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_Error.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_Error::send(
 160           string("Feature '") + theFeatureID + "' can be created only in document '"
 161               + aPlugin.second + "' by the XML definition");
 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_Error::send(
 173             string("Can not initialize feature '") + theFeatureID + "' in plugin '"
 174                 + myCurrentPluginName + "'");
 175       }
 176       return aCreated;
 177     } else {
 178       Events_Error::send(string("Can not load plugin '") + myCurrentPluginName + "'");
 179     }
 180   } else {
 181     Events_Error::send(string("Feature '") + theFeatureID + "' not found in any plugin");
 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     // creation of the root document is always outside of the transaction, so, avoid checking it
 193     setCheckTransactions(false);
 194     anApp->createDocument(0); // 0 is a root ID
 195     // creation of the root document is always outside of the transaction, so, avoid checking it
 196     setCheckTransactions(true);
 197   }
 198   return anApp->rootDocument();
 199 }
 200
 201 std::shared_ptr<ModelAPI_Document> Model_Session::document(int theDocID)
 202 {
 203   return std::shared_ptr<ModelAPI_Document>(
 204       Model_Application::getApplication()->document(theDocID));
 205 }
 206
 207 bool Model_Session::hasModuleDocument()
 208 {
 209   return Model_Application::getApplication()->hasRoot();
 210 }
 211
 212 std::shared_ptr<ModelAPI_Document> Model_Session::activeDocument()
 213 {
 214   if (!myCurrentDoc || !Model_Application::getApplication()->hasDocument(myCurrentDoc->id()))
 215     myCurrentDoc = moduleDocument();
 216   return myCurrentDoc;
 217 }
 218
 219 /// makes the last feature in the document as the current
 220 static void makeCurrentLast(std::shared_ptr<ModelAPI_Document> theDoc) {
 221   if (theDoc.get()) {
 222     FeaturePtr aLast = std::dynamic_pointer_cast<Model_Document>(theDoc)->lastFeature();
 223     // if last is nested into something else, make this something else as last:
 224     // otherwise it will look like edition of sub-element, so, the main will be disabled
 225     if (aLast.get()) {
 226       CompositeFeaturePtr aMain = ModelAPI_Tools::compositeOwner(aLast);
 227       while(aMain.get()) {
 228         aLast = aMain;
 229         aMain = ModelAPI_Tools::compositeOwner(aLast);
 230       }
 231     }
 232     theDoc->setCurrentFeature(aLast, false);
 233   }
 234 }
 235
 236 void Model_Session::setActiveDocument(
 237   std::shared_ptr<ModelAPI_Document> theDoc, bool theSendSignal)
 238 {
 239   if (myCurrentDoc != theDoc) {
 240     if (myCurrentDoc.get())
 241       myCurrentDoc->setActive(false);
 242     if (theDoc.get())
 243       theDoc->setActive(true);
 244
 245     std::shared_ptr<ModelAPI_Document> aPrevious = myCurrentDoc;
 246     myCurrentDoc = theDoc;
 247     if (theDoc.get() && theSendSignal) {
 248       // this must be before the synchronisation call because features in PartSet lower than this
 249       // part feature must be disabled and don't recomputed anymore (issue 1156,
 250       // translation feature is failed on activation of Part 2)
 251       if (isOperation()) { // do it only in transaction, not on opening of document
 252         DocumentPtr aRoot = moduleDocument();
 253         if (myCurrentDoc != aRoot) {
 254           FeaturePtr aPartFeat = ModelAPI_Tools::findPartFeature(aRoot, myCurrentDoc);
 255           if (aPartFeat.get()) {
 256             aRoot->setCurrentFeature(aPartFeat, false);
 257           }
 258         }
 259       }
 260       // syncronize the document: it may be just opened or opened but removed before
 261       std::shared_ptr<Model_Document> aDoc = std::dynamic_pointer_cast<Model_Document>(theDoc);
 262       if (aDoc.get()) {
 263         bool aWasChecked = myCheckTransactions;
 264         setCheckTransactions(false);
 265         TDF_LabelList anEmptyUpdated;
 266         aDoc->objects()->synchronizeFeatures(anEmptyUpdated, true, true, true);
 267         if (aWasChecked)
 268             setCheckTransactions(true);
 269       }
 270       static std::shared_ptr<Events_Message> aMsg(
 271           new Events_Message(Events_Loop::eventByName(EVENT_DOCUMENT_CHANGED)));
 272       Events_Loop::loop()->send(aMsg);
 273     }
 274     // make the current state correct and synchronised in the module and sub-documents
 275     if (isOperation()) { // do it only in transaction, not on opening of document
 276       if (myCurrentDoc == moduleDocument()) {
 277         // make the current feature the latest in root, in previous root current become also last
 278         makeCurrentLast(aPrevious);
 279         makeCurrentLast(myCurrentDoc);
 280       } else {
 281         // make the current feature the latest in sub, root current feature becomes this sub
 282         makeCurrentLast(myCurrentDoc);
 283       }
 284     }
 285   }
 286 }
 287
 288 std::list<std::shared_ptr<ModelAPI_Document> > Model_Session::allOpenedDocuments()
 289 {
 290   list<std::shared_ptr<ModelAPI_Document> > aResult;
 291   aResult.push_back(moduleDocument());
 292   // add subs recursively
 293   list<std::shared_ptr<ModelAPI_Document> >::iterator aDoc = aResult.begin();
 294   for(; aDoc != aResult.end(); aDoc++) {
 295     DocumentPtr anAPIDoc = *aDoc;
 296     std::shared_ptr<Model_Document> aDoc = std::dynamic_pointer_cast<Model_Document>(anAPIDoc);
 297     if (aDoc) {
 298       const std::set<int> aSubs = aDoc->subDocuments();
 299       std::set<int>::const_iterator aSubIter = aSubs.cbegin();
 300       for(; aSubIter != aSubs.cend(); aSubIter++) {
 301         aResult.push_back(Model_Application::getApplication()->document(*aSubIter));
 302       }
 303     }
 304   }
 305   return aResult;
 306 }
 307
 308 bool Model_Session::isLoadByDemand(const std::string theDocID)
 309 {
 310   return Model_Application::getApplication()->isLoadByDemand(theDocID);
 311 }
 312
 313 std::shared_ptr<ModelAPI_Document> Model_Session::copy(
 314     std::shared_ptr<ModelAPI_Document> theSource, const int theDestID)
 315 {
 316   std::shared_ptr<Model_Document> aNew = Model_Application::getApplication()->document(theDestID);
 317   // make a copy of all labels
 318   TDF_Label aSourceRoot = std::dynamic_pointer_cast<Model_Document>(theSource)->document()->Main()
 319       .Father();
 320   TDF_Label aTargetRoot = aNew->document()->Main().Father();
 321   Handle(TDF_DataSet) aDS = new TDF_DataSet;
 322   aDS->AddLabel(aSourceRoot);
 323   TDF_ClosureTool::Closure(aDS);
 324   Handle(TDF_RelocationTable) aRT = new TDF_RelocationTable;
 325   aRT->SetRelocation(aSourceRoot, aTargetRoot);
 326   TDF_CopyTool::Copy(aDS, aRT);
 327
 328   TDF_LabelList anEmptyUpdated;
 329   aNew->objects()->synchronizeFeatures(anEmptyUpdated, true, true, true);
 330   return aNew;
 331 }
 332
 333 Model_Session::Model_Session()
 334 {
 335   myPluginsInfoLoaded = false;
 336   myCheckTransactions = true;
 337   myOperationAttachedToNext = false;
 338   ModelAPI_Session::setSession(std::shared_ptr<ModelAPI_Session>(this));
 339   // register the configuration reading listener
 340   Events_Loop* aLoop = Events_Loop::loop();
 341   static const Events_ID kFeatureEvent =
 342     Events_Loop::eventByName(Config_FeatureMessage::MODEL_EVENT());
 343   aLoop->registerListener(this, kFeatureEvent);
 344   aLoop->registerListener(this, Events_Loop::eventByName(EVENT_OBJECT_CREATED), 0, true);
 345   aLoop->registerListener(this, Events_Loop::eventByName(EVENT_OBJECT_UPDATED), 0, true);
 346   aLoop->registerListener(this, Events_Loop::eventByName(EVENT_OBJECT_DELETED), 0, true);
 347   aLoop->registerListener(this, Events_Loop::eventByName(EVENT_VALIDATOR_LOADED));
 348 }
 349
 350 void Model_Session::processEvent(const std::shared_ptr<Events_Message>& theMessage)
 351 {
 352   static const Events_ID kFeatureEvent =
 353     Events_Loop::eventByName(Config_FeatureMessage::MODEL_EVENT());
 354   static const Events_ID kValidatorEvent = Events_Loop::eventByName(EVENT_VALIDATOR_LOADED);
 355   if (theMessage->eventID() == kFeatureEvent) {
 356     const std::shared_ptr<Config_FeatureMessage> aMsg =
 357       std::dynamic_pointer_cast<Config_FeatureMessage>(theMessage);
 358     if (aMsg) {
 359       // process the plugin info, load plugin
 360       if (myPlugins.find(aMsg->id()) == myPlugins.end()) {
 361         myPlugins[aMsg->id()] = std::pair<std::string, std::string>(
 362           aMsg->pluginLibrary(), aMsg->documentKind());
 363       }
 364     } else {
 365       const std::shared_ptr<Config_AttributeMessage> aMsgAttr =
 366         std::dynamic_pointer_cast<Config_AttributeMessage>(theMessage);
 367       if (aMsgAttr) {
 368         if (!aMsgAttr->isObligatory()) {
 369           validators()->registerNotObligatory(aMsgAttr->featureId(), aMsgAttr->attributeId());
 370         }
 371         if(aMsgAttr->isConcealment()) {
 372           validators()->registerConcealment(aMsgAttr->featureId(), aMsgAttr->attributeId());
 373         }
 374         if (!aMsgAttr->caseId().empty()) {
 375           validators()->registerCase(aMsgAttr->featureId(), aMsgAttr->attributeId(),
 376             aMsgAttr->switchId(), aMsgAttr->caseId());
 377         }
 378       }
 379     }
 380     // plugins information was started to load, so, it will be loaded
 381     myPluginsInfoLoaded = true;
 382   } else if (theMessage->eventID() == kValidatorEvent) {
 383     std::shared_ptr<Config_ValidatorMessage> aMsg =
 384       std::dynamic_pointer_cast<Config_ValidatorMessage>(theMessage);
 385     if (aMsg) {
 386       if (aMsg->attributeId().empty()) {  // feature validator
 387         validators()->assignValidator(aMsg->validatorId(), aMsg->featureId(), aMsg->parameters());
 388       } else {  // attribute validator
 389         validators()->assignValidator(aMsg->validatorId(), aMsg->featureId(), aMsg->attributeId(),
 390                                       aMsg->parameters());
 391       }
 392     }
 393   } else {  // create/update/delete
 394     if (myCheckTransactions && !isOperation())
 395       Events_Error::send("Modification of data structure outside of the transaction");
 396     // if part is deleted, make the root as the current document (on undo of Parts creations)
 397     static const Events_ID kDeletedEvent = Events_Loop::eventByName(EVENT_OBJECT_DELETED);
 398     if (theMessage->eventID() == kDeletedEvent) {
 399       std::shared_ptr<ModelAPI_ObjectDeletedMessage> aDeleted =
 400         std::dynamic_pointer_cast<ModelAPI_ObjectDeletedMessage>(theMessage);
 401       if (aDeleted &&
 402           aDeleted->groups().find(ModelAPI_ResultPart::group()) != aDeleted->groups().end())
 403       {
 404          // check that the current feature of the session is still the active Part (even disabled)
 405         bool aFound = false;
 406         FeaturePtr aCurrentPart = moduleDocument()->currentFeature(true);
 407         if (aCurrentPart.get()) {
 408           const std::list<std::shared_ptr<ModelAPI_Result> >& aResList = aCurrentPart->results();
 409           std::list<std::shared_ptr<ModelAPI_Result> >::const_iterator aRes = aResList.begin();
 410           for(; !aFound && aRes != aResList.end(); aRes++) {
 411             ResultPartPtr aPRes = std::dynamic_pointer_cast<ModelAPI_ResultPart>(*aRes);
 412             if (aPRes.get() && aPRes->isActivated() && aPRes->partDoc() == activeDocument()) {
 413               aFound = true;
 414
 415             }
 416           }
 417         }
 418         if (!aFound) { // if not, the part was removed, so activate the module document
 419           setActiveDocument(moduleDocument());
 420         }
 421       }
 422     }
 423   }
 424 }
 425
 426 void Model_Session::LoadPluginsInfo()
 427 {
 428   if (myPluginsInfoLoaded)  // nothing to do
 429     return;
 430
 431   // Read plugins information from XML files
 432   Config_ModuleReader aModuleReader(Config_FeatureMessage::MODEL_EVENT());
 433   aModuleReader.readAll();
 434   std::set<std::string> aFiles = aModuleReader.modulePluginFiles();
 435   std::set<std::string>::iterator it = aFiles.begin();
 436   for ( ; it != aFiles.end(); it++ ) {
 437     Config_ValidatorReader aValidatorReader (*it);
 438     aValidatorReader.readAll();
 439   };
 440
 441 }
 442
 443 void Model_Session::registerPlugin(ModelAPI_Plugin* thePlugin)
 444 {
 445   myPluginObjs[myCurrentPluginName] = thePlugin;
 446   static Events_ID EVENT_LOAD = Events_Loop::loop()->eventByName(EVENT_PLUGIN_LOADED);
 447   ModelAPI_EventCreator::get()->sendUpdated(ObjectPtr(), EVENT_LOAD);
 448   Events_Loop::loop()->flush(EVENT_LOAD);
 449   // If the plugin has an ability to process GUI events, register it
 450   Events_Listener* aListener = dynamic_cast<Events_Listener*>(thePlugin);
 451   if (aListener) {
 452     Events_Loop* aLoop = Events_Loop::loop();
 453     static Events_ID aStateRequestEventId =
 454         Events_Loop::loop()->eventByName(EVENT_FEATURE_STATE_REQUEST);
 455     aLoop->registerListener(aListener, aStateRequestEventId);
 456   }
 457 }
 458
 459 ModelAPI_ValidatorsFactory* Model_Session::validators()
 460 {
 461   static Model_ValidatorsFactory* aFactory = new Model_ValidatorsFactory;
 462   return aFactory;
 463 }
 464
 465 int Model_Session::transactionID()
 466 {
 467   return ROOT_DOC->transactionID();
 468 }