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

Comparing AnyEvent-HTTP/HTTP.pm (file contents):
Revision 1.56 by root, Mon Sep 6 05:30:54 2010 UTC vs.
Revision 1.69 by root, Fri Dec 31 19:32:47 2010 UTC

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

Diff Legend

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

Comparing AnyEvent-HTTP/HTTP.pm (file contents): Revision 1.56 by root, Mon Sep 6 05:30:54 2010 UTC vs. Revision 1.69 by root, Fri Dec 31 19:32:47 2010 UTC

Diff Legend

Comparing AnyEvent-HTTP/HTTP.pm (file contents):
Revision 1.56 by root, Mon Sep 6 05:30:54 2010 UTC vs.
Revision 1.69 by root, Fri Dec 31 19:32:47 2010 UTC