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.44 by root, Tue Jul 7 00:15:32 2009 UTC vs.
Revision 1.88 by root, Sun Jan 2 20:57:03 2011 UTC

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

Diff Legend

Removed lines
+ Added lines
< Changed lines
> Changed lines