vmm: comparison VirtualMailManager/config.py

equal deleted inserted replaced

-:22d115376e4d
+:2ae40cd0d213
 """
 from ConfigParser import \
 Error, MissingSectionHeaderError, NoOptionError, NoSectionError, \
 ParsingError, RawConfigParser
-from cStringIO import StringIO# TODO: move interactive stff to cli
+from cStringIO import StringIO
 from VirtualMailManager.common import VERSION_RE, \
 exec_ok, expand_path, get_unicode, lisdir, version_hex
 from VirtualMailManager.constants import CONF_ERROR
 from VirtualMailManager.errors import ConfigError, VMMError
 from VirtualMailManager.maillocation import known_format
 from VirtualMailManager.password import verify_scheme as _verify_scheme
+DB_MUDULES = ('psycopg2', 'pypgsql')
+DB_SSL_MODES = ('allow', 'disabled', 'prefer', 'require', 'verify-ca',
+'verify-full')
 _ = lambda msg: msg
 class BadOptionError(Error):
 path to the configuration file
 """
 LazyConfig.__init__(self)
 self._cfg_filename = filename
 self._cfg_file = None
-self.__missing = {}
+self._missing = {}
 LCO = LazyConfigOption
 bool_t = self.bool_new
 self._cfg = {
 'account': {
 'du': LCO(str, '/usr/bin/du', self.get, exec_ok),
 'postconf': LCO(str, '/usr/sbin/postconf', self.get, exec_ok),
 },
 'database': {
 'host': LCO(str, 'localhost', self.get),
+'module': LCO(str, 'psycopg2', self.get, check_db_module),
 'name': LCO(str, 'mailsys', self.get),
 'pass': LCO(str, None, self.get),
+'port': LCO(int, 5432, self.getint),
+'sslmode': LCO(str, 'prefer', self.get, check_db_ssl_mode),
 'user': LCO(str, None, self.get),
 },
 'domain': {
 'auto_postmaster': LCO(bool_t, True, self.getboolean),
 'delete_directory': LCO(bool_t, False, self.getboolean),
 def check(self):
 """Performs a configuration check.
 Raises a ConfigError if settings w/o a default value are missed.
-Or a ConfigValueError if 'misc.dovecot_version' has the wrong
+Or some settings have a invalid value.
-format.
+"""
-"""
+def iter_dict():
-# TODO: There are only two settings w/o defaults.
+for section, options in self._missing.iteritems():
-#       So there is no need for cStringIO
+errmsg.write(_(u'* Section: %s\n') % section)
-if not self._chk_cfg():
+errmsg.writelines(u'    %s\n' % option for option in options)
+self._missing.clear()
+errmsg = None
+self._chk_non_default()
+miss_vers = 'misc' in self._missing and \
+'dovecot_version' in self._missing['misc']
+if self._missing:
 errmsg = StringIO()
+errmsg.write(_(u'Check of configuration file %s failed.\n') %
+self._cfg_filename)
 errmsg.write(_(u'Missing options, which have no default value.\n'))
-errmsg.write(_(u'Using configuration file: %s\n') %
+iter_dict()
-self._cfg_filename)
+self._chk_possible_values(miss_vers)
-for section, options in self.__missing.iteritems():
+if self._missing:
-errmsg.write(_(u'* Section: %s\n') % section)
+if not errmsg:
-for option in options:
+errmsg = StringIO()
-errmsg.write((u'    %s\n') % option)
+errmsg.write(_(u'Check of configuration file %s failed.\n') %
+self._cfg_filename)
+errmsg.write(_(u'Invalid configuration values.\n'))
+else:
+errmsg.write('\n' + _(u'Invalid configuration values.\n'))
+iter_dict()
+if errmsg:
 raise ConfigError(errmsg.getvalue(), CONF_ERROR)
-check_version_format(self.get('misc', 'dovecot_version'))
 def hexversion(self, section, option):
 """Converts the version number (e.g.: 1.2.3) from the *option*'s
 value to an int."""
 return version_hex(self.get(section, option))
 def unicode(self, section, option):
 """Returns the value of the `option` from `section`, converted
 to Unicode."""
 return get_unicode(self.get(section, option))
-def _chk_cfg(self):
+def _chk_non_default(self):
 """Checks all section's options for settings w/o a default
-value.
+value. Missing items will be stored in _missing.
+"""
-Returns `True` if everything is fine, else `False`.
-"""
-errors = False
 for section in self._cfg.iterkeys():
 missing = []
 for option, value in self._cfg[section].iteritems():
 if (value.default is None and
 not RawConfigParser.has_option(self, section, option)):
 missing.append(option)
-errors = True
 if missing:
-self.__missing[section] = missing
+self._missing[section] = missing
-return not errors
+def _chk_possible_values(self, miss_vers):
+"""Check settings for which the possible values are known."""
+if not miss_vers:
+value = self.get('misc', 'dovecot_version')
+if not VERSION_RE.match(value):
+self._missing['misc'] = ['version: ' +\
+_(u"Not a valid Dovecot version: '%s'") % value]
+db_err = []
+value = self.dget('database.module').lower()
+if value not in DB_MUDULES:
+db_err.append('module: ' + \
+_(u"Unsupported database module: '%s'") % value)
+if value == 'psycopg2':
+value = self.dget('database.sslmode')
+if value not in DB_SSL_MODES:
+db_err.append('sslmode: ' + \
+_(u"Unknown pgsql SSL mode: '%s'") % value)
+if db_err:
+self._missing['database'] = db_err
 def is_dir(path):
 """Check if the expanded path is a directory.  When the expanded path
 is a directory the expanded path will be returned.  Otherwise a
 """
 path = expand_path(path)
 if lisdir(path):
 return path
 raise ConfigValueError(_(u"No such directory: %s") % get_unicode(path))
+def check_db_module(module):
+"""Check if the *module* is a supported pgsql module."""
+if module.lower() in DB_MUDULES:
+return module
+raise ConfigValueError(_(u"Unsupported database module: '%s'") %
+get_unicode(module))
+def check_db_ssl_mode(ssl_mode):
+"""Check if the *ssl_mode* is one of the SSL modes, known by pgsql."""
+if ssl_mode in DB_SSL_MODES:
+return ssl_mode
+raise ConfigValueError(_(u"Unknown pgsql SSL mode: '%s'") %
+get_unicode(ssl_mode))
 def check_mailbox_format(format):
 """
 Check if the mailbox format *format* is supported.  When the *format*

branch	v0.6.x
changeset 353	2ae40cd0d213
parent 348	ca7575401549
child 359	7fa919dab42c