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
27 # internationalization
28 satdir = os.path.dirname(os.path.realpath(__file__))
29 gettext.install('salomeTools', os.path.join(satdir, 'src', 'i18n'))
31 # Define all possible option for config command : sat config <options>
32 parser = src.options.Options()
33 parser.add_option('v', 'value', 'string', 'value', _("print the value of CONFIG_VARIABLE."))
34 parser.add_option('e', 'edit', 'boolean', 'edit', _("edit the product configuration file."))
35 parser.add_option('l', 'list', 'boolean', 'list',_("list all available applications."))
36 parser.add_option('c', 'copy', 'boolean', 'copy',
37 _("""copy a config file to the personnal config files directory.
38 \tWARNING the included files are not copied.
39 \tIf a name is given the new config file takes the given name."""))
42 ''' Class that helps to find an application pyconf in all the possible directories (pathList)
44 def __init__(self, pathList):
47 :param pathList list: The list of paths where to serach a pyconf.
49 self.pathList = pathList
51 def __call__(self, name):
52 if os.path.isabs(name):
53 return src.pyconf.ConfigInputStream(open(name, 'rb'))
55 return src.pyconf.ConfigInputStream( open(os.path.join( self.get_path(name), name ), 'rb') )
56 raise IOError(_("Configuration file '%s' not found") % name)
58 def get_path( self, name ):
59 '''The method that returns the entire path of the pyconf searched
60 :param name str: The name of the searched pyconf.
62 for path in self.pathList:
63 if os.path.exists(os.path.join(path, name)):
65 raise IOError(_("Configuration file '%s' not found") % name)
68 '''Class that manages the read of all the configuration files of salomeTools
70 def __init__(self, dataDir=None):
73 def _create_vars(self, application=None, command=None, dataDir=None):
74 '''Create a dictionary that stores all information about machine, user, date, repositories, etc...
76 :param application str: The application for which salomeTools is called.
77 :param command str: The command that is called.
78 :param dataDir str: The repository that contain external data for salomeTools.
79 :return: The dictionary that stores all information.
83 var['user'] = src.architecture.get_user()
84 var['salometoolsway'] = os.path.dirname(os.path.dirname(os.path.abspath(__file__)))
85 var['srcDir'] = os.path.join(var['salometoolsway'], 'src')
86 var['sep']= os.path.sep
88 # dataDir has a default location
89 var['dataDir'] = os.path.join(var['salometoolsway'], 'data')
90 if dataDir is not None:
91 var['dataDir'] = dataDir
93 var['personalDir'] = os.path.join(os.path.expanduser('~'), '.salomeTools')
95 # read linux distributions dictionary
96 distrib_cfg = src.pyconf.Config(os.path.join(var['srcDir'], 'internal_config', 'distrib.pyconf'))
98 # set platform parameters
99 dist_name = src.architecture.get_distribution(codes=distrib_cfg.DISTRIBUTIONS)
100 dist_version = src.architecture.get_distrib_version(dist_name, codes=distrib_cfg.VERSIONS)
101 dist = dist_name + dist_version
103 var['dist_name'] = dist_name
104 var['dist_version'] = dist_version
106 var['python'] = src.architecture.get_python_version()
108 var['nb_proc'] = src.architecture.get_nb_proc()
109 node_name = platform.node()
110 var['node'] = node_name
111 var['hostname'] = node_name
113 # set date parameters
114 dt = datetime.datetime.now()
115 var['date'] = dt.strftime('%Y%m%d')
116 var['datehour'] = dt.strftime('%Y%m%d_%H%M%S')
117 var['hour'] = dt.strftime('%H%M%S')
119 var['command'] = str(command)
120 var['application'] = str(application)
122 # Root dir for temporary files
123 var['tmp_root'] = os.sep + 'tmp' + os.sep + var['user']
124 # particular win case
125 if src.architecture.is_windows() :
126 var['tmp_root'] = os.path.expanduser('~') + os.sep + 'tmp'
130 def get_command_line_overrides(self, options, sections):
131 '''get all the overwrites that are in the command line
133 :param options: the options from salomeTools class initialization (like -l5 or --overwrite)
134 :param sections str: The config section to overwrite.
135 :return: The list of all the overwrites to apply.
138 # when there are no options or not the overwrite option, return an empty list
139 if options is None or options.overwrite is None:
143 for section in sections:
144 # only overwrite the sections that correspond to the option
145 over.extend(filter(lambda l: l.startswith(section + "."), options.overwrite))
148 def get_config(self, application=None, options=None, command=None, dataDir=None):
149 '''get the config from all the configuration files.
151 :param application str: The application for which salomeTools is called.
152 :param options calss Options: The general salomeToosl options (--overwrite or -l5, for example)
153 :param command str: The command that is called.
154 :param dataDir str: The repository that contain external data for salomeTools.
155 :return: The final config.
156 :rtype: class 'src.pyconf.Config'
159 # create a ConfigMerger to handle merge
160 merger = src.pyconf.ConfigMerger()#MergeHandler())
162 # create the configuration instance
163 cfg = src.pyconf.Config()
165 # =======================================================================================
166 # create VARS section
167 var = self._create_vars(application=application, command=command, dataDir=dataDir)
169 cfg.VARS = src.pyconf.Mapping(cfg)
171 cfg.VARS[variable] = var[variable]
173 # apply overwrite from command line if needed
174 for rule in self.get_command_line_overrides(options, ["VARS"]):
175 exec('cfg.' + rule) # this cannot be factorized because of the exec
177 # =======================================================================================
178 # Load INTERNAL config
179 # read src/internal_config/salomeTools.pyconf
180 src.pyconf.streamOpener = ConfigOpener([os.path.join(cfg.VARS.srcDir, 'internal_config')])
182 internal_cfg = src.pyconf.Config(open(os.path.join(cfg.VARS.srcDir, 'internal_config', 'salomeTools.pyconf')))
183 except src.pyconf.ConfigError as e:
184 raise src.SatException(_("Error in configuration file: salomeTools.pyconf\n %(error)s") % \
187 merger.merge(cfg, internal_cfg)
189 # apply overwrite from command line if needed
190 for rule in self.get_command_line_overrides(options, ["INTERNAL"]):
191 exec('cfg.' + rule) # this cannot be factorized because of the exec
193 # =======================================================================================
194 # Load SITE config file
195 # search only in the data directory
196 src.pyconf.streamOpener = ConfigOpener([cfg.VARS.dataDir])
198 site_cfg = src.pyconf.Config(open(os.path.join(cfg.VARS.dataDir, 'site.pyconf')))
199 except src.pyconf.ConfigError as e:
200 raise src.SatException(_("Error in configuration file: site.pyconf\n %(error)s") % \
202 except IOError as error:
204 if "site.pyconf" in e :
205 e += "\nYou can copy data" + cfg.VARS.sep + "site.template.pyconf to data" + cfg.VARS.sep + "site.pyconf and edit the file"
206 raise src.SatException( e );
208 # add user local path for configPath
209 site_cfg.SITE.config.configPath.append(os.path.join(cfg.VARS.personalDir, 'Applications'), "User applications path")
211 merger.merge(cfg, site_cfg)
213 # apply overwrite from command line if needed
214 for rule in self.get_command_line_overrides(options, ["SITE"]):
215 exec('cfg.' + rule) # this cannot be factorized because of the exec
218 # =======================================================================================
219 # Load APPLICATION config file
220 if application is not None:
221 # search APPLICATION file in all directories in configPath
222 cp = cfg.SITE.config.configPath
223 src.pyconf.streamOpener = ConfigOpener(cp)
225 application_cfg = src.pyconf.Config(application + '.pyconf')
227 raise src.SatException(_("%s, use 'config --list' to get the list of available applications.") %e)
228 except src.pyconf.ConfigError as e:
229 raise src.SatException(_("Error in configuration file: %(application)s.pyconf\n %(error)s") % \
230 { 'application': application, 'error': str(e) } )
232 merger.merge(cfg, application_cfg)
234 # apply overwrite from command line if needed
235 for rule in self.get_command_line_overrides(options, ["APPLICATION"]):
236 exec('cfg.' + rule) # this cannot be factorized because of the exec
238 # =======================================================================================
239 # Load softwares config files in SOFTWARE section
241 # The directory containing the softwares definition
242 softsDir = os.path.join(cfg.VARS.dataDir, 'softwares')
244 # Loop on all files that are in softsDir directory and read their config
245 for fName in os.listdir(softsDir):
246 if fName.endswith(".pyconf"):
247 src.pyconf.streamOpener = ConfigOpener([softsDir])
249 soft_cfg = src.pyconf.Config(open(os.path.join(softsDir, fName)))
250 except src.pyconf.ConfigError as e:
251 raise src.SatException(_("Error in configuration file: %(soft)s\n %(error)s") % \
252 {'soft' : fName, 'error': str(e) })
253 except IOError as error:
255 raise src.SatException( e );
257 merger.merge(cfg, soft_cfg)
259 # apply overwrite from command line if needed
260 for rule in self.get_command_line_overrides(options, ["SOFTWARE"]):
261 exec('cfg.' + rule) # this cannot be factorized because of the exec
264 # =======================================================================================
266 self.set_user_config_file(cfg)
267 user_cfg_file = self.get_user_config_file()
268 user_cfg = src.pyconf.Config(open(user_cfg_file))
269 merger.merge(cfg, user_cfg)
271 # apply overwrite from command line if needed
272 for rule in self.get_command_line_overrides(options, ["USER"]):
273 exec('cfg.' + rule) # this cannot be factorize because of the exec
277 def set_user_config_file(self, config):
278 '''Set the user config file name and path.
279 If necessary, build it from another one or create it from scratch.
281 :param config class 'src.pyconf.Config': The global config (containing all pyconf).
283 # get the expected name and path of the file
284 self.config_file_name = 'salomeTools.pyconf'
285 self.user_config_file_path = os.path.join(config.VARS.personalDir, self.config_file_name)
287 # if pyconf does not exist, create it from scratch
288 if not os.path.isfile(self.user_config_file_path):
289 self.create_config_file(config)
291 def create_config_file(self, config):
292 '''This method is called when there are no user config file. It build it from scratch.
294 :param config class 'src.pyconf.Config': The global config.
295 :return: the config corresponding to the file created.
296 :rtype: config class 'src.pyconf.Config'
299 cfg_name = self.get_user_config_file()
301 user_cfg = src.pyconf.Config()
303 user_cfg.addMapping('USER', src.pyconf.Mapping(user_cfg), "")
306 user_cfg.USER.addMapping('workDir', os.path.expanduser('~'),
307 "This is where salomeTools will work. You may (and probably do) change it.\n")
308 user_cfg.USER.addMapping('cvs_user', config.VARS.user,
309 "This is the user name used to access salome cvs base.\n")
310 user_cfg.USER.addMapping('svn_user', config.VARS.user,
311 "This is the user name used to access salome svn base.\n")
312 user_cfg.USER.addMapping('output_level', 3,
313 "This is the default output_level you want. 0=>no output, 5=>debug.\n")
314 user_cfg.USER.addMapping('publish_dir', os.path.join(os.path.expanduser('~'), 'websupport', 'satreport'), "")
315 user_cfg.USER.addMapping('editor', 'vi', "This is the editor used to modify configuration files\n")
316 user_cfg.USER.addMapping('browser', 'firefox', "This is the browser used to read html documentation\n")
317 user_cfg.USER.addMapping('pdf_viewer', 'evince', "This is the pdf_viewer used to read pdf documentation\n")
319 src.ensure_path_exists(config.VARS.personalDir)
320 src.ensure_path_exists(os.path.join(config.VARS.personalDir, 'Applications'))
322 f = open(cfg_name, 'w')
325 print(_("You can edit it to configure salomeTools (use: sat config --edit).\n"))
329 def get_user_config_file(self):
330 '''Get the user config file
331 :return: path to the user config file.
334 if not self.user_config_file_path:
335 raise src.SatException(_("Error in get_user_config_file: missing user config file path"))
336 return self.user_config_file_path
339 def print_value(config, path, show_label, logger, level=0, show_full_path=False):
340 '''Prints a value from the configuration. Prints recursively the values under the initial path.
342 :param config class 'src.pyconf.Config': The configuration from which the value is displayed.
343 :param path str : the path in the configuration of the value to print.
344 :param show_label boolean: if True, do a basic display. (useful for bash completion)
345 :param logger Logger: the logger instance
346 :param level int: The number of spaces to add before display.
347 :param show_full_path :
350 # display all the path or not
354 vname = path.split('.')[-1]
356 # number of spaces before the display
357 tab_level = " " * level
359 # call to the function that gets the value of the path.
361 val = config.getByPath(path)
362 except Exception as e:
363 logger.write(tab_level)
364 logger.write("%s: ERROR %s\n" % (src.printcolors.printcLabel(vname), src.printcolors.printcError(str(e))))
367 # in this case, display only the value
369 logger.write(tab_level)
370 logger.write("%s: " % src.printcolors.printcLabel(vname))
372 # The case where the value has under values, do a recursive call to the function
373 if dir(val).__contains__('keys'):
374 if show_label: logger.write("\n")
375 for v in sorted(val.keys()):
376 print_value(config, path + '.' + v, show_label, logger, level + 1)
377 elif val.__class__ == src.pyconf.Sequence or isinstance(val, list): # in this case, value is a list (or a Sequence)
378 if show_label: logger.write("\n")
381 print_value(config, path + "[" + str(index) + "]", show_label, logger, level + 1)
383 else: # case where val is just a str
384 logger.write("%s\n" % val)
387 '''method that is called when salomeTools is called with --help option.
389 :return: The text to display for the config command description.
392 return _("The config command allows manipulation and operation on config files.")
395 def run(args, runner, logger):
396 '''method that is called when salomeTools is called with config parameter.
399 (options, args) = parser.parse_args(args)
401 # case : print a value of the config
403 if options.value == ".":
404 # if argument is ".", print all the config
405 for val in sorted(runner.cfg.keys()):
406 print_value(runner.cfg, val, True, logger)
408 print_value(runner.cfg, options.value, True, logger, level=0, show_full_path=False)
410 # case : edit user pyconf file or application file
412 editor = runner.cfg.USER.editor
413 if 'APPLICATION' not in runner.cfg: # edit user pyconf
414 usercfg = os.path.join(runner.cfg.VARS.personalDir, 'salomeTools.pyconf')
415 src.system.show_in_editor(editor, usercfg, logger)
417 # search for file <application>.pyconf and open it
418 for path in runner.cfg.SITE.config.configPath:
419 pyconf_path = os.path.join(path, runner.cfg.VARS.application + ".pyconf")
420 if os.path.exists(pyconf_path):
421 src.system.show_in_editor(editor, pyconf_path, logger)
424 # case : copy an existing <application>.pyconf to ~/.salomeTools/Applications/LOCAL_<application>.pyconf
426 # product is required
427 src.check_config_has_application( runner.cfg )
429 # get application file path
430 source = runner.cfg.VARS.application + '.pyconf'
431 source_full_path = ""
432 for path in runner.cfg.SITE.config.configPath:
433 # ignore personal directory
434 if path == runner.cfg.VARS.personalDir:
436 # loop on all directories that can have pyconf applications
437 zz = os.path.join(path, source)
438 if os.path.exists(zz):
439 source_full_path = zz
442 if len(source_full_path) == 0:
443 raise src.SatException(_("Config file for product %s not found\n") % source)
446 # a name is given as parameter, use it
448 elif 'copy_prefix' in runner.cfg.SITE.config:
450 dest = runner.cfg.SITE.config.copy_prefix + runner.cfg.VARS.application
452 # use same name as source
453 dest = runner.cfg.VARS.application
456 dest_file = os.path.join(runner.cfg.VARS.personalDir, 'Applications', dest + '.pyconf')
457 if os.path.exists(dest_file):
458 raise src.SatException(_("A personal application '%s' already exists") % dest)
461 shutil.copyfile(source_full_path, dest_file)
462 logger.write(_("%s has been created.\n") % dest_file)
464 # case : display all the available pyconf applications
467 # search in all directories that can have pyconf applications
468 for path in runner.cfg.SITE.config.configPath:
470 logger.write("------ %s\n" % src.printcolors.printcHeader(path))
472 if not os.path.exists(path):
473 logger.write(src.printcolors.printcError(_("Directory not found")) + "\n")
475 for f in sorted(os.listdir(path)):
476 # ignore file that does not ends with .pyconf
477 if not f.endswith('.pyconf'):
480 appliname = f[:-len('.pyconf')]
481 if appliname not in lproduct:
482 lproduct.append(appliname)
483 if path.startswith(runner.cfg.VARS.personalDir):
484 logger.write("%s*\n" % appliname)
486 logger.write("%s\n" % appliname)