]> SALOME platform Git repositories - tools/sat.git/blob - commands/config.py
Salome HOME
bug fix
[tools/sat.git] / 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 = _("WARNING: 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                         prod_cfg = src.pyconf.Config(open(
363                                                     os.path.join(products_dir,
364                                                                  fName)),
365                                                      PWD=("", products_dir))
366                     except Exception as e:
367                         msg = _(
368                             "WARNING: Error in configuration file"
369                             ": %(prod)s\n  %(error)s" % \
370                             {'prod' :  fName, 'error': str(e) })
371                         sys.stdout.write(msg)
372                         continue
373                     
374                     products_cfg.PRODUCTS[pName] = prod_cfg
375         
376         merger.merge(cfg, products_cfg)
377         
378         # apply overwrite from command line if needed
379         for rule in self.get_command_line_overrides(options, ["PRODUCTS"]):
380             exec('cfg.' + rule) # this cannot be factorized because of the exec
381
382         # =====================================================================
383         # Load APPLICATION config file
384         if application is not None:
385             # search APPLICATION file in all directories in configPath
386             cp = cfg.PATHS.APPLICATIONPATH
387             src.pyconf.streamOpener = ConfigOpener(cp)
388             do_merge = True
389             try:
390                 application_cfg = src.pyconf.Config(application + '.pyconf')
391             except IOError as e:
392                 raise src.SatException(_("%s, use 'config --list' to get the"
393                                          " list of available applications.") %e)
394             except src.pyconf.ConfigError as e:
395                 if (not ('-e' in parser.parse_args()[1]) 
396                                          or ('--edit' in parser.parse_args()[1]) 
397                                          and command == 'config'):
398                     raise src.SatException(_("Error in configuration file: "
399                                              "%(application)s.pyconf\n "
400                                              " %(error)s") % \
401                         { 'application': application, 'error': str(e) } )
402                 else:
403                     sys.stdout.write(src.printcolors.printcWarning(
404                                         "There is an error in the file"
405                                         " %s.pyconf.\n" % cfg.VARS.application))
406                     do_merge = False
407             except Exception as e:
408                 if (not ('-e' in parser.parse_args()[1]) 
409                                         or ('--edit' in parser.parse_args()[1]) 
410                                         and command == 'config'):
411                     sys.stdout.write(src.printcolors.printcWarning("%s\n" % str(e)))
412                     raise src.SatException(_("Error in configuration file:"
413                                              " %(application)s.pyconf\n") % \
414                         { 'application': application} )
415                 else:
416                     sys.stdout.write(src.printcolors.printcWarning(
417                                 "There is an error in the file"
418                                 " %s.pyconf. Opening the file with the"
419                                 " default viewer\n" % cfg.VARS.application))
420                     sys.stdout.write("The error:"
421                                  " %s\n" % src.printcolors.printcWarning(
422                                                                       str(e)))
423                     do_merge = False
424
425             if do_merge:
426                 merger.merge(cfg, application_cfg)
427             
428                 # apply overwrite from command line if needed
429                 for rule in self.get_command_line_overrides(options,
430                                                              ["APPLICATION"]):
431                     # this cannot be factorized because of the exec
432                     exec('cfg.' + rule)
433                     
434                 # default launcher name ('salome')
435                 if ('profile' in cfg.APPLICATION and 
436                     'launcher_name' not in cfg.APPLICATION.profile):
437                     cfg.APPLICATION.profile.launcher_name = 'salome'
438         
439             else:
440                 cfg['open_application'] = 'yes'
441                 
442             
443         # =====================================================================
444         # load USER config
445         self.set_user_config_file(cfg)
446         user_cfg_file = self.get_user_config_file()
447         user_cfg = src.pyconf.Config(open(user_cfg_file))
448         merger.merge(cfg, user_cfg)
449
450         # apply overwrite from command line if needed
451         for rule in self.get_command_line_overrides(options, ["USER"]):
452             exec('cfg.' + rule) # this cannot be factorize because of the exec
453         
454         return cfg
455
456     def set_user_config_file(self, config):
457         '''Set the user config file name and path.
458         If necessary, build it from another one or create it from scratch.
459         
460         :param config class 'src.pyconf.Config': The global config 
461                                                  (containing all pyconf).
462         '''
463         # get the expected name and path of the file
464         self.config_file_name = 'salomeTools.pyconf'
465         self.user_config_file_path = os.path.join(config.VARS.personalDir,
466                                                    self.config_file_name)
467         
468         # if pyconf does not exist, create it from scratch
469         if not os.path.isfile(self.user_config_file_path): 
470             self.create_config_file(config)
471     
472     def create_config_file(self, config):
473         '''This method is called when there are no user config file. 
474            It build it from scratch.
475         
476         :param config class 'src.pyconf.Config': The global config.
477         :return: the config corresponding to the file created.
478         :rtype: config class 'src.pyconf.Config'
479         '''
480         
481         cfg_name = self.get_user_config_file()
482
483         user_cfg = src.pyconf.Config()
484         #
485         user_cfg.addMapping('USER', src.pyconf.Mapping(user_cfg), "")
486
487         #
488         user_cfg.USER.addMapping('workdir', os.path.expanduser('~'),
489             "This is where salomeTools will work. "
490             "You may (and probably do) change it.\n")
491         user_cfg.USER.addMapping('cvs_user', config.VARS.user,
492             "This is the user name used to access salome cvs base.\n")
493         user_cfg.USER.addMapping('svn_user', config.VARS.user,
494             "This is the user name used to access salome svn base.\n")
495         user_cfg.USER.addMapping('output_verbose_level', 3,
496             "This is the default output_verbose_level you want."
497             " 0=>no output, 5=>debug.\n")
498         user_cfg.USER.addMapping('publish_dir', 
499                                  os.path.join(os.path.expanduser('~'),
500                                  'websupport', 
501                                  'satreport'), 
502                                  "")
503         user_cfg.USER.addMapping('editor',
504                                  'vi', 
505                                  "This is the editor used to "
506                                  "modify configuration files\n")
507         user_cfg.USER.addMapping('browser', 
508                                  'firefox', 
509                                  "This is the browser used to "
510                                  "read html documentation\n")
511         user_cfg.USER.addMapping('pdf_viewer', 
512                                  'evince', 
513                                  "This is the pdf_viewer used "
514                                  "to read pdf documentation\n")
515         user_cfg.USER.addMapping("base",
516                                  src.pyconf.Reference(
517                                             user_cfg,
518                                             src.pyconf.DOLLAR,
519                                             'workdir  + $VARS.sep + "BASE"'),
520                                  "The products installation base (could be "
521                                  "ignored if this key exists in the site.pyconf"
522                                  " file of salomTools).\n")
523         
524         user_cfg.USER.addMapping("log_dir",
525                                  src.pyconf.Reference(
526                                             user_cfg,
527                                             src.pyconf.DOLLAR,
528                                             'workdir  + $VARS.sep + "LOGS"'),
529                                  "The log repository\n")
530         
531         # 
532         src.ensure_path_exists(config.VARS.personalDir)
533         src.ensure_path_exists(os.path.join(config.VARS.personalDir, 
534                                             'Applications'))
535
536         f = open(cfg_name, 'w')
537         user_cfg.__save__(f)
538         f.close()
539
540         return user_cfg   
541
542     def get_user_config_file(self):
543         '''Get the user config file
544         :return: path to the user config file.
545         :rtype: str
546         '''
547         if not self.user_config_file_path:
548             raise src.SatException(_("Error in get_user_config_file: "
549                                      "missing user config file path"))
550         return self.user_config_file_path     
551
552 def check_path(path, ext=[]):
553     '''Construct a text with the input path and "not found" if it does not
554        exist.
555     
556     :param path Str: the path to check.
557     :param ext List: An extension. Verify that the path extension 
558                      is in the list
559     :return: The string of the path with information
560     :rtype: Str
561     '''
562     # check if file exists
563     if not os.path.exists(path):
564         return "'%s'" % path + " " + src.printcolors.printcError(_(
565                                                             "** not found"))
566
567     # check extension
568     if len(ext) > 0:
569         fe = os.path.splitext(path)[1].lower()
570         if fe not in ext:
571             return "'%s'" % path + " " + src.printcolors.printcError(_(
572                                                         "** bad extension"))
573
574     return path
575
576 def show_product_info(config, name, logger):
577     '''Display on the terminal and logger information about a product.
578     
579     :param config Config: the global configuration.
580     :param name Str: The name of the product
581     :param logger Logger: The logger instance to use for the display
582     '''
583     
584     logger.write(_("%s is a product\n") % src.printcolors.printcLabel(name), 2)
585     pinfo = src.product.get_product_config(config, name)
586     
587     # Type of the product
588     ptype = src.get_cfg_param(pinfo, "type", "")
589     src.printcolors.print_value(logger, "type", ptype, 2)
590     if "depend" in pinfo:
591         src.printcolors.print_value(logger, 
592                                     "depends on", 
593                                     ', '.join(pinfo.depend), 2)
594
595     if "opt_depend" in pinfo:
596         src.printcolors.print_value(logger, 
597                                     "optional", 
598                                     ', '.join(pinfo.opt_depend), 2)
599
600     # information on prepare
601     logger.write("\n", 2)
602     logger.write(src.printcolors.printcLabel("prepare:") + "\n", 2)
603
604     is_dev = src.product.product_is_dev(pinfo)
605     method = pinfo.get_source
606     if is_dev:
607         method += " (dev)"
608     src.printcolors.print_value(logger, "get method", method, 2)
609
610     if method == 'cvs':
611         src.printcolors.print_value(logger, "server", pinfo.cvs_info.server, 2)
612         src.printcolors.print_value(logger, "base module",
613                                     pinfo.cvs_info.module_base, 2)
614         src.printcolors.print_value(logger, "source", pinfo.cvs_info.source, 2)
615         src.printcolors.print_value(logger, "tag", pinfo.cvs_info.tag, 2)
616
617     elif method == 'svn':
618         src.printcolors.print_value(logger, "repo", pinfo.svn_info.repo, 2)
619
620     elif method == 'git':
621         src.printcolors.print_value(logger, "repo", pinfo.git_info.repo, 2)
622         src.printcolors.print_value(logger, "tag", pinfo.git_info.tag, 2)
623
624     elif method == 'archive':
625         src.printcolors.print_value(logger, 
626                                     "get from", 
627                                     check_path(pinfo.archive_info.archive_name), 
628                                     2)
629
630     if 'patches' in pinfo:
631         for patch in pinfo.patches:
632             src.printcolors.print_value(logger, "patch", check_path(patch), 2)
633
634     if src.product.product_is_fixed(pinfo):
635         src.printcolors.print_value(logger, "install_dir", 
636                                     check_path(pinfo.install_dir), 2)
637
638     if src.product.product_is_native(pinfo) or src.product.product_is_fixed(pinfo):
639         return
640     
641     # information on compilation
642     if src.product.product_compiles(pinfo):
643         logger.write("\n", 2)
644         logger.write(src.printcolors.printcLabel("compile:") + "\n", 2)
645         src.printcolors.print_value(logger, 
646                                     "compilation method", 
647                                     pinfo.build_source, 
648                                     2)
649         
650         if pinfo.build_source == "script" and "compil_script" in pinfo:
651             src.printcolors.print_value(logger, 
652                                         "Compilation script", 
653                                         pinfo.compil_script, 
654                                         2)
655         
656         if 'nb_proc' in pinfo:
657             src.printcolors.print_value(logger, "make -j", pinfo.nb_proc, 2)
658     
659         src.printcolors.print_value(logger, 
660                                     "source dir", 
661                                     check_path(pinfo.source_dir), 
662                                     2)
663         if 'install_dir' in pinfo:
664             src.printcolors.print_value(logger, 
665                                         "build dir", 
666                                         check_path(pinfo.build_dir), 
667                                         2)
668             src.printcolors.print_value(logger, 
669                                         "install dir", 
670                                         check_path(pinfo.install_dir), 
671                                         2)
672         else:
673             logger.write("  " + 
674                          src.printcolors.printcWarning(_("no install dir")) + 
675                          "\n", 2)
676     else:
677         logger.write("\n", 2)
678         msg = _("This product does not compile")
679         logger.write("%s\n" % msg, 2)
680
681     # information on environment
682     logger.write("\n", 2)
683     logger.write(src.printcolors.printcLabel("environ :") + "\n", 2)
684     if "environ" in pinfo and "env_script" in pinfo.environ:
685         src.printcolors.print_value(logger, 
686                                     "script", 
687                                     check_path(pinfo.environ.env_script), 
688                                     2)
689
690     zz = src.environment.SalomeEnviron(config, 
691                                        src.fileEnviron.ScreenEnviron(logger), 
692                                        False)
693     zz.set_python_libdirs()
694     zz.set_a_product(name, logger)
695         
696 def show_patchs(config, logger):
697     '''Prints all the used patchs in the application.
698     
699     :param config Config: the global configuration.
700     :param logger Logger: The logger instance to use for the display
701     '''
702     len_max = max([len(p) for p in config.APPLICATION.products]) + 2
703     for product in config.APPLICATION.products:
704         product_info = src.product.get_product_config(config, product)
705         if src.product.product_has_patches(product_info):
706             logger.write("%s: " % product, 1)
707             logger.write(src.printcolors.printcInfo(
708                                             " " * (len_max - len(product) -2) +
709                                             "%s\n" % product_info.patches[0]),
710                          1)
711             if len(product_info.patches) > 1:
712                 for patch in product_info.patches[1:]:
713                     logger.write(src.printcolors.printcInfo(len_max*" " +
714                                                             "%s\n" % patch), 1)
715             logger.write("\n", 1)
716
717 def print_value(config, path, show_label, logger, level=0, show_full_path=False):
718     '''Prints a value from the configuration. Prints recursively the values 
719        under the initial path.
720     
721     :param config class 'src.pyconf.Config': The configuration 
722                                              from which the value is displayed.
723     :param path str : the path in the configuration of the value to print.
724     :param show_label boolean: if True, do a basic display. 
725                                (useful for bash completion)
726     :param logger Logger: the logger instance
727     :param level int: The number of spaces to add before display.
728     :param show_full_path :
729     '''            
730     
731     # Make sure that the path does not ends with a point
732     if path.endswith('.'):
733         path = path[:-1]
734     
735     # display all the path or not
736     if show_full_path:
737         vname = path
738     else:
739         vname = path.split('.')[-1]
740
741     # number of spaces before the display
742     tab_level = "  " * level
743     
744     # call to the function that gets the value of the path.
745     try:
746         val = config.getByPath(path)
747     except Exception as e:
748         logger.write(tab_level)
749         logger.write("%s: ERROR %s\n" % (src.printcolors.printcLabel(vname), 
750                                          src.printcolors.printcError(str(e))))
751         return
752
753     # in this case, display only the value
754     if show_label:
755         logger.write(tab_level)
756         logger.write("%s: " % src.printcolors.printcLabel(vname))
757
758     # The case where the value has under values, 
759     # do a recursive call to the function
760     if dir(val).__contains__('keys'):
761         if show_label: logger.write("\n")
762         for v in sorted(val.keys()):
763             print_value(config, path + '.' + v, show_label, logger, level + 1)
764     elif val.__class__ == src.pyconf.Sequence or isinstance(val, list): 
765         # in this case, value is a list (or a Sequence)
766         if show_label: logger.write("\n")
767         index = 0
768         for v in val:
769             print_value(config, path + "[" + str(index) + "]", 
770                         show_label, logger, level + 1)
771             index = index + 1
772     else: # case where val is just a str
773         logger.write("%s\n" % val)
774
775 def get_config_children(config, args):
776     '''Gets the names of the children of the given parameter.
777        Useful only for completion mechanism
778     
779     :param config Config: The configuration where to read the values
780     :param args: The path in the config from which get the keys
781     '''
782     vals = []
783     rootkeys = config.keys()
784     
785     if len(args) == 0:
786         # no parameter returns list of root keys
787         vals = rootkeys
788     else:
789         parent = args[0]
790         pos = parent.rfind('.')
791         if pos < 0:
792             # Case where there is only on key as parameter.
793             # For example VARS
794             vals = [m for m in rootkeys if m.startswith(parent)]
795         else:
796             # Case where there is a part from a key
797             # for example VARS.us  (for VARS.user)
798             head = parent[0:pos]
799             tail = parent[pos+1:]
800             try:
801                 a = config.getByPath(head)
802                 if dir(a).__contains__('keys'):
803                     vals = map(lambda x: head + '.' + x,
804                                [m for m in a.keys() if m.startswith(tail)])
805             except:
806                 pass
807
808     for v in sorted(vals):
809         sys.stdout.write("%s\n" % v)
810
811 def description():
812     '''method that is called when salomeTools is called with --help option.
813     
814     :return: The text to display for the config command description.
815     :rtype: str
816     '''
817     return _("The config command allows manipulation "
818              "and operation on config files.\n\nexample:\nsat config "
819              "SALOME-master --info ParaView")
820     
821
822 def run(args, runner, logger):
823     '''method that is called when salomeTools is called with config parameter.
824     '''
825     # Parse the options
826     (options, args) = parser.parse_args(args)
827
828     # Only useful for completion mechanism : print the keys of the config
829     if options.schema:
830         get_config_children(runner.cfg, args)
831         return
832     
833     # case : print a value of the config
834     if options.value:
835         if options.value == ".":
836             # if argument is ".", print all the config
837             for val in sorted(runner.cfg.keys()):
838                 print_value(runner.cfg, val, not options.no_label, logger)
839         else:
840             print_value(runner.cfg, options.value, not options.no_label, logger, 
841                         level=0, show_full_path=False)
842     
843     # case : edit user pyconf file or application file
844     elif options.edit:
845         editor = runner.cfg.USER.editor
846         if ('APPLICATION' not in runner.cfg and
847                        'open_application' not in runner.cfg): # edit user pyconf
848             usercfg = os.path.join(runner.cfg.VARS.personalDir, 
849                                    'salomeTools.pyconf')
850             logger.write(_("Openning %s\n" % usercfg), 3)
851             src.system.show_in_editor(editor, usercfg, logger)
852         else:
853             # search for file <application>.pyconf and open it
854             for path in runner.cfg.PATHS.APPLICATIONPATH:
855                 pyconf_path = os.path.join(path, 
856                                     runner.cfg.VARS.application + ".pyconf")
857                 if os.path.exists(pyconf_path):
858                     logger.write(_("Openning %s\n" % pyconf_path), 3)
859                     src.system.show_in_editor(editor, pyconf_path, logger)
860                     break
861     
862     # case : give information about the product in parameter
863     elif options.info:
864         src.check_config_has_application(runner.cfg)
865         if options.info in runner.cfg.APPLICATION.products:
866             show_product_info(runner.cfg, options.info, logger)
867             return
868         raise src.SatException(_("%(product_name)s is not a product "
869                                  "of %(application_name)s.") % 
870                                {'product_name' : options.info,
871                                 'application_name' : 
872                                 runner.cfg.VARS.application})
873     
874     # case : copy an existing <application>.pyconf 
875     # to ~/.salomeTools/Applications/LOCAL_<application>.pyconf
876     elif options.copy:
877         # product is required
878         src.check_config_has_application( runner.cfg )
879
880         # get application file path 
881         source = runner.cfg.VARS.application + '.pyconf'
882         source_full_path = ""
883         for path in runner.cfg.PATHS.APPLICATIONPATH:
884             # ignore personal directory
885             if path == runner.cfg.VARS.personalDir:
886                 continue
887             # loop on all directories that can have pyconf applications
888             zz = os.path.join(path, source)
889             if os.path.exists(zz):
890                 source_full_path = zz
891                 break
892
893         if len(source_full_path) == 0:
894             raise src.SatException(_(
895                         "Config file for product %s not found\n") % source)
896         else:
897             if len(args) > 0:
898                 # a name is given as parameter, use it
899                 dest = args[0]
900             elif 'copy_prefix' in runner.cfg.INTERNAL.config:
901                 # use prefix
902                 dest = (runner.cfg.INTERNAL.config.copy_prefix 
903                         + runner.cfg.VARS.application)
904             else:
905                 # use same name as source
906                 dest = runner.cfg.VARS.application
907                 
908             # the full path
909             dest_file = os.path.join(runner.cfg.VARS.personalDir, 
910                                      'Applications', dest + '.pyconf')
911             if os.path.exists(dest_file):
912                 raise src.SatException(_("A personal application"
913                                          " '%s' already exists") % dest)
914             
915             # perform the copy
916             shutil.copyfile(source_full_path, dest_file)
917             logger.write(_("%s has been created.\n") % dest_file)
918     
919     # case : display all the available pyconf applications
920     elif options.list:
921         lproduct = list()
922         # search in all directories that can have pyconf applications
923         for path in runner.cfg.PATHS.APPLICATIONPATH:
924             # print a header
925             if not options.no_label:
926                 logger.write("------ %s\n" % src.printcolors.printcHeader(path))
927
928             if not os.path.exists(path):
929                 logger.write(src.printcolors.printcError(_(
930                                             "Directory not found")) + "\n")
931             else:
932                 for f in sorted(os.listdir(path)):
933                     # ignore file that does not ends with .pyconf
934                     if not f.endswith('.pyconf'):
935                         continue
936
937                     appliname = f[:-len('.pyconf')]
938                     if appliname not in lproduct:
939                         lproduct.append(appliname)
940                         if path.startswith(runner.cfg.VARS.personalDir) \
941                                     and not options.no_label:
942                             logger.write("%s*\n" % appliname)
943                         else:
944                             logger.write("%s\n" % appliname)
945                             
946             logger.write("\n")
947     # case : give a synthetic view of all patches used in the application
948     elif options.show_patchs:
949         src.check_config_has_application(runner.cfg)
950         # Print some informations
951         logger.write(_('Show the patchs of application %s\n') % 
952                     src.printcolors.printcLabel(runner.cfg.VARS.application), 3)
953         logger.write("\n", 2, False)
954         show_patchs(runner.cfg, logger)
955         
956