/usr/share/perl5/Dpkg/Control/HashCore.pm is in libdpkg-perl 1.19.0.5ubuntu2.
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 | # Copyright © 2007-2009 Raphaël Hertzog <hertzog@debian.org>
# Copyright © 2009, 2012-2015 Guillem Jover <guillem@debian.org>
#
# This program is free software; you can redistribute it and/or modify
# it under the terms of the GNU General Public License as published by
# the Free Software Foundation; either version 2 of the License, or
# (at your option) any later version.
#
# This program is distributed in the hope that it will be useful,
# but WITHOUT ANY WARRANTY; without even the implied warranty of
# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
# GNU General Public License for more details.
#
# You should have received a copy of the GNU General Public License
# along with this program. If not, see <https://www.gnu.org/licenses/>.
package Dpkg::Control::HashCore;
use strict;
use warnings;
our $VERSION = '1.01';
use Dpkg::Gettext;
use Dpkg::ErrorHandling;
use Dpkg::Control::FieldsCore;
# This module cannot use Dpkg::Control::Fields, because that one makes use
# of Dpkg::Vendor which at the same time uses this module, which would turn
# into a compilation error. We can use Dpkg::Control::FieldsCore instead.
use parent qw(Dpkg::Interface::Storable);
use overload
'%{}' => sub { ${$_[0]}->{fields} },
'eq' => sub { "$_[0]" eq "$_[1]" };
=encoding utf8
=head1 NAME
Dpkg::Control::HashCore - parse and manipulate a block of RFC822-like fields
=head1 DESCRIPTION
The Dpkg::Control::Hash object is a hash-like representation of a set of
RFC822-like fields. The fields names are case insensitive and are always
capitalized the same when output (see field_capitalize function in
Dpkg::Control::Fields).
The order in which fields have been set is remembered and is used
to be able to dump back the same content. The output order can also be
overridden if needed.
You can store arbitrary values in the hash, they will always be properly
escaped in the output to conform to the syntax of control files. This is
relevant mainly for multilines values: while the first line is always output
unchanged directly after the field name, supplementary lines are
modified. Empty lines and lines containing only dots are prefixed with
" ." (space + dot) while other lines are prefixed with a single space.
During parsing, trailing spaces are stripped on all lines while leading
spaces are stripped only on the first line of each field.
=head1 METHODS
=over 4
=item $c = Dpkg::Control::Hash->new(%opts)
Creates a new object with the indicated options. Supported options
are:
=over 8
=item allow_pgp
Configures the parser to accept OpenPGP signatures around the control
information. Value can be 0 (default) or 1.
=item allow_duplicate
Configures the parser to allow duplicate fields in the control
information. Value can be 0 (default) or 1.
=item drop_empty
Defines if empty fields are dropped during the output. Value can be 0
(default) or 1.
=item name
The user friendly name of the information stored in the object. It might
be used in some error messages or warnings. A default name might be set
depending on the type.
=item is_pgp_signed
Set by the parser (starting in dpkg 1.17.0) if it finds an OpenPGP
signature around the control information. Value can be 0 (default)
or 1, and undef when the option is not supported by the code (in
versions older than dpkg 1.17.0).
=back
=cut
sub new {
my ($this, %opts) = @_;
my $class = ref($this) || $this;
# Object is a scalar reference and not a hash ref to avoid
# infinite recursion due to overloading hash-dereferencing
my $self = \{
in_order => [],
out_order => [],
is_pgp_signed => 0,
allow_pgp => 0,
allow_duplicate => 0,
drop_empty => 0,
};
bless $self, $class;
$$self->{fields} = Dpkg::Control::HashCore::Tie->new($self);
# Options set by the user override default values
$$self->{$_} = $opts{$_} foreach keys %opts;
return $self;
}
# There is naturally a circular reference between the tied hash and its
# containing object. Happily, the extra layer of scalar reference can
# be used to detect the destruction of the object and break the loop so
# that everything gets garbage-collected.
sub DESTROY {
my $self = shift;
delete $$self->{fields};
}
=item $c->set_options($option, %opts)
Changes the value of one or more options.
=cut
sub set_options {
my ($self, %opts) = @_;
$$self->{$_} = $opts{$_} foreach keys %opts;
}
=item $value = $c->get_option($option)
Returns the value of the corresponding option.
=cut
sub get_option {
my ($self, $k) = @_;
return $$self->{$k};
}
=item $c->load($file)
Parse the content of $file. Exits in case of errors. Returns true if some
fields have been parsed.
=item $c->parse_error($file, $fmt, ...)
Prints an error message and dies on syntax parse errors.
=cut
sub parse_error {
my ($self, $file, $msg) = (shift, shift, shift);
$msg = sprintf($msg, @_) if (@_);
error(g_('syntax error in %s at line %d: %s'), $file, $., $msg);
}
=item $c->parse($fh, $description)
Parse a control file from the given filehandle. Exits in case of errors.
$description is used to describe the filehandle, ideally it's a filename
or a description of where the data comes from. It's used in error
messages. When called multiple times, the parsed fields are accumulated.
Returns true if some fields have been parsed.
=cut
sub parse {
my ($self, $fh, $desc) = @_;
my $paraborder = 1;
my $parabody = 0;
my $cf; # Current field
my $expect_pgp_sig = 0;
local $_;
while (<$fh>) {
# In the common case there will be just a trailing \n character,
# so using chomp here which is very fast will avoid the latter
# s/// doing anything, which gives usa significant speed up.
chomp;
my $armor = $_;
s/\s+$//;
next if length == 0 and $paraborder;
my $lead = substr $_, 0, 1;
next if $lead eq '#';
$paraborder = 0;
my ($name, $value) = split /\s*:\s*/, $_, 2;
if (defined $name and $name =~ m/^\S+?$/) {
$parabody = 1;
if ($lead eq '-') {
$self->parse_error($desc, g_('field cannot start with a hyphen'));
}
if (exists $self->{$name}) {
unless ($$self->{allow_duplicate}) {
$self->parse_error($desc, g_('duplicate field %s found'), $name);
}
}
$self->{$name} = $value;
$cf = $name;
} elsif (m/^\s(\s*\S.*)$/) {
my $line = $1;
unless (defined($cf)) {
$self->parse_error($desc, g_('continued value line not in field'));
}
if ($line =~ /^\.+$/) {
$line = substr $line, 1;
}
$self->{$cf} .= "\n$line";
} elsif (length == 0 ||
($expect_pgp_sig && $armor =~ m/^-----BEGIN PGP SIGNATURE-----[\r\t ]*$/)) {
if ($expect_pgp_sig) {
# Skip empty lines
$_ = <$fh> while defined && m/^\s*$/;
unless (length) {
$self->parse_error($desc, g_('expected OpenPGP signature, ' .
'found end of file after blank line'));
}
chomp;
unless (m/^-----BEGIN PGP SIGNATURE-----[\r\t ]*$/) {
$self->parse_error($desc, g_('expected OpenPGP signature, ' .
"found something else '%s'"), $_);
}
# Skip OpenPGP signature
while (<$fh>) {
chomp;
last if m/^-----END PGP SIGNATURE-----[\r\t ]*$/;
}
unless (defined) {
$self->parse_error($desc, g_('unfinished OpenPGP signature'));
}
# This does not mean the signature is correct, that needs to
# be verified by gnupg.
$$self->{is_pgp_signed} = 1;
}
last; # Finished parsing one block
} elsif ($armor =~ m/^-----BEGIN PGP SIGNED MESSAGE-----[\r\t ]*$/) {
$expect_pgp_sig = 1;
if ($$self->{allow_pgp} and not $parabody) {
# Skip OpenPGP headers
while (<$fh>) {
last if m/^\s*$/;
}
} else {
$self->parse_error($desc, g_('OpenPGP signature not allowed here'));
}
} else {
$self->parse_error($desc,
g_('line with unknown format (not field-colon-value)'));
}
}
if ($expect_pgp_sig and not $$self->{is_pgp_signed}) {
$self->parse_error($desc, g_('unfinished OpenPGP signature'));
}
return defined($cf);
}
=item $c->find_custom_field($name)
Scan the fields and look for a user specific field whose name matches the
following regex: /X[SBC]*-$name/i. Return the name of the field found or
undef if nothing has been found.
=cut
sub find_custom_field {
my ($self, $name) = @_;
foreach my $key (keys %$self) {
return $key if $key =~ /^X[SBC]*-\Q$name\E$/i;
}
return;
}
=item $c->get_custom_field($name)
Identify a user field and retrieve its value.
=cut
sub get_custom_field {
my ($self, $name) = @_;
my $key = $self->find_custom_field($name);
return $self->{$key} if defined $key;
return;
}
=item $c->save($filename)
Write the string representation of the control information to a
file.
=item $str = $c->output()
=item "$c"
Get a string representation of the control information. The fields
are sorted in the order in which they have been read or set except
if the order has been overridden with set_output_order().
=item $c->output($fh)
Print the string representation of the control information to a
filehandle.
=cut
sub output {
my ($self, $fh) = @_;
my $str = '';
my @keys;
if (@{$$self->{out_order}}) {
my $i = 1;
my $imp = {};
$imp->{$_} = $i++ foreach @{$$self->{out_order}};
@keys = sort {
if (defined $imp->{$a} && defined $imp->{$b}) {
$imp->{$a} <=> $imp->{$b};
} elsif (defined($imp->{$a})) {
-1;
} elsif (defined($imp->{$b})) {
1;
} else {
$a cmp $b;
}
} keys %$self;
} else {
@keys = @{$$self->{in_order}};
}
foreach my $key (@keys) {
if (exists $self->{$key}) {
my $value = $self->{$key};
# Skip whitespace-only fields
next if $$self->{drop_empty} and $value !~ m/\S/;
# Escape data to follow control file syntax
my ($first_line, @lines) = split /\n/, $value;
my $kv = "$key:";
$kv .= ' ' . $first_line if length $first_line;
$kv .= "\n";
foreach (@lines) {
s/\s+$//;
if (length == 0 or /^\.+$/) {
$kv .= " .$_\n";
} else {
$kv .= " $_\n";
}
}
# Print it out
if ($fh) {
print { $fh } $kv
or syserr(g_('write error on control data'));
}
$str .= $kv if defined wantarray;
}
}
return $str;
}
=item $c->set_output_order(@fields)
Define the order in which fields will be displayed in the output() method.
=cut
sub set_output_order {
my ($self, @fields) = @_;
$$self->{out_order} = [@fields];
}
=item $c->apply_substvars($substvars)
Update all fields by replacing the variables references with
the corresponding value stored in the Dpkg::Substvars object.
=cut
sub apply_substvars {
my ($self, $substvars, %opts) = @_;
# Add substvars to refer to other fields
$substvars->set_field_substvars($self, 'F');
foreach my $f (keys %$self) {
my $v = $substvars->substvars($self->{$f}, %opts);
if ($v ne $self->{$f}) {
my $sep;
$sep = field_get_sep_type($f);
# If we replaced stuff, ensure we're not breaking
# a dependency field by introducing empty lines, or multiple
# commas
if ($sep & (FIELD_SEP_COMMA | FIELD_SEP_LINE)) {
# Drop empty/whitespace-only lines
$v =~ s/\n[ \t]*(\n|$)/$1/;
}
if ($sep & FIELD_SEP_COMMA) {
$v =~ s/,[\s,]*,/,/g;
$v =~ s/^\s*,\s*//;
$v =~ s/\s*,\s*$//;
}
}
$v =~ s/\$\{\}/\$/g; # XXX: what for?
$self->{$f} = $v;
}
}
package Dpkg::Control::HashCore::Tie;
# This object is used to tie a hash. It implements hash-like functions by
# normalizing the name of fields received in keys (using
# Dpkg::Control::Fields::field_capitalize). It also stores the order in
# which fields have been added in order to be able to dump them in the
# same order. But the order information is stored in a parent object of
# type Dpkg::Control.
use strict;
use warnings;
use Dpkg::Control::FieldsCore;
use Carp;
use Tie::Hash;
use parent -norequire, qw(Tie::ExtraHash);
# $self->[0] is the real hash
# $self->[1] is a reference to the hash contained by the parent object.
# This reference bypasses the top-level scalar reference of a
# Dpkg::Control::Hash, hence ensuring that reference gets DESTROYed
# properly.
# Dpkg::Control::Hash->new($parent)
#
# Return a reference to a tied hash implementing storage of simple
# "field: value" mapping as used in many Debian-specific files.
sub new {
my $class = shift;
my $hash = {};
tie %{$hash}, $class, @_; ## no critic (Miscellanea::ProhibitTies)
return $hash;
}
sub TIEHASH {
my ($class, $parent) = @_;
croak 'parent object must be Dpkg::Control::Hash'
if not $parent->isa('Dpkg::Control::HashCore') and
not $parent->isa('Dpkg::Control::Hash');
return bless [ {}, $$parent ], $class;
}
sub FETCH {
my ($self, $key) = @_;
$key = lc($key);
return $self->[0]->{$key} if exists $self->[0]->{$key};
return;
}
sub STORE {
my ($self, $key, $value) = @_;
$key = lc($key);
if (not exists $self->[0]->{$key}) {
push @{$self->[1]->{in_order}}, field_capitalize($key);
}
$self->[0]->{$key} = $value;
}
sub EXISTS {
my ($self, $key) = @_;
$key = lc($key);
return exists $self->[0]->{$key};
}
sub DELETE {
my ($self, $key) = @_;
my $parent = $self->[1];
my $in_order = $parent->{in_order};
$key = lc($key);
if (exists $self->[0]->{$key}) {
delete $self->[0]->{$key};
@{$in_order} = grep { lc ne $key } @{$in_order};
return 1;
} else {
return 0;
}
}
sub FIRSTKEY {
my $self = shift;
my $parent = $self->[1];
foreach my $key (@{$parent->{in_order}}) {
return $key if exists $self->[0]->{lc $key};
}
}
sub NEXTKEY {
my ($self, $last) = @_;
my $parent = $self->[1];
my $found = 0;
foreach my $key (@{$parent->{in_order}}) {
if ($found) {
return $key if exists $self->[0]->{lc $key};
} else {
$found = 1 if $key eq $last;
}
}
return;
}
1;
=back
=head1 CHANGES
=head2 Version 1.01 (dpkg 1.17.2)
New method: $c->parse_error().
=head2 Version 1.00 (dpkg 1.17.0)
Mark the module as public.
=cut
1;
|