ViewVC Help
View File | Revision Log | Show Annotations | Download File
/cvs/AnyEvent-HTTP/HTTP.pm
(Generate patch)

Comparing AnyEvent-HTTP/HTTP.pm (file contents):
Revision 1.4 by root, Wed Jun 4 11:59:22 2008 UTC vs.
Revision 1.69 by root, Fri Dec 31 19:32:47 2010 UTC

3AnyEvent::HTTP - simple but non-blocking HTTP/HTTPS client 3AnyEvent::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
11This module is an L<AnyEvent> user, you need to make sure that you use and 15This module is an L<AnyEvent> user, you need to make sure that you use and
12run a supported event loop. 16run a supported event loop.
13 17
18This module implements a simple, stateless and non-blocking HTTP
19client. It supports GET, POST and other request methods, cookies and more,
20all on a very low level. It can follow redirects supports proxies and
21automatically limits the number of connections to the values specified in
22the RFC.
23
24It should generally be a "good client" that is enough for most HTTP
25tasks. Simple tasks should be simple, but complex tasks should still be
26possible as the user retains control over request and response headers.
27
28The caller is responsible for authentication management, cookies (if
29the simplistic implementation in this module doesn't suffice), referer
30and other high-level protocol details for which this module offers only
31limited support.
32
14=head2 METHODS 33=head2 METHODS
15 34
16=over 4 35=over 4
17 36
18=cut 37=cut
20package AnyEvent::HTTP; 39package AnyEvent::HTTP;
21 40
22use strict; 41use strict;
23no warnings; 42no warnings;
24 43
25use Carp; 44use Errno ();
26 45
27use AnyEvent (); 46use AnyEvent 5.0 ();
28use AnyEvent::Util (); 47use AnyEvent::Util ();
29use AnyEvent::Socket ();
30use AnyEvent::Handle (); 48use AnyEvent::Handle ();
31 49
32use base Exporter::; 50use base Exporter::;
33 51
34our $VERSION = '1.0'; 52our $VERSION = '1.5';
35 53
36our @EXPORT = qw(http_get http_request); 54our @EXPORT = qw(http_get http_post http_head http_request);
37 55
38our $USERAGENT = "Mozilla/5.0 (compatible; AnyEvent::HTTP/$VERSION; +http://software.schmorp.de/pkg/AnyEvent)"; 56our $USERAGENT = "Mozilla/5.0 (compatible; U; AnyEvent-HTTP/$VERSION; +http://software.schmorp.de/pkg/AnyEvent)";
39our $MAX_RECURSE = 10; 57our $MAX_RECURSE = 10;
40our $MAX_PERSISTENT = 8; 58our $MAX_PERSISTENT = 8;
41our $PERSISTENT_TIMEOUT = 2; 59our $PERSISTENT_TIMEOUT = 2;
42our $TIMEOUT = 300; 60our $TIMEOUT = 300;
43 61
44# changing these is evil 62# changing these is evil
45our $MAX_PERSISTENT_PER_HOST = 2; 63our $MAX_PERSISTENT_PER_HOST = 0;
46our $MAX_PER_HOST = 4; # not respected yet :( 64our $MAX_PER_HOST = 4;
47 65
48our $PROXY; 66our $PROXY;
67our $ACTIVE = 0;
49 68
50my %KA_COUNT; # number of open keep-alive connections per host 69my %KA_COUNT; # number of open keep-alive connections per host
70my %CO_SLOT; # number of open connections, and wait queue, per host
51 71
52=item http_get $url, key => value..., $cb->($data, $headers) 72=item http_get $url, key => value..., $cb->($data, $headers)
53 73
54Executes an HTTP-GET request. See the http_request function for details on 74Executes an HTTP-GET request. See the http_request function for details on
55additional parameters. 75additional parameters and the return value.
56 76
77=item http_head $url, key => value..., $cb->($data, $headers)
78
79Executes an HTTP-HEAD request. See the http_request function for details
80on additional parameters and the return value.
81
57=item http_get $url, $body, key => value..., $cb->($data, $headers) 82=item http_post $url, $body, key => value..., $cb->($data, $headers)
58 83
59Executes an HTTP-POST request with a requets body of C<$bod>. See the 84Executes an HTTP-POST request with a request body of C<$body>. See the
60http_request function for details on additional parameters. 85http_request function for details on additional parameters and the return
86value.
61 87
62=item http_request $method => $url, key => value..., $cb->($data, $headers) 88=item http_request $method => $url, key => value..., $cb->($data, $headers)
63 89
64Executes a HTTP request of type C<$method> (e.g. C<GET>, C<POST>). The URL 90Executes a HTTP request of type C<$method> (e.g. C<GET>, C<POST>). The URL
65must be an absolute http or https URL. 91must be an absolute http or https URL.
66 92
93When called in void context, nothing is returned. In other contexts,
94C<http_request> returns a "cancellation guard" - you have to keep the
95object at least alive until the callback get called. If the object gets
96destroyed before the callback is called, the request will be cancelled.
97
67The callback will be called with the response data as first argument 98The 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 99(or C<undef> if an error occured), and a hash-ref with response headers
69response headers as second argument. 100(and trailers) as second argument.
70 101
71All the headers in that has are lowercased. In addition to the response 102All the headers in that hash are lowercased. In addition to the response
72headers, the three "pseudo-headers" C<HTTPVersion>, C<Status> and 103headers, the "pseudo-headers" (uppercase to avoid clashing with possible
73C<Reason> contain the three parts of the HTTP Status-Line of the same 104response headers) C<HTTPVersion>, C<Status> and C<Reason> contain the
74name. 105three parts of the HTTP Status-Line of the same name. If an error occurs
106during the body phase of a request, then the original C<Status> and
107C<Reason> values from the header are available as C<OrigStatus> and
108C<OrigReason>.
109
110The pseudo-header C<URL> contains the actual URL (which can differ from
111the requested URL when following redirects - for example, you might get
112an error that your URL scheme is not supported even though your URL is a
113valid http URL because it redirected to an ftp URL, in which case you can
114look at the URL pseudo header).
115
116The pseudo-header C<Redirect> only exists when the request was a result
117of an internal redirect. In that case it is an array reference with
118the C<($data, $headers)> from the redirect response. Note that this
119response could in turn be the result of a redirect itself, and C<<
120$headers->{Redirect}[1]{Redirect} >> will then contain the original
121response, and so on.
122
123If the server sends a header multiple times, then their contents will be
124joined together with a comma (C<,>), as per the HTTP spec.
75 125
76If an internal error occurs, such as not being able to resolve a hostname, 126If an internal error occurs, such as not being able to resolve a hostname,
77then C<$data> will be C<undef>, C<< $headers->{Status} >> will be C<599> 127then C<$data> will be C<undef>, C<< $headers->{Status} >> will be C<59x>
78and the C<Reason> pseudo-header will contain an error message. 128(usually C<599>) and the C<Reason> pseudo-header will contain an error
129message.
130
131A typical callback might look like this:
132
133 sub {
134 my ($body, $hdr) = @_;
135
136 if ($hdr->{Status} =~ /^2/) {
137 ... everything should be ok
138 } else {
139 print "error, $hdr->{Status} $hdr->{Reason}\n";
140 }
141 }
79 142
80Additional parameters are key-value pairs, and are fully optional. They 143Additional parameters are key-value pairs, and are fully optional. They
81include: 144include:
82 145
83=over 4 146=over 4
87Whether to recurse requests or not, e.g. on redirects, authentication 150Whether to recurse requests or not, e.g. on redirects, authentication
88retries and so on, and how often to do so. 151retries and so on, and how often to do so.
89 152
90=item headers => hashref 153=item headers => hashref
91 154
92The request headers to use. 155The request headers to use. Currently, C<http_request> may provide its own
156C<Host:>, C<Content-Length:>, C<Connection:> and C<Cookie:> headers and
157will 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
159they won't be sent at all).
93 160
94=item timeout => $seconds 161=item timeout => $seconds
95 162
96The time-out to use for various stages - each connect attempt will reset 163The time-out to use for various stages - each connect attempt will reset
97the timeout, as will read or write activity. Default timeout is 5 minutes. 164the timeout, as will read or write activity, i.e. this is not an overall
165timeout.
166
167Default timeout is 5 minutes.
98 168
99=item proxy => [$host, $port[, $scheme]] or undef 169=item proxy => [$host, $port[, $scheme]] or undef
100 170
101Use the given http proxy for all requests. If not specified, then the 171Use the given http proxy for all requests. If not specified, then the
102default proxy (as specified by C<$ENV{http_proxy}>) is used. 172default proxy (as specified by C<$ENV{http_proxy}>) is used.
103 173
104C<$scheme> must be either missing or C<http> for HTTP, or C<https> for 174C<$scheme> must be either missing, C<http> for HTTP or C<https> for
105HTTPS. 175HTTPS.
106 176
107=item body => $string 177=item body => $string
108 178
109The request body, usually empty. Will be-sent as-is (future versions of 179The request body, usually empty. Will be sent as-is (future versions of
110this module might offer more options). 180this module might offer more options).
111 181
182=item cookie_jar => $hash_ref
183
184Passing this parameter enables (simplified) cookie-processing, loosely
185based on the original netscape specification.
186
187The C<$hash_ref> must be an (initially empty) hash reference which will
188get updated automatically. It is possible to save the cookie_jar to
189persistent storage with something like JSON or Storable, but this is not
190recommended, as expiry times are currently being ignored.
191
192Note that this cookie implementation is not of very high quality, nor
193meant to be complete. If you want complete cookie management you have to
194do that on your own. C<cookie_jar> is meant as a quick fix to get some
195cookie-using sites working. Cookies are a privacy disaster, do not use
196them unless required to.
197
198When cookie processing is enabled, the C<Cookie:> and C<Set-Cookie:>
199headers will be ste and handled by this module, otherwise they will be
200left untouched.
201
202=item tls_ctx => $scheme | $tls_ctx
203
204Specifies the AnyEvent::TLS context to be used for https connections. This
205parameter follows the same rules as the C<tls_ctx> parameter to
206L<AnyEvent::Handle>, but additionally, the two strings C<low> or
207C<high> can be specified, which give you a predefined low-security (no
208verification, highest compatibility) and high-security (CA and common-name
209verification) TLS context.
210
211The default for this option is C<low>, which could be interpreted as "give
212me the page, no matter what".
213
214=item on_prepare => $callback->($fh)
215
216In rare cases you need to "tune" the socket before it is used to
217connect (for exmaple, to bind it on a given IP address). This parameter
218overrides the prepare callback passed to C<AnyEvent::Socket::tcp_connect>
219and behaves exactly the same way (e.g. it has to provide a
220timeout). See the description for the C<$prepare_cb> argument of
221C<AnyEvent::Socket::tcp_connect> for details.
222
223=item tcp_connect => $callback->($host, $service, $connect_cb, $prepare_cb)
224
225In even rarer cases you want total control over how AnyEvent::HTTP
226establishes connections. Normally it uses L<AnyEvent::Socket::tcp_connect>
227to do this, but you can provide your own C<tcp_connect> function -
228obviously, it has to follow the same calling conventions, except that it
229may always return a connection guard object.
230
231There are probably lots of weird uses for this function, starting from
232tracing the hosts C<http_request> actually tries to connect, to (inexact
233but fast) host => IP address caching or even socks protocol support.
234
235=item on_header => $callback->($headers)
236
237When specified, this callback will be called with the header hash as soon
238as headers have been successfully received from the remote server (not on
239locally-generated errors).
240
241It has to return either true (in which case AnyEvent::HTTP will continue),
242or false, in which case AnyEvent::HTTP will cancel the download (and call
243the finish callback with an error code of C<598>).
244
245This callback is useful, among other things, to quickly reject unwanted
246content, which, if it is supposed to be rare, can be faster than first
247doing a C<HEAD> request.
248
249The downside is that cancelling the request makes it impossible to re-use
250the connection. Also, the C<on_header> callback will not receive any
251trailer (headers sent after the response body).
252
253Example: cancel the request unless the content-type is "text/html".
254
255 on_header => sub {
256 $_[0]{"content-type"} =~ /^text\/html\s*(?:;|$)/
257 },
258
259=item on_body => $callback->($partial_body, $headers)
260
261When specified, all body data will be passed to this callback instead of
262to the completion callback. The completion callback will get the empty
263string instead of the body data.
264
265It has to return either true (in which case AnyEvent::HTTP will continue),
266or false, in which case AnyEvent::HTTP will cancel the download (and call
267the completion callback with an error code of C<598>).
268
269The downside to cancelling the request is that it makes it impossible to
270re-use the connection.
271
272This callback is useful when the data is too large to be held in memory
273(so the callback writes it to a file) or when only some information should
274be extracted, or when the body should be processed incrementally.
275
276It is usually preferred over doing your own body handling via
277C<want_body_handle>, but in case of streaming APIs, where HTTP is
278only used to create a connection, C<want_body_handle> is the better
279alternative, as it allows you to install your own event handler, reducing
280resource usage.
281
282=item want_body_handle => $enable
283
284When enabled (default is disabled), the behaviour of AnyEvent::HTTP
285changes considerably: after parsing the headers, and instead of
286downloading the body (if any), the completion callback will be
287called. Instead of the C<$body> argument containing the body data, the
288callback will receive the L<AnyEvent::Handle> object associated with the
289connection. 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.
291
292The handle object might or might not be in TLS mode, might be connected to
293a proxy, be a persistent connection etc., and configured in unspecified
294ways. The user is responsible for this handle (it will not be used by this
295module anymore).
296
297This is useful with some push-type services, where, after the initial
298headers, an interactive protocol is used (typical example would be the
299push-style twitter API which starts a JSON/XML stream).
300
301If you think you need this, first have a look at C<on_body>, to see if
302that doesn't solve your problem in a better way.
303
112=back 304=back
113 305
114=back 306Example: do a simple HTTP GET request for http://www.nethype.de/ and print
307the response body.
308
309 http_request GET => "http://www.nethype.de/", sub {
310 my ($body, $hdr) = @_;
311 print "$body\n";
312 };
313
314Example: do a HTTP HEAD request on https://www.google.com/, use a
315timeout of 30 seconds.
316
317 http_request
318 GET => "https://www.google.com",
319 timeout => 30,
320 sub {
321 my ($body, $hdr) = @_;
322 use Data::Dumper;
323 print Dumper $hdr;
324 }
325 ;
326
327Example: do another simple HTTP GET request, but immediately try to
328cancel it.
329
330 my $request = http_request GET => "http://www.nethype.de/", sub {
331 my ($body, $hdr) = @_;
332 print "$body\n";
333 };
334
335 undef $request;
115 336
116=cut 337=cut
117 338
339sub _slot_schedule;
340sub _slot_schedule($) {
341 my $host = shift;
342
343 while ($CO_SLOT{$host}[0] < $MAX_PER_HOST) {
344 if (my $cb = shift @{ $CO_SLOT{$host}[1] }) {
345 # somebody wants that slot
346 ++$CO_SLOT{$host}[0];
347 ++$ACTIVE;
348
349 $cb->(AnyEvent::Util::guard {
350 --$ACTIVE;
351 --$CO_SLOT{$host}[0];
352 _slot_schedule $host;
353 });
354 } else {
355 # nobody wants the slot, maybe we can forget about it
356 delete $CO_SLOT{$host} unless $CO_SLOT{$host}[0];
357 last;
358 }
359 }
360}
361
362# wait for a free slot on host, call callback
363sub _get_slot($$) {
364 push @{ $CO_SLOT{$_[0]}[1] }, $_[1];
365
366 _slot_schedule $_[0];
367}
368
369# continue to parse $_ for headers and place them into the arg
370sub parse_hdr() {
371 my %hdr;
372
373 # things seen, not parsed:
374 # p3pP="NON CUR OTPi OUR NOR UNI"
375
376 $hdr{lc $1} .= ",$2"
377 while /\G
378 ([^:\000-\037]*):
379 [\011\040]*
380 ((?: [^\012]+ | \012[\011\040] )*)
381 \012
382 /gxc;
383
384 /\G$/
385 or return;
386
387 # remove the "," prefix we added to all headers above
388 substr $_, 0, 1, ""
389 for values %hdr;
390
391 \%hdr
392}
393
394our $qr_nlnl = qr{(?<![^\012])\015?\012};
395
396our $TLS_CTX_LOW = { cache => 1, sslv2 => 1 };
397our $TLS_CTX_HIGH = { cache => 1, verify => 1, verify_peername => "https" };
398
118sub http_request($$$;@) { 399sub http_request($$@) {
119 my $cb = pop; 400 my $cb = pop;
120 my ($method, $url, %arg) = @_; 401 my ($method, $url, %arg) = @_;
121 402
122 my %hdr; 403 my %hdr;
123 404
405 $arg{tls_ctx} = $TLS_CTX_LOW if $arg{tls_ctx} eq "low" || !exists $arg{tls_ctx};
406 $arg{tls_ctx} = $TLS_CTX_HIGH if $arg{tls_ctx} eq "high";
407
124 $method = uc $method; 408 $method = uc $method;
125 409
126 if (my $hdr = delete $arg{headers}) { 410 if (my $hdr = $arg{headers}) {
127 while (my ($k, $v) = each %$hdr) { 411 while (my ($k, $v) = each %$hdr) {
128 $hdr{lc $k} = $v; 412 $hdr{lc $k} = $v;
129 } 413 }
130 } 414 }
131 415
416 # pseudo headers for all subsequent responses
417 my @pseudo = (URL => $url);
418 push @pseudo, Redirect => delete $arg{Redirect} if exists $arg{Redirect};
419
420 my $recurse = exists $arg{recurse} ? delete $arg{recurse} : $MAX_RECURSE;
421
422 return $cb->(undef, { @pseudo, Status => 599, Reason => "Too many redirections" })
423 if $recurse < 0;
424
132 my $proxy = $arg{proxy} || $PROXY; 425 my $proxy = $arg{proxy} || $PROXY;
133 my $timeout = $arg{timeout} || $TIMEOUT; 426 my $timeout = $arg{timeout} || $TIMEOUT;
134 my $recurse = exists $arg{recurse} ? $arg{recurse} : $MAX_RECURSE;
135 427
136 $hdr{"user-agent"} ||= $USERAGENT; 428 my ($uscheme, $uauthority, $upath, $query, $fragment) =
429 $url =~ m|(?:([^:/?#]+):)?(?://([^/?#]*))?([^?#]*)(?:(\?[^#]*))?(?:#(.*))?|;
137 430
138 my ($host, $port, $path, $scheme); 431 $uscheme = lc $uscheme;
432
433 my $uport = $uscheme eq "http" ? 80
434 : $uscheme eq "https" ? 443
435 : return $cb->(undef, { @pseudo, Status => 599, Reason => "Only http and https URL schemes supported" });
436
437 $uauthority =~ /^(?: .*\@ )? ([^\@:]+) (?: : (\d+) )?$/x
438 or return $cb->(undef, { @pseudo, Status => 599, Reason => "Unparsable URL" });
439
440 my $uhost = $1;
441 $uport = $2 if defined $2;
442
443 $hdr{host} = defined $2 ? "$uhost:$2" : "$uhost"
444 unless exists $hdr{host};
445
446 $uhost =~ s/^\[(.*)\]$/$1/;
447 $upath .= $query if length $query;
448
449 $upath =~ s%^/?%/%;
450
451 # cookie processing
452 if (my $jar = $arg{cookie_jar}) {
453 %$jar = () if $jar->{version} != 1;
454
455 my @cookie;
456
457 while (my ($chost, $v) = each %$jar) {
458 if ($chost =~ /^\./) {
459 next unless $chost eq substr $uhost, -length $chost;
460 } elsif ($chost =~ /\./) {
461 next unless $chost eq $uhost;
462 } else {
463 next;
464 }
465
466 while (my ($cpath, $v) = each %$v) {
467 next unless $cpath eq substr $upath, 0, length $cpath;
468
469 while (my ($k, $v) = each %$v) {
470 next if $uscheme ne "https" && exists $v->{secure};
471 my $value = $v->{value};
472 $value =~ s/([\\"])/\\$1/g;
473 push @cookie, "$k=\"$value\"";
474 }
475 }
476 }
477
478 $hdr{cookie} = join "; ", @cookie
479 if @cookie;
480 }
481
482 my ($rhost, $rport, $rscheme, $rpath); # request host, port, path
139 483
140 if ($proxy) { 484 if ($proxy) {
141 ($host, $port, $scheme) = @$proxy; 485 ($rpath, $rhost, $rport, $rscheme) = ($url, @$proxy);
142 $path = $url; 486
487 $rscheme = "http" unless defined $rscheme;
488
489 # don't support https requests over https-proxy transport,
490 # can't be done with tls as spec'ed, unless you double-encrypt.
491 $rscheme = "http" if $uscheme eq "https" && $rscheme eq "https";
143 } else { 492 } else {
144 ($scheme, my $authority, $path, my $query, my $fragment) = 493 ($rhost, $rport, $rscheme, $rpath) = ($uhost, $uport, $uscheme, $upath);
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 } 494 }
164 495
165 $scheme = lc $scheme; 496 # leave out fragment and query string, just a heuristic
497 $hdr{referer} = "$uscheme://$uauthority$upath" unless exists $hdr{referer};
498 $hdr{"user-agent"} = $USERAGENT unless exists $hdr{"user-agent"};
166 499
167 my %state;
168
169 $state{body} = delete $arg{body};
170
171 $hdr{"content-length"} = length $state{body}; 500 $hdr{"content-length"} = length $arg{body}
501 if length $arg{body} || $method ne "GET";
172 502
173 $state{connect_guard} = AnyEvent::Socket::tcp_connect $host, $port, sub { 503 $hdr{connection} = "close TE"; #1.1
504 $hdr{te} = "trailers" unless exists $hdr{te}; #1.1
505
506 my %state = (connect_guard => 1);
507
508 _get_slot $uhost, sub {
509 $state{slot_guard} = shift;
510
511 return unless $state{connect_guard};
512
513 my $connect_cb = sub {
174 $state{fh} = shift 514 $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 } 515 or do {
242 516 my $err = "$!";
243 substr $_, 0, 1, ""
244 for values %hdr;
245
246 if ($method eq "HEAD") {
247 %state = (); 517 %state = ();
518 return $cb->(undef, { @pseudo, Status => 599, Reason => $err });
519 };
520
521 pop; # free memory, save a tree
522
523 return unless delete $state{connect_guard};
524
525 # get handle
526 $state{handle} = new AnyEvent::Handle
527 fh => $state{fh},
528 peername => $rhost,
529 tls_ctx => $arg{tls_ctx},
530 # these need to be reconfigured on keepalive handles
531 timeout => $timeout,
532 on_error => sub {
533 %state = ();
534 $cb->(undef, { @pseudo, Status => 599, Reason => $_[2] });
535 },
536 on_eof => sub {
537 %state = ();
538 $cb->(undef, { @pseudo, Status => 599, Reason => "Unexpected end-of-file" });
539 },
540 ;
541
542 # limit the number of persistent connections
543 # keepalive not yet supported
544# if ($KA_COUNT{$_[1]} < $MAX_PERSISTENT_PER_HOST) {
545# ++$KA_COUNT{$_[1]};
546# $state{handle}{ka_count_guard} = AnyEvent::Util::guard {
547# --$KA_COUNT{$_[1]}
548# };
549# $hdr{connection} = "keep-alive";
550# }
551
552 $state{handle}->starttls ("connect") if $rscheme eq "https";
553
554 # handle actual, non-tunneled, request
555 my $handle_actual_request = sub {
556 $state{handle}->starttls ("connect") if $uscheme eq "https" && !exists $state{handle}{tls};
557
558 # send request
559 $state{handle}->push_write (
560 "$method $rpath HTTP/1.1\015\012"
561 . (join "", map "\u$_: $hdr{$_}\015\012", grep defined $hdr{$_}, keys %hdr)
562 . "\015\012"
563 . (delete $arg{body})
564 );
565
566 # return if error occured during push_write()
567 return unless %state;
568
569 %hdr = (); # reduce memory usage, save a kitten, also make it possible to re-use
570
571 # status line and headers
572 $state{read_response} = sub {
573 for ("$_[1]") {
574 y/\015//d; # weed out any \015, as they show up in the weirdest of places.
575
576 /^HTTP\/([0-9\.]+) \s+ ([0-9]{3}) (?: \s+ ([^\012]*) )? \012/igxc
577 or return (%state = (), $cb->(undef, { @pseudo, Status => 599, Reason => "Invalid server response" }));
578
579 # 100 Continue handling
580 # should not happen as we don't send expect: 100-continue,
581 # but we handle it just in case.
582 # since we send the request body regardless, if we get an error
583 # we are out of-sync, which we currently do NOT handle correctly.
584 return $state{handle}->push_read (line => $qr_nlnl, $state{read_response})
585 if $2 eq 100;
586
587 push @pseudo,
588 HTTPVersion => $1,
589 Status => $2,
590 Reason => $3,
591 ;
592
593 my $hdr = parse_hdr
594 or return (%state = (), $cb->(undef, { @pseudo, Status => 599, Reason => "Garbled response headers" }));
595
596 %hdr = (%$hdr, @pseudo);
597 }
598
599 # redirect handling
600 # microsoft and other shitheads don't give a shit for following standards,
601 # try to support some common forms of broken Location headers.
602 if ($hdr{location} !~ /^(?: $ | [^:\/?\#]+ : )/x) {
603 $hdr{location} =~ s/^\.\/+//;
604
605 my $url = "$rscheme://$uhost:$uport";
606
607 unless ($hdr{location} =~ s/^\///) {
608 $url .= $upath;
609 $url =~ s/\/[^\/]*$//;
610 }
611
612 $hdr{location} = "$url/$hdr{location}";
613 }
614
615 my $redirect;
616
617 if ($recurse) {
618 my $status = $hdr{Status};
619
620 # industry standard is to redirect POST as GET for
621 # 301, 302 and 303, in contrast to http/1.0 and 1.1.
622 # also, the UA should ask the user for 301 and 307 and POST,
623 # industry standard seems to be to simply follow.
624 # we go with the industry standard.
625 if ($status == 301 or $status == 302 or $status == 303) {
626 # HTTP/1.1 is unclear on how to mutate the method
627 $method = "GET" unless $method eq "HEAD";
628 $redirect = 1;
629 } elsif ($status == 307) {
630 $redirect = 1;
631 }
632 }
633
634 my $finish = sub { # ($data, $err_status, $err_reason[, $keepalive])
635 my $keepalive = pop;
636
637 $state{handle}->destroy if $state{handle};
638 %state = ();
639
640 if (defined $_[1]) {
641 $hdr{OrigStatus} = $hdr{Status}; $hdr{Status} = $_[1];
642 $hdr{OrigReason} = $hdr{Reason}; $hdr{Reason} = $_[2];
643 }
644
645 # set-cookie processing
646 if ($arg{cookie_jar}) {
647 for ($hdr{"set-cookie"}) {
648 # parse NAME=VALUE
649 my @kv;
650
651 while (/\G\s* ([^=;,[:space:]]+) \s*=\s* (?: "((?:[^\\"]+|\\.)*)" | ([^=;,[:space:]]*) )/gcxs) {
652 my $name = $1;
653 my $value = $3;
654
655 unless ($value) {
656 $value = $2;
657 $value =~ s/\\(.)/$1/gs;
658 }
659
660 push @kv, $name => $value;
661
662 last unless /\G\s*;/gc;
663 }
664
665 last unless @kv;
666
667 my $name = shift @kv;
668 my %kv = (value => shift @kv, @kv);
669
670 my $cdom;
671 my $cpath = (delete $kv{path}) || "/";
672
673 if (exists $kv{domain}) {
674 $cdom = delete $kv{domain};
675
676 $cdom =~ s/^\.?/./; # make sure it starts with a "."
677
678 next if $cdom =~ /\.$/;
679
680 # this is not rfc-like and not netscape-like. go figure.
681 my $ndots = $cdom =~ y/.//;
682 next if $ndots < ($cdom =~ /\.[^.][^.]\.[^.][^.]$/ ? 3 : 2);
683 } else {
684 $cdom = $uhost;
685 }
686
687 # store it
688 $arg{cookie_jar}{version} = 1;
689 $arg{cookie_jar}{$cdom}{$cpath}{$name} = \%kv;
690
691 redo if /\G\s*,/gc;
692 }
693 }
694
695 if ($redirect && exists $hdr{location}) {
696 # we ignore any errors, as it is very common to receive
697 # Content-Length != 0 but no actual body
698 # we also access %hdr, as $_[1] might be an erro
699 http_request (
700 $method => $hdr{location},
701 %arg,
702 recurse => $recurse - 1,
703 Redirect => [$_[0], \%hdr],
704 $cb);
705 } else {
248 $cb->(undef, \%hdr); 706 $cb->($_[0], \%hdr);
707 }
708 };
709
710 my $len = $hdr{"content-length"};
711
712 if (!$redirect && $arg{on_header} && !$arg{on_header}(\%hdr)) {
713 $finish->(undef, 598 => "Request cancelled by on_header");
714 } elsif (
715 $hdr{Status} =~ /^(?:1..|204|205|304)$/
716 or $method eq "HEAD"
717 or (defined $len && !$len)
718 ) {
719 # no body
720 $finish->("", undef, undef, 1);
249 } else { 721 } else {
250 if (exists $hdr{"content-length"}) { 722 # body handling, many different code paths
723 # - no body expected
724 # - want_body_handle
725 # - te chunked
726 # - 2x length known (with or without on_body)
727 # - 2x length not known (with or without on_body)
728 if (!$redirect && $arg{want_body_handle}) {
729 $_[0]->on_eof (undef);
730 $_[0]->on_error (undef);
731 $_[0]->on_read (undef);
732
733 $finish->(delete $state{handle});
734
735 } elsif ($hdr{"transfer-encoding"} =~ /\bchunked\b/i) {
736 my $cl = 0;
737 my $body = undef;
738 my $on_body = $arg{on_body} || sub { $body .= shift; 1 };
739
740 $_[0]->on_error (sub { $finish->(undef, 599 => $_[2]) });
741
742 my $read_chunk; $read_chunk = sub {
743 $_[1] =~ /^([0-9a-fA-F]+)/
744 or $finish->(undef, 599 => "Garbled chunked transfer encoding");
745
746 my $len = hex $1;
747
748 if ($len) {
749 $cl += $len;
750
251 $_[0]->unshift_read (chunk => $hdr{"content-length"}, sub { 751 $_[0]->push_read (chunk => $len, sub {
252 # could cache persistent connection now 752 $on_body->($_[1], \%hdr)
253 if ($hdr{connection} =~ /\bkeep-alive\b/i) { 753 or return $finish->(undef, 598 => "Request cancelled by on_body");
254 # but we don't, due to misdesigns, this is annoyingly complex 754
755 $_[0]->push_read (line => sub {
756 length $_[1]
757 and return $finish->(undef, 599 => "Garbled chunked transfer encoding");
758 $_[0]->push_read (line => $read_chunk);
759 });
760 });
761 } else {
762 $hdr{"content-length"} ||= $cl;
763
764 $_[0]->push_read (line => $qr_nlnl, sub {
765 if (length $_[1]) {
766 for ("$_[1]") {
767 y/\015//d; # weed out any \015, as they show up in the weirdest of places.
768
769 my $hdr = parse_hdr
770 or return $finish->(undef, 599 => "Garbled response trailers");
771
772 %hdr = (%hdr, %$hdr);
773 }
774 }
775
776 $finish->($body, undef, undef, 1);
777 });
778 }
255 }; 779 };
256 780
781 $_[0]->push_read (line => $read_chunk);
782
783 } elsif ($arg{on_body}) {
784 $_[0]->on_error (sub { $finish->(undef, 599 => $_[2]) });
785
786 if ($len) {
787 $_[0]->on_read (sub {
788 $len -= length $_[0]{rbuf};
789
790 $arg{on_body}(delete $_[0]{rbuf}, \%hdr)
791 or return $finish->(undef, 598 => "Request cancelled by on_body");
792
793 $len > 0
794 or $finish->("", undef, undef, 1);
795 });
257 %state = (); 796 } else {
258 $cb->($_[1], \%hdr); 797 $_[0]->on_eof (sub {
798 $finish->("");
799 });
800 $_[0]->on_read (sub {
801 $arg{on_body}(delete $_[0]{rbuf}, \%hdr)
802 or $finish->(undef, 598 => "Request cancelled by on_body");
803 });
804 }
805 } else {
806 $_[0]->on_eof (undef);
807
808 if ($len) {
809 $_[0]->on_error (sub { $finish->(undef, 599 => $_[2]) });
810 $_[0]->on_read (sub {
811 $finish->((substr delete $_[0]{rbuf}, 0, $len, ""), undef, undef, 1)
812 if $len <= length $_[0]{rbuf};
813 });
814 } else {
815 $_[0]->on_error (sub {
816 ($! == Errno::EPIPE || !$!)
817 ? $finish->(delete $_[0]{rbuf})
818 : $finish->(undef, 599 => $_[2]);
819 });
820 $_[0]->on_read (sub { });
821 }
259 }); 822 }
823 }
824 };
825
826 $state{handle}->push_read (line => $qr_nlnl, $state{read_response});
827 };
828
829 # now handle proxy-CONNECT method
830 if ($proxy && $uscheme eq "https") {
831 # oh dear, we have to wrap it into a connect request
832
833 # maybe re-use $uauthority with patched port?
834 $state{handle}->push_write ("CONNECT $uhost:$uport HTTP/1.0\015\012Host: $uhost\015\012\015\012");
835 $state{handle}->push_read (line => $qr_nlnl, sub {
836 $_[1] =~ /^HTTP\/([0-9\.]+) \s+ ([0-9]{3}) (?: \s+ ([^\015\012]*) )?/ix
837 or return (%state = (), $cb->(undef, { @pseudo, Status => 599, Reason => "Invalid proxy connect response ($_[1])" }));
838
839 if ($2 == 200) {
840 $rpath = $upath;
841 &$handle_actual_request;
260 } else { 842 } 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 = (); 843 %state = ();
265 $cb->($_[0]{rbuf}, \%hdr); 844 $cb->(undef, { @pseudo, Status => $2, Reason => $3 });
266 });
267 $_[0]->on_eof (undef);
268 $_[0]->on_read (sub { });
269 } 845 }
270 } 846 });
847 } else {
848 &$handle_actual_request;
271 }); 849 }
272 }); 850 };
273 }, sub { 851
274 $timeout 852 my $tcp_connect = $arg{tcp_connect}
853 || do { require AnyEvent::Socket; \&AnyEvent::Socket::tcp_connect };
854
855 $state{connect_guard} = $tcp_connect->($rhost, $rport, $connect_cb, $arg{on_prepare} || sub { $timeout });
856
275 }; 857 };
276 858
277 defined wantarray && AnyEvent::Util::guard { %state = () } 859 defined wantarray && AnyEvent::Util::guard { %state = () }
278} 860}
279 861
280sub http_get($$;@) { 862sub http_get($@) {
281 unshift @_, "GET"; 863 unshift @_, "GET";
282 &http_request 864 &http_request
283} 865}
284 866
285sub http_head($$;@) { 867sub http_head($@) {
286 unshift @_, "HEAD"; 868 unshift @_, "HEAD";
287 &http_request 869 &http_request
288} 870}
289 871
290sub http_post($$$;@) { 872sub http_post($$@) {
873 my $url = shift;
291 unshift @_, "POST", "body"; 874 unshift @_, "POST", $url, "body";
292 &http_request 875 &http_request
293} 876}
294 877
878=back
879
880=head2 DNS CACHING
881
882AnyEvent::HTTP uses the AnyEvent::Socket::tcp_connect function for
883the actual connection, which in turn uses AnyEvent::DNS to resolve
884hostnames. The latter is a simple stub resolver and does no caching
885on its own. If you want DNS caching, you currently have to provide
886your own default resolver (by storing a suitable resolver object in
887C<$AnyEvent::DNS::RESOLVER>).
888
295=head2 GLOBAL FUNCTIONS AND VARIABLES 889=head2 GLOBAL FUNCTIONS AND VARIABLES
296 890
297=over 4 891=over 4
298 892
299=item AnyEvent::HTTP::set_proxy "proxy-url" 893=item AnyEvent::HTTP::set_proxy "proxy-url"
300 894
301Sets the default proxy server to use. The proxy-url must begin with a 895Sets the default proxy server to use. The proxy-url must begin with a
302string of the form C<http://host:port> (optionally C<https:...>). 896string of the form C<http://host:port> (optionally C<https:...>), croaks
897otherwise.
898
899To clear an already-set proxy, use C<undef>.
900
901=item $date = AnyEvent::HTTP::format_date $timestamp
902
903Takes a POSIX timestamp (seconds since the epoch) and formats it as a HTTP
904Date (RFC 2616).
905
906=item $timestamp = AnyEvent::HTTP::parse_date $date
907
908Takes a HTTP Date (RFC 2616) and returns the corresponding POSIX
909timestamp, or C<undef> if the date cannot be parsed.
303 910
304=item $AnyEvent::HTTP::MAX_RECURSE 911=item $AnyEvent::HTTP::MAX_RECURSE
305 912
306The default value for the C<recurse> request parameter (default: C<10>). 913The default value for the C<recurse> request parameter (default: C<10>).
307 914
308=item $AnyEvent::HTTP::USERAGENT 915=item $AnyEvent::HTTP::USERAGENT
309 916
310The default value for the C<User-Agent> header (the default is 917The default value for the C<User-Agent> header (the default is
311C<Mozilla/5.0 (compatible; AnyEvent::HTTP/$VERSION; +http://software.schmorp.de/pkg/AnyEvent)>). 918C<Mozilla/5.0 (compatible; U; AnyEvent-HTTP/$VERSION; +http://software.schmorp.de/pkg/AnyEvent)>).
312 919
313=item $AnyEvent::HTTP::MAX_PERSISTENT 920=item $AnyEvent::HTTP::MAX_PER_HOST
314 921
315The maximum number of persistent connections to keep open (default: 8). 922The maximum number of concurrent connections to the same host (identified
923by the hostname). If the limit is exceeded, then the additional requests
924are queued until previous connections are closed.
316 925
317Not implemented currently. 926The default value for this is C<4>, and it is highly advisable to not
927increase it.
318 928
319=item $AnyEvent::HTTP::PERSISTENT_TIMEOUT 929=item $AnyEvent::HTTP::ACTIVE
320 930
321The maximum time to cache a persistent connection, in seconds (default: 2). 931The number of active connections. This is not the number of currently
322 932running requests, but the number of currently open and non-idle TCP
323Not implemented currently. 933connections. This number of can be useful for load-leveling.
324 934
325=back 935=back
326 936
327=cut 937=cut
328 938
939our @month = qw(Jan Feb Mar Apr May Jun Jul Aug Sep Oct Nov Dec);
940our @weekday = qw(Sun Mon Tue Wed Thu Fri Sat);
941
942sub format_date($) {
943 my ($time) = @_;
944
945 # RFC 822/1123 format
946 my ($S, $M, $H, $mday, $mon, $year, $wday, $yday, undef) = gmtime $time;
947
948 sprintf "%s, %02d %s %04d %02d:%02d:%02d GMT",
949 $weekday[$wday], $mday, $month[$mon], $year + 1900,
950 $H, $M, $S;
951}
952
953sub parse_date($) {
954 my ($date) = @_;
955
956 my ($d, $m, $y, $H, $M, $S);
957
958 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$/) {
959 # RFC 822/1123, required by RFC 2616
960 ($d, $m, $y, $H, $M, $S) = ($1, $2, $3, $4, $5, $6);
961
962 } 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$/) {
963 # RFC 850
964 ($d, $m, $y, $H, $M, $S) = ($1, $2, $3 < 69 ? $3 + 2000 : $3 + 1900, $4, $5, $6);
965
966 } 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])$/) {
967 # ISO C's asctime
968 ($d, $m, $y, $H, $M, $S) = ($2, $1, $6, $3, $4, $5);
969 }
970 # other formats fail in the loop below
971
972 for (0..11) {
973 if ($m eq $month[$_]) {
974 require Time::Local;
975 return Time::Local::timegm ($S, $M, $H, $d, $_, $y);
976 }
977 }
978
979 undef
980}
981
329sub set_proxy($) { 982sub set_proxy($) {
983 if (length $_[0]) {
330 $PROXY = [$2, $3 || 3128, $1] if $_[0] =~ m%^(https?):// ([^:/]+) (?: : (\d*) )?%ix; 984 $_[0] =~ m%^(https?):// ([^:/]+) (?: : (\d*) )?%ix
985 or Carp::croak "$_[0]: invalid proxy URL";
986 $PROXY = [$2, $3 || 3128, $1]
987 } else {
988 undef $PROXY;
989 }
331} 990}
332 991
333# initialise proxy from environment 992# initialise proxy from environment
993eval {
334set_proxy $ENV{http_proxy}; 994 set_proxy $ENV{http_proxy};
995};
996
997=head2 SOCKS PROXIES
998
999Socks proxies are not directly supported by AnyEvent::HTTP. You can
1000compile your perl to support socks, or use an external program such as
1001F<socksify> (dante) or F<tsocks> to make your program use a socks proxy
1002transparently.
1003
1004Alternatively, for AnyEvent::HTTP only, you can use your own
1005C<tcp_connect> function that does the proxy handshake - here is an example
1006that works with socks4a proxies:
1007
1008 use Errno;
1009 use AnyEvent::Util;
1010 use AnyEvent::Socket;
1011 use AnyEvent::Handle;
1012
1013 # host, port and username of/for your socks4a proxy
1014 my $socks_host = "10.0.0.23";
1015 my $socks_port = 9050;
1016 my $socks_user = "";
1017
1018 sub socks4a_connect {
1019 my ($host, $port, $connect_cb, $prepare_cb) = @_;
1020
1021 my $hdl = new AnyEvent::Handle
1022 connect => [$socks_host, $socks_port],
1023 on_prepare => sub { $prepare_cb->($_[0]{fh}) },
1024 on_error => sub { $connect_cb->() },
1025 ;
1026
1027 $hdl->push_write (pack "CCnNZ*Z*", 4, 1, $port, 1, $socks_user, $host);
1028
1029 $hdl->push_read (chunk => 8, sub {
1030 my ($hdl, $chunk) = @_;
1031 my ($status, $port, $ipn) = unpack "xCna4", $chunk;
1032
1033 if ($status == 0x5a) {
1034 $connect_cb->($hdl->{fh}, (format_address $ipn) . ":$port");
1035 } else {
1036 $! = Errno::ENXIO; $connect_cb->();
1037 }
1038 });
1039
1040 $hdl
1041 }
1042
1043Use C<socks4a_connect> instead of C<tcp_connect> when doing C<http_request>s,
1044possibly after switching off other proxy types:
1045
1046 AnyEvent::HTTP::set_proxy undef; # usually you do not want other proxies
1047
1048 http_get 'http://www.google.com', tcp_connect => \&socks4a_connect, sub {
1049 my ($data, $headers) = @_;
1050 ...
1051 };
335 1052
336=head1 SEE ALSO 1053=head1 SEE ALSO
337 1054
338L<AnyEvent>. 1055L<AnyEvent>.
339 1056
340=head1 AUTHOR 1057=head1 AUTHOR
341 1058
342 Marc Lehmann <schmorp@schmorp.de> 1059 Marc Lehmann <schmorp@schmorp.de>
343 http://home.schmorp.de/ 1060 http://home.schmorp.de/
1061
1062With many thanks to Дмитрий Шалашов, who provided countless
1063testcases and bugreports.
344 1064
345=cut 1065=cut
346 1066
3471 10671
348 1068

Diff Legend

Removed lines
+ Added lines
< Changed lines
> Changed lines