… | |
… | |
14 | =head1 DESCRIPTION |
14 | =head1 DESCRIPTION |
15 | |
15 | |
16 | See L<http://freenet.sourceforge.net/index.php?page=fcp> for a description |
16 | See L<http://freenet.sourceforge.net/index.php?page=fcp> for a description |
17 | of what the messages do. I am too lazy to document all this here. |
17 | of what the messages do. I am too lazy to document all this here. |
18 | |
18 | |
|
|
19 | The module uses L<AnyEvent> to find a suitable Event module. |
|
|
20 | |
19 | =head1 WARNING |
21 | =head1 WARNING |
20 | |
22 | |
21 | This module is alpha. While it probably won't destroy (much :) of your |
23 | This module is alpha. While it probably won't destroy (much :) of your |
22 | data, it currently works only with the Event module (alkthough the event |
24 | data, it currently falls short of what it should provide (intelligent uri |
23 | mechanism is fully pluggable). |
25 | following, splitfile downloads, healing...) |
|
|
26 | |
|
|
27 | =head2 IMPORT TAGS |
|
|
28 | |
|
|
29 | Nothing much can be "imported" from this module right now. |
|
|
30 | |
|
|
31 | =head2 FREENET BASICS |
|
|
32 | |
|
|
33 | Ok, this section will not explain any freenet basics to you, just some |
|
|
34 | problems I found that you might want to avoid: |
|
|
35 | |
|
|
36 | =over 4 |
|
|
37 | |
|
|
38 | =item freenet URIs are _NOT_ URIs |
|
|
39 | |
|
|
40 | Whenever a "uri" is required by the protocol, freenet expects a kind of |
|
|
41 | URI prefixed with the "freenet:" scheme, e.g. "freenet:CHK...". However, |
|
|
42 | these are not URIs, as freeent fails to parse them correctly, that is, you |
|
|
43 | must unescape an escaped characters ("%2c" => ",") yourself. Maybe in the |
|
|
44 | future this library will do it for you, so watch out for this incompatible |
|
|
45 | change. |
|
|
46 | |
|
|
47 | =item Numbers are in HEX |
|
|
48 | |
|
|
49 | Virtually every number in the FCP protocol is in hex. Be sure to use |
|
|
50 | C<hex()> on all such numbers, as the module (currently) does nothing to |
|
|
51 | convert these for you. |
|
|
52 | |
|
|
53 | =back |
24 | |
54 | |
25 | =head2 THE Net::FCP CLASS |
55 | =head2 THE Net::FCP CLASS |
26 | |
56 | |
27 | =over 4 |
57 | =over 4 |
28 | |
58 | |
29 | =cut |
59 | =cut |
30 | |
60 | |
31 | package Net::FCP; |
61 | package Net::FCP; |
32 | |
62 | |
33 | use Carp; |
63 | use Carp; |
34 | use IO::Socket::INET; |
|
|
35 | |
64 | |
36 | $VERSION = 0.02; |
65 | $VERSION = '1.1'; |
37 | |
66 | |
38 | sub event_reg_cb { |
67 | no warnings; |
39 | my ($obj) = @_; |
|
|
40 | require Event; |
|
|
41 | |
68 | |
42 | $obj->{eventdata} = Event->io ( |
69 | use AnyEvent; |
43 | fd => $obj->{fh}, |
|
|
44 | poll => 'r', |
|
|
45 | cb => sub { |
|
|
46 | $obj->fh_ready; |
|
|
47 | }, |
|
|
48 | ); |
|
|
49 | } |
|
|
50 | |
70 | |
51 | sub event_unreg_cb { |
71 | use Net::FCP::Metadata; |
52 | $_[0]{eventdata} |
72 | use Net::FCP::Util qw(tolc touc xeh); |
53 | and (delete $_[0]{eventdata})->cancel; |
|
|
54 | } |
|
|
55 | |
73 | |
56 | sub event_wait_cb { |
|
|
57 | Event::one_event(); |
|
|
58 | } |
|
|
59 | |
|
|
60 | $regcb = \&event_reg_cb; |
|
|
61 | $unregcb = \&event_unreg_cb; |
|
|
62 | $waitcb = \&event_wait_cb; |
|
|
63 | |
|
|
64 | sub touc($) { |
|
|
65 | local $_ = shift; |
|
|
66 | 1 while s/((?:^|_)(?:svk|chk|uri)(?:_|$))/\U$1/; |
|
|
67 | s/(?:^|_)(.)/\U$1/g; |
|
|
68 | $_; |
|
|
69 | } |
|
|
70 | |
|
|
71 | sub tolc($) { |
|
|
72 | local $_ = shift; |
|
|
73 | s/(?<=[a-z])(?=[A-Z])/_/g; |
|
|
74 | lc $_; |
|
|
75 | } |
|
|
76 | |
|
|
77 | =item $fcp = new Net::FCP [host => $host][, port => $port] |
74 | =item $fcp = new Net::FCP [host => $host][, port => $port][, progress => \&cb] |
78 | |
75 | |
79 | Create a new virtual FCP connection to the given host and port (default |
76 | Create a new virtual FCP connection to the given host and port (default |
80 | 127.0.0.1:8481). |
77 | 127.0.0.1:8481, or the environment variables C<FREDHOST> and C<FREDPORT>). |
81 | |
78 | |
82 | Connections are virtual because no persistent physical connection is |
79 | Connections are virtual because no persistent physical connection is |
83 | established. However, the existance of the node is checked by executing a |
80 | established. |
84 | C<ClientHello> transaction. |
81 | |
|
|
82 | You can install a progress callback that is being called with the Net::FCP |
|
|
83 | object, a txn object, the type of the transaction and the attributes. Use |
|
|
84 | it like this: |
|
|
85 | |
|
|
86 | sub progress_cb { |
|
|
87 | my ($self, $txn, $type, $attr) = @_; |
|
|
88 | |
|
|
89 | warn "progress<$txn,$type," . (join ":", %$attr) . ">\n"; |
|
|
90 | } |
85 | |
91 | |
86 | =cut |
92 | =cut |
87 | |
93 | |
88 | sub new { |
94 | sub new { |
89 | my $class = shift; |
95 | my $class = shift; |
90 | my $self = bless { @_ }, $class; |
96 | my $self = bless { @_ }, $class; |
91 | |
97 | |
92 | $self->{host} ||= "127.0.0.1"; |
98 | $self->{host} ||= $ENV{FREDHOST} || "127.0.0.1"; |
93 | $self->{port} ||= 8481; |
99 | $self->{port} ||= $ENV{FREDPORT} || 8481; |
94 | |
|
|
95 | $self->{nodehello} = $self->txn("ClientHello")->result |
|
|
96 | or croak "unable to get nodehello from node\n"; |
|
|
97 | |
100 | |
98 | $self; |
101 | $self; |
99 | } |
102 | } |
100 | |
103 | |
|
|
104 | sub progress { |
|
|
105 | my ($self, $txn, $type, $attr) = @_; |
|
|
106 | |
|
|
107 | $self->{progress}->($self, $txn, $type, $attr) |
|
|
108 | if $self->{progress}; |
|
|
109 | } |
|
|
110 | |
101 | =item $txn = $fcp->txn(type => attr => val,...) |
111 | =item $txn = $fcp->txn (type => attr => val,...) |
102 | |
112 | |
103 | The low-level interface to transactions. Don't use it. |
113 | The low-level interface to transactions. Don't use it unless you have |
|
|
114 | "special needs". Instead, use predefiend transactions like this: |
|
|
115 | |
|
|
116 | The blocking case, no (visible) transactions involved: |
|
|
117 | |
|
|
118 | my $nodehello = $fcp->client_hello; |
|
|
119 | |
|
|
120 | A transaction used in a blocking fashion: |
|
|
121 | |
|
|
122 | my $txn = $fcp->txn_client_hello; |
|
|
123 | ... |
|
|
124 | my $nodehello = $txn->result; |
|
|
125 | |
|
|
126 | Or shorter: |
|
|
127 | |
|
|
128 | my $nodehello = $fcp->txn_client_hello->result; |
|
|
129 | |
|
|
130 | Setting callbacks: |
|
|
131 | |
|
|
132 | $fcp->txn_client_hello->cb( |
|
|
133 | sub { my $nodehello => $_[0]->result } |
|
|
134 | ); |
104 | |
135 | |
105 | =cut |
136 | =cut |
106 | |
137 | |
107 | sub txn { |
138 | sub txn { |
108 | my ($self, $type, %attr) = @_; |
139 | my ($self, $type, %attr) = @_; |
109 | |
140 | |
110 | $type = touc $type; |
141 | $type = touc $type; |
111 | |
142 | |
112 | my $txn = "Net::FCP::Txn::$type"->new(fcp => $self, type => tolc $type, attr => \%attr); |
143 | my $txn = "Net::FCP::Txn::$type"->new (fcp => $self, type => tolc $type, attr => \%attr); |
113 | |
144 | |
114 | $txn; |
145 | $txn; |
115 | } |
146 | } |
116 | |
147 | |
117 | sub _txn($&) { |
148 | { # transactions |
|
|
149 | |
|
|
150 | my $txn = sub { |
118 | my ($name, $sub) = @_; |
151 | my ($name, $sub) = @_; |
119 | *{"$name\_txn"} = $sub; |
152 | *{"txn_$name"} = $sub; |
120 | *{$name} = sub { $sub->(@_)->result }; |
153 | *{$name} = sub { $sub->(@_)->result }; |
121 | } |
154 | }; |
122 | |
155 | |
123 | =item $txn = $fcp->txn_client_hello |
156 | =item $txn = $fcp->txn_client_hello |
124 | |
157 | |
125 | =item $nodehello = $fcp->client_hello |
158 | =item $nodehello = $fcp->client_hello |
126 | |
159 | |
… | |
… | |
132 | protocol => "1.2", |
165 | protocol => "1.2", |
133 | } |
166 | } |
134 | |
167 | |
135 | =cut |
168 | =cut |
136 | |
169 | |
137 | _txn client_hello => sub { |
170 | $txn->(client_hello => sub { |
138 | my ($self) = @_; |
171 | my ($self) = @_; |
139 | |
172 | |
140 | $self->txn ("client_hello"); |
173 | $self->txn ("client_hello"); |
141 | }; |
174 | }); |
142 | |
175 | |
143 | =item $txn = $fcp->txn_client_info |
176 | =item $txn = $fcp->txn_client_info |
144 | |
177 | |
145 | =item $nodeinfo = $fcp->client_info |
178 | =item $nodeinfo = $fcp->client_info |
146 | |
179 | |
… | |
… | |
170 | routing_time => "a5", |
203 | routing_time => "a5", |
171 | } |
204 | } |
172 | |
205 | |
173 | =cut |
206 | =cut |
174 | |
207 | |
175 | _txn client_info => sub { |
208 | $txn->(client_info => sub { |
176 | my ($self) = @_; |
209 | my ($self) = @_; |
177 | |
210 | |
178 | $self->txn ("client_info"); |
211 | $self->txn ("client_info"); |
179 | }; |
212 | }); |
180 | |
213 | |
181 | =item $txn = $fcp->txn_generate_chk ($metadata, $data) |
214 | =item $txn = $fcp->txn_generate_chk ($metadata, $data[, $cipher]) |
182 | |
215 | |
183 | =item $uri = $fcp->generate_chk ($metadata, $data) |
216 | =item $uri = $fcp->generate_chk ($metadata, $data[, $cipher]) |
184 | |
217 | |
185 | Creates a new CHK, given the metadata and data. UNTESTED. |
218 | Calculates a CHK, given the metadata and data. C<$cipher> is either |
|
|
219 | C<Rijndael> or C<Twofish>, with the latter being the default. |
186 | |
220 | |
187 | =cut |
221 | =cut |
188 | |
222 | |
189 | _txn generate_chk => sub { |
223 | $txn->(generate_chk => sub { |
190 | my ($self, $metadata, $data) = @_; |
224 | my ($self, $metadata, $data, $cipher) = @_; |
191 | |
225 | |
192 | $self->txn (generate_chk => data => "$data$metadata", meta_data_length => length $metadata); |
226 | $metadata = Net::FCP::Metadata::build_metadata $metadata; |
|
|
227 | |
|
|
228 | $self->txn (generate_chk => |
|
|
229 | data => "$metadata$data", |
|
|
230 | metadata_length => xeh length $metadata, |
|
|
231 | cipher => $cipher || "Twofish"); |
193 | }; |
232 | }); |
194 | |
233 | |
195 | =item $txn = $fcp->txn_generate_svk_pair |
234 | =item $txn = $fcp->txn_generate_svk_pair |
196 | |
235 | |
197 | =item ($public, $private) = @{ $fcp->generate_svk_pair } |
236 | =item ($public, $private, $crypto) = @{ $fcp->generate_svk_pair } |
198 | |
237 | |
199 | Creates a new SVK pair. Returns an arrayref. |
238 | Creates a new SVK pair. Returns an arrayref with the public key, the |
|
|
239 | private key and a crypto key, which is just additional entropy. |
200 | |
240 | |
201 | [ |
241 | [ |
202 | "hKs0-WDQA4pVZyMPKNFsK1zapWY", |
242 | "acLx4dux9fvvABH15Gk6~d3I-yw", |
203 | "ZnmvMITaTXBMFGl4~jrjuyWxOWg" |
243 | "cPoDkDMXDGSMM32plaPZDhJDxSs", |
|
|
244 | "BH7LXCov0w51-y9i~BoB3g", |
204 | ] |
245 | ] |
205 | |
246 | |
206 | =cut |
247 | A private key (for inserting) can be constructed like this: |
207 | |
248 | |
|
|
249 | SSK@<private_key>,<crypto_key>/<name> |
|
|
250 | |
|
|
251 | It can be used to insert data. The corresponding public key looks like this: |
|
|
252 | |
|
|
253 | SSK@<public_key>PAgM,<crypto_key>/<name> |
|
|
254 | |
|
|
255 | Watch out for the C<PAgM>-part! |
|
|
256 | |
|
|
257 | =cut |
|
|
258 | |
208 | _txn generate_svk_pair => sub { |
259 | $txn->(generate_svk_pair => sub { |
209 | my ($self) = @_; |
260 | my ($self) = @_; |
210 | |
261 | |
211 | $self->txn ("generate_svk_pair"); |
262 | $self->txn ("generate_svk_pair"); |
212 | }; |
263 | }); |
213 | |
264 | |
214 | =item $txn = $fcp->txn_insert_private_key ($private) |
265 | =item $txn = $fcp->txn_invert_private_key ($private) |
215 | |
266 | |
216 | =item $uri = $fcp->insert_private_key ($private) |
267 | =item $public = $fcp->invert_private_key ($private) |
217 | |
268 | |
218 | Inserts a private key. $private can be either an insert URI (must start |
269 | Inverts a private key (returns the public key). C<$private> can be either |
219 | with freenet:SSK@) or a raw private key (i.e. the private value you get back |
270 | an insert URI (must start with C<freenet:SSK@>) or a raw private key (i.e. |
220 | from C<generate_svk_pair>). |
271 | the private value you get back from C<generate_svk_pair>). |
221 | |
272 | |
222 | Returns the public key. |
273 | Returns the public key. |
223 | |
274 | |
224 | UNTESTED. |
|
|
225 | |
|
|
226 | =cut |
275 | =cut |
227 | |
276 | |
228 | _txn insert_private_key => sub { |
277 | $txn->(invert_private_key => sub { |
229 | my ($self, $privkey) = @_; |
278 | my ($self, $privkey) = @_; |
230 | |
279 | |
231 | $self->txn (invert_private_key => private => $privkey); |
280 | $self->txn (invert_private_key => private => $privkey); |
232 | }; |
281 | }); |
233 | |
282 | |
234 | =item $txn = $fcp->txn_get_size ($uri) |
283 | =item $txn = $fcp->txn_get_size ($uri) |
235 | |
284 | |
236 | =item $length = $fcp->get_size ($uri) |
285 | =item $length = $fcp->get_size ($uri) |
237 | |
286 | |
238 | Finds and returns the size (rounded up to the nearest power of two) of the |
287 | Finds and returns the size (rounded up to the nearest power of two) of the |
239 | given document. |
288 | given document. |
240 | |
289 | |
241 | UNTESTED. |
|
|
242 | |
|
|
243 | =cut |
290 | =cut |
244 | |
291 | |
245 | _txn get_size => sub { |
292 | $txn->(get_size => sub { |
246 | my ($self, $uri) = @_; |
293 | my ($self, $uri) = @_; |
247 | |
294 | |
248 | $self->txn (get_size => URI => $uri); |
295 | $self->txn (get_size => URI => $uri); |
249 | }; |
296 | }); |
250 | |
297 | |
251 | =item MISSING: ClientGet, ClientPut |
298 | =item $txn = $fcp->txn_client_get ($uri [, $htl = 15 [, $removelocal = 0]]) |
|
|
299 | |
|
|
300 | =item ($metadata, $data) = @{ $fcp->client_get ($uri, $htl, $removelocal) |
|
|
301 | |
|
|
302 | Fetches a (small, as it should fit into memory) key content block from |
|
|
303 | freenet. C<$meta> is a C<Net::FCP::Metadata> object or C<undef>). |
|
|
304 | |
|
|
305 | The C<$uri> should begin with C<freenet:>, but the scheme is currently |
|
|
306 | added, if missing. |
|
|
307 | |
|
|
308 | my ($meta, $data) = @{ |
|
|
309 | $fcp->client_get ( |
|
|
310 | "freenet:CHK@hdXaxkwZ9rA8-SidT0AN-bniQlgPAwI,XdCDmBuGsd-ulqbLnZ8v~w" |
|
|
311 | ) |
|
|
312 | }; |
|
|
313 | |
|
|
314 | =cut |
|
|
315 | |
|
|
316 | $txn->(client_get => sub { |
|
|
317 | my ($self, $uri, $htl, $removelocal) = @_; |
|
|
318 | |
|
|
319 | $uri =~ s/^freenet://; $uri = "freenet:$uri"; |
|
|
320 | |
|
|
321 | $self->txn (client_get => URI => $uri, hops_to_live => xeh (defined $htl ? $htl : 15), |
|
|
322 | remove_local_key => $removelocal ? "true" : "false"); |
|
|
323 | }); |
|
|
324 | |
|
|
325 | =item $txn = $fcp->txn_client_put ($uri, $metadata, $data, $htl, $removelocal) |
|
|
326 | |
|
|
327 | =item my $uri = $fcp->client_put ($uri, $metadata, $data, $htl, $removelocal); |
|
|
328 | |
|
|
329 | Insert a new key. If the client is inserting a CHK, the URI may be |
|
|
330 | abbreviated as just CHK@. In this case, the node will calculate the |
|
|
331 | CHK. If the key is a private SSK key, the node will calculcate the public |
|
|
332 | key and the resulting public URI. |
|
|
333 | |
|
|
334 | C<$meta> can be a hash reference (same format as returned by |
|
|
335 | C<Net::FCP::parse_metadata>) or a string. |
|
|
336 | |
|
|
337 | The result is an arrayref with the keys C<uri>, C<public_key> and C<private_key>. |
|
|
338 | |
|
|
339 | =cut |
|
|
340 | |
|
|
341 | $txn->(client_put => sub { |
|
|
342 | my ($self, $uri, $metadata, $data, $htl, $removelocal) = @_; |
|
|
343 | |
|
|
344 | $metadata = Net::FCP::Metadata::build_metadata $metadata; |
|
|
345 | $uri =~ s/^freenet://; $uri = "freenet:$uri"; |
|
|
346 | |
|
|
347 | $self->txn (client_put => URI => $uri, |
|
|
348 | hops_to_live => xeh (defined $htl ? $htl : 15), |
|
|
349 | remove_local_key => $removelocal ? "true" : "false", |
|
|
350 | data => "$metadata$data", metadata_length => xeh length $metadata); |
|
|
351 | }); |
|
|
352 | |
|
|
353 | } # transactions |
252 | |
354 | |
253 | =back |
355 | =back |
254 | |
356 | |
255 | =head2 THE Net::FCP::Txn CLASS |
357 | =head2 THE Net::FCP::Txn CLASS |
256 | |
358 | |
257 | All requests (or transactions) are executed in a asynchroneous way (LIE: |
359 | All requests (or transactions) are executed in a asynchronous way. For |
258 | uploads are blocking). For each request, a C<Net::FCP::Txn> object is |
360 | each request, a C<Net::FCP::Txn> object is created (worse: a tcp |
259 | created (worse: a tcp connection is created, too). |
361 | connection is created, too). |
260 | |
362 | |
261 | For each request there is actually a different subclass (and it's possible |
363 | For each request there is actually a different subclass (and it's possible |
262 | to subclass these, although of course not documented). |
364 | to subclass these, although of course not documented). |
263 | |
365 | |
264 | The most interesting method is C<result>. |
366 | The most interesting method is C<result>. |
… | |
… | |
266 | =over 4 |
368 | =over 4 |
267 | |
369 | |
268 | =cut |
370 | =cut |
269 | |
371 | |
270 | package Net::FCP::Txn; |
372 | package Net::FCP::Txn; |
|
|
373 | |
|
|
374 | use Fcntl; |
|
|
375 | use Socket; |
271 | |
376 | |
272 | =item new arg => val,... |
377 | =item new arg => val,... |
273 | |
378 | |
274 | Creates a new C<Net::FCP::Txn> object. Not normally used. |
379 | Creates a new C<Net::FCP::Txn> object. Not normally used. |
275 | |
380 | |
… | |
… | |
277 | |
382 | |
278 | sub new { |
383 | sub new { |
279 | my $class = shift; |
384 | my $class = shift; |
280 | my $self = bless { @_ }, $class; |
385 | my $self = bless { @_ }, $class; |
281 | |
386 | |
|
|
387 | $self->{signal} = AnyEvent->condvar; |
|
|
388 | |
|
|
389 | $self->{fcp}{txn}{$self} = $self; |
|
|
390 | |
282 | my $attr = ""; |
391 | my $attr = ""; |
283 | my $data = delete $self->{attr}{data}; |
392 | my $data = delete $self->{attr}{data}; |
284 | |
393 | |
285 | while (my ($k, $v) = each %{$self->{attr}}) { |
394 | while (my ($k, $v) = each %{$self->{attr}}) { |
286 | $attr .= (Net::FCP::touc $k) . "=$v\012" |
395 | $attr .= (Net::FCP::touc $k) . "=$v\012" |
287 | } |
396 | } |
288 | |
397 | |
289 | if (defined $data) { |
398 | if (defined $data) { |
290 | $attr .= "DataLength=" . (length $data) . "\012"; |
399 | $attr .= sprintf "DataLength=%x\012", length $data; |
291 | $data = "Data\012$data"; |
400 | $data = "Data\012$data"; |
292 | } else { |
401 | } else { |
293 | $data = "EndMessage\012"; |
402 | $data = "EndMessage\012"; |
294 | } |
403 | } |
295 | |
404 | |
296 | my $fh = new IO::Socket::INET |
405 | socket my $fh, PF_INET, SOCK_STREAM, 0 |
297 | PeerHost => $self->{fcp}{host}, |
406 | or Carp::croak "unable to create new tcp socket: $!"; |
298 | PeerPort => $self->{fcp}{port} |
|
|
299 | or Carp::croak "FCP::txn: unable to connect to $self->{fcp}{host}:$self->{fcp}{port}: $!\n"; |
|
|
300 | |
|
|
301 | binmode $fh, ":raw"; |
407 | binmode $fh, ":raw"; |
|
|
408 | fcntl $fh, F_SETFL, O_NONBLOCK; |
|
|
409 | connect $fh, (sockaddr_in $self->{fcp}{port}, inet_aton $self->{fcp}{host}); |
|
|
410 | # and Carp::croak "FCP::txn: unable to connect to $self->{fcp}{host}:$self->{fcp}{port}: $!\n"; |
302 | |
411 | |
303 | if (0) { |
412 | $self->{sbuf} = |
304 | print |
413 | "\x00\x00\x00\x02" |
305 | Net::FCP::touc $self->{type}, "\012", |
|
|
306 | $attr, |
|
|
307 | $data, "\012"; |
|
|
308 | } |
|
|
309 | |
|
|
310 | print $fh |
|
|
311 | "\x00\x00", "\x00\x02", # SESSID, PRESID |
|
|
312 | Net::FCP::touc $self->{type}, "\012", |
414 | . (Net::FCP::touc $self->{type}) |
313 | $attr, |
415 | . "\012$attr$data"; |
314 | $data; |
|
|
315 | |
416 | |
316 | #$fh->shutdown (1); # freenet buggy?, well, it's java... |
417 | #shutdown $fh, 1; # freenet buggy?, well, it's java... |
317 | |
418 | |
318 | $self->{fh} = $fh; |
419 | $self->{fh} = $fh; |
319 | |
420 | |
320 | $Net::FCP::regcb->($self); |
421 | $self->{w} = AnyEvent->io (fh => $fh, poll => 'w', cb => sub { $self->fh_ready_w }); |
321 | |
422 | |
322 | $self; |
423 | $self; |
323 | } |
424 | } |
324 | |
425 | |
|
|
426 | =item $txn = $txn->cb ($coderef) |
|
|
427 | |
|
|
428 | Sets a callback to be called when the request is finished. The coderef |
|
|
429 | will be called with the txn as it's sole argument, so it has to call |
|
|
430 | C<result> itself. |
|
|
431 | |
|
|
432 | Returns the txn object, useful for chaining. |
|
|
433 | |
|
|
434 | Example: |
|
|
435 | |
|
|
436 | $fcp->txn_client_get ("freenet:CHK....") |
|
|
437 | ->userdata ("ehrm") |
|
|
438 | ->cb(sub { |
|
|
439 | my $data = shift->result; |
|
|
440 | }); |
|
|
441 | |
|
|
442 | =cut |
|
|
443 | |
|
|
444 | sub cb($$) { |
|
|
445 | my ($self, $cb) = @_; |
|
|
446 | $self->{cb} = $cb; |
|
|
447 | $self; |
|
|
448 | } |
|
|
449 | |
|
|
450 | =item $txn = $txn->userdata ([$userdata]) |
|
|
451 | |
|
|
452 | Set user-specific data. This is useful in progress callbacks. The data can be accessed |
|
|
453 | using C<< $txn->{userdata} >>. |
|
|
454 | |
|
|
455 | Returns the txn object, useful for chaining. |
|
|
456 | |
|
|
457 | =cut |
|
|
458 | |
|
|
459 | sub userdata($$) { |
|
|
460 | my ($self, $data) = @_; |
|
|
461 | $self->{userdata} = $data; |
|
|
462 | $self; |
|
|
463 | } |
|
|
464 | |
|
|
465 | =item $txn->cancel (%attr) |
|
|
466 | |
|
|
467 | Cancels the operation with a C<cancel> exception and the given attributes |
|
|
468 | (consider at least giving the attribute C<reason>). |
|
|
469 | |
|
|
470 | UNTESTED. |
|
|
471 | |
|
|
472 | =cut |
|
|
473 | |
|
|
474 | sub cancel { |
|
|
475 | my ($self, %attr) = @_; |
|
|
476 | $self->throw (Net::FCP::Exception->new (cancel => { %attr })); |
|
|
477 | $self->set_result; |
|
|
478 | $self->eof; |
|
|
479 | } |
|
|
480 | |
325 | sub fh_ready { |
481 | sub fh_ready_w { |
326 | my ($self) = @_; |
482 | my ($self) = @_; |
327 | |
483 | |
|
|
484 | my $len = syswrite $self->{fh}, $self->{sbuf}; |
|
|
485 | |
|
|
486 | if ($len > 0) { |
|
|
487 | substr $self->{sbuf}, 0, $len, ""; |
|
|
488 | unless (length $self->{sbuf}) { |
|
|
489 | fcntl $self->{fh}, F_SETFL, 0; |
|
|
490 | $self->{w} = AnyEvent->io (fh => $self->{fh}, poll => 'r', cb => sub { $self->fh_ready_r }); |
|
|
491 | } |
|
|
492 | } elsif (defined $len) { |
|
|
493 | $self->throw (Net::FCP::Exception->new (network_error => { reason => "unexpected end of file while writing" })); |
|
|
494 | } else { |
|
|
495 | $self->throw (Net::FCP::Exception->new (network_error => { reason => "$!" })); |
|
|
496 | } |
|
|
497 | } |
|
|
498 | |
|
|
499 | sub fh_ready_r { |
|
|
500 | my ($self) = @_; |
|
|
501 | |
328 | if (sysread $self->{fh}, $self->{buf}, 65536, length $self->{buf}) { |
502 | if (sysread $self->{fh}, $self->{buf}, 16384 + 1024, length $self->{buf}) { |
329 | for (;;) { |
503 | for (;;) { |
330 | if ($self->{datalen}) { |
504 | if ($self->{datalen}) { |
|
|
505 | #warn "expecting new datachunk $self->{datalen}, got ".(length $self->{buf})."\n";#d# |
331 | if (length $self->{buf} >= $self->{datalen}) { |
506 | if (length $self->{buf} >= $self->{datalen}) { |
332 | $self->recv_data (substr $self->{buf}, 0, $self->{datalen}, ""); |
507 | $self->rcv_data (substr $self->{buf}, 0, delete $self->{datalen}, ""); |
333 | } else { |
508 | } else { |
334 | last; |
509 | last; |
335 | } |
510 | } |
336 | } elsif ($self->{buf} =~ s/^DataChunk\015?\012Length=(\d+)\015?\012Data\015?\012//) { |
511 | } elsif ($self->{buf} =~ s/^DataChunk\015?\012Length=([0-9a-fA-F]+)\015?\012Data\015?\012//) { |
337 | $self->{datalen} = $1; |
512 | $self->{datalen} = hex $1; |
|
|
513 | #warn "expecting new datachunk $self->{datalen}\n";#d# |
338 | } elsif ($self->{buf} =~ s/^([a-zA-Z]+)\015?\012(.*?)\015?\012EndMessage\015?\012//s) { |
514 | } elsif ($self->{buf} =~ s/^([a-zA-Z]+)\015?\012(?:(.+?)\015?\012)?EndMessage\015?\012//s) { |
339 | $self->rcv ($1, { |
515 | $self->rcv ($1, { |
340 | map { my ($a, $b) = split /=/, $_, 2; ((Net::FCP::tolc $a), $b) } |
516 | map { my ($a, $b) = split /=/, $_, 2; ((Net::FCP::tolc $a), $b) } |
341 | split /\015?\012/, $2 |
517 | split /\015?\012/, $2 |
342 | }); |
518 | }); |
343 | } else { |
519 | } else { |
344 | last; |
520 | last; |
345 | } |
521 | } |
346 | } |
522 | } |
347 | } else { |
523 | } else { |
348 | $Net::FCP::unregcb->($self); |
|
|
349 | delete $self->{fh}; |
|
|
350 | $self->eof; |
524 | $self->eof; |
351 | } |
525 | } |
352 | } |
|
|
353 | |
|
|
354 | sub rcv_data { |
|
|
355 | my ($self, $chunk) = @_; |
|
|
356 | } |
526 | } |
357 | |
527 | |
358 | sub rcv { |
528 | sub rcv { |
359 | my ($self, $type, $attr) = @_; |
529 | my ($self, $type, $attr) = @_; |
360 | |
530 | |
361 | $type = Net::FCP::tolc $type; |
531 | $type = Net::FCP::tolc $type; |
|
|
532 | |
|
|
533 | #use PApp::Util; warn PApp::Util::dumpval [$type, $attr]; |
362 | |
534 | |
363 | if (my $method = $self->can("rcv_$type")) { |
535 | if (my $method = $self->can("rcv_$type")) { |
364 | $method->($self, $attr, $type); |
536 | $method->($self, $attr, $type); |
365 | } else { |
537 | } else { |
366 | warn "received unexpected reply type '$type' for '$self->{type}', ignoring\n"; |
538 | warn "received unexpected reply type '$type' for '$self->{type}', ignoring\n"; |
367 | $self->eof; |
539 | } |
|
|
540 | } |
|
|
541 | |
|
|
542 | # used as a default exception thrower |
|
|
543 | sub rcv_throw_exception { |
|
|
544 | my ($self, $attr, $type) = @_; |
|
|
545 | $self->throw (Net::FCP::Exception->new ($type, $attr)); |
|
|
546 | } |
|
|
547 | |
|
|
548 | *rcv_failed = \&Net::FCP::Txn::rcv_throw_exception; |
|
|
549 | *rcv_format_error = \&Net::FCP::Txn::rcv_throw_exception; |
|
|
550 | |
|
|
551 | sub throw { |
|
|
552 | my ($self, $exc) = @_; |
|
|
553 | |
|
|
554 | $self->{exception} = $exc; |
|
|
555 | $self->set_result; |
|
|
556 | $self->eof; # must be last to avoid loops |
|
|
557 | } |
|
|
558 | |
|
|
559 | sub set_result { |
|
|
560 | my ($self, $result) = @_; |
|
|
561 | |
|
|
562 | unless (exists $self->{result}) { |
|
|
563 | $self->{result} = $result; |
|
|
564 | $self->{cb}->($self) if exists $self->{cb}; |
|
|
565 | $self->{signal}->broadcast; |
368 | } |
566 | } |
369 | } |
567 | } |
370 | |
568 | |
371 | sub eof { |
569 | sub eof { |
372 | my ($self, $result) = @_; |
570 | my ($self) = @_; |
373 | |
571 | |
374 | $self->{result} = $result unless exists $self->{result}; |
572 | delete $self->{w}; |
|
|
573 | delete $self->{fh}; |
|
|
574 | |
|
|
575 | delete $self->{fcp}{txn}{$self}; |
|
|
576 | |
|
|
577 | unless (exists $self->{result}) { |
|
|
578 | $self->throw (Net::FCP::Exception->new (short_data => { |
|
|
579 | reason => "unexpected eof or internal node error", |
|
|
580 | })); |
|
|
581 | } |
|
|
582 | } |
|
|
583 | |
|
|
584 | sub progress { |
|
|
585 | my ($self, $type, $attr) = @_; |
|
|
586 | |
|
|
587 | $self->{fcp}->progress ($self, $type, $attr); |
375 | } |
588 | } |
376 | |
589 | |
377 | =item $result = $txn->result |
590 | =item $result = $txn->result |
378 | |
591 | |
379 | Waits until a result is available and then returns it. |
592 | Waits until a result is available and then returns it. |
380 | |
593 | |
381 | This waiting is (depending on your event modul) not very efficient, as it |
594 | This waiting is (depending on your event model) not very efficient, as it |
382 | is done outside the "mainloop". |
595 | is done outside the "mainloop". The biggest problem, however, is that it's |
|
|
596 | blocking one thread of execution. Try to use the callback mechanism, if |
|
|
597 | possible, and call result from within the callback (or after is has been |
|
|
598 | run), as then no waiting is necessary. |
383 | |
599 | |
384 | =cut |
600 | =cut |
385 | |
601 | |
386 | sub result { |
602 | sub result { |
387 | my ($self) = @_; |
603 | my ($self) = @_; |
388 | |
604 | |
389 | $Net::FCP::waitcb->() while !exists $self->{result}; |
605 | $self->{signal}->wait while !exists $self->{result}; |
|
|
606 | |
|
|
607 | die $self->{exception} if $self->{exception}; |
390 | |
608 | |
391 | return $self->{result}; |
609 | return $self->{result}; |
392 | } |
|
|
393 | |
|
|
394 | sub DESTROY { |
|
|
395 | $Net::FCP::unregcb->($_[0]); |
|
|
396 | } |
610 | } |
397 | |
611 | |
398 | package Net::FCP::Txn::ClientHello; |
612 | package Net::FCP::Txn::ClientHello; |
399 | |
613 | |
400 | use base Net::FCP::Txn; |
614 | use base Net::FCP::Txn; |
401 | |
615 | |
402 | sub rcv_node_hello { |
616 | sub rcv_node_hello { |
403 | my ($self, $attr) = @_; |
617 | my ($self, $attr) = @_; |
404 | |
618 | |
405 | $self->eof ($attr); |
619 | $self->set_result ($attr); |
406 | } |
620 | } |
407 | |
621 | |
408 | package Net::FCP::Txn::ClientInfo; |
622 | package Net::FCP::Txn::ClientInfo; |
409 | |
623 | |
410 | use base Net::FCP::Txn; |
624 | use base Net::FCP::Txn; |
411 | |
625 | |
412 | sub rcv_node_info { |
626 | sub rcv_node_info { |
413 | my ($self, $attr) = @_; |
627 | my ($self, $attr) = @_; |
414 | |
628 | |
415 | $self->eof ($attr); |
629 | $self->set_result ($attr); |
416 | } |
630 | } |
417 | |
631 | |
418 | package Net::FCP::Txn::GenerateCHK; |
632 | package Net::FCP::Txn::GenerateCHK; |
419 | |
633 | |
420 | use base Net::FCP::Txn; |
634 | use base Net::FCP::Txn; |
421 | |
635 | |
422 | sub rcv_success { |
636 | sub rcv_success { |
423 | my ($self, $attr) = @_; |
637 | my ($self, $attr) = @_; |
424 | |
638 | |
425 | $self->eof ($attr); |
639 | $self->set_result ($attr->{uri}); |
426 | } |
640 | } |
427 | |
641 | |
428 | package Net::FCP::Txn::GenerateSVKPair; |
642 | package Net::FCP::Txn::GenerateSVKPair; |
429 | |
643 | |
430 | use base Net::FCP::Txn; |
644 | use base Net::FCP::Txn; |
431 | |
645 | |
432 | sub rcv_success { |
646 | sub rcv_success { |
433 | my ($self, $attr) = @_; |
647 | my ($self, $attr) = @_; |
434 | |
648 | $self->set_result ([$attr->{public_key}, $attr->{private_key}, $attr->{crypto_key}]); |
435 | $self->eof ([$attr->{PublicKey}, $attr->{PrivateKey}]); |
|
|
436 | } |
649 | } |
437 | |
650 | |
438 | package Net::FCP::Txn::InvertPrivateKey; |
651 | package Net::FCP::Txn::InvertPrivateKey; |
439 | |
652 | |
440 | use base Net::FCP::Txn; |
653 | use base Net::FCP::Txn; |
441 | |
654 | |
442 | sub rcv_success { |
655 | sub rcv_success { |
443 | my ($self, $attr) = @_; |
656 | my ($self, $attr) = @_; |
444 | |
|
|
445 | $self->eof ($attr->{PublicKey}); |
657 | $self->set_result ($attr->{public_key}); |
446 | } |
658 | } |
447 | |
659 | |
448 | package Net::FCP::Txn::GetSize; |
660 | package Net::FCP::Txn::GetSize; |
449 | |
661 | |
450 | use base Net::FCP::Txn; |
662 | use base Net::FCP::Txn; |
451 | |
663 | |
452 | sub rcv_success { |
664 | sub rcv_success { |
453 | my ($self, $attr) = @_; |
665 | my ($self, $attr) = @_; |
454 | |
|
|
455 | $self->eof ($attr->{Length}); |
666 | $self->set_result (hex $attr->{length}); |
|
|
667 | } |
|
|
668 | |
|
|
669 | package Net::FCP::Txn::GetPut; |
|
|
670 | |
|
|
671 | # base class for get and put |
|
|
672 | |
|
|
673 | use base Net::FCP::Txn; |
|
|
674 | |
|
|
675 | *rcv_uri_error = \&Net::FCP::Txn::rcv_throw_exception; |
|
|
676 | *rcv_route_not_found = \&Net::FCP::Txn::rcv_throw_exception; |
|
|
677 | |
|
|
678 | sub rcv_restarted { |
|
|
679 | my ($self, $attr, $type) = @_; |
|
|
680 | |
|
|
681 | delete $self->{datalength}; |
|
|
682 | delete $self->{metalength}; |
|
|
683 | delete $self->{data}; |
|
|
684 | |
|
|
685 | $self->progress ($type, $attr); |
|
|
686 | } |
|
|
687 | |
|
|
688 | package Net::FCP::Txn::ClientGet; |
|
|
689 | |
|
|
690 | use base Net::FCP::Txn::GetPut; |
|
|
691 | |
|
|
692 | *rcv_data_not_found = \&Net::FCP::Txn::rcv_throw_exception; |
|
|
693 | |
|
|
694 | sub rcv_data { |
|
|
695 | my ($self, $chunk) = @_; |
|
|
696 | |
|
|
697 | $self->{data} .= $chunk; |
|
|
698 | |
|
|
699 | $self->progress ("data", { chunk => length $chunk, received => length $self->{data}, total => $self->{datalength} }); |
|
|
700 | |
|
|
701 | if ($self->{datalength} == length $self->{data}) { |
|
|
702 | my $data = delete $self->{data}; |
|
|
703 | my $meta = new Net::FCP::Metadata (substr $data, 0, $self->{metalength}, ""); |
|
|
704 | |
|
|
705 | $self->set_result ([$meta, $data]); |
|
|
706 | $self->eof; |
|
|
707 | } |
|
|
708 | } |
|
|
709 | |
|
|
710 | sub rcv_data_found { |
|
|
711 | my ($self, $attr, $type) = @_; |
|
|
712 | |
|
|
713 | $self->progress ($type, $attr); |
|
|
714 | |
|
|
715 | $self->{datalength} = hex $attr->{data_length}; |
|
|
716 | $self->{metalength} = hex $attr->{metadata_length}; |
|
|
717 | } |
|
|
718 | |
|
|
719 | package Net::FCP::Txn::ClientPut; |
|
|
720 | |
|
|
721 | use base Net::FCP::Txn::GetPut; |
|
|
722 | |
|
|
723 | *rcv_size_error = \&Net::FCP::Txn::rcv_throw_exception; |
|
|
724 | |
|
|
725 | sub rcv_pending { |
|
|
726 | my ($self, $attr, $type) = @_; |
|
|
727 | $self->progress ($type, $attr); |
|
|
728 | } |
|
|
729 | |
|
|
730 | sub rcv_success { |
|
|
731 | my ($self, $attr, $type) = @_; |
|
|
732 | $self->set_result ($attr); |
|
|
733 | } |
|
|
734 | |
|
|
735 | sub rcv_key_collision { |
|
|
736 | my ($self, $attr, $type) = @_; |
|
|
737 | $self->set_result ({ key_collision => 1, %$attr }); |
456 | } |
738 | } |
457 | |
739 | |
458 | =back |
740 | =back |
459 | |
741 | |
|
|
742 | =head2 The Net::FCP::Exception CLASS |
|
|
743 | |
|
|
744 | Any unexpected (non-standard) responses that make it impossible to return |
|
|
745 | the advertised result will result in an exception being thrown when the |
|
|
746 | C<result> method is called. |
|
|
747 | |
|
|
748 | These exceptions are represented by objects of this class. |
|
|
749 | |
|
|
750 | =over 4 |
|
|
751 | |
|
|
752 | =cut |
|
|
753 | |
|
|
754 | package Net::FCP::Exception; |
|
|
755 | |
|
|
756 | use overload |
|
|
757 | '""' => sub { |
|
|
758 | "Net::FCP::Exception<<$_[0][0]," . (join ":", %{$_[0][1]}) . ">>"; |
|
|
759 | }; |
|
|
760 | |
|
|
761 | =item $exc = new Net::FCP::Exception $type, \%attr |
|
|
762 | |
|
|
763 | Create a new exception object of the given type (a string like |
|
|
764 | C<route_not_found>), and a hashref containing additional attributes |
|
|
765 | (usually the attributes of the message causing the exception). |
|
|
766 | |
|
|
767 | =cut |
|
|
768 | |
|
|
769 | sub new { |
|
|
770 | my ($class, $type, $attr) = @_; |
|
|
771 | |
|
|
772 | bless [Net::FCP::tolc $type, { %$attr }], $class; |
|
|
773 | } |
|
|
774 | |
|
|
775 | =item $exc->type([$type]) |
|
|
776 | |
|
|
777 | With no arguments, returns the exception type. Otherwise a boolean |
|
|
778 | indicating wether the exception is of the given type is returned. |
|
|
779 | |
|
|
780 | =cut |
|
|
781 | |
|
|
782 | sub type { |
|
|
783 | my ($self, $type) = @_; |
|
|
784 | |
|
|
785 | @_ >= 2 |
|
|
786 | ? $self->[0] eq $type |
|
|
787 | : $self->[0]; |
|
|
788 | } |
|
|
789 | |
|
|
790 | =item $exc->attr([$attr]) |
|
|
791 | |
|
|
792 | With no arguments, returns the attributes. Otherwise the named attribute |
|
|
793 | value is returned. |
|
|
794 | |
|
|
795 | =cut |
|
|
796 | |
|
|
797 | sub attr { |
|
|
798 | my ($self, $attr) = @_; |
|
|
799 | |
|
|
800 | @_ >= 2 |
|
|
801 | ? $self->[1]{$attr} |
|
|
802 | : $self->[1]; |
|
|
803 | } |
|
|
804 | |
|
|
805 | =back |
|
|
806 | |
460 | =head1 SEE ALSO |
807 | =head1 SEE ALSO |
461 | |
808 | |
462 | L<http://freenet.sf.net>. |
809 | L<http://freenet.sf.net>. |
463 | |
810 | |
464 | =head1 BUGS |
811 | =head1 BUGS |
465 | |
812 | |
466 | =head1 AUTHOR |
813 | =head1 AUTHOR |
467 | |
814 | |
468 | Marc Lehmann <pcg@goof.com> |
815 | Marc Lehmann <schmorp@schmorp.de> |
469 | http://www.goof.com/pcg/marc/ |
816 | http://home.schmorp.de/ |
470 | |
817 | |
471 | =cut |
818 | =cut |
472 | |
819 | |
473 | 1; |
820 | 1 |
474 | |
821 | |