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