* Add no_override parameter to hook().

* Add a shortcut plugin, inspired by Victor Moral's contributed shortcuts 
  plugin, but featuring a more ikiwiki-ish syntax and with shortcuts that
  can be configured using a page in wiki.

1 files changed, 58 insertions, 0 deletions

diff --git a/IkiWiki/Plugin/shortcut.pm b/IkiWiki/Plugin/shortcut.pm
new file mode 100644
index 000000000..d09d5879d
--- /dev/null
+++ b/IkiWiki/Plugin/shortcut.pm
@@ -0,0 +1,58 @@
+#!/usr/bin/perl
+package IkiWiki::Plugin::shortcut;
+
+use warnings;
+use strict;
+use IkiWiki;
+
+sub import { #{{{
+	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 preprocess_shortcut (@) { #{{{
+	my %params=@_;
+
+	if (! defined $params{name} || ! defined $params{url}) {
+		return "[[shortcut missing name or url parameter]]";
+	}
+
+	hook(type => "preprocess", no_override => 1, id => $params{name},
+		call => sub { shortcut_expand($params{name}, $params{url}, @_) });
+
+	return "shortcut $params{name} points to $params{url}";
+} # }}}
+
+sub shortcut_expand ($$@) { #{{{
+	my $name=shift;
+	my $url=shift;
+	my %params=@_;
+
+	# Get params in original order.
+	my @params;
+	while (@_) {
+		my $key=shift;
+		my $value=shift;
+		push @params, $key if ! length $value;
+	}
+
+	# If the shortcuts page changes, all pages that use shortcuts will
+	# need to be updated.
+	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/\%s/$encoded_text/g;
+	return "<a href=\"$url\">$text</a>";
+} #}}}
+
+1