1 // Created on: 2001-07-09
2 // Created by: Julia DOROVSKIKH
3 // Copyright (c) 2001-2014 OPEN CASCADE SAS
5 // This file is part of Open CASCADE Technology software library.
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.
13 // Alternatively, this file may be used under the terms of Open CASCADE
14 // commercial license or contractual agreement.
17 #include <CDM_Application.hxx>
18 #include <CDM_Document.hxx>
19 #include <CDM_MessageDriver.hxx>
20 #include <CDM_MetaData.hxx>
21 #include <LDOM_DocumentType.hxx>
22 #include <LDOM_LDOMImplementation.hxx>
23 #include <LDOMParser.hxx>
24 #include <OSD_Path.hxx>
25 #include <OSD_OpenFile.hxx>
26 #include <PCDM_Document.hxx>
27 #include <PCDM_DOMHeaderParser.hxx>
28 #include <Standard_Type.hxx>
29 #include <TCollection_AsciiString.hxx>
30 #include <TCollection_ExtendedString.hxx>
31 #include <TDF_Data.hxx>
32 #include <TDocStd_Document.hxx>
33 #include <TDocStd_Owner.hxx>
35 #include <XmlLDrivers.hxx>
36 #include <XmlLDrivers_DocumentRetrievalDriver.hxx>
37 #include <XmlMDataStd.hxx>
39 #include <XmlMDF_ADriver.hxx>
40 #include <XmlMDF_ADriverTable.hxx>
41 #include <XmlObjMgt.hxx>
42 #include <XmlObjMgt_Document.hxx>
43 #include <XmlObjMgt_RRelocationTable.hxx>
45 IMPLEMENT_STANDARD_RTTIEXT(XmlLDrivers_DocumentRetrievalDriver,PCDM_RetrievalDriver)
52 #include <Standard_Failure.hxx>
53 #include <Standard_ErrorHandler.hxx>
55 #define START_REF "START_REF"
56 #define END_REF "END_REF"
58 #define MODIFICATION_COUNTER "MODIFICATION_COUNTER: "
59 #define REFERENCE_COUNTER "REFERENCE_COUNTER: "
62 static void take_time (const Standard_Integer, const char *,
63 const Handle(CDM_MessageDriver)&)
70 static Standard_Integer RemoveExtraSeparator(TCollection_AsciiString& aString) {
72 Standard_Integer i, j, len ;
74 len = aString.Length() ;
76 // Case of network path, such as \\MACHINE\dir
77 for (i = j = 2 ; j <= len ; i++,j++) {
79 for (i = j = 1 ; j <= len ; i++,j++) {
81 Standard_Character c = aString.Value(j) ;
82 aString.SetValue(i,c) ;
84 while(j < len && aString.Value(j+1) == '/') j++ ;
87 if (aString.Value(len) == '/') len-- ;
91 static TCollection_AsciiString GetDirFromFile(const TCollection_ExtendedString& aFileName) {
92 TCollection_AsciiString theCFile=UTL::CString(aFileName);
93 TCollection_AsciiString theDirectory;
94 Standard_Integer i=theCFile.SearchFromEnd("/");
96 // if(i==-1) i=theCFile.SearchFromEnd("\\");
97 if(theCFile.SearchFromEnd("\\") > i)
98 i=theCFile.SearchFromEnd("\\");
100 if(i!=-1) theDirectory=theCFile.SubString(1,i);
104 static TCollection_AsciiString AbsolutePath(
105 const TCollection_AsciiString& aDirPath,
106 const TCollection_AsciiString& aRelFilePath)
108 TCollection_AsciiString EmptyString = "" ;
110 if (aRelFilePath.Search(":") == 2 ||
111 (aRelFilePath.Search("\\") == 1 && aRelFilePath.Value(2) == '\\'))
113 if(aRelFilePath.Search("/") == 1)
115 return aRelFilePath ;
117 TCollection_AsciiString DirPath = aDirPath, RelFilePath = aRelFilePath ;
118 Standard_Integer i,len ;
121 if(DirPath.Search(":") != 2 &&
122 (DirPath.Search("\\") != 1 || DirPath.Value(2) != '\\'))
124 if (DirPath.Search("/") != 1 )
129 DirPath.ChangeAll('\\','/') ;
130 RelFilePath.ChangeAll('\\','/') ;
133 RemoveExtraSeparator(DirPath) ;
134 len = RemoveExtraSeparator(RelFilePath) ;
136 while (RelFilePath.Search("../") == 1) {
139 RelFilePath = RelFilePath.SubString(4,len) ;
141 if (DirPath.IsEmpty())
143 i = DirPath.SearchFromEnd("/") ;
148 TCollection_AsciiString retx;
155 //=======================================================================
156 //function : XmlLDrivers_DocumentRetrievalDriver
157 //purpose : Constructor
158 //=======================================================================
159 XmlLDrivers_DocumentRetrievalDriver::XmlLDrivers_DocumentRetrievalDriver()
161 myReaderStatus = PCDM_RS_OK;
164 //=======================================================================
165 //function : CreateDocument
166 //purpose : pure virtual method definition
167 //=======================================================================
168 Handle(CDM_Document) XmlLDrivers_DocumentRetrievalDriver::CreateDocument()
170 return new TDocStd_Document(PCDM_RetrievalDriver::GetFormat());
173 //=======================================================================
176 //=======================================================================
177 void XmlLDrivers_DocumentRetrievalDriver::Read
178 (const TCollection_ExtendedString& theFileName,
179 const Handle(CDM_Document)& theNewDocument,
180 const Handle(CDM_Application)& theApplication)
182 myReaderStatus = PCDM_RS_DriverFailure;
183 myFileName = theFileName;
185 std::ifstream aFileStream;
186 OSD_OpenStream (aFileStream, myFileName, std::ios::in);
188 if (aFileStream.is_open() && aFileStream.good())
190 Read (aFileStream, NULL, theNewDocument, theApplication);
194 myReaderStatus = PCDM_RS_OpenError;
196 TCollection_ExtendedString aMsg = TCollection_ExtendedString("Error: the file ") +
197 theFileName + " cannot be opened for reading";
199 theApplication->MessageDriver()->Write (aMsg.ToExtString());
200 throw Standard_Failure("File cannot be opened for reading");
204 //=======================================================================
207 //=======================================================================
208 void XmlLDrivers_DocumentRetrievalDriver::Read (Standard_IStream& theIStream,
209 const Handle(Storage_Data)& /*theStorageData*/,
210 const Handle(CDM_Document)& theNewDocument,
211 const Handle(CDM_Application)& theApplication)
213 Handle(CDM_MessageDriver) aMessageDriver = theApplication -> MessageDriver();
214 ::take_time (~0, " +++++ Start RETRIEVE procedures ++++++", aMessageDriver);
216 // 1. Read DOM_Document from file
219 // if myFileName is not empty, "document" tag is required to be read
220 // from the received document
221 Standard_Boolean aWithoutRoot = myFileName.IsEmpty();
223 if (aParser.parse(theIStream, Standard_False, aWithoutRoot))
225 TCollection_AsciiString aData;
226 cout << aParser.GetError(aData) << ": " << aData << endl;
227 myReaderStatus = PCDM_RS_FormatFailure;
230 const XmlObjMgt_Element anElement= aParser.getDocument().getDocumentElement();
231 ::take_time (0, " +++++ Fin parsing XML : ", aMessageDriver);
233 ReadFromDomDocument (anElement, theNewDocument, theApplication);
236 //=======================================================================
237 //function : ReadFromDomDocument
238 //purpose : management of the macro-structure of XML document data
239 //remark : If the application needs to use myRelocTable to retrieve additional
240 // data from LDOM, this method should be reimplemented
241 //=======================================================================
243 void XmlLDrivers_DocumentRetrievalDriver::ReadFromDomDocument
244 (const XmlObjMgt_Element& theElement,
245 const Handle(CDM_Document)& theNewDocument,
246 const Handle(CDM_Application)& theApplication)
248 const Handle(CDM_MessageDriver) aMsgDriver =
249 theApplication -> MessageDriver();
250 // 1. Read info // to be done
251 TCollection_AsciiString anAbsoluteDirectory = GetDirFromFile(myFileName);
252 Standard_Integer aCurDocVersion = 0;
253 TCollection_ExtendedString anInfo;
254 const XmlObjMgt_Element anInfoElem =
255 theElement.GetChildByTagName ("info");
256 if (anInfoElem != NULL) {
257 XmlObjMgt_DOMString aDocVerStr = anInfoElem.getAttribute("DocVersion");
258 if(aDocVerStr == NULL)
260 else if (!aDocVerStr.GetInteger(aCurDocVersion)) {
261 TCollection_ExtendedString aMsg =
262 TCollection_ExtendedString ("Cannot retrieve the current Document version"
263 " attribute as \"") + aDocVerStr + "\"";
264 if(!aMsgDriver.IsNull())
265 aMsgDriver->Write(aMsg.ToExtString());
268 // oan: OCC22305 - check a document verison and if it's greater than
269 // current version of storage driver set an error status and return
270 if( aCurDocVersion > XmlLDrivers::StorageVersion().IntegerValue() )
272 TCollection_ExtendedString aMsg =
273 TCollection_ExtendedString ("error: wrong file version: ") +
274 aDocVerStr + " while current is " +
275 XmlLDrivers::StorageVersion();
276 myReaderStatus = PCDM_RS_NoVersion;
277 if(!aMsgDriver.IsNull())
278 aMsgDriver->Write(aMsg.ToExtString());
282 if( aCurDocVersion < 2) aCurDocVersion = 2;
284 PropagateDocumentVersion(aCurDocVersion);
286 Standard_Boolean isRef = Standard_False;
287 for (LDOM_Node aNode = anInfoElem.getFirstChild();
288 aNode != NULL; aNode = aNode.getNextSibling()) {
289 if (aNode.getNodeType() == LDOM_Node::ELEMENT_NODE) {
290 if (XmlObjMgt::GetExtendedString ((LDOM_Element&)aNode, anInfo)) {
293 if(anInfo.Search(REFERENCE_COUNTER) != -1) {
296 TCollection_AsciiString anInf(anInfo,'?');
297 Standard_Integer aRefCounter = anInf.Token(" ",2).IntegerValue();
298 theNewDocument->SetReferenceCounter(aRefCounter);
300 catch (Standard_Failure) {
301 // cout << "warning: could not read the reference counter in " << aFileName << endl;
302 TCollection_ExtendedString aMsg("Warning: ");
303 aMsg = aMsg.Cat("could not read the reference counter").Cat("\0");
304 if(!aMsgDriver.IsNull())
305 aMsgDriver->Write(aMsg.ToExtString());
308 else if (anInfo.Search(MODIFICATION_COUNTER) != -1) {
312 TCollection_AsciiString anInf(anInfo,'?');
313 Standard_Integer aModCounter = anInf.Token(" ",2).IntegerValue();
314 theNewDocument->SetModifications (aModCounter);
316 catch (Standard_Failure) {
317 TCollection_ExtendedString aMsg("Warning: could not read the modification counter\0");
318 if(!aMsgDriver.IsNull())
319 aMsgDriver->Write(aMsg.ToExtString());
323 if(anInfo == END_REF)
324 isRef = Standard_False;
325 if(isRef) { // Process References
327 Standard_Integer pos=anInfo.Search(" ");
329 // Parce RefId, DocumentVersion and FileName
330 Standard_Integer aRefId;
331 TCollection_ExtendedString aFileName;
332 Standard_Integer aDocumentVersion;
335 TCollection_ExtendedString aRest=anInfo.Split(pos);
336 aRefId = UTL::IntegerValue(anInfo);
338 Standard_Integer pos2 = aRest.Search(" ");
340 aFileName = aRest.Split(pos2);
341 aDocumentVersion = UTL::IntegerValue(aRest);
343 TCollection_AsciiString aPath = UTL::CString(aFileName);
344 TCollection_AsciiString anAbsolutePath;
345 if(!anAbsoluteDirectory.IsEmpty()) {
346 anAbsolutePath = AbsolutePath(anAbsoluteDirectory,aPath);
347 if(!anAbsolutePath.IsEmpty()) aPath=anAbsolutePath;
349 if(!aMsgDriver.IsNull()) {
350 // cout << "reference found; ReferenceIdentifier: " << theReferenceIdentifier << "; File:" << thePath << ", version:" << theDocumentVersion;
351 TCollection_ExtendedString aMsg("Warning: ");
352 aMsg = aMsg.Cat("reference found; ReferenceIdentifier: ").Cat(aRefId).Cat("; File:").Cat(aPath).Cat(", version:").Cat(aDocumentVersion).Cat("\0");
353 aMsgDriver->Write(aMsg.ToExtString());
357 TCollection_ExtendedString theFolder,theName;
358 //TCollection_ExtendedString theFile=myReferences(myIterator).FileName();
359 TCollection_ExtendedString f(aPath);
362 Standard_Integer i= f.SearchFromEnd("/");
363 TCollection_ExtendedString n = f.Split(i);
364 f.Trunc(f.Length()-1);
368 OSD_Path p = UTL::Path(f);
369 Standard_ExtCharacter chr;
370 TCollection_ExtendedString dir, dirRet, name;
375 for ( int i = 1; i <= dir.Length (); ++i ) {
377 chr = dir.Value ( i );
396 theName = UTL::Name(p); theName+= UTL::Extension(p);
399 Handle(CDM_MetaData) aMetaData = CDM_MetaData::LookUp(theFolder,theName,aPath,aPath,UTL::IsReadOnly(aFileName));
401 theNewDocument->CreateReference(aMetaData,aRefId,
402 theApplication,aDocumentVersion,Standard_False);
409 if(anInfo == START_REF)
410 isRef = Standard_True;
417 TCollection_ExtendedString aComment;
418 const XmlObjMgt_Element aCommentsElem =
419 theElement.GetChildByTagName ("comments");
420 if (aCommentsElem != NULL)
422 for (LDOM_Node aNode = aCommentsElem.getFirstChild();
423 aNode != NULL; aNode = aNode.getNextSibling())
425 if (aNode.getNodeType() == LDOM_Node::ELEMENT_NODE)
427 if (XmlObjMgt::GetExtendedString ((LDOM_Element&)aNode, aComment))
429 theNewDocument->AddComment(aComment);
435 // 2. Read Shapes section
436 if (myDrivers.IsNull()) myDrivers = AttributeDrivers (aMsgDriver);
437 const Handle(XmlMDF_ADriver) aNSDriver = ReadShapeSection(theElement, aMsgDriver);
438 if(!aNSDriver.IsNull())
439 ::take_time (0, " +++++ Fin reading Shapes : ", aMsgDriver);
441 // 5. Read document contents
446 TCollection_ExtendedString aMessage ("PasteDocument");
447 aMsgDriver -> Write (aMessage.ToExtString());
449 if (!MakeDocument(theElement, theNewDocument))
450 myReaderStatus = PCDM_RS_MakeFailure;
452 myReaderStatus = PCDM_RS_OK;
454 catch (Standard_Failure const& anException)
456 TCollection_ExtendedString anErrorString (anException.GetMessageString());
457 aMsgDriver -> Write (anErrorString.ToExtString());
460 // Wipe off the shapes written to the <shapes> section
461 ShapeSetCleaning(aNSDriver);
463 // Clean the relocation table.
464 // If the application needs to use myRelocTable to retrieve additional
465 // data from LDOM, this method should be reimplemented avoiding this step
466 myRelocTable.Clear();
467 ::take_time (0, " +++++ Fin reading data OCAF : ", aMsgDriver);
470 //=======================================================================
471 //function : MakeDocument
473 //=======================================================================
474 Standard_Boolean XmlLDrivers_DocumentRetrievalDriver::MakeDocument
475 (const XmlObjMgt_Element& theElement,
476 const Handle(CDM_Document)& theTDoc)
478 Standard_Boolean aResult = Standard_False;
479 Handle(TDocStd_Document) TDOC = Handle(TDocStd_Document)::DownCast(theTDoc);
480 myRelocTable.Clear();
483 Handle(TDF_Data) aTDF = new TDF_Data();
484 aResult = XmlMDF::FromTo (theElement, aTDF, myRelocTable, myDrivers);
486 TDOC->SetData (aTDF);
487 TDocStd_Owner::SetDocument (aTDF, TDOC);
493 //=======================================================================
494 //function : AttributeDrivers
496 //=======================================================================
497 Handle(XmlMDF_ADriverTable) XmlLDrivers_DocumentRetrievalDriver::AttributeDrivers
498 (const Handle(CDM_MessageDriver)& theMessageDriver)
500 return XmlLDrivers::AttributeDrivers (theMessageDriver);
503 //=======================================================================
504 //function : take_time
506 //purpose : output astronomical time elapsed
507 //=======================================================================
510 #include <sys/timeb.h>
511 #include <sys/types.h>
514 extern "C" int ftime (struct timeb *tp);
516 extern struct timeb tmbuf0;
518 static void take_time (const Standard_Integer isReset, const char * aHeader,
519 const Handle(CDM_MessageDriver)& aMessageDriver)
523 TCollection_ExtendedString aMessage ((Standard_CString)aHeader);
524 if (isReset) tmbuf0 = tmbuf;
526 char take_tm_buf [64];
527 Sprintf (take_tm_buf, "%9.2f s ++++",
528 double(tmbuf.time - tmbuf0.time) +
529 double(tmbuf.millitm - tmbuf0.millitm)/1000.);
530 aMessage += take_tm_buf;
532 aMessageDriver -> Write (aMessage.ToExtString());
536 //=======================================================================
537 //function : PropagateDocumentVersion
539 //=======================================================================
540 void XmlLDrivers_DocumentRetrievalDriver::PropagateDocumentVersion(
541 const Standard_Integer theDocVersion )
543 XmlMDataStd::SetDocumentVersion(theDocVersion);
546 //=======================================================================
547 //function : ReadShapeSection
548 //purpose : definition of ReadShapeSection
549 //=======================================================================
550 Handle(XmlMDF_ADriver) XmlLDrivers_DocumentRetrievalDriver::ReadShapeSection(
551 const XmlObjMgt_Element& /*theElement*/,
552 const Handle(CDM_MessageDriver)& /*aMsgDriver*/)
554 Handle(XmlMDF_ADriver) aDriver;
555 //empty; to be redefined
559 //=======================================================================
560 //function : ShapeSetCleaning
561 //purpose : definition of ShapeSetCleaning
562 //=======================================================================
563 void XmlLDrivers_DocumentRetrievalDriver::ShapeSetCleaning(
564 const Handle(XmlMDF_ADriver)& /*theDriver*/)