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