… | |
… | |
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 |
… | |
… | |
36 | |
36 | |
37 | =cut |
37 | =cut |
38 | |
38 | |
39 | package AnyEvent::HTTP; |
39 | package AnyEvent::HTTP; |
40 | |
40 | |
41 | use strict; |
41 | use common::sense; |
42 | no warnings; |
|
|
43 | |
42 | |
44 | use Errno (); |
43 | use Errno (); |
45 | |
44 | |
46 | use AnyEvent 5.0 (); |
45 | use AnyEvent 5.0 (); |
47 | use AnyEvent::Util (); |
46 | use AnyEvent::Util (); |
48 | use AnyEvent::Handle (); |
47 | use AnyEvent::Handle (); |
49 | |
48 | |
50 | use base Exporter::; |
49 | use base Exporter::; |
51 | |
50 | |
52 | our $VERSION = '1.5'; |
51 | our $VERSION = '2.15'; |
53 | |
52 | |
54 | our @EXPORT = qw(http_get http_post http_head http_request); |
53 | our @EXPORT = qw(http_get http_post http_head http_request); |
55 | |
54 | |
56 | 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)"; |
57 | our $MAX_RECURSE = 10; |
56 | our $MAX_RECURSE = 10; |
58 | our $MAX_PERSISTENT = 8; |
|
|
59 | our $PERSISTENT_TIMEOUT = 2; |
57 | our $PERSISTENT_TIMEOUT = 3; |
60 | our $TIMEOUT = 300; |
58 | our $TIMEOUT = 300; |
61 | |
59 | our $MAX_PER_HOST = 4; # changing this is evil |
62 | # changing these is evil |
|
|
63 | our $MAX_PERSISTENT_PER_HOST = 0; |
|
|
64 | our $MAX_PER_HOST = 4; |
|
|
65 | |
60 | |
66 | our $PROXY; |
61 | our $PROXY; |
67 | our $ACTIVE = 0; |
62 | our $ACTIVE = 0; |
68 | |
63 | |
69 | my %KA_COUNT; # number of open keep-alive connections per host |
64 | my %KA_CACHE; # indexed by uhost currently, points to [$handle...] array |
70 | 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 |
71 | |
66 | |
72 | =item http_get $url, key => value..., $cb->($data, $headers) |
67 | =item http_get $url, key => value..., $cb->($data, $headers) |
73 | |
68 | |
74 | 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 |
… | |
… | |
122 | |
117 | |
123 | If the server sends a header multiple times, then their contents will be |
118 | If the server sends a header multiple times, then their contents will be |
124 | joined together with a comma (C<,>), as per the HTTP spec. |
119 | joined together with a comma (C<,>), as per the HTTP spec. |
125 | |
120 | |
126 | If an internal error occurs, such as not being able to resolve a hostname, |
121 | If an internal error occurs, such as not being able to resolve a hostname, |
127 | then C<$data> will be C<undef>, C<< $headers->{Status} >> will be C<59x> |
122 | then C<$data> will be C<undef>, C<< $headers->{Status} >> will be |
128 | (usually 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 |
129 | message. |
124 | message. Currently the following status codes are used: |
|
|
125 | |
|
|
126 | =over 4 |
|
|
127 | |
|
|
128 | =item 595 - errors during connection establishment, proxy handshake. |
|
|
129 | |
|
|
130 | =item 596 - errors during TLS negotiation, request sending and header processing. |
|
|
131 | |
|
|
132 | =item 597 - errors during body receiving or processing. |
|
|
133 | |
|
|
134 | =item 598 - user aborted request via C<on_header> or C<on_body>. |
|
|
135 | |
|
|
136 | =item 599 - other, usually nonretryable, errors (garbled URL etc.). |
|
|
137 | |
|
|
138 | =back |
130 | |
139 | |
131 | A typical callback might look like this: |
140 | A typical callback might look like this: |
132 | |
141 | |
133 | sub { |
142 | sub { |
134 | my ($body, $hdr) = @_; |
143 | my ($body, $hdr) = @_; |
… | |
… | |
145 | |
154 | |
146 | =over 4 |
155 | =over 4 |
147 | |
156 | |
148 | =item recurse => $count (default: $MAX_RECURSE) |
157 | =item recurse => $count (default: $MAX_RECURSE) |
149 | |
158 | |
150 | Whether to recurse requests or not, e.g. on redirects, authentication |
159 | Whether to recurse requests or not, e.g. on redirects, authentication and |
151 | retries and so on, and how often to do so. |
160 | other retries and so on, and how often to do so. |
152 | |
161 | |
153 | =item headers => hashref |
162 | =item headers => hashref |
154 | |
163 | |
155 | 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 |
156 | 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 |
157 | 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:> |
158 | (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 |
159 | they won't be sent at all). |
168 | they won't be sent at all). |
160 | |
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 | |
161 | =item timeout => $seconds |
177 | =item timeout => $seconds |
162 | |
178 | |
163 | 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 |
164 | 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 |
165 | timeout. |
181 | timeout. |
166 | |
182 | |
167 | Default timeout is 5 minutes. |
183 | Default timeout is 5 minutes. |
168 | |
184 | |
169 | =item proxy => [$host, $port[, $scheme]] or undef |
185 | =item proxy => [$host, $port[, $scheme]] or undef |
170 | |
186 | |
171 | 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 |
172 | default proxy (as specified by C<$ENV{http_proxy}>) is used. |
188 | used. |
173 | |
189 | |
174 | 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. |
175 | HTTPS. |
191 | |
|
|
192 | If not specified, then the default proxy is used (see |
|
|
193 | C<AnyEvent::HTTP::set_proxy>). |
176 | |
194 | |
177 | =item body => $string |
195 | =item body => $string |
178 | |
196 | |
179 | 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 |
180 | this module might offer more options). |
198 | this module might offer more options). |
… | |
… | |
182 | =item cookie_jar => $hash_ref |
200 | =item cookie_jar => $hash_ref |
183 | |
201 | |
184 | Passing this parameter enables (simplified) cookie-processing, loosely |
202 | Passing this parameter enables (simplified) cookie-processing, loosely |
185 | based on the original netscape specification. |
203 | based on the original netscape specification. |
186 | |
204 | |
187 | The C<$hash_ref> must be an (initially empty) hash reference which will |
205 | The C<$hash_ref> must be an (initially empty) hash reference which |
188 | get updated automatically. It is possible to save the cookie jar to |
206 | will get updated automatically. It is possible to save the cookie jar |
189 | persistent storage with something like JSON or Storable, but this is not |
207 | to persistent storage with something like JSON or Storable - see the |
190 | recommended, as session-only cookies might survive longer than expected. |
208 | C<AnyEvent::HTTP::cookie_jar_expire> function if you wish to remove |
|
|
209 | expired or session-only cookies, and also for documentation on the format |
|
|
210 | of the cookie jar. |
191 | |
211 | |
192 | Note that this cookie implementation is not meant to be complete. If |
212 | Note that this cookie implementation is not meant to be complete. If |
193 | you want complete cookie management you have to do that on your |
213 | you want complete cookie management you have to do that on your |
194 | own. C<cookie_jar> is meant as a quick fix to get some cookie-using sites |
214 | own. C<cookie_jar> is meant as a quick fix to get most cookie-using sites |
195 | working. Cookies are a privacy disaster, do not use them unless required |
215 | working. Cookies are a privacy disaster, do not use them unless required |
196 | to. |
216 | to. |
197 | |
217 | |
198 | When cookie processing is enabled, the C<Cookie:> and C<Set-Cookie:> |
218 | When cookie processing is enabled, the C<Cookie:> and C<Set-Cookie:> |
199 | headers will be set and handled by this module, otherwise they will be |
219 | headers will be set and handled by this module, otherwise they will be |
… | |
… | |
208 | verification, highest compatibility) and high-security (CA and common-name |
228 | verification, highest compatibility) and high-security (CA and common-name |
209 | verification) TLS context. |
229 | verification) TLS context. |
210 | |
230 | |
211 | 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 |
212 | 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. |
213 | |
243 | |
214 | =item on_prepare => $callback->($fh) |
244 | =item on_prepare => $callback->($fh) |
215 | |
245 | |
216 | 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 |
217 | 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 |
… | |
… | |
287 | 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 |
288 | callback will receive the L<AnyEvent::Handle> object associated with the |
318 | callback will receive the L<AnyEvent::Handle> object associated with the |
289 | 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 |
290 | (e.g. status C<304>), the empty string will be passed. |
320 | (e.g. status C<304>), the empty string will be passed. |
291 | |
321 | |
292 | 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 |
293 | a proxy, be a persistent connection etc., and configured in unspecified |
323 | to a proxy, be a persistent connection, use chunked transfer encoding |
294 | 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 |
295 | module anymore). |
325 | handle (it will not be used by this module anymore). |
296 | |
326 | |
297 | 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 |
298 | headers, an interactive protocol is used (typical example would be the |
328 | headers, an interactive protocol is used (typical example would be the |
299 | push-style twitter API which starts a JSON/XML stream). |
329 | push-style twitter API which starts a JSON/XML stream). |
300 | |
330 | |
301 | 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 |
302 | 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 | }, |
303 | |
374 | |
304 | =back |
375 | =back |
305 | |
376 | |
306 | 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 |
307 | the response body. |
378 | the response body. |
… | |
… | |
313 | |
384 | |
314 | 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 |
315 | timeout of 30 seconds. |
386 | timeout of 30 seconds. |
316 | |
387 | |
317 | http_request |
388 | http_request |
318 | GET => "https://www.google.com", |
389 | HEAD => "https://www.google.com", |
|
|
390 | headers => { "user-agent" => "MySearchClient 1.0" }, |
319 | timeout => 30, |
391 | timeout => 30, |
320 | sub { |
392 | sub { |
321 | my ($body, $hdr) = @_; |
393 | my ($body, $hdr) = @_; |
322 | use Data::Dumper; |
394 | use Data::Dumper; |
323 | print Dumper $hdr; |
395 | print Dumper $hdr; |
… | |
… | |
333 | }; |
405 | }; |
334 | |
406 | |
335 | undef $request; |
407 | undef $request; |
336 | |
408 | |
337 | =cut |
409 | =cut |
|
|
410 | |
|
|
411 | ############################################################################# |
|
|
412 | # wait queue/slots |
338 | |
413 | |
339 | sub _slot_schedule; |
414 | sub _slot_schedule; |
340 | sub _slot_schedule($) { |
415 | sub _slot_schedule($) { |
341 | my $host = shift; |
416 | my $host = shift; |
342 | |
417 | |
… | |
… | |
364 | push @{ $CO_SLOT{$_[0]}[1] }, $_[1]; |
439 | push @{ $CO_SLOT{$_[0]}[1] }, $_[1]; |
365 | |
440 | |
366 | _slot_schedule $_[0]; |
441 | _slot_schedule $_[0]; |
367 | } |
442 | } |
368 | |
443 | |
|
|
444 | ############################################################################# |
|
|
445 | # cookie handling |
|
|
446 | |
|
|
447 | # expire cookies |
|
|
448 | sub cookie_jar_expire($;$) { |
|
|
449 | my ($jar, $session_end) = @_; |
|
|
450 | |
|
|
451 | %$jar = () if $jar->{version} != 1; |
|
|
452 | |
|
|
453 | my $anow = AE::now; |
|
|
454 | |
|
|
455 | while (my ($chost, $paths) = each %$jar) { |
|
|
456 | next unless ref $paths; |
|
|
457 | |
|
|
458 | while (my ($cpath, $cookies) = each %$paths) { |
|
|
459 | while (my ($cookie, $kv) = each %$cookies) { |
|
|
460 | if (exists $kv->{_expires}) { |
|
|
461 | delete $cookies->{$cookie} |
|
|
462 | if $anow > $kv->{_expires}; |
|
|
463 | } elsif ($session_end) { |
|
|
464 | delete $cookies->{$cookie}; |
|
|
465 | } |
|
|
466 | } |
|
|
467 | |
|
|
468 | delete $paths->{$cpath} |
|
|
469 | unless %$cookies; |
|
|
470 | } |
|
|
471 | |
|
|
472 | delete $jar->{$chost} |
|
|
473 | unless %$paths; |
|
|
474 | } |
|
|
475 | } |
|
|
476 | |
369 | # extract cookies from jar |
477 | # extract cookies from jar |
370 | sub cookie_jar_extract($$$$) { |
478 | sub cookie_jar_extract($$$$) { |
371 | my ($jar, $uscheme, $uhost, $upath) = @_; |
479 | my ($jar, $scheme, $host, $path) = @_; |
372 | |
480 | |
373 | %$jar = () if $jar->{version} != 1; |
481 | %$jar = () if $jar->{version} != 1; |
374 | |
482 | |
375 | my @cookies; |
483 | my @cookies; |
376 | |
484 | |
377 | while (my ($chost, $paths) = each %$jar) { |
485 | while (my ($chost, $paths) = each %$jar) { |
378 | next unless ref $paths; |
486 | next unless ref $paths; |
379 | |
487 | |
380 | if ($chost =~ /^\./) { |
488 | if ($chost =~ /^\./) { |
381 | next unless $chost eq substr $uhost, -length $chost; |
489 | next unless $chost eq substr $host, -length $chost; |
382 | } elsif ($chost =~ /\./) { |
490 | } elsif ($chost =~ /\./) { |
383 | next unless $chost eq $uhost; |
491 | next unless $chost eq $host; |
384 | } else { |
492 | } else { |
385 | next; |
493 | next; |
386 | } |
494 | } |
387 | |
495 | |
388 | while (my ($cpath, $cookies) = each %$paths) { |
496 | while (my ($cpath, $cookies) = each %$paths) { |
389 | next unless $cpath eq substr $upath, 0, length $cpath; |
497 | next unless $cpath eq substr $path, 0, length $cpath; |
390 | |
498 | |
391 | while (my ($cookie, $kv) = each %$cookies) { |
499 | while (my ($cookie, $kv) = each %$cookies) { |
392 | next if $uscheme ne "https" && exists $kv->{secure}; |
500 | next if $scheme ne "https" && exists $kv->{secure}; |
393 | |
501 | |
394 | if (exists $kv->{expires}) { |
502 | if (exists $kv->{_expires} and AE::now > $kv->{_expires}) { |
395 | if (AE::now > parse_date ($kv->{expires})) { |
|
|
396 | delete $cookies->{$cookie}; |
503 | delete $cookies->{$cookie}; |
397 | next; |
504 | next; |
398 | } |
|
|
399 | } |
505 | } |
400 | |
506 | |
401 | my $value = $kv->{value}; |
507 | my $value = $kv->{value}; |
402 | |
508 | |
403 | if ($value =~ /[=;,[:space:]]/) { |
509 | if ($value =~ /[=;,[:space:]]/) { |
… | |
… | |
412 | |
518 | |
413 | \@cookies |
519 | \@cookies |
414 | } |
520 | } |
415 | |
521 | |
416 | # parse set_cookie header into jar |
522 | # parse set_cookie header into jar |
417 | sub cookie_jar_set_cookie($$) { |
523 | sub cookie_jar_set_cookie($$$$) { |
418 | my ($jar, $set_cookie) = @_; |
524 | my ($jar, $set_cookie, $host, $date) = @_; |
|
|
525 | |
|
|
526 | my $anow = int AE::now; |
|
|
527 | my $snow; # server-now |
419 | |
528 | |
420 | for ($set_cookie) { |
529 | for ($set_cookie) { |
421 | # parse NAME=VALUE |
530 | # parse NAME=VALUE |
422 | my @kv; |
531 | my @kv; |
423 | |
532 | |
|
|
533 | # expires is not http-compliant in the original cookie-spec, |
|
|
534 | # we support the official date format and some extensions |
424 | while ( |
535 | while ( |
425 | m{ |
536 | m{ |
426 | \G\s* |
537 | \G\s* |
427 | (?: |
538 | (?: |
428 | expires \s*=\s* ([A-Z][a-z][a-z],\ [^,;]+) |
539 | expires \s*=\s* ([A-Z][a-z][a-z]+,\ [^,;]+) |
429 | | ([^=;,[:space:]]+) \s*=\s* (?: "((?:[^\\"]+|\\.)*)" | ([^=;,[:space:]]*) ) |
540 | | ([^=;,[:space:]]+) (?: \s*=\s* (?: "((?:[^\\"]+|\\.)*)" | ([^;,[:space:]]*) ) )? |
430 | ) |
541 | ) |
431 | }gcxsi |
542 | }gcxsi |
432 | ) { |
543 | ) { |
433 | my $name = $2; |
544 | my $name = $2; |
434 | my $value = $4; |
545 | my $value = $4; |
435 | |
546 | |
436 | unless (defined $name) { |
547 | if (defined $1) { |
437 | # expires |
548 | # expires |
438 | $name = "expires"; |
549 | $name = "expires"; |
439 | $value = $1; |
550 | $value = $1; |
440 | } elsif (!defined $value) { |
551 | } elsif (defined $3) { |
441 | # quoted |
552 | # quoted |
442 | $value = $3; |
553 | $value = $3; |
443 | $value =~ s/\\(.)/$1/gs; |
554 | $value =~ s/\\(.)/$1/gs; |
444 | } |
555 | } |
445 | |
556 | |
446 | push @kv, lc $name, $value; |
557 | push @kv, @kv ? lc $name : $name, $value; |
447 | |
558 | |
448 | last unless /\G\s*;/gc; |
559 | last unless /\G\s*;/gc; |
449 | } |
560 | } |
450 | |
561 | |
451 | last unless @kv; |
562 | last unless @kv; |
452 | |
563 | |
453 | my $name = shift @kv; |
564 | my $name = shift @kv; |
454 | my %kv = (value => shift @kv, @kv); |
565 | my %kv = (value => shift @kv, @kv); |
455 | |
566 | |
456 | $kv{expires} ||= format_date (AE::now + $kv{"max-age"}) |
|
|
457 | if exists $kv{"max-age"}; |
567 | if (exists $kv{"max-age"}) { |
|
|
568 | $kv{_expires} = $anow + delete $kv{"max-age"}; |
|
|
569 | } elsif (exists $kv{expires}) { |
|
|
570 | $snow ||= parse_date ($date) || $anow; |
|
|
571 | $kv{_expires} = $anow + (parse_date (delete $kv{expires}) - $snow); |
|
|
572 | } else { |
|
|
573 | delete $kv{_expires}; |
|
|
574 | } |
458 | |
575 | |
459 | my $cdom; |
576 | my $cdom; |
460 | my $cpath = (delete $kv{path}) || "/"; |
577 | my $cpath = (delete $kv{path}) || "/"; |
461 | |
578 | |
462 | if (exists $kv{domain}) { |
579 | if (exists $kv{domain}) { |
… | |
… | |
468 | |
585 | |
469 | # this is not rfc-like and not netscape-like. go figure. |
586 | # this is not rfc-like and not netscape-like. go figure. |
470 | my $ndots = $cdom =~ y/.//; |
587 | my $ndots = $cdom =~ y/.//; |
471 | next if $ndots < ($cdom =~ /\.[^.][^.]\.[^.][^.]$/ ? 3 : 2); |
588 | next if $ndots < ($cdom =~ /\.[^.][^.]\.[^.][^.]$/ ? 3 : 2); |
472 | } else { |
589 | } else { |
473 | $cdom = $uhost; |
590 | $cdom = $host; |
474 | } |
591 | } |
475 | |
592 | |
476 | # store it |
593 | # store it |
477 | $arg{cookie_jar}{version} = 1; |
594 | $jar->{version} = 1; |
478 | $arg{cookie_jar}{$cdom}{$cpath}{$name} = \%kv; |
595 | $jar->{lc $cdom}{$cpath}{$name} = \%kv; |
479 | |
596 | |
480 | redo if /\G\s*,/gc; |
597 | redo if /\G\s*,/gc; |
481 | } |
598 | } |
482 | } |
599 | } |
|
|
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 |
483 | } |
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 |
484 | |
642 | |
485 | # continue to parse $_ for headers and place them into the arg |
643 | # continue to parse $_ for headers and place them into the arg |
486 | sub parse_hdr() { |
644 | sub _parse_hdr() { |
487 | my %hdr; |
645 | my %hdr; |
488 | |
646 | |
489 | # things seen, not parsed: |
647 | # things seen, not parsed: |
490 | # p3pP="NON CUR OTPi OUR NOR UNI" |
648 | # p3pP="NON CUR OTPi OUR NOR UNI" |
491 | |
649 | |
… | |
… | |
505 | for values %hdr; |
663 | for values %hdr; |
506 | |
664 | |
507 | \%hdr |
665 | \%hdr |
508 | } |
666 | } |
509 | |
667 | |
|
|
668 | ############################################################################# |
|
|
669 | # http_get |
|
|
670 | |
510 | our $qr_nlnl = qr{(?<![^\012])\015?\012}; |
671 | our $qr_nlnl = qr{(?<![^\012])\015?\012}; |
511 | |
672 | |
512 | our $TLS_CTX_LOW = { cache => 1, sslv2 => 1 }; |
673 | our $TLS_CTX_LOW = { cache => 1, sslv2 => 1 }; |
513 | 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 | } |
514 | |
693 | |
515 | sub http_request($$@) { |
694 | sub http_request($$@) { |
516 | my $cb = pop; |
695 | my $cb = pop; |
517 | my ($method, $url, %arg) = @_; |
696 | my ($method, $url, %arg) = @_; |
518 | |
697 | |
… | |
… | |
536 | my $recurse = exists $arg{recurse} ? delete $arg{recurse} : $MAX_RECURSE; |
715 | my $recurse = exists $arg{recurse} ? delete $arg{recurse} : $MAX_RECURSE; |
537 | |
716 | |
538 | return $cb->(undef, { @pseudo, Status => 599, Reason => "Too many redirections" }) |
717 | return $cb->(undef, { @pseudo, Status => 599, Reason => "Too many redirections" }) |
539 | if $recurse < 0; |
718 | if $recurse < 0; |
540 | |
719 | |
541 | my $proxy = $arg{proxy} || $PROXY; |
720 | my $proxy = exists $arg{proxy} ? $arg{proxy} : $PROXY; |
542 | my $timeout = $arg{timeout} || $TIMEOUT; |
721 | my $timeout = $arg{timeout} || $TIMEOUT; |
543 | |
722 | |
544 | my ($uscheme, $uauthority, $upath, $query, $fragment) = |
723 | my ($uscheme, $uauthority, $upath, $query, undef) = # ignore fragment |
545 | $url =~ m|(?:([^:/?#]+):)?(?://([^/?#]*))?([^?#]*)(?:(\?[^#]*))?(?:#(.*))?|; |
724 | $url =~ m|^([^:]+):(?://([^/?#]*))?([^?#]*)(?:(\?[^#]*))?(?:#(.*))?$|; |
546 | |
725 | |
547 | $uscheme = lc $uscheme; |
726 | $uscheme = lc $uscheme; |
548 | |
727 | |
549 | my $uport = $uscheme eq "http" ? 80 |
728 | my $uport = $uscheme eq "http" ? 80 |
550 | : $uscheme eq "https" ? 443 |
729 | : $uscheme eq "https" ? 443 |
551 | : return $cb->(undef, { @pseudo, Status => 599, Reason => "Only http and https URL schemes supported" }); |
730 | : return $cb->(undef, { @pseudo, Status => 599, Reason => "Only http and https URL schemes supported" }); |
552 | |
731 | |
553 | $uauthority =~ /^(?: .*\@ )? ([^\@:]+) (?: : (\d+) )?$/x |
732 | $uauthority =~ /^(?: .*\@ )? ([^\@:]+) (?: : (\d+) )?$/x |
554 | or return $cb->(undef, { @pseudo, Status => 599, Reason => "Unparsable URL" }); |
733 | or return $cb->(undef, { @pseudo, Status => 599, Reason => "Unparsable URL" }); |
555 | |
734 | |
556 | my $uhost = $1; |
735 | my $uhost = lc $1; |
557 | $uport = $2 if defined $2; |
736 | $uport = $2 if defined $2; |
558 | |
737 | |
559 | $hdr{host} = defined $2 ? "$uhost:$2" : "$uhost" |
738 | $hdr{host} = defined $2 ? "$uhost:$2" : "$uhost" |
560 | unless exists $hdr{host}; |
739 | unless exists $hdr{host}; |
561 | |
740 | |
… | |
… | |
580 | $rscheme = "http" unless defined $rscheme; |
759 | $rscheme = "http" unless defined $rscheme; |
581 | |
760 | |
582 | # don't support https requests over https-proxy transport, |
761 | # don't support https requests over https-proxy transport, |
583 | # can't be done with tls as spec'ed, unless you double-encrypt. |
762 | # can't be done with tls as spec'ed, unless you double-encrypt. |
584 | $rscheme = "http" if $uscheme eq "https" && $rscheme eq "https"; |
763 | $rscheme = "http" if $uscheme eq "https" && $rscheme eq "https"; |
|
|
764 | |
|
|
765 | $rhost = lc $rhost; |
|
|
766 | $rscheme = lc $rscheme; |
585 | } else { |
767 | } else { |
586 | ($rhost, $rport, $rscheme, $rpath) = ($uhost, $uport, $uscheme, $upath); |
768 | ($rhost, $rport, $rscheme, $rpath) = ($uhost, $uport, $uscheme, $upath); |
587 | } |
769 | } |
588 | |
770 | |
589 | # leave out fragment and query string, just a heuristic |
771 | # leave out fragment and query string, just a heuristic |
… | |
… | |
591 | $hdr{"user-agent"} = $USERAGENT unless exists $hdr{"user-agent"}; |
773 | $hdr{"user-agent"} = $USERAGENT unless exists $hdr{"user-agent"}; |
592 | |
774 | |
593 | $hdr{"content-length"} = length $arg{body} |
775 | $hdr{"content-length"} = length $arg{body} |
594 | if length $arg{body} || $method ne "GET"; |
776 | if length $arg{body} || $method ne "GET"; |
595 | |
777 | |
596 | $hdr{connection} = "close TE"; #1.1 |
778 | my $idempotent = $method =~ /^(?:GET|HEAD|PUT|DELETE|OPTIONS|TRACE)$/; |
|
|
779 | |
|
|
780 | # default value for keepalive is true iff the request is for an idempotent method |
|
|
781 | my $persistent = exists $arg{persistent} ? !!$arg{persistent} : $idempotent; |
|
|
782 | my $keepalive = exists $arg{keepalive} ? !!$arg{keepalive} : !$proxy; |
|
|
783 | my $was_persistent; # true if this is actually a recycled connection |
|
|
784 | |
|
|
785 | # the key to use in the keepalive cache |
|
|
786 | my $ka_key = "$uscheme\x00$uhost\x00$uport\x00$arg{sessionid}"; |
|
|
787 | |
|
|
788 | $hdr{connection} = ($persistent ? $keepalive ? "keep-alive " : "" : "close ") . "Te"; #1.1 |
597 | $hdr{te} = "trailers" unless exists $hdr{te}; #1.1 |
789 | $hdr{te} = "trailers" unless exists $hdr{te}; #1.1 |
598 | |
790 | |
599 | my %state = (connect_guard => 1); |
791 | my %state = (connect_guard => 1); |
|
|
792 | |
|
|
793 | my $ae_error = 595; # connecting |
|
|
794 | |
|
|
795 | # handle actual, non-tunneled, request |
|
|
796 | my $handle_actual_request = sub { |
|
|
797 | $ae_error = 596; # request phase |
|
|
798 | |
|
|
799 | my $hdl = $state{handle}; |
|
|
800 | |
|
|
801 | $hdl->starttls ("connect") if $uscheme eq "https" && !exists $hdl->{tls}; |
|
|
802 | |
|
|
803 | # send request |
|
|
804 | $hdl->push_write ( |
|
|
805 | "$method $rpath HTTP/1.1\015\012" |
|
|
806 | . (join "", map "\u$_: $hdr{$_}\015\012", grep defined $hdr{$_}, keys %hdr) |
|
|
807 | . "\015\012" |
|
|
808 | . (delete $arg{body}) |
|
|
809 | ); |
|
|
810 | |
|
|
811 | # return if error occured during push_write() |
|
|
812 | return unless %state; |
|
|
813 | |
|
|
814 | # reduce memory usage, save a kitten, also re-use it for the response headers. |
|
|
815 | %hdr = (); |
|
|
816 | |
|
|
817 | # status line and headers |
|
|
818 | $state{read_response} = sub { |
|
|
819 | return unless %state; |
|
|
820 | |
|
|
821 | for ("$_[1]") { |
|
|
822 | y/\015//d; # weed out any \015, as they show up in the weirdest of places. |
|
|
823 | |
|
|
824 | /^HTTP\/0*([0-9\.]+) \s+ ([0-9]{3}) (?: \s+ ([^\012]*) )? \012/gxci |
|
|
825 | or return _error %state, $cb, { @pseudo, Status => 599, Reason => "Invalid server response" }; |
|
|
826 | |
|
|
827 | # 100 Continue handling |
|
|
828 | # should not happen as we don't send expect: 100-continue, |
|
|
829 | # but we handle it just in case. |
|
|
830 | # since we send the request body regardless, if we get an error |
|
|
831 | # we are out of-sync, which we currently do NOT handle correctly. |
|
|
832 | return $state{handle}->push_read (line => $qr_nlnl, $state{read_response}) |
|
|
833 | if $2 eq 100; |
|
|
834 | |
|
|
835 | push @pseudo, |
|
|
836 | HTTPVersion => $1, |
|
|
837 | Status => $2, |
|
|
838 | Reason => $3, |
|
|
839 | ; |
|
|
840 | |
|
|
841 | my $hdr = _parse_hdr |
|
|
842 | or return _error %state, $cb, { @pseudo, Status => 599, Reason => "Garbled response headers" }; |
|
|
843 | |
|
|
844 | %hdr = (%$hdr, @pseudo); |
|
|
845 | } |
|
|
846 | |
|
|
847 | # redirect handling |
|
|
848 | # microsoft and other shitheads don't give a shit for following standards, |
|
|
849 | # try to support some common forms of broken Location headers. |
|
|
850 | if ($hdr{location} !~ /^(?: $ | [^:\/?\#]+ : )/x) { |
|
|
851 | $hdr{location} =~ s/^\.\/+//; |
|
|
852 | |
|
|
853 | my $url = "$rscheme://$uhost:$uport"; |
|
|
854 | |
|
|
855 | unless ($hdr{location} =~ s/^\///) { |
|
|
856 | $url .= $upath; |
|
|
857 | $url =~ s/\/[^\/]*$//; |
|
|
858 | } |
|
|
859 | |
|
|
860 | $hdr{location} = "$url/$hdr{location}"; |
|
|
861 | } |
|
|
862 | |
|
|
863 | my $redirect; |
|
|
864 | |
|
|
865 | if ($recurse) { |
|
|
866 | my $status = $hdr{Status}; |
|
|
867 | |
|
|
868 | # industry standard is to redirect POST as GET for |
|
|
869 | # 301, 302 and 303, in contrast to HTTP/1.0 and 1.1. |
|
|
870 | # also, the UA should ask the user for 301 and 307 and POST, |
|
|
871 | # industry standard seems to be to simply follow. |
|
|
872 | # we go with the industry standard. |
|
|
873 | if ($status == 301 or $status == 302 or $status == 303) { |
|
|
874 | # HTTP/1.1 is unclear on how to mutate the method |
|
|
875 | $method = "GET" unless $method eq "HEAD"; |
|
|
876 | $redirect = 1; |
|
|
877 | } elsif ($status == 307) { |
|
|
878 | $redirect = 1; |
|
|
879 | } |
|
|
880 | } |
|
|
881 | |
|
|
882 | my $finish = sub { # ($data, $err_status, $err_reason[, $persistent]) |
|
|
883 | if ($state{handle}) { |
|
|
884 | # handle keepalive |
|
|
885 | if ( |
|
|
886 | $persistent |
|
|
887 | && $_[3] |
|
|
888 | && ($hdr{HTTPVersion} < 1.1 |
|
|
889 | ? $hdr{connection} =~ /\bkeep-?alive\b/i |
|
|
890 | : $hdr{connection} !~ /\bclose\b/i) |
|
|
891 | ) { |
|
|
892 | ka_store $ka_key, delete $state{handle}; |
|
|
893 | } else { |
|
|
894 | # no keepalive, destroy the handle |
|
|
895 | $state{handle}->destroy; |
|
|
896 | } |
|
|
897 | } |
|
|
898 | |
|
|
899 | %state = (); |
|
|
900 | |
|
|
901 | if (defined $_[1]) { |
|
|
902 | $hdr{OrigStatus} = $hdr{Status}; $hdr{Status} = $_[1]; |
|
|
903 | $hdr{OrigReason} = $hdr{Reason}; $hdr{Reason} = $_[2]; |
|
|
904 | } |
|
|
905 | |
|
|
906 | # set-cookie processing |
|
|
907 | if ($arg{cookie_jar}) { |
|
|
908 | cookie_jar_set_cookie $arg{cookie_jar}, $hdr{"set-cookie"}, $uhost, $hdr{date}; |
|
|
909 | } |
|
|
910 | |
|
|
911 | if ($redirect && exists $hdr{location}) { |
|
|
912 | # we ignore any errors, as it is very common to receive |
|
|
913 | # Content-Length != 0 but no actual body |
|
|
914 | # we also access %hdr, as $_[1] might be an erro |
|
|
915 | $state{recurse} = |
|
|
916 | http_request ( |
|
|
917 | $method => $hdr{location}, |
|
|
918 | %arg, |
|
|
919 | recurse => $recurse - 1, |
|
|
920 | Redirect => [$_[0], \%hdr], |
|
|
921 | sub { |
|
|
922 | %state = (); |
|
|
923 | &$cb |
|
|
924 | }, |
|
|
925 | ); |
|
|
926 | } else { |
|
|
927 | $cb->($_[0], \%hdr); |
|
|
928 | } |
|
|
929 | }; |
|
|
930 | |
|
|
931 | $ae_error = 597; # body phase |
|
|
932 | |
|
|
933 | my $chunked = $hdr{"transfer-encoding"} =~ /\bchunked\b/i; # not quite correct... |
|
|
934 | |
|
|
935 | my $len = $chunked ? undef : $hdr{"content-length"}; |
|
|
936 | |
|
|
937 | # body handling, many different code paths |
|
|
938 | # - no body expected |
|
|
939 | # - want_body_handle |
|
|
940 | # - te chunked |
|
|
941 | # - 2x length known (with or without on_body) |
|
|
942 | # - 2x length not known (with or without on_body) |
|
|
943 | if (!$redirect && $arg{on_header} && !$arg{on_header}(\%hdr)) { |
|
|
944 | $finish->(undef, 598 => "Request cancelled by on_header"); |
|
|
945 | } elsif ( |
|
|
946 | $hdr{Status} =~ /^(?:1..|204|205|304)$/ |
|
|
947 | or $method eq "HEAD" |
|
|
948 | or (defined $len && $len == 0) # == 0, not !, because "0 " is true |
|
|
949 | ) { |
|
|
950 | # no body |
|
|
951 | $finish->("", undef, undef, 1); |
|
|
952 | |
|
|
953 | } elsif (!$redirect && $arg{want_body_handle}) { |
|
|
954 | $_[0]->on_eof (undef); |
|
|
955 | $_[0]->on_error (undef); |
|
|
956 | $_[0]->on_read (undef); |
|
|
957 | |
|
|
958 | $finish->(delete $state{handle}); |
|
|
959 | |
|
|
960 | } elsif ($chunked) { |
|
|
961 | my $cl = 0; |
|
|
962 | my $body = ""; |
|
|
963 | my $on_body = $arg{on_body} || sub { $body .= shift; 1 }; |
|
|
964 | |
|
|
965 | $state{read_chunk} = sub { |
|
|
966 | $_[1] =~ /^([0-9a-fA-F]+)/ |
|
|
967 | or return $finish->(undef, $ae_error => "Garbled chunked transfer encoding"); |
|
|
968 | |
|
|
969 | my $len = hex $1; |
|
|
970 | |
|
|
971 | if ($len) { |
|
|
972 | $cl += $len; |
|
|
973 | |
|
|
974 | $_[0]->push_read (chunk => $len, sub { |
|
|
975 | $on_body->($_[1], \%hdr) |
|
|
976 | or return $finish->(undef, 598 => "Request cancelled by on_body"); |
|
|
977 | |
|
|
978 | $_[0]->push_read (line => sub { |
|
|
979 | length $_[1] |
|
|
980 | and return $finish->(undef, $ae_error => "Garbled chunked transfer encoding"); |
|
|
981 | $_[0]->push_read (line => $state{read_chunk}); |
|
|
982 | }); |
|
|
983 | }); |
|
|
984 | } else { |
|
|
985 | $hdr{"content-length"} ||= $cl; |
|
|
986 | |
|
|
987 | $_[0]->push_read (line => $qr_nlnl, sub { |
|
|
988 | if (length $_[1]) { |
|
|
989 | for ("$_[1]") { |
|
|
990 | y/\015//d; # weed out any \015, as they show up in the weirdest of places. |
|
|
991 | |
|
|
992 | my $hdr = _parse_hdr |
|
|
993 | or return $finish->(undef, $ae_error => "Garbled response trailers"); |
|
|
994 | |
|
|
995 | %hdr = (%hdr, %$hdr); |
|
|
996 | } |
|
|
997 | } |
|
|
998 | |
|
|
999 | $finish->($body, undef, undef, 1); |
|
|
1000 | }); |
|
|
1001 | } |
|
|
1002 | }; |
|
|
1003 | |
|
|
1004 | $_[0]->push_read (line => $state{read_chunk}); |
|
|
1005 | |
|
|
1006 | } elsif ($arg{on_body}) { |
|
|
1007 | if (defined $len) { |
|
|
1008 | $_[0]->on_read (sub { |
|
|
1009 | $len -= length $_[0]{rbuf}; |
|
|
1010 | |
|
|
1011 | $arg{on_body}(delete $_[0]{rbuf}, \%hdr) |
|
|
1012 | or return $finish->(undef, 598 => "Request cancelled by on_body"); |
|
|
1013 | |
|
|
1014 | $len > 0 |
|
|
1015 | or $finish->("", undef, undef, 1); |
|
|
1016 | }); |
|
|
1017 | } else { |
|
|
1018 | $_[0]->on_eof (sub { |
|
|
1019 | $finish->(""); |
|
|
1020 | }); |
|
|
1021 | $_[0]->on_read (sub { |
|
|
1022 | $arg{on_body}(delete $_[0]{rbuf}, \%hdr) |
|
|
1023 | or $finish->(undef, 598 => "Request cancelled by on_body"); |
|
|
1024 | }); |
|
|
1025 | } |
|
|
1026 | } else { |
|
|
1027 | $_[0]->on_eof (undef); |
|
|
1028 | |
|
|
1029 | if (defined $len) { |
|
|
1030 | $_[0]->on_read (sub { |
|
|
1031 | $finish->((substr delete $_[0]{rbuf}, 0, $len, ""), undef, undef, 1) |
|
|
1032 | if $len <= length $_[0]{rbuf}; |
|
|
1033 | }); |
|
|
1034 | } else { |
|
|
1035 | $_[0]->on_error (sub { |
|
|
1036 | ($! == Errno::EPIPE || !$!) |
|
|
1037 | ? $finish->(delete $_[0]{rbuf}) |
|
|
1038 | : $finish->(undef, $ae_error => $_[2]); |
|
|
1039 | }); |
|
|
1040 | $_[0]->on_read (sub { }); |
|
|
1041 | } |
|
|
1042 | } |
|
|
1043 | }; |
|
|
1044 | |
|
|
1045 | # if keepalive is enabled, then the server closing the connection |
|
|
1046 | # before a response can happen legally - we retry on idempotent methods. |
|
|
1047 | if ($was_persistent && $idempotent) { |
|
|
1048 | my $old_eof = $hdl->{on_eof}; |
|
|
1049 | $hdl->{on_eof} = sub { |
|
|
1050 | _destroy_state %state; |
|
|
1051 | |
|
|
1052 | %state = (); |
|
|
1053 | $state{recurse} = |
|
|
1054 | http_request ( |
|
|
1055 | $method => $url, |
|
|
1056 | %arg, |
|
|
1057 | recurse => $recurse - 1, |
|
|
1058 | keepalive => 0, |
|
|
1059 | sub { |
|
|
1060 | %state = (); |
|
|
1061 | &$cb |
|
|
1062 | } |
|
|
1063 | ); |
|
|
1064 | }; |
|
|
1065 | $hdl->on_read (sub { |
|
|
1066 | return unless %state; |
|
|
1067 | |
|
|
1068 | # as soon as we receive something, a connection close |
|
|
1069 | # once more becomes a hard error |
|
|
1070 | $hdl->{on_eof} = $old_eof; |
|
|
1071 | $hdl->push_read (line => $qr_nlnl, $state{read_response}); |
|
|
1072 | }); |
|
|
1073 | } else { |
|
|
1074 | $hdl->push_read (line => $qr_nlnl, $state{read_response}); |
|
|
1075 | } |
|
|
1076 | }; |
|
|
1077 | |
|
|
1078 | my $prepare_handle = sub { |
|
|
1079 | my ($hdl) = $state{handle}; |
|
|
1080 | |
|
|
1081 | $hdl->on_error (sub { |
|
|
1082 | _error %state, $cb, { @pseudo, Status => $ae_error, Reason => $_[2] }; |
|
|
1083 | }); |
|
|
1084 | $hdl->on_eof (sub { |
|
|
1085 | _error %state, $cb, { @pseudo, Status => $ae_error, Reason => "Unexpected end-of-file" }; |
|
|
1086 | }); |
|
|
1087 | $hdl->timeout_reset; |
|
|
1088 | $hdl->timeout ($timeout); |
|
|
1089 | }; |
|
|
1090 | |
|
|
1091 | # connected to proxy (or origin server) |
|
|
1092 | my $connect_cb = sub { |
|
|
1093 | my $fh = shift |
|
|
1094 | or return _error %state, $cb, { @pseudo, Status => $ae_error, Reason => "$!" }; |
|
|
1095 | |
|
|
1096 | return unless delete $state{connect_guard}; |
|
|
1097 | |
|
|
1098 | # get handle |
|
|
1099 | $state{handle} = new AnyEvent::Handle |
|
|
1100 | %{ $arg{handle_params} }, |
|
|
1101 | fh => $fh, |
|
|
1102 | peername => $uhost, |
|
|
1103 | tls_ctx => $arg{tls_ctx}, |
|
|
1104 | ; |
|
|
1105 | |
|
|
1106 | $prepare_handle->(); |
|
|
1107 | |
|
|
1108 | #$state{handle}->starttls ("connect") if $rscheme eq "https"; |
|
|
1109 | |
|
|
1110 | # now handle proxy-CONNECT method |
|
|
1111 | if ($proxy && $uscheme eq "https") { |
|
|
1112 | # oh dear, we have to wrap it into a connect request |
|
|
1113 | |
|
|
1114 | # maybe re-use $uauthority with patched port? |
|
|
1115 | $state{handle}->push_write ("CONNECT $uhost:$uport HTTP/1.0\015\012\015\012"); |
|
|
1116 | $state{handle}->push_read (line => $qr_nlnl, sub { |
|
|
1117 | $_[1] =~ /^HTTP\/([0-9\.]+) \s+ ([0-9]{3}) (?: \s+ ([^\015\012]*) )?/ix |
|
|
1118 | or return _error %state, $cb, { @pseudo, Status => 599, Reason => "Invalid proxy connect response ($_[1])" }; |
|
|
1119 | |
|
|
1120 | if ($2 == 200) { |
|
|
1121 | $rpath = $upath; |
|
|
1122 | $handle_actual_request->(); |
|
|
1123 | } else { |
|
|
1124 | _error %state, $cb, { @pseudo, Status => $2, Reason => $3 }; |
|
|
1125 | } |
|
|
1126 | }); |
|
|
1127 | } else { |
|
|
1128 | $handle_actual_request->(); |
|
|
1129 | } |
|
|
1130 | }; |
600 | |
1131 | |
601 | _get_slot $uhost, sub { |
1132 | _get_slot $uhost, sub { |
602 | $state{slot_guard} = shift; |
1133 | $state{slot_guard} = shift; |
603 | |
1134 | |
604 | return unless $state{connect_guard}; |
1135 | return unless $state{connect_guard}; |
605 | |
1136 | |
606 | my $connect_cb = sub { |
1137 | # try to use an existing keepalive connection, but only if we, ourselves, plan |
607 | $state{fh} = shift |
1138 | # on a keepalive request (in theory, this should be a separate config option). |
608 | or do { |
1139 | if ($persistent && $KA_CACHE{$ka_key}) { |
609 | my $err = "$!"; |
1140 | $was_persistent = 1; |
610 | %state = (); |
|
|
611 | return $cb->(undef, { @pseudo, Status => 599, Reason => $err }); |
|
|
612 | }; |
|
|
613 | |
1141 | |
614 | pop; # free memory, save a tree |
1142 | $state{handle} = ka_fetch $ka_key; |
615 | |
|
|
616 | return unless delete $state{connect_guard}; |
|
|
617 | |
|
|
618 | # get handle |
|
|
619 | $state{handle} = new AnyEvent::Handle |
|
|
620 | fh => $state{fh}, |
|
|
621 | peername => $rhost, |
|
|
622 | tls_ctx => $arg{tls_ctx}, |
|
|
623 | # these need to be reconfigured on keepalive handles |
|
|
624 | timeout => $timeout, |
|
|
625 | on_error => sub { |
|
|
626 | %state = (); |
|
|
627 | $cb->(undef, { @pseudo, Status => 599, Reason => $_[2] }); |
|
|
628 | }, |
|
|
629 | on_eof => sub { |
|
|
630 | %state = (); |
|
|
631 | $cb->(undef, { @pseudo, Status => 599, Reason => "Unexpected end-of-file" }); |
|
|
632 | }, |
|
|
633 | ; |
|
|
634 | |
|
|
635 | # limit the number of persistent connections |
|
|
636 | # keepalive not yet supported |
|
|
637 | # if ($KA_COUNT{$_[1]} < $MAX_PERSISTENT_PER_HOST) { |
|
|
638 | # ++$KA_COUNT{$_[1]}; |
|
|
639 | # $state{handle}{ka_count_guard} = AnyEvent::Util::guard { |
|
|
640 | # --$KA_COUNT{$_[1]} |
|
|
641 | # }; |
|
|
642 | # $hdr{connection} = "keep-alive"; |
|
|
643 | # } |
|
|
644 | |
|
|
645 | $state{handle}->starttls ("connect") if $rscheme eq "https"; |
|
|
646 | |
|
|
647 | # handle actual, non-tunneled, request |
|
|
648 | my $handle_actual_request = sub { |
|
|
649 | $state{handle}->starttls ("connect") if $uscheme eq "https" && !exists $state{handle}{tls}; |
|
|
650 | |
|
|
651 | # send request |
|
|
652 | $state{handle}->push_write ( |
1143 | $state{handle}->destroyed |
653 | "$method $rpath HTTP/1.1\015\012" |
1144 | and die "AnyEvent::HTTP: unexpectedly got a destructed handle (1), please report.";#d# |
654 | . (join "", map "\u$_: $hdr{$_}\015\012", grep defined $hdr{$_}, keys %hdr) |
1145 | $prepare_handle->(); |
655 | . "\015\012" |
1146 | $state{handle}->destroyed |
656 | . (delete $arg{body}) |
1147 | and die "AnyEvent::HTTP: unexpectedly got a destructed handle (2), please report.";#d# |
657 | ); |
|
|
658 | |
|
|
659 | # return if error occured during push_write() |
|
|
660 | return unless %state; |
|
|
661 | |
|
|
662 | %hdr = (); # reduce memory usage, save a kitten, also make it possible to re-use |
|
|
663 | |
|
|
664 | # status line and headers |
|
|
665 | $state{read_response} = sub { |
|
|
666 | for ("$_[1]") { |
|
|
667 | y/\015//d; # weed out any \015, as they show up in the weirdest of places. |
|
|
668 | |
|
|
669 | /^HTTP\/([0-9\.]+) \s+ ([0-9]{3}) (?: \s+ ([^\012]*) )? \012/igxc |
|
|
670 | or return (%state = (), $cb->(undef, { @pseudo, Status => 599, Reason => "Invalid server response" })); |
|
|
671 | |
|
|
672 | # 100 Continue handling |
|
|
673 | # should not happen as we don't send expect: 100-continue, |
|
|
674 | # but we handle it just in case. |
|
|
675 | # since we send the request body regardless, if we get an error |
|
|
676 | # we are out of-sync, which we currently do NOT handle correctly. |
|
|
677 | return $state{handle}->push_read (line => $qr_nlnl, $state{read_response}) |
|
|
678 | if $2 eq 100; |
|
|
679 | |
|
|
680 | push @pseudo, |
|
|
681 | HTTPVersion => $1, |
|
|
682 | Status => $2, |
|
|
683 | Reason => $3, |
|
|
684 | ; |
|
|
685 | |
|
|
686 | my $hdr = parse_hdr |
|
|
687 | or return (%state = (), $cb->(undef, { @pseudo, Status => 599, Reason => "Garbled response headers" })); |
|
|
688 | |
|
|
689 | %hdr = (%$hdr, @pseudo); |
|
|
690 | } |
|
|
691 | |
|
|
692 | # redirect handling |
|
|
693 | # microsoft and other shitheads don't give a shit for following standards, |
|
|
694 | # try to support some common forms of broken Location headers. |
|
|
695 | if ($hdr{location} !~ /^(?: $ | [^:\/?\#]+ : )/x) { |
|
|
696 | $hdr{location} =~ s/^\.\/+//; |
|
|
697 | |
|
|
698 | my $url = "$rscheme://$uhost:$uport"; |
|
|
699 | |
|
|
700 | unless ($hdr{location} =~ s/^\///) { |
|
|
701 | $url .= $upath; |
|
|
702 | $url =~ s/\/[^\/]*$//; |
|
|
703 | } |
|
|
704 | |
|
|
705 | $hdr{location} = "$url/$hdr{location}"; |
|
|
706 | } |
|
|
707 | |
|
|
708 | my $redirect; |
|
|
709 | |
|
|
710 | if ($recurse) { |
|
|
711 | my $status = $hdr{Status}; |
|
|
712 | |
|
|
713 | # industry standard is to redirect POST as GET for |
|
|
714 | # 301, 302 and 303, in contrast to http/1.0 and 1.1. |
|
|
715 | # also, the UA should ask the user for 301 and 307 and POST, |
|
|
716 | # industry standard seems to be to simply follow. |
|
|
717 | # we go with the industry standard. |
|
|
718 | if ($status == 301 or $status == 302 or $status == 303) { |
|
|
719 | # HTTP/1.1 is unclear on how to mutate the method |
|
|
720 | $method = "GET" unless $method eq "HEAD"; |
|
|
721 | $redirect = 1; |
|
|
722 | } elsif ($status == 307) { |
|
|
723 | $redirect = 1; |
|
|
724 | } |
|
|
725 | } |
|
|
726 | |
|
|
727 | my $finish = sub { # ($data, $err_status, $err_reason[, $keepalive]) |
|
|
728 | my $keepalive = pop; |
|
|
729 | |
|
|
730 | $state{handle}->destroy if $state{handle}; |
|
|
731 | %state = (); |
|
|
732 | |
|
|
733 | if (defined $_[1]) { |
|
|
734 | $hdr{OrigStatus} = $hdr{Status}; $hdr{Status} = $_[1]; |
|
|
735 | $hdr{OrigReason} = $hdr{Reason}; $hdr{Reason} = $_[2]; |
|
|
736 | } |
|
|
737 | |
|
|
738 | # set-cookie processing |
|
|
739 | if ($arg{cookie_jar}) { |
|
|
740 | cookie_jar_set_cookie $arg{cookie_jar}, $hdr{"set-cookie"}; |
|
|
741 | |
|
|
742 | if ($redirect && exists $hdr{location}) { |
|
|
743 | # we ignore any errors, as it is very common to receive |
|
|
744 | # Content-Length != 0 but no actual body |
|
|
745 | # we also access %hdr, as $_[1] might be an erro |
|
|
746 | http_request ( |
|
|
747 | $method => $hdr{location}, |
|
|
748 | %arg, |
|
|
749 | recurse => $recurse - 1, |
|
|
750 | Redirect => [$_[0], \%hdr], |
|
|
751 | $cb); |
|
|
752 | } else { |
|
|
753 | $cb->($_[0], \%hdr); |
|
|
754 | } |
|
|
755 | }; |
|
|
756 | |
|
|
757 | my $len = $hdr{"content-length"}; |
|
|
758 | |
|
|
759 | if (!$redirect && $arg{on_header} && !$arg{on_header}(\%hdr)) { |
|
|
760 | $finish->(undef, 598 => "Request cancelled by on_header"); |
|
|
761 | } elsif ( |
|
|
762 | $hdr{Status} =~ /^(?:1..|204|205|304)$/ |
|
|
763 | or $method eq "HEAD" |
|
|
764 | or (defined $len && !$len) |
|
|
765 | ) { |
|
|
766 | # no body |
|
|
767 | $finish->("", undef, undef, 1); |
|
|
768 | } else { |
|
|
769 | # body handling, many different code paths |
|
|
770 | # - no body expected |
|
|
771 | # - want_body_handle |
|
|
772 | # - te chunked |
|
|
773 | # - 2x length known (with or without on_body) |
|
|
774 | # - 2x length not known (with or without on_body) |
|
|
775 | if (!$redirect && $arg{want_body_handle}) { |
|
|
776 | $_[0]->on_eof (undef); |
|
|
777 | $_[0]->on_error (undef); |
|
|
778 | $_[0]->on_read (undef); |
|
|
779 | |
|
|
780 | $finish->(delete $state{handle}); |
|
|
781 | |
|
|
782 | } elsif ($hdr{"transfer-encoding"} =~ /\bchunked\b/i) { |
|
|
783 | my $cl = 0; |
|
|
784 | my $body = undef; |
|
|
785 | my $on_body = $arg{on_body} || sub { $body .= shift; 1 }; |
|
|
786 | |
|
|
787 | $_[0]->on_error (sub { $finish->(undef, 599 => $_[2]) }); |
|
|
788 | |
|
|
789 | my $read_chunk; $read_chunk = sub { |
|
|
790 | $_[1] =~ /^([0-9a-fA-F]+)/ |
|
|
791 | or $finish->(undef, 599 => "Garbled chunked transfer encoding"); |
|
|
792 | |
|
|
793 | my $len = hex $1; |
|
|
794 | |
|
|
795 | if ($len) { |
|
|
796 | $cl += $len; |
|
|
797 | |
|
|
798 | $_[0]->push_read (chunk => $len, sub { |
|
|
799 | $on_body->($_[1], \%hdr) |
|
|
800 | or return $finish->(undef, 598 => "Request cancelled by on_body"); |
|
|
801 | |
|
|
802 | $_[0]->push_read (line => sub { |
|
|
803 | length $_[1] |
|
|
804 | and return $finish->(undef, 599 => "Garbled chunked transfer encoding"); |
|
|
805 | $_[0]->push_read (line => $read_chunk); |
|
|
806 | }); |
|
|
807 | }); |
|
|
808 | } else { |
|
|
809 | $hdr{"content-length"} ||= $cl; |
|
|
810 | |
|
|
811 | $_[0]->push_read (line => $qr_nlnl, sub { |
|
|
812 | if (length $_[1]) { |
|
|
813 | for ("$_[1]") { |
|
|
814 | y/\015//d; # weed out any \015, as they show up in the weirdest of places. |
|
|
815 | |
|
|
816 | my $hdr = parse_hdr |
|
|
817 | or return $finish->(undef, 599 => "Garbled response trailers"); |
|
|
818 | |
|
|
819 | %hdr = (%hdr, %$hdr); |
|
|
820 | } |
|
|
821 | } |
|
|
822 | |
|
|
823 | $finish->($body, undef, undef, 1); |
|
|
824 | }); |
|
|
825 | } |
|
|
826 | }; |
|
|
827 | |
|
|
828 | $_[0]->push_read (line => $read_chunk); |
|
|
829 | |
|
|
830 | } elsif ($arg{on_body}) { |
|
|
831 | $_[0]->on_error (sub { $finish->(undef, 599 => $_[2]) }); |
|
|
832 | |
|
|
833 | if ($len) { |
|
|
834 | $_[0]->on_read (sub { |
|
|
835 | $len -= length $_[0]{rbuf}; |
|
|
836 | |
|
|
837 | $arg{on_body}(delete $_[0]{rbuf}, \%hdr) |
|
|
838 | or return $finish->(undef, 598 => "Request cancelled by on_body"); |
|
|
839 | |
|
|
840 | $len > 0 |
|
|
841 | or $finish->("", undef, undef, 1); |
|
|
842 | }); |
|
|
843 | } else { |
|
|
844 | $_[0]->on_eof (sub { |
|
|
845 | $finish->(""); |
|
|
846 | }); |
|
|
847 | $_[0]->on_read (sub { |
|
|
848 | $arg{on_body}(delete $_[0]{rbuf}, \%hdr) |
|
|
849 | or $finish->(undef, 598 => "Request cancelled by on_body"); |
|
|
850 | }); |
|
|
851 | } |
|
|
852 | } else { |
|
|
853 | $_[0]->on_eof (undef); |
|
|
854 | |
|
|
855 | if ($len) { |
|
|
856 | $_[0]->on_error (sub { $finish->(undef, 599 => $_[2]) }); |
|
|
857 | $_[0]->on_read (sub { |
|
|
858 | $finish->((substr delete $_[0]{rbuf}, 0, $len, ""), undef, undef, 1) |
|
|
859 | if $len <= length $_[0]{rbuf}; |
|
|
860 | }); |
|
|
861 | } else { |
|
|
862 | $_[0]->on_error (sub { |
|
|
863 | ($! == Errno::EPIPE || !$!) |
|
|
864 | ? $finish->(delete $_[0]{rbuf}) |
|
|
865 | : $finish->(undef, 599 => $_[2]); |
|
|
866 | }); |
|
|
867 | $_[0]->on_read (sub { }); |
|
|
868 | } |
|
|
869 | } |
|
|
870 | } |
|
|
871 | }; |
|
|
872 | |
|
|
873 | $state{handle}->push_read (line => $qr_nlnl, $state{read_response}); |
|
|
874 | }; |
|
|
875 | |
|
|
876 | # now handle proxy-CONNECT method |
|
|
877 | if ($proxy && $uscheme eq "https") { |
|
|
878 | # oh dear, we have to wrap it into a connect request |
|
|
879 | |
|
|
880 | # maybe re-use $uauthority with patched port? |
|
|
881 | $state{handle}->push_write ("CONNECT $uhost:$uport HTTP/1.0\015\012Host: $uhost\015\012\015\012"); |
|
|
882 | $state{handle}->push_read (line => $qr_nlnl, sub { |
|
|
883 | $_[1] =~ /^HTTP\/([0-9\.]+) \s+ ([0-9]{3}) (?: \s+ ([^\015\012]*) )?/ix |
|
|
884 | or return (%state = (), $cb->(undef, { @pseudo, Status => 599, Reason => "Invalid proxy connect response ($_[1])" })); |
|
|
885 | |
|
|
886 | if ($2 == 200) { |
|
|
887 | $rpath = $upath; |
|
|
888 | &$handle_actual_request; |
1148 | $handle_actual_request->(); |
889 | } else { |
1149 | |
890 | %state = (); |
|
|
891 | $cb->(undef, { @pseudo, Status => $2, Reason => $3 }); |
|
|
892 | } |
|
|
893 | }); |
|
|
894 | } else { |
1150 | } else { |
895 | &$handle_actual_request; |
|
|
896 | } |
|
|
897 | }; |
|
|
898 | |
|
|
899 | my $tcp_connect = $arg{tcp_connect} |
1151 | my $tcp_connect = $arg{tcp_connect} |
900 | || do { require AnyEvent::Socket; \&AnyEvent::Socket::tcp_connect }; |
1152 | || do { require AnyEvent::Socket; \&AnyEvent::Socket::tcp_connect }; |
901 | |
1153 | |
902 | $state{connect_guard} = $tcp_connect->($rhost, $rport, $connect_cb, $arg{on_prepare} || sub { $timeout }); |
1154 | $state{connect_guard} = $tcp_connect->($rhost, $rport, $connect_cb, $arg{on_prepare} || sub { $timeout }); |
903 | |
1155 | } |
904 | }; |
1156 | }; |
905 | |
1157 | |
906 | defined wantarray && AnyEvent::Util::guard { %state = () } |
1158 | defined wantarray && AnyEvent::Util::guard { _destroy_state %state } |
907 | } |
1159 | } |
908 | |
1160 | |
909 | sub http_get($@) { |
1161 | sub http_get($@) { |
910 | unshift @_, "GET"; |
1162 | unshift @_, "GET"; |
911 | &http_request |
1163 | &http_request |
… | |
… | |
929 | AnyEvent::HTTP uses the AnyEvent::Socket::tcp_connect function for |
1181 | AnyEvent::HTTP uses the AnyEvent::Socket::tcp_connect function for |
930 | the actual connection, which in turn uses AnyEvent::DNS to resolve |
1182 | the actual connection, which in turn uses AnyEvent::DNS to resolve |
931 | hostnames. The latter is a simple stub resolver and does no caching |
1183 | hostnames. The latter is a simple stub resolver and does no caching |
932 | on its own. If you want DNS caching, you currently have to provide |
1184 | on its own. If you want DNS caching, you currently have to provide |
933 | your own default resolver (by storing a suitable resolver object in |
1185 | your own default resolver (by storing a suitable resolver object in |
934 | C<$AnyEvent::DNS::RESOLVER>). |
1186 | C<$AnyEvent::DNS::RESOLVER>) or your own C<tcp_connect> callback. |
935 | |
1187 | |
936 | =head2 GLOBAL FUNCTIONS AND VARIABLES |
1188 | =head2 GLOBAL FUNCTIONS AND VARIABLES |
937 | |
1189 | |
938 | =over 4 |
1190 | =over 4 |
939 | |
1191 | |
940 | =item AnyEvent::HTTP::set_proxy "proxy-url" |
1192 | =item AnyEvent::HTTP::set_proxy "proxy-url" |
941 | |
1193 | |
942 | Sets the default proxy server to use. The proxy-url must begin with a |
1194 | Sets the default proxy server to use. The proxy-url must begin with a |
943 | string of the form C<http://host:port> (optionally C<https:...>), croaks |
1195 | string of the form C<http://host:port>, croaks otherwise. |
944 | otherwise. |
|
|
945 | |
1196 | |
946 | To clear an already-set proxy, use C<undef>. |
1197 | To clear an already-set proxy, use C<undef>. |
|
|
1198 | |
|
|
1199 | When AnyEvent::HTTP is loaded for the first time it will query the |
|
|
1200 | default proxy from the operating system, currently by looking at |
|
|
1201 | C<$ENV{http_proxy>}. |
|
|
1202 | |
|
|
1203 | =item AnyEvent::HTTP::cookie_jar_expire $jar[, $session_end] |
|
|
1204 | |
|
|
1205 | Remove all cookies from the cookie jar that have been expired. If |
|
|
1206 | C<$session_end> is given and true, then additionally remove all session |
|
|
1207 | cookies. |
|
|
1208 | |
|
|
1209 | You should call this function (with a true C<$session_end>) before you |
|
|
1210 | save cookies to disk, and you should call this function after loading them |
|
|
1211 | again. If you have a long-running program you can additonally call this |
|
|
1212 | function from time to time. |
|
|
1213 | |
|
|
1214 | A cookie jar is initially an empty hash-reference that is managed by this |
|
|
1215 | module. It's format is subject to change, but currently it is like this: |
|
|
1216 | |
|
|
1217 | The key C<version> has to contain C<1>, otherwise the hash gets |
|
|
1218 | emptied. All other keys are hostnames or IP addresses pointing to |
|
|
1219 | hash-references. The key for these inner hash references is the |
|
|
1220 | server path for which this cookie is meant, and the values are again |
|
|
1221 | hash-references. Each key of those hash-references is a cookie name, and |
|
|
1222 | the value, you guessed it, is another hash-reference, this time with the |
|
|
1223 | key-value pairs from the cookie, except for C<expires> and C<max-age>, |
|
|
1224 | which have been replaced by a C<_expires> key that contains the cookie |
|
|
1225 | expiry timestamp. Session cookies are indicated by not having an |
|
|
1226 | C<_expires> key. |
|
|
1227 | |
|
|
1228 | Here is an example of a cookie jar with a single cookie, so you have a |
|
|
1229 | chance of understanding the above paragraph: |
|
|
1230 | |
|
|
1231 | { |
|
|
1232 | version => 1, |
|
|
1233 | "10.0.0.1" => { |
|
|
1234 | "/" => { |
|
|
1235 | "mythweb_id" => { |
|
|
1236 | _expires => 1293917923, |
|
|
1237 | value => "ooRung9dThee3ooyXooM1Ohm", |
|
|
1238 | }, |
|
|
1239 | }, |
|
|
1240 | }, |
|
|
1241 | } |
947 | |
1242 | |
948 | =item $date = AnyEvent::HTTP::format_date $timestamp |
1243 | =item $date = AnyEvent::HTTP::format_date $timestamp |
949 | |
1244 | |
950 | Takes a POSIX timestamp (seconds since the epoch) and formats it as a HTTP |
1245 | Takes a POSIX timestamp (seconds since the epoch) and formats it as a HTTP |
951 | Date (RFC 2616). |
1246 | Date (RFC 2616). |
952 | |
1247 | |
953 | =item $timestamp = AnyEvent::HTTP::parse_date $date |
1248 | =item $timestamp = AnyEvent::HTTP::parse_date $date |
954 | |
1249 | |
955 | Takes a HTTP Date (RFC 2616) or a Cookie date (netscape cookie spec) and |
1250 | Takes a HTTP Date (RFC 2616) or a Cookie date (netscape cookie spec) or a |
956 | returns the corresponding POSIX timestamp, or C<undef> if the date cannot |
1251 | bunch of minor variations of those, and returns the corresponding POSIX |
957 | be parsed. |
1252 | timestamp, or C<undef> if the date cannot be parsed. |
958 | |
1253 | |
959 | =item $AnyEvent::HTTP::MAX_RECURSE |
1254 | =item $AnyEvent::HTTP::MAX_RECURSE |
960 | |
1255 | |
961 | The default value for the C<recurse> request parameter (default: C<10>). |
1256 | The default value for the C<recurse> request parameter (default: C<10>). |
|
|
1257 | |
|
|
1258 | =item $AnyEvent::HTTP::TIMEOUT |
|
|
1259 | |
|
|
1260 | The default timeout for connection operations (default: C<300>). |
962 | |
1261 | |
963 | =item $AnyEvent::HTTP::USERAGENT |
1262 | =item $AnyEvent::HTTP::USERAGENT |
964 | |
1263 | |
965 | The default value for the C<User-Agent> header (the default is |
1264 | The default value for the C<User-Agent> header (the default is |
966 | C<Mozilla/5.0 (compatible; U; AnyEvent-HTTP/$VERSION; +http://software.schmorp.de/pkg/AnyEvent)>). |
1265 | C<Mozilla/5.0 (compatible; U; AnyEvent-HTTP/$VERSION; +http://software.schmorp.de/pkg/AnyEvent)>). |
967 | |
1266 | |
968 | =item $AnyEvent::HTTP::MAX_PER_HOST |
1267 | =item $AnyEvent::HTTP::MAX_PER_HOST |
969 | |
1268 | |
970 | The maximum number of concurrent connections to the same host (identified |
1269 | The maximum number of concurrent connections to the same host (identified |
971 | by the hostname). If the limit is exceeded, then the additional requests |
1270 | by the hostname). If the limit is exceeded, then the additional requests |
972 | are queued until previous connections are closed. |
1271 | are queued until previous connections are closed. Both persistent and |
|
|
1272 | non-persistent connections are counted in this limit. |
973 | |
1273 | |
974 | The default value for this is C<4>, and it is highly advisable to not |
1274 | The default value for this is C<4>, and it is highly advisable to not |
975 | increase it. |
1275 | increase it much. |
|
|
1276 | |
|
|
1277 | For comparison: the RFC's recommend 4 non-persistent or 2 persistent |
|
|
1278 | connections, older browsers used 2, newers (such as firefox 3) typically |
|
|
1279 | use 6, and Opera uses 8 because like, they have the fastest browser and |
|
|
1280 | give a shit for everybody else on the planet. |
|
|
1281 | |
|
|
1282 | =item $AnyEvent::HTTP::PERSISTENT_TIMEOUT |
|
|
1283 | |
|
|
1284 | The time after which idle persistent conenctions get closed by |
|
|
1285 | AnyEvent::HTTP (default: C<3>). |
976 | |
1286 | |
977 | =item $AnyEvent::HTTP::ACTIVE |
1287 | =item $AnyEvent::HTTP::ACTIVE |
978 | |
1288 | |
979 | The number of active connections. This is not the number of currently |
1289 | The number of active connections. This is not the number of currently |
980 | running requests, but the number of currently open and non-idle TCP |
1290 | running requests, but the number of currently open and non-idle TCP |
981 | connections. This number of can be useful for load-leveling. |
1291 | connections. This number can be useful for load-leveling. |
982 | |
1292 | |
983 | =back |
1293 | =back |
984 | |
1294 | |
985 | =cut |
1295 | =cut |
986 | |
1296 | |
… | |
… | |
1001 | sub parse_date($) { |
1311 | sub parse_date($) { |
1002 | my ($date) = @_; |
1312 | my ($date) = @_; |
1003 | |
1313 | |
1004 | my ($d, $m, $y, $H, $M, $S); |
1314 | my ($d, $m, $y, $H, $M, $S); |
1005 | |
1315 | |
1006 | 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$/) { |
1316 | 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$/) { |
1007 | # RFC 822/1123, required by RFC 2616 (with " ") |
1317 | # RFC 822/1123, required by RFC 2616 (with " ") |
1008 | # cookie dates (with "-") |
1318 | # cookie dates (with "-") |
1009 | |
1319 | |
1010 | ($d, $m, $y, $H, $M, $S) = ($1, $2, $3, $4, $5, $6); |
1320 | ($d, $m, $y, $H, $M, $S) = ($1, $2, $3, $4, $5, $6); |
1011 | |
1321 | |
1012 | } elsif ($date =~ /^[A-Z][a-z]+, ([0-9][0-9])-([A-Z][a-z][a-z])-([0-9][0-9]) ([0-9][0-9]):([0-9][0-9]):([0-9][0-9]) GMT$/) { |
1322 | } 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$/) { |
1013 | # RFC 850 |
1323 | # RFC 850 |
1014 | ($d, $m, $y, $H, $M, $S) = ($1, $2, $3 < 69 ? $3 + 2000 : $3 + 1900, $4, $5, $6); |
1324 | ($d, $m, $y, $H, $M, $S) = ($1, $2, $3 < 69 ? $3 + 2000 : $3 + 1900, $4, $5, $6); |
1015 | |
1325 | |
1016 | } 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])$/) { |
1326 | } 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])$/) { |
1017 | # ISO C's asctime |
1327 | # ISO C's asctime |
1018 | ($d, $m, $y, $H, $M, $S) = ($2, $1, $6, $3, $4, $5); |
1328 | ($d, $m, $y, $H, $M, $S) = ($2, $1, $6, $3, $4, $5); |
1019 | } |
1329 | } |
1020 | # other formats fail in the loop below |
1330 | # other formats fail in the loop below |
1021 | |
1331 | |
1022 | for (0..11) { |
1332 | for (0..11) { |
1023 | if ($m eq $month[$_]) { |
1333 | if ($m eq $month[$_]) { |
1024 | require Time::Local; |
1334 | require Time::Local; |
1025 | return Time::Local::timegm ($S, $M, $H, $d, $_, $y); |
1335 | return eval { Time::Local::timegm ($S, $M, $H, $d, $_, $y) }; |
1026 | } |
1336 | } |
1027 | } |
1337 | } |
1028 | |
1338 | |
1029 | undef |
1339 | undef |
1030 | } |
1340 | } |
1031 | |
1341 | |
1032 | sub set_proxy($) { |
1342 | sub set_proxy($) { |
1033 | if (length $_[0]) { |
1343 | if (length $_[0]) { |
1034 | $_[0] =~ m%^(https?):// ([^:/]+) (?: : (\d*) )?%ix |
1344 | $_[0] =~ m%^(http):// ([^:/]+) (?: : (\d*) )?%ix |
1035 | or Carp::croak "$_[0]: invalid proxy URL"; |
1345 | or Carp::croak "$_[0]: invalid proxy URL"; |
1036 | $PROXY = [$2, $3 || 3128, $1] |
1346 | $PROXY = [$2, $3 || 3128, $1] |
1037 | } else { |
1347 | } else { |
1038 | undef $PROXY; |
1348 | undef $PROXY; |
1039 | } |
1349 | } |
… | |
… | |
1042 | # initialise proxy from environment |
1352 | # initialise proxy from environment |
1043 | eval { |
1353 | eval { |
1044 | set_proxy $ENV{http_proxy}; |
1354 | set_proxy $ENV{http_proxy}; |
1045 | }; |
1355 | }; |
1046 | |
1356 | |
|
|
1357 | =head2 SHOWCASE |
|
|
1358 | |
|
|
1359 | This section contaisn some more elaborate "real-world" examples or code |
|
|
1360 | snippets. |
|
|
1361 | |
|
|
1362 | =head2 HTTP/1.1 FILE DOWNLOAD |
|
|
1363 | |
|
|
1364 | Downloading files with HTTP can be quite tricky, especially when something |
|
|
1365 | goes wrong and you want to resume. |
|
|
1366 | |
|
|
1367 | Here is a function that initiates and resumes a download. It uses the |
|
|
1368 | last modified time to check for file content changes, and works with many |
|
|
1369 | HTTP/1.0 servers as well, and usually falls back to a complete re-download |
|
|
1370 | on older servers. |
|
|
1371 | |
|
|
1372 | It calls the completion callback with either C<undef>, which means a |
|
|
1373 | nonretryable error occured, C<0> when the download was partial and should |
|
|
1374 | be retried, and C<1> if it was successful. |
|
|
1375 | |
|
|
1376 | use AnyEvent::HTTP; |
|
|
1377 | |
|
|
1378 | sub download($$$) { |
|
|
1379 | my ($url, $file, $cb) = @_; |
|
|
1380 | |
|
|
1381 | open my $fh, "+<", $file |
|
|
1382 | or die "$file: $!"; |
|
|
1383 | |
|
|
1384 | my %hdr; |
|
|
1385 | my $ofs = 0; |
|
|
1386 | |
|
|
1387 | warn stat $fh; |
|
|
1388 | warn -s _; |
|
|
1389 | if (stat $fh and -s _) { |
|
|
1390 | $ofs = -s _; |
|
|
1391 | warn "-s is ", $ofs; |
|
|
1392 | $hdr{"if-unmodified-since"} = AnyEvent::HTTP::format_date +(stat _)[9]; |
|
|
1393 | $hdr{"range"} = "bytes=$ofs-"; |
|
|
1394 | } |
|
|
1395 | |
|
|
1396 | http_get $url, |
|
|
1397 | headers => \%hdr, |
|
|
1398 | on_header => sub { |
|
|
1399 | my ($hdr) = @_; |
|
|
1400 | |
|
|
1401 | if ($hdr->{Status} == 200 && $ofs) { |
|
|
1402 | # resume failed |
|
|
1403 | truncate $fh, $ofs = 0; |
|
|
1404 | } |
|
|
1405 | |
|
|
1406 | sysseek $fh, $ofs, 0; |
|
|
1407 | |
|
|
1408 | 1 |
|
|
1409 | }, |
|
|
1410 | on_body => sub { |
|
|
1411 | my ($data, $hdr) = @_; |
|
|
1412 | |
|
|
1413 | if ($hdr->{Status} =~ /^2/) { |
|
|
1414 | length $data == syswrite $fh, $data |
|
|
1415 | or return; # abort on write errors |
|
|
1416 | } |
|
|
1417 | |
|
|
1418 | 1 |
|
|
1419 | }, |
|
|
1420 | sub { |
|
|
1421 | my (undef, $hdr) = @_; |
|
|
1422 | |
|
|
1423 | my $status = $hdr->{Status}; |
|
|
1424 | |
|
|
1425 | if (my $time = AnyEvent::HTTP::parse_date $hdr->{"last-modified"}) { |
|
|
1426 | utime $fh, $time, $time; |
|
|
1427 | } |
|
|
1428 | |
|
|
1429 | if ($status == 200 || $status == 206 || $status == 416) { |
|
|
1430 | # download ok || resume ok || file already fully downloaded |
|
|
1431 | $cb->(1, $hdr); |
|
|
1432 | |
|
|
1433 | } elsif ($status == 412) { |
|
|
1434 | # file has changed while resuming, delete and retry |
|
|
1435 | unlink $file; |
|
|
1436 | $cb->(0, $hdr); |
|
|
1437 | |
|
|
1438 | } elsif ($status == 500 or $status == 503 or $status =~ /^59/) { |
|
|
1439 | # retry later |
|
|
1440 | $cb->(0, $hdr); |
|
|
1441 | |
|
|
1442 | } else { |
|
|
1443 | $cb->(undef, $hdr); |
|
|
1444 | } |
|
|
1445 | } |
|
|
1446 | ; |
|
|
1447 | } |
|
|
1448 | |
|
|
1449 | download "http://server/somelargefile", "/tmp/somelargefile", sub { |
|
|
1450 | if ($_[0]) { |
|
|
1451 | print "OK!\n"; |
|
|
1452 | } elsif (defined $_[0]) { |
|
|
1453 | print "please retry later\n"; |
|
|
1454 | } else { |
|
|
1455 | print "ERROR\n"; |
|
|
1456 | } |
|
|
1457 | }; |
|
|
1458 | |
1047 | =head2 SOCKS PROXIES |
1459 | =head3 SOCKS PROXIES |
1048 | |
1460 | |
1049 | Socks proxies are not directly supported by AnyEvent::HTTP. You can |
1461 | Socks proxies are not directly supported by AnyEvent::HTTP. You can |
1050 | compile your perl to support socks, or use an external program such as |
1462 | compile your perl to support socks, or use an external program such as |
1051 | F<socksify> (dante) or F<tsocks> to make your program use a socks proxy |
1463 | F<socksify> (dante) or F<tsocks> to make your program use a socks proxy |
1052 | transparently. |
1464 | transparently. |