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

Diff Legend

Removed lines
+ Added lines
< Changed lines
> Changed lines