mythhttpresponse.h

Go to the documentation of this file.

#ifndef MYTHHTTPRESPONSE_H
#define MYTHHTTPRESPONSE_H
 
// Std
#include <vector>
 
// MythTV
#include "libmythbase/http/mythhttpdata.h"
#include "libmythbase/http/mythhttpfile.h"
#include "libmythbase/http/mythhttprequest.h"
#include "libmythbase/http/mythhttptypes.h"
#include "libmythbase/http/mythwebsockettypes.h"
 
class QTcpSocket;
 
class MBASE_PUBLIC MythHTTPResponse
{
  public:
    MythHTTPResponse() = default;
    explicit MythHTTPResponse(const HTTPRequest2& Request);
 
    static HTTPResponse HandleOptions       (const HTTPRequest2& Request);
    static HTTPResponse ErrorResponse       (MythHTTPStatus Status, const QString& ServerName);
    static HTTPResponse RedirectionResponse (const HTTPRequest2& Request, const QString& Redirect);
    static HTTPResponse ErrorResponse       (const HTTPRequest2& Request, const QString& Message = {});
    static HTTPResponse OptionsResponse     (const HTTPRequest2& Request);
    static HTTPResponse DataResponse        (const HTTPRequest2& Request, const HTTPData& Data);
    static HTTPResponse FileResponse        (const HTTPRequest2& Request, const HTTPFile& File);
    static HTTPResponse EmptyResponse       (const HTTPRequest2& Request);
    static HTTPResponse UpgradeResponse     (const HTTPRequest2& Request, MythSocketProtocol& Protocol, bool& Testing);
 
    void Finalise  (const MythHTTPConfig& Config);
    template <class T>
    std::enable_if_t<std::is_convertible_v<T, QString>
#if QT_VERSION < QT_VERSION_CHECK(5,14,0)
                         && !std::is_same_v<T, QByteArray>
#endif
        , void>
    AddHeader (const QString& key, const T& val)
    {
        QByteArray bytes = QString("%1: %2\r\n").arg(key, val).toUtf8();
        m_responseHeaders.emplace_back(MythHTTPData::Create(bytes));
    }
    template <class T>
    std::enable_if_t<!std::is_convertible_v<T, QString>, void>
    AddHeader (const QString& key, T val)
    {
        QByteArray bytes = QString("%1: %2\r\n").arg(key).arg(val).toUtf8();
        m_responseHeaders.emplace_back(MythHTTPData::Create(bytes));
    }
 
    QString             m_serverName;
    MythHTTPVersion     m_version         { HTTPOneDotOne };
    MythHTTPConnection  m_connection      { HTTPConnectionClose };
    std::chrono::milliseconds m_timeout   { HTTP_SOCKET_TIMEOUT_MS };
    MythHTTPStatus      m_status          { HTTPBadRequest };
    MythHTTPRequestType m_requestType     { HTTPGet };
    int                 m_allowed         { HTTP_DEFAULT_ALLOWED };
    HTTPHeaders         m_requestHeaders  { nullptr };
    HTTPContents        m_responseHeaders { };
    HTTPVariant         m_response        { std::monostate() };
 
  protected:
    void AddDefaultHeaders();
    void AddContentHeaders();
 
  private:
    Q_DISABLE_COPY(MythHTTPResponse)
};
 
#endif