ViewVC Help
View File | Revision Log | Show Annotations | Download File
/cvs/AnyEvent-HTTP/HTTP.pm
(Generate patch)

Comparing AnyEvent-HTTP/HTTP.pm (file contents):
Revision 1.12 by root, Thu Jun 5 16:33:02 2008 UTC vs.
Revision 1.91 by root, Mon Jan 3 01:03:29 2011 UTC

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

Diff Legend

Removed lines
+ Added lines
< Changed lines
> Changed lines