Changeset 77822 in vbox for trunk/src/VBox

Timestamp:

Mar 21, 2019 8:23:11 AM (6 years ago)

Author:

vboxsync

Message:

FE/Qt: bugref:6699. Adding guest control console to machine's debug menu.

Location:

trunk/src/VBox/Frontends/VirtualBox/src

Files:

• converter/UIConverterBackendGlobal.cpp (modified) (2 diffs)
• extradata/UIExtraDataDefs.h (modified) (1 diff)
• globals/UIActionPoolRuntime.cpp (modified) (3 diffs)
• globals/UIActionPoolRuntime.h (modified) (1 diff)
• guestctrl/UIGuestControlConsole.cpp (modified) (4 diffs)
• guestctrl/UIGuestControlConsole.h (modified) (5 diffs)
• guestctrl/UIGuestControlInterface.cpp (modified) (4 diffs)
• guestctrl/UIGuestControlInterface.h (modified) (3 diffs)
• guestctrl/UIGuestProcessControlDialog.cpp (modified) (4 diffs)
• guestctrl/UIGuestProcessControlWidget.cpp (modified) (6 diffs)
• guestctrl/UIGuestProcessControlWidget.h (modified) (2 diffs)
• runtime/UIMachineLogic.cpp (modified) (2 diffs)
• runtime/UIMachineLogic.h (modified) (1 diff)

trunk/src/VBox/Frontends/VirtualBox/src/converter/UIConverterBackendGlobal.cpp

@@ -807 +807 @@
     switch (runtimeMenuDebuggerActionType)
     {
-        case UIExtraDataMetaDefs::RuntimeMenuDebuggerActionType_Statistics:  strResult = "Statistics"; break;
-        case UIExtraDataMetaDefs::RuntimeMenuDebuggerActionType_CommandLine: strResult = "CommandLine"; break;
-        case UIExtraDataMetaDefs::RuntimeMenuDebuggerActionType_Logging:     strResult = "Logging"; break;
-        case UIExtraDataMetaDefs::RuntimeMenuDebuggerActionType_LogDialog:   strResult = "LogDialog"; break;
-        case UIExtraDataMetaDefs::RuntimeMenuDebuggerActionType_All:         strResult = "All"; break;
+        case UIExtraDataMetaDefs::RuntimeMenuDebuggerActionType_Statistics:            strResult = "Statistics"; break;
+        case UIExtraDataMetaDefs::RuntimeMenuDebuggerActionType_CommandLine:           strResult = "CommandLine"; break;
+        case UIExtraDataMetaDefs::RuntimeMenuDebuggerActionType_Logging:               strResult = "Logging"; break;
+        case UIExtraDataMetaDefs::RuntimeMenuDebuggerActionType_LogDialog:             strResult = "LogDialog"; break;
+        case UIExtraDataMetaDefs::RuntimeMenuDebuggerActionType_GuestControlConsole:   strResult = "GuestControlConsole"; break;
+        case UIExtraDataMetaDefs::RuntimeMenuDebuggerActionType_All:                   strResult = "All"; break;
         default:
         {
@@ -827 +828 @@
      * to search through the keys using 'case-insensitive' rule: */
     QStringList keys;      QList<UIExtraDataMetaDefs::RuntimeMenuDebuggerActionType> values;
-    keys << "Statistics";  values << UIExtraDataMetaDefs::RuntimeMenuDebuggerActionType_Statistics;
-    keys << "CommandLine"; values << UIExtraDataMetaDefs::RuntimeMenuDebuggerActionType_CommandLine;
-    keys << "Logging";     values << UIExtraDataMetaDefs::RuntimeMenuDebuggerActionType_Logging;
-    keys << "LogDialog";   values << UIExtraDataMetaDefs::RuntimeMenuDebuggerActionType_LogDialog;
-    keys << "All";         values << UIExtraDataMetaDefs::RuntimeMenuDebuggerActionType_All;
+    keys << "Statistics";           values << UIExtraDataMetaDefs::RuntimeMenuDebuggerActionType_Statistics;
+    keys << "CommandLine";          values << UIExtraDataMetaDefs::RuntimeMenuDebuggerActionType_CommandLine;
+    keys << "Logging";              values << UIExtraDataMetaDefs::RuntimeMenuDebuggerActionType_Logging;
+    keys << "LogDialog";            values << UIExtraDataMetaDefs::RuntimeMenuDebuggerActionType_LogDialog;
+    keys << "GuestControlConsole";  values << UIExtraDataMetaDefs::RuntimeMenuDebuggerActionType_GuestControlConsole;
+    keys << "All";                  values << UIExtraDataMetaDefs::RuntimeMenuDebuggerActionType_All;
     /* Invalid type for unknown words: */
     if (!keys.contains(strRuntimeMenuDebuggerActionType, Qt::CaseInsensitive))

trunk/src/VBox/Frontends/VirtualBox/src/extradata/UIExtraDataDefs.h

@@ -606 +606 @@
     enum RuntimeMenuDebuggerActionType
     {
-        RuntimeMenuDebuggerActionType_Invalid     = 0,
-        RuntimeMenuDebuggerActionType_Statistics  = RT_BIT(0),
-        RuntimeMenuDebuggerActionType_CommandLine = RT_BIT(1),
-        RuntimeMenuDebuggerActionType_Logging     = RT_BIT(2),
-        RuntimeMenuDebuggerActionType_LogDialog   = RT_BIT(3),
-        RuntimeMenuDebuggerActionType_All         = 0xFFFF
+        RuntimeMenuDebuggerActionType_Invalid              = 0,
+        RuntimeMenuDebuggerActionType_Statistics           = RT_BIT(0),
+        RuntimeMenuDebuggerActionType_CommandLine          = RT_BIT(1),
+        RuntimeMenuDebuggerActionType_Logging              = RT_BIT(2),
+        RuntimeMenuDebuggerActionType_LogDialog            = RT_BIT(3),
+        RuntimeMenuDebuggerActionType_GuestControlConsole  = RT_BIT(4),
+        RuntimeMenuDebuggerActionType_All                  = 0xFFFF
     };
 #endif /* VBOX_WITH_DEBUGGER_GUI */

trunk/src/VBox/Frontends/VirtualBox/src/globals/UIActionPoolRuntime.cpp

@@ -2899 +2899 @@
     {
         setName(QApplication::translate("UIActionPool", "Show &Log...", "debug action"));
+    }
+};
+
+/** Simple action extension, used as 'Guest Control Terminal' action class. */
+class UIActionSimpleRuntimeGuestControlConsole : public UIActionSimple
+{
+    Q_OBJECT;
+
+public:
+
+    /** Constructs action passing @a pParent to the base-class. */
+    UIActionSimpleRuntimeGuestControlConsole(UIActionPool *pParent)
+        : UIActionSimple(pParent, true)
+    {}
+
+protected:
+
+    /** Returns action extra-data ID. */
+    virtual int extraDataID() const /* override */
+    {
+        return UIExtraDataMetaDefs::RuntimeMenuDebuggerActionType_GuestControlConsole;
+    }
+    /** Returns action extra-data key. */
+    virtual QString extraDataKey() const /* override */
+    {
+        return gpConverter->toInternalString(UIExtraDataMetaDefs::RuntimeMenuDebuggerActionType_GuestControlConsole);
+    }
+    /** Returns whether action is allowed. */
+    virtual bool isAllowed() const /* override */
+    {
+        return actionPool()->toRuntime()->isAllowedInMenuDebug(UIExtraDataMetaDefs::RuntimeMenuDebuggerActionType_GuestControlConsole);
+    }
+
+    /** Returns shortcut extra-data ID. */
+    virtual QString shortcutExtraDataID() const /* override */
+    {
+        return QString("GuestControlConsole");
+    }
+
+    /** Handles translation event. */
+    virtual void retranslateUi() /* override */
+    {
+        setName(QApplication::translate("UIActionPool", "Guest Control Terminal...", "debug action"));
     }
 };
@@ -3342 +3385 @@
     m_pool[UIActionIndexRT_M_Debug_T_Logging] = new UIActionToggleRuntimeLogging(this);
     m_pool[UIActionIndexRT_M_Debug_S_ShowLogDialog] = new UIActionSimpleRuntimeShowLogs(this);
+    m_pool[UIActionIndexRT_M_Debug_S_GuestControlConsole] = new UIActionSimpleRuntimeGuestControlConsole(this);
 #endif /* VBOX_WITH_DEBUGGER_GUI */
 
@@ -4254 +4298 @@
     /* 'Log Dialog' action: */
     addAction(pMenu, action(UIActionIndexRT_M_Debug_S_ShowLogDialog));
+    /* 'Guest Control Terminal' action: */
+    addAction(pMenu, action(UIActionIndexRT_M_Debug_S_GuestControlConsole));
 
     /* Mark menu as valid: */

trunk/src/VBox/Frontends/VirtualBox/src/globals/UIActionPoolRuntime.h

@@ -122 +122 @@
     UIActionIndexRT_M_Debug_T_Logging,
     UIActionIndexRT_M_Debug_S_ShowLogDialog,
+    UIActionIndexRT_M_Debug_S_GuestControlConsole,
 #endif
 

trunk/src/VBox/Frontends/VirtualBox/src/guestctrl/UIGuestControlConsole.cpp

@@ -23 +23 @@
 /* GUI includes: */
 #include "UIGuestControlConsole.h"
-
-
-UIGuestControlConsole::UIGuestControlConsole(QWidget* parent /* = 0 */)
+#include "UIGuestControlInterface.h"
+
+UIGuestControlConsole::UIGuestControlConsole(const CGuest &comGuest, QWidget* parent /* = 0 */)
     :QPlainTextEdit(parent)
+    , m_comGuest(comGuest)
     , m_strGreet("Welcome to 'Guest Control Console'. Type 'help' for help\n")
     , m_strPrompt("$>")
     , m_uCommandHistoryIndex(0)
-{
+    , m_pControlInterface(0)
+{
+    m_pControlInterface = new UIGuestControlInterface(this, m_comGuest);
+
+    connect(m_pControlInterface, &UIGuestControlInterface::sigOutputString,
+            this, &UIGuestControlConsole::sltOutputReceived);
+
     /* Configure this: */
     setUndoRedoEnabled(false);
@@ -48 +55 @@
 }
 
+void UIGuestControlConsole::commandEntered(const QString &strCommand)
+{
+    if (m_pControlInterface)
+        m_pControlInterface->putCommand(strCommand);
+}
+
+void UIGuestControlConsole::sltOutputReceived(const QString &strOutput)
+{
+    putOutput(strOutput);
+}
+
 void UIGuestControlConsole::reset()
 {
@@ -124 +142 @@
                 if (!strCommand.isEmpty())
                 {
-                    emit commandEntered(strCommand);
+                    commandEntered(strCommand);
                     if (!m_tCommandHistory.contains(strCommand))
                         m_tCommandHistory.push_back(strCommand);
@@ -297 +315 @@
     return list;
 }
-

trunk/src/VBox/Frontends/VirtualBox/src/guestctrl/UIGuestControlConsole.h

@@ -25 +25 @@
 # include <QPlainTextEdit>
 
+/* COM includes: */
+#include "COMEnums.h"
+#include "CGuest.h"
+
+class UIGuestControlInterface;
 /** QPlainTextEdit extension to provide a simple terminal like widget. */
 class UIGuestControlConsole : public QPlainTextEdit
@@ -31 +36 @@
     Q_OBJECT;
 
-signals:
-    /* This is emitted when return key is pressed */
-    void commandEntered(QString command);
 
 public:
 
-    UIGuestControlConsole(QWidget* parent = 0);
+    UIGuestControlConsole(const CGuest &comGuest, QWidget* parent = 0);
     /* @p strOutput is displayed in the console */
     void putOutput(const QString &strOutput);
@@ -50 +52 @@
 private slots:
 
+    void sltOutputReceived(const QString &strOutput);
 
 private:
@@ -66 +69 @@
     QString        getPreviousCommandFromHistory(const QString &originalString = QString());
     void           completeByTab();
+    void           commandEntered(const QString &strCommand);
+
     /* Return a list of words that start with @p strSearch */
     QList<QString> matchedWords(const QString &strSearch) const;
+    CGuest         m_comGuest;
     const QString  m_strGreet;
     const QString  m_strPrompt;
@@ -74 +80 @@
     CommandHistory m_tCommandHistory;
     unsigned       m_uCommandHistoryIndex;
+    UIGuestControlInterface  *m_pControlInterface;
 };
 
 #endif /* !FEQT_INCLUDED_SRC_guestctrl_UIGuestControlConsole_h */
-

trunk/src/VBox/Frontends/VirtualBox/src/guestctrl/UIGuestControlInterface.cpp

@@ -168 +168 @@
     , m_comGuest(comGuest)
     , m_strHelp("[common-options]               [--username <name>] [--domain <domain>]\n"
-                "                                   [--passwordfile <file> | --password <password>]\n"
+                "                               [--passwordfile <file> | --password <password>]\n"
                 "start                           [common-options]\n"
                 "                                   [--exe <path to executable>] [--timeout <msec>]\n"
@@ -179 +179 @@
                 "                                   [-P|--parents] [<guest directory>\n"
                 "                                   [--sessionid <id> |  [sessionname <name>]]\n"
-                "[stat|ls                          [common-options]\n"
+                "stat|ls                          [common-options]\n"
                 "                                   [--sessionid <id> |  [sessionname <name>]]\n"
                 )
@@ -540 +540 @@
     if (!isGuestAdditionsAvailable(m_comGuest))
     {
-        emit sigOutputString("No guest addtions detected. Guest control needs guest additions");
+        emit sigOutputString("No guest addtions detected. Guest control requires guest additions");
         return;
     }
@@ -676 +676 @@
     return strObjectInfo;
 }
-

trunk/src/VBox/Frontends/VirtualBox/src/guestctrl/UIGuestControlInterface.h

@@ -61 +61 @@
     /** @} */
 
-
 private slots:
 
@@ -93 +92 @@
     QString getFsObjInfoString(const T &fsObjectInfo) const;
 
-
     CGuest        m_comGuest;
     const QString m_strHelp;
@@ -102 +100 @@
 
 #endif /* !FEQT_INCLUDED_SRC_guestctrl_UIGuestControlInterface_h */
-

trunk/src/VBox/Frontends/VirtualBox/src/guestctrl/UIGuestProcessControlDialog.cpp

@@ -24 +24 @@
 #include "UIExtraDataManager.h"
 #include "UIIconPool.h"
+#include "UIGuestControlConsole.h"
 #include "UIGuestProcessControlDialog.h"
-#include "UIGuestProcessControlWidget.h"
 #include "VBoxGlobal.h"
 #ifdef VBOX_WS_MAC
@@ -71 +71 @@
     setWindowTitle(tr("%1 - Guest Control").arg(m_strMachineName));
     /* Translate buttons: */
-    button(ButtonType_Close)->setText(UIGuestProcessControlWidget::tr("Close"));
+    button(ButtonType_Close)->setText(tr("Close"));
 }
 
@@ -83 +83 @@
 {
     /* Create widget: */
-    UIGuestProcessControlWidget *pWidget = new UIGuestProcessControlWidget(EmbedTo_Dialog, m_comGuest, this, m_strMachineName);
+    UIGuestControlConsole *pConsole = new UIGuestControlConsole(m_comGuest);
 
-    if (pWidget)
+    if (pConsole)
     {
         /* Configure widget: */
-        setWidget(pWidget);
+        setWidget(pConsole);
         //setWidgetMenu(pWidget->menu());
 #ifdef VBOX_WS_MAC
@@ -94 +94 @@
 #endif
         /* Add into layout: */
-        centralWidget()->layout()->addWidget(pWidget);
+        centralWidget()->layout()->addWidget(pConsole);
     }
 }

trunk/src/VBox/Frontends/VirtualBox/src/guestctrl/UIGuestProcessControlWidget.cpp

@@ -298 +298 @@
     , m_pSplitter(0)
     , m_pTreeWidget(0)
-    , m_pConsole(0)
-    , m_pControlInterface(0)
     , m_enmEmbedding(enmEmbedding)
     , m_pToolBar(0)
@@ -333 +331 @@
 void UIGuestProcessControlWidget::prepareObjects()
 {
-    m_pControlInterface = new UIGuestControlInterface(this, m_comGuest);
-
     /* Create layout: */
     m_pMainLayout = new QVBoxLayout(this);
@@ -361 +357 @@
     }
 
-    /* Disable the CLI for now (and maybe forever): */
-#ifdef WITH_GUEST_CONTROL_CLI
-    m_pConsole = new UIGuestControlConsole;
-#endif
-
-    if (m_pConsole)
-    {
-        m_pSplitter->addWidget(m_pConsole);
-        setFocusProxy(m_pConsole);
-    }
-
     m_pSplitter->setStretchFactor(0, 2);
     m_pSplitter->setStretchFactor(1, 1);
@@ -391 +376 @@
 {
     qRegisterMetaType<QVector<int> >();
-    connect(m_pControlInterface, &UIGuestControlInterface::sigOutputString,
-            this, &UIGuestProcessControlWidget::sltConsoleOutputReceived);
-    if (m_pConsole)
-        connect(m_pConsole, &UIGuestControlConsole::commandEntered,
-                this, &UIGuestProcessControlWidget::sltConsoleCommandEntered);
 
     if (m_pTreeWidget)
@@ -417 +397 @@
 {
     updateTreeWidget();
-}
-
-void UIGuestProcessControlWidget::sltConsoleCommandEntered(const QString &strCommand)
-{
-    if (m_pControlInterface)
-    {
-        m_pControlInterface->putCommand(strCommand);
-    }
-}
-
-void UIGuestProcessControlWidget::sltConsoleOutputReceived(const QString &strOutput)
-{
-    if (m_pConsole)
-    {
-        m_pConsole->putOutput(strOutput);
-    }
 }
 
@@ -588 +552 @@
     connect(sessionTreeItem, &UIGuestSessionTreeItem::sigGuessSessionUpdated,
             this, &UIGuestProcessControlWidget::sltTreeItemUpdated);
-    connect(sessionTreeItem, &UIGuestSessionTreeItem::sigGuestSessionErrorText,
-            this, &UIGuestProcessControlWidget::sltGuestControlErrorText);
-}
-
-void UIGuestProcessControlWidget::sltGuestControlErrorText(QString strError)
-{
-    if (m_pConsole)
-    {
-        m_pConsole->putOutput(strError);
-    }
 }
 

trunk/src/VBox/Frontends/VirtualBox/src/guestctrl/UIGuestProcessControlWidget.h

@@ -66 +66 @@
 
     void sltGuestSessionsUpdated();
-    void sltConsoleCommandEntered(const QString &strCommand);
-    void sltConsoleOutputReceived(const QString &strOutput);
     void sltGuestSessionRegistered(CGuestSession guestSession);
     void sltGuestSessionUnregistered(CGuestSession guestSession);
-    void sltGuestControlErrorText(QString strError);
     void sltTreeItemUpdated();
     void sltCloseSessionOrProcess();
@@ -92 +89 @@
     QSplitter                *m_pSplitter;
     UIGuestControlTreeWidget *m_pTreeWidget;
-    UIGuestControlConsole    *m_pConsole;
-    UIGuestControlInterface  *m_pControlInterface;
     const EmbedTo             m_enmEmbedding;
     UIToolBar                *m_pToolBar;

trunk/src/VBox/Frontends/VirtualBox/src/runtime/UIMachineLogic.cpp

@@ -1180 +1180 @@
     connect(actionPool()->action(UIActionIndexRT_M_Debug_S_ShowLogDialog), SIGNAL(triggered()),
             this, SLOT(sltShowLogDialog()));
+    connect(actionPool()->action(UIActionIndexRT_M_Debug_S_GuestControlConsole), SIGNAL(triggered()),
+            this, SLOT(sltShowGuestControlConsoleDialog()));
 #endif /* VBOX_WITH_DEBUGGER_GUI */
 
@@ -2482 +2484 @@
 }
 
+void UIMachineLogic::sltShowGuestControlConsoleDialog()
+{
+    if (machine().isNull() || !activeMachineWindow())
+        return;
+
+    /* Create a logviewer only if we don't have one already */
+    if (m_pProcessControlDialog)
+        return;
+
+    QIManagerDialog *pProcessControlDialog;
+    UIGuestProcessControlDialogFactory dialogFactory(actionPool(), console().GetGuest(), machine().GetName());
+    dialogFactory.prepare(pProcessControlDialog, activeMachineWindow());
+    if (pProcessControlDialog)
+    {
+        m_pProcessControlDialog = pProcessControlDialog;
+
+        /* Show instance: */
+        pProcessControlDialog->show();
+        pProcessControlDialog->setWindowState(pProcessControlDialog->windowState() & ~Qt::WindowMinimized);
+        pProcessControlDialog->activateWindow();
+        connect(pProcessControlDialog, &QIManagerDialog::sigClose,
+                this, &UIMachineLogic::sltCloseGuestControlConsoleDialog);
+    }
+}
+
+void UIMachineLogic::sltCloseGuestControlConsoleDialog()
+{
+    QIManagerDialog* pDialog = qobject_cast<QIManagerDialog*>(sender());
+    if (m_pProcessControlDialog != pDialog || !pDialog)
+        return;
+
+    /* Set the m_pLogViewerDialog to NULL before closing the dialog. or we will have redundant deletes*/
+    m_pProcessControlDialog = 0;
+    pDialog->close();
+    UIGuestProcessControlDialogFactory().cleanup(pDialog);
+}
 #endif /* VBOX_WITH_DEBUGGER_GUI */
 

trunk/src/VBox/Frontends/VirtualBox/src/runtime/UIMachineLogic.h

@@ -320 +320 @@
     /** Handles close signal from the log viewer dialog. */
     void sltCloseLogViewerWindow();
+    void sltShowGuestControlConsoleDialog();
+    void sltCloseGuestControlConsoleDialog();
 #endif /* VBOX_WITH_DEBUGGER_GUI */