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

Diff Legend

Removed lines
+ Added lines
< Changed lines
> Changed lines