4dc55e30219667428cff64d57931683cb88ebd71
[ikiwiki.git] / doc / plugins / write.mdwn
1 Ikiwiki's plugin interface allows all kinds of useful [[plugins]] to be
2 written to extend ikiwiki in many ways. Despite the length of this page,
3 it's not really hard. This page is a complete reference to everything a
4 plugin might want to do. There is also a quick [[tutorial]].
5
6 [[toc levels=2]]
7
8 ## Types of plugins
9
10 Most ikiwiki [[plugins]] are written in perl, like ikiwiki. This gives the
11 plugin full access to ikiwiki's internals, and is the most efficient.
12 However, plugins can actually be written in any language that supports XML
13 RPC. These are called [[external]] plugins.
14
15 A plugin written in perl is a perl module, in the `IkiWiki::Plugin`
16 namespace. The name of the plugin is typically in lowercase, such as
17 `IkiWiki::Plugin::inline`. Ikiwiki includes a `IkiWiki::Plugin::skeleton`
18 that can be fleshed out to make a useful plugin.
19 `IkiWiki::Plugin::pagecount` is another simple example. All perl plugins
20 should `use IkiWiki` to import the ikiwiki plugin interface. It's a good
21 idea to include the version number of the plugin interface that your plugin
22 expects: `use IkiWiki 2.00`.
23
24 An external plugin is an executable program. It can be written in any
25 language. Its interface to ikiwiki is via XML RPC, which it reads from
26 ikiwiki on its standard input, and writes to ikiwiki on its standard
27 output. For more details on writing external plugins, see [[external]].
28
29 Despite these two types of plugins having such different interfaces,
30 they're the same as far as how they hook into ikiwiki. This document will
31 explain how to write both sorts of plugins, albeit with an emphasis on perl
32 plugins.
33
34 ## Considerations
35
36 One thing to keep in mind when writing a plugin is that ikiwiki is a wiki
37 *compiler*. So plugins influence pages when they are built, not when they
38 are loaded. A plugin that inserts the current time into a page, for
39 example, will insert the build time. Also, as a compiler, ikiwiki avoids
40 rebuilding pages unless they have changed, so a plugin that prints some
41 random or changing thing on a page will generate a static page that won't
42 change until ikiwiki rebuilds the page for some other reason, like the page
43 being edited.
44
45 ## Registering plugins
46
47 Plugins should, when imported, call `hook()` to hook into ikiwiki's
48 processing. The function uses named parameters, and use varies depending on
49 the type of hook being registered -- see below. A plugin can call
50 the function more than once to register multiple hooks.
51
52 All calls to `hook()` should be passed a "type" parameter, which gives the
53 type of hook, a "id" parameter, which should be a unique string for this
54 plugin, and a "call" parameter, which tells what function to call for the
55 hook.
56
57 An optional "last" parameter, if set to a true value, makes the hook run
58 after all other hooks of its type. Useful if the hook depends on some other
59 hook being run first.
60
61 ## Types of hooks
62
63 In roughly the order they are called.
64
65 ### getopt
66
67         hook(type => "getopt", id => "foo", call => \&getopt);
68
69 This allows for plugins to perform their own processing of command-line
70 options and so add options to the ikiwiki command line. It's called during
71 command line processing, with @ARGV full of any options that ikiwiki was
72 not able to process on its own. The function should process any options it
73 can, removing them from @ARGV, and probably recording the configuration
74 settings in %config. It should take care not to abort if it sees
75 an option it cannot process, and should just skip over those options and
76 leave them in @ARGV.
77
78 ### checkconfig
79
80         hook(type => "checkconfig", id => "foo", call => \&checkconfig);
81
82 This is useful if the plugin needs to check for or modify ikiwiki's
83 configuration. It's called early in the startup process. The
84 function is passed no values. It's ok for the function to call
85 `error()` if something isn't configured right.
86
87 ### refresh
88
89         hook(type => "refresh", id => "foo", call => \&refresh);
90
91 This hook is called just before ikiwiki scans the wiki for changed files.
92 It's useful for plugins that need to create or modify a source page. The
93 function is passed no values.
94
95 ### needsbuild
96
97         hook(type => "needsbuild", id => "foo", call => \&needsbuild);
98
99 This allows a plugin to manipulate the list of files that need to be
100 built when the wiki is refreshed. The function is passed a reference to an
101 array of pages that will be rebuilt, and can modify the array, either
102 adding or removing files from it.
103
104 ### scan
105
106         hook(type => "scan", id => "foo", call => \&scan);
107
108 This hook is called early in the process of building the wiki, and is used
109 as a first pass scan of the page, to collect metadata about the page. It's
110 mostly used to scan the page for WikiLinks, and add them to `%links`.
111 Present in IkiWiki 2.40 and later.
112
113 The function is passed named parameters "page" and "content". Its return
114 value is ignored.
115
116 ### filter
117
118         hook(type => "filter", id => "foo", call => \&filter);
119
120 Runs on the raw source of a page, before anything else touches it, and can
121 make arbitrary changes. The function is passed named parameters "page",
122 "destpage", and "content". It should return the filtered content.
123
124 ### preprocess
125
126 Adding a [[ikiwiki/PreProcessorDirective]] is probably the most common use
127 of a plugin.
128
129         hook(type => "preprocess", id => "foo", call => \&preprocess);
130
131 Replace "foo" with the command name that will be used inside brackets for
132 the preprocessor directive.
133
134 Each time the directive is processed, the referenced function (`preprocess`
135 in the example above) is called, and is passed named parameters. A "page"
136 parameter gives the name of the page that embedded the preprocessor
137 directive, while a "destpage" parameter gives the name of the page the
138 content is going to (different for inlined pages), and a "preview"
139 parameter is set to a true value if the page is being previewed. All
140 parameters included in the directive are included as named parameters as
141 well. Whatever the function returns goes onto the page in place of the
142 directive.
143
144 An optional "scan" parameter, if set to a true value, makes the hook be
145 called during the preliminary scan that ikiwiki makes of updated pages,
146 before begining to render pages. This parameter should be set to true if
147 the hook modifies data in `%links`. Note that doing so will make the hook
148 be run twice per page build, so avoid doing it for expensive hooks. (As an
149 optimisation, if your preprocessor hook is called in a void contets, you
150 can assume it's being run in scan mode.)
151
152 Note that if the [[htmlscrubber]] is enabled, html in
153 [[ikiwiki/PreProcessorDirective]] output is sanitised, which may limit what
154 your plugin can do. Also, the rest of the page content is not in html
155 format at preprocessor time. Text output by a preprocessor directive will
156 be linkified and passed through markdown (or whatever engine is used to
157 htmlize the page) along with the rest of the page.
158
159 ### linkify
160
161         hook(type => "linkify", id => "foo", call => \&linkify);
162
163 This hook is called to convert [[WikiLinks|WikiLink]] on the page into html
164 links. The function is passed named parameters "page", "destpage", and
165 "content". It should return the linkified content.  Present in IkiWiki 2.40
166 and later.
167
168 Plugins that implement linkify must also implement a scan hook, that scans
169 for the links on the page and adds them to `%links`.
170
171 ### htmlize
172
173         hook(type => "htmlize", id => "ext", call => \&htmlize);
174
175 Runs on the source of a page and turns it into html. The id parameter
176 specifies the filename extension that a file must have to be htmlized using
177 this plugin. This is how you can add support for new and exciting markup
178 languages to ikiwiki.
179
180 The function is passed named parameters: "page" and "content" and should
181 return the htmlized content.
182
183 ### pagetemplate
184
185         hook(type => "pagetemplate", id => "foo", call => \&pagetemplate);
186
187 [[Templates|wikitemplates]] are filled out for many different things in
188 ikiwiki, like generating a page, or part of a blog page, or an rss feed, or
189 a cgi. This hook allows modifying the variables available on those
190 templates. The function is passed named parameters. The "page" and
191 "destpage" parameters are the same as for a preprocess hook. The "template"
192 parameter is a [[cpan HTML::Template]] object that is the template that
193 will be used to generate the page. The function can manipulate that
194 template object.
195
196 The most common thing to do is probably to call `$template->param()` to add
197 a new custom parameter to the template.
198
199 ### templatefile
200
201         hook(type => "templatefile", id => "foo", call => \&templatefile);
202
203 This hook allows plugins to change the [[template|wikitemplates]] that is
204 used for a page in the wiki. The hook is passed a "page" parameter, and
205 should return the name of the template file to use, or undef if it doesn't
206 want to change the default ("page.tmpl"). Template files are looked for in
207 /usr/share/ikiwiki/templates by default.
208
209 ### sanitize
210
211         hook(type => "sanitize", id => "foo", call => \&sanitize);
212
213 Use this to implement html sanitization or anything else that needs to
214 modify the body of a page after it has been fully converted to html.
215
216 The function is passed named parameters: "page", "destpage", and "content",
217 and should return the sanitized content.
218
219 ### format
220
221         hook(type => "format", id => "foo", call => \&format);
222
223 The difference between format and sanitize is that sanitize only acts on
224 the page body, while format can modify the entire html page including the
225 header and footer inserted by ikiwiki, the html document type, etc. (It
226 should not rely on always being passed the entire page, as it won't be
227 when the page is being previewed.)
228
229 The function is passed named parameters: "page" and "content", and 
230 should return the formatted content.
231
232 ### delete
233
234         hook(type => "delete", id => "foo", call => \&delete);
235
236 Each time a page or pages is removed from the wiki, the referenced function
237 is called, and passed the names of the source files that were removed.
238
239 ### change
240
241         hook(type => "change", id => "foo", call => \&render);
242
243 Each time ikiwiki renders a change or addition (but not deletion) to the
244 wiki, the referenced function is called, and passed the names of the
245 source files that were rendered.
246
247 ### cgi
248
249         hook(type => "cgi", id => "foo", call => \&cgi);
250
251 Use this to hook into ikiwiki's cgi script. Each registered cgi hook is
252 called in turn, and passed a CGI object. The hook should examine the
253 parameters, and if it will handle this CGI request, output a page
254 (including the http headers) and terminate the program.
255
256 Note that cgi hooks are called as early as possible, before any ikiwiki
257 state is loaded, and with no session information.
258
259 ### auth
260
261         hook(type => "auth", id => "foo", call => \&auth);
262
263 This hook can be used to implement an authentication method. When a user
264 needs to be authenticated, each registered auth hook is called in turn, and
265 passed a CGI object and a session object. 
266
267 If the hook is able to authenticate the user, it should set the session
268 object's "name" parameter to the authenticated user's name. Note that
269 if the name is set to the name of a user who is not registered,
270 a basic registration of the user will be automatically performed.
271
272 ### sessioncgi
273
274         hook(type => "sessioncgi", id => "foo", call => \&sessioncgi);
275
276 Unlike the cgi hook, which is run as soon as possible, the sessioncgi hook
277 is only run once a session object is available. It is passed both a CGI
278 object and a session object. To check if the user is in fact signed in, you
279 can check if the session object has a "name" parameter set.
280
281 ### canedit
282
283         hook(type => "canedit", id => "foo", call => \&pagelocked);
284
285 This hook can be used to implement arbitrary access methods to control when
286 a page can be edited using the web interface (commits from revision control
287 bypass it). When a page is edited, each registered canedit hook is called
288 in turn, and passed the page name, a CGI object, and a session object.
289
290 If the hook has no opinion about whether the edit can proceed, return
291 `undef`, and the next plugin will be asked to decide. If edit can proceed,
292 the hook should return "". If the edit is not allowed by this hook, the
293 hook should return an error message for the user to see, or a function 
294 that can be run to log the user in or perform other action necessary for
295 them to be able to edit the page.
296
297 This hook should avoid directly redirecting the user to a signin page,
298 since it's sometimes used to test to see which pages in a set of pages a
299 user can edit.
300
301 ### editcontent
302
303         hook(type => "editcontent", id => "foo", call => \&editcontent);
304
305 This hook is called when a page is saved (or previewed) using the web
306 interface. It is passed named parameters: `content`, `page`, `cgi`, and
307 `session`. These are, respectively, the new page content as entered by the
308 user, the page name, a `CGI` object, and the user's `CGI::Session`. 
309
310 It can modify the content as desired, and should return the content.
311
312 ### formbuilder
313
314         hook(type => "formbuilder_setup", id => "foo", call => \&formbuilder_setup);
315         hook(type => "formbuilder", id => "foo", call => \&formbuilder);
316
317 These hooks allow tapping into the parts of ikiwiki that use [[cpan
318 CGI::FormBuilder]] to generate web forms. These hooks are passed named
319 parameters: `cgi`, `session`, `form`, and `buttons`. These are, respectively,
320 the `CGI` object, the user's `CGI::Session`, a `CGI::FormBuilder`, and a
321 reference to an array of names of buttons to go on the form.
322
323 Each time a form is set up, the `formbuilder_setup` hook is called.
324 Typically the `formbuilder_setup` hook will check the form's title, and if
325 it's a form that it needs to modify, will call various methods to
326 add/remove/change fields, tweak the validation code for the fields, etc. It
327 will not validate or display the form.
328
329 Just before a form is displayed to the user, the `formbuilder` hook is
330 called. It can be used to validate the form, but should not display it.
331
332 ### savestate
333
334         hook(type => "savestate", id => "foo", call => \&savestate);
335
336 This hook is called whenever ikiwiki normally saves its state, just before
337 the state is saved. The function can save other state, modify values before
338 they're saved, etc.
339
340 ## Plugin interface
341
342 To import the ikiwiki plugin interface:
343
344         use IkiWiki '2.00';
345
346 This will import several variables and functions into your plugin's
347 namespace. These variables and functions are the ones most plugins need,
348 and a special effort will be made to avoid changing them in incompatible
349 ways, and to document any changes that have to be made in the future.
350
351 Note that IkiWiki also provides other variables and functions that are not
352 exported by default. No guarantee is made about these in the future, so if
353 it's not exported, the wise choice is to not use it.
354
355 ### %config
356
357 A plugin can access the wiki's configuration via the `%config`
358 hash. The best way to understand the contents of the hash is to look at
359 [[ikiwiki.setup]], which sets the hash content to configure the wiki.
360
361 ### %pagestate
362
363 The `%pagestate` hash can be used by plugins to save state that they will need
364 next time ikiwiki is run. The hash holds per-page state, so to set a value,
365 use `%pagestate{$page}{$id}{$key}=$value`, and to retrieve the value,
366 use `%pagestate{$page}{$id}{$key}`.
367
368 The `$value` can be anything that perl's Storable module is capable of
369 serializing. `$key` can be any string you like, but `$id` must be the same
370 as the "id" parameter passed to `hook()` when registering the plugin. This
371 is so ikiwiki can know when to delete pagestate for plugins that are no
372 longer used.
373
374 When pages are deleted, ikiwiki automatically deletes their pagestate too.
375
376 Note that page state does not persist across wiki rebuilds, only across
377 wiki updates.
378
379 ### Other variables
380
381 If your plugin needs to access data about other pages in the wiki. It can
382 use the following hashes, using a page name as the key:
383
384 * `%links` lists the names of each page that a page links to, in an array
385   reference.
386 * `%destsources` contains the name of the source file used to create each
387   destination file.
388 * `%pagesources` contains the name of the source file for each page.
389
390 Also, the %IkiWiki::version variable contains the version number for the
391 ikiwiki program.
392
393 ### Library functions
394
395 #### `hook(@)`
396
397 Hook into ikiwiki's processing. See the discussion of hooks above.
398
399 Note that in addition to the named parameters described above, a parameter
400 named `no_override` is supported, If it's set to a true value, then this hook
401 will not override any existing hook with the same id. This is useful if
402 the id can be controled by the user.
403
404 #### `debug($)`
405
406 Logs a debugging message. These are supressed unless verbose mode is turned
407 on.
408
409 #### `error($;$)`
410
411 Aborts with an error message. If the second parameter is passed, it is a
412 function that is called after the error message is printed, to do any final
413 cleanup.
414
415 If called inside a preprocess hook, error() does not abort the entire
416 wiki build, but instead replaces the [[ikiwiki/PreProcessorDirective]] with
417 a version containing the error message.
418
419 In other hooks, error() is a fatal error, so use with care. Try to avoid
420 dying on bad input when building a page, as that will halt
421 the entire wiki build and make the wiki unusable.
422
423 #### `template($;@)`
424
425 Creates and returns a [[cpan HTML::Template]] object. The first parameter
426 is the name of the file in the template directory. The optional remaining
427 parameters are passed to `HTML::Template->new`.
428
429 #### `htmlpage($)`
430
431 Passed a page name, returns the base name that will be used for a the html
432 page created from it. (Ie, it appends ".html".)
433
434 #### `add_depends($$)`
435
436 Makes the specified page depend on the specified [[ikiwiki/PageSpec]].
437
438 #### `pagespec_match($$;@)`
439
440 Passed a page name, and [[ikiwiki/PageSpec]], returns true if the
441 [[ikiwiki/PageSpec]] matches the page.
442
443 Additional named parameters can be passed, to further limit the match.
444 The most often used is "location", which specifies the location the
445 PageSpec should match against. If not passed, relative PageSpecs will match
446 relative to the top of the wiki.
447
448 #### `bestlink($$)`
449
450 Given a page and the text of a link on the page, determine which
451 existing page that link best points to. Prefers pages under a
452 subdirectory with the same name as the source page, failing that
453 goes down the directory tree to the base looking for matching
454 pages, as described in [[ikiwiki/SubPage/LinkingRules]].
455
456 #### `htmllink($$$;@)`
457
458 Many plugins need to generate html links and add them to a page. This is
459 done by using the `htmllink` function. The usual way to call
460 `htmlllink` is:
461
462         htmllink($page, $page, $link)
463
464 Why is `$page` repeated? Because if a page is inlined inside another, and a
465 link is placed on it, the right way to make that link is actually:
466
467         htmllink($page, $destpage, $link)
468
469 Here `$destpage` is the inlining page. A `destpage` parameter is passed to
470 some of the hook functions above; the ones that are not passed it are not used
471 during inlining and don't need to worry about this issue.
472
473 After the three required parameters, named parameters can be used to
474 control some options. These are:
475
476 * noimageinline - set to true to avoid turning links into inline html images
477 * forcesubpage  - set to force a link to a subpage
478 * linktext - set to force the link text to something
479 * anchor - set to make the link include an anchor
480 * rel - set to add a rel attribute to the link
481 * class - set to add a css class to the link
482
483 #### `readfile($;$)`
484
485 Given a filename, reads and returns the entire file.
486
487 The optional second parameter, if set to a true value, makes the file be read
488 in binary mode.
489
490 A failure to read the file will result in it dying with an error.
491
492 #### `writefile($$$;$$)`
493
494 Given a filename, a directory to put it in, and the file's content,
495 writes a file. 
496
497 The optional fourth parameter, if set to a true value, makes the file be
498 written in binary mode.
499
500 The optional fifth parameter can be used to pass a function reference that
501 will be called to handle writing to the file. The function will be called
502 and passed a file descriptor it should write to, and an error recovery
503 function it should call if the writing fails. (You will not normally need to
504 use this interface.)
505
506 A failure to write the file will result in it dying with an error.
507
508 If the destination directory doesn't exist, it will first be created.
509
510 #### `will_render($$)`
511
512 Given a page name and a destination file name (not including the base
513 destination directory), register that the page will result in that file
514 being rendered. 
515
516 It's important to call this before writing to any file in the destination
517 directory, and it's important to call it consistently every time, even if
518 the file isn't really written this time -- unless you delete any old
519 version of the file. In particular, in preview mode, this should still be
520 called even if the file isn't going to be written to during the preview.
521
522 Ikiwiki uses this information to automatically clean up rendered files when
523 the page that rendered them goes away or is changed to no longer render
524 them. will_render also does a few important security checks.
525
526 #### `pagetype($)`
527
528 Given the name of a source file, returns the type of page it is, if it's
529 a type that ikiwiki knowns how to htmlize. Otherwise, returns undef.
530
531 #### `pagename($)`
532
533 Given the name of a source file, returns the name of the wiki page
534 that corresponds to that file.
535
536 #### `srcfile($;$)`
537
538 Given the name of a source file in the wiki, searches for the file in
539 the source directory and the underlay directories (most recently added
540 underlays first), and returns the full path to the first file found.
541
542 Normally srcfile will fail with an error message if the source file cannot
543 be found. The second parameter can be set to a true value to make it return
544 undef instead.
545
546 #### `add_underlay($)`
547
548 Adds a directory to the set of underlay directories that ikiwiki will
549 search for files.
550
551 If the directory name is not absolute, ikiwiki will assume it is in
552 the parent directory of the configured underlaydir.
553
554 #### `displaytime($;$)`
555
556 Given a time, formats it for display.
557
558 The optional second parameter is a strftime format to use to format the
559 time.
560
561 #### `gettext`
562
563 This is the standard gettext function, although slightly optimised.
564
565 #### `urlto($$)`
566
567 Construct a relative url to the first parameter from the page named by the
568 second. The first parameter can be either a page name, or some other
569 destination file, as registered by `will_render`.
570
571 #### `targetpage($$)`
572
573 Passed a page and an extension, returns the filename that page will be
574 rendered to.
575
576 ## Miscellaneous
577
578 ### Internal use pages
579
580 Sometimes it's useful to put pages in the wiki without the overhead of
581 having them be rendered to individual html files. Such internal use pages
582 are collected together to form the RecentChanges page, for example.
583
584 To make an internal use page, register a filename extension that starts
585 with "_". Internal use pages cannot be edited with the web interface,
586 generally shouldn't contain wikilinks or preprocessor directives (use
587 either on them with extreme caution), and are not matched by regular
588 PageSpecs glob patterns, but instead only by a special `internal()`
589 [[ikiwiki/PageSpec]].
590
591 ### RCS plugins
592
593 ikiwiki's support for [[revision_control_systems|rcs]] also uses pluggable
594 perl modules. These are in the `IkiWiki::RCS` namespace, for example
595 `IkiWiki::RCS::svn`. 
596
597 Each RCS plugin must support all the `IkiWiki::rcs_*` functions.
598 See IkiWiki::RCS::Stub for the full list of functions. It's ok if
599 `rcs_getctime` does nothing except for throwing an error.
600
601 See [[RCS_details|rcs/details]] for some more info.
602
603 ### PageSpec plugins
604
605 It's also possible to write plugins that add new functions to
606 [[PageSpecs|ikiwiki/PageSpec]]. Such a plugin should add a function to the
607 IkiWiki::PageSpec package, that is named `match_foo`, where "foo()" is
608 how it will be accessed in a [[ikiwiki/PageSpec]]. The function will be passed
609 two parameters: The name of the page being matched, and the thing to match
610 against. It may also be passed additional, named parameters. It should return
611 a IkiWiki::SuccessReason object if the match succeeds, or an
612 IkiWiki::FailReason object if the match fails.
613
614 ### Setup plugins
615
616 The ikiwiki setup file is loaded using a pluggable mechanism. If you
617 look at the top of [[ikiwiki.setup]], it starts with 
618 'use IkiWiki::Setup::Standard', and the rest of the file is passed to
619 that module's import method.
620
621 It's possible to write other modules in the `IkiWiki::Setup::` namespace that
622 can be used to configure ikiwiki in different ways. These modules should,
623 when imported, populate `$IkiWiki::Setup::raw_setup` with a reference
624 to a hash containing all the config items.
625
626 By the way, to parse a ikiwiki setup file, a program just needs to
627 do something like `use IkiWiki::Setup; my %setup=IkiWiki::Setup::load($filename)`