1bd499649485c1186bcbb34bfe7b16380d8469b4
[occt.git] / src / BinLDrivers / BinLDrivers_DocumentRetrievalDriver.cxx
1 // Created on: 2002-10-31
2 // Created by: Michael SAZONOV
3 // Copyright (c) 2002-2014 OPEN CASCADE SAS
4 //
5 // This file is part of Open CASCADE Technology software library.
6 //
7 // This library is free software; you can redistribute it and/or modify it under
8 // the terms of the GNU Lesser General Public License version 2.1 as published
9 // by the Free Software Foundation, with special exception defined in the file
10 // OCCT_LGPL_EXCEPTION.txt. Consult the file LICENSE_LGPL_21.txt included in OCCT
11 // distribution for complete text of the license and disclaimer of any warranty.
12 //
13 // Alternatively, this file may be used under the terms of Open CASCADE
14 // commercial license or contractual agreement.
15
16
17 #include <BinLDrivers.hxx>
18 #include <BinLDrivers_DocumentRetrievalDriver.hxx>
19 #include <BinLDrivers_DocumentSection.hxx>
20 #include <BinLDrivers_Marker.hxx>
21 #include <BinMDataStd.hxx>
22 #include <BinMDF_ADriver.hxx>
23 #include <BinMDF_ADriverTable.hxx>
24 #include <BinObjMgt_Persistent.hxx>
25 #include <CDM_Application.hxx>
26 #include <CDM_Document.hxx>
27 #include <CDM_MessageDriver.hxx>
28 #include <FSD_BinaryFile.hxx>
29 #include <FSD_FileHeader.hxx>
30 #include <OSD_OpenFile.hxx>
31 #include <PCDM_Document.hxx>
32 #include <PCDM_ReadWriter.hxx>
33 #include <Standard_ErrorHandler.hxx>
34 #include <Standard_Stream.hxx>
35 #include <Standard_Type.hxx>
36 #include <Storage_HeaderData.hxx>
37 #include <Storage_Schema.hxx>
38 #include <TCollection_AsciiString.hxx>
39 #include <TCollection_ExtendedString.hxx>
40 #include <TDF_Attribute.hxx>
41 #include <TDF_Data.hxx>
42 #include <TDF_Label.hxx>
43 #include <TDocStd_Document.hxx>
44 #include <TDocStd_Owner.hxx>
45
46 IMPLEMENT_STANDARD_RTTIEXT(BinLDrivers_DocumentRetrievalDriver,PCDM_RetrievalDriver)
47
48 #define SHAPESECTION_POS "SHAPE_SECTION_POS:"
49 #define SIZEOFSHAPELABEL  18
50
51 #define DATATYPE_MIGRATION
52 //#define DATATYPE_MIGRATION_DEB
53 //=======================================================================
54 //function : BinLDrivers_DocumentRetrievalDriver
55 //purpose  : Constructor
56 //=======================================================================
57
58 BinLDrivers_DocumentRetrievalDriver::BinLDrivers_DocumentRetrievalDriver ()
59 {
60   myReaderStatus = PCDM_RS_OK;
61 }
62
63 //=======================================================================
64 //function : CreateDocument
65 //purpose  : pure virtual method definition
66 //=======================================================================
67
68 Handle(CDM_Document) BinLDrivers_DocumentRetrievalDriver::CreateDocument()
69 {
70   return new TDocStd_Document(PCDM_RetrievalDriver::GetFormat());
71 }
72
73 //=======================================================================
74 //function : Read
75 //purpose  :
76 //=======================================================================
77 void BinLDrivers_DocumentRetrievalDriver::Read
78                          (const TCollection_ExtendedString& theFileName,
79                           const Handle(CDM_Document)&       theNewDocument,
80                           const Handle(CDM_Application)&    theApplication)
81 {
82   std::ifstream aFileStream;
83   OSD_OpenStream (aFileStream, theFileName, std::ios::in | std::ios::binary);
84
85   if (aFileStream.is_open() && aFileStream.good())
86   {
87     Handle(Storage_Data) dData;
88     TCollection_ExtendedString aFormat = PCDM_ReadWriter::FileFormat (aFileStream, dData);
89
90     Read (aFileStream, dData, theNewDocument, theApplication);
91   }
92   else
93   {
94     myReaderStatus = PCDM_RS_OpenError;
95   }
96 }
97
98 #define MODIFICATION_COUNTER "MODIFICATION_COUNTER: "
99 #define REFERENCE_COUNTER "REFERENCE_COUNTER: "
100
101 #define START_TYPES "START_TYPES"
102 #define END_TYPES "END_TYPES"
103
104 //=======================================================================
105 //function : Read
106 //purpose  :
107 //=======================================================================
108 void BinLDrivers_DocumentRetrievalDriver::Read (Standard_IStream&               theIStream,
109                                                 const Handle(Storage_Data)&     theStorageData,
110                                                 const Handle(CDM_Document)&     theDoc,
111                                                 const Handle(CDM_Application)&  theApplication)
112 {
113   myReaderStatus = PCDM_RS_DriverFailure;
114   myMsgDriver = theApplication -> MessageDriver();
115
116   const TCollection_ExtendedString aMethStr
117     ("BinLDrivers_DocumentRetrievalDriver: ");
118
119   Handle(TDocStd_Document) aDoc =
120     Handle(TDocStd_Document)::DownCast(theDoc);
121   if (aDoc.IsNull()) {
122 #ifdef OCCT_DEBUG
123     WriteMessage (aMethStr + "error: null document");
124 #endif
125     myReaderStatus = PCDM_RS_NoDocument;
126     return;
127   }
128
129   // 1. the information section
130   Handle(Storage_HeaderData) aHeaderData;
131   
132   if (!theStorageData.IsNull())
133   {
134     aHeaderData = theStorageData->HeaderData();
135   }
136
137   if (!aHeaderData.IsNull())
138   {
139     for (Standard_Integer i = 1; i <= aHeaderData->UserInfo().Length(); i++)
140     {
141       const TCollection_AsciiString& aLine = aHeaderData->UserInfo().Value(i);
142
143       if(aLine.Search(REFERENCE_COUNTER) != -1)
144       {
145         theDoc->SetReferenceCounter (aLine.Token(" ", 2).IntegerValue());
146       }
147       else if(aLine.Search(MODIFICATION_COUNTER) != -1)
148       {
149         theDoc->SetModifications (aLine.Token(" ", 2).IntegerValue());
150       }
151     }
152   }
153
154   // 1.a Version of writer
155   if (!aHeaderData->StorageVersion().IsIntegerValue()) {
156     // file has no format version
157     WriteMessage (aMethStr + "error: file has no format version");
158     myReaderStatus = PCDM_RS_FormatFailure;
159     return;
160   }
161   Standard_Integer aFileVer = aHeaderData->StorageVersion().IntegerValue();
162   Standard_Integer aCurrVer = BinLDrivers::StorageVersion().IntegerValue();
163   // maintain one-way compatibility starting from version 2+
164   if (!CheckDocumentVersion(aFileVer, aCurrVer)) {
165     myReaderStatus = PCDM_RS_NoVersion;
166     // file was written with another version
167     WriteMessage (aMethStr + "error: wrong file version: " +
168                   aHeaderData->StorageVersion() + " while current is " +
169                   BinLDrivers::StorageVersion());
170     return;
171   }
172
173   // 1.b Retrieve the Types table
174   TColStd_SequenceOfAsciiString aTypeNames; //Sequence of types in file
175   const TColStd_SequenceOfAsciiString& aUserInfo = aHeaderData->UserInfo();
176   Standard_Boolean begin = Standard_False;
177   Standard_Integer i;
178   for (i=1; i <= aUserInfo.Length(); i++) {
179     //const TCollection_AsciiString& aStr = aUserInfo(i);
180     TCollection_AsciiString aStr = aUserInfo(i);
181     if (aStr == START_TYPES)
182       begin = Standard_True;
183     else if (aStr == END_TYPES)
184       break;
185     else if (begin) {
186       if ( aFileVer < 8 ) {
187 #ifdef DATATYPE_MIGRATION
188         TCollection_AsciiString  newName;       
189         if(Storage_Schema::CheckTypeMigration(aStr, newName)) {
190 #ifdef OCCT_DEBUG
191           cout << "CheckTypeMigration:OldType = " <<aStr << " Len = "<<aStr.Length()<<endl;
192           cout << "CheckTypeMigration:NewType = " <<newName  << " Len = "<< newName.Length()<<endl;
193 #endif
194           aStr = newName;
195         }
196 #endif  
197       } 
198       aTypeNames.Append (aStr);    
199     }
200   }
201   if (myDrivers.IsNull())
202     myDrivers = AttributeDrivers (myMsgDriver);
203   myDrivers->AssignIds (aTypeNames); 
204
205   // recognize types not supported by drivers
206   myMapUnsupported.Clear();
207   for (i=1; i <= aTypeNames.Length(); i++)
208     if (myDrivers->GetDriver(i).IsNull()) 
209       myMapUnsupported.Add(i);
210   if (!myMapUnsupported.IsEmpty()) {
211     WriteMessage (aMethStr + "warning: "
212                   "the following attributes have no driver:");
213     for (i=1; i <= aTypeNames.Length(); i++)
214       if (myMapUnsupported.Contains(i))
215         WriteMessage (aTypeNames(i));
216   }
217
218   // propagate the opened document version to data drivers
219   PropagateDocumentVersion(aFileVer);
220
221   // 2. Read document contents
222
223   // 2a. Retrieve data from the stream:
224   myRelocTable.Clear();
225   mySections.Clear();
226   myPAtt.Init();
227   Handle(TDF_Data) aData = new TDF_Data();
228   streampos aDocumentPos = -1;
229
230   // 2b. Read the TOC of Sections
231   if (aFileVer >= 3) {
232     BinLDrivers_DocumentSection aSection;
233     do {
234       BinLDrivers_DocumentSection::ReadTOC (aSection, theIStream);
235       mySections.Append(aSection);
236     } while(!aSection.Name().IsEqual((Standard_CString)SHAPESECTION_POS) && !theIStream.eof());
237
238     if (theIStream.eof()) {
239       // There is no shape section in the file.
240       WriteMessage (aMethStr + "error: shape section is not found");
241       myReaderStatus = PCDM_RS_ReaderException;
242       return;
243     }
244
245     aDocumentPos = theIStream.tellg(); // position of root label
246
247     BinLDrivers_VectorOfDocumentSection::Iterator anIterS (mySections);
248     for (; anIterS.More(); anIterS.Next()) {
249       BinLDrivers_DocumentSection& aCurSection = anIterS.ChangeValue();
250       if (aCurSection.IsPostRead() == Standard_False) {
251         theIStream.seekg ((streampos) aCurSection.Offset());
252         if (aCurSection.Name().IsEqual ((Standard_CString)SHAPESECTION_POS)) 
253           ReadShapeSection (aCurSection, theIStream);
254         else
255           ReadSection (aCurSection, theDoc, theIStream); 
256       }
257     }
258   } else { //aFileVer < 3
259     aDocumentPos = theIStream.tellg(); // position of root label
260
261     // retrieve SHAPESECTION_POS string
262     char aShapeSecLabel[SIZEOFSHAPELABEL + 1];
263     aShapeSecLabel[SIZEOFSHAPELABEL] = 0x00;
264     theIStream.read ((char*)&aShapeSecLabel, SIZEOFSHAPELABEL);// SHAPESECTION_POS
265     TCollection_AsciiString aShapeLabel(aShapeSecLabel);
266     // detect if a file was written in old fashion (version 2 without shapes)
267     // and if so then skip reading ShapeSection
268     if (aShapeLabel.Length() > 0) {
269       // version 2+(with shapes) and higher goes here
270       if(aShapeLabel.Length() <= 0 || aShapeLabel != SHAPESECTION_POS) {
271         WriteMessage (aMethStr + "error: Format failure");
272         myReaderStatus = PCDM_RS_FormatFailure;
273         return;
274       }
275
276       // retrieve ShapeSection Position
277       Standard_Integer aShapeSectionPos; // go to ShapeSection
278       theIStream.read ((char*)&aShapeSectionPos, sizeof(Standard_Integer));
279
280 #if DO_INVERSE
281       aShapeSectionPos = InverseInt (aShapeSectionPos);
282 #endif
283 #ifdef OCCT_DEBUG
284       cout <<"aShapeSectionPos = " <<aShapeSectionPos <<endl;
285 #endif
286       if(aShapeSectionPos) { 
287         aDocumentPos = theIStream.tellg();
288         theIStream.seekg((streampos) aShapeSectionPos);
289
290         CheckShapeSection(aShapeSectionPos, theIStream);
291         // Read Shapes
292         BinLDrivers_DocumentSection aCurSection;
293         ReadShapeSection (aCurSection, theIStream, Standard_False);
294       }
295     }
296   } // end of reading Sections or shape section
297
298   // Return to read of the Document structure
299   theIStream.seekg(aDocumentPos);
300
301   // read the header (tag) of the root label
302   Standard_Integer aTag;
303   theIStream.read ((char*)&aTag, sizeof(Standard_Integer));
304
305   // read sub-tree of the root label
306   Standard_Integer nbRead = ReadSubTree (theIStream, aData->Root());
307   Clear();
308     
309   if (nbRead > 0) {
310     // attach data to the document
311     aDoc->SetData (aData);
312     TDocStd_Owner::SetDocument (aData, aDoc);
313     aDoc->SetComments(aHeaderData->Comments());
314     myReaderStatus = PCDM_RS_OK;
315   }
316
317   // Read Sections (post-reading type)
318   if (aFileVer >= 3) {
319     BinLDrivers_VectorOfDocumentSection::Iterator aSectIter (mySections);
320     for (; aSectIter.More(); aSectIter.Next()) {
321       BinLDrivers_DocumentSection& aCurSection = aSectIter.ChangeValue();
322       if (aCurSection.IsPostRead()) {
323         theIStream.seekg ((streampos) aCurSection.Offset());
324         ReadSection (aCurSection, theDoc, theIStream); 
325       }
326     }
327   }
328 }
329
330 //=======================================================================
331 //function : ReadSubTree
332 //purpose  :
333 //=======================================================================
334
335 Standard_Integer BinLDrivers_DocumentRetrievalDriver::ReadSubTree
336                          (Standard_IStream& theIS,
337                           const TDF_Label&  theLabel)
338 {
339   Standard_Integer nbRead = 0;
340   static TCollection_ExtendedString aMethStr
341     ("BinLDrivers_DocumentRetrievalDriver: ");
342
343   // Read attributes:
344   theIS >> myPAtt;
345   while (theIS && myPAtt.TypeId() > 0 &&             // not an end marker ?
346          myPAtt.Id() > 0 &&                          // not a garbage ?
347          !theIS.eof()) {
348     // get a driver according to TypeId
349     Handle(BinMDF_ADriver) aDriver = myDrivers->GetDriver (myPAtt.TypeId());
350     if (!aDriver.IsNull()) {
351       // create transient attribute
352       nbRead++;
353       Standard_Integer anID = myPAtt.Id();
354       Handle(TDF_Attribute) tAtt;
355       Standard_Boolean isBound = myRelocTable.IsBound(anID);
356       if (isBound)
357         tAtt = Handle(TDF_Attribute)::DownCast(myRelocTable.Find(anID));
358       else
359         tAtt = aDriver->NewEmpty();
360       if (tAtt->Label().IsNull())
361         theLabel.AddAttribute (tAtt);
362       else
363         WriteMessage (aMethStr +
364                       "warning: attempt to attach attribute " +
365                       aDriver->TypeName() + " to a second label");
366
367       Standard_Boolean ok = aDriver->Paste (myPAtt, tAtt, myRelocTable);
368       if (!ok) {
369         // error converting persistent to transient
370         WriteMessage (aMethStr + "warning: failure reading attribute " +
371                       aDriver->TypeName());
372       }
373       else if (!isBound)
374         myRelocTable.Bind (anID, tAtt);
375     }
376     else if (!myMapUnsupported.Contains(myPAtt.TypeId()))
377       WriteMessage (aMethStr + "warning: type ID not registered in header: "
378                     + myPAtt.TypeId());
379
380     // read next attribute
381     theIS >> myPAtt;
382   }
383   if (!theIS || myPAtt.TypeId() != BinLDrivers_ENDATTRLIST) {
384     // unexpected EOF or garbage data
385     WriteMessage (aMethStr + "error: unexpected EOF or garbage data");
386     myReaderStatus = PCDM_RS_UnrecognizedFileFormat;
387     return -1;
388   }
389
390   // Read children:
391   // read the tag of a child label
392   Standard_Integer aTag = BinLDrivers_ENDLABEL;
393   theIS.read ((char*) &aTag, sizeof(Standard_Integer));
394 #if DO_INVERSE
395   aTag = InverseInt (aTag);
396 #endif
397   while (theIS && aTag >= 0 && !theIS.eof()) { // not an end marker ?
398     // create sub-label
399     TDF_Label aLab = theLabel.FindChild (aTag, Standard_True);
400
401     // read sub-tree
402     Standard_Integer nbSubRead = ReadSubTree(theIS, aLab);
403     // check for error
404     if (nbSubRead == -1)
405       return -1;
406     nbRead += nbSubRead;
407
408     // read the tag of the next child
409     theIS.read ((char*) &aTag, sizeof(Standard_Integer));
410 #if DO_INVERSE
411     aTag = InverseInt (aTag);
412 #endif
413   }
414   if (aTag != BinLDrivers_ENDLABEL) {
415     // invalid end label marker
416     WriteMessage (aMethStr + "error: invalid end label marker");
417     myReaderStatus = PCDM_RS_UnrecognizedFileFormat;
418     return -1;
419   }
420
421   return nbRead;
422 }
423
424 //=======================================================================
425 //function : AttributeDrivers
426 //purpose  :
427 //=======================================================================
428
429 Handle(BinMDF_ADriverTable) BinLDrivers_DocumentRetrievalDriver::AttributeDrivers
430        (const Handle(CDM_MessageDriver)& theMessageDriver)
431 {
432   return BinLDrivers::AttributeDrivers (theMessageDriver);
433 }
434
435
436 //=======================================================================
437 //function : WriteMessage
438 //purpose  : write   theMessage   to   the   MessageDriver   of
439 //           theApplication
440 //=======================================================================
441
442 void BinLDrivers_DocumentRetrievalDriver::WriteMessage
443                          (const TCollection_ExtendedString& theMsg)
444 {
445   if (!myMsgDriver.IsNull())
446     myMsgDriver->Write (theMsg.ToExtString());
447 }
448
449 //=======================================================================
450 //function : ReadSection
451 //purpose  : 
452 //=======================================================================
453
454 void BinLDrivers_DocumentRetrievalDriver::ReadSection
455                                 (BinLDrivers_DocumentSection& /*theSection*/,
456                                  const Handle(CDM_Document)&  /*theDocument*/,
457                                  Standard_IStream&            /*theIS*/)
458 {
459   // empty; should be redefined in subclasses
460 }
461
462 //=======================================================================
463 //function : ReadShapeSection
464 //purpose  : 
465 //=======================================================================
466
467 void BinLDrivers_DocumentRetrievalDriver::ReadShapeSection
468                               (BinLDrivers_DocumentSection& theSection,
469                                Standard_IStream&            /*theIS*/,
470                                const Standard_Boolean isMess)
471
472 {
473   if(isMess && theSection.Length()) {
474     const TCollection_ExtendedString aMethStr ("BinLDrivers_DocumentRetrievalDriver: ");
475     WriteMessage (aMethStr + "warning: Geometry is not supported by Lite schema. ");
476   }
477 }
478
479 //=======================================================================
480 //function : CheckShapeSection
481 //purpose  : 
482 //=======================================================================
483 void BinLDrivers_DocumentRetrievalDriver::CheckShapeSection(
484                                   const Storage_Position& ShapeSectionPos, 
485                                                     Standard_IStream& IS)
486 {
487   if (!IS.eof())
488   {
489     const std::streamoff endPos = IS.rdbuf()->pubseekoff(0L, std::ios_base::end, std::ios_base::in);
490 #ifdef OCCT_DEBUG
491     cout << "endPos = " << endPos <<endl;
492 #endif
493     if(ShapeSectionPos != endPos) {
494       const TCollection_ExtendedString aMethStr ("BinLDrivers_DocumentRetrievalDriver: ");
495       WriteMessage (aMethStr + "warning: Geometry is not supported by Lite schema. ");
496     }
497   }
498 }
499
500 //=======================================================================
501 //function : Clear
502 //purpose  : 
503 //=======================================================================
504 void BinLDrivers_DocumentRetrievalDriver::Clear()
505 {
506   myPAtt.Destroy();    // free buffer
507   myRelocTable.Clear();
508   myMapUnsupported.Clear();
509 }
510
511 //=======================================================================
512 //function : PropagateDocumentVersion
513 //purpose  : 
514 //=======================================================================
515 void BinLDrivers_DocumentRetrievalDriver::PropagateDocumentVersion(const Standard_Integer theDocVersion )
516 {
517   BinMDataStd::SetDocumentVersion(theDocVersion);
518 }
519
520 //=======================================================================
521 //function : CheckDocumentVersion
522 //purpose  : 
523 //=======================================================================
524 Standard_Boolean BinLDrivers_DocumentRetrievalDriver::CheckDocumentVersion(
525                                                           const Standard_Integer theFileVersion,
526                                                           const Standard_Integer theCurVersion)
527 {
528   if (theFileVersion < 2 || theFileVersion > theCurVersion) {
529     // file was written with another version
530     return Standard_False;
531   }
532   return Standard_True;
533 }
534