src/XmlLDrivers/XmlLDrivers_DocumentStorageDriver.cxx

   1 // Created on: 2001-07-09
   2 // Created by: Julia DOROVSKIKH
   3 // Copyright (c) 2001-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 <CDM_Application.hxx>
  18 #include <CDM_Document.hxx>
  19 #include <Message.hxx>
  20 #include <Message_Messenger.hxx>
  21 #include <Message_ProgressSentry.hxx>
  22 #include <LDOM_DocumentType.hxx>
  23 #include <LDOM_LDOMImplementation.hxx>
  24 #include <LDOM_XmlWriter.hxx>
  25 #include <OSD_Environment.hxx>
  26 #include <OSD_File.hxx>
  27 #include <OSD_OpenFile.hxx>
  28 #include <PCDM.hxx>
  29 #include <PCDM_ReadWriter.hxx>
  30 #include <Standard_ErrorHandler.hxx>
  31 #include <Standard_Failure.hxx>
  32 #include <Standard_Type.hxx>
  33 #include <Storage_Data.hxx>
  34 #include <TCollection_AsciiString.hxx>
  35 #include <TCollection_ExtendedString.hxx>
  36 #include <TColStd_SequenceOfAsciiString.hxx>
  37 #include <TDocStd_Document.hxx>
  38 #include <XmlLDrivers.hxx>
  39 #include <XmlLDrivers_DocumentStorageDriver.hxx>
  40 #include <XmlLDrivers_NamespaceDef.hxx>
  41 #include <XmlMDF.hxx>
  42 #include <XmlMDF_ADriverTable.hxx>
  43 #include <XmlObjMgt.hxx>
  44 #include <XmlObjMgt_Document.hxx>
  45 #include <XmlObjMgt_SRelocationTable.hxx>
  46
  47 #include <locale.h>
  48 IMPLEMENT_STANDARD_RTTIEXT(XmlLDrivers_DocumentStorageDriver,PCDM_StorageDriver)
  49
  50 #define STORAGE_VERSION      "STORAGE_VERSION: "
  51 #define REFERENCE_COUNTER    "REFERENCE_COUNTER: "
  52 #define MODIFICATION_COUNTER "MODIFICATION_COUNTER: "
  53 #define START_REF            "START_REF"
  54 #define END_REF              "END_REF"
  55
  56 #define FAILSTR "Failed to write xsi:schemaLocation : "
  57
  58 //#define TAKE_TIMES
  59 static void take_time (const Standard_Integer, const char *,
  60                        const Handle(Message_Messenger)&)
  61 #ifdef TAKE_TIMES
  62 ;
  63 #else
  64 {}
  65 #endif
  66
  67 //=======================================================================
  68 //function : XmlLDrivers_DocumentStorageDriver
  69 //purpose  : Constructor
  70 //=======================================================================
  71 XmlLDrivers_DocumentStorageDriver::XmlLDrivers_DocumentStorageDriver
  72                                 (const TCollection_ExtendedString& theCopyright)
  73      : myCopyright (theCopyright)
  74 {
  75 }
  76
  77 //=======================================================================
  78 //function : AddNamespace
  79 //purpose  :
  80 //=======================================================================
  81
  82 void XmlLDrivers_DocumentStorageDriver::AddNamespace
  83                                 (const TCollection_AsciiString& thePrefix,
  84                                  const TCollection_AsciiString& theURI)
  85 {
  86   for (Standard_Integer i = 1; i <= mySeqOfNS.Length(); i++)
  87     if (thePrefix == mySeqOfNS(i).Prefix()) return;
  88   mySeqOfNS.Append (XmlLDrivers_NamespaceDef(thePrefix, theURI));
  89 }
  90
  91 //=======================================================================
  92 //function : Write
  93 //purpose  :
  94 //=======================================================================
  95 void XmlLDrivers_DocumentStorageDriver::Write (const Handle(CDM_Document)&       theDocument,
  96                                                const TCollection_ExtendedString& theFileName,
  97                                                const Handle(Message_ProgressIndicator)& theProgress)
  98 {
  99   myFileName = theFileName;
 100
 101   std::ofstream aFileStream;
 102   OSD_OpenStream (aFileStream, theFileName, std::ios::out);
 103
 104   if (aFileStream.is_open() && aFileStream.good())
 105   {
 106     Write (theDocument, aFileStream, theProgress);
 107   }
 108   else
 109   {
 110     SetIsError (Standard_True);
 111     SetStoreStatus(PCDM_SS_WriteFailure);
 112
 113     TCollection_ExtendedString aMsg = TCollection_ExtendedString("Error: the file ") +
 114                                       theFileName + " cannot be opened for writing";
 115
 116     theDocument->Application()->MessageDriver()->Send (aMsg.ToExtString(), Message_Fail);
 117     throw Standard_Failure("File cannot be opened for writing");
 118   }
 119 }
 120
 121 //=======================================================================
 122 //function : Write
 123 //purpose  :
 124 //=======================================================================
 125 void XmlLDrivers_DocumentStorageDriver::Write (const Handle(CDM_Document)& theDocument,
 126                                                Standard_OStream&           theOStream,
 127                                                const Handle(Message_ProgressIndicator)& theProgress)
 128 {
 129   Handle(Message_Messenger) aMessageDriver = theDocument->Application()->MessageDriver();
 130   ::take_time (~0, " +++++ Start STORAGE procedures ++++++", aMessageDriver);
 131
 132   // Create new DOM_Document
 133   XmlObjMgt_Document aDOMDoc = XmlObjMgt_Document::createDocument ("document");
 134
 135   // Fill the document with data
 136   XmlObjMgt_Element anElement = aDOMDoc.getDocumentElement();
 137
 138   if (WriteToDomDocument (theDocument, anElement, theProgress) == Standard_False) {
 139
 140     LDOM_XmlWriter aWriter;
 141     aWriter.SetIndentation(1);
 142
 143     if (theOStream.good())
 144     {
 145       aWriter.Write (theOStream, aDOMDoc);
 146     }
 147     else
 148     {
 149       SetIsError (Standard_True);
 150       SetStoreStatus(PCDM_SS_WriteFailure);
 151
 152       TCollection_ExtendedString aMsg = TCollection_ExtendedString("Error: the stream is bad and") +
 153                                         " cannot be used for writing";
 154       theDocument->Application()->MessageDriver()->Send (aMsg.ToExtString(), Message_Fail);
 155
 156       throw Standard_Failure("File cannot be opened for writing");
 157     }
 158
 159     ::take_time (0, " +++++ Fin formatting to XML : ", aMessageDriver);
 160   }
 161 }
 162
 163 //=======================================================================
 164 //function : WriteToDomDocument
 165 //purpose  : management of the macro-structure of XML document data
 166 //remark   : If the application needs to use myRelocTable to store additional
 167 //           data to XML, this method should be reimplemented avoiding step 3
 168 //=======================================================================
 169
 170 Standard_Boolean XmlLDrivers_DocumentStorageDriver::WriteToDomDocument
 171                           (const Handle(CDM_Document)&  theDocument,
 172                            XmlObjMgt_Element&           theElement,
 173                            const Handle(Message_ProgressIndicator)& theProgress)
 174 {
 175   SetIsError(Standard_False);
 176   Handle(Message_Messenger) aMessageDriver =
 177     theDocument -> Application() -> MessageDriver();
 178   // 1. Write header information
 179   Standard_Integer i;
 180   XmlObjMgt_Document aDOMDoc = theElement.getOwnerDocument();
 181
 182   // 1.a File Format
 183   TCollection_AsciiString aStorageFormat (theDocument->StorageFormat(), '?');
 184   theElement.setAttribute ("format", aStorageFormat.ToCString());
 185 //  theElement.setAttribute ("schema", "XSD");
 186
 187   theElement.setAttribute ("xmlns" , "http://www.opencascade.org/OCAF/XML");
 188   for (i = 1; i <= mySeqOfNS.Length(); i++) {
 189     TCollection_AsciiString aPrefix =
 190       TCollection_AsciiString("xmlns:") + mySeqOfNS(i).Prefix().ToCString();
 191     theElement.setAttribute (aPrefix.ToCString(),
 192                              mySeqOfNS(i).URI().ToCString());
 193   }
 194   theElement.setAttribute ("xmlns:xsi",
 195                            "http://www.w3.org/2001/XMLSchema-instance");
 196   //mkv 15.09.05 OCC10001
 197   //theElement.setAttribute ("xsi:schemaLocation",
 198   //                         "http://www.opencascade.org/OCAF/XML"
 199   //                         " http://www.nnov.matra-dtv.fr/~agv/XmlOcaf.xsd");
 200   //
 201   // the order of search : by CSF_XmlOcafResource and then by CASROOT
 202   TCollection_AsciiString anHTTP = "http://www.opencascade.org/OCAF/XML";
 203   Standard_Boolean aToSetCSFVariable = Standard_False;
 204   const char * aCSFVariable [2] = {
 205     "CSF_XmlOcafResource",
 206     "CASROOT"
 207   };
 208   OSD_Environment anEnv (aCSFVariable[0]);
 209   TCollection_AsciiString aResourceDir = anEnv.Value();
 210   if (aResourceDir.IsEmpty()) {
 211     // now try by CASROOT
 212     OSD_Environment anEnv2(aCSFVariable[1]);
 213     aResourceDir = anEnv2.Value();
 214     if ( !aResourceDir.IsEmpty() ) {
 215       aResourceDir += "/src/XmlOcafResource" ;
 216       aToSetCSFVariable = Standard_True; //CSF variable to be set later
 217     }
 218 #ifdef OCCT_DEBUGXML
 219     else {
 220       TCollection_ExtendedString aWarn = FAILSTR "Neither ";
 221       aWarn = (aWarn + aCSFVariable[0] + ", nor " + aCSFVariable[1]
 222                + " variables have been set");
 223       aMessageDriver->Send (aWarn.ToExtString(), Message_Warning);
 224     }
 225 #endif
 226   }
 227   if (!aResourceDir.IsEmpty()) {
 228     TCollection_AsciiString aResourceFileName =  aResourceDir + "/XmlOcaf.xsd";
 229     // search directory name that has been constructed, now check whether
 230     // it and the file exist
 231     OSD_File aResourceFile ( aResourceFileName );
 232     if ( aResourceFile.Exists() ) {
 233       if (aToSetCSFVariable) {
 234         OSD_Environment aCSFVarEnv ( aCSFVariable[0], aResourceDir );
 235         aCSFVarEnv.Build();
 236 #ifdef OCCT_DEBUGXML
 237         TCollection_ExtendedString aWarn1 = "Variable ";
 238         aWarn1 = (aWarn1 + aCSFVariable[0]
 239                   + " has not been explicitly defined. Set to " + aResourceDir);
 240         aMessageDriver->Send (aWarn1.ToExtString(), Message_Warning);
 241 #endif
 242         if ( aCSFVarEnv.Failed() ) {
 243           TCollection_ExtendedString aWarn = FAILSTR "Failed to initialize ";
 244           aWarn = aWarn + aCSFVariable[0] + " with " + aResourceDir;
 245           aMessageDriver->Send (aWarn.ToExtString(), Message_Fail);
 246         }
 247       }
 248     }
 249 #ifdef OCCT_DEBUGXML
 250     else {
 251       TCollection_ExtendedString aWarn = FAILSTR "Schema definition file ";
 252       aWarn += (aResourceFileName + " was not found");
 253       aMessageDriver->Send (aWarn.ToExtString(), Message_Warning);
 254     }
 255 #endif
 256     anHTTP = anHTTP + ' ' + aResourceFileName;
 257   }
 258   theElement.setAttribute ("xsi:schemaLocation", anHTTP.ToCString() );
 259
 260   // 1.b Info section
 261   XmlObjMgt_Element anInfoElem = aDOMDoc.createElement("info");
 262   theElement.appendChild(anInfoElem);
 263
 264   TCollection_AsciiString aCreationDate = XmlLDrivers::CreationDate();
 265
 266 //  anInfoElem.setAttribute("dbv", 0);
 267   anInfoElem.setAttribute("date", aCreationDate.ToCString());
 268   anInfoElem.setAttribute("schemav", 0);
 269 //  anInfoElem.setAttribute("appv", anAppVersion.ToCString());
 270
 271   // Document version
 272   Standard_Integer aFormatVersion(XmlLDrivers::StorageVersion());// the last version of the format
 273   if (theDocument->StorageFormatVersion() > 0)
 274   {
 275     if (XmlLDrivers::StorageVersion() < theDocument->StorageFormatVersion())
 276     {
 277       TCollection_ExtendedString anErrorString("Unacceptable storage format version, the last verson is used");
 278       aMessageDriver->Send(anErrorString.ToExtString(), Message_Warning);
 279     }
 280     else
 281       aFormatVersion = theDocument->StorageFormatVersion();
 282   }
 283   anInfoElem.setAttribute("DocVersion", aFormatVersion);
 284
 285   // User info with Copyright
 286   TColStd_SequenceOfAsciiString aUserInfo;
 287   if (myCopyright.Length() > 0)
 288     aUserInfo.Append (TCollection_AsciiString(myCopyright,'?'));
 289
 290   Handle(Storage_Data) theData = new Storage_Data;
 291   //PCDM_ReadWriter::WriteFileFormat( theData, theDocument );
 292   PCDM_ReadWriter::Writer()->WriteReferenceCounter(theData,theDocument);
 293   PCDM_ReadWriter::Writer()->WriteReferences(theData,theDocument, myFileName);
 294   PCDM_ReadWriter::Writer()->WriteExtensions(theData,theDocument);
 295   PCDM_ReadWriter::Writer()->WriteVersion(theData,theDocument);
 296
 297   const TColStd_SequenceOfAsciiString& aRefs = theData->UserInfo();
 298   for(i = 1; i <= aRefs.Length(); i++)
 299     aUserInfo.Append(aRefs.Value(i));
 300
 301   // Keep fomat version in Reloc. table
 302   Handle(Storage_HeaderData) aHeaderData = theData->HeaderData();
 303   aHeaderData->SetStorageVersion(aFormatVersion);
 304   myRelocTable.Clear();
 305   myRelocTable.SetHeaderData(aHeaderData);
 306
 307   for (i = 1; i <= aUserInfo.Length(); i++)
 308   {
 309     XmlObjMgt_Element aUIItem = aDOMDoc.createElement ("iitem");
 310     anInfoElem.appendChild (aUIItem);
 311     LDOM_Text aUIText = aDOMDoc.createTextNode (aUserInfo(i).ToCString());
 312     aUIItem.appendChild (aUIText);
 313   }
 314
 315   // 1.c Comments section
 316   TColStd_SequenceOfExtendedString aComments;
 317   theDocument->Comments(aComments);
 318
 319   XmlObjMgt_Element aCommentsElem = aDOMDoc.createElement ("comments");
 320   theElement.appendChild (aCommentsElem);
 321
 322   for (i = 1; i <= aComments.Length(); i++)
 323   {
 324     XmlObjMgt_Element aCItem = aDOMDoc.createElement ("citem");
 325     aCommentsElem.appendChild (aCItem);
 326     XmlObjMgt::SetExtendedString (aCItem, aComments(i));
 327   }
 328   Message_ProgressSentry aPS(theProgress, "Writing", 0, 2, 1);
 329   // 2a. Write document contents
 330   Standard_Integer anObjNb = 0;
 331   {
 332     try
 333     {
 334       OCC_CATCH_SIGNALS
 335       anObjNb = MakeDocument(theDocument, theElement, theProgress);
 336       if (!aPS.More())
 337       {
 338         SetIsError(Standard_True);
 339         SetStoreStatus(PCDM_SS_UserBreak);
 340         return IsError();
 341       }
 342       aPS.Next();
 343     }
 344     catch (Standard_Failure const& anException)
 345     {
 346       SetIsError (Standard_True);
 347       SetStoreStatus(PCDM_SS_Failure);
 348       TCollection_ExtendedString anErrorString (anException.GetMessageString());
 349       aMessageDriver ->Send (anErrorString.ToExtString(), Message_Fail);
 350     }
 351   }
 352   if (anObjNb <= 0 && IsError() == Standard_False) {
 353     SetIsError (Standard_True);
 354     SetStoreStatus(PCDM_SS_No_Obj);
 355     TCollection_ExtendedString anErrorString ("error occurred");
 356     aMessageDriver ->Send (anErrorString.ToExtString(), Message_Fail);
 357   }
 358   // 2b. Write number of objects into the info section
 359   anInfoElem.setAttribute("objnb", anObjNb);
 360   ::take_time (0, " +++++ Fin DOM data for OCAF : ", aMessageDriver);
 361
 362   // 3. Clear relocation table
 363   //    If the application needs to use myRelocTable to store additional
 364   //    data to XML, this method should be reimplemented avoiding this step
 365   myRelocTable.Clear();
 366
 367   // 4. Write Shapes section
 368   if (WriteShapeSection(theElement, theProgress))
 369     ::take_time (0, " +++ Fin DOM data for Shapes : ", aMessageDriver);
 370   if (!aPS.More())
 371   {
 372     SetIsError(Standard_True);
 373     SetStoreStatus(PCDM_SS_UserBreak);
 374     return IsError();
 375   }
 376   aPS.Next();
 377   return IsError();
 378 }
 379
 380 //=======================================================================
 381 //function : MakeDocument
 382 //purpose  :
 383 //=======================================================================
 384 Standard_Integer XmlLDrivers_DocumentStorageDriver::MakeDocument
 385                                     (const Handle(CDM_Document)& theTDoc,
 386                                      XmlObjMgt_Element&          theElement,
 387                                      const Handle(Message_ProgressIndicator)& theProgress)
 388 {
 389   TCollection_ExtendedString aMessage;
 390   Handle(TDocStd_Document) TDOC = Handle(TDocStd_Document)::DownCast(theTDoc);
 391   if (!TDOC.IsNull())
 392   {
 393 //    myRelocTable.SetDocument (theElement.getOwnerDocument());
 394     Handle(TDF_Data) aTDF = TDOC->GetData();
 395
 396 //      Find MessageDriver and pass it to AttributeDrivers()
 397     Handle(CDM_Application) anApplication= theTDoc -> Application();
 398     Handle(Message_Messenger) aMessageDriver;
 399     if (anApplication.IsNull()) {
 400       aMessageDriver = Message::DefaultMessenger();
 401       aMessageDriver->ChangePrinters().Clear();
 402     }
 403     else
 404       aMessageDriver = anApplication -> MessageDriver();
 405     if (myDrivers.IsNull()) myDrivers = AttributeDrivers (aMessageDriver);
 406
 407 //      Retrieve from DOM_Document
 408     XmlMDF::FromTo (aTDF, theElement, myRelocTable, myDrivers, theProgress);
 409 #ifdef OCCT_DEBUGXML
 410     aMessage = "First step successfull";
 411     aMessageDriver -> Send (aMessage.ToExtString(), Message_Warning);
 412 #endif
 413     return myRelocTable.Extent();
 414   }
 415 #ifdef OCCT_DEBUG
 416   std::cout << "First step failed" << std::endl;  // No MessageDriver available
 417 #endif
 418   return -1; // error
 419 }
 420
 421 //=======================================================================
 422 //function : AttributeDrivers
 423 //purpose  :
 424 //=======================================================================
 425 Handle(XmlMDF_ADriverTable) XmlLDrivers_DocumentStorageDriver::AttributeDrivers
 426        (const Handle(Message_Messenger)& theMessageDriver)
 427 {
 428   return XmlLDrivers::AttributeDrivers (theMessageDriver);
 429 }
 430
 431 //=======================================================================
 432 //function : take_time
 433 //class    : static
 434 //purpose  : output astronomical time elapsed
 435 //=======================================================================
 436 #ifdef TAKE_TIMES
 437 #include <time.h>
 438 #include <sys/timeb.h>
 439 #include <sys/types.h>
 440 #include <stdio.h>
 441 #ifndef _WIN32
 442 extern "C" int ftime (struct timeb *tp);
 443 #endif
 444 struct timeb  tmbuf0;
 445
 446 static void take_time (const Standard_Integer isReset, const char * aHeader,
 447                        const Handle(Message_Messenger)& aMessageDriver)
 448 {
 449   struct timeb  tmbuf;
 450   ftime (&tmbuf);
 451   TCollection_ExtendedString aMessage ((Standard_CString)aHeader);
 452   if (isReset) tmbuf0 = tmbuf;
 453   else {
 454     char take_tm_buf [64];
 455     Sprintf (take_tm_buf, "%9.2f s ++++",
 456              double(tmbuf.time - tmbuf0.time) +
 457              double(tmbuf.millitm - tmbuf0.millitm)/1000.);
 458     aMessage += take_tm_buf;
 459   }
 460   aMessageDriver ->Send (aMessage.ToExtString(), Message_Trace);
 461 }
 462 #endif
 463
 464 //=======================================================================
 465 //function : WriteShapeSection
 466 //purpose  : defines WriteShapeSection
 467 //=======================================================================
 468 Standard_Boolean XmlLDrivers_DocumentStorageDriver::WriteShapeSection
 469                                 (XmlObjMgt_Element&  /*theElement*/,
 470                                 const Handle(Message_ProgressIndicator)& /*theProgress*/)
 471 {
 472   // empty; should be redefined in subclasses
 473   return Standard_False;
 474 }
 475