/usr/share/fusioninventory/lib/FusionInventory/Agent/Tools.pm is in fusioninventory-agent 1:2.3.10.1-1.
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 708 709 710 711 712 713 714 715 716 717 718 719 720 721 722 723 724 725 726 727 728 729 730 731 732 733 734 735 736 737 738 739 740 741 742 743 744 745 746 747 748 749 750 751 752 | package FusionInventory::Agent::Tools;
use strict;
use warnings;
use base 'Exporter';
use Encode qw(encode);
use English qw(-no_match_vars);
use File::Basename;
use File::Spec;
use File::stat;
use File::Which;
use Memoize;
use UNIVERSAL::require;
our @EXPORT = qw(
getDirectoryHandle
getFileHandle
getFormatedLocalTime
getFormatedGMTTime
getFormatedDate
getCanonicalManufacturer
getCanonicalSpeed
getCanonicalSize
getSanitizedString
trimWhitespace
getFirstLine
getFirstMatch
getLastLine
getAllLines
getLinesCount
compareVersion
canRun
canRead
canLoad
hex2char
hex2dec
dec2hex
any
all
none
uniq
file2module
module2file
runFunction
delay
slurp
);
my $nowhere = $OSNAME eq 'MSWin32' ? 'nul' : '/dev/null';
# this trigger some errors on Perl 5.12/Win32:
# Anonymous function called in forbidden scalar context
if ($OSNAME ne 'MSWin32') {
memoize('canRun');
memoize('canRead');
}
sub getFormatedLocalTime {
my ($time) = @_;
return unless $time;
my ($year, $month , $day, $hour, $min, $sec) =
(localtime ($time))[5, 4, 3, 2, 1, 0];
return getFormatedDate(
($year + 1900), ($month + 1), $day, $hour, $min, $sec
);
}
sub getFormatedGMTTime {
my ($time) = @_;
my ($year, $month , $day, $hour, $min, $sec) =
(gmtime ($time))[5, 4, 3, 2, 1, 0];
return getFormatedDate(
($year - 70), $month, ($day - 1), $hour, $min, $sec
);
}
sub getFormatedDate {
my ($year, $month, $day, $hour, $min, $sec) = @_;
return sprintf
"%02d-%02d-%02d %02d:%02d:%02d",
$year, $month, $day, $hour, $min, $sec;
}
sub getCanonicalManufacturer {
my ($manufacturer) = @_;
return unless $manufacturer;
if ($manufacturer =~ /(
maxtor |
sony |
compaq |
ibm |
toshiba |
fujitsu |
lg |
samsung |
nec |
transcend |
matshita |
hitachi |
pioneer
)/xi) {
$manufacturer = ucfirst(lc($1));
} elsif ($manufacturer =~ /^(hp|HP|(?i)hewlett[ -]packard)/) {
$manufacturer = "Hewlett-Packard";
} elsif ($manufacturer =~ /^(WDC|(?i)western)/) {
$manufacturer = "Western Digital";
} elsif ($manufacturer =~ /^(ST|(?i)seagate)/) {
$manufacturer = "Seagate";
} elsif ($manufacturer =~ /^(HD|IC|HU|HGST)/) {
$manufacturer = "Hitachi";
}
return $manufacturer;
}
sub getCanonicalSpeed {
my ($speed) = @_;
## no critic (ExplicitReturnUndef)
return undef unless $speed;
return 400 if $speed =~ /^PC3200U/;
return undef unless $speed =~ /^([,.\d]+) \s? (\S+)$/x;
my $value = $1;
my $unit = lc($2);
return
$unit eq 'ghz' ? $value * 1000 :
$unit eq 'mhz' ? $value :
undef ;
}
sub getCanonicalSize {
my ($size, $base) = @_;
$base ||= 1000;
## no critic (ExplicitReturnUndef)
return undef unless $size;
return $size if $size =~ /^\d+$/;
$size =~ s/ //g;
return undef unless $size =~ /^([,.\d]+) (\S+)$/x;
my $value = $1;
my $unit = lc($2);
return
$unit eq 'tb' ? $value * $base * $base :
$unit eq 'gb' ? $value * $base :
$unit eq 'mb' ? $value :
$unit eq 'kb' ? int($value / ($base)) :
$unit eq 'bytes' ? int($value / ($base * $base)) :
undef ;
}
sub compareVersion {
my ($major, $minor, $min_major, $min_minor) = @_;
$major = 0 unless $major;
$minor = 0 unless $minor;
$min_major = 0 unless $min_major;
$min_minor = 0 unless $min_minor;
return
$major > $min_major
||
(
$major == $min_major
&&
$minor >= $min_minor
);
}
sub getSanitizedString {
my ($string) = @_;
return unless defined $string;
# clean control caracters
$string =~ s/[[:cntrl:]]//g;
# encode to utf-8 if needed
if (!Encode::is_utf8($string) && $string !~ m/\A(
[\x09\x0A\x0D\x20-\x7E] # ASCII
| [\xC2-\xDF][\x80-\xBF] # non-overlong 2-byte
| \xE0[\xA0-\xBF][\x80-\xBF] # excluding overlongs
| [\xE1-\xEC\xEE\xEF][\x80-\xBF]{2} # straight 3-byte
| \xED[\x80-\x9F][\x80-\xBF] # excluding surrogates
| \xF0[\x90-\xBF][\x80-\xBF]{2} # planes 1-3
| [\xF1-\xF3][\x80-\xBF]{3} # planes 4-15
| \xF4[\x80-\x8F][\x80-\xBF]{2} # plane 16
)*\z/x) {
$string = encode("UTF-8", $string);
};
return $string;
}
sub trimWhitespace {
my ($value) = @_;
$value =~ s/^\s+//;
$value =~ s/\s+$//;
$value =~ s/\s+/ /g;
return $value;
}
sub getDirectoryHandle {
my (%params) = @_;
die "no directory parameter given" unless $params{directory};
my $handle;
if (!opendir $handle, $params{directory}) {
$params{logger}->error("Can't open directory $params{directory}: $ERRNO")
if $params{logger};
return;
}
return $handle;
}
sub getFileHandle {
my (%params) = @_;
my $handle;
SWITCH: {
if ($params{file}) {
if (!open $handle, '<', $params{file}) {
$params{logger}->error(
"Can't open file $params{file}: $ERRNO"
) if $params{logger};
return;
}
last SWITCH;
}
if ($params{command}) {
# FIXME: 'Bad file descriptor' error message on Windows
$params{logger}->debug2("executing $params{command}")
if $params{logger};
# Turn off localised output for commands
local $ENV{LC_ALL} = 'C';
local $ENV{LANG} = 'C';
# Ignore 'Broken Pipe' warnings on Solaris
local $SIG{PIPE} = 'IGNORE' if $OSNAME eq 'solaris';
if (!open $handle, '-|', $params{command} . " 2>$nowhere") {
$params{logger}->error(
"Can't run command $params{command}: $ERRNO"
) if $params{logger};
return;
}
last SWITCH;
}
if ($params{string}) {
open $handle, "<", \$params{string} or die;
last SWITCH;
}
die "neither command, file or string parameter given";
}
return $handle;
}
sub getFirstLine {
my (%params) = @_;
my $handle = getFileHandle(%params);
return unless $handle;
my $result = <$handle>;
close $handle;
chomp $result if $result;
return $result;
}
sub getLastLine {
my (%params) = @_;
my $handle = getFileHandle(%params);
return unless $handle;
my $result;
while (my $line = <$handle>) {
$result = $line;
}
close $handle;
chomp $result if $result;
return $result;
}
sub getFirstMatch {
my (%params) = @_;
return unless $params{pattern};
my $handle = getFileHandle(%params);
return unless $handle;
my @results;
while (my $line = <$handle>) {
@results = $line =~ $params{pattern};
last if @results;
}
close $handle;
return wantarray ? @results : $results[0];
}
sub getAllLines {
my (%params) = @_;
my $handle = getFileHandle(%params);
return unless $handle;
if (wantarray) {
my @lines = map { chomp; $_ } <$handle>;
close $handle;
return @lines;
} else {
local $RS;
my $lines = <$handle>;
close $handle;
return $lines;
}
}
sub getLinesCount {
my (%params) = @_;
my $handle = getFileHandle(%params);
return unless $handle;
my $count = 0;
while (my $line = <$handle>) {
$count++;
}
close $handle;
return $count;
}
sub canRun {
my ($binary) = @_;
return $binary =~ m{^/} ?
-x $binary : # full path
scalar(which($binary)); # executable name
}
sub canRead {
my ($file) = @_;
return -f $file;
}
sub canLoad {
my ($module) = @_;
return $module->require();
}
sub hex2char {
my ($value) = @_;
## no critic (ExplicitReturnUndef)
return undef unless $value;
return $value unless $value =~ /^0x/;
$value =~ s/^0x//; # drop hex prefix
$value =~ s/00$//; # drop trailing null-character
$value =~ s/(\w{2})/chr(hex($1))/eg;
return $value;
}
sub hex2dec {
my ($value) = @_;
## no critic (ExplicitReturnUndef)
return undef unless $value;
return $value unless $value =~ /^0x/;
return oct($value);
}
sub dec2hex {
my ($value) = @_;
## no critic (ExplicitReturnUndef)
return undef unless $value;
return $value if $value =~ /^0x/;
return sprintf("0x%x", $value);
}
# shamelessly imported from List::MoreUtils to avoid a dependency
sub any (&@) { ## no critic (SubroutinePrototypes)
my $f = shift;
foreach ( @_ ) {
return 1 if $f->();
}
return 0;
}
sub all (&@) { ## no critic (SubroutinePrototypes)
my $f = shift;
foreach ( @_ ) {
return 0 unless $f->();
}
return 1;
}
sub none (&@) { ## no critic (SubroutinePrototypes)
my $f = shift;
foreach ( @_ ) {
return 0 if $f->();
}
return 1;
}
sub uniq (@) { ## no critic (SubroutinePrototypes)
my %seen = ();
grep { not $seen{$_}++ } @_;
}
sub file2module {
my ($file) = @_;
$file =~ s{.pm$}{};
$file =~ s{/}{::}g;
return $file;
}
sub module2file {
my ($module) = @_;
$module .= '.pm';
$module =~ s{::}{/}g;
return $module;
}
sub runFunction {
my (%params) = @_;
my $logger = $params{logger};
# ensure module is loaded
if ($params{load}) {
$params{module}->require();
if ($EVAL_ERROR) {
$logger->debug("Failed to load $params{module}: $EVAL_ERROR")
if $logger;
return;
}
}
my $result;
eval {
local $SIG{ALRM} = sub { die "alarm\n" };
# set a timeout if needed
alarm $params{timeout} if $params{timeout};
no strict 'refs'; ## no critic (ProhibitNoStrict)
$result = &{$params{module} . '::' . $params{function}}(
ref $params{params} eq 'HASH' ? %{$params{params}} :
ref $params{params} eq 'ARRAY' ? @{$params{params}} :
$params{params}
);
alarm 0;
};
if ($EVAL_ERROR) {
my $message = $EVAL_ERROR eq "alarm\n" ?
"$params{module} killed by a timeout" :
"unexpected error in $params{module}: $EVAL_ERROR";
$logger->debug($message) if $logger;
}
return $result;
}
sub delay {
my ($delay) = @_;
if ($OSNAME eq 'MSWin32') {
Win32->require();
Win32::Sleep($delay*1000);
} else {
sleep($delay);
}
}
sub slurp {
my($file) = @_;
my $handler;
return unless open $handler, '<', $file;
local $INPUT_RECORD_SEPARATOR; # Set input to "slurp" mode.
my $content = <$handler>;
close $handler;
return $content;
}
1;
__END__
=head1 NAME
FusionInventory::Agent::Tools - OS-independent generic functions
=head1 DESCRIPTION
This module provides some OS-independent generic functions.
=head1 FUNCTIONS
=head2 getFormatedLocalTime($time)
Returns a formated date from given Unix timestamp.
=head2 getFormatedGMTTime($time)
Returns a formated date from given Unix timestamp.
=head2 getFormatedDate($year, $month, $day, $hour, $min, $sec)
Returns a formated date from given date elements.
=head2 getCanonicalManufacturer($manufacturer)
Returns a normalized manufacturer value for given one.
=head2 getCanonicalSpeed($speed)
Returns a normalized speed value (in Mhz) for given one.
=head2 getCanonicalSize($size, $base)
Returns a normalized size value (in Mb) for given one.
=head2 getSanitizedString($string)
Returns the input stripped from any control character, properly encoded in
UTF-8.
=head2 trimWhitespace($string)
Remove leading and trailing whitespace, and fold multiple whitespace
characters into a single one.
=head2 compareVersion($major, $minor, $min_major, $min_minor)
Returns true if software with given major and minor version meet minimal
version requirements.
=head2 getDirectoryHandle(%params)
Returns an open file handle on either a command output, or a file.
=over
=item logger a logger object
=item directory the directory to use
=back
=head2 getFileHandle(%params)
Returns an open file handle on either a command output, a file, or a string.
=over
=item logger a logger object
=item command the command to use
=item file the file to use, as an alternative to the command
=item string the string to use, as an alternative to the command
=back
=head2 getFirstLine(%params)
Returns the first line of given command output or given file content, with end
of line removed.
=over
=item logger a logger object
=item command the exact command to use
=item file the file to use, as an alternative to the command
=back
=head2 getAllLines(%params)
Returns all the lines of given command output or given file content, as a list
of strings with end of line removed in list context, as a single string
otherwise.
=over
=item logger a logger object
=item command the exact command to use
=item file the file to use, as an alternative to the command
=back
=head2 getFirstMatch(%params)
Returns the result of applying given pattern on the first matching line of
given command output or given file content.
=over
=item pattern a regexp
=item logger a logger object
=item command the exact command to use
=item file the file to use, as an alternative to the command
=back
=head2 getLastLine(%params)
Returns the last line of given command output or given file content.
=over
=item logger a logger object
=item command the exact command to use
=item file the file to use, as an alternative to the command
=back
=head2 getLinesCount(%params)
Returns the number of lines of given command output or given file content.
=over
=item logger a logger object
=item command the exact command to use
=item file the file to use, as an alternative to the command
=back
=head2 canRun($binary)
Returns true if given binary can be executed.
=head2 canRead($file)
Returns true if given file can be read.
=head2 canLoad($module)
Returns true if given perl module can be loaded (and actually loads it).
=head2 hex2char($value)
Returns the value converted to a character if it starts with hexadecimal
prefix, the unconverted value otherwise. Eg. 0x41 -> A, 41 -> 41.
=head2 hex2dec($value)
Returns the value converted to a decimal if it starts with hexadecimal prefix,
the unconverted value otherwise. Eg. 0x41 -> 65, 41 -> 41.
=head2 dec2hex($value)
Returns the value converted to an hexadecimal if it doesn't start with
hexadecimal prefix, the unconverted value otherwise. Eg. 65 -> 0x41, 0x41 ->
0x41.
=head2 any BLOCK LIST
Returns a true value if any item in LIST meets the criterion given through
BLOCK.
=head2 all BLOCK LIST
Returns a true value if all items in LIST meet the criterion given through
BLOCK.
=head2 none BLOCK LIST
Returns a true value if no item in LIST meets the criterion given through BLOCK.
=head2 uniq BLOCK LIST
Returns a new list by stripping duplicate values in LIST.
=head2 file2module($string)
Converts a perl file name to a perl module name (Foo/Bar.pm -> Foo::Bar)
=head2 module2file($string)
Converts a perl module name to a perl file name ( Foo::Bar -> Foo/Bar.pm)
=head2 runFunction(%params)
Run a function whose name is computed at runtime and return its result.
=over
=item logger a logger object
=item module the function namespace
=item function the function name
=item timeout timeout for function execution
=item load enforce module loading first
=back
=head2 delay($second)
Wait for $second. It uses sleep() or Win32::Sleep() depending
on the Operating System.
=head2 slurp($file)
Return the content of a given file.
|