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

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

Diff Legend

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

Comparing AnyEvent-HTTP/HTTP.pm (file contents): Revision 1.12 by root, Thu Jun 5 16:33:02 2008 UTC vs. Revision 1.50 by root, Tue Aug 11 13:20:42 2009 UTC

Diff Legend

Comparing AnyEvent-HTTP/HTTP.pm (file contents):
Revision 1.12 by root, Thu Jun 5 16:33:02 2008 UTC vs.
Revision 1.50 by root, Tue Aug 11 13:20:42 2009 UTC