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

Comparing Net-FCP/FCP.pm (file contents):
Revision 1.17 by root, Fri Sep 12 03:28:45 2003 UTC vs.
Revision 1.23 by root, Wed Sep 17 08:57:32 2003 UTC

 The import tag to use is named C<event=xyz>, e.g. C<event=Event>,
 C<event=Glib> 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.
 =head2 FREENET BASICS
 Ok, this section will not explain any freenet basics to you, just some
 problems I found that you might want to avoid:
 package Net::FCP;
 use Carp;
-$VERSION = 0.07;
+$VERSION = 0.5;
 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";
       }
    }
-   eval "require $EVENT";
    die $@ if $@;
 }
 sub touc($) {
    local $_ = shift;
    local $_ = shift;
    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<version> (containing
+The metadata will be a hashref with key C<version> (containing the
-the mandatory version header entries).
+mandatory version header entries) and key C<raw> containing the original
+metadata string.
 All other headers are represented by arrayrefs (they can be repeated).
-Since this is confusing, here is a rather verbose example of a parsed
+Since this description is confusing, here is a rather verbose example of a
-manifest:
+parsed manifest:
    (
+      raw => "Version...",
       version => { revision => 1 },
       document => [
                     {
                       info => { format" => "image/jpeg" },
                       name => "background.jpg",
    )
 =cut
 sub parse_metadata {
-   my $meta;
    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) {
          } 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), please report this string: <<$data>>";
+            print STDERR "metadata format error ($1), please report this string: <<$data>>";
+            die "metadata format error";
          }
       }
    }
    #$meta->{tail} = substr $data, pos $data;
    $self;
 }
 sub progress {
    my ($self, $txn, $type, $attr) = @_;
-   warn "progress<$txn,$type," . (join ":", %$attr) . ">\n";
+   #warn "progress<$txn,$type," . (join ":", %$attr) . ">\n";
 }
 =item $txn = $fcp->txn(type => attr => val,...)
 The low-level interface to transactions. Don't use it.
    my ($self) = @_;
    $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.
+Calculcates a CHK, given the metadata and data. C<$cipher> is either
+C<Rijndael> or C<Twofish>, 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);
+   $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 }
 =cut
 $txn->(client_get => sub {
    my ($self, $uri, $htl, $removelocal) = @_;
-   $self->txn (client_get => URI => $uri, hops_to_live => (defined $htl ? $htl :15),
+   $self->txn (client_get => URI => $uri, hops_to_live => xeh (defined $htl ? $htl : 15),
                remove_local_key => $removelocal ? "true" : "false");
 });
 =item $txn = $fcp->txn_client_put ($uri, $metadata, $data, $htl, $removelocal)
 =cut
 $txn->(client_put => sub {
    my ($self, $uri, $meta, $data, $htl, $removelocal) = @_;
-   $self->txn (client_put => URI => $uri, hops_to_live => (defined $htl ? $htl :15),
+   $self->txn (client_put => URI => $uri, xeh (defined $htl ? $htl : 15),
                remove_local_key => $removelocal ? "true" : "false",
-               data => "$meta$data", metadata_length => length $meta);
+               data => "$meta$data", metadata_length => xeh length $meta);
 });
 } # transactions
-=item MISSING: (ClientPut), InsretKey
+=item MISSING: (ClientPut), InsertKey
 =back
 =head2 THE Net::FCP::Txn CLASS
-All requests (or transactions) are executed in a asynchroneous way (LIE:
+All requests (or transactions) are executed in a asynchronous way. For
-uploads are blocking). For each request, a C<Net::FCP::Txn> object is
+each request, a C<Net::FCP::Txn> object is created (worse: a tcp
-created (worse: a tcp connection is created, too).
+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).
 The most interesting method is C<result>.
    while (my ($k, $v) = each %{$self->{attr}}) {
       $attr .= (Net::FCP::touc $k) . "=$v\012"
    }
    if (defined $data) {
-      $attr .= "DataLength=" . (length $data) . "\012";
+      $attr .= sprintf "DataLength=%x\012", length $data;
       $data = "Data\012$data";
    } else {
       $data = "EndMessage\012";
    }
       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}
+      . (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);
 =item $result = $txn->result
 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
 sub result {
    my ($self) = @_;
 use base Net::FCP::Txn;
 sub rcv_success {
    my ($self, $attr) = @_;
-   $self->set_result ($attr);
+   $self->set_result ($attr->{uri});
 }
 package Net::FCP::Txn::GenerateSVKPair;
 use base Net::FCP::Txn;
 use base Net::FCP::Txn;
 sub rcv_success {
    my ($self, $attr) = @_;
-   $self->set_result ($attr->{Length});
+   $self->set_result (hex $attr->{Length});
 }
 package Net::FCP::Txn::GetPut;
 # base class for get and put
 sub rcv_data {
    my ($self, $chunk) = @_;
    $self->{data} .= $chunk;
-   $self->progress ("data", { chunk => length $chunk, total => length $self->{data}, end => $self->{datalength} });
+   $self->progress ("data", { chunk => length $chunk, received => length $self->{data}, total => $self->{datalength} });
    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]);
+      $self->eof;
    }
 }
 sub rcv_data_found {
    my ($self, $attr, $type) = @_;
 package Net::FCP::Exception;
 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
 Create a new exception object of the given type (a string like
  Marc Lehmann <pcg@goof.com>
  http://www.goof.com/pcg/marc/
 =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;

Diff Legend

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

Comparing Net-FCP/FCP.pm (file contents): Revision 1.17 by root, Fri Sep 12 03:28:45 2003 UTC vs. Revision 1.23 by root, Wed Sep 17 08:57:32 2003 UTC

Diff Legend

Comparing Net-FCP/FCP.pm (file contents):
Revision 1.17 by root, Fri Sep 12 03:28:45 2003 UTC vs.
Revision 1.23 by root, Wed Sep 17 08:57:32 2003 UTC