src/environment.py

   1 #!/usr/bin/env python
   2 #-*- coding:utf-8 -*-
   3 #  Copyright (C) 2010-2013  CEA/DEN
   4 #
   5 #  This library is free software; you can redistribute it and/or
   6 #  modify it under the terms of the GNU Lesser General Public
   7 #  License as published by the Free Software Foundation; either
   8 #  version 2.1 of the License.
   9 #
  10 #  This library is distributed in the hope that it will be useful,
  11 #  but WITHOUT ANY WARRANTY; without even the implied warranty of
  12 #  MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
  13 #  Lesser General Public License for more details.
  14 #
  15 #  You should have received a copy of the GNU Lesser General Public
  16 #  License along with this library; if not, write to the Free Software
  17 #  Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA  02111-1307 USA
  18
  19 import os
  20 import subprocess
  21 import string
  22 import sys
  23
  24 import src
  25
  26 class Environ:
  27     '''Class to manage the environment context
  28     '''
  29     def __init__(self, environ=None):
  30         '''Initialization. If the environ argument is passed, the environment
  31            will be add to it, else it is the external environment.
  32
  33         :param environ dict:
  34         '''
  35         if environ is not None:
  36             self.environ = environ
  37         else:
  38             self.environ = os.environ
  39
  40     def __repr__(self):
  41         """easy non exhaustive quick resume for debug print
  42         """
  43         res={}
  44         res["environ"]=self.environ
  45         return self.__class__.__name__ + str(res)[0:-1] + " ...etc...}"
  46
  47     def _expandvars(self, value):
  48         '''replace some $VARIABLE into its actual value in the environment
  49
  50         :param value str: the string to be replaced
  51         :return: the replaced variable
  52         :rtype: str
  53         '''
  54         if "$" in value:
  55             # The string.Template class is a string class
  56             # for supporting $-substitutions
  57             zt = string.Template(value)
  58             try:
  59                 value = zt.substitute(self.environ)
  60             except KeyError as exc:
  61                 raise src.SatException(_("Missing definition "
  62                                          "in environment: %s") % str(exc))
  63         return value
  64
  65     def append_value(self, key, value, sep=os.pathsep):
  66         '''append value to key using sep
  67
  68         :param key str: the environment variable to append
  69         :param value str: the value to append to key
  70         :param sep str: the separator string
  71         '''
  72         # check if the key is already in the environment
  73         if key in self.environ:
  74             value_list = self.environ[key].split(sep)
  75             # Check if the value is already in the key value or not
  76             if not value in value_list:
  77                 value_list.append(value)
  78             else:
  79                 value_list.append(value_list.pop(value_list.index(value)))
  80             self.set(key, sep.join(value_list))
  81         else:
  82             self.set(key, value)
  83
  84     def append(self, key, value, sep=os.pathsep):
  85         '''Same as append_value but the value argument can be a list
  86
  87         :param key str: the environment variable to append
  88         :param value str or list: the value(s) to append to key
  89         :param sep str: the separator string
  90         '''
  91         if isinstance(value, list):
  92             for v in value:
  93                 self.append_value(key, v, sep)
  94         else:
  95             self.append_value(key, value, sep)
  96
  97     def prepend_value(self, key, value, sep=os.pathsep):
  98         '''prepend value to key using sep
  99
 100         :param key str: the environment variable to prepend
 101         :param value str: the value to prepend to key
 102         :param sep str: the separator string
 103         '''
 104         if key in self.environ:
 105             value_list = self.environ[key].split(sep)
 106             if not value in value_list:
 107                 value_list.insert(0, value)
 108             else:
 109                 value_list.insert(0, value_list.pop(value_list.index(value)))
 110             self.set(key, sep.join(value_list))
 111         else:
 112             self.set(key, value)
 113
 114     def prepend(self, key, value, sep=os.pathsep):
 115         '''Same as prepend_value but the value argument can be a list
 116
 117         :param key str: the environment variable to prepend
 118         :param value str or list: the value(s) to prepend to key
 119         :param sep str: the separator string
 120         '''
 121         if isinstance(value, list):
 122             for v in value:
 123                 self.prepend_value(key, v, sep)
 124         else:
 125             self.prepend_value(key, value, sep)
 126
 127     def is_defined(self, key):
 128         '''Check if the key exists in the environment
 129
 130         :param key str: the environment variable to check
 131         '''
 132         return key in self.environ.keys()
 133
 134     def set(self, key, value):
 135         '''Set the environment variable "key" to value "value"
 136
 137         :param key str: the environment variable to set
 138         :param value str: the value
 139         '''
 140         self.environ[key] = self._expandvars(value)
 141
 142     def get(self, key):
 143         '''Get the value of the environment variable "key"
 144
 145         :param key str: the environment variable
 146         '''
 147         if key in self.environ:
 148             return self.environ[key]
 149         else:
 150             return ""
 151
 152     def command_value(self, key, command):
 153         '''Get the value given by the system command "command"
 154            and put it in the environment variable key
 155
 156         :param key str: the environment variable
 157         :param command str: the command to execute
 158         '''
 159         value = subprocess.Popen(command,
 160                                  shell=True,
 161                                  stdout=subprocess.PIPE,
 162                                  env=self.environ).communicate()[0]
 163         self.environ[key] = value
 164
 165
 166 class SalomeEnviron:
 167     """Class to manage the environment of SALOME.
 168     """
 169
 170     def __init__(self,
 171                  cfg,
 172                  environ,
 173                  forBuild=False,
 174                  for_package=None,
 175                  enable_simple_env_script = True):
 176         '''Initialization.
 177
 178         :param cfg Config: the global config
 179         :param environ Environ: the Environ instance where
 180                                 to store the environment variables
 181         :param forBuild bool: If true, it is a launch environment,
 182                               else a build one
 183         :param for_package str: If not None, produce a relative environment
 184                                 designed for a package.
 185         '''
 186         self.environ = environ
 187         self.cfg = cfg
 188         self.forBuild = forBuild
 189         self.for_package = for_package
 190         self.enable_simple_env_script = enable_simple_env_script
 191         self.silent = False
 192
 193     def __repr__(self):
 194         """easy non exhaustive quick resume for debug print"""
 195         res={}
 196         res["environ"]=str(self.environ)
 197         res["forBuild"]=self.forBuild
 198         return self.__class__.__name__ + str(res)[0:-1] + " ...etc...}"
 199
 200     def append(self, key, value, sep=os.pathsep):
 201         '''append value to key using sep
 202
 203         :param key str: the environment variable to append
 204         :param value str: the value to append to key
 205         :param sep str: the separator string
 206         '''
 207         return self.environ.append(key, value, sep)
 208
 209     def prepend(self, key, value, sep=os.pathsep):
 210         '''prepend value to key using sep
 211
 212         :param key str: the environment variable to prepend
 213         :param value str: the value to prepend to key
 214         :param sep str: the separator string
 215         '''
 216         return self.environ.prepend(key, value, sep)
 217
 218     def is_defined(self, key):
 219         '''Check if the key exists in the environment
 220
 221         :param key str: the environment variable to check
 222         '''
 223         return self.environ.is_defined(key)
 224
 225     def get(self, key):
 226         '''Get the value of the environment variable "key"
 227
 228         :param key str: the environment variable
 229         '''
 230         return self.environ.get(key)
 231
 232     def set(self, key, value):
 233         '''Set the environment variable "key" to value "value"
 234
 235         :param key str: the environment variable to set
 236         :param value str: the value
 237         '''
 238         # check if value needs to be evaluated
 239         if value is not None and value.startswith("`") and value.endswith("`"):
 240             res = subprocess.Popen("echo %s" % value,
 241                                    shell=True,
 242                                    stdout=subprocess.PIPE).communicate()
 243             value = res[0].strip()
 244
 245         return self.environ.set(key, value)
 246
 247     def dump(self, out):
 248         """Write the environment to out
 249
 250         :param out file: the stream where to write the environment
 251         """
 252         for k in self.environ.environ.keys():
 253             try:
 254                 value = self.get(k)
 255             except:
 256                 value = "?"
 257             out.write("%s=%s\n" % (k, value))
 258
 259     def add_line(self, nb_line):
 260         """Add empty lines to the out stream (in case of file generation)
 261
 262         :param nb_line int: the number of empty lines to add
 263         """
 264         if 'add_line' in dir(self.environ):
 265             self.environ.add_line(nb_line)
 266
 267     def add_comment(self, comment):
 268         """Add a commentary to the out stream (in case of file generation)
 269
 270         :param comment str: the commentary to add
 271         """
 272         if 'add_comment' in dir(self.environ):
 273             self.environ.add_comment(comment)
 274
 275     def add_warning(self, warning):
 276         """Add a warning to the out stream (in case of file generation)
 277
 278         :param warning str: the warning to add
 279         """
 280         if 'add_warning' in dir(self.environ):
 281             self.environ.add_warning(warning)
 282
 283     def finish(self, required):
 284         """Add a final instruction in the out file (in case of file generation)
 285
 286         :param required bool: Do nothing if required is False
 287         """
 288         if 'finish' in dir(self.environ):
 289             self.environ.add_line(1)
 290             self.environ.add_comment("clean all the path")
 291             self.environ.finish(required)
 292
 293     def set_python_libdirs(self):
 294         """Set some generic variables for python library paths
 295         """
 296         ver = self.get('PYTHON_VERSION')
 297         self.set('PYTHON_LIBDIR0', os.path.join('lib',
 298                                                 'python' + ver,
 299                                                 'site-packages'))
 300         self.set('PYTHON_LIBDIR1', os.path.join('lib64',
 301                                                 'python' + ver,
 302                                                 'site-packages'))
 303
 304         self.python_lib0 = self.get('PYTHON_LIBDIR0')
 305         self.python_lib1 = self.get('PYTHON_LIBDIR1')
 306
 307     def get_names(self, lProducts):
 308         """Get the products name to add in SALOME_MODULES environment variable
 309            It is the name of the product, except in the case where the is a
 310            component name. And it has to be in SALOME_MODULES variable only
 311            if the product has the property has_salome_hui = "yes"
 312
 313         :param lProducts list: List of products to potentially add
 314         """
 315         lProdHasGui = [p for p in lProducts if 'properties' in
 316             src.product.get_product_config(self.cfg, p) and
 317             'has_salome_gui' in
 318             src.product.get_product_config(self.cfg, p).properties and
 319             src.product.get_product_config(self.cfg,
 320                                            p).properties.has_salome_gui=='yes']
 321         lProdName = []
 322         for ProdName in lProdHasGui:
 323             pi = src.product.get_product_config(self.cfg, ProdName)
 324             if 'component_name' in pi:
 325                 lProdName.append(pi.component_name)
 326             else:
 327                 lProdName.append(ProdName)
 328         return lProdName
 329
 330     def set_application_env(self, logger):
 331         """Sets the environment defined in the APPLICATION file.
 332
 333         :param logger Logger: The logger instance to display messages
 334         """
 335
 336         # Set the variables defined in the "environ" section
 337         if 'environ' in self.cfg.APPLICATION:
 338             self.add_comment("APPLICATION environment")
 339             self.load_cfg_environment(self.cfg.APPLICATION.environ)
 340             if self.forBuild and "build" in self.cfg.APPLICATION.environ:
 341                 self.load_cfg_environment(self.cfg.APPLICATION.environ.build)
 342             if not self.forBuild and "launch" in self.cfg.APPLICATION.environ:
 343                 self.load_cfg_environment(self.cfg.APPLICATION.environ.launch)
 344             self.add_line(1)
 345
 346         # If there is an "environ_script" section, load the scripts
 347         if 'environ_script' in self.cfg.APPLICATION:
 348             for pscript in self.cfg.APPLICATION.environ_script:
 349                 self.add_comment("script %s" % pscript)
 350                 sname = pscript.replace(" ", "_")
 351                 self.run_env_script("APPLICATION_%s" % sname,
 352                                 self.cfg.APPLICATION.environ_script[pscript],
 353                                 logger)
 354                 self.add_line(1)
 355
 356     def set_salome_minimal_product_env(self, product_info, logger):
 357         """Sets the minimal environment for a SALOME product.
 358            xxx_ROOT_DIR and xxx_SRC_DIR
 359
 360         :param product_info Config: The product description
 361         :param logger Logger: The logger instance to display messages
 362         """
 363         # set root dir
 364         root_dir = product_info.name + "_ROOT_DIR"
 365         if not self.is_defined(root_dir):
 366             if 'install_dir' in product_info and product_info.install_dir:
 367                 self.set(root_dir, product_info.install_dir)
 368             elif not self.silent:
 369                 logger.write("  " + _("No install_dir for product %s\n") %
 370                               product_info.name, 5)
 371
 372         source_in_package = src.get_property_in_product_cfg(product_info,
 373                                                            "sources_in_package")
 374         if not self.for_package or source_in_package == "yes":
 375             # set source dir, unless no source dir
 376             if not src.product.product_is_fixed(product_info):
 377                 src_dir = product_info.name + "_SRC_DIR"
 378                 if not self.is_defined(src_dir):
 379                     if not self.for_package:
 380                         self.set(src_dir, product_info.source_dir)
 381                     else:
 382                         self.set(src_dir, os.path.join("out_dir_Path",
 383                                                        "SOURCES",
 384                                                        product_info.name))
 385
 386     def set_salome_generic_product_env(self, pi):
 387         """Sets the generic environment for a SALOME product.
 388
 389         :param pi Config: The product description
 390         """
 391         # Construct XXX_ROOT_DIR
 392         env_root_dir = self.get(pi.name + "_ROOT_DIR")
 393         l_binpath_libpath = []
 394
 395         # create additional ROOT_DIR for CPP components
 396         if 'component_name' in pi:
 397             compo_name = pi.component_name
 398             if compo_name + "CPP" == pi.name:
 399                 compo_root_dir = compo_name + "_ROOT_DIR"
 400                 envcompo_root_dir = os.path.join(
 401                             self.cfg.TOOLS.common.install_root, compo_name )
 402                 self.set(compo_root_dir ,  envcompo_root_dir)
 403                 bin_path = os.path.join(envcompo_root_dir, 'bin', 'salome')
 404                 lib_path = os.path.join(envcompo_root_dir, 'lib', 'salome')
 405                 l_binpath_libpath.append( (bin_path, lib_path) )
 406
 407         bin_path = os.path.join(env_root_dir, 'bin', 'salome')
 408         if src.get_property_in_product_cfg(pi, "fhs"):
 409             lib_path = os.path.join(env_root_dir, 'lib')
 410             pylib1_path = os.path.join(env_root_dir, self.python_lib0)
 411             pylib2_path = os.path.join(env_root_dir, self.python_lib1)
 412         else:
 413             lib_path = os.path.join(env_root_dir, 'lib', 'salome')
 414             pylib1_path = os.path.join(env_root_dir, self.python_lib0, 'salome')
 415             pylib2_path = os.path.join(env_root_dir, self.python_lib1, 'salome')
 416
 417         # Construct the paths to prepend to PATH and LD_LIBRARY_PATH and
 418         # PYTHONPATH
 419         l_binpath_libpath.append( (bin_path, lib_path) )
 420
 421         for bin_path, lib_path in l_binpath_libpath:
 422             if not self.forBuild:
 423                 self.prepend('PATH', bin_path)
 424                 if src.architecture.is_windows():
 425                     self.prepend('PATH', lib_path)
 426                 else :
 427                     self.prepend('LD_LIBRARY_PATH', lib_path)
 428
 429             l = [ bin_path, lib_path, pylib1_path, pylib2_path ]
 430             self.prepend('PYTHONPATH', l)
 431
 432     def set_cpp_env(self, product_info):
 433         """Sets the generic environment for a SALOME cpp product.
 434
 435         :param product_info Config: The product description
 436         """
 437         # Construct XXX_ROOT_DIR
 438         env_root_dir = self.get(product_info.name + "_ROOT_DIR")
 439         l_binpath_libpath = []
 440
 441         # Construct the paths to prepend to PATH and LD_LIBRARY_PATH and
 442         # PYTHONPATH
 443         bin_path = os.path.join(env_root_dir, 'bin')
 444         lib_path = os.path.join(env_root_dir, 'lib')
 445         l_binpath_libpath.append( (bin_path, lib_path) )
 446
 447         for bin_path, lib_path in l_binpath_libpath:
 448             if not self.forBuild:
 449                 self.prepend('PATH', bin_path)
 450                 if src.architecture.is_windows():
 451                     self.prepend('PATH', lib_path)
 452                 else :
 453                     self.prepend('LD_LIBRARY_PATH', lib_path)
 454
 455             l = [ bin_path, lib_path,
 456                   os.path.join(env_root_dir, self.python_lib0),
 457                   os.path.join(env_root_dir, self.python_lib1)
 458                 ]
 459             self.prepend('PYTHONPATH', l)
 460
 461     def load_cfg_environment(self, cfg_env):
 462         """Loads environment defined in cfg_env
 463
 464         :param cfg_env Config: A config containing an environment
 465         """
 466         # Loop on cfg_env values
 467         for env_def in cfg_env:
 468             val = cfg_env[env_def]
 469
 470             # if it is env_script, do not do anything (reserved keyword)
 471             if env_def == "env_script":
 472                 continue
 473
 474             # if it is a dict, do not do anything
 475             if isinstance(val, src.pyconf.Mapping):
 476                 continue
 477
 478             # if it is a list, loop on its values
 479             if isinstance(val, src.pyconf.Sequence):
 480                 # transform into list of strings
 481                 l_val = []
 482                 for item in val:
 483                     l_val.append(item)
 484                 val = l_val
 485
 486             # "_" means that the value must be prepended
 487             if env_def.startswith("_"):
 488                 # separator exception for PV_PLUGIN_PATH
 489                 if env_def[1:] == 'PV_PLUGIN_PATH':
 490                     self.prepend(env_def[1:], val, ';')
 491                 else:
 492                     self.prepend(env_def[1:], val)
 493             elif env_def.endswith("_"):
 494                 # separator exception for PV_PLUGIN_PATH
 495                 if env_def[:-1] == 'PV_PLUGIN_PATH':
 496                     self.append(env_def[:-1], val, ';')
 497                 else:
 498                     self.append(env_def[:-1], val)
 499             else:
 500                 self.set(env_def, val)
 501
 502     def set_a_product(self, product, logger):
 503         """Sets the environment of a product.
 504
 505         :param product str: The product name
 506         :param logger Logger: The logger instance to display messages
 507         """
 508
 509         # Get the informations corresponding to the product
 510         pi = src.product.get_product_config(self.cfg, product)
 511
 512         if self.for_package:
 513             pi.install_dir = os.path.join("out_dir_Path",
 514                                           self.for_package,
 515                                           pi.name)
 516
 517         if not self.silent:
 518             logger.write(_("Setting environment for %s\n") % product, 4)
 519
 520         self.add_line(1)
 521         self.add_comment('setting environ for ' + product)
 522
 523         # Do not define environment if the product is native
 524         if src.product.product_is_native(pi):
 525             if src.product.product_has_env_script(pi):
 526                 self.run_env_script(pi, native=True)
 527             return
 528
 529         # Set an additional environment for SALOME products
 530         if src.product.product_is_salome(pi):
 531             # set environment using definition of the product
 532             self.set_salome_minimal_product_env(pi, logger)
 533             self.set_salome_generic_product_env(pi)
 534
 535         if src.product.product_is_cpp(pi):
 536             # set a specific environment for cpp modules
 537             self.set_salome_minimal_product_env(pi, logger)
 538             self.set_cpp_env(pi)
 539
 540             if src.product.product_is_generated(pi):
 541                 if "component_name" in pi:
 542                     # hack the source and install directories in order to point
 543                     # on the generated product source install directories
 544                     install_dir_save = pi.install_dir
 545                     source_dir_save = pi.source_dir
 546                     name_save = pi.name
 547                     pi.install_dir = os.path.join(self.cfg.APPLICATION.workdir,
 548                                                   "INSTALL",
 549                                                   pi.component_name)
 550                     if self.for_package:
 551                         pi.install_dir = os.path.join("out_dir_Path",
 552                                                       self.for_package,
 553                                                       pi.component_name)
 554                     pi.source_dir = os.path.join(self.cfg.APPLICATION.workdir,
 555                                                   "GENERATED",
 556                                                   pi.component_name)
 557                     pi.name = pi.component_name
 558                     self.set_salome_minimal_product_env(pi, logger)
 559                     self.set_salome_generic_product_env(pi)
 560
 561                     # Put original values
 562                     pi.install_dir = install_dir_save
 563                     pi.source_dir = source_dir_save
 564                     pi.name = name_save
 565
 566         # Put the environment define in the configuration of the product
 567         if "environ" in pi:
 568             self.load_cfg_environment(pi.environ)
 569             if self.forBuild and "build" in pi.environ:
 570                 self.load_cfg_environment(pi.environ.build)
 571             if not self.forBuild and "launch" in pi.environ:
 572                 self.load_cfg_environment(pi.environ.launch)
 573             # if product_info defines a env_scripts, load it
 574             if 'env_script' in pi.environ:
 575                 self.run_env_script(pi, logger)
 576
 577
 578
 579
 580     def run_env_script(self, product_info, logger=None, native=False):
 581         """Runs an environment script.
 582
 583         :param product_info Config: The product description
 584         :param logger Logger: The logger instance to display messages
 585         :param native Boolean: if True load set_native_env instead of set_env
 586         """
 587         env_script = product_info.environ.env_script
 588         # Check that the script exists
 589         if not os.path.exists(env_script):
 590             raise src.SatException(_("Environment script not found: %s") %
 591                                    env_script)
 592
 593         if not self.silent and logger is not None:
 594             logger.write("  ** load %s\n" % env_script, 4)
 595
 596         # import the script and run the set_env function
 597         try:
 598             import imp
 599             pyproduct = imp.load_source(product_info.name + "_env_script",
 600                                         env_script)
 601             if not native:
 602                 pyproduct.set_env(self,
 603                                   product_info.install_dir,
 604                                   product_info.version)
 605             else:
 606                 if "set_nativ_env" in dir(pyproduct):
 607                     pyproduct.set_nativ_env(self)
 608         except:
 609             __, exceptionValue, exceptionTraceback = sys.exc_info()
 610             print(exceptionValue)
 611             import traceback
 612             traceback.print_tb(exceptionTraceback)
 613             traceback.print_exc()
 614
 615     def run_simple_env_script(self, script_path, logger=None):
 616         """Runs an environment script. Same as run_env_script, but with a
 617            script path as parameter.
 618
 619         :param script_path str: a path to an environment script
 620         :param logger Logger: The logger instance to display messages
 621         """
 622         if not self.enable_simple_env_script:
 623             return
 624         # Check that the script exists
 625         if not os.path.exists(script_path):
 626             raise src.SatException(_("Environment script not found: %s") %
 627                                    script_path)
 628
 629         if not self.silent and logger is not None:
 630             logger.write("  ** load %s\n" % script_path, 4)
 631
 632         script_basename = os.path.basename(script_path)
 633         if script_basename.endswith(".py"):
 634             script_basename = script_basename[:-len(".py")]
 635
 636         # import the script and run the set_env function
 637         try:
 638             import imp
 639             pyproduct = imp.load_source(script_basename + "_env_script",
 640                                         script_path)
 641             pyproduct.load_env(self)
 642         except:
 643             __, exceptionValue, exceptionTraceback = sys.exc_info()
 644             print(exceptionValue)
 645             import traceback
 646             traceback.print_tb(exceptionTraceback)
 647             traceback.print_exc()
 648
 649     def set_products(self, logger, src_root=None):
 650         """Sets the environment for all the products.
 651
 652         :param logger Logger: The logger instance to display messages
 653         :param src_root src: the application working directory
 654         """
 655         self.add_line(1)
 656         self.add_comment('setting environ for all products')
 657
 658         # Make sure that the python lib dirs are set after python
 659         if "Python" in self.cfg.APPLICATION.products:
 660             self.set_a_product("Python", logger)
 661             self.set_python_libdirs()
 662
 663         # The loop on the products
 664         for product in self.cfg.APPLICATION.products.keys():
 665             if product == "Python":
 666                 continue
 667             self.set_a_product(product, logger)
 668             self.finish(False)
 669
 670     def set_full_environ(self, logger, env_info):
 671         """Sets the full environment for products
 672            specified in env_info dictionary.
 673
 674         :param logger Logger: The logger instance to display messages
 675         :param env_info list: the list of products
 676         """
 677         # set product environ
 678         self.set_application_env(logger)
 679
 680         self.set_python_libdirs()
 681
 682         # set products
 683         for product in env_info:
 684             self.set_a_product(product, logger)
 685
 686 class FileEnvWriter:
 687     """Class to dump the environment to a file.
 688     """
 689     def __init__(self, config, logger, out_dir, src_root, env_info=None):
 690         '''Initialization.
 691
 692         :param cfg Config: the global config
 693         :param logger Logger: The logger instance to display messages
 694         :param out_dir str: The directory path where t put the output files
 695         :param src_root str: The application working directory
 696         :param env_info str: The list of products to add in the files.
 697         '''
 698         self.config = config
 699         self.logger = logger
 700         self.out_dir = out_dir
 701         self.src_root= src_root
 702         self.silent = True
 703         self.env_info = env_info
 704
 705     def write_env_file(self, filename, forBuild, shell, for_package = None):
 706         """Create an environment file.
 707
 708         :param filename str: the file path
 709         :param forBuild bool: if true, the build environment
 710         :param shell str: the type of file wanted (.sh, .bat)
 711         :return: The path to the generated file
 712         :rtype: str
 713         """
 714         if not self.silent:
 715             self.logger.write(_("Create environment file %s\n") %
 716                               src.printcolors.printcLabel(filename), 3)
 717
 718         # create then env object
 719         env_file = open(os.path.join(self.out_dir, filename), "w")
 720         tmp = src.fileEnviron.get_file_environ(env_file,
 721                                                shell,
 722                                                {})
 723         env = SalomeEnviron(self.config, tmp, forBuild, for_package=for_package)
 724         env.silent = self.silent
 725
 726         # Set the environment
 727         if self.env_info is not None:
 728             env.set_full_environ(self.logger, self.env_info)
 729         else:
 730             # set env from the APPLICATION
 731             env.set_application_env(self.logger)
 732
 733             # The list of products to launch
 734             lProductsName = env.get_names(self.config.APPLICATION.products.keys())
 735             env.set( "SALOME_MODULES",    ','.join(lProductsName))
 736
 737             # set the products
 738             env.set_products(self.logger,
 739                             src_root=self.src_root)
 740
 741         # add cleanup and close
 742         env.finish(True)
 743         env_file.close()
 744
 745         return env_file.name
 746
 747     def write_cfgForPy_file(self,
 748                             filename,
 749                             additional_env = {},
 750                             for_package = None,
 751                             with_commercial = True):
 752         """Append to current opened aFile a cfgForPy
 753            environment (SALOME python launcher).
 754
 755         :param filename str: the file path
 756         :param additional_env dict: a dictionary of additional variables
 757                                     to add to the environment
 758         :param for_package str: If not None, produce a relative environment
 759                                 designed for a package.
 760         """
 761         if not self.silent:
 762             self.logger.write(_("Create configuration file %s\n") %
 763                               src.printcolors.printcLabel(filename.name), 3)
 764
 765         # create then env object
 766         tmp = src.fileEnviron.get_file_environ(filename,
 767                                                "cfgForPy",
 768                                                {})
 769         # environment for launch
 770         env = SalomeEnviron(self.config,
 771                             tmp,
 772                             forBuild=False,
 773                             for_package=for_package,
 774                             enable_simple_env_script = with_commercial)
 775         env.silent = self.silent
 776
 777         if self.env_info is not None:
 778             env.set_full_environ(self.logger, self.env_info)
 779         else:
 780             # set env from PRODUCT
 781             env.set_application_env(self.logger)
 782
 783             # The list of products to launch
 784             lProductsName = env.get_names(self.config.APPLICATION.products.keys())
 785             env.set( "SALOME_MODULES",    ','.join(lProductsName))
 786
 787             # set the products
 788             env.set_products(self.logger,
 789                             src_root=self.src_root)
 790
 791         # Add the additional environment if it is not empty
 792         if len(additional_env) != 0:
 793             for variable in additional_env:
 794                 env.set(variable, additional_env[variable])
 795
 796         # add cleanup and close
 797         env.finish(True)
 798
 799 class Shell:
 800     """Definition of a Shell.
 801     """
 802     def __init__(self, name, extension):
 803         '''Initialization.
 804
 805         :param name str: the shell name
 806         :param extension str: the shell extension
 807         '''
 808         self.name = name
 809         self.extension = extension
 810
 811 def load_environment(config, build, logger):
 812     """Loads the environment (used to run the tests, for example).
 813
 814     :param config Config: the global config
 815     :param build bool: build environement if True
 816     :param logger Logger: The logger instance to display messages
 817     """
 818     environ = SalomeEnviron(config, Environ(os.environ), build)
 819     environ.set_application_env(logger)
 820     environ.set_products(logger)
 821     environ.finish(True)