plugins/proxy.py

   1 #!/usr/bin/python
   2 # -*- coding: utf-8 -*-
   3 #
   4 # proxy.py — helper for Python-based external (xml-rpc) ikiwiki plugins
   5 #
   6 # Copyright © 2008      martin f. krafft <madduck@madduck.net>
   7 #             2008-2011 Joey Hess <joey@kitenet.net>
   8 #             2012      W. Trevor King <wking@tremily.us>
   9 #
  10 #  Redistribution and use in source and binary forms, with or without
  11 # modification, are permitted provided that the following conditions
  12 # are met:
  13 # 1. Redistributions of source code must retain the above copyright
  14 #    notice, this list of conditions and the following disclaimer.
  15 # 2. Redistributions in binary form must reproduce the above copyright
  16 #    notice, this list of conditions and the following disclaimer in the
  17 #    documentation and/or other materials provided with the distribution.
  18 # .
  19 # THIS SOFTWARE IS PROVIDED BY IKIWIKI AND CONTRIBUTORS ``AS IS''
  20 # AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED
  21 # TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A
  22 # PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE FOUNDATION
  23 # OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
  24 # SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
  25 # LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF
  26 # USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND
  27 # ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY,
  28 # OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT
  29 # OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
  30 # SUCH DAMAGE.
  31 #
  32 __name__ = 'proxy.py'
  33 __description__ = 'helper for Python-based external (xml-rpc) ikiwiki plugins'
  34 __version__ = '0.2'
  35 __author__ = 'martin f. krafft <madduck@madduck.net>'
  36 __copyright__ = 'Copyright © ' + __author__
  37 __licence__ = 'BSD-2-clause'
  38
  39 import sys
  40 import time
  41 import xml.parsers.expat
  42 try:  # Python 3
  43     import xmlrpc.client as _xmlrpc_client
  44 except ImportError:  # Python 2
  45     import xmlrpclib as _xmlrpc_client
  46 try:  # Python 3
  47     import xmlrpc.server as _xmlrpc_server
  48 except ImportError:  # Python 2
  49     import SimpleXMLRPCServer as _xmlrpc_server
  50
  51
  52 class ParseError (Exception):
  53     pass
  54
  55
  56 class PipeliningDetected (Exception):
  57     pass
  58
  59
  60 class GoingDown (Exception):
  61     pass
  62
  63
  64 class InvalidReturnValue (Exception):
  65     pass
  66
  67
  68 class AlreadyImported (Exception):
  69     pass
  70
  71
  72 class _IkiWikiExtPluginXMLRPCDispatcher(_xmlrpc_server.SimpleXMLRPCDispatcher):
  73
  74     def __init__(self, allow_none=False, encoding=None):
  75         try:
  76             _xmlrpc_server.SimpleXMLRPCDispatcher.__init__(
  77                 self, allow_none, encoding)
  78         except TypeError:
  79             # see http://bugs.debian.org/470645
  80             # python2.4 and before only took one argument
  81             _xmlrpc_server.SimpleXMLRPCDispatcher.__init__(self)
  82
  83     def dispatch(self, method, params):
  84         return self._dispatch(method, params)
  85
  86
  87 class XMLStreamParser(object):
  88
  89     def __init__(self):
  90         self._parser = xml.parsers.expat.ParserCreate()
  91         self._parser.StartElementHandler = self._push_tag
  92         self._parser.EndElementHandler = self._pop_tag
  93         self._parser.XmlDeclHandler = self._check_pipelining
  94         self._reset()
  95
  96     def _reset(self):
  97         self._stack = list()
  98         self._acc = r''
  99         self._first_tag_received = False
 100
 101     def _push_tag(self, tag, attrs):
 102         self._stack.append(tag)
 103         self._first_tag_received = True
 104
 105     def _pop_tag(self, tag):
 106         top = self._stack.pop()
 107         if top != tag:
 108             raise ParseError(
 109                 'expected {} closing tag, got {}'.format(top, tag))
 110
 111     def _request_complete(self):
 112         return self._first_tag_received and len(self._stack) == 0
 113
 114     def _check_pipelining(self, *args):
 115         if self._first_tag_received:
 116             raise PipeliningDetected('need a new line between XML documents')
 117
 118     def parse(self, data):
 119         self._parser.Parse(data, False)
 120         self._acc += data
 121         if self._request_complete():
 122             ret = self._acc
 123             self._reset()
 124             return ret
 125
 126
 127 class _IkiWikiExtPluginXMLRPCHandler(object):
 128
 129     def __init__(self, debug_fn):
 130         self._dispatcher = _IkiWikiExtPluginXMLRPCDispatcher()
 131         self.register_function = self._dispatcher.register_function
 132         self._debug_fn = debug_fn
 133
 134     def register_function(self, function, name=None):
 135         # will be overwritten by __init__
 136         pass
 137
 138     @staticmethod
 139     def _write(out_fd, data):
 140         out_fd.write(str(data))
 141         out_fd.flush()
 142
 143     @staticmethod
 144     def _read(in_fd):
 145         ret = None
 146         parser = XMLStreamParser()
 147         while True:
 148             line = in_fd.readline()
 149             if len(line) == 0:
 150                 # ikiwiki exited, EOF received
 151                 return None
 152
 153             ret = parser.parse(line)
 154             # unless this returns non-None, we need to loop again
 155             if ret is not None:
 156                 return ret
 157
 158     def send_rpc(self, cmd, in_fd, out_fd, *args, **kwargs):
 159         xml = _xmlrpc_client.dumps(sum(kwargs.items(), args), cmd)
 160         self._debug_fn("calling ikiwiki procedure `{}': [{}]".format(cmd, xml))
 161         _IkiWikiExtPluginXMLRPCHandler._write(out_fd, xml)
 162
 163         self._debug_fn('reading response from ikiwiki...')
 164
 165         xml = _IkiWikiExtPluginXMLRPCHandler._read(in_fd)
 166         self._debug_fn(
 167             'read response to procedure {} from ikiwiki: [{}]'.format(
 168                 cmd, xml))
 169         if xml is None:
 170             # ikiwiki is going down
 171             self._debug_fn('ikiwiki is going down, and so are we...')
 172             raise GoingDown()
 173
 174         data = _xmlrpc_client.loads(xml)[0][0]
 175         self._debug_fn(
 176             'parsed data from response to procedure {}: [{}]'.format(
 177                 cmd, data))
 178         return data
 179
 180     def handle_rpc(self, in_fd, out_fd):
 181         self._debug_fn('waiting for procedure calls from ikiwiki...')
 182         xml = _IkiWikiExtPluginXMLRPCHandler._read(in_fd)
 183         if xml is None:
 184             # ikiwiki is going down
 185             self._debug_fn('ikiwiki is going down, and so are we...')
 186             raise GoingDown()
 187
 188         self._debug_fn(
 189             'received procedure call from ikiwiki: [{}]'.format(xml))
 190         params, method = _xmlrpc_client.loads(xml)
 191         ret = self._dispatcher.dispatch(method, params)
 192         xml = _xmlrpc_client.dumps((ret,), methodresponse=True)
 193         self._debug_fn(
 194                 'sending procedure response to ikiwiki: [{}]'.format(xml))
 195         _IkiWikiExtPluginXMLRPCHandler._write(out_fd, xml)
 196         return ret
 197
 198
 199 class IkiWikiProcedureProxy(object):
 200
 201     # how to communicate None to ikiwiki
 202     _IKIWIKI_NIL_SENTINEL = {'null':''}
 203
 204     # sleep during each iteration
 205     _LOOP_DELAY = 0.1
 206
 207     def __init__(self, id, in_fd=sys.stdin, out_fd=sys.stdout, debug_fn=None):
 208         self._id = id
 209         self._in_fd = in_fd
 210         self._out_fd = out_fd
 211         self._hooks = list()
 212         self._functions = list()
 213         self._imported = False
 214         if debug_fn is not None:
 215             self._debug_fn = debug_fn
 216         else:
 217             self._debug_fn = lambda s: None
 218         self._xmlrpc_handler = _IkiWikiExtPluginXMLRPCHandler(self._debug_fn)
 219         self._xmlrpc_handler.register_function(self._importme, name='import')
 220
 221     def rpc(self, cmd, *args, **kwargs):
 222         def subst_none(seq):
 223             for i in seq:
 224                 if i is None:
 225                     yield IkiWikiProcedureProxy._IKIWIKI_NIL_SENTINEL
 226                 else:
 227                     yield i
 228
 229         args = list(subst_none(args))
 230         kwargs = dict(zip(kwargs.keys(), list(subst_none(kwargs.values()))))
 231         ret = self._xmlrpc_handler.send_rpc(cmd, self._in_fd, self._out_fd,
 232                                             *args, **kwargs)
 233         if ret == IkiWikiProcedureProxy._IKIWIKI_NIL_SENTINEL:
 234             ret = None
 235         return ret
 236
 237     def hook(self, type, function, name=None, id=None, last=False):
 238         if self._imported:
 239             raise AlreadyImported()
 240
 241         if name is None:
 242             name = function.__name__
 243
 244         if id is None:
 245             id = self._id
 246
 247         def hook_proxy(*args):
 248 #            curpage = args[0]
 249 #            kwargs = dict([args[i:i+2] for i in xrange(1, len(args), 2)])
 250             ret = function(self, *args)
 251             self._debug_fn(
 252                     "{} hook `{}' returned: [{}]".format(type, name, ret))
 253             if ret == IkiWikiProcedureProxy._IKIWIKI_NIL_SENTINEL:
 254                 raise InvalidReturnValue(
 255                     'hook functions are not allowed to return {}'.format(
 256                         IkiWikiProcedureProxy._IKIWIKI_NIL_SENTINEL))
 257             if ret is None:
 258                 ret = IkiWikiProcedureProxy._IKIWIKI_NIL_SENTINEL
 259             return ret
 260
 261         self._hooks.append((id, type, name, last))
 262         self._xmlrpc_handler.register_function(hook_proxy, name=name)
 263
 264     def inject(self, rname, function, name=None, memoize=True):
 265         if self._imported:
 266             raise AlreadyImported()
 267
 268         if name is None:
 269             name = function.__name__
 270
 271         self._functions.append((rname, name, memoize))
 272         self._xmlrpc_handler.register_function(function, name=name)
 273
 274     def getargv(self):
 275         return self.rpc('getargv')
 276
 277     def setargv(self, argv):
 278         return self.rpc('setargv', argv)
 279
 280     def getvar(self, hash, key):
 281         return self.rpc('getvar', hash, key)
 282
 283     def setvar(self, hash, key, value):
 284         return self.rpc('setvar', hash, key, value)
 285
 286     def getstate(self, page, id, key):
 287         return self.rpc('getstate', page, id, key)
 288
 289     def setstate(self, page, id, key, value):
 290         return self.rpc('setstate', page, id, key, value)
 291
 292     def pagespec_match(self, spec):
 293         return self.rpc('pagespec_match', spec)
 294
 295     def error(self, msg):
 296         try:
 297             self.rpc('error', msg)
 298         except IOError as e:
 299             if e.errno != 32:
 300                 raise
 301         import posix
 302         sys.exit(posix.EX_SOFTWARE)
 303
 304     def run(self):
 305         try:
 306             while True:
 307                 ret = self._xmlrpc_handler.handle_rpc(
 308                     self._in_fd, self._out_fd)
 309                 time.sleep(IkiWikiProcedureProxy._LOOP_DELAY)
 310         except GoingDown:
 311             return
 312
 313         except Exception as e:
 314             import traceback
 315             tb = traceback.format_exc()
 316             self.error('uncaught exception: {}\n{}'.format(e, tb))
 317             return
 318
 319     def _importme(self):
 320         self._debug_fn('importing...')
 321         for id, type, function, last in self._hooks:
 322             self._debug_fn('hooking {}/{} into {} chain...'.format(
 323                     id, function, type))
 324             self.rpc('hook', id=id, type=type, call=function, last=last)
 325         for rname, function, memoize in self._functions:
 326             self._debug_fn('injecting {} as {}...'.format(function, rname))
 327             self.rpc('inject', name=rname, call=function, memoize=memoize)
 328         self._imported = True
 329         return IkiWikiProcedureProxy._IKIWIKI_NIL_SENTINEL