96a2aa16d02c84697072f71f51ff63226e29be8b
[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 [[!template id="note" text="""
7 Ikiwiki is a compiler
8
9 One thing to keep in mind when writing a plugin is that ikiwiki is a wiki
10 *compiler*. So plugins influence pages when they are built, not when they
11 are loaded. A plugin that inserts the current time into a page, for
12 example, will insert the build time.
13
14 Also, as a compiler, ikiwiki avoids rebuilding pages unless they have
15 changed, so a plugin that prints some random or changing thing on a page
16 will generate a static page that won't change until ikiwiki rebuilds the
17 page for some other reason, like the page being edited.
18
19 The [[tutorial]] has some other examples of ways that ikiwiki being a
20 compiler may trip up the unwary.
21 """]]
22
23 [[!toc levels=2]]
24
25 ## Highlevel view of ikiwiki
26
27 Ikiwiki mostly has two modes of operation. It can either be running
28 as a compiler, building or updating a wiki; or as a cgi program, providing
29 user interface for editing pages, etc. Almost everything ikiwiki does
30 is accomplished by calling various hooks provided by plugins.
31
32 ### compiler
33
34 As a compiler, ikiwiki starts by calling the `refresh` hook. Then it checks
35 the wiki's source to find new or changed pages. The `needsbuild` hook is
36 then called to allow manipulation of the list of pages that need to be
37 built. 
38
39 Now that it knows what pages it needs to build, ikiwiki runs two
40 compile passes. First, it runs `scan` hooks, which collect metadata about
41 the pages. Then it runs a page rendering pipeline, by calling in turn these
42 hooks: `filter`, `preprocess`, `linkify`, `htmlize`, `postscan`,
43 `pagetemplate`, `sanitize`, `format`.
44
45 After all necessary pages are built, it calls the `change` hook. Finally,
46 if a page is was deleted, the `delete` hook is called, and the files that
47 page had previously produced are removed.
48
49 ### cgi
50
51 The flow between hooks when ikiwiki is run as a cgi is best illustrated by
52 an example.
53
54 Alice browses to a page and clicks Edit.
55
56 * Ikiwiki is run as a cgi. It assigns Alice a session cookie, and,
57   by calling the `auth` hooks, sees that she is not yet logged in.
58 * The `sessioncgi` hooks are then called, and one of them,
59   from the [[editpage]] plugin, notices that the cgi has been told "do=edit".
60 * The [[editpage]] plugin calls the `canedit` hook to check if this
61   page edit is allowed. The [[signinedit]] plugin has a hook that says not:
62   Alice is not signed in.
63 * The [[signinedit]] plugin then launches the signin process. A signin
64   page is built by calling the `formbuilder_setup` hook.
65
66 Alice signs in with her openid.
67
68 * The [[openid]] plugin's `formbuilder` hook sees that an openid was
69   entered in the signin form, and redirects to Alice's openid provider.
70 * Alice's openid provider calls back to ikiwiki. The [[openid]] plugin
71   has an `auth` hook that finishes the openid signin process.
72 * Signin complete, ikiwiki returns to what Alice was doing before; editing
73   a page.
74 * Now all the `canedit` hooks are happy. The [[editpage]] plugin calls
75   `formbuilder_setup` to display the page editing form.
76
77 Alice saves her change to the page.
78
79 * The [[editpage]] plugin's `formbuilder` hook sees that the Save button
80   was pressed, and calls the `checkcontent` and `editcontent` hooks.
81   Then it saves the page to disk, and branches into the compiler part
82   of ikiwiki to refresh the wiki.
83
84 ## Types of plugins
85
86 Most ikiwiki [[plugins]] are written in perl, like ikiwiki. This gives the
87 plugin full access to ikiwiki's internals, and is the most efficient.
88 However, plugins can actually be written in any language that supports XML
89 RPC. These are called [[external]] plugins.
90
91 A plugin written in perl is a perl module, in the `IkiWiki::Plugin`
92 namespace. The name of the plugin is typically in lowercase, such as
93 `IkiWiki::Plugin::inline`. Ikiwiki includes a `IkiWiki::Plugin::skeleton`
94 that can be fleshed out to make a useful plugin.
95 `IkiWiki::Plugin::pagecount` is another simple example. All perl plugins
96 should `use IkiWiki` to import the ikiwiki plugin interface. It's a good
97 idea to include the version number of the plugin interface that your plugin
98 expects: `use IkiWiki 3.00`.
99
100 An external plugin is an executable program. It can be written in any
101 language. Its interface to ikiwiki is via XML RPC, which it reads from
102 ikiwiki on its standard input, and writes to ikiwiki on its standard
103 output. For more details on writing external plugins, see [[external]].
104
105 Despite these two types of plugins having such different interfaces,
106 they're the same as far as how they hook into ikiwiki. This document will
107 explain how to write both sorts of plugins, albeit with an emphasis on perl
108 plugins.
109
110 ## Plugin interface
111
112 To import the ikiwiki plugin interface:
113
114         use IkiWiki '3.00';
115
116 This will import several variables and functions into your plugin's
117 namespace. These variables and functions are the ones most plugins need,
118 and a special effort will be made to avoid changing them in incompatible
119 ways, and to document any changes that have to be made in the future.
120
121 Note that IkiWiki also provides other variables and functions that are not
122 exported by default. No guarantee is made about these in the future, so if
123 it's not exported, the wise choice is to not use it.
124
125 ## Registering plugins
126
127 Plugins should, when imported, call `hook()` to hook into ikiwiki's
128 processing. The function uses named parameters, and use varies depending on
129 the type of hook being registered -- see below. A plugin can call
130 the function more than once to register multiple hooks.
131
132 All calls to `hook()` should be passed a "type" parameter, which gives the
133 type of hook, a "id" parameter, which should be a unique string for this
134 plugin, and a "call" parameter, which tells what function to call for the
135 hook.
136
137 An optional "last" parameter, if set to a true value, makes the hook run
138 after all other hooks of its type, and an optional "first" parameter makes
139 it run first. Useful if the hook depends on some other hook being run first.
140
141 ## Types of hooks
142
143 In roughly the order they are called.
144
145 ### getopt
146
147         hook(type => "getopt", id => "foo", call => \&getopt);
148
149 This allows for plugins to perform their own processing of command-line
150 options and so add options to the ikiwiki command line. It's called during
151 command line processing, with `@ARGV` full of any options that ikiwiki was
152 not able to process on its own. The function should process any options it
153 can, removing them from `@ARGV`, and probably recording the configuration
154 settings in `%config`. It should take care not to abort if it sees
155 an option it cannot process, and should just skip over those options and
156 leave them in `@ARGV`.
157
158 ### checkconfig
159
160         hook(type => "checkconfig", id => "foo", call => \&checkconfig);
161
162 This is useful if the plugin needs to check for or modify ikiwiki's
163 configuration. It's called early in the startup process. `%config`
164 is populated at this point, but other state has not yet been loaded.
165 The function is passed no values. It's ok for the function to call
166 `error()` if something isn't configured right.
167
168 ### refresh
169
170         hook(type => "refresh", id => "foo", call => \&refresh);
171
172 This hook is called just before ikiwiki scans the wiki for changed files.
173 It's useful for plugins that need to create or modify a source page. The
174 function is passed no values.
175
176 ### needsbuild
177
178         hook(type => "needsbuild", id => "foo", call => \&needsbuild);
179
180 This allows a plugin to manipulate the list of files that need to be
181 built when the wiki is refreshed. The function is passed a reference to an
182 array of files that will be rebuilt, and can modify the array, either
183 adding or removing files from it.
184
185 ### scan
186
187         hook(type => "scan", id => "foo", call => \&scan);
188
189 This hook is called early in the process of building the wiki, and is used
190 as a first pass scan of the page, to collect metadata about the page. It's
191 mostly used to scan the page for [[WikiLinks|ikiwiki/WikiLink]], and add
192 them to `%links`. Present in IkiWiki 2.40 and later.
193
194 The function is passed named parameters "page" and "content". Its return
195 value is ignored.
196
197 ### filter
198
199         hook(type => "filter", id => "foo", call => \&filter);
200
201 Runs on the raw source of a page, before anything else touches it, and can
202 make arbitrary changes. The function is passed named parameters "page",
203 "destpage", and "content". It should return the filtered content.
204
205 ### preprocess
206
207 Adding a preprocessor [[ikiwiki/directive]] is probably the most common use
208 of a plugin.
209
210         hook(type => "preprocess", id => "foo", call => \&preprocess);
211
212 Replace "foo" with the command name that will be used for the preprocessor
213 directive.
214
215 Each time the directive is processed, the referenced function (`preprocess`
216 in the example above) is called. Whatever the function returns goes onto
217 the page in place of the directive. Or, if the function aborts using
218 `error()`, the directive will be replaced with the error message.
219
220 The function is passed named parameters. First come the parameters set
221 in the preprocessor directive. These are passed in the same order as
222 they're in the directive, and if the preprocessor directive contains a bare
223 parameter (example: `\[[!foo param]]`), that parameter will be passed with
224 an empty value.
225
226 After the parameters from the preprocessor directive some additional ones
227 are passed: A "page" parameter gives the name of the page that embedded the
228 preprocessor directive, while a "destpage" parameter gives the name of the
229 page the content is going to (different for inlined pages), and a "preview"
230 parameter is set to a true value if the page is being previewed.
231
232 If `hook` is passed an optional "scan" parameter, set to a true value, this
233 makes the hook be called during the preliminary scan that ikiwiki makes of
234 updated pages, before begining to render pages. This should be done if the
235 hook modifies data in `%links` (typically by calling `add_link`). Note that
236 doing so will make the hook be run twice per page build, so avoid doing it
237 for expensive hooks. (As an optimisation, if your preprocessor hook is
238 called in a void context, you can assume it's being run in scan mode, and
239 avoid doing expensive things at that point.)
240
241 Note that if the [[htmlscrubber]] is enabled, html in
242 preprocessor [[ikiwiki/directive]] output is sanitised, which may limit what
243 your plugin can do. Also, the rest of the page content is not in html
244 format at preprocessor time. Text output by a preprocessor directive will
245 be linkified and passed through markdown (or whatever engine is used to
246 htmlize the page) along with the rest of the page.
247
248 ### linkify
249
250         hook(type => "linkify", id => "foo", call => \&linkify);
251
252 This hook is called to convert [[WikiLinks|ikiwiki/WikiLink]] on the page into html
253 links. The function is passed named parameters "page", "destpage", and
254 "content". It should return the linkified content.  Present in IkiWiki 2.40
255 and later.
256
257 Plugins that implement linkify must also implement a scan hook, that scans
258 for the links on the page and adds them to `%links` (typically by calling
259 `add_link`).
260
261 ### htmlize
262
263         hook(type => "htmlize", id => "ext", call => \&htmlize);
264
265 Runs on the source of a page and turns it into html. The id parameter
266 specifies the filename extension that a file must have to be htmlized using
267 this plugin. This is how you can add support for new and exciting markup
268 languages to ikiwiki.
269
270 The function is passed named parameters: "page" and "content" and should
271 return the htmlized content.
272
273 If `hook` is passed an optional "keepextension" parameter, set to a true
274 value, then the extension will not be stripped from the source filename when
275 generating the page.
276
277 If `hook` is passed an optional "noextension" parameter, set to a true
278 value, then the id parameter specifies not a filename extension, but
279 a whole filename that can be htmlized. This is useful for files
280 like `Makefile` that have no extension.
281
282 If `hook` is passed an optional "longname" parameter, this value is used
283 when prompting a user to choose a page type on the edit page form.
284
285 ### postscan
286
287         hook(type => "postscan", id => "foo", call => \&postscan);
288
289 This hook is called once the page has been converted to html (but before
290 the generated html is put in a template). The most common use is to
291 update search indexes. Added in ikiwiki 2.54.
292
293 The function is passed named parameters "page" and "content". Its return
294 value is ignored.
295
296 ### pagetemplate
297
298         hook(type => "pagetemplate", id => "foo", call => \&pagetemplate);
299
300 [[Templates|wikitemplates]] are filled out for many different things in
301 ikiwiki, like generating a page, or part of a blog page, or an rss feed, or
302 a cgi. This hook allows modifying the variables available on those
303 templates. The function is passed named parameters. The "page" and
304 "destpage" parameters are the same as for a preprocess hook. The "template"
305 parameter is a [[!cpan HTML::Template]] object that is the template that
306 will be used to generate the page. The function can manipulate that
307 template object.
308
309 The most common thing to do is probably to call `$template->param()` to add
310 a new custom parameter to the template.
311
312 ### templatefile
313
314         hook(type => "templatefile", id => "foo", call => \&templatefile);
315
316 This hook allows plugins to change the [[template|wikitemplates]] that is
317 used for a page in the wiki. The hook is passed a "page" parameter, and
318 should return the name of the template file to use, or undef if it doesn't
319 want to change the default ("page.tmpl"). Template files are looked for in
320 /usr/share/ikiwiki/templates by default.
321
322 ### sanitize
323
324         hook(type => "sanitize", id => "foo", call => \&sanitize);
325
326 Use this to implement html sanitization or anything else that needs to
327 modify the body of a page after it has been fully converted to html.
328
329 The function is passed named parameters: "page", "destpage", and "content",
330 and should return the sanitized content.
331
332 ### format
333
334         hook(type => "format", id => "foo", call => \&format);
335
336 The difference between format and sanitize is that sanitize only acts on
337 the page body, while format can modify the entire html page including the
338 header and footer inserted by ikiwiki, the html document type, etc. (It
339 should not rely on always being passed the entire page, as it won't be
340 when the page is being previewed.)
341
342 The function is passed named parameters: "page" and "content", and 
343 should return the formatted content.
344
345 ### delete
346
347         hook(type => "delete", id => "foo", call => \&delete);
348
349 Each time a page or pages is removed from the wiki, the referenced function
350 is called, and passed the names of the source files that were removed.
351
352 ### change
353
354         hook(type => "change", id => "foo", call => \&render);
355
356 Each time ikiwiki renders a change or addition (but not deletion) to the
357 wiki, the referenced function is called, and passed the names of the
358 source files that were rendered.
359
360 ### cgi
361
362         hook(type => "cgi", id => "foo", call => \&cgi);
363
364 Use this to hook into ikiwiki's cgi script. Each registered cgi hook is
365 called in turn, and passed a CGI object. The hook should examine the
366 parameters, and if it will handle this CGI request, output a page
367 (including the http headers) and terminate the program.
368
369 Note that cgi hooks are called as early as possible, before any ikiwiki
370 state is loaded, and with no session information.
371
372 ### auth
373
374         hook(type => "auth", id => "foo", call => \&auth);
375
376 This hook can be used to implement an authentication method. When a user
377 needs to be authenticated, each registered auth hook is called in turn, and
378 passed a CGI object and a session object. 
379
380 If the hook is able to authenticate the user, it should set the session
381 object's "name" parameter to the authenticated user's name. Note that
382 if the name is set to the name of a user who is not registered,
383 a basic registration of the user will be automatically performed.
384
385 ### sessioncgi
386
387         hook(type => "sessioncgi", id => "foo", call => \&sessioncgi);
388
389 Unlike the cgi hook, which is run as soon as possible, the sessioncgi hook
390 is only run once a session object is available. It is passed both a CGI
391 object and a session object. To check if the user is in fact signed in, you
392 can check if the session object has a "name" parameter set.
393
394 ### canedit
395
396         hook(type => "canedit", id => "foo", call => \&canedit);
397
398 This hook can be used to implement arbitrary access methods to control when
399 a page can be edited using the web interface (commits from revision control
400 bypass it). When a page is edited, each registered canedit hook is called
401 in turn, and passed the page name, a CGI object, and a session object.
402
403 If the hook has no opinion about whether the edit can proceed, return
404 `undef`, and the next plugin will be asked to decide. If edit can proceed,
405 the hook should return "". If the edit is not allowed by this hook, the
406 hook should return an error message for the user to see, or a function 
407 that can be run to log the user in or perform other action necessary for
408 them to be able to edit the page.
409
410 This hook should avoid directly redirecting the user to a signin page,
411 since it's sometimes used to test to see which pages in a set of pages a
412 user can edit.
413
414 ### canremove
415
416         hook(type => "canremove", id => "foo", call => \&canremove);
417
418 This hook can be used to implement arbitrary access methods to control
419 when a page can be removed using the web interface (commits from
420 revision control bypass it). It works exactly like the `canedit` hook,
421 but is passed the named parameters `cgi` (a CGI object), `session`
422 (a session object) and `page` (the page subject to deletion).
423
424 ### canrename
425
426         hook(type => "canrename", id => "foo", call => \&canrename);
427
428 This hook can be used to implement arbitrary access methods to control when
429 a page can be renamed using the web interface (commits from revision control
430 bypass it). It works exactly like the `canedit` hook,
431 but is passed the named parameters `cgi` (a CGI object), `session` (a
432 session object), `src`, `srcfile`, `dest` and `destfile`.
433
434 ### checkcontent
435         
436         hook(type => "checkcontent", id => "foo", call => \&checkcontent);
437
438 This hook is called to check the content a user has entered on a page,
439 before it is saved, and decide if it should be allowed.
440
441 It is passed named parameters: `content`, `page`, `cgi`, and `session`. If
442 the content the user has entered is a comment, it may also be passed some
443 additional parameters: `author`, `url`, and `subject`. The `subject`
444 parameter may also be filled with the user's comment about the change.
445
446 Note: When the user edits an existing wiki page, this hook is also
447 passed a `diff` named parameter, which will include only the lines
448 that they added to the page, or modified.
449
450 The hook should return `undef` on success. If the content is disallowed, it
451 should return a message stating what the problem is, or a function
452 that can be run to perform whatever action is necessary to allow the user
453 to post the content.
454
455 ### editcontent
456
457         hook(type => "editcontent", id => "foo", call => \&editcontent);
458
459 This hook is called when a page is saved (or previewed) using the web
460 interface. It is passed named parameters: `content`, `page`, `cgi`, and
461 `session`. These are, respectively, the new page content as entered by the
462 user, the page name, a `CGI` object, and the user's `CGI::Session`. 
463
464 It can modify the content as desired, and should return the content.
465
466 ### formbuilder
467
468         hook(type => "formbuilder_setup", id => "foo", call => \&formbuilder_setup);
469         hook(type => "formbuilder", id => "foo", call => \&formbuilder);
470
471 These hooks allow tapping into the parts of ikiwiki that use [[!cpan
472 CGI::FormBuilder]] to generate web forms. These hooks are passed named
473 parameters: `cgi`, `session`, `form`, and `buttons`. These are, respectively,
474 the `CGI` object, the user's `CGI::Session`, a `CGI::FormBuilder`, and a
475 reference to an array of names of buttons to go on the form.
476
477 Each time a form is set up, the `formbuilder_setup` hook is called.
478 Typically the `formbuilder_setup` hook will check the form's title, and if
479 it's a form that it needs to modify, will call various methods to
480 add/remove/change fields, tweak the validation code for the fields, etc. It
481 will not validate or display the form.
482
483 Just before a form is displayed to the user, the `formbuilder` hook is
484 called. It can be used to validate the form, but should not display it.
485
486 ### savestate
487
488         hook(type => "savestate", id => "foo", call => \&savestate);
489
490 This hook is called whenever ikiwiki normally saves its state, just before
491 the state is saved. The function can save other state, modify values before
492 they're saved, etc.
493
494 ### renamepage
495
496         hook(type => "renamepage", id => "foo", call => \&renamepage);
497
498 This hook is called by the [[plugins/rename]] plugin when it renames
499 something, once per page linking to the renamed page's old location.
500 The hook is passed named parameters: `page`, `oldpage`, `newpage`, and
501 `content`, and should try to modify the content of `page` to reflect
502 the name change. For example, by converting links to point to the
503 new page.
504
505 ### rename
506
507         hook(type => "rename", id => "foo", call => \&rename);
508
509 When a page or set of pages is renamed, the referenced function is
510 called for every page, and is passed named parameters:
511
512 * `torename`: a reference to a hash with keys: `src`, `srcfile`,
513   `dest`, `destfile`, `required`.
514 * `cgi`: a CGI object
515 * `session`: a session object.
516
517 Such a hook function returns any additional rename hashes it wants to
518 add. This hook is applied recursively to returned additional rename
519 hashes, so that it handles the case where two plugins use the hook:
520 plugin A would see when plugin B adds a new file to be renamed.
521
522 ### getsetup
523
524         hook(type => "getsetup", id => "foo", call => \&getsetup);
525
526 This hooks is not called during normal operation, but only when setting up 
527 the wiki, or generating a setup file. Plugins can use this hook to add
528 configuration options.
529
530 The hook is passed no parameters. It returns data about the configuration
531 options added by the plugin. It can also check if the plugin is usable, and
532 die if not, which will cause the plugin to not be offered in the configuration
533 interface.
534
535 The data returned is a list of `%config` options, followed by a hash
536 describing the option. There can also be an item named "plugin", which
537 describes the plugin as a whole. For example:
538
539                 return
540                         plugin => {
541                                 description => "description of this plugin",
542                                 safe => 1,
543                                 rebuild => 1,
544                                 section => "misc",
545                         },
546                         option_foo => {
547                                 type => "boolean",
548                                 description => "enable foo?",
549                                 advanced => 1,
550                                 safe => 1,
551                                 rebuild => 1,
552                         },
553                         option_bar => {
554                                 type => "string",
555                                 example => "hello",
556                                 description => "option bar",
557                                 safe => 1,
558                                 rebuild => 0,
559                         },
560
561 * `type` can be "boolean", "string", "integer", "pagespec",
562   or "internal" (used for values that are not user-visible). The type is
563   the type of the leaf values;  the `%config` option may be an array or
564   hash of these.
565 * `example` can be set to an example value.
566 * `description` is a short description of the option.
567 * `link` is a link to further information about the option. This can either
568   be a [[ikiwiki/WikiLink]], or an url.
569 * `advanced` can be set to true if the option is more suitable for advanced
570   users.
571 * `safe` should be false if the option should not be displayed in unsafe
572   configuration methods, such as the web interface. Anything that specifies
573   a command to run, a path on disk, or a regexp should be marked as unsafe.
574   If a plugin is marked as unsafe, that prevents it from being
575   enabled/disabled.
576 * `rebuild` should be true if changing the option (or enabling/disabling
577   the plugin) will require a wiki rebuild, false if no rebuild is needed,
578   and undef if a rebuild could be needed in some circumstances, but is not
579   strictly required.
580 * `section` can optionally specify which section in the config file
581   the plugin fits in. The convention is to name the sections the
582   same as the tags used for [[plugins|plugin]] on this wiki.
583
584 ### genwrapper
585
586         hook(type => "genwrapper", id => "foo", call => \&genwrapper);
587
588 This hook is used to inject C code (which it returns) into the `main`
589 function of the ikiwiki wrapper when it is being generated.
590
591 ## Exported variables
592
593 Several variables are exported to your plugin when you `use IkiWiki;`
594
595 ### `%config`
596
597 A plugin can access the wiki's configuration via the `%config`
598 hash. The best way to understand the contents of the hash is to look at
599 your ikiwiki setup file, which sets the hash content to configure the wiki.
600
601 ### `%pagestate`
602
603 The `%pagestate` hash can be used by plugins to save state that they will need
604 next time ikiwiki is run. The hash holds per-page state, so to set a value,
605 use `$pagestate{$page}{$id}{$key}=$value`, and to retrieve the value,
606 use `$pagestate{$page}{$id}{$key}`.
607
608 The `$value` can be anything that perl's Storable module is capable of
609 serializing. `$key` can be any string you like, but `$id` must be the same
610 as the "id" parameter passed to `hook()` when registering the plugin. This
611 is so ikiwiki can know when to delete pagestate for plugins that are no
612 longer used.
613
614 When pages are deleted, ikiwiki automatically deletes their pagestate too.
615
616 Note that page state does not persist across wiki rebuilds, only across
617 wiki updates.
618
619 ### `%wikistate`
620
621 The `%wikistate` hash can be used by a plugin to store persistant state
622 that is not bound to any one page. To set a value, use
623 `$wikistate{$id}{$key}=$value, where `$value` is anything Storable can
624 serialize, `$key` is any string you like, and `$id` must be the same as the
625 "id" parameter passed to `hook()` when registering the plugin, so that the
626 state can be dropped if the plugin is no longer used.
627
628 ### `%links`
629
630 The `%links` hash can be used to look up the names of each page that
631 a page links to. The name of the page is the key; the value is an array
632 reference. Do not modify this hash directly; call `add_link()`.
633
634         $links{"foo"} = ["bar", "baz"];
635
636 ### `%pagesources`
637
638 The `%pagesources` has can be used to look up the source filename
639 of a page. So the key is the page name, and the value is the source
640 filename. Do not modify this hash.
641
642         $pagesources{"foo"} = "foo.mdwn";
643
644 ### `%destsources`
645
646 The `%destsources` hash records the name of the source file used to
647 create each destination file. The key is the output filename (ie,
648 "foo/index.html"), and the value is the source filename that it was built
649 from (eg, "foo.mdwn"). Note that a single source file may create multiple
650 destination files. Do not modify this hash directly; call `will_render()`.
651         
652         $destsources{"foo/index.html"} = "foo.mdwn";
653
654 ## Library functions
655
656 Several functions are exported to your plugin when you `use IkiWiki;`
657
658 ### `hook(@)`
659
660 Hook into ikiwiki's processing. See the discussion of hooks above.
661
662 Note that in addition to the named parameters described above, a parameter
663 named `no_override` is supported, If it's set to a true value, then this hook
664 will not override any existing hook with the same id. This is useful if
665 the id can be controled by the user.
666
667 ### `debug($)`
668
669 Logs a debugging message. These are supressed unless verbose mode is turned
670 on.
671
672 ### `error($;$)`
673
674 Aborts with an error message. If the second parameter is passed, it is a
675 function that is called after the error message is printed, to do any final
676 cleanup.
677
678 If called inside a preprocess hook, error() does not abort the entire
679 wiki build, but instead replaces the preprocessor [[ikiwiki/directive]] with
680 a version containing the error message.
681
682 In other hooks, error() is a fatal error, so use with care. Try to avoid
683 dying on bad input when building a page, as that will halt
684 the entire wiki build and make the wiki unusable.
685
686 ### `template($;@)`
687
688 Creates and returns a [[!cpan HTML::Template]] object. The first parameter
689 is the name of the file in the template directory. The optional remaining
690 parameters are passed to `HTML::Template->new`.
691
692 ### `htmlpage($)`
693
694 Passed a page name, returns the base name that will be used for a the html
695 page created from it. (Ie, it appends ".html".)
696
697 Use this when constructing the filename of a html file. Use `urlto` when
698 generating a link to a page.
699
700 ### `pagespec_match_list($$;@)`
701
702 Passed a page name, and [[ikiwiki/PageSpec]], returns a list of pages
703 in the wiki that match the [[ikiwiki/PageSpec]]. 
704
705 The page will automatically be made to depend on the specified
706 [[ikiwiki/PageSpec]], so `add_depends` does not need to be called. This
707 is often significantly more efficient than calling `add_depends` and
708 `pagespec_match` in a loop. You should use this anytime a plugin
709 needs to match a set of pages and do something based on that list.
710
711 Unlike pagespec_match, this may throw an error if there is an error in
712 the pagespec.
713
714 Additional named parameters can be specified:
715
716 * `deptype` optionally specifies the type of dependency to add. Use the
717   `deptype` function to generate a dependency type.
718 * `filter` is a reference to a function, that is called and passed a page,
719   and returns true if the page should be filtered out of the list.
720 * `sort` specifies a sort order for the list. See
721   [[ikiwiki/PageSpec/sorting]] for the avilable sort methods.
722 * `reverse` if true, sorts in reverse.
723 * `num` if nonzero, specifies the maximum number of matching pages that
724   will be returned.
725 * `list` makes it only match amoung the specified list of pages.
726   Default is to match amoung all pages in the wiki.
727
728 Any other named parameters are passed on to `pagespec_match`, to further
729 limit the match.
730
731 ### `add_depends($$;$)`
732
733 Makes the specified page depend on the specified [[ikiwiki/PageSpec]].
734
735 By default, dependencies are full content dependencies, meaning that the
736 page will be updated whenever anything matching the PageSpec is modified.
737 This can be overridden by passing a `deptype` value as the third parameter.
738
739 ### `pagespec_match($$;@)`
740
741 Passed a page name, and [[ikiwiki/PageSpec]], returns a true value if the
742 [[ikiwiki/PageSpec]] matches the page.
743
744 Note that the return value is overloaded. If stringified, it will be a
745 message indicating why the PageSpec succeeded, or failed, to match the
746 page.
747
748 Additional named parameters can be passed, to further limit the match.
749 The most often used is "location", which specifies the location the
750 PageSpec should match against. If not passed, relative PageSpecs will match
751 relative to the top of the wiki.
752
753 ### `deptype(@)`
754
755 Use this function to generate ikiwiki's internal representation of a
756 dependency type from one or more of these keywords:
757
758 * `content` is the default. Any change to the content
759   of a page triggers the dependency.
760 * `presence` is only triggered by a change to the presence
761   of a page.
762 * `links` is only triggered by a change to the links of a page.
763   This includes when a link is added, removed, or changes what
764   it points to due to other changes. It does not include the
765   addition or removal of a duplicate link.
766
767 If multiple types are specified, they are combined.
768
769 ### `bestlink($$)`
770
771 Given a page and the text of a link on the page, determine which
772 existing page that link best points to. Prefers pages under a
773 subdirectory with the same name as the source page, failing that
774 goes down the directory tree to the base looking for matching
775 pages, as described in [[ikiwiki/SubPage/LinkingRules]].
776
777 ### `htmllink($$$;@)`
778
779 Many plugins need to generate html links and add them to a page. This is
780 done by using the `htmllink` function. The usual way to call
781 `htmllink` is:
782
783         htmllink($page, $page, $link)
784
785 Why is `$page` repeated? Because if a page is inlined inside another, and a
786 link is placed on it, the right way to make that link is actually:
787
788         htmllink($page, $destpage, $link)
789
790 Here `$destpage` is the inlining page. A `destpage` parameter is passed to
791 some of the hook functions above; the ones that are not passed it are not used
792 during inlining and don't need to worry about this issue.
793
794 After the three required parameters, named parameters can be used to
795 control some options. These are:
796
797 * noimageinline - set to true to avoid turning links into inline html images
798 * forcesubpage  - set to force a link to a subpage
799 * linktext - set to force the link text to something
800 * anchor - set to make the link include an anchor
801 * rel - set to add a rel attribute to the link
802 * class - set to add a css class to the link
803 * title - set to add a title attribute to the link
804
805 ### `readfile($;$)`
806
807 Given a filename, reads and returns the entire file.
808
809 The optional second parameter, if set to a true value, makes the file be read
810 in binary mode.
811
812 A failure to read the file will result in it dying with an error.
813
814 ### `writefile($$$;$$)`
815
816 Given a filename, a directory to put it in, and the file's content,
817 writes a file. 
818
819 The optional fourth parameter, if set to a true value, makes the file be
820 written in binary mode.
821
822 The optional fifth parameter can be used to pass a function reference that
823 will be called to handle writing to the file. The function will be called
824 and passed a file descriptor it should write to, and an error recovery
825 function it should call if the writing fails. (You will not normally need to
826 use this interface.)
827
828 A failure to write the file will result in it dying with an error.
829
830 If the destination directory doesn't exist, it will first be created.
831
832 The filename and directory are separate parameters because of
833 some security checks done to avoid symlink attacks. Before writing a file,
834 it checks to make sure there's not a symlink with its name, to avoid
835 following the symlink. If the filename parameter includes a subdirectory
836 to put the file in, it also checks if that subdirectory is a symlink, etc.
837 The directory parameter, however, is not checked for symlinks. So,
838 generally the directory parameter is a trusted toplevel directory like
839 the srcdir or destdir, and any subdirectories of this are included in the
840 filename parameter.
841
842 ### `will_render($$)`
843
844 Given a page name and a destination file name (not including the base
845 destination directory), register that the page will result in that file
846 being rendered. 
847
848 It's important to call this before writing to any file in the destination
849 directory, and it's important to call it consistently every time, even if
850 the file isn't really written this time -- unless you delete any old
851 version of the file. In particular, in preview mode, this should still be
852 called even if the file isn't going to be written to during the preview.
853
854 Ikiwiki uses this information to automatically clean up rendered files when
855 the page that rendered them goes away or is changed to no longer render
856 them. will_render also does a few important security checks.
857
858 ### `pagetype($)`
859
860 Given the name of a source file, returns the type of page it is, if it's
861 a type that ikiwiki knowns how to htmlize. Otherwise, returns undef.
862
863 ### `pagename($)`
864
865 Given the name of a source file, returns the name of the wiki page
866 that corresponds to that file.
867
868 ### `pagetitle($)`
869
870 Give the name of a wiki page, returns a version suitable to be displayed as
871 the page's title. This is accomplished by de-escaping escaped characters in
872 the page name. "_" is replaced with a space, and '__NN__' is replaced by 
873 the UTF character with code NN.
874
875 ### `titlepage($)`
876
877 This performs the inverse of `pagetitle`, ie, it converts a page title into
878 a wiki page name.
879
880 ### `linkpage($)`
881
882 This converts text that could have been entered by the user as a
883 [[ikiwiki/WikiLink]] into a wiki page name.
884
885 ### `srcfile($;$)`
886
887 Given the name of a source file in the wiki, searches for the file in
888 the source directory and the underlay directories (most recently added
889 underlays first), and returns the full path to the first file found.
890
891 Normally srcfile will fail with an error message if the source file cannot
892 be found. The second parameter can be set to a true value to make it return
893 undef instead.
894
895 ### `add_underlay($)`
896
897 Adds a directory to the set of underlay directories that ikiwiki will
898 search for files.
899
900 If the directory name is not absolute, ikiwiki will assume it is in
901 the parent directory of the configured underlaydir.
902
903 ### `displaytime($;$)`
904
905 Given a time, formats it for display.
906
907 The optional second parameter is a strftime format to use to format the
908 time.
909
910 ### `gettext`
911
912 This is the standard gettext function, although slightly optimised.
913
914 ### `ngettext`
915
916 This is the standard ngettext function, although slightly optimised.
917
918 ### `urlto($$;$)`
919
920 Construct a relative url to the first parameter from the page named by the
921 second. The first parameter can be either a page name, or some other
922 destination file, as registered by `will_render`.
923
924 If the third parameter is passed and is true, an absolute url will be
925 constructed instead of the default relative url.
926
927 ### `newpagefile($$)`
928
929 This can be called when creating a new page, to determine what filename
930 to save the page to. It's passed a page name, and its type, and returns
931 the name of the file to create, relative to the srcdir.
932
933 ### `targetpage($$;$)`
934
935 Passed a page and an extension, returns the filename that page will be
936 rendered to.
937
938 Optionally, a third parameter can be passed, to specify the preferred
939 filename of the page. For example, `targetpage("foo", "rss", "feed")`
940 will yield something like `foo/feed.rss`.
941
942 ### `add_link($$)`
943
944 This adds a link to `%links`, ensuring that duplicate links are not
945 added. Pass it the page that contains the link, and the link text.
946
947 ## Miscellaneous
948
949 ### Internal use pages
950
951 Sometimes it's useful to put pages in the wiki without the overhead of
952 having them be rendered to individual html files. Such internal use pages
953 are collected together to form the RecentChanges page, for example.
954
955 To make an internal use page, register a filename extension that starts
956 with "_". Internal use pages cannot be edited with the web interface,
957 generally shouldn't contain [[WikiLinks|ikiwiki/WikiLink]] or preprocessor directives (use
958 either on them with extreme caution), and are not matched by regular
959 PageSpecs glob patterns, but instead only by a special `internal()`
960 [[ikiwiki/PageSpec]].
961
962 ### RCS plugins
963
964 ikiwiki's support for [[revision_control_systems|rcs]] is also done via
965 plugins. See [[RCS_details|rcs/details]] for some more info.
966
967 RCS plugins must register a number of hooks. Each hook has type 'rcs', 
968 and the 'id' field is set to the name of the hook. For example:
969         
970         hook(type => "rcs", id => "rcs_update", call => \&rcs_update);
971         hook(type => "rcs", id => "rcs_prepedit", call => \&rcs_prepedit);
972
973 #### `rcs_update()`
974
975 Updates the working directory with any remote changes.
976
977 #### `rcs_prepedit($)`
978
979 Is passed a file to prepare to edit. It can generate and return an arbitrary
980 token, that will be passed into `rcs_commit` when committing. For example,
981 it might return the current revision ID of the file, and use that
982 information later when merging changes.
983
984 #### `rcs_commit($$$;$$)`
985
986 Passed a file, message, token (from `rcs_prepedit`), user, and ip address.
987 Should try to commit the file. Returns `undef` on *success* and a version
988 of the page with the rcs's conflict markers on failure.
989
990 #### `rcs_commit_staged($$$)`
991
992 Passed a message, user, and ip address. Should commit all staged changes.
993 Returns undef on success, and an error message on failure.
994
995 Changes can be staged by calls to `rcs_add`, `rcs_remove`, and
996 `rcs_rename`.
997
998 #### `rcs_add($)`
999
1000 Adds the passed file to the archive. The filename is relative to the root
1001 of the srcdir.
1002
1003 Note that this should not commit the new file, it should only
1004 prepare for it to be committed when rcs_commit (or `rcs_commit_staged`) is
1005 called. Note that the file may be in a new subdir that is not yet in
1006 to version control; the subdir can be added if so.
1007
1008 #### `rcs_remove($)`
1009
1010 Remove a file. The filename is relative to the root of the srcdir.
1011
1012 Note that this should not commit the removal, it should only prepare for it
1013 to be committed when `rcs_commit` (or `rcs_commit_staged`) is called. Note
1014 that the new file may be in a new subdir that is not yet in version
1015 control; the subdir can be added if so.
1016
1017 #### `rcs_rename($$)`
1018
1019 Rename a file. The filenames are relative to the root of the srcdir.
1020
1021 Note that this should not commit the rename, it should only
1022 prepare it for when `rcs_commit` (or `rcs_commit_staged`) is called.
1023 The new filename may be in a new subdir, that is not yet added to
1024 version control. If so, the subdir will exist already, and should
1025 be added to revision control.
1026
1027 #### `rcs_recentchanges($)`
1028
1029 Examine the RCS history and generate a list of recent changes.
1030 The parameter is how many changes to return.
1031
1032 The data structure returned for each change is:
1033
1034         {
1035                 rev => # the RCSs id for this commit
1036                 user => # name of user who made the change,
1037                 committype => # either "web" or the name of the rcs,
1038                 when => # time when the change was made,
1039                 message => [
1040                         { line => "commit message line 1" },
1041                         { line => "commit message line 2" },
1042                         # etc,
1043                 ],
1044                 pages => [
1045                         {
1046                                 page => # name of page changed,
1047                                 diffurl => # optional url to a diff of changes
1048                         },
1049                         # repeat for each page changed in this commit,
1050                 ],
1051         }
1052
1053 #### `rcs_diff($)`
1054
1055 The parameter is the rev from `rcs_recentchanges`.
1056 Should return a list of lines of the diff (including \n) in list
1057 context, and the whole diff in scalar context.
1058
1059 #### `rcs_getctime($)`
1060
1061 This is used to get the page creation time for a file from the RCS, by looking
1062 it up in the history.
1063
1064 It's ok if this is not implemented, and throws an error.
1065
1066 #### `rcs_receive()`
1067
1068 This is called when ikiwiki is running as a pre-receive hook (or
1069 equivalent), and is testing if changes pushed into the RCS from an
1070 untrusted user should be accepted. This is optional, and doesn't make
1071 sense to implement for all RCSs.
1072
1073 It should examine the incoming changes, and do any sanity 
1074 checks that are appropriate for the RCS to limit changes to safe file adds,
1075 removes, and changes. If something bad is found, it should exit
1076 nonzero, to abort the push. Otherwise, it should return a list of
1077 files that were changed, in the form:
1078
1079         {
1080                 file => # name of file that was changed
1081                 action => # either "add", "change", or "remove"
1082                 path => # temp file containing the new file content, only
1083                         # needed for "add"/"change", and only if the file
1084                         # is an attachment, not a page
1085         }
1086
1087 The list will then be checked to make sure that each change is one that
1088 is allowed to be made via the web interface.
1089
1090 ### PageSpec plugins
1091
1092 It's also possible to write plugins that add new functions to
1093 [[PageSpecs|ikiwiki/PageSpec]]. Such a plugin should add a function to the
1094 IkiWiki::PageSpec package, that is named `match_foo`, where "foo()" is
1095 how it will be accessed in a [[ikiwiki/PageSpec]]. The function will be passed
1096 two parameters: The name of the page being matched, and the thing to match
1097 against. It may also be passed additional, named parameters.
1098
1099 It should return a IkiWiki::SuccessReason object if the match succeeds, or
1100 an IkiWiki::FailReason object if the match fails. If the match cannot be
1101 attempted at all, for any page, it can instead return an
1102 IkiWiki::ErrorReason object explaining why.
1103
1104 When constructing these objects, you should also include information about
1105 of any pages whose contents or other metadata influenced the result of the
1106 match. Do this by passing a list of pages, followed by `deptype` values.
1107
1108 For example, "backlink(foo)" is influenced by the contents of page foo;
1109 "link(foo)" and "title(bar)" are influenced by the contents of any page
1110 they match; "created_before(foo)" is influenced by the metadata of foo;
1111 while "glob(*)" is not influenced by the contents of any page.
1112
1113 ### Setup plugins
1114
1115 The ikiwiki setup file is loaded using a pluggable mechanism. If you look
1116 at the top of a setup file, it starts with 'use IkiWiki::Setup::Standard',
1117 and the rest of the file is passed to that module's import method.
1118
1119 It's possible to write other modules in the `IkiWiki::Setup::` namespace that
1120 can be used to configure ikiwiki in different ways. These modules should,
1121 when imported, populate `$IkiWiki::Setup::raw_setup` with a reference
1122 to a hash containing all the config items. They should also implement a
1123 `gendump` function.
1124
1125 By the way, to parse a ikiwiki setup file and populate `%config`, a
1126 program just needs to do something like:
1127 `use IkiWiki::Setup; IkiWiki::Setup::load($filename)`
1128
1129 ### Function overriding
1130
1131 Sometimes using ikiwiki's pre-defined hooks is not enough. Your plugin
1132 may need to replace one of ikiwiki's own functions with a modified version,
1133 or wrap one of the functions.
1134
1135 For example, your plugin might want to override `displaytime`, to change
1136 the html markup used when displaying a date. Or it might want to override
1137 `IkiWiki::formattime`, to change how a date is formatted. Or perhaps you
1138 want to override `bestlink` and change how ikiwiki deals with [[WikiLinks|ikiwiki/WikiLink]].
1139
1140 By venturing into this territory, your plugin is becoming tightly tied to
1141 ikiwiki's internals. And it might break if those internals change. But
1142 don't let that stop you, if you're brave.
1143
1144 Ikiwiki provides an `inject()` function, that is a powerful way to replace
1145 any function with one of your own. This even allows you to inject a
1146 replacement for an exported function, like `bestlink`. Everything that
1147 imports that function will get your version instead. Pass it the name of
1148 the function to replace, and a new function to call. 
1149
1150 For example, here's how to replace `displaytime` with a version using HTML 5
1151 markup:
1152
1153         inject(name => 'IkiWiki::displaytime', call => sub {
1154                 return "<time>".formattime(@_)."</time>";
1155         });
1156
1157 Here's how to wrap `bestlink` with a version that tries to handle
1158 plural words:
1159
1160         my $origbestlink=\&bestlink;
1161         inject(name => 'IkiWiki::bestlink', call => \&mybestlink);
1162
1163         sub deplural ($) {
1164                 my $word=shift;
1165                 $word =~ s/e?s$//; # just an example :-)
1166                 return $word;
1167         }
1168
1169         sub mybestlink ($$) {
1170                 my $page=shift;
1171                 my $link=shift;
1172                 my $ret=$origbestlink->($page, $link);
1173                 if (! length $ret) {
1174                         $ret=$origbestlink->($page, deplural($link));
1175                 }
1176                 return $ret;
1177         }
1178
1179 ### Javascript
1180
1181 Some plugins use javascript to make ikiwiki look a bit more web-2.0-ish.
1182
1183 All javascript code should be put in `.js` files in the `javascript`
1184 underlay, and plugins using those files can enable use of the underlay by
1185 calling `add_underlay("javascript");` in their `import` function.
1186
1187 You'll have to arrange for `<script>` tags to be added to the pages that
1188 use your javascript. This can be done using a `format` hook.
1189
1190 Ikiwiki provides some utility functions in `ikiwiki.js`, for use by other
1191 javascript code. These include:
1192
1193 #### `getElementsByClass(cls, node, tag)` 
1194
1195 Returns an array of elements with the given class. The node and tag are
1196 optional and define what document node and element names to search.
1197
1198 #### `hook(name, call)`
1199
1200 The function `call` will be run as part of the hook named `name`.
1201
1202 Note that to hook into `window.onload`, you can use the `onload' hook.
1203
1204 #### `run_hooks(name)`
1205
1206 Runs the hooks with the specified name.