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

Diff Legend

Removed lines
+ Added lines
< Changed lines
> Changed lines