]> git.llucax.com Git - software/pymin.git/blobdiff - services/ip/__init__.py
Add configuration and command-line option framework.
[software/pymin.git] / services / ip / __init__.py
index c2fff476e800f0449ebe5a1125362bb59ad26537..8ce72f78b60d305d2322eacc89fe4a02b0c3dae4 100644 (file)
 # vim: set encoding=utf-8 et sw=4 sts=4 :
 
 # vim: set encoding=utf-8 et sw=4 sts=4 :
 
-from mako.template import Template
-from mako.runtime import Context
-from os import path
-try:
-    import cPickle as pickle
-except ImportError:
-    import pickle
+from formencode import validators as V
+from pymin.config import Option
+from handler import IpHandler
 
 
-try:
-    from seqtools import Sequence
-except ImportError:
-    # NOP for testing
-    class Sequence: pass
-try:
-    from dispatcher import handler, HandlerError
-except ImportError:
-    # NOP for testing
-    class HandlerError(RuntimeError): pass
-    def handler(f): return f
+def setup_service(options, config):
+    options.add_group('ip', 'IP network interfaces', [
+        Option('pickle_dir', V.String, metavar='DIR',
+               help='store persistent data in DIR directory'),
+        Option('config_dir', V.String, metavar='DIR',
+               help='write config files in DIR directory'),
+    ])
 
 
-__ALL__ = ('IpHandler',)
+def get_service(config):
+    return IpHandler(config.ip.pickle_dir, config.ip.config_dir)
 
 
-pickle_ext = '.pkl'
-pickle_devices = 'devs'
-
-template_dir = path.join(path.dirname(__file__), 'templates')
-command_filename = 'command'
-
-
-device_com = 'device.command'
-ip_add_com = 'ip_add.command'
-ip_del_com = 'ip_del.command'
-ip_flush_com = 'ip_flush.command'
-route_add_com = 'route_add.command'
-route_del_com = 'route_del.command'
-route_flush_com = 'route_flush.command'
-
-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.
-
-    message - A descriptive error message.
-    """
-
-    def __init__(self, message):
-        r"Initialize the Error object. See class documentation for more info."
-        self.message = message
-
-    def __str__(self):
-        return self.message
-
-class DeviceError(Error):
-
-    def __init__(self, device):
-        self.message = 'Device error : "%s"' % device
-
-class DeviceNotFoundError(DeviceError):
-
-    def __init__(self, device):
-        self.message = 'Device not found : "%s"' % device
-
-class AddressError(Error):
-
-    def __init__(self, addr):
-        self.message = 'Address error : "%s"' % addr
-
-class AddressNotFoundError(AddressError):
-
-    def __init__(self, address):
-        self.message = 'Address not found : "%s"' % address
-
-class AddressAlreadyExistsError(AddressError):
-
-    def __init__(self, address):
-        self.message = 'Address already exists : "%s"' % address
-
-class RouteError(Error):
-
-    def __init__(self, route):
-        self.message = 'Route error : "%s"' % route
-
-class RouteNotFoundError(RouteError):
-
-    def __init__(self, route):
-        self.message = 'Route not found : "%s"' % route
-
-class RouteAlreadyExistsError(RouteError):
-
-    def __init__(self, route):
-        self.message = 'Route already exists : "%s"' % route
-
-class Route(Sequence):
-
-    def __init__(self, net_addr, prefix, gateway):
-        self.net_addr = net_addr
-        self.prefix = prefix
-        self.gateway = gateway
-
-    def as_tuple(self):
-        return(self.addr, self.prefix, self.gateway)
-
-class RouteHandler:
-
-    def __init__(self, devices, config_dir, ip_handler):
-        self.devices = devices
-        route_add_fn = path.join(template_dir, route_add_com)
-        route_del_fn = path.join(template_dir, route_del_com)
-        route_flush_fn = path.join(template_dir, route_flush_com)
-        self.route_add_template = Template(filename=route_add_fn)
-        self.route_del_template = Template(filename=route_del_fn)
-        self.route_flush_template = Template(filename=route_flush_fn)
-        self.config_dir = config_dir
-        self.ip_handler = ip_handler
-
-    @handler
-    def add(self, device, net_addr, prefix, gateway):
-        if not device in self.devices:
-            raise DeviceNotFoundError(device)
-        r = Route(net_addr, prefix, gateway)
-        try:
-            self.devices[device].routes.index(r)
-            raise RouteAlreadyExistsError(net_addr + '/' + prefix + '->' + gateway)
-        except ValueError:
-            out_file = file(path.join(self.config_dir, command_filename), 'w')
-            ctx = Context(out_file, dev=device, net_addr=net_addr, prefix=prefix, gateway=gateway)
-            self.route_add_template.render_context(ctx)
-            out_file.close()
-            execute_command(self.config_dir)
-            self.devices[device].routes.append(r)
-            self.ip_handler.commit()
-
-
-    @handler
-    def delete(self, device, net_addr, prefix, gateway):
-        if not device in self.devices:
-            raise DeviceNotFoundError(device)
-        r = Route(net_addr, prefix, gateway)
-        #try:
-            #i = self.devices[device].routes.index(r)
-            #out_file = file(path.join(self.config_dir, command_filename), 'w')
-            #ctx = Context(out_file, dev=device, net_addr=net_addr, prefix=prefix, gateway=gateway)
-            #self.route_add_template.render_context(ctx)
-            #out_file.close()
-            #execute_command(self.config_dir)
-            #self.devices[device].routes.append(r)
-            #self.ip_handler.commit()
-
-        #except ValueError:
-            #raise RouteNotFoundError(net_addr + '/' + prefix + '->' + gateway)
-
-    @handler
-    def flush(self, device):
-        if not device in self.devices:
-            raise DeviceNotFoundError(device)
-        out_file = file(path.join(self.config_dir, command_filename), 'w')
-        ctx = Context(out_file, dev=device)
-        self.route_flush_template.render_context(ctx)
-        out_file.close()
-        execute_command(self.config_dir)
-        self.devices[device].routes = list()
-        self.ip_handler.commit()
-
-    @handler
-    def list(self, device):
-        try:
-            k = self.devices[device].routes.keys()
-        except ValueError:
-            k = list()
-        return k
-
-    @handler
-    def show(self):
-        try:
-            k = self.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:
-
-    def __init__(self, devices, config_dir, ip_handler):
-        self.devices = devices
-        self.config_dir = config_dir
-        ip_add_fn = path.join(template_dir, ip_add_com)
-        ip_del_fn = path.join(template_dir, ip_del_com)
-        ip_flush_fn = path.join(template_dir, ip_flush_com)
-        self.ip_add_template = Template(filename=ip_add_fn)
-        self.ip_del_template = Template(filename=ip_del_fn)
-        self.ip_flush_template = Template(filename=ip_flush_fn)
-        self.ip_handler = ip_handler
-
-
-    @handler
-    def add(self, device, ip, prefix, broadcast='+'):
-        if not device in self.devices:
-            raise DeviceNotFoundError(device)
-        if ip in self.devices[device].addrs:
-            raise AddressAlreadyExistsError(ip)
-        out_file = file(path.join(self.config_dir, command_filename), 'w')
-        ctx = Context(out_file, dev=device, addr=ip, prefix=prefix, broadcast=broadcast)
-        self.ip_add_template.render_context(ctx)
-        out_file.close()
-        execute_command(self.config_dir)
-        self.devices[device].addrs[ip] = Address(ip, prefix, broadcast)
-        self.ip_handler.commit()
-
-    @handler
-    def delete(self, device, ip):
-        if not device in self.devices:
-            raise DeviceNotFoundError(device)
-        if not ip in self.devices[device].addrs:
-            raise AddressNotFoundError(ip)
-        out_file = file(path.join(self.config_dir, command_filename), 'w')
-        ctx = Context(out_file, dev=device, addr=ip, prefix=self.devices[device].addrs[ip].prefix)
-        self.ip_del_template.render_context(ctx)
-        out_file.close()
-        execute_command(self.config_dir)
-        del self.devices[device].addrs[ip]
-        self.ip_handler.commit()
-
-
-    @handler
-    def flush(self, device):
-        if not device in self.devices:
-            raise DeviceNotFoundError(device)
-        out_file = file(path.join(self.config_dir, command_filename), 'w')
-        ctx = Context(out_file, dev=device)
-        self.ip_flush_template.render_context(ctx)
-        out_file.close()
-        execute_command(self.config_dir)
-        self.devices[device].addrs = dict()
-        self.ip_handler.commit()
-
-
-    @handler
-    def list(self, device):
-        try:
-            k = self.devices[device].addrs.keys()
-        except ValueError:
-            k = list()
-        return k
-
-    @handler
-    def show(self, device):
-        try:
-            k = self.devices[device].addrs.values()
-        except ValueError:
-            k = list()
-        return k
-
-class Device(Sequence):
-
-    def __init__(self, name):
-        self.name = name
-        self.addrs = dict()
-        self.routes = list()
-
-    def as_tuple(self):
-        return (self.name, self.addrs, self.routes)
-
-class DeviceHandler:
-
-    def __init__(self, devices, config_dir = '.'):
-        self.devices = devices
-        dev_fn = path.join(template_dir, device_com)
-        self.device_template = Template(filename=dev_fn)
-        self.config_dir = config_dir
-
-    @handler
-    def up(self, name):
-        if name in self.devices:
-            out_file = file(path.join(self.config_dir, command_filename), 'w')
-            ctx = Context(out_file, dev=name, action='up')
-            self.device_template.render_context(ctx)
-            out_file.close()
-            execute_command(self.config_dir)
-        else:
-            raise DeviceNotFoundError(name)
-
-    @handler
-    def down(self, name):
-        if name in self.devices:
-            out_file = file(path.join(self.config_dir, command_filename), 'w')
-            ctx = Context(out_file, dev=name, action='down')
-            self.device_template.render_context(ctx)
-            out_file.close()
-            execute_command(self.config_dir)
-        else:
-            raise DeviceNotFoundError(name)
-
-    @handler
-    def list(self):
-        return self.devices.keys()
-
-    @handler
-    def show(self):
-        return self.devices.items()
-
-def execute_command(config_dir):
-    out_file = file(path.join(config_dir, command_filename), 'r')
-    print out_file.read()
-    out_file.close()
-
-class IpHandler:
-
-    def __init__(self, pickle_dir='.', config_dir='.'):
-        r"Initialize DhcpHandler object, see class documentation for details."
-
-        self.pickle_dir = pickle_dir
-        self.config_dir = config_dir
-
-        try:
-            self._load()
-        except IOError:
-            # This is the first time the handler is used, create a basic
-            # setup using some nice defaults
-            self.devices = dict(
-                eth0=Device('eth0'),
-                eth1=Device('eth1'),
-                )
-            self._dump()
-        self.addr = AddressHandler(self.devices, config_dir, self)
-        self.route = RouteHandler(self.devices, config_dir, self)
-        self.dev = DeviceHandler(self.devices, config_dir)
-        self._write_config()
-
-    def commit(self):
-        r"commit() -> None :: Commit the changes and reload the DHCP service."
-        #esto seria para poner en una interfaz
-        #y seria que hace el pickle deberia llamarse
-        #al hacerse un commit
-        self._dump()
-        self._write_config()
-
-    @handler
-    def rollback(self):
-        r"rollback() -> None :: Discard the changes not yet commited."
-        self._load()
-
-    def _dump(self):
-        r"_dump() -> None :: Dump all persistent data to pickle files."
-        # XXX podría ir en una clase base
-        self._dump_var(self.devices, pickle_devices)
-
-
-    def _load(self):
-        r"_load() -> None :: Load all persistent data from pickle files."
-        # XXX podría ir en una clase base
-        self.devices = self._load_var(pickle_devices)
-
-    def _pickle_filename(self, name):
-        r"_pickle_filename() -> string :: Construct a pickle filename."
-        # XXX podría ir en una clase base
-        return path.join(self.pickle_dir, name) + pickle_ext
-
-    def _dump_var(self, var, name):
-        r"_dump_var() -> None :: Dump a especific variable to a pickle file."
-        # XXX podría ir en una clase base
-        pkl_file = file(self._pickle_filename(name), 'wb')
-        pickle.dump(var, pkl_file, 2)
-        pkl_file.close()
-
-    def _load_var(self, name):
-        r"_load_var() -> object :: Load a especific pickle file."
-        # XXX podría ir en una clase base
-        return pickle.load(file(self._pickle_filename(name)))
-
-    def _write_config(self):
-        r"_write_config() -> None :: Execute all commands."
-        pass
-
-
-
-
-if __name__ == '__main__':
-
-    ip = IpHandler()
-    ip.dev.up('eth0')
-    ip.dev.down('eth0')
-    ip.dev.show()
-    ip.addr.add('eth0','192.168.0.23','24','192.168.255.255')
-    ip.addr.add('eth0','192.168.0.26','24')
-    ip.addr.show('eth0')
-    ip.addr.flush('eth0')
-    ip.route.add('eth0','192.168.0.0','24','192.168.0.1')
-    ip.route.flush('eth0')
-    #ip.addr.delete('eth0','192.168.0.23')
-    #ip.addr.delete('eth0','192.168.0.26')
\ No newline at end of file