ViewVC Help

View File | Revision Log | Show Annotations | Download File

/cvs/AnyEvent-HTTP/HTTP.pm

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

Diff Legend

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