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