1# vim: ft=python fileencoding=utf-8 sts=4 sw=4 et: 2 3# Copyright 2015-2021 Florian Bruhin (The Compiler) <mail@qutebrowser.org> 4# 5# This file is part of qutebrowser. 6# 7# qutebrowser is free software: you can redistribute it and/or modify 8# it under the terms of the GNU General Public License as published by 9# the Free Software Foundation, either version 3 of the License, or 10# (at your option) any later version. 11# 12# qutebrowser is distributed in the hope that it will be useful, 13# but WITHOUT ANY WARRANTY; without even the implied warranty of 14# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the 15# GNU General Public License for more details. 16# 17# You should have received a copy of the GNU General Public License 18# along with qutebrowser. If not, see <https://www.gnu.org/licenses/>. 19 20"""Customized QWebInspector for QtWebEngine.""" 21 22import pathlib 23 24from PyQt5.QtCore import QLibraryInfo 25from PyQt5.QtWebEngineWidgets import QWebEngineView, QWebEnginePage 26from PyQt5.QtWidgets import QWidget 27 28from qutebrowser.browser import inspector 29from qutebrowser.browser.webengine import webenginesettings 30from qutebrowser.misc import miscwidgets 31from qutebrowser.utils import version, usertypes 32from qutebrowser.keyinput import modeman 33 34 35class WebEngineInspectorView(QWebEngineView): 36 37 """The QWebEngineView used for the inspector. 38 39 We don't use a qutebrowser WebEngineView because that has various 40 customization which doesn't apply to the inspector. 41 """ 42 43 def createWindow(self, 44 wintype: QWebEnginePage.WebWindowType) -> QWebEngineView: 45 """Called by Qt when a page wants to create a new tab or window. 46 47 In case the user wants to open a resource in a new tab, we use the 48 createWindow handling of the main page to achieve that. 49 50 See WebEngineView.createWindow for details. 51 """ 52 return self.page().inspectedPage().view().createWindow(wintype) 53 54 55class WebEngineInspector(inspector.AbstractWebInspector): 56 57 """A web inspector for QtWebEngine with Qt API support.""" 58 59 def __init__(self, splitter: miscwidgets.InspectorSplitter, 60 win_id: int, 61 parent: QWidget = None) -> None: 62 super().__init__(splitter, win_id, parent) 63 self._check_devtools_resources() 64 65 view = WebEngineInspectorView() 66 self._settings = webenginesettings.WebEngineSettings(view.settings()) 67 self._set_widget(view) 68 page = view.page() 69 page.windowCloseRequested.connect( # type: ignore[attr-defined] 70 self._on_window_close_requested) 71 72 def _on_window_close_requested(self) -> None: 73 """Called when the 'x' was clicked in the devtools.""" 74 modeman.leave( 75 self._win_id, 76 usertypes.KeyMode.insert, 77 'devtools close requested', 78 maybe=True, 79 ) 80 self.hide() 81 82 def _check_devtools_resources(self) -> None: 83 """Make sure that the devtools resources are available on Fedora. 84 85 Fedora packages devtools resources into its own package. If it's not 86 installed, we show a nice error instead of a blank inspector. 87 """ 88 dist = version.distribution() 89 if dist is None or dist.parsed != version.Distribution.fedora: 90 return 91 92 data_path = pathlib.Path(QLibraryInfo.location(QLibraryInfo.DataPath)) 93 pak = data_path / 'resources' / 'qtwebengine_devtools_resources.pak' 94 if not pak.exists(): 95 raise inspector.Error("QtWebEngine devtools resources not found, " 96 "please install the qt5-qtwebengine-devtools " 97 "Fedora package.") 98 99 def inspect(self, page: QWebEnginePage) -> None: # type: ignore[override] 100 inspector_page = self._widget.page() 101 inspector_page.setInspectedPage(page) 102 self._settings.update_for_url(inspector_page.requestedUrl()) 103 104 def _needs_recreate(self) -> bool: 105 """Recreate the inspector when detaching to a window. 106 107 WORKAROUND for what's likely an unknown Qt bug. 108 """ 109 return True 110