X-Git-Url: https://git.llucax.com/software/pymin.git/blobdiff_plain/7012b07c7b88ece1a0a08c53ca5a07c81209d2e6..07d6251c69d26b80b47ff012c3e44b7e4a366df4:/pymin/services/ip/__init__.py?ds=sidebyside diff --git a/pymin/services/ip/__init__.py b/pymin/services/ip/__init__.py index db29c77..86551f4 100644 --- a/pymin/services/ip/__init__.py +++ b/pymin/services/ip/__init__.py @@ -2,77 +2,59 @@ 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, call + TransactionalHandler, SubHandler, call, \ + get_network_devices, ListComposedSubHandler, \ + DictComposedSubHandler, ListSubHandler, \ + Device, Address, ExecutionError -__ALL__ = ('IpHandler', 'Error','DeviceError', 'DeviceNotFoundError', - 'RouteError', 'RouteNotFoundError', 'RouteAlreadyExistsError', - 'AddressError', 'AddressNotFoundError', 'AddressAlreadyExistsError') +__all__ = ('IpHandler',) -class Error(HandlerError): - r""" - Error(command) -> Error instance :: Base IpHandler exception class. - All exceptions raised by the IpHandler inherits from this one, so you can - easily catch any IpHandler exception. +class Hop(Sequence): - message - A descriptive error message. - """ - pass - -class DeviceError(Error): - - def __init__(self, device): - self.message = u'Device error : "%s"' % device - -class DeviceNotFoundError(DeviceError): - - def __init__(self, device): - self.message = u'Device not found : "%s"' % device - -class AddressError(Error): - - def __init__(self, addr): - self.message = u'Address error : "%s"' % addr - -class AddressNotFoundError(AddressError): - - def __init__(self, address): - self.message = u'Address not found : "%s"' % address - -class AddressAlreadyExistsError(AddressError): - - def __init__(self, address): - self.message = u'Address already exists : "%s"' % address - -class RouteError(Error): - - def __init__(self, route): - self.message = u'Route error : "%s"' % route + def __init__(self, gateway, device): + self.gateway = gateway + self.device = device -class RouteNotFoundError(RouteError): + def as_tuple(self): + return (self.gateway, self.device) - def __init__(self, route): - self.message = u'Route not found : "%s"' % route + def __cmp__(self, other): + if self.gateway == other.gateway \ + and self.device == other.device: + return 0 + return cmp(id(self), id(other)) -class RouteAlreadyExistsError(RouteError): +class HopHandler(ListSubHandler): + handler_help = u"Manage IP hops" + _cont_subhandler_attr = 'hops' + _cont_subhandler_class = Hop - def __init__(self, route): - self.message = u'Route already exists : "%s"' % route + @handler('Add a hop: add ') + def add(self, dev, gw): + if not dev in self.parent.devices: + raise DeviceNotFoundError(device) + return ListSubHandler.add(self, dev, gw) 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 as_tuple(self): - return(self.addr, self.prefix, self.gateway) + return(self.net_addr, self.prefix, self.gateway) def __cmp__(self, other): if self.net_addr == other.net_addr \ @@ -81,130 +63,49 @@ class Route(Sequence): return 0 return cmp(id(self), id(other)) -class RouteHandler(Handler): - +class RouteHandler(ListComposedSubHandler): handler_help = u"Manage IP routes" + _comp_subhandler_cont = 'devices' + _comp_subhandler_attr = 'routes' + _comp_subhandler_class = Route + + @handler(u'Adds a route to : ip route add [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 [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] - def __init__(self, parent): - self.parent = parent - - @handler(u'Adds a route to a device') - def add(self, device, net_addr, prefix, gateway): - if not device in self.parent.devices: - raise DeviceNotFoundError(device) - r = Route(net_addr, prefix, gateway) - try: - self.parent.devices[device].routes.index(r) - raise RouteAlreadyExistsError(net_addr + '/' + prefix + '->' + gateway) - except ValueError: - self.parent.devices[device].routes.append(r) - - @handler(u'Deletes a route from a device') - def delete(self, device, net_addr, prefix, gateway): - if not device in self.parent.devices: - raise DeviceNotFoundError(device) - r = Route(net_addr, prefix, gateway) - try: - self.parent.devices[device].routes.remove(r) - except ValueError: - raise RouteNotFoundError(net_addr + '/' + prefix + '->' + gateway) - - @handler(u'Flushes routes from a device') - def flush(self, device): - if not device in self.parent.devices: - raise DeviceNotFoundError(device) - self.parent.devices[device].routes = list() - - - @handler(u'List routes') - def list(self, device): - try: - k = self.parent.devices[device].routes.keys() - except ValueError: - k = list() - return k - - @handler(u'Get information about all routes') - def show(self): - try: - k = self.parent.devices[device].routes.values() - except ValueError: - k = list() - return k - - -class Address(Sequence): - - def __init__(self, ip, prefix, broadcast): - self.ip = ip - self.prefix = prefix - self.broadcast = broadcast - - def as_tuple(self): - return (self.ip, self.prefix, self.broadcast) - -class AddressHandler(Handler): + @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" + _comp_subhandler_cont = 'devices' + _comp_subhandler_attr = 'addrs' + _comp_subhandler_class = Address - def __init__(self, parent): - self.parent = parent - - @handler(u'Adds an address to a device') - def add(self, device, ip, prefix, broadcast='+'): - if not device in self.parent.devices: - raise DeviceNotFoundError(device) - if ip in self.parent.devices[device].addrs: - raise AddressAlreadyExistsError(ip) - self.parent.devices[device].addrs[ip] = Address(ip, prefix, broadcast) - - @handler(u'Deletes an address from a device') - def delete(self, device, ip): - if not device in self.parent.devices: - raise DeviceNotFoundError(device) - if not ip in self.parent.devices[device].addrs: - raise AddressNotFoundError(ip) - del self.parent.devices[device].addrs[ip] - - @handler(u'Flushes addresses from a device') - def flush(self, device): - if not device in self.parent.devices: - raise DeviceNotFoundError(device) - self.parent.devices[device].addrs = dict() - - @handler(u'List all addresses from a device') - def list(self, device): - try: - k = self.parent.devices[device].addrs.keys() - except ValueError: - k = list() - return k - - @handler(u'Get information about addresses from a device') - def show(self, device): - try: - k = self.parent.devices[device].addrs.values() - except ValueError: - k = list() - return k - - -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(Handler): +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 @@ -214,77 +115,169 @@ class DeviceHandler(Handler): @handler(u'Bring the device up') def up(self, name): - if name in self.devices: + log.debug(u'DeviceHandler.up(%r)', name) + 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: + log.debug(u'DeviceHandler.up: device not found') raise DeviceNotFoundError(name) @handler(u'Bring the device down') def down(self, name): - if name in self.devices: + log.debug(u'DeviceHandler.down(%r)', name) + 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: + log.debug(u'DeviceHandler.up: device not found') raise DeviceNotFoundError(name) @handler(u'List all devices') def list(self): - return self.devices.keys() + log.debug(u'DeviceHandler.list()') + return self.parent.devices.keys() @handler(u'Get information about a device') def show(self): - return self.devices.items() - - -def get_devices(): - p = Popen(('ip', 'link', 'list'), stdout=PIPE, close_fds=True) - string = p.stdout.read() - p.wait() - d = dict() - i = string.find('eth') - while i != -1: - eth = string[i:i+4] - m = string.find('link/ether', i+4) - mac = string[ m+11 : m+11+17] - d[eth] = Device(eth, mac) - i = string.find('eth', m+11+17) - return d + log.debug(u'DeviceHandler.show()') + 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','no_device_routes') - _restorable_defaults = dict(devices=get_devices()) + _restorable_defaults = dict( + devices=get_network_devices(), + hops = list(), + no_device_routes = list(), + ) _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." + 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._write_config() self.addr = AddressHandler(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." + log.debug(u'IpHandler._write_config()') 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(): + 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( - dev = device.name, - addr = address.ip, - prefix = address.prefix, - broadcast = address.broadcast, + dev = device.name, + addr = address.ip, + netmask = address.netmask, + peer = address.peer, + broadcast = broadcast, ) ), 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, @@ -292,12 +285,78 @@ class IpHandler(Restorable, ConfigWriter, TransactionalHandler): gateway = route.gateway, ) ), shell=True) + except ExecutionError, e: + log.debug(u'IpHandler._write_config_for_device: error adding ' + u'-> %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 and active devices + go_active = False + 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 + 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(): + go_down = False + if k not in devices: + 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__': + 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') + 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') @@ -305,11 +364,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.flush('eth0') + ip.hop.delete('201.21.32.53','eth0') + ip.route.clear('eth0') ip.commit() - ip.addr.delete('eth0','192.168.0.23') - ip.commit() -