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.52 by root, Sat Sep 26 10:13:12 2009 UTC vs.
Revision 1.91 by root, Mon Jan 3 01:03:29 2011 UTC

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

Diff Legend

Removed lines
+ Added lines
< Changed lines
> Changed lines