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

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

Diff Legend

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

Comparing AnyEvent-HTTP/HTTP.pm (file contents): Revision 1.4 by root, Wed Jun 4 11:59:22 2008 UTC vs. Revision 1.52 by root, Sat Sep 26 10:13:12 2009 UTC

Diff Legend

Comparing AnyEvent-HTTP/HTTP.pm (file contents):
Revision 1.4 by root, Wed Jun 4 11:59:22 2008 UTC vs.
Revision 1.52 by root, Sat Sep 26 10:13:12 2009 UTC