Changeset 73978 in vbox

Timestamp:

Aug 30, 2018 1:19:36 PM (7 years ago)

Author:

vboxsync

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

124714

Message:

IPRT/rest: Fixed empty array & map handling by making the begin iteration functions return VERR_JSON_IS_EMPTY rather than letter the query method do that. Made query parameter processing table driven and made it use the right escapeing. bugref:9167

Location:

trunk

Files:

• include/iprt/cpp/restbase.h (modified) (3 diffs)
• include/iprt/err.h (modified) (1 diff)
• include/iprt/json.h (modified) (3 diffs)
• src/VBox/Runtime/common/misc/json.cpp (modified) (2 diffs)
• src/VBox/Runtime/common/rest/RTCRestArrayBase.cpp (modified) (1 diff)
• src/VBox/Runtime/common/rest/RTCRestClientApiBase.cpp (modified) (1 diff)
• src/VBox/Runtime/common/rest/RTCRestClientRequestBase.cpp (modified) (1 diff)
• src/VBox/Runtime/common/rest/RTCRestStringMapBase.cpp (modified) (1 diff)

trunk/include/iprt/cpp/restbase.h

@@ -303 +303 @@
         kCollectionFormat_tsv,              /**< Tab-separated list. */
         kCollectionFormat_pipes,            /**< Pipe-separated list. */
+        kCollectionFormat_multi,            /**< Special collection type that must be handled by caller of toString. */
         kCollectionFormat_Mask = 7,         /**< Collection type mask. */
 
@@ -1370 +1371 @@
 
     /**
+     * Do path parameters.
      *
      * @returns IPRT status code
@@ -1380 +1382 @@
     int doPathParameters(RTCString *a_pStrPath, const char *a_pszPathTemplate, size_t a_cchPathTemplate,
                          PATHREPLACEENTRY *a_paPathParams, size_t a_cPathParams) const;
+
+    /** Query parameter descriptor. */
+    typedef struct
+    {
+        const char                 *pszName;    /**< The parameter name. */
+        uint32_t                    fFlags;     /**< The toString flags. */
+        bool                        fRequired;  /**< Required or not. */
+    } QUERYPARAMDESC;
+
+    /**
+     * Do query parameters.
+     *
+     * @returns IPRT status code
+     * @param   a_pStrQuery         The destination string.
+     * @param   a_paQueryParams     The query parameter descriptors.
+     * @param   a_papQueryParamObjs The query parameter objects, parallel to @a a_paQueryParams.
+     * @param   a_cQueryParams      Number of query parameters.
+     */
+    int doQueryParameters(RTCString *a_pStrQuery, QUERYPARAMDESC const *a_paQueryParams,
+                          RTCRestObjectBase const **a_papQueryParamObjs, size_t a_cQueryParams) const;
 };
 

trunk/include/iprt/err.h

@@ -2877 +2877 @@
 /** The JSON document is malformed. */
 #define VERR_JSON_MALFORMED                         (-24702)
+/** Object or array is empty. */
+#define VERR_JSON_IS_EMPTY                          (-24703)
 /** @} */
 

trunk/include/iprt/json.h

@@ -277 +277 @@
  * @param   hJsonVal        The JSON value handle.
  * @param   phJsonIt        Where to store the JSON iterator handle on success.
+ * @todo    Make return VERR_JSON_IS_EMPTY (or remove it).
  */
 RTDECL(int) RTJsonIteratorBegin(RTJSONVAL hJsonVal, PRTJSONIT phJsonIt);
@@ -285 +286 @@
  * @returns IPRT status code.
  * @retval  VERR_JSON_VALUE_INVALID_TYPE if the JSON value is not an array.
+ * @retval  VERR_JSON_IS_EMPTY if no members.
  * @param   hJsonVal        The JSON value handle.
  * @param   phJsonIt        Where to store the JSON iterator handle on success.
@@ -295 +297 @@
  * @returns IPRT status code.
  * @retval  VERR_JSON_VALUE_INVALID_TYPE if the JSON value is not an object.
+ * @retval  VERR_JSON_IS_EMPTY if no members.
  * @param   hJsonVal        The JSON value handle.
  * @param   phJsonIt        Where to store the JSON iterator handle on success.

trunk/src/VBox/Runtime/common/misc/json.cpp

@@ -1518 +1518 @@
     RTJSON_TYPECHECK_RETURN(pThis, RTJSONVALTYPE_ARRAY);
 
-    return rtJsonIteratorBeginWorker(pThis, phJsonIt);
+    if (pThis->Type.Array.cItems > 0)
+        return rtJsonIteratorBeginWorker(pThis, phJsonIt);
+    return VERR_JSON_IS_EMPTY;
 }
 
@@ -1528 +1530 @@
     RTJSON_TYPECHECK_RETURN(pThis, RTJSONVALTYPE_OBJECT);
 
-    return rtJsonIteratorBeginWorker(pThis, phJsonIt);
+    if (pThis->Type.Object.cMembers > 0)
+        return rtJsonIteratorBeginWorker(pThis, phJsonIt);
+    return VERR_JSON_IS_EMPTY;
 }
 

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

@@ -179 +179 @@
         RTJsonIteratorFree(hIterator);
     }
+    else if (rcRet == VERR_JSON_IS_EMPTY)
+        rcRet = VINF_SUCCESS;
     else
         rcRet = a_rCursor.m_pPrimary->addError(a_rCursor, rcRet, "RTJsonIteratorBeginArray failed: %Rrc", rcRet);

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

@@ -117 +117 @@
                 if (strQuery.isNotEmpty())
                 {
-                    if (RT_SUCCESS(rc))
-                        rc = strFullUrl.appendNoThrow('?');
-                    if (RT_SUCCESS(rc))
-                        rc = strFullUrl.appendNoThrow(strQuery);
+                    Assert(strQuery.startsWith("?"));
+                    rc = strFullUrl.appendNoThrow(strQuery);
                     strQuery.setNull();
                 }

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

@@ -112 +112 @@
 }
 
+
+int RTCRestClientRequestBase::doQueryParameters(RTCString *a_pStrQuery, QUERYPARAMDESC const *a_paQueryParams,
+                                                RTCRestObjectBase const **a_papQueryParamObjs, size_t a_cQueryParams) const
+{
+    RTCString strTmpVal;
+    char chSep = a_pStrQuery->isEmpty() ? '?' : '&';
+    for (size_t i = 0; i < a_cQueryParams; i++)
+    {
+        if ((a_paQueryParams[i].fFlags & RTCRestObjectBase::kCollectionFormat_Mask) != RTCRestObjectBase::kCollectionFormat_multi)
+        {
+            int rc = a_papQueryParamObjs[i]->toString(&strTmpVal, a_paQueryParams[i].fFlags);
+            AssertRCReturn(rc, rc);
+
+            rc = a_pStrQuery->appendPrintfNoThrow("%c%RMpq=%RMpq", chSep, a_paQueryParams[i].pszName, strTmpVal.c_str());
+            AssertRCReturn(rc, rc);
+
+            chSep = '&';
+        }
+        else
+        {
+            AssertFailedReturn(VERR_NOT_IMPLEMENTED);
+        }
+    }
+    return VINF_SUCCESS;
+}
+

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

@@ -175 +175 @@
         RTJsonIteratorFree(hIterator);
     }
+    else if (rcRet == VERR_JSON_IS_EMPTY)
+        rcRet = VINF_SUCCESS;
     else
         rcRet = a_rCursor.m_pPrimary->addError(a_rCursor, rcRet, "RTJsonIteratorBegin failed: %Rrc", rcRet);