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