Split apache404 into an independent plugin

Also make it ignore the 'do' parameter at Joey's suggestion, to have one
less thing to remember when configuring.

diff --git a/IkiWiki/CGI.pm b/IkiWiki/CGI.pm
index 8734cdd494ece0d4f1a2229d0bed37542519495e..e75ebcd27652fb6a2a1c6317afd6b9ab99332930 100644 (file)
--- a/IkiWiki/CGI.pm
+++ b/IkiWiki/CGI.pm
@@ -338,46 +338,6 @@ sub cgi_goto ($;$) {
        exit;
 }
 
-sub cgi_page_from_404 ($$$) {
-       my $path = shift;
-       my $baseurl = shift;
-       my $usedirs = shift;
-
-       # fail if missing from environment or whatever
-       return undef unless defined $path;
-       return undef unless defined $baseurl;
-
-       # with usedirs on, path is like /~fred/foo/bar/ or /~fred/foo/bar or
-       #    /~fred/foo/bar/index.html
-       # with usedirs off, path is like /~fred/foo/bar.html
-       # baseurl is like 'http://people.example.com/~fred'
-
-       # convert baseurl to ~fred
-       unless ($baseurl =~ s{^https?://[^/]+/?}{}) {
-               return undef;
-       }
-
-       # convert path to /~fred/foo/bar
-       if ($usedirs) {
-               $path =~ s/\/*(?:index\.$config{htmlext})?$//;
-       }
-       else {
-               $path =~ s/\.$config{htmlext}$//;
-       }
-
-       # remove /~fred/
-       unless ($path =~ s{^/*\Q$baseurl\E/*}{}) {
-               return undef;
-       }
-
-       # special case for the index
-       unless ($path) {
-               return 'index';
-       }
-
-       return $path;
-}
-
 sub cgi (;$$) {
        my $q=shift;
        my $session=shift;
@@ -409,14 +369,7 @@ sub cgi (;$$) {
        # commenter are for compatibility with any saved URLs
        if ($do eq 'goto' || $do eq 'recentchanges_link' ||
            $do eq 'commenter') {
-               my $page = undef;
-
-               if ($ENV{REDIRECT_STATUS} eq '404') {
-                       $page = cgi_page_from_404($ENV{REDIRECT_URL},
-                               $config{url}, $config{usedirs});
-               }
-
-               cgi_goto($q, $page);
+               cgi_goto($q);
        }
 
        # Need to lock the wiki before getting a session.

diff --git a/IkiWiki/Plugin/apache404.pm b/IkiWiki/Plugin/apache404.pm
new file mode 100644 (file)
index 0000000..3ac6b3a
--- /dev/null
+++ b/IkiWiki/Plugin/apache404.pm
@@ -0,0 +1,76 @@
+#!/usr/bin/perl
+# Copyright © 2009 Simon McVittie <http://smcv.pseudorandom.co.uk/>
+# Licensed under the GNU GPL, version 2, or any later version published by the
+# Free Software Foundation
+package IkiWiki::Plugin::apache404;
+
+use warnings;
+use strict;
+use IkiWiki 3.00;
+
+sub import {
+       hook(type => "cgi", id => 'apache404',  call => \&cgi);
+}
+
+sub getsetup () {
+       return
+               plugin => {
+                       # not really a matter of safety, but enabling/disabling
+                       # through a web interface is useless - it needs web
+                       # server admin action too
+                       safe => 0,
+                       rebuild => 0,
+               }
+}
+
+sub cgi_page_from_404 ($$$) {
+       my $path = shift;
+       my $baseurl = shift;
+       my $usedirs = shift;
+
+       # fail if missing from environment or whatever
+       return undef unless defined $path;
+       return undef unless defined $baseurl;
+
+       # with usedirs on, path is like /~fred/foo/bar/ or /~fred/foo/bar or
+       #    /~fred/foo/bar/index.html
+       # with usedirs off, path is like /~fred/foo/bar.html
+       # baseurl is like 'http://people.example.com/~fred'
+
+       # convert baseurl to ~fred
+       unless ($baseurl =~ s{^https?://[^/]+/?}{}) {
+               return undef;
+       }
+
+       # convert path to /~fred/foo/bar
+       if ($usedirs) {
+               $path =~ s/\/*(?:index\.$config{htmlext})?$//;
+       }
+       else {
+               $path =~ s/\.$config{htmlext}$//;
+       }
+
+       # remove /~fred/
+       unless ($path =~ s{^/*\Q$baseurl\E/*}{}) {
+               return undef;
+       }
+
+       # special case for the index
+       unless ($path) {
+               return 'index';
+       }
+
+       return $path;
+}
+
+sub cgi ($) {
+       my $cgi=shift;
+
+       if ($ENV{REDIRECT_STATUS} eq '404') {
+               my $page = cgi_page_from_404($ENV{REDIRECT_URL},
+                       $config{url}, $config{usedirs});
+               IkiWiki::cgi_goto($cgi, $page);
+       }
+}
+
+1;

diff --git a/doc/plugins/apache404.mdwn b/doc/plugins/apache404.mdwn
new file mode 100644 (file)
index 0000000..bab8fb5
--- /dev/null
+++ b/doc/plugins/apache404.mdwn
@@ -0,0 +1,11 @@
+[[!template id=plugin name=apache404 author="[[Simon_McVittie|smcv]]"]]
+[[!tag type/useful]]
+
+This plugin lets you use the IkiWiki CGI script as an Apache 404 handler,
+to give the behaviour of various other wiki engines where visiting a
+nonexistent page provides you with a link to create it.
+
+To achieve this, put something like this in the wiki's Apache configuration
+file:
+
+    ErrorDocument 404 /cgi-bin/ikiwiki.cgi

diff --git a/doc/tips/apache_404_handler.mdwn b/doc/tips/apache_404_handler.mdwn
deleted file mode 100644 (file)
index 0fda759..0000000
--- a/doc/tips/apache_404_handler.mdwn
+++ /dev/null
@@ -1,10 +0,0 @@
-[[!meta title="Apache 404 handler"]]
-
-Sufficiently recent versions of IkiWiki can be used as an Apache 404 handler,
-to give the behaviour of various other wiki engines where visiting a
-nonexistent page provides you with a link to create it.
-
-To achieve this, put something like this in the wiki's Apache configuration
-file:
-
-    ErrorDocument 404 /cgi-bin/ikiwiki.cgi?do=goto

diff --git a/t/apache404.t b/t/apache404.t
new file mode 100755 (executable)
index 0000000..00fc352
--- /dev/null
+++ b/t/apache404.t
@@ -0,0 +1,45 @@
+#!/usr/bin/perl
+use warnings;
+use strict;
+use Test::More tests => 17;
+
+BEGIN { use_ok("IkiWiki::Plugin::apache404"); }
+
+sub cgi_page_from_404 {
+       return IkiWiki::Plugin::apache404::cgi_page_from_404(shift, shift,
+                                                            shift);
+}
+
+$IkiWiki::config{htmlext} = 'html';
+
+is(cgi_page_from_404('/', 'http://example.com', 1), 'index');
+is(cgi_page_from_404('/index.html', 'http://example.com', 0), 'index');
+is(cgi_page_from_404('/', 'http://example.com/', 1), 'index');
+is(cgi_page_from_404('/index.html', 'http://example.com/', 0), 'index');
+
+is(cgi_page_from_404('/~user/foo/bar', 'http://example.com/~user', 1),
+   'foo/bar');
+is(cgi_page_from_404('/~user/foo/bar/index.html', 'http://example.com/~user', 1),
+   'foo/bar');
+is(cgi_page_from_404('/~user/foo/bar/', 'http://example.com/~user', 1),
+   'foo/bar');
+is(cgi_page_from_404('/~user/foo/bar.html', 'http://example.com/~user', 0),
+   'foo/bar');
+
+is(cgi_page_from_404('/~user/foo/bar', 'http://example.com/~user/', 1),
+   'foo/bar');
+is(cgi_page_from_404('/~user/foo/bar/index.html', 'http://example.com/~user/', 1),
+   'foo/bar');
+is(cgi_page_from_404('/~user/foo/bar/', 'http://example.com/~user/', 1),
+   'foo/bar');
+is(cgi_page_from_404('/~user/foo/bar.html', 'http://example.com/~user/', 0),
+   'foo/bar');
+
+is(cgi_page_from_404('/~user/foo', 'https://example.com/~user', 1),
+   'foo');
+is(cgi_page_from_404('/~user/foo/index.html', 'https://example.com/~user', 1),
+   'foo');
+is(cgi_page_from_404('/~user/foo/', 'https://example.com/~user', 1),
+   'foo');
+is(cgi_page_from_404('/~user/foo.html', 'https://example.com/~user', 0),
+   'foo');

diff --git a/t/cgi_page_from_404.t b/t/cgi_page_from_404.t
deleted file mode 100755 (executable)
index adbbdf8..0000000
--- a/t/cgi_page_from_404.t
+++ /dev/null
@@ -1,43 +0,0 @@
-#!/usr/bin/perl
-use warnings;
-use strict;
-use Test::More tests => 18;
-
-BEGIN { use_ok("IkiWiki"); }
-BEGIN { use_ok("IkiWiki::CGI"); }
-
-sub cgi_page_from_404 { return IkiWiki::cgi_page_from_404(shift, shift, shift); }
-
-$IkiWiki::config{htmlext} = 'html';
-
-is(cgi_page_from_404('/', 'http://example.com', 1), 'index');
-is(cgi_page_from_404('/index.html', 'http://example.com', 0), 'index');
-is(cgi_page_from_404('/', 'http://example.com/', 1), 'index');
-is(cgi_page_from_404('/index.html', 'http://example.com/', 0), 'index');
-
-is(cgi_page_from_404('/~user/foo/bar', 'http://example.com/~user', 1),
-   'foo/bar');
-is(cgi_page_from_404('/~user/foo/bar/index.html', 'http://example.com/~user', 1),
-   'foo/bar');
-is(cgi_page_from_404('/~user/foo/bar/', 'http://example.com/~user', 1),
-   'foo/bar');
-is(cgi_page_from_404('/~user/foo/bar.html', 'http://example.com/~user', 0),
-   'foo/bar');
-
-is(cgi_page_from_404('/~user/foo/bar', 'http://example.com/~user/', 1),
-   'foo/bar');
-is(cgi_page_from_404('/~user/foo/bar/index.html', 'http://example.com/~user/', 1),
-   'foo/bar');
-is(cgi_page_from_404('/~user/foo/bar/', 'http://example.com/~user/', 1),
-   'foo/bar');
-is(cgi_page_from_404('/~user/foo/bar.html', 'http://example.com/~user/', 0),
-   'foo/bar');
-
-is(cgi_page_from_404('/~user/foo', 'https://example.com/~user', 1),
-   'foo');
-is(cgi_page_from_404('/~user/foo/index.html', 'https://example.com/~user', 1),
-   'foo');
-is(cgi_page_from_404('/~user/foo/', 'https://example.com/~user', 1),
-   'foo');
-is(cgi_page_from_404('/~user/foo.html', 'https://example.com/~user', 0),
-   'foo');