German translation update. Closes: #471540
[ikiwiki.git] / IkiWiki / Plugin / external.pm
1 #!/usr/bin/perl
2 # Support for external plugins written in other languages.
3 # Communication via XML RPC a pipe.
4 # See externaldemo for an example of a plugin that uses this.
5 package IkiWiki::Plugin::external;
6
7 use warnings;
8 use strict;
9 use IkiWiki 2.00;
10 use RPC::XML;
11 use RPC::XML::Parser;
12 use IPC::Open2;
13 use IO::Handle;
14
15 my %plugins;
16
17 sub import { #{{{
18         my $self=shift;
19         my $plugin=shift;
20         return unless defined $plugin;
21
22         my ($plugin_read, $plugin_write);
23         my $pid = open2($plugin_read, $plugin_write,
24                 IkiWiki::possibly_foolish_untaint($plugin));
25
26         # open2 doesn't respect "use open ':utf8'"
27         binmode($plugin_read, ':utf8');
28         binmode($plugin_write, ':utf8');
29
30         $plugins{$plugin}={in => $plugin_read, out => $plugin_write, pid => $pid,
31                 accum => ""};
32         $RPC::XML::ENCODING="utf-8";
33
34         rpc_call($plugins{$plugin}, "import");
35 } #}}}
36
37 sub rpc_write ($$) { #{{{
38         my $fh=shift;
39         my $string=shift;
40
41         $fh->print($string."\n");
42         $fh->flush;
43 } #}}}
44
45 sub rpc_call ($$;@) { #{{{
46         my $plugin=shift;
47         my $command=shift;
48
49         # send the command
50         my $req=RPC::XML::request->new($command, @_);
51         rpc_write($plugin->{out}, $req->as_string);
52
53         # process incoming rpc until a result is available
54         while ($_ = $plugin->{in}->getline) {
55                 $plugin->{accum}.=$_;
56                 while ($plugin->{accum} =~ /^\s*(<\?xml\s.*?<\/(?:methodCall|methodResponse)>)\n(.*)/s) {
57                         $plugin->{accum}=$2;
58                         my $r = RPC::XML::Parser->new->parse($1);
59                         error("XML RPC parser failure: $r") unless ref $r;
60                         if ($r->isa('RPC::XML::response')) {
61                                 my $value=$r->value;
62                                 if ($r->is_fault($value)) {
63                                         # throw the error as best we can
64                                         print STDERR $value->string."\n";
65                                         return "";
66                                 }
67                                 elsif ($value->isa('RPC::XML::array')) {
68                                         return @{$value->value};
69                                 }
70                                 elsif ($value->isa('RPC::XML::struct')) {
71                                         return %{$value->value};
72                                 }
73                                 else {
74                                         return $value->value;
75                                 }
76                         }
77
78                         my $name=$r->name;
79                         my @args=map { $_->value } @{$r->args};
80
81                         # When dispatching a function, first look in 
82                         # IkiWiki::RPC::XML. This allows overriding
83                         # IkiWiki functions with RPC friendly versions.
84                         my $ret;
85                         if (exists $IkiWiki::RPC::XML::{$name}) {
86                                 $ret=$IkiWiki::RPC::XML::{$name}($plugin, @args);
87                         }
88                         elsif (exists $IkiWiki::{$name}) {
89                                 $ret=$IkiWiki::{$name}(@args);
90                         }
91                         else {
92                                 error("XML RPC call error, unknown function: $name");
93                         }
94
95                         my $string=eval { RPC::XML::response->new($ret)->as_string };
96                         if ($@ && ref $ret) {
97                                 # One common reason for serialisation to
98                                 # fail is a complex return type that cannot
99                                 # be represented as an XML RPC response.
100                                 # Handle this case by just returning 1.
101                                 $string=eval { RPC::XML::response->new(1)->as_string };
102                         }
103                         if ($@) {
104                                 error("XML response serialisation failed: $@");
105                         }
106                         rpc_write($plugin->{out}, $string);
107                 }
108         }
109
110         return undef;
111 } #}}}
112
113 package IkiWiki::RPC::XML;
114 use Memoize;
115
116 sub getvar ($$$) { #{{{
117         my $plugin=shift;
118         my $varname="IkiWiki::".shift;
119         my $key=shift;
120
121         no strict 'refs';
122         my $ret=$varname->{$key};
123         use strict 'refs';
124         return $ret;
125 } #}}}
126
127 sub setvar ($$$;@) { #{{{
128         my $plugin=shift;
129         my $varname="IkiWiki::".shift;
130         my $key=shift;
131
132         no strict 'refs';
133         my $ret=$varname->{$key}=@_;
134         use strict 'refs';
135         return $ret;
136 } #}}}
137
138 sub getstate ($$$$) { #{{{
139         my $plugin=shift;
140         my $page=shift;
141         my $id=shift;
142         my $key=shift;
143
144         return $IkiWiki::pagestate{$page}{$id}{$key};
145 } #}}}
146
147 sub setstate ($$$$;@) { #{{{
148         my $plugin=shift;
149         my $page=shift;
150         my $id=shift;
151         my $key=shift;
152
153         return $IkiWiki::pagestate{$page}{$id}{$key}=@_;
154 } #}}}
155
156 sub getargv ($) { #{{{
157         my $plugin=shift;
158
159         return @ARGV;
160 } #}}}
161
162 sub setargv ($@) { #{{{
163         my $plugin=shift;
164
165         @ARGV=@_;
166 } #}}}
167
168 sub inject ($@) { #{{{
169         # Bind a given perl function name to a particular RPC request.
170         my $plugin=shift;
171         my %params=@_;
172
173         if (! exists $params{name} || ! exists $params{call}) {
174                 die "inject needs name and call parameters";
175         }
176         my $sub = sub {
177                 IkiWiki::Plugin::external::rpc_call($plugin, $params{call}, @_)
178         };
179         eval qq{*$params{name}=\$sub};
180         memoize($params{name}) if $params{memoize};
181         return 1;
182 } #}}}
183
184 sub hook ($@) { #{{{
185         # the call parameter is a function name to call, since XML RPC
186         # cannot pass a function reference
187         my $plugin=shift;
188         my %params=@_;
189
190         my $callback=$params{call};
191         delete $params{call};
192
193         IkiWiki::hook(%params, call => sub {
194                 my $ret=IkiWiki::Plugin::external::rpc_call($plugin, $callback, @_);
195                 return $ret;
196         });
197 } #}}}
198
199 sub pagespec_match ($@) { #{{{
200         # convert pagespec_match's return object into a XML RPC boolean
201         my $plugin=shift;
202
203         return RPC::XML::boolean->new(0 + IkiWiki::pagespec_march(@_));
204 } #}}}
205
206 1