Merge branch 'master' of ssh://git.ikiwiki.info/srv/git/ikiwiki.info

[git.ikiwiki.info.git] / IkiWiki / Setup.pm

diff --git a/IkiWiki/Setup.pm b/IkiWiki/Setup.pm
index 3accf35919cb13c7123eb9d4c4ce254e75beaa39..7af744f6ab18fe2bc0132891ce7c4fc3a461040f 100644 (file)
--- a/IkiWiki/Setup.pm
+++ b/IkiWiki/Setup.pm
@@ -13,37 +13,70 @@ use open qw{:utf8 :std};
 use File::Spec;
 
 sub load ($;$) {
-       my $setup=IkiWiki::possibly_foolish_untaint(shift);
+       my $file=IkiWiki::possibly_foolish_untaint(shift);
        my $safemode=shift;
 
-       $config{setupfile}=File::Spec->rel2abs($setup);
+       $config{setupfile}=File::Spec->rel2abs($file);
 
        #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, $!));
+       open (IN, $file) || error(sprintf(gettext("cannot read %s: %s"), $file, $!));
        my $content;
        {
                local $/=undef;
-               $content=<IN> || error("$setup: $!");
+               $content=<IN> || error("$file: $!");
        }
        close IN;
 
-       if ($content=~/(use\s+)?(IkiWiki::Setup::\w+)/) {
+       if ($content=~/((?:use|require)\s+)?IkiWiki::Setup::(\w+)/) {
                $config{setuptype}=$2;
                if ($1) {
-                       error sprintf(gettext("cannot load %s in safe mode"), $setup)
+                       error sprintf(gettext("cannot load %s in safe mode"), $file)
                                if $safemode;
+                       no warnings;
                        eval IkiWiki::possibly_foolish_untaint($content);
-                       error("$setup: ".$@) if $@;
+                       error("$file: ".$@) if $@;
                }
                else {
-                       eval qq{require $config{setuptype}};
+                       eval qq{require IkiWiki::Setup::$config{setuptype}};
                        error $@ if $@;
-                       $config{setuptype}->loaddump(IkiWiki::possibly_foolish_untaint($content));
+                       "IkiWiki::Setup::$config{setuptype}"->loaddump(IkiWiki::possibly_foolish_untaint($content));
                }
        }
        else {
-               error sprintf(gettext("failed to parse %s"), $setup);
+               error sprintf(gettext("failed to parse %s"), $file);
+       }
+}
+
+sub dump ($) {
+       my $file=IkiWiki::possibly_foolish_untaint(shift);
+
+       my @header=(
+               "Setup file for ikiwiki.",
+               "",
+               "Passing this to ikiwiki --setup will make ikiwiki generate",
+               "wrappers and build the wiki.",
+               "",
+               "Remember to re-run ikiwiki --setup any time you edit this file.",
+       );
+
+       # Fork because dumping setup requires loading all plugins.
+       my $pid=fork();
+       if ($pid == 0) {
+               eval qq{require IkiWiki::Setup::$config{setuptype}};
+               error $@ if $@;
+               my @dump="IkiWiki::Setup::$config{setuptype}"->gendump(@header);
+       
+               open (OUT, ">", $file) || die "$file: $!";
+               print OUT "$_\n" foreach @dump;
+               close OUT;
+
+               exit 0;
+       }
+       else {
+               waitpid $pid, 0;
+               exit($? >> 8) if $? >> 8;
+               exit(1) if $?;
        }
 }
 
@@ -103,7 +136,7 @@ sub getsetup () {
        # Load all plugins, so that all setup options are available.
        my @plugins=IkiWiki::listplugins();
        foreach my $plugin (@plugins) {
-               eval { IkiWiki::loadplugin($plugin) };
+               eval { IkiWiki::loadplugin($plugin, 1) };
                if (exists $IkiWiki::hooks{checkconfig}{$plugin}{call}) {
                        my @s=eval { $IkiWiki::hooks{checkconfig}{$plugin}{call}->() };
                }
@@ -147,16 +180,70 @@ sub getsetup () {
                } keys %sections;
 }
 
-sub dump ($) {
-       my $file=IkiWiki::possibly_foolish_untaint(shift);
+sub commented_dump ($$) {
+       my $dumpline=shift;
+       my $indent=shift;
+
+       my %setup=(%config);
+       my @ret;
        
-       eval qq{require $config{setuptype}};
-       error $@ if $@;
-       my @dump=$config{setuptype}->gendump("Setup file for ikiwiki.");
+       # disable logging to syslog while dumping
+       $config{syslog}=undef;
+
+       eval q{use Text::Wrap};
+       die $@ if $@;
+
+       my %section_plugins;
+       push @ret, commented_dumpvalues($dumpline, $indent, \%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};
+               push @{$section_plugins{$section}}, $plugin;
+               if (@{$section_plugins{$section}} == 1) {
+                       push @ret, "", $indent.("#" x 70), "$indent# $section plugins",
+                               sub {
+                                       wrap("$indent#   (", "$indent#    ",
+                                               join(", ", @{$section_plugins{$section}})).")"
+                               },
+                               $indent.("#" x 70);
+               }
+
+               my @values=commented_dumpvalues($dumpline, $indent, \%setup, @{$setup});
+               if (@values) {
+                       push @ret, "", "$indent# $plugin plugin", @values;
+               }
+       }
+
+       return map { ref $_ ? $_->() : $_ } @ret;
+}
 
-       open (OUT, ">", $file) || die "$file: $!";
-       print OUT "$_\n" foreach @dump;
-       close OUT;
+sub commented_dumpvalues ($$$@) {
+       my $dumpline=shift;
+       my $indent=shift;
+       my $setup=shift;
+       my @ret;
+       while (@_) {
+               my $key=shift;
+               my %info=%{shift()};
+
+               next if $key eq "plugin" || $info{type} eq "internal";
+               
+               push @ret, "$indent# ".$info{description} if exists $info{description};
+               
+               if (exists $setup->{$key} && defined $setup->{$key}) {
+                       push @ret, $dumpline->($key, $setup->{$key}, $info{type}, "");
+                       delete $setup->{$key};
+               }
+               elsif (exists $info{example}) {
+                       push @ret, $dumpline->($key, $info{example}, $info{type}, "#");
+               }
+               else {
+                       push @ret, $dumpline->($key, "", $info{type}, "#");
+               }
+       }
+       return @ret;
 }
 
 1