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