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

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

Diff Legend

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

Comparing AnyEvent-HTTP/HTTP.pm (file contents): Revision 1.10 by root, Thu Jun 5 13:06:43 2008 UTC vs. Revision 1.45 by root, Fri Jul 17 16:56:36 2009 UTC

Diff Legend

Comparing AnyEvent-HTTP/HTTP.pm (file contents):
Revision 1.10 by root, Thu Jun 5 13:06:43 2008 UTC vs.
Revision 1.45 by root, Fri Jul 17 16:56:36 2009 UTC