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

[ikiwiki.git] / IkiWiki / Setup.pm

diff --git a/IkiWiki/Setup.pm b/IkiWiki/Setup.pm
index 560bc798bf4cd03da85e16eeb97aeed4d72125a5..b67d1a45417149758f7b6ce2cfc882ba02ed51af 100644 (file)
--- a/IkiWiki/Setup.pm
+++ b/IkiWiki/Setup.pm
@@ -1,15 +1,25 @@
 #!/usr/bin/perl
+# Ikiwiki setup files are perl files that 'use IkiWiki::Setup::foo',
+# passing it some sort of configuration data.
+
+package IkiWiki::Setup;
 
 use warnings;
 use strict;
 use IkiWiki;
 use open qw{:utf8 :std};
 
-package IkiWiki;
+# There can be multiple modules, with different configuration styles.
+# The setup modules each convert the data into the hashes used by ikiwiki
+# internally (if it's not already in that format), and store it in
+# IkiWiki::Setup::$raw_setup, to pass it back to this module.
+our $raw_setup;
 
-sub setup () { # {{{
-       my $setup=possibly_foolish_untaint($config{setup});
+sub load ($) { # {{{
+       my $setup=IkiWiki::possibly_foolish_untaint(shift);
        delete $config{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;
        {
@@ -20,9 +30,38 @@ sub setup () { # {{{
        close IN;
 
        eval $code;
-       error($@) if $@;
+       error("$setup: ".$@) if $@;
+
+       my %setup=%{$raw_setup};
+       $raw_setup=undef;
 
-       exit;
+       # Merge setup into existing config and untaint.
+       $setup{plugin}=$config{plugin};
+       if (exists $setup{add_plugins}) {
+               push @{$setup{plugin}}, @{$setup{add_plugins}};
+               delete $setup{add_plugins};
+       }
+       if (exists $setup{exclude}) {
+               push @{$config{wiki_file_prune_regexps}}, $setup{exclude};
+       }
+       foreach my $c (keys %setup) {
+               if (defined $setup{$c}) {
+                       if (! ref $setup{$c}) {
+                               $config{$c}=IkiWiki::possibly_foolish_untaint($setup{$c});
+                       }
+                       elsif (ref $setup{$c} eq 'ARRAY') {
+                               $config{$c}=[map { IkiWiki::possibly_foolish_untaint($_) } @{$setup{$c}}]
+                       }
+                       elsif (ref $setup{$c} eq 'HASH') {
+                               foreach my $key (keys %{$setup{$c}}) {
+                                       $config{$c}{$key}=IkiWiki::possibly_foolish_untaint($setup{$c}{$key});
+                               }
+                       }
+               }
+               else {
+                       $config{$c}=undef;
+               }
+       }
 } #}}}
 
 1