Changeset 74250 in vbox for trunk/include/iprt/cpp

Timestamp:

Sep 13, 2018 4:33:17 PM (6 years ago)

Author:

vboxsync

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

125044

Message:

IRPT/rest,http: Use header callbacks for capturing header values in responses. Removed [P]FNCREATEINSTANCE as it isn't needed any more (and it didn't work like expected for RTCRestString). Some HTTP header callback updates. bugref:9167

Location:

trunk/include/iprt/cpp

Files:

• restbase.h (modified) (1 diff)
• restclient.h (modified) (5 diffs)

trunk/include/iprt/cpp/restbase.h

@@ -386 +386 @@
      */
     virtual const char *typeName(void) const = 0;
-
-    /**
-     * Factory method.
-     * @returns Pointer to new object on success, NULL if out of memory.
-     */
-    typedef DECLCALLBACK(RTCRestObjectBase *) FNCREATEINSTANCE(void);
-    /** Pointer to factory method. */
-    typedef FNCREATEINSTANCE *PFNCREATEINSTANCE;
 
 protected:

trunk/include/iprt/cpp/restclient.h

@@ -29 +29 @@
 #include <iprt/http.h>
 #include <iprt/cpp/restbase.h>
+#include <iprt/cpp/reststringmap.h>
 
 
@@ -463 +464 @@
      * This may install callbacks and such like.
      *
+     * When overridden, the parent class must always be called.
+     *
      * @returns IPRT status code.
      * @param   a_hHttp     The HTTP handle to prepare for receiving.
-     * @param   a_pppvHdr   If a header callback handler is installed, set the value pointed to to NULL.
-     * @param   a_pppvBody  If a body callback handler is installed, set the value pointed to to NULL.
-     */
-    virtual int receivePrepare(RTHTTP a_hHttp, void ***a_pppvHdr, void ***a_pppvBody);
+     */
+    virtual int receivePrepare(RTHTTP a_hHttp);
 
     /**
@@ -478 +479 @@
      *                      which case it is possible receivePrepare() wasn't called.
      *
-     * @note    Called before consumeHeaders() and consumeBody().
+     * @note    Called before consumeBody() but after consumeHeader().
      */
     virtual void receiveComplete(int a_rcStatus, RTHTTP a_hHttp);
 
     /**
-     * Callback that consumes HTTP header data from the server.
+     * Callback that consumes HTTP body data from the server.
      *
      * @param   a_pchData  Body data.
      * @param   a_cbData   Amount of body data.
      *
-     * @note    Called after receiveComplete()..
-     */
-    virtual void consumeHeaders(const char *a_pchData, size_t a_cbData);
-
-    /**
-     * Callback that consumes HTTP body data from the server.
-     *
-     * @param   a_pchData  Body data.
-     * @param   a_cbData   Amount of body data.
-     *
-     * @note    Called after consumeHeaders().
+     * @note    Called after consumeHeader().
      */
     virtual void consumeBody(const char *a_pchData, size_t a_cbData);
@@ -559 +550 @@
     int addError(int a_rc, const char *a_pszFormat, ...);
 
-    /** Field flags. */
-    enum
-    {
-        /** Collection map, name is a prefix followed by '*'. */
-        kHdrField_MapCollection   = RT_BIT_32(24)
-    };
-
-    /** Header field descriptor. */
-    typedef struct
-    {
-        /** The header field name. */
-        const char *pszName;
-        /** The length of the field name.*/
-        uint32_t    cchName;
-        /** Flags, TBD. */
-        uint32_t    fFlags;
-        /** Object factory. */
-        RTCRestObjectBase::PFNCREATEINSTANCE pfnCreateInstance;
-    } HEADERFIELDDESC;
-
-    /**
-     * Helper that extracts fields from the HTTP headers.
-     *
-     * @param   a_paFieldDescs      Pointer to an array of field descriptors.
-     * @param   a_pappFieldValues   Pointer to a parallel array of value pointer pointers.
-     * @param   a_cFields           Number of field descriptors..
-     * @param   a_pchData           The header blob to search.
-     * @param   a_cbData            The size of the header blob to search.
-     */
-    void extractHeaderFieldsFromBlob(HEADERFIELDDESC const *a_paFieldDescs, RTCRestObjectBase ***a_pappFieldValues,
-                                     size_t a_cFields, const char *a_pchData, size_t a_cbData);
-
-    /**
-     * Helper that extracts a header field.
-     *
-     * @retval  VINF_SUCCESS
-     * @retval  VERR_NOT_FOUND if not found.
-     * @retval  VERR_NO_STR_MEMORY
-     * @param   a_pszField  The header field header name.
-     * @param   a_cchField  The length of the header field name.
-     * @param   a_pchData   The header blob to search.
-     * @param   a_cbData    The size of the header blob to search.
-     * @param   a_pStrDst   Where to store the header value on successs.
-     */
-    int extractHeaderFromBlob(const char *a_pszField, size_t a_cchField, const char *a_pchData, size_t a_cbData,
-                              RTCString *a_pStrDst);
+    /**
+     * Deserializes a header field value.
+     *
+     * @returns IPRT status code.
+     * @param   a_pObj              The object to deserialize into.
+     * @param   a_pchValue          Pointer to the value (not zero terminated).
+     *                              Not necessarily valid UTF-8!
+     * @param   a_cchValue          The value length.
+     * @param   a_fFlags            Flags to pass to fromString().
+     * @param   a_pszErrorTag       The error tag (field name).
+     */
+    int deserializeHeader(RTCRestObjectBase *a_pObj, const char *a_pchValue, size_t a_cchValue,
+                          uint32_t a_fFlags, const char *a_pszErrorTag);
+
+    /**
+     * Deserializes a header field value.
+     *
+     * @returns IPRT status code.
+     * @param   a_pMap              The string map object to deserialize into.
+     * @param   a_pchField          Pointer to the map field name.  (Caller dropped the prefix.)
+     *                              Not necessarily valid UTF-8!
+     * @param   a_cchField          Length of field name.
+     * @param   a_pchValue          Pointer to the value (not zero terminated).
+     *                              Not necessarily valid UTF-8!
+     * @param   a_cchValue          The value length.
+     * @param   a_fFlags            Flags to pass to fromString().
+     * @param   a_pszErrorTag       The error tag (field name).
+     */
+    int deserializeHeaderIntoMap(RTCRestStringMapBase *a_pMap, const char *a_pchField, size_t a_cchField,
+                                 const char *a_pchValue, size_t a_cchValue, uint32_t a_fFlags, const char *a_pszErrorTag);
 
     /**
@@ -626 +601 @@
         virtual int unknownField(RTCRestJsonCursor const &a_rCursor) RT_OVERRIDE;
     };
+
+
+    /**
+     * Consumes a header.
+     *
+     * Child classes can override this to pick up their header fields, but must
+     * always call the parent class.
+     *
+     * @returns IPRT status code.
+     * @param   a_uMatchWord    Match word constructed by RTHTTP_MAKE_HDR_MATCH_WORD
+     * @param   a_pchField      The field name (not zero terminated).
+     *                          Not necessarily valid UTF-8!
+     * @param   a_cchField      The length of the field.
+     * @param   a_pchValue      The field value (not zero terminated).
+     * @param   a_cchValue      The length of the value.
+     */
+    virtual int consumeHeader(uint32_t a_uMatchWord, const char *a_pchField, size_t a_cchField,
+                              const char *a_pchValue, size_t a_cchValue);
+
+private:
+    /** Callback for use with RTHttpSetHeaderCallback. */
+    static FNRTHTTPHEADERCALLBACK receiveHttpHeaderCallback;
 };