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

Comparing AnyEvent-HTTP/HTTP.pm (file contents):
Revision 1.88 by root, Sun Jan 2 20:57:03 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
170	will provide defaults at least for C<TE:>, C<Referer:> and C<User-Agent:>	171	will provide defaults at least for C<TE:>, C<Referer:> and C<User-Agent:>
171	(this can be suppressed by using C<undef> for these headers in which case	172	(this can be suppressed by using C<undef> for these headers in which case
172	they won't be sent at all).	173	they won't be sent at all).
173		174
		175	You really should provide your own C<User-Agent:> header value that is
		176	appropriate for your program - I wouldn't be surprised if the default
		177	AnyEvent string gets blocked by webservers sooner or later.
		178
		179	Also, make sure that your headers names and values do not contain any
		180	embedded newlines.
		181
174	=item timeout => $seconds	182	=item timeout => $seconds
175		183
176	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
177	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
178	timeout.	186	timeout.
179		187
180	Default timeout is 5 minutes.	188	Default timeout is 5 minutes.
181		189
182	=item proxy => [$host, $port[, $scheme]] or undef	190	=item proxy => [$host, $port[, $scheme]] or undef
183		191
184	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
185	default proxy (as specified by C<$ENV{http_proxy}>) is used.	193	used.
186		194
187	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.
188	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>.
189		207
190	=item body => $string	208	=item body => $string
191		209
192	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
193	this module might offer more options).	211	this module might offer more options).
…		…
224	verification) TLS context.	242	verification) TLS context.
225		243
226	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
227	me the page, no matter what".	245	me the page, no matter what".
228		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
229	=item on_prepare => $callback->($fh)	259	=item on_prepare => $callback->($fh)
230		260
231	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
232	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
233	overrides the prepare callback passed to C<AnyEvent::Socket::tcp_connect>	263	overrides the prepare callback passed to C<AnyEvent::Socket::tcp_connect>
234	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
235	timeout). See the description for the C<$prepare_cb> argument of	265	timeout). See the description for the C<$prepare_cb> argument of
236	C<AnyEvent::Socket::tcp_connect> for details.	266	C<AnyEvent::Socket::tcp_connect> for details.
237		267
…		…
240	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
241	establishes connections. Normally it uses L<AnyEvent::Socket::tcp_connect>	271	establishes connections. Normally it uses L<AnyEvent::Socket::tcp_connect>
242	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 -
243	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
244	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.
245		281
246	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
247	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
248	but fast) host => IP address caching or even socks protocol support.	284	but fast) host => IP address caching or even socks protocol support.
249		285
…		…
302	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
303	callback will receive the L<AnyEvent::Handle> object associated with the	339	callback will receive the L<AnyEvent::Handle> object associated with the
304	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
305	(e.g. status C<304>), the empty string will be passed.	341	(e.g. status C<304>), the empty string will be passed.
306		342
307	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
308	a proxy, be a persistent connection etc., and configured in unspecified	344	to a proxy, be a persistent connection, use chunked transfer encoding
309	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
310	module anymore).	346	handle (it will not be used by this module anymore).
311		347
312	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
313	headers, an interactive protocol is used (typical example would be the	349	headers, an interactive protocol is used (typical example would be the
314	push-style twitter API which starts a JSON/XML stream).	350	push-style twitter API which starts a JSON/XML stream).
315		351
316	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
317	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	},
318		395
319	=back	396	=back
320		397
321	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
322	the response body.	399	the response body.
…		…
328		405
329	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
330	timeout of 30 seconds.	407	timeout of 30 seconds.
331		408
332	http_request	409	http_request
333	GET => "https://www.google.com",	410	HEAD => "https://www.google.com",
		411	headers => { "user-agent" => "MySearchClient 1.0" },
334	timeout => 30,	412	timeout => 30,
335	sub {	413	sub {
336	my ($body, $hdr) = @_;	414	my ($body, $hdr) = @_;
337	use Data::Dumper;	415	use Data::Dumper;
338	print Dumper $hdr;	416	print Dumper $hdr;
…		…
348	};	426	};
349		427
350	undef $request;	428	undef $request;
351		429
352	=cut	430	=cut
		431
		432	#############################################################################
		433	# wait queue/slots
353		434
354	sub _slot_schedule;	435	sub _slot_schedule;
355	sub _slot_schedule($) {	436	sub _slot_schedule($) {
356	my $host = shift;	437	my $host = shift;
357		438
…		…
380		461
381	_slot_schedule $_[0];	462	_slot_schedule $_[0];
382	}	463	}
383		464
384	#############################################################################	465	#############################################################################
		466	# cookie handling
385		467
386	# expire cookies	468	# expire cookies
387	sub cookie_jar_expire($;$) {	469	sub cookie_jar_expire($;$) {
388	my ($jar, $session_end) = @_;	470	my ($jar, $session_end) = @_;
389		471
390	%$jar = () if $jar->{version} != 1;	472	%$jar = () if $jar->{version} != 2;
391		473
392	my $anow = AE::now;	474	my $anow = AE::now;
393		475
394	while (my ($chost, $paths) = each %$jar) {	476	while (my ($chost, $paths) = each %$jar) {
395	next unless ref $paths;	477	next unless ref $paths;
…		…
413	}	495	}
414	}	496	}
415		497
416	# extract cookies from jar	498	# extract cookies from jar
417	sub cookie_jar_extract($$$$) {	499	sub cookie_jar_extract($$$$) {
418	my ($jar, $uscheme, $uhost, $upath) = @_;	500	my ($jar, $scheme, $host, $path) = @_;
419		501
420	%$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]/;
421		506
422	my @cookies;	507	my @cookies;
423		508
424	while (my ($chost, $paths) = each %$jar) {	509	while (my ($chost, $paths) = each %$jar) {
425	next unless ref $paths;	510	next unless ref $paths;
426		511
427	if ($chost =~ /^\./) {	512	# exact match or suffix including . match
428	next unless $chost eq substr $uhost, -length $chost;	513	$chost eq $host or ".$chost" eq substr $host, -1 - length $chost
429	} elsif ($chost =~ /\./) {
430	next unless $chost eq $uhost;
431	} else {
432	next;	514	or next;
433	}
434		515
435	while (my ($cpath, $cookies) = each %$paths) {	516	while (my ($cpath, $cookies) = each %$paths) {
436	next unless $cpath eq substr $upath, 0, length $cpath;	517	next unless $cpath eq substr $path, 0, length $cpath;
437		518
438	while (my ($cookie, $kv) = each %$cookies) {	519	while (my ($cookie, $kv) = each %$cookies) {
439	next if $uscheme ne "https" && exists $kv->{secure};	520	next if $scheme ne "https" && exists $kv->{secure};
440		521
441	if (exists $kv->{_expires} and AE::now > $kv->{_expires}) {	522	if (exists $kv->{_expires} and AE::now > $kv->{_expires}) {
442	delete $cookies->{$cookie};	523	delete $cookies->{$cookie};
443	next;	524	next;
444	}	525	}
…		…
458	\@cookies	539	\@cookies
459	}	540	}
460		541
461	# parse set_cookie header into jar	542	# parse set_cookie header into jar
462	sub cookie_jar_set_cookie($$$$) {	543	sub cookie_jar_set_cookie($$$$) {
463	my ($jar, $set_cookie, $uhost, $date) = @_;	544	my ($jar, $set_cookie, $host, $date) = @_;
		545
		546	%$jar = () if $jar->{version} != 2;
464		547
465	my $anow = int AE::now;	548	my $anow = int AE::now;
466	my $snow; # server-now	549	my $snow; # server-now
467		550
468	for ($set_cookie) {	551	for ($set_cookie) {
…		…
474	while (	557	while (
475	m{	558	m{
476	\G\s*	559	\G\s*
477	(?:	560	(?:
478	expires \s=\s ([A-Z][a-z][a-z]+,\ [^,;]+)	561	expires \s=\s ([A-Z][a-z][a-z]+,\ [^,;]+)
479	\| ([^=;,[:space:]]+) (?: \s=\s (?: "((?:[^\\"]+\|\\.))" \| ([^=;,[:space:]]) ) )?	562	\| ([^=;,[:space:]]+) (?: \s=\s (?: "((?:[^\\"]+\|\\.))" \| ([^;,[:space:]]) ) )?
480	)	563	)
481	}gcxsi	564	}gcxsi
482	) {	565	) {
483	my $name = $2;	566	my $name = $2;
484	my $value = $4;	567	my $value = $4;
…		…
491	# quoted	574	# quoted
492	$value = $3;	575	$value = $3;
493	$value =~ s/\\(.)/$1/gs;	576	$value =~ s/\\(.)/$1/gs;
494	}	577	}
495		578
496	push @kv, lc $name, $value;	579	push @kv, @kv ? lc $name : $name, $value;
497		580
498	last unless /\G\s*;/gc;	581	last unless /\G\s*;/gc;
499	}	582	}
500		583
501	last unless @kv;	584	last unless @kv;
…		…
514		597
515	my $cdom;	598	my $cdom;
516	my $cpath = (delete $kv{path}) \|\| "/";	599	my $cpath = (delete $kv{path}) \|\| "/";
517		600
518	if (exists $kv{domain}) {	601	if (exists $kv{domain}) {
519	$cdom = delete $kv{domain};	602	$cdom = $kv{domain};
520		603
521	$cdom =~ s/^\.?/./; # make sure it starts with a "."	604	$cdom =~ s/^\.?/./; # make sure it starts with a "."
522		605
523	next if $cdom =~ /\.$/;	606	next if $cdom =~ /\.$/;
524		607
525	# this is not rfc-like and not netscape-like. go figure.	608	# this is not rfc-like and not netscape-like. go figure.
526	my $ndots = $cdom =~ y/.//;	609	my $ndots = $cdom =~ y/.//;
527	next if $ndots < ($cdom =~ /\.[^.][^.]\.[^.][^.]$/ ? 3 : 2);	610	next if $ndots < ($cdom =~ /\.[^.][^.]\.[^.][^.]$/ ? 3 : 2);
		611
		612	$cdom = substr $cdom, 1; # remove initial .
528	} else {	613	} else {
529	$cdom = $uhost;	614	$cdom = $host;
530	}	615	}
531		616
532	# store it	617	# store it
533	$jar->{version} = 1;	618	$jar->{version} = 2;
534	$jar->{lc $cdom}{$cpath}{$name} = \%kv;	619	$jar->{lc $cdom}{$cpath}{$name} = \%kv;
535		620
536	redo if /\G\s*,/gc;	621	redo if /\G\s*,/gc;
537	}	622	}
538	}	623	}
539		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
540	# continue to parse $_ for headers and place them into the arg	667	# continue to parse $_ for headers and place them into the arg
541	sub parse_hdr() {	668	sub _parse_hdr() {
542	my %hdr;	669	my %hdr;
543		670
544	# things seen, not parsed:	671	# things seen, not parsed:
545	# p3pP="NON CUR OTPi OUR NOR UNI"	672	# p3pP="NON CUR OTPi OUR NOR UNI"
546		673
…		…
560	for values %hdr;	687	for values %hdr;
561		688
562	\%hdr	689	\%hdr
563	}	690	}
564		691
		692	#############################################################################
		693	# http_get
		694
565	our $qr_nlnl = qr{(?<![^\012])\015?\012};	695	our $qr_nlnl = qr{(?<![^\012])\015?\012};
566		696
567	our $TLS_CTX_LOW = { cache => 1, sslv2 => 1 };	697	our $TLS_CTX_LOW = { cache => 1, sslv2 => 1 };
568	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	);
569		757
570	sub http_request($$@) {	758	sub http_request($$@) {
571	my $cb = pop;	759	my $cb = pop;
572	my ($method, $url, %arg) = @_;	760	my ($method, $url, %arg) = @_;
573		761
…		…
591	my $recurse = exists $arg{recurse} ? delete $arg{recurse} : $MAX_RECURSE;	779	my $recurse = exists $arg{recurse} ? delete $arg{recurse} : $MAX_RECURSE;
592		780
593	return $cb->(undef, { @pseudo, Status => 599, Reason => "Too many redirections" })	781	return $cb->(undef, { @pseudo, Status => 599, Reason => "Too many redirections" })
594	if $recurse < 0;	782	if $recurse < 0;
595		783
596	my $proxy = $arg{proxy} \|\| $PROXY;	784	my $proxy = exists $arg{proxy} ? $arg{proxy} : $PROXY;
597	my $timeout = $arg{timeout} \|\| $TIMEOUT;	785	my $timeout = $arg{timeout} \|\| $TIMEOUT;
598		786
599	my ($uscheme, $uauthority, $upath, $query, $fragment) =	787	my ($uscheme, $uauthority, $upath, $query, undef) = # ignore fragment
600	$url =~ m\|(?:([^:/?#]+):)?(?://([^/?#]))?([^?#])(?:(\?[^#]))?(?:#(.))?\|;	788	$url =~ m\|^([^:]+):(?://([^/?#]))?([^?#])(?:(\?[^#]))?(?:#(.))?$\|;
601		789
602	$uscheme = lc $uscheme;	790	$uscheme = lc $uscheme;
603		791
604	my $uport = $uscheme eq "http" ? 80	792	my $uport = $uscheme eq "http" ? 80
605	: $uscheme eq "https" ? 443	793	: $uscheme eq "https" ? 443
606	: 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" });
607		795
608	$uauthority =~ /^(?: .*\@ )? ([^\@:]+) (?: : (\d+) )?$/x	796	$uauthority =~ /^(?: .*\@ )? ([^\@]+?) (?: : (\d+) )?$/x
609	or return $cb->(undef, { @pseudo, Status => 599, Reason => "Unparsable URL" });	797	or return $cb->(undef, { @pseudo, Status => 599, Reason => "Unparsable URL" });
610		798
611	my $uhost = lc $1;	799	my $uhost = lc $1;
612	$uport = $2 if defined $2;	800	$uport = $2 if defined $2;
613		801
…		…
649	$hdr{"user-agent"} = $USERAGENT unless exists $hdr{"user-agent"};	837	$hdr{"user-agent"} = $USERAGENT unless exists $hdr{"user-agent"};
650		838
651	$hdr{"content-length"} = length $arg{body}	839	$hdr{"content-length"} = length $arg{body}
652	if length $arg{body} \|\| $method ne "GET";	840	if length $arg{body} \|\| $method ne "GET";
653		841
654	$hdr{connection} = "close Te"; #1.1	842	my $idempotent = $IDEMPOTENT{$method};
		843
		844	# default value for keepalive is true iff the request is for an idempotent method
		845	my $persistent = exists $arg{persistent} ? !!$arg{persistent} : $idempotent;
		846	my $keepalive = exists $arg{keepalive} ? !!$arg{keepalive} : !$proxy;
		847	my $was_persistent; # true if this is actually a recycled connection
		848
		849	# the key to use in the keepalive cache
		850	my $ka_key = "$uscheme\x00$uhost\x00$uport\x00$arg{sessionid}";
		851
		852	$hdr{connection} = ($persistent ? $keepalive ? "keep-alive, " : "" : "close, ") . "Te"; #1.1
655	$hdr{te} = "trailers" unless exists $hdr{te}; #1.1	853	$hdr{te} = "trailers" unless exists $hdr{te}; #1.1
656		854
657	my %state = (connect_guard => 1);	855	my %state = (connect_guard => 1);
658		856
659	my $ae_error = 595; # connecting	857	my $ae_error = 595; # connecting
660		858
661	# handle actual, non-tunneled, request	859	# handle actual, non-tunneled, request
662	my $handle_actual_request = sub {	860	my $handle_actual_request = sub {
663	$ae_error = 596; # request phase	861	$ae_error = 596; # request phase
664		862
		863	my $hdl = $state{handle};
		864
665	$state{handle}->starttls ("connect") if $uscheme eq "https" && !exists $state{handle}{tls};	865	$hdl->starttls ("connect") if $uscheme eq "https" && !exists $hdl->{tls};
666		866
667	# send request	867	# send request
668	$state{handle}->push_write (	868	$hdl->push_write (
669	"$method $rpath HTTP/1.1\015\012"	869	"$method $rpath HTTP/1.1\015\012"
670	. (join "", map "\u$_: $hdr{$_}\015\012", grep defined $hdr{$_}, keys %hdr)	870	. (join "", map "\u$_: $hdr{$_}\015\012", grep defined $hdr{$_}, keys %hdr)
671	. "\015\012"	871	. "\015\012"
672	. (delete $arg{body})	872	. $arg{body}
673	);	873	);
674		874
675	# return if error occured during push_write()	875	# return if error occurred during push_write()
676	return unless %state;	876	return unless %state;
677		877
678	%hdr = (); # reduce memory usage, save a kitten, also make it possible to re-use	878	# reduce memory usage, save a kitten, also re-use it for the response headers.
		879	%hdr = ();
679		880
680	# status line and headers	881	# status line and headers
681	$state{read_response} = sub {	882	$state{read_response} = sub {
		883	return unless %state;
		884
682	for ("$_[1]") {	885	for ("$_[1]") {
683	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.
684		887
685	/^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
686	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" };
687		890
688	# 100 Continue handling	891	# 100 Continue handling
689	# should not happen as we don't send expect: 100-continue,	892	# should not happen as we don't send expect: 100-continue,
690	# but we handle it just in case.	893	# but we handle it just in case.
691	# 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
…		…
697	HTTPVersion => $1,	900	HTTPVersion => $1,
698	Status => $2,	901	Status => $2,
699	Reason => $3,	902	Reason => $3,
700	;	903	;
701		904
702	my $hdr = parse_hdr	905	my $hdr = _parse_hdr
703	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" };
704		907
705	%hdr = (%$hdr, @pseudo);	908	%hdr = (%$hdr, @pseudo);
706	}	909	}
707		910
708	# redirect handling	911	# redirect handling
709	# microsoft and other shitheads don't give a shit for following standards,	912	# relative uri handling forced by microsoft and other shitheads.
710	# try to support some common forms of broken Location headers.	913	# we give our best and fall back to URI if available.
711	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"
712	$hdr{location} =~ s/^\.\/+//;	924	$loc =~ s/^\.\/+//;
713		925
714	my $url = "$rscheme://$uhost:$uport";	926	if ($loc !~ m%^[.?#]%) {
		927	my $prefix = "$uscheme://$uauthority";
715		928
716	unless ($hdr{location} =~ s/^\///) {	929	unless ($loc =~ s/^\///) {
717	$url .= $upath;	930	$prefix .= $upath;
718	$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	}
719	}	945	}
720		946
721	$hdr{location} = "$url/$hdr{location}";	947	$hdr{location} = $loc;
722	}	948	}
723		949
724	my $redirect;	950	my $redirect;
725		951
726	if ($recurse) {	952	if ($recurse) {
…		…
728		954
729	# industry standard is to redirect POST as GET for	955	# industry standard is to redirect POST as GET for
730	# 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.
731	# 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,
732	# industry standard seems to be to simply follow.	958	# industry standard seems to be to simply follow.
733	# we go with the industry standard.	959	# we go with the industry standard. 308 is defined
		960	# by rfc7538
734	if ($status == 301 or $status == 302 or $status == 303) {	961	if ($status == 301 or $status == 302 or $status == 303) {
		962	$redirect = 1;
735	# HTTP/1.1 is unclear on how to mutate the method	963	# HTTP/1.1 is unclear on how to mutate the method
736	$method = "GET" unless $method eq "HEAD";	964	unless ($method eq "HEAD") {
737	$redirect = 1;	965	$method = "GET";
		966	delete $arg{body};
		967	}
738	} elsif ($status == 307) {	968	} elsif ($status == 307 or $status == 308) {
739	$redirect = 1;	969	$redirect = 1;
740	}	970	}
741	}	971	}
742		972
743	my $finish = sub { # ($data, $err_status, $err_reason[, $keepalive])	973	my $finish = sub { # ($data, $err_status, $err_reason[, $persistent])
744	my $may_keep_alive = $_[3];	974	if ($state{handle}) {
745		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
746	$state{handle}->destroy if $state{handle};	986	$state{handle}->destroy;
		987	}
		988	}
		989
747	%state = ();	990	%state = ();
748		991
749	if (defined $_[1]) {	992	if (defined $_[1]) {
750	$hdr{OrigStatus} = $hdr{Status}; $hdr{Status} = $_[1];	993	$hdr{OrigStatus} = $hdr{Status}; $hdr{Status} = $_[1];
751	$hdr{OrigReason} = $hdr{Reason}; $hdr{Reason} = $_[2];	994	$hdr{OrigReason} = $hdr{Reason}; $hdr{Reason} = $_[2];
…		…
758		1001
759	if ($redirect && exists $hdr{location}) {	1002	if ($redirect && exists $hdr{location}) {
760	# we ignore any errors, as it is very common to receive	1003	# we ignore any errors, as it is very common to receive
761	# Content-Length != 0 but no actual body	1004	# Content-Length != 0 but no actual body
762	# we also access %hdr, as $_[1] might be an erro	1005	# we also access %hdr, as $_[1] might be an erro
		1006	$state{recurse} =
763	http_request (	1007	http_request (
764	$method => $hdr{location},	1008	$method => $hdr{location},
765	%arg,	1009	%arg,
766	recurse => $recurse - 1,	1010	recurse => $recurse - 1,
767	Redirect => [$_[0], \%hdr],	1011	Redirect => [$_[0], \%hdr],
		1012	sub {
		1013	%state = ();
		1014	&$cb
		1015	},
768	$cb);	1016	);
769	} else {	1017	} else {
770	$cb->($_[0], \%hdr);	1018	$cb->($_[0], \%hdr);
771	}	1019	}
772	};	1020	};
773		1021
774	$ae_error = 597; # body phase	1022	$ae_error = 597; # body phase
775		1023
		1024	my $chunked = $hdr{"transfer-encoding"} =~ /\bchunked\b/i; # not quite correct...
		1025
776	my $len = $hdr{"content-length"};	1026	my $len = $chunked ? undef : $hdr{"content-length"};
777		1027
778	# body handling, many different code paths	1028	# body handling, many different code paths
779	# - no body expected	1029	# - no body expected
780	# - want_body_handle	1030	# - want_body_handle
781	# - te chunked	1031	# - te chunked
…		…
796	$_[0]->on_error (undef);	1046	$_[0]->on_error (undef);
797	$_[0]->on_read (undef);	1047	$_[0]->on_read (undef);
798		1048
799	$finish->(delete $state{handle});	1049	$finish->(delete $state{handle});
800		1050
801	} elsif ($hdr{"transfer-encoding"} =~ /\bchunked\b/i) {	1051	} elsif ($chunked) {
802	my $cl = 0;	1052	my $cl = 0;
803	my $body = undef;	1053	my $body = "";
804	my $on_body = $arg{on_body} \|\| sub { $body .= shift; 1 };	1054	my $on_body = (!$redirect && $arg{on_body}) \|\| sub { $body .= shift; 1 };
805		1055
806	$state{read_chunk} = sub {	1056	$state{read_chunk} = sub {
807	$_[1] =~ /^([0-9a-fA-F]+)/	1057	$_[1] =~ /^([0-9a-fA-F]+)/
808	or $finish->(undef, $ae_error => "Garbled chunked transfer encoding");	1058	or return $finish->(undef, $ae_error => "Garbled chunked transfer encoding");
809		1059
810	my $len = hex $1;	1060	my $len = hex $1;
811		1061
812	if ($len) {	1062	if ($len) {
813	$cl += $len;	1063	$cl += $len;
…		…
828	$_[0]->push_read (line => $qr_nlnl, sub {	1078	$_[0]->push_read (line => $qr_nlnl, sub {
829	if (length $_[1]) {	1079	if (length $_[1]) {
830	for ("$_[1]") {	1080	for ("$_[1]") {
831	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.
832		1082
833	my $hdr = parse_hdr	1083	my $hdr = _parse_hdr
834	or return $finish->(undef, $ae_error => "Garbled response trailers");	1084	or return $finish->(undef, $ae_error => "Garbled response trailers");
835		1085
836	%hdr = (%hdr, %$hdr);	1086	%hdr = (%hdr, %$hdr);
837	}	1087	}
838	}	1088	}
…		…
842	}	1092	}
843	};	1093	};
844		1094
845	$_[0]->push_read (line => $state{read_chunk});	1095	$_[0]->push_read (line => $state{read_chunk});
846		1096
847	} elsif ($arg{on_body}) {	1097	} elsif (!$redirect && $arg{on_body}) {
848	if (defined $len) {	1098	if (defined $len) {
849	$_[0]->on_read (sub {	1099	$_[0]->on_read (sub {
850	$len -= length $_[0]{rbuf};	1100	$len -= length $_[0]{rbuf};
851		1101
852	$arg{on_body}(delete $_[0]{rbuf}, \%hdr)	1102	$arg{on_body}(delete $_[0]{rbuf}, \%hdr)
…		…
881	$_[0]->on_read (sub { });	1131	$_[0]->on_read (sub { });
882	}	1132	}
883	}	1133	}
884	};	1134	};
885		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 {
886	$state{handle}->push_read (line => $qr_nlnl, $state{read_response});	1165	$hdl->push_read (line => $qr_nlnl, $state{read_response});
		1166	}
887	};	1167	};
888		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)
889	my $connect_cb = sub {	1183	my $connect_cb = sub {
890	$state{fh} = shift	1184	my $fh = shift
891	or do {
892	my $err = "$!";
893	%state = ();
894	return $cb->(undef, { @pseudo, Status => $ae_error, Reason => $err });	1185	or return _error %state, $cb, { @pseudo, Status => $ae_error, Reason => "$!" };
895	};
896		1186
897	return unless delete $state{connect_guard};	1187	return unless delete $state{connect_guard};
898		1188
899	# get handle	1189	# get handle
900	$state{handle} = new AnyEvent::Handle	1190	$state{handle} = new AnyEvent::Handle
		1191	%{ $arg{handle_params} },
901	fh => $state{fh},	1192	fh => $fh,
902	peername => $rhost,	1193	peername => $uhost,
903	tls_ctx => $arg{tls_ctx},	1194	tls_ctx => $arg{tls_ctx},
904	# these need to be reconfigured on keepalive handles
905	timeout => $timeout,
906	on_error => sub {
907	%state = ();
908	$cb->(undef, { @pseudo, Status => $ae_error, Reason => $_[2] });
909	},
910	on_eof => sub {
911	%state = ();
912	$cb->(undef, { @pseudo, Status => $ae_error, Reason => "Unexpected end-of-file" });
913	},
914	;	1195	;
915		1196
916	# limit the number of persistent connections	1197	$prepare_handle->();
917	# keepalive not yet supported
918	# if ($KA_COUNT{$_[1]} < $MAX_PERSISTENT_PER_HOST) {
919	# ++$KA_COUNT{$_[1]};
920	# $state{handle}{ka_count_guard} = AnyEvent::Util::guard {
921	# --$KA_COUNT{$_[1]}
922	# };
923	# $hdr{connection} = "keep-alive";
924	# }
925		1198
926	$state{handle}->starttls ("connect") if $rscheme eq "https";	1199	#$state{handle}->starttls ("connect") if $rscheme eq "https";
927		1200
928	# now handle proxy-CONNECT method	1201	# now handle proxy-CONNECT method
929	if ($proxy && $uscheme eq "https") {	1202	if ($proxy && $uscheme eq "https") {
930	# oh dear, we have to wrap it into a connect request	1203	# oh dear, we have to wrap it into a connect request
931		1204
		1205	my $auth = exists $hdr{"proxy-authorization"}
		1206	? "proxy-authorization: " . (delete $hdr{"proxy-authorization"}) . "\015\012"
		1207	: "";
		1208
932	# maybe re-use $uauthority with patched port?	1209	# maybe re-use $uauthority with patched port?
933	$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");
934	$state{handle}->push_read (line => $qr_nlnl, sub {	1211	$state{handle}->push_read (line => $qr_nlnl, sub {
935	$_[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
936	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])" };
937		1214
938	if ($2 == 200) {	1215	if ($2 == 200) {
939	$rpath = $upath;	1216	$rpath = $upath;
940	$handle_actual_request->();	1217	$handle_actual_request->();
941	} else {	1218	} else {
942	%state = ();
943	$cb->(undef, { @pseudo, Status => $2, Reason => $3 });	1219	_error %state, $cb, { @pseudo, Status => $2, Reason => $3 };
944	}	1220	}
945	});	1221	});
946	} else {	1222	} else {
		1223	delete $hdr{"proxy-authorization"} unless $proxy;
		1224
947	$handle_actual_request->();	1225	$handle_actual_request->();
948	}	1226	}
949	};	1227	};
950		1228
951	_get_slot $uhost, sub {	1229	_get_slot $uhost, sub {
952	$state{slot_guard} = shift;	1230	$state{slot_guard} = shift;
953		1231
954	return unless $state{connect_guard};	1232	return unless $state{connect_guard};
955		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 {
956	my $tcp_connect = $arg{tcp_connect}	1249	my $tcp_connect = $arg{tcp_connect}
957	\|\| do { require AnyEvent::Socket; \&AnyEvent::Socket::tcp_connect };	1250	\|\| do { require AnyEvent::Socket; \&AnyEvent::Socket::tcp_connect };
958		1251
959	$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	}
960	};	1254	};
961		1255
962	defined wantarray && AnyEvent::Util::guard { %state = () }	1256	defined wantarray && AnyEvent::Util::guard { _destroy_state %state }
963	}	1257	}
964		1258
965	sub http_get($@) {	1259	sub http_get($@) {
966	unshift @_, "GET";	1260	unshift @_, "GET";
967	&http_request	1261	&http_request
…		…
985	AnyEvent::HTTP uses the AnyEvent::Socket::tcp_connect function for	1279	AnyEvent::HTTP uses the AnyEvent::Socket::tcp_connect function for
986	the actual connection, which in turn uses AnyEvent::DNS to resolve	1280	the actual connection, which in turn uses AnyEvent::DNS to resolve
987	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
988	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
989	your own default resolver (by storing a suitable resolver object in	1283	your own default resolver (by storing a suitable resolver object in
990	C<$AnyEvent::DNS::RESOLVER>).	1284	C<$AnyEvent::DNS::RESOLVER>) or your own C<tcp_connect> callback.
991		1285
992	=head2 GLOBAL FUNCTIONS AND VARIABLES	1286	=head2 GLOBAL FUNCTIONS AND VARIABLES
993		1287
994	=over 4	1288	=over 4
995		1289
996	=item AnyEvent::HTTP::set_proxy "proxy-url"	1290	=item AnyEvent::HTTP::set_proxy "proxy-url"
997		1291
998	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
999	string of the form C<http://host:port> (optionally C<https:...>), croaks	1293	string of the form C<http://host:port>, croaks otherwise.
1000	otherwise.
1001		1294
1002	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>}.
1003		1300
1004	=item AnyEvent::HTTP::cookie_jar_expire $jar[, $session_end]	1301	=item AnyEvent::HTTP::cookie_jar_expire $jar[, $session_end]
1005		1302
1006	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
1007	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
1008	cookies.	1305	cookies.
1009		1306
1010	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
1011	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
1012	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
1013	function from time to time.	1310	function from time to time.
1014		1311
1015	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
1016	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:
1017		1314
1018	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
1019	emptied. All other keys are hostnames or IP addresses pointing to	1316	cleared. All other keys are hostnames or IP addresses pointing to
1020	hash-references. The key for these inner hash references is the	1317	hash-references. The key for these inner hash references is the
1021	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
1022	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
1023	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
1024	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>,
1025	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
1026	expiry timestamp.	1323	expiry timestamp. Session cookies are indicated by not having an
		1324	C<_expires> key.
1027		1325
1028	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
1029	chance of understanding the above paragraph:	1327	chance of understanding the above paragraph:
1030		1328
1031	{	1329	{
1032	version => 1,	1330	version => 2,
1033	"10.0.0.1" => {	1331	"10.0.0.1" => {
1034	"/" => {	1332	"/" => {
1035	"mythweb_id" => {	1333	"mythweb_id" => {
1036	_expires => 1293917923,	1334	_expires => 1293917923,
1037	value => "ooRung9dThee3ooyXooM1Ohm",	1335	value => "ooRung9dThee3ooyXooM1Ohm",
…		…
1053		1351
1054	=item $AnyEvent::HTTP::MAX_RECURSE	1352	=item $AnyEvent::HTTP::MAX_RECURSE
1055		1353
1056	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>).
1057		1355
		1356	=item $AnyEvent::HTTP::TIMEOUT
		1357
		1358	The default timeout for connection operations (default: C<300>).
		1359
1058	=item $AnyEvent::HTTP::USERAGENT	1360	=item $AnyEvent::HTTP::USERAGENT
1059		1361
1060	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
1061	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)>).
1062		1364
1063	=item $AnyEvent::HTTP::MAX_PER_HOST	1365	=item $AnyEvent::HTTP::MAX_PER_HOST
1064		1366
1065	The maximum number of concurrent connections to the same host (identified	1367	The maximum number of concurrent connections to the same host (identified
1066	by the hostname). If the limit is exceeded, then the additional requests	1368	by the hostname). If the limit is exceeded, then additional requests
1067	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.
1068		1371
1069	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
1070	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>).
1071		1384
1072	=item $AnyEvent::HTTP::ACTIVE	1385	=item $AnyEvent::HTTP::ACTIVE
1073		1386
1074	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
1075	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
1076	connections. This number of can be useful for load-leveling.	1389	connections. This number can be useful for load-leveling.
1077		1390
1078	=back	1391	=back
1079		1392
1080	=cut	1393	=cut
1081		1394
…		…
1115	# other formats fail in the loop below	1428	# other formats fail in the loop below
1116		1429
1117	for (0..11) {	1430	for (0..11) {
1118	if ($m eq $month[$_]) {	1431	if ($m eq $month[$_]) {
1119	require Time::Local;	1432	require Time::Local;
1120	return Time::Local::timegm ($S, $M, $H, $d, $_, $y);	1433	return eval { Time::Local::timegm ($S, $M, $H, $d, $_, $y) };
1121	}	1434	}
1122	}	1435	}
1123		1436
1124	undef	1437	undef
1125	}	1438	}
1126		1439
1127	sub set_proxy($) {	1440	sub set_proxy($) {
1128	if (length $_[0]) {	1441	if (length $_[0]) {
1129	$_[0] =~ m%^(https?):// ([^:/]+) (?: : (\d*) )?%ix	1442	$_[0] =~ m%^(http):// ([^:/]+) (?: : (\d*) )?%ix
1130	or Carp::croak "$_[0]: invalid proxy URL";	1443	or Carp::croak "$_[0]: invalid proxy URL";
1131	$PROXY = [$2, $3 \|\| 3128, $1]	1444	$PROXY = [$2, $3 \|\| 3128, $1]
1132	} else {	1445	} else {
1133	undef $PROXY;	1446	undef $PROXY;
1134	}	1447	}
…		…
1137	# initialise proxy from environment	1450	# initialise proxy from environment
1138	eval {	1451	eval {
1139	set_proxy $ENV{http_proxy};	1452	set_proxy $ENV{http_proxy};
1140	};	1453	};
1141		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
1142	=head2 SOCKS PROXIES	1555	=head3 SOCKS PROXIES
1143		1556
1144	Socks proxies are not directly supported by AnyEvent::HTTP. You can	1557	Socks proxies are not directly supported by AnyEvent::HTTP. You can
1145	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
1146	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
1147	transparently.	1560	transparently.

Diff Legend

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

Comparing AnyEvent-HTTP/HTTP.pm (file contents): Revision 1.88 by root, Sun Jan 2 20:57:03 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.88 by root, Sun Jan 2 20:57:03 2011 UTC vs.
Revision 1.139 by root, Fri Aug 5 20:48:14 2022 UTC