#!/usr/bin/env python # # Copyright CEA/DAM/DIF (2010, 2011) # Contributor: Stephane THIELL # # This file is part of the ClusterShell library. # # This software is governed by the CeCILL-C license under French law and # abiding by the rules of distribution of free software. You can use, # modify and/ or redistribute the software under the terms of the CeCILL-C # license as circulated by CEA, CNRS and INRIA at the following URL # "http://www.cecill.info". # # As a counterpart to the access to the source code and rights to copy, # modify and redistribute granted by the license, users are provided only # with a limited warranty and the software's author, the holder of the # economic rights, and the successive licensors have only limited # liability. # # In this respect, the user's attention is drawn to the risks associated # with loading, using, modifying and/or developing or reproducing the # software by the user in light of its specific status of free software, # that may mean that it is complicated to manipulate, and that also # therefore means that it is reserved for developers and experienced # professionals having in-depth computer knowledge. Users are therefore # encouraged to load and test the software's suitability as regards their # requirements in conditions enabling the security of their systems and/or # data to be ensured and, more generally, to use and operate it in the # same conditions as regards security. # # The fact that you are presently reading this means that you have had # knowledge of the CeCILL-C license and that you accept its terms. """ CLI configuration classes """ import ConfigParser import os from ClusterShell.CLI.Display import VERB_QUIET, VERB_STD, \ VERB_VERB, VERB_DEBUG, THREE_CHOICES class ClushConfigError(Exception): """Exception used by ClushConfig to report an error.""" def __init__(self, section, option, msg): Exception.__init__(self) self.section = section self.option = option self.msg = msg def __str__(self): return "(Config %s.%s): %s" % (self.section, self.option, self.msg) class ClushConfig(ConfigParser.ConfigParser, object): """Config class for clush (specialized ConfigParser)""" main_defaults = { "fanout" : "64", "connect_timeout" : "30", "command_timeout" : "0", "history_size" : "100", "color" : THREE_CHOICES[-1], # auto "verbosity" : "%d" % VERB_STD, "node_count" : "yes", "fd_max" : "16384" } def __init__(self, options, filename=None): """Initialize ClushConfig object from corresponding OptionParser options.""" ConfigParser.ConfigParser.__init__(self) # create Main section with default values self.add_section("Main") for key, value in ClushConfig.main_defaults.iteritems(): self.set("Main", key, value) # config files override defaults values if filename: files = [filename] else: files = ['/etc/clustershell/clush.conf', os.path.expanduser('~/.clush.conf')] self.read(files) # Apply command line overrides if options.quiet: self._set_main("verbosity", VERB_QUIET) if options.verbose: self._set_main("verbosity", VERB_VERB) if options.debug: self._set_main("verbosity", VERB_DEBUG) if options.fanout: self._set_main("fanout", options.fanout) if options.user: self._set_main("ssh_user", options.user) if options.options: self._set_main("ssh_options", options.options) if options.connect_timeout: self._set_main("connect_timeout", options.connect_timeout) if options.command_timeout: self._set_main("command_timeout", options.command_timeout) if options.whencolor: self._set_main("color", options.whencolor) def _set_main(self, option, value): """Set given option/value pair in the Main section.""" self.set("Main", option, str(value)) def _getx(self, xtype, section, option): """Return a value of specified type for the named option.""" try: return getattr(ConfigParser.ConfigParser, 'get%s' % xtype)(self, \ section, option) except (ConfigParser.Error, TypeError, ValueError), exc: raise ClushConfigError(section, option, exc) def getboolean(self, section, option): """Return a boolean value for the named option.""" return self._getx('boolean', section, option) def getfloat(self, section, option): """Return a float value for the named option.""" return self._getx('float', section, option) def getint(self, section, option): """Return an integer value for the named option.""" return self._getx('int', section, option) def _get_optional(self, section, option): """Utility method to get a value for the named option, but do not raise an exception if the option doesn't exist.""" try: return self.get(section, option) except ConfigParser.Error: pass @property def verbosity(self): """verbosity value as an integer""" try: return self.getint("Main", "verbosity") except ClushConfigError: return 0 @property def fanout(self): """fanout value as an integer""" return self.getint("Main", "fanout") @property def connect_timeout(self): """connect_timeout value as a float""" return self.getfloat("Main", "connect_timeout") @property def command_timeout(self): """command_timeout value as a float""" return self.getfloat("Main", "command_timeout") @property def ssh_user(self): """ssh_user value as a string (optional)""" return self._get_optional("Main", "ssh_user") @property def ssh_path(self): """ssh_path value as a string (optional)""" return self._get_optional("Main", "ssh_path") @property def ssh_options(self): """ssh_options value as a string (optional)""" return self._get_optional("Main", "ssh_options") @property def color(self): """color value as a string in (never, always, auto)""" whencolor = self._get_optional("Main", "color") if whencolor not in THREE_CHOICES: raise ClushConfigError("Main", "color", "choose from %s" % \ THREE_CHOICES) return whencolor @property def node_count(self): """node_count value as a boolean""" return self.getboolean("Main", "node_count") @property def fd_max(self): """max number of open files (soft rlimit)""" return self.getint("Main", "fd_max")