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

Diff Legend

Removed lines
+ Added lines
< Changed lines
> Changed lines