make sure value is defined before using it as an array
[ikiwiki.git] / IkiWiki / Plugin / websetup.pm
index c22516eec5a19463b9fb2673896f1f093d7a7be6..2d978c5b46758e3ad2234f4d0bc8ba73d80e89b1 100644 (file)
@@ -3,24 +3,22 @@ package IkiWiki::Plugin::websetup;
 
 use warnings;
 use strict;
-use IkiWiki 2.00;
+use IkiWiki 3.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 { #{{{
+sub import {
        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 () { #{{{
+sub getsetup () {
        return
+               plugin => {
+                       safe => 1,
+                       rebuild => 0,
+               },
                websetup_force_plugins => {
                        type => "string",
                        example => [],
@@ -35,15 +33,15 @@ sub getsetup () { #{{{
                        safe => 0,
                        rebuild => 0,
                },
-} #}}}
+}
 
-sub checkconfig () { #{{{
+sub checkconfig () {
        if (! exists $config{websetup_show_unsafe}) {
                $config{websetup_show_unsafe}=1;
        }
-} #}}}
+}
 
-sub formatexample ($$) { #{{{
+sub formatexample ($$) {
        my $example=shift;
        my $value=shift;
 
@@ -56,67 +54,96 @@ sub formatexample ($$) { #{{{
        else {
                return "";
        }
-} #}}}
+}
 
-sub showfields ($$$@) { #{{{
+sub showfields ($$$@) {
        my $form=shift;
        my $plugin=shift;
        my $enabled=shift;
 
        my @show;
+       my %plugininfo;
        while (@_) {
                my $key=shift;
                my %info=%{shift()};
 
                # skip internal settings
-               next if $info{type} eq "internal";
+               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 $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) {
+               # plugin is forced disabled, so skip its settings
+               @show=();
+       }
 
-       my %shownfields;
-       if (defined $plugin) {
-               if (showplugintoggle($form, $plugin, $enabled, $section)) {
-                       $shownfields{"enable.$plugin"}=[$plugin];
+       # show plugin toggle
+       if (defined $plugin && (! $plugin_forced || $config{websetup_advanced})) {
+               my $name="enable.$plugin";
+               $form->field(
+                       name => $name,
+                       label => "",
+                       type => "checkbox",
+                       fieldset => $section,
+                       options => [ [ 1 => sprintf(gettext("enable %s?"), $plugin) ]]
+               );
+               if (! $form->submitted) {
+                       $form->field(name => $name, value => $enabled);
+               }
+               if ($plugin_forced) {
+                       $form->field(name => $name, disabled => 1);
                }
-               elsif (! $enabled) {
-                   # plugin not enabled and cannot be, so skip showing
-                   # its configuration
-                   return;
+               else {
+                       $enabledfields{$name}=[$name, \%plugininfo];
                }
        }
 
+       # show plugin settings
        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="<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 : $key;
+               my $name=defined $plugin ? $plugin.".".$key : $section.".".$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,
-                       );
+               my $value=$config{$key};
+
+               if ($info{safe} && defined $value &&
+                   (ref $value eq 'ARRAY' || ref $info{example} eq 'ARRAY')) {
+                       $value=[@{$value}, "", ""]; # blank items for expansion
                }
-               elsif ($info{type} eq "string") {
+
+               if ($info{type} eq "string") {
                        $form->field(
                                name => $name,
                                label => $description,
@@ -156,51 +183,52 @@ sub showfields ($$$@) { #{{{
                                name => $name,
                                label => "",
                                type => "checkbox",
-                               value => $value,
                                options => [ [ 1 => $description ] ],
                                fieldset => $section,
                        );
+                       if (! $form->submitted) {
+                               $form->field(name => $name, value => $value);
+                       }
                }
                
                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];
+                       $enabledfields{$name}=[$key, \%info];
                }
+               $shownfields++;
+       }
+       
+       # 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 showplugintoggle ($$$$) { #{{{
-       my $form=shift;
+sub enable_plugin ($) {
        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;
-       }
+       $config{disable_plugins}=[grep { $_ ne $plugin } @{$config{disable_plugins}}];
+       push @{$config{add_plugins}}, $plugin;
+}
 
-       $form->field(
-               name => "enable.$plugin",
-               label => "",
-               type => "checkbox",
-               options => [ [ 1 => sprintf(gettext("enable %s?"), $plugin) ] ],
-               value => $enabled,
-               fieldset => $section,
-       );
+sub disable_plugin ($) {
+       my $plugin=shift;
 
-       return 1;
-} #}}}
+       if (grep { $_ eq $plugin } @{$config{add_plugins}}) {
+               $config{add_plugins}=[grep { $_ ne $plugin } @{$config{add_plugins}}];
+       }
+       else {
+               push @{$config{disable_plugins}}, $plugin;
+       }
+}
 
-sub showform ($$) { #{{{
+sub showform ($$) {
        my $cgi=shift;
        my $session=shift;
 
@@ -209,6 +237,10 @@ sub showform ($$) { #{{{
                error(gettext("you are not logged in as an admin"));
        }
 
+       if (! exists $config{setupfile}) {
+               error(gettext("setup file for this wiki is not known"));
+       }
+
        eval q{use CGI::FormBuilder};
        error($@) if $@;
 
@@ -221,11 +253,38 @@ 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"];
+       
+       $form->field(name => "do", type => "hidden", value => "setup",
+               force => 1);
+       $form->field(name => "rebuild_asked", type => "hidden");
+
+       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 {
@@ -234,8 +293,6 @@ sub showform ($$) { #{{{
        });
        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
@@ -243,98 +300,151 @@ sub showform ($$) { #{{{
 
        # 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;
 
                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->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) {
-                       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 (! @value) {
+                               @value=0;
+                       }
+               
                        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;
+                               $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;
+                       }
 
                        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 {
-                               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};
+                               }
+                               elsif (! defined $config{$key} && ! length $value[0]) {
+                                       delete $rebuild{$field};
+                               }
+                               elsif ((! defined $config{$key} || ! $config{$key}) &&
+                                      ! $value[0] && $info{type} eq "boolean") {
+                                       delete $rebuild{$field};
+                               }
+                               else {
+                                       $config{$key}=$value[0];
                                }
-                               $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) {
-                               next if $rebuild{$field};
-                               $form->field(name => $field, type => "hidden",
-                                       force => 1);
+                               $required=1 if $rebuild{$field};
+                               next if exists $rebuild{$field};
+                               $form->field(name => $field, type => "hidden");
+                       }
+                       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);
                        $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."));
+                       IkiWiki::Setup::dump($config{setupfile});
+
+                       IkiWiki::saveindex();
+                       IkiWiki::unlockwiki();
+
+                       # Print the top part of a standard misctemplate,
+                       # then show the rebuild or refresh.
+                       my $divider="xxx";
+                       my $html=IkiWiki::misctemplate("setup", $divider);
+                       IkiWiki::printheader($session);
+                       my ($head, $tail)=split($divider, $html, 2);
+                       print $head."<pre>\n";
+
+                       my @command;
+                       if ($form->submitted eq 'Rebuild Wiki') {
+                               @command=("ikiwiki", "-setup", $config{setupfile},
+                                        "-rebuild", "-v");
+                       }
+                       else {
+                               @command=("ikiwiki", "-setup", $config{setupfile},
+                                       "-refresh", "-wrappers", "-v");
+                       }
 
-                       if (%rebuild) {
-                               # TODO rebuild
+                       my $ret=system(@command);
+                       print "\n<pre>";
+                       if ($ret != 0) {
+                               print '<p class="error">'.
+                                       sprintf(gettext("<p class=\"error\">Error: %s exited nonzero (%s)"),
+                                               join(" ", @command), $ret).
+                                       '</p>';
                        }
+
+                       print $tail;                    
+                       exit 0;
                }
        }
 
        IkiWiki::showform($form, $buttons, $session, $cgi);
-} #}}}
+}
 
-sub sessioncgi ($$) { #{{{
+sub sessioncgi ($$) {
        my $cgi=shift;
        my $session=shift;
 
@@ -342,9 +452,9 @@ sub sessioncgi ($$) { #{{{
                showform($cgi, $session);
                exit;
        }
-} #}}}
+}
 
-sub formbuilder_setup (@) { #{{{
+sub formbuilder_setup (@) {
        my %params=@_;
 
        my $form=$params{form};
@@ -355,6 +465,6 @@ sub formbuilder_setup (@) { #{{{
                        exit;
                }
        }
-} #}}}
+}
 
 1