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

Timestamp:

Oct 31, 2013 4:40:46 PM (11 years ago)

Author:

vboxsync

Message:

Guest Control:

• Implemented IGuestSession::DirectoryRemove, IGuestSession::DirectoryRemoveRecursive, IGuestSession::DirectoryRename + IGuestSession::FileRename.
• Added appropriate commands to VBoxManage (basic support for now).
• Implemented support for proper guest session process termination via SCM.
• Implemented support for internal anonymous wait events which are not relying on the public API's VBoxEventType_T.
• Various bugfixes.

File:

• trunk/src/VBox/Frontends/VBoxManage/VBoxManageGuestCtrl.cpp (modified) (34 diffs)

trunk/src/VBox/Frontends/VBoxManage/VBoxManageGuestCtrl.cpp

@@ -141 +141 @@
 
     PGCTLCMDCTX pCmdCtx;
-    ComPtr<IGuestSession> pGuestSession;
     bool fDryRun;
     bool fHostToGuest;
@@ -282 +281 @@
 enum GETOPTDEF_RMDIR
 {
-    GETOPTDEF_RMDIR_RECURSIVE = 2000
 };
 
@@ -349 +347 @@
                  "                            [--domain <domain>] [--verbose]\n"
                  "\n"
+                 "                            ren[ame]|mv\n"
+                 "                            <source>... <dest> --username <name>\n"
+                 "                            [--passwordfile <file> | --password <password>]\n"
+                 "                            [--domain <domain>] [--verbose]\n"
+                 "\n"
                  "                            createtemp[orary]|mktemp\n"
                  "                            <template> --username <name>\n"
@@ -729 +732 @@
     AssertPtrReturn(pCtx, RTEXITCODE_FAILURE);
 
+#ifdef DEBUG_andy
+    RTPrintf("Original argv:\n");
+    for (int i=0; i<pArg->argc;i++)
+        RTPrintf("\targv[%d]=%s\n", i, pArg->argv[i]);
+#endif
+
     RTEXITCODE rcExit = RTEXITCODE_SUCCESS;
 
@@ -780 +789 @@
             pCtx->iArgc = 0;
 
+            int iArgIdx = 2; /* Skip VM name and guest control command */
             int ch;
             RTGETOPTUNION ValueUnion;
@@ -785 +795 @@
             RTGetOptInit(&GetState, pArg->argc, pArg->argv,
                          s_aOptions, RT_ELEMENTS(s_aOptions),
-                         2, /* Skip VM name and guest control command */
-                         RTGETOPTINIT_FLAGS_OPTS_FIRST);
+                         iArgIdx, 0);
 
             while (   (ch = RTGetOpt(&GetState, &ValueUnion))
@@ -797 +806 @@
                         if (!(uFlags & CTLCMDCTX_FLAGS_SESSION_ANONYMOUS))
                             pCtx->strUsername = ValueUnion.psz;
+                        iArgIdx = GetState.iNext;
                         break;
 
@@ -805 +815 @@
                                 pCtx->strPassword = ValueUnion.psz;
                         }
+                        iArgIdx = GetState.iNext;
                         break;
 
@@ -811 +822 @@
                         if (!(uFlags & CTLCMDCTX_FLAGS_SESSION_ANONYMOUS))
                             rcExit = readPasswordFile(ValueUnion.psz, &pCtx->strPassword);
+                        iArgIdx = GetState.iNext;
                         break;
                     }
@@ -817 +829 @@
                         if (!(uFlags & CTLCMDCTX_FLAGS_SESSION_ANONYMOUS))
                             pCtx->strDomain = ValueUnion.psz;
+                        iArgIdx = GetState.iNext;
                         break;
 
                     case 'v': /* Verbose */
                         pCtx->fVerbose = true;
+                        iArgIdx = GetState.iNext;
                         break;
 
-                    case VINF_GETOPT_NOT_OPTION:
-                        /* Fall through is intentional. */
                     default:
+                        /* Simply skip; might be handled in a specific command
+                         * handler later. */
+                        break;
+
+                } /* switch */
+
+                int iArgDiff = GetState.iNext - iArgIdx;
+                if (iArgDiff)
+                {
+#ifdef DEBUG_andy
+                    RTPrintf("Not handled (iNext=%d, iArgsCur=%d):\n", GetState.iNext, iArgIdx);
+#endif
+                    for (int i = iArgIdx; i < GetState.iNext; i++)
                     {
-                        Assert(GetState.iNext);
-                        char *pszArg = RTStrDup(pArg->argv[GetState.iNext - 1]);
+                        char *pszArg = RTStrDup(pArg->argv[i]);
                         if (!pszArg)
                         {
@@ -837 +861 @@
                         pCtx->ppaArgv[pCtx->iArgc] = pszArg;
                         pCtx->iArgc++;
-                        break;
+#ifdef DEBUG_andy
+                        RTPrintf("\targv[%d]=%s\n", i, pArg->argv[i]);
                     }
-
-                } /* switch */
+#endif
+                    iArgIdx = GetState.iNext;
+                }
+
             } /* while RTGetOpt */
         }
@@ -1077 +1104 @@
     };
 
+#ifdef DEBUG_andy
+    RTPrintf("first=%d\n", pCtx->iFirstArgc);
+    for (int i=0; i<pCtx->iArgc;i++)
+        RTPrintf("\targv[%d]=%s\n", i, pCtx->ppaArgv[i]);
+#endif
+
     int                     ch;
     RTGETOPTUNION           ValueUnion;
     RTGETOPTSTATE           GetState;
-    RTGetOptInit(&GetState, pCtx->iArgc, pCtx->ppaArgv, s_aOptions, RT_ELEMENTS(s_aOptions), pCtx->iFirstArgc, 0);
+    RTGetOptInit(&GetState, pCtx->iArgc, pCtx->ppaArgv, s_aOptions, RT_ELEMENTS(s_aOptions),
+                 pCtx->iFirstArgc, RTGETOPTINIT_FLAGS_OPTS_FIRST);
 
     Utf8Str                              strCmd;
@@ -1174 +1208 @@
 
                 default:
-                    return RTGetOptPrintError(ch, &ValueUnion);
+                    /* Note: Necessary for handling non-options (after --) which
+                     *       contain a single dash, e.g. "-- foo.exe -s". */
+                    if (GetState.argc == GetState.iNext)
+                        aArgs.push_back(Bstr(ValueUnion.psz).raw());
+                    else
+                        return RTGetOptPrintError(ch, &ValueUnion);
                     break;
 
@@ -1410 +1449 @@
     AssertPtrReturn(pCtx, VERR_INVALID_POINTER);
 
-    PCOPYCONTEXT pContext = new COPYCONTEXT();
-    AssertPtrReturn(pContext, VERR_NO_MEMORY); /**< @todo r=klaus cannot happen with new */
-    ComPtr<IGuestSession> pGuestSession;
-    HRESULT rc = pCtx->pGuest->CreateSession(Bstr(pCtx->strUsername).raw(),
-                                             Bstr(pCtx->strPassword).raw(),
-                                             Bstr(pCtx->strDomain).raw(),
-                                             Bstr(strSessionName).raw(),
-                                             pGuestSession.asOutParam());
-    if (FAILED(rc))
-        return ctrlPrintError(pCtx->pGuest, COM_IIDOF(IGuest));
-
-    pContext->pCmdCtx = pCtx;
-    pContext->fDryRun = fDryRun;
-    pContext->fHostToGuest = fHostToGuest;
-    pContext->pGuestSession = pGuestSession;
-
-    *ppContext = pContext;
-
-    return VINF_SUCCESS;
+    int vrc = VINF_SUCCESS;
+    try
+    {
+        PCOPYCONTEXT pContext = new COPYCONTEXT();
+
+        pContext->pCmdCtx = pCtx;
+        pContext->fDryRun = fDryRun;
+        pContext->fHostToGuest = fHostToGuest;
+
+        *ppContext = pContext;
+    }
+    catch (std::bad_alloc)
+    {
+        vrc = VERR_NO_MEMORY;
+    }
+
+    return vrc;
 }
 
@@ -1439 +1476 @@
 {
     if (pContext)
-    {
-        if (pContext->pGuestSession)
-            pContext->pGuestSession->Close();
         delete pContext;
-    }
 }
 
@@ -1617 +1650 @@
         SafeArray<DirectoryCreateFlag_T> dirCreateFlags;
         dirCreateFlags.push_back(DirectoryCreateFlag_Parents);
-        HRESULT rc = pContext->pGuestSession->DirectoryCreate(Bstr(pszDir).raw(),
-                                                              0700, ComSafeArrayAsInParam(dirCreateFlags));
+        HRESULT rc = pContext->pCmdCtx->pGuestSession->DirectoryCreate(Bstr(pszDir).raw(),
+                                                                       0700, ComSafeArrayAsInParam(dirCreateFlags));
         if (FAILED(rc))
-            vrc = ctrlPrintError(pContext->pGuestSession, COM_IIDOF(IGuestSession));
+            vrc = ctrlPrintError(pContext->pCmdCtx->pGuestSession, COM_IIDOF(IGuestSession));
     }
     else /* ... or on the host. */
@@ -1636 +1669 @@
  * @return  IPRT status code.
  * @param   pContext                Pointer to current copy control context.
- * @param   bGuest                  true if directory needs to be checked on the guest
+ * @param   fOnGuest                true if directory needs to be checked on the guest
  *                                  or false if on the host.
  * @param   pszDir                  Actual directory to check.
@@ -1642 +1675 @@
  *                                  given directory exists or not.
  */
-static int ctrlCopyDirExists(PCOPYCONTEXT pContext, bool bGuest,
+static int ctrlCopyDirExists(PCOPYCONTEXT pContext, bool fOnGuest,
                              const char *pszDir, bool *fExists)
 {
@@ -1650 +1683 @@
 
     int vrc = VINF_SUCCESS;
-    if (bGuest)
+    if (fOnGuest)
     {
         BOOL fDirExists = FALSE;
-        HRESULT rc = pContext->pGuestSession->DirectoryExists(Bstr(pszDir).raw(), &fDirExists);
+        HRESULT rc = pContext->pCmdCtx->pGuestSession->DirectoryExists(Bstr(pszDir).raw(), &fDirExists);
         if (FAILED(rc))
-            vrc = ctrlPrintError(pContext->pGuestSession, COM_IIDOF(IGuestSession));
+            vrc = ctrlPrintError(pContext->pCmdCtx->pGuestSession, COM_IIDOF(IGuestSession));
         else
             *fExists = fDirExists ? true : false;
@@ -1720 +1753 @@
     {
         BOOL fFileExists = FALSE;
-        HRESULT rc = pContext->pGuestSession->FileExists(Bstr(pszFile).raw(), &fFileExists);
+        HRESULT rc = pContext->pCmdCtx->pGuestSession->FileExists(Bstr(pszFile).raw(), &fFileExists);
         if (FAILED(rc))
-            vrc = ctrlPrintError(pContext->pGuestSession, COM_IIDOF(IGuestSession));
+            vrc = ctrlPrintError(pContext->pCmdCtx->pGuestSession, COM_IIDOF(IGuestSession));
         else
             *fExists = fFileExists ? true : false;
@@ -1796 +1829 @@
     {
         SafeArray<CopyFileFlag_T> copyFlags;
-        rc = pContext->pGuestSession->CopyTo(Bstr(pszFileSource).raw(), Bstr(pszFileDest).raw(),
-                                             ComSafeArrayAsInParam(copyFlags),
-
-                                             pProgress.asOutParam());
-    }
-    else
-    {
-        SafeArray<CopyFileFlag_T> copyFlags;
-        rc = pContext->pGuestSession->CopyFrom(Bstr(pszFileSource).raw(), Bstr(pszFileDest).raw(),
+        rc = pContext->pCmdCtx->pGuestSession->CopyTo(Bstr(pszFileSource).raw(), Bstr(pszFileDest).raw(),
                                                ComSafeArrayAsInParam(copyFlags),
                                                pProgress.asOutParam());
     }
+    else
+    {
+        SafeArray<CopyFileFlag_T> copyFlags;
+        rc = pContext->pCmdCtx->pGuestSession->CopyFrom(Bstr(pszFileSource).raw(), Bstr(pszFileDest).raw(),
+                                               ComSafeArrayAsInParam(copyFlags),
+                                               pProgress.asOutParam());
+    }
 
     if (FAILED(rc))
     {
-        vrc = ctrlPrintError(pContext->pGuestSession, COM_IIDOF(IGuestSession));
+        vrc = ctrlPrintError(pContext->pCmdCtx->pGuestSession, COM_IIDOF(IGuestSession));
     }
     else
@@ -2038 +2070 @@
     SafeArray<DirectoryOpenFlag_T> dirOpenFlags; /* No flags supported yet. */
     ComPtr<IGuestDirectory> pDirectory;
-    HRESULT rc = pContext->pGuestSession->DirectoryOpen(Bstr(szCurDir).raw(), Bstr(pszFilter).raw(),
+    HRESULT rc = pContext->pCmdCtx->pGuestSession->DirectoryOpen(Bstr(szCurDir).raw(), Bstr(pszFilter).raw(),
                                                         ComSafeArrayAsInParam(dirOpenFlags),
                                                         pDirectory.asOutParam());
     if (FAILED(rc))
-        return ctrlPrintError(pContext->pGuestSession, COM_IIDOF(IGuestSession));
+        return ctrlPrintError(pContext->pCmdCtx->pGuestSession, COM_IIDOF(IGuestSession));
     ComPtr<IFsObjInfo> dirEntry;
     while (true)
@@ -2385 +2417 @@
     PCOPYCONTEXT pContext = NULL;
     vrc = ctrlCopyContextCreate(pCtx, fDryRun, fHostToGuest,
-                                "VBoxManage Guest Control Copy", &pContext);
+                                  fHostToGuest
+                                ? "VBoxManage Guest Control - Copy to guest"
+                                : "VBoxManage Guest Control - Copy from guest", &pContext);
     if (RT_FAILURE(vrc))
     {
@@ -2544 +2578 @@
     AssertPtrReturn(pCtx, RTEXITCODE_FAILURE);
 
-    /*
-     * Parse arguments.
-     *
-     * Note! No direct returns here, everyone must go thru the cleanup at the
-     *       end of this function.
-     */
     static const RTGETOPTDEF s_aOptions[] =
     {
@@ -2619 +2647 @@
     AssertPtrReturn(pCtx, RTEXITCODE_FAILURE);
 
-    /*
-     * Parse arguments.
-     *
-     * Note! No direct returns here, everyone must go thru the cleanup at the
-     *       end of this function.
-     */
     static const RTGETOPTDEF s_aOptions[] =
     {
-        { "--recursive",           GETOPTDEF_RMDIR_RECURSIVE,       RTGETOPT_REQ_NOTHING }
+        { "--recursive",           'R',                             RTGETOPT_REQ_NOTHING }
     };
 
@@ -2644 +2666 @@
         switch (ch)
         {
-            case GETOPTDEF_RMDIR_RECURSIVE:
+            case 'R':
                 fRecursive = true;
                 break;
@@ -2695 +2717 @@
                 if (SUCCEEDED(rc))
                     CHECK_PROGRESS_ERROR(pProgress, ("Directory deletion failed"));
+
+                pProgress.setNull();
             }
             else
@@ -2714 +2738 @@
 {
     AssertPtrReturn(pCtx, RTEXITCODE_FAILURE);
-
-    /*
-     * Parse arguments.
-     *
-     * Note! No direct returns here, everyone must go thru the cleanup at the
-     *       end of this function.
-     */
-    static const RTGETOPTDEF s_aOptions[] = { 0 };
 
     int ch;
@@ -2727 +2743 @@
     RTGETOPTSTATE GetState;
     RTGetOptInit(&GetState, pCtx->iArgc, pCtx->ppaArgv,
-                 s_aOptions, RT_ELEMENTS(s_aOptions), pCtx->iFirstArgc, RTGETOPTINIT_FLAGS_OPTS_FIRST);
+                 NULL /* s_aOptions */, 0 /* RT_ELEMENTS(s_aOptions) */,
+                 pCtx->iFirstArgc, RTGETOPTINIT_FLAGS_OPTS_FIRST);
 
     DESTDIRMAP mapDirs;
@@ -2772 +2789 @@
 }
 
+static DECLCALLBACK(RTEXITCODE) handleCtrlRename(PGCTLCMDCTX pCtx)
+{
+    AssertPtrReturn(pCtx, RTEXITCODE_FAILURE);
+
+    static const RTGETOPTDEF s_aOptions[] = { 0 };
+
+    int ch;
+    RTGETOPTUNION ValueUnion;
+    RTGETOPTSTATE GetState;
+    RTGetOptInit(&GetState, pCtx->iArgc, pCtx->ppaArgv,
+                 NULL /*s_aOptions*/, 0 /*RT_ELEMENTS(s_aOptions)*/, pCtx->iFirstArgc, RTGETOPTINIT_FLAGS_OPTS_FIRST);
+
+    int vrc = VINF_SUCCESS;
+
+    bool fDryrun = false;
+    std::vector< Utf8Str > vecSources;
+    Utf8Str strDest;
+    com::SafeArray<PathRenameFlag_T> aRenameFlags;
+
+    try
+    {
+        /** @todo Make flags configurable. */
+        aRenameFlags.push_back(PathRenameFlag_NoReplace);
+
+        while (   (ch = RTGetOpt(&GetState, &ValueUnion))
+               && RT_SUCCESS(vrc))
+        {
+            /* For options that require an argument, ValueUnion has received the value. */
+            switch (ch)
+            {
+                /** @todo Implement a --dryrun command. */
+                /** @todo Implement rename flags. */
+
+                case VINF_GETOPT_NOT_OPTION:
+                    vecSources.push_back(Utf8Str(ValueUnion.psz));
+                    strDest = ValueUnion.psz;
+                    break;
+
+                default:
+                    return RTGetOptPrintError(ch, &ValueUnion);
+                    break;
+            }
+        }
+    }
+    catch (std::bad_alloc)
+    {
+        vrc = VERR_NO_MEMORY;
+    }
+
+    if (RT_FAILURE(vrc))
+        return RTMsgErrorExit(RTEXITCODE_FAILURE, "Failed to initialize, rc=%Rrc\n", vrc);
+
+    uint32_t cSources = vecSources.size();
+    if (!cSources)
+        return errorSyntax(USAGE_GUESTCONTROL, "No source(s) to move specified!");
+    if (cSources < 2)
+        return errorSyntax(USAGE_GUESTCONTROL, "No destination specified!");
+
+    /* Delete last element, which now is the destination. */
+    vecSources.pop_back();
+    cSources = vecSources.size();
+
+    HRESULT rc = S_OK;
+
+    if (cSources > 1)
+    {
+        ComPtr<IGuestFsObjInfo> pFsObjInfo;
+        rc = pCtx->pGuestSession->DirectoryQueryInfo(Bstr(strDest).raw(), pFsObjInfo.asOutParam());
+        if (FAILED(rc))
+            return RTMsgErrorExit(RTEXITCODE_FAILURE, "Destination must be a directory\n");
+    }
+
+    /*
+     * Rename (move) the entries.
+     */
+    if (pCtx->fVerbose && cSources)
+        RTPrintf("Renaming %RU32 %s ...\n", cSources,
+                   cSources > 1
+                 ? "entries" : "entry");
+
+    std::vector< Utf8Str >::iterator it = vecSources.begin();
+    while (   (it != vecSources.end())
+           && !g_fGuestCtrlCanceled)
+    {
+        bool fSourceIsDirectory = false;
+        Utf8Str strCurSource = (*it);
+        Utf8Str strCurDest = strDest;
+
+        /** @todo Slooooow, but works for now. */
+        ComPtr<IGuestFsObjInfo> pFsObjInfo;
+        rc = pCtx->pGuestSession->FileQueryInfo(Bstr(strCurSource).raw(), pFsObjInfo.asOutParam());
+        if (FAILED(rc))
+        {
+            rc = pCtx->pGuestSession->DirectoryQueryInfo(Bstr(strCurSource).raw(), pFsObjInfo.asOutParam());
+            fSourceIsDirectory = SUCCEEDED(rc);
+        }
+        if (FAILED(rc))
+        {
+            if (pCtx->fVerbose)
+                RTPrintf("Warning: Cannot stat for element \"%s\": No such element\n",
+                         strCurSource.c_str());
+            it++;
+            continue; /* Skip. */
+        }
+
+        if (!fSourceIsDirectory)
+        {
+            char *pszFileName = RTPathFilename(strCurSource.c_str());
+            if (!pszFileName)
+            {
+                RTMsgError("Unable to extract file name from source \"%s\"",
+                           strCurSource.c_str());
+                break;
+            }
+
+            char szFileDest[RTPATH_MAX];
+            vrc = RTPathJoin(szFileDest, sizeof(szFileDest), strDest.c_str(), pszFileName);
+            if (RT_FAILURE(vrc))
+            {
+                RTMsgError("Unable to build destination name for source \"%s\", rc=%Rrc",
+                           strCurSource.c_str(), vrc);
+                break;
+            }
+
+            strCurDest = szFileDest;
+        }
+
+        if (pCtx->fVerbose)
+            RTPrintf("Renaming %s \"%s\" to \"%s\" ...\n",
+                     fSourceIsDirectory ? "directory" : "file",
+                     strCurSource.c_str(), strCurDest.c_str());
+
+        if (!fDryrun)
+        {
+            if (fSourceIsDirectory)
+            {
+                CHECK_ERROR_BREAK(pCtx->pGuestSession, DirectoryRename(Bstr(strCurSource).raw(),
+                                                                       Bstr(strCurDest).raw(),
+                                                                       ComSafeArrayAsInParam(aRenameFlags)));
+
+                /* Break here, since it makes no sense to rename mroe than one source to
+                 * the same directory. */
+                it = vecSources.end();
+                break;
+            }
+            else
+                CHECK_ERROR_BREAK(pCtx->pGuestSession, FileRename(Bstr(strCurSource).raw(),
+                                                                  Bstr(strCurDest).raw(),
+                                                                  ComSafeArrayAsInParam(aRenameFlags)));
+        }
+
+        it++;
+    }
+
+    if (   (it != vecSources.end())
+        && pCtx->fVerbose)
+    {
+        RTPrintf("Warning: Not all sources were renamed\n");
+    }
+
+    return FAILED(rc) ? RTEXITCODE_FAILURE : RTEXITCODE_SUCCESS;
+}
+
 static DECLCALLBACK(RTEXITCODE) handleCtrlCreateTemp(PGCTLCMDCTX pCtx)
 {
     AssertPtrReturn(pCtx, RTEXITCODE_FAILURE);
 
-    /*
-     * Parse arguments.
-     *
-     * Note! No direct returns here, everyone must go thru the cleanup at the
-     *       end of this function.
-     */
     static const RTGETOPTDEF s_aOptions[] =
     {
@@ -3246 +3420 @@
         return errorSyntax(USAGE_GUESTCONTROL, "Must specify at least a PID to close");
 
-    /*
-     * Parse arguments.
-     *
-     * Note! No direct returns here, everyone must go thru the cleanup at the
-     *       end of this function.
-     */
     static const RTGETOPTDEF s_aOptions[] =
     {
@@ -3447 +3615 @@
 
     if (pCtx->iArgc < 1)
-        return errorSyntax(USAGE_GUESTCONTROL, "Must specify at least a session ID to close");
-
-    /*
-     * Parse arguments.
-     *
-     * Note! No direct returns here, everyone must go thru the cleanup at the
-     *       end of this function.
-     */
+        return errorSyntax(USAGE_GUESTCONTROL, "Must specify at least a session to close");
+
     static const RTGETOPTDEF s_aOptions[] =
     {
@@ -3602 +3764 @@
     RTGETOPTSTATE GetState;
     RTGetOptInit(&GetState, pCtx->iArgc, pCtx->ppaArgv,
-                 s_aOptions, RT_ELEMENTS(s_aOptions), pCtx->iFirstArgc, RTGETOPTINIT_FLAGS_OPTS_FIRST);
+                 NULL /*s_aOptions*/, 0 /*RT_ELEMENTS(s_aOptions)*/, pCtx->iFirstArgc, RTGETOPTINIT_FLAGS_OPTS_FIRST);
 
     while ((ch = RTGetOpt(&GetState, &ValueUnion)))
@@ -3717 +3879 @@
              || !RTStrICmp(pArg->argv[1], "removefile"))
         gctlCmd.pfnHandler = handleCtrlRemoveFile;
+    else if (   !RTStrICmp(pArg->argv[1], "ren")
+             || !RTStrICmp(pArg->argv[1], "rename")
+             || !RTStrICmp(pArg->argv[1], "mv"))
+        gctlCmd.pfnHandler = handleCtrlRename;
     else if (   !RTStrICmp(pArg->argv[1], "createtemporary")
              || !RTStrICmp(pArg->argv[1], "createtemp")