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

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.46 by root, Sat Jul 25 01:29:09 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.46 by root, Sat Jul 25 01:29:09 2009 UTC