… | |
… | |
15 | This module is an L<AnyEvent> user, you need to make sure that you use and |
15 | This module is an L<AnyEvent> user, you need to make sure that you use and |
16 | run a supported event loop. |
16 | run a supported event loop. |
17 | |
17 | |
18 | This module implements a simple, stateless and non-blocking HTTP |
18 | This module implements a simple, stateless and non-blocking HTTP |
19 | client. It supports GET, POST and other request methods, cookies and more, |
19 | client. It supports GET, POST and other request methods, cookies and more, |
20 | all on a very low level. It can follow redirects supports proxies and |
20 | all on a very low level. It can follow redirects, supports proxies, and |
21 | automatically limits the number of connections to the values specified in |
21 | automatically limits the number of connections to the values specified in |
22 | the RFC. |
22 | the RFC. |
23 | |
23 | |
24 | It should generally be a "good client" that is enough for most HTTP |
24 | It should generally be a "good client" that is enough for most HTTP |
25 | tasks. Simple tasks should be simple, but complex tasks should still be |
25 | tasks. Simple tasks should be simple, but complex tasks should still be |
… | |
… | |
46 | use AnyEvent::Util (); |
46 | use AnyEvent::Util (); |
47 | use AnyEvent::Handle (); |
47 | use AnyEvent::Handle (); |
48 | |
48 | |
49 | use base Exporter::; |
49 | use base Exporter::; |
50 | |
50 | |
51 | our $VERSION = '1.5'; |
51 | our $VERSION = '2.15'; |
52 | |
52 | |
53 | our @EXPORT = qw(http_get http_post http_head http_request); |
53 | our @EXPORT = qw(http_get http_post http_head http_request); |
54 | |
54 | |
55 | our $USERAGENT = "Mozilla/5.0 (compatible; U; AnyEvent-HTTP/$VERSION; +http://software.schmorp.de/pkg/AnyEvent)"; |
55 | our $USERAGENT = "Mozilla/5.0 (compatible; U; AnyEvent-HTTP/$VERSION; +http://software.schmorp.de/pkg/AnyEvent)"; |
56 | our $MAX_RECURSE = 10; |
56 | our $MAX_RECURSE = 10; |
57 | our $MAX_PERSISTENT = 8; |
|
|
58 | our $PERSISTENT_TIMEOUT = 2; |
57 | our $PERSISTENT_TIMEOUT = 3; |
59 | our $TIMEOUT = 300; |
58 | our $TIMEOUT = 300; |
60 | |
59 | our $MAX_PER_HOST = 4; # changing this is evil |
61 | # changing these is evil |
|
|
62 | our $MAX_PERSISTENT_PER_HOST = 2; |
|
|
63 | our $MAX_PER_HOST = 4; |
|
|
64 | |
60 | |
65 | our $PROXY; |
61 | our $PROXY; |
66 | our $ACTIVE = 0; |
62 | our $ACTIVE = 0; |
67 | |
63 | |
68 | my %KA_COUNT; # number of open keep-alive connections per host |
64 | my %KA_CACHE; # indexed by uhost currently, points to [$handle...] array |
69 | my %CO_SLOT; # number of open connections, and wait queue, per host |
65 | my %CO_SLOT; # number of open connections, and wait queue, per host |
70 | |
66 | |
71 | =item http_get $url, key => value..., $cb->($data, $headers) |
67 | =item http_get $url, key => value..., $cb->($data, $headers) |
72 | |
68 | |
73 | Executes an HTTP-GET request. See the http_request function for details on |
69 | Executes an HTTP-GET request. See the http_request function for details on |
… | |
… | |
127 | C<590>-C<599> and the C<Reason> pseudo-header will contain an error |
123 | C<590>-C<599> and the C<Reason> pseudo-header will contain an error |
128 | message. Currently the following status codes are used: |
124 | message. Currently the following status codes are used: |
129 | |
125 | |
130 | =over 4 |
126 | =over 4 |
131 | |
127 | |
132 | =item 595 - errors during connection etsbalishment, proxy handshake. |
128 | =item 595 - errors during connection establishment, proxy handshake. |
133 | |
129 | |
134 | =item 596 - errors during TLS negotiation, request sending and header processing. |
130 | =item 596 - errors during TLS negotiation, request sending and header processing. |
135 | |
131 | |
136 | =item 597 - errors during body receiving or processing. |
132 | =item 597 - errors during body receiving or processing. |
137 | |
133 | |
… | |
… | |
158 | |
154 | |
159 | =over 4 |
155 | =over 4 |
160 | |
156 | |
161 | =item recurse => $count (default: $MAX_RECURSE) |
157 | =item recurse => $count (default: $MAX_RECURSE) |
162 | |
158 | |
163 | Whether to recurse requests or not, e.g. on redirects, authentication |
159 | Whether to recurse requests or not, e.g. on redirects, authentication and |
164 | retries and so on, and how often to do so. |
160 | other retries and so on, and how often to do so. |
165 | |
161 | |
166 | =item headers => hashref |
162 | =item headers => hashref |
167 | |
163 | |
168 | The request headers to use. Currently, C<http_request> may provide its own |
164 | The request headers to use. Currently, C<http_request> may provide its own |
169 | C<Host:>, C<Content-Length:>, C<Connection:> and C<Cookie:> headers and |
165 | C<Host:>, C<Content-Length:>, C<Connection:> and C<Cookie:> headers and |
170 | will provide defaults at least for C<TE:>, C<Referer:> and C<User-Agent:> |
166 | will 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 |
167 | (this can be suppressed by using C<undef> for these headers in which case |
172 | they won't be sent at all). |
168 | they won't be sent at all). |
173 | |
169 | |
|
|
170 | You really should provide your own C<User-Agent:> header value that is |
|
|
171 | appropriate for your program - I wouldn't be surprised if the default |
|
|
172 | AnyEvent string gets blocked by webservers sooner or later. |
|
|
173 | |
|
|
174 | Also, make sure that your headers names and values do not contain any |
|
|
175 | embedded newlines. |
|
|
176 | |
174 | =item timeout => $seconds |
177 | =item timeout => $seconds |
175 | |
178 | |
176 | The time-out to use for various stages - each connect attempt will reset |
179 | The time-out to use for various stages - each connect attempt will reset |
177 | the timeout, as will read or write activity, i.e. this is not an overall |
180 | the timeout, as will read or write activity, i.e. this is not an overall |
178 | timeout. |
181 | timeout. |
179 | |
182 | |
180 | Default timeout is 5 minutes. |
183 | Default timeout is 5 minutes. |
181 | |
184 | |
182 | =item proxy => [$host, $port[, $scheme]] or undef |
185 | =item proxy => [$host, $port[, $scheme]] or undef |
183 | |
186 | |
184 | Use the given http proxy for all requests. If not specified, then the |
187 | Use the given http proxy for all requests, or no proxy if C<undef> is |
185 | default proxy (as specified by C<$ENV{http_proxy}>) is used. |
188 | used. |
186 | |
189 | |
187 | C<$scheme> must be either missing, C<http> for HTTP or C<https> for |
190 | C<$scheme> must be either missing or must be C<http> for HTTP. |
188 | HTTPS. |
191 | |
|
|
192 | If not specified, then the default proxy is used (see |
|
|
193 | C<AnyEvent::HTTP::set_proxy>). |
189 | |
194 | |
190 | =item body => $string |
195 | =item body => $string |
191 | |
196 | |
192 | The request body, usually empty. Will be sent as-is (future versions of |
197 | The request body, usually empty. Will be sent as-is (future versions of |
193 | this module might offer more options). |
198 | this module might offer more options). |
… | |
… | |
223 | verification, highest compatibility) and high-security (CA and common-name |
228 | verification, highest compatibility) and high-security (CA and common-name |
224 | verification) TLS context. |
229 | verification) TLS context. |
225 | |
230 | |
226 | The default for this option is C<low>, which could be interpreted as "give |
231 | The default for this option is C<low>, which could be interpreted as "give |
227 | me the page, no matter what". |
232 | me the page, no matter what". |
|
|
233 | |
|
|
234 | See also the C<sessionid> parameter. |
|
|
235 | |
|
|
236 | =item session => $string |
|
|
237 | |
|
|
238 | The module might reuse connections to the same host internally. Sometimes |
|
|
239 | (e.g. when using TLS), you do not want to reuse connections from other |
|
|
240 | sessions. This can be achieved by setting this parameter to some unique |
|
|
241 | ID (such as the address of an object storing your state data, or the TLS |
|
|
242 | context) - only connections using the same unique ID will be reused. |
228 | |
243 | |
229 | =item on_prepare => $callback->($fh) |
244 | =item on_prepare => $callback->($fh) |
230 | |
245 | |
231 | In rare cases you need to "tune" the socket before it is used to |
246 | In rare cases you need to "tune" the socket before it is used to |
232 | connect (for exmaple, to bind it on a given IP address). This parameter |
247 | connect (for exmaple, to bind it on a given IP address). This parameter |
… | |
… | |
302 | called. Instead of the C<$body> argument containing the body data, the |
317 | called. Instead of the C<$body> argument containing the body data, the |
303 | callback will receive the L<AnyEvent::Handle> object associated with the |
318 | callback will receive the L<AnyEvent::Handle> object associated with the |
304 | connection. In error cases, C<undef> will be passed. When there is no body |
319 | connection. 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. |
320 | (e.g. status C<304>), the empty string will be passed. |
306 | |
321 | |
307 | The handle object might or might not be in TLS mode, might be connected to |
322 | The handle object might or might not be in TLS mode, might be connected |
308 | a proxy, be a persistent connection etc., and configured in unspecified |
323 | to a proxy, be a persistent connection, use chunked transfer encoding |
309 | ways. The user is responsible for this handle (it will not be used by this |
324 | etc., and configured in unspecified ways. The user is responsible for this |
310 | module anymore). |
325 | handle (it will not be used by this module anymore). |
311 | |
326 | |
312 | This is useful with some push-type services, where, after the initial |
327 | This is useful with some push-type services, where, after the initial |
313 | headers, an interactive protocol is used (typical example would be the |
328 | headers, an interactive protocol is used (typical example would be the |
314 | push-style twitter API which starts a JSON/XML stream). |
329 | push-style twitter API which starts a JSON/XML stream). |
315 | |
330 | |
316 | If you think you need this, first have a look at C<on_body>, to see if |
331 | If you think you need this, first have a look at C<on_body>, to see if |
317 | that doesn't solve your problem in a better way. |
332 | that doesn't solve your problem in a better way. |
|
|
333 | |
|
|
334 | =item persistent => $boolean |
|
|
335 | |
|
|
336 | Try to create/reuse a persistent connection. When this flag is set |
|
|
337 | (default: true for idempotent requests, false for all others), then |
|
|
338 | C<http_request> tries to re-use an existing (previously-created) |
|
|
339 | persistent connection to the host and, failing that, tries to create a new |
|
|
340 | one. |
|
|
341 | |
|
|
342 | Requests failing in certain ways will be automatically retried once, which |
|
|
343 | is dangerous for non-idempotent requests, which is why it defaults to off |
|
|
344 | for them. The reason for this is because the bozos who designed HTTP/1.1 |
|
|
345 | made it impossible to distinguish between a fatal error and a normal |
|
|
346 | connection timeout, so you never know whether there was a problem with |
|
|
347 | your request or not. |
|
|
348 | |
|
|
349 | When reusing an existent connection, many parameters (such as TLS context) |
|
|
350 | will be ignored. See the C<session> parameter for a workaround. |
|
|
351 | |
|
|
352 | =item keepalive => $boolean |
|
|
353 | |
|
|
354 | Only used when C<persistent> is also true. This parameter decides whether |
|
|
355 | C<http_request> tries to handshake a HTTP/1.0-style keep-alive connection |
|
|
356 | (as opposed to only a HTTP/1.1 persistent connection). |
|
|
357 | |
|
|
358 | The default is true, except when using a proxy, in which case it defaults |
|
|
359 | to false, as HTTP/1.0 proxies cannot support this in a meaningful way. |
|
|
360 | |
|
|
361 | =item handle_params => { key => value ... } |
|
|
362 | |
|
|
363 | The key-value pairs in this hash will be passed to any L<AnyEvent::Handle> |
|
|
364 | constructor that is called - not all requests will create a handle, and |
|
|
365 | sometimes more than one is created, so this parameter is only good for |
|
|
366 | setting hints. |
|
|
367 | |
|
|
368 | Example: set the maximum read size to 4096, to potentially conserve memory |
|
|
369 | at the cost of speed. |
|
|
370 | |
|
|
371 | handle_params => { |
|
|
372 | max_read_size => 4096, |
|
|
373 | }, |
318 | |
374 | |
319 | =back |
375 | =back |
320 | |
376 | |
321 | Example: do a simple HTTP GET request for http://www.nethype.de/ and print |
377 | Example: do a simple HTTP GET request for http://www.nethype.de/ and print |
322 | the response body. |
378 | the response body. |
… | |
… | |
328 | |
384 | |
329 | Example: do a HTTP HEAD request on https://www.google.com/, use a |
385 | Example: do a HTTP HEAD request on https://www.google.com/, use a |
330 | timeout of 30 seconds. |
386 | timeout of 30 seconds. |
331 | |
387 | |
332 | http_request |
388 | http_request |
333 | GET => "https://www.google.com", |
389 | HEAD => "https://www.google.com", |
|
|
390 | headers => { "user-agent" => "MySearchClient 1.0" }, |
334 | timeout => 30, |
391 | timeout => 30, |
335 | sub { |
392 | sub { |
336 | my ($body, $hdr) = @_; |
393 | my ($body, $hdr) = @_; |
337 | use Data::Dumper; |
394 | use Data::Dumper; |
338 | print Dumper $hdr; |
395 | print Dumper $hdr; |
… | |
… | |
348 | }; |
405 | }; |
349 | |
406 | |
350 | undef $request; |
407 | undef $request; |
351 | |
408 | |
352 | =cut |
409 | =cut |
|
|
410 | |
|
|
411 | ############################################################################# |
|
|
412 | # wait queue/slots |
353 | |
413 | |
354 | sub _slot_schedule; |
414 | sub _slot_schedule; |
355 | sub _slot_schedule($) { |
415 | sub _slot_schedule($) { |
356 | my $host = shift; |
416 | my $host = shift; |
357 | |
417 | |
… | |
… | |
380 | |
440 | |
381 | _slot_schedule $_[0]; |
441 | _slot_schedule $_[0]; |
382 | } |
442 | } |
383 | |
443 | |
384 | ############################################################################# |
444 | ############################################################################# |
|
|
445 | # cookie handling |
385 | |
446 | |
386 | # expire cookies |
447 | # expire cookies |
387 | sub cookie_jar_expire($;$) { |
448 | sub cookie_jar_expire($;$) { |
388 | my ($jar, $session_end) = @_; |
449 | my ($jar, $session_end) = @_; |
389 | |
450 | |
… | |
… | |
413 | } |
474 | } |
414 | } |
475 | } |
415 | |
476 | |
416 | # extract cookies from jar |
477 | # extract cookies from jar |
417 | sub cookie_jar_extract($$$$) { |
478 | sub cookie_jar_extract($$$$) { |
418 | my ($jar, $uscheme, $uhost, $upath) = @_; |
479 | my ($jar, $scheme, $host, $path) = @_; |
419 | |
480 | |
420 | %$jar = () if $jar->{version} != 1; |
481 | %$jar = () if $jar->{version} != 1; |
421 | |
482 | |
422 | my @cookies; |
483 | my @cookies; |
423 | |
484 | |
424 | while (my ($chost, $paths) = each %$jar) { |
485 | while (my ($chost, $paths) = each %$jar) { |
425 | next unless ref $paths; |
486 | next unless ref $paths; |
426 | |
487 | |
427 | if ($chost =~ /^\./) { |
488 | if ($chost =~ /^\./) { |
428 | next unless $chost eq substr $uhost, -length $chost; |
489 | next unless $chost eq substr $host, -length $chost; |
429 | } elsif ($chost =~ /\./) { |
490 | } elsif ($chost =~ /\./) { |
430 | next unless $chost eq $uhost; |
491 | next unless $chost eq $host; |
431 | } else { |
492 | } else { |
432 | next; |
493 | next; |
433 | } |
494 | } |
434 | |
495 | |
435 | while (my ($cpath, $cookies) = each %$paths) { |
496 | while (my ($cpath, $cookies) = each %$paths) { |
436 | next unless $cpath eq substr $upath, 0, length $cpath; |
497 | next unless $cpath eq substr $path, 0, length $cpath; |
437 | |
498 | |
438 | while (my ($cookie, $kv) = each %$cookies) { |
499 | while (my ($cookie, $kv) = each %$cookies) { |
439 | next if $uscheme ne "https" && exists $kv->{secure}; |
500 | next if $scheme ne "https" && exists $kv->{secure}; |
440 | |
501 | |
441 | if (exists $kv->{_expires} and AE::now > $kv->{_expires}) { |
502 | if (exists $kv->{_expires} and AE::now > $kv->{_expires}) { |
442 | delete $cookies->{$cookie}; |
503 | delete $cookies->{$cookie}; |
443 | next; |
504 | next; |
444 | } |
505 | } |
… | |
… | |
458 | \@cookies |
519 | \@cookies |
459 | } |
520 | } |
460 | |
521 | |
461 | # parse set_cookie header into jar |
522 | # parse set_cookie header into jar |
462 | sub cookie_jar_set_cookie($$$$) { |
523 | sub cookie_jar_set_cookie($$$$) { |
463 | my ($jar, $set_cookie, $uhost, $date) = @_; |
524 | my ($jar, $set_cookie, $host, $date) = @_; |
464 | |
525 | |
465 | my $anow = int AE::now; |
526 | my $anow = int AE::now; |
466 | my $snow; # server-now |
527 | my $snow; # server-now |
467 | |
528 | |
468 | for ($set_cookie) { |
529 | for ($set_cookie) { |
… | |
… | |
474 | while ( |
535 | while ( |
475 | m{ |
536 | m{ |
476 | \G\s* |
537 | \G\s* |
477 | (?: |
538 | (?: |
478 | expires \s*=\s* ([A-Z][a-z][a-z]+,\ [^,;]+) |
539 | expires \s*=\s* ([A-Z][a-z][a-z]+,\ [^,;]+) |
479 | | ([^=;,[:space:]]+) (?: \s*=\s* (?: "((?:[^\\"]+|\\.)*)" | ([^=;,[:space:]]*) ) )? |
540 | | ([^=;,[:space:]]+) (?: \s*=\s* (?: "((?:[^\\"]+|\\.)*)" | ([^;,[:space:]]*) ) )? |
480 | ) |
541 | ) |
481 | }gcxsi |
542 | }gcxsi |
482 | ) { |
543 | ) { |
483 | my $name = $2; |
544 | my $name = $2; |
484 | my $value = $4; |
545 | my $value = $4; |
… | |
… | |
491 | # quoted |
552 | # quoted |
492 | $value = $3; |
553 | $value = $3; |
493 | $value =~ s/\\(.)/$1/gs; |
554 | $value =~ s/\\(.)/$1/gs; |
494 | } |
555 | } |
495 | |
556 | |
496 | push @kv, lc $name, $value; |
557 | push @kv, @kv ? lc $name : $name, $value; |
497 | |
558 | |
498 | last unless /\G\s*;/gc; |
559 | last unless /\G\s*;/gc; |
499 | } |
560 | } |
500 | |
561 | |
501 | last unless @kv; |
562 | last unless @kv; |
… | |
… | |
524 | |
585 | |
525 | # this is not rfc-like and not netscape-like. go figure. |
586 | # this is not rfc-like and not netscape-like. go figure. |
526 | my $ndots = $cdom =~ y/.//; |
587 | my $ndots = $cdom =~ y/.//; |
527 | next if $ndots < ($cdom =~ /\.[^.][^.]\.[^.][^.]$/ ? 3 : 2); |
588 | next if $ndots < ($cdom =~ /\.[^.][^.]\.[^.][^.]$/ ? 3 : 2); |
528 | } else { |
589 | } else { |
529 | $cdom = $uhost; |
590 | $cdom = $host; |
530 | } |
591 | } |
531 | |
592 | |
532 | # store it |
593 | # store it |
533 | $jar->{version} = 1; |
594 | $jar->{version} = 1; |
534 | $jar->{lc $cdom}{$cpath}{$name} = \%kv; |
595 | $jar->{lc $cdom}{$cpath}{$name} = \%kv; |
535 | |
596 | |
536 | redo if /\G\s*,/gc; |
597 | redo if /\G\s*,/gc; |
537 | } |
598 | } |
538 | } |
599 | } |
539 | |
600 | |
|
|
601 | ############################################################################# |
|
|
602 | # keepalive/persistent connection cache |
|
|
603 | |
|
|
604 | # fetch a connection from the keepalive cache |
|
|
605 | sub ka_fetch($) { |
|
|
606 | my $ka_key = shift; |
|
|
607 | |
|
|
608 | my $hdl = pop @{ $KA_CACHE{$ka_key} }; # currently we reuse the MOST RECENTLY USED connection |
|
|
609 | delete $KA_CACHE{$ka_key} |
|
|
610 | unless @{ $KA_CACHE{$ka_key} }; |
|
|
611 | |
|
|
612 | $hdl |
|
|
613 | } |
|
|
614 | |
|
|
615 | sub ka_store($$) { |
|
|
616 | my ($ka_key, $hdl) = @_; |
|
|
617 | |
|
|
618 | my $kaa = $KA_CACHE{$ka_key} ||= []; |
|
|
619 | |
|
|
620 | my $destroy = sub { |
|
|
621 | my @ka = grep $_ != $hdl, @{ $KA_CACHE{$ka_key} }; |
|
|
622 | |
|
|
623 | $hdl->destroy; |
|
|
624 | |
|
|
625 | @ka |
|
|
626 | ? $KA_CACHE{$ka_key} = \@ka |
|
|
627 | : delete $KA_CACHE{$ka_key}; |
|
|
628 | }; |
|
|
629 | |
|
|
630 | # on error etc., destroy |
|
|
631 | $hdl->on_error ($destroy); |
|
|
632 | $hdl->on_eof ($destroy); |
|
|
633 | $hdl->on_read ($destroy); |
|
|
634 | $hdl->timeout ($PERSISTENT_TIMEOUT); |
|
|
635 | |
|
|
636 | push @$kaa, $hdl; |
|
|
637 | shift @$kaa while @$kaa > $MAX_PER_HOST; |
|
|
638 | } |
|
|
639 | |
|
|
640 | ############################################################################# |
|
|
641 | # utilities |
|
|
642 | |
540 | # continue to parse $_ for headers and place them into the arg |
643 | # continue to parse $_ for headers and place them into the arg |
541 | sub parse_hdr() { |
644 | sub _parse_hdr() { |
542 | my %hdr; |
645 | my %hdr; |
543 | |
646 | |
544 | # things seen, not parsed: |
647 | # things seen, not parsed: |
545 | # p3pP="NON CUR OTPi OUR NOR UNI" |
648 | # p3pP="NON CUR OTPi OUR NOR UNI" |
546 | |
649 | |
… | |
… | |
560 | for values %hdr; |
663 | for values %hdr; |
561 | |
664 | |
562 | \%hdr |
665 | \%hdr |
563 | } |
666 | } |
564 | |
667 | |
|
|
668 | ############################################################################# |
|
|
669 | # http_get |
|
|
670 | |
565 | our $qr_nlnl = qr{(?<![^\012])\015?\012}; |
671 | our $qr_nlnl = qr{(?<![^\012])\015?\012}; |
566 | |
672 | |
567 | our $TLS_CTX_LOW = { cache => 1, sslv2 => 1 }; |
673 | our $TLS_CTX_LOW = { cache => 1, sslv2 => 1 }; |
568 | our $TLS_CTX_HIGH = { cache => 1, verify => 1, verify_peername => "https" }; |
674 | our $TLS_CTX_HIGH = { cache => 1, verify => 1, verify_peername => "https" }; |
|
|
675 | |
|
|
676 | # maybe it should just become a normal object :/ |
|
|
677 | |
|
|
678 | sub _destroy_state(\%) { |
|
|
679 | my ($state) = @_; |
|
|
680 | |
|
|
681 | $state->{handle}->destroy if $state->{handle}; |
|
|
682 | %$state = (); |
|
|
683 | } |
|
|
684 | |
|
|
685 | sub _error(\%$$) { |
|
|
686 | my ($state, $cb, $hdr) = @_; |
|
|
687 | |
|
|
688 | &_destroy_state ($state); |
|
|
689 | |
|
|
690 | $cb->(undef, $hdr); |
|
|
691 | () |
|
|
692 | } |
|
|
693 | |
|
|
694 | our %IDEMPOTENT = ( |
|
|
695 | DELETE => 1, |
|
|
696 | GET => 1, |
|
|
697 | HEAD => 1, |
|
|
698 | OPTIONS => 1, |
|
|
699 | PUT => 1, |
|
|
700 | TRACE => 1, |
|
|
701 | |
|
|
702 | ACL => 1, |
|
|
703 | "BASELINE-CONTROL" => 1, |
|
|
704 | BIND => 1, |
|
|
705 | CHECKIN => 1, |
|
|
706 | CHECKOUT => 1, |
|
|
707 | COPY => 1, |
|
|
708 | LABEL => 1, |
|
|
709 | LINK => 1, |
|
|
710 | MERGE => 1, |
|
|
711 | MKACTIVITY => 1, |
|
|
712 | MKCALENDAR => 1, |
|
|
713 | MKCOL => 1, |
|
|
714 | MKREDIRECTREF => 1, |
|
|
715 | MKWORKSPACE => 1, |
|
|
716 | MOVE => 1, |
|
|
717 | ORDERPATCH => 1, |
|
|
718 | PROPFIND => 1, |
|
|
719 | PROPPATCH => 1, |
|
|
720 | REBIND => 1, |
|
|
721 | REPORT => 1, |
|
|
722 | SEARCH => 1, |
|
|
723 | UNBIND => 1, |
|
|
724 | UNCHECKOUT => 1, |
|
|
725 | UNLINK => 1, |
|
|
726 | UNLOCK => 1, |
|
|
727 | UPDATE => 1, |
|
|
728 | UPDATEREDIRECTREF => 1, |
|
|
729 | "VERSION-CONTROL" => 1, |
|
|
730 | ); |
569 | |
731 | |
570 | sub http_request($$@) { |
732 | sub http_request($$@) { |
571 | my $cb = pop; |
733 | my $cb = pop; |
572 | my ($method, $url, %arg) = @_; |
734 | my ($method, $url, %arg) = @_; |
573 | |
735 | |
… | |
… | |
591 | my $recurse = exists $arg{recurse} ? delete $arg{recurse} : $MAX_RECURSE; |
753 | my $recurse = exists $arg{recurse} ? delete $arg{recurse} : $MAX_RECURSE; |
592 | |
754 | |
593 | return $cb->(undef, { @pseudo, Status => 599, Reason => "Too many redirections" }) |
755 | return $cb->(undef, { @pseudo, Status => 599, Reason => "Too many redirections" }) |
594 | if $recurse < 0; |
756 | if $recurse < 0; |
595 | |
757 | |
596 | my $proxy = $arg{proxy} || $PROXY; |
758 | my $proxy = exists $arg{proxy} ? $arg{proxy} : $PROXY; |
597 | my $timeout = $arg{timeout} || $TIMEOUT; |
759 | my $timeout = $arg{timeout} || $TIMEOUT; |
598 | |
760 | |
599 | my ($uscheme, $uauthority, $upath, $query, $fragment) = |
761 | my ($uscheme, $uauthority, $upath, $query, undef) = # ignore fragment |
600 | $url =~ m|(?:([^:/?#]+):)?(?://([^/?#]*))?([^?#]*)(?:(\?[^#]*))?(?:#(.*))?|; |
762 | $url =~ m|^([^:]+):(?://([^/?#]*))?([^?#]*)(?:(\?[^#]*))?(?:#(.*))?$|; |
601 | |
763 | |
602 | $uscheme = lc $uscheme; |
764 | $uscheme = lc $uscheme; |
603 | |
765 | |
604 | my $uport = $uscheme eq "http" ? 80 |
766 | my $uport = $uscheme eq "http" ? 80 |
605 | : $uscheme eq "https" ? 443 |
767 | : $uscheme eq "https" ? 443 |
… | |
… | |
649 | $hdr{"user-agent"} = $USERAGENT unless exists $hdr{"user-agent"}; |
811 | $hdr{"user-agent"} = $USERAGENT unless exists $hdr{"user-agent"}; |
650 | |
812 | |
651 | $hdr{"content-length"} = length $arg{body} |
813 | $hdr{"content-length"} = length $arg{body} |
652 | if length $arg{body} || $method ne "GET"; |
814 | if length $arg{body} || $method ne "GET"; |
653 | |
815 | |
654 | my $idempotent = $method =~ /^(?:GET|HEAD|PUT|DELETE|OPTIONS|TRACE)$/; |
816 | my $idempotent = $IDEMPOTENT{$method}; |
655 | |
817 | |
656 | # default value for keepalive is true iff the request is for an idempotent method |
818 | # default value for keepalive is true iff the request is for an idempotent method |
657 | my $keepalive = exists $arg{keepalive} |
819 | my $persistent = exists $arg{persistent} ? !!$arg{persistent} : $idempotent; |
658 | ? $arg{keepalive}*1 |
820 | my $keepalive = exists $arg{keepalive} ? !!$arg{keepalive} : !$proxy; |
659 | : $idempotent ? $PERSISTENT_TIMEOUT : 0; |
821 | my $was_persistent; # true if this is actually a recycled connection |
660 | |
822 | |
|
|
823 | # the key to use in the keepalive cache |
|
|
824 | my $ka_key = "$uscheme\x00$uhost\x00$uport\x00$arg{sessionid}"; |
|
|
825 | |
661 | $hdr{connection} = ($keepalive ? "" : "close ") . "Te"; #1.1 |
826 | $hdr{connection} = ($persistent ? $keepalive ? "keep-alive " : "" : "close ") . "Te"; #1.1 |
662 | $hdr{te} = "trailers" unless exists $hdr{te}; #1.1 |
827 | $hdr{te} = "trailers" unless exists $hdr{te}; #1.1 |
663 | |
828 | |
664 | my %state = (connect_guard => 1); |
829 | my %state = (connect_guard => 1); |
665 | |
830 | |
666 | my $ae_error = 595; # connecting |
831 | my $ae_error = 595; # connecting |
667 | |
832 | |
668 | # handle actual, non-tunneled, request |
833 | # handle actual, non-tunneled, request |
669 | my $handle_actual_request = sub { |
834 | my $handle_actual_request = sub { |
670 | $ae_error = 596; # request phase |
835 | $ae_error = 596; # request phase |
671 | |
836 | |
|
|
837 | my $hdl = $state{handle}; |
|
|
838 | |
672 | $state{handle}->starttls ("connect") if $uscheme eq "https" && !exists $state{handle}{tls}; |
839 | $hdl->starttls ("connect") if $uscheme eq "https" && !exists $hdl->{tls}; |
673 | |
840 | |
674 | # send request |
841 | # send request |
675 | $state{handle}->push_write ( |
842 | $hdl->push_write ( |
676 | "$method $rpath HTTP/1.1\015\012" |
843 | "$method $rpath HTTP/1.1\015\012" |
677 | . (join "", map "\u$_: $hdr{$_}\015\012", grep defined $hdr{$_}, keys %hdr) |
844 | . (join "", map "\u$_: $hdr{$_}\015\012", grep defined $hdr{$_}, keys %hdr) |
678 | . "\015\012" |
845 | . "\015\012" |
679 | . (delete $arg{body}) |
846 | . (delete $arg{body}) |
680 | ); |
847 | ); |
… | |
… | |
685 | # reduce memory usage, save a kitten, also re-use it for the response headers. |
852 | # reduce memory usage, save a kitten, also re-use it for the response headers. |
686 | %hdr = (); |
853 | %hdr = (); |
687 | |
854 | |
688 | # status line and headers |
855 | # status line and headers |
689 | $state{read_response} = sub { |
856 | $state{read_response} = sub { |
|
|
857 | return unless %state; |
|
|
858 | |
690 | for ("$_[1]") { |
859 | for ("$_[1]") { |
691 | y/\015//d; # weed out any \015, as they show up in the weirdest of places. |
860 | y/\015//d; # weed out any \015, as they show up in the weirdest of places. |
692 | |
861 | |
693 | /^HTTP\/0*([0-9\.]+) \s+ ([0-9]{3}) (?: \s+ ([^\012]*) )? \012/gxci |
862 | /^HTTP\/0*([0-9\.]+) \s+ ([0-9]{3}) (?: \s+ ([^\012]*) )? \012/gxci |
694 | or return (%state = (), $cb->(undef, { @pseudo, Status => 599, Reason => "Invalid server response" })); |
863 | or return _error %state, $cb, { @pseudo, Status => 599, Reason => "Invalid server response" }; |
695 | |
864 | |
696 | # 100 Continue handling |
865 | # 100 Continue handling |
697 | # should not happen as we don't send expect: 100-continue, |
866 | # should not happen as we don't send expect: 100-continue, |
698 | # but we handle it just in case. |
867 | # but we handle it just in case. |
699 | # since we send the request body regardless, if we get an error |
868 | # since we send the request body regardless, if we get an error |
… | |
… | |
705 | HTTPVersion => $1, |
874 | HTTPVersion => $1, |
706 | Status => $2, |
875 | Status => $2, |
707 | Reason => $3, |
876 | Reason => $3, |
708 | ; |
877 | ; |
709 | |
878 | |
710 | my $hdr = parse_hdr |
879 | my $hdr = _parse_hdr |
711 | or return (%state = (), $cb->(undef, { @pseudo, Status => 599, Reason => "Garbled response headers" })); |
880 | or return _error %state, $cb, { @pseudo, Status => 599, Reason => "Garbled response headers" }; |
712 | |
881 | |
713 | %hdr = (%$hdr, @pseudo); |
882 | %hdr = (%$hdr, @pseudo); |
714 | } |
883 | } |
715 | |
884 | |
716 | # redirect handling |
885 | # redirect handling |
… | |
… | |
746 | } elsif ($status == 307) { |
915 | } elsif ($status == 307) { |
747 | $redirect = 1; |
916 | $redirect = 1; |
748 | } |
917 | } |
749 | } |
918 | } |
750 | |
919 | |
751 | my $finish = sub { # ($data, $err_status, $err_reason[, $keepalive]) |
920 | my $finish = sub { # ($data, $err_status, $err_reason[, $persistent]) |
752 | my $may_keep_alive = $_[3]; |
921 | if ($state{handle}) { |
753 | |
922 | # handle keepalive |
|
|
923 | if ( |
|
|
924 | $persistent |
|
|
925 | && $_[3] |
|
|
926 | && ($hdr{HTTPVersion} < 1.1 |
|
|
927 | ? $hdr{connection} =~ /\bkeep-?alive\b/i |
|
|
928 | : $hdr{connection} !~ /\bclose\b/i) |
|
|
929 | ) { |
|
|
930 | ka_store $ka_key, delete $state{handle}; |
|
|
931 | } else { |
|
|
932 | # no keepalive, destroy the handle |
754 | $state{handle}->destroy if $state{handle}; |
933 | $state{handle}->destroy; |
|
|
934 | } |
|
|
935 | } |
|
|
936 | |
755 | %state = (); |
937 | %state = (); |
756 | |
938 | |
757 | if (defined $_[1]) { |
939 | if (defined $_[1]) { |
758 | $hdr{OrigStatus} = $hdr{Status}; $hdr{Status} = $_[1]; |
940 | $hdr{OrigStatus} = $hdr{Status}; $hdr{Status} = $_[1]; |
759 | $hdr{OrigReason} = $hdr{Reason}; $hdr{Reason} = $_[2]; |
941 | $hdr{OrigReason} = $hdr{Reason}; $hdr{Reason} = $_[2]; |
… | |
… | |
766 | |
948 | |
767 | if ($redirect && exists $hdr{location}) { |
949 | if ($redirect && exists $hdr{location}) { |
768 | # we ignore any errors, as it is very common to receive |
950 | # we ignore any errors, as it is very common to receive |
769 | # Content-Length != 0 but no actual body |
951 | # Content-Length != 0 but no actual body |
770 | # we also access %hdr, as $_[1] might be an erro |
952 | # we also access %hdr, as $_[1] might be an erro |
|
|
953 | $state{recurse} = |
771 | http_request ( |
954 | http_request ( |
772 | $method => $hdr{location}, |
955 | $method => $hdr{location}, |
773 | %arg, |
956 | %arg, |
774 | recurse => $recurse - 1, |
957 | recurse => $recurse - 1, |
775 | Redirect => [$_[0], \%hdr], |
958 | Redirect => [$_[0], \%hdr], |
|
|
959 | sub { |
|
|
960 | %state = (); |
|
|
961 | &$cb |
|
|
962 | }, |
776 | $cb); |
963 | ); |
777 | } else { |
964 | } else { |
778 | $cb->($_[0], \%hdr); |
965 | $cb->($_[0], \%hdr); |
779 | } |
966 | } |
780 | }; |
967 | }; |
781 | |
968 | |
782 | $ae_error = 597; # body phase |
969 | $ae_error = 597; # body phase |
783 | |
970 | |
|
|
971 | my $chunked = $hdr{"transfer-encoding"} =~ /\bchunked\b/i; # not quite correct... |
|
|
972 | |
784 | my $len = $hdr{"content-length"}; |
973 | my $len = $chunked ? undef : $hdr{"content-length"}; |
785 | |
974 | |
786 | # body handling, many different code paths |
975 | # body handling, many different code paths |
787 | # - no body expected |
976 | # - no body expected |
788 | # - want_body_handle |
977 | # - want_body_handle |
789 | # - te chunked |
978 | # - te chunked |
… | |
… | |
804 | $_[0]->on_error (undef); |
993 | $_[0]->on_error (undef); |
805 | $_[0]->on_read (undef); |
994 | $_[0]->on_read (undef); |
806 | |
995 | |
807 | $finish->(delete $state{handle}); |
996 | $finish->(delete $state{handle}); |
808 | |
997 | |
809 | } elsif ($hdr{"transfer-encoding"} =~ /\bchunked\b/i) { |
998 | } elsif ($chunked) { |
810 | my $cl = 0; |
999 | my $cl = 0; |
811 | my $body = undef; |
1000 | my $body = ""; |
812 | my $on_body = $arg{on_body} || sub { $body .= shift; 1 }; |
1001 | my $on_body = $arg{on_body} || sub { $body .= shift; 1 }; |
813 | |
1002 | |
814 | $state{read_chunk} = sub { |
1003 | $state{read_chunk} = sub { |
815 | $_[1] =~ /^([0-9a-fA-F]+)/ |
1004 | $_[1] =~ /^([0-9a-fA-F]+)/ |
816 | or $finish->(undef, $ae_error => "Garbled chunked transfer encoding"); |
1005 | or return $finish->(undef, $ae_error => "Garbled chunked transfer encoding"); |
817 | |
1006 | |
818 | my $len = hex $1; |
1007 | my $len = hex $1; |
819 | |
1008 | |
820 | if ($len) { |
1009 | if ($len) { |
821 | $cl += $len; |
1010 | $cl += $len; |
… | |
… | |
836 | $_[0]->push_read (line => $qr_nlnl, sub { |
1025 | $_[0]->push_read (line => $qr_nlnl, sub { |
837 | if (length $_[1]) { |
1026 | if (length $_[1]) { |
838 | for ("$_[1]") { |
1027 | for ("$_[1]") { |
839 | y/\015//d; # weed out any \015, as they show up in the weirdest of places. |
1028 | y/\015//d; # weed out any \015, as they show up in the weirdest of places. |
840 | |
1029 | |
841 | my $hdr = parse_hdr |
1030 | my $hdr = _parse_hdr |
842 | or return $finish->(undef, $ae_error => "Garbled response trailers"); |
1031 | or return $finish->(undef, $ae_error => "Garbled response trailers"); |
843 | |
1032 | |
844 | %hdr = (%hdr, %$hdr); |
1033 | %hdr = (%hdr, %$hdr); |
845 | } |
1034 | } |
846 | } |
1035 | } |
… | |
… | |
889 | $_[0]->on_read (sub { }); |
1078 | $_[0]->on_read (sub { }); |
890 | } |
1079 | } |
891 | } |
1080 | } |
892 | }; |
1081 | }; |
893 | |
1082 | |
|
|
1083 | # if keepalive is enabled, then the server closing the connection |
|
|
1084 | # before a response can happen legally - we retry on idempotent methods. |
|
|
1085 | if ($was_persistent && $idempotent) { |
|
|
1086 | my $old_eof = $hdl->{on_eof}; |
|
|
1087 | $hdl->{on_eof} = sub { |
|
|
1088 | _destroy_state %state; |
|
|
1089 | |
|
|
1090 | %state = (); |
|
|
1091 | $state{recurse} = |
|
|
1092 | http_request ( |
|
|
1093 | $method => $url, |
|
|
1094 | %arg, |
|
|
1095 | recurse => $recurse - 1, |
|
|
1096 | keepalive => 0, |
|
|
1097 | sub { |
|
|
1098 | %state = (); |
|
|
1099 | &$cb |
|
|
1100 | } |
|
|
1101 | ); |
|
|
1102 | }; |
|
|
1103 | $hdl->on_read (sub { |
|
|
1104 | return unless %state; |
|
|
1105 | |
|
|
1106 | # as soon as we receive something, a connection close |
|
|
1107 | # once more becomes a hard error |
|
|
1108 | $hdl->{on_eof} = $old_eof; |
|
|
1109 | $hdl->push_read (line => $qr_nlnl, $state{read_response}); |
|
|
1110 | }); |
|
|
1111 | } else { |
894 | $state{handle}->push_read (line => $qr_nlnl, $state{read_response}); |
1112 | $hdl->push_read (line => $qr_nlnl, $state{read_response}); |
|
|
1113 | } |
895 | }; |
1114 | }; |
896 | |
1115 | |
|
|
1116 | my $prepare_handle = sub { |
|
|
1117 | my ($hdl) = $state{handle}; |
|
|
1118 | |
|
|
1119 | $hdl->on_error (sub { |
|
|
1120 | _error %state, $cb, { @pseudo, Status => $ae_error, Reason => $_[2] }; |
|
|
1121 | }); |
|
|
1122 | $hdl->on_eof (sub { |
|
|
1123 | _error %state, $cb, { @pseudo, Status => $ae_error, Reason => "Unexpected end-of-file" }; |
|
|
1124 | }); |
|
|
1125 | $hdl->timeout_reset; |
|
|
1126 | $hdl->timeout ($timeout); |
|
|
1127 | }; |
|
|
1128 | |
|
|
1129 | # connected to proxy (or origin server) |
897 | my $connect_cb = sub { |
1130 | my $connect_cb = sub { |
898 | $state{fh} = shift |
1131 | my $fh = shift |
899 | or do { |
|
|
900 | my $err = "$!"; |
|
|
901 | %state = (); |
|
|
902 | return $cb->(undef, { @pseudo, Status => $ae_error, Reason => $err }); |
1132 | or return _error %state, $cb, { @pseudo, Status => $ae_error, Reason => "$!" }; |
903 | }; |
|
|
904 | |
1133 | |
905 | return unless delete $state{connect_guard}; |
1134 | return unless delete $state{connect_guard}; |
906 | |
1135 | |
907 | # get handle |
1136 | # get handle |
908 | $state{handle} = new AnyEvent::Handle |
1137 | $state{handle} = new AnyEvent::Handle |
|
|
1138 | %{ $arg{handle_params} }, |
909 | fh => $state{fh}, |
1139 | fh => $fh, |
910 | peername => $rhost, |
1140 | peername => $uhost, |
911 | tls_ctx => $arg{tls_ctx}, |
1141 | tls_ctx => $arg{tls_ctx}, |
912 | # these need to be reconfigured on keepalive handles |
|
|
913 | timeout => $timeout, |
|
|
914 | on_error => sub { |
|
|
915 | %state = (); |
|
|
916 | $cb->(undef, { @pseudo, Status => $ae_error, Reason => $_[2] }); |
|
|
917 | }, |
|
|
918 | on_eof => sub { |
|
|
919 | %state = (); |
|
|
920 | $cb->(undef, { @pseudo, Status => $ae_error, Reason => "Unexpected end-of-file" }); |
|
|
921 | }, |
|
|
922 | ; |
1142 | ; |
923 | |
1143 | |
924 | # limit the number of persistent connections |
1144 | $prepare_handle->(); |
925 | # keepalive not yet supported |
|
|
926 | # if ($KA_COUNT{$_[1]} < $MAX_PERSISTENT_PER_HOST) { |
|
|
927 | # ++$KA_COUNT{$_[1]}; |
|
|
928 | # $state{handle}{ka_count_guard} = AnyEvent::Util::guard { |
|
|
929 | # --$KA_COUNT{$_[1]} |
|
|
930 | # }; |
|
|
931 | # $hdr{connection} = "keep-alive"; |
|
|
932 | # } |
|
|
933 | |
1145 | |
934 | $state{handle}->starttls ("connect") if $rscheme eq "https"; |
1146 | #$state{handle}->starttls ("connect") if $rscheme eq "https"; |
935 | |
1147 | |
936 | # now handle proxy-CONNECT method |
1148 | # now handle proxy-CONNECT method |
937 | if ($proxy && $uscheme eq "https") { |
1149 | if ($proxy && $uscheme eq "https") { |
938 | # oh dear, we have to wrap it into a connect request |
1150 | # oh dear, we have to wrap it into a connect request |
939 | |
1151 | |
940 | # maybe re-use $uauthority with patched port? |
1152 | # maybe re-use $uauthority with patched port? |
941 | $state{handle}->push_write ("CONNECT $uhost:$uport HTTP/1.0\015\012\015\012"); |
1153 | $state{handle}->push_write ("CONNECT $uhost:$uport HTTP/1.0\015\012\015\012"); |
942 | $state{handle}->push_read (line => $qr_nlnl, sub { |
1154 | $state{handle}->push_read (line => $qr_nlnl, sub { |
943 | $_[1] =~ /^HTTP\/([0-9\.]+) \s+ ([0-9]{3}) (?: \s+ ([^\015\012]*) )?/ix |
1155 | $_[1] =~ /^HTTP\/([0-9\.]+) \s+ ([0-9]{3}) (?: \s+ ([^\015\012]*) )?/ix |
944 | or return (%state = (), $cb->(undef, { @pseudo, Status => 599, Reason => "Invalid proxy connect response ($_[1])" })); |
1156 | or return _error %state, $cb, { @pseudo, Status => 599, Reason => "Invalid proxy connect response ($_[1])" }; |
945 | |
1157 | |
946 | if ($2 == 200) { |
1158 | if ($2 == 200) { |
947 | $rpath = $upath; |
1159 | $rpath = $upath; |
948 | $handle_actual_request->(); |
1160 | $handle_actual_request->(); |
949 | } else { |
1161 | } else { |
950 | %state = (); |
|
|
951 | $cb->(undef, { @pseudo, Status => $2, Reason => $3 }); |
1162 | _error %state, $cb, { @pseudo, Status => $2, Reason => $3 }; |
952 | } |
1163 | } |
953 | }); |
1164 | }); |
954 | } else { |
1165 | } else { |
955 | $handle_actual_request->(); |
1166 | $handle_actual_request->(); |
956 | } |
1167 | } |
… | |
… | |
959 | _get_slot $uhost, sub { |
1170 | _get_slot $uhost, sub { |
960 | $state{slot_guard} = shift; |
1171 | $state{slot_guard} = shift; |
961 | |
1172 | |
962 | return unless $state{connect_guard}; |
1173 | return unless $state{connect_guard}; |
963 | |
1174 | |
|
|
1175 | # try to use an existing keepalive connection, but only if we, ourselves, plan |
|
|
1176 | # on a keepalive request (in theory, this should be a separate config option). |
|
|
1177 | if ($persistent && $KA_CACHE{$ka_key}) { |
|
|
1178 | $was_persistent = 1; |
|
|
1179 | |
|
|
1180 | $state{handle} = ka_fetch $ka_key; |
|
|
1181 | $state{handle}->destroyed |
|
|
1182 | and die "AnyEvent::HTTP: unexpectedly got a destructed handle (1), please report.";#d# |
|
|
1183 | $prepare_handle->(); |
|
|
1184 | $state{handle}->destroyed |
|
|
1185 | and die "AnyEvent::HTTP: unexpectedly got a destructed handle (2), please report.";#d# |
|
|
1186 | $handle_actual_request->(); |
|
|
1187 | |
|
|
1188 | } else { |
964 | my $tcp_connect = $arg{tcp_connect} |
1189 | my $tcp_connect = $arg{tcp_connect} |
965 | || do { require AnyEvent::Socket; \&AnyEvent::Socket::tcp_connect }; |
1190 | || do { require AnyEvent::Socket; \&AnyEvent::Socket::tcp_connect }; |
966 | |
1191 | |
967 | $state{connect_guard} = $tcp_connect->($rhost, $rport, $connect_cb, $arg{on_prepare} || sub { $timeout }); |
1192 | $state{connect_guard} = $tcp_connect->($rhost, $rport, $connect_cb, $arg{on_prepare} || sub { $timeout }); |
|
|
1193 | } |
968 | }; |
1194 | }; |
969 | |
1195 | |
970 | defined wantarray && AnyEvent::Util::guard { %state = () } |
1196 | defined wantarray && AnyEvent::Util::guard { _destroy_state %state } |
971 | } |
1197 | } |
972 | |
1198 | |
973 | sub http_get($@) { |
1199 | sub http_get($@) { |
974 | unshift @_, "GET"; |
1200 | unshift @_, "GET"; |
975 | &http_request |
1201 | &http_request |
… | |
… | |
993 | AnyEvent::HTTP uses the AnyEvent::Socket::tcp_connect function for |
1219 | AnyEvent::HTTP uses the AnyEvent::Socket::tcp_connect function for |
994 | the actual connection, which in turn uses AnyEvent::DNS to resolve |
1220 | the actual connection, which in turn uses AnyEvent::DNS to resolve |
995 | hostnames. The latter is a simple stub resolver and does no caching |
1221 | hostnames. The latter is a simple stub resolver and does no caching |
996 | on its own. If you want DNS caching, you currently have to provide |
1222 | on its own. If you want DNS caching, you currently have to provide |
997 | your own default resolver (by storing a suitable resolver object in |
1223 | your own default resolver (by storing a suitable resolver object in |
998 | C<$AnyEvent::DNS::RESOLVER>). |
1224 | C<$AnyEvent::DNS::RESOLVER>) or your own C<tcp_connect> callback. |
999 | |
1225 | |
1000 | =head2 GLOBAL FUNCTIONS AND VARIABLES |
1226 | =head2 GLOBAL FUNCTIONS AND VARIABLES |
1001 | |
1227 | |
1002 | =over 4 |
1228 | =over 4 |
1003 | |
1229 | |
1004 | =item AnyEvent::HTTP::set_proxy "proxy-url" |
1230 | =item AnyEvent::HTTP::set_proxy "proxy-url" |
1005 | |
1231 | |
1006 | Sets the default proxy server to use. The proxy-url must begin with a |
1232 | Sets the default proxy server to use. The proxy-url must begin with a |
1007 | string of the form C<http://host:port> (optionally C<https:...>), croaks |
1233 | string of the form C<http://host:port>, croaks otherwise. |
1008 | otherwise. |
|
|
1009 | |
1234 | |
1010 | To clear an already-set proxy, use C<undef>. |
1235 | To clear an already-set proxy, use C<undef>. |
|
|
1236 | |
|
|
1237 | When AnyEvent::HTTP is loaded for the first time it will query the |
|
|
1238 | default proxy from the operating system, currently by looking at |
|
|
1239 | C<$ENV{http_proxy>}. |
1011 | |
1240 | |
1012 | =item AnyEvent::HTTP::cookie_jar_expire $jar[, $session_end] |
1241 | =item AnyEvent::HTTP::cookie_jar_expire $jar[, $session_end] |
1013 | |
1242 | |
1014 | Remove all cookies from the cookie jar that have been expired. If |
1243 | Remove all cookies from the cookie jar that have been expired. If |
1015 | C<$session_end> is given and true, then additionally remove all session |
1244 | C<$session_end> is given and true, then additionally remove all session |
… | |
… | |
1025 | |
1254 | |
1026 | The key C<version> has to contain C<1>, otherwise the hash gets |
1255 | The key C<version> has to contain C<1>, otherwise the hash gets |
1027 | emptied. All other keys are hostnames or IP addresses pointing to |
1256 | emptied. All other keys are hostnames or IP addresses pointing to |
1028 | hash-references. The key for these inner hash references is the |
1257 | hash-references. The key for these inner hash references is the |
1029 | server path for which this cookie is meant, and the values are again |
1258 | server path for which this cookie is meant, and the values are again |
1030 | hash-references. The keys of those hash-references is the cookie name, and |
1259 | hash-references. Each key of those hash-references is a cookie name, and |
1031 | the value, you guessed it, is another hash-reference, this time with the |
1260 | the value, you guessed it, is another hash-reference, this time with the |
1032 | key-value pairs from the cookie, except for C<expires> and C<max-age>, |
1261 | key-value pairs from the cookie, except for C<expires> and C<max-age>, |
1033 | which have been replaced by a C<_expires> key that contains the cookie |
1262 | which have been replaced by a C<_expires> key that contains the cookie |
1034 | expiry timestamp. |
1263 | expiry timestamp. Session cookies are indicated by not having an |
|
|
1264 | C<_expires> key. |
1035 | |
1265 | |
1036 | Here is an example of a cookie jar with a single cookie, so you have a |
1266 | Here is an example of a cookie jar with a single cookie, so you have a |
1037 | chance of understanding the above paragraph: |
1267 | chance of understanding the above paragraph: |
1038 | |
1268 | |
1039 | { |
1269 | { |
… | |
… | |
1061 | |
1291 | |
1062 | =item $AnyEvent::HTTP::MAX_RECURSE |
1292 | =item $AnyEvent::HTTP::MAX_RECURSE |
1063 | |
1293 | |
1064 | The default value for the C<recurse> request parameter (default: C<10>). |
1294 | The default value for the C<recurse> request parameter (default: C<10>). |
1065 | |
1295 | |
|
|
1296 | =item $AnyEvent::HTTP::TIMEOUT |
|
|
1297 | |
|
|
1298 | The default timeout for connection operations (default: C<300>). |
|
|
1299 | |
1066 | =item $AnyEvent::HTTP::USERAGENT |
1300 | =item $AnyEvent::HTTP::USERAGENT |
1067 | |
1301 | |
1068 | The default value for the C<User-Agent> header (the default is |
1302 | The default value for the C<User-Agent> header (the default is |
1069 | C<Mozilla/5.0 (compatible; U; AnyEvent-HTTP/$VERSION; +http://software.schmorp.de/pkg/AnyEvent)>). |
1303 | C<Mozilla/5.0 (compatible; U; AnyEvent-HTTP/$VERSION; +http://software.schmorp.de/pkg/AnyEvent)>). |
1070 | |
1304 | |
1071 | =item $AnyEvent::HTTP::MAX_PER_HOST |
1305 | =item $AnyEvent::HTTP::MAX_PER_HOST |
1072 | |
1306 | |
1073 | The maximum number of concurrent connections to the same host (identified |
1307 | The maximum number of concurrent connections to the same host (identified |
1074 | by the hostname). If the limit is exceeded, then the additional requests |
1308 | by the hostname). If the limit is exceeded, then the additional requests |
1075 | are queued until previous connections are closed. |
1309 | are queued until previous connections are closed. Both persistent and |
|
|
1310 | non-persistent connections are counted in this limit. |
1076 | |
1311 | |
1077 | The default value for this is C<4>, and it is highly advisable to not |
1312 | The default value for this is C<4>, and it is highly advisable to not |
1078 | increase it. |
1313 | increase it much. |
|
|
1314 | |
|
|
1315 | For comparison: the RFC's recommend 4 non-persistent or 2 persistent |
|
|
1316 | connections, older browsers used 2, newers (such as firefox 3) typically |
|
|
1317 | use 6, and Opera uses 8 because like, they have the fastest browser and |
|
|
1318 | give a shit for everybody else on the planet. |
|
|
1319 | |
|
|
1320 | =item $AnyEvent::HTTP::PERSISTENT_TIMEOUT |
|
|
1321 | |
|
|
1322 | The time after which idle persistent connections get closed by |
|
|
1323 | AnyEvent::HTTP (default: C<3>). |
1079 | |
1324 | |
1080 | =item $AnyEvent::HTTP::ACTIVE |
1325 | =item $AnyEvent::HTTP::ACTIVE |
1081 | |
1326 | |
1082 | The number of active connections. This is not the number of currently |
1327 | The number of active connections. This is not the number of currently |
1083 | running requests, but the number of currently open and non-idle TCP |
1328 | running requests, but the number of currently open and non-idle TCP |
1084 | connections. This number of can be useful for load-leveling. |
1329 | connections. This number can be useful for load-leveling. |
1085 | |
1330 | |
1086 | =back |
1331 | =back |
1087 | |
1332 | |
1088 | =cut |
1333 | =cut |
1089 | |
1334 | |
… | |
… | |
1123 | # other formats fail in the loop below |
1368 | # other formats fail in the loop below |
1124 | |
1369 | |
1125 | for (0..11) { |
1370 | for (0..11) { |
1126 | if ($m eq $month[$_]) { |
1371 | if ($m eq $month[$_]) { |
1127 | require Time::Local; |
1372 | require Time::Local; |
1128 | return Time::Local::timegm ($S, $M, $H, $d, $_, $y); |
1373 | return eval { Time::Local::timegm ($S, $M, $H, $d, $_, $y) }; |
1129 | } |
1374 | } |
1130 | } |
1375 | } |
1131 | |
1376 | |
1132 | undef |
1377 | undef |
1133 | } |
1378 | } |
1134 | |
1379 | |
1135 | sub set_proxy($) { |
1380 | sub set_proxy($) { |
1136 | if (length $_[0]) { |
1381 | if (length $_[0]) { |
1137 | $_[0] =~ m%^(https?):// ([^:/]+) (?: : (\d*) )?%ix |
1382 | $_[0] =~ m%^(http):// ([^:/]+) (?: : (\d*) )?%ix |
1138 | or Carp::croak "$_[0]: invalid proxy URL"; |
1383 | or Carp::croak "$_[0]: invalid proxy URL"; |
1139 | $PROXY = [$2, $3 || 3128, $1] |
1384 | $PROXY = [$2, $3 || 3128, $1] |
1140 | } else { |
1385 | } else { |
1141 | undef $PROXY; |
1386 | undef $PROXY; |
1142 | } |
1387 | } |
… | |
… | |
1145 | # initialise proxy from environment |
1390 | # initialise proxy from environment |
1146 | eval { |
1391 | eval { |
1147 | set_proxy $ENV{http_proxy}; |
1392 | set_proxy $ENV{http_proxy}; |
1148 | }; |
1393 | }; |
1149 | |
1394 | |
|
|
1395 | =head2 SHOWCASE |
|
|
1396 | |
|
|
1397 | This section contaisn some more elaborate "real-world" examples or code |
|
|
1398 | snippets. |
|
|
1399 | |
|
|
1400 | =head2 HTTP/1.1 FILE DOWNLOAD |
|
|
1401 | |
|
|
1402 | Downloading files with HTTP can be quite tricky, especially when something |
|
|
1403 | goes wrong and you want to resume. |
|
|
1404 | |
|
|
1405 | Here is a function that initiates and resumes a download. It uses the |
|
|
1406 | last modified time to check for file content changes, and works with many |
|
|
1407 | HTTP/1.0 servers as well, and usually falls back to a complete re-download |
|
|
1408 | on older servers. |
|
|
1409 | |
|
|
1410 | It calls the completion callback with either C<undef>, which means a |
|
|
1411 | nonretryable error occured, C<0> when the download was partial and should |
|
|
1412 | be retried, and C<1> if it was successful. |
|
|
1413 | |
|
|
1414 | use AnyEvent::HTTP; |
|
|
1415 | |
|
|
1416 | sub download($$$) { |
|
|
1417 | my ($url, $file, $cb) = @_; |
|
|
1418 | |
|
|
1419 | open my $fh, "+<", $file |
|
|
1420 | or die "$file: $!"; |
|
|
1421 | |
|
|
1422 | my %hdr; |
|
|
1423 | my $ofs = 0; |
|
|
1424 | |
|
|
1425 | warn stat $fh; |
|
|
1426 | warn -s _; |
|
|
1427 | if (stat $fh and -s _) { |
|
|
1428 | $ofs = -s _; |
|
|
1429 | warn "-s is ", $ofs; |
|
|
1430 | $hdr{"if-unmodified-since"} = AnyEvent::HTTP::format_date +(stat _)[9]; |
|
|
1431 | $hdr{"range"} = "bytes=$ofs-"; |
|
|
1432 | } |
|
|
1433 | |
|
|
1434 | http_get $url, |
|
|
1435 | headers => \%hdr, |
|
|
1436 | on_header => sub { |
|
|
1437 | my ($hdr) = @_; |
|
|
1438 | |
|
|
1439 | if ($hdr->{Status} == 200 && $ofs) { |
|
|
1440 | # resume failed |
|
|
1441 | truncate $fh, $ofs = 0; |
|
|
1442 | } |
|
|
1443 | |
|
|
1444 | sysseek $fh, $ofs, 0; |
|
|
1445 | |
|
|
1446 | 1 |
|
|
1447 | }, |
|
|
1448 | on_body => sub { |
|
|
1449 | my ($data, $hdr) = @_; |
|
|
1450 | |
|
|
1451 | if ($hdr->{Status} =~ /^2/) { |
|
|
1452 | length $data == syswrite $fh, $data |
|
|
1453 | or return; # abort on write errors |
|
|
1454 | } |
|
|
1455 | |
|
|
1456 | 1 |
|
|
1457 | }, |
|
|
1458 | sub { |
|
|
1459 | my (undef, $hdr) = @_; |
|
|
1460 | |
|
|
1461 | my $status = $hdr->{Status}; |
|
|
1462 | |
|
|
1463 | if (my $time = AnyEvent::HTTP::parse_date $hdr->{"last-modified"}) { |
|
|
1464 | utime $fh, $time, $time; |
|
|
1465 | } |
|
|
1466 | |
|
|
1467 | if ($status == 200 || $status == 206 || $status == 416) { |
|
|
1468 | # download ok || resume ok || file already fully downloaded |
|
|
1469 | $cb->(1, $hdr); |
|
|
1470 | |
|
|
1471 | } elsif ($status == 412) { |
|
|
1472 | # file has changed while resuming, delete and retry |
|
|
1473 | unlink $file; |
|
|
1474 | $cb->(0, $hdr); |
|
|
1475 | |
|
|
1476 | } elsif ($status == 500 or $status == 503 or $status =~ /^59/) { |
|
|
1477 | # retry later |
|
|
1478 | $cb->(0, $hdr); |
|
|
1479 | |
|
|
1480 | } else { |
|
|
1481 | $cb->(undef, $hdr); |
|
|
1482 | } |
|
|
1483 | } |
|
|
1484 | ; |
|
|
1485 | } |
|
|
1486 | |
|
|
1487 | download "http://server/somelargefile", "/tmp/somelargefile", sub { |
|
|
1488 | if ($_[0]) { |
|
|
1489 | print "OK!\n"; |
|
|
1490 | } elsif (defined $_[0]) { |
|
|
1491 | print "please retry later\n"; |
|
|
1492 | } else { |
|
|
1493 | print "ERROR\n"; |
|
|
1494 | } |
|
|
1495 | }; |
|
|
1496 | |
1150 | =head2 SOCKS PROXIES |
1497 | =head3 SOCKS PROXIES |
1151 | |
1498 | |
1152 | Socks proxies are not directly supported by AnyEvent::HTTP. You can |
1499 | Socks proxies are not directly supported by AnyEvent::HTTP. You can |
1153 | compile your perl to support socks, or use an external program such as |
1500 | compile your perl to support socks, or use an external program such as |
1154 | F<socksify> (dante) or F<tsocks> to make your program use a socks proxy |
1501 | F<socksify> (dante) or F<tsocks> to make your program use a socks proxy |
1155 | transparently. |
1502 | transparently. |