Changeset 186

Timestamp:

07/30/12 01:06:26 (12 years ago)

Author:

atzm

Message:

• API seiri

File:

• etherws/trunk/etherws.py (modified) (15 diffs)

etherws/trunk/etherws.py

@@ -2 +2 @@
 # -*- coding: utf-8 -*-
 #
-#              Ethernet over WebSocket tunneling server/client
+#                          Ethernet over WebSocket
 #
 # depends on:
@@ -9 +9 @@
 #   - websocket-client-0.7.0
 #   - tornado-2.3
-#
-# todo:
-#   - servant mode support (like typical p2p software)
 #
 # ===========================================================================
@@ -177 +174 @@
         return sorted(self._table.itervalues(), cmp=SwitchPort.cmp_by_number)
 
-    def shut_port(self, portnum, flag=True):
-        self._table[portnum].shut = flag
-
     def get_port(self, portnum):
         return self._table[portnum]
 
     def register_port(self, interface):
-        interface._switch_portnum = self._next  # XXX
-        self._table[self._next] = SwitchPort(self._next, interface)
-        self._next += 1
+        try:
+            interface._switch_portnum = self._next  # XXX
+            self._table[self._next] = SwitchPort(self._next, interface)
+            return self._next
+        finally:
+            self._next += 1
 
     def unregister_port(self, interface):
@@ -307 +304 @@
 
 
+class EtherWebSocketHandler(DebugMixIn, BasicAuthMixIn, WebSocketHandler):
+    def __init__(self, app, req, switch, htpasswd=None, debug=False):
+        super(EtherWebSocketHandler, self).__init__(app, req)
+        self._switch = switch
+        self._htpasswd = htpasswd
+        self._debug = debug
+
+    @classmethod
+    def get_type(cls):
+        return 'server'
+
+    def get_target(self):
+        return self.request.remote_ip
+
+    def open(self):
+        try:
+            return self._switch.register_port(self)
+        finally:
+            self.dprintf('connected: %s\n', lambda: self.request.remote_ip)
+
+    def on_message(self, message):
+        self._switch.receive(self, EthernetFrame(message))
+
+    def on_close(self):
+        self._switch.unregister_port(self)
+        self.dprintf('disconnected: %s\n', lambda: self.request.remote_ip)
+
+
 class TapHandler(DebugMixIn):
     READ_SIZE = 65535
@@ -317 +342 @@
         self._tap = None
 
-    @property
-    def closed(self):
-        return not self._tap
-
-    def get_type(self):
+    @classmethod
+    def get_type(cls):
         return 'tap'
 
-    def get_name(self):
+    def get_target(self):
         if self.closed:
             return self._dev
         return self._tap.name
+
+    @property
+    def closed(self):
+        return not self._tap
 
     def open(self):
@@ -334 +360 @@
         self._tap = TunTapDevice(self._dev, IFF_TAP | IFF_NO_PI)
         self._tap.up()
-        self._switch.register_port(self)
         self._ioloop.add_handler(self.fileno(), self, self._ioloop.READ)
+        return self._switch.register_port(self)
 
     def close(self):
         if self.closed:
             raise ValueError('I/O operation on closed tap')
+        self._switch.unregister_port(self)
         self._ioloop.remove_handler(self.fileno())
-        self._switch.unregister_port(self)
         self._tap.close()
         self._tap = None
@@ -374 +400 @@
 
 
-class EtherWebSocketHandler(DebugMixIn, BasicAuthMixIn, WebSocketHandler):
-    def __init__(self, app, req, switch, htpasswd=None, debug=False):
-        super(EtherWebSocketHandler, self).__init__(app, req)
-        self._switch = switch
-        self._htpasswd = htpasswd
-        self._debug = debug
-
-    def get_type(self):
-        return 'server'
-
-    def get_name(self):
-        return self.request.remote_ip
-
-    def open(self):
-        self._switch.register_port(self)
-        self.dprintf('connected: %s\n', lambda: self.request.remote_ip)
-
-    def on_message(self, message):
-        self._switch.receive(self, EthernetFrame(message))
-
-    def on_close(self):
-        self._switch.unregister_port(self)
-        self.dprintf('disconnected: %s\n', lambda: self.request.remote_ip)
-
-
 class EtherWebSocketClient(DebugMixIn):
     def __init__(self, ioloop, switch, url, ssl_=None, cred=None, debug=False):
@@ -414 +415 @@
             self._options['header'] = auth
 
+    @classmethod
+    def get_type(cls):
+        return 'client'
+
+    def get_target(self):
+        return self._url
+
     @property
     def closed(self):
         return not self._sock
-
-    def get_type(self):
-        return 'client'
-
-    def get_name(self):
-        return self._url
 
     def open(self):
@@ -436 +438 @@
             self._sock = websocket.WebSocket()
             self._sock.connect(self._url, **self._options)
-            self._switch.register_port(self)
             self._ioloop.add_handler(self.fileno(), self, self._ioloop.READ)
-            self.dprintf('connected: %s\n', lambda: self._url)
+            return self._switch.register_port(self)
         finally:
             websocket._SSLSocketWrapper = sslwrap
+            self.dprintf('connected: %s\n', lambda: self._url)
 
     def close(self):
         if self.closed:
             raise websocket.WebSocketException('already closed')
+        self._switch.unregister_port(self)
         self._ioloop.remove_handler(self.fileno())
-        self._switch.unregister_port(self)
         self._sock.close()
         self._sock = None
@@ -478 +480 @@
 class EtherWebSocketControlHandler(DebugMixIn, BasicAuthMixIn, RequestHandler):
     NAMESPACE = 'etherws.control'
+    INTERFACES = {
+        TapHandler.get_type():           TapHandler,
+        EtherWebSocketClient.get_type(): EtherWebSocketClient,
+    }
 
     def __init__(self, app, req, ioloop, switch, htpasswd=None, debug=False):
@@ -512 +518 @@
         list_ = []
         for port in self._switch.portlist:
-            list_.append({
-                'port': port.number,
-                'type': port.interface.get_type(),
-                'name': port.interface.get_name(),
-                'tx':   port.tx,
-                'rx':   port.rx,
-                'shut': port.shut,
-            })
+            list_.append(self._portstat(port))
         return {'portlist': list_}
 
     def handle_addPort(self, params):
+        list_ = []
         for p in params:
-            getattr(self, '_openport_' + p['type'])(p)
-        return self.handle_listPort(params)
+            type_ = p['type']
+            target = p['target']
+            options = getattr(self, '_optparse_' + type_)(p.get('options', {}))
+            klass = self.INTERFACES[type_]
+            interface = klass(self._ioloop, self._switch, target, **options)
+            portnum = interface.open()
+            list_.append(self._portstat(self._switch.get_port(portnum)))
+        return {'portlist': list_}
 
     def handle_delPort(self, params):
+        list_ = []
         for p in params:
-            self._switch.get_port(int(p['port'])).interface.close()
-        return self.handle_listPort(params)
+            port = self._switch.get_port(int(p['port']))
+            list_.append(self._portstat(port))
+            port.interface.close()
+        return {'portlist': list_}
 
     def handle_shutPort(self, params):
+        list_ = []
         for p in params:
-            self._switch.shut_port(int(p['port']), bool(p['flag']))
-        return self.handle_listPort(params)
-
-    def _openport_tap(self, p):
-        dev = p['device']
-        tap = TapHandler(self._ioloop, self._switch, dev, debug=self._debug)
-        tap.open()
-
-    def _openport_client(self, p):
-        ssl_ = self._ssl_wrapper(p.get('insecure'), p.get('cacerts'))
-        cred = {'user': p.get('user'), 'passwd': p.get('passwd')}
-        url = p['url']
-        client = EtherWebSocketClient(self._ioloop, self._switch,
-                                      url, ssl_, cred, self._debug)
-        client.open()
+            port = self._switch.get_port(int(p['port']))
+            port.shut = bool(p['flag'])
+            list_.append(self._portstat(port))
+        return {'portlist': list_}
+
+    def _optparse_tap(self, opt):
+        return {'debug': self._debug}
+
+    def _optparse_client(self, opt):
+        args = {'cert_reqs': ssl.CERT_REQUIRED, 'ca_certs': opt.get('cacerts')}
+        if opt.get('insecure'):
+            args = {}
+        ssl_ = lambda sock: ssl.wrap_socket(sock, **args)
+        cred = {'user': opt.get('user'), 'passwd': opt.get('passwd')}
+        return {'ssl_': ssl_, 'cred': cred, 'debug': self._debug}
 
     @staticmethod
-    def _ssl_wrapper(insecure, ca_certs):
-        args = {'cert_reqs': ssl.CERT_REQUIRED, 'ca_certs': ca_certs}
-        if insecure:
-            args = {}
-        return lambda sock: ssl.wrap_socket(sock, **args)
-
-
-def daemonize(nochdir=False, noclose=False):
-    if os.fork() > 0:
-        sys.exit(0)
-
-    os.setsid()
-
-    if os.fork() > 0:
-        sys.exit(0)
-
-    if not nochdir:
-        os.chdir('/')
-
-    if not noclose:
-        os.umask(0)
-        sys.stdin.close()
-        sys.stdout.close()
-        sys.stderr.close()
-        os.close(0)
-        os.close(1)
-        os.close(2)
-        sys.stdin = open(os.devnull)
-        sys.stdout = open(os.devnull, 'a')
-        sys.stderr = open(os.devnull, 'a')
-
-
-def main():
-    def realpath(ns, *keys):
-        for k in keys:
-            v = getattr(ns, k, None)
-            if v is not None:
-                v = os.path.realpath(v)
-                open(v).close()  # check readable
-                setattr(ns, k, v)
-
-    def checkpath(ns, path):
+    def _portstat(port):
+        return {
+            'port':   port.number,
+            'type':   port.interface.get_type(),
+            'target': port.interface.get_target(),
+            'tx':     port.tx,
+            'rx':     port.rx,
+            'shut':   port.shut,
+        }
+
+
+def start_switch(args):
+    def daemonize(nochdir=False, noclose=False):
+        if os.fork() > 0:
+            sys.exit(0)
+
+        os.setsid()
+
+        if os.fork() > 0:
+            sys.exit(0)
+
+        if not nochdir:
+            os.chdir('/')
+
+        if not noclose:
+            os.umask(0)
+            sys.stdin.close()
+            sys.stdout.close()
+            sys.stderr.close()
+            os.close(0)
+            os.close(1)
+            os.close(2)
+            sys.stdin = open(os.devnull)
+            sys.stdout = open(os.devnull, 'a')
+            sys.stderr = open(os.devnull, 'a')
+
+    def checkabspath(ns, path):
         val = getattr(ns, path, '')
         if not val.startswith('/'):
@@ -606 +611 @@
         return None
 
+    def setrealpath(ns, *keys):
+        for k in keys:
+            v = getattr(ns, k, None)
+            if v is not None:
+                v = os.path.realpath(v)
+                open(v).close()  # check readable
+                setattr(ns, k, v)
+
     def setport(ns, port, isssl):
         val = getattr(ns, port, None)
@@ -620 +633 @@
             return setattr(ns, htpasswd, Htpasswd(val))
 
-    parser = argparse.ArgumentParser()
-
-    parser.add_argument('--debug', action='store_true', default=False)
-    parser.add_argument('--foreground', action='store_true', default=False)
-    parser.add_argument('--ageout', action='store', type=int, default=300)
-
-    parser.add_argument('--path', action='store', default='/')
-    parser.add_argument('--host', action='store', default='')
-    parser.add_argument('--port', action='store', type=int)
-    parser.add_argument('--htpasswd', action='store')
-    parser.add_argument('--sslkey', action='store')
-    parser.add_argument('--sslcert', action='store')
-
-    parser.add_argument('--ctlpath', action='store', default='/ctl')
-    parser.add_argument('--ctlhost', action='store', default='')
-    parser.add_argument('--ctlport', action='store', type=int)
-    parser.add_argument('--ctlhtpasswd', action='store')
-    parser.add_argument('--ctlsslkey', action='store')
-    parser.add_argument('--ctlsslcert', action='store')
-
-    args = parser.parse_args()
-
     #if args.debug:
     #    websocket.enableTrace(True)
@@ -648 +639 @@
         raise ValueError('invalid ageout: %s' % args.ageout)
 
-    realpath(args, 'htpasswd', 'sslkey', 'sslcert')
-    realpath(args, 'ctlhtpasswd', 'ctlsslkey', 'ctlsslcert')
-
-    checkpath(args, 'path')
-    checkpath(args, 'ctlpath')
+    setrealpath(args, 'htpasswd', 'sslkey', 'sslcert')
+    setrealpath(args, 'ctlhtpasswd', 'ctlsslkey', 'ctlsslcert')
+
+    checkabspath(args, 'path')
+    checkabspath(args, 'ctlpath')
 
     sslopt = getsslopt(args, 'sslkey', 'sslcert')
@@ -715 +706 @@
 
 
+def main():
+    parser = argparse.ArgumentParser()
+    subparsers = parser.add_subparsers(dest='subcommand')
+    parser_s = subparsers.add_parser('switch')
+    parser_c = subparsers.add_parser('control')
+
+    parser_s.add_argument('--debug', action='store_true', default=False)
+    parser_s.add_argument('--foreground', action='store_true', default=False)
+    parser_s.add_argument('--ageout', action='store', type=int, default=300)
+
+    parser_s.add_argument('--path', action='store', default='/')
+    parser_s.add_argument('--host', action='store', default='')
+    parser_s.add_argument('--port', action='store', type=int)
+    parser_s.add_argument('--htpasswd', action='store')
+    parser_s.add_argument('--sslkey', action='store')
+    parser_s.add_argument('--sslcert', action='store')
+
+    parser_s.add_argument('--ctlpath', action='store', default='/ctl')
+    parser_s.add_argument('--ctlhost', action='store', default='')
+    parser_s.add_argument('--ctlport', action='store', type=int)
+    parser_s.add_argument('--ctlhtpasswd', action='store')
+    parser_s.add_argument('--ctlsslkey', action='store')
+    parser_s.add_argument('--ctlsslcert', action='store')
+
+    args = parser.parse_args()
+
+    globals()['start_' + args.subcommand](args)
+
+
 if __name__ == '__main__':
     main()