6 use Date
::Format
qw(time2str);
10 use Fcntl
qw(:DEFAULT :flock);
12 use File
::Path
qw(make_path);
13 use Filesys
::Df
(); # don't overwrite our df()
22 use POSIX
qw(EINTR EEXIST EOPNOTSUPP);
23 use Scalar
::Util
'weaken';
24 use Socket
qw(AF_INET AF_INET6 AI_ALL AI_V4MAPPED AI_CANONNAME SOCK_DGRAM IPPROTO_TCP);
25 use String
::ShellQuote
;
27 use Time
::HiRes
qw(usleep gettimeofday tv_interval alarm);
33 # avoid warning when parsing long hex values with hex()
34 no warnings
'portable'; # Support for 64-bit ints required
52 extract_sensitive_params
67 my $pvelogdir = "/var/log/pve";
68 my $pvetaskdir = "$pvelogdir/tasks";
73 my $IPV4OCTET = "(?:25[0-5]|(?:2[0-4]|1[0-9]|[1-9])?[0-9])";
74 our $IPV4RE = "(?:(?:$IPV4OCTET\\.){3}$IPV4OCTET)";
75 my $IPV6H16 = "(?:[0-9a-fA-F]{1,4})";
76 my $IPV6LS32 = "(?:(?:$IPV4RE|$IPV6H16:$IPV6H16))";
79 "(?:(?:" . "(?:$IPV6H16:){6})$IPV6LS32)|" .
80 "(?:(?:" . "::(?:$IPV6H16:){5})$IPV6LS32)|" .
81 "(?:(?:(?:" . "$IPV6H16)?::(?:$IPV6H16:){4})$IPV6LS32)|" .
82 "(?:(?:(?:(?:$IPV6H16:){0,1}$IPV6H16)?::(?:$IPV6H16:){3})$IPV6LS32)|" .
83 "(?:(?:(?:(?:$IPV6H16:){0,2}$IPV6H16)?::(?:$IPV6H16:){2})$IPV6LS32)|" .
84 "(?:(?:(?:(?:$IPV6H16:){0,3}$IPV6H16)?::(?:$IPV6H16:){1})$IPV6LS32)|" .
85 "(?:(?:(?:(?:$IPV6H16:){0,4}$IPV6H16)?::" . ")$IPV6LS32)|" .
86 "(?:(?:(?:(?:$IPV6H16:){0,5}$IPV6H16)?::" . ")$IPV6H16)|" .
87 "(?:(?:(?:(?:$IPV6H16:){0,6}$IPV6H16)?::" . ")))";
89 our $IPRE = "(?:$IPV4RE|$IPV6RE)";
91 our $EMAIL_USER_RE = qr/[\w\+\-\~]+(\.[\w\+\-\~]+)*/;
92 our $EMAIL_RE = qr/$EMAIL_USER_RE@[a-zA-Z0-9\-]+(\.[a-zA-Z0-9\-]+)*/;
94 use constant {CLONE_NEWNS
=> 0x00020000,
95 CLONE_NEWUTS
=> 0x04000000,
96 CLONE_NEWIPC
=> 0x08000000,
97 CLONE_NEWUSER
=> 0x10000000,
98 CLONE_NEWPID
=> 0x20000000,
99 CLONE_NEWNET
=> 0x40000000};
101 use constant {O_PATH
=> 0x00200000,
102 O_CLOEXEC
=> 0x00080000,
103 O_TMPFILE
=> 0x00410000}; # This includes O_DIRECTORY
105 use constant {AT_EMPTY_PATH
=> 0x1000,
109 use constant {RENAME_NOREPLACE
=> (1 << 0),
110 RENAME_EXCHANGE
=> (1 << 1),
111 RENAME_WHITEOUT
=> (1 << 2)};
113 sub run_with_timeout
{
114 my ($timeout, $code, @param) = @_;
116 die "got timeout\n" if $timeout <= 0;
118 my $prev_alarm = alarm 0; # suspend outer alarm early
125 local $SIG{ALRM
} = sub { $sigcount++; die "got timeout\n"; };
126 local $SIG{PIPE
} = sub { $sigcount++; die "broken pipe\n" };
127 local $SIG{__DIE__
}; # see SA bug 4631
131 eval { $res = &$code(@param); };
133 alarm(0); # avoid race conditions
142 # this shouldn't happen anymore?
143 die "unknown error" if $sigcount && !$err; # seems to happen sometimes
150 # flock: we use one file handle per process, so lock file
151 # can be nested multiple times and succeeds for the same process.
153 # Since this is the only way we lock now and we don't have the old
154 # 'lock(); code(); unlock();' pattern anymore we do not actually need to
155 # count how deep we're nesting. Therefore this hash now stores a weak reference
156 # to a boolean telling us whether we already have a lock.
158 my $lock_handles = {};
161 my ($filename, $timeout, $shared, $code, @param) = @_;
163 $timeout = 10 if !$timeout;
165 my $mode = $shared ? LOCK_SH
: LOCK_EX
;
167 my $lockhash = ($lock_handles->{$$} //= {});
169 # Returns a locked file handle.
170 my $get_locked_file = sub {
171 my $fh = IO
::File-
>new(">>$filename")
172 or die "can't open file - $!\n";
174 if (!flock($fh, $mode|LOCK_NB
)) {
175 print STDERR
"trying to acquire lock...\n";
178 $success = flock($fh, $mode);
179 # try again on EINTR (see bug #273)
180 if ($success || ($! != EINTR
)) {
185 print STDERR
" failed\n";
186 die "can't acquire lock '$filename' - $!\n";
188 print STDERR
" OK\n";
195 my $checkptr = $lockhash->{$filename};
196 my $check = 0; # This must not go out of scope before running the code.
197 my $local_fh; # This must stay local
198 if (!$checkptr || !$$checkptr) {
199 # We cannot create a weak reference in a single atomic step, so we first
200 # create a false-value, then create a reference to it, then weaken it,
201 # and after successfully locking the file we change the boolean value.
203 # The reason for this is that if an outer SIGALRM throws an exception
204 # between creating the reference and weakening it, a subsequent call to
205 # lock_file_full() will see a leftover full reference to a valid
206 # variable. This variable must be 0 in order for said call to attempt to
207 # lock the file anew.
209 # An externally triggered exception elsewhere in the code will cause the
210 # weak reference to become 'undef', and since the file handle is only
211 # stored in the local scope in $local_fh, the file will be closed by
212 # perl's cleanup routines as well.
214 # This still assumes that an IO::File handle can properly deal with such
215 # exceptions thrown during its own destruction, but that's up to perls
217 $lockhash->{$filename} = \
$check;
218 weaken
$lockhash->{$filename};
219 $local_fh = eval { run_with_timeout
($timeout, $get_locked_file) };
221 $@ = "can't lock file '$filename' - $@";
226 $res = eval { &$code(@param); };
233 my ($filename, $timeout, $code, @param) = @_;
235 return lock_file_full
($filename, $timeout, 0, $code, @param);
238 sub file_set_contents
{
239 my ($filename, $data, $perm) = @_;
241 $perm = 0644 if !defined($perm);
243 my $tmpname = "$filename.tmp.$$";
246 my ($fh, $tries) = (undef, 0);
247 while (!$fh && $tries++ < 3) {
248 $fh = IO
::File-
>new($tmpname, O_WRONLY
|O_CREAT
|O_EXCL
, $perm);
249 if (!$fh && $! == EEXIST
) {
250 unlink($tmpname) or die "unable to delete old temp file: $!\n";
253 die "unable to open file '$tmpname' - $!\n" if !$fh;
254 die "unable to write '$tmpname' - $!\n" unless print $fh $data;
255 die "closing file '$tmpname' failed - $!\n" unless close $fh;
264 if (!rename($tmpname, $filename)) {
265 my $msg = "close (rename) atomic file '$filename' failed: $!\n";
271 sub file_get_contents
{
272 my ($filename, $max) = @_;
274 my $fh = IO
::File-
>new($filename, "r") ||
275 die "can't open '$filename' - $!\n";
277 my $content = safe_read_from
($fh, $max, 0, $filename);
285 my ($filename, $dst, $max, $perm) = @_;
287 file_set_contents
($dst, file_get_contents
($filename, $max), $perm);
290 sub file_read_firstline
{
293 my $fh = IO
::File-
>new ($filename, "r");
294 return undef if !$fh;
302 my ($fh, $max, $oneline, $filename) = @_;
304 # pmxcfs file size limit
305 $max = 512*1024 if !$max;
307 my $subject = defined($filename) ?
"file '$filename'" : 'input';
312 while ($count = sysread($fh, $input, 8192, $br)) {
314 die "$subject too long - aborting\n" if $br > $max;
315 if ($oneline && $input =~ m/^(.*)\n/) {
320 die "unable to read $subject - $!\n" if !defined($count);
325 # The $cmd parameter can be:
327 # This is generally executed by passing it to the shell with the -c option.
328 # However, it can be executed in one of two ways, depending on whether
329 # there's a pipe involved:
330 # *) with pipe: passed explicitly to bash -c, prefixed with:
332 # *) without a pipe: passed to perl's open3 which uses 'sh -c'
333 # (Note that this may result in two different syntax requirements!)
335 # -) an array of arguments (strings)
336 # Will be executed without interference from a shell. (Parameters are passed
337 # as is, no escape sequences of strings will be touched.)
338 # -) an array of arrays
339 # Each array represents a command, and each command's output is piped into
340 # the following command's standard input.
341 # For this a shell command string is created with pipe symbols between each
343 # Each command is a list of strings meant to end up in the final command
344 # unchanged. In order to achieve this, every argument is shell-quoted.
345 # Quoting can be disabled for a particular argument by turning it into a
346 # reference, this allows inserting arbitrary shell options.
347 # For instance: the $cmd [ [ 'echo', 'hello', \'>/dev/null' ] ] will not
348 # produce any output, while the $cmd [ [ 'echo', 'hello', '>/dev/null' ] ]
349 # will literally print: hello >/dev/null
351 my ($cmd, %param) = @_;
356 if (my $ref = ref($cmd)) {
357 if (ref($cmd->[0])) {
358 $cmdstr = 'set -o pipefail && ';
360 foreach my $command (@$cmd) {
361 # concatenate quoted parameters
362 # strings which are passed by reference are NOT shell quoted
363 $cmdstr .= $pipe . join(' ', map { ref($_) ?
$$_ : shellquote
($_) } @$command);
366 $cmd = [ '/bin/bash', '-c', "$cmdstr" ];
368 $cmdstr = cmd2string
($cmd);
373 # see 'man bash' for option pipefail
374 $cmd = [ '/bin/bash', '-c', "set -o pipefail && $cmd" ];
399 foreach my $p (keys %param) {
400 if ($p eq 'timeout') {
401 $timeout = $param{$p};
402 } elsif ($p eq 'umask') {
403 $old_umask = umask($param{$p});
404 } elsif ($p eq 'errmsg') {
405 $errmsg = $param{$p};
406 } elsif ($p eq 'input') {
408 } elsif ($p eq 'output') {
409 $output = $param{$p};
410 } elsif ($p eq 'outfunc') {
411 $outfunc = $param{$p};
412 } elsif ($p eq 'errfunc') {
413 $errfunc = $param{$p};
414 } elsif ($p eq 'logfunc') {
415 $logfunc = $param{$p};
416 } elsif ($p eq 'afterfork') {
417 $afterfork = $param{$p};
418 } elsif ($p eq 'noerr') {
420 } elsif ($p eq 'keeplocale') {
421 $keeplocale = $param{$p};
422 } elsif ($p eq 'quiet') {
425 die "got unknown parameter '$p' for run_command\n";
430 my $origerrfunc = $errfunc;
434 &$origerrfunc("$laststderr\n");
436 print STDERR
"$laststderr\n" if $laststderr;
443 my $reader = $output && $output =~ m/^>&/ ?
$output : IO
::File-
>new();
444 my $writer = $input && $input =~ m/^<&/ ?
$input : IO
::File-
>new();
445 my $error = IO
::File-
>new();
450 local $ENV{LC_ALL
} = 'C' if !$keeplocale;
452 # suppress LVM warnings like: "File descriptor 3 left open";
453 local $ENV{LVM_SUPPRESS_FD_WARNINGS
} = "1";
455 $pid = open3
($writer, $reader, $error, @$cmd) || die $!;
457 # if we pipe fron STDIN, open3 closes STDIN, so we we
458 # a perl warning "Filehandle STDIN reopened as GENXYZ .. "
459 # as soon as we open a new file.
460 # to avoid that we open /dev/null
461 if (!ref($writer) && !defined(fileno(STDIN
))) {
463 open(STDIN
, "</dev/null");
470 if ($orig_pid != $$) {
478 local $SIG{ALRM
} = sub { die "got timeout\n"; } if $timeout;
479 $oldtimeout = alarm($timeout) if $timeout;
481 &$afterfork() if $afterfork;
484 print $writer $input if defined $input;
488 my $select = new IO
::Select
;
489 $select->add($reader) if ref($reader);
490 $select->add($error);
495 my $starttime = time();
497 while ($select->count) {
498 my @handles = $select->can_read(1);
500 foreach my $h (@handles) {
502 my $count = sysread ($h, $buf, 4096);
503 if (!defined ($count)) {
509 $select->remove ($h) if !$count;
511 if ($outfunc || $logfunc) {
513 while ($buf =~ s/^([^\010\r\n]*)(?:\n|(?:\010)+|\r\n?)//) {
514 my $line = $outlog . $1;
516 &$outfunc($line) if $outfunc;
517 &$logfunc($line) if $logfunc;
531 } elsif ($h eq $error) {
532 if ($errfunc || $logfunc) {
534 while ($buf =~ s/^([^\010\r\n]*)(?:\n|(?:\010)+|\r\n?)//) {
535 my $line = $errlog . $1;
537 &$errfunc($line) if $errfunc;
538 &$logfunc($line) if $logfunc;
556 &$outfunc($outlog) if $outfunc && $outlog;
557 &$logfunc($outlog) if $logfunc && $outlog;
559 &$errfunc($errlog) if $errfunc && $errlog;
560 &$logfunc($errlog) if $logfunc && $errlog;
565 die "failed to execute\n";
566 } elsif (my $sig = ($? & 127)) {
567 die "got signal $sig\n";
568 } elsif ($exitcode = ($? >> 8)) {
569 if (!($exitcode == 24 && ($cmdstr =~ m
|^(\S
+/)?rsync\s
|))) {
570 if ($errmsg && $laststderr) {
571 my $lerr = $laststderr;
575 die "exit code $exitcode\n";
586 if ($errmsg && $laststderr) {
587 &$errfunc(undef); # flush laststderr
590 umask ($old_umask) if defined($old_umask);
592 alarm($oldtimeout) if $oldtimeout;
595 if ($pid && ($err eq "got timeout\n")) {
598 die "command '$cmdstr' failed: $err";
602 $err =~ s/^usermod:\s*// if $cmdstr =~ m
|^(\S
+/)?usermod\s
|;
605 die "command '$cmdstr' failed: $err";
612 # Run a command with a tcp socket as standard input.
613 sub pipe_socket_to_command
{
614 my ($cmd, $ip, $port) = @_;
619 Proto
=> &Socket
::IPPROTO_TCP
,
620 GetAddrInfoFlags
=> 0,
624 my $socket = IO
::Socket
::IP-
>new(%$params) or die "failed to open socket: $!\n";
626 print "$ip\n$port\n"; # tell remote where to connect
630 local $SIG{ALRM
} = sub { die "timed out waiting for client\n" };
632 my $client = $socket->accept; # Wait for a client
636 # We want that the command talks over the TCP socket and takes
637 # ownership of it, so that when it closes it the connection is
638 # terminated, so we need to be able to close the socket. So we
639 # can't really use PVE::Tools::run_command().
640 my $pid = fork() // die "fork failed: $!\n";
642 POSIX
::dup2
(fileno($client), 0);
643 POSIX
::dup2
(fileno($client), 1);
645 exec {$cmd->[0]} @$cmd or do {
646 warn "exec failed: $!\n";
652 if (waitpid($pid, 0) != $pid) {
653 kill(15 => $pid); # if we got interrupted terminate the child
655 while (waitpid($pid, POSIX
::WNOHANG
) != $pid) {
658 kill(9 => $pid), last if $count > 300; # 30 second timeout
661 if (my $sig = ($? & 127)) {
662 die "got signal $sig\n";
663 } elsif (my $exitcode = ($? >> 8)) {
664 die "exit code $exitcode\n";
671 my $listtxt = shift // '';
673 return split (/\0/, $listtxt) if $listtxt =~ m/\0/;
675 $listtxt =~ s/[,;]/ /g;
676 $listtxt =~ s/^\s+//;
678 my @data = split (/\s+/, $listtxt);
686 return $txt if !defined($txt);
694 # simple uri templates like "/vms/{vmid}"
695 sub template_replace
{
696 my ($tmpl, $data) = @_;
698 return $tmpl if !$tmpl;
701 while ($tmpl =~ m/([^{]+)?(\{([^}]+)\})?/g) {
703 $res .= ($data->{$3} || '-') if $2;
709 my ($filename, $fh, $data) = @_;
713 my $res = print $fh $data;
715 die "write to '$filename' failed\n" if !$res;
721 'at' => 'ftp.at.debian.org',
722 'au' => 'ftp.au.debian.org',
723 'be' => 'ftp.be.debian.org',
724 'bg' => 'ftp.bg.debian.org',
725 'br' => 'ftp.br.debian.org',
726 'ca' => 'ftp.ca.debian.org',
727 'ch' => 'ftp.ch.debian.org',
728 'cl' => 'ftp.cl.debian.org',
729 'cz' => 'ftp.cz.debian.org',
730 'de' => 'ftp.de.debian.org',
731 'dk' => 'ftp.dk.debian.org',
732 'ee' => 'ftp.ee.debian.org',
733 'es' => 'ftp.es.debian.org',
734 'fi' => 'ftp.fi.debian.org',
735 'fr' => 'ftp.fr.debian.org',
736 'gr' => 'ftp.gr.debian.org',
737 'hk' => 'ftp.hk.debian.org',
738 'hr' => 'ftp.hr.debian.org',
739 'hu' => 'ftp.hu.debian.org',
740 'ie' => 'ftp.ie.debian.org',
741 'is' => 'ftp.is.debian.org',
742 'it' => 'ftp.it.debian.org',
743 'jp' => 'ftp.jp.debian.org',
744 'kr' => 'ftp.kr.debian.org',
745 'mx' => 'ftp.mx.debian.org',
746 'nl' => 'ftp.nl.debian.org',
747 'no' => 'ftp.no.debian.org',
748 'nz' => 'ftp.nz.debian.org',
749 'pl' => 'ftp.pl.debian.org',
750 'pt' => 'ftp.pt.debian.org',
751 'ro' => 'ftp.ro.debian.org',
752 'ru' => 'ftp.ru.debian.org',
753 'se' => 'ftp.se.debian.org',
754 'si' => 'ftp.si.debian.org',
755 'sk' => 'ftp.sk.debian.org',
756 'tr' => 'ftp.tr.debian.org',
757 'tw' => 'ftp.tw.debian.org',
758 'gb' => 'ftp.uk.debian.org',
759 'us' => 'ftp.us.debian.org',
764 'dk' => ['Danish', 'da', 'qwerty/dk-latin1.kmap.gz', 'dk', 'nodeadkeys'],
765 'de' => ['German', 'de', 'qwertz/de-latin1-nodeadkeys.kmap.gz', 'de', 'nodeadkeys' ],
766 'de-ch' => ['Swiss-German', 'de-ch', 'qwertz/sg-latin1.kmap.gz', 'ch', 'de_nodeadkeys' ],
767 'en-gb' => ['United Kingdom', 'en-gb', 'qwerty/uk.kmap.gz' , 'gb', undef],
768 'en-us' => ['U.S. English', 'en-us', 'qwerty/us-latin1.kmap.gz', 'us', undef ],
769 'es' => ['Spanish', 'es', 'qwerty/es.kmap.gz', 'es', 'nodeadkeys'],
770 #'et' => [], # Ethopia or Estonia ??
771 'fi' => ['Finnish', 'fi', 'qwerty/fi-latin1.kmap.gz', 'fi', 'nodeadkeys'],
772 #'fo' => ['Faroe Islands', 'fo', ???, 'fo', 'nodeadkeys'],
773 'fr' => ['French', 'fr', 'azerty/fr-latin1.kmap.gz', 'fr', 'nodeadkeys'],
774 'fr-be' => ['Belgium-French', 'fr-be', 'azerty/be2-latin1.kmap.gz', 'be', 'nodeadkeys'],
775 'fr-ca' => ['Canada-French', 'fr-ca', 'qwerty/cf.kmap.gz', 'ca', 'fr-legacy'],
776 'fr-ch' => ['Swiss-French', 'fr-ch', 'qwertz/fr_CH-latin1.kmap.gz', 'ch', 'fr_nodeadkeys'],
777 #'hr' => ['Croatia', 'hr', 'qwertz/croat.kmap.gz', 'hr', ??], # latin2?
778 'hu' => ['Hungarian', 'hu', 'qwertz/hu.kmap.gz', 'hu', undef],
779 'is' => ['Icelandic', 'is', 'qwerty/is-latin1.kmap.gz', 'is', 'nodeadkeys'],
780 'it' => ['Italian', 'it', 'qwerty/it2.kmap.gz', 'it', 'nodeadkeys'],
781 'jp' => ['Japanese', 'ja', 'qwerty/jp106.kmap.gz', 'jp', undef],
782 'lt' => ['Lithuanian', 'lt', 'qwerty/lt.kmap.gz', 'lt', 'std'],
783 #'lv' => ['Latvian', 'lv', 'qwerty/lv-latin4.kmap.gz', 'lv', ??], # latin4 or latin7?
784 'mk' => ['Macedonian', 'mk', 'qwerty/mk.kmap.gz', 'mk', 'nodeadkeys'],
785 'nl' => ['Dutch', 'nl', 'qwerty/nl.kmap.gz', 'nl', undef],
786 #'nl-be' => ['Belgium-Dutch', 'nl-be', ?, ?, ?],
787 'no' => ['Norwegian', 'no', 'qwerty/no-latin1.kmap.gz', 'no', 'nodeadkeys'],
788 'pl' => ['Polish', 'pl', 'qwerty/pl.kmap.gz', 'pl', undef],
789 'pt' => ['Portuguese', 'pt', 'qwerty/pt-latin1.kmap.gz', 'pt', 'nodeadkeys'],
790 'pt-br' => ['Brazil-Portuguese', 'pt-br', 'qwerty/br-latin1.kmap.gz', 'br', 'nodeadkeys'],
791 #'ru' => ['Russian', 'ru', 'qwerty/ru.kmap.gz', 'ru', undef], # don't know?
792 'si' => ['Slovenian', 'sl', 'qwertz/slovene.kmap.gz', 'si', undef],
793 'se' => ['Swedish', 'sv', 'qwerty/se-latin1.kmap.gz', 'se', 'nodeadkeys'],
795 'tr' => ['Turkish', 'tr', 'qwerty/trq.kmap.gz', 'tr', undef],
798 my $kvmkeymaparray = [];
799 foreach my $lc (sort keys %$keymaphash) {
800 push @$kvmkeymaparray, $keymaphash->{$lc}->[1];
808 return $kvmkeymaparray;
812 my ($param, $key) = @_;
814 my $res = $param->{$key};
815 delete $param->{$key};
820 # For extracting sensitive keys (e.g. password), to avoid writing them to www-data owned configs
821 sub extract_sensitive_params
:prototype($$$) {
822 my ($param, $sensitive_list, $delete_list) = @_;
824 my %delete = map { $_ => 1 } ($delete_list || [])->@*;
827 for my $opt (@$sensitive_list) {
828 # handle deletions as explicitly setting `undef`, so subs which only have $param but not
829 # $delete_list available can recognize them. Afterwards new values may override.
830 if (exists($delete{$opt})) {
831 $sensitive->{$opt} = undef;
834 if (defined(my $value = extract_param
($param, $opt))) {
835 $sensitive->{$opt} = $value;
842 # Note: we use this to wait until vncterm/spiceterm is ready
843 sub wait_for_vnc_port
{
844 my ($port, $family, $timeout) = @_;
846 $timeout = 5 if !$timeout;
848 my $starttime = [gettimeofday
];
851 my $cmd = ['/bin/ss', '-Htln', "sport = :$port"];
852 push @$cmd, $family == AF_INET6 ?
'-6' : '-4' if defined($family);
855 while (($elapsed = tv_interval
($starttime)) < $timeout) {
856 # -Htln = don't print header, tcp, listening sockets only, numeric ports
857 run_command
($cmd, outfunc
=> sub {
859 if ($line =~ m/^LISTEN\s+\d+\s+\d+\s+\S+:(\d+)\s/) {
860 $found = 1 if ($port == $1);
864 $sleeptime += 100000 if $sleeptime < 1000000;
868 die "Timeout while waiting for port '$port' to get ready!\n";
871 sub next_unused_port
{
872 my ($range_start, $range_end, $family, $address) = @_;
874 # We use a file to register allocated ports.
875 # Those registrations expires after $expiretime.
876 # We use this to avoid race conditions between
877 # allocation and use of ports.
879 my $filename = "/var/tmp/pve-reserved-ports";
888 if (my $fh = IO
::File-
>new ($filename, "r")) {
889 while (my $line = <$fh>) {
890 if ($line =~ m/^(\d+)\s(\d+)$/) {
891 my ($port, $timestamp) = ($1, $2);
892 if (($timestamp + $expiretime) > $ctime) {
893 $ports->{$port} = $timestamp; # not expired
900 my %sockargs = (Listen
=> 5,
903 Proto
=> IPPROTO_TCP
,
904 GetAddrInfoFlags
=> 0);
905 $sockargs{LocalAddr
} = $address if defined($address);
907 for (my $p = $range_start; $p < $range_end; $p++) {
908 next if $ports->{$p}; # reserved
910 $sockargs{LocalPort
} = $p;
911 my $sock = IO
::Socket
::IP-
>new(%sockargs);
916 $ports->{$p} = $ctime;
922 foreach my $p (keys %$ports) {
923 $data .= "$p $ports->{$p}\n";
926 file_set_contents
($filename, $data);
931 my $p = lock_file
('/var/lock/pve-ports.lck', 10, $code);
934 die "unable to find free port (${range_start}-${range_end})\n" if !$p;
939 sub next_migrate_port
{
940 my ($family, $address) = @_;
941 return next_unused_port
(60000, 60050, $family, $address);
945 my ($family, $address) = @_;
946 return next_unused_port
(5900, 6000, $family, $address);
949 sub spice_port_range
{
950 return (61000, 61999);
953 sub next_spice_port
{
954 my ($family, $address) = @_;
955 return next_unused_port
(spice_port_range
(), $family, $address);
960 eval { $value = "$value" };
961 return "error turning value into a string: $@" if $@;
965 # sigkill after $timeout a $sub running in a fork if it can't write a pipe
966 # the $sub has to return a single scalar
967 sub run_fork_with_timeout
{
968 my ($timeout, $sub) = @_;
972 my $pipe_out = IO
::Pipe-
>new();
974 # disable pending alarms, save their remaining time
975 my $prev_alarm = alarm 0;
977 # avoid leaving a zombie if the parent gets interrupted
981 if (!defined($child)) {
982 die "fork failed: $!\n";
991 print {$pipe_out} encode_json
({ result
=> $res });
995 print {$pipe_out} encode_json
({ error
=> must_stringify
($err) });
1002 local $SIG{INT
} = sub { $sig_received++; };
1003 local $SIG{TERM
} = sub {
1004 $error //= "interrupted by unexpected signal\n";
1005 kill('TERM', $child);
1008 $pipe_out->reader();
1010 my $readvalues = sub {
1012 my $child_res = decode_json
(readline_nointr
($pipe_out));
1013 $res = $child_res->{result
};
1014 $error = $child_res->{error
};
1017 if (defined($timeout)) {
1018 run_with_timeout
($timeout, $readvalues);
1025 kill('KILL', $child);
1029 die "interrupted by unexpected signal\n" if $sig_received;
1031 die $error if $error;
1037 return run_fork_with_timeout
(undef, $code);
1040 # NOTE: NFS syscall can't be interrupted, so alarm does
1041 # not work to provide timeouts.
1042 # from 'man nfs': "Only SIGKILL can interrupt a pending NFS operation"
1043 # So fork() before using Filesys::Df
1045 my ($path, $timeout) = @_;
1047 my $df = sub { return Filesys
::Df
::df
($path, 1) };
1049 my $res = eval { run_fork_with_timeout
($timeout, $df) } // {};
1052 # untaint, but be flexible: PB usage can result in scientific notation
1053 my ($blocks, $used, $bavail) = map { defined($_) ?
(/^([\d\.e\-+]+)$/) : 0 }
1054 $res->@{qw(blocks used bavail)};
1064 my ($path, $timeout) = @_;
1073 if ($line =~ m/^(\d+)\s+total$/) {
1078 run_command
(['du', '-scb', $path], outfunc
=> $parser, timeout
=> $timeout);
1084 # We use this to uniquely identify a process.
1085 # An 'Unique Process ID' has the following format:
1086 # "UPID:$node:$pid:$pstart:$startime:$dtype:$id:$user"
1091 # Note: pstart can be > 32bit if uptime > 497 days, so this can result in
1092 # more that 8 characters for pstart
1093 return sprintf("UPID:%s:%08X:%08X:%08X:%s:%s:%s:", $d->{node
}, $d->{pid
},
1094 $d->{pstart
}, $d->{starttime
}, $d->{type
}, $d->{id
},
1099 my ($upid, $noerr) = @_;
1104 # "UPID:$node:$pid:$pstart:$startime:$dtype:$id:$user"
1105 # Note: allow up to 9 characters for pstart (work until 20 years uptime)
1106 if ($upid =~ m/^UPID:([a-zA-Z0-9]([a-zA-Z0-9\-]*[a-zA-Z0-9])?):([0-9A-Fa-f]{8}):([0-9A-Fa-f]{8,9}):([0-9A-Fa-f]{8}):([^:\s]+):([^:\s]*):([^:\s]+):$/) {
1108 $res->{pid
} = hex($3);
1109 $res->{pstart
} = hex($4);
1110 $res->{starttime
} = hex($5);
1115 my $subdir = substr($5, 7, 8);
1116 $filename = "$pvetaskdir/$subdir/$upid";
1119 return undef if $noerr;
1120 die "unable to parse worker upid '$upid'\n";
1123 return wantarray ?
($res, $filename) : $res;
1129 my ($task, $filename) = upid_decode
($upid);
1131 my $dirname = dirname
($filename);
1132 make_path
($dirname);
1134 my $wwwid = getpwnam('www-data') ||
1135 die "getpwnam failed";
1139 my $outfh = IO
::File-
>new ($filename, O_WRONLY
|O_CREAT
|O_EXCL
, $perm) ||
1140 die "unable to create output file '$filename' - $!\n";
1141 chown $wwwid, -1, $outfh;
1146 sub upid_read_status
{
1149 my ($task, $filename) = upid_decode
($upid);
1150 my $fh = IO
::File-
>new($filename, "r");
1151 return "unable to open file - $!" if !$fh;
1153 sysseek($fh, -$maxlen, 2);
1155 my $br = sysread($fh, $readbuf, $maxlen);
1158 return "unable to extract last line"
1159 if $readbuf !~ m/\n?(.+)$/;
1161 if ($line =~ m/^TASK OK$/) {
1163 } elsif ($line =~ m/^TASK ERROR: (.+)$/) {
1165 } elsif ($line =~ m/^TASK (WARNINGS: \d+)$/) {
1168 return "unexpected status";
1171 return "unable to read tail (got $br bytes)";
1174 # useful functions to store comments in config files
1178 # all control and hi-bit characters, and ':'
1179 my $unsafe = "^\x20-\x39\x3b-\x7e";
1180 return uri_escape
(Encode
::encode
("utf8", $text), $unsafe);
1186 return Encode
::decode
("utf8", uri_unescape
($data));
1189 # depreciated - do not use!
1190 # we now decode all parameters by default
1191 sub decode_utf8_parameters
{
1194 foreach my $p (qw(comment description firstname lastname)) {
1195 $param->{$p} = decode
('utf8', $param->{$p}) if $param->{$p};
1201 sub random_ether_addr
{
1204 my ($seconds, $microseconds) = gettimeofday
;
1206 my $rand = Digest
::SHA
::sha1
($$, rand(), $seconds, $microseconds);
1208 # clear multicast, set local id
1209 vec($rand, 0, 8) = (vec($rand, 0, 8) & 0xfe) | 2;
1211 my $addr = sprintf("%02X:%02X:%02X:%02X:%02X:%02X", unpack("C6", $rand));
1212 if (defined($prefix)) {
1213 $addr = uc($prefix) . substr($addr, length($prefix));
1221 return String
::ShellQuote
::shell_quote
($str);
1227 die "no arguments" if !$cmd;
1229 return $cmd if !ref($cmd);
1232 foreach my $arg (@$cmd) { push @qa, shellquote
($arg); }
1234 return join (' ', @qa);
1237 # split an shell argument string into an array,
1241 return $str ?
[ Text
::ParseWords
::shellwords
($str) ] : [];
1245 my ($filename, $start, $limit, $filter) = @_;
1250 my $fh = IO
::File-
>new($filename, "r");
1253 push @$lines, { n
=> $count, t
=> "unable to open file - $!"};
1254 return ($count, $lines);
1257 $start = 0 if !$start;
1258 $limit = 50 if !$limit;
1263 # duplicate code, so that we do not slow down normal path
1264 while (defined($line = <$fh>)) {
1265 next if $line !~ m/$filter/;
1266 next if $count++ < $start;
1267 next if $limit <= 0;
1269 push @$lines, { n
=> $count, t
=> $line};
1273 while (defined($line = <$fh>)) {
1274 next if $count++ < $start;
1275 next if $limit <= 0;
1277 push @$lines, { n
=> $count, t
=> $line};
1284 # HACK: ExtJS store.guaranteeRange() does not like empty array
1288 push @$lines, { n
=> $count, t
=> "no content"};
1291 return ($count, $lines);
1295 my ($start, $limit, $since, $until, $service) = @_;
1300 $start = 0 if !$start;
1301 $limit = 50 if !$limit;
1306 return if $count++ < $start;
1307 return if $limit <= 0;
1308 push @$lines, { n
=> int($count), t
=> $line};
1312 my $cmd = ['journalctl', '-o', 'short', '--no-pager'];
1314 push @$cmd, '--unit', $service if $service;
1315 push @$cmd, '--since', $since if $since;
1316 push @$cmd, '--until', $until if $until;
1317 run_command
($cmd, outfunc
=> $parser);
1319 # HACK: ExtJS store.guaranteeRange() does not like empty array
1323 push @$lines, { n
=> $count, t
=> "no content"};
1326 return ($count, $lines);
1329 sub dir_glob_regex
{
1330 my ($dir, $regex) = @_;
1332 my $dh = IO
::Dir-
>new ($dir);
1333 return wantarray ?
() : undef if !$dh;
1335 while (defined(my $tmp = $dh->read)) {
1336 if (my @res = $tmp =~ m/^($regex)$/) {
1338 return wantarray ?
@res : $tmp;
1343 return wantarray ?
() : undef;
1346 sub dir_glob_foreach
{
1347 my ($dir, $regex, $func) = @_;
1349 my $dh = IO
::Dir-
>new ($dir);
1351 while (defined(my $tmp = $dh->read)) {
1352 if (my @res = $tmp =~ m/^($regex)$/) {
1359 sub assert_if_modified
{
1360 my ($digest1, $digest2) = @_;
1362 if ($digest1 && $digest2 && ($digest1 ne $digest2)) {
1363 die "detected modified configuration - file changed by other user? Try again.\n";
1367 # Digest for short strings
1368 # like FNV32a, but we only return 31 bits (positive numbers)
1372 my $hval = 0x811c9dc5;
1374 foreach my $c (unpack('C*', $string)) {
1382 $hval = $hval & 0xffffffff;
1384 return $hval & 0x7fffffff;
1387 sub fnv31a_hex
{ return sprintf("%X", fnv31a
(@_)); }
1389 sub unpack_sockaddr_in46
{
1391 my $family = Socket
::sockaddr_family
($sin);
1392 my ($port, $host) = ($family == AF_INET6 ? Socket
::unpack_sockaddr_in6
($sin)
1393 : Socket
::unpack_sockaddr_in
($sin));
1394 return ($family, $port, $host);
1397 sub getaddrinfo_all
{
1398 my ($hostname, @opts) = @_;
1400 flags
=> AI_V4MAPPED
| AI_ALL
,
1403 my ($err, @res) = Socket
::getaddrinfo
($hostname, '0', \
%hints);
1404 die "failed to get address info for: $hostname: $err\n" if $err;
1408 sub get_host_address_family
{
1409 my ($hostname, $socktype) = @_;
1410 my @res = getaddrinfo_all
($hostname, socktype
=> $socktype);
1411 return $res[0]->{family
};
1414 # get the fully qualified domain name of a host
1415 # same logic as hostname(1): The FQDN is the name getaddrinfo(3) returns,
1416 # given a nodename as a parameter
1418 my ($nodename) = @_;
1421 flags
=> AI_CANONNAME
,
1422 socktype
=> SOCK_DGRAM
1425 my ($err, @addrs) = Socket
::getaddrinfo
($nodename, undef, $hints);
1427 die "getaddrinfo: $err" if $err;
1429 return $addrs[0]->{canonname
};
1432 # Parses any sane kind of host, or host+port pair:
1433 # The port is always optional and thus may be undef.
1434 sub parse_host_and_port
{
1436 if ($address =~ /^($IPV4RE|[[:alnum:]\-.]+)(?::(\d+))?$/ || # ipv4 or host with optional ':port'
1437 $address =~ /^\[($IPV6RE|$IPV4RE|[[:alnum:]\-.]+)\](?::(\d+))?$/ || # anything in brackets with optional ':port'
1438 $address =~ /^($IPV6RE)(?:\.(\d+))?$/) # ipv6 with optional port separated by dot
1440 return ($1, $2, 1); # end with 1 to support simple if(parse...) tests
1445 sub setresuid
($$$) {
1446 my ($ruid, $euid, $suid) = @_;
1447 return 0 == syscall(PVE
::Syscall
::setresuid
, $ruid, $euid, $suid);
1452 return 0 == syscall(PVE
::Syscall
::unshare
, $flags);
1456 my ($fileno, $nstype) = @_;
1457 return 0 == syscall(PVE
::Syscall
::setns
, $fileno, $nstype);
1462 return 0 == syscall(PVE
::Syscall
::syncfs
, $fileno);
1467 return 0 == syscall(PVE
::Syscall
::fsync
, $fileno);
1470 sub renameat2
($$$$$) {
1471 my ($olddirfd, $oldpath, $newdirfd, $newpath, $flags) = @_;
1472 return 0 == syscall(PVE
::Syscall
::renameat2
, $olddirfd, $oldpath, $newdirfd, $newpath, $flags);
1475 sub sync_mountpoint
{
1477 sysopen my $fd, $path, O_RDONLY
|O_CLOEXEC
or die "failed to open $path: $!\n";
1479 if (!syncfs
(fileno($fd))) {
1483 die "syncfs '$path' failed - $syncfs_err\n" if defined $syncfs_err;
1486 # support sending multi-part mail messages with a text and or a HTML part
1487 # mailto may be a single email string or an array of receivers
1489 my ($mailto, $subject, $text, $html, $mailfrom, $author) = @_;
1491 $mailto = [ $mailto ] if !ref($mailto);
1493 my $mailto_quoted = [];
1494 for my $to (@$mailto) {
1495 die "mailto does not look like a valid email address or username\n"
1496 if $to !~ /^$EMAIL_RE$/ && $to !~ /^$EMAIL_USER_RE$/;
1497 push @$mailto_quoted, shellquote
($to);
1500 my $rcvrtxt = join (', ', @$mailto);
1502 $mailfrom = $mailfrom || "root";
1503 die "mailfrom does not look like a valid email address or username\n"
1504 if $mailfrom !~ /^$EMAIL_RE$/ && $mailfrom !~ /^$EMAIL_USER_RE$/;
1505 my $mailfrom_quoted = shellquote
($mailfrom);
1507 $author = $author // 'Proxmox VE';
1509 open (MAIL
, "|-", "sendmail", "-B", "8BITMIME", "-f", $mailfrom_quoted,
1510 "--", @$mailto_quoted) || die "unable to open 'sendmail' - $!";
1512 my $date = time2str
('%a, %d %b %Y %H:%M:%S %z', time());
1514 my $is_multipart = $text && $html;
1516 # multipart spec see https://www.ietf.org/rfc/rfc1521.txt
1517 my $boundary = "----_=_NextPart_001_".int(time).$$;
1519 if ($subject =~ /[^[:ascii:]]/) {
1520 $subject = Encode
::encode
('MIME-Header', $subject);
1523 if ($subject =~ /[^[:ascii:]]/ || $is_multipart) {
1524 print MAIL
"MIME-Version: 1.0\n";
1526 print MAIL
"From: $author <$mailfrom>\n";
1527 print MAIL
"To: $rcvrtxt\n";
1528 print MAIL
"Date: $date\n";
1529 print MAIL
"Subject: $subject\n";
1531 if ($is_multipart) {
1532 print MAIL
"Content-Type: multipart/alternative;\n";
1533 print MAIL
"\tboundary=\"$boundary\"\n";
1535 print MAIL "This
is a multi-part message
in MIME format
.\n\n";
1536 print MAIL "--$boundary\n";
1539 if (defined($text)) {
1540 print MAIL "Content-Type
: text
/plain
;\n";
1541 print MAIL "\tcharset
=\"UTF-8
\"\n";
1542 print MAIL "Content-Transfer-Encoding
: 8bit
\n";
1545 # avoid 'remove extra line breaks' issue (MS Outlook)
1547 $text =~ s/^/$fill/gm;
1551 print MAIL "\n--$boundary\n" if $is_multipart;
1554 if (defined($html)) {
1555 print MAIL "Content-Type
: text
/html
;\n";
1556 print MAIL "\tcharset
=\"UTF-8
\"\n";
1557 print MAIL "Content-Transfer-Encoding
: 8bit
\n";
1562 print MAIL "\n--$boundary--\n" if $is_multipart;
1569 my ($perm, %opts) = @_;
1571 # default permissions are stricter than with file_set_contents
1572 $perm = 0600 if !defined($perm);
1574 my $dir = $opts{dir} // '/run';
1575 my $mode = $opts{mode} // O_RDWR;
1576 $mode |= O_EXCL if !$opts{allow_links};
1578 my $fh = IO::File->new($dir, $mode | O_TMPFILE, $perm);
1579 if (!$fh && $! == EOPNOTSUPP) {
1580 $dir = '/tmp' if !defined($opts{dir});
1581 $dir .= "/.tmpfile
.$$";
1582 $fh = IO::File->new($dir, $mode | O_CREAT | O_EXCL, $perm);
1583 unlink($dir) if $fh;
1585 die "failed to create tempfile
: $!\n" if !$fh;
1589 sub tempfile_contents {
1590 my ($data, $perm, %opts) = @_;
1592 my $fh = tempfile($perm, %opts);
1594 die "unable to
write to tempfile
: $!\n" if !print {$fh} $data;
1595 die "unable to flush to tempfile
: $!\n" if !defined($fh->flush());
1602 return ("/proc/$$/fd/".$fh->fileno, $fh);
1605 sub validate_ssh_public_keys {
1607 my @lines = split(/\n/, $raw);
1609 foreach my $line (@lines) {
1610 next if $line =~ m/^\s*$/;
1612 my ($filename, $handle) = tempfile_contents($line);
1613 run_command(["ssh-keygen
", "-l
", "-f
", $filename],
1614 outfunc => sub {}, errfunc => sub {});
1616 die "SSH public key validation error
\n" if $@;
1621 my ($dirfd, $pathname, $flags, $mode) = @_;
1622 my $fd = syscall(PVE::Syscall::openat, $dirfd, $pathname, $flags, $mode//0);
1623 return undef if $fd < 0;
1624 # sysopen() doesn't deal with numeric file descriptors apparently
1625 # so we need to convert to a mode string for IO::Handle->new_from_fd
1626 my $flagstr = ($flags & O_RDWR) ? 'rw' : ($flags & O_WRONLY) ? 'w' : 'r';
1627 my $handle = IO::Handle->new_from_fd($fd, $flagstr);
1628 return $handle if $handle;
1629 my $err = $!; # save error before closing the raw fd
1630 syscall(PVE::Syscall::close, $fd); # close
1636 my ($dirfd, $name, $mode) = @_;
1637 return syscall(PVE::Syscall::mkdirat, $dirfd, $name, $mode) == 0;
1640 sub fchownat($$$$$) {
1641 my ($dirfd, $pathname, $owner, $group, $flags) = @_;
1642 return syscall(PVE::Syscall::fchownat, $dirfd, $pathname, $owner, $group, $flags) == 0;
1645 my $salt_starter = time();
1651 my $salt = substr(Digest::SHA::sha1_base64(time() + $salt_starter + $$), 0, 8);
1653 # crypt does not want '+' in salt (see 'man crypt')
1656 return crypt(encode("utf8
", $pw), "\
$5\$$salt\$");
1659 # intended usage: convert_size($val, "kb
" => "gb
")
1660 # we round up to the next integer by default
1661 # E.g. `convert_size(1023, "b
" => "kb
")` returns 1
1662 # use $no_round_up to switch this off, above example would then return 0
1663 # this is also true for converting down e.g. 0.0005 gb to mb returns 1
1664 # (0 if $no_round_up is true)
1665 # allowed formats for value:
1671 my ($value, $from, $to, $no_round_up) = @_;
1682 die "no value
given"
1683 if !defined($value) || $value eq "";
1685 $from = lc($from // ''); $to = lc($to // '');
1686 die "unknown
'from' and/or 'to' units
($from => $to)"
1687 if !defined($units->{$from}) || !defined($units->{$to});
1689 die "value
'$value' is not a valid
, positive number
"
1690 if $value !~ m/^(?:[0-9]+\.?[0-9]*|[0-9]*\.[0-9]+)$/;
1692 my $shift_amount = ($units->{$from} - $units->{$to}) * 10;
1694 $value *= 2**$shift_amount;
1695 $value++ if !$no_round_up && ($value - int($value)) > 0.0;
1700 # uninterruptible readline
1702 sub readline_nointr {
1707 last if defined($line) || ($! != EINTR);
1714 $host_arch = (POSIX::uname())[4] if !$host_arch;
1718 # Devices are: [ (12 bits minor) (12 bits major) (8 bits minor) ]
1719 sub dev_t_major($) {
1721 return (int($dev_t) & 0xfff00) >> 8;
1724 sub dev_t_minor($) {
1726 $dev_t = int($dev_t);
1727 return (($dev_t >> 12) & 0xfff00) | ($dev_t & 0xff);
1730 # Given an array of array refs [ \[a b c], \[a b b], \[e b a] ]
1731 # Returns the intersection of elements as a single array [a b]
1732 sub array_intersect {
1735 if (!ref($arrays->[0])) {
1736 $arrays = [ grep { ref($_) eq 'ARRAY' } @_ ];
1739 return [] if scalar(@$arrays) == 0;
1740 return $arrays->[0] if scalar(@$arrays) == 1;
1742 my $array_unique = sub {
1744 return grep { ! $seen{ $_ }++ } @_;
1747 # base idea is to get all unique members from the first array, then
1748 # check the common elements with the next (uniquely made) one, only keep
1749 # those. Repeat for every array and at the end we only have those left
1750 # which exist in all arrays
1751 my $return_arr = [ $array_unique->(@{$arrays->[0]}) ];
1752 for my $i (1 .. $#$arrays) {
1754 # $return_arr is already unique, explicit at before the loop, implicit below.
1755 foreach my $element (@$return_arr, $array_unique->(@{$arrays->[$i]})) {
1759 foreach my $element (keys %count) {
1760 push @$return_arr, $element if $count{$element} > 1;
1762 last if scalar(@$return_arr) == 0; # empty intersection, early exit
1768 sub open_tree($$$) {
1769 my ($dfd, $pathname, $flags) = @_;
1770 return PVE::Syscall::file_handle_result(syscall(
1771 &PVE::Syscall::open_tree,
1778 sub move_mount($$$$$) {
1779 my ($from_dirfd, $from_pathname, $to_dirfd, $to_pathname, $flags) = @_;
1780 return 0 == syscall(
1781 &PVE::Syscall::move_mount,
1791 my ($fsname, $flags) = @_;
1792 return PVE::Syscall::file_handle_result(syscall(&PVE::Syscall::fsopen, $fsname, $flags));
1796 my ($fd, $flags, $mount_attrs) = @_;
1797 return PVE::Syscall::file_handle_result(syscall(
1798 &PVE::Syscall::fsmount,
1806 my ($dirfd, $pathname, $flags) = @_;
1807 return PVE::Syscall::file_handle_result(syscall(
1808 &PVE::Syscall::fspick,
1815 sub fsconfig($$$$$) {
1816 my ($fd, $command, $key, $value, $aux) = @_;
1817 return 0 == syscall(&PVE::Syscall::fsconfig, $fd, $command, $key, $value, $aux);
1820 # "raw
" mount, old api, not for generic use (as it does not invoke any helpers).
1821 # use for lower level stuff such as bind/remount/... or simple tmpfs mounts
1823 my ($source, $target, $filesystemtype, $mountflags, $data) = @_;
1824 return 0 == syscall(
1825 &PVE::Syscall::mount,
1835 my ($left, $right, $cmp) = @_;
1837 return 0 if !defined($left) && !defined($right);
1838 return -1 if !defined($left);
1839 return 1 if !defined($right);
1840 return $cmp->($left, $right);
1844 # opts is a hash ref with the following known properties
1845 # hash_required - if 1, at least one checksum has to be specified otherwise an error will be thrown
1848 # verify_certificates - if 0 (false) we tell wget to ignore untrusted TLS certs. Default to true
1849 # md5sum|sha(1|224|256|384|512)sum - the respective expected checksum string
1850 sub download_file_from_url {
1851 my ($dest, $url, $opts) = @_;
1853 my ($checksum_algorithm, $checksum_expected);
1854 for ('sha512', 'sha384', 'sha256', 'sha224', 'sha1', 'md5') {
1855 if (defined($opts->{"${_
}sum
"})) {
1856 $checksum_algorithm = $_;
1857 $checksum_expected = $opts->{"${_
}sum
"};
1861 die "checksum required but
not specified
\n" if ($opts->{hash_required} && !$checksum_algorithm);
1863 print "downloading
$url to
$dest\n";
1865 my $tmpdest = "$dest.tmp
.$$";
1867 if (-f $dest && $checksum_algorithm) {
1868 print "calculating checksum of existing file
...";
1869 my $checksum_got = get_file_hash($checksum_algorithm, $dest);
1871 if (lc($checksum_got) eq lc($checksum_expected)) {
1872 print "OK
, got correct file already
, no need to download
\n";
1875 # we could re-download, but may not be safe so just abort for now..
1876 print "\n"; # the front end expects the error to reside at the last line without any noise
1877 die "checksum mismatch
: got
'$checksum_got' != expect
'$checksum_expected', aborting
\n";
1881 local $SIG{INT} = sub {
1882 unlink $tmpdest or warn "could
not cleanup temporary file
: $!";
1883 die "got interrupted by signal
\n";
1886 { # limit the scope of the ENV change
1888 if ($opts->{http_proxy}) {
1889 $ENV{http_proxy} = $opts->{http_proxy};
1891 if ($opts->{https_proxy}) {
1892 $ENV{https_proxy} = $opts->{https_proxy};
1895 my $cmd = ['wget', '--progress=dot:giga', '-O', $tmpdest, $url];
1897 if (!($opts->{verify_certificates} // 1)) { # default to true
1898 push @$cmd, '--no-check-certificate';
1901 run_command($cmd, errmsg => "download failed
");
1904 if ($checksum_algorithm) {
1905 print "calculating checksum
...";
1907 my $checksum_got = get_file_hash($checksum_algorithm, $tmpdest);
1909 if (lc($checksum_got) eq lc($checksum_expected)) {
1910 print "OK
, checksum verified
\n";
1912 print "\n"; # the front end expects the error to reside at the last line without any noise
1913 die "checksum mismatch
: got
'$checksum_got' != expect
'$checksum_expected'\n";
1917 rename($tmpdest, $dest) or die "unable to
rename temporary file
: $!\n";
1920 unlink $tmpdest or warn "could
not cleanup temporary file
: $!";
1924 print "download of
'$url' to
'$dest' finished
\n";
1928 my ($algorithm, $filename) = @_;
1930 my $algorithm_map = {
1931 'md5' => sub { Digest::MD5->new },
1932 'sha1' => sub { Digest::SHA->new(1) },
1933 'sha224' => sub { Digest::SHA->new(224) },
1934 'sha256' => sub { Digest::SHA->new(256) },
1935 'sha384' => sub { Digest::SHA->new(384) },
1936 'sha512' => sub { Digest::SHA->new(512) },
1939 my $digester = $algorithm_map->{$algorithm}->() or die "unknown algorithm
'$algorithm'\n";
1941 open(my $fh, '<', $filename) or die "unable to
open '$filename': $!\n";
1944 my $digest = $digester->addfile($fh)->hexdigest;