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

Diff Legend

Removed lines
+ Added lines
< Changed lines
> Changed lines