* Added plugin system, currently only supporting for PreProcessorDirectives.

* Added a pagecount plugin, enabled by default.
* Support PreProcessorDirectives with no parameters, ie "[[pagecount ]]".
* Fixed/optimised backlinks code, to avoid rebuilding pages to update
  backlinks when the backlinks hadn't really changed.
* Moved inline page support, rss generation etc into the inline plugin,
  enabled by default.
* Added brokenlinks plugin, not enabled by default, but rather handy.
* Fix several broken links in the doc wiki.

diff --git a/IkiWiki/Plugin/brokenlinks.pm b/IkiWiki/Plugin/brokenlinks.pm
new file mode 100644 (file)
index 0000000..9485da3
--- /dev/null
+++ b/IkiWiki/Plugin/brokenlinks.pm
@@ -0,0 +1,39 @@
+#!/usr/bin/perl
+# Provides a list of broken links.
+package IkiWiki::Plugin::brokenlinks;
+
+use warnings;
+use strict;
+
+sub import { #{{{
+       IkiWiki::register_plugin("preprocess", "brokenlinks", \&preprocess);
+} # }}}
+
+sub preprocess (@) { #{{{
+       my %params=@_;
+       $params{pages}="*" unless defined $params{pages};
+       
+       # Needs to update whenever a page is added or removed, so
+       # register a dependency.
+       IkiWiki::add_depends($params{page}, $params{pages});
+       
+       my @broken;
+       foreach my $page (%IkiWiki::links) {
+               if (IkiWiki::globlist_match($page, $params{pages})) {
+                       foreach my $link (@{$IkiWiki::links{$page}}) {
+                               next if $link =~ /.*\/discussion/i;
+                               my $bestlink=IkiWiki::bestlink($page, $link);
+                               next if length $bestlink;
+                               push @broken,
+                                       IkiWiki::htmllink($page, $link, 1).
+                                       " in ".
+                                       IkiWiki::htmllink($params{page}, $page, 1);
+                       }
+               }
+       }
+       
+       return "There are no broken links!" unless @broken;
+       return "<ul>\n".join("\n", map { "<li>$_</li>" } sort @broken)."</ul>\n";
+} # }}}
+
+1

diff --git a/IkiWiki/Plugin/inline.pm b/IkiWiki/Plugin/inline.pm
new file mode 100644 (file)
index 0000000..53ea5bf
--- /dev/null
+++ b/IkiWiki/Plugin/inline.pm
@@ -0,0 +1,161 @@
+#!/usr/bin/perl
+# Page inlining and blogging.
+package IkiWiki::Plugin::inline;
+
+use warnings;
+use strict;
+
+sub import { #{{{
+       IkiWiki::register_plugin("preprocess", "inline", \&IkiWiki::preprocess_inline);
+} # }}}
+
+# Back to ikiwiki namespace for the rest, this code is very much
+# internal to ikiwiki even though it's separated into a plugin.
+package IkiWiki;
+       
+sub preprocess_inline (@) { #{{{
+       my %params=@_;
+
+       if (! exists $params{pages}) {
+               return "";
+       }
+       if (! exists $params{archive}) {
+               $params{archive}="no";
+       }
+       if (! exists $params{show} && $params{archive} eq "no") {
+               $params{show}=10;
+       }
+       add_depends($params{page}, $params{pages});
+
+       my $ret="";
+       
+       if (exists $params{rootpage}) {
+               # Add a blog post form, with a rss link button.
+               my $formtemplate=HTML::Template->new(blind_cache => 1,
+                       filename => "$config{templatedir}/blogpost.tmpl");
+               $formtemplate->param(cgiurl => $config{cgiurl});
+               $formtemplate->param(rootpage => $params{rootpage});
+               if ($config{rss}) {
+                       $formtemplate->param(rssurl => rsspage(basename($params{page})));
+               }
+               $ret.=$formtemplate->output;
+       }
+       elsif ($config{rss}) {
+               # Add a rss link button.
+               my $linktemplate=HTML::Template->new(blind_cache => 1,
+                       filename => "$config{templatedir}/rsslink.tmpl");
+               $linktemplate->param(rssurl => rsspage(basename($params{page})));
+               $ret.=$linktemplate->output;
+       }
+       
+       my $template=HTML::Template->new(blind_cache => 1,
+               filename => (($params{archive} eq "no") 
+                               ? "$config{templatedir}/inlinepage.tmpl"
+                               : "$config{templatedir}/inlinepagetitle.tmpl"));
+       
+       my @pages;
+       foreach my $page (blog_list($params{pages}, $params{show})) {
+               next if $page eq $params{page};
+               push @pages, $page;
+               $template->param(pagelink => htmllink($params{page}, $page));
+               $template->param(content => get_inline_content($params{page}, $page))
+                       if $params{archive} eq "no";
+               $template->param(ctime => scalar(gmtime($pagectime{$page})));
+               $ret.=$template->output;
+       }
+       
+       # TODO: should really add this to renderedfiles and call
+       # check_overwrite, but currently renderedfiles
+       # only supports listing one file per page.
+       if ($config{rss}) {
+               writefile(rsspage($params{page}), $config{destdir},
+                       genrss($params{page}, @pages));
+       }
+       
+       return $ret;
+} #}}}
+
+sub blog_list ($$) { #{{{
+       my $globlist=shift;
+       my $maxitems=shift;
+
+       my @list;
+       foreach my $page (keys %pagesources) {
+               if (globlist_match($page, $globlist)) {
+                       push @list, $page;
+               }
+       }
+
+       @list=sort { $pagectime{$b} <=> $pagectime{$a} } @list;
+       return @list if ! $maxitems || @list <= $maxitems;
+       return @list[0..$maxitems - 1];
+} #}}}
+
+sub get_inline_content ($$) { #{{{
+       my $parentpage=shift;
+       my $page=shift;
+       
+       my $file=$pagesources{$page};
+       my $type=pagetype($file);
+       if ($type ne 'unknown') {
+               return htmlize($type, linkify(readfile(srcfile($file)), $parentpage));
+       }
+       else {
+               return "";
+       }
+} #}}}
+
+sub date_822 ($) { #{{{
+       my $time=shift;
+
+       eval q{use POSIX};
+       return POSIX::strftime("%a, %d %b %Y %H:%M:%S %z", localtime($time));
+} #}}}
+
+sub absolute_urls ($$) { #{{{
+       # sucky sub because rss sucks
+       my $content=shift;
+       my $url=shift;
+
+       $url=~s/[^\/]+$//;
+       
+       $content=~s/<a\s+href="(?!http:\/\/)([^"]+)"/<a href="$url$1"/ig;
+       $content=~s/<img\s+src="(?!http:\/\/)([^"]+)"/<img src="$url$1"/ig;
+       return $content;
+} #}}}
+
+sub rsspage ($) { #{{{
+       my $page=shift;
+
+       return $page.".rss";
+} #}}}
+
+sub genrss ($@) { #{{{
+       my $page=shift;
+       my @pages=@_;
+       
+       my $url="$config{url}/".htmlpage($page);
+       
+       my $template=HTML::Template->new(blind_cache => 1,
+               filename => "$config{templatedir}/rsspage.tmpl");
+       
+       my @items;
+       foreach my $p (@pages) {
+               push @items, {
+                       itemtitle => pagetitle(basename($p)),
+                       itemurl => "$config{url}/$renderedfiles{$p}",
+                       itempubdate => date_822($pagectime{$p}),
+                       itemcontent => absolute_urls(get_inline_content($page, $p), $url),
+               } if exists $renderedfiles{$p};
+       }
+
+       $template->param(
+               title => $config{wikiname},
+               pageurl => $url,
+               items => \@items,
+       );
+       
+       return $template->output;
+} #}}}
+
+1

diff --git a/IkiWiki/Plugin/pagecount.pm b/IkiWiki/Plugin/pagecount.pm
new file mode 100644 (file)
index 0000000..865ab4c
--- /dev/null
+++ b/IkiWiki/Plugin/pagecount.pm
@@ -0,0 +1,29 @@
+#!/usr/bin/perl
+# Provides [[pagecount ]] to count the number of pages.
+package IkiWiki::Plugin::pagecount;
+
+use warnings;
+use strict;
+
+sub import { #{{{
+       IkiWiki::register_plugin("preprocess", "pagecount", \&preprocess);
+} # }}}
+
+sub preprocess (@) { #{{{
+       my %params=@_;
+       $params{pages}="*" unless defined $params{pages};
+       
+       # Needs to update count whenever a page is added or removed, so
+       # register a dependency.
+       IkiWiki::add_depends($params{page}, $params{pages});
+       
+       my @pages=keys %IkiWiki::pagesources;
+       return $#pages+1 if $params{pages} eq "*"; # optimisation
+       my $count=0;
+       foreach my $page (@pages) {
+               $count++ if IkiWiki::globlist_match($page, $params{pages});
+       }
+       return $count;
+} # }}}
+
+1

diff --git a/IkiWiki/Plugin/skeleton.pm b/IkiWiki/Plugin/skeleton.pm
new file mode 100644 (file)
index 0000000..e8d3db0
--- /dev/null
+++ b/IkiWiki/Plugin/skeleton.pm
@@ -0,0 +1,19 @@
+#!/usr/bin/perl
+# Ikiwiki skeleton plugin. Replace "skeleton" with the name of your plugin
+# in the lines below, and flesh out the methods to make it do something.
+package IkiWiki::Plugin::skeleton;
+
+use warnings;
+use strict;
+
+sub import { #{{{
+       IkiWiki::register_plugin("preprocess", "skeleton", \&preprocess);
+} # }}}
+
+sub preprocess (@) { #{{{
+       my %params=@_;
+
+       return "skeleton plugin result";
+} # }}}
+
+1

diff --git a/IkiWiki/Render.pm b/IkiWiki/Render.pm
index 3006b64d46930276de4f630b6c5d3ee83874184b..f9730193b42c26ef3cacfd1eac51cddc73d794be 100644 (file)
--- a/IkiWiki/Render.pm
+++ b/IkiWiki/Render.pm
@@ -122,18 +122,10 @@ sub parentlinks ($) { #{{{
        return @ret;
 } #}}}
 
        return @ret;
 } #}}}
 

-sub rsspage ($) { #{{{
-       my $page=shift;
-
-       return $page.".rss";
-} #}}}
-

 sub preprocess ($$) { #{{{
        my $page=shift;
        my $content=shift;
 
 sub preprocess ($$) { #{{{
        my $page=shift;
        my $content=shift;
 

-       my %commands=(inline => \&preprocess_inline);
-       

        my $handle=sub {
                my $escape=shift;
                my $command=shift;
        my $handle=sub {
                my $escape=shift;
                my $command=shift;


@@ -141,12 +133,12 @@ sub preprocess ($$) { #{{{
                if (length $escape) {
                        return "[[$command $params]]";
                }
                if (length $escape) {
                        return "[[$command $params]]";
                }

-               elsif (exists $commands{$command}) {
+               elsif (exists $plugins{preprocess}{$command}) {

                        my %params;
                        while ($params =~ /(\w+)=\"([^"]+)"(\s+|$)/g) {
                                $params{$1}=$2;
                        }
                        my %params;
                        while ($params =~ /(\w+)=\"([^"]+)"(\s+|$)/g) {
                                $params{$1}=$2;
                        }

-                       return $commands{$command}->(page => $page, %params);
+                       return $plugins{preprocess}{$command}->(page => $page, %params);

                }
                else {
                        return "[[bad directive $command]]";
                }
                else {
                        return "[[bad directive $command]]";


@@ -157,102 +149,17 @@ sub preprocess ($$) { #{{{
        return $content;
 } #}}}
 
        return $content;
 } #}}}
 

-sub blog_list ($$) { #{{{
-       my $globlist=shift;
-       my $maxitems=shift;
-       
-       my @list;
-       foreach my $page (keys %pagesources) {
-               if (globlist_match($page, $globlist)) {
-                       push @list, $page;
-               }
-       }
-
-       @list=sort { $pagectime{$b} <=> $pagectime{$a} } @list;
-       return @list if ! $maxitems || @list <= $maxitems;
-       return @list[0..$maxitems - 1];
-} #}}}
-
-sub get_inline_content ($$) { #{{{
-       my $parentpage=shift;
+sub add_depends ($$) { #{{{

        my $page=shift;
        my $page=shift;

+       my $globlist=shift;

        
        

-       my $file=$pagesources{$page};
-       my $type=pagetype($file);
-       if ($type ne 'unknown') {
-               return htmlize($type, linkify(readfile(srcfile($file)), $parentpage));
-       }
-       else {
-               return "";
-       }
-} #}}}
-
-sub preprocess_inline ($@) { #{{{
-       my %params=@_;
-       
-       if (! exists $params{pages}) {
-               return "";
-       }
-       if (! exists $params{archive}) {
-               $params{archive}="no";
-       }
-       if (! exists $params{show} && $params{archive} eq "no") {
-               $params{show}=10;
-       }
-       if (! exists $depends{$params{page}}) {
-               $depends{$params{page}}=$params{pages};
+       if (! exists $depends{$page}) {
+               $depends{$page}=$globlist;

        }
        else {
        }
        else {

-               $depends{$params{page}}.=" ".$params{pages};
-       }
-
-       my $ret="";
-       
-       if (exists $params{rootpage}) {
-               # Add a blog post form, with a rss link button.
-               my $formtemplate=HTML::Template->new(blind_cache => 1,
-                       filename => "$config{templatedir}/blogpost.tmpl");
-               $formtemplate->param(cgiurl => $config{cgiurl});
-               $formtemplate->param(rootpage => $params{rootpage});
-               if ($config{rss}) {
-                       $formtemplate->param(rssurl => rsspage(basename($params{page})));
-               }
-               $ret.=$formtemplate->output;
-       }
-       elsif ($config{rss}) {
-               # Add a rss link button.
-               my $linktemplate=HTML::Template->new(blind_cache => 1,
-                       filename => "$config{templatedir}/rsslink.tmpl");
-               $linktemplate->param(rssurl => rsspage(basename($params{page})));
-               $ret.=$linktemplate->output;
-       }
-       
-       my $template=HTML::Template->new(blind_cache => 1,
-               filename => (($params{archive} eq "no") 
-                               ? "$config{templatedir}/inlinepage.tmpl"
-                               : "$config{templatedir}/inlinepagetitle.tmpl"));
-       
-       my @pages;
-       foreach my $page (blog_list($params{pages}, $params{show})) {
-               next if $page eq $params{page};
-               push @pages, $page;
-               $template->param(pagelink => htmllink($params{page}, $page));
-               $template->param(content => get_inline_content($params{page}, $page))
-                       if $params{archive} eq "no";
-               $template->param(ctime => scalar(gmtime($pagectime{$page})));
-               $ret.=$template->output;
-       }
-       
-       # TODO: should really add this to renderedfiles and call
-       # check_overwrite, but currently renderedfiles
-       # only supports listing one file per page.
-       if ($config{rss}) {
-               writefile(rsspage($params{page}), $config{destdir},
-                       genrss($params{page}, @pages));
+               $depends{$page}.=" ".$globlist;

        }
        }

-       
-       return $ret;
-} #}}}
+} # }}}

 
 sub genpage ($$$) { #{{{
        my $content=shift;
 
 sub genpage ($$$) { #{{{
        my $content=shift;


@@ -295,53 +202,6 @@ sub genpage ($$$) { #{{{
        return $template->output;
 } #}}}
 
        return $template->output;
 } #}}}
 

-sub date_822 ($) { #{{{
-       my $time=shift;
-
-       eval q{use POSIX};
-       return POSIX::strftime("%a, %d %b %Y %H:%M:%S %z", localtime($time));
-} #}}}
-
-sub absolute_urls ($$) { #{{{
-       # sucky sub because rss sucks
-       my $content=shift;
-       my $url=shift;
-
-       $url=~s/[^\/]+$//;
-       
-       $content=~s/<a\s+href="(?!http:\/\/)([^"]+)"/<a href="$url$1"/ig;
-       $content=~s/<img\s+src="(?!http:\/\/)([^"]+)"/<img src="$url$1"/ig;
-       return $content;
-} #}}}
-
-sub genrss ($@) { #{{{
-       my $page=shift;
-       my @pages=@_;
-       
-       my $url="$config{url}/".htmlpage($page);
-       
-       my $template=HTML::Template->new(blind_cache => 1,
-               filename => "$config{templatedir}/rsspage.tmpl");
-       
-       my @items;
-       foreach my $p (@pages) {
-               push @items, {
-                       itemtitle => pagetitle(basename($p)),
-                       itemurl => "$config{url}/$renderedfiles{$p}",
-                       itempubdate => date_822($pagectime{$p}),
-                       itemcontent => absolute_urls(get_inline_content($page, $p), $url),
-               } if exists $renderedfiles{$p};
-       }
-
-       $template->param(
-               title => $config{wikiname},
-               pageurl => $url,
-               items => \@items,
-       );
-       
-       return $template->output;
-} #}}}
-

 sub check_overwrite ($$) { #{{{
        # Important security check. Make sure to call this before saving
        # any files to the source directory.
 sub check_overwrite ($$) { #{{{
        # Important security check. Make sure to call this before saving
        # any files to the source directory.


@@ -400,6 +260,7 @@ sub render ($) { #{{{
        else {
                my $content=readfile($srcfile, 1);
                $links{$file}=[];
        else {
                my $content=readfile($srcfile, 1);
                $links{$file}=[];

+               delete $depends{$file};

                check_overwrite("$config{destdir}/$file", $file);
                writefile($file, $config{destdir}, $content, 1);
                $oldpagemtime{$file}=time;
                check_overwrite("$config{destdir}/$file", $file);
                writefile($file, $config{destdir}, $content, 1);
                $oldpagemtime{$file}=time;


@@ -588,6 +449,7 @@ FILE:               foreach my $file (@files) {
                        my $p=pagename($f);
                        if (exists $depends{$p}) {
                                foreach my $file (keys %rendered, @del) {
                        my $p=pagename($f);
                        if (exists $depends{$p}) {
                                foreach my $file (keys %rendered, @del) {

+                                       next if $f eq $file;

                                        my $page=pagename($file);
                                        if (globlist_match($page, $depends{$p})) {
                                                debug("rendering $f, which depends on $page");
                                        my $page=pagename($file);
                                        if (globlist_match($page, $depends{$p})) {
                                                debug("rendering $f, which depends on $page");


@@ -606,8 +468,8 @@ FILE:               foreach my $file (@files) {
                        if (exists $links{$page}) {
                                foreach my $link (map { bestlink($page, $_) } @{$links{$page}}) {
                                        if (length $link &&
                        if (exists $links{$page}) {
                                foreach my $link (map { bestlink($page, $_) } @{$links{$page}}) {
                                        if (length $link &&

-                                           ! exists $oldlinks{$page} ||
-                                           ! grep { $_ eq $link } @{$oldlinks{$page}}) {
+                                           (! exists $oldlinks{$page} ||
+                                            ! grep { bestlink($page, $_) eq $link } @{$oldlinks{$page}})) {

                                                $linkchanged{$link}=1;
                                        }
                                }
                                                $linkchanged{$link}=1;
                                        }
                                }


@@ -615,8 +477,8 @@ FILE:               foreach my $file (@files) {
                        if (exists $oldlinks{$page}) {
                                foreach my $link (map { bestlink($page, $_) } @{$oldlinks{$page}}) {
                                        if (length $link &&
                        if (exists $oldlinks{$page}) {
                                foreach my $link (map { bestlink($page, $_) } @{$oldlinks{$page}}) {
                                        if (length $link &&

-                                           ! exists $links{$page} ||
-                                           ! grep { $_ eq $link } @{$links{$page}}) {
+                                           (! exists $links{$page} || 
+                                            ! grep { bestlink($page, $_) eq $link } @{$links{$page}})) {

                                                $linkchanged{$link}=1;
                                        }
                                }
                                                $linkchanged{$link}=1;
                                        }
                                }

diff --git a/Makefile.PL b/Makefile.PL
index 9d31dcb8b56dd1a7c49f7a7b24fd7ccfa72f6f2c..85fc075433cd2fbaa6d15856fa6573001f7080e8 100755 (executable)
--- a/Makefile.PL
+++ b/Makefile.PL
@@ -13,7 +13,9 @@ pure_install:: extra_install
 
 extra_build:
        ./ikiwiki doc html --templatedir=templates --underlaydir=basewiki \
 
 extra_build:
        ./ikiwiki doc html --templatedir=templates --underlaydir=basewiki \

-               --wikiname="ikiwiki" --verbose --nosvn --exclude=/discussion
+               --wikiname="ikiwiki" --verbose --nosvn \
+               --exclude=/discussion --plugin=brokenlinks \
+               --plugin=pagecount

        ./mdwn2man doc/usage.mdwn > ikiwiki.man
                
 extra_clean:
        ./mdwn2man doc/usage.mdwn > ikiwiki.man
                
 extra_clean:

diff --git a/basewiki/preprocessordirective.mdwn b/basewiki/preprocessordirective.mdwn
index a7d1be8c848a14519cb6c00df6121e924eb66eb6..ffa3fc7c4f7d697e214a26a1eb09f0977ea67882 100644 (file)
--- a/basewiki/preprocessordirective.mdwn
+++ b/basewiki/preprocessordirective.mdwn
@@ -6,6 +6,7 @@ contain spaces and parameters. The general form is:
 This gets expanded before the rest of the page is processed, and can be used
 to transform the page in various ways.
 
 This gets expanded before the rest of the page is processed, and can be used
 to transform the page in various ways.
 

-Currently, these preprocessor directives are available:
+Note that if a preprocessor directive has no parameters, a space still must
+be put after its name, to avoid confusion with a [[WikiLink]]. For example:

 
 

-* "inline" to make a [[blog]]
+\\[[pagecount ]]

diff --git a/debian/changelog b/debian/changelog
index 72299ec590abac5523ec7b0b721784c486ee6737..504bf0c9ab6cc77a2f5591907a4e90f16726c7ef 100644 (file)
--- a/debian/changelog
+++ b/debian/changelog
@@ -11,8 +11,17 @@ ikiwiki (1.1) UNRELEASED; urgency=low
   * Which means that more than one blog is now supported to appear on a
     single page. (With some limitations, like only the last one getting an
     rss file.)
   * Which means that more than one blog is now supported to appear on a
     single page. (With some limitations, like only the last one getting an
     rss file.)

+  * Added plugin system, currently only supporting for PreProcessorDirectives.
+  * Added a pagecount plugin, enabled by default.
+  * Support PreProcessorDirectives with no parameters, ie "[[pagecount ]]".
+  * Fixed/optimised backlinks code, to avoid rebuilding pages to update
+    backlinks when the backlinks hadn't really changed.
+  * Moved inline page support, rss generation etc into the inline plugin,
+    enabled by default.
+  * Added brokenlinks plugin, not enabled by default, but rather handy.
+  * Fix several broken links in the doc wiki.

 
 

- -- Joey Hess <joeyh@debian.org>  Mon,  1 May 2006 18:21:16 -0400
+ -- Joey Hess <joeyh@debian.org>  Mon,  1 May 2006 21:01:12 -0400

 
 ikiwiki (1.0) unstable; urgency=low
 
 
 ikiwiki (1.0) unstable; urgency=low
 

diff --git a/doc/bugs.mdwn b/doc/bugs.mdwn
index 47799676a6e3df1a0e5dc2397fa66e5e4b7debf0..c646242aaa96a20fca4b454d1472fa9cdffaf6ac 100644 (file)
--- a/doc/bugs.mdwn
+++ b/doc/bugs.mdwn
@@ -2,10 +2,11 @@
   adding/removing a page. For example, if Foo/Bar links to "Baz", which is
   Foo/Baz, and Foo/Bar/Baz gets added, it will update the links in Foo/Bar
   to point to it, but will forget to update the linkbacks in Foo/Baz.
   adding/removing a page. For example, if Foo/Bar links to "Baz", which is
   Foo/Baz, and Foo/Bar/Baz gets added, it will update the links in Foo/Bar
   to point to it, but will forget to update the linkbacks in Foo/Baz.

-  And if Foo/Bar/Baz is then removed, it forgets to update Foo/Bar to link
+  
+* And if Foo/Bar/Baz is then removed, it forgets to update Foo/Bar to link

   back to Foo/Baz.
 
   back to Foo/Baz.
 

-    -- is this still true?
+    -- is this still true? (Yes (as of 1.0))

 
 * If I try to do a web commit, to a svn+ssh repo, it fails with
   "Host key verification failed."
 
 * If I try to do a web commit, to a svn+ssh repo, it fails with
   "Host key verification failed."


@@ -31,4 +32,4 @@
   line if --cgi is set, even if it's not yet running as a cgi
 * if a page containing an rss feed happens to show up in an rss feed,
   the preprocessor directives won't be expanded (good) but are left in
   line if --cgi is set, even if it's not yet running as a cgi
 * if a page containing an rss feed happens to show up in an rss feed,
   the preprocessor directives won't be expanded (good) but are left in

-  raw rather than removed (bad)
+  raw rather than removed (bad).

diff --git a/doc/features.mdwn b/doc/features.mdwn
index a8b33a75fd6ea5fe9ace1e4fa030262e3cce5a3f..f63122edfa49726d5f5e2168c888efdabc7164b2 100644 (file)
--- a/doc/features.mdwn
+++ b/doc/features.mdwn
@@ -61,7 +61,8 @@ Some of ikiwiki's features:
 
 * [[BackLinks]]
 
 
 * [[BackLinks]]
 

-  Automatically included on pages. Rather faster than eg [[MoinMoin]] and always there to help with navigation.
+  Automatically included on pages. Rather faster than eg MoinMoin and
+  always there to help with navigation.

 
 * [[PageHistory]]
 
 
 * [[PageHistory]]
 


@@ -115,6 +116,10 @@ Some of ikiwiki's features:
   ikiwiki can be configured to send you commit mails with diffs of changes
   to selected pages.
 
   ikiwiki can be configured to send you commit mails with diffs of changes
   to selected pages.
 

+* [[Plugins]]
+
+  A plugin system allows extending ikiwiki in arbitrary ways.
+

 ----
 
 It also has some [[TODO]] items and [[Bugs]].
 ----
 
 It also has some [[TODO]] items and [[Bugs]].

diff --git a/doc/ikiwiki.setup b/doc/ikiwiki.setup
index 9775b3194931922a481301c498061086b1de2aa2..4a08e1919aff3ac1ce92225879ee805c05df3a0c 100644 (file)
--- a/doc/ikiwiki.setup
+++ b/doc/ikiwiki.setup
@@ -52,4 +52,6 @@ use IkiWiki::Setup::Standard {
        #hyperestraier => 1,
        # Sanitize html?
        sanitize => 1,
        #hyperestraier => 1,
        # Sanitize html?
        sanitize => 1,

+       # To change the enabled plugins, edit this list
+       #plugins => [qw{pagecount inline brokenlinks}],

 }
 }

diff --git a/doc/plugins.mdwn b/doc/plugins.mdwn
new file mode 100644 (file)
index 0000000..e83250f
--- /dev/null
+++ b/doc/plugins.mdwn
@@ -0,0 +1,27 @@
+Plugins can be used to add additional features to ikiwiki. It's possible to
+[[write]] your own plugins, or you can install and use plugins contributed by
+others. 
+
+The ikiiki package includes some standard plugins that are installed and
+by default. These include [[inline]], [[pagecount]], and [[brokenlinks]].
+Of these, [[inline]] is enabled by default.
+
+## Third party plugins
+
+Plugins are perl modules and should be installed somewhere in the perl
+module search path. See the @INC list at the end of the output of `perl -V`
+for a list of the directories in that path. All plugins are in the
+IkiWiki::Plugin namespace, so they go in a IkiWiki/Plugin subdirectory
+inside the perl search path. For example, if your perl looks in
+`/usr/local/lib/site_perl` for modules, you can locally install ikiwiki
+plugins to `/usr/local/lib/site_perl/IkiWiki/Plugin`
+
+Once a plugin is installed, you need to configure ikiwiki to load it using
+the `--plugin` switch described in [[usage]], or the equivilant line in
+[[ikiwiki.setup]].
+
+## Plugin directory
+
+Add your contributed plugins using this form:
+
+[[inline pages="plugins/* !plugins/write !*/Discussion" archive="yes" rootpage="plugins/contrib" show="30"]]

diff --git a/doc/plugins/brokelinks.mdwn b/doc/plugins/brokelinks.mdwn
new file mode 100644 (file)
index 0000000..05efe28
--- /dev/null
+++ b/doc/plugins/brokelinks.mdwn
@@ -0,0 +1,11 @@
+This plugin generates a list of broken links on pages in the wiki. This is
+a useful way to find pages that still need to be written, or links that
+are written wrong.
+
+The optional parameter "pages" can be a [[GlobList]] specifying the pages
+to search for broken links, default is search them all.
+
+This plugin is included in ikiwiki, but is not enabled by default.
+If it is turned on, here's a list of broken links on this wiki:
+
+[[brokenlinks ]]

diff --git a/doc/plugins/inline.mdwn b/doc/plugins/inline.mdwn
new file mode 100644 (file)
index 0000000..68f3817
--- /dev/null
+++ b/doc/plugins/inline.mdwn
@@ -0,0 +1,4 @@
+Allows including one wiki page inside another, generating blogs and RSS
+feeds. See [[blog]] for details.
+
+This plugin is enabled by default.

diff --git a/doc/plugins/pagecount.mdwn b/doc/plugins/pagecount.mdwn
new file mode 100644 (file)
index 0000000..678ac82
--- /dev/null
+++ b/doc/plugins/pagecount.mdwn
@@ -0,0 +1,11 @@
+Provides a \\[[pagecount ]] [[PreProcessorDirective]] that is replaced with
+the total number of pages currently in the wiki.
+
+The optional parameter "pages" can be a [[GlobList]] specifying the pages
+to count, default is to count them all.
+
+This plugin is included in ikiwiki, but is not enabled by default.
+
+If it is turned on it can tell us that this wiki includes
+[[pagecount ]] pages, of which [[pagecount pages="*/Discussion"]] are
+discussion pages.

diff --git a/doc/plugins/write.mdwn b/doc/plugins/write.mdwn
new file mode 100644 (file)
index 0000000..e09ca35
--- /dev/null
+++ b/doc/plugins/write.mdwn
@@ -0,0 +1,74 @@
+ikiwiki [[plugins]] are written in perl. Each plugin is a perl module, in
+the `IkiWiki::Plugin` namespace. The name of the plugin is typically in
+lowercase, such as `IkiWiki::Plugin::inline`. Ikiwiki includes a
+`IkiWiki::Plugin::skeleton` that can be fleshed out to make a useful
+plugin. `IkiWiki::Plugin::pagecount` is another simple example.
+
+## Note
+
+One thing to keep in mind when writing a plugin is that ikiwiki is a wiki
+*compiler*. So plugins influence pages when they are built, not when they
+are loaded. A plugin that inserts the current time into a page, for
+example, will insert the build time. Also, as a compiler, ikiwiki avoids
+rebuilding pages unless they have changed, so a plugin that prints some
+random or changing thing on a page will generate a static page that won't
+change until ikiwiki rebuilds the page for some other reason, like the page
+being edited.
+
+## Registering plugins
+
+Plugins should, when imported, call IkiWiki::register_plugin to hook into
+ikiwiki. The function takes four parameters:
+
+1. A method type. Use "preprocess" to register a [[PreProcessorDirective]]
+2. A command name. This is the bit that will appear inside brackets in a
+   page.
+3. A reference to a subroutine that is run when the plugin is used.
+
+## Writing a [[PreProcessorDirective]]
+
+For preprocessor commands, the subroutine is passed named parameters. A
+"page" parameter gives the name of the page that embedded the preprocessor
+command. All parameters included in the preprocessor command are included
+as named parameters as well. Whatever the subroutine returns goes onto the
+page in place of the command.
+
+## Error handing in plugins
+
+While a plugin can call ikiwiki's error routine for a fatal error, for
+errors that aren't intended to halt the entire wiki build, including bad
+parameters passed to a [[PreProcessorDirective]], etc, it's better to just
+return the error message as the output of the plugin.
+
+## Html issues
+
+Note that if [[HTMLSanitization]] is enabled, html in 
+[[PreProcessorDirective]] output is sanitised, which may limit what your
+plugin can do. Also, the rest of the page content is not in html format at
+preprocessor time.
+
+## Wiki configuration
+
+A plugin can access the wiki's configuration via the `%IkiWiki::config` hash.
+The best way to understand the contents of the hash is to look at
+[[ikiwiki.setup]], which sets the hash content to configure the wiki.
+
+## Wiki data
+
+If your plugin needs to access data about other pages in the wiki. It can
+use the following hashes, using a page name as the key:
+
+* `%IkiWiki::links` lists the names of each page
+  that is linked to from that page in an array reference.
+* `%IkiWiki::pagemtime` contains the last modification time of each page
+* `%IkiWiki::pagectime` contains the creation time of each page`
+* `%IkiWiki::renderedfiles` contains the name of the file rendered by a
+  page
+* `%IkiWiki::pagesources` contains the name of the source file for a page.
+* `%IkiWiki::depends` contains a [[GlobList]] that is used to specify other
+  pages that a page depends on. If one of its dependencies is updated, the
+  page will also get rebuilt. 
+  
+  Many plugins will need to add dependencies to this hash; the best way to do
+  it is by using the IkiWiki::add_depends function, which takes as its
+  parameters the page name and a [[GlobList]] of dependencies to add.

diff --git a/doc/post-commit.mdwn b/doc/post-commit.mdwn
index 780687563dce671c91a9f1cfc2eefc3d6c409d4a..76c8dfeac96dab892ba64e81450506ebc17282b2 100644 (file)
--- a/doc/post-commit.mdwn
+++ b/doc/post-commit.mdwn
@@ -1,7 +1,7 @@
 A post-commit hook is run every time you commit a change to your subversion repository. To make the wiki be updated each time a commit is made, it can be run from (or as) a post-commit hook.
 
 The best way to run ikiwiki in a [[Subversion]] post-commit hook is using
 A post-commit hook is run every time you commit a change to your subversion repository. To make the wiki be updated each time a commit is made, it can be run from (or as) a post-commit hook.
 
 The best way to run ikiwiki in a [[Subversion]] post-commit hook is using

-a [[wrapper]], which can be generated using `ikiwiki --wrapper`.
+a wrapper, which can be generated using `ikiwiki --wrapper`.

 
 First, set up the subversion checkout that ikiwiki will update and compile
 into your wiki at each subversion commit. Run ikiwiki a few times by hand
 
 First, set up the subversion checkout that ikiwiki will update and compile
 into your wiki at each subversion commit. Run ikiwiki a few times by hand

diff --git a/doc/security.mdwn b/doc/security.mdwn
index 766b8bee4bd6a61ecb711fa579a011e692cf2b55..77552b1b2e2d2c3abe04d273200b23412b7f9219 100644 (file)
--- a/doc/security.mdwn
+++ b/doc/security.mdwn
@@ -62,7 +62,7 @@ this wiki, BTW.
 
 ## page locking can be bypassed via direct svn commits
 
 
 ## page locking can be bypassed via direct svn commits
 

-A [[lock]]ed page can only be edited on the web by an admin, but
+A locked page can only be edited on the web by an admin, but

 anyone who is allowed to commit direct to svn can bypass this. This is by
 design, although a subversion pre-commit hook could be used to prevent
 editing of locked pages when using subversion, if you really need to.
 anyone who is allowed to commit direct to svn can bypass this. This is by
 design, although a subversion pre-commit hook could be used to prevent
 editing of locked pages when using subversion, if you really need to.

diff --git a/doc/todo.mdwn b/doc/todo.mdwn
index 764872eeaef63689fb25a0ca7f08abfb0ea62e4e..4bf9eb4c0d96671942f5331220199e8a52753f8d 100644 (file)
--- a/doc/todo.mdwn
+++ b/doc/todo.mdwn
@@ -7,9 +7,3 @@ Welcome to ikiwiki's todo list. Items are moved to [[todo/done]] when done.
 # Full list of open items:
 
 [[inline pages="todo/* !todo/done* !*/Discussion" archive="yes"]]
 # Full list of open items:
 
 [[inline pages="todo/* !todo/done* !*/Discussion" archive="yes"]]

-
-----
-
-Test:
-
-[[inline pages="news/* !*/Discussion" rootpage="news" show="30"]]

diff --git a/doc/todo/lists.mdwn b/doc/todo/lists.mdwn
index 841e3a4632e09ceb71b4864b0ffc7b23d40e7544..9330124936403aa3e794b428853e8ab312baaa33 100644 (file)
--- a/doc/todo/lists.mdwn
+++ b/doc/todo/lists.mdwn
@@ -1,7 +1,8 @@
 * list of all missing pages
 
 * list of all missing pages
 

-  Could be a [[plugin]].
+  done

 
 * list of registered users, with the names being links to any userpages.
 
 
 * list of registered users, with the names being links to any userpages.
 

-  Could be implemented with a [[preprocessordirective]], which suggests that there needs to be some sort of plugin interface for new preprocessordirectives. Although, how to let the wiki know that the page needs an update whever a new user is added?
\ No newline at end of file
+  Might be a plugin, but how to let the wiki know that the page
+  needs an update whever a new user is added?

diff --git a/doc/todo/plugin.mdwn b/doc/todo/plugin.mdwn
index 0a8a0942e096a5a723531705685c4a407712cc20..255f0ccf60dfad3284ff9763ece35c85c10a2087 100644 (file)
--- a/doc/todo/plugin.mdwn
+++ b/doc/todo/plugin.mdwn
@@ -1,5 +1,3 @@
-For one type of plugin, see [[todo/PluggableRenderers]]. 
-

 A plugin system should ideally support things like:
 
 * [[todo/lists]] of pages, of mising pages / broken links, of registered users, etc
 A plugin system should ideally support things like:
 
 * [[todo/lists]] of pages, of mising pages / broken links, of registered users, etc


@@ -11,22 +9,15 @@ A plugin system should ideally support things like:
 * would it be useful to reimplement the hyperestradier search integration as a plugin?
 * Support [[RecentChanges]] as a regular page containing a plugin that updates each time there is a change, and statically builds the recent changes list. (Would this be too expensive/inflexible? There might be other ways to do it as a plugin, like making all links to RecentChanges link to the cgi and have the cgi render it on demand.)
 * etc
 * would it be useful to reimplement the hyperestradier search integration as a plugin?
 * Support [[RecentChanges]] as a regular page containing a plugin that updates each time there is a change, and statically builds the recent changes list. (Would this be too expensive/inflexible? There might be other ways to do it as a plugin, like making all links to RecentChanges link to the cgi and have the cgi render it on demand.)
 * etc

+* For another type of plugin, see [[todo/PluggableRenderers]]. 

 
 

-Another, separate plugin system that already (mostly) exists in ikiwiki is the RCS backend, which allows writing modules to drive other RCS systems than subversion.
+Another, separate plugin system that already (mostly) exists in ikiwiki is
+the RCS backend, which allows writing modules to drive other RCS systems
+than subversion.

 
 ## preprocessor plugins
 
 
 ## preprocessor plugins
 

-Considering ikiwiki plugins, one idea I have is to make the [[PreProcessorDirective]]s be a plugin. A setting in the config file would enable various plusins, which are perl modules, that each provide one or more preprocessor directives. 
-
-Since preprocessing happens before htmlization but after a page is loaded and linkified, it should be possible to use it to create something like a link map or lists, or a page index. Page inlining and rss generation is already done via preprocessor directives and seems a natureal as a plugin too. 
-
-Note that things like a link map or a broken link list page would need to
-be updated whenever a set (or all) pages change; the %depends hash
-already allows for pages to register this, although there could be some
-strange behavior if mixing multiple directives some of which exclude pages
-that others might want to include.
-
-I need to look at the full range of things that other wikis use their plugin systems for, but preprocessor directives as plugins certianly seems useful, even if it's  not a complete solution.
+done

 
 ## case study: Moin Moin plugins
 
 
 ## case study: Moin Moin plugins
 

diff --git a/doc/usage.mdwn b/doc/usage.mdwn
index 4936039b69125b0def6c5fd1117165f5e58fe8ad..c4d1f5818627b9327e8c583a416a182fec079748 100644 (file)
--- a/doc/usage.mdwn
+++ b/doc/usage.mdwn
@@ -41,7 +41,7 @@ These options control the mode that ikiwiki is operating in.
 
 * --wrapper [file]
 
 
 * --wrapper [file]
 

-  Generate a [[wrapper]] binary that is hardcoded to do action specified by
+  Generate a wrapper binary that is hardcoded to do action specified by

   the other options, using the specified input files and `destination`
   directory. The filename to use for the wrapper is optional.
 
   the other options, using the specified input files and `destination`
   directory. The filename to use for the wrapper is optional.
 


@@ -70,13 +70,6 @@ These options configure the wiki.
 
   The name of the wiki, default is "wiki".
 
 
   The name of the wiki, default is "wiki".
 

-* --fixctime
-
-  Pull last changed time for all pages out of the revision control system.
-  This rarely used option provides a way to get the real creation times of
-  items in weblogs, for example when building a wiki from a new subversion
-  checkout. It is unoptimised and quite slow.
-

 * --templatedir
 
   Specify the directory that the page [[templates]] are stored in.
 * --templatedir
 
   Specify the directory that the page [[templates]] are stored in.


@@ -129,7 +122,7 @@ These options configure the wiki.
 * --rss, --norss
 
   If rss is set, ikiwiki will generate rss feeds for pages that inline
 * --rss, --norss
 
   If rss is set, ikiwiki will generate rss feeds for pages that inline

-  a blog.
+  a [[blog]].

 
 * --url http://url/
 
 
 * --url http://url/
 


@@ -137,7 +130,8 @@ These options configure the wiki.
 
 * --cgiurl http://url/ikiwiki.cgi
 
 
 * --cgiurl http://url/ikiwiki.cgi
 

-  Specifies the url to the ikiwiki [[CGI]] script [[wrapper]]. Required when building the wiki for links to the cgi script to be generated.
+  Specifies the url to the ikiwiki [[CGI]] script wrapper. Required when
+  building the wiki for links to the cgi script to be generated.

 
 * --historyurl http://url/trunk/\[[file]]?root=wiki
 
 
 * --historyurl http://url/trunk/\[[file]]?root=wiki
 


@@ -172,6 +166,11 @@ These options configure the wiki.
   Enable [[HtmlSanitization]] of wiki content. On by default, disable with
   --no-sanitize.
 
   Enable [[HtmlSanitization]] of wiki content. On by default, disable with
   --no-sanitize.
 

+* --plugin name
+
+  Enables the use of the specified plugin in the wiki. See [[plugins]] for
+  details. Note that plugin names are case sensative.
+

 * --hyperestraier
 
   Enables use of the [[HyperEstraier]] search engine for full test page
 * --hyperestraier
 
   Enables use of the [[HyperEstraier]] search engine for full test page


@@ -179,7 +178,14 @@ These options configure the wiki.
 
 * --verbose
 
 
 * --verbose
 

-  Be vebose about what it's doing.
+  Be vebose about what is being done.
+
+* --fixctime
+
+  Pull last changed time for all pages out of the revision control system.
+  This rarely used option provides a way to get the real creation times of
+  items in weblogs, for example when building a wiki from a new subversion
+  checkout. It is unoptimised and quite slow.

 
 # AUTHOR
 
 
 # AUTHOR
 

diff --git a/ikiwiki b/ikiwiki
index dfb484f6402cc15fba20f577d6be57e57a9dd7fa..6c42a7e5d8037f173e6a3660e1475f614a29618f 100755 (executable)
--- a/ikiwiki
+++ b/ikiwiki
@@ -9,7 +9,7 @@ use HTML::Template;
 use lib '.'; # For use without installation, removed by Makefile.
 
 use vars qw{%config %links %oldlinks %oldpagemtime %pagectime
 use lib '.'; # For use without installation, removed by Makefile.
 
 use vars qw{%config %links %oldlinks %oldpagemtime %pagectime

-            %renderedfiles %pagesources %depends};
+            %renderedfiles %pagesources %depends %plugins};

 
 sub usage () { #{{{
        die "usage: ikiwiki [options] source dest\n";
 
 sub usage () { #{{{
        die "usage: ikiwiki [options] source dest\n";


@@ -20,7 +20,7 @@ sub getconfig () { #{{{
                %config=(
                        wiki_file_prune_regexp => qr{((^|/).svn/|\.\.|^\.|\/\.|\.html?$|\.rss$)},
                        wiki_link_regexp => qr/\[\[(?:([^\s\]\|]+)\|)?([^\s\]]+)\]\]/,
                %config=(
                        wiki_file_prune_regexp => qr{((^|/).svn/|\.\.|^\.|\/\.|\.html?$|\.rss$)},
                        wiki_link_regexp => qr/\[\[(?:([^\s\]\|]+)\|)?([^\s\]]+)\]\]/,

-                       wiki_processor_regexp => qr/\[\[(\w+)\s+([^\]]+)\]\]/,
+                       wiki_processor_regexp => qr/\[\[(\w+)\s+([^\]]*)\]\]/,

                        wiki_file_regexp => qr/(^[-[:alnum:]_.:\/+]+$)/,
                        verbose => 0,
                        wikiname => "wiki",
                        wiki_file_regexp => qr/(^[-[:alnum:]_.:\/+]+$)/,
                        verbose => 0,
                        wikiname => "wiki",


@@ -50,6 +50,7 @@ sub getconfig () { #{{{
                        setup => undef,
                        adminuser => undef,
                        adminemail => undef,
                        setup => undef,
                        adminuser => undef,
                        adminemail => undef,

+                       plugin => [qw{inline}],

                );
 
                eval q{use Getopt::Long};
                );
 
                eval q{use Getopt::Long};


@@ -90,6 +91,9 @@ sub getconfig () { #{{{
                        "wrapper:s" => sub {
                                $config{wrapper}=$_[1] ? $_[1] : "ikiwiki-wrap"
                        },
                        "wrapper:s" => sub {
                                $config{wrapper}=$_[1] ? $_[1] : "ikiwiki-wrap"
                        },

+                       "plugin=s@" => sub {
+                               push @{$config{plugin}}, $_[1];
+                       }

                ) || usage();
 
                if (! $config{setup}) {
                ) || usage();
 
                if (! $config{setup}) {


@@ -129,6 +133,14 @@ sub checkconfig () { #{{{
                require IkiWiki::Rcs::Stub;
                $config{rcs}=0;
        }
                require IkiWiki::Rcs::Stub;
                $config{rcs}=0;
        }

+
+       foreach my $plugin (@{$config{plugin}}) {
+               $plugin="IkiWiki::Plugin::".possibly_foolish_untaint($plugin);
+               eval qq{use $plugin};
+               if ($@) {
+                       error("Failed to load plugin $plugin: $@");
+               }
+       }

 } #}}}
 
 sub error ($) { #{{{
 } #}}}
 
 sub error ($) { #{{{


@@ -476,6 +488,14 @@ sub globlist_match ($$) { #{{{
        return 0;
 } #}}}
 
        return 0;
 } #}}}
 

+sub register_plugin ($$$) { # {{{
+       my $type=shift;
+       my $command=shift;
+       my $function=shift;
+       
+       $plugins{$type}{$command}=$function;
+} # }}}
+

 sub main () { #{{{
        getconfig();
        
 sub main () { #{{{
        getconfig();