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.56 by root, Mon Sep 6 05:30:54 2010 UTC vs.
Revision 1.105 by root, Tue May 10 12:33:51 2011 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.45'; 51our $VERSION = '2.11';
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" (uppercase to avoid clashing with possible 98headers, the "pseudo-headers" (uppercase to avoid clashing with possible
105response headers) C<HTTPVersion>, C<Status> and C<Reason> contain the 99response headers) C<HTTPVersion>, C<Status> and C<Reason> contain the
106three 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>.
107 104
108The 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
109the requested URL when following redirects - for example, you might get 106the requested URL when following redirects - for example, you might get
110an 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
111valid 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
120 117
121If 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
122joined together with a comma (C<,>), as per the HTTP spec. 119joined together with a comma (C<,>), as per the HTTP spec.
123 120
124If 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,
125then 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
126(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
127message. 124message. Currently the following status codes are used:
125
126=over 4
127
128=item 595 - errors during connection etsbalishment, 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
128 139
129A typical callback might look like this: 140A typical callback might look like this:
130 141
131 sub { 142 sub {
132 my ($body, $hdr) = @_; 143 my ($body, $hdr) = @_;
148Whether to recurse requests or not, e.g. on redirects, authentication 159Whether to recurse requests or not, e.g. on redirects, authentication
149retries and so on, and how often to do so. 160retries and so on, and how often to do so.
150 161
151=item headers => hashref 162=item headers => hashref
152 163
153The request headers to use. Currently, C<http_request> may provide its 164The request headers to use. Currently, C<http_request> may provide its own
154own C<Host:>, C<Content-Length:>, C<Connection:> and C<Cookie:> headers 165C<Host:>, C<Content-Length:>, C<Connection:> and C<Cookie:> headers and
155and 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:>
156suppressed 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
157sent 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.
158 176
159=item timeout => $seconds 177=item timeout => $seconds
160 178
161The 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
162the 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
164 182
165Default timeout is 5 minutes. 183Default timeout is 5 minutes.
166 184
167=item proxy => [$host, $port[, $scheme]] or undef 185=item proxy => [$host, $port[, $scheme]] or undef
168 186
169Use 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
170default proxy (as specified by C<$ENV{http_proxy}>) is used. 188used.
171 189
172C<$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.
173HTTPS. 191
192If not specified, then the default proxy is used (see
193C<AnyEvent::HTTP::set_proxy>).
174 194
175=item body => $string 195=item body => $string
176 196
177The 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
178this module might offer more options). 198this module might offer more options).
179 199
180=item cookie_jar => $hash_ref 200=item cookie_jar => $hash_ref
181 201
182Passing this parameter enables (simplified) cookie-processing, loosely 202Passing this parameter enables (simplified) cookie-processing, loosely
183based on the original netscape specification. 203based on the original netscape specification.
184 204
185The C<$hash_ref> must be an (initially empty) hash reference which will 205The C<$hash_ref> must be an (initially empty) hash reference which
186get updated automatically. It is possible to save the cookie_jar to 206will get updated automatically. It is possible to save the cookie jar
187persistent storage with something like JSON or Storable, but this is not 207to persistent storage with something like JSON or Storable - see the
188recommended, 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.
189 211
190Note that this cookie implementation is not of very high quality, nor 212Note that this cookie implementation is not meant to be complete. If
191meant to be complete. If you want complete cookie management you have to 213you want complete cookie management you have to do that on your
192do 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
193cookie-using sites working. Cookies are a privacy disaster, do not use 215working. Cookies are a privacy disaster, do not use them unless required
194them 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.
195 221
196=item tls_ctx => $scheme | $tls_ctx 222=item tls_ctx => $scheme | $tls_ctx
197 223
198Specifies the AnyEvent::TLS context to be used for https connections. This 224Specifies the AnyEvent::TLS context to be used for https connections. This
199parameter follows the same rules as the C<tls_ctx> parameter to 225parameter follows the same rules as the C<tls_ctx> parameter to
203verification) TLS context. 229verification) TLS context.
204 230
205The 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
206me the page, no matter what". 232me the page, no matter what".
207 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
208=item on_prepare => $callback->($fh) 244=item on_prepare => $callback->($fh)
209 245
210In 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
211connect (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
212overrides the prepare callback passed to C<AnyEvent::Socket::tcp_connect> 248overrides the prepare callback passed to C<AnyEvent::Socket::tcp_connect>
213and 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
214timeout). See the description for the C<$prepare_cb> argument of 250timeout). See the description for the C<$prepare_cb> argument of
215C<AnyEvent::Socket::tcp_connect> for details. 251C<AnyEvent::Socket::tcp_connect> for details.
216 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
217=item on_header => $callback->($headers) 265=item on_header => $callback->($headers)
218 266
219When 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
220as headers have been successfully received from the remote server (not on 268as headers have been successfully received from the remote server (not on
221locally-generated errors). 269locally-generated errors).
226 274
227This callback is useful, among other things, to quickly reject unwanted 275This callback is useful, among other things, to quickly reject unwanted
228content, 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
229doing a C<HEAD> request. 277doing a C<HEAD> request.
230 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
231Example: cancel the request unless the content-type is "text/html". 283Example: cancel the request unless the content-type is "text/html".
232 284
233 on_header => sub { 285 on_header => sub {
234 $_[0]{"content-type"} =~ /^text\/html\s*(?:;|$)/ 286 $_[0]{"content-type"} =~ /^text\/html\s*(?:;|$)/
235 }, 287 },
241string instead of the body data. 293string instead of the body data.
242 294
243It 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),
244or 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
245the 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.
246 301
247This 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
248(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
249be extracted, or when the body should be processed incrementally. 304be extracted, or when the body should be processed incrementally.
250 305
262called. Instead of the C<$body> argument containing the body data, the 317called. Instead of the C<$body> argument containing the body data, the
263callback will receive the L<AnyEvent::Handle> object associated with the 318callback will receive the L<AnyEvent::Handle> object associated with the
264connection. 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
265(e.g. status C<304>), the empty string will be passed. 320(e.g. status C<304>), the empty string will be passed.
266 321
267The 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
268a proxy, be a persistent connection etc., and configured in unspecified 323to a proxy, be a persistent connection, use chunked transfer encoding
269ways. 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
270module anymore). 325handle (it will not be used by this module anymore).
271 326
272This is useful with some push-type services, where, after the initial 327This is useful with some push-type services, where, after the initial
273headers, an interactive protocol is used (typical example would be the 328headers, an interactive protocol is used (typical example would be the
274push-style twitter API which starts a JSON/XML stream). 329push-style twitter API which starts a JSON/XML stream).
275 330
276If 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
277that doesn't solve your problem in a better way. 332that doesn't solve your problem in a better way.
278 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
279=back 375=back
280 376
281Example: 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.
282 379
283 http_request GET => "http://www.nethype.de/", sub { 380 http_request GET => "http://www.nethype.de/", sub {
284 my ($body, $hdr) = @_; 381 my ($body, $hdr) = @_;
285 print "$body\n"; 382 print "$body\n";
286 }; 383 };
287 384
288Example: 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
289timeout of 30 seconds. 386timeout of 30 seconds.
290 387
291 http_request 388 http_request
292 GET => "https://www.google.com", 389 GET => "https://www.google.com",
390 headers => { "user-agent" => "MySearchClient 1.0" },
293 timeout => 30, 391 timeout => 30,
294 sub { 392 sub {
295 my ($body, $hdr) = @_; 393 my ($body, $hdr) = @_;
296 use Data::Dumper; 394 use Data::Dumper;
297 print Dumper $hdr; 395 print Dumper $hdr;
298 } 396 }
299 ; 397 ;
300 398
301Example: make another simple HTTP GET request, but immediately try to 399Example: do another simple HTTP GET request, but immediately try to
302cancel it. 400cancel it.
303 401
304 my $request = http_request GET => "http://www.nethype.de/", sub { 402 my $request = http_request GET => "http://www.nethype.de/", sub {
305 my ($body, $hdr) = @_; 403 my ($body, $hdr) = @_;
306 print "$body\n"; 404 print "$body\n";
307 }; 405 };
308 406
309 undef $request; 407 undef $request;
310 408
311=cut 409=cut
410
411#############################################################################
412# wait queue/slots
312 413
313sub _slot_schedule; 414sub _slot_schedule;
314sub _slot_schedule($) { 415sub _slot_schedule($) {
315 my $host = shift; 416 my $host = shift;
316 417
338 push @{ $CO_SLOT{$_[0]}[1] }, $_[1]; 439 push @{ $CO_SLOT{$_[0]}[1] }, $_[1];
339 440
340 _slot_schedule $_[0]; 441 _slot_schedule $_[0];
341} 442}
342 443
343our $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
344our $qr_nlnl = qr{(?<![^\012])\015?\012}; 671our $qr_nlnl = qr{(?<![^\012])\015?\012};
345 672
346our $TLS_CTX_LOW = { cache => 1, sslv2 => 1 }; 673our $TLS_CTX_LOW = { cache => 1, sslv2 => 1 };
347our $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}
348 693
349sub http_request($$@) { 694sub http_request($$@) {
350 my $cb = pop; 695 my $cb = pop;
351 my ($method, $url, %arg) = @_; 696 my ($method, $url, %arg) = @_;
352 697
367 my @pseudo = (URL => $url); 712 my @pseudo = (URL => $url);
368 push @pseudo, Redirect => delete $arg{Redirect} if exists $arg{Redirect}; 713 push @pseudo, Redirect => delete $arg{Redirect} if exists $arg{Redirect};
369 714
370 my $recurse = exists $arg{recurse} ? delete $arg{recurse} : $MAX_RECURSE; 715 my $recurse = exists $arg{recurse} ? delete $arg{recurse} : $MAX_RECURSE;
371 716
372 return $cb->(undef, { Status => 599, Reason => "Too many redirections", @pseudo }) 717 return $cb->(undef, { @pseudo, Status => 599, Reason => "Too many redirections" })
373 if $recurse < 0; 718 if $recurse < 0;
374 719
375 my $proxy = $arg{proxy} || $PROXY; 720 my $proxy = exists $arg{proxy} ? $arg{proxy} : $PROXY;
376 my $timeout = $arg{timeout} || $TIMEOUT; 721 my $timeout = $arg{timeout} || $TIMEOUT;
377 722
378 my ($uscheme, $uauthority, $upath, $query, $fragment) = 723 my ($uscheme, $uauthority, $upath, $query, undef) = # ignore fragment
379 $url =~ m|(?:([^:/?#]+):)?(?://([^/?#]*))?([^?#]*)(?:(\?[^#]*))?(?:#(.*))?|; 724 $url =~ m|^([^:]+):(?://([^/?#]*))?([^?#]*)(?:(\?[^#]*))?(?:#(.*))?$|;
380 725
381 $uscheme = lc $uscheme; 726 $uscheme = lc $uscheme;
382 727
383 my $uport = $uscheme eq "http" ? 80 728 my $uport = $uscheme eq "http" ? 80
384 : $uscheme eq "https" ? 443 729 : $uscheme eq "https" ? 443
385 : 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" });
386 731
387 $uauthority =~ /^(?: .*\@ )? ([^\@:]+) (?: : (\d+) )?$/x 732 $uauthority =~ /^(?: .*\@ )? ([^\@:]+) (?: : (\d+) )?$/x
388 or return $cb->(undef, { Status => 599, Reason => "Unparsable URL", @pseudo }); 733 or return $cb->(undef, { @pseudo, Status => 599, Reason => "Unparsable URL" });
389 734
390 my $uhost = $1; 735 my $uhost = lc $1;
391 $uport = $2 if defined $2; 736 $uport = $2 if defined $2;
392 737
393 $hdr{host} = defined $2 ? "$uhost:$2" : "$uhost" 738 $hdr{host} = defined $2 ? "$uhost:$2" : "$uhost"
394 unless exists $hdr{host}; 739 unless exists $hdr{host};
395 740
398 743
399 $upath =~ s%^/?%/%; 744 $upath =~ s%^/?%/%;
400 745
401 # cookie processing 746 # cookie processing
402 if (my $jar = $arg{cookie_jar}) { 747 if (my $jar = $arg{cookie_jar}) {
403 %$jar = () if $jar->{version} != 1; 748 my $cookies = cookie_jar_extract $jar, $uscheme, $uhost, $upath;
404 749
405 my @cookie;
406
407 while (my ($chost, $v) = each %$jar) {
408 if ($chost =~ /^\./) {
409 next unless $chost eq substr $uhost, -length $chost;
410 } elsif ($chost =~ /\./) {
411 next unless $chost eq $uhost;
412 } else {
413 next;
414 }
415
416 while (my ($cpath, $v) = each %$v) {
417 next unless $cpath eq substr $upath, 0, length $cpath;
418
419 while (my ($k, $v) = each %$v) {
420 next if $uscheme ne "https" && exists $v->{secure};
421 my $value = $v->{value};
422 $value =~ s/([\\"])/\\$1/g;
423 push @cookie, "$k=\"$value\"";
424 }
425 }
426 }
427
428 $hdr{cookie} = join "; ", @cookie 750 $hdr{cookie} = join "; ", @$cookies
429 if @cookie; 751 if @$cookies;
430 } 752 }
431 753
432 my ($rhost, $rport, $rscheme, $rpath); # request host, port, path 754 my ($rhost, $rport, $rscheme, $rpath); # request host, port, path
433 755
434 if ($proxy) { 756 if ($proxy) {
437 $rscheme = "http" unless defined $rscheme; 759 $rscheme = "http" unless defined $rscheme;
438 760
439 # don't support https requests over https-proxy transport, 761 # don't support https requests over https-proxy transport,
440 # 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.
441 $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;
442 } else { 767 } else {
443 ($rhost, $rport, $rscheme, $rpath) = ($uhost, $uport, $uscheme, $upath); 768 ($rhost, $rport, $rscheme, $rpath) = ($uhost, $uport, $uscheme, $upath);
444 } 769 }
445 770
446 # leave out fragment and query string, just a heuristic 771 # leave out fragment and query string, just a heuristic
447 $hdr{referer} ||= "$uscheme://$uauthority$upath" unless exists $hdr{referer}; 772 $hdr{referer} = "$uscheme://$uauthority$upath" unless exists $hdr{referer};
448 $hdr{"user-agent"} ||= $USERAGENT unless exists $hdr{"user-agent"}; 773 $hdr{"user-agent"} = $USERAGENT unless exists $hdr{"user-agent"};
449 774
450 $hdr{"content-length"} = length $arg{body} 775 $hdr{"content-length"} = length $arg{body}
451 if length $arg{body} || $method ne "GET"; 776 if length $arg{body} || $method ne "GET";
452 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
453 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 $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 keepalive => 0,
1058 sub {
1059 %state = ();
1060 &$cb
1061 }
1062 );
1063 };
1064 $hdl->on_read (sub {
1065 return unless %state;
1066
1067 # as soon as we receive something, a connection close
1068 # once more becomes a hard error
1069 $hdl->{on_eof} = $old_eof;
1070 $hdl->push_read (line => $qr_nlnl, $state{read_response});
1071 });
1072 } else {
1073 $hdl->push_read (line => $qr_nlnl, $state{read_response});
1074 }
1075 };
1076
1077 my $prepare_handle = sub {
1078 my ($hdl) = $state{handle};
1079
1080 $hdl->on_error (sub {
1081 _error %state, $cb, { @pseudo, Status => $ae_error, Reason => $_[2] };
1082 });
1083 $hdl->on_eof (sub {
1084 _error %state, $cb, { @pseudo, Status => $ae_error, Reason => "Unexpected end-of-file" };
1085 });
1086 $hdl->timeout_reset;
1087 $hdl->timeout ($timeout);
1088 };
1089
1090 # connected to proxy (or origin server)
1091 my $connect_cb = sub {
1092 my $fh = shift
1093 or return _error %state, $cb, { @pseudo, Status => $ae_error, Reason => "$!" };
1094
1095 return unless delete $state{connect_guard};
1096
1097 # get handle
1098 $state{handle} = new AnyEvent::Handle
1099 %{ $arg{handle_params} },
1100 fh => $fh,
1101 peername => $uhost,
1102 tls_ctx => $arg{tls_ctx},
1103 ;
1104
1105 $prepare_handle->();
1106
1107 #$state{handle}->starttls ("connect") if $rscheme eq "https";
1108
1109 # now handle proxy-CONNECT method
1110 if ($proxy && $uscheme eq "https") {
1111 # oh dear, we have to wrap it into a connect request
1112
1113 # maybe re-use $uauthority with patched port?
1114 $state{handle}->push_write ("CONNECT $uhost:$uport HTTP/1.0\015\012\015\012");
1115 $state{handle}->push_read (line => $qr_nlnl, sub {
1116 $_[1] =~ /^HTTP\/([0-9\.]+) \s+ ([0-9]{3}) (?: \s+ ([^\015\012]*) )?/ix
1117 or return _error %state, $cb, { @pseudo, Status => 599, Reason => "Invalid proxy connect response ($_[1])" };
1118
1119 if ($2 == 200) {
1120 $rpath = $upath;
1121 $handle_actual_request->();
1122 } else {
1123 _error %state, $cb, { @pseudo, Status => $2, Reason => $3 };
1124 }
1125 });
1126 } else {
1127 $handle_actual_request->();
1128 }
1129 };
454 1130
455 _get_slot $uhost, sub { 1131 _get_slot $uhost, sub {
456 $state{slot_guard} = shift; 1132 $state{slot_guard} = shift;
457 1133
458 return unless $state{connect_guard}; 1134 return unless $state{connect_guard};
459 1135
460 $state{connect_guard} = AnyEvent::Socket::tcp_connect $rhost, $rport, sub { 1136 # try to use an existing keepalive connection, but only if we, ourselves, plan
461 $state{fh} = shift 1137 # on a keepalive request (in theory, this should be a separate config option).
462 or do { 1138 if ($persistent && $KA_CACHE{$ka_key}) {
463 my $err = "$!"; 1139 $was_persistent = 1;
464 %state = ();
465 return $cb->(undef, { Status => 599, Reason => $err, @pseudo });
466 };
467 1140
468 pop; # free memory, save a tree 1141 $state{handle} = ka_fetch $ka_key;
469
470 return unless delete $state{connect_guard};
471
472 # get handle
473 $state{handle} = new AnyEvent::Handle
474 fh => $state{fh},
475 peername => $rhost,
476 tls_ctx => $arg{tls_ctx},
477 # these need to be reconfigured on keepalive handles
478 timeout => $timeout,
479 on_error => sub {
480 %state = ();
481 $cb->(undef, { Status => 599, Reason => $_[2], @pseudo });
482 },
483 on_eof => sub {
484 %state = ();
485 $cb->(undef, { Status => 599, Reason => "Unexpected end-of-file", @pseudo });
486 },
487 ;
488
489 # limit the number of persistent connections
490 # keepalive not yet supported
491# if ($KA_COUNT{$_[1]} < $MAX_PERSISTENT_PER_HOST) {
492# ++$KA_COUNT{$_[1]};
493# $state{handle}{ka_count_guard} = AnyEvent::Util::guard {
494# --$KA_COUNT{$_[1]}
495# };
496# $hdr{connection} = "keep-alive";
497# } else {
498 delete $hdr{connection};
499# }
500
501 $state{handle}->starttls ("connect") if $rscheme eq "https";
502
503 # handle actual, non-tunneled, request
504 my $handle_actual_request = sub {
505 $state{handle}->starttls ("connect") if $uscheme eq "https" && !exists $state{handle}{tls};
506
507 # send request
508 $state{handle}->push_write ( 1142 $state{handle}->destroyed
509 "$method $rpath HTTP/1.0\015\012" 1143 and die "got a destructed habndle. pah\n";#d#
510 . (join "", map "\u$_: $hdr{$_}\015\012", grep defined $hdr{$_}, keys %hdr) 1144 $prepare_handle->();
511 . "\015\012" 1145 $state{handle}->destroyed
512 . (delete $arg{body}) 1146 and die "got a destructed habndle. pa2\n";#d#
513 );
514
515 # return if error occured during push_write()
516 return unless %state;
517
518 %hdr = (); # reduce memory usage, save a kitten, also make it possible to re-use
519
520 # status line
521 $state{handle}->push_read (line => $qr_nl, sub {
522 $_[1] =~ /^HTTP\/([0-9\.]+) \s+ ([0-9]{3}) (?: \s+ ([^\015\012]*) )?/ix
523 or return (%state = (), $cb->(undef, { Status => 599, Reason => "Invalid server response ($_[1])", @pseudo }));
524
525 push @pseudo,
526 HTTPVersion => $1,
527 Status => $2,
528 Reason => $3,
529 ;
530
531 # headers, could be optimized a bit
532 $state{handle}->unshift_read (line => $qr_nlnl, sub {
533 for ("$_[1]") {
534 y/\015//d; # weed out any \015, as they show up in the weirdest of places.
535
536 # things seen, not parsed:
537 # p3pP="NON CUR OTPi OUR NOR UNI"
538
539 $hdr{lc $1} .= ",$2"
540 while /\G
541 ([^:\000-\037]*):
542 [\011\040]*
543 ((?: [^\012]+ | \012[\011\040] )*)
544 \012
545 /gxc;
546
547 /\G$/
548 or return (%state = (), $cb->(undef, { Status => 599, Reason => "Garbled response headers", @pseudo }));
549 }
550
551 # remove the "," prefix we added to all headers above
552 substr $_, 0, 1, ""
553 for values %hdr;
554
555 # patch in all pseudo headers
556 %hdr = (%hdr, @pseudo);
557
558 # redirect handling
559 # microsoft and other shitheads don't give a shit for following standards,
560 # try to support some common forms of broken Location headers.
561 if ($hdr{location} !~ /^(?: $ | [^:\/?\#]+ : )/x) {
562 $hdr{location} =~ s/^\.\/+//;
563
564 my $url = "$rscheme://$uhost:$uport";
565
566 unless ($hdr{location} =~ s/^\///) {
567 $url .= $upath;
568 $url =~ s/\/[^\/]*$//;
569 }
570
571 $hdr{location} = "$url/$hdr{location}";
572 }
573
574 my $redirect;
575
576 if ($recurse) {
577 my $status = $hdr{Status};
578
579 if (($status == 301 || $status == 302) && $method ne "POST") {
580 # apparently, mozilla et al. just change POST to GET here
581 # more research is needed before we do the same
582 $redirect = 1;
583 } elsif ($status == 303) {
584 # even http/1.1 is unclear on how to mutate the method
585 $method = "GET" unless $method eq "HEAD";
586 $redirect = 1;
587 } elsif ($status == 307 && $method =~ /^(?:GET|HEAD)$/) {
588 $redirect = 1;
589 }
590 }
591
592 my $finish = sub {
593 $state{handle}->destroy if $state{handle};
594 %state = ();
595
596 # set-cookie processing
597 if ($arg{cookie_jar}) {
598 for ($_[1]{"set-cookie"}) {
599 # parse NAME=VALUE
600 my @kv;
601
602 while (/\G\s* ([^=;,[:space:]]+) \s*=\s* (?: "((?:[^\\"]+|\\.)*)" | ([^=;,[:space:]]*) )/gcxs) {
603 my $name = $1;
604 my $value = $3;
605
606 unless ($value) {
607 $value = $2;
608 $value =~ s/\\(.)/$1/gs;
609 }
610
611 push @kv, $name => $value;
612
613 last unless /\G\s*;/gc;
614 }
615
616 last unless @kv;
617
618 my $name = shift @kv;
619 my %kv = (value => shift @kv, @kv);
620
621 my $cdom;
622 my $cpath = (delete $kv{path}) || "/";
623
624 if (exists $kv{domain}) {
625 $cdom = delete $kv{domain};
626
627 $cdom =~ s/^\.?/./; # make sure it starts with a "."
628
629 next if $cdom =~ /\.$/;
630
631 # this is not rfc-like and not netscape-like. go figure.
632 my $ndots = $cdom =~ y/.//;
633 next if $ndots < ($cdom =~ /\.[^.][^.]\.[^.][^.]$/ ? 3 : 2);
634 } else {
635 $cdom = $uhost;
636 }
637
638 # store it
639 $arg{cookie_jar}{version} = 1;
640 $arg{cookie_jar}{$cdom}{$cpath}{$name} = \%kv;
641
642 redo if /\G\s*,/gc;
643 }
644 }
645
646 if ($redirect && exists $hdr{location}) {
647 # we ignore any errors, as it is very common to receive
648 # Content-Length != 0 but no actual body
649 # we also access %hdr, as $_[1] might be an erro
650 http_request (
651 $method => $hdr{location},
652 %arg,
653 recurse => $recurse - 1,
654 Redirect => \@_,
655 $cb);
656 } else {
657 $cb->($_[0], $_[1]);
658 }
659 };
660
661 my $len = $hdr{"content-length"};
662
663 if (!$redirect && $arg{on_header} && !$arg{on_header}(\%hdr)) {
664 $finish->(undef, { Status => 598, Reason => "Request cancelled by on_header", @pseudo });
665 } elsif (
666 $hdr{Status} =~ /^(?:1..|[23]04)$/
667 or $method eq "HEAD"
668 or (defined $len && !$len)
669 ) {
670 # no body
671 $finish->("", \%hdr);
672 } else {
673 # body handling, four different code paths
674 # for want_body_handle, on_body (2x), normal (2x)
675 # we might read too much here, but it does not matter yet (no pers. connections)
676 if (!$redirect && $arg{want_body_handle}) {
677 $_[0]->on_eof (undef);
678 $_[0]->on_error (undef);
679 $_[0]->on_read (undef);
680
681 $finish->(delete $state{handle}, \%hdr);
682
683 } elsif ($arg{on_body}) {
684 $_[0]->on_error (sub { $finish->(undef, { Status => 599, Reason => $_[2], @pseudo }) });
685 if ($len) {
686 $_[0]->on_eof (undef);
687 $_[0]->on_read (sub {
688 $len -= length $_[0]{rbuf};
689
690 $arg{on_body}(delete $_[0]{rbuf}, \%hdr)
691 or $finish->(undef, { Status => 598, Reason => "Request cancelled by on_body", @pseudo });
692
693 $len > 0
694 or $finish->("", \%hdr);
695 });
696 } else {
697 $_[0]->on_eof (sub {
698 $finish->("", \%hdr);
699 });
700 $_[0]->on_read (sub {
701 $arg{on_body}(delete $_[0]{rbuf}, \%hdr)
702 or $finish->(undef, { Status => 598, Reason => "Request cancelled by on_body", @pseudo });
703 });
704 }
705 } else {
706 $_[0]->on_eof (undef);
707
708 if ($len) {
709 $_[0]->on_error (sub { $finish->(undef, { Status => 599, Reason => $_[2], @pseudo }) });
710 $_[0]->on_read (sub {
711 $finish->((substr delete $_[0]{rbuf}, 0, $len, ""), \%hdr)
712 if $len <= length $_[0]{rbuf};
713 });
714 } else {
715 $_[0]->on_error (sub {
716 $! == Errno::EPIPE || !$!
717 ? $finish->(delete $_[0]{rbuf}, \%hdr)
718 : $finish->(undef, { Status => 599, Reason => $_[2], @pseudo });
719 });
720 $_[0]->on_read (sub { });
721 }
722 }
723 }
724 });
725 });
726 };
727
728 # now handle proxy-CONNECT method
729 if ($proxy && $uscheme eq "https") {
730 # oh dear, we have to wrap it into a connect request
731
732 # maybe re-use $uauthority with patched port?
733 $state{handle}->push_write ("CONNECT $uhost:$uport HTTP/1.0\015\012Host: $uhost\015\012\015\012");
734 $state{handle}->push_read (line => $qr_nlnl, sub {
735 $_[1] =~ /^HTTP\/([0-9\.]+) \s+ ([0-9]{3}) (?: \s+ ([^\015\012]*) )?/ix
736 or return (%state = (), $cb->(undef, { Status => 599, Reason => "Invalid proxy connect response ($_[1])", @pseudo }));
737
738 if ($2 == 200) {
739 $rpath = $upath;
740 &$handle_actual_request; 1147 $handle_actual_request->();
741 } else { 1148 $state{handle}->destroyed
742 %state = (); 1149 and die "got a destructed habndle. pa3\n";#d#
743 $cb->(undef, { Status => $2, Reason => $3, @pseudo }); 1150
744 }
745 });
746 } else { 1151 } else {
747 &$handle_actual_request; 1152 my $tcp_connect = $arg{tcp_connect}
1153 || do { require AnyEvent::Socket; \&AnyEvent::Socket::tcp_connect };
1154
1155 $state{connect_guard} = $tcp_connect->($rhost, $rport, $connect_cb, $arg{on_prepare} || sub { $timeout });
748 } 1156 }
749
750 }, $arg{on_prepare} || sub { $timeout };
751 }; 1157 };
752 1158
753 defined wantarray && AnyEvent::Util::guard { %state = () } 1159 defined wantarray && AnyEvent::Util::guard { _destroy_state %state }
754} 1160}
755 1161
756sub http_get($@) { 1162sub http_get($@) {
757 unshift @_, "GET"; 1163 unshift @_, "GET";
758 &http_request 1164 &http_request
776AnyEvent::HTTP uses the AnyEvent::Socket::tcp_connect function for 1182AnyEvent::HTTP uses the AnyEvent::Socket::tcp_connect function for
777the actual connection, which in turn uses AnyEvent::DNS to resolve 1183the actual connection, which in turn uses AnyEvent::DNS to resolve
778hostnames. The latter is a simple stub resolver and does no caching 1184hostnames. The latter is a simple stub resolver and does no caching
779on its own. If you want DNS caching, you currently have to provide 1185on its own. If you want DNS caching, you currently have to provide
780your own default resolver (by storing a suitable resolver object in 1186your own default resolver (by storing a suitable resolver object in
781C<$AnyEvent::DNS::RESOLVER>). 1187C<$AnyEvent::DNS::RESOLVER>) or your own C<tcp_connect> callback.
782 1188
783=head2 GLOBAL FUNCTIONS AND VARIABLES 1189=head2 GLOBAL FUNCTIONS AND VARIABLES
784 1190
785=over 4 1191=over 4
786 1192
787=item AnyEvent::HTTP::set_proxy "proxy-url" 1193=item AnyEvent::HTTP::set_proxy "proxy-url"
788 1194
789Sets the default proxy server to use. The proxy-url must begin with a 1195Sets the default proxy server to use. The proxy-url must begin with a
790string of the form C<http://host:port> (optionally C<https:...>), croaks 1196string of the form C<http://host:port>, croaks otherwise.
791otherwise.
792 1197
793To clear an already-set proxy, use C<undef>. 1198To clear an already-set proxy, use C<undef>.
794 1199
1200When AnyEvent::HTTP is laoded for the first time it will query the
1201default proxy from the operating system, currently by looking at
1202C<$ENV{http_proxy>}.
1203
1204=item AnyEvent::HTTP::cookie_jar_expire $jar[, $session_end]
1205
1206Remove all cookies from the cookie jar that have been expired. If
1207C<$session_end> is given and true, then additionally remove all session
1208cookies.
1209
1210You should call this function (with a true C<$session_end>) before you
1211save cookies to disk, and you should call this function after loading them
1212again. If you have a long-running program you can additonally call this
1213function from time to time.
1214
1215A cookie jar is initially an empty hash-reference that is managed by this
1216module. It's format is subject to change, but currently it is like this:
1217
1218The key C<version> has to contain C<1>, otherwise the hash gets
1219emptied. All other keys are hostnames or IP addresses pointing to
1220hash-references. The key for these inner hash references is the
1221server path for which this cookie is meant, and the values are again
1222hash-references. The keys of those hash-references is the cookie name, and
1223the value, you guessed it, is another hash-reference, this time with the
1224key-value pairs from the cookie, except for C<expires> and C<max-age>,
1225which have been replaced by a C<_expires> key that contains the cookie
1226expiry timestamp.
1227
1228Here is an example of a cookie jar with a single cookie, so you have a
1229chance of understanding the above paragraph:
1230
1231 {
1232 version => 1,
1233 "10.0.0.1" => {
1234 "/" => {
1235 "mythweb_id" => {
1236 _expires => 1293917923,
1237 value => "ooRung9dThee3ooyXooM1Ohm",
1238 },
1239 },
1240 },
1241 }
1242
1243=item $date = AnyEvent::HTTP::format_date $timestamp
1244
1245Takes a POSIX timestamp (seconds since the epoch) and formats it as a HTTP
1246Date (RFC 2616).
1247
1248=item $timestamp = AnyEvent::HTTP::parse_date $date
1249
1250Takes a HTTP Date (RFC 2616) or a Cookie date (netscape cookie spec) or a
1251bunch of minor variations of those, and returns the corresponding POSIX
1252timestamp, or C<undef> if the date cannot be parsed.
1253
795=item $AnyEvent::HTTP::MAX_RECURSE 1254=item $AnyEvent::HTTP::MAX_RECURSE
796 1255
797The default value for the C<recurse> request parameter (default: C<10>). 1256The default value for the C<recurse> request parameter (default: C<10>).
1257
1258=item $AnyEvent::HTTP::TIMEOUT
1259
1260The default timeout for conenction operations (default: C<300>).
798 1261
799=item $AnyEvent::HTTP::USERAGENT 1262=item $AnyEvent::HTTP::USERAGENT
800 1263
801The default value for the C<User-Agent> header (the default is 1264The default value for the C<User-Agent> header (the default is
802C<Mozilla/5.0 (compatible; U; AnyEvent-HTTP/$VERSION; +http://software.schmorp.de/pkg/AnyEvent)>). 1265C<Mozilla/5.0 (compatible; U; AnyEvent-HTTP/$VERSION; +http://software.schmorp.de/pkg/AnyEvent)>).
803 1266
804=item $AnyEvent::HTTP::MAX_PER_HOST 1267=item $AnyEvent::HTTP::MAX_PER_HOST
805 1268
806The maximum number of concurrent connections to the same host (identified 1269The maximum number of concurrent connections to the same host (identified
807by the hostname). If the limit is exceeded, then the additional requests 1270by the hostname). If the limit is exceeded, then the additional requests
808are queued until previous connections are closed. 1271are queued until previous connections are closed. Both persistent and
1272non-persistent connections are counted in this limit.
809 1273
810The default value for this is C<4>, and it is highly advisable to not 1274The default value for this is C<4>, and it is highly advisable to not
811increase it. 1275increase it much.
1276
1277For comparison: the RFC's recommend 4 non-persistent or 2 persistent
1278connections, older browsers used 2, newers (such as firefox 3) typically
1279use 6, and Opera uses 8 because like, they have the fastest browser and
1280give a shit for everybody else on the planet.
1281
1282=item $AnyEvent::HTTP::PERSISTENT_TIMEOUT
1283
1284The time after which idle persistent conenctions get closed by
1285AnyEvent::HTTP (default: C<3>).
812 1286
813=item $AnyEvent::HTTP::ACTIVE 1287=item $AnyEvent::HTTP::ACTIVE
814 1288
815The number of active connections. This is not the number of currently 1289The number of active connections. This is not the number of currently
816running requests, but the number of currently open and non-idle TCP 1290running requests, but the number of currently open and non-idle TCP
817connections. This number of can be useful for load-leveling. 1291connections. This number can be useful for load-leveling.
818 1292
819=back 1293=back
820 1294
821=cut 1295=cut
1296
1297our @month = qw(Jan Feb Mar Apr May Jun Jul Aug Sep Oct Nov Dec);
1298our @weekday = qw(Sun Mon Tue Wed Thu Fri Sat);
1299
1300sub format_date($) {
1301 my ($time) = @_;
1302
1303 # RFC 822/1123 format
1304 my ($S, $M, $H, $mday, $mon, $year, $wday, $yday, undef) = gmtime $time;
1305
1306 sprintf "%s, %02d %s %04d %02d:%02d:%02d GMT",
1307 $weekday[$wday], $mday, $month[$mon], $year + 1900,
1308 $H, $M, $S;
1309}
1310
1311sub parse_date($) {
1312 my ($date) = @_;
1313
1314 my ($d, $m, $y, $H, $M, $S);
1315
1316 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$/) {
1317 # RFC 822/1123, required by RFC 2616 (with " ")
1318 # cookie dates (with "-")
1319
1320 ($d, $m, $y, $H, $M, $S) = ($1, $2, $3, $4, $5, $6);
1321
1322 } 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$/) {
1323 # RFC 850
1324 ($d, $m, $y, $H, $M, $S) = ($1, $2, $3 < 69 ? $3 + 2000 : $3 + 1900, $4, $5, $6);
1325
1326 } 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])$/) {
1327 # ISO C's asctime
1328 ($d, $m, $y, $H, $M, $S) = ($2, $1, $6, $3, $4, $5);
1329 }
1330 # other formats fail in the loop below
1331
1332 for (0..11) {
1333 if ($m eq $month[$_]) {
1334 require Time::Local;
1335 return Time::Local::timegm ($S, $M, $H, $d, $_, $y);
1336 }
1337 }
1338
1339 undef
1340}
822 1341
823sub set_proxy($) { 1342sub set_proxy($) {
824 if (length $_[0]) { 1343 if (length $_[0]) {
825 $_[0] =~ m%^(https?):// ([^:/]+) (?: : (\d*) )?%ix 1344 $_[0] =~ m%^(http):// ([^:/]+) (?: : (\d*) )?%ix
826 or Carp::croak "$_[0]: invalid proxy URL"; 1345 or Carp::croak "$_[0]: invalid proxy URL";
827 $PROXY = [$2, $3 || 3128, $1] 1346 $PROXY = [$2, $3 || 3128, $1]
828 } else { 1347 } else {
829 undef $PROXY; 1348 undef $PROXY;
830 } 1349 }
833# initialise proxy from environment 1352# initialise proxy from environment
834eval { 1353eval {
835 set_proxy $ENV{http_proxy}; 1354 set_proxy $ENV{http_proxy};
836}; 1355};
837 1356
1357=head2 SHOWCASE
1358
1359This section contaisn some more elaborate "real-world" examples or code
1360snippets.
1361
1362=head2 HTTP/1.1 FILE DOWNLOAD
1363
1364Downloading files with HTTP can be quite tricky, especially when something
1365goes wrong and you want to resume.
1366
1367Here is a function that initiates and resumes a download. It uses the
1368last modified time to check for file content changes, and works with many
1369HTTP/1.0 servers as well, and usually falls back to a complete re-download
1370on older servers.
1371
1372It calls the completion callback with either C<undef>, which means a
1373nonretryable error occured, C<0> when the download was partial and should
1374be retried, and C<1> if it was successful.
1375
1376 use AnyEvent::HTTP;
1377
1378 sub download($$$) {
1379 my ($url, $file, $cb) = @_;
1380
1381 open my $fh, "+<", $file
1382 or die "$file: $!";
1383
1384 my %hdr;
1385 my $ofs = 0;
1386
1387 warn stat $fh;
1388 warn -s _;
1389 if (stat $fh and -s _) {
1390 $ofs = -s _;
1391 warn "-s is ", $ofs;#d#
1392 $hdr{"if-unmodified-since"} = AnyEvent::HTTP::format_date +(stat _)[9];
1393 $hdr{"range"} = "bytes=$ofs-";
1394 }
1395
1396 http_get $url,
1397 headers => \%hdr,
1398 on_header => sub {
1399 my ($hdr) = @_;
1400
1401 if ($hdr->{Status} == 200 && $ofs) {
1402 # resume failed
1403 truncate $fh, $ofs = 0;
1404 }
1405
1406 sysseek $fh, $ofs, 0;
1407
1408 1
1409 },
1410 on_body => sub {
1411 my ($data, $hdr) = @_;
1412
1413 if ($hdr->{Status} =~ /^2/) {
1414 length $data == syswrite $fh, $data
1415 or return; # abort on write errors
1416 }
1417
1418 1
1419 },
1420 sub {
1421 my (undef, $hdr) = @_;
1422
1423 my $status = $hdr->{Status};
1424
1425 if (my $time = AnyEvent::HTTP::parse_date $hdr->{"last-modified"}) {
1426 utime $fh, $time, $time;
1427 }
1428
1429 if ($status == 200 || $status == 206 || $status == 416) {
1430 # download ok || resume ok || file already fully downloaded
1431 $cb->(1, $hdr);
1432
1433 } elsif ($status == 412) {
1434 # file has changed while resuming, delete and retry
1435 unlink $file;
1436 $cb->(0, $hdr);
1437
1438 } elsif ($status == 500 or $status == 503 or $status =~ /^59/) {
1439 # retry later
1440 $cb->(0, $hdr);
1441
1442 } else {
1443 $cb->(undef, $hdr);
1444 }
1445 }
1446 ;
1447 }
1448
1449 download "http://server/somelargefile", "/tmp/somelargefile", sub {
1450 if ($_[0]) {
1451 print "OK!\n";
1452 } elsif (defined $_[0]) {
1453 print "please retry later\n";
1454 } else {
1455 print "ERROR\n";
1456 }
1457 };
1458
1459=head3 SOCKS PROXIES
1460
1461Socks proxies are not directly supported by AnyEvent::HTTP. You can
1462compile your perl to support socks, or use an external program such as
1463F<socksify> (dante) or F<tsocks> to make your program use a socks proxy
1464transparently.
1465
1466Alternatively, for AnyEvent::HTTP only, you can use your own
1467C<tcp_connect> function that does the proxy handshake - here is an example
1468that works with socks4a proxies:
1469
1470 use Errno;
1471 use AnyEvent::Util;
1472 use AnyEvent::Socket;
1473 use AnyEvent::Handle;
1474
1475 # host, port and username of/for your socks4a proxy
1476 my $socks_host = "10.0.0.23";
1477 my $socks_port = 9050;
1478 my $socks_user = "";
1479
1480 sub socks4a_connect {
1481 my ($host, $port, $connect_cb, $prepare_cb) = @_;
1482
1483 my $hdl = new AnyEvent::Handle
1484 connect => [$socks_host, $socks_port],
1485 on_prepare => sub { $prepare_cb->($_[0]{fh}) },
1486 on_error => sub { $connect_cb->() },
1487 ;
1488
1489 $hdl->push_write (pack "CCnNZ*Z*", 4, 1, $port, 1, $socks_user, $host);
1490
1491 $hdl->push_read (chunk => 8, sub {
1492 my ($hdl, $chunk) = @_;
1493 my ($status, $port, $ipn) = unpack "xCna4", $chunk;
1494
1495 if ($status == 0x5a) {
1496 $connect_cb->($hdl->{fh}, (format_address $ipn) . ":$port");
1497 } else {
1498 $! = Errno::ENXIO; $connect_cb->();
1499 }
1500 });
1501
1502 $hdl
1503 }
1504
1505Use C<socks4a_connect> instead of C<tcp_connect> when doing C<http_request>s,
1506possibly after switching off other proxy types:
1507
1508 AnyEvent::HTTP::set_proxy undef; # usually you do not want other proxies
1509
1510 http_get 'http://www.google.com', tcp_connect => \&socks4a_connect, sub {
1511 my ($data, $headers) = @_;
1512 ...
1513 };
1514
838=head1 SEE ALSO 1515=head1 SEE ALSO
839 1516
840L<AnyEvent>. 1517L<AnyEvent>.
841 1518
842=head1 AUTHOR 1519=head1 AUTHOR

Diff Legend

Removed lines
+ Added lines
< Changed lines
> Changed lines