Changeset 37952 in vbox

Timestamp:

Jul 14, 2011 10:14:52 AM (14 years ago)

Author:

vboxsync

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

72865

Message:

VBoxServiceToolbox.cpp: Use RTMsgSetProgName; mkdir shall fail if no arguments are given.

File:

• trunk/src/VBox/Additions/common/VBoxService/VBoxServiceToolBox.cpp (modified) (26 diffs)

trunk/src/VBox/Additions/common/VBoxService/VBoxServiceToolBox.cpp

@@ -73 +73 @@
 *   Structures and Typedefs                                                    *
 *******************************************************************************/
+/** Pointer to a handler function. */
+typedef RTEXITCODE (*PFNHANDLER)(int , char **);
+
 /**
  * An file/directory entry. Used to cache
@@ -126 +129 @@
 
 /**
- * Displays an error message because of syntax error.
- *
- * @return  VERR_INVALID_PARAMETER
- * @param   pszFormat
- */
-static int VBoxServiceToolboxErrorSyntax(const char *pszFormat, ...)
-{
-    va_list args;
-
-    va_start(args, pszFormat);
-    RTPrintf("\n"
-             "Syntax error: %N\n", pszFormat, &args);
-    va_end(args);
-    return VERR_INVALID_PARAMETER;
-}
-
-/**
  * Prints a parseable stream header which contains the actual tool
  * which was called/used along with its stream version.
@@ -234 +220 @@
         rc = RTFileFromNative(&hInput, RTFILE_NATIVE_STDIN);
         if (RT_FAILURE(rc))
-            RTMsgError("cat: Could not translate input file to native handle, rc=%Rrc\n", rc);
+            RTMsgError("Could not translate input file to native handle, rc=%Rrc\n", rc);
     }
 
@@ -241 +227 @@
         rc = RTFileFromNative(&hOutput, RTFILE_NATIVE_STDOUT);
         if (RT_FAILURE(rc))
-            RTMsgError("cat: Could not translate output file to native handle, rc=%Rrc\n", rc);
+            RTMsgError("Could not translate output file to native handle, rc=%Rrc\n", rc);
     }
 
@@ -261 +247 @@
                     rc = VINF_SUCCESS;
                 else if (RT_FAILURE(rc))
-                    RTMsgError("cat: Error while reading input, rc=%Rrc\n", rc);
+                    RTMsgError("Error while reading input, rc=%Rrc\n", rc);
                 break;
             }
@@ -333 +319 @@
             case 'T':
             case 'v':
-                RTMsgError("cat: Sorry, option '%s' is not implemented yet!\n",
+                RTMsgError("Sorry, option '%s' is not implemented yet!\n",
                            ValueUnion.pDef->pszLong);
                 rc = VERR_INVALID_PARAMETER;
@@ -382 +368 @@
             rc = RTFileOpen(&hOutput, szOutput, fFlags);
             if (RT_FAILURE(rc))
-                RTMsgError("cat: Could not create output file '%s', rc=%Rrc\n",
+                RTMsgError("Could not create output file '%s', rc=%Rrc\n",
                            szOutput, rc);
         }
@@ -404 +390 @@
                     PCRTSTATUSMSG pMsg = RTErrGet(rc);
                     if (pMsg)
-                        RTMsgError("cat: Could not open input file '%s': %s\n",
+                        RTMsgError("Could not open input file '%s': %s\n",
                                    pNodeIt->pszName, pMsg->pszMsgFull);
                     else
-                        RTMsgError("cat: Could not open input file '%s', rc=%Rrc\n", pNodeIt->pszName, rc);
+                        RTMsgError("Could not open input file '%s', rc=%Rrc\n", pNodeIt->pszName, rc);
                 }
 
@@ -607 +593 @@
     if (RT_FAILURE(rc))
     {
-        RTMsgError("ls: Failed to retrieve absolute path of '%s', rc=%Rrc\n", pszDir, rc);
+        RTMsgError("Failed to retrieve absolute path of '%s', rc=%Rrc\n", pszDir, rc);
         return rc;
     }
@@ -615 +601 @@
     if (RT_FAILURE(rc))
     {
-        RTMsgError("ls: Failed to open directory '%s', rc=%Rrc\n", szPathAbs, rc);
+        RTMsgError("Failed to open directory '%s', rc=%Rrc\n", szPathAbs, rc);
         return rc;
     }
@@ -649 +635 @@
     if (RT_FAILURE(rc2))
     {
-        RTMsgError("ls: Failed to close dir '%s', rc=%Rrc\n",
+        RTMsgError("Failed to close dir '%s', rc=%Rrc\n",
                    pszDir, rc2);
         if (RT_SUCCESS(rc))
@@ -741 +727 @@
     RTGETOPTUNION ValueUnion;
     RTGETOPTSTATE GetState;
-    RTGetOptInit(&GetState, argc, argv,
-                 s_aOptions, RT_ELEMENTS(s_aOptions),
-                 1 /*iFirst*/, RTGETOPTINIT_FLAGS_OPTS_FIRST);
-
-    int rc = VINF_SUCCESS;
-    bool fVerbose = false;
-    uint32_t fFlags = VBOXSERVICETOOLBOXLSFLAG_NONE;
+    int rc = RTGetOptInit(&GetState, argc, argv,
+                          s_aOptions, RT_ELEMENTS(s_aOptions),
+                          1 /*iFirst*/, RTGETOPTINIT_FLAGS_OPTS_FIRST);
+    AssertRCReturn(rc, RTEXITCODE_INIT);
+
+    bool     fVerbose     = false;
+    uint32_t fFlags       = VBOXSERVICETOOLBOXLSFLAG_NONE;
     uint32_t fOutputFlags = VBOXSERVICETOOLBOXOUTPUTFLAG_NONE;
 
@@ -780 +766 @@
                 break;
 
-            case 'v':
+            case 'v': /** @todo r=bird: "man ls" -> "-v natural sort of (version) numbers within text" */
                 fVerbose = true;
                 break;
@@ -817 +803 @@
                 rc = VBoxServiceToolboxPathBufAddPathEntry(&fileList, szDirCur);
                 if (RT_FAILURE(rc))
-                    RTMsgError("ls: Adding current directory failed, rc=%Rrc\n", rc);
+                    RTMsgError("Adding current directory failed, rc=%Rrc\n", rc);
             }
             else
-                RTMsgError("ls: Getting current directory failed, rc=%Rrc\n", rc);
+                RTMsgError("Getting current directory failed, rc=%Rrc\n", rc);
         }
 
@@ -857 +843 @@
                     }
                     else
-                        RTMsgError("ls: Unable to query information for '%s', rc=%Rrc\n",
+                        RTMsgError("Unable to query information for '%s', rc=%Rrc\n",
                                    pNodeIt->pszName, rc);
                     RTFileClose(file);
                 }
                 else
-                    RTMsgError("ls: Failed opening '%s', rc=%Rrc\n",
+                    RTMsgError("Failed opening '%s', rc=%Rrc\n",
                                pNodeIt->pszName, rc);
             }
@@ -869 +855 @@
                                                    fFlags, fOutputFlags);
             if (RT_FAILURE(rc))
-                RTMsgError("ls: Failed while enumerating '%s', rc=%Rrc\n",
+                RTMsgError("Failed while enumerating '%s', rc=%Rrc\n",
                            pNodeIt->pszName, rc);
         }
@@ -877 +863 @@
     }
     else if (fVerbose)
-        RTMsgError("ls: Failed with rc=%Rrc\n", rc);
+        RTMsgError("Failed with rc=%Rrc\n", rc);
 
     VBoxServiceToolboxPathBufDestroy(&fileList);
@@ -898 +884 @@
         { "--parents",  'p', RTGETOPT_REQ_NOTHING},
         { "--verbose",  'v', RTGETOPT_REQ_NOTHING}
+    };
+
+    int ch;
+    RTGETOPTUNION ValueUnion;
+    RTGETOPTSTATE GetState;
+    int rc = RTGetOptInit(&GetState, argc, argv,
+                          s_aOptions, RT_ELEMENTS(s_aOptions),
+                          1 /*iFirst*/, RTGETOPTINIT_FLAGS_OPTS_FIRST);
+    AssertRCReturn(rc, RTEXITCODE_INIT);
+
+    bool    fMakeParentDirs = false;
+    bool    fVerbose        = false;
+    RTFMODE fDirMode        = RTFS_UNIX_IRWXU | RTFS_UNIX_IRWXG | RTFS_UNIX_IRWXO;
+    int     cDirsCreated    = 0;
+
+    while ((ch = RTGetOpt(&GetState, &ValueUnion)))
+    {
+        /* For options that require an argument, ValueUnion has received the value. */
+        switch (ch)
+        {
+            case 'p':
+                fMakeParentDirs = true;
+#ifndef RT_OS_WINDOWS
+                umask(0); /* RTDirCreate workaround */
+#endif
+                break;
+
+            case 'm':
+                rc = RTStrToUInt32Ex(ValueUnion.psz, NULL, 8 /* Base */, &fDirMode);
+                if (RT_FAILURE(rc)) /* Only octet based values supported right now! */
+                    return RTMsgErrorExit(RTEXITCODE_SYNTAX,
+                                          "Mode flag strings not implemented yet! Use octal numbers instead. (%s)\n",
+                                          ValueUnion.psz);
+#ifndef RT_OS_WINDOWS
+                umask(0); /* RTDirCreate workaround */
+#endif
+                break;
+
+            case 'v':
+                fVerbose = true;
+                break;
+
+            case 'h':
+                RTPrintf("Usage: %s [options] dir1 [dir2...]\n"
+                         "\n"
+                         "Options:\n"
+                         "    -m,--mode=<mode>  The file mode to set (chmod) on the created\n"
+                         "                      directories.  Default: a=rwx & umask.\n"
+                         "    -p,--parents      Create parent directories as needed, no\n"
+                         "                      error if the directory already exists.\n"
+                         "    -v,--verbose      Display a message for each created directory.\n"
+                         "    -V,--version      Display the version and exit\n"
+                         "    -h,--help         Display this help text and exit.\n"
+                         , argv[0]);
+                return RTEXITCODE_SUCCESS;
+
+            case 'V':
+                VBoxServiceToolboxShowVersion();
+                return RTEXITCODE_SUCCESS;
+
+            case VINF_GETOPT_NOT_OPTION:
+                if (fMakeParentDirs)
+                    /** @todo r=bird: If fVerbose is set, we should also show
+                     * which directories that get created, parents as well as
+                     * omitting existing final dirs. Annoying, but check any
+                     * mkdir implementation (try "mkdir -pv asdf/1/2/3/4"
+                     * twice). */
+                    rc = RTDirCreateFullPath(ValueUnion.psz, fDirMode);
+                else
+                    rc = RTDirCreate(ValueUnion.psz, fDirMode);
+                if (RT_FAILURE(rc))
+                    return RTMsgErrorExit(RTEXITCODE_FAILURE, "Could not create directory '%s': %Rra\n",
+                                          ValueUnion.psz, rc);
+                if (fVerbose)
+                    RTMsgInfo("Created directory 's', mode %#RTfmode\n", ValueUnion.psz, fDirMode);
+                cDirsCreated++;
+                break;
+
+            default:
+                return RTGetOptPrintError(ch, &ValueUnion);
+        }
+    }
+    AssertRC(rc);
+
+    if (cDirsCreated == 0)
+        return RTMsgErrorExit(RTEXITCODE_SYNTAX, "No directory argument.");
+
+    return RTEXITCODE_SUCCESS;
+}
+
+
+/**
+ * Main function for tool "vbox_stat".
+ *
+ * @return  RTEXITCODE.
+ * @param   argc                    Number of arguments.
+ * @param   argv                    Pointer to argument array.
+ */
+static RTEXITCODE VBoxServiceToolboxStat(int argc, char **argv)
+{
+    static const RTGETOPTDEF s_aOptions[] =
+    {
+        { "--file-system",     'f',                       RTGETOPT_REQ_NOTHING },
+        { "--dereference",     'L',                       RTGETOPT_REQ_NOTHING },
+        { "--machinereadable", STAT_OPT_MACHINE_READABLE, RTGETOPT_REQ_NOTHING },
+        { "--terse",           't',                       RTGETOPT_REQ_NOTHING },
+        { "--verbose",         'v',                       RTGETOPT_REQ_NOTHING }
     };
 
@@ -908 +1001 @@
 
     int rc = VINF_SUCCESS;
-    bool fMakeParentDirs = false;
     bool fVerbose = false;
-
-    RTFMODE newMode = 0;
-    RTFMODE dirMode = RTFS_UNIX_IRWXU | RTFS_UNIX_IRWXG | RTFS_UNIX_IRWXO;
-
-    /* Init directory list. */
-    RTLISTNODE dirList;
-    RTListInit(&dirList);
+    uint32_t fOutputFlags = VBOXSERVICETOOLBOXOUTPUTFLAG_LONG; /* Use long mode by default. */
+
+    /* Init file list. */
+    RTLISTNODE fileList;
+    RTListInit(&fileList);
 
     while (   (ch = RTGetOpt(&GetState, &ValueUnion))
@@ -924 +1014 @@
         switch (ch)
         {
+            case 'f':
+            case 'L':
+                RTMsgError("Sorry, option '%s' is not implemented yet!\n", ValueUnion.pDef->pszLong);
+                rc = VERR_INVALID_PARAMETER;
+                break;
+
+            case LS_OPT_MACHINE_READABLE:
+                fOutputFlags |= VBOXSERVICETOOLBOXOUTPUTFLAG_PARSEABLE;
+                break;
+
+            case 'v':   /** @todo r=bird: There is no verbose option for stat. */
+                fVerbose = true;
+                break;
+
             case 'h':
                 VBoxServiceToolboxShowUsage();
                 return RTEXITCODE_SUCCESS;
-
-            case 'p':
-                fMakeParentDirs = true;
-                break;
-
-            case 'm':
-                rc = RTStrToUInt32Ex(ValueUnion.psz, NULL, 8 /* Base */, &newMode);
-                if (RT_FAILURE(rc)) /* Only octet based values supported right now! */
-                {
-                    RTMsgError("mkdir: Mode flag strings not implemented yet! Use octal numbers instead.\n");
-                    return RTEXITCODE_SYNTAX;
-                }
-                break;
-
-            case 'v':
-                fVerbose = true;
-                break;
-
-            case 'V':
-                VBoxServiceToolboxShowVersion();
-                return RTEXITCODE_SUCCESS;
-
-            case VINF_GETOPT_NOT_OPTION:
-               /* Add path(s) to buffer. This enables processing multiple paths
-                * at once.
-                *
-                * Since the non-options (RTGETOPTINIT_FLAGS_OPTS_FIRST) come last when
-                * processing this loop it's safe to immediately exit on syntax errors
-                * or showing the help text (see above). */
-               rc = VBoxServiceToolboxPathBufAddPathEntry(&dirList, ValueUnion.psz);
-               break;
-
-
-            default:
-                return RTGetOptPrintError(ch, &ValueUnion);
-        }
-    }
-
-    if (RT_SUCCESS(rc))
-    {
-        if (fMakeParentDirs || newMode)
-        {
-#ifndef RT_OS_WINDOWS
-            mode_t umaskMode = umask(0); /* Get current umask. */
-            if (newMode)
-                dirMode = newMode;
-#endif
-        }
-
-        PVBOXSERVICETOOLBOXPATHENTRY pNodeIt;
-        RTListForEach(&dirList, pNodeIt, VBOXSERVICETOOLBOXPATHENTRY, Node)
-        {
-            rc = fMakeParentDirs
-               ? RTDirCreateFullPath(pNodeIt->pszName, dirMode)
-               : RTDirCreate(pNodeIt->pszName, dirMode);
-
-            if (RT_SUCCESS(rc) && fVerbose)
-                RTMsgError("mkdir: Created directory 's', mode %#RTfmode\n", pNodeIt->pszName, dirMode);
-            else if (RT_FAILURE(rc)) /** @todo Add a switch with more helpful error texts! */
-            {
-                RTMsgError("mkdir: Could not create directory '%s': %Rra\n", pNodeIt->pszName, rc);
-                break;
-            }
-        }
-    }
-    else if (fVerbose)
-        RTMsgError("mkdir: Failed with rc=%Rrc\n", rc);
-
-    VBoxServiceToolboxPathBufDestroy(&dirList);
-    return RT_SUCCESS(rc) ? RTEXITCODE_SUCCESS : RTEXITCODE_FAILURE;
-}
-
-
-/**
- * Main function for tool "vbox_stat".
- *
- * @return  RTEXITCODE.
- * @param   argc                    Number of arguments.
- * @param   argv                    Pointer to argument array.
- */
-static RTEXITCODE VBoxServiceToolboxStat(int argc, char **argv)
-{
-    static const RTGETOPTDEF s_aOptions[] =
-    {
-        { "--file-system",     'f',                       RTGETOPT_REQ_NOTHING },
-        { "--dereference",     'L',                       RTGETOPT_REQ_NOTHING },
-        { "--machinereadable", STAT_OPT_MACHINE_READABLE, RTGETOPT_REQ_NOTHING },
-        { "--terse",           't',                       RTGETOPT_REQ_NOTHING },
-        { "--verbose",         'v',                       RTGETOPT_REQ_NOTHING }
-    };
-
-    int ch;
-    RTGETOPTUNION ValueUnion;
-    RTGETOPTSTATE GetState;
-    RTGetOptInit(&GetState, argc, argv,
-                 s_aOptions, RT_ELEMENTS(s_aOptions),
-                 1 /*iFirst*/, RTGETOPTINIT_FLAGS_OPTS_FIRST);
-
-    int rc = VINF_SUCCESS;
-    bool fVerbose = false;
-    uint32_t fOutputFlags = VBOXSERVICETOOLBOXOUTPUTFLAG_LONG; /* Use long mode by default. */
-
-    /* Init file list. */
-    RTLISTNODE fileList;
-    RTListInit(&fileList);
-
-    while (   (ch = RTGetOpt(&GetState, &ValueUnion))
-              && RT_SUCCESS(rc))
-    {
-        /* For options that require an argument, ValueUnion has received the value. */
-        switch (ch)
-        {
-            case 'h':
-                VBoxServiceToolboxShowUsage();
-                return RTEXITCODE_SUCCESS;
-
-            case 'f':
-            case 'L':
-                RTMsgError("stat: Sorry, option '%s' is not implemented yet!\n",
-                           ValueUnion.pDef->pszLong);
-                rc = VERR_INVALID_PARAMETER;
-                break;
-
-            case LS_OPT_MACHINE_READABLE:
-                fOutputFlags |= VBOXSERVICETOOLBOXOUTPUTFLAG_PARSEABLE;
-                break;
-
-            case 'v':
-                fVerbose = true;
-                break;
 
             case 'V':
@@ -1103 +1077 @@
                     rc2 = RTFileQueryInfo(file, &objInfo, RTFSOBJATTRADD_UNIX);
                     if (RT_FAILURE(rc2))
-                        RTMsgError("stat: Unable to query information for '%s', rc=%Rrc\n",
+                        RTMsgError("Unable to query information for '%s', rc=%Rrc\n",
                                    pNodeIt->pszName, rc2);
                     RTFileClose(file);
                 }
                 else
-                    RTMsgError("stat: Failed opening '%s', rc=%Rrc\n",
+                    RTMsgError("Failed opening '%s', rc=%Rrc\n",
                                pNodeIt->pszName, rc2);
 
@@ -1126 +1100 @@
             else
             {
-                RTMsgError("stat: Cannot stat for '%s': No such file or directory\n",
+                RTMsgError("Cannot stat for '%s': No such file or directory\n",
                            pNodeIt->pszName);
                 rc = VERR_FILE_NOT_FOUND;
@@ -1150 +1124 @@
 
         if (RTListIsEmpty(&fileList))
-            RTMsgError("stat: Missing operand\n");
+            RTMsgError("Missing operand\n");
     }
     else if (fVerbose)
-        RTMsgError("stat: Failed with rc=%Rrc\n", rc);
+        RTMsgError("Failed with rc=%Rrc\n", rc);
 
     VBoxServiceToolboxPathBufDestroy(&fileList);
@@ -1160 +1134 @@
 
 
-/**
- * Entry point for internal toolbox.
- *
- * @return  True if an internal tool was handled, false if not.
- * @param   argc                    Number of arguments.
- * @param   argv                    Pointer to argument array.
- * @param   prcExit                 Where to store the exit code when an
- *                                  internal toolbox command was handled.
- */
-bool VBoxServiceToolboxMain(int argc, char **argv, RTEXITCODE *prcExit)
+
+/**
+ * Looks up the handler for the tool give by @a pszTool.
+ *
+ * @returns Pointer to handler function.  NULL if not found.
+ * @param   pszTool     The name of the tool.
+ */
+static PFNHANDLER vboxServiceToolboxLookUpHandler(const char *pszTool)
 {
     static struct
@@ -1184 +1156 @@
     };
 
-    /*
-     * Check if the file named in argv[0] is one of the toolbox programs.
-     */
-    AssertReturn(argc > 0, false);
-    const char *pszTool = RTPathFilename(argv[0]);
     /* Skip optional 'vbox_' prefix. */
     if (   pszTool[0] == 'v'
@@ -1197 +1164 @@
         pszTool += 5;
 
+    /* Do a linear search, since we don't have that much stuff in the table. */
     for (unsigned i = 0; i < RT_ELEMENTS(s_aTools); i++)
         if (!strcmp(s_aTools[i].pszName, pszTool))
-        {
-            *prcExit = s_aTools[i].pfnHandler(argc, argv);
-            return true;
-        }
+            return s_aTools[i].pfnHandler;
+
+    return NULL;
+}
+
+
+/**
+ * Entry point for internal toolbox.
+ *
+ * @return  True if an internal tool was handled, false if not.
+ * @param   argc                    Number of arguments.
+ * @param   argv                    Pointer to argument array.
+ * @param   prcExit                 Where to store the exit code when an
+ *                                  internal toolbox command was handled.
+ */
+bool VBoxServiceToolboxMain(int argc, char **argv, RTEXITCODE *prcExit)
+{
 
     /*
-     * For debugging and testing purposes we also allow toolbox program access
-     * when the first VBoxService argument is --use-toolbox.
+     * Check if the file named in argv[0] is one of the toolbox programs.
      */
-    if (argc >= 3 && !strcmp(argv[1], "--use-toolbox"))
-    {
-        pszTool = argv[2];
-        for (unsigned i = 0; i < RT_ELEMENTS(s_aTools); i++)
-            if (!strcmp(s_aTools[i].pszName, pszTool))
-            {
-                *prcExit = s_aTools[i].pfnHandler(argc - 2, argv + 2);
-                return true;
-            }
-
-       *prcExit = RTMsgErrorExit(RTEXITCODE_SYNTAX, "Toolbox program '%s' does not exist", pszTool);
-       return true;
-    }
-
-    return false;
-}
-
+    AssertReturn(argc > 0, false);
+    const char *pszTool    = RTPathFilename(argv[0]);
+    PFNHANDLER  pfnHandler = vboxServiceToolboxLookUpHandler(pszTool);
+    if (!pfnHandler)
+    {
+        /*
+         * For debugging and testing purposes we also allow toolbox program access
+         * when the first VBoxService argument is --use-toolbox.
+         */
+        if (argc < 3 || strcmp(argv[1], "--use-toolbox"))
+            return false;
+        argc -= 2;
+        argv += 2;
+        pszTool = argv[0];
+        pfnHandler = vboxServiceToolboxLookUpHandler(pszTool);
+        if (!pfnHandler)
+        {
+           *prcExit = RTMsgErrorExit(RTEXITCODE_SYNTAX, "Toolbox program '%s' does not exist", pszTool);
+           return true;
+        }
+    }
+
+    /*
+     * Invoke the handler.
+     */
+    RTMsgSetProgName("VBoxService/%s", pszTool);
+    *prcExit = pfnHandler(argc, argv);
+    return true;
+
+}
+