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

Comparing AnyEvent-HTTP/HTTP.pm (file contents):
Revision 1.85 by root, Sun Jan 2 05:31:56 2011 UTC vs.
Revision 1.103 by root, Thu Feb 24 12:13:11 2011 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.1';
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 = 0;
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
…		…
169	C<Host:>, C<Content-Length:>, C<Connection:> and C<Cookie:> headers and	165	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:>	166	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	167	(this can be suppressed by using C<undef> for these headers in which case
172	they won't be sent at all).	168	they won't be sent at all).
173		169
		170	You really should provide your own C<User-Agent:> header value that is
		171	appropriate for your program - I wouldn't be surprised if the default
		172	AnyEvent string gets blocked by webservers sooner or later.
		173
174	=item timeout => $seconds	174	=item timeout => $seconds
175		175
176	The time-out to use for various stages - each connect attempt will reset	176	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	177	the timeout, as will read or write activity, i.e. this is not an overall
178	timeout.	178	timeout.
179		179
180	Default timeout is 5 minutes.	180	Default timeout is 5 minutes.
181		181
182	=item proxy => [$host, $port[, $scheme]] or undef	182	=item proxy => [$host, $port[, $scheme]] or undef
183		183
184	Use the given http proxy for all requests. If not specified, then the	184	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.	185	used.
186		186
187	C<$scheme> must be either missing, C<http> for HTTP or C<https> for	187	C<$scheme> must be either missing or must be C<http> for HTTP.
188	HTTPS.	188
		189	If not specified, then the default proxy is used (see
		190	C<AnyEvent::HTTP::set_proxy>).
189		191
190	=item body => $string	192	=item body => $string
191		193
192	The request body, usually empty. Will be sent as-is (future versions of	194	The request body, usually empty. Will be sent as-is (future versions of
193	this module might offer more options).	195	this module might offer more options).
…		…
223	verification, highest compatibility) and high-security (CA and common-name	225	verification, highest compatibility) and high-security (CA and common-name
224	verification) TLS context.	226	verification) TLS context.
225		227
226	The default for this option is C<low>, which could be interpreted as "give	228	The default for this option is C<low>, which could be interpreted as "give
227	me the page, no matter what".	229	me the page, no matter what".
		230
		231	See also the C<sessionid> parameter.
		232
		233	=item session => $string
		234
		235	The module might reuse connections to the same host internally. Sometimes
		236	(e.g. when using TLS), you do not want to reuse connections from other
		237	sessions. This can be achieved by setting this parameter to some unique
		238	ID (such as the address of an object storing your state data, or the TLS
		239	context) - only connections using the same unique ID will be reused.
228		240
229	=item on_prepare => $callback->($fh)	241	=item on_prepare => $callback->($fh)
230		242
231	In rare cases you need to "tune" the socket before it is used to	243	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	244	connect (for exmaple, to bind it on a given IP address). This parameter
…		…
302	called. Instead of the C<$body> argument containing the body data, the	314	called. Instead of the C<$body> argument containing the body data, the
303	callback will receive the L<AnyEvent::Handle> object associated with the	315	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	316	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.	317	(e.g. status C<304>), the empty string will be passed.
306		318
307	The handle object might or might not be in TLS mode, might be connected to	319	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	320	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	321	etc., and configured in unspecified ways. The user is responsible for this
310	module anymore).	322	handle (it will not be used by this module anymore).
311		323
312	This is useful with some push-type services, where, after the initial	324	This is useful with some push-type services, where, after the initial
313	headers, an interactive protocol is used (typical example would be the	325	headers, an interactive protocol is used (typical example would be the
314	push-style twitter API which starts a JSON/XML stream).	326	push-style twitter API which starts a JSON/XML stream).
315		327
316	If you think you need this, first have a look at C<on_body>, to see if	328	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.	329	that doesn't solve your problem in a better way.
		330
		331	=item persistent => $boolean
		332
		333	Try to create/reuse a persistent connection. When this flag is set
		334	(default: true for idempotent requests, false for all others), then
		335	C<http_request> tries to re-use an existing (previously-created)
		336	persistent connection to the host and, failing that, tries to create a new
		337	one.
		338
		339	Requests failing in certain ways will be automatically retried once, which
		340	is dangerous for non-idempotent requests, which is why it defaults to off
		341	for them. The reason for this is because the bozos who designed HTTP/1.1
		342	made it impossible to distinguish between a fatal error and a normal
		343	connection timeout, so you never know whether there was a problem with
		344	your request or not.
		345
		346	When reusing an existent connection, many parameters (such as TLS context)
		347	will be ignored. See the C<session> parameter for a workaround.
		348
		349	=item keepalive => $boolean
		350
		351	Only used when C<persistent> is also true. This parameter decides whether
		352	C<http_request> tries to handshake a HTTP/1.0-style keep-alive connection
		353	(as opposed to only a HTTP/1.1 persistent connection).
		354
		355	The default is true, except when using a proxy, in which case it defaults
		356	to false, as HTTP/1.0 proxies cannot support this in a meaningful way.
		357
		358	=item handle_params => { key => value ... }
		359
		360	The key-value pairs in this hash will be passed to any L<AnyEvent::Handle>
		361	constructor that is called - not all requests will create a handle, and
		362	sometimes more than one is created, so this parameter is only good for
		363	setting hints.
		364
		365	Example: set the maximum read size to 4096, to potentially conserve memory
		366	at the cost of speed.
		367
		368	handle_params => {
		369	max_read_size => 4096,
		370	},
318		371
319	=back	372	=back
320		373
321	Example: do a simple HTTP GET request for http://www.nethype.de/ and print	374	Example: do a simple HTTP GET request for http://www.nethype.de/ and print
322	the response body.	375	the response body.
…		…
329	Example: do a HTTP HEAD request on https://www.google.com/, use a	382	Example: do a HTTP HEAD request on https://www.google.com/, use a
330	timeout of 30 seconds.	383	timeout of 30 seconds.
331		384
332	http_request	385	http_request
333	GET => "https://www.google.com",	386	GET => "https://www.google.com",
		387	headers => { "user-agent" => "MySearchClient 1.0" },
334	timeout => 30,	388	timeout => 30,
335	sub {	389	sub {
336	my ($body, $hdr) = @_;	390	my ($body, $hdr) = @_;
337	use Data::Dumper;	391	use Data::Dumper;
338	print Dumper $hdr;	392	print Dumper $hdr;
…		…
348	};	402	};
349		403
350	undef $request;	404	undef $request;
351		405
352	=cut	406	=cut
		407
		408	#############################################################################
		409	# wait queue/slots
353		410
354	sub _slot_schedule;	411	sub _slot_schedule;
355	sub _slot_schedule($) {	412	sub _slot_schedule($) {
356	my $host = shift;	413	my $host = shift;
357		414
…		…
380		437
381	_slot_schedule $_[0];	438	_slot_schedule $_[0];
382	}	439	}
383		440
384	#############################################################################	441	#############################################################################
		442	# cookie handling
385		443
386	# expire cookies	444	# expire cookies
387	sub cookie_jar_expire($;$) {	445	sub cookie_jar_expire($;$) {
388	my ($jar, $session_end) = @_;	446	my ($jar, $session_end) = @_;
389		447
…		…
413	}	471	}
414	}	472	}
415		473
416	# extract cookies from jar	474	# extract cookies from jar
417	sub cookie_jar_extract($$$$) {	475	sub cookie_jar_extract($$$$) {
418	my ($jar, $uscheme, $uhost, $upath) = @_;	476	my ($jar, $scheme, $host, $path) = @_;
419
420	$uhost = lc $uhost;
421		477
422	%$jar = () if $jar->{version} != 1;	478	%$jar = () if $jar->{version} != 1;
423		479
424	my @cookies;	480	my @cookies;
425		481
426	while (my ($chost, $paths) = each %$jar) {	482	while (my ($chost, $paths) = each %$jar) {
427	next unless ref $paths;	483	next unless ref $paths;
428		484
429	if ($chost =~ /^\./) {	485	if ($chost =~ /^\./) {
430	next unless $chost eq substr $uhost, -length $chost;	486	next unless $chost eq substr $host, -length $chost;
431	} elsif ($chost =~ /\./) {	487	} elsif ($chost =~ /\./) {
432	next unless $chost eq $uhost;	488	next unless $chost eq $host;
433	} else {	489	} else {
434	next;	490	next;
435	}	491	}
436		492
437	while (my ($cpath, $cookies) = each %$paths) {	493	while (my ($cpath, $cookies) = each %$paths) {
438	next unless $cpath eq substr $upath, 0, length $cpath;	494	next unless $cpath eq substr $path, 0, length $cpath;
439		495
440	while (my ($cookie, $kv) = each %$cookies) {	496	while (my ($cookie, $kv) = each %$cookies) {
441	next if $uscheme ne "https" && exists $kv->{secure};	497	next if $scheme ne "https" && exists $kv->{secure};
442		498
443	if (exists $kv->{_expires} and AE::now > $kv->{_expires}) {	499	if (exists $kv->{_expires} and AE::now > $kv->{_expires}) {
444	delete $cookies->{$cookie};	500	delete $cookies->{$cookie};
445	next;	501	next;
446	}	502	}
…		…
460	\@cookies	516	\@cookies
461	}	517	}
462		518
463	# parse set_cookie header into jar	519	# parse set_cookie header into jar
464	sub cookie_jar_set_cookie($$$$) {	520	sub cookie_jar_set_cookie($$$$) {
465	my ($jar, $set_cookie, $uhost, $date) = @_;	521	my ($jar, $set_cookie, $host, $date) = @_;
466		522
467	my $anow = int AE::now;	523	my $anow = int AE::now;
468	my $snow; # server-now	524	my $snow; # server-now
469		525
470	for ($set_cookie) {	526	for ($set_cookie) {
…		…
476	while (	532	while (
477	m{	533	m{
478	\G\s*	534	\G\s*
479	(?:	535	(?:
480	expires \s=\s ([A-Z][a-z][a-z]+,\ [^,;]+)	536	expires \s=\s ([A-Z][a-z][a-z]+,\ [^,;]+)
481	\| ([^=;,[:space:]]+) (?: \s=\s (?: "((?:[^\\"]+\|\\.))" \| ([^=;,[:space:]]) ) )?	537	\| ([^=;,[:space:]]+) (?: \s=\s (?: "((?:[^\\"]+\|\\.))" \| ([^;,[:space:]]) ) )?
482	)	538	)
483	}gcxsi	539	}gcxsi
484	) {	540	) {
485	my $name = $2;	541	my $name = $2;
486	my $value = $4;	542	my $value = $4;
…		…
493	# quoted	549	# quoted
494	$value = $3;	550	$value = $3;
495	$value =~ s/\\(.)/$1/gs;	551	$value =~ s/\\(.)/$1/gs;
496	}	552	}
497		553
498	push @kv, lc $name, $value;	554	push @kv, @kv ? lc $name : $name, $value;
499		555
500	last unless /\G\s*;/gc;	556	last unless /\G\s*;/gc;
501	}	557	}
502		558
503	last unless @kv;	559	last unless @kv;
…		…
526		582
527	# this is not rfc-like and not netscape-like. go figure.	583	# this is not rfc-like and not netscape-like. go figure.
528	my $ndots = $cdom =~ y/.//;	584	my $ndots = $cdom =~ y/.//;
529	next if $ndots < ($cdom =~ /\.[^.][^.]\.[^.][^.]$/ ? 3 : 2);	585	next if $ndots < ($cdom =~ /\.[^.][^.]\.[^.][^.]$/ ? 3 : 2);
530	} else {	586	} else {
531	$cdom = $uhost;	587	$cdom = $host;
532	}	588	}
533		589
534	# store it	590	# store it
535	$jar->{version} = 1;	591	$jar->{version} = 1;
536	$jar->{lc $cdom}{$cpath}{$name} = \%kv;	592	$jar->{lc $cdom}{$cpath}{$name} = \%kv;
537		593
538	redo if /\G\s*,/gc;	594	redo if /\G\s*,/gc;
539	}	595	}
540	}	596	}
541		597
		598	#############################################################################
		599	# keepalive/persistent connection cache
		600
		601	# fetch a connection from the keepalive cache
		602	sub ka_fetch($) {
		603	my $ka_key = shift;
		604
		605	my $hdl = pop @{ $KA_CACHE{$ka_key} }; # currently we reuse the MOST RECENTLY USED connection
		606	delete $KA_CACHE{$ka_key}
		607	unless @{ $KA_CACHE{$ka_key} };
		608
		609	$hdl
		610	}
		611
		612	sub ka_store($$) {
		613	my ($ka_key, $hdl) = @_;
		614
		615	my $kaa = $KA_CACHE{$ka_key} \|\|= [];
		616
		617	my $destroy = sub {
		618	my @ka = grep $_ != $hdl, @{ $KA_CACHE{$ka_key} };
		619
		620	$hdl->destroy;
		621
		622	@ka
		623	? $KA_CACHE{$ka_key} = \@ka
		624	: delete $KA_CACHE{$ka_key};
		625	};
		626
		627	# on error etc., destroy
		628	$hdl->on_error ($destroy);
		629	$hdl->on_eof ($destroy);
		630	$hdl->on_read ($destroy);
		631	$hdl->timeout ($PERSISTENT_TIMEOUT);
		632
		633	push @$kaa, $hdl;
		634	shift @$kaa while @$kaa > $MAX_PER_HOST;
		635	}
		636
		637	#############################################################################
		638	# utilities
		639
542	# continue to parse $_ for headers and place them into the arg	640	# continue to parse $_ for headers and place them into the arg
543	sub parse_hdr() {	641	sub _parse_hdr() {
544	my %hdr;	642	my %hdr;
545		643
546	# things seen, not parsed:	644	# things seen, not parsed:
547	# p3pP="NON CUR OTPi OUR NOR UNI"	645	# p3pP="NON CUR OTPi OUR NOR UNI"
548		646
…		…
562	for values %hdr;	660	for values %hdr;
563		661
564	\%hdr	662	\%hdr
565	}	663	}
566		664
		665	#############################################################################
		666	# http_get
		667
567	our $qr_nlnl = qr{(?<![^\012])\015?\012};	668	our $qr_nlnl = qr{(?<![^\012])\015?\012};
568		669
569	our $TLS_CTX_LOW = { cache => 1, sslv2 => 1 };	670	our $TLS_CTX_LOW = { cache => 1, sslv2 => 1 };
570	our $TLS_CTX_HIGH = { cache => 1, verify => 1, verify_peername => "https" };	671	our $TLS_CTX_HIGH = { cache => 1, verify => 1, verify_peername => "https" };
		672
		673	# maybe it should just become a normal object :/
		674
		675	sub _destroy_state(\%) {
		676	my ($state) = @_;
		677
		678	$state->{handle}->destroy if $state->{handle};
		679	%$state = ();
		680	}
		681
		682	sub _error(\%$$) {
		683	my ($state, $cb, $hdr) = @_;
		684
		685	&_destroy_state ($state);
		686
		687	$cb->(undef, $hdr);
		688	()
		689	}
571		690
572	sub http_request($$@) {	691	sub http_request($$@) {
573	my $cb = pop;	692	my $cb = pop;
574	my ($method, $url, %arg) = @_;	693	my ($method, $url, %arg) = @_;
575		694
…		…
593	my $recurse = exists $arg{recurse} ? delete $arg{recurse} : $MAX_RECURSE;	712	my $recurse = exists $arg{recurse} ? delete $arg{recurse} : $MAX_RECURSE;
594		713
595	return $cb->(undef, { @pseudo, Status => 599, Reason => "Too many redirections" })	714	return $cb->(undef, { @pseudo, Status => 599, Reason => "Too many redirections" })
596	if $recurse < 0;	715	if $recurse < 0;
597		716
598	my $proxy = $arg{proxy} \|\| $PROXY;	717	my $proxy = exists $arg{proxy} ? $arg{proxy} : $PROXY;
599	my $timeout = $arg{timeout} \|\| $TIMEOUT;	718	my $timeout = $arg{timeout} \|\| $TIMEOUT;
600		719
601	my ($uscheme, $uauthority, $upath, $query, $fragment) =	720	my ($uscheme, $uauthority, $upath, $query, undef) = # ignore fragment
602	$url =~ m\|(?:([^:/?#]+):)?(?://([^/?#]))?([^?#])(?:(\?[^#]))?(?:#(.))?\|;	721	$url =~ m\|^([^:]+):(?://([^/?#]))?([^?#])(?:(\?[^#]))?(?:#(.))?$\|;
603		722
604	$uscheme = lc $uscheme;	723	$uscheme = lc $uscheme;
605		724
606	my $uport = $uscheme eq "http" ? 80	725	my $uport = $uscheme eq "http" ? 80
607	: $uscheme eq "https" ? 443	726	: $uscheme eq "https" ? 443
608	: return $cb->(undef, { @pseudo, Status => 599, Reason => "Only http and https URL schemes supported" });	727	: return $cb->(undef, { @pseudo, Status => 599, Reason => "Only http and https URL schemes supported" });
609		728
610	$uauthority =~ /^(?: .*\@ )? ([^\@:]+) (?: : (\d+) )?$/x	729	$uauthority =~ /^(?: .*\@ )? ([^\@:]+) (?: : (\d+) )?$/x
611	or return $cb->(undef, { @pseudo, Status => 599, Reason => "Unparsable URL" });	730	or return $cb->(undef, { @pseudo, Status => 599, Reason => "Unparsable URL" });
612		731
613	my $uhost = $1;	732	my $uhost = lc $1;
614	$uport = $2 if defined $2;	733	$uport = $2 if defined $2;
615		734
616	$hdr{host} = defined $2 ? "$uhost:$2" : "$uhost"	735	$hdr{host} = defined $2 ? "$uhost:$2" : "$uhost"
617	unless exists $hdr{host};	736	unless exists $hdr{host};
618		737
…		…
637	$rscheme = "http" unless defined $rscheme;	756	$rscheme = "http" unless defined $rscheme;
638		757
639	# don't support https requests over https-proxy transport,	758	# don't support https requests over https-proxy transport,
640	# can't be done with tls as spec'ed, unless you double-encrypt.	759	# can't be done with tls as spec'ed, unless you double-encrypt.
641	$rscheme = "http" if $uscheme eq "https" && $rscheme eq "https";	760	$rscheme = "http" if $uscheme eq "https" && $rscheme eq "https";
		761
		762	$rhost = lc $rhost;
		763	$rscheme = lc $rscheme;
642	} else {	764	} else {
643	($rhost, $rport, $rscheme, $rpath) = ($uhost, $uport, $uscheme, $upath);	765	($rhost, $rport, $rscheme, $rpath) = ($uhost, $uport, $uscheme, $upath);
644	}	766	}
645		767
646	# leave out fragment and query string, just a heuristic	768	# leave out fragment and query string, just a heuristic
…		…
648	$hdr{"user-agent"} = $USERAGENT unless exists $hdr{"user-agent"};	770	$hdr{"user-agent"} = $USERAGENT unless exists $hdr{"user-agent"};
649		771
650	$hdr{"content-length"} = length $arg{body}	772	$hdr{"content-length"} = length $arg{body}
651	if length $arg{body} \|\| $method ne "GET";	773	if length $arg{body} \|\| $method ne "GET";
652		774
653	$hdr{connection} = "close TE"; #1.1	775	my $idempotent = $method =~ /^(?:GET\|HEAD\|PUT\|DELETE\|OPTIONS\|TRACE)$/;
		776
		777	# default value for keepalive is true iff the request is for an idempotent method
		778	my $persistent = exists $arg{persistent} ? !!$arg{persistent} : $idempotent;
		779	my $keepalive = exists $arg{keepalive} ? !!$arg{keepalive} : !$proxy;
		780	my $was_persistent; # true if this is actually a recycled connection
		781
		782	# the key to use in the keepalive cache
		783	my $ka_key = "$uhost\x00$arg{sessionid}";
		784
		785	$hdr{connection} = ($persistent ? $keepalive ? "keep-alive " : "" : "close ") . "Te"; #1.1
654	$hdr{te} = "trailers" unless exists $hdr{te}; #1.1	786	$hdr{te} = "trailers" unless exists $hdr{te}; #1.1
655		787
656	my %state = (connect_guard => 1);	788	my %state = (connect_guard => 1);
657		789
658	_get_slot $uhost, sub {
659	$state{slot_guard} = shift;
660
661	return unless $state{connect_guard};
662
663	my $ae_error = 595; # connecting	790	my $ae_error = 595; # connecting
664		791
665	# handle actual, non-tunneled, request	792	# handle actual, non-tunneled, request
666	my $handle_actual_request = sub {	793	my $handle_actual_request = sub {
667	$ae_error = 596; # request phase	794	$ae_error = 596; # request phase
668		795
		796	my $hdl = $state{handle};
		797
669	$state{handle}->starttls ("connect") if $uscheme eq "https" && !exists $state{handle}{tls};	798	$hdl->starttls ("connect") if $uscheme eq "https" && !exists $hdl->{tls};
670		799
671	# send request	800	# send request
672	$state{handle}->push_write (	801	$hdl->push_write (
673	"$method $rpath HTTP/1.1\015\012"	802	"$method $rpath HTTP/1.1\015\012"
674	. (join "", map "\u$_: $hdr{$_}\015\012", grep defined $hdr{$_}, keys %hdr)	803	. (join "", map "\u$_: $hdr{$_}\015\012", grep defined $hdr{$_}, keys %hdr)
675	. "\015\012"	804	. "\015\012"
676	. (delete $arg{body})	805	. (delete $arg{body})
677	);	806	);
678		807
679	# return if error occured during push_write()	808	# return if error occured during push_write()
		809	return unless %state;
		810
		811	# reduce memory usage, save a kitten, also re-use it for the response headers.
		812	%hdr = ();
		813
		814	# status line and headers
		815	$state{read_response} = sub {
680	return unless %state;	816	return unless %state;
681		817
682	%hdr = (); # reduce memory usage, save a kitten, also make it possible to re-use
683
684	# status line and headers
685	$state{read_response} = sub {
686	for ("$_[1]") {	818	for ("$_[1]") {
687	y/\015//d; # weed out any \015, as they show up in the weirdest of places.	819	y/\015//d; # weed out any \015, as they show up in the weirdest of places.
688		820
689	/^HTTP\/0([0-9\.]+) \s+ ([0-9]{3}) (?: \s+ ([^\012]) )? \012/gxci	821	/^HTTP\/0([0-9\.]+) \s+ ([0-9]{3}) (?: \s+ ([^\012]) )? \012/gxci
690	or return (%state = (), $cb->(undef, { @pseudo, Status => 599, Reason => "Invalid server response" }));	822	or return _error %state, $cb, { @pseudo, Status => 599, Reason => "Invalid server response" };
691		823
692	# 100 Continue handling	824	# 100 Continue handling
693	# should not happen as we don't send expect: 100-continue,	825	# should not happen as we don't send expect: 100-continue,
694	# but we handle it just in case.	826	# but we handle it just in case.
695	# since we send the request body regardless, if we get an error	827	# since we send the request body regardless, if we get an error
696	# we are out of-sync, which we currently do NOT handle correctly.	828	# we are out of-sync, which we currently do NOT handle correctly.
697	return $state{handle}->push_read (line => $qr_nlnl, $state{read_response})	829	return $state{handle}->push_read (line => $qr_nlnl, $state{read_response})
698	if $2 eq 100;	830	if $2 eq 100;
699		831
700	push @pseudo,	832	push @pseudo,
701	HTTPVersion => $1,	833	HTTPVersion => $1,
702	Status => $2,	834	Status => $2,
703	Reason => $3,	835	Reason => $3,
704	;	836	;
705		837
706	my $hdr = parse_hdr	838	my $hdr = _parse_hdr
707	or return (%state = (), $cb->(undef, { @pseudo, Status => 599, Reason => "Garbled response headers" }));	839	or return _error %state, $cb, { @pseudo, Status => 599, Reason => "Garbled response headers" };
708		840
709	%hdr = (%$hdr, @pseudo);	841	%hdr = (%$hdr, @pseudo);
		842	}
		843
		844	# redirect handling
		845	# microsoft and other shitheads don't give a shit for following standards,
		846	# try to support some common forms of broken Location headers.
		847	if ($hdr{location} !~ /^(?: $ \| [^:\/?\#]+ : )/x) {
		848	$hdr{location} =~ s/^\.\/+//;
		849
		850	my $url = "$rscheme://$uhost:$uport";
		851
		852	unless ($hdr{location} =~ s/^\///) {
		853	$url .= $upath;
		854	$url =~ s/\/[^\/]*$//;
710	}	855	}
711		856
712	# redirect handling
713	# microsoft and other shitheads don't give a shit for following standards,
714	# try to support some common forms of broken Location headers.
715	if ($hdr{location} !~ /^(?: $ \| [^:\/?\#]+ : )/x) {
716	$hdr{location} =~ s/^\.\/+//;
717
718	my $url = "$rscheme://$uhost:$uport";
719
720	unless ($hdr{location} =~ s/^\///) {
721	$url .= $upath;
722	$url =~ s/\/[^\/]*$//;
723	}
724
725	$hdr{location} = "$url/$hdr{location}";	857	$hdr{location} = "$url/$hdr{location}";
		858	}
		859
		860	my $redirect;
		861
		862	if ($recurse) {
		863	my $status = $hdr{Status};
		864
		865	# industry standard is to redirect POST as GET for
		866	# 301, 302 and 303, in contrast to HTTP/1.0 and 1.1.
		867	# also, the UA should ask the user for 301 and 307 and POST,
		868	# industry standard seems to be to simply follow.
		869	# we go with the industry standard.
		870	if ($status == 301 or $status == 302 or $status == 303) {
		871	# HTTP/1.1 is unclear on how to mutate the method
		872	$method = "GET" unless $method eq "HEAD";
		873	$redirect = 1;
		874	} elsif ($status == 307) {
		875	$redirect = 1;
726	}	876	}
		877	}
727		878
728	my $redirect;	879	my $finish = sub { # ($data, $err_status, $err_reason[, $persistent])
729		880	if ($state{handle}) {
730	if ($recurse) {	881	# handle keepalive
731	my $status = $hdr{Status};	882	if (
732		883	$persistent
733	# industry standard is to redirect POST as GET for	884	&& $_[3]
734	# 301, 302 and 303, in contrast to HTTP/1.0 and 1.1.	885	&& ($hdr{HTTPVersion} < 1.1
735	# also, the UA should ask the user for 301 and 307 and POST,	886	? $hdr{connection} =~ /\bkeep-?alive\b/i
736	# industry standard seems to be to simply follow.	887	: $hdr{connection} !~ /\bclose\b/i)
737	# we go with the industry standard.	888	) {
738	if ($status == 301 or $status == 302 or $status == 303) {	889	ka_store $ka_key, delete $state{handle};
739	# HTTP/1.1 is unclear on how to mutate the method	890	} else {
740	$method = "GET" unless $method eq "HEAD";	891	# no keepalive, destroy the handle
741	$redirect = 1;	892	$state{handle}->destroy;
742	} elsif ($status == 307) {
743	$redirect = 1;
744	}	893	}
745	}	894	}
746		895
747	my $finish = sub { # ($data, $err_status, $err_reason[, $keepalive])
748	my $may_keep_alive = $_[3];
749
750	$state{handle}->destroy if $state{handle};
751	%state = ();	896	%state = ();
752		897
753	if (defined $_[1]) {	898	if (defined $_[1]) {
754	$hdr{OrigStatus} = $hdr{Status}; $hdr{Status} = $_[1];	899	$hdr{OrigStatus} = $hdr{Status}; $hdr{Status} = $_[1];
755	$hdr{OrigReason} = $hdr{Reason}; $hdr{Reason} = $_[2];	900	$hdr{OrigReason} = $hdr{Reason}; $hdr{Reason} = $_[2];
756	}	901	}
757		902
758	# set-cookie processing	903	# set-cookie processing
759	if ($arg{cookie_jar}) {	904	if ($arg{cookie_jar}) {
760	cookie_jar_set_cookie $arg{cookie_jar}, $hdr{"set-cookie"}, $uhost, $hdr{date};	905	cookie_jar_set_cookie $arg{cookie_jar}, $hdr{"set-cookie"}, $uhost, $hdr{date};
761	}	906	}
762		907
763	if ($redirect && exists $hdr{location}) {	908	if ($redirect && exists $hdr{location}) {
764	# we ignore any errors, as it is very common to receive	909	# we ignore any errors, as it is very common to receive
765	# Content-Length != 0 but no actual body	910	# Content-Length != 0 but no actual body
766	# we also access %hdr, as $_[1] might be an erro	911	# we also access %hdr, as $_[1] might be an erro
		912	$state{recurse} =
767	http_request (	913	http_request (
768	$method => $hdr{location},	914	$method => $hdr{location},
769	%arg,	915	%arg,
770	recurse => $recurse - 1,	916	recurse => $recurse - 1,
771	Redirect => [$_[0], \%hdr],	917	Redirect => [$_[0], \%hdr],
		918	sub {
		919	%state = ();
		920	&$cb
		921	},
		922	);
		923	} else {
		924	$cb->($_[0], \%hdr);
		925	}
		926	};
		927
		928	$ae_error = 597; # body phase
		929
		930	my $chunked = $hdr{"transfer-encoding"} =~ /\bchunked\b/i; # not quite correct...
		931
		932	my $len = $chunked ? undef : $hdr{"content-length"};
		933
		934	# body handling, many different code paths
		935	# - no body expected
		936	# - want_body_handle
		937	# - te chunked
		938	# - 2x length known (with or without on_body)
		939	# - 2x length not known (with or without on_body)
		940	if (!$redirect && $arg{on_header} && !$arg{on_header}(\%hdr)) {
		941	$finish->(undef, 598 => "Request cancelled by on_header");
		942	} elsif (
		943	$hdr{Status} =~ /^(?:1..\|204\|205\|304)$/
		944	or $method eq "HEAD"
		945	or (defined $len && $len == 0) # == 0, not !, because "0 " is true
		946	) {
		947	# no body
		948	$finish->("", undef, undef, 1);
		949
		950	} elsif (!$redirect && $arg{want_body_handle}) {
		951	$_[0]->on_eof (undef);
		952	$_[0]->on_error (undef);
		953	$_[0]->on_read (undef);
		954
		955	$finish->(delete $state{handle});
		956
		957	} elsif ($chunked) {
		958	my $cl = 0;
		959	my $body = "";
		960	my $on_body = $arg{on_body} \|\| sub { $body .= shift; 1 };
		961
		962	$state{read_chunk} = sub {
		963	$_[1] =~ /^([0-9a-fA-F]+)/
		964	or $finish->(undef, $ae_error => "Garbled chunked transfer encoding");
		965
		966	my $len = hex $1;
		967
		968	if ($len) {
		969	$cl += $len;
		970
		971	$_[0]->push_read (chunk => $len, sub {
		972	$on_body->($_[1], \%hdr)
		973	or return $finish->(undef, 598 => "Request cancelled by on_body");
		974
		975	$_[0]->push_read (line => sub {
		976	length $_[1]
		977	and return $finish->(undef, $ae_error => "Garbled chunked transfer encoding");
		978	$_[0]->push_read (line => $state{read_chunk});
772	$cb);	979	});
		980	});
773	} else {	981	} else {
774	$cb->($_[0], \%hdr);	982	$hdr{"content-length"} \|\|= $cl;
		983
		984	$_[0]->push_read (line => $qr_nlnl, sub {
		985	if (length $_[1]) {
		986	for ("$_[1]") {
		987	y/\015//d; # weed out any \015, as they show up in the weirdest of places.
		988
		989	my $hdr = _parse_hdr
		990	or return $finish->(undef, $ae_error => "Garbled response trailers");
		991
		992	%hdr = (%hdr, %$hdr);
		993	}
		994	}
		995
		996	$finish->($body, undef, undef, 1);
		997	});
775	}	998	}
776	};	999	};
777		1000
778	$ae_error = 597; # body phase
779
780	my $len = $hdr{"content-length"};
781
782	# body handling, many different code paths
783	# - no body expected
784	# - want_body_handle
785	# - te chunked
786	# - 2x length known (with or without on_body)
787	# - 2x length not known (with or without on_body)
788	if (!$redirect && $arg{on_header} && !$arg{on_header}(\%hdr)) {
789	$finish->(undef, 598 => "Request cancelled by on_header");
790	} elsif (
791	$hdr{Status} =~ /^(?:1..\|204\|205\|304)$/
792	or $method eq "HEAD"
793	or (defined $len && $len == 0) # == 0, not !, because "0 " is true
794	) {
795	# no body
796	$finish->("", undef, undef, 1);
797
798	} elsif (!$redirect && $arg{want_body_handle}) {
799	$_[0]->on_eof (undef);
800	$_[0]->on_error (undef);
801	$_[0]->on_read (undef);
802
803	$finish->(delete $state{handle});
804
805	} elsif ($hdr{"transfer-encoding"} =~ /\bchunked\b/i) {
806	my $cl = 0;
807	my $body = undef;
808	my $on_body = $arg{on_body} \|\| sub { $body .= shift; 1 };
809
810	$state{read_chunk} = sub {
811	$_[1] =~ /^([0-9a-fA-F]+)/
812	or $finish->(undef, $ae_error => "Garbled chunked transfer encoding");
813
814	my $len = hex $1;
815
816	if ($len) {
817	$cl += $len;
818
819	$_[0]->push_read (chunk => $len, sub {
820	$on_body->($_[1], \%hdr)
821	or return $finish->(undef, 598 => "Request cancelled by on_body");
822
823	$_[0]->push_read (line => sub {
824	length $_[1]
825	and return $finish->(undef, $ae_error => "Garbled chunked transfer encoding");
826	$_[0]->push_read (line => $state{read_chunk});
827	});
828	});
829	} else {
830	$hdr{"content-length"} \|\|= $cl;
831
832	$_[0]->push_read (line => $qr_nlnl, sub {
833	if (length $_[1]) {
834	for ("$_[1]") {
835	y/\015//d; # weed out any \015, as they show up in the weirdest of places.
836
837	my $hdr = parse_hdr
838	or return $finish->(undef, $ae_error => "Garbled response trailers");
839
840	%hdr = (%hdr, %$hdr);
841	}
842	}
843
844	$finish->($body, undef, undef, 1);
845	});
846	}
847	};
848
849	$_[0]->push_read (line => $state{read_chunk});	1001	$_[0]->push_read (line => $state{read_chunk});
850		1002
851	} elsif ($arg{on_body}) {	1003	} elsif ($arg{on_body}) {
852	if (defined $len) {	1004	if (defined $len) {
853	$_[0]->on_read (sub {	1005	$_[0]->on_read (sub {
854	$len -= length $_[0]{rbuf};	1006	$len -= length $_[0]{rbuf};
855		1007
856	$arg{on_body}(delete $_[0]{rbuf}, \%hdr)	1008	$arg{on_body}(delete $_[0]{rbuf}, \%hdr)
857	or return $finish->(undef, 598 => "Request cancelled by on_body");	1009	or return $finish->(undef, 598 => "Request cancelled by on_body");
858		1010
859	$len > 0	1011	$len > 0
860	or $finish->("", undef, undef, 1);	1012	or $finish->("", undef, undef, 1);
861	});
862	} else {
863	$_[0]->on_eof (sub {
864	$finish->("");
865	});
866	$_[0]->on_read (sub {
867	$arg{on_body}(delete $_[0]{rbuf}, \%hdr)
868	or $finish->(undef, 598 => "Request cancelled by on_body");
869	});
870	}	1013	});
871	} else {	1014	} else {
872	$_[0]->on_eof (undef);	1015	$_[0]->on_eof (sub {
873		1016	$finish->("");
874	if (defined $len) {	1017	});
875	$_[0]->on_read (sub {	1018	$_[0]->on_read (sub {
876	$finish->((substr delete $_[0]{rbuf}, 0, $len, ""), undef, undef, 1)	1019	$arg{on_body}(delete $_[0]{rbuf}, \%hdr)
877	if $len <= length $_[0]{rbuf};	1020	or $finish->(undef, 598 => "Request cancelled by on_body");
878	});
879	} else {
880	$_[0]->on_error (sub {
881	($! == Errno::EPIPE \|\| !$!)
882	? $finish->(delete $_[0]{rbuf})
883	: $finish->(undef, $ae_error => $_[2]);
884	});
885	$_[0]->on_read (sub { });
886	}	1021	});
887	}	1022	}
888	};
889
890	$state{handle}->push_read (line => $qr_nlnl, $state{read_response});
891	};
892
893	my $connect_cb = sub {
894	$state{fh} = shift
895	or do {
896	my $err = "$!";
897	%state = ();
898	return $cb->(undef, { @pseudo, Status => $ae_error, Reason => $err });
899	};
900
901	return unless delete $state{connect_guard};
902
903	# get handle
904	$state{handle} = new AnyEvent::Handle
905	fh => $state{fh},
906	peername => $rhost,
907	tls_ctx => $arg{tls_ctx},
908	# these need to be reconfigured on keepalive handles
909	timeout => $timeout,
910	on_error => sub {
911	%state = ();
912	$cb->(undef, { @pseudo, Status => $ae_error, Reason => $_[2] });
913	},
914	on_eof => sub {
915	%state = ();
916	$cb->(undef, { @pseudo, Status => $ae_error, Reason => "Unexpected end-of-file" });
917	},
918	;
919
920	# limit the number of persistent connections
921	# keepalive not yet supported
922	# if ($KA_COUNT{$_[1]} < $MAX_PERSISTENT_PER_HOST) {
923	# ++$KA_COUNT{$_[1]};
924	# $state{handle}{ka_count_guard} = AnyEvent::Util::guard {
925	# --$KA_COUNT{$_[1]}
926	# };
927	# $hdr{connection} = "keep-alive";
928	# }
929
930	$state{handle}->starttls ("connect") if $rscheme eq "https";
931
932	# now handle proxy-CONNECT method
933	if ($proxy && $uscheme eq "https") {
934	# oh dear, we have to wrap it into a connect request
935
936	# maybe re-use $uauthority with patched port?
937	$state{handle}->push_write ("CONNECT $uhost:$uport HTTP/1.0\015\012Host: $uhost\015\012\015\012");
938	$state{handle}->push_read (line => $qr_nlnl, sub {
939	$_[1] =~ /^HTTP\/([0-9\.]+) \s+ ([0-9]{3}) (?: \s+ ([^\015\012]*) )?/ix
940	or return (%state = (), $cb->(undef, { @pseudo, Status => 599, Reason => "Invalid proxy connect response ($_[1])" }));
941
942	if ($2 == 200) {
943	$rpath = $upath;
944	$handle_actual_request->();
945	} else {
946	%state = ();
947	$cb->(undef, { @pseudo, Status => $2, Reason => $3 });
948	}
949	});
950	} else {	1023	} else {
951	$handle_actual_request->();	1024	$_[0]->on_eof (undef);
		1025
		1026	if (defined $len) {
		1027	$_[0]->on_read (sub {
		1028	$finish->((substr delete $_[0]{rbuf}, 0, $len, ""), undef, undef, 1)
		1029	if $len <= length $_[0]{rbuf};
		1030	});
		1031	} else {
		1032	$_[0]->on_error (sub {
		1033	($! == Errno::EPIPE \|\| !$!)
		1034	? $finish->(delete $_[0]{rbuf})
		1035	: $finish->(undef, $ae_error => $_[2]);
		1036	});
		1037	$_[0]->on_read (sub { });
		1038	}
952	}	1039	}
953	};	1040	};
954		1041
955	my $tcp_connect = $arg{tcp_connect}	1042	# if keepalive is enabled, then the server closing the connection
956	\|\| do { require AnyEvent::Socket; \&AnyEvent::Socket::tcp_connect };	1043	# before a response can happen legally - we retry on idempotent methods.
		1044	if ($was_persistent && $idempotent) {
		1045	my $old_eof = $hdl->{on_eof};
		1046	$hdl->{on_eof} = sub {
		1047	_destroy_state %state;
957		1048
958	$state{connect_guard} = $tcp_connect->($rhost, $rport, $connect_cb, $arg{on_prepare} \|\| sub { $timeout });	1049	%state = ();
		1050	$state{recurse} =
		1051	http_request (
		1052	$method => $url,
		1053	%arg,
		1054	keepalive => 0,
		1055	sub {
		1056	%state = ();
		1057	&$cb
		1058	}
		1059	);
		1060	};
		1061	$hdl->on_read (sub {
		1062	return unless %state;
		1063
		1064	# as soon as we receive something, a connection close
		1065	# once more becomes a hard error
		1066	$hdl->{on_eof} = $old_eof;
		1067	$hdl->push_read (line => $qr_nlnl, $state{read_response});
		1068	});
		1069	} else {
		1070	$hdl->push_read (line => $qr_nlnl, $state{read_response});
		1071	}
959	};	1072	};
960		1073
		1074	my $prepare_handle = sub {
		1075	my ($hdl) = $state{handle};
		1076
		1077	$hdl->on_error (sub {
		1078	_error %state, $cb, { @pseudo, Status => $ae_error, Reason => $_[2] };
		1079	});
		1080	$hdl->on_eof (sub {
		1081	_error %state, $cb, { @pseudo, Status => $ae_error, Reason => "Unexpected end-of-file" };
		1082	});
		1083	$hdl->timeout_reset;
		1084	$hdl->timeout ($timeout);
		1085	};
		1086
		1087	# connected to proxy (or origin server)
		1088	my $connect_cb = sub {
		1089	my $fh = shift
		1090	or return _error %state, $cb, { @pseudo, Status => $ae_error, Reason => "$!" };
		1091
		1092	return unless delete $state{connect_guard};
		1093
		1094	# get handle
		1095	$state{handle} = new AnyEvent::Handle
		1096	%{ $arg{handle_params} },
		1097	fh => $fh,
		1098	peername => $uhost,
		1099	tls_ctx => $arg{tls_ctx},
		1100	;
		1101
		1102	$prepare_handle->();
		1103
		1104	#$state{handle}->starttls ("connect") if $rscheme eq "https";
		1105
		1106	# now handle proxy-CONNECT method
		1107	if ($proxy && $uscheme eq "https") {
		1108	# oh dear, we have to wrap it into a connect request
		1109
		1110	# maybe re-use $uauthority with patched port?
		1111	$state{handle}->push_write ("CONNECT $uhost:$uport HTTP/1.0\015\012\015\012");
		1112	$state{handle}->push_read (line => $qr_nlnl, sub {
		1113	$_[1] =~ /^HTTP\/([0-9\.]+) \s+ ([0-9]{3}) (?: \s+ ([^\015\012]*) )?/ix
		1114	or return _error %state, $cb, { @pseudo, Status => 599, Reason => "Invalid proxy connect response ($_[1])" };
		1115
		1116	if ($2 == 200) {
		1117	$rpath = $upath;
		1118	$handle_actual_request->();
		1119	} else {
		1120	_error %state, $cb, { @pseudo, Status => $2, Reason => $3 };
		1121	}
		1122	});
		1123	} else {
		1124	$handle_actual_request->();
		1125	}
		1126	};
		1127
		1128	_get_slot $uhost, sub {
		1129	$state{slot_guard} = shift;
		1130
		1131	return unless $state{connect_guard};
		1132
		1133	# try to use an existing keepalive connection, but only if we, ourselves, plan
		1134	# on a keepalive request (in theory, this should be a separate config option).
		1135	if ($persistent && $KA_CACHE{$ka_key}) {
		1136	$was_persistent = 1;
		1137
		1138	$state{handle} = ka_fetch $ka_key;
		1139	$state{handle}->destroyed
		1140	and die "got a destructed habndle. pah\n";#d#
		1141	$prepare_handle->();
		1142	$state{handle}->destroyed
		1143	and die "got a destructed habndle. pa2\n";#d#
		1144	$handle_actual_request->();
		1145	$state{handle}->destroyed
		1146	and die "got a destructed habndle. pa3\n";#d#
		1147
		1148	} else {
		1149	my $tcp_connect = $arg{tcp_connect}
		1150	\|\| do { require AnyEvent::Socket; \&AnyEvent::Socket::tcp_connect };
		1151
		1152	$state{connect_guard} = $tcp_connect->($rhost, $rport, $connect_cb, $arg{on_prepare} \|\| sub { $timeout });
		1153	}
		1154	};
		1155
961	defined wantarray && AnyEvent::Util::guard { %state = () }	1156	defined wantarray && AnyEvent::Util::guard { _destroy_state %state }
962	}	1157	}
963		1158
964	sub http_get($@) {	1159	sub http_get($@) {
965	unshift @_, "GET";	1160	unshift @_, "GET";
966	&http_request	1161	&http_request
…		…
984	AnyEvent::HTTP uses the AnyEvent::Socket::tcp_connect function for	1179	AnyEvent::HTTP uses the AnyEvent::Socket::tcp_connect function for
985	the actual connection, which in turn uses AnyEvent::DNS to resolve	1180	the actual connection, which in turn uses AnyEvent::DNS to resolve
986	hostnames. The latter is a simple stub resolver and does no caching	1181	hostnames. The latter is a simple stub resolver and does no caching
987	on its own. If you want DNS caching, you currently have to provide	1182	on its own. If you want DNS caching, you currently have to provide
988	your own default resolver (by storing a suitable resolver object in	1183	your own default resolver (by storing a suitable resolver object in
989	C<$AnyEvent::DNS::RESOLVER>).	1184	C<$AnyEvent::DNS::RESOLVER>) or your own C<tcp_connect> callback.
990		1185
991	=head2 GLOBAL FUNCTIONS AND VARIABLES	1186	=head2 GLOBAL FUNCTIONS AND VARIABLES
992		1187
993	=over 4	1188	=over 4
994		1189
995	=item AnyEvent::HTTP::set_proxy "proxy-url"	1190	=item AnyEvent::HTTP::set_proxy "proxy-url"
996		1191
997	Sets the default proxy server to use. The proxy-url must begin with a	1192	Sets the default proxy server to use. The proxy-url must begin with a
998	string of the form C<http://host:port> (optionally C<https:...>), croaks	1193	string of the form C<http://host:port>, croaks otherwise.
999	otherwise.
1000		1194
1001	To clear an already-set proxy, use C<undef>.	1195	To clear an already-set proxy, use C<undef>.
		1196
		1197	When AnyEvent::HTTP is laoded for the first time it will query the
		1198	default proxy from the operating system, currently by looking at
		1199	C<$ENV{http_proxy>}.
1002		1200
1003	=item AnyEvent::HTTP::cookie_jar_expire $jar[, $session_end]	1201	=item AnyEvent::HTTP::cookie_jar_expire $jar[, $session_end]
1004		1202
1005	Remove all cookies from the cookie jar that have been expired. If	1203	Remove all cookies from the cookie jar that have been expired. If
1006	C<$session_end> is given and true, then additionally remove all session	1204	C<$session_end> is given and true, then additionally remove all session
…		…
1052		1250
1053	=item $AnyEvent::HTTP::MAX_RECURSE	1251	=item $AnyEvent::HTTP::MAX_RECURSE
1054		1252
1055	The default value for the C<recurse> request parameter (default: C<10>).	1253	The default value for the C<recurse> request parameter (default: C<10>).
1056		1254
		1255	=item $AnyEvent::HTTP::TIMEOUT
		1256
		1257	The default timeout for conenction operations (default: C<300>).
		1258
1057	=item $AnyEvent::HTTP::USERAGENT	1259	=item $AnyEvent::HTTP::USERAGENT
1058		1260
1059	The default value for the C<User-Agent> header (the default is	1261	The default value for the C<User-Agent> header (the default is
1060	C<Mozilla/5.0 (compatible; U; AnyEvent-HTTP/$VERSION; +http://software.schmorp.de/pkg/AnyEvent)>).	1262	C<Mozilla/5.0 (compatible; U; AnyEvent-HTTP/$VERSION; +http://software.schmorp.de/pkg/AnyEvent)>).
1061		1263
1062	=item $AnyEvent::HTTP::MAX_PER_HOST	1264	=item $AnyEvent::HTTP::MAX_PER_HOST
1063		1265
1064	The maximum number of concurrent connections to the same host (identified	1266	The maximum number of concurrent connections to the same host (identified
1065	by the hostname). If the limit is exceeded, then the additional requests	1267	by the hostname). If the limit is exceeded, then the additional requests
1066	are queued until previous connections are closed.	1268	are queued until previous connections are closed. Both persistent and
		1269	non-persistent connections are counted in this limit.
1067		1270
1068	The default value for this is C<4>, and it is highly advisable to not	1271	The default value for this is C<4>, and it is highly advisable to not
1069	increase it.	1272	increase it much.
		1273
		1274	For comparison: the RFC's recommend 4 non-persistent or 2 persistent
		1275	connections, older browsers used 2, newers (such as firefox 3) typically
		1276	use 6, and Opera uses 8 because like, they have the fastest browser and
		1277	give a shit for everybody else on the planet.
		1278
		1279	=item $AnyEvent::HTTP::PERSISTENT_TIMEOUT
		1280
		1281	The time after which idle persistent conenctions get closed by
		1282	AnyEvent::HTTP (default: C<3>).
1070		1283
1071	=item $AnyEvent::HTTP::ACTIVE	1284	=item $AnyEvent::HTTP::ACTIVE
1072		1285
1073	The number of active connections. This is not the number of currently	1286	The number of active connections. This is not the number of currently
1074	running requests, but the number of currently open and non-idle TCP	1287	running requests, but the number of currently open and non-idle TCP
1075	connections. This number of can be useful for load-leveling.	1288	connections. This number can be useful for load-leveling.
1076		1289
1077	=back	1290	=back
1078		1291
1079	=cut	1292	=cut
1080		1293
…		…
1123	undef	1336	undef
1124	}	1337	}
1125		1338
1126	sub set_proxy($) {	1339	sub set_proxy($) {
1127	if (length $_[0]) {	1340	if (length $_[0]) {
1128	$_[0] =~ m%^(https?):// ([^:/]+) (?: : (\d*) )?%ix	1341	$_[0] =~ m%^(http):// ([^:/]+) (?: : (\d*) )?%ix
1129	or Carp::croak "$_[0]: invalid proxy URL";	1342	or Carp::croak "$_[0]: invalid proxy URL";
1130	$PROXY = [$2, $3 \|\| 3128, $1]	1343	$PROXY = [$2, $3 \|\| 3128, $1]
1131	} else {	1344	} else {
1132	undef $PROXY;	1345	undef $PROXY;
1133	}	1346	}
…		…
1136	# initialise proxy from environment	1349	# initialise proxy from environment
1137	eval {	1350	eval {
1138	set_proxy $ENV{http_proxy};	1351	set_proxy $ENV{http_proxy};
1139	};	1352	};
1140		1353
		1354	=head2 SHOWCASE
		1355
		1356	This section contaisn some more elaborate "real-world" examples or code
		1357	snippets.
		1358
		1359	=head2 HTTP/1.1 FILE DOWNLOAD
		1360
		1361	Downloading files with HTTP can be quite tricky, especially when something
		1362	goes wrong and you want to resume.
		1363
		1364	Here is a function that initiates and resumes a download. It uses the
		1365	last modified time to check for file content changes, and works with many
		1366	HTTP/1.0 servers as well, and usually falls back to a complete re-download
		1367	on older servers.
		1368
		1369	It calls the completion callback with either C<undef>, which means a
		1370	nonretryable error occured, C<0> when the download was partial and should
		1371	be retried, and C<1> if it was successful.
		1372
		1373	use AnyEvent::HTTP;
		1374
		1375	sub download($$$) {
		1376	my ($url, $file, $cb) = @_;
		1377
		1378	open my $fh, "+<", $file
		1379	or die "$file: $!";
		1380
		1381	my %hdr;
		1382	my $ofs = 0;
		1383
		1384	warn stat $fh;
		1385	warn -s _;
		1386	if (stat $fh and -s _) {
		1387	$ofs = -s _;
		1388	warn "-s is ", $ofs;#d#
		1389	$hdr{"if-unmodified-since"} = AnyEvent::HTTP::format_date +(stat _)[9];
		1390	$hdr{"range"} = "bytes=$ofs-";
		1391	}
		1392
		1393	http_get $url,
		1394	headers => \%hdr,
		1395	on_header => sub {
		1396	my ($hdr) = @_;
		1397
		1398	if ($hdr->{Status} == 200 && $ofs) {
		1399	# resume failed
		1400	truncate $fh, $ofs = 0;
		1401	}
		1402
		1403	sysseek $fh, $ofs, 0;
		1404
		1405	1
		1406	},
		1407	on_body => sub {
		1408	my ($data, $hdr) = @_;
		1409
		1410	if ($hdr->{Status} =~ /^2/) {
		1411	length $data == syswrite $fh, $data
		1412	or return; # abort on write errors
		1413	}
		1414
		1415	1
		1416	},
		1417	sub {
		1418	my (undef, $hdr) = @_;
		1419
		1420	my $status = $hdr->{Status};
		1421
		1422	if (my $time = AnyEvent::HTTP::parse_date $hdr->{"last-modified"}) {
		1423	utime $fh, $time, $time;
		1424	}
		1425
		1426	if ($status == 200 \|\| $status == 206 \|\| $status == 416) {
		1427	# download ok \|\| resume ok \|\| file already fully downloaded
		1428	$cb->(1, $hdr);
		1429
		1430	} elsif ($status == 412) {
		1431	# file has changed while resuming, delete and retry
		1432	unlink $file;
		1433	$cb->(0, $hdr);
		1434
		1435	} elsif ($status == 500 or $status == 503 or $status =~ /^59/) {
		1436	# retry later
		1437	$cb->(0, $hdr);
		1438
		1439	} else {
		1440	$cb->(undef, $hdr);
		1441	}
		1442	}
		1443	;
		1444	}
		1445
		1446	download "http://server/somelargefile", "/tmp/somelargefile", sub {
		1447	if ($_[0]) {
		1448	print "OK!\n";
		1449	} elsif (defined $_[0]) {
		1450	print "please retry later\n";
		1451	} else {
		1452	print "ERROR\n";
		1453	}
		1454	};
		1455
1141	=head2 SOCKS PROXIES	1456	=head3 SOCKS PROXIES
1142		1457
1143	Socks proxies are not directly supported by AnyEvent::HTTP. You can	1458	Socks proxies are not directly supported by AnyEvent::HTTP. You can
1144	compile your perl to support socks, or use an external program such as	1459	compile your perl to support socks, or use an external program such as
1145	F<socksify> (dante) or F<tsocks> to make your program use a socks proxy	1460	F<socksify> (dante) or F<tsocks> to make your program use a socks proxy
1146	transparently.	1461	transparently.

Diff Legend

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

Comparing AnyEvent-HTTP/HTTP.pm (file contents): Revision 1.85 by root, Sun Jan 2 05:31:56 2011 UTC vs. Revision 1.103 by root, Thu Feb 24 12:13:11 2011 UTC

Diff Legend

Comparing AnyEvent-HTTP/HTTP.pm (file contents):
Revision 1.85 by root, Sun Jan 2 05:31:56 2011 UTC vs.
Revision 1.103 by root, Thu Feb 24 12:13:11 2011 UTC