--- cvsroot/Net-FCP/FCP.pm 2003/09/15 00:05:32 1.20 +++ cvsroot/Net-FCP/FCP.pm 2005/01/12 20:37:33 1.34 @@ -74,10 +74,13 @@ use Carp; -$VERSION = 0.08; +$VERSION = 0.7; no warnings; +use Net::FCP::Metadata; +use Net::FCP::Util qw(tolc touc xeh); + our $EVENT = Net::FCP::Event::Auto::; sub import { @@ -92,90 +95,7 @@ die $@ if $@; } -sub touc($) { - local $_ = shift; - 1 while s/((?:^|_)(?:svk|chk|uri)(?:_|$))/\U$1/; - s/(?:^|_)(.)/\U$1/g; - $_; -} - -sub tolc($) { - local $_ = shift; - s/(?<=[a-z])(?=[A-Z])/_/g; - lc $_; -} - -=item $meta = Net::FCP::parse_metadata $string - -Parse a metadata string and return it. - -The metadata will be a hashref with key C (containing -the mandatory version header entries). - -All other headers are represented by arrayrefs (they can be repeated). - -Since this is confusing, here is a rather verbose example of a parsed -manifest: - - ( - version => { revision => 1 }, - document => [ - { - info => { format" => "image/jpeg" }, - name => "background.jpg", - redirect => { target => "freenet:CHK\@ZcagI,ra726bSw" }, - }, - { - info => { format" => "text/html" }, - name => ".next", - redirect => { target => "freenet:SSK\@ilUPAgM/TFEE/3" }, - }, - { - info => { format" => "text/html" }, - redirect => { target => "freenet:CHK\@8M8Po8ucwI,8xA" }, - } - ] - ) - -=cut - -sub parse_metadata { - my $meta; - - my $data = shift; - if ($data =~ /^Version\015?\012/gc) { - my $hdr = $meta->{version} = {}; - - for (;;) { - while ($data =~ /\G([^=\015\012]+)=([^\015\012]*)\015?\012/gc) { - my ($k, $v) = ($1, $2); - my @p = split /\./, tolc $k, 3; - - $hdr->{$p[0]} = $v if @p == 1; # lamest code I ever wrote - $hdr->{$p[0]}{$p[1]} = $v if @p == 2; - $hdr->{$p[0]}{$p[1]}{$p[2]} = $v if @p == 3; - die "FATAL: 4+ dot metadata" if @p >= 4; - } - - if ($data =~ /\GEndPart\015?\012/gc) { - # nop - } elsif ($data =~ /\GEnd(\015?\012|$)/gc) { - last; - } elsif ($data =~ /\G([A-Za-z0-9.\-]+)\015?\012/gcs) { - push @{$meta->{tolc $1}}, $hdr = {}; - } elsif ($data =~ /\G(.*)/gcs) { - print STDERR "metadata format error ($1), please report this string: <<$data>>"; - die "metadata format error"; - } - } - } - - #$meta->{tail} = substr $data, pos $data; - - $meta; -} - -=item $fcp = new Net::FCP [host => $host][, port => $port] +=item $fcp = new Net::FCP [host => $host][, port => $port][, progress => \&cb] Create a new virtual FCP connection to the given host and port (default 127.0.0.1:8481, or the environment variables C and C). @@ -183,12 +103,15 @@ Connections are virtual because no persistent physical connection is established. -=begin comment +You can install a progress callback that is being called with the Net::FCP +object, a txn object, the type of the transaction and the attributes. Use +it like this: -However, the existance of the node is checked by executing a -C transaction. + sub progress_cb { + my ($self, $txn, $type, $attr) = @_; -=end + warn "progress<$txn,$type," . (join ":", %$attr) . ">\n"; + } =cut @@ -199,22 +122,20 @@ $self->{host} ||= $ENV{FREDHOST} || "127.0.0.1"; $self->{port} ||= $ENV{FREDPORT} || 8481; - #$self->{nodehello} = $self->client_hello - # or croak "unable to get nodehello from node\n"; - $self; } sub progress { my ($self, $txn, $type, $attr) = @_; - #warn "progress<$txn,$type," . (join ":", %$attr) . ">\n"; -} -=item $txn = $fcp->txn(type => attr => val,...) + $self->{progress}->($self, $txn, $type, $attr) + if $self->{progress}; +} -The low-level interface to transactions. Don't use it. +=item $txn = $fcp->txn (type => attr => val,...) -Here are some examples of using transactions: +The low-level interface to transactions. Don't use it unless you have +"special needs". Instead, use predefiend transactions like this: The blocking case, no (visible) transactions involved: @@ -243,7 +164,7 @@ $type = touc $type; - my $txn = "Net::FCP::Txn::$type"->new(fcp => $self, type => tolc $type, attr => \%attr); + my $txn = "Net::FCP::Txn::$type"->new (fcp => $self, type => tolc $type, attr => \%attr); $txn; } @@ -314,31 +235,49 @@ $self->txn ("client_info"); }); -=item $txn = $fcp->txn_generate_chk ($metadata, $data) +=item $txn = $fcp->txn_generate_chk ($metadata, $data[, $cipher]) -=item $uri = $fcp->generate_chk ($metadata, $data) +=item $uri = $fcp->generate_chk ($metadata, $data[, $cipher]) -Creates a new CHK, given the metadata and data. UNTESTED. +Calculates a CHK, given the metadata and data. C<$cipher> is either +C or C, with the latter being the default. =cut $txn->(generate_chk => sub { - my ($self, $metadata, $data) = @_; + my ($self, $metadata, $data, $cipher) = @_; - $self->txn (generate_chk => data => "$metadata$data", metadata_length => length $metadata); + $metadata = Net::FCP::Metadata::build_metadata $metadata; + + $self->txn (generate_chk => + data => "$metadata$data", + metadata_length => xeh length $metadata, + cipher => $cipher || "Twofish"); }); =item $txn = $fcp->txn_generate_svk_pair -=item ($public, $private) = @{ $fcp->generate_svk_pair } +=item ($public, $private, $crypto) = @{ $fcp->generate_svk_pair } -Creates a new SVK pair. Returns an arrayref. +Creates a new SVK pair. Returns an arrayref with the public key, the +private key and a crypto key, which is just additional entropy. [ - "hKs0-WDQA4pVZyMPKNFsK1zapWY", - "ZnmvMITaTXBMFGl4~jrjuyWxOWg" + "acLx4dux9fvvABH15Gk6~d3I-yw", + "cPoDkDMXDGSMM32plaPZDhJDxSs", + "BH7LXCov0w51-y9i~BoB3g", ] +A private key (for inserting) can be constructed like this: + + SSK@,/ + +It can be used to insert data. The corresponding public key looks like this: + + SSK@PAgM,/ + +Watch out for the C-part! + =cut $txn->(generate_svk_pair => sub { @@ -347,21 +286,19 @@ $self->txn ("generate_svk_pair"); }); -=item $txn = $fcp->txn_insert_private_key ($private) +=item $txn = $fcp->txn_invert_private_key ($private) -=item $public = $fcp->insert_private_key ($private) +=item $public = $fcp->invert_private_key ($private) -Inserts a private key. $private can be either an insert URI (must start -with C) or a raw private key (i.e. the private value you get -back from C). +Inverts a private key (returns the public key). C<$private> can be either +an insert URI (must start with C) or a raw private key (i.e. +the private value you get back from C). Returns the public key. -UNTESTED. - =cut -$txn->(insert_private_key => sub { +$txn->(invert_private_key => sub { my ($self, $privkey) = @_; $self->txn (invert_private_key => private => $privkey); @@ -374,8 +311,6 @@ Finds and returns the size (rounded up to the nearest power of two) of the given document. -UNTESTED. - =cut $txn->(get_size => sub { @@ -388,11 +323,11 @@ =item ($metadata, $data) = @{ $fcp->client_get ($uri, $htl, $removelocal) -Fetches a (small, as it should fit into memory) file from -freenet. C<$meta> is the metadata (as returned by C or -C). +Fetches a (small, as it should fit into memory) key content block from +freenet. C<$meta> is a C object or C). -Due to the overhead, a better method to download big files should be used. +The C<$uri> should begin with C, but the scheme is currently +added, if missing. my ($meta, $data) = @{ $fcp->client_get ( @@ -405,7 +340,9 @@ $txn->(client_get => sub { my ($self, $uri, $htl, $removelocal) = @_; - $self->txn (client_get => URI => $uri, hops_to_live => (defined $htl ? $htl :15), + $uri =~ s/^freenet://; $uri = "freenet:$uri"; + + $self->txn (client_get => URI => $uri, hops_to_live => xeh (defined $htl ? $htl : 15), remove_local_key => $removelocal ? "true" : "false"); }); @@ -415,33 +352,37 @@ Insert a new key. If the client is inserting a CHK, the URI may be abbreviated as just CHK@. In this case, the node will calculate the -CHK. +CHK. If the key is a private SSK key, the node will calculcate the public +key and the resulting public URI. -C<$meta> can be a reference or a string (ONLY THE STRING CASE IS IMPLEMENTED!). +C<$meta> can be a hash reference (same format as returned by +C) or a string. -THIS INTERFACE IS UNTESTED AND SUBJECT TO CHANGE. +The result is an arrayref with the keys C, C and C. =cut $txn->(client_put => sub { - my ($self, $uri, $meta, $data, $htl, $removelocal) = @_; + my ($self, $uri, $metadata, $data, $htl, $removelocal) = @_; + + $metadata = Net::FCP::Metadata::build_metadata $metadata; + $uri =~ s/^freenet://; $uri = "freenet:$uri"; - $self->txn (client_put => URI => $uri, hops_to_live => (defined $htl ? $htl :15), + $self->txn (client_put => URI => $uri, + hops_to_live => xeh (defined $htl ? $htl : 15), remove_local_key => $removelocal ? "true" : "false", - data => "$meta$data", metadata_length => length $meta); + data => "$metadata$data", metadata_length => xeh length $metadata); }); } # transactions -=item MISSING: (ClientPut), InsretKey - =back =head2 THE Net::FCP::Txn CLASS -All requests (or transactions) are executed in a asynchroneous way (LIE: -uploads are blocking). For each request, a C object is -created (worse: a tcp connection is created, too). +All requests (or transactions) are executed in a asynchronous way. For +each request, a C object is created (worse: a tcp +connection is created, too). For each request there is actually a different subclass (and it's possible to subclass these, although of course not documented). @@ -479,7 +420,7 @@ } if (defined $data) { - $attr .= "DataLength=" . (length $data) . "\012"; + $attr .= sprintf "DataLength=%x\012", length $data; $data = "Data\012$data"; } else { $data = "EndMessage\012"; @@ -496,14 +437,16 @@ $self->{sbuf} = "\x00\x00\x00\x02" - . Net::FCP::touc $self->{type} + . (Net::FCP::touc $self->{type}) . "\012$attr$data"; - #$fh->shutdown (1); # freenet buggy?, well, it's java... + #shutdown $fh, 1; # freenet buggy?, well, it's java... $self->{fh} = $fh; - $self->{w} = $EVENT->new_from_fh ($fh)->cb(sub { $self->fh_ready_w })->poll(0, 1, 1); + $self->{w} = $EVENT->new_from_fh ($fh) + ->cb (sub { $self->fh_ready_w }) + ->poll (0, 1, 1); $self; } @@ -549,7 +492,7 @@ =item $txn->cancel (%attr) -Cancels the operation with a C exception anf the given attributes +Cancels the operation with a C exception and the given attributes (consider at least giving the attribute C). UNTESTED. @@ -668,6 +611,7 @@ sub progress { my ($self, $type, $attr) = @_; + $self->{fcp}->progress ($self, $type, $attr); } @@ -676,7 +620,10 @@ Waits until a result is available and then returns it. This waiting is (depending on your event model) not very efficient, as it -is done outside the "mainloop". +is done outside the "mainloop". The biggest problem, however, is that it's +blocking one thread of execution. Try to use the callback mechanism, if +possible, and call result from within the callback (or after is has been +run), as then no waiting is necessary. =cut @@ -717,7 +664,7 @@ sub rcv_success { my ($self, $attr) = @_; - $self->set_result ($attr); + $self->set_result ($attr->{uri}); } package Net::FCP::Txn::GenerateSVKPair; @@ -726,16 +673,16 @@ sub rcv_success { my ($self, $attr) = @_; - $self->set_result ([$attr->{PublicKey}, $attr->{PrivateKey}]); + $self->set_result ([$attr->{public_key}, $attr->{private_key}, $attr->{crypto_key}]); } -package Net::FCP::Txn::InsertPrivateKey; +package Net::FCP::Txn::InvertPrivateKey; use base Net::FCP::Txn; sub rcv_success { my ($self, $attr) = @_; - $self->set_result ($attr->{PublicKey}); + $self->set_result ($attr->{public_key}); } package Net::FCP::Txn::GetSize; @@ -744,7 +691,7 @@ sub rcv_success { my ($self, $attr) = @_; - $self->set_result ($attr->{Length}); + $self->set_result (hex $attr->{length}); } package Net::FCP::Txn::GetPut; @@ -753,8 +700,8 @@ use base Net::FCP::Txn; -*rcv_uri_error = \&Net::FCP::Txn::rcv_throw_exception; -*rcv_route_not_found = \&Net::FCP::Txn::rcv_throw_exception; +*rcv_uri_error = \&Net::FCP::Txn::rcv_throw_exception; +*rcv_route_not_found = \&Net::FCP::Txn::rcv_throw_exception; sub rcv_restarted { my ($self, $attr, $type) = @_; @@ -781,9 +728,10 @@ if ($self->{datalength} == length $self->{data}) { my $data = delete $self->{data}; - my $meta = Net::FCP::parse_metadata substr $data, 0, $self->{metalength}, ""; + my $meta = new Net::FCP::Metadata (substr $data, 0, $self->{metalength}, ""); $self->set_result ([$meta, $data]); + $self->eof; } } @@ -801,7 +749,6 @@ use base Net::FCP::Txn::GetPut; *rcv_size_error = \&Net::FCP::Txn::rcv_throw_exception; -*rcv_key_collision = \&Net::FCP::Txn::rcv_throw_exception; sub rcv_pending { my ($self, $attr, $type) = @_; @@ -813,6 +760,11 @@ $self->set_result ($attr); } +sub rcv_key_collision { + my ($self, $attr, $type) = @_; + $self->set_result ({ key_collision => 1, %$attr }); +} + =back =head2 The Net::FCP::Exception CLASS @@ -831,7 +783,7 @@ use overload '""' => sub { - "Net::FCP::Exception<<$_[0][0]," . (join ":", %{$_[0][1]}) . ">>\n"; + "Net::FCP::Exception<<$_[0][0]," . (join ":", %{$_[0][1]}) . ">>"; }; =item $exc = new Net::FCP::Exception $type, \%attr @@ -889,16 +841,16 @@ =head1 AUTHOR Marc Lehmann - http://www.goof.com/pcg/marc/ + http://home.schmorp.de/ =cut package Net::FCP::Event::Auto; my @models = ( - [Coro => Coro::Event:: ], + [Coro => Coro::Event::], [Event => Event::], - [Glib => Glib:: ], + [Glib => Glib::], [Tk => Tk::], );