X-Git-Url: http://git.vanrenterghem.biz/git.ikiwiki.info.git/blobdiff_plain/5184b8abfce9f2e6c899f8f00e0ac3341161a1b2..e39366315cd153fc794aed7a9b4df587115d49e7:/plugins/proxy.py diff --git a/plugins/proxy.py b/plugins/proxy.py index 36facecc5..c2e9bd621 100644 --- a/plugins/proxy.py +++ b/plugins/proxy.py @@ -4,14 +4,35 @@ # proxy.py — helper for Python-based external (xml-rpc) ikiwiki plugins # # Copyright © martin f. krafft -# 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 ' __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: @@ -107,8 +128,8 @@ class _IkiWikiExtPluginXMLRPCHandler(object): if ret is not None: return ret - def send_rpc(self, cmd, in_fd, out_fd, **kwargs): - xml = xmlrpclib.dumps(sum(kwargs.iteritems(), ()), cmd) + def send_rpc(self, cmd, in_fd, out_fd, *args, **kwargs): + xml = xmlrpclib.dumps(sum(kwargs.iteritems(), args), cmd) self._debug_fn("calling ikiwiki procedure `%s': [%s]" % (cmd, xml)) _IkiWikiExtPluginXMLRPCHandler._write(out_fd, xml) @@ -118,9 +139,10 @@ 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] + data = xmlrpclib.loads(xml)[0][0] self._debug_fn('parsed data from response to procedure %s: [%s]' % (cmd, data)) return 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 @@ -153,6 +178,8 @@ class IkiWikiProcedureProxy(object): self._in_fd = in_fd self._out_fd = out_fd self._hooks = list() + self._functions = list() + self._imported = False if debug_fn is not None: self._debug_fn = debug_fn else: @@ -160,15 +187,36 @@ class IkiWikiProcedureProxy(object): self._xmlrpc_handler = _IkiWikiExtPluginXMLRPCHandler(self._debug_fn) self._xmlrpc_handler.register_function(self._importme, name='import') - def hook(self, type, function, name=None, last=False): + def rpc(self, cmd, *args, **kwargs): + def subst_none(seq): + for i in seq: + if i is None: + yield IkiWikiProcedureProxy._IKIWIKI_NIL_SENTINEL + else: + yield i + + args = list(subst_none(args)) + kwargs = dict(zip(kwargs.keys(), list(subst_none(kwargs.itervalues())))) + ret = self._xmlrpc_handler.send_rpc(cmd, self._in_fd, self._out_fd, + *args, **kwargs) + if ret == IkiWikiProcedureProxy._IKIWIKI_NIL_SENTINEL: + ret = None + return ret + + def hook(self, type, function, name=None, id=None, last=False): + if self._imported: + raise IkiWikiProcedureProxy.AlreadyImported + if name is None: name = function.__name__ - self._hooks.append((type, name, last)) + + 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)]) - ret = function(*args) + ret = function(self, *args) self._debug_fn("%s hook `%s' returned: [%s]" % (type, name, ret)) if ret == IkiWikiProcedureProxy._IKIWIKI_NIL_SENTINEL: raise IkiWikiProcedureProxy.InvalidReturnValue, \ @@ -178,30 +226,76 @@ class IkiWikiProcedureProxy(object): ret = IkiWikiProcedureProxy._IKIWIKI_NIL_SENTINEL return ret + self._hooks.append((id, type, name, last)) self._xmlrpc_handler.register_function(hook_proxy, name=name) - 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._xmlrpc_handler.send_rpc('hook', self._in_fd, self._out_fd, - id=self._id, type=type, call=function, - last=last) - return IkiWikiProcedureProxy._IKIWIKI_NIL_SENTINEL + def inject(self, rname, function, name=None, memoize=True): + if self._imported: + raise IkiWikiProcedureProxy.AlreadyImported + + if name is None: + name = function.__name__ + + self._functions.append((rname, name, memoize)) + self._xmlrpc_handler.register_function(function, name=name) + + def getargv(self): + return self.rpc('getargv') + + def setargv(self, argv): + return self.rpc('setargv', argv) + + def getvar(self, hash, key): + return self.rpc('getvar', hash, key) + + def setvar(self, hash, key, value): + return self.rpc('setvar', hash, key, value) + + def getstate(self, page, id, key): + return self.rpc('getstate', page, id, key) + + def setstate(self, page, id, key, value): + return self.rpc('setstate', page, id, key, value) + + def pagespec_match(self, spec): + return self.rpc('pagespec_match', spec) + + def error(self, msg): + try: + self.rpc('error', msg) + except IOError, e: + if e.errno != 32: + raise + import posix + sys.exit(posix.EX_SOFTWARE) def run(self): 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: - print >>sys.stderr, 'uncaught exception: %s' % e import traceback - print >>sys.stderr, traceback.format_exc(sys.exc_info()[2]) - import posix - sys.exit(posix.EX_SOFTWARE) + self.error('uncaught exception: %s\n%s' \ + % (e, traceback.format_exc(sys.exc_info()[2]))) + return + + def _importme(self): + self._debug_fn('importing...') + 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) + self._imported = True + return IkiWikiProcedureProxy._IKIWIKI_NIL_SENTINEL class InvalidReturnValue(Exception): pass + + class AlreadyImported(Exception): + pass