RegExWebEnginePage.h

/*
 * Copyright (C) 2020 Adrian Carpenter
 *
 * This file is part of a regex101.com offline application.
 *
 * https://github.com/fizzyade/regex101
 *
 * =====================================================================
 * The regex101 web content is owned and used with permission from
 * Firas Dib at regex101.com.  This application is an unofficial
 * tool to provide an offline application version of the website.
 * =====================================================================
 *
 * This program is free software: you can redistribute it and/or modify
 * it under the terms of the GNU General Public License as published by
 * the Free Software Foundation, either version 3 of the License, or
 * (at your option) any later version.
 *
 * This program is distributed in the hope that it will be useful,
 * but WITHOUT ANY WARRANTY; without even the implied warranty of
 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
 * GNU General Public License for more details.
 *
 * You should have received a copy of the GNU General Public License
 * along with this program.  If not, see <http://www.gnu.org/licenses/>.
 */

#ifndef REGEXWEBENGINEPAGE_H
#define REGEXWEBENGINEPAGE_H

#include "RegExApiEndpoint.h"
#include "RegExUrlRequestInterceptor.h"
#include "RegExWebEngineProfile.h"
#include <QWebEnginePage>

class QWebChannel;

namespace Nedrysoft {
    /**
     * @brief               RegExWebEnginePage class.
     *
     * @details             This subclass provides a web page that is set up to use the handlers,
     *                      interceptors and web channels.
     */
    class RegExWebEnginePage :
            public QWebEnginePage
    {
        private:
            Q_OBJECT

        public:
            /**
             * @brief           Constructs a web engine page.
             */
            RegExWebEnginePage();

            /**
             * @brief           Destroys the web engine page.
             */
            ~RegExWebEnginePage();

        protected:
            /**
             * @brief           javaScriptConsoleMessage
             *
             * @details         This overridden function allows debug information from the console.log functions
             *                  to be obtained.
             *
             * @param[in]       level is the level of message.
             * @param[in]       message is the content of the message sent via javascript.
             * @param[in]       lineNumber is the number of the line that caused the output.
             * @param[in]       sourceID is the identifier of the source of the message.
             */
            virtual void javaScriptConsoleMessage(JavaScriptConsoleMessageLevel level, const QString& message, int lineNumber, const QString& sourceID) override;

            /**
             * @brief           javaScriptAlert
             *
             * @details         This overridden function allows javascript alerts to be handled.
             *
             * @param[in]       securityOrigin is the origin which is considered secure.
             * @param[in]       msg is the alert message.
             */
            void javaScriptAlert(const QUrl &securityOrigin, const QString &msg) override;

            /**
             * @brief           acceptNavigationRequest
             *
             * @details         Allows or blocks requests that are send by the page
             *
             * @param[in]       url is the url to be navigated to.
             * @param[in]       type is the type of request, click etc.
             * @param[in]       isMainFrame is true if this is the main browser; otherwise false.
             *
             * @returns         true if the navigation is allowed; otherwise false.
             */
            bool acceptNavigationRequest(const QUrl &url, QWebEnginePage::NavigationType type, bool isMainFrame) override;

            /**
             * @brief           createWindow
             *
             * @details         Called when a new window is to be opened.
             *
             * @param[in]       type is the type of request, click etc.
             * @param[in]       isMainFrame is true if this is the main browser; otherwise false.
             *
             * @returns         a pointer to the new page page; otherwise null to deny the request.
             */
            QWebEnginePage *createWindow(QWebEnginePage::WebWindowType type) override;

        private:
            Nedrysoft::RegExUrlRequestInterceptor *m_urlInterceptor;            //! url interceptor object to block everything other than our scheme
            RegExWebEngineProfile *m_profile;                                   //! profile object with access settings for our scheme
            QWebChannel *m_apiChannel;                                          //! channel object to pass functions between c++ & javascript
    };
}

#endif // REGEXWEBENGINEPAGE_H