Split nat handler in submodules (refs #2).

diff --git a/services/nat/handler.py b/services/nat/handler.py
index 042a23c290c7997a910ddd05a8cc832a62b556bf..e80b02d28ecb096750ac58b4fe31c49f643e9d86 100644 (file)
--- a/services/nat/handler.py
+++ b/services/nat/handler.py
@@ -1,186 +1,16 @@
 # vim: set encoding=utf-8 et sw=4 sts=4 :
 
-from os import path
 import logging ; log = logging.getLogger('pymin.services.nat')
 
-from pymin.seqtools import Sequence
-from pymin.dispatcher import Handler, handler, HandlerError
-from pymin.service.util import Restorable, ConfigWriter, RestartHandler, \
-                               ReloadHandler, TransactionalHandler, \
-                               ServiceHandler, ListSubHandler, call
+from pymin.service.util import Restorable, ConfigWriter, ReloadHandler, \
+                               ServiceHandler, TransactionalHandler, call
 
-__all__ = ('NatHandler')
+from portfw import PortForwardHandler
+from snat import SNatHandler
+from masq import MasqHandler
 
+__all__ = ('NatHandler',)
 
-class PortForward(Sequence):
-    r"""PortForward(dev, protocol, port, dst[, dst_port[, ...]]) -> PortForward.
-
-    dev - Netword device to use.
-    protocol - TCP or UDP.
-    port - Port to forward.
-    dst - Destination IP address.
-    dst_port - Destination port (at dst).
-    src_net - Source network to apply the forward (as IP/mask).
-    dst_net - Source network to apply the forward (as IP/mask).
-    """
-
-    def __init__(self, dev, protocol, port, dst, dst_port=None, src_net=None,
-                       dst_net=None):
-        r"Initialize object, see class documentation for details."
-        # TODO Validate
-        self.dev = dev
-        self.protocol = protocol
-        self.port = port
-        self.dst = dst
-        self.dst_port = dst_port
-        self.src_net = src_net
-        self.dst_net = dst_net
-
-    def update(self, dev=None, protocol=None, port=None, dst=None,
-                    dst_port=None, src_net=None, dst_net=None):
-        r"update([dev[, ...]]) -> Update the values of a port (see class doc)."
-        # TODO Validate
-        if dev is not None: self.dev = dev
-        if protocol is not None: self.protocol = protocol
-        if port is not None: self.port = port
-        if dst is not None: self.dst = dst
-        if dst_port is not None: self.dst_port = dst_port
-        if src_net is not None: self.src_net = src_net
-        if dst_net is not None: self.dst_net = dst_net
-
-    def as_tuple(self):
-        r"Return a tuple representing the port forward."
-        return (self.dev, self.protocol, self.port, self.dst, self.dst_port,
-                    self.src_net, self.dst_net)
-
-    def as_call_list(self, index=None):
-        if self.dst_port is not None:
-            self.dst = self.dst + ':' + self.dst_port
-        cmd = ['-t', 'nat', '-I', 'PREROUTING']
-        if index is not None:
-            cmd.append(str(index))
-        cmd.extend(('-i', self.dev, '-j', 'DNAT', '--to', self.dst,
-                '-p', self.protocol, '--dport', self.port))
-        if self.src_net is not None:
-            cmd.extend(('-s', self.src_net))
-        if self.dst_net is not None:
-            cmd.extend(('-d', self.dst_net))
-        return cmd
-
-class PortForwardHandler(ListSubHandler):
-    r"""PortForwardHandler(parent) -> PortForwardHandler instance.
-
-    This class is a helper for NatHandler to do all the work related to port
-    forwarding.
-
-    parent - The parent service handler.
-    """
-
-    handler_help = u"Manage NAT port forwarding."
-
-    _cont_subhandler_attr = 'ports'
-    _cont_subhandler_class = PortForward
-
-class SNat(Sequence):
-    r"""SNat(dev, src[, src_net]) -> SNat instance.
-
-    dev - Netword device to use.
-    src - Source IP address.
-    src_net - Source network to apply the NAT (as IP/mask).
-    """
-
-    def __init__(self, dev, src, src_net=None):
-        r"Initialize object, see class documentation for details."
-        # TODO Validate
-        self.dev = dev
-        self.src = src
-        self.src_net = src_net
-
-    def update(self, dev=None, src=None, src_net=None):
-        r"update([dev[, ...]]) -> Update the values of a snat (see class doc)."
-        # TODO Validate
-        if dev is not None: self.dev = dev
-        if src is not None: self.src = src
-        if src_net is not None: self.src_net = src_net
-
-    def __cmp__(self, other):
-        r"Compares two SNat objects."
-        return cmp(self.as_tuple(), other.as_tuple())
-
-    def as_tuple(self):
-        r"Return a tuple representing the snat."
-        return (self.dev, self.src, self.src_net)
-
-    def as_call_list(self, index=None):
-        cmd = ['-t', 'nat', '-I', 'POSTROUTING']
-        if index is not None:
-            cmd.append(str(index))
-        cmd.extend(('-o', self.dev, '-j', 'SNAT', '--to', self.src))
-        if self.src_net is not None:
-            cmd.extend(('-s', self.src_net))
-        return cmd
-
-class SNatHandler(ListSubHandler):
-    r"""SNatHandler(parent) -> SNatHandler instance.
-
-    This class is a helper for NatHandler to do all the work related to
-    Source NAT.
-
-    parent - The parent service handler.
-    """
-
-    handler_help = u"Manage source NAT."
-
-    _cont_subhandler_attr = 'snats'
-    _cont_subhandler_class = SNat
-
-class Masq(Sequence):
-    r"""Masq(dev, src_net) -> Masq instance.
-
-    dev - Netword device to use.
-    src_net - Source network to apply the masquerade (as IP/mask).
-    """
-
-    def __init__(self, dev, src_net):
-        r"Initialize object, see class documentation for details."
-        # TODO Validate
-        self.dev = dev
-        self.src_net = src_net
-
-    def update(self, dev=None, src_net=None):
-        r"update([dev[, ...]]) -> Update the values of a masq (see class doc)."
-        # TODO Validate
-        if dev is not None: self.dev = dev
-        if src_net is not None: self.src_net = src_net
-
-    def __cmp__(self, other):
-        r"Compares two Masq objects."
-        return cmp(self.as_tuple(), other.as_tuple())
-
-    def as_tuple(self):
-        r"Return a tuple representing the masquerade."
-        return (self.dev, self.src_net)
-
-    def as_call_list(self, index=None):
-        cmd = ['-t', 'nat', '-I', 'POSTROUTING']
-        if index is not None:
-            cmd.append(str(index))
-        cmd.extend(('-o', self.dev, '-j', 'MASQUERADE', '-s', self.src_net))
-        return cmd
-
-class MasqHandler(ListSubHandler):
-    r"""MasqHandler(parent) -> MasqHandler instance.
-
-    This class is a helper for NatHandler to do all the work related to
-    masquerading.
-
-    parent - The parent service handler.
-    """
-
-    handler_help = u"Manage NAT masquerading."
-
-    _cont_subhandler_attr = 'masqs'
-    _cont_subhandler_class = Masq
 
 class NatHandler(Restorable, ConfigWriter, ReloadHandler, ServiceHandler,
                         TransactionalHandler):

diff --git a/services/nat/masq.py b/services/nat/masq.py
new file mode 100644 (file)
index 0000000..ac46f93
--- /dev/null
+++ b/services/nat/masq.py
@@ -0,0 +1,56 @@
+# vim: set encoding=utf-8 et sw=4 sts=4 :
+
+from pymin.seqtools import Sequence
+from pymin.service.util import ListSubHandler
+
+__all__ = ('MasqHandler',)
+
+
+class Masq(Sequence):
+    r"""Masq(dev, src_net) -> Masq instance.
+
+    dev - Netword device to use.
+    src_net - Source network to apply the masquerade (as IP/mask).
+    """
+
+    def __init__(self, dev, src_net):
+        r"Initialize object, see class documentation for details."
+        # TODO Validate
+        self.dev = dev
+        self.src_net = src_net
+
+    def update(self, dev=None, src_net=None):
+        r"update([dev[, ...]]) -> Update the values of a masq (see class doc)."
+        # TODO Validate
+        if dev is not None: self.dev = dev
+        if src_net is not None: self.src_net = src_net
+
+    def __cmp__(self, other):
+        r"Compares two Masq objects."
+        return cmp(self.as_tuple(), other.as_tuple())
+
+    def as_tuple(self):
+        r"Return a tuple representing the masquerade."
+        return (self.dev, self.src_net)
+
+    def as_call_list(self, index=None):
+        cmd = ['-t', 'nat', '-I', 'POSTROUTING']
+        if index is not None:
+            cmd.append(str(index))
+        cmd.extend(('-o', self.dev, '-j', 'MASQUERADE', '-s', self.src_net))
+        return cmd
+
+class MasqHandler(ListSubHandler):
+    r"""MasqHandler(parent) -> MasqHandler instance.
+
+    This class is a helper for NatHandler to do all the work related to
+    masquerading.
+
+    parent - The parent service handler.
+    """
+
+    handler_help = u"Manage NAT masquerading."
+
+    _cont_subhandler_attr = 'masqs'
+    _cont_subhandler_class = Masq
+

diff --git a/services/nat/portfw.py b/services/nat/portfw.py
new file mode 100644 (file)
index 0000000..fda3536
--- /dev/null
+++ b/services/nat/portfw.py
@@ -0,0 +1,77 @@
+# vim: set encoding=utf-8 et sw=4 sts=4 :
+
+from pymin.seqtools import Sequence
+from pymin.service.util import ListSubHandler
+
+__all__ = ('PortForwardHandler',)
+
+
+class PortForward(Sequence):
+    r"""PortForward(dev, protocol, port, dst[, dst_port[, ...]]) -> PortForward.
+
+    dev - Netword device to use.
+    protocol - TCP or UDP.
+    port - Port to forward.
+    dst - Destination IP address.
+    dst_port - Destination port (at dst).
+    src_net - Source network to apply the forward (as IP/mask).
+    dst_net - Source network to apply the forward (as IP/mask).
+    """
+
+    def __init__(self, dev, protocol, port, dst, dst_port=None, src_net=None,
+                       dst_net=None):
+        r"Initialize object, see class documentation for details."
+        # TODO Validate
+        self.dev = dev
+        self.protocol = protocol
+        self.port = port
+        self.dst = dst
+        self.dst_port = dst_port
+        self.src_net = src_net
+        self.dst_net = dst_net
+
+    def update(self, dev=None, protocol=None, port=None, dst=None,
+                    dst_port=None, src_net=None, dst_net=None):
+        r"update([dev[, ...]]) -> Update the values of a port (see class doc)."
+        # TODO Validate
+        if dev is not None: self.dev = dev
+        if protocol is not None: self.protocol = protocol
+        if port is not None: self.port = port
+        if dst is not None: self.dst = dst
+        if dst_port is not None: self.dst_port = dst_port
+        if src_net is not None: self.src_net = src_net
+        if dst_net is not None: self.dst_net = dst_net
+
+    def as_tuple(self):
+        r"Return a tuple representing the port forward."
+        return (self.dev, self.protocol, self.port, self.dst, self.dst_port,
+                    self.src_net, self.dst_net)
+
+    def as_call_list(self, index=None):
+        if self.dst_port is not None:
+            self.dst = self.dst + ':' + self.dst_port
+        cmd = ['-t', 'nat', '-I', 'PREROUTING']
+        if index is not None:
+            cmd.append(str(index))
+        cmd.extend(('-i', self.dev, '-j', 'DNAT', '--to', self.dst,
+                '-p', self.protocol, '--dport', self.port))
+        if self.src_net is not None:
+            cmd.extend(('-s', self.src_net))
+        if self.dst_net is not None:
+            cmd.extend(('-d', self.dst_net))
+        return cmd
+
+class PortForwardHandler(ListSubHandler):
+    r"""PortForwardHandler(parent) -> PortForwardHandler instance.
+
+    This class is a helper for NatHandler to do all the work related to port
+    forwarding.
+
+    parent - The parent service handler.
+    """
+
+    handler_help = u"Manage NAT port forwarding."
+
+    _cont_subhandler_attr = 'ports'
+    _cont_subhandler_class = PortForward
+

diff --git a/services/nat/snat.py b/services/nat/snat.py
new file mode 100644 (file)
index 0000000..7e59e00
--- /dev/null
+++ b/services/nat/snat.py
@@ -0,0 +1,61 @@
+# vim: set encoding=utf-8 et sw=4 sts=4 :
+
+from pymin.seqtools import Sequence
+from pymin.service.util import ListSubHandler
+
+__all__ = ('SNatHandler',)
+
+
+class SNat(Sequence):
+    r"""SNat(dev, src[, src_net]) -> SNat instance.
+
+    dev - Netword device to use.
+    src - Source IP address.
+    src_net - Source network to apply the NAT (as IP/mask).
+    """
+
+    def __init__(self, dev, src, src_net=None):
+        r"Initialize object, see class documentation for details."
+        # TODO Validate
+        self.dev = dev
+        self.src = src
+        self.src_net = src_net
+
+    def update(self, dev=None, src=None, src_net=None):
+        r"update([dev[, ...]]) -> Update the values of a snat (see class doc)."
+        # TODO Validate
+        if dev is not None: self.dev = dev
+        if src is not None: self.src = src
+        if src_net is not None: self.src_net = src_net
+
+    def __cmp__(self, other):
+        r"Compares two SNat objects."
+        return cmp(self.as_tuple(), other.as_tuple())
+
+    def as_tuple(self):
+        r"Return a tuple representing the snat."
+        return (self.dev, self.src, self.src_net)
+
+    def as_call_list(self, index=None):
+        cmd = ['-t', 'nat', '-I', 'POSTROUTING']
+        if index is not None:
+            cmd.append(str(index))
+        cmd.extend(('-o', self.dev, '-j', 'SNAT', '--to', self.src))
+        if self.src_net is not None:
+            cmd.extend(('-s', self.src_net))
+        return cmd
+
+class SNatHandler(ListSubHandler):
+    r"""SNatHandler(parent) -> SNatHandler instance.
+
+    This class is a helper for NatHandler to do all the work related to
+    Source NAT.
+
+    parent - The parent service handler.
+    """
+
+    handler_help = u"Manage source NAT."
+
+    _cont_subhandler_attr = 'snats'
+    _cont_subhandler_class = SNat
+