po: avoid warnings and possible bugs with nested named subroutines

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

diff --git a/IkiWiki/Plugin/external.pm b/IkiWiki/Plugin/external.pm
index a90c5d8e2faf1247946a12350320b13ea0b9c4f2..066f15cf1b2f12ef4a027e5c9842d1b859358f23 100644 (file)
--- a/IkiWiki/Plugin/external.pm
+++ b/IkiWiki/Plugin/external.pm
@@ -1,12 +1,12 @@
 #!/usr/bin/perl
 # Support for external plugins written in other languages.
 #!/usr/bin/perl
 # Support for external plugins written in other languages.

-# Communication via XML RPC a pipe.
+# Communication via XML RPC to a pipe.

 # See externaldemo for an example of a plugin that uses this.
 package IkiWiki::Plugin::external;
 
 use warnings;
 use strict;
 # See externaldemo for an example of a plugin that uses this.
 package IkiWiki::Plugin::external;
 
 use warnings;
 use strict;

-use IkiWiki 2.00;
+use IkiWiki 3.00;

 use RPC::XML;
 use RPC::XML::Parser;
 use IPC::Open2;
 use RPC::XML;
 use RPC::XML::Parser;
 use IPC::Open2;


@@ -14,7 +14,7 @@ use IO::Handle;
 
 my %plugins;
 
 
 my %plugins;
 

-sub import { #{{{
+sub import {

        my $self=shift;
        my $plugin=shift;
        return unless defined $plugin;
        my $self=shift;
        my $plugin=shift;
        return unless defined $plugin;


@@ -32,17 +32,17 @@ sub import { #{{{
        $RPC::XML::ENCODING="utf-8";
 
        rpc_call($plugins{$plugin}, "import");
        $RPC::XML::ENCODING="utf-8";
 
        rpc_call($plugins{$plugin}, "import");

-} #}}}
+}

 
 

-sub rpc_write ($$) { #{{{
+sub rpc_write ($$) {

        my $fh=shift;
        my $string=shift;
 
        $fh->print($string."\n");
        $fh->flush;
        my $fh=shift;
        my $string=shift;
 
        $fh->print($string."\n");
        $fh->flush;

-} #}}}
+}

 
 

-sub rpc_call ($$;@) { #{{{
+sub rpc_call ($$;@) {

        my $plugin=shift;
        my $command=shift;
 
        my $plugin=shift;
        my $command=shift;
 


@@ -68,7 +68,22 @@ sub rpc_call ($$;@) { #{{{
                                        return @{$value->value};
                                }
                                elsif ($value->isa('RPC::XML::struct')) {
                                        return @{$value->value};
                                }
                                elsif ($value->isa('RPC::XML::struct')) {

-                                       return %{$value->value};
+                                       my %hash=%{$value->value};
+
+                                       # XML-RPC v1 does not allow for
+                                       # nil/null/None/undef values to be
+                                       # transmitted, so until
+                                       # XML::RPC::Parser honours v2
+                                       # (<nil/>), external plugins send
+                                       # a hash with one key "null" pointing
+                                       # to an empty string.
+                                       if (exists $hash{null} &&
+                                           $hash{null} eq "" &&
+                                           int(keys(%hash)) == 1) {
+                                               return undef;
+                                       }
+
+                                       return %hash;

                                }
                                else {
                                        return $value->value;
                                }
                                else {
                                        return $value->value;


@@ -92,6 +107,14 @@ sub rpc_call ($$;@) { #{{{
                                error("XML RPC call error, unknown function: $name");
                        }
 
                                error("XML RPC call error, unknown function: $name");
                        }
 

+                       # XML-RPC v1 does not allow for nil/null/None/undef
+                       # values to be transmitted, so until XML::RPC::Parser
+                       # honours v2 (<nil/>), send a hash with one key "null"
+                       # pointing to an empty string.
+                       if (! defined $ret) {
+                               $ret={"null" => ""};
+                       }
+

                        my $string=eval { RPC::XML::response->new($ret)->as_string };
                        if ($@ && ref $ret) {
                                # One common reason for serialisation to
                        my $string=eval { RPC::XML::response->new($ret)->as_string };
                        if ($@ && ref $ret) {
                                # One common reason for serialisation to


@@ -108,12 +131,12 @@ sub rpc_call ($$;@) { #{{{
        }
 
        return undef;
        }
 
        return undef;

-} #}}}
+}

 
 package IkiWiki::RPC::XML;
 use Memoize;
 
 
 package IkiWiki::RPC::XML;
 use Memoize;
 

-sub getvar ($$$) { #{{{
+sub getvar ($$$) {

        my $plugin=shift;
        my $varname="IkiWiki::".shift;
        my $key=shift;
        my $plugin=shift;
        my $varname="IkiWiki::".shift;
        my $key=shift;


@@ -122,50 +145,53 @@ sub getvar ($$$) { #{{{
        my $ret=$varname->{$key};
        use strict 'refs';
        return $ret;
        my $ret=$varname->{$key};
        use strict 'refs';
        return $ret;

-} #}}}
+}

 
 

-sub setvar ($$$;@) { #{{{
+sub setvar ($$$;@) {

        my $plugin=shift;
        my $varname="IkiWiki::".shift;
        my $key=shift;
        my $plugin=shift;
        my $varname="IkiWiki::".shift;
        my $key=shift;

+       my $value=shift;

 
        no strict 'refs';
 
        no strict 'refs';

-       my $ret=$varname->{$key}=@_;
+       my $ret=$varname->{$key}=$value;

        use strict 'refs';
        return $ret;
        use strict 'refs';
        return $ret;

-} #}}}
+}

 
 

-sub getstate ($$$$) { #{{{
+sub getstate ($$$$) {

        my $plugin=shift;
        my $page=shift;
        my $id=shift;
        my $key=shift;
 
        return $IkiWiki::pagestate{$page}{$id}{$key};
        my $plugin=shift;
        my $page=shift;
        my $id=shift;
        my $key=shift;
 
        return $IkiWiki::pagestate{$page}{$id}{$key};

-} #}}}
+}

 
 

-sub setstate ($$$$;@) { #{{{
+sub setstate ($$$$;@) {

        my $plugin=shift;
        my $page=shift;
        my $id=shift;
        my $key=shift;
        my $plugin=shift;
        my $page=shift;
        my $id=shift;
        my $key=shift;

+       my $value=shift;

 
 

-       return $IkiWiki::pagestate{$page}{$id}{$key}=@_;
-} #}}}
+       return $IkiWiki::pagestate{$page}{$id}{$key}=$value;
+}

 
 

-sub getargv ($) { #{{{
+sub getargv ($) {

        my $plugin=shift;
 
        return \@ARGV;
        my $plugin=shift;
 
        return \@ARGV;

-} #}}}
+}

 
 

-sub setargv ($@) { #{{{
+sub setargv ($@) {

        my $plugin=shift;
        my $plugin=shift;

+       my $array=shift;

 
 

-       @ARGV=@_;
-} #}}}
+       @ARGV=@$array;
+}

 
 

-sub inject ($@) { #{{{
+sub inject ($@) {

        # Bind a given perl function name to a particular RPC request.
        my $plugin=shift;
        my %params=@_;
        # Bind a given perl function name to a particular RPC request.
        my $plugin=shift;
        my %params=@_;


@@ -176,12 +202,20 @@ sub inject ($@) { #{{{
        my $sub = sub {
                IkiWiki::Plugin::external::rpc_call($plugin, $params{call}, @_)
        };
        my $sub = sub {
                IkiWiki::Plugin::external::rpc_call($plugin, $params{call}, @_)
        };

+       $sub=memoize($sub) if $params{memoize};
+
+       # This will add it to the symbol table even if not present.
+       no warnings;

        eval qq{*$params{name}=\$sub};
        eval qq{*$params{name}=\$sub};

-       memoize($params{name}) if $params{memoize};
+       use warnings;
+
+       # This will ensure that everywhere it was exported to sees
+       # the injected version.
+       IkiWiki::inject(name => $params{name}, call => $sub);

        return 1;
        return 1;

-} #}}}
+}

 
 

-sub hook ($@) { #{{{
+sub hook ($@) {

        # the call parameter is a function name to call, since XML RPC
        # cannot pass a function reference
        my $plugin=shift;
        # the call parameter is a function name to call, since XML RPC
        # cannot pass a function reference
        my $plugin=shift;


@@ -191,16 +225,15 @@ sub hook ($@) { #{{{
        delete $params{call};
 
        IkiWiki::hook(%params, call => sub {
        delete $params{call};
 
        IkiWiki::hook(%params, call => sub {

-               my $ret=IkiWiki::Plugin::external::rpc_call($plugin, $callback, @_);
-               return $ret;
+               IkiWiki::Plugin::external::rpc_call($plugin, $callback, @_);

        });
        });

-} #}}}
+}

 
 

-sub pagespec_match ($@) { #{{{
+sub pagespec_match ($@) {

        # convert pagespec_match's return object into a XML RPC boolean
        my $plugin=shift;
 
        return RPC::XML::boolean->new(0 + IkiWiki::pagespec_march(@_));
        # convert pagespec_match's return object into a XML RPC boolean
        my $plugin=shift;
 
        return RPC::XML::boolean->new(0 + IkiWiki::pagespec_march(@_));

-} #}}}
+}

 
 1
 
 1