#
# 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
+# Copyright © 2008 martin f. krafft <madduck@madduck.net>
+# 2008-2011 Joey Hess <joey@kitenet.net>
+# 2012 W. Trevor King <wking@tremily.us>
+#
+# 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'
+__version__ = '0.2'
__author__ = 'martin f. krafft <madduck@madduck.net>'
__copyright__ = 'Copyright © ' + __author__
-__licence__ = 'GPLv2'
+__licence__ = 'BSD-2-clause'
import sys
import time
-import xmlrpclib
import xml.parsers.expat
-from SimpleXMLRPCServer import SimpleXMLRPCDispatcher
+try: # Python 3
+ import xmlrpc.client as _xmlrpc_client
+except ImportError: # Python 2
+ import xmlrpclib as _xmlrpc_client
+try: # Python 3
+ import xmlrpc.server as _xmlrpc_server
+except ImportError: # Python 2
+ import SimpleXMLRPCServer as _xmlrpc_server
+
+
+class ParseError (Exception):
+ pass
+
+
+class PipeliningDetected (Exception):
+ pass
+
+
+class GoingDown (Exception):
+ pass
+
-class _IkiWikiExtPluginXMLRPCDispatcher(SimpleXMLRPCDispatcher):
+class InvalidReturnValue (Exception):
+ pass
+
+
+class AlreadyImported (Exception):
+ pass
+
+
+class _IkiWikiExtPluginXMLRPCDispatcher(_xmlrpc_server.SimpleXMLRPCDispatcher):
def __init__(self, allow_none=False, encoding=None):
try:
- SimpleXMLRPCDispatcher.__init__(self, allow_none, encoding)
+ _xmlrpc_server.SimpleXMLRPCDispatcher.__init__(
+ self, allow_none, encoding)
except TypeError:
# see http://bugs.debian.org/470645
# python2.4 and before only took one argument
- SimpleXMLRPCDispatcher.__init__(self)
+ _xmlrpc_server.SimpleXMLRPCDispatcher.__init__(self)
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()
def _pop_tag(self, tag):
top = self._stack.pop()
if top != tag:
- raise ParseError, 'expected %s closing tag, got %s' % (top, tag)
+ raise ParseError(
+ 'expected {0} closing tag, got {1}'.format(top, tag))
def _request_complete(self):
return self._first_tag_received and len(self._stack) == 0
def _check_pipelining(self, *args):
if self._first_tag_received:
- raise PipeliningDetected, 'need a new line between XML documents'
+ raise PipeliningDetected('need a new line between XML documents')
def parse(self, data):
self._parser.Parse(data, False)
self._reset()
return ret
- class ParseError(Exception):
- pass
-
- class PipeliningDetected(Exception):
- pass
class _IkiWikiExtPluginXMLRPCHandler(object):
@staticmethod
def _read(in_fd):
ret = None
- parser = _XMLStreamParser()
+ parser = XMLStreamParser()
while True:
line = in_fd.readline()
if len(line) == 0:
return ret
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)
+ xml = _xmlrpc_client.dumps(sum(kwargs.items(), args), cmd)
+ self._debug_fn(
+ "calling ikiwiki procedure `{0}': [{1}]".format(cmd, repr(xml)))
+ # ensure that encoded is a str (bytestring in Python 2, Unicode in 3)
+ if str is bytes and not isinstance(xml, str):
+ encoded = xml.encode('utf8')
+ else:
+ encoded = xml
+ _IkiWikiExtPluginXMLRPCHandler._write(out_fd, encoded)
self._debug_fn('reading response from ikiwiki...')
- xml = _IkiWikiExtPluginXMLRPCHandler._read(in_fd)
- self._debug_fn('read response to procedure %s from ikiwiki: [%s]' % (cmd, xml))
+ response = _IkiWikiExtPluginXMLRPCHandler._read(in_fd)
+ if str is bytes and not isinstance(response, str):
+ xml = response.encode('utf8')
+ else:
+ xml = response
+ self._debug_fn(
+ 'read response to procedure {0} from ikiwiki: [{1}]'.format(
+ cmd, repr(xml)))
if xml is None:
# ikiwiki is going down
- return None
+ self._debug_fn('ikiwiki is going down, and so are we...')
+ raise GoingDown()
- data = xmlrpclib.loads(xml)[0][0]
- self._debug_fn('parsed data from response to procedure %s: [%s]' % (cmd, data))
+ data = _xmlrpc_client.loads(xml)[0][0]
+ self._debug_fn(
+ 'parsed data from response to procedure {0}: [{1}]'.format(
+ cmd, repr(data)))
return data
def handle_rpc(self, in_fd, out_fd):
if xml is None:
# ikiwiki is going down
self._debug_fn('ikiwiki is going down, and so are we...')
- return
+ raise GoingDown()
- self._debug_fn('received procedure call from ikiwiki: [%s]' % xml)
- params, method = xmlrpclib.loads(xml)
+ self._debug_fn(
+ 'received procedure call from ikiwiki: [{0}]'.format(xml))
+ params, method = _xmlrpc_client.loads(xml)
ret = self._dispatcher.dispatch(method, params)
- xml = xmlrpclib.dumps((ret,), methodresponse=True)
- self._debug_fn('sending procedure response to ikiwiki: [%s]' % xml)
+ xml = _xmlrpc_client.dumps((ret,), methodresponse=True)
+ self._debug_fn(
+ 'sending procedure response to ikiwiki: [{0}]'.format(xml))
_IkiWikiExtPluginXMLRPCHandler._write(out_fd, xml)
return ret
+
class IkiWikiProcedureProxy(object):
# how to communicate None to ikiwiki
yield i
args = list(subst_none(args))
- kwargs = dict(zip(kwargs.keys(), list(subst_none(kwargs.itervalues()))))
+ kwargs = dict(zip(kwargs.keys(), list(subst_none(kwargs.values()))))
ret = self._xmlrpc_handler.send_rpc(cmd, self._in_fd, self._out_fd,
*args, **kwargs)
if ret == IkiWikiProcedureProxy._IKIWIKI_NIL_SENTINEL:
def hook(self, type, function, name=None, id=None, last=False):
if self._imported:
- raise IkiWikiProcedureProxy.AlreadyImported
+ raise AlreadyImported()
if name is None:
name = function.__name__
# curpage = args[0]
# kwargs = dict([args[i:i+2] for i in xrange(1, len(args), 2)])
ret = function(self, *args)
- self._debug_fn("%s hook `%s' returned: [%s]" % (type, name, ret))
+ self._debug_fn(
+ "{0} hook `{1}' returned: [{2}]".format(type, name, repr(ret)))
if ret == IkiWikiProcedureProxy._IKIWIKI_NIL_SENTINEL:
- raise IkiWikiProcedureProxy.InvalidReturnValue, \
- 'hook functions are not allowed to return %s' \
- % IkiWikiProcedureProxy._IKIWIKI_NIL_SENTINEL
+ raise InvalidReturnValue(
+ 'hook functions are not allowed to return {0}'.format(
+ IkiWikiProcedureProxy._IKIWIKI_NIL_SENTINEL))
if ret is None:
ret = IkiWikiProcedureProxy._IKIWIKI_NIL_SENTINEL
return ret
def inject(self, rname, function, name=None, memoize=True):
if self._imported:
- raise IkiWikiProcedureProxy.AlreadyImported
+ raise AlreadyImported()
if name is None:
name = function.__name__
def error(self, msg):
try:
self.rpc('error', msg)
- except IOError, e:
+ except IOError as 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
+ ret = self._xmlrpc_handler.handle_rpc(
+ self._in_fd, self._out_fd)
time.sleep(IkiWikiProcedureProxy._LOOP_DELAY)
- except Exception, e:
+ except GoingDown:
+ return
+
+ except Exception as 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)
+ tb = traceback.format_exc()
+ self.error('uncaught exception: {0}\n{1}'.format(e, tb))
+ 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._debug_fn('hooking {0}/{1} into {2} chain...'.format(
+ 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._debug_fn('injecting {0} as {1}...'.format(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