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

Diff Legend

Removed lines
+ Added lines
< Changed lines
> Changed lines