release candidate

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

diff --git a/IkiWiki/Setup.pm b/IkiWiki/Setup.pm
index 3accf35919cb13c7123eb9d4c4ce254e75beaa39..453d19670d2bfc6113c2d87b3d0af44242823754 100644 (file)
--- a/IkiWiki/Setup.pm
+++ b/IkiWiki/Setup.pm
@@ -13,37 +13,70 @@ use open qw{:utf8 :std};
 use File::Spec;
 
 sub load ($;$) {
 use File::Spec;
 
 sub load ($;$) {

-       my $setup=IkiWiki::possibly_foolish_untaint(shift);
+       my $file=IkiWiki::possibly_foolish_untaint(shift);

        my $safemode=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.
 
        #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;
        my $content;
        {
                local $/=undef;

-               $content=<IN> || error("$setup: $!");
+               $content=<IN> || error("$file: $!");

        }
        close IN;
 
        }
        close IN;
 

-       if ($content=~/(use\s+)?(IkiWiki::Setup::\w+)/) {
+       if ($content=~/((?:use|require)\s+)?IkiWiki::Setup::(\w+)/) {

                $config{setuptype}=$2;
                if ($1) {
                $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;
                                if $safemode;

+                       no warnings;

                        eval IkiWiki::possibly_foolish_untaint($content);
                        eval IkiWiki::possibly_foolish_untaint($content);

-                       error("$setup: ".$@) if $@;
+                       error("$file: ".$@) if $@;

                }
                else {
                }
                else {

-                       eval qq{require $config{setuptype}};
+                       eval qq{require IkiWiki::Setup::$config{setuptype}};

                        error $@ if $@;
                        error $@ if $@;

-                       $config{setuptype}->loaddump(IkiWiki::possibly_foolish_untaint($content));
+                       "IkiWiki::Setup::$config{setuptype}"->loaddump(IkiWiki::possibly_foolish_untaint($content));

                }
        }
        else {
                }
        }
        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 $?;

        }
 }
 
        }
 }
 


@@ -91,6 +124,27 @@ sub merge ($) {
        }
 }
 
        }
 }
 

+sub disabled_plugins (@) {
+       # Handles running disable hooks of plugins that were enabled
+       # previously, but got disabled when a new setup file was loaded.
+       if (exists $config{setupfile} && @_) {
+               # Fork a child to load the disabled plugins.
+               my $pid=fork();
+               if ($pid == 0) {
+                       foreach my $plugin (@_) {
+                               eval { IkiWiki::loadplugin($plugin, 1) };
+                               if (exists $IkiWiki::hooks{disable}{$plugin}{call}) {
+                                       eval { $IkiWiki::hooks{disable}{$plugin}{call}->() };
+                               }
+                       }
+                       exit(0);
+               }
+               else {
+                       waitpid $pid, 0;
+               }
+       }
+}
+

 sub getsetup () {
        # Gets all available setup data from all plugins. Returns an
        # ordered list of [plugin, setup] pairs.
 sub getsetup () {
        # Gets all available setup data from all plugins. Returns an
        # ordered list of [plugin, setup] pairs.


@@ -101,13 +155,15 @@ sub getsetup () {
         $config{syslog}=undef;
 
        # Load all plugins, so that all setup options are available.
         $config{syslog}=undef;
 
        # Load all plugins, so that all setup options are available.

+       my %original_loaded_plugins=%IkiWiki::loaded_plugins;

        my @plugins=IkiWiki::listplugins();
        foreach my $plugin (@plugins) {
        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}->() };
                }
        }
                if (exists $IkiWiki::hooks{checkconfig}{$plugin}{call}) {
                        my @s=eval { $IkiWiki::hooks{checkconfig}{$plugin}{call}->() };
                }
        }

+       %IkiWiki::loaded_plugins=%original_loaded_plugins;

        
        my %sections;
        foreach my $plugin (@plugins) {
        
        my %sections;
        foreach my $plugin (@plugins) {


@@ -116,6 +172,11 @@ sub getsetup () {
                        my @s=eval { $IkiWiki::hooks{getsetup}{$plugin}{call}->() };
                        next unless @s;
 
                        my @s=eval { $IkiWiki::hooks{getsetup}{$plugin}{call}->() };
                        next unless @s;
 

+                       if (scalar(@s) % 2 != 0) {
+                               print STDERR "warning: plugin $plugin has a broken getsetup; ignoring\n";
+                               next;
+                       }
+

                        # set default section value (note use of shared
                        # hashref between array and hash)
                        my %s=@s;
                        # set default section value (note use of shared
                        # hashref between array and hash)
                        my %s=@s;


@@ -147,16 +208,74 @@ sub getsetup () {
                } keys %sections;
 }
 
                } 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};
+               if (! defined $section) {
+                       print STDERR "warning: missing section in $plugin\n";
+                       $section="other";
+               }
+               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;
+}
+
+sub commented_dumpvalues ($$$@) {
+       my $dumpline=shift;
+       my $indent=shift;
+       my $setup=shift;
+       my @ret;
+       while (@_) {
+               my $key=shift;
+               my %info=%{shift()};

 
 

-       open (OUT, ">", $file) || die "$file: $!";
-       print OUT "$_\n" foreach @dump;
-       close OUT;
+               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
 }
 
 1