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.53 by root, Sat Dec 5 15:37:07 2009 UTC vs.
Revision 1.77 by root, Sat Jan 1 19:13:41 2011 UTC

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

Diff Legend

Removed lines
+ Added lines
< Changed lines
> Changed lines