release: 🎉 new release v2.3.5.

This PR adds a params-util.js file which checks wheather the
page_params exists or not.

Fixes: #517.

app/main/index.js

@@ -73,7 +73,8 @@ function createMainWindow() {
 		minHeight: 400,
 		webPreferences: {
 			plugins: true,
-			nodeIntegration: true
+			nodeIntegration: true,
+			partition: 'persist:webviewsession'
 		},
 		show: false
 	});
@@ -246,11 +247,42 @@ app.on('ready', () => {
 		page.session.once('will-download', (event, item) => {
 			const filePath = path.join(downloadPath, item.getFilename());
 			item.setSavePath(filePath);
-			item.once('done', () => {
-				page.send('downloadFileCompleted', filePath, item.getFilename());
+			item.on('updated', (event, state) => {
+				switch (state) {
+					case 'interrupted' : {
+						// Can interrupted to due to network error, cancel download then
+						console.log('Download interrupted, cancelling and fallback to dialog download.');
+						item.cancel();
+						break;
+					}
+					case 'progressing': {
+						if (item.isPaused()) {
+							item.cancel();
+						}
+						// This event can also be used to show progres in percentage in future.
+						break;
+					}
+					default: {
+						console.info('Unknown updated state of download item');
+					}
+				}
+			});
+			item.once('done', (event, state) => {
+				if (state === 'completed') {
+					page.send('downloadFileCompleted', item.getSavePath(), item.getFilename());
+				} else {
+					console.log('Download failed state: ', state);
+					page.send('downloadFileFailed');
+				}
+				// To stop item for listening to updated events of this file
+				item.removeAllListeners('updated');
 			});
 		});
 	});
+
+	ipcMain.on('realm-icon-changed', (event, serverURL, iconURL) => {
+		page.send('update-realm-icon', serverURL, iconURL);
+	});
 });
 
 app.on('before-quit', () => {

app/package-lock.json

@@ -1,6 +1,6 @@
 {
   "name": "zulip",
-  "version": "2.3.2",
+  "version": "2.3.5",
   "lockfileVersion": 1,
   "requires": true,
   "dependencies": {

app/package.json

@@ -1,7 +1,7 @@
 {
   "name": "zulip",
   "productName": "Zulip",
-  "version": "2.3.3",
+  "version": "2.3.5",
   "description": "Zulip Desktop App",
   "license": "Apache-2.0",
   "copyright": "Kandra Labs, Inc.",

app/renderer/css/preference.css

@@ -388,8 +388,7 @@ i.open-tab-button {
 .selected-css-path,
 .download-folder-path {
     background: #eeeeee;
-    padding: 10px;
-    margin-top: 10px;
+    padding: 5px 10px;
     margin-right: 10px;
     display: flex;
     width: 90%;
@@ -565,7 +564,7 @@ input.toggle-round:checked+label:after {
 
 .certificate-input {
      width:100%;
-     margin-top: 10px; 
+     margin-top: 10px;
      display:inline-flex;
 }
 

app/renderer/js/components/handle-external-link.js

@@ -10,24 +10,26 @@ function handleExternalLink(event) {
 	const { url } = event;
 	const domainPrefix = DomainUtil.getDomain(this.props.index).url;
 	const downloadPath = ConfigUtil.getConfigItem('downloadsPath', `${app.getPath('downloads')}`);
-  // Whitelist URLs which are allowed to be opened in the app
+	const shouldShowInFolder = ConfigUtil.getConfigItem('showDownloadFolder', false);
+
+	// Whitelist URLs which are allowed to be opened in the app
 	const {
-    isInternalUrl: isWhiteListURL,
-    isUploadsUrl: isUploadsURL
-  } = LinkUtil.isInternal(domainPrefix, url);
+		isInternalUrl: isWhiteListURL,
+		isUploadsUrl: isUploadsURL
+	} = LinkUtil.isInternal(domainPrefix, url);
 
 	if (isWhiteListURL) {
 		event.preventDefault();
 
-    // download txt, pdf, mp3, mp4 etc.. by using downloadURL in the
-    // main process which allows the user to save the files to their desktop
-    // and not trigger webview reload while image in webview will
-    // do nothing and will not save it
+		// download txt, pdf, mp3, mp4 etc.. by using downloadURL in the
+		// main process which allows the user to save the files to their desktop
+		// and not trigger webview reload while image in webview will
+		// do nothing and will not save it
 		if (!LinkUtil.isImage(url) && isUploadsURL) {
 			ipcRenderer.send('downloadFile', url, downloadPath);
 			ipcRenderer.once('downloadFileCompleted', (event, filePath, fileName) => {
 				const downloadNotification = new Notification('Download Complete', {
-					body: `Click to open ${fileName}`,
+					body: shouldShowInFolder ? `Click to show ${fileName} in folder` : `Click to open ${fileName}`,
 					silent: true // We'll play our own sound - ding.ogg
 				});
 
@@ -37,13 +39,27 @@ function handleExternalLink(event) {
 				}
 
 				downloadNotification.onclick = () => {
-					shell.openItem(filePath);
+					if (shouldShowInFolder) {
+						// Reveal file in download folder
+						shell.showItemInFolder(filePath);
+					} else {
+						// Open file in the default native app
+						shell.openItem(filePath);
+					}
 				};
+				ipcRenderer.removeAllListeners('downloadFileFailed');
+			});
+
+			ipcRenderer.once('downloadFileFailed', () => {
+				// Automatic download failed, so show save dialog prompt and download
+				// through webview
+				this.$el.downloadURL(url);
+				ipcRenderer.removeAllListeners('downloadFileCompleted');
 			});
 			return;
 		}
 
-    // open internal urls inside the current webview.
+		// open internal urls inside the current webview.
 		this.$el.loadURL(url);
 	} else {
 		event.preventDefault();

app/renderer/js/electron-bridge.js

@@ -0,0 +1,39 @@
+const events = require('events');
+const { ipcRenderer } = require('electron');
+
+// we have and will have some non camelcase stuff
+// while working with zulip so just turning the rule off
+// for the whole file.
+/* eslint-disable camelcase */
+class ElectronBridge extends events {
+	send_event(...args) {
+		this.emit(...args);
+	}
+
+	on_event(...args) {
+		this.on(...args);
+	}
+}
+
+const electron_bridge = new ElectronBridge();
+
+electron_bridge.on('total_unread_count', (...args) => {
+	ipcRenderer.send('unread-count', ...args);
+});
+
+electron_bridge.on('realm_name', (...args) => {
+	ipcRenderer.send('realm-name-changed', ...args);
+});
+
+electron_bridge.on('realm_icon_url', iconURL => {
+	const serverURL = location.origin;
+	iconURL = iconURL.includes('http') ? iconURL : `${serverURL}${iconURL}`;
+	ipcRenderer.send('realm-icon-changed', serverURL, iconURL);
+});
+
+// this follows node's idiomatic implementation of event
+// emitters to make event handling more simpler instead of using
+// functions zulip side will emit event using ElectronBrigde.send_event
+// which is alias of .emit and on this side we can handle the data by adding
+// a listener for the event.
+module.exports = electron_bridge;

app/renderer/js/main.js

@@ -117,7 +117,8 @@ class ServerManagerView {
 				showNotification: true,
 				silent: false
 			},
-			downloadsPath: `${app.getPath('downloads')}`
+			downloadsPath: `${app.getPath('downloads')}`,
+			showDownloadFolder: false
 		};
 
 		// Platform specific settings
@@ -396,6 +397,22 @@ class ServerManagerView {
 			const webContents = webview.getWebContents();
 			webContents.send('toggle-dnd', state, newSettings);
 		});
+
+		ipcRenderer.on('update-realm-icon', (event, serverURL, iconURL) => {
+			DomainUtil.getDomains().forEach((domain, index) => {
+				if (domain.url.includes(serverURL)) {
+					DomainUtil.saveServerIcon(iconURL).then(localIconUrl => {
+						const serverImgsSelector = `.tab .server-icons`;
+						const serverImgs = document.querySelectorAll(serverImgsSelector);
+						serverImgs[index].src = localIconUrl;
+
+						domain.icon = localIconUrl;
+						DomainUtil.db.push(`/domains[${index}]`, domain, true);
+						DomainUtil.reloadDB();
+					});
+				}
+			});
+		});
 	}
 
 	destroyTab(name, index) {

app/renderer/js/notification/index.js

@@ -4,6 +4,7 @@ const {
   remote: { app }
 } = require('electron');
 
+const params = require('../utils/params-util.js');
 const DefaultNotification = require('./default-notification');
 const { appId, loadBots } = require('./helpers');
 
@@ -19,9 +20,8 @@ if (process.platform === 'darwin') {
 }
 
 window.addEventListener('load', () => {
-	// Call this function only when user is logged in
 	// eslint-disable-next-line no-undef, camelcase
-	if (page_params.realm_uri) {
+	if (params.isPageParams() && page_params.realm_uri) {
 		loadBots();
 	}
 });

app/renderer/js/pages/preference/general-section.js

@@ -97,6 +97,10 @@ class GeneralSection extends BaseSection {
 				</div>
 				<div class="title">Advanced</div>
 				<div class="settings-card">
+				<div class="setting-row" id="show-download-folder">
+					<div class="setting-description">Show downloaded file in the file manager</div>
+					<div class="setting-control"></div>
+				</div>
 					<div class="setting-row" id="download-folder">
 						<div class="setting-description">
 							Default download location
@@ -105,9 +109,10 @@ class GeneralSection extends BaseSection {
 					</div>
 					<div class="setting-row">
 						<div class="setting-description">
-							<div class="download-folder-path">${ConfigUtil.getConfigItem('downloadsPath')}</div>
+							<div class="download-folder-path">${ConfigUtil.getConfigItem('downloadsPath', `${app.getPath('downloads')}`)}</div>
 						</div>
 					</div>
+
 				</div>
 				<div class="title">Reset Application Data</div>
                 <div class="settings-card">
@@ -138,6 +143,7 @@ class GeneralSection extends BaseSection {
 		this.showCustomCSSPath();
 		this.removeCustomCSS();
 		this.downloadFolder();
+		this.showDownloadFolder();
 
 		// Platform specific settings
 
@@ -385,6 +391,18 @@ class GeneralSection extends BaseSection {
 		});
 	}
 
+	showDownloadFolder() {
+		this.generateSettingOption({
+			$element: document.querySelector('#show-download-folder .setting-control'),
+			value: ConfigUtil.getConfigItem('showDownloadFolder', false),
+			clickHandler: () => {
+				const newValue = !ConfigUtil.getConfigItem('showDownloadFolder');
+				ConfigUtil.setConfigItem('showDownloadFolder', newValue);
+				this.showDownloadFolder();
+			}
+		});
+	}
+
 }
 
 module.exports = GeneralSection;

app/renderer/js/preload.js

@@ -5,6 +5,7 @@ const SetupSpellChecker = require('./spellchecker');
 
 const ConfigUtil = require(__dirname + '/utils/config-util.js');
 const LinkUtil = require(__dirname + '/utils/link-util.js');
+const params = require(__dirname + '/utils/params-util.js');
 
 // eslint-disable-next-line import/no-unassigned-import
 require('./notification');
@@ -12,6 +13,9 @@ require('./notification');
 // Prevent drag and drop event in main process which prevents remote code executaion
 require(__dirname + '/shared/preventdrag.js');
 
+// eslint-disable-next-line camelcase
+window.electron_bridge = require('./electron-bridge');
+
 const logout = () => {
 	// Create the menu for the below
 	document.querySelector('.dropdown-toggle').click();
@@ -39,46 +43,44 @@ process.once('loaded', () => {
 
 // To prevent failing this script on linux we need to load it after the document loaded
 document.addEventListener('DOMContentLoaded', () => {
+	if (params.isPageParams()) {
 	// Get the default language of the server
-	const serverLanguage = page_params.default_language; // eslint-disable-line no-undef, camelcase
+		const serverLanguage = page_params.default_language; // eslint-disable-line no-undef, camelcase
+		if (serverLanguage) {
+			// Set spellcheker language
+			ConfigUtil.setConfigItem('spellcheckerLanguage', serverLanguage);
+			// Init spellchecker
+			SetupSpellChecker.init();
+		}
+		// redirect users to network troubleshooting page
+		const getRestartButton = document.querySelector('.restart_get_events_button');
+		if (getRestartButton) {
+			getRestartButton.addEventListener('click', () => {
+				ipcRenderer.send('forward-message', 'reload-viewer');
+			});
+		}
+		// Open image attachment link in the lightbox instead of opening in the default browser
+		const { $, lightbox } = window;
+		$('#main_div').on('click', '.message_content p a', function (e) {
+			const url = $(this).attr('href');
 
-	if (serverLanguage) {
-		// Set spellcheker language
-		ConfigUtil.setConfigItem('spellcheckerLanguage', serverLanguage);
-		// Init spellchecker
-		SetupSpellChecker.init();
-	}
+			if (LinkUtil.isImage(url)) {
+				const $img = $(this).parent().siblings('.message_inline_image').find('img');
 
-	// redirect users to network troubleshooting page
-	const getRestartButton = document.querySelector('.restart_get_events_button');
-	if (getRestartButton) {
-		getRestartButton.addEventListener('click', () => {
-			ipcRenderer.send('forward-message', 'reload-viewer');
+				// prevent the image link from opening in a new page.
+				e.preventDefault();
+				// prevent the message compose dialog from happening.
+				e.stopPropagation();
+
+				// Open image in the default browser if image preview is unavailable
+				if (!$img[0]) {
+					shell.openExternal(window.location.origin + url);
+				}
+				// Open image in lightbox
+				lightbox.open($img);
+			}
 		});
 	}
-
-	// Open image attachment link in the lightbox instead of opening in the default browser
-	const { $, lightbox } = window;
-
-	$('#main_div').on('click', '.message_content p a', function (e) {
-		const url = $(this).attr('href');
-
-		if (LinkUtil.isImage(url)) {
-			const $img = $(this).parent().siblings('.message_inline_image').find('img');
-
-			// prevent the image link from opening in a new page.
-			e.preventDefault();
-			// prevent the message compose dialog from happening.
-			e.stopPropagation();
-
-			// Open image in the default browser if image preview is unavailable
-			if (!$img[0]) {
-				shell.openExternal(window.location.origin + url);
-			}
-			// Open image in lightbox
-			lightbox.open($img);
-		}
-	});
 });
 
 // Clean up spellchecker events after you navigate away from this page;

app/renderer/js/utils/params-util.js

@@ -0,0 +1,15 @@
+// This util function returns the page params if they're present else returns null
+function isPageParams() {
+	let webpageParams = null;
+	try {
+		// eslint-disable-next-line no-undef, camelcase
+		webpageParams = page_params;
+	} catch (err) {
+		webpageParams = null;
+	}
+	return webpageParams;
+}
+
+module.exports = {
+	isPageParams
+};

changelog.md

@@ -4,7 +4,37 @@
 
 All notable changes to the Zulip desktop app are documented in this file.
 
+### v2.3.4-beta --2018-07-24
 
+**Fixes**:
+* Fix downloading functionality of file attachments.
+* Fix null of downloadPath when settings.json fails.
+
+<hr>
+
+### v2.3.3 --2018-07-14
+
+**Enhancements**:
+* Add dock bounce effect on macOS
+* Add a setting option to use the system proxy settings
+* Add support for self/custom signed certificate
+* Add Sentry support to get the bug reports
+* Show a notification when a user clicks on file attachments and open the same in default native app 
+
+
+**Fixes**:
+* Fix auto-updates on Windows
+* Fix image attachments not opening up in the app
+* Security fix - Do proper HTML escaping for server data to avoid XSS attacks 
+* Other minor fixes
+
+**Updated dependencies**:
+
+electron-builder: v20.20.4
+
+electron-updater: v2.23.3
+
+<hr>
 
 ### v2.3.2 --2018-05-28
 

gulpfile.js

@@ -10,11 +10,11 @@ gulp.task('dev', () => {
   // Start browser process
 	electron.start();
   // Restart browser process
-	gulp.watch('app/main/*.js', ['restart:browser']);
+	gulp.watch('app/main/*.js', gulp.series('restart:browser'));
   // Reload renderer process
-	gulp.watch('app/renderer/css/*.css', ['reload:renderer']);
-	gulp.watch('app/renderer/*.html', ['reload:renderer']);
-	gulp.watch('app/renderer/js/**/*.js', ['reload:renderer']);
+	gulp.watch('app/renderer/css/*.css', gulp.series('reload:renderer'));
+	gulp.watch('app/renderer/*.html', gulp.series('reload:renderer'));
+	gulp.watch('app/renderer/js/**/*.js', gulp.series('reload:renderer'));
 });
 
 gulp.task('restart:browser', done => {
@@ -36,4 +36,4 @@ gulp.task('test-e2e', () => {
 	}));
 });
 
-gulp.task('default', ['dev', 'test-e2e']);
+gulp.task('default', gulp.parallel('dev', 'test-e2e'));

package-lock.json

@@ -1,6 +1,6 @@
 {
   "name": "zulip",
-  "version": "2.3.2",
+  "version": "2.3.5",
   "lockfileVersion": 1,
   "requires": true,
   "dependencies": {
@@ -11,9 +11,9 @@
       "dev": true
     },
     "@types/node": {
-      "version": "8.10.17",
-      "resolved": "https://registry.npmjs.org/@types/node/-/node-8.10.17.tgz",
-      "integrity": "sha512-3N3FRd/rA1v5glXjb90YdYUa+sOB7WrkU2rAhKZnF4TKD86Cym9swtulGuH0p9nxo7fP5woRNa8b0oFTpCO1bg==",
+      "version": "8.10.21",
+      "resolved": "https://registry.npmjs.org/@types/node/-/node-8.10.21.tgz",
+      "integrity": "sha512-87XkD9qDXm8fIax+5y7drx84cXsu34ZZqfB7Cial3Q/2lxSoJ/+DRaWckkCbxP41wFSIrrb939VhzaNxj4eY1w==",
       "dev": true
     },
     "abbrev": {
@@ -2458,7 +2458,7 @@
     "es6-promise": {
       "version": "4.2.4",
       "resolved": "https://registry.npmjs.org/es6-promise/-/es6-promise-4.2.4.tgz",
-      "integrity": "sha1-3EIhwrFlGHYL2MOaUtjzVvwA7Sk=",
+      "integrity": "sha512-/NdNZVJg+uZgtm9eS3O6lrOLYmQag2DjdEXuPaHlZ6RuVqgqaVZfgYCepEIKsLqwdQArOPtC3XzRLqGGfT8KQQ==",
       "dev": true
     },
     "es6-set": {

package.json

@@ -1,7 +1,7 @@
 {
   "name": "zulip",
   "productName": "Zulip",
-  "version": "2.3.3",
+  "version": "2.3.5",
   "main": "./app/main",
   "description": "Zulip Desktop App",
   "license": "Apache-2.0",

tests/e2e/package.json

@@ -0,0 +1,185 @@
+{
+ "name": "zulip",
+ "productName": "ZulipTest",
+ "version": "2.3.3",
+ "main": "../../app/main",
+ "description": "Zulip Desktop App",
+ "license": "Apache-2.0",
+ "copyright": "Kandra Labs, Inc.",
+ "author": {
+  "name": "Kandra Labs, Inc.",
+  "email": "support@zulipchat.com"
+ },
+ "repository": {
+  "type": "git",
+  "url": "https://github.com/zulip/zulip-electron.git"
+ },
+ "bugs": {
+  "url": "https://github.com/zulip/zulip-electron/issues"
+ },
+ "engines": {
+  "node": ">=6.0.0"
+ },
+ "scripts": {
+  "start": "electron app --disable-http-cache --no-electron-connect",
+  "reinstall": "node ./tools/reinstall-node-modules.js",
+  "postinstall": "electron-builder install-app-deps",
+  "test": "xo",
+  "test-e2e": "gulp test-e2e",
+  "dev": "gulp dev & nodemon --watch app/main --watch app/renderer --exec 'npm test' -e html,css,js",
+  "pack": "electron-builder --dir",
+  "dist": "electron-builder",
+  "mas": "electron-builder --mac mas",
+  "travis": "cd ./scripts && ./travis-build-test.sh",
+  "build-locales": "node tools/locale-helper"
+ },
+ "pre-commit": [
+  "test"
+ ],
+ "build": {
+  "appId": "org.zulip.zulip-electron",
+  "asar": true,
+  "files": [
+   "**/*",
+   "!docs${/*}",
+   "!node_modules/@paulcbetts/cld/deps/cld${/*}"
+  ],
+  "copyright": "©2017 Kandra Labs, Inc.",
+  "mac": {
+   "category": "public.app-category.productivity",
+   "artifactName": "${productName}-${version}-${arch}.${ext}"
+  },
+  "linux": {
+   "category": "Chat;GNOME;GTK;Network;InstantMessaging",
+   "packageCategory": "GNOME;GTK;Network;InstantMessaging",
+   "description": "Zulip Desktop Client for Linux",
+   "target": [
+    "deb",
+    "zip",
+    "AppImage",
+    "snap"
+   ],
+   "maintainer": "Akash Nimare <svnitakash@gmail.com>",
+   "artifactName": "${productName}-${version}-${arch}.${ext}"
+  },
+  "deb": {
+   "synopsis": "Zulip Desktop App",
+   "afterInstall": "./scripts/debian-add-repo.sh",
+   "afterRemove": "./scripts/debian-uninstaller.sh"
+  },
+  "snap": {
+   "synopsis": "Zulip Desktop App"
+  },
+  "dmg": {
+   "background": "build/appdmg.png",
+   "icon": "build/icon.icns",
+   "iconSize": 100,
+   "contents": [
+    {
+     "x": 380,
+     "y": 280,
+     "type": "link",
+     "path": "/Applications"
+    },
+    {
+     "x": 110,
+     "y": 280,
+     "type": "file"
+    }
+   ],
+   "window": {
+    "width": 500,
+    "height": 500
+   }
+  },
+  "win": {
+   "target": [
+    {
+     "target": "nsis-web",
+     "arch": [
+      "x64",
+      "ia32"
+     ]
+    }
+   ],
+   "icon": "build/icon.ico",
+   "publisherName": "Kandra Labs, Inc."
+  },
+  "nsis": {
+   "perMachine": true,
+   "oneClick": false,
+   "allowToChangeInstallationDirectory": true
+  }
+ },
+ "keywords": [
+  "Zulip",
+  "Group Chat app",
+  "electron-app",
+  "electron",
+  "Desktop app",
+  "InstantMessaging"
+ ],
+ "devDependencies": {
+  "assert": "1.4.1",
+  "cp-file": "^5.0.0",
+  "devtron": "1.4.0",
+  "electron": "2.0.1",
+  "electron-builder": "20.20.4",
+  "electron-connect": "0.6.2",
+  "electron-debug": "1.4.0",
+  "google-translate-api": "2.3.0",
+  "gulp": "^4.0.0",
+  "gulp-tape": "0.0.9",
+  "is-ci": "^1.0.10",
+  "nodemon": "^1.14.11",
+  "pre-commit": "1.2.2",
+  "spectron": "3.8.0",
+  "tap-colorize": "^1.2.0",
+  "tape": "^4.8.0",
+  "xo": "0.18.2"
+ },
+ "xo": {
+  "parserOptions": {
+   "sourceType": "script",
+   "ecmaFeatures": {
+    "globalReturn": true
+   }
+  },
+  "esnext": true,
+  "overrides": [
+   {
+    "files": "app*/**/*.js",
+    "rules": {
+     "max-lines": [
+      "warn",
+      {
+       "max": 500,
+       "skipBlankLines": true,
+       "skipComments": true
+      }
+     ],
+     "no-warning-comments": 0,
+     "object-curly-spacing": 0,
+     "capitalized-comments": 0,
+     "no-else-return": 0,
+     "no-path-concat": 0,
+     "no-alert": 0,
+     "guard-for-in": 0,
+     "prefer-promise-reject-errors": 0,
+     "import/no-unresolved": 0,
+     "import/no-extraneous-dependencies": 0,
+     "no-prototype-builtins": 0
+    }
+   }
+  ],
+  "ignore": [
+   "tests/e2e/*.js",
+   "tools/locale-helper/*.js"
+  ],
+  "envs": [
+   "node",
+   "browser",
+   "mocha"
+  ]
+ }
+}