Changeset 92845 in vbox for trunk/src/VBox

Timestamp:

Dec 9, 2021 11:39:01 AM (3 years ago)

Author:

vboxsync

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

148773

Message:

Additions: Shared Clipboard: fix HTML content conversion, bugref:10160.

This commit applies a fix for HTML content handling for the case when
data is being copied from X11 host and pasted into Windows guest. We
now make sure that clipboard data is NULL-terminated string. If HTML
data is not wrapped into CF_HTML format, we now do so.

Location:

trunk/src/VBox

Files:

• Additions/WINNT/VBoxTray/VBoxClipboard.cpp (modified) (1 diff)
• GuestHost/SharedClipboard/clipboard-win.cpp (modified) (3 diffs)
• GuestHost/SharedClipboard/clipboard-x11.cpp (modified) (1 diff)

trunk/src/VBox/Additions/WINNT/VBoxTray/VBoxClipboard.cpp

@@ -438 +438 @@
                                     }
                                 }
+                                else if (fFormat == VBOX_SHCL_FMT_HTML)
+                                {
+                                    /* Wrap content into CF_HTML clipboard format if needed. */
+                                    if (!SharedClipboardWinIsCFHTML((const char *)pMem))
+                                    {
+                                        char *pszWrapped = NULL;
+                                        uint32_t cbWrapped = 0;
+                                        rc =  SharedClipboardWinConvertMIMEToCFHTML((const char *)pMem, cb, &pszWrapped, &cbWrapped);
+                                        if (RT_SUCCESS(rc))
+                                        {
+                                            if (GlobalUnlock(hMem) == 0)
+                                            {
+                                                hMem = GlobalReAlloc(hMem, cbWrapped, 0);
+                                                if (hMem)
+                                                {
+                                                    pMem = GlobalLock(hMem);
+                                                    if (pMem)
+                                                    {
+                                                        /* Copy wrapped content back to memory passed to system clipboard. */
+                                                        memcpy(pMem, pszWrapped, cbWrapped);
+                                                        cb = cbWrapped;
+                                                    }
+                                                    else
+                                                    {
+                                                        LogRel(("Shared Clipboard: Cannot lock memory, "
+                                                                "HTML clipboard data won't be converted into CF_HTML clipboard format\n"));
+                                                        GlobalFree(hMem);
+                                                        hMem = NULL;
+                                                    }
+                                                }
+                                                else
+                                                    LogRel(("Shared Clipboard: Cannot re-allocate memory, "
+                                                            "HTML clipboard data won't be converted into CF_HTML clipboard format\n"));
+                                            }
+                                            else
+                                                LogRel(("Shared Clipboard: Cannot unlock memory, "
+                                                        "HTML clipboard data won't be converted into CF_HTML clipboard format\n"));
+
+                                            RTMemFree(pszWrapped);
+                                        }
+                                        else
+                                            LogRel(("Shared Clipboard: Cannot convert HTML clipboard data into CF_HTML clipboard format, rc=%Rrc\n", rc));
+                                    }
+                                }
                             }
 

trunk/src/VBox/GuestHost/SharedClipboard/clipboard-win.cpp

@@ -574 +574 @@
  *   EndFragment   = Header length + fragment length - 38(ending length)
  *
+ * @return  IPRT status code.
  * @param   pszSource   Source buffer that contains utf-16 string in mime html format
  * @param   cb          Size of source buffer in bytes
@@ -585 +586 @@
 int SharedClipboardWinConvertMIMEToCFHTML(const char *pszSource, size_t cb, char **ppszOutput, uint32_t *pcbOutput)
 {
+    /**
+     * CF_HTML format description (see also, https://docs.microsoft.com/en-us/previous-versions/
+     * windows/internet-explorer/ie-developer/platform-apis/aa767917(v=vs.85)?redirectedfrom=MSDN):
+     *
+     *   @StartHtml - pos before <html>
+     *   @EndHtml - whole size of text excluding ending zero char (pos after </html>)
+     *   @StartFragment - pos after <!--StartFragment-->
+     *   @EndFragment - pos before <!--EndFragment-->
+     *   @note: all values includes CR\LF inserted into text
+    */
+
+#define VBOX_CLIP_CF_HTML_HEADER \
+    "Version:1.0\r\n" \
+    "StartHTML:000000101\r\n" \
+    "EndHTML:%0000009u\r\n" \
+    "StartFragment:000000137\r\n" \
+    "EndFragment:%0000009u\r\n" \
+    "<html>\r\n" \
+    "<body>\r\n" \
+    "<!--StartFragment-->"
+
+#define VBOX_CLIP_CF_HTML_FOOTER \
+    "<!--EndFragment-->\r\n" \
+    "</body>\r\n" \
+    "</html>\r\n"
+
     Assert(ppszOutput);
     Assert(pcbOutput);
@@ -590 +617 @@
     Assert(cb);
 
-    /* construct CF_HTML formatted string */
-    char *pszResult = NULL;
-    size_t cchFragment;
-    int rc = RTStrNLenEx(pszSource, cb, &cchFragment);
-    if (!RT_SUCCESS(rc))
-    {
-        LogRelFlowFunc(("Error: invalid source fragment. rc = %Rrc\n"));
-        return VERR_INVALID_PARAMETER;
-    }
-
-    /*
-    @StartHtml - pos before <html>
-    @EndHtml - whole size of text excluding ending zero char
-    @StartFragment - pos after <!--StartFragment-->
-    @EndFragment - pos before <!--EndFragment-->
-    @note: all values includes CR\LF inserted into text
-    Calculations:
-    Header length = format Length + (3*6('digits')) - 2('%s') = format length + 16 (control value - 183)
-    EndHtml  = Header length + fragment length
-    StartHtml = 105(constant)
-    StartFragment = 143(constant)
-    EndFragment  = Header length + fragment length - 40(ending length)
-    */
-    static const char s_szFormatSample[] =
-    /*   0:   */ "Version:1.0\r\n"
-    /*  13:   */ "StartHTML:000000101\r\n"
-    /*  34:   */ "EndHTML:%0000009u\r\n" // END HTML = Header length + fragment length
-    /*  53:   */ "StartFragment:000000137\r\n"
-    /*  78:   */ "EndFragment:%0000009u\r\n"
-    /* 101:   */ "<html>\r\n"
-    /* 109:   */ "<body>\r\n"
-    /* 117:   */ "<!--StartFragment-->"
-    /* 137:   */ "%s"
-    /* 137+2: */ "<!--EndFragment-->\r\n"
-    /* 157+2: */ "</body>\r\n"
-    /* 166+2: */ "</html>\r\n";
-    /* 175+2: */
-    AssertCompile(sizeof(s_szFormatSample) == 175 + 2 + 1);
-
-    /* calculate parameters of CF_HTML header */
-    size_t cchHeader      = sizeof(s_szFormatSample) - 1;
-    size_t offEndHtml     = cchHeader + cchFragment;
-    size_t offEndFragment = cchHeader + cchFragment - 38; /* 175-137 = 38 */
-    pszResult = (char *)RTMemAlloc(offEndHtml + 1);
+    size_t  cchFragment;
+    int     rc;
+
+    char    *szFormat       = VBOX_CLIP_CF_HTML_HEADER "%s" VBOX_CLIP_CF_HTML_FOOTER;
+    size_t  offEndFragment  = sizeof(VBOX_CLIP_CF_HTML_HEADER) - 2 /* '%' chars */ + cb;
+    size_t  offEndHTML      = offEndFragment + sizeof(VBOX_CLIP_CF_HTML_FOOTER);
+    char    *pszResult      = NULL;
+    size_t  cbResult        = sizeof(VBOX_CLIP_CF_HTML_HEADER) + cb + sizeof(VBOX_CLIP_CF_HTML_FOOTER);
+
+    /* Make sure input string is '\0' terminated. */
+    rc = RTStrNLenEx(pszSource, cb, &cchFragment);
+    if (RT_FAILURE(rc))
+    {
+        LogRelFlowFunc(("Error: invalid source fragment. rc = %Rrc\n", rc));
+        return rc;
+    }
+
+    pszResult = (char *)RTMemAllocZ(cbResult);
     if (pszResult == NULL)
     {
-        LogRelFlowFunc(("Error: Cannot allocate memory for result buffer. rc = %Rrc\n"));
+        LogRel(("Shared Clipboard: cannot allocate memory for HTML clipboard conversion, rc = %Rrc\n", rc));
         return VERR_NO_MEMORY;
     }
 
     /* format result CF_HTML string */
-    size_t cchFormatted = RTStrPrintf(pszResult, offEndHtml + 1,
-                                      s_szFormatSample, offEndHtml, offEndFragment, pszSource);
-    Assert(offEndHtml == cchFormatted); NOREF(cchFormatted);
-
-#ifdef VBOX_STRICT
-    /* Control calculations. check consistency.*/
-    static const char s_szStartFragment[] = "<!--StartFragment-->";
-    static const char s_szEndFragment[] = "<!--EndFragment-->";
-
-    /* check 'StartFragment:' value */
-    const char *pszRealStartFragment = RTStrStr(pszResult, s_szStartFragment);
-    Assert(&pszRealStartFragment[sizeof(s_szStartFragment) - 1] - pszResult == 137);
-
-    /* check 'EndFragment:' value */
-    const char *pszRealEndFragment = RTStrStr(pszResult, s_szEndFragment);
-    Assert((size_t)(pszRealEndFragment - pszResult) == offEndFragment);
-#endif
-
-    *ppszOutput = pszResult;
-    *pcbOutput = (uint32_t)cchFormatted + 1;
-    Assert(*pcbOutput == cchFormatted + 1);
-
-    return VINF_SUCCESS;
+    size_t cchFormatted = RTStrPrintf2(pszResult, cbResult, szFormat, offEndHTML, offEndFragment, pszSource);
+    if (cchFormatted > 0)
+    {
+        *ppszOutput = pszResult;
+        *pcbOutput = (uint32_t)cchFormatted + 1;
+        return VINF_SUCCESS;
+    }
+    else
+        LogRel(("Shared Clipboard: cannot format CF_HTML content\n"));
+
+    return VERR_INVALID_PARAMETER;
 }
 

trunk/src/VBox/GuestHost/SharedClipboard/clipboard-x11.cpp

@@ -2037 +2037 @@
                 else /* Raw data. */
                 {
-                   pvDst = RTMemAlloc(cbSrc);
-                   if(pvDst)
-                   {
-                        memcpy(pvDst, pvSrc, cbSrc);
-                        cbDst = cbSrc;
-                   }
-                   else
-                   {
-                        rc = VERR_NO_MEMORY;
-                        break;
-                   }
+                    pvDst = RTMemAllocZ(cbSrc + 1 /* '\0' */);
+                    if(pvDst)
+                    {
+                         memcpy(pvDst, pvSrc, cbSrc);
+                         cbDst = cbSrc + 1 /* '\0' */;
+                    }
+                    else
+                    {
+                         rc = VERR_NO_MEMORY;
+                         break;
+                    }
                 }