/usr/share/perl5/Mojo/Content.pm is in libmojolicious-perl 2.98+dfsg-2.
This file is owned by root:root, with mode 0o644.
The actual contents of the file can be viewed below.
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 | package Mojo::Content;
use Mojo::Base 'Mojo::EventEmitter';
use Carp 'croak';
use Mojo::Headers;
has [qw(auto_relax relaxed)] => 0;
has headers => sub { Mojo::Headers->new };
has max_leftover_size => sub { $ENV{MOJO_MAX_LEFTOVER_SIZE} || 262144 };
sub body_contains {
croak 'Method "body_contains" not implemented by subclass';
}
sub body_size { croak 'Method "body_size" not implemented by subclass' }
sub boundary {
(shift->headers->content_type || '')
=~ m!multipart.*boundary="*([a-zA-Z0-9'(),.:?\-_+/]+)!i
and return $1;
return;
}
# "Operator! Give me the number for 911!"
sub build_body { shift->_build('body') }
sub build_headers { shift->_build('header') }
sub charset {
(shift->headers->content_type || '') =~ /charset="?([^"\s;]+)"?/i
and return $1;
return;
}
sub clone {
my $self = shift;
return if $self->is_dynamic;
return $self->new(headers => $self->headers->clone);
}
sub generate_body_chunk {
my ($self, $offset) = @_;
# Drain
$self->emit(drain => $offset)
if !delete $self->{delay} && !length $self->{body_buffer};
# Get chunk
my $chunk = $self->{body_buffer} // '';
$self->{body_buffer} = '';
# EOF or delay
return $self->{eof} ? '' : undef unless length $chunk;
return $chunk;
}
sub get_body_chunk {
croak 'Method "get_body_chunk" not implemented by subclass';
}
sub get_header_chunk {
my ($self, $offset) = @_;
unless (defined $self->{header_buffer}) {
my $headers = $self->headers->to_string;
$self->{header_buffer}
= $headers ? "$headers\x0d\x0a\x0d\x0a" : "\x0d\x0a";
}
return substr $self->{header_buffer}, $offset,
$ENV{MOJO_CHUNK_SIZE} || 131072;
}
sub has_leftovers { length(shift->{buffer} || '') }
sub header_size { length shift->build_headers }
sub is_chunked { (shift->headers->transfer_encoding || '') =~ /chunked/i }
sub is_dynamic {
my $self = shift;
return $self->{dynamic} && !defined $self->headers->content_length;
}
sub is_finished { (shift->{state} || '') eq 'finished' }
sub is_multipart {undef}
sub is_parsing_body { (shift->{state} || '') eq 'body' }
sub leftovers { shift->{buffer} }
sub parse {
my $self = shift;
# Parse headers
$self->parse_until_body(@_);
return $self if $self->{state} eq 'headers';
$self->_body;
# Relaxed parsing for wonky web servers
if ($self->auto_relax) {
my $headers = $self->headers;
my $connection = $headers->connection || '';
my $len = $headers->content_length // '';
$self->relaxed(1)
if !length $len && ($connection =~ /close/i || $headers->content_type);
}
# Parse chunked content
$self->{real_size} = 0 unless exists $self->{real_size};
if ($self->is_chunked && ($self->{state} || '') ne 'headers') {
$self->_parse_chunked;
$self->{state} = 'finished' if ($self->{chunked} || '') eq 'finished';
}
# Not chunked, pass through to second buffer
else {
$self->{real_size} += length $self->{pre_buffer};
$self->{buffer} .= $self->{pre_buffer}
unless $self->is_finished
&& length($self->{buffer}) > $self->max_leftover_size;
$self->{pre_buffer} = '';
}
# Chunked or relaxed content
if ($self->is_chunked || $self->relaxed) {
$self->{size} += length($self->{buffer} //= '');
$self->emit(read => $self->{buffer})->{buffer} = '';
}
# Normal content
else {
my $len = $self->headers->content_length || 0;
$self->{size} ||= 0;
my $need = $len - $self->{size};
# Slurp
if ($need > 0) {
my $chunk = substr $self->{buffer}, 0, $need, '';
$self->{size} += length $chunk;
$self->emit(read => $chunk);
}
# Finished
$self->{state} = 'finished' if $len <= $self->progress;
}
return $self;
}
sub parse_body {
my $self = shift;
$self->{state} = 'body';
return $self->parse(@_);
}
sub parse_body_once {
my $self = shift;
$self->parse_body(@_);
$self->{state} = 'finished';
return $self;
}
sub parse_until_body {
my ($self, $chunk) = @_;
# Prepare first buffer
$self->{pre_buffer} //= '';
$self->{raw_size} //= 0;
# Add chunk
if (defined $chunk) {
$self->{raw_size} += length $chunk;
$self->{pre_buffer} .= $chunk;
}
# Parser started
unless ($self->{state}) {
# Update size
$self->{header_size} = $self->{raw_size} - length $self->{pre_buffer};
# Headers
$self->{state} = 'headers';
}
# Parse headers
$self->_parse_headers if ($self->{state} || '') eq 'headers';
return $self;
}
sub progress {
my $self = shift;
return 0 unless ($self->{state} || '') ~~ [qw(body finished)];
return $self->{raw_size} - ($self->{header_size} || 0);
}
sub write {
my ($self, $chunk, $cb) = @_;
# Dynamic content
$self->{dynamic} = 1;
# Add chunk
if (defined $chunk) { $self->{body_buffer} .= $chunk }
# Delay
else { $self->{delay} = 1 }
# Drain
$self->once(drain => $cb) if $cb;
# Finish
$self->{eof} = 1 if defined $chunk && $chunk eq '';
}
# "Here's to alcohol, the cause of-and solution to-all life's problems."
sub write_chunk {
my ($self, $chunk, $cb) = @_;
# Chunked transfer encoding
$self->headers->transfer_encoding('chunked') unless $self->is_chunked;
# Write
$self->write(defined $chunk ? $self->_build_chunk($chunk) : $chunk, $cb);
# Finish
$self->{eof} = 1 if defined $chunk && $chunk eq '';
}
sub _body {
my $self = shift;
$self->emit('body') unless $self->{body}++;
}
sub _build {
my ($self, $part) = @_;
# Build part from chunks
my $method = "get_${part}_chunk";
my $buffer = '';
my $offset = 0;
while (1) {
my $chunk = $self->$method($offset);
# No chunk yet, try again
next unless defined $chunk;
# End of part
last unless length $chunk;
# Part
$offset += length $chunk;
$buffer .= $chunk;
}
return $buffer;
}
sub _build_chunk {
my ($self, $chunk) = @_;
# End
my $formatted = '';
if (length $chunk == 0) { $formatted = "\x0d\x0a0\x0d\x0a\x0d\x0a" }
# Separator
else {
# First chunk has no leading CRLF
$formatted = "\x0d\x0a" if $self->{chunks};
$self->{chunks} = 1;
# Chunk
$formatted .= sprintf('%x', length $chunk) . "\x0d\x0a$chunk";
}
return $formatted;
}
sub _parse_chunked {
my $self = shift;
# Trailing headers
return $self->_parse_chunked_trailing_headers
if ($self->{chunked} || '') eq 'trailing_headers';
# New chunk (ignore the chunk extension)
while ($self->{pre_buffer} =~ /^((?:\x0d?\x0a)?([\da-fA-F]+).*\x0d?\x0a)/) {
my $header = $1;
my $len = hex($2);
# Whole chunk
if (length($self->{pre_buffer}) >= (length($header) + $len)) {
# Remove header
substr $self->{pre_buffer}, 0, length $header, '';
# Last chunk
if ($len == 0) {
$self->{chunked} = 'trailing_headers';
last;
}
# Remove payload
$self->{real_size} += $len;
$self->{buffer} .= substr $self->{pre_buffer}, 0, $len, '';
# Remove newline at end of chunk
$self->{pre_buffer} =~ s/^(\x0d?\x0a)//;
}
# Not a whole chunk, wait for more data
else {last}
}
# Trailing headers
$self->_parse_chunked_trailing_headers
if ($self->{chunked} || '') eq 'trailing_headers';
}
sub _parse_chunked_trailing_headers {
my $self = shift;
# Parse
my $headers = $self->headers;
$headers->parse($self->{pre_buffer});
$self->{pre_buffer} = '';
# Finished
if ($headers->is_finished) {
# Remove Transfer-Encoding
my $headers = $self->headers;
my $encoding = $headers->transfer_encoding;
$encoding =~ s/,?\s*chunked//ig;
$encoding
? $headers->transfer_encoding($encoding)
: $headers->remove('Transfer-Encoding');
$headers->content_length($self->{real_size});
$self->{chunked} = 'finished';
}
}
sub _parse_headers {
my $self = shift;
# Parse
my $headers = $self->headers;
$headers->parse($self->{pre_buffer});
$self->{pre_buffer} = '';
# Finished
if ($headers->is_finished) {
my $leftovers = $headers->leftovers;
$self->{header_size} = $self->{raw_size} - length $leftovers;
$self->{pre_buffer} = $leftovers;
$self->{state} = 'body';
$self->_body;
}
}
1;
=head1 NAME
Mojo::Content - HTTP 1.1 content base class
=head1 SYNOPSIS
use Mojo::Base 'Mojo::Content';
=head1 DESCRIPTION
L<Mojo::Content> is an abstract base class for HTTP 1.1 content as described
in RFC 2616.
=head1 EVENTS
L<Mojo::Content> can emit the following events.
=head2 C<drain>
$content->on(drain => sub {
my ($content, $offset) = @_;
...
});
Emitted once all data has been written.
$content->on(drain => sub {
my $content = shift;
$content->write_chunk(time);
});
=head2 C<body>
$content->on(body => sub {
my $content = shift;
...
});
Emitted once all headers have been parsed and the body starts.
$content->on(body => sub {
my $content = shift;
$content->auto_upgrade(0) if $content->headers->header('X-No-MultiPart');
});
=head2 C<read>
$content->on(read => sub {
my ($content, $chunk) = @_;
...
});
Emitted when a new chunk of content arrives.
$content->unsubscribe('read');
$content->on(read => sub {
my ($content, $chunk) = @_;
say "Streaming: $chunk";
});
=head1 ATTRIBUTES
L<Mojo::Content> implements the following attributes.
=head2 C<auto_relax>
my $relax = $content->auto_relax;
$content = $content->auto_relax(1);
Try to detect broken web servers and turn on relaxed parsing automatically.
=head2 C<headers>
my $headers = $content->headers;
$content = $content->headers(Mojo::Headers->new);
Content headers, defaults to a L<Mojo::Headers> object.
=head2 C<max_leftover_size>
my $size = $content->max_leftover_size;
$content = $content->max_leftover_size(1024);
Maximum size in bytes of buffer for pipelined HTTP requests, defaults to the
value of the C<MOJO_MAX_LEFTOVER_SIZE> environment variable or C<262144>.
=head2 C<relaxed>
my $relaxed = $content->relaxed;
$content = $content->relaxed(1);
Activate relaxed parsing for HTTP 0.9 and responses that are terminated with a
connection close.
=head1 METHODS
L<Mojo::Content> inherits all methods from L<Mojo::EventEmitter> and
implements the following new ones.
=head2 C<body_contains>
my $success = $content->body_contains('foo bar baz');
Check if content contains a specific string. Meant to be overloaded in a
subclass.
=head2 C<body_size>
my $size = $content->body_size;
Content size in bytes. Meant to be overloaded in a subclass.
=head2 C<boundary>
my $boundary = $content->boundary;
Extract multipart boundary from C<Content-Type> header.
=head2 C<build_body>
my $string = $content->build_body;
Render whole body.
=head2 C<build_headers>
my $string = $content->build_headers;
Render all headers.
=head2 C<charset>
my $charset = $content->charset;
Extract charset from C<Content-Type> header.
=head2 C<clone>
my $clone = $content->clone;
Clone content if possible, otherwise return C<undef>.
=head2 C<generate_body_chunk>
my $chunk = $content->generate_body_chunk(0);
Generate dynamic content.
=head2 C<get_body_chunk>
my $chunk = $content->get_body_chunk(0);
Get a chunk of content starting from a specfic position. Meant to be
overloaded in a subclass.
=head2 C<get_header_chunk>
my $chunk = $content->get_header_chunk(13);
Get a chunk of the headers starting from a specfic position.
=head2 C<has_leftovers>
my $success = $content->has_leftovers;
Check if there are leftovers.
=head2 C<header_size>
my $size = $content->header_size;
Size of headers in bytes.
=head2 C<is_chunked>
my $success = $content->is_chunked;
Check if content is chunked.
=head2 C<is_dynamic>
my $success = $content->is_dynamic;
Check if content will be dynamically generated, which prevents C<clone> from
working.
=head2 C<is_finished>
my $success = $content->is_finished;
Check if parser is finished.
=head2 C<is_multipart>
my $false = $content->is_multipart;
False.
=head2 C<is_parsing_body>
my $success = $content->is_parsing_body;
Check if body parsing started yet.
=head2 C<leftovers>
my $bytes = $content->leftovers;
Get leftover data from content parser.
=head2 C<parse>
$content = $content->parse("Content-Length: 12\r\n\r\nHello World!");
Parse content chunk.
=head2 C<parse_body>
$content = $content->parse_body("Hi!");
Parse body chunk.
=head2 C<parse_body_once>
$content = $content->parse_body_once("Hi!");
Parse body chunk once.
=head2 C<parse_until_body>
$content
= $content->parse_until_body("Content-Length: 12\r\n\r\nHello World!");
Parse chunk and stop after headers.
=head2 C<progress>
my $size = $content->progress;
Size of content already received from message in bytes.
=head2 C<write>
$content->write('Hello!');
$content->write('Hello!', sub {...});
Write dynamic content non-blocking, the optional drain callback will be
invoked once all data has been written.
=head2 C<write_chunk>
$content->write_chunk('Hello!');
$content->write_chunk('Hello!', sub {...});
Write dynamic content non-blocking with C<chunked> transfer encoding, the
optional drain callback will be invoked once all data has been written.
=head1 SEE ALSO
L<Mojolicious>, L<Mojolicious::Guides>, L<http://mojolicio.us>.
=cut
|