--- cvsroot/Net-FCP/FCP.pm 2003/09/07 22:57:40 1.1 +++ cvsroot/Net-FCP/FCP.pm 2003/09/10 05:20:48 1.16 @@ -19,8 +19,23 @@ =head1 WARNING This module is alpha. While it probably won't destroy (much :) of your -data, it currently works only with the Event module (alkthough the event -mechanism is fully pluggable). +data, it currently falls short of what it should provide (intelligent uri +following, splitfile downloads, healing...) + +=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. =head2 THE Net::FCP CLASS @@ -31,40 +46,112 @@ package Net::FCP; use Carp; -use IO::Socket::INET; -$VERSION = 0.01; +$VERSION = 0.07; -sub event_reg_cb { - my ($obj) = @_; - require Event; - - $obj->{eventdata} = Event->io ( - fd => $obj->{fh}, - poll => 'r', - cb => sub { - $obj->fh_ready; - }, - ); +no warnings; + +our $EVENT = Net::FCP::Event::Auto::; +$EVENT = Net::FCP::Event::Event;#d# + +sub import { + shift; + + for (@_) { + if (/^event=(\w+)$/) { + $EVENT = "Net::FCP::Event::$1"; + } + } + eval "require $EVENT"; + die $@ if $@; } -sub event_unreg_cb { - $_[0]{eventdata} - and (delete $_[0]{eventdata})->cancel; +sub touc($) { + local $_ = shift; + 1 while s/((?:^|_)(?:svk|chk|uri)(?:_|$))/\U$1/; + s/(?:^|_)(.)/\U$1/g; + $_; } -sub event_wait_cb { - Event::one_event(); +sub tolc($) { + local $_ = shift; + s/(?<=[a-z])(?=[A-Z])/_/g; + lc $_; } -$regcb = \&event_reg_cb; -$unregcb = \&event_unreg_cb; -$waitcb = \&event_wait_cb; +=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) { + die "metadata format error ($1)"; + } + } + } + + #$meta->{tail} = substr $data, pos $data; + + $meta; +} =item $fcp = new Net::FCP [host => $host][, port => $port] Create a new virtual FCP connection to the given host and port (default -127.0.0.1:8481). +127.0.0.1:8481, or the environment variables C and C). Connections are virtual because no persistent physical connection is established. However, the existance of the node is checked by executing a @@ -76,25 +163,54 @@ my $class = shift; my $self = bless { @_ }, $class; - $self->{host} ||= "127.0.0.1"; - $self->{port} ||= 8481; + $self->{host} ||= $ENV{FREDHOST} || "127.0.0.1"; + $self->{port} ||= $ENV{FREDPORT} || 8481; - $self->{nodehello} = $self->txn("ClientHello")->result - or croak "unable to get nodehello from node\n"; + #$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,...) The low-level interface to transactions. Don't use it. +Here are some examples of using transactions: + +The blocking case, no (visible) transactions involved: + + my $nodehello = $fcp->client_hello; + +A transaction used in a blocking fashion: + + my $txn = $fcp->txn_client_hello; + ... + my $nodehello = $txn->result; + +Or shorter: + + my $nodehello = $fcp->txn_client_hello->result; + +Setting callbacks: + + $fcp->txn_client_hello->cb( + sub { my $nodehello => $_[0]->result } + ); + =cut sub txn { my ($self, $type, %attr) = @_; - my $txn = "Net::FCP::Txn::$type"->new(fcp => $self, type => $type, attr => \%attr); + $type = touc $type; + + my $txn = "Net::FCP::Txn::$type"->new(fcp => $self, type => tolc $type, attr => \%attr); $txn; } @@ -112,9 +228,9 @@ Executes a ClientHello request and returns it's results. { - MaxFileSize => "5f5e100", - Protocol => "1.2", - Node => "Fred,0.6,1.46,7050" + max_file_size => "5f5e100", + node => "Fred,0.6,1.46,7050" + protocol => "1.2", } =cut @@ -122,7 +238,7 @@ _txn client_hello => sub { my ($self) = @_; - $self->txn ("ClientHello"); + $self->txn ("client_hello"); }; =item $txn = $fcp->txn_client_info @@ -132,27 +248,27 @@ Executes a ClientInfo request and returns it's results. { - MaxFileSize => "5f5e100", - DatastoreMax => "2540be400", - NodePort => 369, - JavaName => "Java HotSpot(TM) Server VM", - OperatingSystemVersion => "2.4.20", - EstimatedLoad => 52, - FreeMemory => "5cc0148", - DatastoreFree => "5ce03400", - NodeAddress => "1.2.3.4", - ActiveJobs => "1f", - AllocatedMemory => "bde0000", - Architecture => "i386", - RoutingTime => "a5", - LeastRecentTimestamp => "f41538b878", - AvailableThreads => 17, - DatastoreUsed => "1f72bb000", - JavaVersion => "Blackdown-1.4.1-01", - IsTransient => "false", - OperatingSystem => "Linux", - JavaVendor => "http://www.blackdown.org/", - MostRecentTimestamp => "f77e2cc520" + active_jobs => "1f", + allocated_memory => "bde0000", + architecture => "i386", + available_threads => 17, + datastore_free => "5ce03400", + datastore_max => "2540be400", + datastore_used => "1f72bb000", + estimated_load => 52, + free_memory => "5cc0148", + is_transient => "false", + java_name => "Java HotSpot(_T_M) Server VM", + java_vendor => "http://www.blackdown.org/", + java_version => "Blackdown-1.4.1-01", + least_recent_timestamp => "f41538b878", + max_file_size => "5f5e100", + most_recent_timestamp => "f77e2cc520" + node_address => "1.2.3.4", + node_port => 369, + operating_system => "Linux", + operating_system_version => "2.4.20", + routing_time => "a5", } =cut @@ -160,7 +276,7 @@ _txn client_info => sub { my ($self) = @_; - $self->txn ("ClientInfo"); + $self->txn ("client_info"); }; =item $txn = $fcp->txn_generate_chk ($metadata, $data) @@ -174,7 +290,7 @@ _txn generate_chk => sub { my ($self, $metadata, $data) = @_; - $self->txn (GenerateCHK => data => "$data$metadata", MetaDataLength => length $metadata); + $self->txn (generate_chk => data => "$data$metadata", metadata_length => length $metadata); }; =item $txn = $fcp->txn_generate_svk_pair @@ -193,7 +309,7 @@ _txn generate_svk_pair => sub { my ($self) = @_; - $self->txn ("GenerateSVKPair"); + $self->txn ("generate_svk_pair"); }; =item $txn = $fcp->txn_insert_private_key ($private) @@ -213,7 +329,7 @@ _txn insert_private_key => sub { my ($self, $privkey) = @_; - $self->txn (InvertPrivateKey => Private => $privkey); + $self->txn (invert_private_key => private => $privkey); }; =item $txn = $fcp->txn_get_size ($uri) @@ -230,10 +346,34 @@ _txn get_size => sub { my ($self, $uri) = @_; - $self->txn (GetSize => URI => $uri); + $self->txn (get_size => URI => $uri); }; -=item MISSING: ClientGet, ClientPut +=item $txn = $fcp->txn_client_get ($uri [, $htl = 15 [, $removelocal = 0]]) + +=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). + +Due to the overhead, a better method to download big files should be used. + + my ($meta, $data) = @{ + $fcp->client_get ( + "freenet:CHK@hdXaxkwZ9rA8-SidT0AN-bniQlgPAwI,XdCDmBuGsd-ulqbLnZ8v~w" + ) + }; + +=cut + +_txn client_get => sub { + my ($self, $uri, $htl, $removelocal) = @_; + + $self->txn (client_get => URI => $uri, hops_to_live => ($htl || 15), remove_local_key => $removelocal ? "true" : "false"); +}; + +=item MISSING: ClientPut =back @@ -254,6 +394,9 @@ package Net::FCP::Txn; +use Fcntl; +use Socket; + =item new arg => val,... Creates a new C object. Not normally used. @@ -264,11 +407,15 @@ my $class = shift; my $self = bless { @_ }, $class; + $self->{signal} = $EVENT->new_signal; + + $self->{fcp}{txn}{$self} = $self; + my $attr = ""; my $data = delete $self->{attr}{data}; while (my ($k, $v) = each %{$self->{attr}}) { - $attr .= "$k=$v\012" + $attr .= (Net::FCP::touc $k) . "=$v\012" } if (defined $data) { @@ -278,86 +425,185 @@ $data = "EndMessage\012"; } - my $fh = new IO::Socket::INET - PeerHost => $self->{fcp}{host}, - PeerPort => $self->{fcp}{port} - or Carp::croak "FCP::txn: unable to connect to $self->{fcp}{host}:$self->{fcp}{port}: $!\n"; - + socket my $fh, PF_INET, SOCK_STREAM, 0 + or Carp::croak "unable to create new tcp socket: $!"; binmode $fh, ":raw"; - - print - $self->{type}, "\012", - $attr, - $data, "\012"; - - print $fh - "\x00\x00", "\x00\x02", # SESSID, PRESID - $self->{type}, "\012", - $attr, - $data; + fcntl $fh, F_SETFL, O_NONBLOCK; + connect $fh, (sockaddr_in $self->{fcp}{port}, inet_aton $self->{fcp}{host}) + and !$!{EWOULDBLOCK} + and !$!{EINPROGRESS} + and Carp::croak "FCP::txn: unable to connect to $self->{fcp}{host}:$self->{fcp}{port}: $!\n"; + + $self->{sbuf} = + "\x00\x00\x00\x02" + . Net::FCP::touc $self->{type} + . "\012$attr$data"; #$fh->shutdown (1); # freenet buggy?, well, it's java... $self->{fh} = $fh; - $Net::FCP::regcb->($self); + $self->{w} = $EVENT->new_from_fh ($fh)->cb(sub { $self->fh_ready_w })->poll(0, 1, 1); $self; } -sub fh_ready { +=item $txn = $txn->cb ($coderef) + +Sets a callback to be called when the request is finished. The coderef +will be called with the txn as it's sole argument, so it has to call +C itself. + +Returns the txn object, useful for chaining. + +Example: + + $fcp->txn_client_get ("freenet:CHK....") + ->userdata ("ehrm") + ->cb(sub { + my $data = shift->result; + }); + +=cut + +sub cb($$) { + my ($self, $cb) = @_; + $self->{cb} = $cb; + $self; +} + +=item $txn = $txn->userdata ([$userdata]) + +Set user-specific data. This is useful in progress callbacks. The data can be accessed +using C<< $txn->{userdata} >>. + +Returns the txn object, useful for chaining. + +=cut + +sub userdata($$) { + my ($self, $data) = @_; + $self->{userdata} = $data; + $self; +} + +sub fh_ready_w { + my ($self) = @_; + + my $len = syswrite $self->{fh}, $self->{sbuf}; + + if ($len > 0) { + 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); + } + } elsif (defined $len) { + $self->throw (Net::FCP::Exception->new (network_error => { reason => "unexpected end of file while writing" })); + } else { + $self->throw (Net::FCP::Exception->new (network_error => { reason => "$!" })); + } +} + +sub fh_ready_r { my ($self) = @_; if (sysread $self->{fh}, $self->{buf}, 65536, length $self->{buf}) { for (;;) { if ($self->{datalen}) { + #warn "expecting new datachunk $self->{datalen}, got ".(length $self->{buf})."\n";#d# if (length $self->{buf} >= $self->{datalen}) { - $self->recv_data (substr $self->{buf}, 0, $self->{datalen}, ""); + $self->rcv_data (substr $self->{buf}, 0, delete $self->{datalen}, ""); } else { last; } - } elsif ($self->{buf} =~ s/^DataChunk\015?\012Length=(\d+)\015?\012Data\015?\012//) { - $self->{datalen} = $1; - } elsif ($self->{buf} =~ s/^([a-zA-Z]+)\015?\012(.*?)\015?\012EndMessage\015?\012//s) { - $self->rcv ($1, {map { split /=/, $_, 2 } split /\015?\012/, $2}); + } elsif ($self->{buf} =~ s/^DataChunk\015?\012Length=([0-9a-fA-F]+)\015?\012Data\015?\012//) { + $self->{datalen} = hex $1; + #warn "expecting new datachunk $self->{datalen}\n";#d# + } elsif ($self->{buf} =~ s/^([a-zA-Z]+)\015?\012(?:(.+?)\015?\012)?EndMessage\015?\012//s) { + $self->rcv ($1, { + map { my ($a, $b) = split /=/, $_, 2; ((Net::FCP::tolc $a), $b) } + split /\015?\012/, $2 + }); } else { last; } } } else { - $Net::FCP::unregcb->($self); - delete $self->{fh}; $self->eof; } } sub rcv_data { my ($self, $chunk) = @_; + + $self->{data} .= $chunk; + + $self->progress ("data", { chunk => length $chunk, total => length $self->{data}, end => $self->{datalength} }); } sub rcv { my ($self, $type, $attr) = @_; - #use PApp::Util;warn "$type => ".PApp::Util::dumpval($attr); - if (my $method = $self->can("rcv_\L$type")) { + $type = Net::FCP::tolc $type; + + #use PApp::Util; warn PApp::Util::dumpval [$type, $attr]; + + if (my $method = $self->can("rcv_$type")) { $method->($self, $attr, $type); } else { warn "received unexpected reply type '$type' for '$self->{type}', ignoring\n"; - $self->eof; } } -sub eof { +# used as a default exception thrower +sub rcv_throw_exception { + my ($self, $attr, $type) = @_; + $self->throw (Net::FCP::Exception->new ($type, $attr)); +} + +*rcv_failed = \&Net::FCP::Txn::rcv_throw_exception; +*rcv_format_error = \&Net::FCP::Txn::rcv_throw_exception; + +sub throw { + my ($self, $exc) = @_; + + $self->{exception} = $exc; + $self->set_result (1); + $self->eof; # must be last to avoid loops +} + +sub set_result { my ($self, $result) = @_; - $self->{result} = $result unless exists $self->{result}; + unless (exists $self->{result}) { + $self->{result} = $result; + $self->{cb}->($self) if exists $self->{cb}; + $self->{signal}->send; + } +} + +sub eof { + my ($self) = @_; + + delete $self->{w}; + delete $self->{fh}; + + delete $self->{fcp}{txn}{$self}; + + $self->set_result; # just in case +} + +sub progress { + my ($self, $type, $attr) = @_; + $self->{fcp}->progress ($self, $type, $attr); } =item $result = $txn->result Waits until a result is available and then returns it. -This waiting is (depending on your event modul) not very efficient, as it +This waiting is (depending on your event model) not very efficient, as it is done outside the "mainloop". =cut @@ -365,33 +611,31 @@ sub result { my ($self) = @_; - $Net::FCP::waitcb->() while !exists $self->{result}; + $self->{signal}->wait while !exists $self->{result}; - return $self->{result}; -} + die $self->{exception} if $self->{exception}; -sub DESTROY { - $Net::FCP::unregcb->($_[0]); + return $self->{result}; } package Net::FCP::Txn::ClientHello; use base Net::FCP::Txn; -sub rcv_nodehello { +sub rcv_node_hello { my ($self, $attr) = @_; - $self->eof ($attr); + $self->set_result ($attr); } package Net::FCP::Txn::ClientInfo; use base Net::FCP::Txn; -sub rcv_nodeinfo { +sub rcv_node_info { my ($self, $attr) = @_; - $self->eof ($attr); + $self->set_result ($attr); } package Net::FCP::Txn::GenerateCHK; @@ -401,7 +645,7 @@ sub rcv_success { my ($self, $attr) = @_; - $self->eof ($attr); + $self->set_result ($attr); } package Net::FCP::Txn::GenerateSVKPair; @@ -411,7 +655,7 @@ sub rcv_success { my ($self, $attr) = @_; - $self->eof ([$attr->{PublicKey}, $attr->{PrivateKey}]); + $self->set_result ([$attr->{PublicKey}, $attr->{PrivateKey}]); } package Net::FCP::Txn::InvertPrivateKey; @@ -421,7 +665,7 @@ sub rcv_success { my ($self, $attr) = @_; - $self->eof ($attr->{PublicKey}); + $self->set_result ($attr->{PublicKey}); } package Net::FCP::Txn::GetSize; @@ -431,7 +675,88 @@ sub rcv_success { my ($self, $attr) = @_; - $self->eof ($attr->{Length}); + $self->set_result ($attr->{Length}); +} + +package Net::FCP::Txn::GetPut; + +# base class for get and put + +use base Net::FCP::Txn; + +*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) = @_; + + delete $self->{datalength}; + delete $self->{metalength}; + delete $self->{data}; + + $self->progress ($type, $attr); +} + +package Net::FCP::Txn::ClientGet; + +use base Net::FCP::Txn::GetPut; + +*rcv_data_not_found = \&Net::FCP::Txn::rcv_throw_exception; + +sub rcv_data_found { + my ($self, $attr, $type) = @_; + + $self->progress ($type, $attr); + + $self->{datalength} = hex $attr->{data_length}; + $self->{metalength} = hex $attr->{metadata_length}; +} + +sub eof { + my ($self) = @_; + + if ($self->{datalength} == length $self->{data}) { + my $data = delete $self->{data}; + my $meta = Net::FCP::parse_metadata substr $data, 0, $self->{metalength}, ""; + + $self->set_result ([$meta, $data]); + } elsif (!exists $self->{result}) { + $self->throw (Net::FCP::Exception->new (short_data => { + reason => "unexpected eof or internal node error", + received => length $self->{data}, + expected => $self->{datalength}, + })); + } +} + +package Net::FCP::Txn::ClientPut; + +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) = @_; + $self->progress ($type, $attr); +} + +sub rcv_success { + my ($self, $attr, $type) = @_; + $self->set_result ($attr); +} + +package Net::FCP::Exception; + +use overload + '""' => sub { + "Net::FCP::Exception<<$_[0][0]," . (join ":", %{$_[0][1]}) . ">>\n"; + }; + +sub new { + my ($class, $type, $attr) = @_; + + bless [Net::FCP::tolc $type, { %$attr }], $class; } =back