#!/usr/bin/env python3 # -*- coding: utf-8 -*- # Copyright (C) 2018 Andy Stewart # # Author: Andy Stewart # Maintainer: Andy Stewart # # This program 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 # any later version. # # This program 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 this program. If not, see . from PyQt5 import QtCore from PyQt5.QtCore import QUrl, Qt, QEvent, QPointF, QEventLoop, QVariant, QTimer from PyQt5.QtNetwork import QNetworkCookie from PyQt5.QtWebEngineWidgets import QWebEngineView, QWebEnginePage, QWebEngineContextMenuData, QWebEngineProfile, QWebEngineSettings from PyQt5.QtWidgets import QApplication, QWidget from core.utils import touch, is_port_in_use, string_to_base64 from core.buffer import Buffer from urllib.parse import urlparse, parse_qs, urlunparse, urlencode import os import subprocess import re import base64 MOUSE_BACK_BUTTON = 8 MOUSE_FORWARD_BUTTON = 16 class BrowserView(QWebEngineView): open_url_in_new_tab = QtCore.pyqtSignal(str) open_url_in_background_tab = QtCore.pyqtSignal(str) translate_selected_text = QtCore.pyqtSignal(str) trigger_focus_event = QtCore.pyqtSignal(str) def __init__(self, config_dir): super(QWebEngineView, self).__init__() self.installEventFilter(self) self.config_dir = config_dir self.web_page = BrowserPage() self.setPage(self.web_page) self.cookie_store = self.page().profile().cookieStore() self.cookie_storage = BrowserCookieStorage(config_dir) self.cookie_store.cookieAdded.connect(self.cookie_storage.add_cookie) self.selectionChanged.connect(self.select_text_change) self.urlChanged.connect(lambda url: self.search_quit()) self.load_cookie() self.search_term = "" self.get_markers_raw = self.read_js_content("get_markers.js") self.goto_marker_raw = self.read_js_content("goto_marker.js") self.get_focus_text_js = self.read_js_content("get_focus_text.js") self.set_focus_text_raw = self.read_js_content("set_focus_text.js") self.clear_focus_js = self.read_js_content("clear_focus.js") self.select_input_text_js = self.read_js_content("select_input_text.js") self.dark_mode_js = self.read_js_content("dark_mode.js") self.get_selection_text_js = self.read_js_content("get_selection_text.js") def open_download_manage_page(self): self.open_url_new_buffer("file://" + (os.path.join(os.path.dirname(__file__), "aria2-webui", "index.html"))) def read_js_content(self, js_file): return open(os.path.join(os.path.dirname(__file__), "js", js_file), "r").read() def filter_url(self, url): parsed = urlparse(url) qd = parse_qs(parsed.query, keep_blank_values=True) if parsed.netloc.startswith("www.google.com"): # Only save search parameters for Google, avoid duplicate url for same keyword. filtered = dict((k, v) for k, v in qd.items() if k.startswith("q")) else: filtered = dict((k, v) for k, v in qd.items()) return urlunparse([ parsed.scheme, parsed.netloc, parsed.path, parsed.params, urlencode(filtered, doseq=True), # query string parsed.fragment ]) def filter_title(self, title): "If title is google url, we should drop this history, it's a temp redirect url." try: parsed = urlparse(title) qd = parse_qs(parsed.query, keep_blank_values=True) if parsed.netloc.startswith("www.google.com"): return "" else: return title except Exception: return title def _search_text(self, text, is_backward = False): if self.search_term != text: self.search_term = text if is_backward: self.web_page.findText(self.search_term, self.web_page.FindBackward) else: self.web_page.findText(self.search_term) def search_text_forward(self): if self.search_term == "": self.buffer.send_input_message("Forward Search Text: ", "search_text_forward") else: self._search_text(self.search_term) def search_text_backward(self): if self.search_term == "": self.buffer.send_input_message("Backward Search Text: ", "search_text_backward") else: self._search_text(self.search_term, True) def search_quit(self): if self.search_term != "": self._search_text("") def select_text_change(self): modifiers = QApplication.keyboardModifiers() if modifiers == Qt.ControlModifier: self.translate_selected_text.emit(self.selectedText()) def load_cookie(self): for cookie in self.cookie_storage.load_cookie(): self.cookie_store.setCookie(cookie) def clear_cookies(self): self.cookie_storage.clear_cookies(self.cookie_store) def createWindow(self, window_type): return self.create_new_browser_window_callback() def event(self, event): if event.type() == QEvent.ChildAdded: obj = event.child() if isinstance(obj, QWidget): obj.installEventFilter(self) return QWebEngineView.event(self, event) def eventFilter(self, obj, event): # Focus emacs buffer when user click view. if event.type() in [QEvent.MouseButtonPress, QEvent.MouseButtonRelease, QEvent.MouseMove, QEvent.MouseButtonDblClick, QEvent.Wheel]: # Send mouse event to applicatin view. self.trigger_focus_event.emit("{0},{1}".format(event.globalX(), event.globalY())) if event.type() == QEvent.MouseButtonPress: if event.button() == MOUSE_FORWARD_BUTTON: self.forward() event.accept() return True elif event.button() == MOUSE_BACK_BUTTON: self.back() event.accept() return True return super(QWebEngineView, self).eventFilter(obj, event) def open_url(self, url): self.setUrl(QUrl(url)) def open_url_new_buffer(self, url): self.open_url_in_new_tab.emit(url) def open_url_background_buffer(self, url): self.open_url_in_background_tab.emit(url) def zoom_in(self): self.setZoomFactor(min(5, self.zoomFactor() + 0.25)) def zoom_out(self): self.setZoomFactor(max(0.25, self.zoomFactor() - 0.25)) def zoom_reset(self): self.setZoomFactor(float(self.buffer.emacs_var_dict["eaf-browser-default-zoom"])) def eval_js(self, js): self.web_page.runJavaScript(js) def eval_js_file(self, js_file): self.eval_js(self.read_js_content(js_file)) def execute_js(self, js): return self.web_page.execute_javascript(js) def scroll_left(self): self.eval_js("document.scrollingElement.scrollBy(-35, 0)") def scroll_right(self): self.eval_js("document.scrollingElement.scrollBy(35, 0)") def scroll_up(self): self.eval_js("document.scrollingElement.scrollBy(0, 50)") def scroll_down(self): self.eval_js("document.scrollingElement.scrollBy(0, -50)") def scroll_up_page(self): self.eval_js("document.scrollingElement.scrollBy({left: 0, top: window.innerHeight/2, behavior: '" + self.buffer.emacs_var_dict["eaf-browser-scroll-behavior"] + "'})") def scroll_down_page(self): self.eval_js("document.scrollingElement.scrollBy({left: 0, top: -window.innerHeight/2, behavior: '" + self.buffer.emacs_var_dict["eaf-browser-scroll-behavior"] + "'})") def scroll_to_begin(self): self.eval_js("document.scrollingElement.scrollTo({left: 0, top: 0, behavior: '" + self.buffer.emacs_var_dict["eaf-browser-scroll-behavior"] + "'})") def scroll_to_bottom(self): self.eval_js("document.scrollingElement.scrollTo({left: 0, top: document.body.scrollHeight, behavior: '" + self.buffer.emacs_var_dict["eaf-browser-scroll-behavior"] + "'})") def get_selection_text(self): return self.execute_js(self.get_selection_text_js) def refresh_page(self): self.reload() def copy_text(self): self.triggerPageAction(self.web_page.Copy) def yank_text(self): self.triggerPageAction(self.web_page.Paste) def kill_text(self): self.triggerPageAction(self.web_page.Cut) def undo_action(self): self.triggerPageAction(self.web_page.Undo) def redo_action(self): self.triggerPageAction(self.web_page.Redo) def exit_fullscreen(self): self.triggerPageAction(self.web_page.ExitFullScreen) def select_all(self): # We need window focus before select all text. self.eval_js("window.focus()") self.triggerPageAction(self.web_page.SelectAll) def select_input_text(self): self.eval_js(self.select_input_text_js) def get_url(self): return self.execute_js("window.location.href;") def cleanup_links(self): self.eval_js("document.querySelector('.eaf-marker-container').remove();") self.eval_js("document.querySelector('.eaf-style').remove();") def get_link_markers(self): self.eval_js(self.get_markers_raw.replace("%1", self.buffer.emacs_var_dict["eaf-marker-letters"])); def get_marker_link(self, marker): self.goto_marker_js = self.goto_marker_raw.replace("%1", str(marker)); link = self.execute_js(self.goto_marker_js) self.cleanup_links() return link def jump_to_link(self, marker): link = self.get_marker_link(marker) if link != "": self.open_url(link) def jump_to_link_new_buffer(self, marker): link = self.get_marker_link(marker) if link != "": self.open_url_new_buffer(link) def jump_to_link_background_buffer(self, marker): link = self.get_marker_link(marker) if link != "": self.open_url_background_buffer(link) def get_focus_text(self): return self.execute_js(self.get_focus_text_js) def set_focus_text(self, new_text): self.set_focus_text_js = self.set_focus_text_raw.replace("%1", string_to_base64(new_text)); self.eval_js(self.set_focus_text_js) def clear_focus(self): self.eval_js(self.clear_focus_js) def dark_mode(self): self.eval_js(self.dark_mode_js) class BrowserPage(QWebEnginePage): def __init__(self): QWebEnginePage.__init__(self) def execute_javascript(self, script_src): self.loop = QEventLoop() self.result = QVariant() QTimer.singleShot(250, self.loop.quit) self.runJavaScript(script_src, self.callback_js) self.loop.exec_() self.loop = None return self.result def callback_js(self, res): if self.loop is not None and self.loop.isRunning(): self.result = res self.loop.quit() class BrowserCookieStorage: def __init__(self, config_dir): self.cookie_file = os.path.join(config_dir, "browser", "cookie", "cookie") touch(self.cookie_file) def load_cookie(self): with open(self.cookie_file, 'rb+') as store: cookies = store.read() return QNetworkCookie.parseCookies(cookies) def save_cookie(self, cookie): with open(self.cookie_file, 'wb+') as store: store.write(cookie + b'\n' if cookie is not None else b'') def add_cookie(self, cookie): raw = cookie.toRawForm() self.save_cookie(raw) def clear_cookies(self, cookie_store): cookie_store.deleteAllCookies() open(self.cookie_file, 'w').close() class HistoryPage(): def __init__(self, title, url, hit): self.title = title self.url = url self.hit = float(hit) class BrowserBuffer(Buffer): close_page = QtCore.pyqtSignal(str) get_focus_text = QtCore.pyqtSignal(str, str) open_dev_tools_tab = QtCore.pyqtSignal(object) enter_fullscreen_request = QtCore.pyqtSignal() exit_fullscreen_request = QtCore.pyqtSignal() def __init__(self, buffer_id, url, config_dir, arguments, emacs_var_dict, fit_to_view, background_color): Buffer.__init__(self, buffer_id, url, arguments, emacs_var_dict, fit_to_view, background_color) self.add_widget(BrowserView(config_dir)) self.config_dir = config_dir self.history_list = [] if self.emacs_var_dict["eaf-browser-remember-history"] == "true": self.history_log_file_path = os.path.join(self.config_dir, "browser", "history", "log.txt") self.history_pattern = re.compile("^(.+)ᛝ(.+)ᛡ(.+)$") self.noprefix_url_pattern = re.compile("^(https?|file)://(.+)") self.nopostfix_url_pattern = re.compile("^[^#\?]*") self.history_close_file_path = os.path.join(self.config_dir, "browser", "history", "close.txt") touch(self.history_log_file_path) with open(self.history_log_file_path, "r") as f: raw_list = f.readlines() for raw_his in raw_list: his_line = re.match(self.history_pattern, raw_his) if his_line is None: # Obsolete Old history format old_his = re.match("(.*)\s((https?|file):[^\s]+)$", raw_his) if old_his is not None: self.history_list.append(HistoryPage(old_his.group(1), old_his.group(2), 1)) else: self.history_list.append(HistoryPage(his_line.group(1), his_line.group(2), his_line.group(3))) # Set User Agent with Firefox's one to make EAF browser can login in Google account. self.profile = QWebEngineProfile(self.buffer_widget) self.profile.defaultProfile().setHttpUserAgent("Mozilla/5.0 (X11; Linux i586; rv:31.0) Gecko/20100101 Firefox/72.0") self.buffer_widget.loadStarted.connect(self.start_progress) self.buffer_widget.loadProgress.connect(self.update_progress) self.buffer_widget.loadFinished.connect(self.stop_progress) self.buffer_widget.web_page.windowCloseRequested.connect(self.request_close_buffer) self.buffer_widget.web_page.fullScreenRequested.connect(self.handle_fullscreen_request) self.profile.defaultProfile().downloadRequested.connect(self.handle_download_request) settings = QWebEngineSettings.globalSettings() try: settings.setAttribute(QWebEngineSettings.PluginsEnabled, self.emacs_var_dict["eaf-browser-enable-plugin"] == "true") settings.setAttribute(QWebEngineSettings.JavascriptEnabled, self.emacs_var_dict["eaf-browser-enable-javascript"] == "true") settings.setAttribute(QWebEngineSettings.FullScreenSupportEnabled, True) except Exception: pass for method_name in ["search_text_forward", "search_text_backward", "zoom_out", "zoom_in", "zoom_reset", "scroll_left", "scroll_right", "scroll_up", "scroll_down", "scroll_up_page", "scroll_down_page", "scroll_to_begin", "scroll_to_bottom", "refresh_page", "undo_action", "redo_action", "get_url", "exit_fullscreen", "set_focus_text", "clear_focus", "dark_mode"]: self.build_widget_method(method_name) self.build_widget_method("history_backward", "back") self.build_widget_method("history_forward", "forward") self.build_widget_method("action_quit", "search_quit") self.build_widget_method("yank_text", "yank_text", "Yank text.") self.build_widget_method("kill_text", "kill_text", "Kill text.") for method_name in ["recover_prev_close_page", "scroll_up", "scroll_down", "scroll_left", "scroll_right", "scroll_up_page", "scroll_down_page", "scroll_to_begin", "scroll_to_bottom", "open_link", "open_link_new_buffer", "open_link_background_buffer", "history_backward", "history_forward", "new_blank_page", "open_download_manage_page", "refresh_page", "zoom_in", "zoom_out", "zoom_reset", "save_as_bookmark"]: self.build_insert_or_do(method_name) def handle_fullscreen_request(self, request): if request.toggleOn(): self.enter_fullscreen_request.emit() else: self.exit_fullscreen_request.emit() request.accept() def handle_download_request(self, download_item): download_data = download_item.url().toString() if download_data.startswith("data:image/"): image_path = os.path.join(os.path.expanduser(self.emacs_var_dict["eaf-browser-download-path"]), "image.png") touch(image_path) with open(image_path, "wb") as f: f.write(base64.decodestring(download_data.split(",")[1].encode("utf-8"))) self.message_to_emacs.emit("Save image: " + image_path) else: self.try_start_aria2_daemon() download_data = download_item.url().toString() with open(os.devnull, "w") as null_file: subprocess.Popen(["aria2p", "add", download_data], stdout=null_file) self.message_to_emacs.emit("Start download: " + download_data) def destroy_buffer(self): # Record close page. self.close_page.emit(self.buffer_widget.url().toString()) # Load blank page to stop video playing, such as youtube.com. self.buffer_widget.open_url("about:blank") if self.buffer_widget is not None: # NOTE: We need delete QWebEnginePage manual, otherwise QtWebEngineProcess won't quit. self.buffer_widget.web_page.deleteLater() self.buffer_widget.deleteLater() def get_key_event_widgets(self): # We need send key event to QWebEngineView's focusProxy widget, not QWebEngineView. return [self.buffer_widget.focusProxy()] def scroll(self, scroll_direction, scroll_type): if scroll_type == "page": if scroll_direction == "up": self.scroll_up_page() else: self.scroll_down_page() else: if scroll_direction == "up": self.scroll_up() else: self.scroll_down() def handle_input_message(self, result_type, result_content): if result_type == "search_text_forward": self.buffer_widget._search_text(str(result_content)) elif result_type == "search_text_backward": self.buffer_widget._search_text(str(result_content), True) elif result_type == "jump_link": self.buffer_widget.jump_to_link(str(result_content).strip()) elif result_type == "jump_link_new_buffer": self.buffer_widget.jump_to_link_new_buffer(str(result_content).strip()) elif result_type == "jump_link_background_buffer": self.buffer_widget.jump_to_link_background_buffer(str(result_content).strip()) elif result_type == "eval_js_file": self.buffer_widget.eval_js_file(str(result_content)) elif result_type == "eval_js": self.buffer_widget.eval_js(str(result_content)) def cancel_input_message(self, result_type): if result_type == "jump_link" or result_type == "jump_link_new_buffer" or result_type == "jump_link_background_buffer": self.buffer_widget.cleanup_links() def clear_all_cookies(self): self.buffer_widget.clear_cookies() self.message_to_emacs.emit("Cleared all cookies.") def try_start_aria2_daemon(self): if not is_port_in_use(6800): with open(os.devnull, "w") as null_file: aria2_args = ["aria2c"] aria2_args.append("-d") aria2_args.append(os.path.expanduser(str(self.emacs_var_dict["eaf-browser-download-path"]))) aria2_proxy_host = str(self.emacs_var_dict["eaf-browser-aria2-proxy-host"]) aria2_proxy_port = str(self.emacs_var_dict["eaf-browser-aria2-proxy-port"]) if aria2_proxy_host != "" and aria2_proxy_port != "": aria2_args.append("--all-proxy") aria2_args.append("http://{0}:{1}".format(aria2_proxy_host, aria2_proxy_port)) aria2_args.append("--enable-rpc") aria2_args.append("--rpc-listen-all") subprocess.Popen(aria2_args, stdout=null_file) def open_download_manage_page(self): self.try_start_aria2_daemon() self.buffer_widget.open_download_manage_page() def copy_text(self): self.buffer_widget.copy_text() self.message_to_emacs.emit("Copy '" + self.buffer_widget.get_selection_text() + "'") def open_link(self): self.buffer_widget.get_link_markers() self.send_input_message("Open Link: ", "jump_link"); def open_link_new_buffer(self): self.buffer_widget.get_link_markers() self.send_input_message("Open Link in New Buffer: ", "jump_link_new_buffer"); def open_link_background_buffer(self): self.buffer_widget.get_link_markers() self.send_input_message("Open Link in Background Buffer: ", "jump_link_background_buffer"); def reset_default_zoom(self): if hasattr(self, "buffer_widget"): self.buffer_widget.setZoomFactor(float(self.emacs_var_dict["eaf-browser-default-zoom"])) def edit_focus_text(self): text = self.buffer_widget.get_focus_text() if text != None: self.get_focus_text.emit(self.buffer_id, text) else: self.message_to_emacs.emit("No active input element.") def is_focus(self): return self.buffer_widget.get_focus_text() != None def record_history(self, new_title): new_url = self.buffer_widget.filter_url(self.buffer_widget.url().toString()) if self.emacs_var_dict["eaf-browser-remember-history"] == "true" and self.buffer_widget.filter_title(new_title) != "" and \ self.arguments != "temp_html_file" and new_title != "about:blank" and new_url != "about:blank": # Throw traceback info if algorithm has bug and protection of historical record is not erased. try: noprefix_new_url_match = re.match(self.noprefix_url_pattern, new_url) if noprefix_new_url_match is not None: found = False for history in self.history_list: noprefix_url_match = re.match(self.noprefix_url_pattern, history.url) if noprefix_url_match is not None: noprefix_url = noprefix_url_match.group(2) noprefix_new_url = noprefix_new_url_match.group(2) nopostfix_new_url_match = re.match(self.nopostfix_url_pattern, noprefix_new_url) if noprefix_url == noprefix_new_url: # found unique url history.title = new_title history.url = new_url history.hit += 0.5 found = True elif nopostfix_new_url_match is not None and noprefix_url == nopostfix_new_url_match.group(): # also increment parent history.hit += 0.25 if not found: self.history_list.append(HistoryPage(new_title, new_url, 1)) self.history_list.sort(key = lambda x: x.hit, reverse = True) with open(self.history_log_file_path, "w") as f: f.writelines(map(lambda history: history.title + "ᛝ" + history.url + "ᛡ" + str(history.hit) + "\n", self.history_list)) except Exception: import traceback self.message_to_emacs.emit("Error in record_history: " + str(traceback.print_exc())) def adjust_dark_mode(self): try: if self.emacs_var_dict["eaf-browser-dark-mode"] == "true": self.dark_mode() except Exception: pass def new_blank_page(self): self.eval_in_emacs.emit('''(eaf-open \"{0}\" \"browser\" \"\" t)'''''.format(self.emacs_var_dict["eaf-browser-blank-page-url"])) def clear_history(self): if os.path.exists(self.history_log_file_path): os.remove(self.history_log_file_path) self.message_to_emacs.emit("Cleared browsing history.") else: self.message_to_emacs.emit("There is no browsing history.") def record_close_page(self, url): if self.emacs_var_dict["eaf-browser-remember-history"] == "true": touch(self.history_close_file_path) with open(self.history_close_file_path, "a") as f: f.write("{0}\n".format(url)) def recover_prev_close_page(self): if os.path.exists(self.history_close_file_path): with open(self.history_close_file_path, "r") as f: close_urls = f.readlines() if len(close_urls) > 0: # We need use rstrip remove \n char from url record. prev_close_url = close_urls.pop().rstrip() self.open_url_in_new_tab.emit(prev_close_url) open(self.history_close_file_path, "w").writelines(close_urls) self.message_to_emacs.emit("Recovery {0}".format(prev_close_url)) else: self.message_to_emacs.emit("No page need recovery.") else: self.message_to_emacs.emit("No page need recovery.") def insert_or_do(func): def _do(self, *args, **kwargs): if self.is_focus(): self.fake_key_event(self.current_event_string) else: func(self, *args, **kwargs) return _do def build_insert_or_do(self, method_name): def _do (): if self.is_focus(): self.fake_key_event(self.current_event_string) else: getattr(self, method_name)() setattr(self, "insert_or_{}".format(method_name), _do) @insert_or_do def insert_or_close_buffer(self): self.request_close_buffer() @insert_or_do def insert_or_goto_left_tab(self): self.goto_left_tab.emit() @insert_or_do def insert_or_goto_right_tab(self): self.goto_right_tab.emit() @insert_or_do def insert_or_open_url(self): self.eval_in_emacs.emit('''(call-interactively 'eaf-open-browser-with-history)''') def select_all_or_input_text(self): if self.is_focus(): self.buffer_widget.select_input_text() else: self.buffer_widget.select_all() def eval_js_file(self): self.send_input_message("Eval JS file: ", "eval_js_file", "file") def eval_js(self): self.send_input_message("Eval JS: ", "eval_js") def open_dev_tool_page(self): self.open_dev_tools_tab.emit(self.buffer_widget.web_page)