(no commit message)
[ikiwiki.git] / plugins / proxy.py
index ea0ca96462c500e790b19dfb2d869eb803845e46..c2e9bd6215fbe11fc5264a66a3a84fb80147972e 100644 (file)
@@ -4,14 +4,35 @@
 # proxy.py — helper for Python-based external (xml-rpc) ikiwiki plugins
 #
 # Copyright © martin f. krafft <madduck@madduck.net>
-# Released under the terms of the GNU GPL version 2
-#
+# 
+#  Redistribution and use in source and binary forms, with or without
+# modification, are permitted provided that the following conditions
+# are met:
+# 1. Redistributions of source code must retain the above copyright
+#    notice, this list of conditions and the following disclaimer.
+# 2. Redistributions in binary form must reproduce the above copyright
+#    notice, this list of conditions and the following disclaimer in the
+#    documentation and/or other materials provided with the distribution.
+# .
+# THIS SOFTWARE IS PROVIDED BY IKIWIKI AND CONTRIBUTORS ``AS IS''
+# AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED
+# TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A
+# PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE FOUNDATION
+# OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
+# SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
+# LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF
+# USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND
+# ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY,
+# OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT
+# OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
+# SUCH DAMAGE.
+# 
 __name__ = 'proxy.py'
 __description__ = 'helper for Python-based external (xml-rpc) ikiwiki plugins'
 __version__ = '0.1'
 __author__ = 'martin f. krafft <madduck@madduck.net>'
 __copyright__ = 'Copyright © ' + __author__
-__licence__ = 'GPLv2'
+__licence__ = 'BSD-2-clause'
 
 import sys
 import time
@@ -32,7 +53,7 @@ class _IkiWikiExtPluginXMLRPCDispatcher(SimpleXMLRPCDispatcher):
     def dispatch(self, method, params):
         return self._dispatch(method, params)
 
-class _XMLStreamParser(object):
+class XMLStreamParser(object):
 
     def __init__(self):
         self._parser = xml.parsers.expat.ParserCreate()
@@ -95,7 +116,7 @@ class _IkiWikiExtPluginXMLRPCHandler(object):
     @staticmethod
     def _read(in_fd):
         ret = None
-        parser = _XMLStreamParser()
+        parser = XMLStreamParser()
         while True:
             line = in_fd.readline()
             if len(line) == 0:
@@ -118,7 +139,8 @@ class _IkiWikiExtPluginXMLRPCHandler(object):
         self._debug_fn('read response to procedure %s from ikiwiki: [%s]' % (cmd, xml))
         if xml is None:
             # ikiwiki is going down
-            return None
+            self._debug_fn('ikiwiki is going down, and so are we...')
+            raise _IkiWikiExtPluginXMLRPCHandler._GoingDown
 
         data = xmlrpclib.loads(xml)[0][0]
         self._debug_fn('parsed data from response to procedure %s: [%s]' % (cmd, data))
@@ -130,7 +152,7 @@ class _IkiWikiExtPluginXMLRPCHandler(object):
         if xml is None:
             # ikiwiki is going down
             self._debug_fn('ikiwiki is going down, and so are we...')
-            return
+            raise _IkiWikiExtPluginXMLRPCHandler._GoingDown
 
         self._debug_fn('received procedure call from ikiwiki: [%s]' % xml)
         params, method = xmlrpclib.loads(xml)
@@ -140,6 +162,9 @@ class _IkiWikiExtPluginXMLRPCHandler(object):
         _IkiWikiExtPluginXMLRPCHandler._write(out_fd, xml)
         return ret
 
+    class _GoingDown:
+        pass
+
 class IkiWikiProcedureProxy(object):
 
     # how to communicate None to ikiwiki
@@ -178,13 +203,16 @@ class IkiWikiProcedureProxy(object):
             ret = None
         return ret
 
-    def hook(self, type, function, name=None, last=False):
+    def hook(self, type, function, name=None, id=None, last=False):
         if self._imported:
             raise IkiWikiProcedureProxy.AlreadyImported
 
         if name is None:
             name = function.__name__
 
+        if id is None:
+            id = self._id
+
         def hook_proxy(*args):
 #            curpage = args[0]
 #            kwargs = dict([args[i:i+2] for i in xrange(1, len(args), 2)])
@@ -198,7 +226,7 @@ class IkiWikiProcedureProxy(object):
                 ret = IkiWikiProcedureProxy._IKIWIKI_NIL_SENTINEL
             return ret
 
-        self._hooks.append((type, name, last))
+        self._hooks.append((id, type, name, last))
         self._xmlrpc_handler.register_function(hook_proxy, name=name)
 
     def inject(self, rname, function, name=None, memoize=True):
@@ -238,7 +266,6 @@ class IkiWikiProcedureProxy(object):
         except IOError, e:
             if e.errno != 32:
                 raise
-
         import posix
         sys.exit(posix.EX_SOFTWARE)
 
@@ -246,21 +273,21 @@ class IkiWikiProcedureProxy(object):
         try:
             while True:
                 ret = self._xmlrpc_handler.handle_rpc(self._in_fd, self._out_fd)
-                if ret is None:
-                    return
                 time.sleep(IkiWikiProcedureProxy._LOOP_DELAY)
+        except _IkiWikiExtPluginXMLRPCHandler._GoingDown:
+            return
+
         except Exception, e:
             import traceback
             self.error('uncaught exception: %s\n%s' \
                        % (e, traceback.format_exc(sys.exc_info()[2])))
-            import posix
-            sys.exit(posix.EX_SOFTWARE)
+            return
 
     def _importme(self):
         self._debug_fn('importing...')
-        for type, function, last in self._hooks:
-            self._debug_fn('hooking %s into %s chain...' % (function, type))
-            self.rpc('hook', id=self._id, type=type, call=function, last=last)
+        for id, type, function, last in self._hooks:
+            self._debug_fn('hooking %s/%s into %s chain...' % (id, function, type))
+            self.rpc('hook', id=id, type=type, call=function, last=last)
         for rname, function, memoize in self._functions:
             self._debug_fn('injecting %s as %s...' % (function, rname))
             self.rpc('inject', name=rname, call=function, memoize=memoize)