doc/bugs/Error_with_external_plugins.mdwn

   1 Hello,
   2 I stumbled upon this bug when writing a Python plugin. I think this is a ikiwiki bug, since I do not think my plugin does anything wrong.
   3
   4 # Example
   5
   6 I set up an example wiki, containing the setup file and the plugin, [[on github|https://github.com/paternal/ikiwiki-rpcbug]].
   7
   8 1. Clone the repository
   9
  10         git clone https://github.com/paternal/ikiwiki-rpcbug.git
  11
  12 2. Change to the right directory
  13
  14         cd ikiwiki-rpcbug
  15
  16 2. Add the right ikiwiki directory to PYTHONPATH
  17
  18         export PYTHONPATH="$PYTHONPATH:$(dirname $(dpkg -L ikiwiki | grep proxy))"
  19
  20 3. Build the wiki
  21
  22         ikiwiki --setup wiki.setup --rebuild
  23
  24 4. The problem is in page [[http://localhost/~USERNAME/ikiwiki_bug_rpc/foo/]] (for instance, [[http://localhost/~USERNAME/ikiwiki_bug_rpc]] is fine.
  25
  26 # Problem
  27
  28 Page `foo` contains the directive ``[[!rpcbug]]`` (`rpcbug` being the name of the plugin). Calling [[``proxy.rpc("srcfile", "bar")``|https://github.com/paternal/ikiwiki-rpcbug/blob/master/plugins/rpcbug#L15]] in the preprocess function seems to mess up the RPC communication between ikiwiki and the plugin, and the result is that the generate `foo/index.html` page is a text file containing the return value of the `preprocess` call.
  29
  30 What I do not understand is that disabling the `format` function (by commenting [[line 46 of the plugin|https://github.com/paternal/ikiwiki-rpcbug/blob/master/plugins/rpcbug#L46]]) solves the problem. Half of an explaination is that I think that when the the ``proxy.rpc`` function is called, the RPC communication is messed up in such a way that the `format` function is not called, and the return value of `preprocess` is considered to be the whole html code of the resulting page.
  31
  32 > I understood that: as the first rpc call messes up the communication, more rpc calls are messed up, but if there is only one rpc call, not that much is broken. -- [[Louis|spalax]]
  33
  34 I hope someone will understand the problem better than I do, because I have no idea about how to solve this.
  35
  36 Regards,
  37 -- [[Louis|spalax]]