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

Diff Legend

Removed lines
+ Added lines
< Changed lines
> Changed lines