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

Comparing AnyEvent-HTTP/HTTP.pm (file contents):
Revision 1.9 by root, Wed Jun 4 13:51:53 2008 UTC vs.
Revision 1.42 by root, Mon Jul 6 00:08:16 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.452 ();
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.12';
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 = 2;
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
79	name.	106	pseudo-header C<URL> contains the original URL (which can differ from the
		107	requested URL when following redirects).
		108
		109	If the server sends a header multiple times, then their contents will be
		110	joined together with a comma (C<,>), as per the HTTP spec.
80		111
81	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,
82	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>
83	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.
84		116
85	A typical callback might look like this:	117	A typical callback might look like this:
86		118
87	sub {	119	sub {
88	my ($body, $hdr) = @_;	120	my ($body, $hdr) = @_;
…		…
104	Whether to recurse requests or not, e.g. on redirects, authentication	136	Whether to recurse requests or not, e.g. on redirects, authentication
105	retries and so on, and how often to do so.	137	retries and so on, and how often to do so.
106		138
107	=item headers => hashref	139	=item headers => hashref
108		140
109	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:>.
110		144
111	=item timeout => $seconds	145	=item timeout => $seconds
112		146
113	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
114	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.
…		…
123		157
124	=item body => $string	158	=item body => $string
125		159
126	The request body, usually empty. Will be-sent as-is (future versions of	160	The request body, usually empty. Will be-sent as-is (future versions of
127	this module might offer more options).	161	this module might offer more options).
		162
		163	=item cookie_jar => $hash_ref
		164
		165	Passing this parameter enables (simplified) cookie-processing, loosely
		166	based on the original netscape specification.
		167
		168	The C<$hash_ref> must be an (initially empty) hash reference which will
		169	get updated automatically. It is possible to save the cookie_jar to
		170	persistent storage with something like JSON or Storable, but this is not
		171	recommended, as expiry times are currently being ignored.
		172
		173	Note that this cookie implementation is not of very high quality, nor
		174	meant to be complete. If you want complete cookie management you have to
		175	do that on your own. C<cookie_jar> is meant as a quick fix to get some
		176	cookie-using sites working. Cookies are a privacy disaster, do not use
		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>.
		227
		228	=item want_body_handle => $enable
		229
		230	When enabled (default is disabled), the behaviour of AnyEvent::HTTP
		231	changes considerably: after parsing the headers, and instead of
		232	downloading the body (if any), the completion callback will be
		233	called. Instead of the C<$body> argument containing the body data, the
		234	callback will receive the L<AnyEvent::Handle> object associated with the
		235	connection. In error cases, C<undef> will be passed. When there is no body
		236	(e.g. status C<304>), the empty string will be passed.
		237
		238	The handle object might or might not be in TLS mode, might be connected to
		239	a proxy, be a persistent connection etc., and configured in unspecified
		240	ways. The user is responsible for this handle (it will not be used by this
		241	module anymore).
		242
		243	This is useful with some push-type services, where, after the initial
		244	headers, an interactive protocol is used (typical example would be the
		245	push-style twitter API which starts a JSON/XML stream).
		246
		247	If you think you need this, first have a look at C<on_body>, to see if
		248	that doesn'T solve your problem in a better way.
128		249
129	=back	250	=back
130		251
131	Example: make a simple HTTP GET request for http://www.nethype.de/	252	Example: make a simple HTTP GET request for http://www.nethype.de/
132		253
…		…
146	use Data::Dumper;	267	use Data::Dumper;
147	print Dumper $hdr;	268	print Dumper $hdr;
148	}	269	}
149	;	270	;
150		271
		272	Example: make another simple HTTP GET request, but immediately try to
		273	cancel it.
		274
		275	my $request = http_request GET => "http://www.nethype.de/", sub {
		276	my ($body, $hdr) = @_;
		277	print "$body\n";
		278	};
		279
		280	undef $request;
		281
151	=cut	282	=cut
152		283
		284	sub _slot_schedule;
		285	sub _slot_schedule($) {
		286	my $host = shift;
		287
		288	while ($CO_SLOT{$host}[0] < $MAX_PER_HOST) {
		289	if (my $cb = shift @{ $CO_SLOT{$host}[1] }) {
		290	# somebody wants that slot
		291	++$CO_SLOT{$host}[0];
		292	++$ACTIVE;
		293
		294	$cb->(AnyEvent::Util::guard {
		295	--$ACTIVE;
		296	--$CO_SLOT{$host}[0];
		297	_slot_schedule $host;
		298	});
		299	} else {
		300	# nobody wants the slot, maybe we can forget about it
		301	delete $CO_SLOT{$host} unless $CO_SLOT{$host}[0];
		302	last;
		303	}
		304	}
		305	}
		306
		307	# wait for a free slot on host, call callback
		308	sub _get_slot($$) {
		309	push @{ $CO_SLOT{$_[0]}[1] }, $_[1];
		310
		311	_slot_schedule $_[0];
		312	}
		313
		314	our $qr_nl = qr<\015?\012>;
		315	our $qr_nlnl = qr<\015?\012\015?\012>;
		316
		317	our $TLS_CTX_LOW = { cache => 1, sslv2 => 1 };
		318	our $TLS_CTX_HIGH = { cache => 1, verify => 1, verify_peername => "https" };
		319
153	sub http_request($$$;@) {	320	sub http_request($$@) {
154	my $cb = pop;	321	my $cb = pop;
155	my ($method, $url, %arg) = @_;	322	my ($method, $url, %arg) = @_;
156		323
157	my %hdr;	324	my %hdr;
		325
		326	$arg{tls_ctx} = $TLS_CTX_LOW if $arg{tls_ctx} eq "low" \|\| !exists $arg{tls_ctx};
		327	$arg{tls_ctx} = $TLS_CTX_HIGH if $arg{tls_ctx} eq "high";
158		328
159	$method = uc $method;	329	$method = uc $method;
160		330
161	if (my $hdr = $arg{headers}) {	331	if (my $hdr = $arg{headers}) {
162	while (my ($k, $v) = each %$hdr) {	332	while (my ($k, $v) = each %$hdr) {
163	$hdr{lc $k} = $v;	333	$hdr{lc $k} = $v;
164	}	334	}
165	}	335	}
166		336
167	my $recurse = exists $arg{recurse} ? $arg{recurse} : $MAX_RECURSE;	337	my $recurse = exists $arg{recurse} ? delete $arg{recurse} : $MAX_RECURSE;
168		338
169	return $cb->(undef, { Status => 599, Reason => "recursion limit reached" })	339	return $cb->(undef, { Status => 599, Reason => "Too many redirections", URL => $url })
170	if $recurse < 0;	340	if $recurse < 0;
171		341
172	my $proxy = $arg{proxy} \|\| $PROXY;	342	my $proxy = $arg{proxy} \|\| $PROXY;
173	my $timeout = $arg{timeout} \|\| $TIMEOUT;	343	my $timeout = $arg{timeout} \|\| $TIMEOUT;
174		344
		345	my ($uscheme, $uauthority, $upath, $query, $fragment) =
		346	$url =~ m\|(?:([^:/?#]+):)?(?://([^/?#]))?([^?#])(?:\?([^#]))?(?:#(.))?\|;
		347
		348	$uscheme = lc $uscheme;
		349
		350	my $uport = $uscheme eq "http" ? 80
		351	: $uscheme eq "https" ? 443
		352	: return $cb->(undef, { Status => 599, Reason => "Only http and https URL schemes supported", URL => $url });
		353
		354	$uauthority =~ /^(?: .*\@ )? ([^\@:]+) (?: : (\d+) )?$/x
		355	or return $cb->(undef, { Status => 599, Reason => "Unparsable URL", URL => $url });
		356
		357	my $uhost = $1;
		358	$uport = $2 if defined $2;
		359
		360	$uhost =~ s/^\[(.*)\]$/$1/;
		361	$upath .= "?$query" if length $query;
		362
		363	$upath =~ s%^/?%/%;
		364
		365	# cookie processing
		366	if (my $jar = $arg{cookie_jar}) {
		367	%$jar = () if $jar->{version} != 1;
		368
		369	my @cookie;
		370
		371	while (my ($chost, $v) = each %$jar) {
		372	if ($chost =~ /^\./) {
		373	next unless $chost eq substr $uhost, -length $chost;
		374	} elsif ($chost =~ /\./) {
		375	next unless $chost eq $uhost;
		376	} else {
		377	next;
		378	}
		379
		380	while (my ($cpath, $v) = each %$v) {
		381	next unless $cpath eq substr $upath, 0, length $cpath;
		382
		383	while (my ($k, $v) = each %$v) {
		384	next if $uscheme ne "https" && exists $v->{secure};
		385	my $value = $v->{value};
		386	$value =~ s/([\\"])/\\$1/g;
		387	push @cookie, "$k=\"$value\"";
		388	}
		389	}
		390	}
		391
		392	$hdr{cookie} = join "; ", @cookie
		393	if @cookie;
		394	}
		395
		396	my ($rhost, $rport, $rscheme, $rpath); # request host, port, path
		397
		398	if ($proxy) {
		399	($rpath, $rhost, $rport, $rscheme) = ($url, @$proxy);
		400
		401	# don't support https requests over https-proxy transport,
		402	# can't be done with tls as spec'ed, unless you double-encrypt.
		403	$rscheme = "http" if $uscheme eq "https" && $rscheme eq "https";
		404	} else {
		405	($rhost, $rport, $rscheme, $rpath) = ($uhost, $uport, $uscheme, $upath);
		406	}
		407
175	$hdr{"user-agent"} \|\|= $USERAGENT;	408	$hdr{"user-agent"} \|\|= $USERAGENT;
		409	$hdr{referer} \|\|= "$uscheme://$uauthority$upath"; # leave out fragment and query string, just a heuristic
176		410
177	my ($host, $port, $path, $scheme);	411	$hdr{host} = "$uhost:$uport";
178
179	if ($proxy) {
180	($host, $port, $scheme) = @$proxy;
181	$path = $url;
182	} else {
183	($scheme, my $authority, $path, my $query, my $fragment) =
184	$url =~ m\|(?:([^:/?#]+):)?(?://([^/?#]))?([^?#])(?:\?([^#]))?(?:#(.))?\|;
185
186	$port = $scheme eq "http" ? 80
187	: $scheme eq "https" ? 443
188	: return $cb->(undef, { Status => 599, Reason => "$url: only http and https URLs supported" });
189
190	$authority =~ /^(?: .*\@ )? ([^\@:]+) (?: : (\d+) )?$/x
191	or return $cb->(undef, { Status => 599, Reason => "$url: unparsable URL" });
192
193	$host = $1;
194	$port = $2 if defined $2;
195
196	$host =~ s/^\[(.*)\]$/$1/;
197	$path .= "?$query" if length $query;
198
199	$path = "/" unless $path;
200
201	$hdr{host} = $host = lc $host;
202	}
203
204	$scheme = lc $scheme;
205
206	my %state;
207
208	$hdr{"content-length"} = length $arg{body};	412	$hdr{"content-length"} = length $arg{body};
209		413
		414	my %state = (connect_guard => 1);
		415
		416	_get_slot $uhost, sub {
		417	$state{slot_guard} = shift;
		418
		419	return unless $state{connect_guard};
		420
210	$state{connect_guard} = AnyEvent::Socket::tcp_connect $host, $port, sub {	421	$state{connect_guard} = AnyEvent::Socket::tcp_connect $rhost, $rport, sub {
211	$state{fh} = shift	422	$state{fh} = shift
212	or return $cb->(undef, { Status => 599, Reason => "$!" });	423	or return (%state = (), $cb->(undef, { Status => 599, Reason => "$!", URL => $url }));
		424	pop; # free memory, save a tree
213		425
214	delete $state{connect_guard}; # reduce memory usage, save a tree	426	return unless delete $state{connect_guard};
215		427
216	# get handle	428	# get handle
217	$state{handle} = new AnyEvent::Handle	429	$state{handle} = new AnyEvent::Handle
218	fh => $state{fh},	430	fh => $state{fh},
219	($scheme eq "https" ? (tls => "connect") : ());	431	timeout => $timeout,
		432	peername => $rhost,
		433	tls_ctx => $arg{tls_ctx};
220		434
221	# limit the number of persistent connections	435	# limit the number of persistent connections
		436	# keepalive not yet supported
222	if ($KA_COUNT{$_[1]} < $MAX_PERSISTENT_PER_HOST) {	437	if ($KA_COUNT{$_[1]} < $MAX_PERSISTENT_PER_HOST) {
223	++$KA_COUNT{$_[1]};	438	++$KA_COUNT{$_[1]};
224	$state{handle}{ka_count_guard} = AnyEvent::Util::guard { --$KA_COUNT{$_[1]} };	439	$state{handle}{ka_count_guard} = AnyEvent::Util::guard {
		440	--$KA_COUNT{$_[1]}
		441	};
225	$hdr{connection} = "keep-alive";	442	$hdr{connection} = "keep-alive";
226	delete $hdr{connection}; # keep-alive not yet supported
227	} else {	443	} else {
228	delete $hdr{connection};	444	delete $hdr{connection};
229	}	445	}
230		446
231	# (re-)configure handle	447	# (re-)configure handle
232	$state{handle}->timeout ($timeout);
233	$state{handle}->on_error (sub {	448	$state{handle}->on_error (sub {
234	%state = ();	449	%state = ();
235	$cb->(undef, { Status => 599, Reason => "$!" });	450	$cb->(undef, { Status => 599, Reason => $_[2], URL => $url });
236	});	451	});
237	$state{handle}->on_eof (sub {	452	$state{handle}->on_eof (sub {
238	%state = ();	453	%state = ();
239	$cb->(undef, { Status => 599, Reason => "unexpected end-of-file" });	454	$cb->(undef, { Status => 599, Reason => "Unexpected end-of-file", URL => $url });
240	});
241
242	# send request
243	$state{handle}->push_write (
244	"$method $path HTTP/1.0\015\012"
245	. (join "", map "$_: $hdr{$_}\015\012", keys %hdr)
246	. "\015\012"
247	. (delete $arg{body})
248	);
249
250	%hdr = (); # reduce memory usage, save a kitten
251
252	# status line
253	$state{handle}->push_read (line => qr/\015?\012/, sub {
254	$_[1] =~ /^HTTP\/([0-9\.]+) \s+ ([0-9]{3}) \s+ ([^\015\012]+)/ix
255	or return (%state = (), $cb->(undef, { Status => 599, Reason => "invalid server response ($_[1])" }));
256
257	my %hdr = ( # response headers
258	HTTPVersion => ",$1",
259	Status => ",$2",
260	Reason => ",$3",
261	);	455	});
262		456
		457	$state{handle}->starttls ("connect") if $rscheme eq "https";
		458
		459	# handle actual, non-tunneled, request
		460	my $handle_actual_request = sub {
		461	$state{handle}->starttls ("connect") if $uscheme eq "https" && !exists $state{handle}{tls};
		462
		463	# send request
		464	$state{handle}->push_write (
		465	"$method $rpath HTTP/1.0\015\012"
		466	. (join "", map "\u$_: $hdr{$_}\015\012", keys %hdr)
		467	. "\015\012"
		468	. (delete $arg{body})
		469	);
		470
		471	%hdr = (); # reduce memory usage, save a kitten
		472
		473	# status line
		474	$state{handle}->push_read (line => $qr_nl, sub {
		475	$_[1] =~ /^HTTP\/([0-9\.]+) \s+ ([0-9]{3}) (?: \s+ ([^\015\012]*) )?/ix
		476	or return (%state = (), $cb->(undef, { Status => 599, Reason => "Invalid server response ($_[1])", URL => $url }));
		477
		478	my %hdr = ( # response headers
		479	HTTPVersion => ",$1",
		480	Status => ",$2",
		481	Reason => ",$3",
		482	URL => ",$url"
		483	);
		484
263	# headers, could be optimized a bit	485	# headers, could be optimized a bit
264	$state{handle}->unshift_read (line => qr/\015?\012\015?\012/, sub {	486	$state{handle}->unshift_read (line => $qr_nlnl, sub {
265	for ("$_[1]\012") {	487	for ("$_[1]\012") {
266	# we support spaces in field names, as lotus domino	488	y/\015//d; # weed out any \015, as they show up in the weirdest of places.
267	# creates them.	489
		490	# things seen, not parsed:
		491	# p3pP="NON CUR OTPi OUR NOR UNI"
		492
268	$hdr{lc $1} .= ",$2"	493	$hdr{lc $1} .= ",$2"
269	while /\G	494	while /\G
270	([^:\000-\037]+):	495	([^:\000-\037]+):
271	[\011\040]*	496	[\011\040]*
272	((?: [^\015\012]+ \| \015?\012[\011\040] )*)	497	((?: [^\012]+ \| \012[\011\040] )*)
273	\015?\012	498	\012
274	/gxc;	499	/gxc;
275		500
276	/\G$/	501	/\G$/
277	or return $cb->(undef, { Status => 599, Reason => "garbled response headers" });	502	or return (%state = (), $cb->(undef, { Status => 599, Reason => "Garbled response headers", URL => $url }));
		503	}
		504
		505	substr $_, 0, 1, ""
		506	for values %hdr;
		507
		508	# redirect handling
		509	# microsoft and other shitheads don't give a shit for following standards,
		510	# try to support some common forms of broken Location headers.
		511	if ($hdr{location} !~ /^(?: $ \| [^:\/?\#]+ : )/x) {
		512	$hdr{location} =~ s/^\.\/+//;
		513
		514	my $url = "$rscheme://$uhost:$uport";
		515
		516	unless ($hdr{location} =~ s/^\///) {
		517	$url .= $upath;
		518	$url =~ s/\/[^\/]*$//;
		519	}
		520
		521	$hdr{location} = "$url/$hdr{location}";
		522	}
		523
		524	my $redirect;
		525
		526	if ($recurse) {
		527	if ($hdr{Status} =~ /^30[12]$/ && $method ne "POST") {
		528	# apparently, mozilla et al. just change POST to GET here
		529	# more research is needed before we do the same
		530	$redirect = 1;
		531	} elsif ($hdr{Status} == 303) {
		532	# even http/1.1 is unclear on how to mutate the method
		533	$method = "GET" unless $method eq "HEAD";
		534	$redirect = 1;
		535	} elsif ($hdr{Status} == 307 && $method =~ /^(?:GET\|HEAD)$/) {
		536	$redirect = 1;
		537	}
		538	}
		539
		540	my $finish = sub {
		541	$state{handle}->destroy if $state{handle};
		542	%state = ();
		543
		544	# set-cookie processing
		545	if ($arg{cookie_jar}) {
		546	for ($_[1]{"set-cookie"}) {
		547	# parse NAME=VALUE
		548	my @kv;
		549
		550	while (/\G\s* ([^=;,[:space:]]+) \s=\s (?: "((?:[^\\"]+\|\\.))" \| ([^=;,[:space:]]) )/gcxs) {
		551	my $name = $1;
		552	my $value = $3;
		553
		554	unless ($value) {
		555	$value = $2;
		556	$value =~ s/\\(.)/$1/gs;
		557	}
		558
		559	push @kv, $name => $value;
		560
		561	last unless /\G\s*;/gc;
		562	}
		563
		564	last unless @kv;
		565
		566	my $name = shift @kv;
		567	my %kv = (value => shift @kv, @kv);
		568
		569	my $cdom;
		570	my $cpath = (delete $kv{path}) \|\| "/";
		571
		572	if (exists $kv{domain}) {
		573	$cdom = delete $kv{domain};
		574
		575	$cdom =~ s/^\.?/./; # make sure it starts with a "."
		576
		577	next if $cdom =~ /\.$/;
		578
		579	# this is not rfc-like and not netscape-like. go figure.
		580	my $ndots = $cdom =~ y/.//;
		581	next if $ndots < ($cdom =~ /\.[^.][^.]\.[^.][^.]$/ ? 3 : 2);
		582	} else {
		583	$cdom = $uhost;
		584	}
		585
		586	# store it
		587	$arg{cookie_jar}{version} = 1;
		588	$arg{cookie_jar}{$cdom}{$cpath}{$name} = \%kv;
		589
		590	redo if /\G\s*,/gc;
		591	}
		592	}
		593
		594	if ($redirect) {
		595	# we ignore any errors, as it is very common to receive
		596	# Content-Length != 0 but no actual body
		597	# we also access %hdr, as $_[1] might be an erro
		598	http_request ($method => $hdr{location}, %arg, recurse => $recurse - 1, $cb);
		599	} else {
		600	$cb->($_[0], $_[1]);
		601	}
		602	};
		603
		604	my $len = $hdr{"content-length"};
		605
		606	if (!$redirect && $arg{on_header} && !$arg{on_header}(\%hdr)) {
		607	$finish->(undef, { Status => 598, Reason => "Request cancelled by on_header", URL => $url });
		608	} elsif (
		609	$hdr{Status} =~ /^(?:1..\|[23]04)$/
		610	or $method eq "HEAD"
		611	or (defined $len && !$len)
		612	) {
		613	# no body
		614	$finish->("", \%hdr);
		615	} else {
		616	# body handling, four different code paths
		617	# for want_body_handle, on_body (2x), normal (2x)
		618	# we might read too much here, but it does not matter yet (no pers. connections)
		619	if (!$redirect && $arg{want_body_handle}) {
		620	$_[0]->on_eof (undef);
		621	$_[0]->on_error (undef);
		622	$_[0]->on_read (undef);
		623
		624	$finish->(delete $state{handle}, \%hdr);
		625
		626	} elsif ($arg{on_body}) {
		627	$_[0]->on_error (sub { $finish->(undef, { Status => 599, Reason => $_[2], URL => $url }) });
		628	if ($len) {
		629	$_[0]->on_eof (undef);
		630	$_[0]->on_read (sub {
		631	$len -= length $_[0]{rbuf};
		632
		633	$arg{on_body}(delete $_[0]{rbuf}, \%hdr)
		634	or $finish->(undef, { Status => 598, Reason => "Request cancelled by on_body", URL => $url });
		635
		636	$len > 0
		637	or $finish->("", \%hdr);
		638	});
		639	} else {
		640	$_[0]->on_eof (sub {
		641	$finish->("", \%hdr);
		642	});
		643	$_[0]->on_read (sub {
		644	$arg{on_body}(delete $_[0]{rbuf}, \%hdr)
		645	or $finish->(undef, { Status => 598, Reason => "Request cancelled by on_body", URL => $url });
		646	});
		647	}
		648	} else {
		649	$_[0]->on_eof (undef);
		650
		651	if ($len) {
		652	$_[0]->on_error (sub { $finish->(undef, { Status => 599, Reason => $_[2], URL => $url }) });
		653	$_[0]->on_read (sub {
		654	$finish->((substr delete $_[0]{rbuf}, 0, $len, ""), \%hdr)
		655	if $len <= length $_[0]{rbuf};
		656	});
		657	} else {
		658	$_[0]->on_error (sub {
		659	$! == Errno::EPIPE
		660	? $finish->(delete $_[0]{rbuf}, \%hdr)
		661	: $finish->(undef, { Status => 599, Reason => $_[2], URL => $url });
		662	});
		663	$_[0]->on_read (sub { });
		664	}
		665	}
		666	}
		667	});
278	}	668	});
		669	};
279		670
280	substr $_, 0, 1, ""	671	# now handle proxy-CONNECT method
281	for values %hdr;	672	if ($proxy && $uscheme eq "https") {
		673	# oh dear, we have to wrap it into a connect request
282		674
283	my $finish = sub {	675	# maybe re-use $uauthority with patched port?
284	if ($_[1]{Status} =~ /^30[12]$/ && $recurse) {	676	$state{handle}->push_write ("CONNECT $uhost:$uport HTTP/1.0\015\012Host: $uhost\015\012\015\012");
285	http_request ($method, $_[1]{location}, %arg, recurse => $recurse - 1, $cb);	677	$state{handle}->push_read (line => $qr_nlnl, sub {
		678	$_[1] =~ /^HTTP\/([0-9\.]+) \s+ ([0-9]{3}) (?: \s+ ([^\015\012]*) )?/ix
		679	or return (%state = (), $cb->(undef, { Status => 599, Reason => "Invalid proxy connect response ($_[1])", URL => $url }));
		680
		681	if ($2 == 200) {
		682	$rpath = $upath;
		683	&$handle_actual_request;
286	} else {	684	} else {
287	$cb->($_[0], $_[1]);	685	%state = ();
		686	$cb->(undef, { Status => $2, Reason => $3, URL => $url });
288	}	687	}
289	};	688	});
290
291	if ($hdr{Status} =~ /^(?:1..\|204\|304)$/ or $method eq "HEAD") {
292	%state = ();
293	$finish->(undef, \%hdr);
294	} else {	689	} else {
295	if (exists $hdr{"content-length"}) {	690	&$handle_actual_request;
296	$_[0]->unshift_read (chunk => $hdr{"content-length"}, sub {
297	# could cache persistent connection now
298	if ($hdr{connection} =~ /\bkeep-alive\b/i) {
299	# but we don't, due to misdesigns, this is annoyingly complex
300	};
301
302	%state = ();
303	$finish->($_[1], \%hdr);
304	});
305	} else {
306	# too bad, need to read until we get an error or EOF,
307	# no way to detect winged data.
308	$_[0]->on_error (sub {
309	%state = ();
310	$finish->($_[0]{rbuf}, \%hdr);
311	});
312	$_[0]->on_eof (undef);
313	$_[0]->on_read (sub { });
314	}
315	}
316	});	691	}
		692
		693	}, sub {
		694	$timeout
317	});	695	};
318	}, sub {
319	$timeout
320	};	696	};
321		697
322	defined wantarray && AnyEvent::Util::guard { %state = () }	698	defined wantarray && AnyEvent::Util::guard { %state = () }
323	}	699	}
324		700
325	sub http_get($$;@) {	701	sub http_get($@) {
326	unshift @_, "GET";	702	unshift @_, "GET";
327	&http_request	703	&http_request
328	}	704	}
329		705
330	sub http_head($$;@) {	706	sub http_head($@) {
331	unshift @_, "HEAD";	707	unshift @_, "HEAD";
332	&http_request	708	&http_request
333	}	709	}
334		710
335	sub http_post($$$;@) {	711	sub http_post($$@) {
		712	my $url = shift;
336	unshift @_, "POST", "body";	713	unshift @_, "POST", $url, "body";
337	&http_request	714	&http_request
338	}	715	}
339		716
340	=back	717	=back
341		718
…		…
353	The default value for the C<recurse> request parameter (default: C<10>).	730	The default value for the C<recurse> request parameter (default: C<10>).
354		731
355	=item $AnyEvent::HTTP::USERAGENT	732	=item $AnyEvent::HTTP::USERAGENT
356		733
357	The default value for the C<User-Agent> header (the default is	734	The default value for the C<User-Agent> header (the default is
358	C<Mozilla/5.0 (compatible; AnyEvent::HTTP/$VERSION; +http://software.schmorp.de/pkg/AnyEvent)>).	735	C<Mozilla/5.0 (compatible; U; AnyEvent-HTTP/$VERSION; +http://software.schmorp.de/pkg/AnyEvent)>).
359		736
360	=item $AnyEvent::HTTP::MAX_PERSISTENT	737	=item $AnyEvent::HTTP::MAX_PERSISTENT
361		738
362	The maximum number of persistent connections to keep open (default: 8).	739	The maximum number of persistent connections to keep open (default: 8).
363		740
…		…
366	=item $AnyEvent::HTTP::PERSISTENT_TIMEOUT	743	=item $AnyEvent::HTTP::PERSISTENT_TIMEOUT
367		744
368	The maximum time to cache a persistent connection, in seconds (default: 2).	745	The maximum time to cache a persistent connection, in seconds (default: 2).
369		746
370	Not implemented currently.	747	Not implemented currently.
		748
		749	=item $AnyEvent::HTTP::ACTIVE
		750
		751	The number of active connections. This is not the number of currently
		752	running requests, but the number of currently open and non-idle TCP
		753	connections. This number of can be useful for load-leveling.
371		754
372	=back	755	=back
373		756
374	=cut	757	=cut
375		758
…		…
384		767
385	L<AnyEvent>.	768	L<AnyEvent>.
386		769
387	=head1 AUTHOR	770	=head1 AUTHOR
388		771
389	Marc Lehmann <schmorp@schmorp.de>	772	Marc Lehmann <schmorp@schmorp.de>
390	http://home.schmorp.de/	773	http://home.schmorp.de/
		774
		775	With many thanks to Дмитрий Шалашов, who provided countless
		776	testcases and bugreports.
391		777
392	=cut	778	=cut
393		779
394	1	780	1
395		781

Diff Legend

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

Comparing AnyEvent-HTTP/HTTP.pm (file contents): Revision 1.9 by root, Wed Jun 4 13:51:53 2008 UTC vs. Revision 1.42 by root, Mon Jul 6 00:08:16 2009 UTC

Diff Legend

Comparing AnyEvent-HTTP/HTTP.pm (file contents):
Revision 1.9 by root, Wed Jun 4 13:51:53 2008 UTC vs.
Revision 1.42 by root, Mon Jul 6 00:08:16 2009 UTC