… | |
… | |
3 | AnyEvent::HTTP - simple but non-blocking HTTP/HTTPS client |
3 | AnyEvent::HTTP - simple but non-blocking HTTP/HTTPS client |
4 | |
4 | |
5 | =head1 SYNOPSIS |
5 | =head1 SYNOPSIS |
6 | |
6 | |
7 | use AnyEvent::HTTP; |
7 | use AnyEvent::HTTP; |
|
|
8 | |
|
|
9 | http_get "http://www.nethype.de/", sub { print $_[1] }; |
|
|
10 | |
|
|
11 | # ... do something else here |
8 | |
12 | |
9 | =head1 DESCRIPTION |
13 | =head1 DESCRIPTION |
10 | |
14 | |
11 | 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 |
12 | run a supported event loop. |
16 | run a supported event loop. |
… | |
… | |
35 | package AnyEvent::HTTP; |
39 | package AnyEvent::HTTP; |
36 | |
40 | |
37 | use strict; |
41 | use strict; |
38 | no warnings; |
42 | no warnings; |
39 | |
43 | |
40 | use Carp; |
44 | use Errno (); |
41 | |
45 | |
42 | use AnyEvent (); |
46 | use AnyEvent 4.452 (); |
43 | use AnyEvent::Util (); |
47 | use AnyEvent::Util (); |
44 | use AnyEvent::Socket (); |
48 | use AnyEvent::Socket (); |
45 | use AnyEvent::Handle (); |
49 | use AnyEvent::Handle (); |
46 | |
50 | |
47 | use base Exporter::; |
51 | use base Exporter::; |
48 | |
52 | |
49 | our $VERSION = '1.0'; |
53 | our $VERSION = '1.12'; |
50 | |
54 | |
51 | our @EXPORT = qw(http_get http_request); |
55 | our @EXPORT = qw(http_get http_post http_head http_request); |
52 | |
56 | |
53 | our $USERAGENT = "Mozilla/5.0 (compatible; AnyEvent::HTTP/$VERSION; +http://software.schmorp.de/pkg/AnyEvent)"; |
57 | our $USERAGENT = "Mozilla/5.0 (compatible; U; AnyEvent-HTTP/$VERSION; +http://software.schmorp.de/pkg/AnyEvent)"; |
54 | our $MAX_RECURSE = 10; |
58 | our $MAX_RECURSE = 10; |
55 | our $MAX_PERSISTENT = 8; |
59 | our $MAX_PERSISTENT = 8; |
56 | our $PERSISTENT_TIMEOUT = 2; |
60 | our $PERSISTENT_TIMEOUT = 2; |
57 | our $TIMEOUT = 300; |
61 | our $TIMEOUT = 300; |
58 | |
62 | |
59 | # changing these is evil |
63 | # changing these is evil |
60 | our $MAX_PERSISTENT_PER_HOST = 2; |
64 | our $MAX_PERSISTENT_PER_HOST = 0; |
61 | our $MAX_PER_HOST = 4; |
65 | our $MAX_PER_HOST = 4; |
62 | |
66 | |
63 | our $PROXY; |
67 | our $PROXY; |
|
|
68 | our $ACTIVE = 0; |
64 | |
69 | |
65 | my %KA_COUNT; # number of open keep-alive connections per host |
70 | my %KA_COUNT; # number of open keep-alive connections per host |
66 | my %CO_SLOT; # number of open connections, and wait queue, per host |
71 | my %CO_SLOT; # number of open connections, and wait queue, per host |
67 | |
72 | |
68 | =item http_get $url, key => value..., $cb->($data, $headers) |
73 | =item http_get $url, key => value..., $cb->($data, $headers) |
69 | |
74 | |
70 | Executes an HTTP-GET request. See the http_request function for details on |
75 | Executes an HTTP-GET request. See the http_request function for details on |
71 | additional parameters. |
76 | additional parameters and the return value. |
72 | |
77 | |
73 | =item http_head $url, key => value..., $cb->($data, $headers) |
78 | =item http_head $url, key => value..., $cb->($data, $headers) |
74 | |
79 | |
75 | Executes an HTTP-HEAD request. See the http_request function for details on |
80 | Executes an HTTP-HEAD request. See the http_request function for details |
76 | additional parameters. |
81 | on additional parameters and the return value. |
77 | |
82 | |
78 | =item http_post $url, $body, key => value..., $cb->($data, $headers) |
83 | =item http_post $url, $body, key => value..., $cb->($data, $headers) |
79 | |
84 | |
80 | Executes an HTTP-POST request with a request body of C<$bod>. See the |
85 | Executes an HTTP-POST request with a request body of C<$body>. See the |
81 | http_request function for details on additional parameters. |
86 | http_request function for details on additional parameters and the return |
|
|
87 | value. |
82 | |
88 | |
83 | =item http_request $method => $url, key => value..., $cb->($data, $headers) |
89 | =item http_request $method => $url, key => value..., $cb->($data, $headers) |
84 | |
90 | |
85 | Executes a HTTP request of type C<$method> (e.g. C<GET>, C<POST>). The URL |
91 | Executes a HTTP request of type C<$method> (e.g. C<GET>, C<POST>). The URL |
86 | must be an absolute http or https URL. |
92 | must be an absolute http or https URL. |
87 | |
93 | |
|
|
94 | When called in void context, nothing is returned. In other contexts, |
|
|
95 | C<http_request> returns a "cancellation guard" - you have to keep the |
|
|
96 | object at least alive until the callback get called. If the object gets |
|
|
97 | destroyed before the callbakc is called, the request will be cancelled. |
|
|
98 | |
88 | The callback will be called with the response data as first argument |
99 | The callback will be called with the response body data as first argument |
89 | (or C<undef> if it wasn't available due to errors), and a hash-ref with |
100 | (or C<undef> if an error occured), and a hash-ref with response headers as |
90 | response headers as second argument. |
101 | second argument. |
91 | |
102 | |
92 | All the headers in that hash are lowercased. In addition to the response |
103 | All the headers in that hash are lowercased. In addition to the response |
93 | headers, the three "pseudo-headers" C<HTTPVersion>, C<Status> and |
104 | headers, the "pseudo-headers" C<HTTPVersion>, C<Status> and C<Reason> |
94 | C<Reason> contain the three parts of the HTTP Status-Line of the same |
105 | contain the three parts of the HTTP Status-Line of the same name. The |
|
|
106 | pseudo-header C<URL> contains the original URL (which can differ from the |
|
|
107 | requested URL when following redirects). |
|
|
108 | |
95 | name. If the server sends a header multiple lines, then their contents |
109 | If the server sends a header multiple times, then their contents will be |
96 | will be joined together with C<\x00>. |
110 | joined together with a comma (C<,>), as per the HTTP spec. |
97 | |
111 | |
98 | If an internal error occurs, such as not being able to resolve a hostname, |
112 | If an internal error occurs, such as not being able to resolve a hostname, |
99 | then C<$data> will be C<undef>, C<< $headers->{Status} >> will be C<599> |
113 | then C<$data> will be C<undef>, C<< $headers->{Status} >> will be C<59x> |
100 | and the C<Reason> pseudo-header will contain an error message. |
114 | (usually C<599>) and the C<Reason> pseudo-header will contain an error |
|
|
115 | message. |
101 | |
116 | |
102 | A typical callback might look like this: |
117 | A typical callback might look like this: |
103 | |
118 | |
104 | sub { |
119 | sub { |
105 | my ($body, $hdr) = @_; |
120 | my ($body, $hdr) = @_; |
… | |
… | |
151 | based on the original netscape specification. |
166 | based on the original netscape specification. |
152 | |
167 | |
153 | The C<$hash_ref> must be an (initially empty) hash reference which will |
168 | The C<$hash_ref> must be an (initially empty) hash reference which will |
154 | get updated automatically. It is possible to save the cookie_jar to |
169 | get updated automatically. It is possible to save the cookie_jar to |
155 | persistent storage with something like JSON or Storable, but this is not |
170 | persistent storage with something like JSON or Storable, but this is not |
156 | recommended, as expire times are currently being ignored. |
171 | recommended, as expiry times are currently being ignored. |
157 | |
172 | |
158 | Note that this cookie implementation is not of very high quality, nor |
173 | Note that this cookie implementation is not of very high quality, nor |
159 | meant to be complete. If you want complete cookie management you have to |
174 | meant to be complete. If you want complete cookie management you have to |
160 | do that on your own. C<cookie_jar> is meant as a quick fix to get some |
175 | do that on your own. C<cookie_jar> is meant as a quick fix to get some |
161 | cookie-using sites working. Cookies are a privacy disaster, do not use |
176 | cookie-using sites working. Cookies are a privacy disaster, do not use |
162 | them unless required to. |
177 | them unless required to. |
|
|
178 | |
|
|
179 | =item tls_ctx => $scheme | $tls_ctx |
|
|
180 | |
|
|
181 | Specifies the AnyEvent::TLS context to be used for https connections. This |
|
|
182 | parameter follows the same rules as the C<tls_ctx> parameter to |
|
|
183 | L<AnyEvent::Handle>, but additionally, the two strings C<low> or |
|
|
184 | C<high> can be specified, which give you a predefined low-security (no |
|
|
185 | verification, highest compatibility) and high-security (CA and common-name |
|
|
186 | verification) TLS context. |
|
|
187 | |
|
|
188 | The default for this option is C<low>, which could be interpreted as "give |
|
|
189 | me the page, no matter what". |
|
|
190 | |
|
|
191 | =item on_header => $callback->($headers) |
|
|
192 | |
|
|
193 | When specified, this callback will be called with the header hash as soon |
|
|
194 | as headers have been successfully received from the remote server (not on |
|
|
195 | locally-generated errors). |
|
|
196 | |
|
|
197 | It has to return either true (in which case AnyEvent::HTTP will continue), |
|
|
198 | or false, in which case AnyEvent::HTTP will cancel the download (and call |
|
|
199 | the finish callback with an error code of C<598>). |
|
|
200 | |
|
|
201 | This callback is useful, among other things, to quickly reject unwanted |
|
|
202 | content, which, if it is supposed to be rare, can be faster than first |
|
|
203 | doing a C<HEAD> request. |
|
|
204 | |
|
|
205 | Example: cancel the request unless the content-type is "text/html". |
|
|
206 | |
|
|
207 | on_header => sub { |
|
|
208 | $_[0]{"content-type"} =~ /^text\/html\s*(?:;|$)/ |
|
|
209 | }, |
|
|
210 | |
|
|
211 | =item on_body => $callback->($partial_body, $headers) |
|
|
212 | |
|
|
213 | When specified, all body data will be passed to this callback instead of |
|
|
214 | to the completion callback. The completion callback will get the empty |
|
|
215 | string instead of the body data. |
|
|
216 | |
|
|
217 | It has to return either true (in which case AnyEvent::HTTP will continue), |
|
|
218 | or false, in which case AnyEvent::HTTP will cancel the download (and call |
|
|
219 | the completion callback with an error code of C<598>). |
|
|
220 | |
|
|
221 | This callback is useful when the data is too large to be held in memory |
|
|
222 | (so the callback writes it to a file) or when only some information should |
|
|
223 | be extracted, or when the body should be processed incrementally. |
|
|
224 | |
|
|
225 | It is usually preferred over doing your own body handling via |
|
|
226 | C<want_body_handle>. |
|
|
227 | |
|
|
228 | =item want_body_handle => $enable |
|
|
229 | |
|
|
230 | When enabled (default is disabled), the behaviour of AnyEvent::HTTP |
|
|
231 | changes considerably: after parsing the headers, and instead of |
|
|
232 | downloading the body (if any), the completion callback will be |
|
|
233 | called. Instead of the C<$body> argument containing the body data, the |
|
|
234 | callback will receive the L<AnyEvent::Handle> object associated with the |
|
|
235 | connection. In error cases, C<undef> will be passed. When there is no body |
|
|
236 | (e.g. status C<304>), the empty string will be passed. |
|
|
237 | |
|
|
238 | The handle object might or might not be in TLS mode, might be connected to |
|
|
239 | a proxy, be a persistent connection etc., and configured in unspecified |
|
|
240 | ways. The user is responsible for this handle (it will not be used by this |
|
|
241 | module anymore). |
|
|
242 | |
|
|
243 | This is useful with some push-type services, where, after the initial |
|
|
244 | headers, an interactive protocol is used (typical example would be the |
|
|
245 | push-style twitter API which starts a JSON/XML stream). |
|
|
246 | |
|
|
247 | If you think you need this, first have a look at C<on_body>, to see if |
|
|
248 | that doesn'T solve your problem in a better way. |
163 | |
249 | |
164 | =back |
250 | =back |
165 | |
251 | |
166 | Example: make a simple HTTP GET request for http://www.nethype.de/ |
252 | Example: make a simple HTTP GET request for http://www.nethype.de/ |
167 | |
253 | |
… | |
… | |
181 | use Data::Dumper; |
267 | use Data::Dumper; |
182 | print Dumper $hdr; |
268 | print Dumper $hdr; |
183 | } |
269 | } |
184 | ; |
270 | ; |
185 | |
271 | |
|
|
272 | Example: make another simple HTTP GET request, but immediately try to |
|
|
273 | cancel it. |
|
|
274 | |
|
|
275 | my $request = http_request GET => "http://www.nethype.de/", sub { |
|
|
276 | my ($body, $hdr) = @_; |
|
|
277 | print "$body\n"; |
|
|
278 | }; |
|
|
279 | |
|
|
280 | undef $request; |
|
|
281 | |
186 | =cut |
282 | =cut |
187 | |
283 | |
188 | sub _slot_schedule; |
284 | sub _slot_schedule; |
189 | sub _slot_schedule($) { |
285 | sub _slot_schedule($) { |
190 | my $host = shift; |
286 | my $host = shift; |
191 | |
287 | |
192 | while ($CO_SLOT{$host}[0] < $MAX_PER_HOST) { |
288 | while ($CO_SLOT{$host}[0] < $MAX_PER_HOST) { |
193 | if (my $cb = shift @{ $CO_SLOT{$host}[1] }) { |
289 | if (my $cb = shift @{ $CO_SLOT{$host}[1] }) { |
194 | # somebody wants that slot |
290 | # somebody wants that slot |
195 | ++$CO_SLOT{$host}[0]; |
291 | ++$CO_SLOT{$host}[0]; |
|
|
292 | ++$ACTIVE; |
196 | |
293 | |
197 | $cb->(AnyEvent::Util::guard { |
294 | $cb->(AnyEvent::Util::guard { |
|
|
295 | --$ACTIVE; |
198 | --$CO_SLOT{$host}[0]; |
296 | --$CO_SLOT{$host}[0]; |
199 | _slot_schedule $host; |
297 | _slot_schedule $host; |
200 | }); |
298 | }); |
201 | } else { |
299 | } else { |
202 | # nobody wants the slot, maybe we can forget about it |
300 | # nobody wants the slot, maybe we can forget about it |
… | |
… | |
211 | push @{ $CO_SLOT{$_[0]}[1] }, $_[1]; |
309 | push @{ $CO_SLOT{$_[0]}[1] }, $_[1]; |
212 | |
310 | |
213 | _slot_schedule $_[0]; |
311 | _slot_schedule $_[0]; |
214 | } |
312 | } |
215 | |
313 | |
|
|
314 | our $qr_nl = qr<\015?\012>; |
|
|
315 | our $qr_nlnl = qr<\015?\012\015?\012>; |
|
|
316 | |
|
|
317 | our $TLS_CTX_LOW = { cache => 1, sslv2 => 1 }; |
|
|
318 | our $TLS_CTX_HIGH = { cache => 1, verify => 1, verify_peername => "https" }; |
|
|
319 | |
216 | sub http_request($$$;@) { |
320 | sub http_request($$@) { |
217 | my $cb = pop; |
321 | my $cb = pop; |
218 | my ($method, $url, %arg) = @_; |
322 | my ($method, $url, %arg) = @_; |
219 | |
323 | |
220 | my %hdr; |
324 | my %hdr; |
|
|
325 | |
|
|
326 | $arg{tls_ctx} = $TLS_CTX_LOW if $arg{tls_ctx} eq "low" || !exists $arg{tls_ctx}; |
|
|
327 | $arg{tls_ctx} = $TLS_CTX_HIGH if $arg{tls_ctx} eq "high"; |
221 | |
328 | |
222 | $method = uc $method; |
329 | $method = uc $method; |
223 | |
330 | |
224 | if (my $hdr = $arg{headers}) { |
331 | if (my $hdr = $arg{headers}) { |
225 | while (my ($k, $v) = each %$hdr) { |
332 | while (my ($k, $v) = each %$hdr) { |
226 | $hdr{lc $k} = $v; |
333 | $hdr{lc $k} = $v; |
227 | } |
334 | } |
228 | } |
335 | } |
229 | |
336 | |
230 | my $recurse = exists $arg{recurse} ? $arg{recurse} : $MAX_RECURSE; |
337 | my $recurse = exists $arg{recurse} ? delete $arg{recurse} : $MAX_RECURSE; |
231 | |
338 | |
232 | return $cb->(undef, { Status => 599, Reason => "recursion limit reached" }) |
339 | return $cb->(undef, { Status => 599, Reason => "Too many redirections", URL => $url }) |
233 | if $recurse < 0; |
340 | if $recurse < 0; |
234 | |
341 | |
235 | my $proxy = $arg{proxy} || $PROXY; |
342 | my $proxy = $arg{proxy} || $PROXY; |
236 | my $timeout = $arg{timeout} || $TIMEOUT; |
343 | my $timeout = $arg{timeout} || $TIMEOUT; |
237 | |
344 | |
238 | $hdr{"user-agent"} ||= $USERAGENT; |
|
|
239 | |
|
|
240 | my ($scheme, $authority, $upath, $query, $fragment) = |
345 | my ($uscheme, $uauthority, $upath, $query, $fragment) = |
241 | $url =~ m|(?:([^:/?#]+):)?(?://([^/?#]*))?([^?#]*)(?:\?([^#]*))?(?:#(.*))?|; |
346 | $url =~ m|(?:([^:/?#]+):)?(?://([^/?#]*))?([^?#]*)(?:\?([^#]*))?(?:#(.*))?|; |
242 | |
347 | |
243 | $scheme = lc $scheme; |
348 | $uscheme = lc $uscheme; |
244 | |
349 | |
245 | my $uport = $scheme eq "http" ? 80 |
350 | my $uport = $uscheme eq "http" ? 80 |
246 | : $scheme eq "https" ? 443 |
351 | : $uscheme eq "https" ? 443 |
247 | : return $cb->(undef, { Status => 599, Reason => "only http and https URL schemes supported" }); |
352 | : return $cb->(undef, { Status => 599, Reason => "Only http and https URL schemes supported", URL => $url }); |
248 | |
353 | |
249 | $authority =~ /^(?: .*\@ )? ([^\@:]+) (?: : (\d+) )?$/x |
354 | $uauthority =~ /^(?: .*\@ )? ([^\@:]+) (?: : (\d+) )?$/x |
250 | or return $cb->(undef, { Status => 599, Reason => "unparsable URL" }); |
355 | or return $cb->(undef, { Status => 599, Reason => "Unparsable URL", URL => $url }); |
251 | |
356 | |
252 | my $uhost = $1; |
357 | my $uhost = $1; |
253 | $uport = $2 if defined $2; |
358 | $uport = $2 if defined $2; |
254 | |
359 | |
|
|
360 | $hdr{host} = defined $2 ? "$uhost:$2" : "$uhost"; |
|
|
361 | |
255 | $uhost =~ s/^\[(.*)\]$/$1/; |
362 | $uhost =~ s/^\[(.*)\]$/$1/; |
256 | $upath .= "?$query" if length $query; |
363 | $upath .= "?$query" if length $query; |
257 | |
364 | |
258 | $upath =~ s%^/?%/%; |
365 | $upath =~ s%^/?%/%; |
259 | |
366 | |
260 | $hdr{referer} ||= "$scheme://$authority$upath"; |
|
|
261 | |
|
|
262 | # cookie processing |
367 | # cookie processing |
263 | if (my $jar = $arg{cookie_jar}) { |
368 | if (my $jar = $arg{cookie_jar}) { |
264 | %$jar = () if $jar->{version} < 1; |
369 | %$jar = () if $jar->{version} != 1; |
265 | |
370 | |
266 | my @cookie; |
371 | my @cookie; |
267 | |
372 | |
268 | while (my ($chost, $v) = each %$jar) { |
373 | while (my ($chost, $v) = each %$jar) { |
|
|
374 | if ($chost =~ /^\./) { |
269 | next unless $chost eq substr $uhost, -length $chost; |
375 | next unless $chost eq substr $uhost, -length $chost; |
270 | next unless $chost =~ /^\./; |
376 | } elsif ($chost =~ /\./) { |
|
|
377 | next unless $chost eq $uhost; |
|
|
378 | } else { |
|
|
379 | next; |
|
|
380 | } |
271 | |
381 | |
272 | while (my ($cpath, $v) = each %$v) { |
382 | while (my ($cpath, $v) = each %$v) { |
273 | next unless $cpath eq substr $upath, 0, length $cpath; |
383 | next unless $cpath eq substr $upath, 0, length $cpath; |
274 | |
384 | |
275 | while (my ($k, $v) = each %$v) { |
385 | while (my ($k, $v) = each %$v) { |
276 | next if $scheme ne "https" && exists $v->{secure}; |
386 | next if $uscheme ne "https" && exists $v->{secure}; |
|
|
387 | my $value = $v->{value}; |
|
|
388 | $value =~ s/([\\"])/\\$1/g; |
277 | push @cookie, "$k=$v->{value}"; |
389 | push @cookie, "$k=\"$value\""; |
278 | } |
390 | } |
279 | } |
391 | } |
280 | } |
392 | } |
281 | |
393 | |
282 | $hdr{cookie} = join "; ", @cookie |
394 | $hdr{cookie} = join "; ", @cookie |
283 | if @cookie; |
395 | if @cookie; |
284 | } |
396 | } |
285 | |
397 | |
286 | my ($rhost, $rport, $rpath); # request host, port, path |
398 | my ($rhost, $rport, $rscheme, $rpath); # request host, port, path |
287 | |
399 | |
288 | if ($proxy) { |
400 | if ($proxy) { |
289 | ($rhost, $rport, $scheme) = @$proxy; |
401 | ($rpath, $rhost, $rport, $rscheme) = ($url, @$proxy); |
290 | $rpath = $url; |
402 | |
|
|
403 | # don't support https requests over https-proxy transport, |
|
|
404 | # can't be done with tls as spec'ed, unless you double-encrypt. |
|
|
405 | $rscheme = "http" if $uscheme eq "https" && $rscheme eq "https"; |
291 | } else { |
406 | } else { |
292 | ($rhost, $rport, $rpath) = ($uhost, $uport, $upath); |
407 | ($rhost, $rport, $rscheme, $rpath) = ($uhost, $uport, $uscheme, $upath); |
293 | $hdr{host} = $uhost; |
|
|
294 | } |
408 | } |
|
|
409 | |
|
|
410 | $hdr{"user-agent"} ||= $USERAGENT; |
|
|
411 | $hdr{referer} ||= "$uscheme://$uauthority$upath"; # leave out fragment and query string, just a heuristic |
295 | |
412 | |
296 | $hdr{"content-length"} = length $arg{body}; |
413 | $hdr{"content-length"} = length $arg{body}; |
297 | |
414 | |
298 | my %state = (connect_guard => 1); |
415 | my %state = (connect_guard => 1); |
299 | |
416 | |
… | |
… | |
302 | |
419 | |
303 | return unless $state{connect_guard}; |
420 | return unless $state{connect_guard}; |
304 | |
421 | |
305 | $state{connect_guard} = AnyEvent::Socket::tcp_connect $rhost, $rport, sub { |
422 | $state{connect_guard} = AnyEvent::Socket::tcp_connect $rhost, $rport, sub { |
306 | $state{fh} = shift |
423 | $state{fh} = shift |
307 | or return $cb->(undef, { Status => 599, Reason => "$!" }); |
424 | or return (%state = (), $cb->(undef, { Status => 599, Reason => "$!", URL => $url })); |
|
|
425 | pop; # free memory, save a tree |
308 | |
426 | |
309 | delete $state{connect_guard}; # reduce memory usage, save a tree |
427 | return unless delete $state{connect_guard}; |
310 | |
428 | |
311 | # get handle |
429 | # get handle |
312 | $state{handle} = new AnyEvent::Handle |
430 | $state{handle} = new AnyEvent::Handle |
313 | fh => $state{fh}, |
431 | fh => $state{fh}, |
314 | ($scheme eq "https" ? (tls => "connect") : ()); |
432 | timeout => $timeout, |
|
|
433 | peername => $rhost, |
|
|
434 | tls_ctx => $arg{tls_ctx}; |
315 | |
435 | |
316 | # limit the number of persistent connections |
436 | # limit the number of persistent connections |
|
|
437 | # keepalive not yet supported |
317 | if ($KA_COUNT{$_[1]} < $MAX_PERSISTENT_PER_HOST) { |
438 | if ($KA_COUNT{$_[1]} < $MAX_PERSISTENT_PER_HOST) { |
318 | ++$KA_COUNT{$_[1]}; |
439 | ++$KA_COUNT{$_[1]}; |
319 | $state{handle}{ka_count_guard} = AnyEvent::Util::guard { --$KA_COUNT{$_[1]} }; |
440 | $state{handle}{ka_count_guard} = AnyEvent::Util::guard { |
|
|
441 | --$KA_COUNT{$_[1]} |
|
|
442 | }; |
320 | $hdr{connection} = "keep-alive"; |
443 | $hdr{connection} = "keep-alive"; |
321 | delete $hdr{connection}; # keep-alive not yet supported |
|
|
322 | } else { |
444 | } else { |
323 | delete $hdr{connection}; |
445 | delete $hdr{connection}; |
324 | } |
446 | } |
325 | |
447 | |
326 | # (re-)configure handle |
448 | # (re-)configure handle |
327 | $state{handle}->timeout ($timeout); |
|
|
328 | $state{handle}->on_error (sub { |
449 | $state{handle}->on_error (sub { |
329 | %state = (); |
450 | %state = (); |
330 | $cb->(undef, { Status => 599, Reason => "$!" }); |
451 | $cb->(undef, { Status => 599, Reason => $_[2], URL => $url }); |
331 | }); |
452 | }); |
332 | $state{handle}->on_eof (sub { |
453 | $state{handle}->on_eof (sub { |
333 | %state = (); |
454 | %state = (); |
334 | $cb->(undef, { Status => 599, Reason => "unexpected end-of-file" }); |
455 | $cb->(undef, { Status => 599, Reason => "Unexpected end-of-file", URL => $url }); |
335 | }); |
456 | }); |
336 | |
457 | |
|
|
458 | $state{handle}->starttls ("connect") if $rscheme eq "https"; |
|
|
459 | |
|
|
460 | # handle actual, non-tunneled, request |
|
|
461 | my $handle_actual_request = sub { |
|
|
462 | $state{handle}->starttls ("connect") if $uscheme eq "https" && !exists $state{handle}{tls}; |
|
|
463 | |
337 | # send request |
464 | # send request |
338 | $state{handle}->push_write ( |
465 | $state{handle}->push_write ( |
339 | "$method $rpath HTTP/1.0\015\012" |
466 | "$method $rpath HTTP/1.0\015\012" |
340 | . (join "", map "$_: $hdr{$_}\015\012", keys %hdr) |
467 | . (join "", map "\u$_: $hdr{$_}\015\012", keys %hdr) |
341 | . "\015\012" |
468 | . "\015\012" |
342 | . (delete $arg{body}) |
469 | . (delete $arg{body}) |
343 | ); |
|
|
344 | |
|
|
345 | %hdr = (); # reduce memory usage, save a kitten |
|
|
346 | |
|
|
347 | # status line |
|
|
348 | $state{handle}->push_read (line => qr/\015?\012/, sub { |
|
|
349 | $_[1] =~ /^HTTP\/([0-9\.]+) \s+ ([0-9]{3}) \s+ ([^\015\012]+)/ix |
|
|
350 | or return (%state = (), $cb->(undef, { Status => 599, Reason => "invalid server response ($_[1])" })); |
|
|
351 | |
|
|
352 | my %hdr = ( # response headers |
|
|
353 | HTTPVersion => "\x00$1", |
|
|
354 | Status => "\x00$2", |
|
|
355 | Reason => "\x00$3", |
|
|
356 | ); |
470 | ); |
357 | |
471 | |
|
|
472 | %hdr = (); # reduce memory usage, save a kitten |
|
|
473 | |
|
|
474 | # status line |
|
|
475 | $state{handle}->push_read (line => $qr_nl, sub { |
|
|
476 | $_[1] =~ /^HTTP\/([0-9\.]+) \s+ ([0-9]{3}) (?: \s+ ([^\015\012]*) )?/ix |
|
|
477 | or return (%state = (), $cb->(undef, { Status => 599, Reason => "Invalid server response ($_[1])", URL => $url })); |
|
|
478 | |
|
|
479 | my %hdr = ( # response headers |
|
|
480 | HTTPVersion => ",$1", |
|
|
481 | Status => ",$2", |
|
|
482 | Reason => ",$3", |
|
|
483 | URL => ",$url" |
|
|
484 | ); |
|
|
485 | |
358 | # headers, could be optimized a bit |
486 | # headers, could be optimized a bit |
359 | $state{handle}->unshift_read (line => qr/\015?\012\015?\012/, sub { |
487 | $state{handle}->unshift_read (line => $qr_nlnl, sub { |
360 | for ("$_[1]\012") { |
488 | for ("$_[1]\012") { |
361 | # we support spaces in field names, as lotus domino |
489 | y/\015//d; # weed out any \015, as they show up in the weirdest of places. |
362 | # creates them. |
490 | |
|
|
491 | # things seen, not parsed: |
|
|
492 | # p3pP="NON CUR OTPi OUR NOR UNI" |
|
|
493 | |
363 | $hdr{lc $1} .= "\x00$2" |
494 | $hdr{lc $1} .= ",$2" |
364 | while /\G |
495 | while /\G |
365 | ([^:\000-\037]+): |
496 | ([^:\000-\037]*): |
366 | [\011\040]* |
497 | [\011\040]* |
367 | ((?: [^\015\012]+ | \015?\012[\011\040] )*) |
498 | ((?: [^\012]+ | \012[\011\040] )*) |
368 | \015?\012 |
499 | \012 |
369 | /gxc; |
500 | /gxc; |
370 | |
501 | |
371 | /\G$/ |
502 | /\G$/ |
372 | or return (%state = (), $cb->(undef, { Status => 599, Reason => "garbled response headers" })); |
503 | or return (%state = (), $cb->(undef, { Status => 599, Reason => "Garbled response headers", URL => $url })); |
373 | } |
504 | } |
374 | |
505 | |
375 | substr $_, 0, 1, "" |
506 | substr $_, 0, 1, "" |
376 | for values %hdr; |
507 | for values %hdr; |
377 | |
508 | |
378 | my $finish = sub { |
509 | # redirect handling |
379 | %state = (); |
510 | # microsoft and other shitheads don't give a shit for following standards, |
|
|
511 | # try to support some common forms of broken Location headers. |
|
|
512 | if ($hdr{location} !~ /^(?: $ | [^:\/?\#]+ : )/x) { |
|
|
513 | $hdr{location} =~ s/^\.\/+//; |
380 | |
514 | |
381 | # set-cookie processing |
515 | my $url = "$rscheme://$uhost:$uport"; |
382 | if ($arg{cookie_jar} && exists $hdr{"set-cookie"}) { |
|
|
383 | for (split /\x00/, $hdr{"set-cookie"}) { |
|
|
384 | my ($cookie, @arg) = split /;\s*/; |
|
|
385 | my ($name, $value) = split /=/, $cookie, 2; |
|
|
386 | my %kv = (value => $value, map { split /=/, $_, 2 } @arg); |
|
|
387 | |
|
|
388 | my $cdom = (delete $kv{domain}) || $uhost; |
|
|
389 | my $cpath = (delete $kv{path}) || "/"; |
|
|
390 | |
|
|
391 | $cdom =~ s/^.?/./; # make sure it starts with a "." |
|
|
392 | |
516 | |
393 | next if $cdom =~ /\.$/; |
517 | unless ($hdr{location} =~ s/^\///) { |
394 | |
518 | $url .= $upath; |
395 | # this is not rfc-like and not netscape-like. go figure. |
519 | $url =~ s/\/[^\/]*$//; |
396 | my $ndots = $cdom =~ y/.//; |
520 | } |
397 | next if $ndots < ($cdom =~ /\.[^.][^.]\.[^.][^.]$/ ? 3 : 2); |
521 | |
398 | |
522 | $hdr{location} = "$url/$hdr{location}"; |
|
|
523 | } |
|
|
524 | |
|
|
525 | my $redirect; |
|
|
526 | |
|
|
527 | if ($recurse) { |
|
|
528 | if ($hdr{Status} =~ /^30[12]$/ && $method ne "POST") { |
|
|
529 | # apparently, mozilla et al. just change POST to GET here |
|
|
530 | # more research is needed before we do the same |
399 | # store it |
531 | $redirect = 1; |
400 | $arg{cookie_jar}{version} = 1; |
532 | } elsif ($hdr{Status} == 303) { |
401 | $arg{cookie_jar}{$cdom}{$cpath}{$name} = \%kv; |
533 | # even http/1.1 is unclear on how to mutate the method |
|
|
534 | $method = "GET" unless $method eq "HEAD"; |
|
|
535 | $redirect = 1; |
|
|
536 | } elsif ($hdr{Status} == 307 && $method =~ /^(?:GET|HEAD)$/) { |
|
|
537 | $redirect = 1; |
402 | } |
538 | } |
403 | } |
539 | } |
404 | |
540 | |
405 | if ($_[1]{Status} =~ /^x30[12]$/ && $recurse) { |
541 | my $finish = sub { |
406 | # microsoft and other assholes don't give a shit for following standards, |
542 | $state{handle}->destroy if $state{handle}; |
407 | # try to support a common form of broken Location header. |
543 | %state = (); |
408 | $_[1]{location} =~ s%^/%$scheme://$uhost:$uport/%; |
|
|
409 | |
544 | |
|
|
545 | # set-cookie processing |
|
|
546 | if ($arg{cookie_jar}) { |
|
|
547 | for ($_[1]{"set-cookie"}) { |
|
|
548 | # parse NAME=VALUE |
|
|
549 | my @kv; |
|
|
550 | |
|
|
551 | while (/\G\s* ([^=;,[:space:]]+) \s*=\s* (?: "((?:[^\\"]+|\\.)*)" | ([^=;,[:space:]]*) )/gcxs) { |
|
|
552 | my $name = $1; |
|
|
553 | my $value = $3; |
|
|
554 | |
|
|
555 | unless ($value) { |
|
|
556 | $value = $2; |
|
|
557 | $value =~ s/\\(.)/$1/gs; |
|
|
558 | } |
|
|
559 | |
|
|
560 | push @kv, $name => $value; |
|
|
561 | |
|
|
562 | last unless /\G\s*;/gc; |
|
|
563 | } |
|
|
564 | |
|
|
565 | last unless @kv; |
|
|
566 | |
|
|
567 | my $name = shift @kv; |
|
|
568 | my %kv = (value => shift @kv, @kv); |
|
|
569 | |
|
|
570 | my $cdom; |
|
|
571 | my $cpath = (delete $kv{path}) || "/"; |
|
|
572 | |
|
|
573 | if (exists $kv{domain}) { |
|
|
574 | $cdom = delete $kv{domain}; |
|
|
575 | |
|
|
576 | $cdom =~ s/^\.?/./; # make sure it starts with a "." |
|
|
577 | |
|
|
578 | next if $cdom =~ /\.$/; |
|
|
579 | |
|
|
580 | # this is not rfc-like and not netscape-like. go figure. |
|
|
581 | my $ndots = $cdom =~ y/.//; |
|
|
582 | next if $ndots < ($cdom =~ /\.[^.][^.]\.[^.][^.]$/ ? 3 : 2); |
|
|
583 | } else { |
|
|
584 | $cdom = $uhost; |
|
|
585 | } |
|
|
586 | |
|
|
587 | # store it |
|
|
588 | $arg{cookie_jar}{version} = 1; |
|
|
589 | $arg{cookie_jar}{$cdom}{$cpath}{$name} = \%kv; |
|
|
590 | |
|
|
591 | redo if /\G\s*,/gc; |
|
|
592 | } |
|
|
593 | } |
|
|
594 | |
|
|
595 | if ($redirect) { |
|
|
596 | # we ignore any errors, as it is very common to receive |
|
|
597 | # Content-Length != 0 but no actual body |
|
|
598 | # we also access %hdr, as $_[1] might be an erro |
410 | http_request ($method, $_[1]{location}, %arg, recurse => $recurse - 1, $cb); |
599 | http_request ($method => $hdr{location}, %arg, recurse => $recurse - 1, $cb); |
|
|
600 | } else { |
|
|
601 | $cb->($_[0], $_[1]); |
|
|
602 | } |
|
|
603 | }; |
|
|
604 | |
|
|
605 | my $len = $hdr{"content-length"}; |
|
|
606 | |
|
|
607 | if (!$redirect && $arg{on_header} && !$arg{on_header}(\%hdr)) { |
|
|
608 | $finish->(undef, { Status => 598, Reason => "Request cancelled by on_header", URL => $url }); |
|
|
609 | } elsif ( |
|
|
610 | $hdr{Status} =~ /^(?:1..|[23]04)$/ |
|
|
611 | or $method eq "HEAD" |
|
|
612 | or (defined $len && !$len) |
|
|
613 | ) { |
|
|
614 | # no body |
|
|
615 | $finish->("", \%hdr); |
411 | } else { |
616 | } else { |
412 | $cb->($_[0], $_[1]); |
617 | # body handling, four different code paths |
|
|
618 | # for want_body_handle, on_body (2x), normal (2x) |
|
|
619 | # we might read too much here, but it does not matter yet (no pers. connections) |
|
|
620 | if (!$redirect && $arg{want_body_handle}) { |
|
|
621 | $_[0]->on_eof (undef); |
|
|
622 | $_[0]->on_error (undef); |
|
|
623 | $_[0]->on_read (undef); |
|
|
624 | |
|
|
625 | $finish->(delete $state{handle}, \%hdr); |
|
|
626 | |
|
|
627 | } elsif ($arg{on_body}) { |
|
|
628 | $_[0]->on_error (sub { $finish->(undef, { Status => 599, Reason => $_[2], URL => $url }) }); |
|
|
629 | if ($len) { |
|
|
630 | $_[0]->on_eof (undef); |
|
|
631 | $_[0]->on_read (sub { |
|
|
632 | $len -= length $_[0]{rbuf}; |
|
|
633 | |
|
|
634 | $arg{on_body}(delete $_[0]{rbuf}, \%hdr) |
|
|
635 | or $finish->(undef, { Status => 598, Reason => "Request cancelled by on_body", URL => $url }); |
|
|
636 | |
|
|
637 | $len > 0 |
|
|
638 | or $finish->("", \%hdr); |
|
|
639 | }); |
|
|
640 | } else { |
|
|
641 | $_[0]->on_eof (sub { |
|
|
642 | $finish->("", \%hdr); |
|
|
643 | }); |
|
|
644 | $_[0]->on_read (sub { |
|
|
645 | $arg{on_body}(delete $_[0]{rbuf}, \%hdr) |
|
|
646 | or $finish->(undef, { Status => 598, Reason => "Request cancelled by on_body", URL => $url }); |
|
|
647 | }); |
|
|
648 | } |
|
|
649 | } else { |
|
|
650 | $_[0]->on_eof (undef); |
|
|
651 | |
|
|
652 | if ($len) { |
|
|
653 | $_[0]->on_error (sub { $finish->(undef, { Status => 599, Reason => $_[2], URL => $url }) }); |
|
|
654 | $_[0]->on_read (sub { |
|
|
655 | $finish->((substr delete $_[0]{rbuf}, 0, $len, ""), \%hdr) |
|
|
656 | if $len <= length $_[0]{rbuf}; |
|
|
657 | }); |
|
|
658 | } else { |
|
|
659 | $_[0]->on_error (sub { |
|
|
660 | $! == Errno::EPIPE || !$! |
|
|
661 | ? $finish->(delete $_[0]{rbuf}, \%hdr) |
|
|
662 | : $finish->(undef, { Status => 599, Reason => $_[2], URL => $url }); |
|
|
663 | }); |
|
|
664 | $_[0]->on_read (sub { }); |
|
|
665 | } |
|
|
666 | } |
413 | } |
667 | } |
414 | }; |
668 | }); |
|
|
669 | }); |
|
|
670 | }; |
415 | |
671 | |
416 | if ($hdr{Status} =~ /^(?:1..|204|304)$/ or $method eq "HEAD") { |
672 | # now handle proxy-CONNECT method |
417 | $finish->(undef, \%hdr); |
673 | if ($proxy && $uscheme eq "https") { |
|
|
674 | # oh dear, we have to wrap it into a connect request |
|
|
675 | |
|
|
676 | # maybe re-use $uauthority with patched port? |
|
|
677 | $state{handle}->push_write ("CONNECT $uhost:$uport HTTP/1.0\015\012Host: $uhost\015\012\015\012"); |
|
|
678 | $state{handle}->push_read (line => $qr_nlnl, sub { |
|
|
679 | $_[1] =~ /^HTTP\/([0-9\.]+) \s+ ([0-9]{3}) (?: \s+ ([^\015\012]*) )?/ix |
|
|
680 | or return (%state = (), $cb->(undef, { Status => 599, Reason => "Invalid proxy connect response ($_[1])", URL => $url })); |
|
|
681 | |
|
|
682 | if ($2 == 200) { |
|
|
683 | $rpath = $upath; |
|
|
684 | &$handle_actual_request; |
418 | } else { |
685 | } else { |
419 | if (exists $hdr{"content-length"}) { |
686 | %state = (); |
420 | $_[0]->unshift_read (chunk => $hdr{"content-length"}, sub { |
687 | $cb->(undef, { Status => $2, Reason => $3, URL => $url }); |
421 | # could cache persistent connection now |
|
|
422 | if ($hdr{connection} =~ /\bkeep-alive\b/i) { |
|
|
423 | # but we don't, due to misdesigns, this is annoyingly complex |
|
|
424 | }; |
|
|
425 | |
|
|
426 | $finish->($_[1], \%hdr); |
|
|
427 | }); |
|
|
428 | } else { |
|
|
429 | # too bad, need to read until we get an error or EOF, |
|
|
430 | # no way to detect winged data. |
|
|
431 | $_[0]->on_error (sub { |
|
|
432 | $finish->($_[0]{rbuf}, \%hdr); |
|
|
433 | }); |
|
|
434 | $_[0]->on_eof (undef); |
|
|
435 | $_[0]->on_read (sub { }); |
|
|
436 | } |
|
|
437 | } |
688 | } |
438 | }); |
689 | }); |
|
|
690 | } else { |
|
|
691 | &$handle_actual_request; |
439 | }); |
692 | } |
|
|
693 | |
440 | }, sub { |
694 | }, sub { |
441 | $timeout |
695 | $timeout |
442 | }; |
696 | }; |
443 | }; |
697 | }; |
444 | |
698 | |
445 | defined wantarray && AnyEvent::Util::guard { %state = () } |
699 | defined wantarray && AnyEvent::Util::guard { %state = () } |
446 | } |
700 | } |
447 | |
701 | |
448 | sub http_get($$;@) { |
702 | sub http_get($@) { |
449 | unshift @_, "GET"; |
703 | unshift @_, "GET"; |
450 | &http_request |
704 | &http_request |
451 | } |
705 | } |
452 | |
706 | |
453 | sub http_head($$;@) { |
707 | sub http_head($@) { |
454 | unshift @_, "HEAD"; |
708 | unshift @_, "HEAD"; |
455 | &http_request |
709 | &http_request |
456 | } |
710 | } |
457 | |
711 | |
458 | sub http_post($$$;@) { |
712 | sub http_post($$@) { |
|
|
713 | my $url = shift; |
459 | unshift @_, "POST", "body"; |
714 | unshift @_, "POST", $url, "body"; |
460 | &http_request |
715 | &http_request |
461 | } |
716 | } |
462 | |
717 | |
463 | =back |
718 | =back |
464 | |
719 | |
… | |
… | |
476 | The default value for the C<recurse> request parameter (default: C<10>). |
731 | The default value for the C<recurse> request parameter (default: C<10>). |
477 | |
732 | |
478 | =item $AnyEvent::HTTP::USERAGENT |
733 | =item $AnyEvent::HTTP::USERAGENT |
479 | |
734 | |
480 | The default value for the C<User-Agent> header (the default is |
735 | The default value for the C<User-Agent> header (the default is |
481 | C<Mozilla/5.0 (compatible; AnyEvent::HTTP/$VERSION; +http://software.schmorp.de/pkg/AnyEvent)>). |
736 | C<Mozilla/5.0 (compatible; U; AnyEvent-HTTP/$VERSION; +http://software.schmorp.de/pkg/AnyEvent)>). |
482 | |
737 | |
483 | =item $AnyEvent::HTTP::MAX_PERSISTENT |
738 | =item $AnyEvent::HTTP::MAX_PER_HOST |
484 | |
739 | |
485 | The maximum number of persistent connections to keep open (default: 8). |
740 | The maximum number of concurrent conenctions to the same host (identified |
|
|
741 | by the hostname). If the limit is exceeded, then the additional requests |
|
|
742 | are queued until previous connections are closed. |
486 | |
743 | |
487 | Not implemented currently. |
744 | The default value for this is C<4>, and it is highly advisable to not |
|
|
745 | increase it. |
488 | |
746 | |
489 | =item $AnyEvent::HTTP::PERSISTENT_TIMEOUT |
747 | =item $AnyEvent::HTTP::ACTIVE |
490 | |
748 | |
491 | The maximum time to cache a persistent connection, in seconds (default: 2). |
749 | The number of active connections. This is not the number of currently |
492 | |
750 | running requests, but the number of currently open and non-idle TCP |
493 | Not implemented currently. |
751 | connections. This number of can be useful for load-leveling. |
494 | |
752 | |
495 | =back |
753 | =back |
496 | |
754 | |
497 | =cut |
755 | =cut |
498 | |
756 | |
… | |
… | |
507 | |
765 | |
508 | L<AnyEvent>. |
766 | L<AnyEvent>. |
509 | |
767 | |
510 | =head1 AUTHOR |
768 | =head1 AUTHOR |
511 | |
769 | |
512 | Marc Lehmann <schmorp@schmorp.de> |
770 | Marc Lehmann <schmorp@schmorp.de> |
513 | http://home.schmorp.de/ |
771 | http://home.schmorp.de/ |
|
|
772 | |
|
|
773 | With many thanks to Дмитрий Шалашов, who provided countless |
|
|
774 | testcases and bugreports. |
514 | |
775 | |
515 | =cut |
776 | =cut |
516 | |
777 | |
517 | 1 |
778 | 1 |
518 | |
779 | |