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

Comparing AnyEvent-HTTP/HTTP.pm (file contents):
Revision 1.52 by root, Sat Sep 26 10:13:12 2009 UTC vs.
Revision 1.86 by root, Sun Jan 2 06:38:32 2011 UTC

…		…
36		36
37	=cut	37	=cut
38		38
39	package AnyEvent::HTTP;	39	package AnyEvent::HTTP;
40		40
41	use strict;	41	use common::sense;
42	no warnings;
43		42
44	use Errno ();	43	use Errno ();
45		44
46	use AnyEvent 5.0 ();	45	use AnyEvent 5.0 ();
47	use AnyEvent::Util ();	46	use AnyEvent::Util ();
48	use AnyEvent::Socket ();
49	use AnyEvent::Handle ();	47	use AnyEvent::Handle ();
50		48
51	use base Exporter::;	49	use base Exporter::;
52		50
53	our $VERSION = '1.43';	51	our $VERSION = '1.5';
54		52
55	our @EXPORT = qw(http_get http_post http_head http_request);	53	our @EXPORT = qw(http_get http_post http_head http_request);
56		54
57	our $USERAGENT = "Mozilla/5.0 (compatible; U; 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)";
58	our $MAX_RECURSE = 10;	56	our $MAX_RECURSE = 10;
…		…
92	must be an absolute http or https URL.	90	must be an absolute http or https URL.
93		91
94	When called in void context, nothing is returned. In other contexts,	92	When called in void context, nothing is returned. In other contexts,
95	C<http_request> returns a "cancellation guard" - you have to keep the	93	C<http_request> returns a "cancellation guard" - you have to keep the
96	object at least alive until the callback get called. If the object gets	94	object at least alive until the callback get called. If the object gets
97	destroyed before the callbakc is called, the request will be cancelled.	95	destroyed before the callback is called, the request will be cancelled.
98		96
99	The callback will be called with the response body data as first argument	97	The callback will be called with the response body data as first argument
100	(or C<undef> if an error occured), and a hash-ref with response headers as	98	(or C<undef> if an error occured), and a hash-ref with response headers
101	second argument.	99	(and trailers) as second argument.
102		100
103	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
104	headers, the "pseudo-headers" C<HTTPVersion>, C<Status> and C<Reason>	102	headers, the "pseudo-headers" (uppercase to avoid clashing with possible
		103	response headers) C<HTTPVersion>, C<Status> and C<Reason> contain the
105	contain the three parts of the HTTP Status-Line of the same name. 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
106	pseudo-header C<URL> contains the original URL (which can differ from the	109	The pseudo-header C<URL> contains the actual URL (which can differ from
107	requested URL when following redirects).	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.
108		121
109	If the server sends a header multiple times, then their contents will be	122	If the server sends a header multiple times, then their contents will be
110	joined together with a comma (C<,>), as per the HTTP spec.	123	joined together with a comma (C<,>), as per the HTTP spec.
111		124
112	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,
113	then C<$data> will be C<undef>, C<< $headers->{Status} >> will be C<59x>	126	then C<$data> will be C<undef>, C<< $headers->{Status} >> will be
114	(usually C<599>) and the C<Reason> pseudo-header will contain an error	127	C<590>-C<599> and the C<Reason> pseudo-header will contain an error
115	message.	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
116		143
117	A typical callback might look like this:	144	A typical callback might look like this:
118		145
119	sub {	146	sub {
120	my ($body, $hdr) = @_;	147	my ($body, $hdr) = @_;
…		…
136	Whether to recurse requests or not, e.g. on redirects, authentication	163	Whether to recurse requests or not, e.g. on redirects, authentication
137	retries and so on, and how often to do so.	164	retries and so on, and how often to do so.
138		165
139	=item headers => hashref	166	=item headers => hashref
140		167
141	The request headers to use. Currently, C<http_request> may provide its	168	The request headers to use. Currently, C<http_request> may provide its own
142	own C<Host:>, C<Content-Length:>, C<Connection:> and C<Cookie:> headers	169	C<Host:>, C<Content-Length:>, C<Connection:> and C<Cookie:> headers and
143	and will provide defaults for C<User-Agent:> and C<Referer:> (this can be	170	will provide defaults at least for C<TE:>, C<Referer:> and C<User-Agent:>
144	suppressed by using C<undef> for these headers in which case they won't be	171	(this can be suppressed by using C<undef> for these headers in which case
145	sent at all).	172	they won't be sent at all).
146		173
147	=item timeout => $seconds	174	=item timeout => $seconds
148		175
149	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
150	the timeout, as will read or write activity, i.e. this is not an overall	177	the timeout, as will read or write activity, i.e. this is not an overall
…		…
160	C<$scheme> must be either missing, C<http> for HTTP or C<https> for	187	C<$scheme> must be either missing, C<http> for HTTP or C<https> for
161	HTTPS.	188	HTTPS.
162		189
163	=item body => $string	190	=item body => $string
164		191
165	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
166	this module might offer more options).	193	this module might offer more options).
167		194
168	=item cookie_jar => $hash_ref	195	=item cookie_jar => $hash_ref
169		196
170	Passing this parameter enables (simplified) cookie-processing, loosely	197	Passing this parameter enables (simplified) cookie-processing, loosely
171	based on the original netscape specification.	198	based on the original netscape specification.
172		199
173	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
174	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
175	persistent storage with something like JSON or Storable, but this is not	202	to persistent storage with something like JSON or Storable - see the
176	recommended, as expiry 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.
177		206
178	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
179	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
180	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
181	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
182	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.
183		216
184	=item tls_ctx => $scheme \| $tls_ctx	217	=item tls_ctx => $scheme \| $tls_ctx
185		218
186	Specifies the AnyEvent::TLS context to be used for https connections. This	219	Specifies the AnyEvent::TLS context to be used for https connections. This
187	parameter follows the same rules as the C<tls_ctx> parameter to	220	parameter follows the same rules as the C<tls_ctx> parameter to
…		…
200	overrides the prepare callback passed to C<AnyEvent::Socket::tcp_connect>	233	overrides the prepare callback passed to C<AnyEvent::Socket::tcp_connect>
201	and behaves exactly the same way (e.g. it has to provide a	234	and behaves exactly the same way (e.g. it has to provide a
202	timeout). See the description for the C<$prepare_cb> argument of	235	timeout). See the description for the C<$prepare_cb> argument of
203	C<AnyEvent::Socket::tcp_connect> for details.	236	C<AnyEvent::Socket::tcp_connect> for details.
204		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
205	=item on_header => $callback->($headers)	250	=item on_header => $callback->($headers)
206		251
207	When specified, this callback will be called with the header hash as soon	252	When specified, this callback will be called with the header hash as soon
208	as headers have been successfully received from the remote server (not on	253	as headers have been successfully received from the remote server (not on
209	locally-generated errors).	254	locally-generated errors).
…		…
214		259
215	This callback is useful, among other things, to quickly reject unwanted	260	This callback is useful, among other things, to quickly reject unwanted
216	content, which, if it is supposed to be rare, can be faster than first	261	content, which, if it is supposed to be rare, can be faster than first
217	doing a C<HEAD> request.	262	doing a C<HEAD> request.
218		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
219	Example: cancel the request unless the content-type is "text/html".	268	Example: cancel the request unless the content-type is "text/html".
220		269
221	on_header => sub {	270	on_header => sub {
222	$_[0]{"content-type"} =~ /^text\/html\s*(?:;\|$)/	271	$_[0]{"content-type"} =~ /^text\/html\s*(?:;\|$)/
223	},	272	},
…		…
229	string instead of the body data.	278	string instead of the body data.
230		279
231	It has to return either true (in which case AnyEvent::HTTP will continue),	280	It has to return either true (in which case AnyEvent::HTTP will continue),
232	or false, in which case AnyEvent::HTTP will cancel the download (and call	281	or false, in which case AnyEvent::HTTP will cancel the download (and call
233	the completion callback with an error code of C<598>).	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.
234		286
235	This callback is useful when the data is too large to be held in memory	287	This callback is useful when the data is too large to be held in memory
236	(so the callback writes it to a file) or when only some information should	288	(so the callback writes it to a file) or when only some information should
237	be extracted, or when the body should be processed incrementally.	289	be extracted, or when the body should be processed incrementally.
238		290
…		…
264	If you think you need this, first have a look at C<on_body>, to see if	316	If you think you need this, first have a look at C<on_body>, to see if
265	that doesn't solve your problem in a better way.	317	that doesn't solve your problem in a better way.
266		318
267	=back	319	=back
268		320
269	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.
270		323
271	http_request GET => "http://www.nethype.de/", sub {	324	http_request GET => "http://www.nethype.de/", sub {
272	my ($body, $hdr) = @_;	325	my ($body, $hdr) = @_;
273	print "$body\n";	326	print "$body\n";
274	};	327	};
275		328
276	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
277	timeout of 30 seconds.	330	timeout of 30 seconds.
278		331
279	http_request	332	http_request
280	GET => "https://www.google.com",	333	GET => "https://www.google.com",
281	timeout => 30,	334	timeout => 30,
…		…
284	use Data::Dumper;	337	use Data::Dumper;
285	print Dumper $hdr;	338	print Dumper $hdr;
286	}	339	}
287	;	340	;
288		341
289	Example: make another simple HTTP GET request, but immediately try to	342	Example: do another simple HTTP GET request, but immediately try to
290	cancel it.	343	cancel it.
291		344
292	my $request = http_request GET => "http://www.nethype.de/", sub {	345	my $request = http_request GET => "http://www.nethype.de/", sub {
293	my ($body, $hdr) = @_;	346	my ($body, $hdr) = @_;
294	print "$body\n";	347	print "$body\n";
…		…
326	push @{ $CO_SLOT{$_[0]}[1] }, $_[1];	379	push @{ $CO_SLOT{$_[0]}[1] }, $_[1];
327		380
328	_slot_schedule $_[0];	381	_slot_schedule $_[0];
329	}	382	}
330		383
331	our $qr_nl = qr{\015?\012};	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
332	our $qr_nlnl = qr{(?<![^\012])\015?\012};	565	our $qr_nlnl = qr{(?<![^\012])\015?\012};
333		566
334	our $TLS_CTX_LOW = { cache => 1, sslv2 => 1 };	567	our $TLS_CTX_LOW = { cache => 1, sslv2 => 1 };
335	our $TLS_CTX_HIGH = { cache => 1, verify => 1, verify_peername => "https" };	568	our $TLS_CTX_HIGH = { cache => 1, verify => 1, verify_peername => "https" };
336		569
…		…
349	while (my ($k, $v) = each %$hdr) {	582	while (my ($k, $v) = each %$hdr) {
350	$hdr{lc $k} = $v;	583	$hdr{lc $k} = $v;
351	}	584	}
352	}	585	}
353		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
354	my $recurse = exists $arg{recurse} ? delete $arg{recurse} : $MAX_RECURSE;	591	my $recurse = exists $arg{recurse} ? delete $arg{recurse} : $MAX_RECURSE;
355		592
356	return $cb->(undef, { Status => 599, Reason => "Too many redirections", URL => $url })	593	return $cb->(undef, { @pseudo, Status => 599, Reason => "Too many redirections" })
357	if $recurse < 0;	594	if $recurse < 0;
358		595
359	my $proxy = $arg{proxy} \|\| $PROXY;	596	my $proxy = $arg{proxy} \|\| $PROXY;
360	my $timeout = $arg{timeout} \|\| $TIMEOUT;	597	my $timeout = $arg{timeout} \|\| $TIMEOUT;
361		598
362	my ($uscheme, $uauthority, $upath, $query, $fragment) =	599	my ($uscheme, $uauthority, $upath, $query, $fragment) =
363	$url =~ m\|(?:([^:/?#]+):)?(?://([^/?#]))?([^?#])(?:\?([^#]))?(?:#(.))?\|;	600	$url =~ m\|(?:([^:/?#]+):)?(?://([^/?#]))?([^?#])(?:(\?[^#]))?(?:#(.))?\|;
364		601
365	$uscheme = lc $uscheme;	602	$uscheme = lc $uscheme;
366		603
367	my $uport = $uscheme eq "http" ? 80	604	my $uport = $uscheme eq "http" ? 80
368	: $uscheme eq "https" ? 443	605	: $uscheme eq "https" ? 443
369	: return $cb->(undef, { Status => 599, Reason => "Only http and https URL schemes supported", URL => $url });	606	: return $cb->(undef, { @pseudo, Status => 599, Reason => "Only http and https URL schemes supported" });
370		607
371	$uauthority =~ /^(?: .*\@ )? ([^\@:]+) (?: : (\d+) )?$/x	608	$uauthority =~ /^(?: .*\@ )? ([^\@:]+) (?: : (\d+) )?$/x
372	or return $cb->(undef, { Status => 599, Reason => "Unparsable URL", URL => $url });	609	or return $cb->(undef, { @pseudo, Status => 599, Reason => "Unparsable URL" });
373		610
374	my $uhost = $1;	611	my $uhost = lc $1;
375	$uport = $2 if defined $2;	612	$uport = $2 if defined $2;
376		613
377	$hdr{host} = defined $2 ? "$uhost:$2" : "$uhost";	614	$hdr{host} = defined $2 ? "$uhost:$2" : "$uhost"
		615	unless exists $hdr{host};
378		616
379	$uhost =~ s/^\[(.*)\]$/$1/;	617	$uhost =~ s/^\[(.*)\]$/$1/;
380	$upath .= "?$query" if length $query;	618	$upath .= $query if length $query;
381		619
382	$upath =~ s%^/?%/%;	620	$upath =~ s%^/?%/%;
383		621
384	# cookie processing	622	# cookie processing
385	if (my $jar = $arg{cookie_jar}) {	623	if (my $jar = $arg{cookie_jar}) {
386	%$jar = () if $jar->{version} != 1;	624	my $cookies = cookie_jar_extract $jar, $uscheme, $uhost, $upath;
387		625
388	my @cookie;
389
390	while (my ($chost, $v) = each %$jar) {
391	if ($chost =~ /^\./) {
392	next unless $chost eq substr $uhost, -length $chost;
393	} elsif ($chost =~ /\./) {
394	next unless $chost eq $uhost;
395	} else {
396	next;
397	}
398
399	while (my ($cpath, $v) = each %$v) {
400	next unless $cpath eq substr $upath, 0, length $cpath;
401
402	while (my ($k, $v) = each %$v) {
403	next if $uscheme ne "https" && exists $v->{secure};
404	my $value = $v->{value};
405	$value =~ s/([\\"])/\\$1/g;
406	push @cookie, "$k=\"$value\"";
407	}
408	}
409	}
410
411	$hdr{cookie} = join "; ", @cookie	626	$hdr{cookie} = join "; ", @$cookies
412	if @cookie;	627	if @$cookies;
413	}	628	}
414		629
415	my ($rhost, $rport, $rscheme, $rpath); # request host, port, path	630	my ($rhost, $rport, $rscheme, $rpath); # request host, port, path
416		631
417	if ($proxy) {	632	if ($proxy) {
…		…
420	$rscheme = "http" unless defined $rscheme;	635	$rscheme = "http" unless defined $rscheme;
421		636
422	# don't support https requests over https-proxy transport,	637	# don't support https requests over https-proxy transport,
423	# can't be done with tls as spec'ed, unless you double-encrypt.	638	# can't be done with tls as spec'ed, unless you double-encrypt.
424	$rscheme = "http" if $uscheme eq "https" && $rscheme eq "https";	639	$rscheme = "http" if $uscheme eq "https" && $rscheme eq "https";
		640
		641	$rhost = lc $rhost;
		642	$rscheme = lc $rscheme;
425	} else {	643	} else {
426	($rhost, $rport, $rscheme, $rpath) = ($uhost, $uport, $uscheme, $upath);	644	($rhost, $rport, $rscheme, $rpath) = ($uhost, $uport, $uscheme, $upath);
427	}	645	}
428		646
429	# leave out fragment and query string, just a heuristic	647	# leave out fragment and query string, just a heuristic
430	$hdr{referer} \|\|= "$uscheme://$uauthority$upath" unless exists $hdr{referer};	648	$hdr{referer} = "$uscheme://$uauthority$upath" unless exists $hdr{referer};
431	$hdr{"user-agent"} \|\|= $USERAGENT unless exists $hdr{"user-agent"};	649	$hdr{"user-agent"} = $USERAGENT unless exists $hdr{"user-agent"};
432		650
433	$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
434		656
435	my %state = (connect_guard => 1);	657	my %state = (connect_guard => 1);
436		658
437	_get_slot $uhost, sub {	659	_get_slot $uhost, sub {
438	$state{slot_guard} = shift;	660	$state{slot_guard} = shift;
439		661
440	return unless $state{connect_guard};	662	return unless $state{connect_guard};
441		663
442	$state{connect_guard} = AnyEvent::Socket::tcp_connect $rhost, $rport, sub {	664	my $ae_error = 595; # connecting
		665
		666	# handle actual, non-tunneled, request
		667	my $handle_actual_request = sub {
		668	$ae_error = 596; # request phase
		669
		670	$state{handle}->starttls ("connect") if $uscheme eq "https" && !exists $state{handle}{tls};
		671
		672	# send request
		673	$state{handle}->push_write (
		674	"$method $rpath HTTP/1.1\015\012"
		675	. (join "", map "\u$_: $hdr{$_}\015\012", grep defined $hdr{$_}, keys %hdr)
		676	. "\015\012"
		677	. (delete $arg{body})
		678	);
		679
		680	# return if error occured during push_write()
		681	return unless %state;
		682
		683	%hdr = (); # reduce memory usage, save a kitten, also make it possible to re-use
		684
		685	# status line and headers
		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
		690	/^HTTP\/0([0-9\.]+) \s+ ([0-9]{3}) (?: \s+ ([^\012]) )? \012/gxci
		691	or return (%state = (), $cb->(undef, { @pseudo, Status => 599, Reason => "Invalid server response" }));
		692
		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,
		702	HTTPVersion => $1,
		703	Status => $2,
		704	Reason => $3,
		705	;
		706
		707	my $hdr = parse_hdr
		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/\/[^\/]*$//;
		724	}
		725
		726	$hdr{location} = "$url/$hdr{location}";
		727	}
		728
		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};
		752	%state = ();
		753
		754	if (defined $_[1]) {
		755	$hdr{OrigStatus} = $hdr{Status}; $hdr{Status} = $_[1];
		756	$hdr{OrigReason} = $hdr{Reason}; $hdr{Reason} = $_[2];
		757	}
		758
		759	# set-cookie processing
		760	if ($arg{cookie_jar}) {
		761	cookie_jar_set_cookie $arg{cookie_jar}, $hdr{"set-cookie"}, $uhost, $hdr{date};
		762	}
		763
		764	if ($redirect && exists $hdr{location}) {
		765	# we ignore any errors, as it is very common to receive
		766	# Content-Length != 0 but no actual body
		767	# we also access %hdr, as $_[1] might be an erro
		768	http_request (
		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});
		828	});
		829	});
		830	} else {
		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	});
		847	}
		848	};
		849
		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
		861	or $finish->("", undef, undef, 1);
		862	});
		863	} else {
		864	$_[0]->on_eof (sub {
		865	$finish->("");
		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	});
		880	} else {
		881	$_[0]->on_error (sub {
		882	($! == Errno::EPIPE \|\| !$!)
		883	? $finish->(delete $_[0]{rbuf})
		884	: $finish->(undef, $ae_error => $_[2]);
		885	});
		886	$_[0]->on_read (sub { });
		887	}
		888	}
		889	};
		890
		891	$state{handle}->push_read (line => $qr_nlnl, $state{read_response});
		892	};
		893
		894	my $connect_cb = sub {
443	$state{fh} = shift	895	$state{fh} = shift
444	or do {	896	or do {
445	my $err = "$!";	897	my $err = "$!";
446	%state = ();	898	%state = ();
447	return $cb->(undef, { Status => 599, Reason => $err, URL => $url });	899	return $cb->(undef, { @pseudo, Status => $ae_error, Reason => $err });
448	};	900	};
449
450	pop; # free memory, save a tree
451		901
452	return unless delete $state{connect_guard};	902	return unless delete $state{connect_guard};
453		903
454	# get handle	904	# get handle
455	$state{handle} = new AnyEvent::Handle	905	$state{handle} = new AnyEvent::Handle
456	fh => $state{fh},	906	fh => $state{fh},
		907	peername => $rhost,
		908	tls_ctx => $arg{tls_ctx},
		909	# these need to be reconfigured on keepalive handles
457	timeout => $timeout,	910	timeout => $timeout,
458	peername => $rhost,	911	on_error => sub {
459	tls_ctx => $arg{tls_ctx};	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	;
460		920
461	# limit the number of persistent connections	921	# limit the number of persistent connections
462	# keepalive not yet supported	922	# keepalive not yet supported
463	if ($KA_COUNT{$_[1]} < $MAX_PERSISTENT_PER_HOST) {	923	# if ($KA_COUNT{$_[1]} < $MAX_PERSISTENT_PER_HOST) {
464	++$KA_COUNT{$_[1]};	924	# ++$KA_COUNT{$_[1]};
465	$state{handle}{ka_count_guard} = AnyEvent::Util::guard {	925	# $state{handle}{ka_count_guard} = AnyEvent::Util::guard {
466	--$KA_COUNT{$_[1]}	926	# --$KA_COUNT{$_[1]}
467	};	927	# };
468	$hdr{connection} = "keep-alive";	928	# $hdr{connection} = "keep-alive";
469	} else {
470	delete $hdr{connection};
471	}	929	# }
472
473	# (re-)configure handle
474	$state{handle}->on_error (sub {
475	%state = ();
476	$cb->(undef, { Status => 599, Reason => $_[2], URL => $url });
477	});
478	$state{handle}->on_eof (sub {
479	%state = ();
480	$cb->(undef, { Status => 599, Reason => "Unexpected end-of-file", URL => $url });
481	});
482		930
483	$state{handle}->starttls ("connect") if $rscheme eq "https";	931	$state{handle}->starttls ("connect") if $rscheme eq "https";
484
485	# handle actual, non-tunneled, request
486	my $handle_actual_request = sub {
487	$state{handle}->starttls ("connect") if $uscheme eq "https" && !exists $state{handle}{tls};
488
489	# send request
490	$state{handle}->push_write (
491	"$method $rpath HTTP/1.0\015\012"
492	. (join "", map "\u$_: $hdr{$_}\015\012", grep defined $hdr{$_}, keys %hdr)
493	. "\015\012"
494	. (delete $arg{body})
495	);
496
497	%hdr = (); # reduce memory usage, save a kitten
498
499	# status line
500	$state{handle}->push_read (line => $qr_nl, sub {
501	$_[1] =~ /^HTTP\/([0-9\.]+) \s+ ([0-9]{3}) (?: \s+ ([^\015\012]*) )?/ix
502	or return (%state = (), $cb->(undef, { Status => 599, Reason => "Invalid server response ($_[1])", URL => $url }));
503
504	my %hdr = ( # response headers
505	HTTPVersion => ",$1",
506	Status => ",$2",
507	Reason => ",$3",
508	URL => ",$url"
509	);
510
511	# headers, could be optimized a bit
512	$state{handle}->unshift_read (line => $qr_nlnl, sub {
513	for ("$_[1]") {
514	y/\015//d; # weed out any \015, as they show up in the weirdest of places.
515
516	# things seen, not parsed:
517	# p3pP="NON CUR OTPi OUR NOR UNI"
518
519	$hdr{lc $1} .= ",$2"
520	while /\G
521	([^:\000-\037]*):
522	[\011\040]*
523	((?: [^\012]+ \| \012[\011\040] )*)
524	\012
525	/gxc;
526
527	/\G$/
528	or return (%state = (), $cb->(undef, { Status => 599, Reason => "Garbled response headers", URL => $url }));
529	}
530
531	substr $_, 0, 1, ""
532	for values %hdr;
533
534	# redirect handling
535	# microsoft and other shitheads don't give a shit for following standards,
536	# try to support some common forms of broken Location headers.
537	if ($hdr{location} !~ /^(?: $ \| [^:\/?\#]+ : )/x) {
538	$hdr{location} =~ s/^\.\/+//;
539
540	my $url = "$rscheme://$uhost:$uport";
541
542	unless ($hdr{location} =~ s/^\///) {
543	$url .= $upath;
544	$url =~ s/\/[^\/]*$//;
545	}
546
547	$hdr{location} = "$url/$hdr{location}";
548	}
549
550	my $redirect;
551
552	if ($recurse) {
553	if ($hdr{Status} =~ /^30[12]$/ && $method ne "POST") {
554	# apparently, mozilla et al. just change POST to GET here
555	# more research is needed before we do the same
556	$redirect = 1;
557	} elsif ($hdr{Status} == 303) {
558	# even http/1.1 is unclear on how to mutate the method
559	$method = "GET" unless $method eq "HEAD";
560	$redirect = 1;
561	} elsif ($hdr{Status} == 307 && $method =~ /^(?:GET\|HEAD)$/) {
562	$redirect = 1;
563	}
564	}
565
566	my $finish = sub {
567	$state{handle}->destroy if $state{handle};
568	%state = ();
569
570	# set-cookie processing
571	if ($arg{cookie_jar}) {
572	for ($_[1]{"set-cookie"}) {
573	# parse NAME=VALUE
574	my @kv;
575
576	while (/\G\s* ([^=;,[:space:]]+) \s=\s (?: "((?:[^\\"]+\|\\.))" \| ([^=;,[:space:]]) )/gcxs) {
577	my $name = $1;
578	my $value = $3;
579
580	unless ($value) {
581	$value = $2;
582	$value =~ s/\\(.)/$1/gs;
583	}
584
585	push @kv, $name => $value;
586
587	last unless /\G\s*;/gc;
588	}
589
590	last unless @kv;
591
592	my $name = shift @kv;
593	my %kv = (value => shift @kv, @kv);
594
595	my $cdom;
596	my $cpath = (delete $kv{path}) \|\| "/";
597
598	if (exists $kv{domain}) {
599	$cdom = delete $kv{domain};
600
601	$cdom =~ s/^\.?/./; # make sure it starts with a "."
602
603	next if $cdom =~ /\.$/;
604
605	# this is not rfc-like and not netscape-like. go figure.
606	my $ndots = $cdom =~ y/.//;
607	next if $ndots < ($cdom =~ /\.[^.][^.]\.[^.][^.]$/ ? 3 : 2);
608	} else {
609	$cdom = $uhost;
610	}
611
612	# store it
613	$arg{cookie_jar}{version} = 1;
614	$arg{cookie_jar}{$cdom}{$cpath}{$name} = \%kv;
615
616	redo if /\G\s*,/gc;
617	}
618	}
619
620	if ($redirect && exists $hdr{location}) {
621	# we ignore any errors, as it is very common to receive
622	# Content-Length != 0 but no actual body
623	# we also access %hdr, as $_[1] might be an erro
624	http_request ($method => $hdr{location}, %arg, recurse => $recurse - 1, $cb);
625	} else {
626	$cb->($_[0], $_[1]);
627	}
628	};
629
630	my $len = $hdr{"content-length"};
631
632	if (!$redirect && $arg{on_header} && !$arg{on_header}(\%hdr)) {
633	$finish->(undef, { Status => 598, Reason => "Request cancelled by on_header", URL => $url });
634	} elsif (
635	$hdr{Status} =~ /^(?:1..\|[23]04)$/
636	or $method eq "HEAD"
637	or (defined $len && !$len)
638	) {
639	# no body
640	$finish->("", \%hdr);
641	} else {
642	# body handling, four different code paths
643	# for want_body_handle, on_body (2x), normal (2x)
644	# we might read too much here, but it does not matter yet (no pers. connections)
645	if (!$redirect && $arg{want_body_handle}) {
646	$_[0]->on_eof (undef);
647	$_[0]->on_error (undef);
648	$_[0]->on_read (undef);
649
650	$finish->(delete $state{handle}, \%hdr);
651
652	} elsif ($arg{on_body}) {
653	$_[0]->on_error (sub { $finish->(undef, { Status => 599, Reason => $_[2], URL => $url }) });
654	if ($len) {
655	$_[0]->on_eof (undef);
656	$_[0]->on_read (sub {
657	$len -= length $_[0]{rbuf};
658
659	$arg{on_body}(delete $_[0]{rbuf}, \%hdr)
660	or $finish->(undef, { Status => 598, Reason => "Request cancelled by on_body", URL => $url });
661
662	$len > 0
663	or $finish->("", \%hdr);
664	});
665	} else {
666	$_[0]->on_eof (sub {
667	$finish->("", \%hdr);
668	});
669	$_[0]->on_read (sub {
670	$arg{on_body}(delete $_[0]{rbuf}, \%hdr)
671	or $finish->(undef, { Status => 598, Reason => "Request cancelled by on_body", URL => $url });
672	});
673	}
674	} else {
675	$_[0]->on_eof (undef);
676
677	if ($len) {
678	$_[0]->on_error (sub { $finish->(undef, { Status => 599, Reason => $_[2], URL => $url }) });
679	$_[0]->on_read (sub {
680	$finish->((substr delete $_[0]{rbuf}, 0, $len, ""), \%hdr)
681	if $len <= length $_[0]{rbuf};
682	});
683	} else {
684	$_[0]->on_error (sub {
685	$! == Errno::EPIPE \|\| !$!
686	? $finish->(delete $_[0]{rbuf}, \%hdr)
687	: $finish->(undef, { Status => 599, Reason => $_[2], URL => $url });
688	});
689	$_[0]->on_read (sub { });
690	}
691	}
692	}
693	});
694	});
695	};
696		932
697	# now handle proxy-CONNECT method	933	# now handle proxy-CONNECT method
698	if ($proxy && $uscheme eq "https") {	934	if ($proxy && $uscheme eq "https") {
699	# oh dear, we have to wrap it into a connect request	935	# oh dear, we have to wrap it into a connect request
700		936
701	# maybe re-use $uauthority with patched port?	937	# maybe re-use $uauthority with patched port?
702	$state{handle}->push_write ("CONNECT $uhost:$uport HTTP/1.0\015\012Host: $uhost\015\012\015\012");	938	$state{handle}->push_write ("CONNECT $uhost:$uport HTTP/1.0\015\012\015\012");
703	$state{handle}->push_read (line => $qr_nlnl, sub {	939	$state{handle}->push_read (line => $qr_nlnl, sub {
704	$_[1] =~ /^HTTP\/([0-9\.]+) \s+ ([0-9]{3}) (?: \s+ ([^\015\012]*) )?/ix	940	$_[1] =~ /^HTTP\/([0-9\.]+) \s+ ([0-9]{3}) (?: \s+ ([^\015\012]*) )?/ix
705	or return (%state = (), $cb->(undef, { Status => 599, Reason => "Invalid proxy connect response ($_[1])", URL => $url }));	941	or return (%state = (), $cb->(undef, { @pseudo, Status => 599, Reason => "Invalid proxy connect response ($_[1])" }));
706		942
707	if ($2 == 200) {	943	if ($2 == 200) {
708	$rpath = $upath;	944	$rpath = $upath;
709	&$handle_actual_request;	945	$handle_actual_request->();
710	} else {	946	} else {
711	%state = ();	947	%state = ();
712	$cb->(undef, { Status => $2, Reason => $3, URL => $url });	948	$cb->(undef, { @pseudo, Status => $2, Reason => $3 });
713	}	949	}
714	});	950	});
715	} else {	951	} else {
716	&$handle_actual_request;	952	$handle_actual_request->();
717	}	953	}
		954	};
718		955
719	}, $arg{on_prepare} \|\| sub { $timeout };	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 });
720	};	960	};
721		961
722	defined wantarray && AnyEvent::Util::guard { %state = () }	962	defined wantarray && AnyEvent::Util::guard { %state = () }
723	}	963	}
724		964
…		…
738	&http_request	978	&http_request
739	}	979	}
740		980
741	=back	981	=back
742		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
743	=head2 GLOBAL FUNCTIONS AND VARIABLES	992	=head2 GLOBAL FUNCTIONS AND VARIABLES
744		993
745	=over 4	994	=over 4
746		995
747	=item AnyEvent::HTTP::set_proxy "proxy-url"	996	=item AnyEvent::HTTP::set_proxy "proxy-url"
…		…
750	string of the form C<http://host:port> (optionally C<https:...>), croaks	999	string of the form C<http://host:port> (optionally C<https:...>), croaks
751	otherwise.	1000	otherwise.
752		1001
753	To clear an already-set proxy, use C<undef>.	1002	To clear an already-set proxy, use C<undef>.
754		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.
		1053
755	=item $AnyEvent::HTTP::MAX_RECURSE	1054	=item $AnyEvent::HTTP::MAX_RECURSE
756		1055
757	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>).
758		1057
759	=item $AnyEvent::HTTP::USERAGENT	1058	=item $AnyEvent::HTTP::USERAGENT
…		…
777	connections. This number of can be useful for load-leveling.	1076	connections. This number of can be useful for load-leveling.
778		1077
779	=back	1078	=back
780		1079
781	=cut	1080	=cut
		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	}
782		1126
783	sub set_proxy($) {	1127	sub set_proxy($) {
784	if (length $_[0]) {	1128	if (length $_[0]) {
785	$_[0] =~ m%^(https?):// ([^:/]+) (?: : (\d*) )?%ix	1129	$_[0] =~ m%^(https?):// ([^:/]+) (?: : (\d*) )?%ix
786	or Carp::croak "$_[0]: invalid proxy URL";	1130	or Carp::croak "$_[0]: invalid proxy URL";
…		…
793	# initialise proxy from environment	1137	# initialise proxy from environment
794	eval {	1138	eval {
795	set_proxy $ENV{http_proxy};	1139	set_proxy $ENV{http_proxy};
796	};	1140	};
797		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	};
		1197
798	=head1 SEE ALSO	1198	=head1 SEE ALSO
799		1199
800	L<AnyEvent>.	1200	L<AnyEvent>.
801		1201
802	=head1 AUTHOR	1202	=head1 AUTHOR

Diff Legend

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

Comparing AnyEvent-HTTP/HTTP.pm (file contents): Revision 1.52 by root, Sat Sep 26 10:13:12 2009 UTC vs. Revision 1.86 by root, Sun Jan 2 06:38:32 2011 UTC

Diff Legend

Comparing AnyEvent-HTTP/HTTP.pm (file contents):
Revision 1.52 by root, Sat Sep 26 10:13:12 2009 UTC vs.
Revision 1.86 by root, Sun Jan 2 06:38:32 2011 UTC