Changeset 74023 in vbox for trunk/src/VBox/Runtime/common/rest

Timestamp:

Sep 2, 2018 1:43:59 PM (7 years ago)

Author:

vboxsync

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

124770

Message:

IPRT/rest: Implemented header collection (x-obmcs-header-collection) and multi-query array mapping. Renamed RTCRestObjectBase::getType() to typeName() to avoid clashing with generated code. bugref:9167

Location:

trunk/src/VBox/Runtime/common/rest

Files:

• RTCRestArrayBase.cpp (modified) (1 diff)
• RTCRestClientRequestBase.cpp (modified) (2 diffs)
• RTCRestClientResponseBase.cpp (modified) (6 diffs)
• RTCRestStringMapBase.cpp (modified) (6 diffs)
• rest-primary-object-types.cpp (modified) (7 diffs)

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

@@ -245 +245 @@
 
 
+RTCRestObjectBase::kTypeClass RTCRestArrayBase::typeClass(void) const
+{
+    return kTypeClass_Array;
+}
+
+
+const char *RTCRestArrayBase::typeName(void) const
+{
+    return "RTCRestArray<ElementType>";
+}
+
+
 
 /*********************************************************************************************************************************

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

@@ -146 +146 @@
             else
             {
-                AssertFailedReturn(VERR_NOT_IMPLEMENTED);
+                /*
+                 * Enumerate array and add 'name=element' for each element in it.
+                 */
+                AssertReturn(a_papQueryParamObjs[i]->typeClass() == RTCRestObjectBase::kTypeClass_Array,
+                             VERR_REST_INTERAL_ERROR_2);
+                RTCRestArrayBase const *pArray = (RTCRestArrayBase const *)a_papQueryParamObjs[i];
+                for (size_t i = 0; i < pArray->size(); i++)
+                {
+                    RTCRestObjectBase const *pObj = pArray->atBase(i);
+                    int rc = pObj->toString(&strTmpVal, a_paQueryParams[i].fFlags & ~RTCRestObjectBase::kCollectionFormat_Mask);
+                    AssertRCReturn(rc, rc);
+
+                    rc = a_pStrQuery->appendPrintfNoThrow("%c%RMpq=%RMpq", chSep, a_paQueryParams[i].pszName, strTmpVal.c_str());
+                    AssertRCReturn(rc, rc);
+
+                    chSep = '&';
+                }
             }
         }
@@ -170 +186 @@
                       ("Required header parameter '%s' is not set!\n", a_paHeaderParams[i].pszName));
 
-            int rc = a_papHeaderParamObjs[i]->toString(&strTmpVal, a_paHeaderParams[i].fFlags);
-            AssertRCReturn(rc, rc);
-
-            rc = RTHttpAppendHeader(a_hHttp, a_paHeaderParams[i].pszName, strTmpVal.c_str(), 0);
-            AssertRCReturn(rc, rc);
+            if (!a_paHeaderParams[i].fMapCollection)
+            {
+                int rc = a_papHeaderParamObjs[i]->toString(&strTmpVal, a_paHeaderParams[i].fFlags);
+                AssertRCReturn(rc, rc);
+
+                rc = RTHttpAppendHeader(a_hHttp, a_paHeaderParams[i].pszName, strTmpVal.c_str(), 0);
+                AssertRCReturn(rc, rc);
+            }
+            else if (!a_papHeaderParamObjs[i]->isNull())
+            {
+                /*
+                 * Enumerate the map and produce a series of head fields on the form:
+                 *      (a_paHeaderParams[i].pszName + key): value.toString()
+                 */
+                AssertReturn(a_papHeaderParamObjs[i]->typeClass() == RTCRestObjectBase::kTypeClass_StringMap,
+                             VERR_REST_INTERAL_ERROR_1);
+                RTCRestStringMapBase const *pMap    = (RTCRestStringMapBase const *)a_papHeaderParamObjs[i];
+                const size_t                cchName = strlen(a_paHeaderParams[i].pszName);
+                RTCString                   strTmpName;
+                for (RTCRestStringMapBase::ConstIterator it = pMap->begin(); it != pMap->end(); ++it)
+                {
+                    int rc = strTmpName.assignNoThrow(a_paHeaderParams[i].pszName, cchName);
+                    AssertRCReturn(rc, rc);
+                    rc = strTmpName.appendNoThrow(it.getKey());
+                    AssertRCReturn(rc, rc);
+
+                    rc = it.getValue()->toString(&strTmpVal, a_paHeaderParams[i].fFlags);
+                    AssertRCReturn(rc, rc);
+
+                    rc = RTHttpAppendHeader(a_hHttp, strTmpName.c_str(), strTmpVal.c_str(), 0);
+                    AssertRCReturn(rc, rc);
+                }
+            }
+            else
+                Assert(!a_paHeaderParams[i].fRequired);
         }
     }

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

@@ -231 +231 @@
             {
                 size_t const cchThisName = a_paFieldDescs[i].cchName;
-                if (  !(a_paFieldDescs[i].fFlags & kHdrField_MapCollection)
-                    ?    cchThisName == cchName
-                      && RTStrNICmpAscii(a_pchData, a_paFieldDescs[i].pszName, cchThisName) == 0
-                    :    cchThisName <= cchName
-                      && RTStrNICmpAscii(a_pchData, a_paFieldDescs[i].pszName, cchThisName - 1) == 0)
+                if (   (!(a_paFieldDescs[i].fFlags & kHdrField_MapCollection) ? cchThisName == cchName : cchThisName < cchName)
+                    && RTStrNICmpAscii(a_pchData, a_paFieldDescs[i].pszName, cchThisName) == 0)
                 {
                     /* Get and clean the value. */
-                    int rc = VINF_SUCCESS;
                     if (!fHaveValue)
                     {
-                        rc = strValue.assignNoThrow(&a_pchData[offValue], cchValue);
+                        int rc = strValue.assignNoThrow(&a_pchData[offValue], cchValue);
                         if (RT_SUCCESS(rc))
                         {
@@ -257 +253 @@
                      * Create field to deserialize.
                      */
-                    RTCRestObjectBase *pObj = NULL;
-                    if (!(a_paFieldDescs[i].fFlags & (kHdrField_MapCollection | kHdrField_ArrayCollection)))
+                    RTCRestStringMapBase *pMap = NULL;
+                    RTCRestObjectBase    *pObj = NULL;
+                    if (!(a_paFieldDescs[i].fFlags & kHdrField_MapCollection))
                     {
                         /* Only once. */
@@ -269 +266 @@
                             {
                                 addError(VERR_NO_MEMORY, "out of memory");
-                                continue;
+                                break;
                             }
                         }
@@ -280 +277 @@
                     else
                     {
-                        Assert(a_paFieldDescs[i].pszName[cchThisName - 1] == '*');
-                        AssertMsgFailed(("impl field collections"));
-                        continue;
+                        /* Make sure we've got a map to work with. */
+                        if (!*a_pappFieldValues[i])
+                            *a_pappFieldValues[i] = pObj = a_paFieldDescs[i].pfnCreateInstance();
+                        else
+                            pObj = *a_pappFieldValues[i];
+                        AssertBreak(pObj->typeClass() == RTCRestObjectBase::kTypeClass_StringMap);
+                        pMap = (RTCRestStringMapBase *)pObj;
+
+                        /* Insert the header field name (sans prefix) into the map.  We then use the
+                           new value object for the deserialization of the header field value below.  */
+                        int rc = pMap->putNewValue(&pObj, &a_pchData[cchThisName], cchName - cchThisName);
+                        if (RT_SUCCESS(rc))
+                        { /* likely */ }
+                        else if (rc == VERR_ALREADY_EXISTS)
+                        {
+                            addError(VERR_REST_RESPONSE_REPEAT_HEADER_FIELD, "Already saw header field '%s'", a_paFieldDescs[i].pszName);
+                            continue;
+                        }
+                        else
+                        {
+                            addError(rc, "out of memory");
+                            break;
+                        }
                     }
 
@@ -289 +306 @@
                      */
                     RTERRINFOSTATIC ErrInfo;
-                    rc = pObj->fromString(strValue, a_paFieldDescs[i].pszName, RTErrInfoInitStatic(&ErrInfo),
-                                          a_paFieldDescs[i].fFlags & RTCRestObjectBase::kCollectionFormat_Mask);
+                    int rc = pObj->fromString(strValue, a_paFieldDescs[i].pszName, RTErrInfoInitStatic(&ErrInfo),
+                                              a_paFieldDescs[i].fFlags & RTCRestObjectBase::kCollectionFormat_Mask);
                     if (RT_SUCCESS(rc))
                     { /* likely */ }
@@ -405 +422 @@
             if (RT_SUCCESS(rc))
             {
-                PrimaryJsonCursorForBody PrimaryCursor(hValue, a_pDst->getType(), this); /* note: consumes hValue */
+                PrimaryJsonCursorForBody PrimaryCursor(hValue, a_pDst->typeName(), this); /* note: consumes hValue */
                 a_pDst->deserializeFromJson(PrimaryCursor.m_Cursor);
             }
             else if (RTErrInfoIsSet(&ErrInfo.Core))
                 addError(rc, "Error %Rrc parsing server response as JSON (type %s): %s",
-                         rc, a_pDst->getType(), ErrInfo.Core.pszMsg);
+                         rc, a_pDst->typeName(), ErrInfo.Core.pszMsg);
             else
-                addError(rc, "Error %Rrc parsing server response as JSON (type %s)", rc, a_pDst->getType());
+                addError(rc, "Error %Rrc parsing server response as JSON (type %s)", rc, a_pDst->typeName());
         }
         else if (rc == VERR_INVALID_UTF8_ENCODING)
             addError(VERR_REST_RESPONSE_INVALID_UTF8_ENCODING, "Invalid UTF-8 body encoding (object type %s; Content-Type: %s)",
-                     a_pDst->getType(), m_strContentType.c_str());
+                     a_pDst->typeName(), m_strContentType.c_str());
         else if (rc == VERR_BUFFER_UNDERFLOW)
             addError(VERR_REST_RESPONSE_EMBEDDED_ZERO_CHAR, "Embedded zero character in response (object type %s; Content-Type: %s)",
-                     a_pDst->getType(), m_strContentType.c_str());
+                     a_pDst->typeName(), m_strContentType.c_str());
         else
             addError(rc, "Unexpected body validation error (object type %s; Content-Type: %s): %Rrc",
-                     a_pDst->getType(), m_strContentType.c_str(), rc);
+                     a_pDst->typeName(), m_strContentType.c_str(), rc);
     }
     else
         addError(VERR_REST_RESPONSE_CONTENT_TYPE_NOT_SUPPORTED, "Unsupported content type for '%s': %s",
-                 a_pDst->getType(), m_strContentType.c_str());
-}
-
+                 a_pDst->typeName(), m_strContentType.c_str());
+}
+

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

@@ -204 +204 @@
 
 
+RTCRestObjectBase::kTypeClass RTCRestStringMapBase::typeClass(void) const
+{
+    return kTypeClass_StringMap;
+}
+
+
+const char *RTCRestStringMapBase::typeName(void) const
+{
+    return "RTCRestStringMap<ValueType>";
+}
+
+
 /*********************************************************************************************************************************
 *   Generic map methods                                                                                                          *
@@ -269 +281 @@
 {
     return remove(a_rStrKey.c_str());
+}
+
+
+int RTCRestStringMapBase::putNewValue(RTCRestObjectBase **a_ppValue, const char *a_pszKey, size_t a_cchKey /*= RTSTR_MAX*/,
+                                      bool a_fReplace /*= false*/)
+{
+    RTCRestObjectBase *pValue = createValue();
+    if (pValue)
+    {
+        int rc = putWorker(a_pszKey, pValue, a_fReplace, a_cchKey);
+        if (RT_SUCCESS(rc))
+            *a_ppValue = pValue;
+        else
+        {
+            delete pValue;
+            *a_ppValue = NULL;
+        }
+        return rc;
+    }
+    *a_ppValue = NULL;
+    return VERR_NO_MEMORY;
+}
+
+
+int RTCRestStringMapBase::putNewValue(RTCRestObjectBase **a_ppValue, RTCString const &a_rStrKey, bool a_fReplace /*= false*/)
+{
+    return putNewValue(a_ppValue, a_rStrKey.c_str(), a_rStrKey.length(), a_fReplace);
 }
 
@@ -301 +340 @@
 
 
-int RTCRestStringMapBase::putWorker(const char *a_pszKey, RTCRestObjectBase *a_pValue, bool a_fReplace)
+int RTCRestStringMapBase::putWorker(const char *a_pszKey, RTCRestObjectBase *a_pValue, bool a_fReplace,
+                                    size_t a_cchKey /*= RTSTR_MAX*/)
 {
     int rc;
@@ -307 +347 @@
     if (pEntry)
     {
-        rc = pEntry->strKey.assignNoThrow(a_pszKey);
+        rc = pEntry->strKey.assignNoThrow(a_pszKey, a_cchKey);
         if (RT_SUCCESS(rc))
         {
@@ -347 +387 @@
 
 
-int RTCRestStringMapBase::putCopyWorker(const char *a_pszKey, RTCRestObjectBase const &a_rValue, bool a_fReplace)
+int RTCRestStringMapBase::putCopyWorker(const char *a_pszKey, RTCRestObjectBase const &a_rValue, bool a_fReplace,
+                                        size_t a_cchKey /*= RTSTR_MAX*/)
 {
     int rc;
@@ -353 +394 @@
     if (pValueCopy)
     {
-        rc = putWorker(a_pszKey, pValueCopy, a_fReplace);
+        rc = putWorker(a_pszKey, pValueCopy, a_fReplace, a_cchKey);
         if (RT_SUCCESS(rc))
         { /* likely */ }

trunk/src/VBox/Runtime/common/rest/rest-primary-object-types.cpp

@@ -118 +118 @@
 
 
+RTCRestObjectBase::kTypeClass RTCRestObjectBase::typeClass() const
+{
+    return kTypeClass_Object;
+}
+
+
 /*********************************************************************************************************************************
 *   RTCRestBool implementation                                                                                                   *
@@ -277 +283 @@
 
 
-const char *RTCRestBool::getType()
+RTCRestObjectBase::kTypeClass RTCRestBool::typeClass() const
+{
+    return kTypeClass_Bool;
+}
+
+
+const char *RTCRestBool::typeName() const
 {
     return "bool";
@@ -434 +446 @@
 
 
-const char *RTCRestInt64::getType()
+RTCRestObjectBase::kTypeClass RTCRestInt64::typeClass() const
+{
+    return kTypeClass_Int64;
+}
+
+
+const char *RTCRestInt64::typeName() const
 {
     return "int64_t";
@@ -597 +615 @@
 
 
-const char *RTCRestInt32::getType()
+RTCRestObjectBase::kTypeClass RTCRestInt32::typeClass() const
+{
+    return kTypeClass_Int32;
+}
+
+
+const char *RTCRestInt32::typeName() const
 {
     return "int32_t";
@@ -760 +784 @@
 
 
-const char *RTCRestInt16::getType()
+RTCRestObjectBase::kTypeClass RTCRestInt16::typeClass() const
+{
+    return kTypeClass_Int16;
+}
+
+
+const char *RTCRestInt16::typeName() const
 {
     return "int16_t";
@@ -920 +950 @@
 
 
-const char *RTCRestDouble::getType()
+RTCRestObjectBase::kTypeClass RTCRestDouble::typeClass() const
+{
+    return kTypeClass_Double;
+}
+
+
+const char *RTCRestDouble::typeName() const
 {
     return "double";
@@ -1071 +1107 @@
 
 
-const char *RTCRestString::getType()
+RTCRestObjectBase::kTypeClass RTCRestString::typeClass() const
+{
+    return kTypeClass_String;
+}
+
+
+const char *RTCRestString::typeName() const
 {
     return "RTCString";