src/PVE/Tools.pm

   1 package PVE::Tools;
   2
   3 use strict;
   4 use warnings;
   5 use POSIX qw(EINTR EEXIST EOPNOTSUPP);
   6 use IO::Socket::IP;
   7 use Socket qw(AF_INET AF_INET6 AI_ALL AI_V4MAPPED AI_CANONNAME SOCK_DGRAM
   8               IPPROTO_TCP);
   9 use IO::Select;
  10 use File::Basename;
  11 use File::Path qw(make_path);
  12 use Filesys::Df (); # don't overwrite our df()
  13 use IO::Pipe;
  14 use IO::File;
  15 use IO::Dir;
  16 use IO::Handle;
  17 use IPC::Open3;
  18 use Fcntl qw(:DEFAULT :flock);
  19 use base 'Exporter';
  20 use URI::Escape;
  21 use Encode;
  22 use Digest::SHA;
  23 use JSON;
  24 use Text::ParseWords;
  25 use String::ShellQuote;
  26 use Time::HiRes qw(usleep gettimeofday tv_interval alarm);
  27 use Net::DBus qw(dbus_uint32 dbus_uint64);
  28 use Net::DBus::Callback;
  29 use Net::DBus::Reactor;
  30 use Scalar::Util 'weaken';
  31 use PVE::Syscall;
  32
  33 # avoid warning when parsing long hex values with hex()
  34 no warnings 'portable'; # Support for 64-bit ints required
  35
  36 our @EXPORT_OK = qw(
  37 $IPV6RE
  38 $IPV4RE
  39 lock_file
  40 lock_file_full
  41 run_command
  42 file_set_contents
  43 file_get_contents
  44 file_read_firstline
  45 dir_glob_regex
  46 dir_glob_foreach
  47 split_list
  48 template_replace
  49 safe_print
  50 trim
  51 extract_param
  52 file_copy
  53 O_PATH
  54 O_TMPFILE
  55 );
  56
  57 my $pvelogdir = "/var/log/pve";
  58 my $pvetaskdir = "$pvelogdir/tasks";
  59
  60 mkdir $pvelogdir;
  61 mkdir $pvetaskdir;
  62
  63 my $IPV4OCTET = "(?:25[0-5]|(?:2[0-4]|1[0-9]|[1-9])?[0-9])";
  64 our $IPV4RE = "(?:(?:$IPV4OCTET\\.){3}$IPV4OCTET)";
  65 my $IPV6H16 = "(?:[0-9a-fA-F]{1,4})";
  66 my $IPV6LS32 = "(?:(?:$IPV4RE|$IPV6H16:$IPV6H16))";
  67
  68 our $IPV6RE = "(?:" .
  69     "(?:(?:" .                             "(?:$IPV6H16:){6})$IPV6LS32)|" .
  70     "(?:(?:" .                           "::(?:$IPV6H16:){5})$IPV6LS32)|" .
  71     "(?:(?:(?:" .              "$IPV6H16)?::(?:$IPV6H16:){4})$IPV6LS32)|" .
  72     "(?:(?:(?:(?:$IPV6H16:){0,1}$IPV6H16)?::(?:$IPV6H16:){3})$IPV6LS32)|" .
  73     "(?:(?:(?:(?:$IPV6H16:){0,2}$IPV6H16)?::(?:$IPV6H16:){2})$IPV6LS32)|" .
  74     "(?:(?:(?:(?:$IPV6H16:){0,3}$IPV6H16)?::(?:$IPV6H16:){1})$IPV6LS32)|" .
  75     "(?:(?:(?:(?:$IPV6H16:){0,4}$IPV6H16)?::" .           ")$IPV6LS32)|" .
  76     "(?:(?:(?:(?:$IPV6H16:){0,5}$IPV6H16)?::" .            ")$IPV6H16)|" .
  77     "(?:(?:(?:(?:$IPV6H16:){0,6}$IPV6H16)?::" .                    ")))";
  78
  79 our $IPRE = "(?:$IPV4RE|$IPV6RE)";
  80
  81 use constant {CLONE_NEWNS   => 0x00020000,
  82               CLONE_NEWUTS  => 0x04000000,
  83               CLONE_NEWIPC  => 0x08000000,
  84               CLONE_NEWUSER => 0x10000000,
  85               CLONE_NEWPID  => 0x20000000,
  86               CLONE_NEWNET  => 0x40000000};
  87
  88 use constant {O_PATH    => 0x00200000,
  89               O_TMPFILE => 0x00410000}; # This includes O_DIRECTORY
  90
  91 sub run_with_timeout {
  92     my ($timeout, $code, @param) = @_;
  93
  94     die "got timeout\n" if $timeout <= 0;
  95
  96     my $prev_alarm = alarm 0; # suspend outer alarm early
  97
  98     my $sigcount = 0;
  99
 100     my $res;
 101
 102     eval {
 103         local $SIG{ALRM} = sub { $sigcount++; die "got timeout\n"; };
 104         local $SIG{PIPE} = sub { $sigcount++; die "broken pipe\n" };
 105         local $SIG{__DIE__};   # see SA bug 4631
 106
 107         alarm($timeout);
 108
 109         eval { $res = &$code(@param); };
 110
 111         alarm(0); # avoid race conditions
 112
 113         die $@ if $@;
 114     };
 115
 116     my $err = $@;
 117
 118     alarm $prev_alarm;
 119
 120     # this shouldn't happen anymore?
 121     die "unknown error" if $sigcount && !$err; # seems to happen sometimes
 122
 123     die $err if $err;
 124
 125     return $res;
 126 }
 127
 128 # flock: we use one file handle per process, so lock file
 129 # can be nested multiple times and succeeds for the same process.
 130 #
 131 # Since this is the only way we lock now and we don't have the old
 132 # 'lock(); code(); unlock();' pattern anymore we do not actually need to
 133 # count how deep we're nesting. Therefore this hash now stores a weak reference
 134 # to a boolean telling us whether we already have a lock.
 135
 136 my $lock_handles =  {};
 137
 138 sub lock_file_full {
 139     my ($filename, $timeout, $shared, $code, @param) = @_;
 140
 141     $timeout = 10 if !$timeout;
 142
 143     my $mode = $shared ? LOCK_SH : LOCK_EX;
 144
 145     my $lockhash = ($lock_handles->{$$} //= {});
 146
 147     # Returns a locked file handle.
 148     my $get_locked_file = sub {
 149         my $fh = IO::File->new(">>$filename")
 150             or die "can't open file - $!\n";
 151
 152         if (!flock($fh, $mode|LOCK_NB)) {
 153             print STDERR "trying to acquire lock...\n";
 154             my $success;
 155             while(1) {
 156                 $success = flock($fh, $mode);
 157                 # try again on EINTR (see bug #273)
 158                 if ($success || ($! != EINTR)) {
 159                     last;
 160                 }
 161             }
 162             if (!$success) {
 163                 print STDERR " failed\n";
 164                 die "can't acquire lock '$filename' - $!\n";
 165             }
 166             print STDERR " OK\n";
 167         }
 168
 169         return $fh;
 170     };
 171
 172     my $res;
 173     my $checkptr = $lockhash->{$filename};
 174     my $check = 0; # This must not go out of scope before running the code.
 175     my $local_fh; # This must stay local
 176     if (!$checkptr || !$$checkptr) {
 177         # We cannot create a weak reference in a single atomic step, so we first
 178         # create a false-value, then create a reference to it, then weaken it,
 179         # and after successfully locking the file we change the boolean value.
 180         #
 181         # The reason for this is that if an outer SIGALRM throws an exception
 182         # between creating the reference and weakening it, a subsequent call to
 183         # lock_file_full() will see a leftover full reference to a valid
 184         # variable. This variable must be 0 in order for said call to attempt to
 185         # lock the file anew.
 186         #
 187         # An externally triggered exception elsewhere in the code will cause the
 188         # weak reference to become 'undef', and since the file handle is only
 189         # stored in the local scope in $local_fh, the file will be closed by
 190         # perl's cleanup routines as well.
 191         #
 192         # This still assumes that an IO::File handle can properly deal with such
 193         # exceptions thrown during its own destruction, but that's up to perls
 194         # guts now.
 195         $lockhash->{$filename} = \$check;
 196         weaken $lockhash->{$filename};
 197         $local_fh = eval { run_with_timeout($timeout, $get_locked_file) };
 198         if ($@) {
 199             $@ = "can't lock file '$filename' - $@";
 200             return undef;
 201         }
 202         $check = 1;
 203     }
 204     $res = eval { &$code(@param); };
 205     return undef if $@;
 206     return $res;
 207 }
 208
 209
 210 sub lock_file {
 211     my ($filename, $timeout, $code, @param) = @_;
 212
 213     return lock_file_full($filename, $timeout, 0, $code, @param);
 214 }
 215
 216 sub file_set_contents {
 217     my ($filename, $data, $perm)  = @_;
 218
 219     $perm = 0644 if !defined($perm);
 220
 221     my $tmpname = "$filename.tmp.$$";
 222
 223     eval {
 224         my ($fh, $tries) = (undef, 0);
 225         while (!$fh && $tries++ < 3) {
 226             $fh = IO::File->new($tmpname, O_WRONLY|O_CREAT|O_EXCL, $perm);
 227             if (!$fh && $! == EEXIST) {
 228                 unlink($tmpname) or die "unable to delete old temp file: $!\n";
 229             }
 230         }
 231         die "unable to open file '$tmpname' - $!\n" if !$fh;
 232         die "unable to write '$tmpname' - $!\n" unless print $fh $data;
 233         die "closing file '$tmpname' failed - $!\n" unless close $fh;
 234     };
 235     my $err = $@;
 236
 237     if ($err) {
 238         unlink $tmpname;
 239         die $err;
 240     }
 241
 242     if (!rename($tmpname, $filename)) {
 243         my $msg = "close (rename) atomic file '$filename' failed: $!\n";
 244         unlink $tmpname;
 245         die $msg;
 246     }
 247 }
 248
 249 sub file_get_contents {
 250     my ($filename, $max) = @_;
 251
 252     my $fh = IO::File->new($filename, "r") ||
 253         die "can't open '$filename' - $!\n";
 254
 255     my $content = safe_read_from($fh, $max, 0, $filename);
 256
 257     close $fh;
 258
 259     return $content;
 260 }
 261
 262 sub file_copy {
 263     my ($filename, $dst, $max, $perm) = @_;
 264
 265     file_set_contents ($dst, file_get_contents($filename, $max), $perm);
 266 }
 267
 268 sub file_read_firstline {
 269     my ($filename) = @_;
 270
 271     my $fh = IO::File->new ($filename, "r");
 272     return undef if !$fh;
 273     my $res = <$fh>;
 274     chomp $res if $res;
 275     $fh->close;
 276     return $res;
 277 }
 278
 279 sub safe_read_from {
 280     my ($fh, $max, $oneline, $filename) = @_;
 281
 282     $max = 32768 if !$max;
 283
 284     my $subject = defined($filename) ? "file '$filename'" : 'input';
 285
 286     my $br = 0;
 287     my $input = '';
 288     my $count;
 289     while ($count = sysread($fh, $input, 8192, $br)) {
 290         $br += $count;
 291         die "$subject too long - aborting\n" if $br > $max;
 292         if ($oneline && $input =~ m/^(.*)\n/) {
 293             $input = $1;
 294             last;
 295         }
 296     }
 297     die "unable to read $subject - $!\n" if !defined($count);
 298
 299     return $input;
 300 }
 301
 302 # The $cmd parameter can be:
 303 #  -) a string
 304 #    This is generally executed by passing it to the shell with the -c option.
 305 #    However, it can be executed in one of two ways, depending on whether
 306 #    there's a pipe involved:
 307 #      *) with pipe: passed explicitly to bash -c, prefixed with:
 308 #          set -o pipefail &&
 309 #      *) without a pipe: passed to perl's open3 which uses 'sh -c'
 310 #      (Note that this may result in two different syntax requirements!)
 311 #      FIXME?
 312 #  -) an array of arguments (strings)
 313 #    Will be executed without interference from a shell. (Parameters are passed
 314 #    as is, no escape sequences of strings will be touched.)
 315 #  -) an array of arrays
 316 #    Each array represents a command, and each command's output is piped into
 317 #    the following command's standard input.
 318 #    For this a shell command string is created with pipe symbols between each
 319 #    command.
 320 #    Each command is a list of strings meant to end up in the final command
 321 #    unchanged. In order to achieve this, every argument is shell-quoted.
 322 #    Quoting can be disabled for a particular argument by turning it into a
 323 #    reference, this allows inserting arbitrary shell options.
 324 #    For instance: the $cmd [ [ 'echo', 'hello', \'>/dev/null' ] ] will not
 325 #    produce any output, while the $cmd [ [ 'echo', 'hello', '>/dev/null' ] ]
 326 #    will literally print: hello >/dev/null
 327 sub run_command {
 328     my ($cmd, %param) = @_;
 329
 330     my $old_umask;
 331     my $cmdstr;
 332
 333     if (my $ref = ref($cmd)) {
 334         if (ref($cmd->[0])) {
 335             $cmdstr = 'set -o pipefail && ';
 336             my $pipe = '';
 337             foreach my $command (@$cmd) {
 338                 # concatenate quoted parameters
 339                 # strings which are passed by reference are NOT shell quoted
 340                 $cmdstr .= $pipe .  join(' ', map { ref($_) ? $$_ : shellquote($_) } @$command);
 341                 $pipe = ' | ';
 342             }
 343             $cmd = [ '/bin/bash', '-c', "$cmdstr" ];
 344         } else {
 345             $cmdstr = cmd2string($cmd);
 346         }
 347     } else {
 348         $cmdstr = $cmd;
 349         if ($cmd =~ m/\|/) {
 350             # see 'man bash' for option pipefail
 351             $cmd = [ '/bin/bash', '-c', "set -o pipefail && $cmd" ];
 352         } else {
 353             $cmd = [ $cmd ];
 354         }
 355     }
 356
 357     my $errmsg;
 358     my $laststderr;
 359     my $timeout;
 360     my $oldtimeout;
 361     my $pid;
 362     my $exitcode = -1;
 363
 364     my $outfunc;
 365     my $errfunc;
 366     my $logfunc;
 367     my $input;
 368     my $output;
 369     my $afterfork;
 370     my $noerr;
 371     my $keeplocale;
 372     my $quiet;
 373
 374     eval {
 375
 376         foreach my $p (keys %param) {
 377             if ($p eq 'timeout') {
 378                 $timeout = $param{$p};
 379             } elsif ($p eq 'umask') {
 380                 $old_umask = umask($param{$p});
 381             } elsif ($p eq 'errmsg') {
 382                 $errmsg = $param{$p};
 383             } elsif ($p eq 'input') {
 384                 $input = $param{$p};
 385             } elsif ($p eq 'output') {
 386                 $output = $param{$p};
 387             } elsif ($p eq 'outfunc') {
 388                 $outfunc = $param{$p};
 389             } elsif ($p eq 'errfunc') {
 390                 $errfunc = $param{$p};
 391             } elsif ($p eq 'logfunc') {
 392                 $logfunc = $param{$p};
 393             } elsif ($p eq 'afterfork') {
 394                 $afterfork = $param{$p};
 395             } elsif ($p eq 'noerr') {
 396                 $noerr = $param{$p};
 397             } elsif ($p eq 'keeplocale') {
 398                 $keeplocale = $param{$p};
 399             } elsif ($p eq 'quiet') {
 400                 $quiet = $param{$p};
 401             } else {
 402                 die "got unknown parameter '$p' for run_command\n";
 403             }
 404         }
 405
 406         if ($errmsg) {
 407             my $origerrfunc = $errfunc;
 408             $errfunc = sub {
 409                 if ($laststderr) {
 410                     if ($origerrfunc) {
 411                         &$origerrfunc("$laststderr\n");
 412                     } else {
 413                         print STDERR "$laststderr\n" if $laststderr;
 414                     }
 415                 }
 416                 $laststderr = shift;
 417             };
 418         }
 419
 420         my $reader = $output && $output =~ m/^>&/ ? $output : IO::File->new();
 421         my $writer = $input && $input =~ m/^<&/ ? $input : IO::File->new();
 422         my $error  = IO::File->new();
 423
 424         my $orig_pid = $$;
 425
 426         eval {
 427             local $ENV{LC_ALL} = 'C' if !$keeplocale;
 428
 429             # suppress LVM warnings like: "File descriptor 3 left open";
 430             local $ENV{LVM_SUPPRESS_FD_WARNINGS} = "1";
 431
 432             $pid = open3($writer, $reader, $error, @$cmd) || die $!;
 433
 434             # if we pipe fron STDIN, open3 closes STDIN, so we we
 435             # a perl warning "Filehandle STDIN reopened as GENXYZ .. "
 436             # as soon as we open a new file.
 437             # to avoid that we open /dev/null
 438             if (!ref($writer) && !defined(fileno(STDIN))) {
 439                 POSIX::close(0);
 440                 open(STDIN, "</dev/null");
 441             }
 442         };
 443
 444         my $err = $@;
 445
 446         # catch exec errors
 447         if ($orig_pid != $$) {
 448             warn "ERROR: $err";
 449             POSIX::_exit (1);
 450             kill ('KILL', $$);
 451         }
 452
 453         die $err if $err;
 454
 455         local $SIG{ALRM} = sub { die "got timeout\n"; } if $timeout;
 456         $oldtimeout = alarm($timeout) if $timeout;
 457
 458         &$afterfork() if $afterfork;
 459
 460         if (ref($writer)) {
 461             print $writer $input if defined $input;
 462             close $writer;
 463         }
 464
 465         my $select = new IO::Select;
 466         $select->add($reader) if ref($reader);
 467         $select->add($error);
 468
 469         my $outlog = '';
 470         my $errlog = '';
 471
 472         my $starttime = time();
 473
 474         while ($select->count) {
 475             my @handles = $select->can_read(1);
 476
 477             foreach my $h (@handles) {
 478                 my $buf = '';
 479                 my $count = sysread ($h, $buf, 4096);
 480                 if (!defined ($count)) {
 481                     my $err = $!;
 482                     kill (9, $pid);
 483                     waitpid ($pid, 0);
 484                     die $err;
 485                 }
 486                 $select->remove ($h) if !$count;
 487                 if ($h eq $reader) {
 488                     if ($outfunc || $logfunc) {
 489                         eval {
 490                             $outlog .= $buf;
 491                             while ($outlog =~ s/^([^\010\r\n]*)(\r|\n|(\010)+|\r\n)//s) {
 492                                 my $line = $1;
 493                                 &$outfunc($line) if $outfunc;
 494                                 &$logfunc($line) if $logfunc;
 495                             }
 496                         };
 497                         my $err = $@;
 498                         if ($err) {
 499                             kill (9, $pid);
 500                             waitpid ($pid, 0);
 501                             die $err;
 502                         }
 503                     } elsif (!$quiet) {
 504                         print $buf;
 505                         *STDOUT->flush();
 506                     }
 507                 } elsif ($h eq $error) {
 508                     if ($errfunc || $logfunc) {
 509                         eval {
 510                             $errlog .= $buf;
 511                             while ($errlog =~ s/^([^\010\r\n]*)(\r|\n|(\010)+|\r\n)//s) {
 512                                 my $line = $1;
 513                                 &$errfunc($line) if $errfunc;
 514                                 &$logfunc($line) if $logfunc;
 515                             }
 516                         };
 517                         my $err = $@;
 518                         if ($err) {
 519                             kill (9, $pid);
 520                             waitpid ($pid, 0);
 521                             die $err;
 522                         }
 523                     } elsif (!$quiet) {
 524                         print STDERR $buf;
 525                         *STDERR->flush();
 526                     }
 527                 }
 528             }
 529         }
 530
 531         &$outfunc($outlog) if $outfunc && $outlog;
 532         &$logfunc($outlog) if $logfunc && $outlog;
 533
 534         &$errfunc($errlog) if $errfunc && $errlog;
 535         &$logfunc($errlog) if $logfunc && $errlog;
 536
 537         waitpid ($pid, 0);
 538
 539         if ($? == -1) {
 540             die "failed to execute\n";
 541         } elsif (my $sig = ($? & 127)) {
 542             die "got signal $sig\n";
 543         } elsif ($exitcode = ($? >> 8)) {
 544             if (!($exitcode == 24 && ($cmdstr =~ m|^(\S+/)?rsync\s|))) {
 545                 if ($errmsg && $laststderr) {
 546                     my $lerr = $laststderr;
 547                     $laststderr = undef;
 548                     die "$lerr\n";
 549                 }
 550                 die "exit code $exitcode\n";
 551             }
 552         }
 553
 554         alarm(0);
 555     };
 556
 557     my $err = $@;
 558
 559     alarm(0);
 560
 561     if ($errmsg && $laststderr) {
 562         &$errfunc(undef); # flush laststderr
 563     }
 564
 565     umask ($old_umask) if defined($old_umask);
 566
 567     alarm($oldtimeout) if $oldtimeout;
 568
 569     if ($err) {
 570         if ($pid && ($err eq "got timeout\n")) {
 571             kill (9, $pid);
 572             waitpid ($pid, 0);
 573             die "command '$cmdstr' failed: $err";
 574         }
 575
 576         if ($errmsg) {
 577             $err =~ s/^usermod:\s*// if $cmdstr =~ m|^(\S+/)?usermod\s|;
 578             die "$errmsg: $err";
 579         } elsif(!$noerr) {
 580             die "command '$cmdstr' failed: $err";
 581         }
 582     }
 583
 584     return $exitcode;
 585 }
 586
 587 # Run a command with a tcp socket as standard input.
 588 sub pipe_socket_to_command  {
 589     my ($cmd, $ip, $port) = @_;
 590
 591     my $params = {
 592         Listen => 1,
 593         ReuseAddr => 1,
 594         Proto => &Socket::IPPROTO_TCP,
 595         GetAddrInfoFlags => 0,
 596         LocalAddr => $ip,
 597         LocalPort => $port,
 598     };
 599     my $socket = IO::Socket::IP->new(%$params) or die "failed to open socket: $!\n";
 600
 601     print "$ip\n$port\n"; # tell remote where to connect
 602     *STDOUT->flush();
 603
 604     alarm 0;
 605     local $SIG{ALRM} = sub { die "timed out waiting for client\n" };
 606     alarm 30;
 607     my $client = $socket->accept; # Wait for a client
 608     alarm 0;
 609     close($socket);
 610
 611     # We want that the command talks over the TCP socket and takes
 612     # ownership of it, so that when it closes it the connection is
 613     # terminated, so we need to be able to close the socket. So we
 614     # can't really use PVE::Tools::run_command().
 615     my $pid = fork() // die "fork failed: $!\n";
 616     if (!$pid) {
 617         POSIX::dup2(fileno($client), 0);
 618         POSIX::dup2(fileno($client), 1);
 619         close($client);
 620         exec {$cmd->[0]} @$cmd or do {
 621             warn "exec failed: $!\n";
 622             POSIX::_exit(1);
 623         };
 624     }
 625
 626     close($client);
 627     if (waitpid($pid, 0) != $pid) {
 628         kill(15 => $pid); # if we got interrupted terminate the child
 629         my $count = 0;
 630         while (waitpid($pid, POSIX::WNOHANG) != $pid) {
 631             usleep(100000);
 632             $count++;
 633             kill(9 => $pid), last if $count > 300; # 30 second timeout
 634         }
 635     }
 636     if (my $sig = ($? & 127)) {
 637         die "got signal $sig\n";
 638     } elsif (my $exitcode = ($? >> 8)) {
 639         die "exit code $exitcode\n";
 640     }
 641
 642     return undef;
 643 }
 644
 645 sub split_list {
 646     my $listtxt = shift || '';
 647
 648     return split (/\0/, $listtxt) if $listtxt =~ m/\0/;
 649
 650     $listtxt =~ s/[,;]/ /g;
 651     $listtxt =~ s/^\s+//;
 652
 653     my @data = split (/\s+/, $listtxt);
 654
 655     return @data;
 656 }
 657
 658 sub trim {
 659     my $txt = shift;
 660
 661     return $txt if !defined($txt);
 662
 663     $txt =~ s/^\s+//;
 664     $txt =~ s/\s+$//;
 665
 666     return $txt;
 667 }
 668
 669 # simple uri templates like "/vms/{vmid}"
 670 sub template_replace {
 671     my ($tmpl, $data) = @_;
 672
 673     return $tmpl if !$tmpl;
 674
 675     my $res = '';
 676     while ($tmpl =~ m/([^{]+)?({([^}]+)})?/g) {
 677         $res .= $1 if $1;
 678         $res .= ($data->{$3} || '-') if $2;
 679     }
 680     return $res;
 681 }
 682
 683 sub safe_print {
 684     my ($filename, $fh, $data) = @_;
 685
 686     return if !$data;
 687
 688     my $res = print $fh $data;
 689
 690     die "write to '$filename' failed\n" if !$res;
 691 }
 692
 693 sub debmirrors {
 694
 695     return {
 696         'at' => 'ftp.at.debian.org',
 697         'au' => 'ftp.au.debian.org',
 698         'be' => 'ftp.be.debian.org',
 699         'bg' => 'ftp.bg.debian.org',
 700         'br' => 'ftp.br.debian.org',
 701         'ca' => 'ftp.ca.debian.org',
 702         'ch' => 'ftp.ch.debian.org',
 703         'cl' => 'ftp.cl.debian.org',
 704         'cz' => 'ftp.cz.debian.org',
 705         'de' => 'ftp.de.debian.org',
 706         'dk' => 'ftp.dk.debian.org',
 707         'ee' => 'ftp.ee.debian.org',
 708         'es' => 'ftp.es.debian.org',
 709         'fi' => 'ftp.fi.debian.org',
 710         'fr' => 'ftp.fr.debian.org',
 711         'gr' => 'ftp.gr.debian.org',
 712         'hk' => 'ftp.hk.debian.org',
 713         'hr' => 'ftp.hr.debian.org',
 714         'hu' => 'ftp.hu.debian.org',
 715         'ie' => 'ftp.ie.debian.org',
 716         'is' => 'ftp.is.debian.org',
 717         'it' => 'ftp.it.debian.org',
 718         'jp' => 'ftp.jp.debian.org',
 719         'kr' => 'ftp.kr.debian.org',
 720         'mx' => 'ftp.mx.debian.org',
 721         'nl' => 'ftp.nl.debian.org',
 722         'no' => 'ftp.no.debian.org',
 723         'nz' => 'ftp.nz.debian.org',
 724         'pl' => 'ftp.pl.debian.org',
 725         'pt' => 'ftp.pt.debian.org',
 726         'ro' => 'ftp.ro.debian.org',
 727         'ru' => 'ftp.ru.debian.org',
 728         'se' => 'ftp.se.debian.org',
 729         'si' => 'ftp.si.debian.org',
 730         'sk' => 'ftp.sk.debian.org',
 731         'tr' => 'ftp.tr.debian.org',
 732         'tw' => 'ftp.tw.debian.org',
 733         'gb' => 'ftp.uk.debian.org',
 734         'us' => 'ftp.us.debian.org',
 735     };
 736 }
 737
 738 my $keymaphash =  {
 739     'dk'     => ['Danish', 'da', 'qwerty/dk-latin1.kmap.gz', 'dk', 'nodeadkeys'],
 740     'de'     => ['German', 'de', 'qwertz/de-latin1-nodeadkeys.kmap.gz', 'de', 'nodeadkeys' ],
 741     'de-ch'  => ['Swiss-German', 'de-ch', 'qwertz/sg-latin1.kmap.gz',  'ch', 'de_nodeadkeys' ],
 742     'en-gb'  => ['United Kingdom', 'en-gb', 'qwerty/uk.kmap.gz' , 'gb', undef],
 743     'en-us'  => ['U.S. English', 'en-us', 'qwerty/us-latin1.kmap.gz',  'us', undef ],
 744     'es'     => ['Spanish', 'es', 'qwerty/es.kmap.gz', 'es', 'nodeadkeys'],
 745     #'et'     => [], # Ethopia or Estonia ??
 746     'fi'     => ['Finnish', 'fi', 'qwerty/fi-latin1.kmap.gz', 'fi', 'nodeadkeys'],
 747     #'fo'     => ['Faroe Islands', 'fo', ???, 'fo', 'nodeadkeys'],
 748     'fr'     => ['French', 'fr', 'azerty/fr-latin1.kmap.gz', 'fr', 'nodeadkeys'],
 749     'fr-be'  => ['Belgium-French', 'fr-be', 'azerty/be2-latin1.kmap.gz', 'be', 'nodeadkeys'],
 750     'fr-ca'  => ['Canada-French', 'fr-ca', 'qwerty/cf.kmap.gz', 'ca', 'fr-legacy'],
 751     'fr-ch'  => ['Swiss-French', 'fr-ch', 'qwertz/fr_CH-latin1.kmap.gz', 'ch', 'fr_nodeadkeys'],
 752     #'hr'     => ['Croatia', 'hr', 'qwertz/croat.kmap.gz', 'hr', ??], # latin2?
 753     'hu'     => ['Hungarian', 'hu', 'qwertz/hu.kmap.gz', 'hu', undef],
 754     'is'     => ['Icelandic', 'is', 'qwerty/is-latin1.kmap.gz', 'is', 'nodeadkeys'],
 755     'it'     => ['Italian', 'it', 'qwerty/it2.kmap.gz', 'it', 'nodeadkeys'],
 756     'jp'     => ['Japanese', 'ja', 'qwerty/jp106.kmap.gz', 'jp', undef],
 757     'lt'     => ['Lithuanian', 'lt', 'qwerty/lt.kmap.gz', 'lt', 'std'],
 758     #'lv'     => ['Latvian', 'lv', 'qwerty/lv-latin4.kmap.gz', 'lv', ??], # latin4 or latin7?
 759     'mk'     => ['Macedonian', 'mk', 'qwerty/mk.kmap.gz', 'mk', 'nodeadkeys'],
 760     'nl'     => ['Dutch', 'nl', 'qwerty/nl.kmap.gz', 'nl', undef],
 761     #'nl-be'  => ['Belgium-Dutch', 'nl-be', ?, ?, ?],
 762     'no'   => ['Norwegian', 'no', 'qwerty/no-latin1.kmap.gz', 'no', 'nodeadkeys'],
 763     'pl'     => ['Polish', 'pl', 'qwerty/pl.kmap.gz', 'pl', undef],
 764     'pt'     => ['Portuguese', 'pt', 'qwerty/pt-latin1.kmap.gz', 'pt', 'nodeadkeys'],
 765     'pt-br'  => ['Brazil-Portuguese', 'pt-br', 'qwerty/br-latin1.kmap.gz', 'br', 'nodeadkeys'],
 766     #'ru'     => ['Russian', 'ru', 'qwerty/ru.kmap.gz', 'ru', undef], # dont know?
 767     'si'     => ['Slovenian', 'sl', 'qwertz/slovene.kmap.gz', 'si', undef],
 768     'se'     => ['Swedish', 'sv', 'qwerty/se-latin1.kmap.gz', 'se', 'nodeadkeys'],
 769     #'th'     => [],
 770     'tr'     => ['Turkish', 'tr', 'qwerty/trq.kmap.gz', 'tr', undef],
 771 };
 772
 773 my $kvmkeymaparray = [];
 774 foreach my $lc (sort keys %$keymaphash) {
 775     push @$kvmkeymaparray, $keymaphash->{$lc}->[1];
 776 }
 777
 778 sub kvmkeymaps {
 779     return $keymaphash;
 780 }
 781
 782 sub kvmkeymaplist {
 783     return $kvmkeymaparray;
 784 }
 785
 786 sub extract_param {
 787     my ($param, $key) = @_;
 788
 789     my $res = $param->{$key};
 790     delete $param->{$key};
 791
 792     return $res;
 793 }
 794
 795 # Note: we use this to wait until vncterm/spiceterm is ready
 796 sub wait_for_vnc_port {
 797     my ($port, $family, $timeout) = @_;
 798
 799     $timeout = 5 if !$timeout;
 800     my $sleeptime = 0;
 801     my $starttime = [gettimeofday];
 802     my $elapsed;
 803
 804     my $cmd = ['/bin/ss', '-Htln', "sport = :$port"];
 805     push @$cmd, $family == AF_INET6 ? '-6' : '-4' if defined($family);
 806
 807     my $found;
 808     while (($elapsed = tv_interval($starttime)) < $timeout) {
 809         # -Htln = don't print header, tcp, listening sockets only, numeric ports
 810         run_command($cmd, outfunc => sub {
 811             my $line = shift;
 812             if ($line =~ m/^LISTEN\s+\d+\s+\d+\s+\S+:(\d+)\s/) {
 813                 $found = 1 if ($port == $1);
 814             }
 815         });
 816         return 1 if $found;
 817         $sleeptime += 100000 if  $sleeptime < 1000000;
 818         usleep($sleeptime);
 819     }
 820
 821     die "Timeout while waiting for port '$port' to get ready!\n";
 822 }
 823
 824 sub next_unused_port {
 825     my ($range_start, $range_end, $family, $address) = @_;
 826
 827     # We use a file to register allocated ports.
 828     # Those registrations expires after $expiretime.
 829     # We use this to avoid race conditions between
 830     # allocation and use of ports.
 831
 832     my $filename = "/var/tmp/pve-reserved-ports";
 833
 834     my $code = sub {
 835
 836         my $expiretime = 5;
 837         my $ctime = time();
 838
 839         my $ports = {};
 840
 841         if (my $fh = IO::File->new ($filename, "r")) {
 842             while (my $line = <$fh>) {
 843                 if ($line =~ m/^(\d+)\s(\d+)$/) {
 844                     my ($port, $timestamp) = ($1, $2);
 845                     if (($timestamp + $expiretime) > $ctime) {
 846                         $ports->{$port} = $timestamp; # not expired
 847                     }
 848                 }
 849             }
 850         }
 851
 852         my $newport;
 853         my %sockargs = (Listen => 5,
 854                         ReuseAddr => 1,
 855                         Family    => $family,
 856                         Proto     => IPPROTO_TCP,
 857                         GetAddrInfoFlags => 0);
 858         $sockargs{LocalAddr} = $address if defined($address);
 859
 860         for (my $p = $range_start; $p < $range_end; $p++) {
 861             next if $ports->{$p}; # reserved
 862
 863             $sockargs{LocalPort} = $p;
 864             my $sock = IO::Socket::IP->new(%sockargs);
 865
 866             if ($sock) {
 867                 close($sock);
 868                 $newport = $p;
 869                 $ports->{$p} = $ctime;
 870                 last;
 871             }
 872         }
 873
 874         my $data = "";
 875         foreach my $p (keys %$ports) {
 876             $data .= "$p $ports->{$p}\n";
 877         }
 878
 879         file_set_contents($filename, $data);
 880
 881         return $newport;
 882     };
 883
 884     my $p = lock_file('/var/lock/pve-ports.lck', 10, $code);
 885     die $@ if $@;
 886
 887     die "unable to find free port (${range_start}-${range_end})\n" if !$p;
 888
 889     return $p;
 890 }
 891
 892 sub next_migrate_port {
 893     my ($family, $address) = @_;
 894     return next_unused_port(60000, 60050, $family, $address);
 895 }
 896
 897 sub next_vnc_port {
 898     my ($family, $address) = @_;
 899     return next_unused_port(5900, 6000, $family, $address);
 900 }
 901
 902 sub next_spice_port {
 903     my ($family, $address) = @_;
 904     return next_unused_port(61000, 61099, $family, $address);
 905 }
 906
 907 # sigkill after $timeout  a $sub running in a fork if it can't write a pipe
 908 # the $sub has to return a single scalar
 909 sub run_fork_with_timeout {
 910     my ($timeout, $sub) = @_;
 911
 912     my $res;
 913     my $error;
 914     my $pipe_out = IO::Pipe->new();
 915
 916     # disable pending alarms, save their remaining time
 917     my $prev_alarm = alarm 0;
 918
 919     # avoid leaving a zombie if the parent gets interrupted
 920     my $sig_received;
 921     local $SIG{INT} = sub { $sig_received++; };
 922
 923     my $child = fork();
 924     if (!defined($child)) {
 925         die "fork failed: $!\n";
 926         return $res;
 927     }
 928
 929     if (!$child) {
 930         $pipe_out->writer();
 931
 932         eval {
 933             $res = $sub->();
 934             print {$pipe_out} encode_json({ result => $res });
 935             $pipe_out->flush();
 936         };
 937         if (my $err = $@) {
 938             print {$pipe_out} encode_json({ error => $err });
 939             $pipe_out->flush();
 940             POSIX::_exit(1);
 941         }
 942         POSIX::_exit(0);
 943     }
 944
 945     $pipe_out->reader();
 946
 947     my $readvalues = sub {
 948         local $/ = undef;
 949         my $child_res = decode_json(scalar<$pipe_out>);
 950         $res = $child_res->{result};
 951         $error = $child_res->{error};
 952     };
 953     eval {
 954         if (defined($timeout)) {
 955             run_with_timeout($timeout, $readvalues);
 956         } else {
 957             $readvalues->();
 958         }
 959     };
 960     warn $@ if $@;
 961     $pipe_out->close();
 962     kill('KILL', $child);
 963     waitpid($child, 0);
 964
 965     alarm $prev_alarm;
 966     die "interrupted by unexpected signal\n" if $sig_received;
 967
 968     die $error if $error;
 969     return $res;
 970 }
 971
 972 sub run_fork {
 973     my ($code) = @_;
 974     return run_fork_with_timeout(undef, $code);
 975 }
 976
 977 # NOTE: NFS syscall can't be interrupted, so alarm does
 978 # not work to provide timeouts.
 979 # from 'man nfs': "Only SIGKILL can interrupt a pending NFS operation"
 980 # So fork() before using Filesys::Df
 981 sub df {
 982     my ($path, $timeout) = @_;
 983
 984     my $df = sub { return Filesys::Df::df($path, 1) };
 985
 986     my $res = eval { run_fork_with_timeout($timeout, $df) } // {};
 987     warn $@ if $@;
 988
 989     return {
 990         total => $res->{blocks} // 0,
 991         used => $res->{used} // 0,
 992         avail => $res->{bavail} // 0,
 993     };
 994 }
 995
 996 # UPID helper
 997 # We use this to uniquely identify a process.
 998 # An 'Unique Process ID' has the following format:
 999 # "UPID:$node:$pid:$pstart:$startime:$dtype:$id:$user"
1000
1001 sub upid_encode {
1002     my $d = shift;
1003
1004     # Note: pstart can be > 32bit if uptime > 497 days, so this can result in
1005     # more that 8 characters for pstart
1006     return sprintf("UPID:%s:%08X:%08X:%08X:%s:%s:%s:", $d->{node}, $d->{pid},
1007                    $d->{pstart}, $d->{starttime}, $d->{type}, $d->{id},
1008                    $d->{user});
1009 }
1010
1011 sub upid_decode {
1012     my ($upid, $noerr) = @_;
1013
1014     my $res;
1015     my $filename;
1016
1017     # "UPID:$node:$pid:$pstart:$startime:$dtype:$id:$user"
1018     # Note: allow up to 9 characters for pstart (work until 20 years uptime)
1019     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]+):$/) {
1020         $res->{node} = $1;
1021         $res->{pid} = hex($3);
1022         $res->{pstart} = hex($4);
1023         $res->{starttime} = hex($5);
1024         $res->{type} = $6;
1025         $res->{id} = $7;
1026         $res->{user} = $8;
1027
1028         my $subdir = substr($5, 7, 8);
1029         $filename = "$pvetaskdir/$subdir/$upid";
1030
1031     } else {
1032         return undef if $noerr;
1033         die "unable to parse worker upid '$upid'\n";
1034     }
1035
1036     return wantarray ? ($res, $filename) : $res;
1037 }
1038
1039 sub upid_open {
1040     my ($upid) = @_;
1041
1042     my ($task, $filename) = upid_decode($upid);
1043
1044     my $dirname = dirname($filename);
1045     make_path($dirname);
1046
1047     my $wwwid = getpwnam('www-data') ||
1048         die "getpwnam failed";
1049
1050     my $perm = 0640;
1051
1052     my $outfh = IO::File->new ($filename, O_WRONLY|O_CREAT|O_EXCL, $perm) ||
1053         die "unable to create output file '$filename' - $!\n";
1054     chown $wwwid, -1, $outfh;
1055
1056     return $outfh;
1057 };
1058
1059 sub upid_read_status {
1060     my ($upid) = @_;
1061
1062     my ($task, $filename) = upid_decode($upid);
1063     my $fh = IO::File->new($filename, "r");
1064     return "unable to open file - $!" if !$fh;
1065     my $maxlen = 4096;
1066     sysseek($fh, -$maxlen, 2);
1067     my $readbuf = '';
1068     my $br = sysread($fh, $readbuf, $maxlen);
1069     close($fh);
1070     if ($br) {
1071         return "unable to extract last line"
1072             if $readbuf !~ m/\n?(.+)$/;
1073         my $line = $1;
1074         if ($line =~ m/^TASK OK$/) {
1075             return 'OK';
1076         } elsif ($line =~ m/^TASK ERROR: (.+)$/) {
1077             return $1;
1078         } else {
1079             return "unexpected status";
1080         }
1081     }
1082     return "unable to read tail (got $br bytes)";
1083 }
1084
1085 # useful functions to store comments in config files
1086 sub encode_text {
1087     my ($text) = @_;
1088
1089     # all control and hi-bit characters, and ':'
1090     my $unsafe = "^\x20-\x39\x3b-\x7e";
1091     return uri_escape(Encode::encode("utf8", $text), $unsafe);
1092 }
1093
1094 sub decode_text {
1095     my ($data) = @_;
1096
1097     return Encode::decode("utf8", uri_unescape($data));
1098 }
1099
1100 # depreciated - do not use!
1101 # we now decode all parameters by default
1102 sub decode_utf8_parameters {
1103     my ($param) = @_;
1104
1105     foreach my $p (qw(comment description firstname lastname)) {
1106         $param->{$p} = decode('utf8', $param->{$p}) if $param->{$p};
1107     }
1108
1109     return $param;
1110 }
1111
1112 sub random_ether_addr {
1113     my ($prefix) = @_;
1114
1115     my ($seconds, $microseconds) = gettimeofday;
1116
1117     my $rand = Digest::SHA::sha1($$, rand(), $seconds, $microseconds);
1118
1119     # clear multicast, set local id
1120     vec($rand, 0, 8) = (vec($rand, 0, 8) & 0xfe) | 2;
1121
1122     my $addr = sprintf("%02X:%02X:%02X:%02X:%02X:%02X", unpack("C6", $rand));
1123     if (defined($prefix)) {
1124         $addr = uc($prefix) . substr($addr, length($prefix));
1125     }
1126     return $addr;
1127 }
1128
1129 sub shellquote {
1130     my $str = shift;
1131
1132     return String::ShellQuote::shell_quote($str);
1133 }
1134
1135 sub cmd2string {
1136     my ($cmd) = @_;
1137
1138     die "no arguments" if !$cmd;
1139
1140     return $cmd if !ref($cmd);
1141
1142     my @qa = ();
1143     foreach my $arg (@$cmd) { push @qa, shellquote($arg); }
1144
1145     return join (' ', @qa);
1146 }
1147
1148 # split an shell argument string into an array,
1149 sub split_args {
1150     my ($str) = @_;
1151
1152     return $str ? [ Text::ParseWords::shellwords($str) ] : [];
1153 }
1154
1155 sub dump_logfile {
1156     my ($filename, $start, $limit, $filter) = @_;
1157
1158     my $lines = [];
1159     my $count = 0;
1160
1161     my $fh = IO::File->new($filename, "r");
1162     if (!$fh) {
1163         $count++;
1164         push @$lines, { n => $count, t => "unable to open file - $!"};
1165         return ($count, $lines);
1166     }
1167
1168     $start = 0 if !$start;
1169     $limit = 50 if !$limit;
1170
1171     my $line;
1172
1173     if ($filter) {
1174         # duplicate code, so that we do not slow down normal path
1175         while (defined($line = <$fh>)) {
1176             next if $line !~ m/$filter/;
1177             next if $count++ < $start;
1178             next if $limit <= 0;
1179             chomp $line;
1180             push @$lines, { n => $count, t => $line};
1181             $limit--;
1182         }
1183     } else {
1184         while (defined($line = <$fh>)) {
1185             next if $count++ < $start;
1186             next if $limit <= 0;
1187             chomp $line;
1188             push @$lines, { n => $count, t => $line};
1189             $limit--;
1190         }
1191     }
1192
1193     close($fh);
1194
1195     # HACK: ExtJS store.guaranteeRange() does not like empty array
1196     # so we add a line
1197     if (!$count) {
1198         $count++;
1199         push @$lines, { n => $count, t => "no content"};
1200     }
1201
1202     return ($count, $lines);
1203 }
1204
1205 sub dump_journal {
1206     my ($start, $limit, $since, $until, $service) = @_;
1207
1208     my $lines = [];
1209     my $count = 0;
1210
1211     $start = 0 if !$start;
1212     $limit = 50 if !$limit;
1213
1214     my $parser = sub {
1215         my $line = shift;
1216
1217         return if $count++ < $start;
1218         return if $limit <= 0;
1219         push @$lines, { n => int($count), t => $line};
1220         $limit--;
1221     };
1222
1223     my $cmd = ['journalctl', '-o', 'short', '--no-pager'];
1224
1225     push @$cmd, '--unit', $service if $service;
1226     push @$cmd, '--since', $since if $since;
1227     push @$cmd, '--until', $until if $until;
1228     run_command($cmd, outfunc => $parser);
1229
1230     # HACK: ExtJS store.guaranteeRange() does not like empty array
1231     # so we add a line
1232     if (!$count) {
1233         $count++;
1234         push @$lines, { n => $count, t => "no content"};
1235     }
1236
1237     return ($count, $lines);
1238 }
1239
1240 sub dir_glob_regex {
1241     my ($dir, $regex) = @_;
1242
1243     my $dh = IO::Dir->new ($dir);
1244     return wantarray ? () : undef if !$dh;
1245
1246     while (defined(my $tmp = $dh->read)) {
1247         if (my @res = $tmp =~ m/^($regex)$/) {
1248             $dh->close;
1249             return wantarray ? @res : $tmp;
1250         }
1251     }
1252     $dh->close;
1253
1254     return wantarray ? () : undef;
1255 }
1256
1257 sub dir_glob_foreach {
1258     my ($dir, $regex, $func) = @_;
1259
1260     my $dh = IO::Dir->new ($dir);
1261     if (defined $dh) {
1262         while (defined(my $tmp = $dh->read)) {
1263             if (my @res = $tmp =~ m/^($regex)$/) {
1264                 &$func (@res);
1265             }
1266         }
1267     }
1268 }
1269
1270 sub assert_if_modified {
1271     my ($digest1, $digest2) = @_;
1272
1273     if ($digest1 && $digest2 && ($digest1 ne $digest2)) {
1274         die "detected modified configuration - file changed by other user? Try again.\n";
1275     }
1276 }
1277
1278 # Digest for short strings
1279 # like FNV32a, but we only return 31 bits (positive numbers)
1280 sub fnv31a {
1281     my ($string) = @_;
1282
1283     my $hval = 0x811c9dc5;
1284
1285     foreach my $c (unpack('C*', $string)) {
1286         $hval ^= $c;
1287         $hval += (
1288             (($hval << 1) ) +
1289             (($hval << 4) ) +
1290             (($hval << 7) ) +
1291             (($hval << 8) ) +
1292             (($hval << 24) ) );
1293         $hval = $hval & 0xffffffff;
1294     }
1295     return $hval & 0x7fffffff;
1296 }
1297
1298 sub fnv31a_hex { return sprintf("%X", fnv31a(@_)); }
1299
1300 sub unpack_sockaddr_in46 {
1301     my ($sin) = @_;
1302     my $family = Socket::sockaddr_family($sin);
1303     my ($port, $host) = ($family == AF_INET6 ? Socket::unpack_sockaddr_in6($sin)
1304                                              : Socket::unpack_sockaddr_in($sin));
1305     return ($family, $port, $host);
1306 }
1307
1308 sub getaddrinfo_all {
1309     my ($hostname, @opts) = @_;
1310     my %hints = ( flags => AI_V4MAPPED | AI_ALL,
1311                   @opts );
1312     my ($err, @res) = Socket::getaddrinfo($hostname, '0', \%hints);
1313     die "failed to get address info for: $hostname: $err\n" if $err;
1314     return @res;
1315 }
1316
1317 sub get_host_address_family {
1318     my ($hostname, $socktype) = @_;
1319     my @res = getaddrinfo_all($hostname, socktype => $socktype);
1320     return $res[0]->{family};
1321 }
1322
1323 # get the fully qualified domain name of a host
1324 # same logic as hostname(1): The FQDN is the name getaddrinfo(3) returns,
1325 # given a nodename as a parameter
1326 sub get_fqdn {
1327     my ($nodename) = @_;
1328
1329     my $hints = {
1330         flags => AI_CANONNAME,
1331         socktype => SOCK_DGRAM
1332     };
1333
1334     my ($err, @addrs) = Socket::getaddrinfo($nodename, undef, $hints);
1335
1336     die "getaddrinfo: $err" if $err;
1337
1338     return $addrs[0]->{canonname};
1339 }
1340
1341 # Parses any sane kind of host, or host+port pair:
1342 # The port is always optional and thus may be undef.
1343 sub parse_host_and_port {
1344     my ($address) = @_;
1345     if ($address =~ /^($IPV4RE|[[:alnum:]\-.]+)(?::(\d+))?$/ ||             # ipv4 or host with optional ':port'
1346         $address =~ /^\[($IPV6RE|$IPV4RE|[[:alnum:]\-.]+)\](?::(\d+))?$/ || # anything in brackets with optional ':port'
1347         $address =~ /^($IPV6RE)(?:\.(\d+))?$/)                              # ipv6 with optional port separated by dot
1348     {
1349         return ($1, $2, 1); # end with 1 to support simple if(parse...) tests
1350     }
1351     return; # nothing
1352 }
1353
1354 sub unshare($) {
1355     my ($flags) = @_;
1356     return 0 == syscall(PVE::Syscall::unshare, $flags);
1357 }
1358
1359 sub setns($$) {
1360     my ($fileno, $nstype) = @_;
1361     return 0 == syscall(PVE::Syscall::setns, $fileno, $nstype);
1362 }
1363
1364 sub syncfs($) {
1365     my ($fileno) = @_;
1366     return 0 == syscall(PVE::Syscall::syncfs, $fileno);
1367 }
1368
1369 sub sync_mountpoint {
1370     my ($path) = @_;
1371     sysopen my $fd, $path, O_PATH or die "failed to open $path: $!\n";
1372     my $result = syncfs(fileno($fd));
1373     close($fd);
1374     return $result;
1375 }
1376
1377 # support sending multi-part mail messages with a text and or a HTML part
1378 # mailto may be a single email string or an array of receivers
1379 sub sendmail {
1380     my ($mailto, $subject, $text, $html, $mailfrom, $author) = @_;
1381     my $mail_re = qr/[^-a-zA-Z0-9+._@]/;
1382
1383     $mailto = [ $mailto ] if !ref($mailto);
1384
1385     foreach (@$mailto) {
1386         die "illegal character in mailto address\n"
1387             if ($_ =~ $mail_re);
1388     }
1389
1390     my $rcvrtxt = join (', ', @$mailto);
1391
1392     $mailfrom = $mailfrom || "root";
1393     die "illegal character in mailfrom address\n"
1394         if $mailfrom =~ $mail_re;
1395
1396     $author = $author || 'Proxmox VE';
1397
1398     open (MAIL, "|-", "sendmail", "-B", "8BITMIME", "-f", $mailfrom, @$mailto) ||
1399         die "unable to open 'sendmail' - $!";
1400
1401     # multipart spec see https://www.ietf.org/rfc/rfc1521.txt
1402     my $boundary = "----_=_NextPart_001_".int(time).$$;
1403
1404     print MAIL "Content-Type: multipart/alternative;\n";
1405     print MAIL "\tboundary=\"$boundary\"\n";
1406     print MAIL "MIME-Version: 1.0\n";
1407
1408     print MAIL "FROM: $author <$mailfrom>\n";
1409     print MAIL "TO: $rcvrtxt\n";
1410     print MAIL "SUBJECT: $subject\n";
1411     print MAIL "\n";
1412     print MAIL "This is a multi-part message in MIME format.\n\n";
1413     print MAIL "--$boundary\n";
1414
1415     if (defined($text)) {
1416         print MAIL "Content-Type: text/plain;\n";
1417         print MAIL "\tcharset=\"UTF8\"\n";
1418         print MAIL "Content-Transfer-Encoding: 8bit\n";
1419         print MAIL "\n";
1420
1421         # avoid 'remove extra line breaks' issue (MS Outlook)
1422         my $fill = '  ';
1423         $text =~ s/^/$fill/gm;
1424
1425         print MAIL $text;
1426
1427         print MAIL "\n--$boundary\n";
1428     }
1429
1430     if (defined($html)) {
1431         print MAIL "Content-Type: text/html;\n";
1432         print MAIL "\tcharset=\"UTF8\"\n";
1433         print MAIL "Content-Transfer-Encoding: 8bit\n";
1434         print MAIL "\n";
1435
1436         print MAIL $html;
1437
1438         print MAIL "\n--$boundary--\n";
1439     }
1440
1441     close(MAIL);
1442 }
1443
1444 sub tempfile {
1445     my ($perm, %opts) = @_;
1446
1447     # default permissions are stricter than with file_set_contents
1448     $perm = 0600 if !defined($perm);
1449
1450     my $dir = $opts{dir} // '/run';
1451     my $mode = $opts{mode} // O_RDWR;
1452     $mode |= O_EXCL if !$opts{allow_links};
1453
1454     my $fh = IO::File->new($dir, $mode | O_TMPFILE, $perm);
1455     if (!$fh && $! == EOPNOTSUPP) {
1456         $dir = '/tmp' if !defined($opts{dir});
1457         $dir .= "/.tmpfile.$$";
1458         $fh = IO::File->new($dir, $mode | O_CREAT | O_EXCL, $perm);
1459         unlink($dir) if $fh;
1460     }
1461     die "failed to create tempfile: $!\n" if !$fh;
1462     return $fh;
1463 }
1464
1465 sub tempfile_contents {
1466     my ($data, $perm, %opts) = @_;
1467
1468     my $fh = tempfile($perm, %opts);
1469     eval {
1470         die "unable to write to tempfile: $!\n" if !print {$fh} $data;
1471         die "unable to flush to tempfile: $!\n" if !defined($fh->flush());
1472     };
1473     if (my $err = $@) {
1474         close $fh;
1475         die $err;
1476     }
1477
1478     return ("/proc/$$/fd/".$fh->fileno, $fh);
1479 }
1480
1481 sub validate_ssh_public_keys {
1482     my ($raw) = @_;
1483     my @lines = split(/\n/, $raw);
1484
1485     foreach my $line (@lines) {
1486         next if $line =~ m/^\s*$/;
1487         eval {
1488             my ($filename, $handle) = tempfile_contents($line);
1489             run_command(["ssh-keygen", "-l", "-f", $filename],
1490                         outfunc => sub {}, errfunc => sub {});
1491         };
1492         die "SSH public key validation error\n" if $@;
1493     }
1494 }
1495
1496 sub openat($$$;$) {
1497     my ($dirfd, $pathname, $flags, $mode) = @_;
1498     my $fd = syscall(PVE::Syscall::openat, $dirfd, $pathname, $flags, $mode//0);
1499     return undef if $fd < 0;
1500     # sysopen() doesn't deal with numeric file descriptors apparently
1501     # so we need to convert to a mode string for IO::Handle->new_from_fd
1502     my $flagstr = ($flags & O_RDWR) ? 'rw' : ($flags & O_WRONLY) ? 'w' : 'r';
1503     my $handle = IO::Handle->new_from_fd($fd, $flagstr);
1504     return $handle if $handle;
1505     my $err = $!; # save error before closing the raw fd
1506     syscall(PVE::Syscall::close, $fd); # close
1507     $! = $err;
1508     return undef;
1509 }
1510
1511 sub mkdirat($$$) {
1512     my ($dirfd, $name, $mode) = @_;
1513     return syscall(PVE::Syscall::mkdirat, $dirfd, $name, $mode) == 0;
1514 }
1515
1516 # NOTE: This calls the dbus main loop and must not be used when another dbus
1517 # main loop is being used as we need to wait for the JobRemoved signal.
1518 # Polling the job status instead doesn't work because this doesn't give us the
1519 # distinction between success and failure.
1520 #
1521 # Note that the description is mandatory for security reasons.
1522 sub enter_systemd_scope {
1523     my ($unit, $description, %extra) = @_;
1524     die "missing description\n" if !defined($description);
1525
1526     my $timeout = delete $extra{timeout};
1527
1528     $unit .= '.scope';
1529     my $properties = [ [PIDs => [dbus_uint32($$)]] ];
1530
1531     foreach my $key (keys %extra) {
1532         if ($key eq 'Slice' || $key eq 'KillMode') {
1533             push @$properties, [$key, $extra{$key}];
1534         } elsif ($key eq 'CPUShares') {
1535             push @$properties, [$key, dbus_uint64($extra{$key})];
1536         } elsif ($key eq 'CPUQuota') {
1537             push @$properties, ['CPUQuotaPerSecUSec',
1538                                 dbus_uint64($extra{$key} * 10000)];
1539         } else {
1540             die "Don't know how to encode $key for systemd scope\n";
1541         }
1542     }
1543
1544     my $job;
1545     my $done = 0;
1546
1547     my $bus = Net::DBus->system();
1548     my $reactor = Net::DBus::Reactor->main();
1549
1550     my $service = $bus->get_service('org.freedesktop.systemd1');
1551     my $if = $service->get_object('/org/freedesktop/systemd1', 'org.freedesktop.systemd1.Manager');
1552     # Connect to the JobRemoved signal since we want to wait for it to finish
1553     my $sigid;
1554     my $timer;
1555     my $cleanup = sub {
1556         my ($no_shutdown) = @_;
1557         $if->disconnect_from_signal('JobRemoved', $sigid) if defined($if);
1558         $if = undef;
1559         $sigid = undef;
1560         $reactor->remove_timeout($timer) if defined($timer);
1561         $timer = undef;
1562         return if $no_shutdown;
1563         $reactor->shutdown();
1564     };
1565
1566     $sigid = $if->connect_to_signal('JobRemoved', sub {
1567         my ($id, $removed_job, $signaled_unit, $result) = @_;
1568         return if $signaled_unit ne $unit || $removed_job ne $job;
1569         $cleanup->(0);
1570         die "systemd job failed\n" if $result ne 'done';
1571         $done = 1;
1572     });
1573
1574     my $on_timeout = sub {
1575         $cleanup->(0);
1576         die "systemd job timed out\n";
1577     };
1578
1579     $timer = $reactor->add_timeout($timeout * 1000, Net::DBus::Callback->new(method => $on_timeout))
1580         if defined($timeout);
1581     $job = $if->StartTransientUnit($unit, 'fail', $properties, []);
1582     $reactor->run();
1583     $cleanup->(1);
1584     die "systemd job never completed\n" if !$done;
1585 }
1586
1587 my $salt_starter = time();
1588
1589 sub encrypt_pw {
1590     my ($pw) = @_;
1591
1592     $salt_starter++;
1593     my $salt = substr(Digest::SHA::sha1_base64(time() + $salt_starter + $$), 0, 8);
1594
1595     # crypt does not want '+' in salt (see 'man crypt')
1596     $salt =~ s/\+/X/g;
1597
1598     return crypt(encode("utf8", $pw), "\$5\$$salt\$");
1599 }
1600
1601 # intended usage: convert_size($val, "kb" => "gb")
1602 # we round up to the next integer by default
1603 # E.g. `convert_size(1023, "b" => "kb")` returns 1
1604 # use $no_round_up to switch this off, above example would then return 0
1605 # this is also true for converting down e.g. 0.0005 gb to mb returns 1
1606 # (0 if $no_round_up is true)
1607 # allowed formats for value:
1608 # 1234
1609 # 1234.
1610 # 1234.1234
1611 # .1234
1612 sub convert_size {
1613     my ($value, $from, $to, $no_round_up) = @_;
1614
1615     my $units = {
1616         b  => 0,
1617         kb => 1,
1618         mb => 2,
1619         gb => 3,
1620         tb => 4,
1621         pb => 5,
1622     };
1623
1624     die "no value given"
1625         if !defined($value) || $value eq "";
1626
1627     $from = lc($from // ''); $to = lc($to // '');
1628     die "unknown 'from' and/or 'to' units ($from => $to)"
1629         if !defined($units->{$from}) || !defined($units->{$to});
1630
1631     die "value '$value' is not a valid, positive number"
1632         if $value !~ m/^(?:[0-9]+\.?[0-9]*|[0-9]*\.[0-9]+)$/;
1633
1634     my $shift_amount = ($units->{$from} - $units->{$to}) * 10;
1635
1636     $value *= 2**$shift_amount;
1637     $value++ if !$no_round_up && ($value - int($value)) > 0.0;
1638
1639     return int($value);
1640 }
1641
1642 1;