Changeset 71021 in vbox for trunk

Timestamp:

Feb 15, 2018 1:50:20 PM (7 years ago)

Author:

vboxsync

Message:

FE/Qt: bugref:6699 Better error handling for guest control console

Location:

trunk/src/VBox/Frontends/VirtualBox/src/runtime/information/guestctrl

Files:

• UIGuestControlConsole.h (added)
• UIGuestControlInterface.cpp (modified) (13 diffs)
• UIGuestControlInterface.h (modified) (2 diffs)
• UIGuestSessionTreeItem.h (added)
• UIInformationGuestSession.h (modified) (1 diff)

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

@@ -32 +32 @@
 
 
-#define SUCCESS_RETURN(strMessage){   \
-    emit sigOutputString(strMessage); \
-    return true;                      \
-}
-
-#define ERROR_RETURN(strMessage){      \
-    emit sigOutputString(strMessage);  \
-    return false;                      \
-}
-
 #define GCTLCMD_COMMON_OPT_USER             999 /**< The --username option number. */
 #define GCTLCMD_COMMON_OPT_PASSWORD         998 /**< The --password option number. */
@@ -57 +47 @@
         { "--verbose",              'v',                                RTGETOPT_REQ_NOTHING },
 
-
-/** Common option definitions. */
+#define HANDLE_COMMON_OPTION_DEFS()                   \
+    case GCTLCMD_COMMON_OPT_USER:                     \
+        commandData.m_strUserName = ValueUnion.psz;   \
+        break;                                        \
+    case GCTLCMD_COMMON_OPT_PASSWORD:                 \
+        commandData.m_strPassword = ValueUnion.psz;   \
+        break;
+
+QString generateErrorString(int getOptErrorCode, const RTGETOPTUNION &valueUnion)
+{
+    QString errorString;
+    if(valueUnion.pDef)
+    {
+        if(valueUnion.pDef->pszLong)
+        {
+            errorString = QString(valueUnion.pDef->pszLong);
+        }
+    }
+
+    switch (getOptErrorCode)
+    {
+        case (VERR_GETOPT_UNKNOWN_OPTION):
+            errorString = errorString.append("RTGetOpt: Command line option not recognized.");
+            break;
+        case (VERR_GETOPT_REQUIRED_ARGUMENT_MISSING):
+            errorString = errorString.append("RTGetOpt: Command line option needs argument.");
+            break;
+        case (VERR_GETOPT_INVALID_ARGUMENT_FORMAT):
+            errorString = errorString.append("RTGetOpt: Command line option has argument with bad format.");
+            break;
+        case (VINF_GETOPT_NOT_OPTION):
+            errorString = errorString.append("RTGetOpt: Not an option.");
+            break;
+        case (VERR_GETOPT_INDEX_MISSING):
+            errorString = errorString.append("RTGetOpt: Command line option needs an index.");
+            break;
+        default:
+            break;
+    }
+    return errorString;
+}
+
+/** Common option definitions: */
 class CommandData
 {
@@ -106 +137 @@
 
     CommandData commandData;
-    parseCommonOptions(argc, argv, commandData);
+    //parseCommonOptions(argc, argv, commandData);
 
     static const RTGETOPTDEF s_aOptions[] =
     {
+        GCTLCMD_COMMON_OPTION_DEFS()
         { "--sessionname",                   GCTLCMD_COMMON_OPT_SESSION_NAME,         RTGETOPT_REQ_STRING  },
         { "--sessionid",                     GCTLCMD_COMMON_OPT_SESSION_ID,           RTGETOPT_REQ_UINT32  },
@@ -127 +159 @@
     RTGETOPTUNION ValueUnion;
     RTGETOPTSTATE GetState;
-    RTGetOptInit(&GetState, argc, argv, s_aOptions, RT_ELEMENTS(s_aOptions), 0, 0);
+    RTGetOptInit(&GetState, argc, argv, s_aOptions, RT_ELEMENTS(s_aOptions), 1 /* ignore 0th element (command) */, 0);
     while ((ch = RTGetOpt(&GetState, &ValueUnion)))
     {
         switch (ch)
         {
+            HANDLE_COMMON_OPTION_DEFS()
             case GCTLCMD_COMMON_OPT_SESSION_NAME:
                 sessionNameGiven = true;
@@ -144 +177 @@
                 break;
             default:
-                break;
+            {
+                emit sigOutputString(generateErrorString(ch, ValueUnion));
+                return false;
+                printf("hoppala %d\n", ch);
+                break;
+            }
         }
     }
@@ -150 +188 @@
     if (sessionNameGiven && commandData.m_strSessionName.isEmpty())
     {
-        emit sigOutputString(QString("'Session Name' is not name valid\n").append(m_strHelp));
+        emit sigOutputString(QString(m_strHelp).append("'Session Name' is not name valid\n"));
         return false;
     }
@@ -158 +196 @@
     if (sessionIdGiven && sessionNameGiven)
     {
-        emit sigOutputString(QString("Both 'Session Name' and 'Session Id' are supplied\n").append(m_strHelp));
+        emit sigOutputString(QString(m_strHelp).append("Both 'Session Name' and 'Session Id' are supplied\n"));
         return false;
     }
@@ -166 +204 @@
         if (!findSession(commandData.m_uSessionId, guestSession))
         {
-            emit sigOutputString(QString("No session with id %1 found.\n").arg(commandData.m_uSessionId).append(m_strHelp));
+            emit sigOutputString(QString(m_strHelp).append("No session with id %1 found.\n").arg(commandData.m_uSessionId));
             return false;
         }
@@ -207 +245 @@
 {
     CommandData commandData;
-    if (!parseCommonOptions(argc, argv, commandData))
-        return false;
 
     static const RTGETOPTDEF s_aOptions[] =
@@ -223 +259 @@
         switch (ch)
         {
+            HANDLE_COMMON_OPTION_DEFS()
             case GCTLCMD_COMMON_OPT_SESSION_NAME:
                 commandData.m_strSessionName  = ValueUnion.psz;
@@ -238 +275 @@
     if (!createSession(commandData, guestSession))
         return false;
-    return true;
-}
-
-bool UIGuestControlInterface::parseCommonOptions(int argc, char** argv, CommandData& commandData)
-{
-    static const RTGETOPTDEF s_aOptions[] =
-    {
-        { "--username",             GCTLCMD_COMMON_OPT_USER,            RTGETOPT_REQ_STRING  },
-        { "--passwordfile",         GCTLCMD_COMMON_OPT_PASSWORD_FILE,   RTGETOPT_REQ_STRING  },
-        { "--password",             GCTLCMD_COMMON_OPT_PASSWORD,        RTGETOPT_REQ_STRING  },
-        { "--domain",               GCTLCMD_COMMON_OPT_DOMAIN,          RTGETOPT_REQ_STRING  },
-        { "--quiet",                'q',                                RTGETOPT_REQ_NOTHING },
-        { "--verbose",              'v',                                RTGETOPT_REQ_NOTHING },
-    };
-
-
-    int ch;
-    RTGETOPTUNION ValueUnion;
-    RTGETOPTSTATE GetState;
-    RTGetOptInit(&GetState, argc, argv, s_aOptions, RT_ELEMENTS(s_aOptions), 0, 0);
-    while ((ch = RTGetOpt(&GetState, &ValueUnion)))
-    {
-        switch (ch)
-        {
-            /* Username: */
-            case GCTLCMD_COMMON_OPT_USER:
-                commandData.m_strUserName = ValueUnion.psz;
-                break;
-            /* Paaword: */
-            case GCTLCMD_COMMON_OPT_PASSWORD:
-                commandData.m_strPassword = ValueUnion.psz;
-                break;
-            default:
-                break;
-        }
-    }
-
     return true;
 }
@@ -341 +341 @@
                      else
                      {
-                         emit sigOutputString(QString("Unknown Command '%1'\n").arg(ValueUnion.psz).append(m_strHelp));
+                         emit sigOutputString(QString(m_strHelp).append("\nSyntax Error. Unknown Command '%1'").arg(ValueUnion.psz));
                          RTGetOptArgvFree(argv);
                          return;
@@ -398 +398 @@
     }
     /* Wait session to start: */
-    const ULONG waitTimeout = 1;//2000;
+    const ULONG waitTimeout = 2000;
     KGuestSessionWaitResult waitResult = guestSession.WaitFor(KGuestSessionWaitForFlag_Start, waitTimeout);
     if (waitResult != KGuestSessionWaitResult_Start)

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

@@ -1 +1 @@
 /* $Id$ */
 /** @file
- * VBox Qt GUI - UIInformationConfiguration class declaration.
+ * VBox Qt GUI - UIGuestControlInterface class declaration.
  */
 
@@ -66 +66 @@
     /* Handles the 'create' session command */
     bool handleCreate(int, char**);
-    bool parseCommonOptions(int argc, char** argv, CommandData& commandData);
+
 
     CGuest        m_comGuest;

trunk/src/VBox/Frontends/VirtualBox/src/runtime/information/guestctrl/UIInformationGuestSession.h

@@ -1 +1 @@
 /* $Id$ */
 /** @file
- * VBox Qt GUI - UIInformationConfiguration class declaration.
+ * VBox Qt GUI - UIInformationGuestSession class declaration.
  */