]> git.llucax.com Git - software/pymin.git/blobdiff - services/dns/__init__.py
Remove plug-in code from handler module in services (refs #27).
[software/pymin.git] / services / dns / __init__.py
index 6bc45e82ded0cead0ed355c54a2216890384fa38..1b5e4e59396b05bc11b7770000f1afd1dbf7e197 100644 (file)
@@ -1,691 +1,7 @@
 # vim: set encoding=utf-8 et sw=4 sts=4 :
 
-# TODO COMMENT
-from mako.template import Template
-from mako.runtime import Context
-from os import path
-from os import unlink
+from handler import DnsHandler
 
-try:
-    import cPickle as pickle
-except ImportError:
-    import pickle
+def get_service(config):
+    return DnsHandler(config.dns.pickle_dir, config.dns.config_dir)
 
-try:
-    from seqtools import Sequence
-except ImportError:
-    # NOP for testing
-    class Sequence: pass
-
-try:
-    from dispatcher import handler, HandlerError
-except ImportError:
-    class HandlerError(RuntimeError): pass
-    def handler(f): return f # NOP for testing
-
-
-
-__ALL__ = ('DnsHandler',)
-
-pickle_ext = '.pkl'
-
-pickle_vars = 'vars'
-pickle_zones = 'zones'
-
-config_filename = 'named.conf'
-zone_filename = 'zoneX.zone'
-zone_filename_ext = '.zone'
-
-template_dir = path.join(path.dirname(__file__), 'templates')
-
-
-class Error(HandlerError):
-    r"""
-    Error(command) -> Error instance :: Base DnsHandler exception class.
-
-    All exceptions raised by the DnsHandler inherits from this one, so you can
-    easily catch any DnsHandler 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 ZoneError(Error, KeyError):
-    r"""
-    ZoneError(zonename) -> ZoneError instance
-
-    This is the base exception for all zone related errors.
-    """
-
-    def __init__(self, zonename):
-        r"Initialize the object. See class documentation for more info."
-        self.message = 'Zone error: "%s"' % zonename
-
-
-class ZoneNotFoundError(ZoneError):
-    r"""
-    ZoneNotFoundError(hostname) -> ZoneNotFoundError instance
-
-    This exception is raised when trying to operate on a zone that doesn't
-    exists.
-    """
-
-    def __init__(self, zonename):
-        r"Initialize the object. See class documentation for more info."
-        self.message = 'zone not found: "%s"' % zonename
-
-
-class ZoneAlreadyExistsError(ZoneError):
-    r"""
-    ZoneAlreadyExistsError(hostname) -> ZoneAlreadyExistsError instance
-
-    This exception is raised when trying to add a zonename that already exists.
-    """
-
-    def __init__(self, zonename):
-        r"Initialize the object. See class documentation for more info."
-        self.message = 'Zone already exists: "%s"' % zonename
-
-
-class HostError(Error, KeyError):
-    r"""
-    HostError(hostname) -> HostError instance
-
-    This is the base exception for all host related errors.
-    """
-
-    def __init__(self, hostname):
-        r"Initialize the object. See class documentation for more info."
-        self.message = 'Host error: "%s"' % hostname
-
-class HostAlreadyExistsError(HostError):
-    r"""
-    HostAlreadyExistsError(hostname) -> HostAlreadyExistsError instance
-
-    This exception is raised when trying to add a hostname that already exists.
-    """
-
-    def __init__(self, hostname):
-        r"Initialize the object. See class documentation for more info."
-        self.message = 'Host already exists: "%s"' % hostname
-
-class HostNotFoundError(HostError):
-    r"""
-    HostNotFoundError(hostname) -> HostNotFoundError instance
-
-    This exception is raised when trying to operate on a hostname that doesn't
-    exists.
-    """
-
-    def __init__(self, hostname):
-        r"Initialize the object. See class documentation for more info."
-        self.message = 'Host not found: "%s"' % hostname
-
-
-class MailExchangeError(Error, KeyError):
-    r"""
-    MailExchangeError(hostname) -> MailExchangeError instance
-
-    This is the base exception for all mail exchange related errors.
-    """
-
-    def __init__(self, mx):
-        r"Initialize the object. See class documentation for more info."
-        self.message = 'Mail Exchange error: "%s"' % mx
-
-
-class MailExchangeAlreadyExistsError(MailExchangeError):
-    r"""
-    MailExchangeAlreadyExistsError(hostname) -> MailExchangeAlreadyExistsError instance
-
-    This exception is raised when trying to add a mail exchange that already exists.
-    """
-
-    def __init__(self, mx):
-        r"Initialize the object. See class documentation for more info."
-        self.message = 'Mail Exchange already exists: "%s"' % mx
-
-
-class MailExchangeNotFoundError(MailExchangeError):
-    r"""
-    MailExchangeNotFoundError(hostname) -> MailExchangeNotFoundError instance
-
-    This exception is raised when trying to operate on a mail exchange that doesn't
-    exists.
-    """
-
-    def __init__(self, mx):
-        r"Initialize the object. See class documentation for more info."
-        self.message = 'Mail Exchange not found: "%s"' % mx
-
-
-
-class NameServerError(Error, KeyError):
-    r"""
-    NameServerError(ns) -> NameServerError instance
-
-    This is the base exception for all name server related errors.
-    """
-
-    def __init__(self, ns):
-        r"Initialize the object. See class documentation for more info."
-        self.message = 'Name Server error: "%s"' % ns
-
-class NameServerAlreadyExistsError(NameServerError):
-    r"""
-    NameServerAlreadyExistsError(hostname) -> NameServerAlreadyExistsError instance
-
-    This exception is raised when trying to add a name server that already exists.
-    """
-
-    def __init__(self, ns):
-        r"Initialize the object. See class documentation for more info."
-        self.message = 'Name server already exists: "%s"' % ns
-
-class NameServerNotFoundError(NameServerError):
-    r"""
-    NameServerNotFoundError(hostname) -> NameServerNotFoundError instance
-
-    This exception is raised when trying to operate on a name server that doesn't
-    exists.
-    """
-
-    def __init__(self, ns):
-        r"Initialize the object. See class documentation for more info."
-        self.message = 'Mail Exchange not found: "%s"' % ns
-
-
-class ParameterError(Error, KeyError):
-    r"""
-    ParameterError(paramname) -> ParameterError instance
-
-    This is the base exception for all DhcpHandler parameters related errors.
-    """
-
-    def __init__(self, paramname):
-        r"Initialize the object. See class documentation for more info."
-        self.message = 'Parameter error: "%s"' % paramname
-
-class ParameterNotFoundError(ParameterError):
-    r"""
-    ParameterNotFoundError(hostname) -> ParameterNotFoundError instance
-
-    This exception is raised when trying to operate on a parameter that doesn't
-    exists.
-    """
-
-    def __init__(self, paramname):
-        r"Initialize the object. See class documentation for more info."
-        self.message = 'Parameter not found: "%s"' % paramname
-
-class Host(Sequence):
-    def __init__(self, name, ip):
-        self.name = name
-        self.ip = ip
-
-    def as_tuple(self):
-        return (self.name, self.ip)
-
-class HostHandler:
-    def __init__(self,zones):
-        self.zones = zones
-
-    @handler
-    def add(self, name, hostname, ip):
-        if not name in self.zones:
-            raise ZoneNotFoundError(name)
-        if hostname in self.zones[name].hosts:
-            raise HostAlreadyExistsError(hostname)
-        self.zones[name].hosts[hostname] = Host(hostname, ip)
-        self.zones[name].mod = True
-
-    @handler
-    def update(self, name, hostname, ip):
-        if not name in self.zones:
-            raise ZoneNotFoundError(name)
-        if not hostname in self.zones[name].hosts:
-             raise HostNotFoundError(name)
-        self.zones[name].hosts[hostname].ip = ip
-        self.zones[name].mod = True
-
-    @handler
-    def delete(self, name, hostname):
-        if not name in self.zones:
-            raise ZoneNotFoundError(name)
-        if not hostname in self.zones[name].hosts:
-             raise HostNotFoundError(name)
-        del self.zones[name].hosts[hostname]
-        self.zones[name].mod = True
-
-    @handler
-    def list(self):
-        return self.zones.keys()
-
-    @handler
-    def show(self):
-        return self.zones.values()
-
-
-class MailExchange(Sequence):
-
-    def __init__(self, mx, prio):
-        self.mx = mx
-        self.prio = prio
-
-    def as_tuple(self):
-        return (self.mx, self.prio)
-
-class MailExchangeHandler:
-
-    def __init__(self, zones):
-        self.zones = zones
-
-    @handler
-    def add(self, zonename, mx, prio):
-        if not zonename in self.zones:
-            raise ZoneNotFoundError(zonename)
-        if mx in self.zones[zonename].mxs:
-            raise MailExchangeAlreadyExistsError(mx)
-        self.zones[zonename].mxs[mx] = MailExchange(mx, prio)
-        self.zones[zonename].mod = True
-
-    @handler
-    def update(self, zonename, mx, prio):
-        if not zonename in self.zones:
-            raise ZoneNotFoundError(zonename)
-        if not mx in self.zones[zonename].mxs:
-            raise MailExchangeNotFoundError(mx)
-        self.zones[zonename].mxs[mx].prio = prio
-        self.zones[zonename].mod = True
-
-    @handler
-    def delete(self, zonename, mx):
-        if not zonename in self.zones:
-            raise ZoneNotFoundError(zonename)
-        if not mx in self.zones[zonename].mxs:
-            raise MailExchangeNotFoundError(mx)
-        del self.zones[zonename].mxs[mx]
-        self.zones[zonename].mod = True
-
-    @handler
-    def list(self):
-        return self.zones.keys()
-
-    @handler
-    def show(self):
-        return self.zones.values()
-
-
-class NameServer(Sequence):
-
-    def __init__(self, name):
-        self.name = name
-
-    def as_tuple(self):
-        return (self.name)
-
-class NameServerHandler:
-
-    def __init__(self, zones):
-        self.zones = zones
-
-    @handler
-    def add(self, zone, ns):
-        if not zone in self.zones:
-            raise ZoneNotFoundError(zone)
-        if ns in self.zones[zone].nss:
-            raise NameServerAlreadyExistsError(ns)
-        self.zones[zone].nss[ns] = NameServer(ns)
-        self.zones[zone].mod = True
-
-    @handler
-    def delete(self, zone, ns):
-        if not zone in self.zones:
-            raise ZoneNotFoundError(zone)
-        if not ns in self.zones[zone].nss:
-            raise NameServerNotFoundError(ns)
-        del self.zones[zone].nss[ns]
-        self.zones[zone].mod = True
-
-    @handler
-    def list(self):
-        return self.zones.keys()
-
-    @handler
-    def show(self):
-        return self.zones.values()
-
-
-class Zone(Sequence):
-    def __init__(self, name):
-        self.name = name
-        self.hosts = dict()
-        self.mxs = dict()
-        self.nss = dict()
-        self.new = False
-        self.mod = False
-        self.dele = False
-
-    def as_tuple(self):
-        return (self.name, self.hosts, self.mxs, self.nss)
-
-class ZoneHandler:
-
-    r"""ZoneHandler(zones) -> ZoneHandler instance :: Handle a list of zones.
-
-    This class is a helper for DnsHandler to do all the work related to zone
-    administration.
-
-    zones - A dictionary with string keys (zone name) and Zone instances values.
-    """
-    def __init__(self, zones):
-        self.zones = zones
-
-    @handler
-    def add(self, name):
-        if name in self.zones:
-            if self.zones[name].dele = True:
-                self.zones[name].dele = False
-            else:
-                raise ZoneAlreadyExistsError(name)
-        self.zones[name] = Zone(name)
-        self.zones[name].mod = True
-        self.zones[name].new = True
-
-
-    @handler
-    def delete(self, name):
-        r"delete(name) -> None :: Delete a zone from the zone list."
-        if not name in self.zones:
-            raise ZoneNotFoundError(name)
-        self.zones[name].dele = True
-
-    @handler
-    def list(self):
-        return self.zones.keys()
-
-    @handler
-    def show(self):
-        return self.zones.values()
-
-class DnsHandler:
-    r"""DnsHandler([pickle_dir[, config_dir]]) -> DnsHandler instance.
-
-    Handles DNS service commands for the dns program.
-
-    pickle_dir - Directory where to write the persistent configuration data.
-
-    config_dir - Directory where to store de generated configuration files.
-
-    Both defaults to the current working directory.
-    """
-
-    def __init__(self, pickle_dir='.', config_dir='.'):
-        r"Initialize DnsHandler object, see class documentation for details."
-        self.pickle_dir = pickle_dir
-        self.config_dir = config_dir
-        c_filename = path.join(template_dir, config_filename)
-        z_filename = path.join(template_dir, zone_filename)
-        self.config_template = Template(filename=c_filename)
-        self.zone_template = Template(filename=z_filename)
-        try :
-            self._load()
-        except IOError:
-            self.zones = dict()
-            self.vars = dict(
-                isp_dns1 = '',
-                isp_dns2 = '',
-                bind_addr1 = '',
-                bind_addr2 = ''
-            )
-
-        self.host = HostHandler(self.zones)
-        self.zone = ZoneHandler(self.zones)
-        self.mx = MailExchangeHandler(self.zones)
-        self.ns = NameServerHandler(self.zones)
-        self.mod = False
-
-    @handler
-    def set(self, param, value):
-        r"set(param, value) -> None :: Set a DNS parameter."
-        if not param in self.vars:
-            raise ParameterNotFoundError(param)
-        self.vars[param] = value
-        self.mod = True
-
-    @handler
-    def get(self, param):
-        r"get(param) -> None :: Get a DNS parameter."
-        if not param in self.vars:
-            raise ParameterNotFoundError(param)
-        return self.vars[param]
-
-    @handler
-    def list(self):
-        return self.vars.keys()
-
-    @handler
-    def show(self):
-        return self.vars.values()
-
-    @handler
-    def start(self):
-        r"start() -> None :: Start the DNS service."
-        #esto seria para poner en una interfaz
-        #y seria el hook para arrancar el servicio
-        pass
-
-    @handler
-    def stop(self):
-        r"stop() -> None :: Stop the DNS service."
-        #esto seria para poner en una interfaz
-        #y seria el hook para arrancar el servicio
-        pass
-
-    @handler
-    def restart(self):
-        r"restart() -> None :: Restart the DNS service."
-        #esto seria para poner en una interfaz
-        #y seria el hook para arrancar el servicio
-        pass
-
-    @handler
-    def reload(self):
-        r"reload() -> None :: Reload the configuration of the DNS service."
-        #esto seria para poner en una interfaz
-        #y seria el hook para arrancar el servicio
-        pass
-
-    @handler
-    def commit(self):
-        r"commit() -> None :: Commit the changes and reload the DNS 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()
-        self.reload()
-
-    @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.vars, pickle_vars)
-        self._dump_var(self.zones, pickle_zones)
-
-    def _load(self):
-        r"_load() -> None :: Load all persistent data from pickle files."
-        # XXX podría ir en una clase base
-        self.vars = self._load_var(pickle_vars)
-        self.zones = self._load_var(pickle_zones)
-
-    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 :: Generate all the configuration files."
-        # XXX podría ir en una clase base, ver como generalizar variables a
-        # reemplazar en la template
-        #archivos de zona
-        delete_zones = list()
-        for a_zone in self.zones.values():
-            if a_zone.mod:
-                if not a_zone.new:
-                    # TODO freeze de la zona
-                    print 'Freezing zone ' + a_zone.name + zone_filename_ext
-                zone_out_file = file(path.join(self.config_dir, a_zone.name + zone_filename_ext), 'w')
-                ctx = Context(
-                    zone_out_file,
-                    zone = a_zone,
-                    hosts = a_zone.hosts.values(),
-                    mxs = a_zone.mxs.values(),
-                    nss = a_zone.nss.values()
-                    )
-                self.zone_template.render_context(ctx)
-                zone_out_file.close()
-                a_zone.mod = False
-                if not a_zone.new:
-                    # TODO unfreeze de la zona
-                    print 'Unfreezing zone ' + a_zone.name + zone_filename_ext
-                else :
-                    self.mod = True
-                    a_zone.new = False
-            if a_zone.dele:
-                #borro el archivo .zone
-                try:
-                    self.mod = True
-                    unlink(path.join(self.config_dir, a_zone.name + zone_filename_ext))
-                except OSError:
-                    #la excepcion pude darse en caso que haga un add de una zona y
-                    #luego el del, como no hice commit, no se crea el archivo
-                    pass
-                delete_zones.append(a_zone.name)
-        #borro las zonas
-        for z in delete_zones:
-            del self.zones[z]
-        #archivo general
-        if self.mod :
-            cfg_out_file = file(path.join(self.config_dir, config_filename), 'w')
-            ctx = Context(cfg_out_file, zones=self.zones.values(), **self.vars)
-            self.config_template.render_context(ctx)
-            cfg_out_file.close()
-            self.mod = False
-            print 'Restarting service'
-
-
-
-if __name__ == '__main__':
-
-    dns = DnsHandler();
-
-    dns.set('isp_dns1','la_garcha.com')
-    dns.set('bind_addr1','localhost')
-    dns.zone.add('zona_loca.com')
-    #dns.zone.update('zona_loca.com','ns1.dominio.com')
-
-    dns.host.add('zona_loca.com','hostname_loco','192.168.0.23')
-    dns.host.update('zona_loca.com','hostname_loco','192.168.0.66')
-
-    dns.host.add('zona_loca.com','hostname_kuak','192.168.0.23')
-    dns.host.delete('zona_loca.com','hostname_kuak')
-
-    dns.host.add('zona_loca.com','hostname_kuang','192.168.0.24')
-    dns.host.add('zona_loca.com','hostname_chan','192.168.0.25')
-    dns.host.add('zona_loca.com','hostname_kaine','192.168.0.26')
-
-    dns.mx.add('zona_loca.com','mx1.sarasa.com',10)
-    dns.mx.update('zona_loca.com','mx1.sarasa.com',20)
-    dns.mx.add('zona_loca.com','mx2.sarasa.com',30)
-    dns.mx.add('zona_loca.com','mx3.sarasa.com',40)
-    dns.mx.delete('zona_loca.com','mx3.sarasa.com')
-
-    dns.ns.add('zona_loca.com','ns1.jua.com')
-    dns.ns.add('zona_loca.com','ns2.jua.com')
-    dns.ns.add('zona_loca.com','ns3.jua.com')
-    dns.ns.delete('zona_loca.com','ns3.jua.com')
-
-    dns.zone.add('zona_oscura')
-
-    dns.host.add('zona_oscura','hostname_a','192.168.0.24')
-    dns.host.add('zona_oscura','hostname_b','192.168.0.25')
-    dns.host.add('zona_oscura','hostname_c','192.168.0.26')
-
-    dns.zone.delete('zona_oscura')
-
-    dns.commit()
-
-    print 'ZONAS :'
-    print dns.zone.show() + '\n'
-    print 'HOSTS :'
-    print dns.host.show()
-
-    #test zone errors
-    try:
-        dns.zone.update('zone-sarasa','lalal')
-    except ZoneNotFoundError, inst:
-        print 'Error: ', inst
-
-    try:
-        dns.zone.delete('zone-sarasa')
-    except ZoneNotFoundError, inst:
-        print 'Error: ', inst
-
-    try:
-        dns.zone.add('zona_loca.com','ns1.dom.com','ns2.dom.com')
-    except ZoneAlreadyExistsError, inst:
-        print 'Error: ', inst
-
-    #test hosts errors
-    try:
-        dns.host.update('zone-sarasa','kuak','192.68')
-    except ZoneNotFoundError, inst:
-        print 'Error: ', inst
-
-    try:
-        dns.host.update('zona_loca.com','kuak','192.68')
-    except HostNotFoundError, inst:
-        print 'Error: ', inst
-
-    try:
-        dns.host.delete('zone-sarasa','lala')
-    except ZoneNotFoundError, inst:
-        print 'Error: ', inst
-
-    try:
-        dns.host.delete('zona_loca.com','lala')
-    except HostNotFoundError, inst:
-        print 'Error: ', inst
-
-    try:
-        dns.host.add('zona','hostname_loco','192.168.0.23')
-    except ZoneNotFoundError, inst:
-        print 'Error: ', inst
-
-    try:
-        dns.host.add('zona_loca.com','hostname_loco','192.168.0.23')
-    except HostAlreadyExistsError, inst:
-        print 'Error: ', inst