--- cvsroot/Net-FCP/FCP.pm 2003/09/16 07:00:59 1.21 +++ cvsroot/Net-FCP/FCP.pm 2006/11/27 13:16:25 1.38 @@ -16,6 +16,8 @@ See L for a description of what the messages do. I am too lazy to document all this here. +The module uses L to find a suitable Event module. + =head1 WARNING This module is alpha. While it probably won't destroy (much :) of your @@ -24,21 +26,7 @@ =head2 IMPORT TAGS -Nothing much can be "imported" from this module right now. There are, -however, certain "import tags" that can be used to select the event model -to be used. - -Event models are implemented as modules under the C -class, where C is the event model to use. The default is C (or -later C). - -The import tag to use is named C, e.g. C, -C etc. - -You should specify the event module to use only in the main program. - -If no event model has been specified, FCP tries to autodetect it on first -use (e.g. first transaction), in this order: Coro, Event, Glib, Tk. +Nothing much can be "imported" from this module right now. =head2 FREENET BASICS @@ -74,110 +62,16 @@ use Carp; -$VERSION = 0.08; +$VERSION = '1.0'; no warnings; -our $EVENT = Net::FCP::Event::Auto::; - -sub import { - shift; - - for (@_) { - if (/^event=(\w+)$/) { - $EVENT = "Net::FCP::Event::$1"; - eval "require $EVENT"; - } - } - 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) and key C containing the original -metadata string. +use AnyEvent; -All other headers are represented by arrayrefs (they can be repeated). - -Since this description is confusing, here is a rather verbose example of a -parsed manifest: - - ( - raw => "Version...", - 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 $data = shift; - my $meta = { raw => $data }; - - 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; -} +use Net::FCP::Metadata; +use Net::FCP::Util qw(tolc touc xeh); -=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). @@ -185,12 +79,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 @@ -201,22 +98,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: @@ -245,7 +140,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; } @@ -320,7 +215,7 @@ =item $uri = $fcp->generate_chk ($metadata, $data[, $cipher]) -Calculcates a CHK, given the metadata and data. C<$cipher> is either +Calculates a CHK, given the metadata and data. C<$cipher> is either C or C, with the latter being the default. =cut @@ -328,23 +223,37 @@ $txn->(generate_chk => sub { my ($self, $metadata, $data, $cipher) = @_; + $metadata = Net::FCP::Metadata::build_metadata $metadata; + $self->txn (generate_chk => - data => "$metadata$data", - metadata_length => length $metadata, - cipher => $cipher || "Twofish"); + 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 { @@ -353,21 +262,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); @@ -380,8 +287,6 @@ Finds and returns the size (rounded up to the nearest power of two) of the given document. -UNTESTED. - =cut $txn->(get_size => sub { @@ -394,11 +299,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 ( @@ -411,7 +316,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"); }); @@ -421,33 +328,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) = @_; - $self->txn (client_put => URI => $uri, hops_to_live => (defined $htl ? $htl :15), + $metadata = Net::FCP::Metadata::build_metadata $metadata; + $uri =~ s/^freenet://; $uri = "freenet:$uri"; + + $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). @@ -473,7 +384,7 @@ my $class = shift; my $self = bless { @_ }, $class; - $self->{signal} = $EVENT->new_signal; + $self->{signal} = AnyEvent->condvar; $self->{fcp}{txn}{$self} = $self; @@ -509,7 +420,7 @@ $self->{fh} = $fh; - $self->{w} = $EVENT->new_from_fh ($fh)->cb(sub { $self->fh_ready_w })->poll(0, 1, 1); + $self->{w} = AnyEvent->io (fh => $fh, poll => 'w', cb => sub { $self->fh_ready_w }); $self; } @@ -555,7 +466,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. @@ -578,7 +489,7 @@ substr $self->{sbuf}, 0, $len, ""; unless (length $self->{sbuf}) { fcntl $self->{fh}, F_SETFL, 0; - $self->{w}->cb(sub { $self->fh_ready_r })->poll (1, 0, 1); + $self->{w} = AnyEvent->io (fh => $self->{fh}, poll => 'r', cb => sub { $self->fh_ready_r }); } } elsif (defined $len) { $self->throw (Net::FCP::Exception->new (network_error => { reason => "unexpected end of file while writing" })); @@ -590,7 +501,7 @@ sub fh_ready_r { my ($self) = @_; - if (sysread $self->{fh}, $self->{buf}, 65536, length $self->{buf}) { + if (sysread $self->{fh}, $self->{buf}, 16384 + 1024, length $self->{buf}) { for (;;) { if ($self->{datalen}) { #warn "expecting new datachunk $self->{datalen}, got ".(length $self->{buf})."\n";#d# @@ -653,7 +564,7 @@ unless (exists $self->{result}) { $self->{result} = $result; $self->{cb}->($self) if exists $self->{cb}; - $self->{signal}->send; + $self->{signal}->broadcast; } } @@ -674,6 +585,7 @@ sub progress { my ($self, $type, $attr) = @_; + $self->{fcp}->progress ($self, $type, $attr); } @@ -682,7 +594,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 @@ -732,16 +647,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; @@ -750,7 +665,7 @@ sub rcv_success { my ($self, $attr) = @_; - $self->set_result ($attr->{Length}); + $self->set_result (hex $attr->{length}); } package Net::FCP::Txn::GetPut; @@ -759,8 +674,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) = @_; @@ -787,9 +702,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; } } @@ -807,7 +723,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) = @_; @@ -819,6 +734,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 @@ -837,7 +757,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 @@ -894,42 +814,10 @@ =head1 AUTHOR - Marc Lehmann - http://www.goof.com/pcg/marc/ + Marc Lehmann + http://home.schmorp.de/ =cut -package Net::FCP::Event::Auto; - -my @models = ( - [Coro => Coro::Event:: ], - [Event => Event::], - [Glib => Glib:: ], - [Tk => Tk::], -); - -sub AUTOLOAD { - $AUTOLOAD =~ s/.*://; - - for (@models) { - my ($model, $package) = @$_; - if (defined ${"$package\::VERSION"}) { - $EVENT = "Net::FCP::Event::$model"; - eval "require $EVENT"; die if $@; - goto &{"$EVENT\::$AUTOLOAD"}; - } - } - - for (@models) { - my ($model, $package) = @$_; - $EVENT = "Net::FCP::Event::$model"; - if (eval "require $EVENT") { - goto &{"$EVENT\::$AUTOLOAD"}; - } - } - - die "No event module selected for Net::FCP and autodetect failed. Install any of these: Coro, Event, Glib or Tk."; -} - -1; +1