WebBrowser/WebBrowserPage.py

# -*- coding: utf-8 -*-

# Copyright (c) 2008 - 2016 Detlev Offenbach <detlev@die-offenbachs.de>
#


"""
Module implementing the helpbrowser using QWebView.
"""

from __future__ import unicode_literals
try:
    str = unicode       # __IGNORE_EXCEPTION__
except NameError:
    pass

from PyQt5.QtCore import pyqtSlot, pyqtSignal, QObject, QT_TRANSLATE_NOOP, \
    QUrl, QBuffer, QIODevice, QFileInfo, Qt, QTimer, QEvent, \
    QRect, QFile, QPoint, QByteArray, QEventLoop, qVersion
from PyQt5.QtGui import QDesktopServices, QClipboard, QMouseEvent, QColor, \
    QPalette
from PyQt5.QtWidgets import qApp, QStyle, QMenu, QApplication, QInputDialog, \
    QLineEdit, QLabel, QToolTip, QFrame, QDialog
from PyQt5.QtPrintSupport import QPrinter, QPrintDialog
from PyQt5.QtWebEngineWidgets import QWebEnginePage
from PyQt5.QtWebChannel import QWebChannel
from PyQt5.QtNetwork import QNetworkReply, QNetworkRequest
import sip

from E5Gui import E5MessageBox, E5FileDialog

import WebBrowser
from WebBrowser.WebBrowserWindow import WebBrowserWindow

from .JavaScript.ExternalJsObject import ExternalJsObject

from .Tools.WebHitTestResult import WebHitTestResult
from .Tools import Scripts

import Preferences
import UI.PixmapCache
import Globals
##
##try:
##    from PyQt5.QtNetwork import QSslCertificate
##    SSL_AVAILABLE = True
##except ImportError:
##    SSL_AVAILABLE = False


class WebBrowserPage(QWebEnginePage):
    """
    Class implementing an enhanced web page.
    """
##    _webPluginFactory = None
##    
    def __init__(self, parent=None):
        """
        Constructor
        
        @param parent parent widget of this window (QWidget)
        """
        super(WebBrowserPage, self).__init__(
            WebBrowserWindow.webProfile(), parent)
        
        self.__setupWebChannel()
        
##        self.setPluginFactory(self.webPluginFactory())
##        
##        self.__lastRequest = None
##        self.__lastRequestType = QWebPage.NavigationTypeOther
##        
##        from .Network.NetworkAccessManagerProxy import \
##            NetworkAccessManagerProxy
##        self.__proxy = NetworkAccessManagerProxy(self)
##        self.__proxy.setWebPage(self)
##        self.__proxy.setPrimaryNetworkAccessManager(
##            WebBrowserWindow.networkManager())
##        self.setNetworkAccessManager(self.__proxy)
##        
##        self.__sslConfiguration = None
##        self.__proxy.finished.connect(self.__managerFinished)
##        
##        self.__adBlockedEntries = []
##        self.loadStarted.connect(self.__loadStarted)
        self.featurePermissionRequested.connect(
            self.__featurePermissionRequested)
        
        self.authenticationRequired.connect(
            WebBrowserWindow.networkManager().authentication)
        
        self.proxyAuthenticationRequired.connect(
            WebBrowserWindow.networkManager().proxyAuthentication)
        
        self.fullScreenRequested.connect(self.__fullScreenRequested)
    
    def acceptNavigationRequest(self, url, type_, isMainFrame):
        """
        Public method to determine, if a request may be accepted.
        
        @param url URL to navigate to
        @type QUrl
        @param type_ type of the navigation request
        @type QWebEnginePage.NavigationType
        @param isMainFrame flag indicating, that the request originated from
            the main frame
        @type bool
        @return flag indicating acceptance
        @rtype bool
        """
##        self.__lastRequest = request
##        if self.__lastRequest.url() != request.url() or \
##           type_ != QWebPage.NavigationTypeOther:
##            self.__lastRequestType = type_
        
        # TODO: Qt 5.6: move to handleUnknownProtocol
        scheme = url.scheme()
        if scheme == "mailto":
            QDesktopServices.openUrl(url)
            return False
        
        # AdBlock
        if url.scheme() == "abp":
            if WebBrowserWindow.adBlockManager().addSubscriptionFromUrl(url):
                return False
        
##        
##        if type_ == QWebPage.NavigationTypeFormResubmitted:
##            res = E5MessageBox.yesNo(
##                self.view(),
##                self.tr("Resending POST request"),
##                self.tr(
##                    """In order to display the site, the request along with"""
##                    """ all the data must be sent once again, which may lead"""
##                    """ to some unexpected behaviour of the site e.g. the"""
##                    """ same action might be performed once again. Do you"""
##                    """ want to continue anyway?"""),
##                icon=E5MessageBox.Warning)
##            if not res:
##                return False
        
        return QWebEnginePage.acceptNavigationRequest(self, url, type_,
                                                      isMainFrame)
##    
##    def populateNetworkRequest(self, request):
##        """
##        Public method to add data to a network request.
##        
##        @param request reference to the network request object
##            (QNetworkRequest)
##        """
##        try:
##            request.setAttribute(QNetworkRequest.User + 100, self)
##            if self.__lastRequest.url() == request.url():
##                request.setAttribute(QNetworkRequest.User + 101,
##                                     self.__lastRequestType)
##                if self.__lastRequestType == \
##                        QWebPage.NavigationTypeLinkClicked:
##                    request.setRawHeader(b"X-Eric6-UserLoadAction",
##                                         QByteArray(b"1"))
##        except TypeError:
##            pass
##    
##    def pageAttributeId(self):
##        """
##        Public method to get the attribute id of the page attribute.
##        
##        @return attribute id of the page attribute (integer)
##        """
##        return QNetworkRequest.User + 100
##    
##    def supportsExtension(self, extension):
##        """
##        Public method to check the support for an extension.
##        
##        @param extension extension to test for (QWebPage.Extension)
##        @return flag indicating the support of extension (boolean)
##        """
##        try:
##            if extension in [QWebPage.ErrorPageExtension,
##                             QWebPage.ChooseMultipleFilesExtension]:
##                return True
##        except AttributeError:
##            pass
##        
##        return QWebPage.supportsExtension(self, extension)
##    
##    def extension(self, extension, option, output):
##        """
##        Public method to implement a specific extension.
##        
##        @param extension extension to be executed (QWebPage.Extension)
##        @param option provides input to the extension
##            (QWebPage.ExtensionOption)
##        @param output stores the output results (QWebPage.ExtensionReturn)
##        @return flag indicating a successful call of the extension (boolean)
##        """
##        if extension == QWebPage.ChooseMultipleFilesExtension:
##            info = sip.cast(option,
##                            QWebPage.ChooseMultipleFilesExtensionOption)
##            files = sip.cast(output,
##                             QWebPage.ChooseMultipleFilesExtensionReturn)
##            if info is None or files is None:
##                return super(HelpWebPage, self).extension(
##                    extension, option, output)
##            
##            suggestedFileName = ""
##            if info.suggestedFileNames:
##                suggestedFileName = info.suggestedFileNames[0]
##            
##            files.fileNames = E5FileDialog.getOpenFileNames(
##                None,
##                self.tr("Select files to upload..."),
##                suggestedFileName)
##            return True
##        
##        if extension == QWebPage.ErrorPageExtension:
##            info = sip.cast(option, QWebPage.ErrorPageExtensionOption)
##            
##            errorPage = sip.cast(output, QWebPage.ErrorPageExtensionReturn)
##            urlString = bytes(info.url.toEncoded()).decode()
##            errorPage.baseUrl = info.url
##            if info.domain == QWebPage.QtNetwork and \
##               info.error == QNetworkReply.ProtocolUnknownError:
##                url = QUrl(info.url)
##                res = E5MessageBox.yesNo(
##                    None,
##                    self.tr("Protocol Error"),
##                    self.tr("""Open external application for {0}-link?\n"""
##                            """URL: {1}""").format(
##                        url.scheme(), url.toString(
##                            QUrl.PrettyDecoded | QUrl.RemovePassword)),
##                    yesDefault=True)
##                
##                if res:
##                    QDesktopServices.openUrl(url)
##                return True
##            elif info.domain == QWebPage.QtNetwork and \
##                info.error == QNetworkReply.ContentAccessDenied and \
##                    info.errorString.startswith("AdBlockRule:"):
##                if info.frame != info.frame.page().mainFrame():
##                    # content in <iframe>
##                    docElement = info.frame.page().mainFrame()\
##                        .documentElement()
##                    for element in docElement.findAll("iframe"):
##                        src = element.attribute("src")
##                        if src in info.url.toString():
##                            element.setAttribute("style", "display:none;")
##                    return False
##                else:
##                    # the whole page is blocked
##                    rule = info.errorString.replace("AdBlockRule:", "")
##                    title = self.tr("Content blocked by AdBlock Plus")
##                    message = self.tr(
##                        "Blocked by rule: <i>{0}</i>").format(rule)
##                    
##                    htmlFile = QFile(":/html/adblockPage.html")
##                    htmlFile.open(QFile.ReadOnly)
##                    html = htmlFile.readAll()
##                    html = html.replace(
##                        "@FAVICON@", "qrc:icons/adBlockPlus16.png")
##                    html = html.replace(
##                        "@IMAGE@", "qrc:icons/adBlockPlus64.png")
##                    html = html.replace("@TITLE@", title.encode("utf8"))
##                    html = html.replace("@MESSAGE@", message.encode("utf8"))
##                    errorPage.content = html
##                    return True
##            
##            if info.domain == QWebPage.QtNetwork and \
##               info.error == QNetworkReply.OperationCanceledError and \
##               info.errorString == "eric6:No Error":
##                return False
##            
##            if info.domain == QWebPage.WebKit and info.error == 203:
##                # "Loading is handled by the media engine"
##                return False
##            
##            title = self.tr("Error loading page: {0}").format(urlString)
##            htmlFile = QFile(":/html/notFoundPage.html")
##            htmlFile.open(QFile.ReadOnly)
##            html = htmlFile.readAll()
##            pixmap = qApp.style()\
##                .standardIcon(QStyle.SP_MessageBoxWarning).pixmap(48, 48)
##            imageBuffer = QBuffer()
##            imageBuffer.open(QIODevice.ReadWrite)
##            if pixmap.save(imageBuffer, "PNG"):
##                html = html.replace("@IMAGE@", imageBuffer.buffer().toBase64())
##            pixmap = qApp.style()\
##                .standardIcon(QStyle.SP_MessageBoxWarning).pixmap(16, 16)
##            imageBuffer = QBuffer()
##            imageBuffer.open(QIODevice.ReadWrite)
##            if pixmap.save(imageBuffer, "PNG"):
##                html = html.replace(
##                    "@FAVICON@", imageBuffer.buffer().toBase64())
##            html = html.replace("@TITLE@", title.encode("utf8"))
##            html = html.replace("@H1@", info.errorString.encode("utf8"))
##            html = html.replace(
##                "@H2@", self.tr("When connecting to: {0}.")
##                .format(urlString).encode("utf8"))
##            html = html.replace(
##                "@LI-1@",
##                self.tr("Check the address for errors such as "
##                        "<b>ww</b>.example.org instead of "
##                        "<b>www</b>.example.org").encode("utf8"))
##            html = html.replace(
##                "@LI-2@",
##                self.tr(
##                    "If the address is correct, try checking the network "
##                    "connection.").encode("utf8"))
##            html = html.replace(
##                "@LI-3@",
##                self.tr(
##                    "If your computer or network is protected by a firewall "
##                    "or proxy, make sure that the browser is permitted to "
##                    "access the network.").encode("utf8"))
##            html = html.replace(
##                "@LI-4@",
##                self.tr("If your cache policy is set to offline browsing,"
##                        "only pages in the local cache are available.")
##                .encode("utf8"))
##            html = html.replace(
##                "@BUTTON@", self.tr("Try Again").encode("utf8"))
##            errorPage.content = html
##            return True
##        
##        return QWebPage.extension(self, extension, option, output)
##    
##    def __loadStarted(self):
##        """
##        Private slot to handle the loadStarted signal.
##        """
##        self.__adBlockedEntries = []
##    
##    def addAdBlockRule(self, rule, url):
##        """
##        Public slot to add an AdBlock rule to the page.
##        
##        @param rule AdBlock rule to add (AdBlockRule)
##        @param url URL that matched the rule (QUrl)
##        """
##        from .AdBlock.AdBlockPage import AdBlockedPageEntry
##        entry = AdBlockedPageEntry(rule, url)
##        if entry not in self.__adBlockedEntries:
##            self.__adBlockedEntries.append(entry)
##    
##    def getAdBlockedPageEntries(self):
##        """
##        Public method to get the list of AdBlock page entries.
##        
##        @return list of AdBlock page entries (list of AdBlockedPageEntry)
##        """
##        return self.__adBlockedEntries
    
    @classmethod
    def userAgent(cls, resolveEmpty=False):
        """
        Class method to get the global user agent setting.
        
        @param resolveEmpty flag indicating to resolve an empty
            user agent (boolean)
        @return user agent string (string)
        """
        agent = Preferences.getWebBrowser("UserAgent")
        if agent == "" and resolveEmpty:
            agent = cls.userAgentForUrl(QUrl())
        return agent
    
    @classmethod
    def setUserAgent(cls, agent):
        """
        Class method to set the global user agent string.
        
        @param agent new current user agent string (string)
        """
        Preferences.setWebBrowser("UserAgent", agent)
    
    @classmethod
    def userAgentForUrl(cls, url):
        """
        Class method to determine the user agent for the given URL.
        
        @param url URL to determine user agent for (QUrl)
        @return user agent string (string)
        """
        agent = WebBrowserWindow.userAgentsManager().userAgentForUrl(url)
        if agent == "":
            # no agent string specified for the given host -> use global one
            agent = Preferences.getWebBrowser("UserAgent")
            if agent == "":
                # no global agent string specified -> use default one
                agent = WebBrowserWindow.webProfile().httpUserAgent()
        return agent
    
##    @classmethod
##    def webPluginFactory(cls):
##        """
##        Class method to get a reference to the web plug-in factory
##        instance.
##        
##        @return reference to the web plug-in factory instance (WebPluginFactory
##        """
##        if cls._webPluginFactory is None:
##            from .WebPlugins.WebPluginFactory import WebPluginFactory
##            cls._webPluginFactory = WebPluginFactory()
##        
##        return cls._webPluginFactory
##    
##    def event(self, evt):
##        """
##        Public method implementing the event handler.
##        
##        @param evt reference to the event (QEvent)
##        @return flag indicating that the event was handled (boolean)
##        """
##        if evt.type() == QEvent.Leave:
##            # Fake a mouse move event just outside of the widget to trigger
##            # the WebKit event handler's mouseMoved function. This implements
##            # the interesting mouse-out behavior like invalidating scrollbars.
##            fakeEvent = QMouseEvent(QEvent.MouseMove, QPoint(0, -1),
##                                    Qt.NoButton, Qt.NoButton, Qt.NoModifier)
##            return super(HelpWebPage, self).event(fakeEvent)
##        
##        return super(HelpWebPage, self).event(evt)
    
    def __featurePermissionRequested(self, url, feature):
        """
        Private slot handling a feature permission request.
        
        @param url url requesting the feature
        @type QUrl
        @param feature requested feature
        @type QWebEnginePage.Feature
        """
        manager = WebBrowserWindow.featurePermissionManager()
        manager.requestFeaturePermission(self, url, feature)
    
    def execJavaScript(self, script):
        """
        Public method to execute a JavaScript function synchroneously.
        
        @param script JavaScript script source to be executed
        @type str
        @return result of the script
        @rtype depending upon script result
        """
        loop = QEventLoop()
        resultDict = {"res": None}
        QTimer.singleShot(500, loop.quit);
        
        def resultCallback(res, resDict=resultDict):
            if loop and loop.isRunning():
                resDict["res"] = res
                loop.quit()
        
        self.runJavaScript(script, resultCallback)
        
        loop.exec_()
        return resultDict["res"]
    
    def scroll(self, x, y):
        """
        Public method to scroll by the given amount of pixels.
        
        @param x horizontal scroll value
        @type int
        @param y vertical scroll value
        @type int
        """
        self.runJavaScript(
            "window.scrollTo(window.scrollX + {0}, window.scrollY + {1})"
            .format(x, y)
        )
    
    def hitTestContent(self, pos):
        """
        Public method to test the content at a specified position.
        
        @param pos position to execute the test at
        @type QPoint
        @return test result object
        @rtype WebHitTestResult
        """
        return WebHitTestResult(self, pos)
    
    def __setupWebChannel(self):
        """
        Private method to setup a web channel to our external object.
        """
        oldChannel = self.webChannel()
        newChannel = QWebChannel(self)
        newChannel.registerObject("eric_object", ExternalJsObject(self))
        self.setWebChannel(newChannel)
        
        if oldChannel:
            del oldChannel.registeredObjects["eric_object"]
            del oldChannel
    
    def certificateError(self, error):
        """
        Public method to handle SSL certificate errors.
        
        @param error object containing the certificate error information
        @type QWebEngineCertificateError
        @return flag indicating to ignore this error
        @rtype bool
        """
        return WebBrowserWindow.networkManager().certificateError(
            error, self.view())
    
    def __fullScreenRequested(self, request):
        """
        Private slot handling a full screen request.
        """
        self.view().requestFullScreen(request.toggleOn())
        
        accepted = request.toggleOn() == self.view().isFullScreen()
        
        if accepted:
            request.accept()
        else:
            request.reject()
    
    ##############################################
    ## Methods below deal with JavaScript messages
    ##############################################
    
    def javaScriptConsoleMessage(self, level, message, lineNumber,  sourceId):
        """
        Public method to show a console message.
        
        @param level severity
        @type QWebEnginePage.JavaScriptConsoleMessageLevel
        @param message message to be shown
        @type str
        @param lineNumber line number of an error
        @type int
        @param sourceId source URL causing the error
        @type str
        """
        self.view().mainWindow().javascriptConsole().javaScriptConsoleMessage(
            level, message, lineNumber,  sourceId)