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

Comparing AnyEvent-HTTP/HTTP.pm (file contents):
Revision 1.49 by root, Wed Aug 5 16:23:48 2009 UTC vs.
Revision 1.68 by root, Fri Dec 31 19:22:18 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.8 ();	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.42';	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;
…		…
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
101	second argument.	100	(and trailers) as 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,
…		…
136	Whether to recurse requests or not, e.g. on redirects, authentication	150	Whether to recurse requests or not, e.g. on redirects, authentication
137	retries and so on, and how often to do so.	151	retries and so on, and how often to do so.
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 own
142	own C<Host:>, C<Content-Length:>, C<Connection:> and C<Cookie:> headers	156	C<Host:>, C<Content-Length:>, C<Connection:> and C<Cookie:> headers and
143	and will provide defaults for C<User-Agent:> and C<Referer:> (this can be	157	will provide defaults for C<TE:>, C<Referer:> and C<User-Agent:> (this can
144	suppressed by using C<undef> for these headers in which case they won't be	158	be suppressed by using C<undef> for these headers in which case they won't
145	sent at all).	159	be sent at all).
146		160
147	=item timeout => $seconds	161	=item timeout => $seconds
148		162
149	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
150	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.
151		168
152	=item proxy => [$host, $port[, $scheme]] or undef	169	=item proxy => [$host, $port[, $scheme]] or undef
153		170
154	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
155	default proxy (as specified by C<$ENV{http_proxy}>) is used.	172	default proxy (as specified by C<$ENV{http_proxy}>) is used.
…		…
157	C<$scheme> must be either missing, C<http> for HTTP or C<https> for	174	C<$scheme> must be either missing, C<http> for HTTP or C<https> for
158	HTTPS.	175	HTTPS.
159		176
160	=item body => $string	177	=item body => $string
161		178
162	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
163	this module might offer more options).	180	this module might offer more options).
164		181
165	=item cookie_jar => $hash_ref	182	=item cookie_jar => $hash_ref
166		183
167	Passing this parameter enables (simplified) cookie-processing, loosely	184	Passing this parameter enables (simplified) cookie-processing, loosely
…		…
188	verification) TLS context.	205	verification) TLS context.
189		206
190	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
191	me the page, no matter what".	208	me the page, no matter what".
192		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
193	=item on_header => $callback->($headers)	231	=item on_header => $callback->($headers)
194		232
195	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
196	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
197	locally-generated errors).	235	locally-generated errors).
…		…
202		240
203	This callback is useful, among other things, to quickly reject unwanted	241	This callback is useful, among other things, to quickly reject unwanted
204	content, which, if it is supposed to be rare, can be faster than first	242	content, which, if it is supposed to be rare, can be faster than first
205	doing a C<HEAD> request.	243	doing a C<HEAD> request.
206		244
		245	The downside is that cancelling the request makes it impossible to re-use
		246	the connection. Also, the C<on_header> callback will not receive any
		247	trailer (headers sent after the response body).
		248
207	Example: cancel the request unless the content-type is "text/html".	249	Example: cancel the request unless the content-type is "text/html".
208		250
209	on_header => sub {	251	on_header => sub {
210	$_[0]{"content-type"} =~ /^text\/html\s*(?:;\|$)/	252	$_[0]{"content-type"} =~ /^text\/html\s*(?:;\|$)/
211	},	253	},
…		…
217	string instead of the body data.	259	string instead of the body data.
218		260
219	It has to return either true (in which case AnyEvent::HTTP will continue),	261	It has to return either true (in which case AnyEvent::HTTP will continue),
220	or false, in which case AnyEvent::HTTP will cancel the download (and call	262	or false, in which case AnyEvent::HTTP will cancel the download (and call
221	the completion callback with an error code of C<598>).	263	the completion callback with an error code of C<598>).
		264
		265	The downside to cancelling the request is that it makes it impossible to
		266	re-use the connection.
222		267
223	This callback is useful when the data is too large to be held in memory	268	This callback is useful when the data is too large to be held in memory
224	(so the callback writes it to a file) or when only some information should	269	(so the callback writes it to a file) or when only some information should
225	be extracted, or when the body should be processed incrementally.	270	be extracted, or when the body should be processed incrementally.
226		271
…		…
252	If you think you need this, first have a look at C<on_body>, to see if	297	If you think you need this, first have a look at C<on_body>, to see if
253	that doesn't solve your problem in a better way.	298	that doesn't solve your problem in a better way.
254		299
255	=back	300	=back
256		301
257	Example: make a simple HTTP GET request for http://www.nethype.de/	302	Example: do a simple HTTP GET request for http://www.nethype.de/ and print
		303	the response body.
258		304
259	http_request GET => "http://www.nethype.de/", sub {	305	http_request GET => "http://www.nethype.de/", sub {
260	my ($body, $hdr) = @_;	306	my ($body, $hdr) = @_;
261	print "$body\n";	307	print "$body\n";
262	};	308	};
263		309
264	Example: make a HTTP HEAD request on https://www.google.com/, use a	310	Example: do a HTTP HEAD request on https://www.google.com/, use a
265	timeout of 30 seconds.	311	timeout of 30 seconds.
266		312
267	http_request	313	http_request
268	GET => "https://www.google.com",	314	GET => "https://www.google.com",
269	timeout => 30,	315	timeout => 30,
…		…
272	use Data::Dumper;	318	use Data::Dumper;
273	print Dumper $hdr;	319	print Dumper $hdr;
274	}	320	}
275	;	321	;
276		322
277	Example: make another simple HTTP GET request, but immediately try to	323	Example: do another simple HTTP GET request, but immediately try to
278	cancel it.	324	cancel it.
279		325
280	my $request = http_request GET => "http://www.nethype.de/", sub {	326	my $request = http_request GET => "http://www.nethype.de/", sub {
281	my ($body, $hdr) = @_;	327	my ($body, $hdr) = @_;
282	print "$body\n";	328	print "$body\n";
…		…
314	push @{ $CO_SLOT{$_[0]}[1] }, $_[1];	360	push @{ $CO_SLOT{$_[0]}[1] }, $_[1];
315		361
316	_slot_schedule $_[0];	362	_slot_schedule $_[0];
317	}	363	}
318		364
319	our $qr_nl = qr{\015?\012};	365	# continue to parse $_ for headers and place them into the arg
		366	sub parse_hdr() {
		367	my %hdr;
		368
		369	# things seen, not parsed:
		370	# p3pP="NON CUR OTPi OUR NOR UNI"
		371
		372	$hdr{lc $1} .= ",$2"
		373	while /\G
		374	([^:\000-\037]*):
		375	[\011\040]*
		376	((?: [^\012]+ \| \012[\011\040] )*)
		377	\012
		378	/gxc;
		379
		380	/\G$/
		381	or return;
		382
		383	# remove the "," prefix we added to all headers above
		384	substr $_, 0, 1, ""
		385	for values %hdr;
		386
		387	\%hdr
		388	}
		389
320	our $qr_nlnl = qr{(?<![^\012])\015?\012};	390	our $qr_nlnl = qr{(?<![^\012])\015?\012};
321		391
322	our $TLS_CTX_LOW = { cache => 1, sslv2 => 1 };	392	our $TLS_CTX_LOW = { cache => 1, sslv2 => 1 };
323	our $TLS_CTX_HIGH = { cache => 1, verify => 1, verify_peername => "https" };	393	our $TLS_CTX_HIGH = { cache => 1, verify => 1, verify_peername => "https" };
324		394
…		…
337	while (my ($k, $v) = each %$hdr) {	407	while (my ($k, $v) = each %$hdr) {
338	$hdr{lc $k} = $v;	408	$hdr{lc $k} = $v;
339	}	409	}
340	}	410	}
341		411
		412	# pseudo headers for all subsequent responses
		413	my @pseudo = (URL => $url);
		414	push @pseudo, Redirect => delete $arg{Redirect} if exists $arg{Redirect};
		415
342	my $recurse = exists $arg{recurse} ? delete $arg{recurse} : $MAX_RECURSE;	416	my $recurse = exists $arg{recurse} ? delete $arg{recurse} : $MAX_RECURSE;
343		417
344	return $cb->(undef, { Status => 599, Reason => "Too many redirections", URL => $url })	418	return $cb->(undef, { @pseudo, Status => 599, Reason => "Too many redirections" })
345	if $recurse < 0;	419	if $recurse < 0;
346		420
347	my $proxy = $arg{proxy} \|\| $PROXY;	421	my $proxy = $arg{proxy} \|\| $PROXY;
348	my $timeout = $arg{timeout} \|\| $TIMEOUT;	422	my $timeout = $arg{timeout} \|\| $TIMEOUT;
349		423
350	my ($uscheme, $uauthority, $upath, $query, $fragment) =	424	my ($uscheme, $uauthority, $upath, $query, $fragment) =
351	$url =~ m\|(?:([^:/?#]+):)?(?://([^/?#]))?([^?#])(?:\?([^#]))?(?:#(.))?\|;	425	$url =~ m\|(?:([^:/?#]+):)?(?://([^/?#]))?([^?#])(?:(\?[^#]))?(?:#(.))?\|;
352		426
353	$uscheme = lc $uscheme;	427	$uscheme = lc $uscheme;
354		428
355	my $uport = $uscheme eq "http" ? 80	429	my $uport = $uscheme eq "http" ? 80
356	: $uscheme eq "https" ? 443	430	: $uscheme eq "https" ? 443
357	: return $cb->(undef, { Status => 599, Reason => "Only http and https URL schemes supported", URL => $url });	431	: return $cb->(undef, { @pseudo, Status => 599, Reason => "Only http and https URL schemes supported" });
358		432
359	$uauthority =~ /^(?: .*\@ )? ([^\@:]+) (?: : (\d+) )?$/x	433	$uauthority =~ /^(?: .*\@ )? ([^\@:]+) (?: : (\d+) )?$/x
360	or return $cb->(undef, { Status => 599, Reason => "Unparsable URL", URL => $url });	434	or return $cb->(undef, { @pseudo, Status => 599, Reason => "Unparsable URL" });
361		435
362	my $uhost = $1;	436	my $uhost = $1;
363	$uport = $2 if defined $2;	437	$uport = $2 if defined $2;
364		438
365	$hdr{host} = defined $2 ? "$uhost:$2" : "$uhost";	439	$hdr{host} = defined $2 ? "$uhost:$2" : "$uhost"
		440	unless exists $hdr{host};
366		441
367	$uhost =~ s/^\[(.*)\]$/$1/;	442	$uhost =~ s/^\[(.*)\]$/$1/;
368	$upath .= "?$query" if length $query;	443	$upath .= $query if length $query;
369		444
370	$upath =~ s%^/?%/%;	445	$upath =~ s%^/?%/%;
371		446
372	# cookie processing	447	# cookie processing
373	if (my $jar = $arg{cookie_jar}) {	448	if (my $jar = $arg{cookie_jar}) {
…		…
413	} else {	488	} else {
414	($rhost, $rport, $rscheme, $rpath) = ($uhost, $uport, $uscheme, $upath);	489	($rhost, $rport, $rscheme, $rpath) = ($uhost, $uport, $uscheme, $upath);
415	}	490	}
416		491
417	# leave out fragment and query string, just a heuristic	492	# leave out fragment and query string, just a heuristic
418	$hdr{referer} \|\|= "$uscheme://$uauthority$upath" unless exists $hdr{referer};	493	$hdr{referer} = "$uscheme://$uauthority$upath" unless exists $hdr{referer};
419	$hdr{"user-agent"} \|\|= $USERAGENT unless exists $hdr{"user-agent"};	494	$hdr{"user-agent"} = $USERAGENT unless exists $hdr{"user-agent"};
420		495
421	$hdr{"content-length"} = length $arg{body};	496	$hdr{"content-length"} = length $arg{body}
		497	if length $arg{body} \|\| $method ne "GET";
		498
		499	$hdr{connection} = "close TE"; #1.1
		500	$hdr{te} = "trailers" unless exists $hdr{te}; #1.1
422		501
423	my %state = (connect_guard => 1);	502	my %state = (connect_guard => 1);
424		503
425	_get_slot $uhost, sub {	504	_get_slot $uhost, sub {
426	$state{slot_guard} = shift;	505	$state{slot_guard} = shift;
427		506
428	return unless $state{connect_guard};	507	return unless $state{connect_guard};
429		508
430	$state{connect_guard} = AnyEvent::Socket::tcp_connect $rhost, $rport, sub {	509	my $connect_cb = sub {
431	$state{fh} = shift	510	$state{fh} = shift
432	or do {	511	or do {
433	my $err = "$!";	512	my $err = "$!";
434	%state = ();	513	%state = ();
435	return $cb->(undef, { Status => 599, Reason => $err, URL => $url });	514	return $cb->(undef, { @pseudo, Status => 599, Reason => $err });
436	};	515	};
437		516
438	pop; # free memory, save a tree	517	pop; # free memory, save a tree
439		518
440	return unless delete $state{connect_guard};	519	return unless delete $state{connect_guard};
441		520
442	# get handle	521	# get handle
443	$state{handle} = new AnyEvent::Handle	522	$state{handle} = new AnyEvent::Handle
444	fh => $state{fh},	523	fh => $state{fh},
		524	peername => $rhost,
		525	tls_ctx => $arg{tls_ctx},
		526	# these need to be reconfigured on keepalive handles
445	timeout => $timeout,	527	timeout => $timeout,
446	peername => $rhost,	528	on_error => sub {
447	tls_ctx => $arg{tls_ctx};	529	%state = ();
		530	$cb->(undef, { @pseudo, Status => 599, Reason => $_[2] });
		531	},
		532	on_eof => sub {
		533	%state = ();
		534	$cb->(undef, { @pseudo, Status => 599, Reason => "Unexpected end-of-file" });
		535	},
		536	;
448		537
449	# limit the number of persistent connections	538	# limit the number of persistent connections
450	# keepalive not yet supported	539	# keepalive not yet supported
451	if ($KA_COUNT{$_[1]} < $MAX_PERSISTENT_PER_HOST) {	540	# if ($KA_COUNT{$_[1]} < $MAX_PERSISTENT_PER_HOST) {
452	++$KA_COUNT{$_[1]};	541	# ++$KA_COUNT{$_[1]};
453	$state{handle}{ka_count_guard} = AnyEvent::Util::guard {	542	# $state{handle}{ka_count_guard} = AnyEvent::Util::guard {
454	--$KA_COUNT{$_[1]}	543	# --$KA_COUNT{$_[1]}
455	};	544	# };
456	$hdr{connection} = "keep-alive";	545	# $hdr{connection} = "keep-alive";
457	} else {
458	delete $hdr{connection};
459	}	546	# }
460
461	# (re-)configure handle
462	$state{handle}->on_error (sub {
463	%state = ();
464	$cb->(undef, { Status => 599, Reason => $_[2], URL => $url });
465	});
466	$state{handle}->on_eof (sub {
467	%state = ();
468	$cb->(undef, { Status => 599, Reason => "Unexpected end-of-file", URL => $url });
469	});
470		547
471	$state{handle}->starttls ("connect") if $rscheme eq "https";	548	$state{handle}->starttls ("connect") if $rscheme eq "https";
472		549
473	# handle actual, non-tunneled, request	550	# handle actual, non-tunneled, request
474	my $handle_actual_request = sub {	551	my $handle_actual_request = sub {
475	$state{handle}->starttls ("connect") if $uscheme eq "https" && !exists $state{handle}{tls};	552	$state{handle}->starttls ("connect") if $uscheme eq "https" && !exists $state{handle}{tls};
476		553
477	# send request	554	# send request
478	$state{handle}->push_write (	555	$state{handle}->push_write (
479	"$method $rpath HTTP/1.0\015\012"	556	"$method $rpath HTTP/1.1\015\012"
480	. (join "", map "\u$_: $hdr{$_}\015\012", grep defined $hdr{$_}, keys %hdr)	557	. (join "", map "\u$_: $hdr{$_}\015\012", grep defined $hdr{$_}, keys %hdr)
481	. "\015\012"	558	. "\015\012"
482	. (delete $arg{body})	559	. (delete $arg{body})
483	);	560	);
484		561
		562	# return if error occured during push_write()
		563	return unless %state;
		564
485	%hdr = (); # reduce memory usage, save a kitten	565	%hdr = (); # reduce memory usage, save a kitten, also make it possible to re-use
486		566
487	# status line	567	# status line and headers
488	$state{handle}->push_read (line => $qr_nl, sub {	568	$state{read_response} = sub {
489	$_[1] =~ /^HTTP\/([0-9\.]+) \s+ ([0-9]{3}) (?: \s+ ([^\015\012]*) )?/ix
490	or return (%state = (), $cb->(undef, { Status => 599, Reason => "Invalid server response ($_[1])", URL => $url }));
491
492	my %hdr = ( # response headers
493	HTTPVersion => ",$1",
494	Status => ",$2",
495	Reason => ",$3",
496	URL => ",$url"
497	);
498
499	# headers, could be optimized a bit
500	$state{handle}->unshift_read (line => $qr_nlnl, sub {
501	for ("$_[1]") {	569	for ("$_[1]") {
502	y/\015//d; # weed out any \015, as they show up in the weirdest of places.	570	y/\015//d; # weed out any \015, as they show up in the weirdest of places.
503		571
504	# things seen, not parsed:	572	/^HTTP\/([0-9\.]+) \s+ ([0-9]{3}) (?: \s+ ([^\012]*) )? \012/igxc
505	# p3pP="NON CUR OTPi OUR NOR UNI"	573	or return (%state = (), $cb->(undef, { @pseudo, Status => 599, Reason => "Invalid server response" }));
506		574
507	$hdr{lc $1} .= ",$2"	575	# 100 Continue handling
508	while /\G	576	# should not happen as we don't send expect: 100-continue,
509	([^:\000-\037]*):	577	# but we handle it just in case.
510	[\011\040]*	578	# since we send the request body regardless, if we get an error
511	((?: [^\012]+ \| \012[\011\040] )*)	579	# we are out of-sync, which we currently do NOT handle correctly.
512	\012	580	return $state{handle}->push_read (line => $qr_nlnl, $state{read_response})
513	/gxc;	581	if $2 eq 100;
514		582
		583	push @pseudo,
		584	HTTPVersion => $1,
		585	Status => $2,
		586	Reason => $3,
515	/\G$/	587	;
		588
		589	my $hdr = parse_hdr
516	or return (%state = (), $cb->(undef, { Status => 599, Reason => "Garbled response headers", URL => $url }));	590	or return (%state = (), $cb->(undef, { @pseudo, Status => 599, Reason => "Garbled response headers" }));
		591
		592	%hdr = (%$hdr, @pseudo);
		593	}
		594
		595	# redirect handling
		596	# microsoft and other shitheads don't give a shit for following standards,
		597	# try to support some common forms of broken Location headers.
		598	if ($hdr{location} !~ /^(?: $ \| [^:\/?\#]+ : )/x) {
		599	$hdr{location} =~ s/^\.\/+//;
		600
		601	my $url = "$rscheme://$uhost:$uport";
		602
		603	unless ($hdr{location} =~ s/^\///) {
		604	$url .= $upath;
		605	$url =~ s/\/[^\/]*$//;
517	}	606	}
518		607
519	substr $_, 0, 1, ""
520	for values %hdr;
521
522	# redirect handling
523	# microsoft and other shitheads don't give a shit for following standards,
524	# try to support some common forms of broken Location headers.
525	if ($hdr{location} !~ /^(?: $ \| [^:\/?\#]+ : )/x) {
526	$hdr{location} =~ s/^\.\/+//;
527
528	my $url = "$rscheme://$uhost:$uport";
529
530	unless ($hdr{location} =~ s/^\///) {
531	$url .= $upath;
532	$url =~ s/\/[^\/]*$//;
533	}
534
535	$hdr{location} = "$url/$hdr{location}";	608	$hdr{location} = "$url/$hdr{location}";
		609	}
		610
		611	my $redirect;
		612
		613	if ($recurse) {
		614	my $status = $hdr{Status};
		615
		616	# industry standard is to redirect POST as GET for
		617	# 301, 302 and 303, in contrast to http/1.0 and 1.1.
		618	# also, the UA should ask the user for 301 and 307 and POST,
		619	# industry standard seems to be to simply follow.
		620	# we go with the industry standard.
		621	if ($status == 301 or $status == 302 or $status == 303) {
		622	# HTTP/1.1 is unclear on how to mutate the method
		623	$method = "GET" unless $method eq "HEAD";
		624	$redirect = 1;
		625	} elsif ($status == 307) {
		626	$redirect = 1;
536	}	627	}
		628	}
537		629
		630	my $finish = sub { # ($data, $err_status, $err_reason[, $keepalive])
538	my $redirect;	631	my $keepalive = pop;
539		632
		633	$state{handle}->destroy if $state{handle};
		634	%state = ();
		635
		636	if (defined $_[1]) {
		637	$hdr{OrigStatus} = $hdr{Status}; $hdr{Status} = $_[1];
		638	$hdr{OrigReason} = $hdr{Reason}; $hdr{Reason} = $_[2];
		639	}
		640
		641	# set-cookie processing
540	if ($recurse) {	642	if ($arg{cookie_jar}) {
541	if ($hdr{Status} =~ /^30[12]$/ && $method ne "POST") {	643	for ($hdr{"set-cookie"}) {
542	# apparently, mozilla et al. just change POST to GET here	644	# parse NAME=VALUE
543	# more research is needed before we do the same	645	my @kv;
		646
		647	while (/\G\s* ([^=;,[:space:]]+) \s=\s (?: "((?:[^\\"]+\|\\.))" \| ([^=;,[:space:]]) )/gcxs) {
544	$redirect = 1;	648	my $name = $1;
545	} elsif ($hdr{Status} == 303) {	649	my $value = $3;
546	# even http/1.1 is unclear on how to mutate the method	650
547	$method = "GET" unless $method eq "HEAD";	651	unless ($value) {
		652	$value = $2;
		653	$value =~ s/\\(.)/$1/gs;
		654	}
		655
		656	push @kv, $name => $value;
		657
		658	last unless /\G\s*;/gc;
		659	}
		660
		661	last unless @kv;
		662
		663	my $name = shift @kv;
		664	my %kv = (value => shift @kv, @kv);
		665
		666	my $cdom;
		667	my $cpath = (delete $kv{path}) \|\| "/";
		668
		669	if (exists $kv{domain}) {
		670	$cdom = delete $kv{domain};
		671
		672	$cdom =~ s/^\.?/./; # make sure it starts with a "."
		673
		674	next if $cdom =~ /\.$/;
		675
		676	# this is not rfc-like and not netscape-like. go figure.
		677	my $ndots = $cdom =~ y/.//;
		678	next if $ndots < ($cdom =~ /\.[^.][^.]\.[^.][^.]$/ ? 3 : 2);
		679	} else {
		680	$cdom = $uhost;
		681	}
		682
548	$redirect = 1;	683	# store it
549	} elsif ($hdr{Status} == 307 && $method =~ /^(?:GET\|HEAD)$/) {	684	$arg{cookie_jar}{version} = 1;
550	$redirect = 1;	685	$arg{cookie_jar}{$cdom}{$cpath}{$name} = \%kv;
		686
		687	redo if /\G\s*,/gc;
551	}	688	}
552	}	689	}
553		690
554	my $finish = sub {
555	$state{handle}->destroy if $state{handle};
556	%state = ();
557
558	# set-cookie processing
559	if ($arg{cookie_jar}) {
560	for ($_[1]{"set-cookie"}) {
561	# parse NAME=VALUE
562	my @kv;
563
564	while (/\G\s* ([^=;,[:space:]]+) \s=\s (?: "((?:[^\\"]+\|\\.))" \| ([^=;,[:space:]]) )/gcxs) {
565	my $name = $1;
566	my $value = $3;
567
568	unless ($value) {
569	$value = $2;
570	$value =~ s/\\(.)/$1/gs;
571	}
572
573	push @kv, $name => $value;
574
575	last unless /\G\s*;/gc;
576	}
577
578	last unless @kv;
579
580	my $name = shift @kv;
581	my %kv = (value => shift @kv, @kv);
582
583	my $cdom;
584	my $cpath = (delete $kv{path}) \|\| "/";
585
586	if (exists $kv{domain}) {
587	$cdom = delete $kv{domain};
588
589	$cdom =~ s/^\.?/./; # make sure it starts with a "."
590
591	next if $cdom =~ /\.$/;
592
593	# this is not rfc-like and not netscape-like. go figure.
594	my $ndots = $cdom =~ y/.//;
595	next if $ndots < ($cdom =~ /\.[^.][^.]\.[^.][^.]$/ ? 3 : 2);
596	} else {
597	$cdom = $uhost;
598	}
599
600	# store it
601	$arg{cookie_jar}{version} = 1;
602	$arg{cookie_jar}{$cdom}{$cpath}{$name} = \%kv;
603
604	redo if /\G\s*,/gc;
605	}
606	}
607
608	if ($redirect && exists $hdr{location}) {	691	if ($redirect && exists $hdr{location}) {
609	# we ignore any errors, as it is very common to receive	692	# we ignore any errors, as it is very common to receive
610	# Content-Length != 0 but no actual body	693	# Content-Length != 0 but no actual body
611	# we also access %hdr, as $_[1] might be an erro	694	# we also access %hdr, as $_[1] might be an erro
612	http_request ($method => $hdr{location}, %arg, recurse => $recurse - 1, $cb);	695	http_request (
613	} else {	696	$method => $hdr{location},
614	$cb->($_[0], $_[1]);
615	}	697	%arg,
		698	recurse => $recurse - 1,
		699	Redirect => [$_[0], \%hdr],
616	};	700	$cb);
617
618	my $len = $hdr{"content-length"};
619
620	if (!$redirect && $arg{on_header} && !$arg{on_header}(\%hdr)) {
621	$finish->(undef, { Status => 598, Reason => "Request cancelled by on_header", URL => $url });
622	} elsif (
623	$hdr{Status} =~ /^(?:1..\|[23]04)$/
624	or $method eq "HEAD"
625	or (defined $len && !$len)
626	) {
627	# no body
628	$finish->("", \%hdr);
629	} else {	701	} else {
		702	$cb->($_[0], \%hdr);
		703	}
		704	};
		705
		706	my $len = $hdr{"content-length"};
		707
		708	if (!$redirect && $arg{on_header} && !$arg{on_header}(\%hdr)) {
		709	$finish->(undef, 598 => "Request cancelled by on_header");
		710	} elsif (
		711	$hdr{Status} =~ /^(?:1..\|204\|205\|304)$/
		712	or $method eq "HEAD"
		713	or (defined $len && !$len)
		714	) {
		715	# no body
		716	$finish->("", undef, undef, 1);
		717	} else {
630	# body handling, four different code paths	718	# body handling, many different code paths
631	# for want_body_handle, on_body (2x), normal (2x)	719	# - no body expected
632	# we might read too much here, but it does not matter yet (no pers. connections)	720	# - want_body_handle
		721	# - te chunked
		722	# - 2x length known (with or without on_body)
		723	# - 2x length not known (with or without on_body)
633	if (!$redirect && $arg{want_body_handle}) {	724	if (!$redirect && $arg{want_body_handle}) {
634	$_[0]->on_eof (undef);	725	$_[0]->on_eof (undef);
635	$_[0]->on_error (undef);	726	$_[0]->on_error (undef);
636	$_[0]->on_read (undef);	727	$_[0]->on_read (undef);
637		728
638	$finish->(delete $state{handle}, \%hdr);	729	$finish->(delete $state{handle});
639		730
640	} elsif ($arg{on_body}) {	731	} elsif ($hdr{"transfer-encoding"} =~ /\bchunked\b/i) {
		732	my $cl = 0;
		733	my $body = undef;
		734	my $on_body = $arg{on_body} \|\| sub { $body .= shift; 1 };
		735
641	$_[0]->on_error (sub { $finish->(undef, { Status => 599, Reason => $_[2], URL => $url }) });	736	$_[0]->on_error (sub { $finish->(undef, 599 => $_[2]) });
		737
		738	my $read_chunk; $read_chunk = sub {
		739	$_[1] =~ /^([0-9a-fA-F]+)/
		740	or $finish->(undef, 599 => "Garbled chunked transfer encoding");
		741
		742	my $len = hex $1;
		743
642	if ($len) {	744	if ($len) {
643	$_[0]->on_eof (undef);	745	$cl += $len;
		746
		747	$_[0]->push_read (chunk => $len, sub {
		748	$on_body->($_[1], \%hdr)
		749	or return $finish->(undef, 598 => "Request cancelled by on_body");
		750
644	$_[0]->on_read (sub {	751	$_[0]->push_read (line => sub {
645	$len -= length $_[0]{rbuf};	752	length $_[1]
646		753	and return $finish->(undef, 599 => "Garbled chunked transfer encoding");
647	$arg{on_body}(delete $_[0]{rbuf}, \%hdr)	754	$_[0]->push_read (line => $read_chunk);
648	or $finish->(undef, { Status => 598, Reason => "Request cancelled by on_body", URL => $url });
649
650	$len > 0	755	});
651	or $finish->("", \%hdr);
652	});	756	});
653	} else {	757	} else {
654	$_[0]->on_eof (sub {	758	$hdr{"content-length"} \|\|= $cl;
655	$finish->("", \%hdr);	759
		760	$_[0]->push_read (line => $qr_nlnl, sub {
		761	if (length $_[1]) {
		762	for ("$_[1]") {
		763	y/\015//d; # weed out any \015, as they show up in the weirdest of places.
		764
		765	my $hdr = parse_hdr
		766	or return $finish->(undef, 599 => "Garbled response trailers");
		767
		768	%hdr = (%hdr, %$hdr);
		769	}
656	});	770	}
657	$_[0]->on_read (sub {	771
658	$arg{on_body}(delete $_[0]{rbuf}, \%hdr)	772	$finish->($body, undef, undef, 1);
659	or $finish->(undef, { Status => 598, Reason => "Request cancelled by on_body", URL => $url });
660	});	773	});
661	}	774	}
		775	};
		776
		777	$_[0]->push_read (line => $read_chunk);
		778
		779	} elsif ($arg{on_body}) {
		780	$_[0]->on_error (sub { $finish->(undef, 599 => $_[2]) });
		781
		782	if ($len) {
		783	$_[0]->on_read (sub {
		784	$len -= length $_[0]{rbuf};
		785
		786	$arg{on_body}(delete $_[0]{rbuf}, \%hdr)
		787	or return $finish->(undef, 598 => "Request cancelled by on_body");
		788
		789	$len > 0
		790	or $finish->("", undef, undef, 1);
		791	});
662	} else {	792	} else {
663	$_[0]->on_eof (undef);	793	$_[0]->on_eof (sub {
664		794	$finish->("");
665	if ($len) {	795	});
666	$_[0]->on_error (sub { $finish->(undef, { Status => 599, Reason => $_[2], URL => $url }) });
667	$_[0]->on_read (sub {	796	$_[0]->on_read (sub {
		797	$arg{on_body}(delete $_[0]{rbuf}, \%hdr)
		798	or $finish->(undef, 598 => "Request cancelled by on_body");
		799	});
		800	}
		801	} else {
		802	$_[0]->on_eof (undef);
		803
		804	if ($len) {
		805	$_[0]->on_error (sub { $finish->(undef, 599 => $_[2]) });
		806	$_[0]->on_read (sub {
668	$finish->((substr delete $_[0]{rbuf}, 0, $len, ""), \%hdr)	807	$finish->((substr delete $_[0]{rbuf}, 0, $len, ""), undef, undef, 1)
669	if $len <= length $_[0]{rbuf};	808	if $len <= length $_[0]{rbuf};
670	});	809	});
671	} else {	810	} else {
672	$_[0]->on_error (sub {	811	$_[0]->on_error (sub {
673	$! == Errno::EPIPE \|\| !$!	812	($! == Errno::EPIPE \|\| !$!)
674	? $finish->(delete $_[0]{rbuf}, \%hdr)	813	? $finish->(delete $_[0]{rbuf})
675	: $finish->(undef, { Status => 599, Reason => $_[2], URL => $url });	814	: $finish->(undef, 599 => $_[2]);
676	});	815	});
677	$_[0]->on_read (sub { });	816	$_[0]->on_read (sub { });
678	}
679	}	817	}
680	}	818	}
681	});	819	}
682	});	820	};
		821
		822	$state{handle}->push_read (line => $qr_nlnl, $state{read_response});
683	};	823	};
684		824
685	# now handle proxy-CONNECT method	825	# now handle proxy-CONNECT method
686	if ($proxy && $uscheme eq "https") {	826	if ($proxy && $uscheme eq "https") {
687	# oh dear, we have to wrap it into a connect request	827	# oh dear, we have to wrap it into a connect request
688		828
689	# maybe re-use $uauthority with patched port?	829	# maybe re-use $uauthority with patched port?
690	$state{handle}->push_write ("CONNECT $uhost:$uport HTTP/1.0\015\012Host: $uhost\015\012\015\012");	830	$state{handle}->push_write ("CONNECT $uhost:$uport HTTP/1.0\015\012Host: $uhost\015\012\015\012");
691	$state{handle}->push_read (line => $qr_nlnl, sub {	831	$state{handle}->push_read (line => $qr_nlnl, sub {
692	$_[1] =~ /^HTTP\/([0-9\.]+) \s+ ([0-9]{3}) (?: \s+ ([^\015\012]*) )?/ix	832	$_[1] =~ /^HTTP\/([0-9\.]+) \s+ ([0-9]{3}) (?: \s+ ([^\015\012]*) )?/ix
693	or return (%state = (), $cb->(undef, { Status => 599, Reason => "Invalid proxy connect response ($_[1])", URL => $url }));	833	or return (%state = (), $cb->(undef, { @pseudo, Status => 599, Reason => "Invalid proxy connect response ($_[1])" }));
694		834
695	if ($2 == 200) {	835	if ($2 == 200) {
696	$rpath = $upath;	836	$rpath = $upath;
697	&$handle_actual_request;	837	&$handle_actual_request;
698	} else {	838	} else {
699	%state = ();	839	%state = ();
700	$cb->(undef, { Status => $2, Reason => $3, URL => $url });	840	$cb->(undef, { @pseudo, Status => $2, Reason => $3 });
701	}	841	}
702	});	842	});
703	} else {	843	} else {
704	&$handle_actual_request;	844	&$handle_actual_request;
705	}	845	}
706
707	}, sub {
708	$timeout
709	};	846	};
		847
		848	my $tcp_connect = $arg{tcp_connect}
		849	\|\| do { require AnyEvent::Socket; \&AnyEvent::Socket::tcp_connect };
		850
		851	$state{connect_guard} = $tcp_connect->($rhost, $rport, $connect_cb, $arg{on_prepare} \|\| sub { $timeout });
		852
710	};	853	};
711		854
712	defined wantarray && AnyEvent::Util::guard { %state = () }	855	defined wantarray && AnyEvent::Util::guard { %state = () }
713	}	856	}
714		857
…		…
728	&http_request	871	&http_request
729	}	872	}
730		873
731	=back	874	=back
732		875
		876	=head2 DNS CACHING
		877
		878	AnyEvent::HTTP uses the AnyEvent::Socket::tcp_connect function for
		879	the actual connection, which in turn uses AnyEvent::DNS to resolve
		880	hostnames. The latter is a simple stub resolver and does no caching
		881	on its own. If you want DNS caching, you currently have to provide
		882	your own default resolver (by storing a suitable resolver object in
		883	C<$AnyEvent::DNS::RESOLVER>).
		884
733	=head2 GLOBAL FUNCTIONS AND VARIABLES	885	=head2 GLOBAL FUNCTIONS AND VARIABLES
734		886
735	=over 4	887	=over 4
736		888
737	=item AnyEvent::HTTP::set_proxy "proxy-url"	889	=item AnyEvent::HTTP::set_proxy "proxy-url"
738		890
739	Sets the default proxy server to use. The proxy-url must begin with a	891	Sets the default proxy server to use. The proxy-url must begin with a
740	string of the form C<http://host:port> (optionally C<https:...>).	892	string of the form C<http://host:port> (optionally C<https:...>), croaks
		893	otherwise.
		894
		895	To clear an already-set proxy, use C<undef>.
		896
		897	=item $date = AnyEvent::HTTP::format_date $timestamp
		898
		899	Takes a POSIX timestamp (seconds since the epoch) and formats it as a HTTP
		900	Date (RFC 2616).
		901
		902	=item $timestamp = AnyEvent::HTTP::parse_date $date
		903
		904	Takes a HTTP Date (RFC 2616) and returns the corresponding POSIX
		905	timestamp, or C<undef> if the date cannot be parsed.
741		906
742	=item $AnyEvent::HTTP::MAX_RECURSE	907	=item $AnyEvent::HTTP::MAX_RECURSE
743		908
744	The default value for the C<recurse> request parameter (default: C<10>).	909	The default value for the C<recurse> request parameter (default: C<10>).
745		910
…		…
765		930
766	=back	931	=back
767		932
768	=cut	933	=cut
769		934
		935	our @month = qw(Jan Feb Mar Apr May Jun Jul Aug Sep Oct Nov Dec);
		936	our @weekday = qw(Sun Mon Tue Wed Thu Fri Sat);
		937
		938	sub format_date($) {
		939	my ($time) = @_;
		940
		941	# RFC 822/1123 format
		942	my ($S, $M, $H, $mday, $mon, $year, $wday, $yday, undef) = gmtime $time;
		943
		944	sprintf "%s, %02d %s %04d %02d:%02d:%02d GMT",
		945	$weekday[$wday], $mday, $month[$mon], $year + 1900,
		946	$H, $M, $S;
		947	}
		948
		949	sub parse_date($) {
		950	my ($date) = @_;
		951
		952	my ($d, $m, $y, $H, $M, $S);
		953
		954	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$/) {
		955	# RFC 822/1123, required by RFC 2616
		956	($d, $m, $y, $H, $M, $S) = ($1, $2, $3, $4, $5, $6);
		957
		958	} 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$/) {
		959	# RFC 850
		960	($d, $m, $y, $H, $M, $S) = ($1, $2, $3 < 69 ? $3 + 2000 : $3 + 1900, $4, $5, $6);
		961
		962	} 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])$/) {
		963	# ISO C's asctime
		964	($d, $m, $y, $H, $M, $S) = ($2, $1, $6, $3, $4, $5);
		965	}
		966	# other formats fail in the loop below
		967
		968	for (0..11) {
		969	if ($m eq $month[$_]) {
		970	require Time::Local;
		971	return Time::Local::timegm ($S, $M, $H, $d, $_, $y);
		972	}
		973	}
		974
		975	undef
		976	}
		977
770	sub set_proxy($) {	978	sub set_proxy($) {
		979	if (length $_[0]) {
771	$PROXY = [$2, $3 \|\| 3128, $1] if $_[0] =~ m%^(https?):// ([^:/]+) (?: : (\d*) )?%ix;	980	$_[0] =~ m%^(https?):// ([^:/]+) (?: : (\d*) )?%ix
		981	or Carp::croak "$_[0]: invalid proxy URL";
		982	$PROXY = [$2, $3 \|\| 3128, $1]
		983	} else {
		984	undef $PROXY;
		985	}
772	}	986	}
773		987
774	# initialise proxy from environment	988	# initialise proxy from environment
		989	eval {
775	set_proxy $ENV{http_proxy};	990	set_proxy $ENV{http_proxy};
		991	};
		992
		993	=head2 SOCKS PROXIES
		994
		995	Socks proxies are not directly supported by AnyEvent::HTTP. You can
		996	compile your perl to support socks, or use an external program such as
		997	F<socksify> (dante) or F<tsocks> to make your program use a socks proxy
		998	transparently.
		999
		1000	Alternatively, for AnyEvent::HTTP only, you can use your own
		1001	C<tcp_connect> function that does the proxy handshake - here is an example
		1002	that works with socks4a proxies:
		1003
		1004	use Errno;
		1005	use AnyEvent::Util;
		1006	use AnyEvent::Socket;
		1007	use AnyEvent::Handle;
		1008
		1009	# host, port and username of/for your socks4a proxy
		1010	my $socks_host = "10.0.0.23";
		1011	my $socks_port = 9050;
		1012	my $socks_user = "";
		1013
		1014	sub socks4a_connect {
		1015	my ($host, $port, $connect_cb, $prepare_cb) = @_;
		1016
		1017	my $hdl = new AnyEvent::Handle
		1018	connect => [$socks_host, $socks_port],
		1019	on_prepare => sub { $prepare_cb->($_[0]{fh}) },
		1020	on_error => sub { $connect_cb->() },
		1021	;
		1022
		1023	$hdl->push_write (pack "CCnNZZ", 4, 1, $port, 1, $socks_user, $host);
		1024
		1025	$hdl->push_read (chunk => 8, sub {
		1026	my ($hdl, $chunk) = @_;
		1027	my ($status, $port, $ipn) = unpack "xCna4", $chunk;
		1028
		1029	if ($status == 0x5a) {
		1030	$connect_cb->($hdl->{fh}, (format_address $ipn) . ":$port");
		1031	} else {
		1032	$! = Errno::ENXIO; $connect_cb->();
		1033	}
		1034	});
		1035
		1036	$hdl
		1037	}
		1038
		1039	Use C<socks4a_connect> instead of C<tcp_connect> when doing C<http_request>s,
		1040	possibly after switching off other proxy types:
		1041
		1042	AnyEvent::HTTP::set_proxy undef; # usually you do not want other proxies
		1043
		1044	http_get 'http://www.google.com', tcp_connect => \&socks4a_connect, sub {
		1045	my ($data, $headers) = @_;
		1046	...
		1047	};
776		1048
777	=head1 SEE ALSO	1049	=head1 SEE ALSO
778		1050
779	L<AnyEvent>.	1051	L<AnyEvent>.
780		1052

Diff Legend

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

Comparing AnyEvent-HTTP/HTTP.pm (file contents): Revision 1.49 by root, Wed Aug 5 16:23:48 2009 UTC vs. Revision 1.68 by root, Fri Dec 31 19:22:18 2010 UTC

Diff Legend

Comparing AnyEvent-HTTP/HTTP.pm (file contents):
Revision 1.49 by root, Wed Aug 5 16:23:48 2009 UTC vs.
Revision 1.68 by root, Fri Dec 31 19:22:18 2010 UTC