[ViewVC] Diff of: cvs/AnyEvent-HTTP/HTTP.pm

Comparing AnyEvent-HTTP/HTTP.pm (file contents):
Revision 1.4 by root, Wed Jun 4 11:59:22 2008 UTC vs.
Revision 1.58 by root, Sun Nov 14 20:23:00 2010 UTC

…		…
3	AnyEvent::HTTP - simple but non-blocking HTTP/HTTPS client	3	AnyEvent::HTTP - simple but non-blocking HTTP/HTTPS client
4		4
5	=head1 SYNOPSIS	5	=head1 SYNOPSIS
6		6
7	use AnyEvent::HTTP;	7	use AnyEvent::HTTP;
		8
		9	http_get "http://www.nethype.de/", sub { print $_[1] };
		10
		11	# ... do something else here
8		12
9	=head1 DESCRIPTION	13	=head1 DESCRIPTION
10		14
11	This module is an L<AnyEvent> user, you need to make sure that you use and	15	This module is an L<AnyEvent> user, you need to make sure that you use and
12	run a supported event loop.	16	run a supported event loop.
13		17
		18	This module implements a simple, stateless and non-blocking HTTP
		19	client. It supports GET, POST and other request methods, cookies and more,
		20	all on a very low level. It can follow redirects supports proxies and
		21	automatically limits the number of connections to the values specified in
		22	the RFC.
		23
		24	It should generally be a "good client" that is enough for most HTTP
		25	tasks. Simple tasks should be simple, but complex tasks should still be
		26	possible as the user retains control over request and response headers.
		27
		28	The caller is responsible for authentication management, cookies (if
		29	the simplistic implementation in this module doesn't suffice), referer
		30	and other high-level protocol details for which this module offers only
		31	limited support.
		32
14	=head2 METHODS	33	=head2 METHODS
15		34
16	=over 4	35	=over 4
17		36
18	=cut	37	=cut
…		…
20	package AnyEvent::HTTP;	39	package AnyEvent::HTTP;
21		40
22	use strict;	41	use strict;
23	no warnings;	42	no warnings;
24		43
25	use Carp;	44	use Errno ();
26		45
27	use AnyEvent ();	46	use AnyEvent 5.0 ();
28	use AnyEvent::Util ();	47	use AnyEvent::Util ();
29	use AnyEvent::Socket ();	48	use AnyEvent::Socket ();
30	use AnyEvent::Handle ();	49	use AnyEvent::Handle ();
31		50
32	use base Exporter::;	51	use base Exporter::;
33		52
34	our $VERSION = '1.0';	53	our $VERSION = '1.46';
35		54
36	our @EXPORT = qw(http_get http_request);	55	our @EXPORT = qw(http_get http_post http_head http_request);
37		56
38	our $USERAGENT = "Mozilla/5.0 (compatible; AnyEvent::HTTP/$VERSION; +http://software.schmorp.de/pkg/AnyEvent)";	57	our $USERAGENT = "Mozilla/5.0 (compatible; U; AnyEvent-HTTP/$VERSION; +http://software.schmorp.de/pkg/AnyEvent)";
39	our $MAX_RECURSE = 10;	58	our $MAX_RECURSE = 10;
40	our $MAX_PERSISTENT = 8;	59	our $MAX_PERSISTENT = 8;
41	our $PERSISTENT_TIMEOUT = 2;	60	our $PERSISTENT_TIMEOUT = 2;
42	our $TIMEOUT = 300;	61	our $TIMEOUT = 300;
43		62
44	# changing these is evil	63	# changing these is evil
45	our $MAX_PERSISTENT_PER_HOST = 2;	64	our $MAX_PERSISTENT_PER_HOST = 0;
46	our $MAX_PER_HOST = 4; # not respected yet :(	65	our $MAX_PER_HOST = 4;
47		66
48	our $PROXY;	67	our $PROXY;
		68	our $ACTIVE = 0;
49		69
50	my %KA_COUNT; # number of open keep-alive connections per host	70	my %KA_COUNT; # number of open keep-alive connections per host
		71	my %CO_SLOT; # number of open connections, and wait queue, per host
51		72
52	=item http_get $url, key => value..., $cb->($data, $headers)	73	=item http_get $url, key => value..., $cb->($data, $headers)
53		74
54	Executes an HTTP-GET request. See the http_request function for details on	75	Executes an HTTP-GET request. See the http_request function for details on
55	additional parameters.	76	additional parameters and the return value.
56		77
		78	=item http_head $url, key => value..., $cb->($data, $headers)
		79
		80	Executes an HTTP-HEAD request. See the http_request function for details
		81	on additional parameters and the return value.
		82
57	=item http_get $url, $body, key => value..., $cb->($data, $headers)	83	=item http_post $url, $body, key => value..., $cb->($data, $headers)
58		84
59	Executes an HTTP-POST request with a requets body of C<$bod>. See the	85	Executes an HTTP-POST request with a request body of C<$body>. See the
60	http_request function for details on additional parameters.	86	http_request function for details on additional parameters and the return
		87	value.
61		88
62	=item http_request $method => $url, key => value..., $cb->($data, $headers)	89	=item http_request $method => $url, key => value..., $cb->($data, $headers)
63		90
64	Executes a HTTP request of type C<$method> (e.g. C<GET>, C<POST>). The URL	91	Executes a HTTP request of type C<$method> (e.g. C<GET>, C<POST>). The URL
65	must be an absolute http or https URL.	92	must be an absolute http or https URL.
66		93
		94	When called in void context, nothing is returned. In other contexts,
		95	C<http_request> returns a "cancellation guard" - you have to keep the
		96	object at least alive until the callback get called. If the object gets
		97	destroyed before the callback is called, the request will be cancelled.
		98
67	The callback will be called with the response data as first argument	99	The callback will be called with the response body data as first argument
68	(or C<undef> if it wasn't available due to errors), and a hash-ref with	100	(or C<undef> if an error occured), and a hash-ref with response headers as
69	response headers as second argument.	101	second argument.
70		102
71	All the headers in that has are lowercased. In addition to the response	103	All the headers in that hash are lowercased. In addition to the response
72	headers, the three "pseudo-headers" C<HTTPVersion>, C<Status> and	104	headers, the "pseudo-headers" (uppercase to avoid clashing with possible
		105	response headers) C<HTTPVersion>, C<Status> and C<Reason> contain the
73	C<Reason> contain the three parts of the HTTP Status-Line of the same	106	three parts of the HTTP Status-Line of the same name.
74	name.	107
		108	The pseudo-header C<URL> contains the actual URL (which can differ from
		109	the requested URL when following redirects - for example, you might get
		110	an error that your URL scheme is not supported even though your URL is a
		111	valid http URL because it redirected to an ftp URL, in which case you can
		112	look at the URL pseudo header).
		113
		114	The pseudo-header C<Redirect> only exists when the request was a result
		115	of an internal redirect. In that case it is an array reference with
		116	the C<($data, $headers)> from the redirect response. Note that this
		117	response could in turn be the result of a redirect itself, and C<<
		118	$headers->{Redirect}[1]{Redirect} >> will then contain the original
		119	response, and so on.
		120
		121	If the server sends a header multiple times, then their contents will be
		122	joined together with a comma (C<,>), as per the HTTP spec.
75		123
76	If an internal error occurs, such as not being able to resolve a hostname,	124	If an internal error occurs, such as not being able to resolve a hostname,
77	then C<$data> will be C<undef>, C<< $headers->{Status} >> will be C<599>	125	then C<$data> will be C<undef>, C<< $headers->{Status} >> will be C<59x>
78	and the C<Reason> pseudo-header will contain an error message.	126	(usually C<599>) and the C<Reason> pseudo-header will contain an error
		127	message.
		128
		129	A typical callback might look like this:
		130
		131	sub {
		132	my ($body, $hdr) = @_;
		133
		134	if ($hdr->{Status} =~ /^2/) {
		135	... everything should be ok
		136	} else {
		137	print "error, $hdr->{Status} $hdr->{Reason}\n";
		138	}
		139	}
79		140
80	Additional parameters are key-value pairs, and are fully optional. They	141	Additional parameters are key-value pairs, and are fully optional. They
81	include:	142	include:
82		143
83	=over 4	144	=over 4
…		…
87	Whether to recurse requests or not, e.g. on redirects, authentication	148	Whether to recurse requests or not, e.g. on redirects, authentication
88	retries and so on, and how often to do so.	149	retries and so on, and how often to do so.
89		150
90	=item headers => hashref	151	=item headers => hashref
91		152
92	The request headers to use.	153	The request headers to use. Currently, C<http_request> may provide its
		154	own C<Host:>, C<Content-Length:>, C<Connection:> and C<Cookie:> headers
		155	and will provide defaults for C<User-Agent:> and C<Referer:> (this can be
		156	suppressed by using C<undef> for these headers in which case they won't be
		157	sent at all).
93		158
94	=item timeout => $seconds	159	=item timeout => $seconds
95		160
96	The time-out to use for various stages - each connect attempt will reset	161	The time-out to use for various stages - each connect attempt will reset
97	the timeout, as will read or write activity. Default timeout is 5 minutes.	162	the timeout, as will read or write activity, i.e. this is not an overall
		163	timeout.
		164
		165	Default timeout is 5 minutes.
98		166
99	=item proxy => [$host, $port[, $scheme]] or undef	167	=item proxy => [$host, $port[, $scheme]] or undef
100		168
101	Use the given http proxy for all requests. If not specified, then the	169	Use the given http proxy for all requests. If not specified, then the
102	default proxy (as specified by C<$ENV{http_proxy}>) is used.	170	default proxy (as specified by C<$ENV{http_proxy}>) is used.
103		171
104	C<$scheme> must be either missing or C<http> for HTTP, or C<https> for	172	C<$scheme> must be either missing, C<http> for HTTP or C<https> for
105	HTTPS.	173	HTTPS.
106		174
107	=item body => $string	175	=item body => $string
108		176
109	The request body, usually empty. Will be-sent as-is (future versions of	177	The request body, usually empty. Will be-sent as-is (future versions of
110	this module might offer more options).	178	this module might offer more options).
111		179
		180	=item cookie_jar => $hash_ref
		181
		182	Passing this parameter enables (simplified) cookie-processing, loosely
		183	based on the original netscape specification.
		184
		185	The C<$hash_ref> must be an (initially empty) hash reference which will
		186	get updated automatically. It is possible to save the cookie_jar to
		187	persistent storage with something like JSON or Storable, but this is not
		188	recommended, as expiry times are currently being ignored.
		189
		190	Note that this cookie implementation is not of very high quality, nor
		191	meant to be complete. If you want complete cookie management you have to
		192	do that on your own. C<cookie_jar> is meant as a quick fix to get some
		193	cookie-using sites working. Cookies are a privacy disaster, do not use
		194	them unless required to.
		195
		196	=item tls_ctx => $scheme \| $tls_ctx
		197
		198	Specifies the AnyEvent::TLS context to be used for https connections. This
		199	parameter follows the same rules as the C<tls_ctx> parameter to
		200	L<AnyEvent::Handle>, but additionally, the two strings C<low> or
		201	C<high> can be specified, which give you a predefined low-security (no
		202	verification, highest compatibility) and high-security (CA and common-name
		203	verification) TLS context.
		204
		205	The default for this option is C<low>, which could be interpreted as "give
		206	me the page, no matter what".
		207
		208	=item on_prepare => $callback->($fh)
		209
		210	In rare cases you need to "tune" the socket before it is used to
		211	connect (for exmaple, to bind it on a given IP address). This parameter
		212	overrides the prepare callback passed to C<AnyEvent::Socket::tcp_connect>
		213	and behaves exactly the same way (e.g. it has to provide a
		214	timeout). See the description for the C<$prepare_cb> argument of
		215	C<AnyEvent::Socket::tcp_connect> for details.
		216
		217	=item on_header => $callback->($headers)
		218
		219	When specified, this callback will be called with the header hash as soon
		220	as headers have been successfully received from the remote server (not on
		221	locally-generated errors).
		222
		223	It has to return either true (in which case AnyEvent::HTTP will continue),
		224	or false, in which case AnyEvent::HTTP will cancel the download (and call
		225	the finish callback with an error code of C<598>).
		226
		227	This callback is useful, among other things, to quickly reject unwanted
		228	content, which, if it is supposed to be rare, can be faster than first
		229	doing a C<HEAD> request.
		230
		231	Example: cancel the request unless the content-type is "text/html".
		232
		233	on_header => sub {
		234	$_[0]{"content-type"} =~ /^text\/html\s*(?:;\|$)/
		235	},
		236
		237	=item on_body => $callback->($partial_body, $headers)
		238
		239	When specified, all body data will be passed to this callback instead of
		240	to the completion callback. The completion callback will get the empty
		241	string instead of the body data.
		242
		243	It has to return either true (in which case AnyEvent::HTTP will continue),
		244	or false, in which case AnyEvent::HTTP will cancel the download (and call
		245	the completion callback with an error code of C<598>).
		246
		247	This callback is useful when the data is too large to be held in memory
		248	(so the callback writes it to a file) or when only some information should
		249	be extracted, or when the body should be processed incrementally.
		250
		251	It is usually preferred over doing your own body handling via
		252	C<want_body_handle>, but in case of streaming APIs, where HTTP is
		253	only used to create a connection, C<want_body_handle> is the better
		254	alternative, as it allows you to install your own event handler, reducing
		255	resource usage.
		256
		257	=item want_body_handle => $enable
		258
		259	When enabled (default is disabled), the behaviour of AnyEvent::HTTP
		260	changes considerably: after parsing the headers, and instead of
		261	downloading the body (if any), the completion callback will be
		262	called. Instead of the C<$body> argument containing the body data, the
		263	callback will receive the L<AnyEvent::Handle> object associated with the
		264	connection. In error cases, C<undef> will be passed. When there is no body
		265	(e.g. status C<304>), the empty string will be passed.
		266
		267	The handle object might or might not be in TLS mode, might be connected to
		268	a proxy, be a persistent connection etc., and configured in unspecified
		269	ways. The user is responsible for this handle (it will not be used by this
		270	module anymore).
		271
		272	This is useful with some push-type services, where, after the initial
		273	headers, an interactive protocol is used (typical example would be the
		274	push-style twitter API which starts a JSON/XML stream).
		275
		276	If you think you need this, first have a look at C<on_body>, to see if
		277	that doesn't solve your problem in a better way.
		278
112	=back	279	=back
113		280
114	=back	281	Example: make a simple HTTP GET request for http://www.nethype.de/
		282
		283	http_request GET => "http://www.nethype.de/", sub {
		284	my ($body, $hdr) = @_;
		285	print "$body\n";
		286	};
		287
		288	Example: make a HTTP HEAD request on https://www.google.com/, use a
		289	timeout of 30 seconds.
		290
		291	http_request
		292	GET => "https://www.google.com",
		293	timeout => 30,
		294	sub {
		295	my ($body, $hdr) = @_;
		296	use Data::Dumper;
		297	print Dumper $hdr;
		298	}
		299	;
		300
		301	Example: make another simple HTTP GET request, but immediately try to
		302	cancel it.
		303
		304	my $request = http_request GET => "http://www.nethype.de/", sub {
		305	my ($body, $hdr) = @_;
		306	print "$body\n";
		307	};
		308
		309	undef $request;
115		310
116	=cut	311	=cut
117		312
		313	sub _slot_schedule;
		314	sub _slot_schedule($) {
		315	my $host = shift;
		316
		317	while ($CO_SLOT{$host}[0] < $MAX_PER_HOST) {
		318	if (my $cb = shift @{ $CO_SLOT{$host}[1] }) {
		319	# somebody wants that slot
		320	++$CO_SLOT{$host}[0];
		321	++$ACTIVE;
		322
		323	$cb->(AnyEvent::Util::guard {
		324	--$ACTIVE;
		325	--$CO_SLOT{$host}[0];
		326	_slot_schedule $host;
		327	});
		328	} else {
		329	# nobody wants the slot, maybe we can forget about it
		330	delete $CO_SLOT{$host} unless $CO_SLOT{$host}[0];
		331	last;
		332	}
		333	}
		334	}
		335
		336	# wait for a free slot on host, call callback
		337	sub _get_slot($$) {
		338	push @{ $CO_SLOT{$_[0]}[1] }, $_[1];
		339
		340	_slot_schedule $_[0];
		341	}
		342
		343	our $qr_nlnl = qr{(?<![^\012])\015?\012};
		344
		345	our $TLS_CTX_LOW = { cache => 1, sslv2 => 1 };
		346	our $TLS_CTX_HIGH = { cache => 1, verify => 1, verify_peername => "https" };
		347
118	sub http_request($$$;@) {	348	sub http_request($$@) {
119	my $cb = pop;	349	my $cb = pop;
120	my ($method, $url, %arg) = @_;	350	my ($method, $url, %arg) = @_;
121		351
122	my %hdr;	352	my %hdr;
123		353
		354	$arg{tls_ctx} = $TLS_CTX_LOW if $arg{tls_ctx} eq "low" \|\| !exists $arg{tls_ctx};
		355	$arg{tls_ctx} = $TLS_CTX_HIGH if $arg{tls_ctx} eq "high";
		356
124	$method = uc $method;	357	$method = uc $method;
125		358
126	if (my $hdr = delete $arg{headers}) {	359	if (my $hdr = $arg{headers}) {
127	while (my ($k, $v) = each %$hdr) {	360	while (my ($k, $v) = each %$hdr) {
128	$hdr{lc $k} = $v;	361	$hdr{lc $k} = $v;
129	}	362	}
130	}	363	}
131		364
		365	# pseudo headers for all subsequent responses
		366	my @pseudo = (URL => $url);
		367	push @pseudo, Redirect => delete $arg{Redirect} if exists $arg{Redirect};
		368
		369	my $recurse = exists $arg{recurse} ? delete $arg{recurse} : $MAX_RECURSE;
		370
		371	return $cb->(undef, { Status => 599, Reason => "Too many redirections", @pseudo })
		372	if $recurse < 0;
		373
132	my $proxy = $arg{proxy} \|\| $PROXY;	374	my $proxy = $arg{proxy} \|\| $PROXY;
133	my $timeout = $arg{timeout} \|\| $TIMEOUT;	375	my $timeout = $arg{timeout} \|\| $TIMEOUT;
134	my $recurse = exists $arg{recurse} ? $arg{recurse} : $MAX_RECURSE;
135		376
136	$hdr{"user-agent"} \|\|= $USERAGENT;	377	my ($uscheme, $uauthority, $upath, $query, $fragment) =
		378	$url =~ m\|(?:([^:/?#]+):)?(?://([^/?#]))?([^?#])(?:(\?[^#]))?(?:#(.))?\|;
137		379
138	my ($host, $port, $path, $scheme);	380	$uscheme = lc $uscheme;
		381
		382	my $uport = $uscheme eq "http" ? 80
		383	: $uscheme eq "https" ? 443
		384	: return $cb->(undef, { Status => 599, Reason => "Only http and https URL schemes supported", @pseudo });
		385
		386	$uauthority =~ /^(?: .*\@ )? ([^\@:]+) (?: : (\d+) )?$/x
		387	or return $cb->(undef, { Status => 599, Reason => "Unparsable URL", @pseudo });
		388
		389	my $uhost = $1;
		390	$uport = $2 if defined $2;
		391
		392	$hdr{host} = defined $2 ? "$uhost:$2" : "$uhost"
		393	unless exists $hdr{host};
		394
		395	$uhost =~ s/^\[(.*)\]$/$1/;
		396	$upath .= $query if length $query;
		397
		398	$upath =~ s%^/?%/%;
		399
		400	# cookie processing
		401	if (my $jar = $arg{cookie_jar}) {
		402	%$jar = () if $jar->{version} != 1;
		403
		404	my @cookie;
		405
		406	while (my ($chost, $v) = each %$jar) {
		407	if ($chost =~ /^\./) {
		408	next unless $chost eq substr $uhost, -length $chost;
		409	} elsif ($chost =~ /\./) {
		410	next unless $chost eq $uhost;
		411	} else {
		412	next;
		413	}
		414
		415	while (my ($cpath, $v) = each %$v) {
		416	next unless $cpath eq substr $upath, 0, length $cpath;
		417
		418	while (my ($k, $v) = each %$v) {
		419	next if $uscheme ne "https" && exists $v->{secure};
		420	my $value = $v->{value};
		421	$value =~ s/([\\"])/\\$1/g;
		422	push @cookie, "$k=\"$value\"";
		423	}
		424	}
		425	}
		426
		427	$hdr{cookie} = join "; ", @cookie
		428	if @cookie;
		429	}
		430
		431	my ($rhost, $rport, $rscheme, $rpath); # request host, port, path
139		432
140	if ($proxy) {	433	if ($proxy) {
141	($host, $port, $scheme) = @$proxy;	434	($rpath, $rhost, $rport, $rscheme) = ($url, @$proxy);
142	$path = $url;	435
		436	$rscheme = "http" unless defined $rscheme;
		437
		438	# don't support https requests over https-proxy transport,
		439	# can't be done with tls as spec'ed, unless you double-encrypt.
		440	$rscheme = "http" if $uscheme eq "https" && $rscheme eq "https";
143	} else {	441	} else {
144	($scheme, my $authority, $path, my $query, my $fragment) =	442	($rhost, $rport, $rscheme, $rpath) = ($uhost, $uport, $uscheme, $upath);
145	$url =~ m\|(?:([^:/?#]+):)?(?://([^/?#]))?([^?#])(?:\?([^#]))?(?:#(.))?\|;
146
147	$port = $scheme eq "http" ? 80
148	: $scheme eq "https" ? 443
149	: croak "$url: only http and https URLs supported";
150
151	$authority =~ /^(?: .*\@ )? ([^\@:]+) (?: : (\d+) )?$/x
152	or croak "$authority: unparsable URL";
153
154	$host = $1;
155	$port = $2 if defined $2;
156
157	$host =~ s/^\[(.*)\]$/$1/;
158	$path .= "?$query" if length $query;
159
160	$path = "/" unless $path;
161
162	$hdr{host} = $host = lc $host;
163	}	443	}
164		444
165	$scheme = lc $scheme;	445	# leave out fragment and query string, just a heuristic
		446	$hdr{referer} \|\|= "$uscheme://$uauthority$upath" unless exists $hdr{referer};
		447	$hdr{"user-agent"} \|\|= $USERAGENT unless exists $hdr{"user-agent"};
166		448
167	my %state;
168
169	$state{body} = delete $arg{body};
170
171	$hdr{"content-length"} = length $state{body};	449	$hdr{"content-length"} = length $arg{body}
		450	if length $arg{body} \|\| $method ne "GET";
172		451
		452	my %state = (connect_guard => 1);
		453
		454	_get_slot $uhost, sub {
		455	$state{slot_guard} = shift;
		456
		457	return unless $state{connect_guard};
		458
173	$state{connect_guard} = AnyEvent::Socket::tcp_connect $host, $port, sub {	459	$state{connect_guard} = AnyEvent::Socket::tcp_connect $rhost, $rport, sub {
174	$state{fh} = shift	460	$state{fh} = shift
175	or return $cb->(undef, { Status => 599, Reason => "$!" });
176
177	delete $state{connect_guard}; # reduce memory usage, save a tree
178
179	# get handle
180	$state{handle} = new AnyEvent::Handle
181	fh => $state{fh},
182	($scheme eq "https" ? (tls => "connect") : ());
183
184	# limit the number of persistent connections
185	if ($KA_COUNT{$_[1]} < $MAX_PERSISTENT_PER_HOST) {
186	++$KA_COUNT{$_[1]};
187	$state{handle}{ka_count_guard} = AnyEvent::Util::guard { --$KA_COUNT{$_[1]} };
188	$hdr{connection} = "keep-alive";
189	delete $hdr{connection}; # keep-alive not yet supported
190	} else {
191	delete $hdr{connection};
192	}
193
194	# (re-)configure handle
195	$state{handle}->timeout ($timeout);
196	$state{handle}->on_error (sub {
197	%state = ();
198	$cb->(undef, { Status => 599, Reason => "$!" });
199	});
200	$state{handle}->on_eof (sub {
201	%state = ();
202	$cb->(undef, { Status => 599, Reason => "unexpected end-of-file" });
203	});
204
205	# send request
206	$state{handle}->push_write (
207	"$method $path HTTP/1.0\015\012"
208	. (join "", map "$_: $hdr{$_}\015\012", keys %hdr)
209	. "\015\012"
210	. (delete $state{body})
211	);
212
213	%hdr = (); # reduce memory usage, save a kitten
214
215	# status line
216	$state{handle}->push_read (line => qr/\015?\012/, sub {
217	$_[1] =~ /^HTTP\/([0-9\.]+) \s+ ([0-9]{3}) \s+ ([^\015\012]+)/ix
218	or return (%state = (), $cb->(undef, { Status => 599, Reason => "invalid server response ($_[1])" }));
219
220	my %hdr = ( # response headers
221	HTTPVersion => ",$1",
222	Status => ",$2",
223	Reason => ",$3",
224	);
225
226	# headers, could be optimized a bit
227	$state{handle}->unshift_read (line => qr/\015?\012\015?\012/, sub {
228	for ("$_[1]\012") {
229	# we support spaces in field names, as lotus domino
230	# creates them.
231	$hdr{lc $1} .= ",$2"
232	while /\G
233	([^:\000-\037]+):
234	[\011\040]*
235	((?: [^\015\012]+ \| \015?\012[\011\040] )*)
236	\015?\012
237	/gxc;
238
239	/\G$/
240	or return $cb->(undef, { Status => 599, Reason => "garbled response headers" });
241	}	461	or do {
242		462	my $err = "$!";
243	substr $_, 0, 1, ""
244	for values %hdr;
245
246	if ($method eq "HEAD") {
247	%state = ();	463	%state = ();
248	$cb->(undef, \%hdr);	464	return $cb->(undef, { Status => 599, Reason => $err, @pseudo });
		465	};
		466
		467	pop; # free memory, save a tree
		468
		469	return unless delete $state{connect_guard};
		470
		471	# get handle
		472	$state{handle} = new AnyEvent::Handle
		473	fh => $state{fh},
		474	peername => $rhost,
		475	tls_ctx => $arg{tls_ctx},
		476	# these need to be reconfigured on keepalive handles
		477	timeout => $timeout,
		478	on_error => sub {
		479	%state = ();
		480	$cb->(undef, { Status => 599, Reason => $_[2], @pseudo });
		481	},
		482	on_eof => sub {
		483	%state = ();
		484	$cb->(undef, { Status => 599, Reason => "Unexpected end-of-file", @pseudo });
		485	},
		486	;
		487
		488	# limit the number of persistent connections
		489	# keepalive not yet supported
		490	# if ($KA_COUNT{$_[1]} < $MAX_PERSISTENT_PER_HOST) {
		491	# ++$KA_COUNT{$_[1]};
		492	# $state{handle}{ka_count_guard} = AnyEvent::Util::guard {
		493	# --$KA_COUNT{$_[1]}
		494	# };
		495	# $hdr{connection} = "keep-alive";
249	} else {	496	# } else {
250	if (exists $hdr{"content-length"}) {	497	delete $hdr{connection};
251	$_[0]->unshift_read (chunk => $hdr{"content-length"}, sub {	498	# }
252	# could cache persistent connection now	499
253	if ($hdr{connection} =~ /\bkeep-alive\b/i) {	500	$state{handle}->starttls ("connect") if $rscheme eq "https";
254	# but we don't, due to misdesigns, this is annoyingly complex	501
		502	# handle actual, non-tunneled, request
		503	my $handle_actual_request = sub {
		504	$state{handle}->starttls ("connect") if $uscheme eq "https" && !exists $state{handle}{tls};
		505
		506	# send request
		507	$state{handle}->push_write (
		508	"$method $rpath HTTP/1.0\015\012"
		509	. (join "", map "\u$_: $hdr{$_}\015\012", grep defined $hdr{$_}, keys %hdr)
		510	. "\015\012"
		511	. (delete $arg{body})
		512	);
		513
		514	# return if error occured during push_write()
		515	return unless %state;
		516
		517	%hdr = (); # reduce memory usage, save a kitten, also make it possible to re-use
		518
		519	# status line and headers
		520	$state{handle}->push_read (line => $qr_nlnl, sub {
		521	for ("$_[1]") {
		522	y/\015//d; # weed out any \015, as they show up in the weirdest of places.
		523
		524	/^HTTP\/([0-9\.]+) \s+ ([0-9]{3}) (?: \s+ ([^\015\012]*) )? \015?\012/igxc
		525	or return (%state = (), $cb->(undef, { Status => 599, Reason => "Invalid server response", @pseudo }));
		526
		527	push @pseudo,
		528	HTTPVersion => $1,
		529	Status => $2,
		530	Reason => $3,
		531	;
		532
		533	# things seen, not parsed:
		534	# p3pP="NON CUR OTPi OUR NOR UNI"
		535
		536	$hdr{lc $1} .= ",$2"
		537	while /\G
		538	([^:\000-\037]*):
		539	[\011\040]*
		540	((?: [^\012]+ \| \012[\011\040] )*)
		541	\012
		542	/gxc;
		543
		544	/\G$/
		545	or return (%state = (), $cb->(undef, { Status => 599, Reason => "Garbled response headers", @pseudo }));
		546	}
		547
		548	# remove the "," prefix we added to all headers above
		549	substr $_, 0, 1, ""
		550	for values %hdr;
		551
		552	# patch in all pseudo headers
		553	%hdr = (%hdr, @pseudo);
		554
		555	# redirect handling
		556	# microsoft and other shitheads don't give a shit for following standards,
		557	# try to support some common forms of broken Location headers.
		558	if ($hdr{location} !~ /^(?: $ \| [^:\/?\#]+ : )/x) {
		559	$hdr{location} =~ s/^\.\/+//;
		560
		561	my $url = "$rscheme://$uhost:$uport";
		562
		563	unless ($hdr{location} =~ s/^\///) {
		564	$url .= $upath;
		565	$url =~ s/\/[^\/]*$//;
		566	}
		567
		568	$hdr{location} = "$url/$hdr{location}";
		569	}
		570
		571	my $redirect;
		572
		573	if ($recurse) {
		574	my $status = $hdr{Status};
		575
		576	# industry standard is to redirect POST as GET for
		577	# 301, 302 and 303, in contrast to http/1.0 and 1.1.
		578	# also, the UA should ask the user for 301 and 307 and POST,
		579	# industry standard seems to be to simply follow.
		580	# we go with the industry standard.
		581	if ($status == 301 or $status == 302 or $status == 303) {
		582	# HTTP/1.1 is unclear on how to mutate the method
		583	$method = "GET" unless $method eq "HEAD";
		584	$redirect = 1;
		585	} elsif ($status == 307) {
		586	$redirect = 1;
		587	}
		588	}
		589
		590	my $finish = sub {
		591	$state{handle}->destroy if $state{handle};
		592	%state = ();
		593
		594	# set-cookie processing
		595	if ($arg{cookie_jar}) {
		596	for ($_[1]{"set-cookie"}) {
		597	# parse NAME=VALUE
		598	my @kv;
		599
		600	while (/\G\s* ([^=;,[:space:]]+) \s=\s (?: "((?:[^\\"]+\|\\.))" \| ([^=;,[:space:]]) )/gcxs) {
		601	my $name = $1;
		602	my $value = $3;
		603
		604	unless ($value) {
		605	$value = $2;
		606	$value =~ s/\\(.)/$1/gs;
		607	}
		608
		609	push @kv, $name => $value;
		610
		611	last unless /\G\s*;/gc;
		612	}
		613
		614	last unless @kv;
		615
		616	my $name = shift @kv;
		617	my %kv = (value => shift @kv, @kv);
		618
		619	my $cdom;
		620	my $cpath = (delete $kv{path}) \|\| "/";
		621
		622	if (exists $kv{domain}) {
		623	$cdom = delete $kv{domain};
		624
		625	$cdom =~ s/^\.?/./; # make sure it starts with a "."
		626
		627	next if $cdom =~ /\.$/;
		628
		629	# this is not rfc-like and not netscape-like. go figure.
		630	my $ndots = $cdom =~ y/.//;
		631	next if $ndots < ($cdom =~ /\.[^.][^.]\.[^.][^.]$/ ? 3 : 2);
		632	} else {
		633	$cdom = $uhost;
		634	}
		635
		636	# store it
		637	$arg{cookie_jar}{version} = 1;
		638	$arg{cookie_jar}{$cdom}{$cpath}{$name} = \%kv;
		639
		640	redo if /\G\s*,/gc;
255	};	641	}
256
257	%state = ();
258	$cb->($_[1], \%hdr);
259	});	642	}
		643
		644	if ($redirect && exists $hdr{location}) {
		645	# we ignore any errors, as it is very common to receive
		646	# Content-Length != 0 but no actual body
		647	# we also access %hdr, as $_[1] might be an erro
		648	http_request (
		649	$method => $hdr{location},
		650	%arg,
		651	recurse => $recurse - 1,
		652	Redirect => \@_,
		653	$cb);
		654	} else {
		655	$cb->($_[0], $_[1]);
		656	}
		657	};
		658
		659	my $len = $hdr{"content-length"};
		660
		661	if (!$redirect && $arg{on_header} && !$arg{on_header}(\%hdr)) {
		662	$finish->(undef, { Status => 598, Reason => "Request cancelled by on_header", @pseudo });
		663	} elsif (
		664	$hdr{Status} =~ /^(?:1..\|[23]04)$/
		665	or $method eq "HEAD"
		666	or (defined $len && !$len)
		667	) {
		668	# no body
		669	$finish->("", \%hdr);
260	} else {	670	} else {
261	# too bad, need to read until we get an error or EOF,	671	# body handling, four different code paths
262	# no way to detect winged data.	672	# for want_body_handle, on_body (2x), normal (2x)
		673	# we might read too much here, but it does not matter yet (no pers. connections)
		674	if (!$redirect && $arg{want_body_handle}) {
		675	$_[0]->on_eof (undef);
		676	$_[0]->on_error (undef);
		677	$_[0]->on_read (undef);
		678
		679	$finish->(delete $state{handle}, \%hdr);
		680
		681	} elsif ($arg{on_body}) {
		682	$_[0]->on_error (sub { $finish->(undef, { Status => 599, Reason => $_[2], @pseudo }) });
		683	if ($len) {
		684	$_[0]->on_eof (undef);
		685	$_[0]->on_read (sub {
		686	$len -= length $_[0]{rbuf};
		687
		688	$arg{on_body}(delete $_[0]{rbuf}, \%hdr)
		689	or $finish->(undef, { Status => 598, Reason => "Request cancelled by on_body", @pseudo });
		690
		691	$len > 0
		692	or $finish->("", \%hdr);
		693	});
		694	} else {
263	$_[0]->on_error (sub {	695	$_[0]->on_eof (sub {
		696	$finish->("", \%hdr);
264	%state = ();	697	});
		698	$_[0]->on_read (sub {
265	$cb->($_[0]{rbuf}, \%hdr);	699	$arg{on_body}(delete $_[0]{rbuf}, \%hdr)
		700	or $finish->(undef, { Status => 598, Reason => "Request cancelled by on_body", @pseudo });
		701	});
266	});	702	}
		703	} else {
267	$_[0]->on_eof (undef);	704	$_[0]->on_eof (undef);
		705
		706	if ($len) {
		707	$_[0]->on_error (sub { $finish->(undef, { Status => 599, Reason => $_[2], @pseudo }) });
		708	$_[0]->on_read (sub {
		709	$finish->((substr delete $_[0]{rbuf}, 0, $len, ""), \%hdr)
		710	if $len <= length $_[0]{rbuf};
		711	});
		712	} else {
		713	$_[0]->on_error (sub {
		714	($! == Errno::EPIPE \|\| !$!)
		715	? $finish->(delete $_[0]{rbuf}, \%hdr)
		716	: $finish->(undef, { Status => 599, Reason => $_[2], @pseudo });
		717	});
268	$_[0]->on_read (sub { });	718	$_[0]->on_read (sub { });
		719	}
		720	}
269	}	721	}
270	}	722	});
271	});	723	};
		724
		725	# now handle proxy-CONNECT method
		726	if ($proxy && $uscheme eq "https") {
		727	# oh dear, we have to wrap it into a connect request
		728
		729	# maybe re-use $uauthority with patched port?
		730	$state{handle}->push_write ("CONNECT $uhost:$uport HTTP/1.0\015\012Host: $uhost\015\012\015\012");
		731	$state{handle}->push_read (line => $qr_nlnl, sub {
		732	$_[1] =~ /^HTTP\/([0-9\.]+) \s+ ([0-9]{3}) (?: \s+ ([^\015\012]*) )?/ix
		733	or return (%state = (), $cb->(undef, { Status => 599, Reason => "Invalid proxy connect response ($_[1])", @pseudo }));
		734
		735	if ($2 == 200) {
		736	$rpath = $upath;
		737	&$handle_actual_request;
		738	} else {
		739	%state = ();
		740	$cb->(undef, { Status => $2, Reason => $3, @pseudo });
		741	}
272	});	742	});
273	}, sub {	743	} else {
274	$timeout	744	&$handle_actual_request;
		745	}
		746
		747	}, $arg{on_prepare} \|\| sub { $timeout };
275	};	748	};
276		749
277	defined wantarray && AnyEvent::Util::guard { %state = () }	750	defined wantarray && AnyEvent::Util::guard { %state = () }
278	}	751	}
279		752
280	sub http_get($$;@) {	753	sub http_get($@) {
281	unshift @_, "GET";	754	unshift @_, "GET";
282	&http_request	755	&http_request
283	}	756	}
284		757
285	sub http_head($$;@) {	758	sub http_head($@) {
286	unshift @_, "HEAD";	759	unshift @_, "HEAD";
287	&http_request	760	&http_request
288	}	761	}
289		762
290	sub http_post($$$;@) {	763	sub http_post($$@) {
		764	my $url = shift;
291	unshift @_, "POST", "body";	765	unshift @_, "POST", $url, "body";
292	&http_request	766	&http_request
293	}	767	}
294		768
		769	=back
		770
		771	=head2 DNS CACHING
		772
		773	AnyEvent::HTTP uses the AnyEvent::Socket::tcp_connect function for
		774	the actual connection, which in turn uses AnyEvent::DNS to resolve
		775	hostnames. The latter is a simple stub resolver and does no caching
		776	on its own. If you want DNS caching, you currently have to provide
		777	your own default resolver (by storing a suitable resolver object in
		778	C<$AnyEvent::DNS::RESOLVER>).
		779
295	=head2 GLOBAL FUNCTIONS AND VARIABLES	780	=head2 GLOBAL FUNCTIONS AND VARIABLES
296		781
297	=over 4	782	=over 4
298		783
299	=item AnyEvent::HTTP::set_proxy "proxy-url"	784	=item AnyEvent::HTTP::set_proxy "proxy-url"
300		785
301	Sets the default proxy server to use. The proxy-url must begin with a	786	Sets the default proxy server to use. The proxy-url must begin with a
302	string of the form C<http://host:port> (optionally C<https:...>).	787	string of the form C<http://host:port> (optionally C<https:...>), croaks
		788	otherwise.
		789
		790	To clear an already-set proxy, use C<undef>.
303		791
304	=item $AnyEvent::HTTP::MAX_RECURSE	792	=item $AnyEvent::HTTP::MAX_RECURSE
305		793
306	The default value for the C<recurse> request parameter (default: C<10>).	794	The default value for the C<recurse> request parameter (default: C<10>).
307		795
308	=item $AnyEvent::HTTP::USERAGENT	796	=item $AnyEvent::HTTP::USERAGENT
309		797
310	The default value for the C<User-Agent> header (the default is	798	The default value for the C<User-Agent> header (the default is
311	C<Mozilla/5.0 (compatible; AnyEvent::HTTP/$VERSION; +http://software.schmorp.de/pkg/AnyEvent)>).	799	C<Mozilla/5.0 (compatible; U; AnyEvent-HTTP/$VERSION; +http://software.schmorp.de/pkg/AnyEvent)>).
312		800
313	=item $AnyEvent::HTTP::MAX_PERSISTENT	801	=item $AnyEvent::HTTP::MAX_PER_HOST
314		802
315	The maximum number of persistent connections to keep open (default: 8).	803	The maximum number of concurrent connections to the same host (identified
		804	by the hostname). If the limit is exceeded, then the additional requests
		805	are queued until previous connections are closed.
316		806
317	Not implemented currently.	807	The default value for this is C<4>, and it is highly advisable to not
		808	increase it.
318		809
319	=item $AnyEvent::HTTP::PERSISTENT_TIMEOUT	810	=item $AnyEvent::HTTP::ACTIVE
320		811
321	The maximum time to cache a persistent connection, in seconds (default: 2).	812	The number of active connections. This is not the number of currently
322		813	running requests, but the number of currently open and non-idle TCP
323	Not implemented currently.	814	connections. This number of can be useful for load-leveling.
324		815
325	=back	816	=back
326		817
327	=cut	818	=cut
328		819
329	sub set_proxy($) {	820	sub set_proxy($) {
		821	if (length $_[0]) {
330	$PROXY = [$2, $3 \|\| 3128, $1] if $_[0] =~ m%^(https?):// ([^:/]+) (?: : (\d*) )?%ix;	822	$_[0] =~ m%^(https?):// ([^:/]+) (?: : (\d*) )?%ix
		823	or Carp::croak "$_[0]: invalid proxy URL";
		824	$PROXY = [$2, $3 \|\| 3128, $1]
		825	} else {
		826	undef $PROXY;
		827	}
331	}	828	}
332		829
333	# initialise proxy from environment	830	# initialise proxy from environment
		831	eval {
334	set_proxy $ENV{http_proxy};	832	set_proxy $ENV{http_proxy};
		833	};
335		834
336	=head1 SEE ALSO	835	=head1 SEE ALSO
337		836
338	L<AnyEvent>.	837	L<AnyEvent>.
339		838
340	=head1 AUTHOR	839	=head1 AUTHOR
341		840
342	Marc Lehmann <schmorp@schmorp.de>	841	Marc Lehmann <schmorp@schmorp.de>
343	http://home.schmorp.de/	842	http://home.schmorp.de/
		843
		844	With many thanks to Дмитрий Шалашов, who provided countless
		845	testcases and bugreports.
344		846
345	=cut	847	=cut
346		848
347	1	849	1
348		850

Diff Legend

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

Comparing AnyEvent-HTTP/HTTP.pm (file contents): Revision 1.4 by root, Wed Jun 4 11:59:22 2008 UTC vs. Revision 1.58 by root, Sun Nov 14 20:23:00 2010 UTC

Diff Legend

Comparing AnyEvent-HTTP/HTTP.pm (file contents):
Revision 1.4 by root, Wed Jun 4 11:59:22 2008 UTC vs.
Revision 1.58 by root, Sun Nov 14 20:23:00 2010 UTC