1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
|
#!/usr/bin/perl
# 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;
use warnings;
use strict;
use IkiWiki;
use open qw{:utf8 :std};
use File::Spec;
sub load ($;$) {
my $file=IkiWiki::possibly_foolish_untaint(shift);
my $safemode=shift;
$config{setupfile}=File::Spec->rel2abs($file);
#translators: The first parameter is a filename, and the second
#translators: is a (probably not translated) error message.
open (IN, $file) || error(sprintf(gettext("cannot read %s: %s"), $file, $!));
my $content;
{
local $/=undef;
$content=<IN> || error("$file: $!");
}
close IN;
if ($content=~/((?:use|require)\s+)?IkiWiki::Setup::(\w+)/) {
$config{setuptype}=$2;
if ($1) {
error sprintf(gettext("cannot load %s in safe mode"), $file)
if $safemode;
eval IkiWiki::possibly_foolish_untaint($content);
error("$file: ".$@) if $@;
}
else {
eval qq{require IkiWiki::Setup::$config{setuptype}};
error $@ if $@;
"IkiWiki::Setup::$config{setuptype}"->loaddump(IkiWiki::possibly_foolish_untaint($content));
}
}
else {
error sprintf(gettext("failed to parse %s"), $file);
}
}
sub dump ($) {
my $file=IkiWiki::possibly_foolish_untaint(shift);
eval qq{require IkiWiki::Setup::$config{setuptype}};
error $@ if $@;
my @dump="IkiWiki::Setup::$config{setuptype}"->gendump(
"Setup file for ikiwiki.",
"",
"Passing this to ikiwiki --setup will make ikiwiki generate",
"wrappers and build the wiki.",
"",
"Remember to re-run ikiwiki --setup any time you edit this file.",
);
open (OUT, ">", $file) || die "$file: $!";
print OUT "$_\n" foreach @dump;
close OUT;
}
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 commented_dump ($$) {
my $dumpline=shift;
my $indent=shift;
my %setup=(%config);
my @ret;
# disable logging to syslog while dumping
$config{syslog}=undef;
eval q{use Text::Wrap};
die $@ if $@;
my %section_plugins;
push @ret, commented_dumpvalues($dumpline, $indent, \%setup, IkiWiki::getsetup());
foreach my $pair (IkiWiki::Setup::getsetup()) {
my $plugin=$pair->[0];
my $setup=$pair->[1];
my %s=@{$setup};
my $section=$s{plugin}->{section};
push @{$section_plugins{$section}}, $plugin;
if (@{$section_plugins{$section}} == 1) {
push @ret, "", $indent.("#" x 70), "$indent# $section plugins",
sub {
wrap("$indent# (", "$indent# ",
join(", ", @{$section_plugins{$section}})).")"
},
$indent.("#" x 70);
}
my @values=commented_dumpvalues($dumpline, $indent, \%setup, @{$setup});
if (@values) {
push @ret, "", "$indent# $plugin plugin", @values;
}
}
return map { ref $_ ? $_->() : $_ } @ret;
}
sub commented_dumpvalues ($$$@) {
my $dumpline=shift;
my $indent=shift;
my $setup=shift;
my @ret;
while (@_) {
my $key=shift;
my %info=%{shift()};
next if $key eq "plugin" || $info{type} eq "internal";
push @ret, "$indent# ".$info{description} if exists $info{description};
if (exists $setup->{$key} && defined $setup->{$key}) {
push @ret, $dumpline->($key, $setup->{$key}, $info{type}, "");
delete $setup->{$key};
}
elsif (exists $info{example}) {
push @ret, $dumpline->($key, $info{example}, $info{type}, "#");
}
else {
push @ret, $dumpline->($key, "", $info{type}, "#");
}
}
return @ret;
}
1
|