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