Changeset 97276 in vbox for trunk/src/VBox/Main

Timestamp:

Oct 24, 2022 10:23:55 AM (2 years ago)

Author:

vboxsync

Message:

Main/Guest Control: Added new guestControl::GuestPath class which contains the (static) Translate() function to translate paths from/to host/guests. Also added a new testcase for that function. bugref:10286

Location:

trunk/src/VBox/Main

Files:

• include/GuestCtrlImplPrivate.h (modified) (1 diff)
• src-client/GuestCtrlPrivate.cpp (modified) (2 diffs)
• testcase/Makefile.kmk (modified) (3 diffs)
• testcase/tstGuestCtrlPaths.cpp (added)

trunk/src/VBox/Main/include/GuestCtrlImplPrivate.h

@@ -1385 +1385 @@
     /** @} */
 };
+
+/**
+ * Class for handling guest / host path functions.
+ */
+class GuestPath
+{
+private:
+
+    /**
+     * Default constructor.
+     *
+     * Not directly instantiable (yet).
+     */
+    GuestPath(void) { }
+
+public:
+
+    /** @name Static helper functions.
+     * @{ */
+    static int Translate(Utf8Str &strPath, PathStyle_T enmSrcPathStyle, PathStyle_T enmDstPathStyle);
+    /** @}  */
+};
 #endif /* !MAIN_INCLUDED_GuestCtrlImplPrivate_h */
 

trunk/src/VBox/Main/src-client/GuestCtrlPrivate.cpp

@@ -47 +47 @@
 #endif
 #include <iprt/fs.h>
+#include <iprt/path.h>
 #include <iprt/rand.h>
 #include <iprt/time.h>
@@ -1663 +1664 @@
 }
 
+
+//////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////
+// GuestPath
+//////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////
+
+/**
+ * Translates a path from a specific path style into another.
+ *
+ * @returns VBox status code.
+ * @retval  VERR_NOT_SUPPORTED if a conversion is not supported.
+ * @retval  VERR_NOT_IMPLEMENTED if path style conversion is not implemented yet.
+ * @param   strPath             Path to translate. Will contain the translated path on success. UTF-8 only.
+ * @param   enmSrcPathStyle     Source path style \a strPath is expected in.
+ * @param   enmDstPathStyle     Destination path style to convert to.
+ *
+ * @note    This does NOT remove any trailing slashes and/or perform file system lookups!
+ */
+/* static */
+int GuestPath::Translate(Utf8Str &strPath, PathStyle_T enmSrcPathStyle, PathStyle_T enmDstPathStyle)
+{
+    if (strPath.isEmpty())
+        return VINF_SUCCESS;
+
+    AssertReturn(RTStrIsValidEncoding(strPath.c_str()), VERR_INVALID_PARAMETER);
+
+#ifdef DEBUG
+    Utf8Str const strPathOrg = strPath; /* Make a backup so that we later can log stuff properly. */
+#endif
+
+    int vrc = VINF_SUCCESS;
+
+    Utf8Str strTranslated;
+
+    if (   enmSrcPathStyle == PathStyle_DOS
+        && enmDstPathStyle == PathStyle_UNIX)
+    {
+        strTranslated = RTPathChangeToUnixSlashes(strPath.mutableRaw(), true /* fForce */);
+    }
+    else if (   enmSrcPathStyle == PathStyle_UNIX
+             && enmDstPathStyle == PathStyle_DOS)
+    {
+        /** @todo Check for quoted (sub) strings, e.g. '/foo/bar/\ baz' vs . '/foo/bar/"\ baz"'? */
+
+        const char  *psz = strPath.c_str();
+        size_t const cch = strPath.length();
+        size_t       off = 0;
+        while (off < cch)
+        {
+            /* Most likely cases first. */
+            if (psz[off] == '/') /* Just transform slashes. */
+                strTranslated += '\\';
+            /*
+             * Do a mapping of "\", which marks an escape sequence for paths on UNIX-y OSes to DOS-based OSes (like Windows),
+             * however, on DOS "\" is a path separator.
+             *
+             * See @bugref{21095}.
+             */
+            else if (psz[off] == '\\')
+            {
+                /* "\ " is valid on UNIX-system and mark a space in a path component. */
+                if (   off + 1      <= cch
+                    && psz[off + 1] == ' ')
+                {
+                    strTranslated += ' ';
+                    off++; /* Skip actual escape sequence char (space in this case). */
+                }
+                else
+                {
+                    /* Every other escape sequence is not supported and would lead to different paths anyway, so bail out here. */
+                    vrc = VERR_NOT_SUPPORTED;
+                    break;
+                }
+            }
+            else /* Just add it unmodified. */
+                strTranslated += psz[off];
+            off++;
+        }
+    }
+    else if (enmSrcPathStyle == enmDstPathStyle)
+    {
+        strTranslated = strPath;
+    }
+    else
+        AssertFailedReturn(VERR_NOT_IMPLEMENTED);
+
+    if (RT_FAILURE(vrc))
+        return vrc;
+
+    /* Cleanup. */
+    const char  *psz = strTranslated.mutableRaw();
+    size_t const cch = strTranslated.length();
+    size_t       off = 0;
+    while (off < cch)
+    {
+        if (off + 1 > cch)
+            break;
+        /* Remove double slashes. */
+        if (   psz[off]     == '\\'
+            && psz[off + 1] == '\\')
+        {
+            strTranslated.erase(off + 1, 1);
+            off++;
+        }
+        if (   psz[off]     == '/'
+            && psz[off + 1] == '/')
+        {
+            strTranslated.erase(off + 1, 1);
+            off++;
+        }
+        off++;
+    }
+
+    /* Note: Do not trim() paths here, as technically it's possible to create paths with trailing spaces. */
+
+    strTranslated.jolt();
+
+    if (RT_SUCCESS(vrc))
+        strPath = strTranslated;
+
+#ifdef DEBUG
+    LogRel2(("Guest Control: Mapping '%s' -> '%s', vrc=%Rrc\n", strPathOrg.c_str(), strPath.c_str(), vrc));
+#endif
+    return vrc;
+}
+

trunk/src/VBox/Main/testcase/Makefile.kmk

@@ -43 +43 @@
         $(if $(VBOX_WITH_XPCOM),tstVBoxAPIXPCOM,tstVBoxAPIWin msiDarwinDescriptorDecoder) \
         $(if $(VBOX_WITH_RESOURCE_USAGE_API),tstCollector,) \
+        $(if $(VBOX_WITH_GUEST_CONTROL),tstGuestCtrlContextID,) \
         $(if $(VBOX_WITH_GUEST_CONTROL),tstGuestCtrlParseBuffer,) \
-        $(if $(VBOX_WITH_GUEST_CONTROL),tstGuestCtrlContextID,) \
+        $(if $(VBOX_WITH_GUEST_CONTROL),tstGuestCtrlPaths,) \
         tstMediumLock \
         tstBstr \
@@ -207 +208 @@
 
 #
+# tstGuestCtrlContextID
+#
+tstGuestCtrlContextID_TEMPLATE = VBOXMAINCLIENTTSTEXE
+tstGuestCtrlContextID_INTERMEDIATES   = $(VBOX_MAIN_APIWRAPPER_GEN_HDRS)
+tstGuestCtrlContextID_DEFS    += VBOX_WITH_HGCM VBOX_WITH_GUEST_CONTROL VBOX_GUESTCTRL_TEST_CASE
+tstGuestCtrlContextID_SOURCES  = \
+        tstGuestCtrlContextID.cpp \
+        ../src-client/GuestCtrlPrivate.cpp
+tstGuestCtrlContextID_INCS     = ../include \
+     $(VBOX_MAIN_APIWRAPPER_INCS)
+
+
+#
 # tstGuestCtrlParseBuffer
 #
@@ -220 +234 @@
 
 #
-# tstGuestCtrlContextID
-#
-tstGuestCtrlContextID_TEMPLATE = VBOXMAINCLIENTTSTEXE
-tstGuestCtrlContextID_INTERMEDIATES   = $(VBOX_MAIN_APIWRAPPER_GEN_HDRS)
-tstGuestCtrlContextID_DEFS    += VBOX_WITH_HGCM VBOX_WITH_GUEST_CONTROL VBOX_GUESTCTRL_TEST_CASE
-tstGuestCtrlContextID_SOURCES  = \
-        tstGuestCtrlContextID.cpp \
+# tstGuestCtrlPaths
+#
+tstGuestCtrlPaths_TEMPLATE       = VBOXMAINCLIENTTSTEXE
+tstGuestCtrlPaths_INTERMEDIATES  = $(VBOX_MAIN_APIWRAPPER_GEN_HDRS)
+tstGuestCtrlPaths_DEFS          += VBOX_WITH_HGCM VBOX_WITH_GUEST_CONTROL VBOX_GUESTCTRL_TEST_CASE
+tstGuestCtrlPaths_SOURCES        = \
+        tstGuestCtrlPaths.cpp \
         ../src-client/GuestCtrlPrivate.cpp
-tstGuestCtrlContextID_INCS     = ../include \
-     $(VBOX_MAIN_APIWRAPPER_INCS)
+tstGuestCtrlPaths_INCS           = ../include \
+    $(VBOX_MAIN_APIWRAPPER_INCS)
+
+if 0 # Enable this if you want automatic runs after compilation.
+ $$(tstGuestCtrlPaths_0_OUTDIR)/tstGuestCtrlPaths.run: $$(tstGuestCtrlPaths_1_STAGE_TARGET)
+        export VBOX_LOG_DEST=nofile; $(tstGuestCtrlPaths_1_STAGE_TARGET) quiet
+        $(QUIET)$(APPEND) -t "$@" "done"
+ OTHERS += $(tstGuestCtrlPaths_0_OUTDIR)/tstGuestCtrlPaths.run
+endif