doc/plugins/write/external.mdwn

   1 External plugins are standalone, executable programs, that can be written
   2 in any language. When ikiwiki starts up, it runs the program, and
   3 communicates with it using XML RPC. If you want to [[write]] an external
   4 plugin, read on..
   5
   6 ikiwiki contains one sample external plugin, named `externaldemo`. This is
   7 written in perl, but is intended to be an example of how to write an
   8 external plugin in your favorite programming language. Wow us at how much
   9 easier you can do the same thing in your favorite language. ;-)
  10
  11 [[toc ]]
  12
  13 ## How external plugins use XML RPC
  14
  15 While XML RPC is typically used over http, ikiwiki doesn't do that.
  16 Instead, the external plugin reads XML RPC data from stdin, and writes it
  17 to stdout. To ease parsing, each separate XML RPC request or response must
  18 start at the beginning of a line, and end with a newline. When outputting
  19 XML RPC to stdout, be _sure_ to flush stdout. Failure to do so will result
  20 in deadlock!
  21
  22 An external plugin should operate in a loop. First, read a command from
  23 stdin, using XML RPC. Dispatch the command, and return its result to
  24 stdout, also using XML RPC. After reading a command, and before returning
  25 the result, the plugin can output XML RPC requests of its own, calling
  26 functions in ikiwiki. Note: *Never* make an XML RPC request at any other
  27 time. Ikiwiki won't be listening for it, and you will deadlock.
  28
  29 When ikiwiki starts up an external plugin, the first RPC it will make
  30 is to call the plugin's `import()` function. That function typically makes
  31 an RPC to ikiwiki's `hook()` function, registering a callback.
  32
  33 An external plugin can use XML RPC to call any of the exported functions
  34 documented in the [[plugin_interface_documentation|write]]. It can also
  35 actually call any non-exported IkiWiki function, but doing so is a good way
  36 to break your plugin when ikiwiki changes. There is currently no versioned
  37 interface like there is for perl plugins, but external plugins were first
  38 supported in ikiwiki version 2.6.
  39
  40 ## Accessing data structures
  41
  42 Ikiwiki has a few global data structures such as `%config`, which holds
  43 its configuration. External plugins can use the `getvar` and `setvar` RPCs
  44 to access any such global hash. To get the "url" configuration value,
  45 call `getvar("config", "url")`. To set it, call
  46 `setvar("config", "url", "http://example.com/)`.
  47
  48 ## Notes on function parameters
  49
  50 The [[plugin_interface_documentation|write]] talks about functions that take
  51 "named parameters". When such a function is called over XML RPC, such named
  52 parameters look like a list of keys and values:
  53
  54         page, foo, destpage, bar, magnify, 1
  55
  56 If a name is repeated in the list, the later value overrides the earlier
  57 one:
  58
  59         name, Bob, age, 20, name, Sally, gender, female
  60
  61 In perl, boiling this down to an associative array of named parameters is
  62 very easy:
  63
  64         sub foo {
  65                 my %params=@list;
  66
  67 Other languages might not find it so easy. If not, it might be a good idea
  68 to convert these named parameters into something more natural for the
  69 language as part of their XML RPC interface.
  70
  71 ## Function injection
  72
  73 Some parts of ikiwiki are extensible by adding functions. For example, the
  74 RCS interface relies on plugins providing several IkiWiki::rcs_* functions.
  75 It's actually possible to do this from an external plugin too.
  76
  77 To make your external plugin provide an `IkiWiki::rcs_update` function, for
  78 example, make an RPC call to `inject`. Pass it named parameters "name" and
  79 "call", where "name" is the name of the function to inject into perl (here
  80 "Ikiwiki::rcs_update" and "call" is the RPC call ikiwiki will make whenever
  81 that function is run.
  82
  83 If the RPC call is memoizable, you can also pass a "memoize" parameter, set
  84 to 1.
  85
  86 ## Limitations of XML RPC
  87
  88 Since XML RPC can't pass around references to objects, it can't be used
  89 with functions that take or return such references. That means you can't
  90 use XML RPC for `cgi` or `formbuilder` hooks (which are passed CGI and
  91 FormBuilder perl objects), or use it to call `template()` (which returns a
  92 perl HTML::Template object).
  93
  94 Also. the `getopt` hook doesn't work, as ARGV is not available to the external
  95 plugin.
  96
  97 ## Performance issues
  98
  99 Since each external plugin is a separate process, when ikiwiki is
 100 configured to use lots of external plugins, it will start up slower, and
 101 use more resources. One or two should not be a problem though.
 102
 103 There is some overhead in using XML RPC for function calls. Most plugins
 104 should find it to be pretty minimal though. In one benchmark, ikiwiki was
 105 able to perform 10000 simple XML RPC calls in 11 seconds -- 900 per second.
 106
 107 Using external plugins for hooks such as `sanitize` and `format`, which
 108 pass around entire pages, and are run for each page rendered, will cause
 109 more XML RPC overhead than usual, due to the larger number of calls, and the
 110 large quantity of data conversion going on. In contrast, `preprocess` hooks
 111 are called generally rarely, and pass around minimal data.
 112
 113 External plugins should avoid making RPC calls unnecessarily (ie, in a loop).
 114 Memoizing the results of appropriate RPC calls is one good way to minimise the
 115 number of calls.
 116
 117 Injecting a replacement for a commonly called ikiwiki function
 118 could result in a lot more RPC calls than expected and slow
 119 eveything down. `pagetitle`, for instance, is called about 100 times
 120 per page build. Whenever possible, you should tell ikiwiki to memoize
 121 injected functions.
 122
 123 In general, use common sense, and your external plugin will probably
 124 perform ok.