pymin/services/ip/__init__.py

   1 # vim: set encoding=utf-8 et sw=4 sts=4 :
   2
   3 from subprocess import Popen, PIPE
   4 from os import path
   5
   6 from pymin.seqtools import Sequence
   7 from pymin.dispatcher import handler, HandlerError, Handler
   8 from pymin.services.util import Restorable, ConfigWriter, InitdHandler, \
   9                                 TransactionalHandler, SubHandler, call, \
  10                                 get_network_devices, ListComposedSubHandler, \
  11                                 DictComposedSubHandler, Device, Address, ExecutionError
  12
  13 __ALL__ = ('IpHandler',)
  14
  15 # TODO: convertir HopHandler a ComposedSubHandler
  16
  17 class HopError(HandlerError):
  18
  19     def __init__(self, hop):
  20         self.message = u'Hop error : "%s"' % hop
  21
  22 class HopNotFoundError(HopError):
  23
  24     def __init__(self, hop):
  25         self.message = u'Hop not found : "%s"' % hop
  26
  27 class HopAlreadyExistsError(HopError):
  28
  29     def __init__(self, hop):
  30         self.message = u'Hop already exists : "%s"' % hop
  31
  32
  33 class Hop(Sequence):
  34
  35     def __init__(self, gateway, device):
  36         self.gateway = gateway
  37         self.device = device
  38
  39     def as_tuple(self):
  40         return (self.gateway, self.device)
  41
  42     def __cmp__(self, other):
  43         if self.gateway == other.gateway \
  44                 and self.device == other.device:
  45             return 0
  46         return cmp(id(self), id(other))
  47
  48 class HopHandler(Handler):
  49
  50     def __init__(self, parent):
  51         self.parent = parent
  52
  53     @handler('Adds a hop : add <gateway> <device>')
  54     def add(self, gw, dev):
  55         if not dev in self.parent.devices:
  56             raise DeviceNotFoundError(device)
  57         h = Hop(gw, dev)
  58         try:
  59             self.parent.hops.index(h)
  60             raise HopAlreadyExistsError(gw  + '->' + dev)
  61         except ValueError:
  62             self.parent.hops.append(h)
  63
  64     @handler(u'Deletes a hop : delete <gateway> <device>')
  65     def delete(self, gw, dev):
  66         if not dev in self.parent.devices:
  67             raise DeviceNotFoundError(device)
  68         h = Hop(gw, dev)
  69         try:
  70             self.parent.hops.remove(h)
  71         except ValueError:
  72             raise HopNotFoundError(gw + '->' + dev)
  73
  74     @handler(u'Lists hops : list <dev>')
  75     def list(self, device):
  76         try:
  77             k = self.parent.hops.keys()
  78         except ValueError:
  79             k = list()
  80         return k
  81
  82     @handler(u'Get information about all hops: show <dev>')
  83     def show(self, device):
  84         try:
  85             k = self.parent.hops.values()
  86         except ValueError:
  87             k = list()
  88         return k
  89
  90 class Route(Sequence):
  91     def __init__(self, net_addr, prefix, gateway):
  92         self.net_addr = net_addr
  93         self.prefix = prefix
  94         self.gateway = gateway
  95     def update(self, net_addr=None, prefix=None, gateway=None):
  96         if net_addr is not None: self.net_addr = net_addr
  97         if prefix is not None: self.prefix = prefix
  98         if gateway is not None: self.gateway = gateway
  99     def as_tuple(self):
 100         return(self.net_addr, self.prefix, self.gateway)
 101
 102 class RouteHandler(ListComposedSubHandler):
 103     handler_help = u"Manage IP routes"
 104     _comp_subhandler_cont = 'devices'
 105     _comp_subhandler_attr = 'routes'
 106     _comp_subhandler_class = Route
 107
 108
 109 class AddressHandler(DictComposedSubHandler):
 110     handler_help = u"Manage IP addresses"
 111     _comp_subhandler_cont = 'devices'
 112     _comp_subhandler_attr = 'addrs'
 113     _comp_subhandler_class = Address
 114
 115
 116 class DeviceHandler(SubHandler):
 117
 118     handler_help = u"Manage network devices"
 119
 120     def __init__(self, parent):
 121         # FIXME remove templates to execute commands
 122         from mako.template import Template
 123         self.parent = parent
 124         template_dir = path.join(path.dirname(__file__), 'templates')
 125         dev_fn = path.join(template_dir, 'device')
 126         self.device_template = Template(filename=dev_fn)
 127
 128     @handler(u'Bring the device up')
 129     def up(self, name):
 130         if name in self.parent.devices:
 131             call(self.device_template.render(dev=name, action='up'), shell=True)
 132             #bring up all the route asocitaed to the device
 133             for route in self.parent.devices[name].routes:
 134                 try:
 135                     call(self.parent._render_config('route_add', dict(
 136                             dev = name,
 137                             net_addr = route.net_addr,
 138                             prefix = route.prefix,
 139                             gateway = route.gateway,
 140                         )
 141                     ), shell=True)
 142                 except ExecutionError, e:
 143                     print e
 144         else:
 145             raise DeviceNotFoundError(name)
 146
 147     @handler(u'Bring the device down')
 148     def down(self, name):
 149         if name in self.parent.devices:
 150             call(self.device_template.render(dev=name, action='down'), shell=True)
 151         else:
 152             raise DeviceNotFoundError(name)
 153
 154     @handler(u'List all devices')
 155     def list(self):
 156         return self.parent.devices.keys()
 157
 158     @handler(u'Get information about a device')
 159     def show(self):
 160         return self.parent.devices.items()
 161
 162 class IpHandler(Restorable, ConfigWriter, TransactionalHandler):
 163
 164     handler_help = u"Manage IP devices, addresses, routes and hops"
 165
 166     _persistent_attrs = ('devices','hops')
 167
 168     _restorable_defaults = dict(
 169                             devices=get_network_devices(),
 170                             hops = list()
 171                             )
 172
 173     _config_writer_files = ('device', 'ip_add', 'ip_del', 'ip_flush',
 174                             'route_add', 'route_del', 'route_flush', 'hop')
 175     _config_writer_tpl_dir = path.join(path.dirname(__file__), 'templates')
 176
 177     def __init__(self, pickle_dir='.', config_dir='.'):
 178         r"Initialize DhcpHandler object, see class documentation for details."
 179         self._persistent_dir = pickle_dir
 180         self._config_writer_cfg_dir = config_dir
 181         self._config_build_templates()
 182         self._restore()
 183         self._write_config()
 184         self.addr = AddressHandler(self)
 185         self.route = RouteHandler(self)
 186         self.dev = DeviceHandler(self)
 187         self.hop = HopHandler(self)
 188         self.services = list()
 189
 190     def _write_config(self):
 191         r"_write_config() -> None :: Execute all commands."
 192         for device in self.devices.values():
 193             if device.active:
 194                 self._write_config_for_device(device)
 195         self._write_hops()
 196
 197     def _write_hops(self):
 198         r"_write_hops() -> None :: Execute all hops."
 199         if self.hops:
 200             try:
 201                 call('ip route del default', shell=True)
 202             except ExecutionError, e:
 203                 print e
 204             try:
 205                 #get hops for active devices
 206                 active_hops = dict()
 207                 for h in self.hops:
 208                     if h.device in self.devices:
 209                         if self.devices[h.device].active:
 210                             active_hops.append(h)
 211                 call(self._render_config('hop', dict(
 212                     hops = active_hops,
 213                         )
 214                 ), shell=True)
 215             except ExecutionError, e:
 216                 print e
 217
 218     def _write_config_for_device(self, device):
 219         r"_write_config_for_device(self, device) -> None :: Execute all commands for a device."
 220         try:
 221             call(self._render_config('route_flush', dict(dev=device.name)), shell=True)
 222         except ExecutionError, e:
 223             print e
 224         try:
 225             call(self._render_config('ip_flush', dict(dev=device.name)), shell=True)
 226         except ExecutionError, e:
 227             print e
 228         for address in device.addrs.values():
 229             broadcast = address.broadcast
 230             if broadcast is None:
 231                 broadcast = '+'
 232             try:
 233                 call(self._render_config('ip_add', dict(
 234                     dev = device.name,
 235                     addr = address.ip,
 236                     netmask = address.netmask,
 237                     peer = address.peer,
 238                     broadcast = broadcast,
 239                     )
 240                 ), shell=True)
 241             except ExecutionError, e:
 242                 print e
 243         for route in device.routes:
 244             try:
 245                 call(self._render_config('route_add', dict(
 246                         dev = device.name,
 247                         net_addr = route.net_addr,
 248                         prefix = route.prefix,
 249                         gateway = route.gateway,
 250                     )
 251                 ), shell=True)
 252             except ExecutionError, e:
 253                 print e
 254
 255     def handle_timer(self):
 256         self.refresh_devices()
 257
 258
 259     def refresh_devices(self):
 260         devices = get_network_devices()
 261         #add not registered and active devices
 262         go_active = False
 263         for k,v in devices.items():
 264             if k not in self.devices:
 265                 self.devices[k] = v
 266             elif not self.devices[k].active:
 267                 self.active = True
 268                 go_active = True
 269                 self._write_config_for_device(self.devices[k])
 270         if go_active:
 271             self._write_hops()
 272             for s in services:
 273                 if s._running:
 274                     try:
 275                         s.stop()
 276                     except ExecutionError:
 277                         pass
 278                     try:
 279                         s.start()
 280                     except ExecutionError:
 281                         pass
 282
 283         #mark inactive devices
 284         for k in self.devices.keys():
 285             if k not in devices:
 286                 self.devices[k].active = False
 287
 288         #hooks a service to the ip handler, so when
 289         #a device is brought up one can restart the service
 290         #that need to refresh their device list
 291         def device_up_hook(self, serv):
 292                 if hasattr(serv, 'stop') and hasattr(serv, 'start'):
 293                         services.append(serv)
 294
 295
 296
 297
 298
 299 if __name__ == '__main__':
 300
 301     ip = IpHanlder()
 302     print '----------------------'
 303     ip.hop.add('201.21.32.53','eth0')
 304     ip.hop.add('205.65.65.25','eth1')
 305     ip.commit()
 306     ip.dev.up('eth0')
 307     ip.addr.add('eth0','192.168.0.23','24','192.168.255.255')
 308     ip.addr.add('eth0','192.168.0.26','24')
 309     ip.commit()
 310     ip.route.add('eth0','192.168.0.0','24','192.168.0.1')
 311     ip.route.add('eth0','192.168.0.5','24','192.168.0.1')
 312     ip.commit()
 313     ip.hop.delete('201.21.32.53','eth0')
 314     ip.route.clear('eth0')
 315     ip.commit()
 316
 317
 318