ViewVC Help

View File | Revision Log | Show Annotations | Download File

/cvs/AnyEvent-HTTP/HTTP.pm

Comparing AnyEvent-HTTP/HTTP.pm (file contents):
Revision 1.64 by root, Fri Dec 31 02:53:29 2010 UTC vs.
Revision 1.112 by root, Wed Nov 14 22:22:24 2012 UTC

…		…
15	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
16	run a supported event loop.	16	run a supported event loop.
17		17
18	This module implements a simple, stateless and non-blocking HTTP	18	This module implements a simple, stateless and non-blocking HTTP
19	client. It supports GET, POST and other request methods, cookies and more,	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	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	21	automatically limits the number of connections to the values specified in
22	the RFC.	22	the RFC.
23		23
24	It should generally be a "good client" that is enough for most HTTP	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	25	tasks. Simple tasks should be simple, but complex tasks should still be
…		…
36		36
37	=cut	37	=cut
38		38
39	package AnyEvent::HTTP;	39	package AnyEvent::HTTP;
40		40
41	use strict;	41	use common::sense;
42	no warnings;
43		42
44	use Errno ();	43	use Errno ();
45		44
46	use AnyEvent 5.0 ();	45	use AnyEvent 5.0 ();
47	use AnyEvent::Util ();	46	use AnyEvent::Util ();
48	use AnyEvent::Handle ();	47	use AnyEvent::Handle ();
49		48
50	use base Exporter::;	49	use base Exporter::;
51		50
52	our $VERSION = '1.46';	51	our $VERSION = '2.15';
53		52
54	our @EXPORT = qw(http_get http_post http_head http_request);	53	our @EXPORT = qw(http_get http_post http_head http_request);
55		54
56	our $USERAGENT = "Mozilla/5.0 (compatible; U; AnyEvent-HTTP/$VERSION; +http://software.schmorp.de/pkg/AnyEvent)";	55	our $USERAGENT = "Mozilla/5.0 (compatible; U; AnyEvent-HTTP/$VERSION; +http://software.schmorp.de/pkg/AnyEvent)";
57	our $MAX_RECURSE = 10;	56	our $MAX_RECURSE = 10;
58	our $MAX_PERSISTENT = 8;
59	our $PERSISTENT_TIMEOUT = 2;	57	our $PERSISTENT_TIMEOUT = 3;
60	our $TIMEOUT = 300;	58	our $TIMEOUT = 300;
61		59	our $MAX_PER_HOST = 4; # changing this is evil
62	# changing these is evil
63	our $MAX_PERSISTENT_PER_HOST = 0;
64	our $MAX_PER_HOST = 4;
65		60
66	our $PROXY;	61	our $PROXY;
67	our $ACTIVE = 0;	62	our $ACTIVE = 0;
68		63
69	my %KA_COUNT; # number of open keep-alive connections per host	64	my %KA_CACHE; # indexed by uhost currently, points to [$handle...] array
70	my %CO_SLOT; # number of open connections, and wait queue, per host	65	my %CO_SLOT; # number of open connections, and wait queue, per host
71		66
72	=item http_get $url, key => value..., $cb->($data, $headers)	67	=item http_get $url, key => value..., $cb->($data, $headers)
73		68
74	Executes an HTTP-GET request. See the http_request function for details on	69	Executes an HTTP-GET request. See the http_request function for details on
…		…
94	C<http_request> returns a "cancellation guard" - you have to keep the	89	C<http_request> returns a "cancellation guard" - you have to keep the
95	object at least alive until the callback get called. If the object gets	90	object at least alive until the callback get called. If the object gets
96	destroyed before the callback is called, the request will be cancelled.	91	destroyed before the callback is called, the request will be cancelled.
97		92
98	The callback will be called with the response body data as first argument	93	The callback will be called with the response body data as first argument
99	(or C<undef> if an error occured), and a hash-ref with response headers as	94	(or C<undef> if an error occured), and a hash-ref with response headers
100	second argument.	95	(and trailers) as second argument.
101		96
102	All the headers in that hash are lowercased. In addition to the response	97	All the headers in that hash are lowercased. In addition to the response
103	headers, the "pseudo-headers" (uppercase to avoid clashing with possible	98	headers, the "pseudo-headers" (uppercase to avoid clashing with possible
104	response headers) C<HTTPVersion>, C<Status> and C<Reason> contain the	99	response headers) C<HTTPVersion>, C<Status> and C<Reason> contain the
105	three parts of the HTTP Status-Line of the same name. If an error occurs	100	three parts of the HTTP Status-Line of the same name. If an error occurs
…		…
122		117
123	If the server sends a header multiple times, then their contents will be	118	If the server sends a header multiple times, then their contents will be
124	joined together with a comma (C<,>), as per the HTTP spec.	119	joined together with a comma (C<,>), as per the HTTP spec.
125		120
126	If an internal error occurs, such as not being able to resolve a hostname,	121	If an internal error occurs, such as not being able to resolve a hostname,
127	then C<$data> will be C<undef>, C<< $headers->{Status} >> will be C<59x>	122	then C<$data> will be C<undef>, C<< $headers->{Status} >> will be
128	(usually C<599>) and the C<Reason> pseudo-header will contain an error	123	C<590>-C<599> and the C<Reason> pseudo-header will contain an error
129	message.	124	message. Currently the following status codes are used:
		125
		126	=over 4
		127
		128	=item 595 - errors during connection etsbalishment, proxy handshake.
		129
		130	=item 596 - errors during TLS negotiation, request sending and header processing.
		131
		132	=item 597 - errors during body receiving or processing.
		133
		134	=item 598 - user aborted request via C<on_header> or C<on_body>.
		135
		136	=item 599 - other, usually nonretryable, errors (garbled URL etc.).
		137
		138	=back
130		139
131	A typical callback might look like this:	140	A typical callback might look like this:
132		141
133	sub {	142	sub {
134	my ($body, $hdr) = @_;	143	my ($body, $hdr) = @_;
…		…
145		154
146	=over 4	155	=over 4
147		156
148	=item recurse => $count (default: $MAX_RECURSE)	157	=item recurse => $count (default: $MAX_RECURSE)
149		158
150	Whether to recurse requests or not, e.g. on redirects, authentication	159	Whether to recurse requests or not, e.g. on redirects, authentication and
151	retries and so on, and how often to do so.	160	other retries and so on, and how often to do so.
152		161
153	=item headers => hashref	162	=item headers => hashref
154		163
155	The request headers to use. Currently, C<http_request> may provide its	164	The request headers to use. Currently, C<http_request> may provide its own
156	own C<Host:>, C<Content-Length:>, C<Connection:> and C<Cookie:> headers	165	C<Host:>, C<Content-Length:>, C<Connection:> and C<Cookie:> headers and
157	and will provide defaults for C<User-Agent:> and C<Referer:> (this can be	166	will provide defaults at least for C<TE:>, C<Referer:> and C<User-Agent:>
158	suppressed by using C<undef> for these headers in which case they won't be	167	(this can be suppressed by using C<undef> for these headers in which case
159	sent at all).	168	they won't be sent at all).
		169
		170	You really should provide your own C<User-Agent:> header value that is
		171	appropriate for your program - I wouldn't be surprised if the default
		172	AnyEvent string gets blocked by webservers sooner or later.
		173
		174	Also, make sure that your headers names and values do not contain any
		175	embedded newlines.
160		176
161	=item timeout => $seconds	177	=item timeout => $seconds
162		178
163	The time-out to use for various stages - each connect attempt will reset	179	The time-out to use for various stages - each connect attempt will reset
164	the timeout, as will read or write activity, i.e. this is not an overall	180	the timeout, as will read or write activity, i.e. this is not an overall
…		…
166		182
167	Default timeout is 5 minutes.	183	Default timeout is 5 minutes.
168		184
169	=item proxy => [$host, $port[, $scheme]] or undef	185	=item proxy => [$host, $port[, $scheme]] or undef
170		186
171	Use the given http proxy for all requests. If not specified, then the	187	Use the given http proxy for all requests, or no proxy if C<undef> is
172	default proxy (as specified by C<$ENV{http_proxy}>) is used.	188	used.
173		189
174	C<$scheme> must be either missing, C<http> for HTTP or C<https> for	190	C<$scheme> must be either missing or must be C<http> for HTTP.
175	HTTPS.	191
		192	If not specified, then the default proxy is used (see
		193	C<AnyEvent::HTTP::set_proxy>).
176		194
177	=item body => $string	195	=item body => $string
178		196
179	The request body, usually empty. Will be-sent as-is (future versions of	197	The request body, usually empty. Will be sent as-is (future versions of
180	this module might offer more options).	198	this module might offer more options).
181		199
182	=item cookie_jar => $hash_ref	200	=item cookie_jar => $hash_ref
183		201
184	Passing this parameter enables (simplified) cookie-processing, loosely	202	Passing this parameter enables (simplified) cookie-processing, loosely
185	based on the original netscape specification.	203	based on the original netscape specification.
186		204
187	The C<$hash_ref> must be an (initially empty) hash reference which will	205	The C<$hash_ref> must be an (initially empty) hash reference which
188	get updated automatically. It is possible to save the cookie_jar to	206	will get updated automatically. It is possible to save the cookie jar
189	persistent storage with something like JSON or Storable, but this is not	207	to persistent storage with something like JSON or Storable - see the
190	recommended, as expiry times are currently being ignored.	208	C<AnyEvent::HTTP::cookie_jar_expire> function if you wish to remove
		209	expired or session-only cookies, and also for documentation on the format
		210	of the cookie jar.
191		211
192	Note that this cookie implementation is not of very high quality, nor	212	Note that this cookie implementation is not meant to be complete. If
193	meant to be complete. If you want complete cookie management you have to	213	you want complete cookie management you have to do that on your
194	do that on your own. C<cookie_jar> is meant as a quick fix to get some	214	own. C<cookie_jar> is meant as a quick fix to get most cookie-using sites
195	cookie-using sites working. Cookies are a privacy disaster, do not use	215	working. Cookies are a privacy disaster, do not use them unless required
196	them unless required to.	216	to.
		217
		218	When cookie processing is enabled, the C<Cookie:> and C<Set-Cookie:>
		219	headers will be set and handled by this module, otherwise they will be
		220	left untouched.
197		221
198	=item tls_ctx => $scheme | $tls_ctx	222	=item tls_ctx => $scheme | $tls_ctx
199		223
200	Specifies the AnyEvent::TLS context to be used for https connections. This	224	Specifies the AnyEvent::TLS context to be used for https connections. This
201	parameter follows the same rules as the C<tls_ctx> parameter to	225	parameter follows the same rules as the C<tls_ctx> parameter to
…		…
205	verification) TLS context.	229	verification) TLS context.
206		230
207	The default for this option is C<low>, which could be interpreted as "give	231	The default for this option is C<low>, which could be interpreted as "give
208	me the page, no matter what".	232	me the page, no matter what".
209		233
		234	See also the C<sessionid> parameter.
		235
		236	=item session => $string
		237
		238	The module might reuse connections to the same host internally. Sometimes
		239	(e.g. when using TLS), you do not want to reuse connections from other
		240	sessions. This can be achieved by setting this parameter to some unique
		241	ID (such as the address of an object storing your state data, or the TLS
		242	context) - only connections using the same unique ID will be reused.
		243
210	=item on_prepare => $callback->($fh)	244	=item on_prepare => $callback->($fh)
211		245
212	In rare cases you need to "tune" the socket before it is used to	246	In rare cases you need to "tune" the socket before it is used to
213	connect (for exmaple, to bind it on a given IP address). This parameter	247	connect (for exmaple, to bind it on a given IP address). This parameter
214	overrides the prepare callback passed to C<AnyEvent::Socket::tcp_connect>	248	overrides the prepare callback passed to C<AnyEvent::Socket::tcp_connect>
…		…
240		274
241	This callback is useful, among other things, to quickly reject unwanted	275	This callback is useful, among other things, to quickly reject unwanted
242	content, which, if it is supposed to be rare, can be faster than first	276	content, which, if it is supposed to be rare, can be faster than first
243	doing a C<HEAD> request.	277	doing a C<HEAD> request.
244		278
		279	The downside is that cancelling the request makes it impossible to re-use
		280	the connection. Also, the C<on_header> callback will not receive any
		281	trailer (headers sent after the response body).
		282
245	Example: cancel the request unless the content-type is "text/html".	283	Example: cancel the request unless the content-type is "text/html".
246		284
247	on_header => sub {	285	on_header => sub {
248	$_[0]{"content-type"} =~ /^text\/html\s*(?:;|$)/	286	$_[0]{"content-type"} =~ /^text\/html\s*(?:;|$)/
249	},	287	},
…		…
255	string instead of the body data.	293	string instead of the body data.
256		294
257	It has to return either true (in which case AnyEvent::HTTP will continue),	295	It has to return either true (in which case AnyEvent::HTTP will continue),
258	or false, in which case AnyEvent::HTTP will cancel the download (and call	296	or false, in which case AnyEvent::HTTP will cancel the download (and call
259	the completion callback with an error code of C<598>).	297	the completion callback with an error code of C<598>).
		298
		299	The downside to cancelling the request is that it makes it impossible to
		300	re-use the connection.
260		301
261	This callback is useful when the data is too large to be held in memory	302	This callback is useful when the data is too large to be held in memory
262	(so the callback writes it to a file) or when only some information should	303	(so the callback writes it to a file) or when only some information should
263	be extracted, or when the body should be processed incrementally.	304	be extracted, or when the body should be processed incrementally.
264		305
…		…
276	called. Instead of the C<$body> argument containing the body data, the	317	called. Instead of the C<$body> argument containing the body data, the
277	callback will receive the L<AnyEvent::Handle> object associated with the	318	callback will receive the L<AnyEvent::Handle> object associated with the
278	connection. In error cases, C<undef> will be passed. When there is no body	319	connection. In error cases, C<undef> will be passed. When there is no body
279	(e.g. status C<304>), the empty string will be passed.	320	(e.g. status C<304>), the empty string will be passed.
280		321
281	The handle object might or might not be in TLS mode, might be connected to	322	The handle object might or might not be in TLS mode, might be connected
282	a proxy, be a persistent connection etc., and configured in unspecified	323	to a proxy, be a persistent connection, use chunked transfer encoding
283	ways. The user is responsible for this handle (it will not be used by this	324	etc., and configured in unspecified ways. The user is responsible for this
284	module anymore).	325	handle (it will not be used by this module anymore).
285		326
286	This is useful with some push-type services, where, after the initial	327	This is useful with some push-type services, where, after the initial
287	headers, an interactive protocol is used (typical example would be the	328	headers, an interactive protocol is used (typical example would be the
288	push-style twitter API which starts a JSON/XML stream).	329	push-style twitter API which starts a JSON/XML stream).
289		330
290	If you think you need this, first have a look at C<on_body>, to see if	331	If you think you need this, first have a look at C<on_body>, to see if
291	that doesn't solve your problem in a better way.	332	that doesn't solve your problem in a better way.
292		333
		334	=item persistent => $boolean
		335
		336	Try to create/reuse a persistent connection. When this flag is set
		337	(default: true for idempotent requests, false for all others), then
		338	C<http_request> tries to re-use an existing (previously-created)
		339	persistent connection to the host and, failing that, tries to create a new
		340	one.
		341
		342	Requests failing in certain ways will be automatically retried once, which
		343	is dangerous for non-idempotent requests, which is why it defaults to off
		344	for them. The reason for this is because the bozos who designed HTTP/1.1
		345	made it impossible to distinguish between a fatal error and a normal
		346	connection timeout, so you never know whether there was a problem with
		347	your request or not.
		348
		349	When reusing an existent connection, many parameters (such as TLS context)
		350	will be ignored. See the C<session> parameter for a workaround.
		351
		352	=item keepalive => $boolean
		353
		354	Only used when C<persistent> is also true. This parameter decides whether
		355	C<http_request> tries to handshake a HTTP/1.0-style keep-alive connection
		356	(as opposed to only a HTTP/1.1 persistent connection).
		357
		358	The default is true, except when using a proxy, in which case it defaults
		359	to false, as HTTP/1.0 proxies cannot support this in a meaningful way.
		360
		361	=item handle_params => { key => value ... }
		362
		363	The key-value pairs in this hash will be passed to any L<AnyEvent::Handle>
		364	constructor that is called - not all requests will create a handle, and
		365	sometimes more than one is created, so this parameter is only good for
		366	setting hints.
		367
		368	Example: set the maximum read size to 4096, to potentially conserve memory
		369	at the cost of speed.
		370
		371	handle_params => {
		372	max_read_size => 4096,
		373	},
		374
293	=back	375	=back
294		376
295	Example: make a simple HTTP GET request for http://www.nethype.de/	377	Example: do a simple HTTP GET request for http://www.nethype.de/ and print
		378	the response body.
296		379
297	http_request GET => "http://www.nethype.de/", sub {	380	http_request GET => "http://www.nethype.de/", sub {
298	my ($body, $hdr) = @_;	381	my ($body, $hdr) = @_;
299	print "$body\n";	382	print "$body\n";
300	};	383	};
301		384
302	Example: make a HTTP HEAD request on https://www.google.com/, use a	385	Example: do a HTTP HEAD request on https://www.google.com/, use a
303	timeout of 30 seconds.	386	timeout of 30 seconds.
304		387
305	http_request	388	http_request
306	GET => "https://www.google.com",	389	HEAD => "https://www.google.com",
		390	headers => { "user-agent" => "MySearchClient 1.0" },
307	timeout => 30,	391	timeout => 30,
308	sub {	392	sub {
309	my ($body, $hdr) = @_;	393	my ($body, $hdr) = @_;
310	use Data::Dumper;	394	use Data::Dumper;
311	print Dumper $hdr;	395	print Dumper $hdr;
312	}	396	}
313	;	397	;
314		398
315	Example: make another simple HTTP GET request, but immediately try to	399	Example: do another simple HTTP GET request, but immediately try to
316	cancel it.	400	cancel it.
317		401
318	my $request = http_request GET => "http://www.nethype.de/", sub {	402	my $request = http_request GET => "http://www.nethype.de/", sub {
319	my ($body, $hdr) = @_;	403	my ($body, $hdr) = @_;
320	print "$body\n";	404	print "$body\n";
321	};	405	};
322		406
323	undef $request;	407	undef $request;
324		408
325	=cut	409	=cut
		410
		411	#############################################################################
		412	# wait queue/slots
326		413
327	sub _slot_schedule;	414	sub _slot_schedule;
328	sub _slot_schedule($) {	415	sub _slot_schedule($) {
329	my $host = shift;	416	my $host = shift;
330		417
…		…
352	push @{ $CO_SLOT{$_[0]}[1] }, $_[1];	439	push @{ $CO_SLOT{$_[0]}[1] }, $_[1];
353		440
354	_slot_schedule $_[0];	441	_slot_schedule $_[0];
355	}	442	}
356		443
		444	#############################################################################
		445	# cookie handling
		446
		447	# expire cookies
		448	sub cookie_jar_expire($;$) {
		449	my ($jar, $session_end) = @_;
		450
		451	%$jar = () if $jar->{version} != 1;
		452
		453	my $anow = AE::now;
		454
		455	while (my ($chost, $paths) = each %$jar) {
		456	next unless ref $paths;
		457
		458	while (my ($cpath, $cookies) = each %$paths) {
		459	while (my ($cookie, $kv) = each %$cookies) {
		460	if (exists $kv->{_expires}) {
		461	delete $cookies->{$cookie}
		462	if $anow > $kv->{_expires};
		463	} elsif ($session_end) {
		464	delete $cookies->{$cookie};
		465	}
		466	}
		467
		468	delete $paths->{$cpath}
		469	unless %$cookies;
		470	}
		471
		472	delete $jar->{$chost}
		473	unless %$paths;
		474	}
		475	}
		476
		477	# extract cookies from jar
		478	sub cookie_jar_extract($$$$) {
		479	my ($jar, $scheme, $host, $path) = @_;
		480
		481	%$jar = () if $jar->{version} != 1;
		482
		483	my @cookies;
		484
		485	while (my ($chost, $paths) = each %$jar) {
		486	next unless ref $paths;
		487
		488	if ($chost =~ /^\./) {
		489	next unless $chost eq substr $host, -length $chost;
		490	} elsif ($chost =~ /\./) {
		491	next unless $chost eq $host;
		492	} else {
		493	next;
		494	}
		495
		496	while (my ($cpath, $cookies) = each %$paths) {
		497	next unless $cpath eq substr $path, 0, length $cpath;
		498
		499	while (my ($cookie, $kv) = each %$cookies) {
		500	next if $scheme ne "https" && exists $kv->{secure};
		501
		502	if (exists $kv->{_expires} and AE::now > $kv->{_expires}) {
		503	delete $cookies->{$cookie};
		504	next;
		505	}
		506
		507	my $value = $kv->{value};
		508
		509	if ($value =~ /[=;,[:space:]]/) {
		510	$value =~ s/([\\"])/\\$1/g;
		511	$value = "\"$value\"";
		512	}
		513
		514	push @cookies, "$cookie=$value";
		515	}
		516	}
		517	}
		518
		519	\@cookies
		520	}
		521
		522	# parse set_cookie header into jar
		523	sub cookie_jar_set_cookie($$$$) {
		524	my ($jar, $set_cookie, $host, $date) = @_;
		525
		526	my $anow = int AE::now;
		527	my $snow; # server-now
		528
		529	for ($set_cookie) {
		530	# parse NAME=VALUE
		531	my @kv;
		532
		533	# expires is not http-compliant in the original cookie-spec,
		534	# we support the official date format and some extensions
		535	while (
		536	m{
		537	\G\s*
		538	(?:
		539	expires \s*=\s* ([A-Z][a-z][a-z]+,\ [^,;]+)
		540	| ([^=;,[:space:]]+) (?: \s*=\s* (?: "((?:[^\\"]+|\\.)*)" | ([^;,[:space:]]*) ) )?
		541	)
		542	}gcxsi
		543	) {
		544	my $name = $2;
		545	my $value = $4;
		546
		547	if (defined $1) {
		548	# expires
		549	$name = "expires";
		550	$value = $1;
		551	} elsif (defined $3) {
		552	# quoted
		553	$value = $3;
		554	$value =~ s/\\(.)/$1/gs;
		555	}
		556
		557	push @kv, @kv ? lc $name : $name, $value;
		558
		559	last unless /\G\s*;/gc;
		560	}
		561
		562	last unless @kv;
		563
		564	my $name = shift @kv;
		565	my %kv = (value => shift @kv, @kv);
		566
		567	if (exists $kv{"max-age"}) {
		568	$kv{_expires} = $anow + delete $kv{"max-age"};
		569	} elsif (exists $kv{expires}) {
		570	$snow ||= parse_date ($date) || $anow;
		571	$kv{_expires} = $anow + (parse_date (delete $kv{expires}) - $snow);
		572	} else {
		573	delete $kv{_expires};
		574	}
		575
		576	my $cdom;
		577	my $cpath = (delete $kv{path}) || "/";
		578
		579	if (exists $kv{domain}) {
		580	$cdom = delete $kv{domain};
		581
		582	$cdom =~ s/^\.?/./; # make sure it starts with a "."
		583
		584	next if $cdom =~ /\.$/;
		585
		586	# this is not rfc-like and not netscape-like. go figure.
		587	my $ndots = $cdom =~ y/.//;
		588	next if $ndots < ($cdom =~ /\.[^.][^.]\.[^.][^.]$/ ? 3 : 2);
		589	} else {
		590	$cdom = $host;
		591	}
		592
		593	# store it
		594	$jar->{version} = 1;
		595	$jar->{lc $cdom}{$cpath}{$name} = \%kv;
		596
		597	redo if /\G\s*,/gc;
		598	}
		599	}
		600
		601	#############################################################################
		602	# keepalive/persistent connection cache
		603
		604	# fetch a connection from the keepalive cache
		605	sub ka_fetch($) {
		606	my $ka_key = shift;
		607
		608	my $hdl = pop @{ $KA_CACHE{$ka_key} }; # currently we reuse the MOST RECENTLY USED connection
		609	delete $KA_CACHE{$ka_key}
		610	unless @{ $KA_CACHE{$ka_key} };
		611
		612	$hdl
		613	}
		614
		615	sub ka_store($$) {
		616	my ($ka_key, $hdl) = @_;
		617
		618	my $kaa = $KA_CACHE{$ka_key} ||= [];
		619
		620	my $destroy = sub {
		621	my @ka = grep $_ != $hdl, @{ $KA_CACHE{$ka_key} };
		622
		623	$hdl->destroy;
		624
		625	@ka
		626	? $KA_CACHE{$ka_key} = \@ka
		627	: delete $KA_CACHE{$ka_key};
		628	};
		629
		630	# on error etc., destroy
		631	$hdl->on_error ($destroy);
		632	$hdl->on_eof ($destroy);
		633	$hdl->on_read ($destroy);
		634	$hdl->timeout ($PERSISTENT_TIMEOUT);
		635
		636	push @$kaa, $hdl;
		637	shift @$kaa while @$kaa > $MAX_PER_HOST;
		638	}
		639
		640	#############################################################################
		641	# utilities
		642
		643	# continue to parse $_ for headers and place them into the arg
		644	sub _parse_hdr() {
		645	my %hdr;
		646
		647	# things seen, not parsed:
		648	# p3pP="NON CUR OTPi OUR NOR UNI"
		649
		650	$hdr{lc $1} .= ",$2"
		651	while /\G
		652	([^:\000-\037]*):
		653	[\011\040]*
		654	((?: [^\012]+ | \012[\011\040] )*)
		655	\012
		656	/gxc;
		657
		658	/\G$/
		659	or return;
		660
		661	# remove the "," prefix we added to all headers above
		662	substr $_, 0, 1, ""
		663	for values %hdr;
		664
		665	\%hdr
		666	}
		667
		668	#############################################################################
		669	# http_get
		670
357	our $qr_nlnl = qr{(?<![^\012])\015?\012};	671	our $qr_nlnl = qr{(?<![^\012])\015?\012};
358		672
359	our $TLS_CTX_LOW = { cache => 1, sslv2 => 1 };	673	our $TLS_CTX_LOW = { cache => 1, sslv2 => 1 };
360	our $TLS_CTX_HIGH = { cache => 1, verify => 1, verify_peername => "https" };	674	our $TLS_CTX_HIGH = { cache => 1, verify => 1, verify_peername => "https" };
		675
		676	# maybe it should just become a normal object :/
		677
		678	sub _destroy_state(\%) {
		679	my ($state) = @_;
		680
		681	$state->{handle}->destroy if $state->{handle};
		682	%$state = ();
		683	}
		684
		685	sub _error(\%$$) {
		686	my ($state, $cb, $hdr) = @_;
		687
		688	&_destroy_state ($state);
		689
		690	$cb->(undef, $hdr);
		691	()
		692	}
361		693
362	sub http_request($$@) {	694	sub http_request($$@) {
363	my $cb = pop;	695	my $cb = pop;
364	my ($method, $url, %arg) = @_;	696	my ($method, $url, %arg) = @_;
365		697
…		…
383	my $recurse = exists $arg{recurse} ? delete $arg{recurse} : $MAX_RECURSE;	715	my $recurse = exists $arg{recurse} ? delete $arg{recurse} : $MAX_RECURSE;
384		716
385	return $cb->(undef, { @pseudo, Status => 599, Reason => "Too many redirections" })	717	return $cb->(undef, { @pseudo, Status => 599, Reason => "Too many redirections" })
386	if $recurse < 0;	718	if $recurse < 0;
387		719
388	my $proxy = $arg{proxy} || $PROXY;	720	my $proxy = exists $arg{proxy} ? $arg{proxy} : $PROXY;
389	my $timeout = $arg{timeout} || $TIMEOUT;	721	my $timeout = $arg{timeout} || $TIMEOUT;
390		722
391	my ($uscheme, $uauthority, $upath, $query, $fragment) =	723	my ($uscheme, $uauthority, $upath, $query, undef) = # ignore fragment
392	$url =~ m|(?:([^:/?#]+):)?(?://([^/?#]*))?([^?#]*)(?:(\?[^#]*))?(?:#(.*))?|;	724	$url =~ m|^([^:]+):(?://([^/?#]*))?([^?#]*)(?:(\?[^#]*))?(?:#(.*))?$|;
393		725
394	$uscheme = lc $uscheme;	726	$uscheme = lc $uscheme;
395		727
396	my $uport = $uscheme eq "http" ? 80	728	my $uport = $uscheme eq "http" ? 80
397	: $uscheme eq "https" ? 443	729	: $uscheme eq "https" ? 443
398	: return $cb->(undef, { @pseudo, Status => 599, Reason => "Only http and https URL schemes supported" });	730	: return $cb->(undef, { @pseudo, Status => 599, Reason => "Only http and https URL schemes supported" });
399		731
400	$uauthority =~ /^(?: .*\@ )? ([^\@:]+) (?: : (\d+) )?$/x	732	$uauthority =~ /^(?: .*\@ )? ([^\@:]+) (?: : (\d+) )?$/x
401	or return $cb->(undef, { @pseudo, Status => 599, Reason => "Unparsable URL" });	733	or return $cb->(undef, { @pseudo, Status => 599, Reason => "Unparsable URL" });
402		734
403	my $uhost = $1;	735	my $uhost = lc $1;
404	$uport = $2 if defined $2;	736	$uport = $2 if defined $2;
405		737
406	$hdr{host} = defined $2 ? "$uhost:$2" : "$uhost"	738	$hdr{host} = defined $2 ? "$uhost:$2" : "$uhost"
407	unless exists $hdr{host};	739	unless exists $hdr{host};
408		740
…		…
411		743
412	$upath =~ s%^/?%/%;	744	$upath =~ s%^/?%/%;
413		745
414	# cookie processing	746	# cookie processing
415	if (my $jar = $arg{cookie_jar}) {	747	if (my $jar = $arg{cookie_jar}) {
416	%$jar = () if $jar->{version} != 1;	748	my $cookies = cookie_jar_extract $jar, $uscheme, $uhost, $upath;
417		749
418	my @cookie;
419
420	while (my ($chost, $v) = each %$jar) {
421	if ($chost =~ /^\./) {
422	next unless $chost eq substr $uhost, -length $chost;
423	} elsif ($chost =~ /\./) {
424	next unless $chost eq $uhost;
425	} else {
426	next;
427	}
428
429	while (my ($cpath, $v) = each %$v) {
430	next unless $cpath eq substr $upath, 0, length $cpath;
431
432	while (my ($k, $v) = each %$v) {
433	next if $uscheme ne "https" && exists $v->{secure};
434	my $value = $v->{value};
435	$value =~ s/([\\"])/\\$1/g;
436	push @cookie, "$k=\"$value\"";
437	}
438	}
439	}
440
441	$hdr{cookie} = join "; ", @cookie	750	$hdr{cookie} = join "; ", @$cookies
442	if @cookie;	751	if @$cookies;
443	}	752	}
444		753
445	my ($rhost, $rport, $rscheme, $rpath); # request host, port, path	754	my ($rhost, $rport, $rscheme, $rpath); # request host, port, path
446		755
447	if ($proxy) {	756	if ($proxy) {
…		…
450	$rscheme = "http" unless defined $rscheme;	759	$rscheme = "http" unless defined $rscheme;
451		760
452	# don't support https requests over https-proxy transport,	761	# don't support https requests over https-proxy transport,
453	# can't be done with tls as spec'ed, unless you double-encrypt.	762	# can't be done with tls as spec'ed, unless you double-encrypt.
454	$rscheme = "http" if $uscheme eq "https" && $rscheme eq "https";	763	$rscheme = "http" if $uscheme eq "https" && $rscheme eq "https";
		764
		765	$rhost = lc $rhost;
		766	$rscheme = lc $rscheme;
455	} else {	767	} else {
456	($rhost, $rport, $rscheme, $rpath) = ($uhost, $uport, $uscheme, $upath);	768	($rhost, $rport, $rscheme, $rpath) = ($uhost, $uport, $uscheme, $upath);
457	}	769	}
458		770
459	# leave out fragment and query string, just a heuristic	771	# leave out fragment and query string, just a heuristic
460	$hdr{referer} ||= "$uscheme://$uauthority$upath" unless exists $hdr{referer};	772	$hdr{referer} = "$uscheme://$uauthority$upath" unless exists $hdr{referer};
461	$hdr{"user-agent"} ||= $USERAGENT unless exists $hdr{"user-agent"};	773	$hdr{"user-agent"} = $USERAGENT unless exists $hdr{"user-agent"};
462		774
463	$hdr{"content-length"} = length $arg{body}	775	$hdr{"content-length"} = length $arg{body}
464	if length $arg{body} || $method ne "GET";	776	if length $arg{body} || $method ne "GET";
465		777
		778	my $idempotent = $method =~ /^(?:GET|HEAD|PUT|DELETE|OPTIONS|TRACE)$/;
		779
		780	# default value for keepalive is true iff the request is for an idempotent method
		781	my $persistent = exists $arg{persistent} ? !!$arg{persistent} : $idempotent;
		782	my $keepalive = exists $arg{keepalive} ? !!$arg{keepalive} : !$proxy;
		783	my $was_persistent; # true if this is actually a recycled connection
		784
		785	# the key to use in the keepalive cache
		786	my $ka_key = "$uscheme\x00$uhost\x00$uport\x00$arg{sessionid}";
		787
		788	$hdr{connection} = ($persistent ? $keepalive ? "keep-alive " : "" : "close ") . "Te"; #1.1
		789	$hdr{te} = "trailers" unless exists $hdr{te}; #1.1
		790
466	my %state = (connect_guard => 1);	791	my %state = (connect_guard => 1);
		792
		793	my $ae_error = 595; # connecting
		794
		795	# handle actual, non-tunneled, request
		796	my $handle_actual_request = sub {
		797	$ae_error = 596; # request phase
		798
		799	my $hdl = $state{handle};
		800
		801	$hdl->starttls ("connect") if $uscheme eq "https" && !exists $hdl->{tls};
		802
		803	# send request
		804	$hdl->push_write (
		805	"$method $rpath HTTP/1.1\015\012"
		806	. (join "", map "\u$_: $hdr{$_}\015\012", grep defined $hdr{$_}, keys %hdr)
		807	. "\015\012"
		808	. (delete $arg{body})
		809	);
		810
		811	# return if error occured during push_write()
		812	return unless %state;
		813
		814	# reduce memory usage, save a kitten, also re-use it for the response headers.
		815	%hdr = ();
		816
		817	# status line and headers
		818	$state{read_response} = sub {
		819	return unless %state;
		820
		821	for ("$_[1]") {
		822	y/\015//d; # weed out any \015, as they show up in the weirdest of places.
		823
		824	/^HTTP\/0*([0-9\.]+) \s+ ([0-9]{3}) (?: \s+ ([^\012]*) )? \012/gxci
		825	or return _error %state, $cb, { @pseudo, Status => 599, Reason => "Invalid server response" };
		826
		827	# 100 Continue handling
		828	# should not happen as we don't send expect: 100-continue,
		829	# but we handle it just in case.
		830	# since we send the request body regardless, if we get an error
		831	# we are out of-sync, which we currently do NOT handle correctly.
		832	return $state{handle}->push_read (line => $qr_nlnl, $state{read_response})
		833	if $2 eq 100;
		834
		835	push @pseudo,
		836	HTTPVersion => $1,
		837	Status => $2,
		838	Reason => $3,
		839	;
		840
		841	my $hdr = _parse_hdr
		842	or return _error %state, $cb, { @pseudo, Status => 599, Reason => "Garbled response headers" };
		843
		844	%hdr = (%$hdr, @pseudo);
		845	}
		846
		847	# redirect handling
		848	# microsoft and other shitheads don't give a shit for following standards,
		849	# try to support some common forms of broken Location headers.
		850	if ($hdr{location} !~ /^(?: $ | [^:\/?\#]+ : )/x) {
		851	$hdr{location} =~ s/^\.\/+//;
		852
		853	my $url = "$rscheme://$uhost:$uport";
		854
		855	unless ($hdr{location} =~ s/^\///) {
		856	$url .= $upath;
		857	$url =~ s/\/[^\/]*$//;
		858	}
		859
		860	$hdr{location} = "$url/$hdr{location}";
		861	}
		862
		863	my $redirect;
		864
		865	if ($recurse) {
		866	my $status = $hdr{Status};
		867
		868	# industry standard is to redirect POST as GET for
		869	# 301, 302 and 303, in contrast to HTTP/1.0 and 1.1.
		870	# also, the UA should ask the user for 301 and 307 and POST,
		871	# industry standard seems to be to simply follow.
		872	# we go with the industry standard.
		873	if ($status == 301 or $status == 302 or $status == 303) {
		874	# HTTP/1.1 is unclear on how to mutate the method
		875	$method = "GET" unless $method eq "HEAD";
		876	$redirect = 1;
		877	} elsif ($status == 307) {
		878	$redirect = 1;
		879	}
		880	}
		881
		882	my $finish = sub { # ($data, $err_status, $err_reason[, $persistent])
		883	if ($state{handle}) {
		884	# handle keepalive
		885	if (
		886	$persistent
		887	&& $_[3]
		888	&& ($hdr{HTTPVersion} < 1.1
		889	? $hdr{connection} =~ /\bkeep-?alive\b/i
		890	: $hdr{connection} !~ /\bclose\b/i)
		891	) {
		892	ka_store $ka_key, delete $state{handle};
		893	} else {
		894	# no keepalive, destroy the handle
		895	$state{handle}->destroy;
		896	}
		897	}
		898
		899	%state = ();
		900
		901	if (defined $_[1]) {
		902	$hdr{OrigStatus} = $hdr{Status}; $hdr{Status} = $_[1];
		903	$hdr{OrigReason} = $hdr{Reason}; $hdr{Reason} = $_[2];
		904	}
		905
		906	# set-cookie processing
		907	if ($arg{cookie_jar}) {
		908	cookie_jar_set_cookie $arg{cookie_jar}, $hdr{"set-cookie"}, $uhost, $hdr{date};
		909	}
		910
		911	if ($redirect && exists $hdr{location}) {
		912	# we ignore any errors, as it is very common to receive
		913	# Content-Length != 0 but no actual body
		914	# we also access %hdr, as $_[1] might be an erro
		915	$state{recurse} =
		916	http_request (
		917	$method => $hdr{location},
		918	%arg,
		919	recurse => $recurse - 1,
		920	Redirect => [$_[0], \%hdr],
		921	sub {
		922	%state = ();
		923	&$cb
		924	},
		925	);
		926	} else {
		927	$cb->($_[0], \%hdr);
		928	}
		929	};
		930
		931	$ae_error = 597; # body phase
		932
		933	my $chunked = $hdr{"transfer-encoding"} =~ /\bchunked\b/i; # not quite correct...
		934
		935	my $len = $chunked ? undef : $hdr{"content-length"};
		936
		937	# body handling, many different code paths
		938	# - no body expected
		939	# - want_body_handle
		940	# - te chunked
		941	# - 2x length known (with or without on_body)
		942	# - 2x length not known (with or without on_body)
		943	if (!$redirect && $arg{on_header} && !$arg{on_header}(\%hdr)) {
		944	$finish->(undef, 598 => "Request cancelled by on_header");
		945	} elsif (
		946	$hdr{Status} =~ /^(?:1..|204|205|304)$/
		947	or $method eq "HEAD"
		948	or (defined $len && $len == 0) # == 0, not !, because "0 " is true
		949	) {
		950	# no body
		951	$finish->("", undef, undef, 1);
		952
		953	} elsif (!$redirect && $arg{want_body_handle}) {
		954	$_[0]->on_eof (undef);
		955	$_[0]->on_error (undef);
		956	$_[0]->on_read (undef);
		957
		958	$finish->(delete $state{handle});
		959
		960	} elsif ($chunked) {
		961	my $cl = 0;
		962	my $body = "";
		963	my $on_body = $arg{on_body} || sub { $body .= shift; 1 };
		964
		965	$state{read_chunk} = sub {
		966	$_[1] =~ /^([0-9a-fA-F]+)/
		967	or return $finish->(undef, $ae_error => "Garbled chunked transfer encoding");
		968
		969	my $len = hex $1;
		970
		971	if ($len) {
		972	$cl += $len;
		973
		974	$_[0]->push_read (chunk => $len, sub {
		975	$on_body->($_[1], \%hdr)
		976	or return $finish->(undef, 598 => "Request cancelled by on_body");
		977
		978	$_[0]->push_read (line => sub {
		979	length $_[1]
		980	and return $finish->(undef, $ae_error => "Garbled chunked transfer encoding");
		981	$_[0]->push_read (line => $state{read_chunk});
		982	});
		983	});
		984	} else {
		985	$hdr{"content-length"} ||= $cl;
		986
		987	$_[0]->push_read (line => $qr_nlnl, sub {
		988	if (length $_[1]) {
		989	for ("$_[1]") {
		990	y/\015//d; # weed out any \015, as they show up in the weirdest of places.
		991
		992	my $hdr = _parse_hdr
		993	or return $finish->(undef, $ae_error => "Garbled response trailers");
		994
		995	%hdr = (%hdr, %$hdr);
		996	}
		997	}
		998
		999	$finish->($body, undef, undef, 1);
		1000	});
		1001	}
		1002	};
		1003
		1004	$_[0]->push_read (line => $state{read_chunk});
		1005
		1006	} elsif ($arg{on_body}) {
		1007	if (defined $len) {
		1008	$_[0]->on_read (sub {
		1009	$len -= length $_[0]{rbuf};
		1010
		1011	$arg{on_body}(delete $_[0]{rbuf}, \%hdr)
		1012	or return $finish->(undef, 598 => "Request cancelled by on_body");
		1013
		1014	$len > 0
		1015	or $finish->("", undef, undef, 1);
		1016	});
		1017	} else {
		1018	$_[0]->on_eof (sub {
		1019	$finish->("");
		1020	});
		1021	$_[0]->on_read (sub {
		1022	$arg{on_body}(delete $_[0]{rbuf}, \%hdr)
		1023	or $finish->(undef, 598 => "Request cancelled by on_body");
		1024	});
		1025	}
		1026	} else {
		1027	$_[0]->on_eof (undef);
		1028
		1029	if (defined $len) {
		1030	$_[0]->on_read (sub {
		1031	$finish->((substr delete $_[0]{rbuf}, 0, $len, ""), undef, undef, 1)
		1032	if $len <= length $_[0]{rbuf};
		1033	});
		1034	} else {
		1035	$_[0]->on_error (sub {
		1036	($! == Errno::EPIPE || !$!)
		1037	? $finish->(delete $_[0]{rbuf})
		1038	: $finish->(undef, $ae_error => $_[2]);
		1039	});
		1040	$_[0]->on_read (sub { });
		1041	}
		1042	}
		1043	};
		1044
		1045	# if keepalive is enabled, then the server closing the connection
		1046	# before a response can happen legally - we retry on idempotent methods.
		1047	if ($was_persistent && $idempotent) {
		1048	my $old_eof = $hdl->{on_eof};
		1049	$hdl->{on_eof} = sub {
		1050	_destroy_state %state;
		1051
		1052	%state = ();
		1053	$state{recurse} =
		1054	http_request (
		1055	$method => $url,
		1056	%arg,
		1057	recurse => $recurse - 1,
		1058	keepalive => 0,
		1059	sub {
		1060	%state = ();
		1061	&$cb
		1062	}
		1063	);
		1064	};
		1065	$hdl->on_read (sub {
		1066	return unless %state;
		1067
		1068	# as soon as we receive something, a connection close
		1069	# once more becomes a hard error
		1070	$hdl->{on_eof} = $old_eof;
		1071	$hdl->push_read (line => $qr_nlnl, $state{read_response});
		1072	});
		1073	} else {
		1074	$hdl->push_read (line => $qr_nlnl, $state{read_response});
		1075	}
		1076	};
		1077
		1078	my $prepare_handle = sub {
		1079	my ($hdl) = $state{handle};
		1080
		1081	$hdl->on_error (sub {
		1082	_error %state, $cb, { @pseudo, Status => $ae_error, Reason => $_[2] };
		1083	});
		1084	$hdl->on_eof (sub {
		1085	_error %state, $cb, { @pseudo, Status => $ae_error, Reason => "Unexpected end-of-file" };
		1086	});
		1087	$hdl->timeout_reset;
		1088	$hdl->timeout ($timeout);
		1089	};
		1090
		1091	# connected to proxy (or origin server)
		1092	my $connect_cb = sub {
		1093	my $fh = shift
		1094	or return _error %state, $cb, { @pseudo, Status => $ae_error, Reason => "$!" };
		1095
		1096	return unless delete $state{connect_guard};
		1097
		1098	# get handle
		1099	$state{handle} = new AnyEvent::Handle
		1100	%{ $arg{handle_params} },
		1101	fh => $fh,
		1102	peername => $uhost,
		1103	tls_ctx => $arg{tls_ctx},
		1104	;
		1105
		1106	$prepare_handle->();
		1107
		1108	#$state{handle}->starttls ("connect") if $rscheme eq "https";
		1109
		1110	# now handle proxy-CONNECT method
		1111	if ($proxy && $uscheme eq "https") {
		1112	# oh dear, we have to wrap it into a connect request
		1113
		1114	# maybe re-use $uauthority with patched port?
		1115	$state{handle}->push_write ("CONNECT $uhost:$uport HTTP/1.0\015\012\015\012");
		1116	$state{handle}->push_read (line => $qr_nlnl, sub {
		1117	$_[1] =~ /^HTTP\/([0-9\.]+) \s+ ([0-9]{3}) (?: \s+ ([^\015\012]*) )?/ix
		1118	or return _error %state, $cb, { @pseudo, Status => 599, Reason => "Invalid proxy connect response ($_[1])" };
		1119
		1120	if ($2 == 200) {
		1121	$rpath = $upath;
		1122	$handle_actual_request->();
		1123	} else {
		1124	_error %state, $cb, { @pseudo, Status => $2, Reason => $3 };
		1125	}
		1126	});
		1127	} else {
		1128	$handle_actual_request->();
		1129	}
		1130	};
467		1131
468	_get_slot $uhost, sub {	1132	_get_slot $uhost, sub {
469	$state{slot_guard} = shift;	1133	$state{slot_guard} = shift;
470		1134
471	return unless $state{connect_guard};	1135	return unless $state{connect_guard};
472		1136
473	my $connect_cb = sub {	1137	# try to use an existing keepalive connection, but only if we, ourselves, plan
474	$state{fh} = shift	1138	# on a keepalive request (in theory, this should be a separate config option).
475	or do {	1139	if ($persistent && $KA_CACHE{$ka_key}) {
476	my $err = "$!";	1140	$was_persistent = 1;
477	%state = ();
478	return $cb->(undef, { @pseudo, Status => 599, Reason => $err });
479	};
480		1141
481	pop; # free memory, save a tree	1142	$state{handle} = ka_fetch $ka_key;
482
483	return unless delete $state{connect_guard};
484
485	# get handle
486	$state{handle} = new AnyEvent::Handle
487	fh => $state{fh},
488	peername => $rhost,
489	tls_ctx => $arg{tls_ctx},
490	# these need to be reconfigured on keepalive handles
491	timeout => $timeout,
492	on_error => sub {
493	%state = ();
494	$cb->(undef, { @pseudo, Status => 599, Reason => $_[2] });
495	},
496	on_eof => sub {
497	%state = ();
498	$cb->(undef, { @pseudo, Status => 599, Reason => "Unexpected end-of-file" });
499	},
500	;
501
502	# limit the number of persistent connections
503	# keepalive not yet supported
504	# if ($KA_COUNT{$_[1]} < $MAX_PERSISTENT_PER_HOST) {
505	# ++$KA_COUNT{$_[1]};
506	# $state{handle}{ka_count_guard} = AnyEvent::Util::guard {
507	# --$KA_COUNT{$_[1]}
508	# };
509	# $hdr{connection} = "keep-alive";
510	# } else {
511	delete $hdr{connection};
512	# }
513
514	$state{handle}->starttls ("connect") if $rscheme eq "https";
515
516	# handle actual, non-tunneled, request
517	my $handle_actual_request = sub {
518	$state{handle}->starttls ("connect") if $uscheme eq "https" && !exists $state{handle}{tls};
519
520	# send request
521	$state{handle}->push_write (	1143	$state{handle}->destroyed
522	"$method $rpath HTTP/1.0\015\012"	1144	and die "AnyEvent::HTTP: unexpectedly got a destructed handle (1), please report.";#d#
523	. (join "", map "\u$_: $hdr{$_}\015\012", grep defined $hdr{$_}, keys %hdr)	1145	$prepare_handle->();
524	. "\015\012"	1146	$state{handle}->destroyed
525	. (delete $arg{body})	1147	and die "AnyEvent::HTTP: unexpectedly got a destructed handle (2), please report.";#d#
526	);
527
528	# return if error occured during push_write()
529	return unless %state;
530
531	%hdr = (); # reduce memory usage, save a kitten, also make it possible to re-use
532
533	# status line and headers
534	$state{handle}->push_read (line => $qr_nlnl, sub {
535	my $keepalive = pop;
536
537	for ("$_[1]") {
538	y/\015//d; # weed out any \015, as they show up in the weirdest of places.
539
540	/^HTTP\/([0-9\.]+) \s+ ([0-9]{3}) (?: \s+ ([^\015\012]*) )? \015?\012/igxc
541	or return (%state = (), $cb->(undef, { @pseudo, Status => 599, Reason => "Invalid server response" }));
542
543	push @pseudo,
544	HTTPVersion => $1,
545	Status => $2,
546	Reason => $3,
547	;
548
549	# things seen, not parsed:
550	# p3pP="NON CUR OTPi OUR NOR UNI"
551
552	$hdr{lc $1} .= ",$2"
553	while /\G
554	([^:\000-\037]*):
555	[\011\040]*
556	((?: [^\012]+ | \012[\011\040] )*)
557	\012
558	/gxc;
559
560	/\G$/
561	or return (%state = (), $cb->(undef, { @pseudo, Status => 599, Reason => "Garbled response headers" }));
562	}
563
564	# remove the "," prefix we added to all headers above
565	substr $_, 0, 1, ""
566	for values %hdr;
567
568	# patch in all pseudo headers
569	%hdr = (%hdr, @pseudo);
570
571	# redirect handling
572	# microsoft and other shitheads don't give a shit for following standards,
573	# try to support some common forms of broken Location headers.
574	if ($hdr{location} !~ /^(?: $ | [^:\/?\#]+ : )/x) {
575	$hdr{location} =~ s/^\.\/+//;
576
577	my $url = "$rscheme://$uhost:$uport";
578
579	unless ($hdr{location} =~ s/^\///) {
580	$url .= $upath;
581	$url =~ s/\/[^\/]*$//;
582	}
583
584	$hdr{location} = "$url/$hdr{location}";
585	}
586
587	my $redirect;
588
589	if ($recurse) {
590	my $status = $hdr{Status};
591
592	# industry standard is to redirect POST as GET for
593	# 301, 302 and 303, in contrast to http/1.0 and 1.1.
594	# also, the UA should ask the user for 301 and 307 and POST,
595	# industry standard seems to be to simply follow.
596	# we go with the industry standard.
597	if ($status == 301 or $status == 302 or $status == 303) {
598	# HTTP/1.1 is unclear on how to mutate the method
599	$method = "GET" unless $method eq "HEAD";
600	$redirect = 1;
601	} elsif ($status == 307) {
602	$redirect = 1;
603	}
604	}
605
606	my $finish = sub { # ($data, $err_status, $err_reason[, $keepalive])
607	$state{handle}->destroy if $state{handle};
608	%state = ();
609
610	if (defined $_[1]) {
611	$hdr{OrigStatus} = $hdr{Status}; $hdr{Status} = $_[1];
612	$hdr{OrigReason} = $hdr{Reason}; $hdr{Reason} = $_[2];
613	}
614
615	# set-cookie processing
616	if ($arg{cookie_jar}) {
617	for ($hdr{"set-cookie"}) {
618	# parse NAME=VALUE
619	my @kv;
620
621	while (/\G\s* ([^=;,[:space:]]+) \s*=\s* (?: "((?:[^\\"]+|\\.)*)" | ([^=;,[:space:]]*) )/gcxs) {
622	my $name = $1;
623	my $value = $3;
624
625	unless ($value) {
626	$value = $2;
627	$value =~ s/\\(.)/$1/gs;
628	}
629
630	push @kv, $name => $value;
631
632	last unless /\G\s*;/gc;
633	}
634
635	last unless @kv;
636
637	my $name = shift @kv;
638	my %kv = (value => shift @kv, @kv);
639
640	my $cdom;
641	my $cpath = (delete $kv{path}) || "/";
642
643	if (exists $kv{domain}) {
644	$cdom = delete $kv{domain};
645
646	$cdom =~ s/^\.?/./; # make sure it starts with a "."
647
648	next if $cdom =~ /\.$/;
649
650	# this is not rfc-like and not netscape-like. go figure.
651	my $ndots = $cdom =~ y/.//;
652	next if $ndots < ($cdom =~ /\.[^.][^.]\.[^.][^.]$/ ? 3 : 2);
653	} else {
654	$cdom = $uhost;
655	}
656
657	# store it
658	$arg{cookie_jar}{version} = 1;
659	$arg{cookie_jar}{$cdom}{$cpath}{$name} = \%kv;
660
661	redo if /\G\s*,/gc;
662	}
663	}
664
665	if ($redirect && exists $hdr{location}) {
666	# we ignore any errors, as it is very common to receive
667	# Content-Length != 0 but no actual body
668	# we also access %hdr, as $_[1] might be an erro
669	http_request (
670	$method => $hdr{location},
671	%arg,
672	recurse => $recurse - 1,
673	Redirect => [$_[0], \%hdr],
674	$cb);
675	} else {
676	$cb->($_[0], \%hdr);
677	}
678	};
679
680	my $len = $hdr{"content-length"};
681
682	if (!$redirect && $arg{on_header} && !$arg{on_header}(\%hdr)) {
683	$finish->(undef, 598 => "Request cancelled by on_header");
684	} elsif (
685	$hdr{Status} =~ /^(?:1..|204|205|304)$/
686	or $method eq "HEAD"
687	or (defined $len && !$len)
688	) {
689	# no body
690	$finish->("", undef, undef, 1);
691	} else {
692	# body handling, four different code paths
693	# for want_body_handle, on_body (2x), normal (2x)
694	# we might read too much here, but it does not matter yet (no pipelining)
695	if (!$redirect && $arg{want_body_handle}) {
696	$_[0]->on_eof (undef);
697	$_[0]->on_error (undef);
698	$_[0]->on_read (undef);
699
700	$finish->(delete $state{handle});
701
702	} elsif ($arg{on_body}) {
703	$_[0]->on_error (sub { $finish->(undef, 599 => $_[2]) });
704	if ($len) {
705	$_[0]->on_read (sub {
706	$len -= length $_[0]{rbuf};
707
708	$arg{on_body}(delete $_[0]{rbuf}, \%hdr)
709	or $finish->(undef, 598 => "Request cancelled by on_body");
710
711	$len > 0
712	or $finish->("", undef, undef, 1);
713	});
714	} else {
715	$_[0]->on_eof (sub {
716	$finish->("");
717	});
718	$_[0]->on_read (sub {
719	$arg{on_body}(delete $_[0]{rbuf}, \%hdr)
720	or $finish->(undef, 598 => "Request cancelled by on_body");
721	});
722	}
723	} else {
724	$_[0]->on_eof (undef);
725
726	if ($len) {
727	$_[0]->on_error (sub { $finish->(undef, 599 => $_[2]) });
728	$_[0]->on_read (sub {
729	$finish->((substr delete $_[0]{rbuf}, 0, $len, ""), undef, undef, 1)
730	if $len <= length $_[0]{rbuf};
731	});
732	} else {
733	$_[0]->on_error (sub {
734	($! == Errno::EPIPE || !$!)
735	? $finish->(delete $_[0]{rbuf})
736	: $finish->(undef, 599 => $_[2]);
737	});
738	$_[0]->on_read (sub { });
739	}
740	}
741	}
742	});
743	};
744
745	# now handle proxy-CONNECT method
746	if ($proxy && $uscheme eq "https") {
747	# oh dear, we have to wrap it into a connect request
748
749	# maybe re-use $uauthority with patched port?
750	$state{handle}->push_write ("CONNECT $uhost:$uport HTTP/1.0\015\012Host: $uhost\015\012\015\012");
751	$state{handle}->push_read (line => $qr_nlnl, sub {
752	$_[1] =~ /^HTTP\/([0-9\.]+) \s+ ([0-9]{3}) (?: \s+ ([^\015\012]*) )?/ix
753	or return (%state = (), $cb->(undef, { @pseudo, Status => 599, Reason => "Invalid proxy connect response ($_[1])" }));
754
755	if ($2 == 200) {
756	$rpath = $upath;
757	&$handle_actual_request;	1148	$handle_actual_request->();
758	} else {	1149
759	%state = ();
760	$cb->(undef, { @pseudo, Status => $2, Reason => $3 });
761	}
762	});
763	} else {	1150	} else {
764	&$handle_actual_request;
765	}
766	};
767
768	my $tcp_connect = $arg{tcp_connect}	1151	my $tcp_connect = $arg{tcp_connect}
769	|| do { require AnyEvent::Socket; \&AnyEvent::Socket::tcp_connect };	1152	|| do { require AnyEvent::Socket; \&AnyEvent::Socket::tcp_connect };
770		1153
771	$state{connect_guard} = $tcp_connect->($rhost, $rport, $connect_cb, $arg{on_prepare} || sub { $timeout });	1154	$state{connect_guard} = $tcp_connect->($rhost, $rport, $connect_cb, $arg{on_prepare} || sub { $timeout });
772		1155	}
773	};	1156	};
774		1157
775	defined wantarray && AnyEvent::Util::guard { %state = () }	1158	defined wantarray && AnyEvent::Util::guard { _destroy_state %state }
776	}	1159	}
777		1160
778	sub http_get($@) {	1161	sub http_get($@) {
779	unshift @_, "GET";	1162	unshift @_, "GET";
780	&http_request	1163	&http_request
…		…
798	AnyEvent::HTTP uses the AnyEvent::Socket::tcp_connect function for	1181	AnyEvent::HTTP uses the AnyEvent::Socket::tcp_connect function for
799	the actual connection, which in turn uses AnyEvent::DNS to resolve	1182	the actual connection, which in turn uses AnyEvent::DNS to resolve
800	hostnames. The latter is a simple stub resolver and does no caching	1183	hostnames. The latter is a simple stub resolver and does no caching
801	on its own. If you want DNS caching, you currently have to provide	1184	on its own. If you want DNS caching, you currently have to provide
802	your own default resolver (by storing a suitable resolver object in	1185	your own default resolver (by storing a suitable resolver object in
803	C<$AnyEvent::DNS::RESOLVER>).	1186	C<$AnyEvent::DNS::RESOLVER>) or your own C<tcp_connect> callback.
804		1187
805	=head2 GLOBAL FUNCTIONS AND VARIABLES	1188	=head2 GLOBAL FUNCTIONS AND VARIABLES
806		1189
807	=over 4	1190	=over 4
808		1191
809	=item AnyEvent::HTTP::set_proxy "proxy-url"	1192	=item AnyEvent::HTTP::set_proxy "proxy-url"
810		1193
811	Sets the default proxy server to use. The proxy-url must begin with a	1194	Sets the default proxy server to use. The proxy-url must begin with a
812	string of the form C<http://host:port> (optionally C<https:...>), croaks	1195	string of the form C<http://host:port>, croaks otherwise.
813	otherwise.
814		1196
815	To clear an already-set proxy, use C<undef>.	1197	To clear an already-set proxy, use C<undef>.
		1198
		1199	When AnyEvent::HTTP is laoded for the first time it will query the
		1200	default proxy from the operating system, currently by looking at
		1201	C<$ENV{http_proxy>}.
		1202
		1203	=item AnyEvent::HTTP::cookie_jar_expire $jar[, $session_end]
		1204
		1205	Remove all cookies from the cookie jar that have been expired. If
		1206	C<$session_end> is given and true, then additionally remove all session
		1207	cookies.
		1208
		1209	You should call this function (with a true C<$session_end>) before you
		1210	save cookies to disk, and you should call this function after loading them
		1211	again. If you have a long-running program you can additonally call this
		1212	function from time to time.
		1213
		1214	A cookie jar is initially an empty hash-reference that is managed by this
		1215	module. It's format is subject to change, but currently it is like this:
		1216
		1217	The key C<version> has to contain C<1>, otherwise the hash gets
		1218	emptied. All other keys are hostnames or IP addresses pointing to
		1219	hash-references. The key for these inner hash references is the
		1220	server path for which this cookie is meant, and the values are again
		1221	hash-references. The keys of those hash-references is the cookie name, and
		1222	the value, you guessed it, is another hash-reference, this time with the
		1223	key-value pairs from the cookie, except for C<expires> and C<max-age>,
		1224	which have been replaced by a C<_expires> key that contains the cookie
		1225	expiry timestamp.
		1226
		1227	Here is an example of a cookie jar with a single cookie, so you have a
		1228	chance of understanding the above paragraph:
		1229
		1230	{
		1231	version => 1,
		1232	"10.0.0.1" => {
		1233	"/" => {
		1234	"mythweb_id" => {
		1235	_expires => 1293917923,
		1236	value => "ooRung9dThee3ooyXooM1Ohm",
		1237	},
		1238	},
		1239	},
		1240	}
816		1241
817	=item $date = AnyEvent::HTTP::format_date $timestamp	1242	=item $date = AnyEvent::HTTP::format_date $timestamp
818		1243
819	Takes a POSIX timestamp (seconds since the epoch) and formats it as a HTTP	1244	Takes a POSIX timestamp (seconds since the epoch) and formats it as a HTTP
820	Date (RFC 2616).	1245	Date (RFC 2616).
821		1246
822	=item $timestamp = AnyEvent::HTTP::parse_date $date	1247	=item $timestamp = AnyEvent::HTTP::parse_date $date
823		1248
824	Takes a HTTP Date (RFC 2616) and returns the corresponding POSIX	1249	Takes a HTTP Date (RFC 2616) or a Cookie date (netscape cookie spec) or a
		1250	bunch of minor variations of those, and returns the corresponding POSIX
825	timestamp, or C<undef> if the date cannot be parsed.	1251	timestamp, or C<undef> if the date cannot be parsed.
826		1252
827	=item $AnyEvent::HTTP::MAX_RECURSE	1253	=item $AnyEvent::HTTP::MAX_RECURSE
828		1254
829	The default value for the C<recurse> request parameter (default: C<10>).	1255	The default value for the C<recurse> request parameter (default: C<10>).
		1256
		1257	=item $AnyEvent::HTTP::TIMEOUT
		1258
		1259	The default timeout for connection operations (default: C<300>).
830		1260
831	=item $AnyEvent::HTTP::USERAGENT	1261	=item $AnyEvent::HTTP::USERAGENT
832		1262
833	The default value for the C<User-Agent> header (the default is	1263	The default value for the C<User-Agent> header (the default is
834	C<Mozilla/5.0 (compatible; U; AnyEvent-HTTP/$VERSION; +http://software.schmorp.de/pkg/AnyEvent)>).	1264	C<Mozilla/5.0 (compatible; U; AnyEvent-HTTP/$VERSION; +http://software.schmorp.de/pkg/AnyEvent)>).
835		1265
836	=item $AnyEvent::HTTP::MAX_PER_HOST	1266	=item $AnyEvent::HTTP::MAX_PER_HOST
837		1267
838	The maximum number of concurrent connections to the same host (identified	1268	The maximum number of concurrent connections to the same host (identified
839	by the hostname). If the limit is exceeded, then the additional requests	1269	by the hostname). If the limit is exceeded, then the additional requests
840	are queued until previous connections are closed.	1270	are queued until previous connections are closed. Both persistent and
		1271	non-persistent connections are counted in this limit.
841		1272
842	The default value for this is C<4>, and it is highly advisable to not	1273	The default value for this is C<4>, and it is highly advisable to not
843	increase it.	1274	increase it much.
		1275
		1276	For comparison: the RFC's recommend 4 non-persistent or 2 persistent
		1277	connections, older browsers used 2, newers (such as firefox 3) typically
		1278	use 6, and Opera uses 8 because like, they have the fastest browser and
		1279	give a shit for everybody else on the planet.
		1280
		1281	=item $AnyEvent::HTTP::PERSISTENT_TIMEOUT
		1282
		1283	The time after which idle persistent conenctions get closed by
		1284	AnyEvent::HTTP (default: C<3>).
844		1285
845	=item $AnyEvent::HTTP::ACTIVE	1286	=item $AnyEvent::HTTP::ACTIVE
846		1287
847	The number of active connections. This is not the number of currently	1288	The number of active connections. This is not the number of currently
848	running requests, but the number of currently open and non-idle TCP	1289	running requests, but the number of currently open and non-idle TCP
849	connections. This number of can be useful for load-leveling.	1290	connections. This number can be useful for load-leveling.
850		1291
851	=back	1292	=back
852		1293
853	=cut	1294	=cut
854		1295
…		…
869	sub parse_date($) {	1310	sub parse_date($) {
870	my ($date) = @_;	1311	my ($date) = @_;
871		1312
872	my ($d, $m, $y, $H, $M, $S);	1313	my ($d, $m, $y, $H, $M, $S);
873		1314
874	if ($date =~ /^[A-Z][a-z][a-z], ([0-9][0-9]) ([A-Z][a-z][a-z]) ([0-9][0-9][0-9][0-9]) ([0-9][0-9]):([0-9][0-9]):([0-9][0-9]) GMT$/) {	1315	if ($date =~ /^[A-Z][a-z][a-z]+, ([0-9][0-9]?)[\- ]([A-Z][a-z][a-z])[\- ]([0-9][0-9][0-9][0-9]) ([0-9][0-9]?):([0-9][0-9]?):([0-9][0-9]?) GMT$/) {
875	# RFC 822/1123, required by RFC 2616	1316	# RFC 822/1123, required by RFC 2616 (with " ")
		1317	# cookie dates (with "-")
		1318
876	($d, $m, $y, $H, $M, $S) = ($1, $2, $3, $4, $5, $6);	1319	($d, $m, $y, $H, $M, $S) = ($1, $2, $3, $4, $5, $6);
877		1320
878	} elsif ($date =~ /^[A-Z][a-z]+, ([0-9][0-9])-([A-Z][a-z][a-z])-([0-9][0-9]) ([0-9][0-9]):([0-9][0-9]):([0-9][0-9]) GMT$/) {	1321	} elsif ($date =~ /^[A-Z][a-z][a-z]+, ([0-9][0-9]?)-([A-Z][a-z][a-z])-([0-9][0-9]) ([0-9][0-9]?):([0-9][0-9]?):([0-9][0-9]?) GMT$/) {
879	# RFC 850	1322	# RFC 850
880	($d, $m, $y, $H, $M, $S) = ($1, $2, $3 < 69 ? $3 + 2000 : $3 + 1900, $4, $5, $6);	1323	($d, $m, $y, $H, $M, $S) = ($1, $2, $3 < 69 ? $3 + 2000 : $3 + 1900, $4, $5, $6);
881		1324
882	} elsif ($date =~ /^[A-Z][a-z][a-z] ([A-Z][a-z][a-z]) ([0-9 ][0-9]) ([0-9][0-9]):([0-9][0-9]):([0-9][0-9]) ([0-9][0-9][0-9][0-9])$/) {	1325	} elsif ($date =~ /^[A-Z][a-z][a-z]+ ([A-Z][a-z][a-z]) ([0-9 ]?[0-9]) ([0-9][0-9]?):([0-9][0-9]?):([0-9][0-9]?) ([0-9][0-9][0-9][0-9])$/) {
883	# ISO C's asctime	1326	# ISO C's asctime
884	($d, $m, $y, $H, $M, $S) = ($2, $1, $6, $3, $4, $5);	1327	($d, $m, $y, $H, $M, $S) = ($2, $1, $6, $3, $4, $5);
885	}	1328	}
886	# other formats fail in the loop below	1329	# other formats fail in the loop below
887		1330
888	for (0..11) {	1331	for (0..11) {
889	if ($m eq $month[$_]) {	1332	if ($m eq $month[$_]) {
890	require Time::Local;	1333	require Time::Local;
891	return Time::Local::timegm ($S, $M, $H, $d, $_, $y);	1334	return eval { Time::Local::timegm ($S, $M, $H, $d, $_, $y) };
892	}	1335	}
893	}	1336	}
894		1337
895	undef	1338	undef
896	}	1339	}
897		1340
898	sub set_proxy($) {	1341	sub set_proxy($) {
899	if (length $_[0]) {	1342	if (length $_[0]) {
900	$_[0] =~ m%^(https?):// ([^:/]+) (?: : (\d*) )?%ix	1343	$_[0] =~ m%^(http):// ([^:/]+) (?: : (\d*) )?%ix
901	or Carp::croak "$_[0]: invalid proxy URL";	1344	or Carp::croak "$_[0]: invalid proxy URL";
902	$PROXY = [$2, $3 || 3128, $1]	1345	$PROXY = [$2, $3 || 3128, $1]
903	} else {	1346	} else {
904	undef $PROXY;	1347	undef $PROXY;
905	}	1348	}
…		…
908	# initialise proxy from environment	1351	# initialise proxy from environment
909	eval {	1352	eval {
910	set_proxy $ENV{http_proxy};	1353	set_proxy $ENV{http_proxy};
911	};	1354	};
912		1355
		1356	=head2 SHOWCASE
		1357
		1358	This section contaisn some more elaborate "real-world" examples or code
		1359	snippets.
		1360
		1361	=head2 HTTP/1.1 FILE DOWNLOAD
		1362
		1363	Downloading files with HTTP can be quite tricky, especially when something
		1364	goes wrong and you want to resume.
		1365
		1366	Here is a function that initiates and resumes a download. It uses the
		1367	last modified time to check for file content changes, and works with many
		1368	HTTP/1.0 servers as well, and usually falls back to a complete re-download
		1369	on older servers.
		1370
		1371	It calls the completion callback with either C<undef>, which means a
		1372	nonretryable error occured, C<0> when the download was partial and should
		1373	be retried, and C<1> if it was successful.
		1374
		1375	use AnyEvent::HTTP;
		1376
		1377	sub download($$$) {
		1378	my ($url, $file, $cb) = @_;
		1379
		1380	open my $fh, "+<", $file
		1381	or die "$file: $!";
		1382
		1383	my %hdr;
		1384	my $ofs = 0;
		1385
		1386	warn stat $fh;
		1387	warn -s _;
		1388	if (stat $fh and -s _) {
		1389	$ofs = -s _;
		1390	warn "-s is ", $ofs;
		1391	$hdr{"if-unmodified-since"} = AnyEvent::HTTP::format_date +(stat _)[9];
		1392	$hdr{"range"} = "bytes=$ofs-";
		1393	}
		1394
		1395	http_get $url,
		1396	headers => \%hdr,
		1397	on_header => sub {
		1398	my ($hdr) = @_;
		1399
		1400	if ($hdr->{Status} == 200 && $ofs) {
		1401	# resume failed
		1402	truncate $fh, $ofs = 0;
		1403	}
		1404
		1405	sysseek $fh, $ofs, 0;
		1406
		1407	1
		1408	},
		1409	on_body => sub {
		1410	my ($data, $hdr) = @_;
		1411
		1412	if ($hdr->{Status} =~ /^2/) {
		1413	length $data == syswrite $fh, $data
		1414	or return; # abort on write errors
		1415	}
		1416
		1417	1
		1418	},
		1419	sub {
		1420	my (undef, $hdr) = @_;
		1421
		1422	my $status = $hdr->{Status};
		1423
		1424	if (my $time = AnyEvent::HTTP::parse_date $hdr->{"last-modified"}) {
		1425	utime $fh, $time, $time;
		1426	}
		1427
		1428	if ($status == 200 || $status == 206 || $status == 416) {
		1429	# download ok || resume ok || file already fully downloaded
		1430	$cb->(1, $hdr);
		1431
		1432	} elsif ($status == 412) {
		1433	# file has changed while resuming, delete and retry
		1434	unlink $file;
		1435	$cb->(0, $hdr);
		1436
		1437	} elsif ($status == 500 or $status == 503 or $status =~ /^59/) {
		1438	# retry later
		1439	$cb->(0, $hdr);
		1440
		1441	} else {
		1442	$cb->(undef, $hdr);
		1443	}
		1444	}
		1445	;
		1446	}
		1447
		1448	download "http://server/somelargefile", "/tmp/somelargefile", sub {
		1449	if ($_[0]) {
		1450	print "OK!\n";
		1451	} elsif (defined $_[0]) {
		1452	print "please retry later\n";
		1453	} else {
		1454	print "ERROR\n";
		1455	}
		1456	};
		1457
913	=head2 SOCKS PROXIES	1458	=head3 SOCKS PROXIES
914		1459
915	Socks proxies are not directly supported by AnyEvent::HTTP. You can	1460	Socks proxies are not directly supported by AnyEvent::HTTP. You can
916	compile your perl to support socks, or use an external program such as	1461	compile your perl to support socks, or use an external program such as
917	F<socksify> (dante) or F<tsocks> to make your program use a socks proxy	1462	F<socksify> (dante) or F<tsocks> to make your program use a socks proxy
918	transparently.	1463	transparently.

Diff Legend

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