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

Diff Legend

Removed lines
+ Added lines
< Changed lines
> Changed lines