Changeset 86896 in vbox for trunk/src/VBox/Frontends

Timestamp:

Nov 16, 2020 5:43:13 PM (4 years ago)

Author:

vboxsync

svn:sync-xref-src-repo-rev:

141367

Message:

FE/Qt: bugref:9722: VirtualBox Manager: Propose user a set of external tools to generate public key if none was found.

File:

• trunk/src/VBox/Frontends/VirtualBox/src/manager/UIVirtualBoxManager.cpp (modified) (14 diffs)

trunk/src/VBox/Frontends/VirtualBox/src/manager/UIVirtualBoxManager.cpp

@@ -25 +25 @@
 #include <QStandardPaths>
 #include <QStatusBar>
+#include <QStyle>
 #include <QTextEdit>
 #ifndef VBOX_WS_WIN
@@ -34 +35 @@
 #include "QIDialogButtonBox.h"
 #include "QIFileDialog.h"
+#include "QIRichTextLabel.h"
 #include "UIActionPoolManager.h"
 #include "UICloudConsoleManager.h"
@@ -40 +42 @@
 #include "UICloudProfileManager.h"
 #include "UIDesktopServices.h"
+#include "UIDesktopWidgetWatchdog.h"
 #include "UIErrorString.h"
 #include "UIExtraDataManager.h"
@@ -118 +121 @@
 private slots:
 
+    /** Handles help-viewer @a link click. */
+    void sltHandleHelpViewerLinkClick(const QUrl &link);
+
     /** Handles abstract @a pButton click. */
     void sltHandleButtonClicked(QAbstractButton *pButton);
@@ -142 +148 @@
     /** Returns a list of default key folders. */
     QStringList defaultKeyFolders() const;
+    /** Returns a list of key generation tools. */
+    QStringList keyGenerationTools() const;
 
     /** Loads file contents.
@@ -147 +155 @@
     bool loadFileContents(const QString &strPath, bool fIgnoreErrors = false);
 
+    /** Holds the help-viewer instance. */
+    QIRichTextLabel   *m_pHelpViewer;
     /** Holds the text-editor instance. */
     QTextEdit         *m_pTextEditor;
@@ -160 +170 @@
 UIAcquirePublicKeyDialog::UIAcquirePublicKeyDialog(QWidget *pParent /* = 0 */)
     : QIWithRetranslateUI<QDialog>(pParent)
+    , m_pHelpViewer(0)
     , m_pTextEditor(0)
     , m_pButtonBox(0)
@@ -170 +181 @@
 {
     return m_pTextEditor->toPlainText();
+}
+
+void UIAcquirePublicKeyDialog::sltHandleHelpViewerLinkClick(const QUrl &link)
+{
+    /* Parse the link meta and use it to get tool path to copy to clipboard: */
+    bool fOk = false;
+    const uint uToolNumber = link.toString().section('#', 1, 1).toUInt(&fOk);
+    if (fOk)
+        QApplication::clipboard()->setText(keyGenerationTools().value(uToolNumber), QClipboard::Clipboard);
 }
 
@@ -204 +224 @@
 {
     setWindowTitle(tr("Public key"));
+
+    /* Generating help-viewer text: */
+    QStringList folders;
+    foreach (const QString &strFolder, defaultKeyFolders())
+        folders << QString("&nbsp;%1").arg(strFolder);
+    const QStringList initialTools = keyGenerationTools();
+    QStringList tools;
+    foreach (const QString &strTool, initialTools)
+        tools << QString("&nbsp;<a href=#%1><img src='manager://copy'/></a>&nbsp;&nbsp;%2")
+                         .arg(initialTools.indexOf(strTool))
+                         .arg(strTool);
+#ifdef VBOX_WS_WIN
+    m_pHelpViewer->setText(tr("We haven't found public key id_rsa[.pub] in suitable locations. "
+                              "If you have one, please put it under one of those folders OR copy "
+                              "content to the edit box below:<br><br>"
+                              "%1<br><br>"
+                              "If you don't have one, please consider using one of the following "
+                              "tools to generate it:<br><br>"
+                              "%2")
+                           .arg(folders.join("<br>"))
+                           .arg(tools.join("<br>")));
+#else
+    m_pHelpViewer->setText(tr("We haven't found public key id_rsa[.pub] in suitable location. "
+                              "If you have one, please put it under specified folder OR copy "
+                              "content to the edit box below:<br><br>"
+                              "%1<br><br>"
+                              "If you don't have one, please consider using the following "
+                              "tool to generate it:<br><br>"
+                              "%2")
+                           .arg(folders.join("<br>"))
+                           .arg(tools.join("<br>")));
+#endif
+
     m_pTextEditor->setPlaceholderText(tr("Paste public key"));
     m_pButtonBox->button(QDialogButtonBox::Open)->setText(tr("Browse"));
@@ -219 +272 @@
     /* Resize to suitable size: */
     const int iMinimumHeightHint = minimumSizeHint().height();
-    resize(iMinimumHeightHint * 2, iMinimumHeightHint);
+    resize(iMinimumHeightHint * 1.618, iMinimumHeightHint);
 }
 
@@ -228 +281 @@
     if (pLayout)
     {
+        /* Create help-viewer: */
+        m_pHelpViewer = new QIRichTextLabel(this);
+        if (m_pHelpViewer)
+        {
+            /* Prepare icon and size as well: */
+            const QIcon icon = UIIconPool::iconSet(":/file_manager_copy_16px.png");
+            const int iMetric = QApplication::style()->pixelMetric(QStyle::PM_SmallIconSize) * 2 / 3;
+
+            /* Configure help-viewer: */
+            m_pHelpViewer->setHidden(true);
+            m_pHelpViewer->setMinimumTextWidth(gpDesktop->screenGeometry(window()).width() / 5);
+            m_pHelpViewer->registerPixmap(icon.pixmap(window()->windowHandle(), QSize(iMetric, iMetric)), "manager://copy");
+            connect(m_pHelpViewer, &QIRichTextLabel::sigLinkClicked, this, &UIAcquirePublicKeyDialog::sltHandleHelpViewerLinkClick);
+            pLayout->addWidget(m_pHelpViewer, 2);
+        }
+
         /* Prepare text-editor: */
         m_pTextEditor = new QTextEdit(this);
@@ -233 +302 @@
         {
             connect(m_pTextEditor, &QTextEdit::textChanged, this, &UIAcquirePublicKeyDialog::sltRevalidate);
-            pLayout->addWidget(m_pTextEditor);
+            pLayout->addWidget(m_pTextEditor, 1);
         }
 
@@ -284 +353 @@
             fFileLoaded = loadFileContents(strAbsoluteFilePathWeNeed, true /* ignore errors */);
     }
+
+    /* Show/hide help-viewer depending on
+     * whether we were able to load the file: */
+    m_pHelpViewer->setHidden(fFileLoaded);
 }
 
@@ -296 +369 @@
     folders << QDir::toNativeSeparators(QDir(QDir::homePath()).absoluteFilePath(".ssh"));
     return folders;
+}
+
+QStringList UIAcquirePublicKeyDialog::keyGenerationTools() const
+{
+    QStringList tools;
+#ifdef VBOX_WS_WIN
+    // WORKAROUND:
+    // There is additional key generation tool on Windows:
+    tools << "puttygen.exe";
+    tools << "ssh-keygen.exe -m PEM -t rsa -b 4096";
+#else
+    tools << "ssh-keygen -m PEM -t rsa -b 4096";
+#endif
+    return tools;
 }