add info for all common setup file options, and most internal ones

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

diff --git a/IkiWiki/Setup/Standard.pm b/IkiWiki/Setup/Standard.pm
index 87db648e0accc2c177f2f55e8c6dc712863a0326..d88dc9e1c266aada900195c0e9c33d0db5fd5fd5 100644 (file)
--- a/IkiWiki/Setup/Standard.pm
+++ b/IkiWiki/Setup/Standard.pm
@@ -3,86 +3,100 @@
 # Parameters to import should be all the standard ikiwiki config stuff,
 # plus an array of wrappers to set up.
 
+package IkiWiki::Setup::Standard;
+
 use warnings;
 use strict;
-use IkiWiki::Wrapper;
-use IkiWiki::Render;
+use IkiWiki;
 
-package IkiWiki::Setup::Standard;
+sub import { #{{{
+       $IkiWiki::Setup::raw_setup=$_[1];
+} #}}}
 
-sub import {
-       IkiWiki::setup_standard(@_);
-}
+sub dumpline ($$$$) { #{{{
+       my $key=shift;
+       my $value=shift;
+       my $type=shift;
+       my $prefix=shift;
        
-package IkiWiki;
-
-sub setup_standard {
-       my %setup=%{$_[1]};
-
-       $setup{plugin}=$config{plugin};
-       if (exists $setup{add_plugins}) {
-               push @{$setup{plugin}}, @{$setup{add_plugins}};
-               delete $setup{add_plugins};
+       eval q{use Data::Dumper};
+       error($@) if $@;
+       local $Data::Dumper::Terse=1;
+       local $Data::Dumper::Indent=1;
+       local $Data::Dumper::Pad="\t";
+       local $Data::Dumper::Sortkeys=1;
+       local $Data::Dumper::Quotekeys=0;
+       
+       my $dumpedvalue;
+       if ($type eq 'boolean' || $type eq 'integer') {
+               $dumpedvalue=$value;
        }
-       if (exists $setup{exclude}) {
-               push @{$config{wiki_file_prune_regexps}}, $setup{exclude};
+       else {
+               $dumpedvalue=Dumper($value);
+               chomp $dumpedvalue;
+               $dumpedvalue=~s/^\t//;
        }
+       
+       return "\t$prefix$key=$dumpedvalue,";
+} #}}}
+
+sub dumpvalues ($@) { #{{{
+       my $setup=shift;
+       my @ret;
+       while (@_) {
+               my $key=shift;
+               my %info=%{shift()};
 
-       if (! $config{render} && (! $config{refresh} || $config{wrappers})) {
-               debug(gettext("generating wrappers.."));
-               my @wrappers=@{$setup{wrappers}};
-               delete $setup{wrappers};
-               my %startconfig=(%config);
-               foreach my $wrapper (@wrappers) {
-                       %config=(%startconfig, rebuild => 0, verbose => 0, %setup, %{$wrapper});
-                       checkconfig();
-                       if (! $config{cgi} && ! $config{post_commit}) {
-                               $config{post_commit}=1;
-                       }
-                       gen_wrapper();
+               next if $info{type} eq "internal";
+               
+               push @ret, "\t# ".$info{description} if exists $info{description};
+               
+               if (exists $setup->{$key} && defined $setup->{$key}) {
+                       push @ret, dumpline($key, $setup->{$key}, $info{type}, "");
+                       delete $setup->{$key};
                }
-               %config=(%startconfig);
-       }
-       
-       foreach my $c (keys %setup) {
-               next if $c eq 'syslog';
-               if (defined $setup{$c}) {
-                       if (! ref $setup{$c}) {
-                               $config{$c}=possibly_foolish_untaint($setup{$c});
-                       }
-                       elsif (ref $setup{$c} eq 'ARRAY') {
-                               $config{$c}=[map { possibly_foolish_untaint($_) } @{$setup{$c}}]
-                       }
-                       elsif (ref $setup{$c} eq 'HASH') {
-                               foreach my $key (keys %{$setup{$c}}) {
-                                       $config{$c}{$key}=possibly_foolish_untaint($setup{$c}{$key});
-                               }
-                       }
+               elsif (exists $info{default} && defined $info{default}) {
+                       push @ret, dumpline($key, $info{default}, $info{type}, "#");
                }
-               else {
-                       $config{$c}=undef;
+               elsif (exists $info{example}) {
+                       push @ret, dumpline($key, $info{example}, $info{type}, "#");
                }
        }
+       return @ret;
+} #}}}
 
-       if ($config{render}) {
-               commandline_render();
-       }
-       elsif (! $config{refresh}) {
-               $config{rebuild}=1;
-               debug(gettext("rebuilding wiki.."));
-       }
-       else {
-               debug(gettext("refreshing wiki.."));
+sub dump ($) { #{{{
+       my $file=IkiWiki::possibly_foolish_untaint(shift);
+       
+       my %setup=(%config);
+       my @ret;
+       
+       push @ret, "\t# basic setup";
+       push @ret, dumpvalues(\%setup, IkiWiki::getsetup());
+       push @ret, "";
+
+       foreach my $id (sort keys %{$IkiWiki::hooks{getsetup}}) {
+               # use an array rather than a hash, to preserve order
+               my @s=$IkiWiki::hooks{getsetup}{$id}{call}->();
+               return unless @s;
+               push @ret, "\t# $id plugin";
+               push @ret, dumpvalues(\%setup, @s);
+               push @ret, "";
        }
+       
+       unshift @ret, "#!/usr/bin/perl
+# 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.
 
-       loadplugins();
-       checkconfig();
-       lockwiki();
-       loadindex();
-       refresh();
+use IkiWiki::Setup::Standard {";
+       push @ret, "}";
 
-       debug(gettext("done"));
-       saveindex();
-}
+       open (OUT, ">", $file) || die "$file: $!";
+       print OUT "$_\n" foreach @ret;
+       close OUT;
+} #}}}
 
 1