ikiwiki/IkiWiki/Setup.pm

145 lines
3.6 KiB
Perl
Raw Normal View History

#!/usr/bin/perl
2008-07-10 04:47:06 +02:00
# 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};
2008-08-06 02:11:23 +02:00
use File::Spec;
sub load ($) {
my $setup=IkiWiki::possibly_foolish_untaint(shift);
$config{setupfile}=File::Spec->rel2abs($setup);
2007-01-04 13:00:23 +01:00
#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, $!));
2006-03-24 03:42:19 +01:00
my $code;
{
local $/=undef;
$code=<IN> || error("$setup: $!");
2006-03-24 03:42:19 +01:00
}
($code)=$code=~/(.*)/s;
close IN;
eval $code;
error("$setup: ".$@) if $@;
}
sub merge ($) {
2008-08-02 19:38:45 +02:00
# Merge setup into existing config and untaint.
my %setup=%{shift()};
2008-09-01 04:11:59 +02:00
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') {
2008-07-26 18:46:31 +02:00
$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}}) {
2008-07-26 18:46:31 +02:00
$config{$c}{$key}=IkiWiki::possibly_foolish_untaint($setup{$c}{$key});
}
}
}
else {
$config{$c}=undef;
}
}
2008-07-27 03:14:07 +02:00
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 () {
2008-08-03 22:23:41 +02:00
# Gets all available setup data from all plugins. Returns an
# ordered list of [plugin, setup] pairs.
2008-08-02 19:38:45 +02:00
2008-08-03 22:23:41 +02:00
# disable logging to syslog while dumping, broken plugins may
# whine when loaded
my $syslog=$config{syslog};
$config{syslog}=undef;
2008-08-02 19:38:45 +02:00
# Load all plugins, so that all setup options are available.
my @plugins=IkiWiki::listplugins();
2008-08-02 19:38:45 +02:00
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;
2008-08-02 19:38:45 +02:00
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}) {
2010-02-12 06:22:00 +01:00
$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 ];
2008-08-02 19:38:45 +02:00
}
}
$config{syslog}=$syslog;
2008-08-02 19:38:45 +02:00
return map { sort { $a->[0] cmp $b->[0] } @{$sections{$_}} }
2010-02-12 12:35:52 +01:00
sort { # core first, other last, otherwise alphabetical
($b eq "core") <=> ($a eq "core")
||
2010-02-12 12:35:52 +01:00
($a eq "other") <=> ($b eq "other")
||
$a cmp $b
} keys %sections;
}
2008-08-02 19:38:45 +02:00
sub dump ($) {
2008-07-26 21:39:41 +02:00
my $file=IkiWiki::possibly_foolish_untaint(shift);
require IkiWiki::Setup::Standard;
2008-07-26 21:43:25 +02:00
my @dump=IkiWiki::Setup::Standard::gendump("Setup file for ikiwiki.");
2008-07-26 21:39:41 +02:00
open (OUT, ">", $file) || die "$file: $!";
2008-07-26 21:43:25 +02:00
print OUT "$_\n" foreach @dump;
2008-07-26 21:39:41 +02:00
close OUT;
}
1