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