IkiWiki/Plugin/shortcut.pm

   1 #!/usr/bin/perl
   2 package IkiWiki::Plugin::shortcut;
   3
   4 use warnings;
   5 use strict;
   6 use IkiWiki 3.00;
   7
   8 sub import {
   9         hook(type => "getsetup", id => "shortcut", call => \&getsetup);
  10         hook(type => "checkconfig", id => "shortcut", call => \&checkconfig);
  11         hook(type => "preprocess", id => "shortcut", call => \&preprocess_shortcut);
  12 }
  13
  14 sub getsetup () {
  15         return
  16                 plugin => {
  17                         safe => 1,
  18                         rebuild => undef,
  19                 },
  20 }
  21
  22 sub checkconfig () {
  23         if (defined $config{srcdir} && length $config{srcdir}) {
  24                 # Preprocess the shortcuts page to get all the available shortcuts
  25                 # defined before other pages are rendered.
  26                 my $srcfile=srcfile("shortcuts.".$config{default_pageext}, 1);
  27                 if (! defined $srcfile) {
  28                         $srcfile=srcfile("shortcuts.mdwn", 1);
  29                 }
  30                 if (! defined $srcfile) {
  31                         print STDERR sprintf(gettext("shortcut plugin will not work without %s"),
  32                                 "shortcuts.".$config{default_pageext})."\n";
  33                 }
  34                 else {
  35                         IkiWiki::preprocess("shortcuts", "shortcuts", readfile($srcfile));
  36                 }
  37         }
  38 }
  39
  40 sub preprocess_shortcut (@) {
  41         my %params=@_;
  42
  43         if (! defined $params{name} || ! defined $params{url}) {
  44                 error gettext("missing name or url parameter");
  45         }
  46
  47         hook(type => "preprocess", no_override => 1, id => $params{name},
  48                 shortcut => 1,
  49                 call => sub { shortcut_expand($params{url}, $params{desc}, @_) });
  50
  51         #translators: This is used to display what shortcuts are defined.
  52         #translators: First parameter is the name of the shortcut, the second
  53         #translators: is an URL.
  54         return sprintf(gettext("shortcut %s points to <i>%s</i>"), $params{name}, $params{url});
  55 }
  56
  57 sub shortcut_expand ($$@) {
  58         my $url=shift;
  59         my $desc=shift;
  60         my %params=@_;
  61
  62         # Get params in original order.
  63         my @params;
  64         while (@_) {
  65                 my $key=shift;
  66                 my $value=shift;
  67                 push @params, $key if ! length $value;
  68         }
  69
  70         # If the shortcuts page changes, all pages that use shortcuts will
  71         # need to be updated.
  72         add_depends($params{destpage}, "shortcuts");
  73
  74         my $text=join(" ", @params);
  75         my $encoded_text=$text;
  76         $encoded_text=~s/([^A-Za-z0-9])/sprintf("%%%02X", ord($1))/seg;
  77
  78         $url=~s{\%([sS])}{
  79                 $1 eq 's' ? $encoded_text : $text
  80         }eg;
  81
  82         $text=~s/_/ /g;
  83         if (defined $params{desc}) {
  84                 $desc=$params{desc};
  85         }
  86         if (defined $desc) {
  87                 $desc=~s/\%s/$text/g;
  88         }
  89         else {
  90                 $desc=$text;
  91         }
  92
  93         return "<a href=\"$url\">$desc</a>";
  94 }
  95
  96 1