3 # Copyright (C) 2010-2012 CEA/DEN
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.
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.
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
28 # internationalization
29 satdir = os.path.dirname(os.path.realpath(__file__))
30 gettext.install('salomeTools', os.path.join(satdir, 'src', 'i18n'))
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',
54 '''Class that helps to find an application pyconf
55 in all the possible directories (pathList)
57 def __init__(self, pathList):
60 :param pathList list: The list of paths where to search a pyconf.
62 self.pathList = pathList
64 def __call__(self, name):
65 if os.path.isabs(name):
66 return src.pyconf.ConfigInputStream(open(name, 'rb'))
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)
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.
76 for path in self.pathList:
77 if os.path.exists(os.path.join(path, name)):
79 raise IOError(_("Configuration file '%s' not found") % name)
82 '''Class that manages the read of all the configuration files of salomeTools
84 def __init__(self, datadir=None):
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...
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
95 :return: The dictionary that stores all information.
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
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
111 var['personalDir'] = os.path.join(os.path.expanduser('~'),
113 src.ensure_path_exists(var['personalDir'])
115 var['personal_applications_dir'] = os.path.join(var['personalDir'],
117 src.ensure_path_exists(var['personal_applications_dir'])
119 var['personal_products_dir'] = os.path.join(var['personalDir'],
121 src.ensure_path_exists(var['personal_products_dir'])
123 var['personal_archives_dir'] = os.path.join(var['personalDir'],
125 src.ensure_path_exists(var['personal_archives_dir'])
127 var['personal_jobs_dir'] = os.path.join(var['personalDir'],
129 src.ensure_path_exists(var['personal_jobs_dir'])
131 var['personal_machines_dir'] = os.path.join(var['personalDir'],
133 src.ensure_path_exists(var['personal_machines_dir'])
135 # read linux distributions dictionary
136 distrib_cfg = src.pyconf.Config(os.path.join(var['srcDir'],
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
147 var['dist_name'] = dist_name
148 var['dist_version'] = dist_version
150 var['python'] = src.architecture.get_python_version()
152 var['nb_proc'] = src.architecture.get_nb_proc()
153 node_name = platform.node()
154 var['node'] = node_name
155 var['hostname'] = node_name
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')
163 var['command'] = str(command)
164 var['application'] = str(application)
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'
174 def get_command_line_overrides(self, options, sections):
175 '''get all the overwrites that are in the command line
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.
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:
189 for section in sections:
190 # only overwrite the sections that correspond to the option
191 over.extend(filter(lambda l: l.startswith(section + "."),
195 def get_config(self, application=None, options=None, command=None,
197 '''get the config from all the configuration files.
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'
209 # create a ConfigMerger to handle merge
210 merger = src.pyconf.ConfigMerger()#MergeHandler())
212 # create the configuration instance
213 cfg = src.pyconf.Config()
215 # =====================================================================
216 # create VARS section
217 var = self._create_vars(application=application, command=command,
220 cfg.VARS = src.pyconf.Mapping(cfg)
222 cfg.VARS[variable] = var[variable]
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
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')])
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") % \
241 merger.merge(cfg, internal_cfg)
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
247 # =====================================================================
248 # Load SITE config file
249 # search only in the data directory
250 src.pyconf.streamOpener = ConfigOpener([cfg.VARS.datadir])
252 site_cfg = src.pyconf.Config(open(os.path.join(cfg.VARS.datadir,
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") % \
259 except IOError as error:
261 if "site.pyconf" in e :
262 e += ("\nYou can copy data"
264 + "site.template.pyconf to data"
266 + "site.pyconf and edit the file")
267 raise src.SatException( e );
268 merger.merge(cfg, site_cfg)
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
274 # =====================================================================
276 projects_cfg = src.pyconf.Config()
277 projects_cfg.addMapping("PROJECTS",
278 src.pyconf.Mapping(projects_cfg),
280 projects_cfg.PROJECTS.addMapping("projects",
281 src.pyconf.Mapping(cfg.PROJECTS),
282 "The projects definition\n")
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)
290 project_name = os.path.basename(
291 project_pyconf_path)[:-len(".pyconf")]
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)
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"] = \
309 merger.merge(cfg, projects_cfg)
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
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, "")
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",
338 if PATH not in cfg.PROJECTS.projects[project]:
340 cfg.PATHS[PATH].append(cfg.PROJECTS.projects[project][PATH], "")
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
346 # =====================================================================
347 # Load APPLICATION config file
348 if application is not None:
349 # search APPLICATION file in all directories in configPath
350 cp = cfg.PATHS.APPLICATIONPATH
351 src.pyconf.streamOpener = ConfigOpener(cp)
354 application_cfg = src.pyconf.Config(application + '.pyconf')
356 raise src.SatException(_("%s, use 'config --list' to get the"
357 " list of available applications.") %e)
358 except src.pyconf.ConfigError as e:
359 if (not ('-e' in parser.parse_args()[1])
360 or ('--edit' in parser.parse_args()[1])
361 and command == 'config'):
362 raise src.SatException(_("Error in configuration file: "
363 "%(application)s.pyconf\n "
365 { 'application': application, 'error': str(e) } )
367 sys.stdout.write(src.printcolors.printcWarning(
368 "There is an error in the file"
369 " %s.pyconf.\n" % cfg.VARS.application))
371 except Exception as e:
372 if (not ('-e' in parser.parse_args()[1])
373 or ('--edit' in parser.parse_args()[1])
374 and command == 'config'):
375 sys.stdout.write(src.printcolors.printcWarning("%s\n" % str(e)))
376 raise src.SatException(_("Error in configuration file:"
377 " %(application)s.pyconf\n") % \
378 { 'application': application} )
380 sys.stdout.write(src.printcolors.printcWarning(
381 "There is an error in the file"
382 " %s.pyconf. Opening the file with the"
383 " default viewer\n" % cfg.VARS.application))
384 sys.stdout.write("The error:"
385 " %s\n" % src.printcolors.printcWarning(
390 merger.merge(cfg, application_cfg)
392 # apply overwrite from command line if needed
393 for rule in self.get_command_line_overrides(options,
395 # this cannot be factorized because of the exec
398 # default launcher name ('salome')
399 if ('profile' in cfg.APPLICATION and
400 'launcher_name' not in cfg.APPLICATION.profile):
401 cfg.APPLICATION.profile.launcher_name = 'salome'
404 cfg['open_application'] = 'yes'
406 # =====================================================================
407 # Load product config files in PRODUCTS section
408 products_cfg = src.pyconf.Config()
409 products_cfg.addMapping("PRODUCTS",
410 src.pyconf.Mapping(products_cfg),
412 if application is not None:
413 src.pyconf.streamOpener = ConfigOpener(cfg.PATHS.PRODUCTPATH)
414 for product_name in cfg.APPLICATION.products.keys():
415 # Loop on all files that are in softsDir directory
416 # and read their config
417 product_file_name = product_name + ".pyconf"
418 product_file_path = src.find_file_in_lpath(product_file_name, cfg.PATHS.PRODUCTPATH)
419 if product_file_path:
420 products_dir = os.path.dirname(product_file_path)
422 prod_cfg = src.pyconf.Config(open(
423 os.path.join(products_dir,
425 PWD=("", products_dir))
426 products_cfg.PRODUCTS[product_name] = prod_cfg
427 except Exception as e:
429 "WARNING: Error in configuration file"
430 ": %(prod)s\n %(error)s" % \
431 {'prod' : product_name, 'error': str(e) })
432 sys.stdout.write(msg)
434 merger.merge(cfg, products_cfg)
436 # apply overwrite from command line if needed
437 for rule in self.get_command_line_overrides(options, ["PRODUCTS"]):
438 exec('cfg.' + rule) # this cannot be factorized because of the exec
440 # =====================================================================
442 self.set_user_config_file(cfg)
443 user_cfg_file = self.get_user_config_file()
444 user_cfg = src.pyconf.Config(open(user_cfg_file))
445 merger.merge(cfg, user_cfg)
447 # apply overwrite from command line if needed
448 for rule in self.get_command_line_overrides(options, ["USER"]):
449 exec('cfg.' + rule) # this cannot be factorize because of the exec
453 def set_user_config_file(self, config):
454 '''Set the user config file name and path.
455 If necessary, build it from another one or create it from scratch.
457 :param config class 'src.pyconf.Config': The global config
458 (containing all pyconf).
460 # get the expected name and path of the file
461 self.config_file_name = 'salomeTools.pyconf'
462 self.user_config_file_path = os.path.join(config.VARS.personalDir,
463 self.config_file_name)
465 # if pyconf does not exist, create it from scratch
466 if not os.path.isfile(self.user_config_file_path):
467 self.create_config_file(config)
469 def create_config_file(self, config):
470 '''This method is called when there are no user config file.
471 It build it from scratch.
473 :param config class 'src.pyconf.Config': The global config.
474 :return: the config corresponding to the file created.
475 :rtype: config class 'src.pyconf.Config'
478 cfg_name = self.get_user_config_file()
480 user_cfg = src.pyconf.Config()
482 user_cfg.addMapping('USER', src.pyconf.Mapping(user_cfg), "")
485 user_cfg.USER.addMapping('workdir', os.path.expanduser('~'),
486 "This is where salomeTools will work. "
487 "You may (and probably do) change it.\n")
488 user_cfg.USER.addMapping('cvs_user', config.VARS.user,
489 "This is the user name used to access salome cvs base.\n")
490 user_cfg.USER.addMapping('svn_user', config.VARS.user,
491 "This is the user name used to access salome svn base.\n")
492 user_cfg.USER.addMapping('output_verbose_level', 3,
493 "This is the default output_verbose_level you want."
494 " 0=>no output, 5=>debug.\n")
495 user_cfg.USER.addMapping('publish_dir',
496 os.path.join(os.path.expanduser('~'),
500 user_cfg.USER.addMapping('editor',
502 "This is the editor used to "
503 "modify configuration files\n")
504 user_cfg.USER.addMapping('browser',
506 "This is the browser used to "
507 "read html documentation\n")
508 user_cfg.USER.addMapping('pdf_viewer',
510 "This is the pdf_viewer used "
511 "to read pdf documentation\n")
512 user_cfg.USER.addMapping("base",
513 src.pyconf.Reference(
516 'workdir + $VARS.sep + "BASE"'),
517 "The products installation base (could be "
518 "ignored if this key exists in the site.pyconf"
519 " file of salomTools).\n")
521 user_cfg.USER.addMapping("log_dir",
522 src.pyconf.Reference(
525 'workdir + $VARS.sep + "LOGS"'),
526 "The log repository\n")
529 src.ensure_path_exists(config.VARS.personalDir)
530 src.ensure_path_exists(os.path.join(config.VARS.personalDir,
533 f = open(cfg_name, 'w')
539 def get_user_config_file(self):
540 '''Get the user config file
541 :return: path to the user config file.
544 if not self.user_config_file_path:
545 raise src.SatException(_("Error in get_user_config_file: "
546 "missing user config file path"))
547 return self.user_config_file_path
549 def check_path(path, ext=[]):
550 '''Construct a text with the input path and "not found" if it does not
553 :param path Str: the path to check.
554 :param ext List: An extension. Verify that the path extension
556 :return: The string of the path with information
559 # check if file exists
560 if not os.path.exists(path):
561 return "'%s'" % path + " " + src.printcolors.printcError(_(
566 fe = os.path.splitext(path)[1].lower()
568 return "'%s'" % path + " " + src.printcolors.printcError(_(
573 def show_product_info(config, name, logger):
574 '''Display on the terminal and logger information about a product.
576 :param config Config: the global configuration.
577 :param name Str: The name of the product
578 :param logger Logger: The logger instance to use for the display
581 logger.write(_("%s is a product\n") % src.printcolors.printcLabel(name), 2)
582 pinfo = src.product.get_product_config(config, name)
584 # Type of the product
585 ptype = src.get_cfg_param(pinfo, "type", "")
586 src.printcolors.print_value(logger, "type", ptype, 2)
587 if "depend" in pinfo:
588 src.printcolors.print_value(logger,
590 ', '.join(pinfo.depend), 2)
592 if "opt_depend" in pinfo:
593 src.printcolors.print_value(logger,
595 ', '.join(pinfo.opt_depend), 2)
597 # information on prepare
598 logger.write("\n", 2)
599 logger.write(src.printcolors.printcLabel("prepare:") + "\n", 2)
601 is_dev = src.product.product_is_dev(pinfo)
602 method = pinfo.get_source
605 src.printcolors.print_value(logger, "get method", method, 2)
608 src.printcolors.print_value(logger, "server", pinfo.cvs_info.server, 2)
609 src.printcolors.print_value(logger, "base module",
610 pinfo.cvs_info.module_base, 2)
611 src.printcolors.print_value(logger, "source", pinfo.cvs_info.source, 2)
612 src.printcolors.print_value(logger, "tag", pinfo.cvs_info.tag, 2)
614 elif method == 'svn':
615 src.printcolors.print_value(logger, "repo", pinfo.svn_info.repo, 2)
617 elif method == 'git':
618 src.printcolors.print_value(logger, "repo", pinfo.git_info.repo, 2)
619 src.printcolors.print_value(logger, "tag", pinfo.git_info.tag, 2)
621 elif method == 'archive':
622 src.printcolors.print_value(logger,
624 check_path(pinfo.archive_info.archive_name),
627 if 'patches' in pinfo:
628 for patch in pinfo.patches:
629 src.printcolors.print_value(logger, "patch", check_path(patch), 2)
631 if src.product.product_is_fixed(pinfo):
632 src.printcolors.print_value(logger, "install_dir",
633 check_path(pinfo.install_dir), 2)
635 if src.product.product_is_native(pinfo) or src.product.product_is_fixed(pinfo):
638 # information on compilation
639 if src.product.product_compiles(pinfo):
640 logger.write("\n", 2)
641 logger.write(src.printcolors.printcLabel("compile:") + "\n", 2)
642 src.printcolors.print_value(logger,
643 "compilation method",
647 if pinfo.build_source == "script" and "compil_script" in pinfo:
648 src.printcolors.print_value(logger,
649 "Compilation script",
653 if 'nb_proc' in pinfo:
654 src.printcolors.print_value(logger, "make -j", pinfo.nb_proc, 2)
656 src.printcolors.print_value(logger,
658 check_path(pinfo.source_dir),
660 if 'install_dir' in pinfo:
661 src.printcolors.print_value(logger,
663 check_path(pinfo.build_dir),
665 src.printcolors.print_value(logger,
667 check_path(pinfo.install_dir),
671 src.printcolors.printcWarning(_("no install dir")) +
674 logger.write("\n", 2)
675 msg = _("This product does not compile")
676 logger.write("%s\n" % msg, 2)
678 # information on environment
679 logger.write("\n", 2)
680 logger.write(src.printcolors.printcLabel("environ :") + "\n", 2)
681 if "environ" in pinfo and "env_script" in pinfo.environ:
682 src.printcolors.print_value(logger,
684 check_path(pinfo.environ.env_script),
687 zz = src.environment.SalomeEnviron(config,
688 src.fileEnviron.ScreenEnviron(logger),
690 zz.set_python_libdirs()
691 zz.set_a_product(name, logger)
693 def show_patchs(config, logger):
694 '''Prints all the used patchs in the application.
696 :param config Config: the global configuration.
697 :param logger Logger: The logger instance to use for the display
699 len_max = max([len(p) for p in config.APPLICATION.products]) + 2
700 for product in config.APPLICATION.products:
701 product_info = src.product.get_product_config(config, product)
702 if src.product.product_has_patches(product_info):
703 logger.write("%s: " % product, 1)
704 logger.write(src.printcolors.printcInfo(
705 " " * (len_max - len(product) -2) +
706 "%s\n" % product_info.patches[0]),
708 if len(product_info.patches) > 1:
709 for patch in product_info.patches[1:]:
710 logger.write(src.printcolors.printcInfo(len_max*" " +
712 logger.write("\n", 1)
714 def print_value(config, path, show_label, logger, level=0, show_full_path=False):
715 '''Prints a value from the configuration. Prints recursively the values
716 under the initial path.
718 :param config class 'src.pyconf.Config': The configuration
719 from which the value is displayed.
720 :param path str : the path in the configuration of the value to print.
721 :param show_label boolean: if True, do a basic display.
722 (useful for bash completion)
723 :param logger Logger: the logger instance
724 :param level int: The number of spaces to add before display.
725 :param show_full_path :
728 # Make sure that the path does not ends with a point
729 if path.endswith('.'):
732 # display all the path or not
736 vname = path.split('.')[-1]
738 # number of spaces before the display
739 tab_level = " " * level
741 # call to the function that gets the value of the path.
743 val = config.getByPath(path)
744 except Exception as e:
745 logger.write(tab_level)
746 logger.write("%s: ERROR %s\n" % (src.printcolors.printcLabel(vname),
747 src.printcolors.printcError(str(e))))
750 # in this case, display only the value
752 logger.write(tab_level)
753 logger.write("%s: " % src.printcolors.printcLabel(vname))
755 # The case where the value has under values,
756 # do a recursive call to the function
757 if dir(val).__contains__('keys'):
758 if show_label: logger.write("\n")
759 for v in sorted(val.keys()):
760 print_value(config, path + '.' + v, show_label, logger, level + 1)
761 elif val.__class__ == src.pyconf.Sequence or isinstance(val, list):
762 # in this case, value is a list (or a Sequence)
763 if show_label: logger.write("\n")
766 print_value(config, path + "[" + str(index) + "]",
767 show_label, logger, level + 1)
769 else: # case where val is just a str
770 logger.write("%s\n" % val)
772 def get_config_children(config, args):
773 '''Gets the names of the children of the given parameter.
774 Useful only for completion mechanism
776 :param config Config: The configuration where to read the values
777 :param args: The path in the config from which get the keys
780 rootkeys = config.keys()
783 # no parameter returns list of root keys
787 pos = parent.rfind('.')
789 # Case where there is only on key as parameter.
791 vals = [m for m in rootkeys if m.startswith(parent)]
793 # Case where there is a part from a key
794 # for example VARS.us (for VARS.user)
796 tail = parent[pos+1:]
798 a = config.getByPath(head)
799 if dir(a).__contains__('keys'):
800 vals = map(lambda x: head + '.' + x,
801 [m for m in a.keys() if m.startswith(tail)])
805 for v in sorted(vals):
806 sys.stdout.write("%s\n" % v)
809 '''method that is called when salomeTools is called with --help option.
811 :return: The text to display for the config command description.
814 return _("The config command allows manipulation "
815 "and operation on config files.\n\nexample:\nsat config "
816 "SALOME-master --info ParaView")
819 def run(args, runner, logger):
820 '''method that is called when salomeTools is called with config parameter.
823 (options, args) = parser.parse_args(args)
825 # Only useful for completion mechanism : print the keys of the config
827 get_config_children(runner.cfg, args)
830 # case : print a value of the config
832 if options.value == ".":
833 # if argument is ".", print all the config
834 for val in sorted(runner.cfg.keys()):
835 print_value(runner.cfg, val, not options.no_label, logger)
837 print_value(runner.cfg, options.value, not options.no_label, logger,
838 level=0, show_full_path=False)
840 # case : edit user pyconf file or application file
842 editor = runner.cfg.USER.editor
843 if ('APPLICATION' not in runner.cfg and
844 'open_application' not in runner.cfg): # edit user pyconf
845 usercfg = os.path.join(runner.cfg.VARS.personalDir,
846 'salomeTools.pyconf')
847 logger.write(_("Openning %s\n" % usercfg), 3)
848 src.system.show_in_editor(editor, usercfg, logger)
850 # search for file <application>.pyconf and open it
851 for path in runner.cfg.PATHS.APPLICATIONPATH:
852 pyconf_path = os.path.join(path,
853 runner.cfg.VARS.application + ".pyconf")
854 if os.path.exists(pyconf_path):
855 logger.write(_("Openning %s\n" % pyconf_path), 3)
856 src.system.show_in_editor(editor, pyconf_path, logger)
859 # case : give information about the product in parameter
861 src.check_config_has_application(runner.cfg)
862 if options.info in runner.cfg.APPLICATION.products:
863 show_product_info(runner.cfg, options.info, logger)
865 raise src.SatException(_("%(product_name)s is not a product "
866 "of %(application_name)s.") %
867 {'product_name' : options.info,
869 runner.cfg.VARS.application})
871 # case : copy an existing <application>.pyconf
872 # to ~/.salomeTools/Applications/LOCAL_<application>.pyconf
874 # product is required
875 src.check_config_has_application( runner.cfg )
877 # get application file path
878 source = runner.cfg.VARS.application + '.pyconf'
879 source_full_path = ""
880 for path in runner.cfg.PATHS.APPLICATIONPATH:
881 # ignore personal directory
882 if path == runner.cfg.VARS.personalDir:
884 # loop on all directories that can have pyconf applications
885 zz = os.path.join(path, source)
886 if os.path.exists(zz):
887 source_full_path = zz
890 if len(source_full_path) == 0:
891 raise src.SatException(_(
892 "Config file for product %s not found\n") % source)
895 # a name is given as parameter, use it
897 elif 'copy_prefix' in runner.cfg.INTERNAL.config:
899 dest = (runner.cfg.INTERNAL.config.copy_prefix
900 + runner.cfg.VARS.application)
902 # use same name as source
903 dest = runner.cfg.VARS.application
906 dest_file = os.path.join(runner.cfg.VARS.personalDir,
907 'Applications', dest + '.pyconf')
908 if os.path.exists(dest_file):
909 raise src.SatException(_("A personal application"
910 " '%s' already exists") % dest)
913 shutil.copyfile(source_full_path, dest_file)
914 logger.write(_("%s has been created.\n") % dest_file)
916 # case : display all the available pyconf applications
919 # search in all directories that can have pyconf applications
920 for path in runner.cfg.PATHS.APPLICATIONPATH:
922 if not options.no_label:
923 logger.write("------ %s\n" % src.printcolors.printcHeader(path))
925 if not os.path.exists(path):
926 logger.write(src.printcolors.printcError(_(
927 "Directory not found")) + "\n")
929 for f in sorted(os.listdir(path)):
930 # ignore file that does not ends with .pyconf
931 if not f.endswith('.pyconf'):
934 appliname = f[:-len('.pyconf')]
935 if appliname not in lproduct:
936 lproduct.append(appliname)
937 if path.startswith(runner.cfg.VARS.personalDir) \
938 and not options.no_label:
939 logger.write("%s*\n" % appliname)
941 logger.write("%s\n" % appliname)
944 # case : give a synthetic view of all patches used in the application
945 elif options.show_patchs:
946 src.check_config_has_application(runner.cfg)
947 # Print some informations
948 logger.write(_('Show the patchs of application %s\n') %
949 src.printcolors.printcLabel(runner.cfg.VARS.application), 3)
950 logger.write("\n", 2, False)
951 show_patchs(runner.cfg, logger)