WebAdmin.h

Go to the documentation of this file.

// WebAdmin.h

// Declares the cWebAdmin class representing the admin interface over http protocol, and related services (API)

#pragma once

#include "Bindings/LuaState.h"
#include "IniFile.h"
#include "HTTP/HTTPServer.h"
#include "HTTP/HTTPMessage.h"





// Disable MSVC warnings:
#if defined(_MSC_VER)
    #pragma warning(push)
    #pragma warning(disable:4355)  // 'this' : used in base member initializer list
#endif





// tolua_begin
struct HTTPFormData
{
    std::string Name;
    std::string Value;
    std::string Type;
} ;
// tolua_end




// tolua_begin
struct HTTPRequest
{
    typedef std::map< std::string, std::string > StringStringMap;
    typedef std::map< std::string, HTTPFormData > FormDataMap;

    AString URL;

    AString Method;

    AString Path;

    AString Username;

    // tolua_end

    StringStringMap Params;     // >> EXPORTED IN MANUALBINDINGS <<

    StringStringMap PostParams;  // >> EXPORTED IN MANUALBINDINGS <<

    FormDataMap FormData;       // >> EXPORTED IN MANUALBINDINGS <<
} ;  // tolua_export





// tolua_begin
struct HTTPTemplateRequest
{
    HTTPRequest Request;
} ;
// tolua_end





struct sWebAdminPage
{
    AString Content;
    AString PluginName;
    AString TabTitle;
    AString TabUrlPath;
    AString ContentType;
};





// tolua_begin
class cWebAdmin :
    // tolua_end
    public cHTTPServer::cCallbacks
    // tolua_begin
{
public:
    // tolua_end

    class cWebTabCallback abstract
    {
    public:
        // Force a virtual destructor in descendants
        virtual ~cWebTabCallback() {}

        virtual bool Call(
            const HTTPRequest & a_Request,
            const AString & a_UrlPath,
            AString & a_Content,
            AString & a_ContentType
        ) = 0;
    };


    class cWebTab
    {
    public:
        AString m_Title;
        AString m_UrlPath;
        AString m_PluginName;
        std::shared_ptr<cWebTabCallback> m_Callback;

        cWebTab(const AString & a_Title, const AString & a_UrlPath, const AString & a_PluginName, std::shared_ptr<cWebTabCallback> a_Callback):
            m_Title(a_Title),
            m_UrlPath(a_UrlPath),
            m_PluginName(a_PluginName),
            m_Callback(a_Callback)
        {
        }
    };
    typedef std::shared_ptr<cWebTab> cWebTabPtr;
    typedef std::vector<cWebTabPtr> cWebTabPtrs;


    cWebAdmin(void);
    virtual ~cWebAdmin() override;

    bool Init(void);

    bool Start(void);

    void Stop(void);

    bool LoadLoginPage(void);

    cWebTabPtrs GetAllWebTabs(void) { return m_WebTabs; }

    void RemoveAllPluginWebTabs(const AString & a_PluginName);

    sWebAdminPage GetPage(const HTTPRequest & a_Request);

    // tolua_begin

    void Reload(void);

    AString GetPorts(void) const { return StringsConcat(m_Ports, ','); }

    static AString GetBaseURL(const AString & a_URL);

    static AString GetContentTypeFromFileExt(const AString & a_FileExtension);

    static AString GetHTMLEscapedString(const AString & a_Input);
    // tolua_end

    void AddWebTab(
        const AString & a_Title,
        const AString & a_UrlPath,
        const AString & a_PluginName,
        std::shared_ptr<cWebTabCallback> a_Callback
    );

    bool DelWebTab(const AString & a_UrlPath);

    static AString GetURLEncodedString(const AString & a_Input);

    static AString GetBaseURL(const AStringVector & a_URLSplit);

protected:

    cCriticalSection m_CS;

    cWebTabPtrs m_WebTabs;

    cLuaState m_TemplateScript;

    AString m_LoginPage;

    cIniFile m_IniFile;

    bool m_IsInitialized;

    bool m_IsRunning;

    AStringVector m_Ports;

    cHTTPServer m_HTTPServer;


    bool LoadIniFile(void);

    void HandleWebadminRequest(cHTTPServerConnection & a_Connection, cHTTPIncomingRequest & a_Request);

    void HandleRootRequest(cHTTPServerConnection & a_Connection, cHTTPIncomingRequest & a_Request);

    void HandleFileRequest(cHTTPServerConnection & a_Connection, cHTTPIncomingRequest & a_Request);

    // cHTTPServer::cCallbacks overrides:
    virtual void OnRequestBegun   (cHTTPServerConnection & a_Connection, cHTTPIncomingRequest & a_Request) override;
    virtual void OnRequestBody    (cHTTPServerConnection & a_Connection, cHTTPIncomingRequest & a_Request, const char * a_Data, size_t a_Size) override;
    virtual void OnRequestFinished(cHTTPServerConnection & a_Connection, cHTTPIncomingRequest & a_Request) override;
} ;  // tolua_export





// Revert MSVC warnings back to orignal state:
#if defined(_MSC_VER)
    #pragma warning(pop)
#endif