shortcut: Support Wikipedia's form of url-encoding for unicode characters

[ikiwiki.git] / IkiWiki / Plugin / shortcut.pm

diff --git a/IkiWiki/Plugin/shortcut.pm b/IkiWiki/Plugin/shortcut.pm
index 2a4a36a41764e29d7f50bcb03f50af167f32538a..98df143ab27e34506217f770d40c03e554dcd386 100644 (file)
--- a/IkiWiki/Plugin/shortcut.pm
+++ b/IkiWiki/Plugin/shortcut.pm
@@ -3,37 +3,59 @@ package IkiWiki::Plugin::shortcut;
 
 use warnings;
 use strict;
-use IkiWiki;
+use IkiWiki 3.00;
 
-sub import { #{{{
+sub import {
+       hook(type => "getsetup", id => "shortcut", call => \&getsetup);
        hook(type => "checkconfig", id => "shortcut", call => \&checkconfig);
        hook(type => "preprocess", id => "shortcut", call => \&preprocess_shortcut);
-} #}}}
+}
 
-sub checkconfig () { #{{{
-       # Preprocess the shortcuts page to get all the available shortcuts
-       # defined before other pages are rendered.
-       IkiWiki::preprocess("shortcuts", "shortcuts",
-               readfile(srcfile("shortcuts.mdwn")));
-} # }}}
+sub getsetup () {
+       return
+               plugin => {
+                       safe => 1,
+                       rebuild => undef,
+                       section => "widget",
+               },
+}
 
-sub preprocess_shortcut (@) { #{{{
+sub checkconfig () {
+       if (defined $config{srcdir} && length $config{srcdir}) {
+               # Preprocess the shortcuts page to get all the available shortcuts
+               # defined before other pages are rendered.
+               my $srcfile=srcfile("shortcuts.".$config{default_pageext}, 1);
+               if (! defined $srcfile) {
+                       $srcfile=srcfile("shortcuts.mdwn", 1);
+               }
+               if (! defined $srcfile) {
+                       print STDERR sprintf(gettext("shortcut plugin will not work without %s"),
+                               "shortcuts.".$config{default_pageext})."\n";
+               }
+               else {
+                       IkiWiki::preprocess("shortcuts", "shortcuts", readfile($srcfile));
+               }
+       }
+}
+
+sub preprocess_shortcut (@) {
        my %params=@_;
 
        if (! defined $params{name} || ! defined $params{url}) {
-               return "[[".gettext("shortcut missing name or url parameter")."]]";
+               error gettext("missing name or url parameter");
        }
 
        hook(type => "preprocess", no_override => 1, id => $params{name},
+               shortcut => 1,
                call => sub { shortcut_expand($params{url}, $params{desc}, @_) });
 
        #translators: This is used to display what shortcuts are defined.
        #translators: First parameter is the name of the shortcut, the second
        #translators: is an URL.
-       return sprintf(gettext("shortcut %s points to %s"), $params{name}, $params{url});
-} # }}}
+       return sprintf(gettext("shortcut %s points to <i>%s</i>"), $params{name}, $params{url});
+}
 
-sub shortcut_expand ($$@) { #{{{
+sub shortcut_expand ($$@) {
        my $url=shift;
        my $desc=shift;
        my %params=@_;
@@ -51,9 +73,27 @@ sub shortcut_expand ($$@) { #{{{
        add_depends($params{destpage}, "shortcuts");
 
        my $text=join(" ", @params);
-       my $encoded_text=$text;
-       $encoded_text=~s/([^A-Za-z0-9])/sprintf("%%%02X", ord($1))/seg;
        
+       $url=~s{\%([sSW])}{
+               if ($1 eq 's') {
+                       my $t=$text;
+                       $t=~s/([^A-Za-z0-9])/sprintf("%%%02X", ord($1))/seg;
+                       $t;
+               }
+               elsif ($1 eq 'S') {
+                       $text;
+               }
+               elsif ($1 eq 'W') {
+                       my $t=Encode::encode_utf8($text);
+                       $t=~s/([^A-Za-z0-9])/sprintf("%%%02X", ord($1))/seg;
+                       $t;
+               }
+       }eg;
+
+       $text=~s/_/ /g;
+       if (defined $params{desc}) {
+               $desc=$params{desc};
+       }
        if (defined $desc) {
                $desc=~s/\%s/$text/g;
        }
@@ -61,8 +101,7 @@ sub shortcut_expand ($$@) { #{{{
                $desc=$text;
        }
 
-       $url=~s/\%s/$encoded_text/g;
        return "<a href=\"$url\">$desc</a>";
-} #}}}
+}
 
 1