improve doc generator, introduce verbose_description property

[pve-common.git] / src / PVE / Tools.pm

diff --git a/src/PVE/Tools.pm b/src/PVE/Tools.pm
index 40dfc5a36908eb73c569b9e5ce406f598561c933..8c7f3733f80aa0c0338a09c6d9d314122138a342 100644 (file)
--- a/src/PVE/Tools.pm
+++ b/src/PVE/Tools.pm
@@ -678,7 +678,7 @@ my $keymaphash =  {
 };
 
 my $kvmkeymaparray = [];
-foreach my $lc (keys %$keymaphash) {
+foreach my $lc (sort keys %$keymaphash) {
     push @$kvmkeymaparray, $keymaphash->{$lc}->[1];
 }
 
@@ -1214,6 +1214,68 @@ sub sync_mountpoint {
     return $result;
 }
 
+# support sending multi-part mail messages with a text and or a HTML part
+# mailto may be a single email string or an array of receivers
+sub sendmail {
+    my ($mailto, $subject, $text, $html, $mailfrom, $author) = @_;
+
+    $mailto = [ $mailto ] if !ref($mailto);
+
+    my $rcvrarg = '';
+    foreach my $r (@$mailto) {
+       $rcvrarg .= " '$r'";
+    }
+    my $rcvrtxt = join (', ', @$mailto);
+
+    $mailfrom = $mailfrom || "root";
+    $author = $author || 'Proxmox VE';
+
+    open (MAIL,"|sendmail -B 8BITMIME -f $mailfrom $rcvrarg") ||
+       die "unable to open 'sendmail' - $!";
+
+    # multipart spec see https://www.ietf.org/rfc/rfc1521.txt
+    my $boundary = "----_=_NextPart_001_".int(time).$$;
+
+    print MAIL "Content-Type: multipart/alternative;\n";
+    print MAIL "\tboundary=\"$boundary\"\n";
+    print MAIL "MIME-Version: 1.0\n";
+
+    print MAIL "FROM: $author <$mailfrom>\n";
+    print MAIL "TO: $rcvrtxt\n";
+    print MAIL "SUBJECT: $subject\n";
+    print MAIL "\n";
+    print MAIL "This is a multi-part message in MIME format.\n\n";
+    print MAIL "--$boundary\n";
+
+    if (defined($text)) {
+       print MAIL "Content-Type: text/plain;\n";
+       print MAIL "\tcharset=\"UTF8\"\n";
+       print MAIL "Content-Transfer-Encoding: 8bit\n";
+       print MAIL "\n";
+
+       # avoid 'remove extra line breaks' issue (MS Outlook)
+       my $fill = '  ';
+       $text =~ s/^/$fill/gm;
+
+       print MAIL $text;
+
+       print MAIL "\n--$boundary\n";
+    }
+
+    if (defined($html)) {
+       print MAIL "Content-Type: text/html;\n";
+       print MAIL "\tcharset=\"UTF8\"\n";
+       print MAIL "Content-Transfer-Encoding: 8bit\n";
+       print MAIL "\n";
+
+       print MAIL $html;
+
+       print MAIL "\n--$boundary--\n";
+    }
+
+    close(MAIL);
+}
+
 sub tempfile {
     my ($perm, %opts) = @_;
 
@@ -1245,4 +1307,19 @@ sub tempfile_contents {
     return ("/proc/$$/fd/".$fh->fileno, $fh);
 }
 
+sub validate_ssh_public_keys {
+    my ($raw) = @_;
+    my @lines = split(/\n/, $raw);
+
+    foreach my $line (@lines) {
+       next if $line =~ m/^\s*$/;
+       eval {
+           my ($filename, $handle) = tempfile_contents($line);
+           run_command(["ssh-keygen", "-l", "-f", $filename],
+                       outfunc => sub {}, errfunc => sub {});
+       };
+       die "SSH public key validation error\n" if $@;
+    }
+}
+
 1;