ViewVC Help

View File | Revision Log | Show Annotations | Download File

/cvs/AnyEvent-HTTP/HTTP.pm

Comparing AnyEvent-HTTP/HTTP.pm (file contents):
Revision 1.82 by root, Sun Jan 2 04:50:40 2011 UTC vs.
Revision 1.137 by root, Mon Apr 27 12:14:12 2020 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.25;
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	94	(or C<undef> if an error occurred), and a hash-ref with response headers
100	(and trailers) as 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
…		…
128	C<590>-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. Currently the following status codes are used:	124	message. Currently the following status codes are used:
130		125
131	=over 4	126	=over 4
132		127
133	=item 595 - errors during connection etsbalishment, proxy handshake.	128	=item 595 - errors during connection establishment, proxy handshake.
134		129
135	=item 596 - errors during TLS negotiation, request sending and header processing.	130	=item 596 - errors during TLS negotiation, request sending and header processing.
136		131
137	=item 597 - errors during body receiving or processing.	132	=item 597 - errors during body receiving or processing.
138		133
…		…
159		154
160	=over 4	155	=over 4
161		156
162	=item recurse => $count (default: $MAX_RECURSE)	157	=item recurse => $count (default: $MAX_RECURSE)
163		158
164	Whether to recurse requests or not, e.g. on redirects, authentication	159	Whether to recurse requests or not, e.g. on redirects, authentication and
165	retries and so on, and how often to do so.	160	other retries and so on, and how often to do so.
		161
		162	Only redirects to http and https URLs are supported. While most common
		163	redirection forms are handled entirely within this module, some require
		164	the use of the optional L<URI> module. If it is required but missing, then
		165	the request will fail with an error.
166		166
167	=item headers => hashref	167	=item headers => hashref
168		168
169	The request headers to use. Currently, C<http_request> may provide its own	169	The request headers to use. Currently, C<http_request> may provide its own
170	C<Host:>, C<Content-Length:>, C<Connection:> and C<Cookie:> headers and	170	C<Host:>, C<Content-Length:>, C<Connection:> and C<Cookie:> headers and
171	will provide defaults at least for C<TE:>, C<Referer:> and C<User-Agent:>	171	will provide defaults at least for C<TE:>, C<Referer:> and C<User-Agent:>
172	(this can be suppressed by using C<undef> for these headers in which case	172	(this can be suppressed by using C<undef> for these headers in which case
173	they won't be sent at all).	173	they won't be sent at all).
174		174
		175	You really should provide your own C<User-Agent:> header value that is
		176	appropriate for your program - I wouldn't be surprised if the default
		177	AnyEvent string gets blocked by webservers sooner or later.
		178
		179	Also, make sure that your headers names and values do not contain any
		180	embedded newlines.
		181
175	=item timeout => $seconds	182	=item timeout => $seconds
176		183
177	The time-out to use for various stages - each connect attempt will reset	184	The time-out to use for various stages - each connect attempt will reset
178	the timeout, as will read or write activity, i.e. this is not an overall	185	the timeout, as will read or write activity, i.e. this is not an overall
179	timeout.	186	timeout.
180		187
181	Default timeout is 5 minutes.	188	Default timeout is 5 minutes.
182		189
183	=item proxy => [$host, $port[, $scheme]] or undef	190	=item proxy => [$host, $port[, $scheme]] or undef
184		191
185	Use the given http proxy for all requests. If not specified, then the	192	Use the given http proxy for all requests, or no proxy if C<undef> is
186	default proxy (as specified by C<$ENV{http_proxy}>) is used.	193	used.
187		194
188	C<$scheme> must be either missing, C<http> for HTTP or C<https> for	195	C<$scheme> must be either missing or must be C<http> for HTTP.
189	HTTPS.	196
		197	If not specified, then the default proxy is used (see
		198	C<AnyEvent::HTTP::set_proxy>).
		199
		200	Currently, if your proxy requires authorization, you have to specify an
		201	appropriate "Proxy-Authorization" header in every request.
		202
		203	Note that this module will prefer an existing persistent connection,
		204	even if that connection was made using another proxy. If you need to
		205	ensure that a new connection is made in this case, you can either force
		206	C<persistent> to false or e.g. use the proxy address in your C<sessionid>.
190		207
191	=item body => $string	208	=item body => $string
192		209
193	The request body, usually empty. Will be sent as-is (future versions of	210	The request body, usually empty. Will be sent as-is (future versions of
194	this module might offer more options).	211	this module might offer more options).
…		…
225	verification) TLS context.	242	verification) TLS context.
226		243
227	The default for this option is C<low>, which could be interpreted as "give	244	The default for this option is C<low>, which could be interpreted as "give
228	me the page, no matter what".	245	me the page, no matter what".
229		246
		247	See also the C<sessionid> parameter.
		248
		249	=item sessionid => $string
		250
		251	The module might reuse connections to the same host internally (regardless
		252	of other settings, such as C<tcp_connect> or C<proxy>). Sometimes (e.g.
		253	when using TLS or a specfic proxy), you do not want to reuse connections
		254	from other sessions. This can be achieved by setting this parameter to
		255	some unique ID (such as the address of an object storing your state data
		256	or the TLS context, or the proxy IP) - only connections using the same
		257	unique ID will be reused.
		258
230	=item on_prepare => $callback->($fh)	259	=item on_prepare => $callback->($fh)
231		260
232	In rare cases you need to "tune" the socket before it is used to	261	In rare cases you need to "tune" the socket before it is used to
233	connect (for exmaple, to bind it on a given IP address). This parameter	262	connect (for example, to bind it on a given IP address). This parameter
234	overrides the prepare callback passed to C<AnyEvent::Socket::tcp_connect>	263	overrides the prepare callback passed to C<AnyEvent::Socket::tcp_connect>
235	and behaves exactly the same way (e.g. it has to provide a	264	and behaves exactly the same way (e.g. it has to provide a
236	timeout). See the description for the C<$prepare_cb> argument of	265	timeout). See the description for the C<$prepare_cb> argument of
237	C<AnyEvent::Socket::tcp_connect> for details.	266	C<AnyEvent::Socket::tcp_connect> for details.
238		267
…		…
241	In even rarer cases you want total control over how AnyEvent::HTTP	270	In even rarer cases you want total control over how AnyEvent::HTTP
242	establishes connections. Normally it uses L<AnyEvent::Socket::tcp_connect>	271	establishes connections. Normally it uses L<AnyEvent::Socket::tcp_connect>
243	to do this, but you can provide your own C<tcp_connect> function -	272	to do this, but you can provide your own C<tcp_connect> function -
244	obviously, it has to follow the same calling conventions, except that it	273	obviously, it has to follow the same calling conventions, except that it
245	may always return a connection guard object.	274	may always return a connection guard object.
		275
		276	The connections made by this hook will be treated as equivalent to
		277	connections made the built-in way, specifically, they will be put into
		278	and taken from the persistent connection cache. If your C<$tcp_connect>
		279	function is incompatible with this kind of re-use, consider switching off
		280	C<persistent> connections and/or providing a C<sessionid> identifier.
246		281
247	There are probably lots of weird uses for this function, starting from	282	There are probably lots of weird uses for this function, starting from
248	tracing the hosts C<http_request> actually tries to connect, to (inexact	283	tracing the hosts C<http_request> actually tries to connect, to (inexact
249	but fast) host => IP address caching or even socks protocol support.	284	but fast) host => IP address caching or even socks protocol support.
250		285
…		…
303	called. Instead of the C<$body> argument containing the body data, the	338	called. Instead of the C<$body> argument containing the body data, the
304	callback will receive the L<AnyEvent::Handle> object associated with the	339	callback will receive the L<AnyEvent::Handle> object associated with the
305	connection. In error cases, C<undef> will be passed. When there is no body	340	connection. In error cases, C<undef> will be passed. When there is no body
306	(e.g. status C<304>), the empty string will be passed.	341	(e.g. status C<304>), the empty string will be passed.
307		342
308	The handle object might or might not be in TLS mode, might be connected to	343	The handle object might or might not be in TLS mode, might be connected
309	a proxy, be a persistent connection etc., and configured in unspecified	344	to a proxy, be a persistent connection, use chunked transfer encoding
310	ways. The user is responsible for this handle (it will not be used by this	345	etc., and configured in unspecified ways. The user is responsible for this
311	module anymore).	346	handle (it will not be used by this module anymore).
312		347
313	This is useful with some push-type services, where, after the initial	348	This is useful with some push-type services, where, after the initial
314	headers, an interactive protocol is used (typical example would be the	349	headers, an interactive protocol is used (typical example would be the
315	push-style twitter API which starts a JSON/XML stream).	350	push-style twitter API which starts a JSON/XML stream).
316		351
317	If you think you need this, first have a look at C<on_body>, to see if	352	If you think you need this, first have a look at C<on_body>, to see if
318	that doesn't solve your problem in a better way.	353	that doesn't solve your problem in a better way.
		354
		355	=item persistent => $boolean
		356
		357	Try to create/reuse a persistent connection. When this flag is set
		358	(default: true for idempotent requests, false for all others), then
		359	C<http_request> tries to re-use an existing (previously-created)
		360	persistent connection to same host (i.e. identical URL scheme, hostname,
		361	port and sessionid) and, failing that, tries to create a new one.
		362
		363	Requests failing in certain ways will be automatically retried once, which
		364	is dangerous for non-idempotent requests, which is why it defaults to off
		365	for them. The reason for this is because the bozos who designed HTTP/1.1
		366	made it impossible to distinguish between a fatal error and a normal
		367	connection timeout, so you never know whether there was a problem with
		368	your request or not.
		369
		370	When reusing an existent connection, many parameters (such as TLS context)
		371	will be ignored. See the C<sessionid> parameter for a workaround.
		372
		373	=item keepalive => $boolean
		374
		375	Only used when C<persistent> is also true. This parameter decides whether
		376	C<http_request> tries to handshake a HTTP/1.0-style keep-alive connection
		377	(as opposed to only a HTTP/1.1 persistent connection).
		378
		379	The default is true, except when using a proxy, in which case it defaults
		380	to false, as HTTP/1.0 proxies cannot support this in a meaningful way.
		381
		382	=item handle_params => { key => value ... }
		383
		384	The key-value pairs in this hash will be passed to any L<AnyEvent::Handle>
		385	constructor that is called - not all requests will create a handle, and
		386	sometimes more than one is created, so this parameter is only good for
		387	setting hints.
		388
		389	Example: set the maximum read size to 4096, to potentially conserve memory
		390	at the cost of speed.
		391
		392	handle_params => {
		393	max_read_size => 4096,
		394	},
319		395
320	=back	396	=back
321		397
322	Example: do a simple HTTP GET request for http://www.nethype.de/ and print	398	Example: do a simple HTTP GET request for http://www.nethype.de/ and print
323	the response body.	399	the response body.
…		…
329		405
330	Example: do a HTTP HEAD request on https://www.google.com/, use a	406	Example: do a HTTP HEAD request on https://www.google.com/, use a
331	timeout of 30 seconds.	407	timeout of 30 seconds.
332		408
333	http_request	409	http_request
334	GET => "https://www.google.com",	410	HEAD => "https://www.google.com",
		411	headers => { "user-agent" => "MySearchClient 1.0" },
335	timeout => 30,	412	timeout => 30,
336	sub {	413	sub {
337	my ($body, $hdr) = @_;	414	my ($body, $hdr) = @_;
338	use Data::Dumper;	415	use Data::Dumper;
339	print Dumper $hdr;	416	print Dumper $hdr;
…		…
349	};	426	};
350		427
351	undef $request;	428	undef $request;
352		429
353	=cut	430	=cut
		431
		432	#############################################################################
		433	# wait queue/slots
354		434
355	sub _slot_schedule;	435	sub _slot_schedule;
356	sub _slot_schedule($) {	436	sub _slot_schedule($) {
357	my $host = shift;	437	my $host = shift;
358		438
…		…
381		461
382	_slot_schedule $_[0];	462	_slot_schedule $_[0];
383	}	463	}
384		464
385	#############################################################################	465	#############################################################################
		466	# cookie handling
386		467
387	# expire cookies	468	# expire cookies
388	sub cookie_jar_expire($;$) {	469	sub cookie_jar_expire($;$) {
389	my ($jar, $session_end) = @_;	470	my ($jar, $session_end) = @_;
390		471
391	%$jar = () if $jar->{version} != 1;	472	%$jar = () if $jar->{version} != 2;
392		473
393	my $anow = AE::now;	474	my $anow = AE::now;
394		475
395	while (my ($chost, $paths) = each %$jar) {	476	while (my ($chost, $paths) = each %$jar) {
396	next unless ref $paths;	477	next unless ref $paths;
…		…
414	}	495	}
415	}	496	}
416		497
417	# extract cookies from jar	498	# extract cookies from jar
418	sub cookie_jar_extract($$$$) {	499	sub cookie_jar_extract($$$$) {
419	my ($jar, $uscheme, $uhost, $upath) = @_;	500	my ($jar, $scheme, $host, $path) = @_;
420		501
421	%$jar = () if $jar->{version} != 1;	502	%$jar = () if $jar->{version} != 2;
		503
		504	$host = AnyEvent::Util::idn_to_ascii $host
		505	if $host =~ /[^\x00-\x7f]/;
422		506
423	my @cookies;	507	my @cookies;
424		508
425	while (my ($chost, $paths) = each %$jar) {	509	while (my ($chost, $paths) = each %$jar) {
426	next unless ref $paths;	510	next unless ref $paths;
427		511
428	if ($chost =~ /^\./) {	512	# exact match or suffix including . match
429	next unless $chost eq substr $uhost, -length $chost;	513	$chost eq $host or ".$chost" eq substr $host, -1 - length $chost
430	} elsif ($chost =~ /\./) {
431	next unless $chost eq $uhost;
432	} else {
433	next;	514	or next;
434	}
435		515
436	while (my ($cpath, $cookies) = each %$paths) {	516	while (my ($cpath, $cookies) = each %$paths) {
437	next unless $cpath eq substr $upath, 0, length $cpath;	517	next unless $cpath eq substr $path, 0, length $cpath;
438		518
439	while (my ($cookie, $kv) = each %$cookies) {	519	while (my ($cookie, $kv) = each %$cookies) {
440	next if $uscheme ne "https" && exists $kv->{secure};	520	next if $scheme ne "https" && exists $kv->{secure};
441		521
442	if (exists $kv->{_expires} and AE::now > $kv->{_expires}) {	522	if (exists $kv->{_expires} and AE::now > $kv->{_expires}) {
443	delete $cookies->{$cookie};	523	delete $cookies->{$cookie};
444	next;	524	next;
445	}	525	}
…		…
459	\@cookies	539	\@cookies
460	}	540	}
461		541
462	# parse set_cookie header into jar	542	# parse set_cookie header into jar
463	sub cookie_jar_set_cookie($$$$) {	543	sub cookie_jar_set_cookie($$$$) {
464	my ($jar, $set_cookie, $uhost, $date) = @_;	544	my ($jar, $set_cookie, $host, $date) = @_;
		545
		546	%$jar = () if $jar->{version} != 2;
465		547
466	my $anow = int AE::now;	548	my $anow = int AE::now;
467	my $snow; # server-now	549	my $snow; # server-now
468		550
469	for ($set_cookie) {	551	for ($set_cookie) {
…		…
475	while (	557	while (
476	m{	558	m{
477	\G\s*	559	\G\s*
478	(?:	560	(?:
479	expires \s*=\s* ([A-Z][a-z][a-z]+,\ [^,;]+)	561	expires \s*=\s* ([A-Z][a-z][a-z]+,\ [^,;]+)
480	| ([^=;,[:space:]]+) (?: \s*=\s* (?: "((?:[^\\"]+|\\.)*)" | ([^=;,[:space:]]*) ) )?	562	| ([^=;,[:space:]]+) (?: \s*=\s* (?: "((?:[^\\"]+|\\.)*)" | ([^;,[:space:]]*) ) )?
481	)	563	)
482	}gcxsi	564	}gcxsi
483	) {	565	) {
484	my $name = $2;	566	my $name = $2;
485	my $value = $4;	567	my $value = $4;
…		…
492	# quoted	574	# quoted
493	$value = $3;	575	$value = $3;
494	$value =~ s/\\(.)/$1/gs;	576	$value =~ s/\\(.)/$1/gs;
495	}	577	}
496		578
497	push @kv, lc $name, $value;	579	push @kv, @kv ? lc $name : $name, $value;
498		580
499	last unless /\G\s*;/gc;	581	last unless /\G\s*;/gc;
500	}	582	}
501		583
502	last unless @kv;	584	last unless @kv;
…		…
515		597
516	my $cdom;	598	my $cdom;
517	my $cpath = (delete $kv{path}) || "/";	599	my $cpath = (delete $kv{path}) || "/";
518		600
519	if (exists $kv{domain}) {	601	if (exists $kv{domain}) {
520	$cdom = delete $kv{domain};	602	$cdom = $kv{domain};
521		603
522	$cdom =~ s/^\.?/./; # make sure it starts with a "."	604	$cdom =~ s/^\.?/./; # make sure it starts with a "."
523		605
524	next if $cdom =~ /\.$/;	606	next if $cdom =~ /\.$/;
525		607
526	# this is not rfc-like and not netscape-like. go figure.	608	# this is not rfc-like and not netscape-like. go figure.
527	my $ndots = $cdom =~ y/.//;	609	my $ndots = $cdom =~ y/.//;
528	next if $ndots < ($cdom =~ /\.[^.][^.]\.[^.][^.]$/ ? 3 : 2);	610	next if $ndots < ($cdom =~ /\.[^.][^.]\.[^.][^.]$/ ? 3 : 2);
		611
		612	$cdom = substr $cdom, 1; # remove initial .
529	} else {	613	} else {
530	$cdom = $uhost;	614	$cdom = $host;
531	}	615	}
532		616
533	# store it	617	# store it
534	$jar->{version} = 1;	618	$jar->{version} = 2;
535	$jar->{$cdom}{$cpath}{$name} = \%kv;	619	$jar->{lc $cdom}{$cpath}{$name} = \%kv;
536		620
537	redo if /\G\s*,/gc;	621	redo if /\G\s*,/gc;
538	}	622	}
539	}	623	}
540		624
		625	#############################################################################
		626	# keepalive/persistent connection cache
		627
		628	# fetch a connection from the keepalive cache
		629	sub ka_fetch($) {
		630	my $ka_key = shift;
		631
		632	my $hdl = pop @{ $KA_CACHE{$ka_key} }; # currently we reuse the MOST RECENTLY USED connection
		633	delete $KA_CACHE{$ka_key}
		634	unless @{ $KA_CACHE{$ka_key} };
		635
		636	$hdl
		637	}
		638
		639	sub ka_store($$) {
		640	my ($ka_key, $hdl) = @_;
		641
		642	my $kaa = $KA_CACHE{$ka_key} ||= [];
		643
		644	my $destroy = sub {
		645	my @ka = grep $_ != $hdl, @{ $KA_CACHE{$ka_key} };
		646
		647	$hdl->destroy;
		648
		649	@ka
		650	? $KA_CACHE{$ka_key} = \@ka
		651	: delete $KA_CACHE{$ka_key};
		652	};
		653
		654	# on error etc., destroy
		655	$hdl->on_error ($destroy);
		656	$hdl->on_eof ($destroy);
		657	$hdl->on_read ($destroy);
		658	$hdl->timeout ($PERSISTENT_TIMEOUT);
		659
		660	push @$kaa, $hdl;
		661	shift @$kaa while @$kaa > $MAX_PER_HOST;
		662	}
		663
		664	#############################################################################
		665	# utilities
		666
541	# continue to parse $_ for headers and place them into the arg	667	# continue to parse $_ for headers and place them into the arg
542	sub parse_hdr() {	668	sub _parse_hdr() {
543	my %hdr;	669	my %hdr;
544		670
545	# things seen, not parsed:	671	# things seen, not parsed:
546	# p3pP="NON CUR OTPi OUR NOR UNI"	672	# p3pP="NON CUR OTPi OUR NOR UNI"
547		673
…		…
561	for values %hdr;	687	for values %hdr;
562		688
563	\%hdr	689	\%hdr
564	}	690	}
565		691
		692	#############################################################################
		693	# http_get
		694
566	our $qr_nlnl = qr{(?<![^\012])\015?\012};	695	our $qr_nlnl = qr{(?<![^\012])\015?\012};
567		696
568	our $TLS_CTX_LOW = { cache => 1, sslv2 => 1 };	697	our $TLS_CTX_LOW = { cache => 1, sslv2 => 1 };
569	our $TLS_CTX_HIGH = { cache => 1, verify => 1, verify_peername => "https" };	698	our $TLS_CTX_HIGH = { cache => 1, verify => 1, verify_peername => "https" };
		699
		700	# maybe it should just become a normal object :/
		701
		702	sub _destroy_state(\%) {
		703	my ($state) = @_;
		704
		705	$state->{handle}->destroy if $state->{handle};
		706	%$state = ();
		707	}
		708
		709	sub _error(\%$$) {
		710	my ($state, $cb, $hdr) = @_;
		711
		712	&_destroy_state ($state);
		713
		714	$cb->(undef, $hdr);
		715	()
		716	}
		717
		718	our %IDEMPOTENT = (
		719	DELETE => 1,
		720	GET => 1,
		721	HEAD => 1,
		722	OPTIONS => 1,
		723	PUT => 1,
		724	TRACE => 1,
		725
		726	ACL => 1,
		727	"BASELINE-CONTROL" => 1,
		728	BIND => 1,
		729	CHECKIN => 1,
		730	CHECKOUT => 1,
		731	COPY => 1,
		732	LABEL => 1,
		733	LINK => 1,
		734	MERGE => 1,
		735	MKACTIVITY => 1,
		736	MKCALENDAR => 1,
		737	MKCOL => 1,
		738	MKREDIRECTREF => 1,
		739	MKWORKSPACE => 1,
		740	MOVE => 1,
		741	ORDERPATCH => 1,
		742	PROPFIND => 1,
		743	PROPPATCH => 1,
		744	REBIND => 1,
		745	REPORT => 1,
		746	SEARCH => 1,
		747	UNBIND => 1,
		748	UNCHECKOUT => 1,
		749	UNLINK => 1,
		750	UNLOCK => 1,
		751	UPDATE => 1,
		752	UPDATEREDIRECTREF => 1,
		753	"VERSION-CONTROL" => 1,
		754	);
570		755
571	sub http_request($$@) {	756	sub http_request($$@) {
572	my $cb = pop;	757	my $cb = pop;
573	my ($method, $url, %arg) = @_;	758	my ($method, $url, %arg) = @_;
574		759
…		…
592	my $recurse = exists $arg{recurse} ? delete $arg{recurse} : $MAX_RECURSE;	777	my $recurse = exists $arg{recurse} ? delete $arg{recurse} : $MAX_RECURSE;
593		778
594	return $cb->(undef, { @pseudo, Status => 599, Reason => "Too many redirections" })	779	return $cb->(undef, { @pseudo, Status => 599, Reason => "Too many redirections" })
595	if $recurse < 0;	780	if $recurse < 0;
596		781
597	my $proxy = $arg{proxy} || $PROXY;	782	my $proxy = exists $arg{proxy} ? $arg{proxy} : $PROXY;
598	my $timeout = $arg{timeout} || $TIMEOUT;	783	my $timeout = $arg{timeout} || $TIMEOUT;
599		784
600	my ($uscheme, $uauthority, $upath, $query, $fragment) =	785	my ($uscheme, $uauthority, $upath, $query, undef) = # ignore fragment
601	$url =~ m|(?:([^:/?#]+):)?(?://([^/?#]*))?([^?#]*)(?:(\?[^#]*))?(?:#(.*))?|;	786	$url =~ m|^([^:]+):(?://([^/?#]*))?([^?#]*)(?:(\?[^#]*))?(?:#(.*))?$|;
602		787
603	$uscheme = lc $uscheme;	788	$uscheme = lc $uscheme;
604		789
605	my $uport = $uscheme eq "http" ? 80	790	my $uport = $uscheme eq "http" ? 80
606	: $uscheme eq "https" ? 443	791	: $uscheme eq "https" ? 443
607	: return $cb->(undef, { @pseudo, Status => 599, Reason => "Only http and https URL schemes supported" });	792	: return $cb->(undef, { @pseudo, Status => 599, Reason => "Only http and https URL schemes supported" });
608		793
609	$uauthority =~ /^(?: .*\@ )? ([^\@:]+) (?: : (\d+) )?$/x	794	$uauthority =~ /^(?: .*\@ )? ([^\@]+?) (?: : (\d+) )?$/x
610	or return $cb->(undef, { @pseudo, Status => 599, Reason => "Unparsable URL" });	795	or return $cb->(undef, { @pseudo, Status => 599, Reason => "Unparsable URL" });
611		796
612	my $uhost = $1;	797	my $uhost = lc $1;
613	$uport = $2 if defined $2;	798	$uport = $2 if defined $2;
614		799
615	$hdr{host} = defined $2 ? "$uhost:$2" : "$uhost"	800	$hdr{host} = defined $2 ? "$uhost:$2" : "$uhost"
616	unless exists $hdr{host};	801	unless exists $hdr{host};
617		802
…		…
636	$rscheme = "http" unless defined $rscheme;	821	$rscheme = "http" unless defined $rscheme;
637		822
638	# don't support https requests over https-proxy transport,	823	# don't support https requests over https-proxy transport,
639	# can't be done with tls as spec'ed, unless you double-encrypt.	824	# can't be done with tls as spec'ed, unless you double-encrypt.
640	$rscheme = "http" if $uscheme eq "https" && $rscheme eq "https";	825	$rscheme = "http" if $uscheme eq "https" && $rscheme eq "https";
		826
		827	$rhost = lc $rhost;
		828	$rscheme = lc $rscheme;
641	} else {	829	} else {
642	($rhost, $rport, $rscheme, $rpath) = ($uhost, $uport, $uscheme, $upath);	830	($rhost, $rport, $rscheme, $rpath) = ($uhost, $uport, $uscheme, $upath);
643	}	831	}
644		832
645	# leave out fragment and query string, just a heuristic	833	# leave out fragment and query string, just a heuristic
…		…
647	$hdr{"user-agent"} = $USERAGENT unless exists $hdr{"user-agent"};	835	$hdr{"user-agent"} = $USERAGENT unless exists $hdr{"user-agent"};
648		836
649	$hdr{"content-length"} = length $arg{body}	837	$hdr{"content-length"} = length $arg{body}
650	if length $arg{body} || $method ne "GET";	838	if length $arg{body} || $method ne "GET";
651		839
652	$hdr{connection} = "close TE"; #1.1	840	my $idempotent = $IDEMPOTENT{$method};
		841
		842	# default value for keepalive is true iff the request is for an idempotent method
		843	my $persistent = exists $arg{persistent} ? !!$arg{persistent} : $idempotent;
		844	my $keepalive = exists $arg{keepalive} ? !!$arg{keepalive} : !$proxy;
		845	my $was_persistent; # true if this is actually a recycled connection
		846
		847	# the key to use in the keepalive cache
		848	my $ka_key = "$uscheme\x00$uhost\x00$uport\x00$arg{sessionid}";
		849
		850	$hdr{connection} = ($persistent ? $keepalive ? "keep-alive, " : "" : "close, ") . "Te"; #1.1
653	$hdr{te} = "trailers" unless exists $hdr{te}; #1.1	851	$hdr{te} = "trailers" unless exists $hdr{te}; #1.1
654		852
655	my %state = (connect_guard => 1);	853	my %state = (connect_guard => 1);
656		854
657	_get_slot $uhost, sub {
658	$state{slot_guard} = shift;
659
660	return unless $state{connect_guard};
661
662	my $ae_error = 595; # connecting	855	my $ae_error = 595; # connecting
663		856
664	# handle actual, non-tunneled, request	857	# handle actual, non-tunneled, request
665	my $handle_actual_request = sub {	858	my $handle_actual_request = sub {
666	$ae_error = 596; # request phase	859	$ae_error = 596; # request phase
667		860
		861	my $hdl = $state{handle};
		862
668	$state{handle}->starttls ("connect") if $uscheme eq "https" && !exists $state{handle}{tls};	863	$hdl->starttls ("connect") if $uscheme eq "https" && !exists $hdl->{tls};
669		864
670	# send request	865	# send request
671	$state{handle}->push_write (	866	$hdl->push_write (
672	"$method $rpath HTTP/1.1\015\012"	867	"$method $rpath HTTP/1.1\015\012"
673	. (join "", map "\u$_: $hdr{$_}\015\012", grep defined $hdr{$_}, keys %hdr)	868	. (join "", map "\u$_: $hdr{$_}\015\012", grep defined $hdr{$_}, keys %hdr)
674	. "\015\012"	869	. "\015\012"
675	. (delete $arg{body})	870	. $arg{body}
676	);	871	);
677		872
678	# return if error occured during push_write()	873	# return if error occurred during push_write()
		874	return unless %state;
		875
		876	# reduce memory usage, save a kitten, also re-use it for the response headers.
		877	%hdr = ();
		878
		879	# status line and headers
		880	$state{read_response} = sub {
679	return unless %state;	881	return unless %state;
680		882
681	%hdr = (); # reduce memory usage, save a kitten, also make it possible to re-use
682
683	# status line and headers
684	$state{read_response} = sub {
685	for ("$_[1]") {	883	for ("$_[1]") {
686	y/\015//d; # weed out any \015, as they show up in the weirdest of places.	884	y/\015//d; # weed out any \015, as they show up in the weirdest of places.
687		885
688	/^HTTP\/0*([0-9\.]+) \s+ ([0-9]{3}) (?: \s+ ([^\012]*) )? \012/gxci	886	/^HTTP\/0*([0-9\.]+) \s+ ([0-9]{3}) (?: \s+ ([^\012]*) )? \012/gxci
689	or return (%state = (), $cb->(undef, { @pseudo, Status => 599, Reason => "Invalid server response" }));	887	or return _error %state, $cb, { @pseudo, Status => 599, Reason => "Invalid server response" };
690		888
691	# 100 Continue handling	889	# 100 Continue handling
692	# should not happen as we don't send expect: 100-continue,	890	# should not happen as we don't send expect: 100-continue,
693	# but we handle it just in case.	891	# but we handle it just in case.
694	# since we send the request body regardless, if we get an error	892	# since we send the request body regardless, if we get an error
695	# we are out of-sync, which we currently do NOT handle correctly.	893	# we are out of-sync, which we currently do NOT handle correctly.
696	return $state{handle}->push_read (line => $qr_nlnl, $state{read_response})	894	return $state{handle}->push_read (line => $qr_nlnl, $state{read_response})
697	if $2 eq 100;	895	if $2 eq 100;
698		896
699	push @pseudo,	897	push @pseudo,
700	HTTPVersion => $1,	898	HTTPVersion => $1,
701	Status => $2,	899	Status => $2,
702	Reason => $3,	900	Reason => $3,
703	;	901	;
704		902
705	my $hdr = parse_hdr	903	my $hdr = _parse_hdr
706	or return (%state = (), $cb->(undef, { @pseudo, Status => 599, Reason => "Garbled response headers" }));	904	or return _error %state, $cb, { @pseudo, Status => 599, Reason => "Garbled response headers" };
707		905
708	%hdr = (%$hdr, @pseudo);	906	%hdr = (%$hdr, @pseudo);
709	}	907	}
710		908
711	# redirect handling	909	# redirect handling
712	# microsoft and other shitheads don't give a shit for following standards,	910	# relative uri handling forced by microsoft and other shitheads.
713	# try to support some common forms of broken Location headers.	911	# we give our best and fall back to URI if available.
		912	if (exists $hdr{location}) {
		913	my $loc = $hdr{location};
		914
		915	if ($loc =~ m%^//%) { # //
		916	$loc = "$uscheme:$loc";
		917
		918	} elsif ($loc eq "") {
		919	$loc = $url;
		920
714	if ($hdr{location} !~ /^(?: $ | [^:\/?\#]+ : )/x) {	921	} elsif ($loc !~ /^(?: $ | [^:\/?\#]+ : )/x) { # anything "simple"
715	$hdr{location} =~ s/^\.\/+//;	922	$loc =~ s/^\.\/+//;
716		923
717	my $url = "$rscheme://$uhost:$uport";	924	if ($loc !~ m%^[.?#]%) {
		925	my $prefix = "$uscheme://$uauthority";
718		926
719	unless ($hdr{location} =~ s/^\///) {	927	unless ($loc =~ s/^\///) {
720	$url .= $upath;	928	$prefix .= $upath;
721	$url =~ s/\/[^\/]*$//;	929	$prefix =~ s/\/[^\/]*$//;
722	}	930	}
723		931
724	$hdr{location} = "$url/$hdr{location}";	932	$loc = "$prefix/$loc";
725	}
726		933
727	my $redirect;	934	} elsif (eval { require URI }) { # uri
		935	$loc = URI->new_abs ($loc, $url)->as_string;
728		936
729	if ($recurse) {	937	} else {
730	my $status = $hdr{Status};	938	return _error %state, $cb, { @pseudo, Status => 599, Reason => "Cannot parse Location (URI module missing)" };
731		939	#$hdr{Status} = 599;
732	# industry standard is to redirect POST as GET for	940	#$hdr{Reason} = "Unparsable Redirect (URI module missing)";
733	# 301, 302 and 303, in contrast to HTTP/1.0 and 1.1.
734	# also, the UA should ask the user for 301 and 307 and POST,
735	# industry standard seems to be to simply follow.
736	# we go with the industry standard.
737	if ($status == 301 or $status == 302 or $status == 303) {
738	# HTTP/1.1 is unclear on how to mutate the method
739	$method = "GET" unless $method eq "HEAD";
740	$redirect = 1;	941	#$recurse = 0;
741	} elsif ($status == 307) {
742	$redirect = 1;
743	}	942	}
744	}	943	}
745		944
746	my $finish = sub { # ($data, $err_status, $err_reason[, $keepalive])	945	$hdr{location} = $loc;
747	my $may_keep_alive = $_[3];	946	}
748		947
749	$state{handle}->destroy if $state{handle};	948	my $redirect;
750	%state = ();
751		949
752	if (defined $_[1]) {	950	if ($recurse) {
753	$hdr{OrigStatus} = $hdr{Status}; $hdr{Status} = $_[1];	951	my $status = $hdr{Status};
754	$hdr{OrigReason} = $hdr{Reason}; $hdr{Reason} = $_[2];	952
		953	# industry standard is to redirect POST as GET for
		954	# 301, 302 and 303, in contrast to HTTP/1.0 and 1.1.
		955	# also, the UA should ask the user for 301 and 307 and POST,
		956	# industry standard seems to be to simply follow.
		957	# we go with the industry standard. 308 is defined
		958	# by rfc7538
		959	if ($status == 301 or $status == 302 or $status == 303) {
		960	$redirect = 1;
		961	# HTTP/1.1 is unclear on how to mutate the method
		962	unless ($method eq "HEAD") {
		963	$method = "GET";
		964	delete $arg{body};
755	}	965	}
		966	} elsif ($status == 307 or $status == 308) {
		967	$redirect = 1;
		968	}
		969	}
756		970
757	# set-cookie processing	971	my $finish = sub { # ($data, $err_status, $err_reason[, $persistent])
758	if ($arg{cookie_jar}) {	972	if ($state{handle}) {
759	cookie_jar_set_cookie $arg{cookie_jar}, $hdr{"set-cookie"}, $uhost, $hdr{date};	973	# handle keepalive
		974	if (
		975	$persistent
		976	&& $_[3]
		977	&& ($hdr{HTTPVersion} < 1.1
		978	? $hdr{connection} =~ /\bkeep-?alive\b/i
		979	: $hdr{connection} !~ /\bclose\b/i)
		980	) {
		981	ka_store $ka_key, delete $state{handle};
		982	} else {
		983	# no keepalive, destroy the handle
		984	$state{handle}->destroy;
760	}	985	}
		986	}
761		987
		988	%state = ();
		989
		990	if (defined $_[1]) {
		991	$hdr{OrigStatus} = $hdr{Status}; $hdr{Status} = $_[1];
		992	$hdr{OrigReason} = $hdr{Reason}; $hdr{Reason} = $_[2];
		993	}
		994
		995	# set-cookie processing
		996	if ($arg{cookie_jar}) {
		997	cookie_jar_set_cookie $arg{cookie_jar}, $hdr{"set-cookie"}, $uhost, $hdr{date};
		998	}
		999
762	if ($redirect && exists $hdr{location}) {	1000	if ($redirect && exists $hdr{location}) {
763	# we ignore any errors, as it is very common to receive	1001	# we ignore any errors, as it is very common to receive
764	# Content-Length != 0 but no actual body	1002	# Content-Length != 0 but no actual body
765	# we also access %hdr, as $_[1] might be an erro	1003	# we also access %hdr, as $_[1] might be an erro
		1004	$state{recurse} =
766	http_request (	1005	http_request (
767	$method => $hdr{location},	1006	$method => $hdr{location},
768	%arg,	1007	%arg,
769	recurse => $recurse - 1,	1008	recurse => $recurse - 1,
770	Redirect => [$_[0], \%hdr],	1009	Redirect => [$_[0], \%hdr],
		1010	sub {
		1011	%state = ();
		1012	&$cb
		1013	},
		1014	);
		1015	} else {
		1016	$cb->($_[0], \%hdr);
		1017	}
		1018	};
		1019
		1020	$ae_error = 597; # body phase
		1021
		1022	my $chunked = $hdr{"transfer-encoding"} =~ /\bchunked\b/i; # not quite correct...
		1023
		1024	my $len = $chunked ? undef : $hdr{"content-length"};
		1025
		1026	# body handling, many different code paths
		1027	# - no body expected
		1028	# - want_body_handle
		1029	# - te chunked
		1030	# - 2x length known (with or without on_body)
		1031	# - 2x length not known (with or without on_body)
		1032	if (!$redirect && $arg{on_header} && !$arg{on_header}(\%hdr)) {
		1033	$finish->(undef, 598 => "Request cancelled by on_header");
		1034	} elsif (
		1035	$hdr{Status} =~ /^(?:1..|204|205|304)$/
		1036	or $method eq "HEAD"
		1037	or (defined $len && $len == 0) # == 0, not !, because "0 " is true
		1038	) {
		1039	# no body
		1040	$finish->("", undef, undef, 1);
		1041
		1042	} elsif (!$redirect && $arg{want_body_handle}) {
		1043	$_[0]->on_eof (undef);
		1044	$_[0]->on_error (undef);
		1045	$_[0]->on_read (undef);
		1046
		1047	$finish->(delete $state{handle});
		1048
		1049	} elsif ($chunked) {
		1050	my $cl = 0;
		1051	my $body = "";
		1052	my $on_body = (!$redirect && $arg{on_body}) || sub { $body .= shift; 1 };
		1053
		1054	$state{read_chunk} = sub {
		1055	$_[1] =~ /^([0-9a-fA-F]+)/
		1056	or return $finish->(undef, $ae_error => "Garbled chunked transfer encoding");
		1057
		1058	my $len = hex $1;
		1059
		1060	if ($len) {
		1061	$cl += $len;
		1062
		1063	$_[0]->push_read (chunk => $len, sub {
		1064	$on_body->($_[1], \%hdr)
		1065	or return $finish->(undef, 598 => "Request cancelled by on_body");
		1066
		1067	$_[0]->push_read (line => sub {
		1068	length $_[1]
		1069	and return $finish->(undef, $ae_error => "Garbled chunked transfer encoding");
		1070	$_[0]->push_read (line => $state{read_chunk});
771	$cb);	1071	});
		1072	});
772	} else {	1073	} else {
773	$cb->($_[0], \%hdr);	1074	$hdr{"content-length"} ||= $cl;
		1075
		1076	$_[0]->push_read (line => $qr_nlnl, sub {
		1077	if (length $_[1]) {
		1078	for ("$_[1]") {
		1079	y/\015//d; # weed out any \015, as they show up in the weirdest of places.
		1080
		1081	my $hdr = _parse_hdr
		1082	or return $finish->(undef, $ae_error => "Garbled response trailers");
		1083
		1084	%hdr = (%hdr, %$hdr);
		1085	}
		1086	}
		1087
		1088	$finish->($body, undef, undef, 1);
		1089	});
774	}	1090	}
775	};	1091	};
776		1092
777	$ae_error = 597; # body phase	1093	$_[0]->push_read (line => $state{read_chunk});
778		1094
779	my $len = $hdr{"content-length"};	1095	} elsif (!$redirect && $arg{on_body}) {
		1096	if (defined $len) {
		1097	$_[0]->on_read (sub {
		1098	$len -= length $_[0]{rbuf};
780		1099
781	if (!$redirect && $arg{on_header} && !$arg{on_header}(\%hdr)) {	1100	$arg{on_body}(delete $_[0]{rbuf}, \%hdr)
782	$finish->(undef, 598 => "Request cancelled by on_header");	1101	or return $finish->(undef, 598 => "Request cancelled by on_body");
783	} elsif (	1102
784	$hdr{Status} =~ /^(?:1..|204|205|304)$/	1103	$len > 0
785	or $method eq "HEAD"
786	or (defined $len && !$len)
787	) {
788	# no body
789	$finish->("", undef, undef, 1);	1104	or $finish->("", undef, undef, 1);
		1105	});
790	} else {	1106	} else {
791	# body handling, many different code paths
792	# - no body expected
793	# - want_body_handle
794	# - te chunked
795	# - 2x length known (with or without on_body)
796	# - 2x length not known (with or without on_body)
797	if (!$redirect && $arg{want_body_handle}) {
798	$_[0]->on_eof (undef);	1107	$_[0]->on_eof (sub {
799	$_[0]->on_error (undef);	1108	$finish->("");
800	$_[0]->on_read (undef);
801
802	$finish->(delete $state{handle});
803
804	} elsif ($hdr{"transfer-encoding"} =~ /\bchunked\b/i) {
805	my $cl = 0;
806	my $body = undef;
807	my $on_body = $arg{on_body} || sub { $body .= shift; 1 };
808
809	$state{read_chunk} = sub {
810	$_[1] =~ /^([0-9a-fA-F]+)/
811	or $finish->(undef, $ae_error => "Garbled chunked transfer encoding");
812
813	my $len = hex $1;
814
815	if ($len) {
816	$cl += $len;
817
818	$_[0]->push_read (chunk => $len, sub {
819	$on_body->($_[1], \%hdr)
820	or return $finish->(undef, 598 => "Request cancelled by on_body");
821
822	$_[0]->push_read (line => sub {
823	length $_[1]
824	and return $finish->(undef, $ae_error => "Garbled chunked transfer encoding");
825	$_[0]->push_read (line => $state{read_chunk});
826	});
827	});
828	} else {
829	$hdr{"content-length"} ||= $cl;
830
831	$_[0]->push_read (line => $qr_nlnl, sub {
832	if (length $_[1]) {
833	for ("$_[1]") {
834	y/\015//d; # weed out any \015, as they show up in the weirdest of places.
835
836	my $hdr = parse_hdr
837	or return $finish->(undef, $ae_error => "Garbled response trailers");
838
839	%hdr = (%hdr, %$hdr);
840	}
841	}
842
843	$finish->($body, undef, undef, 1);
844	});
845	}
846	};	1109	});
847
848	$_[0]->push_read (line => $state{read_chunk});
849
850	} elsif ($arg{on_body}) {
851	if ($len) {
852	$_[0]->on_read (sub {	1110	$_[0]->on_read (sub {
853	$len -= length $_[0]{rbuf};
854
855	$arg{on_body}(delete $_[0]{rbuf}, \%hdr)	1111	$arg{on_body}(delete $_[0]{rbuf}, \%hdr)
856	or return $finish->(undef, 598 => "Request cancelled by on_body");
857
858	$len > 0
859	or $finish->("", undef, undef, 1);
860	});
861	} else {
862	$_[0]->on_eof (sub {
863	$finish->("");
864	});
865	$_[0]->on_read (sub {
866	$arg{on_body}(delete $_[0]{rbuf}, \%hdr)
867	or $finish->(undef, 598 => "Request cancelled by on_body");	1112	or $finish->(undef, 598 => "Request cancelled by on_body");
868	});
869	}
870	} else {
871	$_[0]->on_eof (undef);
872
873	if ($len) {
874	$_[0]->on_read (sub {
875	$finish->((substr delete $_[0]{rbuf}, 0, $len, ""), undef, undef, 1)
876	if $len <= length $_[0]{rbuf};
877	});
878	} else {
879	$_[0]->on_error (sub {
880	($! == Errno::EPIPE || !$!)
881	? $finish->(delete $_[0]{rbuf})
882	: $finish->(undef, $ae_error => $_[2]);
883	});
884	$_[0]->on_read (sub { });
885	}
886	}	1113	});
887	}	1114	}
888	};
889
890	$state{handle}->push_read (line => $qr_nlnl, $state{read_response});
891	};
892
893	my $connect_cb = sub {
894	$state{fh} = shift
895	or do {
896	my $err = "$!";
897	%state = ();
898	return $cb->(undef, { @pseudo, Status => $ae_error, Reason => $err });
899	};
900
901	return unless delete $state{connect_guard};
902
903	# get handle
904	$state{handle} = new AnyEvent::Handle
905	fh => $state{fh},
906	peername => $rhost,
907	tls_ctx => $arg{tls_ctx},
908	# these need to be reconfigured on keepalive handles
909	timeout => $timeout,
910	on_error => sub {
911	%state = ();
912	$cb->(undef, { @pseudo, Status => $ae_error, Reason => $_[2] });
913	},
914	on_eof => sub {
915	%state = ();
916	$cb->(undef, { @pseudo, Status => $ae_error, Reason => "Unexpected end-of-file" });
917	},
918	;
919
920	# limit the number of persistent connections
921	# keepalive not yet supported
922	# if ($KA_COUNT{$_[1]} < $MAX_PERSISTENT_PER_HOST) {
923	# ++$KA_COUNT{$_[1]};
924	# $state{handle}{ka_count_guard} = AnyEvent::Util::guard {
925	# --$KA_COUNT{$_[1]}
926	# };
927	# $hdr{connection} = "keep-alive";
928	# }
929
930	$state{handle}->starttls ("connect") if $rscheme eq "https";
931
932	# now handle proxy-CONNECT method
933	if ($proxy && $uscheme eq "https") {
934	# oh dear, we have to wrap it into a connect request
935
936	# maybe re-use $uauthority with patched port?
937	$state{handle}->push_write ("CONNECT $uhost:$uport HTTP/1.0\015\012Host: $uhost\015\012\015\012");
938	$state{handle}->push_read (line => $qr_nlnl, sub {
939	$_[1] =~ /^HTTP\/([0-9\.]+) \s+ ([0-9]{3}) (?: \s+ ([^\015\012]*) )?/ix
940	or return (%state = (), $cb->(undef, { @pseudo, Status => 599, Reason => "Invalid proxy connect response ($_[1])" }));
941
942	if ($2 == 200) {
943	$rpath = $upath;
944	$handle_actual_request->();
945	} else {
946	%state = ();
947	$cb->(undef, { @pseudo, Status => $2, Reason => $3 });
948	}
949	});
950	} else {	1115	} else {
951	$handle_actual_request->();	1116	$_[0]->on_eof (undef);
		1117
		1118	if (defined $len) {
		1119	$_[0]->on_read (sub {
		1120	$finish->((substr delete $_[0]{rbuf}, 0, $len, ""), undef, undef, 1)
		1121	if $len <= length $_[0]{rbuf};
		1122	});
		1123	} else {
		1124	$_[0]->on_error (sub {
		1125	($! == Errno::EPIPE || !$!)
		1126	? $finish->(delete $_[0]{rbuf})
		1127	: $finish->(undef, $ae_error => $_[2]);
		1128	});
		1129	$_[0]->on_read (sub { });
		1130	}
952	}	1131	}
953	};	1132	};
954		1133
955	my $tcp_connect = $arg{tcp_connect}	1134	# if keepalive is enabled, then the server closing the connection
956	|| do { require AnyEvent::Socket; \&AnyEvent::Socket::tcp_connect };	1135	# before a response can happen legally - we retry on idempotent methods.
		1136	if ($was_persistent && $idempotent) {
		1137	my $old_eof = $hdl->{on_eof};
		1138	$hdl->{on_eof} = sub {
		1139	_destroy_state %state;
957		1140
958	$state{connect_guard} = $tcp_connect->($rhost, $rport, $connect_cb, $arg{on_prepare} || sub { $timeout });	1141	%state = ();
		1142	$state{recurse} =
		1143	http_request (
		1144	$method => $url,
		1145	%arg,
		1146	recurse => $recurse - 1,
		1147	persistent => 0,
		1148	sub {
		1149	%state = ();
		1150	&$cb
		1151	}
		1152	);
		1153	};
		1154	$hdl->on_read (sub {
		1155	return unless %state;
		1156
		1157	# as soon as we receive something, a connection close
		1158	# once more becomes a hard error
		1159	$hdl->{on_eof} = $old_eof;
		1160	$hdl->push_read (line => $qr_nlnl, $state{read_response});
		1161	});
		1162	} else {
		1163	$hdl->push_read (line => $qr_nlnl, $state{read_response});
		1164	}
959	};	1165	};
960		1166
		1167	my $prepare_handle = sub {
		1168	my ($hdl) = $state{handle};
		1169
		1170	$hdl->on_error (sub {
		1171	_error %state, $cb, { @pseudo, Status => $ae_error, Reason => $_[2] };
		1172	});
		1173	$hdl->on_eof (sub {
		1174	_error %state, $cb, { @pseudo, Status => $ae_error, Reason => "Unexpected end-of-file" };
		1175	});
		1176	$hdl->timeout_reset;
		1177	$hdl->timeout ($timeout);
		1178	};
		1179
		1180	# connected to proxy (or origin server)
		1181	my $connect_cb = sub {
		1182	my $fh = shift
		1183	or return _error %state, $cb, { @pseudo, Status => $ae_error, Reason => "$!" };
		1184
		1185	return unless delete $state{connect_guard};
		1186
		1187	# get handle
		1188	$state{handle} = new AnyEvent::Handle
		1189	%{ $arg{handle_params} },
		1190	fh => $fh,
		1191	peername => $uhost,
		1192	tls_ctx => $arg{tls_ctx},
		1193	;
		1194
		1195	$prepare_handle->();
		1196
		1197	#$state{handle}->starttls ("connect") if $rscheme eq "https";
		1198
		1199	# now handle proxy-CONNECT method
		1200	if ($proxy && $uscheme eq "https") {
		1201	# oh dear, we have to wrap it into a connect request
		1202
		1203	my $auth = exists $hdr{"proxy-authorization"}
		1204	? "proxy-authorization: " . (delete $hdr{"proxy-authorization"}) . "\015\012"
		1205	: "";
		1206
		1207	# maybe re-use $uauthority with patched port?
		1208	$state{handle}->push_write ("CONNECT $uhost:$uport HTTP/1.0\015\012$auth\015\012");
		1209	$state{handle}->push_read (line => $qr_nlnl, sub {
		1210	$_[1] =~ /^HTTP\/([0-9\.]+) \s+ ([0-9]{3}) (?: \s+ ([^\015\012]*) )?/ix
		1211	or return _error %state, $cb, { @pseudo, Status => 599, Reason => "Invalid proxy connect response ($_[1])" };
		1212
		1213	if ($2 == 200) {
		1214	$rpath = $upath;
		1215	$handle_actual_request->();
		1216	} else {
		1217	_error %state, $cb, { @pseudo, Status => $2, Reason => $3 };
		1218	}
		1219	});
		1220	} else {
		1221	delete $hdr{"proxy-authorization"} unless $proxy;
		1222
		1223	$handle_actual_request->();
		1224	}
		1225	};
		1226
		1227	_get_slot $uhost, sub {
		1228	$state{slot_guard} = shift;
		1229
		1230	return unless $state{connect_guard};
		1231
		1232	# try to use an existing keepalive connection, but only if we, ourselves, plan
		1233	# on a keepalive request (in theory, this should be a separate config option).
		1234	if ($persistent && $KA_CACHE{$ka_key}) {
		1235	$was_persistent = 1;
		1236
		1237	$state{handle} = ka_fetch $ka_key;
		1238	# $state{handle}->destroyed
		1239	# and die "AnyEvent::HTTP: unexpectedly got a destructed handle (1), please report.";#d#
		1240	$prepare_handle->();
		1241	# $state{handle}->destroyed
		1242	# and die "AnyEvent::HTTP: unexpectedly got a destructed handle (2), please report.";#d#
		1243	$rpath = $upath;
		1244	$handle_actual_request->();
		1245
		1246	} else {
		1247	my $tcp_connect = $arg{tcp_connect}
		1248	|| do { require AnyEvent::Socket; \&AnyEvent::Socket::tcp_connect };
		1249
		1250	$state{connect_guard} = $tcp_connect->($rhost, $rport, $connect_cb, $arg{on_prepare} || sub { $timeout });
		1251	}
		1252	};
		1253
961	defined wantarray && AnyEvent::Util::guard { %state = () }	1254	defined wantarray && AnyEvent::Util::guard { _destroy_state %state }
962	}	1255	}
963		1256
964	sub http_get($@) {	1257	sub http_get($@) {
965	unshift @_, "GET";	1258	unshift @_, "GET";
966	&http_request	1259	&http_request
…		…
984	AnyEvent::HTTP uses the AnyEvent::Socket::tcp_connect function for	1277	AnyEvent::HTTP uses the AnyEvent::Socket::tcp_connect function for
985	the actual connection, which in turn uses AnyEvent::DNS to resolve	1278	the actual connection, which in turn uses AnyEvent::DNS to resolve
986	hostnames. The latter is a simple stub resolver and does no caching	1279	hostnames. The latter is a simple stub resolver and does no caching
987	on its own. If you want DNS caching, you currently have to provide	1280	on its own. If you want DNS caching, you currently have to provide
988	your own default resolver (by storing a suitable resolver object in	1281	your own default resolver (by storing a suitable resolver object in
989	C<$AnyEvent::DNS::RESOLVER>).	1282	C<$AnyEvent::DNS::RESOLVER>) or your own C<tcp_connect> callback.
990		1283
991	=head2 GLOBAL FUNCTIONS AND VARIABLES	1284	=head2 GLOBAL FUNCTIONS AND VARIABLES
992		1285
993	=over 4	1286	=over 4
994		1287
995	=item AnyEvent::HTTP::set_proxy "proxy-url"	1288	=item AnyEvent::HTTP::set_proxy "proxy-url"
996		1289
997	Sets the default proxy server to use. The proxy-url must begin with a	1290	Sets the default proxy server to use. The proxy-url must begin with a
998	string of the form C<http://host:port> (optionally C<https:...>), croaks	1291	string of the form C<http://host:port>, croaks otherwise.
999	otherwise.
1000		1292
1001	To clear an already-set proxy, use C<undef>.	1293	To clear an already-set proxy, use C<undef>.
		1294
		1295	When AnyEvent::HTTP is loaded for the first time it will query the
		1296	default proxy from the operating system, currently by looking at
		1297	C<$ENV{http_proxy>}.
1002		1298
1003	=item AnyEvent::HTTP::cookie_jar_expire $jar[, $session_end]	1299	=item AnyEvent::HTTP::cookie_jar_expire $jar[, $session_end]
1004		1300
1005	Remove all cookies from the cookie jar that have been expired. If	1301	Remove all cookies from the cookie jar that have been expired. If
1006	C<$session_end> is given and true, then additionally remove all session	1302	C<$session_end> is given and true, then additionally remove all session
1007	cookies.	1303	cookies.
1008		1304
1009	You should call this function (with a true C<$session_end>) before you	1305	You should call this function (with a true C<$session_end>) before you
1010	save cookies to disk, and you should call this function after loading them	1306	save cookies to disk, and you should call this function after loading them
1011	again. If you have a long-running program you can additonally call this	1307	again. If you have a long-running program you can additionally call this
1012	function from time to time.	1308	function from time to time.
1013		1309
1014	A cookie jar is initially an empty hash-reference that is managed by this	1310	A cookie jar is initially an empty hash-reference that is managed by this
1015	module. It's format is subject to change, but currently it is like this:	1311	module. Its format is subject to change, but currently it is as follows:
1016		1312
1017	The key C<version> has to contain C<1>, otherwise the hash gets	1313	The key C<version> has to contain C<2>, otherwise the hash gets
1018	emptied. All other keys are hostnames or IP addresses pointing to	1314	cleared. All other keys are hostnames or IP addresses pointing to
1019	hash-references. The key for these inner hash references is the	1315	hash-references. The key for these inner hash references is the
1020	server path for which this cookie is meant, and the values are again	1316	server path for which this cookie is meant, and the values are again
1021	hash-references. The keys of those hash-references is the cookie name, and	1317	hash-references. Each key of those hash-references is a cookie name, and
1022	the value, you guessed it, is another hash-reference, this time with the	1318	the value, you guessed it, is another hash-reference, this time with the
1023	key-value pairs from the cookie, except for C<expires> and C<max-age>,	1319	key-value pairs from the cookie, except for C<expires> and C<max-age>,
1024	which have been replaced by a C<_expires> key that contains the cookie	1320	which have been replaced by a C<_expires> key that contains the cookie
1025	expiry timestamp.	1321	expiry timestamp. Session cookies are indicated by not having an
		1322	C<_expires> key.
1026		1323
1027	Here is an example of a cookie jar with a single cookie, so you have a	1324	Here is an example of a cookie jar with a single cookie, so you have a
1028	chance of understanding the above paragraph:	1325	chance of understanding the above paragraph:
1029		1326
1030	{	1327	{
1031	version => 1,	1328	version => 2,
1032	"10.0.0.1" => {	1329	"10.0.0.1" => {
1033	"/" => {	1330	"/" => {
1034	"mythweb_id" => {	1331	"mythweb_id" => {
1035	_expires => 1293917923,	1332	_expires => 1293917923,
1036	value => "ooRung9dThee3ooyXooM1Ohm",	1333	value => "ooRung9dThee3ooyXooM1Ohm",
…		…
1052		1349
1053	=item $AnyEvent::HTTP::MAX_RECURSE	1350	=item $AnyEvent::HTTP::MAX_RECURSE
1054		1351
1055	The default value for the C<recurse> request parameter (default: C<10>).	1352	The default value for the C<recurse> request parameter (default: C<10>).
1056		1353
		1354	=item $AnyEvent::HTTP::TIMEOUT
		1355
		1356	The default timeout for connection operations (default: C<300>).
		1357
1057	=item $AnyEvent::HTTP::USERAGENT	1358	=item $AnyEvent::HTTP::USERAGENT
1058		1359
1059	The default value for the C<User-Agent> header (the default is	1360	The default value for the C<User-Agent> header (the default is
1060	C<Mozilla/5.0 (compatible; U; AnyEvent-HTTP/$VERSION; +http://software.schmorp.de/pkg/AnyEvent)>).	1361	C<Mozilla/5.0 (compatible; U; AnyEvent-HTTP/$VERSION; +http://software.schmorp.de/pkg/AnyEvent)>).
1061		1362
1062	=item $AnyEvent::HTTP::MAX_PER_HOST	1363	=item $AnyEvent::HTTP::MAX_PER_HOST
1063		1364
1064	The maximum number of concurrent connections to the same host (identified	1365	The maximum number of concurrent connections to the same host (identified
1065	by the hostname). If the limit is exceeded, then the additional requests	1366	by the hostname). If the limit is exceeded, then additional requests
1066	are queued until previous connections are closed.	1367	are queued until previous connections are closed. Both persistent and
		1368	non-persistent connections are counted in this limit.
1067		1369
1068	The default value for this is C<4>, and it is highly advisable to not	1370	The default value for this is C<4>, and it is highly advisable to not
1069	increase it.	1371	increase it much.
		1372
		1373	For comparison: the RFC's recommend 4 non-persistent or 2 persistent
		1374	connections, older browsers used 2, newer ones (such as firefox 3)
		1375	typically use 6, and Opera uses 8 because like, they have the fastest
		1376	browser and give a shit for everybody else on the planet.
		1377
		1378	=item $AnyEvent::HTTP::PERSISTENT_TIMEOUT
		1379
		1380	The time after which idle persistent connections get closed by
		1381	AnyEvent::HTTP (default: C<3>).
1070		1382
1071	=item $AnyEvent::HTTP::ACTIVE	1383	=item $AnyEvent::HTTP::ACTIVE
1072		1384
1073	The number of active connections. This is not the number of currently	1385	The number of active connections. This is not the number of currently
1074	running requests, but the number of currently open and non-idle TCP	1386	running requests, but the number of currently open and non-idle TCP
1075	connections. This number of can be useful for load-leveling.	1387	connections. This number can be useful for load-leveling.
1076		1388
1077	=back	1389	=back
1078		1390
1079	=cut	1391	=cut
1080		1392
…		…
1114	# other formats fail in the loop below	1426	# other formats fail in the loop below
1115		1427
1116	for (0..11) {	1428	for (0..11) {
1117	if ($m eq $month[$_]) {	1429	if ($m eq $month[$_]) {
1118	require Time::Local;	1430	require Time::Local;
1119	return Time::Local::timegm ($S, $M, $H, $d, $_, $y);	1431	return eval { Time::Local::timegm ($S, $M, $H, $d, $_, $y) };
1120	}	1432	}
1121	}	1433	}
1122		1434
1123	undef	1435	undef
1124	}	1436	}
1125		1437
1126	sub set_proxy($) {	1438	sub set_proxy($) {
1127	if (length $_[0]) {	1439	if (length $_[0]) {
1128	$_[0] =~ m%^(https?):// ([^:/]+) (?: : (\d*) )?%ix	1440	$_[0] =~ m%^(http):// ([^:/]+) (?: : (\d*) )?%ix
1129	or Carp::croak "$_[0]: invalid proxy URL";	1441	or Carp::croak "$_[0]: invalid proxy URL";
1130	$PROXY = [$2, $3 || 3128, $1]	1442	$PROXY = [$2, $3 || 3128, $1]
1131	} else {	1443	} else {
1132	undef $PROXY;	1444	undef $PROXY;
1133	}	1445	}
…		…
1136	# initialise proxy from environment	1448	# initialise proxy from environment
1137	eval {	1449	eval {
1138	set_proxy $ENV{http_proxy};	1450	set_proxy $ENV{http_proxy};
1139	};	1451	};
1140		1452
		1453	=head2 SHOWCASE
		1454
		1455	This section contains some more elaborate "real-world" examples or code
		1456	snippets.
		1457
		1458	=head2 HTTP/1.1 FILE DOWNLOAD
		1459
		1460	Downloading files with HTTP can be quite tricky, especially when something
		1461	goes wrong and you want to resume.
		1462
		1463	Here is a function that initiates and resumes a download. It uses the
		1464	last modified time to check for file content changes, and works with many
		1465	HTTP/1.0 servers as well, and usually falls back to a complete re-download
		1466	on older servers.
		1467
		1468	It calls the completion callback with either C<undef>, which means a
		1469	nonretryable error occurred, C<0> when the download was partial and should
		1470	be retried, and C<1> if it was successful.
		1471
		1472	use AnyEvent::HTTP;
		1473
		1474	sub download($$$) {
		1475	my ($url, $file, $cb) = @_;
		1476
		1477	open my $fh, "+<", $file
		1478	or die "$file: $!";
		1479
		1480	my %hdr;
		1481	my $ofs = 0;
		1482
		1483	if (stat $fh and -s _) {
		1484	$ofs = -s _;
		1485	warn "-s is ", $ofs;
		1486	$hdr{"if-unmodified-since"} = AnyEvent::HTTP::format_date +(stat _)[9];
		1487	$hdr{"range"} = "bytes=$ofs-";
		1488	}
		1489
		1490	http_get $url,
		1491	headers => \%hdr,
		1492	on_header => sub {
		1493	my ($hdr) = @_;
		1494
		1495	if ($hdr->{Status} == 200 && $ofs) {
		1496	# resume failed
		1497	truncate $fh, $ofs = 0;
		1498	}
		1499
		1500	sysseek $fh, $ofs, 0;
		1501
		1502	1
		1503	},
		1504	on_body => sub {
		1505	my ($data, $hdr) = @_;
		1506
		1507	if ($hdr->{Status} =~ /^2/) {
		1508	length $data == syswrite $fh, $data
		1509	or return; # abort on write errors
		1510	}
		1511
		1512	1
		1513	},
		1514	sub {
		1515	my (undef, $hdr) = @_;
		1516
		1517	my $status = $hdr->{Status};
		1518
		1519	if (my $time = AnyEvent::HTTP::parse_date $hdr->{"last-modified"}) {
		1520	utime $time, $time, $fh;
		1521	}
		1522
		1523	if ($status == 200 || $status == 206 || $status == 416) {
		1524	# download ok || resume ok || file already fully downloaded
		1525	$cb->(1, $hdr);
		1526
		1527	} elsif ($status == 412) {
		1528	# file has changed while resuming, delete and retry
		1529	unlink $file;
		1530	$cb->(0, $hdr);
		1531
		1532	} elsif ($status == 500 or $status == 503 or $status =~ /^59/) {
		1533	# retry later
		1534	$cb->(0, $hdr);
		1535
		1536	} else {
		1537	$cb->(undef, $hdr);
		1538	}
		1539	}
		1540	;
		1541	}
		1542
		1543	download "http://server/somelargefile", "/tmp/somelargefile", sub {
		1544	if ($_[0]) {
		1545	print "OK!\n";
		1546	} elsif (defined $_[0]) {
		1547	print "please retry later\n";
		1548	} else {
		1549	print "ERROR\n";
		1550	}
		1551	};
		1552
1141	=head2 SOCKS PROXIES	1553	=head3 SOCKS PROXIES
1142		1554
1143	Socks proxies are not directly supported by AnyEvent::HTTP. You can	1555	Socks proxies are not directly supported by AnyEvent::HTTP. You can
1144	compile your perl to support socks, or use an external program such as	1556	compile your perl to support socks, or use an external program such as
1145	F<socksify> (dante) or F<tsocks> to make your program use a socks proxy	1557	F<socksify> (dante) or F<tsocks> to make your program use a socks proxy
1146	transparently.	1558	transparently.

Diff Legend

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