]> git.vanrenterghem.biz Git - git.ikiwiki.info.git/blob - doc/plugins/write.mdwn
0da425402fb53b826eab803fb619e3daa8ed97c6
[git.ikiwiki.info.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]].
6 [[toc levels=2]]
8 ## Types of plugins
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.
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`.
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]].
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.
34 ## Considerations
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.
45 ## Registering plugins
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.
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.
59 ## Types of hooks
61 In roughly the order they are called.
63 ### getopt
65         hook(type => "getopt", id => "foo", call => \&getopt);
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.
76 ### checkconfig
78         hook(type => "checkconfig", id => "foo", call => \&checkconfig);
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.
85 ### needsbuild
87         hook(type => "needsbuild", id => "foo", call => \&needsbuild);
89 This allows a plugin the manipulate the list of files that need to be
90 built when the wiki is refreshed. The function is passed a reference to an
91 array of pages that will be rebuilt, and can modify the array, either
92 adding or removing files from it.
94 ### filter
96         hook(type => "filter", id => "foo", call => \&filter);
98 Runs on the raw source of a page, before anything else touches it, and can
99 make arbitrary changes. The function is passed named parameters "page",
100 "destpage", and "content". It should return the filtered content.
102 ### preprocess
104 Adding a [[ikiwiki/PreProcessorDirective]] is probably the most common use
105 of a plugin.
107         hook(type => "preprocess", id => "foo", call => \&preprocess);
109 Replace "foo" with the command name that will be used inside brackets for
110 the preprocessor directive.
112 Each time the directive is processed, the referenced function (`preprocess`
113 in the example above) is called, and is passed named parameters. A "page"
114 parameter gives the name of the page that embedded the preprocessor
115 directive, while a "destpage" parameter gives the name of the page the
116 content is going to (different for inlined pages), and a "preview"
117 parameter is set to a true value if the page is being previewed. All
118 parameters included in the directive are included as named parameters as
119 well. Whatever the function returns goes onto the page in place of the
120 directive.
122 An optional "scan" parameter, if set to a true value, makes the hook be
123 called during the preliminary scan that ikiwiki makes of updated pages,
124 before begining to render pages. This parameter should be set to true if
125 the hook modifies data in `%links`. Note that doing so will make the hook
126 be run twice per page build, so avoid doing it for expensive hooks. (As an
127 optimisation, if your preprocessor hook is called in a void contets, you
128 can assume it's being run in scan mode.)
130 Note that if the [[htmlscrubber]] is enabled, html in
131 [[ikiwiki/PreProcessorDirective]] output is sanitised, which may limit what
132 your plugin can do. Also, the rest of the page content is not in html
133 format at preprocessor time. Text output by a preprocessor directive will
134 be linkified and passed through markdown (or whatever engine is used to
135 htmlize the page) along with the rest of the page.
137 ### htmlize
139         hook(type => "htmlize", id => "ext", call => \&htmlize);
141 Runs on the raw source of a page and turns it into html. The id parameter
142 specifies the filename extension that a file must have to be htmlized using
143 this plugin. This is how you can add support for new and exciting markup
144 languages to ikiwiki.
146 The function is passed named parameters: "page" and "content" and should
147 return the htmlized content.
149 ### pagetemplate
151         hook(type => "pagetemplate", id => "foo", call => \&pagetemplate);
153 [[Templates|wikitemplates]] are filled out for many different things in
154 ikiwiki, like generating a page, or part of a blog page, or an rss feed, or
155 a cgi. This hook allows modifying the variables available on those
156 templates. The function is passed named parameters. The "page" and
157 "destpage" parameters are the same as for a preprocess hook. The "template"
158 parameter is a [[cpan HTML::Template]] object that is the template that
159 will be used to generate the page. The function can manipulate that
160 template object.
162 The most common thing to do is probably to call `$template->param()` to add
163 a new custom parameter to the template.
165 ### templatefile
167         hook(type => "templatefile", id => "foo", call => \&templatefile);
169 This hook allows plugins to change the [[template|wikitemplates]] that is
170 used for a page in the wiki. The hook is passed a "page" parameter, and
171 should return the name of the template file to use, or undef if it doesn't
172 want to change the default ("page.tmpl"). Template files are looked for in
173 /usr/share/ikiwiki/templates by default.
175 ### sanitize
177         hook(type => "sanitize", id => "foo", call => \&sanitize);
179 Use this to implement html sanitization or anything else that needs to
180 modify the body of a page after it has been fully converted to html.
182 The function is passed named parameters: "page" and "content", and 
183 should return the sanitized content.
185 ### format
187         hook(type => "format", id => "foo", call => \&format);
189 The difference between format and sanitize is that sanitize only acts on
190 the page body, while format can modify the entire html page including the
191 header and footer inserted by ikiwiki, the html document type, etc.
193 The function is passed named parameters: "page" and "content", and 
194 should return the formatted content.
196 ### delete
198         hook(type => "delete", id => "foo", call => \&delete);
200 Each time a page or pages is removed from the wiki, the referenced function
201 is called, and passed the names of the source files that were removed.
203 ### change
205         hook(type => "change", id => "foo", call => \&render);
207 Each time ikiwiki renders a change or addition (but not deletion) to the
208 wiki, the referenced function is called, and passed the names of the
209 source files that were rendered.
211 ### cgi
213         hook(type => "cgi", id => "foo", call => \&cgi);
215 Use this to hook into ikiwiki's cgi script. Each registered cgi hook is
216 called in turn, and passed a CGI object. The hook should examine the
217 parameters, and if it will handle this CGI request, output a page (including the http headers) and
218 terminate the program.
220 ### auth
222         hook(type => "auth", id => "foo", call => \&auth);
224 This hook can be used to implement a different authentication method than
225 the standard web form. When a user needs to be authenticated, each registered
226 auth hook is called in turn, and passed a CGI object and a session object. 
228 If the hook is able to authenticate the user, it should set the session
229 object's "name" parameter to the authenticated user's name. Note that
230 if the name is set to the name of a user who is not registered,
231 a basic registration of the user will be automatically performed.
233 ### sessioncgi
235         hook(type => "sessioncgi", id => "foo", call => \&sessioncgi);
237 Unlike the cgi hook, which is run as soon as possible, the sessioncgi hook
238 is only run once a session object is available. It is passed both a CGI
239 object and a session object. To check if the user is in fact signed in, you
240 can check if the session object has a "name" parameter set.
242 ### canedit
244         hook(type => "canedit", id => "foo", call => \&pagelocked);
246 This hook can be used to implement arbitrary access methods to control when
247 a page can be edited using the web interface (commits from revision control
248 bypass it). When a page is edited, each registered canedit hook is called
249 in turn, and passed the page name, a CGI object, and a session object.
251 If the hook has no opinion about whether the edit can proceed, return
252 `undef`, and the next plugin will be asked to decide. If edit can proceed,
253 the hook should return "". If the edit is not allowed by this hook, the
254 hook should return an error message for the user to see, or a function 
255 that can be run to log the user in or perform other action necessary for
256 them to be able to edit the page.
258 This hook should avoid directly redirecting the user to a signin page,
259 since it's sometimes used to test to see which pages in a set of pages a
260 user can edit.
262 ### editcontent
264         hook(type => "editcontent", id => "foo", call => \&editcontent);
266 This hook is called when a page is saved (or previewed) using the web
267 interface. It is passed named parameters: `content`, `page`, `cgi`, and
268 `session`. These are, respectively, the new page content as entered by the
269 user, the page name, a `CGI` object, and the user's `CGI::Session`. 
271 It can modify the content as desired, and should return the content.
273 ### formbuilder
275         hook(type => "formbuilder_setup", id => "foo", call => \&formbuilder_setup);
276         hook(type => "formbuilder", id => "foo", call => \&formbuilder);
278 These hooks allow tapping into the parts of ikiwiki that use [[cpan
279 CGI::FormBuilder]] to generate web forms. These hooks are passed named
280 parameters: `cgi`, `session`, `form`, and `buttons`. These are, respectively,
281 the `CGI` object, the user's `CGI::Session`, a `CGI::FormBuilder`, and a
282 reference to an array of names of buttons to go on the form.
284 Each time a form is set up, the `formbuilder_setup` hook is called.
285 Typically the `formbuilder_setup` hook will check the form's title, and if
286 it's a form that it needs to modify, will call various methods to
287 add/remove/change fields, tweak the validation code for the fields, etc. It
288 will not validate or display the form.
290 Just before a form is displayed to the user, the `formbuilder` hook is
291 called. It can be used to validate the form, but should not display it.
293 ### savestate
295         hook(type => "savestate", id => "foo", call => \&savestate);
297 This hook is called wheneven ikiwiki normally saves its state, just before
298 the state is saved. The function can save other state, modify values before
299 they're saved, etc.
301 ## Plugin interface
303 To import the ikiwiki plugin interface:
305         use IkiWiki '1.00';
307 This will import several variables and functions into your plugin's
308 namespace. These variables and functions are the ones most plugins need,
309 and a special effort will be made to avoid changing them in incompatible
310 ways, and to document any changes that have to be made in the future.
312 Note that IkiWiki also provides other variables and functions that are not
313 exported by default. No guarantee is made about these in the future, so if
314 it's not exported, the wise choice is to not use it.
316 ### %config
318 A plugin can access the wiki's configuration via the `%config`
319 hash. The best way to understand the contents of the hash is to look at
320 [[ikiwiki.setup]], which sets the hash content to configure the wiki.
322 ### %pagestate
324 The `%pagestate` hash can be used by plugins to save state that they will need
325 next time ikiwiki is run. The hash holds per-page state, so to set a value,
326 use `%pagestate{$page}{$id}{$key}=$value`, and to retrieve the value,
327 use `%pagestate{$page}{$id}{$key}`.
329 `$key` can be any string you like, but `$id` must be the same as the "id"
330 parameter passed to `hook()` when registering the plugin. This is so
331 ikiwiki can know when to delete pagestate for plugins that are no longer
332 used.
334 When pages are deleted, ikiwiki automatically deletes their pagestate too.
336 Note that page state does not persist across wiki rebuilds, only across
337 wiki updates.
339 ### Other variables
341 If your plugin needs to access data about other pages in the wiki. It can
342 use the following hashes, using a page name as the key:
344 * `%links` lists the names of each page that a page links to, in an array
345   reference.
346 * `%destsources` contains the name of the source file used to create each
347   destination file.
348 * `%pagesources` contains the name of the source file for each page.
350 Also, the %IkiWiki::version variable contains the version number for the
351 ikiwiki program.
353 ### Library functions
355 #### `hook(@)`
357 Hook into ikiwiki's processing. See the discussion of hooks above.
359 Note that in addition to the named parameters described above, a parameter
360 named `no_override` is supported, If it's set to a true value, then this hook
361 will not override any existing hook with the same id. This is useful if
362 the id can be controled by the user.
364 #### `debug($)`
366 Logs a debugging message. These are supressed unless verbose mode is turned
367 on.
369 #### `error($;$)`
371 Aborts with an error message. If the second parameter is passed, it is a
372 function that is called after the error message is printed, to do any final
373 cleanup.
375 Note that while any plugin can use this for a fatal error, plugins should
376 try to avoid dying on bad input, as that will halt the entire wiki build
377 and make the wiki unusable. So for example, if a
378 [[ikiwiki/PreProcessorDirective]] is passed bad parameters, it's better to
379 return an error message, which can appear on the wiki page, rather than
380 calling error().
382 #### `template($;@)`
384 Creates and returns a [[cpan HTML::Template]] object. The first parameter
385 is the name of the file in the template directory. The optional remaining
386 parameters are passed to `HTML::Template->new`.
388 #### `htmlpage($)`
390 Passed a page name, returns the base name that will be used for a the html
391 page created from it. (Ie, it appends ".html".)
393 #### `add_depends($$)`
395 Makes the specified page depend on the specified [[ikiwiki/PageSpec]].
397 #### `pagespec_match($$;@)`
399 Passed a page name, and [[ikiwiki/PageSpec]], returns true if the
400 [[ikiwiki/PageSpec]] matches the page.
402 Additional named parameters can be passed, to further limit the match.
403 The most often used is "location", which specifies the location the
404 PageSpec should match against. If not passed, relative PageSpecs will match
405 relative to the top of the wiki.
407 #### `bestlink($$)`
409 Given a page and the text of a link on the page, determine which
410 existing page that link best points to. Prefers pages under a
411 subdirectory with the same name as the source page, failing that
412 goes down the directory tree to the base looking for matching
413 pages, as described in [[ikiwiki/SubPage/LinkingRules]].
415 #### `htmllink($$$;@)`
417 Many plugins need to generate html links and add them to a page. This is
418 done by using the `htmllink` function. The usual way to call
419 `htmlllink` is:
421         htmllink($page, $page, $link)
423 Why is `$page` repeated? Because if a page is inlined inside another, and a
424 link is placed on it, the right way to make that link is actually:
426         htmllink($page, $destpage, $link)
428 Here `$destpage` is the inlining page. A `destpage` parameter is passed to
429 some of the hook functions above; the ones that are not passed it are not used
430 during inlining and don't need to worry about this issue.
432 After the three required parameters, named parameters can be used to
433 control some options. These are:
435 * noimageinline - set to true to avoid turning links into inline html images
436 * forcesubpage  - set to force a link to a subpage
437 * linktext - set to force the link text to something
438 * anchor - set to make the link include an anchor
439 * rel - set to add a rel attribute to the link
440 * class - set to add a css class to the link
442 #### `readfile($;$)`
444 Given a filename, reads and returns the entire file.
446 The optional second parameter, if set to a true value, makes the file be read
447 in binary mode.
449 A failure to read the file will result in it dying with an error.
451 #### `writefile($$$;$$)`
453 Given a filename, a directory to put it in, and the file's content,
454 writes a file. 
456 The optional fourth parameter, if set to a true value, makes the file be
457 written in binary mode.
459 The optional fifth parameter can be used to pass a function reference that
460 will be called to handle writing to the file. The function will be called
461 and passed a file descriptor it should write to, and an error recovery
462 function it should call if the writing fails. (You will not normally need to
463 use this interface.)
465 A failure to write the file will result in it dying with an error.
467 If the destination directory doesn't exist, it will first be created.
469 #### `will_render($$)`
471 Given a page name and a destination file name (not including the base
472 destination directory), register that the page will result in that file
473 being rendered. It's important to call this before writing to any file in
474 the destination directory.
476 Ikiwiki uses this information to automatically clean up rendered files when
477 the page that rendered them goes away or is changes to no longer render
478 them. will_render also does a few important security checks.
480 #### `pagetype($)`
482 Given the name of a source file, returns the type of page it is, if it's
483 a type that ikiwiki knowns how to htmlize. Otherwise, returns undef.
485 #### `pagename($)`
487 Given the name of a source file, returns the name of the wiki page
488 that corresponds to that file.
490 #### `srcfile($)`
492 Given the name of a source file in the wiki, searches for the file in
493 the source directory and the underlay directories (most recently added
494 underlays first), and returns the full path to the first file found.
496 #### `add_underlay($)`
498 Adds a directory to the set of underlay directories that ikiwiki will
499 search for files.
501 If the directory name is not absolute, ikiwiki will assume it is in
502 the parent directory of the configured underlaydir.
504 #### `displaytime($;$)`
506 Given a time, formats it for display.
508 The optional second parameter is a strftime format to use to format the
509 time.
511 #### `gettext`
513 This is the standard gettext function, although slightly optimised.
515 #### `urlto($$)`
517 Construct a relative url to the first parameter from the page named by the
518 second. The first parameter can be either a page name, or some other
519 destination file, as registered by `will_render`.
521 #### `targetpage($$)`
523 Passed a page and an extension, returns the filename that page will be
524 rendered to.
526 ## RCS plugins
528 ikiwiki's support for [[revision_control_systems|rcs]] also uses pluggable
529 perl modules. These are in the `IkiWiki::RCS` namespace, for example
530 `IkiWiki::RCS::svn`. 
532 Each RCS plugin must support all the `IkiWiki::rcs_*` functions.
533 See IkiWiki::RCS::Stub for the full list of functions. It's ok if
534 `rcs_getctime` does nothing except for throwing an error.
536 See [[RCS_details|rcs/details]] for some more info.
538 ## PageSpec plugins
540 It's also possible to write plugins that add new functions to
541 [[PageSpecs|ikiwiki/PageSpec]]. Such a plugin should add a function to the
542 IkiWiki::PageSpec package, that is named `match_foo`, where "foo()" is
543 how it will be accessed in a [[ikiwiki/PageSpec]]. The function will be passed
544 two parameters: The name of the page being matched, and the thing to match
545 against. It may also be passed additional, named parameters. It should return
546 a IkiWiki::SuccessReason object if the match succeeds, or an
547 IkiWiki::FailReason object if the match fails.