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