Fix SOFAPYTHON_PLUGINS_PATH env var with Windows (and add a warning error) (#349)

* Fix handling env var sp3pluginpath with windows

* more info in the message

* use sofapy3_plugins_path if both are set

* fix compil

Author: fredroy

Plugin/src/SofaPython3/PythonEnvironment.cpp

@@ -238,20 +238,34 @@ void PythonEnvironment::Init()
         }
     }
 
-    /// Add the directories listed in the SOFAPYTHON_PLUGINS_PATH environnement
-    /// variable (colon-separated) to sys.path
-    char * pathVar = getenv("SOFAPYTHON_PLUGINS_PATH");
-    if (pathVar != nullptr)
+    /// Add the directories listed in the SOFAPYTHON3_PLUGINS_PATH environnement
+    /// variable to sys.path
+    const std::string envVarName = "SOFAPYTHON3_PLUGINS_PATH";
+    const std::string deprecatedEnvVarName = "SOFAPYTHON_PLUGINS_PATH";
+    std::string usedEnvVarName = envVarName;
+
+    char* deprecatedPathVar = getenv(deprecatedEnvVarName.c_str());
+    char* pathVar = getenv(envVarName.c_str());
+    
+    // case where only the deprecated env var is set
+    if (pathVar != nullptr && deprecatedPathVar == nullptr)
     {
-        std::istringstream ss(pathVar);
-        std::string path;
-        while(std::getline(ss, path, ':'))
-        {
-            if (FileSystem::exists(path))
-                addPythonModulePathsFromDirectory(path);
-            else
-                msg_warning("SofaPython3") << "no such directory: '" + path + "'";
-        }
+        msg_deprecated("SofaPython3") << deprecatedEnvVarName << " environment variable is deprecated, use " << envVarName << " instead.";
+        usedEnvVarName = "SOFAPYTHON_PLUGINS_PATH";
+    }
+    // case where both env vars are set
+    else if (pathVar != nullptr && deprecatedPathVar != nullptr)
+    {
+        msg_deprecated("SofaPython3") << deprecatedEnvVarName << " and " << envVarName << " environment variables are both set.";
+        msg_deprecated("SofaPython3") << deprecatedEnvVarName << " is deprecated, and only " << envVarName << " will be used.";
+    }
+    
+    sofa::helper::system::FileRepository pluginPathsRepository(envVarName.c_str());
+    const auto& pluginPaths = pluginPathsRepository.getPaths();
+    for (auto pluginPath : pluginPaths)
+    {
+        std::string cleanPath = FileSystem::cleanPath(pluginPath);
+        addPythonModulePath(cleanPath);
     }
 
     // Add sites-packages wrt the plugin
@@ -332,6 +346,12 @@ void PythonEnvironment::Release()
 
 void PythonEnvironment::addPythonModulePath(const std::string& path)
 {
+    if (!(FileSystem::exists(path) && FileSystem::isDirectory(path)))
+    {
+        msg_warning("SofaPython3") << "Could not add '" + path + "'" << " to sys.path (it does not exist or is not a directory)";
+        return;
+    }
+
     PythonEnvironmentData* data = getStaticData() ;
     if (  data->addedPath.find(path)==data->addedPath.end())
     {