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.23 by root, Wed Jul 2 01:23:41 2008 UTC vs.
Revision 1.85 by root, Sun Jan 2 05:31:56 2011 UTC

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

Diff Legend

Removed lines
+ Added lines
< Changed lines
> Changed lines