use strict;
use IkiWiki 2.00;
+my @rcs_plugins=(qw{git svn bzr mercurial monotone tla norcs});
+
+# amazon_s3 is not something that should be enabled via the web.
+# external is not a standalone plugin.
+my @force_plugins=(qw{amazon_s3 external});
+
sub import { #{{{
- hook(type => "sessioncgi", id => "websetup",
- call => \&sessioncgi);
- hook(type => "formbuilder_setup", id => "websetup",
+ hook(type => "getsetup", id => "websetup", call => \&getsetup);
+ hook(type => "checkconfig", id => "websetup", call => \&checkconfig);
+ hook(type => "sessioncgi", id => "websetup", call => \&sessioncgi);
+ hook(type => "formbuilder_setup", id => "websetup",
call => \&formbuilder_setup);
} # }}}
+sub getsetup () { #{{{
+ return
+ websetup_force_plugins => {
+ type => "string",
+ example => [],
+ description => "list of plugins that cannot be enabled/disabled via the web interface",
+ 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;
+ }
+} #}}}
+
+sub formatexample ($$) { #{{{
+ my $example=shift;
+ my $value=shift;
+
+ if (defined $value && length $value) {
+ return "";
+ }
+ elsif (defined $example && ! ref $example && length $example) {
+ return "<br/ ><small>Example: <tt>$example</tt></small>";
+ }
+ else {
+ return "";
+ }
+} #}}}
+
+sub showfields ($$$@) { #{{{
+ my $form=shift;
+ my $plugin=shift;
+ my $enabled=shift;
+
+ my @show;
+ while (@_) {
+ my $key=shift;
+ my %info=%{shift()};
+
+ # skip internal settings
+ next if $info{type} eq "internal";
+ # 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 ! $info{safe} && ! $config{websetup_show_unsafe};
+ # these are handled specially, so don't show
+ next if $key eq 'add_plugins' || $key eq 'disable_plugins';
+
+ push @show, $key, \%info;
+ }
+
+ return unless @show;
+
+ my $section=defined $plugin ? $plugin." ".gettext("plugin") : gettext("main");
+
+ my %shownfields;
+ if (defined $plugin) {
+ if (showplugintoggle($form, $plugin, $enabled, $section)) {
+ $shownfields{"enable.$plugin"}=[$plugin];
+ }
+ elsif (! $enabled) {
+ # plugin not enabled and cannot be, so skip showing
+ # its configuration
+ return;
+ }
+ }
+
+ while (@show) {
+ my $key=shift @show;
+ my %info=%{shift @show};
+
+ my $description=exists $info{description_html} ? $info{description_html} : $info{description};
+ my $value=$config{$key};
+ # multiple plugins can have the same field
+ my $name=defined $plugin ? $plugin.".".$key : $key;
+
+ if (ref $config{$key} eq 'ARRAY' || ref $info{example} eq 'ARRAY') {
+ $form->field(
+ name => $name,
+ label => $description,
+ comment => formatexample($info{example}, $value),
+ type => "text",
+ value => [ref $value eq 'ARRAY' ? @{$value} : "", , "", ""],
+ size => 60,
+ fieldset => $section,
+ );
+ }
+ elsif ($info{type} eq "string") {
+ $form->field(
+ name => $name,
+ label => $description,
+ comment => formatexample($info{example}, $value),
+ type => "text",
+ value => $value,
+ size => 60,
+ fieldset => $section,
+ );
+ }
+ elsif ($info{type} eq "pagespec") {
+ $form->field(
+ name => $name,
+ label => $description,
+ comment => formatexample($info{example}, $value),
+ type => "text",
+ value => $value,
+ size => 60,
+ validate => \&IkiWiki::pagespec_valid,
+ fieldset => $section,
+ );
+ }
+ elsif ($info{type} eq "integer") {
+ $form->field(
+ name => $name,
+ label => $description,
+ comment => formatexample($info{example}, $value),
+ type => "text",
+ value => $value,
+ size => 5,
+ validate => '/^[0-9]+$/',
+ fieldset => $section,
+ );
+ }
+ elsif ($info{type} eq "boolean") {
+ $form->field(
+ name => $name,
+ label => "",
+ type => "checkbox",
+ value => $value,
+ options => [ [ 1 => $description ] ],
+ fieldset => $section,
+ );
+ }
+
+ if (! $info{safe}) {
+ $form->field(name => $name, disabled => 1);
+ $form->text(gettext("Note: Disabled options cannot be configured here, but only by editing the setup file."));
+ }
+ else {
+ $shownfields{$name}=[$key, \%info];
+ }
+ }
+
+ return %shownfields;
+} #}}}
+
+sub showplugintoggle ($$$$) { #{{{
+ my $form=shift;
+ my $plugin=shift;
+ my $enabled=shift;
+ my $section=shift;
+
+ if (exists $config{websetup_force_plugins} &&
+ grep { $_ eq $plugin } @{$config{websetup_force_plugins}}) {
+ return 0;
+ }
+ if (grep { $_ eq $plugin } @force_plugins, @rcs_plugins) {
+ return 0;
+ }
+
+ $form->field(
+ name => "enable.$plugin",
+ label => "",
+ type => "checkbox",
+ options => [ [ 1 => sprintf(gettext("enable %s?"), $plugin) ] ],
+ value => $enabled,
+ fieldset => $section,
+ );
+
+ return 1;
+} #}}}
+
sub showform ($$) { #{{{
my $cgi=shift;
my $session=shift;
header => 0,
charset => "utf-8",
method => 'POST',
+ javascript => 0,
+ reset => 1,
params => $cgi,
action => $config{cgiurl},
template => {type => 'div'},
$form->field(name => "do", type => "hidden", value => "setup",
force => 1);
+ my %fields=showfields($form, undef, undef, IkiWiki::getsetup());
+
+ # record all currently enabled plugins before all are loaded
+ my %enabled_plugins=%IkiWiki::loaded_plugins;
+
+ # per-plugin setup
+ require IkiWiki::Setup;
+ my %plugins=map { $_ => 1 } IkiWiki::listplugins();
+ foreach my $pair (IkiWiki::Setup::getsetup()) {
+ my $plugin=$pair->[0];
+ my $setup=$pair->[1];
+
+ # skip all rcs plugins except for the one in use
+ next if $plugin ne $config{rcs} && grep { $_ eq $plugin } @rcs_plugins;
- if (! $form->submitted) {
- # TODO
+ my %shown=showfields($form, $plugin, $enabled_plugins{$plugin}, @{$setup});
+ if (%shown) {
+ delete $plugins{$plugin};
+ $fields{$_}=$shown{$_} foreach keys %shown;
+ }
}
+ # list all remaining plugins (with no setup options) at the end
+ foreach (sort keys %plugins) {
+ if (showplugintoggle($form, $_, $enabled_plugins{$_}, gettext("other plugins"))) {
+ $fields{"enable.$_"}=[$_];
+ }
+ }
+
if ($form->submitted eq "Cancel") {
IkiWiki::redirect($cgi, $config{url});
return;
}
- elsif ($form->submitted eq 'Save Setup' && $form->validate) {
- # TODO
+ elsif (($form->submitted eq 'Save Setup' || $form->submitted eq 'Rebuild Wiki') && $form->validate) {
+ my %rebuild;
+ foreach my $field (keys %fields) {
+ if ($field=~/^enable\./) {
+ # rebuild is overkill for many plugins,
+ # but no good way to tell which
+ $rebuild{$field}=1; # TODO only if state changed tho
+ # TODO plugin enable/disable
+ next;
+ }
+
+ my %info=%{$fields{$field}->[1]};
+ my $key=$fields{$field}->[0];
+ my @value=$form->field($field);
+
+ if (! $info{safe}) {
+ error("unsafe field $key"); # should never happen
+ }
- $form->text(gettext("Setup saved."));
+ next unless @value;
+ # Avoid setting fields to empty strings,
+ # if they were not set before.
+ next if ! defined $config{$key} && ! grep { length $_ } @value;
+
+ if (ref $config{$key} eq "ARRAY" || ref $info{example} eq "ARRAY") {
+ if ($info{rebuild} && (! defined $config{$key} || (@{$config{$key}}) != (@value))) {
+ $rebuild{$field}=1;
+ }
+ $config{$key}=\@value;
+ }
+ elsif (ref $config{$key} || ref $info{example}) {
+ error("complex field $key"); # should never happen
+ }
+ else {
+ if ($info{rebuild} && (! defined $config{$key} || $config{$key} ne $value[0])) {
+ $rebuild{$field}=1;
+ }
+ $config{$key}=$value[0];
+ }
+ }
+
+ if (%rebuild && $form->submitted eq 'Save Setup') {
+ $form->text(gettext("The configuration changes shown below require a wiki rebuild to take effect."));
+ foreach my $field ($form->field) {
+ next if $rebuild{$field};
+ $form->field(name => $field, type => "hidden",
+ force => 1);
+ }
+ $form->reset(0); # doesn't really make sense here
+ $buttons=["Rebuild Wiki", "Cancel"];
+ }
+ else {
+ # TODO save to real path
+ IkiWiki::Setup::dump("/tmp/s");
+ $form->text(gettext("Setup saved."));
+
+ if (%rebuild) {
+ # TODO rebuild
+ }
+ }
}
IkiWiki::showform($form, $buttons, $session, $cgi);
sipb-www / ikiwiki.git / blobdiff