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

Comparing AnyEvent-HTTP/HTTP.pm (file contents):
Revision 1.91 by root, Mon Jan 3 01:03:29 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 = 2;
63	our $MAX_PER_HOST = 4;
64		60
65	our $PROXY;	61	our $PROXY;
66	our $ACTIVE = 0;	62	our $ACTIVE = 0;
67		63
68	my %KA_COUNT; # number of open keep-alive connections per host	64	my %KA_CACHE; # indexed by uhost currently, points to [$handle...] array
69	my %CO_SLOT; # number of open connections, and wait queue, per host	65	my %CO_SLOT; # number of open connections, and wait queue, per host
70		66
71	=item http_get $url, key => value..., $cb->($data, $headers)	67	=item http_get $url, key => value..., $cb->($data, $headers)
72		68
73	Executes an HTTP-GET request. See the http_request function for details on	69	Executes an HTTP-GET request. See the http_request function for details on
…		…
183		179
184	Default timeout is 5 minutes.	180	Default timeout is 5 minutes.
185		181
186	=item proxy => [$host, $port[, $scheme]] or undef	182	=item proxy => [$host, $port[, $scheme]] or undef
187		183
188	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
189	default proxy (as specified by C<$ENV{http_proxy}>) is used.	185	used.
190		186
191	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.
192	HTTPS.	188
		189	If not specified, then the default proxy is used (see
		190	C<AnyEvent::HTTP::set_proxy>).
193		191
194	=item body => $string	192	=item body => $string
195		193
196	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
197	this module might offer more options).	195	this module might offer more options).
…		…
227	verification, highest compatibility) and high-security (CA and common-name	225	verification, highest compatibility) and high-security (CA and common-name
228	verification) TLS context.	226	verification) TLS context.
229		227
230	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
231	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.
232		240
233	=item on_prepare => $callback->($fh)	241	=item on_prepare => $callback->($fh)
234		242
235	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
236	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
…		…
306	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
307	callback will receive the L<AnyEvent::Handle> object associated with the	315	callback will receive the L<AnyEvent::Handle> object associated with the
308	connection. In error cases, C<undef> will be passed. When there is no body	316	connection. In error cases, C<undef> will be passed. When there is no body
309	(e.g. status C<304>), the empty string will be passed.	317	(e.g. status C<304>), the empty string will be passed.
310		318
311	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
312	a proxy, be a persistent connection etc., and configured in unspecified	320	to a proxy, be a persistent connection, use chunked transfer encoding
313	ways. The user is responsible for this handle (it will not be used by this	321	etc., and configured in unspecified ways. The user is responsible for this
314	module anymore).	322	handle (it will not be used by this module anymore).
315		323
316	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
317	headers, an interactive protocol is used (typical example would be the	325	headers, an interactive protocol is used (typical example would be the
318	push-style twitter API which starts a JSON/XML stream).	326	push-style twitter API which starts a JSON/XML stream).
319		327
320	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
321	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	},
322		371
323	=back	372	=back
324		373
325	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
326	the response body.	375	the response body.
…		…
353	};	402	};
354		403
355	undef $request;	404	undef $request;
356		405
357	=cut	406	=cut
		407
		408	#############################################################################
		409	# wait queue/slots
358		410
359	sub _slot_schedule;	411	sub _slot_schedule;
360	sub _slot_schedule($) {	412	sub _slot_schedule($) {
361	my $host = shift;	413	my $host = shift;
362		414
…		…
385		437
386	_slot_schedule $_[0];	438	_slot_schedule $_[0];
387	}	439	}
388		440
389	#############################################################################	441	#############################################################################
		442	# cookie handling
390		443
391	# expire cookies	444	# expire cookies
392	sub cookie_jar_expire($;$) {	445	sub cookie_jar_expire($;$) {
393	my ($jar, $session_end) = @_;	446	my ($jar, $session_end) = @_;
394		447
…		…
418	}	471	}
419	}	472	}
420		473
421	# extract cookies from jar	474	# extract cookies from jar
422	sub cookie_jar_extract($$$$) {	475	sub cookie_jar_extract($$$$) {
423	my ($jar, $uscheme, $uhost, $upath) = @_;	476	my ($jar, $scheme, $host, $path) = @_;
424		477
425	%$jar = () if $jar->{version} != 1;	478	%$jar = () if $jar->{version} != 1;
426		479
427	my @cookies;	480	my @cookies;
428		481
429	while (my ($chost, $paths) = each %$jar) {	482	while (my ($chost, $paths) = each %$jar) {
430	next unless ref $paths;	483	next unless ref $paths;
431		484
432	if ($chost =~ /^\./) {	485	if ($chost =~ /^\./) {
433	next unless $chost eq substr $uhost, -length $chost;	486	next unless $chost eq substr $host, -length $chost;
434	} elsif ($chost =~ /\./) {	487	} elsif ($chost =~ /\./) {
435	next unless $chost eq $uhost;	488	next unless $chost eq $host;
436	} else {	489	} else {
437	next;	490	next;
438	}	491	}
439		492
440	while (my ($cpath, $cookies) = each %$paths) {	493	while (my ($cpath, $cookies) = each %$paths) {
441	next unless $cpath eq substr $upath, 0, length $cpath;	494	next unless $cpath eq substr $path, 0, length $cpath;
442		495
443	while (my ($cookie, $kv) = each %$cookies) {	496	while (my ($cookie, $kv) = each %$cookies) {
444	next if $uscheme ne "https" && exists $kv->{secure};	497	next if $scheme ne "https" && exists $kv->{secure};
445		498
446	if (exists $kv->{_expires} and AE::now > $kv->{_expires}) {	499	if (exists $kv->{_expires} and AE::now > $kv->{_expires}) {
447	delete $cookies->{$cookie};	500	delete $cookies->{$cookie};
448	next;	501	next;
449	}	502	}
…		…
463	\@cookies	516	\@cookies
464	}	517	}
465		518
466	# parse set_cookie header into jar	519	# parse set_cookie header into jar
467	sub cookie_jar_set_cookie($$$$) {	520	sub cookie_jar_set_cookie($$$$) {
468	my ($jar, $set_cookie, $uhost, $date) = @_;	521	my ($jar, $set_cookie, $host, $date) = @_;
469		522
470	my $anow = int AE::now;	523	my $anow = int AE::now;
471	my $snow; # server-now	524	my $snow; # server-now
472		525
473	for ($set_cookie) {	526	for ($set_cookie) {
…		…
479	while (	532	while (
480	m{	533	m{
481	\G\s*	534	\G\s*
482	(?:	535	(?:
483	expires \s=\s ([A-Z][a-z][a-z]+,\ [^,;]+)	536	expires \s=\s ([A-Z][a-z][a-z]+,\ [^,;]+)
484	\| ([^=;,[:space:]]+) (?: \s=\s (?: "((?:[^\\"]+\|\\.))" \| ([^=;,[:space:]]) ) )?	537	\| ([^=;,[:space:]]+) (?: \s=\s (?: "((?:[^\\"]+\|\\.))" \| ([^;,[:space:]]) ) )?
485	)	538	)
486	}gcxsi	539	}gcxsi
487	) {	540	) {
488	my $name = $2;	541	my $name = $2;
489	my $value = $4;	542	my $value = $4;
…		…
496	# quoted	549	# quoted
497	$value = $3;	550	$value = $3;
498	$value =~ s/\\(.)/$1/gs;	551	$value =~ s/\\(.)/$1/gs;
499	}	552	}
500		553
501	push @kv, lc $name, $value;	554	push @kv, @kv ? lc $name : $name, $value;
502		555
503	last unless /\G\s*;/gc;	556	last unless /\G\s*;/gc;
504	}	557	}
505		558
506	last unless @kv;	559	last unless @kv;
…		…
529		582
530	# this is not rfc-like and not netscape-like. go figure.	583	# this is not rfc-like and not netscape-like. go figure.
531	my $ndots = $cdom =~ y/.//;	584	my $ndots = $cdom =~ y/.//;
532	next if $ndots < ($cdom =~ /\.[^.][^.]\.[^.][^.]$/ ? 3 : 2);	585	next if $ndots < ($cdom =~ /\.[^.][^.]\.[^.][^.]$/ ? 3 : 2);
533	} else {	586	} else {
534	$cdom = $uhost;	587	$cdom = $host;
535	}	588	}
536		589
537	# store it	590	# store it
538	$jar->{version} = 1;	591	$jar->{version} = 1;
539	$jar->{lc $cdom}{$cpath}{$name} = \%kv;	592	$jar->{lc $cdom}{$cpath}{$name} = \%kv;
540		593
541	redo if /\G\s*,/gc;	594	redo if /\G\s*,/gc;
542	}	595	}
543	}	596	}
544		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
545	# continue to parse $_ for headers and place them into the arg	640	# continue to parse $_ for headers and place them into the arg
546	sub parse_hdr() {	641	sub _parse_hdr() {
547	my %hdr;	642	my %hdr;
548		643
549	# things seen, not parsed:	644	# things seen, not parsed:
550	# p3pP="NON CUR OTPi OUR NOR UNI"	645	# p3pP="NON CUR OTPi OUR NOR UNI"
551		646
…		…
565	for values %hdr;	660	for values %hdr;
566		661
567	\%hdr	662	\%hdr
568	}	663	}
569		664
		665	#############################################################################
		666	# http_get
		667
570	our $qr_nlnl = qr{(?<![^\012])\015?\012};	668	our $qr_nlnl = qr{(?<![^\012])\015?\012};
571		669
572	our $TLS_CTX_LOW = { cache => 1, sslv2 => 1 };	670	our $TLS_CTX_LOW = { cache => 1, sslv2 => 1 };
573	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	}
574		690
575	sub http_request($$@) {	691	sub http_request($$@) {
576	my $cb = pop;	692	my $cb = pop;
577	my ($method, $url, %arg) = @_;	693	my ($method, $url, %arg) = @_;
578		694
…		…
596	my $recurse = exists $arg{recurse} ? delete $arg{recurse} : $MAX_RECURSE;	712	my $recurse = exists $arg{recurse} ? delete $arg{recurse} : $MAX_RECURSE;
597		713
598	return $cb->(undef, { @pseudo, Status => 599, Reason => "Too many redirections" })	714	return $cb->(undef, { @pseudo, Status => 599, Reason => "Too many redirections" })
599	if $recurse < 0;	715	if $recurse < 0;
600		716
601	my $proxy = $arg{proxy} \|\| $PROXY;	717	my $proxy = exists $arg{proxy} ? $arg{proxy} : $PROXY;
602	my $timeout = $arg{timeout} \|\| $TIMEOUT;	718	my $timeout = $arg{timeout} \|\| $TIMEOUT;
603		719
604	my ($uscheme, $uauthority, $upath, $query, $fragment) =	720	my ($uscheme, $uauthority, $upath, $query, undef) = # ignore fragment
605	$url =~ m\|(?:([^:/?#]+):)?(?://([^/?#]))?([^?#])(?:(\?[^#]))?(?:#(.))?\|;	721	$url =~ m\|^([^:]+):(?://([^/?#]))?([^?#])(?:(\?[^#]))?(?:#(.))?$\|;
606		722
607	$uscheme = lc $uscheme;	723	$uscheme = lc $uscheme;
608		724
609	my $uport = $uscheme eq "http" ? 80	725	my $uport = $uscheme eq "http" ? 80
610	: $uscheme eq "https" ? 443	726	: $uscheme eq "https" ? 443
…		…
657	if length $arg{body} \|\| $method ne "GET";	773	if length $arg{body} \|\| $method ne "GET";
658		774
659	my $idempotent = $method =~ /^(?:GET\|HEAD\|PUT\|DELETE\|OPTIONS\|TRACE)$/;	775	my $idempotent = $method =~ /^(?:GET\|HEAD\|PUT\|DELETE\|OPTIONS\|TRACE)$/;
660		776
661	# default value for keepalive is true iff the request is for an idempotent method	777	# default value for keepalive is true iff the request is for an idempotent method
662	my $keepalive = exists $arg{keepalive}	778	my $persistent = exists $arg{persistent} ? !!$arg{persistent} : $idempotent;
663	? $arg{keepalive}*1	779	my $keepalive = exists $arg{keepalive} ? !!$arg{keepalive} : !$proxy;
664	: $idempotent ? $PERSISTENT_TIMEOUT : 0;	780	my $was_persistent; # true if this is actually a recycled connection
665		781
		782	# the key to use in the keepalive cache
		783	my $ka_key = "$uhost\x00$arg{sessionid}";
		784
666	$hdr{connection} = ($keepalive ? "" : "close ") . "Te"; #1.1	785	$hdr{connection} = ($persistent ? $keepalive ? "keep-alive " : "" : "close ") . "Te"; #1.1
667	$hdr{te} = "trailers" unless exists $hdr{te}; #1.1	786	$hdr{te} = "trailers" unless exists $hdr{te}; #1.1
668		787
669	my %state = (connect_guard => 1);	788	my %state = (connect_guard => 1);
670		789
671	my $ae_error = 595; # connecting	790	my $ae_error = 595; # connecting
672		791
673	# handle actual, non-tunneled, request	792	# handle actual, non-tunneled, request
674	my $handle_actual_request = sub {	793	my $handle_actual_request = sub {
675	$ae_error = 596; # request phase	794	$ae_error = 596; # request phase
676		795
		796	my $hdl = $state{handle};
		797
677	$state{handle}->starttls ("connect") if $uscheme eq "https" && !exists $state{handle}{tls};	798	$hdl->starttls ("connect") if $uscheme eq "https" && !exists $hdl->{tls};
678		799
679	# send request	800	# send request
680	$state{handle}->push_write (	801	$hdl->push_write (
681	"$method $rpath HTTP/1.1\015\012"	802	"$method $rpath HTTP/1.1\015\012"
682	. (join "", map "\u$_: $hdr{$_}\015\012", grep defined $hdr{$_}, keys %hdr)	803	. (join "", map "\u$_: $hdr{$_}\015\012", grep defined $hdr{$_}, keys %hdr)
683	. "\015\012"	804	. "\015\012"
684	. (delete $arg{body})	805	. (delete $arg{body})
685	);	806	);
…		…
690	# reduce memory usage, save a kitten, also re-use it for the response headers.	811	# reduce memory usage, save a kitten, also re-use it for the response headers.
691	%hdr = ();	812	%hdr = ();
692		813
693	# status line and headers	814	# status line and headers
694	$state{read_response} = sub {	815	$state{read_response} = sub {
		816	return unless %state;
		817
695	for ("$_[1]") {	818	for ("$_[1]") {
696	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.
697		820
698	/^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
699	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" };
700		823
701	# 100 Continue handling	824	# 100 Continue handling
702	# should not happen as we don't send expect: 100-continue,	825	# should not happen as we don't send expect: 100-continue,
703	# but we handle it just in case.	826	# but we handle it just in case.
704	# 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
…		…
710	HTTPVersion => $1,	833	HTTPVersion => $1,
711	Status => $2,	834	Status => $2,
712	Reason => $3,	835	Reason => $3,
713	;	836	;
714		837
715	my $hdr = parse_hdr	838	my $hdr = _parse_hdr
716	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" };
717		840
718	%hdr = (%$hdr, @pseudo);	841	%hdr = (%$hdr, @pseudo);
719	}	842	}
720		843
721	# redirect handling	844	# redirect handling
…		…
751	} elsif ($status == 307) {	874	} elsif ($status == 307) {
752	$redirect = 1;	875	$redirect = 1;
753	}	876	}
754	}	877	}
755		878
756	my $finish = sub { # ($data, $err_status, $err_reason[, $keepalive])	879	my $finish = sub { # ($data, $err_status, $err_reason[, $persistent])
757	my $may_keep_alive = $_[3];	880	if ($state{handle}) {
758		881	# handle keepalive
		882	if (
		883	$persistent
		884	&& $_[3]
		885	&& ($hdr{HTTPVersion} < 1.1
		886	? $hdr{connection} =~ /\bkeep-?alive\b/i
		887	: $hdr{connection} !~ /\bclose\b/i)
		888	) {
		889	ka_store $ka_key, delete $state{handle};
		890	} else {
		891	# no keepalive, destroy the handle
759	$state{handle}->destroy if $state{handle};	892	$state{handle}->destroy;
		893	}
		894	}
		895
760	%state = ();	896	%state = ();
761		897
762	if (defined $_[1]) {	898	if (defined $_[1]) {
763	$hdr{OrigStatus} = $hdr{Status}; $hdr{Status} = $_[1];	899	$hdr{OrigStatus} = $hdr{Status}; $hdr{Status} = $_[1];
764	$hdr{OrigReason} = $hdr{Reason}; $hdr{Reason} = $_[2];	900	$hdr{OrigReason} = $hdr{Reason}; $hdr{Reason} = $_[2];
…		…
771		907
772	if ($redirect && exists $hdr{location}) {	908	if ($redirect && exists $hdr{location}) {
773	# we ignore any errors, as it is very common to receive	909	# we ignore any errors, as it is very common to receive
774	# Content-Length != 0 but no actual body	910	# Content-Length != 0 but no actual body
775	# we also access %hdr, as $_[1] might be an erro	911	# we also access %hdr, as $_[1] might be an erro
		912	$state{recurse} =
776	http_request (	913	http_request (
777	$method => $hdr{location},	914	$method => $hdr{location},
778	%arg,	915	%arg,
779	recurse => $recurse - 1,	916	recurse => $recurse - 1,
780	Redirect => [$_[0], \%hdr],	917	Redirect => [$_[0], \%hdr],
		918	sub {
		919	%state = ();
		920	&$cb
		921	},
781	$cb);	922	);
782	} else {	923	} else {
783	$cb->($_[0], \%hdr);	924	$cb->($_[0], \%hdr);
784	}	925	}
785	};	926	};
786		927
…		…
813		954
814	$finish->(delete $state{handle});	955	$finish->(delete $state{handle});
815		956
816	} elsif ($chunked) {	957	} elsif ($chunked) {
817	my $cl = 0;	958	my $cl = 0;
818	my $body = undef;	959	my $body = "";
819	my $on_body = $arg{on_body} \|\| sub { $body .= shift; 1 };	960	my $on_body = $arg{on_body} \|\| sub { $body .= shift; 1 };
820		961
821	$state{read_chunk} = sub {	962	$state{read_chunk} = sub {
822	$_[1] =~ /^([0-9a-fA-F]+)/	963	$_[1] =~ /^([0-9a-fA-F]+)/
823	or $finish->(undef, $ae_error => "Garbled chunked transfer encoding");	964	or $finish->(undef, $ae_error => "Garbled chunked transfer encoding");
…		…
843	$_[0]->push_read (line => $qr_nlnl, sub {	984	$_[0]->push_read (line => $qr_nlnl, sub {
844	if (length $_[1]) {	985	if (length $_[1]) {
845	for ("$_[1]") {	986	for ("$_[1]") {
846	y/\015//d; # weed out any \015, as they show up in the weirdest of places.	987	y/\015//d; # weed out any \015, as they show up in the weirdest of places.
847		988
848	my $hdr = parse_hdr	989	my $hdr = _parse_hdr
849	or return $finish->(undef, $ae_error => "Garbled response trailers");	990	or return $finish->(undef, $ae_error => "Garbled response trailers");
850		991
851	%hdr = (%hdr, %$hdr);	992	%hdr = (%hdr, %$hdr);
852	}	993	}
853	}	994	}
…		…
896	$_[0]->on_read (sub { });	1037	$_[0]->on_read (sub { });
897	}	1038	}
898	}	1039	}
899	};	1040	};
900		1041
		1042	# if keepalive is enabled, then the server closing the connection
		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;
		1048
		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 {
901	$state{handle}->push_read (line => $qr_nlnl, $state{read_response});	1070	$hdl->push_read (line => $qr_nlnl, $state{read_response});
		1071	}
902	};	1072	};
903		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)
904	my $connect_cb = sub {	1088	my $connect_cb = sub {
905	$state{fh} = shift	1089	my $fh = shift
906	or do {
907	my $err = "$!";
908	%state = ();
909	return $cb->(undef, { @pseudo, Status => $ae_error, Reason => $err });	1090	or return _error %state, $cb, { @pseudo, Status => $ae_error, Reason => "$!" };
910	};
911		1091
912	return unless delete $state{connect_guard};	1092	return unless delete $state{connect_guard};
913		1093
914	# get handle	1094	# get handle
915	$state{handle} = new AnyEvent::Handle	1095	$state{handle} = new AnyEvent::Handle
		1096	%{ $arg{handle_params} },
916	fh => $state{fh},	1097	fh => $fh,
917	peername => $rhost,	1098	peername => $uhost,
918	tls_ctx => $arg{tls_ctx},	1099	tls_ctx => $arg{tls_ctx},
919	# these need to be reconfigured on keepalive handles
920	timeout => $timeout,
921	on_error => sub {
922	%state = ();
923	$cb->(undef, { @pseudo, Status => $ae_error, Reason => $_[2] });
924	},
925	on_eof => sub {
926	%state = ();
927	$cb->(undef, { @pseudo, Status => $ae_error, Reason => "Unexpected end-of-file" });
928	},
929	;	1100	;
930		1101
931	# limit the number of persistent connections	1102	$prepare_handle->();
932	# keepalive not yet supported
933	# if ($KA_COUNT{$_[1]} < $MAX_PERSISTENT_PER_HOST) {
934	# ++$KA_COUNT{$_[1]};
935	# $state{handle}{ka_count_guard} = AnyEvent::Util::guard {
936	# --$KA_COUNT{$_[1]}
937	# };
938	# $hdr{connection} = "keep-alive";
939	# }
940		1103
941	$state{handle}->starttls ("connect") if $rscheme eq "https";	1104	#$state{handle}->starttls ("connect") if $rscheme eq "https";
942		1105
943	# now handle proxy-CONNECT method	1106	# now handle proxy-CONNECT method
944	if ($proxy && $uscheme eq "https") {	1107	if ($proxy && $uscheme eq "https") {
945	# oh dear, we have to wrap it into a connect request	1108	# oh dear, we have to wrap it into a connect request
946		1109
947	# maybe re-use $uauthority with patched port?	1110	# maybe re-use $uauthority with patched port?
948	$state{handle}->push_write ("CONNECT $uhost:$uport HTTP/1.0\015\012\015\012");	1111	$state{handle}->push_write ("CONNECT $uhost:$uport HTTP/1.0\015\012\015\012");
949	$state{handle}->push_read (line => $qr_nlnl, sub {	1112	$state{handle}->push_read (line => $qr_nlnl, sub {
950	$_[1] =~ /^HTTP\/([0-9\.]+) \s+ ([0-9]{3}) (?: \s+ ([^\015\012]*) )?/ix	1113	$_[1] =~ /^HTTP\/([0-9\.]+) \s+ ([0-9]{3}) (?: \s+ ([^\015\012]*) )?/ix
951	or return (%state = (), $cb->(undef, { @pseudo, Status => 599, Reason => "Invalid proxy connect response ($_[1])" }));	1114	or return _error %state, $cb, { @pseudo, Status => 599, Reason => "Invalid proxy connect response ($_[1])" };
952		1115
953	if ($2 == 200) {	1116	if ($2 == 200) {
954	$rpath = $upath;	1117	$rpath = $upath;
955	$handle_actual_request->();	1118	$handle_actual_request->();
956	} else {	1119	} else {
957	%state = ();
958	$cb->(undef, { @pseudo, Status => $2, Reason => $3 });	1120	_error %state, $cb, { @pseudo, Status => $2, Reason => $3 };
959	}	1121	}
960	});	1122	});
961	} else {	1123	} else {
962	$handle_actual_request->();	1124	$handle_actual_request->();
963	}	1125	}
…		…
966	_get_slot $uhost, sub {	1128	_get_slot $uhost, sub {
967	$state{slot_guard} = shift;	1129	$state{slot_guard} = shift;
968		1130
969	return unless $state{connect_guard};	1131	return unless $state{connect_guard};
970		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 {
971	my $tcp_connect = $arg{tcp_connect}	1149	my $tcp_connect = $arg{tcp_connect}
972	\|\| do { require AnyEvent::Socket; \&AnyEvent::Socket::tcp_connect };	1150	\|\| do { require AnyEvent::Socket; \&AnyEvent::Socket::tcp_connect };
973		1151
974	$state{connect_guard} = $tcp_connect->($rhost, $rport, $connect_cb, $arg{on_prepare} \|\| sub { $timeout });	1152	$state{connect_guard} = $tcp_connect->($rhost, $rport, $connect_cb, $arg{on_prepare} \|\| sub { $timeout });
		1153	}
975	};	1154	};
976		1155
977	defined wantarray && AnyEvent::Util::guard { %state = () }	1156	defined wantarray && AnyEvent::Util::guard { _destroy_state %state }
978	}	1157	}
979		1158
980	sub http_get($@) {	1159	sub http_get($@) {
981	unshift @_, "GET";	1160	unshift @_, "GET";
982	&http_request	1161	&http_request
…		…
1000	AnyEvent::HTTP uses the AnyEvent::Socket::tcp_connect function for	1179	AnyEvent::HTTP uses the AnyEvent::Socket::tcp_connect function for
1001	the actual connection, which in turn uses AnyEvent::DNS to resolve	1180	the actual connection, which in turn uses AnyEvent::DNS to resolve
1002	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
1003	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
1004	your own default resolver (by storing a suitable resolver object in	1183	your own default resolver (by storing a suitable resolver object in
1005	C<$AnyEvent::DNS::RESOLVER>).	1184	C<$AnyEvent::DNS::RESOLVER>) or your own C<tcp_connect> callback.
1006		1185
1007	=head2 GLOBAL FUNCTIONS AND VARIABLES	1186	=head2 GLOBAL FUNCTIONS AND VARIABLES
1008		1187
1009	=over 4	1188	=over 4
1010		1189
1011	=item AnyEvent::HTTP::set_proxy "proxy-url"	1190	=item AnyEvent::HTTP::set_proxy "proxy-url"
1012		1191
1013	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
1014	string of the form C<http://host:port> (optionally C<https:...>), croaks	1193	string of the form C<http://host:port>, croaks otherwise.
1015	otherwise.
1016		1194
1017	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>}.
1018		1200
1019	=item AnyEvent::HTTP::cookie_jar_expire $jar[, $session_end]	1201	=item AnyEvent::HTTP::cookie_jar_expire $jar[, $session_end]
1020		1202
1021	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
1022	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
…		…
1068		1250
1069	=item $AnyEvent::HTTP::MAX_RECURSE	1251	=item $AnyEvent::HTTP::MAX_RECURSE
1070		1252
1071	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>).
1072		1254
		1255	=item $AnyEvent::HTTP::TIMEOUT
		1256
		1257	The default timeout for conenction operations (default: C<300>).
		1258
1073	=item $AnyEvent::HTTP::USERAGENT	1259	=item $AnyEvent::HTTP::USERAGENT
1074		1260
1075	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
1076	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)>).
1077		1263
1078	=item $AnyEvent::HTTP::MAX_PER_HOST	1264	=item $AnyEvent::HTTP::MAX_PER_HOST
1079		1265
1080	The maximum number of concurrent connections to the same host (identified	1266	The maximum number of concurrent connections to the same host (identified
1081	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
1082	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.
1083		1270
1084	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
1085	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>).
1086		1283
1087	=item $AnyEvent::HTTP::ACTIVE	1284	=item $AnyEvent::HTTP::ACTIVE
1088		1285
1089	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
1090	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
1091	connections. This number of can be useful for load-leveling.	1288	connections. This number can be useful for load-leveling.
1092		1289
1093	=back	1290	=back
1094		1291
1095	=cut	1292	=cut
1096		1293
…		…
1139	undef	1336	undef
1140	}	1337	}
1141		1338
1142	sub set_proxy($) {	1339	sub set_proxy($) {
1143	if (length $_[0]) {	1340	if (length $_[0]) {
1144	$_[0] =~ m%^(https?):// ([^:/]+) (?: : (\d*) )?%ix	1341	$_[0] =~ m%^(http):// ([^:/]+) (?: : (\d*) )?%ix
1145	or Carp::croak "$_[0]: invalid proxy URL";	1342	or Carp::croak "$_[0]: invalid proxy URL";
1146	$PROXY = [$2, $3 \|\| 3128, $1]	1343	$PROXY = [$2, $3 \|\| 3128, $1]
1147	} else {	1344	} else {
1148	undef $PROXY;	1345	undef $PROXY;
1149	}	1346	}
…		…
1152	# initialise proxy from environment	1349	# initialise proxy from environment
1153	eval {	1350	eval {
1154	set_proxy $ENV{http_proxy};	1351	set_proxy $ENV{http_proxy};
1155	};	1352	};
1156		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
1157	=head2 SOCKS PROXIES	1456	=head3 SOCKS PROXIES
1158		1457
1159	Socks proxies are not directly supported by AnyEvent::HTTP. You can	1458	Socks proxies are not directly supported by AnyEvent::HTTP. You can
1160	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
1161	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
1162	transparently.	1461	transparently.

Diff Legend

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

Comparing AnyEvent-HTTP/HTTP.pm (file contents): Revision 1.91 by root, Mon Jan 3 01:03:29 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.91 by root, Mon Jan 3 01:03:29 2011 UTC vs.
Revision 1.103 by root, Thu Feb 24 12:13:11 2011 UTC