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
81 my $pvelogdir = "/var/log/pve";
82 my $pvetaskdir = "$pvelogdir/tasks";
87 my $IPV4OCTET = "(?:25[0-5]|(?:2[0-4]|1[0-9]|[1-9])?[0-9])";
88 our $IPV4RE = "(?:(?:$IPV4OCTET\\.){3}$IPV4OCTET)";
89 my $IPV6H16 = "(?:[0-9a-fA-F]{1,4})";
90 my $IPV6LS32 = "(?:(?:$IPV4RE|$IPV6H16:$IPV6H16))";
93 "(?:(?:" . "(?:$IPV6H16:){6})$IPV6LS32)|" .
94 "(?:(?:" . "::(?:$IPV6H16:){5})$IPV6LS32)|" .
95 "(?:(?:(?:" . "$IPV6H16)?::(?:$IPV6H16:){4})$IPV6LS32)|" .
96 "(?:(?:(?:(?:$IPV6H16:){0,1}$IPV6H16)?::(?:$IPV6H16:){3})$IPV6LS32)|" .
97 "(?:(?:(?:(?:$IPV6H16:){0,2}$IPV6H16)?::(?:$IPV6H16:){2})$IPV6LS32)|" .
98 "(?:(?:(?:(?:$IPV6H16:){0,3}$IPV6H16)?::(?:$IPV6H16:){1})$IPV6LS32)|" .
99 "(?:(?:(?:(?:$IPV6H16:){0,4}$IPV6H16)?::" . ")$IPV6LS32)|" .
100 "(?:(?:(?:(?:$IPV6H16:){0,5}$IPV6H16)?::" . ")$IPV6H16)|" .
101 "(?:(?:(?:(?:$IPV6H16:){0,6}$IPV6H16)?::" . ")))";
103 our $IPRE = "(?:$IPV4RE|$IPV6RE)";
105 our $EMAIL_USER_RE = qr/[\w\+\-\~]+(\.[\w\+\-\~]+)*/;
106 our $EMAIL_RE = qr/$EMAIL_USER_RE@[a-zA-Z0-9\-]+(\.[a-zA-Z0-9\-]+)*/;
108 use constant {CLONE_NEWNS
=> 0x00020000,
109 CLONE_NEWUTS
=> 0x04000000,
110 CLONE_NEWIPC
=> 0x08000000,
111 CLONE_NEWUSER
=> 0x10000000,
112 CLONE_NEWPID
=> 0x20000000,
113 CLONE_NEWNET
=> 0x40000000};
115 use constant {O_PATH
=> 0x00200000,
116 O_CLOEXEC
=> 0x00080000,
117 O_TMPFILE
=> 0x00400000 | O_DIRECTORY
};
119 use constant {AT_EMPTY_PATH
=> 0x1000,
123 use constant {RENAME_NOREPLACE
=> (1 << 0),
124 RENAME_EXCHANGE
=> (1 << 1),
125 RENAME_WHITEOUT
=> (1 << 2)};
129 MS_NOSUID
=> (1 << 1),
130 MS_NODEV
=> (1 << 2),
131 MS_NOEXEC
=> (1 << 3),
132 MS_SYNCHRONOUS
=> (1 << 4),
133 MS_REMOUNT
=> (1 << 5),
134 MS_MANDLOCK
=> (1 << 6),
135 MS_DIRSYNC
=> (1 << 7),
136 MS_NOSYMFOLLOW
=> (1 << 8),
137 MS_NOATIME
=> (1 << 10),
138 MS_NODIRATIME
=> (1 << 11),
139 MS_BIND
=> (1 << 12),
140 MS_MOVE
=> (1 << 13),
144 sub run_with_timeout
{
145 my ($timeout, $code, @param) = @_;
147 die "got timeout\n" if $timeout <= 0;
149 my $prev_alarm = alarm 0; # suspend outer alarm early
157 local $SIG{ALRM
} = sub { $sigcount++; $got_timeout = 1; die "got timeout\n"; };
158 local $SIG{PIPE
} = sub { $sigcount++; die "broken pipe\n" };
159 local $SIG{__DIE__
}; # see SA bug 4631
163 eval { $res = &$code(@param); };
165 alarm(0); # avoid race conditions
174 # this shouldn't happen anymore?
175 die "unknown error" if $sigcount && !$err; # seems to happen sometimes
177 # assume that user handles timeout err if called in list context
178 die $err if $err && (!wantarray || !$got_timeout);
180 return wantarray ?
($res, $got_timeout) : $res;
183 # flock: we use one file handle per process, so lock file
184 # can be nested multiple times and succeeds for the same process.
186 # Since this is the only way we lock now and we don't have the old
187 # 'lock(); code(); unlock();' pattern anymore we do not actually need to
188 # count how deep we're nesting. Therefore this hash now stores a weak reference
189 # to a boolean telling us whether we already have a lock.
191 my $lock_handles = {};
194 my ($filename, $timeout, $shared, $code, @param) = @_;
196 $timeout = 10 if !$timeout;
198 my $mode = $shared ? LOCK_SH
: LOCK_EX
;
200 my $lockhash = ($lock_handles->{$$} //= {});
202 # Returns a locked file handle.
203 my $get_locked_file = sub {
204 my $fh = IO
::File-
>new(">>$filename")
205 or die "can't open file - $!\n";
207 if (!flock($fh, $mode|LOCK_NB
)) {
208 print STDERR
"trying to acquire lock...\n";
211 $success = flock($fh, $mode);
212 # try again on EINTR (see bug #273)
213 if ($success || ($! != EINTR
)) {
218 print STDERR
" failed\n";
219 die "can't acquire lock '$filename' - $!\n";
221 print STDERR
" OK\n";
228 my $checkptr = $lockhash->{$filename};
229 my $check = 0; # This must not go out of scope before running the code.
230 my $local_fh; # This must stay local
231 if (!$checkptr || !$$checkptr) {
232 # We cannot create a weak reference in a single atomic step, so we first
233 # create a false-value, then create a reference to it, then weaken it,
234 # and after successfully locking the file we change the boolean value.
236 # The reason for this is that if an outer SIGALRM throws an exception
237 # between creating the reference and weakening it, a subsequent call to
238 # lock_file_full() will see a leftover full reference to a valid
239 # variable. This variable must be 0 in order for said call to attempt to
240 # lock the file anew.
242 # An externally triggered exception elsewhere in the code will cause the
243 # weak reference to become 'undef', and since the file handle is only
244 # stored in the local scope in $local_fh, the file will be closed by
245 # perl's cleanup routines as well.
247 # This still assumes that an IO::File handle can properly deal with such
248 # exceptions thrown during its own destruction, but that's up to perls
250 $lockhash->{$filename} = \
$check;
251 weaken
$lockhash->{$filename};
252 $local_fh = eval { run_with_timeout
($timeout, $get_locked_file) };
254 $@ = "can't lock file '$filename' - $@";
259 $res = eval { &$code(@param); };
266 my ($filename, $timeout, $code, @param) = @_;
268 return lock_file_full
($filename, $timeout, 0, $code, @param);
271 sub file_set_contents
{
272 my ($filename, $data, $perm, $force_utf8) = @_;
274 $perm = 0644 if !defined($perm);
276 my $tmpname = "$filename.tmp.$$";
279 my ($fh, $tries) = (undef, 0);
280 while (!$fh && $tries++ < 3) {
281 $fh = IO
::File-
>new($tmpname, O_WRONLY
|O_CREAT
|O_EXCL
, $perm);
282 if (!$fh && $! == EEXIST
) {
283 unlink($tmpname) or die "unable to delete old temp file: $!\n";
286 die "unable to open file '$tmpname' - $!\n" if !$fh;
288 binmode($fh, ":encoding(UTF-8)") if $force_utf8;
290 die "unable to write '$tmpname' - $!\n" unless print $fh $data;
291 die "closing file '$tmpname' failed - $!\n" unless close $fh;
300 if (!rename($tmpname, $filename)) {
301 my $msg = "close (rename) atomic file '$filename' failed: $!\n";
307 sub file_get_contents
{
308 my ($filename, $max) = @_;
310 my $fh = IO
::File-
>new($filename, "r") ||
311 die "can't open '$filename' - $!\n";
313 my $content = safe_read_from
($fh, $max, 0, $filename);
321 my ($filename, $dst, $max, $perm) = @_;
323 file_set_contents
($dst, file_get_contents
($filename, $max), $perm);
326 sub file_read_firstline
{
329 my $fh = IO
::File-
>new ($filename, "r");
331 return undef if $! == POSIX
::ENOENT
;
332 die "file '$filename' exists but open for reading failed - $!\n";
341 my ($fh, $max, $oneline, $filename) = @_;
343 # pmxcfs file size limit
344 $max = 1024 * 1024 if !$max;
346 my $subject = defined($filename) ?
"file '$filename'" : 'input';
351 while ($count = sysread($fh, $input, 8192, $br)) {
353 die "$subject too long - aborting\n" if $br > $max;
354 if ($oneline && $input =~ m/^(.*)\n/) {
359 die "unable to read $subject - $!\n" if !defined($count);
364 # The $cmd parameter can be:
366 # This is generally executed by passing it to the shell with the -c option.
367 # However, it can be executed in one of two ways, depending on whether
368 # there's a pipe involved:
369 # *) with pipe: passed explicitly to bash -c, prefixed with:
371 # *) without a pipe: passed to perl's open3 which uses 'sh -c'
372 # (Note that this may result in two different syntax requirements!)
374 # -) an array of arguments (strings)
375 # Will be executed without interference from a shell. (Parameters are passed
376 # as is, no escape sequences of strings will be touched.)
377 # -) an array of arrays
378 # Each array represents a command, and each command's output is piped into
379 # the following command's standard input.
380 # For this a shell command string is created with pipe symbols between each
382 # Each command is a list of strings meant to end up in the final command
383 # unchanged. In order to achieve this, every argument is shell-quoted.
384 # Quoting can be disabled for a particular argument by turning it into a
385 # reference, this allows inserting arbitrary shell options.
386 # For instance: the $cmd [ [ 'echo', 'hello', \'>/dev/null' ] ] will not
387 # produce any output, while the $cmd [ [ 'echo', 'hello', '>/dev/null' ] ]
388 # will literally print: hello >/dev/null
390 my ($cmd, %param) = @_;
395 if (my $ref = ref($cmd)) {
396 if (ref($cmd->[0])) {
397 $cmdstr = 'set -o pipefail && ';
399 foreach my $command (@$cmd) {
400 # concatenate quoted parameters
401 # strings which are passed by reference are NOT shell quoted
402 $cmdstr .= $pipe . join(' ', map { ref($_) ?
$$_ : shellquote
($_) } @$command);
405 $cmd = [ '/bin/bash', '-c', "$cmdstr" ];
407 $cmdstr = cmd2string
($cmd);
412 # see 'man bash' for option pipefail
413 $cmd = [ '/bin/bash', '-c', "set -o pipefail && $cmd" ];
438 foreach my $p (keys %param) {
439 if ($p eq 'timeout') {
440 $timeout = $param{$p};
441 } elsif ($p eq 'umask') {
442 $old_umask = umask($param{$p});
443 } elsif ($p eq 'errmsg') {
444 $errmsg = $param{$p};
445 } elsif ($p eq 'input') {
447 } elsif ($p eq 'output') {
448 $output = $param{$p};
449 } elsif ($p eq 'outfunc') {
450 $outfunc = $param{$p};
451 } elsif ($p eq 'errfunc') {
452 $errfunc = $param{$p};
453 } elsif ($p eq 'logfunc') {
454 $logfunc = $param{$p};
455 } elsif ($p eq 'afterfork') {
456 $afterfork = $param{$p};
457 } elsif ($p eq 'noerr') {
459 } elsif ($p eq 'keeplocale') {
460 $keeplocale = $param{$p};
461 } elsif ($p eq 'quiet') {
464 die "got unknown parameter '$p' for run_command\n";
469 my $origerrfunc = $errfunc;
473 &$origerrfunc("$laststderr\n");
475 print STDERR
"$laststderr\n" if $laststderr;
482 my $reader = $output && $output =~ m/^>&/ ?
$output : IO
::File-
>new();
483 my $writer = $input && $input =~ m/^<&/ ?
$input : IO
::File-
>new();
484 my $error = IO
::File-
>new();
489 local $ENV{LC_ALL
} = 'C' if !$keeplocale;
491 # suppress LVM warnings like: "File descriptor 3 left open";
492 local $ENV{LVM_SUPPRESS_FD_WARNINGS
} = "1";
494 $pid = open3
($writer, $reader, $error, @$cmd) || die $!;
496 # if we pipe fron STDIN, open3 closes STDIN, so we get a perl warning like
497 # "Filehandle STDIN reopened as GENXYZ .. " as soon as we open a new file.
498 # to avoid that we open /dev/null
499 if (!ref($writer) && !defined(fileno(STDIN
))) {
501 open(STDIN
, '<', '/dev/null');
508 if ($orig_pid != $$) {
516 local $SIG{ALRM
} = sub { die "got timeout\n"; } if $timeout;
517 $oldtimeout = alarm($timeout) if $timeout;
519 &$afterfork() if $afterfork;
522 print $writer $input if defined $input;
526 my $select = IO
::Select-
>new();
527 $select->add($reader) if ref($reader);
528 $select->add($error);
533 my $starttime = time();
535 while ($select->count) {
536 my @handles = $select->can_read(1);
538 foreach my $h (@handles) {
540 my $count = sysread ($h, $buf, 4096);
541 if (!defined ($count)) {
547 $select->remove ($h) if !$count;
549 if ($outfunc || $logfunc) {
551 while ($buf =~ s/^([^\010\r\n]*)(?:\n|(?:\010)+|\r\n?)//) {
552 my $line = $outlog . $1;
554 &$outfunc($line) if $outfunc;
555 &$logfunc($line) if $logfunc;
569 } elsif ($h eq $error) {
570 if ($errfunc || $logfunc) {
572 while ($buf =~ s/^([^\010\r\n]*)(?:\n|(?:\010)+|\r\n?)//) {
573 my $line = $errlog . $1;
575 &$errfunc($line) if $errfunc;
576 &$logfunc($line) if $logfunc;
594 &$outfunc($outlog) if $outfunc && $outlog;
595 &$logfunc($outlog) if $logfunc && $outlog;
597 &$errfunc($errlog) if $errfunc && $errlog;
598 &$logfunc($errlog) if $logfunc && $errlog;
603 die "failed to execute\n";
604 } elsif (my $sig = ($? & 127)) {
605 die "got signal $sig\n";
606 } elsif ($exitcode = ($? >> 8)) {
607 if (!($exitcode == 24 && ($cmdstr =~ m
|^(\S
+/)?rsync\s
|))) {
608 if ($errmsg && $laststderr) {
609 my $lerr = $laststderr;
613 die "exit code $exitcode\n";
624 if ($errmsg && $laststderr) {
625 &$errfunc(undef); # flush laststderr
628 umask ($old_umask) if defined($old_umask);
630 alarm($oldtimeout) if $oldtimeout;
633 if ($pid && ($err eq "got timeout\n")) {
636 die "command '$cmdstr' failed: $err";
640 $err =~ s/^usermod:\s*// if $cmdstr =~ m
|^(\S
+/)?usermod\s
|;
643 die "command '$cmdstr' failed: $err";
650 # Run a command with a tcp socket as standard input.
651 sub pipe_socket_to_command
{
652 my ($cmd, $ip, $port) = @_;
657 Proto
=> &Socket
::IPPROTO_TCP
,
658 GetAddrInfoFlags
=> 0,
662 my $socket = IO
::Socket
::IP-
>new(%$params) or die "failed to open socket: $!\n";
664 print "$ip\n$port\n"; # tell remote where to connect
668 local $SIG{ALRM
} = sub { die "timed out waiting for client\n" };
670 my $client = $socket->accept; # Wait for a client
674 # We want that the command talks over the TCP socket and takes
675 # ownership of it, so that when it closes it the connection is
676 # terminated, so we need to be able to close the socket. So we
677 # can't really use PVE::Tools::run_command().
678 my $pid = fork() // die "fork failed: $!\n";
680 POSIX
::dup2
(fileno($client), 0);
681 POSIX
::dup2
(fileno($client), 1);
683 exec {$cmd->[0]} @$cmd or do {
684 warn "exec failed: $!\n";
690 if (waitpid($pid, 0) != $pid) {
691 kill(15 => $pid); # if we got interrupted terminate the child
693 while (waitpid($pid, POSIX
::WNOHANG
) != $pid) {
696 kill(9 => $pid), last if $count > 300; # 30 second timeout
699 if (my $sig = ($? & 127)) {
700 die "got signal $sig\n";
701 } elsif (my $exitcode = ($? >> 8)) {
702 die "exit code $exitcode\n";
709 my $listtxt = shift // '';
711 return split (/\0/, $listtxt) if $listtxt =~ m/\0/;
713 $listtxt =~ s/[,;]/ /g;
714 $listtxt =~ s/^\s+//;
716 my @data = split (/\s+/, $listtxt);
724 return $txt if !defined($txt);
732 # simple uri templates like "/vms/{vmid}"
733 sub template_replace
{
734 my ($tmpl, $data) = @_;
736 return $tmpl if !$tmpl;
739 while ($tmpl =~ m/([^{]+)?(\{([^}]+)\})?/g) {
741 $res .= ($data->{$3} || '-') if $2;
747 my ($filename, $fh, $data) = @_;
751 my $res = print $fh $data;
753 die "write to '$filename' failed\n" if !$res;
759 'at' => 'ftp.at.debian.org',
760 'au' => 'ftp.au.debian.org',
761 'be' => 'ftp.be.debian.org',
762 'bg' => 'ftp.bg.debian.org',
763 'br' => 'ftp.br.debian.org',
764 'ca' => 'ftp.ca.debian.org',
765 'ch' => 'ftp.ch.debian.org',
766 'cl' => 'ftp.cl.debian.org',
767 'cz' => 'ftp.cz.debian.org',
768 'de' => 'ftp.de.debian.org',
769 'dk' => 'ftp.dk.debian.org',
770 'ee' => 'ftp.ee.debian.org',
771 'es' => 'ftp.es.debian.org',
772 'fi' => 'ftp.fi.debian.org',
773 'fr' => 'ftp.fr.debian.org',
774 'gr' => 'ftp.gr.debian.org',
775 'hk' => 'ftp.hk.debian.org',
776 'hr' => 'ftp.hr.debian.org',
777 'hu' => 'ftp.hu.debian.org',
778 'ie' => 'ftp.ie.debian.org',
779 'is' => 'ftp.is.debian.org',
780 'it' => 'ftp.it.debian.org',
781 'jp' => 'ftp.jp.debian.org',
782 'kr' => 'ftp.kr.debian.org',
783 'mx' => 'ftp.mx.debian.org',
784 'nl' => 'ftp.nl.debian.org',
785 'no' => 'ftp.no.debian.org',
786 'nz' => 'ftp.nz.debian.org',
787 'pl' => 'ftp.pl.debian.org',
788 'pt' => 'ftp.pt.debian.org',
789 'ro' => 'ftp.ro.debian.org',
790 'ru' => 'ftp.ru.debian.org',
791 'se' => 'ftp.se.debian.org',
792 'si' => 'ftp.si.debian.org',
793 'sk' => 'ftp.sk.debian.org',
794 'tr' => 'ftp.tr.debian.org',
795 'tw' => 'ftp.tw.debian.org',
796 'gb' => 'ftp.uk.debian.org',
797 'us' => 'ftp.us.debian.org',
802 'dk' => ['Danish', 'da', 'qwerty/dk-latin1.kmap.gz', 'dk', 'nodeadkeys'],
803 'de' => ['German', 'de', 'qwertz/de-latin1-nodeadkeys.kmap.gz', 'de', 'nodeadkeys' ],
804 'de-ch' => ['Swiss-German', 'de-ch', 'qwertz/sg-latin1.kmap.gz', 'ch', 'de_nodeadkeys' ],
805 'en-gb' => ['United Kingdom', 'en-gb', 'qwerty/uk.kmap.gz' , 'gb', undef],
806 'en-us' => ['U.S. English', 'en-us', 'qwerty/us-latin1.kmap.gz', 'us', undef ],
807 'es' => ['Spanish', 'es', 'qwerty/es.kmap.gz', 'es', 'nodeadkeys'],
808 #'et' => [], # Ethopia or Estonia ??
809 'fi' => ['Finnish', 'fi', 'qwerty/fi-latin1.kmap.gz', 'fi', 'nodeadkeys'],
810 #'fo' => ['Faroe Islands', 'fo', ???, 'fo', 'nodeadkeys'],
811 'fr' => ['French', 'fr', 'azerty/fr-latin1.kmap.gz', 'fr', 'nodeadkeys'],
812 'fr-be' => ['Belgium-French', 'fr-be', 'azerty/be2-latin1.kmap.gz', 'be', 'nodeadkeys'],
813 'fr-ca' => ['Canada-French', 'fr-ca', 'qwerty/cf.kmap.gz', 'ca', 'fr-legacy'],
814 'fr-ch' => ['Swiss-French', 'fr-ch', 'qwertz/fr_CH-latin1.kmap.gz', 'ch', 'fr_nodeadkeys'],
815 #'hr' => ['Croatia', 'hr', 'qwertz/croat.kmap.gz', 'hr', ??], # latin2?
816 'hu' => ['Hungarian', 'hu', 'qwertz/hu.kmap.gz', 'hu', undef],
817 'is' => ['Icelandic', 'is', 'qwerty/is-latin1.kmap.gz', 'is', 'nodeadkeys'],
818 'it' => ['Italian', 'it', 'qwerty/it2.kmap.gz', 'it', 'nodeadkeys'],
819 'jp' => ['Japanese', 'ja', 'qwerty/jp106.kmap.gz', 'jp', undef],
820 'lt' => ['Lithuanian', 'lt', 'qwerty/lt.kmap.gz', 'lt', 'std'],
821 #'lv' => ['Latvian', 'lv', 'qwerty/lv-latin4.kmap.gz', 'lv', ??], # latin4 or latin7?
822 'mk' => ['Macedonian', 'mk', 'qwerty/mk.kmap.gz', 'mk', 'nodeadkeys'],
823 'nl' => ['Dutch', 'nl', 'qwerty/nl.kmap.gz', 'nl', undef],
824 #'nl-be' => ['Belgium-Dutch', 'nl-be', ?, ?, ?],
825 'no' => ['Norwegian', 'no', 'qwerty/no-latin1.kmap.gz', 'no', 'nodeadkeys'],
826 'pl' => ['Polish', 'pl', 'qwerty/pl.kmap.gz', 'pl', undef],
827 'pt' => ['Portuguese', 'pt', 'qwerty/pt-latin1.kmap.gz', 'pt', 'nodeadkeys'],
828 'pt-br' => ['Brazil-Portuguese', 'pt-br', 'qwerty/br-latin1.kmap.gz', 'br', 'nodeadkeys'],
829 #'ru' => ['Russian', 'ru', 'qwerty/ru.kmap.gz', 'ru', undef], # don't know?
830 'si' => ['Slovenian', 'sl', 'qwertz/slovene.kmap.gz', 'si', undef],
831 'se' => ['Swedish', 'sv', 'qwerty/se-latin1.kmap.gz', 'se', 'nodeadkeys'],
833 'tr' => ['Turkish', 'tr', 'qwerty/trq.kmap.gz', 'tr', undef],
836 my $kvmkeymaparray = [];
837 foreach my $lc (sort keys %$keymaphash) {
838 push @$kvmkeymaparray, $keymaphash->{$lc}->[1];
846 return $kvmkeymaparray;
850 my ($param, $key) = @_;
852 my $res = $param->{$key};
853 delete $param->{$key};
858 # For extracting sensitive keys (e.g. password), to avoid writing them to www-data owned configs
859 sub extract_sensitive_params
:prototype($$$) {
860 my ($param, $sensitive_list, $delete_list) = @_;
862 my %delete = map { $_ => 1 } ($delete_list || [])->@*;
865 for my $opt (@$sensitive_list) {
866 # handle deletions as explicitly setting `undef`, so subs which only have $param but not
867 # $delete_list available can recognize them. Afterwards new values may override.
868 if (exists($delete{$opt})) {
869 $sensitive->{$opt} = undef;
872 if (defined(my $value = extract_param
($param, $opt))) {
873 $sensitive->{$opt} = $value;
880 # Note: we use this to wait until vncterm/spiceterm is ready
881 sub wait_for_vnc_port
{
882 my ($port, $family, $timeout) = @_;
884 $timeout = 5 if !$timeout;
886 my $starttime = [gettimeofday
];
889 my $cmd = ['/bin/ss', '-Htln', "sport = :$port"];
890 push @$cmd, $family == AF_INET6 ?
'-6' : '-4' if defined($family);
893 while (($elapsed = tv_interval
($starttime)) < $timeout) {
894 # -Htln = don't print header, tcp, listening sockets only, numeric ports
895 run_command
($cmd, outfunc
=> sub {
897 if ($line =~ m/^LISTEN\s+\d+\s+\d+\s+\S+:(\d+)\s/) {
898 $found = 1 if ($port == $1);
902 $sleeptime += 100000 if $sleeptime < 1000000;
906 die "Timeout while waiting for port '$port' to get ready!\n";
909 sub next_unused_port
{
910 my ($range_start, $range_end, $family, $address) = @_;
912 # We use a file to register allocated ports.
913 # Those registrations expires after $expiretime.
914 # We use this to avoid race conditions between
915 # allocation and use of ports.
917 my $filename = "/var/tmp/pve-reserved-ports";
926 if (my $fh = IO
::File-
>new ($filename, "r")) {
927 while (my $line = <$fh>) {
928 if ($line =~ m/^(\d+)\s(\d+)$/) {
929 my ($port, $timestamp) = ($1, $2);
930 if (($timestamp + $expiretime) > $ctime) {
931 $ports->{$port} = $timestamp; # not expired
938 my %sockargs = (Listen
=> 5,
941 Proto
=> IPPROTO_TCP
,
942 GetAddrInfoFlags
=> 0);
943 $sockargs{LocalAddr
} = $address if defined($address);
945 for (my $p = $range_start; $p < $range_end; $p++) {
946 next if $ports->{$p}; # reserved
948 $sockargs{LocalPort
} = $p;
949 my $sock = IO
::Socket
::IP-
>new(%sockargs);
954 $ports->{$p} = $ctime;
960 foreach my $p (keys %$ports) {
961 $data .= "$p $ports->{$p}\n";
964 file_set_contents
($filename, $data);
969 my $p = lock_file
('/var/lock/pve-ports.lck', 10, $code);
972 die "unable to find free port (${range_start}-${range_end})\n" if !$p;
977 sub next_migrate_port
{
978 my ($family, $address) = @_;
979 return next_unused_port
(60000, 60050, $family, $address);
983 my ($family, $address) = @_;
984 return next_unused_port
(5900, 6000, $family, $address);
987 sub spice_port_range
{
988 return (61000, 61999);
991 sub next_spice_port
{
992 my ($family, $address) = @_;
993 return next_unused_port
(spice_port_range
(), $family, $address);
998 eval { $value = "$value" };
999 return "error turning value into a string: $@" if $@;
1003 # sigkill after $timeout a $sub running in a fork if it can't write a pipe
1004 # the $sub has to return a single scalar
1005 sub run_fork_with_timeout
{
1006 my ($timeout, $sub) = @_;
1010 my $pipe_out = IO
::Pipe-
>new();
1012 # disable pending alarms, save their remaining time
1013 my $prev_alarm = alarm 0;
1015 # avoid leaving a zombie if the parent gets interrupted
1019 if (!defined($child)) {
1020 die "fork failed: $!\n";
1025 $pipe_out->writer();
1029 print {$pipe_out} encode_json
({ result
=> $res });
1033 print {$pipe_out} encode_json
({ error
=> must_stringify
($err) });
1040 local $SIG{INT
} = sub { $sig_received++; };
1041 local $SIG{TERM
} = sub {
1042 $error //= "interrupted by unexpected signal\n";
1043 kill('TERM', $child);
1046 $pipe_out->reader();
1048 my $readvalues = sub {
1050 my $child_res = decode_json
(readline_nointr
($pipe_out));
1051 $res = $child_res->{result
};
1052 $error = $child_res->{error
};
1055 my $got_timeout = 0;
1056 my $wantarray = wantarray; # so it can be queried inside eval
1058 if (defined($timeout)) {
1060 (undef, $got_timeout) = run_with_timeout
($timeout, $readvalues);
1062 run_with_timeout
($timeout, $readvalues);
1070 kill('KILL', $child);
1071 # FIXME: hangs if $child doesn't exits?! (D state)
1075 die "interrupted by unexpected signal\n" if $sig_received;
1077 die $error if $error;
1078 return wantarray ?
($res, $got_timeout) : $res;
1083 return run_fork_with_timeout
(undef, $code);
1086 # NOTE: NFS syscall can't be interrupted, so alarm does
1087 # not work to provide timeouts.
1088 # from 'man nfs': "Only SIGKILL can interrupt a pending NFS operation"
1089 # So fork() before using Filesys::Df
1091 my ($path, $timeout) = @_;
1093 my $df = sub { return Filesys
::Df
::df
($path, 1) };
1095 my $res = eval { run_fork_with_timeout
($timeout, $df) } // {};
1098 # untaint, but be flexible: PB usage can result in scientific notation
1099 my ($blocks, $used, $bavail) = map { defined($_) ?
(/^([\d\.e\-+]+)$/) : 0 }
1100 $res->@{qw(blocks used bavail)};
1110 my ($path, $timeout) = @_;
1119 if ($line =~ m/^(\d+)\s+total$/) {
1124 run_command
(['du', '-scb', $path], outfunc
=> $parser, timeout
=> $timeout);
1130 # We use this to uniquely identify a process.
1131 # An 'Unique Process ID' has the following format:
1132 # "UPID:$node:$pid:$pstart:$startime:$dtype:$id:$user"
1137 # Note: pstart can be > 32bit if uptime > 497 days, so this can result in
1138 # more that 8 characters for pstart
1139 return sprintf("UPID:%s:%08X:%08X:%08X:%s:%s:%s:", $d->{node
}, $d->{pid
},
1140 $d->{pstart
}, $d->{starttime
}, $d->{type
}, $d->{id
},
1145 my ($upid, $noerr) = @_;
1150 # "UPID:$node:$pid:$pstart:$startime:$dtype:$id:$user"
1151 # Note: allow up to 9 characters for pstart (work until 20 years uptime)
1152 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]+):$/) {
1154 $res->{pid
} = hex($3);
1155 $res->{pstart
} = hex($4);
1156 $res->{starttime
} = hex($5);
1161 my $subdir = substr($5, 7, 8);
1162 $filename = "$pvetaskdir/$subdir/$upid";
1165 return undef if $noerr;
1166 die "unable to parse worker upid '$upid'\n";
1169 return wantarray ?
($res, $filename) : $res;
1175 my ($task, $filename) = upid_decode
($upid);
1177 my $dirname = dirname
($filename);
1178 make_path
($dirname);
1180 my $wwwid = getpwnam('www-data') ||
1181 die "getpwnam failed";
1185 my $outfh = IO
::File-
>new ($filename, O_WRONLY
|O_CREAT
|O_EXCL
, $perm) ||
1186 die "unable to create output file '$filename' - $!\n";
1187 chown $wwwid, -1, $outfh;
1192 sub upid_read_status
{
1195 my ($task, $filename) = upid_decode
($upid);
1196 my $fh = IO
::File-
>new($filename, "r");
1197 return "unable to open file - $!" if !$fh;
1199 sysseek($fh, -$maxlen, 2);
1201 my $br = sysread($fh, $readbuf, $maxlen);
1204 return "unable to extract last line"
1205 if $readbuf !~ m/\n?(.+)$/;
1207 if ($line =~ m/^TASK OK$/) {
1209 } elsif ($line =~ m/^TASK ERROR: (.+)$/) {
1211 } elsif ($line =~ m/^TASK (WARNINGS: \d+)$/) {
1214 return "unexpected status";
1217 return "unable to read tail (got $br bytes)";
1220 # Check if the status returned by upid_read_status is an error status.
1221 # If the status could not be parsed it's also treated as an error.
1222 sub upid_status_is_error
{
1225 return !($status eq 'OK' || $status =~ m/^WARNINGS: \d+$/);
1228 # takes the parsed status and returns the type, either ok, warning, error or unknown
1229 sub upid_normalize_status_type
{
1234 } elsif ($status eq 'OK') {
1236 } elsif ($status =~ m/^WARNINGS: \d+$/) {
1238 } elsif ($status eq 'unexpected status') {
1245 # useful functions to store comments in config files
1249 # all control and hi-bit characters, ':' and '%'
1250 my $unsafe = "^\x20-\x24\x26-\x39\x3b-\x7e";
1251 return uri_escape
(Encode
::encode
("utf8", $text), $unsafe);
1257 return Encode
::decode
("utf8", uri_unescape
($data));
1260 # NOTE: deprecated - do not use! we now decode all parameters by default
1261 sub decode_utf8_parameters
{
1264 foreach my $p (qw(comment description firstname lastname)) {
1265 $param->{$p} = decode
('utf8', $param->{$p}) if $param->{$p};
1271 sub random_ether_addr
{
1274 my ($seconds, $microseconds) = gettimeofday
;
1276 my $rand = Digest
::SHA
::sha1
($$, rand(), $seconds, $microseconds);
1278 # clear multicast, set local id
1279 vec($rand, 0, 8) = (vec($rand, 0, 8) & 0xfe) | 2;
1281 my $addr = sprintf("%02X:%02X:%02X:%02X:%02X:%02X", unpack("C6", $rand));
1282 if (defined($prefix)) {
1283 $addr = uc($prefix) . substr($addr, length($prefix));
1291 return String
::ShellQuote
::shell_quote
($str);
1297 die "no arguments" if !$cmd;
1299 return $cmd if !ref($cmd);
1302 foreach my $arg (@$cmd) { push @qa, shellquote
($arg); }
1304 return join (' ', @qa);
1307 # split an shell argument string into an array,
1311 return $str ?
[ Text
::ParseWords
::shellwords
($str) ] : [];
1314 sub dump_logfile_by_filehandle
{
1315 my ($fh, $filter, $state) = @_;
1317 my $count = ($state->{count
} //= 0);
1318 my $lines = ($state->{lines
} //= []);
1319 my $start = ($state->{start
} //= 0);
1320 my $limit = ($state->{limit
} //= 50);
1321 my $final = ($state->{final
} //= 1);
1322 my $read_until_end = ($state->{read_until_end
} //= $limit == 0);
1326 # duplicate code, so that we do not slow down normal path
1327 while (defined($line = <$fh>)) {
1328 if (ref($filter) eq 'CODE') {
1329 next if !$filter->($line);
1331 next if $line !~ m/$filter/;
1333 next if $count++ < $start;
1334 if (!$read_until_end) {
1335 next if $limit <= 0;
1339 push @$lines, { n
=> $count, t
=> $line};
1342 while (defined($line = <$fh>)) {
1343 next if $count++ < $start;
1344 if (!$read_until_end) {
1345 next if $limit <= 0;
1349 push @$lines, { n
=> $count, t
=> $line};
1353 # HACK: ExtJS store.guaranteeRange() does not like empty array
1355 if (!$count && $final) {
1357 push @$lines, { n
=> $count, t
=> "no content"};
1360 $state->{count
} = $count;
1361 $state->{limit
} = $limit;
1365 my ($filename, $start, $limit, $filter) = @_;
1367 my $fh = IO
::File-
>new($filename, "r");
1369 return (1, { n
=> 1, t
=> "unable to open file - $!"});
1379 dump_logfile_by_filehandle
($fh, $filter, \
%state);
1383 return ($state{'count'}, $state{'lines'});
1387 my ($start, $limit, $since, $until, $service) = @_;
1392 $start = 0 if !$start;
1393 $limit = 50 if !$limit;
1398 return if $count++ < $start;
1399 return if $limit <= 0;
1400 push @$lines, { n
=> int($count), t
=> $line};
1404 my $cmd = ['journalctl', '-o', 'short', '--no-pager'];
1406 push @$cmd, '--unit', $service if $service;
1407 push @$cmd, '--since', $since if $since;
1408 push @$cmd, '--until', $until if $until;
1409 run_command
($cmd, outfunc
=> $parser);
1411 # HACK: ExtJS store.guaranteeRange() does not like empty array
1415 push @$lines, { n
=> $count, t
=> "no content"};
1418 return ($count, $lines);
1421 sub dir_glob_regex
{
1422 my ($dir, $regex) = @_;
1424 my $dh = IO
::Dir-
>new ($dir);
1425 return wantarray ?
() : undef if !$dh;
1427 while (defined(my $tmp = $dh->read)) {
1428 if (my @res = $tmp =~ m/^($regex)$/) {
1430 return wantarray ?
@res : $tmp;
1435 return wantarray ?
() : undef;
1438 sub dir_glob_foreach
{
1439 my ($dir, $regex, $func) = @_;
1441 my $dh = IO
::Dir-
>new ($dir);
1443 while (defined(my $tmp = $dh->read)) {
1444 if (my @res = $tmp =~ m/^($regex)$/) {
1451 sub assert_if_modified
{
1452 my ($digest1, $digest2) = @_;
1454 if ($digest1 && $digest2 && ($digest1 ne $digest2)) {
1455 die "detected modified configuration - file changed by other user? Try again.\n";
1459 # Digest for short strings
1460 # like FNV32a, but we only return 31 bits (positive numbers)
1464 my $hval = 0x811c9dc5;
1466 foreach my $c (unpack('C*', $string)) {
1474 $hval = $hval & 0xffffffff;
1476 return $hval & 0x7fffffff;
1479 sub fnv31a_hex
{ return sprintf("%X", fnv31a
(@_)); }
1481 sub unpack_sockaddr_in46
{
1483 my $family = Socket
::sockaddr_family
($sin);
1484 my ($port, $host) = ($family == AF_INET6 ? Socket
::unpack_sockaddr_in6
($sin)
1485 : Socket
::unpack_sockaddr_in
($sin));
1486 return ($family, $port, $host);
1489 sub getaddrinfo_all
{
1490 my ($hostname, @opts) = @_;
1492 flags
=> AI_V4MAPPED
| AI_ALL
,
1495 my ($err, @res) = Socket
::getaddrinfo
($hostname, '0', \
%hints);
1496 die "failed to get address info for: $hostname: $err\n" if $err;
1500 sub get_host_address_family
{
1501 my ($hostname, $socktype) = @_;
1502 my @res = getaddrinfo_all
($hostname, socktype
=> $socktype);
1503 return $res[0]->{family
};
1506 # get the fully qualified domain name of a host
1507 # same logic as hostname(1): The FQDN is the name getaddrinfo(3) returns,
1508 # given a nodename as a parameter
1510 my ($nodename) = @_;
1513 flags
=> AI_CANONNAME
,
1514 socktype
=> SOCK_DGRAM
1517 my ($err, @addrs) = Socket
::getaddrinfo
($nodename, undef, $hints);
1519 die "getaddrinfo: $err" if $err;
1521 return $addrs[0]->{canonname
};
1524 # Parses any sane kind of host, or host+port pair:
1525 # The port is always optional and thus may be undef.
1526 sub parse_host_and_port
{
1528 if ($address =~ /^($IPV4RE|[[:alnum:]\-.]+)(?::(\d+))?$/ || # ipv4 or host with optional ':port'
1529 $address =~ /^\[($IPV6RE|$IPV4RE|[[:alnum:]\-.]+)\](?::(\d+))?$/ || # anything in brackets with optional ':port'
1530 $address =~ /^($IPV6RE)(?:\.(\d+))?$/) # ipv6 with optional port separated by dot
1532 return ($1, $2, 1); # end with 1 to support simple if(parse...) tests
1537 sub setresuid
($$$) {
1538 my ($ruid, $euid, $suid) = @_;
1539 return 0 == syscall(PVE
::Syscall
::setresuid
, int($ruid), int($euid), int($suid));
1544 return 0 == syscall(PVE
::Syscall
::unshare
, int($flags));
1548 my ($fileno, $nstype) = @_;
1549 return 0 == syscall(PVE
::Syscall
::setns
, int($fileno), int($nstype));
1554 return 0 == syscall(PVE
::Syscall
::syncfs
, int($fileno));
1559 return 0 == syscall(PVE
::Syscall
::fsync
, int($fileno));
1562 sub renameat2
($$$$$) {
1563 my ($olddirfd, $oldpath, $newdirfd, $newpath, $flags) = @_;
1564 return 0 == syscall(
1565 PVE
::Syscall
::renameat2
,
1574 sub sync_mountpoint
{
1576 sysopen my $fd, $path, O_RDONLY
|O_CLOEXEC
or die "failed to open $path: $!\n";
1578 if (!syncfs
(fileno($fd))) {
1582 die "syncfs '$path' failed - $syncfs_err\n" if defined $syncfs_err;
1585 my sub check_mail_addr
{
1587 die "'$addr' does not look like a valid email address or username\n"
1588 if $addr !~ /^$EMAIL_RE$/ && $addr !~ /^$EMAIL_USER_RE$/;
1591 # support sending multi-part mail messages with a text and or a HTML part
1592 # mailto may be a single email string or an array of receivers
1594 my ($mailto, $subject, $text, $html, $mailfrom, $author) = @_;
1596 $mailto = [ $mailto ] if !ref($mailto);
1598 check_mail_addr
($_) for $mailto->@*;
1599 my $to_quoted = [ map { shellquote
($_) } $mailto->@* ];
1601 $mailfrom = $mailfrom || "root";
1602 check_mail_addr
($mailfrom);
1603 my $from_quoted = shellquote
($mailfrom);
1605 $author = $author // 'Proxmox VE';
1607 open (my $mail, "|-", "sendmail", "-B", "8BITMIME", "-f", $from_quoted, "--", $to_quoted->@*)
1608 or die "unable to open 'sendmail' - $!";
1610 my $is_multipart = $text && $html;
1611 my $boundary = "----_=_NextPart_001_" . int(time()) . $$; # multipart spec, see rfc 1521
1613 $subject = Encode
::encode
('MIME-Header', $subject) if $subject =~ /[^[:ascii:]]/;
1615 print $mail "MIME-Version: 1.0\n" if $subject =~ /[^[:ascii:]]/ || $is_multipart;
1617 print $mail "From: $author <$mailfrom>\n";
1618 print $mail "To: " . join(', ', @$mailto) ."\n";
1619 print $mail "Date: " . time2str
('%a, %d %b %Y %H:%M:%S %z', time()) . "\n";
1620 print $mail "Subject: $subject\n";
1622 if ($is_multipart) {
1623 print $mail "Content-Type: multipart/alternative;\n";
1624 print $mail "\tboundary=\"$boundary\"\n";
1626 print $mail "This
is a multi-part message
in MIME format
.\n\n";
1627 print $mail "--$boundary\n";
1630 if (defined($text)) {
1631 print $mail "Content-Type
: text
/plain
;\n";
1632 print $mail "Auto-Submitted
: auto-generated
;\n";
1633 print $mail "\tcharset
=\"UTF-8
\"\n";
1634 print $mail "Content-Transfer-Encoding
: 8bit
\n";
1637 # avoid 'remove extra line breaks' issue (MS Outlook)
1639 $text =~ s/^/$fill/gm;
1643 print $mail "\n--$boundary\n" if $is_multipart;
1646 if (defined($html)) {
1647 print $mail "Content-Type
: text
/html
;\n";
1648 print $mail "Auto-Submitted
: auto-generated
;\n";
1649 print $mail "\tcharset
=\"UTF-8
\"\n";
1650 print $mail "Content-Transfer-Encoding
: 8bit
\n";
1655 print $mail "\n--$boundary--\n" if $is_multipart;
1661 # creates a temporary file that does not shows up on the file system hierarchy.
1663 # Uses O_TMPFILE if available, which makes it just an anon inode that never shows up in the FS.
1664 # If O_TMPFILE is not available, which unlikely nowadays (added in 3.11 kernel and all FS relevant
1665 # for us support it) back to open-create + immediate unlink while still holding the file handle.
1667 # TODO: to avoid FS dependent features we could (transparently) switch to memfd_create as backend
1669 my ($perm, %opts) = @_;
1671 # default permissions are stricter than with file_set_contents
1672 $perm = 0600 if !defined($perm);
1674 my $dir = $opts{dir};
1676 if (-d "/run/user
/$<") {
1677 $dir = "/run/user
/$<";
1684 my $mode = $opts{mode} // O_RDWR;
1685 $mode |= O_EXCL if !$opts{allow_links};
1687 my $fh = IO::File->new($dir, $mode | O_TMPFILE, $perm);
1688 if (!$fh && $! == EOPNOTSUPP) {
1689 $dir = '/tmp' if !defined($opts{dir});
1690 $dir .= "/.tmpfile
.$$";
1691 $fh = IO::File->new($dir, $mode | O_CREAT | O_EXCL, $perm);
1692 unlink($dir) if $fh;
1694 die "failed to create tempfile
: $!\n" if !$fh;
1698 # create an (ideally) anon file with the $data as content and return its FD-path and FH
1699 sub tempfile_contents {
1700 my ($data, $perm, %opts) = @_;
1702 my $fh = tempfile($perm, %opts);
1704 die "unable to
write to tempfile
: $!\n" if !print {$fh} $data;
1705 die "unable to flush to tempfile
: $!\n" if !defined($fh->flush());
1712 return ("/proc/$$/fd/".$fh->fileno, $fh);
1715 sub validate_ssh_public_keys {
1717 my @lines = split(/\n/, $raw);
1719 foreach my $line (@lines) {
1720 next if $line =~ m/^\s*$/;
1722 my ($filename, $handle) = tempfile_contents($line);
1723 run_command(["ssh-keygen
", "-l
", "-f
", $filename],
1724 outfunc => sub {}, errfunc => sub {});
1726 die "SSH public key validation error
\n" if $@;
1731 my ($dirfd, $pathname, $flags, $mode) = @_;
1732 $dirfd = int($dirfd);
1733 $flags = int($flags);
1734 $mode = int($mode // 0);
1736 my $fd = syscall(PVE::Syscall::openat, $dirfd, $pathname, $flags, $mode);
1737 return undef if $fd < 0;
1738 # sysopen() doesn't deal with numeric file descriptors apparently
1739 # so we need to convert to a mode string for IO::Handle->new_from_fd
1740 my $flagstr = ($flags & O_RDWR) ? 'rw' : ($flags & O_WRONLY) ? 'w' : 'r';
1741 my $handle = IO::Handle->new_from_fd($fd, $flagstr);
1742 return $handle if $handle;
1743 my $err = $!; # save error before closing the raw fd
1744 syscall(PVE::Syscall::close, $fd); # close
1750 my ($dirfd, $name, $mode) = @_;
1751 return syscall(PVE::Syscall::mkdirat, int($dirfd), $name, int($mode)) == 0;
1755 my ($filename, $mode, $dev) = @_;
1756 return syscall(PVE::Syscall::mknod, $filename, int($mode), int($dev)) == 0;
1759 sub fchownat($$$$$) {
1760 my ($dirfd, $pathname, $owner, $group, $flags) = @_;
1762 PVE::Syscall::fchownat,
1771 my $salt_starter = time();
1777 my $salt = substr(Digest::SHA::sha1_base64(time() + $salt_starter + $$), 0, 8);
1779 # crypt does not want '+' in salt (see 'man crypt')
1782 return crypt(encode("utf8
", $pw), "\
$5\$$salt\$");
1785 # intended usage: convert_size($val, "kb
" => "gb
")
1786 # we round up to the next integer by default
1787 # E.g. `convert_size(1023, "b
" => "kb
")` returns 1
1788 # use $no_round_up to switch this off, above example would then return 0
1789 # this is also true for converting down e.g. 0.0005 gb to mb returns 1
1790 # (0 if $no_round_up is true)
1791 # allowed formats for value:
1797 my ($value, $from, $to, $no_round_up) = @_;
1808 die "no value
given"
1809 if !defined($value) || $value eq "";
1811 $from = lc($from // ''); $to = lc($to // '');
1812 die "unknown
'from' and/or 'to' units
($from => $to)"
1813 if !defined($units->{$from}) || !defined($units->{$to});
1815 die "value
'$value' is not a valid
, positive number
"
1816 if $value !~ m/^(?:[0-9]+\.?[0-9]*|[0-9]*\.[0-9]+)$/;
1818 my $shift_amount = ($units->{$from} - $units->{$to}) * 10;
1820 $value *= 2**$shift_amount;
1821 $value++ if !$no_round_up && ($value - int($value)) > 0.0;
1826 # uninterruptible readline
1828 sub readline_nointr {
1833 last if defined($line) || ($! != EINTR);
1840 $host_arch = (POSIX::uname())[4] if !$host_arch;
1844 # Devices are: [ (12 bits minor) (12 bits major) (8 bits minor) ]
1845 sub dev_t_major($) {
1847 return (int($dev_t) & 0xfff00) >> 8;
1850 sub dev_t_minor($) {
1852 $dev_t = int($dev_t);
1853 return (($dev_t >> 12) & 0xfff00) | ($dev_t & 0xff);
1856 # Given an array of array refs [ \[a b c], \[a b b], \[e b a] ]
1857 # Returns the intersection of elements as a single array [a b]
1858 sub array_intersect {
1861 if (!ref($arrays->[0])) {
1862 $arrays = [ grep { ref($_) eq 'ARRAY' } @_ ];
1865 return [] if scalar(@$arrays) == 0;
1866 return $arrays->[0] if scalar(@$arrays) == 1;
1868 my $array_unique = sub {
1870 return grep { ! $seen{ $_ }++ } @_;
1873 # base idea is to get all unique members from the first array, then
1874 # check the common elements with the next (uniquely made) one, only keep
1875 # those. Repeat for every array and at the end we only have those left
1876 # which exist in all arrays
1877 my $return_arr = [ $array_unique->(@{$arrays->[0]}) ];
1878 for my $i (1 .. $#$arrays) {
1880 # $return_arr is already unique, explicit at before the loop, implicit below.
1881 foreach my $element (@$return_arr, $array_unique->(@{$arrays->[$i]})) {
1885 foreach my $element (keys %count) {
1886 push @$return_arr, $element if $count{$element} > 1;
1888 last if scalar(@$return_arr) == 0; # empty intersection, early exit
1894 sub open_tree($$$) {
1895 my ($dfd, $pathname, $flags) = @_;
1896 return PVE::Syscall::file_handle_result(syscall(
1897 &PVE::Syscall::open_tree,
1904 sub move_mount($$$$$) {
1905 my ($from_dirfd, $from_pathname, $to_dirfd, $to_pathname, $flags) = @_;
1906 return 0 == syscall(
1907 &PVE::Syscall::move_mount,
1917 my ($fsname, $flags) = @_;
1918 return PVE::Syscall::file_handle_result(syscall(&PVE::Syscall::fsopen, $fsname, int($flags)));
1922 my ($fd, $flags, $mount_attrs) = @_;
1923 return PVE::Syscall::file_handle_result(syscall(
1924 &PVE::Syscall::fsmount,
1932 my ($dirfd, $pathname, $flags) = @_;
1933 return PVE::Syscall::file_handle_result(syscall(
1934 &PVE::Syscall::fspick,
1941 sub fsconfig($$$$$) {
1942 my ($fd, $command, $key, $value, $aux) = @_;
1943 return 0 == syscall(
1944 &PVE::Syscall::fsconfig,
1953 # "raw
" mount, old api, not for generic use (as it does not invoke any helpers).
1954 # use for lower level stuff such as bind/remount/... or simple tmpfs mounts
1956 my ($source, $target, $filesystemtype, $mountflags, $data) = @_;
1957 return 0 == syscall(
1958 &PVE::Syscall::mount,
1967 # size is optional and defaults to 256, note that xattr limits are FS specific and that xattrs can
1968 # get arbitrary long. pass `0` for $size in array context to get the actual size of a value
1969 sub getxattr($$;$) {
1970 my ($path_or_handle, $name, $size) = @_;
1972 my $buf = pack("x
${size
}");
1974 my $xattr_size = -1; # the actual size of the xattr, can be zero
1975 if (defined(my $fd = fileno($path_or_handle))) {
1976 $xattr_size = syscall(&PVE::Syscall::fgetxattr, $fd, $name, $buf, int($size));
1978 $xattr_size = syscall(&PVE::Syscall::getxattr, $path_or_handle, $name, $buf, int($size));
1980 if ($xattr_size < 0) {
1983 $buf = substr($buf, 0, $xattr_size);
1984 return wantarray ? ($buf, $xattr_size) : $buf;
1987 # NOTE: can take either a path or an open file handle, i.e., its multiplexing setxattr and fsetxattr
1988 sub setxattr($$$;$) {
1989 my ($path_or_handle, $name, $value, $flags) = @_;
1990 my $size = length($value); # NOTE: seems to get correct length also for wide-characters in text..
1992 if (defined(my $fd = fileno($path_or_handle))) {
1993 return 0 == syscall(
1994 &PVE::Syscall::fsetxattr,
2002 return 0 == syscall(
2003 &PVE::Syscall::setxattr,
2014 my ($left, $right, $cmp) = @_;
2016 return 0 if !defined($left) && !defined($right);
2017 return -1 if !defined($left);
2018 return 1 if !defined($right);
2019 return $cmp->($left, $right);
2023 # opts is a hash ref with the following known properties
2024 # allow_overwrite - if 1, overwriting existing files is allowed, use with care. Default to false
2025 # hash_required - if 1, at least one checksum has to be specified otherwise an error will be thrown
2028 # verify_certificates - if 0 (false) we tell wget to ignore untrusted TLS certs. Default to true
2029 # md5sum|sha(1|224|256|384|512)sum - the respective expected checksum string
2030 sub download_file_from_url {
2031 my ($dest, $url, $opts) = @_;
2033 my ($checksum_algorithm, $checksum_expected);
2034 for ('sha512', 'sha384', 'sha256', 'sha224', 'sha1', 'md5') {
2035 if (defined($opts->{"${_
}sum
"})) {
2036 $checksum_algorithm = $_;
2037 $checksum_expected = $opts->{"${_
}sum
"};
2041 die "checksum required but
not specified
\n" if ($opts->{hash_required} && !$checksum_algorithm);
2043 print "downloading
$url to
$dest\n";
2046 if ($checksum_algorithm) {
2047 print "calculating checksum of existing file
...";
2048 my $checksum_got = get_file_hash($checksum_algorithm, $dest);
2050 if (lc($checksum_got) eq lc($checksum_expected)) {
2051 print "OK
, got correct file already
, no need to download
\n";
2053 } elsif ($opts->{allow_overwrite}) {
2054 print "checksum mismatch
: got
'$checksum_got' != expect
'$checksum_expected', re-download
\n";
2056 print "\n"; # the front end expects the error to reside at the last line without any noise
2057 die "checksum mismatch
: got
'$checksum_got' != expect
'$checksum_expected', aborting
\n";
2059 } elsif (!$opts->{allow_overwrite}) {
2060 die "refusing to override existing file
'$dest'\n";
2064 my $tmp_download = "$dest.tmp_dwnl
.$$";
2065 my $tmp_decomp = "$dest.tmp_dcom
.$$";
2067 local $SIG{INT} = sub {
2068 unlink $tmp_download or warn "could
not cleanup temporary file
: $!"
2069 if -e $tmp_download;
2070 unlink $tmp_decomp or warn "could
not cleanup temporary file
: $!"
2071 if $opts->{decompression_command} && -e $tmp_decomp;
2072 die "got interrupted by signal
\n";
2075 { # limit the scope of the ENV change
2077 if ($opts->{http_proxy}) {
2078 $ENV{http_proxy} = $opts->{http_proxy};
2080 if ($opts->{https_proxy}) {
2081 $ENV{https_proxy} = $opts->{https_proxy};
2084 my $cmd = ['wget', '--progress=dot:giga', '-O', $tmp_download, $url];
2086 if (!($opts->{verify_certificates} // 1)) { # default to true
2087 push @$cmd, '--no-check-certificate';
2090 run_command($cmd, errmsg => "download failed
");
2093 if ($checksum_algorithm) {
2094 print "calculating checksum
...";
2096 my $checksum_got = get_file_hash($checksum_algorithm, $tmp_download);
2098 if (lc($checksum_got) eq lc($checksum_expected)) {
2099 print "OK
, checksum verified
\n";
2101 print "\n"; # the front end expects the error to reside at the last line without any noise
2102 die "checksum mismatch
: got
'$checksum_got' != expect
'$checksum_expected'\n";
2106 if (my $cmd = $opts->{decompression_command}) {
2107 push @$cmd, $tmp_download;
2109 if (!open($fh, ">", "$tmp_decomp")) {
2110 die "cant
open temporary file
$tmp_decomp for decompresson
: $!\n";
2112 print "decompressing
$tmp_download to
$tmp_decomp\n";
2113 run_command($cmd, output => '>&'.fileno($fh));
2114 unlink $tmp_download;
2115 rename($tmp_decomp, $dest) or die "unable to
rename temporary file
: $!\n";
2117 rename($tmp_download, $dest) or die "unable to
rename temporary file
: $!\n";
2121 unlink $tmp_download or warn "could
not cleanup temporary file
: $!"
2122 if -e $tmp_download;
2123 unlink $tmp_decomp or warn "could
not cleanup temporary file
: $!"
2124 if $opts->{decompression_command} && -e $tmp_decomp;
2128 print "download of
'$url' to
'$dest' finished
\n";
2132 my ($algorithm, $filename) = @_;
2134 my $algorithm_map = {
2135 'md5' => sub { Digest::MD5->new },
2136 'sha1' => sub { Digest::SHA->new(1) },
2137 'sha224' => sub { Digest::SHA->new(224) },
2138 'sha256' => sub { Digest::SHA->new(256) },
2139 'sha384' => sub { Digest::SHA->new(384) },
2140 'sha512' => sub { Digest::SHA->new(512) },
2143 my $digester = $algorithm_map->{$algorithm}->() or die "unknown algorithm
'$algorithm'\n";
2145 open(my $fh, '<', $filename) or die "unable to
open '$filename': $!\n";
2148 my $digest = $digester->addfile($fh)->hexdigest;
2153 # compare two perl variables recursively, so this works for scalars, nested
2154 # hashes and nested arrays
2158 return 0 if defined($a) != defined($b);
2159 return 1 if !defined($a); # both are undef
2161 my ($ref_a, $ref_b) = (ref($a), ref($b));
2164 return 0 if !$ref_a && !$ref_b && "$a" ne "$b";
2166 # different types, ok because ref never returns undef, only empty string
2167 return 0 if $ref_a ne $ref_b;
2169 if ($ref_a eq 'HASH') {
2170 return 0 if scalar(keys $a->%*) != scalar(keys $b->%*);
2171 for my $opt (keys $a->%*) {
2172 return 0 if !is_deeply($a->{$opt}, $b->{$opt});
2174 } elsif ($ref_a eq 'ARRAY') {
2175 return 0 if scalar($a->@*) != scalar($b->@*);
2176 for (my $i = 0; $i < $a->@*; $i++) {
2177 return 0 if !is_deeply($a->[$i], $b->[$i]);