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.41 by root, Sun Jul 5 23:50:59 2009 UTC vs.
Revision 1.81 by root, Sun Jan 2 01:20:17 2011 UTC

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

Diff Legend

Removed lines
+ Added lines
< Changed lines
> Changed lines