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.35 by root, Thu Oct 30 03:47:01 2008 UTC vs.
Revision 1.137 by root, Mon Apr 27 12:14:12 2020 UTC

15This 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
16run a supported event loop. 16run a supported event loop.
17 17
18This module implements a simple, stateless and non-blocking HTTP 18This module implements a simple, stateless and non-blocking HTTP
19client. It supports GET, POST and other request methods, cookies and more, 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 20all on a very low level. It can follow redirects, supports proxies, and
21automatically limits the number of connections to the values specified in 21automatically limits the number of connections to the values specified in
22the RFC. 22the RFC.
23 23
24It should generally be a "good client" that is enough for most HTTP 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 25tasks. Simple tasks should be simple, but complex tasks should still be
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.1'; 51our $VERSION = 2.25;
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;
60our $PERSISTENT_TIMEOUT = 2; 57our $PERSISTENT_TIMEOUT = 3;
61our $TIMEOUT = 300; 58our $TIMEOUT = 300;
62 59our $MAX_PER_HOST = 4; # changing this is evil
63# changing these is evil
64our $MAX_PERSISTENT_PER_HOST = 2;
65our $MAX_PER_HOST = 4;
66 60
67our $PROXY; 61our $PROXY;
68our $ACTIVE = 0; 62our $ACTIVE = 0;
69 63
70my %KA_COUNT; # number of open keep-alive connections per host 64my %KA_CACHE; # indexed by uhost currently, points to [$handle...] array
71my %CO_SLOT; # number of open connections, and wait queue, per host 65my %CO_SLOT; # number of open connections, and wait queue, per host
72 66
73=item http_get $url, key => value..., $cb->($data, $headers) 67=item http_get $url, key => value..., $cb->($data, $headers)
74 68
75Executes an HTTP-GET request. See the http_request function for details on 69Executes an HTTP-GET request. See the http_request function for details on
92must be an absolute http or https URL. 86must be an absolute http or https URL.
93 87
94When called in void context, nothing is returned. In other contexts, 88When called in void context, nothing is returned. In other contexts,
95C<http_request> returns a "cancellation guard" - you have to keep the 89C<http_request> returns a "cancellation guard" - you have to keep the
96object at least alive until the callback get called. If the object gets 90object at least alive until the callback get called. If the object gets
97destroyed before the callbakc is called, the request will be cancelled. 91destroyed before the callback is called, the request will be cancelled.
98 92
99The callback will be called with the response data as first argument 93The callback will be called with the response body data as first argument
100(or C<undef> if it wasn't available due to errors), and a hash-ref with 94(or C<undef> if an error occurred), and a hash-ref with response headers
101response headers as second argument. 95(and trailers) as second argument.
102 96
103All the headers in that hash are lowercased. In addition to the response 97All the headers in that hash are lowercased. In addition to the response
104headers, the "pseudo-headers" C<HTTPVersion>, C<Status> and C<Reason> 98headers, the "pseudo-headers" (uppercase to avoid clashing with possible
99response headers) C<HTTPVersion>, C<Status> and C<Reason> contain the
105contain the three parts of the HTTP Status-Line of the same name. The 100three parts of the HTTP Status-Line of the same name. If an error occurs
101during the body phase of a request, then the original C<Status> and
102C<Reason> values from the header are available as C<OrigStatus> and
103C<OrigReason>.
104
106pseudo-header C<URL> contains the original URL (which can differ from the 105The pseudo-header C<URL> contains the actual URL (which can differ from
107requested URL when following redirects). 106the requested URL when following redirects - for example, you might get
107an error that your URL scheme is not supported even though your URL is a
108valid http URL because it redirected to an ftp URL, in which case you can
109look at the URL pseudo header).
110
111The pseudo-header C<Redirect> only exists when the request was a result
112of an internal redirect. In that case it is an array reference with
113the C<($data, $headers)> from the redirect response. Note that this
114response could in turn be the result of a redirect itself, and C<<
115$headers->{Redirect}[1]{Redirect} >> will then contain the original
116response, and so on.
108 117
109If the server sends a header multiple times, then their contents will be 118If the server sends a header multiple times, then their contents will be
110joined together with a comma (C<,>), as per the HTTP spec. 119joined together with a comma (C<,>), as per the HTTP spec.
111 120
112If an internal error occurs, such as not being able to resolve a hostname, 121If an internal error occurs, such as not being able to resolve a hostname,
113then C<$data> will be C<undef>, C<< $headers->{Status} >> will be C<599> 122then C<$data> will be C<undef>, C<< $headers->{Status} >> will be
114and the C<Reason> pseudo-header will contain an error message. 123C<590>-C<599> and the C<Reason> pseudo-header will contain an error
124message. Currently the following status codes are used:
125
126=over 4
127
128=item 595 - errors during connection establishment, proxy handshake.
129
130=item 596 - errors during TLS negotiation, request sending and header processing.
131
132=item 597 - errors during body receiving or processing.
133
134=item 598 - user aborted request via C<on_header> or C<on_body>.
135
136=item 599 - other, usually nonretryable, errors (garbled URL etc.).
137
138=back
115 139
116A typical callback might look like this: 140A typical callback might look like this:
117 141
118 sub { 142 sub {
119 my ($body, $hdr) = @_; 143 my ($body, $hdr) = @_;
130 154
131=over 4 155=over 4
132 156
133=item recurse => $count (default: $MAX_RECURSE) 157=item recurse => $count (default: $MAX_RECURSE)
134 158
135Whether to recurse requests or not, e.g. on redirects, authentication 159Whether to recurse requests or not, e.g. on redirects, authentication and
136retries and so on, and how often to do so. 160other retries and so on, and how often to do so.
161
162Only redirects to http and https URLs are supported. While most common
163redirection forms are handled entirely within this module, some require
164the use of the optional L<URI> module. If it is required but missing, then
165the request will fail with an error.
137 166
138=item headers => hashref 167=item headers => hashref
139 168
140The request headers to use. Currently, C<http_request> may provide its 169The request headers to use. Currently, C<http_request> may provide its own
141own C<Host:>, C<Content-Length:>, C<Connection:> and C<Cookie:> headers 170C<Host:>, C<Content-Length:>, C<Connection:> and C<Cookie:> headers and
142and will provide defaults for C<User-Agent:> and C<Referer:>. 171will provide defaults at least for C<TE:>, C<Referer:> and C<User-Agent:>
172(this can be suppressed by using C<undef> for these headers in which case
173they won't be sent at all).
174
175You really should provide your own C<User-Agent:> header value that is
176appropriate for your program - I wouldn't be surprised if the default
177AnyEvent string gets blocked by webservers sooner or later.
178
179Also, make sure that your headers names and values do not contain any
180embedded newlines.
143 181
144=item timeout => $seconds 182=item timeout => $seconds
145 183
146The time-out to use for various stages - each connect attempt will reset 184The time-out to use for various stages - each connect attempt will reset
147the timeout, as will read or write activity. Default timeout is 5 minutes. 185the timeout, as will read or write activity, i.e. this is not an overall
186timeout.
187
188Default timeout is 5 minutes.
148 189
149=item proxy => [$host, $port[, $scheme]] or undef 190=item proxy => [$host, $port[, $scheme]] or undef
150 191
151Use the given http proxy for all requests. If not specified, then the 192Use the given http proxy for all requests, or no proxy if C<undef> is
152default proxy (as specified by C<$ENV{http_proxy}>) is used. 193used.
153 194
154C<$scheme> must be either missing or C<http> for HTTP, or C<https> for 195C<$scheme> must be either missing or must be C<http> for HTTP.
155HTTPS. 196
197If not specified, then the default proxy is used (see
198C<AnyEvent::HTTP::set_proxy>).
199
200Currently, if your proxy requires authorization, you have to specify an
201appropriate "Proxy-Authorization" header in every request.
202
203Note that this module will prefer an existing persistent connection,
204even if that connection was made using another proxy. If you need to
205ensure that a new connection is made in this case, you can either force
206C<persistent> to false or e.g. use the proxy address in your C<sessionid>.
156 207
157=item body => $string 208=item body => $string
158 209
159The request body, usually empty. Will be-sent as-is (future versions of 210The request body, usually empty. Will be sent as-is (future versions of
160this module might offer more options). 211this module might offer more options).
161 212
162=item cookie_jar => $hash_ref 213=item cookie_jar => $hash_ref
163 214
164Passing this parameter enables (simplified) cookie-processing, loosely 215Passing this parameter enables (simplified) cookie-processing, loosely
165based on the original netscape specification. 216based on the original netscape specification.
166 217
167The C<$hash_ref> must be an (initially empty) hash reference which will 218The C<$hash_ref> must be an (initially empty) hash reference which
168get updated automatically. It is possible to save the cookie_jar to 219will get updated automatically. It is possible to save the cookie jar
169persistent storage with something like JSON or Storable, but this is not 220to persistent storage with something like JSON or Storable - see the
170recommended, as expire times are currently being ignored. 221C<AnyEvent::HTTP::cookie_jar_expire> function if you wish to remove
222expired or session-only cookies, and also for documentation on the format
223of the cookie jar.
171 224
172Note that this cookie implementation is not of very high quality, nor 225Note that this cookie implementation is not meant to be complete. If
173meant to be complete. If you want complete cookie management you have to 226you want complete cookie management you have to do that on your
174do that on your own. C<cookie_jar> is meant as a quick fix to get some 227own. C<cookie_jar> is meant as a quick fix to get most cookie-using sites
175cookie-using sites working. Cookies are a privacy disaster, do not use 228working. Cookies are a privacy disaster, do not use them unless required
176them unless required to. 229to.
230
231When cookie processing is enabled, the C<Cookie:> and C<Set-Cookie:>
232headers will be set and handled by this module, otherwise they will be
233left untouched.
234
235=item tls_ctx => $scheme | $tls_ctx
236
237Specifies the AnyEvent::TLS context to be used for https connections. This
238parameter follows the same rules as the C<tls_ctx> parameter to
239L<AnyEvent::Handle>, but additionally, the two strings C<low> or
240C<high> can be specified, which give you a predefined low-security (no
241verification, highest compatibility) and high-security (CA and common-name
242verification) TLS context.
243
244The default for this option is C<low>, which could be interpreted as "give
245me the page, no matter what".
246
247See also the C<sessionid> parameter.
248
249=item sessionid => $string
250
251The module might reuse connections to the same host internally (regardless
252of other settings, such as C<tcp_connect> or C<proxy>). Sometimes (e.g.
253when using TLS or a specfic proxy), you do not want to reuse connections
254from other sessions. This can be achieved by setting this parameter to
255some unique ID (such as the address of an object storing your state data
256or the TLS context, or the proxy IP) - only connections using the same
257unique ID will be reused.
258
259=item on_prepare => $callback->($fh)
260
261In rare cases you need to "tune" the socket before it is used to
262connect (for example, to bind it on a given IP address). This parameter
263overrides the prepare callback passed to C<AnyEvent::Socket::tcp_connect>
264and behaves exactly the same way (e.g. it has to provide a
265timeout). See the description for the C<$prepare_cb> argument of
266C<AnyEvent::Socket::tcp_connect> for details.
267
268=item tcp_connect => $callback->($host, $service, $connect_cb, $prepare_cb)
269
270In even rarer cases you want total control over how AnyEvent::HTTP
271establishes connections. Normally it uses L<AnyEvent::Socket::tcp_connect>
272to do this, but you can provide your own C<tcp_connect> function -
273obviously, it has to follow the same calling conventions, except that it
274may always return a connection guard object.
275
276The connections made by this hook will be treated as equivalent to
277connections made the built-in way, specifically, they will be put into
278and taken from the persistent connection cache. If your C<$tcp_connect>
279function is incompatible with this kind of re-use, consider switching off
280C<persistent> connections and/or providing a C<sessionid> identifier.
281
282There are probably lots of weird uses for this function, starting from
283tracing the hosts C<http_request> actually tries to connect, to (inexact
284but fast) host => IP address caching or even socks protocol support.
285
286=item on_header => $callback->($headers)
287
288When specified, this callback will be called with the header hash as soon
289as headers have been successfully received from the remote server (not on
290locally-generated errors).
291
292It has to return either true (in which case AnyEvent::HTTP will continue),
293or false, in which case AnyEvent::HTTP will cancel the download (and call
294the finish callback with an error code of C<598>).
295
296This callback is useful, among other things, to quickly reject unwanted
297content, which, if it is supposed to be rare, can be faster than first
298doing a C<HEAD> request.
299
300The downside is that cancelling the request makes it impossible to re-use
301the connection. Also, the C<on_header> callback will not receive any
302trailer (headers sent after the response body).
303
304Example: cancel the request unless the content-type is "text/html".
305
306 on_header => sub {
307 $_[0]{"content-type"} =~ /^text\/html\s*(?:;|$)/
308 },
309
310=item on_body => $callback->($partial_body, $headers)
311
312When specified, all body data will be passed to this callback instead of
313to the completion callback. The completion callback will get the empty
314string instead of the body data.
315
316It has to return either true (in which case AnyEvent::HTTP will continue),
317or false, in which case AnyEvent::HTTP will cancel the download (and call
318the completion callback with an error code of C<598>).
319
320The downside to cancelling the request is that it makes it impossible to
321re-use the connection.
322
323This callback is useful when the data is too large to be held in memory
324(so the callback writes it to a file) or when only some information should
325be extracted, or when the body should be processed incrementally.
326
327It is usually preferred over doing your own body handling via
328C<want_body_handle>, but in case of streaming APIs, where HTTP is
329only used to create a connection, C<want_body_handle> is the better
330alternative, as it allows you to install your own event handler, reducing
331resource usage.
332
333=item want_body_handle => $enable
334
335When enabled (default is disabled), the behaviour of AnyEvent::HTTP
336changes considerably: after parsing the headers, and instead of
337downloading the body (if any), the completion callback will be
338called. Instead of the C<$body> argument containing the body data, the
339callback will receive the L<AnyEvent::Handle> object associated with the
340connection. In error cases, C<undef> will be passed. When there is no body
341(e.g. status C<304>), the empty string will be passed.
342
343The handle object might or might not be in TLS mode, might be connected
344to a proxy, be a persistent connection, use chunked transfer encoding
345etc., and configured in unspecified ways. The user is responsible for this
346handle (it will not be used by this module anymore).
347
348This is useful with some push-type services, where, after the initial
349headers, an interactive protocol is used (typical example would be the
350push-style twitter API which starts a JSON/XML stream).
351
352If you think you need this, first have a look at C<on_body>, to see if
353that doesn't solve your problem in a better way.
354
355=item persistent => $boolean
356
357Try to create/reuse a persistent connection. When this flag is set
358(default: true for idempotent requests, false for all others), then
359C<http_request> tries to re-use an existing (previously-created)
360persistent connection to same host (i.e. identical URL scheme, hostname,
361port and sessionid) and, failing that, tries to create a new one.
362
363Requests failing in certain ways will be automatically retried once, which
364is dangerous for non-idempotent requests, which is why it defaults to off
365for them. The reason for this is because the bozos who designed HTTP/1.1
366made it impossible to distinguish between a fatal error and a normal
367connection timeout, so you never know whether there was a problem with
368your request or not.
369
370When reusing an existent connection, many parameters (such as TLS context)
371will be ignored. See the C<sessionid> parameter for a workaround.
372
373=item keepalive => $boolean
374
375Only used when C<persistent> is also true. This parameter decides whether
376C<http_request> tries to handshake a HTTP/1.0-style keep-alive connection
377(as opposed to only a HTTP/1.1 persistent connection).
378
379The default is true, except when using a proxy, in which case it defaults
380to false, as HTTP/1.0 proxies cannot support this in a meaningful way.
381
382=item handle_params => { key => value ... }
383
384The key-value pairs in this hash will be passed to any L<AnyEvent::Handle>
385constructor that is called - not all requests will create a handle, and
386sometimes more than one is created, so this parameter is only good for
387setting hints.
388
389Example: set the maximum read size to 4096, to potentially conserve memory
390at the cost of speed.
391
392 handle_params => {
393 max_read_size => 4096,
394 },
177 395
178=back 396=back
179 397
180Example: make a simple HTTP GET request for http://www.nethype.de/ 398Example: do a simple HTTP GET request for http://www.nethype.de/ and print
399the response body.
181 400
182 http_request GET => "http://www.nethype.de/", sub { 401 http_request GET => "http://www.nethype.de/", sub {
183 my ($body, $hdr) = @_; 402 my ($body, $hdr) = @_;
184 print "$body\n"; 403 print "$body\n";
185 }; 404 };
186 405
187Example: make a HTTP HEAD request on https://www.google.com/, use a 406Example: do a HTTP HEAD request on https://www.google.com/, use a
188timeout of 30 seconds. 407timeout of 30 seconds.
189 408
190 http_request 409 http_request
191 GET => "https://www.google.com", 410 HEAD => "https://www.google.com",
411 headers => { "user-agent" => "MySearchClient 1.0" },
192 timeout => 30, 412 timeout => 30,
193 sub { 413 sub {
194 my ($body, $hdr) = @_; 414 my ($body, $hdr) = @_;
195 use Data::Dumper; 415 use Data::Dumper;
196 print Dumper $hdr; 416 print Dumper $hdr;
197 } 417 }
198 ; 418 ;
199 419
200Example: make another simple HTTP GET request, but immediately try to 420Example: do another simple HTTP GET request, but immediately try to
201cancel it. 421cancel it.
202 422
203 my $request = http_request GET => "http://www.nethype.de/", sub { 423 my $request = http_request GET => "http://www.nethype.de/", sub {
204 my ($body, $hdr) = @_; 424 my ($body, $hdr) = @_;
205 print "$body\n"; 425 print "$body\n";
206 }; 426 };
207 427
208 undef $request; 428 undef $request;
209 429
210=cut 430=cut
431
432#############################################################################
433# wait queue/slots
211 434
212sub _slot_schedule; 435sub _slot_schedule;
213sub _slot_schedule($) { 436sub _slot_schedule($) {
214 my $host = shift; 437 my $host = shift;
215 438
237 push @{ $CO_SLOT{$_[0]}[1] }, $_[1]; 460 push @{ $CO_SLOT{$_[0]}[1] }, $_[1];
238 461
239 _slot_schedule $_[0]; 462 _slot_schedule $_[0];
240} 463}
241 464
242our $qr_nl = qr<\015?\012>; 465#############################################################################
243our $qr_nlnl = qr<\015?\012\015?\012>; 466# cookie handling
467
468# expire cookies
469sub cookie_jar_expire($;$) {
470 my ($jar, $session_end) = @_;
471
472 %$jar = () if $jar->{version} != 2;
473
474 my $anow = AE::now;
475
476 while (my ($chost, $paths) = each %$jar) {
477 next unless ref $paths;
478
479 while (my ($cpath, $cookies) = each %$paths) {
480 while (my ($cookie, $kv) = each %$cookies) {
481 if (exists $kv->{_expires}) {
482 delete $cookies->{$cookie}
483 if $anow > $kv->{_expires};
484 } elsif ($session_end) {
485 delete $cookies->{$cookie};
486 }
487 }
488
489 delete $paths->{$cpath}
490 unless %$cookies;
491 }
492
493 delete $jar->{$chost}
494 unless %$paths;
495 }
496}
497
498# extract cookies from jar
499sub cookie_jar_extract($$$$) {
500 my ($jar, $scheme, $host, $path) = @_;
501
502 %$jar = () if $jar->{version} != 2;
503
504 $host = AnyEvent::Util::idn_to_ascii $host
505 if $host =~ /[^\x00-\x7f]/;
506
507 my @cookies;
508
509 while (my ($chost, $paths) = each %$jar) {
510 next unless ref $paths;
511
512 # exact match or suffix including . match
513 $chost eq $host or ".$chost" eq substr $host, -1 - length $chost
514 or next;
515
516 while (my ($cpath, $cookies) = each %$paths) {
517 next unless $cpath eq substr $path, 0, length $cpath;
518
519 while (my ($cookie, $kv) = each %$cookies) {
520 next if $scheme ne "https" && exists $kv->{secure};
521
522 if (exists $kv->{_expires} and AE::now > $kv->{_expires}) {
523 delete $cookies->{$cookie};
524 next;
525 }
526
527 my $value = $kv->{value};
528
529 if ($value =~ /[=;,[:space:]]/) {
530 $value =~ s/([\\"])/\\$1/g;
531 $value = "\"$value\"";
532 }
533
534 push @cookies, "$cookie=$value";
535 }
536 }
537 }
538
539 \@cookies
540}
541
542# parse set_cookie header into jar
543sub cookie_jar_set_cookie($$$$) {
544 my ($jar, $set_cookie, $host, $date) = @_;
545
546 %$jar = () if $jar->{version} != 2;
547
548 my $anow = int AE::now;
549 my $snow; # server-now
550
551 for ($set_cookie) {
552 # parse NAME=VALUE
553 my @kv;
554
555 # expires is not http-compliant in the original cookie-spec,
556 # we support the official date format and some extensions
557 while (
558 m{
559 \G\s*
560 (?:
561 expires \s*=\s* ([A-Z][a-z][a-z]+,\ [^,;]+)
562 | ([^=;,[:space:]]+) (?: \s*=\s* (?: "((?:[^\\"]+|\\.)*)" | ([^;,[:space:]]*) ) )?
563 )
564 }gcxsi
565 ) {
566 my $name = $2;
567 my $value = $4;
568
569 if (defined $1) {
570 # expires
571 $name = "expires";
572 $value = $1;
573 } elsif (defined $3) {
574 # quoted
575 $value = $3;
576 $value =~ s/\\(.)/$1/gs;
577 }
578
579 push @kv, @kv ? lc $name : $name, $value;
580
581 last unless /\G\s*;/gc;
582 }
583
584 last unless @kv;
585
586 my $name = shift @kv;
587 my %kv = (value => shift @kv, @kv);
588
589 if (exists $kv{"max-age"}) {
590 $kv{_expires} = $anow + delete $kv{"max-age"};
591 } elsif (exists $kv{expires}) {
592 $snow ||= parse_date ($date) || $anow;
593 $kv{_expires} = $anow + (parse_date (delete $kv{expires}) - $snow);
594 } else {
595 delete $kv{_expires};
596 }
597
598 my $cdom;
599 my $cpath = (delete $kv{path}) || "/";
600
601 if (exists $kv{domain}) {
602 $cdom = $kv{domain};
603
604 $cdom =~ s/^\.?/./; # make sure it starts with a "."
605
606 next if $cdom =~ /\.$/;
607
608 # this is not rfc-like and not netscape-like. go figure.
609 my $ndots = $cdom =~ y/.//;
610 next if $ndots < ($cdom =~ /\.[^.][^.]\.[^.][^.]$/ ? 3 : 2);
611
612 $cdom = substr $cdom, 1; # remove initial .
613 } else {
614 $cdom = $host;
615 }
616
617 # store it
618 $jar->{version} = 2;
619 $jar->{lc $cdom}{$cpath}{$name} = \%kv;
620
621 redo if /\G\s*,/gc;
622 }
623}
624
625#############################################################################
626# keepalive/persistent connection cache
627
628# fetch a connection from the keepalive cache
629sub ka_fetch($) {
630 my $ka_key = shift;
631
632 my $hdl = pop @{ $KA_CACHE{$ka_key} }; # currently we reuse the MOST RECENTLY USED connection
633 delete $KA_CACHE{$ka_key}
634 unless @{ $KA_CACHE{$ka_key} };
635
636 $hdl
637}
638
639sub ka_store($$) {
640 my ($ka_key, $hdl) = @_;
641
642 my $kaa = $KA_CACHE{$ka_key} ||= [];
643
644 my $destroy = sub {
645 my @ka = grep $_ != $hdl, @{ $KA_CACHE{$ka_key} };
646
647 $hdl->destroy;
648
649 @ka
650 ? $KA_CACHE{$ka_key} = \@ka
651 : delete $KA_CACHE{$ka_key};
652 };
653
654 # on error etc., destroy
655 $hdl->on_error ($destroy);
656 $hdl->on_eof ($destroy);
657 $hdl->on_read ($destroy);
658 $hdl->timeout ($PERSISTENT_TIMEOUT);
659
660 push @$kaa, $hdl;
661 shift @$kaa while @$kaa > $MAX_PER_HOST;
662}
663
664#############################################################################
665# utilities
666
667# continue to parse $_ for headers and place them into the arg
668sub _parse_hdr() {
669 my %hdr;
670
671 # things seen, not parsed:
672 # p3pP="NON CUR OTPi OUR NOR UNI"
673
674 $hdr{lc $1} .= ",$2"
675 while /\G
676 ([^:\000-\037]*):
677 [\011\040]*
678 ((?: [^\012]+ | \012[\011\040] )*)
679 \012
680 /gxc;
681
682 /\G$/
683 or return;
684
685 # remove the "," prefix we added to all headers above
686 substr $_, 0, 1, ""
687 for values %hdr;
688
689 \%hdr
690}
691
692#############################################################################
693# http_get
694
695our $qr_nlnl = qr{(?<![^\012])\015?\012};
696
697our $TLS_CTX_LOW = { cache => 1, sslv2 => 1 };
698our $TLS_CTX_HIGH = { cache => 1, verify => 1, verify_peername => "https" };
699
700# maybe it should just become a normal object :/
701
702sub _destroy_state(\%) {
703 my ($state) = @_;
704
705 $state->{handle}->destroy if $state->{handle};
706 %$state = ();
707}
708
709sub _error(\%$$) {
710 my ($state, $cb, $hdr) = @_;
711
712 &_destroy_state ($state);
713
714 $cb->(undef, $hdr);
715 ()
716}
717
718our %IDEMPOTENT = (
719 DELETE => 1,
720 GET => 1,
721 HEAD => 1,
722 OPTIONS => 1,
723 PUT => 1,
724 TRACE => 1,
725
726 ACL => 1,
727 "BASELINE-CONTROL" => 1,
728 BIND => 1,
729 CHECKIN => 1,
730 CHECKOUT => 1,
731 COPY => 1,
732 LABEL => 1,
733 LINK => 1,
734 MERGE => 1,
735 MKACTIVITY => 1,
736 MKCALENDAR => 1,
737 MKCOL => 1,
738 MKREDIRECTREF => 1,
739 MKWORKSPACE => 1,
740 MOVE => 1,
741 ORDERPATCH => 1,
742 PROPFIND => 1,
743 PROPPATCH => 1,
744 REBIND => 1,
745 REPORT => 1,
746 SEARCH => 1,
747 UNBIND => 1,
748 UNCHECKOUT => 1,
749 UNLINK => 1,
750 UNLOCK => 1,
751 UPDATE => 1,
752 UPDATEREDIRECTREF => 1,
753 "VERSION-CONTROL" => 1,
754);
244 755
245sub http_request($$@) { 756sub http_request($$@) {
246 my $cb = pop; 757 my $cb = pop;
247 my ($method, $url, %arg) = @_; 758 my ($method, $url, %arg) = @_;
248 759
249 my %hdr; 760 my %hdr;
761
762 $arg{tls_ctx} = $TLS_CTX_LOW if $arg{tls_ctx} eq "low" || !exists $arg{tls_ctx};
763 $arg{tls_ctx} = $TLS_CTX_HIGH if $arg{tls_ctx} eq "high";
250 764
251 $method = uc $method; 765 $method = uc $method;
252 766
253 if (my $hdr = $arg{headers}) { 767 if (my $hdr = $arg{headers}) {
254 while (my ($k, $v) = each %$hdr) { 768 while (my ($k, $v) = each %$hdr) {
255 $hdr{lc $k} = $v; 769 $hdr{lc $k} = $v;
256 } 770 }
257 } 771 }
258 772
773 # pseudo headers for all subsequent responses
774 my @pseudo = (URL => $url);
775 push @pseudo, Redirect => delete $arg{Redirect} if exists $arg{Redirect};
776
259 my $recurse = exists $arg{recurse} ? delete $arg{recurse} : $MAX_RECURSE; 777 my $recurse = exists $arg{recurse} ? delete $arg{recurse} : $MAX_RECURSE;
260 778
261 return $cb->(undef, { Status => 599, Reason => "recursion limit reached", URL => $url }) 779 return $cb->(undef, { @pseudo, Status => 599, Reason => "Too many redirections" })
262 if $recurse < 0; 780 if $recurse < 0;
263 781
264 my $proxy = $arg{proxy} || $PROXY; 782 my $proxy = exists $arg{proxy} ? $arg{proxy} : $PROXY;
265 my $timeout = $arg{timeout} || $TIMEOUT; 783 my $timeout = $arg{timeout} || $TIMEOUT;
266 784
267 $hdr{"user-agent"} ||= $USERAGENT;
268
269 my ($uscheme, $uauthority, $upath, $query, $fragment) = 785 my ($uscheme, $uauthority, $upath, $query, undef) = # ignore fragment
270 $url =~ m|(?:([^:/?#]+):)?(?://([^/?#]*))?([^?#]*)(?:\?([^#]*))?(?:#(.*))?|; 786 $url =~ m|^([^:]+):(?://([^/?#]*))?([^?#]*)(?:(\?[^#]*))?(?:#(.*))?$|;
271 787
272 $uscheme = lc $uscheme; 788 $uscheme = lc $uscheme;
273 789
274 my $uport = $uscheme eq "http" ? 80 790 my $uport = $uscheme eq "http" ? 80
275 : $uscheme eq "https" ? 443 791 : $uscheme eq "https" ? 443
276 : return $cb->(undef, { Status => 599, Reason => "only http and https URL schemes supported", URL => $url }); 792 : return $cb->(undef, { @pseudo, Status => 599, Reason => "Only http and https URL schemes supported" });
277 793
278 $hdr{referer} ||= "$uscheme://$uauthority$upath"; # leave out fragment and query string, just a heuristic
279
280 $uauthority =~ /^(?: .*\@ )? ([^\@:]+) (?: : (\d+) )?$/x 794 $uauthority =~ /^(?: .*\@ )? ([^\@]+?) (?: : (\d+) )?$/x
281 or return $cb->(undef, { Status => 599, Reason => "unparsable URL", URL => $url }); 795 or return $cb->(undef, { @pseudo, Status => 599, Reason => "Unparsable URL" });
282 796
283 my $uhost = $1; 797 my $uhost = lc $1;
284 $uport = $2 if defined $2; 798 $uport = $2 if defined $2;
285 799
800 $hdr{host} = defined $2 ? "$uhost:$2" : "$uhost"
801 unless exists $hdr{host};
802
286 $uhost =~ s/^\[(.*)\]$/$1/; 803 $uhost =~ s/^\[(.*)\]$/$1/;
287 $upath .= "?$query" if length $query; 804 $upath .= $query if length $query;
288 805
289 $upath =~ s%^/?%/%; 806 $upath =~ s%^/?%/%;
290 807
291 # cookie processing 808 # cookie processing
292 if (my $jar = $arg{cookie_jar}) { 809 if (my $jar = $arg{cookie_jar}) {
293 %$jar = () if $jar->{version} != 1; 810 my $cookies = cookie_jar_extract $jar, $uscheme, $uhost, $upath;
294 811
295 my @cookie;
296
297 while (my ($chost, $v) = each %$jar) {
298 if ($chost =~ /^\./) {
299 next unless $chost eq substr $uhost, -length $chost;
300 } elsif ($chost =~ /\./) {
301 next unless $chost eq $uhost;
302 } else {
303 next;
304 }
305
306 while (my ($cpath, $v) = each %$v) {
307 next unless $cpath eq substr $upath, 0, length $cpath;
308
309 while (my ($k, $v) = each %$v) {
310 next if $uscheme ne "https" && exists $v->{secure};
311 my $value = $v->{value};
312 $value =~ s/([\\"])/\\$1/g;
313 push @cookie, "$k=\"$value\"";
314 }
315 }
316 }
317
318 $hdr{cookie} = join "; ", @cookie 812 $hdr{cookie} = join "; ", @$cookies
319 if @cookie; 813 if @$cookies;
320 } 814 }
321 815
322 my ($rhost, $rport, $rscheme, $rpath); # request host, port, path 816 my ($rhost, $rport, $rscheme, $rpath); # request host, port, path
323 817
324 if ($proxy) { 818 if ($proxy) {
325 ($rhost, $rport, $rscheme, $rpath) = (@$proxy, $url); 819 ($rpath, $rhost, $rport, $rscheme) = ($url, @$proxy);
820
821 $rscheme = "http" unless defined $rscheme;
326 822
327 # don't support https requests over https-proxy transport, 823 # don't support https requests over https-proxy transport,
328 # can't be done with tls as spec'ed. 824 # can't be done with tls as spec'ed, unless you double-encrypt.
329 $rscheme = "http" if $uscheme eq "https" && $rscheme eq "https"; 825 $rscheme = "http" if $uscheme eq "https" && $rscheme eq "https";
826
827 $rhost = lc $rhost;
828 $rscheme = lc $rscheme;
330 } else { 829 } else {
331 ($rhost, $rport, $rscheme, $rpath) = ($uhost, $uport, $uscheme, $upath); 830 ($rhost, $rport, $rscheme, $rpath) = ($uhost, $uport, $uscheme, $upath);
332 } 831 }
333 832
334 $hdr{host} = $uhost; 833 # leave out fragment and query string, just a heuristic
834 $hdr{referer} = "$uscheme://$uauthority$upath" unless exists $hdr{referer};
835 $hdr{"user-agent"} = $USERAGENT unless exists $hdr{"user-agent"};
836
335 $hdr{"content-length"} = length $arg{body}; 837 $hdr{"content-length"} = length $arg{body}
838 if length $arg{body} || $method ne "GET";
839
840 my $idempotent = $IDEMPOTENT{$method};
841
842 # default value for keepalive is true iff the request is for an idempotent method
843 my $persistent = exists $arg{persistent} ? !!$arg{persistent} : $idempotent;
844 my $keepalive = exists $arg{keepalive} ? !!$arg{keepalive} : !$proxy;
845 my $was_persistent; # true if this is actually a recycled connection
846
847 # the key to use in the keepalive cache
848 my $ka_key = "$uscheme\x00$uhost\x00$uport\x00$arg{sessionid}";
849
850 $hdr{connection} = ($persistent ? $keepalive ? "keep-alive, " : "" : "close, ") . "Te"; #1.1
851 $hdr{te} = "trailers" unless exists $hdr{te}; #1.1
336 852
337 my %state = (connect_guard => 1); 853 my %state = (connect_guard => 1);
854
855 my $ae_error = 595; # connecting
856
857 # handle actual, non-tunneled, request
858 my $handle_actual_request = sub {
859 $ae_error = 596; # request phase
860
861 my $hdl = $state{handle};
862
863 $hdl->starttls ("connect") if $uscheme eq "https" && !exists $hdl->{tls};
864
865 # send request
866 $hdl->push_write (
867 "$method $rpath HTTP/1.1\015\012"
868 . (join "", map "\u$_: $hdr{$_}\015\012", grep defined $hdr{$_}, keys %hdr)
869 . "\015\012"
870 . $arg{body}
871 );
872
873 # return if error occurred during push_write()
874 return unless %state;
875
876 # reduce memory usage, save a kitten, also re-use it for the response headers.
877 %hdr = ();
878
879 # status line and headers
880 $state{read_response} = sub {
881 return unless %state;
882
883 for ("$_[1]") {
884 y/\015//d; # weed out any \015, as they show up in the weirdest of places.
885
886 /^HTTP\/0*([0-9\.]+) \s+ ([0-9]{3}) (?: \s+ ([^\012]*) )? \012/gxci
887 or return _error %state, $cb, { @pseudo, Status => 599, Reason => "Invalid server response" };
888
889 # 100 Continue handling
890 # should not happen as we don't send expect: 100-continue,
891 # but we handle it just in case.
892 # since we send the request body regardless, if we get an error
893 # we are out of-sync, which we currently do NOT handle correctly.
894 return $state{handle}->push_read (line => $qr_nlnl, $state{read_response})
895 if $2 eq 100;
896
897 push @pseudo,
898 HTTPVersion => $1,
899 Status => $2,
900 Reason => $3,
901 ;
902
903 my $hdr = _parse_hdr
904 or return _error %state, $cb, { @pseudo, Status => 599, Reason => "Garbled response headers" };
905
906 %hdr = (%$hdr, @pseudo);
907 }
908
909 # redirect handling
910 # relative uri handling forced by microsoft and other shitheads.
911 # we give our best and fall back to URI if available.
912 if (exists $hdr{location}) {
913 my $loc = $hdr{location};
914
915 if ($loc =~ m%^//%) { # //
916 $loc = "$uscheme:$loc";
917
918 } elsif ($loc eq "") {
919 $loc = $url;
920
921 } elsif ($loc !~ /^(?: $ | [^:\/?\#]+ : )/x) { # anything "simple"
922 $loc =~ s/^\.\/+//;
923
924 if ($loc !~ m%^[.?#]%) {
925 my $prefix = "$uscheme://$uauthority";
926
927 unless ($loc =~ s/^\///) {
928 $prefix .= $upath;
929 $prefix =~ s/\/[^\/]*$//;
930 }
931
932 $loc = "$prefix/$loc";
933
934 } elsif (eval { require URI }) { # uri
935 $loc = URI->new_abs ($loc, $url)->as_string;
936
937 } else {
938 return _error %state, $cb, { @pseudo, Status => 599, Reason => "Cannot parse Location (URI module missing)" };
939 #$hdr{Status} = 599;
940 #$hdr{Reason} = "Unparsable Redirect (URI module missing)";
941 #$recurse = 0;
942 }
943 }
944
945 $hdr{location} = $loc;
946 }
947
948 my $redirect;
949
950 if ($recurse) {
951 my $status = $hdr{Status};
952
953 # industry standard is to redirect POST as GET for
954 # 301, 302 and 303, in contrast to HTTP/1.0 and 1.1.
955 # also, the UA should ask the user for 301 and 307 and POST,
956 # industry standard seems to be to simply follow.
957 # we go with the industry standard. 308 is defined
958 # by rfc7538
959 if ($status == 301 or $status == 302 or $status == 303) {
960 $redirect = 1;
961 # HTTP/1.1 is unclear on how to mutate the method
962 unless ($method eq "HEAD") {
963 $method = "GET";
964 delete $arg{body};
965 }
966 } elsif ($status == 307 or $status == 308) {
967 $redirect = 1;
968 }
969 }
970
971 my $finish = sub { # ($data, $err_status, $err_reason[, $persistent])
972 if ($state{handle}) {
973 # handle keepalive
974 if (
975 $persistent
976 && $_[3]
977 && ($hdr{HTTPVersion} < 1.1
978 ? $hdr{connection} =~ /\bkeep-?alive\b/i
979 : $hdr{connection} !~ /\bclose\b/i)
980 ) {
981 ka_store $ka_key, delete $state{handle};
982 } else {
983 # no keepalive, destroy the handle
984 $state{handle}->destroy;
985 }
986 }
987
988 %state = ();
989
990 if (defined $_[1]) {
991 $hdr{OrigStatus} = $hdr{Status}; $hdr{Status} = $_[1];
992 $hdr{OrigReason} = $hdr{Reason}; $hdr{Reason} = $_[2];
993 }
994
995 # set-cookie processing
996 if ($arg{cookie_jar}) {
997 cookie_jar_set_cookie $arg{cookie_jar}, $hdr{"set-cookie"}, $uhost, $hdr{date};
998 }
999
1000 if ($redirect && exists $hdr{location}) {
1001 # we ignore any errors, as it is very common to receive
1002 # Content-Length != 0 but no actual body
1003 # we also access %hdr, as $_[1] might be an erro
1004 $state{recurse} =
1005 http_request (
1006 $method => $hdr{location},
1007 %arg,
1008 recurse => $recurse - 1,
1009 Redirect => [$_[0], \%hdr],
1010 sub {
1011 %state = ();
1012 &$cb
1013 },
1014 );
1015 } else {
1016 $cb->($_[0], \%hdr);
1017 }
1018 };
1019
1020 $ae_error = 597; # body phase
1021
1022 my $chunked = $hdr{"transfer-encoding"} =~ /\bchunked\b/i; # not quite correct...
1023
1024 my $len = $chunked ? undef : $hdr{"content-length"};
1025
1026 # body handling, many different code paths
1027 # - no body expected
1028 # - want_body_handle
1029 # - te chunked
1030 # - 2x length known (with or without on_body)
1031 # - 2x length not known (with or without on_body)
1032 if (!$redirect && $arg{on_header} && !$arg{on_header}(\%hdr)) {
1033 $finish->(undef, 598 => "Request cancelled by on_header");
1034 } elsif (
1035 $hdr{Status} =~ /^(?:1..|204|205|304)$/
1036 or $method eq "HEAD"
1037 or (defined $len && $len == 0) # == 0, not !, because "0 " is true
1038 ) {
1039 # no body
1040 $finish->("", undef, undef, 1);
1041
1042 } elsif (!$redirect && $arg{want_body_handle}) {
1043 $_[0]->on_eof (undef);
1044 $_[0]->on_error (undef);
1045 $_[0]->on_read (undef);
1046
1047 $finish->(delete $state{handle});
1048
1049 } elsif ($chunked) {
1050 my $cl = 0;
1051 my $body = "";
1052 my $on_body = (!$redirect && $arg{on_body}) || sub { $body .= shift; 1 };
1053
1054 $state{read_chunk} = sub {
1055 $_[1] =~ /^([0-9a-fA-F]+)/
1056 or return $finish->(undef, $ae_error => "Garbled chunked transfer encoding");
1057
1058 my $len = hex $1;
1059
1060 if ($len) {
1061 $cl += $len;
1062
1063 $_[0]->push_read (chunk => $len, sub {
1064 $on_body->($_[1], \%hdr)
1065 or return $finish->(undef, 598 => "Request cancelled by on_body");
1066
1067 $_[0]->push_read (line => sub {
1068 length $_[1]
1069 and return $finish->(undef, $ae_error => "Garbled chunked transfer encoding");
1070 $_[0]->push_read (line => $state{read_chunk});
1071 });
1072 });
1073 } else {
1074 $hdr{"content-length"} ||= $cl;
1075
1076 $_[0]->push_read (line => $qr_nlnl, sub {
1077 if (length $_[1]) {
1078 for ("$_[1]") {
1079 y/\015//d; # weed out any \015, as they show up in the weirdest of places.
1080
1081 my $hdr = _parse_hdr
1082 or return $finish->(undef, $ae_error => "Garbled response trailers");
1083
1084 %hdr = (%hdr, %$hdr);
1085 }
1086 }
1087
1088 $finish->($body, undef, undef, 1);
1089 });
1090 }
1091 };
1092
1093 $_[0]->push_read (line => $state{read_chunk});
1094
1095 } elsif (!$redirect && $arg{on_body}) {
1096 if (defined $len) {
1097 $_[0]->on_read (sub {
1098 $len -= length $_[0]{rbuf};
1099
1100 $arg{on_body}(delete $_[0]{rbuf}, \%hdr)
1101 or return $finish->(undef, 598 => "Request cancelled by on_body");
1102
1103 $len > 0
1104 or $finish->("", undef, undef, 1);
1105 });
1106 } else {
1107 $_[0]->on_eof (sub {
1108 $finish->("");
1109 });
1110 $_[0]->on_read (sub {
1111 $arg{on_body}(delete $_[0]{rbuf}, \%hdr)
1112 or $finish->(undef, 598 => "Request cancelled by on_body");
1113 });
1114 }
1115 } else {
1116 $_[0]->on_eof (undef);
1117
1118 if (defined $len) {
1119 $_[0]->on_read (sub {
1120 $finish->((substr delete $_[0]{rbuf}, 0, $len, ""), undef, undef, 1)
1121 if $len <= length $_[0]{rbuf};
1122 });
1123 } else {
1124 $_[0]->on_error (sub {
1125 ($! == Errno::EPIPE || !$!)
1126 ? $finish->(delete $_[0]{rbuf})
1127 : $finish->(undef, $ae_error => $_[2]);
1128 });
1129 $_[0]->on_read (sub { });
1130 }
1131 }
1132 };
1133
1134 # if keepalive is enabled, then the server closing the connection
1135 # before a response can happen legally - we retry on idempotent methods.
1136 if ($was_persistent && $idempotent) {
1137 my $old_eof = $hdl->{on_eof};
1138 $hdl->{on_eof} = sub {
1139 _destroy_state %state;
1140
1141 %state = ();
1142 $state{recurse} =
1143 http_request (
1144 $method => $url,
1145 %arg,
1146 recurse => $recurse - 1,
1147 persistent => 0,
1148 sub {
1149 %state = ();
1150 &$cb
1151 }
1152 );
1153 };
1154 $hdl->on_read (sub {
1155 return unless %state;
1156
1157 # as soon as we receive something, a connection close
1158 # once more becomes a hard error
1159 $hdl->{on_eof} = $old_eof;
1160 $hdl->push_read (line => $qr_nlnl, $state{read_response});
1161 });
1162 } else {
1163 $hdl->push_read (line => $qr_nlnl, $state{read_response});
1164 }
1165 };
1166
1167 my $prepare_handle = sub {
1168 my ($hdl) = $state{handle};
1169
1170 $hdl->on_error (sub {
1171 _error %state, $cb, { @pseudo, Status => $ae_error, Reason => $_[2] };
1172 });
1173 $hdl->on_eof (sub {
1174 _error %state, $cb, { @pseudo, Status => $ae_error, Reason => "Unexpected end-of-file" };
1175 });
1176 $hdl->timeout_reset;
1177 $hdl->timeout ($timeout);
1178 };
1179
1180 # connected to proxy (or origin server)
1181 my $connect_cb = sub {
1182 my $fh = shift
1183 or return _error %state, $cb, { @pseudo, Status => $ae_error, Reason => "$!" };
1184
1185 return unless delete $state{connect_guard};
1186
1187 # get handle
1188 $state{handle} = new AnyEvent::Handle
1189 %{ $arg{handle_params} },
1190 fh => $fh,
1191 peername => $uhost,
1192 tls_ctx => $arg{tls_ctx},
1193 ;
1194
1195 $prepare_handle->();
1196
1197 #$state{handle}->starttls ("connect") if $rscheme eq "https";
1198
1199 # now handle proxy-CONNECT method
1200 if ($proxy && $uscheme eq "https") {
1201 # oh dear, we have to wrap it into a connect request
1202
1203 my $auth = exists $hdr{"proxy-authorization"}
1204 ? "proxy-authorization: " . (delete $hdr{"proxy-authorization"}) . "\015\012"
1205 : "";
1206
1207 # maybe re-use $uauthority with patched port?
1208 $state{handle}->push_write ("CONNECT $uhost:$uport HTTP/1.0\015\012$auth\015\012");
1209 $state{handle}->push_read (line => $qr_nlnl, sub {
1210 $_[1] =~ /^HTTP\/([0-9\.]+) \s+ ([0-9]{3}) (?: \s+ ([^\015\012]*) )?/ix
1211 or return _error %state, $cb, { @pseudo, Status => 599, Reason => "Invalid proxy connect response ($_[1])" };
1212
1213 if ($2 == 200) {
1214 $rpath = $upath;
1215 $handle_actual_request->();
1216 } else {
1217 _error %state, $cb, { @pseudo, Status => $2, Reason => $3 };
1218 }
1219 });
1220 } else {
1221 delete $hdr{"proxy-authorization"} unless $proxy;
1222
1223 $handle_actual_request->();
1224 }
1225 };
338 1226
339 _get_slot $uhost, sub { 1227 _get_slot $uhost, sub {
340 $state{slot_guard} = shift; 1228 $state{slot_guard} = shift;
341 1229
342 return unless $state{connect_guard}; 1230 return unless $state{connect_guard};
343 1231
344 $state{connect_guard} = AnyEvent::Socket::tcp_connect $rhost, $rport, sub { 1232 # try to use an existing keepalive connection, but only if we, ourselves, plan
345 $state{fh} = shift 1233 # on a keepalive request (in theory, this should be a separate config option).
346 or return $cb->(undef, { Status => 599, Reason => "$!", URL => $url }); 1234 if ($persistent && $KA_CACHE{$ka_key}) {
347 pop; # free memory, save a tree 1235 $was_persistent = 1;
348 1236
349 return unless delete $state{connect_guard}; 1237 $state{handle} = ka_fetch $ka_key;
1238# $state{handle}->destroyed
1239# and die "AnyEvent::HTTP: unexpectedly got a destructed handle (1), please report.";#d#
1240 $prepare_handle->();
1241# $state{handle}->destroyed
1242# and die "AnyEvent::HTTP: unexpectedly got a destructed handle (2), please report.";#d#
1243 $rpath = $upath;
1244 $handle_actual_request->();
350 1245
351 # get handle
352 $state{handle} = new AnyEvent::Handle
353 fh => $state{fh},
354 timeout => $timeout;
355
356 # limit the number of persistent connections
357 # keepalive not yet supported
358 if ($KA_COUNT{$_[1]} < $MAX_PERSISTENT_PER_HOST) {
359 ++$KA_COUNT{$_[1]};
360 $state{handle}{ka_count_guard} = AnyEvent::Util::guard {
361 --$KA_COUNT{$_[1]}
362 };
363 $hdr{connection} = "keep-alive";
364 } else { 1246 } else {
365 delete $hdr{connection}; 1247 my $tcp_connect = $arg{tcp_connect}
366 } 1248 || do { require AnyEvent::Socket; \&AnyEvent::Socket::tcp_connect };
367 1249
368 # (re-)configure handle 1250 $state{connect_guard} = $tcp_connect->($rhost, $rport, $connect_cb, $arg{on_prepare} || sub { $timeout });
369 $state{handle}->on_error (sub {
370 my $errno = "$!";
371 %state = ();
372 $cb->(undef, { Status => 599, Reason => $errno, URL => $url });
373 });
374 $state{handle}->on_eof (sub {
375 %state = ();
376 $cb->(undef, { Status => 599, Reason => "unexpected end-of-file", URL => $url });
377 });
378
379 $state{handle}->starttls ("connect") if $rscheme eq "https";
380
381 # handle actual, non-tunneled, request
382 my $handle_actual_request = sub {
383 $state{handle}->starttls ("connect") if $uscheme eq "https" && !exists $state{handle}{tls};
384
385 # send request
386 $state{handle}->push_write (
387 "$method $rpath HTTP/1.0\015\012"
388 . (join "", map "\u$_: $hdr{$_}\015\012", keys %hdr)
389 . "\015\012"
390 . (delete $arg{body})
391 );
392
393 %hdr = (); # reduce memory usage, save a kitten
394
395 # status line
396 $state{handle}->push_read (line => $qr_nl, sub {
397 $_[1] =~ /^HTTP\/([0-9\.]+) \s+ ([0-9]{3}) (?: \s+ ([^\015\012]*) )?/ix
398 or return (%state = (), $cb->(undef, { Status => 599, Reason => "invalid server response ($_[1])", URL => $url }));
399
400 my %hdr = ( # response headers
401 HTTPVersion => ",$1",
402 Status => ",$2",
403 Reason => ",$3",
404 URL => ",$url"
405 );
406
407 # headers, could be optimized a bit
408 $state{handle}->unshift_read (line => $qr_nlnl, sub {
409 for ("$_[1]\012") {
410 y/\015//d; # weed out any \015, as they show up in the weirdest of places.
411
412 # we support spaces in field names, as lotus domino
413 # creates them (actually spaces around seperators
414 # are strictly allowed in http, they are a security issue).
415 $hdr{lc $1} .= ",$2"
416 while /\G
417 ([^:\000-\037]+):
418 [\011\040]*
419 ((?: [^\012]+ | \012[\011\040] )*)
420 \012
421 /gxc;
422
423 /\G$/
424 or return (%state = (), $cb->(undef, { Status => 599, Reason => "garbled response headers", URL => $url }));
425 }
426
427 substr $_, 0, 1, ""
428 for values %hdr;
429
430 my $finish = sub {
431 $state{handle}->destroy;
432 %state = ();
433
434 # set-cookie processing
435 if ($arg{cookie_jar}) {
436 for ($hdr{"set-cookie"}) {
437 # parse NAME=VALUE
438 my @kv;
439
440 while (/\G\s* ([^=;,[:space:]]+) \s*=\s* (?: "((?:[^\\"]+|\\.)*)" | ([^=;,[:space:]]*) )/gcxs) {
441 my $name = $1;
442 my $value = $3;
443
444 unless ($value) {
445 $value = $2;
446 $value =~ s/\\(.)/$1/gs;
447 }
448
449 push @kv, $name => $value;
450
451 last unless /\G\s*;/gc;
452 }
453
454 last unless @kv;
455
456 my $name = shift @kv;
457 my %kv = (value => shift @kv, @kv);
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 $arg{cookie_jar}{version} = 1;
478 $arg{cookie_jar}{$cdom}{$cpath}{$name} = \%kv;
479
480 redo if /\G\s*,/gc;
481 }
482 }
483
484 # microsoft and other shitheads don't give a shit for following standards,
485 # try to support some common forms of broken Location headers.
486 if ($_[1]{location} !~ /^(?: $ | [^:\/?\#]+ : )/x) {
487 $_[1]{location} =~ s/^\.\/+//;
488
489 my $url = "$rscheme://$uhost:$uport";
490
491 unless ($_[1]{location} =~ s/^\///) {
492 $url .= $upath;
493 $url =~ s/\/[^\/]*$//;
494 }
495
496 $_[1]{location} = "$url/$_[1]{location}";
497 }
498
499 if ($_[1]{Status} =~ /^30[12]$/ && $recurse && $method ne "POST") {
500 # apparently, mozilla et al. just change POST to GET here
501 # more research is needed before we do the same
502 http_request ($method, $_[1]{location}, %arg, recurse => $recurse - 1, $cb);
503 } elsif ($_[1]{Status} == 303 && $recurse) {
504 # even http/1.1 is unclear on how to mutate the method
505 $method = "GET" unless $method eq "HEAD";
506 http_request ($method => $_[1]{location}, %arg, recurse => $recurse - 1, $cb);
507 } elsif ($_[1]{Status} == 307 && $recurse && $method =~ /^(?:GET|HEAD)$/) {
508 http_request ($method => $_[1]{location}, %arg, recurse => $recurse - 1, $cb);
509 } else {
510 $cb->($_[0], $_[1]);
511 }
512 };
513
514 if ($hdr{Status} =~ /^(?:1..|204|304)$/ or $method eq "HEAD") {
515 $finish->(undef, \%hdr);
516 } else {
517 if (exists $hdr{"content-length"}) {
518 $_[0]->unshift_read (chunk => $hdr{"content-length"}, sub {
519 # could cache persistent connection now
520 if ($hdr{connection} =~ /\bkeep-alive\b/i) {
521 # but we don't, due to misdesigns, this is annoyingly complex
522 };
523
524 $finish->($_[1], \%hdr);
525 });
526 } else {
527 # too bad, need to read until we get an error or EOF,
528 # no way to detect winged data.
529 $_[0]->on_error (sub {
530 $finish->($_[0]{rbuf}, \%hdr);
531 });
532 $_[0]->on_eof (undef);
533 $_[0]->on_read (sub { });
534 }
535 }
536 });
537 });
538 };
539
540 # now handle proxy-CONNECT method
541 if ($proxy && $uscheme eq "https") {
542 # oh dear, we have to wrap it into a connect request
543
544 # maybe re-use $uauthority with patched port?
545 $state{handle}->push_write ("CONNECT $uhost:$uport HTTP/1.0\015\012Host: $uhost\015\012\015\012");
546 $state{handle}->push_read (line => $qr_nlnl, sub {
547 $_[1] =~ /^HTTP\/([0-9\.]+) \s+ ([0-9]{3}) (?: \s+ ([^\015\012]*) )?/ix
548 or return (%state = (), $cb->(undef, { Status => 599, Reason => "invalid proxy connect response ($_[1])", URL => $url }));
549
550 if ($2 == 200) {
551 $rpath = $upath;
552 &$handle_actual_request;
553 } else {
554 %state = ();
555 $cb->(undef, { Status => $2, Reason => $3, URL => $url });
556 }
557 });
558 } else {
559 &$handle_actual_request;
560 }
561
562 }, sub {
563 $timeout
564 }; 1251 }
565 }; 1252 };
566 1253
567 defined wantarray && AnyEvent::Util::guard { %state = () } 1254 defined wantarray && AnyEvent::Util::guard { _destroy_state %state }
568} 1255}
569 1256
570sub http_get($@) { 1257sub http_get($@) {
571 unshift @_, "GET"; 1258 unshift @_, "GET";
572 &http_request 1259 &http_request
583 &http_request 1270 &http_request
584} 1271}
585 1272
586=back 1273=back
587 1274
1275=head2 DNS CACHING
1276
1277AnyEvent::HTTP uses the AnyEvent::Socket::tcp_connect function for
1278the actual connection, which in turn uses AnyEvent::DNS to resolve
1279hostnames. The latter is a simple stub resolver and does no caching
1280on its own. If you want DNS caching, you currently have to provide
1281your own default resolver (by storing a suitable resolver object in
1282C<$AnyEvent::DNS::RESOLVER>) or your own C<tcp_connect> callback.
1283
588=head2 GLOBAL FUNCTIONS AND VARIABLES 1284=head2 GLOBAL FUNCTIONS AND VARIABLES
589 1285
590=over 4 1286=over 4
591 1287
592=item AnyEvent::HTTP::set_proxy "proxy-url" 1288=item AnyEvent::HTTP::set_proxy "proxy-url"
593 1289
594Sets the default proxy server to use. The proxy-url must begin with a 1290Sets the default proxy server to use. The proxy-url must begin with a
595string of the form C<http://host:port> (optionally C<https:...>). 1291string of the form C<http://host:port>, croaks otherwise.
1292
1293To clear an already-set proxy, use C<undef>.
1294
1295When AnyEvent::HTTP is loaded for the first time it will query the
1296default proxy from the operating system, currently by looking at
1297C<$ENV{http_proxy>}.
1298
1299=item AnyEvent::HTTP::cookie_jar_expire $jar[, $session_end]
1300
1301Remove all cookies from the cookie jar that have been expired. If
1302C<$session_end> is given and true, then additionally remove all session
1303cookies.
1304
1305You should call this function (with a true C<$session_end>) before you
1306save cookies to disk, and you should call this function after loading them
1307again. If you have a long-running program you can additionally call this
1308function from time to time.
1309
1310A cookie jar is initially an empty hash-reference that is managed by this
1311module. Its format is subject to change, but currently it is as follows:
1312
1313The key C<version> has to contain C<2>, otherwise the hash gets
1314cleared. All other keys are hostnames or IP addresses pointing to
1315hash-references. The key for these inner hash references is the
1316server path for which this cookie is meant, and the values are again
1317hash-references. Each key of those hash-references is a cookie name, and
1318the value, you guessed it, is another hash-reference, this time with the
1319key-value pairs from the cookie, except for C<expires> and C<max-age>,
1320which have been replaced by a C<_expires> key that contains the cookie
1321expiry timestamp. Session cookies are indicated by not having an
1322C<_expires> key.
1323
1324Here is an example of a cookie jar with a single cookie, so you have a
1325chance of understanding the above paragraph:
1326
1327 {
1328 version => 2,
1329 "10.0.0.1" => {
1330 "/" => {
1331 "mythweb_id" => {
1332 _expires => 1293917923,
1333 value => "ooRung9dThee3ooyXooM1Ohm",
1334 },
1335 },
1336 },
1337 }
1338
1339=item $date = AnyEvent::HTTP::format_date $timestamp
1340
1341Takes a POSIX timestamp (seconds since the epoch) and formats it as a HTTP
1342Date (RFC 2616).
1343
1344=item $timestamp = AnyEvent::HTTP::parse_date $date
1345
1346Takes a HTTP Date (RFC 2616) or a Cookie date (netscape cookie spec) or a
1347bunch of minor variations of those, and returns the corresponding POSIX
1348timestamp, or C<undef> if the date cannot be parsed.
596 1349
597=item $AnyEvent::HTTP::MAX_RECURSE 1350=item $AnyEvent::HTTP::MAX_RECURSE
598 1351
599The default value for the C<recurse> request parameter (default: C<10>). 1352The default value for the C<recurse> request parameter (default: C<10>).
600 1353
1354=item $AnyEvent::HTTP::TIMEOUT
1355
1356The default timeout for connection operations (default: C<300>).
1357
601=item $AnyEvent::HTTP::USERAGENT 1358=item $AnyEvent::HTTP::USERAGENT
602 1359
603The default value for the C<User-Agent> header (the default is 1360The default value for the C<User-Agent> header (the default is
604C<Mozilla/5.0 (compatible; AnyEvent::HTTP/$VERSION; +http://software.schmorp.de/pkg/AnyEvent)>). 1361C<Mozilla/5.0 (compatible; U; AnyEvent-HTTP/$VERSION; +http://software.schmorp.de/pkg/AnyEvent)>).
605 1362
606=item $AnyEvent::HTTP::MAX_PERSISTENT 1363=item $AnyEvent::HTTP::MAX_PER_HOST
607 1364
608The maximum number of persistent connections to keep open (default: 8). 1365The maximum number of concurrent connections to the same host (identified
1366by the hostname). If the limit is exceeded, then additional requests
1367are queued until previous connections are closed. Both persistent and
1368non-persistent connections are counted in this limit.
609 1369
610Not implemented currently. 1370The default value for this is C<4>, and it is highly advisable to not
1371increase it much.
1372
1373For comparison: the RFC's recommend 4 non-persistent or 2 persistent
1374connections, older browsers used 2, newer ones (such as firefox 3)
1375typically use 6, and Opera uses 8 because like, they have the fastest
1376browser and give a shit for everybody else on the planet.
611 1377
612=item $AnyEvent::HTTP::PERSISTENT_TIMEOUT 1378=item $AnyEvent::HTTP::PERSISTENT_TIMEOUT
613 1379
614The maximum time to cache a persistent connection, in seconds (default: 2). 1380The time after which idle persistent connections get closed by
615 1381AnyEvent::HTTP (default: C<3>).
616Not implemented currently.
617 1382
618=item $AnyEvent::HTTP::ACTIVE 1383=item $AnyEvent::HTTP::ACTIVE
619 1384
620The number of active connections. This is not the number of currently 1385The number of active connections. This is not the number of currently
621running requests, but the number of currently open and non-idle TCP 1386running requests, but the number of currently open and non-idle TCP
622connections. This number of can be useful for load-leveling. 1387connections. This number can be useful for load-leveling.
623 1388
624=back 1389=back
625 1390
626=cut 1391=cut
627 1392
1393our @month = qw(Jan Feb Mar Apr May Jun Jul Aug Sep Oct Nov Dec);
1394our @weekday = qw(Sun Mon Tue Wed Thu Fri Sat);
1395
1396sub format_date($) {
1397 my ($time) = @_;
1398
1399 # RFC 822/1123 format
1400 my ($S, $M, $H, $mday, $mon, $year, $wday, $yday, undef) = gmtime $time;
1401
1402 sprintf "%s, %02d %s %04d %02d:%02d:%02d GMT",
1403 $weekday[$wday], $mday, $month[$mon], $year + 1900,
1404 $H, $M, $S;
1405}
1406
1407sub parse_date($) {
1408 my ($date) = @_;
1409
1410 my ($d, $m, $y, $H, $M, $S);
1411
1412 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$/) {
1413 # RFC 822/1123, required by RFC 2616 (with " ")
1414 # cookie dates (with "-")
1415
1416 ($d, $m, $y, $H, $M, $S) = ($1, $2, $3, $4, $5, $6);
1417
1418 } 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$/) {
1419 # RFC 850
1420 ($d, $m, $y, $H, $M, $S) = ($1, $2, $3 < 69 ? $3 + 2000 : $3 + 1900, $4, $5, $6);
1421
1422 } 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])$/) {
1423 # ISO C's asctime
1424 ($d, $m, $y, $H, $M, $S) = ($2, $1, $6, $3, $4, $5);
1425 }
1426 # other formats fail in the loop below
1427
1428 for (0..11) {
1429 if ($m eq $month[$_]) {
1430 require Time::Local;
1431 return eval { Time::Local::timegm ($S, $M, $H, $d, $_, $y) };
1432 }
1433 }
1434
1435 undef
1436}
1437
628sub set_proxy($) { 1438sub set_proxy($) {
629 $PROXY = [$2, $3 || 3128, $1] if $_[0] =~ m%^(https?):// ([^:/]+) (?: : (\d*) )?%ix; 1439 if (length $_[0]) {
1440 $_[0] =~ m%^(http):// ([^:/]+) (?: : (\d*) )?%ix
1441 or Carp::croak "$_[0]: invalid proxy URL";
1442 $PROXY = [$2, $3 || 3128, $1]
1443 } else {
1444 undef $PROXY;
1445 }
630} 1446}
631 1447
632# initialise proxy from environment 1448# initialise proxy from environment
1449eval {
633set_proxy $ENV{http_proxy}; 1450 set_proxy $ENV{http_proxy};
1451};
1452
1453=head2 SHOWCASE
1454
1455This section contains some more elaborate "real-world" examples or code
1456snippets.
1457
1458=head2 HTTP/1.1 FILE DOWNLOAD
1459
1460Downloading files with HTTP can be quite tricky, especially when something
1461goes wrong and you want to resume.
1462
1463Here is a function that initiates and resumes a download. It uses the
1464last modified time to check for file content changes, and works with many
1465HTTP/1.0 servers as well, and usually falls back to a complete re-download
1466on older servers.
1467
1468It calls the completion callback with either C<undef>, which means a
1469nonretryable error occurred, C<0> when the download was partial and should
1470be retried, and C<1> if it was successful.
1471
1472 use AnyEvent::HTTP;
1473
1474 sub download($$$) {
1475 my ($url, $file, $cb) = @_;
1476
1477 open my $fh, "+<", $file
1478 or die "$file: $!";
1479
1480 my %hdr;
1481 my $ofs = 0;
1482
1483 if (stat $fh and -s _) {
1484 $ofs = -s _;
1485 warn "-s is ", $ofs;
1486 $hdr{"if-unmodified-since"} = AnyEvent::HTTP::format_date +(stat _)[9];
1487 $hdr{"range"} = "bytes=$ofs-";
1488 }
1489
1490 http_get $url,
1491 headers => \%hdr,
1492 on_header => sub {
1493 my ($hdr) = @_;
1494
1495 if ($hdr->{Status} == 200 && $ofs) {
1496 # resume failed
1497 truncate $fh, $ofs = 0;
1498 }
1499
1500 sysseek $fh, $ofs, 0;
1501
1502 1
1503 },
1504 on_body => sub {
1505 my ($data, $hdr) = @_;
1506
1507 if ($hdr->{Status} =~ /^2/) {
1508 length $data == syswrite $fh, $data
1509 or return; # abort on write errors
1510 }
1511
1512 1
1513 },
1514 sub {
1515 my (undef, $hdr) = @_;
1516
1517 my $status = $hdr->{Status};
1518
1519 if (my $time = AnyEvent::HTTP::parse_date $hdr->{"last-modified"}) {
1520 utime $time, $time, $fh;
1521 }
1522
1523 if ($status == 200 || $status == 206 || $status == 416) {
1524 # download ok || resume ok || file already fully downloaded
1525 $cb->(1, $hdr);
1526
1527 } elsif ($status == 412) {
1528 # file has changed while resuming, delete and retry
1529 unlink $file;
1530 $cb->(0, $hdr);
1531
1532 } elsif ($status == 500 or $status == 503 or $status =~ /^59/) {
1533 # retry later
1534 $cb->(0, $hdr);
1535
1536 } else {
1537 $cb->(undef, $hdr);
1538 }
1539 }
1540 ;
1541 }
1542
1543 download "http://server/somelargefile", "/tmp/somelargefile", sub {
1544 if ($_[0]) {
1545 print "OK!\n";
1546 } elsif (defined $_[0]) {
1547 print "please retry later\n";
1548 } else {
1549 print "ERROR\n";
1550 }
1551 };
1552
1553=head3 SOCKS PROXIES
1554
1555Socks proxies are not directly supported by AnyEvent::HTTP. You can
1556compile your perl to support socks, or use an external program such as
1557F<socksify> (dante) or F<tsocks> to make your program use a socks proxy
1558transparently.
1559
1560Alternatively, for AnyEvent::HTTP only, you can use your own
1561C<tcp_connect> function that does the proxy handshake - here is an example
1562that works with socks4a proxies:
1563
1564 use Errno;
1565 use AnyEvent::Util;
1566 use AnyEvent::Socket;
1567 use AnyEvent::Handle;
1568
1569 # host, port and username of/for your socks4a proxy
1570 my $socks_host = "10.0.0.23";
1571 my $socks_port = 9050;
1572 my $socks_user = "";
1573
1574 sub socks4a_connect {
1575 my ($host, $port, $connect_cb, $prepare_cb) = @_;
1576
1577 my $hdl = new AnyEvent::Handle
1578 connect => [$socks_host, $socks_port],
1579 on_prepare => sub { $prepare_cb->($_[0]{fh}) },
1580 on_error => sub { $connect_cb->() },
1581 ;
1582
1583 $hdl->push_write (pack "CCnNZ*Z*", 4, 1, $port, 1, $socks_user, $host);
1584
1585 $hdl->push_read (chunk => 8, sub {
1586 my ($hdl, $chunk) = @_;
1587 my ($status, $port, $ipn) = unpack "xCna4", $chunk;
1588
1589 if ($status == 0x5a) {
1590 $connect_cb->($hdl->{fh}, (format_address $ipn) . ":$port");
1591 } else {
1592 $! = Errno::ENXIO; $connect_cb->();
1593 }
1594 });
1595
1596 $hdl
1597 }
1598
1599Use C<socks4a_connect> instead of C<tcp_connect> when doing C<http_request>s,
1600possibly after switching off other proxy types:
1601
1602 AnyEvent::HTTP::set_proxy undef; # usually you do not want other proxies
1603
1604 http_get 'http://www.google.com', tcp_connect => \&socks4a_connect, sub {
1605 my ($data, $headers) = @_;
1606 ...
1607 };
634 1608
635=head1 SEE ALSO 1609=head1 SEE ALSO
636 1610
637L<AnyEvent>. 1611L<AnyEvent>.
638 1612
639=head1 AUTHOR 1613=head1 AUTHOR
640 1614
641 Marc Lehmann <schmorp@schmorp.de> 1615 Marc Lehmann <schmorp@schmorp.de>
642 http://home.schmorp.de/ 1616 http://home.schmorp.de/
643 1617
1618With many thanks to Дмитрий Шалашов, who provided countless
1619testcases and bugreports.
1620
644=cut 1621=cut
645 1622
6461 16231
647 1624

Diff Legend

Removed lines
+ Added lines
< Changed lines
> Changed lines