ikiwiki/IkiWiki/Plugin/websetup.pm

515 lines
13 KiB
Perl
Raw Normal View History

2008-08-02 19:27:58 +02:00
#!/usr/bin/perl
package IkiWiki::Plugin::websetup;
use warnings;
use strict;
use IkiWiki 3.00;
2008-08-02 19:27:58 +02:00
sub import {
2008-08-02 22:40:46 +02:00
hook(type => "getsetup", id => "websetup", call => \&getsetup);
hook(type => "checkconfig", id => "websetup", call => \&checkconfig);
2008-08-02 22:40:46 +02:00
hook(type => "sessioncgi", id => "websetup", call => \&sessioncgi);
hook(type => "formbuilder_setup", id => "websetup",
2008-08-02 19:27:58 +02:00
call => \&formbuilder_setup);
}
2008-08-02 19:27:58 +02:00
sub getsetup () {
2008-08-02 22:40:46 +02:00
return
plugin => {
safe => 1,
rebuild => 0,
2010-02-12 10:22:15 +01:00
section => "web",
},
2008-08-02 22:40:46 +02:00
websetup_force_plugins => {
type => "string",
2008-08-03 05:59:40 +02:00
example => [],
2008-08-02 22:40:46 +02:00
description => "list of plugins that cannot be enabled/disabled via the web interface",
safe => 0,
rebuild => 0,
},
websetup_unsafe => {
type => "string",
example => [],
description => "list of additional setup field keys to treat as unsafe",
safe => 0,
rebuild => 0,
},
websetup_show_unsafe => {
type => "boolean",
example => 1,
description => "show unsafe settings, read-only, in web interface?",
safe => 0,
rebuild => 0,
},
}
sub checkconfig () {
if (! exists $config{websetup_show_unsafe}) {
$config{websetup_show_unsafe}=1;
}
}
2008-08-02 22:40:46 +02:00
sub formatexample ($$) {
2008-08-02 22:40:46 +02:00
my $example=shift;
my $value=shift;
2008-08-02 22:40:46 +02:00
if (defined $value && length $value) {
return "";
}
elsif (defined $example && ! ref $example && length $example) {
2008-08-02 22:40:46 +02:00
return "<br/ ><small>Example: <tt>$example</tt></small>";
}
else {
return "";
}
}
2008-08-02 22:40:46 +02:00
sub issafe ($) {
my $key=shift;
return ! grep { $_ eq $key } @{$config{websetup_unsafe}};
}
sub showfields ($$$@) {
2008-08-02 20:35:23 +02:00
my $form=shift;
2008-08-02 22:40:46 +02:00
my $plugin=shift;
my $enabled=shift;
2008-08-02 20:35:23 +02:00
2008-08-02 22:40:46 +02:00
my @show;
2008-08-03 22:23:41 +02:00
my %plugininfo;
2008-08-02 20:35:23 +02:00
while (@_) {
my $key=shift;
my %info=%{shift()};
if ($key eq 'plugin') {
%plugininfo=%info;
next;
}
2008-08-02 20:35:23 +02:00
2008-08-03 06:27:27 +02:00
# skip internal settings
2008-08-03 22:23:41 +02:00
next if defined $info{type} && $info{type} eq "internal";
2008-08-03 06:27:27 +02:00
# XXX hashes not handled yet
next if ref $config{$key} && ref $config{$key} eq 'HASH' || ref $info{example} eq 'HASH';
# maybe skip unsafe settings
next if ! ($config{websetup_show_unsafe} && $config{websetup_advanced}) &&
(! $info{safe} || ! issafe($key));
2008-08-03 20:57:24 +02:00
# maybe skip advanced settings
next if $info{advanced} && ! $config{websetup_advanced};
2008-08-02 22:40:46 +02:00
# these are handled specially, so don't show
next if $key eq 'add_plugins' || $key eq 'disable_plugins';
2008-08-03 22:23:41 +02:00
2008-08-02 22:40:46 +02:00
push @show, $key, \%info;
}
2008-08-02 20:35:23 +02:00
my $section=defined $plugin
2010-05-03 04:43:55 +02:00
? sprintf(gettext("%s plugin:"), $plugininfo{section})." ".$plugin
: "main";
my %enabledfields;
my $shownfields=0;
2008-08-03 22:23:41 +02:00
my $plugin_forced=defined $plugin && (! $plugininfo{safe} ||
(exists $config{websetup_force_plugins} && grep { $_ eq $plugin } @{$config{websetup_force_plugins}}));
if ($plugin_forced && ! $enabled) {
# plugin is forced disabled, so skip its settings
@show=();
2008-08-02 22:40:46 +02:00
}
my $section_fieldset;
if (defined $plugin) {
# Define the combined fieldset for the plugin's section.
# This ensures that this fieldset comes first.
$section_fieldset=sprintf(gettext("%s plugins"), $plugininfo{section});
$form->field(name => "placeholder.$plugininfo{section}",
type => "hidden",
fieldset => $section_fieldset);
}
# show plugin toggle
if (defined $plugin && (! $plugin_forced || $config{websetup_advanced})) {
my $name="enable.$plugin";
$form->field(
name => $name,
2008-08-04 02:51:46 +02:00
label => "",
type => "checkbox",
fieldset => $section,
2008-08-04 02:51:46 +02:00
options => [ [ 1 => sprintf(gettext("enable %s?"), $plugin) ]]
);
2008-08-04 02:51:46 +02:00
if (! $form->submitted) {
$form->field(name => $name, value => $enabled);
}
if ($plugin_forced) {
$form->field(name => $name, disabled => 1);
}
else {
$enabledfields{$name}=[$name, \%plugininfo];
}
}
2008-08-02 22:40:46 +02:00
# show plugin settings
2008-08-02 22:40:46 +02:00
while (@show) {
my $key=shift @show;
my %info=%{shift @show};
2008-08-02 20:35:23 +02:00
2008-08-03 20:36:17 +02:00
my $description=$info{description};
if (exists $info{link} && length $info{link}) {
if ($info{link} =~ /^\w+:\/\//) {
$description="<a href=\"$info{link}\">$description</a>";
}
else {
$description=htmllink("", "", $info{link}, noimageinline => 1, linktext => $description);
}
}
# multiple plugins can have the same field
my $name=defined $plugin ? $plugin.".".$key : $section.".".$key;
2008-08-02 22:40:46 +02:00
my $value=$config{$key};
if (! defined $value) {
$value="";
}
if (ref $value eq 'ARRAY' || ref $info{example} eq 'ARRAY') {
$value=[(ref $value eq 'ARRAY' ? map { Encode::encode_utf8($_) } @{$value} : "")];
push @$value, "", "" if $info{safe} && issafe($key); # blank items for expansion
2010-01-09 22:20:09 +01:00
}
else {
$value=Encode::encode_utf8($value);
}
if ($info{type} eq "string") {
2008-08-02 20:35:23 +02:00
$form->field(
name => $name,
label => $description,
comment => formatexample($info{example}, $value),
2008-08-02 20:35:23 +02:00
type => "text",
value => $value,
size => 60,
fieldset => $section,
);
}
2008-08-02 22:40:46 +02:00
elsif ($info{type} eq "pagespec") {
$form->field(
name => $name,
label => $description,
comment => formatexample($info{example}, $value),
2008-08-02 22:40:46 +02:00
type => "text",
value => $value,
size => 60,
validate => \&IkiWiki::pagespec_valid,
fieldset => $section,
);
}
2008-08-02 20:35:23 +02:00
elsif ($info{type} eq "integer") {
$form->field(
name => $name,
label => $description,
comment => formatexample($info{example}, $value),
2008-08-02 20:35:23 +02:00
type => "text",
value => $value,
2008-08-02 22:40:46 +02:00
size => 5,
2008-08-02 20:35:23 +02:00
validate => '/^[0-9]+$/',
fieldset => $section,
);
}
elsif ($info{type} eq "boolean") {
$form->field(
name => $name,
2008-08-04 02:51:46 +02:00
label => "",
type => "checkbox",
options => [ [ 1 => $description ] ],
2008-08-02 20:35:23 +02:00
fieldset => $section,
);
if (! $form->submitted ||
($info{advanced} && $form->submitted eq 'Advanced Mode')) {
2008-08-04 02:51:46 +02:00
$form->field(name => $name, value => $value);
}
2008-08-02 20:35:23 +02:00
}
if (! $info{safe} || ! issafe($key)) {
$form->field(name => $name, disabled => 1);
}
else {
$enabledfields{$name}=[$key, \%info];
}
$shownfields++;
2008-08-02 20:35:23 +02:00
}
# if no fields were shown for the plugin, drop it into a combined
# fieldset for its section
if (defined $plugin && (! $plugin_forced || $config{websetup_advanced}) &&
! $shownfields) {
$form->field(name => "enable.$plugin", fieldset => $section_fieldset);
}
return %enabledfields;
}
2008-08-02 20:35:23 +02:00
sub enable_plugin ($) {
my $plugin=shift;
$config{disable_plugins}=[grep { $_ ne $plugin } @{$config{disable_plugins}}];
push @{$config{add_plugins}}, $plugin;
}
sub disable_plugin ($) {
my $plugin=shift;
$config{add_plugins}=[grep { $_ ne $plugin } @{$config{add_plugins}}];
push @{$config{disable_plugins}}, $plugin;
}
sub showform ($$) {
2008-08-02 19:27:58 +02:00
my $cgi=shift;
my $session=shift;
IkiWiki::needsignin($cgi, $session);
2008-08-02 19:27:58 +02:00
if (! defined $session->param("name") ||
! IkiWiki::is_admin($session->param("name"))) {
error(gettext("you are not logged in as an admin"));
}
if (! exists $config{setupfile}) {
error(gettext("setup file for this wiki is not known"));
}
2008-08-02 19:27:58 +02:00
eval q{use CGI::FormBuilder};
error($@) if $@;
my $form = CGI::FormBuilder->new(
title => "setup",
name => "setup",
header => 0,
charset => "utf-8",
method => 'POST',
2008-08-02 20:35:23 +02:00
javascript => 0,
2008-08-02 22:40:46 +02:00
reset => 1,
2008-08-02 19:27:58 +02:00
params => $cgi,
2008-08-03 22:23:41 +02:00
fieldsets => [
[main => gettext("main")],
],
2010-11-23 01:12:17 +01:00
action => IkiWiki::cgiurl(),
2008-08-02 19:27:58 +02:00
template => {type => 'div'},
stylesheet => 1,
2008-08-02 19:27:58 +02:00
);
$form->field(name => "do", type => "hidden", value => "setup",
force => 1);
$form->field(name => "rebuild_asked", type => "hidden");
$form->field(name => "showadvanced", type => "hidden");
2008-08-03 20:57:24 +02:00
2008-08-03 22:46:38 +02:00
if ($form->submitted eq 'Basic Mode') {
2008-08-03 20:57:24 +02:00
$form->field(name => "showadvanced", type => "hidden",
value => 0, force => 1);
}
2008-08-03 22:46:38 +02:00
elsif ($form->submitted eq 'Advanced Mode') {
2008-08-03 20:57:24 +02:00
$form->field(name => "showadvanced", type => "hidden",
value => 1, force => 1);
}
my $advancedtoggle;
if ($form->field("showadvanced")) {
$config{websetup_advanced}=1;
2008-08-03 22:46:38 +02:00
$advancedtoggle="Basic Mode";
2008-08-03 20:57:24 +02:00
}
else {
$config{websetup_advanced}=0;
2008-08-03 22:46:38 +02:00
$advancedtoggle="Advanced Mode";
2008-08-03 20:57:24 +02:00
}
my $buttons=["Save Setup", $advancedtoggle, "Cancel"];
2008-08-02 19:27:58 +02:00
IkiWiki::decode_form_utf8($form);
IkiWiki::run_hooks(formbuilder_setup => sub {
shift->(form => $form, cgi => $cgi, session => $session,
buttons => $buttons);
});
my %fields=showfields($form, undef, undef, IkiWiki::getsetup());
2008-08-02 22:40:46 +02:00
# record all currently enabled plugins before all are loaded
my %enabled_plugins=%IkiWiki::loaded_plugins;
# per-plugin setup
2008-08-02 20:35:23 +02:00
require IkiWiki::Setup;
foreach my $pair (IkiWiki::Setup::getsetup()) {
my $plugin=$pair->[0];
my $setup=$pair->[1];
2008-08-02 22:40:46 +02:00
my %shown=showfields($form, $plugin, $enabled_plugins{$plugin}, @{$setup});
if (%shown) {
$fields{$_}=$shown{$_} foreach keys %shown;
}
2008-08-02 19:27:58 +02:00
}
2010-01-09 22:20:09 +01:00
IkiWiki::decode_form_utf8($form);
2008-08-02 22:40:46 +02:00
2008-08-02 19:27:58 +02:00
if ($form->submitted eq "Cancel") {
IkiWiki::redirect($cgi, IkiWiki::baseurl(undef));
2008-08-02 19:27:58 +02:00
return;
}
2008-08-03 05:32:40 +02:00
elsif (($form->submitted eq 'Save Setup' || $form->submitted eq 'Rebuild Wiki') && $form->validate) {
# Push values from form into %config, avoiding unnecessary
# changes, and keeping track of which changes need a
# rebuild.
2008-08-03 05:32:40 +02:00
my %rebuild;
foreach my $field (keys %fields) {
2008-08-03 05:32:40 +02:00
my %info=%{$fields{$field}->[1]};
2008-08-03 06:27:27 +02:00
my $key=$fields{$field}->[0];
my @value=$form->field($field);
if (! @value) {
@value=0;
}
if (! $info{safe} || ! issafe($key)) {
2008-08-03 06:27:27 +02:00
error("unsafe field $key"); # should never happen
2008-08-03 05:32:40 +02:00
}
if (exists $info{rebuild} &&
($info{rebuild} || ! defined $info{rebuild})) {
$rebuild{$field}=$info{rebuild};
}
if ($field=~/^enable\.(.*)/) {
my $plugin=$1;
$value[0]=0 if ! length $value[0];
if ($value[0] != exists $enabled_plugins{$plugin}) {
if ($value[0]) {
enable_plugin($plugin);
}
else {
disable_plugin($plugin);
}
}
else {
delete $rebuild{$field};
}
next;
}
2008-08-03 05:14:59 +02:00
2008-08-03 06:27:27 +02:00
if (ref $config{$key} eq "ARRAY" || ref $info{example} eq "ARRAY") {
@value=sort grep { length $_ } @value;
my @oldvalue=sort grep { length $_ }
(defined $config{$key} ? @{$config{$key}} : ());
my $same=(@oldvalue) == (@value);
for (my $x=0; $same && $x < @value; $x++) {
$same=0 if $value[$x] ne $oldvalue[$x];
}
if ($same) {
delete $rebuild{$field};
}
else {
$config{$key}=\@value;
2008-08-03 06:27:27 +02:00
}
2008-08-03 05:32:40 +02:00
}
2008-08-03 06:27:27 +02:00
elsif (ref $config{$key} || ref $info{example}) {
error("complex field $key"); # should never happen
}
else {
if (defined $config{$key} && $config{$key} eq $value[0]) {
delete $rebuild{$field};
}
elsif (! defined $config{$key} && ! length $value[0]) {
delete $rebuild{$field};
2008-08-03 06:27:27 +02:00
}
elsif ((! defined $config{$key} || ! $config{$key}) &&
! $value[0] && $info{type} eq "boolean") {
delete $rebuild{$field};
}
else {
$config{$key}=$value[0];
}
}
}
if (%rebuild && ! $form->field("rebuild_asked")) {
my $required=0;
2008-08-03 05:32:40 +02:00
foreach my $field ($form->field) {
$required=1 if $rebuild{$field};
next if exists $rebuild{$field};
$form->field(name => $field, type => "hidden");
2008-08-03 05:32:40 +02:00
}
if ($required) {
$form->text(gettext("The configuration changes shown below require a wiki rebuild to take effect."));
$buttons=["Rebuild Wiki", "Cancel"];
}
else {
$form->text(gettext("For the configuration changes shown below to fully take effect, you may need to rebuild the wiki."));
$buttons=["Rebuild Wiki", "Save Setup", "Cancel"];
}
$form->field(name => "rebuild_asked", value => 1, force => 1);
2008-08-03 05:32:40 +02:00
$form->reset(0); # doesn't really make sense here
}
else {
my $oldsetup=readfile($config{setupfile});
IkiWiki::Setup::dump($config{setupfile});
IkiWiki::saveindex();
IkiWiki::unlockwiki();
2011-01-05 22:15:38 +01:00
# Print the top part of a standard cgitemplate,
2010-05-15 03:40:30 +02:00
# then show the rebuild or refresh, live.
my $divider="\0";
2011-01-05 22:15:38 +01:00
my $html=IkiWiki::cgitemplate($cgi, "setup", $divider);
IkiWiki::printheader($session);
my ($head, $tail)=split($divider, $html, 2);
print $head."<pre>\n";
2008-08-04 20:53:11 +02:00
my @command;
if ($form->submitted eq 'Rebuild Wiki') {
@command=("ikiwiki", "-setup", $config{setupfile},
"-rebuild", "-v");
2008-08-03 05:32:40 +02:00
}
2008-08-04 20:53:11 +02:00
else {
@command=("ikiwiki", "-setup", $config{setupfile},
"-refresh", "-wrappers", "-v");
2008-08-04 20:53:11 +02:00
}
close STDERR;
open(STDERR, ">&STDOUT");
my $ret=system(@command);
print "\n<\/pre>";
if ($ret != 0) {
print '<p class="error">'.
sprintf(gettext("Error: %s exited nonzero (%s). Discarding setup changes."),
join(" ", @command), $ret).
'</p>';
open(OUT, ">", $config{setupfile}) || error("$config{setupfile}: $!");
print OUT Encode::encode_utf8($oldsetup);
close OUT;
}
print $tail;
exit 0;
2008-08-03 05:32:40 +02:00
}
2008-08-02 19:27:58 +02:00
}
IkiWiki::showform($form, $buttons, $session, $cgi);
}
2008-08-02 19:27:58 +02:00
sub sessioncgi ($$) {
2008-08-02 19:27:58 +02:00
my $cgi=shift;
my $session=shift;
if ($cgi->param("do") eq "setup") {
showform($cgi, $session);
exit;
}
}
2008-08-02 19:27:58 +02:00
sub formbuilder_setup (@) {
2008-08-02 19:27:58 +02:00
my %params=@_;
my $form=$params{form};
if ($form->title eq "preferences" &&
IkiWiki::is_admin($params{session}->param("name"))) {
push @{$params{buttons}}, "Setup";
if ($form->submitted && $form->submitted eq "Setup") {
2008-08-02 19:27:58 +02:00
showform($params{cgi}, $params{session});
exit;
}
}
}
2008-08-02 19:27:58 +02:00
1