Changeset 87042 in vbox for trunk/src/VBox/Runtime

Timestamp:

Dec 4, 2020 12:10:36 PM (4 years ago)

Author:

vboxsync

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

141732

Message:

Shared Clipboard/Transfers: More cleanup / documentation work. bugref:9874

Location:

trunk/src/VBox/Runtime

Files:

• r3/http-server.cpp (modified) (5 diffs)
• tools/RTHttpServer.cpp (modified) (8 diffs)

trunk/src/VBox/Runtime/r3/http-server.cpp

@@ -328 +328 @@
 
 /**
+ * Initializes a HTTP body.
+ *
+ * @param   pBody               Body to initialize.
+ * @param   cbSize              Size of body (in bytes) to allocate. Optional and can be 0.
+ */
+static int rtHttpServerBodyInit(PRTHTTPBODY pBody, size_t cbSize)
+{
+    if (cbSize)
+    {
+        pBody->pvBody      = RTMemAlloc(cbSize);
+        AssertPtrReturn(pBody->pvBody, VERR_NO_MEMORY);
+        pBody->cbBodyAlloc = cbSize;
+    }
+    else
+    {
+        pBody->pvBody      = NULL;
+        pBody->cbBodyAlloc = 0;
+    }
+
+    pBody->cbBodyUsed = 0;
+    pBody->offBody    = 0;
+
+    return VINF_SUCCESS;
+}
+
+/**
+ * Destroys a HTTP body.
+ *
+ * @param   pBody               Body to destroy.
+ */
+static void rtHttpServerBodyDestroy(PRTHTTPBODY pBody)
+{
+    if (!pBody)
+        return;
+
+    if (pBody->pvBody)
+    {
+        Assert(pBody->cbBodyAlloc);
+
+        RTMemFree(pBody->pvBody);
+        pBody->pvBody = NULL;
+    }
+
+    pBody->cbBodyAlloc  = 0;
+    pBody->cbBodyUsed   = 0;
+    pBody->offBody      = 0;
+}
+
+/**
  * Allocates and initializes a new client request.
  *
@@ -341 +390 @@
     AssertRC(rc2);
 
+    rc2 = rtHttpServerBodyInit(&pReq->Body, 0 /* cbSize */);
+    AssertRC(rc2);
+
     return pReq;
 }
@@ -356 +408 @@
     RTHttpHeaderListDestroy(pReq->hHdrLst);
 
-    RTMemFree(pReq->pvBody);
-    pReq->pvBody = NULL;
+    rtHttpServerBodyDestroy(&pReq->Body);
 
     RTMemFree(pReq);
@@ -376 +427 @@
     AssertRCReturn(rc, rc);
 
-    if (cbBody)
-    {
-        pResp->pvBody      = RTMemAlloc(cbBody);
-        AssertPtrReturn(pResp->pvBody, VERR_NO_MEMORY);
-        pResp->cbBodyAlloc = cbBody;
-    }
-    else
-    {
-        pResp->cbBodyAlloc = 0;
-    }
-
-    pResp->cbBodyUsed = 0;
+    rc = rtHttpServerBodyInit(&pResp->Body, cbBody);
 
     return rc;
@@ -417 +457 @@
     RTHttpHeaderListDestroy(pResp->hHdrLst);
 
-    if (pResp->pvBody)
-    {
-        Assert(pResp->cbBodyAlloc);
-
-        RTMemFree(pResp->pvBody);
-        pResp->pvBody = NULL;
-    }
-
-    pResp->cbBodyAlloc = 0;
-    pResp->cbBodyUsed  = 0;
+    rtHttpServerBodyDestroy(&pResp->Body);
 }
 

trunk/src/VBox/Runtime/tools/RTHttpServer.cpp

@@ -328 +328 @@
      * !!! HACK ALERT !!!
      ** @todo Build up and use a real XML DOM here. Works with Gnome / Gvfs-compatible apps though.
+     * !!! HACK ALERT !!!
      */
     ssize_t cch = RTStrPrintf(pszBuf, cbBuf,
@@ -354 +355 @@
     return rc;
 }
+
+static int writeHeaderDAV(PRTHTTPSERVERREQ pReq, PRTFSOBJINFO pObjInfo, char *pszBuf, size_t cbBuf, size_t *pcbWritten)
+{
+    /**
+     * !!! HACK ALERT !!!
+     ** @todo Build up and use a real XML DOM here. Works with Gnome / Gvfs-compatible apps though.
+     * !!! HACK ALERT !!!
+     */
+
+    size_t cbWritten = 0;
+
+    ssize_t cch = RTStrPrintf2(pszBuf, cbBuf - cbWritten, "<?xml version=\"1.0\" encoding=\"utf-8\"?>\r\n");
+    AssertReturn(cch, VERR_BUFFER_UNDERFLOW);
+    pszBuf    += cch;
+    cbWritten += cch;
+
+    cch = RTStrPrintf2(pszBuf, cbBuf - cbWritten, "<d:multistatus xmlns:d=\"DAV:\">\r\n");
+    AssertReturn(cch, VERR_BUFFER_UNDERFLOW);
+    pszBuf    += cch;
+    cbWritten += cch;
+
+    int rc = dirEntryWriteDAV(pszBuf, cbBuf - cbWritten, pReq->pszUrl, pObjInfo, (size_t *)&cch);
+    AssertRC(rc);
+    pszBuf    += cch;
+    cbWritten += cch;
+
+    *pcbWritten += cbWritten;
+
+    return rc;
+}
+
+static int writeFooterDAV(PRTHTTPSERVERREQ pReq, char *pszBuf, size_t cbBuf, size_t *pcbWritten)
+{
+    RT_NOREF(pReq, pcbWritten);
+
+    /**
+     * !!! HACK ALERT !!!
+     ** @todo Build up and use a real XML DOM here. Works with Gnome / Gvfs-compatible apps though.
+     * !!! HACK ALERT !!!
+     */
+    ssize_t cch = RTStrPrintf2(pszBuf, cbBuf, "</d:multistatus>");
+    AssertReturn(cch, VERR_BUFFER_UNDERFLOW);
+    RT_NOREF(cch);
+
+    return VINF_SUCCESS;
+}
 #endif /* IPRT_HTTP_WITH_WEBDAV */
 
@@ -477 +524 @@
         PRTHTTPSERVERRESP pResp = &pThis->Resp;
 
-        const size_t cbToCopy = RT_MIN(cbBuf, pResp->cbBodyUsed);
-        memcpy(pvBuf, pResp->pvBody, cbToCopy);
-        Assert(pResp->cbBodyUsed >= cbToCopy);
-        pResp->cbBodyUsed -= cbToCopy;
+        const size_t cbToCopy = RT_MIN(cbBuf, pResp->Body.cbBodyUsed - pResp->Body.offBody);
+        memcpy(pvBuf, (uint8_t *)pResp->Body.pvBody + pResp->Body.offBody, cbToCopy);
+        Assert(pResp->Body.cbBodyUsed >= cbToCopy);
+        pResp->Body.offBody += cbToCopy;
 
         *pcbRead = cbToCopy;
@@ -545 +592 @@
             if (RTFS_IS_DIRECTORY(objInfo.Attr.fMode))
             {
-                PRTHTTPSERVERRESP pResp = &pThis->Resp;
+                PRTHTTPSERVERRESP pResp = &pThis->Resp; /* Only one request a time for now. */
 
                 RTVFSDIR hVfsDir;
@@ -554 +601 @@
                     RTHttpServerResponseInitEx(pResp, _64K); /** @todo Make this more dynamic. */
 
-                    char  *pszBody    = (char *)pResp->pvBody;
-                    size_t cbBodyLeft = pResp->cbBodyAlloc;
+                    char  *pszBody    = (char *)pResp->Body.pvBody;
+                    size_t cbBodyLeft = pResp->Body.cbBodyAlloc;
 
                     /*
@@ -573 +620 @@
                     else if (pReq->enmMethod == RTHTTPMETHOD_PROPFIND)
                     {
-                        ssize_t cch = RTStrPrintf2(pszBody, cbBodyLeft, "<?xml version=\"1.0\" encoding=\"utf-8\"?>\r\n");
-                        Assert(cch);
-                        pszBody    += cch;
-                        cbBodyLeft -= cch;
-
-                        cch = RTStrPrintf2(pszBody, cbBodyLeft, "<d:multistatus xmlns:d=\"DAV:\">\r\n");
-                        Assert(cch);
-                        pszBody    += cch;
-                        cbBodyLeft -= cch;
-
-                        rc = dirEntryWriteDAV(pszBody, cbBodyLeft, "/", &objInfo, (size_t *)&cch);
-                        AssertRC(rc);
-                        pszBody    += cch;
-                        cbBodyLeft -= cch;
+                        size_t cbWritten = 0;
+                        rc = writeHeaderDAV(pReq, &objInfo, pszBody, cbBodyLeft, &cbWritten);
+                        if (RT_SUCCESS(rc))
+                        {
+                            Assert(cbBodyLeft >= cbWritten);
+                            cbBodyLeft -= cbWritten;
+                        }
+
                     }
 #endif /* IPRT_HTTP_WITH_WEBDAV */
@@ -596 +637 @@
                     while (RT_SUCCESS(rc = dirRead(hVfsDir, &pszEntry, &fsObjInfo)))
                     {
+                        LogFlowFunc(("Entry '%s'\n", pszEntry));
+
                         size_t cbWritten = 0;
                         rc = dirEntryWrite(pReq->enmMethod, pszBody, cbBodyLeft, pszEntry, &fsObjInfo, &cbWritten);
                         if (rc == VERR_BUFFER_OVERFLOW)
                         {
-                            pResp->cbBodyAlloc += _4K; /** @todo Improve this. */
-                            pResp->pvBody       = RTMemRealloc(pResp->pvBody, pResp->cbBodyAlloc);
-                            AssertPtrBreakStmt(pResp->pvBody, rc = VERR_NO_MEMORY);
-
-                            pszBody = (char *)pResp->pvBody;
+                            pResp->Body.cbBodyAlloc += _4K; /** @todo Improve this. */
+                            pResp->Body.pvBody       = RTMemRealloc(pResp->Body.pvBody, pResp->Body.cbBodyAlloc);
+                            AssertPtrBreakStmt(pResp->Body.pvBody, rc = VERR_NO_MEMORY);
+
+                            pszBody = (char *)pResp->Body.pvBody;
                             cbBodyLeft += _4K; /** @todo Ditto. */
 
@@ -642 +685 @@
                         else if (pReq->enmMethod == RTHTTPMETHOD_PROPFIND)
                         {
-                            /**
-                             * !!! HACK ALERT !!!
-                             ** @todo Build up and use a real XML DOM here. Works with Gnome / Gvfs-compatible apps though.
-                             */
-                            ssize_t cch = RTStrPrintf2(pszBody, cbBodyLeft, "</d:multistatus>\r\n");
-                            Assert(cch);
-                            RT_NOREF(cch);
+                            rc  = writeFooterDAV(pReq, pszBody, cbBodyLeft, NULL);
                         }
 #endif /* IPRT_HTTP_WITH_WEBDAV */
 
-                        pResp->cbBodyUsed = strlen((char *)pResp->pvBody);
-
-                        pObjInfo->cbObject = pResp->cbBodyUsed;
+                        pResp->Body.cbBodyUsed = strlen((char *)pResp->Body.pvBody);
+
+                        pObjInfo->cbObject = pResp->Body.cbBodyUsed;
                     }
                 }