pymin/services/proxy/__init__.py

   1 # vim: set encoding=utf-8 et sw=4 sts=4 :
   2
   3 from os import path
   4
   5 from pymin.seqtools import Sequence
   6 from pymin.dispatcher import Handler, handler, HandlerError
   7 from pymin.services.util import Restorable, ConfigWriter, InitdHandler, \
   8                                 TransactionalHandler, ParametersHandler
   9
  10 __ALL__ = ('ProxyHandler', 'Error', 'HostError', 'HostAlreadyExistsError',
  11             'HostNotFoundError')
  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     pass
  23
  24 class HostError(Error, KeyError):
  25     r"""
  26     HostError(hostname) -> HostError instance
  27
  28     This is the base exception for all host related errors.
  29     """
  30
  31     def __init__(self, hostname):
  32         r"Initialize the object. See class documentation for more info."
  33         self.message = u'Host error: "%s"' % hostname
  34
  35 class HostAlreadyExistsError(HostError):
  36     r"""
  37     HostAlreadyExistsError(hostname) -> HostAlreadyExistsError instance
  38
  39     This exception is raised when trying to add a hostname that already exists.
  40     """
  41
  42     def __init__(self, hostname):
  43         r"Initialize the object. See class documentation for more info."
  44         self.message = u'Host already exists: "%s"' % hostname
  45
  46 class HostNotFoundError(HostError):
  47     r"""
  48     HostNotFoundError(hostname) -> HostNotFoundError instance
  49
  50     This exception is raised when trying to operate on a hostname that doesn't
  51     exists.
  52     """
  53
  54     def __init__(self, hostname):
  55         r"Initialize the object. See class documentation for more info."
  56         self.message = u'Host not found: "%s"' % hostname
  57
  58
  59 class Host(Sequence):
  60
  61     def __init__(self,ip):
  62         self.ip = ip
  63
  64     def as_tuple(self):
  65         return (self.ip)
  66
  67 class HostHandler(Handler):
  68
  69     handler_help = u"Manage proxy hosts"
  70
  71     def __init__(self, hosts):
  72         self.hosts = hosts
  73
  74     @handler(u'Adds a host')
  75     def add(self, ip):
  76         if ip in self.hosts:
  77             raise HostAlreadyExistsError(ip)
  78         self.hosts[ip] = Host(ip)
  79
  80     @handler(u'Deletes a host')
  81     def delete(self, ip):
  82         if not ip in self.hosts:
  83             raise HostNotFoundError(ip)
  84         del self.hosts[ip]
  85
  86     @handler(u'Shows all hosts')
  87     def list(self):
  88         return self.hosts.keys()
  89
  90     @handler(u'Get information about all hosts')
  91     def show(self):
  92         return self.hosts.items()
  93
  94
  95 class ProxyHandler(Restorable, ConfigWriter, InitdHandler,
  96                    TransactionalHandler, ParametersHandler):
  97
  98     handler_help = u"Manage proxy service"
  99
 100     _initd_name = 'squid'
 101
 102     _persistent_attrs = ('params', 'hosts')
 103
 104     _restorable_defaults = dict(
 105             hosts = dict(),
 106             params  = dict(
 107                 ip   = '192.168.0.1',
 108                 port = '8080',
 109             ),
 110     )
 111
 112     _config_writer_files = 'squid.conf'
 113     _config_writer_tpl_dir = path.join(path.dirname(__file__), 'templates')
 114
 115     def __init__(self, pickle_dir='.', config_dir='.'):
 116         r"Initialize DhcpHandler object, see class documentation for details."
 117         self._persistent_dir = pickle_dir
 118         self._config_writer_cfg_dir = config_dir
 119         self._config_build_templates()
 120         self._restore()
 121         self.host = HostHandler(self.hosts)
 122
 123     def _get_config_vars(self, config_file):
 124         return dict(hosts=self.hosts.values(), **self.params)
 125
 126
 127 if __name__ == '__main__':
 128
 129     px = ProxyHandler()
 130     px.set('ip','192.66.66.66')
 131     px.set('port','666')
 132     px.host.add('192.168.0.25.25')
 133     px.host.add('192.168.0.25.26')
 134     px.host.add('192.168.0.25.27')
 135     px.host.delete('192.168.0.25.27')
 136     px.commit()