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.18 by root, Fri Jun 6 16:23:57 2008 UTC vs.
Revision 1.77 by root, Sat Jan 1 19:13:41 2011 UTC

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

Diff Legend

Removed lines
+ Added lines
< Changed lines
> Changed lines