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             for p in self.cfg.APPLICATION.environ:
 340                 val = self.cfg.APPLICATION.environ[p]
 341                 # "_" means that the value must be prepended
 342                 if p.startswith("_"):
 343                     # separator exception for PV_PLUGIN_PATH
 344                     if p[1:] == 'PV_PLUGIN_PATH':
 345                         self.prepend(p[1:], val, ';')
 346                     else:
 347                         self.prepend(p[1:], val)
 348                 elif p.endswith("_"):
 349                     # separator exception for PV_PLUGIN_PATH
 350                     if p[:-1] == 'PV_PLUGIN_PATH':
 351                         self.append(p[:-1], val, ';')
 352                     else:
 353                         self.append(p[:-1], val)
 354                 else:
 355                     self.set(p, val)
 356             self.add_line(1)
 357
 358         # If there is an "environ_script" section, load the scripts
 359         if 'environ_script' in self.cfg.APPLICATION:
 360             for pscript in self.cfg.APPLICATION.environ_script:
 361                 self.add_comment("script %s" % pscript)
 362                 sname = pscript.replace(" ", "_")
 363                 self.run_env_script("APPLICATION_%s" % sname,
 364                                 self.cfg.APPLICATION.environ_script[pscript],
 365                                 logger)
 366                 self.add_line(1)
 367
 368     def set_salome_minimal_product_env(self, product_info, logger):
 369         """Sets the minimal environment for a SALOME product.
 370            xxx_ROOT_DIR and xxx_SRC_DIR
 371
 372         :param product_info Config: The product description
 373         :param logger Logger: The logger instance to display messages
 374         """
 375         # set root dir
 376         root_dir = product_info.name + "_ROOT_DIR"
 377         if not self.is_defined(root_dir):
 378             if 'install_dir' in product_info and product_info.install_dir:
 379                 self.set(root_dir, product_info.install_dir)
 380             elif not self.silent:
 381                 logger.write("  " + _("No install_dir for product %s\n") %
 382                               product_info.name, 5)
 383
 384         if not self.for_package:
 385             # set source dir, unless no source dir
 386             if not src.product.product_is_fixed(product_info):
 387                 src_dir = product_info.name + "_SRC_DIR"
 388                 if not self.is_defined(src_dir):
 389                     self.set(src_dir, product_info.source_dir)
 390
 391     def set_salome_generic_product_env(self, pi):
 392         """Sets the generic environment for a SALOME product.
 393
 394         :param pi Config: The product description
 395         """
 396         # Construct XXX_ROOT_DIR
 397         env_root_dir = self.get(pi.name + "_ROOT_DIR")
 398         l_binpath_libpath = []
 399
 400         # create additional ROOT_DIR for CPP components
 401         if 'component_name' in pi:
 402             compo_name = pi.component_name
 403             if compo_name + "CPP" == pi.name:
 404                 compo_root_dir = compo_name + "_ROOT_DIR"
 405                 envcompo_root_dir = os.path.join(
 406                             self.cfg.TOOLS.common.install_root, compo_name )
 407                 self.set(compo_root_dir ,  envcompo_root_dir)
 408                 bin_path = os.path.join(envcompo_root_dir, 'bin', 'salome')
 409                 lib_path = os.path.join(envcompo_root_dir, 'lib', 'salome')
 410                 l_binpath_libpath.append( (bin_path, lib_path) )
 411
 412         appliname = 'salome'
 413         if (src.get_cfg_param(pi, 'product_type', 'SALOME').upper()
 414                             not in [ "SALOME", "SMESH_PLUGIN", "SAMPLE" ]):
 415             appliname = ''
 416
 417         # Construct the paths to prepend to PATH and LD_LIBRARY_PATH and
 418         # PYTHONPATH
 419         bin_path = os.path.join(env_root_dir, 'bin', appliname)
 420         lib_path = os.path.join(env_root_dir, 'lib', appliname)
 421         l_binpath_libpath.append( (bin_path, lib_path) )
 422
 423         for bin_path, lib_path in l_binpath_libpath:
 424             if not self.forBuild:
 425                 self.prepend('PATH', bin_path)
 426                 if src.architecture.is_windows():
 427                     self.prepend('PATH', lib_path)
 428                 else :
 429                     self.prepend('LD_LIBRARY_PATH', lib_path)
 430
 431             l = [ bin_path, lib_path,
 432                   os.path.join(env_root_dir, self.python_lib0, appliname),
 433                   os.path.join(env_root_dir, self.python_lib1, appliname)
 434                 ]
 435             self.prepend('PYTHONPATH', l)
 436
 437     def set_cpp_env(self, product_info):
 438         """Sets the generic environment for a SALOME cpp product.
 439
 440         :param product_info Config: The product description
 441         """
 442         # Construct XXX_ROOT_DIR
 443         env_root_dir = self.get(product_info.name + "_ROOT_DIR")
 444         l_binpath_libpath = []
 445
 446         # Construct the paths to prepend to PATH and LD_LIBRARY_PATH and
 447         # PYTHONPATH
 448         bin_path = os.path.join(env_root_dir, 'bin')
 449         lib_path = os.path.join(env_root_dir, 'lib')
 450         l_binpath_libpath.append( (bin_path, lib_path) )
 451
 452         for bin_path, lib_path in l_binpath_libpath:
 453             if not self.forBuild:
 454                 self.prepend('PATH', bin_path)
 455                 if src.architecture.is_windows():
 456                     self.prepend('PATH', lib_path)
 457                 else :
 458                     self.prepend('LD_LIBRARY_PATH', lib_path)
 459
 460             l = [ bin_path, lib_path,
 461                   os.path.join(env_root_dir, self.python_lib0),
 462                   os.path.join(env_root_dir, self.python_lib1)
 463                 ]
 464             self.prepend('PYTHONPATH', l)
 465
 466     def load_cfg_environment(self, cfg_env):
 467         """Loads environment defined in cfg_env
 468
 469         :param cfg_env Config: A config containing an environment
 470         """
 471         # Loop on cfg_env values
 472         for env_def in cfg_env:
 473             val = cfg_env[env_def]
 474
 475             # if it is env_script, do not do anything (reserved keyword)
 476             if env_def == "env_script":
 477                 continue
 478
 479             # if it is a dict, do not do anything
 480             if isinstance(val, src.pyconf.Mapping):
 481                 continue
 482
 483             # if it is a list, loop on its values
 484             if isinstance(val, src.pyconf.Sequence):
 485                 # transform into list of strings
 486                 l_val = []
 487                 for item in val:
 488                     l_val.append(item)
 489                 val = l_val
 490
 491             # "_" means that the value must be prepended
 492             if env_def.startswith("_"):
 493                 # separator exception for PV_PLUGIN_PATH
 494                 if env_def[1:] == 'PV_PLUGIN_PATH':
 495                     self.prepend(env_def[1:], val, ';')
 496                 else:
 497                     self.prepend(env_def[1:], val)
 498             elif env_def.endswith("_"):
 499                 # separator exception for PV_PLUGIN_PATH
 500                 if env_def[:-1] == 'PV_PLUGIN_PATH':
 501                     self.append(env_def[:-1], val, ';')
 502                 else:
 503                     self.append(env_def[:-1], val)
 504             else:
 505                 self.set(env_def, val)
 506
 507     def set_a_product(self, product, logger):
 508         """Sets the environment of a product.
 509
 510         :param product str: The product name
 511         :param logger Logger: The logger instance to display messages
 512         """
 513
 514         # Get the informations corresponding to the product
 515         pi = src.product.get_product_config(self.cfg, product)
 516
 517         if self.for_package:
 518             pi.install_dir = os.path.join("out_dir_Path",
 519                                           self.for_package,
 520                                           pi.name)
 521
 522         if not self.silent:
 523             logger.write(_("Setting environment for %s\n") % product, 4)
 524
 525         self.add_line(1)
 526         self.add_comment('setting environ for ' + product)
 527
 528         # Do not define environment if the product is native
 529         if src.product.product_is_native(pi):
 530             if src.product.product_has_env_script(pi):
 531                 self.run_env_script(pi, native=True)
 532             return
 533
 534         # Set an additional environment for SALOME products
 535         if src.product.product_is_salome(pi):
 536             # set environment using definition of the product
 537             self.set_salome_minimal_product_env(pi, logger)
 538             self.set_salome_generic_product_env(pi)
 539
 540         if src.product.product_is_cpp(pi):
 541             # set a specific environment for cpp modules
 542             self.set_salome_minimal_product_env(pi, logger)
 543             self.set_cpp_env(pi)
 544
 545             if src.product.product_is_generated(pi):
 546                 if "component_name" in pi:
 547                     # hack the source and install directories in order to point
 548                     # on the generated product source install directories
 549                     install_dir_save = pi.install_dir
 550                     source_dir_save = pi.source_dir
 551                     name_save = pi.name
 552                     pi.install_dir = os.path.join(self.cfg.APPLICATION.workdir,
 553                                                   "INSTALL",
 554                                                   pi.component_name)
 555                     if self.for_package:
 556                         pi.install_dir = os.path.join("out_dir_Path",
 557                                                       self.for_package,
 558                                                       pi.component_name)
 559                     pi.source_dir = os.path.join(self.cfg.APPLICATION.workdir,
 560                                                   "GENERATED",
 561                                                   pi.component_name)
 562                     pi.name = pi.component_name
 563                     self.set_salome_minimal_product_env(pi, logger)
 564                     self.set_salome_generic_product_env(pi)
 565
 566                     # Put original values
 567                     pi.install_dir = install_dir_save
 568                     pi.source_dir = source_dir_save
 569                     pi.name = name_save
 570
 571         # Put the environment define in the configuration of the product
 572         if "environ" in pi:
 573             self.load_cfg_environment(pi.environ)
 574             if self.forBuild and "build" in pi.environ:
 575                 self.load_cfg_environment(pi.environ.build)
 576             if not self.forBuild and "launch" in pi.environ:
 577                 self.load_cfg_environment(pi.environ.launch)
 578             # if product_info defines a env_scripts, load it
 579             if 'env_script' in pi.environ:
 580                 self.run_env_script(pi, logger)
 581
 582
 583
 584
 585     def run_env_script(self, product_info, logger=None, native=False):
 586         """Runs an environment script.
 587
 588         :param product_info Config: The product description
 589         :param logger Logger: The logger instance to display messages
 590         :param native Boolean: if True load set_native_env instead of set_env
 591         """
 592         env_script = product_info.environ.env_script
 593         # Check that the script exists
 594         if not os.path.exists(env_script):
 595             raise src.SatException(_("Environment script not found: %s") %
 596                                    env_script)
 597
 598         if not self.silent and logger is not None:
 599             logger.write("  ** load %s\n" % env_script, 4)
 600
 601         # import the script and run the set_env function
 602         try:
 603             import imp
 604             pyproduct = imp.load_source(product_info.name + "_env_script",
 605                                         env_script)
 606             if not native:
 607                 pyproduct.set_env(self,
 608                                   product_info.install_dir,
 609                                   product_info.version)
 610             else:
 611                 if "set_nativ_env" in dir(pyproduct):
 612                     pyproduct.set_nativ_env(self)
 613         except:
 614             __, exceptionValue, exceptionTraceback = sys.exc_info()
 615             print(exceptionValue)
 616             import traceback
 617             traceback.print_tb(exceptionTraceback)
 618             traceback.print_exc()
 619
 620     def run_simple_env_script(self, script_path, logger=None):
 621         """Runs an environment script. Same as run_env_script, but with a
 622            script path as parameter.
 623
 624         :param script_path str: a path to an environment script
 625         :param logger Logger: The logger instance to display messages
 626         """
 627         if not self.enable_simple_env_script:
 628             return
 629         # Check that the script exists
 630         if not os.path.exists(script_path):
 631             raise src.SatException(_("Environment script not found: %s") %
 632                                    script_path)
 633
 634         if not self.silent and logger is not None:
 635             logger.write("  ** load %s\n" % script_path, 4)
 636
 637         script_basename = os.path.basename(script_path)
 638         if script_basename.endswith(".py"):
 639             script_basename = script_basename[:-len(".py")]
 640
 641         # import the script and run the set_env function
 642         try:
 643             import imp
 644             pyproduct = imp.load_source(script_basename + "_env_script",
 645                                         script_path)
 646             pyproduct.load_env(self)
 647         except:
 648             __, exceptionValue, exceptionTraceback = sys.exc_info()
 649             print(exceptionValue)
 650             import traceback
 651             traceback.print_tb(exceptionTraceback)
 652             traceback.print_exc()
 653
 654     def set_products(self, logger, src_root=None):
 655         """Sets the environment for all the products.
 656
 657         :param logger Logger: The logger instance to display messages
 658         :param src_root src: the application working directory
 659         """
 660         self.add_line(1)
 661         self.add_comment('setting environ for all products')
 662
 663         # Make sure that the python lib dirs are set after python
 664         if "Python" in self.cfg.APPLICATION.products:
 665             self.set_a_product("Python", logger)
 666             self.set_python_libdirs()
 667
 668         # The loop on the products
 669         for product in self.cfg.APPLICATION.products.keys():
 670             if product == "Python":
 671                 continue
 672             self.set_a_product(product, logger)
 673             self.finish(False)
 674
 675     def set_full_environ(self, logger, env_info):
 676         """Sets the full environment for products
 677            specified in env_info dictionary.
 678
 679         :param logger Logger: The logger instance to display messages
 680         :param env_info list: the list of products
 681         """
 682         # set product environ
 683         self.set_application_env(logger)
 684
 685         self.set_python_libdirs()
 686
 687         # set products
 688         for product in env_info:
 689             self.set_a_product(product, logger)
 690
 691 class FileEnvWriter:
 692     """Class to dump the environment to a file.
 693     """
 694     def __init__(self, config, logger, out_dir, src_root, env_info=None):
 695         '''Initialization.
 696
 697         :param cfg Config: the global config
 698         :param logger Logger: The logger instance to display messages
 699         :param out_dir str: The directory path where t put the output files
 700         :param src_root str: The application working directory
 701         :param env_info str: The list of products to add in the files.
 702         '''
 703         self.config = config
 704         self.logger = logger
 705         self.out_dir = out_dir
 706         self.src_root= src_root
 707         self.silent = True
 708         self.env_info = env_info
 709
 710     def write_env_file(self, filename, forBuild, shell, for_package = None):
 711         """Create an environment file.
 712
 713         :param filename str: the file path
 714         :param forBuild bool: if true, the build environment
 715         :param shell str: the type of file wanted (.sh, .bat)
 716         :return: The path to the generated file
 717         :rtype: str
 718         """
 719         if not self.silent:
 720             self.logger.write(_("Create environment file %s\n") %
 721                               src.printcolors.printcLabel(filename), 3)
 722
 723         # create then env object
 724         env_file = open(os.path.join(self.out_dir, filename), "w")
 725         tmp = src.fileEnviron.get_file_environ(env_file,
 726                                                shell,
 727                                                {})
 728         env = SalomeEnviron(self.config, tmp, forBuild, for_package=for_package)
 729         env.silent = self.silent
 730
 731         # Set the environment
 732         if self.env_info is not None:
 733             env.set_full_environ(self.logger, self.env_info)
 734         else:
 735             # set env from the APPLICATION
 736             env.set_application_env(self.logger)
 737
 738             # The list of products to launch
 739             lProductsName = env.get_names(self.config.APPLICATION.products.keys())
 740             env.set( "SALOME_MODULES",    ','.join(lProductsName))
 741
 742             # set the products
 743             env.set_products(self.logger,
 744                             src_root=self.src_root)
 745
 746         # add cleanup and close
 747         env.finish(True)
 748         env_file.close()
 749
 750         return env_file.name
 751
 752     def write_cfgForPy_file(self,
 753                             filename,
 754                             additional_env = {},
 755                             for_package = None,
 756                             with_commercial = True):
 757         """Append to current opened aFile a cfgForPy
 758            environment (SALOME python launcher).
 759
 760         :param filename str: the file path
 761         :param additional_env dict: a dictionary of additional variables
 762                                     to add to the environment
 763         :param for_package str: If not None, produce a relative environment
 764                                 designed for a package.
 765         """
 766         if not self.silent:
 767             self.logger.write(_("Create configuration file %s\n") %
 768                               src.printcolors.printcLabel(filename.name), 3)
 769
 770         # create then env object
 771         tmp = src.fileEnviron.get_file_environ(filename,
 772                                                "cfgForPy",
 773                                                {})
 774         # environment for launch
 775         env = SalomeEnviron(self.config,
 776                             tmp,
 777                             forBuild=False,
 778                             for_package=for_package,
 779                             enable_simple_env_script = with_commercial)
 780         env.silent = self.silent
 781
 782         if self.env_info is not None:
 783             env.set_full_environ(self.logger, self.env_info)
 784         else:
 785             # set env from PRODUCT
 786             env.set_application_env(self.logger)
 787
 788             # The list of products to launch
 789             lProductsName = env.get_names(self.config.APPLICATION.products.keys())
 790             env.set( "SALOME_MODULES",    ','.join(lProductsName))
 791
 792             # set the products
 793             env.set_products(self.logger,
 794                             src_root=self.src_root)
 795
 796         # Add the additional environment if it is not empty
 797         if len(additional_env) != 0:
 798             for variable in additional_env:
 799                 env.set(variable, additional_env[variable])
 800
 801         # add cleanup and close
 802         env.finish(True)
 803
 804 class Shell:
 805     """Definition of a Shell.
 806     """
 807     def __init__(self, name, extension):
 808         '''Initialization.
 809
 810         :param name str: the shell name
 811         :param extension str: the shell extension
 812         '''
 813         self.name = name
 814         self.extension = extension
 815
 816 def load_environment(config, build, logger):
 817     """Loads the environment (used to run the tests, for example).
 818
 819     :param config Config: the global config
 820     :param build bool: build environement if True
 821     :param logger Logger: The logger instance to display messages
 822     """
 823     environ = SalomeEnviron(config, Environ(os.environ), build)
 824     environ.set_application_env(logger)
 825     environ.set_products(logger)
 826     environ.finish(True)