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

Comparing AnyEvent-HTTP/HTTP.pm (file contents):
Revision 1.55 by root, Wed Jun 16 19:17:30 2010 UTC vs.
Revision 1.88 by root, Sun Jan 2 20:57:03 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.45';	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).
158		173
159	=item timeout => $seconds	174	=item timeout => $seconds
160		175
161	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
162	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
…		…
172	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
173	HTTPS.	188	HTTPS.
174		189
175	=item body => $string	190	=item body => $string
176		191
177	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
178	this module might offer more options).	193	this module might offer more options).
179		194
180	=item cookie_jar => $hash_ref	195	=item cookie_jar => $hash_ref
181		196
182	Passing this parameter enables (simplified) cookie-processing, loosely	197	Passing this parameter enables (simplified) cookie-processing, loosely
183	based on the original netscape specification.	198	based on the original netscape specification.
184		199
185	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
186	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
187	persistent storage with something like JSON or Storable, but this is not	202	to persistent storage with something like JSON or Storable - see the
188	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.
189		206
190	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
191	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
192	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
193	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
194	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.
195		216
196	=item tls_ctx => $scheme \| $tls_ctx	217	=item tls_ctx => $scheme \| $tls_ctx
197		218
198	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
199	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
…		…
212	overrides the prepare callback passed to C<AnyEvent::Socket::tcp_connect>	233	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	234	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	235	timeout). See the description for the C<$prepare_cb> argument of
215	C<AnyEvent::Socket::tcp_connect> for details.	236	C<AnyEvent::Socket::tcp_connect> for details.
216		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
217	=item on_header => $callback->($headers)	250	=item on_header => $callback->($headers)
218		251
219	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
220	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
221	locally-generated errors).	254	locally-generated errors).
…		…
226		259
227	This callback is useful, among other things, to quickly reject unwanted	260	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	261	content, which, if it is supposed to be rare, can be faster than first
229	doing a C<HEAD> request.	262	doing a C<HEAD> request.
230		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
231	Example: cancel the request unless the content-type is "text/html".	268	Example: cancel the request unless the content-type is "text/html".
232		269
233	on_header => sub {	270	on_header => sub {
234	$_[0]{"content-type"} =~ /^text\/html\s*(?:;\|$)/	271	$_[0]{"content-type"} =~ /^text\/html\s*(?:;\|$)/
235	},	272	},
…		…
241	string instead of the body data.	278	string instead of the body data.
242		279
243	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),
244	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
245	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.
246		286
247	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
248	(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
249	be extracted, or when the body should be processed incrementally.	289	be extracted, or when the body should be processed incrementally.
250		290
…		…
276	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
277	that doesn't solve your problem in a better way.	317	that doesn't solve your problem in a better way.
278		318
279	=back	319	=back
280		320
281	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.
282		323
283	http_request GET => "http://www.nethype.de/", sub {	324	http_request GET => "http://www.nethype.de/", sub {
284	my ($body, $hdr) = @_;	325	my ($body, $hdr) = @_;
285	print "$body\n";	326	print "$body\n";
286	};	327	};
287		328
288	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
289	timeout of 30 seconds.	330	timeout of 30 seconds.
290		331
291	http_request	332	http_request
292	GET => "https://www.google.com",	333	GET => "https://www.google.com",
293	timeout => 30,	334	timeout => 30,
…		…
296	use Data::Dumper;	337	use Data::Dumper;
297	print Dumper $hdr;	338	print Dumper $hdr;
298	}	339	}
299	;	340	;
300		341
301	Example: make another simple HTTP GET request, but immediately try to	342	Example: do another simple HTTP GET request, but immediately try to
302	cancel it.	343	cancel it.
303		344
304	my $request = http_request GET => "http://www.nethype.de/", sub {	345	my $request = http_request GET => "http://www.nethype.de/", sub {
305	my ($body, $hdr) = @_;	346	my ($body, $hdr) = @_;
306	print "$body\n";	347	print "$body\n";
…		…
338	push @{ $CO_SLOT{$_[0]}[1] }, $_[1];	379	push @{ $CO_SLOT{$_[0]}[1] }, $_[1];
339		380
340	_slot_schedule $_[0];	381	_slot_schedule $_[0];
341	}	382	}
342		383
343	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
344	our $qr_nlnl = qr{(?<![^\012])\015?\012};	565	our $qr_nlnl = qr{(?<![^\012])\015?\012};
345		566
346	our $TLS_CTX_LOW = { cache => 1, sslv2 => 1 };	567	our $TLS_CTX_LOW = { cache => 1, sslv2 => 1 };
347	our $TLS_CTX_HIGH = { cache => 1, verify => 1, verify_peername => "https" };	568	our $TLS_CTX_HIGH = { cache => 1, verify => 1, verify_peername => "https" };
348		569
…		…
367	my @pseudo = (URL => $url);	588	my @pseudo = (URL => $url);
368	push @pseudo, Redirect => delete $arg{Redirect} if exists $arg{Redirect};	589	push @pseudo, Redirect => delete $arg{Redirect} if exists $arg{Redirect};
369		590
370	my $recurse = exists $arg{recurse} ? delete $arg{recurse} : $MAX_RECURSE;	591	my $recurse = exists $arg{recurse} ? delete $arg{recurse} : $MAX_RECURSE;
371		592
372	return $cb->(undef, { Status => 599, Reason => "Too many redirections", @pseudo })	593	return $cb->(undef, { @pseudo, Status => 599, Reason => "Too many redirections" })
373	if $recurse < 0;	594	if $recurse < 0;
374		595
375	my $proxy = $arg{proxy} \|\| $PROXY;	596	my $proxy = $arg{proxy} \|\| $PROXY;
376	my $timeout = $arg{timeout} \|\| $TIMEOUT;	597	my $timeout = $arg{timeout} \|\| $TIMEOUT;
377		598
378	my ($uscheme, $uauthority, $upath, $query, $fragment) =	599	my ($uscheme, $uauthority, $upath, $query, $fragment) =
379	$url =~ m\|(?:([^:/?#]+):)?(?://([^/?#]))?([^?#])(?:\?([^#]))?(?:#(.))?\|;	600	$url =~ m\|(?:([^:/?#]+):)?(?://([^/?#]))?([^?#])(?:(\?[^#]))?(?:#(.))?\|;
380		601
381	$uscheme = lc $uscheme;	602	$uscheme = lc $uscheme;
382		603
383	my $uport = $uscheme eq "http" ? 80	604	my $uport = $uscheme eq "http" ? 80
384	: $uscheme eq "https" ? 443	605	: $uscheme eq "https" ? 443
385	: return $cb->(undef, { Status => 599, Reason => "Only http and https URL schemes supported", @pseudo });	606	: return $cb->(undef, { @pseudo, Status => 599, Reason => "Only http and https URL schemes supported" });
386		607
387	$uauthority =~ /^(?: .*\@ )? ([^\@:]+) (?: : (\d+) )?$/x	608	$uauthority =~ /^(?: .*\@ )? ([^\@:]+) (?: : (\d+) )?$/x
388	or return $cb->(undef, { Status => 599, Reason => "Unparsable URL", @pseudo });	609	or return $cb->(undef, { @pseudo, Status => 599, Reason => "Unparsable URL" });
389		610
390	my $uhost = $1;	611	my $uhost = lc $1;
391	$uport = $2 if defined $2;	612	$uport = $2 if defined $2;
392		613
393	$hdr{host} = defined $2 ? "$uhost:$2" : "$uhost"	614	$hdr{host} = defined $2 ? "$uhost:$2" : "$uhost"
394	unless exists $hdr{host};	615	unless exists $hdr{host};
395		616
396	$uhost =~ s/^\[(.*)\]$/$1/;	617	$uhost =~ s/^\[(.*)\]$/$1/;
397	$upath .= "?$query" if length $query;	618	$upath .= $query if length $query;
398		619
399	$upath =~ s%^/?%/%;	620	$upath =~ s%^/?%/%;
400		621
401	# cookie processing	622	# cookie processing
402	if (my $jar = $arg{cookie_jar}) {	623	if (my $jar = $arg{cookie_jar}) {
403	%$jar = () if $jar->{version} != 1;	624	my $cookies = cookie_jar_extract $jar, $uscheme, $uhost, $upath;
404		625
405	my @cookie;
406
407	while (my ($chost, $v) = each %$jar) {
408	if ($chost =~ /^\./) {
409	next unless $chost eq substr $uhost, -length $chost;
410	} elsif ($chost =~ /\./) {
411	next unless $chost eq $uhost;
412	} else {
413	next;
414	}
415
416	while (my ($cpath, $v) = each %$v) {
417	next unless $cpath eq substr $upath, 0, length $cpath;
418
419	while (my ($k, $v) = each %$v) {
420	next if $uscheme ne "https" && exists $v->{secure};
421	my $value = $v->{value};
422	$value =~ s/([\\"])/\\$1/g;
423	push @cookie, "$k=\"$value\"";
424	}
425	}
426	}
427
428	$hdr{cookie} = join "; ", @cookie	626	$hdr{cookie} = join "; ", @$cookies
429	if @cookie;	627	if @$cookies;
430	}	628	}
431		629
432	my ($rhost, $rport, $rscheme, $rpath); # request host, port, path	630	my ($rhost, $rport, $rscheme, $rpath); # request host, port, path
433		631
434	if ($proxy) {	632	if ($proxy) {
…		…
437	$rscheme = "http" unless defined $rscheme;	635	$rscheme = "http" unless defined $rscheme;
438		636
439	# don't support https requests over https-proxy transport,	637	# don't support https requests over https-proxy transport,
440	# 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.
441	$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;
442	} else {	643	} else {
443	($rhost, $rport, $rscheme, $rpath) = ($uhost, $uport, $uscheme, $upath);	644	($rhost, $rport, $rscheme, $rpath) = ($uhost, $uport, $uscheme, $upath);
444	}	645	}
445		646
446	# leave out fragment and query string, just a heuristic	647	# leave out fragment and query string, just a heuristic
447	$hdr{referer} \|\|= "$uscheme://$uauthority$upath" unless exists $hdr{referer};	648	$hdr{referer} = "$uscheme://$uauthority$upath" unless exists $hdr{referer};
448	$hdr{"user-agent"} \|\|= $USERAGENT unless exists $hdr{"user-agent"};	649	$hdr{"user-agent"} = $USERAGENT unless exists $hdr{"user-agent"};
449		650
450	$hdr{"content-length"} = length $arg{body}	651	$hdr{"content-length"} = length $arg{body}
451	if length $arg{body} \|\| $method ne "GET";	652	if length $arg{body} \|\| $method ne "GET";
452		653
		654	$hdr{connection} = "close Te"; #1.1
		655	$hdr{te} = "trailers" unless exists $hdr{te}; #1.1
		656
453	my %state = (connect_guard => 1);	657	my %state = (connect_guard => 1);
		658
		659	my $ae_error = 595; # connecting
		660
		661	# handle actual, non-tunneled, request
		662	my $handle_actual_request = sub {
		663	$ae_error = 596; # request phase
		664
		665	$state{handle}->starttls ("connect") if $uscheme eq "https" && !exists $state{handle}{tls};
		666
		667	# send request
		668	$state{handle}->push_write (
		669	"$method $rpath HTTP/1.1\015\012"
		670	. (join "", map "\u$_: $hdr{$_}\015\012", grep defined $hdr{$_}, keys %hdr)
		671	. "\015\012"
		672	. (delete $arg{body})
		673	);
		674
		675	# return if error occured during push_write()
		676	return unless %state;
		677
		678	%hdr = (); # reduce memory usage, save a kitten, also make it possible to re-use
		679
		680	# status line and headers
		681	$state{read_response} = sub {
		682	for ("$_[1]") {
		683	y/\015//d; # weed out any \015, as they show up in the weirdest of places.
		684
		685	/^HTTP\/0([0-9\.]+) \s+ ([0-9]{3}) (?: \s+ ([^\012]) )? \012/gxci
		686	or return (%state = (), $cb->(undef, { @pseudo, Status => 599, Reason => "Invalid server response" }));
		687
		688	# 100 Continue handling
		689	# should not happen as we don't send expect: 100-continue,
		690	# but we handle it just in case.
		691	# since we send the request body regardless, if we get an error
		692	# we are out of-sync, which we currently do NOT handle correctly.
		693	return $state{handle}->push_read (line => $qr_nlnl, $state{read_response})
		694	if $2 eq 100;
		695
		696	push @pseudo,
		697	HTTPVersion => $1,
		698	Status => $2,
		699	Reason => $3,
		700	;
		701
		702	my $hdr = parse_hdr
		703	or return (%state = (), $cb->(undef, { @pseudo, Status => 599, Reason => "Garbled response headers" }));
		704
		705	%hdr = (%$hdr, @pseudo);
		706	}
		707
		708	# redirect handling
		709	# microsoft and other shitheads don't give a shit for following standards,
		710	# try to support some common forms of broken Location headers.
		711	if ($hdr{location} !~ /^(?: $ \| [^:\/?\#]+ : )/x) {
		712	$hdr{location} =~ s/^\.\/+//;
		713
		714	my $url = "$rscheme://$uhost:$uport";
		715
		716	unless ($hdr{location} =~ s/^\///) {
		717	$url .= $upath;
		718	$url =~ s/\/[^\/]*$//;
		719	}
		720
		721	$hdr{location} = "$url/$hdr{location}";
		722	}
		723
		724	my $redirect;
		725
		726	if ($recurse) {
		727	my $status = $hdr{Status};
		728
		729	# industry standard is to redirect POST as GET for
		730	# 301, 302 and 303, in contrast to HTTP/1.0 and 1.1.
		731	# also, the UA should ask the user for 301 and 307 and POST,
		732	# industry standard seems to be to simply follow.
		733	# we go with the industry standard.
		734	if ($status == 301 or $status == 302 or $status == 303) {
		735	# HTTP/1.1 is unclear on how to mutate the method
		736	$method = "GET" unless $method eq "HEAD";
		737	$redirect = 1;
		738	} elsif ($status == 307) {
		739	$redirect = 1;
		740	}
		741	}
		742
		743	my $finish = sub { # ($data, $err_status, $err_reason[, $keepalive])
		744	my $may_keep_alive = $_[3];
		745
		746	$state{handle}->destroy if $state{handle};
		747	%state = ();
		748
		749	if (defined $_[1]) {
		750	$hdr{OrigStatus} = $hdr{Status}; $hdr{Status} = $_[1];
		751	$hdr{OrigReason} = $hdr{Reason}; $hdr{Reason} = $_[2];
		752	}
		753
		754	# set-cookie processing
		755	if ($arg{cookie_jar}) {
		756	cookie_jar_set_cookie $arg{cookie_jar}, $hdr{"set-cookie"}, $uhost, $hdr{date};
		757	}
		758
		759	if ($redirect && exists $hdr{location}) {
		760	# we ignore any errors, as it is very common to receive
		761	# Content-Length != 0 but no actual body
		762	# we also access %hdr, as $_[1] might be an erro
		763	http_request (
		764	$method => $hdr{location},
		765	%arg,
		766	recurse => $recurse - 1,
		767	Redirect => [$_[0], \%hdr],
		768	$cb);
		769	} else {
		770	$cb->($_[0], \%hdr);
		771	}
		772	};
		773
		774	$ae_error = 597; # body phase
		775
		776	my $len = $hdr{"content-length"};
		777
		778	# body handling, many different code paths
		779	# - no body expected
		780	# - want_body_handle
		781	# - te chunked
		782	# - 2x length known (with or without on_body)
		783	# - 2x length not known (with or without on_body)
		784	if (!$redirect && $arg{on_header} && !$arg{on_header}(\%hdr)) {
		785	$finish->(undef, 598 => "Request cancelled by on_header");
		786	} elsif (
		787	$hdr{Status} =~ /^(?:1..\|204\|205\|304)$/
		788	or $method eq "HEAD"
		789	or (defined $len && $len == 0) # == 0, not !, because "0 " is true
		790	) {
		791	# no body
		792	$finish->("", undef, undef, 1);
		793
		794	} elsif (!$redirect && $arg{want_body_handle}) {
		795	$_[0]->on_eof (undef);
		796	$_[0]->on_error (undef);
		797	$_[0]->on_read (undef);
		798
		799	$finish->(delete $state{handle});
		800
		801	} elsif ($hdr{"transfer-encoding"} =~ /\bchunked\b/i) {
		802	my $cl = 0;
		803	my $body = undef;
		804	my $on_body = $arg{on_body} \|\| sub { $body .= shift; 1 };
		805
		806	$state{read_chunk} = sub {
		807	$_[1] =~ /^([0-9a-fA-F]+)/
		808	or $finish->(undef, $ae_error => "Garbled chunked transfer encoding");
		809
		810	my $len = hex $1;
		811
		812	if ($len) {
		813	$cl += $len;
		814
		815	$_[0]->push_read (chunk => $len, sub {
		816	$on_body->($_[1], \%hdr)
		817	or return $finish->(undef, 598 => "Request cancelled by on_body");
		818
		819	$_[0]->push_read (line => sub {
		820	length $_[1]
		821	and return $finish->(undef, $ae_error => "Garbled chunked transfer encoding");
		822	$_[0]->push_read (line => $state{read_chunk});
		823	});
		824	});
		825	} else {
		826	$hdr{"content-length"} \|\|= $cl;
		827
		828	$_[0]->push_read (line => $qr_nlnl, sub {
		829	if (length $_[1]) {
		830	for ("$_[1]") {
		831	y/\015//d; # weed out any \015, as they show up in the weirdest of places.
		832
		833	my $hdr = parse_hdr
		834	or return $finish->(undef, $ae_error => "Garbled response trailers");
		835
		836	%hdr = (%hdr, %$hdr);
		837	}
		838	}
		839
		840	$finish->($body, undef, undef, 1);
		841	});
		842	}
		843	};
		844
		845	$_[0]->push_read (line => $state{read_chunk});
		846
		847	} elsif ($arg{on_body}) {
		848	if (defined $len) {
		849	$_[0]->on_read (sub {
		850	$len -= length $_[0]{rbuf};
		851
		852	$arg{on_body}(delete $_[0]{rbuf}, \%hdr)
		853	or return $finish->(undef, 598 => "Request cancelled by on_body");
		854
		855	$len > 0
		856	or $finish->("", undef, undef, 1);
		857	});
		858	} else {
		859	$_[0]->on_eof (sub {
		860	$finish->("");
		861	});
		862	$_[0]->on_read (sub {
		863	$arg{on_body}(delete $_[0]{rbuf}, \%hdr)
		864	or $finish->(undef, 598 => "Request cancelled by on_body");
		865	});
		866	}
		867	} else {
		868	$_[0]->on_eof (undef);
		869
		870	if (defined $len) {
		871	$_[0]->on_read (sub {
		872	$finish->((substr delete $_[0]{rbuf}, 0, $len, ""), undef, undef, 1)
		873	if $len <= length $_[0]{rbuf};
		874	});
		875	} else {
		876	$_[0]->on_error (sub {
		877	($! == Errno::EPIPE \|\| !$!)
		878	? $finish->(delete $_[0]{rbuf})
		879	: $finish->(undef, $ae_error => $_[2]);
		880	});
		881	$_[0]->on_read (sub { });
		882	}
		883	}
		884	};
		885
		886	$state{handle}->push_read (line => $qr_nlnl, $state{read_response});
		887	};
		888
		889	my $connect_cb = sub {
		890	$state{fh} = shift
		891	or do {
		892	my $err = "$!";
		893	%state = ();
		894	return $cb->(undef, { @pseudo, Status => $ae_error, Reason => $err });
		895	};
		896
		897	return unless delete $state{connect_guard};
		898
		899	# get handle
		900	$state{handle} = new AnyEvent::Handle
		901	fh => $state{fh},
		902	peername => $rhost,
		903	tls_ctx => $arg{tls_ctx},
		904	# these need to be reconfigured on keepalive handles
		905	timeout => $timeout,
		906	on_error => sub {
		907	%state = ();
		908	$cb->(undef, { @pseudo, Status => $ae_error, Reason => $_[2] });
		909	},
		910	on_eof => sub {
		911	%state = ();
		912	$cb->(undef, { @pseudo, Status => $ae_error, Reason => "Unexpected end-of-file" });
		913	},
		914	;
		915
		916	# limit the number of persistent connections
		917	# keepalive not yet supported
		918	# if ($KA_COUNT{$_[1]} < $MAX_PERSISTENT_PER_HOST) {
		919	# ++$KA_COUNT{$_[1]};
		920	# $state{handle}{ka_count_guard} = AnyEvent::Util::guard {
		921	# --$KA_COUNT{$_[1]}
		922	# };
		923	# $hdr{connection} = "keep-alive";
		924	# }
		925
		926	$state{handle}->starttls ("connect") if $rscheme eq "https";
		927
		928	# now handle proxy-CONNECT method
		929	if ($proxy && $uscheme eq "https") {
		930	# oh dear, we have to wrap it into a connect request
		931
		932	# maybe re-use $uauthority with patched port?
		933	$state{handle}->push_write ("CONNECT $uhost:$uport HTTP/1.0\015\012\015\012");
		934	$state{handle}->push_read (line => $qr_nlnl, sub {
		935	$_[1] =~ /^HTTP\/([0-9\.]+) \s+ ([0-9]{3}) (?: \s+ ([^\015\012]*) )?/ix
		936	or return (%state = (), $cb->(undef, { @pseudo, Status => 599, Reason => "Invalid proxy connect response ($_[1])" }));
		937
		938	if ($2 == 200) {
		939	$rpath = $upath;
		940	$handle_actual_request->();
		941	} else {
		942	%state = ();
		943	$cb->(undef, { @pseudo, Status => $2, Reason => $3 });
		944	}
		945	});
		946	} else {
		947	$handle_actual_request->();
		948	}
		949	};
454		950
455	_get_slot $uhost, sub {	951	_get_slot $uhost, sub {
456	$state{slot_guard} = shift;	952	$state{slot_guard} = shift;
457		953
458	return unless $state{connect_guard};	954	return unless $state{connect_guard};
459		955
460	$state{connect_guard} = AnyEvent::Socket::tcp_connect $rhost, $rport, sub {	956	my $tcp_connect = $arg{tcp_connect}
461	$state{fh} = shift	957	\|\| do { require AnyEvent::Socket; \&AnyEvent::Socket::tcp_connect };
462	or do {
463	my $err = "$!";
464	%state = ();
465	return $cb->(undef, { Status => 599, Reason => $err, @pseudo });
466	};
467		958
468	pop; # free memory, save a tree	959	$state{connect_guard} = $tcp_connect->($rhost, $rport, $connect_cb, $arg{on_prepare} \|\| sub { $timeout });
469
470	return unless delete $state{connect_guard};
471
472	# get handle
473	$state{handle} = new AnyEvent::Handle
474	fh => $state{fh},
475	timeout => $timeout,
476	peername => $rhost,
477	tls_ctx => $arg{tls_ctx};
478
479	# limit the number of persistent connections
480	# keepalive not yet supported
481	if ($KA_COUNT{$_[1]} < $MAX_PERSISTENT_PER_HOST) {
482	++$KA_COUNT{$_[1]};
483	$state{handle}{ka_count_guard} = AnyEvent::Util::guard {
484	--$KA_COUNT{$_[1]}
485	};
486	$hdr{connection} = "keep-alive";
487	} else {
488	delete $hdr{connection};
489	}
490
491	# (re-)configure handle
492	$state{handle}->on_error (sub {
493	%state = ();
494	$cb->(undef, { Status => 599, Reason => $_[2], @pseudo });
495	});
496	$state{handle}->on_eof (sub {
497	%state = ();
498	$cb->(undef, { Status => 599, Reason => "Unexpected end-of-file", @pseudo });
499	});
500
501	$state{handle}->starttls ("connect") if $rscheme eq "https";
502
503	# handle actual, non-tunneled, request
504	my $handle_actual_request = sub {
505	$state{handle}->starttls ("connect") if $uscheme eq "https" && !exists $state{handle}{tls};
506
507	# send request
508	$state{handle}->push_write (
509	"$method $rpath HTTP/1.0\015\012"
510	. (join "", map "\u$_: $hdr{$_}\015\012", grep defined $hdr{$_}, keys %hdr)
511	. "\015\012"
512	. (delete $arg{body})
513	);
514
515	# return if error occured during push_write()
516	return unless %state;
517
518	%hdr = (); # reduce memory usage, save a kitten, also make it possible to re-use
519
520	# status line
521	$state{handle}->push_read (line => $qr_nl, sub {
522	$_[1] =~ /^HTTP\/([0-9\.]+) \s+ ([0-9]{3}) (?: \s+ ([^\015\012]*) )?/ix
523	or return (%state = (), $cb->(undef, { Status => 599, Reason => "Invalid server response ($_[1])", @pseudo }));
524
525	push @pseudo,
526	HTTPVersion => $1,
527	Status => $2,
528	Reason => $3,
529	;
530
531	# headers, could be optimized a bit
532	$state{handle}->unshift_read (line => $qr_nlnl, sub {
533	for ("$_[1]") {
534	y/\015//d; # weed out any \015, as they show up in the weirdest of places.
535
536	# things seen, not parsed:
537	# p3pP="NON CUR OTPi OUR NOR UNI"
538
539	$hdr{lc $1} .= ",$2"
540	while /\G
541	([^:\000-\037]*):
542	[\011\040]*
543	((?: [^\012]+ \| \012[\011\040] )*)
544	\012
545	/gxc;
546
547	/\G$/
548	or return (%state = (), $cb->(undef, { Status => 599, Reason => "Garbled response headers", @pseudo }));
549	}
550
551	# remove the "," prefix we added to all headers above
552	substr $_, 0, 1, ""
553	for values %hdr;
554
555	# patch in all pseudo headers
556	%hdr = (%hdr, @pseudo);
557
558	# redirect handling
559	# microsoft and other shitheads don't give a shit for following standards,
560	# try to support some common forms of broken Location headers.
561	if ($hdr{location} !~ /^(?: $ \| [^:\/?\#]+ : )/x) {
562	$hdr{location} =~ s/^\.\/+//;
563
564	my $url = "$rscheme://$uhost:$uport";
565
566	unless ($hdr{location} =~ s/^\///) {
567	$url .= $upath;
568	$url =~ s/\/[^\/]*$//;
569	}
570
571	$hdr{location} = "$url/$hdr{location}";
572	}
573
574	my $redirect;
575
576	if ($recurse) {
577	my $status = $hdr{Status};
578
579	if (($status == 301 \|\| $status == 302) && $method ne "POST") {
580	# apparently, mozilla et al. just change POST to GET here
581	# more research is needed before we do the same
582	$redirect = 1;
583	} elsif ($status == 303) {
584	# even http/1.1 is unclear on how to mutate the method
585	$method = "GET" unless $method eq "HEAD";
586	$redirect = 1;
587	} elsif ($status == 307 && $method =~ /^(?:GET\|HEAD)$/) {
588	$redirect = 1;
589	}
590	}
591
592	my $finish = sub {
593	$state{handle}->destroy if $state{handle};
594	%state = ();
595
596	# set-cookie processing
597	if ($arg{cookie_jar}) {
598	for ($_[1]{"set-cookie"}) {
599	# parse NAME=VALUE
600	my @kv;
601
602	while (/\G\s* ([^=;,[:space:]]+) \s=\s (?: "((?:[^\\"]+\|\\.))" \| ([^=;,[:space:]]) )/gcxs) {
603	my $name = $1;
604	my $value = $3;
605
606	unless ($value) {
607	$value = $2;
608	$value =~ s/\\(.)/$1/gs;
609	}
610
611	push @kv, $name => $value;
612
613	last unless /\G\s*;/gc;
614	}
615
616	last unless @kv;
617
618	my $name = shift @kv;
619	my %kv = (value => shift @kv, @kv);
620
621	my $cdom;
622	my $cpath = (delete $kv{path}) \|\| "/";
623
624	if (exists $kv{domain}) {
625	$cdom = delete $kv{domain};
626
627	$cdom =~ s/^\.?/./; # make sure it starts with a "."
628
629	next if $cdom =~ /\.$/;
630
631	# this is not rfc-like and not netscape-like. go figure.
632	my $ndots = $cdom =~ y/.//;
633	next if $ndots < ($cdom =~ /\.[^.][^.]\.[^.][^.]$/ ? 3 : 2);
634	} else {
635	$cdom = $uhost;
636	}
637
638	# store it
639	$arg{cookie_jar}{version} = 1;
640	$arg{cookie_jar}{$cdom}{$cpath}{$name} = \%kv;
641
642	redo if /\G\s*,/gc;
643	}
644	}
645
646	if ($redirect && exists $hdr{location}) {
647	# we ignore any errors, as it is very common to receive
648	# Content-Length != 0 but no actual body
649	# we also access %hdr, as $_[1] might be an erro
650	http_request (
651	$method => $hdr{location},
652	%arg,
653	recurse => $recurse - 1,
654	Redirect => \@_,
655	$cb);
656	} else {
657	$cb->($_[0], $_[1]);
658	}
659	};
660
661	my $len = $hdr{"content-length"};
662
663	if (!$redirect && $arg{on_header} && !$arg{on_header}(\%hdr)) {
664	$finish->(undef, { Status => 598, Reason => "Request cancelled by on_header", @pseudo });
665	} elsif (
666	$hdr{Status} =~ /^(?:1..\|[23]04)$/
667	or $method eq "HEAD"
668	or (defined $len && !$len)
669	) {
670	# no body
671	$finish->("", \%hdr);
672	} else {
673	# body handling, four different code paths
674	# for want_body_handle, on_body (2x), normal (2x)
675	# we might read too much here, but it does not matter yet (no pers. connections)
676	if (!$redirect && $arg{want_body_handle}) {
677	$_[0]->on_eof (undef);
678	$_[0]->on_error (undef);
679	$_[0]->on_read (undef);
680
681	$finish->(delete $state{handle}, \%hdr);
682
683	} elsif ($arg{on_body}) {
684	$_[0]->on_error (sub { $finish->(undef, { Status => 599, Reason => $_[2], @pseudo }) });
685	if ($len) {
686	$_[0]->on_eof (undef);
687	$_[0]->on_read (sub {
688	$len -= length $_[0]{rbuf};
689
690	$arg{on_body}(delete $_[0]{rbuf}, \%hdr)
691	or $finish->(undef, { Status => 598, Reason => "Request cancelled by on_body", @pseudo });
692
693	$len > 0
694	or $finish->("", \%hdr);
695	});
696	} else {
697	$_[0]->on_eof (sub {
698	$finish->("", \%hdr);
699	});
700	$_[0]->on_read (sub {
701	$arg{on_body}(delete $_[0]{rbuf}, \%hdr)
702	or $finish->(undef, { Status => 598, Reason => "Request cancelled by on_body", @pseudo });
703	});
704	}
705	} else {
706	$_[0]->on_eof (undef);
707
708	if ($len) {
709	$_[0]->on_error (sub { $finish->(undef, { Status => 599, Reason => $_[2], @pseudo }) });
710	$_[0]->on_read (sub {
711	$finish->((substr delete $_[0]{rbuf}, 0, $len, ""), \%hdr)
712	if $len <= length $_[0]{rbuf};
713	});
714	} else {
715	$_[0]->on_error (sub {
716	$! == Errno::EPIPE \|\| !$!
717	? $finish->(delete $_[0]{rbuf}, \%hdr)
718	: $finish->(undef, { Status => 599, Reason => $_[2], @pseudo });
719	});
720	$_[0]->on_read (sub { });
721	}
722	}
723	}
724	});
725	});
726	};
727
728	# now handle proxy-CONNECT method
729	if ($proxy && $uscheme eq "https") {
730	# oh dear, we have to wrap it into a connect request
731
732	# maybe re-use $uauthority with patched port?
733	$state{handle}->push_write ("CONNECT $uhost:$uport HTTP/1.0\015\012Host: $uhost\015\012\015\012");
734	$state{handle}->push_read (line => $qr_nlnl, sub {
735	$_[1] =~ /^HTTP\/([0-9\.]+) \s+ ([0-9]{3}) (?: \s+ ([^\015\012]*) )?/ix
736	or return (%state = (), $cb->(undef, { Status => 599, Reason => "Invalid proxy connect response ($_[1])", @pseudo }));
737
738	if ($2 == 200) {
739	$rpath = $upath;
740	&$handle_actual_request;
741	} else {
742	%state = ();
743	$cb->(undef, { Status => $2, Reason => $3, @pseudo });
744	}
745	});
746	} else {
747	&$handle_actual_request;
748	}
749
750	}, $arg{on_prepare} \|\| sub { $timeout };
751	};	960	};
752		961
753	defined wantarray && AnyEvent::Util::guard { %state = () }	962	defined wantarray && AnyEvent::Util::guard { %state = () }
754	}	963	}
755		964
…		…
790	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
791	otherwise.	1000	otherwise.
792		1001
793	To clear an already-set proxy, use C<undef>.	1002	To clear an already-set proxy, use C<undef>.
794		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
795	=item $AnyEvent::HTTP::MAX_RECURSE	1054	=item $AnyEvent::HTTP::MAX_RECURSE
796		1055
797	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>).
798		1057
799	=item $AnyEvent::HTTP::USERAGENT	1058	=item $AnyEvent::HTTP::USERAGENT
…		…
817	connections. This number of can be useful for load-leveling.	1076	connections. This number of can be useful for load-leveling.
818		1077
819	=back	1078	=back
820		1079
821	=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	}
822		1126
823	sub set_proxy($) {	1127	sub set_proxy($) {
824	if (length $_[0]) {	1128	if (length $_[0]) {
825	$_[0] =~ m%^(https?):// ([^:/]+) (?: : (\d*) )?%ix	1129	$_[0] =~ m%^(https?):// ([^:/]+) (?: : (\d*) )?%ix
826	or Carp::croak "$_[0]: invalid proxy URL";	1130	or Carp::croak "$_[0]: invalid proxy URL";
…		…
833	# initialise proxy from environment	1137	# initialise proxy from environment
834	eval {	1138	eval {
835	set_proxy $ENV{http_proxy};	1139	set_proxy $ENV{http_proxy};
836	};	1140	};
837		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
838	=head1 SEE ALSO	1198	=head1 SEE ALSO
839		1199
840	L<AnyEvent>.	1200	L<AnyEvent>.
841		1201
842	=head1 AUTHOR	1202	=head1 AUTHOR

Diff Legend

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

Comparing AnyEvent-HTTP/HTTP.pm (file contents): Revision 1.55 by root, Wed Jun 16 19:17:30 2010 UTC vs. Revision 1.88 by root, Sun Jan 2 20:57:03 2011 UTC

Diff Legend

Comparing AnyEvent-HTTP/HTTP.pm (file contents):
Revision 1.55 by root, Wed Jun 16 19:17:30 2010 UTC vs.
Revision 1.88 by root, Sun Jan 2 20:57:03 2011 UTC