Changeset 74060 in vbox

Timestamp:

Sep 4, 2018 9:28:28 AM (6 years ago)

Author:

vboxsync

Message:

IPRT/http: s/RTHttpAppend/RTHttpAdd/[Raw]Header, defining FRONT and BACK flags. bugref:9167

Location:

trunk

Files:

• include/iprt/http.h (modified) (2 diffs)
• src/VBox/Runtime/common/rest/RTCRestClientApiBaseOci.cpp (modified) (4 diffs)
• src/VBox/Runtime/common/rest/RTCRestClientRequestBase.cpp (modified) (2 diffs)
• src/VBox/Runtime/generic/http-curl.cpp (modified) (6 diffs)

trunk/include/iprt/http.h

@@ -294 +294 @@
 RTR3DECL(int) RTHttpSetHeaders(RTHTTP hHttp, size_t cHeaders, const char * const *papszHeaders);
 
-/**
- * Appends a raw header.
+/** @name RTHTTPADDHDR_F_XXX - Flags for RTHttpAddRawHeader and RTHttpAddHeader
+ * @{ */
+#define RTHTTPADDHDR_F_BACK     UINT32_C(0) /**< Append the header. */
+#define RTHTTPADDHDR_F_FRONT    UINT32_C(1) /**< Prepend the header. */
+/** @} */
+
+/**
+ * Adds a raw header.
  *
  * @returns IPRT status code.
  * @param   hHttp           The HTTP client handle.
  * @param   pszHeader       Header string on the form "foo: bar".
- */
-RTR3DECL(int) RTHttpAppendRawHeader(RTHTTP hHttp, const char *pszHeader);
-
-/**
- * Appends a header field and value.
+ * @param   fFlags          RTHTTPADDHDR_F_FRONT or RTHTTPADDHDR_F_BACK.
+ */
+RTR3DECL(int) RTHttpAddRawHeader(RTHTTP hHttp, const char *pszHeader, uint32_t fFlags);
+
+/**
+ * Adds a header field and value.
  *
  * @returns IPRT status code.
@@ -310 +317 @@
  * @param   pszField        The header field name.
  * @param   pszValue        The header field value.
- * @param   fFlags          Flags reserved for controlling encoding, MBZ.
- */
-RTR3DECL(int) RTHttpAppendHeader(RTHTTP hHttp, const char *pszField, const char *pszValue, uint32_t fFlags);
+ * @param   fFlags          Only RTHTTPADDHDR_F_FRONT or RTHTTPADDHDR_F_BACK,
+ *                          may be extended with encoding controlling flags if
+ *                          needed later.
+ */
+RTR3DECL(int) RTHttpAddHeader(RTHTTP hHttp, const char *pszField, const char *pszValue, uint32_t fFlags);
 
 /**

trunk/src/VBox/Runtime/common/rest/RTCRestClientApiBaseOci.cpp

@@ -146 +146 @@
         RTStrPrintf(szTmp, sizeof(szTmp), "%zu", a_rStrXmitBody.length());
 
-        rc = RTHttpAppendHeader(a_hHttp, s_szContentLength, szTmp, 0);
+        rc = RTHttpAddHeader(a_hHttp, s_szContentLength, szTmp, RTHTTPADDHDR_F_BACK);
         AssertRCReturn(rc, rc);
         pszContentLength = RTHttpGetHeader(a_hHttp, RT_STR_TUPLE(s_szContentLength));
@@ -177 +177 @@
         rc = RTBase64EncodeEx(abHash, sizeof(abHash), RTBASE64_FLAGS_NO_LINE_BREAKS, szTmp, sizeof(szTmp), NULL);
 
-        rc = RTHttpAppendHeader(a_hHttp, s_szXContentSha256, szTmp, 0);
+        rc = RTHttpAddHeader(a_hHttp, s_szXContentSha256, szTmp, RTHTTPADDHDR_F_BACK);
         AssertRCReturn(rc, rc);
         pszValue = RTHttpGetHeader(a_hHttp, RT_STR_TUPLE(s_szXContentSha256));
@@ -223 +223 @@
                     Time.u8Hour, Time.u8Minute, Time.u8Second);
 
-        rc = RTHttpAppendHeader(a_hHttp, s_szXDate, szTmp, 0);
+        rc = RTHttpAddHeader(a_hHttp, s_szXDate, szTmp, RTHTTPADDHDR_F_BACK);
         AssertRCReturn(rc, rc);
         pszXDate = RTHttpGetHeader(a_hHttp, RT_STR_TUPLE(s_szXDate));
@@ -304 +304 @@
                                      * Finally, add the authorization header.
                                      */
-                                    rc = RTHttpAppendHeader(a_hHttp, "Authorization", strAuth.c_str(), 0);
+                                    rc = RTHttpAddHeader(a_hHttp, "Authorization", strAuth.c_str(), RTHTTPADDHDR_F_FRONT);
                                     AssertRC(rc);
                                 }

trunk/src/VBox/Runtime/common/rest/RTCRestClientRequestBase.cpp

@@ -193 +193 @@
                 AssertRCReturn(rc, rc);
 
-                rc = RTHttpAppendHeader(a_hHttp, a_paHeaderParams[i].pszName, strTmpVal.c_str(), 0);
+                rc = RTHttpAddHeader(a_hHttp, a_paHeaderParams[i].pszName, strTmpVal.c_str(), RTHTTPADDHDR_F_BACK);
                 AssertRCReturn(rc, rc);
             }
@@ -217 +217 @@
                     AssertRCReturn(rc, rc);
 
-                    rc = RTHttpAppendHeader(a_hHttp, strTmpName.c_str(), strTmpVal.c_str(), 0);
+                    rc = RTHttpAddHeader(a_hHttp, strTmpName.c_str(), strTmpVal.c_str(), RTHTTPADDHDR_F_BACK);
                     AssertRCReturn(rc, rc);
                 }

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

@@ -1929 +1929 @@
 
 /**
- * Helper for RTHttpSetHeaders and RTHttpAppendHeader that unsets the user agent
+ * Helper for RTHttpSetHeaders and RTHttpAddRawHeader that unsets the user agent
  * if it is now in one of the headers.
  */
@@ -1967 +1967 @@
 
     /*
-     * Convert the headers into a curl string list, checkig each string for User-Agent.
+     * Convert the headers into a curl string list, checking each string for User-Agent.
      */
     struct curl_slist *pHeaders = NULL;
@@ -2000 +2000 @@
 
 
-RTR3DECL(int) RTHttpAppendRawHeader(RTHTTP hHttp, const char *pszHeader)
+RTR3DECL(int) RTHttpAddRawHeader(RTHTTP hHttp, const char *pszHeader, uint32_t fFlags)
 {
     PRTHTTPINTERNAL pThis = hHttp;
     RTHTTP_VALID_RETURN(pThis);
+    AssertReturn(!(fFlags & ~RTHTTPADDHDR_F_BACK), VERR_INVALID_FLAGS);
+/** @todo implement RTHTTPADDHDR_F_FRONT */
 
     /*
@@ -2040 +2042 @@
 
 
-RTR3DECL(int) RTHttpAppendHeader(RTHTTP hHttp, const char *pszField, const char *pszValue, uint32_t fFlags)
+RTR3DECL(int) RTHttpAddHeader(RTHTTP hHttp, const char *pszField, const char *pszValue, uint32_t fFlags)
 {
 
@@ -2062 +2064 @@
     size_t const cchValue = strlen(pszValue);
 
-    AssertReturn(!fFlags, VERR_INVALID_FLAGS);
+    AssertReturn(!(fFlags & ~RTHTTPADDHDR_F_BACK), VERR_INVALID_FLAGS);
 
     /*
@@ -2084 +2086 @@
     pszHeader[cbNeeded - 1] = '\0';
 
-    int rc = RTHttpAppendRawHeader(hHttp, pszHeader);
+    int rc = RTHttpAddRawHeader(hHttp, pszHeader, fFlags & RTHTTPADDHDR_F_FRONT);
 
     if (pszHeaderFree)