daklib/config.py

   1 #!/usr/bin/env python
   2
   3 """
   4 Config access class
   5
   6 @contact: Debian FTPMaster <ftpmaster@debian.org>
   7 @copyright: 2008  Mark Hymers <mhy@debian.org>
   8 @license: GNU General Public License version 2 or later
   9 """
  10
  11 # This program is free software; you can redistribute it and/or modify
  12 # it under the terms of the GNU General Public License as published by
  13 # the Free Software Foundation; either version 2 of the License, or
  14 # (at your option) any later version.
  15
  16 # This program is distributed in the hope that it will be useful,
  17 # but WITHOUT ANY WARRANTY; without even the implied warranty of
  18 # MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  19 # GNU General Public License for more details.
  20
  21 # You should have received a copy of the GNU General Public License
  22 # along with this program; if not, write to the Free Software
  23 # Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA  02111-1307  USA
  24
  25 ################################################################################
  26
  27 # <NCommander> mhy, how about "Now with 20% more monty python references"
  28
  29 ################################################################################
  30
  31 import os
  32 import apt_pkg
  33 import socket
  34
  35 ################################################################################
  36
  37 default_config = "/etc/dak/dak.conf" #: default dak config, defines host properties
  38
  39 # suppress some deprecation warnings in squeeze related to apt_pkg
  40 # module
  41 import warnings
  42 warnings.filterwarnings('ignore', ".*apt_pkg.* is deprecated.*", DeprecationWarning)
  43
  44 ################################################################################
  45
  46 def which_conf_file():
  47     return os.getenv("DAK_CONFIG", default_config)
  48
  49 class Config(object):
  50     """
  51     A Config object is a singleton containing
  52     information about the DAK configuration
  53     """
  54
  55     __shared_state = {}
  56
  57     def __init__(self, *args, **kwargs):
  58         self.__dict__ = self.__shared_state
  59
  60         if not getattr(self, 'initialised', False):
  61             self.initialised = True
  62             self._readconf()
  63             self._setup_routines()
  64
  65     def _readconf(self):
  66         apt_pkg.init()
  67
  68         self.Cnf = apt_pkg.Configuration()
  69
  70         apt_pkg.read_config_file_isc(self.Cnf, which_conf_file())
  71
  72         # Check whether our dak.conf was the real one or
  73         # just a pointer to our main one
  74         res = socket.gethostbyaddr(socket.gethostname())
  75         conffile = self.Cnf.get("Config::" + res[0] + "::DakConfig")
  76         if conffile:
  77             apt_pkg.read_config_file_isc(self.Cnf, conffile)
  78
  79         # Rebind some functions
  80         # TODO: Clean this up
  81         self.get = self.Cnf.get
  82         self.subtree = self.Cnf.subtree
  83         self.value_list = self.Cnf.value_list
  84         self.find = self.Cnf.find
  85         self.find_b = self.Cnf.find_b
  86
  87     def has_key(self, name):
  88         return name in self.Cnf
  89
  90     def __contains__(self, name):
  91         return name in self.Cnf
  92
  93     def __getitem__(self, name):
  94         return self.Cnf[name]
  95
  96     def __setitem__(self, name, value):
  97         self.Cnf[name] = value
  98
  99     @staticmethod
 100     def get_db_value(name, default=None, rettype=None):
 101         from daklib.dbconn import DBConfig, DBConn, NoResultFound
 102         try:
 103             res = DBConn().session().query(DBConfig).filter(DBConfig.name == name).one()
 104         except NoResultFound:
 105             return default
 106
 107         if rettype:
 108             return rettype(res.value)
 109         else:
 110             return res.value
 111
 112     def _setup_routines(self):
 113         """
 114         This routine is the canonical list of which fields need to exist in
 115         the config table.  If your dak instance is to work, we suggest reading it
 116
 117         Of course, what the values do is another matter
 118         """
 119         for field in [('db_revision',      None,       int),
 120                       ('defaultsuitename', 'unstable', str),
 121                       ('exportpath',       '',         str)
 122                       ]:
 123             setattr(self, 'get_%s' % field[0], lambda s=None, x=field[0], y=field[1], z=field[2]: self.get_db_value(x, y, z))
 124             setattr(Config, '%s' % field[0], property(fget=getattr(self, 'get_%s' % field[0])))
 125
 126     def get_defaultsuite(self):
 127         from daklib.dbconn import get_suite
 128         suitename = self.defaultsuitename
 129         if not suitename:
 130             return None
 131         else:
 132             return get_suite(suitename)
 133
 134     defaultsuite = property(get_defaultsuite)
 135