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

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

Diff Legend

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

Comparing AnyEvent-HTTP/HTTP.pm (file contents): Revision 1.90 by root, Mon Jan 3 00:41:25 2011 UTC vs. Revision 1.138 by root, Fri Aug 5 20:45:09 2022 UTC

Diff Legend

Comparing AnyEvent-HTTP/HTTP.pm (file contents):
Revision 1.90 by root, Mon Jan 3 00:41:25 2011 UTC vs.
Revision 1.138 by root, Fri Aug 5 20:45:09 2022 UTC