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

Comparing AnyEvent-HTTP/HTTP.pm (file contents):
Revision 1.49 by root, Wed Aug 5 16:23:48 2009 UTC vs.
Revision 1.87 by root, Sun Jan 2 08:51:53 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 4.8 ();	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.42';	51	our $VERSION = '1.5';
54		52
55	our @EXPORT = qw(http_get http_post http_head http_request);	53	our @EXPORT = qw(http_get http_post http_head http_request);
56		54
57	our $USERAGENT = "Mozilla/5.0 (compatible; U; AnyEvent-HTTP/$VERSION; +http://software.schmorp.de/pkg/AnyEvent)";	55	our $USERAGENT = "Mozilla/5.0 (compatible; U; AnyEvent-HTTP/$VERSION; +http://software.schmorp.de/pkg/AnyEvent)";
58	our $MAX_RECURSE = 10;	56	our $MAX_RECURSE = 10;
…		…
92	must be an absolute http or https URL.	90	must be an absolute http or https URL.
93		91
94	When called in void context, nothing is returned. In other contexts,	92	When called in void context, nothing is returned. In other contexts,
95	C<http_request> returns a "cancellation guard" - you have to keep the	93	C<http_request> returns a "cancellation guard" - you have to keep the
96	object at least alive until the callback get called. If the object gets	94	object at least alive until the callback get called. If the object gets
97	destroyed before the callbakc is called, the request will be cancelled.	95	destroyed before the callback is called, the request will be cancelled.
98		96
99	The callback will be called with the response body data as first argument	97	The callback will be called with the response body data as first argument
100	(or C<undef> if an error occured), and a hash-ref with response headers as	98	(or C<undef> if an error occured), and a hash-ref with response headers
101	second argument.	99	(and trailers) as second argument.
102		100
103	All the headers in that hash are lowercased. In addition to the response	101	All the headers in that hash are lowercased. In addition to the response
104	headers, the "pseudo-headers" C<HTTPVersion>, C<Status> and C<Reason>	102	headers, the "pseudo-headers" (uppercase to avoid clashing with possible
		103	response headers) C<HTTPVersion>, C<Status> and C<Reason> contain the
105	contain the three parts of the HTTP Status-Line of the same name. The	104	three parts of the HTTP Status-Line of the same name. If an error occurs
		105	during the body phase of a request, then the original C<Status> and
		106	C<Reason> values from the header are available as C<OrigStatus> and
		107	C<OrigReason>.
		108
106	pseudo-header C<URL> contains the original URL (which can differ from the	109	The pseudo-header C<URL> contains the actual URL (which can differ from
107	requested URL when following redirects).	110	the requested URL when following redirects - for example, you might get
		111	an error that your URL scheme is not supported even though your URL is a
		112	valid http URL because it redirected to an ftp URL, in which case you can
		113	look at the URL pseudo header).
		114
		115	The pseudo-header C<Redirect> only exists when the request was a result
		116	of an internal redirect. In that case it is an array reference with
		117	the C<($data, $headers)> from the redirect response. Note that this
		118	response could in turn be the result of a redirect itself, and C<<
		119	$headers->{Redirect}[1]{Redirect} >> will then contain the original
		120	response, and so on.
108		121
109	If the server sends a header multiple times, then their contents will be	122	If the server sends a header multiple times, then their contents will be
110	joined together with a comma (C<,>), as per the HTTP spec.	123	joined together with a comma (C<,>), as per the HTTP spec.
111		124
112	If an internal error occurs, such as not being able to resolve a hostname,	125	If an internal error occurs, such as not being able to resolve a hostname,
113	then C<$data> will be C<undef>, C<< $headers->{Status} >> will be C<59x>	126	then C<$data> will be C<undef>, C<< $headers->{Status} >> will be
114	(usually C<599>) and the C<Reason> pseudo-header will contain an error	127	C<590>-C<599> and the C<Reason> pseudo-header will contain an error
115	message.	128	message. Currently the following status codes are used:
		129
		130	=over 4
		131
		132	=item 595 - errors during connection etsbalishment, proxy handshake.
		133
		134	=item 596 - errors during TLS negotiation, request sending and header processing.
		135
		136	=item 597 - errors during body receiving or processing.
		137
		138	=item 598 - user aborted request via C<on_header> or C<on_body>.
		139
		140	=item 599 - other, usually nonretryable, errors (garbled URL etc.).
		141
		142	=back
116		143
117	A typical callback might look like this:	144	A typical callback might look like this:
118		145
119	sub {	146	sub {
120	my ($body, $hdr) = @_;	147	my ($body, $hdr) = @_;
…		…
136	Whether to recurse requests or not, e.g. on redirects, authentication	163	Whether to recurse requests or not, e.g. on redirects, authentication
137	retries and so on, and how often to do so.	164	retries and so on, and how often to do so.
138		165
139	=item headers => hashref	166	=item headers => hashref
140		167
141	The request headers to use. Currently, C<http_request> may provide its	168	The request headers to use. Currently, C<http_request> may provide its own
142	own C<Host:>, C<Content-Length:>, C<Connection:> and C<Cookie:> headers	169	C<Host:>, C<Content-Length:>, C<Connection:> and C<Cookie:> headers and
143	and will provide defaults for C<User-Agent:> and C<Referer:> (this can be	170	will provide defaults at least for C<TE:>, C<Referer:> and C<User-Agent:>
144	suppressed by using C<undef> for these headers in which case they won't be	171	(this can be suppressed by using C<undef> for these headers in which case
145	sent at all).	172	they won't be sent at all).
146		173
147	=item timeout => $seconds	174	=item timeout => $seconds
148		175
149	The time-out to use for various stages - each connect attempt will reset	176	The time-out to use for various stages - each connect attempt will reset
150	the timeout, as will read or write activity. Default timeout is 5 minutes.	177	the timeout, as will read or write activity, i.e. this is not an overall
		178	timeout.
		179
		180	Default timeout is 5 minutes.
151		181
152	=item proxy => [$host, $port[, $scheme]] or undef	182	=item proxy => [$host, $port[, $scheme]] or undef
153		183
154	Use the given http proxy for all requests. If not specified, then the	184	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.	185	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	187	C<$scheme> must be either missing, C<http> for HTTP or C<https> for
158	HTTPS.	188	HTTPS.
159		189
160	=item body => $string	190	=item body => $string
161		191
162	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
163	this module might offer more options).	193	this module might offer more options).
164		194
165	=item cookie_jar => $hash_ref	195	=item cookie_jar => $hash_ref
166		196
167	Passing this parameter enables (simplified) cookie-processing, loosely	197	Passing this parameter enables (simplified) cookie-processing, loosely
168	based on the original netscape specification.	198	based on the original netscape specification.
169		199
170	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
171	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
172	persistent storage with something like JSON or Storable, but this is not	202	to persistent storage with something like JSON or Storable - see the
173	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.
174		206
175	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
176	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
177	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
178	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
179	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.
180		216
181	=item tls_ctx => $scheme \| $tls_ctx	217	=item tls_ctx => $scheme \| $tls_ctx
182		218
183	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
184	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
…		…
188	verification) TLS context.	224	verification) TLS context.
189		225
190	The default for this option is C<low>, which could be interpreted as "give	226	The default for this option is C<low>, which could be interpreted as "give
191	me the page, no matter what".	227	me the page, no matter what".
192		228
		229	=item on_prepare => $callback->($fh)
		230
		231	In rare cases you need to "tune" the socket before it is used to
		232	connect (for exmaple, to bind it on a given IP address). This parameter
		233	overrides the prepare callback passed to C<AnyEvent::Socket::tcp_connect>
		234	and behaves exactly the same way (e.g. it has to provide a
		235	timeout). See the description for the C<$prepare_cb> argument of
		236	C<AnyEvent::Socket::tcp_connect> for details.
		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
193	=item on_header => $callback->($headers)	250	=item on_header => $callback->($headers)
194		251
195	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
196	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
197	locally-generated errors).	254	locally-generated errors).
…		…
202		259
203	This callback is useful, among other things, to quickly reject unwanted	260	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	261	content, which, if it is supposed to be rare, can be faster than first
205	doing a C<HEAD> request.	262	doing a C<HEAD> request.
206		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
207	Example: cancel the request unless the content-type is "text/html".	268	Example: cancel the request unless the content-type is "text/html".
208		269
209	on_header => sub {	270	on_header => sub {
210	$_[0]{"content-type"} =~ /^text\/html\s*(?:;\|$)/	271	$_[0]{"content-type"} =~ /^text\/html\s*(?:;\|$)/
211	},	272	},
…		…
217	string instead of the body data.	278	string instead of the body data.
218		279
219	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),
220	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
221	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.
222		286
223	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
224	(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
225	be extracted, or when the body should be processed incrementally.	289	be extracted, or when the body should be processed incrementally.
226		290
…		…
252	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
253	that doesn't solve your problem in a better way.	317	that doesn't solve your problem in a better way.
254		318
255	=back	319	=back
256		320
257	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.
258		323
259	http_request GET => "http://www.nethype.de/", sub {	324	http_request GET => "http://www.nethype.de/", sub {
260	my ($body, $hdr) = @_;	325	my ($body, $hdr) = @_;
261	print "$body\n";	326	print "$body\n";
262	};	327	};
263		328
264	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
265	timeout of 30 seconds.	330	timeout of 30 seconds.
266		331
267	http_request	332	http_request
268	GET => "https://www.google.com",	333	GET => "https://www.google.com",
269	timeout => 30,	334	timeout => 30,
…		…
272	use Data::Dumper;	337	use Data::Dumper;
273	print Dumper $hdr;	338	print Dumper $hdr;
274	}	339	}
275	;	340	;
276		341
277	Example: make another simple HTTP GET request, but immediately try to	342	Example: do another simple HTTP GET request, but immediately try to
278	cancel it.	343	cancel it.
279		344
280	my $request = http_request GET => "http://www.nethype.de/", sub {	345	my $request = http_request GET => "http://www.nethype.de/", sub {
281	my ($body, $hdr) = @_;	346	my ($body, $hdr) = @_;
282	print "$body\n";	347	print "$body\n";
…		…
314	push @{ $CO_SLOT{$_[0]}[1] }, $_[1];	379	push @{ $CO_SLOT{$_[0]}[1] }, $_[1];
315		380
316	_slot_schedule $_[0];	381	_slot_schedule $_[0];
317	}	382	}
318		383
319	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
320	our $qr_nlnl = qr{(?<![^\012])\015?\012};	565	our $qr_nlnl = qr{(?<![^\012])\015?\012};
321		566
322	our $TLS_CTX_LOW = { cache => 1, sslv2 => 1 };	567	our $TLS_CTX_LOW = { cache => 1, sslv2 => 1 };
323	our $TLS_CTX_HIGH = { cache => 1, verify => 1, verify_peername => "https" };	568	our $TLS_CTX_HIGH = { cache => 1, verify => 1, verify_peername => "https" };
324		569
…		…
337	while (my ($k, $v) = each %$hdr) {	582	while (my ($k, $v) = each %$hdr) {
338	$hdr{lc $k} = $v;	583	$hdr{lc $k} = $v;
339	}	584	}
340	}	585	}
341		586
		587	# pseudo headers for all subsequent responses
		588	my @pseudo = (URL => $url);
		589	push @pseudo, Redirect => delete $arg{Redirect} if exists $arg{Redirect};
		590
342	my $recurse = exists $arg{recurse} ? delete $arg{recurse} : $MAX_RECURSE;	591	my $recurse = exists $arg{recurse} ? delete $arg{recurse} : $MAX_RECURSE;
343		592
344	return $cb->(undef, { Status => 599, Reason => "Too many redirections", URL => $url })	593	return $cb->(undef, { @pseudo, Status => 599, Reason => "Too many redirections" })
345	if $recurse < 0;	594	if $recurse < 0;
346		595
347	my $proxy = $arg{proxy} \|\| $PROXY;	596	my $proxy = $arg{proxy} \|\| $PROXY;
348	my $timeout = $arg{timeout} \|\| $TIMEOUT;	597	my $timeout = $arg{timeout} \|\| $TIMEOUT;
349		598
350	my ($uscheme, $uauthority, $upath, $query, $fragment) =	599	my ($uscheme, $uauthority, $upath, $query, $fragment) =
351	$url =~ m\|(?:([^:/?#]+):)?(?://([^/?#]))?([^?#])(?:\?([^#]))?(?:#(.))?\|;	600	$url =~ m\|(?:([^:/?#]+):)?(?://([^/?#]))?([^?#])(?:(\?[^#]))?(?:#(.))?\|;
352		601
353	$uscheme = lc $uscheme;	602	$uscheme = lc $uscheme;
354		603
355	my $uport = $uscheme eq "http" ? 80	604	my $uport = $uscheme eq "http" ? 80
356	: $uscheme eq "https" ? 443	605	: $uscheme eq "https" ? 443
357	: return $cb->(undef, { Status => 599, Reason => "Only http and https URL schemes supported", URL => $url });	606	: return $cb->(undef, { @pseudo, Status => 599, Reason => "Only http and https URL schemes supported" });
358		607
359	$uauthority =~ /^(?: .*\@ )? ([^\@:]+) (?: : (\d+) )?$/x	608	$uauthority =~ /^(?: .*\@ )? ([^\@:]+) (?: : (\d+) )?$/x
360	or return $cb->(undef, { Status => 599, Reason => "Unparsable URL", URL => $url });	609	or return $cb->(undef, { @pseudo, Status => 599, Reason => "Unparsable URL" });
361		610
362	my $uhost = $1;	611	my $uhost = lc $1;
363	$uport = $2 if defined $2;	612	$uport = $2 if defined $2;
364		613
365	$hdr{host} = defined $2 ? "$uhost:$2" : "$uhost";	614	$hdr{host} = defined $2 ? "$uhost:$2" : "$uhost"
		615	unless exists $hdr{host};
366		616
367	$uhost =~ s/^\[(.*)\]$/$1/;	617	$uhost =~ s/^\[(.*)\]$/$1/;
368	$upath .= "?$query" if length $query;	618	$upath .= $query if length $query;
369		619
370	$upath =~ s%^/?%/%;	620	$upath =~ s%^/?%/%;
371		621
372	# cookie processing	622	# cookie processing
373	if (my $jar = $arg{cookie_jar}) {	623	if (my $jar = $arg{cookie_jar}) {
374	%$jar = () if $jar->{version} != 1;	624	my $cookies = cookie_jar_extract $jar, $uscheme, $uhost, $upath;
375		625
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	626	$hdr{cookie} = join "; ", @$cookies
400	if @cookie;	627	if @$cookies;
401	}	628	}
402		629
403	my ($rhost, $rport, $rscheme, $rpath); # request host, port, path	630	my ($rhost, $rport, $rscheme, $rpath); # request host, port, path
404		631
405	if ($proxy) {	632	if ($proxy) {
…		…
408	$rscheme = "http" unless defined $rscheme;	635	$rscheme = "http" unless defined $rscheme;
409		636
410	# don't support https requests over https-proxy transport,	637	# don't support https requests over https-proxy transport,
411	# 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.
412	$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;
413	} else {	643	} else {
414	($rhost, $rport, $rscheme, $rpath) = ($uhost, $uport, $uscheme, $upath);	644	($rhost, $rport, $rscheme, $rpath) = ($uhost, $uport, $uscheme, $upath);
415	}	645	}
416		646
417	# leave out fragment and query string, just a heuristic	647	# leave out fragment and query string, just a heuristic
418	$hdr{referer} \|\|= "$uscheme://$uauthority$upath" unless exists $hdr{referer};	648	$hdr{referer} = "$uscheme://$uauthority$upath" unless exists $hdr{referer};
419	$hdr{"user-agent"} \|\|= $USERAGENT unless exists $hdr{"user-agent"};	649	$hdr{"user-agent"} = $USERAGENT unless exists $hdr{"user-agent"};
420		650
421	$hdr{"content-length"} = length $arg{body};	651	$hdr{"content-length"} = length $arg{body}
		652	if length $arg{body} \|\| $method ne "GET";
		653
		654	$hdr{connection} = "close Te"; #1.1
		655	$hdr{te} = "trailers" unless exists $hdr{te}; #1.1
422		656
423	my %state = (connect_guard => 1);	657	my %state = (connect_guard => 1);
424		658
425	_get_slot $uhost, sub {	659	_get_slot $uhost, sub {
426	$state{slot_guard} = shift;	660	$state{slot_guard} = shift;
427		661
428	return unless $state{connect_guard};	662	return unless $state{connect_guard};
429		663
430	$state{connect_guard} = AnyEvent::Socket::tcp_connect $rhost, $rport, sub {	664	my $ae_error = 595; # connecting
		665
		666	# handle actual, non-tunneled, request
		667	my $handle_actual_request = sub {
		668	$ae_error = 596; # request phase
		669
		670	$state{handle}->starttls ("connect") if $uscheme eq "https" && !exists $state{handle}{tls};
		671
		672	# send request
		673	$state{handle}->push_write (
		674	"$method $rpath HTTP/1.1\015\012"
		675	. (join "", map "\u$_: $hdr{$_}\015\012", grep defined $hdr{$_}, keys %hdr)
		676	. "\015\012"
		677	. (delete $arg{body})
		678	);
		679
		680	# return if error occured during push_write()
		681	return unless %state;
		682
		683	%hdr = (); # reduce memory usage, save a kitten, also make it possible to re-use
		684
		685	# status line and headers
		686	$state{read_response} = sub {
		687	for ("$_[1]") {
		688	y/\015//d; # weed out any \015, as they show up in the weirdest of places.
		689
		690	/^HTTP\/0([0-9\.]+) \s+ ([0-9]{3}) (?: \s+ ([^\012]) )? \012/gxci
		691	or return (%state = (), $cb->(undef, { @pseudo, Status => 599, Reason => "Invalid server response" }));
		692
		693	# 100 Continue handling
		694	# should not happen as we don't send expect: 100-continue,
		695	# but we handle it just in case.
		696	# since we send the request body regardless, if we get an error
		697	# we are out of-sync, which we currently do NOT handle correctly.
		698	return $state{handle}->push_read (line => $qr_nlnl, $state{read_response})
		699	if $2 eq 100;
		700
		701	push @pseudo,
		702	HTTPVersion => $1,
		703	Status => $2,
		704	Reason => $3,
		705	;
		706
		707	my $hdr = parse_hdr
		708	or return (%state = (), $cb->(undef, { @pseudo, Status => 599, Reason => "Garbled response headers" }));
		709
		710	%hdr = (%$hdr, @pseudo);
		711	}
		712
		713	# redirect handling
		714	# microsoft and other shitheads don't give a shit for following standards,
		715	# try to support some common forms of broken Location headers.
		716	if ($hdr{location} !~ /^(?: $ \| [^:\/?\#]+ : )/x) {
		717	$hdr{location} =~ s/^\.\/+//;
		718
		719	my $url = "$rscheme://$uhost:$uport";
		720
		721	unless ($hdr{location} =~ s/^\///) {
		722	$url .= $upath;
		723	$url =~ s/\/[^\/]*$//;
		724	}
		725
		726	$hdr{location} = "$url/$hdr{location}";
		727	}
		728
		729	my $redirect;
		730
		731	if ($recurse) {
		732	my $status = $hdr{Status};
		733
		734	# industry standard is to redirect POST as GET for
		735	# 301, 302 and 303, in contrast to HTTP/1.0 and 1.1.
		736	# also, the UA should ask the user for 301 and 307 and POST,
		737	# industry standard seems to be to simply follow.
		738	# we go with the industry standard.
		739	if ($status == 301 or $status == 302 or $status == 303) {
		740	# HTTP/1.1 is unclear on how to mutate the method
		741	$method = "GET" unless $method eq "HEAD";
		742	$redirect = 1;
		743	} elsif ($status == 307) {
		744	$redirect = 1;
		745	}
		746	}
		747
		748	my $finish = sub { # ($data, $err_status, $err_reason[, $keepalive])
		749	my $may_keep_alive = $_[3];
		750
		751	$state{handle}->destroy if $state{handle};
		752	%state = ();
		753
		754	if (defined $_[1]) {
		755	$hdr{OrigStatus} = $hdr{Status}; $hdr{Status} = $_[1];
		756	$hdr{OrigReason} = $hdr{Reason}; $hdr{Reason} = $_[2];
		757	}
		758
		759	# set-cookie processing
		760	if ($arg{cookie_jar}) {
		761	cookie_jar_set_cookie $arg{cookie_jar}, $hdr{"set-cookie"}, $uhost, $hdr{date};
		762	}
		763
		764	if ($redirect && exists $hdr{location}) {
		765	# we ignore any errors, as it is very common to receive
		766	# Content-Length != 0 but no actual body
		767	# we also access %hdr, as $_[1] might be an erro
		768	http_request (
		769	$method => $hdr{location},
		770	%arg,
		771	recurse => $recurse - 1,
		772	Redirect => [$_[0], \%hdr],
		773	$cb);
		774	} else {
		775	$cb->($_[0], \%hdr);
		776	}
		777	};
		778
		779	$ae_error = 597; # body phase
		780
		781	my $len = $hdr{"content-length"};
		782
		783	# body handling, many different code paths
		784	# - no body expected
		785	# - want_body_handle
		786	# - te chunked
		787	# - 2x length known (with or without on_body)
		788	# - 2x length not known (with or without on_body)
		789	if (!$redirect && $arg{on_header} && !$arg{on_header}(\%hdr)) {
		790	$finish->(undef, 598 => "Request cancelled by on_header");
		791	} elsif (
		792	$hdr{Status} =~ /^(?:1..\|204\|205\|304)$/
		793	or $method eq "HEAD"
		794	or (defined $len && $len == 0) # == 0, not !, because "0 " is true
		795	) {
		796	# no body
		797	$finish->("", undef, undef, 1);
		798
		799	} elsif (!$redirect && $arg{want_body_handle}) {
		800	$_[0]->on_eof (undef);
		801	$_[0]->on_error (undef);
		802	$_[0]->on_read (undef);
		803
		804	$finish->(delete $state{handle});
		805
		806	} elsif ($hdr{"transfer-encoding"} =~ /\bchunked\b/i) {
		807	my $cl = 0;
		808	my $body = undef;
		809	my $on_body = $arg{on_body} \|\| sub { $body .= shift; 1 };
		810
		811	$state{read_chunk} = sub {
		812	$_[1] =~ /^([0-9a-fA-F]+)/
		813	or $finish->(undef, $ae_error => "Garbled chunked transfer encoding");
		814
		815	my $len = hex $1;
		816
		817	if ($len) {
		818	$cl += $len;
		819
		820	$_[0]->push_read (chunk => $len, sub {
		821	$on_body->($_[1], \%hdr)
		822	or return $finish->(undef, 598 => "Request cancelled by on_body");
		823
		824	$_[0]->push_read (line => sub {
		825	length $_[1]
		826	and return $finish->(undef, $ae_error => "Garbled chunked transfer encoding");
		827	$_[0]->push_read (line => $state{read_chunk});
		828	});
		829	});
		830	} else {
		831	$hdr{"content-length"} \|\|= $cl;
		832
		833	$_[0]->push_read (line => $qr_nlnl, sub {
		834	if (length $_[1]) {
		835	for ("$_[1]") {
		836	y/\015//d; # weed out any \015, as they show up in the weirdest of places.
		837
		838	my $hdr = parse_hdr
		839	or return $finish->(undef, $ae_error => "Garbled response trailers");
		840
		841	%hdr = (%hdr, %$hdr);
		842	}
		843	}
		844
		845	$finish->($body, undef, undef, 1);
		846	});
		847	}
		848	};
		849
		850	$_[0]->push_read (line => $state{read_chunk});
		851
		852	} elsif ($arg{on_body}) {
		853	if (defined $len) {
		854	$_[0]->on_read (sub {
		855	$len -= length $_[0]{rbuf};
		856
		857	$arg{on_body}(delete $_[0]{rbuf}, \%hdr)
		858	or return $finish->(undef, 598 => "Request cancelled by on_body");
		859
		860	$len > 0
		861	or $finish->("", undef, undef, 1);
		862	});
		863	} else {
		864	$_[0]->on_eof (sub {
		865	$finish->("");
		866	});
		867	$_[0]->on_read (sub {
		868	$arg{on_body}(delete $_[0]{rbuf}, \%hdr)
		869	or $finish->(undef, 598 => "Request cancelled by on_body");
		870	});
		871	}
		872	} else {
		873	$_[0]->on_eof (undef);
		874
		875	if (defined $len) {
		876	$_[0]->on_read (sub {
		877	$finish->((substr delete $_[0]{rbuf}, 0, $len, ""), undef, undef, 1)
		878	if $len <= length $_[0]{rbuf};
		879	});
		880	} else {
		881	$_[0]->on_error (sub {
		882	($! == Errno::EPIPE \|\| !$!)
		883	? $finish->(delete $_[0]{rbuf})
		884	: $finish->(undef, $ae_error => $_[2]);
		885	});
		886	$_[0]->on_read (sub { });
		887	}
		888	}
		889	};
		890
		891	$state{handle}->push_read (line => $qr_nlnl, $state{read_response});
		892	};
		893
		894	my $connect_cb = sub {
431	$state{fh} = shift	895	$state{fh} = shift
432	or do {	896	or do {
433	my $err = "$!";	897	my $err = "$!";
434	%state = ();	898	%state = ();
435	return $cb->(undef, { Status => 599, Reason => $err, URL => $url });	899	return $cb->(undef, { @pseudo, Status => $ae_error, Reason => $err });
436	};	900	};
437
438	pop; # free memory, save a tree
439		901
440	return unless delete $state{connect_guard};	902	return unless delete $state{connect_guard};
441		903
442	# get handle	904	# get handle
443	$state{handle} = new AnyEvent::Handle	905	$state{handle} = new AnyEvent::Handle
444	fh => $state{fh},	906	fh => $state{fh},
		907	peername => $rhost,
		908	tls_ctx => $arg{tls_ctx},
		909	# these need to be reconfigured on keepalive handles
445	timeout => $timeout,	910	timeout => $timeout,
446	peername => $rhost,	911	on_error => sub {
447	tls_ctx => $arg{tls_ctx};	912	%state = ();
		913	$cb->(undef, { @pseudo, Status => $ae_error, Reason => $_[2] });
		914	},
		915	on_eof => sub {
		916	%state = ();
		917	$cb->(undef, { @pseudo, Status => $ae_error, Reason => "Unexpected end-of-file" });
		918	},
		919	;
448		920
449	# limit the number of persistent connections	921	# limit the number of persistent connections
450	# keepalive not yet supported	922	# keepalive not yet supported
451	if ($KA_COUNT{$_[1]} < $MAX_PERSISTENT_PER_HOST) {	923	# if ($KA_COUNT{$_[1]} < $MAX_PERSISTENT_PER_HOST) {
452	++$KA_COUNT{$_[1]};	924	# ++$KA_COUNT{$_[1]};
453	$state{handle}{ka_count_guard} = AnyEvent::Util::guard {	925	# $state{handle}{ka_count_guard} = AnyEvent::Util::guard {
454	--$KA_COUNT{$_[1]}	926	# --$KA_COUNT{$_[1]}
455	};	927	# };
456	$hdr{connection} = "keep-alive";	928	# $hdr{connection} = "keep-alive";
457	} else {
458	delete $hdr{connection};
459	}	929	# }
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		930
471	$state{handle}->starttls ("connect") if $rscheme eq "https";	931	$state{handle}->starttls ("connect") if $rscheme eq "https";
472
473	# handle actual, non-tunneled, request
474	my $handle_actual_request = sub {
475	$state{handle}->starttls ("connect") if $uscheme eq "https" && !exists $state{handle}{tls};
476
477	# send request
478	$state{handle}->push_write (
479	"$method $rpath HTTP/1.0\015\012"
480	. (join "", map "\u$_: $hdr{$_}\015\012", grep defined $hdr{$_}, keys %hdr)
481	. "\015\012"
482	. (delete $arg{body})
483	);
484
485	%hdr = (); # reduce memory usage, save a kitten
486
487	# status line
488	$state{handle}->push_read (line => $qr_nl, 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]") {
502	y/\015//d; # weed out any \015, as they show up in the weirdest of places.
503
504	# things seen, not parsed:
505	# p3pP="NON CUR OTPi OUR NOR UNI"
506
507	$hdr{lc $1} .= ",$2"
508	while /\G
509	([^:\000-\037]*):
510	[\011\040]*
511	((?: [^\012]+ \| \012[\011\040] )*)
512	\012
513	/gxc;
514
515	/\G$/
516	or return (%state = (), $cb->(undef, { Status => 599, Reason => "Garbled response headers", URL => $url }));
517	}
518
519	substr $_, 0, 1, ""
520	for values %hdr;
521
522	# redirect handling
523	# microsoft and other shitheads don't give a shit for following standards,
524	# try to support some common forms of broken Location headers.
525	if ($hdr{location} !~ /^(?: $ \| [^:\/?\#]+ : )/x) {
526	$hdr{location} =~ s/^\.\/+//;
527
528	my $url = "$rscheme://$uhost:$uport";
529
530	unless ($hdr{location} =~ s/^\///) {
531	$url .= $upath;
532	$url =~ s/\/[^\/]*$//;
533	}
534
535	$hdr{location} = "$url/$hdr{location}";
536	}
537
538	my $redirect;
539
540	if ($recurse) {
541	if ($hdr{Status} =~ /^30[12]$/ && $method ne "POST") {
542	# apparently, mozilla et al. just change POST to GET here
543	# more research is needed before we do the same
544	$redirect = 1;
545	} elsif ($hdr{Status} == 303) {
546	# even http/1.1 is unclear on how to mutate the method
547	$method = "GET" unless $method eq "HEAD";
548	$redirect = 1;
549	} elsif ($hdr{Status} == 307 && $method =~ /^(?:GET\|HEAD)$/) {
550	$redirect = 1;
551	}
552	}
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	});
682	});
683	};
684		932
685	# now handle proxy-CONNECT method	933	# now handle proxy-CONNECT method
686	if ($proxy && $uscheme eq "https") {	934	if ($proxy && $uscheme eq "https") {
687	# oh dear, we have to wrap it into a connect request	935	# oh dear, we have to wrap it into a connect request
688		936
689	# maybe re-use $uauthority with patched port?	937	# 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");	938	$state{handle}->push_write ("CONNECT $uhost:$uport HTTP/1.0\015\012\015\012");
691	$state{handle}->push_read (line => $qr_nlnl, sub {	939	$state{handle}->push_read (line => $qr_nlnl, sub {
692	$_[1] =~ /^HTTP\/([0-9\.]+) \s+ ([0-9]{3}) (?: \s+ ([^\015\012]*) )?/ix	940	$_[1] =~ /^HTTP\/([0-9\.]+) \s+ ([0-9]{3}) (?: \s+ ([^\015\012]*) )?/ix
693	or return (%state = (), $cb->(undef, { Status => 599, Reason => "Invalid proxy connect response ($_[1])", URL => $url }));	941	or return (%state = (), $cb->(undef, { @pseudo, Status => 599, Reason => "Invalid proxy connect response ($_[1])" }));
694		942
695	if ($2 == 200) {	943	if ($2 == 200) {
696	$rpath = $upath;	944	$rpath = $upath;
697	&$handle_actual_request;	945	$handle_actual_request->();
698	} else {	946	} else {
699	%state = ();	947	%state = ();
700	$cb->(undef, { Status => $2, Reason => $3, URL => $url });	948	$cb->(undef, { @pseudo, Status => $2, Reason => $3 });
701	}	949	}
702	});	950	});
703	} else {	951	} else {
704	&$handle_actual_request;	952	$handle_actual_request->();
705	}	953	}
706
707	}, sub {
708	$timeout
709	};	954	};
		955
		956	my $tcp_connect = $arg{tcp_connect}
		957	\|\| do { require AnyEvent::Socket; \&AnyEvent::Socket::tcp_connect };
		958
		959	$state{connect_guard} = $tcp_connect->($rhost, $rport, $connect_cb, $arg{on_prepare} \|\| sub { $timeout });
710	};	960	};
711		961
712	defined wantarray && AnyEvent::Util::guard { %state = () }	962	defined wantarray && AnyEvent::Util::guard { %state = () }
713	}	963	}
714		964
…		…
728	&http_request	978	&http_request
729	}	979	}
730		980
731	=back	981	=back
732		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
733	=head2 GLOBAL FUNCTIONS AND VARIABLES	992	=head2 GLOBAL FUNCTIONS AND VARIABLES
734		993
735	=over 4	994	=over 4
736		995
737	=item AnyEvent::HTTP::set_proxy "proxy-url"	996	=item AnyEvent::HTTP::set_proxy "proxy-url"
738		997
739	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
740	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.
741		1053
742	=item $AnyEvent::HTTP::MAX_RECURSE	1054	=item $AnyEvent::HTTP::MAX_RECURSE
743		1055
744	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>).
745		1057
…		…
765		1077
766	=back	1078	=back
767		1079
768	=cut	1080	=cut
769		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
770	sub set_proxy($) {	1127	sub set_proxy($) {
		1128	if (length $_[0]) {
771	$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	}
772	}	1135	}
773		1136
774	# initialise proxy from environment	1137	# initialise proxy from environment
		1138	eval {
775	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	};
776		1197
777	=head1 SEE ALSO	1198	=head1 SEE ALSO
778		1199
779	L<AnyEvent>.	1200	L<AnyEvent>.
780		1201

Diff Legend

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

Comparing AnyEvent-HTTP/HTTP.pm (file contents): Revision 1.49 by root, Wed Aug 5 16:23:48 2009 UTC vs. Revision 1.87 by root, Sun Jan 2 08:51:53 2011 UTC

Diff Legend

Comparing AnyEvent-HTTP/HTTP.pm (file contents):
Revision 1.49 by root, Wed Aug 5 16:23:48 2009 UTC vs.
Revision 1.87 by root, Sun Jan 2 08:51:53 2011 UTC