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

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.62 by root, Thu Dec 30 04:30:24 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.62 by root, Thu Dec 30 04:30:24 2010 UTC