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.39 by root, Thu Jun 11 12:46:01 2009 UTC vs.
Revision 1.80 by root, Sat Jan 1 21:51:22 2011 UTC

39package AnyEvent::HTTP; 39package AnyEvent::HTTP;
40 40
41use strict; 41use strict;
42no warnings; 42no warnings;
43 43
44use Carp; 44use Errno ();
45 45
46use AnyEvent (); 46use AnyEvent 5.0 ();
47use AnyEvent::Util (); 47use AnyEvent::Util ();
48use AnyEvent::Socket ();
49use AnyEvent::Handle (); 48use AnyEvent::Handle ();
50 49
51use base Exporter::; 50use base Exporter::;
52 51
53our $VERSION = '1.12'; 52our $VERSION = '1.5';
54 53
55our @EXPORT = qw(http_get http_post http_head http_request); 54our @EXPORT = qw(http_get http_post http_head http_request);
56 55
57our $USERAGENT = "Mozilla/5.0 (compatible; AnyEvent::HTTP/$VERSION; +http://software.schmorp.de/pkg/AnyEvent)"; 56our $USERAGENT = "Mozilla/5.0 (compatible; U; AnyEvent-HTTP/$VERSION; +http://software.schmorp.de/pkg/AnyEvent)";
58our $MAX_RECURSE = 10; 57our $MAX_RECURSE = 10;
59our $MAX_PERSISTENT = 8; 58our $MAX_PERSISTENT = 8;
60our $PERSISTENT_TIMEOUT = 2; 59our $PERSISTENT_TIMEOUT = 2;
61our $TIMEOUT = 300; 60our $TIMEOUT = 300;
62 61
63# changing these is evil 62# changing these is evil
64our $MAX_PERSISTENT_PER_HOST = 2; 63our $MAX_PERSISTENT_PER_HOST = 0;
65our $MAX_PER_HOST = 4; 64our $MAX_PER_HOST = 4;
66 65
67our $PROXY; 66our $PROXY;
68our $ACTIVE = 0; 67our $ACTIVE = 0;
69 68
92must be an absolute http or https URL. 91must be an absolute http or https URL.
93 92
94When called in void context, nothing is returned. In other contexts, 93When called in void context, nothing is returned. In other contexts,
95C<http_request> returns a "cancellation guard" - you have to keep the 94C<http_request> returns a "cancellation guard" - you have to keep the
96object at least alive until the callback get called. If the object gets 95object at least alive until the callback get called. If the object gets
97destroyed before the callbakc is called, the request will be cancelled. 96destroyed before the callback is called, the request will be cancelled.
98 97
99The callback will be called with the response data as first argument 98The callback will be called with the response body data as first argument
100(or C<undef> if it wasn't available due to errors), and a hash-ref with 99(or C<undef> if an error occured), and a hash-ref with response headers
101response headers as second argument. 100(and trailers) as second argument.
102 101
103All the headers in that hash are lowercased. In addition to the response 102All the headers in that hash are lowercased. In addition to the response
104headers, the "pseudo-headers" C<HTTPVersion>, C<Status> and C<Reason> 103headers, the "pseudo-headers" (uppercase to avoid clashing with possible
104response headers) C<HTTPVersion>, C<Status> and C<Reason> contain the
105contain the three parts of the HTTP Status-Line of the same name. The 105three parts of the HTTP Status-Line of the same name. If an error occurs
106during the body phase of a request, then the original C<Status> and
107C<Reason> values from the header are available as C<OrigStatus> and
108C<OrigReason>.
109
106pseudo-header C<URL> contains the original URL (which can differ from the 110The pseudo-header C<URL> contains the actual URL (which can differ from
107requested URL when following redirects). 111the requested URL when following redirects - for example, you might get
112an error that your URL scheme is not supported even though your URL is a
113valid http URL because it redirected to an ftp URL, in which case you can
114look at the URL pseudo header).
115
116The pseudo-header C<Redirect> only exists when the request was a result
117of an internal redirect. In that case it is an array reference with
118the C<($data, $headers)> from the redirect response. Note that this
119response could in turn be the result of a redirect itself, and C<<
120$headers->{Redirect}[1]{Redirect} >> will then contain the original
121response, and so on.
108 122
109If the server sends a header multiple times, then their contents will be 123If the server sends a header multiple times, then their contents will be
110joined together with a comma (C<,>), as per the HTTP spec. 124joined together with a comma (C<,>), as per the HTTP spec.
111 125
112If an internal error occurs, such as not being able to resolve a hostname, 126If 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<599> 127then C<$data> will be C<undef>, C<< $headers->{Status} >> will be
114and the C<Reason> pseudo-header will contain an error message. 128C<590>-C<599> and the C<Reason> pseudo-header will contain an error
129message. Currently the following status codes are used:
130
131=over 4
132
133=item 595 - errors during connection etsbalishment, proxy handshake.
134
135=item 596 - errors during TLS negotiation, request sending and header processing.
136
137=item 597 - errors during body receiving or processing.
138
139=item 598 - user aborted request via C<on_header> or C<on_body>.
140
141=item 599 - other, usually nonretryable, errors (garbled URL etc.).
142
143=back
115 144
116A typical callback might look like this: 145A typical callback might look like this:
117 146
118 sub { 147 sub {
119 my ($body, $hdr) = @_; 148 my ($body, $hdr) = @_;
135Whether to recurse requests or not, e.g. on redirects, authentication 164Whether to recurse requests or not, e.g. on redirects, authentication
136retries and so on, and how often to do so. 165retries and so on, and how often to do so.
137 166
138=item headers => hashref 167=item headers => hashref
139 168
140The request headers to use. Currently, C<http_request> may provide its 169The request headers to use. Currently, C<http_request> may provide its own
141own C<Host:>, C<Content-Length:>, C<Connection:> and C<Cookie:> headers 170C<Host:>, C<Content-Length:>, C<Connection:> and C<Cookie:> headers and
142and will provide defaults for C<User-Agent:> and C<Referer:>. 171will provide defaults at least for C<TE:>, C<Referer:> and C<User-Agent:>
172(this can be suppressed by using C<undef> for these headers in which case
173they won't be sent at all).
143 174
144=item timeout => $seconds 175=item timeout => $seconds
145 176
146The time-out to use for various stages - each connect attempt will reset 177The time-out to use for various stages - each connect attempt will reset
147the timeout, as will read or write activity. Default timeout is 5 minutes. 178the timeout, as will read or write activity, i.e. this is not an overall
179timeout.
180
181Default timeout is 5 minutes.
148 182
149=item proxy => [$host, $port[, $scheme]] or undef 183=item proxy => [$host, $port[, $scheme]] or undef
150 184
151Use the given http proxy for all requests. If not specified, then the 185Use the given http proxy for all requests. If not specified, then the
152default proxy (as specified by C<$ENV{http_proxy}>) is used. 186default proxy (as specified by C<$ENV{http_proxy}>) is used.
153 187
154C<$scheme> must be either missing or C<http> for HTTP, or C<https> for 188C<$scheme> must be either missing, C<http> for HTTP or C<https> for
155HTTPS. 189HTTPS.
156 190
157=item body => $string 191=item body => $string
158 192
159The request body, usually empty. Will be-sent as-is (future versions of 193The request body, usually empty. Will be sent as-is (future versions of
160this module might offer more options). 194this module might offer more options).
161 195
162=item cookie_jar => $hash_ref 196=item cookie_jar => $hash_ref
163 197
164Passing this parameter enables (simplified) cookie-processing, loosely 198Passing this parameter enables (simplified) cookie-processing, loosely
165based on the original netscape specification. 199based on the original netscape specification.
166 200
167The C<$hash_ref> must be an (initially empty) hash reference which will 201The C<$hash_ref> must be an (initially empty) hash reference which
168get updated automatically. It is possible to save the cookie_jar to 202will get updated automatically. It is possible to save the cookie jar
169persistent storage with something like JSON or Storable, but this is not 203to persistent storage with something like JSON or Storable - see the
170recommended, as expire times are currently being ignored. 204C<AnyEvent::HTTP::cookie_jar_expire> function if you wish to remove
205expired or session-only cookies, and also for documentation on the format
206of the cookie jar.
171 207
172Note that this cookie implementation is not of very high quality, nor 208Note that this cookie implementation is not meant to be complete. If
173meant to be complete. If you want complete cookie management you have to 209you want complete cookie management you have to do that on your
174do that on your own. C<cookie_jar> is meant as a quick fix to get some 210own. C<cookie_jar> is meant as a quick fix to get most cookie-using sites
175cookie-using sites working. Cookies are a privacy disaster, do not use 211working. Cookies are a privacy disaster, do not use them unless required
176them unless required to. 212to.
213
214When cookie processing is enabled, the C<Cookie:> and C<Set-Cookie:>
215headers will be set and handled by this module, otherwise they will be
216left untouched.
217
218=item tls_ctx => $scheme | $tls_ctx
219
220Specifies the AnyEvent::TLS context to be used for https connections. This
221parameter follows the same rules as the C<tls_ctx> parameter to
222L<AnyEvent::Handle>, but additionally, the two strings C<low> or
223C<high> can be specified, which give you a predefined low-security (no
224verification, highest compatibility) and high-security (CA and common-name
225verification) TLS context.
226
227The default for this option is C<low>, which could be interpreted as "give
228me the page, no matter what".
229
230=item on_prepare => $callback->($fh)
231
232In rare cases you need to "tune" the socket before it is used to
233connect (for exmaple, to bind it on a given IP address). This parameter
234overrides the prepare callback passed to C<AnyEvent::Socket::tcp_connect>
235and behaves exactly the same way (e.g. it has to provide a
236timeout). See the description for the C<$prepare_cb> argument of
237C<AnyEvent::Socket::tcp_connect> for details.
238
239=item tcp_connect => $callback->($host, $service, $connect_cb, $prepare_cb)
240
241In even rarer cases you want total control over how AnyEvent::HTTP
242establishes connections. Normally it uses L<AnyEvent::Socket::tcp_connect>
243to do this, but you can provide your own C<tcp_connect> function -
244obviously, it has to follow the same calling conventions, except that it
245may always return a connection guard object.
246
247There are probably lots of weird uses for this function, starting from
248tracing the hosts C<http_request> actually tries to connect, to (inexact
249but fast) host => IP address caching or even socks protocol support.
250
251=item on_header => $callback->($headers)
252
253When specified, this callback will be called with the header hash as soon
254as headers have been successfully received from the remote server (not on
255locally-generated errors).
256
257It has to return either true (in which case AnyEvent::HTTP will continue),
258or false, in which case AnyEvent::HTTP will cancel the download (and call
259the finish callback with an error code of C<598>).
260
261This callback is useful, among other things, to quickly reject unwanted
262content, which, if it is supposed to be rare, can be faster than first
263doing a C<HEAD> request.
264
265The downside is that cancelling the request makes it impossible to re-use
266the connection. Also, the C<on_header> callback will not receive any
267trailer (headers sent after the response body).
268
269Example: cancel the request unless the content-type is "text/html".
270
271 on_header => sub {
272 $_[0]{"content-type"} =~ /^text\/html\s*(?:;|$)/
273 },
274
275=item on_body => $callback->($partial_body, $headers)
276
277When specified, all body data will be passed to this callback instead of
278to the completion callback. The completion callback will get the empty
279string instead of the body data.
280
281It has to return either true (in which case AnyEvent::HTTP will continue),
282or false, in which case AnyEvent::HTTP will cancel the download (and call
283the completion callback with an error code of C<598>).
284
285The downside to cancelling the request is that it makes it impossible to
286re-use the connection.
287
288This callback is useful when the data is too large to be held in memory
289(so the callback writes it to a file) or when only some information should
290be extracted, or when the body should be processed incrementally.
291
292It is usually preferred over doing your own body handling via
293C<want_body_handle>, but in case of streaming APIs, where HTTP is
294only used to create a connection, C<want_body_handle> is the better
295alternative, as it allows you to install your own event handler, reducing
296resource usage.
297
298=item want_body_handle => $enable
299
300When enabled (default is disabled), the behaviour of AnyEvent::HTTP
301changes considerably: after parsing the headers, and instead of
302downloading the body (if any), the completion callback will be
303called. Instead of the C<$body> argument containing the body data, the
304callback will receive the L<AnyEvent::Handle> object associated with the
305connection. In error cases, C<undef> will be passed. When there is no body
306(e.g. status C<304>), the empty string will be passed.
307
308The handle object might or might not be in TLS mode, might be connected to
309a proxy, be a persistent connection etc., and configured in unspecified
310ways. The user is responsible for this handle (it will not be used by this
311module anymore).
312
313This is useful with some push-type services, where, after the initial
314headers, an interactive protocol is used (typical example would be the
315push-style twitter API which starts a JSON/XML stream).
316
317If you think you need this, first have a look at C<on_body>, to see if
318that doesn't solve your problem in a better way.
177 319
178=back 320=back
179 321
180Example: make a simple HTTP GET request for http://www.nethype.de/ 322Example: do a simple HTTP GET request for http://www.nethype.de/ and print
323the response body.
181 324
182 http_request GET => "http://www.nethype.de/", sub { 325 http_request GET => "http://www.nethype.de/", sub {
183 my ($body, $hdr) = @_; 326 my ($body, $hdr) = @_;
184 print "$body\n"; 327 print "$body\n";
185 }; 328 };
186 329
187Example: make a HTTP HEAD request on https://www.google.com/, use a 330Example: do a HTTP HEAD request on https://www.google.com/, use a
188timeout of 30 seconds. 331timeout of 30 seconds.
189 332
190 http_request 333 http_request
191 GET => "https://www.google.com", 334 GET => "https://www.google.com",
192 timeout => 30, 335 timeout => 30,
195 use Data::Dumper; 338 use Data::Dumper;
196 print Dumper $hdr; 339 print Dumper $hdr;
197 } 340 }
198 ; 341 ;
199 342
200Example: make another simple HTTP GET request, but immediately try to 343Example: do another simple HTTP GET request, but immediately try to
201cancel it. 344cancel it.
202 345
203 my $request = http_request GET => "http://www.nethype.de/", sub { 346 my $request = http_request GET => "http://www.nethype.de/", sub {
204 my ($body, $hdr) = @_; 347 my ($body, $hdr) = @_;
205 print "$body\n"; 348 print "$body\n";
237 push @{ $CO_SLOT{$_[0]}[1] }, $_[1]; 380 push @{ $CO_SLOT{$_[0]}[1] }, $_[1];
238 381
239 _slot_schedule $_[0]; 382 _slot_schedule $_[0];
240} 383}
241 384
242our $qr_nl = qr<\015?\012>; 385#############################################################################
243our $qr_nlnl = qr<\015?\012\015?\012>; 386
387# expire cookies
388sub cookie_jar_expire($;$) {
389 my ($jar, $session_end) = @_;
390
391 %$jar = () if $jar->{version} != 1;
392
393 my $anow = AE::now;
394
395 while (my ($chost, $paths) = each %$jar) {
396 next unless ref $paths;
397
398 while (my ($cpath, $cookies) = each %$paths) {
399 while (my ($cookie, $kv) = each %$cookies) {
400 if (exists $kv->{_expires}) {
401 delete $cookies->{$cookie}
402 if $anow > $kv->{_expires};
403 } elsif ($session_end) {
404 delete $cookies->{$cookie};
405 }
406 }
407
408 delete $paths->{$cpath}
409 unless %$cookies;
410 }
411
412 delete $jar->{$chost}
413 unless %$paths;
414 }
415}
416
417# extract cookies from jar
418sub cookie_jar_extract($$$$) {
419 my ($jar, $uscheme, $uhost, $upath) = @_;
420
421 %$jar = () if $jar->{version} != 1;
422
423 my @cookies;
424
425 while (my ($chost, $paths) = each %$jar) {
426 next unless ref $paths;
427
428 if ($chost =~ /^\./) {
429 next unless $chost eq substr $uhost, -length $chost;
430 } elsif ($chost =~ /\./) {
431 next unless $chost eq $uhost;
432 } else {
433 next;
434 }
435
436 while (my ($cpath, $cookies) = each %$paths) {
437 next unless $cpath eq substr $upath, 0, length $cpath;
438
439 while (my ($cookie, $kv) = each %$cookies) {
440 next if $uscheme ne "https" && exists $kv->{secure};
441
442 if (exists $kv->{_expires} and AE::now > $kv->{_expires}) {
443 delete $cookies->{$cookie};
444 next;
445 }
446
447 my $value = $kv->{value};
448
449 if ($value =~ /[=;,[:space:]]/) {
450 $value =~ s/([\\"])/\\$1/g;
451 $value = "\"$value\"";
452 }
453
454 push @cookies, "$cookie=$value";
455 }
456 }
457 }
458
459 \@cookies
460}
461
462# parse set_cookie header into jar
463sub cookie_jar_set_cookie($$$$) {
464 my ($jar, $set_cookie, $uhost, $date) = @_;
465
466 my $anow = int AE::now;
467 my $snow; # server-now
468
469 for ($set_cookie) {
470 # parse NAME=VALUE
471 my @kv;
472
473 # expires is not http-compliant in the original cookie-spec,
474 # we support the official date format and some extensions
475 while (
476 m{
477 \G\s*
478 (?:
479 expires \s*=\s* ([A-Z][a-z][a-z]+,\ [^,;]+)
480 | ([^=;,[:space:]]+) \s*=\s* (?: "((?:[^\\"]+|\\.)*)" | ([^=;,[:space:]]*) )
481 )
482 }gcxsi
483 ) {
484 my $name = $2;
485 my $value = $4;
486
487 unless (defined $name) {
488 # expires
489 $name = "expires";
490 $value = $1;
491 } elsif (!defined $value) {
492 # quoted
493 $value = $3;
494 $value =~ s/\\(.)/$1/gs;
495 }
496
497 push @kv, lc $name, $value;
498
499 last unless /\G\s*;/gc;
500 }
501
502 last unless @kv;
503
504 my $name = shift @kv;
505 my %kv = (value => shift @kv, @kv);
506
507 if (exists $kv{"max-age"}) {
508 $kv{_expires} = $anow + delete $kv{"max-age"};
509 } elsif (exists $kv{expires}) {
510 $snow ||= parse_date ($date) || $anow;
511 $kv{_expires} = $anow + (parse_date (delete $kv{expires}) - $snow);
512 } else {
513 delete $kv{_expires};
514 }
515
516 my $cdom;
517 my $cpath = (delete $kv{path}) || "/";
518
519 if (exists $kv{domain}) {
520 $cdom = delete $kv{domain};
521
522 $cdom =~ s/^\.?/./; # make sure it starts with a "."
523
524 next if $cdom =~ /\.$/;
525
526 # this is not rfc-like and not netscape-like. go figure.
527 my $ndots = $cdom =~ y/.//;
528 next if $ndots < ($cdom =~ /\.[^.][^.]\.[^.][^.]$/ ? 3 : 2);
529 } else {
530 $cdom = $uhost;
531 }
532
533 # store it
534 $jar->{version} = 1;
535 $jar->{$cdom}{$cpath}{$name} = \%kv;
536
537 redo if /\G\s*,/gc;
538 }
539}
540
541# continue to parse $_ for headers and place them into the arg
542sub parse_hdr() {
543 my %hdr;
544
545 # things seen, not parsed:
546 # p3pP="NON CUR OTPi OUR NOR UNI"
547
548 $hdr{lc $1} .= ",$2"
549 while /\G
550 ([^:\000-\037]*):
551 [\011\040]*
552 ((?: [^\012]+ | \012[\011\040] )*)
553 \012
554 /gxc;
555
556 /\G$/
557 or return;
558
559 # remove the "," prefix we added to all headers above
560 substr $_, 0, 1, ""
561 for values %hdr;
562
563 \%hdr
564}
565
566our $qr_nlnl = qr{(?<![^\012])\015?\012};
567
568our $TLS_CTX_LOW = { cache => 1, sslv2 => 1 };
569our $TLS_CTX_HIGH = { cache => 1, verify => 1, verify_peername => "https" };
244 570
245sub http_request($$@) { 571sub http_request($$@) {
246 my $cb = pop; 572 my $cb = pop;
247 my ($method, $url, %arg) = @_; 573 my ($method, $url, %arg) = @_;
248 574
249 my %hdr; 575 my %hdr;
576
577 $arg{tls_ctx} = $TLS_CTX_LOW if $arg{tls_ctx} eq "low" || !exists $arg{tls_ctx};
578 $arg{tls_ctx} = $TLS_CTX_HIGH if $arg{tls_ctx} eq "high";
250 579
251 $method = uc $method; 580 $method = uc $method;
252 581
253 if (my $hdr = $arg{headers}) { 582 if (my $hdr = $arg{headers}) {
254 while (my ($k, $v) = each %$hdr) { 583 while (my ($k, $v) = each %$hdr) {
255 $hdr{lc $k} = $v; 584 $hdr{lc $k} = $v;
256 } 585 }
257 } 586 }
258 587
588 # pseudo headers for all subsequent responses
589 my @pseudo = (URL => $url);
590 push @pseudo, Redirect => delete $arg{Redirect} if exists $arg{Redirect};
591
259 my $recurse = exists $arg{recurse} ? delete $arg{recurse} : $MAX_RECURSE; 592 my $recurse = exists $arg{recurse} ? delete $arg{recurse} : $MAX_RECURSE;
260 593
261 return $cb->(undef, { Status => 599, Reason => "recursion limit reached", URL => $url }) 594 return $cb->(undef, { @pseudo, Status => 599, Reason => "Too many redirections" })
262 if $recurse < 0; 595 if $recurse < 0;
263 596
264 my $proxy = $arg{proxy} || $PROXY; 597 my $proxy = $arg{proxy} || $PROXY;
265 my $timeout = $arg{timeout} || $TIMEOUT; 598 my $timeout = $arg{timeout} || $TIMEOUT;
266 599
267 $hdr{"user-agent"} ||= $USERAGENT;
268
269 my ($uscheme, $uauthority, $upath, $query, $fragment) = 600 my ($uscheme, $uauthority, $upath, $query, $fragment) =
270 $url =~ m|(?:([^:/?#]+):)?(?://([^/?#]*))?([^?#]*)(?:\?([^#]*))?(?:#(.*))?|; 601 $url =~ m|(?:([^:/?#]+):)?(?://([^/?#]*))?([^?#]*)(?:(\?[^#]*))?(?:#(.*))?|;
271 602
272 $uscheme = lc $uscheme; 603 $uscheme = lc $uscheme;
273 604
274 my $uport = $uscheme eq "http" ? 80 605 my $uport = $uscheme eq "http" ? 80
275 : $uscheme eq "https" ? 443 606 : $uscheme eq "https" ? 443
276 : return $cb->(undef, { Status => 599, Reason => "only http and https URL schemes supported", URL => $url }); 607 : return $cb->(undef, { @pseudo, Status => 599, Reason => "Only http and https URL schemes supported" });
277
278 $hdr{referer} ||= "$uscheme://$uauthority$upath"; # leave out fragment and query string, just a heuristic
279 608
280 $uauthority =~ /^(?: .*\@ )? ([^\@:]+) (?: : (\d+) )?$/x 609 $uauthority =~ /^(?: .*\@ )? ([^\@:]+) (?: : (\d+) )?$/x
281 or return $cb->(undef, { Status => 599, Reason => "unparsable URL", URL => $url }); 610 or return $cb->(undef, { @pseudo, Status => 599, Reason => "Unparsable URL" });
282 611
283 my $uhost = $1; 612 my $uhost = $1;
284 $uport = $2 if defined $2; 613 $uport = $2 if defined $2;
285 614
615 $hdr{host} = defined $2 ? "$uhost:$2" : "$uhost"
616 unless exists $hdr{host};
617
286 $uhost =~ s/^\[(.*)\]$/$1/; 618 $uhost =~ s/^\[(.*)\]$/$1/;
287 $upath .= "?$query" if length $query; 619 $upath .= $query if length $query;
288 620
289 $upath =~ s%^/?%/%; 621 $upath =~ s%^/?%/%;
290 622
291 # cookie processing 623 # cookie processing
292 if (my $jar = $arg{cookie_jar}) { 624 if (my $jar = $arg{cookie_jar}) {
293 %$jar = () if $jar->{version} != 1; 625 my $cookies = cookie_jar_extract $jar, $uscheme, $uhost, $upath;
294 626
295 my @cookie;
296
297 while (my ($chost, $v) = each %$jar) {
298 if ($chost =~ /^\./) {
299 next unless $chost eq substr $uhost, -length $chost;
300 } elsif ($chost =~ /\./) {
301 next unless $chost eq $uhost;
302 } else {
303 next;
304 }
305
306 while (my ($cpath, $v) = each %$v) {
307 next unless $cpath eq substr $upath, 0, length $cpath;
308
309 while (my ($k, $v) = each %$v) {
310 next if $uscheme ne "https" && exists $v->{secure};
311 my $value = $v->{value};
312 $value =~ s/([\\"])/\\$1/g;
313 push @cookie, "$k=\"$value\"";
314 }
315 }
316 }
317
318 $hdr{cookie} = join "; ", @cookie 627 $hdr{cookie} = join "; ", @$cookies
319 if @cookie; 628 if @$cookies;
320 } 629 }
321 630
322 my ($rhost, $rport, $rscheme, $rpath); # request host, port, path 631 my ($rhost, $rport, $rscheme, $rpath); # request host, port, path
323 632
324 if ($proxy) { 633 if ($proxy) {
325 ($rpath, $rhost, $rport, $rscheme) = ($url, @$proxy); 634 ($rpath, $rhost, $rport, $rscheme) = ($url, @$proxy);
635
636 $rscheme = "http" unless defined $rscheme;
326 637
327 # don't support https requests over https-proxy transport, 638 # don't support https requests over https-proxy transport,
328 # can't be done with tls as spec'ed, unless you double-encrypt. 639 # can't be done with tls as spec'ed, unless you double-encrypt.
329 $rscheme = "http" if $uscheme eq "https" && $rscheme eq "https"; 640 $rscheme = "http" if $uscheme eq "https" && $rscheme eq "https";
330 } else { 641 } else {
331 ($rhost, $rport, $rscheme, $rpath) = ($uhost, $uport, $uscheme, $upath); 642 ($rhost, $rport, $rscheme, $rpath) = ($uhost, $uport, $uscheme, $upath);
332 } 643 }
333 644
334 $hdr{host} = $uhost; 645 # leave out fragment and query string, just a heuristic
646 $hdr{referer} = "$uscheme://$uauthority$upath" unless exists $hdr{referer};
647 $hdr{"user-agent"} = $USERAGENT unless exists $hdr{"user-agent"};
648
335 $hdr{"content-length"} = length $arg{body}; 649 $hdr{"content-length"} = length $arg{body}
650 if length $arg{body} || $method ne "GET";
651
652 $hdr{connection} = "close TE"; #1.1
653 $hdr{te} = "trailers" unless exists $hdr{te}; #1.1
336 654
337 my %state = (connect_guard => 1); 655 my %state = (connect_guard => 1);
338 656
339 _get_slot $uhost, sub { 657 _get_slot $uhost, sub {
340 $state{slot_guard} = shift; 658 $state{slot_guard} = shift;
341 659
342 return unless $state{connect_guard}; 660 return unless $state{connect_guard};
343 661
344 $state{connect_guard} = AnyEvent::Socket::tcp_connect $rhost, $rport, sub { 662 my $ae_error = 595; # connecting
663
664 my $connect_cb = sub {
345 $state{fh} = shift 665 $state{fh} = shift
666 or do {
667 my $err = "$!";
668 %state = ();
346 or return $cb->(undef, { Status => 599, Reason => "$!", URL => $url }); 669 return $cb->(undef, { @pseudo, Status => $ae_error, Reason => $err });
347 pop; # free memory, save a tree 670 };
348 671
349 return unless delete $state{connect_guard}; 672 return unless delete $state{connect_guard};
350 673
351 # get handle 674 # get handle
352 $state{handle} = new AnyEvent::Handle 675 $state{handle} = new AnyEvent::Handle
353 fh => $state{fh}, 676 fh => $state{fh},
677 peername => $rhost,
678 tls_ctx => $arg{tls_ctx},
679 # these need to be reconfigured on keepalive handles
354 timeout => $timeout; 680 timeout => $timeout,
681 on_error => sub {
682 %state = ();
683 $cb->(undef, { @pseudo, Status => $ae_error, Reason => $_[2] });
684 },
685 on_eof => sub {
686 %state = ();
687 $cb->(undef, { @pseudo, Status => $ae_error, Reason => "Unexpected end-of-file" });
688 },
689 ;
355 690
356 # limit the number of persistent connections 691 # limit the number of persistent connections
357 # keepalive not yet supported 692 # keepalive not yet supported
358 if ($KA_COUNT{$_[1]} < $MAX_PERSISTENT_PER_HOST) { 693# if ($KA_COUNT{$_[1]} < $MAX_PERSISTENT_PER_HOST) {
359 ++$KA_COUNT{$_[1]}; 694# ++$KA_COUNT{$_[1]};
360 $state{handle}{ka_count_guard} = AnyEvent::Util::guard { 695# $state{handle}{ka_count_guard} = AnyEvent::Util::guard {
361 --$KA_COUNT{$_[1]} 696# --$KA_COUNT{$_[1]}
362 }; 697# };
363 $hdr{connection} = "keep-alive"; 698# $hdr{connection} = "keep-alive";
364 } else {
365 delete $hdr{connection};
366 } 699# }
367
368 # (re-)configure handle
369 $state{handle}->on_error (sub {
370 my $errno = "$!";
371 %state = ();
372 $cb->(undef, { Status => 599, Reason => $errno, URL => $url });
373 });
374 $state{handle}->on_eof (sub {
375 %state = ();
376 $cb->(undef, { Status => 599, Reason => "unexpected end-of-file", URL => $url });
377 });
378 700
379 $state{handle}->starttls ("connect") if $rscheme eq "https"; 701 $state{handle}->starttls ("connect") if $rscheme eq "https";
380 702
381 # handle actual, non-tunneled, request 703 # handle actual, non-tunneled, request
382 my $handle_actual_request = sub { 704 my $handle_actual_request = sub {
705 $ae_error = 596; # request phase
706
383 $state{handle}->starttls ("connect") if $uscheme eq "https" && !exists $state{handle}{tls}; 707 $state{handle}->starttls ("connect") if $uscheme eq "https" && !exists $state{handle}{tls};
384 708
385 # send request 709 # send request
386 $state{handle}->push_write ( 710 $state{handle}->push_write (
387 "$method $rpath HTTP/1.0\015\012" 711 "$method $rpath HTTP/1.1\015\012"
388 . (join "", map "\u$_: $hdr{$_}\015\012", keys %hdr) 712 . (join "", map "\u$_: $hdr{$_}\015\012", grep defined $hdr{$_}, keys %hdr)
389 . "\015\012" 713 . "\015\012"
390 . (delete $arg{body}) 714 . (delete $arg{body})
391 ); 715 );
392 716
717 # return if error occured during push_write()
718 return unless %state;
719
393 %hdr = (); # reduce memory usage, save a kitten 720 %hdr = (); # reduce memory usage, save a kitten, also make it possible to re-use
394 721
395 # status line 722 # status line and headers
396 $state{handle}->push_read (line => $qr_nl, sub { 723 $state{read_response} = sub {
397 $_[1] =~ /^HTTP\/([0-9\.]+) \s+ ([0-9]{3}) (?: \s+ ([^\015\012]*) )?/ix
398 or return (%state = (), $cb->(undef, { Status => 599, Reason => "invalid server response ($_[1])", URL => $url }));
399
400 my %hdr = ( # response headers
401 HTTPVersion => ",$1",
402 Status => ",$2",
403 Reason => ",$3",
404 URL => ",$url"
405 );
406
407 # headers, could be optimized a bit
408 $state{handle}->unshift_read (line => $qr_nlnl, sub {
409 for ("$_[1]\012") { 724 for ("$_[1]") {
410 y/\015//d; # weed out any \015, as they show up in the weirdest of places. 725 y/\015//d; # weed out any \015, as they show up in the weirdest of places.
411 726
412 # we support spaces in field names, as lotus domino 727 /^HTTP\/0*([0-9\.]+) \s+ ([0-9]{3}) (?: \s+ ([^\012]*) )? \012/gxci
413 # creates them (actually spaces around seperators 728 or return (%state = (), $cb->(undef, { @pseudo, Status => 599, Reason => "Invalid server response" }));
414 # are strictly allowed in http, they are a security issue).
415 $hdr{lc $1} .= ",$2"
416 while /\G
417 ([^:\000-\037]+):
418 [\011\040]*
419 ((?: [^\012]+ | \012[\011\040] )*)
420 \012
421 /gxc;
422 729
730 # 100 Continue handling
731 # should not happen as we don't send expect: 100-continue,
732 # but we handle it just in case.
733 # since we send the request body regardless, if we get an error
734 # we are out of-sync, which we currently do NOT handle correctly.
735 return $state{handle}->push_read (line => $qr_nlnl, $state{read_response})
736 if $2 eq 100;
737
738 push @pseudo,
739 HTTPVersion => $1,
740 Status => $2,
741 Reason => $3,
423 /\G$/ 742 ;
743
744 my $hdr = parse_hdr
424 or return (%state = (), $cb->(undef, { Status => 599, Reason => "garbled response headers", URL => $url })); 745 or return (%state = (), $cb->(undef, { @pseudo, Status => 599, Reason => "Garbled response headers" }));
746
747 %hdr = (%$hdr, @pseudo);
748 }
749
750 # redirect handling
751 # microsoft and other shitheads don't give a shit for following standards,
752 # try to support some common forms of broken Location headers.
753 if ($hdr{location} !~ /^(?: $ | [^:\/?\#]+ : )/x) {
754 $hdr{location} =~ s/^\.\/+//;
755
756 my $url = "$rscheme://$uhost:$uport";
757
758 unless ($hdr{location} =~ s/^\///) {
759 $url .= $upath;
760 $url =~ s/\/[^\/]*$//;
425 } 761 }
426 762
427 substr $_, 0, 1, "" 763 $hdr{location} = "$url/$hdr{location}";
428 for values %hdr; 764 }
429 765
430 my $finish = sub { 766 my $redirect;
767
768 if ($recurse) {
769 my $status = $hdr{Status};
770
771 # industry standard is to redirect POST as GET for
772 # 301, 302 and 303, in contrast to HTTP/1.0 and 1.1.
773 # also, the UA should ask the user for 301 and 307 and POST,
774 # industry standard seems to be to simply follow.
775 # we go with the industry standard.
776 if ($status == 301 or $status == 302 or $status == 303) {
777 # HTTP/1.1 is unclear on how to mutate the method
778 $method = "GET" unless $method eq "HEAD";
779 $redirect = 1;
780 } elsif ($status == 307) {
781 $redirect = 1;
782 }
783 }
784
785 my $finish = sub { # ($data, $err_status, $err_reason[, $keepalive])
786 my $may_keep_alive = $_[3];
787
431 $state{handle}->destroy; 788 $state{handle}->destroy if $state{handle};
432 %state = (); 789 %state = ();
433 790
791 if (defined $_[1]) {
792 $hdr{OrigStatus} = $hdr{Status}; $hdr{Status} = $_[1];
793 $hdr{OrigReason} = $hdr{Reason}; $hdr{Reason} = $_[2];
794 }
795
434 # set-cookie processing 796 # set-cookie processing
435 if ($arg{cookie_jar}) { 797 if ($arg{cookie_jar}) {
436 for ($hdr{"set-cookie"}) { 798 cookie_jar_set_cookie $arg{cookie_jar}, $hdr{"set-cookie"}, $uhost, $hdr{date};
437 # parse NAME=VALUE 799 }
800
801 if ($redirect && exists $hdr{location}) {
802 # we ignore any errors, as it is very common to receive
803 # Content-Length != 0 but no actual body
804 # we also access %hdr, as $_[1] might be an erro
805 http_request (
806 $method => $hdr{location},
807 %arg,
808 recurse => $recurse - 1,
809 Redirect => [$_[0], \%hdr],
810 $cb);
811 } else {
812 $cb->($_[0], \%hdr);
813 }
814 };
815
816 $ae_error = 597; # body phase
817
818 my $len = $hdr{"content-length"};
819
820 if (!$redirect && $arg{on_header} && !$arg{on_header}(\%hdr)) {
821 $finish->(undef, 598 => "Request cancelled by on_header");
822 } elsif (
823 $hdr{Status} =~ /^(?:1..|204|205|304)$/
824 or $method eq "HEAD"
825 or (defined $len && !$len)
826 ) {
827 # no body
828 $finish->("", undef, undef, 1);
829 } else {
830 # body handling, many different code paths
831 # - no body expected
832 # - want_body_handle
833 # - te chunked
834 # - 2x length known (with or without on_body)
835 # - 2x length not known (with or without on_body)
836 if (!$redirect && $arg{want_body_handle}) {
837 $_[0]->on_eof (undef);
838 $_[0]->on_error (undef);
839 $_[0]->on_read (undef);
840
841 $finish->(delete $state{handle});
842
843 } elsif ($hdr{"transfer-encoding"} =~ /\bchunked\b/i) {
844 my $cl = 0;
845 my $body = undef;
846 my $on_body = $arg{on_body} || sub { $body .= shift; 1 };
847
848 my $read_chunk; $read_chunk = sub {
849 $_[1] =~ /^([0-9a-fA-F]+)/
850 or $finish->(undef, $ae_error => "Garbled chunked transfer encoding");
851
852 my $len = hex $1;
853
854 if ($len) {
855 $cl += $len;
856
857 $_[0]->push_read (chunk => $len, sub {
858 $on_body->($_[1], \%hdr)
859 or return $finish->(undef, 598 => "Request cancelled by on_body");
860
861 $_[0]->push_read (line => sub {
862 length $_[1]
863 and return $finish->(undef, $ae_error => "Garbled chunked transfer encoding");
864 $_[0]->push_read (line => $read_chunk);
865 });
438 my @kv; 866 });
867 } else {
868 $hdr{"content-length"} ||= $cl;
439 869
440 while (/\G\s* ([^=;,[:space:]]+) \s*=\s* (?: "((?:[^\\"]+|\\.)*)" | ([^=;,[:space:]]*) )/gcxs) { 870 $_[0]->push_read (line => $qr_nlnl, sub {
441 my $name = $1; 871 if (length $_[1]) {
442 my $value = $3;
443
444 unless ($value) { 872 for ("$_[1]") {
873 y/\015//d; # weed out any \015, as they show up in the weirdest of places.
874
875 my $hdr = parse_hdr
876 or return $finish->(undef, $ae_error => "Garbled response trailers");
877
878 %hdr = (%hdr, %$hdr);
445 $value = $2; 879 }
446 $value =~ s/\\(.)/$1/gs;
447 } 880 }
448 881
449 push @kv, $name => $value; 882 $finish->($body, undef, undef, 1);
450
451 last unless /\G\s*;/gc;
452 } 883 });
453
454 last unless @kv;
455
456 my $name = shift @kv;
457 my %kv = (value => shift @kv, @kv);
458
459 my $cdom;
460 my $cpath = (delete $kv{path}) || "/";
461
462 if (exists $kv{domain}) {
463 $cdom = delete $kv{domain};
464
465 $cdom =~ s/^\.?/./; # make sure it starts with a "."
466
467 next if $cdom =~ /\.$/;
468
469 # this is not rfc-like and not netscape-like. go figure.
470 my $ndots = $cdom =~ y/.//;
471 next if $ndots < ($cdom =~ /\.[^.][^.]\.[^.][^.]$/ ? 3 : 2);
472 } else {
473 $cdom = $uhost;
474 }
475
476 # store it
477 $arg{cookie_jar}{version} = 1;
478 $arg{cookie_jar}{$cdom}{$cpath}{$name} = \%kv;
479
480 redo if /\G\s*,/gc;
481 } 884 }
482 } 885 };
483 886
484 # microsoft and other shitheads don't give a shit for following standards, 887 $_[0]->push_read (line => $read_chunk);
485 # try to support some common forms of broken Location headers.
486 if ($_[1]{location} !~ /^(?: $ | [^:\/?\#]+ : )/x) {
487 $_[1]{location} =~ s/^\.\/+//;
488 888
489 my $url = "$rscheme://$uhost:$uport"; 889 } elsif ($arg{on_body}) {
490
491 unless ($_[1]{location} =~ s/^\///) {
492 $url .= $upath;
493 $url =~ s/\/[^\/]*$//;
494 }
495
496 $_[1]{location} = "$url/$_[1]{location}";
497 }
498
499 if ($_[1]{Status} =~ /^30[12]$/ && $recurse && $method ne "POST") {
500 # apparently, mozilla et al. just change POST to GET here
501 # more research is needed before we do the same
502 http_request ($method, $_[1]{location}, %arg, recurse => $recurse - 1, $cb);
503 } elsif ($_[1]{Status} == 303 && $recurse) {
504 # even http/1.1 is unclear on how to mutate the method
505 $method = "GET" unless $method eq "HEAD";
506 http_request ($method => $_[1]{location}, %arg, recurse => $recurse - 1, $cb);
507 } elsif ($_[1]{Status} == 307 && $recurse && $method =~ /^(?:GET|HEAD)$/) {
508 http_request ($method => $_[1]{location}, %arg, recurse => $recurse - 1, $cb);
509 } else { 890 if ($len) {
510 $cb->($_[0], $_[1]); 891 $_[0]->on_read (sub {
511 } 892 $len -= length $_[0]{rbuf};
512 };
513 893
514 if ($hdr{Status} =~ /^(?:1..|204|304)$/ or $method eq "HEAD") { 894 $arg{on_body}(delete $_[0]{rbuf}, \%hdr)
515 $finish->(undef, \%hdr); 895 or return $finish->(undef, 598 => "Request cancelled by on_body");
516 } else { 896
517 if (exists $hdr{"content-length"}) {
518 $_[0]->unshift_read (chunk => $hdr{"content-length"}, sub {
519 # could cache persistent connection now
520 if ($hdr{connection} =~ /\bkeep-alive\b/i) {
521 # but we don't, due to misdesigns, this is annoyingly complex
522 }; 897 $len > 0
523 898 or $finish->("", undef, undef, 1);
524 $finish->($_[1], \%hdr);
525 }); 899 });
526 } else { 900 } else {
527 # too bad, need to read until we get an error or EOF, 901 $_[0]->on_eof (sub {
528 # no way to detect winged data. 902 $finish->("");
903 });
904 $_[0]->on_read (sub {
905 $arg{on_body}(delete $_[0]{rbuf}, \%hdr)
906 or $finish->(undef, 598 => "Request cancelled by on_body");
907 });
908 }
909 } else {
910 $_[0]->on_eof (undef);
911
912 if ($len) {
913 $_[0]->on_read (sub {
914 $finish->((substr delete $_[0]{rbuf}, 0, $len, ""), undef, undef, 1)
915 if $len <= length $_[0]{rbuf};
916 });
917 } else {
529 $_[0]->on_error (sub { 918 $_[0]->on_error (sub {
530 # delete ought to be more efficient, as we would have to make 919 ($! == Errno::EPIPE || !$!)
531 # a copy otherwise as $_[0] gets destroyed.
532 $finish->(delete $_[0]{rbuf}, \%hdr); 920 ? $finish->(delete $_[0]{rbuf})
921 : $finish->(undef, $ae_error => $_[2]);
533 }); 922 });
534 $_[0]->on_eof (undef);
535 $_[0]->on_read (sub { }); 923 $_[0]->on_read (sub { });
536 } 924 }
537 } 925 }
538 }); 926 }
539 }); 927 };
928
929 $state{handle}->push_read (line => $qr_nlnl, $state{read_response});
540 }; 930 };
541 931
542 # now handle proxy-CONNECT method 932 # now handle proxy-CONNECT method
543 if ($proxy && $uscheme eq "https") { 933 if ($proxy && $uscheme eq "https") {
544 # oh dear, we have to wrap it into a connect request 934 # oh dear, we have to wrap it into a connect request
545 935
546 # maybe re-use $uauthority with patched port? 936 # maybe re-use $uauthority with patched port?
547 $state{handle}->push_write ("CONNECT $uhost:$uport HTTP/1.0\015\012Host: $uhost\015\012\015\012"); 937 $state{handle}->push_write ("CONNECT $uhost:$uport HTTP/1.0\015\012Host: $uhost\015\012\015\012");
548 $state{handle}->push_read (line => $qr_nlnl, sub { 938 $state{handle}->push_read (line => $qr_nlnl, sub {
549 $_[1] =~ /^HTTP\/([0-9\.]+) \s+ ([0-9]{3}) (?: \s+ ([^\015\012]*) )?/ix 939 $_[1] =~ /^HTTP\/([0-9\.]+) \s+ ([0-9]{3}) (?: \s+ ([^\015\012]*) )?/ix
550 or return (%state = (), $cb->(undef, { Status => 599, Reason => "invalid proxy connect response ($_[1])", URL => $url })); 940 or return (%state = (), $cb->(undef, { @pseudo, Status => 599, Reason => "Invalid proxy connect response ($_[1])" }));
551 941
552 if ($2 == 200) { 942 if ($2 == 200) {
553 $rpath = $upath; 943 $rpath = $upath;
554 &$handle_actual_request; 944 &$handle_actual_request;
555 } else { 945 } else {
556 %state = (); 946 %state = ();
557 $cb->(undef, { Status => $2, Reason => $3, URL => $url }); 947 $cb->(undef, { @pseudo, Status => $2, Reason => $3 });
558 } 948 }
559 }); 949 });
560 } else { 950 } else {
561 &$handle_actual_request; 951 &$handle_actual_request;
562 } 952 }
563
564 }, sub {
565 $timeout
566 }; 953 };
954
955 my $tcp_connect = $arg{tcp_connect}
956 || do { require AnyEvent::Socket; \&AnyEvent::Socket::tcp_connect };
957
958 $state{connect_guard} = $tcp_connect->($rhost, $rport, $connect_cb, $arg{on_prepare} || sub { $timeout });
959
567 }; 960 };
568 961
569 defined wantarray && AnyEvent::Util::guard { %state = () } 962 defined wantarray && AnyEvent::Util::guard { %state = () }
570} 963}
571 964
585 &http_request 978 &http_request
586} 979}
587 980
588=back 981=back
589 982
983=head2 DNS CACHING
984
985AnyEvent::HTTP uses the AnyEvent::Socket::tcp_connect function for
986the actual connection, which in turn uses AnyEvent::DNS to resolve
987hostnames. The latter is a simple stub resolver and does no caching
988on its own. If you want DNS caching, you currently have to provide
989your own default resolver (by storing a suitable resolver object in
990C<$AnyEvent::DNS::RESOLVER>).
991
590=head2 GLOBAL FUNCTIONS AND VARIABLES 992=head2 GLOBAL FUNCTIONS AND VARIABLES
591 993
592=over 4 994=over 4
593 995
594=item AnyEvent::HTTP::set_proxy "proxy-url" 996=item AnyEvent::HTTP::set_proxy "proxy-url"
595 997
596Sets the default proxy server to use. The proxy-url must begin with a 998Sets the default proxy server to use. The proxy-url must begin with a
597string of the form C<http://host:port> (optionally C<https:...>). 999string of the form C<http://host:port> (optionally C<https:...>), croaks
1000otherwise.
1001
1002To clear an already-set proxy, use C<undef>.
1003
1004=item AnyEvent::HTTP::cookie_jar_expire $jar[, $session_end]
1005
1006Remove all cookies from the cookie jar that have been expired. If
1007C<$session_end> is given and true, then additionally remove all session
1008cookies.
1009
1010You should call this function (with a true C<$session_end>) before you
1011save cookies to disk, and you should call this function after loading them
1012again. If you have a long-running program you can additonally call this
1013function from time to time.
1014
1015A cookie jar is initially an empty hash-reference that is managed by this
1016module. It's format is subject to change, but currently it is like this:
1017
1018The key C<version> has to contain C<1>, otherwise the hash gets
1019emptied. All other keys are hostnames or IP addresses pointing to
1020hash-references. The key for these inner hash references is the
1021server path for which this cookie is meant, and the values are again
1022hash-references. The keys of those hash-references is the cookie name, and
1023the value, you guessed it, is another hash-reference, this time with the
1024key-value pairs from the cookie, except for C<expires> and C<max-age>,
1025which have been replaced by a C<_expires> key that contains the cookie
1026expiry timestamp.
1027
1028Here is an example of a cookie jar with a single cookie, so you have a
1029chance of understanding the above paragraph:
1030
1031 {
1032 version => 1,
1033 "10.0.0.1" => {
1034 "/" => {
1035 "mythweb_id" => {
1036 _expires => 1293917923,
1037 value => "ooRung9dThee3ooyXooM1Ohm",
1038 },
1039 },
1040 },
1041 }
1042
1043=item $date = AnyEvent::HTTP::format_date $timestamp
1044
1045Takes a POSIX timestamp (seconds since the epoch) and formats it as a HTTP
1046Date (RFC 2616).
1047
1048=item $timestamp = AnyEvent::HTTP::parse_date $date
1049
1050Takes a HTTP Date (RFC 2616) or a Cookie date (netscape cookie spec) or a
1051bunch of minor variations of those, and returns the corresponding POSIX
1052timestamp, or C<undef> if the date cannot be parsed.
598 1053
599=item $AnyEvent::HTTP::MAX_RECURSE 1054=item $AnyEvent::HTTP::MAX_RECURSE
600 1055
601The default value for the C<recurse> request parameter (default: C<10>). 1056The default value for the C<recurse> request parameter (default: C<10>).
602 1057
603=item $AnyEvent::HTTP::USERAGENT 1058=item $AnyEvent::HTTP::USERAGENT
604 1059
605The default value for the C<User-Agent> header (the default is 1060The default value for the C<User-Agent> header (the default is
606C<Mozilla/5.0 (compatible; AnyEvent::HTTP/$VERSION; +http://software.schmorp.de/pkg/AnyEvent)>). 1061C<Mozilla/5.0 (compatible; U; AnyEvent-HTTP/$VERSION; +http://software.schmorp.de/pkg/AnyEvent)>).
607 1062
608=item $AnyEvent::HTTP::MAX_PERSISTENT 1063=item $AnyEvent::HTTP::MAX_PER_HOST
609 1064
610The maximum number of persistent connections to keep open (default: 8). 1065The maximum number of concurrent connections to the same host (identified
1066by the hostname). If the limit is exceeded, then the additional requests
1067are queued until previous connections are closed.
611 1068
612Not implemented currently. 1069The default value for this is C<4>, and it is highly advisable to not
613 1070increase it.
614=item $AnyEvent::HTTP::PERSISTENT_TIMEOUT
615
616The maximum time to cache a persistent connection, in seconds (default: 2).
617
618Not implemented currently.
619 1071
620=item $AnyEvent::HTTP::ACTIVE 1072=item $AnyEvent::HTTP::ACTIVE
621 1073
622The number of active connections. This is not the number of currently 1074The number of active connections. This is not the number of currently
623running requests, but the number of currently open and non-idle TCP 1075running requests, but the number of currently open and non-idle TCP
625 1077
626=back 1078=back
627 1079
628=cut 1080=cut
629 1081
1082our @month = qw(Jan Feb Mar Apr May Jun Jul Aug Sep Oct Nov Dec);
1083our @weekday = qw(Sun Mon Tue Wed Thu Fri Sat);
1084
1085sub format_date($) {
1086 my ($time) = @_;
1087
1088 # RFC 822/1123 format
1089 my ($S, $M, $H, $mday, $mon, $year, $wday, $yday, undef) = gmtime $time;
1090
1091 sprintf "%s, %02d %s %04d %02d:%02d:%02d GMT",
1092 $weekday[$wday], $mday, $month[$mon], $year + 1900,
1093 $H, $M, $S;
1094}
1095
1096sub parse_date($) {
1097 my ($date) = @_;
1098
1099 my ($d, $m, $y, $H, $M, $S);
1100
1101 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$/) {
1102 # RFC 822/1123, required by RFC 2616 (with " ")
1103 # cookie dates (with "-")
1104
1105 ($d, $m, $y, $H, $M, $S) = ($1, $2, $3, $4, $5, $6);
1106
1107 } 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$/) {
1108 # RFC 850
1109 ($d, $m, $y, $H, $M, $S) = ($1, $2, $3 < 69 ? $3 + 2000 : $3 + 1900, $4, $5, $6);
1110
1111 } 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])$/) {
1112 # ISO C's asctime
1113 ($d, $m, $y, $H, $M, $S) = ($2, $1, $6, $3, $4, $5);
1114 }
1115 # other formats fail in the loop below
1116
1117 for (0..11) {
1118 if ($m eq $month[$_]) {
1119 require Time::Local;
1120 return Time::Local::timegm ($S, $M, $H, $d, $_, $y);
1121 }
1122 }
1123
1124 undef
1125}
1126
630sub set_proxy($) { 1127sub set_proxy($) {
1128 if (length $_[0]) {
631 $PROXY = [$2, $3 || 3128, $1] if $_[0] =~ m%^(https?):// ([^:/]+) (?: : (\d*) )?%ix; 1129 $_[0] =~ m%^(https?):// ([^:/]+) (?: : (\d*) )?%ix
1130 or Carp::croak "$_[0]: invalid proxy URL";
1131 $PROXY = [$2, $3 || 3128, $1]
1132 } else {
1133 undef $PROXY;
1134 }
632} 1135}
633 1136
634# initialise proxy from environment 1137# initialise proxy from environment
1138eval {
635set_proxy $ENV{http_proxy}; 1139 set_proxy $ENV{http_proxy};
1140};
1141
1142=head2 SOCKS PROXIES
1143
1144Socks proxies are not directly supported by AnyEvent::HTTP. You can
1145compile your perl to support socks, or use an external program such as
1146F<socksify> (dante) or F<tsocks> to make your program use a socks proxy
1147transparently.
1148
1149Alternatively, for AnyEvent::HTTP only, you can use your own
1150C<tcp_connect> function that does the proxy handshake - here is an example
1151that works with socks4a proxies:
1152
1153 use Errno;
1154 use AnyEvent::Util;
1155 use AnyEvent::Socket;
1156 use AnyEvent::Handle;
1157
1158 # host, port and username of/for your socks4a proxy
1159 my $socks_host = "10.0.0.23";
1160 my $socks_port = 9050;
1161 my $socks_user = "";
1162
1163 sub socks4a_connect {
1164 my ($host, $port, $connect_cb, $prepare_cb) = @_;
1165
1166 my $hdl = new AnyEvent::Handle
1167 connect => [$socks_host, $socks_port],
1168 on_prepare => sub { $prepare_cb->($_[0]{fh}) },
1169 on_error => sub { $connect_cb->() },
1170 ;
1171
1172 $hdl->push_write (pack "CCnNZ*Z*", 4, 1, $port, 1, $socks_user, $host);
1173
1174 $hdl->push_read (chunk => 8, sub {
1175 my ($hdl, $chunk) = @_;
1176 my ($status, $port, $ipn) = unpack "xCna4", $chunk;
1177
1178 if ($status == 0x5a) {
1179 $connect_cb->($hdl->{fh}, (format_address $ipn) . ":$port");
1180 } else {
1181 $! = Errno::ENXIO; $connect_cb->();
1182 }
1183 });
1184
1185 $hdl
1186 }
1187
1188Use C<socks4a_connect> instead of C<tcp_connect> when doing C<http_request>s,
1189possibly after switching off other proxy types:
1190
1191 AnyEvent::HTTP::set_proxy undef; # usually you do not want other proxies
1192
1193 http_get 'http://www.google.com', tcp_connect => \&socks4a_connect, sub {
1194 my ($data, $headers) = @_;
1195 ...
1196 };
636 1197
637=head1 SEE ALSO 1198=head1 SEE ALSO
638 1199
639L<AnyEvent>. 1200L<AnyEvent>.
640 1201

Diff Legend

Removed lines
+ Added lines
< Changed lines
> Changed lines