/usr/share/perl5/Mojo/Headers.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 | package Mojo::Headers;
use Mojo::Base -base;
use Mojo::Util 'get_line';
has max_line_size => sub { $ENV{MOJO_MAX_LINE_SIZE} || 10240 };
# Common headers
my @HEADERS = (
qw(Accept Accept-Language Accept-Ranges Authorization Connection),
qw(Cache-Control Content-Disposition Content-Length Content-Range),
qw(Content-Transfer-Encoding Content-Type Cookie DNT Date ETag Expect),
qw(Expires Host If-Modified-Since Last-Modified Location),
qw(Proxy-Authenticate Proxy-Authorization Range Sec-WebSocket-Accept),
qw(Sec-WebSocket-Key Sec-WebSocket-Origin Sec-WebSocket-Protocol),
qw(Sec-WebSocket-Version Server Set-Cookie Status Trailer),
qw(Transfer-Encoding Upgrade User-Agent WWW-Authenticate)
);
{
no strict 'refs';
for my $header (@HEADERS) {
my $name = lc $header;
$name =~ s/-/_/g;
*{__PACKAGE__ . "::$name"} = sub { scalar shift->header($header => @_) };
}
}
# Lower case headers
my %NORMALCASE = map { lc($_) => $_ } @HEADERS;
sub add {
my ($self, $name) = (shift, shift);
# Make sure we have a normal case entry for name
my $lcname = lc $name;
$NORMALCASE{$lcname} //= $name;
# Add lines
push @{$self->{headers}{$lcname}}, map { ref $_ eq 'ARRAY' ? $_ : [$_] } @_;
return $self;
}
sub clone {
my $self = shift;
my $clone = $self->new;
$clone->{headers}{$_} = [@{$self->{headers}{$_}}]
for keys %{$self->{headers}};
return $clone;
}
sub from_hash {
my ($self, $hash) = (shift, shift);
# Empty hash deletes all headers
delete $self->{headers} if keys %{$hash} == 0;
# Merge
while (my ($header, $value) = each %$hash) {
$self->add($header => ref $value eq 'ARRAY' ? @$value : $value);
}
return $self;
}
# "Will you be my mommy? You smell like dead bunnies..."
sub header {
my ($self, $name) = (shift, shift);
# Replace
return $self->remove($name)->add($name, @_) if @_;
# String
return unless my $headers = $self->{headers}{lc $name};
return join ', ', map { join ', ', @$_ } @$headers unless wantarray;
# Array
return @$headers;
}
sub is_finished { (shift->{state} || '') eq 'finished' }
sub is_limit_exceeded { shift->{limit} }
sub leftovers { delete shift->{buffer} }
sub names {
[map { $NORMALCASE{$_} || $_ } keys %{shift->{headers}}];
}
sub parse {
my ($self, $chunk) = @_;
# Parse headers with size limit
$self->{state} = 'headers';
$self->{buffer} //= '';
$self->{buffer} .= $chunk if defined $chunk;
my $headers = $self->{cache} ||= [];
my $max = $self->max_line_size;
while (defined(my $line = get_line \$self->{buffer})) {
# Check line size limit
if (length $line > $max) {
$self->{limit} = $self->{state} = 'finished';
return $self;
}
# New header
if ($line =~ /^(\S+)\s*:\s*(.*)$/) { push @$headers, $1, $2 }
# Multiline
elsif (@$headers && $line =~ s/^\s+//) { $headers->[-1] .= " $line" }
# Empty line
else {
$self->add(splice @$headers, 0, 2) while @$headers;
$self->{state} = 'finished';
return $self;
}
}
# Check line size limit
$self->{limit} = $self->{state} = 'finished'
if length $self->{buffer} > $max;
return $self;
}
sub referrer { scalar shift->header(Referer => @_) }
sub remove {
my ($self, $name) = @_;
delete $self->{headers}{lc $name};
return $self;
}
sub to_hash {
my ($self, $multi) = @_;
# Build
my %hash;
for my $header (@{$self->names}) {
my @headers = $self->header($header);
# Multi line
if ($multi) { $hash{$header} = [@headers] }
# Flat
else {
# Turn single value arrays into strings
@$_ == 1 and $_ = $_->[0] for @headers;
$hash{$header} = @headers > 1 ? [@headers] : $headers[0];
}
}
return \%hash;
}
sub to_string {
my $self = shift;
# Format multiline values
my @headers;
for my $name (@{$self->names}) {
push @headers, "$name: " . join("\x0d\x0a ", @$_) for $self->header($name);
}
# Format headers
return join "\x0d\x0a", @headers;
}
1;
=head1 NAME
Mojo::Headers - Headers
=head1 SYNOPSIS
use Mojo::Headers;
my $headers = Mojo::Headers->new;
$headers->content_type('text/plain');
$headers->parse("Content-Type: text/html\n\n");
=head1 DESCRIPTION
L<Mojo::Headers> is a container and parser for HTTP headers.
=head1 ATTRIBUTES
L<Mojo::Headers> implements the following attributes.
=head2 C<max_line_size>
my $size = $headers->max_line_size;
$headers = $headers->max_line_size(1024);
Maximum line size in bytes, defaults to the value of the
C<MOJO_MAX_LINE_SIZE> environment variable or C<10240>.
=head1 METHODS
L<Mojo::Headers> inherits all methods from L<Mojo::Base> and implements the
following new ones.
=head2 C<accept>
my $accept = $headers->accept;
$headers = $headers->accept('application/json');
Shortcut for the C<Accept> header.
=head2 C<accept_language>
my $accept_language = $headers->accept_language;
$headers = $headers->accept_language('de, en');
Shortcut for the C<Accept-Language> header.
=head2 C<accept_ranges>
my $ranges = $headers->accept_ranges;
$headers = $headers->accept_ranges('bytes');
Shortcut for the C<Accept-Ranges> header.
=head2 C<add>
$headers = $headers->add('Content-Type', 'text/plain');
Add one or more header lines.
=head2 C<authorization>
my $authorization = $headers->authorization;
$headers = $headers->authorization('Basic Zm9vOmJhcg==');
Shortcut for the C<Authorization> header.
=head2 C<cache_control>
my $cache_control = $headers->cache_control;
$headers = $headers->cache_control('max-age=1, no-cache');
Shortcut for the C<Cache-Control> header.
=head2 C<clone>
my $clone = $headers->clone;
Clone headers.
=head2 C<connection>
my $connection = $headers->connection;
$headers = $headers->connection('close');
Shortcut for the C<Connection> header.
=head2 C<content_disposition>
my $content_disposition = $headers->content_disposition;
$headers = $headers->content_disposition('foo');
Shortcut for the C<Content-Disposition> header.
=head2 C<content_length>
my $content_length = $headers->content_length;
$headers = $headers->content_length(4000);
Shortcut for the C<Content-Length> header.
=head2 C<content_range>
my $range = $headers->content_range;
$headers = $headers->content_range('bytes 2-8/100');
Shortcut for the C<Content-Range> header.
=head2 C<content_transfer_encoding>
my $encoding = $headers->content_transfer_encoding;
$headers = $headers->content_transfer_encoding('foo');
Shortcut for the C<Content-Transfer-Encoding> header.
=head2 C<content_type>
my $content_type = $headers->content_type;
$headers = $headers->content_type('text/plain');
Shortcut for the C<Content-Type> header.
=head2 C<cookie>
my $cookie = $headers->cookie;
$headers = $headers->cookie('f=b');
Shortcut for the C<Cookie> header.
=head2 C<date>
my $date = $headers->date;
$headers = $headers->date('Sun, 17 Aug 2008 16:27:35 GMT');
Shortcut for the C<Date> header.
=head2 C<dnt>
my $dnt = $headers->dnt;
$headers = $headers->dnt(1);
Shortcut for the C<DNT> (Do Not Track) header.
=head2 C<etag>
my $etag = $headers->etag;
$headers = $headers->etag('abc321');
Shortcut for the C<ETag> header.
=head2 C<expect>
my $expect = $headers->expect;
$headers = $headers->expect('100-continue');
Shortcut for the C<Expect> header.
=head2 C<expires>
my $expires = $headers->expires;
$headers = $headers->expires('Thu, 01 Dec 1994 16:00:00 GMT');
Shortcut for the C<Expires> header.
=head2 C<from_hash>
$headers = $headers->from_hash({'Content-Type' => 'text/html'});
Parse headers from a hash reference.
=head2 C<header>
my $string = $headers->header('Content-Type');
my @lines = $headers->header('Content-Type');
$headers = $headers->header('Content-Type' => 'text/plain');
Get or replace the current header values.
# Multiple headers with the same name
for my $header ($headers->header('Set-Cookie')) {
say 'Set-Cookie:';
# Multiple lines per header
say for @$header;
}
=head2 C<host>
my $host = $headers->host;
$headers = $headers->host('127.0.0.1');
Shortcut for the C<Host> header.
=head2 C<if_modified_since>
my $m = $headers->if_modified_since;
$headers = $headers->if_modified_since('Sun, 17 Aug 2008 16:27:35 GMT');
Shortcut for the C<If-Modified-Since> header.
=head2 C<is_finished>
my $success = $headers->is_finished;
Check if header parser is finished.
=head2 C<is_limit_exceeded>
my $success = $headers->is_limit_exceeded;
Check if a header has exceeded C<max_line_size>.
=head2 C<last_modified>
my $m = $headers->last_modified;
$headers = $headers->last_modified('Sun, 17 Aug 2008 16:27:35 GMT');
Shortcut for the C<Last-Modified> header.
=head2 C<leftovers>
my $leftovers = $headers->leftovers;
Leftovers.
=head2 C<location>
my $location = $headers->location;
$headers = $headers->location('http://127.0.0.1/foo');
Shortcut for the C<Location> header.
=head2 C<names>
my $names = $headers->names;
Generate a list of all currently defined headers.
=head2 C<parse>
$headers = $headers->parse("Content-Type: text/foo\n\n");
Parse formatted headers.
=head2 C<proxy_authenticate>
my $authenticate = $headers->proxy_authenticate;
$headers = $headers->proxy_authenticate('Basic "realm"');
Shortcut for the C<Proxy-Authenticate> header.
=head2 C<proxy_authorization>
my $proxy_authorization = $headers->proxy_authorization;
$headers = $headers->proxy_authorization('Basic Zm9vOmJhcg==');
Shortcut for the C<Proxy-Authorization> header.
=head2 C<range>
my $range = $headers->range;
$headers = $headers->range('bytes=2-8');
Shortcut for the C<Range> header.
=head2 C<referrer>
my $referrer = $headers->referrer;
$headers = $headers->referrer('http://mojolicio.us');
Shortcut for the C<Referer> header, there was a typo in RFC 2068 which
resulted in C<Referer> becoming an official header.
=head2 C<remove>
$headers = $headers->remove('Content-Type');
Remove a header.
=head2 C<sec_websocket_accept>
my $accept = $headers->sec_websocket_accept;
$headers = $headers->sec_websocket_accept('s3pPLMBiTxaQ9kYGzzhZRbK+xOo=');
Shortcut for the C<Sec-WebSocket-Accept> header.
=head2 C<sec_websocket_key>
my $key = $headers->sec_websocket_key;
$headers = $headers->sec_websocket_key('dGhlIHNhbXBsZSBub25jZQ==');
Shortcut for the C<Sec-WebSocket-Key> header.
=head2 C<sec_websocket_origin>
my $origin = $headers->sec_websocket_origin;
$headers = $headers->sec_websocket_origin('http://example.com');
Shortcut for the C<Sec-WebSocket-Origin> header.
=head2 C<sec_websocket_protocol>
my $protocol = $headers->sec_websocket_protocol;
$headers = $headers->sec_websocket_protocol('sample');
Shortcut for the C<Sec-WebSocket-Protocol> header.
=head2 C<sec_websocket_version>
my $version = $headers->sec_websocket_version;
$headers = $headers->sec_websocket_version(13);
Shortcut for the C<Sec-WebSocket-Version> header.
=head2 C<server>
my $server = $headers->server;
$headers = $headers->server('Mojo');
Shortcut for the C<Server> header.
=head2 C<set_cookie>
my $set_cookie = $headers->set_cookie;
$headers = $headers->set_cookie('f=b; path=/');
Shortcut for the C<Set-Cookie> header.
=head2 C<status>
my $status = $headers->status;
$headers = $headers->status('200 OK');
Shortcut for the C<Status> header.
=head2 C<to_hash>
my $single = $headers->to_hash;
my $multi = $headers->to_hash(1);
Turn headers into hash reference, nested array references to represent multi
line values are disabled by default.
=head2 C<to_string>
my $string = $headers->to_string;
Turn headers into a string, suitable for HTTP 1.1 messages.
=head2 C<trailer>
my $trailer = $headers->trailer;
$headers = $headers->trailer('X-Foo');
Shortcut for the C<Trailer> header.
=head2 C<transfer_encoding>
my $transfer_encoding = $headers->transfer_encoding;
$headers = $headers->transfer_encoding('chunked');
Shortcut for the C<Transfer-Encoding> header.
=head2 C<upgrade>
my $upgrade = $headers->upgrade;
$headers = $headers->upgrade('websocket');
Shortcut for the C<Upgrade> header.
=head2 C<user_agent>
my $user_agent = $headers->user_agent;
$headers = $headers->user_agent('Mojo/1.0');
Shortcut for the C<User-Agent> header.
=head2 C<www_authenticate>
my $authenticate = $headers->www_authenticate;
$headers = $headers->www_authenticate('Basic realm="realm"');
Shortcut for the C<WWW-Authenticate> header.
=head1 SEE ALSO
L<Mojolicious>, L<Mojolicious::Guides>, L<http://mojolicio.us>.
=cut
|