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

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

Diff Legend

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

Comparing AnyEvent-HTTP/HTTP.pm (file contents): Revision 1.57 by root, Mon Sep 6 06:31:32 2010 UTC vs. Revision 1.91 by root, Mon Jan 3 01:03:29 2011 UTC

Diff Legend

Comparing AnyEvent-HTTP/HTTP.pm (file contents):
Revision 1.57 by root, Mon Sep 6 06:31:32 2010 UTC vs.
Revision 1.91 by root, Mon Jan 3 01:03:29 2011 UTC