X-Git-Url: http://git.vanrenterghem.biz/git.ikiwiki.info.git/blobdiff_plain/15341aed015e4b23d0a1171779d5baa0414c4fad..b1dade8d960ce7ccb549e5652d35a8e9dbccf5c6:/IkiWiki/Setup.pm?ds=sidebyside diff --git a/IkiWiki/Setup.pm b/IkiWiki/Setup.pm index d14be879d..3accf3591 100644 --- a/IkiWiki/Setup.pm +++ b/IkiWiki/Setup.pm @@ -1,6 +1,8 @@ #!/usr/bin/perl -# Ikiwiki setup files are perl files that 'use IkiWiki::Setup::foo', -# passing it some sort of configuration data. +# Ikiwiki setup files can be perl files that 'use IkiWiki::Setup::foo', +# passing it some sort of configuration data. Or, they can contain +# the module name at the top, without the 'use', and the whole file is +# then fed into that module. package IkiWiki::Setup; @@ -8,30 +10,48 @@ use warnings; use strict; use IkiWiki; use open qw{:utf8 :std}; +use File::Spec; -sub load ($) { # {{{ +sub load ($;$) { my $setup=IkiWiki::possibly_foolish_untaint(shift); - delete $config{setup}; + my $safemode=shift; + + $config{setupfile}=File::Spec->rel2abs($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; + my $content; { local $/=undef; - $code=; + $content= || error("$setup: $!"); } - ($code)=$code=~/(.*)/s; close IN; - eval $code; - error("$setup: ".$@) if $@; -} #}}} + if ($content=~/(use\s+)?(IkiWiki::Setup::\w+)/) { + $config{setuptype}=$2; + if ($1) { + error sprintf(gettext("cannot load %s in safe mode"), $setup) + if $safemode; + eval IkiWiki::possibly_foolish_untaint($content); + error("$setup: ".$@) if $@; + } + else { + eval qq{require $config{setuptype}}; + error $@ if $@; + $config{setuptype}->loaddump(IkiWiki::possibly_foolish_untaint($content)); + } + } + else { + error sprintf(gettext("failed to parse %s"), $setup); + } +} sub merge ($) { # Merge setup into existing config and untaint. my %setup=%{shift()}; - if (exists $setup{add_plugins}) { + if (exists $setup{add_plugins} && exists $config{add_plugins}) { push @{$setup{add_plugins}}, @{$config{add_plugins}}; } if (exists $setup{exclude}) { @@ -69,40 +89,70 @@ sub merge ($) { 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. -sub getsetup () { #{{{ - # Gets all available setup data from all plugins. Returns an ordered list of - # [plugin, setup] pairs. - my @ret; + # 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=grep { $_ ne $config{rcs} } sort(IkiWiki::listplugins()); - unshift @plugins, $config{rcs} if $config{rcs}; # rcs plugin 1st + 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; - push @ret, [ $plugin, \@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 @ret; -} #}}} + 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 ($) { #{{{ +sub dump ($) { my $file=IkiWiki::possibly_foolish_untaint(shift); - require IkiWiki::Setup::Standard; - my @dump=IkiWiki::Setup::Standard::gendump("Setup file for ikiwiki."); + eval qq{require $config{setuptype}}; + error $@ if $@; + my @dump=$config{setuptype}->gendump("Setup file for ikiwiki."); open (OUT, ">", $file) || die "$file: $!"; print OUT "$_\n" foreach @dump;