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

Comparing AnyEvent-HTTP/HTTP.pm (file contents):
Revision 1.90 by root, Mon Jan 3 00:41:25 2011 UTC vs.
Revision 1.131 by root, Thu Aug 30 17:04:28 2018 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.24;
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.
193		202
194	=item body => $string	203	=item body => $string
195		204
196	The request body, usually empty. Will be sent as-is (future versions of	205	The request body, usually empty. Will be sent as-is (future versions of
197	this module might offer more options).	206	this module might offer more options).
…		…
228	verification) TLS context.	237	verification) TLS context.
229		238
230	The default for this option is C<low>, which could be interpreted as "give	239	The default for this option is C<low>, which could be interpreted as "give
231	me the page, no matter what".	240	me the page, no matter what".
232		241
		242	See also the C<sessionid> parameter.
		243
		244	=item session => $string
		245
		246	The module might reuse connections to the same host internally. Sometimes
		247	(e.g. when using TLS), you do not want to reuse connections from other
		248	sessions. This can be achieved by setting this parameter to some unique
		249	ID (such as the address of an object storing your state data, or the TLS
		250	context) - only connections using the same unique ID will be reused.
		251
233	=item on_prepare => $callback->($fh)	252	=item on_prepare => $callback->($fh)
234		253
235	In rare cases you need to "tune" the socket before it is used to	254	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	255	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>	256	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	257	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	258	timeout). See the description for the C<$prepare_cb> argument of
240	C<AnyEvent::Socket::tcp_connect> for details.	259	C<AnyEvent::Socket::tcp_connect> for details.
241		260
…		…
306	called. Instead of the C<$body> argument containing the body data, the	325	called. Instead of the C<$body> argument containing the body data, the
307	callback will receive the L<AnyEvent::Handle> object associated with the	326	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	327	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.	328	(e.g. status C<304>), the empty string will be passed.
310		329
311	The handle object might or might not be in TLS mode, might be connected to	330	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	331	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	332	etc., and configured in unspecified ways. The user is responsible for this
314	module anymore).	333	handle (it will not be used by this module anymore).
315		334
316	This is useful with some push-type services, where, after the initial	335	This is useful with some push-type services, where, after the initial
317	headers, an interactive protocol is used (typical example would be the	336	headers, an interactive protocol is used (typical example would be the
318	push-style twitter API which starts a JSON/XML stream).	337	push-style twitter API which starts a JSON/XML stream).
319		338
320	If you think you need this, first have a look at C<on_body>, to see if	339	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.	340	that doesn't solve your problem in a better way.
		341
		342	=item persistent => $boolean
		343
		344	Try to create/reuse a persistent connection. When this flag is set
		345	(default: true for idempotent requests, false for all others), then
		346	C<http_request> tries to re-use an existing (previously-created)
		347	persistent connection to the host and, failing that, tries to create a new
		348	one.
		349
		350	Requests failing in certain ways will be automatically retried once, which
		351	is dangerous for non-idempotent requests, which is why it defaults to off
		352	for them. The reason for this is because the bozos who designed HTTP/1.1
		353	made it impossible to distinguish between a fatal error and a normal
		354	connection timeout, so you never know whether there was a problem with
		355	your request or not.
		356
		357	When reusing an existent connection, many parameters (such as TLS context)
		358	will be ignored. See the C<session> parameter for a workaround.
		359
		360	=item keepalive => $boolean
		361
		362	Only used when C<persistent> is also true. This parameter decides whether
		363	C<http_request> tries to handshake a HTTP/1.0-style keep-alive connection
		364	(as opposed to only a HTTP/1.1 persistent connection).
		365
		366	The default is true, except when using a proxy, in which case it defaults
		367	to false, as HTTP/1.0 proxies cannot support this in a meaningful way.
		368
		369	=item handle_params => { key => value ... }
		370
		371	The key-value pairs in this hash will be passed to any L<AnyEvent::Handle>
		372	constructor that is called - not all requests will create a handle, and
		373	sometimes more than one is created, so this parameter is only good for
		374	setting hints.
		375
		376	Example: set the maximum read size to 4096, to potentially conserve memory
		377	at the cost of speed.
		378
		379	handle_params => {
		380	max_read_size => 4096,
		381	},
322		382
323	=back	383	=back
324		384
325	Example: do a simple HTTP GET request for http://www.nethype.de/ and print	385	Example: do a simple HTTP GET request for http://www.nethype.de/ and print
326	the response body.	386	the response body.
…		…
332		392
333	Example: do a HTTP HEAD request on https://www.google.com/, use a	393	Example: do a HTTP HEAD request on https://www.google.com/, use a
334	timeout of 30 seconds.	394	timeout of 30 seconds.
335		395
336	http_request	396	http_request
337	GET => "https://www.google.com",	397	HEAD => "https://www.google.com",
338	headers => { "user-agent" => "MySearchClient 1.0" },	398	headers => { "user-agent" => "MySearchClient 1.0" },
339	timeout => 30,	399	timeout => 30,
340	sub {	400	sub {
341	my ($body, $hdr) = @_;	401	my ($body, $hdr) = @_;
342	use Data::Dumper;	402	use Data::Dumper;
…		…
353	};	413	};
354		414
355	undef $request;	415	undef $request;
356		416
357	=cut	417	=cut
		418
		419	#############################################################################
		420	# wait queue/slots
358		421
359	sub _slot_schedule;	422	sub _slot_schedule;
360	sub _slot_schedule($) {	423	sub _slot_schedule($) {
361	my $host = shift;	424	my $host = shift;
362		425
…		…
385		448
386	_slot_schedule $_[0];	449	_slot_schedule $_[0];
387	}	450	}
388		451
389	#############################################################################	452	#############################################################################
		453	# cookie handling
390		454
391	# expire cookies	455	# expire cookies
392	sub cookie_jar_expire($;$) {	456	sub cookie_jar_expire($;$) {
393	my ($jar, $session_end) = @_;	457	my ($jar, $session_end) = @_;
394		458
395	%$jar = () if $jar->{version} != 1;	459	%$jar = () if $jar->{version} != 2;
396		460
397	my $anow = AE::now;	461	my $anow = AE::now;
398		462
399	while (my ($chost, $paths) = each %$jar) {	463	while (my ($chost, $paths) = each %$jar) {
400	next unless ref $paths;	464	next unless ref $paths;
…		…
418	}	482	}
419	}	483	}
420		484
421	# extract cookies from jar	485	# extract cookies from jar
422	sub cookie_jar_extract($$$$) {	486	sub cookie_jar_extract($$$$) {
423	my ($jar, $uscheme, $uhost, $upath) = @_;	487	my ($jar, $scheme, $host, $path) = @_;
424		488
425	%$jar = () if $jar->{version} != 1;	489	%$jar = () if $jar->{version} != 2;
		490
		491	$host = AnyEvent::Util::idn_to_ascii $host
		492	if $host =~ /[^\x00-\x7f]/;
426		493
427	my @cookies;	494	my @cookies;
428		495
429	while (my ($chost, $paths) = each %$jar) {	496	while (my ($chost, $paths) = each %$jar) {
430	next unless ref $paths;	497	next unless ref $paths;
431		498
432	if ($chost =~ /^\./) {	499	# exact match or suffix including . match
433	next unless $chost eq substr $uhost, -length $chost;	500	$chost eq $host or ".$chost" eq substr $host, -1 - length $chost
434	} elsif ($chost =~ /\./) {
435	next unless $chost eq $uhost;
436	} else {
437	next;	501	or next;
438	}
439		502
440	while (my ($cpath, $cookies) = each %$paths) {	503	while (my ($cpath, $cookies) = each %$paths) {
441	next unless $cpath eq substr $upath, 0, length $cpath;	504	next unless $cpath eq substr $path, 0, length $cpath;
442		505
443	while (my ($cookie, $kv) = each %$cookies) {	506	while (my ($cookie, $kv) = each %$cookies) {
444	next if $uscheme ne "https" && exists $kv->{secure};	507	next if $scheme ne "https" && exists $kv->{secure};
445		508
446	if (exists $kv->{_expires} and AE::now > $kv->{_expires}) {	509	if (exists $kv->{_expires} and AE::now > $kv->{_expires}) {
447	delete $cookies->{$cookie};	510	delete $cookies->{$cookie};
448	next;	511	next;
449	}	512	}
…		…
463	\@cookies	526	\@cookies
464	}	527	}
465		528
466	# parse set_cookie header into jar	529	# parse set_cookie header into jar
467	sub cookie_jar_set_cookie($$$$) {	530	sub cookie_jar_set_cookie($$$$) {
468	my ($jar, $set_cookie, $uhost, $date) = @_;	531	my ($jar, $set_cookie, $host, $date) = @_;
		532
		533	%$jar = () if $jar->{version} != 2;
469		534
470	my $anow = int AE::now;	535	my $anow = int AE::now;
471	my $snow; # server-now	536	my $snow; # server-now
472		537
473	for ($set_cookie) {	538	for ($set_cookie) {
…		…
479	while (	544	while (
480	m{	545	m{
481	\G\s*	546	\G\s*
482	(?:	547	(?:
483	expires \s=\s ([A-Z][a-z][a-z]+,\ [^,;]+)	548	expires \s=\s ([A-Z][a-z][a-z]+,\ [^,;]+)
484	\| ([^=;,[:space:]]+) (?: \s=\s (?: "((?:[^\\"]+\|\\.))" \| ([^=;,[:space:]]) ) )?	549	\| ([^=;,[:space:]]+) (?: \s=\s (?: "((?:[^\\"]+\|\\.))" \| ([^;,[:space:]]) ) )?
485	)	550	)
486	}gcxsi	551	}gcxsi
487	) {	552	) {
488	my $name = $2;	553	my $name = $2;
489	my $value = $4;	554	my $value = $4;
…		…
496	# quoted	561	# quoted
497	$value = $3;	562	$value = $3;
498	$value =~ s/\\(.)/$1/gs;	563	$value =~ s/\\(.)/$1/gs;
499	}	564	}
500		565
501	push @kv, lc $name, $value;	566	push @kv, @kv ? lc $name : $name, $value;
502		567
503	last unless /\G\s*;/gc;	568	last unless /\G\s*;/gc;
504	}	569	}
505		570
506	last unless @kv;	571	last unless @kv;
…		…
519		584
520	my $cdom;	585	my $cdom;
521	my $cpath = (delete $kv{path}) \|\| "/";	586	my $cpath = (delete $kv{path}) \|\| "/";
522		587
523	if (exists $kv{domain}) {	588	if (exists $kv{domain}) {
524	$cdom = delete $kv{domain};	589	$cdom = $kv{domain};
525		590
526	$cdom =~ s/^\.?/./; # make sure it starts with a "."	591	$cdom =~ s/^\.?/./; # make sure it starts with a "."
527		592
528	next if $cdom =~ /\.$/;	593	next if $cdom =~ /\.$/;
529		594
530	# this is not rfc-like and not netscape-like. go figure.	595	# this is not rfc-like and not netscape-like. go figure.
531	my $ndots = $cdom =~ y/.//;	596	my $ndots = $cdom =~ y/.//;
532	next if $ndots < ($cdom =~ /\.[^.][^.]\.[^.][^.]$/ ? 3 : 2);	597	next if $ndots < ($cdom =~ /\.[^.][^.]\.[^.][^.]$/ ? 3 : 2);
		598
		599	$cdom = substr $cdom, 1; # remove initial .
533	} else {	600	} else {
534	$cdom = $uhost;	601	$cdom = $host;
535	}	602	}
536		603
537	# store it	604	# store it
538	$jar->{version} = 1;	605	$jar->{version} = 2;
539	$jar->{lc $cdom}{$cpath}{$name} = \%kv;	606	$jar->{lc $cdom}{$cpath}{$name} = \%kv;
540		607
541	redo if /\G\s*,/gc;	608	redo if /\G\s*,/gc;
542	}	609	}
543	}	610	}
544		611
		612	#############################################################################
		613	# keepalive/persistent connection cache
		614
		615	# fetch a connection from the keepalive cache
		616	sub ka_fetch($) {
		617	my $ka_key = shift;
		618
		619	my $hdl = pop @{ $KA_CACHE{$ka_key} }; # currently we reuse the MOST RECENTLY USED connection
		620	delete $KA_CACHE{$ka_key}
		621	unless @{ $KA_CACHE{$ka_key} };
		622
		623	$hdl
		624	}
		625
		626	sub ka_store($$) {
		627	my ($ka_key, $hdl) = @_;
		628
		629	my $kaa = $KA_CACHE{$ka_key} \|\|= [];
		630
		631	my $destroy = sub {
		632	my @ka = grep $_ != $hdl, @{ $KA_CACHE{$ka_key} };
		633
		634	$hdl->destroy;
		635
		636	@ka
		637	? $KA_CACHE{$ka_key} = \@ka
		638	: delete $KA_CACHE{$ka_key};
		639	};
		640
		641	# on error etc., destroy
		642	$hdl->on_error ($destroy);
		643	$hdl->on_eof ($destroy);
		644	$hdl->on_read ($destroy);
		645	$hdl->timeout ($PERSISTENT_TIMEOUT);
		646
		647	push @$kaa, $hdl;
		648	shift @$kaa while @$kaa > $MAX_PER_HOST;
		649	}
		650
		651	#############################################################################
		652	# utilities
		653
545	# continue to parse $_ for headers and place them into the arg	654	# continue to parse $_ for headers and place them into the arg
546	sub parse_hdr() {	655	sub _parse_hdr() {
547	my %hdr;	656	my %hdr;
548		657
549	# things seen, not parsed:	658	# things seen, not parsed:
550	# p3pP="NON CUR OTPi OUR NOR UNI"	659	# p3pP="NON CUR OTPi OUR NOR UNI"
551		660
…		…
565	for values %hdr;	674	for values %hdr;
566		675
567	\%hdr	676	\%hdr
568	}	677	}
569		678
		679	#############################################################################
		680	# http_get
		681
570	our $qr_nlnl = qr{(?<![^\012])\015?\012};	682	our $qr_nlnl = qr{(?<![^\012])\015?\012};
571		683
572	our $TLS_CTX_LOW = { cache => 1, sslv2 => 1 };	684	our $TLS_CTX_LOW = { cache => 1, sslv2 => 1 };
573	our $TLS_CTX_HIGH = { cache => 1, verify => 1, verify_peername => "https" };	685	our $TLS_CTX_HIGH = { cache => 1, verify => 1, verify_peername => "https" };
		686
		687	# maybe it should just become a normal object :/
		688
		689	sub _destroy_state(\%) {
		690	my ($state) = @_;
		691
		692	$state->{handle}->destroy if $state->{handle};
		693	%$state = ();
		694	}
		695
		696	sub _error(\%$$) {
		697	my ($state, $cb, $hdr) = @_;
		698
		699	&_destroy_state ($state);
		700
		701	$cb->(undef, $hdr);
		702	()
		703	}
		704
		705	our %IDEMPOTENT = (
		706	DELETE => 1,
		707	GET => 1,
		708	HEAD => 1,
		709	OPTIONS => 1,
		710	PUT => 1,
		711	TRACE => 1,
		712
		713	ACL => 1,
		714	"BASELINE-CONTROL" => 1,
		715	BIND => 1,
		716	CHECKIN => 1,
		717	CHECKOUT => 1,
		718	COPY => 1,
		719	LABEL => 1,
		720	LINK => 1,
		721	MERGE => 1,
		722	MKACTIVITY => 1,
		723	MKCALENDAR => 1,
		724	MKCOL => 1,
		725	MKREDIRECTREF => 1,
		726	MKWORKSPACE => 1,
		727	MOVE => 1,
		728	ORDERPATCH => 1,
		729	PROPFIND => 1,
		730	PROPPATCH => 1,
		731	REBIND => 1,
		732	REPORT => 1,
		733	SEARCH => 1,
		734	UNBIND => 1,
		735	UNCHECKOUT => 1,
		736	UNLINK => 1,
		737	UNLOCK => 1,
		738	UPDATE => 1,
		739	UPDATEREDIRECTREF => 1,
		740	"VERSION-CONTROL" => 1,
		741	);
574		742
575	sub http_request($$@) {	743	sub http_request($$@) {
576	my $cb = pop;	744	my $cb = pop;
577	my ($method, $url, %arg) = @_;	745	my ($method, $url, %arg) = @_;
578		746
…		…
596	my $recurse = exists $arg{recurse} ? delete $arg{recurse} : $MAX_RECURSE;	764	my $recurse = exists $arg{recurse} ? delete $arg{recurse} : $MAX_RECURSE;
597		765
598	return $cb->(undef, { @pseudo, Status => 599, Reason => "Too many redirections" })	766	return $cb->(undef, { @pseudo, Status => 599, Reason => "Too many redirections" })
599	if $recurse < 0;	767	if $recurse < 0;
600		768
601	my $proxy = $arg{proxy} \|\| $PROXY;	769	my $proxy = exists $arg{proxy} ? $arg{proxy} : $PROXY;
602	my $timeout = $arg{timeout} \|\| $TIMEOUT;	770	my $timeout = $arg{timeout} \|\| $TIMEOUT;
603		771
604	my ($uscheme, $uauthority, $upath, $query, $fragment) =	772	my ($uscheme, $uauthority, $upath, $query, undef) = # ignore fragment
605	$url =~ m\|(?:([^:/?#]+):)?(?://([^/?#]))?([^?#])(?:(\?[^#]))?(?:#(.))?\|;	773	$url =~ m\|^([^:]+):(?://([^/?#]))?([^?#])(?:(\?[^#]))?(?:#(.))?$\|;
606		774
607	$uscheme = lc $uscheme;	775	$uscheme = lc $uscheme;
608		776
609	my $uport = $uscheme eq "http" ? 80	777	my $uport = $uscheme eq "http" ? 80
610	: $uscheme eq "https" ? 443	778	: $uscheme eq "https" ? 443
611	: return $cb->(undef, { @pseudo, Status => 599, Reason => "Only http and https URL schemes supported" });	779	: return $cb->(undef, { @pseudo, Status => 599, Reason => "Only http and https URL schemes supported" });
612		780
613	$uauthority =~ /^(?: .*\@ )? ([^\@:]+) (?: : (\d+) )?$/x	781	$uauthority =~ /^(?: .*\@ )? ([^\@]+?) (?: : (\d+) )?$/x
614	or return $cb->(undef, { @pseudo, Status => 599, Reason => "Unparsable URL" });	782	or return $cb->(undef, { @pseudo, Status => 599, Reason => "Unparsable URL" });
615		783
616	my $uhost = lc $1;	784	my $uhost = lc $1;
617	$uport = $2 if defined $2;	785	$uport = $2 if defined $2;
618		786
…		…
654	$hdr{"user-agent"} = $USERAGENT unless exists $hdr{"user-agent"};	822	$hdr{"user-agent"} = $USERAGENT unless exists $hdr{"user-agent"};
655		823
656	$hdr{"content-length"} = length $arg{body}	824	$hdr{"content-length"} = length $arg{body}
657	if length $arg{body} \|\| $method ne "GET";	825	if length $arg{body} \|\| $method ne "GET";
658		826
659	my $idempotent = $method =~ /^(?:GET\|HEAD\|PUT\|DELETE\|OPTIONS\|TRACE)$/;	827	my $idempotent = $IDEMPOTENT{$method};
660		828
661	# default value for keepalive is true iff the request is for an idempotent method	829	# default value for keepalive is true iff the request is for an idempotent method
662	my $keepalive = exists $arg{keepalive}	830	my $persistent = exists $arg{persistent} ? !!$arg{persistent} : $idempotent;
663	? $arg{keepalive}*1	831	my $keepalive = exists $arg{keepalive} ? !!$arg{keepalive} : !$proxy;
664	: $idempotent ? $PERSISTENT_TIMEOUT : 0;	832	my $was_persistent; # true if this is actually a recycled connection
665		833
		834	# the key to use in the keepalive cache
		835	my $ka_key = "$uscheme\x00$uhost\x00$uport\x00$arg{sessionid}";
		836
666	$hdr{connection} = ($keepalive ? "" : "close ") . "Te"; #1.1	837	$hdr{connection} = ($persistent ? $keepalive ? "keep-alive, " : "" : "close, ") . "Te"; #1.1
667	$hdr{te} = "trailers" unless exists $hdr{te}; #1.1	838	$hdr{te} = "trailers" unless exists $hdr{te}; #1.1
668		839
669	my %state = (connect_guard => 1);	840	my %state = (connect_guard => 1);
670		841
671	my $ae_error = 595; # connecting	842	my $ae_error = 595; # connecting
672		843
673	# handle actual, non-tunneled, request	844	# handle actual, non-tunneled, request
674	my $handle_actual_request = sub {	845	my $handle_actual_request = sub {
675	$ae_error = 596; # request phase	846	$ae_error = 596; # request phase
676		847
		848	my $hdl = $state{handle};
		849
677	$state{handle}->starttls ("connect") if $uscheme eq "https" && !exists $state{handle}{tls};	850	$hdl->starttls ("connect") if $uscheme eq "https" && !exists $hdl->{tls};
678		851
679	# send request	852	# send request
680	$state{handle}->push_write (	853	$hdl->push_write (
681	"$method $rpath HTTP/1.1\015\012"	854	"$method $rpath HTTP/1.1\015\012"
682	. (join "", map "\u$_: $hdr{$_}\015\012", grep defined $hdr{$_}, keys %hdr)	855	. (join "", map "\u$_: $hdr{$_}\015\012", grep defined $hdr{$_}, keys %hdr)
683	. "\015\012"	856	. "\015\012"
684	. (delete $arg{body})	857	. $arg{body}
685	);	858	);
686		859
687	# return if error occured during push_write()	860	# return if error occurred during push_write()
688	return unless %state;	861	return unless %state;
689		862
690	# reduce memory usage, save a kitten, also re-use it for the response headers.	863	# reduce memory usage, save a kitten, also re-use it for the response headers.
691	%hdr = ();	864	%hdr = ();
692		865
693	# status line and headers	866	# status line and headers
694	$state{read_response} = sub {	867	$state{read_response} = sub {
		868	return unless %state;
		869
695	for ("$_[1]") {	870	for ("$_[1]") {
696	y/\015//d; # weed out any \015, as they show up in the weirdest of places.	871	y/\015//d; # weed out any \015, as they show up in the weirdest of places.
697		872
698	/^HTTP\/0([0-9\.]+) \s+ ([0-9]{3}) (?: \s+ ([^\012]) )? \012/gxci	873	/^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" }));	874	or return _error %state, $cb, { @pseudo, Status => 599, Reason => "Invalid server response" };
700		875
701	# 100 Continue handling	876	# 100 Continue handling
702	# should not happen as we don't send expect: 100-continue,	877	# should not happen as we don't send expect: 100-continue,
703	# but we handle it just in case.	878	# but we handle it just in case.
704	# since we send the request body regardless, if we get an error	879	# since we send the request body regardless, if we get an error
…		…
710	HTTPVersion => $1,	885	HTTPVersion => $1,
711	Status => $2,	886	Status => $2,
712	Reason => $3,	887	Reason => $3,
713	;	888	;
714		889
715	my $hdr = parse_hdr	890	my $hdr = _parse_hdr
716	or return (%state = (), $cb->(undef, { @pseudo, Status => 599, Reason => "Garbled response headers" }));	891	or return _error %state, $cb, { @pseudo, Status => 599, Reason => "Garbled response headers" };
717		892
718	%hdr = (%$hdr, @pseudo);	893	%hdr = (%$hdr, @pseudo);
719	}	894	}
720		895
721	# redirect handling	896	# redirect handling
722	# microsoft and other shitheads don't give a shit for following standards,	897	# relative uri handling forced by microsoft and other shitheads.
723	# try to support some common forms of broken Location headers.	898	# we give our best and fall back to URI if available.
724	if ($hdr{location} !~ /^(?: $ \| [^:\/?\#]+ : )/x) {	899	if (exists $hdr{location}) {
		900	my $loc = $hdr{location};
		901
		902	if ($loc =~ m%^//%) { # //
		903	$loc = "$uscheme:$loc";
		904
		905	} elsif ($loc eq "") {
		906	$loc = $url;
		907
		908	} elsif ($loc !~ /^(?: $ \| [^:\/?\#]+ : )/x) { # anything "simple"
725	$hdr{location} =~ s/^\.\/+//;	909	$loc =~ s/^\.\/+//;
726		910
727	my $url = "$rscheme://$uhost:$uport";	911	if ($loc !~ m%^[.?#]%) {
		912	my $prefix = "$uscheme://$uauthority";
728		913
729	unless ($hdr{location} =~ s/^\///) {	914	unless ($loc =~ s/^\///) {
730	$url .= $upath;	915	$prefix .= $upath;
731	$url =~ s/\/[^\/]*$//;	916	$prefix =~ s/\/[^\/]*$//;
		917	}
		918
		919	$loc = "$prefix/$loc";
		920
		921	} elsif (eval { require URI }) { # uri
		922	$loc = URI->new_abs ($loc, $url)->as_string;
		923
		924	} else {
		925	return _error %state, $cb, { @pseudo, Status => 599, Reason => "Cannot parse Location (URI module missing)" };
		926	#$hdr{Status} = 599;
		927	#$hdr{Reason} = "Unparsable Redirect (URI module missing)";
		928	#$recurse = 0;
		929	}
732	}	930	}
733		931
734	$hdr{location} = "$url/$hdr{location}";	932	$hdr{location} = $loc;
735	}	933	}
736		934
737	my $redirect;	935	my $redirect;
738		936
739	if ($recurse) {	937	if ($recurse) {
…		…
741		939
742	# industry standard is to redirect POST as GET for	940	# industry standard is to redirect POST as GET for
743	# 301, 302 and 303, in contrast to HTTP/1.0 and 1.1.	941	# 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,	942	# also, the UA should ask the user for 301 and 307 and POST,
745	# industry standard seems to be to simply follow.	943	# industry standard seems to be to simply follow.
746	# we go with the industry standard.	944	# we go with the industry standard. 308 is defined
		945	# by rfc7538
747	if ($status == 301 or $status == 302 or $status == 303) {	946	if ($status == 301 or $status == 302 or $status == 303) {
		947	$redirect = 1;
748	# HTTP/1.1 is unclear on how to mutate the method	948	# HTTP/1.1 is unclear on how to mutate the method
749	$method = "GET" unless $method eq "HEAD";	949	unless ($method eq "HEAD") {
750	$redirect = 1;	950	$method = "GET";
		951	delete $arg{body};
		952	}
751	} elsif ($status == 307) {	953	} elsif ($status == 307 or $status == 308) {
752	$redirect = 1;	954	$redirect = 1;
753	}	955	}
754	}	956	}
755		957
756	my $finish = sub { # ($data, $err_status, $err_reason[, $keepalive])	958	my $finish = sub { # ($data, $err_status, $err_reason[, $persistent])
757	my $may_keep_alive = $_[3];	959	if ($state{handle}) {
758		960	# handle keepalive
		961	if (
		962	$persistent
		963	&& $_[3]
		964	&& ($hdr{HTTPVersion} < 1.1
		965	? $hdr{connection} =~ /\bkeep-?alive\b/i
		966	: $hdr{connection} !~ /\bclose\b/i)
		967	) {
		968	ka_store $ka_key, delete $state{handle};
		969	} else {
		970	# no keepalive, destroy the handle
759	$state{handle}->destroy if $state{handle};	971	$state{handle}->destroy;
		972	}
		973	}
		974
760	%state = ();	975	%state = ();
761		976
762	if (defined $_[1]) {	977	if (defined $_[1]) {
763	$hdr{OrigStatus} = $hdr{Status}; $hdr{Status} = $_[1];	978	$hdr{OrigStatus} = $hdr{Status}; $hdr{Status} = $_[1];
764	$hdr{OrigReason} = $hdr{Reason}; $hdr{Reason} = $_[2];	979	$hdr{OrigReason} = $hdr{Reason}; $hdr{Reason} = $_[2];
…		…
771		986
772	if ($redirect && exists $hdr{location}) {	987	if ($redirect && exists $hdr{location}) {
773	# we ignore any errors, as it is very common to receive	988	# we ignore any errors, as it is very common to receive
774	# Content-Length != 0 but no actual body	989	# Content-Length != 0 but no actual body
775	# we also access %hdr, as $_[1] might be an erro	990	# we also access %hdr, as $_[1] might be an erro
		991	$state{recurse} =
776	http_request (	992	http_request (
777	$method => $hdr{location},	993	$method => $hdr{location},
778	%arg,	994	%arg,
779	recurse => $recurse - 1,	995	recurse => $recurse - 1,
780	Redirect => [$_[0], \%hdr],	996	Redirect => [$_[0], \%hdr],
		997	sub {
		998	%state = ();
		999	&$cb
		1000	},
781	$cb);	1001	);
782	} else {	1002	} else {
783	$cb->($_[0], \%hdr);	1003	$cb->($_[0], \%hdr);
784	}	1004	}
785	};	1005	};
786		1006
787	$ae_error = 597; # body phase	1007	$ae_error = 597; # body phase
788		1008
		1009	my $chunked = $hdr{"transfer-encoding"} =~ /\bchunked\b/i; # not quite correct...
		1010
789	my $len = $hdr{"content-length"};	1011	my $len = $chunked ? undef : $hdr{"content-length"};
790		1012
791	# body handling, many different code paths	1013	# body handling, many different code paths
792	# - no body expected	1014	# - no body expected
793	# - want_body_handle	1015	# - want_body_handle
794	# - te chunked	1016	# - te chunked
…		…
809	$_[0]->on_error (undef);	1031	$_[0]->on_error (undef);
810	$_[0]->on_read (undef);	1032	$_[0]->on_read (undef);
811		1033
812	$finish->(delete $state{handle});	1034	$finish->(delete $state{handle});
813		1035
814	} elsif ($hdr{"transfer-encoding"} =~ /\bchunked\b/i) {	1036	} elsif ($chunked) {
815	my $cl = 0;	1037	my $cl = 0;
816	my $body = undef;	1038	my $body = "";
817	my $on_body = $arg{on_body} \|\| sub { $body .= shift; 1 };	1039	my $on_body = (!$redirect && $arg{on_body}) \|\| sub { $body .= shift; 1 };
818		1040
819	$state{read_chunk} = sub {	1041	$state{read_chunk} = sub {
820	$_[1] =~ /^([0-9a-fA-F]+)/	1042	$_[1] =~ /^([0-9a-fA-F]+)/
821	or $finish->(undef, $ae_error => "Garbled chunked transfer encoding");	1043	or return $finish->(undef, $ae_error => "Garbled chunked transfer encoding");
822		1044
823	my $len = hex $1;	1045	my $len = hex $1;
824		1046
825	if ($len) {	1047	if ($len) {
826	$cl += $len;	1048	$cl += $len;
…		…
841	$_[0]->push_read (line => $qr_nlnl, sub {	1063	$_[0]->push_read (line => $qr_nlnl, sub {
842	if (length $_[1]) {	1064	if (length $_[1]) {
843	for ("$_[1]") {	1065	for ("$_[1]") {
844	y/\015//d; # weed out any \015, as they show up in the weirdest of places.	1066	y/\015//d; # weed out any \015, as they show up in the weirdest of places.
845		1067
846	my $hdr = parse_hdr	1068	my $hdr = _parse_hdr
847	or return $finish->(undef, $ae_error => "Garbled response trailers");	1069	or return $finish->(undef, $ae_error => "Garbled response trailers");
848		1070
849	%hdr = (%hdr, %$hdr);	1071	%hdr = (%hdr, %$hdr);
850	}	1072	}
851	}	1073	}
…		…
855	}	1077	}
856	};	1078	};
857		1079
858	$_[0]->push_read (line => $state{read_chunk});	1080	$_[0]->push_read (line => $state{read_chunk});
859		1081
860	} elsif ($arg{on_body}) {	1082	} elsif (!$redirect && $arg{on_body}) {
861	if (defined $len) {	1083	if (defined $len) {
862	$_[0]->on_read (sub {	1084	$_[0]->on_read (sub {
863	$len -= length $_[0]{rbuf};	1085	$len -= length $_[0]{rbuf};
864		1086
865	$arg{on_body}(delete $_[0]{rbuf}, \%hdr)	1087	$arg{on_body}(delete $_[0]{rbuf}, \%hdr)
…		…
894	$_[0]->on_read (sub { });	1116	$_[0]->on_read (sub { });
895	}	1117	}
896	}	1118	}
897	};	1119	};
898		1120
		1121	# if keepalive is enabled, then the server closing the connection
		1122	# before a response can happen legally - we retry on idempotent methods.
		1123	if ($was_persistent && $idempotent) {
		1124	my $old_eof = $hdl->{on_eof};
		1125	$hdl->{on_eof} = sub {
		1126	_destroy_state %state;
		1127
		1128	%state = ();
		1129	$state{recurse} =
		1130	http_request (
		1131	$method => $url,
		1132	%arg,
		1133	recurse => $recurse - 1,
		1134	persistent => 0,
		1135	sub {
		1136	%state = ();
		1137	&$cb
		1138	}
		1139	);
		1140	};
		1141	$hdl->on_read (sub {
		1142	return unless %state;
		1143
		1144	# as soon as we receive something, a connection close
		1145	# once more becomes a hard error
		1146	$hdl->{on_eof} = $old_eof;
		1147	$hdl->push_read (line => $qr_nlnl, $state{read_response});
		1148	});
		1149	} else {
899	$state{handle}->push_read (line => $qr_nlnl, $state{read_response});	1150	$hdl->push_read (line => $qr_nlnl, $state{read_response});
		1151	}
900	};	1152	};
901		1153
		1154	my $prepare_handle = sub {
		1155	my ($hdl) = $state{handle};
		1156
		1157	$hdl->on_error (sub {
		1158	_error %state, $cb, { @pseudo, Status => $ae_error, Reason => $_[2] };
		1159	});
		1160	$hdl->on_eof (sub {
		1161	_error %state, $cb, { @pseudo, Status => $ae_error, Reason => "Unexpected end-of-file" };
		1162	});
		1163	$hdl->timeout_reset;
		1164	$hdl->timeout ($timeout);
		1165	};
		1166
		1167	# connected to proxy (or origin server)
902	my $connect_cb = sub {	1168	my $connect_cb = sub {
903	$state{fh} = shift	1169	my $fh = shift
904	or do {
905	my $err = "$!";
906	%state = ();
907	return $cb->(undef, { @pseudo, Status => $ae_error, Reason => $err });	1170	or return _error %state, $cb, { @pseudo, Status => $ae_error, Reason => "$!" };
908	};
909		1171
910	return unless delete $state{connect_guard};	1172	return unless delete $state{connect_guard};
911		1173
912	# get handle	1174	# get handle
913	$state{handle} = new AnyEvent::Handle	1175	$state{handle} = new AnyEvent::Handle
		1176	%{ $arg{handle_params} },
914	fh => $state{fh},	1177	fh => $fh,
915	peername => $rhost,	1178	peername => $uhost,
916	tls_ctx => $arg{tls_ctx},	1179	tls_ctx => $arg{tls_ctx},
917	# these need to be reconfigured on keepalive handles
918	timeout => $timeout,
919	on_error => sub {
920	%state = ();
921	$cb->(undef, { @pseudo, Status => $ae_error, Reason => $_[2] });
922	},
923	on_eof => sub {
924	%state = ();
925	$cb->(undef, { @pseudo, Status => $ae_error, Reason => "Unexpected end-of-file" });
926	},
927	;	1180	;
928		1181
929	# limit the number of persistent connections	1182	$prepare_handle->();
930	# keepalive not yet supported
931	# if ($KA_COUNT{$_[1]} < $MAX_PERSISTENT_PER_HOST) {
932	# ++$KA_COUNT{$_[1]};
933	# $state{handle}{ka_count_guard} = AnyEvent::Util::guard {
934	# --$KA_COUNT{$_[1]}
935	# };
936	# $hdr{connection} = "keep-alive";
937	# }
938		1183
939	$state{handle}->starttls ("connect") if $rscheme eq "https";	1184	#$state{handle}->starttls ("connect") if $rscheme eq "https";
940		1185
941	# now handle proxy-CONNECT method	1186	# now handle proxy-CONNECT method
942	if ($proxy && $uscheme eq "https") {	1187	if ($proxy && $uscheme eq "https") {
943	# oh dear, we have to wrap it into a connect request	1188	# oh dear, we have to wrap it into a connect request
944		1189
		1190	my $auth = exists $hdr{"proxy-authorization"}
		1191	? "proxy-authorization: " . (delete $hdr{"proxy-authorization"}) . "\015\012"
		1192	: "";
		1193
945	# maybe re-use $uauthority with patched port?	1194	# maybe re-use $uauthority with patched port?
946	$state{handle}->push_write ("CONNECT $uhost:$uport HTTP/1.0\015\012\015\012");	1195	$state{handle}->push_write ("CONNECT $uhost:$uport HTTP/1.0\015\012$auth\015\012");
947	$state{handle}->push_read (line => $qr_nlnl, sub {	1196	$state{handle}->push_read (line => $qr_nlnl, sub {
948	$_[1] =~ /^HTTP\/([0-9\.]+) \s+ ([0-9]{3}) (?: \s+ ([^\015\012]*) )?/ix	1197	$_[1] =~ /^HTTP\/([0-9\.]+) \s+ ([0-9]{3}) (?: \s+ ([^\015\012]*) )?/ix
949	or return (%state = (), $cb->(undef, { @pseudo, Status => 599, Reason => "Invalid proxy connect response ($_[1])" }));	1198	or return _error %state, $cb, { @pseudo, Status => 599, Reason => "Invalid proxy connect response ($_[1])" };
950		1199
951	if ($2 == 200) {	1200	if ($2 == 200) {
952	$rpath = $upath;	1201	$rpath = $upath;
953	$handle_actual_request->();	1202	$handle_actual_request->();
954	} else {	1203	} else {
955	%state = ();
956	$cb->(undef, { @pseudo, Status => $2, Reason => $3 });	1204	_error %state, $cb, { @pseudo, Status => $2, Reason => $3 };
957	}	1205	}
958	});	1206	});
959	} else {	1207	} else {
		1208	delete $hdr{"proxy-authorization"} unless $proxy;
		1209
960	$handle_actual_request->();	1210	$handle_actual_request->();
961	}	1211	}
962	};	1212	};
963		1213
964	_get_slot $uhost, sub {	1214	_get_slot $uhost, sub {
965	$state{slot_guard} = shift;	1215	$state{slot_guard} = shift;
966		1216
967	return unless $state{connect_guard};	1217	return unless $state{connect_guard};
968		1218
		1219	# try to use an existing keepalive connection, but only if we, ourselves, plan
		1220	# on a keepalive request (in theory, this should be a separate config option).
		1221	if ($persistent && $KA_CACHE{$ka_key}) {
		1222	$was_persistent = 1;
		1223
		1224	$state{handle} = ka_fetch $ka_key;
		1225	# $state{handle}->destroyed
		1226	# and die "AnyEvent::HTTP: unexpectedly got a destructed handle (1), please report.";#d#
		1227	$prepare_handle->();
		1228	# $state{handle}->destroyed
		1229	# and die "AnyEvent::HTTP: unexpectedly got a destructed handle (2), please report.";#d#
		1230	$handle_actual_request->();
		1231
		1232	} else {
969	my $tcp_connect = $arg{tcp_connect}	1233	my $tcp_connect = $arg{tcp_connect}
970	\|\| do { require AnyEvent::Socket; \&AnyEvent::Socket::tcp_connect };	1234	\|\| do { require AnyEvent::Socket; \&AnyEvent::Socket::tcp_connect };
971		1235
972	$state{connect_guard} = $tcp_connect->($rhost, $rport, $connect_cb, $arg{on_prepare} \|\| sub { $timeout });	1236	$state{connect_guard} = $tcp_connect->($rhost, $rport, $connect_cb, $arg{on_prepare} \|\| sub { $timeout });
		1237	}
973	};	1238	};
974		1239
975	defined wantarray && AnyEvent::Util::guard { %state = () }	1240	defined wantarray && AnyEvent::Util::guard { _destroy_state %state }
976	}	1241	}
977		1242
978	sub http_get($@) {	1243	sub http_get($@) {
979	unshift @_, "GET";	1244	unshift @_, "GET";
980	&http_request	1245	&http_request
…		…
998	AnyEvent::HTTP uses the AnyEvent::Socket::tcp_connect function for	1263	AnyEvent::HTTP uses the AnyEvent::Socket::tcp_connect function for
999	the actual connection, which in turn uses AnyEvent::DNS to resolve	1264	the actual connection, which in turn uses AnyEvent::DNS to resolve
1000	hostnames. The latter is a simple stub resolver and does no caching	1265	hostnames. The latter is a simple stub resolver and does no caching
1001	on its own. If you want DNS caching, you currently have to provide	1266	on its own. If you want DNS caching, you currently have to provide
1002	your own default resolver (by storing a suitable resolver object in	1267	your own default resolver (by storing a suitable resolver object in
1003	C<$AnyEvent::DNS::RESOLVER>).	1268	C<$AnyEvent::DNS::RESOLVER>) or your own C<tcp_connect> callback.
1004		1269
1005	=head2 GLOBAL FUNCTIONS AND VARIABLES	1270	=head2 GLOBAL FUNCTIONS AND VARIABLES
1006		1271
1007	=over 4	1272	=over 4
1008		1273
1009	=item AnyEvent::HTTP::set_proxy "proxy-url"	1274	=item AnyEvent::HTTP::set_proxy "proxy-url"
1010		1275
1011	Sets the default proxy server to use. The proxy-url must begin with a	1276	Sets the default proxy server to use. The proxy-url must begin with a
1012	string of the form C<http://host:port> (optionally C<https:...>), croaks	1277	string of the form C<http://host:port>, croaks otherwise.
1013	otherwise.
1014		1278
1015	To clear an already-set proxy, use C<undef>.	1279	To clear an already-set proxy, use C<undef>.
		1280
		1281	When AnyEvent::HTTP is loaded for the first time it will query the
		1282	default proxy from the operating system, currently by looking at
		1283	C<$ENV{http_proxy>}.
1016		1284
1017	=item AnyEvent::HTTP::cookie_jar_expire $jar[, $session_end]	1285	=item AnyEvent::HTTP::cookie_jar_expire $jar[, $session_end]
1018		1286
1019	Remove all cookies from the cookie jar that have been expired. If	1287	Remove all cookies from the cookie jar that have been expired. If
1020	C<$session_end> is given and true, then additionally remove all session	1288	C<$session_end> is given and true, then additionally remove all session
1021	cookies.	1289	cookies.
1022		1290
1023	You should call this function (with a true C<$session_end>) before you	1291	You should call this function (with a true C<$session_end>) before you
1024	save cookies to disk, and you should call this function after loading them	1292	save cookies to disk, and you should call this function after loading them
1025	again. If you have a long-running program you can additonally call this	1293	again. If you have a long-running program you can additionally call this
1026	function from time to time.	1294	function from time to time.
1027		1295
1028	A cookie jar is initially an empty hash-reference that is managed by this	1296	A cookie jar is initially an empty hash-reference that is managed by this
1029	module. It's format is subject to change, but currently it is like this:	1297	module. Its format is subject to change, but currently it is as follows:
1030		1298
1031	The key C<version> has to contain C<1>, otherwise the hash gets	1299	The key C<version> has to contain C<2>, otherwise the hash gets
1032	emptied. All other keys are hostnames or IP addresses pointing to	1300	cleared. All other keys are hostnames or IP addresses pointing to
1033	hash-references. The key for these inner hash references is the	1301	hash-references. The key for these inner hash references is the
1034	server path for which this cookie is meant, and the values are again	1302	server path for which this cookie is meant, and the values are again
1035	hash-references. The keys of those hash-references is the cookie name, and	1303	hash-references. Each key of those hash-references is a cookie name, and
1036	the value, you guessed it, is another hash-reference, this time with the	1304	the value, you guessed it, is another hash-reference, this time with the
1037	key-value pairs from the cookie, except for C<expires> and C<max-age>,	1305	key-value pairs from the cookie, except for C<expires> and C<max-age>,
1038	which have been replaced by a C<_expires> key that contains the cookie	1306	which have been replaced by a C<_expires> key that contains the cookie
1039	expiry timestamp.	1307	expiry timestamp. Session cookies are indicated by not having an
		1308	C<_expires> key.
1040		1309
1041	Here is an example of a cookie jar with a single cookie, so you have a	1310	Here is an example of a cookie jar with a single cookie, so you have a
1042	chance of understanding the above paragraph:	1311	chance of understanding the above paragraph:
1043		1312
1044	{	1313	{
…		…
1066		1335
1067	=item $AnyEvent::HTTP::MAX_RECURSE	1336	=item $AnyEvent::HTTP::MAX_RECURSE
1068		1337
1069	The default value for the C<recurse> request parameter (default: C<10>).	1338	The default value for the C<recurse> request parameter (default: C<10>).
1070		1339
		1340	=item $AnyEvent::HTTP::TIMEOUT
		1341
		1342	The default timeout for connection operations (default: C<300>).
		1343
1071	=item $AnyEvent::HTTP::USERAGENT	1344	=item $AnyEvent::HTTP::USERAGENT
1072		1345
1073	The default value for the C<User-Agent> header (the default is	1346	The default value for the C<User-Agent> header (the default is
1074	C<Mozilla/5.0 (compatible; U; AnyEvent-HTTP/$VERSION; +http://software.schmorp.de/pkg/AnyEvent)>).	1347	C<Mozilla/5.0 (compatible; U; AnyEvent-HTTP/$VERSION; +http://software.schmorp.de/pkg/AnyEvent)>).
1075		1348
1076	=item $AnyEvent::HTTP::MAX_PER_HOST	1349	=item $AnyEvent::HTTP::MAX_PER_HOST
1077		1350
1078	The maximum number of concurrent connections to the same host (identified	1351	The maximum number of concurrent connections to the same host (identified
1079	by the hostname). If the limit is exceeded, then the additional requests	1352	by the hostname). If the limit is exceeded, then additional requests
1080	are queued until previous connections are closed.	1353	are queued until previous connections are closed. Both persistent and
		1354	non-persistent connections are counted in this limit.
1081		1355
1082	The default value for this is C<4>, and it is highly advisable to not	1356	The default value for this is C<4>, and it is highly advisable to not
1083	increase it.	1357	increase it much.
		1358
		1359	For comparison: the RFC's recommend 4 non-persistent or 2 persistent
		1360	connections, older browsers used 2, newer ones (such as firefox 3)
		1361	typically use 6, and Opera uses 8 because like, they have the fastest
		1362	browser and give a shit for everybody else on the planet.
		1363
		1364	=item $AnyEvent::HTTP::PERSISTENT_TIMEOUT
		1365
		1366	The time after which idle persistent connections get closed by
		1367	AnyEvent::HTTP (default: C<3>).
1084		1368
1085	=item $AnyEvent::HTTP::ACTIVE	1369	=item $AnyEvent::HTTP::ACTIVE
1086		1370
1087	The number of active connections. This is not the number of currently	1371	The number of active connections. This is not the number of currently
1088	running requests, but the number of currently open and non-idle TCP	1372	running requests, but the number of currently open and non-idle TCP
1089	connections. This number of can be useful for load-leveling.	1373	connections. This number can be useful for load-leveling.
1090		1374
1091	=back	1375	=back
1092		1376
1093	=cut	1377	=cut
1094		1378
…		…
1128	# other formats fail in the loop below	1412	# other formats fail in the loop below
1129		1413
1130	for (0..11) {	1414	for (0..11) {
1131	if ($m eq $month[$_]) {	1415	if ($m eq $month[$_]) {
1132	require Time::Local;	1416	require Time::Local;
1133	return Time::Local::timegm ($S, $M, $H, $d, $_, $y);	1417	return eval { Time::Local::timegm ($S, $M, $H, $d, $_, $y) };
1134	}	1418	}
1135	}	1419	}
1136		1420
1137	undef	1421	undef
1138	}	1422	}
1139		1423
1140	sub set_proxy($) {	1424	sub set_proxy($) {
1141	if (length $_[0]) {	1425	if (length $_[0]) {
1142	$_[0] =~ m%^(https?):// ([^:/]+) (?: : (\d*) )?%ix	1426	$_[0] =~ m%^(http):// ([^:/]+) (?: : (\d*) )?%ix
1143	or Carp::croak "$_[0]: invalid proxy URL";	1427	or Carp::croak "$_[0]: invalid proxy URL";
1144	$PROXY = [$2, $3 \|\| 3128, $1]	1428	$PROXY = [$2, $3 \|\| 3128, $1]
1145	} else {	1429	} else {
1146	undef $PROXY;	1430	undef $PROXY;
1147	}	1431	}
…		…
1150	# initialise proxy from environment	1434	# initialise proxy from environment
1151	eval {	1435	eval {
1152	set_proxy $ENV{http_proxy};	1436	set_proxy $ENV{http_proxy};
1153	};	1437	};
1154		1438
		1439	=head2 SHOWCASE
		1440
		1441	This section contains some more elaborate "real-world" examples or code
		1442	snippets.
		1443
		1444	=head2 HTTP/1.1 FILE DOWNLOAD
		1445
		1446	Downloading files with HTTP can be quite tricky, especially when something
		1447	goes wrong and you want to resume.
		1448
		1449	Here is a function that initiates and resumes a download. It uses the
		1450	last modified time to check for file content changes, and works with many
		1451	HTTP/1.0 servers as well, and usually falls back to a complete re-download
		1452	on older servers.
		1453
		1454	It calls the completion callback with either C<undef>, which means a
		1455	nonretryable error occurred, C<0> when the download was partial and should
		1456	be retried, and C<1> if it was successful.
		1457
		1458	use AnyEvent::HTTP;
		1459
		1460	sub download($$$) {
		1461	my ($url, $file, $cb) = @_;
		1462
		1463	open my $fh, "+<", $file
		1464	or die "$file: $!";
		1465
		1466	my %hdr;
		1467	my $ofs = 0;
		1468
		1469	if (stat $fh and -s _) {
		1470	$ofs = -s _;
		1471	warn "-s is ", $ofs;
		1472	$hdr{"if-unmodified-since"} = AnyEvent::HTTP::format_date +(stat _)[9];
		1473	$hdr{"range"} = "bytes=$ofs-";
		1474	}
		1475
		1476	http_get $url,
		1477	headers => \%hdr,
		1478	on_header => sub {
		1479	my ($hdr) = @_;
		1480
		1481	if ($hdr->{Status} == 200 && $ofs) {
		1482	# resume failed
		1483	truncate $fh, $ofs = 0;
		1484	}
		1485
		1486	sysseek $fh, $ofs, 0;
		1487
		1488	1
		1489	},
		1490	on_body => sub {
		1491	my ($data, $hdr) = @_;
		1492
		1493	if ($hdr->{Status} =~ /^2/) {
		1494	length $data == syswrite $fh, $data
		1495	or return; # abort on write errors
		1496	}
		1497
		1498	1
		1499	},
		1500	sub {
		1501	my (undef, $hdr) = @_;
		1502
		1503	my $status = $hdr->{Status};
		1504
		1505	if (my $time = AnyEvent::HTTP::parse_date $hdr->{"last-modified"}) {
		1506	utime $time, $time, $fh;
		1507	}
		1508
		1509	if ($status == 200 \|\| $status == 206 \|\| $status == 416) {
		1510	# download ok \|\| resume ok \|\| file already fully downloaded
		1511	$cb->(1, $hdr);
		1512
		1513	} elsif ($status == 412) {
		1514	# file has changed while resuming, delete and retry
		1515	unlink $file;
		1516	$cb->(0, $hdr);
		1517
		1518	} elsif ($status == 500 or $status == 503 or $status =~ /^59/) {
		1519	# retry later
		1520	$cb->(0, $hdr);
		1521
		1522	} else {
		1523	$cb->(undef, $hdr);
		1524	}
		1525	}
		1526	;
		1527	}
		1528
		1529	download "http://server/somelargefile", "/tmp/somelargefile", sub {
		1530	if ($_[0]) {
		1531	print "OK!\n";
		1532	} elsif (defined $_[0]) {
		1533	print "please retry later\n";
		1534	} else {
		1535	print "ERROR\n";
		1536	}
		1537	};
		1538
1155	=head2 SOCKS PROXIES	1539	=head3 SOCKS PROXIES
1156		1540
1157	Socks proxies are not directly supported by AnyEvent::HTTP. You can	1541	Socks proxies are not directly supported by AnyEvent::HTTP. You can
1158	compile your perl to support socks, or use an external program such as	1542	compile your perl to support socks, or use an external program such as
1159	F<socksify> (dante) or F<tsocks> to make your program use a socks proxy	1543	F<socksify> (dante) or F<tsocks> to make your program use a socks proxy
1160	transparently.	1544	transparently.

Diff Legend

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

Comparing AnyEvent-HTTP/HTTP.pm (file contents): Revision 1.90 by root, Mon Jan 3 00:41:25 2011 UTC vs. Revision 1.131 by root, Thu Aug 30 17:04:28 2018 UTC

Diff Legend

Comparing AnyEvent-HTTP/HTTP.pm (file contents):
Revision 1.90 by root, Mon Jan 3 00:41:25 2011 UTC vs.
Revision 1.131 by root, Thu Aug 30 17:04:28 2018 UTC