]>
git.proxmox.com Git - pve-common.git/blob - data/PVE/Tools.pm
8 use File
::Path
qw(make_path);
11 use Fcntl
qw(:DEFAULT :flock);
30 my $pvelogdir = "/var/log/pve";
31 my $pvetaskdir = "$pvelogdir/tasks";
36 # flock: we use one file handle per process, so lock file
37 # can be called multiple times and succeeds for the same process.
39 my $lock_handles = {};
42 my ($filename, $timeout, $code, @param) = @_;
46 $timeout = 10 if !$timeout;
50 local $SIG{ALRM
} = sub { die "got timeout (can't lock '$filename')\n"; };
54 if (!$lock_handles->{$$}->{$filename}) {
55 $lock_handles->{$$}->{$filename} = new IO
::File
(">>$filename") ||
56 die "can't open lock file '$filename' - $!\n";
59 if (!flock ($lock_handles->{$$}->{$filename}, LOCK_EX
|LOCK_NB
)) {
60 print STDERR
"trying to aquire lock...";
61 if (!flock ($lock_handles->{$$}->{$filename}, LOCK_EX
)) {
62 print STDERR
" failed\n";
63 die "can't aquire lock for '$filename' - $!\n";
69 $res = &$code(@param);
76 if ($lock_handles->{$$}->{$filename}) {
77 my $fh = $lock_handles->{$$}->{$filename};
78 $lock_handles->{$$}->{$filename} = undef;
92 sub file_set_contents
{
93 my ($filename, $data, $perm) = @_;
95 $perm = 0644 if !defined($perm);
97 my $tmpname = "$filename.tmp.$$";
100 my $fh = IO
::File-
>new($tmpname, O_WRONLY
|O_CREAT
, $perm);
101 die "unable to open file '$tmpname' - $!\n" if !$fh;
102 die "unable to write '$tmpname' - $!\n" unless print $fh $data;
103 die "closing file '$tmpname' failed - $!\n" unless close $fh;
112 if (!rename($tmpname, $filename)) {
113 my $msg = "close (rename) atomic file '$filename' failed: $!\n";
119 sub file_get_contents
{
120 my ($filename, $max) = @_;
122 my $fh = IO
::File-
>new($filename, "r") ||
123 die "can't open '$filename' - $!\n";
125 my $content = safe_read_from
($fh, $max);
132 sub file_read_firstline
{
135 my $fh = IO
::File-
>new ($filename, "r");
136 return undef if !$fh;
144 my ($fh, $max, $oneline) = @_;
146 $max = 32768 if !$max;
151 while ($count = sysread($fh, $input, 8192, $br)) {
153 die "input too long - aborting\n" if $br > $max;
154 if ($oneline && $input =~ m/^(.*)\n/) {
159 die "unable to read input - $!\n" if !defined($count);
165 my ($cmd, %param) = @_;
169 $cmd = [ $cmd ] if !ref($cmd);
171 my $cmdstr = join (' ', @$cmd);
186 foreach my $p (keys %param) {
187 if ($p eq 'timeout') {
188 $timeout = $param{$p};
189 } elsif ($p eq 'umask') {
191 } elsif ($p eq 'errmsg') {
192 $errmsg = $param{$p};
194 print STDERR
"$laststderr\n" if $laststderr;
197 } elsif ($p eq 'input') {
199 } elsif ($p eq 'output') {
200 $output = $param{$p};
201 } elsif ($p eq 'outfunc') {
202 $outfunc = $param{$p};
203 } elsif ($p eq 'errfunc') {
204 $errfunc = $param{$p};
205 } elsif ($p eq 'logfunc') {
206 $logfunc = $param{$p};
208 die "got unknown parameter '$p' for run_command\n";
212 my $reader = $output && $output =~ m/^>&/ ?
$output : IO
::File-
>new();
213 my $writer = $input && $input =~ m/^<&/ ?
$input : IO
::File-
>new();
214 my $error = IO
::File-
>new();
216 # try to avoid locale related issues/warnings
217 my $lang = $param{lang
} || 'C';
222 local $ENV{LC_ALL
} = $lang;
224 # suppress LVM warnings like: "File descriptor 3 left open";
225 local $ENV{LVM_SUPPRESS_FD_WARNINGS
} = "1";
227 $pid = open3
($writer, $reader, $error, @$cmd) || die $!;
229 # if we pipe fron STDIN, open3 closes STDIN, so we we
230 # a perl warning "Filehandle STDIN reopened as GENXYZ .. "
231 # as soon as we open a new file.
232 # to avoid that we open /dev/null
233 if (!ref($writer) && !defined(fileno(STDIN
))) {
235 open(STDIN
, "</dev/null");
242 if ($orig_pid != $$) {
250 local $SIG{ALRM
} = sub { die "got timeout\n"; } if $timeout;
251 $oldtimeout = alarm($timeout) if $timeout;
254 print $writer $input if defined $input;
258 my $select = new IO
::Select
;
259 $select->add($reader) if ref($reader);
260 $select->add($error);
265 my $starttime = time();
267 while ($select->count) {
268 my @handles = $select->can_read(1);
270 foreach my $h (@handles) {
272 my $count = sysread ($h, $buf, 4096);
273 if (!defined ($count)) {
279 $select->remove ($h) if !$count;
281 if ($outfunc || $logfunc) {
284 while ($outlog =~ s/^([^\010\r\n]*)(\r|\n|(\010)+|\r\n)//s) {
286 &$outfunc($line) if $outfunc;
287 &$logfunc($line) if $logfunc;
300 } elsif ($h eq $error) {
301 if ($errfunc || $logfunc) {
304 while ($errlog =~ s/^([^\010\r\n]*)(\r|\n|(\010)+|\r\n)//s) {
306 &$errfunc($line) if $errfunc;
307 &$logfunc($line) if $logfunc;
324 &$outfunc($outlog) if $outfunc && $outlog;
325 &$logfunc($outlog) if $logfunc && $outlog;
327 &$errfunc($errlog) if $errfunc && $errlog;
328 &$logfunc($errlog) if $logfunc && $errlog;
333 die "failed to execute\n";
334 } elsif (my $sig = ($? & 127)) {
335 die "got signal $sig\n";
336 } elsif (my $ec = ($? >> 8)) {
337 if (!($ec == 24 && ($cmdstr =~ m
|^(\S
+/)?rsync\s
|))) {
338 if ($errmsg && $laststderr) {
339 my $lerr = $laststderr;
343 die "exit code $ec\n";
354 print STDERR
"$laststderr\n" if $laststderr;
356 umask ($old_umask) if defined($old_umask);
358 alarm($oldtimeout) if $oldtimeout;
361 if ($pid && ($err eq "got timeout\n")) {
364 die "command '$cmdstr' failed: $err";
370 die "command '$cmdstr' failed: $err";
378 my $listtxt = shift || '';
380 return split (/\0/, $listtxt) if $listtxt =~ m/\0/;
382 $listtxt =~ s/[,;]/ /g;
383 $listtxt =~ s/^\s+//;
385 my @data = split (/\s+/, $listtxt);
393 return $txt if !defined($txt);
401 # simple uri templates like "/vms/{vmid}"
402 sub template_replace
{
403 my ($tmpl, $data) = @_;
406 while ($tmpl =~ m/([^{]+)?({([^}]+)})?/g) {
408 $res .= ($data->{$3} || '-') if $2;
414 my ($filename, $fh, $data) = @_;
418 my $res = print $fh $data;
420 die "write to '$filename' failed\n" if !$res;
426 'at' => 'ftp.at.debian.org',
427 'au' => 'ftp.au.debian.org',
428 'be' => 'ftp.be.debian.org',
429 'bg' => 'ftp.bg.debian.org',
430 'br' => 'ftp.br.debian.org',
431 'ca' => 'ftp.ca.debian.org',
432 'ch' => 'ftp.ch.debian.org',
433 'cl' => 'ftp.cl.debian.org',
434 'cz' => 'ftp.cz.debian.org',
435 'de' => 'ftp.de.debian.org',
436 'dk' => 'ftp.dk.debian.org',
437 'ee' => 'ftp.ee.debian.org',
438 'es' => 'ftp.es.debian.org',
439 'fi' => 'ftp.fi.debian.org',
440 'fr' => 'ftp.fr.debian.org',
441 'gr' => 'ftp.gr.debian.org',
442 'hk' => 'ftp.hk.debian.org',
443 'hr' => 'ftp.hr.debian.org',
444 'hu' => 'ftp.hu.debian.org',
445 'ie' => 'ftp.ie.debian.org',
446 'is' => 'ftp.is.debian.org',
447 'it' => 'ftp.it.debian.org',
448 'jp' => 'ftp.jp.debian.org',
449 'kr' => 'ftp.kr.debian.org',
450 'mx' => 'ftp.mx.debian.org',
451 'nl' => 'ftp.nl.debian.org',
452 'no' => 'ftp.no.debian.org',
453 'nz' => 'ftp.nz.debian.org',
454 'pl' => 'ftp.pl.debian.org',
455 'pt' => 'ftp.pt.debian.org',
456 'ro' => 'ftp.ro.debian.org',
457 'ru' => 'ftp.ru.debian.org',
458 'se' => 'ftp.se.debian.org',
459 'si' => 'ftp.si.debian.org',
460 'sk' => 'ftp.sk.debian.org',
461 'tr' => 'ftp.tr.debian.org',
462 'tw' => 'ftp.tw.debian.org',
463 'gb' => 'ftp.uk.debian.org',
464 'us' => 'ftp.us.debian.org',
470 'dk' => ['Danish', 'da', 'qwerty/dk-latin1.kmap.gz', 'dk', 'nodeadkeys'],
471 'de' => ['German', 'de', 'qwertz/de-latin1-nodeadkeys.kmap.gz', 'de', 'nodeadkeys' ],
472 'de-ch' => ['Swiss-German', 'de-ch', 'qwertz/sg-latin1.kmap.gz', 'ch', 'de_nodeadkeys' ],
473 'en-gb' => ['United Kingdom', 'en-gb', 'qwerty/uk.kmap.gz' , 'gb', 'intl' ],
474 'en-us' => ['U.S. English', 'en-us', 'qwerty/us-latin1.kmap.gz', 'us', 'intl' ],
475 'es' => ['Spanish', 'es', 'qwerty/es.kmap.gz', 'es', 'nodeadkeys'],
476 #'et' => [], # Ethopia or Estonia ??
477 'fi' => ['Finnish', 'fi', 'qwerty/fi-latin1.kmap.gz', 'fi', 'nodeadkeys'],
478 #'fo' => ['Faroe Islands', 'fo', ???, 'fo', 'nodeadkeys'],
479 'fr' => ['French', 'fr', 'azerty/fr-latin1.kmap.gz', 'fr', 'nodeadkeys'],
480 'fr-be' => ['Belgium-French', 'fr-be', 'azerty/be2-latin1.kmap.gz', 'be', 'nodeadkeys'],
481 'fr-ca' => ['Canada-French', 'fr-ca', 'qwerty/cf.kmap.gz', 'ca', 'fr-legacy'],
482 'fr-ch' => ['Swiss-French', 'fr-ch', 'qwertz/fr_CH-latin1.kmap.gz', 'ch', 'fr_nodeadkeys'],
483 #'hr' => ['Croatia', 'hr', 'qwertz/croat.kmap.gz', 'hr', ??], # latin2?
484 'hu' => ['Hungarian', 'hu', 'qwertz/hu.kmap.gz', 'hu', undef],
485 'is' => ['Icelandic', 'is', 'qwerty/is-latin1.kmap.gz', 'is', 'nodeadkeys'],
486 'it' => ['Italian', 'it', 'qwerty/it2.kmap.gz', 'it', 'nodeadkeys'],
487 'jp' => ['Japanese', 'ja', 'qwerty/jp106.kmap.gz', 'jp', undef],
488 'lt' => ['Lithuanian', 'lt', 'qwerty/lt.kmap.gz', 'lt', 'std'],
489 #'lv' => ['Latvian', 'lv', 'qwerty/lv-latin4.kmap.gz', 'lv', ??], # latin4 or latin7?
490 'mk' => ['Macedonian', 'mk', 'qwerty/mk.kmap.gz', 'mk', 'nodeadkeys'],
491 'nl' => ['Dutch', 'nl', 'qwerty/nl.kmap.gz', 'nl', undef],
492 #'nl-be' => ['Belgium-Dutch', 'nl-be', ?, ?, ?],
493 'no' => ['Norwegian', 'no', 'qwerty/no-latin1.kmap.gz', 'no', 'nodeadkeys'],
494 'pl' => ['Polish', 'pl', 'qwerty/pl.kmap.gz', 'pl', undef],
495 'pt' => ['Portuguese', 'pt', 'qwerty/pt-latin1.kmap.gz', 'pt', 'nodeadkeys'],
496 'pt-br' => ['Brazil-Portuguese', 'pt-br', 'qwerty/br-latin1.kmap.gz', 'br', 'nodeadkeys'],
497 #'ru' => ['Russian', 'ru', 'qwerty/ru.kmap.gz', 'ru', undef], # dont know?
498 'si' => ['Slovenian', 'sl', 'qwertz/slovene.kmap.gz', 'si', undef],
499 #'sv' => [], Swedish ?
506 my ($param, $key) = @_;
508 my $res = $param->{$key};
509 delete $param->{$key};
516 for (my $p = 5900; $p < 6000; $p++) {
518 my $sock = IO
::Socket
::INET-
>new (Listen
=> 5,
519 LocalAddr
=> 'localhost',
530 die "unable to find free vnc port";
533 # NOTE: NFS syscall can't be interrupted, so alarm does
534 # not work to provide timeouts.
535 # from 'man nfs': "Only SIGKILL can interrupt a pending NFS operation"
536 # So the spawn external 'df' process instead of using
537 # Filesys::Df (which uses statfs syscall)
539 my ($path, $timeout) = @_;
541 my $cmd = [ 'df', '-P', '-B', '1', $path];
551 if (my ($fsid, $total, $used, $avail) = $line =~
552 m/^(\S+.*)\s+(\d+)\s+(\d+)\s+(\d+)\s+\d+%\s.*$/) {
560 eval { run_command
($cmd, timeout
=> $timeout, outfunc
=> $parser); };
567 # We use this to uniquely identify a process.
568 # An 'Unique Process ID' has the following format:
569 # "UPID:$node:$pid:$pstart:$startime:$dtype:$id:$user"
574 return sprintf("UPID:%s:%08X:%08X:%08X:%s:%s:%s:", $d->{node
}, $d->{pid
},
575 $d->{pstart
}, $d->{starttime
}, $d->{type
}, $d->{id
},
580 my ($upid, $noerr) = @_;
585 # "UPID:$node:$pid:$pstart:$startime:$dtype:$id:$user"
586 if ($upid =~ m/^UPID:([A-Za-z][[:alnum:]\-]*[[:alnum:]]+):([0-9A-Fa-f]{8}):([0-9A-Fa-f]{8}):([0-9A-Fa-f]{8}):([^:\s]+):([^:\s]*):([^:\s]+):$/) {
588 $res->{pid
} = hex($2);
589 $res->{pstart
} = hex($3);
590 $res->{starttime
} = hex($4);
595 my $subdir = substr($4, 7, 8);
596 $filename = "$pvetaskdir/$subdir/$upid";
599 return undef if $noerr;
600 die "unable to parse worker upid '$upid'\n";
603 return wantarray ?
($res, $filename) : $res;
609 my ($task, $filename) = upid_decode
($upid);
611 my $dirname = dirname
($filename);
614 my $wwwid = getpwnam('www-data') ||
615 die "getpwnam failed";
619 my $outfh = IO
::File-
>new ($filename, O_WRONLY
|O_CREAT
|O_EXCL
, $perm) ||
620 die "unable to create output file '$filename' - $!\n";
621 chown $wwwid, $outfh;
626 sub upid_read_status
{
629 my ($task, $filename) = upid_decode
($upid);
630 my $fh = IO
::File-
>new($filename, "r");
631 return "unable to open file - $!" if !$fh;
633 sysseek($fh, -$maxlen, 2);
635 my $br = sysread($fh, $readbuf, $maxlen);
638 return "unable to extract last line"
639 if $readbuf !~ m/\n?(.+)$/;
641 if ($line =~ m/^TASK OK$/) {
643 } elsif ($line =~ m/^TASK ERROR: (.+)$/) {
646 return "unexpected status";
649 return "unable to read tail (got $br bytes)";
652 # useful functions to store comments in config files
656 # all control and hi-bit characters, and ':'
657 my $unsafe = "^\x20-\x39\x3b-\x7e";
658 return uri_escape
(Encode
::encode
("utf8", $text), $unsafe);
664 return Encode
::decode
("utf8", uri_unescape
($data));
667 sub random_ether_addr
{
669 my $rand = Digest
::SHA1
::sha1_hex
(rand(), time());
672 for (my $i = 0; $i < 6; $i++) {
673 my $ss = hex(substr($rand, $i*2, 2));
675 $ss &= 0xfe; # clear multicast
676 $ss |= 2; # set local id
678 $ss = sprintf("%02X", $ss);
693 return "''" if !defined ($str) || ($str eq '');
695 die "unable to quote string containing null (\\000) bytes"
698 # from String::ShellQuote
699 if ($str =~ m
|[^\w
!%+,\-./:@^]|) {
712 # a clumsy way to split an shell argument string into an array,
713 # we simply pass it to the cli (exec call)
714 # fixme: use Text::ParseWords::shellwords() ?
720 return $args if !$str;
722 my $cmd = 'perl -e \'foreach my $a (@ARGV) { print "$a\n"; } \' -- ' . $str;
725 run_command
($cmd, outfunc
=> sub {
733 die "unable to parse args: $str\n" if $err;