f664204d0bfe9c35db71d7b0f1511302e6586133
[occt.git] / src / XmlLDrivers / XmlLDrivers_DocumentStorageDriver.cxx
1 // File:      XmlLDrivers_DocumentStorageDriver.cxx
2 // Created:   Mon Jul  9 12:29:49 MSK DST 2001
3 // Author:    Julia DOROVSKIKH
4 // Copyright: Open Cascade 2001
5
6 #include <XmlLDrivers_DocumentStorageDriver.ixx>
7
8 #include <XmlLDrivers.hxx>
9 #include <XmlLDrivers_NamespaceDef.hxx>
10 #include <XmlMDF.hxx>
11 #include <XmlMDF_ADriverTable.hxx>
12
13 #include <XmlObjMgt.hxx>
14 #include <XmlObjMgt_SRelocationTable.hxx>
15
16 #include <LDOM_XmlWriter.hxx>
17 #include <LDOM_LDOMImplementation.hxx>
18 #include <LDOM_DocumentType.hxx>
19 #include <XmlObjMgt_Document.hxx>
20
21 #include <Storage_Data.hxx>
22 #include <PCDM.hxx>
23 #include <PCDM_ReadWriter.hxx>
24 #include <CDM_NullMessageDriver.hxx>
25 #include <CDM_Document.hxx>
26 #include <CDM_Application.hxx>
27 #include <TDocStd_Document.hxx>
28 #include <TColStd_SequenceOfAsciiString.hxx>
29
30 #include <locale.h>
31 #include <Standard_Failure.hxx>
32 #include <Standard_ErrorHandler.hxx>
33
34 #include <OSD_File.hxx>
35 #include <OSD_Environment.hxx>
36
37 #define STORAGE_VERSION      "STORAGE_VERSION: "
38 #define REFERENCE_COUNTER    "REFERENCE_COUNTER: "
39 #define MODIFICATION_COUNTER "MODIFICATION_COUNTER: "
40 #define START_REF            "START_REF"
41 #define END_REF              "END_REF"
42
43 #define FAILSTR "Failed to write xsi:schemaLocation : "
44
45 //#define TAKE_TIMES
46 static void take_time (const Standard_Integer, const char *,
47                        const Handle(CDM_MessageDriver)&)
48 #ifdef TAKE_TIMES
49 ;
50 #else
51 {}
52 #endif
53
54 //=======================================================================
55 //function : XmlLDrivers_DocumentStorageDriver
56 //purpose  : Constructor
57 //=======================================================================
58 XmlLDrivers_DocumentStorageDriver::XmlLDrivers_DocumentStorageDriver
59                                 (const TCollection_ExtendedString& theCopyright)
60      : myCopyright (theCopyright)
61
62 }
63
64 //=======================================================================
65 //function : SchemaName
66 //purpose  : 
67 //=======================================================================
68 TCollection_ExtendedString XmlLDrivers_DocumentStorageDriver::SchemaName() const
69 {
70   TCollection_ExtendedString schemaname;
71   return schemaname; 
72 }
73
74 //=======================================================================
75 //function : AddNamespace
76 //purpose  : 
77 //=======================================================================
78
79 void XmlLDrivers_DocumentStorageDriver::AddNamespace
80                                 (const TCollection_AsciiString& thePrefix,
81                                  const TCollection_AsciiString& theURI)
82 {
83   for (Standard_Integer i = 1; i <= mySeqOfNS.Length(); i++)
84     if (thePrefix == mySeqOfNS(i).Prefix()) return;
85   mySeqOfNS.Append (XmlLDrivers_NamespaceDef(thePrefix, theURI));
86 }
87
88 //=======================================================================
89 //function : Write
90 //purpose  : 
91 //=======================================================================
92 void XmlLDrivers_DocumentStorageDriver::Write
93                           (const Handle(CDM_Document)&       theDocument,
94                            const TCollection_ExtendedString& theFileName)
95 {
96   const TCollection_AsciiString anOldNumLocale =
97     (Standard_CString) setlocale (LC_NUMERIC, NULL);
98   setlocale(LC_NUMERIC, "C");
99
100   Handle(CDM_MessageDriver) aMessageDriver =
101     theDocument -> Application() -> MessageDriver();
102   ::take_time (~0, " +++++ Start STORAGE procedures ++++++", aMessageDriver);
103
104   // Create new DOM_Document
105   XmlObjMgt_Document aDOMDoc = XmlObjMgt_Document::createDocument ("document");
106
107   // Fill the document with data
108   XmlObjMgt_Element anElement = aDOMDoc.getDocumentElement();
109
110   if (WriteToDomDocument (theDocument, anElement, theFileName) == Standard_False) {
111     // Write DOM_Document into XML file,
112     TCollection_AsciiString aFileName (theFileName, '?');
113     FILE * aFile = fopen(aFileName.ToCString(), "wt");
114
115     if (aFile) {
116       LDOM_XmlWriter aWriter (aFile);
117       aWriter.SetIndentation(1);
118       aWriter << aDOMDoc;
119       fclose(aFile);
120       ::take_time (0, " +++++ Fin formatting to XML : ", aMessageDriver);
121
122     }else{
123       myIsError = Standard_True;
124       TCollection_ExtendedString aMsg =
125         TCollection_ExtendedString("Error: the file ") + aFileName +
126           " cannot be opened for writing";
127       aMessageDriver -> Write (aMsg.ToExtString());
128         Standard_Failure::Raise("File cannot be opened for writing");
129     }
130   }
131   setlocale(LC_NUMERIC, (char *) anOldNumLocale.ToCString()) ;
132 }
133
134 //=======================================================================
135 //function : WriteToDomDocument
136 //purpose  : management of the macro-structure of XML document data
137 //remark   : If the application needs to use myRelocTable to store additional
138 //           data to XML, this method should be reimplemented avoiding step 3
139 //=======================================================================
140
141 Standard_Boolean XmlLDrivers_DocumentStorageDriver::WriteToDomDocument
142                                   (const Handle(CDM_Document)&  theDocument,
143                                    XmlObjMgt_Element&           theElement,
144                                    const TCollection_ExtendedString& theFileName)
145 {
146   myIsError = Standard_False;
147   Handle(CDM_MessageDriver) aMessageDriver =
148     theDocument -> Application() -> MessageDriver();
149   // 1. Write header information
150   Standard_Integer i;
151   XmlObjMgt_Document aDOMDoc = theElement.getOwnerDocument();
152
153   // 1.a File Format
154   TCollection_AsciiString aStorageFormat (theDocument->StorageFormat(), '?');
155   theElement.setAttribute ("format", aStorageFormat.ToCString());
156 //  theElement.setAttribute ("schema", "XSD");
157
158   theElement.setAttribute ("xmlns" , "http://www.opencascade.org/OCAF/XML");
159   for (i = 1; i <= mySeqOfNS.Length(); i++) {
160     TCollection_AsciiString aPrefix =
161       TCollection_AsciiString("xmlns:") + mySeqOfNS(i).Prefix().ToCString();
162     theElement.setAttribute (aPrefix.ToCString(),
163                              mySeqOfNS(i).URI().ToCString());
164   }
165   theElement.setAttribute ("xmlns:xsi",
166                            "http://www.w3.org/2001/XMLSchema-instance");
167   //mkv 15.09.05 OCC10001
168   //theElement.setAttribute ("xsi:schemaLocation",
169   //                         "http://www.opencascade.org/OCAF/XML"
170   //                         " http://www.nnov.matra-dtv.fr/~agv/XmlOcaf.xsd");
171   //
172   // the order of search : by CSF_XmlOcafResource and then by CASROOT
173   TCollection_AsciiString anHTTP = "http://www.opencascade.org/OCAF/XML";
174   Standard_Boolean aToSetCSFVariable = Standard_False;
175   const char * aCSFVariable [2] = {
176     "CSF_XmlOcafResource",
177     "CASROOT"
178   };
179   TCollection_AsciiString aResourceDir = "";
180   aResourceDir = getenv (aCSFVariable[0]);
181   if (aResourceDir.IsEmpty()) {
182     // now try by CASROOT
183     aResourceDir = getenv (aCSFVariable[1]);
184     if ( !aResourceDir.IsEmpty() ) {
185       aResourceDir += "/src/XmlOcafResource" ;
186       aToSetCSFVariable = Standard_True; //CSF variable to be set later
187     }
188 #ifdef DEB
189     else {
190       TCollection_ExtendedString aWarn = FAILSTR "Neither ";
191       aWarn = (aWarn + aCSFVariable[0] + ", nor " + aCSFVariable[1]
192                + " variables have been set");
193       aMessageDriver->Write (aWarn.ToExtString());
194     }
195 #endif
196   }
197   if (!aResourceDir.IsEmpty()) {
198     TCollection_AsciiString aResourceFileName =  aResourceDir + "/XmlOcaf.xsd";
199     // search directory name that has been constructed, now check whether
200     // it and the file exist
201     OSD_File aResourceFile ( aResourceFileName );
202     if ( aResourceFile.Exists() ) {
203       if (aToSetCSFVariable) {
204         OSD_Environment aCSFVarEnv ( aCSFVariable[0], aResourceDir );
205         aCSFVarEnv.Build();
206 #ifdef DEB
207         TCollection_ExtendedString aWarn1 = "Variable ";
208         aWarn1 = (aWarn1 + aCSFVariable[0]
209                   + " has not been explicitly defined. Set to " + aResourceDir);
210         aMessageDriver->Write (aWarn1.ToExtString());
211 #endif
212         if ( aCSFVarEnv.Failed() ) {
213           TCollection_ExtendedString aWarn = FAILSTR "Failed to initialize ";
214           aWarn = aWarn + aCSFVariable[0] + " with " + aResourceDir;
215           aMessageDriver->Write (aWarn.ToExtString());
216         }
217       }
218     }
219 #ifdef DEB
220     else {
221       TCollection_ExtendedString aWarn = FAILSTR "Schema definition file ";
222       aWarn += (aResourceFileName + " was not found");
223       aMessageDriver->Write (aWarn.ToExtString());
224     }
225 #endif
226     anHTTP = anHTTP + ' ' + aResourceFileName;
227   }
228   theElement.setAttribute ("xsi:schemaLocation", anHTTP.ToCString() );
229
230   // 1.b Info section
231   XmlObjMgt_Element anInfoElem = aDOMDoc.createElement("info");
232   theElement.appendChild(anInfoElem);
233
234   TCollection_AsciiString aCreationDate = XmlLDrivers::CreationDate();
235
236 //  anInfoElem.setAttribute("dbv", 0);
237   anInfoElem.setAttribute("date", aCreationDate.ToCString());
238   anInfoElem.setAttribute("schemav", 0);
239 //  anInfoElem.setAttribute("appv", anAppVersion.ToCString());
240
241   // Document version
242   anInfoElem.setAttribute("DocVersion", XmlLDrivers::StorageVersion().ToCString());
243  
244   // User info with Copyright
245   TColStd_SequenceOfAsciiString aUserInfo;
246   if (myCopyright.Length() > 0)
247     aUserInfo.Append (TCollection_AsciiString(myCopyright,'?'));
248
249   Handle(Storage_Data) theData = new Storage_Data;
250   //PCDM_ReadWriter::WriteFileFormat( theData, theDocument );
251   PCDM_ReadWriter::Writer()->WriteReferenceCounter(theData,theDocument);
252   PCDM_ReadWriter::Writer()->WriteReferences(theData,theDocument,theFileName);
253   PCDM_ReadWriter::Writer()->WriteExtensions(theData,theDocument);
254   PCDM_ReadWriter::Writer()->WriteVersion(theData,theDocument);
255
256   const TColStd_SequenceOfAsciiString& aRefs = theData->UserInfo();
257   for(i = 1; i <= aRefs.Length(); i++)
258     aUserInfo.Append(aRefs.Value(i));
259
260   for (i = 1; i <= aUserInfo.Length(); i++)
261   {
262     XmlObjMgt_Element aUIItem = aDOMDoc.createElement ("iitem");
263     anInfoElem.appendChild (aUIItem);
264     LDOM_Text aUIText = aDOMDoc.createTextNode (aUserInfo(i).ToCString());
265     aUIItem.appendChild (aUIText);
266   }
267
268   // 1.c Comments section
269   TColStd_SequenceOfExtendedString aComments;
270   theDocument->Comments(aComments);
271
272   XmlObjMgt_Element aCommentsElem = aDOMDoc.createElement ("comments");
273   theElement.appendChild (aCommentsElem);
274
275   for (i = 1; i <= aComments.Length(); i++)
276   {
277     XmlObjMgt_Element aCItem = aDOMDoc.createElement ("citem");
278     aCommentsElem.appendChild (aCItem);
279     XmlObjMgt::SetExtendedString (aCItem, aComments(i));
280   }
281
282   // 2a. Write document contents
283   Standard_Integer anObjNb = 0;
284   {
285     try
286     {
287       OCC_CATCH_SIGNALS
288       anObjNb = MakeDocument(theDocument, theElement);
289     }
290     catch (Standard_Failure)
291     {
292       myIsError = Standard_True;
293       TCollection_ExtendedString anErrorString (Standard_Failure::Caught()->GetMessageString());
294       aMessageDriver -> Write (anErrorString.ToExtString());
295     }
296   }
297   if (anObjNb <= 0 && myIsError == Standard_False) {
298     myIsError = Standard_True;
299     TCollection_ExtendedString anErrorString ("error occurred");
300     aMessageDriver -> Write (anErrorString.ToExtString());
301   }
302   // 2b. Write number of objects into the info section
303   anInfoElem.setAttribute("objnb", anObjNb);
304   ::take_time (0, " +++++ Fin DOM data for OCAF : ", aMessageDriver);
305
306   // 3. Clear relocation table
307   //    If the application needs to use myRelocTable to store additional
308   //    data to XML, this method should be reimplemented avoiding this step
309   myRelocTable.Clear();
310
311   // 4. Write Shapes section
312   if(WriteShapeSection(theElement))
313     ::take_time (0, " +++ Fin DOM data for Shapes : ", aMessageDriver);
314   return myIsError;
315 }
316
317 //=======================================================================
318 //function : MakeDocument
319 //purpose  : 
320 //=======================================================================
321 Standard_Integer XmlLDrivers_DocumentStorageDriver::MakeDocument
322                                     (const Handle(CDM_Document)& theTDoc,
323                                      XmlObjMgt_Element&          theElement) 
324 {  
325   TCollection_ExtendedString aMessage;
326   Handle(TDocStd_Document) TDOC = Handle(TDocStd_Document)::DownCast(theTDoc);  
327   myRelocTable.Clear();
328   if (!TDOC.IsNull()) 
329   {
330 //    myRelocTable.SetDocument (theElement.getOwnerDocument());
331     Handle(TDF_Data) aTDF = TDOC->GetData();
332
333 //      Find MessageDriver and pass it to AttributeDrivers()
334     Handle(CDM_Application) anApplication= theTDoc -> Application();
335     Handle(CDM_MessageDriver) aMessageDriver;
336     if (anApplication.IsNull())
337       aMessageDriver = new CDM_NullMessageDriver;
338     else
339       aMessageDriver = anApplication -> MessageDriver();
340     if (myDrivers.IsNull()) myDrivers = AttributeDrivers (aMessageDriver);
341
342 //      Retrieve from DOM_Document
343     XmlMDF::FromTo (aTDF, theElement, myRelocTable, myDrivers); 
344 #if defined(DEB) && !defined(TAKE_TIMES)
345     aMessage = "First step successfull";
346     aMessageDriver -> Write (aMessage.ToExtString());
347 #endif
348     return myRelocTable.Extent();
349   }
350 #ifdef DEB
351   cout << "First step failed" << endl;  // No MessageDriver available
352 #endif
353   return -1; // error
354 }
355
356 //=======================================================================
357 //function : IsError
358 //purpose  : 
359 //=======================================================================
360
361 Standard_Boolean XmlLDrivers_DocumentStorageDriver::IsError () const
362 {
363   return myIsError;
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