pymin/services/dhcp/__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__ = ('DhcpHandler', 'Error', 'HostError', 'HostAlreadyExistsError',
  11             'HostNotFoundError')
  12
  13 class Error(HandlerError):
  14     r"""
  15     Error(message) -> Error instance :: Base DhcpHandler exception class.
  16
  17     All exceptions raised by the DhcpHandler inherits from this one, so you can
  18     easily catch any DhcpHandler 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
  65 class Host(Sequence):
  66     r"""Host(name, ip, mac) -> Host instance :: Class representing a host.
  67
  68     name - Host name, should be a fully qualified name, but no checks are done.
  69     ip - IP assigned to the hostname.
  70     mac - MAC address to associate to the hostname.
  71     """
  72
  73     def __init__(self, name, ip, mac):
  74         r"Initialize Host object, see class documentation for details."
  75         self.name = name
  76         self.ip = ip
  77         self.mac = mac
  78
  79     def as_tuple(self):
  80         r"Return a tuple representing the host."
  81         return (self.name, self.ip, self.mac)
  82
  83 class HostHandler(Handler):
  84     r"""HostHandler(hosts) -> HostHandler instance :: Handle a list of hosts.
  85
  86     This class is a helper for DhcpHandler to do all the work related to hosts
  87     administration.
  88
  89     hosts - A dictionary with string keys (hostnames) and Host instances values.
  90     """
  91
  92     def __init__(self, hosts):
  93         r"Initialize HostHandler object, see class documentation for details."
  94         self.hosts = hosts
  95
  96     @handler(u'Add a new host.')
  97     def add(self, name, ip, mac):
  98         r"add(name, ip, mac) -> None :: Add a host to the hosts list."
  99         if name in self.hosts:
 100             raise HostAlreadyExistsError(name)
 101         self.hosts[name] = Host(name, ip, mac)
 102
 103     @handler(u'Update a host.')
 104     def update(self, name, ip=None, mac=None):
 105         r"update(name[, ip[, mac]]) -> None :: Update a host of the hosts list."
 106         if not name in self.hosts:
 107             raise HostNotFoundError(name)
 108         if ip is not None:
 109             self.hosts[name].ip = ip
 110         if mac is not None:
 111             self.hosts[name].mac = mac
 112
 113     @handler(u'Delete a host.')
 114     def delete(self, name):
 115         r"delete(name) -> None :: Delete a host of the hosts list."
 116         if not name in self.hosts:
 117             raise HostNotFoundError(name)
 118         del self.hosts[name]
 119
 120     @handler(u'Get information about a host.')
 121     def get(self, name):
 122         r"get(name) -> Host :: List all the information of a host."
 123         if not name in self.hosts:
 124             raise HostNotFoundError(name)
 125         return self.hosts[name]
 126
 127     @handler(u'List hosts.')
 128     def list(self):
 129         r"list() -> tuple :: List all the hostnames."
 130         return self.hosts.keys()
 131
 132     @handler(u'Get information about all hosts.')
 133     def show(self):
 134         r"show() -> list of Hosts :: List all the complete hosts information."
 135         return self.hosts.values()
 136
 137
 138 class DhcpHandler(Restorable, ConfigWriter, InitdHandler, TransactionalHandler,
 139                   ParametersHandler):
 140     r"""DhcpHandler([pickle_dir[, config_dir]]) -> DhcpHandler instance.
 141
 142     Handles DHCP service commands for the dhcpd program.
 143
 144     pickle_dir - Directory where to write the persistent configuration data.
 145
 146     config_dir - Directory where to store de generated configuration files.
 147
 148     Both defaults to the current working directory.
 149     """
 150
 151     _initd_name = 'dhcpd'
 152
 153     _persistent_attrs = ('params', 'hosts')
 154
 155     _restorable_defaults = dict(
 156             hosts = dict(),
 157             params  = dict(
 158                 domain_name = 'example.com',
 159                 dns_1       = 'ns1.example.com',
 160                 dns_2       = 'ns2.example.com',
 161                 net_address = '192.168.0.0',
 162                 net_mask    = '255.255.255.0',
 163                 net_start   = '192.168.0.100',
 164                 net_end     = '192.168.0.200',
 165                 net_gateway = '192.168.0.1',
 166             ),
 167     )
 168
 169     _config_writer_files = 'dhcpd.conf'
 170     _config_writer_tpl_dir = path.join(path.dirname(__file__), 'templates')
 171
 172     def __init__(self, pickle_dir='.', config_dir='.'):
 173         r"Initialize DhcpHandler object, see class documentation for details."
 174         self._persistent_dir = pickle_dir
 175         self._config_writer_cfg_dir = config_dir
 176         self._config_build_templates()
 177         self._restore()
 178         self.host = HostHandler(self.hosts)
 179
 180     def _get_config_vars(self, config_file):
 181         return dict(hosts=self.hosts.values(), **self.params)
 182
 183
 184 if __name__ == '__main__':
 185
 186     import os
 187
 188     h = DhcpHandler()
 189
 190     def dump():
 191         print '-' * 80
 192         print 'Variables:', h.list()
 193         print h.show()
 194         print
 195         print 'Hosts:', h.host.list()
 196         print h.host.show()
 197         print '-' * 80
 198
 199     dump()
 200
 201     h.host.add('my_name','192.168.0.102','00:12:ff:56')
 202
 203     h.host.update('my_name','192.168.0.192','00:12:ff:56')
 204
 205     h.host.add('nico','192.168.0.188','00:00:00:00')
 206
 207     h.set('domain_name','baryon.com.ar')
 208
 209     try:
 210         h.set('sarasa','baryon.com.ar')
 211     except KeyError, e:
 212         print 'Error:', e
 213
 214     h.commit()
 215
 216     dump()
 217
 218     os.system('rm -f *.pkl ' + ' '.join(h._config_writer_files))
 219