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

Comparing AnyEvent-HTTP/HTTP.pm (file contents):
Revision 1.11 by root, Thu Jun 5 15:34:00 2008 UTC vs.
Revision 1.87 by root, Sun Jan 2 08:51:53 2011 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.
…		…
32		36
33	=cut	37	=cut
34		38
35	package AnyEvent::HTTP;	39	package AnyEvent::HTTP;
36		40
37	use strict;	41	use common::sense;
38	no warnings;
39		42
40	use Carp;	43	use Errno ();
41		44
42	use AnyEvent ();	45	use AnyEvent 5.0 ();
43	use AnyEvent::Util ();	46	use AnyEvent::Util ();
44	use AnyEvent::Socket ();
45	use AnyEvent::Handle ();	47	use AnyEvent::Handle ();
46		48
47	use base Exporter::;	49	use base Exporter::;
48		50
49	our $VERSION = '1.0';	51	our $VERSION = '1.5';
50		52
51	our @EXPORT = qw(http_get http_request);	53	our @EXPORT = qw(http_get http_post http_head http_request);
52		54
53	our $USERAGENT = "Mozilla/5.0 (compatible; AnyEvent::HTTP/$VERSION; +http://software.schmorp.de/pkg/AnyEvent)";	55	our $USERAGENT = "Mozilla/5.0 (compatible; U; AnyEvent-HTTP/$VERSION; +http://software.schmorp.de/pkg/AnyEvent)";
54	our $MAX_RECURSE = 10;	56	our $MAX_RECURSE = 10;
55	our $MAX_PERSISTENT = 8;	57	our $MAX_PERSISTENT = 8;
56	our $PERSISTENT_TIMEOUT = 2;	58	our $PERSISTENT_TIMEOUT = 2;
57	our $TIMEOUT = 300;	59	our $TIMEOUT = 300;
58		60
59	# changing these is evil	61	# changing these is evil
60	our $MAX_PERSISTENT_PER_HOST = 2;	62	our $MAX_PERSISTENT_PER_HOST = 0;
61	our $MAX_PER_HOST = 4;	63	our $MAX_PER_HOST = 4;
62		64
63	our $PROXY;	65	our $PROXY;
		66	our $ACTIVE = 0;
64		67
65	my %KA_COUNT; # number of open keep-alive connections per host	68	my %KA_COUNT; # number of open keep-alive connections per host
66	my %CO_SLOT; # number of open connections, and wait queue, per host	69	my %CO_SLOT; # number of open connections, and wait queue, per host
67		70
68	=item http_get $url, key => value..., $cb->($data, $headers)	71	=item http_get $url, key => value..., $cb->($data, $headers)
69		72
70	Executes an HTTP-GET request. See the http_request function for details on	73	Executes an HTTP-GET request. See the http_request function for details on
71	additional parameters.	74	additional parameters and the return value.
72		75
73	=item http_head $url, key => value..., $cb->($data, $headers)	76	=item http_head $url, key => value..., $cb->($data, $headers)
74		77
75	Executes an HTTP-HEAD request. See the http_request function for details on	78	Executes an HTTP-HEAD request. See the http_request function for details
76	additional parameters.	79	on additional parameters and the return value.
77		80
78	=item http_post $url, $body, key => value..., $cb->($data, $headers)	81	=item http_post $url, $body, key => value..., $cb->($data, $headers)
79		82
80	Executes an HTTP-POST request with a request body of C<$bod>. See the	83	Executes an HTTP-POST request with a request body of C<$body>. See the
81	http_request function for details on additional parameters.	84	http_request function for details on additional parameters and the return
		85	value.
82		86
83	=item http_request $method => $url, key => value..., $cb->($data, $headers)	87	=item http_request $method => $url, key => value..., $cb->($data, $headers)
84		88
85	Executes a HTTP request of type C<$method> (e.g. C<GET>, C<POST>). The URL	89	Executes a HTTP request of type C<$method> (e.g. C<GET>, C<POST>). The URL
86	must be an absolute http or https URL.	90	must be an absolute http or https URL.
87		91
		92	When called in void context, nothing is returned. In other contexts,
		93	C<http_request> returns a "cancellation guard" - you have to keep the
		94	object at least alive until the callback get called. If the object gets
		95	destroyed before the callback is called, the request will be cancelled.
		96
88	The callback will be called with the response data as first argument	97	The callback will be called with the response body data as first argument
89	(or C<undef> if it wasn't available due to errors), and a hash-ref with	98	(or C<undef> if an error occured), and a hash-ref with response headers
90	response headers as second argument.	99	(and trailers) as second argument.
91		100
92	All the headers in that hash are lowercased. In addition to the response	101	All the headers in that hash are lowercased. In addition to the response
93	headers, the three "pseudo-headers" C<HTTPVersion>, C<Status> and	102	headers, the "pseudo-headers" (uppercase to avoid clashing with possible
94	C<Reason> contain the three parts of the HTTP Status-Line of the same	103	response headers) C<HTTPVersion>, C<Status> and C<Reason> contain the
		104	three parts of the HTTP Status-Line of the same name. If an error occurs
		105	during the body phase of a request, then the original C<Status> and
		106	C<Reason> values from the header are available as C<OrigStatus> and
		107	C<OrigReason>.
		108
		109	The pseudo-header C<URL> contains the actual URL (which can differ from
		110	the requested URL when following redirects - for example, you might get
		111	an error that your URL scheme is not supported even though your URL is a
		112	valid http URL because it redirected to an ftp URL, in which case you can
		113	look at the URL pseudo header).
		114
		115	The pseudo-header C<Redirect> only exists when the request was a result
		116	of an internal redirect. In that case it is an array reference with
		117	the C<($data, $headers)> from the redirect response. Note that this
		118	response could in turn be the result of a redirect itself, and C<<
		119	$headers->{Redirect}[1]{Redirect} >> will then contain the original
		120	response, and so on.
		121
95	name. If the server sends a header multiple lines, then their contents	122	If the server sends a header multiple times, then their contents will be
96	will be joined together with C<\x00>.	123	joined together with a comma (C<,>), as per the HTTP spec.
97		124
98	If an internal error occurs, such as not being able to resolve a hostname,	125	If an internal error occurs, such as not being able to resolve a hostname,
99	then C<$data> will be C<undef>, C<< $headers->{Status} >> will be C<599>	126	then C<$data> will be C<undef>, C<< $headers->{Status} >> will be
100	and the C<Reason> pseudo-header will contain an error message.	127	C<590>-C<599> and the C<Reason> pseudo-header will contain an error
		128	message. Currently the following status codes are used:
		129
		130	=over 4
		131
		132	=item 595 - errors during connection etsbalishment, proxy handshake.
		133
		134	=item 596 - errors during TLS negotiation, request sending and header processing.
		135
		136	=item 597 - errors during body receiving or processing.
		137
		138	=item 598 - user aborted request via C<on_header> or C<on_body>.
		139
		140	=item 599 - other, usually nonretryable, errors (garbled URL etc.).
		141
		142	=back
101		143
102	A typical callback might look like this:	144	A typical callback might look like this:
103		145
104	sub {	146	sub {
105	my ($body, $hdr) = @_;	147	my ($body, $hdr) = @_;
…		…
121	Whether to recurse requests or not, e.g. on redirects, authentication	163	Whether to recurse requests or not, e.g. on redirects, authentication
122	retries and so on, and how often to do so.	164	retries and so on, and how often to do so.
123		165
124	=item headers => hashref	166	=item headers => hashref
125		167
126	The request headers to use.	168	The request headers to use. Currently, C<http_request> may provide its own
		169	C<Host:>, C<Content-Length:>, C<Connection:> and C<Cookie:> headers and
		170	will provide defaults at least for C<TE:>, C<Referer:> and C<User-Agent:>
		171	(this can be suppressed by using C<undef> for these headers in which case
		172	they won't be sent at all).
127		173
128	=item timeout => $seconds	174	=item timeout => $seconds
129		175
130	The time-out to use for various stages - each connect attempt will reset	176	The time-out to use for various stages - each connect attempt will reset
131	the timeout, as will read or write activity. Default timeout is 5 minutes.	177	the timeout, as will read or write activity, i.e. this is not an overall
		178	timeout.
		179
		180	Default timeout is 5 minutes.
132		181
133	=item proxy => [$host, $port[, $scheme]] or undef	182	=item proxy => [$host, $port[, $scheme]] or undef
134		183
135	Use the given http proxy for all requests. If not specified, then the	184	Use the given http proxy for all requests. If not specified, then the
136	default proxy (as specified by C<$ENV{http_proxy}>) is used.	185	default proxy (as specified by C<$ENV{http_proxy}>) is used.
137		186
138	C<$scheme> must be either missing or C<http> for HTTP, or C<https> for	187	C<$scheme> must be either missing, C<http> for HTTP or C<https> for
139	HTTPS.	188	HTTPS.
140		189
141	=item body => $string	190	=item body => $string
142		191
143	The request body, usually empty. Will be-sent as-is (future versions of	192	The request body, usually empty. Will be sent as-is (future versions of
144	this module might offer more options).	193	this module might offer more options).
145		194
146	=item cookie_jar => $hash_ref	195	=item cookie_jar => $hash_ref
147		196
148	Passing this parameter enables (simplified) cookie-processing, loosely	197	Passing this parameter enables (simplified) cookie-processing, loosely
149	based on the original netscape specification.	198	based on the original netscape specification.
150		199
151	The C<$hash_ref> must be an (initially empty) hash reference which will	200	The C<$hash_ref> must be an (initially empty) hash reference which
152	get updated automatically. It is possible to save the cookie_jar to	201	will get updated automatically. It is possible to save the cookie jar
153	persistent storage with something like JSON or Storable, but this is not	202	to persistent storage with something like JSON or Storable - see the
154	recommended, as expire times are currently being ignored.	203	C<AnyEvent::HTTP::cookie_jar_expire> function if you wish to remove
		204	expired or session-only cookies, and also for documentation on the format
		205	of the cookie jar.
155		206
156	Note that this cookie implementation is not of very high quality, nor	207	Note that this cookie implementation is not meant to be complete. If
157	meant to be complete. If you want complete cookie management you have to	208	you want complete cookie management you have to do that on your
158	do that on your own. C<cookie_jar> is meant as a quick fix to get some	209	own. C<cookie_jar> is meant as a quick fix to get most cookie-using sites
159	cookie-using sites working. Cookies are a privacy disaster, do not use	210	working. Cookies are a privacy disaster, do not use them unless required
160	them unless required to.	211	to.
		212
		213	When cookie processing is enabled, the C<Cookie:> and C<Set-Cookie:>
		214	headers will be set and handled by this module, otherwise they will be
		215	left untouched.
		216
		217	=item tls_ctx => $scheme \| $tls_ctx
		218
		219	Specifies the AnyEvent::TLS context to be used for https connections. This
		220	parameter follows the same rules as the C<tls_ctx> parameter to
		221	L<AnyEvent::Handle>, but additionally, the two strings C<low> or
		222	C<high> can be specified, which give you a predefined low-security (no
		223	verification, highest compatibility) and high-security (CA and common-name
		224	verification) TLS context.
		225
		226	The default for this option is C<low>, which could be interpreted as "give
		227	me the page, no matter what".
		228
		229	=item on_prepare => $callback->($fh)
		230
		231	In rare cases you need to "tune" the socket before it is used to
		232	connect (for exmaple, to bind it on a given IP address). This parameter
		233	overrides the prepare callback passed to C<AnyEvent::Socket::tcp_connect>
		234	and behaves exactly the same way (e.g. it has to provide a
		235	timeout). See the description for the C<$prepare_cb> argument of
		236	C<AnyEvent::Socket::tcp_connect> for details.
		237
		238	=item tcp_connect => $callback->($host, $service, $connect_cb, $prepare_cb)
		239
		240	In even rarer cases you want total control over how AnyEvent::HTTP
		241	establishes connections. Normally it uses L<AnyEvent::Socket::tcp_connect>
		242	to do this, but you can provide your own C<tcp_connect> function -
		243	obviously, it has to follow the same calling conventions, except that it
		244	may always return a connection guard object.
		245
		246	There are probably lots of weird uses for this function, starting from
		247	tracing the hosts C<http_request> actually tries to connect, to (inexact
		248	but fast) host => IP address caching or even socks protocol support.
		249
		250	=item on_header => $callback->($headers)
		251
		252	When specified, this callback will be called with the header hash as soon
		253	as headers have been successfully received from the remote server (not on
		254	locally-generated errors).
		255
		256	It has to return either true (in which case AnyEvent::HTTP will continue),
		257	or false, in which case AnyEvent::HTTP will cancel the download (and call
		258	the finish callback with an error code of C<598>).
		259
		260	This callback is useful, among other things, to quickly reject unwanted
		261	content, which, if it is supposed to be rare, can be faster than first
		262	doing a C<HEAD> request.
		263
		264	The downside is that cancelling the request makes it impossible to re-use
		265	the connection. Also, the C<on_header> callback will not receive any
		266	trailer (headers sent after the response body).
		267
		268	Example: cancel the request unless the content-type is "text/html".
		269
		270	on_header => sub {
		271	$_[0]{"content-type"} =~ /^text\/html\s*(?:;\|$)/
		272	},
		273
		274	=item on_body => $callback->($partial_body, $headers)
		275
		276	When specified, all body data will be passed to this callback instead of
		277	to the completion callback. The completion callback will get the empty
		278	string instead of the body data.
		279
		280	It has to return either true (in which case AnyEvent::HTTP will continue),
		281	or false, in which case AnyEvent::HTTP will cancel the download (and call
		282	the completion callback with an error code of C<598>).
		283
		284	The downside to cancelling the request is that it makes it impossible to
		285	re-use the connection.
		286
		287	This callback is useful when the data is too large to be held in memory
		288	(so the callback writes it to a file) or when only some information should
		289	be extracted, or when the body should be processed incrementally.
		290
		291	It is usually preferred over doing your own body handling via
		292	C<want_body_handle>, but in case of streaming APIs, where HTTP is
		293	only used to create a connection, C<want_body_handle> is the better
		294	alternative, as it allows you to install your own event handler, reducing
		295	resource usage.
		296
		297	=item want_body_handle => $enable
		298
		299	When enabled (default is disabled), the behaviour of AnyEvent::HTTP
		300	changes considerably: after parsing the headers, and instead of
		301	downloading the body (if any), the completion callback will be
		302	called. Instead of the C<$body> argument containing the body data, the
		303	callback will receive the L<AnyEvent::Handle> object associated with the
		304	connection. In error cases, C<undef> will be passed. When there is no body
		305	(e.g. status C<304>), the empty string will be passed.
		306
		307	The handle object might or might not be in TLS mode, might be connected to
		308	a proxy, be a persistent connection etc., and configured in unspecified
		309	ways. The user is responsible for this handle (it will not be used by this
		310	module anymore).
		311
		312	This is useful with some push-type services, where, after the initial
		313	headers, an interactive protocol is used (typical example would be the
		314	push-style twitter API which starts a JSON/XML stream).
		315
		316	If you think you need this, first have a look at C<on_body>, to see if
		317	that doesn't solve your problem in a better way.
161		318
162	=back	319	=back
163		320
164	Example: make a simple HTTP GET request for http://www.nethype.de/	321	Example: do a simple HTTP GET request for http://www.nethype.de/ and print
		322	the response body.
165		323
166	http_request GET => "http://www.nethype.de/", sub {	324	http_request GET => "http://www.nethype.de/", sub {
167	my ($body, $hdr) = @_;	325	my ($body, $hdr) = @_;
168	print "$body\n";	326	print "$body\n";
169	};	327	};
170		328
171	Example: make a HTTP HEAD request on https://www.google.com/, use a	329	Example: do a HTTP HEAD request on https://www.google.com/, use a
172	timeout of 30 seconds.	330	timeout of 30 seconds.
173		331
174	http_request	332	http_request
175	GET => "https://www.google.com",	333	GET => "https://www.google.com",
176	timeout => 30,	334	timeout => 30,
…		…
179	use Data::Dumper;	337	use Data::Dumper;
180	print Dumper $hdr;	338	print Dumper $hdr;
181	}	339	}
182	;	340	;
183		341
		342	Example: do another simple HTTP GET request, but immediately try to
		343	cancel it.
		344
		345	my $request = http_request GET => "http://www.nethype.de/", sub {
		346	my ($body, $hdr) = @_;
		347	print "$body\n";
		348	};
		349
		350	undef $request;
		351
184	=cut	352	=cut
185		353
		354	sub _slot_schedule;
186	sub _slot_schedule($) {	355	sub _slot_schedule($) {
187	my $host = shift;	356	my $host = shift;
188		357
189	while ($CO_SLOT{$host}[0] < $MAX_PER_HOST) {	358	while ($CO_SLOT{$host}[0] < $MAX_PER_HOST) {
190	if (my $cb = shift @{ $CO_SLOT{$host}[1] }) {	359	if (my $cb = shift @{ $CO_SLOT{$host}[1] }) {
191	# somebody wnats that slot	360	# somebody wants that slot
192	++$CO_SLOT{$host}[0];	361	++$CO_SLOT{$host}[0];
		362	++$ACTIVE;
193		363
194	$cb->(AnyEvent::Util::guard {	364	$cb->(AnyEvent::Util::guard {
		365	--$ACTIVE;
195	--$CO_SLOT{$host}[0];	366	--$CO_SLOT{$host}[0];
196	_slot_schedule $host;	367	_slot_schedule $host;
197	});	368	});
198	} else {	369	} else {
199	# nobody wants the slot, maybe we can forget about it	370	# nobody wants the slot, maybe we can forget about it
200	delete $CO_SLOT{$host} unless $CO_SLOT{$host}[0];	371	delete $CO_SLOT{$host} unless $CO_SLOT{$host}[0];
201	warn "$host deleted" unless $CO_SLOT{$host}[0];#d#
202	last;	372	last;
203	}	373	}
204	}	374	}
205	}	375	}
206		376
…		…
209	push @{ $CO_SLOT{$_[0]}[1] }, $_[1];	379	push @{ $CO_SLOT{$_[0]}[1] }, $_[1];
210		380
211	_slot_schedule $_[0];	381	_slot_schedule $_[0];
212	}	382	}
213		383
		384	#############################################################################
		385
		386	# expire cookies
		387	sub cookie_jar_expire($;$) {
		388	my ($jar, $session_end) = @_;
		389
		390	%$jar = () if $jar->{version} != 1;
		391
		392	my $anow = AE::now;
		393
		394	while (my ($chost, $paths) = each %$jar) {
		395	next unless ref $paths;
		396
		397	while (my ($cpath, $cookies) = each %$paths) {
		398	while (my ($cookie, $kv) = each %$cookies) {
		399	if (exists $kv->{_expires}) {
		400	delete $cookies->{$cookie}
		401	if $anow > $kv->{_expires};
		402	} elsif ($session_end) {
		403	delete $cookies->{$cookie};
		404	}
		405	}
		406
		407	delete $paths->{$cpath}
		408	unless %$cookies;
		409	}
		410
		411	delete $jar->{$chost}
		412	unless %$paths;
		413	}
		414	}
		415
		416	# extract cookies from jar
		417	sub cookie_jar_extract($$$$) {
		418	my ($jar, $uscheme, $uhost, $upath) = @_;
		419
		420	%$jar = () if $jar->{version} != 1;
		421
		422	my @cookies;
		423
		424	while (my ($chost, $paths) = each %$jar) {
		425	next unless ref $paths;
		426
		427	if ($chost =~ /^\./) {
		428	next unless $chost eq substr $uhost, -length $chost;
		429	} elsif ($chost =~ /\./) {
		430	next unless $chost eq $uhost;
		431	} else {
		432	next;
		433	}
		434
		435	while (my ($cpath, $cookies) = each %$paths) {
		436	next unless $cpath eq substr $upath, 0, length $cpath;
		437
		438	while (my ($cookie, $kv) = each %$cookies) {
		439	next if $uscheme ne "https" && exists $kv->{secure};
		440
		441	if (exists $kv->{_expires} and AE::now > $kv->{_expires}) {
		442	delete $cookies->{$cookie};
		443	next;
		444	}
		445
		446	my $value = $kv->{value};
		447
		448	if ($value =~ /[=;,[:space:]]/) {
		449	$value =~ s/([\\"])/\\$1/g;
		450	$value = "\"$value\"";
		451	}
		452
		453	push @cookies, "$cookie=$value";
		454	}
		455	}
		456	}
		457
		458	\@cookies
		459	}
		460
		461	# parse set_cookie header into jar
		462	sub cookie_jar_set_cookie($$$$) {
		463	my ($jar, $set_cookie, $uhost, $date) = @_;
		464
		465	my $anow = int AE::now;
		466	my $snow; # server-now
		467
		468	for ($set_cookie) {
		469	# parse NAME=VALUE
		470	my @kv;
		471
		472	# expires is not http-compliant in the original cookie-spec,
		473	# we support the official date format and some extensions
		474	while (
		475	m{
		476	\G\s*
		477	(?:
		478	expires \s=\s ([A-Z][a-z][a-z]+,\ [^,;]+)
		479	\| ([^=;,[:space:]]+) (?: \s=\s (?: "((?:[^\\"]+\|\\.))" \| ([^=;,[:space:]]) ) )?
		480	)
		481	}gcxsi
		482	) {
		483	my $name = $2;
		484	my $value = $4;
		485
		486	if (defined $1) {
		487	# expires
		488	$name = "expires";
		489	$value = $1;
		490	} elsif (defined $3) {
		491	# quoted
		492	$value = $3;
		493	$value =~ s/\\(.)/$1/gs;
		494	}
		495
		496	push @kv, lc $name, $value;
		497
		498	last unless /\G\s*;/gc;
		499	}
		500
		501	last unless @kv;
		502
		503	my $name = shift @kv;
		504	my %kv = (value => shift @kv, @kv);
		505
		506	if (exists $kv{"max-age"}) {
		507	$kv{_expires} = $anow + delete $kv{"max-age"};
		508	} elsif (exists $kv{expires}) {
		509	$snow \|\|= parse_date ($date) \|\| $anow;
		510	$kv{_expires} = $anow + (parse_date (delete $kv{expires}) - $snow);
		511	} else {
		512	delete $kv{_expires};
		513	}
		514
		515	my $cdom;
		516	my $cpath = (delete $kv{path}) \|\| "/";
		517
		518	if (exists $kv{domain}) {
		519	$cdom = delete $kv{domain};
		520
		521	$cdom =~ s/^\.?/./; # make sure it starts with a "."
		522
		523	next if $cdom =~ /\.$/;
		524
		525	# this is not rfc-like and not netscape-like. go figure.
		526	my $ndots = $cdom =~ y/.//;
		527	next if $ndots < ($cdom =~ /\.[^.][^.]\.[^.][^.]$/ ? 3 : 2);
		528	} else {
		529	$cdom = $uhost;
		530	}
		531
		532	# store it
		533	$jar->{version} = 1;
		534	$jar->{lc $cdom}{$cpath}{$name} = \%kv;
		535
		536	redo if /\G\s*,/gc;
		537	}
		538	}
		539
		540	# continue to parse $_ for headers and place them into the arg
		541	sub parse_hdr() {
		542	my %hdr;
		543
		544	# things seen, not parsed:
		545	# p3pP="NON CUR OTPi OUR NOR UNI"
		546
		547	$hdr{lc $1} .= ",$2"
		548	while /\G
		549	([^:\000-\037]*):
		550	[\011\040]*
		551	((?: [^\012]+ \| \012[\011\040] )*)
		552	\012
		553	/gxc;
		554
		555	/\G$/
		556	or return;
		557
		558	# remove the "," prefix we added to all headers above
		559	substr $_, 0, 1, ""
		560	for values %hdr;
		561
		562	\%hdr
		563	}
		564
		565	our $qr_nlnl = qr{(?<![^\012])\015?\012};
		566
		567	our $TLS_CTX_LOW = { cache => 1, sslv2 => 1 };
		568	our $TLS_CTX_HIGH = { cache => 1, verify => 1, verify_peername => "https" };
		569
214	sub http_request($$$;@) {	570	sub http_request($$@) {
215	my $cb = pop;	571	my $cb = pop;
216	my ($method, $url, %arg) = @_;	572	my ($method, $url, %arg) = @_;
217		573
218	my %hdr;	574	my %hdr;
		575
		576	$arg{tls_ctx} = $TLS_CTX_LOW if $arg{tls_ctx} eq "low" \|\| !exists $arg{tls_ctx};
		577	$arg{tls_ctx} = $TLS_CTX_HIGH if $arg{tls_ctx} eq "high";
219		578
220	$method = uc $method;	579	$method = uc $method;
221		580
222	if (my $hdr = $arg{headers}) {	581	if (my $hdr = $arg{headers}) {
223	while (my ($k, $v) = each %$hdr) {	582	while (my ($k, $v) = each %$hdr) {
224	$hdr{lc $k} = $v;	583	$hdr{lc $k} = $v;
225	}	584	}
226	}	585	}
227		586
		587	# pseudo headers for all subsequent responses
		588	my @pseudo = (URL => $url);
		589	push @pseudo, Redirect => delete $arg{Redirect} if exists $arg{Redirect};
		590
228	my $recurse = exists $arg{recurse} ? $arg{recurse} : $MAX_RECURSE;	591	my $recurse = exists $arg{recurse} ? delete $arg{recurse} : $MAX_RECURSE;
229		592
230	return $cb->(undef, { Status => 599, Reason => "recursion limit reached" })	593	return $cb->(undef, { @pseudo, Status => 599, Reason => "Too many redirections" })
231	if $recurse < 0;	594	if $recurse < 0;
232		595
233	my $proxy = $arg{proxy} \|\| $PROXY;	596	my $proxy = $arg{proxy} \|\| $PROXY;
234	my $timeout = $arg{timeout} \|\| $TIMEOUT;	597	my $timeout = $arg{timeout} \|\| $TIMEOUT;
235		598
236	$hdr{"user-agent"} \|\|= $USERAGENT;
237
238	my ($scheme, $authority, $upath, $query, $fragment) =	599	my ($uscheme, $uauthority, $upath, $query, $fragment) =
239	$url =~ m\|(?:([^:/?#]+):)?(?://([^/?#]))?([^?#])(?:\?([^#]))?(?:#(.))?\|;	600	$url =~ m\|(?:([^:/?#]+):)?(?://([^/?#]))?([^?#])(?:(\?[^#]))?(?:#(.))?\|;
240		601
241	$scheme = lc $scheme;	602	$uscheme = lc $uscheme;
242		603
243	my $uport = $scheme eq "http" ? 80	604	my $uport = $uscheme eq "http" ? 80
244	: $scheme eq "https" ? 443	605	: $uscheme eq "https" ? 443
245	: return $cb->(undef, { Status => 599, Reason => "only http and https URL schemes supported" });	606	: return $cb->(undef, { @pseudo, Status => 599, Reason => "Only http and https URL schemes supported" });
246		607
247	$authority =~ /^(?: .*\@ )? ([^\@:]+) (?: : (\d+) )?$/x	608	$uauthority =~ /^(?: .*\@ )? ([^\@:]+) (?: : (\d+) )?$/x
248	or return $cb->(undef, { Status => 599, Reason => "unparsable URL" });	609	or return $cb->(undef, { @pseudo, Status => 599, Reason => "Unparsable URL" });
249		610
250	my $uhost = $1;	611	my $uhost = lc $1;
251	$uport = $2 if defined $2;	612	$uport = $2 if defined $2;
252		613
		614	$hdr{host} = defined $2 ? "$uhost:$2" : "$uhost"
		615	unless exists $hdr{host};
		616
253	$uhost =~ s/^\[(.*)\]$/$1/;	617	$uhost =~ s/^\[(.*)\]$/$1/;
254	$upath .= "?$query" if length $query;	618	$upath .= $query if length $query;
255		619
256	$upath =~ s%^/?%/%;	620	$upath =~ s%^/?%/%;
257		621
258	# cookie processing	622	# cookie processing
259	if (my $jar = $arg{cookie_jar}) {	623	if (my $jar = $arg{cookie_jar}) {
260	%$jar = () if $jar->{version} < 1;	624	my $cookies = cookie_jar_extract $jar, $uscheme, $uhost, $upath;
261		625
262	my @cookie;
263
264	while (my ($chost, $v) = each %$jar) {
265	next unless $chost eq substr $uhost, -length $chost;
266	next unless $chost =~ /^\./;
267
268	while (my ($cpath, $v) = each %$v) {
269	next unless $cpath eq substr $upath, 0, length $cpath;
270
271	while (my ($k, $v) = each %$v) {
272	next if $scheme ne "https" && exists $v->{secure};
273	push @cookie, "$k=$v->{value}";
274	}
275	}
276	}
277
278	$hdr{cookie} = join "; ", @cookie	626	$hdr{cookie} = join "; ", @$cookies
279	if @cookie;	627	if @$cookies;
280	}	628	}
281		629
282	my ($rhost, $rport, $rpath); # request host, port, path	630	my ($rhost, $rport, $rscheme, $rpath); # request host, port, path
283		631
284	if ($proxy) {	632	if ($proxy) {
285	($rhost, $rport, $scheme) = @$proxy;	633	($rpath, $rhost, $rport, $rscheme) = ($url, @$proxy);
286	$rpath = $url;	634
		635	$rscheme = "http" unless defined $rscheme;
		636
		637	# don't support https requests over https-proxy transport,
		638	# can't be done with tls as spec'ed, unless you double-encrypt.
		639	$rscheme = "http" if $uscheme eq "https" && $rscheme eq "https";
		640
		641	$rhost = lc $rhost;
		642	$rscheme = lc $rscheme;
287	} else {	643	} else {
288	($rhost, $rport, $rpath) = ($uhost, $uport, $upath);	644	($rhost, $rport, $rscheme, $rpath) = ($uhost, $uport, $uscheme, $upath);
289	$hdr{host} = $uhost;
290	}	645	}
291		646
		647	# leave out fragment and query string, just a heuristic
		648	$hdr{referer} = "$uscheme://$uauthority$upath" unless exists $hdr{referer};
		649	$hdr{"user-agent"} = $USERAGENT unless exists $hdr{"user-agent"};
		650
292	$hdr{"content-length"} = length $arg{body};	651	$hdr{"content-length"} = length $arg{body}
		652	if length $arg{body} \|\| $method ne "GET";
		653
		654	$hdr{connection} = "close Te"; #1.1
		655	$hdr{te} = "trailers" unless exists $hdr{te}; #1.1
293		656
294	my %state = (connect_guard => 1);	657	my %state = (connect_guard => 1);
295		658
296	_get_slot $uhost, sub {	659	_get_slot $uhost, sub {
297	$state{slot_guard} = shift;	660	$state{slot_guard} = shift;
298		661
299	return unless $state{connect_guard};	662	return unless $state{connect_guard};
300		663
301	$state{connect_guard} = AnyEvent::Socket::tcp_connect $rhost, $rport, sub {	664	my $ae_error = 595; # connecting
302	$state{fh} = shift
303	or return $cb->(undef, { Status => 599, Reason => "$!" });
304		665
305	delete $state{connect_guard}; # reduce memory usage, save a tree	666	# handle actual, non-tunneled, request
		667	my $handle_actual_request = sub {
		668	$ae_error = 596; # request phase
306		669
307	# get handle	670	$state{handle}->starttls ("connect") if $uscheme eq "https" && !exists $state{handle}{tls};
308	$state{handle} = new AnyEvent::Handle
309	fh => $state{fh},
310	($scheme eq "https" ? (tls => "connect") : ());
311
312	# limit the number of persistent connections
313	if ($KA_COUNT{$_[1]} < $MAX_PERSISTENT_PER_HOST) {
314	++$KA_COUNT{$_[1]};
315	$state{handle}{ka_count_guard} = AnyEvent::Util::guard { --$KA_COUNT{$_[1]} };
316	$hdr{connection} = "keep-alive";
317	delete $hdr{connection}; # keep-alive not yet supported
318	} else {
319	delete $hdr{connection};
320	}
321
322	# (re-)configure handle
323	$state{handle}->timeout ($timeout);
324	$state{handle}->on_error (sub {
325	%state = ();
326	$cb->(undef, { Status => 599, Reason => "$!" });
327	});
328	$state{handle}->on_eof (sub {
329	%state = ();
330	$cb->(undef, { Status => 599, Reason => "unexpected end-of-file" });
331	});
332		671
333	# send request	672	# send request
334	$state{handle}->push_write (	673	$state{handle}->push_write (
335	"$method $rpath HTTP/1.0\015\012"	674	"$method $rpath HTTP/1.1\015\012"
336	. (join "", map "$_: $hdr{$_}\015\012", keys %hdr)	675	. (join "", map "\u$_: $hdr{$_}\015\012", grep defined $hdr{$_}, keys %hdr)
337	. "\015\012"	676	. "\015\012"
338	. (delete $arg{body})	677	. (delete $arg{body})
339	);	678	);
340		679
		680	# return if error occured during push_write()
		681	return unless %state;
		682
341	%hdr = (); # reduce memory usage, save a kitten	683	%hdr = (); # reduce memory usage, save a kitten, also make it possible to re-use
342		684
343	# status line	685	# status line and headers
344	$state{handle}->push_read (line => qr/\015?\012/, sub {	686	$state{read_response} = sub {
		687	for ("$_[1]") {
		688	y/\015//d; # weed out any \015, as they show up in the weirdest of places.
		689
345	$_[1] =~ /^HTTP\/([0-9\.]+) \s+ ([0-9]{3}) \s+ ([^\015\012]+)/ix	690	/^HTTP\/0([0-9\.]+) \s+ ([0-9]{3}) (?: \s+ ([^\012]) )? \012/gxci
346	or return (%state = (), $cb->(undef, { Status => 599, Reason => "invalid server response ($_[1])" }));	691	or return (%state = (), $cb->(undef, { @pseudo, Status => 599, Reason => "Invalid server response" }));
347		692
348	my %hdr = ( # response headers	693	# 100 Continue handling
		694	# should not happen as we don't send expect: 100-continue,
		695	# but we handle it just in case.
		696	# since we send the request body regardless, if we get an error
		697	# we are out of-sync, which we currently do NOT handle correctly.
		698	return $state{handle}->push_read (line => $qr_nlnl, $state{read_response})
		699	if $2 eq 100;
		700
		701	push @pseudo,
349	HTTPVersion => "\x00$1",	702	HTTPVersion => $1,
350	Status => "\x00$2",	703	Status => $2,
351	Reason => "\x00$3",	704	Reason => $3,
352	);	705	;
353		706
354	# headers, could be optimized a bit	707	my $hdr = parse_hdr
355	$state{handle}->unshift_read (line => qr/\015?\012\015?\012/, sub {
356	for ("$_[1]\012") {
357	# we support spaces in field names, as lotus domino
358	# creates them.
359	$hdr{lc $1} .= "\x00$2"
360	while /\G
361	([^:\000-\037]+):
362	[\011\040]*
363	((?: [^\015\012]+ \| \015?\012[\011\040] )*)
364	\015?\012
365	/gxc;
366
367	/\G$/
368	or return (%state = (), $cb->(undef, { Status => 599, Reason => "garbled response headers" }));	708	or return (%state = (), $cb->(undef, { @pseudo, Status => 599, Reason => "Garbled response headers" }));
		709
		710	%hdr = (%$hdr, @pseudo);
		711	}
		712
		713	# redirect handling
		714	# microsoft and other shitheads don't give a shit for following standards,
		715	# try to support some common forms of broken Location headers.
		716	if ($hdr{location} !~ /^(?: $ \| [^:\/?\#]+ : )/x) {
		717	$hdr{location} =~ s/^\.\/+//;
		718
		719	my $url = "$rscheme://$uhost:$uport";
		720
		721	unless ($hdr{location} =~ s/^\///) {
		722	$url .= $upath;
		723	$url =~ s/\/[^\/]*$//;
369	}	724	}
370		725
371	substr $_, 0, 1, ""	726	$hdr{location} = "$url/$hdr{location}";
372	for values %hdr;	727	}
373		728
374	my $finish = sub {	729	my $redirect;
		730
		731	if ($recurse) {
		732	my $status = $hdr{Status};
		733
		734	# industry standard is to redirect POST as GET for
		735	# 301, 302 and 303, in contrast to HTTP/1.0 and 1.1.
		736	# also, the UA should ask the user for 301 and 307 and POST,
		737	# industry standard seems to be to simply follow.
		738	# we go with the industry standard.
		739	if ($status == 301 or $status == 302 or $status == 303) {
		740	# HTTP/1.1 is unclear on how to mutate the method
		741	$method = "GET" unless $method eq "HEAD";
		742	$redirect = 1;
		743	} elsif ($status == 307) {
		744	$redirect = 1;
		745	}
		746	}
		747
		748	my $finish = sub { # ($data, $err_status, $err_reason[, $keepalive])
		749	my $may_keep_alive = $_[3];
		750
		751	$state{handle}->destroy if $state{handle};
375	%state = ();	752	%state = ();
376		753
		754	if (defined $_[1]) {
		755	$hdr{OrigStatus} = $hdr{Status}; $hdr{Status} = $_[1];
		756	$hdr{OrigReason} = $hdr{Reason}; $hdr{Reason} = $_[2];
		757	}
		758
377	# set-cookie processing	759	# set-cookie processing
378	if ($arg{cookie_jar} && exists $hdr{"set-cookie"}) {	760	if ($arg{cookie_jar}) {
379	for (split /\x00/, $hdr{"set-cookie"}) {	761	cookie_jar_set_cookie $arg{cookie_jar}, $hdr{"set-cookie"}, $uhost, $hdr{date};
380	my ($cookie, @arg) = split /;\s*/;	762	}
381	my ($name, $value) = split /=/, $cookie, 2;
382	my %kv = (value => $value, map { split /=/, $_, 2 } @arg);
383
384	my $cdom = (delete $kv{domain}) \|\| $uhost;
385	my $cpath = (delete $kv{path}) \|\| "/";
386
387	$cdom =~ s/^.?/./; # make sure it starts with a "."
388		763
389	next if $cdom =~ /\.$/;	764	if ($redirect && exists $hdr{location}) {
390		765	# we ignore any errors, as it is very common to receive
391	# this is not rfc-like and not netscape-like. go figure.	766	# Content-Length != 0 but no actual body
392	my $ndots = $cdom =~ y/.//;	767	# we also access %hdr, as $_[1] might be an erro
393	next if $ndots < ($cdom =~ /\.[^.][^.]\.[^.][^.]$/ ? 3 : 2);	768	http_request (
394		769	$method => $hdr{location},
		770	%arg,
		771	recurse => $recurse - 1,
		772	Redirect => [$_[0], \%hdr],
		773	$cb);
		774	} else {
		775	$cb->($_[0], \%hdr);
		776	}
		777	};
		778
		779	$ae_error = 597; # body phase
		780
		781	my $len = $hdr{"content-length"};
		782
		783	# body handling, many different code paths
		784	# - no body expected
		785	# - want_body_handle
		786	# - te chunked
		787	# - 2x length known (with or without on_body)
		788	# - 2x length not known (with or without on_body)
		789	if (!$redirect && $arg{on_header} && !$arg{on_header}(\%hdr)) {
		790	$finish->(undef, 598 => "Request cancelled by on_header");
		791	} elsif (
		792	$hdr{Status} =~ /^(?:1..\|204\|205\|304)$/
		793	or $method eq "HEAD"
		794	or (defined $len && $len == 0) # == 0, not !, because "0 " is true
		795	) {
		796	# no body
		797	$finish->("", undef, undef, 1);
		798
		799	} elsif (!$redirect && $arg{want_body_handle}) {
		800	$_[0]->on_eof (undef);
		801	$_[0]->on_error (undef);
		802	$_[0]->on_read (undef);
		803
		804	$finish->(delete $state{handle});
		805
		806	} elsif ($hdr{"transfer-encoding"} =~ /\bchunked\b/i) {
		807	my $cl = 0;
		808	my $body = undef;
		809	my $on_body = $arg{on_body} \|\| sub { $body .= shift; 1 };
		810
		811	$state{read_chunk} = sub {
		812	$_[1] =~ /^([0-9a-fA-F]+)/
		813	or $finish->(undef, $ae_error => "Garbled chunked transfer encoding");
		814
		815	my $len = hex $1;
		816
		817	if ($len) {
		818	$cl += $len;
		819
		820	$_[0]->push_read (chunk => $len, sub {
		821	$on_body->($_[1], \%hdr)
		822	or return $finish->(undef, 598 => "Request cancelled by on_body");
		823
		824	$_[0]->push_read (line => sub {
		825	length $_[1]
		826	and return $finish->(undef, $ae_error => "Garbled chunked transfer encoding");
		827	$_[0]->push_read (line => $state{read_chunk});
395	# store it	828	});
396	$arg{cookie_jar}{version} = 1;
397	$arg{cookie_jar}{$cdom}{$cpath}{$name} = \%kv;
398	}	829	});
399	}
400
401	if ($_[1]{Status} =~ /^x30[12]$/ && $recurse) {
402	# microsoft and other assholes don't give a shit for following standards,
403	# try to support a common form of broken Location header.
404	$_[1]{location} =~ s%^/%$scheme://$uhost:$uport/%;
405
406	http_request ($method, $_[1]{location}, %arg, recurse => $recurse - 1, $cb);
407	} else {	830	} else {
408	$cb->($_[0], $_[1]);	831	$hdr{"content-length"} \|\|= $cl;
		832
		833	$_[0]->push_read (line => $qr_nlnl, sub {
		834	if (length $_[1]) {
		835	for ("$_[1]") {
		836	y/\015//d; # weed out any \015, as they show up in the weirdest of places.
		837
		838	my $hdr = parse_hdr
		839	or return $finish->(undef, $ae_error => "Garbled response trailers");
		840
		841	%hdr = (%hdr, %$hdr);
		842	}
		843	}
		844
		845	$finish->($body, undef, undef, 1);
		846	});
409	}	847	}
410	};	848	};
411		849
412	if ($hdr{Status} =~ /^(?:1..\|204\|304)$/ or $method eq "HEAD") {	850	$_[0]->push_read (line => $state{read_chunk});
		851
		852	} elsif ($arg{on_body}) {
		853	if (defined $len) {
		854	$_[0]->on_read (sub {
		855	$len -= length $_[0]{rbuf};
		856
		857	$arg{on_body}(delete $_[0]{rbuf}, \%hdr)
		858	or return $finish->(undef, 598 => "Request cancelled by on_body");
		859
		860	$len > 0
413	$finish->(undef, \%hdr);	861	or $finish->("", undef, undef, 1);
		862	});
414	} else {	863	} else {
415	if (exists $hdr{"content-length"}) {	864	$_[0]->on_eof (sub {
416	$_[0]->unshift_read (chunk => $hdr{"content-length"}, sub {
417	# could cache persistent connection now
418	if ($hdr{connection} =~ /\bkeep-alive\b/i) {
419	# but we don't, due to misdesigns, this is annoyingly complex
420	};
421
422	$finish->($_[1], \%hdr);	865	$finish->("");
423	});	866	});
		867	$_[0]->on_read (sub {
		868	$arg{on_body}(delete $_[0]{rbuf}, \%hdr)
		869	or $finish->(undef, 598 => "Request cancelled by on_body");
		870	});
		871	}
		872	} else {
		873	$_[0]->on_eof (undef);
		874
		875	if (defined $len) {
		876	$_[0]->on_read (sub {
		877	$finish->((substr delete $_[0]{rbuf}, 0, $len, ""), undef, undef, 1)
		878	if $len <= length $_[0]{rbuf};
		879	});
424	} else {	880	} else {
425	# too bad, need to read until we get an error or EOF,
426	# no way to detect winged data.
427	$_[0]->on_error (sub {	881	$_[0]->on_error (sub {
		882	($! == Errno::EPIPE \|\| !$!)
428	$finish->($_[0]{rbuf}, \%hdr);	883	? $finish->(delete $_[0]{rbuf})
		884	: $finish->(undef, $ae_error => $_[2]);
429	});	885	});
430	$_[0]->on_eof (undef);
431	$_[0]->on_read (sub { });	886	$_[0]->on_read (sub { });
432	}	887	}
		888	}
		889	};
		890
		891	$state{handle}->push_read (line => $qr_nlnl, $state{read_response});
		892	};
		893
		894	my $connect_cb = sub {
		895	$state{fh} = shift
		896	or do {
		897	my $err = "$!";
		898	%state = ();
		899	return $cb->(undef, { @pseudo, Status => $ae_error, Reason => $err });
		900	};
		901
		902	return unless delete $state{connect_guard};
		903
		904	# get handle
		905	$state{handle} = new AnyEvent::Handle
		906	fh => $state{fh},
		907	peername => $rhost,
		908	tls_ctx => $arg{tls_ctx},
		909	# these need to be reconfigured on keepalive handles
		910	timeout => $timeout,
		911	on_error => sub {
		912	%state = ();
		913	$cb->(undef, { @pseudo, Status => $ae_error, Reason => $_[2] });
		914	},
		915	on_eof => sub {
		916	%state = ();
		917	$cb->(undef, { @pseudo, Status => $ae_error, Reason => "Unexpected end-of-file" });
		918	},
		919	;
		920
		921	# limit the number of persistent connections
		922	# keepalive not yet supported
		923	# if ($KA_COUNT{$_[1]} < $MAX_PERSISTENT_PER_HOST) {
		924	# ++$KA_COUNT{$_[1]};
		925	# $state{handle}{ka_count_guard} = AnyEvent::Util::guard {
		926	# --$KA_COUNT{$_[1]}
		927	# };
		928	# $hdr{connection} = "keep-alive";
		929	# }
		930
		931	$state{handle}->starttls ("connect") if $rscheme eq "https";
		932
		933	# now handle proxy-CONNECT method
		934	if ($proxy && $uscheme eq "https") {
		935	# oh dear, we have to wrap it into a connect request
		936
		937	# maybe re-use $uauthority with patched port?
		938	$state{handle}->push_write ("CONNECT $uhost:$uport HTTP/1.0\015\012\015\012");
		939	$state{handle}->push_read (line => $qr_nlnl, sub {
		940	$_[1] =~ /^HTTP\/([0-9\.]+) \s+ ([0-9]{3}) (?: \s+ ([^\015\012]*) )?/ix
		941	or return (%state = (), $cb->(undef, { @pseudo, Status => 599, Reason => "Invalid proxy connect response ($_[1])" }));
		942
		943	if ($2 == 200) {
		944	$rpath = $upath;
		945	$handle_actual_request->();
		946	} else {
		947	%state = ();
		948	$cb->(undef, { @pseudo, Status => $2, Reason => $3 });
433	}	949	}
434	});	950	});
		951	} else {
		952	$handle_actual_request->();
435	});	953	}
436	}, sub {
437	$timeout
438	};	954	};
		955
		956	my $tcp_connect = $arg{tcp_connect}
		957	\|\| do { require AnyEvent::Socket; \&AnyEvent::Socket::tcp_connect };
		958
		959	$state{connect_guard} = $tcp_connect->($rhost, $rport, $connect_cb, $arg{on_prepare} \|\| sub { $timeout });
439	};	960	};
440		961
441	defined wantarray && AnyEvent::Util::guard { %state = () }	962	defined wantarray && AnyEvent::Util::guard { %state = () }
442	}	963	}
443		964
444	sub http_get($$;@) {	965	sub http_get($@) {
445	unshift @_, "GET";	966	unshift @_, "GET";
446	&http_request	967	&http_request
447	}	968	}
448		969
449	sub http_head($$;@) {	970	sub http_head($@) {
450	unshift @_, "HEAD";	971	unshift @_, "HEAD";
451	&http_request	972	&http_request
452	}	973	}
453		974
454	sub http_post($$$;@) {	975	sub http_post($$@) {
		976	my $url = shift;
455	unshift @_, "POST", "body";	977	unshift @_, "POST", $url, "body";
456	&http_request	978	&http_request
457	}	979	}
458		980
459	=back	981	=back
460		982
		983	=head2 DNS CACHING
		984
		985	AnyEvent::HTTP uses the AnyEvent::Socket::tcp_connect function for
		986	the actual connection, which in turn uses AnyEvent::DNS to resolve
		987	hostnames. The latter is a simple stub resolver and does no caching
		988	on its own. If you want DNS caching, you currently have to provide
		989	your own default resolver (by storing a suitable resolver object in
		990	C<$AnyEvent::DNS::RESOLVER>).
		991
461	=head2 GLOBAL FUNCTIONS AND VARIABLES	992	=head2 GLOBAL FUNCTIONS AND VARIABLES
462		993
463	=over 4	994	=over 4
464		995
465	=item AnyEvent::HTTP::set_proxy "proxy-url"	996	=item AnyEvent::HTTP::set_proxy "proxy-url"
466		997
467	Sets the default proxy server to use. The proxy-url must begin with a	998	Sets the default proxy server to use. The proxy-url must begin with a
468	string of the form C<http://host:port> (optionally C<https:...>).	999	string of the form C<http://host:port> (optionally C<https:...>), croaks
		1000	otherwise.
		1001
		1002	To clear an already-set proxy, use C<undef>.
		1003
		1004	=item AnyEvent::HTTP::cookie_jar_expire $jar[, $session_end]
		1005
		1006	Remove all cookies from the cookie jar that have been expired. If
		1007	C<$session_end> is given and true, then additionally remove all session
		1008	cookies.
		1009
		1010	You should call this function (with a true C<$session_end>) before you
		1011	save cookies to disk, and you should call this function after loading them
		1012	again. If you have a long-running program you can additonally call this
		1013	function from time to time.
		1014
		1015	A cookie jar is initially an empty hash-reference that is managed by this
		1016	module. It's format is subject to change, but currently it is like this:
		1017
		1018	The key C<version> has to contain C<1>, otherwise the hash gets
		1019	emptied. All other keys are hostnames or IP addresses pointing to
		1020	hash-references. The key for these inner hash references is the
		1021	server path for which this cookie is meant, and the values are again
		1022	hash-references. The keys of those hash-references is the cookie name, and
		1023	the value, you guessed it, is another hash-reference, this time with the
		1024	key-value pairs from the cookie, except for C<expires> and C<max-age>,
		1025	which have been replaced by a C<_expires> key that contains the cookie
		1026	expiry timestamp.
		1027
		1028	Here is an example of a cookie jar with a single cookie, so you have a
		1029	chance of understanding the above paragraph:
		1030
		1031	{
		1032	version => 1,
		1033	"10.0.0.1" => {
		1034	"/" => {
		1035	"mythweb_id" => {
		1036	_expires => 1293917923,
		1037	value => "ooRung9dThee3ooyXooM1Ohm",
		1038	},
		1039	},
		1040	},
		1041	}
		1042
		1043	=item $date = AnyEvent::HTTP::format_date $timestamp
		1044
		1045	Takes a POSIX timestamp (seconds since the epoch) and formats it as a HTTP
		1046	Date (RFC 2616).
		1047
		1048	=item $timestamp = AnyEvent::HTTP::parse_date $date
		1049
		1050	Takes a HTTP Date (RFC 2616) or a Cookie date (netscape cookie spec) or a
		1051	bunch of minor variations of those, and returns the corresponding POSIX
		1052	timestamp, or C<undef> if the date cannot be parsed.
469		1053
470	=item $AnyEvent::HTTP::MAX_RECURSE	1054	=item $AnyEvent::HTTP::MAX_RECURSE
471		1055
472	The default value for the C<recurse> request parameter (default: C<10>).	1056	The default value for the C<recurse> request parameter (default: C<10>).
473		1057
474	=item $AnyEvent::HTTP::USERAGENT	1058	=item $AnyEvent::HTTP::USERAGENT
475		1059
476	The default value for the C<User-Agent> header (the default is	1060	The default value for the C<User-Agent> header (the default is
477	C<Mozilla/5.0 (compatible; AnyEvent::HTTP/$VERSION; +http://software.schmorp.de/pkg/AnyEvent)>).	1061	C<Mozilla/5.0 (compatible; U; AnyEvent-HTTP/$VERSION; +http://software.schmorp.de/pkg/AnyEvent)>).
478		1062
479	=item $AnyEvent::HTTP::MAX_PERSISTENT	1063	=item $AnyEvent::HTTP::MAX_PER_HOST
480		1064
481	The maximum number of persistent connections to keep open (default: 8).	1065	The maximum number of concurrent connections to the same host (identified
		1066	by the hostname). If the limit is exceeded, then the additional requests
		1067	are queued until previous connections are closed.
482		1068
483	Not implemented currently.	1069	The default value for this is C<4>, and it is highly advisable to not
		1070	increase it.
484		1071
485	=item $AnyEvent::HTTP::PERSISTENT_TIMEOUT	1072	=item $AnyEvent::HTTP::ACTIVE
486		1073
487	The maximum time to cache a persistent connection, in seconds (default: 2).	1074	The number of active connections. This is not the number of currently
488		1075	running requests, but the number of currently open and non-idle TCP
489	Not implemented currently.	1076	connections. This number of can be useful for load-leveling.
490		1077
491	=back	1078	=back
492		1079
493	=cut	1080	=cut
494		1081
		1082	our @month = qw(Jan Feb Mar Apr May Jun Jul Aug Sep Oct Nov Dec);
		1083	our @weekday = qw(Sun Mon Tue Wed Thu Fri Sat);
		1084
		1085	sub format_date($) {
		1086	my ($time) = @_;
		1087
		1088	# RFC 822/1123 format
		1089	my ($S, $M, $H, $mday, $mon, $year, $wday, $yday, undef) = gmtime $time;
		1090
		1091	sprintf "%s, %02d %s %04d %02d:%02d:%02d GMT",
		1092	$weekday[$wday], $mday, $month[$mon], $year + 1900,
		1093	$H, $M, $S;
		1094	}
		1095
		1096	sub parse_date($) {
		1097	my ($date) = @_;
		1098
		1099	my ($d, $m, $y, $H, $M, $S);
		1100
		1101	if ($date =~ /^[A-Z][a-z][a-z]+, ([0-9][0-9]?)[\- ]([A-Z][a-z][a-z])[\- ]([0-9][0-9][0-9][0-9]) ([0-9][0-9]?):([0-9][0-9]?):([0-9][0-9]?) GMT$/) {
		1102	# RFC 822/1123, required by RFC 2616 (with " ")
		1103	# cookie dates (with "-")
		1104
		1105	($d, $m, $y, $H, $M, $S) = ($1, $2, $3, $4, $5, $6);
		1106
		1107	} elsif ($date =~ /^[A-Z][a-z][a-z]+, ([0-9][0-9]?)-([A-Z][a-z][a-z])-([0-9][0-9]) ([0-9][0-9]?):([0-9][0-9]?):([0-9][0-9]?) GMT$/) {
		1108	# RFC 850
		1109	($d, $m, $y, $H, $M, $S) = ($1, $2, $3 < 69 ? $3 + 2000 : $3 + 1900, $4, $5, $6);
		1110
		1111	} elsif ($date =~ /^[A-Z][a-z][a-z]+ ([A-Z][a-z][a-z]) ([0-9 ]?[0-9]) ([0-9][0-9]?):([0-9][0-9]?):([0-9][0-9]?) ([0-9][0-9][0-9][0-9])$/) {
		1112	# ISO C's asctime
		1113	($d, $m, $y, $H, $M, $S) = ($2, $1, $6, $3, $4, $5);
		1114	}
		1115	# other formats fail in the loop below
		1116
		1117	for (0..11) {
		1118	if ($m eq $month[$_]) {
		1119	require Time::Local;
		1120	return Time::Local::timegm ($S, $M, $H, $d, $_, $y);
		1121	}
		1122	}
		1123
		1124	undef
		1125	}
		1126
495	sub set_proxy($) {	1127	sub set_proxy($) {
		1128	if (length $_[0]) {
496	$PROXY = [$2, $3 \|\| 3128, $1] if $_[0] =~ m%^(https?):// ([^:/]+) (?: : (\d*) )?%ix;	1129	$_[0] =~ m%^(https?):// ([^:/]+) (?: : (\d*) )?%ix
		1130	or Carp::croak "$_[0]: invalid proxy URL";
		1131	$PROXY = [$2, $3 \|\| 3128, $1]
		1132	} else {
		1133	undef $PROXY;
		1134	}
497	}	1135	}
498		1136
499	# initialise proxy from environment	1137	# initialise proxy from environment
		1138	eval {
500	set_proxy $ENV{http_proxy};	1139	set_proxy $ENV{http_proxy};
		1140	};
		1141
		1142	=head2 SOCKS PROXIES
		1143
		1144	Socks proxies are not directly supported by AnyEvent::HTTP. You can
		1145	compile your perl to support socks, or use an external program such as
		1146	F<socksify> (dante) or F<tsocks> to make your program use a socks proxy
		1147	transparently.
		1148
		1149	Alternatively, for AnyEvent::HTTP only, you can use your own
		1150	C<tcp_connect> function that does the proxy handshake - here is an example
		1151	that works with socks4a proxies:
		1152
		1153	use Errno;
		1154	use AnyEvent::Util;
		1155	use AnyEvent::Socket;
		1156	use AnyEvent::Handle;
		1157
		1158	# host, port and username of/for your socks4a proxy
		1159	my $socks_host = "10.0.0.23";
		1160	my $socks_port = 9050;
		1161	my $socks_user = "";
		1162
		1163	sub socks4a_connect {
		1164	my ($host, $port, $connect_cb, $prepare_cb) = @_;
		1165
		1166	my $hdl = new AnyEvent::Handle
		1167	connect => [$socks_host, $socks_port],
		1168	on_prepare => sub { $prepare_cb->($_[0]{fh}) },
		1169	on_error => sub { $connect_cb->() },
		1170	;
		1171
		1172	$hdl->push_write (pack "CCnNZZ", 4, 1, $port, 1, $socks_user, $host);
		1173
		1174	$hdl->push_read (chunk => 8, sub {
		1175	my ($hdl, $chunk) = @_;
		1176	my ($status, $port, $ipn) = unpack "xCna4", $chunk;
		1177
		1178	if ($status == 0x5a) {
		1179	$connect_cb->($hdl->{fh}, (format_address $ipn) . ":$port");
		1180	} else {
		1181	$! = Errno::ENXIO; $connect_cb->();
		1182	}
		1183	});
		1184
		1185	$hdl
		1186	}
		1187
		1188	Use C<socks4a_connect> instead of C<tcp_connect> when doing C<http_request>s,
		1189	possibly after switching off other proxy types:
		1190
		1191	AnyEvent::HTTP::set_proxy undef; # usually you do not want other proxies
		1192
		1193	http_get 'http://www.google.com', tcp_connect => \&socks4a_connect, sub {
		1194	my ($data, $headers) = @_;
		1195	...
		1196	};
501		1197
502	=head1 SEE ALSO	1198	=head1 SEE ALSO
503		1199
504	L<AnyEvent>.	1200	L<AnyEvent>.
505		1201
506	=head1 AUTHOR	1202	=head1 AUTHOR
507		1203
508	Marc Lehmann <schmorp@schmorp.de>	1204	Marc Lehmann <schmorp@schmorp.de>
509	http://home.schmorp.de/	1205	http://home.schmorp.de/
		1206
		1207	With many thanks to Дмитрий Шалашов, who provided countless
		1208	testcases and bugreports.
510		1209
511	=cut	1210	=cut
512		1211
513	1	1212	1
514		1213

Diff Legend

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

Comparing AnyEvent-HTTP/HTTP.pm (file contents): Revision 1.11 by root, Thu Jun 5 15:34:00 2008 UTC vs. Revision 1.87 by root, Sun Jan 2 08:51:53 2011 UTC

Diff Legend

Comparing AnyEvent-HTTP/HTTP.pm (file contents):
Revision 1.11 by root, Thu Jun 5 15:34:00 2008 UTC vs.
Revision 1.87 by root, Sun Jan 2 08:51:53 2011 UTC