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.21 by root, Thu Jun 12 11:56:09 2008 UTC vs.
Revision 1.138 by root, Fri Aug 5 20:45:09 2022 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.02'; 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
76additional parameters. 70additional parameters and the return value.
77 71
78=item http_head $url, key => value..., $cb->($data, $headers) 72=item http_head $url, key => value..., $cb->($data, $headers)
79 73
80Executes an HTTP-HEAD request. See the http_request function for details on 74Executes an HTTP-HEAD request. See the http_request function for details
81additional parameters. 75on additional parameters and the return value.
82 76
83=item http_post $url, $body, key => value..., $cb->($data, $headers) 77=item http_post $url, $body, key => value..., $cb->($data, $headers)
84 78
85Executes an HTTP-POST request with a request body of C<$bod>. See the 79Executes an HTTP-POST request with a request body of C<$body>. See the
86http_request function for details on additional parameters. 80http_request function for details on additional parameters and the return
81value.
87 82
88=item http_request $method => $url, key => value..., $cb->($data, $headers) 83=item http_request $method => $url, key => value..., $cb->($data, $headers)
89 84
90Executes a HTTP request of type C<$method> (e.g. C<GET>, C<POST>). The URL 85Executes a HTTP request of type C<$method> (e.g. C<GET>, C<POST>). The URL
91must be an absolute http or https URL. 86must be an absolute http or https URL.
92 87
88When called in void context, nothing is returned. In other contexts,
89C<http_request> returns a "cancellation guard" - you have to keep the
90object at least alive until the callback get called. If the object gets
91destroyed before the callback is called, the request will be cancelled.
92
93The callback will be called with the response data as first argument 93The callback will be called with the response body data as first argument
94(or C<undef> if it wasn't available due to errors), and a hash-ref with 94(or C<undef> if an error occurred), and a hash-ref with response headers
95response headers as second argument. 95(and trailers) as second argument.
96 96
97All 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
98headers, 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
99contain 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
100pseudo-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
101requested 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).
102 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.
117
103If the server sends a header multiple lines, then their contents will be 118If the server sends a header multiple times, then their contents will be
104joined together with C<\x00>. 119joined together with a comma (C<,>), as per the HTTP spec.
105 120
106If 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,
107then 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
108and 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
109 139
110A typical callback might look like this: 140A typical callback might look like this:
111 141
112 sub { 142 sub {
113 my ($body, $hdr) = @_; 143 my ($body, $hdr) = @_;
124 154
125=over 4 155=over 4
126 156
127=item recurse => $count (default: $MAX_RECURSE) 157=item recurse => $count (default: $MAX_RECURSE)
128 158
129Whether to recurse requests or not, e.g. on redirects, authentication 159Whether to recurse requests or not, e.g. on redirects, authentication and
130retries 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.
131 166
132=item headers => hashref 167=item headers => hashref
133 168
134The request headers to use. Currently, C<http_request> may provide its 169The request headers to use. Currently, C<http_request> may provide its own
135own C<Host:>, C<Content-Length:>, C<Connection:> and C<Cookie:> headers 170C<Host:>, C<Content-Length:>, C<Connection:> and C<Cookie:> headers and
136and 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.
137 181
138=item timeout => $seconds 182=item timeout => $seconds
139 183
140The 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
141the 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.
142 189
143=item proxy => [$host, $port[, $scheme]] or undef 190=item proxy => [$host, $port[, $scheme]] or undef
144 191
145Use 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
146default proxy (as specified by C<$ENV{http_proxy}>) is used. 193used.
147 194
148C<$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.
149HTTPS. 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>.
150 207
151=item body => $string 208=item body => $string
152 209
153The 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
154this module might offer more options). 211this module might offer more options).
155 212
156=item cookie_jar => $hash_ref 213=item cookie_jar => $hash_ref
157 214
158Passing this parameter enables (simplified) cookie-processing, loosely 215Passing this parameter enables (simplified) cookie-processing, loosely
159based on the original netscape specification. 216based on the original netscape specification.
160 217
161The C<$hash_ref> must be an (initially empty) hash reference which will 218The C<$hash_ref> must be an (initially empty) hash reference which
162get updated automatically. It is possible to save the cookie_jar to 219will get updated automatically. It is possible to save the cookie jar
163persistent storage with something like JSON or Storable, but this is not 220to persistent storage with something like JSON or Storable - see the
164recommended, 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.
165 224
166Note that this cookie implementation is not of very high quality, nor 225Note that this cookie implementation is not meant to be complete. If
167meant to be complete. If you want complete cookie management you have to 226you want complete cookie management you have to do that on your
168do that on your own. C<cookie_jar> is meant as a quick fix to get some 227own. C<cookie_jar> is meant as a quick fix to get most cookie-using sites
169cookie-using sites working. Cookies are a privacy disaster, do not use 228working. Cookies are a privacy disaster, do not use them unless required
170them 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 },
171 395
172=back 396=back
173 397
174Example: 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.
175 400
176 http_request GET => "http://www.nethype.de/", sub { 401 http_request GET => "http://www.nethype.de/", sub {
177 my ($body, $hdr) = @_; 402 my ($body, $hdr) = @_;
178 print "$body\n"; 403 print "$body\n";
179 }; 404 };
180 405
181Example: 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
182timeout of 30 seconds. 407timeout of 30 seconds.
183 408
184 http_request 409 http_request
185 GET => "https://www.google.com", 410 HEAD => "https://www.google.com",
411 headers => { "user-agent" => "MySearchClient 1.0" },
186 timeout => 30, 412 timeout => 30,
187 sub { 413 sub {
188 my ($body, $hdr) = @_; 414 my ($body, $hdr) = @_;
189 use Data::Dumper; 415 use Data::Dumper;
190 print Dumper $hdr; 416 print Dumper $hdr;
191 } 417 }
192 ; 418 ;
193 419
420Example: do another simple HTTP GET request, but immediately try to
421cancel it.
422
423 my $request = http_request GET => "http://www.nethype.de/", sub {
424 my ($body, $hdr) = @_;
425 print "$body\n";
426 };
427
428 undef $request;
429
194=cut 430=cut
431
432#############################################################################
433# wait queue/slots
195 434
196sub _slot_schedule; 435sub _slot_schedule;
197sub _slot_schedule($) { 436sub _slot_schedule($) {
198 my $host = shift; 437 my $host = shift;
199 438
221 push @{ $CO_SLOT{$_[0]}[1] }, $_[1]; 460 push @{ $CO_SLOT{$_[0]}[1] }, $_[1];
222 461
223 _slot_schedule $_[0]; 462 _slot_schedule $_[0];
224} 463}
225 464
465#############################################################################
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 QUERY => 1,
722 HEAD => 1,
723 OPTIONS => 1,
724 PUT => 1,
725 TRACE => 1,
726
727 ACL => 1,
728 "BASELINE-CONTROL" => 1,
729 BIND => 1,
730 CHECKIN => 1,
731 CHECKOUT => 1,
732 COPY => 1,
733 LABEL => 1,
734 LINK => 1,
735 MERGE => 1,
736 MKACTIVITY => 1,
737 MKCALENDAR => 1,
738 MKCOL => 1,
739 MKREDIRECTREF => 1,
740 MKWORKSPACE => 1,
741 MOVE => 1,
742 ORDERPATCH => 1,
743 PROPFIND => 1,
744 PROPPATCH => 1,
745 REBIND => 1,
746 REPORT => 1,
747 SEARCH => 1,
748 UNBIND => 1,
749 UNCHECKOUT => 1,
750 UNLINK => 1,
751 UNLOCK => 1,
752 UPDATE => 1,
753 UPDATEREDIRECTREF => 1,
754 "VERSION-CONTROL" => 1,
755);
756
226sub http_request($$@) { 757sub http_request($$@) {
227 my $cb = pop; 758 my $cb = pop;
228 my ($method, $url, %arg) = @_; 759 my ($method, $url, %arg) = @_;
229 760
230 my %hdr; 761 my %hdr;
762
763 $arg{tls_ctx} = $TLS_CTX_LOW if $arg{tls_ctx} eq "low" || !exists $arg{tls_ctx};
764 $arg{tls_ctx} = $TLS_CTX_HIGH if $arg{tls_ctx} eq "high";
231 765
232 $method = uc $method; 766 $method = uc $method;
233 767
234 if (my $hdr = $arg{headers}) { 768 if (my $hdr = $arg{headers}) {
235 while (my ($k, $v) = each %$hdr) { 769 while (my ($k, $v) = each %$hdr) {
236 $hdr{lc $k} = $v; 770 $hdr{lc $k} = $v;
237 } 771 }
238 } 772 }
239 773
774 # pseudo headers for all subsequent responses
775 my @pseudo = (URL => $url);
776 push @pseudo, Redirect => delete $arg{Redirect} if exists $arg{Redirect};
777
240 my $recurse = exists $arg{recurse} ? $arg{recurse} : $MAX_RECURSE; 778 my $recurse = exists $arg{recurse} ? delete $arg{recurse} : $MAX_RECURSE;
241 779
242 return $cb->(undef, { Status => 599, Reason => "recursion limit reached", URL => $url }) 780 return $cb->(undef, { @pseudo, Status => 599, Reason => "Too many redirections" })
243 if $recurse < 0; 781 if $recurse < 0;
244 782
245 my $proxy = $arg{proxy} || $PROXY; 783 my $proxy = exists $arg{proxy} ? $arg{proxy} : $PROXY;
246 my $timeout = $arg{timeout} || $TIMEOUT; 784 my $timeout = $arg{timeout} || $TIMEOUT;
247 785
248 $hdr{"user-agent"} ||= $USERAGENT;
249
250 my ($scheme, $authority, $upath, $query, $fragment) = 786 my ($uscheme, $uauthority, $upath, $query, undef) = # ignore fragment
251 $url =~ m|(?:([^:/?#]+):)?(?://([^/?#]*))?([^?#]*)(?:\?([^#]*))?(?:#(.*))?|; 787 $url =~ m|^([^:]+):(?://([^/?#]*))?([^?#]*)(?:(\?[^#]*))?(?:#(.*))?$|;
252 788
253 $scheme = lc $scheme; 789 $uscheme = lc $uscheme;
254 790
255 my $uport = $scheme eq "http" ? 80 791 my $uport = $uscheme eq "http" ? 80
256 : $scheme eq "https" ? 443 792 : $uscheme eq "https" ? 443
257 : return $cb->(undef, { Status => 599, Reason => "only http and https URL schemes supported", URL => $url }); 793 : return $cb->(undef, { @pseudo, Status => 599, Reason => "Only http and https URL schemes supported" });
258 794
259 $hdr{referer} ||= "$scheme://$authority$upath"; # leave out fragment and query string, just a heuristic
260
261 $authority =~ /^(?: .*\@ )? ([^\@:]+) (?: : (\d+) )?$/x 795 $uauthority =~ /^(?: .*\@ )? ([^\@]+?) (?: : (\d+) )?$/x
262 or return $cb->(undef, { Status => 599, Reason => "unparsable URL", URL => $url }); 796 or return $cb->(undef, { @pseudo, Status => 599, Reason => "Unparsable URL" });
263 797
264 my $uhost = $1; 798 my $uhost = lc $1;
265 $uport = $2 if defined $2; 799 $uport = $2 if defined $2;
266 800
801 $hdr{host} = defined $2 ? "$uhost:$2" : "$uhost"
802 unless exists $hdr{host};
803
267 $uhost =~ s/^\[(.*)\]$/$1/; 804 $uhost =~ s/^\[(.*)\]$/$1/;
268 $upath .= "?$query" if length $query; 805 $upath .= $query if length $query;
269 806
270 $upath =~ s%^/?%/%; 807 $upath =~ s%^/?%/%;
271 808
272 # cookie processing 809 # cookie processing
273 if (my $jar = $arg{cookie_jar}) { 810 if (my $jar = $arg{cookie_jar}) {
274 %$jar = () if $jar->{version} < 1; 811 my $cookies = cookie_jar_extract $jar, $uscheme, $uhost, $upath;
275 812
813 $hdr{cookie} = join "; ", @$cookies
276 my @cookie; 814 if @$cookies;
277 815 }
278 while (my ($chost, $v) = each %$jar) { 816
279 next unless $chost eq substr $uhost, -length $chost; 817 my ($rhost, $rport, $rscheme, $rpath); # request host, port, path
280 next unless $chost =~ /^\./; 818
281 819 if ($proxy) {
282 while (my ($cpath, $v) = each %$v) { 820 ($rpath, $rhost, $rport, $rscheme) = ($url, @$proxy);
283 next unless $cpath eq substr $upath, 0, length $cpath; 821
284 822 $rscheme = "http" unless defined $rscheme;
285 while (my ($k, $v) = each %$v) { 823
286 next if $scheme ne "https" && exists $v->{secure}; 824 # don't support https requests over https-proxy transport,
287 push @cookie, "$k=$v->{value}"; 825 # can't be done with tls as spec'ed, unless you double-encrypt.
826 $rscheme = "http" if $uscheme eq "https" && $rscheme eq "https";
827
828 $rhost = lc $rhost;
829 $rscheme = lc $rscheme;
830 } else {
831 ($rhost, $rport, $rscheme, $rpath) = ($uhost, $uport, $uscheme, $upath);
832 }
833
834 # leave out fragment and query string, just a heuristic
835 $hdr{referer} = "$uscheme://$uauthority$upath" unless exists $hdr{referer};
836 $hdr{"user-agent"} = $USERAGENT unless exists $hdr{"user-agent"};
837
838 $hdr{"content-length"} = length $arg{body}
839 if length $arg{body} || $method ne "GET";
840
841 my $idempotent = $IDEMPOTENT{$method};
842
843 # default value for keepalive is true iff the request is for an idempotent method
844 my $persistent = exists $arg{persistent} ? !!$arg{persistent} : $idempotent;
845 my $keepalive = exists $arg{keepalive} ? !!$arg{keepalive} : !$proxy;
846 my $was_persistent; # true if this is actually a recycled connection
847
848 # the key to use in the keepalive cache
849 my $ka_key = "$uscheme\x00$uhost\x00$uport\x00$arg{sessionid}";
850
851 $hdr{connection} = ($persistent ? $keepalive ? "keep-alive, " : "" : "close, ") . "Te"; #1.1
852 $hdr{te} = "trailers" unless exists $hdr{te}; #1.1
853
854 my %state = (connect_guard => 1);
855
856 my $ae_error = 595; # connecting
857
858 # handle actual, non-tunneled, request
859 my $handle_actual_request = sub {
860 $ae_error = 596; # request phase
861
862 my $hdl = $state{handle};
863
864 $hdl->starttls ("connect") if $uscheme eq "https" && !exists $hdl->{tls};
865
866 # send request
867 $hdl->push_write (
868 "$method $rpath HTTP/1.1\015\012"
869 . (join "", map "\u$_: $hdr{$_}\015\012", grep defined $hdr{$_}, keys %hdr)
870 . "\015\012"
871 . $arg{body}
872 );
873
874 # return if error occurred during push_write()
875 return unless %state;
876
877 # reduce memory usage, save a kitten, also re-use it for the response headers.
878 %hdr = ();
879
880 # status line and headers
881 $state{read_response} = sub {
882 return unless %state;
883
884 for ("$_[1]") {
885 y/\015//d; # weed out any \015, as they show up in the weirdest of places.
886
887 /^HTTP\/0*([0-9\.]+) \s+ ([0-9]{3}) (?: \s+ ([^\012]*) )? \012/gxci
888 or return _error %state, $cb, { @pseudo, Status => 599, Reason => "Invalid server response" };
889
890 # 100 Continue handling
891 # should not happen as we don't send expect: 100-continue,
892 # but we handle it just in case.
893 # since we send the request body regardless, if we get an error
894 # we are out of-sync, which we currently do NOT handle correctly.
895 return $state{handle}->push_read (line => $qr_nlnl, $state{read_response})
896 if $2 eq 100;
897
898 push @pseudo,
899 HTTPVersion => $1,
900 Status => $2,
901 Reason => $3,
902 ;
903
904 my $hdr = _parse_hdr
905 or return _error %state, $cb, { @pseudo, Status => 599, Reason => "Garbled response headers" };
906
907 %hdr = (%$hdr, @pseudo);
908 }
909
910 # redirect handling
911 # relative uri handling forced by microsoft and other shitheads.
912 # we give our best and fall back to URI if available.
913 if (exists $hdr{location}) {
914 my $loc = $hdr{location};
915
916 if ($loc =~ m%^//%) { # //
917 $loc = "$uscheme:$loc";
918
919 } elsif ($loc eq "") {
920 $loc = $url;
921
922 } elsif ($loc !~ /^(?: $ | [^:\/?\#]+ : )/x) { # anything "simple"
923 $loc =~ s/^\.\/+//;
924
925 if ($loc !~ m%^[.?#]%) {
926 my $prefix = "$uscheme://$uauthority";
927
928 unless ($loc =~ s/^\///) {
929 $prefix .= $upath;
930 $prefix =~ s/\/[^\/]*$//;
931 }
932
933 $loc = "$prefix/$loc";
934
935 } elsif (eval { require URI }) { # uri
936 $loc = URI->new_abs ($loc, $url)->as_string;
937
938 } else {
939 return _error %state, $cb, { @pseudo, Status => 599, Reason => "Cannot parse Location (URI module missing)" };
940 #$hdr{Status} = 599;
941 #$hdr{Reason} = "Unparsable Redirect (URI module missing)";
942 #$recurse = 0;
943 }
944 }
945
946 $hdr{location} = $loc;
947 }
948
949 my $redirect;
950
951 if ($recurse) {
952 my $status = $hdr{Status};
953
954 # industry standard is to redirect POST as GET for
955 # 301, 302 and 303, in contrast to HTTP/1.0 and 1.1.
956 # also, the UA should ask the user for 301 and 307 and POST,
957 # industry standard seems to be to simply follow.
958 # we go with the industry standard. 308 is defined
959 # by rfc7538
960 if ($status == 301 or $status == 302 or $status == 303) {
961 $redirect = 1;
962 # HTTP/1.1 is unclear on how to mutate the method
963 unless ($method eq "HEAD") {
964 $method = "GET";
965 delete $arg{body};
966 }
967 } elsif ($status == 307 or $status == 308) {
968 $redirect = 1;
288 } 969 }
289 } 970 }
971
972 my $finish = sub { # ($data, $err_status, $err_reason[, $persistent])
973 if ($state{handle}) {
974 # handle keepalive
975 if (
976 $persistent
977 && $_[3]
978 && ($hdr{HTTPVersion} < 1.1
979 ? $hdr{connection} =~ /\bkeep-?alive\b/i
980 : $hdr{connection} !~ /\bclose\b/i)
981 ) {
982 ka_store $ka_key, delete $state{handle};
983 } else {
984 # no keepalive, destroy the handle
985 $state{handle}->destroy;
986 }
987 }
988
989 %state = ();
990
991 if (defined $_[1]) {
992 $hdr{OrigStatus} = $hdr{Status}; $hdr{Status} = $_[1];
993 $hdr{OrigReason} = $hdr{Reason}; $hdr{Reason} = $_[2];
994 }
995
996 # set-cookie processing
997 if ($arg{cookie_jar}) {
998 cookie_jar_set_cookie $arg{cookie_jar}, $hdr{"set-cookie"}, $uhost, $hdr{date};
999 }
1000
1001 if ($redirect && exists $hdr{location}) {
1002 # we ignore any errors, as it is very common to receive
1003 # Content-Length != 0 but no actual body
1004 # we also access %hdr, as $_[1] might be an erro
1005 $state{recurse} =
1006 http_request (
1007 $method => $hdr{location},
1008 %arg,
1009 recurse => $recurse - 1,
1010 Redirect => [$_[0], \%hdr],
1011 sub {
1012 %state = ();
1013 &$cb
1014 },
1015 );
1016 } else {
1017 $cb->($_[0], \%hdr);
1018 }
1019 };
1020
1021 $ae_error = 597; # body phase
1022
1023 my $chunked = $hdr{"transfer-encoding"} =~ /\bchunked\b/i; # not quite correct...
1024
1025 my $len = $chunked ? undef : $hdr{"content-length"};
1026
1027 # body handling, many different code paths
1028 # - no body expected
1029 # - want_body_handle
1030 # - te chunked
1031 # - 2x length known (with or without on_body)
1032 # - 2x length not known (with or without on_body)
1033 if (!$redirect && $arg{on_header} && !$arg{on_header}(\%hdr)) {
1034 $finish->(undef, 598 => "Request cancelled by on_header");
1035 } elsif (
1036 $hdr{Status} =~ /^(?:1..|204|205|304)$/
1037 or $method eq "HEAD"
1038 or (defined $len && $len == 0) # == 0, not !, because "0 " is true
1039 ) {
1040 # no body
1041 $finish->("", undef, undef, 1);
1042
1043 } elsif (!$redirect && $arg{want_body_handle}) {
1044 $_[0]->on_eof (undef);
1045 $_[0]->on_error (undef);
1046 $_[0]->on_read (undef);
1047
1048 $finish->(delete $state{handle});
1049
1050 } elsif ($chunked) {
1051 my $cl = 0;
1052 my $body = "";
1053 my $on_body = (!$redirect && $arg{on_body}) || sub { $body .= shift; 1 };
1054
1055 $state{read_chunk} = sub {
1056 $_[1] =~ /^([0-9a-fA-F]+)/
1057 or return $finish->(undef, $ae_error => "Garbled chunked transfer encoding");
1058
1059 my $len = hex $1;
1060
1061 if ($len) {
1062 $cl += $len;
1063
1064 $_[0]->push_read (chunk => $len, sub {
1065 $on_body->($_[1], \%hdr)
1066 or return $finish->(undef, 598 => "Request cancelled by on_body");
1067
1068 $_[0]->push_read (line => sub {
1069 length $_[1]
1070 and return $finish->(undef, $ae_error => "Garbled chunked transfer encoding");
1071 $_[0]->push_read (line => $state{read_chunk});
1072 });
1073 });
1074 } else {
1075 $hdr{"content-length"} ||= $cl;
1076
1077 $_[0]->push_read (line => $qr_nlnl, sub {
1078 if (length $_[1]) {
1079 for ("$_[1]") {
1080 y/\015//d; # weed out any \015, as they show up in the weirdest of places.
1081
1082 my $hdr = _parse_hdr
1083 or return $finish->(undef, $ae_error => "Garbled response trailers");
1084
1085 %hdr = (%hdr, %$hdr);
1086 }
1087 }
1088
1089 $finish->($body, undef, undef, 1);
1090 });
1091 }
1092 };
1093
1094 $_[0]->push_read (line => $state{read_chunk});
1095
1096 } elsif (!$redirect && $arg{on_body}) {
1097 if (defined $len) {
1098 $_[0]->on_read (sub {
1099 $len -= length $_[0]{rbuf};
1100
1101 $arg{on_body}(delete $_[0]{rbuf}, \%hdr)
1102 or return $finish->(undef, 598 => "Request cancelled by on_body");
1103
1104 $len > 0
1105 or $finish->("", undef, undef, 1);
1106 });
1107 } else {
1108 $_[0]->on_eof (sub {
1109 $finish->("");
1110 });
1111 $_[0]->on_read (sub {
1112 $arg{on_body}(delete $_[0]{rbuf}, \%hdr)
1113 or $finish->(undef, 598 => "Request cancelled by on_body");
1114 });
1115 }
1116 } else {
1117 $_[0]->on_eof (undef);
1118
1119 if (defined $len) {
1120 $_[0]->on_read (sub {
1121 $finish->((substr delete $_[0]{rbuf}, 0, $len, ""), undef, undef, 1)
1122 if $len <= length $_[0]{rbuf};
1123 });
1124 } else {
1125 $_[0]->on_error (sub {
1126 ($! == Errno::EPIPE || !$!)
1127 ? $finish->(delete $_[0]{rbuf})
1128 : $finish->(undef, $ae_error => $_[2]);
1129 });
1130 $_[0]->on_read (sub { });
1131 }
1132 }
1133 };
1134
1135 # if keepalive is enabled, then the server closing the connection
1136 # before a response can happen legally - we retry on idempotent methods.
1137 if ($was_persistent && $idempotent) {
1138 my $old_eof = $hdl->{on_eof};
1139 $hdl->{on_eof} = sub {
1140 _destroy_state %state;
1141
1142 %state = ();
1143 $state{recurse} =
1144 http_request (
1145 $method => $url,
1146 %arg,
1147 recurse => $recurse - 1,
1148 persistent => 0,
1149 sub {
1150 %state = ();
1151 &$cb
1152 }
1153 );
1154 };
1155 $hdl->on_read (sub {
1156 return unless %state;
1157
1158 # as soon as we receive something, a connection close
1159 # once more becomes a hard error
1160 $hdl->{on_eof} = $old_eof;
1161 $hdl->push_read (line => $qr_nlnl, $state{read_response});
1162 });
1163 } else {
1164 $hdl->push_read (line => $qr_nlnl, $state{read_response});
290 } 1165 }
291
292 $hdr{cookie} = join "; ", @cookie
293 if @cookie;
294 } 1166 };
295 1167
296 my ($rhost, $rport, $rpath); # request host, port, path 1168 my $prepare_handle = sub {
1169 my ($hdl) = $state{handle};
297 1170
298 if ($proxy) { 1171 $hdl->on_error (sub {
299 ($rhost, $rport, $scheme) = @$proxy; 1172 _error %state, $cb, { @pseudo, Status => $ae_error, Reason => $_[2] };
300 $rpath = $url; 1173 });
301 } else { 1174 $hdl->on_eof (sub {
302 ($rhost, $rport, $rpath) = ($uhost, $uport, $upath); 1175 _error %state, $cb, { @pseudo, Status => $ae_error, Reason => "Unexpected end-of-file" };
303 $hdr{host} = $uhost; 1176 });
1177 $hdl->timeout_reset;
1178 $hdl->timeout ($timeout);
304 } 1179 };
305 1180
306 $hdr{"content-length"} = length $arg{body}; 1181 # connected to proxy (or origin server)
1182 my $connect_cb = sub {
1183 my $fh = shift
1184 or return _error %state, $cb, { @pseudo, Status => $ae_error, Reason => "$!" };
307 1185
308 my %state = (connect_guard => 1); 1186 return unless delete $state{connect_guard};
1187
1188 # get handle
1189 $state{handle} = new AnyEvent::Handle
1190 %{ $arg{handle_params} },
1191 fh => $fh,
1192 peername => $uhost,
1193 tls_ctx => $arg{tls_ctx},
1194 ;
1195
1196 $prepare_handle->();
1197
1198 #$state{handle}->starttls ("connect") if $rscheme eq "https";
1199
1200 # now handle proxy-CONNECT method
1201 if ($proxy && $uscheme eq "https") {
1202 # oh dear, we have to wrap it into a connect request
1203
1204 my $auth = exists $hdr{"proxy-authorization"}
1205 ? "proxy-authorization: " . (delete $hdr{"proxy-authorization"}) . "\015\012"
1206 : "";
1207
1208 # maybe re-use $uauthority with patched port?
1209 $state{handle}->push_write ("CONNECT $uhost:$uport HTTP/1.0\015\012$auth\015\012");
1210 $state{handle}->push_read (line => $qr_nlnl, sub {
1211 $_[1] =~ /^HTTP\/([0-9\.]+) \s+ ([0-9]{3}) (?: \s+ ([^\015\012]*) )?/ix
1212 or return _error %state, $cb, { @pseudo, Status => 599, Reason => "Invalid proxy connect response ($_[1])" };
1213
1214 if ($2 == 200) {
1215 $rpath = $upath;
1216 $handle_actual_request->();
1217 } else {
1218 _error %state, $cb, { @pseudo, Status => $2, Reason => $3 };
1219 }
1220 });
1221 } else {
1222 delete $hdr{"proxy-authorization"} unless $proxy;
1223
1224 $handle_actual_request->();
1225 }
1226 };
309 1227
310 _get_slot $uhost, sub { 1228 _get_slot $uhost, sub {
311 $state{slot_guard} = shift; 1229 $state{slot_guard} = shift;
312 1230
313 return unless $state{connect_guard}; 1231 return unless $state{connect_guard};
314 1232
315 $state{connect_guard} = AnyEvent::Socket::tcp_connect $rhost, $rport, sub { 1233 # try to use an existing keepalive connection, but only if we, ourselves, plan
316 $state{fh} = shift 1234 # on a keepalive request (in theory, this should be a separate config option).
317 or return $cb->(undef, { Status => 599, Reason => "$!", URL => $url }); 1235 if ($persistent && $KA_CACHE{$ka_key}) {
1236 $was_persistent = 1;
318 1237
319 delete $state{connect_guard}; # reduce memory usage, save a tree 1238 $state{handle} = ka_fetch $ka_key;
1239# $state{handle}->destroyed
1240# and die "AnyEvent::HTTP: unexpectedly got a destructed handle (1), please report.";#d#
1241 $prepare_handle->();
1242# $state{handle}->destroyed
1243# and die "AnyEvent::HTTP: unexpectedly got a destructed handle (2), please report.";#d#
1244 $rpath = $upath;
1245 $handle_actual_request->();
320 1246
321 # get handle
322 $state{handle} = new AnyEvent::Handle
323 fh => $state{fh},
324 ($scheme eq "https" ? (tls => "connect") : ());
325
326 # limit the number of persistent connections
327 if ($KA_COUNT{$_[1]} < $MAX_PERSISTENT_PER_HOST) {
328 ++$KA_COUNT{$_[1]};
329 $state{handle}{ka_count_guard} = AnyEvent::Util::guard { --$KA_COUNT{$_[1]} };
330 $hdr{connection} = "keep-alive";
331 delete $hdr{connection}; # keep-alive not yet supported
332 } else { 1247 } else {
333 delete $hdr{connection}; 1248 my $tcp_connect = $arg{tcp_connect}
334 } 1249 || do { require AnyEvent::Socket; \&AnyEvent::Socket::tcp_connect };
335 1250
336 # (re-)configure handle 1251 $state{connect_guard} = $tcp_connect->($rhost, $rport, $connect_cb, $arg{on_prepare} || sub { $timeout });
337 $state{handle}->timeout ($timeout);
338 $state{handle}->on_error (sub {
339 my $errno = "$!";
340 %state = ();
341 $cb->(undef, { Status => 599, Reason => $errno, URL => $url });
342 });
343 $state{handle}->on_eof (sub {
344 %state = ();
345 $cb->(undef, { Status => 599, Reason => "unexpected end-of-file", URL => $url });
346 });
347
348 # send request
349 $state{handle}->push_write (
350 "$method $rpath HTTP/1.0\015\012"
351 . (join "", map "$_: $hdr{$_}\015\012", keys %hdr)
352 . "\015\012"
353 . (delete $arg{body})
354 );
355
356 %hdr = (); # reduce memory usage, save a kitten
357
358 # status line
359 $state{handle}->push_read (line => qr/\015?\012/, sub {
360 $_[1] =~ /^HTTP\/([0-9\.]+) \s+ ([0-9]{3}) \s+ ([^\015\012]+)/ix
361 or return (%state = (), $cb->(undef, { Status => 599, Reason => "invalid server response ($_[1])", URL => $url }));
362
363 my %hdr = ( # response headers
364 HTTPVersion => "\x00$1",
365 Status => "\x00$2",
366 Reason => "\x00$3",
367 URL => "\x00$url"
368 );
369
370 # headers, could be optimized a bit
371 $state{handle}->unshift_read (line => qr/\015?\012\015?\012/, sub {
372 for ("$_[1]\012") {
373 # we support spaces in field names, as lotus domino
374 # creates them.
375 $hdr{lc $1} .= "\x00$2"
376 while /\G
377 ([^:\000-\037]+):
378 [\011\040]*
379 ((?: [^\015\012]+ | \015?\012[\011\040] )*)
380 \015?\012
381 /gxc;
382
383 /\G$/
384 or return (%state = (), $cb->(undef, { Status => 599, Reason => "garbled response headers", URL => $url }));
385 }
386
387 substr $_, 0, 1, ""
388 for values %hdr;
389
390 my $finish = sub {
391 %state = ();
392
393 # set-cookie processing
394 if ($arg{cookie_jar} && exists $hdr{"set-cookie"}) {
395 for (split /\x00/, $hdr{"set-cookie"}) {
396 my ($cookie, @arg) = split /;\s*/;
397 my ($name, $value) = split /=/, $cookie, 2;
398 my %kv = (value => $value, map { split /=/, $_, 2 } @arg);
399
400 my $cdom = (delete $kv{domain}) || $uhost;
401 my $cpath = (delete $kv{path}) || "/";
402
403 $cdom =~ s/^.?/./; # make sure it starts with a "."
404
405 next if $cdom =~ /\.$/;
406
407 # this is not rfc-like and not netscape-like. go figure.
408 my $ndots = $cdom =~ y/.//;
409 next if $ndots < ($cdom =~ /\.[^.][^.]\.[^.][^.]$/ ? 3 : 2);
410
411 # store it
412 $arg{cookie_jar}{version} = 1;
413 $arg{cookie_jar}{$cdom}{$cpath}{$name} = \%kv;
414 }
415 }
416
417 if ($_[1]{Status} =~ /^30[12]$/ && $recurse) {
418 # microsoft and other assholes don't give a shit for following standards,
419 # try to support a common form of broken Location header.
420 $_[1]{location} =~ s%^/%$scheme://$uhost:$uport/%;
421
422 http_request ($method, $_[1]{location}, %arg, recurse => $recurse - 1, $cb);
423 } else {
424 $cb->($_[0], $_[1]);
425 }
426 };
427
428 if ($hdr{Status} =~ /^(?:1..|204|304)$/ or $method eq "HEAD") {
429 $finish->(undef, \%hdr);
430 } else {
431 if (exists $hdr{"content-length"}) {
432 $_[0]->unshift_read (chunk => $hdr{"content-length"}, sub {
433 # could cache persistent connection now
434 if ($hdr{connection} =~ /\bkeep-alive\b/i) {
435 # but we don't, due to misdesigns, this is annoyingly complex
436 };
437
438 $finish->($_[1], \%hdr);
439 });
440 } else {
441 # too bad, need to read until we get an error or EOF,
442 # no way to detect winged data.
443 $_[0]->on_error (sub {
444 $finish->($_[0]{rbuf}, \%hdr);
445 });
446 $_[0]->on_eof (undef);
447 $_[0]->on_read (sub { });
448 }
449 }
450 });
451 });
452 }, sub {
453 $timeout
454 }; 1252 }
455 }; 1253 };
456 1254
457 defined wantarray && AnyEvent::Util::guard { %state = () } 1255 defined wantarray && AnyEvent::Util::guard { _destroy_state %state }
458} 1256}
459 1257
460sub http_get($@) { 1258sub http_get($@) {
461 unshift @_, "GET"; 1259 unshift @_, "GET";
462 &http_request 1260 &http_request
466 unshift @_, "HEAD"; 1264 unshift @_, "HEAD";
467 &http_request 1265 &http_request
468} 1266}
469 1267
470sub http_post($$@) { 1268sub http_post($$@) {
1269 my $url = shift;
471 unshift @_, "POST", "body"; 1270 unshift @_, "POST", $url, "body";
472 &http_request 1271 &http_request
473} 1272}
474 1273
475=back 1274=back
476 1275
1276=head2 DNS CACHING
1277
1278AnyEvent::HTTP uses the AnyEvent::Socket::tcp_connect function for
1279the actual connection, which in turn uses AnyEvent::DNS to resolve
1280hostnames. The latter is a simple stub resolver and does no caching
1281on its own. If you want DNS caching, you currently have to provide
1282your own default resolver (by storing a suitable resolver object in
1283C<$AnyEvent::DNS::RESOLVER>) or your own C<tcp_connect> callback.
1284
477=head2 GLOBAL FUNCTIONS AND VARIABLES 1285=head2 GLOBAL FUNCTIONS AND VARIABLES
478 1286
479=over 4 1287=over 4
480 1288
481=item AnyEvent::HTTP::set_proxy "proxy-url" 1289=item AnyEvent::HTTP::set_proxy "proxy-url"
482 1290
483Sets the default proxy server to use. The proxy-url must begin with a 1291Sets the default proxy server to use. The proxy-url must begin with a
484string of the form C<http://host:port> (optionally C<https:...>). 1292string of the form C<http://host:port>, croaks otherwise.
1293
1294To clear an already-set proxy, use C<undef>.
1295
1296When AnyEvent::HTTP is loaded for the first time it will query the
1297default proxy from the operating system, currently by looking at
1298C<$ENV{http_proxy>}.
1299
1300=item AnyEvent::HTTP::cookie_jar_expire $jar[, $session_end]
1301
1302Remove all cookies from the cookie jar that have been expired. If
1303C<$session_end> is given and true, then additionally remove all session
1304cookies.
1305
1306You should call this function (with a true C<$session_end>) before you
1307save cookies to disk, and you should call this function after loading them
1308again. If you have a long-running program you can additionally call this
1309function from time to time.
1310
1311A cookie jar is initially an empty hash-reference that is managed by this
1312module. Its format is subject to change, but currently it is as follows:
1313
1314The key C<version> has to contain C<2>, otherwise the hash gets
1315cleared. All other keys are hostnames or IP addresses pointing to
1316hash-references. The key for these inner hash references is the
1317server path for which this cookie is meant, and the values are again
1318hash-references. Each key of those hash-references is a cookie name, and
1319the value, you guessed it, is another hash-reference, this time with the
1320key-value pairs from the cookie, except for C<expires> and C<max-age>,
1321which have been replaced by a C<_expires> key that contains the cookie
1322expiry timestamp. Session cookies are indicated by not having an
1323C<_expires> key.
1324
1325Here is an example of a cookie jar with a single cookie, so you have a
1326chance of understanding the above paragraph:
1327
1328 {
1329 version => 2,
1330 "10.0.0.1" => {
1331 "/" => {
1332 "mythweb_id" => {
1333 _expires => 1293917923,
1334 value => "ooRung9dThee3ooyXooM1Ohm",
1335 },
1336 },
1337 },
1338 }
1339
1340=item $date = AnyEvent::HTTP::format_date $timestamp
1341
1342Takes a POSIX timestamp (seconds since the epoch) and formats it as a HTTP
1343Date (RFC 2616).
1344
1345=item $timestamp = AnyEvent::HTTP::parse_date $date
1346
1347Takes a HTTP Date (RFC 2616) or a Cookie date (netscape cookie spec) or a
1348bunch of minor variations of those, and returns the corresponding POSIX
1349timestamp, or C<undef> if the date cannot be parsed.
485 1350
486=item $AnyEvent::HTTP::MAX_RECURSE 1351=item $AnyEvent::HTTP::MAX_RECURSE
487 1352
488The default value for the C<recurse> request parameter (default: C<10>). 1353The default value for the C<recurse> request parameter (default: C<10>).
489 1354
1355=item $AnyEvent::HTTP::TIMEOUT
1356
1357The default timeout for connection operations (default: C<300>).
1358
490=item $AnyEvent::HTTP::USERAGENT 1359=item $AnyEvent::HTTP::USERAGENT
491 1360
492The default value for the C<User-Agent> header (the default is 1361The default value for the C<User-Agent> header (the default is
493C<Mozilla/5.0 (compatible; AnyEvent::HTTP/$VERSION; +http://software.schmorp.de/pkg/AnyEvent)>). 1362C<Mozilla/5.0 (compatible; U; AnyEvent-HTTP/$VERSION; +http://software.schmorp.de/pkg/AnyEvent)>).
494 1363
495=item $AnyEvent::HTTP::MAX_PERSISTENT 1364=item $AnyEvent::HTTP::MAX_PER_HOST
496 1365
497The maximum number of persistent connections to keep open (default: 8). 1366The maximum number of concurrent connections to the same host (identified
1367by the hostname). If the limit is exceeded, then additional requests
1368are queued until previous connections are closed. Both persistent and
1369non-persistent connections are counted in this limit.
498 1370
499Not implemented currently. 1371The default value for this is C<4>, and it is highly advisable to not
1372increase it much.
1373
1374For comparison: the RFC's recommend 4 non-persistent or 2 persistent
1375connections, older browsers used 2, newer ones (such as firefox 3)
1376typically use 6, and Opera uses 8 because like, they have the fastest
1377browser and give a shit for everybody else on the planet.
500 1378
501=item $AnyEvent::HTTP::PERSISTENT_TIMEOUT 1379=item $AnyEvent::HTTP::PERSISTENT_TIMEOUT
502 1380
503The maximum time to cache a persistent connection, in seconds (default: 2). 1381The time after which idle persistent connections get closed by
504 1382AnyEvent::HTTP (default: C<3>).
505Not implemented currently.
506 1383
507=item $AnyEvent::HTTP::ACTIVE 1384=item $AnyEvent::HTTP::ACTIVE
508 1385
509The number of active connections. This is not the number of currently 1386The number of active connections. This is not the number of currently
510running requests, but the number of currently open and non-idle TCP 1387running requests, but the number of currently open and non-idle TCP
511connections. This number of can be useful for load-leveling. 1388connections. This number can be useful for load-leveling.
512 1389
513=back 1390=back
514 1391
515=cut 1392=cut
516 1393
1394our @month = qw(Jan Feb Mar Apr May Jun Jul Aug Sep Oct Nov Dec);
1395our @weekday = qw(Sun Mon Tue Wed Thu Fri Sat);
1396
1397sub format_date($) {
1398 my ($time) = @_;
1399
1400 # RFC 822/1123 format
1401 my ($S, $M, $H, $mday, $mon, $year, $wday, $yday, undef) = gmtime $time;
1402
1403 sprintf "%s, %02d %s %04d %02d:%02d:%02d GMT",
1404 $weekday[$wday], $mday, $month[$mon], $year + 1900,
1405 $H, $M, $S;
1406}
1407
1408sub parse_date($) {
1409 my ($date) = @_;
1410
1411 my ($d, $m, $y, $H, $M, $S);
1412
1413 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$/) {
1414 # RFC 822/1123, required by RFC 2616 (with " ")
1415 # cookie dates (with "-")
1416
1417 ($d, $m, $y, $H, $M, $S) = ($1, $2, $3, $4, $5, $6);
1418
1419 } 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$/) {
1420 # RFC 850
1421 ($d, $m, $y, $H, $M, $S) = ($1, $2, $3 < 69 ? $3 + 2000 : $3 + 1900, $4, $5, $6);
1422
1423 } 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])$/) {
1424 # ISO C's asctime
1425 ($d, $m, $y, $H, $M, $S) = ($2, $1, $6, $3, $4, $5);
1426 }
1427 # other formats fail in the loop below
1428
1429 for (0..11) {
1430 if ($m eq $month[$_]) {
1431 require Time::Local;
1432 return eval { Time::Local::timegm ($S, $M, $H, $d, $_, $y) };
1433 }
1434 }
1435
1436 undef
1437}
1438
517sub set_proxy($) { 1439sub set_proxy($) {
518 $PROXY = [$2, $3 || 3128, $1] if $_[0] =~ m%^(https?):// ([^:/]+) (?: : (\d*) )?%ix; 1440 if (length $_[0]) {
1441 $_[0] =~ m%^(http):// ([^:/]+) (?: : (\d*) )?%ix
1442 or Carp::croak "$_[0]: invalid proxy URL";
1443 $PROXY = [$2, $3 || 3128, $1]
1444 } else {
1445 undef $PROXY;
1446 }
519} 1447}
520 1448
521# initialise proxy from environment 1449# initialise proxy from environment
1450eval {
522set_proxy $ENV{http_proxy}; 1451 set_proxy $ENV{http_proxy};
1452};
1453
1454=head2 SHOWCASE
1455
1456This section contains some more elaborate "real-world" examples or code
1457snippets.
1458
1459=head2 HTTP/1.1 FILE DOWNLOAD
1460
1461Downloading files with HTTP can be quite tricky, especially when something
1462goes wrong and you want to resume.
1463
1464Here is a function that initiates and resumes a download. It uses the
1465last modified time to check for file content changes, and works with many
1466HTTP/1.0 servers as well, and usually falls back to a complete re-download
1467on older servers.
1468
1469It calls the completion callback with either C<undef>, which means a
1470nonretryable error occurred, C<0> when the download was partial and should
1471be retried, and C<1> if it was successful.
1472
1473 use AnyEvent::HTTP;
1474
1475 sub download($$$) {
1476 my ($url, $file, $cb) = @_;
1477
1478 open my $fh, "+<", $file
1479 or die "$file: $!";
1480
1481 my %hdr;
1482 my $ofs = 0;
1483
1484 if (stat $fh and -s _) {
1485 $ofs = -s _;
1486 warn "-s is ", $ofs;
1487 $hdr{"if-unmodified-since"} = AnyEvent::HTTP::format_date +(stat _)[9];
1488 $hdr{"range"} = "bytes=$ofs-";
1489 }
1490
1491 http_get $url,
1492 headers => \%hdr,
1493 on_header => sub {
1494 my ($hdr) = @_;
1495
1496 if ($hdr->{Status} == 200 && $ofs) {
1497 # resume failed
1498 truncate $fh, $ofs = 0;
1499 }
1500
1501 sysseek $fh, $ofs, 0;
1502
1503 1
1504 },
1505 on_body => sub {
1506 my ($data, $hdr) = @_;
1507
1508 if ($hdr->{Status} =~ /^2/) {
1509 length $data == syswrite $fh, $data
1510 or return; # abort on write errors
1511 }
1512
1513 1
1514 },
1515 sub {
1516 my (undef, $hdr) = @_;
1517
1518 my $status = $hdr->{Status};
1519
1520 if (my $time = AnyEvent::HTTP::parse_date $hdr->{"last-modified"}) {
1521 utime $time, $time, $fh;
1522 }
1523
1524 if ($status == 200 || $status == 206 || $status == 416) {
1525 # download ok || resume ok || file already fully downloaded
1526 $cb->(1, $hdr);
1527
1528 } elsif ($status == 412) {
1529 # file has changed while resuming, delete and retry
1530 unlink $file;
1531 $cb->(0, $hdr);
1532
1533 } elsif ($status == 500 or $status == 503 or $status =~ /^59/) {
1534 # retry later
1535 $cb->(0, $hdr);
1536
1537 } else {
1538 $cb->(undef, $hdr);
1539 }
1540 }
1541 ;
1542 }
1543
1544 download "http://server/somelargefile", "/tmp/somelargefile", sub {
1545 if ($_[0]) {
1546 print "OK!\n";
1547 } elsif (defined $_[0]) {
1548 print "please retry later\n";
1549 } else {
1550 print "ERROR\n";
1551 }
1552 };
1553
1554=head3 SOCKS PROXIES
1555
1556Socks proxies are not directly supported by AnyEvent::HTTP. You can
1557compile your perl to support socks, or use an external program such as
1558F<socksify> (dante) or F<tsocks> to make your program use a socks proxy
1559transparently.
1560
1561Alternatively, for AnyEvent::HTTP only, you can use your own
1562C<tcp_connect> function that does the proxy handshake - here is an example
1563that works with socks4a proxies:
1564
1565 use Errno;
1566 use AnyEvent::Util;
1567 use AnyEvent::Socket;
1568 use AnyEvent::Handle;
1569
1570 # host, port and username of/for your socks4a proxy
1571 my $socks_host = "10.0.0.23";
1572 my $socks_port = 9050;
1573 my $socks_user = "";
1574
1575 sub socks4a_connect {
1576 my ($host, $port, $connect_cb, $prepare_cb) = @_;
1577
1578 my $hdl = new AnyEvent::Handle
1579 connect => [$socks_host, $socks_port],
1580 on_prepare => sub { $prepare_cb->($_[0]{fh}) },
1581 on_error => sub { $connect_cb->() },
1582 ;
1583
1584 $hdl->push_write (pack "CCnNZ*Z*", 4, 1, $port, 1, $socks_user, $host);
1585
1586 $hdl->push_read (chunk => 8, sub {
1587 my ($hdl, $chunk) = @_;
1588 my ($status, $port, $ipn) = unpack "xCna4", $chunk;
1589
1590 if ($status == 0x5a) {
1591 $connect_cb->($hdl->{fh}, (format_address $ipn) . ":$port");
1592 } else {
1593 $! = Errno::ENXIO; $connect_cb->();
1594 }
1595 });
1596
1597 $hdl
1598 }
1599
1600Use C<socks4a_connect> instead of C<tcp_connect> when doing C<http_request>s,
1601possibly after switching off other proxy types:
1602
1603 AnyEvent::HTTP::set_proxy undef; # usually you do not want other proxies
1604
1605 http_get 'http://www.google.com', tcp_connect => \&socks4a_connect, sub {
1606 my ($data, $headers) = @_;
1607 ...
1608 };
523 1609
524=head1 SEE ALSO 1610=head1 SEE ALSO
525 1611
526L<AnyEvent>. 1612L<AnyEvent>.
527 1613
528=head1 AUTHOR 1614=head1 AUTHOR
529 1615
530 Marc Lehmann <schmorp@schmorp.de> 1616 Marc Lehmann <schmorp@schmorp.de>
531 http://home.schmorp.de/ 1617 http://home.schmorp.de/
532 1618
1619With many thanks to Дмитрий Шалашов, who provided countless
1620testcases and bugreports.
1621
533=cut 1622=cut
534 1623
5351 16241
536 1625

Diff Legend

Removed lines
+ Added lines
< Changed lines
> Changed lines