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                                 DictSubHandler
  10
  11 __ALL__ = ('DhcpHandler', 'Error')
  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     pass
  23
  24 class Host(Sequence):
  25     r"""Host(name, ip, mac) -> Host instance :: Class representing a host.
  26
  27     name - Host name, should be a fully qualified name, but no checks are done.
  28     ip - IP assigned to the hostname.
  29     mac - MAC address to associate to the hostname.
  30     """
  31
  32     def __init__(self, name, ip, mac):
  33         r"Initialize Host object, see class documentation for details."
  34         self.name = name
  35         self.ip = ip
  36         self.mac = mac
  37
  38     def as_tuple(self):
  39         r"Return a tuple representing the host."
  40         return (self.name, self.ip, self.mac)
  41
  42     def update(self, ip=None, mac=None):
  43         if ip is not None:
  44             self.ip = ip
  45         if mac is not None:
  46             self.mac = mac
  47
  48 class HostHandler(DictSubHandler):
  49     r"""HostHandler(parent) -> HostHandler instance :: Handle a list of hosts.
  50
  51     This class is a helper for DhcpHandler to do all the work related to hosts
  52     administration.
  53     """
  54
  55     handler_help = u"Manage DHCP hosts"
  56
  57     _dict_subhandler_attr = 'hosts'
  58     _dict_subhandler_class = Host
  59
  60 class DhcpHandler(Restorable, ConfigWriter, InitdHandler, TransactionalHandler,
  61                   ParametersHandler):
  62     r"""DhcpHandler([pickle_dir[, config_dir]]) -> DhcpHandler instance.
  63
  64     Handles DHCP service commands for the dhcpd program.
  65
  66     pickle_dir - Directory where to write the persistent configuration data.
  67
  68     config_dir - Directory where to store de generated configuration files.
  69
  70     Both defaults to the current working directory.
  71     """
  72
  73     handler_help = u"Manage DHCP service"
  74
  75     _initd_name = 'dhcpd'
  76
  77     _persistent_attrs = ('params', 'hosts')
  78
  79     _restorable_defaults = dict(
  80             hosts = dict(),
  81             params  = dict(
  82                 domain_name = 'example.com',
  83                 dns_1       = 'ns1.example.com',
  84                 dns_2       = 'ns2.example.com',
  85                 net_address = '192.168.0.0',
  86                 net_mask    = '255.255.255.0',
  87                 net_start   = '192.168.0.100',
  88                 net_end     = '192.168.0.200',
  89                 net_gateway = '192.168.0.1',
  90             ),
  91     )
  92
  93     _config_writer_files = 'dhcpd.conf'
  94     _config_writer_tpl_dir = path.join(path.dirname(__file__), 'templates')
  95
  96     def __init__(self, pickle_dir='.', config_dir='.'):
  97         r"Initialize DhcpHandler object, see class documentation for details."
  98         self._persistent_dir = pickle_dir
  99         self._config_writer_cfg_dir = config_dir
 100         self._config_build_templates()
 101         self._restore()
 102         self.host = HostHandler(self)
 103
 104     def _get_config_vars(self, config_file):
 105         return dict(hosts=self.hosts.values(), **self.params)
 106
 107
 108 if __name__ == '__main__':
 109
 110     import os
 111
 112     h = DhcpHandler()
 113
 114     def dump():
 115         print '-' * 80
 116         print 'Variables:', h.list()
 117         print h.show()
 118         print
 119         print 'Hosts:', h.host.list()
 120         print h.host.show()
 121         print '-' * 80
 122
 123     dump()
 124
 125     h.host.add('my_name','192.168.0.102','00:12:ff:56')
 126
 127     h.host.update('my_name','192.168.0.192','00:12:ff:56')
 128
 129     h.host.add('nico','192.168.0.188','00:00:00:00')
 130
 131     h.set('domain_name','baryon.com.ar')
 132
 133     try:
 134         h.set('sarasa','baryon.com.ar')
 135     except KeyError, e:
 136         print 'Error:', e
 137
 138     h.commit()
 139
 140     dump()
 141
 142     os.system('rm -f *.pkl ' + ' '.join(h._config_writer_files))
 143