2 # -*- coding: iso-8859-1 -*-
3 # Copyright (C) 2007-2024 CEA, EDF, OPEN CASCADE
5 # Copyright (C) 2003-2007 OPEN CASCADE, EADS/CCR, LIP6, CEA/DEN,
6 # CEDRAT, EDF R&D, LEG, PRINCIPIA R&D, BUREAU VERITAS
8 # This library is free software; you can redistribute it and/or
9 # modify it under the terms of the GNU Lesser General Public
10 # License as published by the Free Software Foundation; either
11 # version 2.1 of the License, or (at your option) any later version.
13 # This library is distributed in the hope that it will be useful,
14 # but WITHOUT ANY WARRANTY; without even the implied warranty of
15 # MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
16 # Lesser General Public License for more details.
18 # You should have received a copy of the GNU Lesser General Public
19 # License along with this library; if not, write to the Free Software
20 # Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA
22 # See http://www.salome-platform.org/ or email : webmaster.salome@opencascade.com
25 import sys, os, string, glob, time, pickle
26 from launchConfigureParser import verbose
28 # this file is extraction of set_env from runSalome.py
29 # for reusage in automated tests
31 # salome_subdir variable is used for composing paths like $KERNEL_ROOT_DIR/share/salome/resources, etc.
32 # before moving to SUIT-based gui, instead of salome_subdir there was args['appname'] used.
33 # but after - 'appname' = "SalomeApp", so using it in making the subdirectory is an error.
34 salome_subdir = "salome"
37 # -----------------------------------------------------------------------------
39 def add_path(directory, variable_name):
40 """Function helper to add environment variables"""
41 if variable_name not in os.environ:
42 os.environ[variable_name] = ""
44 if os.path.exists(directory):
46 for _dir in os.environ[variable_name].split(os.pathsep):
47 if os.path.exists(_dir):
48 if not os.path.samefile(_dir, directory):
51 if os.path.abspath(_dir) != os.path.abspath(directory):
54 newpath[:0] = [ directory ]
55 newpath = os.pathsep.join(newpath)
56 os.environ[variable_name] = newpath
57 if variable_name == "PYTHONPATH":
58 sys.path[:0] = [os.path.realpath(directory)]
60 # -----------------------------------------------------------------------------
65 if __lib__dir__: return __lib__dir__
70 # -----------------------------------------------------------------------------
72 def get_config(silent=False, exeName=None, keepEnvironment=True):
74 Get list of modules, paths.
76 Read args from launch configure xml file and command line options.
77 Check variables <module>_ROOT_DIR and set list of used modules.
78 Return args, modules_list, modules_root_dir
81 # read args from launch configure xml file and command line options
84 import launchConfigureParser
85 args = launchConfigureParser.get_env(exeName=exeName, keepEnvironment=keepEnvironment)
88 # Check variables <module>_ROOT_DIR
89 # and set list of used modules (without KERNEL)
93 modules_list += [a for a in args["modules"] if a.strip()]
94 # KERNEL must be last in the list to locate it at the first place in PATH
96 modules_list[:0] = ["GUI"]
97 modules_list[:0] = ["KERNEL"]
98 modules_list.reverse()
100 modules_root_dir = {}
103 for module in modules_list :
104 module_variable=module+"_ROOT_DIR"
105 if module_variable not in os.environ:
107 print("*******************************************************")
109 print("* Environment variable",module_variable,"must be set")
110 print("* Module", module, "will be not available")
112 print("********************************************************")
114 to_remove_list.append(module)
117 module_root_dir = os.environ[module_variable]
118 modules_root_dir[module]=module_root_dir
120 for to_remove in to_remove_list:
121 modules_list.remove(to_remove)
123 while "KERNEL" in modules_list:
124 modules_list.remove("KERNEL")
127 while "GUI" in modules_list:
128 modules_list.remove("GUI")
131 return args, modules_list, modules_root_dir
133 # -----------------------------------------------------------------------------
135 def set_env(args, modules_list, modules_root_dir, silent=False, keepEnvironment=True):
136 """Add to the PATH-variables modules specific paths"""
139 from salome_utils import getLogDir, generateFileName, makeTmpDir, getPortNumber
141 if 'launcher' in args:
142 pos = args['launcher'].find(":")
144 machine = args['launcher'][0:pos]
145 port = args['launcher'][pos+1:]
146 os.environ["NSPORT"] = port
148 # create temporary directory for environment files needed by modules from the list
149 port = getPortNumber(False)
151 tmp_dir = getLogDir()
152 env_dir = generateFileName(tmp_dir, prefix="env", with_port=True)
156 python_version="python%d.%d" % sys.version_info[0:2]
157 modules_root_dir_list = []
158 if os.getenv('SALOME_BATCH') == None:
159 os.putenv('SALOME_BATCH','0')
161 modules_list = modules_list[:] + ["GUI"]
162 if not keepEnvironment:
163 modules_list = modules_list[:] + ["KERNEL"]
164 for module in modules_list :
165 if module in modules_root_dir:
166 module_root_dir = modules_root_dir[module]
167 if module_root_dir not in modules_root_dir_list:
168 modules_root_dir_list[:0] = [module_root_dir]
169 if sys.platform == "win32":
170 add_path(os.path.join(module_root_dir,get_lib_dir(),salome_subdir),
172 elif sys.platform == "darwin":
173 add_path(os.path.join(module_root_dir,get_lib_dir(),salome_subdir),
176 add_path(os.path.join(module_root_dir,get_lib_dir(),salome_subdir),
178 add_path(os.path.join(module_root_dir,"bin",salome_subdir),
180 if os.path.exists(os.path.join(module_root_dir, "examples")):
181 add_path(os.path.join(module_root_dir,"examples"),
184 add_path(os.path.join(module_root_dir,"bin",salome_subdir),
186 # add lib before site-packages to load script instead of dll if any (win32 platform)
187 add_path(os.path.join(module_root_dir,get_lib_dir(),salome_subdir),
189 add_path(os.path.join(module_root_dir,get_lib_dir(),
190 python_version,"site-packages",
194 if platform.machine() == "x86_64":
195 add_path(os.path.join(module_root_dir,"lib64",
196 python_version,"site-packages",
200 add_path(os.path.join(module_root_dir,get_lib_dir(),
201 python_version,"site-packages",
206 # set environment by modules from the list
210 mod=importlib.import_module(module.lower()+"_setenv")
219 if sys.platform == 'win32':
220 os.environ["SALOMEPATH"]=";".join(modules_root_dir_list)
222 os.environ["SALOMEPATH"]=":".join(modules_root_dir_list)
225 # set trace environment variable
227 if "SALOME_trace" not in os.environ:
228 os.environ["SALOME_trace"]="local"
230 os.environ["SALOME_trace"]="file:"+args['file'][0]
232 os.environ["SALOME_trace"]="with_logger"
234 # -----------------------------------------------------------------------------
236 def main(silent=False, exeName=None):
237 keep_env = not os.getenv('SALOME_PLEASE_SETUP_ENVIRONMENT_AS_BEFORE')
238 args, modules_list, modules_root_dir = get_config(silent=silent, exeName=exeName, keepEnvironment=keep_env)
239 set_env(args, modules_list, modules_root_dir, silent=silent, keepEnvironment=keep_env)
242 # -----------------------------------------------------------------------------
244 if __name__ == "__main__":