X-Git-Url: http://git.vanrenterghem.biz/git.ikiwiki.info.git/blobdiff_plain/903213e63fd6c409046f66e73881aba33c3926de..68869d664b978b063c9181d024edb34a63306c33:/IkiWiki/Plugin/websetup.pm diff --git a/IkiWiki/Plugin/websetup.pm b/IkiWiki/Plugin/websetup.pm index 4670d69c0..95d044c08 100644 --- a/IkiWiki/Plugin/websetup.pm +++ b/IkiWiki/Plugin/websetup.pm @@ -3,18 +3,22 @@ package IkiWiki::Plugin::websetup; use warnings; use strict; -use IkiWiki 2.00; +use IkiWiki 3.00; -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 => [], @@ -29,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; @@ -50,9 +54,9 @@ sub formatexample ($$) { #{{{ else { return ""; } -} #}}} +} -sub showfields ($$$@) { #{{{ +sub showfields ($$$@) { my $form=shift; my $plugin=shift; my $enabled=shift; @@ -82,16 +86,39 @@ sub showfields ($$$@) { #{{{ 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) { - # plugin is forced disabled, so skip its configuration - return; + # plugin is forced disabled, so skip its settings + @show=(); } - my %shownfields; - 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 => "", + 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); + } + else { + $enabledfields{$name}=[$name, \%plugininfo]; + } + } + + # show plugin settings while (@show) { my $key=shift @show; my %info=%{shift @show}; @@ -107,12 +134,12 @@ sub showfields ($$$@) { #{{{ } # multiple plugins can have the same field - my $name=defined $plugin ? $plugin.".".$key : $key; + my $name=defined $plugin ? $plugin.".".$key : $section.".".$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{safe} && (ref $value eq 'ARRAY' || ref $info{example} eq 'ARRAY')) { + $value=[(ref $value eq 'ARRAY' ? @{$value} : ""), "", ""]; # blank items for expansion } if ($info{type} eq "string") { @@ -155,43 +182,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); } 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; - $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 enable_plugin ($) { + my $plugin=shift; + + $config{disable_plugins}=[grep { $_ ne $plugin } @{$config{disable_plugins}}]; + push @{$config{add_plugins}}, $plugin; +} + +sub disable_plugin ($) { + my $plugin=shift; + + if (grep { $_ eq $plugin } @{$config{add_plugins}}) { + $config{add_plugins}=[grep { $_ ne $plugin } @{$config{add_plugins}}]; + } + else { + push @{$config{disable_plugins}}, $plugin; + } +} + +sub showform ($$) { my $cgi=shift; my $session=shift; @@ -200,6 +236,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 $@; @@ -220,23 +260,27 @@ sub showform ($$) { #{{{ template => {type => 'div'}, stylesheet => IkiWiki::baseurl()."style.css", ); + + $form->field(name => "do", type => "hidden", value => "setup", + force => 1); + $form->field(name => "rebuild_asked", type => "hidden"); - if ($form->submitted eq 'Basic') { + if ($form->submitted eq 'Basic Mode') { $form->field(name => "showadvanced", type => "hidden", value => 0, force => 1); } - elsif ($form->submitted eq 'Advanced') { + 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"; + $advancedtoggle="Basic Mode"; } else { $config{websetup_advanced}=0; - $advancedtoggle="Advanced"; + $advancedtoggle="Advanced Mode"; } my $buttons=["Save Setup", $advancedtoggle, "Cancel"]; @@ -248,8 +292,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 @@ -257,14 +299,12 @@ 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]; my %shown=showfields($form, $plugin, $enabled_plugins{$plugin}, @{$setup}); if (%shown) { - delete $plugins{$plugin}; $fields{$_}=$shown{$_} foreach keys %shown; } } @@ -274,71 +314,136 @@ sub showform ($$) { #{{{ 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."
\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
";
+			if ($ret != 0) {
+				print '
'.
+					sprintf(gettext("
Error: %s exited nonzero (%s)"),
+						join(" ", @command), $ret).
+					'
';
 			}
+
+			print $tail;			
+			exit 0;
 		}
 	}
 
 	IkiWiki::showform($form, $buttons, $session, $cgi);
-} #}}}
+}
 
-sub sessioncgi ($$) { #{{{
+sub sessioncgi ($$) {
 	my $cgi=shift;
 	my $session=shift;
 
@@ -346,9 +451,9 @@ sub sessioncgi ($$) { #{{{
 		showform($cgi, $session);
 		exit;
 	}
-} #}}}
+}
 
-sub formbuilder_setup (@) { #{{{
+sub formbuilder_setup (@) {
 	my %params=@_;
 
 	my $form=$params{form};
@@ -359,6 +464,6 @@ sub formbuilder_setup (@) { #{{{
 			exit;
 		}
 	}
-} #}}}
+}
 
 1