[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.139 by root, Fri Aug 5 20:48:14 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	PRI => 1,
		744	PROPFIND => 1,
		745	PROPPATCH => 1,
		746	REBIND => 1,
		747	REPORT => 1,
		748	SEARCH => 1,
		749	UNBIND => 1,
		750	UNCHECKOUT => 1,
		751	UNLINK => 1,
		752	UNLOCK => 1,
		753	UPDATE => 1,
		754	UPDATEREDIRECTREF => 1,
		755	"VERSION-CONTROL" => 1,
		756	);
574		757
575	sub http_request($$@) {	758	sub http_request($$@) {
576	my $cb = pop;	759	my $cb = pop;
577	my ($method, $url, %arg) = @_;	760	my ($method, $url, %arg) = @_;
578		761
…		…
596	my $recurse = exists $arg{recurse} ? delete $arg{recurse} : $MAX_RECURSE;	779	my $recurse = exists $arg{recurse} ? delete $arg{recurse} : $MAX_RECURSE;
597		780
598	return $cb->(undef, { @pseudo, Status => 599, Reason => "Too many redirections" })	781	return $cb->(undef, { @pseudo, Status => 599, Reason => "Too many redirections" })
599	if $recurse < 0;	782	if $recurse < 0;
600		783
601	my $proxy = $arg{proxy} \|\| $PROXY;	784	my $proxy = exists $arg{proxy} ? $arg{proxy} : $PROXY;
602	my $timeout = $arg{timeout} \|\| $TIMEOUT;	785	my $timeout = $arg{timeout} \|\| $TIMEOUT;
603		786
604	my ($uscheme, $uauthority, $upath, $query, $fragment) =	787	my ($uscheme, $uauthority, $upath, $query, undef) = # ignore fragment
605	$url =~ m\|(?:([^:/?#]+):)?(?://([^/?#]))?([^?#])(?:(\?[^#]))?(?:#(.))?\|;	788	$url =~ m\|^([^:]+):(?://([^/?#]))?([^?#])(?:(\?[^#]))?(?:#(.))?$\|;
606		789
607	$uscheme = lc $uscheme;	790	$uscheme = lc $uscheme;
608		791
609	my $uport = $uscheme eq "http" ? 80	792	my $uport = $uscheme eq "http" ? 80
610	: $uscheme eq "https" ? 443	793	: $uscheme eq "https" ? 443
611	: return $cb->(undef, { @pseudo, Status => 599, Reason => "Only http and https URL schemes supported" });	794	: return $cb->(undef, { @pseudo, Status => 599, Reason => "Only http and https URL schemes supported" });
612		795
613	$uauthority =~ /^(?: .*\@ )? ([^\@:]+) (?: : (\d+) )?$/x	796	$uauthority =~ /^(?: .*\@ )? ([^\@]+?) (?: : (\d+) )?$/x
614	or return $cb->(undef, { @pseudo, Status => 599, Reason => "Unparsable URL" });	797	or return $cb->(undef, { @pseudo, Status => 599, Reason => "Unparsable URL" });
615		798
616	my $uhost = lc $1;	799	my $uhost = lc $1;
617	$uport = $2 if defined $2;	800	$uport = $2 if defined $2;
618		801
…		…
654	$hdr{"user-agent"} = $USERAGENT unless exists $hdr{"user-agent"};	837	$hdr{"user-agent"} = $USERAGENT unless exists $hdr{"user-agent"};
655		838
656	$hdr{"content-length"} = length $arg{body}	839	$hdr{"content-length"} = length $arg{body}
657	if length $arg{body} \|\| $method ne "GET";	840	if length $arg{body} \|\| $method ne "GET";
658		841
659	my $idempotent = $method =~ /^(?:GET\|HEAD\|PUT\|DELETE\|OPTIONS\|TRACE)$/;	842	my $idempotent = $IDEMPOTENT{$method};
660		843
661	# default value for keepalive is true iff the request is for an idempotent method	844	# default value for keepalive is true iff the request is for an idempotent method
662	my $keepalive = exists $arg{keepalive}	845	my $persistent = exists $arg{persistent} ? !!$arg{persistent} : $idempotent;
663	? $arg{keepalive}*1	846	my $keepalive = exists $arg{keepalive} ? !!$arg{keepalive} : !$proxy;
664	: $idempotent ? $PERSISTENT_TIMEOUT : 0;	847	my $was_persistent; # true if this is actually a recycled connection
665		848
		849	# the key to use in the keepalive cache
		850	my $ka_key = "$uscheme\x00$uhost\x00$uport\x00$arg{sessionid}";
		851
666	$hdr{connection} = ($keepalive ? "" : "close ") . "Te"; #1.1	852	$hdr{connection} = ($persistent ? $keepalive ? "keep-alive, " : "" : "close, ") . "Te"; #1.1
667	$hdr{te} = "trailers" unless exists $hdr{te}; #1.1	853	$hdr{te} = "trailers" unless exists $hdr{te}; #1.1
668		854
669	my %state = (connect_guard => 1);	855	my %state = (connect_guard => 1);
670		856
671	my $ae_error = 595; # connecting	857	my $ae_error = 595; # connecting
672		858
673	# handle actual, non-tunneled, request	859	# handle actual, non-tunneled, request
674	my $handle_actual_request = sub {	860	my $handle_actual_request = sub {
675	$ae_error = 596; # request phase	861	$ae_error = 596; # request phase
676		862
		863	my $hdl = $state{handle};
		864
677	$state{handle}->starttls ("connect") if $uscheme eq "https" && !exists $state{handle}{tls};	865	$hdl->starttls ("connect") if $uscheme eq "https" && !exists $hdl->{tls};
678		866
679	# send request	867	# send request
680	$state{handle}->push_write (	868	$hdl->push_write (
681	"$method $rpath HTTP/1.1\015\012"	869	"$method $rpath HTTP/1.1\015\012"
682	. (join "", map "\u$_: $hdr{$_}\015\012", grep defined $hdr{$_}, keys %hdr)	870	. (join "", map "\u$_: $hdr{$_}\015\012", grep defined $hdr{$_}, keys %hdr)
683	. "\015\012"	871	. "\015\012"
684	. (delete $arg{body})	872	. $arg{body}
685	);	873	);
686		874
687	# return if error occured during push_write()	875	# return if error occurred during push_write()
688	return unless %state;	876	return unless %state;
689		877
690	# reduce memory usage, save a kitten, also re-use it for the response headers.	878	# reduce memory usage, save a kitten, also re-use it for the response headers.
691	%hdr = ();	879	%hdr = ();
692		880
693	# status line and headers	881	# status line and headers
694	$state{read_response} = sub {	882	$state{read_response} = sub {
		883	return unless %state;
		884
695	for ("$_[1]") {	885	for ("$_[1]") {
696	y/\015//d; # weed out any \015, as they show up in the weirdest of places.	886	y/\015//d; # weed out any \015, as they show up in the weirdest of places.
697		887
698	/^HTTP\/0([0-9\.]+) \s+ ([0-9]{3}) (?: \s+ ([^\012]) )? \012/gxci	888	/^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" }));	889	or return _error %state, $cb, { @pseudo, Status => 599, Reason => "Invalid server response" };
700		890
701	# 100 Continue handling	891	# 100 Continue handling
702	# should not happen as we don't send expect: 100-continue,	892	# should not happen as we don't send expect: 100-continue,
703	# but we handle it just in case.	893	# but we handle it just in case.
704	# since we send the request body regardless, if we get an error	894	# since we send the request body regardless, if we get an error
…		…
710	HTTPVersion => $1,	900	HTTPVersion => $1,
711	Status => $2,	901	Status => $2,
712	Reason => $3,	902	Reason => $3,
713	;	903	;
714		904
715	my $hdr = parse_hdr	905	my $hdr = _parse_hdr
716	or return (%state = (), $cb->(undef, { @pseudo, Status => 599, Reason => "Garbled response headers" }));	906	or return _error %state, $cb, { @pseudo, Status => 599, Reason => "Garbled response headers" };
717		907
718	%hdr = (%$hdr, @pseudo);	908	%hdr = (%$hdr, @pseudo);
719	}	909	}
720		910
721	# redirect handling	911	# redirect handling
722	# microsoft and other shitheads don't give a shit for following standards,	912	# relative uri handling forced by microsoft and other shitheads.
723	# try to support some common forms of broken Location headers.	913	# we give our best and fall back to URI if available.
724	if ($hdr{location} !~ /^(?: $ \| [^:\/?\#]+ : )/x) {	914	if (exists $hdr{location}) {
		915	my $loc = $hdr{location};
		916
		917	if ($loc =~ m%^//%) { # //
		918	$loc = "$uscheme:$loc";
		919
		920	} elsif ($loc eq "") {
		921	$loc = $url;
		922
		923	} elsif ($loc !~ /^(?: $ \| [^:\/?\#]+ : )/x) { # anything "simple"
725	$hdr{location} =~ s/^\.\/+//;	924	$loc =~ s/^\.\/+//;
726		925
727	my $url = "$rscheme://$uhost:$uport";	926	if ($loc !~ m%^[.?#]%) {
		927	my $prefix = "$uscheme://$uauthority";
728		928
729	unless ($hdr{location} =~ s/^\///) {	929	unless ($loc =~ s/^\///) {
730	$url .= $upath;	930	$prefix .= $upath;
731	$url =~ s/\/[^\/]*$//;	931	$prefix =~ s/\/[^\/]*$//;
		932	}
		933
		934	$loc = "$prefix/$loc";
		935
		936	} elsif (eval { require URI }) { # uri
		937	$loc = URI->new_abs ($loc, $url)->as_string;
		938
		939	} else {
		940	return _error %state, $cb, { @pseudo, Status => 599, Reason => "Cannot parse Location (URI module missing)" };
		941	#$hdr{Status} = 599;
		942	#$hdr{Reason} = "Unparsable Redirect (URI module missing)";
		943	#$recurse = 0;
		944	}
732	}	945	}
733		946
734	$hdr{location} = "$url/$hdr{location}";	947	$hdr{location} = $loc;
735	}	948	}
736		949
737	my $redirect;	950	my $redirect;
738		951
739	if ($recurse) {	952	if ($recurse) {
…		…
741		954
742	# industry standard is to redirect POST as GET for	955	# industry standard is to redirect POST as GET for
743	# 301, 302 and 303, in contrast to HTTP/1.0 and 1.1.	956	# 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,	957	# also, the UA should ask the user for 301 and 307 and POST,
745	# industry standard seems to be to simply follow.	958	# industry standard seems to be to simply follow.
746	# we go with the industry standard.	959	# we go with the industry standard. 308 is defined
		960	# by rfc7538
747	if ($status == 301 or $status == 302 or $status == 303) {	961	if ($status == 301 or $status == 302 or $status == 303) {
		962	$redirect = 1;
748	# HTTP/1.1 is unclear on how to mutate the method	963	# HTTP/1.1 is unclear on how to mutate the method
749	$method = "GET" unless $method eq "HEAD";	964	unless ($method eq "HEAD") {
750	$redirect = 1;	965	$method = "GET";
		966	delete $arg{body};
		967	}
751	} elsif ($status == 307) {	968	} elsif ($status == 307 or $status == 308) {
752	$redirect = 1;	969	$redirect = 1;
753	}	970	}
754	}	971	}
755		972
756	my $finish = sub { # ($data, $err_status, $err_reason[, $keepalive])	973	my $finish = sub { # ($data, $err_status, $err_reason[, $persistent])
757	my $may_keep_alive = $_[3];	974	if ($state{handle}) {
758		975	# handle keepalive
		976	if (
		977	$persistent
		978	&& $_[3]
		979	&& ($hdr{HTTPVersion} < 1.1
		980	? $hdr{connection} =~ /\bkeep-?alive\b/i
		981	: $hdr{connection} !~ /\bclose\b/i)
		982	) {
		983	ka_store $ka_key, delete $state{handle};
		984	} else {
		985	# no keepalive, destroy the handle
759	$state{handle}->destroy if $state{handle};	986	$state{handle}->destroy;
		987	}
		988	}
		989
760	%state = ();	990	%state = ();
761		991
762	if (defined $_[1]) {	992	if (defined $_[1]) {
763	$hdr{OrigStatus} = $hdr{Status}; $hdr{Status} = $_[1];	993	$hdr{OrigStatus} = $hdr{Status}; $hdr{Status} = $_[1];
764	$hdr{OrigReason} = $hdr{Reason}; $hdr{Reason} = $_[2];	994	$hdr{OrigReason} = $hdr{Reason}; $hdr{Reason} = $_[2];
…		…
771		1001
772	if ($redirect && exists $hdr{location}) {	1002	if ($redirect && exists $hdr{location}) {
773	# we ignore any errors, as it is very common to receive	1003	# we ignore any errors, as it is very common to receive
774	# Content-Length != 0 but no actual body	1004	# Content-Length != 0 but no actual body
775	# we also access %hdr, as $_[1] might be an erro	1005	# we also access %hdr, as $_[1] might be an erro
		1006	$state{recurse} =
776	http_request (	1007	http_request (
777	$method => $hdr{location},	1008	$method => $hdr{location},
778	%arg,	1009	%arg,
779	recurse => $recurse - 1,	1010	recurse => $recurse - 1,
780	Redirect => [$_[0], \%hdr],	1011	Redirect => [$_[0], \%hdr],
		1012	sub {
		1013	%state = ();
		1014	&$cb
		1015	},
781	$cb);	1016	);
782	} else {	1017	} else {
783	$cb->($_[0], \%hdr);	1018	$cb->($_[0], \%hdr);
784	}	1019	}
785	};	1020	};
786		1021
787	$ae_error = 597; # body phase	1022	$ae_error = 597; # body phase
788		1023
		1024	my $chunked = $hdr{"transfer-encoding"} =~ /\bchunked\b/i; # not quite correct...
		1025
789	my $len = $hdr{"content-length"};	1026	my $len = $chunked ? undef : $hdr{"content-length"};
790		1027
791	# body handling, many different code paths	1028	# body handling, many different code paths
792	# - no body expected	1029	# - no body expected
793	# - want_body_handle	1030	# - want_body_handle
794	# - te chunked	1031	# - te chunked
…		…
809	$_[0]->on_error (undef);	1046	$_[0]->on_error (undef);
810	$_[0]->on_read (undef);	1047	$_[0]->on_read (undef);
811		1048
812	$finish->(delete $state{handle});	1049	$finish->(delete $state{handle});
813		1050
814	} elsif ($hdr{"transfer-encoding"} =~ /\bchunked\b/i) {	1051	} elsif ($chunked) {
815	my $cl = 0;	1052	my $cl = 0;
816	my $body = undef;	1053	my $body = "";
817	my $on_body = $arg{on_body} \|\| sub { $body .= shift; 1 };	1054	my $on_body = (!$redirect && $arg{on_body}) \|\| sub { $body .= shift; 1 };
818		1055
819	$state{read_chunk} = sub {	1056	$state{read_chunk} = sub {
820	$_[1] =~ /^([0-9a-fA-F]+)/	1057	$_[1] =~ /^([0-9a-fA-F]+)/
821	or $finish->(undef, $ae_error => "Garbled chunked transfer encoding");	1058	or return $finish->(undef, $ae_error => "Garbled chunked transfer encoding");
822		1059
823	my $len = hex $1;	1060	my $len = hex $1;
824		1061
825	if ($len) {	1062	if ($len) {
826	$cl += $len;	1063	$cl += $len;
…		…
841	$_[0]->push_read (line => $qr_nlnl, sub {	1078	$_[0]->push_read (line => $qr_nlnl, sub {
842	if (length $_[1]) {	1079	if (length $_[1]) {
843	for ("$_[1]") {	1080	for ("$_[1]") {
844	y/\015//d; # weed out any \015, as they show up in the weirdest of places.	1081	y/\015//d; # weed out any \015, as they show up in the weirdest of places.
845		1082
846	my $hdr = parse_hdr	1083	my $hdr = _parse_hdr
847	or return $finish->(undef, $ae_error => "Garbled response trailers");	1084	or return $finish->(undef, $ae_error => "Garbled response trailers");
848		1085
849	%hdr = (%hdr, %$hdr);	1086	%hdr = (%hdr, %$hdr);
850	}	1087	}
851	}	1088	}
…		…
855	}	1092	}
856	};	1093	};
857		1094
858	$_[0]->push_read (line => $state{read_chunk});	1095	$_[0]->push_read (line => $state{read_chunk});
859		1096
860	} elsif ($arg{on_body}) {	1097	} elsif (!$redirect && $arg{on_body}) {
861	if (defined $len) {	1098	if (defined $len) {
862	$_[0]->on_read (sub {	1099	$_[0]->on_read (sub {
863	$len -= length $_[0]{rbuf};	1100	$len -= length $_[0]{rbuf};
864		1101
865	$arg{on_body}(delete $_[0]{rbuf}, \%hdr)	1102	$arg{on_body}(delete $_[0]{rbuf}, \%hdr)
…		…
894	$_[0]->on_read (sub { });	1131	$_[0]->on_read (sub { });
895	}	1132	}
896	}	1133	}
897	};	1134	};
898		1135
		1136	# if keepalive is enabled, then the server closing the connection
		1137	# before a response can happen legally - we retry on idempotent methods.
		1138	if ($was_persistent && $idempotent) {
		1139	my $old_eof = $hdl->{on_eof};
		1140	$hdl->{on_eof} = sub {
		1141	_destroy_state %state;
		1142
		1143	%state = ();
		1144	$state{recurse} =
		1145	http_request (
		1146	$method => $url,
		1147	%arg,
		1148	recurse => $recurse - 1,
		1149	persistent => 0,
		1150	sub {
		1151	%state = ();
		1152	&$cb
		1153	}
		1154	);
		1155	};
		1156	$hdl->on_read (sub {
		1157	return unless %state;
		1158
		1159	# as soon as we receive something, a connection close
		1160	# once more becomes a hard error
		1161	$hdl->{on_eof} = $old_eof;
		1162	$hdl->push_read (line => $qr_nlnl, $state{read_response});
		1163	});
		1164	} else {
899	$state{handle}->push_read (line => $qr_nlnl, $state{read_response});	1165	$hdl->push_read (line => $qr_nlnl, $state{read_response});
		1166	}
900	};	1167	};
901		1168
		1169	my $prepare_handle = sub {
		1170	my ($hdl) = $state{handle};
		1171
		1172	$hdl->on_error (sub {
		1173	_error %state, $cb, { @pseudo, Status => $ae_error, Reason => $_[2] };
		1174	});
		1175	$hdl->on_eof (sub {
		1176	_error %state, $cb, { @pseudo, Status => $ae_error, Reason => "Unexpected end-of-file" };
		1177	});
		1178	$hdl->timeout_reset;
		1179	$hdl->timeout ($timeout);
		1180	};
		1181
		1182	# connected to proxy (or origin server)
902	my $connect_cb = sub {	1183	my $connect_cb = sub {
903	$state{fh} = shift	1184	my $fh = shift
904	or do {
905	my $err = "$!";
906	%state = ();
907	return $cb->(undef, { @pseudo, Status => $ae_error, Reason => $err });	1185	or return _error %state, $cb, { @pseudo, Status => $ae_error, Reason => "$!" };
908	};
909		1186
910	return unless delete $state{connect_guard};	1187	return unless delete $state{connect_guard};
911		1188
912	# get handle	1189	# get handle
913	$state{handle} = new AnyEvent::Handle	1190	$state{handle} = new AnyEvent::Handle
		1191	%{ $arg{handle_params} },
914	fh => $state{fh},	1192	fh => $fh,
915	peername => $rhost,	1193	peername => $uhost,
916	tls_ctx => $arg{tls_ctx},	1194	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	;	1195	;
928		1196
929	# limit the number of persistent connections	1197	$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		1198
939	$state{handle}->starttls ("connect") if $rscheme eq "https";	1199	#$state{handle}->starttls ("connect") if $rscheme eq "https";
940		1200
941	# now handle proxy-CONNECT method	1201	# now handle proxy-CONNECT method
942	if ($proxy && $uscheme eq "https") {	1202	if ($proxy && $uscheme eq "https") {
943	# oh dear, we have to wrap it into a connect request	1203	# oh dear, we have to wrap it into a connect request
944		1204
		1205	my $auth = exists $hdr{"proxy-authorization"}
		1206	? "proxy-authorization: " . (delete $hdr{"proxy-authorization"}) . "\015\012"
		1207	: "";
		1208
945	# maybe re-use $uauthority with patched port?	1209	# maybe re-use $uauthority with patched port?
946	$state{handle}->push_write ("CONNECT $uhost:$uport HTTP/1.0\015\012\015\012");	1210	$state{handle}->push_write ("CONNECT $uhost:$uport HTTP/1.0\015\012$auth\015\012");
947	$state{handle}->push_read (line => $qr_nlnl, sub {	1211	$state{handle}->push_read (line => $qr_nlnl, sub {
948	$_[1] =~ /^HTTP\/([0-9\.]+) \s+ ([0-9]{3}) (?: \s+ ([^\015\012]*) )?/ix	1212	$_[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])" }));	1213	or return _error %state, $cb, { @pseudo, Status => 599, Reason => "Invalid proxy connect response ($_[1])" };
950		1214
951	if ($2 == 200) {	1215	if ($2 == 200) {
952	$rpath = $upath;	1216	$rpath = $upath;
953	$handle_actual_request->();	1217	$handle_actual_request->();
954	} else {	1218	} else {
955	%state = ();
956	$cb->(undef, { @pseudo, Status => $2, Reason => $3 });	1219	_error %state, $cb, { @pseudo, Status => $2, Reason => $3 };
957	}	1220	}
958	});	1221	});
959	} else {	1222	} else {
		1223	delete $hdr{"proxy-authorization"} unless $proxy;
		1224
960	$handle_actual_request->();	1225	$handle_actual_request->();
961	}	1226	}
962	};	1227	};
963		1228
964	_get_slot $uhost, sub {	1229	_get_slot $uhost, sub {
965	$state{slot_guard} = shift;	1230	$state{slot_guard} = shift;
966		1231
967	return unless $state{connect_guard};	1232	return unless $state{connect_guard};
968		1233
		1234	# try to use an existing keepalive connection, but only if we, ourselves, plan
		1235	# on a keepalive request (in theory, this should be a separate config option).
		1236	if ($persistent && $KA_CACHE{$ka_key}) {
		1237	$was_persistent = 1;
		1238
		1239	$state{handle} = ka_fetch $ka_key;
		1240	# $state{handle}->destroyed
		1241	# and die "AnyEvent::HTTP: unexpectedly got a destructed handle (1), please report.";#d#
		1242	$prepare_handle->();
		1243	# $state{handle}->destroyed
		1244	# and die "AnyEvent::HTTP: unexpectedly got a destructed handle (2), please report.";#d#
		1245	$rpath = $upath;
		1246	$handle_actual_request->();
		1247
		1248	} else {
969	my $tcp_connect = $arg{tcp_connect}	1249	my $tcp_connect = $arg{tcp_connect}
970	\|\| do { require AnyEvent::Socket; \&AnyEvent::Socket::tcp_connect };	1250	\|\| do { require AnyEvent::Socket; \&AnyEvent::Socket::tcp_connect };
971		1251
972	$state{connect_guard} = $tcp_connect->($rhost, $rport, $connect_cb, $arg{on_prepare} \|\| sub { $timeout });	1252	$state{connect_guard} = $tcp_connect->($rhost, $rport, $connect_cb, $arg{on_prepare} \|\| sub { $timeout });
		1253	}
973	};	1254	};
974		1255
975	defined wantarray && AnyEvent::Util::guard { %state = () }	1256	defined wantarray && AnyEvent::Util::guard { _destroy_state %state }
976	}	1257	}
977		1258
978	sub http_get($@) {	1259	sub http_get($@) {
979	unshift @_, "GET";	1260	unshift @_, "GET";
980	&http_request	1261	&http_request
…		…
998	AnyEvent::HTTP uses the AnyEvent::Socket::tcp_connect function for	1279	AnyEvent::HTTP uses the AnyEvent::Socket::tcp_connect function for
999	the actual connection, which in turn uses AnyEvent::DNS to resolve	1280	the actual connection, which in turn uses AnyEvent::DNS to resolve
1000	hostnames. The latter is a simple stub resolver and does no caching	1281	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	1282	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	1283	your own default resolver (by storing a suitable resolver object in
1003	C<$AnyEvent::DNS::RESOLVER>).	1284	C<$AnyEvent::DNS::RESOLVER>) or your own C<tcp_connect> callback.
1004		1285
1005	=head2 GLOBAL FUNCTIONS AND VARIABLES	1286	=head2 GLOBAL FUNCTIONS AND VARIABLES
1006		1287
1007	=over 4	1288	=over 4
1008		1289
1009	=item AnyEvent::HTTP::set_proxy "proxy-url"	1290	=item AnyEvent::HTTP::set_proxy "proxy-url"
1010		1291
1011	Sets the default proxy server to use. The proxy-url must begin with a	1292	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	1293	string of the form C<http://host:port>, croaks otherwise.
1013	otherwise.
1014		1294
1015	To clear an already-set proxy, use C<undef>.	1295	To clear an already-set proxy, use C<undef>.
		1296
		1297	When AnyEvent::HTTP is loaded for the first time it will query the
		1298	default proxy from the operating system, currently by looking at
		1299	C<$ENV{http_proxy>}.
1016		1300
1017	=item AnyEvent::HTTP::cookie_jar_expire $jar[, $session_end]	1301	=item AnyEvent::HTTP::cookie_jar_expire $jar[, $session_end]
1018		1302
1019	Remove all cookies from the cookie jar that have been expired. If	1303	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	1304	C<$session_end> is given and true, then additionally remove all session
1021	cookies.	1305	cookies.
1022		1306
1023	You should call this function (with a true C<$session_end>) before you	1307	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	1308	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	1309	again. If you have a long-running program you can additionally call this
1026	function from time to time.	1310	function from time to time.
1027		1311
1028	A cookie jar is initially an empty hash-reference that is managed by this	1312	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:	1313	module. Its format is subject to change, but currently it is as follows:
1030		1314
1031	The key C<version> has to contain C<1>, otherwise the hash gets	1315	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	1316	cleared. All other keys are hostnames or IP addresses pointing to
1033	hash-references. The key for these inner hash references is the	1317	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	1318	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	1319	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	1320	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>,	1321	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	1322	which have been replaced by a C<_expires> key that contains the cookie
1039	expiry timestamp.	1323	expiry timestamp. Session cookies are indicated by not having an
		1324	C<_expires> key.
1040		1325
1041	Here is an example of a cookie jar with a single cookie, so you have a	1326	Here is an example of a cookie jar with a single cookie, so you have a
1042	chance of understanding the above paragraph:	1327	chance of understanding the above paragraph:
1043		1328
1044	{	1329	{
1045	version => 1,	1330	version => 2,
1046	"10.0.0.1" => {	1331	"10.0.0.1" => {
1047	"/" => {	1332	"/" => {
1048	"mythweb_id" => {	1333	"mythweb_id" => {
1049	_expires => 1293917923,	1334	_expires => 1293917923,
1050	value => "ooRung9dThee3ooyXooM1Ohm",	1335	value => "ooRung9dThee3ooyXooM1Ohm",
…		…
1066		1351
1067	=item $AnyEvent::HTTP::MAX_RECURSE	1352	=item $AnyEvent::HTTP::MAX_RECURSE
1068		1353
1069	The default value for the C<recurse> request parameter (default: C<10>).	1354	The default value for the C<recurse> request parameter (default: C<10>).
1070		1355
		1356	=item $AnyEvent::HTTP::TIMEOUT
		1357
		1358	The default timeout for connection operations (default: C<300>).
		1359
1071	=item $AnyEvent::HTTP::USERAGENT	1360	=item $AnyEvent::HTTP::USERAGENT
1072		1361
1073	The default value for the C<User-Agent> header (the default is	1362	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)>).	1363	C<Mozilla/5.0 (compatible; U; AnyEvent-HTTP/$VERSION; +http://software.schmorp.de/pkg/AnyEvent)>).
1075		1364
1076	=item $AnyEvent::HTTP::MAX_PER_HOST	1365	=item $AnyEvent::HTTP::MAX_PER_HOST
1077		1366
1078	The maximum number of concurrent connections to the same host (identified	1367	The maximum number of concurrent connections to the same host (identified
1079	by the hostname). If the limit is exceeded, then the additional requests	1368	by the hostname). If the limit is exceeded, then additional requests
1080	are queued until previous connections are closed.	1369	are queued until previous connections are closed. Both persistent and
		1370	non-persistent connections are counted in this limit.
1081		1371
1082	The default value for this is C<4>, and it is highly advisable to not	1372	The default value for this is C<4>, and it is highly advisable to not
1083	increase it.	1373	increase it much.
		1374
		1375	For comparison: the RFC's recommend 4 non-persistent or 2 persistent
		1376	connections, older browsers used 2, newer ones (such as firefox 3)
		1377	typically use 6, and Opera uses 8 because like, they have the fastest
		1378	browser and give a shit for everybody else on the planet.
		1379
		1380	=item $AnyEvent::HTTP::PERSISTENT_TIMEOUT
		1381
		1382	The time after which idle persistent connections get closed by
		1383	AnyEvent::HTTP (default: C<3>).
1084		1384
1085	=item $AnyEvent::HTTP::ACTIVE	1385	=item $AnyEvent::HTTP::ACTIVE
1086		1386
1087	The number of active connections. This is not the number of currently	1387	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	1388	running requests, but the number of currently open and non-idle TCP
1089	connections. This number of can be useful for load-leveling.	1389	connections. This number can be useful for load-leveling.
1090		1390
1091	=back	1391	=back
1092		1392
1093	=cut	1393	=cut
1094		1394
…		…
1128	# other formats fail in the loop below	1428	# other formats fail in the loop below
1129		1429
1130	for (0..11) {	1430	for (0..11) {
1131	if ($m eq $month[$_]) {	1431	if ($m eq $month[$_]) {
1132	require Time::Local;	1432	require Time::Local;
1133	return Time::Local::timegm ($S, $M, $H, $d, $_, $y);	1433	return eval { Time::Local::timegm ($S, $M, $H, $d, $_, $y) };
1134	}	1434	}
1135	}	1435	}
1136		1436
1137	undef	1437	undef
1138	}	1438	}
1139		1439
1140	sub set_proxy($) {	1440	sub set_proxy($) {
1141	if (length $_[0]) {	1441	if (length $_[0]) {
1142	$_[0] =~ m%^(https?):// ([^:/]+) (?: : (\d*) )?%ix	1442	$_[0] =~ m%^(http):// ([^:/]+) (?: : (\d*) )?%ix
1143	or Carp::croak "$_[0]: invalid proxy URL";	1443	or Carp::croak "$_[0]: invalid proxy URL";
1144	$PROXY = [$2, $3 \|\| 3128, $1]	1444	$PROXY = [$2, $3 \|\| 3128, $1]
1145	} else {	1445	} else {
1146	undef $PROXY;	1446	undef $PROXY;
1147	}	1447	}
…		…
1150	# initialise proxy from environment	1450	# initialise proxy from environment
1151	eval {	1451	eval {
1152	set_proxy $ENV{http_proxy};	1452	set_proxy $ENV{http_proxy};
1153	};	1453	};
1154		1454
		1455	=head2 SHOWCASE
		1456
		1457	This section contains some more elaborate "real-world" examples or code
		1458	snippets.
		1459
		1460	=head2 HTTP/1.1 FILE DOWNLOAD
		1461
		1462	Downloading files with HTTP can be quite tricky, especially when something
		1463	goes wrong and you want to resume.
		1464
		1465	Here is a function that initiates and resumes a download. It uses the
		1466	last modified time to check for file content changes, and works with many
		1467	HTTP/1.0 servers as well, and usually falls back to a complete re-download
		1468	on older servers.
		1469
		1470	It calls the completion callback with either C<undef>, which means a
		1471	nonretryable error occurred, C<0> when the download was partial and should
		1472	be retried, and C<1> if it was successful.
		1473
		1474	use AnyEvent::HTTP;
		1475
		1476	sub download($$$) {
		1477	my ($url, $file, $cb) = @_;
		1478
		1479	open my $fh, "+<", $file
		1480	or die "$file: $!";
		1481
		1482	my %hdr;
		1483	my $ofs = 0;
		1484
		1485	if (stat $fh and -s _) {
		1486	$ofs = -s _;
		1487	warn "-s is ", $ofs;
		1488	$hdr{"if-unmodified-since"} = AnyEvent::HTTP::format_date +(stat _)[9];
		1489	$hdr{"range"} = "bytes=$ofs-";
		1490	}
		1491
		1492	http_get $url,
		1493	headers => \%hdr,
		1494	on_header => sub {
		1495	my ($hdr) = @_;
		1496
		1497	if ($hdr->{Status} == 200 && $ofs) {
		1498	# resume failed
		1499	truncate $fh, $ofs = 0;
		1500	}
		1501
		1502	sysseek $fh, $ofs, 0;
		1503
		1504	1
		1505	},
		1506	on_body => sub {
		1507	my ($data, $hdr) = @_;
		1508
		1509	if ($hdr->{Status} =~ /^2/) {
		1510	length $data == syswrite $fh, $data
		1511	or return; # abort on write errors
		1512	}
		1513
		1514	1
		1515	},
		1516	sub {
		1517	my (undef, $hdr) = @_;
		1518
		1519	my $status = $hdr->{Status};
		1520
		1521	if (my $time = AnyEvent::HTTP::parse_date $hdr->{"last-modified"}) {
		1522	utime $time, $time, $fh;
		1523	}
		1524
		1525	if ($status == 200 \|\| $status == 206 \|\| $status == 416) {
		1526	# download ok \|\| resume ok \|\| file already fully downloaded
		1527	$cb->(1, $hdr);
		1528
		1529	} elsif ($status == 412) {
		1530	# file has changed while resuming, delete and retry
		1531	unlink $file;
		1532	$cb->(0, $hdr);
		1533
		1534	} elsif ($status == 500 or $status == 503 or $status =~ /^59/) {
		1535	# retry later
		1536	$cb->(0, $hdr);
		1537
		1538	} else {
		1539	$cb->(undef, $hdr);
		1540	}
		1541	}
		1542	;
		1543	}
		1544
		1545	download "http://server/somelargefile", "/tmp/somelargefile", sub {
		1546	if ($_[0]) {
		1547	print "OK!\n";
		1548	} elsif (defined $_[0]) {
		1549	print "please retry later\n";
		1550	} else {
		1551	print "ERROR\n";
		1552	}
		1553	};
		1554
1155	=head2 SOCKS PROXIES	1555	=head3 SOCKS PROXIES
1156		1556
1157	Socks proxies are not directly supported by AnyEvent::HTTP. You can	1557	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	1558	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	1559	F<socksify> (dante) or F<tsocks> to make your program use a socks proxy
1160	transparently.	1560	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.139 by root, Fri Aug 5 20:48:14 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.139 by root, Fri Aug 5 20:48:14 2022 UTC