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

Comparing AnyEvent-HTTP/HTTP.pm (file contents):
Revision 1.91 by root, Mon Jan 3 01:03:29 2011 UTC vs.
Revision 1.137 by root, Mon Apr 27 12:14:12 2020 UTC

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

Diff Legend

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

Comparing AnyEvent-HTTP/HTTP.pm (file contents): Revision 1.91 by root, Mon Jan 3 01:03:29 2011 UTC vs. Revision 1.137 by root, Mon Apr 27 12:14:12 2020 UTC

Diff Legend

Comparing AnyEvent-HTTP/HTTP.pm (file contents):
Revision 1.91 by root, Mon Jan 3 01:03:29 2011 UTC vs.
Revision 1.137 by root, Mon Apr 27 12:14:12 2020 UTC