layout

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

diff --git a/IkiWiki/Setup.pm b/IkiWiki/Setup.pm
index 2d6e1d1cffe082315e3f64493c570e86c7d39649..a3fd5ce66466f45e1480776e31be39ece90f592b 100644 (file)
--- a/IkiWiki/Setup.pm
+++ b/IkiWiki/Setup.pm
@@ -1,30 +1,144 @@
 #!/usr/bin/perl
 #!/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};
 
 use warnings;
 use strict;
 use IkiWiki;
 use open qw{:utf8 :std};

+use File::Spec;

 
 

-package IkiWiki;
+sub load ($) {
+       my $setup=IkiWiki::possibly_foolish_untaint(shift);
+       $config{setupfile}=File::Spec->rel2abs($setup);

 
 

-sub setup () { # {{{
-       my $setup=possibly_foolish_untaint($config{setup});
-       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;
        {
                local $/=undef;
        #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;
        {
                local $/=undef;

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

        }
        }

+       

        ($code)=$code=~/(.*)/s;
        close IN;
 
        eval $code;
        ($code)=$code=~/(.*)/s;
        close IN;
 
        eval $code;

-       error($@) if $@;
+       error("$setup: ".$@) if $@;
+}
+
+sub merge ($) {
+       # Merge setup into existing config and untaint.
+       my %setup=%{shift()};
+
+       if (exists $setup{add_plugins} && exists $config{add_plugins}) {
+               push @{$setup{add_plugins}}, @{$config{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} || ref $setup{$c} eq 'Regexp') {
+                               $config{$c}=IkiWiki::possibly_foolish_untaint($setup{$c});
+                       }
+                       elsif (ref $setup{$c} eq 'ARRAY') {
+                               if ($c eq 'wrappers') {
+                                       # backwards compatability code
+                                       $config{$c}=$setup{$c};
+                               }
+                               else {
+                                       $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;
+               }
+       }
+       
+       if (length $config{cgi_wrapper}) {
+               push @{$config{wrappers}}, {
+                       cgi => 1,
+                       wrapper => $config{cgi_wrapper},
+                       wrappermode => (defined $config{cgi_wrappermode} ? $config{cgi_wrappermode} : "06755"),
+               };
+       }
+}
+
+sub getsetup () {
+       # Gets all available setup data from all plugins. Returns an
+       # ordered list of [plugin, setup] pairs.
+
+        # disable logging to syslog while dumping, broken plugins may
+       # whine when loaded
+       my $syslog=$config{syslog};
+        $config{syslog}=undef;
+
+       # Load all plugins, so that all setup options are available.
+       my @plugins=IkiWiki::listplugins();
+       foreach my $plugin (@plugins) {
+               eval { IkiWiki::loadplugin($plugin) };
+               if (exists $IkiWiki::hooks{checkconfig}{$plugin}{call}) {
+                       my @s=eval { $IkiWiki::hooks{checkconfig}{$plugin}{call}->() };
+               }
+       }
+       
+       my %sections;
+       foreach my $plugin (@plugins) {
+               if (exists $IkiWiki::hooks{getsetup}{$plugin}{call}) {
+                       # use an array rather than a hash, to preserve order
+                       my @s=eval { $IkiWiki::hooks{getsetup}{$plugin}{call}->() };
+                       next unless @s;
+
+                       # set default section value (note use of shared
+                       # hashref between array and hash)
+                       my %s=@s;
+                       if (! exists $s{plugin} || ! $s{plugin}->{section}) {
+                               $s{plugin}->{section}="other";
+                       }
+
+                       # only the selected rcs plugin is included
+                       if ($config{rcs} && $plugin eq $config{rcs}) {
+                               $s{plugin}->{section}="core";
+                       }
+                       elsif ($s{plugin}->{section} eq "rcs") {
+                               next;
+                       }
+
+                       push @{$sections{$s{plugin}->{section}}}, [ $plugin, \@s ];
+               }
+       }
+       
+        $config{syslog}=$syslog;
+
+       return map { sort { $a->[0] cmp $b->[0] } @{$sections{$_}} }
+               sort { # core first, other last, otherwise alphabetical
+                       ($b eq "core") <=> ($a eq "core")
+                          ||
+                       ($a eq "other") <=> ($b eq "other")
+                          ||
+                       $a cmp $b
+               } keys %sections;
+}
+
+sub dump ($) {
+       my $file=IkiWiki::possibly_foolish_untaint(shift);
+       
+       require IkiWiki::Setup::Standard;
+       my @dump=IkiWiki::Setup::Standard::gendump("Setup file for ikiwiki.");

 
 

-       exit;
-} #}}}
+       open (OUT, ">", $file) || die "$file: $!";
+       print OUT "$_\n" foreach @dump;
+       close OUT;
+}

 
 1
 
 1