From 5541b06de43c70ca9c23231d175d474789dacd25 Mon Sep 17 00:00:00 2001
From: Joey Hess <joey@gnu.kitenet.net>
Date: Fri, 5 Feb 2010 15:22:02 -0500
Subject: response

---
 IkiWiki/Plugin/httpauth.pm | 14 +++++++++++++-
 1 file changed, 13 insertions(+), 1 deletion(-)

(limited to 'IkiWiki/Plugin/httpauth.pm')

diff --git a/IkiWiki/Plugin/httpauth.pm b/IkiWiki/Plugin/httpauth.pm
index 127c321f0..c1811643b 100644
--- a/IkiWiki/Plugin/httpauth.pm
+++ b/IkiWiki/Plugin/httpauth.pm
@@ -9,6 +9,8 @@ use IkiWiki 3.00;
 sub import {
 	hook(type => "getsetup", id => "httpauth", call => \&getsetup);
 	hook(type => "auth", id => "httpauth", call => \&auth);
+	hook(type => "canedit", id => "httpauth", call => \&canedit,
+		last => 1);
 }
 
 sub getsetup () {
@@ -33,10 +35,20 @@ sub auth ($$) {
 	if (defined $cgi->remote_user()) {
 		$session->param("name", $cgi->remote_user());
 	}
-	elsif (defined $config{cgiauthurl}) {
+}
+
+sub canedit ($$$) {
+	my $page=shift;
+	my $cgi=shift;
+	my $session=shift;
+
+	if (! defined $cgi->remote_user() && defined $config{cgiauthurl}) {
 		IkiWiki::redirect($cgi, $config{cgiauthurl}.'?'.$cgi->query_string());
 		exit;
 	}
+	else {
+		return undef;
+	}
 }
 
 1
-- 
cgit v1.2.3


From 1af8db763b76856a3f8fb4d79333b19ef5083637 Mon Sep 17 00:00:00 2001
From: Joey Hess <joey@gnu.kitenet.net>
Date: Fri, 5 Feb 2010 23:06:29 -0500
Subject: revert accidental code change

---
 IkiWiki/Plugin/httpauth.pm | 14 +-------------
 1 file changed, 1 insertion(+), 13 deletions(-)

(limited to 'IkiWiki/Plugin/httpauth.pm')

diff --git a/IkiWiki/Plugin/httpauth.pm b/IkiWiki/Plugin/httpauth.pm
index c1811643b..127c321f0 100644
--- a/IkiWiki/Plugin/httpauth.pm
+++ b/IkiWiki/Plugin/httpauth.pm
@@ -9,8 +9,6 @@ use IkiWiki 3.00;
 sub import {
 	hook(type => "getsetup", id => "httpauth", call => \&getsetup);
 	hook(type => "auth", id => "httpauth", call => \&auth);
-	hook(type => "canedit", id => "httpauth", call => \&canedit,
-		last => 1);
 }
 
 sub getsetup () {
@@ -35,20 +33,10 @@ sub auth ($$) {
 	if (defined $cgi->remote_user()) {
 		$session->param("name", $cgi->remote_user());
 	}
-}
-
-sub canedit ($$$) {
-	my $page=shift;
-	my $cgi=shift;
-	my $session=shift;
-
-	if (! defined $cgi->remote_user() && defined $config{cgiauthurl}) {
+	elsif (defined $config{cgiauthurl}) {
 		IkiWiki::redirect($cgi, $config{cgiauthurl}.'?'.$cgi->query_string());
 		exit;
 	}
-	else {
-		return undef;
-	}
 }
 
 1
-- 
cgit v1.2.3


From f2d6d4f6b24bb399481c40dc6eb6f3fe25190c5d Mon Sep 17 00:00:00 2001
From: Joey Hess <joey@gnu.kitenet.net>
Date: Thu, 11 Feb 2010 16:36:19 -0500
Subject: patch so far

---
 IkiWiki/Plugin/httpauth.pm | 20 +++++++++++++++++---
 1 file changed, 17 insertions(+), 3 deletions(-)

(limited to 'IkiWiki/Plugin/httpauth.pm')

diff --git a/IkiWiki/Plugin/httpauth.pm b/IkiWiki/Plugin/httpauth.pm
index 127c321f0..a18f8ca54 100644
--- a/IkiWiki/Plugin/httpauth.pm
+++ b/IkiWiki/Plugin/httpauth.pm
@@ -9,6 +9,8 @@ use IkiWiki 3.00;
 sub import {
 	hook(type => "getsetup", id => "httpauth", call => \&getsetup);
 	hook(type => "auth", id => "httpauth", call => \&auth);
+	hook(type => "canedit", id => "httpauth", call => \&canedit,
+		last => 1);
 }
 
 sub getsetup () {
@@ -33,9 +35,21 @@ sub auth ($$) {
 	if (defined $cgi->remote_user()) {
 		$session->param("name", $cgi->remote_user());
 	}
-	elsif (defined $config{cgiauthurl}) {
-		IkiWiki::redirect($cgi, $config{cgiauthurl}.'?'.$cgi->query_string());
-		exit;
+}
+
+sub canedit ($$$) {
+	my $page=shift;
+	my $cgi=shift;
+	my $session=shift;
+
+	if (! defined $cgi->remote_user() && defined $config{cgiauthurl}) {
+		return sub {
+			IkiWiki::redirect($cgi, $config{cgiauthurl}.'?'.$cgi->query_string());
+			exit;
+		};
+	}
+	else {
+		return undef;
 	}
 }
 
-- 
cgit v1.2.3


From 046095552ac231366d71a3c7a84bdc6d46662212 Mon Sep 17 00:00:00 2001
From: Joey Hess <joey@gnu.kitenet.net>
Date: Thu, 11 Feb 2010 17:26:09 -0500
Subject: httpauth: When cgiauthurl is configured, httpauth can now be used
 alongside other authentication methods (like openid or anonok). Rather than
 always redirect to the cgiauthurl for authentication, there is now a button
 on the login form to use it.

---
 IkiWiki/Plugin/httpauth.pm        | 35 +++++++++++++++++++++++++++++++----
 IkiWiki/Plugin/openid.pm          |  2 +-
 debian/changelog                  |  4 ++++
 doc/bugs/anonok_vs._httpauth.mdwn |  2 ++
 doc/plugins/httpauth.mdwn         |  9 +++++----
 5 files changed, 43 insertions(+), 9 deletions(-)

(limited to 'IkiWiki/Plugin/httpauth.pm')

diff --git a/IkiWiki/Plugin/httpauth.pm b/IkiWiki/Plugin/httpauth.pm
index a18f8ca54..d0d4da0b7 100644
--- a/IkiWiki/Plugin/httpauth.pm
+++ b/IkiWiki/Plugin/httpauth.pm
@@ -11,6 +11,8 @@ sub import {
 	hook(type => "auth", id => "httpauth", call => \&auth);
 	hook(type => "canedit", id => "httpauth", call => \&canedit,
 		last => 1);
+	hook(type => "formbuilder_setup", id => "httpauth",
+		call => \&formbuilder_setup);
 }
 
 sub getsetup () {
@@ -27,6 +29,14 @@ sub getsetup () {
 			rebuild => 0,
 		},
 }
+			
+sub redir_cgiauthurl ($$) {
+	my $cgi=shift;
+	my $params=shift;
+
+	IkiWiki::redirect($cgi, $config{cgiauthurl}.'?'.$params);
+	exit;
+}
 
 sub auth ($$) {
 	my $cgi=shift;
@@ -43,14 +53,31 @@ sub canedit ($$$) {
 	my $session=shift;
 
 	if (! defined $cgi->remote_user() && defined $config{cgiauthurl}) {
-		return sub {
-			IkiWiki::redirect($cgi, $config{cgiauthurl}.'?'.$cgi->query_string());
-			exit;
-		};
+		return sub { redir_cgiauthurl($cgi, $cgi->query_string()) };
 	}
 	else {
 		return undef;
 	}
 }
 
+sub formbuilder_setup (@) {
+	my %params=@_;
+
+	my $form=$params{form};
+	my $session=$params{session};
+	my $cgi=$params{cgi};
+	my $buttons=$params{buttons};
+
+	if ($form->title eq "signin" &&
+	    ! defined $cgi->remote_user() && defined $config{cgiauthurl}) {
+		my $button_text="Login with HTTP auth";
+		push @$buttons, $button_text;
+
+		if ($form->submitted && $form->submitted eq $button_text) {
+			redir_cgiauthurl($cgi, "do=postsignin");
+			exit;
+		}
+	}
+}
+
 1
diff --git a/IkiWiki/Plugin/openid.pm b/IkiWiki/Plugin/openid.pm
index b60740c0e..382d8286f 100644
--- a/IkiWiki/Plugin/openid.pm
+++ b/IkiWiki/Plugin/openid.pm
@@ -56,7 +56,7 @@ sub formbuilder_setup (@) {
 		# OpenID fieldset.
 		$form->fieldsets("OpenID");
 
- 		$form->field(
+		$form->field(
 			name => "openid_url",
 			label => gettext("Log in with")." ".htmllink("", "", "ikiwiki/OpenID", noimageinline => 1),
 			fieldset => "OpenID",
diff --git a/debian/changelog b/debian/changelog
index 358a5dc5c..3dd68558e 100644
--- a/debian/changelog
+++ b/debian/changelog
@@ -15,6 +15,10 @@ ikiwiki (3.20100123) UNRELEASED; urgency=low
   * Fix color and format plugins to appear in the websetup interface.
   * amazon_s3: Fix to support the EU S3 datacenter, which is more picky
     about attempts to create already existing buckets.
+  * httpauth: When cgiauthurl is configured, httpauth can now be used
+    alongside other authentication methods (like openid or anonok). Rather
+    than always redirect to the cgiauthurl for authentication, there is now
+    a button on the login form to use it.
 
  -- Joey Hess <joeyh@debian.org>  Tue, 26 Jan 2010 22:25:33 -0500
 
diff --git a/doc/bugs/anonok_vs._httpauth.mdwn b/doc/bugs/anonok_vs._httpauth.mdwn
index b738e3b6c..bff37e18b 100644
--- a/doc/bugs/anonok_vs._httpauth.mdwn
+++ b/doc/bugs/anonok_vs._httpauth.mdwn
@@ -114,3 +114,5 @@ index 127c321..a18f8ca 100644
 >> time that httpauth is redirecting to the cgiauthurl. As mentioned above,
 >> the only way to deal with that would be to add a link to the signin page
 >> that does the httpauth signin. --[[Joey]] 
+
+>>> That's dealt with in final version. [[done]] --[[Joey]] 
diff --git a/doc/plugins/httpauth.mdwn b/doc/plugins/httpauth.mdwn
index 77796a3d7..a7aac558b 100644
--- a/doc/plugins/httpauth.mdwn
+++ b/doc/plugins/httpauth.mdwn
@@ -14,10 +14,11 @@ signed into the wiki. This method is suitable only for private wikis.
 ## separate cgiauthurl
 
 To use httpauth for a wiki where the content is public, and where
-the `ikiwiki.cgi` needs to be usable without authentication (for searching
-and so on), you can configure a separate url that is used for
-authentication, via the `cgiauthurl` option in the setup file. This
-url will then be redirected to whenever authentication is needed.
+the `ikiwiki.cgi` needs to be usable without authentication (for searching,
+or logging in using other methods, and so on), you can configure a separate
+url that is used for authentication, via the `cgiauthurl` option in the setup
+file. This url will then be redirected to when a user chooses to log in using
+httpauth.
 
 A typical setup is to make an `auth` subdirectory, and symlink `ikiwiki.cgi` 
 into it. Then configure the web server to require authentication only for
-- 
cgit v1.2.3


From e11876b7003c700fbc3717ca9c5af5aac3b72ac2 Mon Sep 17 00:00:00 2001
From: Joey Hess <joey@gnu.kitenet.net>
Date: Thu, 11 Feb 2010 18:25:10 -0500
Subject: httpauth: Add httpauth_pagespec setting that can be used to limit
 pages to only being edited via users authed with httpauth.

---
 IkiWiki.pm                 |  7 ++++-
 IkiWiki/Plugin/httpauth.pm | 75 +++++++++++++++++++++++++++++++++-------------
 debian/changelog           |  2 ++
 doc/plugins/httpauth.mdwn  |  9 ++++++
 4 files changed, 72 insertions(+), 21 deletions(-)

(limited to 'IkiWiki/Plugin/httpauth.pm')

diff --git a/IkiWiki.pm b/IkiWiki.pm
index 2a0132745..de7dbfc79 100644
--- a/IkiWiki.pm
+++ b/IkiWiki.pm
@@ -941,7 +941,12 @@ sub linkpage ($) {
 sub cgiurl (@) {
 	my %params=@_;
 
-	return $config{cgiurl}."?".
+	my $cgiurl=$config{cgiurl};
+	if (exists $params{cgiurl}) {
+		$cgiurl=$params{cgiurl};
+		delete $params{cgiurl};
+	}
+	return $cgiurl."?".
 		join("&amp;", map $_."=".uri_escape_utf8($params{$_}), keys %params);
 }
 
diff --git a/IkiWiki/Plugin/httpauth.pm b/IkiWiki/Plugin/httpauth.pm
index d0d4da0b7..202ca1153 100644
--- a/IkiWiki/Plugin/httpauth.pm
+++ b/IkiWiki/Plugin/httpauth.pm
@@ -9,10 +9,10 @@ use IkiWiki 3.00;
 sub import {
 	hook(type => "getsetup", id => "httpauth", call => \&getsetup);
 	hook(type => "auth", id => "httpauth", call => \&auth);
-	hook(type => "canedit", id => "httpauth", call => \&canedit,
-		last => 1);
 	hook(type => "formbuilder_setup", id => "httpauth",
 		call => \&formbuilder_setup);
+	hook(type => "canedit", id => "httpauth", call => \&canedit);
+	hook(type => "pagetemplate", id => "httpauth", call => \&pagetemplate);
 }
 
 sub getsetup () {
@@ -28,13 +28,20 @@ sub getsetup () {
 			safe => 1,
 			rebuild => 0,
 		},
+		httpauth_pagespec => {
+			type => "pagespec",
+			example => "!*/Discussion",
+			description => "PageSpec of pages where only httpauth will be used for authentication",
+			safe => 0,
+			rebuild => 0,
+		},
 }
 			
-sub redir_cgiauthurl ($$) {
+sub redir_cgiauthurl ($;@) {
 	my $cgi=shift;
-	my $params=shift;
 
-	IkiWiki::redirect($cgi, $config{cgiauthurl}.'?'.$params);
+	IkiWiki::redirect($cgi, 
+		IkiWiki::cgiurl(cgiurl => $config{cgiauthurl}, @_));
 	exit;
 }
 
@@ -47,19 +54,6 @@ sub auth ($$) {
 	}
 }
 
-sub canedit ($$$) {
-	my $page=shift;
-	my $cgi=shift;
-	my $session=shift;
-
-	if (! defined $cgi->remote_user() && defined $config{cgiauthurl}) {
-		return sub { redir_cgiauthurl($cgi, $cgi->query_string()) };
-	}
-	else {
-		return undef;
-	}
-}
-
 sub formbuilder_setup (@) {
 	my %params=@_;
 
@@ -74,10 +68,51 @@ sub formbuilder_setup (@) {
 		push @$buttons, $button_text;
 
 		if ($form->submitted && $form->submitted eq $button_text) {
-			redir_cgiauthurl($cgi, "do=postsignin");
-			exit;
+			# bounce thru cgiauthurl and then back to
+			# the stored postsignin action
+			redir_cgiauthurl($cgi, do => "postsignin");
 		}
 	}
 }
 
+sub test_httpauth_pagespec ($) {
+	my $page=shift;
+
+	return defined $config{httpauth_pagespec} &&
+	       length $config{httpauth_pagespec} &&
+	       defined $config{cgiauthurl} &&
+	       pagespec_match($page, $config{httpauth_pagespec});
+}
+
+sub canedit ($$$) {
+	my $page=shift;
+	my $cgi=shift;
+	my $session=shift;
+
+	if (! defined $cgi->remote_user() && test_httpauth_pagespec($page)) {
+		return sub {
+			IkiWiki::redirect($cgi, 
+				$config{cgiauthurl}.'?'.$cgi->query_string());
+			exit;
+		};
+	}
+	else {
+		return undef;
+	}
+}
+
+sub pagetemplate (@_) {
+	my %params=@_;
+	my $template=$params{template};
+
+	if ($template->param("editurl") &&
+	    test_httpauth_pagespec($params{page})) {
+		# go directly to cgiauthurl when editing a page matching
+		# the pagespec
+		$template->param(editurl => IkiWiki::cgiurl(
+			cgiurl => $config{cgiauthurl},
+			do => "edit", page => $params{page}));
+	}
+}
+
 1
diff --git a/debian/changelog b/debian/changelog
index 3dd68558e..14be7ec69 100644
--- a/debian/changelog
+++ b/debian/changelog
@@ -19,6 +19,8 @@ ikiwiki (3.20100123) UNRELEASED; urgency=low
     alongside other authentication methods (like openid or anonok). Rather
     than always redirect to the cgiauthurl for authentication, there is now
     a button on the login form to use it.
+  * httpauth: Add httpauth_pagespec setting that can be used to limit
+    pages to only being edited via users authed with httpauth.
 
  -- Joey Hess <joeyh@debian.org>  Tue, 26 Jan 2010 22:25:33 -0500
 
diff --git a/doc/plugins/httpauth.mdwn b/doc/plugins/httpauth.mdwn
index a7aac558b..0eda5554f 100644
--- a/doc/plugins/httpauth.mdwn
+++ b/doc/plugins/httpauth.mdwn
@@ -24,3 +24,12 @@ A typical setup is to make an `auth` subdirectory, and symlink `ikiwiki.cgi`
 into it. Then configure the web server to require authentication only for
 access to the `auth` subdirectory. Then `cgiauthurl` is pointed at this
 symlink.
+
+## using only httpauth for some pages
+
+If you want to only use httpauth for editing some pages, while allowing
+other authentication methods to be used for other pages, you can
+configure `httpauth_pagespec` in the setup file. This makes Edit
+links on pages that match the [[ikiwiki/PageSpec]] automatically use
+the `cgiauthurl`, and prevents matching pages from being edited by
+users authentication via other methods.
-- 
cgit v1.2.3


From e6678275a98bd00e888018409998fd67686149c8 Mon Sep 17 00:00:00 2001
From: Joey Hess <joey@gnu.kitenet.net>
Date: Thu, 11 Feb 2010 18:32:07 -0500
Subject: fix logic error

---
 IkiWiki/Plugin/httpauth.pm | 16 +++++++++++-----
 1 file changed, 11 insertions(+), 5 deletions(-)

(limited to 'IkiWiki/Plugin/httpauth.pm')

diff --git a/IkiWiki/Plugin/httpauth.pm b/IkiWiki/Plugin/httpauth.pm
index 202ca1153..5b7d65253 100644
--- a/IkiWiki/Plugin/httpauth.pm
+++ b/IkiWiki/Plugin/httpauth.pm
@@ -75,13 +75,16 @@ sub formbuilder_setup (@) {
 	}
 }
 
+sub need_httpauth_pagespec () {
+	return defined $config{httpauth_pagespec} &&
+	       length $config{httpauth_pagespec} &&
+	       defined $config{cgiauthurl};
+}
+
 sub test_httpauth_pagespec ($) {
 	my $page=shift;
 
-	return defined $config{httpauth_pagespec} &&
-	       length $config{httpauth_pagespec} &&
-	       defined $config{cgiauthurl} &&
-	       pagespec_match($page, $config{httpauth_pagespec});
+	pagespec_match($page, $config{httpauth_pagespec});
 }
 
 sub canedit ($$$) {
@@ -89,7 +92,9 @@ sub canedit ($$$) {
 	my $cgi=shift;
 	my $session=shift;
 
-	if (! defined $cgi->remote_user() && test_httpauth_pagespec($page)) {
+	if (! defined $cgi->remote_user() &&
+	    need_httpauth_pagespec() &&
+    	    ! test_httpauth_pagespec($page)) {
 		return sub {
 			IkiWiki::redirect($cgi, 
 				$config{cgiauthurl}.'?'.$cgi->query_string());
@@ -106,6 +111,7 @@ sub pagetemplate (@_) {
 	my $template=$params{template};
 
 	if ($template->param("editurl") &&
+	    need_httpauth_pagespec() &&
 	    test_httpauth_pagespec($params{page})) {
 		# go directly to cgiauthurl when editing a page matching
 		# the pagespec
-- 
cgit v1.2.3


From 6f1d6236185148930a2c7694c9ae59877997d0d4 Mon Sep 17 00:00:00 2001
From: Joey Hess <joey@gnu.kitenet.net>
Date: Thu, 11 Feb 2010 19:54:40 -0500
Subject: partially fix httpauth canedit hook

My logic was right before. Cleaned up some code.

(Page creation is still a problem.)

Also, I removed the Edit url munging, because that is not
necessary with the canedit hook, since canedit will handle
redirection through cgiauthurl if necessary.
---
 IkiWiki/Plugin/httpauth.pm | 43 +++++++++++++------------------------------
 1 file changed, 13 insertions(+), 30 deletions(-)

(limited to 'IkiWiki/Plugin/httpauth.pm')

diff --git a/IkiWiki/Plugin/httpauth.pm b/IkiWiki/Plugin/httpauth.pm
index 5b7d65253..b2bb2701a 100644
--- a/IkiWiki/Plugin/httpauth.pm
+++ b/IkiWiki/Plugin/httpauth.pm
@@ -11,8 +11,8 @@ sub import {
 	hook(type => "auth", id => "httpauth", call => \&auth);
 	hook(type => "formbuilder_setup", id => "httpauth",
 		call => \&formbuilder_setup);
-	hook(type => "canedit", id => "httpauth", call => \&canedit);
-	hook(type => "pagetemplate", id => "httpauth", call => \&pagetemplate);
+	hook(type => "canedit", id => "httpauth", call => \&canedit,
+		first => 1);
 }
 
 sub getsetup () {
@@ -41,7 +41,9 @@ sub redir_cgiauthurl ($;@) {
 	my $cgi=shift;
 
 	IkiWiki::redirect($cgi, 
-		IkiWiki::cgiurl(cgiurl => $config{cgiauthurl}, @_));
+		@_ > 1 ? IkiWiki::cgiurl(cgiurl => $config{cgiauthurl}, @_)
+		       : $config{cgiauthurl}."?@_"
+	);
 	exit;
 }
 
@@ -75,16 +77,11 @@ sub formbuilder_setup (@) {
 	}
 }
 
-sub need_httpauth_pagespec () {
-	return defined $config{httpauth_pagespec} &&
-	       length $config{httpauth_pagespec} &&
-	       defined $config{cgiauthurl};
-}
-
 sub test_httpauth_pagespec ($) {
 	my $page=shift;
 
-	pagespec_match($page, $config{httpauth_pagespec});
+	return (
+       );
 }
 
 sub canedit ($$$) {
@@ -93,12 +90,13 @@ sub canedit ($$$) {
 	my $session=shift;
 
 	if (! defined $cgi->remote_user() &&
-	    need_httpauth_pagespec() &&
-    	    ! test_httpauth_pagespec($page)) {
+	    defined $config{httpauth_pagespec} &&
+	    length $config{httpauth_pagespec} &&
+	    defined $config{cgiauthurl} &&
+	    pagespec_match($page, $config{httpauth_pagespec})) {
 		return sub {
-			IkiWiki::redirect($cgi, 
-				$config{cgiauthurl}.'?'.$cgi->query_string());
-			exit;
+			# bounce thru cgiauthurl and back to edit action
+			redir_cgiauthurl($cgi, $cgi->query_string());
 		};
 	}
 	else {
@@ -106,19 +104,4 @@ sub canedit ($$$) {
 	}
 }
 
-sub pagetemplate (@_) {
-	my %params=@_;
-	my $template=$params{template};
-
-	if ($template->param("editurl") &&
-	    need_httpauth_pagespec() &&
-	    test_httpauth_pagespec($params{page})) {
-		# go directly to cgiauthurl when editing a page matching
-		# the pagespec
-		$template->param(editurl => IkiWiki::cgiurl(
-			cgiurl => $config{cgiauthurl},
-			do => "edit", page => $params{page}));
-	}
-}
-
 1
-- 
cgit v1.2.3


From a63929f6cc7778ffc4ba57d784cdf2206ec650c7 Mon Sep 17 00:00:00 2001
From: Joey Hess <joey@gnu.kitenet.net>
Date: Thu, 11 Feb 2010 22:24:15 -0500
Subject: Group related plugins into sections in the setup file, and drop
 unused rcs plugins from the setup file.

---
 IkiWiki/Plugin/anonok.pm            |  1 +
 IkiWiki/Plugin/blogspam.pm          |  1 +
 IkiWiki/Plugin/bzr.pm               |  1 +
 IkiWiki/Plugin/conditional.pm       |  1 +
 IkiWiki/Plugin/cvs.pm               |  1 +
 IkiWiki/Plugin/darcs.pm             |  1 +
 IkiWiki/Plugin/editpage.pm          |  1 +
 IkiWiki/Plugin/git.pm               |  1 +
 IkiWiki/Plugin/htmlscrubber.pm      |  1 +
 IkiWiki/Plugin/httpauth.pm          |  1 +
 IkiWiki/Plugin/inline.pm            |  1 +
 IkiWiki/Plugin/link.pm              |  1 +
 IkiWiki/Plugin/lockedit.pm          |  1 +
 IkiWiki/Plugin/mdwn.pm              |  1 +
 IkiWiki/Plugin/mercurial.pm         |  1 +
 IkiWiki/Plugin/meta.pm              |  1 +
 IkiWiki/Plugin/moderatedcomments.pm |  1 +
 IkiWiki/Plugin/monotone.pm          |  1 +
 IkiWiki/Plugin/opendiscussion.pm    |  1 +
 IkiWiki/Plugin/openid.pm            |  1 +
 IkiWiki/Plugin/parentlinks.pm       |  1 +
 IkiWiki/Plugin/passwordauth.pm      |  1 +
 IkiWiki/Plugin/recentchanges.pm     |  1 +
 IkiWiki/Plugin/signinedit.pm        |  1 +
 IkiWiki/Plugin/svn.pm               |  1 +
 IkiWiki/Plugin/tla.pm               |  1 +
 IkiWiki/Setup.pm                    | 32 ++++++++++++++++++++++++++------
 IkiWiki/Setup/Standard.pm           |  8 ++++++++
 debian/changelog                    |  2 ++
 doc/plugins/write.mdwn              | 13 ++++++++-----
 30 files changed, 70 insertions(+), 11 deletions(-)

(limited to 'IkiWiki/Plugin/httpauth.pm')

diff --git a/IkiWiki/Plugin/anonok.pm b/IkiWiki/Plugin/anonok.pm
index 243b98920..0e74cbfad 100644
--- a/IkiWiki/Plugin/anonok.pm
+++ b/IkiWiki/Plugin/anonok.pm
@@ -15,6 +15,7 @@ sub getsetup () {
 		plugin => {
 			safe => 1,
 			rebuild => 0,
+			section => "auth",
 		},
 		anonok_pagespec => {
 			type => "pagespec",
diff --git a/IkiWiki/Plugin/blogspam.pm b/IkiWiki/Plugin/blogspam.pm
index 626c8ec42..c4e5cf390 100644
--- a/IkiWiki/Plugin/blogspam.pm
+++ b/IkiWiki/Plugin/blogspam.pm
@@ -18,6 +18,7 @@ sub getsetup () {
 		plugin => {
 			safe => 1,
 			rebuild => 0,
+			section => "auth",
 		},
 		blogspam_pagespec => {
 			type => 'pagespec',
diff --git a/IkiWiki/Plugin/bzr.pm b/IkiWiki/Plugin/bzr.pm
index 883007367..1ffdc2353 100644
--- a/IkiWiki/Plugin/bzr.pm
+++ b/IkiWiki/Plugin/bzr.pm
@@ -36,6 +36,7 @@ sub getsetup () {
 		plugin => {
 			safe => 0, # rcs plugin
 			rebuild => undef,
+			section => "rcs",
 		},
 		bzr_wrapper => {
 			type => "string",
diff --git a/IkiWiki/Plugin/conditional.pm b/IkiWiki/Plugin/conditional.pm
index aad617812..beeddc672 100644
--- a/IkiWiki/Plugin/conditional.pm
+++ b/IkiWiki/Plugin/conditional.pm
@@ -16,6 +16,7 @@ sub getsetup {
 		plugin => {
 			safe => 1,
 			rebuild => undef,
+			section => "core",
 		},
 }
 
diff --git a/IkiWiki/Plugin/cvs.pm b/IkiWiki/Plugin/cvs.pm
index f6db8bc98..26a3e9dd2 100644
--- a/IkiWiki/Plugin/cvs.pm
+++ b/IkiWiki/Plugin/cvs.pm
@@ -85,6 +85,7 @@ sub getsetup () {
 		plugin => {
 			safe => 0, # rcs plugin
 			rebuild => undef,
+			section => "rcs",
 		},
 		cvsrepo => {
 			type => "string",
diff --git a/IkiWiki/Plugin/darcs.pm b/IkiWiki/Plugin/darcs.pm
index 0d68f27e5..1c9538e83 100644
--- a/IkiWiki/Plugin/darcs.pm
+++ b/IkiWiki/Plugin/darcs.pm
@@ -92,6 +92,7 @@ sub getsetup() {
 		plugin => {
 			safe => 0, # rcs plugin
 			rebuild => undef,
+			section => "rcs",
 		},
 		darcs_wrapper => {
 			type => "string",
diff --git a/IkiWiki/Plugin/editpage.pm b/IkiWiki/Plugin/editpage.pm
index 9211cca89..44fe5514a 100644
--- a/IkiWiki/Plugin/editpage.pm
+++ b/IkiWiki/Plugin/editpage.pm
@@ -17,6 +17,7 @@ sub getsetup () {
 		plugin => {
 			safe => 1,
 			rebuild => 1,
+			section => "core",
 		},
 }
 
diff --git a/IkiWiki/Plugin/git.pm b/IkiWiki/Plugin/git.pm
index 1eec6aee6..b02f4a5ed 100644
--- a/IkiWiki/Plugin/git.pm
+++ b/IkiWiki/Plugin/git.pm
@@ -68,6 +68,7 @@ sub getsetup () {
 		plugin => {
 			safe => 0, # rcs plugin
 			rebuild => undef,
+			section => "rcs",
 		},
 		git_wrapper => {
 			type => "string",
diff --git a/IkiWiki/Plugin/htmlscrubber.pm b/IkiWiki/Plugin/htmlscrubber.pm
index a249cdf7a..ee284a45c 100644
--- a/IkiWiki/Plugin/htmlscrubber.pm
+++ b/IkiWiki/Plugin/htmlscrubber.pm
@@ -40,6 +40,7 @@ sub getsetup () {
 		plugin => {
 			safe => 1,
 			rebuild => undef,
+			section => "core",
 		},
 		htmlscrubber_skip => {
 			type => "pagespec",
diff --git a/IkiWiki/Plugin/httpauth.pm b/IkiWiki/Plugin/httpauth.pm
index b2bb2701a..478f67446 100644
--- a/IkiWiki/Plugin/httpauth.pm
+++ b/IkiWiki/Plugin/httpauth.pm
@@ -20,6 +20,7 @@ sub getsetup () {
 		plugin => {
 			safe => 1,
 			rebuild => 0,
+			section => "auth",
 		},
 		cgiauthurl => {
 			type => "string",
diff --git a/IkiWiki/Plugin/inline.pm b/IkiWiki/Plugin/inline.pm
index 401852513..44919e58c 100644
--- a/IkiWiki/Plugin/inline.pm
+++ b/IkiWiki/Plugin/inline.pm
@@ -49,6 +49,7 @@ sub getsetup () {
 		plugin => {
 			safe => 1,
 			rebuild => undef,
+			section => "core",
 		},
 		rss => {
 			type => "boolean",
diff --git a/IkiWiki/Plugin/link.pm b/IkiWiki/Plugin/link.pm
index 4c1add985..3838aec09 100644
--- a/IkiWiki/Plugin/link.pm
+++ b/IkiWiki/Plugin/link.pm
@@ -20,6 +20,7 @@ sub getsetup () {
 		plugin => {
 			safe => 1,
 			rebuild => 1,
+			section => "core",
 		},
 }
 
diff --git a/IkiWiki/Plugin/lockedit.pm b/IkiWiki/Plugin/lockedit.pm
index 74ddbb153..1466e8337 100644
--- a/IkiWiki/Plugin/lockedit.pm
+++ b/IkiWiki/Plugin/lockedit.pm
@@ -15,6 +15,7 @@ sub getsetup () {
 		plugin => {
 			safe => 1,
 			rebuild => 0,
+			section => "auth",
 		},
 		locked_pages => {
 			type => "pagespec",
diff --git a/IkiWiki/Plugin/mdwn.pm b/IkiWiki/Plugin/mdwn.pm
index 3de59ef3d..4ddf097ba 100644
--- a/IkiWiki/Plugin/mdwn.pm
+++ b/IkiWiki/Plugin/mdwn.pm
@@ -16,6 +16,7 @@ sub getsetup () {
 		plugin => {
 			safe => 1,
 			rebuild => 1, # format plugin
+			section => "core",
 		},
 		multimarkdown => {
 			type => "boolean",
diff --git a/IkiWiki/Plugin/mercurial.pm b/IkiWiki/Plugin/mercurial.pm
index 11fdec529..ea00a3364 100644
--- a/IkiWiki/Plugin/mercurial.pm
+++ b/IkiWiki/Plugin/mercurial.pm
@@ -36,6 +36,7 @@ sub getsetup () {
 		plugin => {
 			safe => 0, # rcs plugin
 			rebuild => undef,
+			section => "rcs",
 		},
 		mercurial_wrapper => {
 			type => "string",
diff --git a/IkiWiki/Plugin/meta.pm b/IkiWiki/Plugin/meta.pm
index 55c9ddbd1..5f046cb2a 100644
--- a/IkiWiki/Plugin/meta.pm
+++ b/IkiWiki/Plugin/meta.pm
@@ -20,6 +20,7 @@ sub getsetup () {
 		plugin => {
 			safe => 1,
 			rebuild => undef,
+			section => "core",
 		},
 }
 
diff --git a/IkiWiki/Plugin/moderatedcomments.pm b/IkiWiki/Plugin/moderatedcomments.pm
index 2555927b7..afe1ceedf 100644
--- a/IkiWiki/Plugin/moderatedcomments.pm
+++ b/IkiWiki/Plugin/moderatedcomments.pm
@@ -15,6 +15,7 @@ sub getsetup () {
 		plugin => {
 			safe => 1,
 			rebuild => 0,
+			section => "auth",
 		},
 		moderate_users => {
 			type => 'boolean',
diff --git a/IkiWiki/Plugin/monotone.pm b/IkiWiki/Plugin/monotone.pm
index 9502804f1..c33cf7e3a 100644
--- a/IkiWiki/Plugin/monotone.pm
+++ b/IkiWiki/Plugin/monotone.pm
@@ -68,6 +68,7 @@ sub getsetup () {
 		plugin => {
 			safe => 0, # rcs plugin
 			rebuild => undef,
+			section => "rcs",
 		},
 		mtn_wrapper => {
 			type => "string",
diff --git a/IkiWiki/Plugin/opendiscussion.pm b/IkiWiki/Plugin/opendiscussion.pm
index 5a455940b..2805f60ef 100644
--- a/IkiWiki/Plugin/opendiscussion.pm
+++ b/IkiWiki/Plugin/opendiscussion.pm
@@ -16,6 +16,7 @@ sub getsetup () {
 		plugin => {
 			safe => 1,
 			rebuild => 0,
+			section => "auth",
 		},
 }
 
diff --git a/IkiWiki/Plugin/openid.pm b/IkiWiki/Plugin/openid.pm
index 382d8286f..bb99446b4 100644
--- a/IkiWiki/Plugin/openid.pm
+++ b/IkiWiki/Plugin/openid.pm
@@ -26,6 +26,7 @@ sub getsetup () {
 		plugin => {
 			safe => 1,
 			rebuild => 0,
+			section => "auth",
 		},
 		openidsignup => {
 			type => "string",
diff --git a/IkiWiki/Plugin/parentlinks.pm b/IkiWiki/Plugin/parentlinks.pm
index e678a057d..728bbc399 100644
--- a/IkiWiki/Plugin/parentlinks.pm
+++ b/IkiWiki/Plugin/parentlinks.pm
@@ -16,6 +16,7 @@ sub getsetup () {
 		plugin => {
 			safe => 1,
 			rebuild => 1,
+			section => "core",
 		},
 }
 
diff --git a/IkiWiki/Plugin/passwordauth.pm b/IkiWiki/Plugin/passwordauth.pm
index c07065b7d..4848b47bb 100644
--- a/IkiWiki/Plugin/passwordauth.pm
+++ b/IkiWiki/Plugin/passwordauth.pm
@@ -19,6 +19,7 @@ sub getsetup () {
 		plugin => {
 			safe => 1,
 			rebuild => 0,
+			section => "auth",
 		},
 		account_creation_password => {
 			type => "string",
diff --git a/IkiWiki/Plugin/recentchanges.pm b/IkiWiki/Plugin/recentchanges.pm
index 5c7b71aaa..04219b721 100644
--- a/IkiWiki/Plugin/recentchanges.pm
+++ b/IkiWiki/Plugin/recentchanges.pm
@@ -22,6 +22,7 @@ sub getsetup () {
 		plugin => {
 			safe => 1,
 			rebuild => 1,
+			section => "core",
 		},
 		recentchangespage => {
 			type => "string",
diff --git a/IkiWiki/Plugin/signinedit.pm b/IkiWiki/Plugin/signinedit.pm
index 8b44a68f7..31160c02f 100644
--- a/IkiWiki/Plugin/signinedit.pm
+++ b/IkiWiki/Plugin/signinedit.pm
@@ -16,6 +16,7 @@ sub getsetup () {
 		plugin => {
 			safe => 1,
 			rebuild => 0,
+			section => "auth",
 		},
 }
 
diff --git a/IkiWiki/Plugin/svn.pm b/IkiWiki/Plugin/svn.pm
index 06b987f51..7d27ec842 100644
--- a/IkiWiki/Plugin/svn.pm
+++ b/IkiWiki/Plugin/svn.pm
@@ -44,6 +44,7 @@ sub getsetup () {
 		plugin => {
 			safe => 0, # rcs plugin
 			rebuild => undef,
+			section => "rcs",
 		},
 		svnrepo => {
 			type => "string",
diff --git a/IkiWiki/Plugin/tla.pm b/IkiWiki/Plugin/tla.pm
index f4b20a6ec..16d73b136 100644
--- a/IkiWiki/Plugin/tla.pm
+++ b/IkiWiki/Plugin/tla.pm
@@ -34,6 +34,7 @@ sub getsetup () {
 		plugin => {
 			safe => 0, # rcs plugin
 			rebuild => undef,
+			section => "rcs",
 		},
 		tla_wrapper => {
 			type => "string",
diff --git a/IkiWiki/Setup.pm b/IkiWiki/Setup.pm
index 8a25ecc57..b21bd7bfe 100644
--- a/IkiWiki/Setup.pm
+++ b/IkiWiki/Setup.pm
@@ -77,7 +77,6 @@ sub merge ($) {
 sub getsetup () {
 	# Gets all available setup data from all plugins. Returns an
 	# ordered list of [plugin, setup] pairs.
-	my @ret;
 
         # disable logging to syslog while dumping, broken plugins may
 	# whine when loaded
@@ -85,27 +84,48 @@ sub getsetup () {
         $config{syslog}=undef;
 
 	# Load all plugins, so that all setup options are available.
-	my @plugins=grep { $_ ne $config{rcs} } sort(IkiWiki::listplugins());
-	unshift @plugins, $config{rcs} if $config{rcs}; # rcs plugin 1st
+	my @plugins=IkiWiki::listplugins();
 	foreach my $plugin (@plugins) {
 		eval { IkiWiki::loadplugin($plugin) };
 		if (exists $IkiWiki::hooks{checkconfig}{$plugin}{call}) {
 			my @s=eval { $IkiWiki::hooks{checkconfig}{$plugin}{call}->() };
 		}
 	}
-
+	
+	my %sections;
 	foreach my $plugin (@plugins) {
 		if (exists $IkiWiki::hooks{getsetup}{$plugin}{call}) {
 			# use an array rather than a hash, to preserve order
 			my @s=eval { $IkiWiki::hooks{getsetup}{$plugin}{call}->() };
 			next unless @s;
-			push @ret, [ $plugin, \@s ],
+
+			# set default section value (note use of shared
+			# hashref between array and hash)
+			my %s=@s;
+			if (! exists $s{plugin} || ! $s{plugin}->{section}) {
+				$s{plugin}->{section}="misc";
+			}
+
+			# only the selected rcs plugin is included
+			if ($config{rcs} && $plugin eq $config{rcs}) {
+				$s{plugin}->{section}="core";
+			}
+			elsif ($s{plugin}->{section} eq "rcs") {
+				next;
+			}
+
+			push @{$sections{$s{plugin}->{section}}}, [ $plugin, \@s ];
 		}
 	}
 	
         $config{syslog}=$syslog;
 
-	return @ret;
+	return map { sort { $a->[0] cmp $b->[0] } @{$sections{$_}} }
+		sort { # core first, then alphabetical
+			($b eq "core") <=> ($a eq "core")
+			   ||
+			$a cmp $b
+		} keys %sections;
 }
 
 sub dump ($) {
diff --git a/IkiWiki/Setup/Standard.pm b/IkiWiki/Setup/Standard.pm
index 951bcfc56..c99dbb620 100644
--- a/IkiWiki/Setup/Standard.pm
+++ b/IkiWiki/Setup/Standard.pm
@@ -90,10 +90,18 @@ sub gendump ($) {
 	# disable logging to syslog while dumping
 	$config{syslog}=undef;
 
+	my $curr_section;
 	push @ret, dumpvalues(\%setup, IkiWiki::getsetup());
 	foreach my $pair (IkiWiki::Setup::getsetup()) {
 		my $plugin=$pair->[0];
 		my $setup=$pair->[1];
+		my %s=@{$setup};
+		my $section=$s{plugin}->{section};
+		if (! defined $curr_section || $curr_section ne $section) {
+			$curr_section=$section;
+			push @ret, "", "\t#", "\t# $section plugins", "\t#";
+		}
+
 		my @values=dumpvalues(\%setup, @{$setup});
 		if (@values) {
 			push @ret, "", "\t# $plugin plugin", @values;
diff --git a/debian/changelog b/debian/changelog
index d74abd0f9..f24a453c8 100644
--- a/debian/changelog
+++ b/debian/changelog
@@ -22,6 +22,8 @@ ikiwiki (3.20100123) UNRELEASED; urgency=low
   * httpauth: Add httpauth_pagespec setting that can be used to limit
     pages to only being edited via users authed with httpauth.
   * Allow globs to be used in user() pagespecs.
+  * Group related plugins into sections in the setup file, and drop
+    unused rcs plugins from the setup file.
 
  -- Joey Hess <joeyh@debian.org>  Tue, 26 Jan 2010 22:25:33 -0500
 
diff --git a/doc/plugins/write.mdwn b/doc/plugins/write.mdwn
index 082f0e38f..68454d56c 100644
--- a/doc/plugins/write.mdwn
+++ b/doc/plugins/write.mdwn
@@ -457,6 +457,12 @@ describing the option. There can also be an item named "plugin", which
 describes the plugin as a whole. For example:
 
                 return
+			plugin => {
+				description => "description of this plugin",
+				safe => 1,
+				rebuild => 1,
+				section => "misc",
+			},
 			option_foo => {
 				type => "boolean",
 				description => "enable foo?",
@@ -471,11 +477,6 @@ describes the plugin as a whole. For example:
 				safe => 1,
 				rebuild => 0,
 			},
-			plugin => {
-				description => "description of this plugin",
-				safe => 1,
-				rebuild => 1,
-			},
 
 * `type` can be "boolean", "string", "integer", "pagespec",
   or "internal" (used for values that are not user-visible). The type is
@@ -496,6 +497,8 @@ describes the plugin as a whole. For example:
   the plugin) will require a wiki rebuild, false if no rebuild is needed,
   and undef if a rebuild could be needed in some circumstances, but is not
   strictly required.
+* `section` can optionally specify which section in the config file
+  the plugin fits in.
 
 ### genwrapper
 
-- 
cgit v1.2.3