2 package IkiWiki::Plugin::websetup;
9 hook(type => "getsetup", id => "websetup", call => \&getsetup);
10 hook(type => "checkconfig", id => "websetup", call => \&checkconfig);
11 hook(type => "sessioncgi", id => "websetup", call => \&sessioncgi);
12 hook(type => "formbuilder_setup", id => "websetup",
13 call => \&formbuilder_setup);
22 websetup_force_plugins => {
25 description => "list of plugins that cannot be enabled/disabled via the web interface",
29 websetup_show_unsafe => {
32 description => "show unsafe settings, read-only, in web interface?",
39 if (! exists $config{websetup_show_unsafe}) {
40 $config{websetup_show_unsafe}=1;
44 sub formatexample ($$) {
48 if (defined $value && length $value) {
51 elsif (defined $example && ! ref $example && length $example) {
52 return "<br/ ><small>Example: <tt>$example</tt></small>";
59 sub showfields ($$$@) {
70 # skip internal settings
71 next if defined $info{type} && $info{type} eq "internal";
72 # XXX hashes not handled yet
73 next if ref $config{$key} && ref $config{$key} eq 'HASH' || ref $info{example} eq 'HASH';
74 # maybe skip unsafe settings
75 next if ! $info{safe} && ! ($config{websetup_show_unsafe} && $config{websetup_advanced});
76 # maybe skip advanced settings
77 next if $info{advanced} && ! $config{websetup_advanced};
78 # these are handled specially, so don't show
79 next if $key eq 'add_plugins' || $key eq 'disable_plugins';
81 if ($key eq 'plugin') {
86 push @show, $key, \%info;
89 my $section=defined $plugin ? $plugin." ".gettext("plugin") : "main";
93 my $plugin_forced=defined $plugin && (! $plugininfo{safe} ||
94 (exists $config{websetup_force_plugins} && grep { $_ eq $plugin } @{$config{websetup_force_plugins}}));
95 if ($plugin_forced && ! $enabled) {
96 # plugin is forced disabled, so skip its settings
101 if (defined $plugin && (! $plugin_forced || $config{websetup_advanced})) {
102 my $name="enable.$plugin";
107 fieldset => $section,
108 options => [ [ 1 => sprintf(gettext("enable %s?"), $plugin) ]]
110 if (! $form->submitted) {
111 $form->field(name => $name, value => $enabled);
113 if ($plugin_forced) {
114 $form->field(name => $name, disabled => 1);
117 $enabledfields{$name}=[$name, \%plugininfo];
121 # show plugin settings
124 my %info=%{shift @show};
126 my $description=$info{description};
127 if (exists $info{link} && length $info{link}) {
128 if ($info{link} =~ /^\w+:\/\//) {
129 $description="<a href=\"$info{link}\">$description</a>";
132 $description=htmllink("", "", $info{link}, noimageinline => 1, linktext => $description);
136 # multiple plugins can have the same field
137 my $name=defined $plugin ? $plugin.".".$key : $section.".".$key;
139 my $value=$config{$key};
141 if ($info{safe} && defined $value &&
142 (ref $value eq 'ARRAY' || ref $info{example} eq 'ARRAY')) {
143 $value=[@{$value}, "", ""]; # blank items for expansion
146 if ($info{type} eq "string") {
149 label => $description,
150 comment => formatexample($info{example}, $value),
154 fieldset => $section,
157 elsif ($info{type} eq "pagespec") {
160 label => $description,
161 comment => formatexample($info{example}, $value),
165 validate => \&IkiWiki::pagespec_valid,
166 fieldset => $section,
169 elsif ($info{type} eq "integer") {
172 label => $description,
173 comment => formatexample($info{example}, $value),
177 validate => '/^[0-9]+$/',
178 fieldset => $section,
181 elsif ($info{type} eq "boolean") {
186 options => [ [ 1 => $description ] ],
187 fieldset => $section,
189 if (! $form->submitted) {
190 $form->field(name => $name, value => $value);
195 $form->field(name => $name, disabled => 1);
198 $enabledfields{$name}=[$key, \%info];
203 # if no fields were shown for the plugin, drop it into the
205 if (defined $plugin && (! $plugin_forced || $config{websetup_advanced}) &&
207 $form->field(name => "enable.$plugin", fieldset => "plugins");
210 return %enabledfields;
213 sub enable_plugin ($) {
216 $config{disable_plugins}=[grep { $_ ne $plugin } @{$config{disable_plugins}}];
217 push @{$config{add_plugins}}, $plugin;
220 sub disable_plugin ($) {
223 if (grep { $_ eq $plugin } @{$config{add_plugins}}) {
224 $config{add_plugins}=[grep { $_ ne $plugin } @{$config{add_plugins}}];
227 push @{$config{disable_plugins}}, $plugin;
235 if (! defined $session->param("name") ||
236 ! IkiWiki::is_admin($session->param("name"))) {
237 error(gettext("you are not logged in as an admin"));
240 if (! exists $config{setupfile}) {
241 error(gettext("setup file for this wiki is not known"));
244 eval q{use CGI::FormBuilder};
247 my $form = CGI::FormBuilder->new(
257 [main => gettext("main")],
258 [plugins => gettext("plugins")]
260 action => $config{cgiurl},
261 template => {type => 'div'},
262 stylesheet => IkiWiki::baseurl()."style.css",
265 $form->field(name => "do", type => "hidden", value => "setup",
267 $form->field(name => "rebuild_asked", type => "hidden");
269 if ($form->submitted eq 'Basic Mode') {
270 $form->field(name => "showadvanced", type => "hidden",
271 value => 0, force => 1);
273 elsif ($form->submitted eq 'Advanced Mode') {
274 $form->field(name => "showadvanced", type => "hidden",
275 value => 1, force => 1);
278 if ($form->field("showadvanced")) {
279 $config{websetup_advanced}=1;
280 $advancedtoggle="Basic Mode";
283 $config{websetup_advanced}=0;
284 $advancedtoggle="Advanced Mode";
287 my $buttons=["Save Setup", $advancedtoggle, "Cancel"];
289 IkiWiki::decode_form_utf8($form);
290 IkiWiki::run_hooks(formbuilder_setup => sub {
291 shift->(form => $form, cgi => $cgi, session => $session,
292 buttons => $buttons);
294 IkiWiki::decode_form_utf8($form);
296 my %fields=showfields($form, undef, undef, IkiWiki::getsetup());
298 # record all currently enabled plugins before all are loaded
299 my %enabled_plugins=%IkiWiki::loaded_plugins;
302 require IkiWiki::Setup;
303 foreach my $pair (IkiWiki::Setup::getsetup()) {
304 my $plugin=$pair->[0];
305 my $setup=$pair->[1];
307 my %shown=showfields($form, $plugin, $enabled_plugins{$plugin}, @{$setup});
309 $fields{$_}=$shown{$_} foreach keys %shown;
313 if ($form->submitted eq "Cancel") {
314 IkiWiki::redirect($cgi, $config{url});
317 elsif (($form->submitted eq 'Save Setup' || $form->submitted eq 'Rebuild Wiki') && $form->validate) {
318 # Push values from form into %config, avoiding unnecessary
319 # changes, and keeping track of which changes need a
322 foreach my $field (keys %fields) {
323 my %info=%{$fields{$field}->[1]};
324 my $key=$fields{$field}->[0];
325 my @value=$form->field($field);
331 error("unsafe field $key"); # should never happen
334 if (exists $info{rebuild} &&
335 ($info{rebuild} || ! defined $info{rebuild})) {
336 $rebuild{$field}=$info{rebuild};
339 if ($field=~/^enable\.(.*)/) {
341 $value[0]=0 if ! length $value[0];
342 if ($value[0] != exists $enabled_plugins{$plugin}) {
344 enable_plugin($plugin);
347 disable_plugin($plugin);
352 delete $rebuild{$field};
357 if (ref $config{$key} eq "ARRAY" || ref $info{example} eq "ARRAY") {
358 @value=sort grep { length $_ } @value;
359 my @oldvalue=sort grep { length $_ }
360 (defined $config{$key} ? @{$config{$key}} : ());
361 if ((@oldvalue) == (@value)) {
362 delete $rebuild{$field};
365 $config{$key}=\@value;
368 elsif (ref $config{$key} || ref $info{example}) {
369 error("complex field $key"); # should never happen
372 if (defined $config{$key} && $config{$key} eq $value[0]) {
373 delete $rebuild{$field};
375 elsif (! defined $config{$key} && ! length $value[0]) {
376 delete $rebuild{$field};
378 elsif ((! defined $config{$key} || ! $config{$key}) &&
379 ! $value[0] && $info{type} eq "boolean") {
380 delete $rebuild{$field};
383 $config{$key}=$value[0];
388 if (%rebuild && ! $form->field("rebuild_asked")) {
390 foreach my $field ($form->field) {
391 $required=1 if $rebuild{$field};
392 next if exists $rebuild{$field};
393 $form->field(name => $field, type => "hidden");
396 $form->text(gettext("The configuration changes shown below require a wiki rebuild to take effect."));
397 $buttons=["Rebuild Wiki", "Cancel"];
400 $form->text(gettext("For the configuration changes shown below to fully take effect, you may need to rebuild the wiki."));
401 $buttons=["Rebuild Wiki", "Save Setup", "Cancel"];
403 $form->field(name => "rebuild_asked", value => 1, force => 1);
404 $form->reset(0); # doesn't really make sense here
407 IkiWiki::Setup::dump($config{setupfile});
409 IkiWiki::saveindex();
410 IkiWiki::unlockwiki();
412 # Print the top part of a standard misctemplate,
413 # then show the rebuild or refresh.
415 my $html=IkiWiki::misctemplate("setup", $divider);
416 IkiWiki::printheader($session);
417 my ($head, $tail)=split($divider, $html, 2);
418 print $head."<pre>\n";
421 if ($form->submitted eq 'Rebuild Wiki') {
422 @command=("ikiwiki", "-setup", $config{setupfile},
426 @command=("ikiwiki", "-setup", $config{setupfile},
427 "-refresh", "-wrappers", "-v");
430 my $ret=system(@command);
433 print '<p class="error">'.
434 sprintf(gettext("<p class=\"error\">Error: %s exited nonzero (%s)"),
435 join(" ", @command), $ret).
444 IkiWiki::showform($form, $buttons, $session, $cgi);
447 sub sessioncgi ($$) {
451 if ($cgi->param("do") eq "setup") {
452 showform($cgi, $session);
457 sub formbuilder_setup (@) {
460 my $form=$params{form};
461 if ($form->title eq "preferences") {
462 push @{$params{buttons}}, "Wiki Setup";
463 if ($form->submitted && $form->submitted eq "Wiki Setup") {
464 showform($params{cgi}, $params{session});