X-Git-Url: https://sipb.mit.edu/gitweb.cgi/ikiwiki.git/blobdiff_plain/7baa6320e0dfb97bde1af3a3bbc46ace53f19093..b7d6a49be4a5e1d9c94219392179c14dba40034a:/IkiWiki/Plugin/websetup.pm diff --git a/IkiWiki/Plugin/websetup.pm b/IkiWiki/Plugin/websetup.pm index a0c396067..4c9367410 100644 --- a/IkiWiki/Plugin/websetup.pm +++ b/IkiWiki/Plugin/websetup.pm @@ -5,12 +5,6 @@ use warnings; 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 @default_force_plugins=(qw{amazon_s3 external}); - sub import { #{{{ hook(type => "getsetup", id => "websetup", call => \&getsetup); hook(type => "checkconfig", id => "websetup", call => \&checkconfig); @@ -23,7 +17,7 @@ sub getsetup () { #{{{ return websetup_force_plugins => { type => "string", - example => \@default_force_plugins, + example => [], description => "list of plugins that cannot be enabled/disabled via the web interface", safe => 0, rebuild => 0, @@ -64,45 +58,64 @@ sub showfields ($$$@) { #{{{ my $enabled=shift; my @show; + my %plugininfo; while (@_) { my $key=shift; my %info=%{shift()}; - # skip complex or internal settings - next if ref $config{$key} || ref $info{example} || $info{type} eq "internal"; + # skip internal settings + next if defined $info{type} && $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}; + next if ! $info{safe} && ! ($config{websetup_show_unsafe} && $config{websetup_advanced}); + # maybe skip advanced settings + next if $info{advanced} && ! $config{websetup_advanced}; # these are handled specially, so don't show next if $key eq 'add_plugins' || $key eq 'disable_plugins'; + + if ($key eq 'plugin') { + %plugininfo=%info; + next; + } 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; - } + 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 configuration + @show=(); } + my %shownfields; + my %skippedfields; + my $section=defined $plugin ? $plugin." ".gettext("plugin") : "main"; + 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}; + my $description=$info{description}; + if (exists $info{link} && length $info{link}) { + if ($info{link} =~ /^\w+:\/\//) { + $description="$description"; + } + else { + $description=htmllink("", "", $info{link}, noimageinline => 1, linktext => $description); + } + } + # multiple plugins can have the same field my $name=defined $plugin ? $plugin.".".$key : $key; - + + my $value=$config{$key}; + + if ($info{safe} && (ref $config{$key} eq 'ARRAY' || ref $info{example} eq 'ARRAY')) { + push @{$value}, "", ""; # blank items for expansion + } + if ($info{type} eq "string") { $form->field( name => $name, @@ -151,41 +164,33 @@ sub showfields ($$$@) { #{{{ 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.")); + $skippedfields{$name}=1; } 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}}, @rcs_plugins) { - return 0; - } - elsif (! exists $config{websetup_force_plugins} && - grep { $_ eq $plugin } @default_force_plugins, @rcs_plugins) { - return 0; + if (defined $plugin && (! $plugin_forced || $config{websetup_advanced})) { + my $name="enable.$plugin"; + $section="plugins" unless %shownfields || (%skippedfields && $config{websetup_advanced}); + $form->field( + name => $name, + label => "", + type => "checkbox", + options => [ [ 1 => sprintf(gettext("enable %s?"), $plugin) ] ], + value => $enabled, + fieldset => $section, + ); + if ($plugin_forced) { + $form->field(name => $name, disabled => 1); + } + else { + $shownfields{$name}=[$name, \%plugininfo]; + } } - $form->field( - ame => "enable.$plugin", - label => "", - type => "checkbox", - options => [ [ 1 => sprintf(gettext("enable %s?"), $plugin) ] ], - value => $enabled, - fieldset => $section, - ); - - return 1; + return %shownfields; } #}}} sub showform ($$) { #{{{ @@ -209,11 +214,34 @@ sub showform ($$) { #{{{ javascript => 0, reset => 1, params => $cgi, + fieldsets => [ + [main => gettext("main")], + [plugins => gettext("plugins")] + ], action => $config{cgiurl}, template => {type => 'div'}, stylesheet => IkiWiki::baseurl()."style.css", ); - my $buttons=["Save Setup", "Cancel"]; + + if ($form->submitted eq 'Basic Mode') { + $form->field(name => "showadvanced", type => "hidden", + value => 0, force => 1); + } + elsif ($form->submitted eq 'Advanced Mode') { + $form->field(name => "showadvanced", type => "hidden", + value => 1, force => 1); + } + my $advancedtoggle; + if ($form->field("showadvanced")) { + $config{websetup_advanced}=1; + $advancedtoggle="Basic Mode"; + } + else { + $config{websetup_advanced}=0; + $advancedtoggle="Advanced Mode"; + } + + my $buttons=["Save Setup", $advancedtoggle, "Cancel"]; IkiWiki::decode_form_utf8($form); IkiWiki::run_hooks(formbuilder_setup => sub { @@ -235,9 +263,6 @@ sub showform ($$) { #{{{ 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; my %shown=showfields($form, $plugin, $enabled_plugins{$plugin}, @{$setup}); if (%shown) { @@ -245,13 +270,6 @@ sub showform ($$) { #{{{ $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}); @@ -260,27 +278,42 @@ sub showform ($$) { #{{{ elsif (($form->submitted eq 'Save Setup' || $form->submitted eq 'Rebuild Wiki') && $form->validate) { my %rebuild; foreach my $field (keys %fields) { - # TODO plugin enable/disable - next if $field=~/^enable\./; # plugin - - my $key=$fields{$field}->[0]; + 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 $value=$form->field($field); - + my $key=$fields{$field}->[0]; + my @value=$form->field($field); + if (! $info{safe}) { - error("unsafe field $key"); # should never happen + error("unsafe field $key"); # should never happen } - next unless defined $value; + next unless @value; # Avoid setting fields to empty strings, # if they were not set before. - next if ! defined $config{$key} && ! length $value; + next if ! defined $config{$key} && ! grep { length $_ } @value; - if ($info{rebuild} && (! defined $config{$key} || $config{$key} ne $value)) { - $rebuild{$field}=1; + 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; } - - $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') {