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