1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 284 285 286 287 288 289 290 291 292 293 294 295 296 297 298 299 300 301 302 303 304 305 306 307 308 309 310 311 312 313 314 315 316 317 318 319 320 321 322 323 324 325 326 327 328 329 330 331 332 333 334 335 336 337 338 339 340 341 342 343 344 345 346 347 348 349 350 351 352 353 354 355 356 357 358 359 360 361 362 363 364 365 366 367 368 369 370 371 372 373 374 375 376 377 378 379 380 381 382 383 384 385 386 387 388 389 390 391 392 393 394 395 396 397 398 399 400 401 402 403 404 405 406 407 408 409 410 411 412 413 414 415 416 417 418 419 420 421 422 423 424 425 426 427 428 429 430 431 432 433 434 435 436 437 438 439 440 441 442 443 444 445 446 447 448 449 450 451 452 453 454 455 456 457 458 459 460 461 462 463 464 465 466 467 468 469 470 471 472 473 474 475 476 477 478 479 480 481 482 483 484 485 486 487 488 489 490 491 492 493 494 495 496 497 498 499 500 501 502 503 504 505 506 507 508 509 510 511 512 513 514 515 516 517 518 519 520 521 522 523 524 525 526 527 528 529 530 531 532 533 534 535 536 537 538 539 540 541 542 543 544 545 546 547 548 549 550 551 552 553 554 555 556 557 558 559 560 561 562 563 564 565 566 567 568 569 570 571 572 573 574 575 576 577 578 579 580 581 582 583 584 585 586 587 588 589 590 591 592 593 594 595 596 597 598 599 600 601 602 603 604 605 606 607 608 609 610 611 612 613 614 615 616 617 618 619 620 621 622 623 624 625 626 627 628 629 630 631 632 633 634 635 636 637 638 639 640 641 642 643 644 645 646 647 648 649 650 651 652 653
|
# Copyright (C) 2008-2010, Sebastian Riedel.
package Mojo::Transaction::HTTP;
use strict;
use warnings;
use base 'Mojo::Transaction';
use Mojo::Message::Request;
use Mojo::Message::Response;
__PACKAGE__->attr([qw/continue_handler_cb continued handler_cb upgrade_cb/]);
__PACKAGE__->attr(continue_timeout => 5);
__PACKAGE__->attr(req => sub { Mojo::Message::Request->new });
__PACKAGE__->attr(res => sub { Mojo::Message::Response->new });
# What's a wedding? Webster's dictionary describes it as the act of removing
# weeds from one's garden.
sub client_leftovers {
my $self = shift;
# No leftovers
return unless $self->is_state('done_with_leftovers');
# Leftovers
my $leftovers = $self->res->leftovers;
$self->done;
return $leftovers;
}
sub client_read {
my ($self, $chunk) = @_;
# Request and response
my $req = $self->req;
my $res = $self->res;
# Length
my $read = length $chunk;
# Read 100 Continue
if ($self->is_state('read_continue')) {
$res->done if $read == 0;
$res->parse($chunk);
# We got a 100 Continue response
my $done = $res->is_state(qw/done done_with_leftovers/);
if ($done && $res->code == 100) {
$self->_new_response;
$self->continued(1);
$self->{_continue} = 0;
}
# We got something else
elsif ($res->is_finished) {
$self->continued(0);
$self->done;
}
}
# Read response
else {
$self->done if $read == 0;
# HEAD response
if ($req->method eq 'HEAD') {
$res->parse_until_body($chunk);
while ($res->content->is_state('body')) {
# Check for unexpected 1XX
if ($res->is_status_class(100)) { $self->_new_response(1) }
# Leftovers
elsif ($res->has_leftovers) {
$res->state('done_with_leftovers');
$self->state('done_with_leftovers');
last;
}
# Done
else { $self->done and last }
}
}
# Normal response
else {
# Parse
$res->parse($chunk);
# Finished
while ($res->is_finished) {
# Check for unexpected 100
if (($res->code || '') eq '100') { $self->_new_response }
else {
# Inherit state
$self->state($res->state);
$self->error($res->error) if $res->has_error;
last;
}
}
}
}
# Check for request/response errors
$self->error($req->error) if $req->has_error;
$self->error($res->error) if $res->has_error;
# Make sure we don't wait longer than the set time for a 100 Continue
# (defaults to 5 seconds)
if ($self->{_continue}) {
my $continue = $self->{_continue};
my $started = $self->{_started} ||= time;
$continue = $self->continue_timeout - (time - $started);
$continue = 0 if $continue < 0;
$self->{_continue} = $continue;
}
# 100 Continue timeout
if ($self->is_state('read_continue')) {
$self->state('write_body') unless $self->{_continue};
}
return $self;
}
sub client_write {
my $self = shift;
# Chunk
my $chunk = '';
# Offsets
my $offset = $self->{_offset} ||= 0;
my $write = $self->{_write} ||= 0;
# Request
my $req = $self->req;
# Writing
my $state = $self->state;
if ($state eq 'start') {
# Connection header
my $headers = $req->headers;
unless ($headers->connection) {
if ($self->keep_alive || $self->kept_alive) {
$headers->connection('Keep-Alive');
}
else { $headers->connection('Close') }
}
# We might have to handle 100 Continue
$self->{_continue} = $self->continue_timeout
if ($req->headers->expect || '') =~ /100-continue/;
# Ready for next state
$state = 'write_start_line';
$write = $req->start_line_size;
}
# Start line
if ($state eq 'write_start_line') {
my $buffer = $req->get_start_line_chunk($offset);
# Written
my $written = defined $buffer ? length $buffer : 0;
$write = $write - $written;
$offset = $offset + $written;
$chunk .= $buffer;
# Done
if ($write <= 0) {
$state = 'write_headers';
$offset = 0;
$write = $req->header_size;
}
}
# Headers
if ($state eq 'write_headers') {
my $buffer = $req->get_header_chunk($offset);
# Written
my $written = defined $buffer ? length $buffer : 0;
$write = $write - $written;
$offset = $offset + $written;
$chunk .= $buffer;
# Done
if ($write <= 0) {
$state = $self->{_continue} ? 'read_continue' : 'write_body';
$offset = 0;
$write = $req->body_size;
# Chunked
$write = 1 if $req->is_chunked;
}
}
# Body
if ($state eq 'write_body') {
my $buffer = $req->get_body_chunk($offset);
# Written
my $written = defined $buffer ? length $buffer : 0;
$write = $write - $written;
$offset = $offset + $written;
$chunk .= $buffer;
# End
$state = 'read_response' if defined $buffer && !length $buffer;
# Chunked
$write = 1 if $req->is_chunked;
# Done
$state = 'read_response' if $write <= 0;
}
$self->state($state);
# Offsets
$self->{_offset} = $offset;
$self->{_write} = $write;
return $chunk;
}
sub keep_alive {
my ($self, $keep_alive) = @_;
# Custom
if ($keep_alive) {
$self->{keep_alive} = $keep_alive;
return $self;
}
# Request and response
my $req = $self->req;
my $res = $self->res;
# No keep alive for 0.9 and 1.0
my $version = $req->version;
$self->{keep_alive} ||= 0 if $req->version eq '0.9' || $version eq '1.0';
$version = $res->version;
$self->{keep_alive} ||= 0 if $version eq '0.9' || $version eq '1.0';
# Connection headers
my $reqc = $req->headers->connection || '';
my $resc = $res->headers->connection || '';
# Keep alive
$self->{keep_alive} = 1
if $reqc =~ /^keep-alive$/i || $resc =~ /^keep-alive$/i;
# Close
$self->{keep_alive} = 0 if $reqc =~ /^close$/i || $resc =~ /^close$/i;
# Default
$self->{keep_alive} = 1 unless defined $self->{keep_alive};
return $self->{keep_alive};
}
sub server_leftovers {
my $self = shift;
# Request
my $req = $self->req;
# No leftovers
return unless $req->is_state('done_with_leftovers');
# Leftovers
my $leftovers = $req->leftovers;
# Done
$req->done;
return $leftovers;
}
sub server_read {
my ($self, $chunk) = @_;
# Request and response
my $req = $self->req;
my $res = $self->res;
# Parse
$req->parse($chunk) unless $req->has_error;
# Parser error
my $handled = $self->{_handled};
if ($req->has_error && !$handled) {
# Write
$self->state('write');
# Handler callback
$self->handler_cb->($self);
# Close connection
$res->headers->connection('Close');
# Protect handler from incoming pipelined requests
$self->{_handled} = 1;
}
# EOF
elsif ((length $chunk == 0) || ($req->is_finished && !$handled)) {
# Writing
$self->state('write');
# Upgrade callback
my $ws;
$ws = $self->upgrade_cb->($self) if $req->headers->upgrade;
# Handler callback
$self->handler_cb->($ws ? ($ws, $self) : $self);
# Protect handler from incoming pipelined requests
$self->{_handled} = 1;
}
# Expect 100 Continue
elsif ($req->content->is_state('body') && !defined $self->continued) {
if (($req->headers->expect || '') =~ /100-continue/i) {
# Writing
$self->state('write');
# Continue handler callback
$self->continue_handler_cb->($self);
$self->continued(0);
}
}
return $self;
}
sub server_write {
my $self = shift;
# Chunk
my $chunk = '';
# Offsets
my $offset = $self->{_offset} ||= 0;
my $write = $self->{_write} ||= 0;
# Request and response
my $req = $self->req;
my $res = $self->res;
# Writing
my $state = $self->state;
if ($state eq 'write') {
# Connection header
my $headers = $res->headers;
unless ($headers->connection) {
if ($self->keep_alive) { $headers->connection('Keep-Alive') }
else { $headers->connection('Close') }
}
# Ready for next state
$state = 'write_start_line';
$write = $res->start_line_size;
}
# Start line
if ($state eq 'write_start_line') {
my $buffer = $res->get_start_line_chunk($offset);
# Written
my $written = defined $buffer ? length $buffer : 0;
$write = $write - $written;
$offset = $offset + $written;
# Append
$chunk .= $buffer;
# Done
if ($write <= 0) {
$state = 'write_headers';
$offset = 0;
$write = $res->header_size;
}
}
# Headers
if ($state eq 'write_headers') {
my $buffer = $res->get_header_chunk($offset);
# Written
my $written = defined $buffer ? length $buffer : 0;
$write = $write - $written;
$offset = $offset + $written;
# Append
$chunk .= $buffer;
# Done
if ($write <= 0) {
# HEAD request
if ($req->method eq 'HEAD') {
# Don't send body if request method is HEAD
$state =
$req->is_state('done_with_leftovers')
? 'done_with_leftovers'
: 'done';
}
# Body
else {
$state = 'write_body';
$offset = 0;
$write = $res->body_size;
# Chunked
$write = 1 if $res->is_chunked;
}
}
}
# Body
if ($state eq 'write_body') {
# 100 Continue
if ($write <= 0) {
# Continue done
if (defined $self->continued && $self->continued == 0) {
$self->continued(1);
$state = 'read';
# Continue
if ($res->code == 100) { $self->res($res->new) }
# Don't continue
else { $state = 'done' }
}
# Everything done
elsif (!defined $self->continued) {
$state =
$req->is_state('done_with_leftovers')
? 'done_with_leftovers'
: 'done';
}
}
# Normal body
else {
my $buffer = $res->get_body_chunk($offset);
# Written
my $written = defined $buffer ? length $buffer : 0;
$write = $write - $written;
$offset = $offset + $written;
# Append
$chunk .= $buffer;
# Chunked
$write = 1 if $res->is_chunked;
# Done
$state =
$req->is_state('done_with_leftovers')
? 'done_with_leftovers'
: 'done'
if $write <= 0 || (defined $buffer && !length $buffer);
}
}
$self->state($state);
# Offsets
$self->{_offset} = $offset;
$self->{_write} = $write;
return $chunk;
}
# Replace client response after receiving 100 Continue
sub _new_response {
my $self = shift;
# 1 is special case for HEAD
my $until_body = @_ ? shift : 0;
my $res = $self->res;
my $new = $res->new;
# Check for leftovers in old response
if ($res->has_leftovers) {
$until_body
? $new->parse_until_body($res->leftovers)
: $new->parse($res->leftovers);
$new->is_finished
? $self->state($new->state)
: $self->state('read_response');
}
$self->res($new);
}
1;
__END__
=head1 NAME
Mojo::Transaction::HTTP - HTTP 1.1 Transaction Container
=head1 SYNOPSIS
use Mojo::Transaction::HTTP;
my $tx = Mojo::Transaction::HTTP->new;
my $req = $tx->req;
my $res = $tx->res;
my $keep_alive = $tx->keep_alive;
=head1 DESCRIPTION
L<Mojo::Transaction::HTTP> is a container and state machine for HTTP 1.1
transactions as described in RFC 2616.
=head1 ATTRIBUTES
L<Mojo::Transaction::HTTP> inherits all attributes from L<Mojo::Transaction>
and implements the following new ones.
=head2 C<continue_handler_cb>
my $cb = $tx->continue_handler_cb;
$tx = $tx->continue_handler_cb(sub {...});
Callback to handle C<100 Continue> requests.
=head2 C<continue_timeout>
my $timeout = $tx->continue_timeout;
$tx = $tx->continue_timeout(3);
Timeout for C<100 Continue> requests.
=head2 C<continued>
my $continued = $tx->continued;
$tx = $tx->continued(1);
Transaction was continued.
=head2 C<handler_cb>
my $cb = $tx->handler_cb;
$tx = $tx->handler_cb(sub {...});
Handler callback.
=head2 C<keep_alive>
my $keep_alive = $tx->keep_alive;
$tx = $tx->keep_alive(1);
Connection can be kept alive.
=head2 C<req>
my $req = $tx->req;
$tx = $tx->req(Mojo::Message::Request->new);
HTTP 1.1 request.
=head2 C<res>
my $res = $tx->res;
$tx = $tx->res(Mojo::Message::Response->new);
HTTP 1.1 response.
=head2 C<upgrade_cb>
my $cb = $tx->upgrade_cb;
$tx = $tx->upgrade_cb(sub {...});
WebSocket upgrade callback.
=head1 METHODS
L<Mojo::Transaction::HTTP> inherits all methods from L<Mojo::Transaction> and
implements the following new ones.
=head2 C<client_leftovers>
my $leftovers = $tx->client_leftovers;
Leftovers from the client response, used for pipelining.
=head2 C<client_read>
$tx = $tx->client_read($chunk);
Read and process client data.
=head2 C<client_write>
my $chunk = $tx->client_write;
Write client data.
=head2 C<server_leftovers>
my $leftovers = $tx->server_leftovers;
Leftovers from the server request, used for pipelining.
=head2 C<server_read>
$tx = $tx->server_read($chunk);
Read and process server data.
=head2 C<server_write>
my $chunk = $tx->server_write;
Write server data.
=head1 SEE ALSO
L<Mojolicious>, L<Mojolicious::Guides>, L<http://mojolicious.org>.
=cut
|