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 _("print the value of CONFIG_VARIABLE."))
36 parser.add_option('e', 'edit', 'boolean', 'edit',
37 _("edit the product configuration file."))
38 parser.add_option('i', 'info', 'string', 'info',
39 _("get information on a product."))
40 parser.add_option('l', 'list', 'boolean', 'list',
41 _("list all available applications."))
42 parser.add_option('c', 'copy', 'boolean', 'copy',
43 _("""copy a config file to the personnal config files directory.
44 \tWARNING the included files are not copied.
45 \tIf a name is given the new config file takes the given name."""))
46 parser.add_option('n', 'no_label', 'boolean', 'no_label',
47 _("do not print labels, Works only with --value and --list."))
48 parser.add_option('s', 'schema', 'boolean', 'schema',
52 '''Class that helps to find an application pyconf
53 in all the possible directories (pathList)
55 def __init__(self, pathList):
58 :param pathList list: The list of paths where to serach a pyconf.
60 self.pathList = pathList
62 def __call__(self, name):
63 if os.path.isabs(name):
64 return src.pyconf.ConfigInputStream(open(name, 'rb'))
66 return src.pyconf.ConfigInputStream(
67 open(os.path.join( self.get_path(name), name ), 'rb') )
68 raise IOError(_("Configuration file '%s' not found") % name)
70 def get_path( self, name ):
71 '''The method that returns the entire path of the pyconf searched
72 :param name str: The name of the searched pyconf.
74 for path in self.pathList:
75 if os.path.exists(os.path.join(path, name)):
77 raise IOError(_("Configuration file '%s' not found") % name)
80 '''Class that manages the read of all the configuration files of salomeTools
82 def __init__(self, datadir=None):
85 def _create_vars(self, application=None, command=None, datadir=None):
86 '''Create a dictionary that stores all information about machine,
87 user, date, repositories, etc...
89 :param application str: The application for which salomeTools is called.
90 :param command str: The command that is called.
91 :param datadir str: The repository that contain external data
93 :return: The dictionary that stores all information.
97 var['user'] = src.architecture.get_user()
98 var['salometoolsway'] = os.path.dirname(
99 os.path.dirname(os.path.abspath(__file__)))
100 var['srcDir'] = os.path.join(var['salometoolsway'], 'src')
101 var['sep']= os.path.sep
103 # datadir has a default location
104 var['datadir'] = os.path.join(var['salometoolsway'], 'data')
105 if datadir is not None:
106 var['datadir'] = datadir
108 var['personalDir'] = os.path.join(os.path.expanduser('~'),
111 # read linux distributions dictionary
112 distrib_cfg = src.pyconf.Config(os.path.join(var['srcDir'],
116 # set platform parameters
117 dist_name = src.architecture.get_distribution(
118 codes=distrib_cfg.DISTRIBUTIONS)
119 dist_version = src.architecture.get_distrib_version(dist_name,
120 codes=distrib_cfg.VERSIONS)
121 dist = dist_name + dist_version
123 var['dist_name'] = dist_name
124 var['dist_version'] = dist_version
126 var['python'] = src.architecture.get_python_version()
128 var['nb_proc'] = src.architecture.get_nb_proc()
129 node_name = platform.node()
130 var['node'] = node_name
131 var['hostname'] = node_name
133 # set date parameters
134 dt = datetime.datetime.now()
135 var['date'] = dt.strftime('%Y%m%d')
136 var['datehour'] = dt.strftime('%Y%m%d_%H%M%S')
137 var['hour'] = dt.strftime('%H%M%S')
139 var['command'] = str(command)
140 var['application'] = str(application)
142 # Root dir for temporary files
143 var['tmp_root'] = os.sep + 'tmp' + os.sep + var['user']
144 # particular win case
145 if src.architecture.is_windows() :
146 var['tmp_root'] = os.path.expanduser('~') + os.sep + 'tmp'
150 def get_command_line_overrides(self, options, sections):
151 '''get all the overwrites that are in the command line
153 :param options: the options from salomeTools class
154 initialization (like -l5 or --overwrite)
155 :param sections str: The config section to overwrite.
156 :return: The list of all the overwrites to apply.
159 # when there are no options or not the overwrite option,
160 # return an empty list
161 if options is None or options.overwrite is None:
165 for section in sections:
166 # only overwrite the sections that correspond to the option
167 over.extend(filter(lambda l: l.startswith(section + "."),
171 def get_config(self, application=None, options=None, command=None,
173 '''get the config from all the configuration files.
175 :param application str: The application for which salomeTools is called.
176 :param options class Options: The general salomeToos
177 options (--overwrite or -l5, for example)
178 :param command str: The command that is called.
179 :param datadir str: The repository that contain
180 external data for salomeTools.
181 :return: The final config.
182 :rtype: class 'src.pyconf.Config'
185 # create a ConfigMerger to handle merge
186 merger = src.pyconf.ConfigMerger()#MergeHandler())
188 # create the configuration instance
189 cfg = src.pyconf.Config()
191 # =====================================================================
192 # create VARS section
193 var = self._create_vars(application=application, command=command,
196 cfg.VARS = src.pyconf.Mapping(cfg)
198 cfg.VARS[variable] = var[variable]
200 # apply overwrite from command line if needed
201 for rule in self.get_command_line_overrides(options, ["VARS"]):
202 exec('cfg.' + rule) # this cannot be factorized because of the exec
204 # =====================================================================
205 # Load INTERNAL config
206 # read src/internal_config/salomeTools.pyconf
207 src.pyconf.streamOpener = ConfigOpener([
208 os.path.join(cfg.VARS.srcDir, 'internal_config')])
210 internal_cfg = src.pyconf.Config(open(os.path.join(cfg.VARS.srcDir,
211 'internal_config', 'salomeTools.pyconf')))
212 except src.pyconf.ConfigError as e:
213 raise src.SatException(_("Error in configuration file:"
214 " salomeTools.pyconf\n %(error)s") % \
217 merger.merge(cfg, internal_cfg)
219 # apply overwrite from command line if needed
220 for rule in self.get_command_line_overrides(options, ["INTERNAL"]):
221 exec('cfg.' + rule) # this cannot be factorized because of the exec
223 # =====================================================================
224 # Load SITE config file
225 # search only in the data directory
226 src.pyconf.streamOpener = ConfigOpener([cfg.VARS.datadir])
228 site_cfg = src.pyconf.Config(open(os.path.join(cfg.VARS.datadir,
230 except src.pyconf.ConfigError as e:
231 raise src.SatException(_("Error in configuration file: "
232 "site.pyconf\n %(error)s") % \
234 except IOError as error:
236 if "site.pyconf" in e :
237 e += ("\nYou can copy data"
239 + "site.template.pyconf to data"
241 + "site.pyconf and edit the file")
242 raise src.SatException( e );
244 # add user local path for configPath
245 site_cfg.SITE.config.config_path.append(
246 os.path.join(cfg.VARS.personalDir, 'Applications'),
247 "User applications path")
249 merger.merge(cfg, site_cfg)
251 # apply overwrite from command line if needed
252 for rule in self.get_command_line_overrides(options, ["SITE"]):
253 exec('cfg.' + rule) # this cannot be factorized because of the exec
256 # =====================================================================
257 # Load APPLICATION config file
258 if application is not None:
259 # search APPLICATION file in all directories in configPath
260 cp = cfg.SITE.config.config_path
261 src.pyconf.streamOpener = ConfigOpener(cp)
263 application_cfg = src.pyconf.Config(application + '.pyconf')
265 raise src.SatException(_("%s, use 'config --list' to get the"
266 " list of available applications.") %e)
267 except src.pyconf.ConfigError as e:
268 raise src.SatException(_("Error in configuration file:"
269 " %(application)s.pyconf\n %(error)s") % \
270 { 'application': application, 'error': str(e) } )
272 merger.merge(cfg, application_cfg)
274 # apply overwrite from command line if needed
275 for rule in self.get_command_line_overrides(options,
277 # this cannot be factorized because of the exec
280 # default launcher name ('salome')
281 if ('profile' in cfg.APPLICATION and
282 'launcher_name' not in cfg.APPLICATION.profile):
283 cfg.APPLICATION.profile.launcher_name = 'salome'
285 # =====================================================================
286 # Load product config files in PRODUCTS section
288 # The directory containing the softwares definition
289 products_dir = os.path.join(cfg.VARS.datadir, 'products')
291 # Loop on all files that are in softsDir directory
292 # and read their config
293 for fName in os.listdir(products_dir):
294 if fName.endswith(".pyconf"):
295 src.pyconf.streamOpener = ConfigOpener([products_dir])
297 prod_cfg = src.pyconf.Config(open(
298 os.path.join(products_dir, fName)))
299 except src.pyconf.ConfigError as e:
300 raise src.SatException(_(
301 "Error in configuration file: %(prod)s\n %(error)s") % \
302 {'prod' : fName, 'error': str(e) })
303 except IOError as error:
305 raise src.SatException( e );
306 except Exception as e:
307 raise src.SatException(_(
308 "Error in configuration file: %(prod)s\n %(error)s") % \
309 {'prod' : fName, 'error': str(e) })
311 merger.merge(cfg.PRODUCTS, prod_cfg)
313 # apply overwrite from command line if needed
314 for rule in self.get_command_line_overrides(options, ["PRODUCTS"]):
315 exec('cfg.' + rule) # this cannot be factorized because of the exec
318 # =====================================================================
320 self.set_user_config_file(cfg)
321 user_cfg_file = self.get_user_config_file()
322 user_cfg = src.pyconf.Config(open(user_cfg_file))
323 merger.merge(cfg, user_cfg)
325 # apply overwrite from command line if needed
326 for rule in self.get_command_line_overrides(options, ["USER"]):
327 exec('cfg.' + rule) # this cannot be factorize because of the exec
331 def set_user_config_file(self, config):
332 '''Set the user config file name and path.
333 If necessary, build it from another one or create it from scratch.
335 :param config class 'src.pyconf.Config': The global config
336 (containing all pyconf).
338 # get the expected name and path of the file
339 self.config_file_name = 'salomeTools.pyconf'
340 self.user_config_file_path = os.path.join(config.VARS.personalDir,
341 self.config_file_name)
343 # if pyconf does not exist, create it from scratch
344 if not os.path.isfile(self.user_config_file_path):
345 self.create_config_file(config)
347 def create_config_file(self, config):
348 '''This method is called when there are no user config file.
349 It build it from scratch.
351 :param config class 'src.pyconf.Config': The global config.
352 :return: the config corresponding to the file created.
353 :rtype: config class 'src.pyconf.Config'
356 cfg_name = self.get_user_config_file()
358 user_cfg = src.pyconf.Config()
360 user_cfg.addMapping('USER', src.pyconf.Mapping(user_cfg), "")
363 user_cfg.USER.addMapping('workdir', os.path.expanduser('~'),
364 "This is where salomeTools will work. "
365 "You may (and probably do) change it.\n")
366 user_cfg.USER.addMapping('cvs_user', config.VARS.user,
367 "This is the user name used to access salome cvs base.\n")
368 user_cfg.USER.addMapping('svn_user', config.VARS.user,
369 "This is the user name used to access salome svn base.\n")
370 user_cfg.USER.addMapping('output_verbose_level', 3,
371 "This is the default output_verbose_level you want."
372 " 0=>no output, 5=>debug.\n")
373 user_cfg.USER.addMapping('publish_dir',
374 os.path.join(os.path.expanduser('~'),
378 user_cfg.USER.addMapping('editor',
380 "This is the editor used to "
381 "modify configuration files\n")
382 user_cfg.USER.addMapping('browser',
384 "This is the browser used to "
385 "read html documentation\n")
386 user_cfg.USER.addMapping('pdf_viewer',
388 "This is the pdf_viewer used "
389 "to read pdf documentation\n")
390 user_cfg.USER.addMapping("bases",
391 src.pyconf.Mapping(user_cfg.USER),
392 "The products installation base(s)\n")
394 user_cfg.USER.bases.base = src.pyconf.Reference(
397 'workdir + $VARS.sep + "BASE"')
399 src.ensure_path_exists(config.VARS.personalDir)
400 src.ensure_path_exists(os.path.join(config.VARS.personalDir,
403 f = open(cfg_name, 'w')
406 print(_("You can edit it to configure salomeTools "
407 "(use: sat config --edit).\n"))
411 def get_user_config_file(self):
412 '''Get the user config file
413 :return: path to the user config file.
416 if not self.user_config_file_path:
417 raise src.SatException(_("Error in get_user_config_file: "
418 "missing user config file path"))
419 return self.user_config_file_path
421 def check_path(path, ext=[]):
422 # check if file exists
423 if not os.path.exists(path):
424 return "'%s'" % path + " " + src.printcolors.printcError(_("** not found"))
428 fe = os.path.splitext(path)[1].lower()
430 return "'%s'" % path + " " + src.printcolors.printcError(_("** bad extension"))
434 def show_product_info(config, name, logger):
435 logger.write(_("%s is a product\n") % src.printcolors.printcLabel(name), 2)
436 pinfo = src.product.get_product_config(config, name)
438 ptype = src.get_cfg_param(pinfo, "type", "")
439 src.printcolors.print_value(logger, "type", ptype, 2)
440 if "opt_depend" in pinfo:
441 src.printcolors.print_value(logger, "depends on", ', '.join(pinfo.depend), 2)
443 if "opt_depend" in pinfo:
444 src.printcolors.print_value(logger, "optional", ', '.join(pinfo.opt_depend), 2)
446 # information on prepare
447 logger.write("\n", 2)
448 logger.write(src.printcolors.printcLabel("prepare:") + "\n", 2)
450 is_dev = src.product.product_is_dev(pinfo)
451 method = pinfo.get_source
454 src.printcolors.print_value(logger, "get method", method, 2)
457 src.printcolors.print_value(logger, "server", pinfo.cvs_info.server, 2)
458 src.printcolors.print_value(logger, "base module", pinfo.cvs_info.module_base, 2)
459 src.printcolors.print_value(logger, "source", pinfo.cvs_info.source, 2)
460 src.printcolors.print_value(logger, "tag", pinfo.cvs_info.tag, 2)
462 elif method == 'svn':
463 src.printcolors.print_value(logger, "repo", pinfo.svn_info.repo, 2)
465 elif method == 'git':
466 src.printcolors.print_value(logger, "repo", pinfo.git_info.repo, 2)
467 src.printcolors.print_value(logger, "tag", pinfo.git_info.tag, 2)
469 elif method == 'archive':
470 src.printcolors.print_value(logger, "get from", check_path(pinfo.archive_info.archive_name), 2)
472 if 'patches' in pinfo:
473 for patch in pinfo.patches:
474 src.printcolors.print_value(logger, "patch", check_path(patch), 2)
476 if src.product.product_is_fixed(pinfo):
477 src.printcolors.print_value(logger, "install_dir", check_path(pinfo.install_dir), 2)
479 if src.product.product_is_native(pinfo) or src.product.product_is_fixed(pinfo):
482 # information on compilation
483 logger.write("\n", 2)
484 logger.write(src.printcolors.printcLabel("compile:") + "\n", 2)
485 src.printcolors.print_value(logger, "compilation method", pinfo.build_source, 2)
487 if 'nb_proc' in pinfo:
488 src.printcolors.print_value(logger, "make -j", pinfo.nb_proc, 2)
490 src.printcolors.print_value(logger, "source dir", check_path(pinfo.source_dir), 2)
491 if 'install_dir' in pinfo:
492 src.printcolors.print_value(logger, "build dir", check_path(pinfo.build_dir), 2)
493 src.printcolors.print_value(logger, "install dir", check_path(pinfo.install_dir), 2)
495 logger.write(" " + src.printcolors.printcWarning(_("no install dir")) + "\n", 2)
497 # information on environment
498 logger.write("\n", 2)
499 logger.write(src.printcolors.printcLabel("environ :") + "\n", 2)
500 if "environ" in pinfo and "env_script" in pinfo.environ:
501 src.printcolors.print_value(logger, "script", check_path(pinfo.environ.env_script), 2)
503 zz = src.environment.SalomeEnviron(config, src.fileEnviron.ScreenEnviron(logger), False)
504 zz.set_python_libdirs()
505 zz.set_a_product(name, logger)
508 def print_value(config, path, show_label, logger, level=0, show_full_path=False):
509 '''Prints a value from the configuration. Prints recursively the values
510 under the initial path.
512 :param config class 'src.pyconf.Config': The configuration
513 from which the value is displayed.
514 :param path str : the path in the configuration of the value to print.
515 :param show_label boolean: if True, do a basic display.
516 (useful for bash completion)
517 :param logger Logger: the logger instance
518 :param level int: The number of spaces to add before display.
519 :param show_full_path :
522 # Make sure that the path does not ends with a point
523 if path.endswith('.'):
526 # display all the path or not
530 vname = path.split('.')[-1]
532 # number of spaces before the display
533 tab_level = " " * level
535 # call to the function that gets the value of the path.
537 val = config.getByPath(path)
538 except Exception as e:
539 logger.write(tab_level)
540 logger.write("%s: ERROR %s\n" % (src.printcolors.printcLabel(vname),
541 src.printcolors.printcError(str(e))))
544 # in this case, display only the value
546 logger.write(tab_level)
547 logger.write("%s: " % src.printcolors.printcLabel(vname))
549 # The case where the value has under values,
550 # do a recursive call to the function
551 if dir(val).__contains__('keys'):
552 if show_label: logger.write("\n")
553 for v in sorted(val.keys()):
554 print_value(config, path + '.' + v, show_label, logger, level + 1)
555 elif val.__class__ == src.pyconf.Sequence or isinstance(val, list):
556 # in this case, value is a list (or a Sequence)
557 if show_label: logger.write("\n")
560 print_value(config, path + "[" + str(index) + "]",
561 show_label, logger, level + 1)
563 else: # case where val is just a str
564 logger.write("%s\n" % val)
566 def get_config_children(config, args):
567 '''Gets the names of the children of the given parameter.
568 Useful only for completion mechanism
570 :param config Config: The configuration where to read the values
571 :param args: The path in the config from which get the keys
574 rootkeys = config.keys()
577 # no parameter returns list of root keys
581 pos = parent.rfind('.')
583 # Case where there is only on key as parameter.
585 vals = [m for m in rootkeys if m.startswith(parent)]
587 # Case where there is a part from a key
588 # for example VARS.us (for VARS.user)
590 tail = parent[pos+1:]
592 a = config.getByPath(head)
593 if dir(a).__contains__('keys'):
594 vals = map(lambda x: head + '.' + x,
595 [m for m in a.keys() if m.startswith(tail)])
599 for v in sorted(vals):
600 sys.stdout.write("%s\n" % v)
603 '''method that is called when salomeTools is called with --help option.
605 :return: The text to display for the config command description.
608 return _("The config command allows manipulation "
609 "and operation on config files.")
612 def run(args, runner, logger):
613 '''method that is called when salomeTools is called with config parameter.
616 (options, args) = parser.parse_args(args)
618 # Only useful for completion mechanism : print the keys of the config
620 get_config_children(runner.cfg, args)
623 # case : print a value of the config
625 if options.value == ".":
626 # if argument is ".", print all the config
627 for val in sorted(runner.cfg.keys()):
628 print_value(runner.cfg, val, not options.no_label, logger)
630 print_value(runner.cfg, options.value, not options.no_label, logger,
631 level=0, show_full_path=False)
633 # case : edit user pyconf file or application file
635 editor = runner.cfg.USER.editor
636 if 'APPLICATION' not in runner.cfg: # edit user pyconf
637 usercfg = os.path.join(runner.cfg.VARS.personalDir,
638 'salomeTools.pyconf')
639 src.system.show_in_editor(editor, usercfg, logger)
641 # search for file <application>.pyconf and open it
642 for path in runner.cfg.SITE.config.config_path:
643 pyconf_path = os.path.join(path,
644 runner.cfg.VARS.application + ".pyconf")
645 if os.path.exists(pyconf_path):
646 src.system.show_in_editor(editor, pyconf_path, logger)
649 # case : give information about the product in parameter
651 if options.info in runner.cfg.APPLICATION.products:
652 show_product_info(runner.cfg, options.info, logger)
654 raise src.SatException(_("%(product_name)s is not a product of %(application_name)s.") % {'product_name' : options.info, 'application_name' : runner.cfg.VARS.application})
656 # case : copy an existing <application>.pyconf
657 # to ~/.salomeTools/Applications/LOCAL_<application>.pyconf
659 # product is required
660 src.check_config_has_application( runner.cfg )
662 # get application file path
663 source = runner.cfg.VARS.application + '.pyconf'
664 source_full_path = ""
665 for path in runner.cfg.SITE.config.config_path:
666 # ignore personal directory
667 if path == runner.cfg.VARS.personalDir:
669 # loop on all directories that can have pyconf applications
670 zz = os.path.join(path, source)
671 if os.path.exists(zz):
672 source_full_path = zz
675 if len(source_full_path) == 0:
676 raise src.SatException(_(
677 "Config file for product %s not found\n") % source)
680 # a name is given as parameter, use it
682 elif 'copy_prefix' in runner.cfg.SITE.config:
684 dest = (runner.cfg.SITE.config.copy_prefix
685 + runner.cfg.VARS.application)
687 # use same name as source
688 dest = runner.cfg.VARS.application
691 dest_file = os.path.join(runner.cfg.VARS.personalDir,
692 'Applications', dest + '.pyconf')
693 if os.path.exists(dest_file):
694 raise src.SatException(_("A personal application"
695 " '%s' already exists") % dest)
698 shutil.copyfile(source_full_path, dest_file)
699 logger.write(_("%s has been created.\n") % dest_file)
701 # case : display all the available pyconf applications
704 # search in all directories that can have pyconf applications
705 for path in runner.cfg.SITE.config.config_path:
707 if not options.no_label:
708 logger.write("------ %s\n" % src.printcolors.printcHeader(path))
710 if not os.path.exists(path):
711 logger.write(src.printcolors.printcError(_(
712 "Directory not found")) + "\n")
714 for f in sorted(os.listdir(path)):
715 # ignore file that does not ends with .pyconf
716 if not f.endswith('.pyconf'):
719 appliname = f[:-len('.pyconf')]
720 if appliname not in lproduct:
721 lproduct.append(appliname)
722 if path.startswith(runner.cfg.VARS.personalDir) \
723 and not options.no_label:
724 logger.write("%s*\n" % appliname)
726 logger.write("%s\n" % appliname)