* Work on firming up the plugin interface:

  - Plugins should not need to load IkiWiki::Render to get commonly
    used functions, so moved some functions from there to IkiWiki.
  - Picked out the set of functions and variables that most plugins
    use, documented them, and made IkiWiki export them by default,
    like a proper perl module should.
  - Use the other functions at your own risk.
  - This is not quite complete, I still have to decide whether to
    export some other things.
* Changed all plugins included in ikiwiki to not use "IkiWiki::" when
  referring to stuff now exported by the IkiWiki module.
* Anyone with a third-party ikiwiki plugin is strongly enrouraged
  to make like changes to it and avoid use of non-exported symboles from
  "IkiWiki::".
* Link debian/changelog and debian/news to NEWS and CHANGELOG.
* Support hyperestradier version 1.4.2, which adds a new required phraseform
  setting.

Author: joey

CHANGELOG

@@ -0,0 +1 @@
+debian/changelog

IkiWiki.pm

@@ -7,14 +7,19 @@ use Encode;
 use HTML::Entities;
 use open qw{:utf8 :std};
 
+use vars qw{%config %links %oldlinks %oldpagemtime %pagectime %pagecase
+            %renderedfiles %pagesources %depends %hooks %forcerebuild};
+
+use Exporter q{import};
+our @EXPORT = qw(hook debug error template htmlpage add_depends pagespec_match
+                 bestlink htmllink readfile writefile pagetype srcfile pagename
+                 %config %links %renderedfiles %pagesources);
+
 # Optimisation.
 use Memoize;
 memoize("abs2rel");
 memoize("pagespec_translate");
 
-use vars qw{%config %links %oldlinks %oldpagemtime %pagectime %pagecase
-            %renderedfiles %pagesources %depends %hooks %forcerebuild};
-
 my $installdir=''; # INSTALLDIR_AUTOREPLACE done by Makefile, DNE
 
 sub defaultconfig () { #{{{
@@ -254,11 +259,6 @@ sub writefile ($$$;$) { #{{{
 } #}}}
 
 sub bestlink ($$) { #{{{
-	# Given a page and the text of a link on the page, determine which
-	# existing page that link best points to. Prefers pages under a
-	# subdirectory with the same name as the source page, failing that
-	# goes down the directory tree to the base looking for matching
-	# pages.
 	my $page=shift;
 	my $link=shift;
 
@@ -329,6 +329,16 @@ sub abs2rel ($$) { #{{{
 	return $ret;
 } #}}}
 
+sub displaytime ($) { #{{{
+	my $time=shift;
+
+	eval q{use POSIX};
+	# strftime doesn't know about encodings, so make sure
+	# its output is properly treated as utf8
+	return decode_utf8(POSIX::strftime(
+			$config{timeformat}, localtime($time)));
+} #}}}
+
 sub htmllink ($$$;$$$) { #{{{
 	my $lpage=shift; # the page doing the linking
 	my $page=shift; # the page that will contain the link (different for inline)
@@ -370,6 +380,117 @@ sub htmllink ($$$;$$$) { #{{{
 	return "<a href=\"$bestlink\">$linktext</a>";
 } #}}}
 
+sub htmlize ($$$) { #{{{
+	my $page=shift;
+	my $type=shift;
+	my $content=shift;
+
+	if (exists $hooks{htmlize}{$type}) {
+		$content=$hooks{htmlize}{$type}{call}->(
+			page => $page,
+			content => $content,
+		);
+	}
+	else {
+		error("htmlization of $type not supported");
+	}
+
+	run_hooks(sanitize => sub {
+		$content=shift->(
+			page => $page,
+			content => $content,
+		);
+	});
+
+	return $content;
+} #}}}
+
+sub linkify ($$$) { #{{{
+	my $lpage=shift; # the page containing the links
+	my $page=shift; # the page the link will end up on (different for inline)
+	my $content=shift;
+
+	$content =~ s{(\\?)$config{wiki_link_regexp}}{
+		$2 ? ( $1 ? "[[$2|$3]]" : htmllink($lpage, $page, titlepage($3), 0, 0, pagetitle($2)))
+		   : ( $1 ? "[[$3]]" :    htmllink($lpage, $page, titlepage($3)))
+	}eg;
+	
+	return $content;
+} #}}}
+
+my %preprocessing;
+sub preprocess ($$$) { #{{{
+	my $page=shift; # the page the data comes from
+	my $destpage=shift; # the page the data will appear in (different for inline)
+	my $content=shift;
+
+	my $handle=sub {
+		my $escape=shift;
+		my $command=shift;
+		my $params=shift;
+		if (length $escape) {
+			return "[[$command $params]]";
+		}
+		elsif (exists $hooks{preprocess}{$command}) {
+			# Note: preserve order of params, some plugins may
+			# consider it significant.
+			my @params;
+			while ($params =~ /(?:(\w+)=)?(?:"""(.*?)"""|"([^"]+)"|(\S+))(?:\s+|$)/sg) {
+				my $key=$1;
+				my $val;
+				if (defined $2) {
+					$val=$2;
+					$val=~s/\r\n/\n/mg;
+					$val=~s/^\n+//g;
+					$val=~s/\n+$//g;
+				}
+				elsif (defined $3) {
+					$val=$3;
+				}
+				elsif (defined $4) {
+					$val=$4;
+				}
+
+				if (defined $key) {
+					push @params, $key, $val;
+				}
+				else {
+					push @params, $val, '';
+				}
+			}
+			if ($preprocessing{$page}++ > 3) {
+				# Avoid loops of preprocessed pages preprocessing
+				# other pages that preprocess them, etc.
+				return "[[$command preprocessing loop detected on $page at depth $preprocessing{$page}]]";
+			}
+			my $ret=$hooks{preprocess}{$command}{call}->(
+				@params,
+				page => $page,
+				destpage => $destpage,
+			);
+			$preprocessing{$page}--;
+			return $ret;
+		}
+		else {
+			return "[[$command $params]]";
+		}
+	};
+	
+	$content =~ s{(\\?)\[\[(\w+)\s+((?:(?:\w+=)?(?:""".*?"""|"[^"]+"|[^\s\]]+)\s*)*)\]\]}{$handle->($1, $2, $3)}seg;
+	return $content;
+} #}}}
+
+sub filter ($$) {
+	my $page=shift;
+	my $content=shift;
+
+	run_hooks(filter => sub {
+		$content=shift->(page => $page, content => $content);
+	});
+
+	return $content;
+}
+
 sub indexlink () { #{{{
 	return "<a href=\"$config{url}\">$config{wikiname}</a>";
 } #}}}
@@ -478,7 +599,7 @@ sub misctemplate ($$) { #{{{
 		indexlink => indexlink(),
 		wikiname => $config{wikiname},
 		pagebody => $pagebody,
-		baseurl => baseurl(),
+	baseurl => baseurl(),
 	);
 	return $template->output;
 }#}}}
@@ -594,6 +715,18 @@ sub pagespec_translate ($) { #{{{
 	return $code;
 } #}}}
 
+sub add_depends ($$) { #{{{
+	my $page=shift;
+	my $pagespec=shift;
+	
+	if (! exists $depends{$page}) {
+		$depends{$page}=$pagespec;
+	}
+	else {
+		$depends{$page}=pagespec_merge($depends{$page}, $pagespec);
+	}
+} # }}}
+
 sub pagespec_match ($$) { #{{{
 	my $page=shift;
 	my $spec=shift;

IkiWiki/CGI.pm

@@ -431,7 +431,6 @@ sub cgi_editpage ($$) { #{{{
 		return;
 	}
 	elsif ($form->submitted eq "Preview") {
-		require IkiWiki::Render;
 		my $content=$form->field('editcontent');
 		my $comments=$form->field('comments');
 		$form->field(name => "editcontent",

IkiWiki/Plugin/aggregate.pm

@@ -14,30 +14,24 @@ my %feeds;
 my %guids;
 
 sub import { #{{{
-	IkiWiki::hook(type => "getopt", id => "aggregate", 
-		call => \&getopt);
-	IkiWiki::hook(type => "checkconfig", id => "aggregate",
-		call => \&checkconfig);
-	IkiWiki::hook(type => "filter", id => "aggregate", 
-		call => \&filter);
-	IkiWiki::hook(type => "preprocess", id => "aggregate",
-		call => \&preprocess);
-        IkiWiki::hook(type => "delete", id => "aggregate",
-                call => \&delete);
-	IkiWiki::hook(type => "savestate", id => "aggregate",
-		call => \&savestate);
+	hook(type => "getopt", id => "aggregate", call => \&getopt);
+	hook(type => "checkconfig", id => "aggregate", call => \&checkconfig);
+	hook(type => "filter", id => "aggregate", call => \&filter);
+	hook(type => "preprocess", id => "aggregate", call => \&preprocess);
+        hook(type => "delete", id => "aggregate", call => \&delete);
+	hook(type => "savestate", id => "aggregate", call => \&savestate);
 } # }}}
 
 sub getopt () { #{{{
         eval q{use Getopt::Long};
         Getopt::Long::Configure('pass_through');
-        GetOptions("aggregate" => \$IkiWiki::config{aggregate});
+        GetOptions("aggregate" => \$config{aggregate});
 } #}}}
 
 sub checkconfig () { #{{{
 	IkiWiki::lockwiki();
 	loadstate();
-	if ($IkiWiki::config{aggregate}) {
+	if ($config{aggregate}) {
 		IkiWiki::loadindex();
 		aggregate();
 		savestate();
@@ -78,7 +72,7 @@ sub preprocess (@) { #{{{
 	$feed->{url}=$params{url};
 	my $dir=exists $params{dir} ? $params{dir} : $params{page}."/".IkiWiki::titlepage($params{name});
 	$dir=~s/^\/+//;
-	($dir)=$dir=~/$IkiWiki::config{wiki_file_regexp}/;
+	($dir)=$dir=~/$config{wiki_file_regexp}/;
 	$feed->{dir}=$dir;
 	$feed->{feedurl}=defined $params{feedurl} ? $params{feedurl} : "";
 	$feed->{updateinterval}=defined $params{updateinterval} ? $params{updateinterval} * 60 : 15 * 60;
@@ -109,15 +103,15 @@ sub delete (@) { #{{{
 
 	# Remove feed data for removed pages.
 	foreach my $file (@files) {
-		my $page=IkiWiki::pagename($file);
+		my $page=pagename($file);
 		remove_feeds($page);
 	}
 } #}}}
 
 sub loadstate () { #{{{
-	if (-e "$IkiWiki::config{wikistatedir}/aggregate") {
-		open (IN, "$IkiWiki::config{wikistatedir}/aggregate" ||
-			die "$IkiWiki::config{wikistatedir}/aggregate: $!");
+	if (-e "$config{wikistatedir}/aggregate") {
+		open (IN, "$config{wikistatedir}/aggregate" ||
+			die "$config{wikistatedir}/aggregate: $!");
 		while (<IN>) {
 			$_=IkiWiki::possibly_foolish_untaint($_);
 			chomp;
@@ -151,8 +145,8 @@ sub loadstate () { #{{{
 sub savestate () { #{{{
 	eval q{use HTML::Entities};
 	die $@ if $@;
-	open (OUT, ">$IkiWiki::config{wikistatedir}/aggregate" ||
-		die "$IkiWiki::config{wikistatedir}/aggregate: $!");
+	open (OUT, ">$config{wikistatedir}/aggregate" ||
+		die "$config{wikistatedir}/aggregate: $!");
 	foreach my $data (values %feeds, values %guids) {
 		if ($data->{remove}) {
 			if ($data->{name}) {
@@ -193,32 +187,32 @@ sub aggregate () { #{{{
 	die $@ if $@;
 
 	foreach my $feed (values %feeds) {
-		next unless $IkiWiki::config{rebuild} || 
+		next unless $config{rebuild} || 
 			time - $feed->{lastupdate} >= $feed->{updateinterval};
 		$feed->{lastupdate}=time;
 		$feed->{newposts}=0;
 		$IkiWiki::forcerebuild{$feed->{sourcepage}}=1;
 
-		IkiWiki::debug("checking feed ".$feed->{name}." ...");
+		debug("checking feed ".$feed->{name}." ...");
 
 		if (! length $feed->{feedurl}) {
 			my @urls=XML::Feed->find_feeds($feed->{url});
 			if (! @urls) {
 				$feed->{message}="could not find feed at ".$feed->{feedurl};
-				IkiWiki::debug($feed->{message});
+				debug($feed->{message});
 				next;
 			}
 			$feed->{feedurl}=pop @urls;
 		}
 		my $f=eval{XML::Feed->parse(URI->new($feed->{feedurl}))};
 		if ($@) {
 			$feed->{message}="feed crashed XML::Feed! $@";
-			IkiWiki::debug($feed->{message});
+			debug($feed->{message});
 			next;
 		}
 		if (! $f) {
 			$feed->{message}=XML::Feed->errstr;
-			IkiWiki::debug($feed->{message});
+			debug($feed->{message});
 			next;
 		}
 
@@ -234,7 +228,7 @@ sub aggregate () { #{{{
 		}
 
 		$feed->{message}="processed ok at ".
-			IkiWiki::displaytime($feed->{lastupdate});
+			displaytime($feed->{lastupdate});
 	}
 
 	# TODO: expiry
@@ -264,7 +258,7 @@ sub add_page (@) { #{{{
 		# directory name or trigger ".." disallowing code.
 		$page=~s!([/.])!"__".ord($1)."__"!eg;
 		$page=$feed->{dir}."/".$page;
-		($page)=$page=~/$IkiWiki::config{wiki_file_regexp}/;
+		($page)=$page=~/$config{wiki_file_regexp}/;
 		if (! defined $page || ! length $page) {
 			$page=$feed->{dir}."/item";
 		}
@@ -274,7 +268,7 @@ sub add_page (@) { #{{{
 			$c++
 		}
 		$guid->{page}=$page;
-		IkiWiki::debug("creating new page $page");
+		debug("creating new page $page");
 	}
 	$guid->{feed}=$feed->{name};
 
@@ -284,11 +278,11 @@ sub add_page (@) { #{{{
 	eval q{use Digest::MD5 'md5_hex'};
 	require Encode;
 	my $digest=md5_hex(Encode::encode_utf8($params{content}));
-	return unless ! exists $guid->{md5} || $guid->{md5} ne $digest || $IkiWiki::config{rebuild};
+	return unless ! exists $guid->{md5} || $guid->{md5} ne $digest || $config{rebuild};
 	$guid->{md5}=$digest;
 
 	# Create the page.
-	my $template=IkiWiki::template("aggregatepost.tmpl", blind_cache => 1);
+	my $template=template("aggregatepost.tmpl", blind_cache => 1);
 	$template->param(title => $params{title})
 		if defined $params{title} && length($params{title});
 	$template->param(content => htmlescape(htmlabs($params{content}, $feed->{feedurl})));
@@ -299,7 +293,7 @@ sub add_page (@) { #{{{
 	if (ref $feed->{tags}) {
 		$template->param(tags => [map { tag => $_ }, @{$feed->{tags}}]);
 	}
-	IkiWiki::writefile(IkiWiki::htmlpage($guid->{page}), $IkiWiki::config{srcdir},
+	writefile(htmlpage($guid->{page}), $config{srcdir},
 		$template->output);
 
 	# Set the mtime, this lets the build process get the right creation
@@ -374,7 +368,7 @@ sub remove_feeds () { #{{{
 sub pagefile ($) { #{{{
 	my $page=shift;
 
-	return "$IkiWiki::config{srcdir}/".IkiWiki::htmlpage($page);
+	return "$config{srcdir}/".htmlpage($page);
 } #}}}
 
 1