remove bogus symlink

[git.ikiwiki.info.git] / IkiWiki / Plugin / websetup.pm

diff --git a/IkiWiki/Plugin/websetup.pm b/IkiWiki/Plugin/websetup.pm
index a30475977e2b07ef74d24666f3c8af6c3389bd09..dec360d68d21f903049e7f45765f0f9338c714bc 100644 (file)
--- a/IkiWiki/Plugin/websetup.pm
+++ b/IkiWiki/Plugin/websetup.pm
@@ -6,36 +6,154 @@ use strict;
 use IkiWiki 2.00;
 
 sub import { #{{{
 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);
 } # }}}
 
             call => \&formbuilder_setup);
 } # }}}
 

-sub addfields ($$@) {
+sub getsetup () { #{{{
+       return
+               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 "<br/ ><small>Example: <tt>$example</tt></small>";
+       }
+       else {
+               return "";
+       }
+} #}}}
+
+sub showfields ($$$@) { #{{{

        my $form=shift;
        my $form=shift;

-       my $section=shift;
+       my $plugin=shift;
+       my $enabled=shift;

 
 

+       my @show;
+       my %plugininfo;

        while (@_) {
                my $key=shift;
                my %info=%{shift()};
 
        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 configuration
+               @show=();
+       }
+       # show plugin toggle
+       if (defined $plugin && (! $plugin_forced || $config{websetup_advanced})) {
+               my $name="enable.$plugin";
+               $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 {
+                       $enabledfields{$name}=[$name, \%plugininfo];
+               }
+       }
+
+       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="<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 $value=$config{$key};
 
                my $value=$config{$key};

-               # multiple plugins can have the same key
-               my $name=$section.".".$key;
+
+               if ($info{safe} && (ref $config{$key} eq 'ARRAY' || ref $info{example} eq 'ARRAY')) {
+                       push @{$value}, "", ""; # blank items for expansion
+               }

 
                if ($info{type} eq "string") {
                        $form->field(
                                name => $name,
                                label => $description,
 
                if ($info{type} eq "string") {
                        $form->field(
                                name => $name,
                                label => $description,

-                               comment => exists $info{example} && length $info{example} && $info{example} ne $value ? "<br/ ><small>Example: <tt>$info{example}</tt></small>" : "",
+                               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,
                                type => "text",
                                value => $value,
                                size => 60,

+                               validate => \&IkiWiki::pagespec_valid,

                                fieldset => $section,
                        );
                }
                                fieldset => $section,
                        );
                }


@@ -43,8 +161,10 @@ sub addfields ($$@) {
                        $form->field(
                                name => $name,
                                label => $description,
                        $form->field(
                                name => $name,
                                label => $description,

+                               comment => formatexample($info{example}, $value),

                                type => "text",
                                value => $value,
                                type => "text",
                                value => $value,

+                               size => 5,

                                validate => '/^[0-9]+$/',
                                fieldset => $section,
                        );
                                validate => '/^[0-9]+$/',
                                fieldset => $section,
                        );


@@ -59,8 +179,25 @@ sub addfields ($$@) {
                                fieldset => $section,
                        );
                }
                                fieldset => $section,
                        );
                }

+               
+               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 showform ($$) { #{{{
        my $cgi=shift;
 
 sub showform ($$) { #{{{
        my $cgi=shift;


@@ -81,12 +218,36 @@ sub showform ($$) { #{{{
                charset => "utf-8",
                method => 'POST',
                javascript => 0,
                charset => "utf-8",
                method => 'POST',
                javascript => 0,

+               reset => 1,

                params => $cgi,
                params => $cgi,

+               fieldsets => [
+                       [main => gettext("main")], 
+                       [plugins => gettext("plugins")]
+               ],

                action => $config{cgiurl},
                template => {type => 'div'},
                stylesheet => IkiWiki::baseurl()."style.css",
        );
                action => $config{cgiurl},
                template => {type => 'div'},
                stylesheet => IkiWiki::baseurl()."style.css",
        );

-       my $buttons=["Save Setup", "Cancel"];
+
+       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 {
 
        IkiWiki::decode_form_utf8($form);
        IkiWiki::run_hooks(formbuilder_setup => sub {


@@ -97,22 +258,89 @@ sub showform ($$) { #{{{
 
        $form->field(name => "do", type => "hidden", value => "setup",
                force => 1);
 
        $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;
        require IkiWiki::Setup;

+       my %plugins=map { $_ => 1 } IkiWiki::listplugins();

        foreach my $pair (IkiWiki::Setup::getsetup()) {
                my $plugin=$pair->[0];
                my $setup=$pair->[1];
        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) {
+                       delete $plugins{$plugin};
+                       $fields{$_}=$shown{$_} foreach keys %shown;
+               }
+       }
+       

        if ($form->submitted eq "Cancel") {
                IkiWiki::redirect($cgi, $config{url});
                return;
        }
        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) {
+               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
+                       }

 
 

-               $form->text(gettext("Setup saved."));
+                       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);
        }
 
        IkiWiki::showform($form, $buttons, $session, $cgi);