--- cvsroot/Net-FCP/FCP.pm 2004/05/13 21:43:16 1.29 +++ cvsroot/Net-FCP/FCP.pm 2006/11/28 15:18:17 1.39 @@ -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,162 +62,14 @@ use Carp; -$VERSION = 0.6; +$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; - 1 while s/(SVK|CHK|URI)([^_])/$1\_$2/i; - 1 while s/([^_])(SVK|CHK|URI)/$1\_$2/i; - s/(?<=[a-z])(?=[A-Z])/_/g; - lc $_; -} - -# the opposite of hex -sub xeh($) { - sprintf "%x", $_[0]; -} - -=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. - -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; -} - -=item $string = Net::FCP::build_metadata $meta - -Takes a hash reference as returned by C and -returns the corresponding string form. If a string is given, it's returned -as is. - -=cut - -sub build_metadata_subhash($$$) { - my ($prefix, $level, $hash) = @_; - - join "", - map - ref $hash->{$_} ? build_metadata_subhash ($prefix . (Net::FCP::touc $_) . ".", $level + 1, $hash->{$_}) - : $prefix . ($level > 1 ? $_ : Net::FCP::touc $_) . "=" . $hash->{$_} . "\n", - keys %$hash; -} - -sub build_metadata_hash($$) { - my ($header, $hash) = @_; - - if (ref $hash eq ARRAY::) { - join "", map build_metadata_hash ($header, $_), @$hash - } else { - (Net::FCP::touc $header) . "\n" - . (build_metadata_subhash "", 0, $hash) - . "EndPart\n"; - } -} - -sub build_metadata($) { - my ($meta) = @_; - - return $meta unless ref $meta; - - $meta = { %$meta }; - - delete $meta->{raw}; - - my $res = - (build_metadata_hash version => delete $meta->{version}) - . (join "", map +(build_metadata_hash $_, $meta->{$_}), keys %$meta); - - substr $res, 0, -5; # get rid of "Part". Broken Syntax.... -} +use AnyEvent; +use Net::FCP::Metadata; +use Net::FCP::Util qw(tolc touc xeh); =item $fcp = new Net::FCP [host => $host][, port => $port][, progress => \&cb] @@ -249,13 +89,6 @@ warn "progress<$txn,$type," . (join ":", %$attr) . ">\n"; } -=begin comment - -However, the existance of the node is checked by executing a -C transaction. - -=end - =cut sub new { @@ -265,9 +98,6 @@ $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; } @@ -278,11 +108,10 @@ if $self->{progress}; } -=item $txn = $fcp->txn(type => attr => val,...) - -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: @@ -394,15 +223,17 @@ $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 => xeh 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 with the public key, the private key and a crypto key, which is just additional entropy. @@ -468,15 +299,12 @@ =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). The C<$uri> should begin with C, but the scheme is currently added, if missing. -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" @@ -488,8 +316,7 @@ $txn->(client_get => sub { my ($self, $uri, $htl, $removelocal) = @_; - $uri =~ s/^freenet://; - $uri = "freenet:$uri"; + $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"); @@ -512,14 +339,15 @@ =cut $txn->(client_put => sub { - my ($self, $uri, $meta, $data, $htl, $removelocal) = @_; + my ($self, $uri, $metadata, $data, $htl, $removelocal) = @_; - $meta = build_metadata $meta; + $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 => xeh length $meta); + data => "$metadata$data", metadata_length => xeh length $metadata); }); } # transactions @@ -556,7 +384,7 @@ my $class = shift; my $self = bless { @_ }, $class; - $self->{signal} = $EVENT->new_signal; + $self->{signal} = AnyEvent->condvar; $self->{fcp}{txn}{$self} = $self; @@ -578,10 +406,8 @@ or Carp::croak "unable to create new tcp socket: $!"; binmode $fh, ":raw"; 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"; + connect $fh, (sockaddr_in $self->{fcp}{port}, inet_aton $self->{fcp}{host}); +# and Carp::croak "FCP::txn: unable to connect to $self->{fcp}{host}:$self->{fcp}{port}: $!\n"; $self->{sbuf} = "\x00\x00\x00\x02" @@ -592,7 +418,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; } @@ -638,7 +464,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. @@ -661,7 +487,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" })); @@ -673,7 +499,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# @@ -736,7 +562,7 @@ unless (exists $self->{result}) { $self->{result} = $result; $self->{cb}->($self) if exists $self->{cb}; - $self->{signal}->send; + $self->{signal}->broadcast; } } @@ -874,7 +700,7 @@ 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; @@ -895,7 +721,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) = @_; @@ -907,6 +732,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 @@ -982,42 +812,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