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

Comparing AnyEvent-HTTP/HTTP.pm (file contents):
Revision 1.50 by root, Tue Aug 11 13:20:42 2009 UTC vs.
Revision 1.80 by root, Sat Jan 1 21:51:22 2011 UTC

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

Diff Legend

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

Comparing AnyEvent-HTTP/HTTP.pm (file contents): Revision 1.50 by root, Tue Aug 11 13:20:42 2009 UTC vs. Revision 1.80 by root, Sat Jan 1 21:51:22 2011 UTC

Diff Legend

Comparing AnyEvent-HTTP/HTTP.pm (file contents):
Revision 1.50 by root, Tue Aug 11 13:20:42 2009 UTC vs.
Revision 1.80 by root, Sat Jan 1 21:51:22 2011 UTC