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

Comparing AnyEvent-HTTP/HTTP.pm (file contents):
Revision 1.89 by root, Mon Jan 3 00:23:25 2011 UTC vs.
Revision 1.102 by root, Sat Feb 19 06:46:14 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.04';
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
…		…
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		477
420	%$jar = () if $jar->{version} != 1;	478	%$jar = () if $jar->{version} != 1;
421		479
422	my @cookies;	480	my @cookies;
423		481
424	while (my ($chost, $paths) = each %$jar) {	482	while (my ($chost, $paths) = each %$jar) {
425	next unless ref $paths;	483	next unless ref $paths;
426		484
427	if ($chost =~ /^\./) {	485	if ($chost =~ /^\./) {
428	next unless $chost eq substr $uhost, -length $chost;	486	next unless $chost eq substr $host, -length $chost;
429	} elsif ($chost =~ /\./) {	487	} elsif ($chost =~ /\./) {
430	next unless $chost eq $uhost;	488	next unless $chost eq $host;
431	} else {	489	} else {
432	next;	490	next;
433	}	491	}
434		492
435	while (my ($cpath, $cookies) = each %$paths) {	493	while (my ($cpath, $cookies) = each %$paths) {
436	next unless $cpath eq substr $upath, 0, length $cpath;	494	next unless $cpath eq substr $path, 0, length $cpath;
437		495
438	while (my ($cookie, $kv) = each %$cookies) {	496	while (my ($cookie, $kv) = each %$cookies) {
439	next if $uscheme ne "https" && exists $kv->{secure};	497	next if $scheme ne "https" && exists $kv->{secure};
440		498
441	if (exists $kv->{_expires} and AE::now > $kv->{_expires}) {	499	if (exists $kv->{_expires} and AE::now > $kv->{_expires}) {
442	delete $cookies->{$cookie};	500	delete $cookies->{$cookie};
443	next;	501	next;
444	}	502	}
…		…
458	\@cookies	516	\@cookies
459	}	517	}
460		518
461	# parse set_cookie header into jar	519	# parse set_cookie header into jar
462	sub cookie_jar_set_cookie($$$$) {	520	sub cookie_jar_set_cookie($$$$) {
463	my ($jar, $set_cookie, $uhost, $date) = @_;	521	my ($jar, $set_cookie, $host, $date) = @_;
464		522
465	my $anow = int AE::now;	523	my $anow = int AE::now;
466	my $snow; # server-now	524	my $snow; # server-now
467		525
468	for ($set_cookie) {	526	for ($set_cookie) {
…		…
474	while (	532	while (
475	m{	533	m{
476	\G\s*	534	\G\s*
477	(?:	535	(?:
478	expires \s=\s ([A-Z][a-z][a-z]+,\ [^,;]+)	536	expires \s=\s ([A-Z][a-z][a-z]+,\ [^,;]+)
479	\| ([^=;,[:space:]]+) (?: \s=\s (?: "((?:[^\\"]+\|\\.))" \| ([^=;,[:space:]]) ) )?	537	\| ([^=;,[:space:]]+) (?: \s=\s (?: "((?:[^\\"]+\|\\.))" \| ([^;,[:space:]]) ) )?
480	)	538	)
481	}gcxsi	539	}gcxsi
482	) {	540	) {
483	my $name = $2;	541	my $name = $2;
484	my $value = $4;	542	my $value = $4;
…		…
491	# quoted	549	# quoted
492	$value = $3;	550	$value = $3;
493	$value =~ s/\\(.)/$1/gs;	551	$value =~ s/\\(.)/$1/gs;
494	}	552	}
495		553
496	push @kv, lc $name, $value;	554	push @kv, @kv ? lc $name : $name, $value;
497		555
498	last unless /\G\s*;/gc;	556	last unless /\G\s*;/gc;
499	}	557	}
500		558
501	last unless @kv;	559	last unless @kv;
…		…
524		582
525	# this is not rfc-like and not netscape-like. go figure.	583	# this is not rfc-like and not netscape-like. go figure.
526	my $ndots = $cdom =~ y/.//;	584	my $ndots = $cdom =~ y/.//;
527	next if $ndots < ($cdom =~ /\.[^.][^.]\.[^.][^.]$/ ? 3 : 2);	585	next if $ndots < ($cdom =~ /\.[^.][^.]\.[^.][^.]$/ ? 3 : 2);
528	} else {	586	} else {
529	$cdom = $uhost;	587	$cdom = $host;
530	}	588	}
531		589
532	# store it	590	# store it
533	$jar->{version} = 1;	591	$jar->{version} = 1;
534	$jar->{lc $cdom}{$cpath}{$name} = \%kv;	592	$jar->{lc $cdom}{$cpath}{$name} = \%kv;
535		593
536	redo if /\G\s*,/gc;	594	redo if /\G\s*,/gc;
537	}	595	}
538	}	596	}
539		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
540	# continue to parse $_ for headers and place them into the arg	640	# continue to parse $_ for headers and place them into the arg
541	sub parse_hdr() {	641	sub _parse_hdr() {
542	my %hdr;	642	my %hdr;
543		643
544	# things seen, not parsed:	644	# things seen, not parsed:
545	# p3pP="NON CUR OTPi OUR NOR UNI"	645	# p3pP="NON CUR OTPi OUR NOR UNI"
546		646
…		…
560	for values %hdr;	660	for values %hdr;
561		661
562	\%hdr	662	\%hdr
563	}	663	}
564		664
		665	#############################################################################
		666	# http_get
		667
565	our $qr_nlnl = qr{(?<![^\012])\015?\012};	668	our $qr_nlnl = qr{(?<![^\012])\015?\012};
566		669
567	our $TLS_CTX_LOW = { cache => 1, sslv2 => 1 };	670	our $TLS_CTX_LOW = { cache => 1, sslv2 => 1 };
568	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	}
569		690
570	sub http_request($$@) {	691	sub http_request($$@) {
571	my $cb = pop;	692	my $cb = pop;
572	my ($method, $url, %arg) = @_;	693	my ($method, $url, %arg) = @_;
573		694
…		…
591	my $recurse = exists $arg{recurse} ? delete $arg{recurse} : $MAX_RECURSE;	712	my $recurse = exists $arg{recurse} ? delete $arg{recurse} : $MAX_RECURSE;
592		713
593	return $cb->(undef, { @pseudo, Status => 599, Reason => "Too many redirections" })	714	return $cb->(undef, { @pseudo, Status => 599, Reason => "Too many redirections" })
594	if $recurse < 0;	715	if $recurse < 0;
595		716
596	my $proxy = $arg{proxy} \|\| $PROXY;	717	my $proxy = exists $arg{proxy} ? $arg{proxy} : $PROXY;
597	my $timeout = $arg{timeout} \|\| $TIMEOUT;	718	my $timeout = $arg{timeout} \|\| $TIMEOUT;
598		719
599	my ($uscheme, $uauthority, $upath, $query, $fragment) =	720	my ($uscheme, $uauthority, $upath, $query, undef) = # ignore fragment
600	$url =~ m\|(?:([^:/?#]+):)?(?://([^/?#]))?([^?#])(?:(\?[^#]))?(?:#(.))?\|;	721	$url =~ m\|^([^:]+):(?://([^/?#]))?([^?#])(?:(\?[^#]))?(?:#(.))?$\|;
601		722
602	$uscheme = lc $uscheme;	723	$uscheme = lc $uscheme;
603		724
604	my $uport = $uscheme eq "http" ? 80	725	my $uport = $uscheme eq "http" ? 80
605	: $uscheme eq "https" ? 443	726	: $uscheme eq "https" ? 443
…		…
652	if length $arg{body} \|\| $method ne "GET";	773	if length $arg{body} \|\| $method ne "GET";
653		774
654	my $idempotent = $method =~ /^(?:GET\|HEAD\|PUT\|DELETE\|OPTIONS\|TRACE)$/;	775	my $idempotent = $method =~ /^(?:GET\|HEAD\|PUT\|DELETE\|OPTIONS\|TRACE)$/;
655		776
656	# 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
657	my $keepalive = exists $arg{keepalive}	778	my $keepalive = exists $arg{keepalive} ? !!$arg{keepalive} : $idempotent;
658	? $arg{keepalive}*1	779	my $keepalive10 = exists $arg{keepalive10} ? $arg{keepalive10} : !$proxy;
659	: $idempotent ? $PERSISTENT_TIMEOUT : 0;	780	my $keptalive; # true if this is actually a recycled connection
660		781
		782	# the key to use in the keepalive cache
		783	my $ka_key = "$uhost\x00$arg{sessionid}";
		784
661	$hdr{connection} = ($keepalive ? "" : "close ") . "Te"; #1.1	785	$hdr{connection} = ($keepalive ? $keepalive10 ? "keep-alive " : "" : "close ") . "Te"; #1.1
662	$hdr{te} = "trailers" unless exists $hdr{te}; #1.1	786	$hdr{te} = "trailers" unless exists $hdr{te}; #1.1
663		787
664	my %state = (connect_guard => 1);	788	my %state = (connect_guard => 1);
665		789
666	my $ae_error = 595; # connecting	790	my $ae_error = 595; # connecting
667		791
668	# handle actual, non-tunneled, request	792	# handle actual, non-tunneled, request
669	my $handle_actual_request = sub {	793	my $handle_actual_request = sub {
670	$ae_error = 596; # request phase	794	$ae_error = 596; # request phase
671		795
		796	my $hdl = $state{handle};
		797
672	$state{handle}->starttls ("connect") if $uscheme eq "https" && !exists $state{handle}{tls};	798	$hdl->starttls ("connect") if $uscheme eq "https" && !exists $hdl->{tls};
673		799
674	# send request	800	# send request
675	$state{handle}->push_write (	801	$hdl->push_write (
676	"$method $rpath HTTP/1.1\015\012"	802	"$method $rpath HTTP/1.1\015\012"
677	. (join "", map "\u$_: $hdr{$_}\015\012", grep defined $hdr{$_}, keys %hdr)	803	. (join "", map "\u$_: $hdr{$_}\015\012", grep defined $hdr{$_}, keys %hdr)
678	. "\015\012"	804	. "\015\012"
679	. (delete $arg{body})	805	. (delete $arg{body})
680	);	806	);
…		…
685	# 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.
686	%hdr = ();	812	%hdr = ();
687		813
688	# status line and headers	814	# status line and headers
689	$state{read_response} = sub {	815	$state{read_response} = sub {
		816	return unless %state;
		817
690	for ("$_[1]") {	818	for ("$_[1]") {
691	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.
692		820
693	/^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
694	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" };
695		823
696	# 100 Continue handling	824	# 100 Continue handling
697	# should not happen as we don't send expect: 100-continue,	825	# should not happen as we don't send expect: 100-continue,
698	# but we handle it just in case.	826	# but we handle it just in case.
699	# 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
…		…
705	HTTPVersion => $1,	833	HTTPVersion => $1,
706	Status => $2,	834	Status => $2,
707	Reason => $3,	835	Reason => $3,
708	;	836	;
709		837
710	my $hdr = parse_hdr	838	my $hdr = _parse_hdr
711	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" };
712		840
713	%hdr = (%$hdr, @pseudo);	841	%hdr = (%$hdr, @pseudo);
714	}	842	}
715		843
716	# redirect handling	844	# redirect handling
…		…
747	$redirect = 1;	875	$redirect = 1;
748	}	876	}
749	}	877	}
750		878
751	my $finish = sub { # ($data, $err_status, $err_reason[, $keepalive])	879	my $finish = sub { # ($data, $err_status, $err_reason[, $keepalive])
752	my $may_keep_alive = $_[3];	880	if ($state{handle}) {
753		881	# handle keepalive
		882	if (
		883	$keepalive
		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
754	$state{handle}->destroy if $state{handle};	892	$state{handle}->destroy;
		893	}
		894	}
		895
755	%state = ();	896	%state = ();
756		897
757	if (defined $_[1]) {	898	if (defined $_[1]) {
758	$hdr{OrigStatus} = $hdr{Status}; $hdr{Status} = $_[1];	899	$hdr{OrigStatus} = $hdr{Status}; $hdr{Status} = $_[1];
759	$hdr{OrigReason} = $hdr{Reason}; $hdr{Reason} = $_[2];	900	$hdr{OrigReason} = $hdr{Reason}; $hdr{Reason} = $_[2];
…		…
771	http_request (	912	http_request (
772	$method => $hdr{location},	913	$method => $hdr{location},
773	%arg,	914	%arg,
774	recurse => $recurse - 1,	915	recurse => $recurse - 1,
775	Redirect => [$_[0], \%hdr],	916	Redirect => [$_[0], \%hdr],
776	$cb);	917	$cb
		918	);
777	} else {	919	} else {
778	$cb->($_[0], \%hdr);	920	$cb->($_[0], \%hdr);
779	}	921	}
780	};	922	};
781		923
782	$ae_error = 597; # body phase	924	$ae_error = 597; # body phase
783		925
		926	my $chunked = $hdr{"transfer-encoding"} =~ /\bchunked\b/i; # not quite correct...
		927
784	my $len = $hdr{"content-length"};	928	my $len = $chunked ? undef : $hdr{"content-length"};
785		929
786	# body handling, many different code paths	930	# body handling, many different code paths
787	# - no body expected	931	# - no body expected
788	# - want_body_handle	932	# - want_body_handle
789	# - te chunked	933	# - te chunked
…		…
804	$_[0]->on_error (undef);	948	$_[0]->on_error (undef);
805	$_[0]->on_read (undef);	949	$_[0]->on_read (undef);
806		950
807	$finish->(delete $state{handle});	951	$finish->(delete $state{handle});
808		952
809	} elsif ($hdr{"transfer-encoding"} =~ /\bchunked\b/i) {	953	} elsif ($chunked) {
810	my $cl = 0;	954	my $cl = 0;
811	my $body = undef;	955	my $body = "";
812	my $on_body = $arg{on_body} \|\| sub { $body .= shift; 1 };	956	my $on_body = $arg{on_body} \|\| sub { $body .= shift; 1 };
813		957
814	$state{read_chunk} = sub {	958	$state{read_chunk} = sub {
815	$_[1] =~ /^([0-9a-fA-F]+)/	959	$_[1] =~ /^([0-9a-fA-F]+)/
816	or $finish->(undef, $ae_error => "Garbled chunked transfer encoding");	960	or $finish->(undef, $ae_error => "Garbled chunked transfer encoding");
…		…
836	$_[0]->push_read (line => $qr_nlnl, sub {	980	$_[0]->push_read (line => $qr_nlnl, sub {
837	if (length $_[1]) {	981	if (length $_[1]) {
838	for ("$_[1]") {	982	for ("$_[1]") {
839	y/\015//d; # weed out any \015, as they show up in the weirdest of places.	983	y/\015//d; # weed out any \015, as they show up in the weirdest of places.
840		984
841	my $hdr = parse_hdr	985	my $hdr = _parse_hdr
842	or return $finish->(undef, $ae_error => "Garbled response trailers");	986	or return $finish->(undef, $ae_error => "Garbled response trailers");
843		987
844	%hdr = (%hdr, %$hdr);	988	%hdr = (%hdr, %$hdr);
845	}	989	}
846	}	990	}
…		…
889	$_[0]->on_read (sub { });	1033	$_[0]->on_read (sub { });
890	}	1034	}
891	}	1035	}
892	};	1036	};
893		1037
		1038	# if keepalive is enabled, then the server closing the connection
		1039	# before a response can happen legally - we retry on idempotent methods.
		1040	if ($keptalive && $idempotent) {
		1041	my $old_eof = $hdl->{on_eof};
		1042	$hdl->{on_eof} = sub {
		1043	_destroy_state %state;
		1044
		1045	http_request (
		1046	$method => $url,
		1047	%arg,
		1048	keepalive => 0,
		1049	$cb
		1050	);
		1051	};
		1052	$hdl->on_read (sub {
		1053	return unless %state;
		1054
		1055	# as soon as we receive something, a connection close
		1056	# once more becomes a hard error
		1057	$hdl->{on_eof} = $old_eof;
		1058	$hdl->push_read (line => $qr_nlnl, $state{read_response});
		1059	});
		1060	} else {
894	$state{handle}->push_read (line => $qr_nlnl, $state{read_response});	1061	$hdl->push_read (line => $qr_nlnl, $state{read_response});
		1062	}
895	};	1063	};
896		1064
		1065	my $prepare_handle = sub {
		1066	my ($hdl) = $state{handle};
		1067
		1068	$hdl->timeout ($timeout);
		1069	$hdl->on_error (sub {
		1070	_error %state, $cb, { @pseudo, Status => $ae_error, Reason => $_[2] };
		1071	});
		1072	$hdl->on_eof (sub {
		1073	_error %state, $cb, { @pseudo, Status => $ae_error, Reason => "Unexpected end-of-file" };
		1074	});
		1075	};
		1076
		1077	# connected to proxy (or origin server)
897	my $connect_cb = sub {	1078	my $connect_cb = sub {
898	$state{fh} = shift	1079	my $fh = shift
899	or do {
900	my $err = "$!";
901	%state = ();
902	return $cb->(undef, { @pseudo, Status => $ae_error, Reason => $err });	1080	or return _error %state, $cb, { @pseudo, Status => $ae_error, Reason => "$!" };
903	};
904		1081
905	return unless delete $state{connect_guard};	1082	return unless delete $state{connect_guard};
906		1083
907	# get handle	1084	# get handle
908	$state{handle} = new AnyEvent::Handle	1085	$state{handle} = new AnyEvent::Handle
		1086	%{ $arg{handle_params} },
909	fh => $state{fh},	1087	fh => $fh,
910	peername => $rhost,	1088	peername => $uhost,
911	tls_ctx => $arg{tls_ctx},	1089	tls_ctx => $arg{tls_ctx},
912	# these need to be reconfigured on keepalive handles
913	timeout => $timeout,
914	on_error => sub {
915	%state = ();
916	$cb->(undef, { @pseudo, Status => $ae_error, Reason => $_[2] });
917	},
918	on_eof => sub {
919	%state = ();
920	$cb->(undef, { @pseudo, Status => $ae_error, Reason => "Unexpected end-of-file" });
921	},
922	;	1090	;
923		1091
924	# limit the number of persistent connections	1092	$prepare_handle->();
925	# keepalive not yet supported
926	# if ($KA_COUNT{$_[1]} < $MAX_PERSISTENT_PER_HOST) {
927	# ++$KA_COUNT{$_[1]};
928	# $state{handle}{ka_count_guard} = AnyEvent::Util::guard {
929	# --$KA_COUNT{$_[1]}
930	# };
931	# $hdr{connection} = "keep-alive";
932	# }
933		1093
934	$state{handle}->starttls ("connect") if $rscheme eq "https";	1094	#$state{handle}->starttls ("connect") if $rscheme eq "https";
935		1095
936	# now handle proxy-CONNECT method	1096	# now handle proxy-CONNECT method
937	if ($proxy && $uscheme eq "https") {	1097	if ($proxy && $uscheme eq "https") {
938	# oh dear, we have to wrap it into a connect request	1098	# oh dear, we have to wrap it into a connect request
939		1099
940	# maybe re-use $uauthority with patched port?	1100	# maybe re-use $uauthority with patched port?
941	$state{handle}->push_write ("CONNECT $uhost:$uport HTTP/1.0\015\012\015\012");	1101	$state{handle}->push_write ("CONNECT $uhost:$uport HTTP/1.0\015\012\015\012");
942	$state{handle}->push_read (line => $qr_nlnl, sub {	1102	$state{handle}->push_read (line => $qr_nlnl, sub {
943	$_[1] =~ /^HTTP\/([0-9\.]+) \s+ ([0-9]{3}) (?: \s+ ([^\015\012]*) )?/ix	1103	$_[1] =~ /^HTTP\/([0-9\.]+) \s+ ([0-9]{3}) (?: \s+ ([^\015\012]*) )?/ix
944	or return (%state = (), $cb->(undef, { @pseudo, Status => 599, Reason => "Invalid proxy connect response ($_[1])" }));	1104	or return _error %state, $cb, { @pseudo, Status => 599, Reason => "Invalid proxy connect response ($_[1])" };
945		1105
946	if ($2 == 200) {	1106	if ($2 == 200) {
947	$rpath = $upath;	1107	$rpath = $upath;
948	$handle_actual_request->();	1108	$handle_actual_request->();
949	} else {	1109	} else {
950	%state = ();
951	$cb->(undef, { @pseudo, Status => $2, Reason => $3 });	1110	_error %state, $cb, { @pseudo, Status => $2, Reason => $3 };
952	}	1111	}
953	});	1112	});
954	} else {	1113	} else {
955	$handle_actual_request->();	1114	$handle_actual_request->();
956	}	1115	}
…		…
959	_get_slot $uhost, sub {	1118	_get_slot $uhost, sub {
960	$state{slot_guard} = shift;	1119	$state{slot_guard} = shift;
961		1120
962	return unless $state{connect_guard};	1121	return unless $state{connect_guard};
963		1122
		1123	# try to use an existing keepalive connection, but only if we, ourselves, plan
		1124	# on a keepalive request (in theory, this should be a separate config option).
		1125	if ($keepalive && $KA_CACHE{$ka_key}) {
		1126	$keptalive = 1;
		1127	$state{handle} = ka_fetch $ka_key;
		1128	$prepare_handle->();
		1129	$handle_actual_request->();
		1130
		1131	} else {
964	my $tcp_connect = $arg{tcp_connect}	1132	my $tcp_connect = $arg{tcp_connect}
965	\|\| do { require AnyEvent::Socket; \&AnyEvent::Socket::tcp_connect };	1133	\|\| do { require AnyEvent::Socket; \&AnyEvent::Socket::tcp_connect };
966		1134
967	$state{connect_guard} = $tcp_connect->($rhost, $rport, $connect_cb, $arg{on_prepare} \|\| sub { $timeout });	1135	$state{connect_guard} = $tcp_connect->($rhost, $rport, $connect_cb, $arg{on_prepare} \|\| sub { $timeout });
		1136	}
968	};	1137	};
969		1138
970	defined wantarray && AnyEvent::Util::guard { %state = () }	1139	defined wantarray && AnyEvent::Util::guard { _destroy_state %state }
971	}	1140	}
972		1141
973	sub http_get($@) {	1142	sub http_get($@) {
974	unshift @_, "GET";	1143	unshift @_, "GET";
975	&http_request	1144	&http_request
…		…
993	AnyEvent::HTTP uses the AnyEvent::Socket::tcp_connect function for	1162	AnyEvent::HTTP uses the AnyEvent::Socket::tcp_connect function for
994	the actual connection, which in turn uses AnyEvent::DNS to resolve	1163	the actual connection, which in turn uses AnyEvent::DNS to resolve
995	hostnames. The latter is a simple stub resolver and does no caching	1164	hostnames. The latter is a simple stub resolver and does no caching
996	on its own. If you want DNS caching, you currently have to provide	1165	on its own. If you want DNS caching, you currently have to provide
997	your own default resolver (by storing a suitable resolver object in	1166	your own default resolver (by storing a suitable resolver object in
998	C<$AnyEvent::DNS::RESOLVER>).	1167	C<$AnyEvent::DNS::RESOLVER>) or your own C<tcp_connect> callback.
999		1168
1000	=head2 GLOBAL FUNCTIONS AND VARIABLES	1169	=head2 GLOBAL FUNCTIONS AND VARIABLES
1001		1170
1002	=over 4	1171	=over 4
1003		1172
1004	=item AnyEvent::HTTP::set_proxy "proxy-url"	1173	=item AnyEvent::HTTP::set_proxy "proxy-url"
1005		1174
1006	Sets the default proxy server to use. The proxy-url must begin with a	1175	Sets the default proxy server to use. The proxy-url must begin with a
1007	string of the form C<http://host:port> (optionally C<https:...>), croaks	1176	string of the form C<http://host:port>, croaks otherwise.
1008	otherwise.
1009		1177
1010	To clear an already-set proxy, use C<undef>.	1178	To clear an already-set proxy, use C<undef>.
		1179
		1180	When AnyEvent::HTTP is laoded for the first time it will query the
		1181	default proxy from the operating system, currently by looking at
		1182	C<$ENV{http_proxy>}.
1011		1183
1012	=item AnyEvent::HTTP::cookie_jar_expire $jar[, $session_end]	1184	=item AnyEvent::HTTP::cookie_jar_expire $jar[, $session_end]
1013		1185
1014	Remove all cookies from the cookie jar that have been expired. If	1186	Remove all cookies from the cookie jar that have been expired. If
1015	C<$session_end> is given and true, then additionally remove all session	1187	C<$session_end> is given and true, then additionally remove all session
…		…
1061		1233
1062	=item $AnyEvent::HTTP::MAX_RECURSE	1234	=item $AnyEvent::HTTP::MAX_RECURSE
1063		1235
1064	The default value for the C<recurse> request parameter (default: C<10>).	1236	The default value for the C<recurse> request parameter (default: C<10>).
1065		1237
		1238	=item $AnyEvent::HTTP::TIMEOUT
		1239
		1240	The default timeout for conenction operations (default: C<300>).
		1241
1066	=item $AnyEvent::HTTP::USERAGENT	1242	=item $AnyEvent::HTTP::USERAGENT
1067		1243
1068	The default value for the C<User-Agent> header (the default is	1244	The default value for the C<User-Agent> header (the default is
1069	C<Mozilla/5.0 (compatible; U; AnyEvent-HTTP/$VERSION; +http://software.schmorp.de/pkg/AnyEvent)>).	1245	C<Mozilla/5.0 (compatible; U; AnyEvent-HTTP/$VERSION; +http://software.schmorp.de/pkg/AnyEvent)>).
1070		1246
1071	=item $AnyEvent::HTTP::MAX_PER_HOST	1247	=item $AnyEvent::HTTP::MAX_PER_HOST
1072		1248
1073	The maximum number of concurrent connections to the same host (identified	1249	The maximum number of concurrent connections to the same host (identified
1074	by the hostname). If the limit is exceeded, then the additional requests	1250	by the hostname). If the limit is exceeded, then the additional requests
1075	are queued until previous connections are closed.	1251	are queued until previous connections are closed. Both persistent and
		1252	non-persistent connections are counted in this limit.
1076		1253
1077	The default value for this is C<4>, and it is highly advisable to not	1254	The default value for this is C<4>, and it is highly advisable to not
1078	increase it.	1255	increase it much.
		1256
		1257	For comparison: the RFC's recommend 4 non-persistent or 2 persistent
		1258	connections, older browsers used 2, newers (such as firefox 3) typically
		1259	use 6, and Opera uses 8 because like, they have the fastest browser and
		1260	give a shit for everybody else on the planet.
		1261
		1262	=item $AnyEvent::HTTP::PERSISTENT_TIMEOUT
		1263
		1264	The time after which idle persistent conenctions get closed by
		1265	AnyEvent::HTTP (default: C<3>).
1079		1266
1080	=item $AnyEvent::HTTP::ACTIVE	1267	=item $AnyEvent::HTTP::ACTIVE
1081		1268
1082	The number of active connections. This is not the number of currently	1269	The number of active connections. This is not the number of currently
1083	running requests, but the number of currently open and non-idle TCP	1270	running requests, but the number of currently open and non-idle TCP
1084	connections. This number of can be useful for load-leveling.	1271	connections. This number can be useful for load-leveling.
1085		1272
1086	=back	1273	=back
1087		1274
1088	=cut	1275	=cut
1089		1276
…		…
1132	undef	1319	undef
1133	}	1320	}
1134		1321
1135	sub set_proxy($) {	1322	sub set_proxy($) {
1136	if (length $_[0]) {	1323	if (length $_[0]) {
1137	$_[0] =~ m%^(https?):// ([^:/]+) (?: : (\d*) )?%ix	1324	$_[0] =~ m%^(http):// ([^:/]+) (?: : (\d*) )?%ix
1138	or Carp::croak "$_[0]: invalid proxy URL";	1325	or Carp::croak "$_[0]: invalid proxy URL";
1139	$PROXY = [$2, $3 \|\| 3128, $1]	1326	$PROXY = [$2, $3 \|\| 3128, $1]
1140	} else {	1327	} else {
1141	undef $PROXY;	1328	undef $PROXY;
1142	}	1329	}
…		…
1145	# initialise proxy from environment	1332	# initialise proxy from environment
1146	eval {	1333	eval {
1147	set_proxy $ENV{http_proxy};	1334	set_proxy $ENV{http_proxy};
1148	};	1335	};
1149		1336
		1337	=head2 SHOWCASE
		1338
		1339	This section contaisn some more elaborate "real-world" examples or code
		1340	snippets.
		1341
		1342	=head2 HTTP/1.1 FILE DOWNLOAD
		1343
		1344	Downloading files with HTTP can be quite tricky, especially when something
		1345	goes wrong and you want to resume.
		1346
		1347	Here is a function that initiates and resumes a download. It uses the
		1348	last modified time to check for file content changes, and works with many
		1349	HTTP/1.0 servers as well, and usually falls back to a complete re-download
		1350	on older servers.
		1351
		1352	It calls the completion callback with either C<undef>, which means a
		1353	nonretryable error occured, C<0> when the download was partial and should
		1354	be retried, and C<1> if it was successful.
		1355
		1356	use AnyEvent::HTTP;
		1357
		1358	sub download($$$) {
		1359	my ($url, $file, $cb) = @_;
		1360
		1361	open my $fh, "+<", $file
		1362	or die "$file: $!";
		1363
		1364	my %hdr;
		1365	my $ofs = 0;
		1366
		1367	warn stat $fh;
		1368	warn -s _;
		1369	if (stat $fh and -s _) {
		1370	$ofs = -s _;
		1371	warn "-s is ", $ofs;#d#
		1372	$hdr{"if-unmodified-since"} = AnyEvent::HTTP::format_date +(stat _)[9];
		1373	$hdr{"range"} = "bytes=$ofs-";
		1374	}
		1375
		1376	http_get $url,
		1377	headers => \%hdr,
		1378	on_header => sub {
		1379	my ($hdr) = @_;
		1380
		1381	if ($hdr->{Status} == 200 && $ofs) {
		1382	# resume failed
		1383	truncate $fh, $ofs = 0;
		1384	}
		1385
		1386	sysseek $fh, $ofs, 0;
		1387
		1388	1
		1389	},
		1390	on_body => sub {
		1391	my ($data, $hdr) = @_;
		1392
		1393	if ($hdr->{Status} =~ /^2/) {
		1394	length $data == syswrite $fh, $data
		1395	or return; # abort on write errors
		1396	}
		1397
		1398	1
		1399	},
		1400	sub {
		1401	my (undef, $hdr) = @_;
		1402
		1403	my $status = $hdr->{Status};
		1404
		1405	if (my $time = AnyEvent::HTTP::parse_date $hdr->{"last-modified"}) {
		1406	utime $fh, $time, $time;
		1407	}
		1408
		1409	if ($status == 200 \|\| $status == 206 \|\| $status == 416) {
		1410	# download ok \|\| resume ok \|\| file already fully downloaded
		1411	$cb->(1, $hdr);
		1412
		1413	} elsif ($status == 412) {
		1414	# file has changed while resuming, delete and retry
		1415	unlink $file;
		1416	$cb->(0, $hdr);
		1417
		1418	} elsif ($status == 500 or $status == 503 or $status =~ /^59/) {
		1419	# retry later
		1420	$cb->(0, $hdr);
		1421
		1422	} else {
		1423	$cb->(undef, $hdr);
		1424	}
		1425	}
		1426	;
		1427	}
		1428
		1429	download "http://server/somelargefile", "/tmp/somelargefile", sub {
		1430	if ($_[0]) {
		1431	print "OK!\n";
		1432	} elsif (defined $_[0]) {
		1433	print "please retry later\n";
		1434	} else {
		1435	print "ERROR\n";
		1436	}
		1437	};
		1438
1150	=head2 SOCKS PROXIES	1439	=head3 SOCKS PROXIES
1151		1440
1152	Socks proxies are not directly supported by AnyEvent::HTTP. You can	1441	Socks proxies are not directly supported by AnyEvent::HTTP. You can
1153	compile your perl to support socks, or use an external program such as	1442	compile your perl to support socks, or use an external program such as
1154	F<socksify> (dante) or F<tsocks> to make your program use a socks proxy	1443	F<socksify> (dante) or F<tsocks> to make your program use a socks proxy
1155	transparently.	1444	transparently.

Diff Legend

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

Comparing AnyEvent-HTTP/HTTP.pm (file contents): Revision 1.89 by root, Mon Jan 3 00:23:25 2011 UTC vs. Revision 1.102 by root, Sat Feb 19 06:46:14 2011 UTC

Diff Legend

Comparing AnyEvent-HTTP/HTTP.pm (file contents):
Revision 1.89 by root, Mon Jan 3 00:23:25 2011 UTC vs.
Revision 1.102 by root, Sat Feb 19 06:46:14 2011 UTC