YiHTTPResponse.h

Go to the documentation of this file.

// © You i Labs Inc. 2000-2017. All rights reserved.
#ifndef _YI_HTTP_RESPONSE_H_
#define _YI_HTTP_RESPONSE_H_

#include "binding/YiScriptableObject.h"
#include "thread/YiRecursiveMutex.h"
#include "utility/YiString.h"

#include <memory>

class CYIHTTPRequest;
class CYIUrl;

class CYIHTTPResponse : public CYIScriptableObject
{
public:
    enum CONTENT_TYPE
    {
        CONTENT_TYPE_TEXT,
        CONTENT_TYPE_IMAGE
    };
    
    enum CACHE_CONTROL_TYPE
    {
        CACHE_CONTROL_TYPE_NONE,
        CACHE_CONTROL_TYPE_PRIVATE,
        CACHE_CONTROL_TYPE_PUBLIC,
        CACHE_CONTROL_TYPE_NOCACHE
    };

    enum STATUS
    {
        DOWNLOADING,
        COMPLETED,
        FAILED,
        CANCELLED
    };

    CYIHTTPResponse();
    virtual ~CYIHTTPResponse();
    
    static size_t               ReceiveResponse(char *pBuffer, size_t nSize, size_t nNumBytes, void *pContext);
    static std::shared_ptr<CYIHTTPResponse> CreateFromBytes(char *pHeaders, size_t pHeadersSize, char *pResponse, size_t uResponseSize);

    void Reserve(uint32_t nSize) const;

    STATUS                      GetStatus() const;

    void                        SetStatus(STATUS eStatus);

    const std::vector<char> &   GetRawData() const;

    void SetRequestID(const int32_t id);

    uint32_t GetSize() const;

    int32_t GetHeaderHTTPStatusCode() const;

    CYIString                   GetBody() const;
    
    const CYIString            &GetHeader() const;

    const std::map<CYIString, CYIString> GetHeaders() const;

    bool                     IsCacheable() const;
    
    bool                     ShouldBeStored() const;
    
    int32_t GetMaxAgeInSeconds() const;

    int32_t GetExpiresInSeconds() const;

    const CYIString            &GetETagValue() const;
    
    CACHE_CONTROL_TYPE GetCacheControlType() const;

    CONTENT_TYPE                GetContentType() const;
    
    uint32_t GetContentLength() const;

    const CYIString            &GetContentEncoding() const;
    
    const CYIString            &GetLastModifiedDate() const;
    
    const CYIString            &GetResponseDate() const;

    bool                        IsHeuristicallyExpired() const;

    bool IsExpired() const;

    void Process(const std::shared_ptr<CYIHTTPRequest> &pRequest);

protected:
    void SetMaxAgeInSeconds(int32_t nMaxAge);
    void SetExpiresInSeconds(int32_t nExpires);
    void SetShouldStoreResponse(bool bStoreResponse);
    void SetETagValue(const CYIString &rETag);
    void SetContentType(CONTENT_TYPE eType);
    void SetCacheControlType(CACHE_CONTROL_TYPE eType);
    void SetContentEncoding(const CYIString &rContentEncoding);
    void SetLastModifiedDate(const CYIString &rLastModifiedDate);
    void SetResponseDate(const CYIString &rResponseDate);
    
private:
    void AppendData(char *pBuffer, size_t bufferSize);

    void ParseHeader(const CYIString &rHeader);
    void ParseHeaderKeyValue(const CYIString &rKey, const CYIString &rValue);
    
    void ParseCacheControlValue(const CYIString &rValue);
    void ParsePragmaValue(const CYIString &rValue);
    void ParseExpiresValue(const CYIString &rValue);
    void ParseContentType(const CYIString &rValue);
    void ParseContentLength(const CYIString &rValue);

    int32_t SplitPropKeyValue(const CYIString &rString, CYIString &rKey, CYIString &rValue);

    mutable CYIRecursiveMutex m_mutex;

    mutable int32_t m_nHeaderHTTPStatusCode;

    // HTTP response buffer
    mutable std::vector<char>       m_responseBuffer;

    CYIString                       m_HTTPResponseHeader;
    const char *m_HTTPResponseBody; // for viewing in a debugger only

    int32_t m_nRequestId;

    int32_t m_nMaxAgeInSeconds;
    int32_t m_nExpiresInSeconds;
    bool                            m_bShouldBeStored;
    CYIString                       m_eTag;
    CONTENT_TYPE                    m_eContentType;
    uint32_t m_uContentLength;
    CACHE_CONTROL_TYPE              m_eCacheControlType;
    CYIString                       m_ContentEncoding;
    CYIString                       m_LastModifiedDate;
    CYIString                       m_ResponseDate;
    STATUS                          m_eStatus;
};

#endif // _YI_HTTP_RESPONSE_H_