Helpviewer/FeaturePermissionBar.py

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

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

"""
Module implementing the feature permission bar widget.
"""

from __future__ import unicode_literals

from PyQt5.QtCore import pyqtSignal, QPropertyAnimation, QByteArray, \
    QEasingCurve, QPoint
from PyQt5.QtWidgets import QWidget, QLabel, QHBoxLayout, QPushButton
from PyQt5.QtWebKitWidgets import QWebFrame, QWebPage

import UI.PixmapCache


class FeaturePermissionBar(QWidget):
    """
    Class implementing the feature permission bar widget.
    """
    featurePermissionProvided = pyqtSignal(QWebFrame, QWebPage.Feature,
                                           QWebPage.PermissionPolicy)
    
    DefaultHeight = 30
    
    def __init__(self, view):
        """
        Constructor
        
        @param view reference to the web view
        @type QWebView
        """
        super(FeaturePermissionBar, self).__init__(view)
        
        self.__messageLabel = QLabel(self)
        
        self.__frame = None
        self.__feature = None
        
        self.__permissionFeatureTexts = {
            QWebPage.Notifications:
                self.tr("{0} wants to use desktop notifications."),
            QWebPage.Geolocation:
                self.tr("{0} wants to use your position.")
        }
        
        self.setAutoFillBackground(True)
        self.__layout = QHBoxLayout()
        self.setLayout(self.__layout)
        self.__layout.setContentsMargins(self.DefaultHeight, 0, 0, 0)
        self.__layout.addWidget(self.__messageLabel)
        self.__layout.addStretch()
        self.__allowButton = QPushButton(self.tr("Allow"), self)
        self.__denyButton = QPushButton(self.tr("Deny"), self)
        self.__discardButton = QPushButton(UI.PixmapCache.getIcon("close.png"),
                                           "", self)
        self.__allowButton.clicked.connect(self.__permissionGranted)
        self.__denyButton.clicked.connect(self.__permissionDenied)
        self.__discardButton.clicked.connect(self.__permissionUnknown)
        self.__layout.addWidget(self.__allowButton)
        self.__layout.addWidget(self.__denyButton)
        self.__layout.addWidget(self.__discardButton)
        self.setGeometry(0, -self.DefaultHeight, view.width(),
                         self.DefaultHeight)
    
    def requestPermission(self, frame, feature):
        """
        Public method to ask the user for a permission.
        
        @param frame frame sending the request
        @type QWebFrame
        @param feature requested feature
        @type QWebPage.Feature
        """
        self.__frame = frame
        self.__feature = feature
        
        try:
            self.__messageLabel.setText(
                self.__permissionFeatureTexts[self.__feature].format(
                    self.__frame.securityOrigin().host()))
        except KeyError:
            self.__messageLabel.setText(
                self.tr("{0} wants to use an unknown feature.").format(
                    self.__frame.securityOrigin().host()))
        self.show()
        
        self.__animation = QPropertyAnimation(self)
        self.__animation.setTargetObject(self)
        self.__animation.setPropertyName(QByteArray(b"pos"))
        self.__animation.setDuration(300)
        self.__animation.setStartValue(self.pos())
        self.__animation.setEndValue(QPoint(0, 0))
        self.__animation.setEasingCurve(QEasingCurve.InOutQuad)
        self.__animation.start(QPropertyAnimation.DeleteWhenStopped)
    
    def __permissionDenied(self):
        """
        Private slot handling the user pressing the deny button.
        """
        self.featurePermissionProvided.emit(self.__frame, self.__feature,
                                            QWebPage.PermissionDeniedByUser)
    
    def __permissionGranted(self):
        """
        Private slot handling the user pressing the allow button.
        """
        self.featurePermissionProvided.emit(self.__frame, self.__feature,
                                            QWebPage.PermissionGrantedByUser)
    
    def __permissionUnknown(self):
        """
        Private slot handling the user closing the dialog without.
        """
        self.featurePermissionProvided.emit(self.__frame, self.__feature,
                                            QWebPage.PermissionUnknown)