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.24 by root, Wed Jul 2 01:30:33 2008 UTC vs.
Revision 1.89 by root, Mon Jan 3 00:23:25 2011 UTC

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

Diff Legend

Removed lines
+ Added lines
< Changed lines
> Changed lines