Add logging to pymin.services.proxy module.

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

diff --git a/pymin/services/ip/__init__.py b/pymin/services/ip/__init__.py
index 94d681b7ccae135f6d5e6280f58f35ef10acb6c2..71354abdbba6983ce20618ec4bed4a17261c01db 100644 (file)
--- a/pymin/services/ip/__init__.py
+++ b/pymin/services/ip/__init__.py
@@ -2,16 +2,93 @@
 
 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, Device, Address, \
+                                ExecutionError

 
 __ALL__ = ('IpHandler',)
 
 
 __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
+
+
+class Hop(Sequence):
+
+    def __init__(self, gateway, device):
+        self.gateway = gateway
+        self.device = device
+
+    def as_tuple(self):
+        return (self.gateway, self.device)
+
+    def __cmp__(self, other):
+        if self.gateway == other.gateway \
+                and self.device == other.device:
+            return 0
+        return cmp(id(self), id(other))
+
+class HopHandler(Handler):
+
+    def __init__(self, parent):
+        self.parent = parent
+
+    @handler('Adds a hop : add <gateway> <device>')
+    def add(self, gw, dev):
+        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)
+
+    @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
 class Route(Sequence):
     def __init__(self, net_addr, prefix, gateway):
         self.net_addr = net_addr


@@ -30,16 +107,6 @@ class RouteHandler(ListComposedSubHandler):
     _comp_subhandler_attr = 'routes'
     _comp_subhandler_class = Route
 
     _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)

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


@@ -47,20 +114,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


@@ -70,76 +130,152 @@ 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)
         else:
         if name in self.parent.devices:
             call(self.device_template.render(dev=name, action='up'), shell=True)
         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)
         else:
         if name in self.parent.devices:
             call(self.device_template.render(dev=name, action='down'), shell=True)
         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):
 
         return self.parent.devices.items()
 
 class IpHandler(Restorable, ConfigWriter, TransactionalHandler):
 

-    handler_help = u"Manage IP devices, addresses and routes"
+    handler_help = u"Manage IP devices, addresses, routes and hops"

 
 

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

 
 

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

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

-                            'route_add', 'route_del', 'route_flush')
+                            'route_add', 'route_del', 'route_flush', 'hop')

     _config_writer_tpl_dir = path.join(path.dirname(__file__), 'templates')
 
     def __init__(self, pickle_dir='.', config_dir='.'):
         r"Initialize DhcpHandler object, see class documentation for details."
     _config_writer_tpl_dir = path.join(path.dirname(__file__), 'templates')
 
     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._restore()
         self._persistent_dir = pickle_dir
         self._config_writer_cfg_dir = config_dir
         self._config_build_templates()
         self._restore()

+        self._write_config()

         self.addr = AddressHandler(self)
         self.route = RouteHandler(self)
         self.dev = DeviceHandler(self)
         self.addr = AddressHandler(self)
         self.route = RouteHandler(self)
         self.dev = DeviceHandler(self)

+        self.hop = HopHandler(self)

 
     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)
+            log.debug(u'IpHandler._write_config: processing device %s', device)
+            try:
+                log.debug(u'IpHandler._write_config: flushing routes...')
+                call(self._render_config('route_flush', dict(dev=device.name)),
+                        shell=True)
+            except ExecutionError, e:
+                log.debug(u'IpHandler._write_config: error flushing -> %r', e)
+            try:
+                log.debug(u'IpHandler._write_config: flushing addrs...')
+                call(self._render_config('ip_flush', dict(dev=device.name)),
+                        shell=True)
+            except ExecutionError, e:
+                log.debug(u'IpHandler._write_config: error flushing -> %r', e)

             for address in device.addrs.values():
             for address in device.addrs.values():

-                call(self._render_config('ip_add', dict(
-                        dev = device.name,
-                        addr = address.ip,
-                        netmask = address.netmask,
-                        broadcast = address.broadcast,
-                    )
-                ), shell=True)
+                broadcast = address.broadcast
+                if broadcast is None:
+                    broadcast = '+'
+                try:
+                    log.debug(u'IpHandler._write_config: adding %r', address)
+                    call(self._render_config('ip_add', dict(
+                            dev = device.name,
+                            addr = address.ip,
+                            netmask = address.netmask,
+                            peer = address.peer,
+                            broadcast = broadcast,
+                        )), shell=True)
+                except ExecutionError, e:
+                    log.debug(u'IpHandler._write_config: error adding -> %r', e)

             for route in device.routes:
             for route in device.routes:

-                call(self._render_config('route_add', dict(
-                        dev = device.name,
-                        net_addr = route.net_addr,
-                        prefix = route.prefix,
-                        gateway = route.gateway,
-                    )
+                try:
+                    log.debug(u'IpHandler._write_config: adding %r', route)
+                    call(self._render_config('route_add', dict(
+                            dev = device.name,
+                            net_addr = route.net_addr,
+                            prefix = route.prefix,
+                            gateway = route.gateway,
+                        )), shell=True)
+                except ExecutionError, e:
+                    log.debug(u'IpHandler._write_config: error adding -> %r', e)
+        if self.hops:
+            log.debug(u'IpHandler._write_config: we have hops: %r', self.hops)
+            try:
+                log.debug(u'IpHandler._write_config: flushing default route')
+                call('ip route del default', shell=True)
+            except ExecutionError, e:
+                log.debug(u'IpHandler._write_config: error adding -> %r', e)
+            try:
+                log.debug(u'IpHandler._write_config: configuring hops')
+                call(self._render_config('hop', dict(
+                    hops = self.hops,
+                        )

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

+            except ExecutionError, e:
+                log.debug(u'IpHandler._write_config: error adding -> %r', e)
+
+    def handle_timer(self):
+        log.debug(u'IpHandler.handle_timer()')
+        self.refresh_devices()
+
+    def refresh_devices(self):
+        log.debug(u'IpHandler.update_devices()')
+        devices = get_network_devices()
+        #add not registered devices
+        for k,v in devices.items():
+            if k not in self.devices:
+                log.debug(u'IpHandler.update_devices: adding %r', v)
+                self.devices[k] = v
+        #delete dead devices
+        for k in self.devices.keys():
+            if k not in devices:
+                log.debug(u'IpHandler.update_devices: removing %s', k)
+                del self.devices[k]
+

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

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

     ip = IpHandler()
     print '----------------------'
     ip = IpHandler()
     print '----------------------'

+    ip.hop.add('201.21.32.53','eth0')
+    ip.hop.add('205.65.65.25','eth1')
+    ip.commit()

     ip.dev.up('eth0')
     ip.addr.add('eth0','192.168.0.23','24','192.168.255.255')
     ip.addr.add('eth0','192.168.0.26','24')
     ip.dev.up('eth0')
     ip.addr.add('eth0','192.168.0.23','24','192.168.255.255')
     ip.addr.add('eth0','192.168.0.26','24')


@@ -147,11 +283,9 @@ if __name__ == '__main__':
     ip.route.add('eth0','192.168.0.0','24','192.168.0.1')
     ip.route.add('eth0','192.168.0.5','24','192.168.0.1')
     ip.commit()
     ip.route.add('eth0','192.168.0.0','24','192.168.0.1')
     ip.route.add('eth0','192.168.0.5','24','192.168.0.1')
     ip.commit()

+    ip.hop.delete('201.21.32.53','eth0')

     ip.route.clear('eth0')
     ip.commit()
     ip.route.clear('eth0')
     ip.commit()

-    ip.addr.delete('eth0','192.168.0.23')
-    ip.commit()
-