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

Comparing AnyEvent-HTTP/HTTP.pm (file contents):
Revision 1.91 by root, Mon Jan 3 01:03:29 2011 UTC vs.
Revision 1.140 by root, Wed Mar 6 19:29:18 2024 UTC

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

Diff Legend

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

Comparing AnyEvent-HTTP/HTTP.pm (file contents): Revision 1.91 by root, Mon Jan 3 01:03:29 2011 UTC vs. Revision 1.140 by root, Wed Mar 6 19:29:18 2024 UTC

Diff Legend

Comparing AnyEvent-HTTP/HTTP.pm (file contents):
Revision 1.91 by root, Mon Jan 3 01:03:29 2011 UTC vs.
Revision 1.140 by root, Wed Mar 6 19:29:18 2024 UTC