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.2 by root, Wed Jun 4 11:37:41 2008 UTC vs.
Revision 1.82 by root, Sun Jan 2 04:50:40 2011 UTC

3AnyEvent::HTTP - simple but non-blocking HTTP/HTTPS client 3AnyEvent::HTTP - simple but non-blocking HTTP/HTTPS client
4 4
5=head1 SYNOPSIS 5=head1 SYNOPSIS
6 6
7 use AnyEvent::HTTP; 7 use AnyEvent::HTTP;
8
9 http_get "http://www.nethype.de/", sub { print $_[1] };
10
11 # ... do something else here
8 12
9=head1 DESCRIPTION 13=head1 DESCRIPTION
10 14
11This module is an L<AnyEvent> user, you need to make sure that you use and 15This module is an L<AnyEvent> user, you need to make sure that you use and
12run a supported event loop. 16run a supported event loop.
13 17
18This module implements a simple, stateless and non-blocking HTTP
19client. It supports GET, POST and other request methods, cookies and more,
20all on a very low level. It can follow redirects supports proxies and
21automatically limits the number of connections to the values specified in
22the RFC.
23
24It should generally be a "good client" that is enough for most HTTP
25tasks. Simple tasks should be simple, but complex tasks should still be
26possible as the user retains control over request and response headers.
27
28The caller is responsible for authentication management, cookies (if
29the simplistic implementation in this module doesn't suffice), referer
30and other high-level protocol details for which this module offers only
31limited support.
32
14=head2 METHODS 33=head2 METHODS
15 34
16=over 4 35=over 4
17 36
18=cut 37=cut
20package AnyEvent::HTTP; 39package AnyEvent::HTTP;
21 40
22use strict; 41use strict;
23no warnings; 42no warnings;
24 43
25use Carp; 44use Errno ();
26 45
27use AnyEvent (); 46use AnyEvent 5.0 ();
28use AnyEvent::Util (); 47use AnyEvent::Util ();
29use AnyEvent::Socket ();
30use AnyEvent::Handle (); 48use AnyEvent::Handle ();
31 49
32use base Exporter::; 50use base Exporter::;
33 51
34our $VERSION = '1.0'; 52our $VERSION = '1.5';
35 53
36our @EXPORT = qw(http_get http_request); 54our @EXPORT = qw(http_get http_post http_head http_request);
37 55
38our $USERAGENT = "Mozilla/5.0 (compatible; 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)";
39our $MAX_REDIRECTS = 10; 57our $MAX_RECURSE = 10;
40our $MAX_PERSISTENT = 8; 58our $MAX_PERSISTENT = 8;
41our $PERSISTENT_TIMEOUT = 2; 59our $PERSISTENT_TIMEOUT = 2;
42our $TIMEOUT = 300; 60our $TIMEOUT = 300;
43 61
44# changing these is evil 62# changing these is evil
45our $MAX_PERSISTENT_PER_HOST = 2; 63our $MAX_PERSISTENT_PER_HOST = 0;
46our $MAX_PER_HOST = 4; # not respected yet :( 64our $MAX_PER_HOST = 4;
47 65
48our $PROXY; 66our $PROXY;
67our $ACTIVE = 0;
49 68
50my %KA_COUNT; # number of open keep-alive connections per host 69my %KA_COUNT; # number of open keep-alive connections per host
70my %CO_SLOT; # number of open connections, and wait queue, per host
51 71
52=item http_get $url, key => value..., $cb->($data, $headers) 72=item http_get $url, key => value..., $cb->($data, $headers)
53 73
54Executes an HTTP-GET request. See the http_request function for details on 74Executes an HTTP-GET request. See the http_request function for details on
55additional parameters. 75additional parameters and the return value.
76
77=item http_head $url, key => value..., $cb->($data, $headers)
78
79Executes an HTTP-HEAD request. See the http_request function for details
80on additional parameters and the return value.
81
82=item http_post $url, $body, key => value..., $cb->($data, $headers)
83
84Executes an HTTP-POST request with a request body of C<$body>. See the
85http_request function for details on additional parameters and the return
86value.
56 87
57=item http_request $method => $url, key => value..., $cb->($data, $headers) 88=item http_request $method => $url, key => value..., $cb->($data, $headers)
58 89
59Executes a HTTP request of type C<$method> (e.g. C<GET>, C<POST>). The URL 90Executes a HTTP request of type C<$method> (e.g. C<GET>, C<POST>). The URL
60must be an absolute http or https URL. 91must be an absolute http or https URL.
61 92
93When called in void context, nothing is returned. In other contexts,
94C<http_request> returns a "cancellation guard" - you have to keep the
95object at least alive until the callback get called. If the object gets
96destroyed before the callback is called, the request will be cancelled.
97
62The callback will be called with the response data as first argument 98The callback will be called with the response body data as first argument
63(or C<undef> if it wasn't available due to errors), and a hash-ref with 99(or C<undef> if an error occured), and a hash-ref with response headers
64response headers as second argument. 100(and trailers) as second argument.
65 101
66All the headers in that has are lowercased. In addition to the response 102All the headers in that hash are lowercased. In addition to the response
67headers, the three "pseudo-headers" C<HTTPVersion>, C<Status> and 103headers, the "pseudo-headers" (uppercase to avoid clashing with possible
68C<Reason> contain the three parts of the HTTP Status-Line of the same 104response headers) C<HTTPVersion>, C<Status> and C<Reason> contain the
69name. 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
110The pseudo-header C<URL> contains the actual URL (which can differ from
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.
122
123If the server sends a header multiple times, then their contents will be
124joined together with a comma (C<,>), as per the HTTP spec.
70 125
71If 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,
72then C<$data> will be C<undef>, C<< $headers->{Status} >> will be C<599> 127then C<$data> will be C<undef>, C<< $headers->{Status} >> will be
73and the C<Reason> pseudo-header will contain an error message. 128C<590>-C<599> and the C<Reason> pseudo-header will contain an error
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
144
145A typical callback might look like this:
146
147 sub {
148 my ($body, $hdr) = @_;
149
150 if ($hdr->{Status} =~ /^2/) {
151 ... everything should be ok
152 } else {
153 print "error, $hdr->{Status} $hdr->{Reason}\n";
154 }
155 }
74 156
75Additional parameters are key-value pairs, and are fully optional. They 157Additional parameters are key-value pairs, and are fully optional. They
76include: 158include:
77 159
78=over 4 160=over 4
79 161
80=item recurse => $boolean (default: true) 162=item recurse => $count (default: $MAX_RECURSE)
81 163
82Whether to recurse requests or not, e.g. on redirects, authentication 164Whether to recurse requests or not, e.g. on redirects, authentication
83retries and so on. 165retries and so on, and how often to do so.
84 166
85=item headers => hashref 167=item headers => hashref
86 168
87The request headers to use. 169The request headers to use. Currently, C<http_request> may provide its own
170C<Host:>, C<Content-Length:>, C<Connection:> and C<Cookie:> headers and
171will provide defaults at least for C<TE:>, C<Referer:> and C<User-Agent:>
172(this can be suppressed by using C<undef> for these headers in which case
173they won't be sent at all).
88 174
89=item timeout => $seconds 175=item timeout => $seconds
90 176
91The 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
92the timeout, as will read or write activity. Default timeout is 5 minutes. 178the timeout, as will read or write activity, i.e. this is not an overall
179timeout.
180
181Default timeout is 5 minutes.
93 182
94=item proxy => [$host, $port[, $scheme]] or undef 183=item proxy => [$host, $port[, $scheme]] or undef
95 184
96Use the given http proxy for all requests. If not specified, then the 185Use the given http proxy for all requests. If not specified, then the
97default proxy (as specified by C<$ENV{http_proxy}>) is used. 186default proxy (as specified by C<$ENV{http_proxy}>) is used.
98 187
99C<$scheme> must be either missing or C<http> for HTTP, or C<https> for 188C<$scheme> must be either missing, C<http> for HTTP or C<https> for
100HTTPS. 189HTTPS.
101 190
191=item body => $string
192
193The request body, usually empty. Will be sent as-is (future versions of
194this module might offer more options).
195
196=item cookie_jar => $hash_ref
197
198Passing this parameter enables (simplified) cookie-processing, loosely
199based on the original netscape specification.
200
201The C<$hash_ref> must be an (initially empty) hash reference which
202will get updated automatically. It is possible to save the cookie jar
203to persistent storage with something like JSON or Storable - see the
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.
207
208Note that this cookie implementation is not meant to be complete. If
209you want complete cookie management you have to do that on your
210own. C<cookie_jar> is meant as a quick fix to get most cookie-using sites
211working. Cookies are a privacy disaster, do not use them unless required
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.
217
218=item tls_ctx => $scheme | $tls_ctx
219
220Specifies the AnyEvent::TLS context to be used for https connections. This
221parameter follows the same rules as the C<tls_ctx> parameter to
222L<AnyEvent::Handle>, but additionally, the two strings C<low> or
223C<high> can be specified, which give you a predefined low-security (no
224verification, highest compatibility) and high-security (CA and common-name
225verification) TLS context.
226
227The default for this option is C<low>, which could be interpreted as "give
228me the page, no matter what".
229
230=item on_prepare => $callback->($fh)
231
232In rare cases you need to "tune" the socket before it is used to
233connect (for exmaple, to bind it on a given IP address). This parameter
234overrides the prepare callback passed to C<AnyEvent::Socket::tcp_connect>
235and behaves exactly the same way (e.g. it has to provide a
236timeout). See the description for the C<$prepare_cb> argument of
237C<AnyEvent::Socket::tcp_connect> for details.
238
239=item tcp_connect => $callback->($host, $service, $connect_cb, $prepare_cb)
240
241In even rarer cases you want total control over how AnyEvent::HTTP
242establishes connections. Normally it uses L<AnyEvent::Socket::tcp_connect>
243to do this, but you can provide your own C<tcp_connect> function -
244obviously, it has to follow the same calling conventions, except that it
245may always return a connection guard object.
246
247There are probably lots of weird uses for this function, starting from
248tracing the hosts C<http_request> actually tries to connect, to (inexact
249but fast) host => IP address caching or even socks protocol support.
250
251=item on_header => $callback->($headers)
252
253When specified, this callback will be called with the header hash as soon
254as headers have been successfully received from the remote server (not on
255locally-generated errors).
256
257It has to return either true (in which case AnyEvent::HTTP will continue),
258or false, in which case AnyEvent::HTTP will cancel the download (and call
259the finish callback with an error code of C<598>).
260
261This callback is useful, among other things, to quickly reject unwanted
262content, which, if it is supposed to be rare, can be faster than first
263doing a C<HEAD> request.
264
265The downside is that cancelling the request makes it impossible to re-use
266the connection. Also, the C<on_header> callback will not receive any
267trailer (headers sent after the response body).
268
269Example: cancel the request unless the content-type is "text/html".
270
271 on_header => sub {
272 $_[0]{"content-type"} =~ /^text\/html\s*(?:;|$)/
273 },
274
275=item on_body => $callback->($partial_body, $headers)
276
277When specified, all body data will be passed to this callback instead of
278to the completion callback. The completion callback will get the empty
279string instead of the body data.
280
281It has to return either true (in which case AnyEvent::HTTP will continue),
282or false, in which case AnyEvent::HTTP will cancel the download (and call
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.
287
288This callback is useful when the data is too large to be held in memory
289(so the callback writes it to a file) or when only some information should
290be extracted, or when the body should be processed incrementally.
291
292It is usually preferred over doing your own body handling via
293C<want_body_handle>, but in case of streaming APIs, where HTTP is
294only used to create a connection, C<want_body_handle> is the better
295alternative, as it allows you to install your own event handler, reducing
296resource usage.
297
298=item want_body_handle => $enable
299
300When enabled (default is disabled), the behaviour of AnyEvent::HTTP
301changes considerably: after parsing the headers, and instead of
302downloading the body (if any), the completion callback will be
303called. Instead of the C<$body> argument containing the body data, the
304callback will receive the L<AnyEvent::Handle> object associated with the
305connection. In error cases, C<undef> will be passed. When there is no body
306(e.g. status C<304>), the empty string will be passed.
307
308The handle object might or might not be in TLS mode, might be connected to
309a proxy, be a persistent connection etc., and configured in unspecified
310ways. The user is responsible for this handle (it will not be used by this
311module anymore).
312
313This is useful with some push-type services, where, after the initial
314headers, an interactive protocol is used (typical example would be the
315push-style twitter API which starts a JSON/XML stream).
316
317If you think you need this, first have a look at C<on_body>, to see if
318that doesn't solve your problem in a better way.
319
102=back 320=back
103 321
104=back 322Example: do a simple HTTP GET request for http://www.nethype.de/ and print
323the response body.
324
325 http_request GET => "http://www.nethype.de/", sub {
326 my ($body, $hdr) = @_;
327 print "$body\n";
328 };
329
330Example: do a HTTP HEAD request on https://www.google.com/, use a
331timeout of 30 seconds.
332
333 http_request
334 GET => "https://www.google.com",
335 timeout => 30,
336 sub {
337 my ($body, $hdr) = @_;
338 use Data::Dumper;
339 print Dumper $hdr;
340 }
341 ;
342
343Example: do another simple HTTP GET request, but immediately try to
344cancel it.
345
346 my $request = http_request GET => "http://www.nethype.de/", sub {
347 my ($body, $hdr) = @_;
348 print "$body\n";
349 };
350
351 undef $request;
105 352
106=cut 353=cut
107 354
355sub _slot_schedule;
356sub _slot_schedule($) {
357 my $host = shift;
358
359 while ($CO_SLOT{$host}[0] < $MAX_PER_HOST) {
360 if (my $cb = shift @{ $CO_SLOT{$host}[1] }) {
361 # somebody wants that slot
362 ++$CO_SLOT{$host}[0];
363 ++$ACTIVE;
364
365 $cb->(AnyEvent::Util::guard {
366 --$ACTIVE;
367 --$CO_SLOT{$host}[0];
368 _slot_schedule $host;
369 });
370 } else {
371 # nobody wants the slot, maybe we can forget about it
372 delete $CO_SLOT{$host} unless $CO_SLOT{$host}[0];
373 last;
374 }
375 }
376}
377
378# wait for a free slot on host, call callback
379sub _get_slot($$) {
380 push @{ $CO_SLOT{$_[0]}[1] }, $_[1];
381
382 _slot_schedule $_[0];
383}
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
566our $qr_nlnl = qr{(?<![^\012])\015?\012};
567
568our $TLS_CTX_LOW = { cache => 1, sslv2 => 1 };
569our $TLS_CTX_HIGH = { cache => 1, verify => 1, verify_peername => "https" };
570
108sub http_request($$$;@) { 571sub http_request($$@) {
109 my $cb = pop; 572 my $cb = pop;
110 my ($method, $url, %arg) = @_; 573 my ($method, $url, %arg) = @_;
111 574
112 my %hdr; 575 my %hdr;
113 576
577 $arg{tls_ctx} = $TLS_CTX_LOW if $arg{tls_ctx} eq "low" || !exists $arg{tls_ctx};
578 $arg{tls_ctx} = $TLS_CTX_HIGH if $arg{tls_ctx} eq "high";
579
580 $method = uc $method;
581
114 if (my $hdr = delete $arg{headers}) { 582 if (my $hdr = $arg{headers}) {
115 while (my ($k, $v) = each %$hdr) { 583 while (my ($k, $v) = each %$hdr) {
116 $hdr{lc $k} = $v; 584 $hdr{lc $k} = $v;
117 } 585 }
118 } 586 }
119 587
588 # pseudo headers for all subsequent responses
589 my @pseudo = (URL => $url);
590 push @pseudo, Redirect => delete $arg{Redirect} if exists $arg{Redirect};
591
592 my $recurse = exists $arg{recurse} ? delete $arg{recurse} : $MAX_RECURSE;
593
594 return $cb->(undef, { @pseudo, Status => 599, Reason => "Too many redirections" })
595 if $recurse < 0;
596
120 my $proxy = $arg{proxy} || $PROXY; 597 my $proxy = $arg{proxy} || $PROXY;
121 my $timeout = $arg{timeout} || $TIMEOUT; 598 my $timeout = $arg{timeout} || $TIMEOUT;
122 599
123 $hdr{"user-agent"} ||= $USERAGENT; 600 my ($uscheme, $uauthority, $upath, $query, $fragment) =
601 $url =~ m|(?:([^:/?#]+):)?(?://([^/?#]*))?([^?#]*)(?:(\?[^#]*))?(?:#(.*))?|;
124 602
125 my ($host, $port, $path, $scheme); 603 $uscheme = lc $uscheme;
604
605 my $uport = $uscheme eq "http" ? 80
606 : $uscheme eq "https" ? 443
607 : return $cb->(undef, { @pseudo, Status => 599, Reason => "Only http and https URL schemes supported" });
608
609 $uauthority =~ /^(?: .*\@ )? ([^\@:]+) (?: : (\d+) )?$/x
610 or return $cb->(undef, { @pseudo, Status => 599, Reason => "Unparsable URL" });
611
612 my $uhost = $1;
613 $uport = $2 if defined $2;
614
615 $hdr{host} = defined $2 ? "$uhost:$2" : "$uhost"
616 unless exists $hdr{host};
617
618 $uhost =~ s/^\[(.*)\]$/$1/;
619 $upath .= $query if length $query;
620
621 $upath =~ s%^/?%/%;
622
623 # cookie processing
624 if (my $jar = $arg{cookie_jar}) {
625 my $cookies = cookie_jar_extract $jar, $uscheme, $uhost, $upath;
626
627 $hdr{cookie} = join "; ", @$cookies
628 if @$cookies;
629 }
630
631 my ($rhost, $rport, $rscheme, $rpath); # request host, port, path
126 632
127 if ($proxy) { 633 if ($proxy) {
128 ($host, $port, $scheme) = @$proxy; 634 ($rpath, $rhost, $rport, $rscheme) = ($url, @$proxy);
129 $path = $url; 635
636 $rscheme = "http" unless defined $rscheme;
637
638 # don't support https requests over https-proxy transport,
639 # can't be done with tls as spec'ed, unless you double-encrypt.
640 $rscheme = "http" if $uscheme eq "https" && $rscheme eq "https";
130 } else { 641 } else {
131 ($scheme, my $authority, $path, my $query, my $fragment) = 642 ($rhost, $rport, $rscheme, $rpath) = ($uhost, $uport, $uscheme, $upath);
132 $url =~ m|(?:([^:/?#]+):)?(?://([^/?#]*))?([^?#]*)(?:\?([^#]*))?(?:#(.*))?|;
133
134 $port = $scheme eq "http" ? 80
135 : $scheme eq "https" ? 443
136 : croak "$url: only http and https URLs supported";
137
138 $authority =~ /^(?: .*\@ )? ([^\@:]+) (?: : (\d+) )?$/x
139 or croak "$authority: unparsable URL";
140
141 $host = $1;
142 $port = $2 if defined $2;
143
144 $host =~ s/^\[(.*)\]$/$1/;
145 $path .= "?$query" if length $query;
146
147 $path = "/" unless $path;
148
149 $hdr{host} = $host = lc $host;
150 } 643 }
151 644
152 $scheme = lc $scheme; 645 # leave out fragment and query string, just a heuristic
646 $hdr{referer} = "$uscheme://$uauthority$upath" unless exists $hdr{referer};
647 $hdr{"user-agent"} = $USERAGENT unless exists $hdr{"user-agent"};
153 648
154 my %state;
155
156 my $body = "";
157 $state{body} = $body;
158
159 $hdr{"content-length"} = length $body; 649 $hdr{"content-length"} = length $arg{body}
650 if length $arg{body} || $method ne "GET";
160 651
161 $state{connect_guard} = AnyEvent::Socket::tcp_connect $host, $port, sub { 652 $hdr{connection} = "close TE"; #1.1
653 $hdr{te} = "trailers" unless exists $hdr{te}; #1.1
654
655 my %state = (connect_guard => 1);
656
657 _get_slot $uhost, sub {
162 $state{fh} = shift 658 $state{slot_guard} = shift;
163 or return $cb->(undef, { Status => 599, Reason => "$!" });
164 659
165 delete $state{connect_guard}; # reduce memory usage, save a tree 660 return unless $state{connect_guard};
166 661
167 # get handle 662 my $ae_error = 595; # connecting
168 $state{handle} = new AnyEvent::Handle
169 fh => $state{fh},
170 ($scheme eq "https" ? (tls => "connect") : ());
171 663
172 # limit the number of persistent connections 664 # handle actual, non-tunneled, request
173 if ($KA_COUNT{$_[1]} < $MAX_PERSISTENT_PER_HOST) { 665 my $handle_actual_request = sub {
174 ++$KA_COUNT{$_[1]}; 666 $ae_error = 596; # request phase
175 $state{handle}{ka_count_guard} = AnyEvent::Util::guard { --$KA_COUNT{$_[1]} };
176 $hdr{connection} = "keep-alive";
177 delete $hdr{connection}; # keep-alive not yet supported
178 } else {
179 delete $hdr{connection};
180 }
181 667
182 # (re-)configure handle 668 $state{handle}->starttls ("connect") if $uscheme eq "https" && !exists $state{handle}{tls};
183 $state{handle}->timeout ($timeout);
184 $state{handle}->on_error (sub {
185 %state = ();
186 $cb->(undef, { Status => 599, Reason => "$!" });
187 });
188 $state{handle}->on_eof (sub {
189 %state = ();
190 $cb->(undef, { Status => 599, Reason => "unexpected end-of-file" });
191 });
192 669
193 # send request 670 # send request
194 $state{handle}->push_write ( 671 $state{handle}->push_write (
195 "\U$method\E $path HTTP/1.0\015\012" 672 "$method $rpath HTTP/1.1\015\012"
196 . (join "", map "$_: $hdr{$_}\015\012", keys %hdr) 673 . (join "", map "\u$_: $hdr{$_}\015\012", grep defined $hdr{$_}, keys %hdr)
197 . "\015\012" 674 . "\015\012"
198 . (delete $state{body}) 675 . (delete $arg{body})
199 );
200
201 %hdr = (); # reduce memory usage, save a kitten
202
203 # status line
204 $state{handle}->push_read (line => qr/\015?\012/, sub {
205 $_[1] =~ /^HTTP\/([0-9\.]+) \s+ ([0-9]{3}) \s+ ([^\015\012]+)/ix
206 or return (%state = (), $cb->(undef, { Status => 599, Reason => "invalid server response ($_[1])" }));
207
208 my %hdr = ( # response headers
209 HTTPVersion => ",$1",
210 Status => ",$2",
211 Reason => ",$3",
212 ); 676 );
213 677
214 # headers, could be optimized a bit 678 # return if error occured during push_write()
215 $state{handle}->unshift_read (line => qr/\015?\012\015?\012/, sub { 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 {
216 for ("$_[1]\012") { 685 for ("$_[1]") {
217 # we support spaces in field names, as lotus domino 686 y/\015//d; # weed out any \015, as they show up in the weirdest of places.
218 # creates them.
219 $hdr{lc $1} .= ",$2"
220 while /\G
221 ([^:\000-\037]+):
222 [\011\040]*
223 ((?: [^\015\012]+ | \015?\012[\011\040] )*)
224 \015?\012
225 /gxc;
226 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,
227 /\G$/ 703 ;
704
705 my $hdr = parse_hdr
228 or return $cb->(undef, { Status => 599, Reason => "garbled response headers" }); 706 or return (%state = (), $cb->(undef, { @pseudo, Status => 599, Reason => "Garbled response headers" }));
707
708 %hdr = (%$hdr, @pseudo);
229 } 709 }
230 710
231 substr $_, 0, 1, "" 711 # redirect handling
232 for values %hdr; 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/^\.\/+//;
233 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
234 if (exists $hdr{"content-length"}) { 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
235 $_[0]->unshift_read (chunk => $hdr{"content-length"}, sub { 818 $_[0]->push_read (chunk => $len, sub {
236 # could cache persistent connection now 819 $on_body->($_[1], \%hdr)
237 if ($hdr{connection} =~ /\bkeep-alive\b/i) { 820 or return $finish->(undef, 598 => "Request cancelled by on_body");
238 # but we don't, due to misdesigns, this is annoyingly complex 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 }
239 }; 846 };
240 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 {
894 $state{fh} = shift
895 or do {
896 my $err = "$!";
897 %state = ();
898 return $cb->(undef, { @pseudo, Status => $ae_error, Reason => $err });
899 };
900
901 return unless delete $state{connect_guard};
902
903 # get handle
904 $state{handle} = new AnyEvent::Handle
905 fh => $state{fh},
906 peername => $rhost,
907 tls_ctx => $arg{tls_ctx},
908 # these need to be reconfigured on keepalive handles
909 timeout => $timeout,
910 on_error => sub {
911 %state = ();
912 $cb->(undef, { @pseudo, Status => $ae_error, Reason => $_[2] });
913 },
914 on_eof => sub {
915 %state = ();
916 $cb->(undef, { @pseudo, Status => $ae_error, Reason => "Unexpected end-of-file" });
917 },
918 ;
919
920 # limit the number of persistent connections
921 # keepalive not yet supported
922# if ($KA_COUNT{$_[1]} < $MAX_PERSISTENT_PER_HOST) {
923# ++$KA_COUNT{$_[1]};
924# $state{handle}{ka_count_guard} = AnyEvent::Util::guard {
925# --$KA_COUNT{$_[1]}
926# };
927# $hdr{connection} = "keep-alive";
928# }
929
930 $state{handle}->starttls ("connect") if $rscheme eq "https";
931
932 # now handle proxy-CONNECT method
933 if ($proxy && $uscheme eq "https") {
934 # oh dear, we have to wrap it into a connect request
935
936 # maybe re-use $uauthority with patched port?
937 $state{handle}->push_write ("CONNECT $uhost:$uport HTTP/1.0\015\012Host: $uhost\015\012\015\012");
938 $state{handle}->push_read (line => $qr_nlnl, sub {
939 $_[1] =~ /^HTTP\/([0-9\.]+) \s+ ([0-9]{3}) (?: \s+ ([^\015\012]*) )?/ix
940 or return (%state = (), $cb->(undef, { @pseudo, Status => 599, Reason => "Invalid proxy connect response ($_[1])" }));
941
942 if ($2 == 200) {
943 $rpath = $upath;
944 $handle_actual_request->();
945 } else {
241 %state = (); 946 %state = ();
242 $cb->($_[1], \%hdr); 947 $cb->(undef, { @pseudo, Status => $2, Reason => $3 });
243 }); 948 }
244 } else {
245 # too bad, need to read until we get an error or EOF,
246 # no way to detect winged data.
247 $_[0]->on_error (sub {
248 %state = ();
249 $cb->($_[0]{rbuf}, \%hdr);
250 });
251 $_[0]->on_eof (undef);
252 $_[0]->on_read (sub { });
253 } 949 });
950 } else {
951 $handle_actual_request->();
254 }); 952 }
255 }); 953 };
256 }, sub { 954
257 $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 });
258 }; 959 };
259 960
260 defined wantarray && AnyEvent::Util::guard { %state = () } 961 defined wantarray && AnyEvent::Util::guard { %state = () }
261} 962}
262 963
263sub http_get($$;@) { 964sub http_get($@) {
264 unshift @_, "GET"; 965 unshift @_, "GET";
265 &http_request 966 &http_request
266} 967}
267 968
969sub http_head($@) {
970 unshift @_, "HEAD";
971 &http_request
972}
973
974sub http_post($$@) {
975 my $url = shift;
976 unshift @_, "POST", $url, "body";
977 &http_request
978}
979
980=back
981
982=head2 DNS CACHING
983
984AnyEvent::HTTP uses the AnyEvent::Socket::tcp_connect function for
985the actual connection, which in turn uses AnyEvent::DNS to resolve
986hostnames. The latter is a simple stub resolver and does no caching
987on its own. If you want DNS caching, you currently have to provide
988your own default resolver (by storing a suitable resolver object in
989C<$AnyEvent::DNS::RESOLVER>).
990
268=head2 GLOBAL FUNCTIONS AND VARIABLES 991=head2 GLOBAL FUNCTIONS AND VARIABLES
269 992
270=over 4 993=over 4
271 994
272=item AnyEvent::HTTP::set_proxy "proxy-url" 995=item AnyEvent::HTTP::set_proxy "proxy-url"
273 996
274Sets the default proxy server to use. The proxy-url must begin with a 997Sets the default proxy server to use. The proxy-url must begin with a
275string of the form C<http://host:port> (optionally C<https:...>). 998string of the form C<http://host:port> (optionally C<https:...>), croaks
999otherwise.
276 1000
1001To clear an already-set proxy, use C<undef>.
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
277=item $AnyEvent::HTTP::MAX_REDIRECTS 1053=item $AnyEvent::HTTP::MAX_RECURSE
278 1054
279The default value for the C<max_redirects> request parameter 1055The default value for the C<recurse> request parameter (default: C<10>).
280(default: C<10>).
281 1056
282=item $AnyEvent::HTTP::USERAGENT 1057=item $AnyEvent::HTTP::USERAGENT
283 1058
284The default value for the C<User-Agent> header (the default is 1059The default value for the C<User-Agent> header (the default is
285C<Mozilla/5.0 (compatible; AnyEvent::HTTP/$VERSION; +http://software.schmorp.de/pkg/AnyEvent)>). 1060C<Mozilla/5.0 (compatible; U; AnyEvent-HTTP/$VERSION; +http://software.schmorp.de/pkg/AnyEvent)>).
286 1061
287=item $AnyEvent::HTTP::MAX_PERSISTENT 1062=item $AnyEvent::HTTP::MAX_PER_HOST
288 1063
289The maximum number of persistent connections to keep open (default: 8). 1064The maximum number of concurrent connections to the same host (identified
1065by the hostname). If the limit is exceeded, then the additional requests
1066are queued until previous connections are closed.
290 1067
291=item $AnyEvent::HTTP::PERSISTENT_TIMEOUT 1068The default value for this is C<4>, and it is highly advisable to not
1069increase it.
292 1070
293The maximum time to cache a persistent connection, in seconds (default: 2). 1071=item $AnyEvent::HTTP::ACTIVE
1072
1073The number of active connections. This is not the number of currently
1074running requests, but the number of currently open and non-idle TCP
1075connections. This number of can be useful for load-leveling.
294 1076
295=back 1077=back
296 1078
297=cut 1079=cut
298 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}
1125
299sub set_proxy($) { 1126sub set_proxy($) {
1127 if (length $_[0]) {
300 $PROXY = [$2, $3 || 3128, $1] if $_[0] =~ m%^(https?):// ([^:/]+) (?: : (\d*) )?%ix; 1128 $_[0] =~ m%^(https?):// ([^:/]+) (?: : (\d*) )?%ix
1129 or Carp::croak "$_[0]: invalid proxy URL";
1130 $PROXY = [$2, $3 || 3128, $1]
1131 } else {
1132 undef $PROXY;
1133 }
301} 1134}
302 1135
303# initialise proxy from environment 1136# initialise proxy from environment
1137eval {
304set_proxy $ENV{http_proxy}; 1138 set_proxy $ENV{http_proxy};
1139};
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 };
305 1196
306=head1 SEE ALSO 1197=head1 SEE ALSO
307 1198
308L<AnyEvent>. 1199L<AnyEvent>.
309 1200
310=head1 AUTHOR 1201=head1 AUTHOR
311 1202
312 Marc Lehmann <schmorp@schmorp.de> 1203 Marc Lehmann <schmorp@schmorp.de>
313 http://home.schmorp.de/ 1204 http://home.schmorp.de/
1205
1206With many thanks to Дмитрий Шалашов, who provided countless
1207testcases and bugreports.
314 1208
315=cut 1209=cut
316 1210
3171 12111
318 1212

Diff Legend

Removed lines
+ Added lines
< Changed lines
> Changed lines