Coverage for qutebrowser/browser/browsertab.py : 46%
Hot-keys on this page
r m x p toggle line displays
j k next/prev highlighted chunk
0 (zero) top of page
1 (one) first highlighted chunk
|
# vim: ft=python fileencoding=utf-8 sts=4 sw=4 et:
# Copyright 2016-2018 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/>.
"""Get a QtWebKit/QtWebEngine tab object.
Args: win_id: The window ID where the tab will be shown. private: Whether the tab is a private/off the record tab. parent: The Qt parent to set. """ # Importing modules here so we don't depend on QtWebEngine without the # argument and to avoid circular imports. mode_manager = modeman.instance(win_id) if objects.backend == usertypes.Backend.QtWebEngine: from qutebrowser.browser.webengine import webenginetab tab_class = webenginetab.WebEngineTab else: from qutebrowser.browser.webkit import webkittab tab_class = webkittab.WebKitTab return tab_class(win_id=win_id, mode_manager=mode_manager, private=private, parent=parent)
"""Initialize backend-specific modules.""" if objects.backend == usertypes.Backend.QtWebEngine: from qutebrowser.browser.webengine import webenginetab webenginetab.init()
"""Base class for various errors."""
"""Raised when an operation is not supported with the given backend."""
'normal', 'abnormal', # non-zero exit status 'crashed', # e.g. segfault 'killed', 'unknown', ])
class TabData:
"""A simple namespace with a fixed set of attributes.
Attributes: keep_icon: Whether the (e.g. cloned) icon should not be cleared on page load. inspector: The QWebInspector used for this webview. override_target: Override for open_target for fake clicks (like hints). Only used for QtWebKit. pinned: Flag to pin the tab. fullscreen: Whether the tab has a video shown fullscreen currently. netrc_used: Whether netrc authentication was performed. input_mode: current input mode for the tab. """
"""Attribute of AbstractTab for Qt WebActions.
Class attributes (overridden by subclasses): action_class: The class actions are defined on (QWeb{Engine,}Page) action_base: The type of the actions (QWeb{Engine,}Page.WebAction) """
self._widget = None self._tab = tab
"""Exit the fullscreen mode.""" raise NotImplementedError
"""Save the current page.""" raise NotImplementedError
"""Run a webaction based on its name.""" member = getattr(self.action_class, name, None) if not isinstance(member, self.action_base): raise WebTabError("{} is not a valid web action!".format(name)) self._widget.triggerPageAction(member)
"""Show the source of the current page in a new tab.""" raise NotImplementedError
"""Attribute of AbstractTab for printing the page."""
self._widget = None
raise NotImplementedError
raise NotImplementedError
raise NotImplementedError
raise NotImplementedError
"""Print the tab.
Args: printer: The QPrinter to print to. callback: Called with a boolean (True if printing succeeded, False otherwise) """ raise NotImplementedError
"""Attribute of AbstractTab for doing searches.
Attributes: text: The last thing this view was searched for. search_displayed: Whether we're currently displaying search results in this view. _flags: The flags of the last search (needs to be set by subclasses). _widget: The underlying WebView widget. """
super().__init__(parent) self._widget = None self.text = None self.search_displayed = False
"""Check if case-sensitivity should be used.
This assumes self.text is already set properly.
Arguments: ignore_case: The ignore_case value from the config. """ mapping = { 'smart': not self.text.islower(), 'never': True, 'always': False, } return mapping[ignore_case]
result_cb=None): """Find the given text on the page.
Args: text: The text to search for. ignore_case: Search case-insensitively. ('always'/'never/'smart') reverse: Reverse search direction. result_cb: Called with a bool indicating whether a match was found. """ raise NotImplementedError
"""Clear the current search.""" raise NotImplementedError
"""Go to the previous result of the current search.
Args: result_cb: Called with a bool indicating whether a match was found. """ raise NotImplementedError
"""Go to the next result of the current search.
Args: result_cb: Called with a bool indicating whether a match was found. """ raise NotImplementedError
"""Attribute of AbstractTab for controlling zoom.
Attributes: _neighborlist: A NeighborList with the zoom levels. _default_zoom_changed: Whether the zoom was changed from the default. """
super().__init__(parent) self._tab = tab self._widget = None self._default_zoom_changed = False self._init_neighborlist() config.instance.changed.connect(self._on_config_changed) self._zoom_factor = float(config.val.zoom.default) / 100
# # FIXME:qtwebengine is this needed? # # For some reason, this signal doesn't get disconnected automatically # # when the WebView is destroyed on older PyQt versions. # # See https://github.com/qutebrowser/qutebrowser/issues/390 # self.destroyed.connect(functools.partial( # cfg.changed.disconnect, self.init_neighborlist))
def _on_config_changed(self, option): if option in ['zoom.levels', 'zoom.default']: if not self._default_zoom_changed: factor = float(config.val.zoom.default) / 100 self.set_factor(factor) self._init_neighborlist()
"""Initialize self._neighborlist.""" levels = config.val.zoom.levels self._neighborlist = usertypes.NeighborList( levels, mode=usertypes.NeighborList.Modes.edge) self._neighborlist.fuzzyval = config.val.zoom.default
"""Increase/Decrease the zoom level by the given offset.
Args: offset: The offset in the zoom level list.
Return: The new zoom percentage. """ level = self._neighborlist.getitem(offset) self.set_factor(float(level) / 100, fuzzyval=False) return level
raise NotImplementedError
"""Zoom to a given zoom factor.
Args: factor: The zoom factor as float. fuzzyval: Whether to set the NeighborLists fuzzyval. """ if fuzzyval: self._neighborlist.fuzzyval = int(factor * 100) if factor < 0: raise ValueError("Can't zoom to factor {}!".format(factor))
default_zoom_factor = float(config.val.zoom.default) / 100 self._default_zoom_changed = (factor != default_zoom_factor)
self._zoom_factor = factor self._set_factor_internal(factor)
return self._zoom_factor
self._set_factor_internal(float(config.val.zoom.default) / 100)
self._set_factor_internal(self._zoom_factor)
"""Attribute of AbstractTab for caret browsing."""
super().__init__(parent) self._tab = tab self._widget = None self.selection_enabled = False mode_manager.entered.connect(self._on_mode_entered) mode_manager.left.connect(self._on_mode_left)
raise NotImplementedError
raise NotImplementedError
raise NotImplementedError
raise NotImplementedError
raise NotImplementedError
raise NotImplementedError
raise NotImplementedError
raise NotImplementedError
raise NotImplementedError
raise NotImplementedError
raise NotImplementedError
raise NotImplementedError
raise NotImplementedError
raise NotImplementedError
raise NotImplementedError
raise NotImplementedError
raise NotImplementedError
raise NotImplementedError
raise NotImplementedError
raise NotImplementedError
raise NotImplementedError
"""Attribute of AbstractTab to manage scroll position."""
super().__init__(parent) self._tab = tab self._widget = None self.perc_changed.connect(self._log_scroll_pos_change)
def _log_scroll_pos_change(self): log.webview.vdebug("Scroll position changed to {}".format( self.pos_px()))
self._widget = widget
raise NotImplementedError
raise NotImplementedError
raise NotImplementedError
raise NotImplementedError
raise NotImplementedError
raise NotImplementedError
raise NotImplementedError
raise NotImplementedError
raise NotImplementedError
raise NotImplementedError
raise NotImplementedError
raise NotImplementedError
raise NotImplementedError
raise NotImplementedError
raise NotImplementedError
raise NotImplementedError
"""The history attribute of a AbstractTab."""
self._tab = tab self._history = None
return len(self._history)
return iter(self._history.items())
raise NotImplementedError
"""Go back in the tab's history.""" idx = self.current_idx() - count if idx >= 0: self._go_to_item(self._item_at(idx)) else: self._go_to_item(self._item_at(0)) raise WebTabError("At beginning of history.")
"""Go forward in the tab's history.""" idx = self.current_idx() + count if idx < len(self): self._go_to_item(self._item_at(idx)) else: self._go_to_item(self._item_at(len(self) - 1)) raise WebTabError("At end of history.")
raise NotImplementedError
raise NotImplementedError
raise NotImplementedError
raise NotImplementedError
"""Serialize into an opaque format understood by self.deserialize.""" raise NotImplementedError
"""Serialize from a format produced by self.serialize.""" raise NotImplementedError
"""Deserialize from a list of WebHistoryItems.""" raise NotImplementedError
"""Finding and handling of elements on the page."""
self._widget = None self._tab = tab
"""Find all HTML elements matching a given selector async.
Args: callback: The callback to be called when the search finished. selector: The CSS selector to search for. only_visible: Only show elements which are visible on screen. """ raise NotImplementedError
"""Find the HTML element with the given ID async.
Args: callback: The callback to be called when the search finished. elem_id: The ID to search for. """ raise NotImplementedError
"""Find the focused element on the page async.
Args: callback: The callback to be called when the search finished. Called with a WebEngineElement or None. """ raise NotImplementedError
"""Find the element at the given position async.
This is also called "hit test" elsewhere.
Args: pos: The QPoint to get the element for. callback: The callback to be called when the search finished. Called with a WebEngineElement or None. """ raise NotImplementedError
"""A wrapper over the given widget to hide its API and expose another one.
We use this to unify QWebView and QWebEngineView.
Attributes: history: The AbstractHistory for the current tab. registry: The ObjectRegistry associated with this tab. private: Whether private browsing is turned on for this tab.
_load_status: loading status of this page Accessible via load_status() method. _has_ssl_errors: Whether SSL errors happened. Needs to be set by subclasses.
for properties, see WebView/WebEngineView docs.
Signals: See related Qt signals.
new_tab_requested: Emitted when a new tab should be opened with the given URL. load_status_changed: The loading status changed fullscreen_requested: Fullscreen display was requested by the page. arg: True if fullscreen should be turned on, False if it should be turned off. renderer_process_terminated: Emitted when the underlying renderer process terminated. arg 0: A TerminationStatus member. arg 1: The exit code. """
self.private = private self.win_id = win_id self.tab_id = next(tab_id_gen) super().__init__(parent)
self.registry = objreg.ObjectRegistry() tab_registry = objreg.get('tab-registry', scope='window', window=win_id) tab_registry[self.tab_id] = self objreg.register('tab', self, registry=self.registry)
self.data = TabData() self._layout = miscwidgets.WrapperLayout(self) self._widget = None self._progress = 0 self._has_ssl_errors = False self._mode_manager = mode_manager self._load_status = usertypes.LoadStatus.none self._mouse_event_filter = mouse.MouseEventFilter( self, parent=self) self.backend = None
# FIXME:qtwebengine Should this be public api via self.hints? # Also, should we get it out of objreg? hintmanager = hints.HintManager(win_id, self.tab_id, parent=self) objreg.register('hintmanager', hintmanager, scope='tab', window=self.win_id, tab=self.tab_id)
# pylint: disable=protected-access self._widget = widget self._layout.wrap(self, widget) self.history._history = widget.history() self.scroller._init_widget(widget) self.caret._widget = widget self.zoom._widget = widget self.search._widget = widget self.printing._widget = widget self.action._widget = widget self.elements._widget = widget
self._install_event_filter() self.zoom.set_default()
raise NotImplementedError
"""Setter for load_status.""" if not isinstance(val, usertypes.LoadStatus): raise TypeError("Type {} is no LoadStatus member!".format(val)) log.webview.debug("load status for {}: {}".format(repr(self), val)) self._load_status = val self.load_status_changed.emit(val.name)
"""Return the widget events should be sent to.""" raise NotImplementedError
"""Send the given event to the underlying widget.
The event will be sent via QApplication.postEvent. Note that a posted event may not be re-used in any way! """ # This only gives us some mild protection against re-using events, but # it's certainly better than a segfault. if getattr(evt, 'posted', False): raise utils.Unreachable("Can't re-use an event which was already " "posted!") recipient = self.event_target() evt.posted = True QApplication.postEvent(recipient, evt)
def _on_url_changed(self, url): """Update title when URL has changed and no title is available.""" if url.isValid() and not self.title(): self.title_changed.emit(url.toDisplayString()) self.url_changed.emit(url)
def _on_load_started(self): self._progress = 0 self._has_ssl_errors = False self._set_load_status(usertypes.LoadStatus.loading) self.load_started.emit()
"""Handle `input.insert_mode.auto_load` after loading finished.""" if not config.val.input.insert_mode.auto_load or not ok: return
cur_mode = self._mode_manager.mode if cur_mode == usertypes.KeyMode.insert: return
def _auto_insert_mode_cb(elem): """Called from JS after finding the focused element.""" if elem is None: log.webview.debug("No focused element!") return if elem.is_editable(): modeman.enter(self.win_id, usertypes.KeyMode.insert, 'load finished', only_if_normal=True)
self.elements.find_focused(_auto_insert_mode_cb)
def _on_load_finished(self, ok): if sip.isdeleted(self._widget): # https://github.com/qutebrowser/qutebrowser/issues/3498 return
sess_manager = objreg.get('session-manager') sess_manager.save_autosave()
if ok and not self._has_ssl_errors: if self.url().scheme() == 'https': self._set_load_status(usertypes.LoadStatus.success_https) else: self._set_load_status(usertypes.LoadStatus.success) elif ok: self._set_load_status(usertypes.LoadStatus.warn) else: self._set_load_status(usertypes.LoadStatus.error)
self.load_finished.emit(ok)
if not self.title(): self.title_changed.emit(self.url().toDisplayString())
self.zoom.set_current()
def _on_history_trigger(self): """Emit add_history_item when triggered by backend-specific signal.""" raise NotImplementedError
def _on_load_progress(self, perc): self._progress = perc self.load_progress.emit(perc)
def _on_ssl_errors(self): self._has_ssl_errors = True
raise NotImplementedError
return self._progress
return self._load_status
qtutils.ensure_valid(url) self.title_changed.emit(url.toDisplayString())
raise NotImplementedError
raise NotImplementedError
raise NotImplementedError
raise NotImplementedError
"""Send a fake key event to this tab.""" raise NotImplementedError
"""Dump the current page's html asynchronously.
The given callback will be called with the result when dumping is complete. """ raise NotImplementedError
"""Run javascript async.
The given callback will be called with the result when running JS is complete.
Args: code: The javascript code to run. callback: The callback to call with the result, or None. world: A world ID (int or usertypes.JsWorld member) to run the JS in the main world or in another isolated world. """ raise NotImplementedError
raise NotImplementedError
raise NotImplementedError
raise NotImplementedError
raise NotImplementedError
"""Get the QNetworkAccessManager for this tab.
This is only implemented for QtWebKit. For QtWebEngine, always returns None. """ raise NotImplementedError
"""Get the user agent for this tab.
This is only implemented for QtWebKit. For QtWebEngine, always returns None. """ raise NotImplementedError
def __repr__(self): try: url = utils.elide(self.url().toDisplayString(QUrl.EncodeUnicode), 100) except (AttributeError, RuntimeError) as exc: url = '<{}>'.format(exc.__class__.__name__) return utils.get_repr(self, tab_id=self.tab_id, url=url)
return sip.isdeleted(self._widget) |