HttpResponse.h

Go to the documentation of this file.

/****
 * Sming Framework Project - Open Source framework for high efficiency native ESP8266 development.
 * Created 2015 by Skurydin Alexey
 * http://github.com/SmingHub/Sming
 * All files of the Sming Core are provided under the LGPL v3 license.
 *
 * HttpResponse.h
 *
 * @author: 2017 - Slavey Karadzhov <slav@attachix.com>
 *
 ****/

#pragma once

#include "HttpCommon.h"
#include "Data/Stream/ReadWriteStream.h"
#include "HttpHeaders.h"
#include "FileSystem.h"

class HttpResponse
{
public:
    ~HttpResponse()
    {
        freeStreams();
    }

    bool sendString(const String& text);

    bool sendString(String&& text) noexcept;

    bool hasHeader(const String& name) SMING_DEPRECATED
    {
        return headers.contains(name);
    }

    void redirect(const String& location) SMING_DEPRECATED
    {
        headers[HTTP_HEADER_LOCATION] = location;
    }

    void forbidden() SMING_DEPRECATED
    {
        code = HTTP_STATUS_FORBIDDEN;
    }

    void notFound() SMING_DEPRECATED
    {
        code = HTTP_STATUS_NOT_FOUND;
    }

    HttpResponse* setContentType(const String& type)
    {
        headers[HTTP_HEADER_CONTENT_TYPE] = type;
        return this;
    }

    HttpResponse* setContentType(enum MimeType type)
    {
        return setContentType(::toString(type));
    }

    HttpResponse* setCookie(const String& name, const String& value, bool append = false);

    HttpResponse* setHeader(const String& name, const String& value)
    {
        headers[name] = value;
        return this;
    }

    HttpResponse* setCache(int maxAgeSeconds = 3600, bool isPublic = false);

    // Access-Control-Allow-Origin for AJAX from a different domain
    HttpResponse* setAllowCrossDomainOrigin(const String& controlAllowOrigin)
    {
        headers[HTTP_HEADER_ACCESS_CONTROL_ALLOW_ORIGIN] = controlAllowOrigin;
        return this;
    }

    /*
     * Send file by stat, indicates whether file is compressed
     * A name is required in stat to get the appropriate content type
     */
    bool sendFile(const FileStat& stat);

    bool sendFile(const String& fileName, bool allowGzipFileCheck = true);

    bool sendTemplate(IDataSourceStream* newTemplateInstance) SMING_DEPRECATED
    {
        return sendNamedStream(newTemplateInstance);
    }

    bool sendNamedStream(IDataSourceStream* newDataStream);

    bool sendDataStream(IDataSourceStream* newDataStream, enum MimeType type)
    {
        return sendDataStream(newDataStream, ::toString(type));
    }

    bool sendDataStream(IDataSourceStream* newDataStream, const String& reqContentType = nullptr);

    String getBody()
    {
        String s;
        if(stream != nullptr) {
            stream->moveString(s);
        }
        return s;
    }

    void reset();

    void setBuffer(ReadWriteStream* buffer);

    void freeStreams();

    bool isSuccess()
    {
        return (code >= HTTP_STATUS_OK && code < HTTP_STATUS_BAD_REQUEST);
    }

    String toString() const;

    static String toString(const HttpResponse& res) SMING_DEPRECATED
    {
        return res.toString();
    }

private:
    void setStream(IDataSourceStream* stream);

public:
    HttpStatus code = HTTP_STATUS_OK; 
    HttpHeaders headers;
    ReadWriteStream* buffer = nullptr;   
    IDataSourceStream* stream = nullptr; 
};

inline String toString(const HttpResponse& res)
{
    return res.toString();
}