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

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

Diff Legend

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

Comparing AnyEvent-HTTP/HTTP.pm (file contents): Revision 1.10 by root, Thu Jun 5 13:06:43 2008 UTC vs. Revision 1.51 by root, Fri Aug 14 15:21:33 2009 UTC

Diff Legend

Comparing AnyEvent-HTTP/HTTP.pm (file contents):
Revision 1.10 by root, Thu Jun 5 13:06:43 2008 UTC vs.
Revision 1.51 by root, Fri Aug 14 15:21:33 2009 UTC