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

Diff Legend

Removed lines
+ Added lines
< Changed lines
> Changed lines