Salome HOME
Error management -- Default attribute validator
[modules/shaper.git] / src / Model / Model_Validator.cpp
index eecd08b33013590344a004f9e794fc7a7031ac4a..621f33b5f0eabbffa6b82383b7c583de04a6f1eb 100644 (file)
@@ -1,16 +1,21 @@
+// Copyright (C) 2014-20xx CEA/DEN, EDF R&D
+
 // File:        Model_Validator.cpp
 // Created:     2 Jul 2014
 // Author:      Mikhail PONIKAROV
 
-#include <Model_Validator.h>
-#include <Model_FeatureValidator.h>
-#include <ModelAPI_Feature.h>
+#include "Model_Validator.h"
+
+#include "Model_AttributeValidator.h"
+#include "Model_FeatureValidator.h"
+
 #include <ModelAPI_Attribute.h>
-#include <ModelAPI_Data.h>
+#include <ModelAPI_AttributeString.h>
 #include <ModelAPI_AttributeValidator.h>
-#include <Events_Error.h>
+#include <ModelAPI_Data.h>
+#include <ModelAPI_Feature.h>
 
-const static std::string kDefaultId = "Model_FeatureValidator";
+#include <Events_Error.h>
 
 void Model_ValidatorsFactory::registerValidator(const std::string& theID,
   ModelAPI_Validator* theValidator)
@@ -73,55 +78,49 @@ void Model_ValidatorsFactory::assignValidator(const std::string& theID,
 }
 
 void Model_ValidatorsFactory::validators(const std::string& theFeatureID,
-  std::list<ModelAPI_Validator*>& theResult,
-  std::list<std::list<std::string> >& theArguments) const
-{
-  std::map<std::string, AttrValidators>::const_iterator aFeature = myFeatures.find(theFeatureID);
-  if (aFeature != myFeatures.cend()) {
-    AttrValidators::const_iterator aValIter = aFeature->second.cbegin();
-    for (; aValIter != aFeature->second.cend(); aValIter++) {
-      std::map<std::string, ModelAPI_Validator*>::const_iterator aFound = 
-        myIDs.find(aValIter->first);
-      if (aFound == myIDs.end()) {
-        Events_Error::send(std::string("Validator ") + aValIter->first + " was not registered");
+                                         Validators& theValidators) const
+{
+  std::map<std::string, AttrValidators>::const_iterator aFeatureIt = 
+      myFeatures.find(theFeatureID);
+  if (aFeatureIt != myFeatures.cend()) {
+    AttrValidators::const_iterator aValidatorsIt = aFeatureIt->second.cbegin();
+    for (; aValidatorsIt != aFeatureIt->second.cend(); aValidatorsIt++) {
+      if (!validator(aValidatorsIt->first)) {
+        Events_Error::send(std::string("Validator ") + aValidatorsIt->first + " was not registered");
       } else {
-        theResult.push_back(aFound->second);
-        theArguments.push_back(aValIter->second);
+        theValidators.push_back(std::make_pair(aValidatorsIt->first, aValidatorsIt->second));
       }
     }
   }
-  addDefaultValidators(theResult);
+  addDefaultValidators(theValidators);
 }
 
-void Model_ValidatorsFactory::validators(const std::string& theFeatureID,
-  const std::string& theAttrID,
-  std::list<ModelAPI_Validator*>& theValidators,
-  std::list<std::list<std::string> >& theArguments) const
-{
-  std::map<std::string, std::map<std::string, AttrValidators> >::const_iterator aFeature = 
-    myAttrs.find(theFeatureID);
-  if (aFeature != myAttrs.cend()) {
-    std::map<std::string, AttrValidators>::const_iterator anAttr = aFeature->second.find(theAttrID);
-    if (anAttr != aFeature->second.end()) {
-      AttrValidators::const_iterator aValIter = anAttr->second.cbegin();
-      for (; aValIter != anAttr->second.cend(); aValIter++) {
-        std::map<std::string, ModelAPI_Validator*>::const_iterator aFound = myIDs.find(
-          aValIter->first);
-        if (aFound == myIDs.end()) {
-          Events_Error::send(std::string("Validator ") + aValIter->first + " was not registered");
+void Model_ValidatorsFactory::validators(const std::string& theFeatureID, const std::string& theAttrID,
+                                         Validators& theValidators) const
+{
+  std::map<std::string, std::map<std::string, AttrValidators> >::const_iterator aFeatureIt = 
+      myAttrs.find(theFeatureID);
+  if (aFeatureIt != myAttrs.cend()) {
+    std::map<std::string, AttrValidators>::const_iterator anAttrIt = aFeatureIt->second.find(theAttrID);
+    if (anAttrIt != aFeatureIt->second.end()) {
+      AttrValidators::const_iterator aValidatorsIt = anAttrIt->second.cbegin();
+      for (; aValidatorsIt != anAttrIt->second.cend(); aValidatorsIt++) {
+        if (!validator(aValidatorsIt->first)) {
+          Events_Error::send(std::string("Validator ") + aValidatorsIt->first + " was not registered");
         } else {
-          theValidators.push_back(aFound->second);
-          theArguments.push_back(aValIter->second);
+          theValidators.push_back(std::make_pair(aValidatorsIt->first, aValidatorsIt->second));
         }
       }
     }
   }
+  addDefaultAttributeValidators(theValidators);
 }
 
 Model_ValidatorsFactory::Model_ValidatorsFactory()
   : ModelAPI_ValidatorsFactory()
 {
-  registerValidator(kDefaultId, new Model_FeatureValidator);
+  registerValidator("Model_FeatureValidator", new Model_FeatureValidator);
+  registerValidator("Model_AttributeValidator", new Model_AttributeValidator);
 }
 
 const ModelAPI_Validator* Model_ValidatorsFactory::validator(const std::string& theID) const
@@ -133,86 +132,142 @@ const ModelAPI_Validator* Model_ValidatorsFactory::validator(const std::string&
   return NULL;
 }
 
-void Model_ValidatorsFactory::addDefaultValidators(std::list<ModelAPI_Validator*>& theValidators) const
+void Model_ValidatorsFactory::addDefaultValidators(Validators& theValidators) const
 {
-  std::map<std::string, ModelAPI_Validator*>::const_iterator it = myIDs.find(kDefaultId);
-  if(it == myIDs.end())
+  const static std::string kDefaultId = "Model_FeatureValidator";
+  if (!validator(kDefaultId))
+    return;
+  theValidators.push_back(std::make_pair(kDefaultId, std::list<std::string>()));
+}
+
+void Model_ValidatorsFactory::addDefaultAttributeValidators(Validators& theValidators) const
+{
+  const static std::string kDefaultId = "Model_AttributeValidator";
+  if (!validator(kDefaultId))
     return;
-  theValidators.push_back(it->second);
+  theValidators.push_back(std::make_pair(kDefaultId, std::list<std::string>()));
 }
 
-bool Model_ValidatorsFactory::validate(const boost::shared_ptr<ModelAPI_Feature>& theFeature) const
+bool Model_ValidatorsFactory::validate(const std::shared_ptr<ModelAPI_Feature>& theFeature) const
 {
+  ModelAPI_ExecState anExecState = theFeature->data()->execState();
+  theFeature->setError("", false);
+  theFeature->data()->execState(anExecState);
+
   // check feature validators first
-  std::map<std::string, AttrValidators>::const_iterator aFeature = 
-    myFeatures.find(theFeature->getKind());
-  if (aFeature != myFeatures.end()) {
-    AttrValidators::const_iterator aValidator = aFeature->second.begin();
-    for(; aValidator != aFeature->second.end(); aValidator++) {
-      std::map<std::string, ModelAPI_Validator*>::const_iterator aValFind = 
-        myIDs.find(aValidator->first);
-      if (aValFind == myIDs.end()) {
-        Events_Error::send(std::string("Validator ") + aValidator->first + " was not registered");
-        continue;
-      }
+  Validators aValidators;
+  validators(theFeature->getKind(), aValidators);
+
+  if (!aValidators.empty()) {
+    Validators::const_iterator aValidatorIt = aValidators.cbegin();
+    for(; aValidatorIt != aValidators.cend(); aValidatorIt++) {
+      const std::string& aValidatorID = aValidatorIt->first;
+      const std::list<std::string>& anArguments = aValidatorIt->second;
+      // validators() checks invalid validator names
+      //if (!aValidator) {
+      //  Events_Error::send(std::string("Validator ") + aValidatorID + " was not registered");
+      //  continue;
+      //}
       const ModelAPI_FeatureValidator* aFValidator = 
-        dynamic_cast<const ModelAPI_FeatureValidator*>(aValFind->second);
+        dynamic_cast<const ModelAPI_FeatureValidator*>(validator(aValidatorID));
       if (aFValidator) {
-        if (!aFValidator->isValid(theFeature, aValidator->second))
+        std::string anError;
+        if (!aFValidator->isValid(theFeature, anArguments, anError)) {
+          if (anError.empty())
+            anError = "Unknown error.";
+          anError = "Feature invalidated by \"" + aValidatorID + "\" with error: " + anError;
+          theFeature->setError(anError, false);
+          theFeature->data()->execState(ModelAPI_StateInvalidArgument);
           return false;
+        }
       }
     }
   }
-  // check default validator
-  std::map<std::string, ModelAPI_Validator*>::const_iterator aDefaultVal = myIDs.find(kDefaultId);
-  if(aDefaultVal != myIDs.end()) {
-    static const std::list<std::string> anEmptyArgList;
-    const ModelAPI_FeatureValidator* aFValidator = 
-      dynamic_cast<const ModelAPI_FeatureValidator*>(aDefaultVal->second);
-    if (aFValidator) {
-      if (!aFValidator->isValid(theFeature, anEmptyArgList))
-        return false;
-    }
-  }
+  // The default validator was retrned by validators() and was checked in previous cycle
+  //// check default validator
+  //std::map<std::string, ModelAPI_Validator*>::const_iterator aDefaultVal = myIDs.find(kDefaultId);
+  //if(aDefaultVal != myIDs.end()) {
+  //  static const std::list<std::string> anEmptyArgList;
+  //  const ModelAPI_FeatureValidator* aFValidator = 
+  //    dynamic_cast<const ModelAPI_FeatureValidator*>(aDefaultVal->second);
+  //  if (aFValidator) {
+  //    std::string anError;
+  //    if (!aFValidator->isValid(theFeature, anEmptyArgList, anError)) {
+  //      if (anError.empty())
+  //        anError = "Unknown error.";
+  //      anError = "Feature invalidated by \"" + kDefaultId + "\" with error: " + anError;
+  //      theFeature->setError(anError, false);
+  //      theFeature->data()->execState(ModelAPI_StateInvalidArgument);
+  //      return false;
+  //    }
+  //  }
+  //}
+  
   // check all attributes for validity
-  boost::shared_ptr<ModelAPI_Data> aData = theFeature->data();
-  if (!aData->isValid())
-    return false;
+  std::shared_ptr<ModelAPI_Data> aData = theFeature->data();
+  // Validity of data is checked by "Model_FeatureValidator" (kDefaultId)
+  // if (!aData || !aData->isValid())
+  //   return false;
   static const std::string kAllTypes = "";
-  std::map<std::string, std::map<std::string, AttrValidators> >::const_iterator aFeatureIter = 
-    myAttrs.find(theFeature->getKind());
-  if (aFeatureIter != myAttrs.cend()) {
-    std::list<std::string> aLtAttributes = aData->attributesIDs(kAllTypes);
-    std::list<std::string>::iterator anAttrIter = aLtAttributes.begin();
-    for (; anAttrIter != aLtAttributes.end(); anAttrIter++) {
-      std::map<std::string, AttrValidators>::const_iterator anAttr = 
-          aFeatureIter->second.find(*anAttrIter);
-      if (anAttr != aFeatureIter->second.end()) {
-        AttrValidators::const_iterator aValIter = anAttr->second.cbegin();
-        for (; aValIter != anAttr->second.cend(); aValIter++) {
-          std::map<std::string, ModelAPI_Validator*>::const_iterator aFound = myIDs.find(
-            aValIter->first);
-          if (aFound == myIDs.end()) {
-            Events_Error::send(std::string("Validator ") + aValIter->first + " was not registered");
-          } else {
-            const ModelAPI_AttributeValidator* anAttrValidator = 
-              dynamic_cast<const ModelAPI_AttributeValidator*>(aFound->second);
-            if (anAttrValidator) {
-              AttributePtr anAttribute = theFeature->data()->attribute(*anAttrIter);
-              if (!anAttrValidator->isValid(anAttribute, aValIter->second)) {
-                  return false;
-              }
-            }
-          }
-        }
-      }
-    }
+  std::list<std::string> aLtAttributes = aData->attributesIDs(kAllTypes);
+  std::list<std::string>::const_iterator anAttrIt = aLtAttributes.cbegin();
+  for (; anAttrIt != aLtAttributes.cend(); anAttrIt++) {
+    const std::string& anAttributeID = *anAttrIt; 
+    AttributePtr anAttribute = theFeature->data()->attribute(anAttributeID);
+
+    std::string aValidatorID;
+    std::string anError;
+    if (!validate(anAttribute, aValidatorID, anError)) {
+      if (anError.empty())
+        anError = "Unknown error.";
+      anError = "Attribute \"" + anAttributeID + "\" invalidated by \"" + aValidatorID + "\" with error: " + anError;
+      theFeature->setError(anError, false);
+      theFeature->data()->execState(ModelAPI_StateInvalidArgument);
+      return false;
+    } 
+  }
+
+  return true;
+}
+
+bool Model_ValidatorsFactory::validate(const std::shared_ptr<ModelAPI_Attribute>& theAttribute,
+                                       std::string& theValidator,
+                                       std::string& theError) const
+{
+  FeaturePtr aFeature = ModelAPI_Feature::feature(theAttribute->owner());
+  if (!aFeature.get()) {
+    theValidator = "Model_ValidatorsFactory";
+    theError = "Attribute has no feature.";
+    return false;
   }
+
+  // skip not-case attributes, that really may be invalid (issue 671)
+  if (!const_cast<Model_ValidatorsFactory*>(this)->isCase(aFeature, theAttribute->id()))
+    return true;
+
+  Validators aValidators;
+  validators(aFeature->getKind(), theAttribute->id(), aValidators);
+
+  Validators::iterator aValidatorIt = aValidators.begin();
+  for (; aValidatorIt != aValidators.end(); ++aValidatorIt) {
+    const std::string& aValidatorID = aValidatorIt->first;
+    const std::list<std::string>& anArguments = aValidatorIt->second;
+    const ModelAPI_AttributeValidator* anAttrValidator =
+        dynamic_cast<const ModelAPI_AttributeValidator*>(validator(aValidatorID));
+    if (!anAttrValidator)
+      continue;
+    if (!anAttrValidator->isValid(theAttribute, anArguments, theError)) {
+      theValidator = aValidatorID;
+      return false;
+    } 
+  }
+
   return true;
 }
 
 void Model_ValidatorsFactory::registerNotObligatory(std::string theFeature, std::string theAttribute)
 {
+  const static std::string kDefaultId = "Model_FeatureValidator";
   std::map<std::string, ModelAPI_Validator*>::const_iterator it = myIDs.find(kDefaultId);
   if (it != myIDs.end()) {
     Model_FeatureValidator* aValidator = dynamic_cast<Model_FeatureValidator*>(it->second);
@@ -222,6 +277,19 @@ void Model_ValidatorsFactory::registerNotObligatory(std::string theFeature, std:
   }
 }
 
+bool Model_ValidatorsFactory::isNotObligatory(std::string theFeature, std::string theAttribute)
+{
+  const static std::string kDefaultId = "Model_FeatureValidator";
+  std::map<std::string, ModelAPI_Validator*>::const_iterator it = myIDs.find(kDefaultId);
+  if (it != myIDs.end()) {
+    Model_FeatureValidator* aValidator = dynamic_cast<Model_FeatureValidator*>(it->second);
+    if (aValidator) {
+      return aValidator->isNotObligatory(theFeature, theAttribute);
+    }
+  }
+  return false; // default
+}
+
 void Model_ValidatorsFactory::registerConcealment(std::string theFeature, std::string theAttribute)
 {
   std::map<std::string, std::set<std::string> >::iterator aFind = myConcealed.find(theFeature);
@@ -239,3 +307,34 @@ bool Model_ValidatorsFactory::isConcealed(std::string theFeature, std::string th
   std::map<std::string, std::set<std::string> >::iterator aFind = myConcealed.find(theFeature);
   return aFind != myConcealed.end() && aFind->second.find(theAttribute) != aFind->second.end();
 }
+
+void Model_ValidatorsFactory::registerCase(std::string theFeature, std::string theAttribute,
+    std::string theSwitchId, std::string theCaseId)
+{
+  std::map<std::string, std::map<std::string, std::pair<std::string, std::string> > >::iterator 
+    aFindFeature = myCases.find(theFeature);
+  if (aFindFeature == myCases.end()) {
+    myCases[theFeature] = std::map<std::string, std::pair<std::string, std::string> >();
+    aFindFeature = myCases.find(theFeature);
+  }
+  (aFindFeature->second)[theAttribute] = std::pair<std::string, std::string>(theSwitchId, theCaseId);
+}
+
+bool Model_ValidatorsFactory::isCase(
+  FeaturePtr theFeature, std::string theAttribute)
+{
+  std::map<std::string, std::map<std::string, std::pair<std::string, std::string> > >::iterator 
+    aFindFeature = myCases.find(theFeature->getKind());
+  if (aFindFeature != myCases.end()) {
+    std::map<std::string, std::pair<std::string, std::string> >::iterator
+      aFindAttr = aFindFeature->second.find(theAttribute);
+    if (aFindAttr != aFindFeature->second.end()) {
+      // the the switch-attribute that contains the case value
+      AttributeStringPtr aSwitch = theFeature->string(aFindAttr->second.first);
+      if (aSwitch.get()) {
+        return aSwitch->value() == aFindAttr->second.second; // the second is the case identifier
+      }
+    }
+  }
+  return true; // if no additional conditions, this attribute is the case to be validated
+}