import src.debug as DBG
import pprint as PP
+
class Environ:
"""\
Class to manage the environment context
def append_value(self, key, value, sep=os.pathsep):
"""\
- append value to key using sep
-
+ append value to key using sep,
+ if value contains ":" or ";" then raise error
+
:param key str: the environment variable to append
:param value str: the value to append to key
:param sep str: the separator string
"""
+ for c in [";", ":"]: # windows or linux path separators
+ if c in value:
+ raise Exception("Environ append key '%s' value '%s' contains forbidden character '%s'" % (key, value, c))
# check if the key is already in the environment
if key in self.environ:
value_list = self.environ[key].split(sep)
def prepend_value(self, key, value, sep=os.pathsep):
"""\
- prepend value to key using sep
+ prepend value to key using sep,
+ if value contains ":" or ";" then raise error
:param key str: the environment variable to prepend
:param value str: the value to prepend to key
:param sep str: the separator string
"""
+ for c in [";", ":"]: # windows or linux path separators
+ if c in value:
+ raise Exception("Environ prepend key '%s' value '%s' contains forbidden character '%s'" % (key, value, c))
+ # check if the key is already in the environment
if key in self.environ:
value_list = self.environ[key].split(sep)
if not value in value_list:
:param sep str: the separator string
"""
if isinstance(value, list):
- for v in value:
+ for v in reversed(value): # prepend list, first item at last to stay first
self.prepend_value(key, v, sep)
else:
self.prepend_value(key, value, sep)
else:
return ""
+ def get_value(self, key):
+ """\
+ Get the value of the environment variable "key"
+ This method is added for API compatibility with FileEnviron class
+
+ :param key str: the environment variable
+ """
+ return self.get(key)
+
def command_value(self, key, command):
"""\
Get the value given by the system command "command"
self.for_package = for_package
self.enable_simple_env_script = enable_simple_env_script
self.silent = False
+ self.has_python = False
def __repr__(self):
"""easy almost exhaustive quick resume for debug print"""
"""
return self.environ.get(key)
+ def get_value(self, key):
+ """\
+ Get the real value of the environment variable "key"
+ This method is added for API compatibility with FileEnviron class
+
+ :param key str: the environment variable
+ """
+ if key in self.environ:
+ return self.environ[key]
+ else:
+ return ""
+
def set(self, key, value):
"""\
Set the environment variable "key" to value "value"
"""
if 'finish' in dir(self.environ):
self.environ.add_line(1)
- self.environ.add_comment("clean all the path")
+ # what for ?
+ # self.environ.add_comment("clean all the path")
self.environ.finish(required)
def set_python_libdirs(self):
self.python_lib0 = self.get('PYTHON_LIBDIR0')
self.python_lib1 = self.get('PYTHON_LIBDIR1')
+ self.has_python = True
def get_names(self, lProducts):
"""\
lProdName.append(ProdName)
return lProdName
- def set_application_env(self, logger):
+ def set_application_env(self, logger, no_PRODUCT_ROOT_DIR=False):
"""\
Sets the environment defined in the APPLICATION file.
"""
# add variable PRODUCT_ROOT_DIR as $workdir in APPLICATION.environ section if not present
- try:
- tmp = self.cfg.APPLICATION.environ.PRODUCT_ROOT_DIR
- except:
- self.cfg.APPLICATION.environ.PRODUCT_ROOT_DIR = src.pyconf.Reference(self.cfg, src.pyconf.DOLLAR, "workdir")
- DBG.write("set_application_env add default Config.APPLICATION.environ.PRODUCT_ROOT_DIR", self.cfg.APPLICATION.environ)
+ # but if sat launcher or sat package do not duplicate line context.setVariable(r"PRODUCT_ROOT_DIR", ...
+ # no_PRODUCT_ROOT_DIR used only for write_cfgForPy_file
+ if not no_PRODUCT_ROOT_DIR: # do not duplicate context.setVariable(r"PRODUCT_ROOT_DIR"
+ try:
+ tmp = self.cfg.APPLICATION.environ.PRODUCT_ROOT_DIR
+ except:
+ self.cfg.APPLICATION.environ.PRODUCT_ROOT_DIR = src.pyconf.Reference(self.cfg, src.pyconf.DOLLAR, "workdir")
+ DBG.write("set_application_env: add APPLICATION.environ.PRODUCT_ROOT_DIR", self.cfg.APPLICATION.environ)
+ # these sensitive variables are reset to avoid bad environment interactions
+ self.add_line(1)
+ self.add_comment("reset these sensitive variables to avoid bad environment interactions")
+ self.add_comment("comment these to lines if you wish a different behaviour")
+ self.set("LD_LIBRARY_PATH", "")
+ self.set("PYTHONPATH", "")
+ self.add_line(1)
+
# Set the variables defined in the "environ" section
if 'environ' in self.cfg.APPLICATION:
# we write PRODUCT environment it in order to conform to
lib_path = os.path.join(envcompo_root_dir, 'lib', 'salome')
l_binpath_libpath.append( (bin_path, lib_path) )
+
if src.get_property_in_product_cfg(pi, "fhs"):
lib_path = os.path.join(env_root_dir, 'lib')
- pylib1_path = os.path.join(env_root_dir, self.python_lib0)
- pylib2_path = os.path.join(env_root_dir, self.python_lib1)
bin_path = os.path.join(env_root_dir, 'bin')
+ if self.has_python:
+ # if the application doesn't include python, we don't need these two lines
+ pylib1_path = os.path.join(env_root_dir, self.python_lib0)
+ pylib2_path = os.path.join(env_root_dir, self.python_lib1)
else:
lib_path = os.path.join(env_root_dir, 'lib', 'salome')
- pylib1_path = os.path.join(env_root_dir, self.python_lib0, 'salome')
- pylib2_path = os.path.join(env_root_dir, self.python_lib1, 'salome')
bin_path = os.path.join(env_root_dir, 'bin', 'salome')
+ if self.has_python:
+ # if the application doesn't include python, we don't need these two lines
+ pylib1_path = os.path.join(env_root_dir, self.python_lib0, 'salome')
+ pylib2_path = os.path.join(env_root_dir, self.python_lib1, 'salome')
# Construct the paths to prepend to PATH and LD_LIBRARY_PATH and
# PYTHONPATH
else :
self.prepend('LD_LIBRARY_PATH', lib_path)
- l = [ bin_path, lib_path, pylib1_path, pylib2_path ]
+ l = [ bin_path, lib_path ]
+ if self.has_python:
+ l.append(pylib1_path)
+ l.append(pylib2_path)
+
self.prepend('PYTHONPATH', l)
def set_cpp_env(self, product_info):
else :
self.prepend('LD_LIBRARY_PATH', lib_path)
- l = [ bin_path, lib_path,
- os.path.join(env_root_dir, self.python_lib0),
- os.path.join(env_root_dir, self.python_lib1)
- ]
+ l = [ bin_path, lib_path ]
+ if self.has_python:
+ l.append(os.path.join(env_root_dir, self.python_lib0))
+ l.append(os.path.join(env_root_dir, self.python_lib1))
self.prepend('PYTHONPATH', l)
def load_cfg_environment(self, cfg_env):
self.set_salome_minimal_product_env(pi, logger)
self.set_salome_generic_product_env(pi)
+ # use variable LICENCE_FILE to communicate the licence file name to the environment script
+ licence_file_name = src.product.product_has_licence(pi, self.cfg.PATHS.LICENCEPATH)
+ if licence_file_name:
+ logger.write("licence file found for product %s : %s\n" % (pi.name, licence_file_name), 5)
+ self.set("LICENCE_FILE", licence_file_name)
+
if src.product.product_is_cpp(pi):
# set a specific environment for cpp modules
self.set_salome_minimal_product_env(pi, logger)
product_info.install_dir,
product_info.version)
else:
- # at least this one is mandatoryi,
+ # at least this one is mandatory,
# if set_env_build and set_env_build are not defined
pyproduct.set_env(self,
product_info.install_dir,
"""
DBG.write("set_full_environ for", env_info)
# DBG.write("set_full_environ config", self.cfg.APPLICATION.environ, True)
+
# set product environ
self.set_application_env(logger)
- self.set_python_libdirs()
+ if "Python" in env_info:
+ self.set_a_product("Python", logger)
+ self.set_python_libdirs()
# set products
for product in env_info:
+ if product == "Python":
+ continue
self.set_a_product(product, logger)
class FileEnvWriter:
src.printcolors.printcLabel(filename.name), 3)
# create then env object
- tmp = src.fileEnviron.get_file_environ(filename,
- "cfgForPy",
- {})
+ tmp = src.fileEnviron.get_file_environ(filename, "cfgForPy", {})
+ # DBG.write("fileEnviron.get_file_environ %s" % filename, tmp, True)
+
# environment for launch
env = SalomeEnviron(self.config,
tmp,
enable_simple_env_script = with_commercial)
env.silent = self.silent
+ DBG.write("write_cfgForPy_file", self.config.APPLICATION.environ)
+
if self.env_info is not None:
env.set_full_environ(self.logger, self.env_info)
+ DBG.write("set_full_environ", self.env_info)
+
else:
# set env from PRODUCT
- env.set_application_env(self.logger)
+ env.set_application_env(self.logger, no_PRODUCT_ROOT_DIR=True)
# The list of products to launch
lProductsName = env.get_names(self.config.APPLICATION.products.keys())
- env.set( "SALOME_MODULES", ','.join(lProductsName))
+ env.set("SALOME_MODULES", ','.join(lProductsName))
# set the products
- env.set_products(self.logger,
- src_root=self.src_root)
+ env.set_products(self.logger, src_root=self.src_root)
+ DBG.write("set_application_env without PRODUCT_ROOT_DIR", self.config.APPLICATION.environ)
# Add the additional environment if it is not empty
if len(additional_env) != 0:
