Salome HOME
updated copyright message
[modules/shaper.git] / src / Config / Config_XMLReader.cpp
index 1a53ece53e28d328131d680dfc48dcf903e45b77..a9c56d7de1acb8c18b163c42197791899702ffbc 100644 (file)
@@ -1,16 +1,27 @@
-// Copyright (C) 2014-20xx CEA/DEN, EDF R&D
-
-/*
- * Config_XMLReader.cpp
- *
- *  Created on: Mar 14, 2014
- *      Author: sbh
- */
+// Copyright (C) 2014-2023  CEA, EDF
+//
+// This library is free software; you can redistribute it and/or
+// modify it under the terms of the GNU Lesser General Public
+// License as published by the Free Software Foundation; either
+// version 2.1 of the License, or (at your option) any later version.
+//
+// This library is distributed in the hope that it will be useful,
+// but WITHOUT ANY WARRANTY; without even the implied warranty of
+// MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
+// Lesser General Public License for more details.
+//
+// You should have received a copy of the GNU Lesser General Public
+// License along with this library; if not, write to the Free Software
+// Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA  02111-1307 USA
+//
+// See http://www.salome-platform.org/ or email : webmaster.salome@opencascade.com
+//
 
 #include <Config_XMLReader.h>
 #include <Config_Keywords.h>
 #include <Config_Common.h>
 #include <Config_PropManager.h>
+#include <Config_ModuleReader.h>
 
 #include <Events_Loop.h>
 #include <Events_InfoMessage.h>
@@ -18,6 +29,7 @@
 #include <libxml/tree.h>
 
 #include <fstream>
+#include <sstream>
 
 #ifdef WIN32
 #pragma warning(disable : 4996) // for getenv
     static const char FSEP = '/';
 #endif
 
-Config_XMLReader::Config_XMLReader(const std::string& theXmlFileName)
-    : myXmlDoc(NULL)
+Config_XMLReader::Config_XMLReader(const std::string& theXmlFileName, bool isXMLContent)
+    : myXmlDoc(NULL), myRootFileName(theXmlFileName)
 {
-  std::string prefix = "";
-  Config_Prop* aProp = Config_PropManager::findProp("Plugins", "default_path");
-  if (aProp)
-    prefix = aProp->value();
-  /*
-   * Get path to *.xml files (typically ./bin/../plugins/)
-
-   * the problem: application may be launched using python executable,
-   * to use environment variable (at least for the current moment)
-   */
-  if (prefix.empty())
-    prefix = pluginConfigFile();
-
-  myDocumentPath = prefix + FSEP + theXmlFileName;
-  std::ifstream aTestFile(myDocumentPath);
-  if (!aTestFile)
-    Events_InfoMessage("Config_XMLReader", "Unable to open %1").arg(myDocumentPath).send();
-  aTestFile.close();
+  isFromMemory = isXMLContent;
+  if (!isXMLContent) {
+    myDocumentPath = findConfigFile(theXmlFileName);
+    if (myDocumentPath.empty()) {
+      Events_InfoMessage("Config_XMLReader", "Unable to open %1").arg(theXmlFileName).send();
+    }
+  }
 }
 
 Config_XMLReader::~Config_XMLReader()
@@ -61,6 +62,23 @@ Config_XMLReader::~Config_XMLReader()
   xmlFreeDoc(myXmlDoc);
 }
 
+// LCOV_EXCL_START
+std::string Config_XMLReader::resourcesConfigFile()
+{
+  std::string aValue;
+  char* anEnv = getenv("SHAPER_ROOT_DIR");
+  if (anEnv) {
+    aValue = std::string(anEnv) +
+      FSEP + "share" + FSEP + "salome" + FSEP + "resources" + FSEP + "shaper";
+  } else {
+    anEnv = getenv("CADBUILDER_ROOT_DIR");
+    if (anEnv) {
+      aValue = std::string(anEnv) + FSEP + "resources";
+    }
+  }
+  return aValue;
+}
+
 std::string Config_XMLReader::pluginConfigFile()
 {
   std::string aValue;
@@ -69,18 +87,102 @@ std::string Config_XMLReader::pluginConfigFile()
     aValue = std::string(anEnv) +
       FSEP + "share" + FSEP + "salome" + FSEP + "resources" + FSEP + "shaper";
   } else {
-    anEnv = getenv("OPENPARTS_ROOT_DIR");
+    anEnv = getenv("CADBUILDER_ROOT_DIR");
     if (anEnv) {
       aValue = std::string(anEnv) + FSEP + "plugins";
     }
   }
   return aValue;
 }
+// LCOV_EXCL_STOP
+
+std::string Config_XMLReader::findConfigFile(const std::string theFileName, const int theFindIndex)
+{
+  int aResultIndex = 0;
+  for(int aSolution = 0; aSolution < 12; aSolution++) {
+    std::string aFileName;
+    if (aSolution == 0) {
+      Config_Prop* aProp = Config_PropManager::findProp("Plugins", "default_path");
+      if (!aProp)
+        continue;
+      aFileName = aProp->value();
+    } else {
+      std::ostringstream anEnvName;
+      if (aSolution == 1)
+        anEnvName<<"SHAPER_ROOT_DIR";
+      else if (aSolution == 2)
+        anEnvName<<"CADBUILDER_ROOT_DIR";
+      else
+        anEnvName<<"CADBUILDER_ROOT_DIR";
+
+      char* anEnv = getenv(anEnvName.str().c_str());
+      if (!anEnv)
+        continue;
+      if (aSolution > 2) { // there may be several paths separated by ";" symbol
+// LCOV_EXCL_START
+        std::string anEnvPart = anEnv;
+        size_t aPosStart = 0, aPosEnd;
+        for(int aSubNum = 0; aSubNum < aSolution - 3; aSubNum++) {
+          aPosStart++;
+          aPosStart = anEnvPart.find(';', aPosStart);
+          if (aPosStart == std::string::npos)
+            break;
+        }
+        if (aPosStart == std::string::npos)
+          break;
+        if (aPosStart != 0)
+          aPosStart++;
+        aPosEnd = anEnvPart.find(';', aPosStart);
+        aFileName = anEnvPart.substr(aPosStart,
+          aPosEnd == std::string::npos ? aPosEnd : aPosEnd - aPosStart) + FSEP;
+// LCOV_EXCL_STOP
+      } else {
+        aFileName = std::string(anEnv) + FSEP;
+      }
+      if (aSolution == 1)
+        aFileName += std::string("share") + FSEP + "salome" + FSEP + "resources" + FSEP + "shaper";
+      else if (aSolution == 2)
+        aFileName += "plugins";
+    }
+
+    aFileName += FSEP + theFileName;
+    std::ifstream aTestFile(aFileName);
+    if (aTestFile) {
+      if (aResultIndex == theFindIndex)
+        return aFileName;
+      aResultIndex++;
+      if (aSolution == 1) // don't allow SHAPER and CADBuilder paths treated simultaneously
+        aSolution++;
+    }
+  }
+  return ""; // no files found
+}
 
 void Config_XMLReader::readAll()
 {
-  xmlNodePtr aRoot = findRoot();
-  readRecursively(aRoot);
+  if (isFromMemory) {
+    myXmlDoc = xmlParseMemory(myRootFileName.c_str(), (int)myRootFileName.length());
+    xmlNodePtr aRoot = xmlDocGetRootElement(myXmlDoc);
+    readRecursively(aRoot);
+    return;
+  }
+
+  // to load external modules dependencies (like GEOM for Connector Feature)
+  Config_ModuleReader::loadScript("salome.shaper.initConfig", false);
+
+  for(int aSolution = 0; true; aSolution++) {
+    std::string aFoundFile = findConfigFile(myRootFileName, aSolution);
+    if (aFoundFile.empty()) {
+      break; // no more solutions
+    }
+
+    if (myXmlDoc != NULL) { // clear the previous XML document - now the new one will be opened
+      xmlFreeDoc(myXmlDoc);
+      myXmlDoc = NULL;
+    }
+    xmlNodePtr aRoot = findRoot(aFoundFile);
+    readRecursively(aRoot);
+  }
 }
 
 void Config_XMLReader::processNode(xmlNodePtr theNode)
@@ -100,19 +202,22 @@ void Config_XMLReader::cleanup(xmlNodePtr)
   // do nothing;
 }
 
-bool Config_XMLReader::processChildren(xmlNodePtr aNode)
+// LCOV_EXCL_START
+bool Config_XMLReader::processChildren(xmlNodePtr /*aNode*/)
 {
   return true;
 }
+// LCOV_EXCL_STOP
 
-xmlNodePtr Config_XMLReader::findRoot()
+xmlNodePtr Config_XMLReader::findRoot(const std::string theDocumentPath)
 {
+  std::string aDocPath = theDocumentPath.empty() ? myDocumentPath : theDocumentPath;
   if (myXmlDoc == NULL) {
-    myXmlDoc = xmlParseFile(myDocumentPath.c_str());
+    myXmlDoc = xmlParseFile(aDocPath.c_str());
   }
   if (myXmlDoc == NULL) {
 #ifdef _DEBUG
-    std::cout << "Config_XMLReader::import: " << "Document " << myDocumentPath
+    std::cout << "Config_XMLReader::import: " << "Document " << aDocPath
     << " is not parsed successfully." << std::endl;
 #endif
     return NULL;
@@ -144,10 +249,12 @@ void Config_XMLReader::readRecursively(xmlNodePtr theParent)
   }
 }
 
+// LCOV_EXCL_START
 xmlNodePtr Config_XMLReader::node(void* theNode)
 {
   return static_cast<xmlNodePtr>(theNode);
 }
+// LCOV_EXCL_STOP
 
 std::string Config_XMLReader::getNodeName(xmlNodePtr theNode)
 {
@@ -168,10 +275,12 @@ void Config_XMLReader::storeAttribute(xmlNodePtr theNode, const char* theAttribu
   }
 }
 
+// LCOV_EXCL_START
 std::string Config_XMLReader::restoreAttribute(xmlNodePtr theNode, const char* theAttribute)
 {
   return restoreAttribute(getNodeName(theNode).c_str(), theAttribute);
 }
+// LCOV_EXCL_STOP
 
 std::string Config_XMLReader::restoreAttribute(const char* theNodeName, const char* theAttribute)
 {
@@ -200,7 +309,9 @@ bool Config_XMLReader::cleanupAttribute(const char* theNodeName, const char* the
   return result;
 }
 
+// LCOV_EXCL_START
 const char* Config_XMLReader::encoding() const
 {
   return (const char*) myXmlDoc->encoding;
-}
\ No newline at end of file
+}
+// LCOV_EXCL_STOP