summaryrefslogtreecommitdiff
path: root/Master/tlpkg/tlperl/site/lib/LWP
diff options
context:
space:
mode:
authorKarl Berry <karl@freefriends.org>2017-04-18 23:10:57 +0000
committerKarl Berry <karl@freefriends.org>2017-04-18 23:10:57 +0000
commit40b4b6e177c62a14c166dbba6adf3abc415af4b2 (patch)
tree2996bf29509c806bd8064fb6cf38092c1b375ff8 /Master/tlpkg/tlperl/site/lib/LWP
parent8e743c86b6872f30b7a35c72aa944455157d4b3f (diff)
tlperl 5.24.1 from siep
git-svn-id: svn://tug.org/texlive/trunk@43914 c570f23f-e606-0410-a88d-b1316a301751
Diffstat (limited to 'Master/tlpkg/tlperl/site/lib/LWP')
-rw-r--r--Master/tlpkg/tlperl/site/lib/LWP/Authen/Basic.pm1
-rw-r--r--Master/tlpkg/tlperl/site/lib/LWP/Authen/Digest.pm4
-rw-r--r--Master/tlpkg/tlperl/site/lib/LWP/Authen/Ntlm.pm45
-rw-r--r--Master/tlpkg/tlperl/site/lib/LWP/ConnCache.pm111
-rw-r--r--Master/tlpkg/tlperl/site/lib/LWP/Debug.pm83
-rw-r--r--Master/tlpkg/tlperl/site/lib/LWP/Debug/TraceHTTP.pm26
-rw-r--r--Master/tlpkg/tlperl/site/lib/LWP/DebugFile.pm2
-rw-r--r--Master/tlpkg/tlperl/site/lib/LWP/MemberMixin.pm22
-rw-r--r--Master/tlpkg/tlperl/site/lib/LWP/Protocol.pm128
-rw-r--r--Master/tlpkg/tlperl/site/lib/LWP/Protocol/GHTTP.pm73
-rw-r--r--Master/tlpkg/tlperl/site/lib/LWP/Protocol/cpan.pm12
-rw-r--r--Master/tlpkg/tlperl/site/lib/LWP/Protocol/data.pm12
-rw-r--r--Master/tlpkg/tlperl/site/lib/LWP/Protocol/file.pm23
-rw-r--r--Master/tlpkg/tlperl/site/lib/LWP/Protocol/ftp.pm647
-rw-r--r--Master/tlpkg/tlperl/site/lib/LWP/Protocol/gopher.pm16
-rw-r--r--Master/tlpkg/tlperl/site/lib/LWP/Protocol/http.pm22
-rw-r--r--Master/tlpkg/tlperl/site/lib/LWP/Protocol/loopback.pm6
-rw-r--r--Master/tlpkg/tlperl/site/lib/LWP/Protocol/mailto.pm29
-rw-r--r--Master/tlpkg/tlperl/site/lib/LWP/Protocol/nntp.pm129
-rw-r--r--Master/tlpkg/tlperl/site/lib/LWP/Protocol/nogo.pm11
-rw-r--r--Master/tlpkg/tlperl/site/lib/LWP/RobotUA.pm77
-rw-r--r--Master/tlpkg/tlperl/site/lib/LWP/Simple.pm94
-rw-r--r--Master/tlpkg/tlperl/site/lib/LWP/UserAgent.pm1212
23 files changed, 1473 insertions, 1312 deletions
diff --git a/Master/tlpkg/tlperl/site/lib/LWP/Authen/Basic.pm b/Master/tlpkg/tlperl/site/lib/LWP/Authen/Basic.pm
index e7815bd247f..18fe8cd5f1c 100644
--- a/Master/tlpkg/tlperl/site/lib/LWP/Authen/Basic.pm
+++ b/Master/tlpkg/tlperl/site/lib/LWP/Authen/Basic.pm
@@ -1,4 +1,5 @@
package LWP::Authen::Basic;
+$LWP::Authen::Basic::VERSION = '6.25';
use strict;
require MIME::Base64;
diff --git a/Master/tlpkg/tlperl/site/lib/LWP/Authen/Digest.pm b/Master/tlpkg/tlperl/site/lib/LWP/Authen/Digest.pm
index 6fe542e29b3..2e80af49729 100644
--- a/Master/tlpkg/tlperl/site/lib/LWP/Authen/Digest.pm
+++ b/Master/tlpkg/tlperl/site/lib/LWP/Authen/Digest.pm
@@ -1,5 +1,5 @@
package LWP::Authen::Digest;
-
+$LWP::Authen::Digest::VERSION = '6.25';
use strict;
use base 'LWP::Authen::Basic';
@@ -59,7 +59,7 @@ sub auth_header {
for (@order) {
next unless defined $resp{$_};
- # RFC2617 sais that qop-value and nc-value should be unquoted.
+ # RFC2617 says that qop-value and nc-value should be unquoted.
if ( $_ eq 'qop' || $_ eq 'nc' ) {
push(@pairs, "$_=" . $resp{$_});
}
diff --git a/Master/tlpkg/tlperl/site/lib/LWP/Authen/Ntlm.pm b/Master/tlpkg/tlperl/site/lib/LWP/Authen/Ntlm.pm
index 7cdbf34ef57..7fd0a827f3d 100644
--- a/Master/tlpkg/tlperl/site/lib/LWP/Authen/Ntlm.pm
+++ b/Master/tlpkg/tlperl/site/lib/LWP/Authen/Ntlm.pm
@@ -1,9 +1,8 @@
package LWP::Authen::Ntlm;
use strict;
-use vars qw/$VERSION/;
-$VERSION = "6.15";
+our $VERSION = '6.25';
use Authen::NTLM "1.02";
use MIME::Base64 "2.12";
@@ -32,9 +31,9 @@ sub authenticate {
my $auth_header = $proxy ? "Proxy-Authorization" : "Authorization";
- # my ($challenge) = $response->header('WWW-Authenticate');
+ # my ($challenge) = $response->header('WWW-Authenticate');
my $challenge;
- foreach ($response->header('WWW-Authenticate')) {
+ foreach ($response->header('WWW-Authenticate')) {
last if /^NTLM/ && ($challenge=$_);
}
@@ -62,7 +61,7 @@ sub authenticate {
$referral->header($auth_header => $auth_value);
return $ua->request($referral, $arg, $size, $response);
}
-
+
else {
# Second phase, use the response challenge (unless non-401 code
# was returned, in which case, we just send back the response
@@ -73,7 +72,7 @@ sub authenticate {
}
else {
my $challenge;
- foreach ($response->header('WWW-Authenticate')) {
+ foreach ($response->header('WWW-Authenticate')) {
last if /^NTLM/ && ($challenge=$_);
}
$challenge =~ s/^NTLM //;
@@ -90,7 +89,9 @@ sub authenticate {
}
1;
+__END__
+=pod
=head1 NAME
@@ -116,26 +117,26 @@ LWP::Authen::Ntlm - Library for enabling NTLM authentication (Microsoft) in LWP
=head1 DESCRIPTION
-C<LWP::Authen::Ntlm> allows LWP to authenticate against servers that are using the
-NTLM authentication scheme popularized by Microsoft. This type of authentication is
+L<LWP::Authen::Ntlm> allows LWP to authenticate against servers that are using the
+NTLM authentication scheme popularized by Microsoft. This type of authentication is
common on intranets of Microsoft-centric organizations.
-The module takes advantage of the Authen::NTLM module by Mark Bush. Since there
-is also another Authen::NTLM module available from CPAN by Yee Man Chan with an
-entirely different interface, it is necessary to ensure that you have the correct
+The module takes advantage of the Authen::NTLM module by Mark Bush. Since there
+is also another Authen::NTLM module available from CPAN by Yee Man Chan with an
+entirely different interface, it is necessary to ensure that you have the correct
NTLM module.
-In addition, there have been problems with incompatibilities between different
-versions of Mime::Base64, which Bush's Authen::NTLM makes use of. Therefore, it is
-necessary to ensure that your Mime::Base64 module supports exporting of the
+In addition, there have been problems with incompatibilities between different
+versions of Mime::Base64, which Bush's Authen::NTLM makes use of. Therefore, it is
+necessary to ensure that your Mime::Base64 module supports exporting of the
encode_base64 and decode_base64 functions.
=head1 USAGE
-The module is used indirectly through LWP, rather than including it directly in your
-code. The LWP system will invoke the NTLM authentication when it encounters the
-authentication scheme while attempting to retrieve a URL from a server. In order
-for the NTLM authentication to work, you must have a few things set up in your
+The module is used indirectly through LWP, rather than including it directly in your
+code. The LWP system will invoke the NTLM authentication when it encounters the
+authentication scheme while attempting to retrieve a URL from a server. In order
+for the NTLM authentication to work, you must have a few things set up in your
code prior to attempting to retrieve the URL:
=over 4
@@ -156,9 +157,9 @@ The credentials must be set like this:
$ua->credentials('www.company.com:80', '', "MyDomain\\MyUserCode", 'MyPassword');
-Note that you cannot use the HTTP::Request object's authorization_basic() method to set
-the credentials. Note, too, that the 'www.company.com:80' portion only sets credentials
-on the specified port AND it is case-sensitive (this is due to the way LWP is coded, and
+Note that you cannot use the HTTP::Request object's authorization_basic() method to set
+the credentials. Note, too, that the 'www.company.com:80' portion only sets credentials
+on the specified port AND it is case-sensitive (this is due to the way LWP is coded, and
has nothing to do with LWP::Authen::Ntlm)
=back
@@ -178,3 +179,5 @@ under the same terms as Perl itself.
=head1 SEE ALSO
L<LWP>, L<LWP::UserAgent>, L<lwpcook>.
+
+=cut
diff --git a/Master/tlpkg/tlperl/site/lib/LWP/ConnCache.pm b/Master/tlpkg/tlperl/site/lib/LWP/ConnCache.pm
index 9c7753db8de..172e2f49a5b 100644
--- a/Master/tlpkg/tlperl/site/lib/LWP/ConnCache.pm
+++ b/Master/tlpkg/tlperl/site/lib/LWP/ConnCache.pm
@@ -1,10 +1,9 @@
package LWP::ConnCache;
use strict;
-use vars qw($VERSION $DEBUG);
-
-$VERSION = "6.15";
+our $VERSION = '6.25';
+our $DEBUG;
sub new {
my($class, %cnf) = @_;
@@ -169,6 +168,8 @@ sub _looks_like_number {
__END__
+=pod
+
=head1 NAME
LWP::ConnCache - Connection cache manager
@@ -188,32 +189,58 @@ change in the future.
=head1 DESCRIPTION
The C<LWP::ConnCache> class is the standard connection cache manager
-for LWP::UserAgent.
+for L<LWP::UserAgent>.
+
+=head1 METHODS
The following basic methods are provided:
-=over
+=head2 new
+
+ my $cache = LWP::ConnCache->new( %options )
-=item $cache = LWP::ConnCache->new( %options )
+This method constructs a new L<LWP::ConnCache> object. The only
+option currently accepted is C<total_capacity>. If specified it
+initialize the L<LWP::ConnCache/total_capacity> option. It defaults to C<1>.
-This method constructs a new C<LWP::ConnCache> object. The only
-option currently accepted is 'total_capacity'. If specified it
-initialize the total_capacity option. It defaults to the value 1.
+=head2 total_capacity
-=item $cache->total_capacity( [$num_connections] )
+ my $cap = $cache->total_capacity;
+ $cache->total_capacity(0); # drop all immediately
+ $cache->total_capacity(undef); # no limit
+ $cache->total_capacity($number);
Get/sets the number of connection that will be cached. Connections
will start to be dropped when this limit is reached. If set to C<0>,
then all connections are immediately dropped. If set to C<undef>,
then there is no limit.
-=item $cache->capacity($type, [$num_connections] )
+=head2 capacity
+
+ my $http_capacity = $cache->capacity('http');
+ $cache->capacity('http', 2 );
Get/set a limit for the number of connections of the specified type
-that can be cached. The $type will typically be a short string like
+that can be cached. The first parameter is a short string like
"http" or "ftp".
-=item $cache->drop( [$checker, [$reason]] )
+=head2 drop
+
+ $cache->drop(); # Drop ALL connections
+ # which is just a synonym for:
+ $cache->drop(sub{1}); # Drop ALL connections
+ # drop all connections older than 22 seconds and add a reason for it!
+ $cache->drop(22, "Older than 22 secs dropped");
+ # which is just a synonym for:
+ $cache->drop(sub {
+ my ($conn, $type, $key, $deposit_time) = @_;
+ if ($deposit_time < 22) {
+ # true values drop the connection
+ return 1;
+ }
+ # false values don't drop the connection
+ return 0;
+ }, "Older than 22 secs dropped" );
Drop connections by some criteria. The $checker argument is a
subroutine that is called for each connection. If the routine returns
@@ -226,41 +253,49 @@ connections untouched that the given number of seconds or more are
dropped. If $checker is a string then all connections of the given
type are dropped.
-The $reason argument is passed on to the dropped() method.
+The C<reason> is passed on to the L<LWP::ConnCache/dropped> method.
+
+=head2 prune
-=item $cache->prune
+ $cache->prune();
Calling this method will drop all connections that are dead. This is
-tested by calling the ping() method on the connections. If the ping()
-method exists and returns a FALSE value, then the connection is
-dropped.
+tested by calling the L<LWP::ConnCache/ping> method on the connections. If
+the L<LWP::ConnCache/ping> method exists and returns a false value, then the
+connection is dropped.
+
+=head2 get_types
-=item $cache->get_types
+ my @types = $cache->get_types();
-This returns all the 'type' fields used for the currently cached
+This returns all the C<type> fields used for the currently cached
connections.
-=item $cache->get_connections( [$type] )
+=head2 get_connections
+
+ my @conns = $cache->get_connections(); # all connections
+ my @conns = $cache->get_connections('http'); # connections for http
This returns all connection objects of the specified type. If no type
is specified then all connections are returned. In scalar context the
number of cached connections of the specified type is returned.
-=back
-
+=head1 PROTOCOL METHODS
The following methods are called by low-level protocol modules to
try to save away connections and to get them back.
-=over
+=head2 deposit
-=item $cache->deposit($type, $key, $conn)
+ $cache->deposit($type, $key, $conn);
-This method adds a new connection to the cache. As a result other
+This method adds a new connection to the cache. As a result, other
already cached connections might be dropped. Multiple connections with
-the same $type/$key might added.
+the same type/key might be added.
+
+=head2 withdraw
-=item $conn = $cache->withdraw($type, $key)
+ my $conn = $cache->withdraw($type, $key);
This method tries to fetch back a connection that was previously
deposited. If no cached connection with the specified $type/$key is
@@ -268,35 +303,35 @@ found, then C<undef> is returned. There is not guarantee that a
deposited connection can be withdrawn, as the cache manger is free to
drop connections at any time.
-=back
+=head1 INTERNAL METHODS
The following methods are called internally. Subclasses might want to
override them.
-=over
+=head2 enforce_limits
-=item $conn->enforce_limits([$type])
+ $conn->enforce_limits([$type])
This method is called with after a new connection is added (deposited)
in the cache or capacity limits are adjusted. The default
implementation drops connections until the specified capacity limits
are not exceeded.
-=item $conn->dropping($conn_record, $reason)
+=head2 dropping
+
+ $conn->dropping($conn_record, $reason)
This method is called when a connection is dropped. The record
belonging to the dropped connection is passed as the first argument
and a string describing the reason for the drop is passed as the
second argument. The default implementation makes some noise if the
-$LWP::ConnCache::DEBUG variable is set and nothing more.
-
-=back
+C<$LWP::ConnCache::DEBUG> variable is set and nothing more.
=head1 SUBCLASSING
For specialized cache policy it makes sense to subclass
-C<LWP::ConnCache> and perhaps override the deposit(), enforce_limits()
-and dropping() methods.
+C<LWP::ConnCache> and perhaps override the L<LWP::ConnCache/deposit>,
+L<LWP::ConnCache/enforce_limits>, and L<LWP::ConnCache/dropping> methods.
The object itself is a hash. Keys prefixed with C<cc_> are reserved
for the base class.
@@ -311,3 +346,5 @@ Copyright 2001 Gisle Aas.
This library is free software; you can redistribute it and/or
modify it under the same terms as Perl itself.
+
+=cut
diff --git a/Master/tlpkg/tlperl/site/lib/LWP/Debug.pm b/Master/tlpkg/tlperl/site/lib/LWP/Debug.pm
index 99011d57ab7..f7334c425df 100644
--- a/Master/tlpkg/tlperl/site/lib/LWP/Debug.pm
+++ b/Master/tlpkg/tlperl/site/lib/LWP/Debug.pm
@@ -1,65 +1,58 @@
-package LWP::Debug; # legacy
-
+package LWP::Debug; # legacy
+$LWP::Debug::VERSION = '6.25';
require Exporter;
-@ISA = qw(Exporter);
-@EXPORT_OK = qw(level trace debug conns);
+our @ISA = qw(Exporter);
+our @EXPORT_OK = qw(level trace debug conns);
use Carp ();
my @levels = qw(trace debug conns);
-%current_level = ();
-
+our %current_level = ();
-sub import
-{
- my $pack = shift;
+sub import {
+ my $pack = shift;
my $callpkg = caller(0);
my @symbols = ();
- my @levels = ();
+ my @levels = ();
for (@_) {
- if (/^[-+]/) {
- push(@levels, $_);
- }
- else {
- push(@symbols, $_);
- }
+ if (/^[-+]/) {
+ push(@levels, $_);
+ }
+ else {
+ push(@symbols, $_);
+ }
}
Exporter::export($pack, $callpkg, @symbols);
level(@levels);
}
-
-sub level
-{
+sub level {
for (@_) {
- if ($_ eq '+') { # all on
- # switch on all levels
- %current_level = map { $_ => 1 } @levels;
- }
- elsif ($_ eq '-') { # all off
- %current_level = ();
- }
- elsif (/^([-+])(\w+)$/) {
- $current_level{$2} = $1 eq '+';
- }
- else {
- Carp::croak("Illegal level format $_");
- }
+ if ($_ eq '+') { # all on
+ # switch on all levels
+ %current_level = map { $_ => 1 } @levels;
+ }
+ elsif ($_ eq '-') { # all off
+ %current_level = ();
+ }
+ elsif (/^([-+])(\w+)$/) {
+ $current_level{$2} = $1 eq '+';
+ }
+ else {
+ Carp::croak("Illegal level format $_");
+ }
}
}
+sub trace { _log(@_) if $current_level{'trace'}; }
+sub debug { _log(@_) if $current_level{'debug'}; }
+sub conns { _log(@_) if $current_level{'conns'}; }
-sub trace { _log(@_) if $current_level{'trace'}; }
-sub debug { _log(@_) if $current_level{'debug'}; }
-sub conns { _log(@_) if $current_level{'conns'}; }
-
-
-sub _log
-{
+sub _log {
my $msg = shift;
- $msg .= "\n" unless $msg =~ /\n$/; # ensure trailing "\n"
+ $msg .= "\n" unless $msg =~ /\n$/; # ensure trailing "\n"
- my($package,$filename,$line,$sub) = caller(2);
+ my ($package, $filename, $line, $sub) = caller(2);
print STDERR "$sub: $msg";
}
@@ -67,6 +60,8 @@ sub _log
__END__
+=pod
+
=head1 NAME
LWP::Debug - deprecated
@@ -85,8 +80,8 @@ section provides some hints about recommended replacements.
=head2 Network traffic monitoring
The best way to monitor the network traffic that LWP generates is to
-use an external TCP monitoring program. The Wireshark program
-(L<http://www.wireshark.org/>) is highly recommended for this.
+use an external TCP monitoring program. The
+L<WireShark|http://www.wireshark.org/> program is highly recommended for this.
Another approach it to use a debugging HTTP proxy server and make
LWP direct all its traffic via this one. Call C<< $ua->proxy >> to
@@ -108,3 +103,5 @@ request and response objects that pass through LWP:
=head1 SEE ALSO
L<LWP::UserAgent>
+
+=cut
diff --git a/Master/tlpkg/tlperl/site/lib/LWP/Debug/TraceHTTP.pm b/Master/tlpkg/tlperl/site/lib/LWP/Debug/TraceHTTP.pm
new file mode 100644
index 00000000000..4dc70a096f7
--- /dev/null
+++ b/Master/tlpkg/tlperl/site/lib/LWP/Debug/TraceHTTP.pm
@@ -0,0 +1,26 @@
+package LWP::Debug::TraceHTTP;
+$LWP::Debug::TraceHTTP::VERSION = '6.25';
+# Just call:
+#
+# require LWP::Debug::TraceHTTP;
+# LWP::Protocol::implementor('http', 'LWP::Debug::TraceHTTP');
+#
+# to use this module to trace all calls to the HTTP socket object in
+# programs that use LWP.
+
+use strict;
+use base 'LWP::Protocol::http';
+
+package LWP::Debug::TraceHTTP::Socket;
+$LWP::Debug::TraceHTTP::Socket::VERSION = '6.25';
+use Data::Dump 1.13;
+use Data::Dump::Trace qw(autowrap mcall);
+
+autowrap("LWP::Protocol::http::Socket" => "sock");
+
+sub new {
+ my $class = shift;
+ return mcall("LWP::Protocol::http::Socket" => "new", undef, @_);
+}
+
+1;
diff --git a/Master/tlpkg/tlperl/site/lib/LWP/DebugFile.pm b/Master/tlpkg/tlperl/site/lib/LWP/DebugFile.pm
index aacdfca0fe5..681415f4ccd 100644
--- a/Master/tlpkg/tlperl/site/lib/LWP/DebugFile.pm
+++ b/Master/tlpkg/tlperl/site/lib/LWP/DebugFile.pm
@@ -1,5 +1,5 @@
package LWP::DebugFile;
-
+$LWP::DebugFile::VERSION = '6.25';
# legacy stub
1;
diff --git a/Master/tlpkg/tlperl/site/lib/LWP/MemberMixin.pm b/Master/tlpkg/tlperl/site/lib/LWP/MemberMixin.pm
index e5ee6f6382e..d56a2e8abad 100644
--- a/Master/tlpkg/tlperl/site/lib/LWP/MemberMixin.pm
+++ b/Master/tlpkg/tlperl/site/lib/LWP/MemberMixin.pm
@@ -1,10 +1,9 @@
package LWP::MemberMixin;
-
-sub _elem
-{
+$LWP::MemberMixin::VERSION = '6.25';
+sub _elem {
my $self = shift;
my $elem = shift;
- my $old = $self->{$elem};
+ my $old = $self->{$elem};
$self->{$elem} = shift if @_;
return $old;
}
@@ -13,6 +12,8 @@ sub _elem
__END__
+=pod
+
=head1 NAME
LWP::MemberMixin - Member access mixin class
@@ -20,20 +21,21 @@ LWP::MemberMixin - Member access mixin class
=head1 SYNOPSIS
package Foo;
- require LWP::MemberMixin;
- @ISA=qw(LWP::MemberMixin);
+ use base qw(LWP::MemberMixin);
=head1 DESCRIPTION
A mixin class to get methods that provide easy access to member
-variables in the %$self.
+variables in the C<%$self>.
Ideally there should be better Perl language support for this.
+=head1 METHODS
+
There is only one method provided:
-=over 4
+=head2 _elem
-=item _elem($elem [, $val])
+ _elem($elem [, $val])
Internal method to get/set the value of member variable
C<$elem>. If C<$val> is present it is used as the new value
@@ -41,4 +43,4 @@ for the member variable. If it is not present the current
value is not touched. In both cases the previous value of
the member variable is returned.
-=back
+=cut
diff --git a/Master/tlpkg/tlperl/site/lib/LWP/Protocol.pm b/Master/tlpkg/tlperl/site/lib/LWP/Protocol.pm
index 626bb005c83..3adbaf3de49 100644
--- a/Master/tlpkg/tlperl/site/lib/LWP/Protocol.pm
+++ b/Master/tlpkg/tlperl/site/lib/LWP/Protocol.pm
@@ -1,18 +1,17 @@
package LWP::Protocol;
-require LWP::MemberMixin;
-@ISA = qw(LWP::MemberMixin);
-$VERSION = "6.15";
+use base 'LWP::MemberMixin';
+
+our $VERSION = '6.25';
use strict;
use Carp ();
use HTTP::Status ();
-use HTTP::Response;
+use HTTP::Response ();
+use Try::Tiny qw(try catch);
my %ImplementedBy = (); # scheme => classname
-
-
sub new
{
my($class, $scheme, $ua) = @_;
@@ -62,16 +61,21 @@ sub implementor
no strict 'refs';
# check we actually have one for the scheme:
unless (@{"${ic}::ISA"}) {
- # try to autoload it
- eval "require $ic";
- if ($@) {
- if ($@ =~ /Can't locate/) { #' #emacs get confused by '
- $ic = '';
- }
- else {
- die "$@\n";
- }
- }
+ # try to autoload it
+ try {
+ (my $class = $ic) =~ s{::}{/}g;
+ $class .= '.pm' unless $class =~ /\.pm$/;
+ require $class;
+ }
+ catch {
+ my $error = $_;
+ if ($error =~ /Can't locate/) {
+ $ic = '';
+ }
+ else {
+ die "$error\n";
+ }
+ };
}
$ImplementedBy{$scheme} = $ic if $ic;
$ic;
@@ -96,8 +100,8 @@ sub collect
my $content;
my($ua, $max_size) = @{$self}{qw(ua max_size)};
- eval {
- local $\; # protect the print below from surprises
+ try {
+ local $\; # protect the print below from surprises
if (!defined($arg) || !$response->is_success) {
$response->{default_add_content} = 1;
}
@@ -160,17 +164,15 @@ sub collect
last;
}
}
+ }
+ catch {
+ my $error = $_;
+ chomp($error);
+ $response->push_header('X-Died' => $error);
+ $response->push_header("Client-Aborted", "die");
};
- my $err = $@;
delete $response->{handlers}{response_data};
delete $response->{handlers} unless %{$response->{handlers}};
- if ($err) {
- chomp($err);
- $response->push_header('X-Died' => $err);
- $response->push_header("Client-Aborted", "die");
- return $response;
- }
-
return $response;
}
@@ -191,6 +193,8 @@ sub collect_once
__END__
+=pod
+
=head1 NAME
LWP::Protocol - Base class for LWP protocols
@@ -198,85 +202,93 @@ LWP::Protocol - Base class for LWP protocols
=head1 SYNOPSIS
package LWP::Protocol::foo;
- require LWP::Protocol;
- @ISA=qw(LWP::Protocol);
+ use base qw(LWP::Protocol);
=head1 DESCRIPTION
-This class is used a the base class for all protocol implementations
+This class is used as the base class for all protocol implementations
supported by the LWP library.
When creating an instance of this class using
C<LWP::Protocol::create($url)>, and you get an initialized subclass
appropriate for that access method. In other words, the
-LWP::Protocol::create() function calls the constructor for one of its
+L<LWP::Protocol/create> function calls the constructor for one of its
subclasses.
-All derived LWP::Protocol classes need to override the request()
+All derived C<LWP::Protocol> classes need to override the request()
method which is used to service a request. The overridden method can
make use of the collect() function to collect together chunks of data
as it is received.
+=head1 METHODS
+
The following methods and functions are provided:
-=over 4
+=head2 new
-=item $prot = LWP::Protocol->new()
+ my $prot = LWP::Protocol->new();
The LWP::Protocol constructor is inherited by subclasses. As this is a
virtual base class this method should B<not> be called directly.
-=item $prot = LWP::Protocol::create($scheme)
+=head2 create
+
+ my $prot = LWP::Protocol::create($scheme)
Create an object of the class implementing the protocol to handle the
given scheme. This is a function, not a method. It is more an object
factory than a constructor. This is the function user agents should
use to access protocols.
-=item $class = LWP::Protocol::implementor($scheme, [$class])
+=head2 implementor
+
+ my $class = LWP::Protocol::implementor($scheme, [$class])
-Get and/or set implementor class for a scheme. Returns '' if the
+Get and/or set implementor class for a scheme. Returns C<''> if the
specified scheme is not supported.
-=item $prot->request(...)
+=head2 request
- $response = $protocol->request($request, $proxy, undef);
- $response = $protocol->request($request, $proxy, '/tmp/sss');
- $response = $protocol->request($request, $proxy, \&callback, 1024);
+ $response = $protocol->request($request, $proxy, undef);
+ $response = $protocol->request($request, $proxy, '/tmp/sss');
+ $response = $protocol->request($request, $proxy, \&callback, 1024);
Dispatches a request over the protocol, and returns a response
object. This method needs to be overridden in subclasses. Refer to
L<LWP::UserAgent> for description of the arguments.
-=item $prot->collect($arg, $response, $collector)
+=head2 collect
-Called to collect the content of a request, and process it
-appropriately into a scalar, file, or by calling a callback. If $arg
-is undefined, then the content is stored within the $response. If
-$arg is a simple scalar, then $arg is interpreted as a file name and
-the content is written to this file. If $arg is a reference to a
-routine, then content is passed to this routine.
+ my $res = $prot->collect(undef, $response, $collector); # stored in $response
+ my $res = $prot->collect($filename, $response, $collector);
+ my $res = $prot->collect(sub { ... }, $response, $collector);
-The $collector is a routine that will be called and which is
+Collect the content of a request, and process it appropriately into a scalar,
+file, or by calling a callback. If the first parameter is undefined, then the
+content is stored within the C<$response>. If it's a simple scalar, then it's
+interpreted as a file name and the content is written to this file. If it's a
+code reference, then content is passed to this routine.
+
+The collector is a routine that will be called and which is
responsible for returning pieces (as ref to scalar) of the content to
-process. The $collector signals EOF by returning a reference to an
+process. The C<$collector> signals C<EOF> by returning a reference to an
empty string.
-The return value from collect() is the $response object reference.
+The return value is the L<HTTP::Response> object reference.
B<Note:> We will only use the callback or file argument if
-$response->is_success(). This avoids sending content data for
+C<< $response->is_success() >>. This avoids sending content data for
redirects and authentication responses to the callback which would be
confusing.
-=item $prot->collect_once($arg, $response, $content)
+=head2 collect_once
-Can be called when the whole response content is available as
-$content. This will invoke collect() with a collector callback that
-returns a reference to $content the first time and an empty string the
-next.
+ $prot->collect_once($arg, $response, $content)
-=back
+Can be called when the whole response content is available as content. This
+will invoke L<LWP::Protocol/collect> with a collector callback that
+returns a reference to C<$content> the first time and an empty string the
+next.
=head1 SEE ALSO
@@ -289,3 +301,5 @@ Copyright 1995-2001 Gisle Aas.
This library is free software; you can redistribute it and/or
modify it under the same terms as Perl itself.
+
+=cut
diff --git a/Master/tlpkg/tlperl/site/lib/LWP/Protocol/GHTTP.pm b/Master/tlpkg/tlperl/site/lib/LWP/Protocol/GHTTP.pm
deleted file mode 100644
index 2a356b5fcb1..00000000000
--- a/Master/tlpkg/tlperl/site/lib/LWP/Protocol/GHTTP.pm
+++ /dev/null
@@ -1,73 +0,0 @@
-package LWP::Protocol::GHTTP;
-
-# You can tell LWP to use this module for 'http' requests by running
-# code like this before you make requests:
-#
-# require LWP::Protocol::GHTTP;
-# LWP::Protocol::implementor('http', 'LWP::Protocol::GHTTP');
-#
-
-use strict;
-use vars qw(@ISA);
-
-require LWP::Protocol;
-@ISA=qw(LWP::Protocol);
-
-require HTTP::Response;
-require HTTP::Status;
-
-use HTTP::GHTTP qw(METHOD_GET METHOD_HEAD METHOD_POST);
-
-my %METHOD =
-(
- GET => METHOD_GET,
- HEAD => METHOD_HEAD,
- POST => METHOD_POST,
-);
-
-sub request
-{
- my($self, $request, $proxy, $arg, $size, $timeout) = @_;
-
- my $method = $request->method;
- unless (exists $METHOD{$method}) {
- return HTTP::Response->new(&HTTP::Status::RC_BAD_REQUEST,
- "Bad method '$method'");
- }
-
- my $r = HTTP::GHTTP->new($request->uri);
-
- # XXX what headers for repeated headers here?
- $request->headers->scan(sub { $r->set_header(@_)});
-
- $r->set_type($METHOD{$method});
-
- # XXX should also deal with subroutine content.
- my $cref = $request->content_ref;
- $r->set_body($$cref) if length($$cref);
-
- # XXX is this right
- $r->set_proxy($proxy->as_string) if $proxy;
-
- $r->process_request;
-
- my $response = HTTP::Response->new($r->get_status);
-
- # XXX How can get the headers out of $r?? This way is too stupid.
- my @headers;
- eval {
- # Wrapped in eval because this method is not always available
- @headers = $r->get_headers;
- };
- @headers = qw(Date Connection Server Content-type
- Accept-Ranges Server
- Content-Length Last-Modified ETag) if $@;
- for (@headers) {
- my $v = $r->get_header($_);
- $response->header($_ => $v) if defined $v;
- }
-
- return $self->collect_once($arg, $response, $r->get_body);
-}
-
-1;
diff --git a/Master/tlpkg/tlperl/site/lib/LWP/Protocol/cpan.pm b/Master/tlpkg/tlperl/site/lib/LWP/Protocol/cpan.pm
index 66d8f213b98..3288abdbc12 100644
--- a/Master/tlpkg/tlperl/site/lib/LWP/Protocol/cpan.pm
+++ b/Master/tlpkg/tlperl/site/lib/LWP/Protocol/cpan.pm
@@ -1,10 +1,8 @@
package LWP::Protocol::cpan;
-
+$LWP::Protocol::cpan::VERSION = '6.25';
use strict;
-use vars qw(@ISA);
-require LWP::Protocol;
-@ISA = qw(LWP::Protocol);
+use base qw(LWP::Protocol);
require URI;
require HTTP::Status;
@@ -49,14 +47,14 @@ sub request {
# check proxy
if (defined $proxy)
{
- return HTTP::Response->new(&HTTP::Status::RC_BAD_REQUEST,
+ return HTTP::Response->new(HTTP::Status::RC_BAD_REQUEST,
'You can not proxy with cpan');
}
# check method
my $method = $request->method;
unless ($method eq 'GET' || $method eq 'HEAD') {
- return HTTP::Response->new(&HTTP::Status::RC_BAD_REQUEST,
+ return HTTP::Response->new(HTTP::Status::RC_BAD_REQUEST,
'Library does not allow method ' .
"$method for 'cpan:' URLs");
}
@@ -64,7 +62,7 @@ sub request {
my $path = $request->uri->path;
$path =~ s,^/,,;
- my $response = HTTP::Response->new(&HTTP::Status::RC_FOUND);
+ my $response = HTTP::Response->new(HTTP::Status::RC_FOUND);
$response->header("Location" => URI->new_abs($path, $CPAN));
$response;
}
diff --git a/Master/tlpkg/tlperl/site/lib/LWP/Protocol/data.pm b/Master/tlpkg/tlperl/site/lib/LWP/Protocol/data.pm
index c29c3b4f919..3b256528a4f 100644
--- a/Master/tlpkg/tlperl/site/lib/LWP/Protocol/data.pm
+++ b/Master/tlpkg/tlperl/site/lib/LWP/Protocol/data.pm
@@ -1,15 +1,13 @@
package LWP::Protocol::data;
-
+$LWP::Protocol::data::VERSION = '6.25';
# Implements access to data:-URLs as specified in RFC 2397
use strict;
-use vars qw(@ISA);
require HTTP::Response;
require HTTP::Status;
-require LWP::Protocol;
-@ISA = qw(LWP::Protocol);
+use base qw(LWP::Protocol);
use HTTP::Date qw(time2str);
require LWP; # needs version number
@@ -21,20 +19,20 @@ sub request
# check proxy
if (defined $proxy)
{
- return HTTP::Response->new( &HTTP::Status::RC_BAD_REQUEST,
+ return HTTP::Response->new( HTTP::Status::RC_BAD_REQUEST,
'You can not proxy with data');
}
# check method
my $method = $request->method;
unless ($method eq 'GET' || $method eq 'HEAD') {
- return HTTP::Response->new( &HTTP::Status::RC_BAD_REQUEST,
+ return HTTP::Response->new( HTTP::Status::RC_BAD_REQUEST,
'Library does not allow method ' .
"$method for 'data:' URLs");
}
my $url = $request->uri;
- my $response = HTTP::Response->new( &HTTP::Status::RC_OK, "Document follows");
+ my $response = HTTP::Response->new( HTTP::Status::RC_OK, "Document follows");
my $media_type = $url->media_type;
diff --git a/Master/tlpkg/tlperl/site/lib/LWP/Protocol/file.pm b/Master/tlpkg/tlperl/site/lib/LWP/Protocol/file.pm
index f2887f4b2f3..e83149dbd90 100644
--- a/Master/tlpkg/tlperl/site/lib/LWP/Protocol/file.pm
+++ b/Master/tlpkg/tlperl/site/lib/LWP/Protocol/file.pm
@@ -1,7 +1,6 @@
package LWP::Protocol::file;
-
-require LWP::Protocol;
-@ISA = qw(LWP::Protocol);
+$LWP::Protocol::file::VERSION = '6.25';
+use base qw(LWP::Protocol);
use strict;
@@ -21,14 +20,14 @@ sub request
# check proxy
if (defined $proxy)
{
- return HTTP::Response->new( &HTTP::Status::RC_BAD_REQUEST,
+ return HTTP::Response->new( HTTP::Status::RC_BAD_REQUEST,
'You can not proxy through the filesystem');
}
# check method
my $method = $request->method;
unless ($method eq 'GET' || $method eq 'HEAD') {
- return HTTP::Response->new( &HTTP::Status::RC_BAD_REQUEST,
+ return HTTP::Response->new( HTTP::Status::RC_BAD_REQUEST,
'Library does not allow method ' .
"$method for 'file:' URLs");
}
@@ -38,7 +37,7 @@ sub request
my $scheme = $url->scheme;
if ($scheme ne 'file') {
- return HTTP::Response->new( &HTTP::Status::RC_INTERNAL_SERVER_ERROR,
+ return HTTP::Response->new( HTTP::Status::RC_INTERNAL_SERVER_ERROR,
"LWP::Protocol::file::request called for '$scheme'");
}
@@ -47,11 +46,11 @@ sub request
# test file exists and is readable
unless (-e $path) {
- return HTTP::Response->new( &HTTP::Status::RC_NOT_FOUND,
+ return HTTP::Response->new( HTTP::Status::RC_NOT_FOUND,
"File `$path' does not exist");
}
unless (-r _) {
- return HTTP::Response->new( &HTTP::Status::RC_FORBIDDEN,
+ return HTTP::Response->new( HTTP::Status::RC_FORBIDDEN,
'User does not have read permission');
}
@@ -67,13 +66,13 @@ sub request
if (defined $ims) {
my $time = HTTP::Date::str2time($ims);
if (defined $time and $time >= $mtime) {
- return HTTP::Response->new( &HTTP::Status::RC_NOT_MODIFIED,
+ return HTTP::Response->new( HTTP::Status::RC_NOT_MODIFIED,
"$method $path");
}
}
# Ok, should be an OK response by now...
- my $response = HTTP::Response->new( &HTTP::Status::RC_OK );
+ my $response = HTTP::Response->new( HTTP::Status::RC_OK );
# fill in response headers
$response->header('Last-Modified', HTTP::Date::time2str($mtime));
@@ -81,7 +80,7 @@ sub request
if (-d _) { # If the path is a directory, process it
# generate the HTML for directory
opendir(D, $path) or
- return HTTP::Response->new( &HTTP::Status::RC_INTERNAL_SERVER_ERROR,
+ return HTTP::Response->new( HTTP::Status::RC_INTERNAL_SERVER_ERROR,
"Cannot read directory '$path': $!");
my(@files) = sort readdir(D);
closedir(D);
@@ -128,7 +127,7 @@ sub request
# read the file
if ($method ne "HEAD") {
open(F, $path) or return new
- HTTP::Response(&HTTP::Status::RC_INTERNAL_SERVER_ERROR,
+ HTTP::Response(HTTP::Status::RC_INTERNAL_SERVER_ERROR,
"Cannot read file '$path': $!");
binmode(F);
$response = $self->collect($arg, $response, sub {
diff --git a/Master/tlpkg/tlperl/site/lib/LWP/Protocol/ftp.pm b/Master/tlpkg/tlperl/site/lib/LWP/Protocol/ftp.pm
index f478c6ee732..2a96c1b7c55 100644
--- a/Master/tlpkg/tlperl/site/lib/LWP/Protocol/ftp.pm
+++ b/Master/tlpkg/tlperl/site/lib/LWP/Protocol/ftp.pm
@@ -1,115 +1,114 @@
package LWP::Protocol::ftp;
-
+$LWP::Protocol::ftp::VERSION = '6.25';
# Implementation of the ftp protocol (RFC 959). We let the Net::FTP
# package do all the dirty work.
+use base qw(LWP::Protocol);
+use strict;
-use Carp ();
-
-use HTTP::Status ();
+use Carp ();
+use HTTP::Status ();
use HTTP::Negotiate ();
-use HTTP::Response ();
+use HTTP::Response ();
use LWP::MediaTypes ();
-use File::Listing ();
+use File::Listing ();
-require LWP::Protocol;
-@ISA = qw(LWP::Protocol);
-use strict;
-eval {
+{
+
package LWP::Protocol::MyFTP;
+$LWP::Protocol::MyFTP::VERSION = '6.25';
+use strict;
+ use base qw(Net::FTP);
- require Net::FTP;
- Net::FTP->require_version(2.00);
+ sub new {
+ my $class = shift;
- use vars qw(@ISA);
- @ISA=qw(Net::FTP);
+ my $self = $class->SUPER::new(@_) || return undef;
- sub new {
- my $class = shift;
+ my $mess = $self->message; # welcome message
+ $mess =~ s|\n.*||s; # only first line left
+ $mess =~ s|\s*ready\.?$||;
- my $self = $class->SUPER::new(@_) || return undef;
+ # Make the version number more HTTP like
+ $mess =~ s|\s*\(Version\s*|/| and $mess =~ s|\)$||;
+ ${*$self}{myftp_server} = $mess;
- my $mess = $self->message; # welcome message
- $mess =~ s|\n.*||s; # only first line left
- $mess =~ s|\s*ready\.?$||;
- # Make the version number more HTTP like
- $mess =~ s|\s*\(Version\s*|/| and $mess =~ s|\)$||;
- ${*$self}{myftp_server} = $mess;
- #$response->header("Server", $mess);
+ #$response->header("Server", $mess);
- $self;
+ $self;
}
sub http_server {
- my $self = shift;
- ${*$self}{myftp_server};
+ my $self = shift;
+ ${*$self}{myftp_server};
}
sub home {
- my $self = shift;
- my $old = ${*$self}{myftp_home};
- if (@_) {
- ${*$self}{myftp_home} = shift;
- }
- $old;
+ my $self = shift;
+ my $old = ${*$self}{myftp_home};
+ if (@_) {
+ ${*$self}{myftp_home} = shift;
+ }
+ $old;
}
sub go_home {
- my $self = shift;
- $self->cwd(${*$self}{myftp_home});
+ my $self = shift;
+ $self->cwd(${*$self}{myftp_home});
}
sub request_count {
- my $self = shift;
- ++${*$self}{myftp_reqcount};
+ my $self = shift;
+ ++${*$self}{myftp_reqcount};
}
sub ping {
- my $self = shift;
- return $self->go_home;
+ my $self = shift;
+ return $self->go_home;
}
-
-};
-my $init_failed = $@;
-
+}
sub _connect {
- my($self, $host, $port, $user, $account, $password, $timeout) = @_;
+ my ($self, $host, $port, $user, $account, $password, $timeout) = @_;
my $key;
my $conn_cache = $self->{ua}{conn_cache};
if ($conn_cache) {
- $key = "$host:$port:$user";
- $key .= ":$account" if defined($account);
- if (my $ftp = $conn_cache->withdraw("ftp", $key)) {
- if ($ftp->ping) {
- # save it again
- $conn_cache->deposit("ftp", $key, $ftp);
- return $ftp;
- }
- }
+ $key = "$host:$port:$user";
+ $key .= ":$account" if defined($account);
+ if (my $ftp = $conn_cache->withdraw("ftp", $key)) {
+ if ($ftp->ping) {
+
+ # save it again
+ $conn_cache->deposit("ftp", $key, $ftp);
+ return $ftp;
+ }
+ }
}
# try to make a connection
- my $ftp = LWP::Protocol::MyFTP->new($host,
- Port => $port,
- Timeout => $timeout,
- LocalAddr => $self->{ua}{local_address},
- );
+ my $ftp = LWP::Protocol::MyFTP->new(
+ $host,
+ Port => $port,
+ Timeout => $timeout,
+ LocalAddr => $self->{ua}{local_address},
+ );
+
# XXX Should be some what to pass on 'Passive' (header??)
unless ($ftp) {
- $@ =~ s/^Net::FTP: //;
- return HTTP::Response->new(&HTTP::Status::RC_INTERNAL_SERVER_ERROR, $@);
+ $@ =~ s/^Net::FTP: //;
+ return HTTP::Response->new(HTTP::Status::RC_INTERNAL_SERVER_ERROR, $@);
}
unless ($ftp->login($user, $password, $account)) {
- # Unauthorized. Let's fake a RC_UNAUTHORIZED response
- my $mess = scalar($ftp->message);
- $mess =~ s/\n$//;
- my $res = HTTP::Response->new(&HTTP::Status::RC_UNAUTHORIZED, $mess);
- $res->header("Server", $ftp->http_server);
- $res->header("WWW-Authenticate", qq(Basic Realm="FTP login"));
- return $res;
+
+ # Unauthorized. Let's fake a RC_UNAUTHORIZED response
+ my $mess = scalar($ftp->message);
+ $mess =~ s/\n$//;
+ my $res = HTTP::Response->new(HTTP::Status::RC_UNAUTHORIZED, $mess);
+ $res->header("Server", $ftp->http_server);
+ $res->header("WWW-Authenticate", qq(Basic Realm="FTP login"));
+ return $res;
}
my $home = $ftp->pwd;
@@ -121,38 +120,30 @@ sub _connect {
}
-sub request
-{
- my($self, $request, $proxy, $arg, $size, $timeout) = @_;
+sub request {
+ my ($self, $request, $proxy, $arg, $size, $timeout) = @_;
$size = 4096 unless $size;
# check proxy
- if (defined $proxy)
- {
- return HTTP::Response->new(&HTTP::Status::RC_BAD_REQUEST,
- 'You can not proxy through the ftp');
+ if (defined $proxy) {
+ return HTTP::Response->new(HTTP::Status::RC_BAD_REQUEST,
+ 'You can not proxy through the ftp');
}
my $url = $request->uri;
if ($url->scheme ne 'ftp') {
- my $scheme = $url->scheme;
- return HTTP::Response->new(&HTTP::Status::RC_INTERNAL_SERVER_ERROR,
- "LWP::Protocol::ftp::request called for '$scheme'");
+ my $scheme = $url->scheme;
+ return HTTP::Response->new(HTTP::Status::RC_INTERNAL_SERVER_ERROR,
+ "LWP::Protocol::ftp::request called for '$scheme'");
}
# check method
my $method = $request->method;
unless ($method eq 'GET' || $method eq 'HEAD' || $method eq 'PUT') {
- return HTTP::Response->new(&HTTP::Status::RC_BAD_REQUEST,
- 'Library does not allow method ' .
- "$method for 'ftp:' URLs");
- }
-
- if ($init_failed) {
- return HTTP::Response->new(&HTTP::Status::RC_INTERNAL_SERVER_ERROR,
- $init_failed);
+ return HTTP::Response->new(HTTP::Status::RC_BAD_REQUEST,
+ 'Library does not allow method ' . "$method for 'ftp:' URLs");
}
my $host = $url->host;
@@ -163,272 +154,290 @@ sub request
# If a basic authorization header is present than we prefer these over
# the username/password specified in the URL.
{
- my($u,$p) = $request->authorization_basic;
- if (defined $u) {
- $user = $u;
- $password = $p;
- }
+ my ($u, $p) = $request->authorization_basic;
+ if (defined $u) {
+ $user = $u;
+ $password = $p;
+ }
}
# We allow the account to be specified in the "Account" header
my $account = $request->header('Account');
- my $ftp = $self->_connect($host, $port, $user, $account, $password, $timeout);
- return $ftp if ref($ftp) eq "HTTP::Response"; # ugh!
+ my $ftp
+ = $self->_connect($host, $port, $user, $account, $password, $timeout);
+ return $ftp if ref($ftp) eq "HTTP::Response"; # ugh!
# Create an initial response object
- my $response = HTTP::Response->new(&HTTP::Status::RC_OK, "OK");
- $response->header(Server => $ftp->http_server);
+ my $response = HTTP::Response->new(HTTP::Status::RC_OK, "OK");
+ $response->header(Server => $ftp->http_server);
$response->header('Client-Request-Num' => $ftp->request_count);
$response->request($request);
# Get & fix the path
- my @path = grep { length } $url->path_segments;
+ my @path = grep {length} $url->path_segments;
my $remote_file = pop(@path);
$remote_file = '' unless defined $remote_file;
my $type;
if (ref $remote_file) {
- my @params;
- ($remote_file, @params) = @$remote_file;
- for (@params) {
- $type = $_ if s/^type=//;
- }
+ my @params;
+ ($remote_file, @params) = @$remote_file;
+ for (@params) {
+ $type = $_ if s/^type=//;
+ }
}
if ($type && $type eq 'a') {
- $ftp->ascii;
+ $ftp->ascii;
}
else {
- $ftp->binary;
+ $ftp->binary;
}
for (@path) {
- unless ($ftp->cwd($_)) {
- return HTTP::Response->new(&HTTP::Status::RC_NOT_FOUND,
- "Can't chdir to $_");
- }
+ unless ($ftp->cwd($_)) {
+ return HTTP::Response->new(HTTP::Status::RC_NOT_FOUND,
+ "Can't chdir to $_");
+ }
}
if ($method eq 'GET' || $method eq 'HEAD') {
- if (my $mod_time = $ftp->mdtm($remote_file)) {
- $response->last_modified($mod_time);
- if (my $ims = $request->if_modified_since) {
- if ($mod_time <= $ims) {
- $response->code(&HTTP::Status::RC_NOT_MODIFIED);
- $response->message("Not modified");
- return $response;
- }
- }
- }
-
- # We'll use this later to abort the transfer if necessary.
- # if $max_size is defined, we need to abort early. Otherwise, it's
- # a normal transfer
- my $max_size = undef;
-
- # Set resume location, if the client requested it
- if ($request->header('Range') && $ftp->supported('REST'))
- {
- my $range_info = $request->header('Range');
-
- # Change bytes=2772992-6781209 to just 2772992
- my ($start_byte,$end_byte) = $range_info =~ /.*=\s*(\d+)-(\d+)?/;
- if ( defined $start_byte && !defined $end_byte ) {
-
- # open range -- only the start is specified
-
- $ftp->restart( $start_byte );
- # don't define $max_size, we don't want to abort early
- }
- elsif ( defined $start_byte && defined $end_byte &&
- $start_byte >= 0 && $end_byte >= $start_byte ) {
-
- $ftp->restart( $start_byte );
- $max_size = $end_byte - $start_byte;
- }
- else {
-
- return HTTP::Response->new(&HTTP::Status::RC_BAD_REQUEST,
- 'Incorrect syntax for Range request');
- }
- }
- elsif ($request->header('Range') && !$ftp->supported('REST'))
- {
- return HTTP::Response->new(&HTTP::Status::RC_NOT_IMPLEMENTED,
- "Server does not support resume.");
- }
-
- my $data; # the data handle
- if (length($remote_file) and $data = $ftp->retr($remote_file)) {
- my($type, @enc) = LWP::MediaTypes::guess_media_type($remote_file);
- $response->header('Content-Type', $type) if $type;
- for (@enc) {
- $response->push_header('Content-Encoding', $_);
- }
- my $mess = $ftp->message;
- if ($mess =~ /\((\d+)\s+bytes\)/) {
- $response->header('Content-Length', "$1");
- }
-
- if ($method ne 'HEAD') {
- # Read data from server
- $response = $self->collect($arg, $response, sub {
- my $content = '';
- my $result = $data->read($content, $size);
-
- # Stop early if we need to.
- if (defined $max_size)
- {
- # We need an interface to Net::FTP::dataconn for getting
- # the number of bytes already read
- my $bytes_received = $data->bytes_read();
-
- # We were already over the limit. (Should only happen
- # once at the end.)
- if ($bytes_received - length($content) > $max_size)
- {
- $content = '';
- }
- # We just went over the limit
- elsif ($bytes_received > $max_size)
- {
- # Trim content
- $content = substr($content, 0,
- $max_size - ($bytes_received - length($content)) );
- }
- # We're under the limit
- else
- {
- }
+ if (my $mod_time = $ftp->mdtm($remote_file)) {
+ $response->last_modified($mod_time);
+ if (my $ims = $request->if_modified_since) {
+ if ($mod_time <= $ims) {
+ $response->code(HTTP::Status::RC_NOT_MODIFIED);
+ $response->message("Not modified");
+ return $response;
+ }
+ }
+ }
+
+ # We'll use this later to abort the transfer if necessary.
+ # if $max_size is defined, we need to abort early. Otherwise, it's
+ # a normal transfer
+ my $max_size = undef;
+
+ # Set resume location, if the client requested it
+ if ($request->header('Range') && $ftp->supported('REST')) {
+ my $range_info = $request->header('Range');
+
+ # Change bytes=2772992-6781209 to just 2772992
+ my ($start_byte, $end_byte) = $range_info =~ /.*=\s*(\d+)-(\d+)?/;
+ if (defined $start_byte && !defined $end_byte) {
+
+ # open range -- only the start is specified
+
+ $ftp->restart($start_byte);
+
+ # don't define $max_size, we don't want to abort early
+ }
+ elsif (defined $start_byte
+ && defined $end_byte
+ && $start_byte >= 0
+ && $end_byte >= $start_byte)
+ {
+
+ $ftp->restart($start_byte);
+ $max_size = $end_byte - $start_byte;
+ }
+ else {
+
+ return HTTP::Response->new(HTTP::Status::RC_BAD_REQUEST,
+ 'Incorrect syntax for Range request');
+ }
+ }
+ elsif ($request->header('Range') && !$ftp->supported('REST')) {
+ return HTTP::Response->new(HTTP::Status::RC_NOT_IMPLEMENTED,
+ "Server does not support resume."
+ );
+ }
+
+ my $data; # the data handle
+ if (length($remote_file) and $data = $ftp->retr($remote_file)) {
+ my ($type, @enc) = LWP::MediaTypes::guess_media_type($remote_file);
+ $response->header('Content-Type', $type) if $type;
+ for (@enc) {
+ $response->push_header('Content-Encoding', $_);
+ }
+ my $mess = $ftp->message;
+ if ($mess =~ /\((\d+)\s+bytes\)/) {
+ $response->header('Content-Length', "$1");
+ }
+
+ if ($method ne 'HEAD') {
+
+ # Read data from server
+ $response = $self->collect(
+ $arg,
+ $response,
+ sub {
+ my $content = '';
+ my $result = $data->read($content, $size);
+
+ # Stop early if we need to.
+ if (defined $max_size) {
+
+ # We need an interface to Net::FTP::dataconn for getting
+ # the number of bytes already read
+ my $bytes_received = $data->bytes_read();
+
+ # We were already over the limit. (Should only happen
+ # once at the end.)
+ if ($bytes_received - length($content) > $max_size)
+ {
+ $content = '';
+ }
+
+ # We just went over the limit
+ elsif ($bytes_received > $max_size) {
+
+ # Trim content
+ $content = substr($content, 0,
+ $max_size
+ - ($bytes_received - length($content)));
+ }
+
+ # We're under the limit
+ else {
+ }
+ }
+
+ return \$content;
}
-
- return \$content;
- } );
- }
- # abort is needed for HEAD, it's == close if the transfer has
- # already completed.
- unless ($data->abort) {
- # Something did not work too well. Note that we treat
- # responses to abort() with code 0 in case of HEAD as ok
- # (at least wu-ftpd 2.6.1(1) does that).
- if ($method ne 'HEAD' || $ftp->code != 0) {
- $response->code(&HTTP::Status::RC_INTERNAL_SERVER_ERROR);
- $response->message("FTP close response: " . $ftp->code .
- " " . $ftp->message);
- }
- }
- }
- elsif (!length($remote_file) || ( $ftp->code >= 400 && $ftp->code < 600 )) {
- # not a plain file, try to list instead
- if (length($remote_file) && !$ftp->cwd($remote_file)) {
- return HTTP::Response->new(&HTTP::Status::RC_NOT_FOUND,
- "File '$remote_file' not found");
- }
-
- # It should now be safe to try to list the directory
- my @lsl = $ftp->dir;
-
- # Try to figure out if the user want us to convert the
- # directory listing to HTML.
- my @variants =
- (
- ['html', 0.60, 'text/html' ],
- ['dir', 1.00, 'text/ftp-dir-listing' ]
- );
- #$HTTP::Negotiate::DEBUG=1;
- my $prefer = HTTP::Negotiate::choose(\@variants, $request);
-
- my $content = '';
-
- if (!defined($prefer)) {
- return HTTP::Response->new(&HTTP::Status::RC_NOT_ACCEPTABLE,
- "Neither HTML nor directory listing wanted");
- }
- elsif ($prefer eq 'html') {
- $response->header('Content-Type' => 'text/html');
- $content = "<HEAD><TITLE>File Listing</TITLE>\n";
- my $base = $request->uri->clone;
- my $path = $base->path;
- $base->path("$path/") unless $path =~ m|/$|;
- $content .= qq(<BASE HREF="$base">\n</HEAD>\n);
- $content .= "<BODY>\n<UL>\n";
- for (File::Listing::parse_dir(\@lsl, 'GMT')) {
- my($name, $type, $size, $mtime, $mode) = @$_;
- $content .= qq( <LI> <a href="$name">$name</a>);
- $content .= " $size bytes" if $type eq 'f';
- $content .= "\n";
- }
- $content .= "</UL></body>\n";
- }
- else {
- $response->header('Content-Type', 'text/ftp-dir-listing');
- $content = join("\n", @lsl, '');
- }
-
- $response->header('Content-Length', length($content));
-
- if ($method ne 'HEAD') {
- $response = $self->collect_once($arg, $response, $content);
- }
- }
- else {
- my $res = HTTP::Response->new(&HTTP::Status::RC_BAD_REQUEST,
- "FTP return code " . $ftp->code);
- $res->content_type("text/plain");
- $res->content($ftp->message);
- return $res;
- }
+ );
+ }
+
+ # abort is needed for HEAD, it's == close if the transfer has
+ # already completed.
+ unless ($data->abort) {
+
+ # Something did not work too well. Note that we treat
+ # responses to abort() with code 0 in case of HEAD as ok
+ # (at least wu-ftpd 2.6.1(1) does that).
+ if ($method ne 'HEAD' || $ftp->code != 0) {
+ $response->code(HTTP::Status::RC_INTERNAL_SERVER_ERROR);
+ $response->message("FTP close response: "
+ . $ftp->code . " "
+ . $ftp->message);
+ }
+ }
+ }
+ elsif (!length($remote_file) || ($ftp->code >= 400 && $ftp->code < 600))
+ {
+ # not a plain file, try to list instead
+ if (length($remote_file) && !$ftp->cwd($remote_file)) {
+ return HTTP::Response->new(HTTP::Status::RC_NOT_FOUND,
+ "File '$remote_file' not found"
+ );
+ }
+
+ # It should now be safe to try to list the directory
+ my @lsl = $ftp->dir;
+
+ # Try to figure out if the user want us to convert the
+ # directory listing to HTML.
+ my @variants = (
+ ['html', 0.60, 'text/html'],
+ ['dir', 1.00, 'text/ftp-dir-listing']
+ );
+
+ #$HTTP::Negotiate::DEBUG=1;
+ my $prefer = HTTP::Negotiate::choose(\@variants, $request);
+
+ my $content = '';
+
+ if (!defined($prefer)) {
+ return HTTP::Response->new(HTTP::Status::RC_NOT_ACCEPTABLE,
+ "Neither HTML nor directory listing wanted");
+ }
+ elsif ($prefer eq 'html') {
+ $response->header('Content-Type' => 'text/html');
+ $content = "<HEAD><TITLE>File Listing</TITLE>\n";
+ my $base = $request->uri->clone;
+ my $path = $base->path;
+ $base->path("$path/") unless $path =~ m|/$|;
+ $content .= qq(<BASE HREF="$base">\n</HEAD>\n);
+ $content .= "<BODY>\n<UL>\n";
+ for (File::Listing::parse_dir(\@lsl, 'GMT')) {
+ my ($name, $type, $size, $mtime, $mode) = @$_;
+ $content .= qq( <LI> <a href="$name">$name</a>);
+ $content .= " $size bytes" if $type eq 'f';
+ $content .= "\n";
+ }
+ $content .= "</UL></body>\n";
+ }
+ else {
+ $response->header('Content-Type', 'text/ftp-dir-listing');
+ $content = join("\n", @lsl, '');
+ }
+
+ $response->header('Content-Length', length($content));
+
+ if ($method ne 'HEAD') {
+ $response = $self->collect_once($arg, $response, $content);
+ }
+ }
+ else {
+ my $res = HTTP::Response->new(HTTP::Status::RC_BAD_REQUEST,
+ "FTP return code " . $ftp->code);
+ $res->content_type("text/plain");
+ $res->content($ftp->message);
+ return $res;
+ }
}
elsif ($method eq 'PUT') {
- # method must be PUT
- unless (length($remote_file)) {
- return HTTP::Response->new(&HTTP::Status::RC_BAD_REQUEST,
- "Must have a file name to PUT to");
- }
- my $data;
- if ($data = $ftp->stor($remote_file)) {
- my $content = $request->content;
- my $bytes = 0;
- if (defined $content) {
- if (ref($content) eq 'SCALAR') {
- $bytes = $data->write($$content, length($$content));
- }
- elsif (ref($content) eq 'CODE') {
- my($buf, $n);
- while (length($buf = &$content)) {
- $n = $data->write($buf, length($buf));
- last unless $n;
- $bytes += $n;
- }
- }
- elsif (!ref($content)) {
- if (defined $content && length($content)) {
- $bytes = $data->write($content, length($content));
- }
- }
- else {
- die "Bad content";
- }
- }
- $data->close;
-
- $response->code(&HTTP::Status::RC_CREATED);
- $response->header('Content-Type', 'text/plain');
- $response->content("$bytes bytes stored as $remote_file on $host\n")
-
- }
- else {
- my $res = HTTP::Response->new(&HTTP::Status::RC_BAD_REQUEST,
- "FTP return code " . $ftp->code);
- $res->content_type("text/plain");
- $res->content($ftp->message);
- return $res;
- }
+
+ # method must be PUT
+ unless (length($remote_file)) {
+ return HTTP::Response->new(HTTP::Status::RC_BAD_REQUEST,
+ "Must have a file name to PUT to"
+ );
+ }
+ my $data;
+ if ($data = $ftp->stor($remote_file)) {
+ my $content = $request->content;
+ my $bytes = 0;
+ if (defined $content) {
+ if (ref($content) eq 'SCALAR') {
+ $bytes = $data->write($$content, length($$content));
+ }
+ elsif (ref($content) eq 'CODE') {
+ my ($buf, $n);
+ while (length($buf = &$content)) {
+ $n = $data->write($buf, length($buf));
+ last unless $n;
+ $bytes += $n;
+ }
+ }
+ elsif (!ref($content)) {
+ if (defined $content && length($content)) {
+ $bytes = $data->write($content, length($content));
+ }
+ }
+ else {
+ die "Bad content";
+ }
+ }
+ $data->close;
+
+ $response->code(HTTP::Status::RC_CREATED);
+ $response->header('Content-Type', 'text/plain');
+ $response->content("$bytes bytes stored as $remote_file on $host\n")
+
+ }
+ else {
+ my $res = HTTP::Response->new(HTTP::Status::RC_BAD_REQUEST,
+ "FTP return code " . $ftp->code);
+ $res->content_type("text/plain");
+ $res->content($ftp->message);
+ return $res;
+ }
}
else {
- return HTTP::Response->new(&HTTP::Status::RC_BAD_REQUEST,
- "Illegal method $method");
+ return HTTP::Response->new(HTTP::Status::RC_BAD_REQUEST,
+ "Illegal method $method");
}
$response;
diff --git a/Master/tlpkg/tlperl/site/lib/LWP/Protocol/gopher.pm b/Master/tlpkg/tlperl/site/lib/LWP/Protocol/gopher.pm
index db6c0bfba9d..e6fe5ce8473 100644
--- a/Master/tlpkg/tlperl/site/lib/LWP/Protocol/gopher.pm
+++ b/Master/tlpkg/tlperl/site/lib/LWP/Protocol/gopher.pm
@@ -1,5 +1,5 @@
package LWP::Protocol::gopher;
-
+$LWP::Protocol::gopher::VERSION = '6.25';
# Implementation of the gopher protocol (RFC 1436)
#
# This code is based on 'wwwgopher.pl,v 0.10 1994/10/17 18:12:34 shelden'
@@ -8,15 +8,13 @@ package LWP::Protocol::gopher;
# including contributions from Marc van Heyningen and Martijn Koster.
use strict;
-use vars qw(@ISA);
require HTTP::Response;
require HTTP::Status;
require IO::Socket;
require IO::Select;
-require LWP::Protocol;
-@ISA = qw(LWP::Protocol);
+use base qw(LWP::Protocol);
my %gopher2mimetype = (
@@ -47,7 +45,7 @@ sub request
# check proxy
if (defined $proxy) {
- return HTTP::Response->new(&HTTP::Status::RC_BAD_REQUEST,
+ return HTTP::Response->new(HTTP::Status::RC_BAD_REQUEST,
'You can not proxy through the gopher');
}
@@ -57,19 +55,19 @@ sub request
my $method = $request->method;
unless ($method eq 'GET' || $method eq 'HEAD') {
- return HTTP::Response->new(&HTTP::Status::RC_BAD_REQUEST,
+ return HTTP::Response->new(HTTP::Status::RC_BAD_REQUEST,
'Library does not allow method ' .
"$method for 'gopher:' URLs");
}
my $gophertype = $url->gopher_type;
unless (exists $gopher2mimetype{$gophertype}) {
- return HTTP::Response->new(&HTTP::Status::RC_NOT_IMPLEMENTED,
+ return HTTP::Response->new(HTTP::Status::RC_NOT_IMPLEMENTED,
'Library does not support gophertype ' .
$gophertype);
}
- my $response = HTTP::Response->new(&HTTP::Status::RC_OK, "OK");
+ my $response = HTTP::Response->new(HTTP::Status::RC_OK, "OK");
$response->header('Content-type' => $gopher2mimetype{$gophertype}
|| 'text/plain');
$response->header('Content-Encoding' => $gopher2encoding{$gophertype})
@@ -80,7 +78,7 @@ sub request
$response->header('Client-Warning' => 'Client answer only');
return $response;
}
-
+
if ($gophertype eq '7' && ! $url->search) {
# the url is the prompt for a gopher search; supply boiler-plate
return $self->collect_once($arg, $response, <<"EOT");
diff --git a/Master/tlpkg/tlperl/site/lib/LWP/Protocol/http.pm b/Master/tlpkg/tlperl/site/lib/LWP/Protocol/http.pm
index 23c361f7055..2266b1e9ea6 100644
--- a/Master/tlpkg/tlperl/site/lib/LWP/Protocol/http.pm
+++ b/Master/tlpkg/tlperl/site/lib/LWP/Protocol/http.pm
@@ -1,16 +1,14 @@
package LWP::Protocol::http;
-
+$LWP::Protocol::http::VERSION = '6.25';
use strict;
require HTTP::Response;
require HTTP::Status;
require Net::HTTP;
-use vars qw(@ISA @EXTRA_SOCK_OPTS);
-
-require LWP::Protocol;
-@ISA = qw(LWP::Protocol);
+use base qw(LWP::Protocol);
+our @EXTRA_SOCK_OPTS;
my $CRLF = "\015\012";
sub _new_socket
@@ -39,6 +37,7 @@ sub _new_socket
my $status = "Can't connect to $host:$port";
if ($@ =~ /\bconnect: (.*)/ ||
$@ =~ /\b(Bad hostname)\b/ ||
+ $@ =~ /\b(nodename nor servname provided, or not known)\b/ ||
$@ =~ /\b(certificate verify failed)\b/ ||
$@ =~ /\b(Crypt-SSLeay can't verify hostnames)\b/
) {
@@ -131,7 +130,7 @@ sub request
# check method
my $method = $request->method;
unless ($method =~ /^[A-Za-z0-9_!\#\$%&\'*+\-.^\`|~]+$/) { # HTTP token
- return HTTP::Response->new( &HTTP::Status::RC_BAD_REQUEST,
+ return HTTP::Response->new( HTTP::Status::RC_BAD_REQUEST,
'Library does not allow method ' .
"$method for 'http:' URLs");
}
@@ -168,7 +167,7 @@ sub request
my $cache_key;
if ( $conn_cache ) {
$cache_key = "$host:$port";
- # For https we reuse the socket immediatly only if it has an established
+ # For https we reuse the socket immediately only if it has an established
# tunnel to the target. Otherwise a CONNECT request followed by an SSL
# upgrade need to be done first. The request itself might reuse an
# existing non-ssl connection to the proxy
@@ -181,6 +180,9 @@ sub request
$socket->close;
$socket = undef;
} # else use $socket
+ else {
+ $socket->timeout($timeout);
+ }
}
}
@@ -496,7 +498,7 @@ sub request
#-----------------------------------------------------------
package LWP::Protocol::http::SocketMethods;
-
+$LWP::Protocol::http::SocketMethods::VERSION = '6.25';
sub ping {
my $self = shift;
!$self->can_read(0);
@@ -509,7 +511,7 @@ sub increment_response_count {
#-----------------------------------------------------------
package LWP::Protocol::http::Socket;
-use vars qw(@ISA);
-@ISA = qw(LWP::Protocol::http::SocketMethods Net::HTTP);
+$LWP::Protocol::http::Socket::VERSION = '6.25';
+use base qw(LWP::Protocol::http::SocketMethods Net::HTTP);
1;
diff --git a/Master/tlpkg/tlperl/site/lib/LWP/Protocol/loopback.pm b/Master/tlpkg/tlperl/site/lib/LWP/Protocol/loopback.pm
index 2cd67ae3608..f1e4c9f918e 100644
--- a/Master/tlpkg/tlperl/site/lib/LWP/Protocol/loopback.pm
+++ b/Master/tlpkg/tlperl/site/lib/LWP/Protocol/loopback.pm
@@ -1,11 +1,9 @@
package LWP::Protocol::loopback;
-
+$LWP::Protocol::loopback::VERSION = '6.25';
use strict;
-use vars qw(@ISA);
require HTTP::Response;
-require LWP::Protocol;
-@ISA = qw(LWP::Protocol);
+use base qw(LWP::Protocol);
sub request {
my($self, $request, $proxy, $arg, $size, $timeout) = @_;
diff --git a/Master/tlpkg/tlperl/site/lib/LWP/Protocol/mailto.pm b/Master/tlpkg/tlperl/site/lib/LWP/Protocol/mailto.pm
index 46db7162e44..9358695d57d 100644
--- a/Master/tlpkg/tlperl/site/lib/LWP/Protocol/mailto.pm
+++ b/Master/tlpkg/tlperl/site/lib/LWP/Protocol/mailto.pm
@@ -1,19 +1,18 @@
package LWP::Protocol::mailto;
-
+$LWP::Protocol::mailto::VERSION = '6.25';
# This module implements the mailto protocol. It is just a simple
# frontend to the Unix sendmail program except on MacOS, where it uses
# Mail::Internet.
-require LWP::Protocol;
require HTTP::Request;
require HTTP::Response;
require HTTP::Status;
use Carp;
use strict;
-use vars qw(@ISA $SENDMAIL);
-@ISA = qw(LWP::Protocol);
+use base qw(LWP::Protocol);
+our $SENDMAIL;
unless ($SENDMAIL = $ENV{SENDMAIL}) {
for my $sm (qw(/usr/sbin/sendmail
@@ -39,7 +38,7 @@ sub request
# check proxy
if (defined $proxy)
{
- return HTTP::Response->new(&HTTP::Status::RC_BAD_REQUEST,
+ return HTTP::Response->new(HTTP::Status::RC_BAD_REQUEST,
'You can not proxy with mail');
}
@@ -47,7 +46,7 @@ sub request
my $method = $request->method;
if ($method ne 'POST') {
- return HTTP::Response->new( &HTTP::Status::RC_BAD_REQUEST,
+ return HTTP::Response->new( HTTP::Status::RC_BAD_REQUEST,
'Library does not allow method ' .
"$method for 'mailto:' URLs");
}
@@ -57,7 +56,7 @@ sub request
my $scheme = $url->scheme;
if ($scheme ne 'mailto') {
- return HTTP::Response->new( &HTTP::Status::RC_INTERNAL_SERVER_ERROR,
+ return HTTP::Response->new( HTTP::Status::RC_INTERNAL_SERVER_ERROR,
"LWP::Protocol::mailto::request called for '$scheme'");
}
if ($^O eq "MacOS") {
@@ -65,28 +64,28 @@ sub request
require Mail::Internet;
};
if($@) {
- return HTTP::Response->new( &HTTP::Status::RC_INTERNAL_SERVER_ERROR,
+ return HTTP::Response->new( HTTP::Status::RC_INTERNAL_SERVER_ERROR,
"You don't have MailTools installed");
}
unless ($ENV{SMTPHOSTS}) {
- return HTTP::Response->new( &HTTP::Status::RC_INTERNAL_SERVER_ERROR,
+ return HTTP::Response->new( HTTP::Status::RC_INTERNAL_SERVER_ERROR,
"You don't have SMTPHOSTS defined");
}
}
else {
unless (-x $SENDMAIL) {
- return HTTP::Response->new( &HTTP::Status::RC_INTERNAL_SERVER_ERROR,
+ return HTTP::Response->new( HTTP::Status::RC_INTERNAL_SERVER_ERROR,
"You don't have $SENDMAIL");
}
}
if ($^O eq "MacOS") {
$mail = Mail::Internet->new or
- return HTTP::Response->new( &HTTP::Status::RC_INTERNAL_SERVER_ERROR,
+ return HTTP::Response->new( HTTP::Status::RC_INTERNAL_SERVER_ERROR,
"Can't get a Mail::Internet object");
}
else {
open(SENDMAIL, "| $SENDMAIL -oi -t") or
- return HTTP::Response->new( &HTTP::Status::RC_INTERNAL_SERVER_ERROR,
+ return HTTP::Response->new( HTTP::Status::RC_INTERNAL_SERVER_ERROR,
"Can't run $SENDMAIL: $!");
}
if ($^O eq "MacOS") {
@@ -151,20 +150,20 @@ sub request
if ($^O eq "MacOS") {
$mail->body(\@text);
unless ($mail->smtpsend) {
- return HTTP::Response->new(&HTTP::Status::RC_INTERNAL_SERVER_ERROR,
+ return HTTP::Response->new(HTTP::Status::RC_INTERNAL_SERVER_ERROR,
"Mail::Internet->smtpsend unable to send message to <$addr>");
}
}
else {
unless (close(SENDMAIL)) {
my $err = $! ? "$!" : "Exit status $?";
- return HTTP::Response->new(&HTTP::Status::RC_INTERNAL_SERVER_ERROR,
+ return HTTP::Response->new(HTTP::Status::RC_INTERNAL_SERVER_ERROR,
"$SENDMAIL: $err");
}
}
- my $response = HTTP::Response->new(&HTTP::Status::RC_ACCEPTED,
+ my $response = HTTP::Response->new(HTTP::Status::RC_ACCEPTED,
"Mail accepted");
$response->header('Content-Type', 'text/plain');
if ($^O eq "MacOS") {
diff --git a/Master/tlpkg/tlperl/site/lib/LWP/Protocol/nntp.pm b/Master/tlpkg/tlperl/site/lib/LWP/Protocol/nntp.pm
index 788477d488a..9727a247a51 100644
--- a/Master/tlpkg/tlperl/site/lib/LWP/Protocol/nntp.pm
+++ b/Master/tlpkg/tlperl/site/lib/LWP/Protocol/nntp.pm
@@ -1,9 +1,8 @@
package LWP::Protocol::nntp;
-
+$LWP::Protocol::nntp::VERSION = '6.25';
# Implementation of the Network News Transfer Protocol (RFC 977)
-require LWP::Protocol;
-@ISA = qw(LWP::Protocol);
+use base qw(LWP::Protocol);
require HTTP::Response;
require HTTP::Status;
@@ -12,56 +11,57 @@ require Net::NNTP;
use strict;
-sub request
-{
- my($self, $request, $proxy, $arg, $size, $timeout) = @_;
+sub request {
+ my ($self, $request, $proxy, $arg, $size, $timeout) = @_;
$size = 4096 unless $size;
# Check for proxy
if (defined $proxy) {
- return HTTP::Response->new(&HTTP::Status::RC_BAD_REQUEST,
- 'You can not proxy through NNTP');
+ return HTTP::Response->new(HTTP::Status::RC_BAD_REQUEST,
+ 'You can not proxy through NNTP');
}
# Check that the scheme is as expected
- my $url = $request->uri;
+ my $url = $request->uri;
my $scheme = $url->scheme;
unless ($scheme eq 'news' || $scheme eq 'nntp') {
- return HTTP::Response->new(&HTTP::Status::RC_INTERNAL_SERVER_ERROR,
- "LWP::Protocol::nntp::request called for '$scheme'");
+ return HTTP::Response->new(HTTP::Status::RC_INTERNAL_SERVER_ERROR,
+ "LWP::Protocol::nntp::request called for '$scheme'");
}
# check for a valid method
my $method = $request->method;
unless ($method eq 'GET' || $method eq 'HEAD' || $method eq 'POST') {
- return HTTP::Response->new(&HTTP::Status::RC_BAD_REQUEST,
- 'Library does not allow method ' .
- "$method for '$scheme:' URLs");
+ return HTTP::Response->new(HTTP::Status::RC_BAD_REQUEST,
+ 'Library does not allow method ' . "$method for '$scheme:' URLs");
}
# extract the identifier and check against posting to an article
my $groupart = $url->_group;
- my $is_art = $groupart =~ /@/;
+ my $is_art = $groupart =~ /@/;
if ($is_art && $method eq 'POST') {
- return HTTP::Response->new(&HTTP::Status::RC_BAD_REQUEST,
- "Can't post to an article <$groupart>");
+ return HTTP::Response->new(HTTP::Status::RC_BAD_REQUEST,
+ "Can't post to an article <$groupart>");
}
- my $nntp = Net::NNTP->new($url->host,
- #Port => 18574,
- Timeout => $timeout,
- #Debug => 1,
- );
+ my $nntp = Net::NNTP->new(
+ $url->host,
+
+ #Port => 18574,
+ Timeout => $timeout,
+
+ #Debug => 1,
+ );
die "Can't connect to nntp server" unless $nntp;
# Check the initial welcome message from the NNTP server
if ($nntp->status != 2) {
- return HTTP::Response->new(&HTTP::Status::RC_SERVICE_UNAVAILABLE,
- $nntp->message);
+ return HTTP::Response->new(HTTP::Status::RC_SERVICE_UNAVAILABLE,
+ $nntp->message);
}
- my $response = HTTP::Response->new(&HTTP::Status::RC_OK, "OK");
+ my $response = HTTP::Response->new(HTTP::Status::RC_OK, "OK");
my $mess = $nntp->message;
@@ -74,66 +74,69 @@ sub request
# First we handle posting of articles
if ($method eq 'POST') {
- $nntp->quit; $nntp = undef;
- $response->code(&HTTP::Status::RC_NOT_IMPLEMENTED);
- $response->message("POST not implemented yet");
- return $response;
+ $nntp->quit;
+ $nntp = undef;
+ $response->code(HTTP::Status::RC_NOT_IMPLEMENTED);
+ $response->message("POST not implemented yet");
+ return $response;
}
# The method must be "GET" or "HEAD" by now
if (!$is_art) {
- if (!$nntp->group($groupart)) {
- $response->code(&HTTP::Status::RC_NOT_FOUND);
- $response->message($nntp->message);
- }
- $nntp->quit; $nntp = undef;
- # HEAD: just check if the group exists
- if ($method eq 'GET' && $response->is_success) {
- $response->code(&HTTP::Status::RC_NOT_IMPLEMENTED);
- $response->message("GET newsgroup not implemented yet");
- }
- return $response;
+ if (!$nntp->group($groupart)) {
+ $response->code(HTTP::Status::RC_NOT_FOUND);
+ $response->message($nntp->message);
+ }
+ $nntp->quit;
+ $nntp = undef;
+
+ # HEAD: just check if the group exists
+ if ($method eq 'GET' && $response->is_success) {
+ $response->code(HTTP::Status::RC_NOT_IMPLEMENTED);
+ $response->message("GET newsgroup not implemented yet");
+ }
+ return $response;
}
# Send command to server to retrieve an article (or just the headers)
my $get = $method eq 'HEAD' ? "head" : "article";
my $art = $nntp->$get("<$groupart>");
unless ($art) {
- $nntp->quit; $nntp = undef;
- $response->code(&HTTP::Status::RC_NOT_FOUND);
- $response->message($nntp->message);
- return $response;
+ $nntp->quit;
+ $response->code(HTTP::Status::RC_NOT_FOUND);
+ $response->message($nntp->message);
+ $nntp = undef;
+ return $response;
}
# Parse headers
- my($key, $val);
+ my ($key, $val);
local $_;
while ($_ = shift @$art) {
- if (/^\s+$/) {
- last; # end of headers
- }
- elsif (/^(\S+):\s*(.*)/) {
- $response->push_header($key, $val) if $key;
- ($key, $val) = ($1, $2);
- }
- elsif (/^\s+(.*)/) {
- next unless $key;
- $val .= $1;
- }
- else {
- unshift(@$art, $_);
- last;
- }
+ if (/^\s+$/) {
+ last; # end of headers
+ }
+ elsif (/^(\S+):\s*(.*)/) {
+ $response->push_header($key, $val) if $key;
+ ($key, $val) = ($1, $2);
+ }
+ elsif (/^\s+(.*)/) {
+ next unless $key;
+ $val .= $1;
+ }
+ else {
+ unshift(@$art, $_);
+ last;
+ }
}
$response->push_header($key, $val) if $key;
# Ensure that there is a Content-Type header
$response->header("Content-Type", "text/plain")
- unless $response->header("Content-Type");
+ unless $response->header("Content-Type");
# Collect the body
- $response = $self->collect_once($arg, $response, join("", @$art))
- if @$art;
+ $response = $self->collect_once($arg, $response, join("", @$art)) if @$art;
# Say goodbye to the server
$nntp->quit;
diff --git a/Master/tlpkg/tlperl/site/lib/LWP/Protocol/nogo.pm b/Master/tlpkg/tlperl/site/lib/LWP/Protocol/nogo.pm
index 68150a722d5..a9b0e411ee7 100644
--- a/Master/tlpkg/tlperl/site/lib/LWP/Protocol/nogo.pm
+++ b/Master/tlpkg/tlperl/site/lib/LWP/Protocol/nogo.pm
@@ -4,20 +4,19 @@ package LWP::Protocol::nogo;
# LWP::Protocol::implementor(that_scheme, 'LWP::Protocol::nogo');
# For then on, attempts to access URLs with that scheme will generate
# a 500 error.
-
+$LWP::Protocol::nogo::VERSION = '6.25';
use strict;
-use vars qw(@ISA);
+
require HTTP::Response;
require HTTP::Status;
-require LWP::Protocol;
-@ISA = qw(LWP::Protocol);
+use base qw(LWP::Protocol);
sub request {
my($self, $request) = @_;
my $scheme = $request->uri->scheme;
-
+
return HTTP::Response->new(
- &HTTP::Status::RC_INTERNAL_SERVER_ERROR,
+ HTTP::Status::RC_INTERNAL_SERVER_ERROR,
"Access to \'$scheme\' URIs has been disabled"
);
}
diff --git a/Master/tlpkg/tlperl/site/lib/LWP/RobotUA.pm b/Master/tlpkg/tlperl/site/lib/LWP/RobotUA.pm
index 9e0bf5f0dbb..0e96856329a 100644
--- a/Master/tlpkg/tlperl/site/lib/LWP/RobotUA.pm
+++ b/Master/tlpkg/tlperl/site/lib/LWP/RobotUA.pm
@@ -1,8 +1,8 @@
package LWP::RobotUA;
-require LWP::UserAgent;
-@ISA = qw(LWP::UserAgent);
-$VERSION = "6.15";
+use base qw(LWP::UserAgent);
+
+our $VERSION = '6.25';
require WWW::RobotRules;
require HTTP::Request;
@@ -72,7 +72,7 @@ sub agent
my $old = $self->SUPER::agent(@_);
if (@_) {
# Changing our name means to start fresh
- $self->{'rules'}->agent($self->{'agent'});
+ $self->{'rules'}->agent($self->{'agent'});
}
$old;
}
@@ -123,7 +123,7 @@ sub simple_request
$robot_url->query(undef);
# make access to robot.txt legal since this will be a recursive call
- $self->{'rules'}->parse($robot_url, "");
+ $self->{'rules'}->parse($robot_url, "");
my $robot_req = HTTP::Request->new('GET', $robot_url);
my $parse_head = $self->parse_head(0);
@@ -144,7 +144,7 @@ sub simple_request
# Check rules
unless ($allowed) {
my $res = HTTP::Response->new(
- &HTTP::Status::RC_FORBIDDEN, 'Forbidden by robots.txt');
+ HTTP::Status::RC_FORBIDDEN, 'Forbidden by robots.txt');
$res->request( $request ); # bind it to that request
return $res;
}
@@ -158,7 +158,7 @@ sub simple_request
}
else {
my $res = HTTP::Response->new(
- &HTTP::Status::RC_SERVICE_UNAVAILABLE, 'Please, slow down');
+ HTTP::Status::RC_SERVICE_UNAVAILABLE, 'Please, slow down');
$res->header('Retry-After', time2str(time + $wait));
$res->request( $request ); # bind it to that request
return $res;
@@ -190,6 +190,8 @@ sub as_string
__END__
+=pod
+
=head1 NAME
LWP::RobotUA - a class for well-behaved Web robots
@@ -213,7 +215,7 @@ should consult the F</robots.txt> file to ensure that they are welcomed
and they should not make requests too frequently.
But before you consider writing a robot, take a look at
-<URL:http://www.robotstxt.org/>.
+L<URL:http://www.robotstxt.org/>.
When you use an I<LWP::RobotUA> object as your user agent, then you do not
really have to think about these things yourself; C<robots.txt> files
@@ -226,16 +228,14 @@ special agent will make sure you are nice.
=head1 METHODS
-The LWP::RobotUA is a sub-class of LWP::UserAgent and implements the
+The LWP::RobotUA is a sub-class of L<LWP::UserAgent> and implements the
same methods. In addition the following methods are provided:
-=over 4
-
-=item $ua = LWP::RobotUA->new( %options )
+=head2 new
-=item $ua = LWP::RobotUA->new( $agent, $from )
-
-=item $ua = LWP::RobotUA->new( $agent, $from, $rules )
+ my $ua = LWP::RobotUA->new( %options )
+ my $ua = LWP::RobotUA->new( $agent, $from )
+ my $ua = LWP::RobotUA->new( $agent, $from, $rules )
The LWP::UserAgent options C<agent> and C<from> are mandatory. The
options C<delay>, C<use_sleep> and C<rules> initialize attributes
@@ -246,51 +246,58 @@ F<robots.txt>.
It is also possible to just pass the value of C<agent>, C<from> and
optionally C<rules> as plain positional arguments.
-=item $ua->delay
+=head2 delay
-=item $ua->delay( $minutes )
+ my $delay = $ua->delay;
+ $ua->delay( $minutes );
Get/set the minimum delay between requests to the same server, in
-I<minutes>. The default is 1 minute. Note that this number doesn't
-have to be an integer; for example, this sets the delay to 10 seconds:
+I<minutes>. The default is C<1> minute. Note that this number doesn't
+have to be an integer; for example, this sets the delay to C<10> seconds:
$ua->delay(10/60);
-=item $ua->use_sleep
+=head2 use_sleep
-=item $ua->use_sleep( $boolean )
+ my $bool = $ua->use_sleep;
+ $ua->use_sleep( $boolean );
-Get/set a value indicating whether the UA should sleep() if requests
-arrive too fast, defined as $ua->delay minutes not passed since
-last request to the given server. The default is TRUE. If this value is
-FALSE then an internal SERVICE_UNAVAILABLE response will be generated.
-It will have a Retry-After header that indicates when it is OK to
+Get/set a value indicating whether the UA should L<LWP::RobotUA/sleep> if
+requests arrive too fast, defined as C<< $ua->delay >> minutes not passed since
+last request to the given server. The default is true. If this value is
+false then an internal C<SERVICE_UNAVAILABLE> response will be generated.
+It will have a C<Retry-After> header that indicates when it is OK to
send another request to this server.
-=item $ua->rules
+=head2 rules
-=item $ua->rules( $rules )
+ my $rules = $ua->rules;
+ $ua->rules( $rules );
Set/get which I<WWW::RobotRules> object to use.
-=item $ua->no_visits( $netloc )
+=head2 no_visits
+
+ my $num = $ua->no_visits( $netloc )
Returns the number of documents fetched from this server host. Yeah I
-know, this method should probably have been named num_visits() or
+know, this method should probably have been named C<num_visits> or
something like that. :-(
-=item $ua->host_wait( $netloc )
+=head2 host_wait
+
+ my $num = $ua->host_wait( $netloc )
Returns the number of I<seconds> (from now) you must wait before you can
make a new request to this host.
-=item $ua->as_string
+=head2 as_string
+
+ my $string = $ua->as_string;
Returns a string that describes the state of the UA.
Mainly useful for debugging.
-=back
-
=head1 SEE ALSO
L<LWP::UserAgent>, L<WWW::RobotRules>
@@ -301,3 +308,5 @@ Copyright 1996-2004 Gisle Aas.
This library is free software; you can redistribute it and/or
modify it under the same terms as Perl itself.
+
+=cut
diff --git a/Master/tlpkg/tlperl/site/lib/LWP/Simple.pm b/Master/tlpkg/tlperl/site/lib/LWP/Simple.pm
index e522a1d19c2..321f9641c48 100644
--- a/Master/tlpkg/tlperl/site/lib/LWP/Simple.pm
+++ b/Master/tlpkg/tlperl/site/lib/LWP/Simple.pm
@@ -1,21 +1,20 @@
package LWP::Simple;
use strict;
-use vars qw($ua %loop_check $FULL_LWP @EXPORT @EXPORT_OK $VERSION);
+
+our $VERSION = '6.25';
require Exporter;
-@EXPORT = qw(get head getprint getstore mirror);
-@EXPORT_OK = qw($ua);
+our @EXPORT = qw(get head getprint getstore mirror);
+our @EXPORT_OK = qw($ua);
-# I really hate this. I was a bad idea to do it in the first place.
+# I really hate this. It was a bad idea to do it in the first place.
# Wonder how to get rid of it??? (It even makes LWP::Simple 7% slower
# for trivial tests)
use HTTP::Status;
push(@EXPORT, @HTTP::Status::EXPORT);
-$VERSION = "6.15";
-
sub import
{
my $pkg = shift;
@@ -24,13 +23,12 @@ sub import
}
use LWP::UserAgent ();
-use HTTP::Status ();
use HTTP::Date ();
-$ua = LWP::UserAgent->new; # we create a global UserAgent object
+
+our $ua = LWP::UserAgent->new; # we create a global UserAgent object
$ua->agent("LWP::Simple/$VERSION ");
$ua->env_proxy;
-
sub get ($)
{
my $response = $ua->get(shift);
@@ -97,6 +95,8 @@ sub mirror ($$)
__END__
+=pod
+
=head1 NAME
LWP::Simple - simple procedural interface to LWP
@@ -123,24 +123,36 @@ This module is meant for people who want a simplified view of the
libwww-perl library. It should also be suitable for one-liners. If
you need more control or access to the header fields in the requests
sent and responses received, then you should use the full object-oriented
-interface provided by the C<LWP::UserAgent> module.
+interface provided by the L<LWP::UserAgent> module.
+
+The module will also export the L<LWP::UserAgent> object as C<$ua> if you
+ask for it explicitly.
+
+The user agent created by this module will identify itself as
+C<LWP::Simple/#.##>
+and will initialize its proxy defaults from the environment (by
+calling C<< $ua->env_proxy >>).
+
+=head1 FUNCTIONS
The following functions are provided (and exported) by this module:
-=over 3
+=head2 get
-=item get($url)
+ my $res = get($url);
The get() function will fetch the document identified by the given URL
-and return it. It returns C<undef> if it fails. The $url argument can
-be either a string or a reference to a URI object.
+and return it. It returns C<undef> if it fails. The C<$url> argument can
+be either a string or a reference to a L<URI> object.
You will not be able to examine the response code or response headers
-(like 'Content-Type') when you are accessing the web using this
+(like C<Content-Type>) when you are accessing the web using this
function. If you need that information you should use the full OO
interface (see L<LWP::UserAgent>).
-=item head($url)
+=head2 head
+
+ my $res = head($url);
Get document headers. Returns the following 5 values if successful:
($content_type, $document_length, $modified_time, $expires, $server)
@@ -148,7 +160,9 @@ Get document headers. Returns the following 5 values if successful:
Returns an empty list if it fails. In scalar context returns TRUE if
successful.
-=item getprint($url)
+=head2 getprint
+
+ my $code = getprint($url);
Get and print a document identified by a URL. The document is printed
to the selected default filehandle for output (normally STDOUT) as
@@ -156,22 +170,26 @@ data is received from the network. If the request fails, then the
status code and message are printed on STDERR. The return value is
the HTTP response code.
-=item getstore($url, $file)
+=head2 getstore
+
+ my $code = getstore($url, $file)
Gets a document identified by a URL and stores it in the file. The
return value is the HTTP response code.
-=item mirror($url, $file)
+=head2 mirror
+
+ my $code = mirror($url, $file);
Get and store a document identified by a URL, using
I<If-modified-since>, and checking the I<Content-Length>. Returns
the HTTP response code.
-=back
+=head1 STATUS CONSTANTS
-This module also exports the HTTP::Status constants and procedures.
-You can use them when you check the response code from getprint(),
-getstore() or mirror(). The constants are:
+This module also exports the L<HTTP::Status> constants and procedures.
+You can use them when you check the response code from L<LWP::Simple/getprint>,
+L<LWP::Simple/getstore> or L<LWP::Simple/mirror>. The constants are:
RC_CONTINUE
RC_SWITCHING_PROTOCOLS
@@ -211,34 +229,28 @@ getstore() or mirror(). The constants are:
RC_GATEWAY_TIMEOUT
RC_HTTP_VERSION_NOT_SUPPORTED
-The HTTP::Status classification functions are:
+=head1 CLASSIFICATION FUNCTIONS
-=over 3
+The L<HTTP::Status> classification functions are:
-=item is_success($rc)
+=head2 is_success
-True if response code indicated a successful request.
-
-=item is_error($rc)
+ my $bool = is_success($rc);
-True if response code indicated that an error occurred.
+True if response code indicated a successful request.
-=back
+=head2 is_error
-The module will also export the LWP::UserAgent object as C<$ua> if you
-ask for it explicitly.
+ my $bool = is_error($rc)
-The user agent created by this module will identify itself as
-"LWP::Simple/#.##"
-and will initialize its proxy defaults from the environment (by
-calling $ua->env_proxy).
+True if response code indicated that an error occurred.
=head1 CAVEAT
-Note that if you are using both LWP::Simple and the very popular CGI.pm
+Note that if you are using both LWP::Simple and the very popular L<CGI>
module, you may be importing a C<head> function from each module,
-producing a warning like "Prototype mismatch: sub main::head ($) vs
-none". Get around this problem by just not importing LWP::Simple's
+producing a warning like C<Prototype mismatch: sub main::head ($) vs none>.
+Get around this problem by just not importing LWP::Simple's
C<head> function, like so:
use LWP::Simple qw(!head);
@@ -251,3 +263,5 @@ it as C<LWP::Simple::head($url)>.
L<LWP>, L<lwpcook>, L<LWP::UserAgent>, L<HTTP::Status>, L<lwp-request>,
L<lwp-mirror>
+
+=cut
diff --git a/Master/tlpkg/tlperl/site/lib/LWP/UserAgent.pm b/Master/tlpkg/tlperl/site/lib/LWP/UserAgent.pm
index b9a32839dd0..07c391605e3 100644
--- a/Master/tlpkg/tlperl/site/lib/LWP/UserAgent.pm
+++ b/Master/tlpkg/tlperl/site/lib/LWP/UserAgent.pm
@@ -1,12 +1,10 @@
package LWP::UserAgent;
use strict;
-use vars qw(@ISA $VERSION);
-require LWP::MemberMixin;
-@ISA = qw(LWP::MemberMixin);
-$VERSION = "6.15";
+use base qw(LWP::MemberMixin);
+use Carp ();
use HTTP::Request ();
use HTTP::Response ();
use HTTP::Date ();
@@ -14,14 +12,16 @@ use HTTP::Date ();
use LWP ();
use LWP::Protocol ();
-use Carp ();
+use Scalar::Util qw(blessed);
+use Try::Tiny qw(try catch);
+our $VERSION = '6.25';
sub new
{
# Check for common user mistake
- Carp::croak("Options to LWP::UserAgent should be key/value pairs, not hash reference")
- if ref($_[1]) eq 'HASH';
+ Carp::croak("Options to LWP::UserAgent should be key/value pairs, not hash reference")
+ if ref($_[1]) eq 'HASH';
my($class, %cnf) = @_;
@@ -65,17 +65,19 @@ sub new
my $max_redirect = delete $cnf{max_redirect};
$max_redirect = 7 unless defined $max_redirect;
my $env_proxy = exists $cnf{env_proxy} ? delete $cnf{env_proxy} : $ENV{PERL_LWP_ENV_PROXY};
+ my $no_proxy = exists $cnf{no_proxy} ? delete $cnf{no_proxy} : [];
+ Carp::croak(qq{no_proxy must be an arrayref, not $no_proxy!}) if ref $no_proxy ne 'ARRAY';
my $cookie_jar = delete $cnf{cookie_jar};
my $conn_cache = delete $cnf{conn_cache};
my $keep_alive = delete $cnf{keep_alive};
-
+
Carp::croak("Can't mix conn_cache and keep_alive")
if $conn_cache && $keep_alive;
my $protocols_allowed = delete $cnf{protocols_allowed};
my $protocols_forbidden = delete $cnf{protocols_forbidden};
-
+
my $requests_redirectable = delete $cnf{requests_redirectable};
$requests_redirectable = ['GET', 'HEAD']
unless defined $requests_redirectable;
@@ -88,34 +90,40 @@ sub new
Carp::croak("requests_redirectable has to be an arrayref or 0, not \"$requests_redirectable\"!")
if $requests_redirectable and ref($requests_redirectable) ne 'ARRAY';
-
if (%cnf && $^W) {
Carp::carp("Unrecognized LWP::UserAgent options: @{[sort keys %cnf]}");
}
my $self = bless {
- def_headers => $def_headers,
- timeout => $timeout,
- local_address => $local_address,
- ssl_opts => $ssl_opts,
- use_eval => $use_eval,
- show_progress=> $show_progress,
- max_size => $max_size,
- max_redirect => $max_redirect,
- proxy => {},
- no_proxy => [],
- protocols_allowed => $protocols_allowed,
- protocols_forbidden => $protocols_forbidden,
- requests_redirectable => $requests_redirectable,
- }, $class;
+ def_headers => $def_headers,
+ timeout => $timeout,
+ local_address => $local_address,
+ ssl_opts => $ssl_opts,
+ use_eval => $use_eval,
+ show_progress => $show_progress,
+ max_size => $max_size,
+ max_redirect => $max_redirect,
+ # We set proxy later as we do validation on the values
+ proxy => {},
+ no_proxy => [ @{ $no_proxy } ],
+ protocols_allowed => $protocols_allowed,
+ protocols_forbidden => $protocols_forbidden,
+ requests_redirectable => $requests_redirectable,
+ }, $class;
$self->agent(defined($agent) ? $agent : $class->_agent)
- if defined($agent) || !$def_headers || !$def_headers->header("User-Agent");
+ if defined($agent) || !$def_headers || !$def_headers->header("User-Agent");
$self->from($from) if $from;
$self->cookie_jar($cookie_jar) if $cookie_jar;
$self->parse_head($parse_head);
$self->env_proxy if $env_proxy;
+ if (exists $cnf{proxy}) {
+ Carp::croak(qq{proxy must be an arrayref, not $cnf{proxy}!})
+ if ref $cnf{proxy} ne 'ARRAY';
+ $self->proxy($cnf{proxy});
+ }
+
$self->protocols_allowed( $protocols_allowed ) if $protocols_allowed;
$self->protocols_forbidden($protocols_forbidden) if $protocols_forbidden;
@@ -171,10 +179,13 @@ sub send_request
}
unless ($protocol) {
- $protocol = eval { LWP::Protocol::create($scheme, $self) };
- if ($@) {
- $@ =~ s/ at .* line \d+.*//s; # remove file/line number
- $response = _new_response($request, &HTTP::Status::RC_NOT_IMPLEMENTED, $@);
+ try {
+ $protocol = LWP::Protocol::create($scheme, $self);
+ }
+ catch {
+ my $error = $_;
+ $error =~ s/ at .* line \d+.*//s; # remove file/line number
+ $response = _new_response($request, HTTP::Status::RC_NOT_IMPLEMENTED, $error);
if ($scheme eq "https") {
$response->message($response->message . " (LWP::Protocol::https not installed)");
$response->content_type("text/plain");
@@ -183,28 +194,28 @@ LWP will support https URLs if the LWP::Protocol::https module
is installed.
EOT
}
- }
+ };
}
if (!$response && $self->{use_eval}) {
# we eval, and turn dies into responses below
- eval {
- $response = $protocol->request($request, $proxy, $arg, $size, $self->{timeout}) ||
- die "No response returned by $protocol";
- };
- if ($@) {
- if (UNIVERSAL::isa($@, "HTTP::Response")) {
- $response = $@;
+ try {
+ $response = $protocol->request($request, $proxy, $arg, $size, $self->{timeout}) || die "No response returned by $protocol";
+ }
+ catch {
+ my $error = $_;
+ if (blessed($error) && $error->isa("HTTP::Response")) {
+ $response = $error;
$response->request($request);
}
else {
- my $full = $@;
- (my $status = $@) =~ s/\n.*//s;
+ my $full = $error;
+ (my $status = $error) =~ s/\n.*//s;
$status =~ s/ at .* line \d+.*//s; # remove file/line number
- my $code = ($status =~ s/^(\d\d\d)\s+//) ? $1 : &HTTP::Status::RC_INTERNAL_SERVER_ERROR;
+ my $code = ($status =~ s/^(\d\d\d)\s+//) ? $1 : HTTP::Status::RC_INTERNAL_SERVER_ERROR;
$response = _new_response($request, $code, $status, $full);
}
- }
+ };
}
elsif (!$response) {
$response = $protocol->request($request, $proxy,
@@ -264,27 +275,32 @@ sub simple_request
Carp::croak("No request object passed in");
}
- eval {
- $request = $self->prepare_request($request);
+ my $error;
+ try {
+ $request = $self->prepare_request($request);
+ }
+ catch {
+ $error = $_;
+ $error =~ s/ at .* line \d+.*//s; # remove file/line number
};
- if ($@) {
- $@ =~ s/ at .* line \d+.*//s; # remove file/line number
- return _new_response($request, &HTTP::Status::RC_BAD_REQUEST, $@);
+
+ if ($error) {
+ return _new_response($request, HTTP::Status::RC_BAD_REQUEST, $error);
}
return $self->send_request($request, $arg, $size);
}
-sub request
-{
- my($self, $request, $arg, $size, $previous) = @_;
+sub request {
+ my ($self, $request, $arg, $size, $previous) = @_;
my $response = $self->simple_request($request, $arg, $size);
$response->previous($previous) if $previous;
if ($response->redirects >= $self->{max_redirect}) {
$response->header("Client-Warning" =>
- "Redirect loop detected (max_redirect = $self->{max_redirect})");
+ "Redirect loop detected (max_redirect = $self->{max_redirect})"
+ );
return $response;
}
@@ -294,113 +310,121 @@ sub request
my $code = $response->code;
- if ($code == &HTTP::Status::RC_MOVED_PERMANENTLY or
- $code == &HTTP::Status::RC_FOUND or
- $code == &HTTP::Status::RC_SEE_OTHER or
- $code == &HTTP::Status::RC_TEMPORARY_REDIRECT)
+ if ( $code == HTTP::Status::RC_MOVED_PERMANENTLY
+ or $code == HTTP::Status::RC_FOUND
+ or $code == HTTP::Status::RC_SEE_OTHER
+ or $code == HTTP::Status::RC_TEMPORARY_REDIRECT)
{
- my $referral = $request->clone;
-
- # These headers should never be forwarded
- $referral->remove_header('Host', 'Cookie');
-
- if ($referral->header('Referer') &&
- $request->uri->scheme eq 'https' &&
- $referral->uri->scheme eq 'http')
- {
- # RFC 2616, section 15.1.3.
- # https -> http redirect, suppressing Referer
- $referral->remove_header('Referer');
- }
+ my $referral = $request->clone;
- if ($code == &HTTP::Status::RC_SEE_OTHER ||
- $code == &HTTP::Status::RC_FOUND)
+ # These headers should never be forwarded
+ $referral->remove_header('Host', 'Cookie');
+
+ if ( $referral->header('Referer')
+ && $request->uri->scheme eq 'https'
+ && $referral->uri->scheme eq 'http')
{
- my $method = uc($referral->method);
- unless ($method eq "GET" || $method eq "HEAD") {
- $referral->method("GET");
- $referral->content("");
- $referral->remove_content_headers;
- }
- }
+ # RFC 2616, section 15.1.3.
+ # https -> http redirect, suppressing Referer
+ $referral->remove_header('Referer');
+ }
- # And then we update the URL based on the Location:-header.
- my $referral_uri = $response->header('Location');
- {
- # Some servers erroneously return a relative URL for redirects,
- # so make it absolute if it not already is.
- local $URI::ABS_ALLOW_RELATIVE_SCHEME = 1;
- my $base = $response->base;
- $referral_uri = "" unless defined $referral_uri;
- $referral_uri = $HTTP::URI_CLASS->new($referral_uri, $base)
- ->abs($base);
- }
- $referral->uri($referral_uri);
+ if ( $code == HTTP::Status::RC_SEE_OTHER
+ || $code == HTTP::Status::RC_FOUND)
+ {
+ my $method = uc($referral->method);
+ unless ($method eq "GET" || $method eq "HEAD") {
+ $referral->method("GET");
+ $referral->content("");
+ $referral->remove_content_headers;
+ }
+ }
- return $response unless $self->redirect_ok($referral, $response);
- return $self->request($referral, $arg, $size, $response);
+ # And then we update the URL based on the Location:-header.
+ my $referral_uri = $response->header('Location');
+ {
+ # Some servers erroneously return a relative URL for redirects,
+ # so make it absolute if it not already is.
+ local $URI::ABS_ALLOW_RELATIVE_SCHEME = 1;
+ my $base = $response->base;
+ $referral_uri = "" unless defined $referral_uri;
+ $referral_uri
+ = $HTTP::URI_CLASS->new($referral_uri, $base)->abs($base);
+ }
+ $referral->uri($referral_uri);
+
+ return $response unless $self->redirect_ok($referral, $response);
+ return $self->request($referral, $arg, $size, $response);
}
- elsif ($code == &HTTP::Status::RC_UNAUTHORIZED ||
- $code == &HTTP::Status::RC_PROXY_AUTHENTICATION_REQUIRED
- )
+ elsif ($code == HTTP::Status::RC_UNAUTHORIZED
+ || $code == HTTP::Status::RC_PROXY_AUTHENTICATION_REQUIRED)
{
- my $proxy = ($code == &HTTP::Status::RC_PROXY_AUTHENTICATION_REQUIRED);
- my $ch_header = $proxy || $request->method eq 'CONNECT'
- ? "Proxy-Authenticate" : "WWW-Authenticate";
- my @challenge = $response->header($ch_header);
- unless (@challenge) {
- $response->header("Client-Warning" =>
- "Missing Authenticate header");
- return $response;
- }
+ my $proxy = ($code == HTTP::Status::RC_PROXY_AUTHENTICATION_REQUIRED);
+ my $ch_header
+ = $proxy || $request->method eq 'CONNECT'
+ ? "Proxy-Authenticate"
+ : "WWW-Authenticate";
+ my @challenges = $response->header($ch_header);
+ unless (@challenges) {
+ $response->header(
+ "Client-Warning" => "Missing Authenticate header");
+ return $response;
+ }
- require HTTP::Headers::Util;
- CHALLENGE: for my $challenge (@challenge) {
- $challenge =~ tr/,/;/; # "," is used to separate auth-params!!
- ($challenge) = HTTP::Headers::Util::split_header_words($challenge);
- my $scheme = shift(@$challenge);
- shift(@$challenge); # no value
- $challenge = { @$challenge }; # make rest into a hash
-
- unless ($scheme =~ /^([a-z]+(?:-[a-z]+)*)$/) {
- $response->header("Client-Warning" =>
- "Bad authentication scheme '$scheme'");
- return $response;
- }
- $scheme = $1; # untainted now
- my $class = "LWP::Authen::\u$scheme";
- $class =~ s/-/_/g;
-
- no strict 'refs';
- unless (%{"$class\::"}) {
- # try to load it
- eval "require $class";
- if ($@) {
- if ($@ =~ /^Can\'t locate/) {
- $response->header("Client-Warning" =>
- "Unsupported authentication scheme '$scheme'");
- }
- else {
- $response->header("Client-Warning" => $@);
- }
- next CHALLENGE;
- }
- }
- unless ($class->can("authenticate")) {
- $response->header("Client-Warning" =>
- "Unsupported authentication scheme '$scheme'");
- next CHALLENGE;
- }
- return $class->authenticate($self, $proxy, $challenge, $response,
- $request, $arg, $size);
- }
- return $response;
+ require HTTP::Headers::Util;
+ CHALLENGE: for my $challenge (@challenges) {
+ $challenge =~ tr/,/;/; # "," is used to separate auth-params!!
+ ($challenge) = HTTP::Headers::Util::split_header_words($challenge);
+ my $scheme = shift(@$challenge);
+ shift(@$challenge); # no value
+ $challenge = {@$challenge}; # make rest into a hash
+
+ unless ($scheme =~ /^([a-z]+(?:-[a-z]+)*)$/) {
+ $response->header(
+ "Client-Warning" => "Bad authentication scheme '$scheme'");
+ return $response;
+ }
+ $scheme = $1; # untainted now
+ my $class = "LWP::Authen::\u$scheme";
+ $class =~ s/-/_/g;
+
+ no strict 'refs';
+ unless (%{"$class\::"}) {
+ # try to load it
+ my $error;
+ try {
+ (my $req = $class) =~ s{::}{/}g;
+ $req .= '.pm' unless $req =~ /\.pm$/;
+ require $req;
+ }
+ catch {
+ $error = $_;
+ };
+ if ($error) {
+ if ($error =~ /^Can\'t locate/) {
+ $response->header("Client-Warning" =>
+ "Unsupported authentication scheme '$scheme'");
+ }
+ else {
+ $response->header("Client-Warning" => $error);
+ }
+ next CHALLENGE;
+ }
+ }
+ unless ($class->can("authenticate")) {
+ $response->header("Client-Warning" =>
+ "Unsupported authentication scheme '$scheme'");
+ next CHALLENGE;
+ }
+ return $class->authenticate($self, $proxy, $challenge, $response,
+ $request, $arg, $size);
+ }
+ return $response;
}
return $response;
}
-
#
# Now the shortcuts...
#
@@ -411,12 +435,47 @@ sub get {
return $self->request( HTTP::Request::Common::GET( @parameters ), @suff );
}
+sub _has_raw_content {
+ my $self = shift;
+ shift; # drop url
+
+ # taken from HTTP::Request::Common::request_type_with_data
+ my $content;
+ $content = shift if @_ and ref $_[0];
+ my($k, $v);
+ while (($k,$v) = splice(@_, 0, 2)) {
+ if (lc($k) eq 'content') {
+ $content = $v;
+ }
+ }
+
+ # We were given Content => 'string' ...
+ if (defined $content && ! ref ($content)) {
+ return 1;
+ }
+
+ return;
+}
+
+sub _maybe_copy_default_content_type {
+ my ($self, $req, @parameters) = @_;
+
+ # If we have a default Content-Type and someone passes in a POST/PUT
+ # with Content => 'some-string-value', use that Content-Type instead
+ # of x-www-form-urlencoded
+ my $ct = $self->default_header('Content-Type');
+ return unless defined $ct && $self->_has_raw_content(@parameters);
+
+ $req->header('Content-Type' => $ct);
+}
sub post {
require HTTP::Request::Common;
my($self, @parameters) = @_;
my @suff = $self->_process_colonic_headers(\@parameters, (ref($parameters[1]) ? 2 : 1));
- return $self->request( HTTP::Request::Common::POST( @parameters ), @suff );
+ my $req = HTTP::Request::Common::POST(@parameters);
+ $self->_maybe_copy_default_content_type($req, @parameters);
+ return $self->request($req, @suff);
}
@@ -432,7 +491,9 @@ sub put {
require HTTP::Request::Common;
my($self, @parameters) = @_;
my @suff = $self->_process_colonic_headers(\@parameters, (ref($parameters[1]) ? 2 : 1));
- return $self->request( HTTP::Request::Common::PUT( @parameters ), @suff );
+ my $req = HTTP::Request::Common::PUT(@parameters);
+ $self->_maybe_copy_default_content_type($req, @parameters);
+ return $self->request($req, @suff);
}
@@ -460,7 +521,7 @@ sub _process_colonic_headers {
Carp::croak("A :content_cb value can't be undef") unless defined $arg;
Carp::croak("A :content_cb value must be a coderef")
unless ref $arg and UNIVERSAL::isa($arg, 'CODE');
-
+
}
elsif ($args->[$i] eq ':content_file') {
$arg = $args->[$i + 1];
@@ -588,13 +649,13 @@ sub redirect_ok
my $method = $response->request->method;
return 0 unless grep $_ eq $method,
@{ $self->requests_redirectable || [] };
-
+
if ($new_request->uri->scheme eq 'file') {
$response->header("Client-Warning" =>
"Can't redirect to a file:// URL!");
return 0;
}
-
+
# Otherwise it's apparently okay...
return 1;
}
@@ -726,7 +787,7 @@ sub default_header {
return $self->default_headers->header(@_);
}
-sub _agent { "libwww-perl/$LWP::VERSION" }
+sub _agent { "libwww-perl/$VERSION" }
sub agent {
my $self = shift;
@@ -917,7 +978,7 @@ sub mirror
}
# Only fetching a fresh copy of the would be considered success.
- # If the file was not modified, "304" would returned, which
+ # If the file was not modified, "304" would returned, which
# is considered by HTTP::Status to be a "redirect", /not/ "success"
if ( $response->is_success ) {
my @stat = stat($tmpfile) or die "Could not stat tmpfile '$tmpfile': $!";
@@ -932,7 +993,7 @@ sub mirror
unlink($tmpfile);
die "Content-length mismatch: " . "expected $content_length bytes, got $file_length\n";
}
- # The file was the expected length.
+ # The file was the expected length.
else {
# Replace the stale file with a fresh copy
if ( -e $file ) {
@@ -949,7 +1010,7 @@ sub mirror
}
}
}
- # The local copy is fresh enough, so just delete the temp file
+ # The local copy is fresh enough, so just delete the temp file
else {
unlink($tmpfile);
}
@@ -974,11 +1035,18 @@ sub _need_proxy {
}
-sub proxy
-{
+sub proxy {
my $self = shift;
my $key = shift;
- return map $self->proxy($_, @_), @$key if ref $key;
+ if (!@_ && ref $key eq 'ARRAY') {
+ die 'odd number of items in proxy arrayref!' unless @{$key} % 2 == 0;
+
+ # This map reads the elements of $key 2 at a time
+ return
+ map { $self->proxy($key->[2 * $_], $key->[2 * $_ + 1]) }
+ (0 .. @{$key} / 2 - 1);
+ }
+ return map { $self->proxy($_, @_) } @$key if ref $key;
Carp::croak("'$key' is not a valid URI scheme") unless $key =~ /^$URI::scheme_re\z/;
my $old = $self->{'proxy'}{$key};
@@ -1052,20 +1120,24 @@ sub _new_response {
__END__
+=pod
+
=head1 NAME
LWP::UserAgent - Web user agent class
=head1 SYNOPSIS
- require LWP::UserAgent;
-
+ use strict;
+ use warnings;
+ use LWP::UserAgent ();
+
my $ua = LWP::UserAgent->new;
$ua->timeout(10);
$ua->env_proxy;
-
+
my $response = $ua->get('http://search.cpan.org/');
-
+
if ($response->is_success) {
print $response->decoded_content; # or whatever
}
@@ -1075,35 +1147,48 @@ LWP::UserAgent - Web user agent class
=head1 DESCRIPTION
-The C<LWP::UserAgent> is a class implementing a web user agent.
-C<LWP::UserAgent> objects can be used to dispatch web requests.
+The L<LWP::UserAgent> is a class implementing a web user agent.
+L<LWP::UserAgent> objects can be used to dispatch web requests.
-In normal use the application creates an C<LWP::UserAgent> object, and
+In normal use the application creates an L<LWP::UserAgent> object, and
then configures it with values for timeouts, proxies, name, etc. It
-then creates an instance of C<HTTP::Request> for the request that
+then creates an instance of L<HTTP::Request> for the request that
needs to be performed. This request is then passed to one of the
request method the UserAgent, which dispatches it using the relevant
-protocol, and returns a C<HTTP::Response> object. There are
-convenience methods for sending the most common request types: get(),
-head(), post(), put() and delete(). When using these methods then the
-creation of the request object is hidden as shown in the synopsis above.
-
-The basic approach of the library is to use HTTP style communication
+protocol, and returns a L<HTTP::Response> object. There are
+convenience methods for sending the most common request types:
+L<LWP::UserAgent/get>, L<LWP::UserAgent/head>, L<LWP::UserAgent/post>,
+L<LWP::UserAgent/put> and L<LWP::UserAgent/delete>. When using these
+methods, the creation of the request object is hidden as shown in the
+synopsis above.
+
+The basic approach of the library is to use HTTP-style communication
for all protocol schemes. This means that you will construct
-C<HTTP::Request> objects and receive C<HTTP::Response> objects even
+L<HTTP::Request> objects and receive L<HTTP::Response> objects even
for non-HTTP resources like I<gopher> and I<ftp>. In order to achieve
-even more similarity to HTTP style communications, gopher menus and
+even more similarity to HTTP-style communications, I<gopher> menus and
file directories are converted to HTML documents.
=head1 CONSTRUCTOR METHODS
The following constructor methods are available:
-=over 4
+=head2 clone
-=item $ua = LWP::UserAgent->new( %options )
+ my $ua2 = $ua->clone;
-This method constructs a new C<LWP::UserAgent> object and returns it.
+Returns a copy of the L<LWP::UserAgent> object.
+
+B<CAVEAT>: Please be aware that the clone method does not copy or clone your
+C<cookie_jar> attribute. Due to the limited restrictions on what can be used
+for your cookie jar, there is no way to clone the attribute. The C<cookie_jar>
+attribute will be C<undef> in the new object instance.
+
+=head2 new
+
+ my $ua = LWP::UserAgent->new( %options )
+
+This method constructs a new L<LWP::UserAgent> object and returns it.
Key/value pair arguments may be provided to set up the initial state.
The following options correspond to attribute methods described below:
@@ -1115,7 +1200,7 @@ The following options correspond to attribute methods described below:
cookie_jar undef
default_headers HTTP::Headers->new
local_address undef
- ssl_opts { verify_hostname => 1 }
+ ssl_opts { verify_hostname => 1 }
max_size undef
max_redirect 7
parse_head 1
@@ -1123,92 +1208,77 @@ The following options correspond to attribute methods described below:
protocols_forbidden undef
requests_redirectable ['GET', 'HEAD']
timeout 180
+ proxy undef
+ no_proxy []
The following additional options are also accepted: If the C<env_proxy> option
-is passed in with a TRUE value, then proxy settings are read from environment
-variables (see env_proxy() method below). If C<env_proxy> isn't provided the
-C<PERL_LWP_ENV_PROXY> environment variable controls if env_proxy() is called
-during initialization. If the C<keep_alive> option is passed in, then a
-C<LWP::ConnCache> is set up (see conn_cache() method below). The C<keep_alive>
-value is passed on as the C<total_capacity> for the connection cache.
-
-=item $ua->clone
+is passed in with a true value, then proxy settings are read from environment
+variables (see L<LWP::UserAgent/env_proxy>). If C<env_proxy> isn't provided, the
+C<PERL_LWP_ENV_PROXY> environment variable controls if
+L<LWP::UserAgent/env_proxy> is called during initialization. If the
+C<keep_alive> option is passed in, then a C<LWP::ConnCache> is set up (see
+L<LWP::UserAgent/conn_cache>). The C<keep_alive> value is passed on as the
+C<total_capacity> for the connection cache.
-Returns a copy of the LWP::UserAgent object.
-
-=back
+C<proxy> must be set as an arrayref of key/value pairs. C<no_proxy> takes an
+arrayref of domains.
=head1 ATTRIBUTES
The settings of the configuration attributes modify the behaviour of the
-C<LWP::UserAgent> when it dispatches requests. Most of these can also
+L<LWP::UserAgent> when it dispatches requests. Most of these can also
be initialized by options passed to the constructor method.
The following attribute methods are provided. The attribute value is
left unchanged if no argument is given. The return value from each
method is the old attribute value.
-=over
-
-=item $ua->agent
+=head2 agent
-=item $ua->agent( $product_id )
+ my $agent = $ua->agent;
+ $ua->agent('Checkbot/0.4 '); # append the defaul to the end
+ $ua->agent('Mozilla/5.0');
+ $ua->agent(""); # don't identify
Get/set the product token that is used to identify the user agent on
-the network. The agent value is sent as the "User-Agent" header in
-the requests. The default is the string returned by the _agent()
-method (see below).
+the network. The agent value is sent as the C<User-Agent> header in
+the requests.
-If the $product_id ends with space then the _agent() string is
-appended to it.
+The default is a string of the form C<libwww-perl/#.###>, where C<#.###> is
+substituted with the version number of this library.
-The user agent string should be one or more simple product identifiers
-with an optional version number separated by the "/" character.
-Examples are:
-
- $ua->agent('Checkbot/0.4 ' . $ua->_agent);
- $ua->agent('Checkbot/0.4 '); # same as above
- $ua->agent('Mozilla/5.0');
- $ua->agent(""); # don't identify
-
-=item $ua->_agent
-
-Returns the default agent identifier. This is a string of the form
-"libwww-perl/#.###", where "#.###" is substituted with the version number
-of this library.
-
-=item $ua->from
+If the provided string ends with space, the default C<libwww-perl/#.###>
+string is appended to it.
-=item $ua->from( $email_address )
+The user agent string should be one or more simple product identifiers
+with an optional version number separated by the C</> character.
-Get/set the e-mail address for the human user who controls
-the requesting user agent. The address should be machine-usable, as
-defined in RFC 822. The C<from> value is send as the "From" header in
-the requests. Example:
+=head2 conn_cache
- $ua->from('gaas@cpan.org');
+ my $cache_obj = $ua->conn_cache;
+ $ua->conn_cache( $cache_obj );
-The default is to not send a "From" header. See the default_headers()
-method for the more general interface that allow any header to be defaulted.
+Get/set the L<LWP::ConnCache> object to use. See L<LWP::ConnCache>
+for details.
-=item $ua->cookie_jar
+=head2 cookie_jar
-=item $ua->cookie_jar( $cookie_jar_obj )
+ my $jar = $ua->cookie_jar;
+ $ua->cookie_jar( $cookie_jar_obj );
Get/set the cookie jar object to use. The only requirement is that
-the cookie jar object must implement the extract_cookies($response) and
-add_cookie_header($request) methods. These methods will then be
+the cookie jar object must implement the C<extract_cookies($response)> and
+C<add_cookie_header($request)> methods. These methods will then be
invoked by the user agent as requests are sent and responses are
-received. Normally this will be a C<HTTP::Cookies> object or some
+received. Normally this will be a L<HTTP::Cookies> object or some
subclass.
-The default is to have no cookie_jar, i.e. never automatically add
-"Cookie" headers to the requests.
+The default is to have no cookie jar, i.e. never automatically add
+C<Cookie> headers to the requests.
-Shortcut: If a reference to a plain hash is passed in as the
-$cookie_jar_object, then it is replaced with an instance of
-C<HTTP::Cookies> that is initialized based on the hash. This form also
-automatically loads the C<HTTP::Cookies> module. It means that:
+Shortcut: If a reference to a plain hash is passed in, it is replaced with an
+instance of L<HTTP::Cookies> that is initialized based on the hash. This form
+also automatically loads the L<HTTP::Cookies> module. It means that:
$ua->cookie_jar({ file => "$ENV{HOME}/.cookies.txt" });
@@ -1217,154 +1287,161 @@ is really just a shortcut for:
require HTTP::Cookies;
$ua->cookie_jar(HTTP::Cookies->new(file => "$ENV{HOME}/.cookies.txt"));
-=item $ua->default_headers
+=head2 credentials
-=item $ua->default_headers( $headers_obj )
+ my $creds = $ua->credentials();
+ $ua->credentials( $netloc, $realm );
+ $ua->credentials( $netloc, $realm, $uname, $pass );
+ $ua->credentials("www.example.com:80", "Some Realm", "foo", "secret");
-Get/set the headers object that will provide default header values for
-any requests sent. By default this will be an empty C<HTTP::Headers>
-object.
+Get/set the user name and password to be used for a realm.
-=item $ua->default_header( $field )
+The C<$netloc> is a string of the form C<< <host>:<port> >>. The username and
+password will only be passed to this server.
-=item $ua->default_header( $field => $value )
+=head2 default_header
-This is just a short-cut for $ua->default_headers->header( $field =>
-$value ). Example:
+ $ua->default_header( $field );
+ $ua->default_header( $field => $value );
+ $ua->default_header('Accept-Encoding' => scalar HTTP::Message::decodable());
+ $ua->default_header('Accept-Language' => "no, en");
- $ua->default_header('Accept-Encoding' => scalar HTTP::Message::decodable());
- $ua->default_header('Accept-Language' => "no, en");
+This is just a shortcut for
+C<< $ua->default_headers->header( $field => $value ) >>.
-=item $ua->conn_cache
+=head2 default_headers
-=item $ua->conn_cache( $cache_obj )
+ my $headers = $ua->default_headers;
+ $ua->default_headers( $headers_obj );
-Get/set the C<LWP::ConnCache> object to use. See L<LWP::ConnCache>
-for details.
+Get/set the headers object that will provide default header values for
+any requests sent. By default this will be an empty L<HTTP::Headers>
+object.
-=item $ua->credentials( $netloc, $realm )
+=head2 from
-=item $ua->credentials( $netloc, $realm, $uname, $pass )
+ my $from = $ua->from;
+ $ua->from('foo@bar.com');
-Get/set the user name and password to be used for a realm.
+Get/set the email address for the human user who controls
+the requesting user agent. The address should be machine-usable, as
+defined in L<RFC2822|https://tools.ietf.org/html/rfc2822>. The C<from> value
+is sent as the C<From> header in the requests.
-The $netloc is a string of the form "<host>:<port>". The username and
-password will only be passed to this server. Example:
+The default is to not send a C<From> header. See
+L<LWP::UserAgent/default_headers> for the more general interface that allow
+any header to be defaulted.
- $ua->credentials("www.example.com:80", "Some Realm", "foo", "secret");
-=item $ua->local_address
+=head2 local_address
-=item $ua->local_address( $address )
+ my $address = $ua->local_address;
+ $ua->local_address( $address );
Get/set the local interface to bind to for network connections. The interface
can be specified as a hostname or an IP address. This value is passed as the
C<LocalAddr> argument to L<IO::Socket::INET>.
-=item $ua->max_size
+=head2 max_redirect
+
+ my $max = $ua->max_redirect;
+ $ua->max_redirect( $n );
+
+This reads or sets the object's limit of how many times it will obey
+redirection responses in a given request cycle.
+
+By default, the value is C<7>. This means that if you call L<LWP::UserAgent/request>
+and the response is a redirect elsewhere which is in turn a
+redirect, and so on seven times, then LWP gives up after that seventh
+request.
+
+=head2 max_size
-=item $ua->max_size( $bytes )
+ my $size = $ua->max_size;
+ $ua->max_size( $bytes );
Get/set the size limit for response content. The default is C<undef>,
which means that there is no limit. If the returned response content
is only partial, because the size limit was exceeded, then a
-"Client-Aborted" header will be added to the response. The content
+C<Client-Aborted> header will be added to the response. The content
might end up longer than C<max_size> as we abort once appending a
-chunk of data makes the length exceed the limit. The "Content-Length"
+chunk of data makes the length exceed the limit. The C<Content-Length>
header, if present, will indicate the length of the full content and
will normally not be the same as C<< length($res->content) >>.
-=item $ua->max_redirect
+=head2 parse_head
-=item $ua->max_redirect( $n )
-
-This reads or sets the object's limit of how many times it will obey
-redirection responses in a given request cycle.
-
-By default, the value is 7. This means that if you call request()
-method and the response is a redirect elsewhere which is in turn a
-redirect, and so on seven times, then LWP gives up after that seventh
-request.
-
-=item $ua->parse_head
-
-=item $ua->parse_head( $boolean )
+ my $bool = $ua->parse_head;
+ $ua->parse_head( $boolean );
Get/set a value indicating whether we should initialize response
headers from the E<lt>head> section of HTML documents. The default is
-TRUE. Do not turn this off, unless you know what you are doing.
+true. I<Do not turn this off> unless you know what you are doing.
-=item $ua->protocols_allowed
+=head2 protocols_allowed
-=item $ua->protocols_allowed( \@protocols )
+ my $aref = $ua->protocols_allowed; # get allowed protocols
+ $ua->protocols_allowed( \@protocols ); # allow ONLY these
+ $ua->protocols_allowed(undef); # delete the list
+ $ua->protocols_allowed(['http',]); # ONLY allow http
+
+By default, an object has neither a C<protocols_allowed> list, nor a
+L<LWP::UserAgent/protocols_forbidden> list.
This reads (or sets) this user agent's list of protocols that the
request methods will exclusively allow. The protocol names are case
insensitive.
-For example: C<$ua-E<gt>protocols_allowed( [ 'http', 'https'] );>
+For example: C<< $ua->protocols_allowed( [ 'http', 'https'] ); >>
means that this user agent will I<allow only> those protocols,
and attempts to use this user agent to access URLs with any other
-schemes (like "ftp://...") will result in a 500 error.
-
-To delete the list, call: C<$ua-E<gt>protocols_allowed(undef)>
-
-By default, an object has neither a C<protocols_allowed> list, nor a
-C<protocols_forbidden> list.
+schemes (like C<ftp://...>) will result in a 500 error.
Note that having a C<protocols_allowed> list causes any
-C<protocols_forbidden> list to be ignored.
+L<LWP::UserAgent/protocols_forbidden> list to be ignored.
-=item $ua->protocols_forbidden
+=head2 protocols_forbidden
-=item $ua->protocols_forbidden( \@protocols )
+ my $aref = $ua->protocols_forbidden; # get the forbidden list
+ $ua->protocols_forbidden(\@protocols); # do not allow these
+ $ua->protocols_forbidden(['http',]); # All http reqs get a 500
+ $ua->protocols_forbidden(undef); # delete the list
This reads (or sets) this user agent's list of protocols that the
request method will I<not> allow. The protocol names are case
insensitive.
-For example: C<$ua-E<gt>protocols_forbidden( [ 'file', 'mailto'] );>
+For example: C<< $ua->protocols_forbidden( [ 'file', 'mailto'] ); >>
means that this user agent will I<not> allow those protocols, and
attempts to use this user agent to access URLs with those schemes
will result in a 500 error.
-To delete the list, call: C<$ua-E<gt>protocols_forbidden(undef)>
-
-=item $ua->requests_redirectable
+=head2 requests_redirectable
-=item $ua->requests_redirectable( \@requests )
+ my $aref = $ua->requests_redirectable;
+ $ua->requests_redirectable( \@requests );
+ $ua->requests_redirectable(['GET', 'HEAD',]); # the default
This reads or sets the object's list of request names that
-C<$ua-E<gt>redirect_ok(...)> will allow redirection for. By
-default, this is C<['GET', 'HEAD']>, as per RFC 2616. To
-change to include 'POST', consider:
+L<LWP::UserAgent/redirect_ok> will allow redirection for. By default, this
+is C<['GET', 'HEAD']>, as per L<RFC 2616|https://tools.ietf.org/html/rfc2616>.
+To change to include C<POST>, consider:
push @{ $ua->requests_redirectable }, 'POST';
-=item $ua->show_progress
+=head2 show_progress
-=item $ua->show_progress( $boolean )
+ my $bool = $ua->show_progress;
+ $ua->show_progress( $boolean );
Get/set a value indicating whether a progress bar should be displayed
-on the terminal as requests are processed. The default is FALSE.
+on the terminal as requests are processed. The default is false.
-=item $ua->timeout
+=head2 ssl_opts
-=item $ua->timeout( $secs )
-
-Get/set the timeout value in seconds. The default timeout() value is
-180 seconds, i.e. 3 minutes.
-
-The requests is aborted if no activity on the connection to the server
-is observed for C<timeout> seconds. This means that the time it takes
-for the complete transaction and the request() method to actually
-return might be longer.
-
-=item $ua->ssl_opts
-
-=item $ua->ssl_opts( $key )
-
-=item $ua->ssl_opts( $key => $value )
+ my @keys = $ua->ssl_opts;
+ my $val = $ua->ssl_opts( $key );
+ $ua->ssl_opts( $key => $value );
Get/set the options for SSL connections. Without argument return the list
of options keys currently set. With a single argument return the current
@@ -1408,41 +1485,29 @@ The libwww-perl core no longer bundles protocol plugins for SSL. You will need
to install L<LWP::Protocol::https> separately to enable support for processing
https-URLs.
-=back
+=head2 timeout
-=head2 Proxy attributes
+ my $secs = $ua->timeout;
+ $ua->timeout( $secs );
-The following methods set up when requests should be passed via a
-proxy server.
-
-=over
-
-=item $ua->proxy(\@schemes, $proxy_url)
-
-=item $ua->proxy($scheme, $proxy_url)
-
-Set/retrieve proxy URL for a scheme:
-
- $ua->proxy(['http', 'ftp'], 'http://proxy.sn.no:8001/');
- $ua->proxy('gopher', 'http://proxy.sn.no:8001/');
-
-The first form specifies that the URL is to be used for proxying of
-access methods listed in the list in the first method argument,
-i.e. 'http' and 'ftp'.
+Get/set the timeout value in seconds. The default value is
+180 seconds, i.e. 3 minutes.
-The second form shows a shorthand form for specifying
-proxy URL for a single access scheme.
+The requests is aborted if no activity on the connection to the server
+is observed for C<timeout> seconds. This means that the time it takes
+for the complete transaction and the L<LWP::UserAgent/request> method to
+actually return might be longer.
-=item $ua->no_proxy( $domain, ... )
+=head1 PROXY ATTRIBUTES
-Do not proxy requests to the given domains. Calling no_proxy without
-any domains clears the list of domains. Eg:
+The following methods set up when requests should be passed via a
+proxy server.
- $ua->no_proxy('localhost', 'example.com');
+=head2 env_proxy
-=item $ua->env_proxy
+ $ua->env_proxy;
-Load proxy settings from *_proxy environment variables. You might
+Load proxy settings from C<*_proxy> environment variables. You might
specify proxies like this (sh-syntax):
gopher_proxy=http://proxy.my.place/
@@ -1455,36 +1520,87 @@ environment variables.
On systems with case insensitive environment variables there exists a
name clash between the CGI environment variables and the C<HTTP_PROXY>
-environment variable normally picked up by env_proxy(). Because of
+environment variable normally picked up by C<env_proxy>. Because of
this C<HTTP_PROXY> is not honored for CGI scripts. The
C<CGI_HTTP_PROXY> environment variable can be used instead.
-=back
+=head2 no_proxy
+
+ $ua->no_proxy( @domains );
+ $ua->no_proxy('localhost', 'example.com');
+ $ua->no_proxy(); # clear the list
+
+Do not proxy requests to the given domains. Calling C<no_proxy> without
+any domains clears the list of domains.
+
+=head2 proxy
+
+ $ua->proxy(\@schemes, $proxy_url)
+ $ua->proxy(['http', 'ftp'], 'http://proxy.sn.no:8001/');
+
+ # For a single scheme:
+ $ua->proxy($scheme, $proxy_url)
+ $ua->proxy('gopher', 'http://proxy.sn.no:8001/');
+
+ # To set multiple proxies at once:
+ $ua->proxy([
+ ftp => 'http://ftp.example.com:8001/',
+ [ 'http', 'https' ] => 'http://http.example.com:8001/',
+ ]);
+
+Set/retrieve proxy URL for a scheme.
+
+The first form specifies that the URL is to be used as a proxy for
+access methods listed in the list in the first method argument,
+i.e. C<http> and C<ftp>.
+
+The second form shows a shorthand form for specifying
+proxy URL for a single access scheme.
+
+The third form demonstrates setting multiple proxies at once. This is also
+the only form accepted by the constructor.
-=head2 Handlers
+=head1 HANDLERS
Handlers are code that injected at various phases during the
processing of requests. The following methods are provided to manage
the active handlers:
-=over
+=head2 add_handler
-=item $ua->add_handler( $phase => \&cb, %matchspec )
+ $ua->add_handler( $phase => \&cb, %matchspec )
Add handler to be invoked in the given processing phase. For how to
-specify %matchspec see L<HTTP::Config/"Matching">.
+specify C<%matchspec> see L<HTTP::Config/"Matching">.
-The possible values $phase and the corresponding callback signatures are:
+The possible values C<$phase> and the corresponding callback signatures are:
=over
-=item request_preprepare => sub { my($request, $ua, $h) = @_; ... }
+=item response_data => sub { my($response, $ua, $h, $data) = @_; ... }
-The handler is called before the C<request_prepare> and other standard
-initialization of the request. This can be used to set up headers
-and attributes that the C<request_prepare> handler depends on. Proxy
-initialization should take place here; but in general don't register
-handlers for this phase.
+This handler is called for each chunk of data received for the
+response. The handler might croak to abort the request.
+
+This handler needs to return a TRUE value to be called again for
+subsequent chunks for the same request.
+
+=item response_done => sub { my($response, $ua, $h) = @_; ... }
+
+The handler is called after the response has been fully received, but
+before any redirect handling is attempted. The handler can be used to
+extract information or modify the response.
+
+=item response_header => sub { my($response, $ua, $h) = @_; ... }
+
+This handler is called right after the response headers have been
+received, but before any content data. The handler might set up
+handlers for data and might croak to abort the request.
+
+The handler might set the $response->{default_add_content} value to
+control if any received data should be added to the response object
+directly. This will initially be false if the $ua->request() method
+was called with a $content_file or $content_cb argument; otherwise true.
=item request_prepare => sub { my($request, $ua, $h) = @_; ... }
@@ -1499,6 +1615,14 @@ The return value from the callback is ignored. If an exception is
raised it will abort the request and make the request method return a
"400 Bad request" response.
+=item request_preprepare => sub { my($request, $ua, $h) = @_; ... }
+
+The handler is called before the C<request_prepare> and other standard
+initialization of the request. This can be used to set up headers
+and attributes that the C<request_prepare> handler depends on. Proxy
+initialization should take place here; but in general don't register
+handlers for this phase.
+
=item request_send => sub { my($request, $ua, $h) = @_; ... }
This handler gets a chance of handling requests before they're sent to the
@@ -1508,31 +1632,6 @@ wishes to terminate the processing; otherwise it should return nothing.
The C<response_header> and C<response_data> handlers will not be
invoked for this response, but the C<response_done> will be.
-=item response_header => sub { my($response, $ua, $h) = @_; ... }
-
-This handler is called right after the response headers have been
-received, but before any content data. The handler might set up
-handlers for data and might croak to abort the request.
-
-The handler might set the $response->{default_add_content} value to
-control if any received data should be added to the response object
-directly. This will initially be false if the $ua->request() method
-was called with a $content_file or $content_cb argument; otherwise true.
-
-=item response_data => sub { my($response, $ua, $h, $data) = @_; ... }
-
-This handler is called for each chunk of data received for the
-response. The handler might croak to abort the request.
-
-This handler needs to return a TRUE value to be called again for
-subsequent chunks for the same request.
-
-=item response_done => sub { my($response, $ua, $h) = @_; ... }
-
-The handler is called after the response has been fully received, but
-before any redirect handling is attempted. The handler can be used to
-extract information or modify the response.
-
=item response_redirect => sub { my($response, $ua, $h) = @_; ... }
The handler is called in $ua->request after C<response_done>. If the
@@ -1541,60 +1640,77 @@ this request instead.
=back
-=item $ua->remove_handler( undef, %matchspec )
+=head2 get_my_handler
-=item $ua->remove_handler( $phase, %matchspec )
+ $ua->get_my_handler( $phase, %matchspec );
+ $ua->get_my_handler( $phase, %matchspec, $init );
-Remove handlers that match the given %matchspec. If $phase is not
-provided remove handlers from all phases.
+Will retrieve the matching handler as hash ref.
-Be careful as calling this function with %matchspec that is not
-specific enough can remove handlers not owned by you. It's probably
-better to use the set_my_handler() method instead.
+If C<$init> is passed as a true value, create and add the
+handler if it's not found. If C<$init> is a subroutine reference, then
+it's called with the created handler hash as argument. This sub might
+populate the hash with extra fields; especially the callback. If
+C<$init> is a hash reference, merge the hashes.
-The removed handlers are returned.
+=head2 handlers
-=item $ua->set_my_handler( $phase, $cb, %matchspec )
+ $ua->handlers( $phase, $request )
+ $ua->handlers( $phase, $response )
-Set handlers private to the executing subroutine. Works by defaulting
-an C<owner> field to the %matchspec that holds the name of the called
-subroutine. You might pass an explicit C<owner> to override this.
+Returns the handlers that apply to the given request or response at
+the given processing phase.
-If $cb is passed as C<undef>, remove the handler.
+=head2 remove_handler
-=item $ua->get_my_handler( $phase, %matchspec )
+ $ua->remove_handler( undef, %matchspec );
+ $ua->remove_handler( $phase, %matchspec );
+ $ua->remove_handlers(); # REMOVE ALL HANDLERS IN ALL PHASES
-=item $ua->get_my_handler( $phase, %matchspec, $init )
+Remove handlers that match the given C<%matchspec>. If C<$phase> is not
+provided, remove handlers from all phases.
-Will retrieve the matching handler as hash ref.
+Be careful as calling this function with C<%matchspec> that is not
+specific enough can remove handlers not owned by you. It's probably
+better to use the L<LWP::UserAgent/set_my_handler> method instead.
-If C<$init> is passed as a TRUE value, create and add the
-handler if it's not found. If $init is a subroutine reference, then
-it's called with the created handler hash as argument. This sub might
-populate the hash with extra fields; especially the callback. If
-$init is a hash reference, merge the hashes.
+The removed handlers are returned.
-=item $ua->handlers( $phase, $request )
+=head2 set_my_handler
-=item $ua->handlers( $phase, $response )
+ $ua->set_my_handler( $phase, $cb, %matchspec );
+ $ua->set_my_handler($phase, undef); # remove handler for phase
-Returns the handlers that apply to the given request or response at
-the given processing phase.
+Set handlers private to the executing subroutine. Works by defaulting
+an C<owner> field to the C<%matchspec> that holds the name of the called
+subroutine. You might pass an explicit C<owner> to override this.
-=back
+If $cb is passed as C<undef>, remove the handler.
=head1 REQUEST METHODS
The methods described in this section are used to dispatch requests
via the user agent. The following request methods are provided:
-=over
+=head2 delete
-=item $ua->get( $url )
+ my $res = $ua->delete( $url );
+ my $res = $ua->delete( $url, $field_name => $value, ... );
-=item $ua->get( $url , $field_name => $value, ... )
+This method will dispatch a C<DELETE> request on the given URL. Additional
+headers and content options are the same as for the L<LWP::UserAgent/get>
+method.
-This method will dispatch a C<GET> request on the given $url. Further
+This method will use the DELETE() function from L<HTTP::Request::Common>
+to build the request. See L<HTTP::Request::Common> for a details on
+how to pass form content and other advanced features.
+
+=head2 get
+
+ my $res = $ua->get( $url );
+ my $res = $ua->get( $url , $field_name => $value, ... );
+
+This method will dispatch a C<GET> request on the given URL. Further
arguments can be given to initialize the headers of the request. These
are given as separate name/value pairs. The return value is a
response object. See L<HTTP::Response> for a description of the
@@ -1627,7 +1743,10 @@ object itself. This might not be suitable for very large response
bodies. Only one of C<:content_file> or C<:content_cb> can be
specified. The content of unsuccessful responses will always
accumulate in the response object itself, regardless of the
-C<:content_file> or C<:content_cb> options passed in.
+C<:content_file> or C<:content_cb> options passed in. Note that errors
+writing to the content file (for example due to permission denied
+or the filesystem being full) will be reported via the C<Client-Aborted>
+or C<X-Died> response headers, and not the C<is_success> method.
The C<:read_size_hint> option is passed to the protocol module which
will try to read data from the server in chunks of this size. A
@@ -1640,103 +1759,123 @@ object. The callback can abort the request by invoking die(). The
exception message will show up as the "X-Died" header field in the
response returned by the get() function.
-=item $ua->head( $url )
+=head2 head
-=item $ua->head( $url , $field_name => $value, ... )
+ my $res = $ua->head( $url );
+ my $res = $ua->head( $url , $field_name => $value, ... );
-This method will dispatch a C<HEAD> request on the given $url.
-Otherwise it works like the get() method described above.
+This method will dispatch a C<HEAD> request on the given URL.
+Otherwise it works like the L<LWP::UserAgent/get> method described above.
-=item $ua->post( $url, \%form )
+=head2 is_protocol_supported
-=item $ua->post( $url, \@form )
+ my $bool = $ua->is_protocol_supported( $scheme );
-=item $ua->post( $url, \%form, $field_name => $value, ... )
+You can use this method to test whether this user agent object supports the
+specified C<scheme>. (The C<scheme> might be a string (like C<http> or
+C<ftp>) or it might be an L<URI> object reference.)
-=item $ua->post( $url, $field_name => $value,... Content => \%form )
+Whether a scheme is supported is determined by the user agent's
+C<protocols_allowed> or C<protocols_forbidden> lists (if any), and by
+the capabilities of LWP. I.e., this will return true only if LWP
+supports this protocol I<and> it's permitted for this particular
+object.
-=item $ua->post( $url, $field_name => $value,... Content => \@form )
+=head2 is_online
-=item $ua->post( $url, $field_name => $value,... Content => $content )
+ my $bool = $ua->is_online;
-This method will dispatch a C<POST> request on the given $url, with
-%form or @form providing the key/value pairs for the fill-in form
-content. Additional headers and content options are the same as for
-the get() method.
+Tries to determine if you have access to the Internet. Returns C<1> (true)
+if the built-in heuristics determine that the user agent is
+able to access the Internet (over HTTP) or C<0> (false).
-This method will use the POST() function from C<HTTP::Request::Common>
-to build the request. See L<HTTP::Request::Common> for a details on
-how to pass form content and other advanced features.
+See also L<LWP::Online>.
-=item $ua->put( $url, \%form )
+=head2 mirror
-=item $ua->put( $url, \@form )
+ my $res = $ua->mirror( $url, $filename );
-=item $ua->put( $url, \%form, $field_name => $value, ... )
+This method will get the document identified by URL and store it in
+file called C<$filename>. If the file already exists, then the request
+will contain an C<If-Modified-Since> header matching the modification
+time of the file. If the document on the server has not changed since
+this time, then nothing happens. If the document has been updated, it
+will be downloaded again. The modification time of the file will be
+forced to match that of the server.
-=item $ua->put( $url, $field_name => $value,... Content => \%form )
+The return value is an L<HTTP::Response> object.
-=item $ua->put( $url, $field_name => $value,... Content => \@form )
+=head2 post
-=item $ua->put( $url, $field_name => $value,... Content => $content )
+ my $res = $ua->post( $url, \%form );
+ my $res = $ua->post( $url, \@form );
+ my $res = $ua->post( $url, \%form, $field_name => $value, ... );
+ my $res = $ua->post( $url, $field_name => $value, Content => \%form );
+ my $res = $ua->post( $url, $field_name => $value, Content => \@form );
+ my $res = $ua->post( $url, $field_name => $value, Content => $content );
-This method will dispatch a C<PUT> request on the given $url, with
-%form or @form providing the key/value pairs for the fill-in form
+This method will dispatch a C<POST> request on the given URL, with
+C<%form> or C<@form> providing the key/value pairs for the fill-in form
content. Additional headers and content options are the same as for
-the get() method.
+the L<LWP::UserAgent/get> method.
-This method will use the PUT() function from C<HTTP::Request::Common>
+This method will use the C<POST> function from L<HTTP::Request::Common>
to build the request. See L<HTTP::Request::Common> for a details on
how to pass form content and other advanced features.
-=item $ua->delete( $url )
+=head2 put
-=item $ua->delete( $url, $field_name => $value, ... )
+ # Any version of HTTP::Message works with this form:
+ my $res = $ua->put( $url, $field_name => $value, Content => $content );
-This method will dispatch a C<DELETE> request on the given $url. Additional
-headers and content options are the same as for the get() method.
+ # Using hash or array references requires HTTP::Message >= 6.07
+ use HTTP::Request 6.07;
+ my $res = $ua->put( $url, \%form );
+ my $res = $ua->put( $url, \@form );
+ my $res = $ua->put( $url, \%form, $field_name => $value, ... );
+ my $res = $ua->put( $url, $field_name => $value, Content => \%form );
+ my $res = $ua->put( $url, $field_name => $value, Content => \@form );
-This method will use the DELETE() function from C<HTTP::Request::Common>
-to build the request. See L<HTTP::Request::Common> for a details on
-how to pass form content and other advanced features.
-
-=item $ua->mirror( $url, $filename )
-
-This method will get the document identified by $url and store it in
-file called $filename. If the file already exists, then the request
-will contain an "If-Modified-Since" header matching the modification
-time of the file. If the document on the server has not changed since
-this time, then nothing happens. If the document has been updated, it
-will be downloaded again. The modification time of the file will be
-forced to match that of the server.
+This method will dispatch a C<PUT> request on the given URL, with
+C<%form> or C<@form> providing the key/value pairs for the fill-in form
+content. Additional headers and content options are the same as for
+the L<LWP::UserAgent/get> method.
-The return value is the response object.
+CAVEAT:
-=item $ua->request( $request )
+This method can only accept content that is in key-value pairs when using
+L<HTTP::Request::Common> prior to version C<6.07>. Any use of hash or array
+references will result in an error prior to version C<6.07>.
-=item $ua->request( $request, $content_file )
+This method will use the C<PUT> function from L<HTTP::Request::Common>
+to build the request. See L<HTTP::Request::Common> for a details on
+how to pass form content and other advanced features.
-=item $ua->request( $request, $content_cb )
+=head2 request
-=item $ua->request( $request, $content_cb, $read_size_hint )
+ my $res = $ua->request( $request );
+ my $res = $ua->request( $request, $content_file );
+ my $res = $ua->request( $request, $content_cb );
+ my $res = $ua->request( $request, $content_cb, $read_size_hint );
-This method will dispatch the given $request object. Normally this
-will be an instance of the C<HTTP::Request> class, but any object with
-a similar interface will do. The return value is a response object.
-See L<HTTP::Request> and L<HTTP::Response> for a description of the
-interface provided by these classes.
+This method will dispatch the given C<$request> object. Normally this
+will be an instance of the L<HTTP::Request> class, but any object with
+a similar interface will do. The return value is an L<HTTP::Response> object.
-The request() method will process redirects and authentication
-responses transparently. This means that it may actually send several
-simple requests via the simple_request() method described below.
+The C<request> method will process redirects and authentication
+responses transparently. This means that it may actually send several
+simple requests via the L<LWP::UserAgent/simple_request> method described below.
-The request methods described above; get(), head(), post() and
-mirror(), will all dispatch the request they build via this method.
-They are convenience methods that simply hides the creation of the
-request object for you.
+The request methods described above; L<LWP::UserAgent/get>, L<LWP::UserAgent/head>,
+L<LWP::UserAgent/post> and L<LWP::UserAgent/mirror> will all dispatch the request
+they build via this method. They are convenience methods that simply hide the
+creation of the request object for you.
-The $content_file, $content_cb and $read_size_hint all correspond to
-options described with the get() method above.
+The C<$content_file>, C<$content_cb> and C<$read_size_hint> all correspond to
+options described with the L<LWP::UserAgent/get> method above. Note that errors
+writing to the content file (for example due to permission denied
+or the filesystem being full) will be reported via the C<Client-Aborted>
+or C<X-Died> response headers, and not the C<is_success> method.
You are allowed to use a CODE reference as C<content> in the request
object passed in. The C<content> function should return the content
@@ -1744,78 +1883,38 @@ when called. The content can be returned in chunks. The content
function will be invoked repeatedly until it return an empty string to
signal that there is no more content.
-=item $ua->simple_request( $request )
-
-=item $ua->simple_request( $request, $content_file )
-
-=item $ua->simple_request( $request, $content_cb )
+=head2 simple_request
-=item $ua->simple_request( $request, $content_cb, $read_size_hint )
+ my $request = HTTP::Request->new( ... );
+ my $res = $ua->simple_request( $request );
+ my $res = $ua->simple_request( $request, $content_file );
+ my $res = $ua->simple_request( $request, $content_cb );
+ my $res = $ua->simple_request( $request, $content_cb, $read_size_hint );
This method dispatches a single request and returns the response
-received. Arguments are the same as for request() described above.
+received. Arguments are the same as for the L<LWP::UserAgent/request> described above.
-The difference from request() is that simple_request() will not try to
-handle redirects or authentication responses. The request() method
-will in fact invoke this method for each simple request it sends.
+The difference from L<LWP::UserAgent/request> is that C<simple_request> will not try to
+handle redirects or authentication responses. The L<LWP::UserAgent/request> method
+will, in fact, invoke this method for each simple request it sends.
-=item $ua->is_online
-
-Tries to determine if you have access to the Internet. Returns
-TRUE if the built-in heuristics determine that the user agent is
-able to access the Internet (over HTTP). See also L<LWP::Online>.
-
-=item $ua->is_protocol_supported( $scheme )
-
-You can use this method to test whether this user agent object supports the
-specified C<scheme>. (The C<scheme> might be a string (like 'http' or
-'ftp') or it might be an URI object reference.)
-
-Whether a scheme is supported, is determined by the user agent's
-C<protocols_allowed> or C<protocols_forbidden> lists (if any), and by
-the capabilities of LWP. I.e., this will return TRUE only if LWP
-supports this protocol I<and> it's permitted for this particular
-object.
-
-=back
-
-=head2 Callback methods
+=head1 CALLBACK METHODS
The following methods will be invoked as requests are processed. These
-methods are documented here because subclasses of C<LWP::UserAgent>
+methods are documented here because subclasses of L<LWP::UserAgent>
might want to override their behaviour.
-=over
-
-=item $ua->prepare_request( $request )
+=head2 get_basic_credentials
-This method is invoked by simple_request(). Its task is to modify the
-given $request object by setting up various headers based on the
-attributes of the user agent. The return value should normally be the
-$request object passed in. If a different request object is returned
-it will be the one actually processed.
+ # This checks wantarray and can either return an array:
+ my ($user, $pass) = $ua->get_basic_credentials( $realm, $uri, $isproxy );
+ # or a string that looks like "user:pass"
+ my $creds = $ua->get_basic_credentials($realm, $uri, $isproxy);
-The headers affected by the base implementation are; "User-Agent",
-"From", "Range" and "Cookie".
-
-=item $ua->redirect_ok( $prospective_request, $response )
-
-This method is called by request() before it tries to follow a
-redirection to the request in $response. This should return a TRUE
-value if this redirection is permissible. The $prospective_request
-will be the request to be sent if this method returns TRUE.
-
-The base implementation will return FALSE unless the method
-is in the object's C<requests_redirectable> list,
-FALSE if the proposed redirection is to a "file://..."
-URL, and TRUE otherwise.
-
-=item $ua->get_basic_credentials( $realm, $uri, $isproxy )
-
-This is called by request() to retrieve credentials for documents
+This is called by L<LWP::UserAgent/request> to retrieve credentials for documents
protected by Basic or Digest Authentication. The arguments passed in
-is the $realm provided by the server, the $uri requested and a boolean
-flag to indicate if this is authentication against a proxy server.
+is the C<$realm> provided by the server, the C<$uri> requested and a
+C<boolean flag> to indicate if this is authentication against a proxy server.
The method should return a username and password. It should return an
empty list to abort the authentication resolution attempt. Subclasses
@@ -1824,21 +1923,48 @@ example of this can be found in C<lwp-request> program distributed
with this library.
The base implementation simply checks a set of pre-stored member
-variables, set up with the credentials() method.
+variables, set up with the L<LWP::UserAgent/credentials> method.
+
+=head2 prepare_request
+
+ $request = $ua->prepare_request( $request );
+
+This method is invoked by L<LWP::UserAgent/simple_request>. Its task is
+to modify the given C<$request> object by setting up various headers based
+on the attributes of the user agent. The return value should normally be the
+C<$request> object passed in. If a different request object is returned
+it will be the one actually processed.
+
+The headers affected by the base implementation are; C<User-Agent>,
+C<From>, C<Range> and C<Cookie>.
+
+=head2 progress
-=item $ua->progress( $status, $request_or_response )
+ my $prog = $ua->progress( $status, $request_or_response );
This is called frequently as the response is received regardless of
-how the content is processed. The method is called with $status
-"begin" at the start of processing the request and with $state "end"
-before the request method returns. In between these $status will be
+how the content is processed. The method is called with C<$status>
+"begin" at the start of processing the request and with C<$state> "end"
+before the request method returns. In between these C<$status> will be
the fraction of the response currently received or the string "tick"
if the fraction can't be calculated.
-When $status is "begin" the second argument is the request object,
-otherwise it is the response object.
+When C<$status> is "begin" the second argument is the L<HTTP::Request> object,
+otherwise it is the L<HTTP::Response> object.
-=back
+=head2 redirect_ok
+
+ my $bool = $ua->redirect_ok( $prospective_request, $response );
+
+This method is called by L<LWP::UserAgent/request> before it tries to follow a
+redirection to the request in C<$response>. This should return a true
+value if this redirection is permissible. The C<$prospective_request>
+will be the request to be sent if this method returns true.
+
+The base implementation will return false unless the method
+is in the object's C<requests_redirectable> list,
+false if the proposed redirection is to a C<file://...>
+URL, and true otherwise.
=head1 SEE ALSO
@@ -1851,11 +1977,13 @@ message objects dispatched and received. See L<HTTP::Request::Common>
and L<HTML::Form> for other ways to build request objects.
See L<WWW::Mechanize> and L<WWW::Search> for examples of more
-specialized user agents based on C<LWP::UserAgent>.
+specialized user agents based on L<LWP::UserAgent>.
-=head1 COPYRIGHT
+=head1 COPYRIGHT AND LICENSE
Copyright 1995-2009 Gisle Aas.
This library is free software; you can redistribute it and/or
modify it under the same terms as Perl itself.
+
+=cut