Changeset 79570 in vbox

Timestamp:

Jul 7, 2019 12:40:40 AM (6 years ago)

Author:

vboxsync

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

131860

Message:

IPRT: Added RTPathPurgeFilename for making valid filenames out of random strings. bugref:9288

Location:

trunk

Files:

• include/iprt/mangling.h (modified) (1 diff)
• include/iprt/path.h (modified) (1 diff)
• src/VBox/Runtime/Makefile.kmk (modified) (1 diff)
• src/VBox/Runtime/common/path/RTPathPurgeFilename.cpp (added)
• src/VBox/Runtime/testcase/tstRTPath.cpp (modified) (2 diffs)

trunk/include/iprt/mangling.h

@@ -1644 +1644 @@
 # define RTPathParsedReassemble                         RT_MANGLER(RTPathParsedReassemble)
 # define RTPathParseSimple                              RT_MANGLER(RTPathParseSimple)
+# define RTPathPurgeFilename                            RT_MANGLER(RTPathPurgeFilename)
 # define RTPathQueryInfo                                RT_MANGLER(RTPathQueryInfo)
 # define RTPathQueryInfoEx                              RT_MANGLER(RTPathQueryInfoEx)

trunk/include/iprt/path.h

@@ -454 +454 @@
  */
 RTDECL(char *) RTPathChangeToUnixSlashes(char *pszPath, bool fForce);
+
+/**
+ * Purges a string so it can be used as a file according to fFlags.
+ *
+ * Illegal filename characters are replaced by '_'.
+ *
+ * @returns pszString
+ * @param   pszString   The string to purge.
+ * @param   fFlags      One of the RTPATH_STR_F_STYLE_XXX flags.  Most users
+ *                      will pass RTPATH_STR_F_STYLE_HOST (0).
+ */
+RTDECL(char *) RTPathPurgeFilename(char *pszString, uint32_t fFlags);
 
 /**

trunk/src/VBox/Runtime/Makefile.kmk

@@ -533 +533 @@
         common/path/RTPathParsedReassemble.cpp \
         common/path/RTPathParseSimple.cpp \
+        common/path/RTPathPurgeFilename.cpp \
         common/path/RTPathRealDup.cpp \
         common/path/RTPathRmCmd.cpp \

trunk/src/VBox/Runtime/testcase/tstRTPath.cpp

@@ -251 +251 @@
                              i, cchParent2, cchExpected, s_aTests[i].pszPath);
         }
+    }
+}
+
+
+static void testPurgeFilename(RTTEST hTest)
+{
+    static struct
+    {
+        const char *pszIn, *pszOut;
+        uint32_t    fFlags;
+    } const s_aTests[] =
+    {
+        { "start///end",            "start___end",      RTPATH_STR_F_STYLE_UNIX },
+        { "start///end",            "start___end",      RTPATH_STR_F_STYLE_DOS },
+        { "start///end",            "start___end",      RTPATH_STR_F_STYLE_HOST },
+        { "1:<>\\9",                "1:<>\\9",          RTPATH_STR_F_STYLE_UNIX },
+        { "1:<>\\9",                "1____9",           RTPATH_STR_F_STYLE_DOS },
+        { "\t\r\n",                 "\t\r\n",           RTPATH_STR_F_STYLE_UNIX },
+        { "\t\r\n",                 "___",              RTPATH_STR_F_STYLE_DOS },
+    };
+    RTTestSub(hTest, "RTPathPurgeFilename");
+    for (uint32_t i = 0; i < RT_ELEMENTS(s_aTests); i++)
+    {
+        char szPath[RTPATH_MAX];
+        strcpy(szPath, s_aTests[i].pszIn);
+        char *pszRet = RTPathPurgeFilename(szPath, s_aTests[i].fFlags);
+        RTTEST_CHECK(hTest, pszRet == &szPath[0]);
+        if (strcmp(szPath, s_aTests[i].pszOut) != 0)
+            RTTestFailed(hTest, "sub-test #%u: got '%s', expected '%s' (style %#x)",
+                         i, szPath, s_aTests[i].pszOut, s_aTests[i].fFlags);
     }
 }
@@ -983 +1013 @@
     testParserAndSplitter(hTest);
     testParentLength(hTest);
+    testPurgeFilename(hTest);
 
     /*