git: change calling convention of safe_git to have named arguments

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

diff --git a/IkiWiki/Plugin/websetup.pm b/IkiWiki/Plugin/websetup.pm
index 9edd22d2625ddf474fc419d84b6bc544ba6c3270..f95017c90d71a6408dbd81028fcb15b32c7a3265 100644 (file)
--- a/IkiWiki/Plugin/websetup.pm
+++ b/IkiWiki/Plugin/websetup.pm
@@ -18,6 +18,7 @@ sub getsetup () {
                plugin => {
                        safe => 1,
                        rebuild => 0,
                plugin => {
                        safe => 1,
                        rebuild => 0,

+                       section => "web",

                },
                websetup_force_plugins => {
                        type => "string",
                },
                websetup_force_plugins => {
                        type => "string",


@@ -26,6 +27,13 @@ sub getsetup () {
                        safe => 0,
                        rebuild => 0,
                },
                        safe => 0,
                        rebuild => 0,
                },

+               websetup_unsafe => {
+                       type => "string",
+                       example => [],
+                       description => "list of additional setup field keys to treat as unsafe",
+                       safe => 0,
+                       rebuild => 0,
+               },

                websetup_show_unsafe => {
                        type => "boolean",
                        example => 1,
                websetup_show_unsafe => {
                        type => "boolean",
                        example => 1,


@@ -56,6 +64,12 @@ sub formatexample ($$) {
        }
 }
 
        }
 }
 

+sub issafe ($) {
+       my $key=shift;
+
+       return ! grep { $_ eq $key } @{$config{websetup_unsafe}};
+}
+

 sub showfields ($$$@) {
        my $form=shift;
        my $plugin=shift;
 sub showfields ($$$@) {
        my $form=shift;
        my $plugin=shift;


@@ -66,27 +80,30 @@ sub showfields ($$$@) {
        while (@_) {
                my $key=shift;
                my %info=%{shift()};
        while (@_) {
                my $key=shift;
                my %info=%{shift()};

+               
+               if ($key eq 'plugin') {
+                       %plugininfo=%info;
+                       next;
+               }

 
                # 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
 
                # 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});
+               next if ! ($config{websetup_show_unsafe} && $config{websetup_advanced}) &&
+                       (! $info{safe} || ! issafe($key));

                # 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';
 
                # 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;
        }
 
                push @show, $key, \%info;
        }
 

-       my $section=defined $plugin ? $plugin." ".gettext("plugin") : "main";
+       my $section=defined $plugin
+               ? sprintf(gettext("%s plugin:"), $plugininfo{section})." ".$plugin
+               : "main";

        my %enabledfields;
        my $shownfields=0;
        
        my %enabledfields;
        my $shownfields=0;
        


@@ -97,6 +114,16 @@ sub showfields ($$$@) {
                @show=();
        }
 
                @show=();
        }
 

+       my $section_fieldset;
+       if (defined $plugin) {
+               # Define the combined fieldset for the plugin's section.
+               # This ensures that this fieldset comes first.
+               $section_fieldset=sprintf(gettext("%s plugins"), $plugininfo{section});
+               $form->field(name => "placeholder.$plugininfo{section}",
+                       type => "hidden",
+                       fieldset => $section_fieldset);
+       }
+

        # show plugin toggle
        if (defined $plugin && (! $plugin_forced || $config{websetup_advanced})) {
                my $name="enable.$plugin";
        # show plugin toggle
        if (defined $plugin && (! $plugin_forced || $config{websetup_advanced})) {
                my $name="enable.$plugin";


@@ -124,7 +151,10 @@ sub showfields ($$$@) {
                my %info=%{shift @show};
 
                my $description=$info{description};
                my %info=%{shift @show};
 
                my $description=$info{description};

-               if (exists $info{link} && length $info{link}) {
+               if (exists $info{htmldescription}) {
+                       $description=$info{htmldescription};
+               }
+               elsif (exists $info{link} && length $info{link}) {

                        if ($info{link} =~ /^\w+:\/\//) {
                                $description="<a href=\"$info{link}\">$description</a>";
                        }
                        if ($info{link} =~ /^\w+:\/\//) {
                                $description="<a href=\"$info{link}\">$description</a>";
                        }


@@ -137,9 +167,16 @@ sub showfields ($$$@) {
                my $name=defined $plugin ? $plugin.".".$key : $section.".".$key;
 
                my $value=$config{$key};
                my $name=defined $plugin ? $plugin.".".$key : $section.".".$key;
 
                my $value=$config{$key};

+               if (! defined $value) {
+                       $value="";
+               }

 
 

-               if ($info{safe} && (ref $value eq 'ARRAY' || ref $info{example} eq 'ARRAY')) {
-                       $value=[(ref $value eq 'ARRAY' ? @{$value} : ""), "", ""]; # blank items for expansion
+               if (ref $value eq 'ARRAY' || ref $info{example} eq 'ARRAY') {
+                       $value=[(ref $value eq 'ARRAY' ? map { Encode::encode_utf8($_) }  @{$value} : "")];
+                       push @$value, "", "" if $info{safe} && issafe($key); # blank items for expansion
+               }
+               else {
+                       $value=Encode::encode_utf8($value);

                }
 
                if ($info{type} eq "string") {
                }
 
                if ($info{type} eq "string") {


@@ -185,12 +222,13 @@ sub showfields ($$$@) {
                                options => [ [ 1 => $description ] ],
                                fieldset => $section,
                        );
                                options => [ [ 1 => $description ] ],
                                fieldset => $section,
                        );

-                       if (! $form->submitted) {
+                       if (! $form->submitted ||
+                           ($info{advanced} && $form->submitted eq 'Advanced Mode')) {

                                $form->field(name => $name, value => $value);
                        }
                }
                
                                $form->field(name => $name, value => $value);
                        }
                }
                

-               if (! $info{safe}) {
+               if (! $info{safe} || ! issafe($key)) {

                        $form->field(name => $name, disabled => 1);
                }
                else {
                        $form->field(name => $name, disabled => 1);
                }
                else {


@@ -199,11 +237,11 @@ sub showfields ($$$@) {
                $shownfields++;
        }
        
                $shownfields++;
        }
        

-       # if no fields were shown for the plugin, drop it into the
-       # plugins fieldset
+       # if no fields were shown for the plugin, drop it into a combined
+       # fieldset for its section

        if (defined $plugin && (! $plugin_forced || $config{websetup_advanced}) &&
            ! $shownfields) {
        if (defined $plugin && (! $plugin_forced || $config{websetup_advanced}) &&
            ! $shownfields) {

-               $form->field(name => "enable.$plugin", fieldset => "plugins");
+               $form->field(name => "enable.$plugin", fieldset => $section_fieldset);

        }
 
        return %enabledfields;
        }
 
        return %enabledfields;


@@ -219,18 +257,16 @@ sub enable_plugin ($) {
 sub disable_plugin ($) {
        my $plugin=shift;
 
 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;
-       }
+       $config{add_plugins}=[grep { $_ ne $plugin } @{$config{add_plugins}}];
+       push @{$config{disable_plugins}}, $plugin;

 }
 
 sub showform ($$) {
        my $cgi=shift;
        my $session=shift;
 
 }
 
 sub showform ($$) {
        my $cgi=shift;
        my $session=shift;
 

+       IkiWiki::needsignin($cgi, $session);
+

        if (! defined $session->param("name") || 
            ! IkiWiki::is_admin($session->param("name"))) {
                error(gettext("you are not logged in as an admin"));
        if (! defined $session->param("name") || 
            ! IkiWiki::is_admin($session->param("name"))) {
                error(gettext("you are not logged in as an admin"));


@@ -254,16 +290,16 @@ sub showform ($$) {
                params => $cgi,
                fieldsets => [
                        [main => gettext("main")], 
                params => $cgi,
                fieldsets => [
                        [main => gettext("main")], 

-                       [plugins => gettext("plugins")]

                ],
                ],

-               action => $config{cgiurl},
+               action => IkiWiki::cgiurl(),

                template => {type => 'div'},
                template => {type => 'div'},

-               stylesheet => IkiWiki::baseurl()."style.css",
+               stylesheet => 1,

        );
        
        $form->field(name => "do", type => "hidden", value => "setup",
                force => 1);
        $form->field(name => "rebuild_asked", type => "hidden");
        );
        
        $form->field(name => "do", type => "hidden", value => "setup",
                force => 1);
        $form->field(name => "rebuild_asked", type => "hidden");

+       $form->field(name => "showadvanced", type => "hidden");

 
        if ($form->submitted eq 'Basic Mode') {
                $form->field(name => "showadvanced", type => "hidden", 
 
        if ($form->submitted eq 'Basic Mode') {
                $form->field(name => "showadvanced", type => "hidden", 


@@ -290,7 +326,6 @@ sub showform ($$) {
                shift->(form => $form, cgi => $cgi, session => $session,
                        buttons => $buttons);
        });
                shift->(form => $form, cgi => $cgi, session => $session,
                        buttons => $buttons);
        });

-       IkiWiki::decode_form_utf8($form);

 
        my %fields=showfields($form, undef, undef, IkiWiki::getsetup());
        
 
        my %fields=showfields($form, undef, undef, IkiWiki::getsetup());
        


@@ -308,9 +343,11 @@ sub showform ($$) {
                        $fields{$_}=$shown{$_} foreach keys %shown;
                }
        }
                        $fields{$_}=$shown{$_} foreach keys %shown;
                }
        }

+
+       IkiWiki::decode_form_utf8($form);

        
        if ($form->submitted eq "Cancel") {
        
        if ($form->submitted eq "Cancel") {

-               IkiWiki::redirect($cgi, $config{url});
+               IkiWiki::redirect($cgi, IkiWiki::baseurl(undef));

                return;
        }
        elsif (($form->submitted eq 'Save Setup' || $form->submitted eq 'Rebuild Wiki') && $form->validate) {
                return;
        }
        elsif (($form->submitted eq 'Save Setup' || $form->submitted eq 'Rebuild Wiki') && $form->validate) {


@@ -326,7 +363,7 @@ sub showform ($$) {
                                @value=0;
                        }
                
                                @value=0;
                        }
                

-                       if (! $info{safe}) {
+                       if (! $info{safe} || ! issafe($key)) {

                                error("unsafe field $key"); # should never happen
                        }
                
                                error("unsafe field $key"); # should never happen
                        }
                


@@ -357,7 +394,11 @@ sub showform ($$) {
                                @value=sort grep { length $_ } @value;
                                my @oldvalue=sort grep { length $_ }
                                        (defined $config{$key} ? @{$config{$key}} : ());
                                @value=sort grep { length $_ } @value;
                                my @oldvalue=sort grep { length $_ }
                                        (defined $config{$key} ? @{$config{$key}} : ());

-                               if ((@oldvalue) == (@value)) {
+                               my $same=(@oldvalue) == (@value);
+                               for (my $x=0; $same && $x < @value; $x++) {
+                                       $same=0 if $value[$x] ne $oldvalue[$x];
+                               }
+                               if ($same) {

                                        delete $rebuild{$field};
                                }
                                else {
                                        delete $rebuild{$field};
                                }
                                else {


@@ -409,10 +450,10 @@ sub showform ($$) {
                        IkiWiki::saveindex();
                        IkiWiki::unlockwiki();
 
                        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);
+                       # Print the top part of a standard cgitemplate,
+                       # then show the rebuild or refresh, live.
+                       my $divider="\0";
+                       my $html=IkiWiki::cgitemplate($cgi, "setup", $divider);

                        IkiWiki::printheader($session);
                        my ($head, $tail)=split($divider, $html, 2);
                        print $head."<pre>\n";
                        IkiWiki::printheader($session);
                        my ($head, $tail)=split($divider, $html, 2);
                        print $head."<pre>\n";


@@ -437,7 +478,7 @@ sub showform ($$) {
                                                join(" ", @command), $ret).
                                        '</p>';
                                open(OUT, ">", $config{setupfile}) || error("$config{setupfile}: $!");
                                                join(" ", @command), $ret).
                                        '</p>';
                                open(OUT, ">", $config{setupfile}) || error("$config{setupfile}: $!");

-                               print OUT $oldsetup;
+                               print OUT Encode::encode_utf8($oldsetup);

                                close OUT;
                        }
 
                                close OUT;
                        }
 


@@ -463,9 +504,10 @@ sub formbuilder_setup (@) {
        my %params=@_;
 
        my $form=$params{form};
        my %params=@_;
 
        my $form=$params{form};

-       if ($form->title eq "preferences") {
-               push @{$params{buttons}}, "Wiki Setup";
-               if ($form->submitted && $form->submitted eq "Wiki Setup") {
+       if ($form->title eq "preferences" &&
+           IkiWiki::is_admin($params{session}->param("name"))) {
+               push @{$params{buttons}}, "Setup";
+               if ($form->submitted && $form->submitted eq "Setup") {

                        showform($params{cgi}, $params{session});
                        exit;
                }
                        showform($params{cgi}, $params{session});
                        exit;
                }