X-Git-Url: https://sipb.mit.edu/gitweb.cgi/ikiwiki.git/blobdiff_plain/aa1f0080a81ac253ae4ff8822132327ee29fe835..12eb585353660d121e48d5796d35354b66c7e522:/IkiWiki/Setup.pm diff --git a/IkiWiki/Setup.pm b/IkiWiki/Setup.pm index a37264cd7..77afdd608 100644 --- a/IkiWiki/Setup.pm +++ b/IkiWiki/Setup.pm @@ -1,23 +1,19 @@ #!/usr/bin/perl # Ikiwiki setup files are perl files that 'use IkiWiki::Setup::foo', # passing it some sort of configuration data. -# -# 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. package IkiWiki::Setup; + use warnings; use strict; use IkiWiki; use open qw{:utf8 :std}; - -our $raw_setup; +use File::Spec; sub load ($) { # {{{ my $setup=IkiWiki::possibly_foolish_untaint(shift); - delete $config{setup}; + $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, $!)); @@ -31,55 +27,35 @@ sub load ($) { # {{{ eval $code; error("$setup: ".$@) if $@; - - my $ret=$raw_setup; - $raw_setup=undef; - - return %$ret; } #}}} -package IkiWiki; - -sub setup () { #{{{ - my %setup=IkiWiki::Setup::load($config{setup}); +sub merge ($) { + # Merge setup into existing config and untaint. + my %setup=%{shift()}; - $setup{plugin}=$config{plugin}; - if (exists $setup{add_plugins}) { - push @{$setup{plugin}}, @{$setup{add_plugins}}; - delete $setup{add_plugins}; + 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}; } - - 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(); - } - %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}); + if (! ref $setup{$c} || ref $setup{$c} eq 'Regexp') { + $config{$c}=IkiWiki::possibly_foolish_untaint($setup{$c}); } elsif (ref $setup{$c} eq 'ARRAY') { - $config{$c}=[map { possibly_foolish_untaint($_) } @{$setup{$c}}] + 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}=possibly_foolish_untaint($setup{$c}{$key}); + $config{$c}{$key}=IkiWiki::possibly_foolish_untaint($setup{$c}{$key}); } } } @@ -88,30 +64,58 @@ sub setup () { #{{{ } } - if (! $config{refresh}) { - $config{rebuild}=1; + if (length $config{cgi_wrapper}) { + push @{$config{wrappers}}, { + cgi => 1, + wrapper => $config{cgi_wrapper}, + wrappermode => (defined $config{cgi_wrappermode} ? $config{cgi_wrappermode} : "06755"), + }; } - - loadplugins(); - checkconfig(); +} #}}} - if ($config{render}) { - commandline_render(); - } +sub getsetup () { #{{{ + # Gets all available setup data from all plugins. Returns an + # ordered list of [plugin, setup] pairs. + my @ret; - if (! $config{refresh}) { - debug(gettext("rebuilding wiki..")); - } - else { - debug(gettext("refreshing wiki..")); + # 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 + foreach my $plugin (@plugins) { + eval { IkiWiki::loadplugin($plugin) }; + if (exists $IkiWiki::hooks{checkconfig}{$plugin}{call}) { + my @s=eval { $IkiWiki::hooks{checkconfig}{$plugin}{call}->() }; + } } - lockwiki(); - loadindex(); - refresh(); + 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 ], + } + } + + $config{syslog}=$syslog; - debug(gettext("done")); - saveindex(); + return @ret; } #}}} +sub dump ($) { #{{{ + my $file=IkiWiki::possibly_foolish_untaint(shift); + + require IkiWiki::Setup::Standard; + my @dump=IkiWiki::Setup::Standard::gendump("Setup file for ikiwiki."); + + open (OUT, ">", $file) || die "$file: $!"; + print OUT "$_\n" foreach @dump; + close OUT; +} + 1