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

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

Diff Legend

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

Comparing AnyEvent-HTTP/HTTP.pm (file contents): Revision 1.45 by root, Fri Jul 17 16:56:36 2009 UTC vs. Revision 1.82 by root, Sun Jan 2 04:50:40 2011 UTC

Diff Legend

Comparing AnyEvent-HTTP/HTTP.pm (file contents):
Revision 1.45 by root, Fri Jul 17 16:56:36 2009 UTC vs.
Revision 1.82 by root, Sun Jan 2 04:50:40 2011 UTC