Changeset 87032 in vbox for trunk/src/VBox/Runtime/tools

Timestamp:

Dec 2, 2020 4:33:29 PM (4 years ago)

Author:

vboxsync

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

141673

Message:

Shared Clipboard/Transfers: Added initial directory listing support via WebDAV (needs RTHTTP_WITH_WEBDAV, experimental). bugref:9874

File:

• trunk/src/VBox/Runtime/tools/RTHttpServer.cpp (modified) (16 diffs)

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

@@ -49 +49 @@
 #include <iprt/getopt.h>
 #include <iprt/initterm.h>
+#define LOG_GROUP RTLOGGROUP_HTTP
+#include <iprt/log.h>
 #include <iprt/mem.h>
 #include <iprt/message.h>
@@ -286 +288 @@
                     continue;
             }
-            else if (rc != VERR_NO_MORE_FILES)
+            else
                 break;
         }
@@ -309 +311 @@
 }
 
-static int dirEntryWrite(char *pszBuf, size_t cbBuf,
-                         const char *pszEntry, const PRTFSOBJINFO pObjInfo, size_t *pcbWritten)
-{
+#ifdef RTHTTP_WITH_WEBDAV
+static int dirEntryWriteDAV(char *pszBuf, size_t cbBuf,
+                            const char *pszEntry, const PRTFSOBJINFO pObjInfo, size_t *pcbWritten)
+{
+    char szBirthTime[32];
+    if (RTTimeSpecToString(&pObjInfo->BirthTime, szBirthTime, sizeof(szBirthTime)) == NULL)
+        return VERR_BUFFER_UNDERFLOW;
+
     char szModTime[32];
     if (RTTimeSpecToString(&pObjInfo->ModificationTime, szModTime, sizeof(szModTime)) == NULL)
@@ -318 +325 @@
     int rc = VINF_SUCCESS;
 
-    ssize_t cch = RTStrPrintf2(pszBuf, cbBuf, "201: %s %RU64 %s %s\r\n",
-                               pszEntry, pObjInfo->cbObject, szModTime,
-                               /** @todo Very crude; only files and directories are supported for now. */
-                               RTFS_IS_FILE(pObjInfo->Attr.fMode) ? "FILE" : "DIRECTORY");
+    /**
+     * !!! HACK ALERT !!!
+     ** @todo Build up and use a real XML DOM here. Works with Gnome / Gvfs-compatible apps though.
+     */
+    ssize_t cch = RTStrPrintf(pszBuf, cbBuf,
+"<d:response>"
+"<d:href>%s</d:href>"
+"<d:propstat>"
+"<d:status>HTTP/1.1 200 OK</d:status>"
+"<d:prop>"
+"<d:displayname>%s</d:displayname>"
+"<d:getcontentlength>%RU64</d:getcontentlength>"
+"<d:getcontenttype>%s</d:getcontenttype>"
+"<d:creationdate>%s</d:creationdate>"
+"<d:getlastmodified>%s</d:getlastmodified>"
+"<d:getetag/>"
+"<d:resourcetype><d:collection/></d:resourcetype>"
+"</d:prop>"
+"</d:propstat>"
+"</d:response>",
+                        pszEntry, pszEntry, pObjInfo->cbObject, "application/octet-stream", szBirthTime, szModTime);
+
     if (cch <= 0)
         rc = VERR_BUFFER_OVERFLOW;
+
+    *pcbWritten = cch;
+
+    return rc;
+}
+#endif /* RTHTTP_WITH_WEBDAV */
+
+static int dirEntryWrite(RTHTTPMETHOD enmMethod, char *pszBuf, size_t cbBuf,
+                         const char *pszEntry, const PRTFSOBJINFO pObjInfo, size_t *pcbWritten)
+{
+    char szModTime[32];
+    if (RTTimeSpecToString(&pObjInfo->ModificationTime, szModTime, sizeof(szModTime)) == NULL)
+        return VERR_BUFFER_UNDERFLOW;
+
+    int rc = VINF_SUCCESS;
+
+    ssize_t cch = 0;
+
+    if (enmMethod == RTHTTPMETHOD_GET)
+    {
+        cch = RTStrPrintf2(pszBuf, cbBuf, "201: %s %RU64 %s %s\r\n",
+                           pszEntry, pObjInfo->cbObject, szModTime,
+                           /** @todo Very crude; only files and directories are supported for now. */
+                           RTFS_IS_FILE(pObjInfo->Attr.fMode) ? "FILE" : "DIRECTORY");
+        if (cch <= 0)
+            rc = VERR_BUFFER_OVERFLOW;
+    }
+#ifdef RTHTTP_WITH_WEBDAV
+    else if (enmMethod == RTHTTPMETHOD_PROPFIND)
+    {
+        char szBuf[RTPATH_MAX + _4K]; /** @todo Just a rough guesstimate. */
+        rc = dirEntryWriteDAV(szBuf, sizeof(szBuf), pszEntry, pObjInfo, (size_t *)&cch);
+        if (RT_SUCCESS(rc))
+            rc = RTStrCat(pszBuf, cbBuf, szBuf);
+        AssertRC(rc);
+    }
+#endif /* RTHTTP_WITH_WEBDAV */
+    else
+        rc = VERR_NOT_SUPPORTED;
 
     if (RT_SUCCESS(rc))
@@ -361 +425 @@
 }
 
-DECLCALLBACK(int) onOpen(PRTHTTPCALLBACKDATA pData, const char *pszUrl, void **ppvHandle)
+DECLCALLBACK(int) onOpen(PRTHTTPCALLBACKDATA pData, PRTHTTPSERVERREQ pReq, void **ppvHandle)
 {
     PHTTPSERVERDATA pThis = (PHTTPSERVERDATA)pData->pvUser;
@@ -367 +431 @@
 
     char *pszPathAbs = NULL;
-    int rc = pathResolve(pThis, pszUrl, &pszPathAbs);
+    int rc = pathResolve(pThis, pReq->pszUrl, &pszPathAbs);
     if (RT_SUCCESS(rc))
     {
@@ -395 +459 @@
         RTStrFree(pszPathAbs);
     }
+
+    LogFlowFuncLeaveRC(rc);
     return rc;
 }
@@ -404 +470 @@
 
     AssertReturn(*(uint64_t *)pvHandle == 42 /** @todo Fudge. */, VERR_NOT_FOUND);
+
+    int rc;
 
     if (RTFS_IS_DIRECTORY(pThis->fMode))
@@ -416 +484 @@
         *pcbRead = cbToCopy;
 
-        return VINF_SUCCESS;
+        rc = VINF_SUCCESS;
     }
     else if (RTFS_IS_FILE(pThis->fMode))
-        return RTFileRead(pThis->h.File, pvBuf, cbBuf, pcbRead);
-
-    return VERR_NOT_IMPLEMENTED; /* Never reached. */
+    {
+        rc = RTFileRead(pThis->h.File, pvBuf, cbBuf, pcbRead);
+    }
+    else
+        rc = VERR_NOT_SUPPORTED;
+
+    LogFlowFuncLeaveRC(rc);
+    return rc;
 }
 
@@ -445 +518 @@
     pvHandle = NULL;
 
+    LogFlowFuncLeaveRC(rc);
     return rc;
 }
 
 DECLCALLBACK(int) onQueryInfo(PRTHTTPCALLBACKDATA pData,
-                              const char *pszUrl, PRTFSOBJINFO pObjInfo, char **ppszMIMEHint)
+                              PRTHTTPSERVERREQ pReq, PRTFSOBJINFO pObjInfo, char **ppszMIMEHint)
 {
     PHTTPSERVERDATA pThis = (PHTTPSERVERDATA)pData->pvUser;
     Assert(pData->cbUser == sizeof(HTTPSERVERDATA));
 
+    /** !!!! WARNING !!!
+     **
+     ** Not production-ready code below!
+     ** @todo Use something like bodyAdd() instead of the RTStrPrintf2() hacks.
+     **
+     ** !!!! WARNING !!! */
+
     char *pszPathAbs = NULL;
-    int rc = pathResolve(pThis, pszUrl, &pszPathAbs);
+    int rc = pathResolve(pThis, pReq->pszUrl, &pszPathAbs);
     if (RT_SUCCESS(rc))
     {
@@ -471 +552 @@
                 {
                     RTHttpServerResponseDestroy(pResp);
-                    RTHttpServerResponseInitEx(pResp, _4K);
+                    RTHttpServerResponseInitEx(pResp, _64K); /** @todo Make this more dynamic. */
+
+                    char  *pszBody    = (char *)pResp->pvBody;
+                    size_t cbBodyLeft = pResp->cbBodyAlloc;
 
                     /*
                      * Write body header.
                      */
-                    ssize_t cch = RTStrPrintf2((char *)pResp->pvBody, pResp->cbBodyAlloc,
-                                               "300: file://%s\r\n"
-                                               "200: filename content-length last-modified file-type\r\n",
-                                               pszUrl);
-                    RT_NOREF(cch);
-                    Assert(cch);
-
-                    pResp->cbBodyUsed = strlen((char *)pResp->pvBody);
-
+                    if (pReq->enmMethod == RTHTTPMETHOD_GET)
+                    {
+                        ssize_t cch = RTStrPrintf2(pszBody, cbBodyLeft,
+                                                   "300: file://%s\r\n"
+                                                   "200: filename content-length last-modified file-type\r\n",
+                                                   pReq->pszUrl);
+                        Assert(cch);
+                        pszBody    += cch;
+                        cbBodyLeft -= cch;
+                    }
+#ifdef RTHTTP_WITH_WEBDAV
+                    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;
+                    }
+#endif /* RTHTTP_WITH_WEBDAV */
                     /*
                      * Write body entries.
@@ -492 +596 @@
                     while (RT_SUCCESS(rc = dirRead(hVfsDir, &pszEntry, &fsObjInfo)))
                     {
-                        char *pszBody = (char *)pResp->pvBody;
-
-                        size_t cbWritten;
-                        rc = dirEntryWrite(&pszBody[pResp->cbBodyUsed], pResp->cbBodyAlloc - pResp->cbBodyUsed, pszEntry, &fsObjInfo, &cbWritten);
+                        size_t cbWritten = 0;
+                        rc = dirEntryWrite(pReq->enmMethod, pszBody, cbBodyLeft, pszEntry, &fsObjInfo, &cbWritten);
                         if (rc == VERR_BUFFER_OVERFLOW)
                         {
-                            pResp->cbBodyAlloc *= 2; /** @todo Improve this. */
+                            pResp->cbBodyAlloc += _4K; /** @todo Improve this. */
                             pResp->pvBody       = RTMemRealloc(pResp->pvBody, pResp->cbBodyAlloc);
                             AssertPtrBreakStmt(pResp->pvBody, rc = VERR_NO_MEMORY);
 
                             pszBody = (char *)pResp->pvBody;
-
-                            rc = dirEntryWrite(&pszBody[pResp->cbBodyUsed], pResp->cbBodyAlloc - pResp->cbBodyUsed, pszEntry, &fsObjInfo, &cbWritten);
+                            cbBodyLeft += _4K; /** @todo Ditto. */
+
+                            rc = dirEntryWrite(pReq->enmMethod, pszBody, cbBodyLeft, pszEntry, &fsObjInfo, &cbWritten);
                         }
 
-                        if (RT_SUCCESS(rc))
-                            pResp->cbBodyUsed += cbWritten;
+                        if (   RT_SUCCESS(rc)
+                            && cbWritten)
+                        {
+                            pszBody    += cbWritten;
+                            Assert(cbBodyLeft > cbWritten);
+                            cbBodyLeft -= cbWritten;
+                        }
 
                         RTStrFree(pszEntry);
@@ -521 +629 @@
                     dirClose(hVfsDir);
 
+                    /*
+                     * Write footers, if any.
+                     */
                     if (RT_SUCCESS(rc))
                     {
-                        rc = RTStrAPrintf(ppszMIMEHint, "text/plain");
-                        if (RT_SUCCESS(rc))
-                            pObjInfo->cbObject = pResp->cbBodyUsed;
+                        if (pReq->enmMethod == RTHTTPMETHOD_GET)
+                        {
+                            if (ppszMIMEHint)
+                                rc = RTStrAPrintf(ppszMIMEHint, "text/plain");
+                        }
+#ifdef RTHTTP_WITH_WEBDAV
+                        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);
+                        }
+#endif /* RTHTTP_WITH_WEBDAV */
+
+                        pResp->cbBodyUsed = strlen((char *)pResp->pvBody);
+
+                        pObjInfo->cbObject = pResp->cbBodyUsed;
                     }
                 }
@@ -541 +670 @@
                 }
             }
+            else
+                rc = VERR_NOT_SUPPORTED;
         }
 
@@ -546 +677 @@
     }
 
+    LogFlowFuncLeaveRC(rc);
     return rc;
+}
+
+DECLCALLBACK(int) onDestroy(PRTHTTPCALLBACKDATA pData)
+{
+    PHTTPSERVERDATA pThis = (PHTTPSERVERDATA)pData->pvUser;
+    Assert(pData->cbUser == sizeof(HTTPSERVERDATA));
+
+    RTHttpServerResponseDestroy(&pThis->Resp);
+
+    return VINF_SUCCESS;
 }
 
@@ -650 +792 @@
         Callbacks.pfnClose         = onClose;
         Callbacks.pfnQueryInfo     = onQueryInfo;
+        Callbacks.pfnDestroy       = onDestroy;
 
         g_HttpServerData.h.File = NIL_RTFILE;