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