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

Timestamp:

Apr 7, 2011 9:20:29 AM (14 years ago)

Author:

vboxsync

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

71056

Message:

VBoxManage/GuestCtrl: Added multiple source handling for copyto and made it more similar to cp.

File:

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

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

@@ -108 +108 @@
     GETOPTDEF_EXEC_WAITFORSTDOUT,
     GETOPTDEF_EXEC_WAITFORSTDERR
+};
+
+enum GETOPTDEF_COPYTO
+{
+    GETOPTDEF_COPYTO_DRYRUN = 1000,
+    GETOPTDEF_COPYTO_FOLLOW,
+    GETOPTDEF_COPYTO_PASSWORD,
+    GETOPTDEF_COPYTO_TARGETDIR,
+    GETOPTDEF_COPYTO_USERNAME
 };
 
@@ -488 +497 @@
             case VINF_GETOPT_NOT_OPTION:
             {
-#if 0 /** @todo r=bird: enable this when the argv[0] issue has been addressed. */
                 if (args.size() == 0 && Utf8Cmd.isEmpty())
                     Utf8Cmd = ValueUnion.psz;
                 args.push_back(Bstr(ValueUnion.psz).raw());
-#else
-                if (Utf8Cmd.isEmpty())
-                {
-                    Utf8Cmd = ValueUnion.psz;
-                    if (Utf8Cmd.isEmpty())
-                        return RTMsgErrorExit(RTEXITCODE_SYNTAX, "The first argument cannot be empty yet, wait for 4.1.0");
-                }
-                else
-                    args.push_back(Bstr(ValueUnion.psz).raw());
-#endif
                 break;
             }
@@ -1006 +1004 @@
                 if (RT_SUCCESS(rc))
                 {
-                    RTListInit(pList);
                     rc = ctrlDirectoryEntryAppend(pszSourceAbs, pszDestAbs, pList);
                     *pcObjects = 1;
@@ -1067 +1064 @@
                 if (RT_SUCCESS(rc))
                 {
-                    RTListInit(pList);
                     rc = ctrlCopyDirectoryRead(pszSourceAbsRoot, NULL /* Sub directory */,
                                                pszFilter, pszDestAbs,
@@ -1140 +1136 @@
      * wildcard expansion by a unix shell.  The best solution here would be
      * two different variant, one windowsy (xcopy) and one unixy (gnu cp). */
-    /** @todo r=bird: Why isn't IGuest::CopyToGuest powerful enough to do
-     *        all this recursive copying? */
+
+    /*
+     * IGuest::CopyToGuest is kept as simple as possible to let the developer choose
+     * what and how to implement the file enumeration/recursive lookup, like VBoxManage
+     * does in here.
+     */
 
     static const RTGETOPTDEF s_aOptions[] =
     {
-        { "--dryrun",              'd',         RTGETOPT_REQ_NOTHING }, /**< @todo r=bird: '-d' incompatible with GNU cp.  */
-        { "--follow",              'F',         RTGETOPT_REQ_NOTHING }, /**< @todo r=bird: This isn't a GNU cp option. This is instead spread over several options.  */
-        { "--password",            'p',         RTGETOPT_REQ_STRING  }, /**< @todo r=bird: Just drop these short options since (BSD, GNU, ++) cp uses '-p' to indicate that ownership, timestamp and other stuff should be preserved.  Other file commands probably use '-p' as well. */
-        { "--recursive",           'R',         RTGETOPT_REQ_NOTHING }, /**< @todo r=bird: Most cp implementations treats '-r' as an alias for '-R'. */
-        { "--username",            'u',         RTGETOPT_REQ_STRING  }, /**< @todo r=bird: Just drop these short options since GNU cp uses '-u' to indicate update-only (as does 4nt).  Other file commands probably uses '-u' as well. */
-        { "--verbose",             'v',         RTGETOPT_REQ_NOTHING }
+        { "--dryrun",              GETOPTDEF_COPYTO_DRYRUN,         RTGETOPT_REQ_NOTHING },
+        { "--follow",              GETOPTDEF_COPYTO_FOLLOW,         RTGETOPT_REQ_NOTHING },
+        { "--password",            GETOPTDEF_COPYTO_PASSWORD,       RTGETOPT_REQ_STRING  },
+        { "--recursive",           'R',                             RTGETOPT_REQ_NOTHING },
+        { "--target-directory",    GETOPTDEF_COPYTO_TARGETDIR,      RTGETOPT_REQ_STRING  },
+        { "--username",            GETOPTDEF_COPYTO_USERNAME,       RTGETOPT_REQ_STRING  },
+        { "--verbose",             'v',                             RTGETOPT_REQ_NOTHING }
     };
 
@@ -1156 +1157 @@
     RTGETOPTUNION ValueUnion;
     RTGETOPTSTATE GetState;
-    RTGetOptInit(&GetState, pArg->argc, pArg->argv, s_aOptions, RT_ELEMENTS(s_aOptions), 0, 0);
+    RTGetOptInit(&GetState, pArg->argc, pArg->argv,
+                 s_aOptions, RT_ELEMENTS(s_aOptions), 0, RTGETOPTINIT_FLAGS_OPTS_FIRST);
 
     Utf8Str Utf8Source;
@@ -1167 +1169 @@
     bool fDryRun = false;
 
+    RTLISTNODE listSources;
+    uint32_t cSources = 0;
+    RTListInit(&listSources);
+
     int vrc = VINF_SUCCESS;
-    uint32_t idxNonOption = 0;
     while ((ch = RTGetOpt(&GetState, &ValueUnion)))
     {
@@ -1174 +1179 @@
         switch (ch)
         {
-            case 'd': /* Dry run */
+            case GETOPTDEF_COPYTO_DRYRUN:
                 fDryRun = true;
                 break;
 
-            case 'F': /* Follow symlinks */
+            case GETOPTDEF_COPYTO_FOLLOW:
                 fFlags |= CopyFileFlag_FollowLinks;
                 break;
 
-            case 'p': /* Password */
+            case GETOPTDEF_COPYTO_PASSWORD:
                 Utf8Password = ValueUnion.psz;
                 break;
@@ -1190 +1195 @@
                 break;
 
-            case 'u': /* User name */
+            case GETOPTDEF_COPYTO_TARGETDIR:
+                Utf8Dest = ValueUnion.psz;
+                break;
+
+            case GETOPTDEF_COPYTO_USERNAME:
                 Utf8UserName = ValueUnion.psz;
                 break;
@@ -1200 +1209 @@
             case VINF_GETOPT_NOT_OPTION:
             {
-                /* Get the actual source + destination. */
-                switch (idxNonOption)
+                /* Last argument and no destination specified with
+                 * --target-directory yet? Then use the current argument
+                 * as destination. */
+                if (   pArg->argc == GetState.iNext
+                    && Utf8Dest.isEmpty())
                 {
-                    case 0:
-                        Utf8Source = ValueUnion.psz;
-                        break;
-
-                    case 1:
-                        Utf8Dest = ValueUnion.psz;
-                        break;
-
-                    /* @todo r=bird: VBoxManage guestcontrol execute <VMName> copyto hostfile.1 hostfile.2 hostfile.3 guestdir/
-                     * A better way to implement this would be to tell RTGetOptInit to sort the argument, so
-                     * that when VINF_GETOPT_NOT_OPTION is returned, the remainder of pArg->argv are all arguments. */
-
-                    default:
-                        return errorSyntax(USAGE_GUESTCONTROL, "Too many parameters specified, only source and destination allowed!");
+                    Utf8Dest = ValueUnion.psz;
                 }
-                idxNonOption++;
-                if (idxNonOption == UINT32_MAX)
-                    return errorSyntax(USAGE_GUESTCONTROL, "Too many files specified!");
+                else
+                {
+                    int vrc = ctrlDirectoryEntryAppend(ValueUnion.psz,      /* Source */
+                                                       NULL,                /* No destination given */
+                                                       &listSources);
+                    if (RT_SUCCESS(vrc))
+                    {
+                        cSources++;
+                        if (cSources == UINT32_MAX)
+                            return RTMsgErrorExit(RTEXITCODE_SYNTAX, "Too many sources specified! Aborting.");
+                    }
+                    else
+                        return RTMsgErrorExit(RTEXITCODE_SYNTAX, "Failed to append source: %Rrc", vrc);
+                }
                 break;
             }
@@ -1229 +1239 @@
     }
 
-    if (Utf8Source.isEmpty())
+    if (!cSources)
         return errorSyntax(USAGE_GUESTCONTROL,
-                           "No source specified!");
+                           "No source(s) specified!");
 
     if (Utf8Dest.isEmpty())
@@ -1253 +1263 @@
 
     RTLISTNODE listToCopy;
-    uint32_t cObjects = 0;
-    vrc = ctrlCopyInit(Utf8Source.c_str(), Utf8Dest.c_str(), fFlags,
-                       &cObjects, &listToCopy);
-    if (RT_FAILURE(vrc))
-    {
-        switch (vrc)
-        {
-            case VERR_NOT_FOUND:
-                RTMsgError("No files to copy found!\n");
-                break;
-
-            case VERR_FILE_NOT_FOUND:
-                RTMsgError("Source path \"%s\" not found!\n", Utf8Source.c_str());
-                break;
-
-            default:
-                RTMsgError("Failed to initialize, rc=%Rrc\n", vrc);
-                break;
-        }
-    }
-    else
+    RTListInit(&listToCopy);
+    uint32_t cTotalObjects = 0;
+
+    PDIRECTORYENTRY pNodeSource;
+    RTListForEach(&listSources, pNodeSource, DIRECTORYENTRY, Node)
+    {
+        uint32_t cObjects = 0;
+        vrc = ctrlCopyInit(pNodeSource->pszSourcePath, Utf8Dest.c_str(), fFlags,
+                           &cObjects, &listToCopy);
+        if (RT_FAILURE(vrc))
+        {
+            switch (vrc)
+            {
+                case VERR_NOT_FOUND:
+                    /* Not fatal, just continue to the next source entry (if available). */
+                    continue;
+
+                case VERR_FILE_NOT_FOUND:
+                    RTMsgError("Source path \"%s\" not found!\n", Utf8Source.c_str());
+                    break;
+
+                default:
+                    RTMsgError("Failed to initialize, rc=%Rrc\n", vrc);
+                    break;
+            }
+        }
+        else if (fVerbose)
+        {
+            RTPrintf("Source \"%s\" has %ld elements to copy\n",
+                     pNodeSource->pszSourcePath, cObjects);
+        }
+        cTotalObjects += cObjects;
+    }
+
+    if (fVerbose && cTotalObjects)
+        RTPrintf("Total %ld elements to copy to \"%s\"\n",
+                 cTotalObjects, Utf8Dest.c_str());
+
+    if (cTotalObjects)
     {
         PDIRECTORYENTRY pNode;
-        if (RT_SUCCESS(vrc))
+        uint32_t uCurObject = 1;
+
+        RTListForEach(&listToCopy, pNode, DIRECTORYENTRY, Node)
         {
             if (fVerbose)
-            {
-                if (fCopyRecursive)
-                    RTPrintf("Recursively copying \"%s\" to \"%s\" (%u file(s)) ...\n",
-                             Utf8Source.c_str(), Utf8Dest.c_str(), cObjects);
-                else
-                    RTPrintf("Copying \"%s\" to \"%s\" (%u file(s)) ...\n",
-                             Utf8Source.c_str(), Utf8Dest.c_str(), cObjects);
-            }
-
-            uint32_t iObject = 1;
-            RTListForEach(&listToCopy, pNode, DIRECTORYENTRY, Node)
-            {
-                if (!fDryRun)
-                {
-                    if (fVerbose)
-                        RTPrintf("Copying \"%s\" to \"%s\" (%u/%u) ...\n",
-                                 pNode->pszSourcePath, pNode->pszDestPath, iObject, cObjects);
-                    /* Finally copy the desired file (if no dry run selected). */
-                    if (!fDryRun)
-                        vrc = ctrlCopyFileToGuest(guest, fVerbose, pNode->pszSourcePath, pNode->pszDestPath,
-                                                  Utf8UserName.c_str(), Utf8Password.c_str(), fFlags);
-                }
-                if (RT_FAILURE(vrc))
-                    break;
-                iObject++;
-            }
-            if (RT_SUCCESS(vrc) && fVerbose)
-                RTPrintf("Copy operation successful!\n");
-        }
-        ctrlDirectoryListDestroy(&listToCopy);
-    }
+                RTPrintf("Copying \"%s\" to \"%s\" (%u/%u) ...\n",
+                         pNode->pszSourcePath, pNode->pszDestPath, uCurObject, cTotalObjects);
+            /* Finally copy the desired file (if no dry run selected). */
+            if (!fDryRun)
+                vrc = ctrlCopyFileToGuest(guest, fVerbose, pNode->pszSourcePath, pNode->pszDestPath,
+                                          Utf8UserName.c_str(), Utf8Password.c_str(), fFlags);
+            if (RT_FAILURE(vrc))
+                break;
+            uCurObject++;
+        }
+        Assert(cTotalObjects == uCurObject - 1);
+
+        if (RT_SUCCESS(vrc) && fVerbose)
+            RTPrintf("Copy operation successful!\n");
+    }
+
+    ctrlDirectoryListDestroy(&listToCopy);
+    ctrlDirectoryListDestroy(&listSources);
 
     if (RT_FAILURE(vrc))
@@ -1338 +1355 @@
     RTGETOPTUNION ValueUnion;
     RTGETOPTSTATE GetState;
-    RTGetOptInit(&GetState, pArg->argc, pArg->argv, s_aOptions, RT_ELEMENTS(s_aOptions), 0, 0);
+    RTGetOptInit(&GetState, pArg->argc, pArg->argv,
+                 s_aOptions, RT_ELEMENTS(s_aOptions), 0, RTGETOPTINIT_FLAGS_OPTS_FIRST);
 
     Utf8Str Utf8UserName;
     Utf8Str Utf8Password;
     uint32_t fFlags = CreateDirectoryFlag_None;
-    uint32_t fDirMode = 0; /* 0 == default mode, right? */
+    uint32_t fDirMode = 0; /* Default mode. */
     bool fVerbose = false;
 
@@ -1379 +1397 @@
             case VINF_GETOPT_NOT_OPTION:
             {
-/** @todo r=bird: Simplify by letting RTGetOptInit sort the argv, just like
- *        for cp. */
                 int vrc = ctrlDirectoryEntryAppend(NULL,              /* No source given */
                                                    ValueUnion.psz,    /* Destination */