]> SALOME platform Git repositories - modules/kernel.git/blob - bin/setenv.py
Salome HOME
Revert "Revert "bos #18467 Minor correction to setenv.py""
[modules/kernel.git] / bin / setenv.py
1 #!/usr/bin/env python3
2 #  -*- coding: iso-8859-1 -*-
3 # Copyright (C) 2007-2019  CEA/DEN, EDF R&D, OPEN CASCADE
4 #
5 # Copyright (C) 2003-2007  OPEN CASCADE, EADS/CCR, LIP6, CEA/DEN,
6 # CEDRAT, EDF R&D, LEG, PRINCIPIA R&D, BUREAU VERITAS
7 #
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.
12 #
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.
17 #
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
21 #
22 # See http://www.salome-platform.org/ or email : webmaster.salome@opencascade.com
23 #
24
25 import sys, os, string, glob, time, pickle
26 import orbmodule
27 from launchConfigureParser import verbose
28
29 # this file is extraction of set_env from runSalome.py
30 # for reusage in automated tests
31
32 # salome_subdir variable is used for composing paths like $KERNEL_ROOT_DIR/share/salome/resources, etc.
33 # before moving to SUIT-based gui, instead of salome_subdir there was args['appname'] used.
34 # but after - 'appname'  = "SalomeApp", so using it in making the subdirectory is an error.
35 salome_subdir = "salome"
36
37
38 # -----------------------------------------------------------------------------
39
40 def add_path(directory, variable_name):
41     """Function helper to add environment variables"""
42     if sys.platform == "win32":
43       splitsym = ";"
44     else:
45       splitsym = ":"
46     if variable_name not in os.environ:
47         os.environ[variable_name] = ""
48         pass
49     if os.path.exists(directory):
50         newpath=[]
51         for _dir in os.environ[variable_name].split(splitsym):
52             if os.path.exists(_dir):
53                 if sys.platform != "win32":
54                     if not os.path.samefile(_dir, directory):
55                         newpath.append(_dir)
56                 else:
57                     newpath.append(_dir)
58             else:
59                 if os.path.abspath(_dir) != os.path.abspath(directory):
60                   newpath.append(_dir)
61             pass
62         newpath[:0] = [ directory ]
63         newpath = splitsym.join(newpath)
64         os.environ[variable_name] = newpath
65         if variable_name == "PYTHONPATH":
66             sys.path[:0] = [os.path.realpath(directory)]
67
68 # -----------------------------------------------------------------------------
69
70 __lib__dir__ = None
71 def get_lib_dir():
72     global __lib__dir__
73     if __lib__dir__: return __lib__dir__
74     import platform
75     __lib__dir__ = "lib"
76     return __lib__dir__
77
78 # -----------------------------------------------------------------------------
79
80 def get_config(silent=False, exeName=None, keepEnvironment=True):
81     """
82     Get list of modules, paths.
83
84     Read args from launch configure xml file and command line options.
85     Check variables <module>_ROOT_DIR and set list of used modules.
86     Return args, modules_list, modules_root_dir
87     """
88
89     # read args from launch configure xml file and command line options
90
91
92     import launchConfigureParser
93     args = launchConfigureParser.get_env(exeName=exeName, keepEnvironment=keepEnvironment)
94
95
96     # Check variables <module>_ROOT_DIR
97     # and set list of used modules (without KERNEL)
98
99     modules_list = []
100     if "modules" in args:
101         modules_list += [a for a in args["modules"] if a.strip()]
102     # KERNEL must be last in the list to locate it at the first place in PATH
103     if args["gui"] :
104         modules_list[:0] = ["GUI"]
105     modules_list[:0] = ["KERNEL"]
106     modules_list.reverse()
107
108     modules_root_dir = {}
109
110     to_remove_list=[]
111     for module in modules_list :
112         module_variable=module+"_ROOT_DIR"
113         if module_variable not in os.environ:
114             if not silent:
115                 print("*******************************************************")
116                 print("*")
117                 print("* Environment variable",module_variable,"must be set")
118                 print("* Module", module, "will be not available")
119                 print("*")
120                 print("********************************************************")
121                 pass
122             to_remove_list.append(module)
123             continue
124             pass
125         module_root_dir = os.environ[module_variable]
126         modules_root_dir[module]=module_root_dir
127
128     for to_remove in to_remove_list:
129         modules_list.remove(to_remove)
130
131     while "KERNEL" in modules_list:
132         modules_list.remove("KERNEL")
133         pass
134
135     while "GUI" in modules_list:
136         modules_list.remove("GUI")
137         pass
138
139     return args, modules_list, modules_root_dir
140
141 # -----------------------------------------------------------------------------
142
143 def set_env(args, modules_list, modules_root_dir, silent=False, keepEnvironment=True):
144     """Add to the PATH-variables modules specific paths"""
145
146     import os
147     from salome_utils import getLogDir, generateFileName, makeTmpDir, getPortNumber
148
149     if 'launcher' in args:
150       pos = args['launcher'].find(":")
151       if pos != -1:
152         machine = args['launcher'][0:pos]
153         port = args['launcher'][pos+1:]
154         os.environ["NSPORT"] = port
155
156     # create temporary directory for environment files needed by modules from the list
157     port = getPortNumber(False)
158     if port:
159         tmp_dir = getLogDir()
160         env_dir = generateFileName(tmp_dir, prefix="env", with_port=True)
161         makeTmpDir(env_dir)
162         pass
163
164     python_version="python%d.%d" % sys.version_info[0:2]
165     modules_root_dir_list = []
166     if os.getenv('SALOME_BATCH') == None:
167       os.putenv('SALOME_BATCH','0')
168     if args["gui"] :
169         modules_list = modules_list[:] + ["GUI"]
170     if not keepEnvironment:
171         modules_list = modules_list[:] + ["KERNEL"]
172         for module in modules_list :
173             if module in modules_root_dir:
174                 module_root_dir = modules_root_dir[module]
175                 if module_root_dir not in modules_root_dir_list:
176                   modules_root_dir_list[:0] = [module_root_dir]
177                 if sys.platform == "win32":
178                   add_path(os.path.join(module_root_dir,get_lib_dir(),salome_subdir),
179                          "PATH")
180                 elif sys.platform == "darwin":
181                   add_path(os.path.join(module_root_dir,get_lib_dir(),salome_subdir),
182                          "DYLD_LIBRARY_PATH")
183                 else:
184                   add_path(os.path.join(module_root_dir,get_lib_dir(),salome_subdir),
185                          "LD_LIBRARY_PATH")
186                 add_path(os.path.join(module_root_dir,"bin",salome_subdir),
187                          "PATH")
188                 if os.path.exists(os.path.join(module_root_dir, "examples")):
189                     add_path(os.path.join(module_root_dir,"examples"),
190                              "PYTHONPATH")
191                     pass
192                 add_path(os.path.join(module_root_dir,"bin",salome_subdir),
193                          "PYTHONPATH")
194                 # add lib before site-packages to load script instead of dll if any (win32 platform)
195                 add_path(os.path.join(module_root_dir,get_lib_dir(),salome_subdir),
196                          "PYTHONPATH")
197                 add_path(os.path.join(module_root_dir,get_lib_dir(),
198                                       python_version,"site-packages",
199                                       salome_subdir),
200                          "PYTHONPATH")
201                 import platform
202                 if platform.machine() == "x86_64":
203                     add_path(os.path.join(module_root_dir,"lib64",
204                                           python_version,"site-packages",
205                                           salome_subdir),
206                              "PYTHONPATH")
207                     pass
208                 add_path(os.path.join(module_root_dir,get_lib_dir(),
209                                       python_version,"site-packages",
210                                       salome_subdir,
211                                       "shared_modules"),
212                          "PYTHONPATH")
213
214                 # set environment by modules from the list
215                 if port:
216                     try:
217                         mod=__import__(module.lower()+"_setenv")
218                         mod.set_env(args)
219                         pass
220                     except:
221                         pass
222                     pass
223                 pass
224             pass
225
226         if sys.platform == 'win32':
227             os.environ["SALOMEPATH"]=";".join(modules_root_dir_list)
228         else:
229             os.environ["SALOMEPATH"]=":".join(modules_root_dir_list)
230
231         pass
232     # set trace environment variable
233
234     if "SALOME_trace" not in os.environ:
235         os.environ["SALOME_trace"]="local"
236     if args['file']:
237         os.environ["SALOME_trace"]="file:"+args['file'][0]
238     if args['logger']:
239         os.environ["SALOME_trace"]="with_logger"
240
241 # -----------------------------------------------------------------------------
242
243 def main(silent=False, exeName=None):
244     keep_env = not os.getenv('SALOME_PLEASE_SETUP_ENVIRONMENT_AS_BEFORE')
245     args, modules_list, modules_root_dir = get_config(silent=silent, exeName=exeName, keepEnvironment=keep_env)
246     set_env(args, modules_list, modules_root_dir, silent=silent, keepEnvironment=keep_env)
247     return args
248
249 # -----------------------------------------------------------------------------
250
251 if __name__ == "__main__":
252    import user
253    args = main()