ViewVC Help
View File | Revision Log | Show Annotations | Download File
/cvs/AnyEvent-FCP/FCP.pm
(Generate patch)

Comparing AnyEvent-FCP/FCP.pm (file contents):
Revision 1.7 by root, Sat Jun 5 14:49:25 2010 UTC vs.
Revision 1.14 by root, Sat Aug 8 14:09:47 2015 UTC

35 35
36 use AnyEvent::FCP; 36 use AnyEvent::FCP;
37 37
38 my $fcp = new AnyEvent::FCP; 38 my $fcp = new AnyEvent::FCP;
39 39
40 $fcp->watch_global_sync (1, 0); 40 $fcp->watch_global (1, 0);
41 my $req = $fcp->list_persistent_requests_sync; 41 my $req = $fcp->list_persistent_requests;
42 42
43TODO
43 for my $req (values %$req) { 44 for my $req (values %$req) {
44 if ($req->{filename} =~ /a/) { 45 if ($req->{filename} =~ /a/) {
45 $fcp->modify_persistent_request_sync (1, $req->{identifier}, undef, 0); 46 $fcp->modify_persistent_request (1, $req->{identifier}, undef, 0);
46 } 47 }
47 } 48 }
48 49
49=head2 IMPORT TAGS 50=head2 IMPORT TAGS
50 51
51Nothing much can be "imported" from this module right now. 52Nothing much can be "imported" from this module right now.
52 53
53=head2 THE AnyEvent::FCP CLASS 54=head1 THE AnyEvent::FCP CLASS
54 55
55=over 4 56=over 4
56 57
57=cut 58=cut
58 59
66 67
67use Scalar::Util (); 68use Scalar::Util ();
68 69
69use AnyEvent; 70use AnyEvent;
70use AnyEvent::Handle; 71use AnyEvent::Handle;
72use AnyEvent::Util ();
71 73
72sub touc($) { 74sub touc($) {
73 local $_ = shift; 75 local $_ = shift;
74 1 while s/((?:^|_)(?:svk|chk|uri|fcp|ds|mime)(?:_|$))/\U$1/; 76 1 while s/((?:^|_)(?:svk|chk|uri|fcp|ds|mime|dda)(?:_|$))/\U$1/;
75 s/(?:^|_)(.)/\U$1/g; 77 s/(?:^|_)(.)/\U$1/g;
76 $_ 78 $_
77} 79}
78 80
79sub tolc($) { 81sub tolc($) {
80 local $_ = shift; 82 local $_ = shift;
81 1 while s/(SVK|CHK|URI|FCP|DS|MIME)([^_])/$1\_$2/i; 83 1 while s/(SVK|CHK|URI|FCP|DS|MIME|DDA)([^_])/$1\_$2/;
82 1 while s/([^_])(SVK|CHK|URI|FCP|DS|MIME)/$1\_$2/i; 84 1 while s/([^_])(SVK|CHK|URI|FCP|DS|MIME|DDA)/$1\_$2/;
83 s/(?<=[a-z])(?=[A-Z])/_/g; 85 s/(?<=[a-z])(?=[A-Z])/_/g;
84 lc 86 lc
85} 87}
86 88
87=item $fcp = new AnyEvent::FCP [host => $host][, port => $port][, progress => \&cb][, name => $name] 89=item $fcp = new AnyEvent::FCP [host => $host][, port => $port][, name => $name]
88 90
89Create a new FCP connection to the given host and port (default 91Create a new FCP connection to the given host and port (default
90127.0.0.1:9481, or the environment variables C<FREDHOST> and C<FREDPORT>). 92127.0.0.1:9481, or the environment variables C<FREDHOST> and C<FREDPORT>).
91 93
92If no C<name> was specified, then AnyEvent::FCP will generate a 94If no C<name> was specified, then AnyEvent::FCP will generate a
93(hopefully) unique client name for you. 95(hopefully) unique client name for you.
94 96
95You can install a progress callback that is being called with the AnyEvent::FCP
96object, the type, a hashref with key-value pairs and a reference to any received data,
97for all unsolicited messages.
98
99Example:
100
101 sub progress_cb {
102 my ($self, $type, $kv, $rdata) = @_;
103
104 if ($type eq "simple_progress") {
105 warn "$kv->{identifier} $kv->{succeeded}/$kv->{required}\n";
106 }
107 }
108
109=cut 97=cut
110 98
111sub new { 99sub new {
112 my $class = shift; 100 my $class = shift;
101
102 my $rand = join "", map chr 0x21 + rand 94, 1..40; # ~ 262 bits entropy
103
113 my $self = bless { @_ }, $class; 104 my $self = bless {
114 105 host => $ENV{FREDHOST} || "127.0.0.1",
115 $self->{host} ||= $ENV{FREDHOST} || "127.0.0.1"; 106 port => $ENV{FREDPORT} || 9481,
116 $self->{port} ||= $ENV{FREDPORT} || 9481; 107 timeout => 3600 * 2,
117 $self->{name} ||= time.rand.rand.rand; # lame 108 name => time.rand.rand.rand, # lame
118 $self->{timeout} ||= 600; 109 @_,
119 $self->{progress} ||= sub { }; 110 queue => [],
120 111 req => {},
121 $self->{id} = "a0"; 112 prefix => "..:aefcpid-$rand:",
113 idseq => "a0",
114 }, $class;
122 115
123 { 116 {
124 Scalar::Util::weaken (my $self = $self); 117 Scalar::Util::weaken (my $self = $self);
125 118
126 $self->{hdl} = new AnyEvent::Handle 119 $self->{hdl} = new AnyEvent::Handle
127 connect => [$self->{host} => $self->{port}], 120 connect => [$self->{host} => $self->{port}],
128 timeout => $self->{timeout}, 121 timeout => $self->{timeout},
129 on_error => sub { 122 on_error => sub {
130 warn "<@_>\n"; 123 warn "@_\n";#d#
131 exit 1; 124 exit 1;
132 }, 125 },
133 on_read => sub { $self->on_read (@_) }, 126 on_read => sub { $self->on_read (@_) },
134 on_eof => $self->{on_eof} || sub { }; 127 on_eof => $self->{on_eof} || sub { };
135 128
136 Scalar::Util::weaken ($self->{hdl}{fcp} = $self); 129 Scalar::Util::weaken ($self->{hdl}{fcp} = $self);
137 } 130 }
138 131
139 $self->send_msg ( 132 $self->send_msg (client_hello =>
140 client_hello =>
141 name => $self->{name}, 133 name => $self->{name},
142 expected_version => "2.0", 134 expected_version => "2.0",
143 ); 135 );
144 136
145 $self 137 $self
146} 138}
147 139
140sub identifier {
141 $_[0]{prefix} . ++$_[0]{idseq}
142}
143
148sub send_msg { 144sub send_msg {
149 my ($self, $type, %kv) = @_; 145 my ($self, $type, %kv) = @_;
150 146
151 my $data = delete $kv{data}; 147 my $data = delete $kv{data};
152 148
153 if (exists $kv{id_cb}) { 149 if (exists $kv{id_cb}) {
154 my $id = $kv{identifier} || ++$self->{id}; 150 my $id = $kv{identifier} ||= $self->identifier;
155 $self->{id}{$id} = delete $kv{id_cb}; 151 $self->{id}{$id} = delete $kv{id_cb};
156 $kv{identifier} = $id;
157 } 152 }
158 153
159 my $msg = (touc $type) . "\012" 154 my $msg = (touc $type) . "\012"
160 . join "", map +(touc $_) . "=$kv{$_}\012", keys %kv; 155 . join "", map +(touc $_) . "=$kv{$_}\012", keys %kv;
161 156
173 } 168 }
174 169
175 $self->{hdl}->push_write ($msg); 170 $self->{hdl}->push_write ($msg);
176} 171}
177 172
173sub on {
174 my ($self, $cb) = @_;
175
176 # cb return undef - message eaten, remove cb
177 # cb return 0 - message eaten
178 # cb return 1 - pass to next
179
180 push @{ $self->{on} }, $cb;
181}
182
183sub _push_queue {
184 my ($self, $queue) = @_;
185
186 shift @$queue;
187 $queue->[0]($self, AnyEvent::Util::guard { $self->_push_queue ($queue) })
188 if @$queue;
189}
190
191# lock so only one $type (arbitrary string) is in flight,
192# to work around horribly misdesigned protocol.
193sub serialise {
194 my ($self, $type, $cb) = @_;
195
196 my $queue = $self->{serialise}{$type} ||= [];
197 push @$queue, $cb;
198 $cb->($self, AnyEvent::Util::guard { $self->_push_queue ($queue) })
199 unless $#$queue;
200}
201
202# how to merge these types into $self->{persistent}
203our %PERSISTENT_TYPE = (
204 persistent_get => sub { %{ $_[1] } = (type => "persistent_get" , %{ $_[2] }) },
205 persistent_put => sub { %{ $_[1] } = (type => "persistent_put" , %{ $_[2] }) },
206 persistent_put_dir => sub { %{ $_[1] } = (type => "persistent_put_dir", %{ $_[2] }) },
207 persistent_request_modified => sub { %{ $_[1] } = (%{ $_[1] }, %{ $_[2] }) },
208 persistent_request_removed => sub { delete $_[0]{req}{$_[2]{identifier}} },
209
210 simple_progress => sub { $_[1]{simple_progress} = $_[2] }, # get/put
211
212 uri_generated => sub { $_[1]{uri_generated} = $_[2] }, # put
213 generated_metadata => sub { $_[1]{generated_metadata} = $_[2] }, # put
214 started_compression => sub { $_[1]{started_compression} = $_[2] }, # put
215 finished_compression => sub { $_[1]{finished_compression} = $_[2] }, # put
216 put_fetchable => sub { $_[1]{put_fetchable} = $_[2] }, # put
217 put_failed => sub { $_[1]{put_failed} = $_[2] }, # put
218 put_successful => sub { $_[1]{put_successful} = $_[2] }, # put
219
220 sending_to_network => sub { $_[1]{sending_to_network} = $_[2] }, # get
221 compatibility_mode => sub { $_[1]{compatibility_mode} = $_[2] }, # get
222 expected_hashes => sub { $_[1]{expected_hashes} = $_[2] }, # get
223 expected_mime => sub { $_[1]{expected_mime} = $_[2] }, # get
224 expected_data_length => sub { $_[1]{expected_data_length} = $_[2] }, # get
225 get_failed => sub { $_[1]{get_failed} = $_[2] }, # get
226 data_found => sub { $_[1]{data_found} = $_[2] }, # get
227 enter_finite_cooldown => sub { $_[1]{enter_finite_cooldown} = $_[2] }, # get
228);
229
230sub recv {
231 my ($self, $type, $kv, @extra) = @_;
232
233 if (my $cb = $PERSISTENT_TYPE{$type}) {
234 my $id = $kv->{identifier};
235 my $req = $_[0]{req}{$id} ||= {};
236 $cb->($self, $req, $kv);
237 $self->recv (request_change => $kv, $type, @extra);
238 }
239
240 my $on = $self->{on};
241 for (0 .. $#$on) {
242 unless (my $res = $on->[$_]($self, $type, $kv, @extra)) {
243 splice @$on, $_, 1 unless defined $res;
244 return;
245 }
246 }
247
248 if (my $cb = $self->{queue}[0]) {
249 $cb->($self, $type, $kv, @extra)
250 and shift @{ $self->{queue} };
251 } else {
252 $self->default_recv ($type, $kv, @extra);
253 }
254}
255
178sub on_read { 256sub on_read {
179 my ($self) = @_; 257 my ($self) = @_;
180 258
181 my $type; 259 my $type;
182 my %kv; 260 my %kv;
183 my $rdata; 261 my $rdata;
184
185 my $done_cb = sub {
186 $kv{pkt_type} = $type;
187
188 if (my $cb = $self->{queue}[0]) {
189 $cb->($self, $type, \%kv, $rdata)
190 and shift @{ $self->{queue} };
191 } else {
192 $self->default_recv ($type, \%kv, $rdata);
193 }
194 };
195 262
196 my $hdr_cb; $hdr_cb = sub { 263 my $hdr_cb; $hdr_cb = sub {
197 if ($_[1] =~ /^([^=]+)=(.*)$/) { 264 if ($_[1] =~ /^([^=]+)=(.*)$/) {
198 my ($k, $v) = ($1, $2); 265 my ($k, $v) = ($1, $2);
199 my @k = split /\./, tolc $k; 266 my @k = split /\./, tolc $k;
212 279
213 $_[0]->push_read (line => $hdr_cb); 280 $_[0]->push_read (line => $hdr_cb);
214 } elsif ($_[1] eq "Data") { 281 } elsif ($_[1] eq "Data") {
215 $_[0]->push_read (chunk => delete $kv{data_length}, sub { 282 $_[0]->push_read (chunk => delete $kv{data_length}, sub {
216 $rdata = \$_[1]; 283 $rdata = \$_[1];
217 $done_cb->(); 284 $self->recv ($type, \%kv, $rdata);
218 }); 285 });
219 } elsif ($_[1] eq "EndMessage") { 286 } elsif ($_[1] eq "EndMessage") {
220 $done_cb->(); 287 $self->recv ($type, \%kv);
221 } else { 288 } else {
222 die "protocol error, expected message end, got $_[1]\n";#d# 289 die "protocol error, expected message end, got $_[1]\n";#d#
223 } 290 }
224 }; 291 };
225 292
235 if ($type eq "node_hello") { 302 if ($type eq "node_hello") {
236 $self->{node_hello} = $kv; 303 $self->{node_hello} = $kv;
237 } elsif (exists $self->{id}{$kv->{identifier}}) { 304 } elsif (exists $self->{id}{$kv->{identifier}}) {
238 $self->{id}{$kv->{identifier}}($self, $type, $kv, $rdata) 305 $self->{id}{$kv->{identifier}}($self, $type, $kv, $rdata)
239 and delete $self->{id}{$kv->{identifier}}; 306 and delete $self->{id}{$kv->{identifier}};
240 } else {
241 &{ $self->{progress} };
242 } 307 }
243} 308}
309
310=back
311
312=head2 FCP REQUESTS
313
314The following methods implement various requests. Most of them map
315directory to the FCP message of the same name. The added benefit of
316these over sending requests yourself is that they handle the necessary
317serialisation, protocol quirks, and replies.
318
319All of them exist in two versions, the variant shown in this manpage, and
320a variant with an extra C<_> at the end, and an extra C<$cb> argument. The
321version as shown is I<synchronous> - it will wait for any replies, and
322either return the reply, or croak with an error. The underscore variant
323returns immediately and invokes one or more callbacks or condvars later.
324
325For example, the call
326
327 $info = $fcp->get_plugin_info ($name, $detailed);
328
329Also comes in this underscore variant:
330
331 $fcp->get_plugin_info_ ($name, $detailed, $cb);
332
333You can thinbk of the underscore as a kind of continuation indicator - the
334normal function waits and returns with the data, the C<_> indicates that
335you pass the continuation yourself, and the continuation will be invoked
336with the results.
337
338This callback/continuation argument (C<$cb>) can come in three forms itself:
339
340=over 4
341
342=item A code reference (or rather anything not matching some other alternative)
343
344This code reference will be invoked with the result on success. On an
345error, it will die (in the event loop) with a backtrace of the call site.
346
347This is a popular choice, but it makes handling errors hard - make sure
348you never generate protocol errors!
349
350=item A condvar (as returned by e.g. C<< AnyEvent->condvar >>)
351
352When a condvar is passed, it is sent (C<< $cv->send ($results) >>) the
353results when the request has finished. Should an error occur, the error
354will instead result in C<< $cv->croak ($error) >>.
355
356This is also a popular choice.
357
358=item An array with two callbacks C<[$success, $failure]>
359
360The C<$success> callback will be invoked with the results, while the
361C<$failure> callback will be invoked on any errors.
362
363=item C<undef>
364
365This is the same thing as specifying C<sub { }> as callback, i.e. on
366success, the results are ignored, while on failure, you the module dies
367with a backtrace.
368
369This is good for quick scripts, or when you really aren't interested in
370the results.
371
372=back
373
374=cut
375
376our $NOP_CB = sub { };
244 377
245sub _txn { 378sub _txn {
246 my ($name, $sub) = @_; 379 my ($name, $sub) = @_;
247 380
248 *{$name} = sub { 381 *{$name} = sub {
249 splice @_, 1, 0, (my $cv = AnyEvent->condvar); 382 my $cv = AE::cv;
250 &$sub;
251 $cv
252 };
253 383
254 *{"$name\_sync"} = sub { 384 splice @_, 1, 0, $cv, sub { $cv->croak ($_[0]{extra_description}) };
255 splice @_, 1, 0, (my $cv = AnyEvent->condvar);
256 &$sub; 385 &$sub;
257 $cv->recv 386 $cv->recv
258 }; 387 };
259}
260 388
261=item $cv = $fcp->list_peers ([$with_metdata[, $with_volatile]]) 389 *{"$name\_"} = sub {
390 my ($ok, $err) = pop;
262 391
392 if (ARRAY:: eq ref $ok) {
393 ($ok, $err) = @$ok;
394 } elsif (UNIVERSAL::isa $ok, AnyEvent::CondVar::) {
395 $err = sub { $ok->croak ($_[0]{extra_description}) };
396 } else {
397 my $bt = Carp::longmess "";
398 $err = sub {
399 die "$_[0]{extra_description}$bt";
400 };
401 }
402
403 $ok ||= $NOP_CB;
404
405 splice @_, 1, 0, $ok, $err;
406 &$sub;
407 };
408}
409
410=over 4
411
263=item $peers = $fcp->list_peers_sync ([$with_metdata[, $with_volatile]]) 412=item $peers = $fcp->list_peers ([$with_metdata[, $with_volatile]])
264 413
265=cut 414=cut
266 415
267_txn list_peers => sub { 416_txn list_peers => sub {
268 my ($self, $cv, $with_metadata, $with_volatile) = @_; 417 my ($self, $ok, undef, $with_metadata, $with_volatile) = @_;
269 418
270 my @res; 419 my @res;
271 420
272 $self->send_msg (list_peers => 421 $self->send_msg (list_peers =>
273 with_metadata => $with_metadata ? "true" : "false", 422 with_metadata => $with_metadata ? "true" : "false",
274 with_volatile => $with_volatile ? "true" : "false", 423 with_volatile => $with_volatile ? "true" : "false",
275 id_cb => sub { 424 id_cb => sub {
276 my ($self, $type, $kv, $rdata) = @_; 425 my ($self, $type, $kv, $rdata) = @_;
277 426
278 if ($type eq "end_list_peers") { 427 if ($type eq "end_list_peers") {
279 $cv->(\@res); 428 $ok->(\@res);
280 1 429 1
281 } else { 430 } else {
282 push @res, $kv; 431 push @res, $kv;
283 0 432 0
284 } 433 }
285 }, 434 },
286 ); 435 );
287}; 436};
288 437
289=item $cv = $fcp->list_peer_notes ($node_identifier)
290
291=item $notes = $fcp->list_peer_notes_sync ($node_identifier) 438=item $notes = $fcp->list_peer_notes ($node_identifier)
292 439
293=cut 440=cut
294 441
295_txn list_peer_notes => sub { 442_txn list_peer_notes => sub {
296 my ($self, $cv, $node_identifier) = @_; 443 my ($self, $ok, undef, $node_identifier) = @_;
297 444
298 $self->send_msg (list_peer_notes => 445 $self->send_msg (list_peer_notes =>
299 node_identifier => $node_identifier, 446 node_identifier => $node_identifier,
300 id_cb => sub { 447 id_cb => sub {
301 my ($self, $type, $kv, $rdata) = @_; 448 my ($self, $type, $kv, $rdata) = @_;
302 449
303 $cv->($kv); 450 $ok->($kv);
304 1 451 1
305 }, 452 },
306 ); 453 );
307}; 454};
308 455
309=item $cv = $fcp->watch_global ($enabled[, $verbosity_mask])
310
311=item $fcp->watch_global_sync ($enabled[, $verbosity_mask]) 456=item $fcp->watch_global ($enabled[, $verbosity_mask])
312 457
313=cut 458=cut
314 459
315_txn watch_global => sub { 460_txn watch_global => sub {
316 my ($self, $cv, $enabled, $verbosity_mask) = @_; 461 my ($self, $ok, $err, $enabled, $verbosity_mask) = @_;
317 462
318 $self->send_msg (watch_global => 463 $self->send_msg (watch_global =>
319 enabled => $enabled ? "true" : "false", 464 enabled => $enabled ? "true" : "false",
320 defined $verbosity_mask ? (verbosity_mask => $verbosity_mask+0) : (), 465 defined $verbosity_mask ? (verbosity_mask => $verbosity_mask+0) : (),
321 ); 466 );
322 467
323 $cv->(); 468 $ok->();
324}; 469};
325 470
326=item $cv = $fcp->list_persistent_requests
327
328=item $reqs = $fcp->list_persistent_requests_sync 471=item $reqs = $fcp->list_persistent_requests
329 472
330=cut 473=cut
331 474
332_txn list_persistent_requests => sub { 475_txn list_persistent_requests => sub {
333 my ($self, $cv) = @_; 476 my ($self, $ok, $err) = @_;
334 477
478 $self->serialise (list_persistent_requests => sub {
479 my ($self, $guard) = @_;
480
335 my %res; 481 my @res;
336 482
337 $self->send_msg ("list_persistent_requests"); 483 $self->send_msg ("list_persistent_requests");
338 484
339 push @{ $self->{queue} }, sub { 485 $self->on (sub {
340 my ($self, $type, $kv, $rdata) = @_; 486 my ($self, $type, $kv, $rdata) = @_;
341 487
488 $guard if 0;
489
342 if ($type eq "end_list_persistent_requests") { 490 if ($type eq "end_list_persistent_requests") {
343 $cv->(\%res); 491 $ok->(\@res);
492 return;
493 } else {
494 my $id = $kv->{identifier};
495
496 if ($type =~ /^persistent_(get|put|put_dir)$/) {
497 push @res, [$type, $kv];
498 }
499 }
500
344 1 501 1
345 } else { 502 });
346 my $id = $kv->{identifier}; 503 });
504};
347 505
348 if ($type =~ /^persistent_(get|put|put_dir)$/) { 506=item $sync = $fcp->modify_persistent_request ($global, $identifier[, $client_token[, $priority_class]])
349 $res{$id} = { 507
350 type => $1, 508Update either the C<client_token> or C<priority_class> of a request
351 %{ $res{$id} }, 509identified by C<$global> and C<$identifier>, depending on which of
510C<$client_token> and C<$priority_class> are not C<undef>.
511
512=cut
513
514_txn modify_persistent_request => sub {
515 my ($self, $ok, $err, $global, $identifier, $client_token, $priority_class) = @_;
516
517 $self->serialise ($identifier => sub {
518 my ($self, $guard) = @_;
519
520 $self->send_msg (modify_persistent_request =>
521 global => $global ? "true" : "false",
522 identifier => $identifier,
523 defined $client_token ? (client_token => $client_token ) : (),
524 defined $priority_class ? (priority_class => $priority_class) : (),
525 );
526
527 $self->on (sub {
528 my ($self, $type, $kv, @extra) = @_;
529
530 $guard if 0;
531
532 if ($kv->{identifier} eq $identifier) {
533 if ($type eq "persistent_request_modified") {
352 %$kv, 534 $ok->($kv);
535 return;
536 } elsif ($type eq "protocol_error") {
537 $err->($kv);
538 return;
353 }; 539 }
354 } elsif ($type eq "simple_progress") {
355 delete $kv->{pkt_type}; # save memory
356 push @{ $res{delete $kv->{identifier}}{simple_progress} }, $kv;
357 } else {
358 $res{delete $kv->{identifier}}{delete $kv->{pkt_type}} = $kv;
359 } 540 }
541
360 0 542 1
361 } 543 });
362 }; 544 });
363}; 545};
364 546
365=item $cv = $fcp->remove_request ($global, $identifier)
366
367=item $status = $fcp->remove_request_sync ($global, $identifier)
368
369=cut
370
371_txn remove_request => sub {
372 my ($self, $cv, $global, $identifier) = @_;
373
374 $self->send_msg (remove_request =>
375 global => $global ? "true" : "false",
376 identifier => $identifier,
377 id_cb => sub {
378 my ($self, $type, $kv, $rdata) = @_;
379
380 $cv->($kv);
381 1
382 },
383 );
384};
385
386=item $cv = $fcp->modify_persistent_request ($global, $identifier[, $client_token[, $priority_class]])
387
388=item $sync = $fcp->modify_persistent_request_sync ($global, $identifier[, $client_token[, $priority_class]])
389
390=cut
391
392_txn modify_persistent_request => sub {
393 my ($self, $cv, $global, $identifier, $client_token, $priority_class) = @_;
394
395 $self->send_msg (modify_persistent_request =>
396 global => $global ? "true" : "false",
397 defined $client_token ? (client_token => $client_token ) : (),
398 defined $priority_class ? (priority_class => $priority_class) : (),
399 identifier => $identifier,
400 id_cb => sub {
401 my ($self, $type, $kv, $rdata) = @_;
402
403 $cv->($kv);
404 1
405 },
406 );
407};
408
409=item $cv = $fcp->get_plugin_info ($name, $detailed)
410
411=item $info = $fcp->get_plugin_info_sync ($name, $detailed) 547=item $info = $fcp->get_plugin_info ($name, $detailed)
412 548
413=cut 549=cut
414 550
415_txn get_plugin_info => sub { 551_txn get_plugin_info => sub {
416 my ($self, $cv, $name, $detailed) = @_; 552 my ($self, $ok, $err, $name, $detailed) = @_;
417 553
418 $self->send_msg (get_plugin_info => 554 $self->send_msg (get_plugin_info =>
419 plugin_name => $name, 555 plugin_name => $name,
420 detailed => $detailed ? "true" : "false", 556 detailed => $detailed ? "true" : "false",
421 id_cb => sub { 557 id_cb => sub {
422 my ($self, $type, $kv, $rdata) = @_; 558 my ($self, $type, $kv, $rdata) = @_;
423 559
424 $cv->($kv); 560 $ok->($kv);
425 1 561 1
426 }, 562 },
427 ); 563 );
428}; 564};
429 565
430=item $cv = $fcp->client_get ($uri, $identifier, %kv)
431
432=item $status = $fcp->client_get_sync ($uri, $identifier, %kv) 566=item $status = $fcp->client_get ($uri, $identifier, %kv)
433 567
434%kv can contain (L<http://wiki.freenetproject.org/FCP2p0ClientGet>). 568%kv can contain (L<http://wiki.freenetproject.org/FCP2p0ClientGet>).
435 569
436ignore_ds, ds_only, verbosity, max_size, max_temp_size, max_retries, 570ignore_ds, ds_only, verbosity, max_size, max_temp_size, max_retries,
437priority_class, persistence, client_token, global, return_type, 571priority_class, persistence, client_token, global, return_type,
438binary_blob, allowed_mime_types, filename, temp_filename 572binary_blob, allowed_mime_types, filename, temp_filename
439 573
440=cut 574=cut
441 575
442_txn client_get => sub { 576_txn client_get => sub {
443 my ($self, $cv, $uri, $identifier, %kv) = @_; 577 my ($self, $ok, $err, $uri, $identifier, %kv) = @_;
444 578
579 $self->serialise ($identifier => sub {
580 my ($self, $guard) = @_;
581
445 $self->send_msg (client_get => 582 $self->send_msg (client_get =>
446 %kv, 583 %kv,
447 uri => $uri, 584 uri => $uri,
448 identifier => $identifier, 585 identifier => $identifier,
449 id_cb => sub { 586 );
587
588 $self->on (sub {
450 my ($self, $type, $kv, $rdata) = @_; 589 my ($self, $type, $kv, @extra) = @_;
451 590
591 $guard if 0;
592
593 if ($kv->{identifier} eq $identifier) {
594 if ($type eq "persistent_get") {
452 $cv->($kv); 595 $ok->($kv);
596 return;
597 } elsif ($type eq "protocol_error") {
598 $err->($kv);
599 return;
600 }
601 }
602
453 1 603 1
604 });
605 });
606};
607
608=item $status = $fcp->remove_request ($identifier[, $global])
609
610Remove the request with the given isdentifier. Returns true if successful,
611false on error.
612
613=cut
614
615_txn remove_request => sub {
616 my ($self, $ok, $err, $identifier, $global) = @_;
617
618 $self->serialise ($identifier => sub {
619 my ($self, $guard) = @_;
620
621 $self->send_msg (remove_request =>
622 identifier => $identifier,
623 global => $global ? "true" : "false",
624 );
625 $self->on (sub {
626 my ($self, $type, $kv, @extra) = @_;
627
628 $guard if 0;
629
630 if ($kv->{identifier} eq $identifier) {
631 if ($type eq "persistent_request_removed") {
632 $ok->(1);
633 return;
634 } elsif ($type eq "protocol_error") {
635 $err->($kv);
636 return;
637 }
638 }
639
640 1
641 });
642 });
643};
644
645=item ($can_read, $can_write) = $fcp->test_dda ($local_directory, $remote_directory, $want_read, $want_write))
646
647The DDA test in FCP is probably the single most broken protocol - only
648one directory test can be outstanding at any time, and some guessing and
649heuristics are involved in mangling the paths.
650
651This function combines C<TestDDARequest> and C<TestDDAResponse> in one
652request, handling file reading and writing as well, and tries very hard to
653do the right thing.
654
655Both C<$local_directory> and C<$remote_directory> must specify the same
656directory - C<$local_directory> is the directory path on the client (where
657L<AnyEvent::FCP> runs) and C<$remote_directory> is the directory path on
658the server (where the freenet node runs). When both are running on the
659same node, the paths are generally identical.
660
661C<$want_read> and C<$want_write> should be set to a true value when you
662want to read (get) files or write (put) files, respectively.
663
664On error, an exception is thrown. Otherwise, C<$can_read> and
665C<$can_write> indicate whether you can reaqd or write to freenet via the
666directory.
667
668=cut
669
670_txn test_dda => sub {
671 my ($self, $ok, $err, $local, $remote, $want_read, $want_write) = @_;
672
673 $self->serialise (test_dda => sub {
674 my ($self, $guard) = @_;
675
676 $self->send_msg (test_dda_request =>
677 directory => $remote,
678 want_read_directory => $want_read ? "true" : "false",
679 want_write_directory => $want_write ? "true" : "false",
680 );
681 $self->on (sub {
682 my ($self, $type, $kv) = @_;
683
684 if ($type eq "test_dda_reply") {
685 # the filenames are all relative to the server-side directory,
686 # which might or might not match $remote anymore, so we
687 # need to rewrite the paths to be relative to $local
688 for my $k (qw(read_filename write_filename)) {
689 my $f = $kv->{$k};
690 for my $dir ($kv->{directory}, $remote) {
691 if ($dir eq substr $f, 0, length $dir) {
692 substr $f, 0, 1 + length $dir, "";
693 $kv->{$k} = $f;
694 last;
695 }
696 }
697 }
698
699 my %response = (directory => $remote);
700
701 if (length $kv->{read_filename}) {
702 if (open my $fh, "<:raw", "$local/$kv->{read_filename}") {
703 sysread $fh, my $buf, -s $fh;
704 $response{read_content} = $buf;
705 }
706 }
707
708 if (length $kv->{write_filename}) {
709 if (open my $fh, ">:raw", "$local/$kv->{write_filename}") {
710 syswrite $fh, $kv->{content_to_write};
711 }
712 }
713
714 $self->send_msg (test_dda_response => %response);
715
716 $self->on (sub {
717 my ($self, $type, $kv) = @_;
718
719 $guard if 0; # reference
720
721 if ($type eq "test_dda_complete") {
722 $ok->(
723 $kv->{read_directory_allowed} eq "true",
724 $kv->{write_directory_allowed} eq "true",
725 );
726 } elsif ($type eq "protocol_error" && $kv->{identifier} eq $remote) {
727 $err->($kv->{extra_description});
728 return;
729 }
730
731 1
732 });
733
734 return;
735 } elsif ($type eq "protocol_error" && $kv->{identifier} eq $remote) {
736 $err->($kv);
737 return;
738 }
739
740 1
741 });
742 });
743};
744
745=back
746
747=head2 REQUEST CACHE
748
749The C<AnyEvent::FCP> class keeps a request cache, where it caches all
750information from requests.
751
752For these messages, it will store a copy of the key-value pairs, together with a C<type> slot,
753in C<< $fcp->{req}{$identifier} >>:
754
755 persistent_get
756 persistent_put
757 persistent_put_dir
758
759This message updates the stored data:
760
761 persistent_request_modified
762
763This message will remove this entry:
764
765 persistent_request_removed
766
767These messages get merged into the cache entry, under their
768type, i.e. a C<simple_progress> message will be stored in C<<
769$fcp->{req}{$identifier}{simple_progress} >>:
770
771 simple_progress # get/put
772
773 uri_generated # put
774 generated_metadata # put
775 started_compression # put
776 finished_compression # put
777 put_failed # put
778 put_fetchable # put
779 put_successful # put
780
781 sending_to_network # get
782 compatibility_mode # get
783 expected_hashes # get
784 expected_mime # get
785 expected_data_length # get
786 get_failed # get
787 data_found # get
788 enter_finite_cooldown # get
789
790In addition, an event (basically a fake message) of type C<request_changed> is generated
791on every change, which will be called as C<< $cb->($fcp, $kv, $type) >>, where C<$type>
792is the type of the original message triggering the change,
793
794To fill this cache with the global queue and keep it updated,
795call C<watch_global> to subscribe to updates, followed by
796C<list_persistent_requests_sync>.
797
798 $fcp->watch_global_sync_; # do not wait
799 $fcp->list_persistent_requests; # wait
800
801To get a better idea of what is stored in the cache, here is an example of
802what might be stored in C<< $fcp->{req}{"Frost-gpl.txt"} >>:
803
804 {
805 identifier => "Frost-gpl.txt",
806 uri => 'CHK@Fnx5kzdrfE,EImdzaVyEWl,AAIC--8/gpl.txt',
807 binary_blob => "false",
808 global => "true",
809 max_retries => -1,
810 max_size => 9223372036854775807,
811 persistence => "forever",
812 priority_class => 3,
813 real_time => "false",
814 return_type => "direct",
815 started => "true",
816 type => "persistent_get",
817 verbosity => 2147483647,
818 sending_to_network => {
819 identifier => "Frost-gpl.txt",
820 global => "true",
454 }, 821 },
455 ); 822 compatibility_mode => {
456}; 823 identifier => "Frost-gpl.txt",
457 824 definitive => "true",
458=back 825 dont_compress => "false",
826 global => "true",
827 max => "COMPAT_1255",
828 min => "COMPAT_1255",
829 },
830 expected_hashes => {
831 identifier => "Frost-gpl.txt",
832 global => "true",
833 hashes => {
834 ed2k => "d83596f5ee3b7...",
835 md5 => "e0894e4a2a6...",
836 sha1 => "...",
837 sha256 => "...",
838 sha512 => "...",
839 tth => "...",
840 },
841 },
842 expected_mime => {
843 identifier => "Frost-gpl.txt",
844 global => "true",
845 metadata => { content_type => "application/rar" },
846 },
847 expected_data_length => {
848 identifier => "Frost-gpl.txt",
849 data_length => 37576,
850 global => "true",
851 },
852 simple_progress => {
853 identifier => "Frost-gpl.txt",
854 failed => 0,
855 fatally_failed => 0,
856 finalized_total => "true",
857 global => "true",
858 last_progress => 1438639282628,
859 required => 372,
860 succeeded => 102,
861 total => 747,
862 },
863 data_found => {
864 identifier => "Frost-gpl.txt",
865 completion_time => 1438663354026,
866 data_length => 37576,
867 global => "true",
868 metadata => { content_type => "image/jpeg" },
869 startup_time => 1438657196167,
870 },
871 }
459 872
460=head1 EXAMPLE PROGRAM 873=head1 EXAMPLE PROGRAM
461 874
462 use AnyEvent::FCP; 875 use AnyEvent::FCP;
463 876
464 my $fcp = new AnyEvent::FCP; 877 my $fcp = new AnyEvent::FCP;
465 878
466 # let us look at the global request list 879 # let us look at the global request list
467 $fcp->watch_global (1, 0); 880 $fcp->watch_global_ (1);
468 881
469 # list them, synchronously 882 # list them, synchronously
470 my $req = $fcp->list_persistent_requests_sync; 883 my $req = $fcp->list_persistent_requests;
471 884
472 # go through all requests 885 # go through all requests
886TODO
473 for my $req (values %$req) { 887 for my $req (values %$req) {
474 # skip jobs not directly-to-disk 888 # skip jobs not directly-to-disk
475 next unless $req->{return_type} eq "disk"; 889 next unless $req->{return_type} eq "disk";
476 # skip jobs not issued by FProxy 890 # skip jobs not issued by FProxy
477 next unless $req->{identifier} =~ /^FProxy:/; 891 next unless $req->{identifier} =~ /^FProxy:/;

Diff Legend

Removed lines
+ Added lines
< Changed lines
> Changed lines