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.55 by root, Wed Jun 16 19:17:30 2010 UTC vs.
Revision 1.135 by root, Mon Sep 10 07:03:12 2018 UTC

15This 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
16run a supported event loop. 16run a supported event loop.
17 17
18This module implements a simple, stateless and non-blocking HTTP 18This module implements a simple, stateless and non-blocking HTTP
19client. It supports GET, POST and other request methods, cookies and more, 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 20all on a very low level. It can follow redirects, supports proxies, and
21automatically limits the number of connections to the values specified in 21automatically limits the number of connections to the values specified in
22the RFC. 22the RFC.
23 23
24It should generally be a "good client" that is enough for most HTTP 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 25tasks. Simple tasks should be simple, but complex tasks should still be
36 36
37=cut 37=cut
38 38
39package AnyEvent::HTTP; 39package AnyEvent::HTTP;
40 40
41use strict; 41use common::sense;
42no warnings;
43 42
44use Errno (); 43use Errno ();
45 44
46use AnyEvent 5.0 (); 45use AnyEvent 5.0 ();
47use AnyEvent::Util (); 46use AnyEvent::Util ();
48use AnyEvent::Socket ();
49use AnyEvent::Handle (); 47use AnyEvent::Handle ();
50 48
51use base Exporter::; 49use base Exporter::;
52 50
53our $VERSION = '1.45'; 51our $VERSION = 2.24;
54 52
55our @EXPORT = qw(http_get http_post http_head http_request); 53our @EXPORT = qw(http_get http_post http_head http_request);
56 54
57our $USERAGENT = "Mozilla/5.0 (compatible; U; AnyEvent-HTTP/$VERSION; +http://software.schmorp.de/pkg/AnyEvent)"; 55our $USERAGENT = "Mozilla/5.0 (compatible; U; AnyEvent-HTTP/$VERSION; +http://software.schmorp.de/pkg/AnyEvent)";
58our $MAX_RECURSE = 10; 56our $MAX_RECURSE = 10;
59our $MAX_PERSISTENT = 8;
60our $PERSISTENT_TIMEOUT = 2; 57our $PERSISTENT_TIMEOUT = 3;
61our $TIMEOUT = 300; 58our $TIMEOUT = 300;
62 59our $MAX_PER_HOST = 4; # changing this is evil
63# changing these is evil
64our $MAX_PERSISTENT_PER_HOST = 0;
65our $MAX_PER_HOST = 4;
66 60
67our $PROXY; 61our $PROXY;
68our $ACTIVE = 0; 62our $ACTIVE = 0;
69 63
70my %KA_COUNT; # number of open keep-alive connections per host 64my %KA_CACHE; # indexed by uhost currently, points to [$handle...] array
71my %CO_SLOT; # number of open connections, and wait queue, per host 65my %CO_SLOT; # number of open connections, and wait queue, per host
72 66
73=item http_get $url, key => value..., $cb->($data, $headers) 67=item http_get $url, key => value..., $cb->($data, $headers)
74 68
75Executes an HTTP-GET request. See the http_request function for details on 69Executes an HTTP-GET request. See the http_request function for details on
92must be an absolute http or https URL. 86must be an absolute http or https URL.
93 87
94When called in void context, nothing is returned. In other contexts, 88When called in void context, nothing is returned. In other contexts,
95C<http_request> returns a "cancellation guard" - you have to keep the 89C<http_request> returns a "cancellation guard" - you have to keep the
96object at least alive until the callback get called. If the object gets 90object at least alive until the callback get called. If the object gets
97destroyed before the callbakc is called, the request will be cancelled. 91destroyed before the callback is called, the request will be cancelled.
98 92
99The callback will be called with the response body data as first argument 93The callback will be called with the response body data as first argument
100(or C<undef> if an error occured), and a hash-ref with response headers as 94(or C<undef> if an error occurred), and a hash-ref with response headers
101second argument. 95(and trailers) as second argument.
102 96
103All the headers in that hash are lowercased. In addition to the response 97All the headers in that hash are lowercased. In addition to the response
104headers, the "pseudo-headers" (uppercase to avoid clashing with possible 98headers, the "pseudo-headers" (uppercase to avoid clashing with possible
105response headers) C<HTTPVersion>, C<Status> and C<Reason> contain the 99response headers) C<HTTPVersion>, C<Status> and C<Reason> contain the
106three parts of the HTTP Status-Line of the same name. 100three parts of the HTTP Status-Line of the same name. If an error occurs
101during the body phase of a request, then the original C<Status> and
102C<Reason> values from the header are available as C<OrigStatus> and
103C<OrigReason>.
107 104
108The pseudo-header C<URL> contains the actual URL (which can differ from 105The pseudo-header C<URL> contains the actual URL (which can differ from
109the requested URL when following redirects - for example, you might get 106the requested URL when following redirects - for example, you might get
110an error that your URL scheme is not supported even though your URL is a 107an error that your URL scheme is not supported even though your URL is a
111valid http URL because it redirected to an ftp URL, in which case you can 108valid http URL because it redirected to an ftp URL, in which case you can
120 117
121If the server sends a header multiple times, then their contents will be 118If the server sends a header multiple times, then their contents will be
122joined together with a comma (C<,>), as per the HTTP spec. 119joined together with a comma (C<,>), as per the HTTP spec.
123 120
124If an internal error occurs, such as not being able to resolve a hostname, 121If an internal error occurs, such as not being able to resolve a hostname,
125then C<$data> will be C<undef>, C<< $headers->{Status} >> will be C<59x> 122then C<$data> will be C<undef>, C<< $headers->{Status} >> will be
126(usually C<599>) and the C<Reason> pseudo-header will contain an error 123C<590>-C<599> and the C<Reason> pseudo-header will contain an error
127message. 124message. Currently the following status codes are used:
125
126=over 4
127
128=item 595 - errors during connection establishment, proxy handshake.
129
130=item 596 - errors during TLS negotiation, request sending and header processing.
131
132=item 597 - errors during body receiving or processing.
133
134=item 598 - user aborted request via C<on_header> or C<on_body>.
135
136=item 599 - other, usually nonretryable, errors (garbled URL etc.).
137
138=back
128 139
129A typical callback might look like this: 140A typical callback might look like this:
130 141
131 sub { 142 sub {
132 my ($body, $hdr) = @_; 143 my ($body, $hdr) = @_;
143 154
144=over 4 155=over 4
145 156
146=item recurse => $count (default: $MAX_RECURSE) 157=item recurse => $count (default: $MAX_RECURSE)
147 158
148Whether to recurse requests or not, e.g. on redirects, authentication 159Whether to recurse requests or not, e.g. on redirects, authentication and
149retries and so on, and how often to do so. 160other retries and so on, and how often to do so.
161
162Only redirects to http and https URLs are supported. While most common
163redirection forms are handled entirely within this module, some require
164the use of the optional L<URI> module. If it is required but missing, then
165the request will fail with an error.
150 166
151=item headers => hashref 167=item headers => hashref
152 168
153The request headers to use. Currently, C<http_request> may provide its 169The request headers to use. Currently, C<http_request> may provide its own
154own C<Host:>, C<Content-Length:>, C<Connection:> and C<Cookie:> headers 170C<Host:>, C<Content-Length:>, C<Connection:> and C<Cookie:> headers and
155and will provide defaults for C<User-Agent:> and C<Referer:> (this can be 171will provide defaults at least for C<TE:>, C<Referer:> and C<User-Agent:>
156suppressed by using C<undef> for these headers in which case they won't be 172(this can be suppressed by using C<undef> for these headers in which case
157sent at all). 173they won't be sent at all).
174
175You really should provide your own C<User-Agent:> header value that is
176appropriate for your program - I wouldn't be surprised if the default
177AnyEvent string gets blocked by webservers sooner or later.
178
179Also, make sure that your headers names and values do not contain any
180embedded newlines.
158 181
159=item timeout => $seconds 182=item timeout => $seconds
160 183
161The time-out to use for various stages - each connect attempt will reset 184The time-out to use for various stages - each connect attempt will reset
162the timeout, as will read or write activity, i.e. this is not an overall 185the timeout, as will read or write activity, i.e. this is not an overall
164 187
165Default timeout is 5 minutes. 188Default timeout is 5 minutes.
166 189
167=item proxy => [$host, $port[, $scheme]] or undef 190=item proxy => [$host, $port[, $scheme]] or undef
168 191
169Use the given http proxy for all requests. If not specified, then the 192Use the given http proxy for all requests, or no proxy if C<undef> is
170default proxy (as specified by C<$ENV{http_proxy}>) is used. 193used.
171 194
172C<$scheme> must be either missing, C<http> for HTTP or C<https> for 195C<$scheme> must be either missing or must be C<http> for HTTP.
173HTTPS. 196
197If not specified, then the default proxy is used (see
198C<AnyEvent::HTTP::set_proxy>).
199
200Currently, if your proxy requires authorization, you have to specify an
201appropriate "Proxy-Authorization" header in every request.
202
203Note that this module will prefer an existing persistent connection,
204even if that connection was made using another proxy. If you need to
205ensure that a new conneciton is made in this case, you can either force
206C<persistent> to false or e.g. use the proxy address in your C<sessionid>.
174 207
175=item body => $string 208=item body => $string
176 209
177The request body, usually empty. Will be-sent as-is (future versions of 210The request body, usually empty. Will be sent as-is (future versions of
178this module might offer more options). 211this module might offer more options).
179 212
180=item cookie_jar => $hash_ref 213=item cookie_jar => $hash_ref
181 214
182Passing this parameter enables (simplified) cookie-processing, loosely 215Passing this parameter enables (simplified) cookie-processing, loosely
183based on the original netscape specification. 216based on the original netscape specification.
184 217
185The C<$hash_ref> must be an (initially empty) hash reference which will 218The C<$hash_ref> must be an (initially empty) hash reference which
186get updated automatically. It is possible to save the cookie_jar to 219will get updated automatically. It is possible to save the cookie jar
187persistent storage with something like JSON or Storable, but this is not 220to persistent storage with something like JSON or Storable - see the
188recommended, as expiry times are currently being ignored. 221C<AnyEvent::HTTP::cookie_jar_expire> function if you wish to remove
222expired or session-only cookies, and also for documentation on the format
223of the cookie jar.
189 224
190Note that this cookie implementation is not of very high quality, nor 225Note that this cookie implementation is not meant to be complete. If
191meant to be complete. If you want complete cookie management you have to 226you want complete cookie management you have to do that on your
192do that on your own. C<cookie_jar> is meant as a quick fix to get some 227own. C<cookie_jar> is meant as a quick fix to get most cookie-using sites
193cookie-using sites working. Cookies are a privacy disaster, do not use 228working. Cookies are a privacy disaster, do not use them unless required
194them unless required to. 229to.
230
231When cookie processing is enabled, the C<Cookie:> and C<Set-Cookie:>
232headers will be set and handled by this module, otherwise they will be
233left untouched.
195 234
196=item tls_ctx => $scheme | $tls_ctx 235=item tls_ctx => $scheme | $tls_ctx
197 236
198Specifies the AnyEvent::TLS context to be used for https connections. This 237Specifies the AnyEvent::TLS context to be used for https connections. This
199parameter follows the same rules as the C<tls_ctx> parameter to 238parameter follows the same rules as the C<tls_ctx> parameter to
203verification) TLS context. 242verification) TLS context.
204 243
205The default for this option is C<low>, which could be interpreted as "give 244The default for this option is C<low>, which could be interpreted as "give
206me the page, no matter what". 245me the page, no matter what".
207 246
247See also the C<sessionid> parameter.
248
249=item sessionid => $string
250
251The module might reuse connections to the same host internally (regardless
252of other settings, such as C<tcp_connect> or C<proxy>). Sometimes (e.g.
253when using TLS or a specfic proxy), you do not want to reuse connections
254from other sessions. This can be achieved by setting this parameter to
255some unique ID (such as the address of an object storing your state data
256or the TLS context, or the proxy IP) - only connections using the same
257unique ID will be reused.
258
208=item on_prepare => $callback->($fh) 259=item on_prepare => $callback->($fh)
209 260
210In rare cases you need to "tune" the socket before it is used to 261In rare cases you need to "tune" the socket before it is used to
211connect (for exmaple, to bind it on a given IP address). This parameter 262connect (for example, to bind it on a given IP address). This parameter
212overrides the prepare callback passed to C<AnyEvent::Socket::tcp_connect> 263overrides the prepare callback passed to C<AnyEvent::Socket::tcp_connect>
213and behaves exactly the same way (e.g. it has to provide a 264and behaves exactly the same way (e.g. it has to provide a
214timeout). See the description for the C<$prepare_cb> argument of 265timeout). See the description for the C<$prepare_cb> argument of
215C<AnyEvent::Socket::tcp_connect> for details. 266C<AnyEvent::Socket::tcp_connect> for details.
216 267
268=item tcp_connect => $callback->($host, $service, $connect_cb, $prepare_cb)
269
270In even rarer cases you want total control over how AnyEvent::HTTP
271establishes connections. Normally it uses L<AnyEvent::Socket::tcp_connect>
272to do this, but you can provide your own C<tcp_connect> function -
273obviously, it has to follow the same calling conventions, except that it
274may always return a connection guard object.
275
276The connections made by this hook will be treated as equivalent to
277connecitons made the built-in way, specifically, they will be put into
278and taken from the persistent conneciton cache. If your C<$tcp_connect>
279function is incompatible with this kind of re-use, consider switching off
280C<persistent> connections and/or providing a C<sessionid> identifier.
281
282There are probably lots of weird uses for this function, starting from
283tracing the hosts C<http_request> actually tries to connect, to (inexact
284but fast) host => IP address caching or even socks protocol support.
285
217=item on_header => $callback->($headers) 286=item on_header => $callback->($headers)
218 287
219When specified, this callback will be called with the header hash as soon 288When specified, this callback will be called with the header hash as soon
220as headers have been successfully received from the remote server (not on 289as headers have been successfully received from the remote server (not on
221locally-generated errors). 290locally-generated errors).
226 295
227This callback is useful, among other things, to quickly reject unwanted 296This callback is useful, among other things, to quickly reject unwanted
228content, which, if it is supposed to be rare, can be faster than first 297content, which, if it is supposed to be rare, can be faster than first
229doing a C<HEAD> request. 298doing a C<HEAD> request.
230 299
300The downside is that cancelling the request makes it impossible to re-use
301the connection. Also, the C<on_header> callback will not receive any
302trailer (headers sent after the response body).
303
231Example: cancel the request unless the content-type is "text/html". 304Example: cancel the request unless the content-type is "text/html".
232 305
233 on_header => sub { 306 on_header => sub {
234 $_[0]{"content-type"} =~ /^text\/html\s*(?:;|$)/ 307 $_[0]{"content-type"} =~ /^text\/html\s*(?:;|$)/
235 }, 308 },
241string instead of the body data. 314string instead of the body data.
242 315
243It has to return either true (in which case AnyEvent::HTTP will continue), 316It has to return either true (in which case AnyEvent::HTTP will continue),
244or false, in which case AnyEvent::HTTP will cancel the download (and call 317or false, in which case AnyEvent::HTTP will cancel the download (and call
245the completion callback with an error code of C<598>). 318the completion callback with an error code of C<598>).
319
320The downside to cancelling the request is that it makes it impossible to
321re-use the connection.
246 322
247This callback is useful when the data is too large to be held in memory 323This callback is useful when the data is too large to be held in memory
248(so the callback writes it to a file) or when only some information should 324(so the callback writes it to a file) or when only some information should
249be extracted, or when the body should be processed incrementally. 325be extracted, or when the body should be processed incrementally.
250 326
262called. Instead of the C<$body> argument containing the body data, the 338called. Instead of the C<$body> argument containing the body data, the
263callback will receive the L<AnyEvent::Handle> object associated with the 339callback will receive the L<AnyEvent::Handle> object associated with the
264connection. In error cases, C<undef> will be passed. When there is no body 340connection. In error cases, C<undef> will be passed. When there is no body
265(e.g. status C<304>), the empty string will be passed. 341(e.g. status C<304>), the empty string will be passed.
266 342
267The handle object might or might not be in TLS mode, might be connected to 343The handle object might or might not be in TLS mode, might be connected
268a proxy, be a persistent connection etc., and configured in unspecified 344to a proxy, be a persistent connection, use chunked transfer encoding
269ways. The user is responsible for this handle (it will not be used by this 345etc., and configured in unspecified ways. The user is responsible for this
270module anymore). 346handle (it will not be used by this module anymore).
271 347
272This is useful with some push-type services, where, after the initial 348This is useful with some push-type services, where, after the initial
273headers, an interactive protocol is used (typical example would be the 349headers, an interactive protocol is used (typical example would be the
274push-style twitter API which starts a JSON/XML stream). 350push-style twitter API which starts a JSON/XML stream).
275 351
276If you think you need this, first have a look at C<on_body>, to see if 352If you think you need this, first have a look at C<on_body>, to see if
277that doesn't solve your problem in a better way. 353that doesn't solve your problem in a better way.
278 354
355=item persistent => $boolean
356
357Try to create/reuse a persistent connection. When this flag is set
358(default: true for idempotent requests, false for all others), then
359C<http_request> tries to re-use an existing (previously-created)
360persistent connection to same host (i.e. identical URL scheme, hostname,
361port and sessionid) and, failing that, tries to create a new one.
362
363Requests failing in certain ways will be automatically retried once, which
364is dangerous for non-idempotent requests, which is why it defaults to off
365for them. The reason for this is because the bozos who designed HTTP/1.1
366made it impossible to distinguish between a fatal error and a normal
367connection timeout, so you never know whether there was a problem with
368your request or not.
369
370When reusing an existent connection, many parameters (such as TLS context)
371will be ignored. See the C<sessionid> parameter for a workaround.
372
373=item keepalive => $boolean
374
375Only used when C<persistent> is also true. This parameter decides whether
376C<http_request> tries to handshake a HTTP/1.0-style keep-alive connection
377(as opposed to only a HTTP/1.1 persistent connection).
378
379The default is true, except when using a proxy, in which case it defaults
380to false, as HTTP/1.0 proxies cannot support this in a meaningful way.
381
382=item handle_params => { key => value ... }
383
384The key-value pairs in this hash will be passed to any L<AnyEvent::Handle>
385constructor that is called - not all requests will create a handle, and
386sometimes more than one is created, so this parameter is only good for
387setting hints.
388
389Example: set the maximum read size to 4096, to potentially conserve memory
390at the cost of speed.
391
392 handle_params => {
393 max_read_size => 4096,
394 },
395
279=back 396=back
280 397
281Example: make a simple HTTP GET request for http://www.nethype.de/ 398Example: do a simple HTTP GET request for http://www.nethype.de/ and print
399the response body.
282 400
283 http_request GET => "http://www.nethype.de/", sub { 401 http_request GET => "http://www.nethype.de/", sub {
284 my ($body, $hdr) = @_; 402 my ($body, $hdr) = @_;
285 print "$body\n"; 403 print "$body\n";
286 }; 404 };
287 405
288Example: make a HTTP HEAD request on https://www.google.com/, use a 406Example: do a HTTP HEAD request on https://www.google.com/, use a
289timeout of 30 seconds. 407timeout of 30 seconds.
290 408
291 http_request 409 http_request
292 GET => "https://www.google.com", 410 HEAD => "https://www.google.com",
411 headers => { "user-agent" => "MySearchClient 1.0" },
293 timeout => 30, 412 timeout => 30,
294 sub { 413 sub {
295 my ($body, $hdr) = @_; 414 my ($body, $hdr) = @_;
296 use Data::Dumper; 415 use Data::Dumper;
297 print Dumper $hdr; 416 print Dumper $hdr;
298 } 417 }
299 ; 418 ;
300 419
301Example: make another simple HTTP GET request, but immediately try to 420Example: do another simple HTTP GET request, but immediately try to
302cancel it. 421cancel it.
303 422
304 my $request = http_request GET => "http://www.nethype.de/", sub { 423 my $request = http_request GET => "http://www.nethype.de/", sub {
305 my ($body, $hdr) = @_; 424 my ($body, $hdr) = @_;
306 print "$body\n"; 425 print "$body\n";
307 }; 426 };
308 427
309 undef $request; 428 undef $request;
310 429
311=cut 430=cut
431
432#############################################################################
433# wait queue/slots
312 434
313sub _slot_schedule; 435sub _slot_schedule;
314sub _slot_schedule($) { 436sub _slot_schedule($) {
315 my $host = shift; 437 my $host = shift;
316 438
338 push @{ $CO_SLOT{$_[0]}[1] }, $_[1]; 460 push @{ $CO_SLOT{$_[0]}[1] }, $_[1];
339 461
340 _slot_schedule $_[0]; 462 _slot_schedule $_[0];
341} 463}
342 464
343our $qr_nl = qr{\015?\012}; 465#############################################################################
466# cookie handling
467
468# expire cookies
469sub cookie_jar_expire($;$) {
470 my ($jar, $session_end) = @_;
471
472 %$jar = () if $jar->{version} != 2;
473
474 my $anow = AE::now;
475
476 while (my ($chost, $paths) = each %$jar) {
477 next unless ref $paths;
478
479 while (my ($cpath, $cookies) = each %$paths) {
480 while (my ($cookie, $kv) = each %$cookies) {
481 if (exists $kv->{_expires}) {
482 delete $cookies->{$cookie}
483 if $anow > $kv->{_expires};
484 } elsif ($session_end) {
485 delete $cookies->{$cookie};
486 }
487 }
488
489 delete $paths->{$cpath}
490 unless %$cookies;
491 }
492
493 delete $jar->{$chost}
494 unless %$paths;
495 }
496}
497
498# extract cookies from jar
499sub cookie_jar_extract($$$$) {
500 my ($jar, $scheme, $host, $path) = @_;
501
502 %$jar = () if $jar->{version} != 2;
503
504 $host = AnyEvent::Util::idn_to_ascii $host
505 if $host =~ /[^\x00-\x7f]/;
506
507 my @cookies;
508
509 while (my ($chost, $paths) = each %$jar) {
510 next unless ref $paths;
511
512 # exact match or suffix including . match
513 $chost eq $host or ".$chost" eq substr $host, -1 - length $chost
514 or next;
515
516 while (my ($cpath, $cookies) = each %$paths) {
517 next unless $cpath eq substr $path, 0, length $cpath;
518
519 while (my ($cookie, $kv) = each %$cookies) {
520 next if $scheme ne "https" && exists $kv->{secure};
521
522 if (exists $kv->{_expires} and AE::now > $kv->{_expires}) {
523 delete $cookies->{$cookie};
524 next;
525 }
526
527 my $value = $kv->{value};
528
529 if ($value =~ /[=;,[:space:]]/) {
530 $value =~ s/([\\"])/\\$1/g;
531 $value = "\"$value\"";
532 }
533
534 push @cookies, "$cookie=$value";
535 }
536 }
537 }
538
539 \@cookies
540}
541
542# parse set_cookie header into jar
543sub cookie_jar_set_cookie($$$$) {
544 my ($jar, $set_cookie, $host, $date) = @_;
545
546 %$jar = () if $jar->{version} != 2;
547
548 my $anow = int AE::now;
549 my $snow; # server-now
550
551 for ($set_cookie) {
552 # parse NAME=VALUE
553 my @kv;
554
555 # expires is not http-compliant in the original cookie-spec,
556 # we support the official date format and some extensions
557 while (
558 m{
559 \G\s*
560 (?:
561 expires \s*=\s* ([A-Z][a-z][a-z]+,\ [^,;]+)
562 | ([^=;,[:space:]]+) (?: \s*=\s* (?: "((?:[^\\"]+|\\.)*)" | ([^;,[:space:]]*) ) )?
563 )
564 }gcxsi
565 ) {
566 my $name = $2;
567 my $value = $4;
568
569 if (defined $1) {
570 # expires
571 $name = "expires";
572 $value = $1;
573 } elsif (defined $3) {
574 # quoted
575 $value = $3;
576 $value =~ s/\\(.)/$1/gs;
577 }
578
579 push @kv, @kv ? lc $name : $name, $value;
580
581 last unless /\G\s*;/gc;
582 }
583
584 last unless @kv;
585
586 my $name = shift @kv;
587 my %kv = (value => shift @kv, @kv);
588
589 if (exists $kv{"max-age"}) {
590 $kv{_expires} = $anow + delete $kv{"max-age"};
591 } elsif (exists $kv{expires}) {
592 $snow ||= parse_date ($date) || $anow;
593 $kv{_expires} = $anow + (parse_date (delete $kv{expires}) - $snow);
594 } else {
595 delete $kv{_expires};
596 }
597
598 my $cdom;
599 my $cpath = (delete $kv{path}) || "/";
600
601 if (exists $kv{domain}) {
602 $cdom = $kv{domain};
603
604 $cdom =~ s/^\.?/./; # make sure it starts with a "."
605
606 next if $cdom =~ /\.$/;
607
608 # this is not rfc-like and not netscape-like. go figure.
609 my $ndots = $cdom =~ y/.//;
610 next if $ndots < ($cdom =~ /\.[^.][^.]\.[^.][^.]$/ ? 3 : 2);
611
612 $cdom = substr $cdom, 1; # remove initial .
613 } else {
614 $cdom = $host;
615 }
616
617 # store it
618 $jar->{version} = 2;
619 $jar->{lc $cdom}{$cpath}{$name} = \%kv;
620
621 redo if /\G\s*,/gc;
622 }
623}
624
625#############################################################################
626# keepalive/persistent connection cache
627
628# fetch a connection from the keepalive cache
629sub ka_fetch($) {
630 my $ka_key = shift;
631
632 my $hdl = pop @{ $KA_CACHE{$ka_key} }; # currently we reuse the MOST RECENTLY USED connection
633 delete $KA_CACHE{$ka_key}
634 unless @{ $KA_CACHE{$ka_key} };
635
636 $hdl
637}
638
639sub ka_store($$) {
640 my ($ka_key, $hdl) = @_;
641
642 my $kaa = $KA_CACHE{$ka_key} ||= [];
643
644 my $destroy = sub {
645 my @ka = grep $_ != $hdl, @{ $KA_CACHE{$ka_key} };
646
647 $hdl->destroy;
648
649 @ka
650 ? $KA_CACHE{$ka_key} = \@ka
651 : delete $KA_CACHE{$ka_key};
652 };
653
654 # on error etc., destroy
655 $hdl->on_error ($destroy);
656 $hdl->on_eof ($destroy);
657 $hdl->on_read ($destroy);
658 $hdl->timeout ($PERSISTENT_TIMEOUT);
659
660 push @$kaa, $hdl;
661 shift @$kaa while @$kaa > $MAX_PER_HOST;
662}
663
664#############################################################################
665# utilities
666
667# continue to parse $_ for headers and place them into the arg
668sub _parse_hdr() {
669 my %hdr;
670
671 # things seen, not parsed:
672 # p3pP="NON CUR OTPi OUR NOR UNI"
673
674 $hdr{lc $1} .= ",$2"
675 while /\G
676 ([^:\000-\037]*):
677 [\011\040]*
678 ((?: [^\012]+ | \012[\011\040] )*)
679 \012
680 /gxc;
681
682 /\G$/
683 or return;
684
685 # remove the "," prefix we added to all headers above
686 substr $_, 0, 1, ""
687 for values %hdr;
688
689 \%hdr
690}
691
692#############################################################################
693# http_get
694
344our $qr_nlnl = qr{(?<![^\012])\015?\012}; 695our $qr_nlnl = qr{(?<![^\012])\015?\012};
345 696
346our $TLS_CTX_LOW = { cache => 1, sslv2 => 1 }; 697our $TLS_CTX_LOW = { cache => 1, sslv2 => 1 };
347our $TLS_CTX_HIGH = { cache => 1, verify => 1, verify_peername => "https" }; 698our $TLS_CTX_HIGH = { cache => 1, verify => 1, verify_peername => "https" };
699
700# maybe it should just become a normal object :/
701
702sub _destroy_state(\%) {
703 my ($state) = @_;
704
705 $state->{handle}->destroy if $state->{handle};
706 %$state = ();
707}
708
709sub _error(\%$$) {
710 my ($state, $cb, $hdr) = @_;
711
712 &_destroy_state ($state);
713
714 $cb->(undef, $hdr);
715 ()
716}
717
718our %IDEMPOTENT = (
719 DELETE => 1,
720 GET => 1,
721 HEAD => 1,
722 OPTIONS => 1,
723 PUT => 1,
724 TRACE => 1,
725
726 ACL => 1,
727 "BASELINE-CONTROL" => 1,
728 BIND => 1,
729 CHECKIN => 1,
730 CHECKOUT => 1,
731 COPY => 1,
732 LABEL => 1,
733 LINK => 1,
734 MERGE => 1,
735 MKACTIVITY => 1,
736 MKCALENDAR => 1,
737 MKCOL => 1,
738 MKREDIRECTREF => 1,
739 MKWORKSPACE => 1,
740 MOVE => 1,
741 ORDERPATCH => 1,
742 PROPFIND => 1,
743 PROPPATCH => 1,
744 REBIND => 1,
745 REPORT => 1,
746 SEARCH => 1,
747 UNBIND => 1,
748 UNCHECKOUT => 1,
749 UNLINK => 1,
750 UNLOCK => 1,
751 UPDATE => 1,
752 UPDATEREDIRECTREF => 1,
753 "VERSION-CONTROL" => 1,
754);
348 755
349sub http_request($$@) { 756sub http_request($$@) {
350 my $cb = pop; 757 my $cb = pop;
351 my ($method, $url, %arg) = @_; 758 my ($method, $url, %arg) = @_;
352 759
367 my @pseudo = (URL => $url); 774 my @pseudo = (URL => $url);
368 push @pseudo, Redirect => delete $arg{Redirect} if exists $arg{Redirect}; 775 push @pseudo, Redirect => delete $arg{Redirect} if exists $arg{Redirect};
369 776
370 my $recurse = exists $arg{recurse} ? delete $arg{recurse} : $MAX_RECURSE; 777 my $recurse = exists $arg{recurse} ? delete $arg{recurse} : $MAX_RECURSE;
371 778
372 return $cb->(undef, { Status => 599, Reason => "Too many redirections", @pseudo }) 779 return $cb->(undef, { @pseudo, Status => 599, Reason => "Too many redirections" })
373 if $recurse < 0; 780 if $recurse < 0;
374 781
375 my $proxy = $arg{proxy} || $PROXY; 782 my $proxy = exists $arg{proxy} ? $arg{proxy} : $PROXY;
376 my $timeout = $arg{timeout} || $TIMEOUT; 783 my $timeout = $arg{timeout} || $TIMEOUT;
377 784
378 my ($uscheme, $uauthority, $upath, $query, $fragment) = 785 my ($uscheme, $uauthority, $upath, $query, undef) = # ignore fragment
379 $url =~ m|(?:([^:/?#]+):)?(?://([^/?#]*))?([^?#]*)(?:\?([^#]*))?(?:#(.*))?|; 786 $url =~ m|^([^:]+):(?://([^/?#]*))?([^?#]*)(?:(\?[^#]*))?(?:#(.*))?$|;
380 787
381 $uscheme = lc $uscheme; 788 $uscheme = lc $uscheme;
382 789
383 my $uport = $uscheme eq "http" ? 80 790 my $uport = $uscheme eq "http" ? 80
384 : $uscheme eq "https" ? 443 791 : $uscheme eq "https" ? 443
385 : return $cb->(undef, { Status => 599, Reason => "Only http and https URL schemes supported", @pseudo }); 792 : return $cb->(undef, { @pseudo, Status => 599, Reason => "Only http and https URL schemes supported" });
386 793
387 $uauthority =~ /^(?: .*\@ )? ([^\@:]+) (?: : (\d+) )?$/x 794 $uauthority =~ /^(?: .*\@ )? ([^\@]+?) (?: : (\d+) )?$/x
388 or return $cb->(undef, { Status => 599, Reason => "Unparsable URL", @pseudo }); 795 or return $cb->(undef, { @pseudo, Status => 599, Reason => "Unparsable URL" });
389 796
390 my $uhost = $1; 797 my $uhost = lc $1;
391 $uport = $2 if defined $2; 798 $uport = $2 if defined $2;
392 799
393 $hdr{host} = defined $2 ? "$uhost:$2" : "$uhost" 800 $hdr{host} = defined $2 ? "$uhost:$2" : "$uhost"
394 unless exists $hdr{host}; 801 unless exists $hdr{host};
395 802
396 $uhost =~ s/^\[(.*)\]$/$1/; 803 $uhost =~ s/^\[(.*)\]$/$1/;
397 $upath .= "?$query" if length $query; 804 $upath .= $query if length $query;
398 805
399 $upath =~ s%^/?%/%; 806 $upath =~ s%^/?%/%;
400 807
401 # cookie processing 808 # cookie processing
402 if (my $jar = $arg{cookie_jar}) { 809 if (my $jar = $arg{cookie_jar}) {
403 %$jar = () if $jar->{version} != 1; 810 my $cookies = cookie_jar_extract $jar, $uscheme, $uhost, $upath;
404 811
405 my @cookie;
406
407 while (my ($chost, $v) = each %$jar) {
408 if ($chost =~ /^\./) {
409 next unless $chost eq substr $uhost, -length $chost;
410 } elsif ($chost =~ /\./) {
411 next unless $chost eq $uhost;
412 } else {
413 next;
414 }
415
416 while (my ($cpath, $v) = each %$v) {
417 next unless $cpath eq substr $upath, 0, length $cpath;
418
419 while (my ($k, $v) = each %$v) {
420 next if $uscheme ne "https" && exists $v->{secure};
421 my $value = $v->{value};
422 $value =~ s/([\\"])/\\$1/g;
423 push @cookie, "$k=\"$value\"";
424 }
425 }
426 }
427
428 $hdr{cookie} = join "; ", @cookie 812 $hdr{cookie} = join "; ", @$cookies
429 if @cookie; 813 if @$cookies;
430 } 814 }
431 815
432 my ($rhost, $rport, $rscheme, $rpath); # request host, port, path 816 my ($rhost, $rport, $rscheme, $rpath); # request host, port, path
433 817
434 if ($proxy) { 818 if ($proxy) {
437 $rscheme = "http" unless defined $rscheme; 821 $rscheme = "http" unless defined $rscheme;
438 822
439 # don't support https requests over https-proxy transport, 823 # don't support https requests over https-proxy transport,
440 # can't be done with tls as spec'ed, unless you double-encrypt. 824 # can't be done with tls as spec'ed, unless you double-encrypt.
441 $rscheme = "http" if $uscheme eq "https" && $rscheme eq "https"; 825 $rscheme = "http" if $uscheme eq "https" && $rscheme eq "https";
826
827 $rhost = lc $rhost;
828 $rscheme = lc $rscheme;
442 } else { 829 } else {
443 ($rhost, $rport, $rscheme, $rpath) = ($uhost, $uport, $uscheme, $upath); 830 ($rhost, $rport, $rscheme, $rpath) = ($uhost, $uport, $uscheme, $upath);
444 } 831 }
445 832
446 # leave out fragment and query string, just a heuristic 833 # leave out fragment and query string, just a heuristic
447 $hdr{referer} ||= "$uscheme://$uauthority$upath" unless exists $hdr{referer}; 834 $hdr{referer} = "$uscheme://$uauthority$upath" unless exists $hdr{referer};
448 $hdr{"user-agent"} ||= $USERAGENT unless exists $hdr{"user-agent"}; 835 $hdr{"user-agent"} = $USERAGENT unless exists $hdr{"user-agent"};
449 836
450 $hdr{"content-length"} = length $arg{body} 837 $hdr{"content-length"} = length $arg{body}
451 if length $arg{body} || $method ne "GET"; 838 if length $arg{body} || $method ne "GET";
452 839
840 my $idempotent = $IDEMPOTENT{$method};
841
842 # default value for keepalive is true iff the request is for an idempotent method
843 my $persistent = exists $arg{persistent} ? !!$arg{persistent} : $idempotent;
844 my $keepalive = exists $arg{keepalive} ? !!$arg{keepalive} : !$proxy;
845 my $was_persistent; # true if this is actually a recycled connection
846
847 # the key to use in the keepalive cache
848 my $ka_key = "$uscheme\x00$uhost\x00$uport\x00$arg{sessionid}";
849
850 $hdr{connection} = ($persistent ? $keepalive ? "keep-alive, " : "" : "close, ") . "Te"; #1.1
851 $hdr{te} = "trailers" unless exists $hdr{te}; #1.1
852
453 my %state = (connect_guard => 1); 853 my %state = (connect_guard => 1);
854
855 my $ae_error = 595; # connecting
856
857 # handle actual, non-tunneled, request
858 my $handle_actual_request = sub {
859 $ae_error = 596; # request phase
860
861 my $hdl = $state{handle};
862
863 $hdl->starttls ("connect") if $uscheme eq "https" && !exists $hdl->{tls};
864
865 # send request
866 $hdl->push_write (
867 "$method $rpath HTTP/1.1\015\012"
868 . (join "", map "\u$_: $hdr{$_}\015\012", grep defined $hdr{$_}, keys %hdr)
869 . "\015\012"
870 . $arg{body}
871 );
872
873 # return if error occurred during push_write()
874 return unless %state;
875
876 # reduce memory usage, save a kitten, also re-use it for the response headers.
877 %hdr = ();
878
879 # status line and headers
880 $state{read_response} = sub {
881 return unless %state;
882
883 for ("$_[1]") {
884 y/\015//d; # weed out any \015, as they show up in the weirdest of places.
885
886 /^HTTP\/0*([0-9\.]+) \s+ ([0-9]{3}) (?: \s+ ([^\012]*) )? \012/gxci
887 or return _error %state, $cb, { @pseudo, Status => 599, Reason => "Invalid server response" };
888
889 # 100 Continue handling
890 # should not happen as we don't send expect: 100-continue,
891 # but we handle it just in case.
892 # since we send the request body regardless, if we get an error
893 # we are out of-sync, which we currently do NOT handle correctly.
894 return $state{handle}->push_read (line => $qr_nlnl, $state{read_response})
895 if $2 eq 100;
896
897 push @pseudo,
898 HTTPVersion => $1,
899 Status => $2,
900 Reason => $3,
901 ;
902
903 my $hdr = _parse_hdr
904 or return _error %state, $cb, { @pseudo, Status => 599, Reason => "Garbled response headers" };
905
906 %hdr = (%$hdr, @pseudo);
907 }
908
909 # redirect handling
910 # relative uri handling forced by microsoft and other shitheads.
911 # we give our best and fall back to URI if available.
912 if (exists $hdr{location}) {
913 my $loc = $hdr{location};
914
915 if ($loc =~ m%^//%) { # //
916 $loc = "$uscheme:$loc";
917
918 } elsif ($loc eq "") {
919 $loc = $url;
920
921 } elsif ($loc !~ /^(?: $ | [^:\/?\#]+ : )/x) { # anything "simple"
922 $loc =~ s/^\.\/+//;
923
924 if ($loc !~ m%^[.?#]%) {
925 my $prefix = "$uscheme://$uauthority";
926
927 unless ($loc =~ s/^\///) {
928 $prefix .= $upath;
929 $prefix =~ s/\/[^\/]*$//;
930 }
931
932 $loc = "$prefix/$loc";
933
934 } elsif (eval { require URI }) { # uri
935 $loc = URI->new_abs ($loc, $url)->as_string;
936
937 } else {
938 return _error %state, $cb, { @pseudo, Status => 599, Reason => "Cannot parse Location (URI module missing)" };
939 #$hdr{Status} = 599;
940 #$hdr{Reason} = "Unparsable Redirect (URI module missing)";
941 #$recurse = 0;
942 }
943 }
944
945 $hdr{location} = $loc;
946 }
947
948 my $redirect;
949
950 if ($recurse) {
951 my $status = $hdr{Status};
952
953 # industry standard is to redirect POST as GET for
954 # 301, 302 and 303, in contrast to HTTP/1.0 and 1.1.
955 # also, the UA should ask the user for 301 and 307 and POST,
956 # industry standard seems to be to simply follow.
957 # we go with the industry standard. 308 is defined
958 # by rfc7538
959 if ($status == 301 or $status == 302 or $status == 303) {
960 $redirect = 1;
961 # HTTP/1.1 is unclear on how to mutate the method
962 unless ($method eq "HEAD") {
963 $method = "GET";
964 delete $arg{body};
965 }
966 } elsif ($status == 307 or $status == 308) {
967 $redirect = 1;
968 }
969 }
970
971 my $finish = sub { # ($data, $err_status, $err_reason[, $persistent])
972 if ($state{handle}) {
973 # handle keepalive
974 if (
975 $persistent
976 && $_[3]
977 && ($hdr{HTTPVersion} < 1.1
978 ? $hdr{connection} =~ /\bkeep-?alive\b/i
979 : $hdr{connection} !~ /\bclose\b/i)
980 ) {
981 ka_store $ka_key, delete $state{handle};
982 } else {
983 # no keepalive, destroy the handle
984 $state{handle}->destroy;
985 }
986 }
987
988 %state = ();
989
990 if (defined $_[1]) {
991 $hdr{OrigStatus} = $hdr{Status}; $hdr{Status} = $_[1];
992 $hdr{OrigReason} = $hdr{Reason}; $hdr{Reason} = $_[2];
993 }
994
995 # set-cookie processing
996 if ($arg{cookie_jar}) {
997 cookie_jar_set_cookie $arg{cookie_jar}, $hdr{"set-cookie"}, $uhost, $hdr{date};
998 }
999
1000 if ($redirect && exists $hdr{location}) {
1001 # we ignore any errors, as it is very common to receive
1002 # Content-Length != 0 but no actual body
1003 # we also access %hdr, as $_[1] might be an erro
1004 $state{recurse} =
1005 http_request (
1006 $method => $hdr{location},
1007 %arg,
1008 recurse => $recurse - 1,
1009 Redirect => [$_[0], \%hdr],
1010 sub {
1011 %state = ();
1012 &$cb
1013 },
1014 );
1015 } else {
1016 $cb->($_[0], \%hdr);
1017 }
1018 };
1019
1020 $ae_error = 597; # body phase
1021
1022 my $chunked = $hdr{"transfer-encoding"} =~ /\bchunked\b/i; # not quite correct...
1023
1024 my $len = $chunked ? undef : $hdr{"content-length"};
1025
1026 # body handling, many different code paths
1027 # - no body expected
1028 # - want_body_handle
1029 # - te chunked
1030 # - 2x length known (with or without on_body)
1031 # - 2x length not known (with or without on_body)
1032 if (!$redirect && $arg{on_header} && !$arg{on_header}(\%hdr)) {
1033 $finish->(undef, 598 => "Request cancelled by on_header");
1034 } elsif (
1035 $hdr{Status} =~ /^(?:1..|204|205|304)$/
1036 or $method eq "HEAD"
1037 or (defined $len && $len == 0) # == 0, not !, because "0 " is true
1038 ) {
1039 # no body
1040 $finish->("", undef, undef, 1);
1041
1042 } elsif (!$redirect && $arg{want_body_handle}) {
1043 $_[0]->on_eof (undef);
1044 $_[0]->on_error (undef);
1045 $_[0]->on_read (undef);
1046
1047 $finish->(delete $state{handle});
1048
1049 } elsif ($chunked) {
1050 my $cl = 0;
1051 my $body = "";
1052 my $on_body = (!$redirect && $arg{on_body}) || sub { $body .= shift; 1 };
1053
1054 $state{read_chunk} = sub {
1055 $_[1] =~ /^([0-9a-fA-F]+)/
1056 or return $finish->(undef, $ae_error => "Garbled chunked transfer encoding");
1057
1058 my $len = hex $1;
1059
1060 if ($len) {
1061 $cl += $len;
1062
1063 $_[0]->push_read (chunk => $len, sub {
1064 $on_body->($_[1], \%hdr)
1065 or return $finish->(undef, 598 => "Request cancelled by on_body");
1066
1067 $_[0]->push_read (line => sub {
1068 length $_[1]
1069 and return $finish->(undef, $ae_error => "Garbled chunked transfer encoding");
1070 $_[0]->push_read (line => $state{read_chunk});
1071 });
1072 });
1073 } else {
1074 $hdr{"content-length"} ||= $cl;
1075
1076 $_[0]->push_read (line => $qr_nlnl, sub {
1077 if (length $_[1]) {
1078 for ("$_[1]") {
1079 y/\015//d; # weed out any \015, as they show up in the weirdest of places.
1080
1081 my $hdr = _parse_hdr
1082 or return $finish->(undef, $ae_error => "Garbled response trailers");
1083
1084 %hdr = (%hdr, %$hdr);
1085 }
1086 }
1087
1088 $finish->($body, undef, undef, 1);
1089 });
1090 }
1091 };
1092
1093 $_[0]->push_read (line => $state{read_chunk});
1094
1095 } elsif (!$redirect && $arg{on_body}) {
1096 if (defined $len) {
1097 $_[0]->on_read (sub {
1098 $len -= length $_[0]{rbuf};
1099
1100 $arg{on_body}(delete $_[0]{rbuf}, \%hdr)
1101 or return $finish->(undef, 598 => "Request cancelled by on_body");
1102
1103 $len > 0
1104 or $finish->("", undef, undef, 1);
1105 });
1106 } else {
1107 $_[0]->on_eof (sub {
1108 $finish->("");
1109 });
1110 $_[0]->on_read (sub {
1111 $arg{on_body}(delete $_[0]{rbuf}, \%hdr)
1112 or $finish->(undef, 598 => "Request cancelled by on_body");
1113 });
1114 }
1115 } else {
1116 $_[0]->on_eof (undef);
1117
1118 if (defined $len) {
1119 $_[0]->on_read (sub {
1120 $finish->((substr delete $_[0]{rbuf}, 0, $len, ""), undef, undef, 1)
1121 if $len <= length $_[0]{rbuf};
1122 });
1123 } else {
1124 $_[0]->on_error (sub {
1125 ($! == Errno::EPIPE || !$!)
1126 ? $finish->(delete $_[0]{rbuf})
1127 : $finish->(undef, $ae_error => $_[2]);
1128 });
1129 $_[0]->on_read (sub { });
1130 }
1131 }
1132 };
1133
1134 # if keepalive is enabled, then the server closing the connection
1135 # before a response can happen legally - we retry on idempotent methods.
1136 if ($was_persistent && $idempotent) {
1137 my $old_eof = $hdl->{on_eof};
1138 $hdl->{on_eof} = sub {
1139 _destroy_state %state;
1140
1141 %state = ();
1142 $state{recurse} =
1143 http_request (
1144 $method => $url,
1145 %arg,
1146 recurse => $recurse - 1,
1147 persistent => 0,
1148 sub {
1149 %state = ();
1150 &$cb
1151 }
1152 );
1153 };
1154 $hdl->on_read (sub {
1155 return unless %state;
1156
1157 # as soon as we receive something, a connection close
1158 # once more becomes a hard error
1159 $hdl->{on_eof} = $old_eof;
1160 $hdl->push_read (line => $qr_nlnl, $state{read_response});
1161 });
1162 } else {
1163 $hdl->push_read (line => $qr_nlnl, $state{read_response});
1164 }
1165 };
1166
1167 my $prepare_handle = sub {
1168 my ($hdl) = $state{handle};
1169
1170 $hdl->on_error (sub {
1171 _error %state, $cb, { @pseudo, Status => $ae_error, Reason => $_[2] };
1172 });
1173 $hdl->on_eof (sub {
1174 _error %state, $cb, { @pseudo, Status => $ae_error, Reason => "Unexpected end-of-file" };
1175 });
1176 $hdl->timeout_reset;
1177 $hdl->timeout ($timeout);
1178 };
1179
1180 # connected to proxy (or origin server)
1181 my $connect_cb = sub {
1182 my $fh = shift
1183 or return _error %state, $cb, { @pseudo, Status => $ae_error, Reason => "$!" };
1184
1185 return unless delete $state{connect_guard};
1186
1187 # get handle
1188 $state{handle} = new AnyEvent::Handle
1189 %{ $arg{handle_params} },
1190 fh => $fh,
1191 peername => $uhost,
1192 tls_ctx => $arg{tls_ctx},
1193 ;
1194
1195 $prepare_handle->();
1196
1197 #$state{handle}->starttls ("connect") if $rscheme eq "https";
1198
1199 # now handle proxy-CONNECT method
1200 if ($proxy && $uscheme eq "https") {
1201 # oh dear, we have to wrap it into a connect request
1202
1203 my $auth = exists $hdr{"proxy-authorization"}
1204 ? "proxy-authorization: " . (delete $hdr{"proxy-authorization"}) . "\015\012"
1205 : "";
1206
1207 # maybe re-use $uauthority with patched port?
1208 $state{handle}->push_write ("CONNECT $uhost:$uport HTTP/1.0\015\012$auth\015\012");
1209 $state{handle}->push_read (line => $qr_nlnl, sub {
1210 $_[1] =~ /^HTTP\/([0-9\.]+) \s+ ([0-9]{3}) (?: \s+ ([^\015\012]*) )?/ix
1211 or return _error %state, $cb, { @pseudo, Status => 599, Reason => "Invalid proxy connect response ($_[1])" };
1212
1213 if ($2 == 200) {
1214 $rpath = $upath;
1215 $handle_actual_request->();
1216 } else {
1217 _error %state, $cb, { @pseudo, Status => $2, Reason => $3 };
1218 }
1219 });
1220 } else {
1221 delete $hdr{"proxy-authorization"} unless $proxy;
1222
1223 $handle_actual_request->();
1224 }
1225 };
454 1226
455 _get_slot $uhost, sub { 1227 _get_slot $uhost, sub {
456 $state{slot_guard} = shift; 1228 $state{slot_guard} = shift;
457 1229
458 return unless $state{connect_guard}; 1230 return unless $state{connect_guard};
459 1231
460 $state{connect_guard} = AnyEvent::Socket::tcp_connect $rhost, $rport, sub { 1232 # try to use an existing keepalive connection, but only if we, ourselves, plan
461 $state{fh} = shift 1233 # on a keepalive request (in theory, this should be a separate config option).
462 or do { 1234 if ($persistent && $KA_CACHE{$ka_key}) {
463 my $err = "$!"; 1235 $was_persistent = 1;
464 %state = ();
465 return $cb->(undef, { Status => 599, Reason => $err, @pseudo });
466 };
467 1236
468 pop; # free memory, save a tree 1237 $state{handle} = ka_fetch $ka_key;
1238# $state{handle}->destroyed
1239# and die "AnyEvent::HTTP: unexpectedly got a destructed handle (1), please report.";#d#
1240 $prepare_handle->();
1241# $state{handle}->destroyed
1242# and die "AnyEvent::HTTP: unexpectedly got a destructed handle (2), please report.";#d#
1243 $handle_actual_request->();
469 1244
470 return unless delete $state{connect_guard};
471
472 # get handle
473 $state{handle} = new AnyEvent::Handle
474 fh => $state{fh},
475 timeout => $timeout,
476 peername => $rhost,
477 tls_ctx => $arg{tls_ctx};
478
479 # limit the number of persistent connections
480 # keepalive not yet supported
481 if ($KA_COUNT{$_[1]} < $MAX_PERSISTENT_PER_HOST) {
482 ++$KA_COUNT{$_[1]};
483 $state{handle}{ka_count_guard} = AnyEvent::Util::guard {
484 --$KA_COUNT{$_[1]}
485 };
486 $hdr{connection} = "keep-alive";
487 } else { 1245 } else {
488 delete $hdr{connection}; 1246 my $tcp_connect = $arg{tcp_connect}
489 } 1247 || do { require AnyEvent::Socket; \&AnyEvent::Socket::tcp_connect };
490 1248
491 # (re-)configure handle 1249 $state{connect_guard} = $tcp_connect->($rhost, $rport, $connect_cb, $arg{on_prepare} || sub { $timeout });
492 $state{handle}->on_error (sub {
493 %state = ();
494 $cb->(undef, { Status => 599, Reason => $_[2], @pseudo });
495 });
496 $state{handle}->on_eof (sub {
497 %state = ();
498 $cb->(undef, { Status => 599, Reason => "Unexpected end-of-file", @pseudo });
499 });
500
501 $state{handle}->starttls ("connect") if $rscheme eq "https";
502
503 # handle actual, non-tunneled, request
504 my $handle_actual_request = sub {
505 $state{handle}->starttls ("connect") if $uscheme eq "https" && !exists $state{handle}{tls};
506
507 # send request
508 $state{handle}->push_write (
509 "$method $rpath HTTP/1.0\015\012"
510 . (join "", map "\u$_: $hdr{$_}\015\012", grep defined $hdr{$_}, keys %hdr)
511 . "\015\012"
512 . (delete $arg{body})
513 );
514
515 # return if error occured during push_write()
516 return unless %state;
517
518 %hdr = (); # reduce memory usage, save a kitten, also make it possible to re-use
519
520 # status line
521 $state{handle}->push_read (line => $qr_nl, sub {
522 $_[1] =~ /^HTTP\/([0-9\.]+) \s+ ([0-9]{3}) (?: \s+ ([^\015\012]*) )?/ix
523 or return (%state = (), $cb->(undef, { Status => 599, Reason => "Invalid server response ($_[1])", @pseudo }));
524
525 push @pseudo,
526 HTTPVersion => $1,
527 Status => $2,
528 Reason => $3,
529 ;
530
531 # headers, could be optimized a bit
532 $state{handle}->unshift_read (line => $qr_nlnl, sub {
533 for ("$_[1]") {
534 y/\015//d; # weed out any \015, as they show up in the weirdest of places.
535
536 # things seen, not parsed:
537 # p3pP="NON CUR OTPi OUR NOR UNI"
538
539 $hdr{lc $1} .= ",$2"
540 while /\G
541 ([^:\000-\037]*):
542 [\011\040]*
543 ((?: [^\012]+ | \012[\011\040] )*)
544 \012
545 /gxc;
546
547 /\G$/
548 or return (%state = (), $cb->(undef, { Status => 599, Reason => "Garbled response headers", @pseudo }));
549 }
550
551 # remove the "," prefix we added to all headers above
552 substr $_, 0, 1, ""
553 for values %hdr;
554
555 # patch in all pseudo headers
556 %hdr = (%hdr, @pseudo);
557
558 # redirect handling
559 # microsoft and other shitheads don't give a shit for following standards,
560 # try to support some common forms of broken Location headers.
561 if ($hdr{location} !~ /^(?: $ | [^:\/?\#]+ : )/x) {
562 $hdr{location} =~ s/^\.\/+//;
563
564 my $url = "$rscheme://$uhost:$uport";
565
566 unless ($hdr{location} =~ s/^\///) {
567 $url .= $upath;
568 $url =~ s/\/[^\/]*$//;
569 }
570
571 $hdr{location} = "$url/$hdr{location}";
572 }
573
574 my $redirect;
575
576 if ($recurse) {
577 my $status = $hdr{Status};
578
579 if (($status == 301 || $status == 302) && $method ne "POST") {
580 # apparently, mozilla et al. just change POST to GET here
581 # more research is needed before we do the same
582 $redirect = 1;
583 } elsif ($status == 303) {
584 # even http/1.1 is unclear on how to mutate the method
585 $method = "GET" unless $method eq "HEAD";
586 $redirect = 1;
587 } elsif ($status == 307 && $method =~ /^(?:GET|HEAD)$/) {
588 $redirect = 1;
589 }
590 }
591
592 my $finish = sub {
593 $state{handle}->destroy if $state{handle};
594 %state = ();
595
596 # set-cookie processing
597 if ($arg{cookie_jar}) {
598 for ($_[1]{"set-cookie"}) {
599 # parse NAME=VALUE
600 my @kv;
601
602 while (/\G\s* ([^=;,[:space:]]+) \s*=\s* (?: "((?:[^\\"]+|\\.)*)" | ([^=;,[:space:]]*) )/gcxs) {
603 my $name = $1;
604 my $value = $3;
605
606 unless ($value) {
607 $value = $2;
608 $value =~ s/\\(.)/$1/gs;
609 }
610
611 push @kv, $name => $value;
612
613 last unless /\G\s*;/gc;
614 }
615
616 last unless @kv;
617
618 my $name = shift @kv;
619 my %kv = (value => shift @kv, @kv);
620
621 my $cdom;
622 my $cpath = (delete $kv{path}) || "/";
623
624 if (exists $kv{domain}) {
625 $cdom = delete $kv{domain};
626 1250 }
627 $cdom =~ s/^\.?/./; # make sure it starts with a "."
628
629 next if $cdom =~ /\.$/;
630
631 # this is not rfc-like and not netscape-like. go figure.
632 my $ndots = $cdom =~ y/.//;
633 next if $ndots < ($cdom =~ /\.[^.][^.]\.[^.][^.]$/ ? 3 : 2);
634 } else {
635 $cdom = $uhost;
636 }
637
638 # store it
639 $arg{cookie_jar}{version} = 1;
640 $arg{cookie_jar}{$cdom}{$cpath}{$name} = \%kv;
641
642 redo if /\G\s*,/gc;
643 }
644 }
645
646 if ($redirect && exists $hdr{location}) {
647 # we ignore any errors, as it is very common to receive
648 # Content-Length != 0 but no actual body
649 # we also access %hdr, as $_[1] might be an erro
650 http_request (
651 $method => $hdr{location},
652 %arg,
653 recurse => $recurse - 1,
654 Redirect => \@_,
655 $cb);
656 } else {
657 $cb->($_[0], $_[1]);
658 }
659 };
660
661 my $len = $hdr{"content-length"};
662
663 if (!$redirect && $arg{on_header} && !$arg{on_header}(\%hdr)) {
664 $finish->(undef, { Status => 598, Reason => "Request cancelled by on_header", @pseudo });
665 } elsif (
666 $hdr{Status} =~ /^(?:1..|[23]04)$/
667 or $method eq "HEAD"
668 or (defined $len && !$len)
669 ) {
670 # no body
671 $finish->("", \%hdr);
672 } else {
673 # body handling, four different code paths
674 # for want_body_handle, on_body (2x), normal (2x)
675 # we might read too much here, but it does not matter yet (no pers. connections)
676 if (!$redirect && $arg{want_body_handle}) {
677 $_[0]->on_eof (undef);
678 $_[0]->on_error (undef);
679 $_[0]->on_read (undef);
680
681 $finish->(delete $state{handle}, \%hdr);
682
683 } elsif ($arg{on_body}) {
684 $_[0]->on_error (sub { $finish->(undef, { Status => 599, Reason => $_[2], @pseudo }) });
685 if ($len) {
686 $_[0]->on_eof (undef);
687 $_[0]->on_read (sub {
688 $len -= length $_[0]{rbuf};
689
690 $arg{on_body}(delete $_[0]{rbuf}, \%hdr)
691 or $finish->(undef, { Status => 598, Reason => "Request cancelled by on_body", @pseudo });
692
693 $len > 0
694 or $finish->("", \%hdr);
695 });
696 } else {
697 $_[0]->on_eof (sub {
698 $finish->("", \%hdr);
699 });
700 $_[0]->on_read (sub {
701 $arg{on_body}(delete $_[0]{rbuf}, \%hdr)
702 or $finish->(undef, { Status => 598, Reason => "Request cancelled by on_body", @pseudo });
703 });
704 }
705 } else {
706 $_[0]->on_eof (undef);
707
708 if ($len) {
709 $_[0]->on_error (sub { $finish->(undef, { Status => 599, Reason => $_[2], @pseudo }) });
710 $_[0]->on_read (sub {
711 $finish->((substr delete $_[0]{rbuf}, 0, $len, ""), \%hdr)
712 if $len <= length $_[0]{rbuf};
713 });
714 } else {
715 $_[0]->on_error (sub {
716 $! == Errno::EPIPE || !$!
717 ? $finish->(delete $_[0]{rbuf}, \%hdr)
718 : $finish->(undef, { Status => 599, Reason => $_[2], @pseudo });
719 });
720 $_[0]->on_read (sub { });
721 }
722 }
723 }
724 });
725 });
726 };
727
728 # now handle proxy-CONNECT method
729 if ($proxy && $uscheme eq "https") {
730 # oh dear, we have to wrap it into a connect request
731
732 # maybe re-use $uauthority with patched port?
733 $state{handle}->push_write ("CONNECT $uhost:$uport HTTP/1.0\015\012Host: $uhost\015\012\015\012");
734 $state{handle}->push_read (line => $qr_nlnl, sub {
735 $_[1] =~ /^HTTP\/([0-9\.]+) \s+ ([0-9]{3}) (?: \s+ ([^\015\012]*) )?/ix
736 or return (%state = (), $cb->(undef, { Status => 599, Reason => "Invalid proxy connect response ($_[1])", @pseudo }));
737
738 if ($2 == 200) {
739 $rpath = $upath;
740 &$handle_actual_request;
741 } else {
742 %state = ();
743 $cb->(undef, { Status => $2, Reason => $3, @pseudo });
744 }
745 });
746 } else {
747 &$handle_actual_request;
748 }
749
750 }, $arg{on_prepare} || sub { $timeout };
751 }; 1251 };
752 1252
753 defined wantarray && AnyEvent::Util::guard { %state = () } 1253 defined wantarray && AnyEvent::Util::guard { _destroy_state %state }
754} 1254}
755 1255
756sub http_get($@) { 1256sub http_get($@) {
757 unshift @_, "GET"; 1257 unshift @_, "GET";
758 &http_request 1258 &http_request
776AnyEvent::HTTP uses the AnyEvent::Socket::tcp_connect function for 1276AnyEvent::HTTP uses the AnyEvent::Socket::tcp_connect function for
777the actual connection, which in turn uses AnyEvent::DNS to resolve 1277the actual connection, which in turn uses AnyEvent::DNS to resolve
778hostnames. The latter is a simple stub resolver and does no caching 1278hostnames. The latter is a simple stub resolver and does no caching
779on its own. If you want DNS caching, you currently have to provide 1279on its own. If you want DNS caching, you currently have to provide
780your own default resolver (by storing a suitable resolver object in 1280your own default resolver (by storing a suitable resolver object in
781C<$AnyEvent::DNS::RESOLVER>). 1281C<$AnyEvent::DNS::RESOLVER>) or your own C<tcp_connect> callback.
782 1282
783=head2 GLOBAL FUNCTIONS AND VARIABLES 1283=head2 GLOBAL FUNCTIONS AND VARIABLES
784 1284
785=over 4 1285=over 4
786 1286
787=item AnyEvent::HTTP::set_proxy "proxy-url" 1287=item AnyEvent::HTTP::set_proxy "proxy-url"
788 1288
789Sets the default proxy server to use. The proxy-url must begin with a 1289Sets the default proxy server to use. The proxy-url must begin with a
790string of the form C<http://host:port> (optionally C<https:...>), croaks 1290string of the form C<http://host:port>, croaks otherwise.
791otherwise.
792 1291
793To clear an already-set proxy, use C<undef>. 1292To clear an already-set proxy, use C<undef>.
794 1293
1294When AnyEvent::HTTP is loaded for the first time it will query the
1295default proxy from the operating system, currently by looking at
1296C<$ENV{http_proxy>}.
1297
1298=item AnyEvent::HTTP::cookie_jar_expire $jar[, $session_end]
1299
1300Remove all cookies from the cookie jar that have been expired. If
1301C<$session_end> is given and true, then additionally remove all session
1302cookies.
1303
1304You should call this function (with a true C<$session_end>) before you
1305save cookies to disk, and you should call this function after loading them
1306again. If you have a long-running program you can additionally call this
1307function from time to time.
1308
1309A cookie jar is initially an empty hash-reference that is managed by this
1310module. Its format is subject to change, but currently it is as follows:
1311
1312The key C<version> has to contain C<2>, otherwise the hash gets
1313cleared. All other keys are hostnames or IP addresses pointing to
1314hash-references. The key for these inner hash references is the
1315server path for which this cookie is meant, and the values are again
1316hash-references. Each key of those hash-references is a cookie name, and
1317the value, you guessed it, is another hash-reference, this time with the
1318key-value pairs from the cookie, except for C<expires> and C<max-age>,
1319which have been replaced by a C<_expires> key that contains the cookie
1320expiry timestamp. Session cookies are indicated by not having an
1321C<_expires> key.
1322
1323Here is an example of a cookie jar with a single cookie, so you have a
1324chance of understanding the above paragraph:
1325
1326 {
1327 version => 2,
1328 "10.0.0.1" => {
1329 "/" => {
1330 "mythweb_id" => {
1331 _expires => 1293917923,
1332 value => "ooRung9dThee3ooyXooM1Ohm",
1333 },
1334 },
1335 },
1336 }
1337
1338=item $date = AnyEvent::HTTP::format_date $timestamp
1339
1340Takes a POSIX timestamp (seconds since the epoch) and formats it as a HTTP
1341Date (RFC 2616).
1342
1343=item $timestamp = AnyEvent::HTTP::parse_date $date
1344
1345Takes a HTTP Date (RFC 2616) or a Cookie date (netscape cookie spec) or a
1346bunch of minor variations of those, and returns the corresponding POSIX
1347timestamp, or C<undef> if the date cannot be parsed.
1348
795=item $AnyEvent::HTTP::MAX_RECURSE 1349=item $AnyEvent::HTTP::MAX_RECURSE
796 1350
797The default value for the C<recurse> request parameter (default: C<10>). 1351The default value for the C<recurse> request parameter (default: C<10>).
1352
1353=item $AnyEvent::HTTP::TIMEOUT
1354
1355The default timeout for connection operations (default: C<300>).
798 1356
799=item $AnyEvent::HTTP::USERAGENT 1357=item $AnyEvent::HTTP::USERAGENT
800 1358
801The default value for the C<User-Agent> header (the default is 1359The default value for the C<User-Agent> header (the default is
802C<Mozilla/5.0 (compatible; U; AnyEvent-HTTP/$VERSION; +http://software.schmorp.de/pkg/AnyEvent)>). 1360C<Mozilla/5.0 (compatible; U; AnyEvent-HTTP/$VERSION; +http://software.schmorp.de/pkg/AnyEvent)>).
803 1361
804=item $AnyEvent::HTTP::MAX_PER_HOST 1362=item $AnyEvent::HTTP::MAX_PER_HOST
805 1363
806The maximum number of concurrent connections to the same host (identified 1364The maximum number of concurrent connections to the same host (identified
807by the hostname). If the limit is exceeded, then the additional requests 1365by the hostname). If the limit is exceeded, then additional requests
808are queued until previous connections are closed. 1366are queued until previous connections are closed. Both persistent and
1367non-persistent connections are counted in this limit.
809 1368
810The default value for this is C<4>, and it is highly advisable to not 1369The default value for this is C<4>, and it is highly advisable to not
811increase it. 1370increase it much.
1371
1372For comparison: the RFC's recommend 4 non-persistent or 2 persistent
1373connections, older browsers used 2, newer ones (such as firefox 3)
1374typically use 6, and Opera uses 8 because like, they have the fastest
1375browser and give a shit for everybody else on the planet.
1376
1377=item $AnyEvent::HTTP::PERSISTENT_TIMEOUT
1378
1379The time after which idle persistent connections get closed by
1380AnyEvent::HTTP (default: C<3>).
812 1381
813=item $AnyEvent::HTTP::ACTIVE 1382=item $AnyEvent::HTTP::ACTIVE
814 1383
815The number of active connections. This is not the number of currently 1384The number of active connections. This is not the number of currently
816running requests, but the number of currently open and non-idle TCP 1385running requests, but the number of currently open and non-idle TCP
817connections. This number of can be useful for load-leveling. 1386connections. This number can be useful for load-leveling.
818 1387
819=back 1388=back
820 1389
821=cut 1390=cut
1391
1392our @month = qw(Jan Feb Mar Apr May Jun Jul Aug Sep Oct Nov Dec);
1393our @weekday = qw(Sun Mon Tue Wed Thu Fri Sat);
1394
1395sub format_date($) {
1396 my ($time) = @_;
1397
1398 # RFC 822/1123 format
1399 my ($S, $M, $H, $mday, $mon, $year, $wday, $yday, undef) = gmtime $time;
1400
1401 sprintf "%s, %02d %s %04d %02d:%02d:%02d GMT",
1402 $weekday[$wday], $mday, $month[$mon], $year + 1900,
1403 $H, $M, $S;
1404}
1405
1406sub parse_date($) {
1407 my ($date) = @_;
1408
1409 my ($d, $m, $y, $H, $M, $S);
1410
1411 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$/) {
1412 # RFC 822/1123, required by RFC 2616 (with " ")
1413 # cookie dates (with "-")
1414
1415 ($d, $m, $y, $H, $M, $S) = ($1, $2, $3, $4, $5, $6);
1416
1417 } 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$/) {
1418 # RFC 850
1419 ($d, $m, $y, $H, $M, $S) = ($1, $2, $3 < 69 ? $3 + 2000 : $3 + 1900, $4, $5, $6);
1420
1421 } 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])$/) {
1422 # ISO C's asctime
1423 ($d, $m, $y, $H, $M, $S) = ($2, $1, $6, $3, $4, $5);
1424 }
1425 # other formats fail in the loop below
1426
1427 for (0..11) {
1428 if ($m eq $month[$_]) {
1429 require Time::Local;
1430 return eval { Time::Local::timegm ($S, $M, $H, $d, $_, $y) };
1431 }
1432 }
1433
1434 undef
1435}
822 1436
823sub set_proxy($) { 1437sub set_proxy($) {
824 if (length $_[0]) { 1438 if (length $_[0]) {
825 $_[0] =~ m%^(https?):// ([^:/]+) (?: : (\d*) )?%ix 1439 $_[0] =~ m%^(http):// ([^:/]+) (?: : (\d*) )?%ix
826 or Carp::croak "$_[0]: invalid proxy URL"; 1440 or Carp::croak "$_[0]: invalid proxy URL";
827 $PROXY = [$2, $3 || 3128, $1] 1441 $PROXY = [$2, $3 || 3128, $1]
828 } else { 1442 } else {
829 undef $PROXY; 1443 undef $PROXY;
830 } 1444 }
833# initialise proxy from environment 1447# initialise proxy from environment
834eval { 1448eval {
835 set_proxy $ENV{http_proxy}; 1449 set_proxy $ENV{http_proxy};
836}; 1450};
837 1451
1452=head2 SHOWCASE
1453
1454This section contains some more elaborate "real-world" examples or code
1455snippets.
1456
1457=head2 HTTP/1.1 FILE DOWNLOAD
1458
1459Downloading files with HTTP can be quite tricky, especially when something
1460goes wrong and you want to resume.
1461
1462Here is a function that initiates and resumes a download. It uses the
1463last modified time to check for file content changes, and works with many
1464HTTP/1.0 servers as well, and usually falls back to a complete re-download
1465on older servers.
1466
1467It calls the completion callback with either C<undef>, which means a
1468nonretryable error occurred, C<0> when the download was partial and should
1469be retried, and C<1> if it was successful.
1470
1471 use AnyEvent::HTTP;
1472
1473 sub download($$$) {
1474 my ($url, $file, $cb) = @_;
1475
1476 open my $fh, "+<", $file
1477 or die "$file: $!";
1478
1479 my %hdr;
1480 my $ofs = 0;
1481
1482 if (stat $fh and -s _) {
1483 $ofs = -s _;
1484 warn "-s is ", $ofs;
1485 $hdr{"if-unmodified-since"} = AnyEvent::HTTP::format_date +(stat _)[9];
1486 $hdr{"range"} = "bytes=$ofs-";
1487 }
1488
1489 http_get $url,
1490 headers => \%hdr,
1491 on_header => sub {
1492 my ($hdr) = @_;
1493
1494 if ($hdr->{Status} == 200 && $ofs) {
1495 # resume failed
1496 truncate $fh, $ofs = 0;
1497 }
1498
1499 sysseek $fh, $ofs, 0;
1500
1501 1
1502 },
1503 on_body => sub {
1504 my ($data, $hdr) = @_;
1505
1506 if ($hdr->{Status} =~ /^2/) {
1507 length $data == syswrite $fh, $data
1508 or return; # abort on write errors
1509 }
1510
1511 1
1512 },
1513 sub {
1514 my (undef, $hdr) = @_;
1515
1516 my $status = $hdr->{Status};
1517
1518 if (my $time = AnyEvent::HTTP::parse_date $hdr->{"last-modified"}) {
1519 utime $time, $time, $fh;
1520 }
1521
1522 if ($status == 200 || $status == 206 || $status == 416) {
1523 # download ok || resume ok || file already fully downloaded
1524 $cb->(1, $hdr);
1525
1526 } elsif ($status == 412) {
1527 # file has changed while resuming, delete and retry
1528 unlink $file;
1529 $cb->(0, $hdr);
1530
1531 } elsif ($status == 500 or $status == 503 or $status =~ /^59/) {
1532 # retry later
1533 $cb->(0, $hdr);
1534
1535 } else {
1536 $cb->(undef, $hdr);
1537 }
1538 }
1539 ;
1540 }
1541
1542 download "http://server/somelargefile", "/tmp/somelargefile", sub {
1543 if ($_[0]) {
1544 print "OK!\n";
1545 } elsif (defined $_[0]) {
1546 print "please retry later\n";
1547 } else {
1548 print "ERROR\n";
1549 }
1550 };
1551
1552=head3 SOCKS PROXIES
1553
1554Socks proxies are not directly supported by AnyEvent::HTTP. You can
1555compile your perl to support socks, or use an external program such as
1556F<socksify> (dante) or F<tsocks> to make your program use a socks proxy
1557transparently.
1558
1559Alternatively, for AnyEvent::HTTP only, you can use your own
1560C<tcp_connect> function that does the proxy handshake - here is an example
1561that works with socks4a proxies:
1562
1563 use Errno;
1564 use AnyEvent::Util;
1565 use AnyEvent::Socket;
1566 use AnyEvent::Handle;
1567
1568 # host, port and username of/for your socks4a proxy
1569 my $socks_host = "10.0.0.23";
1570 my $socks_port = 9050;
1571 my $socks_user = "";
1572
1573 sub socks4a_connect {
1574 my ($host, $port, $connect_cb, $prepare_cb) = @_;
1575
1576 my $hdl = new AnyEvent::Handle
1577 connect => [$socks_host, $socks_port],
1578 on_prepare => sub { $prepare_cb->($_[0]{fh}) },
1579 on_error => sub { $connect_cb->() },
1580 ;
1581
1582 $hdl->push_write (pack "CCnNZ*Z*", 4, 1, $port, 1, $socks_user, $host);
1583
1584 $hdl->push_read (chunk => 8, sub {
1585 my ($hdl, $chunk) = @_;
1586 my ($status, $port, $ipn) = unpack "xCna4", $chunk;
1587
1588 if ($status == 0x5a) {
1589 $connect_cb->($hdl->{fh}, (format_address $ipn) . ":$port");
1590 } else {
1591 $! = Errno::ENXIO; $connect_cb->();
1592 }
1593 });
1594
1595 $hdl
1596 }
1597
1598Use C<socks4a_connect> instead of C<tcp_connect> when doing C<http_request>s,
1599possibly after switching off other proxy types:
1600
1601 AnyEvent::HTTP::set_proxy undef; # usually you do not want other proxies
1602
1603 http_get 'http://www.google.com', tcp_connect => \&socks4a_connect, sub {
1604 my ($data, $headers) = @_;
1605 ...
1606 };
1607
838=head1 SEE ALSO 1608=head1 SEE ALSO
839 1609
840L<AnyEvent>. 1610L<AnyEvent>.
841 1611
842=head1 AUTHOR 1612=head1 AUTHOR

Diff Legend

Removed lines
+ Added lines
< Changed lines
> Changed lines