614 lines
20 KiB
Python
614 lines
20 KiB
Python
# vim: ft=python fileencoding=utf-8 sts=4 sw=4 et:
|
|
|
|
# Copyright 2016 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/>.
|
|
|
|
# FIXME:qtwebengine remove this once the stubs are gone
|
|
# pylint: disable=unused-variable
|
|
|
|
"""Wrapper over a QWebEngineView."""
|
|
|
|
import functools
|
|
|
|
from PyQt5.QtCore import pyqtSlot, Qt, QEvent, QPoint, QUrl, QTimer
|
|
from PyQt5.QtGui import QKeyEvent, QIcon
|
|
# pylint: disable=no-name-in-module,import-error,useless-suppression
|
|
from PyQt5.QtWidgets import QOpenGLWidget, QApplication
|
|
from PyQt5.QtWebEngineWidgets import (QWebEnginePage, QWebEngineScript,
|
|
QWebEngineProfile)
|
|
# pylint: enable=no-name-in-module,import-error,useless-suppression
|
|
|
|
from qutebrowser.browser import browsertab, mouse
|
|
from qutebrowser.browser.webengine import (webview, webengineelem, tabhistory,
|
|
interceptor, webenginequtescheme,
|
|
webenginedownloads)
|
|
from qutebrowser.utils import (usertypes, qtutils, log, javascript, utils,
|
|
objreg)
|
|
|
|
|
|
_qute_scheme_handler = None
|
|
|
|
|
|
def init():
|
|
"""Initialize QtWebEngine-specific modules."""
|
|
# For some reason we need to keep a reference, otherwise the scheme handler
|
|
# won't work...
|
|
# https://www.riverbankcomputing.com/pipermail/pyqt/2016-September/038075.html
|
|
global _qute_scheme_handler
|
|
app = QApplication.instance()
|
|
profile = QWebEngineProfile.defaultProfile()
|
|
|
|
log.init.debug("Initializing qute:* handler...")
|
|
_qute_scheme_handler = webenginequtescheme.QuteSchemeHandler(parent=app)
|
|
_qute_scheme_handler.install(profile)
|
|
|
|
log.init.debug("Initializing request interceptor...")
|
|
host_blocker = objreg.get('host-blocker')
|
|
req_interceptor = interceptor.RequestInterceptor(
|
|
host_blocker, parent=app)
|
|
req_interceptor.install(profile)
|
|
|
|
log.init.debug("Initializing QtWebEngine downloads...")
|
|
download_manager = webenginedownloads.DownloadManager(parent=app)
|
|
download_manager.install(profile)
|
|
objreg.register('webengine-download-manager', download_manager)
|
|
|
|
|
|
# Mapping worlds from usertypes.JsWorld to QWebEngineScript world IDs.
|
|
_JS_WORLD_MAP = {
|
|
usertypes.JsWorld.main: QWebEngineScript.MainWorld,
|
|
usertypes.JsWorld.application: QWebEngineScript.ApplicationWorld,
|
|
usertypes.JsWorld.user: QWebEngineScript.UserWorld,
|
|
usertypes.JsWorld.jseval: QWebEngineScript.UserWorld + 1,
|
|
}
|
|
|
|
|
|
class WebEnginePrinting(browsertab.AbstractPrinting):
|
|
|
|
"""QtWebEngine implementations related to printing."""
|
|
|
|
def check_pdf_support(self):
|
|
if not hasattr(self._widget.page(), 'printToPdf'):
|
|
raise browsertab.WebTabError(
|
|
"Printing to PDF is unsupported with QtWebEngine on Qt < 5.7")
|
|
|
|
def check_printer_support(self):
|
|
raise browsertab.WebTabError(
|
|
"Printing is unsupported with QtWebEngine")
|
|
|
|
def to_pdf(self, filename):
|
|
self._widget.page().printToPdf(filename)
|
|
|
|
def to_printer(self, printer):
|
|
# Should never be called
|
|
assert False
|
|
|
|
|
|
class WebEngineSearch(browsertab.AbstractSearch):
|
|
|
|
"""QtWebEngine implementations related to searching on the page."""
|
|
|
|
def __init__(self, parent=None):
|
|
super().__init__(parent)
|
|
self._flags = QWebEnginePage.FindFlags(0)
|
|
|
|
def _find(self, text, flags, cb=None):
|
|
"""Call findText on the widget with optional callback."""
|
|
if cb is None:
|
|
self._widget.findText(text, flags)
|
|
else:
|
|
self._widget.findText(text, flags, cb)
|
|
|
|
def search(self, text, *, ignore_case=False, reverse=False,
|
|
result_cb=None):
|
|
flags = QWebEnginePage.FindFlags(0)
|
|
if ignore_case == 'smart':
|
|
if not text.islower():
|
|
flags |= QWebEnginePage.FindCaseSensitively
|
|
elif not ignore_case:
|
|
flags |= QWebEnginePage.FindCaseSensitively
|
|
if reverse:
|
|
flags |= QWebEnginePage.FindBackward
|
|
|
|
self.text = text
|
|
self._flags = flags
|
|
self._find(text, flags, result_cb)
|
|
|
|
def clear(self):
|
|
self._widget.findText('')
|
|
|
|
def prev_result(self, *, result_cb=None):
|
|
# The int() here makes sure we get a copy of the flags.
|
|
flags = QWebEnginePage.FindFlags(int(self._flags))
|
|
if flags & QWebEnginePage.FindBackward:
|
|
flags &= ~QWebEnginePage.FindBackward
|
|
else:
|
|
flags |= QWebEnginePage.FindBackward
|
|
self._find(self.text, flags, result_cb)
|
|
|
|
def next_result(self, *, result_cb=None):
|
|
self._find(self.text, self._flags, result_cb)
|
|
|
|
|
|
class WebEngineCaret(browsertab.AbstractCaret):
|
|
|
|
"""QtWebEngine implementations related to moving the cursor/selection."""
|
|
|
|
@pyqtSlot(usertypes.KeyMode)
|
|
def _on_mode_entered(self, mode):
|
|
log.stub()
|
|
|
|
@pyqtSlot(usertypes.KeyMode)
|
|
def _on_mode_left(self):
|
|
log.stub()
|
|
|
|
def move_to_next_line(self, count=1):
|
|
log.stub()
|
|
|
|
def move_to_prev_line(self, count=1):
|
|
log.stub()
|
|
|
|
def move_to_next_char(self, count=1):
|
|
log.stub()
|
|
|
|
def move_to_prev_char(self, count=1):
|
|
log.stub()
|
|
|
|
def move_to_end_of_word(self, count=1):
|
|
log.stub()
|
|
|
|
def move_to_next_word(self, count=1):
|
|
log.stub()
|
|
|
|
def move_to_prev_word(self, count=1):
|
|
log.stub()
|
|
|
|
def move_to_start_of_line(self):
|
|
log.stub()
|
|
|
|
def move_to_end_of_line(self):
|
|
log.stub()
|
|
|
|
def move_to_start_of_next_block(self, count=1):
|
|
log.stub()
|
|
|
|
def move_to_start_of_prev_block(self, count=1):
|
|
log.stub()
|
|
|
|
def move_to_end_of_next_block(self, count=1):
|
|
log.stub()
|
|
|
|
def move_to_end_of_prev_block(self, count=1):
|
|
log.stub()
|
|
|
|
def move_to_start_of_document(self):
|
|
log.stub()
|
|
|
|
def move_to_end_of_document(self):
|
|
log.stub()
|
|
|
|
def toggle_selection(self):
|
|
log.stub()
|
|
|
|
def drop_selection(self):
|
|
log.stub()
|
|
|
|
def has_selection(self):
|
|
return self._widget.hasSelection()
|
|
|
|
def selection(self, html=False):
|
|
if html:
|
|
raise browsertab.UnsupportedOperationError
|
|
return self._widget.selectedText()
|
|
|
|
def follow_selected(self, *, tab=False):
|
|
log.stub()
|
|
|
|
|
|
class WebEngineScroller(browsertab.AbstractScroller):
|
|
|
|
"""QtWebEngine implementations related to scrolling."""
|
|
|
|
# FIXME:qtwebengine
|
|
# using stuff here with a big count/argument causes memory leaks and hangs
|
|
|
|
def __init__(self, tab, parent=None):
|
|
super().__init__(tab, parent)
|
|
self._pos_perc = (0, 0)
|
|
self._pos_px = QPoint()
|
|
self._at_bottom = False
|
|
|
|
def _init_widget(self, widget):
|
|
super()._init_widget(widget)
|
|
page = widget.page()
|
|
try:
|
|
page.scrollPositionChanged.connect(self._update_pos)
|
|
except AttributeError:
|
|
log.stub('scrollPositionChanged, on Qt < 5.7')
|
|
self._pos_perc = (None, None)
|
|
|
|
def _key_press(self, key, count=1):
|
|
# FIXME:qtwebengine Abort scrolling if the minimum/maximum was reached.
|
|
for _ in range(count):
|
|
press_evt = QKeyEvent(QEvent.KeyPress, key, Qt.NoModifier, 0, 0, 0)
|
|
release_evt = QKeyEvent(QEvent.KeyRelease, key, Qt.NoModifier,
|
|
0, 0, 0)
|
|
self._tab.send_event(press_evt)
|
|
self._tab.send_event(release_evt)
|
|
|
|
@pyqtSlot()
|
|
def _update_pos(self):
|
|
"""Update the scroll position attributes when it changed."""
|
|
def update_pos_cb(jsret):
|
|
"""Callback after getting scroll position via JS."""
|
|
if jsret is None:
|
|
# This can happen when the callback would get called after
|
|
# shutting down a tab
|
|
return
|
|
log.webview.vdebug(jsret)
|
|
assert isinstance(jsret, dict), jsret
|
|
self._pos_px = QPoint(jsret['px']['x'], jsret['px']['y'])
|
|
|
|
dx = jsret['scroll']['width'] - jsret['inner']['width']
|
|
if dx == 0:
|
|
perc_x = 0
|
|
else:
|
|
perc_x = min(100, round(100 / dx * jsret['px']['x']))
|
|
|
|
dy = jsret['scroll']['height'] - jsret['inner']['height']
|
|
if dy == 0:
|
|
perc_y = 0
|
|
else:
|
|
perc_y = min(100, round(100 / dy * jsret['px']['y']))
|
|
|
|
self._at_bottom = dy >= jsret['px']['y']
|
|
self._pos_perc = perc_x, perc_y
|
|
|
|
self.perc_changed.emit(*self._pos_perc)
|
|
|
|
js_code = javascript.assemble('scroll', 'pos')
|
|
self._tab.run_js_async(js_code, update_pos_cb)
|
|
|
|
def pos_px(self):
|
|
return self._pos_px
|
|
|
|
def pos_perc(self):
|
|
return self._pos_perc
|
|
|
|
def to_perc(self, x=None, y=None):
|
|
js_code = javascript.assemble('scroll', 'to_perc', x, y)
|
|
self._tab.run_js_async(js_code)
|
|
|
|
def to_point(self, point):
|
|
js_code = javascript.assemble('window', 'scroll', point.x(), point.y())
|
|
self._tab.run_js_async(js_code)
|
|
|
|
def delta(self, x=0, y=0):
|
|
self._tab.run_js_async(javascript.assemble('window', 'scrollBy', x, y))
|
|
|
|
def delta_page(self, x=0, y=0):
|
|
js_code = javascript.assemble('scroll', 'delta_page', x, y)
|
|
self._tab.run_js_async(js_code)
|
|
|
|
def up(self, count=1):
|
|
self._key_press(Qt.Key_Up, count)
|
|
|
|
def down(self, count=1):
|
|
self._key_press(Qt.Key_Down, count)
|
|
|
|
def left(self, count=1):
|
|
self._key_press(Qt.Key_Left, count)
|
|
|
|
def right(self, count=1):
|
|
self._key_press(Qt.Key_Right, count)
|
|
|
|
def top(self):
|
|
self._key_press(Qt.Key_Home)
|
|
|
|
def bottom(self):
|
|
self._key_press(Qt.Key_End)
|
|
|
|
def page_up(self, count=1):
|
|
self._key_press(Qt.Key_PageUp, count)
|
|
|
|
def page_down(self, count=1):
|
|
self._key_press(Qt.Key_PageDown, count)
|
|
|
|
def at_top(self):
|
|
return self.pos_px().y() == 0
|
|
|
|
def at_bottom(self):
|
|
return self._at_bottom
|
|
|
|
|
|
class WebEngineHistory(browsertab.AbstractHistory):
|
|
|
|
"""QtWebEngine implementations related to page history."""
|
|
|
|
def current_idx(self):
|
|
return self._history.currentItemIndex()
|
|
|
|
def back(self):
|
|
self._history.back()
|
|
|
|
def forward(self):
|
|
self._history.forward()
|
|
|
|
def can_go_back(self):
|
|
return self._history.canGoBack()
|
|
|
|
def can_go_forward(self):
|
|
return self._history.canGoForward()
|
|
|
|
def serialize(self):
|
|
return qtutils.serialize(self._history)
|
|
|
|
def deserialize(self, data):
|
|
return qtutils.deserialize(data, self._history)
|
|
|
|
def load_items(self, items):
|
|
stream, _data, cur_data = tabhistory.serialize(items)
|
|
qtutils.deserialize_stream(stream, self._history)
|
|
if cur_data is not None:
|
|
if 'zoom' in cur_data:
|
|
self._tab.zoom.set_factor(cur_data['zoom'])
|
|
if ('scroll-pos' in cur_data and
|
|
self._tab.scroller.pos_px() == QPoint(0, 0)):
|
|
QTimer.singleShot(0, functools.partial(
|
|
self._tab.scroller.to_point, cur_data['scroll-pos']))
|
|
|
|
|
|
class WebEngineZoom(browsertab.AbstractZoom):
|
|
|
|
"""QtWebEngine implementations related to zooming."""
|
|
|
|
def _set_factor_internal(self, factor):
|
|
self._widget.setZoomFactor(factor)
|
|
|
|
def factor(self):
|
|
return self._widget.zoomFactor()
|
|
|
|
|
|
class WebEngineElements(browsertab.AbstractElements):
|
|
|
|
"""QtWebEngine implemementations related to elements on the page."""
|
|
|
|
def _js_cb_multiple(self, callback, js_elems):
|
|
"""Handle found elements coming from JS and call the real callback.
|
|
|
|
Args:
|
|
callback: The callback to call with the found elements.
|
|
js_elems: The elements serialized from javascript.
|
|
"""
|
|
elems = []
|
|
for js_elem in js_elems:
|
|
elem = webengineelem.WebEngineElement(js_elem, tab=self._tab)
|
|
elems.append(elem)
|
|
callback(elems)
|
|
|
|
def _js_cb_single(self, callback, js_elem):
|
|
"""Handle a found focus elem coming from JS and call the real callback.
|
|
|
|
Args:
|
|
callback: The callback to call with the found element.
|
|
Called with a WebEngineElement or None.
|
|
js_elem: The element serialized from javascript.
|
|
"""
|
|
log.webview.debug("Got element from JS: {!r}".format(js_elem))
|
|
if js_elem is None:
|
|
callback(None)
|
|
else:
|
|
elem = webengineelem.WebEngineElement(js_elem, tab=self._tab)
|
|
callback(elem)
|
|
|
|
def find_css(self, selector, callback, *, only_visible=False):
|
|
js_code = javascript.assemble('webelem', 'find_all', selector,
|
|
only_visible)
|
|
js_cb = functools.partial(self._js_cb_multiple, callback)
|
|
self._tab.run_js_async(js_code, js_cb)
|
|
|
|
def find_id(self, elem_id, callback):
|
|
js_code = javascript.assemble('webelem', 'element_by_id', elem_id)
|
|
js_cb = functools.partial(self._js_cb_single, callback)
|
|
self._tab.run_js_async(js_code, js_cb)
|
|
|
|
def find_focused(self, callback):
|
|
js_code = javascript.assemble('webelem', 'focus_element')
|
|
js_cb = functools.partial(self._js_cb_single, callback)
|
|
self._tab.run_js_async(js_code, js_cb)
|
|
|
|
def find_at_pos(self, pos, callback):
|
|
assert pos.x() >= 0
|
|
assert pos.y() >= 0
|
|
js_code = javascript.assemble('webelem', 'element_at_pos',
|
|
pos.x(), pos.y())
|
|
js_cb = functools.partial(self._js_cb_single, callback)
|
|
self._tab.run_js_async(js_code, js_cb)
|
|
|
|
|
|
class WebEngineTab(browsertab.AbstractTab):
|
|
|
|
"""A QtWebEngine tab in the browser."""
|
|
|
|
WIDGET_CLASS = QOpenGLWidget
|
|
|
|
def __init__(self, win_id, mode_manager, parent=None):
|
|
super().__init__(win_id=win_id, mode_manager=mode_manager,
|
|
parent=parent)
|
|
widget = webview.WebEngineView(tabdata=self.data, win_id=win_id)
|
|
self.history = WebEngineHistory(self)
|
|
self.scroller = WebEngineScroller(self, parent=self)
|
|
self.caret = WebEngineCaret(win_id=win_id, mode_manager=mode_manager,
|
|
tab=self, parent=self)
|
|
self.zoom = WebEngineZoom(win_id=win_id, parent=self)
|
|
self.search = WebEngineSearch(parent=self)
|
|
self.printing = WebEnginePrinting()
|
|
self.elements = WebEngineElements(self)
|
|
self._set_widget(widget)
|
|
self._connect_signals()
|
|
self.backend = usertypes.Backend.QtWebEngine
|
|
# init js stuff
|
|
self._init_js()
|
|
self._child_event_filter = None
|
|
|
|
def _init_js(self):
|
|
js_code = '\n'.join([
|
|
'"use strict";',
|
|
'window._qutebrowser = {};',
|
|
utils.read_file('javascript/scroll.js'),
|
|
utils.read_file('javascript/webelem.js'),
|
|
])
|
|
script = QWebEngineScript()
|
|
script.setInjectionPoint(QWebEngineScript.DocumentCreation)
|
|
script.setSourceCode(js_code)
|
|
|
|
page = self._widget.page()
|
|
try:
|
|
page.runJavaScript("", QWebEngineScript.ApplicationWorld)
|
|
except TypeError:
|
|
# We're unable to pass a world to runJavaScript
|
|
script.setWorldId(QWebEngineScript.MainWorld)
|
|
else:
|
|
script.setWorldId(QWebEngineScript.ApplicationWorld)
|
|
|
|
# FIXME:qtwebengine what about runsOnSubFrames?
|
|
page.scripts().insert(script)
|
|
|
|
def _install_event_filter(self):
|
|
self._widget.focusProxy().installEventFilter(self._mouse_event_filter)
|
|
self._child_event_filter = mouse.ChildEventFilter(
|
|
eventfilter=self._mouse_event_filter, widget=self._widget,
|
|
parent=self)
|
|
self._widget.installEventFilter(self._child_event_filter)
|
|
|
|
def openurl(self, url):
|
|
self._openurl_prepare(url)
|
|
self._widget.load(url)
|
|
|
|
def url(self, requested=False):
|
|
page = self._widget.page()
|
|
if requested:
|
|
return page.requestedUrl()
|
|
else:
|
|
return page.url()
|
|
|
|
def dump_async(self, callback, *, plain=False):
|
|
if plain:
|
|
self._widget.page().toPlainText(callback)
|
|
else:
|
|
self._widget.page().toHtml(callback)
|
|
|
|
def run_js_async(self, code, callback=None, *, world=None):
|
|
if world is None:
|
|
world_id = QWebEngineScript.ApplicationWorld
|
|
elif isinstance(world, int):
|
|
world_id = world
|
|
else:
|
|
world_id = _JS_WORLD_MAP[world]
|
|
|
|
try:
|
|
if callback is None:
|
|
self._widget.page().runJavaScript(code, world_id)
|
|
else:
|
|
self._widget.page().runJavaScript(code, world_id, callback)
|
|
except TypeError:
|
|
if world is not None and world != usertypes.JsWorld.jseval:
|
|
log.webview.warning("Ignoring world ID on Qt < 5.7")
|
|
# Qt < 5.7
|
|
if callback is None:
|
|
self._widget.page().runJavaScript(code)
|
|
else:
|
|
self._widget.page().runJavaScript(code, callback)
|
|
|
|
def shutdown(self):
|
|
log.stub()
|
|
|
|
def reload(self, *, force=False):
|
|
if force:
|
|
action = QWebEnginePage.ReloadAndBypassCache
|
|
else:
|
|
action = QWebEnginePage.Reload
|
|
self._widget.triggerPageAction(action)
|
|
|
|
def stop(self):
|
|
self._widget.stop()
|
|
|
|
def title(self):
|
|
return self._widget.title()
|
|
|
|
def icon(self):
|
|
try:
|
|
return self._widget.icon()
|
|
except AttributeError:
|
|
log.stub('on Qt < 5.7')
|
|
return QIcon()
|
|
|
|
def set_html(self, html, base_url):
|
|
# FIXME:qtwebengine
|
|
# check this and raise an exception if too big:
|
|
# Warning: The content will be percent encoded before being sent to the
|
|
# renderer via IPC. This may increase its size. The maximum size of the
|
|
# percent encoded content is 2 megabytes minus 30 bytes.
|
|
self._widget.setHtml(html, base_url)
|
|
|
|
def clear_ssl_errors(self):
|
|
log.stub()
|
|
|
|
@pyqtSlot()
|
|
def _on_history_trigger(self):
|
|
url = self.url()
|
|
requested_url = self.url(requested=True)
|
|
|
|
# Don't save the title if it's generated from the URL
|
|
title = self.title()
|
|
title_url = QUrl(url)
|
|
title_url.setScheme('')
|
|
if title == title_url.toDisplayString(QUrl.RemoveScheme).strip('/'):
|
|
title = ""
|
|
|
|
# Don't add history entry if the URL is invalid anyways
|
|
if not url.isValid():
|
|
log.misc.debug("Ignoring invalid URL being added to history")
|
|
return
|
|
|
|
self.add_history_item.emit(url, requested_url, title)
|
|
|
|
def _connect_signals(self):
|
|
view = self._widget
|
|
page = view.page()
|
|
page.windowCloseRequested.connect(self.window_close_requested)
|
|
page.linkHovered.connect(self.link_hovered)
|
|
page.loadProgress.connect(self._on_load_progress)
|
|
page.loadStarted.connect(self._on_load_started)
|
|
page.loadFinished.connect(self._on_history_trigger)
|
|
view.titleChanged.connect(self.title_changed)
|
|
view.urlChanged.connect(self._on_url_changed)
|
|
page.loadFinished.connect(self._on_load_finished)
|
|
page.certificate_error.connect(self._on_ssl_errors)
|
|
page.link_clicked.connect(self._on_link_clicked)
|
|
try:
|
|
view.iconChanged.connect(self.icon_changed)
|
|
except AttributeError:
|
|
log.stub('iconChanged, on Qt < 5.7')
|
|
try:
|
|
page.contentsSizeChanged.connect(self.contents_size_changed)
|
|
except AttributeError:
|
|
log.stub('contentsSizeChanged, on Qt < 5.7')
|
|
|
|
def _event_target(self):
|
|
return self._widget.focusProxy()
|