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.41 by root, Sun Jul 5 23:50:59 2009 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 4.452 (); 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.12'; 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 = 2;
65our $MAX_PER_HOST = 4;
66 60
67our $PROXY; 61our $PROXY;
68our $ACTIVE = 0; 62our $ACTIVE = 0;
69 63
70my %KA_COUNT; # number of open keep-alive connections per host 64my %KA_CACHE; # indexed by uhost currently, points to [$handle...] array
71my %CO_SLOT; # number of open connections, and wait queue, per host 65my %CO_SLOT; # number of open connections, and wait queue, per host
72 66
73=item http_get $url, key => value..., $cb->($data, $headers) 67=item http_get $url, key => value..., $cb->($data, $headers)
74 68
75Executes an HTTP-GET request. See the http_request function for details on 69Executes an HTTP-GET request. See the http_request function for details on
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 data as first argument 93The callback will be called with the response body data as first argument
100(or C<undef> if it wasn't available due to errors), and a hash-ref with 94(or C<undef> if an error occured), and a hash-ref with response headers
101response headers as second 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 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
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) = @_;
136Whether to recurse requests or not, e.g. on redirects, authentication 159Whether to recurse requests or not, e.g. on redirects, authentication
137retries and so on, and how often to do so. 160retries 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:>. 166will provide defaults at least for C<TE:>, C<Referer:> and C<User-Agent:>
167(this can be suppressed by using C<undef> for these headers in which case
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.
144 176
145=item timeout => $seconds 177=item timeout => $seconds
146 178
147The 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
148the timeout, as will read or write activity. Default timeout is 5 minutes. 180the timeout, as will read or write activity, i.e. this is not an overall
181timeout.
182
183Default timeout is 5 minutes.
149 184
150=item proxy => [$host, $port[, $scheme]] or undef 185=item proxy => [$host, $port[, $scheme]] or undef
151 186
152Use 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
153default proxy (as specified by C<$ENV{http_proxy}>) is used. 188used.
154 189
155C<$scheme> must be either missing or C<http> for HTTP, or C<https> for 190C<$scheme> must be either missing or must be C<http> for HTTP.
156HTTPS. 191
192If not specified, then the default proxy is used (see
193C<AnyEvent::HTTP::set_proxy>).
157 194
158=item body => $string 195=item body => $string
159 196
160The 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
161this module might offer more options). 198this module might offer more options).
162 199
163=item cookie_jar => $hash_ref 200=item cookie_jar => $hash_ref
164 201
165Passing this parameter enables (simplified) cookie-processing, loosely 202Passing this parameter enables (simplified) cookie-processing, loosely
166based on the original netscape specification. 203based on the original netscape specification.
167 204
168The C<$hash_ref> must be an (initially empty) hash reference which will 205The C<$hash_ref> must be an (initially empty) hash reference which
169get updated automatically. It is possible to save the cookie_jar to 206will get updated automatically. It is possible to save the cookie jar
170persistent storage with something like JSON or Storable, but this is not 207to persistent storage with something like JSON or Storable - see the
171recommended, 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.
172 211
173Note that this cookie implementation is not of very high quality, nor 212Note that this cookie implementation is not meant to be complete. If
174meant to be complete. If you want complete cookie management you have to 213you want complete cookie management you have to do that on your
175do 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
176cookie-using sites working. Cookies are a privacy disaster, do not use 215working. Cookies are a privacy disaster, do not use them unless required
177them 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.
178 221
179=item tls_ctx => $scheme | $tls_ctx 222=item tls_ctx => $scheme | $tls_ctx
180 223
181Specifies the AnyEvent::TLS context to be used for https connections. This 224Specifies the AnyEvent::TLS context to be used for https connections. This
182parameter follows the same rules as the C<tls_ctx> parameter to 225parameter follows the same rules as the C<tls_ctx> parameter to
186verification) TLS context. 229verification) TLS context.
187 230
188The 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
189me the page, no matter what". 232me the page, no matter what".
190 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
244=item on_prepare => $callback->($fh)
245
246In rare cases you need to "tune" the socket before it is used to
247connect (for exmaple, to bind it on a given IP address). This parameter
248overrides the prepare callback passed to C<AnyEvent::Socket::tcp_connect>
249and behaves exactly the same way (e.g. it has to provide a
250timeout). See the description for the C<$prepare_cb> argument of
251C<AnyEvent::Socket::tcp_connect> for details.
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
191=item on_header => $callback->($hdr) 265=item on_header => $callback->($headers)
192 266
193When 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
194as headers have been successfully received from the remote server (not on 268as headers have been successfully received from the remote server (not on
195locally-generated errors). 269locally-generated errors).
196 270
200 274
201This callback is useful, among other things, to quickly reject unwanted 275This callback is useful, among other things, to quickly reject unwanted
202content, 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
203doing a C<HEAD> request. 277doing a C<HEAD> request.
204 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
283Example: cancel the request unless the content-type is "text/html".
284
285 on_header => sub {
286 $_[0]{"content-type"} =~ /^text\/html\s*(?:;|$)/
287 },
288
205=item on_body => $callback->($data, $hdr) 289=item on_body => $callback->($partial_body, $headers)
206 290
207When specified, all body data will be "filtered" through this callback. 291When specified, all body data will be passed to this callback instead of
292to the completion callback. The completion callback will get the empty
293string instead of the body data.
208 294
209The callback will incrementally receive body data, and is supposed to 295It has to return either true (in which case AnyEvent::HTTP will continue),
210return it or a modified version of it (empty strings are valid returns). 296or false, in which case AnyEvent::HTTP will cancel the download (and call
297the completion callback with an error code of C<598>).
211 298
212If the callback returns C<undef>, then the request will be cancelled. 299The downside to cancelling the request is that it makes it impossible to
300re-use the connection.
213 301
214This callback is useful when you want to do some processing on the data, 302This callback is useful when the data is too large to be held in memory
215or the data is too large to be held in memory (so the callback writes it 303(so the callback writes it to a file) or when only some information should
216to a file and returns the empty string) and so on. 304be extracted, or when the body should be processed incrementally.
217 305
218It is usually preferred over doing your own body handling via 306It is usually preferred over doing your own body handling via
219C<want_body_handle>. 307C<want_body_handle>, but in case of streaming APIs, where HTTP is
308only used to create a connection, C<want_body_handle> is the better
309alternative, as it allows you to install your own event handler, reducing
310resource usage.
220 311
221=item want_body_handle => $enable 312=item want_body_handle => $enable
222 313
223When enabled (default is disabled), the behaviour of AnyEvent::HTTP 314When enabled (default is disabled), the behaviour of AnyEvent::HTTP
224changes considerably: after parsing the headers, and instead of 315changes considerably: after parsing the headers, and instead of
226called. Instead of the C<$body> argument containing the body data, the 317called. Instead of the C<$body> argument containing the body data, the
227callback will receive the L<AnyEvent::Handle> object associated with the 318callback will receive the L<AnyEvent::Handle> object associated with the
228connection. 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
229(e.g. status C<304>), the empty string will be passed. 320(e.g. status C<304>), the empty string will be passed.
230 321
231The 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
232a proxy, be a persistent connection etc., and configured in unspecified 323to a proxy, be a persistent connection, use chunked transfer encoding
233ways. 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
234module anymore). 325handle (it will not be used by this module anymore).
235 326
236This is useful with some push-type services, where, after the initial 327This is useful with some push-type services, where, after the initial
237headers, an interactive protocol is used (typical example would be the 328headers, an interactive protocol is used (typical example would be the
238push-style twitter API which starts a JSON/XML stream). 329push-style twitter API which starts a JSON/XML stream).
239 330
240If 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
241that doesn'T solve your problem in a better way. 332that doesn't solve your problem in a better way.
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 },
242 374
243=back 375=back
244 376
245Example: 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.
246 379
247 http_request GET => "http://www.nethype.de/", sub { 380 http_request GET => "http://www.nethype.de/", sub {
248 my ($body, $hdr) = @_; 381 my ($body, $hdr) = @_;
249 print "$body\n"; 382 print "$body\n";
250 }; 383 };
251 384
252Example: 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
253timeout of 30 seconds. 386timeout of 30 seconds.
254 387
255 http_request 388 http_request
256 GET => "https://www.google.com", 389 GET => "https://www.google.com",
390 headers => { "user-agent" => "MySearchClient 1.0" },
257 timeout => 30, 391 timeout => 30,
258 sub { 392 sub {
259 my ($body, $hdr) = @_; 393 my ($body, $hdr) = @_;
260 use Data::Dumper; 394 use Data::Dumper;
261 print Dumper $hdr; 395 print Dumper $hdr;
262 } 396 }
263 ; 397 ;
264 398
265Example: make another simple HTTP GET request, but immediately try to 399Example: do another simple HTTP GET request, but immediately try to
266cancel it. 400cancel it.
267 401
268 my $request = http_request GET => "http://www.nethype.de/", sub { 402 my $request = http_request GET => "http://www.nethype.de/", sub {
269 my ($body, $hdr) = @_; 403 my ($body, $hdr) = @_;
270 print "$body\n"; 404 print "$body\n";
271 }; 405 };
272 406
273 undef $request; 407 undef $request;
274 408
275=cut 409=cut
410
411#############################################################################
412# wait queue/slots
276 413
277sub _slot_schedule; 414sub _slot_schedule;
278sub _slot_schedule($) { 415sub _slot_schedule($) {
279 my $host = shift; 416 my $host = shift;
280 417
302 push @{ $CO_SLOT{$_[0]}[1] }, $_[1]; 439 push @{ $CO_SLOT{$_[0]}[1] }, $_[1];
303 440
304 _slot_schedule $_[0]; 441 _slot_schedule $_[0];
305} 442}
306 443
307our $qr_nl = qr<\015?\012>; 444#############################################################################
308our $qr_nlnl = qr<\015?\012\015?\012>; 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
671our $qr_nlnl = qr{(?<![^\012])\015?\012};
309 672
310our $TLS_CTX_LOW = { cache => 1, sslv2 => 1 }; 673our $TLS_CTX_LOW = { cache => 1, sslv2 => 1 };
311our $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}
312 693
313sub http_request($$@) { 694sub http_request($$@) {
314 my $cb = pop; 695 my $cb = pop;
315 my ($method, $url, %arg) = @_; 696 my ($method, $url, %arg) = @_;
316 697
325 while (my ($k, $v) = each %$hdr) { 706 while (my ($k, $v) = each %$hdr) {
326 $hdr{lc $k} = $v; 707 $hdr{lc $k} = $v;
327 } 708 }
328 } 709 }
329 710
711 # pseudo headers for all subsequent responses
712 my @pseudo = (URL => $url);
713 push @pseudo, Redirect => delete $arg{Redirect} if exists $arg{Redirect};
714
330 my $recurse = exists $arg{recurse} ? delete $arg{recurse} : $MAX_RECURSE; 715 my $recurse = exists $arg{recurse} ? delete $arg{recurse} : $MAX_RECURSE;
331 716
332 return $cb->(undef, { Status => 599, Reason => "Too many redirections", URL => $url }) 717 return $cb->(undef, { @pseudo, Status => 599, Reason => "Too many redirections" })
333 if $recurse < 0; 718 if $recurse < 0;
334 719
335 my $proxy = $arg{proxy} || $PROXY; 720 my $proxy = exists $arg{proxy} ? $arg{proxy} : $PROXY;
336 my $timeout = $arg{timeout} || $TIMEOUT; 721 my $timeout = $arg{timeout} || $TIMEOUT;
337 722
338 my ($uscheme, $uauthority, $upath, $query, $fragment) = 723 my ($uscheme, $uauthority, $upath, $query, undef) = # ignore fragment
339 $url =~ m|(?:([^:/?#]+):)?(?://([^/?#]*))?([^?#]*)(?:\?([^#]*))?(?:#(.*))?|; 724 $url =~ m|^([^:]+):(?://([^/?#]*))?([^?#]*)(?:(\?[^#]*))?(?:#(.*))?$|;
340 725
341 $uscheme = lc $uscheme; 726 $uscheme = lc $uscheme;
342 727
343 my $uport = $uscheme eq "http" ? 80 728 my $uport = $uscheme eq "http" ? 80
344 : $uscheme eq "https" ? 443 729 : $uscheme eq "https" ? 443
345 : return $cb->(undef, { Status => 599, Reason => "Only http and https URL schemes supported", URL => $url }); 730 : return $cb->(undef, { @pseudo, Status => 599, Reason => "Only http and https URL schemes supported" });
346 731
347 $uauthority =~ /^(?: .*\@ )? ([^\@:]+) (?: : (\d+) )?$/x 732 $uauthority =~ /^(?: .*\@ )? ([^\@:]+) (?: : (\d+) )?$/x
348 or return $cb->(undef, { Status => 599, Reason => "Unparsable URL", URL => $url }); 733 or return $cb->(undef, { @pseudo, Status => 599, Reason => "Unparsable URL" });
349 734
350 my $uhost = $1; 735 my $uhost = lc $1;
351 $uport = $2 if defined $2; 736 $uport = $2 if defined $2;
352 737
738 $hdr{host} = defined $2 ? "$uhost:$2" : "$uhost"
739 unless exists $hdr{host};
740
353 $uhost =~ s/^\[(.*)\]$/$1/; 741 $uhost =~ s/^\[(.*)\]$/$1/;
354 $upath .= "?$query" if length $query; 742 $upath .= $query if length $query;
355 743
356 $upath =~ s%^/?%/%; 744 $upath =~ s%^/?%/%;
357 745
358 # cookie processing 746 # cookie processing
359 if (my $jar = $arg{cookie_jar}) { 747 if (my $jar = $arg{cookie_jar}) {
360 %$jar = () if $jar->{version} != 1; 748 my $cookies = cookie_jar_extract $jar, $uscheme, $uhost, $upath;
361 749
362 my @cookie;
363
364 while (my ($chost, $v) = each %$jar) {
365 if ($chost =~ /^\./) {
366 next unless $chost eq substr $uhost, -length $chost;
367 } elsif ($chost =~ /\./) {
368 next unless $chost eq $uhost;
369 } else {
370 next;
371 }
372
373 while (my ($cpath, $v) = each %$v) {
374 next unless $cpath eq substr $upath, 0, length $cpath;
375
376 while (my ($k, $v) = each %$v) {
377 next if $uscheme ne "https" && exists $v->{secure};
378 my $value = $v->{value};
379 $value =~ s/([\\"])/\\$1/g;
380 push @cookie, "$k=\"$value\"";
381 }
382 }
383 }
384
385 $hdr{cookie} = join "; ", @cookie 750 $hdr{cookie} = join "; ", @$cookies
386 if @cookie; 751 if @$cookies;
387 } 752 }
388 753
389 my ($rhost, $rport, $rscheme, $rpath); # request host, port, path 754 my ($rhost, $rport, $rscheme, $rpath); # request host, port, path
390 755
391 if ($proxy) { 756 if ($proxy) {
392 ($rpath, $rhost, $rport, $rscheme) = ($url, @$proxy); 757 ($rpath, $rhost, $rport, $rscheme) = ($url, @$proxy);
758
759 $rscheme = "http" unless defined $rscheme;
393 760
394 # don't support https requests over https-proxy transport, 761 # don't support https requests over https-proxy transport,
395 # 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.
396 $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;
397 } else { 767 } else {
398 ($rhost, $rport, $rscheme, $rpath) = ($uhost, $uport, $uscheme, $upath); 768 ($rhost, $rport, $rscheme, $rpath) = ($uhost, $uport, $uscheme, $upath);
399 } 769 }
400 770
401 $hdr{"user-agent"} ||= $USERAGENT; 771 # leave out fragment and query string, just a heuristic
402 $hdr{referer} ||= "$uscheme://$uauthority$upath"; # leave out fragment and query string, just a heuristic 772 $hdr{referer} = "$uscheme://$uauthority$upath" unless exists $hdr{referer};
773 $hdr{"user-agent"} = $USERAGENT unless exists $hdr{"user-agent"};
403 774
404 $hdr{host} = "$uhost:$uport";
405 $hdr{"content-length"} = length $arg{body}; 775 $hdr{"content-length"} = length $arg{body}
776 if length $arg{body} || $method ne "GET";
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
406 790
407 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 };
408 1130
409 _get_slot $uhost, sub { 1131 _get_slot $uhost, sub {
410 $state{slot_guard} = shift; 1132 $state{slot_guard} = shift;
411 1133
412 return unless $state{connect_guard}; 1134 return unless $state{connect_guard};
413 1135
414 $state{connect_guard} = AnyEvent::Socket::tcp_connect $rhost, $rport, sub { 1136 # try to use an existing keepalive connection, but only if we, ourselves, plan
415 $state{fh} = shift 1137 # on a keepalive request (in theory, this should be a separate config option).
416 or return (%state = (), $cb->(undef, { Status => 599, Reason => "$!", URL => $url })); 1138 if ($persistent && $KA_CACHE{$ka_key}) {
417 pop; # free memory, save a tree 1139 $was_persistent = 1;
418 1140
419 return unless delete $state{connect_guard}; 1141 $state{handle} = ka_fetch $ka_key;
1142 $state{handle}->destroyed
1143 and die "got a destructed habndle. pah\n";#d#
1144 $prepare_handle->();
1145 $state{handle}->destroyed
1146 and die "got a destructed habndle. pa2\n";#d#
1147 $handle_actual_request->();
1148 $state{handle}->destroyed
1149 and die "got a destructed habndle. pa3\n";#d#
420 1150
421 # get handle
422 $state{handle} = new AnyEvent::Handle
423 fh => $state{fh},
424 timeout => $timeout,
425 peername => $rhost,
426 tls_ctx => $arg{tls_ctx};
427
428 # limit the number of persistent connections
429 # keepalive not yet supported
430 if ($KA_COUNT{$_[1]} < $MAX_PERSISTENT_PER_HOST) {
431 ++$KA_COUNT{$_[1]};
432 $state{handle}{ka_count_guard} = AnyEvent::Util::guard {
433 --$KA_COUNT{$_[1]}
434 };
435 $hdr{connection} = "keep-alive";
436 } else { 1151 } else {
437 delete $hdr{connection}; 1152 my $tcp_connect = $arg{tcp_connect}
438 } 1153 || do { require AnyEvent::Socket; \&AnyEvent::Socket::tcp_connect };
439 1154
440 # (re-)configure handle 1155 $state{connect_guard} = $tcp_connect->($rhost, $rport, $connect_cb, $arg{on_prepare} || sub { $timeout });
441 $state{handle}->on_error (sub {
442 %state = ();
443 $cb->(undef, { Status => 599, Reason => $_[2], URL => $url });
444 });
445 $state{handle}->on_eof (sub {
446 %state = ();
447 $cb->(undef, { Status => 599, Reason => "Unexpected end-of-file", URL => $url });
448 });
449
450 $state{handle}->starttls ("connect") if $rscheme eq "https";
451
452 # handle actual, non-tunneled, request
453 my $handle_actual_request = sub {
454 $state{handle}->starttls ("connect") if $uscheme eq "https" && !exists $state{handle}{tls};
455
456 # send request
457 $state{handle}->push_write (
458 "$method $rpath HTTP/1.0\015\012"
459 . (join "", map "\u$_: $hdr{$_}\015\012", keys %hdr)
460 . "\015\012"
461 . (delete $arg{body})
462 );
463
464 %hdr = (); # reduce memory usage, save a kitten
465
466 # status line
467 $state{handle}->push_read (line => $qr_nl, sub {
468 $_[1] =~ /^HTTP\/([0-9\.]+) \s+ ([0-9]{3}) (?: \s+ ([^\015\012]*) )?/ix
469 or return (%state = (), $cb->(undef, { Status => 599, Reason => "Invalid server response ($_[1])", URL => $url }));
470
471 my %hdr = ( # response headers
472 HTTPVersion => ",$1",
473 Status => ",$2",
474 Reason => ",$3",
475 URL => ",$url"
476 );
477
478 # headers, could be optimized a bit
479 $state{handle}->unshift_read (line => $qr_nlnl, sub {
480 for ("$_[1]\012") {
481 y/\015//d; # weed out any \015, as they show up in the weirdest of places.
482
483 # things seen, not parsed:
484 # p3pP="NON CUR OTPi OUR NOR UNI"
485
486 $hdr{lc $1} .= ",$2"
487 while /\G
488 ([^:\000-\037]+):
489 [\011\040]*
490 ((?: [^\012]+ | \012[\011\040] )*)
491 \012
492 /gxc;
493
494 /\G$/
495 or return (%state = (), $cb->(undef, { Status => 599, Reason => "Garbled response headers", URL => $url }));
496 }
497
498 substr $_, 0, 1, ""
499 for values %hdr;
500
501 # redirect handling
502 # microsoft and other shitheads don't give a shit for following standards,
503 # try to support some common forms of broken Location headers.
504 if ($hdr{location} !~ /^(?: $ | [^:\/?\#]+ : )/x) {
505 $hdr{location} =~ s/^\.\/+//;
506
507 my $url = "$rscheme://$uhost:$uport";
508
509 unless ($hdr{location} =~ s/^\///) {
510 $url .= $upath;
511 $url =~ s/\/[^\/]*$//;
512 }
513
514 $hdr{location} = "$url/$hdr{location}";
515 }
516
517 my $redirect;
518
519 if ($recurse) {
520 if ($hdr{Status} =~ /^30[12]$/ && $method ne "POST") {
521 # apparently, mozilla et al. just change POST to GET here
522 # more research is needed before we do the same
523 $redirect = 1;
524 } elsif ($hdr{Status} == 303) {
525 # even http/1.1 is unclear on how to mutate the method
526 $method = "GET" unless $method eq "HEAD";
527 $redirect = 1;
528 } elsif ($hdr{Status} == 307 && $method =~ /^(?:GET|HEAD)$/) {
529 $redirect = 1;
530 }
531 }
532
533 my $finish = sub {
534 $state{handle}->destroy if $state{handle};
535 %state = ();
536
537 # set-cookie processing
538 if ($arg{cookie_jar}) {
539 for ($_[1]{"set-cookie"}) {
540 # parse NAME=VALUE
541 my @kv;
542
543 while (/\G\s* ([^=;,[:space:]]+) \s*=\s* (?: "((?:[^\\"]+|\\.)*)" | ([^=;,[:space:]]*) )/gcxs) {
544 my $name = $1;
545 my $value = $3;
546
547 unless ($value) {
548 $value = $2;
549 $value =~ s/\\(.)/$1/gs;
550 }
551
552 push @kv, $name => $value;
553
554 last unless /\G\s*;/gc;
555 }
556
557 last unless @kv;
558
559 my $name = shift @kv;
560 my %kv = (value => shift @kv, @kv);
561
562 my $cdom;
563 my $cpath = (delete $kv{path}) || "/";
564
565 if (exists $kv{domain}) {
566 $cdom = delete $kv{domain};
567
568 $cdom =~ s/^\.?/./; # make sure it starts with a "."
569
570 next if $cdom =~ /\.$/;
571
572 # this is not rfc-like and not netscape-like. go figure.
573 my $ndots = $cdom =~ y/.//;
574 next if $ndots < ($cdom =~ /\.[^.][^.]\.[^.][^.]$/ ? 3 : 2);
575 } else {
576 $cdom = $uhost;
577 }
578
579 # store it
580 $arg{cookie_jar}{version} = 1;
581 $arg{cookie_jar}{$cdom}{$cpath}{$name} = \%kv;
582
583 redo if /\G\s*,/gc;
584 }
585 }
586
587 if ($redirect) {
588 # we ignore any errors, as it is very common to receive
589 # Content-Length != 0 but no actual body
590 # we also access %hdr, as $_[1] might be an erro
591 http_request ($method => $hdr{location}, %arg, recurse => $recurse - 1, $cb);
592 } else {
593 $cb->($_[0], $_[1]);
594 }
595 };
596
597 my $len = $hdr{"content-length"};
598
599 if (!$redirect && $arg{on_header} && !$arg{on_header}(\%hdr)) {
600 $finish->(undef, { Status => 598, Reason => "Request cancelled by on_header", URL => $url });
601 } elsif (
602 $hdr{Status} =~ /^(?:1..|204|304)$/
603 or $method eq "HEAD"
604 or (defined $len && !$len)
605 ) {
606 # no body
607 $finish->("", \%hdr);
608 } else {
609 # body handling, four different code paths
610 # for want_body_handle, on_body (2x), normal (2x)
611 # we might read too much here, but it does not matter yet (no pers. connections)
612 if (!$redirect && $arg{want_body_handle}) {
613 $_[0]->on_eof (undef);
614 $_[0]->on_error (undef);
615 $_[0]->on_read (undef);
616
617 $finish->(delete $state{handle}, \%hdr);
618
619 } elsif ($arg{on_body}) {
620 $_[0]->on_error (sub { $finish->(undef, { Status => 599, Reason => $_[2], URL => $url }) });
621 if ($len) {
622 $_[0]->on_eof (undef);
623 $_[0]->on_read (sub {
624 $len -= length $_[0]{rbuf};
625
626 $arg{on_body}(delete $_[0]{rbuf}, \%hdr)
627 or $finish->(undef, { Status => 598, Reason => "Request cancelled by on_body", URL => $url });
628
629 $len > 0
630 or $finish->("", \%hdr);
631 });
632 } else {
633 $_[0]->on_eof (sub {
634 $finish->("", \%hdr);
635 });
636 $_[0]->on_read (sub {
637 $arg{on_body}(delete $_[0]{rbuf}, \%hdr)
638 or $finish->(undef, { Status => 598, Reason => "Request cancelled by on_body", URL => $url });
639 });
640 }
641 } else {
642 $_[0]->on_eof (undef);
643
644 if ($len) {
645 $_[0]->on_error (sub { $finish->(undef, { Status => 599, Reason => $_[2], URL => $url }) });
646 $_[0]->on_read (sub {
647 $finish->((substr delete $_[0]{rbuf}, 0, $len, ""), \%hdr)
648 if $len <= length $_[0]{rbuf};
649 });
650 } else {
651 $_[0]->on_error (sub {
652 $! == Errno::EPIPE
653 ? $finish->(delete $_[0]{rbuf}, \%hdr)
654 : $finish->(undef, { Status => 599, Reason => $_[2], URL => $url });
655 });
656 $_[0]->on_read (sub { });
657 }
658 }
659 }
660 });
661 });
662 };
663
664 # now handle proxy-CONNECT method
665 if ($proxy && $uscheme eq "https") {
666 # oh dear, we have to wrap it into a connect request
667
668 # maybe re-use $uauthority with patched port?
669 $state{handle}->push_write ("CONNECT $uhost:$uport HTTP/1.0\015\012Host: $uhost\015\012\015\012");
670 $state{handle}->push_read (line => $qr_nlnl, sub {
671 $_[1] =~ /^HTTP\/([0-9\.]+) \s+ ([0-9]{3}) (?: \s+ ([^\015\012]*) )?/ix
672 or return (%state = (), $cb->(undef, { Status => 599, Reason => "Invalid proxy connect response ($_[1])", URL => $url }));
673
674 if ($2 == 200) {
675 $rpath = $upath;
676 &$handle_actual_request;
677 } else {
678 %state = ();
679 $cb->(undef, { Status => $2, Reason => $3, URL => $url });
680 }
681 });
682 } else {
683 &$handle_actual_request;
684 }
685
686 }, sub {
687 $timeout
688 }; 1156 }
689 }; 1157 };
690 1158
691 defined wantarray && AnyEvent::Util::guard { %state = () } 1159 defined wantarray && AnyEvent::Util::guard { _destroy_state %state }
692} 1160}
693 1161
694sub http_get($@) { 1162sub http_get($@) {
695 unshift @_, "GET"; 1163 unshift @_, "GET";
696 &http_request 1164 &http_request
707 &http_request 1175 &http_request
708} 1176}
709 1177
710=back 1178=back
711 1179
1180=head2 DNS CACHING
1181
1182AnyEvent::HTTP uses the AnyEvent::Socket::tcp_connect function for
1183the actual connection, which in turn uses AnyEvent::DNS to resolve
1184hostnames. The latter is a simple stub resolver and does no caching
1185on its own. If you want DNS caching, you currently have to provide
1186your own default resolver (by storing a suitable resolver object in
1187C<$AnyEvent::DNS::RESOLVER>) or your own C<tcp_connect> callback.
1188
712=head2 GLOBAL FUNCTIONS AND VARIABLES 1189=head2 GLOBAL FUNCTIONS AND VARIABLES
713 1190
714=over 4 1191=over 4
715 1192
716=item AnyEvent::HTTP::set_proxy "proxy-url" 1193=item AnyEvent::HTTP::set_proxy "proxy-url"
717 1194
718Sets 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
719string of the form C<http://host:port> (optionally C<https:...>). 1196string of the form C<http://host:port>, croaks otherwise.
1197
1198To clear an already-set proxy, use C<undef>.
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.
720 1253
721=item $AnyEvent::HTTP::MAX_RECURSE 1254=item $AnyEvent::HTTP::MAX_RECURSE
722 1255
723The 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>).
724 1261
725=item $AnyEvent::HTTP::USERAGENT 1262=item $AnyEvent::HTTP::USERAGENT
726 1263
727The default value for the C<User-Agent> header (the default is 1264The default value for the C<User-Agent> header (the default is
728C<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)>).
729 1266
730=item $AnyEvent::HTTP::MAX_PERSISTENT 1267=item $AnyEvent::HTTP::MAX_PER_HOST
731 1268
732The maximum number of persistent connections to keep open (default: 8). 1269The maximum number of concurrent connections to the same host (identified
1270by the hostname). If the limit is exceeded, then the additional requests
1271are queued until previous connections are closed. Both persistent and
1272non-persistent connections are counted in this limit.
733 1273
734Not implemented currently. 1274The default value for this is C<4>, and it is highly advisable to not
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.
735 1281
736=item $AnyEvent::HTTP::PERSISTENT_TIMEOUT 1282=item $AnyEvent::HTTP::PERSISTENT_TIMEOUT
737 1283
738The maximum time to cache a persistent connection, in seconds (default: 2). 1284The time after which idle persistent conenctions get closed by
739 1285AnyEvent::HTTP (default: C<3>).
740Not implemented currently.
741 1286
742=item $AnyEvent::HTTP::ACTIVE 1287=item $AnyEvent::HTTP::ACTIVE
743 1288
744The number of active connections. This is not the number of currently 1289The number of active connections. This is not the number of currently
745running requests, but the number of currently open and non-idle TCP 1290running requests, but the number of currently open and non-idle TCP
746connections. This number of can be useful for load-leveling. 1291connections. This number can be useful for load-leveling.
747 1292
748=back 1293=back
749 1294
750=cut 1295=cut
751 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}
1341
752sub set_proxy($) { 1342sub set_proxy($) {
753 $PROXY = [$2, $3 || 3128, $1] if $_[0] =~ m%^(https?):// ([^:/]+) (?: : (\d*) )?%ix; 1343 if (length $_[0]) {
1344 $_[0] =~ m%^(http):// ([^:/]+) (?: : (\d*) )?%ix
1345 or Carp::croak "$_[0]: invalid proxy URL";
1346 $PROXY = [$2, $3 || 3128, $1]
1347 } else {
1348 undef $PROXY;
1349 }
754} 1350}
755 1351
756# initialise proxy from environment 1352# initialise proxy from environment
1353eval {
757set_proxy $ENV{http_proxy}; 1354 set_proxy $ENV{http_proxy};
1355};
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 };
758 1514
759=head1 SEE ALSO 1515=head1 SEE ALSO
760 1516
761L<AnyEvent>. 1517L<AnyEvent>.
762 1518

Diff Legend

Removed lines
+ Added lines
< Changed lines
> Changed lines