From d7daeea26ac9d3ce81b9cc104cd29a5e8baf2070 Mon Sep 17 00:00:00 2001 From: Vinicius Moreira Date: Mon, 13 Dec 2021 17:35:49 -0300 Subject: [PATCH] [web] improvement: checking for javascript fixes based on the Electron version --- CHANGELOG.md | 2 +- README.md | 4 ++-- bauh/gems/web/__init__.py | 2 +- bauh/gems/web/controller.py | 28 ++++++++++++++++------------ 4 files changed, 20 insertions(+), 16 deletions(-) diff --git a/CHANGELOG.md b/CHANGELOG.md index 49d8be1e..9cb03a65 100644 --- a/CHANGELOG.md +++ b/CHANGELOG.md @@ -8,7 +8,7 @@ The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.0.0/). ### Improvements - Web - able to specify a custom User-Agent when installing apps that demand specific settings to work properly on Electron 13.X (e.g: WhatsApp Web) - - checking for javascript fixes based on the Electron version + - checking for javascript fixes based on the Electron version (saved on disk as `~/.local/share/bauh/web/fixes/electron_{branch}/{app_name}.js`) ### Fixes - UI diff --git a/README.md b/README.md index 4eeb4b29..fd8322fa 100644 --- a/README.md +++ b/README.md @@ -324,8 +324,8 @@ will be generated at `~/.local/share/bauh/web/env` (or `/usr/local/share/bauh/we - It supports DRM protected content through a custom Electron implementation provided by [castLabs](https://github.com/castlabs/electron-releases). nativefier handles the switch between the official Electron and the custom. - The isolated environment is created based on the settings defined in [environment.yml](https://raw.githubusercontent.com/vinifmor/bauh-files/master/web/env/v1/environment.yml) (downloaded during runtime). -- Some applications require Javascript fixes to properly work. If there is a known fix, bauh will download the file from [fix](https://github.com/vinifmor/bauh-files/tree/master/web/fix) and -attach it to the generated app. +- Some applications require Javascript fixes to properly work. If there is a known fix, bauh will download the file from [fix](https://github.com/vinifmor/bauh-files/tree/master/web/env/v2/fix) and +attach it to the generated app. The fix files are saved on the disk following the pattern `~/.local/share/bauh/web/fixes/electron_{branch}/{app_name}.js` (or `/usr/local/share/bauh/web/fixes/...` for **root**) - The installed applications are located at `~/.local/share/bauh/installed` (or `/usr/local/share/bauh/web/installed` for **root**). - A desktop entry / menu shortcut will be generated for the installed applications at `~/.local/share/applications` (or `/usr/share/applications` for **root**) - If the Tray Mode **Start Minimized** is defined during the installation setup, a desktop entry will be also generated at `~/.config/autostart` (or `/etc/xdg/autostart` for **root**) diff --git a/bauh/gems/web/__init__.py b/bauh/gems/web/__init__.py index 2540add2..be24aef1 100644 --- a/bauh/gems/web/__init__.py +++ b/bauh/gems/web/__init__.py @@ -10,7 +10,7 @@ WEB_SHARED_DIR = f'{SHARED_FILES_DIR}/web' WEB_CACHE_DIR = f'{CACHE_DIR}/web' INSTALLED_PATH = f'{WEB_SHARED_DIR}/installed' ENV_PATH = f'{WEB_SHARED_DIR}/env' -FIXES_PATH = f'{WEB_SHARED_DIR}/fixes' +FIX_FILE_PATH = WEB_SHARED_DIR + '/fixes/{electron_branch}/{app_id}.js' NODE_DIR_PATH = f'{ENV_PATH}/node' NODE_PATHS = {f'{NODE_DIR_PATH}/bin'} NODE_BIN_PATH = f'{NODE_DIR_PATH}/bin/node' diff --git a/bauh/gems/web/controller.py b/bauh/gems/web/controller.py index 062a9b7f..d0496634 100644 --- a/bauh/gems/web/controller.py +++ b/bauh/gems/web/controller.py @@ -32,7 +32,7 @@ from bauh.commons.boot import CreateConfigFile from bauh.commons.html import bold from bauh.commons.system import ProcessHandler, get_dir_size, get_human_size_str, SimpleProcess from bauh.gems.web import INSTALLED_PATH, nativefier, DESKTOP_ENTRY_PATH_PATTERN, URL_FIX_PATTERN, ENV_PATH, UA_CHROME, \ - SUGGESTIONS_CACHE_FILE, ROOT_DIR, TEMP_PATH, FIXES_PATH, ELECTRON_CACHE_DIR, \ + SUGGESTIONS_CACHE_FILE, ROOT_DIR, TEMP_PATH, FIX_FILE_PATH, ELECTRON_CACHE_DIR, \ get_icon_path from bauh.gems.web.config import WebConfigManager from bauh.gems.web.environment import EnvironmentUpdater, EnvironmentComponent @@ -182,9 +182,8 @@ class WebApplicationManager(SoftwareManager): return description def _get_fix_for(self, url_domain: str, electron_version: str) -> str: - electron_branch = f"electron_{'_'.join(electron_version.split('.')[0:-1])}_X" fix_url = URL_FIX_PATTERN.format(domain=url_domain, - electron_branch=electron_branch) + electron_branch=self._map_electron_branch(electron_version)) try: res = self.http_client.get(fix_url, session=False) @@ -193,6 +192,9 @@ class WebApplicationManager(SoftwareManager): except Exception as e: self.logger.warning("Error when trying to retrieve a fix for {}: {}".format(fix_url, e.__class__.__name__)) + def _map_electron_branch(self, version: str) -> str: + return f"electron_{'_'.join(version.split('.')[0:-1])}_X" + def _strip_url_protocol(self, url: str) -> str: return RE_PROTOCOL_STRIP.split(url)[1].strip().lower() @@ -404,16 +406,15 @@ class WebApplicationManager(SoftwareManager): type_=MessageType.WARNING) traceback.print_exc() - self.logger.info("Checking if there is any Javascript fix file associated with {} ".format(pkg.name)) - - fix_path = '{}/{}.js'.format(FIXES_PATH, pkg.id) + self.logger.info(f"Checking for Javascript fix file associated with {pkg.name}") + fix_path = FIX_FILE_PATH.format(app_id=pkg.id, electron_branch=self._map_electron_branch(pkg.version)) if os.path.isfile(fix_path): - self.logger.info("Removing fix file '{}'".format(fix_path)) + self.logger.info(f"Removing fix file '{fix_path}'") try: os.remove(fix_path) except: - self.logger.error("Could not remove fix file '{}'".format(fix_path)) + self.logger.error(f"Could not remove fix file '{fix_path}'") traceback.print_exc() watcher.show_message(title=self.i18n['error'], body=self.i18n['web.uninstall.error.remove'].format(bold(fix_path)), @@ -667,17 +668,20 @@ class WebApplicationManager(SoftwareManager): electron_version = str(next((c for c in env_components if c.id == 'electron')).version) fix = self._get_fix_for(url_domain=self._strip_url_protocol(pkg.url), electron_version=electron_version) - fix_path = '{}/{}.js'.format(FIXES_PATH, app_id) if fix: # just adding the fix as an installation option. The file will be written later fix_log = f'Fix found for {pkg.url} (electron={electron_version}, widevine={widevine_support})' self.logger.info(fix_log) watcher.print(fix_log) - install_options.append('--inject={}'.format(fix_path)) - Path(FIXES_PATH).mkdir(exist_ok=True, parents=True) - self.logger.info('Writting JS fix at {}'.format(fix_path)) + fix_path = FIX_FILE_PATH.format(app_id=pkg.id, electron_branch=self._map_electron_branch(electron_version)) + Path(os.path.dirname(fix_path)).mkdir(parents=True, exist_ok=True) + + install_options.append(f'--inject={fix_path}') + Path(FIX_FILE_PATH).mkdir(exist_ok=True, parents=True) + + self.logger.info(f'Writting JS fix at {fix_path}') with open(fix_path, 'w+') as f: f.write(fix)