doc/plugins/contrib/bibtex2html.mdwn

   1 [[!template id=plugin name=bibtex2html author="[[anarcat]]"]]
   2
   3 Trivial plugin to implement [[todo/BibTeX]] support simply using [bibtex2html](https://www.lri.fr/~filliatr/bibtex2html/). It only takes a `bib` file as an argument and dumps whatever bibtex2html returns for it, so it shows *all* the entries, something that is not really possible with the existing [[bibtex]] plugin, as that one requires you to explicitly state every citation you want to show.
   4
   5 It is hopefully secure enough, but I have still marked it as unsafe because I am worried about parameter expansion in bibtex calls from bibtex2html that wouldn't escape those characters properly. The pipeline is called safely, but certain `-flags` could be maliciously added to the filenames somehow.
   6
   7 [[!format perl """
   8 #!/usr/bin/perl
   9 package IkiWiki::Plugin::bibtex2html;
  10 use warnings;
  11 use strict;
  12 use IkiWiki 3.00;
  13 use open qw{:utf8 :std};
  14
  15 sub import {
  16         hook(type => "getsetup", id => "bibtex2html",  call => \&getsetup);
  17         hook(type => "preprocess", id => "bibtex2html", call => \&bibtex2html);
  18 }
  19
  20 sub getsetup () {
  21         return
  22                 plugin => {
  23                         safe => 0,
  24                         rebuild => undef,
  25                         section => "core",
  26                 },
  27 }
  28
  29 sub bibtex2html {
  30     my %params=@_;
  31
  32     # check the files exist
  33     my $file=shift;
  34     if (! defined $file) {
  35         error sprintf(gettext('file parameter is required'));
  36     }
  37     my $near = bestlink($params{page}, $file);
  38     if (! $near) {
  39         error sprintf(gettext('cannot find bestlink for "%s"'), $file);
  40     }
  41     if (! exists $pagesources{$near}) {
  42         error sprintf(gettext('cannot find file "%s"'), $near);
  43     }
  44     add_depends($params{page}, $near);
  45     $near = srcfile($near);
  46     my @bibtex_cmd = (qw[bibtex2html -noheader -nofooter -nobibsource -nodoc -q -o -], $near);
  47
  48     open(PIPE, "-|", @bibtex_cmd)
  49         || error "can't open pipe to @bibtex_cmd: $!";
  50     my $html = join("", <PIPE>);
  51     close PIPE;
  52     debug "ran @bibtex_cmd: $html";
  53     return "<div class=\"bibtex2html\">$html<!-- The above was generated with @bibtex_cmd--></div>";
  54 }
  55
  56 1;
  57 """]]
  58
  59 The plugin is generic enough that I wonder if there's a level of abstraction that exists here that I have missed. If not it would be interesting to add. Update: that tool is the [[compile]] plugin, darn it. I guess the next step here is to review that plugin and figure out how to do exactly this with just the `compile` configuration. Yet this works for me now so I'm unlikely to do that in the short term.
  60
  61 Obviously, this should be implemented through Text::Bibtex as forking is expensive. Yet I haven't found a way to do what this plugin does with the existing [[bibtex]] module. [[bibtex]] could of course be extended and then render this plugin obsolete, but I have found it simpler to just reuse an existing working rendered than rewrite my own in Perl. --[[anarcat]]