| … | |
… | |
| 6 | |
6 | |
| 7 | use AnyEvent::FCP; |
7 | use AnyEvent::FCP; |
| 8 | |
8 | |
| 9 | my $fcp = new AnyEvent::FCP; |
9 | my $fcp = new AnyEvent::FCP; |
| 10 | |
10 | |
| 11 | # transactions return condvars |
11 | # transactions return condvars |
| 12 | my $lp_cv = $fcp->list_peers; |
12 | my $lp_cv = $fcp->list_peers; |
| 13 | my $pr_cv = $fcp->list_persistent_requests; |
13 | my $pr_cv = $fcp->list_persistent_requests; |
| 14 | |
14 | |
| 15 | my $peers = $lp_cv->recv; |
15 | my $peers = $lp_cv->recv; |
| 16 | my $reqs = $pr_cv->recv; |
16 | my $reqs = $pr_cv->recv; |
| … | |
… | |
| 26 | The module uses L<AnyEvent> to find a suitable event module. |
26 | The module uses L<AnyEvent> to find a suitable event module. |
| 27 | |
27 | |
| 28 | Only very little is implemented, ask if you need more, and look at the |
28 | Only very little is implemented, ask if you need more, and look at the |
| 29 | example program later in this section. |
29 | example program later in this section. |
| 30 | |
30 | |
|
|
31 | =head2 EXAMPLE |
|
|
32 | |
|
|
33 | This example fetches the download list and sets the priority of all files |
|
|
34 | with "a" in their name to "emergency": |
|
|
35 | |
|
|
36 | use AnyEvent::FCP; |
|
|
37 | |
|
|
38 | my $fcp = new AnyEvent::FCP; |
|
|
39 | |
|
|
40 | $fcp->watch_global (1, 0); |
|
|
41 | my $req = $fcp->list_persistent_requests; |
|
|
42 | |
|
|
43 | TODO |
|
|
44 | for my $req (values %$req) { |
|
|
45 | if ($req->{filename} =~ /a/) { |
|
|
46 | $fcp->modify_persistent_request (1, $req->{identifier}, undef, 0); |
|
|
47 | } |
|
|
48 | } |
|
|
49 | |
| 31 | =head2 IMPORT TAGS |
50 | =head2 IMPORT TAGS |
| 32 | |
51 | |
| 33 | Nothing much can be "imported" from this module right now. |
52 | Nothing much can be "imported" from this module right now. |
| 34 | |
53 | |
| 35 | =head2 THE AnyEvent::FCP CLASS |
54 | =head1 THE AnyEvent::FCP CLASS |
| 36 | |
55 | |
| 37 | =over 4 |
56 | =over 4 |
| 38 | |
57 | |
| 39 | =cut |
58 | =cut |
| 40 | |
59 | |
| … | |
… | |
| 42 | |
61 | |
| 43 | use common::sense; |
62 | use common::sense; |
| 44 | |
63 | |
| 45 | use Carp; |
64 | use Carp; |
| 46 | |
65 | |
| 47 | our $VERSION = '0.21'; |
66 | our $VERSION = '0.3'; |
| 48 | |
67 | |
| 49 | use Scalar::Util (); |
68 | use Scalar::Util (); |
| 50 | |
69 | |
| 51 | use AnyEvent; |
70 | use AnyEvent; |
| 52 | use AnyEvent::Handle; |
71 | use AnyEvent::Handle; |
|
|
72 | use AnyEvent::Util (); |
| 53 | |
73 | |
| 54 | sub touc($) { |
74 | sub touc($) { |
| 55 | local $_ = shift; |
75 | local $_ = shift; |
| 56 | 1 while s/((?:^|_)(?:svk|chk|uri|fcp|ds|mime)(?:_|$))/\U$1/; |
76 | 1 while s/((?:^|_)(?:svk|chk|uri|fcp|ds|mime|dda)(?:_|$))/\U$1/; |
| 57 | s/(?:^|_)(.)/\U$1/g; |
77 | s/(?:^|_)(.)/\U$1/g; |
| 58 | $_ |
78 | $_ |
| 59 | } |
79 | } |
| 60 | |
80 | |
| 61 | sub tolc($) { |
81 | sub tolc($) { |
| 62 | local $_ = shift; |
82 | local $_ = shift; |
| 63 | 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/; |
| 64 | 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/; |
| 65 | s/(?<=[a-z])(?=[A-Z])/_/g; |
85 | s/(?<=[a-z])(?=[A-Z])/_/g; |
| 66 | lc |
86 | lc |
| 67 | } |
87 | } |
| 68 | |
88 | |
| 69 | =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] |
| 70 | |
90 | |
| 71 | Create a new FCP connection to the given host and port (default |
91 | Create a new FCP connection to the given host and port (default |
| 72 | 127.0.0.1:9481, or the environment variables C<FREDHOST> and C<FREDPORT>). |
92 | 127.0.0.1:9481, or the environment variables C<FREDHOST> and C<FREDPORT>). |
| 73 | |
93 | |
| 74 | If no C<name> was specified, then AnyEvent::FCP will generate a |
94 | If no C<name> was specified, then AnyEvent::FCP will generate a |
| 75 | (hopefully) unique client name for you. |
95 | (hopefully) unique client name for you. |
| 76 | |
96 | |
| 77 | You can install a progress callback that is being called with the AnyEvent::FCP |
|
|
| 78 | object, the type, a hashref with key-value pairs and a reference to any received data, |
|
|
| 79 | for all unsolicited messages. |
|
|
| 80 | |
|
|
| 81 | Example: |
|
|
| 82 | |
|
|
| 83 | sub progress_cb { |
|
|
| 84 | my ($self, $type, $kv, $rdata) = @_; |
|
|
| 85 | |
|
|
| 86 | if ($type eq "simple_progress") { |
|
|
| 87 | warn "$kv->{identifier} $kv->{succeeded}/$kv->{required}\n"; |
|
|
| 88 | } |
|
|
| 89 | } |
|
|
| 90 | |
|
|
| 91 | =cut |
97 | =cut |
| 92 | |
98 | |
| 93 | sub new { |
99 | sub new { |
| 94 | my $class = shift; |
100 | my $class = shift; |
| 95 | my $self = bless { @_ }, $class; |
101 | my $self = bless { |
| 96 | |
102 | host => $ENV{FREDHOST} || "127.0.0.1", |
| 97 | $self->{host} ||= $ENV{FREDHOST} || "127.0.0.1"; |
103 | port => $ENV{FREDPORT} || 9481, |
| 98 | $self->{port} ||= $ENV{FREDPORT} || 9481; |
104 | timeout => 3600 * 2, |
| 99 | $self->{name} ||= time.rand.rand.rand; # lame |
105 | name => time.rand.rand.rand, # lame |
| 100 | $self->{timeout} ||= 600; |
106 | @_, |
| 101 | $self->{progress} ||= sub { }; |
107 | queue => [], |
| 102 | |
108 | req => {}, |
| 103 | $self->{id} = "a0"; |
109 | id => "a0", |
|
|
110 | }, $class; |
| 104 | |
111 | |
| 105 | { |
112 | { |
| 106 | Scalar::Util::weaken (my $self = $self); |
113 | Scalar::Util::weaken (my $self = $self); |
| 107 | |
114 | |
| 108 | $self->{hdl} = new AnyEvent::Handle |
115 | $self->{hdl} = new AnyEvent::Handle |
| 109 | connect => [$self->{host} => $self->{port}], |
116 | connect => [$self->{host} => $self->{port}], |
| 110 | timeout => $self->{timeout}, |
117 | timeout => $self->{timeout}, |
| 111 | on_error => sub { |
118 | on_error => sub { |
| 112 | warn "<@_>\n"; |
119 | warn "@_\n";#d# |
| 113 | exit 1; |
120 | exit 1; |
| 114 | }, |
121 | }, |
| 115 | on_read => sub { $self->on_read (@_) }, |
122 | on_read => sub { $self->on_read (@_) }, |
| 116 | on_eof => $self->{on_eof} || sub { }; |
123 | on_eof => $self->{on_eof} || sub { }; |
| 117 | |
124 | |
| 118 | Scalar::Util::weaken ($self->{hdl}{fcp} = $self); |
125 | Scalar::Util::weaken ($self->{hdl}{fcp} = $self); |
| 119 | } |
126 | } |
| 120 | |
127 | |
| 121 | $self->send_msg ( |
128 | $self->send_msg (client_hello => |
| 122 | client_hello => |
|
|
| 123 | name => $self->{name}, |
129 | name => $self->{name}, |
| 124 | expected_version => "2.0", |
130 | expected_version => "2.0", |
| 125 | ); |
131 | ); |
| 126 | |
132 | |
| 127 | $self |
133 | $self |
| 128 | } |
134 | } |
| … | |
… | |
| 131 | my ($self, $type, %kv) = @_; |
137 | my ($self, $type, %kv) = @_; |
| 132 | |
138 | |
| 133 | my $data = delete $kv{data}; |
139 | my $data = delete $kv{data}; |
| 134 | |
140 | |
| 135 | if (exists $kv{id_cb}) { |
141 | if (exists $kv{id_cb}) { |
| 136 | my $id = $kv{identifier} || ++$self->{id}; |
142 | my $id = $kv{identifier} ||= ++$self->{id}; |
| 137 | $self->{id}{$id} = delete $kv{id_cb}; |
143 | $self->{id}{$id} = delete $kv{id_cb}; |
| 138 | $kv{identifier} = $id; |
|
|
| 139 | } |
144 | } |
| 140 | |
145 | |
| 141 | my $msg = (touc $type) . "\012" |
146 | my $msg = (touc $type) . "\012" |
| 142 | . join "", map +(touc $_) . "=$kv{$_}\012", keys %kv; |
147 | . join "", map +(touc $_) . "=$kv{$_}\012", keys %kv; |
| 143 | |
148 | |
| … | |
… | |
| 155 | } |
160 | } |
| 156 | |
161 | |
| 157 | $self->{hdl}->push_write ($msg); |
162 | $self->{hdl}->push_write ($msg); |
| 158 | } |
163 | } |
| 159 | |
164 | |
|
|
165 | sub on { |
|
|
166 | my ($self, $cb) = @_; |
|
|
167 | |
|
|
168 | # cb return undef - message eaten, remove cb |
|
|
169 | # cb return 0 - message eaten |
|
|
170 | # cb return 1 - pass to next |
|
|
171 | |
|
|
172 | push @{ $self->{on} }, $cb; |
|
|
173 | } |
|
|
174 | |
|
|
175 | sub _push_queue { |
|
|
176 | my ($self, $queue) = @_; |
|
|
177 | |
|
|
178 | shift @$queue; |
|
|
179 | $queue->[0]($self, AnyEvent::Util::guard { $self->_push_queue ($queue) }) |
|
|
180 | if @$queue; |
|
|
181 | } |
|
|
182 | |
|
|
183 | # lock so only one $type (arbitrary string) is in flight, |
|
|
184 | # to work around horribly misdesigned protocol. |
|
|
185 | sub serialise { |
|
|
186 | my ($self, $type, $cb) = @_; |
|
|
187 | |
|
|
188 | my $queue = $self->{serialise}{$type} ||= []; |
|
|
189 | push @$queue, $cb; |
|
|
190 | $cb->($self, AnyEvent::Util::guard { $self->_push_queue ($queue) }) |
|
|
191 | unless $#$queue; |
|
|
192 | } |
|
|
193 | |
|
|
194 | # how to merge these types into $self->{persistent} |
|
|
195 | our %PERSISTENT_TYPE = ( |
|
|
196 | persistent_get => sub { %{ $_[1] } = (type => "persistent_get" , %{ $_[2] }) }, |
|
|
197 | persistent_put => sub { %{ $_[1] } = (type => "persistent_put" , %{ $_[2] }) }, |
|
|
198 | persistent_put_dir => sub { %{ $_[1] } = (type => "persistent_put_dir", %{ $_[2] }) }, |
|
|
199 | persistent_request_modified => sub { %{ $_[1] } = (%{ $_[1] }, %{ $_[2] }) }, |
|
|
200 | persistent_request_removed => sub { delete $_[0]{req}{$_[2]{identifier}} }, |
|
|
201 | |
|
|
202 | simple_progress => sub { $_[1]{simple_progress} = $_[2] }, # get/put |
|
|
203 | |
|
|
204 | uri_generated => sub { $_[1]{uri_generated} = $_[2] }, # put |
|
|
205 | generated_metadata => sub { $_[1]{generated_metadata} = $_[2] }, # put |
|
|
206 | started_compression => sub { $_[1]{started_compression} = $_[2] }, # put |
|
|
207 | finished_compression => sub { $_[1]{finished_compression} = $_[2] }, # put |
|
|
208 | put_fetchable => sub { $_[1]{put_fetchable} = $_[2] }, # put |
|
|
209 | put_failed => sub { $_[1]{put_failed} = $_[2] }, # put |
|
|
210 | put_successful => sub { $_[1]{put_successful} = $_[2] }, # put |
|
|
211 | |
|
|
212 | sending_to_network => sub { $_[1]{sending_to_network} = $_[2] }, # get |
|
|
213 | compatibility_mode => sub { $_[1]{compatibility_mode} = $_[2] }, # get |
|
|
214 | expected_hashes => sub { $_[1]{expected_hashes} = $_[2] }, # get |
|
|
215 | expected_mime => sub { $_[1]{expected_mime} = $_[2] }, # get |
|
|
216 | expected_data_length => sub { $_[1]{expected_data_length} = $_[2] }, # get |
|
|
217 | get_failed => sub { $_[1]{get_failed} = $_[2] }, # get |
|
|
218 | data_found => sub { $_[1]{data_found} = $_[2] }, # get |
|
|
219 | enter_finite_cooldown => sub { $_[1]{enter_finite_cooldown} = $_[2] }, # get |
|
|
220 | ); |
|
|
221 | |
|
|
222 | sub recv { |
|
|
223 | my ($self, $type, $kv, @extra) = @_; |
|
|
224 | |
|
|
225 | if (my $cb = $PERSISTENT_TYPE{$type}) { |
|
|
226 | my $id = $kv->{identifier}; |
|
|
227 | my $req = $_[0]{req}{$id} ||= {}; |
|
|
228 | $cb->($self, $req, $kv); |
|
|
229 | $self->recv (request_change => $kv, $type, @extra); |
|
|
230 | } |
|
|
231 | |
|
|
232 | my $on = $self->{on}; |
|
|
233 | for (0 .. $#$on) { |
|
|
234 | unless (my $res = $on->[$_]($self, $type, $kv, @extra)) { |
|
|
235 | splice @$on, $_, 1 unless defined $res; |
|
|
236 | return; |
|
|
237 | } |
|
|
238 | } |
|
|
239 | |
|
|
240 | if (my $cb = $self->{queue}[0]) { |
|
|
241 | $cb->($self, $type, $kv, @extra) |
|
|
242 | and shift @{ $self->{queue} }; |
|
|
243 | } else { |
|
|
244 | $self->default_recv ($type, $kv, @extra); |
|
|
245 | } |
|
|
246 | } |
|
|
247 | |
| 160 | sub on_read { |
248 | sub on_read { |
| 161 | my ($self) = @_; |
249 | my ($self) = @_; |
| 162 | |
250 | |
| 163 | my $type; |
251 | my $type; |
| 164 | my %kv; |
252 | my %kv; |
| 165 | my $rdata; |
253 | my $rdata; |
| 166 | |
|
|
| 167 | my $done_cb = sub { |
|
|
| 168 | $kv{pkt_type} = $type; |
|
|
| 169 | |
|
|
| 170 | if (my $cb = $self->{queue}[0]) { |
|
|
| 171 | $cb->($self, $type, \%kv, $rdata) |
|
|
| 172 | and shift @{ $self->{queue} }; |
|
|
| 173 | } else { |
|
|
| 174 | $self->default_recv ($type, \%kv, $rdata); |
|
|
| 175 | } |
|
|
| 176 | }; |
|
|
| 177 | |
254 | |
| 178 | my $hdr_cb; $hdr_cb = sub { |
255 | my $hdr_cb; $hdr_cb = sub { |
| 179 | if ($_[1] =~ /^([^=]+)=(.*)$/) { |
256 | if ($_[1] =~ /^([^=]+)=(.*)$/) { |
| 180 | my ($k, $v) = ($1, $2); |
257 | my ($k, $v) = ($1, $2); |
| 181 | my @k = split /\./, tolc $k; |
258 | my @k = split /\./, tolc $k; |
| … | |
… | |
| 194 | |
271 | |
| 195 | $_[0]->push_read (line => $hdr_cb); |
272 | $_[0]->push_read (line => $hdr_cb); |
| 196 | } elsif ($_[1] eq "Data") { |
273 | } elsif ($_[1] eq "Data") { |
| 197 | $_[0]->push_read (chunk => delete $kv{data_length}, sub { |
274 | $_[0]->push_read (chunk => delete $kv{data_length}, sub { |
| 198 | $rdata = \$_[1]; |
275 | $rdata = \$_[1]; |
| 199 | $done_cb->(); |
276 | $self->recv ($type, \%kv, $rdata); |
| 200 | }); |
277 | }); |
| 201 | } elsif ($_[1] eq "EndMessage") { |
278 | } elsif ($_[1] eq "EndMessage") { |
| 202 | $done_cb->(); |
279 | $self->recv ($type, \%kv); |
| 203 | } else { |
280 | } else { |
| 204 | die "protocol error, expected message end, got $_[1]\n";#d# |
281 | die "protocol error, expected message end, got $_[1]\n";#d# |
| 205 | } |
282 | } |
| 206 | }; |
283 | }; |
| 207 | |
284 | |
| … | |
… | |
| 217 | if ($type eq "node_hello") { |
294 | if ($type eq "node_hello") { |
| 218 | $self->{node_hello} = $kv; |
295 | $self->{node_hello} = $kv; |
| 219 | } elsif (exists $self->{id}{$kv->{identifier}}) { |
296 | } elsif (exists $self->{id}{$kv->{identifier}}) { |
| 220 | $self->{id}{$kv->{identifier}}($self, $type, $kv, $rdata) |
297 | $self->{id}{$kv->{identifier}}($self, $type, $kv, $rdata) |
| 221 | and delete $self->{id}{$kv->{identifier}}; |
298 | and delete $self->{id}{$kv->{identifier}}; |
| 222 | } else { |
|
|
| 223 | &{ $self->{progress} }; |
|
|
| 224 | } |
299 | } |
| 225 | } |
300 | } |
|
|
301 | |
|
|
302 | our $NOP_CB = sub { }; |
| 226 | |
303 | |
| 227 | sub _txn { |
304 | sub _txn { |
| 228 | my ($name, $sub) = @_; |
305 | my ($name, $sub) = @_; |
| 229 | |
306 | |
| 230 | *{$name} = sub { |
307 | *{$name} = sub { |
| 231 | splice @_, 1, 0, (my $cv = AnyEvent->condvar); |
|
|
| 232 | &$sub; |
|
|
| 233 | $cv |
|
|
| 234 | }; |
|
|
| 235 | |
|
|
| 236 | *{"$name\_sync"} = sub { |
|
|
| 237 | splice @_, 1, 0, (my $cv = AnyEvent->condvar); |
308 | splice @_, 1, 0, (my $cv = AnyEvent->condvar); |
| 238 | &$sub; |
309 | &$sub; |
| 239 | $cv->recv |
310 | $cv->recv |
| 240 | }; |
311 | }; |
| 241 | } |
|
|
| 242 | |
312 | |
| 243 | =item $cv = $fcp->list_peers ([$with_metdata[, $with_volatile]]) |
313 | *{"$name\_"} = sub { |
|
|
314 | splice @_, 1, 0, pop || $NOP_CB; |
|
|
315 | &$sub; |
|
|
316 | }; |
|
|
317 | } |
| 244 | |
318 | |
| 245 | =item $peers = $fcp->list_peers_sync ([$with_metdata[, $with_volatile]]) |
319 | =item $peers = $fcp->list_peers ([$with_metdata[, $with_volatile]]) |
| 246 | |
320 | |
| 247 | =cut |
321 | =cut |
| 248 | |
322 | |
| 249 | _txn list_peers => sub { |
323 | _txn list_peers => sub { |
| 250 | my ($self, $cv, $with_metadata, $with_volatile) = @_; |
324 | my ($self, $cv, $with_metadata, $with_volatile) = @_; |
| … | |
… | |
| 266 | } |
340 | } |
| 267 | }, |
341 | }, |
| 268 | ); |
342 | ); |
| 269 | }; |
343 | }; |
| 270 | |
344 | |
| 271 | =item $cv = $fcp->list_peer_notes ($node_identifier) |
|
|
| 272 | |
|
|
| 273 | =item $notes = $fcp->list_peer_notes_sync ($node_identifier) |
345 | =item $notes = $fcp->list_peer_notes ($node_identifier) |
| 274 | |
346 | |
| 275 | =cut |
347 | =cut |
| 276 | |
348 | |
| 277 | _txn list_peer_notes => sub { |
349 | _txn list_peer_notes => sub { |
| 278 | my ($self, $cv, $node_identifier) = @_; |
350 | my ($self, $cv, $node_identifier) = @_; |
| … | |
… | |
| 286 | 1 |
358 | 1 |
| 287 | }, |
359 | }, |
| 288 | ); |
360 | ); |
| 289 | }; |
361 | }; |
| 290 | |
362 | |
| 291 | =item $cv = $fcp->watch_global ($enabled[, $verbosity_mask]) |
|
|
| 292 | |
|
|
| 293 | =item $fcp->watch_global_sync ($enabled[, $verbosity_mask]) |
363 | =item $fcp->watch_global ($enabled[, $verbosity_mask]) |
| 294 | |
364 | |
| 295 | =cut |
365 | =cut |
| 296 | |
366 | |
| 297 | _txn watch_global => sub { |
367 | _txn watch_global => sub { |
| 298 | my ($self, $cv, $enabled, $verbosity_mask) = @_; |
368 | my ($self, $cv, $enabled, $verbosity_mask) = @_; |
| … | |
… | |
| 303 | ); |
373 | ); |
| 304 | |
374 | |
| 305 | $cv->(); |
375 | $cv->(); |
| 306 | }; |
376 | }; |
| 307 | |
377 | |
| 308 | =item $cv = $fcp->list_persistent_requests |
|
|
| 309 | |
|
|
| 310 | =item $reqs = $fcp->list_persistent_requests_sync |
378 | =item $reqs = $fcp->list_persistent_requests |
| 311 | |
379 | |
| 312 | =cut |
380 | =cut |
| 313 | |
381 | |
| 314 | _txn list_persistent_requests => sub { |
382 | _txn list_persistent_requests => sub { |
| 315 | my ($self, $cv) = @_; |
383 | my ($self, $cv) = @_; |
| 316 | |
384 | |
|
|
385 | $self->serialise (list_persistent_requests => sub { |
|
|
386 | my ($self, $guard) = @_; |
|
|
387 | |
| 317 | my %res; |
388 | my @res; |
| 318 | |
389 | |
| 319 | $self->send_msg ("list_persistent_requests"); |
390 | $self->send_msg ("list_persistent_requests"); |
| 320 | |
391 | |
| 321 | push @{ $self->{queue} }, sub { |
392 | $self->on (sub { |
| 322 | my ($self, $type, $kv, $rdata) = @_; |
393 | my ($self, $type, $kv, $rdata) = @_; |
| 323 | |
394 | |
|
|
395 | $guard if 0; |
|
|
396 | |
| 324 | if ($type eq "end_list_persistent_requests") { |
397 | if ($type eq "end_list_persistent_requests") { |
| 325 | $cv->(\%res); |
398 | $cv->(\@res); |
|
|
399 | return; |
|
|
400 | } else { |
|
|
401 | my $id = $kv->{identifier}; |
|
|
402 | |
|
|
403 | if ($type =~ /^persistent_(get|put|put_dir)$/) { |
|
|
404 | push @res, [$type, $kv]; |
|
|
405 | } |
|
|
406 | } |
|
|
407 | |
| 326 | 1 |
408 | 1 |
| 327 | } else { |
|
|
| 328 | my $id = $kv->{identifier}; |
|
|
| 329 | |
|
|
| 330 | if ($type =~ /^persistent_(get|put|put_dir)$/) { |
|
|
| 331 | $res{$id} = { |
|
|
| 332 | type => $1, |
|
|
| 333 | %{ $res{$id} }, |
|
|
| 334 | %$kv, |
|
|
| 335 | }; |
|
|
| 336 | } elsif ($type eq "simple_progress") { |
|
|
| 337 | delete $kv->{pkt_type}; # save memory |
|
|
| 338 | push @{ $res{delete $kv->{identifier}}{simple_progress} }, $kv; |
|
|
| 339 | } else { |
|
|
| 340 | $res{delete $kv->{identifier}}{delete $kv->{pkt_type}} = $kv; |
|
|
| 341 | } |
|
|
| 342 | 0 |
|
|
| 343 | } |
409 | }); |
| 344 | }; |
410 | }); |
| 345 | }; |
411 | }; |
| 346 | |
412 | |
| 347 | =item $cv = $fcp->remove_request ($global, $identifier) |
|
|
| 348 | |
|
|
| 349 | =item $status = $fcp->remove_request_sync ($global, $identifier) |
413 | =item $status = $fcp->remove_request ($global, $identifier) |
| 350 | |
414 | |
| 351 | =cut |
415 | =cut |
| 352 | |
416 | |
| 353 | _txn remove_request => sub { |
417 | _txn remove_request => sub { |
| 354 | my ($self, $cv, $global, $identifier) = @_; |
418 | my ($self, $cv, $global, $identifier) = @_; |
| … | |
… | |
| 363 | 1 |
427 | 1 |
| 364 | }, |
428 | }, |
| 365 | ); |
429 | ); |
| 366 | }; |
430 | }; |
| 367 | |
431 | |
| 368 | =item $cv = $fcp->modify_persistent_request ($global, $identifier[, $client_token[, $priority_class]]) |
432 | =item $sync = $fcp->modify_persistent_request ($global, $identifier[, $client_token[, $priority_class]]) |
| 369 | |
|
|
| 370 | =item $sync = $fcp->modify_persistent_request_sync ($global, $identifier[, $client_token[, $priority_class]]) |
|
|
| 371 | |
433 | |
| 372 | =cut |
434 | =cut |
| 373 | |
435 | |
| 374 | _txn modify_persistent_request => sub { |
436 | _txn modify_persistent_request => sub { |
| 375 | my ($self, $cv, $global, $identifier, $client_token, $priority_class) = @_; |
437 | my ($self, $cv, $global, $identifier, $client_token, $priority_class) = @_; |
| … | |
… | |
| 386 | 1 |
448 | 1 |
| 387 | }, |
449 | }, |
| 388 | ); |
450 | ); |
| 389 | }; |
451 | }; |
| 390 | |
452 | |
| 391 | =item $cv = $fcp->get_plugin_info ($name, $detailed) |
|
|
| 392 | |
|
|
| 393 | =item $info = $fcp->get_plugin_info_sync ($name, $detailed) |
453 | =item $info = $fcp->get_plugin_info ($name, $detailed) |
| 394 | |
454 | |
| 395 | =cut |
455 | =cut |
| 396 | |
456 | |
| 397 | _txn get_plugin_info => sub { |
457 | _txn get_plugin_info => sub { |
| 398 | my ($self, $cv, $name, $detailed) = @_; |
458 | my ($self, $cv, $name, $detailed) = @_; |
| … | |
… | |
| 407 | 1 |
467 | 1 |
| 408 | }, |
468 | }, |
| 409 | ); |
469 | ); |
| 410 | }; |
470 | }; |
| 411 | |
471 | |
| 412 | =item $cv = $fcp->client_get ($uri, $identifier, %kv) |
|
|
| 413 | |
|
|
| 414 | =item $status = $fcp->client_get_sync ($uri, $identifier, %kv) |
472 | =item $status = $fcp->client_get ($uri, $identifier, %kv) |
| 415 | |
473 | |
| 416 | %kv can contain (L<http://wiki.freenetproject.org/FCP2p0ClientGet>). |
474 | %kv can contain (L<http://wiki.freenetproject.org/FCP2p0ClientGet>). |
| 417 | |
475 | |
| 418 | ignore_ds, ds_only, verbosity, max_size, max_temp_size, max_retries, |
476 | ignore_ds, ds_only, verbosity, max_size, max_temp_size, max_retries, |
| 419 | priority_class, persistence, client_token, global, return_type, |
477 | priority_class, persistence, client_token, global, return_type, |
| … | |
… | |
| 426 | |
484 | |
| 427 | $self->send_msg (client_get => |
485 | $self->send_msg (client_get => |
| 428 | %kv, |
486 | %kv, |
| 429 | uri => $uri, |
487 | uri => $uri, |
| 430 | identifier => $identifier, |
488 | identifier => $identifier, |
| 431 | id_cb => sub { |
489 | ); |
|
|
490 | }; |
|
|
491 | |
|
|
492 | =item $status = $fcp->remove_request ($identifier[, $global]) |
|
|
493 | |
|
|
494 | Remove the request with the given isdentifier. Returns true if successful, |
|
|
495 | false on error. |
|
|
496 | |
|
|
497 | =cut |
|
|
498 | |
|
|
499 | _txn remove_request => sub { |
|
|
500 | my ($self, $cv, $identifier, $global) = @_; |
|
|
501 | |
|
|
502 | $self->serialise ($identifier => sub { |
|
|
503 | my ($self, $guard) = @_; |
|
|
504 | |
|
|
505 | $self->send_msg (remove_request => |
|
|
506 | identifier => $identifier, |
|
|
507 | global => $global ? "true" : "false", |
|
|
508 | ); |
|
|
509 | $self->on (sub { |
| 432 | my ($self, $type, $kv, $rdata) = @_; |
510 | my ($self, $type, $kv, @extra) = @_; |
| 433 | |
511 | |
|
|
512 | if ($kv->{identifier} eq $identifier) { |
|
|
513 | if ($type eq "persistent_request_removed") { |
| 434 | $cv->($kv); |
514 | $cv->(1); |
|
|
515 | return; |
|
|
516 | } elsif ($type eq "protocol_error") { |
|
|
517 | $cv->(undef); |
|
|
518 | return; |
|
|
519 | } |
|
|
520 | } |
|
|
521 | |
| 435 | 1 |
522 | 1 |
| 436 | }, |
523 | }); |
| 437 | ); |
524 | }); |
|
|
525 | }; |
|
|
526 | |
|
|
527 | =item ($can_read, $can_write) = $fcp->test_dda ($local_directory, $remote_directory, $want_read, $want_write)) |
|
|
528 | |
|
|
529 | The DDA test in FCP is probably the single most broken protocol - only |
|
|
530 | one directory test can be outstanding at any time, and some guessing and |
|
|
531 | heuristics are involved in mangling the paths. |
|
|
532 | |
|
|
533 | This function combines C<TestDDARequest> and C<TestDDAResponse> in one |
|
|
534 | request, handling file reading and writing as well, and tries very hard to |
|
|
535 | do the right thing. |
|
|
536 | |
|
|
537 | Both C<$local_directory> and C<$remote_directory> must specify the same |
|
|
538 | directory - C<$local_directory> is the directory path on the client (where |
|
|
539 | L<AnyEvent::FCP> runs) and C<$remote_directory> is the directory path on |
|
|
540 | the server (where the freenet node runs). When both are running on the |
|
|
541 | same node, the paths are generally identical. |
|
|
542 | |
|
|
543 | C<$want_read> and C<$want_write> should be set to a true value when you |
|
|
544 | want to read (get) files or write (put) files, respectively. |
|
|
545 | |
|
|
546 | On error, an exception is thrown. Otherwise, C<$can_read> and |
|
|
547 | C<$can_write> indicate whether you can reaqd or write to freenet via the |
|
|
548 | directory. |
|
|
549 | |
|
|
550 | =cut |
|
|
551 | |
|
|
552 | _txn test_dda => sub { |
|
|
553 | my ($self, $cv, $local, $remote, $want_read, $want_write) = @_; |
|
|
554 | |
|
|
555 | $self->serialise (test_dda => sub { |
|
|
556 | my ($self, $guard) = @_; |
|
|
557 | |
|
|
558 | $self->send_msg (test_dda_request => |
|
|
559 | directory => $remote, |
|
|
560 | want_read_directory => $want_read ? "true" : "false", |
|
|
561 | want_write_directory => $want_write ? "true" : "false", |
|
|
562 | ); |
|
|
563 | $self->on (sub { |
|
|
564 | my ($self, $type, $kv) = @_; |
|
|
565 | |
|
|
566 | if ($type eq "test_dda_reply") { |
|
|
567 | # the filenames are all relative to the server-side directory, |
|
|
568 | # which might or might not match $remote anymore, so we |
|
|
569 | # need to rewrite the paths to be relative to $local |
|
|
570 | for my $k (qw(read_filename write_filename)) { |
|
|
571 | my $f = $kv->{$k}; |
|
|
572 | for my $dir ($kv->{directory}, $remote) { |
|
|
573 | if ($dir eq substr $f, 0, length $dir) { |
|
|
574 | substr $f, 0, 1 + length $dir, ""; |
|
|
575 | $kv->{$k} = $f; |
|
|
576 | last; |
|
|
577 | } |
|
|
578 | } |
|
|
579 | } |
|
|
580 | |
|
|
581 | my %response = (directory => $remote); |
|
|
582 | |
|
|
583 | if (length $kv->{read_filename}) { |
|
|
584 | if (open my $fh, "<:raw", "$local/$kv->{read_filename}") { |
|
|
585 | sysread $fh, my $buf, -s $fh; |
|
|
586 | $response{read_content} = $buf; |
|
|
587 | } |
|
|
588 | } |
|
|
589 | |
|
|
590 | if (length $kv->{write_filename}) { |
|
|
591 | if (open my $fh, ">:raw", "$local/$kv->{write_filename}") { |
|
|
592 | syswrite $fh, $kv->{content_to_write}; |
|
|
593 | } |
|
|
594 | } |
|
|
595 | |
|
|
596 | $self->send_msg (test_dda_response => %response); |
|
|
597 | |
|
|
598 | $self->on (sub { |
|
|
599 | my ($self, $type, $kv) = @_; |
|
|
600 | |
|
|
601 | $guard if 0; # reference |
|
|
602 | |
|
|
603 | if ($type eq "test_dda_complete") { |
|
|
604 | $cv->( |
|
|
605 | $kv->{read_directory_allowed} eq "true", |
|
|
606 | $kv->{write_directory_allowed} eq "true", |
|
|
607 | ); |
|
|
608 | } elsif ($type eq "protocol_error" && $kv->{identifier} eq $remote) { |
|
|
609 | $cv->croak ($kv->{extra_description}); |
|
|
610 | return; |
|
|
611 | } |
|
|
612 | |
|
|
613 | 1 |
|
|
614 | }); |
|
|
615 | |
|
|
616 | return; |
|
|
617 | } elsif ($type eq "protocol_error" && $kv->{identifier} eq $remote) { |
|
|
618 | $cv->croak ($kv->{extra_description}); |
|
|
619 | return; |
|
|
620 | } |
|
|
621 | |
|
|
622 | 1 |
|
|
623 | }); |
|
|
624 | }); |
| 438 | }; |
625 | }; |
| 439 | |
626 | |
| 440 | =back |
627 | =back |
| 441 | |
628 | |
|
|
629 | =head2 REQUEST CACHE |
|
|
630 | |
|
|
631 | The C<AnyEvent::FCP> class keeps a request cache, where it caches all |
|
|
632 | information from requests. |
|
|
633 | |
|
|
634 | For these messages, it will store a copy of the key-value pairs, together with a C<type> slot, |
|
|
635 | in C<< $fcp->{req}{$identifier} >>: |
|
|
636 | |
|
|
637 | persistent_get |
|
|
638 | persistent_put |
|
|
639 | persistent_put_dir |
|
|
640 | |
|
|
641 | This message updates the stored data: |
|
|
642 | |
|
|
643 | persistent_request_modified |
|
|
644 | |
|
|
645 | This message will remove this entry: |
|
|
646 | |
|
|
647 | persistent_request_removed |
|
|
648 | |
|
|
649 | These messages get merged into the cache entry, under their |
|
|
650 | type, i.e. a C<simple_progress> message will be stored in C<< |
|
|
651 | $fcp->{req}{$identifier}{simple_progress} >>: |
|
|
652 | |
|
|
653 | simple_progress # get/put |
|
|
654 | |
|
|
655 | uri_generated # put |
|
|
656 | generated_metadata # put |
|
|
657 | started_compression # put |
|
|
658 | finished_compression # put |
|
|
659 | put_failed # put |
|
|
660 | put_fetchable # put |
|
|
661 | put_successful # put |
|
|
662 | |
|
|
663 | sending_to_network # get |
|
|
664 | compatibility_mode # get |
|
|
665 | expected_hashes # get |
|
|
666 | expected_mime # get |
|
|
667 | expected_data_length # get |
|
|
668 | get_failed # get |
|
|
669 | data_found # get |
|
|
670 | enter_finite_cooldown # get |
|
|
671 | |
|
|
672 | In addition, an event (basically a fake message) of type C<request_changed> is generated |
|
|
673 | on every change, which will be called as C<< $cb->($fcp, $kv, $type) >>, where C<$type> |
|
|
674 | is the type of the original message triggering the change, |
|
|
675 | |
|
|
676 | To fill this cache with the global queue and keep it updated, |
|
|
677 | call C<watch_global> to subscribe to updates, followed by |
|
|
678 | C<list_persistent_requests_sync>. |
|
|
679 | |
|
|
680 | $fcp->watch_global_sync_; # do not wait |
|
|
681 | $fcp->list_persistent_requests; # wait |
|
|
682 | |
|
|
683 | To get a better idea of what is stored in the cache, here is an example of |
|
|
684 | what might be stored in C<< $fcp->{req}{"Frost-gpl.txt"} >>: |
|
|
685 | |
|
|
686 | { |
|
|
687 | identifier => "Frost-gpl.txt", |
|
|
688 | uri => 'CHK@Fnx5kzdrfE,EImdzaVyEWl,AAIC--8/gpl.txt', |
|
|
689 | binary_blob => "false", |
|
|
690 | global => "true", |
|
|
691 | max_retries => -1, |
|
|
692 | max_size => 9223372036854775807, |
|
|
693 | persistence => "forever", |
|
|
694 | priority_class => 3, |
|
|
695 | real_time => "false", |
|
|
696 | return_type => "direct", |
|
|
697 | started => "true", |
|
|
698 | type => "persistent_get", |
|
|
699 | verbosity => 2147483647, |
|
|
700 | sending_to_network => { |
|
|
701 | identifier => "Frost-gpl.txt", |
|
|
702 | global => "true", |
|
|
703 | }, |
|
|
704 | compatibility_mode => { |
|
|
705 | identifier => "Frost-gpl.txt", |
|
|
706 | definitive => "true", |
|
|
707 | dont_compress => "false", |
|
|
708 | global => "true", |
|
|
709 | max => "COMPAT_1255", |
|
|
710 | min => "COMPAT_1255", |
|
|
711 | }, |
|
|
712 | expected_hashes => { |
|
|
713 | identifier => "Frost-gpl.txt", |
|
|
714 | global => "true", |
|
|
715 | hashes => { |
|
|
716 | ed2k => "d83596f5ee3b7...", |
|
|
717 | md5 => "e0894e4a2a6...", |
|
|
718 | sha1 => "...", |
|
|
719 | sha256 => "...", |
|
|
720 | sha512 => "...", |
|
|
721 | tth => "...", |
|
|
722 | }, |
|
|
723 | }, |
|
|
724 | expected_mime => { |
|
|
725 | identifier => "Frost-gpl.txt", |
|
|
726 | global => "true", |
|
|
727 | metadata => { content_type => "application/rar" }, |
|
|
728 | }, |
|
|
729 | expected_data_length => { |
|
|
730 | identifier => "Frost-gpl.txt", |
|
|
731 | data_length => 37576, |
|
|
732 | global => "true", |
|
|
733 | }, |
|
|
734 | simple_progress => { |
|
|
735 | identifier => "Frost-gpl.txt", |
|
|
736 | failed => 0, |
|
|
737 | fatally_failed => 0, |
|
|
738 | finalized_total => "true", |
|
|
739 | global => "true", |
|
|
740 | last_progress => 1438639282628, |
|
|
741 | required => 372, |
|
|
742 | succeeded => 102, |
|
|
743 | total => 747, |
|
|
744 | }, |
|
|
745 | data_found => { |
|
|
746 | identifier => "Frost-gpl.txt", |
|
|
747 | completion_time => 1438663354026, |
|
|
748 | data_length => 37576, |
|
|
749 | global => "true", |
|
|
750 | metadata => { content_type => "image/jpeg" }, |
|
|
751 | startup_time => 1438657196167, |
|
|
752 | }, |
|
|
753 | } |
|
|
754 | |
| 442 | =head1 EXAMPLE PROGRAM |
755 | =head1 EXAMPLE PROGRAM |
| 443 | |
756 | |
| 444 | use AnyEvent::FCP; |
757 | use AnyEvent::FCP; |
| 445 | |
758 | |
| 446 | my $fcp = new AnyEvent::FCP; |
759 | my $fcp = new AnyEvent::FCP; |
| 447 | |
760 | |
| 448 | # let us look at the global request list |
761 | # let us look at the global request list |
| 449 | $fcp->watch_global (1, 0); |
762 | $fcp->watch_global_ (1); |
| 450 | |
763 | |
| 451 | # list them, synchronously |
764 | # list them, synchronously |
| 452 | my $req = $fcp->list_persistent_requests_sync; |
765 | my $req = $fcp->list_persistent_requests; |
| 453 | |
766 | |
| 454 | # go through all requests |
767 | # go through all requests |
|
|
768 | TODO |
| 455 | for my $req (values %$req) { |
769 | for my $req (values %$req) { |
| 456 | # skip jobs not directly-to-disk |
770 | # skip jobs not directly-to-disk |
| 457 | next unless $req->{return_type} eq "disk"; |
771 | next unless $req->{return_type} eq "disk"; |
| 458 | # skip jobs not issued by FProxy |
772 | # skip jobs not issued by FProxy |
| 459 | next unless $req->{identifier} =~ /^FProxy:/; |
773 | next unless $req->{identifier} =~ /^FProxy:/; |
