File Coverage

blib/lib/Net/BitTorrent/Version.pm

Criterion	Covered	Total	%
statement	13	13	100.0
branch	2	2	100.0
condition			n/a
subroutine	5	5	100.0
pod	2	2	100.0
total	22	22	100.0

#!/usr/bin/perl -w
package Net::BitTorrent::Version;
{
    use strict;
    use warnings;
    use version qw[qv];
    our $VERSION_BASE = 52; our $UNSTABLE_RELEASE = 0; our $VERSION = sprintf(($UNSTABLE_RELEASE ? q[%.3f_%03d] : q[%.3f]), (version->new(($VERSION_BASE))->numify / 1000), $UNSTABLE_RELEASE);
    our $PRODUCT_TOKEN = qq[Net::BitTorrent $VERSION];

    sub gen_peerid {
        return pack(
            q[a20],
            (sprintf(
                 q[NB%03d%1s-%8s%5s],
                 $VERSION_BASE,
                 ($UNSTABLE_RELEASE ? q[U] : q[S]),
                 (join q[],
                  map {
                      [q[A] .. q[Z], q[a] .. q[z], 0 .. 9, qw[- . _ ~]]
                      ->[rand(66)]
                      } 1 .. 8
                 ),
                 q[Riana]
             )
            )
        );
    }

    sub gen_node_id {
        return pack(q[H40], join(q[], map { rand(12) } 1 .. 40));
    }
    1;
}

=pod

=head1 NAME

Net::BitTorrent::Version - Net::BitTorrent's project-wide version numbers

=head1 DESCRIPTION

Because of the problems coordinating revision numbers in a distributed
version control system and across a directory full of Perl modules, this
module provides a central location for the project's overall release
number, the version string provided in Extended Protocol handshakes,
and the Peer ID generator.

=head1 Methods

=head2 C

Returns a random 20-byte string that can be used to identify ourself in a
DHT swarm.

=head2 C

Generates a unique Peer ID based on Net::BitTorrent's
L.

=head1 Peer ID Specification

This section describes and provides examples of the Peer ID format used
by this release of the C module.

=head2 Overview

This non-standard format was developed to be URL-safe, unique to the
implementation, and "human parsable."

There are two distinct sections to the Peer IDs generated: the
L which may be used to identify the software and its
version, and the L which is... well, it's junk.
Consider this example:

 NB004S-rogzGB1v--git

Here, C is the header and C<-rogzGB1v--git> is the trailing
signature.

=head3 Header

The header consists of two uppercase characters ('C') followed by
three digits (with leading zeros) representing the distribution version
and a single character used to (potentially) indicate stability:
Ctable or Cnstable.  Any deviation from this indicates a bad
client.  Recent stable builds will be found on CPAN.

=head3 Signature

The remainder of the Peer ID is a hyphen followed by 13 random characters
in the following range:

 ABCDEFGHIJKLMNOPQRSTUVWXYZabcdefghijklmnopqrstuvwxyz0123456789-._~

That is, all uppercase and lowercase letters, decimal digits, as well as
the hyphen, period, underscore, and tilde (66 total).  These are all
characters allowed in a URL without being encoded (referred to as
"Unreserved Characters" in L).

=head2 Version Numbers and Stability

Distribution version numbers will be some value less than one (C<1>) with
the revision number in the three significant decimal places.

Recent stable builds will be found on CPAN.  Unstable builds will most
likely be private builds or temporary uploads to CPAN where the package
name matches C.  See the PAUSE FAQ section entitled
"Developer Releases" (L).

=head2 Examples

=over

=item C

This would be the stable CPAN-ready release C.  The C<--git>
signature does not imply an unstable build.

=item C3BT>

Improper Peer ID; the sixth char is neither 'C' nor 'C' and E
is a reserved character according to L.

=item C

Completely legal Peer ID generated by unstable build around C.

=back

=head1 See Also

XRFC 3986 (URI: Generic Syntax)
Section 2.3. "Unreserved Characters"
(http://tools.ietf.org/html/rfc3986#section-2.3)

PAUSE FAQ sub-section entitled "Developer Releases"
(http://www.cpan.org/modules/04pause.html)

http://slashdot.org/comments.pl?sid=997033&cid=25390887

=head1 Disclaimer

This document and the specification behind it are subject to change.
All modifications will be documented in the Changes file included with
this distribution.  All versions of this file can be found in the
project's git repository.

=head1 Author

Sanko Robinson  - http://sankorobinson.com/

CPAN ID: SANKO

=head1 License and Legal

Copyright (C) 2008-2009 by Sanko Robinson [e-mail]

This program is free software; you can redistribute it and/or modify
it under the terms of The Artistic License 2.0.  See the F
file included with this distribution or
http://www.perlfoundation.org/artistic_license_2_0.  For
clarification, see http://www.perlfoundation.org/artistic_2_0_notes.

When separated from the distribution, all POD documentation is covered
by the Creative Commons Attribution-Share Alike 3.0 License.  See
http://creativecommons.org/licenses/by-sa/3.0/us/legalcode.  For
clarification, see http://creativecommons.org/licenses/by-sa/3.0/us/.

Neither this module nor the L is affiliated with
BitTorrent, Inc.

=for svn $Id: Version.pm 07f0c35 2010-04-02 18:31:29Z [e-mail] $

=cut