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.6 by root, Wed Jun 4 12:05:45 2008 UTC vs.
Revision 1.83 by root, Sun Jan 2 05:02:28 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_RECURSE = 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.
56 76
57=item http_head $url, key => value..., $cb->($data, $headers) 77=item http_head $url, key => value..., $cb->($data, $headers)
58 78
59Executes an HTTP-HEAD request. See the http_request function for details on 79Executes an HTTP-HEAD request. See the http_request function for details
60additional parameters. 80on additional parameters and the return value.
61 81
62=item http_post $url, $body, key => value..., $cb->($data, $headers) 82=item http_post $url, $body, key => value..., $cb->($data, $headers)
63 83
64Executes an HTTP-POST request with a requets body of C<$bod>. See the 84Executes an HTTP-POST request with a request body of C<$body>. See the
65http_request function for details on additional parameters. 85http_request function for details on additional parameters and the return
86value.
66 87
67=item http_request $method => $url, key => value..., $cb->($data, $headers) 88=item http_request $method => $url, key => value..., $cb->($data, $headers)
68 89
69Executes 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
70must be an absolute http or https URL. 91must be an absolute http or https URL.
71 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
72The callback will be called with the response data as first argument 98The callback will be called with the response body data as first argument
73(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
74response headers as second argument. 100(and trailers) as second argument.
75 101
76All 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
77headers, the three "pseudo-headers" C<HTTPVersion>, C<Status> and 103headers, the "pseudo-headers" (uppercase to avoid clashing with possible
78C<Reason> contain the three parts of the HTTP Status-Line of the same 104response headers) C<HTTPVersion>, C<Status> and C<Reason> contain the
79name. 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.
80 125
81If 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,
82then 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
83and 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
84 144
85A typical callback might look like this: 145A typical callback might look like this:
86 146
87 sub { 147 sub {
88 my ($body, $hdr) = @_; 148 my ($body, $hdr) = @_;
104Whether to recurse requests or not, e.g. on redirects, authentication 164Whether to recurse requests or not, e.g. on redirects, authentication
105retries and so on, and how often to do so. 165retries and so on, and how often to do so.
106 166
107=item headers => hashref 167=item headers => hashref
108 168
109The 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).
110 174
111=item timeout => $seconds 175=item timeout => $seconds
112 176
113The 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
114the 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.
115 182
116=item proxy => [$host, $port[, $scheme]] or undef 183=item proxy => [$host, $port[, $scheme]] or undef
117 184
118Use 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
119default proxy (as specified by C<$ENV{http_proxy}>) is used. 186default proxy (as specified by C<$ENV{http_proxy}>) is used.
120 187
121C<$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
122HTTPS. 189HTTPS.
123 190
124=item body => $string 191=item body => $string
125 192
126The 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
127this module might offer more options). 194this module might offer more options).
128 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
129=back 320=back
130 321
131=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;
132 352
133=cut 353=cut
134 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 $uhost = lc $uhost;
422
423 %$jar = () if $jar->{version} != 1;
424
425 my @cookies;
426
427 while (my ($chost, $paths) = each %$jar) {
428 next unless ref $paths;
429
430 if ($chost =~ /^\./) {
431 next unless $chost eq substr $uhost, -length $chost;
432 } elsif ($chost =~ /\./) {
433 next unless $chost eq $uhost;
434 } else {
435 next;
436 }
437
438 while (my ($cpath, $cookies) = each %$paths) {
439 next unless $cpath eq substr $upath, 0, length $cpath;
440
441 while (my ($cookie, $kv) = each %$cookies) {
442 next if $uscheme ne "https" && exists $kv->{secure};
443
444 if (exists $kv->{_expires} and AE::now > $kv->{_expires}) {
445 delete $cookies->{$cookie};
446 next;
447 }
448
449 my $value = $kv->{value};
450
451 if ($value =~ /[=;,[:space:]]/) {
452 $value =~ s/([\\"])/\\$1/g;
453 $value = "\"$value\"";
454 }
455
456 push @cookies, "$cookie=$value";
457 }
458 }
459 }
460
461 \@cookies
462}
463
464# parse set_cookie header into jar
465sub cookie_jar_set_cookie($$$$) {
466 my ($jar, $set_cookie, $uhost, $date) = @_;
467
468 my $anow = int AE::now;
469 my $snow; # server-now
470
471 for ($set_cookie) {
472 # parse NAME=VALUE
473 my @kv;
474
475 # expires is not http-compliant in the original cookie-spec,
476 # we support the official date format and some extensions
477 while (
478 m{
479 \G\s*
480 (?:
481 expires \s*=\s* ([A-Z][a-z][a-z]+,\ [^,;]+)
482 | ([^=;,[:space:]]+) (?: \s*=\s* (?: "((?:[^\\"]+|\\.)*)" | ([^=;,[:space:]]*) ) )?
483 )
484 }gcxsi
485 ) {
486 my $name = $2;
487 my $value = $4;
488
489 if (defined $1) {
490 # expires
491 $name = "expires";
492 $value = $1;
493 } elsif (defined $3) {
494 # quoted
495 $value = $3;
496 $value =~ s/\\(.)/$1/gs;
497 }
498
499 push @kv, lc $name, $value;
500
501 last unless /\G\s*;/gc;
502 }
503
504 last unless @kv;
505
506 my $name = shift @kv;
507 my %kv = (value => shift @kv, @kv);
508
509 if (exists $kv{"max-age"}) {
510 $kv{_expires} = $anow + delete $kv{"max-age"};
511 } elsif (exists $kv{expires}) {
512 $snow ||= parse_date ($date) || $anow;
513 $kv{_expires} = $anow + (parse_date (delete $kv{expires}) - $snow);
514 } else {
515 delete $kv{_expires};
516 }
517
518 my $cdom;
519 my $cpath = (delete $kv{path}) || "/";
520
521 if (exists $kv{domain}) {
522 $cdom = delete $kv{domain};
523
524 $cdom =~ s/^\.?/./; # make sure it starts with a "."
525
526 next if $cdom =~ /\.$/;
527
528 # this is not rfc-like and not netscape-like. go figure.
529 my $ndots = $cdom =~ y/.//;
530 next if $ndots < ($cdom =~ /\.[^.][^.]\.[^.][^.]$/ ? 3 : 2);
531 } else {
532 $cdom = $uhost;
533 }
534
535 # store it
536 $jar->{version} = 1;
537 $jar->{lc $cdom}{$cpath}{$name} = \%kv;
538
539 redo if /\G\s*,/gc;
540 }
541}
542
543# continue to parse $_ for headers and place them into the arg
544sub parse_hdr() {
545 my %hdr;
546
547 # things seen, not parsed:
548 # p3pP="NON CUR OTPi OUR NOR UNI"
549
550 $hdr{lc $1} .= ",$2"
551 while /\G
552 ([^:\000-\037]*):
553 [\011\040]*
554 ((?: [^\012]+ | \012[\011\040] )*)
555 \012
556 /gxc;
557
558 /\G$/
559 or return;
560
561 # remove the "," prefix we added to all headers above
562 substr $_, 0, 1, ""
563 for values %hdr;
564
565 \%hdr
566}
567
568our $qr_nlnl = qr{(?<![^\012])\015?\012};
569
570our $TLS_CTX_LOW = { cache => 1, sslv2 => 1 };
571our $TLS_CTX_HIGH = { cache => 1, verify => 1, verify_peername => "https" };
572
135sub http_request($$$;@) { 573sub http_request($$@) {
136 my $cb = pop; 574 my $cb = pop;
137 my ($method, $url, %arg) = @_; 575 my ($method, $url, %arg) = @_;
138 576
139 my %hdr; 577 my %hdr;
140 578
579 $arg{tls_ctx} = $TLS_CTX_LOW if $arg{tls_ctx} eq "low" || !exists $arg{tls_ctx};
580 $arg{tls_ctx} = $TLS_CTX_HIGH if $arg{tls_ctx} eq "high";
581
141 $method = uc $method; 582 $method = uc $method;
142 583
143 if (my $hdr = delete $arg{headers}) { 584 if (my $hdr = $arg{headers}) {
144 while (my ($k, $v) = each %$hdr) { 585 while (my ($k, $v) = each %$hdr) {
145 $hdr{lc $k} = $v; 586 $hdr{lc $k} = $v;
146 } 587 }
147 } 588 }
148 589
590 # pseudo headers for all subsequent responses
591 my @pseudo = (URL => $url);
592 push @pseudo, Redirect => delete $arg{Redirect} if exists $arg{Redirect};
593
594 my $recurse = exists $arg{recurse} ? delete $arg{recurse} : $MAX_RECURSE;
595
596 return $cb->(undef, { @pseudo, Status => 599, Reason => "Too many redirections" })
597 if $recurse < 0;
598
149 my $proxy = $arg{proxy} || $PROXY; 599 my $proxy = $arg{proxy} || $PROXY;
150 my $timeout = $arg{timeout} || $TIMEOUT; 600 my $timeout = $arg{timeout} || $TIMEOUT;
151 my $recurse = exists $arg{recurse} ? $arg{recurse} : $MAX_RECURSE;
152 601
153 $hdr{"user-agent"} ||= $USERAGENT; 602 my ($uscheme, $uauthority, $upath, $query, $fragment) =
603 $url =~ m|(?:([^:/?#]+):)?(?://([^/?#]*))?([^?#]*)(?:(\?[^#]*))?(?:#(.*))?|;
154 604
155 my ($host, $port, $path, $scheme); 605 $uscheme = lc $uscheme;
606
607 my $uport = $uscheme eq "http" ? 80
608 : $uscheme eq "https" ? 443
609 : return $cb->(undef, { @pseudo, Status => 599, Reason => "Only http and https URL schemes supported" });
610
611 $uauthority =~ /^(?: .*\@ )? ([^\@:]+) (?: : (\d+) )?$/x
612 or return $cb->(undef, { @pseudo, Status => 599, Reason => "Unparsable URL" });
613
614 my $uhost = $1;
615 $uport = $2 if defined $2;
616
617 $hdr{host} = defined $2 ? "$uhost:$2" : "$uhost"
618 unless exists $hdr{host};
619
620 $uhost =~ s/^\[(.*)\]$/$1/;
621 $upath .= $query if length $query;
622
623 $upath =~ s%^/?%/%;
624
625 # cookie processing
626 if (my $jar = $arg{cookie_jar}) {
627 my $cookies = cookie_jar_extract $jar, $uscheme, $uhost, $upath;
628
629 $hdr{cookie} = join "; ", @$cookies
630 if @$cookies;
631 }
632
633 my ($rhost, $rport, $rscheme, $rpath); # request host, port, path
156 634
157 if ($proxy) { 635 if ($proxy) {
158 ($host, $port, $scheme) = @$proxy; 636 ($rpath, $rhost, $rport, $rscheme) = ($url, @$proxy);
159 $path = $url; 637
638 $rscheme = "http" unless defined $rscheme;
639
640 # don't support https requests over https-proxy transport,
641 # can't be done with tls as spec'ed, unless you double-encrypt.
642 $rscheme = "http" if $uscheme eq "https" && $rscheme eq "https";
160 } else { 643 } else {
161 ($scheme, my $authority, $path, my $query, my $fragment) = 644 ($rhost, $rport, $rscheme, $rpath) = ($uhost, $uport, $uscheme, $upath);
162 $url =~ m|(?:([^:/?#]+):)?(?://([^/?#]*))?([^?#]*)(?:\?([^#]*))?(?:#(.*))?|;
163
164 $port = $scheme eq "http" ? 80
165 : $scheme eq "https" ? 443
166 : croak "$url: only http and https URLs supported";
167
168 $authority =~ /^(?: .*\@ )? ([^\@:]+) (?: : (\d+) )?$/x
169 or croak "$authority: unparsable URL";
170
171 $host = $1;
172 $port = $2 if defined $2;
173
174 $host =~ s/^\[(.*)\]$/$1/;
175 $path .= "?$query" if length $query;
176
177 $path = "/" unless $path;
178
179 $hdr{host} = $host = lc $host;
180 } 645 }
181 646
182 $scheme = lc $scheme; 647 # leave out fragment and query string, just a heuristic
648 $hdr{referer} = "$uscheme://$uauthority$upath" unless exists $hdr{referer};
649 $hdr{"user-agent"} = $USERAGENT unless exists $hdr{"user-agent"};
183 650
184 my %state;
185
186 $state{body} = delete $arg{body};
187
188 $hdr{"content-length"} = length $state{body}; 651 $hdr{"content-length"} = length $arg{body}
652 if length $arg{body} || $method ne "GET";
189 653
190 $state{connect_guard} = AnyEvent::Socket::tcp_connect $host, $port, sub { 654 $hdr{connection} = "close TE"; #1.1
655 $hdr{te} = "trailers" unless exists $hdr{te}; #1.1
656
657 my %state = (connect_guard => 1);
658
659 _get_slot $uhost, sub {
191 $state{fh} = shift 660 $state{slot_guard} = shift;
192 or return $cb->(undef, { Status => 599, Reason => "$!" });
193 661
194 delete $state{connect_guard}; # reduce memory usage, save a tree 662 return unless $state{connect_guard};
195 663
196 # get handle 664 my $ae_error = 595; # connecting
197 $state{handle} = new AnyEvent::Handle
198 fh => $state{fh},
199 ($scheme eq "https" ? (tls => "connect") : ());
200 665
201 # limit the number of persistent connections 666 # handle actual, non-tunneled, request
202 if ($KA_COUNT{$_[1]} < $MAX_PERSISTENT_PER_HOST) { 667 my $handle_actual_request = sub {
203 ++$KA_COUNT{$_[1]}; 668 $ae_error = 596; # request phase
204 $state{handle}{ka_count_guard} = AnyEvent::Util::guard { --$KA_COUNT{$_[1]} };
205 $hdr{connection} = "keep-alive";
206 delete $hdr{connection}; # keep-alive not yet supported
207 } else {
208 delete $hdr{connection};
209 }
210 669
211 # (re-)configure handle 670 $state{handle}->starttls ("connect") if $uscheme eq "https" && !exists $state{handle}{tls};
212 $state{handle}->timeout ($timeout);
213 $state{handle}->on_error (sub {
214 %state = ();
215 $cb->(undef, { Status => 599, Reason => "$!" });
216 });
217 $state{handle}->on_eof (sub {
218 %state = ();
219 $cb->(undef, { Status => 599, Reason => "unexpected end-of-file" });
220 });
221 671
222 # send request 672 # send request
223 $state{handle}->push_write ( 673 $state{handle}->push_write (
224 "$method $path HTTP/1.0\015\012" 674 "$method $rpath HTTP/1.1\015\012"
225 . (join "", map "$_: $hdr{$_}\015\012", keys %hdr) 675 . (join "", map "\u$_: $hdr{$_}\015\012", grep defined $hdr{$_}, keys %hdr)
226 . "\015\012" 676 . "\015\012"
227 . (delete $state{body}) 677 . (delete $arg{body})
228 );
229
230 %hdr = (); # reduce memory usage, save a kitten
231
232 # status line
233 $state{handle}->push_read (line => qr/\015?\012/, sub {
234 $_[1] =~ /^HTTP\/([0-9\.]+) \s+ ([0-9]{3}) \s+ ([^\015\012]+)/ix
235 or return (%state = (), $cb->(undef, { Status => 599, Reason => "invalid server response ($_[1])" }));
236
237 my %hdr = ( # response headers
238 HTTPVersion => ",$1",
239 Status => ",$2",
240 Reason => ",$3",
241 ); 678 );
242 679
243 # headers, could be optimized a bit 680 # return if error occured during push_write()
244 $state{handle}->unshift_read (line => qr/\015?\012\015?\012/, sub { 681 return unless %state;
682
683 %hdr = (); # reduce memory usage, save a kitten, also make it possible to re-use
684
685 # status line and headers
686 $state{read_response} = sub {
245 for ("$_[1]\012") { 687 for ("$_[1]") {
246 # we support spaces in field names, as lotus domino 688 y/\015//d; # weed out any \015, as they show up in the weirdest of places.
247 # creates them.
248 $hdr{lc $1} .= ",$2"
249 while /\G
250 ([^:\000-\037]+):
251 [\011\040]*
252 ((?: [^\015\012]+ | \015?\012[\011\040] )*)
253 \015?\012
254 /gxc;
255 689
690 /^HTTP\/0*([0-9\.]+) \s+ ([0-9]{3}) (?: \s+ ([^\012]*) )? \012/gxci
691 or return (%state = (), $cb->(undef, { @pseudo, Status => 599, Reason => "Invalid server response" }));
692
693 # 100 Continue handling
694 # should not happen as we don't send expect: 100-continue,
695 # but we handle it just in case.
696 # since we send the request body regardless, if we get an error
697 # we are out of-sync, which we currently do NOT handle correctly.
698 return $state{handle}->push_read (line => $qr_nlnl, $state{read_response})
699 if $2 eq 100;
700
701 push @pseudo,
702 HTTPVersion => $1,
703 Status => $2,
704 Reason => $3,
256 /\G$/ 705 ;
706
707 my $hdr = parse_hdr
257 or return $cb->(undef, { Status => 599, Reason => "garbled response headers" }); 708 or return (%state = (), $cb->(undef, { @pseudo, Status => 599, Reason => "Garbled response headers" }));
709
710 %hdr = (%$hdr, @pseudo);
258 } 711 }
259 712
260 substr $_, 0, 1, "" 713 # redirect handling
261 for values %hdr; 714 # microsoft and other shitheads don't give a shit for following standards,
715 # try to support some common forms of broken Location headers.
716 if ($hdr{location} !~ /^(?: $ | [^:\/?\#]+ : )/x) {
717 $hdr{location} =~ s/^\.\/+//;
262 718
263 if ($method eq "HEAD") { 719 my $url = "$rscheme://$uhost:$uport";
264 %state = ();
265 $cb->(undef, \%hdr);
266 } else {
267 if (exists $hdr{"content-length"}) {
268 $_[0]->unshift_read (chunk => $hdr{"content-length"}, sub {
269 # could cache persistent connection now
270 if ($hdr{connection} =~ /\bkeep-alive\b/i) {
271 # but we don't, due to misdesigns, this is annoyingly complex
272 };
273 720
274 %state = (); 721 unless ($hdr{location} =~ s/^\///) {
275 $cb->($_[1], \%hdr); 722 $url .= $upath;
723 $url =~ s/\/[^\/]*$//;
276 }); 724 }
277 } else { 725
278 # too bad, need to read until we get an error or EOF, 726 $hdr{location} = "$url/$hdr{location}";
279 # no way to detect winged data.
280 $_[0]->on_error (sub {
281 %state = ();
282 $cb->($_[0]{rbuf}, \%hdr);
283 }); 727 }
284 $_[0]->on_eof (undef); 728
285 $_[0]->on_read (sub { }); 729 my $redirect;
730
731 if ($recurse) {
732 my $status = $hdr{Status};
733
734 # industry standard is to redirect POST as GET for
735 # 301, 302 and 303, in contrast to HTTP/1.0 and 1.1.
736 # also, the UA should ask the user for 301 and 307 and POST,
737 # industry standard seems to be to simply follow.
738 # we go with the industry standard.
739 if ($status == 301 or $status == 302 or $status == 303) {
740 # HTTP/1.1 is unclear on how to mutate the method
741 $method = "GET" unless $method eq "HEAD";
742 $redirect = 1;
743 } elsif ($status == 307) {
744 $redirect = 1;
286 } 745 }
287 } 746 }
747
748 my $finish = sub { # ($data, $err_status, $err_reason[, $keepalive])
749 my $may_keep_alive = $_[3];
750
751 $state{handle}->destroy if $state{handle};
752 %state = ();
753
754 if (defined $_[1]) {
755 $hdr{OrigStatus} = $hdr{Status}; $hdr{Status} = $_[1];
756 $hdr{OrigReason} = $hdr{Reason}; $hdr{Reason} = $_[2];
757 }
758
759 # set-cookie processing
760 if ($arg{cookie_jar}) {
761 cookie_jar_set_cookie $arg{cookie_jar}, $hdr{"set-cookie"}, $uhost, $hdr{date};
762 }
763
764 if ($redirect && exists $hdr{location}) {
765 # we ignore any errors, as it is very common to receive
766 # Content-Length != 0 but no actual body
767 # we also access %hdr, as $_[1] might be an erro
768 http_request (
769 $method => $hdr{location},
770 %arg,
771 recurse => $recurse - 1,
772 Redirect => [$_[0], \%hdr],
773 $cb);
774 } else {
775 $cb->($_[0], \%hdr);
776 }
777 };
778
779 $ae_error = 597; # body phase
780
781 my $len = $hdr{"content-length"};
782
783 if (!$redirect && $arg{on_header} && !$arg{on_header}(\%hdr)) {
784 $finish->(undef, 598 => "Request cancelled by on_header");
785 } elsif (
786 $hdr{Status} =~ /^(?:1..|204|205|304)$/
787 or $method eq "HEAD"
788 or (defined $len && !$len)
789 ) {
790 # no body
791 $finish->("", undef, undef, 1);
792 } else {
793 # body handling, many different code paths
794 # - no body expected
795 # - want_body_handle
796 # - te chunked
797 # - 2x length known (with or without on_body)
798 # - 2x length not known (with or without on_body)
799 if (!$redirect && $arg{want_body_handle}) {
800 $_[0]->on_eof (undef);
801 $_[0]->on_error (undef);
802 $_[0]->on_read (undef);
803
804 $finish->(delete $state{handle});
805
806 } elsif ($hdr{"transfer-encoding"} =~ /\bchunked\b/i) {
807 my $cl = 0;
808 my $body = undef;
809 my $on_body = $arg{on_body} || sub { $body .= shift; 1 };
810
811 $state{read_chunk} = sub {
812 $_[1] =~ /^([0-9a-fA-F]+)/
813 or $finish->(undef, $ae_error => "Garbled chunked transfer encoding");
814
815 my $len = hex $1;
816
817 if ($len) {
818 $cl += $len;
819
820 $_[0]->push_read (chunk => $len, sub {
821 $on_body->($_[1], \%hdr)
822 or return $finish->(undef, 598 => "Request cancelled by on_body");
823
824 $_[0]->push_read (line => sub {
825 length $_[1]
826 and return $finish->(undef, $ae_error => "Garbled chunked transfer encoding");
827 $_[0]->push_read (line => $state{read_chunk});
828 });
829 });
830 } else {
831 $hdr{"content-length"} ||= $cl;
832
833 $_[0]->push_read (line => $qr_nlnl, sub {
834 if (length $_[1]) {
835 for ("$_[1]") {
836 y/\015//d; # weed out any \015, as they show up in the weirdest of places.
837
838 my $hdr = parse_hdr
839 or return $finish->(undef, $ae_error => "Garbled response trailers");
840
841 %hdr = (%hdr, %$hdr);
842 }
843 }
844
845 $finish->($body, undef, undef, 1);
846 });
847 }
848 };
849
850 $_[0]->push_read (line => $state{read_chunk});
851
852 } elsif ($arg{on_body}) {
853 if ($len) {
854 $_[0]->on_read (sub {
855 $len -= length $_[0]{rbuf};
856
857 $arg{on_body}(delete $_[0]{rbuf}, \%hdr)
858 or return $finish->(undef, 598 => "Request cancelled by on_body");
859
860 $len > 0
861 or $finish->("", undef, undef, 1);
862 });
863 } else {
864 $_[0]->on_eof (sub {
865 $finish->("");
866 });
867 $_[0]->on_read (sub {
868 $arg{on_body}(delete $_[0]{rbuf}, \%hdr)
869 or $finish->(undef, 598 => "Request cancelled by on_body");
870 });
871 }
872 } else {
873 $_[0]->on_eof (undef);
874
875 if ($len) {
876 $_[0]->on_read (sub {
877 $finish->((substr delete $_[0]{rbuf}, 0, $len, ""), undef, undef, 1)
878 if $len <= length $_[0]{rbuf};
879 });
880 } else {
881 $_[0]->on_error (sub {
882 ($! == Errno::EPIPE || !$!)
883 ? $finish->(delete $_[0]{rbuf})
884 : $finish->(undef, $ae_error => $_[2]);
885 });
886 $_[0]->on_read (sub { });
887 }
888 }
889 }
288 }); 890 };
891
892 $state{handle}->push_read (line => $qr_nlnl, $state{read_response});
289 }); 893 };
290 }, sub { 894
291 $timeout 895 my $connect_cb = sub {
896 $state{fh} = shift
897 or do {
898 my $err = "$!";
899 %state = ();
900 return $cb->(undef, { @pseudo, Status => $ae_error, Reason => $err });
901 };
902
903 return unless delete $state{connect_guard};
904
905 # get handle
906 $state{handle} = new AnyEvent::Handle
907 fh => $state{fh},
908 peername => $rhost,
909 tls_ctx => $arg{tls_ctx},
910 # these need to be reconfigured on keepalive handles
911 timeout => $timeout,
912 on_error => sub {
913 %state = ();
914 $cb->(undef, { @pseudo, Status => $ae_error, Reason => $_[2] });
915 },
916 on_eof => sub {
917 %state = ();
918 $cb->(undef, { @pseudo, Status => $ae_error, Reason => "Unexpected end-of-file" });
919 },
920 ;
921
922 # limit the number of persistent connections
923 # keepalive not yet supported
924# if ($KA_COUNT{$_[1]} < $MAX_PERSISTENT_PER_HOST) {
925# ++$KA_COUNT{$_[1]};
926# $state{handle}{ka_count_guard} = AnyEvent::Util::guard {
927# --$KA_COUNT{$_[1]}
928# };
929# $hdr{connection} = "keep-alive";
930# }
931
932 $state{handle}->starttls ("connect") if $rscheme eq "https";
933
934 # now handle proxy-CONNECT method
935 if ($proxy && $uscheme eq "https") {
936 # oh dear, we have to wrap it into a connect request
937
938 # maybe re-use $uauthority with patched port?
939 $state{handle}->push_write ("CONNECT $uhost:$uport HTTP/1.0\015\012Host: $uhost\015\012\015\012");
940 $state{handle}->push_read (line => $qr_nlnl, sub {
941 $_[1] =~ /^HTTP\/([0-9\.]+) \s+ ([0-9]{3}) (?: \s+ ([^\015\012]*) )?/ix
942 or return (%state = (), $cb->(undef, { @pseudo, Status => 599, Reason => "Invalid proxy connect response ($_[1])" }));
943
944 if ($2 == 200) {
945 $rpath = $upath;
946 $handle_actual_request->();
947 } else {
948 %state = ();
949 $cb->(undef, { @pseudo, Status => $2, Reason => $3 });
950 }
951 });
952 } else {
953 $handle_actual_request->();
954 }
955 };
956
957 my $tcp_connect = $arg{tcp_connect}
958 || do { require AnyEvent::Socket; \&AnyEvent::Socket::tcp_connect };
959
960 $state{connect_guard} = $tcp_connect->($rhost, $rport, $connect_cb, $arg{on_prepare} || sub { $timeout });
292 }; 961 };
293 962
294 defined wantarray && AnyEvent::Util::guard { %state = () } 963 defined wantarray && AnyEvent::Util::guard { %state = () }
295} 964}
296 965
297sub http_get($$;@) { 966sub http_get($@) {
298 unshift @_, "GET"; 967 unshift @_, "GET";
299 &http_request 968 &http_request
300} 969}
301 970
302sub http_head($$;@) { 971sub http_head($@) {
303 unshift @_, "HEAD"; 972 unshift @_, "HEAD";
304 &http_request 973 &http_request
305} 974}
306 975
307sub http_post($$$;@) { 976sub http_post($$@) {
977 my $url = shift;
308 unshift @_, "POST", "body"; 978 unshift @_, "POST", $url, "body";
309 &http_request 979 &http_request
310} 980}
311 981
982=back
983
984=head2 DNS CACHING
985
986AnyEvent::HTTP uses the AnyEvent::Socket::tcp_connect function for
987the actual connection, which in turn uses AnyEvent::DNS to resolve
988hostnames. The latter is a simple stub resolver and does no caching
989on its own. If you want DNS caching, you currently have to provide
990your own default resolver (by storing a suitable resolver object in
991C<$AnyEvent::DNS::RESOLVER>).
992
312=head2 GLOBAL FUNCTIONS AND VARIABLES 993=head2 GLOBAL FUNCTIONS AND VARIABLES
313 994
314=over 4 995=over 4
315 996
316=item AnyEvent::HTTP::set_proxy "proxy-url" 997=item AnyEvent::HTTP::set_proxy "proxy-url"
317 998
318Sets the default proxy server to use. The proxy-url must begin with a 999Sets the default proxy server to use. The proxy-url must begin with a
319string of the form C<http://host:port> (optionally C<https:...>). 1000string of the form C<http://host:port> (optionally C<https:...>), croaks
1001otherwise.
1002
1003To clear an already-set proxy, use C<undef>.
1004
1005=item AnyEvent::HTTP::cookie_jar_expire $jar[, $session_end]
1006
1007Remove all cookies from the cookie jar that have been expired. If
1008C<$session_end> is given and true, then additionally remove all session
1009cookies.
1010
1011You should call this function (with a true C<$session_end>) before you
1012save cookies to disk, and you should call this function after loading them
1013again. If you have a long-running program you can additonally call this
1014function from time to time.
1015
1016A cookie jar is initially an empty hash-reference that is managed by this
1017module. It's format is subject to change, but currently it is like this:
1018
1019The key C<version> has to contain C<1>, otherwise the hash gets
1020emptied. All other keys are hostnames or IP addresses pointing to
1021hash-references. The key for these inner hash references is the
1022server path for which this cookie is meant, and the values are again
1023hash-references. The keys of those hash-references is the cookie name, and
1024the value, you guessed it, is another hash-reference, this time with the
1025key-value pairs from the cookie, except for C<expires> and C<max-age>,
1026which have been replaced by a C<_expires> key that contains the cookie
1027expiry timestamp.
1028
1029Here is an example of a cookie jar with a single cookie, so you have a
1030chance of understanding the above paragraph:
1031
1032 {
1033 version => 1,
1034 "10.0.0.1" => {
1035 "/" => {
1036 "mythweb_id" => {
1037 _expires => 1293917923,
1038 value => "ooRung9dThee3ooyXooM1Ohm",
1039 },
1040 },
1041 },
1042 }
1043
1044=item $date = AnyEvent::HTTP::format_date $timestamp
1045
1046Takes a POSIX timestamp (seconds since the epoch) and formats it as a HTTP
1047Date (RFC 2616).
1048
1049=item $timestamp = AnyEvent::HTTP::parse_date $date
1050
1051Takes a HTTP Date (RFC 2616) or a Cookie date (netscape cookie spec) or a
1052bunch of minor variations of those, and returns the corresponding POSIX
1053timestamp, or C<undef> if the date cannot be parsed.
320 1054
321=item $AnyEvent::HTTP::MAX_RECURSE 1055=item $AnyEvent::HTTP::MAX_RECURSE
322 1056
323The default value for the C<recurse> request parameter (default: C<10>). 1057The default value for the C<recurse> request parameter (default: C<10>).
324 1058
325=item $AnyEvent::HTTP::USERAGENT 1059=item $AnyEvent::HTTP::USERAGENT
326 1060
327The default value for the C<User-Agent> header (the default is 1061The default value for the C<User-Agent> header (the default is
328C<Mozilla/5.0 (compatible; AnyEvent::HTTP/$VERSION; +http://software.schmorp.de/pkg/AnyEvent)>). 1062C<Mozilla/5.0 (compatible; U; AnyEvent-HTTP/$VERSION; +http://software.schmorp.de/pkg/AnyEvent)>).
329 1063
330=item $AnyEvent::HTTP::MAX_PERSISTENT 1064=item $AnyEvent::HTTP::MAX_PER_HOST
331 1065
332The maximum number of persistent connections to keep open (default: 8). 1066The maximum number of concurrent connections to the same host (identified
1067by the hostname). If the limit is exceeded, then the additional requests
1068are queued until previous connections are closed.
333 1069
334Not implemented currently. 1070The default value for this is C<4>, and it is highly advisable to not
1071increase it.
335 1072
336=item $AnyEvent::HTTP::PERSISTENT_TIMEOUT 1073=item $AnyEvent::HTTP::ACTIVE
337 1074
338The maximum time to cache a persistent connection, in seconds (default: 2). 1075The number of active connections. This is not the number of currently
339 1076running requests, but the number of currently open and non-idle TCP
340Not implemented currently. 1077connections. This number of can be useful for load-leveling.
341 1078
342=back 1079=back
343 1080
344=cut 1081=cut
345 1082
1083our @month = qw(Jan Feb Mar Apr May Jun Jul Aug Sep Oct Nov Dec);
1084our @weekday = qw(Sun Mon Tue Wed Thu Fri Sat);
1085
1086sub format_date($) {
1087 my ($time) = @_;
1088
1089 # RFC 822/1123 format
1090 my ($S, $M, $H, $mday, $mon, $year, $wday, $yday, undef) = gmtime $time;
1091
1092 sprintf "%s, %02d %s %04d %02d:%02d:%02d GMT",
1093 $weekday[$wday], $mday, $month[$mon], $year + 1900,
1094 $H, $M, $S;
1095}
1096
1097sub parse_date($) {
1098 my ($date) = @_;
1099
1100 my ($d, $m, $y, $H, $M, $S);
1101
1102 if ($date =~ /^[A-Z][a-z][a-z]+, ([0-9][0-9]?)[\- ]([A-Z][a-z][a-z])[\- ]([0-9][0-9][0-9][0-9]) ([0-9][0-9]?):([0-9][0-9]?):([0-9][0-9]?) GMT$/) {
1103 # RFC 822/1123, required by RFC 2616 (with " ")
1104 # cookie dates (with "-")
1105
1106 ($d, $m, $y, $H, $M, $S) = ($1, $2, $3, $4, $5, $6);
1107
1108 } elsif ($date =~ /^[A-Z][a-z][a-z]+, ([0-9][0-9]?)-([A-Z][a-z][a-z])-([0-9][0-9]) ([0-9][0-9]?):([0-9][0-9]?):([0-9][0-9]?) GMT$/) {
1109 # RFC 850
1110 ($d, $m, $y, $H, $M, $S) = ($1, $2, $3 < 69 ? $3 + 2000 : $3 + 1900, $4, $5, $6);
1111
1112 } elsif ($date =~ /^[A-Z][a-z][a-z]+ ([A-Z][a-z][a-z]) ([0-9 ]?[0-9]) ([0-9][0-9]?):([0-9][0-9]?):([0-9][0-9]?) ([0-9][0-9][0-9][0-9])$/) {
1113 # ISO C's asctime
1114 ($d, $m, $y, $H, $M, $S) = ($2, $1, $6, $3, $4, $5);
1115 }
1116 # other formats fail in the loop below
1117
1118 for (0..11) {
1119 if ($m eq $month[$_]) {
1120 require Time::Local;
1121 return Time::Local::timegm ($S, $M, $H, $d, $_, $y);
1122 }
1123 }
1124
1125 undef
1126}
1127
346sub set_proxy($) { 1128sub set_proxy($) {
1129 if (length $_[0]) {
347 $PROXY = [$2, $3 || 3128, $1] if $_[0] =~ m%^(https?):// ([^:/]+) (?: : (\d*) )?%ix; 1130 $_[0] =~ m%^(https?):// ([^:/]+) (?: : (\d*) )?%ix
1131 or Carp::croak "$_[0]: invalid proxy URL";
1132 $PROXY = [$2, $3 || 3128, $1]
1133 } else {
1134 undef $PROXY;
1135 }
348} 1136}
349 1137
350# initialise proxy from environment 1138# initialise proxy from environment
1139eval {
351set_proxy $ENV{http_proxy}; 1140 set_proxy $ENV{http_proxy};
1141};
1142
1143=head2 SOCKS PROXIES
1144
1145Socks proxies are not directly supported by AnyEvent::HTTP. You can
1146compile your perl to support socks, or use an external program such as
1147F<socksify> (dante) or F<tsocks> to make your program use a socks proxy
1148transparently.
1149
1150Alternatively, for AnyEvent::HTTP only, you can use your own
1151C<tcp_connect> function that does the proxy handshake - here is an example
1152that works with socks4a proxies:
1153
1154 use Errno;
1155 use AnyEvent::Util;
1156 use AnyEvent::Socket;
1157 use AnyEvent::Handle;
1158
1159 # host, port and username of/for your socks4a proxy
1160 my $socks_host = "10.0.0.23";
1161 my $socks_port = 9050;
1162 my $socks_user = "";
1163
1164 sub socks4a_connect {
1165 my ($host, $port, $connect_cb, $prepare_cb) = @_;
1166
1167 my $hdl = new AnyEvent::Handle
1168 connect => [$socks_host, $socks_port],
1169 on_prepare => sub { $prepare_cb->($_[0]{fh}) },
1170 on_error => sub { $connect_cb->() },
1171 ;
1172
1173 $hdl->push_write (pack "CCnNZ*Z*", 4, 1, $port, 1, $socks_user, $host);
1174
1175 $hdl->push_read (chunk => 8, sub {
1176 my ($hdl, $chunk) = @_;
1177 my ($status, $port, $ipn) = unpack "xCna4", $chunk;
1178
1179 if ($status == 0x5a) {
1180 $connect_cb->($hdl->{fh}, (format_address $ipn) . ":$port");
1181 } else {
1182 $! = Errno::ENXIO; $connect_cb->();
1183 }
1184 });
1185
1186 $hdl
1187 }
1188
1189Use C<socks4a_connect> instead of C<tcp_connect> when doing C<http_request>s,
1190possibly after switching off other proxy types:
1191
1192 AnyEvent::HTTP::set_proxy undef; # usually you do not want other proxies
1193
1194 http_get 'http://www.google.com', tcp_connect => \&socks4a_connect, sub {
1195 my ($data, $headers) = @_;
1196 ...
1197 };
352 1198
353=head1 SEE ALSO 1199=head1 SEE ALSO
354 1200
355L<AnyEvent>. 1201L<AnyEvent>.
356 1202
357=head1 AUTHOR 1203=head1 AUTHOR
358 1204
359 Marc Lehmann <schmorp@schmorp.de> 1205 Marc Lehmann <schmorp@schmorp.de>
360 http://home.schmorp.de/ 1206 http://home.schmorp.de/
1207
1208With many thanks to Дмитрий Шалашов, who provided countless
1209testcases and bugreports.
361 1210
362=cut 1211=cut
363 1212
3641 12131
365 1214

Diff Legend

Removed lines
+ Added lines
< Changed lines
> Changed lines