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