0022898: IGES import fails in german environment
[occt.git] / src / XmlLDrivers / XmlLDrivers_DocumentStorageDriver.cxx
1 // Created on: 2001-07-09
2 // Created by: Julia DOROVSKIKH
3 // Copyright (c) 2001-2012 OPEN CASCADE SAS
4 //
5 // The content of this file is subject to the Open CASCADE Technology Public
6 // License Version 6.5 (the "License"). You may not use the content of this file
7 // except in compliance with the License. Please obtain a copy of the License
8 // at http://www.opencascade.org and read it completely before using this file.
9 //
10 // The Initial Developer of the Original Code is Open CASCADE S.A.S., having its
11 // main offices at: 1, place des Freres Montgolfier, 78280 Guyancourt, France.
12 //
13 // The Original Code and all software distributed under the License is
14 // distributed on an "AS IS" basis, without warranty of any kind, and the
15 // Initial Developer hereby disclaims all such warranties, including without
16 // limitation, any warranties of merchantability, fitness for a particular
17 // purpose or non-infringement. Please see the License for the specific terms
18 // and conditions governing the rights and limitations under the License.
19
20
21 #include <XmlLDrivers_DocumentStorageDriver.ixx>
22
23 #include <XmlLDrivers.hxx>
24 #include <XmlLDrivers_NamespaceDef.hxx>
25 #include <XmlMDF.hxx>
26 #include <XmlMDF_ADriverTable.hxx>
27
28 #include <XmlObjMgt.hxx>
29 #include <XmlObjMgt_SRelocationTable.hxx>
30
31 #include <LDOM_XmlWriter.hxx>
32 #include <LDOM_LDOMImplementation.hxx>
33 #include <LDOM_DocumentType.hxx>
34 #include <XmlObjMgt_Document.hxx>
35
36 #include <Storage_Data.hxx>
37 #include <PCDM.hxx>
38 #include <PCDM_ReadWriter.hxx>
39 #include <CDM_NullMessageDriver.hxx>
40 #include <CDM_Document.hxx>
41 #include <CDM_Application.hxx>
42 #include <TDocStd_Document.hxx>
43 #include <TColStd_SequenceOfAsciiString.hxx>
44
45 #include <locale.h>
46 #include <Standard_Failure.hxx>
47 #include <Standard_ErrorHandler.hxx>
48
49 #include <OSD_File.hxx>
50 #include <OSD_Environment.hxx>
51
52 #define STORAGE_VERSION      "STORAGE_VERSION: "
53 #define REFERENCE_COUNTER    "REFERENCE_COUNTER: "
54 #define MODIFICATION_COUNTER "MODIFICATION_COUNTER: "
55 #define START_REF            "START_REF"
56 #define END_REF              "END_REF"
57
58 #define FAILSTR "Failed to write xsi:schemaLocation : "
59
60 //#define TAKE_TIMES
61 static void take_time (const Standard_Integer, const char *,
62                        const Handle(CDM_MessageDriver)&)
63 #ifdef TAKE_TIMES
64 ;
65 #else
66 {}
67 #endif
68
69 //=======================================================================
70 //function : XmlLDrivers_DocumentStorageDriver
71 //purpose  : Constructor
72 //=======================================================================
73 XmlLDrivers_DocumentStorageDriver::XmlLDrivers_DocumentStorageDriver
74                                 (const TCollection_ExtendedString& theCopyright)
75      : myCopyright (theCopyright)
76
77 }
78
79 //=======================================================================
80 //function : SchemaName
81 //purpose  : 
82 //=======================================================================
83 TCollection_ExtendedString XmlLDrivers_DocumentStorageDriver::SchemaName() const
84 {
85   TCollection_ExtendedString schemaname;
86   return schemaname; 
87 }
88
89 //=======================================================================
90 //function : AddNamespace
91 //purpose  : 
92 //=======================================================================
93
94 void XmlLDrivers_DocumentStorageDriver::AddNamespace
95                                 (const TCollection_AsciiString& thePrefix,
96                                  const TCollection_AsciiString& theURI)
97 {
98   for (Standard_Integer i = 1; i <= mySeqOfNS.Length(); i++)
99     if (thePrefix == mySeqOfNS(i).Prefix()) return;
100   mySeqOfNS.Append (XmlLDrivers_NamespaceDef(thePrefix, theURI));
101 }
102
103 //=======================================================================
104 //function : Write
105 //purpose  : 
106 //=======================================================================
107 void XmlLDrivers_DocumentStorageDriver::Write
108                           (const Handle(CDM_Document)&       theDocument,
109                            const TCollection_ExtendedString& theFileName)
110 {
111   Handle(CDM_MessageDriver) aMessageDriver =
112     theDocument -> Application() -> MessageDriver();
113   ::take_time (~0, " +++++ Start STORAGE procedures ++++++", aMessageDriver);
114
115   // Create new DOM_Document
116   XmlObjMgt_Document aDOMDoc = XmlObjMgt_Document::createDocument ("document");
117
118   // Fill the document with data
119   XmlObjMgt_Element anElement = aDOMDoc.getDocumentElement();
120
121   if (WriteToDomDocument (theDocument, anElement, theFileName) == Standard_False) {
122     // Write DOM_Document into XML file,
123     TCollection_AsciiString aFileName (theFileName, '?');
124     FILE * aFile = fopen(aFileName.ToCString(), "wt");
125
126     if (aFile) {
127       LDOM_XmlWriter aWriter (aFile);
128       aWriter.SetIndentation(1);
129       aWriter << aDOMDoc;
130       fclose(aFile);
131       ::take_time (0, " +++++ Fin formatting to XML : ", aMessageDriver);
132
133     }else{
134       SetIsError (Standard_True);
135       TCollection_ExtendedString aMsg =
136         TCollection_ExtendedString("Error: the file ") + aFileName +
137           " cannot be opened for writing";
138       aMessageDriver -> Write (aMsg.ToExtString());
139         Standard_Failure::Raise("File cannot be opened for writing");
140     }
141   }
142 }
143
144 //=======================================================================
145 //function : WriteToDomDocument
146 //purpose  : management of the macro-structure of XML document data
147 //remark   : If the application needs to use myRelocTable to store additional
148 //           data to XML, this method should be reimplemented avoiding step 3
149 //=======================================================================
150
151 Standard_Boolean XmlLDrivers_DocumentStorageDriver::WriteToDomDocument
152                                   (const Handle(CDM_Document)&  theDocument,
153                                    XmlObjMgt_Element&           theElement,
154                                    const TCollection_ExtendedString& theFileName)
155 {
156   SetIsError(Standard_False);
157   Handle(CDM_MessageDriver) aMessageDriver =
158     theDocument -> Application() -> MessageDriver();
159   // 1. Write header information
160   Standard_Integer i;
161   XmlObjMgt_Document aDOMDoc = theElement.getOwnerDocument();
162
163   // 1.a File Format
164   TCollection_AsciiString aStorageFormat (theDocument->StorageFormat(), '?');
165   theElement.setAttribute ("format", aStorageFormat.ToCString());
166 //  theElement.setAttribute ("schema", "XSD");
167
168   theElement.setAttribute ("xmlns" , "http://www.opencascade.org/OCAF/XML");
169   for (i = 1; i <= mySeqOfNS.Length(); i++) {
170     TCollection_AsciiString aPrefix =
171       TCollection_AsciiString("xmlns:") + mySeqOfNS(i).Prefix().ToCString();
172     theElement.setAttribute (aPrefix.ToCString(),
173                              mySeqOfNS(i).URI().ToCString());
174   }
175   theElement.setAttribute ("xmlns:xsi",
176                            "http://www.w3.org/2001/XMLSchema-instance");
177   //mkv 15.09.05 OCC10001
178   //theElement.setAttribute ("xsi:schemaLocation",
179   //                         "http://www.opencascade.org/OCAF/XML"
180   //                         " http://www.nnov.matra-dtv.fr/~agv/XmlOcaf.xsd");
181   //
182   // the order of search : by CSF_XmlOcafResource and then by CASROOT
183   TCollection_AsciiString anHTTP = "http://www.opencascade.org/OCAF/XML";
184   Standard_Boolean aToSetCSFVariable = Standard_False;
185   const char * aCSFVariable [2] = {
186     "CSF_XmlOcafResource",
187     "CASROOT"
188   };
189   TCollection_AsciiString aResourceDir = "";
190   aResourceDir = getenv (aCSFVariable[0]);
191   if (aResourceDir.IsEmpty()) {
192     // now try by CASROOT
193     aResourceDir = getenv (aCSFVariable[1]);
194     if ( !aResourceDir.IsEmpty() ) {
195       aResourceDir += "/src/XmlOcafResource" ;
196       aToSetCSFVariable = Standard_True; //CSF variable to be set later
197     }
198 #ifdef DEB
199     else {
200       TCollection_ExtendedString aWarn = FAILSTR "Neither ";
201       aWarn = (aWarn + aCSFVariable[0] + ", nor " + aCSFVariable[1]
202                + " variables have been set");
203       aMessageDriver->Write (aWarn.ToExtString());
204     }
205 #endif
206   }
207   if (!aResourceDir.IsEmpty()) {
208     TCollection_AsciiString aResourceFileName =  aResourceDir + "/XmlOcaf.xsd";
209     // search directory name that has been constructed, now check whether
210     // it and the file exist
211     OSD_File aResourceFile ( aResourceFileName );
212     if ( aResourceFile.Exists() ) {
213       if (aToSetCSFVariable) {
214         OSD_Environment aCSFVarEnv ( aCSFVariable[0], aResourceDir );
215         aCSFVarEnv.Build();
216 #ifdef DEB
217         TCollection_ExtendedString aWarn1 = "Variable ";
218         aWarn1 = (aWarn1 + aCSFVariable[0]
219                   + " has not been explicitly defined. Set to " + aResourceDir);
220         aMessageDriver->Write (aWarn1.ToExtString());
221 #endif
222         if ( aCSFVarEnv.Failed() ) {
223           TCollection_ExtendedString aWarn = FAILSTR "Failed to initialize ";
224           aWarn = aWarn + aCSFVariable[0] + " with " + aResourceDir;
225           aMessageDriver->Write (aWarn.ToExtString());
226         }
227       }
228     }
229 #ifdef DEB
230     else {
231       TCollection_ExtendedString aWarn = FAILSTR "Schema definition file ";
232       aWarn += (aResourceFileName + " was not found");
233       aMessageDriver->Write (aWarn.ToExtString());
234     }
235 #endif
236     anHTTP = anHTTP + ' ' + aResourceFileName;
237   }
238   theElement.setAttribute ("xsi:schemaLocation", anHTTP.ToCString() );
239
240   // 1.b Info section
241   XmlObjMgt_Element anInfoElem = aDOMDoc.createElement("info");
242   theElement.appendChild(anInfoElem);
243
244   TCollection_AsciiString aCreationDate = XmlLDrivers::CreationDate();
245
246 //  anInfoElem.setAttribute("dbv", 0);
247   anInfoElem.setAttribute("date", aCreationDate.ToCString());
248   anInfoElem.setAttribute("schemav", 0);
249 //  anInfoElem.setAttribute("appv", anAppVersion.ToCString());
250
251   // Document version
252   anInfoElem.setAttribute("DocVersion", XmlLDrivers::StorageVersion().ToCString());
253  
254   // User info with Copyright
255   TColStd_SequenceOfAsciiString aUserInfo;
256   if (myCopyright.Length() > 0)
257     aUserInfo.Append (TCollection_AsciiString(myCopyright,'?'));
258
259   Handle(Storage_Data) theData = new Storage_Data;
260   //PCDM_ReadWriter::WriteFileFormat( theData, theDocument );
261   PCDM_ReadWriter::Writer()->WriteReferenceCounter(theData,theDocument);
262   PCDM_ReadWriter::Writer()->WriteReferences(theData,theDocument,theFileName);
263   PCDM_ReadWriter::Writer()->WriteExtensions(theData,theDocument);
264   PCDM_ReadWriter::Writer()->WriteVersion(theData,theDocument);
265
266   const TColStd_SequenceOfAsciiString& aRefs = theData->UserInfo();
267   for(i = 1; i <= aRefs.Length(); i++)
268     aUserInfo.Append(aRefs.Value(i));
269
270   for (i = 1; i <= aUserInfo.Length(); i++)
271   {
272     XmlObjMgt_Element aUIItem = aDOMDoc.createElement ("iitem");
273     anInfoElem.appendChild (aUIItem);
274     LDOM_Text aUIText = aDOMDoc.createTextNode (aUserInfo(i).ToCString());
275     aUIItem.appendChild (aUIText);
276   }
277
278   // 1.c Comments section
279   TColStd_SequenceOfExtendedString aComments;
280   theDocument->Comments(aComments);
281
282   XmlObjMgt_Element aCommentsElem = aDOMDoc.createElement ("comments");
283   theElement.appendChild (aCommentsElem);
284
285   for (i = 1; i <= aComments.Length(); i++)
286   {
287     XmlObjMgt_Element aCItem = aDOMDoc.createElement ("citem");
288     aCommentsElem.appendChild (aCItem);
289     XmlObjMgt::SetExtendedString (aCItem, aComments(i));
290   }
291
292   // 2a. Write document contents
293   Standard_Integer anObjNb = 0;
294   {
295     try
296     {
297       OCC_CATCH_SIGNALS
298       anObjNb = MakeDocument(theDocument, theElement);
299     }
300     catch (Standard_Failure)
301     {
302       SetIsError (Standard_True);
303       TCollection_ExtendedString anErrorString (Standard_Failure::Caught()->GetMessageString());
304       aMessageDriver -> Write (anErrorString.ToExtString());
305     }
306   }
307   if (anObjNb <= 0 && IsError() == Standard_False) {
308     SetIsError (Standard_True);
309     TCollection_ExtendedString anErrorString ("error occurred");
310     aMessageDriver -> Write (anErrorString.ToExtString());
311   }
312   // 2b. Write number of objects into the info section
313   anInfoElem.setAttribute("objnb", anObjNb);
314   ::take_time (0, " +++++ Fin DOM data for OCAF : ", aMessageDriver);
315
316   // 3. Clear relocation table
317   //    If the application needs to use myRelocTable to store additional
318   //    data to XML, this method should be reimplemented avoiding this step
319   myRelocTable.Clear();
320
321   // 4. Write Shapes section
322   if(WriteShapeSection(theElement))
323     ::take_time (0, " +++ Fin DOM data for Shapes : ", aMessageDriver);
324   return IsError();
325 }
326
327 //=======================================================================
328 //function : MakeDocument
329 //purpose  : 
330 //=======================================================================
331 Standard_Integer XmlLDrivers_DocumentStorageDriver::MakeDocument
332                                     (const Handle(CDM_Document)& theTDoc,
333                                      XmlObjMgt_Element&          theElement) 
334 {  
335   TCollection_ExtendedString aMessage;
336   Handle(TDocStd_Document) TDOC = Handle(TDocStd_Document)::DownCast(theTDoc);  
337   myRelocTable.Clear();
338   if (!TDOC.IsNull()) 
339   {
340 //    myRelocTable.SetDocument (theElement.getOwnerDocument());
341     Handle(TDF_Data) aTDF = TDOC->GetData();
342
343 //      Find MessageDriver and pass it to AttributeDrivers()
344     Handle(CDM_Application) anApplication= theTDoc -> Application();
345     Handle(CDM_MessageDriver) aMessageDriver;
346     if (anApplication.IsNull())
347       aMessageDriver = new CDM_NullMessageDriver;
348     else
349       aMessageDriver = anApplication -> MessageDriver();
350     if (myDrivers.IsNull()) myDrivers = AttributeDrivers (aMessageDriver);
351
352 //      Retrieve from DOM_Document
353     XmlMDF::FromTo (aTDF, theElement, myRelocTable, myDrivers); 
354 #if defined(DEB) && !defined(TAKE_TIMES)
355     aMessage = "First step successfull";
356     aMessageDriver -> Write (aMessage.ToExtString());
357 #endif
358     return myRelocTable.Extent();
359   }
360 #ifdef DEB
361   cout << "First step failed" << endl;  // No MessageDriver available
362 #endif
363   return -1; // error
364 }
365
366 //=======================================================================
367 //function : AttributeDrivers
368 //purpose  : 
369 //=======================================================================
370 Handle(XmlMDF_ADriverTable) XmlLDrivers_DocumentStorageDriver::AttributeDrivers
371        (const Handle(CDM_MessageDriver)& theMessageDriver) 
372 {
373   return XmlLDrivers::AttributeDrivers (theMessageDriver);
374 }
375
376 //=======================================================================
377 //function : take_time
378 //class    : static
379 //purpose  : output astronomical time elapsed
380 //=======================================================================
381 #ifdef TAKE_TIMES
382 #include <time.h>
383 #include <sys/timeb.h>
384 #include <sys/types.h>
385 #include <stdio.h>
386 #ifndef WNT
387 extern "C" int ftime (struct timeb *tp);
388 #endif
389 struct timeb  tmbuf0;
390
391 static void take_time (const Standard_Integer isReset, const char * aHeader,
392                        const Handle(CDM_MessageDriver)& aMessageDriver)
393 {
394   struct timeb  tmbuf;
395   ftime (&tmbuf);
396   TCollection_ExtendedString aMessage ((Standard_CString)aHeader);
397   if (isReset) tmbuf0 = tmbuf;
398   else {
399     char take_tm_buf [64];
400     Sprintf (take_tm_buf, "%9.2f s ++++",
401              double(tmbuf.time - tmbuf0.time) +
402              double(tmbuf.millitm - tmbuf0.millitm)/1000.);
403     aMessage += take_tm_buf;
404   }
405   aMessageDriver -> Write (aMessage.ToExtString());
406 }
407 #endif
408
409 //=======================================================================
410 //function : WriteShapeSection
411 //purpose  : defines WriteShapeSection
412 //=======================================================================
413 Standard_Boolean XmlLDrivers_DocumentStorageDriver::WriteShapeSection
414                                 (XmlObjMgt_Element&  /*theElement*/)
415 {
416   // empty; should be redefined in subclasses
417   return Standard_False;
418 }
419