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

Diff Legend

Removed lines
+ Added lines
< Changed lines
> Changed lines