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

Comparing AnyEvent-HTTP/HTTP.pm (file contents):
Revision 1.11 by root, Thu Jun 5 15:34:00 2008 UTC vs.
Revision 1.48 by root, Wed Aug 5 16:09:10 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) = @_;
…		…
121	Whether to recurse requests or not, e.g. on redirects, authentication	136	Whether to recurse requests or not, e.g. on redirects, authentication
122	retries and so on, and how often to do so.	137	retries and so on, and how often to do so.
123		138
124	=item headers => hashref	139	=item headers => hashref
125		140
126	The request headers to use.	141	The request headers to use. Currently, C<http_request> may provide its
		142	own C<Host:>, C<Content-Length:>, C<Connection:> and C<Cookie:> headers
		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	send at all).
127		146
128	=item timeout => $seconds	147	=item timeout => $seconds
129		148
130	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
131	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.
…		…
133	=item proxy => [$host, $port[, $scheme]] or undef	152	=item proxy => [$host, $port[, $scheme]] or undef
134		153
135	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
136	default proxy (as specified by C<$ENV{http_proxy}>) is used.	155	default proxy (as specified by C<$ENV{http_proxy}>) is used.
137		156
138	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
139	HTTPS.	158	HTTPS.
140		159
141	=item body => $string	160	=item body => $string
142		161
143	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
…		…
149	based on the original netscape specification.	168	based on the original netscape specification.
150		169
151	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
152	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
153	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
154	recommended, as expire times are currently being ignored.	173	recommended, as expiry times are currently being ignored.
155		174
156	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
157	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
158	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
159	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
160	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.
161		254
162	=back	255	=back
163		256
164	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/
165		258
…		…
179	use Data::Dumper;	272	use Data::Dumper;
180	print Dumper $hdr;	273	print Dumper $hdr;
181	}	274	}
182	;	275	;
183		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
184	=cut	287	=cut
185		288
		289	sub _slot_schedule;
186	sub _slot_schedule($) {	290	sub _slot_schedule($) {
187	my $host = shift;	291	my $host = shift;
188		292
189	while ($CO_SLOT{$host}[0] < $MAX_PER_HOST) {	293	while ($CO_SLOT{$host}[0] < $MAX_PER_HOST) {
190	if (my $cb = shift @{ $CO_SLOT{$host}[1] }) {	294	if (my $cb = shift @{ $CO_SLOT{$host}[1] }) {
191	# somebody wnats that slot	295	# somebody wants that slot
192	++$CO_SLOT{$host}[0];	296	++$CO_SLOT{$host}[0];
		297	++$ACTIVE;
193		298
194	$cb->(AnyEvent::Util::guard {	299	$cb->(AnyEvent::Util::guard {
		300	--$ACTIVE;
195	--$CO_SLOT{$host}[0];	301	--$CO_SLOT{$host}[0];
196	_slot_schedule $host;	302	_slot_schedule $host;
197	});	303	});
198	} else {	304	} else {
199	# nobody wants the slot, maybe we can forget about it	305	# nobody wants the slot, maybe we can forget about it
200	delete $CO_SLOT{$host} unless $CO_SLOT{$host}[0];	306	delete $CO_SLOT{$host} unless $CO_SLOT{$host}[0];
201	warn "$host deleted" unless $CO_SLOT{$host}[0];#d#
202	last;	307	last;
203	}	308	}
204	}	309	}
205	}	310	}
206		311
…		…
209	push @{ $CO_SLOT{$_[0]}[1] }, $_[1];	314	push @{ $CO_SLOT{$_[0]}[1] }, $_[1];
210		315
211	_slot_schedule $_[0];	316	_slot_schedule $_[0];
212	}	317	}
213		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
214	sub http_request($$$;@) {	325	sub http_request($$@) {
215	my $cb = pop;	326	my $cb = pop;
216	my ($method, $url, %arg) = @_;	327	my ($method, $url, %arg) = @_;
217		328
218	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";
219		333
220	$method = uc $method;	334	$method = uc $method;
221		335
222	if (my $hdr = $arg{headers}) {	336	if (my $hdr = $arg{headers}) {
223	while (my ($k, $v) = each %$hdr) {	337	while (my ($k, $v) = each %$hdr) {
224	$hdr{lc $k} = $v;	338	$hdr{lc $k} = $v;
225	}	339	}
226	}	340	}
227		341
228	my $recurse = exists $arg{recurse} ? $arg{recurse} : $MAX_RECURSE;	342	my $recurse = exists $arg{recurse} ? delete $arg{recurse} : $MAX_RECURSE;
229		343
230	return $cb->(undef, { Status => 599, Reason => "recursion limit reached" })	344	return $cb->(undef, { Status => 599, Reason => "Too many redirections", URL => $url })
231	if $recurse < 0;	345	if $recurse < 0;
232		346
233	my $proxy = $arg{proxy} \|\| $PROXY;	347	my $proxy = $arg{proxy} \|\| $PROXY;
234	my $timeout = $arg{timeout} \|\| $TIMEOUT;	348	my $timeout = $arg{timeout} \|\| $TIMEOUT;
235		349
236	$hdr{"user-agent"} \|\|= $USERAGENT;
237
238	my ($scheme, $authority, $upath, $query, $fragment) =	350	my ($uscheme, $uauthority, $upath, $query, $fragment) =
239	$url =~ m\|(?:([^:/?#]+):)?(?://([^/?#]))?([^?#])(?:\?([^#]))?(?:#(.))?\|;	351	$url =~ m\|(?:([^:/?#]+):)?(?://([^/?#]))?([^?#])(?:\?([^#]))?(?:#(.))?\|;
240		352
241	$scheme = lc $scheme;	353	$uscheme = lc $uscheme;
242		354
243	my $uport = $scheme eq "http" ? 80	355	my $uport = $uscheme eq "http" ? 80
244	: $scheme eq "https" ? 443	356	: $uscheme eq "https" ? 443
245	: 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 });
246		358
247	$authority =~ /^(?: .*\@ )? ([^\@:]+) (?: : (\d+) )?$/x	359	$uauthority =~ /^(?: .*\@ )? ([^\@:]+) (?: : (\d+) )?$/x
248	or return $cb->(undef, { Status => 599, Reason => "unparsable URL" });	360	or return $cb->(undef, { Status => 599, Reason => "Unparsable URL", URL => $url });
249		361
250	my $uhost = $1;	362	my $uhost = $1;
251	$uport = $2 if defined $2;	363	$uport = $2 if defined $2;
252		364
		365	$hdr{host} = defined $2 ? "$uhost:$2" : "$uhost";
		366
253	$uhost =~ s/^\[(.*)\]$/$1/;	367	$uhost =~ s/^\[(.*)\]$/$1/;
254	$upath .= "?$query" if length $query;	368	$upath .= "?$query" if length $query;
255		369
256	$upath =~ s%^/?%/%;	370	$upath =~ s%^/?%/%;
257		371
258	# cookie processing	372	# cookie processing
259	if (my $jar = $arg{cookie_jar}) {	373	if (my $jar = $arg{cookie_jar}) {
260	%$jar = () if $jar->{version} < 1;	374	%$jar = () if $jar->{version} != 1;
261		375
262	my @cookie;	376	my @cookie;
263		377
264	while (my ($chost, $v) = each %$jar) {	378	while (my ($chost, $v) = each %$jar) {
		379	if ($chost =~ /^\./) {
265	next unless $chost eq substr $uhost, -length $chost;	380	next unless $chost eq substr $uhost, -length $chost;
266	next unless $chost =~ /^\./;	381	} elsif ($chost =~ /\./) {
		382	next unless $chost eq $uhost;
		383	} else {
		384	next;
		385	}
267		386
268	while (my ($cpath, $v) = each %$v) {	387	while (my ($cpath, $v) = each %$v) {
269	next unless $cpath eq substr $upath, 0, length $cpath;	388	next unless $cpath eq substr $upath, 0, length $cpath;
270		389
271	while (my ($k, $v) = each %$v) {	390	while (my ($k, $v) = each %$v) {
272	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;
273	push @cookie, "$k=$v->{value}";	394	push @cookie, "$k=\"$value\"";
274	}	395	}
275	}	396	}
276	}	397	}
277		398
278	$hdr{cookie} = join "; ", @cookie	399	$hdr{cookie} = join "; ", @cookie
279	if @cookie;	400	if @cookie;
280	}	401	}
281		402
282	my ($rhost, $rport, $rpath); # request host, port, path	403	my ($rhost, $rport, $rscheme, $rpath); # request host, port, path
283		404
284	if ($proxy) {	405	if ($proxy) {
285	($rhost, $rport, $scheme) = @$proxy;	406	($rpath, $rhost, $rport, $rscheme) = ($url, @$proxy);
286	$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";
287	} else {	413	} else {
288	($rhost, $rport, $rpath) = ($uhost, $uport, $upath);	414	($rhost, $rport, $rscheme, $rpath) = ($uhost, $uport, $uscheme, $upath);
289	$hdr{host} = $uhost;
290	}	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"};
291		420
292	$hdr{"content-length"} = length $arg{body};	421	$hdr{"content-length"} = length $arg{body};
293		422
294	my %state = (connect_guard => 1);	423	my %state = (connect_guard => 1);
295		424
…		…
298		427
299	return unless $state{connect_guard};	428	return unless $state{connect_guard};
300		429
301	$state{connect_guard} = AnyEvent::Socket::tcp_connect $rhost, $rport, sub {	430	$state{connect_guard} = AnyEvent::Socket::tcp_connect $rhost, $rport, sub {
302	$state{fh} = shift	431	$state{fh} = shift
		432	or do {
		433	my $err = "$!";
		434	%state = ();
303	or return $cb->(undef, { Status => 599, Reason => "$!" });	435	return $cb->(undef, { Status => 599, Reason => $err, URL => $url });
		436	};
304		437
305	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};
306		441
307	# get handle	442	# get handle
308	$state{handle} = new AnyEvent::Handle	443	$state{handle} = new AnyEvent::Handle
309	fh => $state{fh},	444	fh => $state{fh},
310	($scheme eq "https" ? (tls => "connect") : ());	445	timeout => $timeout,
		446	peername => $rhost,
		447	tls_ctx => $arg{tls_ctx};
311		448
312	# limit the number of persistent connections	449	# limit the number of persistent connections
		450	# keepalive not yet supported
313	if ($KA_COUNT{$_[1]} < $MAX_PERSISTENT_PER_HOST) {	451	if ($KA_COUNT{$_[1]} < $MAX_PERSISTENT_PER_HOST) {
314	++$KA_COUNT{$_[1]};	452	++$KA_COUNT{$_[1]};
315	$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	};
316	$hdr{connection} = "keep-alive";	456	$hdr{connection} = "keep-alive";
317	delete $hdr{connection}; # keep-alive not yet supported
318	} else {	457	} else {
319	delete $hdr{connection};	458	delete $hdr{connection};
320	}	459	}
321		460
322	# (re-)configure handle	461	# (re-)configure handle
323	$state{handle}->timeout ($timeout);
324	$state{handle}->on_error (sub {	462	$state{handle}->on_error (sub {
325	%state = ();	463	%state = ();
326	$cb->(undef, { Status => 599, Reason => "$!" });	464	$cb->(undef, { Status => 599, Reason => $_[2], URL => $url });
327	});	465	});
328	$state{handle}->on_eof (sub {	466	$state{handle}->on_eof (sub {
329	%state = ();	467	%state = ();
330	$cb->(undef, { Status => 599, Reason => "unexpected end-of-file" });	468	$cb->(undef, { Status => 599, Reason => "Unexpected end-of-file", URL => $url });
331	});	469	});
332		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
333	# send request	477	# send request
334	$state{handle}->push_write (	478	$state{handle}->push_write (
335	"$method $rpath HTTP/1.0\015\012"	479	"$method $rpath HTTP/1.0\015\012"
336	. (join "", map "$_: $hdr{$_}\015\012", keys %hdr)	480	. (join "", map "\u$_: $hdr{$_}\015\012", grep defined $hdr{$_}, keys %hdr)
337	. "\015\012"	481	. "\015\012"
338	. (delete $arg{body})	482	. (delete $arg{body})
339	);
340
341	%hdr = (); # reduce memory usage, save a kitten
342
343	# status line
344	$state{handle}->push_read (line => qr/\015?\012/, sub {
345	$_[1] =~ /^HTTP\/([0-9\.]+) \s+ ([0-9]{3}) \s+ ([^\015\012]+)/ix
346	or return (%state = (), $cb->(undef, { Status => 599, Reason => "invalid server response ($_[1])" }));
347
348	my %hdr = ( # response headers
349	HTTPVersion => "\x00$1",
350	Status => "\x00$2",
351	Reason => "\x00$3",
352	);	483	);
353		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
354	# headers, could be optimized a bit	499	# headers, could be optimized a bit
355	$state{handle}->unshift_read (line => qr/\015?\012\015?\012/, sub {	500	$state{handle}->unshift_read (line => $qr_nlnl, sub {
356	for ("$_[1]\012") {	501	for ("$_[1]") {
357	# 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.
358	# creates them.	503
		504	# things seen, not parsed:
		505	# p3pP="NON CUR OTPi OUR NOR UNI"
		506
359	$hdr{lc $1} .= "\x00$2"	507	$hdr{lc $1} .= ",$2"
360	while /\G	508	while /\G
361	([^:\000-\037]+):	509	([^:\000-\037]*):
362	[\011\040]*	510	[\011\040]*
363	((?: [^\015\012]+ \| \015?\012[\011\040] )*)	511	((?: [^\012]+ \| \012[\011\040] )*)
364	\015?\012	512	\012
365	/gxc;	513	/gxc;
366		514
367	/\G$/	515	/\G$/
368	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 }));
369	}	517	}
370		518
371	substr $_, 0, 1, ""	519	substr $_, 0, 1, ""
372	for values %hdr;	520	for values %hdr;
373		521
374	my $finish = sub {	522	# redirect handling
375	%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/^\.\/+//;
376		527
377	# set-cookie processing	528	my $url = "$rscheme://$uhost:$uport";
378	if ($arg{cookie_jar} && exists $hdr{"set-cookie"}) {
379	for (split /\x00/, $hdr{"set-cookie"}) {
380	my ($cookie, @arg) = split /;\s*/;
381	my ($name, $value) = split /=/, $cookie, 2;
382	my %kv = (value => $value, map { split /=/, $_, 2 } @arg);
383
384	my $cdom = (delete $kv{domain}) \|\| $uhost;
385	my $cpath = (delete $kv{path}) \|\| "/";
386
387	$cdom =~ s/^.?/./; # make sure it starts with a "."
388		529
389	next if $cdom =~ /\.$/;	530	unless ($hdr{location} =~ s/^\///) {
390		531	$url .= $upath;
391	# this is not rfc-like and not netscape-like. go figure.	532	$url =~ s/\/[^\/]*$//;
392	my $ndots = $cdom =~ y/.//;	533	}
393	next if $ndots < ($cdom =~ /\.[^.][^.]\.[^.][^.]$/ ? 3 : 2);	534
394		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
395	# store it	544	$redirect = 1;
396	$arg{cookie_jar}{version} = 1;	545	} elsif ($hdr{Status} == 303) {
397	$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;
398	}	551	}
399	}	552	}
400		553
401	if ($_[1]{Status} =~ /^x30[12]$/ && $recurse) {	554	my $finish = sub {
402	# microsoft and other assholes don't give a shit for following standards,	555	$state{handle}->destroy if $state{handle};
403	# try to support a common form of broken Location header.	556	%state = ();
404	$_[1]{location} =~ s%^/%$scheme://$uhost:$uport/%;
405		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
406	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);
407	} else {	629	} else {
408	$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	}
409	}	680	}
410	};	681	});
		682	});
		683	};
411		684
412	if ($hdr{Status} =~ /^(?:1..\|204\|304)$/ or $method eq "HEAD") {	685	# now handle proxy-CONNECT method
413	$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;
414	} else {	698	} else {
415	if (exists $hdr{"content-length"}) {	699	%state = ();
416	$_[0]->unshift_read (chunk => $hdr{"content-length"}, sub {	700	$cb->(undef, { Status => $2, Reason => $3, URL => $url });
417	# could cache persistent connection now
418	if ($hdr{connection} =~ /\bkeep-alive\b/i) {
419	# but we don't, due to misdesigns, this is annoyingly complex
420	};
421
422	$finish->($_[1], \%hdr);
423	});
424	} else {
425	# too bad, need to read until we get an error or EOF,
426	# no way to detect winged data.
427	$_[0]->on_error (sub {
428	$finish->($_[0]{rbuf}, \%hdr);
429	});
430	$_[0]->on_eof (undef);
431	$_[0]->on_read (sub { });
432	}
433	}	701	}
434	});	702	});
		703	} else {
		704	&$handle_actual_request;
435	});	705	}
		706
436	}, sub {	707	}, sub {
437	$timeout	708	$timeout
438	};	709	};
439	};	710	};
440		711
441	defined wantarray && AnyEvent::Util::guard { %state = () }	712	defined wantarray && AnyEvent::Util::guard { %state = () }
442	}	713	}
443		714
444	sub http_get($$;@) {	715	sub http_get($@) {
445	unshift @_, "GET";	716	unshift @_, "GET";
446	&http_request	717	&http_request
447	}	718	}
448		719
449	sub http_head($$;@) {	720	sub http_head($@) {
450	unshift @_, "HEAD";	721	unshift @_, "HEAD";
451	&http_request	722	&http_request
452	}	723	}
453		724
454	sub http_post($$$;@) {	725	sub http_post($$@) {
		726	my $url = shift;
455	unshift @_, "POST", "body";	727	unshift @_, "POST", $url, "body";
456	&http_request	728	&http_request
457	}	729	}
458		730
459	=back	731	=back
460		732
…		…
472	The default value for the C<recurse> request parameter (default: C<10>).	744	The default value for the C<recurse> request parameter (default: C<10>).
473		745
474	=item $AnyEvent::HTTP::USERAGENT	746	=item $AnyEvent::HTTP::USERAGENT
475		747
476	The default value for the C<User-Agent> header (the default is	748	The default value for the C<User-Agent> header (the default is
477	C<Mozilla/5.0 (compatible; AnyEvent::HTTP/$VERSION; +http://software.schmorp.de/pkg/AnyEvent)>).	749	C<Mozilla/5.0 (compatible; U; AnyEvent-HTTP/$VERSION; +http://software.schmorp.de/pkg/AnyEvent)>).
478		750
479	=item $AnyEvent::HTTP::MAX_PERSISTENT	751	=item $AnyEvent::HTTP::MAX_PER_HOST
480		752
481	The maximum number of persistent connections to keep open (default: 8).	753	The maximum number of concurrent connections to the same host (identified
		754	by the hostname). If the limit is exceeded, then the additional requests
		755	are queued until previous connections are closed.
482		756
483	Not implemented currently.	757	The default value for this is C<4>, and it is highly advisable to not
		758	increase it.
484		759
485	=item $AnyEvent::HTTP::PERSISTENT_TIMEOUT	760	=item $AnyEvent::HTTP::ACTIVE
486		761
487	The maximum time to cache a persistent connection, in seconds (default: 2).	762	The number of active connections. This is not the number of currently
488		763	running requests, but the number of currently open and non-idle TCP
489	Not implemented currently.	764	connections. This number of can be useful for load-leveling.
490		765
491	=back	766	=back
492		767
493	=cut	768	=cut
494		769
…		…
503		778
504	L<AnyEvent>.	779	L<AnyEvent>.
505		780
506	=head1 AUTHOR	781	=head1 AUTHOR
507		782
508	Marc Lehmann <schmorp@schmorp.de>	783	Marc Lehmann <schmorp@schmorp.de>
509	http://home.schmorp.de/	784	http://home.schmorp.de/
		785
		786	With many thanks to Дмитрий Шалашов, who provided countless
		787	testcases and bugreports.
510		788
511	=cut	789	=cut
512		790
513	1	791	1
514		792

Diff Legend

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

Comparing AnyEvent-HTTP/HTTP.pm (file contents): Revision 1.11 by root, Thu Jun 5 15:34:00 2008 UTC vs. Revision 1.48 by root, Wed Aug 5 16:09:10 2009 UTC

Diff Legend

Comparing AnyEvent-HTTP/HTTP.pm (file contents):
Revision 1.11 by root, Thu Jun 5 15:34:00 2008 UTC vs.
Revision 1.48 by root, Wed Aug 5 16:09:10 2009 UTC