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

Comparing AnyEvent-HTTP/HTTP.pm (file contents):
Revision 1.42 by root, Mon Jul 6 00:08:16 2009 UTC vs.
Revision 1.65 by root, Fri Dec 31 03:47:32 2010 UTC

…		…
41	use strict;	41	use strict;
42	no warnings;	42	no warnings;
43		43
44	use Errno ();	44	use Errno ();
45		45
46	use AnyEvent 4.452 ();	46	use AnyEvent 5.0 ();
47	use AnyEvent::Util ();	47	use AnyEvent::Util ();
48	use AnyEvent::Socket ();
49	use AnyEvent::Handle ();	48	use AnyEvent::Handle ();
50		49
51	use base Exporter::;	50	use base Exporter::;
52		51
53	our $VERSION = '1.12';	52	our $VERSION = '1.5';
54		53
55	our @EXPORT = qw(http_get http_post http_head http_request);	54	our @EXPORT = qw(http_get http_post http_head http_request);
56		55
57	our $USERAGENT = "Mozilla/5.0 (compatible; U; AnyEvent-HTTP/$VERSION; +http://software.schmorp.de/pkg/AnyEvent)";	56	our $USERAGENT = "Mozilla/5.0 (compatible; U; AnyEvent-HTTP/$VERSION; +http://software.schmorp.de/pkg/AnyEvent)";
58	our $MAX_RECURSE = 10;	57	our $MAX_RECURSE = 10;
59	our $MAX_PERSISTENT = 8;	58	our $MAX_PERSISTENT = 8;
60	our $PERSISTENT_TIMEOUT = 2;	59	our $PERSISTENT_TIMEOUT = 2;
61	our $TIMEOUT = 300;	60	our $TIMEOUT = 300;
62		61
63	# changing these is evil	62	# changing these is evil
64	our $MAX_PERSISTENT_PER_HOST = 2;	63	our $MAX_PERSISTENT_PER_HOST = 0;
65	our $MAX_PER_HOST = 4;	64	our $MAX_PER_HOST = 4;
66		65
67	our $PROXY;	66	our $PROXY;
68	our $ACTIVE = 0;	67	our $ACTIVE = 0;
69		68
…		…
92	must be an absolute http or https URL.	91	must be an absolute http or https URL.
93		92
94	When called in void context, nothing is returned. In other contexts,	93	When called in void context, nothing is returned. In other contexts,
95	C<http_request> returns a "cancellation guard" - you have to keep the	94	C<http_request> returns a "cancellation guard" - you have to keep the
96	object at least alive until the callback get called. If the object gets	95	object at least alive until the callback get called. If the object gets
97	destroyed before the callbakc is called, the request will be cancelled.	96	destroyed before the callback is called, the request will be cancelled.
98		97
99	The callback will be called with the response body data as first argument	98	The callback will be called with the response body data as first argument
100	(or C<undef> if an error occured), and a hash-ref with response headers as	99	(or C<undef> if an error occured), and a hash-ref with response headers as
101	second argument.	100	second argument.
102		101
103	All the headers in that hash are lowercased. In addition to the response	102	All the headers in that hash are lowercased. In addition to the response
104	headers, the "pseudo-headers" C<HTTPVersion>, C<Status> and C<Reason>	103	headers, the "pseudo-headers" (uppercase to avoid clashing with possible
		104	response headers) C<HTTPVersion>, C<Status> and C<Reason> contain the
105	contain the three parts of the HTTP Status-Line of the same name. The	105	three parts of the HTTP Status-Line of the same name. If an error occurs
		106	during the body phase of a request, then the original C<Status> and
		107	C<Reason> values from the header are available as C<OrigStatus> and
		108	C<OrigReason>.
		109
106	pseudo-header C<URL> contains the original URL (which can differ from the	110	The pseudo-header C<URL> contains the actual URL (which can differ from
107	requested URL when following redirects).	111	the requested URL when following redirects - for example, you might get
		112	an error that your URL scheme is not supported even though your URL is a
		113	valid http URL because it redirected to an ftp URL, in which case you can
		114	look at the URL pseudo header).
		115
		116	The pseudo-header C<Redirect> only exists when the request was a result
		117	of an internal redirect. In that case it is an array reference with
		118	the C<($data, $headers)> from the redirect response. Note that this
		119	response could in turn be the result of a redirect itself, and C<<
		120	$headers->{Redirect}[1]{Redirect} >> will then contain the original
		121	response, and so on.
108		122
109	If the server sends a header multiple times, then their contents will be	123	If the server sends a header multiple times, then their contents will be
110	joined together with a comma (C<,>), as per the HTTP spec.	124	joined together with a comma (C<,>), as per the HTTP spec.
111		125
112	If an internal error occurs, such as not being able to resolve a hostname,	126	If an internal error occurs, such as not being able to resolve a hostname,
…		…
138		152
139	=item headers => hashref	153	=item headers => hashref
140		154
141	The request headers to use. Currently, C<http_request> may provide its	155	The request headers to use. Currently, C<http_request> may provide its
142	own C<Host:>, C<Content-Length:>, C<Connection:> and C<Cookie:> headers	156	own C<Host:>, C<Content-Length:>, C<Connection:> and C<Cookie:> headers
143	and will provide defaults for C<User-Agent:> and C<Referer:>.	157	and will provide defaults for C<User-Agent:> and C<Referer:> (this can be
		158	suppressed by using C<undef> for these headers in which case they won't be
		159	sent at all).
144		160
145	=item timeout => $seconds	161	=item timeout => $seconds
146		162
147	The time-out to use for various stages - each connect attempt will reset	163	The time-out to use for various stages - each connect attempt will reset
148	the timeout, as will read or write activity. Default timeout is 5 minutes.	164	the timeout, as will read or write activity, i.e. this is not an overall
		165	timeout.
		166
		167	Default timeout is 5 minutes.
149		168
150	=item proxy => [$host, $port[, $scheme]] or undef	169	=item proxy => [$host, $port[, $scheme]] or undef
151		170
152	Use the given http proxy for all requests. If not specified, then the	171	Use the given http proxy for all requests. If not specified, then the
153	default proxy (as specified by C<$ENV{http_proxy}>) is used.	172	default proxy (as specified by C<$ENV{http_proxy}>) is used.
154		173
155	C<$scheme> must be either missing or C<http> for HTTP, or C<https> for	174	C<$scheme> must be either missing, C<http> for HTTP or C<https> for
156	HTTPS.	175	HTTPS.
157		176
158	=item body => $string	177	=item body => $string
159		178
160	The request body, usually empty. Will be-sent as-is (future versions of	179	The request body, usually empty. Will be-sent as-is (future versions of
…		…
186	verification) TLS context.	205	verification) TLS context.
187		206
188	The default for this option is C<low>, which could be interpreted as "give	207	The default for this option is C<low>, which could be interpreted as "give
189	me the page, no matter what".	208	me the page, no matter what".
190		209
		210	=item on_prepare => $callback->($fh)
		211
		212	In rare cases you need to "tune" the socket before it is used to
		213	connect (for exmaple, to bind it on a given IP address). This parameter
		214	overrides the prepare callback passed to C<AnyEvent::Socket::tcp_connect>
		215	and behaves exactly the same way (e.g. it has to provide a
		216	timeout). See the description for the C<$prepare_cb> argument of
		217	C<AnyEvent::Socket::tcp_connect> for details.
		218
		219	=item tcp_connect => $callback->($host, $service, $connect_cb, $prepare_cb)
		220
		221	In even rarer cases you want total control over how AnyEvent::HTTP
		222	establishes connections. Normally it uses L<AnyEvent::Socket::tcp_connect>
		223	to do this, but you can provide your own C<tcp_connect> function -
		224	obviously, it has to follow the same calling conventions, except that it
		225	may always return a connection guard object.
		226
		227	There are probably lots of weird uses for this function, starting from
		228	tracing the hosts C<http_request> actually tries to connect, to (inexact
		229	but fast) host => IP address caching or even socks protocol support.
		230
191	=item on_header => $callback->($headers)	231	=item on_header => $callback->($headers)
192		232
193	When specified, this callback will be called with the header hash as soon	233	When specified, this callback will be called with the header hash as soon
194	as headers have been successfully received from the remote server (not on	234	as headers have been successfully received from the remote server (not on
195	locally-generated errors).	235	locally-generated errors).
…		…
221	This callback is useful when the data is too large to be held in memory	261	This callback is useful when the data is too large to be held in memory
222	(so the callback writes it to a file) or when only some information should	262	(so the callback writes it to a file) or when only some information should
223	be extracted, or when the body should be processed incrementally.	263	be extracted, or when the body should be processed incrementally.
224		264
225	It is usually preferred over doing your own body handling via	265	It is usually preferred over doing your own body handling via
226	C<want_body_handle>.	266	C<want_body_handle>, but in case of streaming APIs, where HTTP is
		267	only used to create a connection, C<want_body_handle> is the better
		268	alternative, as it allows you to install your own event handler, reducing
		269	resource usage.
227		270
228	=item want_body_handle => $enable	271	=item want_body_handle => $enable
229		272
230	When enabled (default is disabled), the behaviour of AnyEvent::HTTP	273	When enabled (default is disabled), the behaviour of AnyEvent::HTTP
231	changes considerably: after parsing the headers, and instead of	274	changes considerably: after parsing the headers, and instead of
…		…
243	This is useful with some push-type services, where, after the initial	286	This is useful with some push-type services, where, after the initial
244	headers, an interactive protocol is used (typical example would be the	287	headers, an interactive protocol is used (typical example would be the
245	push-style twitter API which starts a JSON/XML stream).	288	push-style twitter API which starts a JSON/XML stream).
246		289
247	If you think you need this, first have a look at C<on_body>, to see if	290	If you think you need this, first have a look at C<on_body>, to see if
248	that doesn'T solve your problem in a better way.	291	that doesn't solve your problem in a better way.
249		292
250	=back	293	=back
251		294
252	Example: make a simple HTTP GET request for http://www.nethype.de/	295	Example: make a simple HTTP GET request for http://www.nethype.de/
253		296
…		…
309	push @{ $CO_SLOT{$_[0]}[1] }, $_[1];	352	push @{ $CO_SLOT{$_[0]}[1] }, $_[1];
310		353
311	_slot_schedule $_[0];	354	_slot_schedule $_[0];
312	}	355	}
313		356
314	our $qr_nl = qr<\015?\012>;	357	our $qr_nlnl = qr{(?<![^\012])\015?\012};
315	our $qr_nlnl = qr<\015?\012\015?\012>;
316		358
317	our $TLS_CTX_LOW = { cache => 1, sslv2 => 1 };	359	our $TLS_CTX_LOW = { cache => 1, sslv2 => 1 };
318	our $TLS_CTX_HIGH = { cache => 1, verify => 1, verify_peername => "https" };	360	our $TLS_CTX_HIGH = { cache => 1, verify => 1, verify_peername => "https" };
319		361
320	sub http_request($$@) {	362	sub http_request($$@) {
…		…
332	while (my ($k, $v) = each %$hdr) {	374	while (my ($k, $v) = each %$hdr) {
333	$hdr{lc $k} = $v;	375	$hdr{lc $k} = $v;
334	}	376	}
335	}	377	}
336		378
		379	# pseudo headers for all subsequent responses
		380	my @pseudo = (URL => $url);
		381	push @pseudo, Redirect => delete $arg{Redirect} if exists $arg{Redirect};
		382
337	my $recurse = exists $arg{recurse} ? delete $arg{recurse} : $MAX_RECURSE;	383	my $recurse = exists $arg{recurse} ? delete $arg{recurse} : $MAX_RECURSE;
338		384
339	return $cb->(undef, { Status => 599, Reason => "Too many redirections", URL => $url })	385	return $cb->(undef, { @pseudo, Status => 599, Reason => "Too many redirections" })
340	if $recurse < 0;	386	if $recurse < 0;
341		387
342	my $proxy = $arg{proxy} \|\| $PROXY;	388	my $proxy = $arg{proxy} \|\| $PROXY;
343	my $timeout = $arg{timeout} \|\| $TIMEOUT;	389	my $timeout = $arg{timeout} \|\| $TIMEOUT;
344		390
345	my ($uscheme, $uauthority, $upath, $query, $fragment) =	391	my ($uscheme, $uauthority, $upath, $query, $fragment) =
346	$url =~ m\|(?:([^:/?#]+):)?(?://([^/?#]))?([^?#])(?:\?([^#]))?(?:#(.))?\|;	392	$url =~ m\|(?:([^:/?#]+):)?(?://([^/?#]))?([^?#])(?:(\?[^#]))?(?:#(.))?\|;
347		393
348	$uscheme = lc $uscheme;	394	$uscheme = lc $uscheme;
349		395
350	my $uport = $uscheme eq "http" ? 80	396	my $uport = $uscheme eq "http" ? 80
351	: $uscheme eq "https" ? 443	397	: $uscheme eq "https" ? 443
352	: return $cb->(undef, { Status => 599, Reason => "Only http and https URL schemes supported", URL => $url });	398	: return $cb->(undef, { @pseudo, Status => 599, Reason => "Only http and https URL schemes supported" });
353		399
354	$uauthority =~ /^(?: .*\@ )? ([^\@:]+) (?: : (\d+) )?$/x	400	$uauthority =~ /^(?: .*\@ )? ([^\@:]+) (?: : (\d+) )?$/x
355	or return $cb->(undef, { Status => 599, Reason => "Unparsable URL", URL => $url });	401	or return $cb->(undef, { @pseudo, Status => 599, Reason => "Unparsable URL" });
356		402
357	my $uhost = $1;	403	my $uhost = $1;
358	$uport = $2 if defined $2;	404	$uport = $2 if defined $2;
359		405
		406	$hdr{host} = defined $2 ? "$uhost:$2" : "$uhost"
		407	unless exists $hdr{host};
		408
360	$uhost =~ s/^\[(.*)\]$/$1/;	409	$uhost =~ s/^\[(.*)\]$/$1/;
361	$upath .= "?$query" if length $query;	410	$upath .= $query if length $query;
362		411
363	$upath =~ s%^/?%/%;	412	$upath =~ s%^/?%/%;
364		413
365	# cookie processing	414	# cookie processing
366	if (my $jar = $arg{cookie_jar}) {	415	if (my $jar = $arg{cookie_jar}) {
…		…
396	my ($rhost, $rport, $rscheme, $rpath); # request host, port, path	445	my ($rhost, $rport, $rscheme, $rpath); # request host, port, path
397		446
398	if ($proxy) {	447	if ($proxy) {
399	($rpath, $rhost, $rport, $rscheme) = ($url, @$proxy);	448	($rpath, $rhost, $rport, $rscheme) = ($url, @$proxy);
400		449
		450	$rscheme = "http" unless defined $rscheme;
		451
401	# don't support https requests over https-proxy transport,	452	# don't support https requests over https-proxy transport,
402	# can't be done with tls as spec'ed, unless you double-encrypt.	453	# can't be done with tls as spec'ed, unless you double-encrypt.
403	$rscheme = "http" if $uscheme eq "https" && $rscheme eq "https";	454	$rscheme = "http" if $uscheme eq "https" && $rscheme eq "https";
404	} else {	455	} else {
405	($rhost, $rport, $rscheme, $rpath) = ($uhost, $uport, $uscheme, $upath);	456	($rhost, $rport, $rscheme, $rpath) = ($uhost, $uport, $uscheme, $upath);
406	}	457	}
407		458
408	$hdr{"user-agent"} \|\|= $USERAGENT;	459	# leave out fragment and query string, just a heuristic
409	$hdr{referer} \|\|= "$uscheme://$uauthority$upath"; # leave out fragment and query string, just a heuristic	460	$hdr{referer} \|\|= "$uscheme://$uauthority$upath" unless exists $hdr{referer};
		461	$hdr{"user-agent"} \|\|= $USERAGENT unless exists $hdr{"user-agent"};
410		462
411	$hdr{host} = "$uhost:$uport";
412	$hdr{"content-length"} = length $arg{body};	463	$hdr{"content-length"} = length $arg{body}
		464	if length $arg{body} \|\| $method ne "GET";
413		465
414	my %state = (connect_guard => 1);	466	my %state = (connect_guard => 1);
415		467
416	_get_slot $uhost, sub {	468	_get_slot $uhost, sub {
417	$state{slot_guard} = shift;	469	$state{slot_guard} = shift;
418		470
419	return unless $state{connect_guard};	471	return unless $state{connect_guard};
420		472
421	$state{connect_guard} = AnyEvent::Socket::tcp_connect $rhost, $rport, sub {	473	my $connect_cb = sub {
422	$state{fh} = shift	474	$state{fh} = shift
423	or return (%state = (), $cb->(undef, { Status => 599, Reason => "$!", URL => $url }));	475	or do {
		476	my $err = "$!";
		477	%state = ();
		478	return $cb->(undef, { @pseudo, Status => 599, Reason => $err });
		479	};
		480
424	pop; # free memory, save a tree	481	pop; # free memory, save a tree
425		482
426	return unless delete $state{connect_guard};	483	return unless delete $state{connect_guard};
427		484
428	# get handle	485	# get handle
429	$state{handle} = new AnyEvent::Handle	486	$state{handle} = new AnyEvent::Handle
430	fh => $state{fh},	487	fh => $state{fh},
		488	peername => $rhost,
		489	tls_ctx => $arg{tls_ctx},
		490	# these need to be reconfigured on keepalive handles
431	timeout => $timeout,	491	timeout => $timeout,
432	peername => $rhost,	492	on_error => sub {
433	tls_ctx => $arg{tls_ctx};	493	%state = ();
		494	$cb->(undef, { @pseudo, Status => 599, Reason => $_[2] });
		495	},
		496	on_eof => sub {
		497	%state = ();
		498	$cb->(undef, { @pseudo, Status => 599, Reason => "Unexpected end-of-file" });
		499	},
		500	;
434		501
435	# limit the number of persistent connections	502	# limit the number of persistent connections
436	# keepalive not yet supported	503	# keepalive not yet supported
437	if ($KA_COUNT{$_[1]} < $MAX_PERSISTENT_PER_HOST) {	504	# if ($KA_COUNT{$_[1]} < $MAX_PERSISTENT_PER_HOST) {
438	++$KA_COUNT{$_[1]};	505	# ++$KA_COUNT{$_[1]};
439	$state{handle}{ka_count_guard} = AnyEvent::Util::guard {	506	# $state{handle}{ka_count_guard} = AnyEvent::Util::guard {
440	--$KA_COUNT{$_[1]}	507	# --$KA_COUNT{$_[1]}
441	};	508	# };
442	$hdr{connection} = "keep-alive";	509	# $hdr{connection} = "keep-alive";
443	} else {	510	# } else {
444	delete $hdr{connection};	511	delete $hdr{connection};
445	}	512	# }
446
447	# (re-)configure handle
448	$state{handle}->on_error (sub {
449	%state = ();
450	$cb->(undef, { Status => 599, Reason => $_[2], URL => $url });
451	});
452	$state{handle}->on_eof (sub {
453	%state = ();
454	$cb->(undef, { Status => 599, Reason => "Unexpected end-of-file", URL => $url });
455	});
456		513
457	$state{handle}->starttls ("connect") if $rscheme eq "https";	514	$state{handle}->starttls ("connect") if $rscheme eq "https";
458		515
459	# handle actual, non-tunneled, request	516	# handle actual, non-tunneled, request
460	my $handle_actual_request = sub {	517	my $handle_actual_request = sub {
461	$state{handle}->starttls ("connect") if $uscheme eq "https" && !exists $state{handle}{tls};	518	$state{handle}->starttls ("connect") if $uscheme eq "https" && !exists $state{handle}{tls};
462		519
463	# send request	520	# send request
464	$state{handle}->push_write (	521	$state{handle}->push_write (
465	"$method $rpath HTTP/1.0\015\012"	522	"$method $rpath HTTP/1.0\015\012"
466	. (join "", map "\u$_: $hdr{$_}\015\012", keys %hdr)	523	. (join "", map "\u$_: $hdr{$_}\015\012", grep defined $hdr{$_}, keys %hdr)
467	. "\015\012"	524	. "\015\012"
468	. (delete $arg{body})	525	. (delete $arg{body})
469	);	526	);
470		527
		528	# return if error occured during push_write()
		529	return unless %state;
		530
471	%hdr = (); # reduce memory usage, save a kitten	531	%hdr = (); # reduce memory usage, save a kitten, also make it possible to re-use
472		532
473	# status line	533	# status line and headers
474	$state{handle}->push_read (line => $qr_nl, sub {	534	$state{handle}->push_read (line => $qr_nlnl, sub {
475	$_[1] =~ /^HTTP\/([0-9\.]+) \s+ ([0-9]{3}) (?: \s+ ([^\015\012]*) )?/ix	535	my $keepalive = pop;
476	or return (%state = (), $cb->(undef, { Status => 599, Reason => "Invalid server response ($_[1])", URL => $url }));
477		536
478	my %hdr = ( # response headers
479	HTTPVersion => ",$1",
480	Status => ",$2",
481	Reason => ",$3",
482	URL => ",$url"
483	);
484
485	# headers, could be optimized a bit
486	$state{handle}->unshift_read (line => $qr_nlnl, sub {
487	for ("$_[1]\012") {	537	for ("$_[1]") {
488	y/\015//d; # weed out any \015, as they show up in the weirdest of places.	538	y/\015//d; # weed out any \015, as they show up in the weirdest of places.
489		539
		540	/^HTTP\/([0-9\.]+) \s+ ([0-9]{3}) (?: \s+ ([^\015\012]*) )? \015?\012/igxc
		541	or return (%state = (), $cb->(undef, { @pseudo, Status => 599, Reason => "Invalid server response" }));
		542
		543	push @pseudo,
		544	HTTPVersion => $1,
		545	Status => $2,
		546	Reason => $3,
		547	;
		548
490	# things seen, not parsed:	549	# things seen, not parsed:
491	# p3pP="NON CUR OTPi OUR NOR UNI"	550	# p3pP="NON CUR OTPi OUR NOR UNI"
492		551
493	$hdr{lc $1} .= ",$2"	552	$hdr{lc $1} .= ",$2"
494	while /\G	553	while /\G
495	([^:\000-\037]+):	554	([^:\000-\037]*):
496	[\011\040]*	555	[\011\040]*
497	((?: [^\012]+ \| \012[\011\040] )*)	556	((?: [^\012]+ \| \012[\011\040] )*)
498	\012	557	\012
499	/gxc;	558	/gxc;
500		559
501	/\G$/	560	/\G$/
502	or return (%state = (), $cb->(undef, { Status => 599, Reason => "Garbled response headers", URL => $url }));	561	or return (%state = (), $cb->(undef, { @pseudo, Status => 599, Reason => "Garbled response headers" }));
		562	}
		563
		564	# remove the "," prefix we added to all headers above
		565	substr $_, 0, 1, ""
		566	for values %hdr;
		567
		568	# patch in all pseudo headers
		569	%hdr = (%hdr, @pseudo);
		570
		571	# redirect handling
		572	# microsoft and other shitheads don't give a shit for following standards,
		573	# try to support some common forms of broken Location headers.
		574	if ($hdr{location} !~ /^(?: $ \| [^:\/?\#]+ : )/x) {
		575	$hdr{location} =~ s/^\.\/+//;
		576
		577	my $url = "$rscheme://$uhost:$uport";
		578
		579	unless ($hdr{location} =~ s/^\///) {
		580	$url .= $upath;
		581	$url =~ s/\/[^\/]*$//;
503	}	582	}
504		583
505	substr $_, 0, 1, ""
506	for values %hdr;
507
508	# redirect handling
509	# microsoft and other shitheads don't give a shit for following standards,
510	# try to support some common forms of broken Location headers.
511	if ($hdr{location} !~ /^(?: $ \| [^:\/?\#]+ : )/x) {
512	$hdr{location} =~ s/^\.\/+//;
513
514	my $url = "$rscheme://$uhost:$uport";
515
516	unless ($hdr{location} =~ s/^\///) {
517	$url .= $upath;
518	$url =~ s/\/[^\/]*$//;
519	}
520
521	$hdr{location} = "$url/$hdr{location}";	584	$hdr{location} = "$url/$hdr{location}";
		585	}
		586
		587	my $redirect;
		588
		589	if ($recurse) {
		590	my $status = $hdr{Status};
		591
		592	# industry standard is to redirect POST as GET for
		593	# 301, 302 and 303, in contrast to http/1.0 and 1.1.
		594	# also, the UA should ask the user for 301 and 307 and POST,
		595	# industry standard seems to be to simply follow.
		596	# we go with the industry standard.
		597	if ($status == 301 or $status == 302 or $status == 303) {
		598	# HTTP/1.1 is unclear on how to mutate the method
		599	$method = "GET" unless $method eq "HEAD";
		600	$redirect = 1;
		601	} elsif ($status == 307) {
		602	$redirect = 1;
522	}	603	}
		604	}
523		605
524	my $redirect;	606	my $finish = sub { # ($data, $err_status, $err_reason[, $keepalive])
		607	$state{handle}->destroy if $state{handle};
		608	%state = ();
525		609
		610	if (defined $_[1]) {
		611	$hdr{OrigStatus} = $hdr{Status}; $hdr{Status} = $_[1];
		612	$hdr{OrigReason} = $hdr{Reason}; $hdr{Reason} = $_[2];
		613	}
		614
		615	# set-cookie processing
526	if ($recurse) {	616	if ($arg{cookie_jar}) {
527	if ($hdr{Status} =~ /^30[12]$/ && $method ne "POST") {	617	for ($hdr{"set-cookie"}) {
528	# apparently, mozilla et al. just change POST to GET here	618	# parse NAME=VALUE
529	# more research is needed before we do the same	619	my @kv;
		620
		621	while (/\G\s* ([^=;,[:space:]]+) \s=\s (?: "((?:[^\\"]+\|\\.))" \| ([^=;,[:space:]]) )/gcxs) {
530	$redirect = 1;	622	my $name = $1;
531	} elsif ($hdr{Status} == 303) {	623	my $value = $3;
532	# even http/1.1 is unclear on how to mutate the method	624
533	$method = "GET" unless $method eq "HEAD";	625	unless ($value) {
		626	$value = $2;
		627	$value =~ s/\\(.)/$1/gs;
		628	}
		629
		630	push @kv, $name => $value;
		631
		632	last unless /\G\s*;/gc;
		633	}
		634
		635	last unless @kv;
		636
		637	my $name = shift @kv;
		638	my %kv = (value => shift @kv, @kv);
		639
		640	my $cdom;
		641	my $cpath = (delete $kv{path}) \|\| "/";
		642
		643	if (exists $kv{domain}) {
		644	$cdom = delete $kv{domain};
		645
		646	$cdom =~ s/^\.?/./; # make sure it starts with a "."
		647
		648	next if $cdom =~ /\.$/;
		649
		650	# this is not rfc-like and not netscape-like. go figure.
		651	my $ndots = $cdom =~ y/.//;
		652	next if $ndots < ($cdom =~ /\.[^.][^.]\.[^.][^.]$/ ? 3 : 2);
		653	} else {
		654	$cdom = $uhost;
		655	}
		656
534	$redirect = 1;	657	# store it
535	} elsif ($hdr{Status} == 307 && $method =~ /^(?:GET\|HEAD)$/) {	658	$arg{cookie_jar}{version} = 1;
536	$redirect = 1;	659	$arg{cookie_jar}{$cdom}{$cpath}{$name} = \%kv;
		660
		661	redo if /\G\s*,/gc;
537	}	662	}
538	}	663	}
539		664
540	my $finish = sub {	665	if ($redirect && exists $hdr{location}) {
541	$state{handle}->destroy if $state{handle};	666	# we ignore any errors, as it is very common to receive
542	%state = ();	667	# Content-Length != 0 but no actual body
543		668	# we also access %hdr, as $_[1] might be an erro
544	# set-cookie processing	669	http_request (
545	if ($arg{cookie_jar}) {	670	$method => $hdr{location},
546	for ($_[1]{"set-cookie"}) {
547	# parse NAME=VALUE
548	my @kv;
549
550	while (/\G\s* ([^=;,[:space:]]+) \s=\s (?: "((?:[^\\"]+\|\\.))" \| ([^=;,[:space:]]) )/gcxs) {
551	my $name = $1;
552	my $value = $3;
553
554	unless ($value) {
555	$value = $2;
556	$value =~ s/\\(.)/$1/gs;
557	}	671	%arg,
		672	recurse => $recurse - 1,
		673	Redirect => [$_[0], \%hdr],
		674	$cb);
		675	} else {
		676	$cb->($_[0], \%hdr);
		677	}
		678	};
558		679
559	push @kv, $name => $value;	680	my $len = $hdr{"content-length"};
560		681
561	last unless /\G\s*;/gc;	682	if (!$redirect && $arg{on_header} && !$arg{on_header}(\%hdr)) {
		683	$finish->(undef, 598 => "Request cancelled by on_header");
		684	} elsif (
		685	$hdr{Status} =~ /^(?:1..\|204\|205\|304)$/
		686	or $method eq "HEAD"
		687	or (defined $len && !$len)
		688	) {
		689	# no body
		690	$finish->("", undef, undef, 1);
		691	} else {
		692	# body handling, four different code paths
		693	# for want_body_handle, on_body (2x), normal (2x)
		694	# we might read too much here, but it does not matter yet (no pipelining)
		695	if (!$redirect && $arg{want_body_handle}) {
		696	$_[0]->on_eof (undef);
		697	$_[0]->on_error (undef);
		698	$_[0]->on_read (undef);
		699
		700	$finish->(delete $state{handle});
		701
		702	} elsif ($arg{on_body}) {
		703	$_[0]->on_error (sub { $finish->(undef, 599 => $_[2]) });
		704	if ($len) {
		705	$_[0]->on_read (sub {
		706	$len -= length $_[0]{rbuf};
		707
		708	$arg{on_body}(delete $_[0]{rbuf}, \%hdr)
		709	or $finish->(undef, 598 => "Request cancelled by on_body");
		710
562	}	711	$len > 0
563		712	or $finish->("", undef, undef, 1);
564	last unless @kv;
565
566	my $name = shift @kv;
567	my %kv = (value => shift @kv, @kv);
568
569	my $cdom;
570	my $cpath = (delete $kv{path}) \|\| "/";
571
572	if (exists $kv{domain}) {
573	$cdom = delete $kv{domain};
574
575	$cdom =~ s/^\.?/./; # make sure it starts with a "."
576
577	next if $cdom =~ /\.$/;
578
579	# this is not rfc-like and not netscape-like. go figure.
580	my $ndots = $cdom =~ y/.//;
581	next if $ndots < ($cdom =~ /\.[^.][^.]\.[^.][^.]$/ ? 3 : 2);
582	} else {
583	$cdom = $uhost;
584	}
585
586	# store it
587	$arg{cookie_jar}{version} = 1;
588	$arg{cookie_jar}{$cdom}{$cpath}{$name} = \%kv;
589
590	redo if /\G\s*,/gc;
591	}	713	});
		714	} else {
		715	$_[0]->on_eof (sub {
		716	$finish->("");
		717	});
		718	$_[0]->on_read (sub {
		719	$arg{on_body}(delete $_[0]{rbuf}, \%hdr)
		720	or $finish->(undef, 598 => "Request cancelled by on_body");
		721	});
592	}	722	}
		723	} else {
		724	$_[0]->on_eof (undef);
593		725
594	if ($redirect) {	726	if ($len) {
595	# we ignore any errors, as it is very common to receive	727	$_[0]->on_error (sub { $finish->(undef, 599 => $_[2]) });
596	# Content-Length != 0 but no actual body	728	$_[0]->on_read (sub {
597	# we also access %hdr, as $_[1] might be an erro	729	$finish->((substr delete $_[0]{rbuf}, 0, $len, ""), undef, undef, 1)
598	http_request ($method => $hdr{location}, %arg, recurse => $recurse - 1, $cb);	730	if $len <= length $_[0]{rbuf};
		731	});
599	} else {	732	} else {
600	$cb->($_[0], $_[1]);
601	}
602	};
603
604	my $len = $hdr{"content-length"};
605
606	if (!$redirect && $arg{on_header} && !$arg{on_header}(\%hdr)) {
607	$finish->(undef, { Status => 598, Reason => "Request cancelled by on_header", URL => $url });
608	} elsif (
609	$hdr{Status} =~ /^(?:1..\|[23]04)$/
610	or $method eq "HEAD"
611	or (defined $len && !$len)
612	) {
613	# no body
614	$finish->("", \%hdr);
615	} else {
616	# body handling, four different code paths
617	# for want_body_handle, on_body (2x), normal (2x)
618	# we might read too much here, but it does not matter yet (no pers. connections)
619	if (!$redirect && $arg{want_body_handle}) {
620	$_[0]->on_eof (undef);
621	$_[0]->on_error (undef);
622	$_[0]->on_read (undef);
623
624	$finish->(delete $state{handle}, \%hdr);
625
626	} elsif ($arg{on_body}) {
627	$_[0]->on_error (sub { $finish->(undef, { Status => 599, Reason => $_[2], URL => $url }) });
628	if ($len) {
629	$_[0]->on_eof (undef);
630	$_[0]->on_read (sub {
631	$len -= length $_[0]{rbuf};
632
633	$arg{on_body}(delete $_[0]{rbuf}, \%hdr)
634	or $finish->(undef, { Status => 598, Reason => "Request cancelled by on_body", URL => $url });
635
636	$len > 0
637	or $finish->("", \%hdr);
638	});
639	} else {
640	$_[0]->on_eof (sub {
641	$finish->("", \%hdr);
642	});
643	$_[0]->on_read (sub {
644	$arg{on_body}(delete $_[0]{rbuf}, \%hdr)
645	or $finish->(undef, { Status => 598, Reason => "Request cancelled by on_body", URL => $url });
646	});
647	}
648	} else {
649	$_[0]->on_eof (undef);
650
651	if ($len) {
652	$_[0]->on_error (sub { $finish->(undef, { Status => 599, Reason => $_[2], URL => $url }) });
653	$_[0]->on_read (sub {
654	$finish->((substr delete $_[0]{rbuf}, 0, $len, ""), \%hdr)
655	if $len <= length $_[0]{rbuf};
656	});
657	} else {
658	$_[0]->on_error (sub {	733	$_[0]->on_error (sub {
659	$! == Errno::EPIPE	734	($! == Errno::EPIPE \|\| !$!)
660	? $finish->(delete $_[0]{rbuf}, \%hdr)	735	? $finish->(delete $_[0]{rbuf})
661	: $finish->(undef, { Status => 599, Reason => $_[2], URL => $url });	736	: $finish->(undef, 599 => $_[2]);
662	});	737	});
663	$_[0]->on_read (sub { });	738	$_[0]->on_read (sub { });
664	}
665	}	739	}
666	}	740	}
667	});	741	}
668	});	742	});
669	};	743	};
670		744
671	# now handle proxy-CONNECT method	745	# now handle proxy-CONNECT method
672	if ($proxy && $uscheme eq "https") {	746	if ($proxy && $uscheme eq "https") {
…		…
674		748
675	# maybe re-use $uauthority with patched port?	749	# maybe re-use $uauthority with patched port?
676	$state{handle}->push_write ("CONNECT $uhost:$uport HTTP/1.0\015\012Host: $uhost\015\012\015\012");	750	$state{handle}->push_write ("CONNECT $uhost:$uport HTTP/1.0\015\012Host: $uhost\015\012\015\012");
677	$state{handle}->push_read (line => $qr_nlnl, sub {	751	$state{handle}->push_read (line => $qr_nlnl, sub {
678	$_[1] =~ /^HTTP\/([0-9\.]+) \s+ ([0-9]{3}) (?: \s+ ([^\015\012]*) )?/ix	752	$_[1] =~ /^HTTP\/([0-9\.]+) \s+ ([0-9]{3}) (?: \s+ ([^\015\012]*) )?/ix
679	or return (%state = (), $cb->(undef, { Status => 599, Reason => "Invalid proxy connect response ($_[1])", URL => $url }));	753	or return (%state = (), $cb->(undef, { @pseudo, Status => 599, Reason => "Invalid proxy connect response ($_[1])" }));
680		754
681	if ($2 == 200) {	755	if ($2 == 200) {
682	$rpath = $upath;	756	$rpath = $upath;
683	&$handle_actual_request;	757	&$handle_actual_request;
684	} else {	758	} else {
685	%state = ();	759	%state = ();
686	$cb->(undef, { Status => $2, Reason => $3, URL => $url });	760	$cb->(undef, { @pseudo, Status => $2, Reason => $3 });
687	}	761	}
688	});	762	});
689	} else {	763	} else {
690	&$handle_actual_request;	764	&$handle_actual_request;
691	}	765	}
692
693	}, sub {
694	$timeout
695	};	766	};
		767
		768	my $tcp_connect = $arg{tcp_connect}
		769	\|\| do { require AnyEvent::Socket; \&AnyEvent::Socket::tcp_connect };
		770
		771	$state{connect_guard} = $tcp_connect->($rhost, $rport, $connect_cb, $arg{on_prepare} \|\| sub { $timeout });
		772
696	};	773	};
697		774
698	defined wantarray && AnyEvent::Util::guard { %state = () }	775	defined wantarray && AnyEvent::Util::guard { %state = () }
699	}	776	}
700		777
…		…
714	&http_request	791	&http_request
715	}	792	}
716		793
717	=back	794	=back
718		795
		796	=head2 DNS CACHING
		797
		798	AnyEvent::HTTP uses the AnyEvent::Socket::tcp_connect function for
		799	the actual connection, which in turn uses AnyEvent::DNS to resolve
		800	hostnames. The latter is a simple stub resolver and does no caching
		801	on its own. If you want DNS caching, you currently have to provide
		802	your own default resolver (by storing a suitable resolver object in
		803	C<$AnyEvent::DNS::RESOLVER>).
		804
719	=head2 GLOBAL FUNCTIONS AND VARIABLES	805	=head2 GLOBAL FUNCTIONS AND VARIABLES
720		806
721	=over 4	807	=over 4
722		808
723	=item AnyEvent::HTTP::set_proxy "proxy-url"	809	=item AnyEvent::HTTP::set_proxy "proxy-url"
724		810
725	Sets the default proxy server to use. The proxy-url must begin with a	811	Sets the default proxy server to use. The proxy-url must begin with a
726	string of the form C<http://host:port> (optionally C<https:...>).	812	string of the form C<http://host:port> (optionally C<https:...>), croaks
		813	otherwise.
		814
		815	To clear an already-set proxy, use C<undef>.
		816
		817	=item $date = AnyEvent::HTTP::format_date $timestamp
		818
		819	Takes a POSIX timestamp (seconds since the epoch) and formats it as a HTTP
		820	Date (RFC 2616).
		821
		822	=item $timestamp = AnyEvent::HTTP::parse_date $date
		823
		824	Takes a HTTP Date (RFC 2616) and returns the corresponding POSIX
		825	timestamp, or C<undef> if the date cannot be parsed.
727		826
728	=item $AnyEvent::HTTP::MAX_RECURSE	827	=item $AnyEvent::HTTP::MAX_RECURSE
729		828
730	The default value for the C<recurse> request parameter (default: C<10>).	829	The default value for the C<recurse> request parameter (default: C<10>).
731		830
732	=item $AnyEvent::HTTP::USERAGENT	831	=item $AnyEvent::HTTP::USERAGENT
733		832
734	The default value for the C<User-Agent> header (the default is	833	The default value for the C<User-Agent> header (the default is
735	C<Mozilla/5.0 (compatible; U; AnyEvent-HTTP/$VERSION; +http://software.schmorp.de/pkg/AnyEvent)>).	834	C<Mozilla/5.0 (compatible; U; AnyEvent-HTTP/$VERSION; +http://software.schmorp.de/pkg/AnyEvent)>).
736		835
737	=item $AnyEvent::HTTP::MAX_PERSISTENT	836	=item $AnyEvent::HTTP::MAX_PER_HOST
738		837
739	The maximum number of persistent connections to keep open (default: 8).	838	The maximum number of concurrent connections to the same host (identified
		839	by the hostname). If the limit is exceeded, then the additional requests
		840	are queued until previous connections are closed.
740		841
741	Not implemented currently.	842	The default value for this is C<4>, and it is highly advisable to not
742		843	increase it.
743	=item $AnyEvent::HTTP::PERSISTENT_TIMEOUT
744
745	The maximum time to cache a persistent connection, in seconds (default: 2).
746
747	Not implemented currently.
748		844
749	=item $AnyEvent::HTTP::ACTIVE	845	=item $AnyEvent::HTTP::ACTIVE
750		846
751	The number of active connections. This is not the number of currently	847	The number of active connections. This is not the number of currently
752	running requests, but the number of currently open and non-idle TCP	848	running requests, but the number of currently open and non-idle TCP
…		…
754		850
755	=back	851	=back
756		852
757	=cut	853	=cut
758		854
		855	our @month = qw(Jan Feb Mar Apr May Jun Jul Aug Sep Oct Nov Dec);
		856	our @weekday = qw(Sun Mon Tue Wed Thu Fri Sat);
		857
		858	sub format_date($) {
		859	my ($time) = @_;
		860
		861	# RFC 822/1123 format
		862	my ($S, $M, $H, $mday, $mon, $year, $wday, $yday, undef) = gmtime $time;
		863
		864	sprintf "%s, %02d %s %04d %02d:%02d:%02d GMT",
		865	$weekday[$wday], $mday, $month[$mon], $year + 1900,
		866	$H, $M, $S;
		867	}
		868
		869	sub parse_date($) {
		870	my ($date) = @_;
		871
		872	my ($d, $m, $y, $H, $M, $S);
		873
		874	if ($date =~ /^[A-Z][a-z][a-z], ([0-9][0-9]) ([A-Z][a-z][a-z]) ([0-9][0-9][0-9][0-9]) ([0-9][0-9]):([0-9][0-9]):([0-9][0-9]) GMT$/) {
		875	# RFC 822/1123, required by RFC 2616
		876	($d, $m, $y, $H, $M, $S) = ($1, $2, $3, $4, $5, $6);
		877
		878	} elsif ($date =~ /^[A-Z][a-z]+, ([0-9][0-9])-([A-Z][a-z][a-z])-([0-9][0-9]) ([0-9][0-9]):([0-9][0-9]):([0-9][0-9]) GMT$/) {
		879	# RFC 850
		880	($d, $m, $y, $H, $M, $S) = ($1, $2, $3 < 69 ? $3 + 2000 : $3 + 1900, $4, $5, $6);
		881
		882	} elsif ($date =~ /^[A-Z][a-z][a-z] ([A-Z][a-z][a-z]) ([0-9 ][0-9]) ([0-9][0-9]):([0-9][0-9]):([0-9][0-9]) ([0-9][0-9][0-9][0-9])$/) {
		883	# ISO C's asctime
		884	($d, $m, $y, $H, $M, $S) = ($2, $1, $6, $3, $4, $5);
		885	}
		886	# other formats fail in the loop below
		887
		888	for (0..11) {
		889	if ($m eq $month[$_]) {
		890	require Time::Local;
		891	return Time::Local::timegm ($S, $M, $H, $d, $_, $y);
		892	}
		893	}
		894
		895	undef
		896	}
		897
759	sub set_proxy($) {	898	sub set_proxy($) {
		899	if (length $_[0]) {
760	$PROXY = [$2, $3 \|\| 3128, $1] if $_[0] =~ m%^(https?):// ([^:/]+) (?: : (\d*) )?%ix;	900	$_[0] =~ m%^(https?):// ([^:/]+) (?: : (\d*) )?%ix
		901	or Carp::croak "$_[0]: invalid proxy URL";
		902	$PROXY = [$2, $3 \|\| 3128, $1]
		903	} else {
		904	undef $PROXY;
		905	}
761	}	906	}
762		907
763	# initialise proxy from environment	908	# initialise proxy from environment
		909	eval {
764	set_proxy $ENV{http_proxy};	910	set_proxy $ENV{http_proxy};
		911	};
		912
		913	=head2 SOCKS PROXIES
		914
		915	Socks proxies are not directly supported by AnyEvent::HTTP. You can
		916	compile your perl to support socks, or use an external program such as
		917	F<socksify> (dante) or F<tsocks> to make your program use a socks proxy
		918	transparently.
		919
		920	Alternatively, for AnyEvent::HTTP only, you can use your own
		921	C<tcp_connect> function that does the proxy handshake - here is an example
		922	that works with socks4a proxies:
		923
		924	use Errno;
		925	use AnyEvent::Util;
		926	use AnyEvent::Socket;
		927	use AnyEvent::Handle;
		928
		929	# host, port and username of/for your socks4a proxy
		930	my $socks_host = "10.0.0.23";
		931	my $socks_port = 9050;
		932	my $socks_user = "";
		933
		934	sub socks4a_connect {
		935	my ($host, $port, $connect_cb, $prepare_cb) = @_;
		936
		937	my $hdl = new AnyEvent::Handle
		938	connect => [$socks_host, $socks_port],
		939	on_prepare => sub { $prepare_cb->($_[0]{fh}) },
		940	on_error => sub { $connect_cb->() },
		941	;
		942
		943	$hdl->push_write (pack "CCnNZZ", 4, 1, $port, 1, $socks_user, $host);
		944
		945	$hdl->push_read (chunk => 8, sub {
		946	my ($hdl, $chunk) = @_;
		947	my ($status, $port, $ipn) = unpack "xCna4", $chunk;
		948
		949	if ($status == 0x5a) {
		950	$connect_cb->($hdl->{fh}, (format_address $ipn) . ":$port");
		951	} else {
		952	$! = Errno::ENXIO; $connect_cb->();
		953	}
		954	});
		955
		956	$hdl
		957	}
		958
		959	Use C<socks4a_connect> instead of C<tcp_connect> when doing C<http_request>s,
		960	possibly after switching off other proxy types:
		961
		962	AnyEvent::HTTP::set_proxy undef; # usually you do not want other proxies
		963
		964	http_get 'http://www.google.com', tcp_connect => \&socks4a_connect, sub {
		965	my ($data, $headers) = @_;
		966	...
		967	};
765		968
766	=head1 SEE ALSO	969	=head1 SEE ALSO
767		970
768	L<AnyEvent>.	971	L<AnyEvent>.
769		972

Diff Legend

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

Comparing AnyEvent-HTTP/HTTP.pm (file contents): Revision 1.42 by root, Mon Jul 6 00:08:16 2009 UTC vs. Revision 1.65 by root, Fri Dec 31 03:47:32 2010 UTC

Diff Legend

Comparing AnyEvent-HTTP/HTTP.pm (file contents):
Revision 1.42 by root, Mon Jul 6 00:08:16 2009 UTC vs.
Revision 1.65 by root, Fri Dec 31 03:47:32 2010 UTC