[ViewVC] Diff of: cvs/Net-FCP/FCP.pm

Comparing Net-FCP/FCP.pm (file contents):
Revision 1.8 by root, Mon Sep 8 01:47:31 2003 UTC vs.
Revision 1.38 by root, Mon Nov 27 13:16:25 2006 UTC

…		…
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.04;	65	$VERSION = '1.0';
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 $meta = Net::FCP::parse_metadata $string
78
79	Parse a metadata string and return it.
80
81	The metadata will be a hashref with key C<version> (containing
82	the mandatory version header entries).
83
84	All other headers are represented by arrayrefs (they can be repeated).
85
86	Since this is confusing, here is a rather verbose example of a parsed
87	manifest:
88
89	(
90	version => { revision => 1 },
91	document => [
92	{
93	"info.format" => "image/jpeg",
94	name => "background.jpg",
95	"redirect.target" => "freenet:CHK\@ZcagI,ra726bSw"
96	},
97	{
98	"info.format" => "text/html",
99	name => ".next",
100	"redirect.target" => "freenet:SSK\@ilUPAgM/TFEE/3"
101	},
102	{
103	"info.format" => "text/html",
104	"redirect.target" => "freenet:CHK\@8M8Po8ucwI,8xA"
105	}
106	]
107	)
108
109	=cut
110
111	sub parse_metadata {
112	my $meta;
113
114	my $data = shift;
115	if ($data =~ /^Version\015?\012/gc) {
116	my $hdr = $meta->{version} = {};
117
118	for (;;) {
119	while ($data =~ /\G([^=\015\012]+)=([^\015\012]*)\015?\012/gc) {
120	my ($k, $v) = ($1, $2);
121	$hdr->{tolc $k} = $v;
122	}
123
124	if ($data =~ /\GEndPart\015?\012/gc) {
125	} elsif ($data =~ /\GEnd\015?\012/gc) {
126	last;
127	} elsif ($data =~ /\G([A-Za-z0-9.\-]+)\015?\012/gcs) {
128	push @{$meta->{tolc $1}}, $hdr = {};
129	} elsif ($data =~ /\G(.*)/gcs) {
130	die "metadata format error ($1)";
131	}
132	}
133	}
134
135	#$meta->{tail} = substr $data, pos $data;
136
137	$meta;
138	}
139
140	=item $fcp = new Net::FCP [host => $host][, port => $port]	74	=item $fcp = new Net::FCP [host => $host][, port => $port][, progress => \&cb]
141		75
142	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
143	127.0.0.1:8481, or the environment variables C<FREDHOST> and C<FREDPORT>).	77	127.0.0.1:8481, or the environment variables C<FREDHOST> and C<FREDPORT>).
144		78
145	Connections are virtual because no persistent physical connection is	79	Connections are virtual because no persistent physical connection is
146	established. However, the existance of the node is checked by executing a	80	established.
147	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	}
148		91
149	=cut	92	=cut
150		93
151	sub new {	94	sub new {
152	my $class = shift;	95	my $class = shift;
153	my $self = bless { @_ }, $class;	96	my $self = bless { @_ }, $class;
154		97
155	$self->{host} \|\|= $ENV{FREDHOST} \|\| "127.0.0.1";	98	$self->{host} \|\|= $ENV{FREDHOST} \|\| "127.0.0.1";
156	$self->{port} \|\|= $ENV{FREDPORt} \|\| 8481;	99	$self->{port} \|\|= $ENV{FREDPORT} \|\| 8481;
157
158	$self->{nodehello} = $self->client_hello
159	or croak "unable to get nodehello from node\n";
160		100
161	$self;	101	$self;
162	}	102	}
163		103
		104	sub progress {
		105	my ($self, $txn, $type, $attr) = @_;
		106
		107	$self->{progress}->($self, $txn, $type, $attr)
		108	if $self->{progress};
		109	}
		110
164	=item $txn = $fcp->txn(type => attr => val,...)	111	=item $txn = $fcp->txn (type => attr => val,...)
165		112
166	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	);
167		135
168	=cut	136	=cut
169		137
170	sub txn {	138	sub txn {
171	my ($self, $type, %attr) = @_;	139	my ($self, $type, %attr) = @_;
172		140
173	$type = touc $type;	141	$type = touc $type;
174		142
175	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);
176		144
177	$txn;	145	$txn;
178	}	146	}
179		147
180	sub _txn($&) {	148	{ # transactions
		149
		150	my $txn = sub {
181	my ($name, $sub) = @_;	151	my ($name, $sub) = @_;
182	*{"$name\_txn"} = $sub;	152	*{"txn_$name"} = $sub;
183	*{$name} = sub { $sub->(@_)->result };	153	*{$name} = sub { $sub->(@_)->result };
184	}	154	};
185		155
186	=item $txn = $fcp->txn_client_hello	156	=item $txn = $fcp->txn_client_hello
187		157
188	=item $nodehello = $fcp->client_hello	158	=item $nodehello = $fcp->client_hello
189		159
…		…
195	protocol => "1.2",	165	protocol => "1.2",
196	}	166	}
197		167
198	=cut	168	=cut
199		169
200	_txn client_hello => sub {	170	$txn->(client_hello => sub {
201	my ($self) = @_;	171	my ($self) = @_;
202		172
203	$self->txn ("client_hello");	173	$self->txn ("client_hello");
204	};	174	});
205		175
206	=item $txn = $fcp->txn_client_info	176	=item $txn = $fcp->txn_client_info
207		177
208	=item $nodeinfo = $fcp->client_info	178	=item $nodeinfo = $fcp->client_info
209		179
…		…
233	routing_time => "a5",	203	routing_time => "a5",
234	}	204	}
235		205
236	=cut	206	=cut
237		207
238	_txn client_info => sub {	208	$txn->(client_info => sub {
239	my ($self) = @_;	209	my ($self) = @_;
240		210
241	$self->txn ("client_info");	211	$self->txn ("client_info");
242	};	212	});
243		213
244	=item $txn = $fcp->txn_generate_chk ($metadata, $data)	214	=item $txn = $fcp->txn_generate_chk ($metadata, $data[, $cipher])
245		215
246	=item $uri = $fcp->generate_chk ($metadata, $data)	216	=item $uri = $fcp->generate_chk ($metadata, $data[, $cipher])
247		217
248	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.
249		220
250	=cut	221	=cut
251		222
252	_txn generate_chk => sub {	223	$txn->(generate_chk => sub {
253	my ($self, $metadata, $data) = @_;	224	my ($self, $metadata, $data, $cipher) = @_;
254		225
255	$self->txn (generate_chk => data => "$data$metadata", metadata_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");
256	};	232	});
257		233
258	=item $txn = $fcp->txn_generate_svk_pair	234	=item $txn = $fcp->txn_generate_svk_pair
259		235
260	=item ($public, $private) = @{ $fcp->generate_svk_pair }	236	=item ($public, $private, $crypto) = @{ $fcp->generate_svk_pair }
261		237
262	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.
263		240
264	[	241	[
265	"hKs0-WDQA4pVZyMPKNFsK1zapWY",	242	"acLx4dux9fvvABH15Gk6~d3I-yw",
266	"ZnmvMITaTXBMFGl4~jrjuyWxOWg"	243	"cPoDkDMXDGSMM32plaPZDhJDxSs",
		244	"BH7LXCov0w51-y9i~BoB3g",
267	]	245	]
268		246
269	=cut	247	A private key (for inserting) can be constructed like this:
270		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
271	_txn generate_svk_pair => sub {	259	$txn->(generate_svk_pair => sub {
272	my ($self) = @_;	260	my ($self) = @_;
273		261
274	$self->txn ("generate_svk_pair");	262	$self->txn ("generate_svk_pair");
275	};	263	});
276		264
277	=item $txn = $fcp->txn_insert_private_key ($private)	265	=item $txn = $fcp->txn_invert_private_key ($private)
278		266
279	=item $uri = $fcp->insert_private_key ($private)	267	=item $public = $fcp->invert_private_key ($private)
280		268
281	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
282	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.
283	from C<generate_svk_pair>).	271	the private value you get back from C<generate_svk_pair>).
284		272
285	Returns the public key.	273	Returns the public key.
286		274
287	UNTESTED.
288
289	=cut	275	=cut
290		276
291	_txn insert_private_key => sub {	277	$txn->(invert_private_key => sub {
292	my ($self, $privkey) = @_;	278	my ($self, $privkey) = @_;
293		279
294	$self->txn (invert_private_key => private => $privkey);	280	$self->txn (invert_private_key => private => $privkey);
295	};	281	});
296		282
297	=item $txn = $fcp->txn_get_size ($uri)	283	=item $txn = $fcp->txn_get_size ($uri)
298		284
299	=item $length = $fcp->get_size ($uri)	285	=item $length = $fcp->get_size ($uri)
300		286
301	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
302	given document.	288	given document.
303		289
304	UNTESTED.
305
306	=cut	290	=cut
307		291
308	_txn get_size => sub {	292	$txn->(get_size => sub {
309	my ($self, $uri) = @_;	293	my ($self, $uri) = @_;
310		294
311	$self->txn (get_size => URI => $uri);	295	$self->txn (get_size => URI => $uri);
312	};	296	});
313		297
314	=item $txn = $fcp->txn_client_get ($uri [, $htl = 15 [, $removelocal = 0]])	298	=item $txn = $fcp->txn_client_get ($uri [, $htl = 15 [, $removelocal = 0]])
315		299
316	=item ($metadata, $data) = @{ $fcp->client_get ($uri, $htl, $removelocal)	300	=item ($metadata, $data) = @{ $fcp->client_get ($uri, $htl, $removelocal)
317		301
318	Fetches a (small, as it should fit into memory) file from	302	Fetches a (small, as it should fit into memory) key content block from
319	freenet. C<$meta> is the metadata (as returned by C<parse_metadata> or	303	freenet. C<$meta> is a C<Net::FCP::Metadata> object or C<undef>).
320	C<undef>).
321		304
322	Due to the overhead, a better method to download big files should be used.	305	The C<$uri> should begin with C<freenet:>, but the scheme is currently
		306	added, if missing.
323		307
324	my ($meta, $data) = @{	308	my ($meta, $data) = @{
325	$fcp->client_get (	309	$fcp->client_get (
326	"freenet:CHK@hdXaxkwZ9rA8-SidT0AN-bniQlgPAwI,XdCDmBuGsd-ulqbLnZ8v~w"	310	"freenet:CHK@hdXaxkwZ9rA8-SidT0AN-bniQlgPAwI,XdCDmBuGsd-ulqbLnZ8v~w"
327	)	311	)
328	};	312	};
329		313
330	=cut	314	=cut
331		315
332	_txn client_get => sub {	316	$txn->(client_get => sub {
333	my ($self, $uri, $htl, $removelocal) = @_;	317	my ($self, $uri, $htl, $removelocal) = @_;
334		318
335	$self->txn (client_get => URI => $uri, hops_to_live => ($htl \|\| 15), remove_local => $removelocal*1);	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");
336	};	323	});
337		324
338	=item MISSING: ClientPut	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
339		354
340	=back	355	=back
341		356
342	=head2 THE Net::FCP::Txn CLASS	357	=head2 THE Net::FCP::Txn CLASS
343		358
344	All requests (or transactions) are executed in a asynchroneous way (LIE:	359	All requests (or transactions) are executed in a asynchronous way. For
345	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
346	created (worse: a tcp connection is created, too).	361	connection is created, too).
347		362
348	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
349	to subclass these, although of course not documented).	364	to subclass these, although of course not documented).
350		365
351	The most interesting method is C<result>.	366	The most interesting method is C<result>.
…		…
353	=over 4	368	=over 4
354		369
355	=cut	370	=cut
356		371
357	package Net::FCP::Txn;	372	package Net::FCP::Txn;
		373
		374	use Fcntl;
		375	use Socket;
358		376
359	=item new arg => val,...	377	=item new arg => val,...
360		378
361	Creates a new C<Net::FCP::Txn> object. Not normally used.	379	Creates a new C<Net::FCP::Txn> object. Not normally used.
362		380
…		…
364		382
365	sub new {	383	sub new {
366	my $class = shift;	384	my $class = shift;
367	my $self = bless { @_ }, $class;	385	my $self = bless { @_ }, $class;
368		386
		387	$self->{signal} = AnyEvent->condvar;
		388
		389	$self->{fcp}{txn}{$self} = $self;
		390
369	my $attr = "";	391	my $attr = "";
370	my $data = delete $self->{attr}{data};	392	my $data = delete $self->{attr}{data};
371		393
372	while (my ($k, $v) = each %{$self->{attr}}) {	394	while (my ($k, $v) = each %{$self->{attr}}) {
373	$attr .= (Net::FCP::touc $k) . "=$v\012"	395	$attr .= (Net::FCP::touc $k) . "=$v\012"
374	}	396	}
375		397
376	if (defined $data) {	398	if (defined $data) {
377	$attr .= "DataLength=" . (length $data) . "\012";	399	$attr .= sprintf "DataLength=%x\012", length $data;
378	$data = "Data\012$data";	400	$data = "Data\012$data";
379	} else {	401	} else {
380	$data = "EndMessage\012";	402	$data = "EndMessage\012";
381	}	403	}
382		404
383	my $fh = new IO::Socket::INET	405	socket my $fh, PF_INET, SOCK_STREAM, 0
384	PeerHost => $self->{fcp}{host},	406	or Carp::croak "unable to create new tcp socket: $!";
385	PeerPort => $self->{fcp}{port}
386	or Carp::croak "FCP::txn: unable to connect to $self->{fcp}{host}:$self->{fcp}{port}: $!\n";
387
388	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 !$!{EWOULDBLOCK}
		411	and !$!{EINPROGRESS}
		412	and Carp::croak "FCP::txn: unable to connect to $self->{fcp}{host}:$self->{fcp}{port}: $!\n";
389		413
390	if (0) {	414	$self->{sbuf} =
391	print	415	"\x00\x00\x00\x02"
392	Net::FCP::touc $self->{type}, "\012",
393	$attr,
394	$data, "\012";
395	}
396
397	print $fh
398	"\x00\x00", "\x00\x02", # SESSID, PRESID
399	Net::FCP::touc $self->{type}, "\012",	416	. (Net::FCP::touc $self->{type})
400	$attr,	417	. "\012$attr$data";
401	$data;
402		418
403	#$fh->shutdown (1); # freenet buggy?, well, it's java...	419	#shutdown $fh, 1; # freenet buggy?, well, it's java...
404		420
405	$self->{fh} = $fh;	421	$self->{fh} = $fh;
406		422
407	$Net::FCP::regcb->($self);	423	$self->{w} = AnyEvent->io (fh => $fh, poll => 'w', cb => sub { $self->fh_ready_w });
408		424
409	$self;	425	$self;
410	}	426	}
411		427
		428	=item $txn = $txn->cb ($coderef)
		429
		430	Sets a callback to be called when the request is finished. The coderef
		431	will be called with the txn as it's sole argument, so it has to call
		432	C<result> itself.
		433
		434	Returns the txn object, useful for chaining.
		435
		436	Example:
		437
		438	$fcp->txn_client_get ("freenet:CHK....")
		439	->userdata ("ehrm")
		440	->cb(sub {
		441	my $data = shift->result;
		442	});
		443
		444	=cut
		445
		446	sub cb($$) {
		447	my ($self, $cb) = @_;
		448	$self->{cb} = $cb;
		449	$self;
		450	}
		451
		452	=item $txn = $txn->userdata ([$userdata])
		453
		454	Set user-specific data. This is useful in progress callbacks. The data can be accessed
		455	using C<< $txn->{userdata} >>.
		456
		457	Returns the txn object, useful for chaining.
		458
		459	=cut
		460
		461	sub userdata($$) {
		462	my ($self, $data) = @_;
		463	$self->{userdata} = $data;
		464	$self;
		465	}
		466
		467	=item $txn->cancel (%attr)
		468
		469	Cancels the operation with a C<cancel> exception and the given attributes
		470	(consider at least giving the attribute C<reason>).
		471
		472	UNTESTED.
		473
		474	=cut
		475
		476	sub cancel {
		477	my ($self, %attr) = @_;
		478	$self->throw (Net::FCP::Exception->new (cancel => { %attr }));
		479	$self->set_result;
		480	$self->eof;
		481	}
		482
412	sub fh_ready {	483	sub fh_ready_w {
413	my ($self) = @_;	484	my ($self) = @_;
414		485
		486	my $len = syswrite $self->{fh}, $self->{sbuf};
		487
		488	if ($len > 0) {
		489	substr $self->{sbuf}, 0, $len, "";
		490	unless (length $self->{sbuf}) {
		491	fcntl $self->{fh}, F_SETFL, 0;
		492	$self->{w} = AnyEvent->io (fh => $self->{fh}, poll => 'r', cb => sub { $self->fh_ready_r });
		493	}
		494	} elsif (defined $len) {
		495	$self->throw (Net::FCP::Exception->new (network_error => { reason => "unexpected end of file while writing" }));
		496	} else {
		497	$self->throw (Net::FCP::Exception->new (network_error => { reason => "$!" }));
		498	}
		499	}
		500
		501	sub fh_ready_r {
		502	my ($self) = @_;
		503
415	if (sysread $self->{fh}, $self->{buf}, 65536, length $self->{buf}) {	504	if (sysread $self->{fh}, $self->{buf}, 16384 + 1024, length $self->{buf}) {
416	for (;;) {	505	for (;;) {
417	if ($self->{datalen}) {	506	if ($self->{datalen}) {
		507	#warn "expecting new datachunk $self->{datalen}, got ".(length $self->{buf})."\n";#d#
418	if (length $self->{buf} >= $self->{datalen}) {	508	if (length $self->{buf} >= $self->{datalen}) {
419	$self->rcv_data (substr $self->{buf}, 0, $self->{datalen}, "");	509	$self->rcv_data (substr $self->{buf}, 0, delete $self->{datalen}, "");
420	} else {	510	} else {
421	last;	511	last;
422	}	512	}
423	} elsif ($self->{buf} =~ s/^DataChunk\015?\012Length=([0-9a-fA-F]+)\015?\012Data\015?\012//) {	513	} elsif ($self->{buf} =~ s/^DataChunk\015?\012Length=([0-9a-fA-F]+)\015?\012Data\015?\012//) {
424	$self->{datalen} = hex $1;	514	$self->{datalen} = hex $1;
		515	#warn "expecting new datachunk $self->{datalen}\n";#d#
425	} elsif ($self->{buf} =~ s/^([a-zA-Z]+)\015?\012(?:(.+?)\015?\012)?EndMessage\015?\012//s) {	516	} elsif ($self->{buf} =~ s/^([a-zA-Z]+)\015?\012(?:(.+?)\015?\012)?EndMessage\015?\012//s) {
426	$self->rcv ($1, {	517	$self->rcv ($1, {
427	map { my ($a, $b) = split /=/, $_, 2; ((Net::FCP::tolc $a), $b) }	518	map { my ($a, $b) = split /=/, $_, 2; ((Net::FCP::tolc $a), $b) }
428	split /\015?\012/, $2	519	split /\015?\012/, $2
429	});	520	});
430	} else {	521	} else {
431	last;	522	last;
432	}	523	}
433	}	524	}
434	} else {	525	} else {
435	$Net::FCP::unregcb->($self);
436	delete $self->{fh};
437	$self->eof;	526	$self->eof;
438	}	527	}
439	}
440
441	sub rcv_data {
442	my ($self, $chunk) = @_;
443
444	$self->{data} .= $chunk;
445	}	528	}
446		529
447	sub rcv {	530	sub rcv {
448	my ($self, $type, $attr) = @_;	531	my ($self, $type, $attr) = @_;
449		532
…		…
456	} else {	539	} else {
457	warn "received unexpected reply type '$type' for '$self->{type}', ignoring\n";	540	warn "received unexpected reply type '$type' for '$self->{type}', ignoring\n";
458	}	541	}
459	}	542	}
460		543
		544	# used as a default exception thrower
		545	sub rcv_throw_exception {
		546	my ($self, $attr, $type) = @_;
		547	$self->throw (Net::FCP::Exception->new ($type, $attr));
		548	}
		549
		550	*rcv_failed = \&Net::FCP::Txn::rcv_throw_exception;
		551	*rcv_format_error = \&Net::FCP::Txn::rcv_throw_exception;
		552
		553	sub throw {
		554	my ($self, $exc) = @_;
		555
		556	$self->{exception} = $exc;
		557	$self->set_result;
		558	$self->eof; # must be last to avoid loops
		559	}
		560
461	sub set_result {	561	sub set_result {
462	my ($self, $result) = @_;	562	my ($self, $result) = @_;
463		563
464	$self->{result} = $result unless exists $self->{result};	564	unless (exists $self->{result}) {
		565	$self->{result} = $result;
		566	$self->{cb}->($self) if exists $self->{cb};
		567	$self->{signal}->broadcast;
		568	}
465	}	569	}
466		570
467	sub eof {	571	sub eof {
468	my ($self) = @_;	572	my ($self) = @_;
469	$self->set_result;	573
		574	delete $self->{w};
		575	delete $self->{fh};
		576
		577	delete $self->{fcp}{txn}{$self};
		578
		579	unless (exists $self->{result}) {
		580	$self->throw (Net::FCP::Exception->new (short_data => {
		581	reason => "unexpected eof or internal node error",
		582	}));
		583	}
		584	}
		585
		586	sub progress {
		587	my ($self, $type, $attr) = @_;
		588
		589	$self->{fcp}->progress ($self, $type, $attr);
470	}	590	}
471		591
472	=item $result = $txn->result	592	=item $result = $txn->result
473		593
474	Waits until a result is available and then returns it.	594	Waits until a result is available and then returns it.
475		595
476	This waiting is (depending on your event model) not very efficient, as it	596	This waiting is (depending on your event model) not very efficient, as it
477	is done outside the "mainloop".	597	is done outside the "mainloop". The biggest problem, however, is that it's
		598	blocking one thread of execution. Try to use the callback mechanism, if
		599	possible, and call result from within the callback (or after is has been
		600	run), as then no waiting is necessary.
478		601
479	=cut	602	=cut
480		603
481	sub result {	604	sub result {
482	my ($self) = @_;	605	my ($self) = @_;
483		606
484	$Net::FCP::waitcb->() while !exists $self->{result};	607	$self->{signal}->wait while !exists $self->{result};
		608
		609	die $self->{exception} if $self->{exception};
485		610
486	return $self->{result};	611	return $self->{result};
487	}
488
489	sub DESTROY {
490	$Net::FCP::unregcb->($_[0]);
491	}	612	}
492		613
493	package Net::FCP::Txn::ClientHello;	614	package Net::FCP::Txn::ClientHello;
494		615
495	use base Net::FCP::Txn;	616	use base Net::FCP::Txn;
…		…
515	use base Net::FCP::Txn;	636	use base Net::FCP::Txn;
516		637
517	sub rcv_success {	638	sub rcv_success {
518	my ($self, $attr) = @_;	639	my ($self, $attr) = @_;
519		640
520	$self->set_result ($attr);	641	$self->set_result ($attr->{uri});
521	}	642	}
522		643
523	package Net::FCP::Txn::GenerateSVKPair;	644	package Net::FCP::Txn::GenerateSVKPair;
524		645
525	use base Net::FCP::Txn;	646	use base Net::FCP::Txn;
526		647
527	sub rcv_success {	648	sub rcv_success {
528	my ($self, $attr) = @_;	649	my ($self, $attr) = @_;
529
530	$self->set_result ([$attr->{PublicKey}, $attr->{PrivateKey}]);	650	$self->set_result ([$attr->{public_key}, $attr->{private_key}, $attr->{crypto_key}]);
531	}	651	}
532		652
533	package Net::FCP::Txn::InvertPrivateKey;	653	package Net::FCP::Txn::InvertPrivateKey;
534		654
535	use base Net::FCP::Txn;	655	use base Net::FCP::Txn;
536		656
537	sub rcv_success {	657	sub rcv_success {
538	my ($self, $attr) = @_;	658	my ($self, $attr) = @_;
539
540	$self->set_result ($attr->{PublicKey});	659	$self->set_result ($attr->{public_key});
541	}	660	}
542		661
543	package Net::FCP::Txn::GetSize;	662	package Net::FCP::Txn::GetSize;
544		663
545	use base Net::FCP::Txn;	664	use base Net::FCP::Txn;
546		665
547	sub rcv_success {	666	sub rcv_success {
548	my ($self, $attr) = @_;	667	my ($self, $attr) = @_;
549
550	$self->set_result ($attr->{Length});	668	$self->set_result (hex $attr->{length});
		669	}
		670
		671	package Net::FCP::Txn::GetPut;
		672
		673	# base class for get and put
		674
		675	use base Net::FCP::Txn;
		676
		677	*rcv_uri_error = \&Net::FCP::Txn::rcv_throw_exception;
		678	*rcv_route_not_found = \&Net::FCP::Txn::rcv_throw_exception;
		679
		680	sub rcv_restarted {
		681	my ($self, $attr, $type) = @_;
		682
		683	delete $self->{datalength};
		684	delete $self->{metalength};
		685	delete $self->{data};
		686
		687	$self->progress ($type, $attr);
551	}	688	}
552		689
553	package Net::FCP::Txn::ClientGet;	690	package Net::FCP::Txn::ClientGet;
554		691
555	use base Net::FCP::Txn;	692	use base Net::FCP::Txn::GetPut;
		693
		694	*rcv_data_not_found = \&Net::FCP::Txn::rcv_throw_exception;
		695
		696	sub rcv_data {
		697	my ($self, $chunk) = @_;
		698
		699	$self->{data} .= $chunk;
		700
		701	$self->progress ("data", { chunk => length $chunk, received => length $self->{data}, total => $self->{datalength} });
		702
		703	if ($self->{datalength} == length $self->{data}) {
		704	my $data = delete $self->{data};
		705	my $meta = new Net::FCP::Metadata (substr $data, 0, $self->{metalength}, "");
		706
		707	$self->set_result ([$meta, $data]);
		708	$self->eof;
		709	}
		710	}
556		711
557	sub rcv_data_found {	712	sub rcv_data_found {
558	my ($self, $attr) = @_;	713	my ($self, $attr, $type) = @_;
		714
		715	$self->progress ($type, $attr);
559		716
560	$self->{datalength} = hex $attr->{data_length};	717	$self->{datalength} = hex $attr->{data_length};
561	$self->{metalength} = hex $attr->{metadata_length};	718	$self->{metalength} = hex $attr->{metadata_length};
562	}	719	}
563		720
564	sub rcv_restarted {	721	package Net::FCP::Txn::ClientPut;
565	# nop, maybe feedback
566	}
567		722
568	sub eof {	723	use base Net::FCP::Txn::GetPut;
569	my ($self) = @_;
570		724
571	my $data = delete $self->{data};	725	*rcv_size_error = \&Net::FCP::Txn::rcv_throw_exception;
572	my $meta = Net::FCP::parse_metadata substr $data, 0, $self->{metalength}, "";
573		726
		727	sub rcv_pending {
		728	my ($self, $attr, $type) = @_;
		729	$self->progress ($type, $attr);
		730	}
		731
		732	sub rcv_success {
		733	my ($self, $attr, $type) = @_;
574	$self->set_result ([$meta, $data]);	734	$self->set_result ($attr);
		735	}
		736
		737	sub rcv_key_collision {
		738	my ($self, $attr, $type) = @_;
		739	$self->set_result ({ key_collision => 1, %$attr });
575	}	740	}
576		741
577	=back	742	=back
578		743
		744	=head2 The Net::FCP::Exception CLASS
		745
		746	Any unexpected (non-standard) responses that make it impossible to return
		747	the advertised result will result in an exception being thrown when the
		748	C<result> method is called.
		749
		750	These exceptions are represented by objects of this class.
		751
		752	=over 4
		753
		754	=cut
		755
		756	package Net::FCP::Exception;
		757
		758	use overload
		759	'""' => sub {
		760	"Net::FCP::Exception<<$_[0][0]," . (join ":", %{$_[0][1]}) . ">>";
		761	};
		762
		763	=item $exc = new Net::FCP::Exception $type, \%attr
		764
		765	Create a new exception object of the given type (a string like
		766	C<route_not_found>), and a hashref containing additional attributes
		767	(usually the attributes of the message causing the exception).
		768
		769	=cut
		770
		771	sub new {
		772	my ($class, $type, $attr) = @_;
		773
		774	bless [Net::FCP::tolc $type, { %$attr }], $class;
		775	}
		776
		777	=item $exc->type([$type])
		778
		779	With no arguments, returns the exception type. Otherwise a boolean
		780	indicating wether the exception is of the given type is returned.
		781
		782	=cut
		783
		784	sub type {
		785	my ($self, $type) = @_;
		786
		787	@_ >= 2
		788	? $self->[0] eq $type
		789	: $self->[0];
		790	}
		791
		792	=item $exc->attr([$attr])
		793
		794	With no arguments, returns the attributes. Otherwise the named attribute
		795	value is returned.
		796
		797	=cut
		798
		799	sub attr {
		800	my ($self, $attr) = @_;
		801
		802	@_ >= 2
		803	? $self->[1]{$attr}
		804	: $self->[1];
		805	}
		806
		807	=back
		808
579	=head1 SEE ALSO	809	=head1 SEE ALSO
580		810
581	L<http://freenet.sf.net>.	811	L<http://freenet.sf.net>.
582		812
583	=head1 BUGS	813	=head1 BUGS
584		814
585	=head1 AUTHOR	815	=head1 AUTHOR
586		816
587	Marc Lehmann <pcg@goof.com>	817	Marc Lehmann <schmorp@schmorp.de>
588	http://www.goof.com/pcg/marc/	818	http://home.schmorp.de/
589		819
590	=cut	820	=cut
591		821
592	1;	822	1
593		823

Diff Legend

-–
+Removed lines
-+
+Added lines
-<
+Changed lines
->
+Changed lines

Comparing Net-FCP/FCP.pm (file contents): Revision 1.8 by root, Mon Sep 8 01:47:31 2003 UTC vs. Revision 1.38 by root, Mon Nov 27 13:16:25 2006 UTC

Diff Legend

Comparing Net-FCP/FCP.pm (file contents):
Revision 1.8 by root, Mon Sep 8 01:47:31 2003 UTC vs.
Revision 1.38 by root, Mon Nov 27 13:16:25 2006 UTC