0eef3d2baa996d9fc566b6bc2d9a4c99664a8eeb
[ikiwiki.git] / doc / plugins / write.mdwn
1 ikiwiki [[plugins]] are written in perl. Each plugin is a perl module, in
2 the `IkiWiki::Plugin` namespace. The name of the plugin is typically in
3 lowercase, such as `IkiWiki::Plugin::inline`. Ikiwiki includes a
4 `IkiWiki::Plugin::skeleton` that can be fleshed out to make a useful
5 plugin. `IkiWiki::Plugin::pagecount` is another simple example.
6
7 [[toc levels=2]]
8
9 ## Considerations
10
11 One thing to keep in mind when writing a plugin is that ikiwiki is a wiki
12 *compiler*. So plugins influence pages when they are built, not when they
13 are loaded. A plugin that inserts the current time into a page, for
14 example, will insert the build time. Also, as a compiler, ikiwiki avoids
15 rebuilding pages unless they have changed, so a plugin that prints some
16 random or changing thing on a page will generate a static page that won't
17 change until ikiwiki rebuilds the page for some other reason, like the page
18 being edited.
19
20 ## Registering plugins
21
22 All plugins should `use IkiWiki` to import the ikiwiki plugin interface.
23 It's a good idea to include the version number of the plugin interface that
24 your plugin expects: `use IkiWiki 2.00`
25
26 Plugins should, when imported, call `hook()` to hook into ikiwiki's
27 processing. The function uses named parameters, and use varies depending on
28 the type of hook being registered -- see below. Note that a plugin can call
29 the function more than once to register multiple hooks. All calls to
30 `hook()` should be passed a "type" parameter, which gives the type of
31 hook, a "id" paramter, which should be a unique string for this plugin, and
32 a "call" parameter, which is a reference to a function to call for the
33 hook.
34
35 An optional "scan" parameter, if set to a true value, makes the hook be
36 called during the preliminary scan that ikiwiki makes of updated pages,
37 before begining to render pages. This parameter should be set to true if
38 the hook modifies data in `%links`. Note that doing so will make the hook
39 be run twice per page build, so avoid doing it for expensive hooks.
40
41 An optional "last" parameter, if set to a true value, makes the hook run
42 after all other hooks of its type. Useful if the hook depends on some other
43 hook being run first.
44
45 ## Types of hooks
46
47 In roughly the order they are called.
48
49 ### getopt
50
51         hook(type => "getopt", id => "foo", call => \&getopt);
52
53 This allows for plugins to perform their own processing of command-line
54 options and so add options to the ikiwiki command line. It's called during
55 command line processing, with @ARGV full of any options that ikiwiki was
56 not able to process on its own. The function should process any options it
57 can, removing them from @ARGV, and probably recording the configuration
58 settings in %config. It should take care not to abort if it sees
59 an option it cannot process, and should just skip over those options and
60 leave them in @ARGV.
61
62 ### checkconfig
63
64         hook(type => "checkconfig", id => "foo", call => \&checkconfig);
65
66 This is useful if the plugin needs to check for or modify ikiwiki's
67 configuration. It's called early in the startup process. The
68 function is passed no values. It's ok for the function to call
69 `error()` if something isn't configured right.
70
71 ### filter
72
73         hook(type => "filter", id => "foo", call => \&filter);
74
75 Runs on the raw source of a page, before anything else touches it, and can
76 make arbitrary changes. The function is passed named parameters `page` and
77 `content` and should return the filtered content.
78
79 ### scan
80
81         hook(type => "scan", id => "foo", call => \&scan);
82
83 This is identical to a preprocess hook (see below), except that it is
84 called in the initial pass that scans pages for data that will be used in
85 later passes. Scan hooks are the only hook that should modify `%links`.
86
87 ### preprocess
88
89 Adding a [[PreProcessorDirective]] is probably the most common use of a
90 plugin.
91
92         hook(type => "preprocess", id => "foo", call => \&preprocess);
93
94 Replace "foo" with the command name that will be used inside brackets for
95 the preprocessor directive.
96
97 Each time the directive is processed, the referenced function (`preprocess`
98 in the example above) is called, and is passed named parameters. A "page"
99 parameter gives the name of the page that embedded the preprocessor
100 directive, while a "destpage" parameter gives the name of the page the
101 content is going to (different for inlined pages), and a "preview"
102 parameter is set to a true value if the page is being previewed. All
103 parameters included in the directive are included as named parameters as
104 well. Whatever the function returns goes onto the page in place of the
105 directive.
106
107 Note that if the [[htmlscrubber]] is enabled, html in
108 [[PreProcessorDirective]] output is sanitised, which may limit what your
109 plugin can do. Also, the rest of the page content is not in html format at
110 preprocessor time. Text output by a preprocessor directive will be
111 linkified and passed through markdown (or whatever engine is used to htmlize
112 the page) along with the rest of the page.
113
114 ### htmlize
115
116         hook(type => "htmlize", id => "ext", call => \&htmlize);
117
118 Runs on the raw source of a page and turns it into html. The id parameter
119 specifies the filename extension that a file must have to be htmlized using
120 this plugin. This is how you can add support for new and exciting markup
121 languages to ikiwiki.
122
123 The function is passed named parameters: "page" and "content" and should
124 return the htmlized content.
125
126 ### pagetemplate
127
128         hook(type => "pagetemplate", id => "foo", call => \&pagetemplate);
129
130 [[Templates]] are filled out for many different things in ikiwiki, like
131 generating a page, or part of a blog page, or an rss feed, or a cgi. This
132 hook allows modifying those templates. The function is passed named
133 parameters. The "page" and "destpage" parameters are the same as for a
134 preprocess hook. The "template" parameter is a [[cpan HTML::Template]]
135 object that is the template that will be used to generate the page. The
136 function can manipulate that template object.
137
138 The most common thing to do is probably to call $template->param() to add
139 a new custom parameter to the template.
140
141 ### sanitize
142
143         hook(type => "sanitize", id => "foo", call => \&sanitize);
144
145 Use this to implement html sanitization or anything else that needs to
146 modify the body of a page after it has been fully converted to html.
147
148 The function is passed named parameters: "page" and "content", and 
149 should return the sanitized content.
150
151 ### format
152
153         hook(type => "format", id => "foo", call => \&format);
154
155 The difference between format and sanitize is that sanitize only acts on
156 the page body, while format can modify the entire html page including the
157 header and footer inserted by ikiwiki, the html document type, etc.
158
159 The function is passed named parameters: "page" and "content", and 
160 should return the formatted content.
161
162 ### delete
163
164         hook(type => "delete", id => "foo", call => \&delete);
165
166 Each time a page or pages is removed from the wiki, the referenced function
167 is called, and passed the names of the source files that were removed.
168
169 ### change
170
171         hook(type => "change", id => "foo", call => \&render);
172
173 Each time ikiwiki renders a change or addition (but not deletion) to the
174 wiki, the referenced function is called, and passed the names of the
175 source files that were rendered.
176
177 ### cgi
178
179         hook(type => "cgi", id => "foo", call => \&cgi);
180
181 Use this to hook into ikiwiki's cgi script. Each registered cgi hook is
182 called in turn, and passed a CGI object. The hook should examine the
183 parameters, and if it will handle this CGI request, output a page and
184 terminate the program.
185
186 ### auth
187
188         hook(type => "auth", id => "foo", call => \&auth);
189
190 This hook can be used to implement a different authentication method than
191 the standard web form. When a user needs to be authenticated, each registered
192 auth hook is called in turn, and passed a CGI object and a session object. 
193
194 If the hook is able to authenticate the user, it should set the session
195 object's "name" parameter to the authenticated user's name. Note that
196 if the name is set to the name of a user who is not registered,
197 a basic registration of the user will be automatically performed.
198
199 ### canedit
200
201         hook(type => "canedit", id => "foo", call => \&pagelocked);
202
203 This hook can be used to implement arbitrary access methods to control when
204 a page can be edited using the web interface (commits from revision control
205 bypass it). When a page is edited, each registered canedit hook is called
206 in turn, and passed the page name, a CGI object, and a session object.
207
208 If edit can proceed, the hook should return "". If the edit is not allowed
209 by this hook, the hook should return an error message for the user to see.
210 If the hook has no opinion about whether the edit can proceed, return
211 `undef`, and the next plugin will be asked to decide.
212
213 ### formbuilder
214
215         hook(type => "formbuilder_setup", id => "foo", call => \&formbuilder_setup);
216         hook(type => "formbuilder", id => "foo", call => \&formbuilder);
217
218 These hooks allow tapping into the parts of ikiwiki that use [[cpan
219 CGI::FormBuilder]] to generate web forms. These hooks are passed named
220 parameters: `cgi`, `session`, and `form`. These are, respectively, the
221 `CGI` object, the user's `CGI::Session`, and a `CGI::FormBuilder`.
222
223 Each time a form is set up, the `formbuilder_setup` hook is called.
224 Typically the `formbuilder_setup` hook will check the form's title, and if
225 it's a form that it needs to modify, will call various methods to
226 add/remove/change fields, tweak the validation code for the fields, etc. It
227 will not validate or display the form.
228
229 Form validation and display can be overridden by the formbuilder hook.
230 By default, ikiwiki will do a basic validation and display of the form,
231 but if this hook is registered, it will stop that and let the hook take
232 over. This hook is passed an additional named parameter: `buttons` is an
233 array of the submit buttons for the form.
234
235 ### savestate
236
237         hook(type => "savestate", id => "foo", call => \&savestate);
238
239 This hook is called wheneven ikiwiki normally saves its state, just before
240 the state is saved. The function can save other state, modify values before
241 they're saved, etc.
242
243 ## Plugin interface
244
245 To import the ikiwiki plugin interface:
246
247         use IkiWiki '1.00';
248
249 This will import several variables and functions into your plugin's
250 namespace. These variables and functions are the ones most plugins need,
251 and a special effort will be made to avoid changing them in incompatible
252 ways, and to document any changes that have to be made in the future.
253
254 Note that IkiWiki also provides other variables functions that are not
255 exported by default. No guarantee is made about these in the future, so if
256 it's not exported, the wise choice is to not use it.
257
258 ### %config
259
260 A plugin can access the wiki's configuration via the `%config`
261 hash. The best way to understand the contents of the hash is to look at
262 [[ikiwiki.setup]], which sets the hash content to configure the wiki.
263
264 ### Other variables
265
266 If your plugin needs to access data about other pages in the wiki. It can
267 use the following hashes, using a page name as the key:
268
269 * `links` lists the names of each page that a page links to, in an array
270   reference.
271 * `%destsources` contains the name of the source file used to create each
272   destination file.
273 * `%pagesources` contains the name of the source file for each page.
274
275 Also, the %IkiWiki::version variable contains the version number for the
276 ikiwiki program.
277
278 ### Library functions
279
280 #### `hook(@)`
281
282 Hook into ikiwiki's processing. See the discussion of hooks above.
283
284 Note that in addition to the named parameters described above, a parameter
285 named no_override is supported, If it's set to a true value, then this hook
286 will not override any existing hook with the same id. This is useful if
287 the id can be controled by the user.
288
289 #### `debug($)`
290
291 Logs a debugging message. These are supressed unless verbose mode is turned
292 on.
293
294 #### `error($;$)`
295
296 Aborts with an error message. If the second parameter is passed, it is a
297 function that is called after the error message is printed, to do any final
298 cleanup.
299
300 Note that while any plugin can use this for a fatal error, plugins should
301 try to avoid dying on bad input, as that will halt the entire wiki build
302 and make the wiki unusable. So for example, if a [[PreProcessorDirective]]
303 is passed bad parameters, it's better to return an error message, which can
304 appear on the wiki page, rather than calling error().
305
306 #### `template($;@)`
307
308 Creates and returns a [[cpan HTML::Template]] object. The first parameter
309 is the name of the file in the template directory. The optional remaining
310 parameters are passed to HTML::Template->new.
311
312 #### `htmlpage($)`
313
314 Passed a page name, returns the base name that will be used for a the html
315 page created from it. (Ie, it appends ".html".)
316
317 #### `add_depends($$)`
318
319 Makes the specified page depend on the specified [[PageSpec]].
320
321 #### `pagespec_match($$;@)`
322
323 Passed a page name, and [[PageSpec]], returns true if the [[PageSpec]]
324 matches the page.
325
326 Additional named parameters can be passed, to further limit the match.
327 The most often used is "location", which specifies the location the
328 PageSpec should match against. If not passed, relative PageSpecs will match
329 relative to the top of the wiki.
330
331 #### `bestlink($$)`
332
333 Given a page and the text of a link on the page, determine which
334 existing page that link best points to. Prefers pages under a
335 subdirectory with the same name as the source page, failing that
336 goes down the directory tree to the base looking for matching
337 pages, as described in [[SubPage/LinkingRules]].
338
339 #### `htmllink($$$;@)`
340
341 Many plugins need to generate html links and add them to a page. This is
342 done by using the `htmllink` function. The usual way to call
343 `htmlllink` is:
344
345         htmllink($page, $page, $link)
346
347 Why is `$page` repeated? Because if a page is inlined inside another, and a
348 link is placed on it, the right way to make that link is actually:
349
350         htmllink($page, $destpage, $link)
351
352 Here `$destpage` is the inlining page. A `destpage` parameter is passed to
353 some of the hook functions above; the ones that are not passed it are not used
354 during inlining and don't need to worry about this issue.
355
356 After the three required parameters, named parameters can be used to
357 control some options. These are:
358
359 * noimageinline - set to true to avoid turning links into inline html images
360 * forcesubpage  - set to force a link to a subpage
361 * linktext - set to force the link text to something
362 * anchor - set to make the link include an anchor
363
364 #### `readfile($;$)`
365
366 Given a filename, reads and returns the entire file.
367
368 The optional second parameter, if set to a true value, makes the file be read
369 in binary mode.
370
371 A failure to read the file will result in it dying with an error.
372
373 #### `writefile($$$;$$)`
374
375 Given a filename, a directory to put it in, and the file's content,
376 writes a file. 
377
378 The optional fourth parameter, if set to a true value, makes the file be
379 written in binary mode.
380
381 The optional fifth parameter can be used to pass a function reference that
382 will be called to handle writing to the file. The function will be called
383 and passed a file descriptor it should write to, and an error recovery
384 function it should call if the writing fails. (You will not normally need to
385 use this interface.)
386
387 A failure to write the file will result in it dying with an error.
388
389 If the destination directory doesn't exist, it will first be created.
390
391 ### `will_render($$)`
392
393 Given a page name and a destination file name (not including the base
394 destination directory), register that the page will result in that file
395 being rendered. It's important to call this before writing to any file in
396 the destination directory.
397
398 #### `pagetype($)`
399
400 Given the name of a source file, returns the type of page it is, if it's
401 a type that ikiwiki knowns how to htmlize. Otherwise, returns undef.
402
403 #### `pagename($)`
404
405 Given the name of a source file, returns the name of the wiki page
406 that corresponds to that file.
407
408 #### `srcfile($)`
409
410 Given the name of a source file in the wiki, searches for the file in
411 the source directory and the underlay directory, and returns the full
412 path to the first file found.
413
414 #### `displaytime($)`
415
416 Given a time, formats it for display.
417
418 #### `gettext`
419
420 This is the standard gettext function, although slightly optimised.
421
422 #### `urlto($$)`
423
424 Construct a relative url to the first parameter from the second.
425
426 #### `targetpage($$)`
427
428 Passed a page and an extension, returns the filename that page will be
429 rendered to.
430
431 ## RCS plugins
432
433 ikiwiki's support for revision control systems also uses pluggable perl
434 modules. These are in the `IkiWiki::RCS` namespace, for example
435 `IkiWiki::RCS::svn`. 
436
437 Each RCS plugin must support all the IkiWiki::rcs\_* functions.
438 See IkiWiki::RCS::Stub for the full list of functions. It's ok if
439 rcs\_getctime does nothing except for throwing an error.
440
441 See [[about_RCS_backends]] for some more info.
442
443 ## PageSpec plugins
444
445 It's also possible to write plugins that add new functions to
446 [[PageSpecs|PageSpec]]. Such a plugin should add a function to the
447 IkiWiki::PageSpec package, that is named `match_foo`, where "foo()" is
448 how it will be accessed in a [[PageSpec]]. The function will be passed
449 two parameters: The name of the page being matched, and the thing to match
450 against. It may also be passed additional, named parameters. It should return
451 a IkiWiki::SuccessReason object if the match succeeds, or an
452 IkiWiki::FailReason object if the match fails.