Remove duplicated code.

[software/pymin.git] / pymin / services / ip / __init__.py

diff --git a/pymin/services/ip/__init__.py b/pymin/services/ip/__init__.py
index 560e2f58747af7b498231ca132c5cc72aff726f6..86551f4ddefdc6b0b62e54ebf270c8a638eba843 100644 (file)
--- a/pymin/services/ip/__init__.py
+++ b/pymin/services/ip/__init__.py
@@ -2,32 +2,17 @@
 
 from subprocess import Popen, PIPE
 from os import path
 
 from subprocess import Popen, PIPE
 from os import path

+import logging ; log = logging.getLogger('pymin.services.ip')

 
 from pymin.seqtools import Sequence
 from pymin.dispatcher import handler, HandlerError, Handler
 from pymin.services.util import Restorable, ConfigWriter, InitdHandler, \
                                 TransactionalHandler, SubHandler, call, \
                                 get_network_devices, ListComposedSubHandler, \
 
 from pymin.seqtools import Sequence
 from pymin.dispatcher import handler, HandlerError, Handler
 from pymin.services.util import Restorable, ConfigWriter, InitdHandler, \
                                 TransactionalHandler, SubHandler, call, \
                                 get_network_devices, ListComposedSubHandler, \

-                                DictComposedSubHandler
+                                DictComposedSubHandler, ListSubHandler, \
+                                Device, Address, ExecutionError

 
 

-__ALL__ = ('IpHandler',)
-
-# TODO: convertir HopHandler a ComposedSubHandler
-
-class HopError(HandlerError):
-
-    def __init__(self, hop):
-        self.message = u'Hop error : "%s"' % hop
-
-class HopNotFoundError(HopError):
-
-    def __init__(self, hop):
-        self.message = u'Hop not found : "%s"' % hop
-
-class HopAlreadyExistsError(HopError):
-
-    def __init__(self, hop):
-        self.message = u'Hop already exists : "%s"' % hop
+__all__ = ('IpHandler',)

 
 
 class Hop(Sequence):
 
 
 class Hop(Sequence):


@@ -45,76 +30,68 @@ class Hop(Sequence):
             return 0
         return cmp(id(self), id(other))
 
             return 0
         return cmp(id(self), id(other))
 

-class HopHandler(Handler):
+class HopHandler(ListSubHandler):
+    handler_help = u"Manage IP hops"
+    _cont_subhandler_attr = 'hops'
+    _cont_subhandler_class = Hop

 
 

-    def __init__(self, parent):
-        self.parent = parent
-
-    @handler('Adds a hop : add <gateway> <device>')
-    def add(self, gw, dev):
+    @handler('Add a hop: add <device> <gateway>')
+    def add(self, dev, gw):

         if not dev in self.parent.devices:
             raise DeviceNotFoundError(device)
         if not dev in self.parent.devices:
             raise DeviceNotFoundError(device)

-        h = Hop(gw, dev)
-        try:
-            self.parent.hops.index(h)
-            raise HopAlreadyExistsError(gw  + '->' + dev)
-        except ValueError:
-            self.parent.hops.append(h)
+        return ListSubHandler.add(self, dev, gw)

 
 

-    @handler(u'Deletes a hop : delete <gateway> <device>')
-    def delete(self, gw, dev):
-        if not dev in self.parent.devices:
-            raise DeviceNotFoundError(device)
-        h = Hop(gw, dev)
-        try:
-            self.parent.hops.remove(h)
-        except ValueError:
-            raise HopNotFoundError(gw + '->' + dev)
-
-    @handler(u'Lists hops : list <dev>')
-    def list(self, device):
-        try:
-            k = self.parent.hops.keys()
-        except ValueError:
-            k = list()
-        return k
-
-    @handler(u'Get information about all hops: show <dev>')
-    def show(self, device):
-        try:
-            k = self.parent.hops.values()
-        except ValueError:
-            k = list()
-        return k

 
 class Route(Sequence):
     def __init__(self, net_addr, prefix, gateway):
         self.net_addr = net_addr
         self.prefix = prefix
         self.gateway = gateway
 
 class Route(Sequence):
     def __init__(self, net_addr, prefix, gateway):
         self.net_addr = net_addr
         self.prefix = prefix
         self.gateway = gateway

+

     def update(self, net_addr=None, prefix=None, gateway=None):
         if net_addr is not None: self.net_addr = net_addr
         if prefix is not None: self.prefix = prefix
         if gateway is not None: self.gateway = gateway
     def update(self, net_addr=None, prefix=None, gateway=None):
         if net_addr is not None: self.net_addr = net_addr
         if prefix is not None: self.prefix = prefix
         if gateway is not None: self.gateway = gateway

+

     def as_tuple(self):
         return(self.net_addr, self.prefix, self.gateway)
 
     def as_tuple(self):
         return(self.net_addr, self.prefix, self.gateway)
 

+    def __cmp__(self, other):
+        if self.net_addr == other.net_addr \
+                and self.prefix == other.prefix \
+                and self.gateway == other.gateway:
+            return 0
+        return cmp(id(self), id(other))
+

 class RouteHandler(ListComposedSubHandler):
     handler_help = u"Manage IP routes"
     _comp_subhandler_cont = 'devices'
     _comp_subhandler_attr = 'routes'
     _comp_subhandler_class = Route
 
 class RouteHandler(ListComposedSubHandler):
     handler_help = u"Manage IP routes"
     _comp_subhandler_cont = 'devices'
     _comp_subhandler_attr = 'routes'
     _comp_subhandler_class = Route
 

-class Address(Sequence):
-    def __init__(self, ip, netmask, broadcast=None):
-        self.ip = ip
-        self.netmask = netmask
-        self.broadcast = broadcast
-    def update(self, netmask=None, broadcast=None):
-        if netmask is not None: self.netmask = netmask
-        if broadcast is not None: self.broadcast = broadcast
-    def as_tuple(self):
-        return (self.ip, self.netmask, self.broadcast)
+    @handler(u'Adds a route to : ip route add <net_addr> <prefix> <gateway> [device]')
+    def add(self, net_addr, prefix, gateway, dev=None):
+        if dev is not None:
+            ListComposedSubHandler.add(self, dev, net_addr, prefix, gateway)
+        else:
+            r = Route(net_addr, prefix, gateway)
+            if not r in self.parent.no_device_routes:
+                self.parent.no_device_routes.append(r)
+
+    @handler("Deletes a route : ip route delete <route_number_in_show> [dev]")
+    def delete(self, index, dev=None):
+        if dev is not None:
+            ListComposedSubHandler.delete(self, dev, index)
+        else:
+            i = int(index)
+            del self.parent.no_device_routes[i]
+
+    @handler("Shows routes : ip route show [dev]")
+    def show(self, dev=None):
+        if dev is not None:
+            return ListComposedSubHandler.show(self, dev)
+        else:
+            return self.parent.no_device_routes

 
 class AddressHandler(DictComposedSubHandler):
     handler_help = u"Manage IP addresses"
 
 class AddressHandler(DictComposedSubHandler):
     handler_help = u"Manage IP addresses"


@@ -122,20 +99,13 @@ class AddressHandler(DictComposedSubHandler):
     _comp_subhandler_attr = 'addrs'
     _comp_subhandler_class = Address
 
     _comp_subhandler_attr = 'addrs'
     _comp_subhandler_class = Address
 

-class Device(Sequence):
-    def __init__(self, name, mac):
-        self.name = name
-        self.mac = mac
-        self.addrs = dict()
-        self.routes = list()
-    def as_tuple(self):
-        return (self.name, self.mac)

 
 class DeviceHandler(SubHandler):
 
     handler_help = u"Manage network devices"
 
     def __init__(self, parent):
 
 class DeviceHandler(SubHandler):
 
     handler_help = u"Manage network devices"
 
     def __init__(self, parent):

+        log.debug(u'DeviceHandler(%r)', parent)

         # FIXME remove templates to execute commands
         from mako.template import Template
         self.parent = parent
         # FIXME remove templates to execute commands
         from mako.template import Template
         self.parent = parent


@@ -145,36 +115,59 @@ class DeviceHandler(SubHandler):
 
     @handler(u'Bring the device up')
     def up(self, name):
 
     @handler(u'Bring the device up')
     def up(self, name):

+        log.debug(u'DeviceHandler.up(%r)', name)

         if name in self.parent.devices:
             call(self.device_template.render(dev=name, action='up'), shell=True)
         if name in self.parent.devices:
             call(self.device_template.render(dev=name, action='up'), shell=True)

+            #bring up all the route asocitaed to the device
+            for route in self.parent.devices[name].routes:
+                try:
+                    log.debug(u'IpHandler.up: adding %r', route)
+                    call(self.parent._render_config('route_add', dict(
+                            dev = name,
+                            net_addr = route.net_addr,
+                            prefix = route.prefix,
+                            gateway = route.gateway,
+                        )
+                    ), shell=True)
+                except ExecutionError, e:
+                    log.debug(u'IpHandler.up: error adding %r -> %r', route, e)
+            self.parent._bring_up_no_dev_routes()
+            self.parent._restart_services()

         else:
         else:

+            log.debug(u'DeviceHandler.up: device not found')

             raise DeviceNotFoundError(name)
 
     @handler(u'Bring the device down')
     def down(self, name):
             raise DeviceNotFoundError(name)
 
     @handler(u'Bring the device down')
     def down(self, name):

+        log.debug(u'DeviceHandler.down(%r)', name)

         if name in self.parent.devices:
             call(self.device_template.render(dev=name, action='down'), shell=True)
         if name in self.parent.devices:
             call(self.device_template.render(dev=name, action='down'), shell=True)

+            self.parent._bring_up_no_dev_routes()
+            self.parent._restart_services()

         else:
         else:

+            log.debug(u'DeviceHandler.up: device not found')

             raise DeviceNotFoundError(name)
 
     @handler(u'List all devices')
     def list(self):
             raise DeviceNotFoundError(name)
 
     @handler(u'List all devices')
     def list(self):

+        log.debug(u'DeviceHandler.list()')

         return self.parent.devices.keys()
 
     @handler(u'Get information about a device')
     def show(self):
         return self.parent.devices.keys()
 
     @handler(u'Get information about a device')
     def show(self):

+        log.debug(u'DeviceHandler.show()')

         return self.parent.devices.items()
 
 class IpHandler(Restorable, ConfigWriter, TransactionalHandler):
 
     handler_help = u"Manage IP devices, addresses, routes and hops"
 
         return self.parent.devices.items()
 
 class IpHandler(Restorable, ConfigWriter, TransactionalHandler):
 
     handler_help = u"Manage IP devices, addresses, routes and hops"
 

-    _persistent_attrs = ('devices','hops')
+    _persistent_attrs = ('devices','hops','no_device_routes')

 
     _restorable_defaults = dict(
 
     _restorable_defaults = dict(

-                            devices=dict((dev, Device(dev, mac))
-                                for (dev, mac) in get_network_devices().items()),
-                            hops = list()
+                            devices=get_network_devices(),
+                            hops = list(),
+                            no_device_routes = list(),

                             )
 
     _config_writer_files = ('device', 'ip_add', 'ip_del', 'ip_flush',
                             )
 
     _config_writer_files = ('device', 'ip_add', 'ip_del', 'ip_flush',


@@ -183,6 +176,7 @@ class IpHandler(Restorable, ConfigWriter, TransactionalHandler):
 
     def __init__(self, pickle_dir='.', config_dir='.'):
         r"Initialize DhcpHandler object, see class documentation for details."
 
     def __init__(self, pickle_dir='.', config_dir='.'):
         r"Initialize DhcpHandler object, see class documentation for details."

+        log.debug(u'IpHandler(%r, %r)', pickle_dir, config_dir)

         self._persistent_dir = pickle_dir
         self._config_writer_cfg_dir = config_dir
         self._config_build_templates()
         self._persistent_dir = pickle_dir
         self._config_writer_cfg_dir = config_dir
         self._config_build_templates()


@@ -192,24 +186,98 @@ class IpHandler(Restorable, ConfigWriter, TransactionalHandler):
         self.route = RouteHandler(self)
         self.dev = DeviceHandler(self)
         self.hop = HopHandler(self)
         self.route = RouteHandler(self)
         self.dev = DeviceHandler(self)
         self.hop = HopHandler(self)

+        self.no_device_routes = list()
+        self.services = list()

 
     def _write_config(self):
         r"_write_config() -> None :: Execute all commands."
 
     def _write_config(self):
         r"_write_config() -> None :: Execute all commands."

+        log.debug(u'IpHandler._write_config()')

         for device in self.devices.values():
         for device in self.devices.values():

-            call(self._render_config('route_flush', dict(dev=device.name)), shell=True)
-            call(self._render_config('ip_flush', dict(dev=device.name)), shell=True)
-            for address in device.addrs.values():
-                broadcast = address.broadcast
-                if broadcast is None:
-                    broadcast = '+'
+            log.debug(u'IpHandler._write_config: processing device %s', device)
+            if device.active:
+                self._write_config_for_device(device)
+        self._bring_up_no_dev_routes()
+        self._write_hops()
+
+    def _bring_up_no_dev_routes(self):
+        log.debug(u'IpHandler._bring_up_no_dev_routes()')
+        for route in self.no_device_routes:
+            try:
+                log.debug(u'IpHandler._bring_up_no_dev_routes: add %r', route)
+                call(self._render_config('route_add', dict(
+                        dev = None,
+                        net_addr = route.net_addr,
+                        prefix = route.prefix,
+                        gateway = route.gateway,
+                    )
+                ), shell=True)
+            except ExecutionError, e:
+                log.debug(u'IpHandler._write_config: error flushing -> %r', e)
+
+    def _write_hops(self):
+        r"_write_hops() -> None :: Execute all hops."
+        log.debug(u'IpHandler._write_hops()')
+        if self.hops:
+            log.debug(u'IpHandler._write_hops: we have hops: %r', self.hops)
+            try:
+                log.debug(u'IpHandler._write_hops: flushing default hops')
+                call('ip route del default', shell=True)
+            except ExecutionError, e:
+                log.debug(u'IpHandler._write_hops: error adding -> %r', e)
+            try:
+                log.debug(u'IpHandler._write_hops: configuring hops')
+                #get hops for active devices
+                active_hops = dict()
+                for h in self.hops:
+                    if h.device in self.devices:
+                        if self.devices[h.device].active:
+                            active_hops.append(h)
+                call(self._render_config('hop', dict(
+                    hops = active_hops,
+                        )
+                ), shell=True)
+            except ExecutionError, e:
+                log.debug(u'IpHandler._write_hops: error adding -> %r', e)
+
+    def _write_config_for_device(self, device):
+        r"_write_config_for_device(self, device) -> None :: Execute commands."
+        log.debug(u'IpHandler._write_config_for_device()')
+        try:
+            log.debug(u'IpHandler._write_config_for_device: flushing routes...')
+            call(self._render_config('route_flush', dict(dev=device.name)),
+                        shell=True)
+        except ExecutionError, e:
+            log.debug(u'IpHandler._write_config_for_device: error flushing '
+                        u'-> %r', e)
+        try:
+            log.debug(u'IpHandler._write_config_for_device: flushing addrs...')
+            call(self._render_config('ip_flush', dict(dev=device.name)),
+                        shell=True)
+        except ExecutionError, e:
+            log.debug(u'IpHandler._write_config_for_device: error flushing '
+                        u'-> %r', e)
+        for address in device.addrs.values():
+            broadcast = address.broadcast
+            if broadcast is None:
+                broadcast = '+'
+            try:
+                log.debug(u'IpHandler._write_config_for_device: adding %r',
+                            address)

                 call(self._render_config('ip_add', dict(
                 call(self._render_config('ip_add', dict(

-                        dev = device.name,
-                        addr = address.ip,
-                        netmask = address.netmask,
-                        broadcast = broadcast,
+                    dev = device.name,
+                    addr = address.ip,
+                    netmask = address.netmask,
+                    peer = address.peer,
+                    broadcast = broadcast,

                     )
                 ), shell=True)
                     )
                 ), shell=True)

-            for route in device.routes:
+            except ExecutionError, e:
+                log.debug(u'IpHandler._write_config_for_device: error adding '
+                            u'-> %r', e)
+        for route in device.routes:
+            try:
+                log.debug(u'IpHandler._write_config_for_device: adding %r',
+                            route)

                 call(self._render_config('route_add', dict(
                         dev = device.name,
                         net_addr = route.net_addr,
                 call(self._render_config('route_add', dict(
                         dev = device.name,
                         net_addr = route.net_addr,


@@ -217,35 +285,74 @@ class IpHandler(Restorable, ConfigWriter, TransactionalHandler):
                         gateway = route.gateway,
                     )
                 ), shell=True)
                         gateway = route.gateway,
                     )
                 ), shell=True)

-
-        if self.hops:
-            call('ip route del default', shell=True)
-            call(self._render_config('hop', dict(
-                        hops = self.hops,
-                    )
-                 ), shell=True)
-
+            except ExecutionError, e:
+                log.debug(u'IpHandler._write_config_for_device: error adding '
+                            u'-> %r', e)

 
     def handle_timer(self):
 
     def handle_timer(self):

+        log.debug(u'IpHandler.handle_timer()')

         self.refresh_devices()
 
         self.refresh_devices()
 

-

     def refresh_devices(self):
     def refresh_devices(self):

+        log.debug(u'IpHandler.update_devices()')

         devices = get_network_devices()
         devices = get_network_devices()

-        #add not registered devices
+        #add not registered and active devices
+        go_active = False

         for k,v in devices.items():
             if k not in self.devices:
         for k,v in devices.items():
             if k not in self.devices:

-                self.devices[k] = Device(k,v)
-        #delete dead devices
+                log.debug(u'IpHandler.update_devices: adding %r', v)
+                self.devices[k] = v
+            elif not self.devices[k].active:
+                self.active = True
+                go_active = True
+                self._write_config_for_device(self.devices[k])
+        if go_active:
+            self._write_hops()
+            self._bring_up_no_dev_routes()
+            self._restart_services()
+
+        #mark inactive devices

         for k in self.devices.keys():
         for k in self.devices.keys():

+            go_down = False

             if k not in devices:
             if k not in devices:

-                del self.devices[k]
+                log.debug(u'IpHandler.update_devices: removing %s', k)
+                self.devices[k].active = False
+                go_down = True
+            if go_down:
+                self._bring_up_no_dev_routes()
+
+    def _restart_services(self):
+        for s in self.services:
+            if s._service_running:
+                try:
+                     s.stop()
+                except ExecutionError:
+                    pass
+                try:
+                    s.start()
+                except ExecutionError:
+                    pass
+
+       #hooks a service to the ip handler, so when
+       #a device is brought up one can restart the service
+       #that need to refresh their device list
+    def device_up_hook(self, serv):
+        if hasattr(serv, 'stop') and hasattr(serv, 'start'):
+            self.services.append(serv)
+
+

 
 
 
 if __name__ == '__main__':
 
 
 
 
 if __name__ == '__main__':
 

-    ip = IpHanlder()
+    logging.basicConfig(
+        level   = logging.DEBUG,
+        format  = '%(asctime)s %(levelname)-8s %(message)s',
+        datefmt = '%H:%M:%S',
+    )
+
+    ip = IpHandler()

     print '----------------------'
     ip.hop.add('201.21.32.53','eth0')
     ip.hop.add('205.65.65.25','eth1')
     print '----------------------'
     ip.hop.add('201.21.32.53','eth0')
     ip.hop.add('205.65.65.25','eth1')