services/proxy/__init__.py

   1 # vim: set encoding=utf-8 et sw=4 sts=4 :
   2
   3 from os import path
   4
   5 from seqtools import Sequence
   6 from dispatcher import Handler, handler, HandlerError
   7 from services.util import Restorable, ConfigWriter
   8 from services.util import InitdHandler, TransactionalHandler, ParametersHandler
   9
  10 __ALL__ = ('ProxyHandler', 'Error', 'HostError', 'HostAlreadyExistsError',
  11             'HostNotFoundError', 'ParameterError', 'ParameterNotFoundError')
  12
  13 class Error(HandlerError):
  14     r"""
  15     Error(command) -> Error instance :: Base DnsHandler exception class.
  16
  17     All exceptions raised by the DnsHandler inherits from this one, so you can
  18     easily catch any DnsHandler exception.
  19
  20     message - A descriptive error message.
  21     """
  22
  23     def __init__(self, message):
  24         r"Initialize the Error object. See class documentation for more info."
  25         self.message = message
  26
  27     def __str__(self):
  28         return self.message
  29
  30 class HostError(Error, KeyError):
  31     r"""
  32     HostError(hostname) -> HostError instance
  33
  34     This is the base exception for all host related errors.
  35     """
  36
  37     def __init__(self, hostname):
  38         r"Initialize the object. See class documentation for more info."
  39         self.message = 'Host error: "%s"' % hostname
  40
  41 class HostAlreadyExistsError(HostError):
  42     r"""
  43     HostAlreadyExistsError(hostname) -> HostAlreadyExistsError instance
  44
  45     This exception is raised when trying to add a hostname that already exists.
  46     """
  47
  48     def __init__(self, hostname):
  49         r"Initialize the object. See class documentation for more info."
  50         self.message = 'Host already exists: "%s"' % hostname
  51
  52 class HostNotFoundError(HostError):
  53     r"""
  54     HostNotFoundError(hostname) -> HostNotFoundError instance
  55
  56     This exception is raised when trying to operate on a hostname that doesn't
  57     exists.
  58     """
  59
  60     def __init__(self, hostname):
  61         r"Initialize the object. See class documentation for more info."
  62         self.message = 'Host not found: "%s"' % hostname
  63
  64 class ParameterError(Error, KeyError):
  65     r"""
  66     ParameterError(paramname) -> ParameterError instance
  67
  68     This is the base exception for all DhcpHandler parameters related errors.
  69     """
  70
  71     def __init__(self, paramname):
  72         r"Initialize the object. See class documentation for more info."
  73         self.message = 'Parameter error: "%s"' % paramname
  74
  75 class ParameterNotFoundError(ParameterError):
  76     r"""
  77     ParameterNotFoundError(hostname) -> ParameterNotFoundError instance
  78
  79     This exception is raised when trying to operate on a parameter that doesn't
  80     exists.
  81     """
  82
  83     def __init__(self, paramname):
  84         r"Initialize the object. See class documentation for more info."
  85         self.message = 'Parameter not found: "%s"' % paramname
  86
  87 class Host(Sequence):
  88
  89     def __init__(self,ip):
  90         self.ip = ip
  91
  92     def as_tuple(self):
  93         return (self.ip)
  94
  95 class HostHandler(Handler):
  96
  97     def __init__(self, hosts):
  98         self.hosts = hosts
  99
 100     @handler(u'Adds a host')
 101     def add(self, ip):
 102         if ip in self.hosts:
 103             raise HostAlreadyExistsError(ip)
 104         self.hosts[ip] = Host(ip)
 105
 106     @handler(u'Deletes a host')
 107     def delete(self, ip):
 108         if not ip in self.hosts:
 109             raise HostNotFoundError(ip)
 110         del self.hosts[ip]
 111
 112     @handler(u'Shows all hosts')
 113     def list(self):
 114         return self.hosts.keys()
 115
 116     @handler(u'Get information about all hosts')
 117     def show(self):
 118         return self.hosts.items()
 119
 120
 121 class ProxyHandler(Restorable, ConfigWriter, InitdHandler,
 122                    TransactionalHandler, ParametersHandler):
 123
 124     _initd_name = 'squid'
 125
 126     _persistent_attrs = ('params', 'hosts')
 127
 128     _restorable_defaults = dict(
 129             hosts = dict(),
 130             params  = dict(
 131                 ip   = '192.168.0.1',
 132                 port = '8080',
 133             ),
 134     )
 135
 136     _config_writer_files = 'squid.conf'
 137     _config_writer_tpl_dir = path.join(path.dirname(__file__), 'templates')
 138
 139     def __init__(self, pickle_dir='.', config_dir='.'):
 140         r"Initialize DhcpHandler object, see class documentation for details."
 141         self._persistent_dir = pickle_dir
 142         self._config_writer_cfg_dir = config_dir
 143         self._config_build_templates()
 144         self._restore()
 145         self.host = HostHandler(self.hosts)
 146
 147     def _get_config_vars(self, config_file):
 148         return dict(hosts=self.hosts.values(), **self.params)
 149
 150
 151 if __name__ == '__main__':
 152
 153     px = ProxyHandler()
 154     px.set('ip','192.66.66.66')
 155     px.set('port','666')
 156     px.host.add('192.168.0.25.25')
 157     px.host.add('192.168.0.25.26')
 158     px.host.add('192.168.0.25.27')
 159     px.host.delete('192.168.0.25.27')
 160     px.commit()