/usr/share/doc/lintian/api.html/Lintian/Util.html is in lintian 2.5.43.
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 630 631 632 633 634 635 636 637 638 639 640 641 642 643 644 645 646 647 648 649 650 651 652 653 654 655 656 657 658 659 660 661 662 663 664 665 666 667 668 669 670 671 672 673 674 675 676 677 678 679 680 681 682 683 684 685 686 687 688 689 690 691 692 693 694 695 696 697 698 699 700 701 702 703 704 705 706 707 | <!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html4/loose.dtd">
<html><head><title>Lintian::Util</title>
<meta http-equiv="Content-Type" content="text/html; charset=UTF-8">
<link rel="stylesheet" title="blkbluw" type="text/css" href="../_blkbluw.css" media="all" >
<link rel="alternate stylesheet" title="blkmagw" type="text/css" href="../_blkmagw.css" media="all" >
<link rel="alternate stylesheet" title="blkcynw" type="text/css" href="../_blkcynw.css" media="all" >
<link rel="alternate stylesheet" title="whtprpk" type="text/css" href="../_whtprpk.css" media="all" >
<link rel="alternate stylesheet" title="whtnavk" type="text/css" href="../_whtnavk.css" media="all" >
<link rel="alternate stylesheet" title="grygrnk" type="text/css" href="../_grygrnk.css" media="all" >
<link rel="alternate stylesheet" title="whtgrng" type="text/css" href="../_whtgrng.css" media="all" >
<link rel="alternate stylesheet" title="blkgrng" type="text/css" href="../_blkgrng.css" media="all" >
<link rel="alternate stylesheet" title="grygrnw" type="text/css" href="../_grygrnw.css" media="all" >
<link rel="alternate stylesheet" title="blkbluw" type="text/css" href="../_blkbluw.css" media="all" >
<link rel="alternate stylesheet" title="whtpurk" type="text/css" href="../_whtpurk.css" media="all" >
<link rel="alternate stylesheet" title="whtgrng" type="text/css" href="../_whtgrng.css" media="all" >
<link rel="alternate stylesheet" title="grygrnw" type="text/css" href="../_grygrnw.css" media="all" >
<script type="text/javascript" src="../_podly.js"></script>
</head>
<body class='pod'>
<!-- start doc -->
<p class="backlinktop"><b><a name="___top" href="../index.html" accesskey="1" title="All Documents"><<</a></b></p>
<div class='indexgroup'>
<ul class='indexList indexList1'>
<li class='indexItem indexItem1'><a href='#NAME'>NAME</a>
<li class='indexItem indexItem1'><a href='#SYNOPSIS'>SYNOPSIS</a>
<li class='indexItem indexItem1'><a href='#DESCRIPTION'>DESCRIPTION</a>
<ul class='indexList indexList2'>
<li class='indexItem indexItem2'><a href='#Debian_control_parsers'>Debian control parsers</a>
</ul>
<li class='indexItem indexItem1'><a href='#CONSTANTS'>CONSTANTS</a>
<li class='indexItem indexItem1'><a href='#VARIABLES'>VARIABLES</a>
<li class='indexItem indexItem1'><a href='#FUNCTIONS'>FUNCTIONS</a>
<li class='indexItem indexItem1'><a href='#SEE_ALSO'>SEE ALSO</a>
</ul>
</div>
<h1><a class='u' href='#___top' title='click to go to top of document'
name="NAME"
>NAME</a></h1>
<p>Lintian::Util - Lintian utility functions</p>
<h1><a class='u' href='#___top' title='click to go to top of document'
name="SYNOPSIS"
>SYNOPSIS</a></h1>
<pre> use Lintian::Util qw(slurp_entire_file normalize_pkg_path);
my $text = slurp_entire_file('some-file');
if ($text =~ m/regex/) {
# ...
}
my $path = normalize_pkg_path('usr/bin/', '../lib/git-core/git-pull');
if (defined $path) {
# ...
}
my (@paragraphs);
eval { @paragraphs = read_dpkg_control_utf8('some/debian/ctrl/file'); };
if ($@) {
# syntax error etc.
die "ctrl/file: $@";
}
foreach my $para (@paragraphs) {
my $value = $para->{'some-field'};
if (defined $value) {
# ...
}
}</pre>
<h1><a class='u' href='#___top' title='click to go to top of document'
name="DESCRIPTION"
>DESCRIPTION</a></h1>
<p>This module contains a number of utility subs that are nice to have, but on their own did not warrant their own module.</p>
<p>Most subs are imported only on request.</p>
<h2><a class='u' href='#___top' title='click to go to top of document'
name="Debian_control_parsers"
>Debian control parsers</a></h2>
<p>At first glance, this module appears to contain several debian control parsers. In practise, there is only one real parser (<a href="#visit_dpkg_paragraph" class="podlinkpod"
>"visit_dpkg_paragraph"</a>) - the rest are convenience functions around it.</p>
<p>If you have very large files (e.g. Packages_amd64), you almost certainly want <a href="#visit_dpkg_paragraph" class="podlinkpod"
>"visit_dpkg_paragraph"</a>. Otherwise, one of the convenience functions are probably what you are looking for.</p>
<dl>
<dt><a name="Use_"get_deb_info"_when"
>Use <a href="#get_deb_info" class="podlinkpod"
>"get_deb_info"</a> when</a></dt>
<dd>
<p>You have a <i>.deb</i> (or <i>.udeb</i>) file and you want the control file from it.</p>
<dt><a name="Use_"get_dsc_info"_when"
>Use <a href="#get_dsc_info" class="podlinkpod"
>"get_dsc_info"</a> when</a></dt>
<dd>
<p>You have a <i>.dsc</i> (or <i>.changes</i>) file. Alternative, it is also useful if you have a control file and only care about the first paragraph.</p>
<dt><a name="Use_"read_dpkg_control_utf8"_or_"read_dpkg_control"_when"
>Use <a href="#read_dpkg_control_utf8" class="podlinkpod"
>"read_dpkg_control_utf8"</a> or <a href="#read_dpkg_control" class="podlinkpod"
>"read_dpkg_control"</a> when</a></dt>
<dd>
<p>You have a debian control file (such <i>debian/control</i>) and you want a number of paragraphs from it.</p>
<dt><a name="Use_"parse_dpkg_control"_when"
>Use <a href="#parse_dpkg_control" class="podlinkpod"
>"parse_dpkg_control"</a> when</a></dt>
<dd>
<p>When you would have used <a href="#read_dpkg_control_utf8" class="podlinkpod"
>"read_dpkg_control_utf8"</a>, except you have an open filehandle rather than a file name.</p>
</dd>
</dl>
<h1><a class='u' href='#___top' title='click to go to top of document'
name="CONSTANTS"
>CONSTANTS</a></h1>
<p>The following constants can be passed to the Debian control file parser functions to alter their parsing flag.</p>
<dl>
<dt><a name="DCTRL_DEBCONF_TEMPLATE"
>DCTRL_DEBCONF_TEMPLATE</a></dt>
<dd>
<p>The file should be parsed as debconf template. These have slightly syntax rules for whitespace in some cases.</p>
<dt><a name="DCTRL_NO_COMMENTS"
>DCTRL_NO_COMMENTS</a></dt>
<dd>
<p>The file do not allow comments. With this flag, any comment in the file is considered a syntax error.</p>
</dd>
</dl>
<h1><a class='u' href='#___top' title='click to go to top of document'
name="VARIABLES"
>VARIABLES</a></h1>
<dl>
<dt><a name="$PKGNAME_REGEX"
>$PKGNAME_REGEX</a></dt>
<dd>
<p>Regular expression that matches valid package names. The expression is not anchored and does not enforce any "boundary" characters.</p>
</dd>
</dl>
<h1><a class='u' href='#___top' title='click to go to top of document'
name="FUNCTIONS"
>FUNCTIONS</a></h1>
<dl>
<dt><a name="parse_dpkg_control(HANDLE[,_FLAGS[,_LINES]])"
>parse_dpkg_control(HANDLE[, FLAGS[, LINES]])</a></dt>
<dd>
<p>Reads a debian control file from HANDLE and returns a list of paragraphs in it. A paragraph is represented via a hashref, which maps (lower cased) field names to their values.</p>
<p>FLAGS (if given) is a bitmask of the <i>DCTRL_*</i> constants. Please refer to <a href="#CONSTANTS" class="podlinkpod"
>"CONSTANTS"</a> for the list of constants and their meaning. The default value for FLAGS is 0.</p>
<p>If LINES is given, it should be a reference to an empty list. On return, LINES will be populated with a hashref for each paragraph (in the same order as the returned list). Each hashref will also have a special key "<i>START-OF-PARAGRAPH</i>" that gives the line number of the first field in that paragraph. These hashrefs will map the field name of the given paragraph to the line number where the field name appeared.</p>
<p>This is a convenience sub around <a href="#visit_dpkg_paragraph" class="podlinkpod"
>"visit_dpkg_paragraph"</a> and can therefore produce the same errors as it. Please see <a href="#visit_dpkg_paragraph" class="podlinkpod"
>"visit_dpkg_paragraph"</a> for the finer semantics of how the control file is parsed.</p>
<p>NB: parse_dpkg_control does <i>not</i> close the handle for the caller.</p>
<dt><a name="visit_dpkg_paragraph_(CODE,_HANDLE[,_FLAGS])"
>visit_dpkg_paragraph (CODE, HANDLE[, FLAGS])</a></dt>
<dd>
<p>Reads a debian control file from HANDLE and passes each paragraph to CODE. A paragraph is represented via a hashref, which maps (lower cased) field names to their values.</p>
<p>FLAGS (if given) is a bitmask of the <i>DCTRL_*</i> constants. Please refer to <a href="#CONSTANTS" class="podlinkpod"
>"CONSTANTS"</a> for the list of constants and their meaning. The default value for FLAGS is 0.</p>
<p>If the file is empty (i.e. it contains no paragraphs), the method will contain an <i>empty</i> list. The deb822 contents may be inside a <i>signed</i> PGP message with a signature.</p>
<p>visit_dpkg_paragraph will require the PGP headers to be correct (if present) and require that the entire file is covered by the signature. However, it will <i>not</i> validate the signature (in fact, the contents of the PGP SIGNATURE part can be empty). The signature should be validated separately.</p>
<p>visit_dpkg_paragraph will pass paragraphs to CODE as they are completed. If CODE can process the paragraphs as they are seen, very large control files can be processed without keeping all the paragraphs in memory.</p>
<p>As a consequence of how the file is parsed, CODE may be passed a number of (valid) paragraphs before parsing is stopped due to a syntax error.</p>
<p>NB: visit_dpkg_paragraph does <i>not</i> close the handle for the caller.</p>
<p>CODE is expected to be a callable reference (e.g. a sub) and will be invoked as the following:</p>
<dl>
<dt><a name="CODE->(PARA,_LINE_NUMBERS)"
>CODE->(PARA, LINE_NUMBERS)</a></dt>
<dd>
<p>The first argument, PARA, is a hashref to the most recent paragraph parsed. The second argument, LINE_NUMBERS, is a hashref mapping each of the field names to the line number where the field name appeared. LINE_NUMBERS will also have a special key "<i>START-OF-PARAGRAPH</i>" that gives the line number of the first field in that paragraph.</p>
<p>The return value of CODE is ignored.</p>
<p>If the CODE invokes die (or similar) the error is propagated to the caller.</p>
</dd>
</dl>
<p><i>On syntax errors</i>, visit_dpkg_paragraph will call die with the following string:</p>
<pre> "syntax error at line %d: %s\n"</pre>
<p>Where %d is the line number of the issue and %s is one of:</p>
<dl>
<dt><a name="Duplicate_field_%s"
>Duplicate field %s</a></dt>
<dd>
<p>The field appeared twice in the paragraph.</p>
<dt><a name="Continuation_line_outside_a_paragraph_(maybe_line_%d_should_be_"_.")"
>Continuation line outside a paragraph (maybe line %d should be " .")</a></dt>
<dd>
<p>A continuation line appears outside a paragraph - usually caused by an unintended empty line before it.</p>
<dt><a name="Whitespace_line_not_allowed_(possibly_missing_a_".")"
>Whitespace line not allowed (possibly missing a ".")</a></dt>
<dd>
<p>An empty continuation line was found. This usually means that a period is missing to denote an "empty line" in (e.g.) the long description of a package.</p>
<dt><a name="Cannot_parse_line_"%s""
>Cannot parse line "%s"</a></dt>
<dd>
<p>Generic error containing the text of the line that confused the parser. Note that all non-printables in %s will be replaced by underscores.</p>
<dt><a name="Comments_are_not_allowed"
>Comments are not allowed</a></dt>
<dd>
<p>A comment line appeared and FLAGS contained DCTRL_NO_COMMENTS.</p>
<dt><a name="PGP_signature_seen_before_start_of_signed_message"
>PGP signature seen before start of signed message</a></dt>
<dd>
<p>A "BEGIN PGP SIGNATURE" header is seen and a "BEGIN PGP MESSAGE" has not been seen yet.</p>
<dt><a name="Two_PGP_signatures_(first_one_at_line_%d)"
>Two PGP signatures (first one at line %d)</a></dt>
<dd>
<p>Two "BEGIN PGP SIGNATURE" headers are seen in the same file.</p>
<dt><a name="Unexpected_%s_header"
>Unexpected %s header</a></dt>
<dd>
<p>A valid PGP header appears (e.g. "BEGIN PUBLIC KEY BLOCK").</p>
<dt><a name="Malformed_PGP_header"
>Malformed PGP header</a></dt>
<dd>
<p>An invalid or malformed PGP header appears.</p>
<dt><a name="Expected_at_most_one_signed_message_(previous_at_line_%d)"
>Expected at most one signed message (previous at line %d)</a></dt>
<dd>
<p>Two "BEGIN PGP MESSAGE" headers appears in the same message.</p>
<dt><a name="End_of_file_but_expected_a_"END_PGP_SIGNATURE"_header"
>End of file but expected a "END PGP SIGNATURE" header</a></dt>
<dd>
<p>The file ended after a "BEGIN PGP SIGNATURE" header without being followed by a "END PGP SIGNATURE".</p>
<dt><a name="PGP_MESSAGE_header_must_be_first_content_if_present"
>PGP MESSAGE header must be first content if present</a></dt>
<dd>
<p>The file had content before PGP MESSAGE.</p>
<dt><a name="Data_after_the_PGP_SIGNATURE"
>Data after the PGP SIGNATURE</a></dt>
<dd>
<p>The file had data after the PGP SIGNATURE block ended.</p>
<dt><a name="End_of_file_before_"BEGIN_PGP_SIGNATURE""
>End of file before "BEGIN PGP SIGNATURE"</a></dt>
<dd>
<p>The file had a "BEGIN PGP MESSAGE" header, but no signature was present.</p>
</dd>
</dl>
<dt><a name="read_dpkg_control_utf8(FILE[,_FLAGS[,_LINES]])"
>read_dpkg_control_utf8(FILE[, FLAGS[, LINES]])</a></dt>
<dd>
<dt><a name="read_dpkg_control(FILE[,_FLAGS[,_LINES]])"
>read_dpkg_control(FILE[, FLAGS[, LINES]])</a></dt>
<dd>
<p>This is a convenience function to ease using <a href="#parse_dpkg_control" class="podlinkpod"
>"parse_dpkg_control"</a> with paths to files (rather than open handles). The first argument must be the path to a FILE, which should be read as a debian control file. If the file is empty, an empty list is returned.</p>
<p>Otherwise, this behaves like:</p>
<pre> use autodie;
open(my $fd, '<:encoding(UTF-8)', FILE); # or '<'
my @p = parse_dpkg_control($fd, FLAGS, LINES);
close($fd);
return @p;</pre>
<p>This goes without saying that may fail with any of the messages that <a href="#parse_dpkg_control(HANDLE%5B%2C_FLAGS%5B%2C_LINES%5D%5D)" class="podlinkpod"
>"parse_dpkg_control(HANDLE[, FLAGS[, LINES]])"</a> do. It can also emit autodie exceptions if open or close fails.</p>
<dt><a name="dpkg_deb_has_ctrl_tarfile()"
>dpkg_deb_has_ctrl_tarfile()</a></dt>
<dd>
<p>Check if lintian could use dpkg-deb instead of ar and tar</p>
<dt><a name="get_deb_info(DEBFILE)"
>get_deb_info(DEBFILE)</a></dt>
<dd>
<p>Extracts the control file from DEBFILE and returns it as a hashref.</p>
<p>Basically, this is a fancy convenience for setting up an ar + tar pipe and passing said pipe to <a href="#parse_dpkg_control(HANDLE%5B%2C_FLAGS%5B%2C_LINES%5D%5D)" class="podlinkpod"
>"parse_dpkg_control(HANDLE[, FLAGS[, LINES]])"</a>.</p>
<p>DEBFILE must be an ar file containing a "control.tar.gz" member, which in turn should contain a "control" file. If the "control" file is empty this will return an empty list.</p>
<p>Note: the control file is only expected to have a single paragraph and thus only the first is returned (in the unlikely case that there are more than one).</p>
<p>This function may fail with any of the messages that <a href="#parse_dpkg_control" class="podlinkpod"
>"parse_dpkg_control"</a> do. It can also emit:</p>
<pre> "cannot fork to unpack %s: %s\n"</pre>
<dt><a name="get_dsc_control_(DSCFILE)"
>get_dsc_control (DSCFILE)</a></dt>
<dd>
<p>Convenience function for reading dsc files. It will read the DSCFILE using <a href="#read_dpkg_control(FILE%5B%2C_FLAGS%5B%2C_LINES%5D%5D)" class="podlinkpod"
>"read_dpkg_control(FILE[, FLAGS[, LINES]])"</a> and then return the first paragraph. If the file has no paragraphs, <code>undef</code> is returned instead.</p>
<p>Note: the control file is only expected to have a single paragraph and thus only the first is returned (in the unlikely case that there are more than one).</p>
<p>This function may fail with any of the messages that <a href="#read_dpkg_control(FILE%5B%2C_FLAGS%5B%2C_LINES%5D%5D)" class="podlinkpod"
>"read_dpkg_control(FILE[, FLAGS[, LINES]])"</a> do.</p>
<dt><a name="slurp_entire_file_(FOH[,_NOCLOSE])"
>slurp_entire_file (FOH[, NOCLOSE])</a></dt>
<dd>
<p>Reads the contents of FOH into memory and return it as a scalar. FOH can be either the path to a file or an open file handle.</p>
<p>If it is a handle, the optional NOCLOSE parameter can be used to prevent the sub from closing the handle. The NOCLOSE parameter has no effect if FOH is not a handle.</p>
<dt><a name="drain_pipe(FD)"
>drain_pipe(FD)</a></dt>
<dd>
<p>Reads and discards any remaining contents from FD, which is assumed to be a pipe. This is mostly done to avoid having the "write"-end die with a SIGPIPE due to a "broken pipe" (which can happen if you just close the pipe).</p>
<p>May cause an exception if there are issues reading from the pipe.</p>
<p>Caveat: This will block until the pipe is closed from the "write"-end, so only use it with pipes where the "write"-end will eventually close their end by themselves (or something else will make them close it).</p>
<dt><a name="get_file_checksum_(ALGO,_FILE)"
>get_file_checksum (ALGO, FILE)</a></dt>
<dd>
<p>Returns a hexadecimal string of the message digest checksum generated by the algorithm ALGO on FILE.</p>
<p>ALGO can be 'md5' or shaX, where X is any number supported by <a href="../Digest/SHA.html" class="podlinkpod"
>Digest::SHA</a> (e.g. 'sha256').</p>
<p>This sub is a convenience wrapper around Digest::{MD5,SHA}.</p>
<dt><a name="is_string_utf8_encoded(STRING)"
>is_string_utf8_encoded(STRING)</a></dt>
<dd>
<p>Returns a truth value if STRING can be decoded as valid UTF-8.</p>
<dt><a name="file_is_encoded_in_non_utf8_(...)"
>file_is_encoded_in_non_utf8 (...)</a></dt>
<dd>
<p>Undocumented</p>
<dt><a name="system_env_(CMD)"
>system_env (CMD)</a></dt>
<dd>
<p>Behaves like system (CMD) except that the environment of CMD is cleaned (as defined by <a href="#clean_env" class="podlinkpod"
>"clean_env"</a>(1)).</p>
<dt><a name="clean_env_([CLOC])"
>clean_env ([CLOC])</a></dt>
<dd>
<p>Destructively cleans %ENV - removes all variables %ENV except a selected few whitelisted variables.</p>
<p>The list of whitelisted %ENV variables are:</p>
<pre> PATH
LC_ALL (*)
TMPDIR</pre>
<p>(*) LC_ALL is a special case as clean_env will change its value to either "C.UTF-8" or "C" (if CLOC is given and a truth value).</p>
<dt><a name="perm2oct(PERM)"
>perm2oct(PERM)</a></dt>
<dd>
<p>Translates PERM to an octal permission. PERM should be a string describing the permissions as done by <i>tar t</i> or <i>ls -l</i>. That is, it should be a string like "-rw-r--r--".</p>
<p>If the string does not appear to be a valid permission, it will cause a trappable error.</p>
<p>Examples:</p>
<pre> # Good
perm2oct('-rw-r--r--') == 0644
perm2oct('-rwxr-xr-x') == 0755
# Bad
perm2oct('broken') # too short to be recognised
perm2oct('-resurunet') # contains unknown permissions</pre>
<dt><a name="delete_dir_(ARGS)"
>delete_dir (ARGS)</a></dt>
<dd>
<p>Convenient way of calling <i>rm -fr ARGS</i>.</p>
<dt><a name="copy_dir_(ARGS)"
>copy_dir (ARGS)</a></dt>
<dd>
<p>Convenient way of calling <i>cp -a ARGS</i>.</p>
<dt><a name="gunzip_file_(IN,_OUT)"
>gunzip_file (IN, OUT)</a></dt>
<dd>
<p>Decompresses contents of the file IN and stores the contents in the file OUT. IN is <i>not</i> removed by this call. On error, this function will cause a trappable error.</p>
<dt><a name="open_gz_(FILE)"
>open_gz (FILE)</a></dt>
<dd>
<p>Opens a handle that reads from the GZip compressed FILE.</p>
<p>On failure, this sub emits a trappable error.</p>
<p>Note: The handle may be a pipe from an external processes.</p>
<dt><a name="touch_file(FILE)"
>touch_file(FILE)</a></dt>
<dd>
<p>Updates the "mtime" of FILE. If FILE does not exist, it will be created.</p>
<p>On failure, this sub will emit a trappable error.</p>
<dt><a name="fail_(MSG[,_...])"
>fail (MSG[, ...])</a></dt>
<dd>
<p>Use to signal an internal error. The argument(s) will used to print a diagnostic message to the user.</p>
<p>If multiple arguments are given, they will be merged into a single string (by join (' ', @_)). If only one argument is given it will be stringified and used directly.</p>
<dt><a name="locate_helper_tool(TOOLNAME)"
>locate_helper_tool(TOOLNAME)</a></dt>
<dd>
<p>Given the name of a helper tool, returns the path to it. The tool must be available in the "helpers" subdir of one of the "lintian root" directories used by Lintian.</p>
<p>The tool name should follow the same rules as check names. Particularly, third-party checks should namespace their tools in the same way they namespace their checks. E.g. "python/some-helper".</p>
<p>If the tool cannot be found, this sub will cause a trappable error.</p>
<dt><a name="strip_([LINE])"
>strip ([LINE])</a></dt>
<dd>
<p>Strips whitespace from the beginning and the end of LINE and returns it. If LINE is omitted, <code>$_</code> will be used instead. Example</p>
<pre> @lines = map { strip } <$fd>;</pre>
<p>In void context, the input argument will be modified so it can be used as a replacement for chomp in some cases:</p>
<pre> while ( my $line = <$fd> ) {
strip ($line);
# $line no longer has any leading or trailing whitespace
}</pre>
<p>Otherwise, a copy of the string is returned:</p>
<pre> while ( my $orig = <$fd> ) {
my $stripped = strip ($orig);
if ($stripped ne $orig) {
# $orig had leading or/and trailing whitespace
}
}</pre>
<dt><a name="lstrip_([LINE])"
>lstrip ([LINE])</a></dt>
<dd>
<p>Like <a href="#strip_(%5BLINE%5D)" class="podlinkpod"
>strip</a> but only strip leading whitespace.</p>
<dt><a name="rstrip_([LINE])"
>rstrip ([LINE])</a></dt>
<dd>
<p>Like <a href="#strip_(%5BLINE%5D)" class="podlinkpod"
>strip</a> but only strip trailing whitespace.</p>
<dt><a name="check_path_(CMD)"
>check_path (CMD)</a></dt>
<dd>
<p>Returns 1 if CMD can be found in PATH (i.e. $ENV{PATH}) and is executable. Otherwise, the function return 0.</p>
<dt><a name="dequote_name(STR,_REMOVESLASH)"
>dequote_name(STR, REMOVESLASH)</a></dt>
<dd>
<p>Strip an extra layer quoting in index file names and optionally remove an initial "./" if any.</p>
<p>Remove initial ./ by default</p>
<dt><a name="signal_number2name(NUM)"
>signal_number2name(NUM)</a></dt>
<dd>
<p>Given a number, returns the name of the signal (without leading "SIG"). Example:</p>
<pre> signal_number2name(2) eq 'INT'</pre>
<dt><a name="normalize_pkg_path(PATH)"
>normalize_pkg_path(PATH)</a></dt>
<dd>
<p>Normalize PATH by removing superfluous path segments. PATH is assumed to be relative the package root. Note that the result will never start nor end with a slash, even if PATH does.</p>
<p>As the name suggests, this is a path "normalization" rather than a true path resolution (for that use Cwd::realpath). Particularly, it assumes none of the path segments are symlinks.</p>
<p>normalize_pkg_path will return <code>q{}</code> (i.e. the empty string) if PATH is normalized to the root dir and <code>undef</code> if the path cannot be normalized without escaping the package root.</p>
<p>Examples: normalize_pkg_path('usr/share/java/../../../usr/share/ant/file') eq 'usr/share/ant/file' normalize_pkg_path('usr/..') eq q{};</p>
<pre> The following will return C<undef>:
normalize_pkg_path('usr/bin/../../../../etc/passwd')</pre>
<dt><a name="normalize_pkg_path(CURDIR,_LINK_TARGET)"
>normalize_pkg_path(CURDIR, LINK_TARGET)</a></dt>
<dd>
<p>Normalize the path obtained by following a link with LINK_TARGET as its target from CURDIR as the current directory. CURDIR is assumed to be relative to the package root. Note that the result will never start nor end with a slash, even if CURDIR or DEST does.</p>
<p>normalize_pkg_path will return <code>q{}</code> (i.e. the empty string) if the target is the root dir and <code>undef</code> if the path cannot be normalized without escaping the package root.</p>
<p><b>CAVEAT</b>: This function is <i>not always sufficient</i> to test if it is safe to open a given symlink. Use <a href="../Lintian/Util.html#is_ancestor_of(PARENTDIR%2C_PATH)" class="podlinkpod"
>is_ancestor_of</a> for that. If you must use this function, remember to check that the target is not a symlink (or if it is, that it can be resolved safely).</p>
<p>Examples:</p>
<pre> normalize_pkg_path('usr/share/java', '../ant/file') eq 'usr/share/ant/file'
normalize_pkg_path('usr/share/java', '../../../usr/share/ant/file')
normalize_pkg_path('usr/share/java', '/usr/share/ant/file')
eq 'usr/share/ant/file'
normalize_pkg_path('/usr/share/java', '/') eq q{};
normalize_pkg_path('/', 'usr/..') eq q{};
The following will return C<undef>:
normalize_pkg_path('usr/bin', '../../../../etc/passwd')
normalize_pkg_path('usr/bin', '/../etc/passwd')</pre>
<dt><a name="parse_boolean_(STR)"
>parse_boolean (STR)</a></dt>
<dd>
<p>Attempt to parse STR as a boolean and return its value. If STR is not a valid/recognised boolean, the sub will invoke croak.</p>
<p>The following values recognised (string checks are not case sensitive):</p>
<dl>
<dt><a name="The_integer_0_is_considered_false"
>The integer 0 is considered false</a></dt>
<dd>
<dt><a name="Any_non-zero_integer_is_considered_true"
>Any non-zero integer is considered true</a></dt>
<dd>
<dt><a name=""true",_"y"_and_"yes"_are_considered_true"
>"true", "y" and "yes" are considered true</a></dt>
<dd>
<dt><a name=""false",_"n"_and_"no"_are_considered_false"
>"false", "n" and "no" are considered false</a></dt>
</dl>
<dt><a name="is_ancestor_of(PARENTDIR,_PATH)"
>is_ancestor_of(PARENTDIR, PATH)</a></dt>
<dd>
<p>Returns true if and only if PATH is PARENTDIR or a path stored somewhere within PARENTDIR (or its subdirs).</p>
<p>This function will resolve the paths; any failure to resolve the path will cause a trappable error.</p>
<dt><a name="unix_locale_split(STR)"
>unix_locale_split(STR)</a></dt>
<dd>
<p>Read STR as a locale code (e.g. en_GB.UTF-8) and return a list of locale codes ordered by preference. As an example, en_GB.UTF-8 might return</p>
<pre> en_GB
en</pre>
<p>Note encoding <i>is ignored</i> as all Lintian files are always encoded in UTF-8.</p>
<p><b>Special cases</b>: The "C" or "POSIX" locale returns the empty list. Other strings that do not match the expected format causes a trappable error.</p>
<dt><a name="pipe_tee(INHANDLE,_OUTHANDLES[,_OPTS])"
>pipe_tee(INHANDLE, OUTHANDLES[, OPTS])</a></dt>
<dd>
<p>Read bytes from INHANDLE and copy them into all of the handles in the listref OUTHANDLES. The optional OPTS argument is a hashref of options, see below.</p>
<p>The subroutine will continue to read from INHANDLE until it is exhausted or an error occurs (either during read or write). In case of errors, a trappable error will be raised. The handles are left open when the subroutine returns, caller must close them afterwards.</p>
<p>Caller should ensure that handles are using "blocking" I/O. The subroutine will use <a href="../perlfunc.html#sysread" class="podlinkpod"
>sysread</a> and <a href="../perlfunc.html#syswrite" class="podlinkpod"
>syswrite</a> when reading and writing.</p>
<p>OPTS, if given, may contain the following key-value pairs:</p>
<dl>
<dt><a name="chunk_size"
>chunk_size</a></dt>
<dd>
<p>A suggested buffer size for read/write. If given, it will be to sysread as LENGTH argument when reading from INHANDLE.</p>
</dd>
</dl>
<dt><a name="load_state_cache(STATE_DIR)"
>load_state_cache(STATE_DIR)</a></dt>
<dd>
<p>[Reporting tools only] Load the state cache from STATE_DIR.</p>
<dt><a name="save_state_cache(STATE_DIR,_STATE)"
>save_state_cache(STATE_DIR, STATE)</a></dt>
<dd>
<p>[Reporting tools only] Save the STATE cache to STATE_DIR.</p>
<dt><a name="find_backlog(LINTIAN_VERSION,_STATE)"
>find_backlog(LINTIAN_VERSION, STATE)</a></dt>
<dd>
<p>[Reporting tools only] Given the current lintian version and the harness state, return a list of group ids that are part of the backlog. The list is sorted based on what version of Lintian processed the package.</p>
<dt><a name="untaint(VALUE)"
>untaint(VALUE)</a></dt>
<dd>
<p>Untaint VALUE</p>
</dd>
</dl>
<h1><a class='u' href='#___top' title='click to go to top of document'
name="SEE_ALSO"
>SEE ALSO</a></h1>
<p>lintian(1)</p>
<p class="backlinkbottom"><b><a name="___bottom" href="../index.html" title="All Documents"><<</a></b></p>
<!-- end doc -->
</body></html>
|