X-Git-Url: http://git.vanrenterghem.biz/git.ikiwiki.info.git/blobdiff_plain/b0f4767448670ca53aa84e1748a887c7bfccd4f3..40ffc929535e0c799b902d0349bd716b5db4868e:/IkiWiki/Plugin/websetup.pm?ds=sidebyside diff --git a/IkiWiki/Plugin/websetup.pm b/IkiWiki/Plugin/websetup.pm index a30475977..827ee3099 100644 --- a/IkiWiki/Plugin/websetup.pm +++ b/IkiWiki/Plugin/websetup.pm @@ -6,36 +6,162 @@ use strict; use IkiWiki 2.00; sub import { #{{{ - hook(type => "sessioncgi", id => "websetup", - call => \&sessioncgi); - hook(type => "formbuilder_setup", id => "websetup", + 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 addfields ($$@) { +sub getsetup () { #{{{ + return + plugin => { + safe => 1, + rebuild => 0, + }, + websetup_force_plugins => { + type => "string", + example => [], + description => "list of plugins that cannot be enabled/disabled via the web interface", + safe => 0, + rebuild => 0, + }, + websetup_show_unsafe => { + type => "boolean", + example => 1, + description => "show unsafe settings, read-only, in web interface?", + safe => 0, + rebuild => 0, + }, +} #}}} + +sub checkconfig () { #{{{ + if (! exists $config{websetup_show_unsafe}) { + $config{websetup_show_unsafe}=1; + } +} #}}} + +sub formatexample ($$) { #{{{ + my $example=shift; + my $value=shift; + + if (defined $value && length $value) { + return ""; + } + elsif (defined $example && ! ref $example && length $example) { + return "
Example: $example"; + } + else { + return ""; + } +} #}}} + +sub showfields ($$$@) { #{{{ my $form=shift; - my $section=shift; + my $plugin=shift; + my $enabled=shift; + my @show; + my %plugininfo; while (@_) { my $key=shift; my %info=%{shift()}; - next if ! $info{safe} || $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} && $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'; - my $description=exists $info{description_html} ? $info{description_html} : $info{description}; + if ($key eq 'plugin') { + %plugininfo=%info; + next; + } + + 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 settings + @show=(); + } + + # 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}; + + 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 : $section.".".$key; my $value=$config{$key}; - # multiple plugins can have the same key - my $name=$section.".".$key; + + if ($info{safe} && (ref $value eq 'ARRAY' || ref $info{example} eq 'ARRAY')) { + $value=[@{$value}, "", ""]; # blank items for expansion + } if ($info{type} eq "string") { $form->field( name => $name, label => $description, - comment => exists $info{example} && length $info{example} && $info{example} ne $value ? "
Example: $info{example}" : "", + comment => formatexample($info{example}, $value), + type => "text", + value => $value, + size => 60, + fieldset => $section, + ); + } + elsif ($info{type} eq "pagespec") { + $form->field( + name => $name, + label => $description, + comment => formatexample($info{example}, $value), type => "text", value => $value, size => 60, + validate => \&IkiWiki::pagespec_valid, fieldset => $section, ); } @@ -43,8 +169,10 @@ sub addfields ($$@) { $form->field( name => $name, label => $description, + comment => formatexample($info{example}, $value), type => "text", value => $value, + size => 5, validate => '/^[0-9]+$/', fieldset => $section, ); @@ -54,11 +182,48 @@ sub addfields ($$@) { 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 { + $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 %enabledfields; +} #}}} + +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; } } @@ -71,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 $@; @@ -81,12 +250,40 @@ sub showform ($$) { #{{{ charset => "utf-8", method => 'POST', 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 { @@ -95,24 +292,152 @@ sub showform ($$) { #{{{ }); IkiWiki::decode_form_utf8($form); - $form->field(name => "do", type => "hidden", value => "setup", - force => 1); - addfields($form, gettext("main"), 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; + + # per-plugin setup require IkiWiki::Setup; foreach my $pair (IkiWiki::Setup::getsetup()) { my $plugin=$pair->[0]; my $setup=$pair->[1]; - addfields($form, $plugin." ".gettext("plugin"), @{$setup}); - } + my %shown=showfields($form, $plugin, $enabled_plugins{$plugin}, @{$setup}); + if (%shown) { + $fields{$_}=$shown{$_} foreach keys %shown; + } + } + if ($form->submitted eq "Cancel") { IkiWiki::redirect($cgi, $config{url}); return; } - elsif ($form->submitted eq 'Save Setup' && $form->validate) { - # TODO + 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 %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 (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); - $form->text(gettext("Setup saved.")); + } + } + else { + delete $rebuild{$field}; + } + next; + } + + if (ref $config{$key} eq "ARRAY" || ref $info{example} eq "ARRAY") { + @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; + } + } + elsif (ref $config{$key} || ref $info{example}) { + error("complex field $key"); # should never happen + } + else { + 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]; + } + } + } + + if (%rebuild && ! $form->field("rebuild_asked")) { + my $required=0; + foreach my $field ($form->field) { + $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 + } + else { + 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");
+			}
+
+			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);