httprequest.h

Go to the documentation of this file.

 
// Program Name: httprequest.h
// Created     : Oct. 21, 2005
//
// Purpose     : Http Request/Response
//
// Copyright (c) 2005 David Blain <dblain@mythtv.org>
//
// Licensed under the GPL v2 or later, see LICENSE for details
//
 
#ifndef HTTPREQUEST_H_
#define HTTPREQUEST_H_
 
#include <utility>
 
// Qt headers
#include <QBuffer>
#include <QDateTime>
#include <QFile>
#include <QRegularExpression>
#include <QTcpSocket>
#include <QTextStream>
 
// MythTV headers
#include "libmythbase/mythchrono.h"
#include "libmythbase/mythsession.h"
 
#include "upnpexp.h"
#include "upnputil.h"
#include "serializers/serializer.h"
 
static constexpr const char* SOAP_ENVELOPE_BEGIN
{ "<s:Envelope xmlns:s=\"http://schemas.xmlsoap.org/soap/envelope/\" " \
  "s:encodingStyle=\"http://schemas.xmlsoap.org/soap/encoding/\">"      \
  "<s:Body>" };
static constexpr const char* SOAP_ENVELOPE_END { "</s:Body>\r\n</s:Envelope>" };
 
 
// Typedefs / Defines
 
enum HttpRequestType : std::uint16_t
{
    RequestTypeUnknown      = 0x0000,
    // HTTP 1.1
    RequestTypeGet          = 0x0001,
    RequestTypeHead         = 0x0002,
    RequestTypePost         = 0x0004,
//     RequestTypePut          = 0x0008,
//     RequestTypeDelete       = 0x0010,
//     RequestTypeConnect      = 0x0020,
    RequestTypeOptions      = 0x0040,
//     RequestTypeTrace        = 0x0080, // SECURITY: XST attack risk, shouldn't include cookies or other sensitive info
    // UPnP
    RequestTypeMSearch      = 0x0100,
    RequestTypeSubscribe    = 0x0200,
    RequestTypeUnsubscribe  = 0x0400,
    RequestTypeNotify       = 0x0800,
    // Not a request type
    RequestTypeResponse     = 0x1000
 
};
 
enum HttpContentType : std::uint8_t
{
    ContentType_Unknown    = 0,
    ContentType_Urlencoded = 1,
    ContentType_XML        = 2,
    ContentType_JSON       = 3,
};
 
enum HttpResponseType : std::int8_t
{
    ResponseTypeNone     = -1,
    ResponseTypeUnknown  =  0,
    ResponseTypeXML      =  1,
    ResponseTypeHTML     =  2,
    ResponseTypeJS       =  3,
    ResponseTypeCSS      =  4,
    ResponseTypeText     =  5,
    ResponseTypeSVG      =  6,
    ResponseTypeFile     =  7,
    ResponseTypeOther    =  8,
    ResponseTypeHeader   =  9
};
 
struct MIMETypes
{
    const char *pszExtension;
    const char *pszType;
 
};
 
 
class IPostProcess
{
    public:
        virtual void ExecutePostProcess( ) = 0;
        virtual ~IPostProcess() = default;
};
 
//
 
class UPNP_PUBLIC HTTPRequest
{
    protected:
 
        static const char  *s_szServerHeaders;
 
        QRegularExpression  m_procReqLineExp    {"\\s+"};
        QRegularExpression  m_parseRangeExp     {"(\\d|\\-)"};
 
    public:
 
        HttpRequestType     m_eType             {RequestTypeUnknown};
        HttpContentType     m_eContentType      {ContentType_Unknown};
 
        QString             m_sRawRequest; // e.g. GET /foo/bar.html HTTP/1.1
 
        QString             m_sOriginalUrl; // Raw request URL before % decoded
        QString             m_sRequestUrl; // Raw request URL
        QString             m_sBaseUrl; // Path section of URL, without parameters
        QString             m_sResourceUrl; // Duplicate of Base URL!?
        QString             m_sMethod;
 
        QStringMap          m_mapParams;
        QStringMultiMap     m_mapHeaders;
        QStringMap          m_mapCookies;
 
        QString             m_sPayload;
 
        QString             m_sProtocol;
        int                 m_nMajor            {0};
        int                 m_nMinor            {0};
 
        bool                m_bProtected        {false};
        bool                m_bEncrypted        {false};
 
        bool                m_bSOAPRequest      {false};
        QString             m_sNameSpace;
 
        // Response
 
        HttpResponseType    m_eResponseType     {ResponseTypeUnknown};
        QString             m_sResponseTypeText;    // used for ResponseTypeOther
 
        long                m_nResponseStatus   {200};
        QStringMap          m_mapRespHeaders;
 
        QString             m_sFileName;
 
        QBuffer             m_response;
 
        IPostProcess       *m_pPostProcess      {nullptr};
 
        QString             m_sPrivateToken;
        MythUserSession     m_userSession;
 
    private:
 
        bool                m_bKeepAlive        {true};
        std::chrono::seconds m_nKeepAliveTimeout {0s};
 
    protected:
 
        HttpRequestType SetRequestType      ( const QString &sType  );
        void            SetRequestProtocol  ( const QString &sLine  );
        HttpContentType SetContentType      ( const QString &sType  );
 
        void            ProcessRequestLine  ( const QString &sLine  );
        bool            ProcessSOAPPayload  ( const QString &sSOAPAction );
        void            ExtractMethodFromURL( ); // Service method, not HTTP method
 
        QString         GetResponseStatus   ( void ) const;
        QString         GetResponseType     ( void ) const;
        QString         GetResponseHeaders  ( void );
 
        bool            ParseRange          ( QString sRange,
                                              long long   llSize,
                                              long long *pllStart,
                                              long long *pllEnd   );
 
        bool            ParseKeepAlive      ( void );
 
        void            ParseCookies        ( void );
 
        QString         BuildResponseHeader ( long long nSize );
 
        qint64          SendData            ( QIODevice *pDevice, qint64 llStart, qint64 llBytes );
        qint64          SendFile            ( QFile &file, qint64 llStart, qint64 llBytes );
 
        bool            IsProtected         () const { return m_bProtected; }
        bool            IsEncrypted         () const { return m_bEncrypted; }
        bool            Authenticated       ();
 
        QString         GetAuthenticationHeader (bool isStale = false);
        QString         CalculateDigestNonce ( const QString &timeStamp) const;
 
        bool            BasicAuthentication ();
        bool            DigestAuthentication ();
        void            AddCORSHeaders ( const QString &sOrigin );
 
    public:
 
                        HTTPRequest     () { m_response.open( QIODevice::ReadWrite ); }
        virtual        ~HTTPRequest     () = default;
 
        bool            ParseRequest    ();
 
        void            FormatErrorResponse ( bool  bServerError,
                                              const QString &sFaultString,
                                              const QString &sDetails );
 
        void            FormatActionResponse( Serializer *ser );
        void            FormatActionResponse( const NameValues &pArgs );
        void            FormatFileResponse  ( const QString &sFileName );
        void            FormatRawResponse   ( const QString &sXML );
 
        qint64          SendResponse    ( void );
        qint64          SendResponseFile( const QString& sFileName );
 
        void            SetResponseHeader ( const QString &sKey,
                                            const QString &sValue,
                                            bool replace = false );
 
        void            SetCookie ( const QString &sKey, const QString &sValue,
                                    const QDateTime &expiryDate,
                                    bool secure );
 
        QString         GetRequestHeader  ( const QString &sKey, const QString &sDefault );
 
        bool            GetKeepAlive () const { return m_bKeepAlive; }
 
        Serializer *    GetSerializer   ();
 
        QByteArray      GetResponsePage     ( void ); // Static response e.g. 400, 404, 501
 
        QString         GetRequestProtocol  () const;
        static QString         GetResponseProtocol () ;
 
        QString         GetRequestType () const;
        QString         GetLastHeader( const QString &sType ) const;
 
        static QString  GetMimeType     ( const QString &sFileExtension );
        static QStringList GetSupportedMimeTypes ();
        static QString  TestMimeType    ( const QString &sFileName );
        static long     GetParameters   ( QString  sParams, QStringMap &mapParams );
        static QString  Encode          ( const QString &sIn );
        static QString  Decode          ( const QString &sIn );
        static QString  GetETagHash     ( const QByteArray &data );
 
        void            SetKeepAliveTimeout ( std::chrono::seconds nTimeout ) { m_nKeepAliveTimeout = nTimeout; }
 
        static bool            IsUrlProtected      ( const QString &sBaseUrl );
 
        // ------------------------------------------------------------------
 
        virtual QString ReadLine        ( std::chrono::milliseconds msecs ) = 0;
        virtual qint64  ReadBlock       ( char *pData, qint64 nMaxLen, std::chrono::milliseconds msecs = 0ms ) = 0;
        virtual qint64  WriteBlock      ( const char *pData,
                                          qint64 nLen    ) = 0;
        virtual QString  GetHostName     ();  // RFC 3875 - The name in the client request
        virtual QString  GetHostAddress  () = 0;
        virtual quint16  GetHostPort     () = 0;
        virtual QString  GetPeerAddress  () = 0;
        virtual int      getSocketHandle () = 0;
};
 
//
 
class BufferedSocketDeviceRequest : public HTTPRequest
{
    public:
 
        QTcpSocket    *m_pSocket {nullptr};
 
    public:
 
        explicit BufferedSocketDeviceRequest( QTcpSocket *pSocket )
            : m_pSocket(pSocket) {}
        ~BufferedSocketDeviceRequest() override = default;
 
        QString  ReadLine        ( std::chrono::milliseconds msecs ) override; // HTTPRequest
        qint64   ReadBlock       ( char *pData, qint64 nMaxLen, std::chrono::milliseconds msecs = 0ms ) override; // HTTPRequest
        qint64   WriteBlock      ( const char *pData, qint64 nLen    ) override; // HTTPRequest
        QString  GetHostAddress  () override; // HTTPRequest
        quint16  GetHostPort     () override; // HTTPRequest
        QString  GetPeerAddress  () override; // HTTPRequest
        int      getSocketHandle () override // HTTPRequest
            {return( m_pSocket->socketDescriptor() ); }
 
};
 
//
 
class UPNP_PUBLIC HttpException
{
    public:
        int     m_code {-1};
        QString m_msg;
 
        explicit HttpException( int nCode = -1, QString sMsg = "")
               : m_code( nCode ), m_msg (std::move( sMsg  ))
        {}
 
        // Needed to force a v-table.
        virtual ~HttpException() = default;
};
 
class UPNP_PUBLIC HttpRedirectException : public HttpException
{
    public:
 
        QString m_hostName;
      //int     m_port;
 
        explicit HttpRedirectException( QString sHostName = "",
                                     int      nCode     = -1,
                               const QString &sMsg      = "" )
               : HttpException( nCode, sMsg ), m_hostName(std::move( sHostName ))
        {}
 
        ~HttpRedirectException() override = default;
 
};
 
#endif