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', \
  43     "Attribute '.*' of the 'apt_pkg.*' object is deprecated, use '.*' instead\.", \
  44     DeprecationWarning)
  45 warnings.filterwarnings('ignore', \
  46     "apt_pkg.*\(\) is deprecated\. Please see apt_pkg.*\(\) for the replacement\.", \
  47     DeprecationWarning)
  48
  49 ################################################################################
  50
  51 def which_conf_file():
  52     return os.getenv("DAK_CONFIG", default_config)
  53
  54 class Config(object):
  55     """
  56     A Config object is a singleton containing
  57     information about the DAK configuration
  58     """
  59
  60     __shared_state = {}
  61
  62     def __init__(self, *args, **kwargs):
  63         self.__dict__ = self.__shared_state
  64
  65         if not getattr(self, 'initialised', False):
  66             self.initialised = True
  67             self._readconf()
  68             self._setup_routines()
  69
  70     def _readconf(self):
  71         apt_pkg.init()
  72
  73         self.Cnf = apt_pkg.newConfiguration()
  74
  75         apt_pkg.ReadConfigFileISC(self.Cnf, which_conf_file())
  76
  77         # Check whether our dak.conf was the real one or
  78         # just a pointer to our main one
  79         res = socket.gethostbyaddr(socket.gethostname())
  80         conffile = self.Cnf.get("Config::" + res[0] + "::DakConfig")
  81         if conffile:
  82             apt_pkg.ReadConfigFileISC(self.Cnf, conffile)
  83
  84         # Rebind some functions
  85         # TODO: Clean this up
  86         self.get = self.Cnf.get
  87         self.SubTree = self.Cnf.SubTree
  88         self.ValueList = self.Cnf.ValueList
  89         self.Find = self.Cnf.Find
  90         self.FindB = self.Cnf.FindB
  91
  92     def has_key(self, name):
  93         return self.Cnf.has_key(name)
  94
  95     def __getitem__(self, name):
  96         return self.Cnf[name]
  97
  98     def __setitem__(self, name, value):
  99         self.Cnf[name] = value
 100
 101     @staticmethod
 102     def get_db_value(name, default=None, rettype=None):
 103         from daklib.dbconn import DBConfig, DBConn, NoResultFound
 104         try:
 105             res = DBConn().session().query(DBConfig).filter(DBConfig.name == name).one()
 106         except NoResultFound:
 107             return default
 108
 109         if rettype:
 110             return rettype(res.value)
 111         else:
 112             return res.value
 113
 114     def _setup_routines(self):
 115         """
 116         This routine is the canonical list of which fields need to exist in
 117         the config table.  If your dak instance is to work, we suggest reading it
 118
 119         Of course, what the values do is another matter
 120         """
 121         for field in [('db_revision',      None,       int),
 122                       ('defaultsuitename', 'unstable', str),
 123                       ('signingkeyids',    '',         str),
 124                       ('exportpath',       '',         str)
 125                       ]:
 126             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))
 127             setattr(Config, '%s' % field[0], property(fget=getattr(self, 'get_%s' % field[0])))
 128
 129     def get_defaultsuite(self):
 130         from daklib.dbconn import get_suite
 131         suitename = self.defaultsuitename
 132         if not suitename:
 133             return None
 134         else:
 135             return get_suite(suitename)
 136
 137     defaultsuite = property(get_defaultsuite)
 138