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.20 by root, Mon Jun 9 13:04:23 2008 UTC vs.
Revision 1.53 by root, Sat Dec 5 15:37:07 2009 UTC

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

Diff Legend

Removed lines
+ Added lines
< Changed lines
> Changed lines