commands/config.py

   1 #!/usr/bin/env python
   2 #-*- coding:utf-8 -*-
   3 #  Copyright (C) 2010-2012  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 platform
  21 import datetime
  22 import shutil
  23 import gettext
  24 import sys
  25
  26 import src
  27
  28 # internationalization
  29 satdir  = os.path.dirname(os.path.realpath(__file__))
  30 gettext.install('salomeTools', os.path.join(satdir, 'src', 'i18n'))
  31
  32 # Define all possible option for config command :  sat config <options>
  33 parser = src.options.Options()
  34 parser.add_option('v', 'value', 'string', 'value',
  35     _("print the value of CONFIG_VARIABLE."))
  36 parser.add_option('e', 'edit', 'boolean', 'edit',
  37     _("edit the product configuration file."))
  38 parser.add_option('i', 'info', 'string', 'info',
  39     _("get information on a product."))
  40 parser.add_option('l', 'list', 'boolean', 'list',
  41     _("list all available applications."))
  42 parser.add_option('c', 'copy', 'boolean', 'copy',
  43     _("""copy a config file to the personnal config files directory.
  44 \tWARNING the included files are not copied.
  45 \tIf a name is given the new config file takes the given name."""))
  46 parser.add_option('n', 'no_label', 'boolean', 'no_label',
  47     _("do not print labels, Works only with --value and --list."))
  48 parser.add_option('s', 'schema', 'boolean', 'schema',
  49     _("Internal use."))
  50
  51 class ConfigOpener:
  52     '''Class that helps to find an application pyconf
  53        in all the possible directories (pathList)
  54     '''
  55     def __init__(self, pathList):
  56         '''Initialization
  57
  58         :param pathList list: The list of paths where to serach a pyconf.
  59         '''
  60         self.pathList = pathList
  61
  62     def __call__(self, name):
  63         if os.path.isabs(name):
  64             return src.pyconf.ConfigInputStream(open(name, 'rb'))
  65         else:
  66             return src.pyconf.ConfigInputStream(
  67                         open(os.path.join( self.get_path(name), name ), 'rb') )
  68         raise IOError(_("Configuration file '%s' not found") % name)
  69
  70     def get_path( self, name ):
  71         '''The method that returns the entire path of the pyconf searched
  72         :param name str: The name of the searched pyconf.
  73         '''
  74         for path in self.pathList:
  75             if os.path.exists(os.path.join(path, name)):
  76                 return path
  77         raise IOError(_("Configuration file '%s' not found") % name)
  78
  79 class ConfigManager:
  80     '''Class that manages the read of all the configuration files of salomeTools
  81     '''
  82     def __init__(self, datadir=None):
  83         pass
  84
  85     def _create_vars(self, application=None, command=None, datadir=None):
  86         '''Create a dictionary that stores all information about machine,
  87            user, date, repositories, etc...
  88
  89         :param application str: The application for which salomeTools is called.
  90         :param command str: The command that is called.
  91         :param datadir str: The repository that contain external data
  92                             for salomeTools.
  93         :return: The dictionary that stores all information.
  94         :rtype: dict
  95         '''
  96         var = {}
  97         var['user'] = src.architecture.get_user()
  98         var['salometoolsway'] = os.path.dirname(
  99                                     os.path.dirname(os.path.abspath(__file__)))
 100         var['srcDir'] = os.path.join(var['salometoolsway'], 'src')
 101         var['sep']= os.path.sep
 102
 103         # datadir has a default location
 104         var['datadir'] = os.path.join(var['salometoolsway'], 'data')
 105         if datadir is not None:
 106             var['datadir'] = datadir
 107
 108         var['personalDir'] = os.path.join(os.path.expanduser('~'),
 109                                            '.salomeTools')
 110
 111         # read linux distributions dictionary
 112         distrib_cfg = src.pyconf.Config(os.path.join(var['srcDir'],
 113                                                       'internal_config',
 114                                                       'distrib.pyconf'))
 115
 116         # set platform parameters
 117         dist_name = src.architecture.get_distribution(
 118                                             codes=distrib_cfg.DISTRIBUTIONS)
 119         dist_version = src.architecture.get_distrib_version(dist_name,
 120                                                     codes=distrib_cfg.VERSIONS)
 121         dist = dist_name + dist_version
 122
 123         var['dist_name'] = dist_name
 124         var['dist_version'] = dist_version
 125         var['dist'] = dist
 126         var['python'] = src.architecture.get_python_version()
 127
 128         var['nb_proc'] = src.architecture.get_nb_proc()
 129         node_name = platform.node()
 130         var['node'] = node_name
 131         var['hostname'] = node_name
 132
 133         # set date parameters
 134         dt = datetime.datetime.now()
 135         var['date'] = dt.strftime('%Y%m%d')
 136         var['datehour'] = dt.strftime('%Y%m%d_%H%M%S')
 137         var['hour'] = dt.strftime('%H%M%S')
 138
 139         var['command'] = str(command)
 140         var['application'] = str(application)
 141
 142         # Root dir for temporary files
 143         var['tmp_root'] = os.sep + 'tmp' + os.sep + var['user']
 144         # particular win case
 145         if src.architecture.is_windows() :
 146             var['tmp_root'] =  os.path.expanduser('~') + os.sep + 'tmp'
 147
 148         return var
 149
 150     def get_command_line_overrides(self, options, sections):
 151         '''get all the overwrites that are in the command line
 152
 153         :param options: the options from salomeTools class
 154                         initialization (like -l5 or --overwrite)
 155         :param sections str: The config section to overwrite.
 156         :return: The list of all the overwrites to apply.
 157         :rtype: list
 158         '''
 159         # when there are no options or not the overwrite option,
 160         # return an empty list
 161         if options is None or options.overwrite is None:
 162             return []
 163
 164         over = []
 165         for section in sections:
 166             # only overwrite the sections that correspond to the option
 167             over.extend(filter(lambda l: l.startswith(section + "."),
 168                                options.overwrite))
 169         return over
 170
 171     def get_config(self, application=None, options=None, command=None,
 172                     datadir=None):
 173         '''get the config from all the configuration files.
 174
 175         :param application str: The application for which salomeTools is called.
 176         :param options class Options: The general salomeToos
 177                                       options (--overwrite or -l5, for example)
 178         :param command str: The command that is called.
 179         :param datadir str: The repository that contain
 180                             external data for salomeTools.
 181         :return: The final config.
 182         :rtype: class 'src.pyconf.Config'
 183         '''
 184
 185         # create a ConfigMerger to handle merge
 186         merger = src.pyconf.ConfigMerger()#MergeHandler())
 187
 188         # create the configuration instance
 189         cfg = src.pyconf.Config()
 190
 191         # =====================================================================
 192         # create VARS section
 193         var = self._create_vars(application=application, command=command,
 194                                 datadir=datadir)
 195         # add VARS to config
 196         cfg.VARS = src.pyconf.Mapping(cfg)
 197         for variable in var:
 198             cfg.VARS[variable] = var[variable]
 199
 200         # apply overwrite from command line if needed
 201         for rule in self.get_command_line_overrides(options, ["VARS"]):
 202             exec('cfg.' + rule) # this cannot be factorized because of the exec
 203
 204         # =====================================================================
 205         # Load INTERNAL config
 206         # read src/internal_config/salomeTools.pyconf
 207         src.pyconf.streamOpener = ConfigOpener([
 208                             os.path.join(cfg.VARS.srcDir, 'internal_config')])
 209         try:
 210             internal_cfg = src.pyconf.Config(open(os.path.join(cfg.VARS.srcDir,
 211                                     'internal_config', 'salomeTools.pyconf')))
 212         except src.pyconf.ConfigError as e:
 213             raise src.SatException(_("Error in configuration file:"
 214                                      " salomeTools.pyconf\n  %(error)s") % \
 215                                    {'error': str(e) })
 216
 217         merger.merge(cfg, internal_cfg)
 218
 219         # apply overwrite from command line if needed
 220         for rule in self.get_command_line_overrides(options, ["INTERNAL"]):
 221             exec('cfg.' + rule) # this cannot be factorized because of the exec
 222
 223         # =====================================================================
 224         # Load SITE config file
 225         # search only in the data directory
 226         src.pyconf.streamOpener = ConfigOpener([cfg.VARS.datadir])
 227         try:
 228             site_cfg = src.pyconf.Config(open(os.path.join(cfg.VARS.datadir,
 229                                                            'site.pyconf')))
 230         except src.pyconf.ConfigError as e:
 231             raise src.SatException(_("Error in configuration file: "
 232                                      "site.pyconf\n  %(error)s") % \
 233                 {'error': str(e) })
 234         except IOError as error:
 235             e = str(error)
 236             if "site.pyconf" in e :
 237                 e += ("\nYou can copy data"
 238                   + cfg.VARS.sep
 239                   + "site.template.pyconf to data"
 240                   + cfg.VARS.sep
 241                   + "site.pyconf and edit the file")
 242             raise src.SatException( e );
 243
 244         # add user local path for configPath
 245         site_cfg.SITE.config.config_path.append(
 246                         os.path.join(cfg.VARS.personalDir, 'Applications'),
 247                         "User applications path")
 248
 249         merger.merge(cfg, site_cfg)
 250
 251         # apply overwrite from command line if needed
 252         for rule in self.get_command_line_overrides(options, ["SITE"]):
 253             exec('cfg.' + rule) # this cannot be factorized because of the exec
 254
 255
 256         # =====================================================================
 257         # Load APPLICATION config file
 258         if application is not None:
 259             # search APPLICATION file in all directories in configPath
 260             cp = cfg.SITE.config.config_path
 261             src.pyconf.streamOpener = ConfigOpener(cp)
 262             try:
 263                 application_cfg = src.pyconf.Config(application + '.pyconf')
 264             except IOError as e:
 265                 raise src.SatException(_("%s, use 'config --list' to get the"
 266                                          " list of available applications.") %e)
 267             except src.pyconf.ConfigError as e:
 268                 raise src.SatException(_("Error in configuration file:"
 269                                 " %(application)s.pyconf\n  %(error)s") % \
 270                     { 'application': application, 'error': str(e) } )
 271
 272             merger.merge(cfg, application_cfg)
 273
 274             # apply overwrite from command line if needed
 275             for rule in self.get_command_line_overrides(options,
 276                                                          ["APPLICATION"]):
 277                 # this cannot be factorized because of the exec
 278                 exec('cfg.' + rule)
 279
 280             # default launcher name ('salome')
 281             if ('profile' in cfg.APPLICATION and
 282                 'launcher_name' not in cfg.APPLICATION.profile):
 283                 cfg.APPLICATION.profile.launcher_name = 'salome'
 284
 285         # =====================================================================
 286         # Load product config files in PRODUCTS section
 287
 288         # The directory containing the softwares definition
 289         products_dir = os.path.join(cfg.VARS.datadir, 'products')
 290
 291         # Loop on all files that are in softsDir directory
 292         # and read their config
 293         for fName in os.listdir(products_dir):
 294             if fName.endswith(".pyconf"):
 295                 src.pyconf.streamOpener = ConfigOpener([products_dir])
 296                 try:
 297                     prod_cfg = src.pyconf.Config(open(
 298                                                 os.path.join(products_dir, fName)))
 299                 except src.pyconf.ConfigError as e:
 300                     raise src.SatException(_(
 301                         "Error in configuration file: %(prod)s\n  %(error)s") % \
 302                         {'prod' :  fName, 'error': str(e) })
 303                 except IOError as error:
 304                     e = str(error)
 305                     raise src.SatException( e );
 306                 except Exception as e:
 307                     raise src.SatException(_(
 308                         "Error in configuration file: %(prod)s\n  %(error)s") % \
 309                         {'prod' :  fName, 'error': str(e) })
 310
 311                 merger.merge(cfg.PRODUCTS, prod_cfg)
 312
 313         # apply overwrite from command line if needed
 314         for rule in self.get_command_line_overrides(options, ["PRODUCTS"]):
 315             exec('cfg.' + rule) # this cannot be factorized because of the exec
 316
 317
 318         # =====================================================================
 319         # load USER config
 320         self.set_user_config_file(cfg)
 321         user_cfg_file = self.get_user_config_file()
 322         user_cfg = src.pyconf.Config(open(user_cfg_file))
 323         merger.merge(cfg, user_cfg)
 324
 325         # apply overwrite from command line if needed
 326         for rule in self.get_command_line_overrides(options, ["USER"]):
 327             exec('cfg.' + rule) # this cannot be factorize because of the exec
 328
 329         return cfg
 330
 331     def set_user_config_file(self, config):
 332         '''Set the user config file name and path.
 333         If necessary, build it from another one or create it from scratch.
 334
 335         :param config class 'src.pyconf.Config': The global config
 336                                                  (containing all pyconf).
 337         '''
 338         # get the expected name and path of the file
 339         self.config_file_name = 'salomeTools.pyconf'
 340         self.user_config_file_path = os.path.join(config.VARS.personalDir,
 341                                                    self.config_file_name)
 342
 343         # if pyconf does not exist, create it from scratch
 344         if not os.path.isfile(self.user_config_file_path):
 345             self.create_config_file(config)
 346
 347     def create_config_file(self, config):
 348         '''This method is called when there are no user config file.
 349            It build it from scratch.
 350
 351         :param config class 'src.pyconf.Config': The global config.
 352         :return: the config corresponding to the file created.
 353         :rtype: config class 'src.pyconf.Config'
 354         '''
 355
 356         cfg_name = self.get_user_config_file()
 357
 358         user_cfg = src.pyconf.Config()
 359         #
 360         user_cfg.addMapping('USER', src.pyconf.Mapping(user_cfg), "")
 361
 362         #
 363         user_cfg.USER.addMapping('workdir', os.path.expanduser('~'),
 364             "This is where salomeTools will work. "
 365             "You may (and probably do) change it.\n")
 366         user_cfg.USER.addMapping('cvs_user', config.VARS.user,
 367             "This is the user name used to access salome cvs base.\n")
 368         user_cfg.USER.addMapping('svn_user', config.VARS.user,
 369             "This is the user name used to access salome svn base.\n")
 370         user_cfg.USER.addMapping('output_verbose_level', 3,
 371             "This is the default output_verbose_level you want."
 372             " 0=>no output, 5=>debug.\n")
 373         user_cfg.USER.addMapping('publish_dir',
 374                                  os.path.join(os.path.expanduser('~'),
 375                                  'websupport',
 376                                  'satreport'),
 377                                  "")
 378         user_cfg.USER.addMapping('editor',
 379                                  'vi',
 380                                  "This is the editor used to "
 381                                  "modify configuration files\n")
 382         user_cfg.USER.addMapping('browser',
 383                                  'firefox',
 384                                  "This is the browser used to "
 385                                  "read html documentation\n")
 386         user_cfg.USER.addMapping('pdf_viewer',
 387                                  'evince',
 388                                  "This is the pdf_viewer used "
 389                                  "to read pdf documentation\n")
 390         user_cfg.USER.addMapping("bases",
 391                                  src.pyconf.Mapping(user_cfg.USER),
 392                                  "The products installation base(s)\n")
 393
 394         user_cfg.USER.bases.base = src.pyconf.Reference(
 395                                             user_cfg,
 396                                             src.pyconf.DOLLAR,
 397                                             'workdir  + $VARS.sep + "BASE"')
 398         #
 399         src.ensure_path_exists(config.VARS.personalDir)
 400         src.ensure_path_exists(os.path.join(config.VARS.personalDir,
 401                                             'Applications'))
 402
 403         f = open(cfg_name, 'w')
 404         user_cfg.__save__(f)
 405         f.close()
 406
 407         return user_cfg
 408
 409     def get_user_config_file(self):
 410         '''Get the user config file
 411         :return: path to the user config file.
 412         :rtype: str
 413         '''
 414         if not self.user_config_file_path:
 415             raise src.SatException(_("Error in get_user_config_file: "
 416                                      "missing user config file path"))
 417         return self.user_config_file_path
 418
 419 def check_path(path, ext=[]):
 420     '''Construct a text with the input path and "not found" if it does not
 421        exist.
 422
 423     :param path Str: the path to check.
 424     :param ext List: An extension. Verify that the path extension
 425                      is in the list
 426     :return: The string of the path with information
 427     :rtype: Str
 428     '''
 429     # check if file exists
 430     if not os.path.exists(path):
 431         return "'%s'" % path + " " + src.printcolors.printcError(_(
 432                                                             "** not found"))
 433
 434     # check extension
 435     if len(ext) > 0:
 436         fe = os.path.splitext(path)[1].lower()
 437         if fe not in ext:
 438             return "'%s'" % path + " " + src.printcolors.printcError(_(
 439                                                         "** bad extension"))
 440
 441     return path
 442
 443 def show_product_info(config, name, logger):
 444     '''Display on the terminal and logger information about a product.
 445
 446     :param config Config: the global configuration.
 447     :param name Str: The name of the product
 448     :param logger Logger: The logger instance to use for the display
 449     '''
 450
 451     logger.write(_("%s is a product\n") % src.printcolors.printcLabel(name), 2)
 452     pinfo = src.product.get_product_config(config, name)
 453
 454     # Type of the product
 455     ptype = src.get_cfg_param(pinfo, "type", "")
 456     src.printcolors.print_value(logger, "type", ptype, 2)
 457     if "opt_depend" in pinfo:
 458         src.printcolors.print_value(logger,
 459                                     "depends on",
 460                                     ', '.join(pinfo.depend), 2)
 461
 462     if "opt_depend" in pinfo:
 463         src.printcolors.print_value(logger,
 464                                     "optional",
 465                                     ', '.join(pinfo.opt_depend), 2)
 466
 467     # information on prepare
 468     logger.write("\n", 2)
 469     logger.write(src.printcolors.printcLabel("prepare:") + "\n", 2)
 470
 471     is_dev = src.product.product_is_dev(pinfo)
 472     method = pinfo.get_source
 473     if is_dev:
 474         method += " (dev)"
 475     src.printcolors.print_value(logger, "get method", method, 2)
 476
 477     if method == 'cvs':
 478         src.printcolors.print_value(logger, "server", pinfo.cvs_info.server, 2)
 479         src.printcolors.print_value(logger, "base module",
 480                                     pinfo.cvs_info.module_base, 2)
 481         src.printcolors.print_value(logger, "source", pinfo.cvs_info.source, 2)
 482         src.printcolors.print_value(logger, "tag", pinfo.cvs_info.tag, 2)
 483
 484     elif method == 'svn':
 485         src.printcolors.print_value(logger, "repo", pinfo.svn_info.repo, 2)
 486
 487     elif method == 'git':
 488         src.printcolors.print_value(logger, "repo", pinfo.git_info.repo, 2)
 489         src.printcolors.print_value(logger, "tag", pinfo.git_info.tag, 2)
 490
 491     elif method == 'archive':
 492         src.printcolors.print_value(logger,
 493                                     "get from",
 494                                     check_path(pinfo.archive_info.archive_name),
 495                                     2)
 496
 497     if 'patches' in pinfo:
 498         for patch in pinfo.patches:
 499             src.printcolors.print_value(logger, "patch", check_path(patch), 2)
 500
 501     if src.product.product_is_fixed(pinfo):
 502         src.printcolors.print_value(logger, "install_dir",
 503                                     check_path(pinfo.install_dir), 2)
 504
 505     if src.product.product_is_native(pinfo) or src.product.product_is_fixed(pinfo):
 506         return
 507
 508     # information on compilation
 509     logger.write("\n", 2)
 510     logger.write(src.printcolors.printcLabel("compile:") + "\n", 2)
 511     src.printcolors.print_value(logger,
 512                                 "compilation method",
 513                                 pinfo.build_source,
 514                                 2)
 515
 516     if pinfo.build_source == "script" and "compil_script" in pinfo:
 517         src.printcolors.print_value(logger,
 518                                     "Compilation script",
 519                                     pinfo.compil_script,
 520                                     2)
 521
 522     if 'nb_proc' in pinfo:
 523         src.printcolors.print_value(logger, "make -j", pinfo.nb_proc, 2)
 524
 525     src.printcolors.print_value(logger,
 526                                 "source dir",
 527                                 check_path(pinfo.source_dir),
 528                                 2)
 529     if 'install_dir' in pinfo:
 530         src.printcolors.print_value(logger,
 531                                     "build dir",
 532                                     check_path(pinfo.build_dir),
 533                                     2)
 534         src.printcolors.print_value(logger,
 535                                     "install dir",
 536                                     check_path(pinfo.install_dir),
 537                                     2)
 538     else:
 539         logger.write("  " +
 540                      src.printcolors.printcWarning(_("no install dir")) +
 541                      "\n", 2)
 542
 543     # information on environment
 544     logger.write("\n", 2)
 545     logger.write(src.printcolors.printcLabel("environ :") + "\n", 2)
 546     if "environ" in pinfo and "env_script" in pinfo.environ:
 547         src.printcolors.print_value(logger,
 548                                     "script",
 549                                     check_path(pinfo.environ.env_script),
 550                                     2)
 551
 552     zz = src.environment.SalomeEnviron(config,
 553                                        src.fileEnviron.ScreenEnviron(logger),
 554                                        False)
 555     zz.set_python_libdirs()
 556     zz.set_a_product(name, logger)
 557
 558
 559 def print_value(config, path, show_label, logger, level=0, show_full_path=False):
 560     '''Prints a value from the configuration. Prints recursively the values
 561        under the initial path.
 562
 563     :param config class 'src.pyconf.Config': The configuration
 564                                              from which the value is displayed.
 565     :param path str : the path in the configuration of the value to print.
 566     :param show_label boolean: if True, do a basic display.
 567                                (useful for bash completion)
 568     :param logger Logger: the logger instance
 569     :param level int: The number of spaces to add before display.
 570     :param show_full_path :
 571     '''
 572
 573     # Make sure that the path does not ends with a point
 574     if path.endswith('.'):
 575         path = path[:-1]
 576
 577     # display all the path or not
 578     if show_full_path:
 579         vname = path
 580     else:
 581         vname = path.split('.')[-1]
 582
 583     # number of spaces before the display
 584     tab_level = "  " * level
 585
 586     # call to the function that gets the value of the path.
 587     try:
 588         val = config.getByPath(path)
 589     except Exception as e:
 590         logger.write(tab_level)
 591         logger.write("%s: ERROR %s\n" % (src.printcolors.printcLabel(vname),
 592                                          src.printcolors.printcError(str(e))))
 593         return
 594
 595     # in this case, display only the value
 596     if show_label:
 597         logger.write(tab_level)
 598         logger.write("%s: " % src.printcolors.printcLabel(vname))
 599
 600     # The case where the value has under values,
 601     # do a recursive call to the function
 602     if dir(val).__contains__('keys'):
 603         if show_label: logger.write("\n")
 604         for v in sorted(val.keys()):
 605             print_value(config, path + '.' + v, show_label, logger, level + 1)
 606     elif val.__class__ == src.pyconf.Sequence or isinstance(val, list):
 607         # in this case, value is a list (or a Sequence)
 608         if show_label: logger.write("\n")
 609         index = 0
 610         for v in val:
 611             print_value(config, path + "[" + str(index) + "]",
 612                         show_label, logger, level + 1)
 613             index = index + 1
 614     else: # case where val is just a str
 615         logger.write("%s\n" % val)
 616
 617 def get_config_children(config, args):
 618     '''Gets the names of the children of the given parameter.
 619        Useful only for completion mechanism
 620
 621     :param config Config: The configuration where to read the values
 622     :param args: The path in the config from which get the keys
 623     '''
 624     vals = []
 625     rootkeys = config.keys()
 626
 627     if len(args) == 0:
 628         # no parameter returns list of root keys
 629         vals = rootkeys
 630     else:
 631         parent = args[0]
 632         pos = parent.rfind('.')
 633         if pos < 0:
 634             # Case where there is only on key as parameter.
 635             # For example VARS
 636             vals = [m for m in rootkeys if m.startswith(parent)]
 637         else:
 638             # Case where there is a part from a key
 639             # for example VARS.us  (for VARS.user)
 640             head = parent[0:pos]
 641             tail = parent[pos+1:]
 642             try:
 643                 a = config.getByPath(head)
 644                 if dir(a).__contains__('keys'):
 645                     vals = map(lambda x: head + '.' + x,
 646                                [m for m in a.keys() if m.startswith(tail)])
 647             except:
 648                 pass
 649
 650     for v in sorted(vals):
 651         sys.stdout.write("%s\n" % v)
 652
 653 def description():
 654     '''method that is called when salomeTools is called with --help option.
 655
 656     :return: The text to display for the config command description.
 657     :rtype: str
 658     '''
 659     return _("The config command allows manipulation "
 660              "and operation on config files.")
 661
 662
 663 def run(args, runner, logger):
 664     '''method that is called when salomeTools is called with config parameter.
 665     '''
 666     # Parse the options
 667     (options, args) = parser.parse_args(args)
 668
 669     # Only useful for completion mechanism : print the keys of the config
 670     if options.schema:
 671         get_config_children(runner.cfg, args)
 672         return
 673
 674     # case : print a value of the config
 675     if options.value:
 676         if options.value == ".":
 677             # if argument is ".", print all the config
 678             for val in sorted(runner.cfg.keys()):
 679                 print_value(runner.cfg, val, not options.no_label, logger)
 680         else:
 681             print_value(runner.cfg, options.value, not options.no_label, logger,
 682                         level=0, show_full_path=False)
 683
 684     # case : edit user pyconf file or application file
 685     elif options.edit:
 686         editor = runner.cfg.USER.editor
 687         if 'APPLICATION' not in runner.cfg: # edit user pyconf
 688             usercfg = os.path.join(runner.cfg.VARS.personalDir,
 689                                    'salomeTools.pyconf')
 690             src.system.show_in_editor(editor, usercfg, logger)
 691         else:
 692             # search for file <application>.pyconf and open it
 693             for path in runner.cfg.SITE.config.config_path:
 694                 pyconf_path = os.path.join(path,
 695                                     runner.cfg.VARS.application + ".pyconf")
 696                 if os.path.exists(pyconf_path):
 697                     src.system.show_in_editor(editor, pyconf_path, logger)
 698                     break
 699
 700     # case : give information about the product in parameter
 701     elif options.info:
 702         src.check_config_has_application(runner.cfg)
 703         if options.info in runner.cfg.APPLICATION.products:
 704             show_product_info(runner.cfg, options.info, logger)
 705             return
 706         raise src.SatException(_("%(product_name)s is not a product "
 707                                  "of %(application_name)s.") %
 708                                {'product_name' : options.info,
 709                                 'application_name' :
 710                                 runner.cfg.VARS.application})
 711
 712     # case : copy an existing <application>.pyconf
 713     # to ~/.salomeTools/Applications/LOCAL_<application>.pyconf
 714     elif options.copy:
 715         # product is required
 716         src.check_config_has_application( runner.cfg )
 717
 718         # get application file path
 719         source = runner.cfg.VARS.application + '.pyconf'
 720         source_full_path = ""
 721         for path in runner.cfg.SITE.config.config_path:
 722             # ignore personal directory
 723             if path == runner.cfg.VARS.personalDir:
 724                 continue
 725             # loop on all directories that can have pyconf applications
 726             zz = os.path.join(path, source)
 727             if os.path.exists(zz):
 728                 source_full_path = zz
 729                 break
 730
 731         if len(source_full_path) == 0:
 732             raise src.SatException(_(
 733                         "Config file for product %s not found\n") % source)
 734         else:
 735             if len(args) > 0:
 736                 # a name is given as parameter, use it
 737                 dest = args[0]
 738             elif 'copy_prefix' in runner.cfg.SITE.config:
 739                 # use prefix
 740                 dest = (runner.cfg.SITE.config.copy_prefix
 741                         + runner.cfg.VARS.application)
 742             else:
 743                 # use same name as source
 744                 dest = runner.cfg.VARS.application
 745
 746             # the full path
 747             dest_file = os.path.join(runner.cfg.VARS.personalDir,
 748                                      'Applications', dest + '.pyconf')
 749             if os.path.exists(dest_file):
 750                 raise src.SatException(_("A personal application"
 751                                          " '%s' already exists") % dest)
 752
 753             # perform the copy
 754             shutil.copyfile(source_full_path, dest_file)
 755             logger.write(_("%s has been created.\n") % dest_file)
 756
 757     # case : display all the available pyconf applications
 758     elif options.list:
 759         lproduct = list()
 760         # search in all directories that can have pyconf applications
 761         for path in runner.cfg.SITE.config.config_path:
 762             # print a header
 763             if not options.no_label:
 764                 logger.write("------ %s\n" % src.printcolors.printcHeader(path))
 765
 766             if not os.path.exists(path):
 767                 logger.write(src.printcolors.printcError(_(
 768                                             "Directory not found")) + "\n")
 769             else:
 770                 for f in sorted(os.listdir(path)):
 771                     # ignore file that does not ends with .pyconf
 772                     if not f.endswith('.pyconf'):
 773                         continue
 774
 775                     appliname = f[:-len('.pyconf')]
 776                     if appliname not in lproduct:
 777                         lproduct.append(appliname)
 778                         if path.startswith(runner.cfg.VARS.personalDir) \
 779                                     and not options.no_label:
 780                             logger.write("%s*\n" % appliname)
 781                         else:
 782                             logger.write("%s\n" % appliname)
 783
 784             logger.write("\n")
 785
 786