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

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

Diff Legend

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

Comparing AnyEvent-HTTP/HTTP.pm (file contents): Revision 1.15 by elmex, Fri Jun 6 10:12:44 2008 UTC vs. Revision 1.82 by root, Sun Jan 2 04:50:40 2011 UTC

Diff Legend

Comparing AnyEvent-HTTP/HTTP.pm (file contents):
Revision 1.15 by elmex, Fri Jun 6 10:12:44 2008 UTC vs.
Revision 1.82 by root, Sun Jan 2 04:50:40 2011 UTC