src/Model/Model_Session.cpp

   1 // Copyright (C) 2014-20xx CEA/DEN, EDF R&D
   2
   3 // File:        Model_Session.cxx
   4 // Created:     20 Mar 2014
   5 // Author:      Mikhail PONIKAROV
   6
   7 #include <Model_Session.h>
   8 #include <ModelAPI_Feature.h>
   9 #include <ModelAPI_Plugin.h>
  10 #include <Model_Data.h>
  11 #include <Model_Document.h>
  12 #include <Model_Objects.h>
  13 #include <Model_Application.h>
  14 #include <Model_Events.h>
  15 #include <Model_Validator.h>
  16 #include <ModelAPI_Events.h>
  17 #include <Events_Loop.h>
  18 #include <Events_InfoMessage.h>
  19 #include <Config_FeatureMessage.h>
  20 #include <Config_AttributeMessage.h>
  21 #include <Config_ValidatorMessage.h>
  22 #include <Config_ModuleReader.h>
  23 #include <Config_ValidatorReader.h>
  24 #include <ModelAPI_ResultPart.h>
  25 #include <ModelAPI_Tools.h>
  26
  27 #include <TDF_CopyTool.hxx>
  28 #include <TDF_DataSet.hxx>
  29 #include <TDF_RelocationTable.hxx>
  30 #include <TDF_ClosureTool.hxx>
  31
  32 static Model_Session* myImpl = new Model_Session();
  33
  34 // t oredirect all calls to the root document
  35 #define ROOT_DOC std::dynamic_pointer_cast<Model_Document>(moduleDocument())
  36
  37 bool Model_Session::load(const char* theFileName)
  38 {
  39   bool aRes = ROOT_DOC->load(theFileName, "root", ROOT_DOC);
  40   return aRes;
  41 }
  42
  43 bool Model_Session::save(const char* theFileName, std::list<std::string>& theResults)
  44 {
  45   return ROOT_DOC->save(theFileName, "root", theResults);
  46 }
  47
  48 void Model_Session::closeAll()
  49 {
  50   Model_Application::getApplication()->deleteAllDocuments();
  51 }
  52
  53 void Model_Session::startOperation(const std::string& theId, const bool theAttachedToNested)
  54 {
  55   myOperationAttachedToNext = theAttachedToNested;
  56   ROOT_DOC->startOperation();
  57   ROOT_DOC->operationId(theId);
  58   static std::shared_ptr<Events_Message> aStartedMsg
  59     (new Events_Message(Events_Loop::eventByName("StartOperation")));
  60   Events_Loop::loop()->send(aStartedMsg);
  61   // remove all useless documents that has been closed: on start of operation undo/redo is cleared
  62   // MPV: this code is dangerous now because it may close the document that is activated right now
  63   // but not in the list of the opened documents yet (create, delete, undo, activate Part)
  64   // later this must be updated by correct usage of uniques IDs of documents, not names of results
  65   //std::list<std::shared_ptr<ModelAPI_Document> > aUsedDocs = allOpenedDocuments();
  66   //Model_Application::getApplication()->removeUselessDocuments(aUsedDocs);
  67 }
  68
  69 void Model_Session::finishOperation()
  70 {
  71   setCheckTransactions(false);
  72   ROOT_DOC->finishOperation();
  73   if (myOperationAttachedToNext) { // twice, with nested
  74     ROOT_DOC->finishOperation();
  75     myOperationAttachedToNext = false;
  76   }
  77   setCheckTransactions(true);
  78 }
  79
  80 void Model_Session::abortOperation()
  81 {
  82   setCheckTransactions(false);
  83   ROOT_DOC->abortOperation();
  84   if (myOperationAttachedToNext) { // twice, with nested
  85     ROOT_DOC->abortOperation();
  86     myOperationAttachedToNext = false;
  87   }
  88   setCheckTransactions(true);
  89   // here the update mechanism may work after abort, so, supress the warnings about
  90   // modifications outside of the transactions
  91   bool aWasCheck = myCheckTransactions;
  92   myCheckTransactions = false;
  93   static std::shared_ptr<Events_Message> anAbortMsg
  94     (new Events_Message(Events_Loop::eventByName("AbortOperation")));
  95   Events_Loop::loop()->send(anAbortMsg);
  96   myCheckTransactions = true;
  97   myCheckTransactions = aWasCheck;
  98 }
  99
 100 bool Model_Session::isOperation()
 101 {
 102   return ROOT_DOC->isOperation();
 103 }
 104
 105 bool Model_Session::isModified()
 106 {
 107   return ROOT_DOC->isModified();
 108 }
 109
 110 bool Model_Session::canUndo()
 111 {
 112   return ROOT_DOC->canUndo();
 113 }
 114
 115 void Model_Session::undo()
 116 {
 117   setCheckTransactions(false);
 118   ROOT_DOC->undo();
 119   setCheckTransactions(true);
 120 }
 121
 122 bool Model_Session::canRedo()
 123 {
 124   return ROOT_DOC->canRedo();
 125 }
 126
 127 void Model_Session::redo()
 128 {
 129   setCheckTransactions(false);
 130   ROOT_DOC->redo();
 131   setCheckTransactions(true);
 132 }
 133
 134 //! Returns stack of performed operations
 135 std::list<std::string> Model_Session::undoList()
 136 {
 137   return ROOT_DOC->undoList();
 138 }
 139 //! Returns stack of rolled back operations
 140 std::list<std::string> Model_Session::redoList()
 141 {
 142   return ROOT_DOC->redoList();
 143 }
 144
 145 FeaturePtr Model_Session::createFeature(std::string theFeatureID, Model_Document* theDocOwner)
 146 {
 147   if (this != myImpl) {
 148     return myImpl->createFeature(theFeatureID, theDocOwner);
 149   }
 150
 151   // load all information about plugins, features and attributes
 152   LoadPluginsInfo();
 153
 154   if (myPlugins.find(theFeatureID) != myPlugins.end()) {
 155     std::pair<std::string, std::string>& aPlugin = myPlugins[theFeatureID]; // plugin and doc kind
 156     if (!aPlugin.second.empty() && aPlugin.second != theDocOwner->kind()) {
 157       Events_InfoMessage("Model_Session",
 158           "Feature '%1' can be created only in document '%2' by the XML definition")
 159           .arg(theFeatureID).arg(aPlugin.second).send();
 160       return FeaturePtr();
 161     }
 162     myCurrentPluginName = aPlugin.first;
 163     if (myPluginObjs.find(myCurrentPluginName) == myPluginObjs.end()) {
 164       // load plugin library if not yet done
 165       Config_ModuleReader::loadPlugin(myCurrentPluginName);
 166     }
 167     if (myPluginObjs.find(myCurrentPluginName) != myPluginObjs.end()) {
 168       FeaturePtr aCreated = myPluginObjs[myCurrentPluginName]->createFeature(theFeatureID);
 169       if (!aCreated) {
 170         Events_InfoMessage("Model_Session",
 171             "Can not initialize feature '%1' in plugin '%2'")
 172             .arg(theFeatureID).arg(myCurrentPluginName).send();
 173       }
 174       return aCreated;
 175     } else {
 176       Events_InfoMessage("Model_Session",
 177         "Can not load plugin '%1'").arg(myCurrentPluginName).send();
 178     }
 179   } else {
 180     Events_InfoMessage("Model_Session",
 181       "Feature '%1' not found in any plugin").arg(theFeatureID).send();
 182   }
 183
 184   return FeaturePtr();  // return nothing
 185 }
 186
 187 std::shared_ptr<ModelAPI_Document> Model_Session::moduleDocument()
 188 {
 189   Handle(Model_Application) anApp = Model_Application::getApplication();
 190   bool aFirstCall = !anApp->hasRoot();
 191   if (aFirstCall) {
 192     // to be sure that plugins are loaded,
 193     // even before the first "createFeature" call (in unit tests)
 194
 195     LoadPluginsInfo();
 196     // creation of the root document is always outside of the transaction, so, avoid checking it
 197     setCheckTransactions(false);
 198     anApp->createDocument(0); // 0 is a root ID
 199     // creation of the root document is always outside of the transaction, so, avoid checking it
 200     setCheckTransactions(true);
 201   }
 202   return anApp->rootDocument();
 203 }
 204
 205 std::shared_ptr<ModelAPI_Document> Model_Session::document(int theDocID)
 206 {
 207   return std::shared_ptr<ModelAPI_Document>(
 208       Model_Application::getApplication()->document(theDocID));
 209 }
 210
 211 bool Model_Session::hasModuleDocument()
 212 {
 213   return Model_Application::getApplication()->hasRoot();
 214 }
 215
 216 std::shared_ptr<ModelAPI_Document> Model_Session::activeDocument()
 217 {
 218   if (!myCurrentDoc || !Model_Application::getApplication()->hasDocument(myCurrentDoc->id()))
 219     myCurrentDoc = moduleDocument();
 220   return myCurrentDoc;
 221 }
 222
 223 /// makes the last feature in the document as the current
 224 static void makeCurrentLast(std::shared_ptr<ModelAPI_Document> theDoc) {
 225   if (theDoc.get()) {
 226     FeaturePtr aLast = std::dynamic_pointer_cast<Model_Document>(theDoc)->lastFeature();
 227     // if last is nested into something else, make this something else as last:
 228     // otherwise it will look like edition of sub-element, so, the main will be disabled
 229     if (aLast.get()) {
 230       CompositeFeaturePtr aMain = ModelAPI_Tools::compositeOwner(aLast);
 231       while(aMain.get()) {
 232         aLast = aMain;
 233         aMain = ModelAPI_Tools::compositeOwner(aLast);
 234       }
 235     }
 236     theDoc->setCurrentFeature(aLast, false);
 237   }
 238 }
 239
 240 void Model_Session::setActiveDocument(
 241   std::shared_ptr<ModelAPI_Document> theDoc, bool theSendSignal)
 242 {
 243   if (myCurrentDoc != theDoc) {
 244     if (myCurrentDoc.get())
 245       myCurrentDoc->setActive(false);
 246     if (theDoc.get())
 247       theDoc->setActive(true);
 248
 249     std::shared_ptr<ModelAPI_Document> aPrevious = myCurrentDoc;
 250     myCurrentDoc = theDoc;
 251     if (theDoc.get() && theSendSignal) {
 252       // this must be before the synchronisation call because features in PartSet lower than this
 253       // part feature must be disabled and don't recomputed anymore (issue 1156,
 254       // translation feature is failed on activation of Part 2)
 255       if (isOperation()) { // do it only in transaction, not on opening of document
 256         DocumentPtr aRoot = moduleDocument();
 257         if (myCurrentDoc != aRoot) {
 258           FeaturePtr aPartFeat = ModelAPI_Tools::findPartFeature(aRoot, myCurrentDoc);
 259           if (aPartFeat.get()) {
 260             aRoot->setCurrentFeature(aPartFeat, false);
 261           }
 262         }
 263       }
 264       // syncronize the document: it may be just opened or opened but removed before
 265       std::shared_ptr<Model_Document> aDoc = std::dynamic_pointer_cast<Model_Document>(theDoc);
 266       if (aDoc.get()) {
 267         bool aWasChecked = myCheckTransactions;
 268         setCheckTransactions(false);
 269         TDF_LabelList anEmptyUpdated;
 270         aDoc->objects()->synchronizeFeatures(anEmptyUpdated, true, true, false, true);
 271         if (aWasChecked)
 272             setCheckTransactions(true);
 273       }
 274       static std::shared_ptr<Events_Message> aMsg(
 275           new Events_Message(Events_Loop::eventByName(EVENT_DOCUMENT_CHANGED)));
 276       Events_Loop::loop()->send(aMsg);
 277     }
 278     // make the current state correct and synchronised in the module and sub-documents
 279     if (isOperation()) { // do it only in transaction, not on opening of document
 280       if (myCurrentDoc == moduleDocument()) {
 281         // make the current feature the latest in root, in previous root current become also last
 282         makeCurrentLast(aPrevious);
 283         makeCurrentLast(myCurrentDoc);
 284       } else {
 285         // make the current feature the latest in sub, root current feature becomes this sub
 286         makeCurrentLast(myCurrentDoc);
 287       }
 288     }
 289   }
 290 }
 291
 292 std::list<std::shared_ptr<ModelAPI_Document> > Model_Session::allOpenedDocuments()
 293 {
 294   std::list<std::shared_ptr<ModelAPI_Document> > aResult;
 295   aResult.push_back(moduleDocument());
 296   // add subs recursively
 297   std::list<std::shared_ptr<ModelAPI_Document> >::iterator aDoc = aResult.begin();
 298   for(; aDoc != aResult.end(); aDoc++) {
 299     DocumentPtr anAPIDoc = *aDoc;
 300     std::shared_ptr<Model_Document> aDoc = std::dynamic_pointer_cast<Model_Document>(anAPIDoc);
 301     if (aDoc) {
 302       const std::set<int> aSubs = aDoc->subDocuments();
 303       std::set<int>::const_iterator aSubIter = aSubs.cbegin();
 304       for(; aSubIter != aSubs.cend(); aSubIter++) {
 305         aResult.push_back(Model_Application::getApplication()->document(*aSubIter));
 306       }
 307     }
 308   }
 309   return aResult;
 310 }
 311
 312 bool Model_Session::isLoadByDemand(const std::string theDocID)
 313 {
 314   return Model_Application::getApplication()->isLoadByDemand(theDocID);
 315 }
 316
 317 std::shared_ptr<ModelAPI_Document> Model_Session::copy(
 318     std::shared_ptr<ModelAPI_Document> theSource, const int theDestID)
 319 {
 320   std::shared_ptr<Model_Document> aNew = Model_Application::getApplication()->document(theDestID);
 321   // make a copy of all labels
 322   TDF_Label aSourceRoot = std::dynamic_pointer_cast<Model_Document>(theSource)->document()->Main()
 323       .Father();
 324   TDF_Label aTargetRoot = aNew->document()->Main().Father();
 325   Handle(TDF_DataSet) aDS = new TDF_DataSet;
 326   aDS->AddLabel(aSourceRoot);
 327   TDF_ClosureTool::Closure(aDS);
 328   Handle(TDF_RelocationTable) aRT = new TDF_RelocationTable(Standard_True);
 329   aRT->SetRelocation(aSourceRoot, aTargetRoot);
 330   TDF_CopyTool::Copy(aDS, aRT);
 331
 332   TDF_LabelList anEmptyUpdated;
 333   aNew->objects()->synchronizeFeatures(anEmptyUpdated, true, true, true, true);
 334   return aNew;
 335 }
 336
 337 Model_Session::Model_Session()
 338 {
 339   myPluginsInfoLoaded = false;
 340   myCheckTransactions = true;
 341   myOperationAttachedToNext = false;
 342   ModelAPI_Session::setSession(std::shared_ptr<ModelAPI_Session>(this));
 343   // register the configuration reading listener
 344   Events_Loop* aLoop = Events_Loop::loop();
 345   static const Events_ID kFeatureEvent =
 346     Events_Loop::eventByName(Config_FeatureMessage::MODEL_EVENT());
 347   aLoop->registerListener(this, kFeatureEvent);
 348   aLoop->registerListener(this, Events_Loop::eventByName(EVENT_OBJECT_CREATED), 0, true);
 349   aLoop->registerListener(this, Events_Loop::eventByName(EVENT_OBJECT_UPDATED), 0, true);
 350   aLoop->registerListener(this, Events_Loop::eventByName(EVENT_OBJECT_DELETED), 0, true);
 351   aLoop->registerListener(this, Events_Loop::eventByName(EVENT_VALIDATOR_LOADED));
 352 }
 353
 354 void Model_Session::processEvent(const std::shared_ptr<Events_Message>& theMessage)
 355 {
 356   static const Events_ID kFeatureEvent =
 357     Events_Loop::eventByName(Config_FeatureMessage::MODEL_EVENT());
 358   static const Events_ID kValidatorEvent = Events_Loop::eventByName(EVENT_VALIDATOR_LOADED);
 359   if (theMessage->eventID() == kFeatureEvent) {
 360     const std::shared_ptr<Config_FeatureMessage> aMsg =
 361       std::dynamic_pointer_cast<Config_FeatureMessage>(theMessage);
 362     if (aMsg) {
 363
 364       // process the plugin info, load plugin
 365       if (myPlugins.find(aMsg->id()) == myPlugins.end()) {
 366         myPlugins[aMsg->id()] = std::pair<std::string, std::string>(
 367           aMsg->pluginLibrary(), aMsg->documentKind());
 368       }
 369     } else {
 370       const std::shared_ptr<Config_AttributeMessage> aMsgAttr =
 371         std::dynamic_pointer_cast<Config_AttributeMessage>(theMessage);
 372       if (aMsgAttr) {
 373
 374         if (!aMsgAttr->isObligatory()) {
 375           validators()->registerNotObligatory(aMsgAttr->featureId(), aMsgAttr->attributeId());
 376         }
 377         if(aMsgAttr->isConcealment()) {
 378           validators()->registerConcealment(aMsgAttr->featureId(), aMsgAttr->attributeId());
 379         }
 380         const std::list<std::pair<std::string, std::string> >& aCases = aMsgAttr->getCases();
 381         if (!aCases.empty()) {
 382           validators()->registerCase(aMsgAttr->featureId(), aMsgAttr->attributeId(), aCases);
 383         }
 384       }
 385     }
 386     // plugins information was started to load, so, it will be loaded
 387     myPluginsInfoLoaded = true;
 388   } else if (theMessage->eventID() == kValidatorEvent) {
 389     std::shared_ptr<Config_ValidatorMessage> aMsg =
 390       std::dynamic_pointer_cast<Config_ValidatorMessage>(theMessage);
 391     if (aMsg) {
 392       if (aMsg->attributeId().empty()) {  // feature validator
 393         validators()->assignValidator(aMsg->validatorId(), aMsg->featureId(), aMsg->parameters());
 394       } else {  // attribute validator
 395         validators()->assignValidator(aMsg->validatorId(), aMsg->featureId(), aMsg->attributeId(),
 396                                       aMsg->parameters());
 397       }
 398     }
 399   } else {  // create/update/delete
 400     if (myCheckTransactions && !isOperation())
 401       Events_InfoMessage("Model_Session",
 402         "Modification of data structure outside of the transaction").send();
 403     // if part is deleted, make the root as the current document (on undo of Parts creations)
 404     static const Events_ID kDeletedEvent = Events_Loop::eventByName(EVENT_OBJECT_DELETED);
 405     if (theMessage->eventID() == kDeletedEvent) {
 406       std::shared_ptr<ModelAPI_ObjectDeletedMessage> aDeleted =
 407         std::dynamic_pointer_cast<ModelAPI_ObjectDeletedMessage>(theMessage);
 408       if (aDeleted &&
 409           aDeleted->groups().find(ModelAPI_ResultPart::group()) != aDeleted->groups().end())
 410       {
 411          // check that the current feature of the session is still the active Part (even disabled)
 412         bool aFound = false;
 413         FeaturePtr aCurrentPart = moduleDocument()->currentFeature(true);
 414         if (aCurrentPart.get()) {
 415           const std::list<std::shared_ptr<ModelAPI_Result> >& aResList = aCurrentPart->results();
 416           std::list<std::shared_ptr<ModelAPI_Result> >::const_iterator aRes = aResList.begin();
 417           for(; !aFound && aRes != aResList.end(); aRes++) {
 418             ResultPartPtr aPRes = std::dynamic_pointer_cast<ModelAPI_ResultPart>(*aRes);
 419             if (aPRes.get() && aPRes->isActivated() && aPRes->partDoc() == activeDocument()) {
 420               aFound = true;
 421
 422             }
 423           }
 424         }
 425         if (!aFound) { // if not, the part was removed, so activate the module document
 426           if (myCurrentDoc.get())
 427             setActiveDocument(moduleDocument());
 428         }
 429       }
 430     }
 431   }
 432 }
 433
 434 void Model_Session::LoadPluginsInfo()
 435 {
 436   if (myPluginsInfoLoaded)  // nothing to do
 437     return;
 438   // Read plugins information from XML files
 439   Config_ModuleReader aModuleReader(Config_FeatureMessage::MODEL_EVENT());
 440   aModuleReader.readAll();
 441   std::set<std::string> aFiles = aModuleReader.modulePluginFiles();
 442   std::set<std::string>::iterator it = aFiles.begin();
 443   for ( ; it != aFiles.end(); it++ ) {
 444     Config_ValidatorReader aValidatorReader (*it);
 445     aValidatorReader.readAll();
 446   };
 447
 448 }
 449
 450 void Model_Session::registerPlugin(ModelAPI_Plugin* thePlugin)
 451 {
 452   myPluginObjs[myCurrentPluginName] = thePlugin;
 453   static Events_ID EVENT_LOAD = Events_Loop::loop()->eventByName(EVENT_PLUGIN_LOADED);
 454   ModelAPI_EventCreator::get()->sendUpdated(ObjectPtr(), EVENT_LOAD);
 455   Events_Loop::loop()->flush(EVENT_LOAD);
 456   // If the plugin has an ability to process GUI events, register it
 457   Events_Listener* aListener = dynamic_cast<Events_Listener*>(thePlugin);
 458   if (aListener) {
 459     Events_Loop* aLoop = Events_Loop::loop();
 460     static Events_ID aStateRequestEventId =
 461         Events_Loop::loop()->eventByName(EVENT_FEATURE_STATE_REQUEST);
 462     aLoop->registerListener(aListener, aStateRequestEventId);
 463   }
 464 }
 465
 466 ModelAPI_ValidatorsFactory* Model_Session::validators()
 467 {
 468   static Model_ValidatorsFactory* aFactory = new Model_ValidatorsFactory;
 469   return aFactory;
 470 }
 471
 472 int Model_Session::transactionID()
 473 {
 474   return ROOT_DOC->transactionID();
 475 }