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

Comparing AnyEvent-HTTP/HTTP.pm (file contents):
Revision 1.16 by root, Fri Jun 6 12:57:48 2008 UTC vs.
Revision 1.53 by root, Sat Dec 5 15:37:07 2009 UTC

…		…
3	AnyEvent::HTTP - simple but non-blocking HTTP/HTTPS client	3	AnyEvent::HTTP - simple but non-blocking HTTP/HTTPS client
4		4
5	=head1 SYNOPSIS	5	=head1 SYNOPSIS
6		6
7	use AnyEvent::HTTP;	7	use AnyEvent::HTTP;
		8
		9	http_get "http://www.nethype.de/", sub { print $_[1] };
		10
		11	# ... do something else here
8		12
9	=head1 DESCRIPTION	13	=head1 DESCRIPTION
10		14
11	This module is an L<AnyEvent> user, you need to make sure that you use and	15	This module is an L<AnyEvent> user, you need to make sure that you use and
12	run a supported event loop.	16	run a supported event loop.
…		…
35	package AnyEvent::HTTP;	39	package AnyEvent::HTTP;
36		40
37	use strict;	41	use strict;
38	no warnings;	42	no warnings;
39		43
40	use Carp;	44	use Errno ();
41		45
42	use AnyEvent ();	46	use AnyEvent 5.0 ();
43	use AnyEvent::Util ();	47	use AnyEvent::Util ();
44	use AnyEvent::Socket ();	48	use AnyEvent::Socket ();
45	use AnyEvent::Handle ();	49	use AnyEvent::Handle ();
46		50
47	use base Exporter::;	51	use base Exporter::;
48		52
49	our $VERSION = '1.01';	53	our $VERSION = '1.44';
50		54
51	our @EXPORT = qw(http_get http_request);	55	our @EXPORT = qw(http_get http_post http_head http_request);
52		56
53	our $USERAGENT = "Mozilla/5.0 (compatible; AnyEvent::HTTP/$VERSION; +http://software.schmorp.de/pkg/AnyEvent)";	57	our $USERAGENT = "Mozilla/5.0 (compatible; U; AnyEvent-HTTP/$VERSION; +http://software.schmorp.de/pkg/AnyEvent)";
54	our $MAX_RECURSE = 10;	58	our $MAX_RECURSE = 10;
55	our $MAX_PERSISTENT = 8;	59	our $MAX_PERSISTENT = 8;
56	our $PERSISTENT_TIMEOUT = 2;	60	our $PERSISTENT_TIMEOUT = 2;
57	our $TIMEOUT = 300;	61	our $TIMEOUT = 300;
58		62
59	# changing these is evil	63	# changing these is evil
60	our $MAX_PERSISTENT_PER_HOST = 2;	64	our $MAX_PERSISTENT_PER_HOST = 0;
61	our $MAX_PER_HOST = 4;	65	our $MAX_PER_HOST = 4;
62		66
63	our $PROXY;	67	our $PROXY;
64	our $ACTIVE = 0;	68	our $ACTIVE = 0;
65		69
…		…
67	my %CO_SLOT; # number of open connections, and wait queue, per host	71	my %CO_SLOT; # number of open connections, and wait queue, per host
68		72
69	=item http_get $url, key => value..., $cb->($data, $headers)	73	=item http_get $url, key => value..., $cb->($data, $headers)
70		74
71	Executes an HTTP-GET request. See the http_request function for details on	75	Executes an HTTP-GET request. See the http_request function for details on
72	additional parameters.	76	additional parameters and the return value.
73		77
74	=item http_head $url, key => value..., $cb->($data, $headers)	78	=item http_head $url, key => value..., $cb->($data, $headers)
75		79
76	Executes an HTTP-HEAD request. See the http_request function for details on	80	Executes an HTTP-HEAD request. See the http_request function for details
77	additional parameters.	81	on additional parameters and the return value.
78		82
79	=item http_post $url, $body, key => value..., $cb->($data, $headers)	83	=item http_post $url, $body, key => value..., $cb->($data, $headers)
80		84
81	Executes an HTTP-POST request with a request body of C<$bod>. See the	85	Executes an HTTP-POST request with a request body of C<$body>. See the
82	http_request function for details on additional parameters.	86	http_request function for details on additional parameters and the return
		87	value.
83		88
84	=item http_request $method => $url, key => value..., $cb->($data, $headers)	89	=item http_request $method => $url, key => value..., $cb->($data, $headers)
85		90
86	Executes a HTTP request of type C<$method> (e.g. C<GET>, C<POST>). The URL	91	Executes a HTTP request of type C<$method> (e.g. C<GET>, C<POST>). The URL
87	must be an absolute http or https URL.	92	must be an absolute http or https URL.
88		93
		94	When called in void context, nothing is returned. In other contexts,
		95	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
		97	destroyed before the callbakc is called, the request will be cancelled.
		98
89	The callback will be called with the response data as first argument	99	The callback will be called with the response body data as first argument
90	(or C<undef> if it wasn't available due to errors), and a hash-ref with	100	(or C<undef> if an error occured), and a hash-ref with response headers as
91	response headers as second argument.	101	second argument.
92		102
93	All the headers in that hash are lowercased. In addition to the response	103	All the headers in that hash are lowercased. In addition to the response
94	headers, the three "pseudo-headers" C<HTTPVersion>, C<Status> and	104	headers, the "pseudo-headers" C<HTTPVersion>, C<Status> and C<Reason>
95	C<Reason> contain the three parts of the HTTP Status-Line of the same	105	contain the three parts of the HTTP Status-Line of the same name. The
		106	pseudo-header C<URL> contains the original URL (which can differ from the
		107	requested URL when following redirects).
		108
96	name. If the server sends a header multiple lines, then their contents	109	If the server sends a header multiple times, then their contents will be
97	will be joined together with C<\x00>.	110	joined together with a comma (C<,>), as per the HTTP spec.
98		111
99	If an internal error occurs, such as not being able to resolve a hostname,	112	If an internal error occurs, such as not being able to resolve a hostname,
100	then C<$data> will be C<undef>, C<< $headers->{Status} >> will be C<599>	113	then C<$data> will be C<undef>, C<< $headers->{Status} >> will be C<59x>
101	and the C<Reason> pseudo-header will contain an error message.	114	(usually C<599>) and the C<Reason> pseudo-header will contain an error
		115	message.
102		116
103	A typical callback might look like this:	117	A typical callback might look like this:
104		118
105	sub {	119	sub {
106	my ($body, $hdr) = @_;	120	my ($body, $hdr) = @_;
…		…
124		138
125	=item headers => hashref	139	=item headers => hashref
126		140
127	The request headers to use. Currently, C<http_request> may provide its	141	The request headers to use. Currently, C<http_request> may provide its
128	own C<Host:>, C<Content-Length:>, C<Connection:> and C<Cookie:> headers	142	own C<Host:>, C<Content-Length:>, C<Connection:> and C<Cookie:> headers
129	and will provide defaults for C<User-Agent:> and C<Referer:>.	143	and will provide defaults for C<User-Agent:> and C<Referer:> (this can be
		144	suppressed by using C<undef> for these headers in which case they won't be
		145	sent at all).
130		146
131	=item timeout => $seconds	147	=item timeout => $seconds
132		148
133	The time-out to use for various stages - each connect attempt will reset	149	The time-out to use for various stages - each connect attempt will reset
134	the timeout, as will read or write activity. Default timeout is 5 minutes.	150	the timeout, as will read or write activity, i.e. this is not an overall
		151	timeout.
		152
		153	Default timeout is 5 minutes.
135		154
136	=item proxy => [$host, $port[, $scheme]] or undef	155	=item proxy => [$host, $port[, $scheme]] or undef
137		156
138	Use the given http proxy for all requests. If not specified, then the	157	Use the given http proxy for all requests. If not specified, then the
139	default proxy (as specified by C<$ENV{http_proxy}>) is used.	158	default proxy (as specified by C<$ENV{http_proxy}>) is used.
140		159
141	C<$scheme> must be either missing or C<http> for HTTP, or C<https> for	160	C<$scheme> must be either missing, C<http> for HTTP or C<https> for
142	HTTPS.	161	HTTPS.
143		162
144	=item body => $string	163	=item body => $string
145		164
146	The request body, usually empty. Will be-sent as-is (future versions of	165	The request body, usually empty. Will be-sent as-is (future versions of
…		…
152	based on the original netscape specification.	171	based on the original netscape specification.
153		172
154	The C<$hash_ref> must be an (initially empty) hash reference which will	173	The C<$hash_ref> must be an (initially empty) hash reference which will
155	get updated automatically. It is possible to save the cookie_jar to	174	get updated automatically. It is possible to save the cookie_jar to
156	persistent storage with something like JSON or Storable, but this is not	175	persistent storage with something like JSON or Storable, but this is not
157	recommended, as expire times are currently being ignored.	176	recommended, as expiry times are currently being ignored.
158		177
159	Note that this cookie implementation is not of very high quality, nor	178	Note that this cookie implementation is not of very high quality, nor
160	meant to be complete. If you want complete cookie management you have to	179	meant to be complete. If you want complete cookie management you have to
161	do that on your own. C<cookie_jar> is meant as a quick fix to get some	180	do that on your own. C<cookie_jar> is meant as a quick fix to get some
162	cookie-using sites working. Cookies are a privacy disaster, do not use	181	cookie-using sites working. Cookies are a privacy disaster, do not use
163	them unless required to.	182	them unless required to.
		183
		184	=item tls_ctx => $scheme \| $tls_ctx
		185
		186	Specifies the AnyEvent::TLS context to be used for https connections. This
		187	parameter follows the same rules as the C<tls_ctx> parameter to
		188	L<AnyEvent::Handle>, but additionally, the two strings C<low> or
		189	C<high> can be specified, which give you a predefined low-security (no
		190	verification, highest compatibility) and high-security (CA and common-name
		191	verification) TLS context.
		192
		193	The default for this option is C<low>, which could be interpreted as "give
		194	me the page, no matter what".
		195
		196	=item on_prepare => $callback->($fh)
		197
		198	In rare cases you need to "tune" the socket before it is used to
		199	connect (for exmaple, to bind it on a given IP address). This parameter
		200	overrides the prepare callback passed to C<AnyEvent::Socket::tcp_connect>
		201	and behaves exactly the same way (e.g. it has to provide a
		202	timeout). See the description for the C<$prepare_cb> argument of
		203	C<AnyEvent::Socket::tcp_connect> for details.
		204
		205	=item on_header => $callback->($headers)
		206
		207	When specified, this callback will be called with the header hash as soon
		208	as headers have been successfully received from the remote server (not on
		209	locally-generated errors).
		210
		211	It has to return either true (in which case AnyEvent::HTTP will continue),
		212	or false, in which case AnyEvent::HTTP will cancel the download (and call
		213	the finish callback with an error code of C<598>).
		214
		215	This callback is useful, among other things, to quickly reject unwanted
		216	content, which, if it is supposed to be rare, can be faster than first
		217	doing a C<HEAD> request.
		218
		219	Example: cancel the request unless the content-type is "text/html".
		220
		221	on_header => sub {
		222	$_[0]{"content-type"} =~ /^text\/html\s*(?:;\|$)/
		223	},
		224
		225	=item on_body => $callback->($partial_body, $headers)
		226
		227	When specified, all body data will be passed to this callback instead of
		228	to the completion callback. The completion callback will get the empty
		229	string instead of the body data.
		230
		231	It has to return either true (in which case AnyEvent::HTTP will continue),
		232	or false, in which case AnyEvent::HTTP will cancel the download (and call
		233	the completion callback with an error code of C<598>).
		234
		235	This callback is useful when the data is too large to be held in memory
		236	(so the callback writes it to a file) or when only some information should
		237	be extracted, or when the body should be processed incrementally.
		238
		239	It is usually preferred over doing your own body handling via
		240	C<want_body_handle>, but in case of streaming APIs, where HTTP is
		241	only used to create a connection, C<want_body_handle> is the better
		242	alternative, as it allows you to install your own event handler, reducing
		243	resource usage.
		244
		245	=item want_body_handle => $enable
		246
		247	When enabled (default is disabled), the behaviour of AnyEvent::HTTP
		248	changes considerably: after parsing the headers, and instead of
		249	downloading the body (if any), the completion callback will be
		250	called. Instead of the C<$body> argument containing the body data, the
		251	callback will receive the L<AnyEvent::Handle> object associated with the
		252	connection. In error cases, C<undef> will be passed. When there is no body
		253	(e.g. status C<304>), the empty string will be passed.
		254
		255	The handle object might or might not be in TLS mode, might be connected to
		256	a proxy, be a persistent connection etc., and configured in unspecified
		257	ways. The user is responsible for this handle (it will not be used by this
		258	module anymore).
		259
		260	This is useful with some push-type services, where, after the initial
		261	headers, an interactive protocol is used (typical example would be the
		262	push-style twitter API which starts a JSON/XML stream).
		263
		264	If you think you need this, first have a look at C<on_body>, to see if
		265	that doesn't solve your problem in a better way.
164		266
165	=back	267	=back
166		268
167	Example: make a simple HTTP GET request for http://www.nethype.de/	269	Example: make a simple HTTP GET request for http://www.nethype.de/
168		270
…		…
181	my ($body, $hdr) = @_;	283	my ($body, $hdr) = @_;
182	use Data::Dumper;	284	use Data::Dumper;
183	print Dumper $hdr;	285	print Dumper $hdr;
184	}	286	}
185	;	287	;
		288
		289	Example: make another simple HTTP GET request, but immediately try to
		290	cancel it.
		291
		292	my $request = http_request GET => "http://www.nethype.de/", sub {
		293	my ($body, $hdr) = @_;
		294	print "$body\n";
		295	};
		296
		297	undef $request;
186		298
187	=cut	299	=cut
188		300
189	sub _slot_schedule;	301	sub _slot_schedule;
190	sub _slot_schedule($) {	302	sub _slot_schedule($) {
…		…
214	push @{ $CO_SLOT{$_[0]}[1] }, $_[1];	326	push @{ $CO_SLOT{$_[0]}[1] }, $_[1];
215		327
216	_slot_schedule $_[0];	328	_slot_schedule $_[0];
217	}	329	}
218		330
		331	our $qr_nl = qr{\015?\012};
		332	our $qr_nlnl = qr{(?<![^\012])\015?\012};
		333
		334	our $TLS_CTX_LOW = { cache => 1, sslv2 => 1 };
		335	our $TLS_CTX_HIGH = { cache => 1, verify => 1, verify_peername => "https" };
		336
219	sub http_request($$@) {	337	sub http_request($$@) {
220	my $cb = pop;	338	my $cb = pop;
221	my ($method, $url, %arg) = @_;	339	my ($method, $url, %arg) = @_;
222		340
223	my %hdr;	341	my %hdr;
		342
		343	$arg{tls_ctx} = $TLS_CTX_LOW if $arg{tls_ctx} eq "low" \|\| !exists $arg{tls_ctx};
		344	$arg{tls_ctx} = $TLS_CTX_HIGH if $arg{tls_ctx} eq "high";
224		345
225	$method = uc $method;	346	$method = uc $method;
226		347
227	if (my $hdr = $arg{headers}) {	348	if (my $hdr = $arg{headers}) {
228	while (my ($k, $v) = each %$hdr) {	349	while (my ($k, $v) = each %$hdr) {
229	$hdr{lc $k} = $v;	350	$hdr{lc $k} = $v;
230	}	351	}
231	}	352	}
232		353
233	my $recurse = exists $arg{recurse} ? $arg{recurse} : $MAX_RECURSE;	354	my $recurse = exists $arg{recurse} ? delete $arg{recurse} : $MAX_RECURSE;
234		355
235	return $cb->(undef, { Status => 599, Reason => "recursion limit reached" })	356	return $cb->(undef, { Status => 599, Reason => "Too many redirections", URL => $url })
236	if $recurse < 0;	357	if $recurse < 0;
237		358
238	my $proxy = $arg{proxy} \|\| $PROXY;	359	my $proxy = $arg{proxy} \|\| $PROXY;
239	my $timeout = $arg{timeout} \|\| $TIMEOUT;	360	my $timeout = $arg{timeout} \|\| $TIMEOUT;
240		361
241	$hdr{"user-agent"} \|\|= $USERAGENT;
242
243	my ($scheme, $authority, $upath, $query, $fragment) =	362	my ($uscheme, $uauthority, $upath, $query, $fragment) =
244	$url =~ m\|(?:([^:/?#]+):)?(?://([^/?#]))?([^?#])(?:\?([^#]))?(?:#(.))?\|;	363	$url =~ m\|(?:([^:/?#]+):)?(?://([^/?#]))?([^?#])(?:\?([^#]))?(?:#(.))?\|;
245		364
246	$scheme = lc $scheme;	365	$uscheme = lc $uscheme;
247		366
248	my $uport = $scheme eq "http" ? 80	367	my $uport = $uscheme eq "http" ? 80
249	: $scheme eq "https" ? 443	368	: $uscheme eq "https" ? 443
250	: return $cb->(undef, { Status => 599, Reason => "only http and https URL schemes supported" });	369	: return $cb->(undef, { Status => 599, Reason => "Only http and https URL schemes supported", URL => $url });
251		370
252	$hdr{referer} \|\|= "$scheme://$authority$upath"; # leave out fragment and query string, just a heuristic
253
254	$authority =~ /^(?: .*\@ )? ([^\@:]+) (?: : (\d+) )?$/x	371	$uauthority =~ /^(?: .*\@ )? ([^\@:]+) (?: : (\d+) )?$/x
255	or return $cb->(undef, { Status => 599, Reason => "unparsable URL" });	372	or return $cb->(undef, { Status => 599, Reason => "Unparsable URL", URL => $url });
256		373
257	my $uhost = $1;	374	my $uhost = $1;
258	$uport = $2 if defined $2;	375	$uport = $2 if defined $2;
259		376
		377	$hdr{host} = defined $2 ? "$uhost:$2" : "$uhost"
		378	unless exists $hdr{host};
		379
260	$uhost =~ s/^\[(.*)\]$/$1/;	380	$uhost =~ s/^\[(.*)\]$/$1/;
261	$upath .= "?$query" if length $query;	381	$upath .= "?$query" if length $query;
262		382
263	$upath =~ s%^/?%/%;	383	$upath =~ s%^/?%/%;
264		384
265	# cookie processing	385	# cookie processing
266	if (my $jar = $arg{cookie_jar}) {	386	if (my $jar = $arg{cookie_jar}) {
267	%$jar = () if $jar->{version} < 1;	387	%$jar = () if $jar->{version} != 1;
268		388
269	my @cookie;	389	my @cookie;
270		390
271	while (my ($chost, $v) = each %$jar) {	391	while (my ($chost, $v) = each %$jar) {
		392	if ($chost =~ /^\./) {
272	next unless $chost eq substr $uhost, -length $chost;	393	next unless $chost eq substr $uhost, -length $chost;
273	next unless $chost =~ /^\./;	394	} elsif ($chost =~ /\./) {
		395	next unless $chost eq $uhost;
		396	} else {
		397	next;
		398	}
274		399
275	while (my ($cpath, $v) = each %$v) {	400	while (my ($cpath, $v) = each %$v) {
276	next unless $cpath eq substr $upath, 0, length $cpath;	401	next unless $cpath eq substr $upath, 0, length $cpath;
277		402
278	while (my ($k, $v) = each %$v) {	403	while (my ($k, $v) = each %$v) {
279	next if $scheme ne "https" && exists $v->{secure};	404	next if $uscheme ne "https" && exists $v->{secure};
		405	my $value = $v->{value};
		406	$value =~ s/([\\"])/\\$1/g;
280	push @cookie, "$k=$v->{value}";	407	push @cookie, "$k=\"$value\"";
281	}	408	}
282	}	409	}
283	}	410	}
284		411
285	$hdr{cookie} = join "; ", @cookie	412	$hdr{cookie} = join "; ", @cookie
286	if @cookie;	413	if @cookie;
287	}	414	}
288		415
289	my ($rhost, $rport, $rpath); # request host, port, path	416	my ($rhost, $rport, $rscheme, $rpath); # request host, port, path
290		417
291	if ($proxy) {	418	if ($proxy) {
292	($rhost, $rport, $scheme) = @$proxy;	419	($rpath, $rhost, $rport, $rscheme) = ($url, @$proxy);
293	$rpath = $url;	420
		421	$rscheme = "http" unless defined $rscheme;
		422
		423	# don't support https requests over https-proxy transport,
		424	# can't be done with tls as spec'ed, unless you double-encrypt.
		425	$rscheme = "http" if $uscheme eq "https" && $rscheme eq "https";
294	} else {	426	} else {
295	($rhost, $rport, $rpath) = ($uhost, $uport, $upath);	427	($rhost, $rport, $rscheme, $rpath) = ($uhost, $uport, $uscheme, $upath);
296	$hdr{host} = $uhost;
297	}	428	}
298		429
		430	# leave out fragment and query string, just a heuristic
		431	$hdr{referer} \|\|= "$uscheme://$uauthority$upath" unless exists $hdr{referer};
		432	$hdr{"user-agent"} \|\|= $USERAGENT unless exists $hdr{"user-agent"};
		433
299	$hdr{"content-length"} = length $arg{body};	434	$hdr{"content-length"} = length $arg{body}
		435	if length $arg{body} \|\| $method ne "GET";
300		436
301	my %state = (connect_guard => 1);	437	my %state = (connect_guard => 1);
302		438
303	_get_slot $uhost, sub {	439	_get_slot $uhost, sub {
304	$state{slot_guard} = shift;	440	$state{slot_guard} = shift;
305		441
306	return unless $state{connect_guard};	442	return unless $state{connect_guard};
307		443
308	$state{connect_guard} = AnyEvent::Socket::tcp_connect $rhost, $rport, sub {	444	$state{connect_guard} = AnyEvent::Socket::tcp_connect $rhost, $rport, sub {
309	$state{fh} = shift	445	$state{fh} = shift
		446	or do {
		447	my $err = "$!";
		448	%state = ();
310	or return $cb->(undef, { Status => 599, Reason => "$!" });	449	return $cb->(undef, { Status => 599, Reason => $err, URL => $url });
		450	};
311		451
312	delete $state{connect_guard}; # reduce memory usage, save a tree	452	pop; # free memory, save a tree
		453
		454	return unless delete $state{connect_guard};
313		455
314	# get handle	456	# get handle
315	$state{handle} = new AnyEvent::Handle	457	$state{handle} = new AnyEvent::Handle
316	fh => $state{fh},	458	fh => $state{fh},
317	($scheme eq "https" ? (tls => "connect") : ());	459	timeout => $timeout,
		460	peername => $rhost,
		461	tls_ctx => $arg{tls_ctx};
318		462
319	# limit the number of persistent connections	463	# limit the number of persistent connections
		464	# keepalive not yet supported
320	if ($KA_COUNT{$_[1]} < $MAX_PERSISTENT_PER_HOST) {	465	if ($KA_COUNT{$_[1]} < $MAX_PERSISTENT_PER_HOST) {
321	++$KA_COUNT{$_[1]};	466	++$KA_COUNT{$_[1]};
322	$state{handle}{ka_count_guard} = AnyEvent::Util::guard { --$KA_COUNT{$_[1]} };	467	$state{handle}{ka_count_guard} = AnyEvent::Util::guard {
		468	--$KA_COUNT{$_[1]}
		469	};
323	$hdr{connection} = "keep-alive";	470	$hdr{connection} = "keep-alive";
324	delete $hdr{connection}; # keep-alive not yet supported
325	} else {	471	} else {
326	delete $hdr{connection};	472	delete $hdr{connection};
327	}	473	}
328		474
329	# (re-)configure handle	475	# (re-)configure handle
330	$state{handle}->timeout ($timeout);
331	$state{handle}->on_error (sub {	476	$state{handle}->on_error (sub {
332	my $errno = "$!";
333	%state = ();	477	%state = ();
334	$cb->(undef, { Status => 599, Reason => $errno });	478	$cb->(undef, { Status => 599, Reason => $_[2], URL => $url });
335	});	479	});
336	$state{handle}->on_eof (sub {	480	$state{handle}->on_eof (sub {
337	%state = ();	481	%state = ();
338	$cb->(undef, { Status => 599, Reason => "unexpected end-of-file" });	482	$cb->(undef, { Status => 599, Reason => "Unexpected end-of-file", URL => $url });
339	});	483	});
340		484
		485	$state{handle}->starttls ("connect") if $rscheme eq "https";
		486
		487	# handle actual, non-tunneled, request
		488	my $handle_actual_request = sub {
		489	$state{handle}->starttls ("connect") if $uscheme eq "https" && !exists $state{handle}{tls};
		490
341	# send request	491	# send request
342	$state{handle}->push_write (	492	$state{handle}->push_write (
343	"$method $rpath HTTP/1.0\015\012"	493	"$method $rpath HTTP/1.0\015\012"
344	. (join "", map "$_: $hdr{$_}\015\012", keys %hdr)	494	. (join "", map "\u$_: $hdr{$_}\015\012", grep defined $hdr{$_}, keys %hdr)
345	. "\015\012"	495	. "\015\012"
346	. (delete $arg{body})	496	. (delete $arg{body})
347	);
348
349	%hdr = (); # reduce memory usage, save a kitten
350
351	# status line
352	$state{handle}->push_read (line => qr/\015?\012/, sub {
353	$_[1] =~ /^HTTP\/([0-9\.]+) \s+ ([0-9]{3}) \s+ ([^\015\012]+)/ix
354	or return (%state = (), $cb->(undef, { Status => 599, Reason => "invalid server response ($_[1])" }));
355
356	my %hdr = ( # response headers
357	HTTPVersion => "\x00$1",
358	Status => "\x00$2",
359	Reason => "\x00$3",
360	);	497	);
361		498
		499	%hdr = (); # reduce memory usage, save a kitten
		500
		501	# status line
		502	$state{handle}->push_read (line => $qr_nl, sub {
		503	$_[1] =~ /^HTTP\/([0-9\.]+) \s+ ([0-9]{3}) (?: \s+ ([^\015\012]*) )?/ix
		504	or return (%state = (), $cb->(undef, { Status => 599, Reason => "Invalid server response ($_[1])", URL => $url }));
		505
		506	my %hdr = ( # response headers
		507	HTTPVersion => ",$1",
		508	Status => ",$2",
		509	Reason => ",$3",
		510	URL => ",$url"
		511	);
		512
362	# headers, could be optimized a bit	513	# headers, could be optimized a bit
363	$state{handle}->unshift_read (line => qr/\015?\012\015?\012/, sub {	514	$state{handle}->unshift_read (line => $qr_nlnl, sub {
364	for ("$_[1]\012") {	515	for ("$_[1]") {
365	# we support spaces in field names, as lotus domino	516	y/\015//d; # weed out any \015, as they show up in the weirdest of places.
366	# creates them.	517
		518	# things seen, not parsed:
		519	# p3pP="NON CUR OTPi OUR NOR UNI"
		520
367	$hdr{lc $1} .= "\x00$2"	521	$hdr{lc $1} .= ",$2"
368	while /\G	522	while /\G
369	([^:\000-\037]+):	523	([^:\000-\037]*):
370	[\011\040]*	524	[\011\040]*
371	((?: [^\015\012]+ \| \015?\012[\011\040] )*)	525	((?: [^\012]+ \| \012[\011\040] )*)
372	\015?\012	526	\012
373	/gxc;	527	/gxc;
374		528
375	/\G$/	529	/\G$/
376	or return (%state = (), $cb->(undef, { Status => 599, Reason => "garbled response headers" }));	530	or return (%state = (), $cb->(undef, { Status => 599, Reason => "Garbled response headers", URL => $url }));
377	}	531	}
378		532
379	substr $_, 0, 1, ""	533	substr $_, 0, 1, ""
380	for values %hdr;	534	for values %hdr;
381		535
382	my $finish = sub {	536	# redirect handling
383	%state = ();	537	# microsoft and other shitheads don't give a shit for following standards,
		538	# try to support some common forms of broken Location headers.
		539	if ($hdr{location} !~ /^(?: $ \| [^:\/?\#]+ : )/x) {
		540	$hdr{location} =~ s/^\.\/+//;
384		541
385	# set-cookie processing	542	my $url = "$rscheme://$uhost:$uport";
386	if ($arg{cookie_jar} && exists $hdr{"set-cookie"}) {
387	for (split /\x00/, $hdr{"set-cookie"}) {
388	my ($cookie, @arg) = split /;\s*/;
389	my ($name, $value) = split /=/, $cookie, 2;
390	my %kv = (value => $value, map { split /=/, $_, 2 } @arg);
391
392	my $cdom = (delete $kv{domain}) \|\| $uhost;
393	my $cpath = (delete $kv{path}) \|\| "/";
394
395	$cdom =~ s/^.?/./; # make sure it starts with a "."
396		543
397	next if $cdom =~ /\.$/;	544	unless ($hdr{location} =~ s/^\///) {
398		545	$url .= $upath;
399	# this is not rfc-like and not netscape-like. go figure.	546	$url =~ s/\/[^\/]*$//;
400	my $ndots = $cdom =~ y/.//;	547	}
401	next if $ndots < ($cdom =~ /\.[^.][^.]\.[^.][^.]$/ ? 3 : 2);	548
402		549	$hdr{location} = "$url/$hdr{location}";
		550	}
		551
		552	my $redirect;
		553
		554	if ($recurse) {
		555	if ($hdr{Status} =~ /^30[12]$/ && $method ne "POST") {
		556	# apparently, mozilla et al. just change POST to GET here
		557	# more research is needed before we do the same
403	# store it	558	$redirect = 1;
404	$arg{cookie_jar}{version} = 1;	559	} elsif ($hdr{Status} == 303) {
405	$arg{cookie_jar}{$cdom}{$cpath}{$name} = \%kv;	560	# even http/1.1 is unclear on how to mutate the method
		561	$method = "GET" unless $method eq "HEAD";
		562	$redirect = 1;
		563	} elsif ($hdr{Status} == 307 && $method =~ /^(?:GET\|HEAD)$/) {
		564	$redirect = 1;
406	}	565	}
407	}	566	}
408		567
409	if ($_[1]{Status} =~ /^30[12]$/ && $recurse) {	568	my $finish = sub {
410	# microsoft and other assholes don't give a shit for following standards,	569	$state{handle}->destroy if $state{handle};
411	# try to support a common form of broken Location header.	570	%state = ();
412	$_[1]{location} =~ s%^/%$scheme://$uhost:$uport/%;
413		571
		572	# set-cookie processing
		573	if ($arg{cookie_jar}) {
		574	for ($_[1]{"set-cookie"}) {
		575	# parse NAME=VALUE
		576	my @kv;
		577
		578	while (/\G\s* ([^=;,[:space:]]+) \s=\s (?: "((?:[^\\"]+\|\\.))" \| ([^=;,[:space:]]) )/gcxs) {
		579	my $name = $1;
		580	my $value = $3;
		581
		582	unless ($value) {
		583	$value = $2;
		584	$value =~ s/\\(.)/$1/gs;
		585	}
		586
		587	push @kv, $name => $value;
		588
		589	last unless /\G\s*;/gc;
		590	}
		591
		592	last unless @kv;
		593
		594	my $name = shift @kv;
		595	my %kv = (value => shift @kv, @kv);
		596
		597	my $cdom;
		598	my $cpath = (delete $kv{path}) \|\| "/";
		599
		600	if (exists $kv{domain}) {
		601	$cdom = delete $kv{domain};
		602
		603	$cdom =~ s/^\.?/./; # make sure it starts with a "."
		604
		605	next if $cdom =~ /\.$/;
		606
		607	# this is not rfc-like and not netscape-like. go figure.
		608	my $ndots = $cdom =~ y/.//;
		609	next if $ndots < ($cdom =~ /\.[^.][^.]\.[^.][^.]$/ ? 3 : 2);
		610	} else {
		611	$cdom = $uhost;
		612	}
		613
		614	# store it
		615	$arg{cookie_jar}{version} = 1;
		616	$arg{cookie_jar}{$cdom}{$cpath}{$name} = \%kv;
		617
		618	redo if /\G\s*,/gc;
		619	}
		620	}
		621
		622	if ($redirect && exists $hdr{location}) {
		623	# we ignore any errors, as it is very common to receive
		624	# Content-Length != 0 but no actual body
		625	# we also access %hdr, as $_[1] might be an erro
414	http_request ($method, $_[1]{location}, %arg, recurse => $recurse - 1, $cb);	626	http_request ($method => $hdr{location}, %arg, recurse => $recurse - 1, $cb);
		627	} else {
		628	$cb->($_[0], $_[1]);
		629	}
		630	};
		631
		632	my $len = $hdr{"content-length"};
		633
		634	if (!$redirect && $arg{on_header} && !$arg{on_header}(\%hdr)) {
		635	$finish->(undef, { Status => 598, Reason => "Request cancelled by on_header", URL => $url });
		636	} elsif (
		637	$hdr{Status} =~ /^(?:1..\|[23]04)$/
		638	or $method eq "HEAD"
		639	or (defined $len && !$len)
		640	) {
		641	# no body
		642	$finish->("", \%hdr);
415	} else {	643	} else {
416	$cb->($_[0], $_[1]);	644	# body handling, four different code paths
		645	# for want_body_handle, on_body (2x), normal (2x)
		646	# we might read too much here, but it does not matter yet (no pers. connections)
		647	if (!$redirect && $arg{want_body_handle}) {
		648	$_[0]->on_eof (undef);
		649	$_[0]->on_error (undef);
		650	$_[0]->on_read (undef);
		651
		652	$finish->(delete $state{handle}, \%hdr);
		653
		654	} elsif ($arg{on_body}) {
		655	$_[0]->on_error (sub { $finish->(undef, { Status => 599, Reason => $_[2], URL => $url }) });
		656	if ($len) {
		657	$_[0]->on_eof (undef);
		658	$_[0]->on_read (sub {
		659	$len -= length $_[0]{rbuf};
		660
		661	$arg{on_body}(delete $_[0]{rbuf}, \%hdr)
		662	or $finish->(undef, { Status => 598, Reason => "Request cancelled by on_body", URL => $url });
		663
		664	$len > 0
		665	or $finish->("", \%hdr);
		666	});
		667	} else {
		668	$_[0]->on_eof (sub {
		669	$finish->("", \%hdr);
		670	});
		671	$_[0]->on_read (sub {
		672	$arg{on_body}(delete $_[0]{rbuf}, \%hdr)
		673	or $finish->(undef, { Status => 598, Reason => "Request cancelled by on_body", URL => $url });
		674	});
		675	}
		676	} else {
		677	$_[0]->on_eof (undef);
		678
		679	if ($len) {
		680	$_[0]->on_error (sub { $finish->(undef, { Status => 599, Reason => $_[2], URL => $url }) });
		681	$_[0]->on_read (sub {
		682	$finish->((substr delete $_[0]{rbuf}, 0, $len, ""), \%hdr)
		683	if $len <= length $_[0]{rbuf};
		684	});
		685	} else {
		686	$_[0]->on_error (sub {
		687	$! == Errno::EPIPE \|\| !$!
		688	? $finish->(delete $_[0]{rbuf}, \%hdr)
		689	: $finish->(undef, { Status => 599, Reason => $_[2], URL => $url });
		690	});
		691	$_[0]->on_read (sub { });
		692	}
		693	}
417	}	694	}
418	};	695	});
		696	});
		697	};
419		698
420	if ($hdr{Status} =~ /^(?:1..\|204\|304)$/ or $method eq "HEAD") {	699	# now handle proxy-CONNECT method
421	$finish->(undef, \%hdr);	700	if ($proxy && $uscheme eq "https") {
		701	# oh dear, we have to wrap it into a connect request
		702
		703	# maybe re-use $uauthority with patched port?
		704	$state{handle}->push_write ("CONNECT $uhost:$uport HTTP/1.0\015\012Host: $uhost\015\012\015\012");
		705	$state{handle}->push_read (line => $qr_nlnl, sub {
		706	$_[1] =~ /^HTTP\/([0-9\.]+) \s+ ([0-9]{3}) (?: \s+ ([^\015\012]*) )?/ix
		707	or return (%state = (), $cb->(undef, { Status => 599, Reason => "Invalid proxy connect response ($_[1])", URL => $url }));
		708
		709	if ($2 == 200) {
		710	$rpath = $upath;
		711	&$handle_actual_request;
422	} else {	712	} else {
423	if (exists $hdr{"content-length"}) {	713	%state = ();
424	$_[0]->unshift_read (chunk => $hdr{"content-length"}, sub {	714	$cb->(undef, { Status => $2, Reason => $3, URL => $url });
425	# could cache persistent connection now
426	if ($hdr{connection} =~ /\bkeep-alive\b/i) {
427	# but we don't, due to misdesigns, this is annoyingly complex
428	};
429
430	$finish->($_[1], \%hdr);
431	});
432	} else {
433	# too bad, need to read until we get an error or EOF,
434	# no way to detect winged data.
435	$_[0]->on_error (sub {
436	$finish->($_[0]{rbuf}, \%hdr);
437	});
438	$_[0]->on_eof (undef);
439	$_[0]->on_read (sub { });
440	}
441	}	715	}
442	});	716	});
		717	} else {
		718	&$handle_actual_request;
443	});	719	}
444	}, sub {	720
445	$timeout	721	}, $arg{on_prepare} \|\| sub { $timeout };
446	};
447	};	722	};
448		723
449	defined wantarray && AnyEvent::Util::guard { %state = () }	724	defined wantarray && AnyEvent::Util::guard { %state = () }
450	}	725	}
451		726
…		…
458	unshift @_, "HEAD";	733	unshift @_, "HEAD";
459	&http_request	734	&http_request
460	}	735	}
461		736
462	sub http_post($$@) {	737	sub http_post($$@) {
		738	my $url = shift;
463	unshift @_, "POST", "body";	739	unshift @_, "POST", $url, "body";
464	&http_request	740	&http_request
465	}	741	}
466		742
467	=back	743	=back
468		744
…		…
471	=over 4	747	=over 4
472		748
473	=item AnyEvent::HTTP::set_proxy "proxy-url"	749	=item AnyEvent::HTTP::set_proxy "proxy-url"
474		750
475	Sets the default proxy server to use. The proxy-url must begin with a	751	Sets the default proxy server to use. The proxy-url must begin with a
476	string of the form C<http://host:port> (optionally C<https:...>).	752	string of the form C<http://host:port> (optionally C<https:...>), croaks
		753	otherwise.
		754
		755	To clear an already-set proxy, use C<undef>.
477		756
478	=item $AnyEvent::HTTP::MAX_RECURSE	757	=item $AnyEvent::HTTP::MAX_RECURSE
479		758
480	The default value for the C<recurse> request parameter (default: C<10>).	759	The default value for the C<recurse> request parameter (default: C<10>).
481		760
482	=item $AnyEvent::HTTP::USERAGENT	761	=item $AnyEvent::HTTP::USERAGENT
483		762
484	The default value for the C<User-Agent> header (the default is	763	The default value for the C<User-Agent> header (the default is
485	C<Mozilla/5.0 (compatible; AnyEvent::HTTP/$VERSION; +http://software.schmorp.de/pkg/AnyEvent)>).	764	C<Mozilla/5.0 (compatible; U; AnyEvent-HTTP/$VERSION; +http://software.schmorp.de/pkg/AnyEvent)>).
486		765
487	=item $AnyEvent::HTTP::MAX_PERSISTENT	766	=item $AnyEvent::HTTP::MAX_PER_HOST
488		767
489	The maximum number of persistent connections to keep open (default: 8).	768	The maximum number of concurrent connections to the same host (identified
		769	by the hostname). If the limit is exceeded, then the additional requests
		770	are queued until previous connections are closed.
490		771
491	Not implemented currently.	772	The default value for this is C<4>, and it is highly advisable to not
492		773	increase it.
493	=item $AnyEvent::HTTP::PERSISTENT_TIMEOUT
494
495	The maximum time to cache a persistent connection, in seconds (default: 2).
496
497	Not implemented currently.
498		774
499	=item $AnyEvent::HTTP::ACTIVE	775	=item $AnyEvent::HTTP::ACTIVE
500		776
501	The number of active connections. This is not the number of currently	777	The number of active connections. This is not the number of currently
502	running requests, but the number of currently open and non-idle TCP	778	running requests, but the number of currently open and non-idle TCP
…		…
505	=back	781	=back
506		782
507	=cut	783	=cut
508		784
509	sub set_proxy($) {	785	sub set_proxy($) {
		786	if (length $_[0]) {
510	$PROXY = [$2, $3 \|\| 3128, $1] if $_[0] =~ m%^(https?):// ([^:/]+) (?: : (\d*) )?%ix;	787	$_[0] =~ m%^(https?):// ([^:/]+) (?: : (\d*) )?%ix
		788	or Carp::croak "$_[0]: invalid proxy URL";
		789	$PROXY = [$2, $3 \|\| 3128, $1]
		790	} else {
		791	undef $PROXY;
		792	}
511	}	793	}
512		794
513	# initialise proxy from environment	795	# initialise proxy from environment
		796	eval {
514	set_proxy $ENV{http_proxy};	797	set_proxy $ENV{http_proxy};
		798	};
515		799
516	=head1 SEE ALSO	800	=head1 SEE ALSO
517		801
518	L<AnyEvent>.	802	L<AnyEvent>.
519		803
520	=head1 AUTHOR	804	=head1 AUTHOR
521		805
522	Marc Lehmann <schmorp@schmorp.de>	806	Marc Lehmann <schmorp@schmorp.de>
523	http://home.schmorp.de/	807	http://home.schmorp.de/
		808
		809	With many thanks to Дмитрий Шалашов, who provided countless
		810	testcases and bugreports.
524		811
525	=cut	812	=cut
526		813
527	1	814	1
528		815

Diff Legend

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

Comparing AnyEvent-HTTP/HTTP.pm (file contents): Revision 1.16 by root, Fri Jun 6 12:57:48 2008 UTC vs. Revision 1.53 by root, Sat Dec 5 15:37:07 2009 UTC

Diff Legend

Comparing AnyEvent-HTTP/HTTP.pm (file contents):
Revision 1.16 by root, Fri Jun 6 12:57:48 2008 UTC vs.
Revision 1.53 by root, Sat Dec 5 15:37:07 2009 UTC