]> sipb.mit.edu Git - ikiwiki.git/blobdiff - IkiWiki/Plugin/websetup.pm
properly support all types of data in arrays
[ikiwiki.git] / IkiWiki / Plugin / websetup.pm
index 150c792a52d7dfcc2097f5467451d6af1800a660..d087b4863148c19797d6cd1c6f7aa38398e04c4a 100644 (file)
@@ -9,7 +9,7 @@ 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});
+my @force_plugins=(qw{amazon_s3 external});
 
 sub import { #{{{
        hook(type => "getsetup", id => "websetup", call => \&getsetup);
@@ -23,7 +23,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,
@@ -68,8 +68,10 @@ sub showfields ($$$@) { #{{{
                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 $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
@@ -78,15 +80,19 @@ sub showfields ($$$@) { #{{{
                push @show, $key, \%info;
        }
 
-       return unless @show;
+       return unless @show;
 
        my $section=defined $plugin ? $plugin." ".gettext("plugin") : gettext("main");
 
+       my %shownfields;
        if (defined $plugin) {
-               if (! showplugintoggle($form, $plugin, $enabled, $section) && ! $enabled) {
+               if (showplugintoggle($form, $plugin, $enabled, $section)) {
+                       $shownfields{"enable.$plugin"}=[$plugin];
+               }
+               elsif (! $enabled) {
                    # plugin not enabled and cannot be, so skip showing
                    # its configuration
-                   return 0;
+                   return;
                }
        }
 
@@ -94,11 +100,24 @@ sub showfields ($$$@) { #{{{
                my $key=shift @show;
                my %info=%{shift @show};
 
-               my $description=exists $info{description_html} ? $info{description_html} : $info{description};
+               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);
+                       }
+               }
+
                my $value=$config{$key};
+               if (ref $config{$key} eq 'ARRAY' || ref $info{example} eq 'ARRAY') {
+                       push @{$value}, "", ""; # blank items for expansion
+               }
+
                # multiple plugins can have the same field
                my $name=defined $plugin ? $plugin.".".$key : $key;
-               
+
                if ($info{type} eq "string") {
                        $form->field(
                                name => $name,
@@ -149,9 +168,12 @@ sub showfields ($$$@) { #{{{
                        $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 1;
+       return %shownfields;
 } #}}}
 
 sub showplugintoggle ($$$$) { #{{{
@@ -161,11 +183,10 @@ sub showplugintoggle ($$$$) { #{{{
        my $section=shift;
 
        if (exists $config{websetup_force_plugins} &&
-           grep { $_ eq $plugin } @{$config{websetup_force_plugins}}, @rcs_plugins) {
+           grep { $_ eq $plugin } @{$config{websetup_force_plugins}}) {
                return 0;
        }
-       elsif (! exists $config{websetup_force_plugins} &&
-              grep { $_ eq $plugin } @default_force_plugins, @rcs_plugins) {
+       if (grep { $_ eq $plugin } @force_plugins, @rcs_plugins) {
                return 0;
        }
 
@@ -217,7 +238,7 @@ sub showform ($$) { #{{{
 
        $form->field(name => "do", type => "hidden", value => "setup",
                force => 1);
-       showfields($form, undef, undef, IkiWiki::getsetup());
+       my %fields=showfields($form, undef, undef, IkiWiki::getsetup());
        
        # record all currently enabled plugins before all are loaded
        my %enabled_plugins=%IkiWiki::loaded_plugins;
@@ -232,21 +253,84 @@ sub showform ($$) { #{{{
                # skip all rcs plugins except for the one in use
                next if $plugin ne $config{rcs} && grep { $_ eq $plugin } @rcs_plugins;
 
-               delete $plugins{$plugin} if showfields($form, $plugin, $enabled_plugins{$plugin}, @{$setup});
+               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
-       showplugintoggle($form, $_, $enabled_plugins{$_}, gettext("other plugins"))
-               foreach sort keys %plugins;
+       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
-               IkiWiki::Setup::dump("/tmp/s");
-               $form->text(gettext("Setup saved."));
+       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
+                       }
+
+                       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);