[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.70 by root, Fri Dec 31 20:31: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
182	based on the original netscape specification.	185	based on the original netscape specification.
183		186
184	The C<$hash_ref> must be an (initially empty) hash reference which will	187	The C<$hash_ref> must be an (initially empty) hash reference which will
185	get updated automatically. It is possible to save the cookie_jar to	188	get updated automatically. It is possible to save the cookie jar to
186	persistent storage with something like JSON or Storable, but this is not	189	persistent storage with something like JSON or Storable, but this is not
187	recommended, as expiry times are currently being ignored.	190	recommended, as session-only cookies might survive longer than expected.
188		191
189	Note that this cookie implementation is not of very high quality, nor	192	Note that this cookie implementation is not meant to be complete. If
190	meant to be complete. If you want complete cookie management you have to	193	you want complete cookie management you have to do that on your
191	do that on your own. C<cookie_jar> is meant as a quick fix to get some	194	own. C<cookie_jar> is meant as a quick fix to get some cookie-using sites
192	cookie-using sites working. Cookies are a privacy disaster, do not use	195	working. Cookies are a privacy disaster, do not use them unless required
193	them unless required to.	196	to.
		197
		198	When cookie processing is enabled, the C<Cookie:> and C<Set-Cookie:>
		199	headers will be set 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"
…		…
411	if (my $jar = $arg{cookie_jar}) {	452	if (my $jar = $arg{cookie_jar}) {
412	%$jar = () if $jar->{version} != 1;	453	%$jar = () if $jar->{version} != 1;
413		454
414	my @cookie;	455	my @cookie;
415		456
416	while (my ($chost, $v) = each %$jar) {	457	while (my ($chost, $paths) = each %$jar) {
417	if ($chost =~ /^\./) {	458	if ($chost =~ /^\./) {
418	next unless $chost eq substr $uhost, -length $chost;	459	next unless $chost eq substr $uhost, -length $chost;
419	} elsif ($chost =~ /\./) {	460	} elsif ($chost =~ /\./) {
420	next unless $chost eq $uhost;	461	next unless $chost eq $uhost;
421	} else {	462	} else {
422	next;	463	next;
423	}	464	}
424		465
425	while (my ($cpath, $v) = each %$v) {	466	while (my ($cpath, $cookies) = each %$paths) {
426	next unless $cpath eq substr $upath, 0, length $cpath;	467	next unless $cpath eq substr $upath, 0, length $cpath;
427		468
428	while (my ($k, $v) = each %$v) {	469	while (my ($cookie, $kv) = each %$cookies) {
429	next if $uscheme ne "https" && exists $v->{secure};	470	next if $uscheme ne "https" && exists $kv->{secure};
		471
		472	if (exists $kv->{expires}) {
		473	if (AE::now > parse_date ($kv->{expires})) {
		474	delete $cookies->{$cookie};
		475	next;
		476	}
		477	}
		478
430	my $value = $v->{value};	479	my $value = $kv->{value};
431	$value =~ s/([\\"])/\\$1/g;	480	$value =~ s/([\\"])/\\$1/g;
432	push @cookie, "$k=\"$value\"";	481	push @cookie, "$cookie=\"$value\"";
433	}	482	}
434	}	483	}
435	}	484	}
436		485
437	$hdr{cookie} = join "; ", @cookie	486	$hdr{cookie} = join "; ", @cookie
…		…
451	} else {	500	} else {
452	($rhost, $rport, $rscheme, $rpath) = ($uhost, $uport, $uscheme, $upath);	501	($rhost, $rport, $rscheme, $rpath) = ($uhost, $uport, $uscheme, $upath);
453	}	502	}
454		503
455	# leave out fragment and query string, just a heuristic	504	# leave out fragment and query string, just a heuristic
456	$hdr{referer} \|\|= "$uscheme://$uauthority$upath" unless exists $hdr{referer};	505	$hdr{referer} = "$uscheme://$uauthority$upath" unless exists $hdr{referer};
457	$hdr{"user-agent"} \|\|= $USERAGENT unless exists $hdr{"user-agent"};	506	$hdr{"user-agent"} = $USERAGENT unless exists $hdr{"user-agent"};
458		507
459	$hdr{"content-length"} = length $arg{body}	508	$hdr{"content-length"} = length $arg{body}
460	if length $arg{body} \|\| $method ne "GET";	509	if length $arg{body} \|\| $method ne "GET";
461		510
		511	$hdr{connection} = "close TE"; #1.1
		512	$hdr{te} = "trailers" unless exists $hdr{te}; #1.1
		513
462	my %state = (connect_guard => 1);	514	my %state = (connect_guard => 1);
463		515
464	_get_slot $uhost, sub {	516	_get_slot $uhost, sub {
465	$state{slot_guard} = shift;	517	$state{slot_guard} = shift;
466		518
467	return unless $state{connect_guard};	519	return unless $state{connect_guard};
468		520
469	my $tcp_connect = $arg{tcp_connect}	521	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	522	$state{fh} = shift
477	or do {	523	or do {
478	my $err = "$!";	524	my $err = "$!";
479	%state = ();	525	%state = ();
480	return $cb->(undef, { Status => 599, Reason => $err, @pseudo });	526	return $cb->(undef, { @pseudo, Status => 599, Reason => $err });
481	};	527	};
482		528
483	pop; # free memory, save a tree	529	pop; # free memory, save a tree
484		530
485	return unless delete $state{connect_guard};	531	return unless delete $state{connect_guard};
486		532
487	# get handle	533	# get handle
488	$state{handle} = new AnyEvent::Handle	534	$state{handle} = new AnyEvent::Handle
489	fh => $state{fh},	535	fh => $state{fh},
490	peername => $rhost,	536	peername => $rhost,
491	tls_ctx => $arg{tls_ctx},	537	tls_ctx => $arg{tls_ctx},
492	# these need to be reconfigured on keepalive handles	538	# these need to be reconfigured on keepalive handles
493	timeout => $timeout,	539	timeout => $timeout,
494	on_error => sub {	540	on_error => sub {
495	%state = ();	541	%state = ();
496	$cb->(undef, { Status => 599, Reason => $_[2], @pseudo });	542	$cb->(undef, { @pseudo, Status => 599, Reason => $_[2] });
497	},	543	},
498	on_eof => sub {	544	on_eof => sub {
499	%state = ();	545	%state = ();
500	$cb->(undef, { Status => 599, Reason => "Unexpected end-of-file", @pseudo });	546	$cb->(undef, { @pseudo, Status => 599, Reason => "Unexpected end-of-file" });
501	},	547	},
502	;	548	;
503		549
504	# limit the number of persistent connections	550	# limit the number of persistent connections
505	# keepalive not yet supported	551	# keepalive not yet supported
506	# if ($KA_COUNT{$_[1]} < $MAX_PERSISTENT_PER_HOST) {	552	# if ($KA_COUNT{$_[1]} < $MAX_PERSISTENT_PER_HOST) {
507	# ++$KA_COUNT{$_[1]};	553	# ++$KA_COUNT{$_[1]};
508	# $state{handle}{ka_count_guard} = AnyEvent::Util::guard {	554	# $state{handle}{ka_count_guard} = AnyEvent::Util::guard {
509	# --$KA_COUNT{$_[1]}	555	# --$KA_COUNT{$_[1]}
510	# };	556	# };
511	# $hdr{connection} = "keep-alive";	557	# $hdr{connection} = "keep-alive";
512	# } else {
513	delete $hdr{connection};
514	# }	558	# }
515		559
516	$state{handle}->starttls ("connect") if $rscheme eq "https";	560	$state{handle}->starttls ("connect") if $rscheme eq "https";
517		561
518	# handle actual, non-tunneled, request	562	# handle actual, non-tunneled, request
519	my $handle_actual_request = sub {	563	my $handle_actual_request = sub {
520	$state{handle}->starttls ("connect") if $uscheme eq "https" && !exists $state{handle}{tls};	564	$state{handle}->starttls ("connect") if $uscheme eq "https" && !exists $state{handle}{tls};
521		565
522	# send request	566	# send request
523	$state{handle}->push_write (	567	$state{handle}->push_write (
524	"$method $rpath HTTP/1.0\015\012"	568	"$method $rpath HTTP/1.1\015\012"
525	. (join "", map "\u$_: $hdr{$_}\015\012", grep defined $hdr{$_}, keys %hdr)	569	. (join "", map "\u$_: $hdr{$_}\015\012", grep defined $hdr{$_}, keys %hdr)
526	. "\015\012"	570	. "\015\012"
527	. (delete $arg{body})	571	. (delete $arg{body})
528	);	572	);
529		573
530	# return if error occured during push_write()	574	# return if error occured during push_write()
531	return unless %state;	575	return unless %state;
532		576
533	%hdr = (); # reduce memory usage, save a kitten, also make it possible to re-use	577	%hdr = (); # reduce memory usage, save a kitten, also make it possible to re-use
534		578
535	# status line and headers	579	# status line and headers
536	$state{handle}->push_read (line => $qr_nlnl, sub {	580	$state{read_response} = sub {
537	for ("$_[1]") {	581	for ("$_[1]") {
538	y/\015//d; # weed out any \015, as they show up in the weirdest of places.	582	y/\015//d; # weed out any \015, as they show up in the weirdest of places.
539		583
540	/^HTTP\/([0-9\.]+) \s+ ([0-9]{3}) (?: \s+ ([^\015\012]*) )? \015?\012/igxc	584	/^HTTP\/([0-9\.]+) \s+ ([0-9]{3}) (?: \s+ ([^\012]*) )? \012/igxc
541	or return (%state = (), $cb->(undef, { Status => 599, Reason => "Invalid server response", @pseudo }));	585	or return (%state = (), $cb->(undef, { @pseudo, Status => 599, Reason => "Invalid server response" }));
542		586
		587	# 100 Continue handling
		588	# should not happen as we don't send expect: 100-continue,
		589	# but we handle it just in case.
		590	# since we send the request body regardless, if we get an error
		591	# we are out of-sync, which we currently do NOT handle correctly.
		592	return $state{handle}->push_read (line => $qr_nlnl, $state{read_response})
		593	if $2 eq 100;
		594
543	push @pseudo,	595	push @pseudo,
544	HTTPVersion => $1,	596	HTTPVersion => $1,
545	Status => $2,	597	Status => $2,
546	Reason => $3,	598	Reason => $3,
547	;	599	;
548		600
549	# things seen, not parsed:	601	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 }));	602	or return (%state = (), $cb->(undef, { @pseudo, Status => 599, Reason => "Garbled response headers" }));
		603
		604	%hdr = (%$hdr, @pseudo);
		605	}
		606
		607	# redirect handling
		608	# microsoft and other shitheads don't give a shit for following standards,
		609	# try to support some common forms of broken Location headers.
		610	if ($hdr{location} !~ /^(?: $ \| [^:\/?\#]+ : )/x) {
		611	$hdr{location} =~ s/^\.\/+//;
		612
		613	my $url = "$rscheme://$uhost:$uport";
		614
		615	unless ($hdr{location} =~ s/^\///) {
		616	$url .= $upath;
		617	$url =~ s/\/[^\/]*$//;
562	}	618	}
563		619
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}";	620	$hdr{location} = "$url/$hdr{location}";
		621	}
		622
		623	my $redirect;
		624
		625	if ($recurse) {
		626	my $status = $hdr{Status};
		627
		628	# industry standard is to redirect POST as GET for
		629	# 301, 302 and 303, in contrast to http/1.0 and 1.1.
		630	# also, the UA should ask the user for 301 and 307 and POST,
		631	# industry standard seems to be to simply follow.
		632	# we go with the industry standard.
		633	if ($status == 301 or $status == 302 or $status == 303) {
		634	# HTTP/1.1 is unclear on how to mutate the method
		635	$method = "GET" unless $method eq "HEAD";
		636	$redirect = 1;
		637	} elsif ($status == 307) {
		638	$redirect = 1;
585	}	639	}
		640	}
586		641
		642	my $finish = sub { # ($data, $err_status, $err_reason[, $keepalive])
587	my $redirect;	643	my $keepalive = pop;
588		644
		645	$state{handle}->destroy if $state{handle};
		646	%state = ();
		647
		648	if (defined $_[1]) {
		649	$hdr{OrigStatus} = $hdr{Status}; $hdr{Status} = $_[1];
		650	$hdr{OrigReason} = $hdr{Reason}; $hdr{Reason} = $_[2];
		651	}
		652
		653	# set-cookie processing
589	if ($recurse) {	654	if ($arg{cookie_jar}) {
590	my $status = $hdr{Status};	655	for ($hdr{"set-cookie"}) {
		656	# parse NAME=VALUE
		657	my @kv;
591		658
592	# industry standard is to redirect POST as GET for	659	while (
593	# 301, 302 and 303, in contrast to http/1.0 and 1.1.	660	m{
594	# also, the UA should ask the user for 301 and 307 and POST,	661	\G\s*
595	# industry standard seems to be to simply follow.	662	(?:
596	# we go with the industry standard.	663	expires \s=\s ([A-Z][a-z][a-z],\ [^,;]+)
597	if ($status == 301 or $status == 302 or $status == 303) {	664	\| ([^=;,[:space:]]+) \s=\s (?: "((?:[^\\"]+\|\\.))" \| ([^=;,[:space:]]) )
598	# HTTP/1.1 is unclear on how to mutate the method	665	)
599	$method = "GET" unless $method eq "HEAD";	666	}gcxsi
		667	) {
		668	my $name = $2;
		669	my $value = $4;
		670
		671	unless (defined $name) {
		672	# expires
		673	$name = "expires";
		674	$value = $1;
		675	} elsif (!defined $value) {
		676	# quoted
		677	$value = $3;
		678	$value =~ s/\\(.)/$1/gs;
		679	}
		680
		681	push @kv, lc $name, $value;
		682
		683	last unless /\G\s*;/gc;
		684	}
		685
		686	last unless @kv;
		687
		688	my $name = shift @kv;
		689	my %kv = (value => shift @kv, @kv);
		690
		691	$kv{expires} \|\|= format_date (AE::now + $kv{"max-age"})
		692	if exists $kv{"max-age"};
		693
		694	my $cdom;
		695	my $cpath = (delete $kv{path}) \|\| "/";
		696
		697	if (exists $kv{domain}) {
		698	$cdom = delete $kv{domain};
		699
		700	$cdom =~ s/^\.?/./; # make sure it starts with a "."
		701
		702	next if $cdom =~ /\.$/;
		703
		704	# this is not rfc-like and not netscape-like. go figure.
		705	my $ndots = $cdom =~ y/.//;
		706	next if $ndots < ($cdom =~ /\.[^.][^.]\.[^.][^.]$/ ? 3 : 2);
		707	} else {
		708	$cdom = $uhost;
		709	}
		710
600	$redirect = 1;	711	# store it
601	} elsif ($status == 307) {	712	$arg{cookie_jar}{version} = 1;
602	$redirect = 1;	713	$arg{cookie_jar}{$cdom}{$cpath}{$name} = \%kv;
		714
		715	redo if /\G\s*,/gc;
603	}	716	}
604	}	717	}
605		718
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}) {	719	if ($redirect && exists $hdr{location}) {
661	# we ignore any errors, as it is very common to receive	720	# we ignore any errors, as it is very common to receive
662	# Content-Length != 0 but no actual body	721	# Content-Length != 0 but no actual body
663	# we also access %hdr, as $_[1] might be an erro	722	# we also access %hdr, as $_[1] might be an erro
664	http_request (	723	http_request (
665	$method => $hdr{location},	724	$method => $hdr{location},
666	%arg,	725	%arg,
667	recurse => $recurse - 1,	726	recurse => $recurse - 1,
668	Redirect => \@_,	727	Redirect => [$_[0], \%hdr],
669	$cb);	728	$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 {	729	} else {
		730	$cb->($_[0], \%hdr);
		731	}
		732	};
		733
		734	my $len = $hdr{"content-length"};
		735
		736	if (!$redirect && $arg{on_header} && !$arg{on_header}(\%hdr)) {
		737	$finish->(undef, 598 => "Request cancelled by on_header");
		738	} elsif (
		739	$hdr{Status} =~ /^(?:1..\|204\|205\|304)$/
		740	or $method eq "HEAD"
		741	or (defined $len && !$len)
		742	) {
		743	# no body
		744	$finish->("", undef, undef, 1);
		745	} else {
687	# body handling, four different code paths	746	# body handling, many different code paths
688	# for want_body_handle, on_body (2x), normal (2x)	747	# - no body expected
689	# we might read too much here, but it does not matter yet (no pers. connections)	748	# - want_body_handle
		749	# - te chunked
		750	# - 2x length known (with or without on_body)
		751	# - 2x length not known (with or without on_body)
690	if (!$redirect && $arg{want_body_handle}) {	752	if (!$redirect && $arg{want_body_handle}) {
691	$_[0]->on_eof (undef);	753	$_[0]->on_eof (undef);
692	$_[0]->on_error (undef);	754	$_[0]->on_error (undef);
693	$_[0]->on_read (undef);	755	$_[0]->on_read (undef);
694		756
695	$finish->(delete $state{handle}, \%hdr);	757	$finish->(delete $state{handle});
696		758
697	} elsif ($arg{on_body}) {	759	} elsif ($hdr{"transfer-encoding"} =~ /\bchunked\b/i) {
		760	my $cl = 0;
		761	my $body = undef;
		762	my $on_body = $arg{on_body} \|\| sub { $body .= shift; 1 };
		763
698	$_[0]->on_error (sub { $finish->(undef, { Status => 599, Reason => $_[2], @pseudo }) });	764	$_[0]->on_error (sub { $finish->(undef, 599 => $_[2]) });
		765
		766	my $read_chunk; $read_chunk = sub {
		767	$_[1] =~ /^([0-9a-fA-F]+)/
		768	or $finish->(undef, 599 => "Garbled chunked transfer encoding");
		769
		770	my $len = hex $1;
		771
699	if ($len) {	772	if ($len) {
700	$_[0]->on_eof (undef);	773	$cl += $len;
		774
		775	$_[0]->push_read (chunk => $len, sub {
		776	$on_body->($_[1], \%hdr)
		777	or return $finish->(undef, 598 => "Request cancelled by on_body");
		778
701	$_[0]->on_read (sub {	779	$_[0]->push_read (line => sub {
702	$len -= length $_[0]{rbuf};	780	length $_[1]
703		781	and return $finish->(undef, 599 => "Garbled chunked transfer encoding");
704	$arg{on_body}(delete $_[0]{rbuf}, \%hdr)	782	$_[0]->push_read (line => $read_chunk);
705	or $finish->(undef, { Status => 598, Reason => "Request cancelled by on_body", @pseudo });
706
707	$len > 0	783	});
708	or $finish->("", \%hdr);
709	});	784	});
710	} else {	785	} else {
711	$_[0]->on_eof (sub {	786	$hdr{"content-length"} \|\|= $cl;
712	$finish->("", \%hdr);	787
		788	$_[0]->push_read (line => $qr_nlnl, sub {
		789	if (length $_[1]) {
		790	for ("$_[1]") {
		791	y/\015//d; # weed out any \015, as they show up in the weirdest of places.
		792
		793	my $hdr = parse_hdr
		794	or return $finish->(undef, 599 => "Garbled response trailers");
		795
		796	%hdr = (%hdr, %$hdr);
		797	}
713	});	798	}
714	$_[0]->on_read (sub {	799
715	$arg{on_body}(delete $_[0]{rbuf}, \%hdr)	800	$finish->($body, undef, undef, 1);
716	or $finish->(undef, { Status => 598, Reason => "Request cancelled by on_body", @pseudo });
717	});	801	});
718	}	802	}
		803	};
		804
		805	$_[0]->push_read (line => $read_chunk);
		806
		807	} elsif ($arg{on_body}) {
		808	$_[0]->on_error (sub { $finish->(undef, 599 => $_[2]) });
		809
		810	if ($len) {
		811	$_[0]->on_read (sub {
		812	$len -= length $_[0]{rbuf};
		813
		814	$arg{on_body}(delete $_[0]{rbuf}, \%hdr)
		815	or return $finish->(undef, 598 => "Request cancelled by on_body");
		816
		817	$len > 0
		818	or $finish->("", undef, undef, 1);
		819	});
719	} else {	820	} else {
720	$_[0]->on_eof (undef);	821	$_[0]->on_eof (sub {
721		822	$finish->("");
722	if ($len) {	823	});
723	$_[0]->on_error (sub { $finish->(undef, { Status => 599, Reason => $_[2], @pseudo }) });
724	$_[0]->on_read (sub {	824	$_[0]->on_read (sub {
		825	$arg{on_body}(delete $_[0]{rbuf}, \%hdr)
		826	or $finish->(undef, 598 => "Request cancelled by on_body");
		827	});
		828	}
		829	} else {
		830	$_[0]->on_eof (undef);
		831
		832	if ($len) {
		833	$_[0]->on_error (sub { $finish->(undef, 599 => $_[2]) });
		834	$_[0]->on_read (sub {
725	$finish->((substr delete $_[0]{rbuf}, 0, $len, ""), \%hdr)	835	$finish->((substr delete $_[0]{rbuf}, 0, $len, ""), undef, undef, 1)
726	if $len <= length $_[0]{rbuf};	836	if $len <= length $_[0]{rbuf};
727	});	837	});
728	} else {	838	} else {
729	$_[0]->on_error (sub {	839	$_[0]->on_error (sub {
730	($! == Errno::EPIPE \|\| !$!)	840	($! == Errno::EPIPE \|\| !$!)
731	? $finish->(delete $_[0]{rbuf}, \%hdr)	841	? $finish->(delete $_[0]{rbuf})
732	: $finish->(undef, { Status => 599, Reason => $_[2], @pseudo });	842	: $finish->(undef, 599 => $_[2]);
733	});	843	});
734	$_[0]->on_read (sub { });	844	$_[0]->on_read (sub { });
735	}
736	}	845	}
737	}	846	}
738	});	847	}
739	};	848	};
740		849
		850	$state{handle}->push_read (line => $qr_nlnl, $state{read_response});
		851	};
		852
741	# now handle proxy-CONNECT method	853	# now handle proxy-CONNECT method
742	if ($proxy && $uscheme eq "https") {	854	if ($proxy && $uscheme eq "https") {
743	# oh dear, we have to wrap it into a connect request	855	# oh dear, we have to wrap it into a connect request
744		856
745	# maybe re-use $uauthority with patched port?	857	# 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");	858	$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 {	859	$state{handle}->push_read (line => $qr_nlnl, sub {
748	$_[1] =~ /^HTTP\/([0-9\.]+) \s+ ([0-9]{3}) (?: \s+ ([^\015\012]*) )?/ix	860	$_[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 }));	861	or return (%state = (), $cb->(undef, { @pseudo, Status => 599, Reason => "Invalid proxy connect response ($_[1])" }));
750		862
751	if ($2 == 200) {	863	if ($2 == 200) {
752	$rpath = $upath;	864	$rpath = $upath;
753	&$handle_actual_request;	865	&$handle_actual_request;
754	} else {	866	} else {
755	%state = ();	867	%state = ();
756	$cb->(undef, { Status => $2, Reason => $3, @pseudo });	868	$cb->(undef, { @pseudo, Status => $2, Reason => $3 });
757	}
758	});	869	}
		870	});
759	} else {	871	} else {
760	&$handle_actual_request;	872	&$handle_actual_request;
761	}
762
763	},	873	}
764	$arg{on_prepare} \|\| sub { $timeout }
765	);	874	};
		875
		876	my $tcp_connect = $arg{tcp_connect}
		877	\|\| do { require AnyEvent::Socket; \&AnyEvent::Socket::tcp_connect };
		878
		879	$state{connect_guard} = $tcp_connect->($rhost, $rport, $connect_cb, $arg{on_prepare} \|\| sub { $timeout });
		880
766	};	881	};
767		882
768	defined wantarray && AnyEvent::Util::guard { %state = () }	883	defined wantarray && AnyEvent::Util::guard { %state = () }
769	}	884	}
770		885
…		…
805	string of the form C<http://host:port> (optionally C<https:...>), croaks	920	string of the form C<http://host:port> (optionally C<https:...>), croaks
806	otherwise.	921	otherwise.
807		922
808	To clear an already-set proxy, use C<undef>.	923	To clear an already-set proxy, use C<undef>.
809		924
		925	=item $date = AnyEvent::HTTP::format_date $timestamp
		926
		927	Takes a POSIX timestamp (seconds since the epoch) and formats it as a HTTP
		928	Date (RFC 2616).
		929
		930	=item $timestamp = AnyEvent::HTTP::parse_date $date
		931
		932	Takes a HTTP Date (RFC 2616) or a Cookie date (netscape cookie spec) and
		933	returns the corresponding POSIX timestamp, or C<undef> if the date cannot
		934	be parsed.
		935
810	=item $AnyEvent::HTTP::MAX_RECURSE	936	=item $AnyEvent::HTTP::MAX_RECURSE
811		937
812	The default value for the C<recurse> request parameter (default: C<10>).	938	The default value for the C<recurse> request parameter (default: C<10>).
813		939
814	=item $AnyEvent::HTTP::USERAGENT	940	=item $AnyEvent::HTTP::USERAGENT
…		…
832	connections. This number of can be useful for load-leveling.	958	connections. This number of can be useful for load-leveling.
833		959
834	=back	960	=back
835		961
836	=cut	962	=cut
		963
		964	our @month = qw(Jan Feb Mar Apr May Jun Jul Aug Sep Oct Nov Dec);
		965	our @weekday = qw(Sun Mon Tue Wed Thu Fri Sat);
		966
		967	sub format_date($) {
		968	my ($time) = @_;
		969
		970	# RFC 822/1123 format
		971	my ($S, $M, $H, $mday, $mon, $year, $wday, $yday, undef) = gmtime $time;
		972
		973	sprintf "%s, %02d %s %04d %02d:%02d:%02d GMT",
		974	$weekday[$wday], $mday, $month[$mon], $year + 1900,
		975	$H, $M, $S;
		976	}
		977
		978	sub parse_date($) {
		979	my ($date) = @_;
		980
		981	my ($d, $m, $y, $H, $M, $S);
		982
		983	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$/) {
		984	# RFC 822/1123, required by RFC 2616 (with " ")
		985	# cookie dates (with "-")
		986
		987	($d, $m, $y, $H, $M, $S) = ($1, $2, $3, $4, $5, $6);
		988
		989	} 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$/) {
		990	# RFC 850
		991	($d, $m, $y, $H, $M, $S) = ($1, $2, $3 < 69 ? $3 + 2000 : $3 + 1900, $4, $5, $6);
		992
		993	} 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])$/) {
		994	# ISO C's asctime
		995	($d, $m, $y, $H, $M, $S) = ($2, $1, $6, $3, $4, $5);
		996	}
		997	# other formats fail in the loop below
		998
		999	for (0..11) {
		1000	if ($m eq $month[$_]) {
		1001	require Time::Local;
		1002	return Time::Local::timegm ($S, $M, $H, $d, $_, $y);
		1003	}
		1004	}
		1005
		1006	undef
		1007	}
837		1008
838	sub set_proxy($) {	1009	sub set_proxy($) {
839	if (length $_[0]) {	1010	if (length $_[0]) {
840	$_[0] =~ m%^(https?):// ([^:/]+) (?: : (\d*) )?%ix	1011	$_[0] =~ m%^(https?):// ([^:/]+) (?: : (\d*) )?%ix
841	or Carp::croak "$_[0]: invalid proxy URL";	1012	or Carp::croak "$_[0]: invalid proxy URL";
…		…
848	# initialise proxy from environment	1019	# initialise proxy from environment
849	eval {	1020	eval {
850	set_proxy $ENV{http_proxy};	1021	set_proxy $ENV{http_proxy};
851	};	1022	};
852		1023
		1024	=head2 SOCKS PROXIES
		1025
		1026	Socks proxies are not directly supported by AnyEvent::HTTP. You can
		1027	compile your perl to support socks, or use an external program such as
		1028	F<socksify> (dante) or F<tsocks> to make your program use a socks proxy
		1029	transparently.
		1030
		1031	Alternatively, for AnyEvent::HTTP only, you can use your own
		1032	C<tcp_connect> function that does the proxy handshake - here is an example
		1033	that works with socks4a proxies:
		1034
		1035	use Errno;
		1036	use AnyEvent::Util;
		1037	use AnyEvent::Socket;
		1038	use AnyEvent::Handle;
		1039
		1040	# host, port and username of/for your socks4a proxy
		1041	my $socks_host = "10.0.0.23";
		1042	my $socks_port = 9050;
		1043	my $socks_user = "";
		1044
		1045	sub socks4a_connect {
		1046	my ($host, $port, $connect_cb, $prepare_cb) = @_;
		1047
		1048	my $hdl = new AnyEvent::Handle
		1049	connect => [$socks_host, $socks_port],
		1050	on_prepare => sub { $prepare_cb->($_[0]{fh}) },
		1051	on_error => sub { $connect_cb->() },
		1052	;
		1053
		1054	$hdl->push_write (pack "CCnNZZ", 4, 1, $port, 1, $socks_user, $host);
		1055
		1056	$hdl->push_read (chunk => 8, sub {
		1057	my ($hdl, $chunk) = @_;
		1058	my ($status, $port, $ipn) = unpack "xCna4", $chunk;
		1059
		1060	if ($status == 0x5a) {
		1061	$connect_cb->($hdl->{fh}, (format_address $ipn) . ":$port");
		1062	} else {
		1063	$! = Errno::ENXIO; $connect_cb->();
		1064	}
		1065	});
		1066
		1067	$hdl
		1068	}
		1069
		1070	Use C<socks4a_connect> instead of C<tcp_connect> when doing C<http_request>s,
		1071	possibly after switching off other proxy types:
		1072
		1073	AnyEvent::HTTP::set_proxy undef; # usually you do not want other proxies
		1074
		1075	http_get 'http://www.google.com', tcp_connect => \&socks4a_connect, sub {
		1076	my ($data, $headers) = @_;
		1077	...
		1078	};
		1079
853	=head1 SEE ALSO	1080	=head1 SEE ALSO
854		1081
855	L<AnyEvent>.	1082	L<AnyEvent>.
856		1083
857	=head1 AUTHOR	1084	=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.70 by root, Fri Dec 31 20:31: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.70 by root, Fri Dec 31 20:31:47 2010 UTC