Changeset 74222 in vbox for trunk/src

Timestamp:

Sep 12, 2018 1:30:00 PM (6 years ago)

Author:

vboxsync

Message:

IPRT/http: Implemented header callbacks. bugref:9167

File:

• trunk/src/VBox/Runtime/generic/http-curl.cpp (modified) (9 diffs)

trunk/src/VBox/Runtime/generic/http-curl.cpp

@@ -218 +218 @@
     /** @name Upload callback
      * @{ */
-    /** Pointer to the download callback function, if anyn. */
+    /** Pointer to the download callback function, if any. */
     PFNRTHTTPUPLOADCALLBACK         pfnUploadCallback;
     /** The user argument for the upload callback function. */
@@ -228 +228 @@
     /** @} */
 
-    /** @name Download callback
+    /** @name Download callback.
      * @{ */
-    /** Pointer to the download callback function, if anyn. */
+    /** Pointer to the download callback function, if any. */
     PFNRTHTTPDOWNLOADCALLBACK       pfnDownloadCallback;
     /** The user argument for the download callback function. */
@@ -247 +247 @@
      * @{ */
     /** Download size hint set by the progress callback. */
-    uint64_t                       cbDownloadHint;
+    uint64_t                        cbDownloadHint;
     /** Callback called during download. */
-    PFNRTHTTPDOWNLDPROGRCALLBACK   pfnDownloadProgress;
+    PFNRTHTTPDOWNLDPROGRCALLBACK    pfnDownloadProgress;
     /** User pointer parameter for pfnDownloadProgress. */
     void                           *pvDownloadProgressUser;
     /** @} */
+
+    /** @name Header callback.
+     * @{ */
+    /** Pointer to the header callback function, if any. */
+    PFNRTHTTPHEADERCALLBACK         pfnHeaderCallback;
+    /** User pointer parameter for pfnHeaderCallback. */
+    void                           *pvHeaderCallbackUser;
+    /** @} */
+
 } RTHTTPINTERNAL;
 /** Pointer to an internal HTTP client instance. */
@@ -2920 +2929 @@
 
 /**
- * cURL callback for writing data.
- */
-static size_t rtHttpWriteData(char *pchBuf, size_t cbUnit, size_t cUnits, void *pvUser)
-{
-    RTHTTPOUTPUTDATA *pOutput    = (RTHTTPOUTPUTDATA *)pvUser;
-    PRTHTTPINTERNAL   pThis      = pOutput->pHttp;
+ * Worker for rtHttpWriteHeaderData and rtHttpWriteBodyData.
+ */
+static size_t rtHttpWriteDataToMemOutput(PRTHTTPINTERNAL pThis, RTHTTPOUTPUTDATA *pOutput, char const *pchBuf, size_t cbToAppend)
+{
+    /*
+     * Do max size and overflow checks.
+     */
+    size_t const cbCurSize  = pOutput->uData.Mem.cb;
+    size_t const cbNewSize  = cbCurSize + cbToAppend;
+    if (   cbToAppend < RTHTTP_MAX_MEM_DOWNLOAD_SIZE
+        && cbNewSize  < RTHTTP_MAX_MEM_DOWNLOAD_SIZE)
+    {
+        if (cbNewSize + 1 <= pOutput->uData.Mem.cbAllocated)
+        {
+            memcpy(&pOutput->uData.Mem.pb[cbCurSize], pchBuf, cbToAppend);
+            pOutput->uData.Mem.cb = cbNewSize;
+            pOutput->uData.Mem.pb[cbNewSize] = '\0';
+            return cbToAppend;
+        }
+
+        /*
+         * We need to reallocate the output buffer.
+         */
+        /** @todo this could do with a better strategy wrt growth. */
+        size_t cbAlloc = RT_ALIGN_Z(cbNewSize + 1, 64);
+        if (   cbAlloc <= pThis->cbDownloadHint
+            && pThis->cbDownloadHint < RTHTTP_MAX_MEM_DOWNLOAD_SIZE
+            && pOutput == &pThis->BodyOutput)
+            cbAlloc = RT_ALIGN_Z(pThis->cbDownloadHint + 1, 64);
+
+        uint8_t *pbNew = (uint8_t *)RTMemRealloc(pOutput->uData.Mem.pb, cbAlloc);
+        if (pbNew)
+        {
+            memcpy(&pbNew[cbCurSize], pchBuf, cbToAppend);
+            pbNew[cbNewSize] = '\0';
+
+            pOutput->uData.Mem.cbAllocated = cbAlloc;
+            pOutput->uData.Mem.pb = pbNew;
+            pOutput->uData.Mem.cb = cbNewSize;
+            return cbToAppend;
+        }
+
+        pThis->rcOutput = VERR_NO_MEMORY;
+    }
+    else
+        pThis->rcOutput = VERR_TOO_MUCH_DATA;
+
+    /*
+     * Failure - abort.
+     */
+    RTMemFree(pOutput->uData.Mem.pb);
+    pOutput->uData.Mem.pb = NULL;
+    pOutput->uData.Mem.cb = RTHTTP_MAX_MEM_DOWNLOAD_SIZE;
+    pThis->fAbort   = true;
+    return 0;
+}
+
+
+/**
+ * cURL callback for writing body data.
+ */
+static size_t rtHttpWriteBodyData(char *pchBuf, size_t cbUnit, size_t cUnits, void *pvUser)
+{
+    PRTHTTPINTERNAL   pThis      = (PRTHTTPINTERNAL)pvUser;
     size_t const      cbToAppend = cbUnit * cUnits;
 
     /*
-     * If called on the body, check if this belongs to the body download callback.
-     */
-    if (   pThis->pfnDownloadCallback
-        && pOutput == &pThis->BodyOutput)
+     * Check if this belongs to the body download callback.
+     */
+    if (pThis->pfnDownloadCallback)
     {
         if (pThis->offDownloadContent == 0)
@@ -2955 +3021 @@
 
     /*
-     * Do max size and overflow checks.
-     */
-    size_t const cbCurSize  = pOutput->uData.Mem.cb;
-    size_t const cbNewSize  = cbCurSize + cbToAppend;
-    if (   cbToAppend < RTHTTP_MAX_MEM_DOWNLOAD_SIZE
-        && cbNewSize  < RTHTTP_MAX_MEM_DOWNLOAD_SIZE)
-    {
-        if (cbNewSize + 1 <= pOutput->uData.Mem.cbAllocated)
-        {
-            memcpy(&pOutput->uData.Mem.pb[cbCurSize], pchBuf, cbToAppend);
-            pOutput->uData.Mem.cb = cbNewSize;
-            pOutput->uData.Mem.pb[cbNewSize] = '\0';
+     * Otherwise, copy to memory output buffer.
+     */
+    return rtHttpWriteDataToMemOutput(pThis, &pThis->BodyOutput, pchBuf, cbToAppend);
+}
+
+
+/**
+ * cURL callback for writing header data.
+ */
+static size_t rtHttpWriteHeaderData(char *pchBuf, size_t cbUnit, size_t cUnits, void *pvUser)
+{
+    PRTHTTPINTERNAL   pThis      = (PRTHTTPINTERNAL)pvUser;
+    size_t const      cbToAppend = cbUnit * cUnits;
+
+    /*
+     * Work the header callback, if one.
+     * ASSUMES cURL is giving us one header at a time.
+     */
+    if (pThis->pfnHeaderCallback)
+    {
+        /* Find the end of the field name first.  Since cURL gives us the
+           "HTTP/{version} {code} {status}" line too, we slap a fictitious
+           field name ':http-status-line' in front of it. */
+        uint32_t    uMatchWord;
+        size_t      cchField;
+        const char *pchField = pchBuf;
+        size_t      cchValue;
+        const char *pchValue = (const char *)memchr(pchBuf, ':', cbToAppend);
+        if (pchValue)
+        {
+            cchField = pchValue - pchField;
+            if (RT_LIKELY(cchField >= 3))
+                uMatchWord = RTHTTP_MAKE_HDR_MATCH_WORD(cchField, RT_C_TO_LOWER(pchBuf[0]),
+                                                        RT_C_TO_LOWER(pchBuf[1]), RT_C_TO_LOWER(pchBuf[2]));
+            else
+                uMatchWord = RTHTTP_MAKE_HDR_MATCH_WORD(cchField,
+                                                        cchField >= 1 ? RT_C_TO_LOWER(pchBuf[0]) : 0,
+                                                        cchField >= 2 ? RT_C_TO_LOWER(pchBuf[1]) : 0,
+                                                        0);
+            pchValue++;
+            cchValue = cbToAppend - cchField - 1;
+        }
+        else if (pchBuf[0] == 'H' && pchBuf[1] == 'T' && pchBuf[2] == 'T' && pchBuf[1] == 'P')
+        {
+            pchField   = ":http-status-line";
+            cchField   = 17;
+            uMatchWord = RTHTTP_MAKE_HDR_MATCH_WORD(17, ':', 'h', 't');
+            pchValue   = pchBuf;
+            cchValue   = cbToAppend;
+        }
+        else
+            AssertMsgFailedReturn(("pchBuf=%.*s\n", cbToAppend, pchBuf), cbToAppend);
+
+        /* Determin the field value, stripping one leading blank and all
+           trailing spaces. */
+        if (cchValue > 0 && RT_C_IS_BLANK(*pchValue))
+            pchValue++, cchValue--;
+        while (cchValue > 0 && RT_C_IS_SPACE(pchValue[cchValue - 1]))
+            cchValue--;
+
+        /* Pass it to the callback. */
+        int rc = pThis->pfnHeaderCallback(pThis, uMatchWord, pchBuf, cchField,
+                                          pchValue, cchValue, pThis->pvHeaderCallbackUser);
+        if (RT_SUCCESS(rc))
             return cbToAppend;
-        }
-
-        /*
-         * We need to reallocate the output buffer.
-         */
-        /** @todo this could do with a better strategy wrt growth. */
-        size_t cbAlloc = RT_ALIGN_Z(cbNewSize + 1, 64);
-        if (   cbAlloc <= pThis->cbDownloadHint
-            && pThis->cbDownloadHint < RTHTTP_MAX_MEM_DOWNLOAD_SIZE
-            && pOutput == &pThis->BodyOutput)
-            cbAlloc = RT_ALIGN_Z(pThis->cbDownloadHint + 1, 64);
-
-        uint8_t *pbNew = (uint8_t *)RTMemRealloc(pOutput->uData.Mem.pb, cbAlloc);
-        if (pbNew)
-        {
-            memcpy(&pbNew[cbCurSize], pchBuf, cbToAppend);
-            pbNew[cbNewSize] = '\0';
-
-            pOutput->uData.Mem.cbAllocated = cbAlloc;
-            pOutput->uData.Mem.pb = pbNew;
-            pOutput->uData.Mem.cb = cbNewSize;
-            return cbToAppend;
-        }
-
-        pThis->rcOutput = VERR_NO_MEMORY;
-    }
-    else
-        pThis->rcOutput = VERR_TOO_MUCH_DATA;
-
-    /*
-     * Failure - abort.
-     */
-    RTMemFree(pOutput->uData.Mem.pb);
-    pOutput->uData.Mem.pb = NULL;
-    pOutput->uData.Mem.cb = RTHTTP_MAX_MEM_DOWNLOAD_SIZE;
-    pThis->fAbort   = true;
-    return 0;
+
+        if (RT_SUCCESS(pThis->rcOutput))
+            pThis->rcOutput = rc;
+        pThis->fAbort = true;
+        return 0;
+    }
+
+    return rtHttpWriteDataToMemOutput(pThis, &pThis->HeadersOutput, pchBuf, cbToAppend);
 }
 
@@ -3174 +3263 @@
     {
         RT_ZERO(pThis->BodyOutput.uData.Mem);
-        int rcCurl = rtHttpSetWriteCallback(pThis, &rtHttpWriteData, (void *)&pThis->BodyOutput);
+        int rcCurl = rtHttpSetWriteCallback(pThis, &rtHttpWriteBodyData, pThis);
         if (fNoBody)
         {
@@ -3461 +3550 @@
         {
             RT_ZERO(pThis->HeadersOutput.uData.Mem);
-            rcCurl = rtHttpSetHeaderCallback(pThis, rtHttpWriteData, &pThis->HeadersOutput);
+            rcCurl = rtHttpSetHeaderCallback(pThis, rtHttpWriteHeaderData, pThis);
         }
 
@@ -3468 +3557 @@
         {
             RT_ZERO(pThis->BodyOutput.uData.Mem);
-            rcCurl = rtHttpSetWriteCallback(pThis, rtHttpWriteData, &pThis->BodyOutput);
+            rcCurl = rtHttpSetWriteCallback(pThis, rtHttpWriteBodyData, pThis);
         }
         else if (pThis->pfnDownloadCallback && CURL_SUCCESS(rcCurl))
@@ -3596 +3685 @@
 
 
-/** @todo header field callback. */
+RTR3DECL(int) RTHttpSetHeaderCallback(RTHTTP hHttp, PFNRTHTTPHEADERCALLBACK pfnCallback, void *pvUser)
+{
+    PRTHTTPINTERNAL pThis = hHttp;
+    RTHTTP_VALID_RETURN(pThis);
+
+    pThis->pfnHeaderCallback    = pfnCallback;
+    pThis->pvHeaderCallbackUser = pvUser;
+    return VINF_SUCCESS;
+}