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

Comparing AnyEvent-HTTP/HTTP.pm (file contents):
Revision 1.83 by root, Sun Jan 2 05:02:28 2011 UTC vs.
Revision 1.119 by root, Sun Jun 8 23:33:28 2014 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
…		…
36		36
37	=cut	37	=cut
38		38
39	package AnyEvent::HTTP;	39	package AnyEvent::HTTP;
40		40
41	use strict;	41	use common::sense;
42	no warnings;
43		42
44	use Errno ();	43	use Errno ();
45		44
46	use AnyEvent 5.0 ();	45	use AnyEvent 5.0 ();
47	use AnyEvent::Util ();	46	use AnyEvent::Util ();
48	use AnyEvent::Handle ();	47	use AnyEvent::Handle ();
49		48
50	use base Exporter::;	49	use base Exporter::;
51		50
52	our $VERSION = '1.5';	51	our $VERSION = 2.2;
53		52
54	our @EXPORT = qw(http_get http_post http_head http_request);	53	our @EXPORT = qw(http_get http_post http_head http_request);
55		54
56	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)";
57	our $MAX_RECURSE = 10;	56	our $MAX_RECURSE = 10;
58	our $MAX_PERSISTENT = 8;
59	our $PERSISTENT_TIMEOUT = 2;	57	our $PERSISTENT_TIMEOUT = 3;
60	our $TIMEOUT = 300;	58	our $TIMEOUT = 300;
61		59	our $MAX_PER_HOST = 4; # changing this is evil
62	# changing these is evil
63	our $MAX_PERSISTENT_PER_HOST = 0;
64	our $MAX_PER_HOST = 4;
65		60
66	our $PROXY;	61	our $PROXY;
67	our $ACTIVE = 0;	62	our $ACTIVE = 0;
68		63
69	my %KA_COUNT; # number of open keep-alive connections per host	64	my %KA_CACHE; # indexed by uhost currently, points to [$handle...] array
70	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
71		66
72	=item http_get $url, key => value..., $cb->($data, $headers)	67	=item http_get $url, key => value..., $cb->($data, $headers)
73		68
74	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
…		…
94	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
95	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
96	destroyed before the callback is called, the request will be cancelled.	91	destroyed before the callback is called, the request will be cancelled.
97		92
98	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
99	(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
100	(and trailers) as second argument.	95	(and trailers) as second argument.
101		96
102	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
103	headers, the "pseudo-headers" (uppercase to avoid clashing with possible	98	headers, the "pseudo-headers" (uppercase to avoid clashing with possible
104	response headers) C<HTTPVersion>, C<Status> and C<Reason> contain the	99	response headers) C<HTTPVersion>, C<Status> and C<Reason> contain the
…		…
128	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
129	message. Currently the following status codes are used:	124	message. Currently the following status codes are used:
130		125
131	=over 4	126	=over 4
132		127
133	=item 595 - errors during connection etsbalishment, proxy handshake.	128	=item 595 - errors during connection establishment, proxy handshake.
134		129
135	=item 596 - errors during TLS negotiation, request sending and header processing.	130	=item 596 - errors during TLS negotiation, request sending and header processing.
136		131
137	=item 597 - errors during body receiving or processing.	132	=item 597 - errors during body receiving or processing.
138		133
…		…
159		154
160	=over 4	155	=over 4
161		156
162	=item recurse => $count (default: $MAX_RECURSE)	157	=item recurse => $count (default: $MAX_RECURSE)
163		158
164	Whether to recurse requests or not, e.g. on redirects, authentication	159	Whether to recurse requests or not, e.g. on redirects, authentication and
165	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.
166		166
167	=item headers => hashref	167	=item headers => hashref
168		168
169	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
170	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
171	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:>
172	(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
173	they won't be sent at all).	173	they won't be sent at all).
174		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
175	=item timeout => $seconds	182	=item timeout => $seconds
176		183
177	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
178	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
179	timeout.	186	timeout.
180		187
181	Default timeout is 5 minutes.	188	Default timeout is 5 minutes.
182		189
183	=item proxy => [$host, $port[, $scheme]] or undef	190	=item proxy => [$host, $port[, $scheme]] or undef
184		191
185	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
186	default proxy (as specified by C<$ENV{http_proxy}>) is used.	193	used.
187		194
188	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.
189	HTTPS.	196
		197	If not specified, then the default proxy is used (see
		198	C<AnyEvent::HTTP::set_proxy>).
190		199
191	=item body => $string	200	=item body => $string
192		201
193	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
194	this module might offer more options).	203	this module might offer more options).
…		…
225	verification) TLS context.	234	verification) TLS context.
226		235
227	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
228	me the page, no matter what".	237	me the page, no matter what".
229		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
230	=item on_prepare => $callback->($fh)	249	=item on_prepare => $callback->($fh)
231		250
232	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
233	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
234	overrides the prepare callback passed to C<AnyEvent::Socket::tcp_connect>	253	overrides the prepare callback passed to C<AnyEvent::Socket::tcp_connect>
235	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
236	timeout). See the description for the C<$prepare_cb> argument of	255	timeout). See the description for the C<$prepare_cb> argument of
237	C<AnyEvent::Socket::tcp_connect> for details.	256	C<AnyEvent::Socket::tcp_connect> for details.
238		257
…		…
303	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
304	callback will receive the L<AnyEvent::Handle> object associated with the	323	callback will receive the L<AnyEvent::Handle> object associated with the
305	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
306	(e.g. status C<304>), the empty string will be passed.	325	(e.g. status C<304>), the empty string will be passed.
307		326
308	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
309	a proxy, be a persistent connection etc., and configured in unspecified	328	to a proxy, be a persistent connection, use chunked transfer encoding
310	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
311	module anymore).	330	handle (it will not be used by this module anymore).
312		331
313	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
314	headers, an interactive protocol is used (typical example would be the	333	headers, an interactive protocol is used (typical example would be the
315	push-style twitter API which starts a JSON/XML stream).	334	push-style twitter API which starts a JSON/XML stream).
316		335
317	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
318	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	},
319		379
320	=back	380	=back
321		381
322	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
323	the response body.	383	the response body.
…		…
329		389
330	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
331	timeout of 30 seconds.	391	timeout of 30 seconds.
332		392
333	http_request	393	http_request
334	GET => "https://www.google.com",	394	HEAD => "https://www.google.com",
		395	headers => { "user-agent" => "MySearchClient 1.0" },
335	timeout => 30,	396	timeout => 30,
336	sub {	397	sub {
337	my ($body, $hdr) = @_;	398	my ($body, $hdr) = @_;
338	use Data::Dumper;	399	use Data::Dumper;
339	print Dumper $hdr;	400	print Dumper $hdr;
…		…
349	};	410	};
350		411
351	undef $request;	412	undef $request;
352		413
353	=cut	414	=cut
		415
		416	#############################################################################
		417	# wait queue/slots
354		418
355	sub _slot_schedule;	419	sub _slot_schedule;
356	sub _slot_schedule($) {	420	sub _slot_schedule($) {
357	my $host = shift;	421	my $host = shift;
358		422
…		…
381		445
382	_slot_schedule $_[0];	446	_slot_schedule $_[0];
383	}	447	}
384		448
385	#############################################################################	449	#############################################################################
		450	# cookie handling
386		451
387	# expire cookies	452	# expire cookies
388	sub cookie_jar_expire($;$) {	453	sub cookie_jar_expire($;$) {
389	my ($jar, $session_end) = @_;	454	my ($jar, $session_end) = @_;
390		455
…		…
414	}	479	}
415	}	480	}
416		481
417	# extract cookies from jar	482	# extract cookies from jar
418	sub cookie_jar_extract($$$$) {	483	sub cookie_jar_extract($$$$) {
419	my ($jar, $uscheme, $uhost, $upath) = @_;	484	my ($jar, $scheme, $host, $path) = @_;
420
421	$uhost = lc $uhost;
422		485
423	%$jar = () if $jar->{version} != 1;	486	%$jar = () if $jar->{version} != 1;
424		487
425	my @cookies;	488	my @cookies;
426		489
427	while (my ($chost, $paths) = each %$jar) {	490	while (my ($chost, $paths) = each %$jar) {
428	next unless ref $paths;	491	next unless ref $paths;
429		492
430	if ($chost =~ /^\./) {	493	if ($chost =~ /^\./) {
431	next unless $chost eq substr $uhost, -length $chost;	494	next unless $chost eq substr $host, -length $chost;
432	} elsif ($chost =~ /\./) {	495	} elsif ($chost =~ /\./) {
433	next unless $chost eq $uhost;	496	next unless $chost eq $host;
434	} else {	497	} else {
435	next;	498	next;
436	}	499	}
437		500
438	while (my ($cpath, $cookies) = each %$paths) {	501	while (my ($cpath, $cookies) = each %$paths) {
439	next unless $cpath eq substr $upath, 0, length $cpath;	502	next unless $cpath eq substr $path, 0, length $cpath;
440		503
441	while (my ($cookie, $kv) = each %$cookies) {	504	while (my ($cookie, $kv) = each %$cookies) {
442	next if $uscheme ne "https" && exists $kv->{secure};	505	next if $scheme ne "https" && exists $kv->{secure};
443		506
444	if (exists $kv->{_expires} and AE::now > $kv->{_expires}) {	507	if (exists $kv->{_expires} and AE::now > $kv->{_expires}) {
445	delete $cookies->{$cookie};	508	delete $cookies->{$cookie};
446	next;	509	next;
447	}	510	}
…		…
461	\@cookies	524	\@cookies
462	}	525	}
463		526
464	# parse set_cookie header into jar	527	# parse set_cookie header into jar
465	sub cookie_jar_set_cookie($$$$) {	528	sub cookie_jar_set_cookie($$$$) {
466	my ($jar, $set_cookie, $uhost, $date) = @_;	529	my ($jar, $set_cookie, $host, $date) = @_;
467		530
468	my $anow = int AE::now;	531	my $anow = int AE::now;
469	my $snow; # server-now	532	my $snow; # server-now
470		533
471	for ($set_cookie) {	534	for ($set_cookie) {
…		…
477	while (	540	while (
478	m{	541	m{
479	\G\s*	542	\G\s*
480	(?:	543	(?:
481	expires \s=\s ([A-Z][a-z][a-z]+,\ [^,;]+)	544	expires \s=\s ([A-Z][a-z][a-z]+,\ [^,;]+)
482	\| ([^=;,[:space:]]+) (?: \s=\s (?: "((?:[^\\"]+\|\\.))" \| ([^=;,[:space:]]) ) )?	545	\| ([^=;,[:space:]]+) (?: \s=\s (?: "((?:[^\\"]+\|\\.))" \| ([^;,[:space:]]) ) )?
483	)	546	)
484	}gcxsi	547	}gcxsi
485	) {	548	) {
486	my $name = $2;	549	my $name = $2;
487	my $value = $4;	550	my $value = $4;
…		…
494	# quoted	557	# quoted
495	$value = $3;	558	$value = $3;
496	$value =~ s/\\(.)/$1/gs;	559	$value =~ s/\\(.)/$1/gs;
497	}	560	}
498		561
499	push @kv, lc $name, $value;	562	push @kv, @kv ? lc $name : $name, $value;
500		563
501	last unless /\G\s*;/gc;	564	last unless /\G\s*;/gc;
502	}	565	}
503		566
504	last unless @kv;	567	last unless @kv;
…		…
527		590
528	# this is not rfc-like and not netscape-like. go figure.	591	# this is not rfc-like and not netscape-like. go figure.
529	my $ndots = $cdom =~ y/.//;	592	my $ndots = $cdom =~ y/.//;
530	next if $ndots < ($cdom =~ /\.[^.][^.]\.[^.][^.]$/ ? 3 : 2);	593	next if $ndots < ($cdom =~ /\.[^.][^.]\.[^.][^.]$/ ? 3 : 2);
531	} else {	594	} else {
532	$cdom = $uhost;	595	$cdom = $host;
533	}	596	}
534		597
535	# store it	598	# store it
536	$jar->{version} = 1;	599	$jar->{version} = 1;
537	$jar->{lc $cdom}{$cpath}{$name} = \%kv;	600	$jar->{lc $cdom}{$cpath}{$name} = \%kv;
538		601
539	redo if /\G\s*,/gc;	602	redo if /\G\s*,/gc;
540	}	603	}
541	}	604	}
542		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
543	# continue to parse $_ for headers and place them into the arg	648	# continue to parse $_ for headers and place them into the arg
544	sub parse_hdr() {	649	sub _parse_hdr() {
545	my %hdr;	650	my %hdr;
546		651
547	# things seen, not parsed:	652	# things seen, not parsed:
548	# p3pP="NON CUR OTPi OUR NOR UNI"	653	# p3pP="NON CUR OTPi OUR NOR UNI"
549		654
…		…
563	for values %hdr;	668	for values %hdr;
564		669
565	\%hdr	670	\%hdr
566	}	671	}
567		672
		673	#############################################################################
		674	# http_get
		675
568	our $qr_nlnl = qr{(?<![^\012])\015?\012};	676	our $qr_nlnl = qr{(?<![^\012])\015?\012};
569		677
570	our $TLS_CTX_LOW = { cache => 1, sslv2 => 1 };	678	our $TLS_CTX_LOW = { cache => 1, sslv2 => 1 };
571	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	);
572		736
573	sub http_request($$@) {	737	sub http_request($$@) {
574	my $cb = pop;	738	my $cb = pop;
575	my ($method, $url, %arg) = @_;	739	my ($method, $url, %arg) = @_;
576		740
…		…
594	my $recurse = exists $arg{recurse} ? delete $arg{recurse} : $MAX_RECURSE;	758	my $recurse = exists $arg{recurse} ? delete $arg{recurse} : $MAX_RECURSE;
595		759
596	return $cb->(undef, { @pseudo, Status => 599, Reason => "Too many redirections" })	760	return $cb->(undef, { @pseudo, Status => 599, Reason => "Too many redirections" })
597	if $recurse < 0;	761	if $recurse < 0;
598		762
599	my $proxy = $arg{proxy} \|\| $PROXY;	763	my $proxy = exists $arg{proxy} ? $arg{proxy} : $PROXY;
600	my $timeout = $arg{timeout} \|\| $TIMEOUT;	764	my $timeout = $arg{timeout} \|\| $TIMEOUT;
601		765
602	my ($uscheme, $uauthority, $upath, $query, $fragment) =	766	my ($uscheme, $uauthority, $upath, $query, undef) = # ignore fragment
603	$url =~ m\|(?:([^:/?#]+):)?(?://([^/?#]))?([^?#])(?:(\?[^#]))?(?:#(.))?\|;	767	$url =~ m\|^([^:]+):(?://([^/?#]))?([^?#])(?:(\?[^#]))?(?:#(.))?$\|;
604		768
605	$uscheme = lc $uscheme;	769	$uscheme = lc $uscheme;
606		770
607	my $uport = $uscheme eq "http" ? 80	771	my $uport = $uscheme eq "http" ? 80
608	: $uscheme eq "https" ? 443	772	: $uscheme eq "https" ? 443
609	: return $cb->(undef, { @pseudo, Status => 599, Reason => "Only http and https URL schemes supported" });	773	: return $cb->(undef, { @pseudo, Status => 599, Reason => "Only http and https URL schemes supported" });
610		774
611	$uauthority =~ /^(?: .*\@ )? ([^\@:]+) (?: : (\d+) )?$/x	775	$uauthority =~ /^(?: .*\@ )? ([^\@:]+) (?: : (\d+) )?$/x
612	or return $cb->(undef, { @pseudo, Status => 599, Reason => "Unparsable URL" });	776	or return $cb->(undef, { @pseudo, Status => 599, Reason => "Unparsable URL" });
613		777
614	my $uhost = $1;	778	my $uhost = lc $1;
615	$uport = $2 if defined $2;	779	$uport = $2 if defined $2;
616		780
617	$hdr{host} = defined $2 ? "$uhost:$2" : "$uhost"	781	$hdr{host} = defined $2 ? "$uhost:$2" : "$uhost"
618	unless exists $hdr{host};	782	unless exists $hdr{host};
619		783
…		…
638	$rscheme = "http" unless defined $rscheme;	802	$rscheme = "http" unless defined $rscheme;
639		803
640	# don't support https requests over https-proxy transport,	804	# don't support https requests over https-proxy transport,
641	# can't be done with tls as spec'ed, unless you double-encrypt.	805	# can't be done with tls as spec'ed, unless you double-encrypt.
642	$rscheme = "http" if $uscheme eq "https" && $rscheme eq "https";	806	$rscheme = "http" if $uscheme eq "https" && $rscheme eq "https";
		807
		808	$rhost = lc $rhost;
		809	$rscheme = lc $rscheme;
643	} else {	810	} else {
644	($rhost, $rport, $rscheme, $rpath) = ($uhost, $uport, $uscheme, $upath);	811	($rhost, $rport, $rscheme, $rpath) = ($uhost, $uport, $uscheme, $upath);
645	}	812	}
646		813
647	# leave out fragment and query string, just a heuristic	814	# leave out fragment and query string, just a heuristic
…		…
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	$hdr{connection} = "close TE"; #1.1	821	my $idempotent = $IDEMPOTENT{$method};
		822
		823	# default value for keepalive is true iff the request is for an idempotent method
		824	my $persistent = exists $arg{persistent} ? !!$arg{persistent} : $idempotent;
		825	my $keepalive = exists $arg{keepalive} ? !!$arg{keepalive} : !$proxy;
		826	my $was_persistent; # true if this is actually a recycled connection
		827
		828	# the key to use in the keepalive cache
		829	my $ka_key = "$uscheme\x00$uhost\x00$uport\x00$arg{sessionid}";
		830
		831	$hdr{connection} = ($persistent ? $keepalive ? "keep-alive, " : "" : "close, ") . "Te"; #1.1
655	$hdr{te} = "trailers" unless exists $hdr{te}; #1.1	832	$hdr{te} = "trailers" unless exists $hdr{te}; #1.1
656		833
657	my %state = (connect_guard => 1);	834	my %state = (connect_guard => 1);
658		835
659	_get_slot $uhost, sub {
660	$state{slot_guard} = shift;
661
662	return unless $state{connect_guard};
663
664	my $ae_error = 595; # connecting	836	my $ae_error = 595; # connecting
665		837
666	# handle actual, non-tunneled, request	838	# handle actual, non-tunneled, request
667	my $handle_actual_request = sub {	839	my $handle_actual_request = sub {
668	$ae_error = 596; # request phase	840	$ae_error = 596; # request phase
669		841
		842	my $hdl = $state{handle};
		843
670	$state{handle}->starttls ("connect") if $uscheme eq "https" && !exists $state{handle}{tls};	844	$hdl->starttls ("connect") if $uscheme eq "https" && !exists $hdl->{tls};
671		845
672	# send request	846	# send request
673	$state{handle}->push_write (	847	$hdl->push_write (
674	"$method $rpath HTTP/1.1\015\012"	848	"$method $rpath HTTP/1.1\015\012"
675	. (join "", map "\u$_: $hdr{$_}\015\012", grep defined $hdr{$_}, keys %hdr)	849	. (join "", map "\u$_: $hdr{$_}\015\012", grep defined $hdr{$_}, keys %hdr)
676	. "\015\012"	850	. "\015\012"
677	. (delete $arg{body})	851	. (delete $arg{body})
678	);	852	);
679		853
680	# return if error occured during push_write()	854	# return if error occurred during push_write()
		855	return unless %state;
		856
		857	# reduce memory usage, save a kitten, also re-use it for the response headers.
		858	%hdr = ();
		859
		860	# status line and headers
		861	$state{read_response} = sub {
681	return unless %state;	862	return unless %state;
682		863
683	%hdr = (); # reduce memory usage, save a kitten, also make it possible to re-use
684
685	# status line and headers
686	$state{read_response} = sub {
687	for ("$_[1]") {	864	for ("$_[1]") {
688	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.
689		866
690	/^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
691	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" };
692		869
693	# 100 Continue handling	870	# 100 Continue handling
694	# should not happen as we don't send expect: 100-continue,	871	# should not happen as we don't send expect: 100-continue,
695	# but we handle it just in case.	872	# but we handle it just in case.
696	# 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
697	# we are out of-sync, which we currently do NOT handle correctly.	874	# we are out of-sync, which we currently do NOT handle correctly.
698	return $state{handle}->push_read (line => $qr_nlnl, $state{read_response})	875	return $state{handle}->push_read (line => $qr_nlnl, $state{read_response})
699	if $2 eq 100;	876	if $2 eq 100;
700		877
701	push @pseudo,	878	push @pseudo,
702	HTTPVersion => $1,	879	HTTPVersion => $1,
703	Status => $2,	880	Status => $2,
704	Reason => $3,	881	Reason => $3,
705	;	882	;
706		883
707	my $hdr = parse_hdr	884	my $hdr = _parse_hdr
708	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" };
709		886
710	%hdr = (%$hdr, @pseudo);	887	%hdr = (%$hdr, @pseudo);
711	}	888	}
712		889
713	# redirect handling	890	# redirect handling
714	# microsoft and other shitheads don't give a shit for following standards,	891	# relative uri handling forced by microsoft and other shitheads.
715	# try to support some common forms of broken Location headers.	892	# we give our best and fall back to URI if available.
		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
716	if ($hdr{location} !~ /^(?: $ \| [^:\/?\#]+ : )/x) {	902	} elsif ($loc !~ /^(?: $ \| [^:\/?\#]+ : )/x) { # anything "simple"
717	$hdr{location} =~ s/^\.\/+//;	903	$loc =~ s/^\.\/+//;
718		904
		905	if ($loc !~ m%^[.?#]%) {
719	my $url = "$rscheme://$uhost:$uport";	906	my $prefix = "$rscheme://$uhost:$uport";
720		907
721	unless ($hdr{location} =~ s/^\///) {	908	unless ($loc =~ s/^\///) {
722	$url .= $upath;	909	$prefix .= $upath;
723	$url =~ s/\/[^\/]*$//;	910	$prefix =~ s/\/[^\/]*$//;
724	}	911	}
725		912
726	$hdr{location} = "$url/$hdr{location}";	913	$loc = "$prefix/$loc";
727	}
728		914
729	my $redirect;	915	} elsif (eval { require URI }) { # uri
		916	$loc = URI->new_abs ($loc, $url)->as_string;
730		917
731	if ($recurse) {	918	} else {
732	my $status = $hdr{Status};	919	return _error %state, $cb, { @pseudo, Status => 599, Reason => "Cannot parse Location (URI module missing)" };
733		920	#$hdr{Status} = 599;
734	# industry standard is to redirect POST as GET for	921	#$hdr{Reason} = "Unparsable Redirect (URI module missing)";
735	# 301, 302 and 303, in contrast to HTTP/1.0 and 1.1.
736	# also, the UA should ask the user for 301 and 307 and POST,
737	# industry standard seems to be to simply follow.
738	# we go with the industry standard.
739	if ($status == 301 or $status == 302 or $status == 303) {
740	# HTTP/1.1 is unclear on how to mutate the method
741	$method = "GET" unless $method eq "HEAD";
742	$redirect = 1;	922	#$recurse = 0;
743	} elsif ($status == 307) {
744	$redirect = 1;
745	}	923	}
746	}	924	}
747		925
		926	$hdr{location} = $loc;
		927	}
		928
		929	my $redirect;
		930
		931	if ($recurse) {
		932	my $status = $hdr{Status};
		933
		934	# industry standard is to redirect POST as GET for
		935	# 301, 302 and 303, in contrast to HTTP/1.0 and 1.1.
		936	# also, the UA should ask the user for 301 and 307 and POST,
		937	# industry standard seems to be to simply follow.
		938	# we go with the industry standard. 308 is defined
		939	# by rfc7238
		940	if ($status == 301 or $status == 302 or $status == 303) {
		941	# HTTP/1.1 is unclear on how to mutate the method
		942	$method = "GET" unless $method eq "HEAD";
		943	$redirect = 1;
		944	} elsif ($status == 307 or $status == 308) {
		945	$redirect = 1;
		946	}
		947	}
		948
748	my $finish = sub { # ($data, $err_status, $err_reason[, $keepalive])	949	my $finish = sub { # ($data, $err_status, $err_reason[, $persistent])
749	my $may_keep_alive = $_[3];	950	if ($state{handle}) {
750		951	# handle keepalive
		952	if (
		953	$persistent
		954	&& $_[3]
		955	&& ($hdr{HTTPVersion} < 1.1
		956	? $hdr{connection} =~ /\bkeep-?alive\b/i
		957	: $hdr{connection} !~ /\bclose\b/i)
		958	) {
		959	ka_store $ka_key, delete $state{handle};
		960	} else {
		961	# no keepalive, destroy the handle
751	$state{handle}->destroy if $state{handle};	962	$state{handle}->destroy;
752	%state = ();
753
754	if (defined $_[1]) {
755	$hdr{OrigStatus} = $hdr{Status}; $hdr{Status} = $_[1];
756	$hdr{OrigReason} = $hdr{Reason}; $hdr{Reason} = $_[2];
757	}	963	}
		964	}
758		965
		966	%state = ();
		967
		968	if (defined $_[1]) {
		969	$hdr{OrigStatus} = $hdr{Status}; $hdr{Status} = $_[1];
		970	$hdr{OrigReason} = $hdr{Reason}; $hdr{Reason} = $_[2];
		971	}
		972
759	# set-cookie processing	973	# set-cookie processing
760	if ($arg{cookie_jar}) {	974	if ($arg{cookie_jar}) {
761	cookie_jar_set_cookie $arg{cookie_jar}, $hdr{"set-cookie"}, $uhost, $hdr{date};	975	cookie_jar_set_cookie $arg{cookie_jar}, $hdr{"set-cookie"}, $uhost, $hdr{date};
762	}	976	}
763		977
764	if ($redirect && exists $hdr{location}) {	978	if ($redirect && exists $hdr{location}) {
765	# we ignore any errors, as it is very common to receive	979	# we ignore any errors, as it is very common to receive
766	# Content-Length != 0 but no actual body	980	# Content-Length != 0 but no actual body
767	# we also access %hdr, as $_[1] might be an erro	981	# we also access %hdr, as $_[1] might be an erro
		982	$state{recurse} =
768	http_request (	983	http_request (
769	$method => $hdr{location},	984	$method => $hdr{location},
770	%arg,	985	%arg,
771	recurse => $recurse - 1,	986	recurse => $recurse - 1,
772	Redirect => [$_[0], \%hdr],	987	Redirect => [$_[0], \%hdr],
		988	sub {
		989	%state = ();
		990	&$cb
		991	},
		992	);
		993	} else {
		994	$cb->($_[0], \%hdr);
		995	}
		996	};
		997
		998	$ae_error = 597; # body phase
		999
		1000	my $chunked = $hdr{"transfer-encoding"} =~ /\bchunked\b/i; # not quite correct...
		1001
		1002	my $len = $chunked ? undef : $hdr{"content-length"};
		1003
		1004	# body handling, many different code paths
		1005	# - no body expected
		1006	# - want_body_handle
		1007	# - te chunked
		1008	# - 2x length known (with or without on_body)
		1009	# - 2x length not known (with or without on_body)
		1010	if (!$redirect && $arg{on_header} && !$arg{on_header}(\%hdr)) {
		1011	$finish->(undef, 598 => "Request cancelled by on_header");
		1012	} elsif (
		1013	$hdr{Status} =~ /^(?:1..\|204\|205\|304)$/
		1014	or $method eq "HEAD"
		1015	or (defined $len && $len == 0) # == 0, not !, because "0 " is true
		1016	) {
		1017	# no body
		1018	$finish->("", undef, undef, 1);
		1019
		1020	} elsif (!$redirect && $arg{want_body_handle}) {
		1021	$_[0]->on_eof (undef);
		1022	$_[0]->on_error (undef);
		1023	$_[0]->on_read (undef);
		1024
		1025	$finish->(delete $state{handle});
		1026
		1027	} elsif ($chunked) {
		1028	my $cl = 0;
		1029	my $body = "";
		1030	my $on_body = $arg{on_body} \|\| sub { $body .= shift; 1 };
		1031
		1032	$state{read_chunk} = sub {
		1033	$_[1] =~ /^([0-9a-fA-F]+)/
		1034	or return $finish->(undef, $ae_error => "Garbled chunked transfer encoding");
		1035
		1036	my $len = hex $1;
		1037
		1038	if ($len) {
		1039	$cl += $len;
		1040
		1041	$_[0]->push_read (chunk => $len, sub {
		1042	$on_body->($_[1], \%hdr)
		1043	or return $finish->(undef, 598 => "Request cancelled by on_body");
		1044
		1045	$_[0]->push_read (line => sub {
		1046	length $_[1]
		1047	and return $finish->(undef, $ae_error => "Garbled chunked transfer encoding");
		1048	$_[0]->push_read (line => $state{read_chunk});
773	$cb);	1049	});
		1050	});
774	} else {	1051	} else {
775	$cb->($_[0], \%hdr);	1052	$hdr{"content-length"} \|\|= $cl;
		1053
		1054	$_[0]->push_read (line => $qr_nlnl, sub {
		1055	if (length $_[1]) {
		1056	for ("$_[1]") {
		1057	y/\015//d; # weed out any \015, as they show up in the weirdest of places.
		1058
		1059	my $hdr = _parse_hdr
		1060	or return $finish->(undef, $ae_error => "Garbled response trailers");
		1061
		1062	%hdr = (%hdr, %$hdr);
		1063	}
		1064	}
		1065
		1066	$finish->($body, undef, undef, 1);
		1067	});
776	}	1068	}
777	};	1069	};
778		1070
779	$ae_error = 597; # body phase	1071	$_[0]->push_read (line => $state{read_chunk});
780		1072
781	my $len = $hdr{"content-length"};	1073	} elsif ($arg{on_body}) {
		1074	if (defined $len) {
		1075	$_[0]->on_read (sub {
		1076	$len -= length $_[0]{rbuf};
782		1077
783	if (!$redirect && $arg{on_header} && !$arg{on_header}(\%hdr)) {	1078	$arg{on_body}(delete $_[0]{rbuf}, \%hdr)
784	$finish->(undef, 598 => "Request cancelled by on_header");	1079	or return $finish->(undef, 598 => "Request cancelled by on_body");
785	} elsif (	1080
786	$hdr{Status} =~ /^(?:1..\|204\|205\|304)$/	1081	$len > 0
787	or $method eq "HEAD"
788	or (defined $len && !$len)
789	) {
790	# no body
791	$finish->("", undef, undef, 1);	1082	or $finish->("", undef, undef, 1);
		1083	});
792	} else {	1084	} else {
793	# body handling, many different code paths
794	# - no body expected
795	# - want_body_handle
796	# - te chunked
797	# - 2x length known (with or without on_body)
798	# - 2x length not known (with or without on_body)
799	if (!$redirect && $arg{want_body_handle}) {
800	$_[0]->on_eof (undef);	1085	$_[0]->on_eof (sub {
801	$_[0]->on_error (undef);	1086	$finish->("");
802	$_[0]->on_read (undef);
803
804	$finish->(delete $state{handle});
805
806	} elsif ($hdr{"transfer-encoding"} =~ /\bchunked\b/i) {
807	my $cl = 0;
808	my $body = undef;
809	my $on_body = $arg{on_body} \|\| sub { $body .= shift; 1 };
810
811	$state{read_chunk} = sub {
812	$_[1] =~ /^([0-9a-fA-F]+)/
813	or $finish->(undef, $ae_error => "Garbled chunked transfer encoding");
814
815	my $len = hex $1;
816
817	if ($len) {
818	$cl += $len;
819
820	$_[0]->push_read (chunk => $len, sub {
821	$on_body->($_[1], \%hdr)
822	or return $finish->(undef, 598 => "Request cancelled by on_body");
823
824	$_[0]->push_read (line => sub {
825	length $_[1]
826	and return $finish->(undef, $ae_error => "Garbled chunked transfer encoding");
827	$_[0]->push_read (line => $state{read_chunk});
828	});
829	});
830	} else {
831	$hdr{"content-length"} \|\|= $cl;
832
833	$_[0]->push_read (line => $qr_nlnl, sub {
834	if (length $_[1]) {
835	for ("$_[1]") {
836	y/\015//d; # weed out any \015, as they show up in the weirdest of places.
837
838	my $hdr = parse_hdr
839	or return $finish->(undef, $ae_error => "Garbled response trailers");
840
841	%hdr = (%hdr, %$hdr);
842	}
843	}
844
845	$finish->($body, undef, undef, 1);
846	});
847	}
848	};	1087	});
849
850	$_[0]->push_read (line => $state{read_chunk});
851
852	} elsif ($arg{on_body}) {
853	if ($len) {
854	$_[0]->on_read (sub {	1088	$_[0]->on_read (sub {
855	$len -= length $_[0]{rbuf};
856
857	$arg{on_body}(delete $_[0]{rbuf}, \%hdr)	1089	$arg{on_body}(delete $_[0]{rbuf}, \%hdr)
858	or return $finish->(undef, 598 => "Request cancelled by on_body");
859
860	$len > 0
861	or $finish->("", undef, undef, 1);
862	});
863	} else {
864	$_[0]->on_eof (sub {
865	$finish->("");
866	});
867	$_[0]->on_read (sub {
868	$arg{on_body}(delete $_[0]{rbuf}, \%hdr)
869	or $finish->(undef, 598 => "Request cancelled by on_body");	1090	or $finish->(undef, 598 => "Request cancelled by on_body");
870	});
871	}
872	} else {
873	$_[0]->on_eof (undef);
874
875	if ($len) {
876	$_[0]->on_read (sub {
877	$finish->((substr delete $_[0]{rbuf}, 0, $len, ""), undef, undef, 1)
878	if $len <= length $_[0]{rbuf};
879	});
880	} else {
881	$_[0]->on_error (sub {
882	($! == Errno::EPIPE \|\| !$!)
883	? $finish->(delete $_[0]{rbuf})
884	: $finish->(undef, $ae_error => $_[2]);
885	});
886	$_[0]->on_read (sub { });
887	}
888	}	1091	});
889	}	1092	}
890	};
891
892	$state{handle}->push_read (line => $qr_nlnl, $state{read_response});
893	};
894
895	my $connect_cb = sub {
896	$state{fh} = shift
897	or do {
898	my $err = "$!";
899	%state = ();
900	return $cb->(undef, { @pseudo, Status => $ae_error, Reason => $err });
901	};
902
903	return unless delete $state{connect_guard};
904
905	# get handle
906	$state{handle} = new AnyEvent::Handle
907	fh => $state{fh},
908	peername => $rhost,
909	tls_ctx => $arg{tls_ctx},
910	# these need to be reconfigured on keepalive handles
911	timeout => $timeout,
912	on_error => sub {
913	%state = ();
914	$cb->(undef, { @pseudo, Status => $ae_error, Reason => $_[2] });
915	},
916	on_eof => sub {
917	%state = ();
918	$cb->(undef, { @pseudo, Status => $ae_error, Reason => "Unexpected end-of-file" });
919	},
920	;
921
922	# limit the number of persistent connections
923	# keepalive not yet supported
924	# if ($KA_COUNT{$_[1]} < $MAX_PERSISTENT_PER_HOST) {
925	# ++$KA_COUNT{$_[1]};
926	# $state{handle}{ka_count_guard} = AnyEvent::Util::guard {
927	# --$KA_COUNT{$_[1]}
928	# };
929	# $hdr{connection} = "keep-alive";
930	# }
931
932	$state{handle}->starttls ("connect") if $rscheme eq "https";
933
934	# now handle proxy-CONNECT method
935	if ($proxy && $uscheme eq "https") {
936	# oh dear, we have to wrap it into a connect request
937
938	# maybe re-use $uauthority with patched port?
939	$state{handle}->push_write ("CONNECT $uhost:$uport HTTP/1.0\015\012Host: $uhost\015\012\015\012");
940	$state{handle}->push_read (line => $qr_nlnl, sub {
941	$_[1] =~ /^HTTP\/([0-9\.]+) \s+ ([0-9]{3}) (?: \s+ ([^\015\012]*) )?/ix
942	or return (%state = (), $cb->(undef, { @pseudo, Status => 599, Reason => "Invalid proxy connect response ($_[1])" }));
943
944	if ($2 == 200) {
945	$rpath = $upath;
946	$handle_actual_request->();
947	} else {
948	%state = ();
949	$cb->(undef, { @pseudo, Status => $2, Reason => $3 });
950	}
951	});
952	} else {	1093	} else {
953	$handle_actual_request->();	1094	$_[0]->on_eof (undef);
		1095
		1096	if (defined $len) {
		1097	$_[0]->on_read (sub {
		1098	$finish->((substr delete $_[0]{rbuf}, 0, $len, ""), undef, undef, 1)
		1099	if $len <= length $_[0]{rbuf};
		1100	});
		1101	} else {
		1102	$_[0]->on_error (sub {
		1103	($! == Errno::EPIPE \|\| !$!)
		1104	? $finish->(delete $_[0]{rbuf})
		1105	: $finish->(undef, $ae_error => $_[2]);
		1106	});
		1107	$_[0]->on_read (sub { });
		1108	}
954	}	1109	}
955	};	1110	};
956		1111
957	my $tcp_connect = $arg{tcp_connect}	1112	# if keepalive is enabled, then the server closing the connection
958	\|\| do { require AnyEvent::Socket; \&AnyEvent::Socket::tcp_connect };	1113	# before a response can happen legally - we retry on idempotent methods.
		1114	if ($was_persistent && $idempotent) {
		1115	my $old_eof = $hdl->{on_eof};
		1116	$hdl->{on_eof} = sub {
		1117	_destroy_state %state;
959		1118
960	$state{connect_guard} = $tcp_connect->($rhost, $rport, $connect_cb, $arg{on_prepare} \|\| sub { $timeout });	1119	%state = ();
		1120	$state{recurse} =
		1121	http_request (
		1122	$method => $url,
		1123	%arg,
		1124	recurse => $recurse - 1,
		1125	keepalive => 0,
		1126	sub {
		1127	%state = ();
		1128	&$cb
		1129	}
		1130	);
		1131	};
		1132	$hdl->on_read (sub {
		1133	return unless %state;
		1134
		1135	# as soon as we receive something, a connection close
		1136	# once more becomes a hard error
		1137	$hdl->{on_eof} = $old_eof;
		1138	$hdl->push_read (line => $qr_nlnl, $state{read_response});
		1139	});
		1140	} else {
		1141	$hdl->push_read (line => $qr_nlnl, $state{read_response});
		1142	}
961	};	1143	};
962		1144
		1145	my $prepare_handle = sub {
		1146	my ($hdl) = $state{handle};
		1147
		1148	$hdl->on_error (sub {
		1149	_error %state, $cb, { @pseudo, Status => $ae_error, Reason => $_[2] };
		1150	});
		1151	$hdl->on_eof (sub {
		1152	_error %state, $cb, { @pseudo, Status => $ae_error, Reason => "Unexpected end-of-file" };
		1153	});
		1154	$hdl->timeout_reset;
		1155	$hdl->timeout ($timeout);
		1156	};
		1157
		1158	# connected to proxy (or origin server)
		1159	my $connect_cb = sub {
		1160	my $fh = shift
		1161	or return _error %state, $cb, { @pseudo, Status => $ae_error, Reason => "$!" };
		1162
		1163	return unless delete $state{connect_guard};
		1164
		1165	# get handle
		1166	$state{handle} = new AnyEvent::Handle
		1167	%{ $arg{handle_params} },
		1168	fh => $fh,
		1169	peername => $uhost,
		1170	tls_ctx => $arg{tls_ctx},
		1171	;
		1172
		1173	$prepare_handle->();
		1174
		1175	#$state{handle}->starttls ("connect") if $rscheme eq "https";
		1176
		1177	# now handle proxy-CONNECT method
		1178	if ($proxy && $uscheme eq "https") {
		1179	# oh dear, we have to wrap it into a connect request
		1180
		1181	# maybe re-use $uauthority with patched port?
		1182	$state{handle}->push_write ("CONNECT $uhost:$uport HTTP/1.0\015\012\015\012");
		1183	$state{handle}->push_read (line => $qr_nlnl, sub {
		1184	$_[1] =~ /^HTTP\/([0-9\.]+) \s+ ([0-9]{3}) (?: \s+ ([^\015\012]*) )?/ix
		1185	or return _error %state, $cb, { @pseudo, Status => 599, Reason => "Invalid proxy connect response ($_[1])" };
		1186
		1187	if ($2 == 200) {
		1188	$rpath = $upath;
		1189	$handle_actual_request->();
		1190	} else {
		1191	_error %state, $cb, { @pseudo, Status => $2, Reason => $3 };
		1192	}
		1193	});
		1194	} else {
		1195	$handle_actual_request->();
		1196	}
		1197	};
		1198
		1199	_get_slot $uhost, sub {
		1200	$state{slot_guard} = shift;
		1201
		1202	return unless $state{connect_guard};
		1203
		1204	# try to use an existing keepalive connection, but only if we, ourselves, plan
		1205	# on a keepalive request (in theory, this should be a separate config option).
		1206	if ($persistent && $KA_CACHE{$ka_key}) {
		1207	$was_persistent = 1;
		1208
		1209	$state{handle} = ka_fetch $ka_key;
		1210	$state{handle}->destroyed
		1211	and die "AnyEvent::HTTP: unexpectedly got a destructed handle (1), please report.";#d#
		1212	$prepare_handle->();
		1213	$state{handle}->destroyed
		1214	and die "AnyEvent::HTTP: unexpectedly got a destructed handle (2), please report.";#d#
		1215	$handle_actual_request->();
		1216
		1217	} else {
		1218	my $tcp_connect = $arg{tcp_connect}
		1219	\|\| do { require AnyEvent::Socket; \&AnyEvent::Socket::tcp_connect };
		1220
		1221	$state{connect_guard} = $tcp_connect->($rhost, $rport, $connect_cb, $arg{on_prepare} \|\| sub { $timeout });
		1222	}
		1223	};
		1224
963	defined wantarray && AnyEvent::Util::guard { %state = () }	1225	defined wantarray && AnyEvent::Util::guard { _destroy_state %state }
964	}	1226	}
965		1227
966	sub http_get($@) {	1228	sub http_get($@) {
967	unshift @_, "GET";	1229	unshift @_, "GET";
968	&http_request	1230	&http_request
…		…
986	AnyEvent::HTTP uses the AnyEvent::Socket::tcp_connect function for	1248	AnyEvent::HTTP uses the AnyEvent::Socket::tcp_connect function for
987	the actual connection, which in turn uses AnyEvent::DNS to resolve	1249	the actual connection, which in turn uses AnyEvent::DNS to resolve
988	hostnames. The latter is a simple stub resolver and does no caching	1250	hostnames. The latter is a simple stub resolver and does no caching
989	on its own. If you want DNS caching, you currently have to provide	1251	on its own. If you want DNS caching, you currently have to provide
990	your own default resolver (by storing a suitable resolver object in	1252	your own default resolver (by storing a suitable resolver object in
991	C<$AnyEvent::DNS::RESOLVER>).	1253	C<$AnyEvent::DNS::RESOLVER>) or your own C<tcp_connect> callback.
992		1254
993	=head2 GLOBAL FUNCTIONS AND VARIABLES	1255	=head2 GLOBAL FUNCTIONS AND VARIABLES
994		1256
995	=over 4	1257	=over 4
996		1258
997	=item AnyEvent::HTTP::set_proxy "proxy-url"	1259	=item AnyEvent::HTTP::set_proxy "proxy-url"
998		1260
999	Sets the default proxy server to use. The proxy-url must begin with a	1261	Sets the default proxy server to use. The proxy-url must begin with a
1000	string of the form C<http://host:port> (optionally C<https:...>), croaks	1262	string of the form C<http://host:port>, croaks otherwise.
1001	otherwise.
1002		1263
1003	To clear an already-set proxy, use C<undef>.	1264	To clear an already-set proxy, use C<undef>.
		1265
		1266	When AnyEvent::HTTP is loaded for the first time it will query the
		1267	default proxy from the operating system, currently by looking at
		1268	C<$ENV{http_proxy>}.
1004		1269
1005	=item AnyEvent::HTTP::cookie_jar_expire $jar[, $session_end]	1270	=item AnyEvent::HTTP::cookie_jar_expire $jar[, $session_end]
1006		1271
1007	Remove all cookies from the cookie jar that have been expired. If	1272	Remove all cookies from the cookie jar that have been expired. If
1008	C<$session_end> is given and true, then additionally remove all session	1273	C<$session_end> is given and true, then additionally remove all session
1009	cookies.	1274	cookies.
1010		1275
1011	You should call this function (with a true C<$session_end>) before you	1276	You should call this function (with a true C<$session_end>) before you
1012	save cookies to disk, and you should call this function after loading them	1277	save cookies to disk, and you should call this function after loading them
1013	again. If you have a long-running program you can additonally call this	1278	again. If you have a long-running program you can additionally call this
1014	function from time to time.	1279	function from time to time.
1015		1280
1016	A cookie jar is initially an empty hash-reference that is managed by this	1281	A cookie jar is initially an empty hash-reference that is managed by this
1017	module. It's format is subject to change, but currently it is like this:	1282	module. It's format is subject to change, but currently it is like this:
1018		1283
1019	The key C<version> has to contain C<1>, otherwise the hash gets	1284	The key C<version> has to contain C<1>, otherwise the hash gets
1020	emptied. All other keys are hostnames or IP addresses pointing to	1285	emptied. All other keys are hostnames or IP addresses pointing to
1021	hash-references. The key for these inner hash references is the	1286	hash-references. The key for these inner hash references is the
1022	server path for which this cookie is meant, and the values are again	1287	server path for which this cookie is meant, and the values are again
1023	hash-references. The keys of those hash-references is the cookie name, and	1288	hash-references. Each key of those hash-references is a cookie name, and
1024	the value, you guessed it, is another hash-reference, this time with the	1289	the value, you guessed it, is another hash-reference, this time with the
1025	key-value pairs from the cookie, except for C<expires> and C<max-age>,	1290	key-value pairs from the cookie, except for C<expires> and C<max-age>,
1026	which have been replaced by a C<_expires> key that contains the cookie	1291	which have been replaced by a C<_expires> key that contains the cookie
1027	expiry timestamp.	1292	expiry timestamp. Session cookies are indicated by not having an
		1293	C<_expires> key.
1028		1294
1029	Here is an example of a cookie jar with a single cookie, so you have a	1295	Here is an example of a cookie jar with a single cookie, so you have a
1030	chance of understanding the above paragraph:	1296	chance of understanding the above paragraph:
1031		1297
1032	{	1298	{
…		…
1054		1320
1055	=item $AnyEvent::HTTP::MAX_RECURSE	1321	=item $AnyEvent::HTTP::MAX_RECURSE
1056		1322
1057	The default value for the C<recurse> request parameter (default: C<10>).	1323	The default value for the C<recurse> request parameter (default: C<10>).
1058		1324
		1325	=item $AnyEvent::HTTP::TIMEOUT
		1326
		1327	The default timeout for connection operations (default: C<300>).
		1328
1059	=item $AnyEvent::HTTP::USERAGENT	1329	=item $AnyEvent::HTTP::USERAGENT
1060		1330
1061	The default value for the C<User-Agent> header (the default is	1331	The default value for the C<User-Agent> header (the default is
1062	C<Mozilla/5.0 (compatible; U; AnyEvent-HTTP/$VERSION; +http://software.schmorp.de/pkg/AnyEvent)>).	1332	C<Mozilla/5.0 (compatible; U; AnyEvent-HTTP/$VERSION; +http://software.schmorp.de/pkg/AnyEvent)>).
1063		1333
1064	=item $AnyEvent::HTTP::MAX_PER_HOST	1334	=item $AnyEvent::HTTP::MAX_PER_HOST
1065		1335
1066	The maximum number of concurrent connections to the same host (identified	1336	The maximum number of concurrent connections to the same host (identified
1067	by the hostname). If the limit is exceeded, then the additional requests	1337	by the hostname). If the limit is exceeded, then the additional requests
1068	are queued until previous connections are closed.	1338	are queued until previous connections are closed. Both persistent and
		1339	non-persistent connections are counted in this limit.
1069		1340
1070	The default value for this is C<4>, and it is highly advisable to not	1341	The default value for this is C<4>, and it is highly advisable to not
1071	increase it.	1342	increase it much.
		1343
		1344	For comparison: the RFC's recommend 4 non-persistent or 2 persistent
		1345	connections, older browsers used 2, newer ones (such as firefox 3)
		1346	typically use 6, and Opera uses 8 because like, they have the fastest
		1347	browser and give a shit for everybody else on the planet.
		1348
		1349	=item $AnyEvent::HTTP::PERSISTENT_TIMEOUT
		1350
		1351	The time after which idle persistent connections get closed by
		1352	AnyEvent::HTTP (default: C<3>).
1072		1353
1073	=item $AnyEvent::HTTP::ACTIVE	1354	=item $AnyEvent::HTTP::ACTIVE
1074		1355
1075	The number of active connections. This is not the number of currently	1356	The number of active connections. This is not the number of currently
1076	running requests, but the number of currently open and non-idle TCP	1357	running requests, but the number of currently open and non-idle TCP
1077	connections. This number of can be useful for load-leveling.	1358	connections. This number can be useful for load-leveling.
1078		1359
1079	=back	1360	=back
1080		1361
1081	=cut	1362	=cut
1082		1363
…		…
1116	# other formats fail in the loop below	1397	# other formats fail in the loop below
1117		1398
1118	for (0..11) {	1399	for (0..11) {
1119	if ($m eq $month[$_]) {	1400	if ($m eq $month[$_]) {
1120	require Time::Local;	1401	require Time::Local;
1121	return Time::Local::timegm ($S, $M, $H, $d, $_, $y);	1402	return eval { Time::Local::timegm ($S, $M, $H, $d, $_, $y) };
1122	}	1403	}
1123	}	1404	}
1124		1405
1125	undef	1406	undef
1126	}	1407	}
1127		1408
1128	sub set_proxy($) {	1409	sub set_proxy($) {
1129	if (length $_[0]) {	1410	if (length $_[0]) {
1130	$_[0] =~ m%^(https?):// ([^:/]+) (?: : (\d*) )?%ix	1411	$_[0] =~ m%^(http):// ([^:/]+) (?: : (\d*) )?%ix
1131	or Carp::croak "$_[0]: invalid proxy URL";	1412	or Carp::croak "$_[0]: invalid proxy URL";
1132	$PROXY = [$2, $3 \|\| 3128, $1]	1413	$PROXY = [$2, $3 \|\| 3128, $1]
1133	} else {	1414	} else {
1134	undef $PROXY;	1415	undef $PROXY;
1135	}	1416	}
…		…
1138	# initialise proxy from environment	1419	# initialise proxy from environment
1139	eval {	1420	eval {
1140	set_proxy $ENV{http_proxy};	1421	set_proxy $ENV{http_proxy};
1141	};	1422	};
1142		1423
		1424	=head2 SHOWCASE
		1425
		1426	This section contains some more elaborate "real-world" examples or code
		1427	snippets.
		1428
		1429	=head2 HTTP/1.1 FILE DOWNLOAD
		1430
		1431	Downloading files with HTTP can be quite tricky, especially when something
		1432	goes wrong and you want to resume.
		1433
		1434	Here is a function that initiates and resumes a download. It uses the
		1435	last modified time to check for file content changes, and works with many
		1436	HTTP/1.0 servers as well, and usually falls back to a complete re-download
		1437	on older servers.
		1438
		1439	It calls the completion callback with either C<undef>, which means a
		1440	nonretryable error occurred, C<0> when the download was partial and should
		1441	be retried, and C<1> if it was successful.
		1442
		1443	use AnyEvent::HTTP;
		1444
		1445	sub download($$$) {
		1446	my ($url, $file, $cb) = @_;
		1447
		1448	open my $fh, "+<", $file
		1449	or die "$file: $!";
		1450
		1451	my %hdr;
		1452	my $ofs = 0;
		1453
		1454	warn stat $fh;
		1455	warn -s _;
		1456	if (stat $fh and -s _) {
		1457	$ofs = -s _;
		1458	warn "-s is ", $ofs;
		1459	$hdr{"if-unmodified-since"} = AnyEvent::HTTP::format_date +(stat _)[9];
		1460	$hdr{"range"} = "bytes=$ofs-";
		1461	}
		1462
		1463	http_get $url,
		1464	headers => \%hdr,
		1465	on_header => sub {
		1466	my ($hdr) = @_;
		1467
		1468	if ($hdr->{Status} == 200 && $ofs) {
		1469	# resume failed
		1470	truncate $fh, $ofs = 0;
		1471	}
		1472
		1473	sysseek $fh, $ofs, 0;
		1474
		1475	1
		1476	},
		1477	on_body => sub {
		1478	my ($data, $hdr) = @_;
		1479
		1480	if ($hdr->{Status} =~ /^2/) {
		1481	length $data == syswrite $fh, $data
		1482	or return; # abort on write errors
		1483	}
		1484
		1485	1
		1486	},
		1487	sub {
		1488	my (undef, $hdr) = @_;
		1489
		1490	my $status = $hdr->{Status};
		1491
		1492	if (my $time = AnyEvent::HTTP::parse_date $hdr->{"last-modified"}) {
		1493	utime $fh, $time, $time;
		1494	}
		1495
		1496	if ($status == 200 \|\| $status == 206 \|\| $status == 416) {
		1497	# download ok \|\| resume ok \|\| file already fully downloaded
		1498	$cb->(1, $hdr);
		1499
		1500	} elsif ($status == 412) {
		1501	# file has changed while resuming, delete and retry
		1502	unlink $file;
		1503	$cb->(0, $hdr);
		1504
		1505	} elsif ($status == 500 or $status == 503 or $status =~ /^59/) {
		1506	# retry later
		1507	$cb->(0, $hdr);
		1508
		1509	} else {
		1510	$cb->(undef, $hdr);
		1511	}
		1512	}
		1513	;
		1514	}
		1515
		1516	download "http://server/somelargefile", "/tmp/somelargefile", sub {
		1517	if ($_[0]) {
		1518	print "OK!\n";
		1519	} elsif (defined $_[0]) {
		1520	print "please retry later\n";
		1521	} else {
		1522	print "ERROR\n";
		1523	}
		1524	};
		1525
1143	=head2 SOCKS PROXIES	1526	=head3 SOCKS PROXIES
1144		1527
1145	Socks proxies are not directly supported by AnyEvent::HTTP. You can	1528	Socks proxies are not directly supported by AnyEvent::HTTP. You can
1146	compile your perl to support socks, or use an external program such as	1529	compile your perl to support socks, or use an external program such as
1147	F<socksify> (dante) or F<tsocks> to make your program use a socks proxy	1530	F<socksify> (dante) or F<tsocks> to make your program use a socks proxy
1148	transparently.	1531	transparently.

Diff Legend

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

Comparing AnyEvent-HTTP/HTTP.pm (file contents): Revision 1.83 by root, Sun Jan 2 05:02:28 2011 UTC vs. Revision 1.119 by root, Sun Jun 8 23:33:28 2014 UTC

Diff Legend

Comparing AnyEvent-HTTP/HTTP.pm (file contents):
Revision 1.83 by root, Sun Jan 2 05:02:28 2011 UTC vs.
Revision 1.119 by root, Sun Jun 8 23:33:28 2014 UTC