Synchronize with Franz 5.6.0 (#1033)

Co-authored-by: FranzBot <i18n@meetfranz.com>
Co-authored-by: vantezzen <hello@vantezzen.io>
Co-authored-by: Makazzz <makazzzpro@live.ca>
Co-authored-by: Stefan Malzner <stefan@adlk.io>
Co-authored-by: Amine Mouafik <amine@mouafik.fr>

4 files changed, 86 insertions, 108 deletions

diff --git a/src/webview/contextMenu.js b/src/webview/contextMenu.js
index d04f90830..679bf5aaa 100644
--- a/src/webview/contextMenu.js
+++ b/src/webview/contextMenu.js
@@ -3,12 +3,18 @@ import ContextMenuBuilder from './contextMenuBuilder';
 
 const webContents = remote.getCurrentWebContents();
 
-export default async function setupContextMenu() {
+export default async function setupContextMenu(isSpellcheckEnabled, getDefaultSpellcheckerLanguage, getSpellcheckerLanguage) {
   const contextMenuBuilder = new ContextMenuBuilder(
     webContents,
   );
 
-  webContents.on('context-menu', (event, params) => {
-    contextMenuBuilder.showPopupMenu(params);
+  webContents.on('context-menu', (e, props) => {
+    // TODO?: e.preventDefault();
+    contextMenuBuilder.showPopupMenu(
+      props,
+      isSpellcheckEnabled(),
+      getDefaultSpellcheckerLanguage(),
+      getSpellcheckerLanguage(),
+    );
   });
 }
diff --git a/src/webview/contextMenuBuilder.js b/src/webview/contextMenuBuilder.js
index 8adc3b432..d99dd6739 100644
--- a/src/webview/contextMenuBuilder.js
+++ b/src/webview/contextMenuBuilder.js
@@ -21,19 +21,19 @@ function matchesWord(string) {
 }
 
 const contextMenuStringTable = {
-  copyMail: () => 'Copy Email Address',
-  copyLinkUrl: () => 'Copy Link',
-  openLinkUrl: () => 'Open Link',
-  copyImageUrl: () => 'Copy Image URL',
-  copyImage: () => 'Copy Image',
-  addToDictionary: () => 'Add to Dictionary',
   lookUpDefinition: ({ word }) => `Look Up "${word}"`,
-  searchGoogle: () => 'Search with Google',
   cut: () => 'Cut',
   copy: () => 'Copy',
   paste: () => 'Paste',
-  inspectElement: () => 'Inspect Element',
+  searchGoogle: () => 'Search with Google',
+  openLinkUrl: () => 'Open Link',
+  copyLinkUrl: () => 'Copy Link',
+  copyImageUrl: () => 'Copy Image Address',
+  copyImage: () => 'Copy Image',
+  addToDictionary: () => 'Add to Dictionary',
   goToHomePage: () => 'Go to Home Page',
+  copyMail: () => 'Copy Email Address',
+  inspectElement: () => 'Inspect Element',
 };
 
 /**
@@ -225,13 +225,13 @@ module.exports = class ContextMenuBuilder {
    * if so, adds suggested spellings as individual menu items.
    */
   addSpellingItems(menu, menuInfo) {
-    const target = this.getWebContents();
+    const webContents = this.getWebContents();
     // Add each spelling suggestion
     for (const suggestion of menuInfo.dictionarySuggestions) {
       menu.append(new MenuItem({
         label: suggestion,
         // eslint-disable-next-line no-loop-func
-        click: () => target.replaceMisspelling(suggestion),
+        click: () => webContents.replaceMisspelling(suggestion),
       }));
     }
 
@@ -240,7 +240,7 @@ module.exports = class ContextMenuBuilder {
       menu.append(
         new MenuItem({
           label: 'Add to dictionary',
-          click: () => target.session.addWordToSpellCheckerDictionary(menuInfo.misspelledWord),
+          click: () => webContents.session.addWordToSpellCheckerDictionary(menuInfo.misspelledWord),
         }),
       );
     }
@@ -262,11 +262,11 @@ module.exports = class ContextMenuBuilder {
     }
 
     if (process.platform === 'darwin') {
-      const target = this.getWebContents();
+      const webContents = this.getWebContents();
 
       const lookUpDefinition = new MenuItem({
         label: this.stringTable.lookUpDefinition({ word: menuInfo.selectionText.trim() }),
-        click: () => target.showDefinitionForSelection(),
+        click: () => webContents.showDefinitionForSelection(),
       });
 
       menu.append(lookUpDefinition);
@@ -316,12 +316,12 @@ module.exports = class ContextMenuBuilder {
    * Adds the Cut menu item
    */
   addCut(menu, menuInfo) {
-    const target = this.getWebContents();
+    const webContents = this.getWebContents();
     menu.append(new MenuItem({
       label: this.stringTable.cut(),
       accelerator: 'CommandOrControl+X',
       enabled: menuInfo.editFlags.canCut,
-      click: () => target.cut(),
+      click: () => webContents.cut(),
     }));
 
     return menu;
@@ -331,12 +331,12 @@ module.exports = class ContextMenuBuilder {
    * Adds the Copy menu item.
    */
   addCopy(menu, menuInfo) {
-    const target = this.getWebContents();
+    const webContents = this.getWebContents();
     menu.append(new MenuItem({
       label: this.stringTable.copy(),
       accelerator: 'CommandOrControl+C',
       enabled: menuInfo.editFlags.canCopy,
-      click: () => target.copy(),
+      click: () => webContents.copy(),
     }));
 
     return menu;
@@ -346,12 +346,12 @@ module.exports = class ContextMenuBuilder {
    * Adds the Paste menu item.
    */
   addPaste(menu, menuInfo) {
-    const target = this.getWebContents();
+    const webContents = this.getWebContents();
     menu.append(new MenuItem({
       label: this.stringTable.paste(),
       accelerator: 'CommandOrControl+V',
       enabled: menuInfo.editFlags.canPaste,
-      click: () => target.paste(),
+      click: () => webContents.paste(),
     }));
 
     return menu;
@@ -363,12 +363,12 @@ module.exports = class ContextMenuBuilder {
       && !menuInfo.linkText
       && !menuInfo.hasImageContents
     ) {
-      const target = this.getWebContents();
+      const webContents = this.getWebContents();
       menu.append(
         new MenuItem({
           label: 'Paste as plain text',
           accelerator: 'CommandOrControl+Shift+V',
-          click: () => target.pasteAndMatchStyle(),
+          click: () => webContents.pasteAndMatchStyle(),
         }),
       );
     }
@@ -386,13 +386,13 @@ module.exports = class ContextMenuBuilder {
    * Adds the "Inspect Element" menu item.
    */
   addInspectElement(menu, menuInfo, needsSeparator = true) {
-    const target = this.getWebContents();
+    const webContents = this.getWebContents();
     if (!this.debugMode) return menu;
     if (needsSeparator) this.addSeparator(menu);
 
     const inspect = new MenuItem({
       label: this.stringTable.inspectElement(),
-      click: () => target.inspectElement(menuInfo.x, menuInfo.y),
+      click: () => webContents.inspectElement(menuInfo.x, menuInfo.y),
     });
 
     menu.append(inspect);
@@ -436,7 +436,7 @@ module.exports = class ContextMenuBuilder {
       accelerator: 'CommandOrControl+Home',
       enabled: true,
       click: () => {
-        // target.loadURL(baseURL.origin);
+        // webContents.loadURL(baseURL.origin);
         window.location.href = baseURL.origin;
       },
     }));
diff --git a/src/webview/recipe.js b/src/webview/recipe.js
index 675f8e311..d29f3edbd 100644
--- a/src/webview/recipe.js
+++ b/src/webview/recipe.js
@@ -3,7 +3,6 @@ import { ipcRenderer, remote, desktopCapturer } from 'electron';
 import path from 'path';
 import { autorun, computed, observable } from 'mobx';
 import fs from 'fs-extra';
-import { loadModule } from 'cld3-asm';
 import { debounce } from 'lodash';
 import { FindInPage } from 'electron-find';
 
@@ -23,8 +22,9 @@ import customDarkModeCss from './darkmode/custom';
 import RecipeWebview from './lib/RecipeWebview';
 import Userscript from './lib/Userscript';
 
-import spellchecker, { switchDict, disable as disableSpellchecker, getSpellcheckerLocaleByFuzzyIdentifier } from './spellchecker';
+import { switchDict, getSpellcheckerLocaleByFuzzyIdentifier } from './spellchecker';
 import { injectDarkModeStyle, isDarkModeStyleInjected, removeDarkModeStyle } from './darkmode';
+import contextMenu from './contextMenu';
 import './notifications';
 
 import { DEFAULT_APP_SETTINGS } from '../config';
@@ -156,7 +156,14 @@ class RecipeController {
 
     debug('Send "hello" to host');
     setTimeout(() => ipcRenderer.sendToHost('hello'), 100);
-    await spellchecker();
+
+    this.spellcheckingProvider = null;
+    contextMenu(
+      () => this.settings.app.enableSpellchecking,
+      () => this.settings.app.spellcheckerLanguage,
+      () => this.spellcheckerLanguage,
+    );
+
     autorun(() => this.update());
 
     document.addEventListener('DOMContentLoaded', () => {
@@ -240,22 +247,15 @@ class RecipeController {
 
     if (this.settings.app.enableSpellchecking) {
       debug('Setting spellchecker language to', this.spellcheckerLanguage);
-      const { spellcheckerLanguage } = this;
+      let { spellcheckerLanguage } = this;
       if (spellcheckerLanguage.includes('automatic')) {
         this.automaticLanguageDetection();
         debug('Found `automatic` locale, falling back to user locale until detected', this.settings.app.locale);
-        spellcheckerLanguage.push(this.settings.app.locale);
-      } else if (this.cldIdentifier) {
-        this.cldIdentifier.destroy();
+        spellcheckerLanguage = this.settings.app.locale;
       }
       switchDict(spellcheckerLanguage);
     } else {
       debug('Disable spellchecker');
-      disableSpellchecker();
-
-      if (this.cldIdentifier) {
-        this.cldIdentifier.destroy();
-      }
     }
 
     if (!this.recipe) {
@@ -366,10 +366,7 @@ class RecipeController {
   }
 
   async automaticLanguageDetection() {
-    const cldFactory = await loadModule();
-    this.cldIdentifier = cldFactory.create(0, 1000);
-
-    window.addEventListener('keyup', debounce((e) => {
+    window.addEventListener('keyup', debounce(async (e) => {
       const element = e.target;
 
       if (!element) return;
@@ -382,22 +379,15 @@ class RecipeController {
       }
 
       // Force a minimum length to get better detection results
-      if (value.length < 30) return;
+      if (value.length < 25) return;
 
       debug('Detecting language for', value);
-      const findResult = this.cldIdentifier.findLanguage(value);
-
-      debug('Language detection result', findResult);
-
-      if (findResult.is_reliable) {
-        const spellcheckerLocale = getSpellcheckerLocaleByFuzzyIdentifier(findResult.language);
-        debug('Language detected reliably, setting spellchecker language to', spellcheckerLocale);
-        if (spellcheckerLocale) {
-          switchDict([
-            ...this.spellcheckerLanguage,
-            spellcheckerLocale,
-          ]);
-        }
+      const locale = await ipcRenderer.invoke('detect-language', { sample: value });
+
+      const spellcheckerLocale = getSpellcheckerLocaleByFuzzyIdentifier(locale);
+      debug('Language detected reliably, setting spellchecker language to', spellcheckerLocale);
+      if (spellcheckerLocale) {
+        switchDict(spellcheckerLocale);
       }
     }, 225));
   }
@@ -411,7 +401,8 @@ new RecipeController();
 const originalWindowOpen = window.open;
 
 window.open = (url, frameName, features) => {
-  if (!url && !frameName && !features) {
+  debug('window.open', url, frameName, features);
+  if (!url) {
     // The service hasn't yet supplied a URL (as used in Skype).
     // Return a new dummy window object and wait for the service to change the properties
     const newWindow = {
@@ -423,8 +414,12 @@ window.open = (url, frameName, features) => {
     const checkInterval = setInterval(() => {
       // Has the service changed the URL yet?
       if (newWindow.location.href !== '') {
-        // Open the new URL
-        ipcRenderer.sendToHost('new-window', newWindow.location.href);
+        if (features) {
+          originalWindowOpen(newWindow.location.href, frameName, features);
+        } else {
+          // Open the new URL
+          ipcRenderer.sendToHost('new-window', newWindow.location.href);
+        }
         clearInterval(checkInterval);
       }
     }, 0);
diff --git a/src/webview/spellchecker.js b/src/webview/spellchecker.js
index 287c9cf11..e7ef102e9 100644
--- a/src/webview/spellchecker.js
+++ b/src/webview/spellchecker.js
@@ -1,64 +1,41 @@
-import { webFrame } from 'electron';
+import {
+  remote,
+} from 'electron';
 import { SPELLCHECKER_LOCALES } from '../i18n/languages';
-import setupContextMenu from './contextMenu';
+import { isMac } from '../environment';
 
 const debug = require('debug')('Franz:spellchecker');
 
-let _isEnabled = false;
+const webContents = remote.getCurrentWebContents();
+const [defaultLocale] = webContents.session.getSpellCheckerLanguages();
+debug('Spellchecker default locale is', defaultLocale);
 
-export async function switchDict(locales) {
-  const { platform } = process;
-  if (platform === 'darwin') {
-    // MacOS uses the build-in languages which cannot be changed
-    return;
-  }
-
-  try {
-    debug('Trying to load dictionary', locales);
-
-    webFrame.session.setSpellCheckerLanguages([...locales, 'en-US']);
-
-    debug('Switched dictionary to', locales);
-
-    _isEnabled = true;
-  } catch (err) {
-    console.error(err);
-  }
-}
-
-export default async function initialize(languages = ['en-us']) {
-  try {
-    debug('Init spellchecker');
-
-    switchDict([
-      navigator.language,
-      ...languages,
-    ]);
-    setupContextMenu();
+export function getSpellcheckerLocaleByFuzzyIdentifier(identifier) {
+  const locales = Object.keys(SPELLCHECKER_LOCALES).filter(key => key.toLocaleLowerCase() === identifier.toLowerCase() || key.split('-')[0] === identifier.toLowerCase());
 
-    return true;
-  } catch (err) {
-    console.error(err);
-    return false;
+  if (locales.length >= 1) {
+    return locales[0];
   }
-}
 
-export function isEnabled() {
-  return _isEnabled;
+  return null;
 }
 
-export function disable() {
-  if (isEnabled()) {
-    // TODO: How to disable build-in spellchecker?
+export function switchDict(locale) {
+  if (isMac) {
+    debug('Ignoring dictionary changes on macOS');
+    return;
   }
-}
 
-export function getSpellcheckerLocaleByFuzzyIdentifier(identifier) {
-  const locales = Object.keys(SPELLCHECKER_LOCALES).filter(key => key === identifier.toLowerCase() || key.split('-')[0] === identifier.toLowerCase());
+  debug('Setting spellchecker locale to', locale);
 
-  if (locales.length >= 1) {
-    return locales[0];
+  const locales = [];
+  const foundLocale = getSpellcheckerLocaleByFuzzyIdentifier(locale);
+
+  if (foundLocale) {
+    locales.push(foundLocale);
   }
 
-  return null;
+  locales.push(defaultLocale, 'de');
+
+  webContents.session.setSpellCheckerLanguages(locales);
 }