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

Comparing AnyEvent-HTTP/HTTP.pm (file contents):
Revision 1.59 by root, Wed Dec 29 23:59:36 2010 UTC vs.
Revision 1.69 by root, Fri Dec 31 19:32:47 2010 UTC

…		…
47	use AnyEvent::Util ();	47	use AnyEvent::Util ();
48	use AnyEvent::Handle ();	48	use AnyEvent::Handle ();
49		49
50	use base Exporter::;	50	use base Exporter::;
51		51
52	our $VERSION = '1.46';	52	our $VERSION = '1.5';
53		53
54	our @EXPORT = qw(http_get http_post http_head http_request);	54	our @EXPORT = qw(http_get http_post http_head http_request);
55		55
56	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)";
57	our $MAX_RECURSE = 10;	57	our $MAX_RECURSE = 10;
…		…
94	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
95	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
96	destroyed before the callback is called, the request will be cancelled.	96	destroyed before the callback is called, the request will be cancelled.
97		97
98	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
99	(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
100	second argument.	100	(and trailers) as second argument.
101		101
102	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
103	headers, the "pseudo-headers" (uppercase to avoid clashing with possible	103	headers, the "pseudo-headers" (uppercase to avoid clashing with possible
104	response headers) C<HTTPVersion>, C<Status> and C<Reason> contain the	104	response headers) C<HTTPVersion>, C<Status> and C<Reason> contain the
105	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>.
106		109
107	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
108	the requested URL when following redirects - for example, you might get	111	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	112	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	113	valid http URL because it redirected to an ftp URL, in which case you can
…		…
147	Whether to recurse requests or not, e.g. on redirects, authentication	150	Whether to recurse requests or not, e.g. on redirects, authentication
148	retries and so on, and how often to do so.	151	retries and so on, and how often to do so.
149		152
150	=item headers => hashref	153	=item headers => hashref
151		154
152	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
153	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
154	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:>
155	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
156	sent at all).	159	they won't be sent at all).
157		160
158	=item timeout => $seconds	161	=item timeout => $seconds
159		162
160	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
161	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
…		…
171	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
172	HTTPS.	175	HTTPS.
173		176
174	=item body => $string	177	=item body => $string
175		178
176	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
177	this module might offer more options).	180	this module might offer more options).
178		181
179	=item cookie_jar => $hash_ref	182	=item cookie_jar => $hash_ref
180		183
181	Passing this parameter enables (simplified) cookie-processing, loosely	184	Passing this parameter enables (simplified) cookie-processing, loosely
…		…
189	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
190	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
191	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
192	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
193	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.
194		201
195	=item tls_ctx => $scheme \| $tls_ctx	202	=item tls_ctx => $scheme \| $tls_ctx
196		203
197	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
198	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
…		…
216	=item tcp_connect => $callback->($host, $service, $connect_cb, $prepare_cb)	223	=item tcp_connect => $callback->($host, $service, $connect_cb, $prepare_cb)
217		224
218	In even rarer cases you want total control over how AnyEvent::HTTP	225	In even rarer cases you want total control over how AnyEvent::HTTP
219	establishes connections. Normally it uses L<AnyEvent::Socket::tcp_connect>	226	establishes connections. Normally it uses L<AnyEvent::Socket::tcp_connect>
220	to do this, but you can provide your own C<tcp_connect> function -	227	to do this, but you can provide your own C<tcp_connect> function -
221	obviously, it has to follow the same calling conventions.	228	obviously, it has to follow the same calling conventions, except that it
		229	may always return a connection guard object.
222		230
223	There are probably lots of weird uses for this function, starting from	231	There are probably lots of weird uses for this function, starting from
224	tracing the hosts C<http_request> actually tries to connect, to (inexact	232	tracing the hosts C<http_request> actually tries to connect, to (inexact
225	but fast) host => IP address caching or even socks protocol support.	233	but fast) host => IP address caching or even socks protocol support.
226		234
…		…
236		244
237	This callback is useful, among other things, to quickly reject unwanted	245	This callback is useful, among other things, to quickly reject unwanted
238	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
239	doing a C<HEAD> request.	247	doing a C<HEAD> request.
240		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
241	Example: cancel the request unless the content-type is "text/html".	253	Example: cancel the request unless the content-type is "text/html".
242		254
243	on_header => sub {	255	on_header => sub {
244	$_[0]{"content-type"} =~ /^text\/html\s*(?:;\|$)/	256	$_[0]{"content-type"} =~ /^text\/html\s*(?:;\|$)/
245	},	257	},
…		…
251	string instead of the body data.	263	string instead of the body data.
252		264
253	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),
254	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
255	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.
256		271
257	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
258	(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
259	be extracted, or when the body should be processed incrementally.	274	be extracted, or when the body should be processed incrementally.
260		275
…		…
286	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
287	that doesn't solve your problem in a better way.	302	that doesn't solve your problem in a better way.
288		303
289	=back	304	=back
290		305
291	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.
292		308
293	http_request GET => "http://www.nethype.de/", sub {	309	http_request GET => "http://www.nethype.de/", sub {
294	my ($body, $hdr) = @_;	310	my ($body, $hdr) = @_;
295	print "$body\n";	311	print "$body\n";
296	};	312	};
297		313
298	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
299	timeout of 30 seconds.	315	timeout of 30 seconds.
300		316
301	http_request	317	http_request
302	GET => "https://www.google.com",	318	GET => "https://www.google.com",
303	timeout => 30,	319	timeout => 30,
…		…
306	use Data::Dumper;	322	use Data::Dumper;
307	print Dumper $hdr;	323	print Dumper $hdr;
308	}	324	}
309	;	325	;
310		326
311	Example: make another simple HTTP GET request, but immediately try to	327	Example: do another simple HTTP GET request, but immediately try to
312	cancel it.	328	cancel it.
313		329
314	my $request = http_request GET => "http://www.nethype.de/", sub {	330	my $request = http_request GET => "http://www.nethype.de/", sub {
315	my ($body, $hdr) = @_;	331	my ($body, $hdr) = @_;
316	print "$body\n";	332	print "$body\n";
…		…
348	push @{ $CO_SLOT{$_[0]}[1] }, $_[1];	364	push @{ $CO_SLOT{$_[0]}[1] }, $_[1];
349		365
350	_slot_schedule $_[0];	366	_slot_schedule $_[0];
351	}	367	}
352		368
		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
353	our $qr_nlnl = qr{(?<![^\012])\015?\012};	394	our $qr_nlnl = qr{(?<![^\012])\015?\012};
354		395
355	our $TLS_CTX_LOW = { cache => 1, sslv2 => 1 };	396	our $TLS_CTX_LOW = { cache => 1, sslv2 => 1 };
356	our $TLS_CTX_HIGH = { cache => 1, verify => 1, verify_peername => "https" };	397	our $TLS_CTX_HIGH = { cache => 1, verify => 1, verify_peername => "https" };
357		398
…		…
376	my @pseudo = (URL => $url);	417	my @pseudo = (URL => $url);
377	push @pseudo, Redirect => delete $arg{Redirect} if exists $arg{Redirect};	418	push @pseudo, Redirect => delete $arg{Redirect} if exists $arg{Redirect};
378		419
379	my $recurse = exists $arg{recurse} ? delete $arg{recurse} : $MAX_RECURSE;	420	my $recurse = exists $arg{recurse} ? delete $arg{recurse} : $MAX_RECURSE;
380		421
381	return $cb->(undef, { Status => 599, Reason => "Too many redirections", @pseudo })	422	return $cb->(undef, { @pseudo, Status => 599, Reason => "Too many redirections" })
382	if $recurse < 0;	423	if $recurse < 0;
383		424
384	my $proxy = $arg{proxy} \|\| $PROXY;	425	my $proxy = $arg{proxy} \|\| $PROXY;
385	my $timeout = $arg{timeout} \|\| $TIMEOUT;	426	my $timeout = $arg{timeout} \|\| $TIMEOUT;
386		427
…		…
389		430
390	$uscheme = lc $uscheme;	431	$uscheme = lc $uscheme;
391		432
392	my $uport = $uscheme eq "http" ? 80	433	my $uport = $uscheme eq "http" ? 80
393	: $uscheme eq "https" ? 443	434	: $uscheme eq "https" ? 443
394	: 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" });
395		436
396	$uauthority =~ /^(?: .*\@ )? ([^\@:]+) (?: : (\d+) )?$/x	437	$uauthority =~ /^(?: .*\@ )? ([^\@:]+) (?: : (\d+) )?$/x
397	or return $cb->(undef, { Status => 599, Reason => "Unparsable URL", @pseudo });	438	or return $cb->(undef, { @pseudo, Status => 599, Reason => "Unparsable URL" });
398		439
399	my $uhost = $1;	440	my $uhost = $1;
400	$uport = $2 if defined $2;	441	$uport = $2 if defined $2;
401		442
402	$hdr{host} = defined $2 ? "$uhost:$2" : "$uhost"	443	$hdr{host} = defined $2 ? "$uhost:$2" : "$uhost"
…		…
451	} else {	492	} else {
452	($rhost, $rport, $rscheme, $rpath) = ($uhost, $uport, $uscheme, $upath);	493	($rhost, $rport, $rscheme, $rpath) = ($uhost, $uport, $uscheme, $upath);
453	}	494	}
454		495
455	# leave out fragment and query string, just a heuristic	496	# leave out fragment and query string, just a heuristic
456	$hdr{referer} \|\|= "$uscheme://$uauthority$upath" unless exists $hdr{referer};	497	$hdr{referer} = "$uscheme://$uauthority$upath" unless exists $hdr{referer};
457	$hdr{"user-agent"} \|\|= $USERAGENT unless exists $hdr{"user-agent"};	498	$hdr{"user-agent"} = $USERAGENT unless exists $hdr{"user-agent"};
458		499
459	$hdr{"content-length"} = length $arg{body}	500	$hdr{"content-length"} = length $arg{body}
460	if length $arg{body} \|\| $method ne "GET";	501	if length $arg{body} \|\| $method ne "GET";
461		502
		503	$hdr{connection} = "close TE"; #1.1
		504	$hdr{te} = "trailers" unless exists $hdr{te}; #1.1
		505
462	my %state = (connect_guard => 1);	506	my %state = (connect_guard => 1);
463		507
464	_get_slot $uhost, sub {	508	_get_slot $uhost, sub {
465	$state{slot_guard} = shift;	509	$state{slot_guard} = shift;
466		510
467	return unless $state{connect_guard};	511	return unless $state{connect_guard};
468		512
469	my $tcp_connect = $arg{tcp_connect}	513	my $connect_cb = sub {
470	\|\| do { require AnyEvent::Socket; \&AnyEvent::Socket::tcp_connect };
471
472	$state{connect_guard} = $tcp_connect->(
473	$rhost,
474	$rport,
475	sub {
476	$state{fh} = shift	514	$state{fh} = shift
477	or do {	515	or do {
478	my $err = "$!";	516	my $err = "$!";
479	%state = ();	517	%state = ();
480	return $cb->(undef, { Status => 599, Reason => $err, @pseudo });	518	return $cb->(undef, { @pseudo, Status => 599, Reason => $err });
481	};	519	};
482		520
483	pop; # free memory, save a tree	521	pop; # free memory, save a tree
484		522
485	return unless delete $state{connect_guard};	523	return unless delete $state{connect_guard};
486		524
487	# get handle	525	# get handle
488	$state{handle} = new AnyEvent::Handle	526	$state{handle} = new AnyEvent::Handle
489	fh => $state{fh},	527	fh => $state{fh},
490	peername => $rhost,	528	peername => $rhost,
491	tls_ctx => $arg{tls_ctx},	529	tls_ctx => $arg{tls_ctx},
492	# these need to be reconfigured on keepalive handles	530	# these need to be reconfigured on keepalive handles
493	timeout => $timeout,	531	timeout => $timeout,
494	on_error => sub {	532	on_error => sub {
495	%state = ();	533	%state = ();
496	$cb->(undef, { Status => 599, Reason => $_[2], @pseudo });	534	$cb->(undef, { @pseudo, Status => 599, Reason => $_[2] });
497	},	535	},
498	on_eof => sub {	536	on_eof => sub {
499	%state = ();	537	%state = ();
500	$cb->(undef, { Status => 599, Reason => "Unexpected end-of-file", @pseudo });	538	$cb->(undef, { @pseudo, Status => 599, Reason => "Unexpected end-of-file" });
501	},	539	},
502	;	540	;
503		541
504	# limit the number of persistent connections	542	# limit the number of persistent connections
505	# keepalive not yet supported	543	# keepalive not yet supported
506	# if ($KA_COUNT{$_[1]} < $MAX_PERSISTENT_PER_HOST) {	544	# if ($KA_COUNT{$_[1]} < $MAX_PERSISTENT_PER_HOST) {
507	# ++$KA_COUNT{$_[1]};	545	# ++$KA_COUNT{$_[1]};
508	# $state{handle}{ka_count_guard} = AnyEvent::Util::guard {	546	# $state{handle}{ka_count_guard} = AnyEvent::Util::guard {
509	# --$KA_COUNT{$_[1]}	547	# --$KA_COUNT{$_[1]}
510	# };	548	# };
511	# $hdr{connection} = "keep-alive";	549	# $hdr{connection} = "keep-alive";
512	# } else {
513	delete $hdr{connection};
514	# }	550	# }
515		551
516	$state{handle}->starttls ("connect") if $rscheme eq "https";	552	$state{handle}->starttls ("connect") if $rscheme eq "https";
517		553
518	# handle actual, non-tunneled, request	554	# handle actual, non-tunneled, request
519	my $handle_actual_request = sub {	555	my $handle_actual_request = sub {
520	$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};
521		557
522	# send request	558	# send request
523	$state{handle}->push_write (	559	$state{handle}->push_write (
524	"$method $rpath HTTP/1.0\015\012"	560	"$method $rpath HTTP/1.1\015\012"
525	. (join "", map "\u$_: $hdr{$_}\015\012", grep defined $hdr{$_}, keys %hdr)	561	. (join "", map "\u$_: $hdr{$_}\015\012", grep defined $hdr{$_}, keys %hdr)
526	. "\015\012"	562	. "\015\012"
527	. (delete $arg{body})	563	. (delete $arg{body})
528	);	564	);
529		565
530	# return if error occured during push_write()	566	# return if error occured during push_write()
531	return unless %state;	567	return unless %state;
532		568
533	%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
534		570
535	# status line and headers	571	# status line and headers
536	$state{handle}->push_read (line => $qr_nlnl, sub {	572	$state{read_response} = sub {
537	for ("$_[1]") {	573	for ("$_[1]") {
538	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.
539		575
540	/^HTTP\/([0-9\.]+) \s+ ([0-9]{3}) (?: \s+ ([^\015\012]*) )? \015?\012/igxc	576	/^HTTP\/([0-9\.]+) \s+ ([0-9]{3}) (?: \s+ ([^\012]*) )? \012/igxc
541	or return (%state = (), $cb->(undef, { Status => 599, Reason => "Invalid server response", @pseudo }));	577	or return (%state = (), $cb->(undef, { @pseudo, Status => 599, Reason => "Invalid server response" }));
542		578
		579	# 100 Continue handling
		580	# should not happen as we don't send expect: 100-continue,
		581	# but we handle it just in case.
		582	# since we send the request body regardless, if we get an error
		583	# we are out of-sync, which we currently do NOT handle correctly.
		584	return $state{handle}->push_read (line => $qr_nlnl, $state{read_response})
		585	if $2 eq 100;
		586
543	push @pseudo,	587	push @pseudo,
544	HTTPVersion => $1,	588	HTTPVersion => $1,
545	Status => $2,	589	Status => $2,
546	Reason => $3,	590	Reason => $3,
547	;	591	;
548		592
549	# things seen, not parsed:	593	my $hdr = parse_hdr
550	# p3pP="NON CUR OTPi OUR NOR UNI"
551
552	$hdr{lc $1} .= ",$2"
553	while /\G
554	([^:\000-\037]*):
555	[\011\040]*
556	((?: [^\012]+ \| \012[\011\040] )*)
557	\012
558	/gxc;
559
560	/\G$/
561	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/\/[^\/]*$//;
562	}	610	}
563		611
564	# remove the "," prefix we added to all headers above
565	substr $_, 0, 1, ""
566	for values %hdr;
567
568	# patch in all pseudo headers
569	%hdr = (%hdr, @pseudo);
570
571	# redirect handling
572	# microsoft and other shitheads don't give a shit for following standards,
573	# try to support some common forms of broken Location headers.
574	if ($hdr{location} !~ /^(?: $ \| [^:\/?\#]+ : )/x) {
575	$hdr{location} =~ s/^\.\/+//;
576
577	my $url = "$rscheme://$uhost:$uport";
578
579	unless ($hdr{location} =~ s/^\///) {
580	$url .= $upath;
581	$url =~ s/\/[^\/]*$//;
582	}
583
584	$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;
585	}	631	}
		632	}
586		633
		634	my $finish = sub { # ($data, $err_status, $err_reason[, $keepalive])
587	my $redirect;	635	my $keepalive = pop;
588		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
589	if ($recurse) {	646	if ($arg{cookie_jar}) {
590	my $status = $hdr{Status};	647	for ($hdr{"set-cookie"}) {
		648	# parse NAME=VALUE
		649	my @kv;
591		650
592	# industry standard is to redirect POST as GET for	651	while (/\G\s* ([^=;,[:space:]]+) \s=\s (?: "((?:[^\\"]+\|\\.))" \| ([^=;,[:space:]]) )/gcxs) {
593	# 301, 302 and 303, in contrast to http/1.0 and 1.1.
594	# also, the UA should ask the user for 301 and 307 and POST,
595	# industry standard seems to be to simply follow.
596	# we go with the industry standard.
597	if ($status == 301 or $status == 302 or $status == 303) {
598	# HTTP/1.1 is unclear on how to mutate the method
599	$method = "GET" unless $method eq "HEAD";
600	$redirect = 1;	652	my $name = $1;
601	} elsif ($status == 307) {	653	my $value = $3;
		654
		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
602	$redirect = 1;	687	# store it
		688	$arg{cookie_jar}{version} = 1;
		689	$arg{cookie_jar}{$cdom}{$cpath}{$name} = \%kv;
		690
		691	redo if /\G\s*,/gc;
603	}	692	}
604	}	693	}
605		694
606	my $finish = sub {
607	$state{handle}->destroy if $state{handle};
608	%state = ();
609
610	# set-cookie processing
611	if ($arg{cookie_jar}) {
612	for ($_[1]{"set-cookie"}) {
613	# parse NAME=VALUE
614	my @kv;
615
616	while (/\G\s* ([^=;,[:space:]]+) \s=\s (?: "((?:[^\\"]+\|\\.))" \| ([^=;,[:space:]]) )/gcxs) {
617	my $name = $1;
618	my $value = $3;
619
620	unless ($value) {
621	$value = $2;
622	$value =~ s/\\(.)/$1/gs;
623	}
624
625	push @kv, $name => $value;
626
627	last unless /\G\s*;/gc;
628	}
629
630	last unless @kv;
631
632	my $name = shift @kv;
633	my %kv = (value => shift @kv, @kv);
634
635	my $cdom;
636	my $cpath = (delete $kv{path}) \|\| "/";
637
638	if (exists $kv{domain}) {
639	$cdom = delete $kv{domain};
640
641	$cdom =~ s/^\.?/./; # make sure it starts with a "."
642
643	next if $cdom =~ /\.$/;
644
645	# this is not rfc-like and not netscape-like. go figure.
646	my $ndots = $cdom =~ y/.//;
647	next if $ndots < ($cdom =~ /\.[^.][^.]\.[^.][^.]$/ ? 3 : 2);
648	} else {
649	$cdom = $uhost;
650	}
651
652	# store it
653	$arg{cookie_jar}{version} = 1;
654	$arg{cookie_jar}{$cdom}{$cpath}{$name} = \%kv;
655
656	redo if /\G\s*,/gc;
657	}
658	}
659
660	if ($redirect && exists $hdr{location}) {	695	if ($redirect && exists $hdr{location}) {
661	# we ignore any errors, as it is very common to receive	696	# we ignore any errors, as it is very common to receive
662	# Content-Length != 0 but no actual body	697	# Content-Length != 0 but no actual body
663	# we also access %hdr, as $_[1] might be an erro	698	# we also access %hdr, as $_[1] might be an erro
664	http_request (	699	http_request (
665	$method => $hdr{location},	700	$method => $hdr{location},
666	%arg,	701	%arg,
667	recurse => $recurse - 1,	702	recurse => $recurse - 1,
668	Redirect => \@_,	703	Redirect => [$_[0], \%hdr],
669	$cb);	704	$cb);
670	} else {
671	$cb->($_[0], $_[1]);
672	}
673	};
674
675	my $len = $hdr{"content-length"};
676
677	if (!$redirect && $arg{on_header} && !$arg{on_header}(\%hdr)) {
678	$finish->(undef, { Status => 598, Reason => "Request cancelled by on_header", @pseudo });
679	} elsif (
680	$hdr{Status} =~ /^(?:1..\|[23]04)$/
681	or $method eq "HEAD"
682	or (defined $len && !$len)
683	) {
684	# no body
685	$finish->("", \%hdr);
686	} 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 {
687	# body handling, four different code paths	722	# body handling, many different code paths
688	# for want_body_handle, on_body (2x), normal (2x)	723	# - no body expected
689	# 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)
690	if (!$redirect && $arg{want_body_handle}) {	728	if (!$redirect && $arg{want_body_handle}) {
691	$_[0]->on_eof (undef);	729	$_[0]->on_eof (undef);
692	$_[0]->on_error (undef);	730	$_[0]->on_error (undef);
693	$_[0]->on_read (undef);	731	$_[0]->on_read (undef);
694		732
695	$finish->(delete $state{handle}, \%hdr);	733	$finish->(delete $state{handle});
696		734
697	} 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
698	$_[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
699	if ($len) {	748	if ($len) {
700	$_[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
701	$_[0]->on_read (sub {	755	$_[0]->push_read (line => sub {
702	$len -= length $_[0]{rbuf};	756	length $_[1]
703		757	and return $finish->(undef, 599 => "Garbled chunked transfer encoding");
704	$arg{on_body}(delete $_[0]{rbuf}, \%hdr)	758	$_[0]->push_read (line => $read_chunk);
705	or $finish->(undef, { Status => 598, Reason => "Request cancelled by on_body", @pseudo });
706
707	$len > 0	759	});
708	or $finish->("", \%hdr);
709	});	760	});
710	} else {	761	} else {
711	$_[0]->on_eof (sub {	762	$hdr{"content-length"} \|\|= $cl;
712	$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	}
713	});	774	}
714	$_[0]->on_read (sub {	775
715	$arg{on_body}(delete $_[0]{rbuf}, \%hdr)	776	$finish->($body, undef, undef, 1);
716	or $finish->(undef, { Status => 598, Reason => "Request cancelled by on_body", @pseudo });
717	});	777	});
718	}	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	});
719	} else {	796	} else {
720	$_[0]->on_eof (undef);	797	$_[0]->on_eof (sub {
721		798	$finish->("");
722	if ($len) {	799	});
723	$_[0]->on_error (sub { $finish->(undef, { Status => 599, Reason => $_[2], @pseudo }) });
724	$_[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 {
725	$finish->((substr delete $_[0]{rbuf}, 0, $len, ""), \%hdr)	811	$finish->((substr delete $_[0]{rbuf}, 0, $len, ""), undef, undef, 1)
726	if $len <= length $_[0]{rbuf};	812	if $len <= length $_[0]{rbuf};
727	});	813	});
728	} else {	814	} else {
729	$_[0]->on_error (sub {	815	$_[0]->on_error (sub {
730	($! == Errno::EPIPE \|\| !$!)	816	($! == Errno::EPIPE \|\| !$!)
731	? $finish->(delete $_[0]{rbuf}, \%hdr)	817	? $finish->(delete $_[0]{rbuf})
732	: $finish->(undef, { Status => 599, Reason => $_[2], @pseudo });	818	: $finish->(undef, 599 => $_[2]);
733	});	819	});
734	$_[0]->on_read (sub { });	820	$_[0]->on_read (sub { });
735	}
736	}	821	}
737	}	822	}
738	});	823	}
739	};	824	};
740		825
		826	$state{handle}->push_read (line => $qr_nlnl, $state{read_response});
		827	};
		828
741	# now handle proxy-CONNECT method	829	# now handle proxy-CONNECT method
742	if ($proxy && $uscheme eq "https") {	830	if ($proxy && $uscheme eq "https") {
743	# oh dear, we have to wrap it into a connect request	831	# oh dear, we have to wrap it into a connect request
744		832
745	# maybe re-use $uauthority with patched port?	833	# maybe re-use $uauthority with patched port?
746	$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");
747	$state{handle}->push_read (line => $qr_nlnl, sub {	835	$state{handle}->push_read (line => $qr_nlnl, sub {
748	$_[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
749	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])" }));
750		838
751	if ($2 == 200) {	839	if ($2 == 200) {
752	$rpath = $upath;	840	$rpath = $upath;
753	&$handle_actual_request;	841	&$handle_actual_request;
754	} else {	842	} else {
755	%state = ();	843	%state = ();
756	$cb->(undef, { Status => $2, Reason => $3, @pseudo });	844	$cb->(undef, { @pseudo, Status => $2, Reason => $3 });
757	}
758	});	845	}
		846	});
759	} else {	847	} else {
760	&$handle_actual_request;	848	&$handle_actual_request;
761	}
762
763	},	849	}
764	$arg{on_prepare} \|\| sub { $timeout }
765	);	850	};
		851
		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
766	};	857	};
767		858
768	defined wantarray && AnyEvent::Util::guard { %state = () }	859	defined wantarray && AnyEvent::Util::guard { %state = () }
769	}	860	}
770		861
…		…
805	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
806	otherwise.	897	otherwise.
807		898
808	To clear an already-set proxy, use C<undef>.	899	To clear an already-set proxy, use C<undef>.
809		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
810	=item $AnyEvent::HTTP::MAX_RECURSE	911	=item $AnyEvent::HTTP::MAX_RECURSE
811		912
812	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>).
813		914
814	=item $AnyEvent::HTTP::USERAGENT	915	=item $AnyEvent::HTTP::USERAGENT
…		…
832	connections. This number of can be useful for load-leveling.	933	connections. This number of can be useful for load-leveling.
833		934
834	=back	935	=back
835		936
836	=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	}
837		981
838	sub set_proxy($) {	982	sub set_proxy($) {
839	if (length $_[0]) {	983	if (length $_[0]) {
840	$_[0] =~ m%^(https?):// ([^:/]+) (?: : (\d*) )?%ix	984	$_[0] =~ m%^(https?):// ([^:/]+) (?: : (\d*) )?%ix
841	or Carp::croak "$_[0]: invalid proxy URL";	985	or Carp::croak "$_[0]: invalid proxy URL";
…		…
848	# initialise proxy from environment	992	# initialise proxy from environment
849	eval {	993	eval {
850	set_proxy $ENV{http_proxy};	994	set_proxy $ENV{http_proxy};
851	};	995	};
852		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
853	=head1 SEE ALSO	1053	=head1 SEE ALSO
854		1054
855	L<AnyEvent>.	1055	L<AnyEvent>.
856		1056
857	=head1 AUTHOR	1057	=head1 AUTHOR

Diff Legend

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

Comparing AnyEvent-HTTP/HTTP.pm (file contents): Revision 1.59 by root, Wed Dec 29 23:59:36 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.59 by root, Wed Dec 29 23:59:36 2010 UTC vs.
Revision 1.69 by root, Fri Dec 31 19:32:47 2010 UTC