Merge pull request #124 from chrisknepper/feature/spell-check-2

Feature/spell check 2

Author: chrisknepper

.gitignore

@@ -11,3 +11,6 @@ Thumbs.db
 /app/background.js
 /app/bridge.js
 /app/**/*.map
+
+# Dictionary files are downloaded by the user's machine
+/resources/dictionaries/**/*

CHANGELOG.md

@@ -1,5 +1,17 @@
 # Changelog
 
+## [0.8.0] - 2019-02-12
+### Added
+- Spellchecking for various languages (see notes in README)
+- Manually refreshing the webview for those times when the app gets all 🤪 (Accessible by pressing Ctrl+R or Cmd+R)
+- Full screen toggle item to View menu
+
+### Changed
+- Update electron from 2.0.12 to 3.1.3 (Electron 3 is required by electron-updater 4 which is required by electron-builder 20)
+
+### Fixed
+- Location of Check for Updates menu item on Windows (Now under Help)
+
 ## [0.7.1] - 2018-11-17
 ### Changed
 - Update electron from 2.0.2 to 2.0.12

README.md

@@ -28,16 +28,20 @@ Head over to the [latest releases](https://github.com/chrisknepper/android-messa
 
 **Important note:** The Windows app binary isn't signed. This doesn't seem to be a big problem, but please report any issues you run into on Windows that may be related to signing.
 
-**Important note 2:** We currently have builds for Windows and macOS, and Linux. I've only tested on macOS and Windows 10, and would love help testing on Linux and older versions of Windows.
+**Important note 2:** We currently have builds for Windows and macOS, and Linux. I test releases on macOS, Windows 10, and Ubuntu Linux. I would love help testing on additional distros of Linux and other versions of Windows.
 
 # Features
 * System notifications when a text comes in
 * Notification badges on macOS
+* Spellchecking in ~50 languages
 * Run in background on Windows / Linux / macOS
 * Minimize to tray on Windows / Linux
 * Menu bar support on macOS
 * TBD...
 
+# Spellchecking
+Implemented via the amazing [`electron-hunpsell`](https://github.com/kwonoj/electron-hunspell) library with dictionaries provided by the excellent [`dictionaries`](https://github.com/wooorm/dictionaries) project. Language files are downloaded when the app opens and the language used is based on the language set in your operating system. If you switch your system language and restart the app, the spellchecking should occur in the new language as long as it is in the [list of supported languages](https://github.com/wooorm/dictionaries#table-of-dictionaries).
+
 # TODOs / Roadmap (rough order of priority):
 - [x] Make sure it actually works (definitely works as of v0.1.0, done via [8068ed2](../../commit/8068ed2))
 - [x] Release signed binaries for macOS (binaries are signed as of v0.0.2, done via [8492023](../../commit/8492023))

package-lock.json

@@ -4,7 +4,7 @@
   "description": "Messages for web, as a desktop app",
   "version": "0.7.1",
   "author": "Chris Knepper <[email protected]>",
-  "copyright": "© 2018 Chris Knepper",
+  "copyright": "© 2018-2019 Chris Knepper",
   "homepage": "https://github.com/chrisknepper/android-messages-desktop",
   "repository": {
     "type": "git",
@@ -25,6 +25,9 @@
     "directories": {
       "buildResources": "resources"
     },
+    "extraResources": [
+      "resources/dictionaries"
+    ],
     "mac": {
       "category": "public.app-category.social-networking",
       "target": [
@@ -43,7 +46,7 @@
     }
   },
   "scripts": {
-    "postinstall": "electron-builder install-app-deps",
+    "postinstall": "electron-builder install-app-deps && npm run install-hunspell && npm run build-hunspell",
     "preunit": "webpack --config=build/webpack.unit.config.js --env=test --display=none",
     "unit": "electron-mocha temp/specs.js --renderer --require source-map-support/register",
     "pree2e": "webpack --config=build/webpack.app.config.js --env=test --display=none && webpack --config=build/webpack.e2e.config.js --env=test --display=none",
@@ -53,13 +56,17 @@
     "release": "npm test && webpack --config=build/webpack.app.config.js --env=production && electron-builder -mwl",
     "build": "webpack --config=build/webpack.app.config.js --env=production && electron-builder --publish never",
     "build-all": "webpack --config=build/webpack.app.config.js --env=production && electron-builder -mwl --publish never",
-    "generate-icons": "png2icons assets/android_messages_desktop_icon.png resources/icon -all -i"
+    "generate-icons": "png2icons assets/android_messages_desktop_icon.png resources/icon -all -i",
+    "install-hunspell": "npm --prefix ./node_modules/electron-hunspell install",
+    "build-hunspell": "npm --prefix ./node_modules/electron-hunspell run build"
   },
   "dependencies": {
     "about-window": "^1.11.1",
+    "electron-hunspell": "https://github.com/kwonoj/electron-hunspell/tarball/v1.0.0-beta.5",
     "electron-settings": "^3.2.0",
-    "electron-updater": "^2.21.10",
-    "fs-jetpack": "^1.0.0"
+    "electron-updater": "4.0.6",
+    "fs-jetpack": "^1.0.0",
+    "hunspell-asm": "^1.1.2"
   },
   "devDependencies": {
     "@babel/core": "^7.0.0-beta.5",
@@ -68,7 +75,7 @@
     "babel-plugin-transform-object-rest-spread": "^7.0.0-beta.3",
     "chai": "^4.1.0",
     "css-loader": "^0.28.7",
-    "electron": "2.0.12",
+    "electron": "3.1.3",
     "electron-builder": "^20.15.1",
     "electron-mocha": "^6.0.4",
     "file-loader": "^1.1.11",

package.json

@@ -0,0 +1,10 @@
+# Ignore everything in this directory
+*
+# Except this file
+!.gitignore
+
+# This, along with the extraFiles electron-builder directive in package.json ensures that
+# resources/dictionaries folder is included as an empty folder in production/user-facing builds.
+# It must be done this way because some OSes install the app to a location from which the user does not
+# have the permission to create a subdirectory unless they run the app as root. Namely, Ubuntu, via the .deb,
+# installs the app to /opt/ and calling node mkdir only works as root from there.

resources/dictionaries/.gitignore

@@ -12,9 +12,10 @@ import { devMenuTemplate } from './menu/dev_menu_template';
 import { settingsMenu } from './menu/settings_menu_template';
 import { helpMenuTemplate } from './menu/help_menu_template';
 import createWindow from './helpers/window';
+import DictionaryManager from './helpers/dictionary_manager';
 import TrayManager from './helpers/tray/tray_manager';
 import settings from 'electron-settings';
-import { IS_MAC, IS_WINDOWS, IS_LINUX, IS_DEV, SETTING_TRAY_ENABLED, SETTING_TRAY_CLICK_SHORTCUT, EVENT_WEBVIEW_NOTIFICATION, EVENT_NOTIFICATION_REFLECT_READY } from './constants';
+import { IS_MAC, IS_WINDOWS, IS_LINUX, IS_DEV, SETTING_TRAY_ENABLED, SETTING_TRAY_CLICK_SHORTCUT, SETTING_CUSTOM_WORDS, EVENT_WEBVIEW_NOTIFICATION, EVENT_NOTIFICATION_REFLECT_READY, EVENT_BRIDGE_INIT, EVENT_SPELL_ADD_CUSTOM_WORD, EVENT_SPELLING_REFLECT_READY } from './constants';
 
 // Special module holding environment variables which you declared
 // in config/env_xxx.json file.
@@ -181,6 +182,57 @@ if (isSecondInstance) {
       }
     });
 
+    ipcMain.on(EVENT_BRIDGE_INIT, async (event) => {
+
+      let spellCheckFiles = null;
+      let customWords = null;
+      const currentLanguage = app.getLocale();
+      try {
+        // TODO: Possibly don't check supported-languages.json every load if local dictionary files already exist
+        const supportedLanguages = await DictionaryManager.getSupportedLanguages();
+
+        const dictionaryLocaleKey = DictionaryManager.doesLanguageExistForLocale(currentLanguage, supportedLanguages);
+
+        if (dictionaryLocaleKey) { // Spellchecking is supported for the current language
+          spellCheckFiles = await DictionaryManager.getLanguagePath(currentLanguage, dictionaryLocaleKey);
+
+          // We send an event with the language key and array of custom words to the webview bridge which contains the
+          // instance of the spellchecker. Done this way because passing class instances (i.e. of the spellchecker)
+          // between electron processes is hacky at best and impossible at worst.
+          const existingCustomWords = settings.get(SETTING_CUSTOM_WORDS, {});
+
+          customWords = {};
+          if (currentLanguage in existingCustomWords) {
+            customWords = { [currentLanguage]: existingCustomWords[currentLanguage] };
+          }
+        }
+      }
+      catch (error) {
+        // TODO: Display this as an error message to the user?
+      }
+
+      event.sender.send(EVENT_SPELLING_REFLECT_READY, {
+        dictionaryLocaleKey: currentLanguage,
+        spellCheckFiles,
+        customWords
+      });
+    });
+
+    ipcMain.on(EVENT_SPELL_ADD_CUSTOM_WORD, (event, msg) => {
+      // Add custom words picked by the user to a persistent data store because they must be added to
+      // the instance of Hunspell on each launch of the app/loading of the dictionary.
+      const { newCustomWord } = msg;
+      const currentLanguage = app.getLocale();
+      const existingCustomWords = settings.get(SETTING_CUSTOM_WORDS, {});
+      if (!(currentLanguage in existingCustomWords)) {
+        existingCustomWords[currentLanguage] = [];
+      }
+      if (newCustomWord && !existingCustomWords[currentLanguage].includes(newCustomWord)) {
+        existingCustomWords[currentLanguage].push(newCustomWord);
+        settings.set(SETTING_CUSTOM_WORDS, existingCustomWords);
+      }
+    });
+
     let quitViaContext = false;
     app.on('before-quit', () => {
       quitViaContext = true;

src/background.js

@@ -1,4 +1,5 @@
 import env from 'env';
+import path from 'path';
 
 const osMap = {
     win32: 'Windows',
@@ -15,14 +16,25 @@ const IS_LINUX = (osName === 'linux');
 
 // Environment
 const IS_DEV = (env.name === 'development');
+const BASE_APP_PATH = IS_DEV ? path.join(__dirname, '..') : process.resourcesPath;
+const RESOURCES_PATH = path.join(BASE_APP_PATH, 'resources');
+const SPELLING_DICTIONARIES_PATH = path.join(RESOURCES_PATH, 'dictionaries');
+const SUPPORTED_LANGUAGES_PATH = path.join(SPELLING_DICTIONARIES_PATH, 'supported-languages.json');
 
 // Settings
 const SETTING_TRAY_ENABLED = 'trayEnabledPref';
 const SETTING_TRAY_CLICK_SHORTCUT = 'trayClickShortcut';
+const SETTING_CUSTOM_WORDS = 'savedCustomDictionaryWords'
 
 // Events
 const EVENT_WEBVIEW_NOTIFICATION = 'messages-webview-notification';
 const EVENT_NOTIFICATION_REFLECT_READY = 'messages-webview-reflect-ready';
+const EVENT_BRIDGE_INIT = 'messages-bridge-init';
+const EVENT_SPELL_ADD_CUSTOM_WORD = 'messages-spelling-add-custom-word';
+const EVENT_SPELLING_REFLECT_READY = 'messages-spelling-reflect-ready';
+
+// Misc.
+const DICTIONARY_CACHE_TIME = 2592000000; // 30 days in milliseconds
 
 export {
     osName,
@@ -31,8 +43,17 @@ export {
     IS_MAC,
     IS_LINUX,
     IS_DEV,
+    BASE_APP_PATH,
+    RESOURCES_PATH,
+    SPELLING_DICTIONARIES_PATH,
+    SUPPORTED_LANGUAGES_PATH,
     SETTING_TRAY_ENABLED,
     SETTING_TRAY_CLICK_SHORTCUT,
+    SETTING_CUSTOM_WORDS,
     EVENT_WEBVIEW_NOTIFICATION,
-    EVENT_NOTIFICATION_REFLECT_READY
+    EVENT_NOTIFICATION_REFLECT_READY,
+    EVENT_BRIDGE_INIT,
+    EVENT_SPELL_ADD_CUSTOM_WORD,
+    EVENT_SPELLING_REFLECT_READY,
+    DICTIONARY_CACHE_TIME
 };