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

Comparing AnyEvent-HTTP/HTTP.pm (file contents):
Revision 1.12 by root, Thu Jun 5 16:33:02 2008 UTC vs.
Revision 1.55 by root, Wed Jun 16 19:17:30 2010 UTC

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

Diff Legend

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

Comparing AnyEvent-HTTP/HTTP.pm (file contents): Revision 1.12 by root, Thu Jun 5 16:33:02 2008 UTC vs. Revision 1.55 by root, Wed Jun 16 19:17:30 2010 UTC

Diff Legend

Comparing AnyEvent-HTTP/HTTP.pm (file contents):
Revision 1.12 by root, Thu Jun 5 16:33:02 2008 UTC vs.
Revision 1.55 by root, Wed Jun 16 19:17:30 2010 UTC