Changeset 40179 in vbox for trunk/src/VBox/Main/src-server/VirtualBoxImpl.cpp

Timestamp:

Feb 20, 2012 3:03:06 PM (13 years ago)

Author:

vboxsync

Message:

Main/ComposeMachineFilename: move sanitising code into separate function and add a test.

File:

• trunk/src/VBox/Main/src-server/VirtualBoxImpl.cpp (modified) (3 diffs)

trunk/src/VBox/Main/src-server/VirtualBoxImpl.cpp

@@ -1300 +1300 @@
 /////////////////////////////////////////////////////////////////////////////
 
+/* Helper for VirtualBox::ComposeMachineFilename */
+static void sanitiseMachineFilename(Utf8Str &aName);
+
 STDMETHODIMP VirtualBox::ComposeMachineFilename(IN_BSTR aName,
                                                 IN_BSTR aBaseFolder,
@@ -1324 +1327 @@
     Utf8Str strBase = aBaseFolder;
     Utf8Str strName = aName;
+    sanitiseMachineFilename(strName);
+
+    if (strBase.isEmpty())
+        /* we use the non-full folder value below to keep the path relative */
+        getDefaultMachineFolder(strBase);
+
+    calculateFullPath(strBase, strBase);
+
+    Bstr bstrSettingsFile = BstrFmt("%s%c%s%c%s.vbox",
+                                    strBase.c_str(),
+                                    RTPATH_DELIMITER,
+                                    strName.c_str(),
+                                    RTPATH_DELIMITER,
+                                    strName.c_str());
+
+#if 0  /* Try to get a unique name. */
+    for (unsigned i = 1; RTFileExists(bstrSettingsFile.c_str() && i < 100; ++i)
+        bstrSettingsFile = BstrFmt("%s%c%s%u%c%s%u.vbox",
+                                   strBase.c_str(),
+                                   RTPATH_DELIMITER,
+                                   strName.c_str(), i,
+                                   RTPATH_DELIMITER,
+                                   strName.c_str());
+#endif
+
+    bstrSettingsFile.detachTo(aFilename);
+
+    return S_OK;
+}
+
+/**
+ * Remove characters from a machine file name which can be problematic on
+ * particular systems.
+ * @param  strName  The file name to sanitise.
+ */
+void sanitiseMachineFilename(Utf8Str &strName)
+{
     /** Set of characters which should be safe for use in filenames: some basic
      * ASCII, Unicode from Latin-1 alphabetic to the end of Hangul.  We try to
@@ -1346 +1386 @@
     for (size_t i = strName.length() - 1; i && pszName[i] == ' '; --i)
        pszName[i] = '_';
-
-    if (strBase.isEmpty())
-        /* we use the non-full folder value below to keep the path relative */
-        getDefaultMachineFolder(strBase);
-
-    calculateFullPath(strBase, strBase);
-
-    Bstr bstrSettingsFile = BstrFmt("%s%c%s%c%s.vbox",
-                                    strBase.c_str(),
-                                    RTPATH_DELIMITER,
-                                    strName.c_str(),
-                                    RTPATH_DELIMITER,
-                                    strName.c_str());
-
-#if 0  /* Try to get a unique name. */
-    for (unsigned i = 1; RTFileExists(bstrSettingsFile.c_str() && i < 100; ++i)
-        bstrSettingsFile = BstrFmt("%s%c%s%u%c%s%u.vbox",
-                                   strBase.c_str(),
-                                   RTPATH_DELIMITER,
-                                   strName.c_str(), i,
-                                   RTPATH_DELIMITER,
-                                   strName.c_str());
+}
+
+/** Simple unit test/operation examples for sanitiseMachineFilename(). */
+static unsigned testSanitiseMachineFilename(void (*pfnPrintf)(const char *, ...))
+{
+    unsigned cErrors = 0;
+
+    /** Expected results of sanitising given file names. */
+    static struct
+    {
+        /** The test file name to be sanitised (Utf-8). */
+        const char *pcszIn;
+        /** The expected sanitised output (Utf-8). */
+        const char *pcszOutExpected;
+    } aTest[] =
+    {
+        { "OS/2 2.1", "OS_2 2.1" },
+        { "-!My VM!-", "__My VM_-" },
+        { "\xF0\x90\x8C\xB0", "____" },
+        { "  My VM  ", "__My VM__" },
+        { ".My VM.", "_My VM_" }
+    };
+    for (unsigned i = 0; i < RT_ELEMENTS(aTest); ++i)
+    {
+        Utf8Str str(aTest[i].pcszIn);
+        sanitiseMachineFilename(str);
+        if (str.compare(aTest[i].pcszOutExpected))
+        {
+            ++cErrors;
+            pfnPrintf("%s: line %d, expected %s, actual %s\n",
+                      __PRETTY_FUNCTION__, i, aTest[i].pcszOutExpected,
+                      str.c_str());
+        }
+    }
+    return cErrors;
+}
+
+#ifdef DEBUG
+/** @todo Proper testcase. */
+/** @todo Do we have a better method of doing init functions? */
+namespace
+{
+    class TestSanitiseMachineFilename
+    {
+    public:
+        TestSanitiseMachineFilename(void)
+        {
+            Assert(!testSanitiseMachineFilename(RTAssertMsg2));
+        }
+    };
+    TestSanitiseMachineFilename s_TestSanitiseMachineFilename;
+}
 #endif
-
-    bstrSettingsFile.detachTo(aFilename);
-
-    return S_OK;
-}
 
 /** @note Locks mSystemProperties object for reading. */