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

Diff Legend

Removed lines
+ Added lines
< Changed lines
> Changed lines