320 lines
11 KiB
Python
320 lines
11 KiB
Python
# vim: ft=python fileencoding=utf-8 sts=4 sw=4 et:
|
|
|
|
# Copyright 2016-2017 Florian Bruhin (The Compiler) <mail@qutebrowser.org>
|
|
#
|
|
# This file is part of qutebrowser.
|
|
#
|
|
# qutebrowser 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.
|
|
#
|
|
# qutebrowser 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 qutebrowser. If not, see <http://www.gnu.org/licenses/>.
|
|
|
|
"""Bridge from QWebEngineSettings to our own settings.
|
|
|
|
Module attributes:
|
|
ATTRIBUTES: A mapping from internal setting names to QWebEngineSetting enum
|
|
constants.
|
|
"""
|
|
|
|
import os
|
|
import logging
|
|
|
|
# pylint: disable=no-name-in-module,import-error,useless-suppression
|
|
from PyQt5.QtWebEngineWidgets import (QWebEngineSettings, QWebEngineProfile,
|
|
QWebEngineScript)
|
|
# pylint: enable=no-name-in-module,import-error,useless-suppression
|
|
|
|
from qutebrowser.browser import shared
|
|
from qutebrowser.config import config, websettings
|
|
from qutebrowser.utils import (objreg, utils, standarddir, javascript, log,
|
|
qtutils)
|
|
|
|
|
|
# The default QWebEngineProfile
|
|
default_profile = None
|
|
# The QWebEngineProfile used for private (off-the-record) windows
|
|
private_profile = None
|
|
|
|
|
|
class Attribute(websettings.Attribute):
|
|
|
|
"""A setting set via QWebEngineSettings::setAttribute."""
|
|
|
|
GLOBAL_SETTINGS = QWebEngineSettings.globalSettings
|
|
ENUM_BASE = QWebEngineSettings
|
|
|
|
|
|
class Setter(websettings.Setter):
|
|
|
|
"""A setting set via QWebEngineSettings getter/setter methods."""
|
|
|
|
GLOBAL_SETTINGS = QWebEngineSettings.globalSettings
|
|
|
|
|
|
class NullStringSetter(websettings.NullStringSetter):
|
|
|
|
"""A setter for settings requiring a null QString as default."""
|
|
|
|
GLOBAL_SETTINGS = QWebEngineSettings.globalSettings
|
|
|
|
|
|
class StaticSetter(websettings.StaticSetter):
|
|
|
|
"""A setting set via static QWebEngineSettings getter/setter methods."""
|
|
|
|
GLOBAL_SETTINGS = QWebEngineSettings.globalSettings
|
|
|
|
|
|
class DefaultProfileSetter(websettings.Base):
|
|
|
|
"""A setting set on the QWebEngineProfile."""
|
|
|
|
def __init__(self, getter, setter):
|
|
super().__init__()
|
|
self._getter = getter
|
|
self._setter = setter
|
|
|
|
def get(self, settings=None):
|
|
utils.unused(settings)
|
|
getter = getattr(default_profile, self._getter)
|
|
return getter()
|
|
|
|
def _set(self, value, settings=None):
|
|
utils.unused(settings)
|
|
setter = getattr(default_profile, self._setter)
|
|
setter(value)
|
|
|
|
|
|
class PersistentCookiePolicy(DefaultProfileSetter):
|
|
|
|
"""The cookies -> store setting is different from other settings."""
|
|
|
|
def __init__(self):
|
|
super().__init__(getter='persistentCookiesPolicy',
|
|
setter='setPersistentCookiesPolicy')
|
|
|
|
def get(self, settings=None):
|
|
utils.unused(settings)
|
|
return config.get('content', 'cookies-store')
|
|
|
|
def _set(self, value, settings=None):
|
|
utils.unused(settings)
|
|
setter = getattr(QWebEngineProfile.defaultProfile(), self._setter)
|
|
setter(
|
|
QWebEngineProfile.AllowPersistentCookies if value else
|
|
QWebEngineProfile.NoPersistentCookies
|
|
)
|
|
|
|
|
|
def _init_stylesheet(profile):
|
|
"""Initialize custom stylesheets.
|
|
|
|
Mostly inspired by QupZilla:
|
|
https://github.com/QupZilla/qupzilla/blob/v2.0/src/lib/app/mainapplication.cpp#L1063-L1101
|
|
https://github.com/QupZilla/qupzilla/blob/v2.0/src/lib/tools/scripts.cpp#L119-L132
|
|
|
|
FIXME:qtwebengine Use QWebEngineStyleSheet once that's available
|
|
https://codereview.qt-project.org/#/c/148671/
|
|
"""
|
|
old_script = profile.scripts().findScript('_qute_stylesheet')
|
|
if not old_script.isNull():
|
|
profile.scripts().remove(old_script)
|
|
|
|
css = shared.get_user_stylesheet()
|
|
source = """
|
|
(function() {{
|
|
var css = document.createElement('style');
|
|
css.setAttribute('type', 'text/css');
|
|
css.appendChild(document.createTextNode('{}'));
|
|
document.getElementsByTagName('head')[0].appendChild(css);
|
|
}})()
|
|
""".format(javascript.string_escape(css))
|
|
|
|
script = QWebEngineScript()
|
|
script.setName('_qute_stylesheet')
|
|
script.setInjectionPoint(QWebEngineScript.DocumentReady)
|
|
script.setWorldId(QWebEngineScript.ApplicationWorld)
|
|
script.setRunsOnSubFrames(True)
|
|
script.setSourceCode(source)
|
|
profile.scripts().insert(script)
|
|
|
|
|
|
def update_settings(section, option):
|
|
"""Update global settings when qwebsettings changed."""
|
|
websettings.update_mappings(MAPPINGS, section, option)
|
|
if section == 'ui' and option in ['hide-scrollbar', 'user-stylesheet']:
|
|
_init_stylesheet(default_profile)
|
|
_init_stylesheet(private_profile)
|
|
|
|
|
|
def _init_profiles():
|
|
"""Init the two used QWebEngineProfiles."""
|
|
global default_profile, private_profile
|
|
default_profile = QWebEngineProfile.defaultProfile()
|
|
default_profile.setCachePath(
|
|
os.path.join(standarddir.cache(), 'webengine'))
|
|
default_profile.setPersistentStoragePath(
|
|
os.path.join(standarddir.data(), 'webengine'))
|
|
_init_stylesheet(default_profile)
|
|
|
|
private_profile = QWebEngineProfile()
|
|
assert private_profile.isOffTheRecord()
|
|
_init_stylesheet(private_profile)
|
|
|
|
|
|
def init(args):
|
|
"""Initialize the global QWebSettings."""
|
|
if args.enable_webengine_inspector:
|
|
os.environ['QTWEBENGINE_REMOTE_DEBUGGING'] = str(utils.random_port())
|
|
|
|
# Workaround for a black screen with some setups
|
|
# https://github.com/spyder-ide/spyder/issues/3226
|
|
if not os.environ.get('QUTE_NO_OPENGL_WORKAROUND'):
|
|
# Hide "No OpenGL_accelerate module loaded: ..." message
|
|
logging.getLogger('OpenGL.acceleratesupport').propagate = False
|
|
try:
|
|
from OpenGL import GL # pylint: disable=unused-variable
|
|
except ImportError:
|
|
pass
|
|
else:
|
|
log.misc.debug("Imported PyOpenGL as workaround")
|
|
|
|
_init_profiles()
|
|
# We need to do this here as a WORKAROUND for
|
|
# https://bugreports.qt.io/browse/QTBUG-58650
|
|
if not qtutils.version_check('5.9'):
|
|
PersistentCookiePolicy().set(config.get('content', 'cookies-store'))
|
|
|
|
Attribute(QWebEngineSettings.FullScreenSupportEnabled).set(True)
|
|
|
|
websettings.init_mappings(MAPPINGS)
|
|
objreg.get('config').changed.connect(update_settings)
|
|
|
|
|
|
def shutdown():
|
|
# FIXME:qtwebengine do we need to do something for a clean shutdown here?
|
|
pass
|
|
|
|
|
|
# Missing QtWebEngine attributes:
|
|
# - ScreenCaptureEnabled
|
|
# - Accelerated2dCanvasEnabled
|
|
# - AutoLoadIconsForPage
|
|
# - TouchIconsEnabled
|
|
# - FocusOnNavigationEnabled (5.8)
|
|
# - AllowRunningInsecureContent (5.8)
|
|
#
|
|
# Missing QtWebEngine fonts:
|
|
# - FantasyFont
|
|
# - PictographFont
|
|
|
|
|
|
MAPPINGS = {
|
|
'content': {
|
|
'allow-images':
|
|
Attribute(QWebEngineSettings.AutoLoadImages),
|
|
'allow-javascript':
|
|
Attribute(QWebEngineSettings.JavascriptEnabled),
|
|
'javascript-can-open-windows-automatically':
|
|
Attribute(QWebEngineSettings.JavascriptCanOpenWindows),
|
|
'javascript-can-access-clipboard':
|
|
Attribute(QWebEngineSettings.JavascriptCanAccessClipboard),
|
|
'allow-plugins':
|
|
Attribute(QWebEngineSettings.PluginsEnabled),
|
|
'hyperlink-auditing':
|
|
Attribute(QWebEngineSettings.HyperlinkAuditingEnabled),
|
|
'local-content-can-access-remote-urls':
|
|
Attribute(QWebEngineSettings.LocalContentCanAccessRemoteUrls),
|
|
'local-content-can-access-file-urls':
|
|
Attribute(QWebEngineSettings.LocalContentCanAccessFileUrls),
|
|
'webgl':
|
|
Attribute(QWebEngineSettings.WebGLEnabled),
|
|
},
|
|
'input': {
|
|
'spatial-navigation':
|
|
Attribute(QWebEngineSettings.SpatialNavigationEnabled),
|
|
'links-included-in-focus-chain':
|
|
Attribute(QWebEngineSettings.LinksIncludedInFocusChain),
|
|
},
|
|
'fonts': {
|
|
'web-family-standard':
|
|
Setter(getter=QWebEngineSettings.fontFamily,
|
|
setter=QWebEngineSettings.setFontFamily,
|
|
args=[QWebEngineSettings.StandardFont]),
|
|
'web-family-fixed':
|
|
Setter(getter=QWebEngineSettings.fontFamily,
|
|
setter=QWebEngineSettings.setFontFamily,
|
|
args=[QWebEngineSettings.FixedFont]),
|
|
'web-family-serif':
|
|
Setter(getter=QWebEngineSettings.fontFamily,
|
|
setter=QWebEngineSettings.setFontFamily,
|
|
args=[QWebEngineSettings.SerifFont]),
|
|
'web-family-sans-serif':
|
|
Setter(getter=QWebEngineSettings.fontFamily,
|
|
setter=QWebEngineSettings.setFontFamily,
|
|
args=[QWebEngineSettings.SansSerifFont]),
|
|
'web-family-cursive':
|
|
Setter(getter=QWebEngineSettings.fontFamily,
|
|
setter=QWebEngineSettings.setFontFamily,
|
|
args=[QWebEngineSettings.CursiveFont]),
|
|
'web-family-fantasy':
|
|
Setter(getter=QWebEngineSettings.fontFamily,
|
|
setter=QWebEngineSettings.setFontFamily,
|
|
args=[QWebEngineSettings.FantasyFont]),
|
|
'web-size-minimum':
|
|
Setter(getter=QWebEngineSettings.fontSize,
|
|
setter=QWebEngineSettings.setFontSize,
|
|
args=[QWebEngineSettings.MinimumFontSize]),
|
|
'web-size-minimum-logical':
|
|
Setter(getter=QWebEngineSettings.fontSize,
|
|
setter=QWebEngineSettings.setFontSize,
|
|
args=[QWebEngineSettings.MinimumLogicalFontSize]),
|
|
'web-size-default':
|
|
Setter(getter=QWebEngineSettings.fontSize,
|
|
setter=QWebEngineSettings.setFontSize,
|
|
args=[QWebEngineSettings.DefaultFontSize]),
|
|
'web-size-default-fixed':
|
|
Setter(getter=QWebEngineSettings.fontSize,
|
|
setter=QWebEngineSettings.setFontSize,
|
|
args=[QWebEngineSettings.DefaultFixedFontSize]),
|
|
},
|
|
'ui': {
|
|
'smooth-scrolling':
|
|
Attribute(QWebEngineSettings.ScrollAnimatorEnabled),
|
|
},
|
|
'storage': {
|
|
'local-storage':
|
|
Attribute(QWebEngineSettings.LocalStorageEnabled),
|
|
'cache-size':
|
|
DefaultProfileSetter(getter='httpCacheMaximumSize',
|
|
setter='setHttpCacheMaximumSize')
|
|
},
|
|
'general': {
|
|
'xss-auditing':
|
|
Attribute(QWebEngineSettings.XSSAuditingEnabled),
|
|
'default-encoding':
|
|
Setter(getter=QWebEngineSettings.defaultTextEncoding,
|
|
setter=QWebEngineSettings.setDefaultTextEncoding),
|
|
}
|
|
}
|
|
|
|
try:
|
|
MAPPINGS['general']['print-element-backgrounds'] = Attribute(
|
|
QWebEngineSettings.PrintElementBackgrounds)
|
|
except AttributeError:
|
|
# Added in Qt 5.8
|
|
pass
|
|
|
|
|
|
if qtutils.version_check('5.9'):
|
|
# https://bugreports.qt.io/browse/QTBUG-58650
|
|
MAPPINGS['content']['cookies-store'] = PersistentCookiePolicy()
|