]> scripts.mit.edu Git - www/ikiwiki.git/blobdiff - IkiWiki/Plugin/websetup.pm
scripts.mit.edu / www / ikiwiki.git / blobdiff
? search:
summary | shortlog | log | commit | commitdiff | tree
raw | inline | side by side
use radio, not checkbox, for booleans
[www/ikiwiki.git] / IkiWiki / Plugin / websetup.pm
diff --git a/IkiWiki/Plugin/websetup.pm b/IkiWiki/Plugin/websetup.pm
index 4c936741066d90fcad61b42b6d6d3020e7eeac71..7f4bce5e519b50b82ef41f7c0db34a3f7fedfd02 100644 (file)
--- a/IkiWiki/Plugin/websetup.pm
+++ b/IkiWiki/Plugin/websetup.pm
@@ -15,6 +15,10 @@ sub import { #{{{
 
 sub getsetup () { #{{{
        return
 
 sub getsetup () { #{{{
        return
+               plugin => {
+                       safe => 1,
+                       rebuild => 0,
+               },
                websetup_force_plugins => {
                        type => "string",
                        example => [],
                websetup_force_plugins => {
                        type => "string",
                        example => [],
@@ -82,17 +86,40 @@ sub showfields ($$$@) { #{{{
                push @show, $key, \%info;
        }
 
                push @show, $key, \%info;
        }
 
+       my $section=defined $plugin ? $plugin." ".gettext("plugin") : "main";
+       my %enabledfields;
+       my $shownfields=0;
+       
        my $plugin_forced=defined $plugin && (! $plugininfo{safe} ||
                (exists $config{websetup_force_plugins} && grep { $_ eq $plugin } @{$config{websetup_force_plugins}}));
        if ($plugin_forced && ! $enabled) {
        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
+               # plugin is forced disabled, so skip its settings
                @show=();
        }
 
                @show=();
        }
 
-       my %shownfields;
-       my %skippedfields;
-       my $section=defined $plugin ? $plugin." ".gettext("plugin") : "main";
-       
+       # show plugin toggle
+       if (defined $plugin && (! $plugin_forced || $config{websetup_advanced})) {
+               my $name="enable.$plugin";
+               $form->field(
+                       name => $name,
+                       label => sprintf(gettext("enable %s?"), $plugin),
+                       type => "radio",
+                       value => $enabled,
+                       fieldset => $section,
+                       options => [
+                               [ 1 => gettext("Yes") ],
+                               [ 0 => gettext("No") ]
+                       ],
+               );
+               if ($plugin_forced) {
+                       $form->field(name => $name, disabled => 1);
+               }
+               else {
+                       $enabledfields{$name}=[$name, \%plugininfo];
+               }
+       }
+
+       # show plugin settings
        while (@show) {
                my $key=shift @show;
                my %info=%{shift @show};
        while (@show) {
                my $key=shift @show;
                my %info=%{shift @show};
@@ -154,43 +181,34 @@ sub showfields ($$$@) { #{{{
                elsif ($info{type} eq "boolean") {
                        $form->field(
                                name => $name,
                elsif ($info{type} eq "boolean") {
                        $form->field(
                                name => $name,
-                               label => "",
-                               type => "checkbox",
+                               label => $description,
+                               type => "radio",
                                value => $value,
                                value => $value,
-                               options => [ [ 1 => $description ] ],
+                               options => [
+                                       [ 1 => gettext("Yes") ],
+                                       [ 0 => gettext("No") ]
+                               ],
                                fieldset => $section,
                        );
                }
                
                if (! $info{safe}) {
                        $form->field(name => $name, disabled => 1);
                                fieldset => $section,
                        );
                }
                
                if (! $info{safe}) {
                        $form->field(name => $name, disabled => 1);
-                       $skippedfields{$name}=1;
                }
                else {
                }
                else {
-                       $shownfields{$name}=[$key, \%info];
+                       $enabledfields{$name}=[$key, \%info];
                }
                }
+               $shownfields++;
        }
        }
-
-       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];
-               }
+       
+       # if no fields were shown for the plugin, drop it into the
+       # plugins fieldset
+       if (defined $plugin && (! $plugin_forced || $config{websetup_advanced}) &&
+           ! $shownfields) {
+               $form->field(name => "enable.$plugin", fieldset => "plugins");
        }
 
        }
 
-       return %shownfields;
+       return %enabledfields;
 } #}}}
 
 sub showform ($$) { #{{{
 } #}}}
 
 sub showform ($$) { #{{{
@@ -219,9 +237,13 @@ sub showform ($$) { #{{{
                        [plugins => gettext("plugins")]
                ],
                action => $config{cgiurl},
                        [plugins => gettext("plugins")]
                ],
                action => $config{cgiurl},
+               table => 0,
                template => {type => 'div'},
                stylesheet => IkiWiki::baseurl()."style.css",
        );
                template => {type => 'div'},
                stylesheet => IkiWiki::baseurl()."style.css",
        );
+       
+       $form->field(name => "do", type => "hidden", value => "setup",
+               force => 1);
 
        if ($form->submitted eq 'Basic Mode') {
                $form->field(name => "showadvanced", type => "hidden", 
 
        if ($form->submitted eq 'Basic Mode') {
                $form->field(name => "showadvanced", type => "hidden", 
@@ -250,8 +272,6 @@ sub showform ($$) { #{{{
        });
        IkiWiki::decode_form_utf8($form);
 
        });
        IkiWiki::decode_form_utf8($form);
 
-       $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 %fields=showfields($form, undef, undef, IkiWiki::getsetup());
        
        # record all currently enabled plugins before all are loaded
@@ -259,14 +279,12 @@ sub showform ($$) { #{{{
 
        # per-plugin setup
        require IkiWiki::Setup;
 
        # 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];
 
                my %shown=showfields($form, $plugin, $enabled_plugins{$plugin}, @{$setup});
                if (%shown) {
        foreach my $pair (IkiWiki::Setup::getsetup()) {
                my $plugin=$pair->[0];
                my $setup=$pair->[1];
 
                my %shown=showfields($form, $plugin, $enabled_plugins{$plugin}, @{$setup});
                if (%shown) {
-                       delete $plugins{$plugin};
                        $fields{$_}=$shown{$_} foreach keys %shown;
                }
        }
                        $fields{$_}=$shown{$_} foreach keys %shown;
                }
        }
@@ -276,62 +294,97 @@ sub showform ($$) { #{{{
                return;
        }
        elsif (($form->submitted eq 'Save Setup' || $form->submitted eq 'Rebuild Wiki') && $form->validate) {
                return;
        }
        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.
                my %rebuild;
                foreach my $field (keys %fields) {
                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);
                        my %info=%{$fields{$field}->[1]};
                        my $key=$fields{$field}->[0];
                        my @value=$form->field($field);
-                       
+                       if (! @value) {
+                               @value=0;
+                       }
+               
                        if (! $info{safe}) {
                                error("unsafe field $key"); # should never happen
                        }
                        if (! $info{safe}) {
                                error("unsafe field $key"); # should never happen
                        }
-
-                       next unless @value;
-                       # Avoid setting fields to empty strings,
-                       # if they were not set before.
-                       next if ! defined $config{$key} && ! grep { length $_ } @value;
+               
+                       if (exists $info{rebuild} &&
+                           ($info{rebuild} || ! defined $info{rebuild})) {
+                               $rebuild{$field}=$info{rebuild};
+                       }
+                                       
+                       if ($field=~/^enable\.(.*)/) {
+                               my $plugin=$1;
+                               if ($value[0] != exists $enabled_plugins{$plugin}) {
+                                       # TODO plugin enable/disable
+                               }
+                               else {
+                                       delete $rebuild{$field};
+                               }
+                               next;
+                       }
 
                        if (ref $config{$key} eq "ARRAY" || ref $info{example} eq "ARRAY") {
 
                        if (ref $config{$key} eq "ARRAY" || ref $info{example} eq "ARRAY") {
-                               if ($info{rebuild} && (! defined $config{$key} || (@{$config{$key}}) != (@value))) {
-                                       $rebuild{$field}=1;
+                               @value=sort grep { length $_ } @value;
+                               my @oldvalue=sort grep { length $_ }
+                                       (defined $config{$key} ? @{$config{$key}} : ());
+                               if ((@oldvalue) == (@value)) {
+                                       delete $rebuild{$field};
+                               }
+                               else {
+                                       $config{$key}=\@value;
                                }
                                }
-                               $config{$key}=\@value;
                        }
                        elsif (ref $config{$key} || ref $info{example}) {
                                error("complex field $key"); # should never happen
                        }
                        else {
                        }
                        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;
+                               if (defined $config{$key} && $config{$key} eq $value[0]) {
+                                       delete $rebuild{$field};
                                }
                                }
-                               $config{$key}=$value[0];
-                       }               
+                               elsif (! defined $config{$key} && ! length $value[0]) {
+                                       delete $rebuild{$field};
+                               }
+                               elsif (! defined $config{$key} && ! $value[0] &&
+                                      $info{type} eq "boolean") {
+                                       delete $rebuild{$field};
+                               }
+                               else {
+                                       $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."));
+               
+               if (%rebuild && ! $form->field("rebuild_asked")) {
+                       my $required=0;
                        foreach my $field ($form->field) {
                        foreach my $field ($form->field) {
-                               next if $rebuild{$field};
+                               $required=1 if $rebuild{$field};
+                               next if exists $rebuild{$field};
                                $form->field(name => $field, type => "hidden",
                                        force => 1);
                        }
                                $form->field(name => $field, type => "hidden",
                                        force => 1);
                        }
+                       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", type => "hidden",
+                               value => 1, force => 1);
                        $form->reset(0); # doesn't really make sense here
                        $form->reset(0); # doesn't really make sense here
-                       $buttons=["Rebuild Wiki", "Cancel"];
                }
                else {
                }
                else {
+                       $form->field(name => "rebuild_asked", type => "hidden",
+                               value => 0, force => 1);
                        # TODO save to real path
                        IkiWiki::Setup::dump("/tmp/s");
                        $form->text(gettext("Setup saved."));
                        # TODO save to real path
                        IkiWiki::Setup::dump("/tmp/s");
                        $form->text(gettext("Setup saved."));
-
-                       if (%rebuild) {
+       
+                       if ($form->submitted eq 'Rebuild Wiki') {
                                # TODO rebuild
                        }
                }
                                # TODO rebuild
                        }
                }
Unnamed repository; edit this file 'description' to name the repository.