Group related plugins into sections in the setup file, and drop unused rcs plugins...
[ikiwiki.git] / IkiWiki / Setup.pm
index d2d1e4b8e7fd44b88c0ed64f110e609f78785ea5..b21bd7bfe549929b29283226a14b1234c08ec595 100644 (file)
@@ -8,30 +8,33 @@ use warnings;
 use strict;
 use IkiWiki;
 use open qw{:utf8 :std};
+use File::Spec;
 
-sub load ($) { # {{{
+sub load ($) {
        my $setup=IkiWiki::possibly_foolish_untaint(shift);
-       delete $config{setup};
+       $config{setupfile}=File::Spec->rel2abs($setup);
+
        #translators: The first parameter is a filename, and the second
        #translators: is a (probably not translated) error message.
        open (IN, $setup) || error(sprintf(gettext("cannot read %s: %s"), $setup, $!));
        my $code;
        {
                local $/=undef;
-               $code=<IN>;
+               $code=<IN> || error("$setup: $!");
        }
+       
        ($code)=$code=~/(.*)/s;
        close IN;
 
        eval $code;
        error("$setup: ".$@) if $@;
-} #}}}
+}
 
 sub merge ($) {
        # Merge setup into existing config and untaint.
        my %setup=%{shift()};
 
-       if (exists $setup{add_plugins}) {
+       if (exists $setup{add_plugins} && exists $config{add_plugins}) {
                push @{$setup{add_plugins}}, @{$config{add_plugins}};
        }
        if (exists $setup{exclude}) {
@@ -69,43 +72,63 @@ sub merge ($) {
                        wrappermode => (defined $config{cgi_wrappermode} ? $config{cgi_wrappermode} : "06755"),
                };
        }
-} #}}}
+}
 
-sub getsetup () { #{{{
+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
        my $syslog=$config{syslog};
-        $config{syslog}=0;
+        $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 ($) { #{{{
+sub dump ($) {
        my $file=IkiWiki::possibly_foolish_untaint(shift);
        
        require IkiWiki::Setup::Standard;