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

Comparing AnyEvent-HTTP/HTTP.pm (file contents):
Revision 1.89 by root, Mon Jan 3 00:23:25 2011 UTC vs.
Revision 1.133 by root, Sat Sep 1 03:16:43 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
170	will provide defaults at least for C<TE:>, C<Referer:> and C<User-Agent:>	171	will provide defaults at least for C<TE:>, C<Referer:> and C<User-Agent:>
171	(this can be suppressed by using C<undef> for these headers in which case	172	(this can be suppressed by using C<undef> for these headers in which case
172	they won't be sent at all).	173	they won't be sent at all).
173		174
		175	You really should provide your own C<User-Agent:> header value that is
		176	appropriate for your program - I wouldn't be surprised if the default
		177	AnyEvent string gets blocked by webservers sooner or later.
		178
		179	Also, make sure that your headers names and values do not contain any
		180	embedded newlines.
		181
174	=item timeout => $seconds	182	=item timeout => $seconds
175		183
176	The time-out to use for various stages - each connect attempt will reset	184	The time-out to use for various stages - each connect attempt will reset
177	the timeout, as will read or write activity, i.e. this is not an overall	185	the timeout, as will read or write activity, i.e. this is not an overall
178	timeout.	186	timeout.
179		187
180	Default timeout is 5 minutes.	188	Default timeout is 5 minutes.
181		189
182	=item proxy => [$host, $port[, $scheme]] or undef	190	=item proxy => [$host, $port[, $scheme]] or undef
183		191
184	Use the given http proxy for all requests. If not specified, then the	192	Use the given http proxy for all requests, or no proxy if C<undef> is
185	default proxy (as specified by C<$ENV{http_proxy}>) is used.	193	used.
186		194
187	C<$scheme> must be either missing, C<http> for HTTP or C<https> for	195	C<$scheme> must be either missing or must be C<http> for HTTP.
188	HTTPS.	196
		197	If not specified, then the default proxy is used (see
		198	C<AnyEvent::HTTP::set_proxy>).
		199
		200	Currently, if your proxy requires authorization, you have to specify an
		201	appropriate "Proxy-Authorization" header in every request.
189		202
190	=item body => $string	203	=item body => $string
191		204
192	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
193	this module might offer more options).	206	this module might offer more options).
…		…
224	verification) TLS context.	237	verification) TLS context.
225		238
226	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
227	me the page, no matter what".	240	me the page, no matter what".
228		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
229	=item on_prepare => $callback->($fh)	252	=item on_prepare => $callback->($fh)
230		253
231	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
232	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
233	overrides the prepare callback passed to C<AnyEvent::Socket::tcp_connect>	256	overrides the prepare callback passed to C<AnyEvent::Socket::tcp_connect>
234	and behaves exactly the same way (e.g. it has to provide a	257	and behaves exactly the same way (e.g. it has to provide a
235	timeout). See the description for the C<$prepare_cb> argument of	258	timeout). See the description for the C<$prepare_cb> argument of
236	C<AnyEvent::Socket::tcp_connect> for details.	259	C<AnyEvent::Socket::tcp_connect> for details.
237		260
…		…
302	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
303	callback will receive the L<AnyEvent::Handle> object associated with the	326	callback will receive the L<AnyEvent::Handle> object associated with the
304	connection. In error cases, C<undef> will be passed. When there is no body	327	connection. In error cases, C<undef> will be passed. When there is no body
305	(e.g. status C<304>), the empty string will be passed.	328	(e.g. status C<304>), the empty string will be passed.
306		329
307	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
308	a proxy, be a persistent connection etc., and configured in unspecified	331	to a proxy, be a persistent connection, use chunked transfer encoding
309	ways. The user is responsible for this handle (it will not be used by this	332	etc., and configured in unspecified ways. The user is responsible for this
310	module anymore).	333	handle (it will not be used by this module anymore).
311		334
312	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
313	headers, an interactive protocol is used (typical example would be the	336	headers, an interactive protocol is used (typical example would be the
314	push-style twitter API which starts a JSON/XML stream).	337	push-style twitter API which starts a JSON/XML stream).
315		338
316	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
317	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 same host (i.e. identical URL scheme, hostname,
		348	port and session) and, failing that, tries to create a new 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	},
318		382
319	=back	383	=back
320		384
321	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
322	the response body.	386	the response body.
…		…
328		392
329	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
330	timeout of 30 seconds.	394	timeout of 30 seconds.
331		395
332	http_request	396	http_request
333	GET => "https://www.google.com",	397	HEAD => "https://www.google.com",
		398	headers => { "user-agent" => "MySearchClient 1.0" },
334	timeout => 30,	399	timeout => 30,
335	sub {	400	sub {
336	my ($body, $hdr) = @_;	401	my ($body, $hdr) = @_;
337	use Data::Dumper;	402	use Data::Dumper;
338	print Dumper $hdr;	403	print Dumper $hdr;
…		…
348	};	413	};
349		414
350	undef $request;	415	undef $request;
351		416
352	=cut	417	=cut
		418
		419	#############################################################################
		420	# wait queue/slots
353		421
354	sub _slot_schedule;	422	sub _slot_schedule;
355	sub _slot_schedule($) {	423	sub _slot_schedule($) {
356	my $host = shift;	424	my $host = shift;
357		425
…		…
380		448
381	_slot_schedule $_[0];	449	_slot_schedule $_[0];
382	}	450	}
383		451
384	#############################################################################	452	#############################################################################
		453	# cookie handling
385		454
386	# expire cookies	455	# expire cookies
387	sub cookie_jar_expire($;$) {	456	sub cookie_jar_expire($;$) {
388	my ($jar, $session_end) = @_;	457	my ($jar, $session_end) = @_;
389		458
390	%$jar = () if $jar->{version} != 1;	459	%$jar = () if $jar->{version} != 2;
391		460
392	my $anow = AE::now;	461	my $anow = AE::now;
393		462
394	while (my ($chost, $paths) = each %$jar) {	463	while (my ($chost, $paths) = each %$jar) {
395	next unless ref $paths;	464	next unless ref $paths;
…		…
413	}	482	}
414	}	483	}
415		484
416	# extract cookies from jar	485	# extract cookies from jar
417	sub cookie_jar_extract($$$$) {	486	sub cookie_jar_extract($$$$) {
418	my ($jar, $uscheme, $uhost, $upath) = @_;	487	my ($jar, $scheme, $host, $path) = @_;
419		488
420	%$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]/;
421		493
422	my @cookies;	494	my @cookies;
423		495
424	while (my ($chost, $paths) = each %$jar) {	496	while (my ($chost, $paths) = each %$jar) {
425	next unless ref $paths;	497	next unless ref $paths;
426		498
427	if ($chost =~ /^\./) {	499	# exact match or suffix including . match
428	next unless $chost eq substr $uhost, -length $chost;	500	$chost eq $host or ".$chost" eq substr $host, -1 - length $chost
429	} elsif ($chost =~ /\./) {
430	next unless $chost eq $uhost;
431	} else {
432	next;	501	or next;
433	}
434		502
435	while (my ($cpath, $cookies) = each %$paths) {	503	while (my ($cpath, $cookies) = each %$paths) {
436	next unless $cpath eq substr $upath, 0, length $cpath;	504	next unless $cpath eq substr $path, 0, length $cpath;
437		505
438	while (my ($cookie, $kv) = each %$cookies) {	506	while (my ($cookie, $kv) = each %$cookies) {
439	next if $uscheme ne "https" && exists $kv->{secure};	507	next if $scheme ne "https" && exists $kv->{secure};
440		508
441	if (exists $kv->{_expires} and AE::now > $kv->{_expires}) {	509	if (exists $kv->{_expires} and AE::now > $kv->{_expires}) {
442	delete $cookies->{$cookie};	510	delete $cookies->{$cookie};
443	next;	511	next;
444	}	512	}
…		…
458	\@cookies	526	\@cookies
459	}	527	}
460		528
461	# parse set_cookie header into jar	529	# parse set_cookie header into jar
462	sub cookie_jar_set_cookie($$$$) {	530	sub cookie_jar_set_cookie($$$$) {
463	my ($jar, $set_cookie, $uhost, $date) = @_;	531	my ($jar, $set_cookie, $host, $date) = @_;
		532
		533	%$jar = () if $jar->{version} != 2;
464		534
465	my $anow = int AE::now;	535	my $anow = int AE::now;
466	my $snow; # server-now	536	my $snow; # server-now
467		537
468	for ($set_cookie) {	538	for ($set_cookie) {
…		…
474	while (	544	while (
475	m{	545	m{
476	\G\s*	546	\G\s*
477	(?:	547	(?:
478	expires \s=\s ([A-Z][a-z][a-z]+,\ [^,;]+)	548	expires \s=\s ([A-Z][a-z][a-z]+,\ [^,;]+)
479	\| ([^=;,[:space:]]+) (?: \s=\s (?: "((?:[^\\"]+\|\\.))" \| ([^=;,[:space:]]) ) )?	549	\| ([^=;,[:space:]]+) (?: \s=\s (?: "((?:[^\\"]+\|\\.))" \| ([^;,[:space:]]) ) )?
480	)	550	)
481	}gcxsi	551	}gcxsi
482	) {	552	) {
483	my $name = $2;	553	my $name = $2;
484	my $value = $4;	554	my $value = $4;
…		…
491	# quoted	561	# quoted
492	$value = $3;	562	$value = $3;
493	$value =~ s/\\(.)/$1/gs;	563	$value =~ s/\\(.)/$1/gs;
494	}	564	}
495		565
496	push @kv, lc $name, $value;	566	push @kv, @kv ? lc $name : $name, $value;
497		567
498	last unless /\G\s*;/gc;	568	last unless /\G\s*;/gc;
499	}	569	}
500		570
501	last unless @kv;	571	last unless @kv;
…		…
514		584
515	my $cdom;	585	my $cdom;
516	my $cpath = (delete $kv{path}) \|\| "/";	586	my $cpath = (delete $kv{path}) \|\| "/";
517		587
518	if (exists $kv{domain}) {	588	if (exists $kv{domain}) {
519	$cdom = delete $kv{domain};	589	$cdom = $kv{domain};
520		590
521	$cdom =~ s/^\.?/./; # make sure it starts with a "."	591	$cdom =~ s/^\.?/./; # make sure it starts with a "."
522		592
523	next if $cdom =~ /\.$/;	593	next if $cdom =~ /\.$/;
524		594
525	# this is not rfc-like and not netscape-like. go figure.	595	# this is not rfc-like and not netscape-like. go figure.
526	my $ndots = $cdom =~ y/.//;	596	my $ndots = $cdom =~ y/.//;
527	next if $ndots < ($cdom =~ /\.[^.][^.]\.[^.][^.]$/ ? 3 : 2);	597	next if $ndots < ($cdom =~ /\.[^.][^.]\.[^.][^.]$/ ? 3 : 2);
		598
		599	$cdom = substr $cdom, 1; # remove initial .
528	} else {	600	} else {
529	$cdom = $uhost;	601	$cdom = $host;
530	}	602	}
531		603
532	# store it	604	# store it
533	$jar->{version} = 1;	605	$jar->{version} = 2;
534	$jar->{lc $cdom}{$cpath}{$name} = \%kv;	606	$jar->{lc $cdom}{$cpath}{$name} = \%kv;
535		607
536	redo if /\G\s*,/gc;	608	redo if /\G\s*,/gc;
537	}	609	}
538	}	610	}
539		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
540	# continue to parse $_ for headers and place them into the arg	654	# continue to parse $_ for headers and place them into the arg
541	sub parse_hdr() {	655	sub _parse_hdr() {
542	my %hdr;	656	my %hdr;
543		657
544	# things seen, not parsed:	658	# things seen, not parsed:
545	# p3pP="NON CUR OTPi OUR NOR UNI"	659	# p3pP="NON CUR OTPi OUR NOR UNI"
546		660
…		…
560	for values %hdr;	674	for values %hdr;
561		675
562	\%hdr	676	\%hdr
563	}	677	}
564		678
		679	#############################################################################
		680	# http_get
		681
565	our $qr_nlnl = qr{(?<![^\012])\015?\012};	682	our $qr_nlnl = qr{(?<![^\012])\015?\012};
566		683
567	our $TLS_CTX_LOW = { cache => 1, sslv2 => 1 };	684	our $TLS_CTX_LOW = { cache => 1, sslv2 => 1 };
568	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	);
569		742
570	sub http_request($$@) {	743	sub http_request($$@) {
571	my $cb = pop;	744	my $cb = pop;
572	my ($method, $url, %arg) = @_;	745	my ($method, $url, %arg) = @_;
573		746
…		…
591	my $recurse = exists $arg{recurse} ? delete $arg{recurse} : $MAX_RECURSE;	764	my $recurse = exists $arg{recurse} ? delete $arg{recurse} : $MAX_RECURSE;
592		765
593	return $cb->(undef, { @pseudo, Status => 599, Reason => "Too many redirections" })	766	return $cb->(undef, { @pseudo, Status => 599, Reason => "Too many redirections" })
594	if $recurse < 0;	767	if $recurse < 0;
595		768
596	my $proxy = $arg{proxy} \|\| $PROXY;	769	my $proxy = exists $arg{proxy} ? $arg{proxy} : $PROXY;
597	my $timeout = $arg{timeout} \|\| $TIMEOUT;	770	my $timeout = $arg{timeout} \|\| $TIMEOUT;
598		771
599	my ($uscheme, $uauthority, $upath, $query, $fragment) =	772	my ($uscheme, $uauthority, $upath, $query, undef) = # ignore fragment
600	$url =~ m\|(?:([^:/?#]+):)?(?://([^/?#]))?([^?#])(?:(\?[^#]))?(?:#(.))?\|;	773	$url =~ m\|^([^:]+):(?://([^/?#]))?([^?#])(?:(\?[^#]))?(?:#(.))?$\|;
601		774
602	$uscheme = lc $uscheme;	775	$uscheme = lc $uscheme;
603		776
604	my $uport = $uscheme eq "http" ? 80	777	my $uport = $uscheme eq "http" ? 80
605	: $uscheme eq "https" ? 443	778	: $uscheme eq "https" ? 443
606	: 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" });
607		780
608	$uauthority =~ /^(?: .*\@ )? ([^\@:]+) (?: : (\d+) )?$/x	781	$uauthority =~ /^(?: .*\@ )? ([^\@]+?) (?: : (\d+) )?$/x
609	or return $cb->(undef, { @pseudo, Status => 599, Reason => "Unparsable URL" });	782	or return $cb->(undef, { @pseudo, Status => 599, Reason => "Unparsable URL" });
610		783
611	my $uhost = lc $1;	784	my $uhost = lc $1;
612	$uport = $2 if defined $2;	785	$uport = $2 if defined $2;
613		786
…		…
649	$hdr{"user-agent"} = $USERAGENT unless exists $hdr{"user-agent"};	822	$hdr{"user-agent"} = $USERAGENT unless exists $hdr{"user-agent"};
650		823
651	$hdr{"content-length"} = length $arg{body}	824	$hdr{"content-length"} = length $arg{body}
652	if length $arg{body} \|\| $method ne "GET";	825	if length $arg{body} \|\| $method ne "GET";
653		826
654	my $idempotent = $method =~ /^(?:GET\|HEAD\|PUT\|DELETE\|OPTIONS\|TRACE)$/;	827	my $idempotent = $IDEMPOTENT{$method};
655		828
656	# 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
657	my $keepalive = exists $arg{keepalive}	830	my $persistent = exists $arg{persistent} ? !!$arg{persistent} : $idempotent;
658	? $arg{keepalive}*1	831	my $keepalive = exists $arg{keepalive} ? !!$arg{keepalive} : !$proxy;
659	: $idempotent ? $PERSISTENT_TIMEOUT : 0;	832	my $was_persistent; # true if this is actually a recycled connection
660		833
		834	# the key to use in the keepalive cache
		835	my $ka_key = "$uscheme\x00$uhost\x00$uport\x00$arg{sessionid}";
		836
661	$hdr{connection} = ($keepalive ? "" : "close ") . "Te"; #1.1	837	$hdr{connection} = ($persistent ? $keepalive ? "keep-alive, " : "" : "close, ") . "Te"; #1.1
662	$hdr{te} = "trailers" unless exists $hdr{te}; #1.1	838	$hdr{te} = "trailers" unless exists $hdr{te}; #1.1
663		839
664	my %state = (connect_guard => 1);	840	my %state = (connect_guard => 1);
665		841
666	my $ae_error = 595; # connecting	842	my $ae_error = 595; # connecting
667		843
668	# handle actual, non-tunneled, request	844	# handle actual, non-tunneled, request
669	my $handle_actual_request = sub {	845	my $handle_actual_request = sub {
670	$ae_error = 596; # request phase	846	$ae_error = 596; # request phase
671		847
		848	my $hdl = $state{handle};
		849
672	$state{handle}->starttls ("connect") if $uscheme eq "https" && !exists $state{handle}{tls};	850	$hdl->starttls ("connect") if $uscheme eq "https" && !exists $hdl->{tls};
673		851
674	# send request	852	# send request
675	$state{handle}->push_write (	853	$hdl->push_write (
676	"$method $rpath HTTP/1.1\015\012"	854	"$method $rpath HTTP/1.1\015\012"
677	. (join "", map "\u$_: $hdr{$_}\015\012", grep defined $hdr{$_}, keys %hdr)	855	. (join "", map "\u$_: $hdr{$_}\015\012", grep defined $hdr{$_}, keys %hdr)
678	. "\015\012"	856	. "\015\012"
679	. (delete $arg{body})	857	. $arg{body}
680	);	858	);
681		859
682	# return if error occured during push_write()	860	# return if error occurred during push_write()
683	return unless %state;	861	return unless %state;
684		862
685	# 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.
686	%hdr = ();	864	%hdr = ();
687		865
688	# status line and headers	866	# status line and headers
689	$state{read_response} = sub {	867	$state{read_response} = sub {
		868	return unless %state;
		869
690	for ("$_[1]") {	870	for ("$_[1]") {
691	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.
692		872
693	/^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
694	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" };
695		875
696	# 100 Continue handling	876	# 100 Continue handling
697	# should not happen as we don't send expect: 100-continue,	877	# should not happen as we don't send expect: 100-continue,
698	# but we handle it just in case.	878	# but we handle it just in case.
699	# 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
…		…
705	HTTPVersion => $1,	885	HTTPVersion => $1,
706	Status => $2,	886	Status => $2,
707	Reason => $3,	887	Reason => $3,
708	;	888	;
709		889
710	my $hdr = parse_hdr	890	my $hdr = _parse_hdr
711	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" };
712		892
713	%hdr = (%$hdr, @pseudo);	893	%hdr = (%$hdr, @pseudo);
714	}	894	}
715		895
716	# redirect handling	896	# redirect handling
717	# microsoft and other shitheads don't give a shit for following standards,	897	# relative uri handling forced by microsoft and other shitheads.
718	# try to support some common forms of broken Location headers.	898	# we give our best and fall back to URI if available.
719	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"
720	$hdr{location} =~ s/^\.\/+//;	909	$loc =~ s/^\.\/+//;
721		910
722	my $url = "$rscheme://$uhost:$uport";	911	if ($loc !~ m%^[.?#]%) {
		912	my $prefix = "$uscheme://$uauthority";
723		913
724	unless ($hdr{location} =~ s/^\///) {	914	unless ($loc =~ s/^\///) {
725	$url .= $upath;	915	$prefix .= $upath;
726	$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	}
727	}	930	}
728		931
729	$hdr{location} = "$url/$hdr{location}";	932	$hdr{location} = $loc;
730	}	933	}
731		934
732	my $redirect;	935	my $redirect;
733		936
734	if ($recurse) {	937	if ($recurse) {
…		…
736		939
737	# industry standard is to redirect POST as GET for	940	# industry standard is to redirect POST as GET for
738	# 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.
739	# 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,
740	# industry standard seems to be to simply follow.	943	# industry standard seems to be to simply follow.
741	# we go with the industry standard.	944	# we go with the industry standard. 308 is defined
		945	# by rfc7538
742	if ($status == 301 or $status == 302 or $status == 303) {	946	if ($status == 301 or $status == 302 or $status == 303) {
		947	$redirect = 1;
743	# HTTP/1.1 is unclear on how to mutate the method	948	# HTTP/1.1 is unclear on how to mutate the method
744	$method = "GET" unless $method eq "HEAD";	949	unless ($method eq "HEAD") {
745	$redirect = 1;	950	$method = "GET";
		951	delete $arg{body};
		952	}
746	} elsif ($status == 307) {	953	} elsif ($status == 307 or $status == 308) {
747	$redirect = 1;	954	$redirect = 1;
748	}	955	}
749	}	956	}
750		957
751	my $finish = sub { # ($data, $err_status, $err_reason[, $keepalive])	958	my $finish = sub { # ($data, $err_status, $err_reason[, $persistent])
752	my $may_keep_alive = $_[3];	959	if ($state{handle}) {
753		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
754	$state{handle}->destroy if $state{handle};	971	$state{handle}->destroy;
		972	}
		973	}
		974
755	%state = ();	975	%state = ();
756		976
757	if (defined $_[1]) {	977	if (defined $_[1]) {
758	$hdr{OrigStatus} = $hdr{Status}; $hdr{Status} = $_[1];	978	$hdr{OrigStatus} = $hdr{Status}; $hdr{Status} = $_[1];
759	$hdr{OrigReason} = $hdr{Reason}; $hdr{Reason} = $_[2];	979	$hdr{OrigReason} = $hdr{Reason}; $hdr{Reason} = $_[2];
…		…
766		986
767	if ($redirect && exists $hdr{location}) {	987	if ($redirect && exists $hdr{location}) {
768	# we ignore any errors, as it is very common to receive	988	# we ignore any errors, as it is very common to receive
769	# Content-Length != 0 but no actual body	989	# Content-Length != 0 but no actual body
770	# we also access %hdr, as $_[1] might be an erro	990	# we also access %hdr, as $_[1] might be an erro
		991	$state{recurse} =
771	http_request (	992	http_request (
772	$method => $hdr{location},	993	$method => $hdr{location},
773	%arg,	994	%arg,
774	recurse => $recurse - 1,	995	recurse => $recurse - 1,
775	Redirect => [$_[0], \%hdr],	996	Redirect => [$_[0], \%hdr],
		997	sub {
		998	%state = ();
		999	&$cb
		1000	},
776	$cb);	1001	);
777	} else {	1002	} else {
778	$cb->($_[0], \%hdr);	1003	$cb->($_[0], \%hdr);
779	}	1004	}
780	};	1005	};
781		1006
782	$ae_error = 597; # body phase	1007	$ae_error = 597; # body phase
783		1008
		1009	my $chunked = $hdr{"transfer-encoding"} =~ /\bchunked\b/i; # not quite correct...
		1010
784	my $len = $hdr{"content-length"};	1011	my $len = $chunked ? undef : $hdr{"content-length"};
785		1012
786	# body handling, many different code paths	1013	# body handling, many different code paths
787	# - no body expected	1014	# - no body expected
788	# - want_body_handle	1015	# - want_body_handle
789	# - te chunked	1016	# - te chunked
…		…
804	$_[0]->on_error (undef);	1031	$_[0]->on_error (undef);
805	$_[0]->on_read (undef);	1032	$_[0]->on_read (undef);
806		1033
807	$finish->(delete $state{handle});	1034	$finish->(delete $state{handle});
808		1035
809	} elsif ($hdr{"transfer-encoding"} =~ /\bchunked\b/i) {	1036	} elsif ($chunked) {
810	my $cl = 0;	1037	my $cl = 0;
811	my $body = undef;	1038	my $body = "";
812	my $on_body = $arg{on_body} \|\| sub { $body .= shift; 1 };	1039	my $on_body = (!$redirect && $arg{on_body}) \|\| sub { $body .= shift; 1 };
813		1040
814	$state{read_chunk} = sub {	1041	$state{read_chunk} = sub {
815	$_[1] =~ /^([0-9a-fA-F]+)/	1042	$_[1] =~ /^([0-9a-fA-F]+)/
816	or $finish->(undef, $ae_error => "Garbled chunked transfer encoding");	1043	or return $finish->(undef, $ae_error => "Garbled chunked transfer encoding");
817		1044
818	my $len = hex $1;	1045	my $len = hex $1;
819		1046
820	if ($len) {	1047	if ($len) {
821	$cl += $len;	1048	$cl += $len;
…		…
836	$_[0]->push_read (line => $qr_nlnl, sub {	1063	$_[0]->push_read (line => $qr_nlnl, sub {
837	if (length $_[1]) {	1064	if (length $_[1]) {
838	for ("$_[1]") {	1065	for ("$_[1]") {
839	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.
840		1067
841	my $hdr = parse_hdr	1068	my $hdr = _parse_hdr
842	or return $finish->(undef, $ae_error => "Garbled response trailers");	1069	or return $finish->(undef, $ae_error => "Garbled response trailers");
843		1070
844	%hdr = (%hdr, %$hdr);	1071	%hdr = (%hdr, %$hdr);
845	}	1072	}
846	}	1073	}
…		…
850	}	1077	}
851	};	1078	};
852		1079
853	$_[0]->push_read (line => $state{read_chunk});	1080	$_[0]->push_read (line => $state{read_chunk});
854		1081
855	} elsif ($arg{on_body}) {	1082	} elsif (!$redirect && $arg{on_body}) {
856	if (defined $len) {	1083	if (defined $len) {
857	$_[0]->on_read (sub {	1084	$_[0]->on_read (sub {
858	$len -= length $_[0]{rbuf};	1085	$len -= length $_[0]{rbuf};
859		1086
860	$arg{on_body}(delete $_[0]{rbuf}, \%hdr)	1087	$arg{on_body}(delete $_[0]{rbuf}, \%hdr)
…		…
889	$_[0]->on_read (sub { });	1116	$_[0]->on_read (sub { });
890	}	1117	}
891	}	1118	}
892	};	1119	};
893		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 {
894	$state{handle}->push_read (line => $qr_nlnl, $state{read_response});	1150	$hdl->push_read (line => $qr_nlnl, $state{read_response});
		1151	}
895	};	1152	};
896		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)
897	my $connect_cb = sub {	1168	my $connect_cb = sub {
898	$state{fh} = shift	1169	my $fh = shift
899	or do {
900	my $err = "$!";
901	%state = ();
902	return $cb->(undef, { @pseudo, Status => $ae_error, Reason => $err });	1170	or return _error %state, $cb, { @pseudo, Status => $ae_error, Reason => "$!" };
903	};
904		1171
905	return unless delete $state{connect_guard};	1172	return unless delete $state{connect_guard};
906		1173
907	# get handle	1174	# get handle
908	$state{handle} = new AnyEvent::Handle	1175	$state{handle} = new AnyEvent::Handle
		1176	%{ $arg{handle_params} },
909	fh => $state{fh},	1177	fh => $fh,
910	peername => $rhost,	1178	peername => $uhost,
911	tls_ctx => $arg{tls_ctx},	1179	tls_ctx => $arg{tls_ctx},
912	# these need to be reconfigured on keepalive handles
913	timeout => $timeout,
914	on_error => sub {
915	%state = ();
916	$cb->(undef, { @pseudo, Status => $ae_error, Reason => $_[2] });
917	},
918	on_eof => sub {
919	%state = ();
920	$cb->(undef, { @pseudo, Status => $ae_error, Reason => "Unexpected end-of-file" });
921	},
922	;	1180	;
923		1181
924	# limit the number of persistent connections	1182	$prepare_handle->();
925	# keepalive not yet supported
926	# if ($KA_COUNT{$_[1]} < $MAX_PERSISTENT_PER_HOST) {
927	# ++$KA_COUNT{$_[1]};
928	# $state{handle}{ka_count_guard} = AnyEvent::Util::guard {
929	# --$KA_COUNT{$_[1]}
930	# };
931	# $hdr{connection} = "keep-alive";
932	# }
933		1183
934	$state{handle}->starttls ("connect") if $rscheme eq "https";	1184	#$state{handle}->starttls ("connect") if $rscheme eq "https";
935		1185
936	# now handle proxy-CONNECT method	1186	# now handle proxy-CONNECT method
937	if ($proxy && $uscheme eq "https") {	1187	if ($proxy && $uscheme eq "https") {
938	# oh dear, we have to wrap it into a connect request	1188	# oh dear, we have to wrap it into a connect request
939		1189
		1190	my $auth = exists $hdr{"proxy-authorization"}
		1191	? "proxy-authorization: " . (delete $hdr{"proxy-authorization"}) . "\015\012"
		1192	: "";
		1193
940	# maybe re-use $uauthority with patched port?	1194	# maybe re-use $uauthority with patched port?
941	$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");
942	$state{handle}->push_read (line => $qr_nlnl, sub {	1196	$state{handle}->push_read (line => $qr_nlnl, sub {
943	$_[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
944	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])" };
945		1199
946	if ($2 == 200) {	1200	if ($2 == 200) {
947	$rpath = $upath;	1201	$rpath = $upath;
948	$handle_actual_request->();	1202	$handle_actual_request->();
949	} else {	1203	} else {
950	%state = ();
951	$cb->(undef, { @pseudo, Status => $2, Reason => $3 });	1204	_error %state, $cb, { @pseudo, Status => $2, Reason => $3 };
952	}	1205	}
953	});	1206	});
954	} else {	1207	} else {
		1208	delete $hdr{"proxy-authorization"} unless $proxy;
		1209
955	$handle_actual_request->();	1210	$handle_actual_request->();
956	}	1211	}
957	};	1212	};
958		1213
959	_get_slot $uhost, sub {	1214	_get_slot $uhost, sub {
960	$state{slot_guard} = shift;	1215	$state{slot_guard} = shift;
961		1216
962	return unless $state{connect_guard};	1217	return unless $state{connect_guard};
963		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 {
964	my $tcp_connect = $arg{tcp_connect}	1233	my $tcp_connect = $arg{tcp_connect}
965	\|\| do { require AnyEvent::Socket; \&AnyEvent::Socket::tcp_connect };	1234	\|\| do { require AnyEvent::Socket; \&AnyEvent::Socket::tcp_connect };
966		1235
967	$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	}
968	};	1238	};
969		1239
970	defined wantarray && AnyEvent::Util::guard { %state = () }	1240	defined wantarray && AnyEvent::Util::guard { _destroy_state %state }
971	}	1241	}
972		1242
973	sub http_get($@) {	1243	sub http_get($@) {
974	unshift @_, "GET";	1244	unshift @_, "GET";
975	&http_request	1245	&http_request
…		…
993	AnyEvent::HTTP uses the AnyEvent::Socket::tcp_connect function for	1263	AnyEvent::HTTP uses the AnyEvent::Socket::tcp_connect function for
994	the actual connection, which in turn uses AnyEvent::DNS to resolve	1264	the actual connection, which in turn uses AnyEvent::DNS to resolve
995	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
996	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
997	your own default resolver (by storing a suitable resolver object in	1267	your own default resolver (by storing a suitable resolver object in
998	C<$AnyEvent::DNS::RESOLVER>).	1268	C<$AnyEvent::DNS::RESOLVER>) or your own C<tcp_connect> callback.
999		1269
1000	=head2 GLOBAL FUNCTIONS AND VARIABLES	1270	=head2 GLOBAL FUNCTIONS AND VARIABLES
1001		1271
1002	=over 4	1272	=over 4
1003		1273
1004	=item AnyEvent::HTTP::set_proxy "proxy-url"	1274	=item AnyEvent::HTTP::set_proxy "proxy-url"
1005		1275
1006	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
1007	string of the form C<http://host:port> (optionally C<https:...>), croaks	1277	string of the form C<http://host:port>, croaks otherwise.
1008	otherwise.
1009		1278
1010	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>}.
1011		1284
1012	=item AnyEvent::HTTP::cookie_jar_expire $jar[, $session_end]	1285	=item AnyEvent::HTTP::cookie_jar_expire $jar[, $session_end]
1013		1286
1014	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
1015	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
1016	cookies.	1289	cookies.
1017		1290
1018	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
1019	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
1020	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
1021	function from time to time.	1294	function from time to time.
1022		1295
1023	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
1024	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:
1025		1298
1026	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
1027	emptied. All other keys are hostnames or IP addresses pointing to	1300	cleared. All other keys are hostnames or IP addresses pointing to
1028	hash-references. The key for these inner hash references is the	1301	hash-references. The key for these inner hash references is the
1029	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
1030	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
1031	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
1032	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>,
1033	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
1034	expiry timestamp.	1307	expiry timestamp. Session cookies are indicated by not having an
		1308	C<_expires> key.
1035		1309
1036	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
1037	chance of understanding the above paragraph:	1311	chance of understanding the above paragraph:
1038		1312
1039	{	1313	{
1040	version => 1,	1314	version => 2,
1041	"10.0.0.1" => {	1315	"10.0.0.1" => {
1042	"/" => {	1316	"/" => {
1043	"mythweb_id" => {	1317	"mythweb_id" => {
1044	_expires => 1293917923,	1318	_expires => 1293917923,
1045	value => "ooRung9dThee3ooyXooM1Ohm",	1319	value => "ooRung9dThee3ooyXooM1Ohm",
…		…
1061		1335
1062	=item $AnyEvent::HTTP::MAX_RECURSE	1336	=item $AnyEvent::HTTP::MAX_RECURSE
1063		1337
1064	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>).
1065		1339
		1340	=item $AnyEvent::HTTP::TIMEOUT
		1341
		1342	The default timeout for connection operations (default: C<300>).
		1343
1066	=item $AnyEvent::HTTP::USERAGENT	1344	=item $AnyEvent::HTTP::USERAGENT
1067		1345
1068	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
1069	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)>).
1070		1348
1071	=item $AnyEvent::HTTP::MAX_PER_HOST	1349	=item $AnyEvent::HTTP::MAX_PER_HOST
1072		1350
1073	The maximum number of concurrent connections to the same host (identified	1351	The maximum number of concurrent connections to the same host (identified
1074	by the hostname). If the limit is exceeded, then the additional requests	1352	by the hostname). If the limit is exceeded, then additional requests
1075	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.
1076		1355
1077	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
1078	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>).
1079		1368
1080	=item $AnyEvent::HTTP::ACTIVE	1369	=item $AnyEvent::HTTP::ACTIVE
1081		1370
1082	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
1083	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
1084	connections. This number of can be useful for load-leveling.	1373	connections. This number can be useful for load-leveling.
1085		1374
1086	=back	1375	=back
1087		1376
1088	=cut	1377	=cut
1089		1378
…		…
1123	# other formats fail in the loop below	1412	# other formats fail in the loop below
1124		1413
1125	for (0..11) {	1414	for (0..11) {
1126	if ($m eq $month[$_]) {	1415	if ($m eq $month[$_]) {
1127	require Time::Local;	1416	require Time::Local;
1128	return Time::Local::timegm ($S, $M, $H, $d, $_, $y);	1417	return eval { Time::Local::timegm ($S, $M, $H, $d, $_, $y) };
1129	}	1418	}
1130	}	1419	}
1131		1420
1132	undef	1421	undef
1133	}	1422	}
1134		1423
1135	sub set_proxy($) {	1424	sub set_proxy($) {
1136	if (length $_[0]) {	1425	if (length $_[0]) {
1137	$_[0] =~ m%^(https?):// ([^:/]+) (?: : (\d*) )?%ix	1426	$_[0] =~ m%^(http):// ([^:/]+) (?: : (\d*) )?%ix
1138	or Carp::croak "$_[0]: invalid proxy URL";	1427	or Carp::croak "$_[0]: invalid proxy URL";
1139	$PROXY = [$2, $3 \|\| 3128, $1]	1428	$PROXY = [$2, $3 \|\| 3128, $1]
1140	} else {	1429	} else {
1141	undef $PROXY;	1430	undef $PROXY;
1142	}	1431	}
…		…
1145	# initialise proxy from environment	1434	# initialise proxy from environment
1146	eval {	1435	eval {
1147	set_proxy $ENV{http_proxy};	1436	set_proxy $ENV{http_proxy};
1148	};	1437	};
1149		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
1150	=head2 SOCKS PROXIES	1539	=head3 SOCKS PROXIES
1151		1540
1152	Socks proxies are not directly supported by AnyEvent::HTTP. You can	1541	Socks proxies are not directly supported by AnyEvent::HTTP. You can
1153	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
1154	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
1155	transparently.	1544	transparently.

Diff Legend

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

Comparing AnyEvent-HTTP/HTTP.pm (file contents): Revision 1.89 by root, Mon Jan 3 00:23:25 2011 UTC vs. Revision 1.133 by root, Sat Sep 1 03:16:43 2018 UTC

Diff Legend

Comparing AnyEvent-HTTP/HTTP.pm (file contents):
Revision 1.89 by root, Mon Jan 3 00:23:25 2011 UTC vs.
Revision 1.133 by root, Sat Sep 1 03:16:43 2018 UTC