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