Group related plugins into sections in the setup file, and drop unused rcs plugins...

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

diff --git a/IkiWiki/Setup/Standard.pm b/IkiWiki/Setup/Standard.pm
index d5135f3eb8de14acdda1d6ac37aee45d192eb6bb..c99dbb620d9473cca44bbec527c115d47a5574d5 100644 (file)
--- a/IkiWiki/Setup/Standard.pm
+++ b/IkiWiki/Setup/Standard.pm
@@ -1,47 +1,125 @@
 #!/usr/bin/perl
 # Standard ikiwiki setup module.
 # Parameters to import should be all the standard ikiwiki config stuff,
 #!/usr/bin/perl
 # Standard ikiwiki setup module.
 # Parameters to import should be all the standard ikiwiki config stuff,

-# plus hashes for cgiwrapper and svnwrapper, which specify any differing
-# config stuff for them and cause the wrappers to be made.
+# plus an array of wrappers to set up.
+
+package IkiWiki::Setup::Standard;

 
 use warnings;
 use strict;
 
 use warnings;
 use strict;

-use IkiWiki::Wrapper;
-use IkiWiki::Render;
-
-package IkiWiki::Setup::Standard;
+use IkiWiki;

 
 sub import {
 
 sub import {

-       IkiWiki::setup_standard(@_);
+       IkiWiki::Setup::merge($_[1]);

 }
 }

+
+sub dumpline ($$$$) {
+       my $key=shift;
+       my $value=shift;
+       my $type=shift;
+       my $prefix=shift;
+       
+       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;
+       # only the perl version preserves utf-8 in output
+       local $Data::Dumper::Useperl=1;

        
        

-package IkiWiki;
+       my $dumpedvalue;
+       if (($type eq 'boolean' || $type eq 'integer') && $value=~/^[0-9]+$/) {
+               # avoid quotes
+               $dumpedvalue=$value;
+       }
+       elsif (ref $value eq 'ARRAY' && @$value && ! grep { /[^\S]/ } @$value) {
+               # dump simple array as qw{}
+               $dumpedvalue="[qw{".join(" ", @$value)."}]";
+       }
+       else {
+               $dumpedvalue=Dumper($value);
+               chomp $dumpedvalue;
+               if (length $prefix) {
+                       # add to second and subsequent lines
+                       my @lines=split(/\n/, $dumpedvalue);
+                       $dumpedvalue="";
+                       for (my $x=0; $x <= $#lines; $x++) {
+                               $lines[$x] =~ s/^\t//;
+                               $dumpedvalue.="\t".($x ? $prefix : "").$lines[$x]."\n";
+                       }
+               }
+               $dumpedvalue=~s/^\t//;
+               chomp $dumpedvalue;
+       }
+       
+       return "\t$prefix$key => $dumpedvalue,";
+}

 
 

-sub setup_standard {
-       my %setup=%{$_[1]};
+sub dumpvalues ($@) {
+       my $setup=shift;
+       my @ret;
+       while (@_) {
+               my $key=shift;
+               my %info=%{shift()};

 
 

-       debug("generating wrappers..");
-       my %startconfig=(%config);
-       foreach my $wrapper (@{$setup{wrappers}}) {
-               %config=(%startconfig, verbose => 0, %setup, %{$wrapper});
-               checkoptions();
-               gen_wrapper();
+               next if $key eq "plugin" || $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};
+               }
+               elsif (exists $info{example}) {
+                       push @ret, dumpline($key, $info{example}, $info{type}, "#");
+               }
+               else {
+                       push @ret, dumpline($key, "", $info{type}, "#");
+               }

        }
        }

-       %config=(%startconfig);
+       return @ret;
+}
+
+sub gendump ($) {
+       my $description=shift;
+       my %setup=(%config);
+       my @ret;

        
        

-       debug("rebuilding wiki..");
-       foreach my $c (keys %setup) {
-               $config{$c}=possibly_foolish_untaint($setup{$c})
-                       if defined $setup{$c} && ! ref $setup{$c};
+       # 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;
+               }

        }
        }

-       $config{rebuild}=1;

 
 

-       checkoptions();
-       lockwiki();
-       refresh();
+       unshift @ret,
+               "#!/usr/bin/perl",
+               "# $description",
+               "#",
+               "# 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.",
+               "use IkiWiki::Setup::Standard {";
+       push @ret, "}";

 
 

-       debug("done");
-       saveindex();
+       return @ret;

 }
 
 1
 }
 
 1