Compare commits

...

138 Commits

Author SHA1 Message Date
Anders Kaseorg
e03de26137 release: New release v5.2.0.
Signed-off-by: Anders Kaseorg <anders@zulip.com>
2020-05-05 12:54:35 -07:00
Anders Kaseorg
983254c310 CVE-2020-12637: Do not ignore certificate errors without ignoreCerts.
Signed-off-by: Anders Kaseorg <anders@zulip.com>
2020-05-05 12:54:35 -07:00
Anders Kaseorg
b6059077d8 Generalize permission-response mechanism to renderer-callback.
Signed-off-by: Anders Kaseorg <anders@zulip.com>
2020-05-05 12:54:35 -07:00
Anders Kaseorg
cafff9a008 new-server-form: Add missing string conversion for error message.
Signed-off-by: Anders Kaseorg <anders@zulip.com>
2020-05-05 12:54:35 -07:00
Anders Kaseorg
190204b2e5 notarize: Fix lint errors.
Signed-off-by: Anders Kaseorg <anders@zulip.com>
2020-05-05 12:54:09 -07:00
Akash Nimare
4c25c99abc notarization: Pass team short name info in code-signing. 2020-05-06 01:13:29 +05:30
Anders Kaseorg
55be93b906 dependencies: Upgrade dependencies.
Signed-off-by: Anders Kaseorg <anders@zulip.com>
2020-05-04 01:56:35 -07:00
Anders Kaseorg
34e2b3a3d0 typescript: Eradicate most any annotations.
Signed-off-by: Anders Kaseorg <anders@zulip.com>
2020-05-04 01:08:05 -07:00
Anders Kaseorg
e5ece8db9e package.json: Fix ‘npm start’ to do something useful.
The old run-dev script raced electron and tsc against each other in
parallel, which usually meant electron would run stale JS files.  We
should overhaul the build process at some point, but whatever we do,
this script isn’t going to be part of it.

Signed-off-by: Anders Kaseorg <anders@zulip.com>
2020-05-03 20:35:21 -07:00
Anders Kaseorg
40b26dbb0e dnd-util: Refine typing.
Signed-off-by: Anders Kaseorg <anders@zulip.com>
2020-05-03 20:03:41 -07:00
Anders Kaseorg
ae4f03f4ba logger-util: Clean up typing disaster zone.
Signed-off-by: Anders Kaseorg <anders@zulip.com>
2020-05-03 20:03:41 -07:00
Anders Kaseorg
8ea32a7a96 feedback: Stub send-feedback types.
Signed-off-by: Anders Kaseorg <anders@zulip.com>
2020-05-03 19:33:52 -07:00
Anders Kaseorg
6b7cce0366 ServerManagerView: Convert loading from object to Set.
Signed-off-by: Anders Kaseorg <anders@zulip.com>
2020-05-03 19:16:05 -07:00
Anders Kaseorg
73fec72e6d registerIpcs: Convert webviewListeners to array with functions.
Signed-off-by: Anders Kaseorg <anders@zulip.com>
2020-05-03 19:09:22 -07:00
Anders Kaseorg
920adfb169 CI: Clean unused steps from CI configuration.
Signed-off-by: Anders Kaseorg <anders@zulip.com>
2020-05-03 15:02:58 -07:00
Manav Mehta
98174fdcaf help: Update Help Center URL.
Earlier the menu option used to redirect to *.zulipchat.com/help which is already reachable from the webapp.
This will enable the desktop app to redirect only to zulipchat.com/help instead of the help page of the corresponding organization.

Fixes: #948.
2020-05-02 20:17:25 +05:30
Anders Kaseorg
a0c033431e electron-bridge: Add decrypt_clipboard helper.
This one helper allows us to implement browser-based social login
entirely on the server side.

Signed-off-by: Anders Kaseorg <anders@zulip.com>
2020-05-01 15:00:02 -07:00
Abhigyan Khaund
82421d843a downloadFiles: Fix issue of showing two Save As dialog box.
Currently, there are two dialog boxes shown while downloading files (in Ubuntu). One by default behavior of electron and other by the dialog box for save as feature.
This PR fixes this issue by using electron's save as dialog box.

Fixes: #947.
2020-05-01 17:55:46 +05:30
Anders Kaseorg
d9afee3330 ServerManagerView: Convert functionalTabs from object to Map.
Signed-off-by: Anders Kaseorg <anders@zulipchat.com>
2020-04-30 13:48:18 -07:00
Anders Kaseorg
a46f2ed618 xo: Enable import/no-mutable-exports.
Signed-off-by: Anders Kaseorg <anders@zulipchat.com>
2020-04-30 13:48:18 -07:00
Anders Kaseorg
9f3b4ff408 xo: Remove unicorn/string-content exclusion.
Signed-off-by: Anders Kaseorg <anders@zulipchat.com>
2020-04-30 13:48:18 -07:00
Anders Kaseorg
fb800f7862 xo: Enable @typescript-eslint/no-unused-vars.
Signed-off-by: Anders Kaseorg <anders@zulipchat.com>
2020-04-30 13:48:18 -07:00
Anders Kaseorg
ba191c3699 xo: Enable object-curly-spacing.
Signed-off-by: Anders Kaseorg <anders@zulipchat.com>
2020-04-30 13:48:18 -07:00
Anders Kaseorg
e49a880ed6 xo: Enable capitalized-comments.
Signed-off-by: Anders Kaseorg <anders@zulipchat.com>
2020-04-30 13:48:18 -07:00
Anders Kaseorg
4bfa7c9265 xo: Enable no-else-return.
Signed-off-by: Anders Kaseorg <anders@zulipchat.com>
2020-04-30 13:48:18 -07:00
Anders Kaseorg
39c6fa4ace xo: Enable @typescript-eslint/member-ordering.
Signed-off-by: Anders Kaseorg <anders@zulipchat.com>
2020-04-30 13:48:18 -07:00
Anders Kaseorg
963c2e5388 xo: Enable @typescript-eslint/restrict-plus-operands.
Signed-off-by: Anders Kaseorg <anders@zulipchat.com>
2020-04-30 13:48:18 -07:00
Anders Kaseorg
849df4adaf xo: Enable @typescript-eslint/restrict-template-expressions.
Signed-off-by: Anders Kaseorg <anders@zulipchat.com>
2020-04-30 13:48:18 -07:00
Anders Kaseorg
fc6ff83485 xo: Enable no-alert.
Signed-off-by: Anders Kaseorg <anders@zulipchat.com>
2020-04-30 13:48:18 -07:00
Anders Kaseorg
5ae2a717fa xo: Enable padding-line-between-statements.
Signed-off-by: Anders Kaseorg <anders@zulipchat.com>
2020-04-30 13:48:18 -07:00
Anders Kaseorg
cfdc08a038 xo: Enable unicorn/catch-error-name.
Signed-off-by: Anders Kaseorg <anders@zulipchat.com>
2020-04-30 13:48:18 -07:00
Anders Kaseorg
b76467529d xo: Upgrade xo to 0.30.
Signed-off-by: Anders Kaseorg <anders@zulipchat.com>
2020-04-30 13:48:18 -07:00
Anders Kaseorg
bb88a7b7a8 xo: Handle floating promises.
Signed-off-by: Anders Kaseorg <anders@zulipchat.com>
2020-04-30 13:48:18 -07:00
Anders Kaseorg
0225778050 typescript: Annotate queueDomain.
Signed-off-by: Anders Kaseorg <anders@zulipchat.com>
2020-04-30 13:48:18 -07:00
Anders Kaseorg
2154b191c8 typescript: Annotate url in WebviewProps.
Signed-off-by: Anders Kaseorg <anders@zulipchat.com>
2020-04-30 13:48:18 -07:00
Anders Kaseorg
4093304b4d typescript: Annotate electron-updater events.
Signed-off-by: Anders Kaseorg <anders@zulipchat.com>
2020-04-30 13:48:18 -07:00
Anders Kaseorg
2e03f779e8 typescript: Annotate setMenu props.
Signed-off-by: Anders Kaseorg <anders@zulipchat.com>
2020-04-30 13:48:18 -07:00
Manav Mehta
9464390070 docs: Update changelog for release 5.1.0. 2020-04-30 00:48:31 +05:30
Manav Mehta
16f0af8853 Remove storing of User-Agent on disk.
Fixes: #921.

Co-authored-by: Anders Kaseorg <anders@zulipchat.com>
2020-04-26 13:30:39 -07:00
am2505
bb6d90671f typescript: Complete most TypeScript todos. 2020-04-25 15:49:10 -07:00
Anders Kaseorg
e536a03fab dependencies: Fix package-lock.json stability.
Signed-off-by: Anders Kaseorg <anders@zulipchat.com>
2020-04-25 13:07:28 -07:00
Anders Kaseorg
ee60702276 release: Update package-lock.json for new release v5.1.0.
Signed-off-by: Anders Kaseorg <anders@zulipchat.com>
2020-04-25 13:07:24 -07:00
Akash Nimare
e721211619 release: New release v5.1.0 2020-04-25 13:53:44 +05:30
Anders Kaseorg
ff671b53ef dependencies: Upgrade dependencies.
Signed-off-by: Anders Kaseorg <anders@zulipchat.com>
2020-04-24 22:15:20 -07:00
Akash Nimare
340eb8da99 server-icon: Handle server icon update gracefully.
Don't trigger user-facing network error for updating the server icon.
2020-04-24 11:48:27 +05:30
Anders Kaseorg
ae689ad6bb general-section: Import supported-locales.json as a JSON module.
Signed-off-by: Anders Kaseorg <anders@zulipchat.com>
2020-04-22 13:06:00 -07:00
Anders Kaseorg
7ffddded5d Configure language by value, not by index.
Signed-off-by: Anders Kaseorg <anders@zulipchat.com>
2020-04-22 13:05:59 -07:00
Anders Kaseorg
714cd926ae generateSelectTemplate: Add missing HTML escaping.
Signed-off-by: Anders Kaseorg <anders@zulipchat.com>
2020-04-22 13:05:15 -07:00
Manav Mehta
b2f4af0f49 Add feature to set application language.
User can now select application language without changing the language in the operating system.

Fixes: #855.
2020-04-22 18:08:49 +05:30
Aditya Mudgil
d7136aef25 macOS: Update dock icon.
* Added inner padding to .icns dock icon for mac
* Change inner padding of the image to 20px for each side

Fixes: #787.
2020-04-14 20:20:48 +05:30
Anders Kaseorg
73f8b21a9f scripts: Synchronize Debian scripts with electron-builder 22.4.1.
Fixes #912.

Signed-off-by: Anders Kaseorg <anders@zulipchat.com>
2020-04-08 14:15:43 -07:00
Akash Nimare
4ce08cb5a2 dock: Do not toggle window on clicking dock.
We are reverting back our decision after getting a lot of feedback
on this behaviour. Fromm now on, when you click on the dock icon we'll
show the app window and won't hide it after clicking again on dock.

Fixes: #914.
2020-04-07 20:16:50 +05:30
Anders Kaseorg
814ce071a3 release: New release v5.0.0.
Signed-off-by: Anders Kaseorg <anders@zulipchat.com>
2020-03-30 19:38:33 -07:00
Anders Kaseorg
92fb176f67 Revert "auth: Move social login process to browser."
This reverts commit 49b29bfed6 (#863).

The design of this feature is still under discussion; we expect it to
return after the security release.

Signed-off-by: Anders Kaseorg <anders@zulipchat.com>
2020-03-30 19:33:24 -07:00
Anders Kaseorg
a03f569af9 CVE-2020-10857: Whitelist safe URL protocols for shell.openExternal.
Signed-off-by: Anders Kaseorg <anders@zulipchat.com>
2020-03-30 19:33:24 -07:00
Anders Kaseorg
af59bb7c99 handleExternalLink: Do not navigate the current window.
Signed-off-by: Anders Kaseorg <anders@zulipchat.com>
2020-03-30 19:33:24 -07:00
Anders Kaseorg
4390966a62 Always show downloaded files in file manager.
shell.openItem is unsafe.

Signed-off-by: Anders Kaseorg <anders@zulipchat.com>
2020-03-30 19:33:24 -07:00
Anders Kaseorg
a6d942fe6c CVE-2020-10858: Lock down session permission requests.
This fixes a vulnerability reported by Matt Austin.

Signed-off-by: Anders Kaseorg <anders@zulipchat.com>
2020-03-30 19:33:24 -07:00
Anders Kaseorg
9d4093b3d8 CVE-2020-10856: Enable context isolation.
This fixes a vulnerability reported by Matt Austin.

Signed-off-by: Anders Kaseorg <anders@zulipchat.com>
2020-03-30 19:33:24 -07:00
Anders Kaseorg
20a6c5d128 preload: Use IPC for logout, shortcut, showNotificationSettings.
Signed-off-by: Anders Kaseorg <anders@zulipchat.com>
2020-03-30 19:33:24 -07:00
Anders Kaseorg
c843e179fc tray: Remove tray variable from window.
Signed-off-by: Anders Kaseorg <anders@zulipchat.com>
2020-03-30 19:33:24 -07:00
Anders Kaseorg
438d4fffa7 notification: Convert loadBots from jQuery to fetch.
Signed-off-by: Anders Kaseorg <anders@zulipchat.com>
2020-03-30 19:32:23 -07:00
Tim Abbott
5c164bfa7d webview: Disable insecure content.
Zulip servers in production are designed to only serve content over
HTTPS.  And a development environment's root page will be served over
HTTP.

So there is no purpose in enabling allowInsecureContent, even
conditionally for use against Zulip development environments; we should
just remove the setting.
2020-03-30 19:32:23 -07:00
Anders Kaseorg
cbc89a72a2 tray: Work around Electron segfault on certain platforms.
Set the tray icon’s context menu immediately after creating the Tray
object.  This seems to prevent an Electron segfault at startup on
certain platforms, such as Ubuntu 16.04 i386.  See
https://github.com/electron/electron/issues/22652 and its linked
issues.

Signed-off-by: Anders Kaseorg <anders@zulipchat.com>
2020-03-30 19:26:29 -07:00
Anders Kaseorg
fb1e163130 typescript: Fix errors hidden by skipLibCheck.
This requires temporarily downgrading to @types/node@^12 (see
https://github.com/electron/electron/issues/21612).

Leave skipLibCheck on for now as it still saves a few seconds when
running tsc.

Signed-off-by: Anders Kaseorg <anders@zulipchat.com>
2020-03-26 16:35:13 -07:00
Anders Kaseorg
2ebeeedba8 dependencies: Move fs-extra from devDependencies to dependencies.
Signed-off-by: Anders Kaseorg <anders@zulipchat.com>
2020-03-24 21:07:25 -07:00
Anders Kaseorg
82a7f97ca6 dependencies: Upgrade dependencies.
Signed-off-by: Anders Kaseorg <anders@zulipchat.com>
2020-03-23 17:22:48 -07:00
Anders Kaseorg
55eb768064 xo: Upgrade xo to 0.28.
Signed-off-by: Anders Kaseorg <anders@zulipchat.com>
2020-03-23 16:53:14 -07:00
Anders Kaseorg
611932c66d xo: Unabbreviate variable names.
To satisfy unicorn/prevent-abbreviations in xo 0.28.

Signed-off-by: Anders Kaseorg <anders@zulipchat.com>
2020-03-23 16:53:12 -07:00
Anders Kaseorg
5deffa5022 changelog: Add missing changelog entry for v4.0.3.
Signed-off-by: Anders Kaseorg <anders@zulipchat.com>
2020-03-23 15:08:21 -07:00
Anders Kaseorg
6f01f1362a js: Declare 'use strict' on tests too.
Signed-off-by: Anders Kaseorg <anders@zulipchat.com>
2020-03-09 22:14:23 -07:00
Anders Kaseorg
9d2739f050 js: Declare 'use strict' on all scripts and no modules.
And enable the import/unambiguous ESLint rule as a check on our
partition between scripts and modules.  After this commit, if you add
a new file and get this error:

  ✖  1:1  This module could be parsed as a valid script.  import/unambiguous

* For a module, add an `import` or `export` declaration to make the
  file unambiguously a module (the empty `export {};` declaration
  suffices).
* For a script, add the file to the xo overrides section of
  package.json that marks it "sourceType": "script", and add a 'use
  strict' declaration.

Signed-off-by: Anders Kaseorg <anders@zulipchat.com>
2020-03-09 20:04:43 -07:00
Akash Nimare
01f6e77237 macOS: Fix undo redo not working on macOS.
The default API provided by Electron doesn't work
as expected. More info here -
https://github.com/electron/electron/issues/15728

Fixes: #866.
2020-03-10 00:32:05 +05:30
Manav Mehta
7ac35cc087 macOS: Replace deprecated isDarkMode() with shouldUseDarkColors.
Fixes: #891.
2020-03-08 14:55:43 +05:30
Anders Kaseorg
32e6b3054f xo: Use more xo defaults.
Signed-off-by: Anders Kaseorg <anders@zulipchat.com>
2020-03-04 21:46:18 -08:00
Anders Kaseorg
40bf2a1f20 xo: Lint *.js too.
Signed-off-by: Anders Kaseorg <anders@zulipchat.com>
2020-03-04 21:22:04 -08:00
Anders Kaseorg
dee2f05ac0 locale-helper: Move supported-locales.js to supported-locales.json.
Signed-off-by: Anders Kaseorg <anders@zulipchat.com>
2020-03-04 20:45:57 -08:00
Anders Kaseorg
ca5de73155 xo: Reenable several easy rules.
Signed-off-by: Anders Kaseorg <anders@zulipchat.com>
2020-03-04 20:15:01 -08:00
Anders Kaseorg
d0f8c040c7 package.json: Add tsc to test script.
Signed-off-by: Anders Kaseorg <anders@zulipchat.com>
2020-03-04 18:26:06 -08:00
Anders Kaseorg
7cf40f1e08 typescript: One more switch to ES export syntax.
Signed-off-by: Anders Kaseorg <anders@zulipchat.com>
2020-03-04 18:15:42 -08:00
Anders Kaseorg
598c0df60b package.json: Reformat to match npm generated output.
Signed-off-by: Anders Kaseorg <anders@zulipchat.com>
2020-03-04 17:52:10 -08:00
Anders Kaseorg
d3bcd7306a typescript: Switch to ES import/export syntax.
Signed-off-by: Anders Kaseorg <anders@zulipchat.com>
2020-03-04 17:21:03 -08:00
Anders Kaseorg
b3261bcdff js: Explode more singleton classes to modules.
Signed-off-by: Anders Kaseorg <anders@zulipchat.com>
2020-03-04 16:27:44 -08:00
Manav Mehta
20c6f487c4 typescript: Implement some TODOs. 2020-03-04 14:21:25 -08:00
Anders Kaseorg
340797ca10 typescript: Refine some type annotations to avoid any.
Signed-off-by: Anders Kaseorg <anders@zulipchat.com>
2020-03-04 12:12:31 -08:00
Anders Kaseorg
220aac2d54 js: Explode singleton classes to modules.
Singleton classes may have a purpose.  This was not that purpose.

Signed-off-by: Anders Kaseorg <anders@zulipchat.com>
2020-03-04 11:54:45 -08:00
Akash Nimare
d9f6cf4cc9 docs: Update recommended node version for development. 2020-03-04 16:59:21 +05:30
Anders Kaseorg
dc3e5d4930 package.json: Sort xo overrides.
Signed-off-by: Anders Kaseorg <anders@zulipchat.com>
2020-03-03 21:50:02 -08:00
Anders Kaseorg
fc2b80c36a main: Fix realm icon updating.
Commit c937317ecf (#605) should have
updated this, but didn’t.

Signed-off-by: Anders Kaseorg <anders@zulipchat.com>
2020-03-03 21:50:02 -08:00
Anders Kaseorg
ab667d8053 checkCertError: Fix showMessageBox usage.
Signed-off-by: Anders Kaseorg <anders@zulipchat.com>
2020-03-03 21:50:02 -08:00
Manav Mehta
8b9a10a23d Update report issue placeholder.
Fixes: #873.
2020-03-04 11:16:31 +05:30
Anders Kaseorg
15af3e732f sentry-util: Hard-code the Sentry DSN.
Commit 088ddf9c62 (#755) does not work,
because neither the .env file nor the environment variables it
provides are available to normal users at runtime.  This silently
broke Sentry data collection.  When we upgraded @sentry/electron in
commit 107e522914, the silent failure
became an error that prevented the app from starting.

The Sentry DSN is not a secret, so we should just commit it to the
repository.

Signed-off-by: Anders Kaseorg <anders@zulipchat.com>
2020-03-04 11:07:00 +05:30
am2505
534f4c1463 Convert Promise to async-await.
Fixes #878.
2020-03-03 20:40:10 -08:00
Anders Kaseorg
063324550e run-dev: Fix for one package.json structure.
Signed-off-by: Anders Kaseorg <anders@zulipchat.com>
2020-03-03 20:00:36 -08:00
Anders Kaseorg
268471df6b typings: Remove redundant ZulipWebWindow.$.
Signed-off-by: Anders Kaseorg <anders@zulipchat.com>
2020-03-03 18:17:13 -08:00
Anders Kaseorg
ca6b2312be typings: Get Window.Notification from upstream.
Signed-off-by: Anders Kaseorg <anders@zulipchat.com>
2020-03-03 18:16:01 -08:00
Anders Kaseorg
ff026e5763 typings: Get NotificationOptions.silent from upstream.
Signed-off-by: Anders Kaseorg <anders@zulipchat.com>
2020-03-03 18:14:13 -08:00
Anders Kaseorg
8f810481e3 typings: Get requestIdleCallback from DefinitelyTyped.
Signed-off-by: Anders Kaseorg <anders@zulipchat.com>
2020-03-03 18:13:26 -08:00
Anders Kaseorg
f91e95647a typings: Use type declarations from DefinitelyTyped.
Signed-off-by: Anders Kaseorg <anders@zulipchat.com>
2020-03-03 18:01:24 -08:00
Anders Kaseorg
e9536f247b dependencies: Use one package.json structure.
The two package.json structure is no longer needed.
https://www.electron.build/tutorials/two-package-structure

Signed-off-by: Anders Kaseorg <anders@zulipchat.com>
2020-03-03 11:02:59 -08:00
Anders Kaseorg
067cbf32a1 build: Fix cld sources exclusion.
As of commit 107e522914, @paulcbetts/cld
was renamed to cld.

docs is not being included anyway since it’s outside of app.

Signed-off-by: Anders Kaseorg <anders@zulipchat.com>
2020-03-03 10:59:41 -08:00
Anders Kaseorg
6824978114 dependencies: Remove @types/dotenv compatibility stub.
Signed-off-by: Anders Kaseorg <anders@zulipchat.com>
2020-03-02 20:31:20 -08:00
Anders Kaseorg
fa86f1ca25 dependencies: Upgrade everything to latest.
Signed-off-by: Anders Kaseorg <anders@zulipchat.com>
2020-03-02 20:31:19 -08:00
Anders Kaseorg
a63b3873ae dependencies: Remove electron-debug.
We already implement all of its functionality.

Signed-off-by: Anders Kaseorg <anders@zulipchat.com>
2020-03-02 20:15:43 -08:00
Anders Kaseorg
5064ea4b47 dependencies: Upgrade node-json-db from 0.9.2 to 1.0.3.
Signed-off-by: Anders Kaseorg <anders@zulipchat.com>
2020-03-02 19:52:39 -08:00
Anders Kaseorg
6b0d8520c5 dependencies: Remove unused dependencies assert, cp-file, is-ci.
Signed-off-by: Anders Kaseorg <anders@zulipchat.com>
2020-03-02 19:19:37 -08:00
Anders Kaseorg
4b16164155 cleanup: Remove unused tests/e2e directory.
It is not used even by test-e2e.

Signed-off-by: Anders Kaseorg <anders@zulipchat.com>
2020-03-02 19:18:25 -08:00
Anders Kaseorg
6036a44fb2 new-server-form: Remove useless .server-save-action wrappers.
Signed-off-by: Anders Kaseorg <anders@zulipchat.com>
2020-03-02 19:08:45 -08:00
Anders Kaseorg
598b96b6e8 webview: Wait for dom-ready before sending messages.
Fixes tests/test-add-organization.js.

Signed-off-by: Anders Kaseorg <anders@zulipchat.com>
2020-03-02 18:52:37 -08:00
Anders Kaseorg
675bc2f06c appveyor.yml, .travis.yml: Test current Node.js releases.
Signed-off-by: Anders Kaseorg <anders@zulipchat.com>
2020-03-02 16:30:12 -08:00
Tim Abbott
eb2988a5e4 dependencies: Update typescript and typescript-eslint.
The changes are mostly done via `xo --fix`; the other changes are
either trivial or disabling new linter rules that we plan to address
in future commits.
2020-02-29 23:39:55 -08:00
Tim Abbott
39ea18228c dependencies: Update gulp testing packages. 2020-02-29 22:54:50 -08:00
Tim Abbott
909e0f07e3 dependencies: Upgrade linters and fix linter errors.
The changes here are mostly straightforward; the one exception is
removing a zulipdev.org hack.

We disable some lint rules we'll want to address later (E.g. we want
to switch to using async/await rather than .then()).  But those are
out of scope for this commit.
2020-02-29 22:47:42 -08:00
Tim Abbott
31af6596bf dependencies: Upgrade Electron to version 8.
This is the latest Electron release, which means we're now getting
nearly modern Chrome (hopefully with fewer rendering bugs and better
performance).
2020-02-29 21:49:19 -08:00
Tim Abbott
3c9914542f badge: Clear badge counts on Linux as well.
My Linux desktop environment doesn't display unread badges, it seems,
but this is clearly how this code should read.
2020-02-29 21:39:56 -08:00
Tim Abbott
f4b9605742 electron: Update some setter/getters to user newer properties.
This removes a few deprecation warnings on app startup.
2020-02-29 21:39:56 -08:00
Tim Abbott
e2fc9241fa dependencies: Upgrade to Electron 7.
This works without any other changes, thanks to Electron's deprecation
process being done over multiple releases.
2020-02-29 21:39:56 -08:00
Tim Abbott
3b18357c74 download: Use removeListener for removing the updated listener.
This is slightly cleaner code, and also fixes a typescript error (that
might be a bug) we'll get when we upgrade to Electron 7.
2020-02-29 21:39:56 -08:00
Tim Abbott
c4beedf740 proxy: Migration to use async/await.
This is required for the upgrade to Electron 7, which removes the old
callback-based form of these APIs.
2020-02-29 21:39:56 -08:00
Anders Kaseorg
b34bf7236f .travis.yml: Fix npm ci invocation for app directory.
Signed-off-by: Anders Kaseorg <anders@zulipchat.com>
2020-02-29 18:49:01 -08:00
Tim Abbott
e32968b2f3 preferences: Convert one more dialog to use async/await.
This should have been in the main version update commit.
2020-02-29 18:32:09 -08:00
Anders Kaseorg
747fbb5ab0 .travis.yml: Run npm ci, not npm install.
This enforces that package-lock.json is up to date in Git.

Signed-off-by: Anders Kaseorg <anders@zulipchat.com>
2020-02-29 18:30:05 -08:00
vsvipul
107e522914 deps: Update Electron and related packages to Electron v6.
This updates most of our direct dependencies to much newer versions
(Electron v6, with compatible versions of related packages like
Spectron).

Further, it updates all of our recursive dependencies with `npm update
--depth=999`.

Modified by tabbott to migrate to async/await for dialogs rather than
the old synchronous API.
2020-02-29 18:28:42 -08:00
Tim Abbott
c83bc08359 i18n: Add additional automatically output strings.
I'm skeptical of the setup that these are generated dynamically while
working in the development environment; that seems not robust.
2020-02-29 17:38:23 -08:00
Anders Kaseorg
ef0b056437 package.json: Fix clean-ts-files script to spare app/node_modules.
Signed-off-by: Anders Kaseorg <anders@zulipchat.com>
2020-02-29 17:03:53 -08:00
Tim Abbott
9370f783ba i18n: Update generated translation data.
I feel like this should probably not be in Git.
2020-02-29 16:14:00 -08:00
Tim Abbott
227e59fee2 gitattributes: Disable binary handling of lock files.
This makes it possible to see what packages change after npm
operations.
2020-02-29 13:09:29 -08:00
Akash Nimare
b7147d0b29 webview: Update web security preference.
Electron docs suggests that we should not use
`disablewebsecurity` thus removing the same.
2020-02-27 16:55:47 +05:30
Akash Nimare
f93053eb20 release: New release 4.1.0-beta. 2020-02-27 10:37:55 +05:30
ViPuL
49b29bfed6 auth: Move social login process to browser.
Moves the social login to browser since there
was no way to verify the authencity of the
auth process for a custom server and to
prevent phishing attacks.

Fixes #849.

Co-authored-by: Kanishk Kakar <kanishk.kakar@gmail.com>
2020-02-25 20:05:27 +05:30
Akash Nimare
0fb610f858 macOS: Add colorless tray icon for macOS.
Fixes: #825.
2020-02-05 21:41:10 +05:30
ViPuL
1d9a923245 startup: Use inbuilt electron API for autostartup. (#859)
Switch from using the external auto-launch module to
inbuilt setLoginItemSettings for windows and macOS,
as some users reported issues on windows.

Fixes: #851.
2020-01-28 12:26:41 +05:30
Ross Brunton
9582d32de8 Added option to select download locations.
Added an option that, when enabled, will mean any file downloads that
would normally go to ~/Downloads (or wherever), in fact prompt.
2020-01-21 16:41:56 +05:30
ViPuL
a2a21631f2 Decode server name in Window menu. 2020-01-08 11:58:44 +05:30
Akash Nimare
9490265a03 dock: Toggle app on clicking the dock icon. 2019-12-29 00:49:46 +05:30
Brandon Liu
70bd619fa8 Fix size of macOS dock icon.
Fixes: #845.
2019-11-30 17:07:31 +05:30
Akash Nimare
c5797e4edb release: New release v4.0.3. 2019-11-21 12:47:29 +05:30
Kanishk Kakar
32321daef2 docs: Add release notes for v4.0.2-beta. (#841) 2019-11-17 04:27:55 +05:30
104 changed files with 10649 additions and 11682 deletions

2
.gitattributes vendored
View File

@@ -1,7 +1,5 @@
* text=auto eol=lf * text=auto eol=lf
package-lock.json binary
app/package-lock.json binary
*.gif binary *.gif binary
*.jpg binary *.jpg binary
*.jpeg binary *.jpeg binary

4
.gitignore vendored
View File

@@ -1,5 +1,5 @@
# Dependency directories # Dependency directory
node_modules/ /node_modules/
# npm cache directory # npm cache directory
.npm .npm

View File

@@ -1,6 +1,3 @@
sudo: required
dist: trusty
os: os:
- osx - osx
- linux - linux
@@ -15,23 +12,12 @@ addons:
language: node_js language: node_js
node_js: node_js:
- '8' - '10'
- '12'
before_install:
- ./scripts/travis-xvfb.sh
- npm install -g gulp
- npm install
cache: cache:
directories: directories:
- node_modules - node_modules
- app/node_modules
script: script:
- npm run travis - npm run test
notifications:
webhooks:
urls:
- https://zulip.org/zulipbot/travis
on_success: always
on_failure: always

View File

@@ -1,11 +1,11 @@
'use strict'; import {app, dialog} from 'electron';
import { app, dialog, shell } from 'electron'; import {UpdateDownloadedEvent, UpdateInfo, autoUpdater} from 'electron-updater';
import { autoUpdater } from 'electron-updater'; import {linuxUpdateNotification} from './linuxupdater'; // Required only in case of linux
import { linuxUpdateNotification } from './linuxupdater'; // Required only in case of linux
import log = require('electron-log'); import log from 'electron-log';
import isDev = require('electron-is-dev'); import isDev from 'electron-is-dev';
import ConfigUtil = require('../renderer/js/utils/config-util'); import * as ConfigUtil from '../renderer/js/utils/config-util';
import * as LinkUtil from '../renderer/js/utils/link-util';
export function appUpdater(updateFromMenu = false): void { export function appUpdater(updateFromMenu = false): void {
// Don't initiate auto-updates in development // Don't initiate auto-updates in development
@@ -34,73 +34,73 @@ export function appUpdater(updateFromMenu = false): void {
autoUpdater.allowPrerelease = isBetaUpdate || false; autoUpdater.allowPrerelease = isBetaUpdate || false;
const eventsListenerRemove = ['update-available', 'update-not-available']; const eventsListenerRemove = ['update-available', 'update-not-available'];
autoUpdater.on('update-available', info => { autoUpdater.on('update-available', async (info: UpdateInfo) => {
if (updateFromMenu) { if (updateFromMenu) {
dialog.showMessageBox({
message: `A new version ${info.version}, of Zulip Desktop is available`,
detail: 'The update will be downloaded in the background. You will be notified when it is ready to be installed.'
});
updateAvailable = true; updateAvailable = true;
// This is to prevent removal of 'update-downloaded' and 'error' event listener. // This is to prevent removal of 'update-downloaded' and 'error' event listener.
eventsListenerRemove.forEach(event => { eventsListenerRemove.forEach(event => {
autoUpdater.removeAllListeners(event); autoUpdater.removeAllListeners(event);
}); });
await dialog.showMessageBox({
message: `A new version ${info.version}, of Zulip Desktop is available`,
detail: 'The update will be downloaded in the background. You will be notified when it is ready to be installed.'
});
} }
}); });
autoUpdater.on('update-not-available', () => { autoUpdater.on('update-not-available', async () => {
if (updateFromMenu) { if (updateFromMenu) {
dialog.showMessageBox({ // Remove all autoUpdator listeners so that next time autoUpdator is manually called these
// listeners don't trigger multiple times.
autoUpdater.removeAllListeners();
await dialog.showMessageBox({
message: 'No updates available', message: 'No updates available',
detail: `You are running the latest version of Zulip Desktop.\nVersion: ${app.getVersion()}` detail: `You are running the latest version of Zulip Desktop.\nVersion: ${app.getVersion()}`
}); });
// Remove all autoUpdator listeners so that next time autoUpdator is manually called these
// listeners don't trigger multiple times.
autoUpdater.removeAllListeners();
} }
}); });
autoUpdater.on('error', error => { autoUpdater.on('error', async (error: Error) => {
if (updateFromMenu) { if (updateFromMenu) {
const messageText = (updateAvailable) ? ('Unable to download the updates') : ('Unable to check for updates');
dialog.showMessageBox({
type: 'error',
buttons: ['Manual Download', 'Cancel'],
message: messageText,
detail: (error).toString() + `\n\nThe latest version of Zulip Desktop is available at -\nhttps://zulipchat.com/apps/.\n
Current Version: ${app.getVersion()}`
}, response => {
if (response === 0) {
shell.openExternal('https://zulipchat.com/apps/');
}
});
// Remove all autoUpdator listeners so that next time autoUpdator is manually called these // Remove all autoUpdator listeners so that next time autoUpdator is manually called these
// listeners don't trigger multiple times. // listeners don't trigger multiple times.
autoUpdater.removeAllListeners(); autoUpdater.removeAllListeners();
const messageText = (updateAvailable) ? ('Unable to download the updates') : ('Unable to check for updates');
const {response} = await dialog.showMessageBox({
type: 'error',
buttons: ['Manual Download', 'Cancel'],
message: messageText,
detail: `Error: ${error.message}\n\nThe latest version of Zulip Desktop is available at -\nhttps://zulipchat.com/apps/.\n
Current Version: ${app.getVersion()}`
});
if (response === 0) {
await LinkUtil.openBrowser(new URL('https://zulipchat.com/apps/'));
}
} }
}); });
// Ask the user if update is available // Ask the user if update is available
autoUpdater.on('update-downloaded', event => { autoUpdater.on('update-downloaded', async (event: UpdateDownloadedEvent) => {
// Ask user to update the app // Ask user to update the app
dialog.showMessageBox({ const {response} = await dialog.showMessageBox({
type: 'question', type: 'question',
buttons: ['Install and Relaunch', 'Install Later'], buttons: ['Install and Relaunch', 'Install Later'],
defaultId: 0, defaultId: 0,
message: `A new update ${event.version} has been downloaded`, message: `A new update ${event.version} has been downloaded`,
detail: 'It will be installed the next time you restart the application' detail: 'It will be installed the next time you restart the application'
}, response => {
if (response === 0) {
setTimeout(() => {
autoUpdater.quitAndInstall();
// force app to quit. This is just a workaround, ideally autoUpdater.quitAndInstall() should relaunch the app.
app.quit();
}, 1000);
}
}); });
if (response === 0) {
setTimeout(() => {
autoUpdater.quitAndInstall();
// Force app to quit. This is just a workaround, ideally autoUpdater.quitAndInstall() should relaunch the app.
app.quit();
}, 1000);
}
}); });
// Init for updates // Init for updates
autoUpdater.checkForUpdates(); (async () => autoUpdater.checkForUpdates())();
} }

View File

@@ -1,19 +1,17 @@
'use strict'; import {sentryInit} from '../renderer/js/utils/sentry-util';
import { sentryInit } from '../renderer/js/utils/sentry-util'; import {appUpdater} from './autoupdater';
import { appUpdater } from './autoupdater'; import {setAutoLaunch} from './startup';
import { setAutoLaunch } from './startup';
import windowStateKeeper = require('electron-window-state'); import windowStateKeeper from 'electron-window-state';
import path = require('path'); import path from 'path';
import fs = require('fs'); import fs from 'fs';
import isDev = require('electron-is-dev'); import electron, {app, dialog, ipcMain, session} from 'electron';
import electron = require('electron');
const { app, ipcMain, session } = electron;
import AppMenu = require('./menu'); import * as AppMenu from './menu';
import BadgeSettings = require('../renderer/js/pages/preference/badge-settings'); import * as BadgeSettings from '../renderer/js/pages/preference/badge-settings';
import ConfigUtil = require('../renderer/js/utils/config-util'); import * as CertificateUtil from '../renderer/js/utils/certificate-util';
import ProxyUtil = require('../renderer/js/utils/proxy-util'); import * as ConfigUtil from '../renderer/js/utils/config-util';
import * as ProxyUtil from '../renderer/js/utils/proxy-util';
interface PatchedGlobal extends NodeJS.Global { interface PatchedGlobal extends NodeJS.Global {
mainWindowState: windowStateKeeper.State; mainWindowState: windowStateKeeper.State;
@@ -21,12 +19,6 @@ interface PatchedGlobal extends NodeJS.Global {
const globalPatched = global as PatchedGlobal; const globalPatched = global as PatchedGlobal;
// Adds debug features like hotkeys for triggering dev tools and reload
// in development mode
if (isDev) {
require('electron-debug')();
}
// Prevent window being garbage collected // Prevent window being garbage collected
let mainWindow: Electron.BrowserWindow; let mainWindow: Electron.BrowserWindow;
let badgeCount: number; let badgeCount: number;
@@ -51,12 +43,34 @@ if (singleInstanceLock) {
app.quit(); app.quit();
} }
const rendererCallbacks = new Map();
let nextRendererCallbackId = 0;
ipcMain.on('renderer-callback', (event: Event, rendererCallbackId: number, ...args: any[]) => {
rendererCallbacks.get(rendererCallbackId)(...args);
rendererCallbacks.delete(rendererCallbackId);
});
function makeRendererCallback(callback: (...args: any[]) => void): number {
rendererCallbacks.set(nextRendererCallbackId, callback);
return nextRendererCallbackId++;
}
const APP_ICON = path.join(__dirname, '../resources', 'Icon'); const APP_ICON = path.join(__dirname, '../resources', 'Icon');
const iconPath = (): string => { const iconPath = (): string => {
return APP_ICON + (process.platform === 'win32' ? '.ico' : '.png'); return APP_ICON + (process.platform === 'win32' ? '.ico' : '.png');
}; };
// Toggle the app window
const toggleApp = (): void => {
if (!mainWindow.isVisible() || mainWindow.isMinimized()) {
mainWindow.show();
} else {
mainWindow.hide();
}
};
function createMainWindow(): Electron.BrowserWindow { function createMainWindow(): Electron.BrowserWindow {
// Load the previous state with fallback to defaults // Load the previous state with fallback to defaults
const mainWindowState: windowStateKeeper.State = windowStateKeeper({ const mainWindowState: windowStateKeeper.State = windowStateKeeper({
@@ -81,7 +95,8 @@ function createMainWindow(): Electron.BrowserWindow {
webPreferences: { webPreferences: {
plugins: true, plugins: true,
nodeIntegration: true, nodeIntegration: true,
partition: 'persist:webviewsession' partition: 'persist:webviewsession',
webviewTag: true
}, },
show: false show: false
}); });
@@ -90,15 +105,16 @@ function createMainWindow(): Electron.BrowserWindow {
win.webContents.send('focus'); win.webContents.send('focus');
}); });
win.loadURL(mainURL); (async () => win.loadURL(mainURL))();
// Keep the app running in background on close event // Keep the app running in background on close event
win.on('close', e => { win.on('close', event => {
if (ConfigUtil.getConfigItem("quitOnClose")) { if (ConfigUtil.getConfigItem('quitOnClose')) {
app.quit(); app.quit();
} }
if (!isQuitting) { if (!isQuitting) {
e.preventDefault(); event.preventDefault();
if (process.platform === 'darwin') { if (process.platform === 'darwin') {
app.hide(); app.hide();
@@ -119,8 +135,8 @@ function createMainWindow(): Electron.BrowserWindow {
}); });
// To destroy tray icon when navigate to a new URL // To destroy tray icon when navigate to a new URL
win.webContents.on('will-navigate', e => { win.webContents.on('will-navigate', event => {
if (e) { if (event) {
win.webContents.send('destroytray'); win.webContents.send('destroytray');
} }
}); });
@@ -140,19 +156,20 @@ app.disableHardwareAcceleration();
// More info here - https://github.com/electron/electron/issues/10732 // More info here - https://github.com/electron/electron/issues/10732
app.commandLine.appendSwitch('force-color-profile', 'srgb'); app.commandLine.appendSwitch('force-color-profile', 'srgb');
// eslint-disable-next-line max-params // This event is only available on macOS. Triggers when you click on the dock icon.
app.on('certificate-error', (event: Event, _webContents: Electron.WebContents, _url: string, _error: string, _certificate: any, callback) => {
event.preventDefault();
callback(true);
});
app.on('activate', () => { app.on('activate', () => {
if (!mainWindow) { if (mainWindow) {
// If there is already a window show it
mainWindow.show();
} else {
mainWindow = createMainWindow(); mainWindow = createMainWindow();
} }
}); });
app.on('ready', () => { app.on('ready', () => {
const ses = session.fromPartition('persist:webviewsession');
ses.setUserAgent(`ZulipElectron/${app.getVersion()} ${ses.getUserAgent()}`);
AppMenu.setMenu({ AppMenu.setMenu({
tabs: [] tabs: []
}); });
@@ -161,7 +178,7 @@ app.on('ready', () => {
// Auto-hide menu bar on Windows + Linux // Auto-hide menu bar on Windows + Linux
if (process.platform !== 'darwin') { if (process.platform !== 'darwin') {
const shouldHideMenu = ConfigUtil.getConfigItem('autoHideMenubar') || false; const shouldHideMenu = ConfigUtil.getConfigItem('autoHideMenubar') || false;
mainWindow.setAutoHideMenuBar(shouldHideMenu); mainWindow.autoHideMenuBar = shouldHideMenu;
mainWindow.setMenuBarVisibility(!shouldHideMenu); mainWindow.setMenuBarVisibility(!shouldHideMenu);
} }
@@ -174,7 +191,7 @@ app.on('ready', () => {
const isSystemProxy = ConfigUtil.getConfigItem('useSystemProxy'); const isSystemProxy = ConfigUtil.getConfigItem('useSystemProxy');
if (isSystemProxy) { if (isSystemProxy) {
ProxyUtil.resolveSystemProxy(mainWindow); (async () => ProxyUtil.resolveSystemProxy(mainWindow))();
} }
const page = mainWindow.webContents; const page = mainWindow.webContents;
@@ -185,10 +202,10 @@ app.on('ready', () => {
} else { } else {
mainWindow.show(); mainWindow.show();
} }
if (!ConfigUtil.isConfigItemExists('userAgent')) { });
const userAgent = session.fromPartition('webview:persistsession').getUserAgent();
ConfigUtil.setConfigItem('userAgent', userAgent); ipcMain.on('fetch-user-agent', event => {
} event.returnValue = session.fromPartition('persist:webviewsession').getUserAgent();
}); });
page.once('did-frame-finish-load', () => { page.once('did-frame-finish-load', () => {
@@ -198,6 +215,64 @@ app.on('ready', () => {
} }
}); });
app.on('certificate-error', (
event: Event,
webContents: Electron.WebContents,
url: string,
error: string,
certificate: Electron.Certificate,
callback: (isTrusted: boolean) => void
) /* eslint-disable-line max-params */ => {
// TODO: The entire concept of selectively ignoring certificate errors
// is ill-conceived, and this handler needs to be deleted.
event.preventDefault();
const {origin} = new URL(url);
const filename = CertificateUtil.getCertificate(encodeURIComponent(origin));
if (filename !== undefined) {
try {
const savedCertificate = fs.readFileSync(
path.join(`${app.getPath('userData')}/certificates`, filename),
'utf8'
);
if (certificate.data.replace(/[\r\n]/g, '') ===
savedCertificate.replace(/[\r\n]/g, '')) {
callback(true);
return;
}
} catch (error) {
console.error(`Error reading certificate file ${filename}:`, error);
}
}
page.send(
'certificate-error',
webContents.id === mainWindow.webContents.id ? null : webContents.id,
makeRendererCallback(ignore => {
callback(ignore);
if (!ignore) {
dialog.showErrorBox(
'Certificate error',
`The server presented an invalid certificate for ${origin}:
${error}`
);
}
})
);
});
page.session.setPermissionRequestHandler((webContents, permission, callback, details) => {
const {origin} = new URL(details.requestingUrl);
page.send('permission-request', {
webContentsId: webContents.id === mainWindow.webContents.id ?
null :
webContents.id,
origin,
permission
}, makeRendererCallback(callback));
});
// Temporarily remove this event // Temporarily remove this event
// electron.powerMonitor.on('resume', () => { // electron.powerMonitor.on('resume', () => {
// mainWindow.reload(); // mainWindow.reload();
@@ -251,38 +326,34 @@ app.on('ready', () => {
}); });
ipcMain.on('toggle-app', () => { ipcMain.on('toggle-app', () => {
if (!mainWindow.isVisible() || mainWindow.isMinimized()) { toggleApp();
mainWindow.show();
} else {
mainWindow.hide();
}
}); });
ipcMain.on('toggle-badge-option', () => { ipcMain.on('toggle-badge-option', () => {
BadgeSettings.updateBadge(badgeCount, mainWindow); BadgeSettings.updateBadge(badgeCount, mainWindow);
}); });
ipcMain.on('toggle-menubar', (_event: Electron.IpcMessageEvent, showMenubar: boolean) => { ipcMain.on('toggle-menubar', (_event: Electron.IpcMainEvent, showMenubar: boolean) => {
mainWindow.setAutoHideMenuBar(showMenubar); mainWindow.autoHideMenuBar = showMenubar;
mainWindow.setMenuBarVisibility(!showMenubar); mainWindow.setMenuBarVisibility(!showMenubar);
page.send('toggle-autohide-menubar', showMenubar, true); page.send('toggle-autohide-menubar', showMenubar, true);
}); });
ipcMain.on('update-badge', (_event: Electron.IpcMessageEvent, messageCount: number) => { ipcMain.on('update-badge', (_event: Electron.IpcMainEvent, messageCount: number) => {
badgeCount = messageCount; badgeCount = messageCount;
BadgeSettings.updateBadge(badgeCount, mainWindow); BadgeSettings.updateBadge(badgeCount, mainWindow);
page.send('tray', messageCount); page.send('tray', messageCount);
}); });
ipcMain.on('update-taskbar-icon', (_event: Electron.IpcMessageEvent, data: any, text: string) => { ipcMain.on('update-taskbar-icon', (_event: Electron.IpcMainEvent, data: string, text: string) => {
BadgeSettings.updateTaskbarIcon(data, text, mainWindow); BadgeSettings.updateTaskbarIcon(data, text, mainWindow);
}); });
ipcMain.on('forward-message', (_event: Electron.IpcMessageEvent, listener: any, ...params: any[]) => { ipcMain.on('forward-message', (_event: Electron.IpcMainEvent, listener: string, ...parameters: unknown[]) => {
page.send(listener, ...params); page.send(listener, ...parameters);
}); });
ipcMain.on('update-menu', (_event: Electron.IpcMessageEvent, props: any) => { ipcMain.on('update-menu', (_event: Electron.IpcMainEvent, props: AppMenu.MenuProps) => {
AppMenu.setMenu(props); AppMenu.setMenu(props);
const activeTab = props.tabs[props.activeTabIndex]; const activeTab = props.tabs[props.activeTabIndex];
if (activeTab) { if (activeTab) {
@@ -290,35 +361,39 @@ app.on('ready', () => {
} }
}); });
ipcMain.on('toggleAutoLauncher', (_event: Electron.IpcMessageEvent, AutoLaunchValue: boolean) => { ipcMain.on('toggleAutoLauncher', async (_event: Electron.IpcMainEvent, AutoLaunchValue: boolean) => {
setAutoLaunch(AutoLaunchValue); await setAutoLaunch(AutoLaunchValue);
}); });
ipcMain.on('downloadFile', (_event: Electron.IpcMessageEvent, url: string, downloadPath: string) => { ipcMain.on('downloadFile', (_event: Electron.IpcMainEvent, url: string, downloadPath: string) => {
page.downloadURL(url); page.downloadURL(url);
page.session.once('will-download', (_event: Event, item) => { page.session.once('will-download', async (_event: Event, item) => {
const filePath = path.join(downloadPath, item.getFilename()); if (ConfigUtil.getConfigItem('promptDownload', false)) {
const showDialogOptions: object = {
defaultPath: path.join(downloadPath, item.getFilename())
};
item.setSaveDialogOptions(showDialogOptions);
} else {
const getTimeStamp = (): number => {
const date = new Date();
return date.getTime();
};
const getTimeStamp = (): any => { const formatFile = (filePath: string): string => {
const date = new Date(); const fileExtension = path.extname(filePath);
return date.getTime(); const baseName = path.basename(filePath, fileExtension);
}; return `${baseName}-${getTimeStamp()}${fileExtension}`;
};
const formatFile = (filePath: string): string => { const filePath = path.join(downloadPath, item.getFilename());
const fileExtension = path.extname(filePath);
const baseName = path.basename(filePath, fileExtension);
return `${baseName}-${getTimeStamp()}${fileExtension}`;
};
// Update the name and path of the file if it already exists // Update the name and path of the file if it already exists
const updatedFilePath = path.join(downloadPath, formatFile(filePath));
const setFilePath: string = fs.existsSync(filePath) ? updatedFilePath : filePath;
item.setSavePath(setFilePath);
}
const updatedFilePath = path.join(downloadPath, formatFile(filePath)); const updatedListener = (_event: Event, state: string): void => {
const setFilePath = fs.existsSync(filePath) ? updatedFilePath : filePath;
item.setSavePath(setFilePath);
item.on('updated', (_event: Event, state) => {
switch (state) { switch (state) {
case 'interrupted': { case 'interrupted': {
// Can interrupted to due to network error, cancel download then // Can interrupted to due to network error, cancel download then
@@ -326,47 +401,52 @@ app.on('ready', () => {
item.cancel(); item.cancel();
break; break;
} }
case 'progressing': { case 'progressing': {
if (item.isPaused()) { if (item.isPaused()) {
item.cancel(); item.cancel();
} }
// This event can also be used to show progress in percentage in future. // This event can also be used to show progress in percentage in future.
break; break;
} }
default: { default: {
console.info('Unknown updated state of download item'); console.info('Unknown updated state of download item');
} }
} }
}); };
item.on('updated', updatedListener);
item.once('done', (_event: Event, state) => { item.once('done', (_event: Event, state) => {
const getFileName = fs.existsSync(filePath) ? formatFile(filePath) : item.getFilename();
if (state === 'completed') { if (state === 'completed') {
page.send('downloadFileCompleted', item.getSavePath(), getFileName); page.send('downloadFileCompleted', item.getSavePath(), path.basename(item.getSavePath()));
} else { } else {
console.log('Download failed state: ', state); console.log('Download failed state:', state);
page.send('downloadFileFailed'); page.send('downloadFileFailed', state);
} }
// To stop item for listening to updated events of this file // To stop item for listening to updated events of this file
item.removeAllListeners('updated'); item.removeListener('updated', updatedListener);
}); });
}); });
}); });
ipcMain.on('realm-name-changed', (_event: Electron.IpcMessageEvent, serverURL: string, realmName: string) => { ipcMain.on('realm-name-changed', (_event: Electron.IpcMainEvent, serverURL: string, realmName: string) => {
page.send('update-realm-name', serverURL, realmName); page.send('update-realm-name', serverURL, realmName);
}); });
ipcMain.on('realm-icon-changed', (_event: Electron.IpcMessageEvent, serverURL: string, iconURL: string) => { ipcMain.on('realm-icon-changed', (_event: Electron.IpcMainEvent, serverURL: string, iconURL: string) => {
page.send('update-realm-icon', serverURL, iconURL); page.send('update-realm-icon', serverURL, iconURL);
}); });
// Using event.sender.send instead of page.send here to // Using event.sender.send instead of page.send here to
// make sure the value of errorReporting is sent only once on load. // make sure the value of errorReporting is sent only once on load.
ipcMain.on('error-reporting', (event: Electron.IpcMessageEvent) => { ipcMain.on('error-reporting', (event: Electron.IpcMainEvent) => {
event.sender.send('error-reporting-val', errorReporting); event.sender.send('error-reporting-val', errorReporting);
}); });
ipcMain.on('save-last-tab', (_event: Electron.IpcMessageEvent, index: number) => { ipcMain.on('save-last-tab', (_event: Electron.IpcMainEvent, index: number) => {
ConfigUtil.setConfigItem('lastActiveTab', index); ConfigUtil.setConfigItem('lastActiveTab', index);
}); });
@@ -375,19 +455,12 @@ app.on('ready', () => {
setInterval(() => { setInterval(() => {
// Set user idle if no activity in 1 second (idleThresholdSeconds) // Set user idle if no activity in 1 second (idleThresholdSeconds)
const idleThresholdSeconds = 1; // 1 second const idleThresholdSeconds = 1; // 1 second
const idleState = electron.powerMonitor.getSystemIdleState(idleThresholdSeconds);
// TODO: Remove typecast to any when types get added if (idleState === 'active') {
// TODO: use powerMonitor.getSystemIdleState when upgrading electron page.send('set-active');
// powerMonitor.querySystemIdleState is deprecated in current electron } else {
// version at the time of writing. page.send('set-idle');
const powerMonitor = electron.powerMonitor as any; }
powerMonitor.querySystemIdleState(idleThresholdSeconds, (idleState: string) => {
if (idleState === 'active') {
page.send('set-active');
} else {
page.send('set-idle');
}
});
}, idleCheckInterval); }, idleCheckInterval);
}); });

View File

@@ -1,11 +1,11 @@
import { app, Notification } from 'electron'; import {app, Notification} from 'electron';
import request = require('request'); import request from 'request';
import semver = require('semver'); import semver from 'semver';
import ConfigUtil = require('../renderer/js/utils/config-util'); import * as ConfigUtil from '../renderer/js/utils/config-util';
import ProxyUtil = require('../renderer/js/utils/proxy-util'); import * as ProxyUtil from '../renderer/js/utils/proxy-util';
import LinuxUpdateUtil = require('../renderer/js/utils/linux-update-util'); import * as LinuxUpdateUtil from '../renderer/js/utils/linux-update-util';
import Logger = require('../renderer/js/utils/logger-util'); import Logger from '../renderer/js/utils/logger-util';
const logger = new Logger({ const logger = new Logger({
file: 'linux-update-util.log', file: 'linux-update-util.log',
@@ -24,20 +24,24 @@ export function linuxUpdateNotification(): void {
ecdhCurve: 'auto' ecdhCurve: 'auto'
}; };
request(options, (error: any, response: any, body: any) => { request(options, (error, response: request.Response, body: string) => {
if (error) { if (error) {
logger.error('Linux update error.'); logger.error('Linux update error.');
logger.error(error); logger.error(error);
return; return;
} }
if (response.statusCode < 400) { if (response.statusCode < 400) {
const data = JSON.parse(body); const data = JSON.parse(body);
const latestVersion = ConfigUtil.getConfigItem('betaUpdate') ? data[0].tag_name : data.tag_name; const latestVersion = ConfigUtil.getConfigItem('betaUpdate') ? data[0].tag_name : data.tag_name;
if (typeof latestVersion !== 'string') {
throw new TypeError('Expected string for tag_name');
}
if (semver.gt(latestVersion, app.getVersion())) { if (semver.gt(latestVersion, app.getVersion())) {
const notified = LinuxUpdateUtil.getUpdateItem(latestVersion); const notified = LinuxUpdateUtil.getUpdateItem(latestVersion);
if (notified === null) { if (notified === null) {
new Notification({title: 'Zulip Update', body: 'A new version ' + latestVersion + ' is available. Please update using your package manager.'}).show(); new Notification({title: 'Zulip Update', body: `A new version ${latestVersion} is available. Please update using your package manager.`}).show();
LinuxUpdateUtil.setUpdateItem(latestVersion, true); LinuxUpdateUtil.setUpdateItem(latestVersion, true);
} }
} }

File diff suppressed because it is too large Load Diff

View File

@@ -1,31 +1,32 @@
'use strict'; import {app} from 'electron';
import { app } from 'electron';
import AutoLaunch = require('auto-launch'); import AutoLaunch from 'auto-launch';
import isDev = require('electron-is-dev'); import isDev from 'electron-is-dev';
import ConfigUtil = require('../renderer/js/utils/config-util'); import * as ConfigUtil from '../renderer/js/utils/config-util';
export const setAutoLaunch = (AutoLaunchValue: boolean): void => { export const setAutoLaunch = async (AutoLaunchValue: boolean): Promise<void> => {
// Don't run this in development // Don't run this in development
if (isDev) { if (isDev) {
return; return;
} }
// On Mac, work around a bug in auto-launch where it opens a Terminal window
// See https://github.com/Teamwork/node-auto-launch/issues/28#issuecomment-222194437
const appPath = process.platform === 'darwin' ? app.getPath('exe').replace(/\.app\/Content.*/, '.app') : undefined; // Use the default
const ZulipAutoLauncher = new AutoLaunch({
name: 'Zulip',
path: appPath,
isHidden: false
});
const autoLaunchOption = ConfigUtil.getConfigItem('startAtLogin', AutoLaunchValue); const autoLaunchOption = ConfigUtil.getConfigItem('startAtLogin', AutoLaunchValue);
if (autoLaunchOption) { // `setLoginItemSettings` doesn't support linux
ZulipAutoLauncher.enable(); if (process.platform === 'linux') {
const ZulipAutoLauncher = new AutoLaunch({
name: 'Zulip',
isHidden: false
});
if (autoLaunchOption) {
await ZulipAutoLauncher.enable();
} else {
await ZulipAutoLauncher.disable();
}
} else { } else {
ZulipAutoLauncher.disable(); app.setLoginItemSettings({
openAtLogin: autoLaunchOption,
openAsHidden: false
});
} }
}; };

1940
app/package-lock.json generated

File diff suppressed because it is too large Load Diff

View File

@@ -1,51 +0,0 @@
{
"name": "zulip",
"productName": "Zulip",
"version": "4.0.2-beta",
"desktopName": "zulip.desktop",
"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-desktop.git"
},
"bugs": {
"url": "https://github.com/zulip/zulip-desktop/issues"
},
"main": "main/index.js",
"keywords": [
"Zulip",
"Group Chat app",
"electron-app",
"electron",
"Desktop app",
"InstantMessaging"
],
"dependencies": {
"@electron-elements/send-feedback": "1.0.8",
"@sentry/electron": "0.14.0",
"adm-zip": "0.4.11",
"auto-launch": "5.0.5",
"backoff": "2.5.0",
"dotenv": "8.0.0",
"electron-is-dev": "0.3.0",
"electron-log": "2.2.14",
"electron-spellchecker": "1.1.2",
"electron-updater": "4.0.6",
"electron-window-state": "5.0.3",
"escape-html": "1.0.3",
"i18n": "0.8.3",
"node-json-db": "0.9.2",
"request": "2.85.0",
"semver": "5.4.1",
"wurl": "2.5.0"
},
"optionalDependencies": {
"node-mac-notifier": "1.1.0"
}
}

View File

@@ -14,33 +14,19 @@
<div class="maintenance-info"> <div class="maintenance-info">
<p class="detail maintainer"> <p class="detail maintainer">
Maintained by Maintained by
<a onclick="linkInBrowser('website')">Zulip</a> <a href="https://zulipchat.com" target="_blank" rel="noopener noreferrer">Zulip</a>
</p> </p>
<p class="detail license"> <p class="detail license">
Available under the Available under the
<a onclick="linkInBrowser('license')">Apache 2.0 License</a> <a href="https://github.com/zulip/zulip-desktop/blob/master/LICENSE" target="_blank" rel="noopener noreferrer">Apache 2.0 License</a>
</p> </p>
</div> </div>
</div> </div>
<script> <script>
const { app } = require('electron').remote; const { app } = require('electron').remote;
const { shell } = require('electron');
const version_tag = document.querySelector('#version'); const version_tag = document.querySelector('#version');
version_tag.innerHTML = 'v' + app.getVersion(); version_tag.innerHTML = 'v' + app.getVersion();
function linkInBrowser(type) {
let url;
switch (type) {
case 'website':
url = "https://zulipchat.com";
break;
case 'license':
url = "https://github.com/zulip/zulip-desktop/blob/master/LICENSE";
break;
}
shell.openExternal(url);
}
</script> </script>
<script>require('./js/shared/preventdrag.js')</script> <script>require('./js/shared/preventdrag.js')</script>
</body> </body>

View File

@@ -724,3 +724,13 @@ i.open-network-button {
margin-top: 10px; margin-top: 10px;
} }
} }
.lang-menu {
font-size: 13px;
font-weight: bold;
background: rgba(78, 191, 172, 1.000);
width: 100px;
height: 38px;
color: rgba(255, 255, 255, 1.000);
border-color: rgba(0, 0, 0, 0);
}

View File

@@ -0,0 +1,82 @@
import {clipboard} from 'electron';
import crypto from 'crypto';
// This helper is exposed via electron_bridge for use in the social
// login flow.
//
// It consists of a key and a promised token. The in-app page sends
// the key to the server, and opens the users browser to a page where
// they can log in and get a token encrypted to that key. When the
// user copies the encrypted token from their browser to the
// clipboard, we decrypt it and resolve the promise. The in-app page
// then uses the decrypted token to log the user in within the app.
//
// The encryption is authenticated (AES-GCM) to guarantee that we
// dont leak anything from the users clipboard other than the token
// intended for us.
export class ClipboardDecrypterImpl implements ClipboardDecrypter {
version: number;
key: Uint8Array;
pasted: Promise<string>;
constructor(_: number) {
// At this time, the only version is 1.
this.version = 1;
this.key = crypto.randomBytes(32);
this.pasted = new Promise(resolve => {
let interval: NodeJS.Timeout | null = null;
const startPolling = () => {
if (interval === null) {
interval = setInterval(poll, 1000);
}
poll();
};
const stopPolling = () => {
if (interval !== null) {
clearInterval(interval);
interval = null;
}
};
const poll = () => {
let plaintext;
try {
const data = Buffer.from(clipboard.readText(), 'hex');
const iv = data.slice(0, 12);
const ciphertext = data.slice(12, -16);
const authTag = data.slice(-16);
const decipher = crypto.createDecipheriv(
'aes-256-gcm',
this.key,
iv,
{authTagLength: 16}
);
decipher.setAuthTag(authTag);
plaintext =
decipher.update(ciphertext, undefined, 'utf8') +
decipher.final('utf8');
} catch (_) {
// If the parsing or decryption failed in any way,
// the correct token hasnt been copied yet; try
// again next time.
return;
}
window.removeEventListener('focus', startPolling);
window.removeEventListener('blur', stopPolling);
stopPolling();
resolve(plaintext);
};
window.addEventListener('focus', startPolling);
window.addEventListener('blur', stopPolling);
if (document.hasFocus()) {
startPolling();
}
});
}
}

View File

@@ -1,11 +1,7 @@
'use strict'; export default class BaseComponent {
class BaseComponent {
generateNodeFromTemplate(template: string): Element | null { generateNodeFromTemplate(template: string): Element | null {
const wrapper = document.createElement('div'); const wrapper = document.createElement('div');
wrapper.innerHTML = template; wrapper.innerHTML = template;
return wrapper.firstElementChild; return wrapper.firstElementChild;
} }
} }
export = BaseComponent;

View File

@@ -1,9 +1,13 @@
'use strict'; import Tab, {TabProps} from './tab';
import Tab = require('./tab'); export default class FunctionalTab extends Tab {
class FunctionalTab extends Tab {
$closeButton: Element; $closeButton: Element;
constructor(props: TabProps) {
super(props);
this.init();
}
template(): string { template(): string {
return `<div class="tab functional-tab" data-tab-id="${this.props.tabIndex}"> return `<div class="tab functional-tab" data-tab-id="${this.props.tabIndex}">
<div class="server-tab-badge close-button"> <div class="server-tab-badge close-button">
@@ -15,12 +19,6 @@ class FunctionalTab extends Tab {
</div>`; </div>`;
} }
// TODO: Typescript - This type for props should be TabProps
constructor(props: any) {
super(props);
this.init();
}
init(): void { init(): void {
this.$el = this.generateNodeFromTemplate(this.template()); this.$el = this.generateNodeFromTemplate(this.template());
if (this.props.name !== 'Settings') { if (this.props.name !== 'Settings') {
@@ -41,11 +39,9 @@ class FunctionalTab extends Tab {
this.$closeButton.classList.remove('active'); this.$closeButton.classList.remove('active');
}); });
this.$closeButton.addEventListener('click', (e: Event) => { this.$closeButton.addEventListener('click', (event: Event) => {
this.props.onDestroy(); this.props.onDestroy();
e.stopPropagation(); event.stopPropagation();
}); });
} }
} }
export = FunctionalTab;

View File

@@ -1,83 +1,60 @@
import { ipcRenderer, remote } from 'electron'; import {ipcRenderer, remote} from 'electron';
import LinkUtil = require('../utils/link-util'); import * as LinkUtil from '../utils/link-util';
import DomainUtil = require('../utils/domain-util'); import * as ConfigUtil from '../utils/config-util';
import ConfigUtil = require('../utils/config-util'); import type WebView from './webview';
const { shell, app } = remote; const {shell, app} = remote;
const dingSound = new Audio('../resources/sounds/ding.ogg'); const dingSound = new Audio('../resources/sounds/ding.ogg');
// TODO: TypeScript - Figure out a way to pass correct type here. export default function handleExternalLink(this: WebView, event: Electron.NewWindowEvent): void {
function handleExternalLink(this: any, event: any): void { event.preventDefault();
const { url } = event;
const domainPrefix = DomainUtil.getDomain(this.props.index).url; const url = new URL(event.url);
const downloadPath = ConfigUtil.getConfigItem('downloadsPath', `${app.getPath('downloads')}`); const downloadPath = ConfigUtil.getConfigItem('downloadsPath', `${app.getPath('downloads')}`);
const shouldShowInFolder = ConfigUtil.getConfigItem('showDownloadFolder', false);
// Whitelist URLs which are allowed to be opened in the app if (LinkUtil.isUploadsUrl(this.props.url, url)) {
const { ipcRenderer.send('downloadFile', url.href, downloadPath);
isInternalUrl: isWhiteListURL, ipcRenderer.once('downloadFileCompleted', async (_event: Event, filePath: string, fileName: string) => {
isUploadsUrl: isUploadsURL const downloadNotification = new Notification('Download Complete', {
} = LinkUtil.isInternal(domainPrefix, url); body: `Click to show ${fileName} in folder`,
silent: true // We'll play our own sound - ding.ogg
});
if (isWhiteListURL) { downloadNotification.addEventListener('click', () => {
event.preventDefault(); // Reveal file in download folder
shell.showItemInFolder(filePath);
});
ipcRenderer.removeAllListeners('downloadFileFailed');
// Code to show pdf in a new BrowserWindow (currently commented out due to bug-upstream) // Play sound to indicate download complete
// Show pdf attachments in a new window if (!ConfigUtil.getConfigItem('silent')) {
// if (LinkUtil.isPDF(url) && isUploadsURL) { await dingSound.play();
// ipcRenderer.send('pdf-view', url); }
// return; });
// }
// download txt, mp3, mp4 etc.. by using downloadURL in the ipcRenderer.once('downloadFileFailed', (_event: Event, state: string) => {
// main process which allows the user to save the files to their desktop // Automatic download failed, so show save dialog prompt and download
// and not trigger webview reload while image in webview will // through webview
// do nothing and will not save it // Only do this if it is the automatic download, otherwise show an error (so we aren't showing two save
// prompts right after each other)
// Code to show pdf in a new BrowserWindow (currently commented out due to bug-upstream) // Check that the download is not cancelled by user
// if (!LinkUtil.isImage(url) && !LinkUtil.isPDF(url) && isUploadsURL) { if (state !== 'cancelled') {
if (!LinkUtil.isImage(url) && isUploadsURL) { if (ConfigUtil.getConfigItem('promptDownload', false)) {
ipcRenderer.send('downloadFile', url, downloadPath); // We need to create a "new Notification" to display it, but just `Notification(...)` on its own
ipcRenderer.once('downloadFileCompleted', (_event: Event, filePath: string, fileName: string) => { // doesn't work
const downloadNotification = new Notification('Download Complete', { new Notification('Download Complete', { // eslint-disable-line no-new
body: shouldShowInFolder ? `Click to show ${fileName} in folder` : `Click to open ${fileName}`, body: 'Download failed'
silent: true // We'll play our own sound - ding.ogg });
}); } else {
this.$el.downloadURL(url.href);
// Play sound to indicate download complete
if (!ConfigUtil.getConfigItem('silent')) {
dingSound.play();
} }
}
downloadNotification.addEventListener('click', () => { ipcRenderer.removeAllListeners('downloadFileCompleted');
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.
this.$el.loadURL(url);
} else { } else {
event.preventDefault(); (async () => LinkUtil.openBrowser(url))();
shell.openExternal(url);
} }
} }
export = handleExternalLink;

View File

@@ -1,13 +1,16 @@
'use strict'; import {ipcRenderer} from 'electron';
import { ipcRenderer } from 'electron'; import Tab, {TabProps} from './tab';
import * as SystemUtil from '../utils/system-util';
import Tab = require('./tab'); export default class ServerTab extends Tab {
import SystemUtil = require('../utils/system-util');
class ServerTab extends Tab {
$badge: Element; $badge: Element;
constructor(props: TabProps) {
super(props);
this.init();
}
template(): string { template(): string {
return `<div class="tab" data-tab-id="${this.props.tabIndex}"> return `<div class="tab" data-tab-id="${this.props.tabIndex}">
<div class="server-tooltip" style="display:none">${this.props.name}</div> <div class="server-tooltip" style="display:none">${this.props.name}</div>
@@ -19,12 +22,6 @@ class ServerTab extends Tab {
</div>`; </div>`;
} }
// TODO: Typescript - This type for props should be TabProps
constructor(props: any) {
super(props);
this.init();
}
init(): void { init(): void {
this.$el = this.generateNodeFromTemplate(this.template()); this.$el = this.generateNodeFromTemplate(this.template());
this.props.$root.append(this.$el); this.props.$root.append(this.$el);
@@ -64,5 +61,3 @@ class ServerTab extends Tab {
return shortcutText; return shortcutText;
} }
} }
export = ServerTab;

View File

@@ -1,14 +1,22 @@
'use strict'; import WebView from './webview';
import BaseComponent from './base';
import WebView = require('./webview'); export interface TabProps {
import BaseComponent = require('./base'); role: string;
icon?: string;
// TODO: TypeScript - Type annotate props name: string;
interface TabProps { $root: Element;
[key: string]: any; onClick: () => void;
index: number;
tabIndex: number;
onHover?: () => void;
onHoverOut?: () => void;
webview: WebView;
materialIcon?: string;
onDestroy?: () => void;
} }
class Tab extends BaseComponent { export default class Tab extends BaseComponent {
props: TabProps; props: TabProps;
webview: WebView; webview: WebView;
$el: Element; $el: Element;
@@ -40,9 +48,7 @@ class Tab extends BaseComponent {
} }
destroy(): void { destroy(): void {
this.$el.parentNode.removeChild(this.$el); this.$el.remove();
this.webview.$el.parentNode.removeChild(this.webview.$el); this.webview.$el.remove();
} }
} }
export = Tab;

View File

@@ -1,40 +1,48 @@
'use strict'; import {ipcRenderer, remote} from 'electron';
import { remote } from 'electron';
import path = require('path'); import path from 'path';
import fs = require('fs'); import fs from 'fs';
import ConfigUtil = require('../utils/config-util'); import * as ConfigUtil from '../utils/config-util';
import SystemUtil = require('../utils/system-util'); import * as SystemUtil from '../utils/system-util';
import BaseComponent = require('../components/base'); import BaseComponent from './base';
import handleExternalLink = require('../components/handle-external-link'); import handleExternalLink from './handle-external-link';
const { app, dialog } = remote; const {app, dialog} = remote;
const shouldSilentWebview = ConfigUtil.getConfigItem('silent'); const shouldSilentWebview = ConfigUtil.getConfigItem('silent');
// TODO: TypeScript - Type annotate WebViewProps.
interface WebViewProps { interface WebViewProps {
[key: string]: any; $root: Element;
index: number;
tabIndex: number;
url: string;
role: string;
name: string;
isActive: () => boolean;
switchLoading: (loading: boolean, url: string) => void;
onNetworkError: (index: number) => void;
nodeIntegration: boolean;
preload: boolean;
onTitleChange: () => void;
ignoreCerts?: boolean;
hasPermission?: (origin: string, permission: string) => boolean;
} }
class WebView extends BaseComponent { export default class WebView extends BaseComponent {
props: any; props: WebViewProps;
zoomFactor: number; zoomFactor: number;
badgeCount: number; badgeCount: number;
loading: boolean; loading: boolean;
customCSS: string; customCSS: string;
$webviewsContainer: DOMTokenList; $webviewsContainer: DOMTokenList;
$el: Electron.WebviewTag; $el: Electron.WebviewTag;
domReady?: Promise<void>;
// This is required because in main.js we access WebView.method as
// webview[method].
[key: string]: any;
constructor(props: WebViewProps) { constructor(props: WebViewProps) {
super(); super();
this.props = props; this.props = props;
this.zoomFactor = 1.0; this.zoomFactor = 1;
this.loading = true; this.loading = true;
this.badgeCount = 0; this.badgeCount = 0;
this.customCSS = ConfigUtil.getConfigItem('customCSS'); this.customCSS = ConfigUtil.getConfigItem('customCSS');
@@ -47,16 +55,18 @@ class WebView extends BaseComponent {
data-tab-id="${this.props.tabIndex}" data-tab-id="${this.props.tabIndex}"
src="${this.props.url}" src="${this.props.url}"
${this.props.nodeIntegration ? 'nodeIntegration' : ''} ${this.props.nodeIntegration ? 'nodeIntegration' : ''}
disablewebsecurity
${this.props.preload ? 'preload="js/preload.js"' : ''} ${this.props.preload ? 'preload="js/preload.js"' : ''}
partition="persist:webviewsession" partition="persist:webviewsession"
name="${this.props.name}" name="${this.props.name}"
webpreferences="allowRunningInsecureContent, javascript=yes"> webpreferences="${this.props.nodeIntegration ? '' : 'contextIsolation, '}javascript=yes">
</webview>`; </webview>`;
} }
init(): void { init(): void {
this.$el = this.generateNodeFromTemplate(this.template()) as Electron.WebviewTag; this.$el = this.generateNodeFromTemplate(this.template()) as Electron.WebviewTag;
this.domReady = new Promise(resolve => {
this.$el.addEventListener('dom-ready', () => resolve(), true);
});
this.props.$root.append(this.$el); this.props.$root.append(this.$el);
this.registerListeners(); this.registerListeners();
@@ -74,7 +84,7 @@ class WebView extends BaseComponent {
} }
this.$el.addEventListener('page-title-updated', event => { this.$el.addEventListener('page-title-updated', event => {
const { title } = event; const {title} = event;
this.badgeCount = this.getBadgeCount(title); this.badgeCount = this.getBadgeCount(title);
this.props.onTitleChange(); this.props.onTitleChange();
}); });
@@ -84,6 +94,7 @@ class WebView extends BaseComponent {
if (isSettingPage) { if (isSettingPage) {
return; return;
} }
this.canGoBackButton(); this.canGoBackButton();
}); });
@@ -92,14 +103,14 @@ class WebView extends BaseComponent {
}); });
this.$el.addEventListener('page-favicon-updated', event => { this.$el.addEventListener('page-favicon-updated', event => {
const { favicons } = event; const {favicons} = event;
// This returns a string of favicons URL. If there is a PM counts in unread messages then the URL would be like // This returns a string of favicons URL. If there is a PM counts in unread messages then the URL would be like
// https://chat.zulip.org/static/images/favicon/favicon-pms.png // https://chat.zulip.org/static/images/favicon/favicon-pms.png
if (favicons[0].indexOf('favicon-pms') > 0 && process.platform === 'darwin') { if (favicons[0].indexOf('favicon-pms') > 0 && process.platform === 'darwin') {
// This api is only supported on macOS // This api is only supported on macOS
app.dock.setBadge('●'); app.dock.setBadge('●');
// bounce the dock // Bounce the dock
if (ConfigUtil.getConfigItem('dockBouncing')) { if (ConfigUtil.getConfigItem('dockBouncing')) {
app.dock.bounce(); app.dock.bounce();
} }
@@ -110,6 +121,7 @@ class WebView extends BaseComponent {
if (this.props.role === 'server') { if (this.props.role === 'server') {
this.$el.classList.add('onload'); this.$el.classList.add('onload');
} }
this.loading = false; this.loading = false;
this.props.switchLoading(false, this.props.url); this.props.switchLoading(false, this.props.url);
this.show(); this.show();
@@ -121,7 +133,7 @@ class WebView extends BaseComponent {
}); });
this.$el.addEventListener('did-fail-load', event => { this.$el.addEventListener('did-fail-load', event => {
const { errorDescription } = event; const {errorDescription} = event;
const hasConnectivityErr = SystemUtil.connectivityERR.includes(errorDescription); const hasConnectivityErr = SystemUtil.connectivityERR.includes(errorDescription);
if (hasConnectivityErr) { if (hasConnectivityErr) {
console.error('error', errorDescription); console.error('error', errorDescription);
@@ -136,12 +148,6 @@ class WebView extends BaseComponent {
if (!isSettingPage) { if (!isSettingPage) {
this.props.switchLoading(true, this.props.url); this.props.switchLoading(true, this.props.url);
} }
let userAgent = SystemUtil.getUserAgent();
if (!userAgent) {
SystemUtil.setUserAgent(this.$el.getUserAgent());
userAgent = SystemUtil.getUserAgent();
}
this.$el.setUserAgent(userAgent);
}); });
this.$el.addEventListener('did-stop-loading', () => { this.$el.addEventListener('did-stop-loading', () => {
@@ -155,7 +161,7 @@ class WebView extends BaseComponent {
} }
showNotificationSettings(): void { showNotificationSettings(): void {
this.$el.executeJavaScript('showNotificationSettings()'); ipcRenderer.sendTo(this.$el.getWebContentsId(), 'show-notification-settings');
} }
show(): void { show(): void {
@@ -181,26 +187,26 @@ class WebView extends BaseComponent {
this.focus(); this.focus();
this.props.onTitleChange(); this.props.onTitleChange();
// Injecting preload css in webview to override some css rules // Injecting preload css in webview to override some css rules
this.$el.insertCSS(fs.readFileSync(path.join(__dirname, '/../../css/preload.css'), 'utf8')); (async () => this.$el.insertCSS(fs.readFileSync(path.join(__dirname, '/../../css/preload.css'), 'utf8')))();
// get customCSS again from config util to avoid warning user again // Get customCSS again from config util to avoid warning user again
this.customCSS = ConfigUtil.getConfigItem('customCSS'); this.customCSS = ConfigUtil.getConfigItem('customCSS');
if (this.customCSS) { if (this.customCSS) {
if (!fs.existsSync(this.customCSS)) { if (!fs.existsSync(this.customCSS)) {
this.customCSS = null; this.customCSS = null;
ConfigUtil.setConfigItem('customCSS', null); ConfigUtil.setConfigItem('customCSS', null);
const errMsg = 'The custom css previously set is deleted!'; const errorMessage = 'The custom css previously set is deleted!';
dialog.showErrorBox('custom css file deleted!', errMsg); dialog.showErrorBox('custom css file deleted!', errorMessage);
return; return;
} }
this.$el.insertCSS(fs.readFileSync(path.resolve(__dirname, this.customCSS), 'utf8')); (async () => this.$el.insertCSS(fs.readFileSync(path.resolve(__dirname, this.customCSS), 'utf8')))();
} }
} }
focus(): void { focus(): void {
// focus Webview and it's contents when Window regain focus. // Focus Webview and it's contents when Window regain focus.
const webContents = this.$el.getWebContents(); const webContents = this.$el.getWebContents();
// HACK: webContents.isFocused() seems to be true even without the element // HACK: webContents.isFocused() seems to be true even without the element
// being in focus. So, we check against `document.activeElement`. // being in focus. So, we check against `document.activeElement`.
@@ -238,16 +244,16 @@ class WebView extends BaseComponent {
} }
zoomActualSize(): void { zoomActualSize(): void {
this.zoomFactor = 1.0; this.zoomFactor = 1;
this.$el.setZoomFactor(this.zoomFactor); this.$el.setZoomFactor(this.zoomFactor);
} }
logOut(): void { logOut(): void {
this.$el.executeJavaScript('logout()'); ipcRenderer.sendTo(this.$el.getWebContentsId(), 'logout');
} }
showShortcut(): void { showShortcut(): void {
this.$el.executeJavaScript('shortcut()'); ipcRenderer.sendTo(this.$el.getWebContentsId(), 'shortcut');
} }
openDevTools(): void { openDevTools(): void {
@@ -289,9 +295,8 @@ class WebView extends BaseComponent {
this.init(); this.init();
} }
send(channel: string, ...param: any[]): void { async send(channel: string, ...parameters: unknown[]): Promise<void> {
this.$el.send(channel, ...param); await this.domReady;
await this.$el.send(channel, ...parameters);
} }
} }
export = WebView;

View File

@@ -1,14 +1,13 @@
import { ipcRenderer } from 'electron'; import {ipcRenderer} from 'electron';
import events = require('events'); import {EventEmitter} from 'events';
import {ClipboardDecrypterImpl} from './clipboard-decrypter';
import {NotificationData, newNotification} from './notification';
type ListenerType = ((...args: any[]) => void); type ListenerType = ((...args: any[]) => void);
// we have and will have some non camelcase stuff class ElectronBridgeImpl extends EventEmitter implements ElectronBridge {
// while working with zulip so just turning the rule off
// for the whole file.
/* eslint-disable @typescript-eslint/camelcase */
class ElectronBridge extends events {
send_notification_reply_message_supported: boolean; send_notification_reply_message_supported: boolean;
idle_on_system: boolean; idle_on_system: boolean;
last_active_on_system: number; last_active_on_system: number;
@@ -23,16 +22,37 @@ class ElectronBridge extends events {
this.last_active_on_system = Date.now(); this.last_active_on_system = Date.now();
} }
send_event(eventName: string | symbol, ...args: any[]): void { send_event = (eventName: string | symbol, ...args: unknown[]): void => {
this.emit(eventName, ...args); this.emit(eventName, ...args);
} };
on_event(eventName: string, listener: ListenerType): void { on_event = (eventName: string, listener: ListenerType): void => {
this.on(eventName, listener); this.on(eventName, listener);
} };
new_notification = (
title: string,
options: NotificationOptions | undefined,
dispatch: (type: string, eventInit: EventInit) => boolean
): NotificationData =>
newNotification(title, options, dispatch);
get_idle_on_system = (): boolean => this.idle_on_system;
get_last_active_on_system = (): number => this.last_active_on_system;
get_send_notification_reply_message_supported = (): boolean =>
this.send_notification_reply_message_supported;
set_send_notification_reply_message_supported = (value: boolean): void => {
this.send_notification_reply_message_supported = value;
};
decrypt_clipboard = (version: number): ClipboardDecrypterImpl =>
new ClipboardDecrypterImpl(version);
} }
const electron_bridge = new ElectronBridge(); const electron_bridge = new ElectronBridgeImpl();
electron_bridge.on('total_unread_count', (...args) => { electron_bridge.on('total_unread_count', (...args) => {
ipcRenderer.send('unread-count', ...args); ipcRenderer.send('unread-count', ...args);
@@ -43,17 +63,19 @@ electron_bridge.on('realm_name', realmName => {
ipcRenderer.send('realm-name-changed', serverURL, realmName); ipcRenderer.send('realm-name-changed', serverURL, realmName);
}); });
electron_bridge.on('realm_icon_url', iconURL => { electron_bridge.on('realm_icon_url', (iconURL: unknown) => {
if (typeof iconURL !== 'string') {
throw new TypeError('Expected string for iconURL');
}
const serverURL = location.origin; const serverURL = location.origin;
iconURL = iconURL.includes('http') ? iconURL : `${serverURL}${iconURL}`; iconURL = iconURL.includes('http') ? iconURL : `${serverURL}${iconURL}`;
ipcRenderer.send('realm-icon-changed', serverURL, iconURL); ipcRenderer.send('realm-icon-changed', serverURL, iconURL);
}); });
// this follows node's idiomatic implementation of event // This follows node's idiomatic implementation of event
// emitters to make event handling more simpler instead of using // emitters to make event handling more simpler instead of using
// functions zulip side will emit event using ElectronBrigde.send_event // 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 // which is alias of .emit and on this side we can handle the data by adding
// a listener for the event. // a listener for the event.
export = electron_bridge; export default electron_bridge;
/* eslint-enable @typescript-eslint/camelcase */

View File

@@ -1,19 +1,17 @@
import { remote } from 'electron'; import {remote} from 'electron';
import SendFeedback from '@electron-elements/send-feedback'; import SendFeedback from '@electron-elements/send-feedback';
import path = require('path'); import path from 'path';
import fs = require('fs'); import fs from 'fs';
const { app } = remote; const {app} = remote;
interface SendFeedback extends HTMLElement { customElements.define('send-feedback', SendFeedback);
[key: string]: any; export const sendFeedback: SendFeedback = document.querySelector('send-feedback');
} export const feedbackHolder = sendFeedback.parentElement;
type SendFeedbackType = SendFeedback; // Make the button color match zulip app's theme
sendFeedback.customStyles = `
// make the button color match zulip app's theme
SendFeedback.customStyles = `
button:hover, button:focus { button:hover, button:focus {
border-color: #4EBFAC; border-color: #4EBFAC;
color: #4EBFAC; color: #4EBFAC;
@@ -30,16 +28,26 @@ button {
} }
`; `;
customElements.define('send-feedback', SendFeedback); /* eslint-disable no-multi-str */
export const sendFeedback: SendFeedbackType = document.querySelector('send-feedback');
export const feedbackHolder = sendFeedback.parentElement;
// customize the fields of custom elements // customize the fields of custom elements
sendFeedback.title = 'Report Issue'; sendFeedback.title = 'Report Issue';
sendFeedback.titleLabel = 'Issue title:'; sendFeedback.titleLabel = 'Issue title:';
sendFeedback.titlePlaceholder = 'Enter issue title'; sendFeedback.titlePlaceholder = 'Enter issue title';
sendFeedback.textareaLabel = 'Describe the issue:'; sendFeedback.textareaLabel = 'Describe the issue:';
sendFeedback.textareaPlaceholder = 'Succinctly describe your issue and steps to reproduce it...'; sendFeedback.textareaPlaceholder = 'Succinctly describe your issue and steps to reproduce it...\n\n\
---\n\
<!-- Please Include: -->\n\
- **Operating System**:\n\
- [ ] Windows\n\
- [ ] Linux/Ubuntu\n\
- [ ] macOS\n\
- **Clear steps to reproduce the issue**:\n\
- **Relevant error messages and/or screenshots**:\n\
';
/* eslint-enable no-multi-str */
sendFeedback.buttonLabel = 'Report Issue'; sendFeedback.buttonLabel = 'Report Issue';
sendFeedback.loaderSuccessText = ''; sendFeedback.loaderSuccessText = '';
@@ -47,10 +55,10 @@ sendFeedback.useReporter('emailReporter', {
email: 'akash@zulipchat.com' email: 'akash@zulipchat.com'
}); });
feedbackHolder.addEventListener('click', (e: Event) => { feedbackHolder.addEventListener('click', (event: Event) => {
// only remove the class if the grey out faded // Only remove the class if the grey out faded
// part is clicked and not the feedback element itself // part is clicked and not the feedback element itself
if (e.target === e.currentTarget) { if (event.target === event.currentTarget) {
feedbackHolder.classList.remove('show'); feedbackHolder.classList.remove('show');
} }
}); });

135
app/renderer/js/injected.ts Normal file
View File

@@ -0,0 +1,135 @@
'use strict';
interface CompatElectronBridge extends ElectronBridge {
readonly idle_on_system: boolean;
readonly last_active_on_system: number;
send_notification_reply_message_supported: boolean;
}
(() => {
const zulipWindow = window as typeof window & {
electron_bridge: CompatElectronBridge;
narrow: {
by_subject?: (target_id: number, opts: {trigger?: string}) => void;
by_topic?: (target_id: number, opts: {trigger?: string}) => void;
};
page_params?: {
default_language?: string;
};
raw_electron_bridge: ElectronBridge;
};
const electron_bridge: CompatElectronBridge = {
...zulipWindow.raw_electron_bridge,
get idle_on_system(): boolean {
return this.get_idle_on_system();
},
get last_active_on_system(): number {
return this.get_last_active_on_system();
},
get send_notification_reply_message_supported(): boolean {
return this.get_send_notification_reply_message_supported();
},
set send_notification_reply_message_supported(value: boolean) {
this.set_send_notification_reply_message_supported(value);
}
};
zulipWindow.electron_bridge = electron_bridge;
(async () => {
if (document.readyState === 'loading') {
await new Promise(resolve => {
document.addEventListener('DOMContentLoaded', () => {
resolve();
});
});
}
const {page_params} = zulipWindow;
if (page_params) {
electron_bridge.send_event('zulip-loaded', {
serverLanguage: page_params.default_language
});
}
})();
electron_bridge.on_event('narrow-by-topic', (id: number) => {
const {narrow} = zulipWindow;
const narrowByTopic = narrow.by_topic || narrow.by_subject;
narrowByTopic(id, {trigger: 'notification'});
});
function attributeListener<T extends EventTarget>(type: string): PropertyDescriptor {
const symbol = Symbol('on' + type);
function listener(this: T, ev: Event): void {
if ((this as any)[symbol].call(this, ev) === false) {
ev.preventDefault();
}
}
return {
configurable: true,
enumerable: true,
get(this: T) {
return (this as any)[symbol];
},
set(this: T, value: unknown) {
if (typeof value === 'function') {
if (!(symbol in this)) {
this.addEventListener(type, listener);
}
(this as any)[symbol] = value;
} else if (symbol in this) {
this.removeEventListener(type, listener);
delete (this as any)[symbol];
}
}
};
}
const NativeNotification = Notification;
class InjectedNotification extends EventTarget {
constructor(title: string, options?: NotificationOptions) {
super();
Object.assign(
this,
electron_bridge.new_notification(title, options, (type: string, eventInit: EventInit) =>
this.dispatchEvent(new Event(type, eventInit))
)
);
}
static get maxActions(): number {
return NativeNotification.maxActions;
}
static get permission(): NotificationPermission {
return NativeNotification.permission;
}
static async requestPermission(callback?: NotificationPermissionCallback): Promise<NotificationPermission> {
if (callback) {
callback(await Promise.resolve(NativeNotification.permission));
}
return NativeNotification.permission;
}
}
Object.defineProperties(InjectedNotification.prototype, {
onclick: attributeListener('click'),
onclose: attributeListener('close'),
onerror: attributeListener('error'),
onshow: attributeListener('show')
});
window.Notification = InjectedNotification as any;
})();

View File

@@ -1,27 +1,27 @@
'use strict'; import {ipcRenderer, remote, clipboard} from 'electron';
import {feedbackHolder} from './feedback';
import { ipcRenderer, remote, clipboard, shell } from 'electron'; import path from 'path';
import { feedbackHolder } from './feedback'; import escape from 'escape-html';
import isDev from 'electron-is-dev';
import path = require('path'); const {session, app, Menu, dialog} = remote;
import escape = require('escape-html');
import isDev = require('electron-is-dev');
const { session, app, Menu, dialog } = remote;
// eslint-disable-next-line import/no-unassigned-import // eslint-disable-next-line import/no-unassigned-import
require('./tray'); import './tray';
import DomainUtil = require('./utils/domain-util'); import * as DomainUtil from './utils/domain-util';
import WebView = require('./components/webview'); import WebView from './components/webview';
import ServerTab = require('./components/server-tab'); import ServerTab from './components/server-tab';
import FunctionalTab = require('./components/functional-tab'); import FunctionalTab from './components/functional-tab';
import ConfigUtil = require('./utils/config-util'); import * as ConfigUtil from './utils/config-util';
import DNDUtil = require('./utils/dnd-util'); import * as DNDUtil from './utils/dnd-util';
import ReconnectUtil = require('./utils/reconnect-util'); import ReconnectUtil from './utils/reconnect-util';
import Logger = require('./utils/logger-util'); import Logger from './utils/logger-util';
import CommonUtil = require('./utils/common-util'); import * as CommonUtil from './utils/common-util';
import EnterpriseUtil = require('./utils/enterprise-util'); import * as EnterpriseUtil from './utils/enterprise-util';
import Messages = require('./../../resources/messages'); import * as LinkUtil from './utils/link-util';
import * as Messages from '../../resources/messages';
import type {DNDSettings} from './utils/dnd-util';
interface FunctionalTabProps { interface FunctionalTabProps {
name: string; name: string;
@@ -29,11 +29,7 @@ interface FunctionalTabProps {
url: string; url: string;
} }
interface AnyObject { interface SettingsOptions extends DNDSettings {
[key: string]: any;
}
interface SettingsOptions {
autoHideMenubar: boolean; autoHideMenubar: boolean;
trayIcon: boolean; trayIcon: boolean;
useManualProxy: boolean; useManualProxy: boolean;
@@ -43,25 +39,17 @@ interface SettingsOptions {
startAtLogin: boolean; startAtLogin: boolean;
startMinimized: boolean; startMinimized: boolean;
enableSpellchecker: boolean; enableSpellchecker: boolean;
showNotification: boolean;
autoUpdate: boolean; autoUpdate: boolean;
betaUpdate: boolean; betaUpdate: boolean;
errorReporting: boolean; errorReporting: boolean;
customCSS: boolean; customCSS: boolean;
silent: boolean;
lastActiveTab: number; lastActiveTab: number;
dnd: boolean; dnd: boolean;
dndPreviousSettings: { dndPreviousSettings: DNDSettings;
showNotification: boolean;
silent: boolean;
flashTaskbarOnMessage?: boolean;
};
downloadsPath: string; downloadsPath: string;
showDownloadFolder: boolean;
quitOnClose: boolean; quitOnClose: boolean;
flashTaskbarOnMessage?: boolean; promptDownload: boolean;
dockBouncing?: boolean; dockBouncing?: boolean;
loading?: AnyObject;
} }
const logger = new Logger({ const logger = new Logger({
@@ -70,7 +58,7 @@ const logger = new Logger({
}); });
const rendererDirectory = path.resolve(__dirname, '..'); const rendererDirectory = path.resolve(__dirname, '..');
type ServerOrFunctionalTab = ServerTab | FunctionalTab; export type ServerOrFunctionalTab = ServerTab | FunctionalTab;
class ServerManagerView { class ServerManagerView {
$addServerButton: HTMLButtonElement; $addServerButton: HTMLButtonElement;
@@ -91,10 +79,10 @@ class ServerManagerView {
$sidebar: Element; $sidebar: Element;
$fullscreenPopup: Element; $fullscreenPopup: Element;
$fullscreenEscapeKey: string; $fullscreenEscapeKey: string;
loading: AnyObject; loading: Set<string>;
activeTabIndex: number; activeTabIndex: number;
tabs: ServerOrFunctionalTab[]; tabs: ServerOrFunctionalTab[];
functionalTabs: AnyObject; functionalTabs: Map<string, number>;
tabIndex: number; tabIndex: number;
presetOrgs: string[]; presetOrgs: string[];
constructor() { constructor() {
@@ -129,54 +117,54 @@ class ServerManagerView {
this.$fullscreenEscapeKey = process.platform === 'darwin' ? '^⌘F' : 'F11'; this.$fullscreenEscapeKey = process.platform === 'darwin' ? '^⌘F' : 'F11';
this.$fullscreenPopup.innerHTML = `Press ${this.$fullscreenEscapeKey} to exit full screen`; this.$fullscreenPopup.innerHTML = `Press ${this.$fullscreenEscapeKey} to exit full screen`;
this.loading = {}; this.loading = new Set();
this.activeTabIndex = -1; this.activeTabIndex = -1;
this.tabs = []; this.tabs = [];
this.presetOrgs = []; this.presetOrgs = [];
this.functionalTabs = {}; this.functionalTabs = new Map();
this.tabIndex = 0; this.tabIndex = 0;
} }
init(): void { async init(): Promise<void> {
this.loadProxy().then(() => { await this.loadProxy();
this.initDefaultSettings(); this.initDefaultSettings();
this.initSidebar(); this.initSidebar();
if (EnterpriseUtil.configFile) { this.removeUAfromDisk();
this.initPresetOrgs(); if (EnterpriseUtil.hasConfigFile()) {
} await this.initPresetOrgs();
this.initTabs(); }
this.initActions();
this.registerIpcs(); await this.initTabs();
}); this.initActions();
this.registerIpcs();
} }
loadProxy(): Promise<boolean> { async loadProxy(): Promise<void> {
return new Promise(resolve => { // To change proxyEnable to useManualProxy in older versions
// To change proxyEnable to useManualProxy in older versions const proxyEnabledOld = ConfigUtil.isConfigItemExists('useProxy');
const proxyEnabledOld = ConfigUtil.isConfigItemExists('useProxy'); if (proxyEnabledOld) {
if (proxyEnabledOld) { const proxyEnableOldState = ConfigUtil.getConfigItem('useProxy');
const proxyEnableOldState = ConfigUtil.getConfigItem('useProxy'); if (proxyEnableOldState) {
if (proxyEnableOldState) { ConfigUtil.setConfigItem('useManualProxy', true);
ConfigUtil.setConfigItem('useManualProxy', true);
}
ConfigUtil.removeConfigItem('useProxy');
} }
const proxyEnabled = ConfigUtil.getConfigItem('useManualProxy') || ConfigUtil.getConfigItem('useSystemProxy'); ConfigUtil.removeConfigItem('useProxy');
if (proxyEnabled) { }
session.fromPartition('persist:webviewsession').setProxy({
pacScript: ConfigUtil.getConfigItem('proxyPAC', ''), const proxyEnabled = ConfigUtil.getConfigItem('useManualProxy') || ConfigUtil.getConfigItem('useSystemProxy');
proxyRules: ConfigUtil.getConfigItem('proxyRules', ''), if (proxyEnabled) {
proxyBypassRules: ConfigUtil.getConfigItem('proxyBypass', '') await session.fromPartition('persist:webviewsession').setProxy({
}, resolve); pacScript: ConfigUtil.getConfigItem('proxyPAC', ''),
} else { proxyRules: ConfigUtil.getConfigItem('proxyRules', ''),
session.fromPartition('persist:webviewsession').setProxy({ proxyBypassRules: ConfigUtil.getConfigItem('proxyBypass', '')
pacScript: '', });
proxyRules: '', } else {
proxyBypassRules: '' await session.fromPartition('persist:webviewsession').setProxy({
}, resolve); pacScript: '',
} proxyRules: '',
}); proxyBypassRules: ''
});
}
} }
// Settings are initialized only when user clicks on General/Server/Network section settings // Settings are initialized only when user clicks on General/Server/Network section settings
@@ -207,8 +195,8 @@ class ServerManagerView {
silent: false silent: false
}, },
downloadsPath: `${app.getPath('downloads')}`, downloadsPath: `${app.getPath('downloads')}`,
showDownloadFolder: false, quitOnClose: false,
quitOnClose: false promptDownload: false
}; };
// Platform specific settings // Platform specific settings
@@ -228,13 +216,12 @@ class ServerManagerView {
settingOptions.autoHideMenubar = false; settingOptions.autoHideMenubar = false;
} }
for (const i in settingOptions) { for (const [setting, value] of Object.entries(settingOptions)) {
const setting = i as keyof SettingsOptions; // Give preference to defaults defined in global_config.json
// give preference to defaults defined in global_config.json
if (EnterpriseUtil.configItemExists(setting)) { if (EnterpriseUtil.configItemExists(setting)) {
ConfigUtil.setConfigItem(setting, EnterpriseUtil.getConfigItem(setting), true); ConfigUtil.setConfigItem(setting, EnterpriseUtil.getConfigItem(setting), true);
} else if (ConfigUtil.getConfigItem(setting) === null) { } else if (ConfigUtil.getConfigItem(setting) === null) {
ConfigUtil.setConfigItem(setting, settingOptions[setting]); ConfigUtil.setConfigItem(setting, value);
} }
} }
} }
@@ -244,110 +231,122 @@ class ServerManagerView {
this.toggleSidebar(showSidebar); this.toggleSidebar(showSidebar);
} }
async queueDomain(domain: any): Promise<boolean> { // Remove the stale UA string from the disk if the app is not freshly
// allows us to start adding multiple domains to the app simultaneously // installed. This should be removed in a further release.
removeUAfromDisk(): void {
ConfigUtil.removeConfigItem('userAgent');
}
async queueDomain(domain: string): Promise<boolean> {
// Allows us to start adding multiple domains to the app simultaneously
// promise of addition resolves in both cases, but we consider it rejected // promise of addition resolves in both cases, but we consider it rejected
// if the resolved value is false // if the resolved value is false
try { try {
const serverConf = await DomainUtil.checkDomain(domain); const serverConf = await DomainUtil.checkDomain(domain);
await DomainUtil.addDomain(serverConf); await DomainUtil.addDomain(serverConf);
return true; return true;
} catch (err) { } catch (error) {
logger.error(err); logger.error(error);
logger.error('Could not add ' + domain + '. Please contact your system administrator.'); logger.error(`Could not add ${domain}. Please contact your system administrator.`);
return false; return false;
} }
} }
async initPresetOrgs(): Promise<void> { async initPresetOrgs(): Promise<void> {
// read preset organizations from global_config.json and queues them // Read preset organizations from global_config.json and queues them
// for addition to the app's domains // for addition to the app's domains
const preAddedDomains = DomainUtil.getDomains(); const preAddedDomains = DomainUtil.getDomains();
this.presetOrgs = EnterpriseUtil.getConfigItem('presetOrganizations', []); this.presetOrgs = EnterpriseUtil.getConfigItem('presetOrganizations', []);
// set to true if at least one new domain is added // Set to true if at least one new domain is added
const domainPromises = []; const domainPromises = [];
for (const url of this.presetOrgs) { for (const url of this.presetOrgs) {
if (DomainUtil.duplicateDomain(url)) { if (DomainUtil.duplicateDomain(url)) {
continue; continue;
} }
domainPromises.push(this.queueDomain(url)); domainPromises.push(this.queueDomain(url));
} }
const domainsAdded = await Promise.all(domainPromises); const domainsAdded = await Promise.all(domainPromises);
if (domainsAdded.includes(true)) { if (domainsAdded.includes(true)) {
// at least one domain was resolved // At least one domain was resolved
if (preAddedDomains.length > 0) { if (preAddedDomains.length > 0) {
// user already has servers added // User already has servers added
// ask them before reloading the app // ask them before reloading the app
dialog.showMessageBox({ const {response} = await dialog.showMessageBox({
type: 'question', type: 'question',
buttons: ['Yes', 'Later'], buttons: ['Yes', 'Later'],
defaultId: 0, defaultId: 0,
message: 'New server' + (domainsAdded.length > 1 ? 's' : '') + ' added. Reload app now?' message: 'New server' + (domainsAdded.length > 1 ? 's' : '') + ' added. Reload app now?'
}, response => {
if (response === 0) {
ipcRenderer.send('reload-full-app');
}
}); });
if (response === 0) {
ipcRenderer.send('reload-full-app');
}
} else { } else {
ipcRenderer.send('reload-full-app'); ipcRenderer.send('reload-full-app');
} }
} else if (domainsAdded.length > 0) { } else if (domainsAdded.length > 0) {
// find all orgs that failed // Find all orgs that failed
const failedDomains: string[] = []; const failedDomains: string[] = [];
for (const org of this.presetOrgs) { for (const org of this.presetOrgs) {
if (DomainUtil.duplicateDomain(org)) { if (DomainUtil.duplicateDomain(org)) {
continue; continue;
} }
failedDomains.push(org); failedDomains.push(org);
} }
const { title, content } = Messages.enterpriseOrgError(domainsAdded.length, failedDomains);
const {title, content} = Messages.enterpriseOrgError(domainsAdded.length, failedDomains);
dialog.showErrorBox(title, content); dialog.showErrorBox(title, content);
if (DomainUtil.getDomains().length === 0) { if (DomainUtil.getDomains().length === 0) {
// no orgs present, stop showing loading gif // No orgs present, stop showing loading gif
this.openSettings('AddServer'); await this.openSettings('AddServer');
} }
} }
} }
initTabs(): void { async initTabs(): Promise<void> {
const servers = DomainUtil.getDomains(); const servers = DomainUtil.getDomains();
if (servers.length > 0) { if (servers.length > 0) {
for (let i = 0; i < servers.length; i++) { for (const [i, server] of servers.entries()) {
this.initServer(servers[i], i); this.initServer(server, i);
} }
// Open last active tab // Open last active tab
let lastActiveTab = ConfigUtil.getConfigItem('lastActiveTab'); let lastActiveTab = ConfigUtil.getConfigItem('lastActiveTab');
if (lastActiveTab >= servers.length) { if (lastActiveTab >= servers.length) {
lastActiveTab = 0; lastActiveTab = 0;
} }
// checkDomain() and webview.load() for lastActiveTab before the others
DomainUtil.updateSavedServer(servers[lastActiveTab].url, lastActiveTab); // `checkDomain()` and `webview.load()` for lastActiveTab before the others
await DomainUtil.updateSavedServer(servers[lastActiveTab].url, lastActiveTab);
this.activateTab(lastActiveTab); this.activateTab(lastActiveTab);
for (let i = 0; i < servers.length; i++) { await Promise.all(servers.map(async (server, i) => {
// after the lastActiveTab is activated, we load the others in the background // After the lastActiveTab is activated, we load the others in the background
// without activating them, to prevent flashing of server icons // without activating them, to prevent flashing of server icons
if (i === lastActiveTab) { if (i === lastActiveTab) {
continue; return;
} }
DomainUtil.updateSavedServer(servers[i].url, i);
await DomainUtil.updateSavedServer(server.url, i);
this.tabs[i].webview.load(); this.tabs[i].webview.load();
} }));
// Remove focus from the settings icon at sidebar bottom // Remove focus from the settings icon at sidebar bottom
this.$settingsButton.classList.remove('active'); this.$settingsButton.classList.remove('active');
} else if (this.presetOrgs.length === 0) { } else if (this.presetOrgs.length === 0) {
// not attempting to add organisations in the background // Not attempting to add organisations in the background
this.openSettings('AddServer'); await this.openSettings('AddServer');
} else { } else {
this.showLoading(true); this.showLoading(true);
} }
} }
initServer(server: any, index: number): void { initServer(server: DomainUtil.ServerConf, index: number): void {
const tabIndex = this.getTabIndex(); const tabIndex = this.getTabIndex();
this.tabs.push(new ServerTab({ this.tabs.push(new ServerTab({
role: 'server', role: 'server',
icon: server.icon, icon: server.icon,
name: server.alias, name: CommonUtil.decodeString(server.alias),
$root: this.$tabsContainer, $root: this.$tabsContainer,
onClick: this.activateLastTab.bind(this, index), onClick: this.activateLastTab.bind(this, index),
index, index,
@@ -361,16 +360,20 @@ class ServerManagerView {
url: server.url, url: server.url,
role: 'server', role: 'server',
name: CommonUtil.decodeString(server.alias), name: CommonUtil.decodeString(server.alias),
ignoreCerts: server.ignoreCerts,
hasPermission: (origin: string, permission: string) =>
origin === server.url && permission === 'notifications',
isActive: () => { isActive: () => {
return index === this.activeTabIndex; return index === this.activeTabIndex;
}, },
switchLoading: (loading: boolean, url: string) => { switchLoading: (loading: boolean, url: string) => {
if (!loading && this.loading[url]) { if (loading) {
this.loading[url] = false; this.loading.add(url);
} else if (loading && !this.loading[url]) { } else {
this.loading[url] = true; this.loading.delete(url);
} }
this.showLoading(this.loading[this.tabs[this.activeTabIndex].webview.props.url]);
this.showLoading(this.loading.has(this.tabs[this.activeTabIndex].webview.props.url));
}, },
onNetworkError: (index: number) => this.openNetworkTroubleshooting(index), onNetworkError: (index: number) => this.openNetworkTroubleshooting(index),
onTitleChange: this.updateBadge.bind(this), onTitleChange: this.updateBadge.bind(this),
@@ -378,7 +381,7 @@ class ServerManagerView {
preload: true preload: true
}) })
})); }));
this.loading[server.url] = true; this.loading.add(server.url);
} }
initActions(): void { initActions(): void {
@@ -394,6 +397,7 @@ class ServerManagerView {
if ($serverImg.src.includes('img/icon.png')) { if ($serverImg.src.includes('img/icon.png')) {
this.displayInitialCharLogo($serverImg, index); this.displayInitialCharLogo($serverImg, index);
} }
$serverImg.addEventListener('error', () => { $serverImg.addEventListener('error', () => {
this.displayInitialCharLogo($serverImg, index); this.displayInitialCharLogo($serverImg, index);
}); });
@@ -408,11 +412,11 @@ class ServerManagerView {
this.$reloadButton.addEventListener('click', () => { this.$reloadButton.addEventListener('click', () => {
this.tabs[this.activeTabIndex].webview.reload(); this.tabs[this.activeTabIndex].webview.reload();
}); });
this.$addServerButton.addEventListener('click', () => { this.$addServerButton.addEventListener('click', async () => {
this.openSettings('AddServer'); await this.openSettings('AddServer');
}); });
this.$settingsButton.addEventListener('click', () => { this.$settingsButton.addEventListener('click', async () => {
this.openSettings('General'); await this.openSettings('General');
}); });
this.$backButton.addEventListener('click', () => { this.$backButton.addEventListener('click', () => {
this.tabs[this.activeTabIndex].webview.back(); this.tabs[this.activeTabIndex].webview.back();
@@ -442,10 +446,9 @@ class ServerManagerView {
} }
displayInitialCharLogo($img: HTMLImageElement, index: number): void { displayInitialCharLogo($img: HTMLImageElement, index: number): void {
/* // The index parameter is needed because webview[data-tab-id] can
index parameter needed because webview[data-tab-id] can increment // increment beyond the size of the sidebar org array and throw an
beyond size of sidebar org array and throw error // error
*/
const $altIcon = document.createElement('div'); const $altIcon = document.createElement('div');
const $parent = $img.parentElement; const $parent = $img.parentElement;
@@ -463,7 +466,7 @@ class ServerManagerView {
$altIcon.classList.add('server-icon'); $altIcon.classList.add('server-icon');
$altIcon.classList.add('alt-icon'); $altIcon.classList.add('alt-icon');
$parent.removeChild($img); $img.remove();
$parent.append($altIcon); $parent.append($altIcon);
this.addContextMenu($altIcon as HTMLImageElement, index); this.addContextMenu($altIcon as HTMLImageElement, index);
@@ -477,8 +480,8 @@ class ServerManagerView {
// as that of its parent element. // as that of its parent element.
// This needs to handled only for the add server tooltip and not others. // This needs to handled only for the add server tooltip and not others.
if (addServer) { if (addServer) {
const { top } = SidebarButton.getBoundingClientRect(); const {top} = SidebarButton.getBoundingClientRect();
SidebarTooltip.style.top = top + 'px'; SidebarTooltip.style.top = `${top}px`;
} }
}); });
SidebarButton.addEventListener('mouseout', () => { SidebarButton.addEventListener('mouseout', () => {
@@ -487,14 +490,14 @@ class ServerManagerView {
} }
onHover(index: number): void { onHover(index: number): void {
// this.$serverIconTooltip[index].innerHTML already has realm name, so we are just // `this.$serverIconTooltip[index].innerHTML` already has realm name, so we are just
// removing the style. // removing the style.
this.$serverIconTooltip[index].removeAttribute('style'); this.$serverIconTooltip[index].removeAttribute('style');
// To handle position of servers' tooltip due to scrolling of list of organizations // To handle position of servers' tooltip due to scrolling of list of organizations
// This could not be handled using CSS, hence the top of the tooltip is made same // This could not be handled using CSS, hence the top of the tooltip is made same
// as that of its parent element. // as that of its parent element.
const { top } = this.$serverIconTooltip[index].parentElement.getBoundingClientRect(); const {top} = this.$serverIconTooltip[index].parentElement.getBoundingClientRect();
this.$serverIconTooltip[index].style.top = top + 'px'; this.$serverIconTooltip[index].style.top = `${top}px`;
} }
onHoverOut(index: number): void { onHoverOut(index: number): void {
@@ -502,12 +505,12 @@ class ServerManagerView {
} }
openFunctionalTab(tabProps: FunctionalTabProps): void { openFunctionalTab(tabProps: FunctionalTabProps): void {
if (this.functionalTabs[tabProps.name] !== undefined) { if (this.functionalTabs.has(tabProps.name)) {
this.activateTab(this.functionalTabs[tabProps.name]); this.activateTab(this.functionalTabs.get(tabProps.name));
return; return;
} }
this.functionalTabs[tabProps.name] = this.tabs.length; this.functionalTabs.set(tabProps.name, this.tabs.length);
const tabIndex = this.getTabIndex(); const tabIndex = this.getTabIndex();
@@ -516,27 +519,28 @@ class ServerManagerView {
materialIcon: tabProps.materialIcon, materialIcon: tabProps.materialIcon,
name: tabProps.name, name: tabProps.name,
$root: this.$tabsContainer, $root: this.$tabsContainer,
index: this.functionalTabs[tabProps.name], index: this.functionalTabs.get(tabProps.name),
tabIndex, tabIndex,
onClick: this.activateTab.bind(this, this.functionalTabs[tabProps.name]), onClick: this.activateTab.bind(this, this.functionalTabs.get(tabProps.name)),
onDestroy: this.destroyTab.bind(this, tabProps.name, this.functionalTabs[tabProps.name]), onDestroy: this.destroyTab.bind(this, tabProps.name, this.functionalTabs.get(tabProps.name)),
webview: new WebView({ webview: new WebView({
$root: this.$webviewsContainer, $root: this.$webviewsContainer,
index: this.functionalTabs[tabProps.name], index: this.functionalTabs.get(tabProps.name),
tabIndex, tabIndex,
url: tabProps.url, url: tabProps.url,
role: 'function', role: 'function',
name: tabProps.name, name: tabProps.name,
isActive: () => { isActive: () => {
return this.functionalTabs[tabProps.name] === this.activeTabIndex; return this.functionalTabs.get(tabProps.name) === this.activeTabIndex;
}, },
switchLoading: (loading: AnyObject, url: string) => { switchLoading: (loading: boolean, url: string) => {
if (!loading && this.loading[url]) { if (loading) {
this.loading[url] = false; this.loading.add(url);
} else if (loading && !this.loading[url]) { } else {
this.loading[url] = true; this.loading.delete(url);
} }
this.showLoading(this.loading[this.tabs[this.activeTabIndex].webview.props.url]);
this.showLoading(this.loading.has(this.tabs[this.activeTabIndex].webview.props.url));
}, },
onNetworkError: (index: number) => this.openNetworkTroubleshooting(index), onNetworkError: (index: number) => this.openNetworkTroubleshooting(index),
onTitleChange: this.updateBadge.bind(this), onTitleChange: this.updateBadge.bind(this),
@@ -549,17 +553,17 @@ class ServerManagerView {
// closed when the functional tab DOM is ready, handled in webview.js // closed when the functional tab DOM is ready, handled in webview.js
this.$webviewsContainer.classList.remove('loaded'); this.$webviewsContainer.classList.remove('loaded');
this.activateTab(this.functionalTabs[tabProps.name]); this.activateTab(this.functionalTabs.get(tabProps.name));
} }
openSettings(nav = 'General'): void { async openSettings(nav = 'General'): Promise<void> {
this.openFunctionalTab({ this.openFunctionalTab({
name: 'Settings', name: 'Settings',
materialIcon: 'settings', materialIcon: 'settings',
url: `file://${rendererDirectory}/preference.html#${nav}` url: `file://${rendererDirectory}/preference.html#${nav}`
}); });
this.$settingsButton.classList.add('active'); this.$settingsButton.classList.add('active');
this.tabs[this.functionalTabs.Settings].webview.send('switch-settings-nav', nav); await this.tabs[this.functionalTabs.get('Settings')].webview.send('switch-settings-nav', nav);
} }
openAbout(): void { openAbout(): void {
@@ -584,7 +588,7 @@ class ServerManagerView {
ipcRenderer.send('save-last-tab', index); ipcRenderer.send('save-last-tab', index);
} }
// returns this.tabs in an way that does // Returns this.tabs in an way that does
// not crash app when this.tabs is passed into // not crash app when this.tabs is passed into
// ipcRenderer. Something about webview, and props.webview // ipcRenderer. Something about webview, and props.webview
// properties in ServerTab causes the app to crash. // properties in ServerTab causes the app to crash.
@@ -594,7 +598,7 @@ class ServerManagerView {
const proto = Object.create(Object.getPrototypeOf(tab)); const proto = Object.create(Object.getPrototypeOf(tab));
const tabClone = Object.assign(proto, tab); const tabClone = Object.assign(proto, tab);
tabClone.webview = { props: {} }; tabClone.webview = {props: {}};
tabClone.webview.props.name = tab.webview.props.name; tabClone.webview.props.name = tab.webview.props.name;
delete tabClone.props.webview; delete tabClone.props.webview;
tabs.push(tabClone); tabs.push(tabClone);
@@ -611,24 +615,27 @@ class ServerManagerView {
if (this.activeTabIndex !== -1) { if (this.activeTabIndex !== -1) {
if (this.activeTabIndex === index) { if (this.activeTabIndex === index) {
return; return;
} else if (hideOldTab) { }
if (hideOldTab) {
// If old tab is functional tab Settings, remove focus from the settings icon at sidebar bottom // If old tab is functional tab Settings, remove focus from the settings icon at sidebar bottom
if (this.tabs[this.activeTabIndex].props.role === 'function' && this.tabs[this.activeTabIndex].props.name === 'Settings') { if (this.tabs[this.activeTabIndex].props.role === 'function' && this.tabs[this.activeTabIndex].props.name === 'Settings') {
this.$settingsButton.classList.remove('active'); this.$settingsButton.classList.remove('active');
} }
this.tabs[this.activeTabIndex].deactivate(); this.tabs[this.activeTabIndex].deactivate();
} }
} }
try { try {
this.tabs[index].webview.canGoBackButton(); this.tabs[index].webview.canGoBackButton();
} catch (err) { } catch (_) {
} }
this.activeTabIndex = index; this.activeTabIndex = index;
this.tabs[index].activate(); this.tabs[index].activate();
this.showLoading(this.loading[this.tabs[this.activeTabIndex].webview.props.url]); this.showLoading(this.loading.has(this.tabs[this.activeTabIndex].webview.props.url));
ipcRenderer.send('update-menu', { ipcRenderer.send('update-menu', {
// JSON stringify this.tabs to avoid a crash // JSON stringify this.tabs to avoid a crash
@@ -658,7 +665,7 @@ class ServerManagerView {
this.tabs[index].destroy(); this.tabs[index].destroy();
delete this.tabs[index]; delete this.tabs[index];
delete this.functionalTabs[name]; this.functionalTabs.delete(name);
// Issue #188: If the functional tab was not focused, do not activate another tab. // Issue #188: If the functional tab was not focused, do not activate another tab.
if (this.activeTabIndex === index) { if (this.activeTabIndex === index) {
@@ -673,21 +680,21 @@ class ServerManagerView {
// Clear global variables // Clear global variables
this.activeTabIndex = -1; this.activeTabIndex = -1;
this.tabs = []; this.tabs = [];
this.functionalTabs = {}; this.functionalTabs.clear();
// Clear DOM elements // Clear DOM elements
this.$tabsContainer.innerHTML = ''; this.$tabsContainer.innerHTML = '';
this.$webviewsContainer.innerHTML = ''; this.$webviewsContainer.innerHTML = '';
} }
reloadView(): void { async reloadView(): Promise<void> {
// Save and remember the index of last active tab so that we can use it later // Save and remember the index of last active tab so that we can use it later
const lastActiveTab = this.tabs[this.activeTabIndex].props.index; const lastActiveTab = this.tabs[this.activeTabIndex].props.index;
ConfigUtil.setConfigItem('lastActiveTab', lastActiveTab); ConfigUtil.setConfigItem('lastActiveTab', lastActiveTab);
// Destroy the current view and re-initiate it // Destroy the current view and re-initiate it
this.destroyView(); this.destroyView();
this.initTabs(); await this.initTabs();
this.initServerActions(); this.initServerActions();
} }
@@ -710,11 +717,9 @@ class ServerManagerView {
ipcRenderer.send('update-badge', messageCountAll); ipcRenderer.send('update-badge', messageCountAll);
} }
updateGeneralSettings(setting: string, value: any): void { updateGeneralSettings(setting: string, value: unknown): void {
const selector = 'webview:not([class*=disabled])'; if (this.getActiveWebview()) {
const webview: Electron.WebviewTag = document.querySelector(selector); const webContents = this.getActiveWebview().getWebContents();
if (webview) {
const webContents = webview.getWebContents();
webContents.send(setting, value); webContents.send(setting, value);
} }
} }
@@ -738,35 +743,40 @@ class ServerManagerView {
return !(url.endsWith('/login/') || this.tabs[tabIndex].webview.loading); return !(url.endsWith('/login/') || this.tabs[tabIndex].webview.loading);
} }
getActiveWebview(): Electron.WebviewTag {
const selector = 'webview:not(.disabled)';
const webview: Electron.WebviewTag = document.querySelector(selector);
return webview;
}
addContextMenu($serverImg: HTMLImageElement, index: number): void { addContextMenu($serverImg: HTMLImageElement, index: number): void {
$serverImg.addEventListener('contextmenu', e => { $serverImg.addEventListener('contextmenu', event => {
e.preventDefault(); event.preventDefault();
const template = [ const template = [
{ {
label: 'Disconnect organization', label: 'Disconnect organization',
click: () => { click: async () => {
dialog.showMessageBox({ const {response} = await dialog.showMessageBox({
type: 'warning', type: 'warning',
buttons: ['YES', 'NO'], buttons: ['YES', 'NO'],
defaultId: 0, defaultId: 0,
message: 'Are you sure you want to disconnect this organization?' message: 'Are you sure you want to disconnect this organization?'
}, response => {
if (response === 0) {
if (DomainUtil.removeDomain(index)) {
ipcRenderer.send('reload-full-app');
} else {
const { title, content } = Messages.orgRemovalError(DomainUtil.getDomain(index).url);
dialog.showErrorBox(title, content);
}
}
}); });
if (response === 0) {
if (DomainUtil.removeDomain(index)) {
ipcRenderer.send('reload-full-app');
} else {
const {title, content} = Messages.orgRemovalError(DomainUtil.getDomain(index).url);
dialog.showErrorBox(title, content);
}
}
} }
}, },
{ {
label: 'Notification settings', label: 'Notification settings',
enabled: this.isLoggedIn(index), enabled: this.isLoggedIn(index),
click: () => { click: () => {
// switch to tab whose icon was right-clicked // Switch to tab whose icon was right-clicked
this.activateTab(index); this.activateTab(index);
this.tabs[index].webview.showNotificationSettings(); this.tabs[index].webview.showNotificationSettings();
} }
@@ -779,47 +789,85 @@ class ServerManagerView {
} }
]; ];
const contextMenu = Menu.buildFromTemplate(template); const contextMenu = Menu.buildFromTemplate(template);
contextMenu.popup({ window: remote.getCurrentWindow() }); contextMenu.popup({window: remote.getCurrentWindow()});
}); });
} }
registerIpcs(): void { registerIpcs(): void {
const webviewListeners: AnyObject = { const webviewListeners: Array<[string, (webview: WebView) => void]> = [
'webview-reload': 'reload', ['webview-reload', webview => webview.reload()],
back: 'back', ['back', webview => webview.back()],
focus: 'focus', ['focus', webview => webview.focus()],
forward: 'forward', ['forward', webview => webview.forward()],
zoomIn: 'zoomIn', ['zoomIn', webview => webview.zoomIn()],
zoomOut: 'zoomOut', ['zoomOut', webview => webview.zoomOut()],
zoomActualSize: 'zoomActualSize', ['zoomActualSize', webview => webview.zoomActualSize()],
'log-out': 'logOut', ['log-out', webview => webview.logOut()],
shortcut: 'showShortcut', ['shortcut', webview => webview.showShortcut()],
'tab-devtools': 'openDevTools' ['tab-devtools', webview => webview.openDevTools()]
}; ];
for (const key in webviewListeners) { for (const [channel, listener] of webviewListeners) {
ipcRenderer.on(key, () => { ipcRenderer.on(channel, () => {
const activeWebview = this.tabs[this.activeTabIndex].webview; const activeWebview = this.tabs[this.activeTabIndex].webview;
if (activeWebview) { if (activeWebview) {
activeWebview[webviewListeners[key] as string](); listener(activeWebview);
} }
}); });
} }
ipcRenderer.on('certificate-error', (
event: Event,
webContentsId: number | null,
rendererCallbackId: number
) => {
const ignore = webContentsId !== null &&
this.tabs.some(
({webview}) =>
!webview.loading &&
webview.$el.getWebContentsId() === webContentsId &&
webview.props.ignoreCerts
);
ipcRenderer.send('renderer-callback', rendererCallbackId, ignore);
});
ipcRenderer.on('permission-request', (
event: Event,
{webContentsId, origin, permission}: {
webContentsId: number | null;
origin: string;
permission: string;
},
rendererCallbackId: number
) => {
const grant = webContentsId === null ?
origin === 'null' && permission === 'notifications' :
this.tabs.some(
({webview}) =>
!webview.loading &&
webview.$el.getWebContentsId() === webContentsId &&
webview.props.hasPermission?.(origin, permission)
);
console.log(
grant ? 'Granted' : 'Denied', 'permissions request for',
permission, 'from', origin
);
ipcRenderer.send('renderer-callback', rendererCallbackId, grant);
});
ipcRenderer.on('show-network-error', (event: Event, index: number) => { ipcRenderer.on('show-network-error', (event: Event, index: number) => {
this.openNetworkTroubleshooting(index); this.openNetworkTroubleshooting(index);
}); });
ipcRenderer.on('open-settings', (event: Event, settingNav: string) => { ipcRenderer.on('open-settings', async (event: Event, settingNav: string) => {
this.openSettings(settingNav); await this.openSettings(settingNav);
}); });
ipcRenderer.on('open-about', this.openAbout.bind(this)); ipcRenderer.on('open-about', this.openAbout.bind(this));
ipcRenderer.on('open-help', () => { ipcRenderer.on('open-help', async () => {
// Open help page of current active server // Open help page of current active server
const helpPage = this.getCurrentActiveServer() + '/help'; await LinkUtil.openBrowser(new URL('https://zulipchat.com/help/'));
shell.openExternal(helpPage);
}); });
ipcRenderer.on('reload-viewer', this.reloadView.bind(this, this.tabs[this.activeTabIndex].props.index)); ipcRenderer.on('reload-viewer', this.reloadView.bind(this, this.tabs[this.activeTabIndex].props.index));
@@ -838,17 +886,19 @@ class ServerManagerView {
this.activateLastTab(index); this.activateLastTab(index);
}); });
ipcRenderer.on('open-org-tab', () => { ipcRenderer.on('open-org-tab', async () => {
this.openSettings('AddServer'); await this.openSettings('AddServer');
}); });
ipcRenderer.on('reload-proxy', (event: Event, showAlert: boolean) => { ipcRenderer.on('reload-proxy', async (event: Event, showAlert: boolean) => {
this.loadProxy().then(() => { await this.loadProxy();
if (showAlert) { if (showAlert) {
alert('Proxy settings saved!'); await dialog.showMessageBox({
ipcRenderer.send('reload-full-app'); message: 'Proxy settings saved!',
} buttons: ['OK']
}); });
ipcRenderer.send('reload-full-app');
}
}); });
ipcRenderer.on('toggle-sidebar', (event: Event, show: boolean) => { ipcRenderer.on('toggle-sidebar', (event: Event, show: boolean) => {
@@ -864,8 +914,8 @@ class ServerManagerView {
webviews.forEach(webview => { webviews.forEach(webview => {
try { try {
webview.setAudioMuted(state); webview.setAudioMuted(state);
} catch (err) { } catch (_) {
// webview is not ready yet // Webview is not ready yet
webview.addEventListener('dom-ready', () => { webview.addEventListener('dom-ready', () => {
webview.setAudioMuted(state); webview.setAudioMuted(state);
}); });
@@ -881,31 +931,28 @@ class ServerManagerView {
}); });
return; return;
} }
this.updateGeneralSettings('toggle-menubar-setting', autoHideMenubar); this.updateGeneralSettings('toggle-menubar-setting', autoHideMenubar);
}); });
ipcRenderer.on('toggle-dnd', (event: Event, state: boolean, newSettings: SettingsOptions) => { ipcRenderer.on('toggle-dnd', (event: Event, state: boolean, newSettings: DNDSettings) => {
this.toggleDNDButton(state); this.toggleDNDButton(state);
ipcRenderer.send('forward-message', 'toggle-silent', newSettings.silent); ipcRenderer.send('forward-message', 'toggle-silent', newSettings.silent);
const selector = 'webview:not([class*=disabled])'; const webContents = this.getActiveWebview().getWebContents();
const webview: Electron.WebviewTag = document.querySelector(selector);
const webContents = webview.getWebContents();
webContents.send('toggle-dnd', state, newSettings); webContents.send('toggle-dnd', state, newSettings);
}); });
ipcRenderer.on('update-realm-name', (event: Event, serverURL: string, realmName: string) => { ipcRenderer.on('update-realm-name', (event: Event, serverURL: string, realmName: string) => {
// TODO: TypeScript - Type annotate getDomains() or this domain paramter. DomainUtil.getDomains().forEach((domain: DomainUtil.ServerConf, index: number) => {
DomainUtil.getDomains().forEach((domain: any, index: number) => {
if (domain.url.includes(serverURL)) { if (domain.url.includes(serverURL)) {
const serverTooltipSelector = `.tab .server-tooltip`; const serverTooltipSelector = '.tab .server-tooltip';
const serverTooltips = document.querySelectorAll(serverTooltipSelector); const serverTooltips = document.querySelectorAll(serverTooltipSelector);
serverTooltips[index].innerHTML = escape(realmName); serverTooltips[index].innerHTML = escape(realmName);
this.tabs[index].props.name = escape(realmName); this.tabs[index].props.name = escape(realmName);
this.tabs[index].webview.props.name = realmName; this.tabs[index].webview.props.name = realmName;
domain.alias = escape(realmName); domain.alias = escape(realmName);
DomainUtil.db.push(`/domains[${index}]`, domain, true); DomainUtil.updateDomain(index, domain);
DomainUtil.reloadDB();
// Update the realm name also on the Window menu // Update the realm name also on the Window menu
ipcRenderer.send('update-menu', { ipcRenderer.send('update-menu', {
tabs: this.tabsForIpc, tabs: this.tabsForIpc,
@@ -916,18 +963,17 @@ class ServerManagerView {
}); });
ipcRenderer.on('update-realm-icon', (event: Event, serverURL: string, iconURL: string) => { ipcRenderer.on('update-realm-icon', (event: Event, serverURL: string, iconURL: string) => {
// TODO: TypeScript - Type annotate getDomains() or this domain paramter. DomainUtil.getDomains().forEach(async (domain, index) => {
DomainUtil.getDomains().forEach((domain: any, index: number) => {
if (domain.url.includes(serverURL)) { if (domain.url.includes(serverURL)) {
DomainUtil.saveServerIcon(iconURL).then((localIconUrl: string) => { const localIconUrl: string = await DomainUtil.saveServerIcon({
const serverImgsSelector = `.tab .server-icons`; url: serverURL,
const serverImgs: NodeListOf<HTMLImageElement> = document.querySelectorAll(serverImgsSelector); icon: iconURL
serverImgs[index].src = localIconUrl;
domain.icon = localIconUrl;
DomainUtil.db.push(`/domains[${index}]`, domain, true);
DomainUtil.reloadDB();
}); });
const serverImgsSelector = '.tab .server-icons';
const serverImgs: NodeListOf<HTMLImageElement> = document.querySelectorAll(serverImgsSelector);
serverImgs[index].src = localIconUrl;
domain.icon = localIconUrl;
DomainUtil.updateDomain(index, domain);
} }
}); });
}); });
@@ -977,8 +1023,10 @@ class ServerManagerView {
ctx.font = '85px Helvetica'; ctx.font = '85px Helvetica';
ctx.fillText(String(Math.min(99, messageCount)), 64, 90); ctx.fillText(String(Math.min(99, messageCount)), 64, 90);
} }
return canvas; return canvas;
} }
ipcRenderer.send('update-taskbar-icon', createOverlayIcon(messageCount).toDataURL(), String(messageCount)); ipcRenderer.send('update-taskbar-icon', createOverlayIcon(messageCount).toDataURL(), String(messageCount));
}); });
@@ -990,41 +1038,46 @@ class ServerManagerView {
clipboard.writeText(this.getCurrentActiveServer()); clipboard.writeText(this.getCurrentActiveServer());
}); });
ipcRenderer.on('new-server', () => { ipcRenderer.on('new-server', async () => {
this.openSettings('AddServer'); await this.openSettings('AddServer');
}); });
ipcRenderer.on('set-active', () => { // Redo and undo functionality since the default API doesn't work on macOS
ipcRenderer.on('undo', () => {
return this.getActiveWebview().undo();
});
ipcRenderer.on('redo', () => {
return this.getActiveWebview().redo();
});
ipcRenderer.on('set-active', async () => {
const webviews: NodeListOf<Electron.WebviewTag> = document.querySelectorAll('webview'); const webviews: NodeListOf<Electron.WebviewTag> = document.querySelectorAll('webview');
webviews.forEach(webview => { await Promise.all([...webviews].map(async webview => webview.send('set-active')));
webview.send('set-active');
});
}); });
ipcRenderer.on('set-idle', () => { ipcRenderer.on('set-idle', async () => {
const webviews: NodeListOf<Electron.WebviewTag> = document.querySelectorAll('webview'); const webviews: NodeListOf<Electron.WebviewTag> = document.querySelectorAll('webview');
webviews.forEach(webview => { await Promise.all([...webviews].map(async webview => webview.send('set-idle')));
webview.send('set-idle');
});
}); });
ipcRenderer.on('open-network-settings', () => { ipcRenderer.on('open-network-settings', async () => {
this.openSettings('Network'); await this.openSettings('Network');
}); });
} }
} }
window.addEventListener('load', () => { window.addEventListener('load', async () => {
const serverManagerView = new ServerManagerView(); // Only start electron-connect (auto reload on change) when its ran
serverManagerView.init();
// only start electron-connect (auto reload on change) when its ran
// from `npm run dev` or `gulp dev` and not from `npm start` when // from `npm run dev` or `gulp dev` and not from `npm start` when
// app is started `npm start` main process's proces.argv will have // app is started `npm start` main process's proces.argv will have
// `--no-electron-connect` // `--no-electron-connect`
const mainProcessArgv = remote.getGlobal('process').argv; if (isDev && !remote.getGlobal('process').argv.includes('--no-electron-connect')) {
if (isDev && !mainProcessArgv.includes('--no-electron-connect')) {
require('electron-connect').client.create(); require('electron-connect').client.create();
} }
const serverManagerView = new ServerManagerView();
await serverManagerView.init();
}); });
export = new ServerManagerView(); export {};

View File

@@ -1,34 +1,31 @@
'use strict'; import {ipcRenderer} from 'electron';
import { ipcRenderer } from 'electron';
import { import {
appId, customReply, focusCurrentServer, parseReply, setupReply appId, customReply, focusCurrentServer, parseReply
} from './helpers'; } from './helpers';
import url = require('url'); import MacNotifier from 'node-mac-notifier';
import MacNotifier = require('node-mac-notifier'); import * as ConfigUtil from '../utils/config-util';
import ConfigUtil = require('../utils/config-util'); import electron_bridge from '../electron-bridge';
type ReplyHandler = (response: string) => void; type ReplyHandler = (response: string) => void;
type ClickHandler = () => void; type ClickHandler = () => void;
let replyHandler: ReplyHandler; let replyHandler: ReplyHandler;
let clickHandler: ClickHandler; let clickHandler: ClickHandler;
declare const window: ZulipWebWindow;
interface NotificationHandlerArgs { interface NotificationHandlerArgs {
response: string; response: string;
} }
class DarwinNotification { class DarwinNotification {
tag: string; tag: number;
constructor(title: string, opts: NotificationOptions) { constructor(title: string, options: NotificationOptions) {
const silent: boolean = ConfigUtil.getConfigItem('silent') || false; const silent: boolean = ConfigUtil.getConfigItem('silent') || false;
const { host, protocol } = location; const {icon} = options;
const { icon } = opts; const profilePic = new URL(icon, location.href).href;
const profilePic = url.resolve(`${protocol}//${host}`, icon);
this.tag = opts.tag; this.tag = Number.parseInt(options.tag, 10);
const notification = new MacNotifier(title, Object.assign(opts, { const notification = new MacNotifier(title, Object.assign(options, {
bundleId: appId, bundleId: appId,
canReply: true, canReply: true,
silent, silent,
@@ -36,7 +33,7 @@ class DarwinNotification {
})); }));
notification.addEventListener('click', () => { notification.addEventListener('click', () => {
// focus to the server who sent the // Focus to the server who sent the
// notification if not focused already // notification if not focused already
if (clickHandler) { if (clickHandler) {
clickHandler(); clickHandler();
@@ -58,23 +55,23 @@ class DarwinNotification {
return ConfigUtil.getConfigItem('showNotification') ? 'granted' : 'denied'; return ConfigUtil.getConfigItem('showNotification') ? 'granted' : 'denied';
} }
set onreply(handler: ReplyHandler) {
replyHandler = handler;
}
get onreply(): ReplyHandler { get onreply(): ReplyHandler {
return replyHandler; return replyHandler;
} }
set onclick(handler: ClickHandler) { set onreply(handler: ReplyHandler) {
clickHandler = handler; replyHandler = handler;
} }
get onclick(): ClickHandler { get onclick(): ClickHandler {
return clickHandler; return clickHandler;
} }
// not something that is common or set onclick(handler: ClickHandler) {
clickHandler = handler;
}
// Not something that is common or
// used by zulip server but added to be // used by zulip server but added to be
// future proff. // future proff.
addEventListener(event: string, handler: ClickHandler | ReplyHandler): void { addEventListener(event: string, handler: ClickHandler | ReplyHandler): void {
@@ -87,15 +84,15 @@ class DarwinNotification {
} }
} }
notificationHandler({ response }: NotificationHandlerArgs): void { async notificationHandler({response}: NotificationHandlerArgs): Promise<void> {
response = parseReply(response); response = await parseReply(response);
focusCurrentServer(); focusCurrentServer();
if (window.electron_bridge.send_notification_reply_message_supported) { if (electron_bridge.send_notification_reply_message_supported) {
window.electron_bridge.send_event('send_notification_reply_message', this.tag, response); electron_bridge.send_event('send_notification_reply_message', this.tag, response);
return; return;
} }
setupReply(this.tag); electron_bridge.emit('narrow-by-topic', this.tag);
if (replyHandler) { if (replyHandler) {
replyHandler(response); replyHandler(response);
return; return;
@@ -104,7 +101,7 @@ class DarwinNotification {
customReply(response); customReply(response);
} }
// method specific to notification api // Method specific to notification api
// used by zulip // used by zulip
close(): void { close(): void {
return; // eslint-disable-line no-useless-return return; // eslint-disable-line no-useless-return

View File

@@ -1,26 +1,24 @@
'use strict'; import {ipcRenderer} from 'electron';
import {focusCurrentServer} from './helpers';
import { ipcRenderer } from 'electron'; import * as ConfigUtil from '../utils/config-util';
import { focusCurrentServer } from './helpers';
import ConfigUtil = require('../utils/config-util');
const NativeNotification = window.Notification; const NativeNotification = window.Notification;
class BaseNotification extends NativeNotification { export default class BaseNotification extends NativeNotification {
constructor(title: string, opts: NotificationOptions) { constructor(title: string, options: NotificationOptions) {
opts.silent = true; options.silent = true;
super(title, opts); super(title, options);
this.addEventListener('click', () => { this.addEventListener('click', () => {
// focus to the server who sent the // Focus to the server who sent the
// notification if not focused already // notification if not focused already
focusCurrentServer(); focusCurrentServer();
ipcRenderer.send('focus-app'); ipcRenderer.send('focus-app');
}); });
} }
static requestPermission(): void { static async requestPermission(): Promise<NotificationPermission> {
return; // eslint-disable-line no-useless-return return this.permission;
} }
// Override default Notification permission // Override default Notification permission
@@ -28,5 +26,3 @@ class BaseNotification extends NativeNotification {
return ConfigUtil.getConfigItem('showNotification') ? 'granted' : 'denied'; return ConfigUtil.getConfigItem('showNotification') ? 'granted' : 'denied';
} }
} }
export = BaseNotification;

View File

@@ -1,6 +1,6 @@
import { remote } from 'electron'; import {remote} from 'electron';
import Logger = require('../utils/logger-util'); import Logger from '../utils/logger-util';
const logger = new Logger({ const logger = new Logger({
file: 'errors.log', file: 'errors.log',
@@ -14,37 +14,28 @@ export type BotListItem = [string, string];
const botsList: BotListItem[] = []; const botsList: BotListItem[] = [];
let botsListLoaded = false; let botsListLoaded = false;
// this function load list of bots from the server // This function load list of bots from the server
// sync=True for a synchronous getJSON request
// in case botsList isn't already completely loaded when required in parseRely // in case botsList isn't already completely loaded when required in parseRely
export function loadBots(sync = false): void { export async function loadBots(): Promise<void> {
const { $ } = window;
botsList.length = 0; botsList.length = 0;
if (sync) { const response = await fetch('/json/users');
$.ajaxSetup({async: false}); if (response.ok) {
} const {members} = await response.json();
$.getJSON('/json/users') members.forEach(({is_bot, full_name}: {[key: string]: unknown}) => {
.done((data: any) => { if (is_bot && typeof full_name === 'string') {
const { members } = data; const bot = `@${full_name}`;
members.forEach((membersRow: any) => { const mention = `@**${bot.replace(/^@/, '')}**`;
if (membersRow.is_bot) { botsList.push([bot, mention]);
const bot = `@${membersRow.full_name}`; }
const mention = `@**${bot.replace(/^@/, '')}**`;
botsList.push([bot, mention]);
}
});
botsListLoaded = true;
})
.fail((error: any) => {
logger.log('Load bots request failed: ', error.responseText);
logger.log('Load bots request status: ', error.statusText);
}); });
if (sync) { botsListLoaded = true;
$.ajaxSetup({async: true}); } else {
logger.log('Load bots request failed: ', await response.text());
logger.log('Load bots request status: ', response.status);
} }
} }
export function checkElements(...elements: any[]): boolean { export function checkElements(...elements: unknown[]): boolean {
let status = true; let status = true;
elements.forEach(element => { elements.forEach(element => {
if (element === null || element === undefined) { if (element === null || element === undefined) {
@@ -55,14 +46,14 @@ export function checkElements(...elements: any[]): boolean {
} }
export function customReply(reply: string): void { export function customReply(reply: string): void {
// server does not support notification reply yet. // Server does not support notification reply yet.
const buttonSelector = '.messagebox #send_controls button[type=submit]'; const buttonSelector = '.messagebox #send_controls button[type=submit]';
const messageboxSelector = '.selected_message .messagebox .messagebox-border .messagebox-content'; const messageboxSelector = '.selected_message .messagebox .messagebox-border .messagebox-content';
const textarea: HTMLInputElement = document.querySelector('#compose-textarea'); const textarea: HTMLInputElement = document.querySelector('#compose-textarea');
const messagebox: HTMLButtonElement = document.querySelector(messageboxSelector); const messagebox: HTMLButtonElement = document.querySelector(messageboxSelector);
const sendButton: HTMLButtonElement = document.querySelector(buttonSelector); const sendButton: HTMLButtonElement = document.querySelector(buttonSelector);
// sanity check for old server versions // Sanity check for old server versions
const elementsExists = checkElements(textarea, messagebox, sendButton); const elementsExists = checkElements(textarea, messagebox, sendButton);
if (!elementsExists) { if (!elementsExists) {
return; return;
@@ -77,19 +68,18 @@ const currentWindow = remote.getCurrentWindow();
const webContents = remote.getCurrentWebContents(); const webContents = remote.getCurrentWebContents();
const webContentsId = webContents.id; const webContentsId = webContents.id;
// this function will focus the server that sent // This function will focus the server that sent
// the notification. Main function implemented in main.js // the notification. Main function implemented in main.js
export function focusCurrentServer(): void { export function focusCurrentServer(): void {
// TODO: TypeScript: currentWindow of type BrowserWindow doesn't currentWindow.webContents.send('focus-webview-with-id', webContentsId);
// have a .send() property per typescript.
(currentWindow as any).send('focus-webview-with-id', webContentsId);
} }
// this function parses the reply from to notification
// This function parses the reply from to notification
// making it easier to reply from notification eg // making it easier to reply from notification eg
// @username in reply will be converted to @**username** // @username in reply will be converted to @**username**
// #stream in reply will be converted to #**stream** // #stream in reply will be converted to #**stream**
// bot mentions are not yet supported // bot mentions are not yet supported
export function parseReply(reply: string): string { export async function parseReply(reply: string): Promise<string> {
const usersDiv = document.querySelectorAll('#user_presences li'); const usersDiv = document.querySelectorAll('#user_presences li');
const streamHolder = document.querySelectorAll('#stream_filters li'); const streamHolder = document.querySelectorAll('#stream_filters li');
@@ -128,9 +118,9 @@ export function parseReply(reply: string): string {
reply = reply.replace(regex, streamMention); reply = reply.replace(regex, streamMention);
}); });
// If botsList isn't completely loaded yet, make a synchronous getJSON request for list // If botsList isn't completely loaded yet, make a request for list
if (botsListLoaded === false) { if (!botsListLoaded) {
loadBots(true); await loadBots();
} }
// Iterate for every bot name and replace in reply // Iterate for every bot name and replace in reply
@@ -145,9 +135,3 @@ export function parseReply(reply: string): string {
reply = reply.replace(/\\n/, '\n'); reply = reply.replace(/\\n/, '\n');
return reply; return reply;
} }
export function setupReply(id: string): void {
const { narrow } = window;
const narrowByTopic = narrow.by_topic || narrow.by_subject;
narrowByTopic(id, { trigger: 'notification' });
}

View File

@@ -1,25 +1,73 @@
'use strict'; import {remote} from 'electron';
import electron_bridge from '../electron-bridge';
import {appId, loadBots} from './helpers';
import { remote } from 'electron'; import DefaultNotification from './default-notification';
import * as params from '../utils/params-util'; const {app} = remote;
import { appId, loadBots } from './helpers';
import DefaultNotification = require('./default-notification');
const { app } = remote;
// From https://github.com/felixrieseberg/electron-windows-notifications#appusermodelid // From https://github.com/felixrieseberg/electron-windows-notifications#appusermodelid
// On windows 8 we have to explicitly set the appUserModelId otherwise notification won't work. // On windows 8 we have to explicitly set the appUserModelId otherwise notification won't work.
app.setAppUserModelId(appId); app.setAppUserModelId(appId);
window.Notification = DefaultNotification; let Notification = DefaultNotification;
if (process.platform === 'darwin') { if (process.platform === 'darwin') {
window.Notification = require('./darwin-notifications'); Notification = require('./darwin-notifications');
} }
window.addEventListener('load', () => { export interface NotificationData {
// eslint-disable-next-line no-undef, @typescript-eslint/camelcase close: () => void;
if (params.isPageParams() && page_params.realm_uri) { title: string;
loadBots(); dir: NotificationDirection;
lang: string;
body: string;
tag: string;
image: string;
icon: string;
badge: string;
vibrate: readonly number[];
timestamp: number;
renotify: boolean;
silent: boolean;
requireInteraction: boolean;
data: unknown;
actions: readonly NotificationAction[];
}
export function newNotification(
title: string,
options: NotificationOptions | undefined,
dispatch: (type: string, eventInit: EventInit) => boolean
): NotificationData {
const notification = new Notification(title, options);
for (const type of ['click', 'close', 'error', 'show']) {
notification.addEventListener(type, (ev: Event) => {
if (!dispatch(type, ev)) {
ev.preventDefault();
}
});
} }
return {
close: () => notification.close(),
title: notification.title,
dir: notification.dir,
lang: notification.lang,
body: notification.body,
tag: notification.tag,
image: notification.image,
icon: notification.icon,
badge: notification.badge,
vibrate: notification.vibrate,
timestamp: notification.timestamp,
renotify: notification.renotify,
silent: notification.silent,
requireInteraction: notification.requireInteraction,
data: notification.data,
actions: notification.actions
};
}
electron_bridge.once('zulip-loaded', async () => {
await loadBots();
}); });

View File

@@ -1,16 +1,10 @@
'use strict'; import {ipcRenderer} from 'electron';
import { ipcRenderer } from 'electron'; export function init($reconnectButton: Element, $settingsButton: Element): void {
$reconnectButton.addEventListener('click', () => {
class NetworkTroubleshootingView { ipcRenderer.send('forward-message', 'reload-viewer');
init($reconnectButton: Element, $settingsButton: Element): void { });
$reconnectButton.addEventListener('click', () => { $settingsButton.addEventListener('click', () => {
ipcRenderer.send('forward-message', 'reload-viewer'); ipcRenderer.send('forward-message', 'open-settings');
}); });
$settingsButton.addEventListener('click', () => {
ipcRenderer.send('forward-message', 'open-settings');
});
}
} }
export = new NetworkTroubleshootingView();

View File

@@ -1,23 +1,26 @@
'use-strict'; 'use-strict';
import { remote, OpenDialogOptions } from 'electron'; import {remote, OpenDialogOptions} from 'electron';
import path = require('path'); import path from 'path';
import BaseComponent = require('../../components/base'); import BaseComponent from '../../components/base';
import CertificateUtil = require('../../utils/certificate-util'); import * as CertificateUtil from '../../utils/certificate-util';
import DomainUtil = require('../../utils/domain-util'); import * as DomainUtil from '../../utils/domain-util';
import t = require('../../utils/translation-util'); import * as t from '../../utils/translation-util';
const { dialog } = remote; interface AddCertificateProps {
$root: Element;
}
class AddCertificate extends BaseComponent { const {dialog} = remote;
// TODO: TypeScript - Here props should be object type
props: any; export default class AddCertificate extends BaseComponent {
props: AddCertificateProps;
_certFile: string; _certFile: string;
$addCertificate: Element | null; $addCertificate: Element | null;
addCertificateButton: Element | null; addCertificateButton: Element | null;
serverUrl: HTMLInputElement | null; serverUrl: HTMLInputElement | null;
constructor(props: any) { constructor(props: AddCertificateProps) {
super(); super();
this.props = props; this.props = props;
this._certFile = ''; this._certFile = '';
@@ -46,7 +49,7 @@ class AddCertificate extends BaseComponent {
this.initListeners(); this.initListeners();
} }
validateAndAdd(): void { async validateAndAdd(): Promise<void> {
const certificate = this._certFile; const certificate = this._certFile;
const serverUrl = this.serverUrl.value; const serverUrl = this.serverUrl.value;
if (certificate !== '' && serverUrl !== '') { if (certificate !== '' && serverUrl !== '') {
@@ -56,45 +59,41 @@ class AddCertificate extends BaseComponent {
if (!copy) { if (!copy) {
return; return;
} }
CertificateUtil.setCertificate(server, fileName); CertificateUtil.setCertificate(server, fileName);
dialog.showMessageBox({
title: 'Success',
message: `Certificate saved!`
});
this.serverUrl.value = ''; this.serverUrl.value = '';
await dialog.showMessageBox({
title: 'Success',
message: 'Certificate saved!'
});
} else { } else {
dialog.showErrorBox('Error', `Please, ${serverUrl === '' ? dialog.showErrorBox('Error', `Please, ${serverUrl === '' ?
'Enter an Organization URL' : 'Choose certificate file'}`); 'Enter an Organization URL' : 'Choose certificate file'}`);
} }
} }
addHandler(): void { async addHandler(): Promise<void> {
const showDialogOptions: OpenDialogOptions = { const showDialogOptions: OpenDialogOptions = {
title: 'Select file', title: 'Select file',
properties: ['openFile'], properties: ['openFile'],
filters: [{ name: 'crt, pem', extensions: ['crt', 'pem'] }] filters: [{name: 'crt, pem', extensions: ['crt', 'pem']}]
}; };
dialog.showOpenDialog(showDialogOptions, selectedFile => { const {filePaths, canceled} = await dialog.showOpenDialog(showDialogOptions);
if (selectedFile) { if (!canceled) {
this._certFile = selectedFile[0] || ''; this._certFile = filePaths[0] || '';
this.validateAndAdd(); await this.validateAndAdd();
} }
});
} }
initListeners(): void { initListeners(): void {
this.addCertificateButton.addEventListener('click', () => { this.addCertificateButton.addEventListener('click', async () => {
this.addHandler(); await this.addHandler();
}); });
this.serverUrl.addEventListener('keypress', event => { this.serverUrl.addEventListener('keypress', async event => {
const EnterkeyCode = event.keyCode; if (event.key === 'Enter') {
await this.addHandler();
if (EnterkeyCode === 13) {
this.addHandler();
} }
}); });
} }
} }
export = AddCertificate;

View File

@@ -1,63 +1,44 @@
'use strict'; import electron, {app} from 'electron';
import { app } from 'electron';
import electron = require('electron'); import * as ConfigUtil from '../../utils/config-util';
import ConfigUtil = require('../../utils/config-util');
let instance: BadgeSettings | any = null; function showBadgeCount(messageCount: number, mainWindow: electron.BrowserWindow): void {
if (process.platform === 'win32') {
class BadgeSettings { updateOverlayIcon(messageCount, mainWindow);
constructor() { } else {
if (instance) { app.badgeCount = messageCount;
return instance;
} else {
instance = this;
}
return instance;
}
showBadgeCount(messageCount: number, mainWindow: electron.BrowserWindow): void {
if (process.platform === 'win32') {
this.updateOverlayIcon(messageCount, mainWindow);
} else {
// This should work on both macOS and Linux
app.setBadgeCount(messageCount);
}
}
hideBadgeCount(mainWindow: electron.BrowserWindow): void {
if (process.platform === 'darwin') {
app.setBadgeCount(0);
}
if (process.platform === 'win32') {
mainWindow.setOverlayIcon(null, '');
}
}
updateBadge(badgeCount: number, mainWindow: electron.BrowserWindow): void {
if (ConfigUtil.getConfigItem('badgeOption', true)) {
this.showBadgeCount(badgeCount, mainWindow);
} else {
this.hideBadgeCount(mainWindow);
}
}
updateOverlayIcon(messageCount: number, mainWindow: electron.BrowserWindow): void {
if (!mainWindow.isFocused()) {
mainWindow.flashFrame(ConfigUtil.getConfigItem('flashTaskbarOnMessage'));
}
if (messageCount === 0) {
mainWindow.setOverlayIcon(null, '');
} else {
mainWindow.webContents.send('render-taskbar-icon', messageCount);
}
}
updateTaskbarIcon(data: string, text: string, mainWindow: electron.BrowserWindow): void {
const img = electron.nativeImage.createFromDataURL(data);
mainWindow.setOverlayIcon(img, text);
} }
} }
export = new BadgeSettings(); function hideBadgeCount(mainWindow: electron.BrowserWindow): void {
if (process.platform === 'win32') {
mainWindow.setOverlayIcon(null, '');
} else {
app.badgeCount = 0;
}
}
export function updateBadge(badgeCount: number, mainWindow: electron.BrowserWindow): void {
if (ConfigUtil.getConfigItem('badgeOption', true)) {
showBadgeCount(badgeCount, mainWindow);
} else {
hideBadgeCount(mainWindow);
}
}
function updateOverlayIcon(messageCount: number, mainWindow: electron.BrowserWindow): void {
if (!mainWindow.isFocused()) {
mainWindow.flashFrame(ConfigUtil.getConfigItem('flashTaskbarOnMessage'));
}
if (messageCount === 0) {
mainWindow.setOverlayIcon(null, '');
} else {
mainWindow.webContents.send('render-taskbar-icon', messageCount);
}
}
export function updateTaskbarIcon(data: string, text: string, mainWindow: electron.BrowserWindow): void {
const img = electron.nativeImage.createFromDataURL(data);
mainWindow.setOverlayIcon(img, text);
}

View File

@@ -1,12 +1,17 @@
'use strict'; import {ipcRenderer} from 'electron';
import escape from 'escape-html';
import { ipcRenderer } from 'electron'; import BaseComponent from '../../components/base';
import BaseComponent = require('../../components/base'); interface BaseSectionProps {
$element: HTMLElement;
disabled?: boolean;
value: boolean;
clickHandler: () => void;
}
class BaseSection extends BaseComponent { export default class BaseSection extends BaseComponent {
// TODO: TypeScript - Here props should be object type generateSettingOption(props: BaseSectionProps): void {
generateSettingOption(props: any): void {
const {$element, disabled, value, clickHandler} = props; const {$element, disabled, value, clickHandler} = props;
$element.innerHTML = ''; $element.innerHTML = '';
@@ -19,8 +24,8 @@ class BaseSection extends BaseComponent {
} }
} }
generateOptionTemplate(settingOption: boolean, disabled: boolean): string { generateOptionTemplate(settingOption: boolean, disabled?: boolean): string {
const label = disabled ? `<label class="disallowed" title="Setting locked by system administrator."/>` : `<label/>`; const label = disabled ? '<label class="disallowed" title="Setting locked by system administrator."/>' : '<label/>';
if (settingOption) { if (settingOption) {
return ` return `
<div class="action"> <div class="action">
@@ -30,8 +35,9 @@ class BaseSection extends BaseComponent {
</div> </div>
</div> </div>
`; `;
} else { }
return `
return `
<div class="action"> <div class="action">
<div class="switch"> <div class="switch">
<input class="toggle toggle-round" type="checkbox"> <input class="toggle toggle-round" type="checkbox">
@@ -39,12 +45,21 @@ class BaseSection extends BaseComponent {
</div> </div>
</div> </div>
`; `;
} }
/* A method that in future can be used to create dropdown menus using <select> <option> tags.
it needs an object which has ``key: value`` pairs and will return a string that can be appended to HTML
*/
generateSelectTemplate(options: {[key: string]: string}, className?: string, idName?: string): string {
let select = `<select class="${escape(className)}" id="${escape(idName)}">\n`;
Object.keys(options).forEach(key => {
select += `<option name="${escape(key)}" value="${escape(key)}">${escape(options[key])}</option>\n`;
});
select += '</select>';
return select;
} }
reloadApp(): void { reloadApp(): void {
ipcRenderer.send('forward-message', 'reload-viewer'); ipcRenderer.send('forward-message', 'reload-viewer');
} }
} }
export = BaseSection;

View File

@@ -1,23 +1,24 @@
'use strict'; import {ipcRenderer} from 'electron';
import { ipcRenderer } from 'electron'; import BaseSection from './base-section';
import * as DomainUtil from '../../utils/domain-util';
import ServerInfoForm from './server-info-form';
import AddCertificate from './add-certificate';
import FindAccounts from './find-accounts';
import * as t from '../../utils/translation-util';
import BaseSection = require('./base-section'); interface ConnectedOrgSectionProps {
import DomainUtil = require('../../utils/domain-util'); $root: Element;
import ServerInfoForm = require('./server-info-form'); }
import AddCertificate = require('./add-certificate');
import FindAccounts = require('./find-accounts');
import t = require('../../utils/translation-util');
class ConnectedOrgSection extends BaseSection { export default class ConnectedOrgSection extends BaseSection {
// TODO: TypeScript - Here props should be object type props: ConnectedOrgSectionProps;
props: any;
$serverInfoContainer: Element | null; $serverInfoContainer: Element | null;
$existingServers: Element | null; $existingServers: Element | null;
$newOrgButton: HTMLButtonElement | null; $newOrgButton: HTMLButtonElement | null;
$addCertificateContainer: Element | null; $addCertificateContainer: Element | null;
$findAccountsContainer: Element | null; $findAccountsContainer: Element | null;
constructor(props: any) { constructor(props: ConnectedOrgSectionProps) {
super(); super();
this.props = props; this.props = props;
} }
@@ -57,10 +58,10 @@ class ConnectedOrgSection extends BaseSection {
// Show noServerText if no servers are there otherwise hide it // Show noServerText if no servers are there otherwise hide it
this.$existingServers.innerHTML = servers.length === 0 ? noServerText : ''; this.$existingServers.innerHTML = servers.length === 0 ? noServerText : '';
for (let i = 0; i < servers.length; i++) { for (const [i, server] of servers.entries()) {
new ServerInfoForm({ new ServerInfoForm({
$root: this.$serverInfoContainer, $root: this.$serverInfoContainer,
server: servers[i], server,
index: i, index: i,
onChange: this.reloadApp onChange: this.reloadApp
}).init(); }).init();
@@ -86,5 +87,3 @@ class ConnectedOrgSection extends BaseSection {
}).init(); }).init();
} }
} }
export = ConnectedOrgSection;

View File

@@ -1,17 +1,19 @@
'use-strict'; 'use-strict';
import { shell } from 'electron'; import BaseComponent from '../../components/base';
import * as LinkUtil from '../../utils/link-util';
import * as t from '../../utils/translation-util';
import BaseComponent = require('../../components/base'); interface FindAccountsProps {
import t = require('../../utils/translation-util'); $root: Element;
}
class FindAccounts extends BaseComponent { export default class FindAccounts extends BaseComponent {
// TODO: TypeScript - Here props should be object type props: FindAccountsProps;
props: any;
$findAccounts: Element | null; $findAccounts: Element | null;
$findAccountsButton: Element | null; $findAccountsButton: Element | null;
$serverUrlField: HTMLInputElement | null; $serverUrlField: HTMLInputElement | null;
constructor(props: any) { constructor(props: FindAccountsProps) {
super(); super();
this.props = props; this.props = props;
} }
@@ -38,19 +40,21 @@ class FindAccounts extends BaseComponent {
this.initListeners(); this.initListeners();
} }
findAccounts(url: string): void { async findAccounts(url: string): Promise<void> {
if (!url) { if (!url) {
return; return;
} }
if (!url.startsWith('http')) { if (!url.startsWith('http')) {
url = 'https://' + url; url = 'https://' + url;
} }
shell.openExternal(url + '/accounts/find');
await LinkUtil.openBrowser(new URL('/accounts/find', url));
} }
initListeners(): void { initListeners(): void {
this.$findAccountsButton.addEventListener('click', () => { this.$findAccountsButton.addEventListener('click', async () => {
this.findAccounts(this.$serverUrlField.value); await this.findAccounts(this.$serverUrlField.value);
}); });
this.$serverUrlField.addEventListener('click', () => { this.$serverUrlField.addEventListener('click', () => {
@@ -59,9 +63,9 @@ class FindAccounts extends BaseComponent {
} }
}); });
this.$serverUrlField.addEventListener('keypress', event => { this.$serverUrlField.addEventListener('keypress', async event => {
if (event.keyCode === 13) { if (event.key === 'Enter') {
this.findAccounts(this.$serverUrlField.value); await this.findAccounts(this.$serverUrlField.value);
} }
}); });
@@ -74,5 +78,3 @@ class FindAccounts extends BaseComponent {
}); });
} }
} }
export = FindAccounts;

View File

@@ -1,21 +1,24 @@
'use strict'; import {ipcRenderer, remote, OpenDialogOptions} from 'electron';
import { ipcRenderer, remote, OpenDialogOptions } from 'electron';
import path = require('path'); import path from 'path';
import fs = require('fs-extra'); import fs from 'fs-extra';
const { app, dialog } = remote; const {app, dialog} = remote;
const currentBrowserWindow = remote.getCurrentWindow(); const currentBrowserWindow = remote.getCurrentWindow();
import BaseSection = require('./base-section'); import BaseSection from './base-section';
import ConfigUtil = require('../../utils/config-util'); import * as ConfigUtil from '../../utils/config-util';
import EnterpriseUtil = require('./../../utils/enterprise-util'); import * as EnterpriseUtil from '../../utils/enterprise-util';
import t = require('../../utils/translation-util'); import * as t from '../../utils/translation-util';
import supportedLocales from '../../../../translations/supported-locales.json';
class GeneralSection extends BaseSection { interface GeneralSectionProps {
// TODO: TypeScript - Here props should be object type $root: Element;
props: any; }
constructor(props: any) {
export default class GeneralSection extends BaseSection {
props: GeneralSectionProps;
constructor(props: GeneralSectionProps) {
super(); super();
this.props = props; this.props = props;
} }
@@ -93,29 +96,32 @@ class GeneralSection extends BaseSection {
</div> </div>
<div class="title">${t.__('Advanced')}</div> <div class="title">${t.__('Advanced')}</div>
<div class="settings-card"> <div class="settings-card">
<div class="setting-row" id="enable-error-reporting">
<div class="setting-description">${t.__('Enable error reporting (requires restart)')}</div> <div class="setting-row" id="enable-error-reporting">
<div class="setting-control"></div> <div class="setting-description">${t.__('Enable error reporting (requires restart)')}</div>
</div> <div class="setting-control"></div>
<div class="setting-row" id="show-download-folder"> </div>
<div class="setting-description">${t.__('Show downloaded files in file manager')}</div>
<div class="setting-control"></div> <div class="setting-row" id="app-language">
</div> <div class="setting-description">${t.__('App language (requires restart)')}</div>
<div class="setting-row" id="add-custom-css"> <div id="lang-div" class="lang-div"></div>
<div class="setting-description"> </div>
${t.__('Add custom CSS')}
</div> <div class="setting-row" id="add-custom-css">
<button class="custom-css-button green">${t.__('Upload')}</button> <div class="setting-description">
</div> ${t.__('Add custom CSS')}
<div class="setting-row" id="remove-custom-css"> </div>
<div class="setting-description"> <button class="custom-css-button green">${t.__('Upload')}</button>
<div class="selected-css-path" id="custom-css-path">${ConfigUtil.getConfigItem('customCSS')}</div> </div>
</div> <div class="setting-row" id="remove-custom-css">
<div class="action red" id="css-delete-action"> <div class="setting-description">
<i class="material-icons">indeterminate_check_box</i> <div class="selected-css-path" id="custom-css-path">${ConfigUtil.getConfigString('customCSS', '')}</div>
<span>${t.__('Delete')}</span> </div>
</div> <div class="action red" id="css-delete-action">
</div> <i class="material-icons">indeterminate_check_box</i>
<span>${t.__('Delete')}</span>
</div>
</div>
<div class="setting-row" id="download-folder"> <div class="setting-row" id="download-folder">
<div class="setting-description"> <div class="setting-description">
${t.__('Default download location')} ${t.__('Default download location')}
@@ -124,10 +130,13 @@ class GeneralSection extends BaseSection {
</div> </div>
<div class="setting-row"> <div class="setting-row">
<div class="setting-description"> <div class="setting-description">
<div class="download-folder-path">${ConfigUtil.getConfigItem('downloadsPath', `${app.getPath('downloads')}`)}</div> <div class="download-folder-path">${ConfigUtil.getConfigString('downloadsPath', app.getPath('downloads'))}</div>
</div> </div>
</div> </div>
<div class="setting-row" id="prompt-download">
<div class="setting-description">${t.__('Ask where to save files before downloading')}</div>
<div class="setting-control"></div>
</div>
</div> </div>
<div class="title">${t.__('Reset Application Data')}</div> <div class="title">${t.__('Reset Application Data')}</div>
<div class="settings-card"> <div class="settings-card">
@@ -137,7 +146,7 @@ class GeneralSection extends BaseSection {
<button class="reset-data-button red w-150">${t.__('Reset App Data')}</button> <button class="reset-data-button red w-150">${t.__('Reset App Data')}</button>
</div> </div>
</div> </div>
</div> </div>
`; `;
} }
@@ -158,9 +167,10 @@ class GeneralSection extends BaseSection {
this.showCustomCSSPath(); this.showCustomCSSPath();
this.removeCustomCSS(); this.removeCustomCSS();
this.downloadFolder(); this.downloadFolder();
this.showDownloadFolder();
this.updateQuitOnCloseOption(); this.updateQuitOnCloseOption();
this.updatePromptDownloadOption();
this.enableErrorReporting(); this.enableErrorReporting();
this.setLocale();
// Platform specific settings // Platform specific settings
@@ -168,6 +178,7 @@ class GeneralSection extends BaseSection {
if (process.platform === 'win32') { if (process.platform === 'win32') {
this.updateFlashTaskbar(); this.updateFlashTaskbar();
} }
// Dock bounce on macOS // Dock bounce on macOS
if (process.platform === 'darwin') { if (process.platform === 'darwin') {
this.updateDockBouncing(); this.updateDockBouncing();
@@ -254,6 +265,7 @@ class GeneralSection extends BaseSection {
ConfigUtil.setConfigItem('betaUpdate', false); ConfigUtil.setConfigItem('betaUpdate', false);
this.betaUpdateOption(); this.betaUpdateOption();
} }
this.autoUpdateOption(); this.autoUpdateOption();
} }
}); });
@@ -281,9 +293,7 @@ class GeneralSection extends BaseSection {
const newValue = !ConfigUtil.getConfigItem('silent', true); const newValue = !ConfigUtil.getConfigItem('silent', true);
ConfigUtil.setConfigItem('silent', newValue); ConfigUtil.setConfigItem('silent', newValue);
this.updateSilentOption(); this.updateSilentOption();
// TODO: TypeScript: currentWindow of type BrowserWindow doesn't currentBrowserWindow.webContents.send('toggle-silent', newValue);
// have a .send() property per typescript.
(currentBrowserWindow as any).send('toggle-silent', newValue);
} }
}); });
} }
@@ -362,43 +372,59 @@ class GeneralSection extends BaseSection {
}); });
} }
clearAppDataDialog(): void { async clearAppDataDialog(): Promise<void> {
const clearAppDataMessage = 'By clicking proceed you will be removing all added accounts and preferences from Zulip. When the application restarts, it will be as if you are starting Zulip for the first time.'; const clearAppDataMessage = 'By clicking proceed you will be removing all added accounts and preferences from Zulip. When the application restarts, it will be as if you are starting Zulip for the first time.';
const getAppPath = path.join(app.getPath('appData'), app.getName()); const getAppPath = path.join(app.getPath('appData'), app.name);
dialog.showMessageBox({ const {response} = await dialog.showMessageBox({
type: 'warning', type: 'warning',
buttons: ['YES', 'NO'], buttons: ['YES', 'NO'],
defaultId: 0, defaultId: 0,
message: 'Are you sure', message: 'Are you sure',
detail: clearAppDataMessage detail: clearAppDataMessage
}, response => {
if (response === 0) {
fs.remove(getAppPath);
setTimeout(() => ipcRenderer.send('forward-message', 'hard-reload'), 1000);
}
}); });
if (response === 0) {
await fs.remove(getAppPath);
ipcRenderer.send('forward-message', 'hard-reload');
}
} }
customCssDialog(): void { async customCssDialog(): Promise<void> {
const showDialogOptions: OpenDialogOptions = { const showDialogOptions: OpenDialogOptions = {
title: 'Select file', title: 'Select file',
properties: ['openFile'], properties: ['openFile'],
filters: [{ name: 'CSS file', extensions: ['css'] }] filters: [{name: 'CSS file', extensions: ['css']}]
}; };
dialog.showOpenDialog(showDialogOptions, selectedFile => { const {filePaths, canceled} = await dialog.showOpenDialog(showDialogOptions);
if (selectedFile) { if (!canceled) {
ConfigUtil.setConfigItem('customCSS', selectedFile[0]); ConfigUtil.setConfigItem('customCSS', filePaths[0]);
ipcRenderer.send('forward-message', 'hard-reload'); ipcRenderer.send('forward-message', 'hard-reload');
} }
});
} }
updateResetDataOption(): void { updateResetDataOption(): void {
const resetDataButton = document.querySelector('#resetdata-option .reset-data-button'); const resetDataButton = document.querySelector('#resetdata-option .reset-data-button');
resetDataButton.addEventListener('click', () => { resetDataButton.addEventListener('click', async () => {
this.clearAppDataDialog(); await this.clearAppDataDialog();
});
}
setLocale(): void {
const langDiv: HTMLSelectElement = document.querySelector('.lang-div');
// This path is for the JSON file that stores key: value pairs for supported locales
const langList = this.generateSelectTemplate(supportedLocales, 'lang-menu');
langDiv.innerHTML += langList;
// `langMenu` is the select-option dropdown menu formed after executing the previous command
const langMenu: HTMLSelectElement = document.querySelector('.lang-menu');
// The next three lines set the selected language visible on the dropdown button
let language = ConfigUtil.getConfigItem('appLanguage');
language = language && langMenu.options.namedItem(language) ? language : 'en-US';
langMenu.options.namedItem(language).selected = true;
langMenu.addEventListener('change', (event: Event) => {
ConfigUtil.setConfigItem('appLanguage', (event.target as HTMLSelectElement).value);
}); });
} }
@@ -416,8 +442,8 @@ class GeneralSection extends BaseSection {
addCustomCSS(): void { addCustomCSS(): void {
const customCSSButton = document.querySelector('#add-custom-css .custom-css-button'); const customCSSButton = document.querySelector('#add-custom-css .custom-css-button');
customCSSButton.addEventListener('click', () => { customCSSButton.addEventListener('click', async () => {
this.customCssDialog(); await this.customCssDialog();
}); });
} }
@@ -431,43 +457,41 @@ class GeneralSection extends BaseSection {
removeCustomCSS(): void { removeCustomCSS(): void {
const removeCSSButton = document.querySelector('#css-delete-action'); const removeCSSButton = document.querySelector('#css-delete-action');
removeCSSButton.addEventListener('click', () => { removeCSSButton.addEventListener('click', () => {
ConfigUtil.setConfigItem('customCSS', ""); ConfigUtil.setConfigItem('customCSS', '');
ipcRenderer.send('forward-message', 'hard-reload'); ipcRenderer.send('forward-message', 'hard-reload');
}); });
} }
downloadFolderDialog(): void { async downloadFolderDialog(): Promise<void> {
const showDialogOptions: OpenDialogOptions = { const showDialogOptions: OpenDialogOptions = {
title: 'Select Download Location', title: 'Select Download Location',
properties: ['openDirectory'] properties: ['openDirectory']
}; };
dialog.showOpenDialog(showDialogOptions, selectedFolder => { const {filePaths, canceled} = await dialog.showOpenDialog(showDialogOptions);
if (selectedFolder) { if (!canceled) {
ConfigUtil.setConfigItem('downloadsPath', selectedFolder[0]); ConfigUtil.setConfigItem('downloadsPath', filePaths[0]);
const downloadFolderPath: HTMLElement = document.querySelector('.download-folder-path'); const downloadFolderPath: HTMLElement = document.querySelector('.download-folder-path');
downloadFolderPath.innerText = selectedFolder[0]; downloadFolderPath.textContent = filePaths[0];
} }
});
} }
downloadFolder(): void { downloadFolder(): void {
const downloadFolder = document.querySelector('#download-folder .download-folder-button'); const downloadFolder = document.querySelector('#download-folder .download-folder-button');
downloadFolder.addEventListener('click', () => { downloadFolder.addEventListener('click', async () => {
this.downloadFolderDialog(); await this.downloadFolderDialog();
}); });
} }
showDownloadFolder(): void { updatePromptDownloadOption(): void {
this.generateSettingOption({ this.generateSettingOption({
$element: document.querySelector('#show-download-folder .setting-control'), $element: document.querySelector('#prompt-download .setting-control'),
value: ConfigUtil.getConfigItem('showDownloadFolder', false), value: ConfigUtil.getConfigItem('promptDownload', false),
clickHandler: () => { clickHandler: () => {
const newValue = !ConfigUtil.getConfigItem('showDownloadFolder'); const newValue = !ConfigUtil.getConfigItem('promptDownload');
ConfigUtil.setConfigItem('showDownloadFolder', newValue); ConfigUtil.setConfigItem('promptDownload', newValue);
this.showDownloadFolder(); this.updatePromptDownloadOption();
} }
}); });
} }
} }
export = GeneralSection;

View File

@@ -1,14 +1,16 @@
'use strict'; import BaseComponent from '../../components/base';
import * as t from '../../utils/translation-util';
import BaseComponent = require('../../components/base'); interface PreferenceNavProps {
import t = require('../../utils/translation-util'); $root: Element;
onItemSelected: (navItem: string) => void;
}
class PreferenceNav extends BaseComponent { export default class PreferenceNav extends BaseComponent {
// TODO: TypeScript - Here props should be object type props: PreferenceNavProps;
props: any;
navItems: string[]; navItems: string[];
$el: Element; $el: Element;
constructor(props: any) { constructor(props: PreferenceNavProps) {
super(); super();
this.props = props; this.props = props;
this.navItems = ['General', 'Network', 'AddServer', 'Organizations', 'Shortcuts']; this.navItems = ['General', 'Network', 'AddServer', 'Organizations', 'Shortcuts'];
@@ -64,5 +66,3 @@ class PreferenceNav extends BaseComponent {
$item.classList.remove('active'); $item.classList.remove('active');
} }
} }
export = PreferenceNav;

View File

@@ -1,20 +1,21 @@
'use strict'; import {ipcRenderer} from 'electron';
import { ipcRenderer } from 'electron'; import BaseSection from './base-section';
import * as ConfigUtil from '../../utils/config-util';
import * as t from '../../utils/translation-util';
import BaseSection = require('./base-section'); interface NetworkSectionProps {
import ConfigUtil = require('../../utils/config-util'); $root: Element;
import t = require('../../utils/translation-util'); }
class NetworkSection extends BaseSection { export default class NetworkSection extends BaseSection {
// TODO: TypeScript - Here props should be object type props: NetworkSectionProps;
props: any;
$proxyPAC: HTMLInputElement; $proxyPAC: HTMLInputElement;
$proxyRules: HTMLInputElement; $proxyRules: HTMLInputElement;
$proxyBypass: HTMLInputElement; $proxyBypass: HTMLInputElement;
$proxySaveAction: Element; $proxySaveAction: Element;
$manualProxyBlock: Element; $manualProxyBlock: Element;
constructor(props: any) { constructor(props: NetworkSectionProps) {
super(); super();
this.props = props; this.props = props;
} }
@@ -104,11 +105,13 @@ class NetworkSection extends BaseSection {
ConfigUtil.setConfigItem('useManualProxy', !manualProxyValue); ConfigUtil.setConfigItem('useManualProxy', !manualProxyValue);
this.toggleManualProxySettings(!manualProxyValue); this.toggleManualProxySettings(!manualProxyValue);
} }
if (newValue === false) {
if (!newValue) {
// Remove proxy system proxy settings // Remove proxy system proxy settings
ConfigUtil.setConfigItem('proxyRules', ''); ConfigUtil.setConfigItem('proxyRules', '');
ipcRenderer.send('forward-message', 'reload-proxy', false); ipcRenderer.send('forward-message', 'reload-proxy', false);
} }
ConfigUtil.setConfigItem('useSystemProxy', newValue); ConfigUtil.setConfigItem('useSystemProxy', newValue);
this.updateProxyOption(); this.updateProxyOption();
} }
@@ -123,6 +126,7 @@ class NetworkSection extends BaseSection {
if (systemProxyValue && newValue) { if (systemProxyValue && newValue) {
ConfigUtil.setConfigItem('useSystemProxy', !systemProxyValue); ConfigUtil.setConfigItem('useSystemProxy', !systemProxyValue);
} }
ConfigUtil.setConfigItem('proxyRules', ''); ConfigUtil.setConfigItem('proxyRules', '');
ConfigUtil.setConfigItem('useManualProxy', newValue); ConfigUtil.setConfigItem('useManualProxy', newValue);
// Reload app only when turning manual proxy off, hence !newValue // Reload app only when turning manual proxy off, hence !newValue
@@ -132,5 +136,3 @@ class NetworkSection extends BaseSection {
}); });
} }
} }
export = NetworkSection;

View File

@@ -1,18 +1,23 @@
'use strict'; import {ipcRenderer, remote} from 'electron';
import { shell, ipcRenderer } from 'electron'; import BaseComponent from '../../components/base';
import * as DomainUtil from '../../utils/domain-util';
import * as LinkUtil from '../../utils/link-util';
import * as t from '../../utils/translation-util';
import BaseComponent = require('../../components/base'); const {dialog} = remote;
import DomainUtil = require('../../utils/domain-util');
import t = require('../../utils/translation-util');
class NewServerForm extends BaseComponent { interface NewServerFormProps {
// TODO: TypeScript - Here props should be object type $root: Element;
props: any; onChange: () => void;
}
export default class NewServerForm extends BaseComponent {
props: NewServerFormProps;
$newServerForm: Element; $newServerForm: Element;
$saveServerButton: HTMLButtonElement; $saveServerButton: HTMLButtonElement;
$newServerUrl: HTMLInputElement; $newServerUrl: HTMLInputElement;
constructor(props: any) { constructor(props: NewServerFormProps) {
super(); super();
this.props = props; this.props = props;
} }
@@ -25,9 +30,7 @@ class NewServerForm extends BaseComponent {
<input class="setting-input-value" autofocus placeholder="your-organization.zulipchat.com or zulip.your-organization.com"/> <input class="setting-input-value" autofocus placeholder="your-organization.zulipchat.com or zulip.your-organization.com"/>
</div> </div>
<div class="server-center"> <div class="server-center">
<div class="server-save-action"> <button id="connect">${t.__('Connect')}</button>
<button id="connect">${t.__('Connect')}</button>
</div>
</div> </div>
<div class="server-center"> <div class="server-center">
<div class="divider"> <div class="divider">
@@ -35,9 +38,7 @@ class NewServerForm extends BaseComponent {
</div> </div>
</div> </div>
<div class="server-center"> <div class="server-center">
<div class="server-save-action"> <button id="open-create-org-link">${t.__('Create a new organization')}</button>
<button id="open-create-org-link">${t.__('Create a new organization')}</button>
</div>
</div> </div>
<div class="server-center"> <div class="server-center">
<div class="server-network-option"> <div class="server-network-option">
@@ -56,29 +57,36 @@ class NewServerForm extends BaseComponent {
initForm(): void { initForm(): void {
this.$newServerForm = this.generateNodeFromTemplate(this.template()); this.$newServerForm = this.generateNodeFromTemplate(this.template());
this.$saveServerButton = this.$newServerForm.querySelectorAll('.server-save-action')[0] as HTMLButtonElement; this.$saveServerButton = this.$newServerForm.querySelector('#connect');
this.props.$root.innerHTML = ''; this.props.$root.innerHTML = '';
this.props.$root.append(this.$newServerForm); this.props.$root.append(this.$newServerForm);
this.$newServerUrl = this.$newServerForm.querySelectorAll('input.setting-input-value')[0] as HTMLInputElement; this.$newServerUrl = this.$newServerForm.querySelectorAll('input.setting-input-value')[0] as HTMLInputElement;
} }
submitFormHandler(): void { async submitFormHandler(): Promise<void> {
this.$saveServerButton.children[0].innerHTML = 'Connecting...'; this.$saveServerButton.innerHTML = 'Connecting...';
DomainUtil.checkDomain(this.$newServerUrl.value).then(serverConf => { let serverConf;
DomainUtil.addDomain(serverConf).then(() => { try {
this.props.onChange(this.props.index); serverConf = await DomainUtil.checkDomain(this.$newServerUrl.value);
} catch (error) {
this.$saveServerButton.innerHTML = 'Connect';
await dialog.showMessageBox({
type: 'error',
message: error.toString(),
buttons: ['OK']
}); });
}, errorMessage => { return;
this.$saveServerButton.children[0].innerHTML = 'Connect'; }
alert(errorMessage);
}); await DomainUtil.addDomain(serverConf);
this.props.onChange();
} }
openCreateNewOrgExternalLink(): void { openCreateNewOrgExternalLink(): void {
const link = 'https://zulipchat.com/new/'; const link = 'https://zulipchat.com/new/';
const externalCreateNewOrgEl = document.querySelector('#open-create-org-link'); const externalCreateNewOrgElement = document.querySelector('#open-create-org-link');
externalCreateNewOrgEl.addEventListener('click', () => { externalCreateNewOrgElement.addEventListener('click', async () => {
shell.openExternal(link); await LinkUtil.openBrowser(new URL(link));
}); });
} }
@@ -88,20 +96,16 @@ class NewServerForm extends BaseComponent {
} }
initActions(): void { initActions(): void {
this.$saveServerButton.addEventListener('click', () => { this.$saveServerButton.addEventListener('click', async () => {
this.submitFormHandler(); await this.submitFormHandler();
}); });
this.$newServerUrl.addEventListener('keypress', event => { this.$newServerUrl.addEventListener('keypress', async event => {
const EnterkeyCode = event.keyCode; if (event.key === 'Enter') {
// Submit form when Enter key is pressed await this.submitFormHandler();
if (EnterkeyCode === 13) {
this.submitFormHandler();
} }
}); });
// open create new org link in default browser // Open create new org link in default browser
this.openCreateNewOrgExternalLink(); this.openCreateNewOrgExternalLink();
this.networkSettingsLink(); this.networkSettingsLink();
} }
} }
export = NewServerForm;

View File

@@ -1,18 +1,17 @@
'use strict'; import {ipcRenderer} from 'electron';
import { ipcRenderer } from 'electron'; import BaseComponent from '../../components/base';
import Nav from './nav';
import BaseComponent = require('../../components/base'); import ServersSection from './servers-section';
import Nav = require('./nav'); import GeneralSection from './general-section';
import ServersSection = require('./servers-section'); import NetworkSection from './network-section';
import GeneralSection = require('./general-section'); import ConnectedOrgSection from './connected-org-section';
import NetworkSection = require('./network-section'); import ShortcutsSection from './shortcuts-section';
import ConnectedOrgSection = require('./connected-org-section'); import type {DNDSettings} from '../../utils/dnd-util';
import ShortcutsSection = require('./shortcuts-section');
type Section = ServersSection | GeneralSection | NetworkSection | ConnectedOrgSection | ShortcutsSection; type Section = ServersSection | GeneralSection | NetworkSection | ConnectedOrgSection | ShortcutsSection;
class PreferenceView extends BaseComponent { export default class PreferenceView extends BaseComponent {
$sidebarContainer: Element; $sidebarContainer: Element;
$settingsContainer: Element; $settingsContainer: Element;
nav: Nav; nav: Nav;
@@ -37,8 +36,9 @@ class PreferenceView extends BaseComponent {
let nav = 'General'; let nav = 'General';
const hasTag = window.location.hash; const hasTag = window.location.hash;
if (hasTag) { if (hasTag) {
nav = hasTag.substring(1); nav = hasTag.slice(1);
} }
this.handleNavigation(nav); this.handleNavigation(nav);
} }
@@ -51,32 +51,38 @@ class PreferenceView extends BaseComponent {
}); });
break; break;
} }
case 'General': { case 'General': {
this.section = new GeneralSection({ this.section = new GeneralSection({
$root: this.$settingsContainer $root: this.$settingsContainer
}); });
break; break;
} }
case 'Organizations': { case 'Organizations': {
this.section = new ConnectedOrgSection({ this.section = new ConnectedOrgSection({
$root: this.$settingsContainer $root: this.$settingsContainer
}); });
break; break;
} }
case 'Network': { case 'Network': {
this.section = new NetworkSection({ this.section = new NetworkSection({
$root: this.$settingsContainer $root: this.$settingsContainer
}); });
break; break;
} }
case 'Shortcuts': { case 'Shortcuts': {
this.section = new ShortcutsSection({ this.section = new ShortcutsSection({
$root: this.$settingsContainer $root: this.$settingsContainer
}); });
break; break;
} }
default: break; default: break;
} }
this.section.init(); this.section.init();
window.location.hash = `#${navItem}`; window.location.hash = `#${navItem}`;
} }
@@ -107,7 +113,7 @@ class PreferenceView extends BaseComponent {
this.handleToggle('tray-option', state); this.handleToggle('tray-option', state);
}); });
ipcRenderer.on('toggle-dnd', (_event: Event, _state: boolean, newSettings: any) => { ipcRenderer.on('toggle-dnd', (_event: Event, _state: boolean, newSettings: DNDSettings) => {
this.handleToggle('show-notification-option', newSettings.showNotification); this.handleToggle('show-notification-option', newSettings.showNotification);
this.handleToggle('silent-option', newSettings.silent); this.handleToggle('silent-option', newSettings.silent);
@@ -122,5 +128,3 @@ window.addEventListener('load', () => {
const preferenceView = new PreferenceView(); const preferenceView = new PreferenceView();
preferenceView.init(); preferenceView.init();
}); });
export = PreferenceView;

View File

@@ -1,23 +1,27 @@
'use strict'; import {remote, ipcRenderer} from 'electron';
import { remote, ipcRenderer } from 'electron'; import BaseComponent from '../../components/base';
import * as DomainUtil from '../../utils/domain-util';
import * as Messages from '../../../../resources/messages';
import * as t from '../../utils/translation-util';
import BaseComponent = require('../../components/base'); const {dialog} = remote;
import DomainUtil = require('../../utils/domain-util');
import Messages = require('./../../../../resources/messages');
import t = require('../../utils/translation-util');
const { dialog } = remote; interface ServerInfoFormProps {
$root: Element;
server: DomainUtil.ServerConf;
index: number;
onChange: () => void;
}
class ServerInfoForm extends BaseComponent { export default class ServerInfoForm extends BaseComponent {
// TODO: TypeScript - Here props should be object type props: ServerInfoFormProps;
props: any;
$serverInfoForm: Element; $serverInfoForm: Element;
$serverInfoAlias: Element; $serverInfoAlias: Element;
$serverIcon: Element; $serverIcon: Element;
$deleteServerButton: Element; $deleteServerButton: Element;
$openServerButton: Element; $openServerButton: Element;
constructor(props: any) { constructor(props: ServerInfoFormProps) {
super(); super();
this.props = props; this.props = props;
} }
@@ -61,22 +65,21 @@ class ServerInfoForm extends BaseComponent {
} }
initActions(): void { initActions(): void {
this.$deleteServerButton.addEventListener('click', () => { this.$deleteServerButton.addEventListener('click', async () => {
dialog.showMessageBox({ const {response} = await dialog.showMessageBox({
type: 'warning', type: 'warning',
buttons: [t.__('YES'), t.__('NO')], buttons: [t.__('YES'), t.__('NO')],
defaultId: 0, defaultId: 0,
message: t.__('Are you sure you want to disconnect this organization?') message: t.__('Are you sure you want to disconnect this organization?')
}, response => {
if (response === 0) {
if (DomainUtil.removeDomain(this.props.index)) {
ipcRenderer.send('reload-full-app');
} else {
const { title, content } = Messages.orgRemovalError(DomainUtil.getDomain(this.props.index).url);
dialog.showErrorBox(title, content);
}
}
}); });
if (response === 0) {
if (DomainUtil.removeDomain(this.props.index)) {
ipcRenderer.send('reload-full-app');
} else {
const {title, content} = Messages.orgRemovalError(DomainUtil.getDomain(this.props.index).url);
dialog.showErrorBox(title, content);
}
}
}); });
this.$openServerButton.addEventListener('click', () => { this.$openServerButton.addEventListener('click', () => {
@@ -92,5 +95,3 @@ class ServerInfoForm extends BaseComponent {
}); });
} }
} }
export = ServerInfoForm;

View File

@@ -1,14 +1,15 @@
'use strict'; import BaseSection from './base-section';
import NewServerForm from './new-server-form';
import * as t from '../../utils/translation-util';
import BaseSection = require('./base-section'); interface ServersSectionProps {
import NewServerForm = require('./new-server-form'); $root: Element;
import t = require('../../utils/translation-util'); }
class ServersSection extends BaseSection { export default class ServersSection extends BaseSection {
// TODO: TypeScript - Here props should be object type props: ServersSectionProps;
props: any;
$newServerContainer: Element; $newServerContainer: Element;
constructor(props: any) { constructor(props: ServersSectionProps) {
super(); super();
this.props = props; this.props = props;
} }
@@ -46,5 +47,3 @@ class ServersSection extends BaseSection {
}).init(); }).init();
} }
} }
export = ServersSection;

View File

@@ -1,17 +1,18 @@
'use strict'; import BaseSection from './base-section';
import * as LinkUtil from '../../utils/link-util';
import * as t from '../../utils/translation-util';
import { shell } from 'electron'; interface ShortcutsSectionProps {
$root: Element;
}
import BaseSection = require('./base-section'); export default class ShortcutsSection extends BaseSection {
import t = require('../../utils/translation-util'); props: ShortcutsSectionProps;
constructor(props: ShortcutsSectionProps) {
class ShortcutsSection extends BaseSection {
// TODO: TypeScript - Here props should be object type
props: any;
constructor(props: any) {
super(); super();
this.props = props; this.props = props;
} }
// TODO - Deduplicate templateMac and templateWinLin functions. In theory // TODO - Deduplicate templateMac and templateWinLin functions. In theory
// they both should be the same the only thing different should be the userOSKey // they both should be the same the only thing different should be the userOSKey
// variable but there seems to be inconsistences between both function, one has more // variable but there seems to be inconsistences between both function, one has more
@@ -330,16 +331,15 @@ class ShortcutsSection extends BaseSection {
openHotkeysExternalLink(): void { openHotkeysExternalLink(): void {
const link = 'https://zulipchat.com/help/keyboard-shortcuts'; const link = 'https://zulipchat.com/help/keyboard-shortcuts';
const externalCreateNewOrgEl = document.querySelector('#open-hotkeys-link'); const externalCreateNewOrgElement = document.querySelector('#open-hotkeys-link');
externalCreateNewOrgEl.addEventListener('click', () => { externalCreateNewOrgElement.addEventListener('click', async () => {
shell.openExternal(link); await LinkUtil.openBrowser(new URL(link));
}); });
} }
init(): void { init(): void {
this.props.$root.innerHTML = (process.platform === 'darwin') ? this.props.$root.innerHTML = (process.platform === 'darwin') ?
this.templateMac() : this.templateWinLin(); this.templateMac() : this.templateWinLin();
this.openHotkeysExternalLink(); this.openHotkeysExternalLink();
} }
} }
export = ShortcutsSection;

View File

@@ -1,47 +1,31 @@
// we have and will have some non camelcase stuff import {contextBridge, ipcRenderer, webFrame} from 'electron';
// while working with zulip and electron bridge import fs from 'fs';
// so turning the rule off for the whole file. import * as SetupSpellChecker from './spellchecker';
/* eslint-disable @typescript-eslint/camelcase */
'use strict'; import isDev from 'electron-is-dev';
import { ipcRenderer, shell } from 'electron'; import * as NetworkError from './pages/network';
import SetupSpellChecker from './spellchecker';
import isDev = require('electron-is-dev');
import LinkUtil = require('./utils/link-util');
import params = require('./utils/params-util');
import NetworkError = require('./pages/network');
interface PatchedGlobal extends NodeJS.Global {
logout: () => void;
shortcut: () => void;
showNotificationSettings: () => void;
}
const globalPatched = global as PatchedGlobal;
// eslint-disable-next-line import/no-unassigned-import // eslint-disable-next-line import/no-unassigned-import
require('./notification'); import './notification';
// Prevent drag and drop event in main process which prevents remote code executaion // Prevent drag and drop event in main process which prevents remote code executaion
require(__dirname + '/shared/preventdrag.js'); // eslint-disable-next-line import/no-unassigned-import
import './shared/preventdrag';
declare let window: ZulipWebWindow; import electron_bridge from './electron-bridge';
contextBridge.exposeInMainWorld('raw_electron_bridge', electron_bridge);
window.electron_bridge = require('./electron-bridge'); ipcRenderer.on('logout', () => {
const logout = (): void => {
// Create the menu for the below // Create the menu for the below
const dropdown: HTMLElement = document.querySelector('.dropdown-toggle'); const dropdown: HTMLElement = document.querySelector('.dropdown-toggle');
dropdown.click(); dropdown.click();
const nodes: NodeListOf<HTMLElement> = document.querySelectorAll('.dropdown-menu li:last-child a'); const nodes: NodeListOf<HTMLElement> = document.querySelectorAll('.dropdown-menu li:last-child a');
nodes[nodes.length - 1].click(); nodes[nodes.length - 1].click();
}; });
const shortcut = (): void => { ipcRenderer.on('shortcut', () => {
// Create the menu for the below // Create the menu for the below
const node: HTMLElement = document.querySelector('a[data-overlay-trigger=keyboard-shortcuts]'); const node: HTMLElement = document.querySelector('a[data-overlay-trigger=keyboard-shortcuts]');
// Additional check // Additional check
@@ -52,9 +36,9 @@ const shortcut = (): void => {
const dropdown: HTMLElement = document.querySelector('.dropdown-toggle'); const dropdown: HTMLElement = document.querySelector('.dropdown-toggle');
dropdown.click(); dropdown.click();
} }
}; });
const showNotificationSettings = (): void => { ipcRenderer.on('show-notification-settings', () => {
// Create the menu for the below // Create the menu for the below
const dropdown: HTMLElement = document.querySelector('.dropdown-toggle'); const dropdown: HTMLElement = document.querySelector('.dropdown-toggle');
dropdown.click(); dropdown.click();
@@ -64,54 +48,24 @@ const showNotificationSettings = (): void => {
const notificationItem: NodeListOf<HTMLElement> = document.querySelectorAll('.normal-settings-list li div'); const notificationItem: NodeListOf<HTMLElement> = document.querySelectorAll('.normal-settings-list li div');
// wait until the notification dom element shows up // Wait until the notification dom element shows up
setTimeout(() => { setTimeout(() => {
notificationItem[2].click(); notificationItem[2].click();
}, 100); }, 100);
};
process.once('loaded', (): void => {
globalPatched.logout = logout;
globalPatched.shortcut = shortcut;
globalPatched.showNotificationSettings = showNotificationSettings;
}); });
// To prevent failing this script on linux we need to load it after the document loaded electron_bridge.once('zulip-loaded', ({serverLanguage}) => {
document.addEventListener('DOMContentLoaded', (): void => {
if (params.isPageParams()) {
// Get the default language of the server // Get the default language of the server
const serverLanguage = page_params.default_language; // eslint-disable-line no-undef if (serverLanguage) {
if (serverLanguage) { // Init spellchecker
// Init spellchecker SetupSpellChecker.init(serverLanguage);
SetupSpellChecker.init(serverLanguage); }
}
// 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 (this: HTMLElement, e: Event) {
const url = $(this).attr('href');
if (LinkUtil.isImage(url)) { // Redirect users to network troubleshooting page
const $img = $(this).parent().siblings('.message_inline_image').find('img'); const getRestartButton = document.querySelector('.restart_get_events_button');
if (getRestartButton) {
// prevent the image link from opening in a new page. getRestartButton.addEventListener('click', () => {
e.preventDefault(); ipcRenderer.send('forward-message', 'reload-viewer');
// 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);
}
}); });
} }
}); });
@@ -126,12 +80,13 @@ window.addEventListener('load', (event: any): void => {
if (!event.target.URL.includes('app/renderer/network.html')) { if (!event.target.URL.includes('app/renderer/network.html')) {
return; return;
} }
const $reconnectButton = document.querySelector('#reconnect'); const $reconnectButton = document.querySelector('#reconnect');
const $settingsButton = document.querySelector('#settings'); const $settingsButton = document.querySelector('#settings');
NetworkError.init($reconnectButton, $settingsButton); NetworkError.init($reconnectButton, $settingsButton);
}); });
// electron's globalShortcut can cause unexpected results // Electron's globalShortcut can cause unexpected results
// so adding the reload shortcut in the old-school way // so adding the reload shortcut in the old-school way
// Zoom from numpad keys is not supported by electron, so adding it through listeners. // Zoom from numpad keys is not supported by electron, so adding it through listeners.
document.addEventListener('keydown', event => { document.addEventListener('keydown', event => {
@@ -152,8 +107,9 @@ ipcRenderer.on('set-active', () => {
if (isDev) { if (isDev) {
console.log('active'); console.log('active');
} }
window.electron_bridge.idle_on_system = false;
window.electron_bridge.last_active_on_system = Date.now(); electron_bridge.idle_on_system = false;
electron_bridge.last_active_on_system = Date.now();
}); });
// Set user as idle and time of last activity is left unchanged // Set user as idle and time of last activity is left unchanged
@@ -161,5 +117,10 @@ ipcRenderer.on('set-idle', () => {
if (isDev) { if (isDev) {
console.log('idle'); console.log('idle');
} }
window.electron_bridge.idle_on_system = true;
electron_bridge.idle_on_system = true;
}); });
(async () => webFrame.executeJavaScript(
fs.readFileSync(require.resolve('./injected'), 'utf8')
))();

View File

@@ -1,5 +1,3 @@
'use strict';
// This is a security fix. Following function prevents drag and drop event in the app // This is a security fix. Following function prevents drag and drop event in the app
// so that attackers can't execute any remote code within the app // so that attackers can't execute any remote code within the app
// It doesn't affect the compose box so that users can still // It doesn't affect the compose box so that users can still
@@ -15,3 +13,5 @@ const preventDragAndDrop = (): void => {
}; };
preventDragAndDrop(); preventDragAndDrop();
export {};

View File

@@ -1,56 +1,61 @@
'use strict'; import type {Subject} from 'rxjs';
import {SpellCheckHandler, ContextMenuListener, ContextMenuBuilder} from 'electron-spellchecker';
import { SpellCheckHandler, ContextMenuListener, ContextMenuBuilder } from 'electron-spellchecker'; import * as ConfigUtil from './utils/config-util';
import Logger from './utils/logger-util';
import ConfigUtil = require('./utils/config-util'); declare module 'electron-spellchecker' {
import Logger = require('./utils/logger-util'); interface SpellCheckHandler {
currentSpellcheckerChanged: Subject<true>;
currentSpellcheckerLanguage: string;
}
}
const logger = new Logger({ const logger = new Logger({
file: 'errors.log', file: 'errors.log',
timestamp: true timestamp: true
}); });
class SetupSpellChecker { let spellCheckHandler: SpellCheckHandler;
SpellCheckHandler: typeof SpellCheckHandler; let contextMenuListener: ContextMenuListener;
contextMenuListener: typeof ContextMenuListener;
init(serverLanguage: string): void { export function init(serverLanguage: string): void {
if (ConfigUtil.getConfigItem('enableSpellchecker')) { if (ConfigUtil.getConfigItem('enableSpellchecker')) {
this.enableSpellChecker(); enableSpellChecker();
}
this.enableContextMenu(serverLanguage);
} }
enableSpellChecker(): void { enableContextMenu(serverLanguage);
try { }
this.SpellCheckHandler = new SpellCheckHandler();
} catch (err) {
logger.error(err);
}
}
enableContextMenu(serverLanguage: string): void { function enableSpellChecker(): void {
if (this.SpellCheckHandler) { try {
this.SpellCheckHandler.attachToInput(); spellCheckHandler = new SpellCheckHandler();
this.SpellCheckHandler.switchLanguage(serverLanguage); } catch (error) {
this.SpellCheckHandler.currentSpellcheckerChanged.subscribe(() => { logger.error(error);
this.SpellCheckHandler.switchLanguage(this.SpellCheckHandler.currentSpellcheckerLanguage);
});
}
const contextMenuBuilder = new ContextMenuBuilder(this.SpellCheckHandler);
this.contextMenuListener = new ContextMenuListener((info: object) => {
contextMenuBuilder.showPopupMenu(info);
});
}
unsubscribeSpellChecker(): void {
if (this.SpellCheckHandler) {
this.SpellCheckHandler.unsubscribe();
}
if (this.contextMenuListener) {
this.contextMenuListener.unsubscribe();
}
} }
} }
export = new SetupSpellChecker(); function enableContextMenu(serverLanguage: string): void {
if (spellCheckHandler) {
spellCheckHandler.attachToInput();
spellCheckHandler.switchLanguage(serverLanguage);
spellCheckHandler.currentSpellcheckerChanged.subscribe(() => {
spellCheckHandler.switchLanguage(spellCheckHandler.currentSpellcheckerLanguage);
});
}
const contextMenuBuilder = new ContextMenuBuilder(spellCheckHandler);
contextMenuListener = new ContextMenuListener(info => {
contextMenuBuilder.showPopupMenu(info);
});
}
export function unsubscribeSpellChecker(): void {
if (spellCheckHandler) {
spellCheckHandler.unsubscribe();
}
if (contextMenuListener) {
contextMenuListener.unsubscribe();
}
}

View File

@@ -1,18 +1,26 @@
'use strict'; import {ipcRenderer, remote, WebviewTag, NativeImage} from 'electron';
import { ipcRenderer, remote, WebviewTag, NativeImage } from 'electron';
import path = require('path'); import path from 'path';
import ConfigUtil = require('./utils/config-util.js'); import * as ConfigUtil from './utils/config-util';
const { Tray, Menu, nativeImage, BrowserWindow } = remote;
const APP_ICON = path.join(__dirname, '../../resources/tray', 'tray'); const {Tray, Menu, nativeImage, BrowserWindow, nativeTheme} = remote;
declare let window: ZulipWebWindow; let tray: Electron.Tray;
// Get the theme on macOS
const theme = nativeTheme.shouldUseDarkColors ? 'dark' : 'light';
const ICON_DIR = process.platform === 'darwin' ? `../../resources/tray/${theme}` : '../../resources/tray';
const TRAY_SUFFIX = 'tray';
const APP_ICON = path.join(__dirname, ICON_DIR, TRAY_SUFFIX);
const iconPath = (): string => { const iconPath = (): string => {
if (process.platform === 'linux') { if (process.platform === 'linux') {
return APP_ICON + 'linux.png'; return APP_ICON + 'linux.png';
} }
return APP_ICON + (process.platform === 'win32' ? 'win.ico' : 'osx.png'); return APP_ICON + (process.platform === 'win32' ? 'win.ico' : 'osx.png');
}; };
@@ -43,69 +51,60 @@ const config = {
thick: process.platform === 'win32' thick: process.platform === 'win32'
}; };
const renderCanvas = function (arg: number): Promise<HTMLCanvasElement> { const renderCanvas = function (arg: number): HTMLCanvasElement {
config.unreadCount = arg; config.unreadCount = arg;
return new Promise(resolve => { const SIZE = config.size * config.pixelRatio;
const SIZE = config.size * config.pixelRatio; const PADDING = SIZE * 0.05;
const PADDING = SIZE * 0.05; const CENTER = SIZE / 2;
const CENTER = SIZE / 2; const HAS_COUNT = config.showUnreadCount && config.unreadCount;
const HAS_COUNT = config.showUnreadCount && config.unreadCount; const color = config.unreadCount ? config.unreadColor : config.readColor;
const color = config.unreadCount ? config.unreadColor : config.readColor; const backgroundColor = config.unreadCount ? config.unreadBackgroundColor : config.readBackgroundColor;
const backgroundColor = config.unreadCount ? config.unreadBackgroundColor : config.readBackgroundColor;
const canvas = document.createElement('canvas'); const canvas = document.createElement('canvas');
canvas.width = SIZE; canvas.width = SIZE;
canvas.height = SIZE; canvas.height = SIZE;
const ctx = canvas.getContext('2d'); const ctx = canvas.getContext('2d');
// Circle // Circle
// If (!config.thick || config.thick && HAS_COUNT) { // If (!config.thick || config.thick && HAS_COUNT) {
ctx.beginPath(); ctx.beginPath();
ctx.arc(CENTER, CENTER, (SIZE / 2) - PADDING, 0, 2 * Math.PI, false); ctx.arc(CENTER, CENTER, (SIZE / 2) - PADDING, 0, 2 * Math.PI, false);
ctx.fillStyle = backgroundColor; ctx.fillStyle = backgroundColor;
ctx.fill(); ctx.fill();
ctx.lineWidth = SIZE / (config.thick ? 10 : 20); ctx.lineWidth = SIZE / (config.thick ? 10 : 20);
ctx.strokeStyle = backgroundColor; ctx.strokeStyle = backgroundColor;
ctx.stroke(); ctx.stroke();
// Count or Icon // Count or Icon
if (HAS_COUNT) { if (HAS_COUNT) {
ctx.fillStyle = color; ctx.fillStyle = color;
ctx.textAlign = 'center'; ctx.textAlign = 'center';
if (config.unreadCount > 99) { if (config.unreadCount > 99) {
ctx.font = `${config.thick ? 'bold ' : ''}${SIZE * 0.4}px Helvetica`; ctx.font = `${config.thick ? 'bold ' : ''}${SIZE * 0.4}px Helvetica`;
ctx.fillText('99+', CENTER, CENTER + (SIZE * 0.15)); ctx.fillText('99+', CENTER, CENTER + (SIZE * 0.15));
} else if (config.unreadCount < 10) { } else if (config.unreadCount < 10) {
ctx.font = `${config.thick ? 'bold ' : ''}${SIZE * 0.5}px Helvetica`; ctx.font = `${config.thick ? 'bold ' : ''}${SIZE * 0.5}px Helvetica`;
ctx.fillText(String(config.unreadCount), CENTER, CENTER + (SIZE * 0.20)); ctx.fillText(String(config.unreadCount), CENTER, CENTER + (SIZE * 0.2));
} else { } else {
ctx.font = `${config.thick ? 'bold ' : ''}${SIZE * 0.5}px Helvetica`; ctx.font = `${config.thick ? 'bold ' : ''}${SIZE * 0.5}px Helvetica`;
ctx.fillText(String(config.unreadCount), CENTER, CENTER + (SIZE * 0.15)); ctx.fillText(String(config.unreadCount), CENTER, CENTER + (SIZE * 0.15));
}
resolve(canvas);
} }
}); }
return canvas;
}; };
/** /**
* Renders the tray icon as a native image * Renders the tray icon as a native image
* @param arg: Unread count * @param arg: Unread count
* @return the native image * @return the native image
*/ */
const renderNativeImage = function (arg: number): Promise<NativeImage> { const renderNativeImage = function (arg: number): NativeImage {
return Promise.resolve() const canvas = renderCanvas(arg);
.then(() => renderCanvas(arg)) const pngData = nativeImage.createFromDataURL(canvas.toDataURL('image/png')).toPNG();
.then(canvas => { return nativeImage.createFromBuffer(pngData, {
const pngData = nativeImage.createFromDataURL(canvas.toDataURL('image/png')).toPNG(); scaleFactor: config.pixelRatio
});
// TODO: Fix the function to correctly use Promise correctly.
// the Promise.resolve().then(...) above is useless we should
// start with renderCanvas(arg).then
// eslint-disable-next-line promise/no-return-wrap
return Promise.resolve(nativeImage.createFromBuffer(pngData, {
scaleFactor: config.pixelRatio
}));
});
}; };
function sendAction(action: string): void { function sendAction(action: string): void {
@@ -119,7 +118,6 @@ function sendAction(action: string): void {
} }
const createTray = function (): void { const createTray = function (): void {
window.tray = new Tray(iconPath());
const contextMenu = Menu.buildFromTemplate([ const contextMenu = Menu.buildFromTemplate([
{ {
label: 'Zulip', label: 'Zulip',
@@ -144,22 +142,23 @@ const createTray = function (): void {
} }
} }
]); ]);
window.tray.setContextMenu(contextMenu); tray = new Tray(iconPath());
tray.setContextMenu(contextMenu);
if (process.platform === 'linux' || process.platform === 'win32') { if (process.platform === 'linux' || process.platform === 'win32') {
window.tray.on('click', () => { tray.on('click', () => {
ipcRenderer.send('toggle-app'); ipcRenderer.send('toggle-app');
}); });
} }
}; };
ipcRenderer.on('destroytray', (event: Event): Event => { ipcRenderer.on('destroytray', (event: Event): Event => {
if (!window.tray) { if (!tray) {
return undefined; return undefined;
} }
window.tray.destroy(); tray.destroy();
if (window.tray.isDestroyed()) { if (tray.isDestroyed()) {
window.tray = null; tray = null;
} else { } else {
throw new Error('Tray icon not properly destroyed.'); throw new Error('Tray icon not properly destroyed.');
} }
@@ -168,45 +167,47 @@ ipcRenderer.on('destroytray', (event: Event): Event => {
}); });
ipcRenderer.on('tray', (_event: Event, arg: number): void => { ipcRenderer.on('tray', (_event: Event, arg: number): void => {
if (!window.tray) { if (!tray) {
return; return;
} }
// We don't want to create tray from unread messages on macOS since it already has dock badges. // We don't want to create tray from unread messages on macOS since it already has dock badges.
if (process.platform === 'linux' || process.platform === 'win32') { if (process.platform === 'linux' || process.platform === 'win32') {
if (arg === 0) { if (arg === 0) {
unread = arg; unread = arg;
window.tray.setImage(iconPath()); tray.setImage(iconPath());
window.tray.setToolTip('No unread messages'); tray.setToolTip('No unread messages');
} else { } else {
unread = arg; unread = arg;
renderNativeImage(arg).then(image => { const image = renderNativeImage(arg);
window.tray.setImage(image); tray.setImage(image);
window.tray.setToolTip(arg + ' unread messages'); tray.setToolTip(`${arg} unread messages`);
});
} }
} }
}); });
function toggleTray(): void { function toggleTray(): void {
let state; let state;
if (window.tray) { if (tray) {
state = false; state = false;
window.tray.destroy(); tray.destroy();
if (window.tray.isDestroyed()) { if (tray.isDestroyed()) {
window.tray = null; tray = null;
} }
ConfigUtil.setConfigItem('trayIcon', false); ConfigUtil.setConfigItem('trayIcon', false);
} else { } else {
state = true; state = true;
createTray(); createTray();
if (process.platform === 'linux' || process.platform === 'win32') { if (process.platform === 'linux' || process.platform === 'win32') {
renderNativeImage(unread).then(image => { const image = renderNativeImage(unread);
window.tray.setImage(image); tray.setImage(image);
window.tray.setToolTip(unread + ' unread messages'); tray.setToolTip(`${unread} unread messages`);
});
} }
ConfigUtil.setConfigItem('trayIcon', true); ConfigUtil.setConfigItem('trayIcon', true);
} }
const selector = 'webview:not([class*=disabled])'; const selector = 'webview:not([class*=disabled])';
const webview: WebviewTag = document.querySelector(selector); const webview: WebviewTag = document.querySelector(selector);
const webContents = webview.getWebContents(); const webContents = webview.getWebContents();
@@ -218,3 +219,5 @@ ipcRenderer.on('toggletray', toggleTray);
if (ConfigUtil.getConfigItem('trayIcon', true)) { if (ConfigUtil.getConfigItem('trayIcon', true)) {
createTray(); createTray();
} }
export {};

View File

@@ -1,96 +1,78 @@
'use strict'; import electron from 'electron';
import {JsonDB} from 'node-json-db';
import {initSetUp} from './default-util';
import { remote } from 'electron'; import fs from 'fs';
import JsonDB from 'node-json-db'; import path from 'path';
import { initSetUp } from './default-util'; import Logger from './logger-util';
import fs = require('fs'); const {app, dialog} =
import path = require('path'); process.type === 'renderer' ? electron.remote : electron;
import Logger = require('./logger-util');
const { app, dialog } = remote;
initSetUp(); initSetUp();
const logger = new Logger({ const logger = new Logger({
file: `certificate-util.log`, file: 'certificate-util.log',
timestamp: true timestamp: true
}); });
let instance: null | CertificateUtil = null;
const certificatesDir = `${app.getPath('userData')}/certificates`; const certificatesDir = `${app.getPath('userData')}/certificates`;
class CertificateUtil { let db: JsonDB;
db: JsonDB;
constructor() { reloadDB();
if (instance) {
return instance;
} else {
instance = this;
}
this.reloadDB(); export function getCertificate(server: string): string | undefined {
return instance; reloadDB();
} return db.getData('/')[server];
getCertificate(server: string, defaultValue: any = null): any {
this.reloadDB();
const value = this.db.getData('/')[server];
if (value === undefined) {
return defaultValue;
} else {
return value;
}
}
// Function to copy the certificate to userData folder
copyCertificate(_server: string, location: string, fileName: string): boolean {
let copied = false;
const filePath = `${certificatesDir}/${fileName}`;
try {
fs.copyFileSync(location, filePath);
copied = true;
} catch (err) {
dialog.showErrorBox(
'Error saving certificate',
'We encountered error while saving the certificate.'
);
logger.error('Error while copying the certificate to certificates folder.');
logger.error(err);
}
return copied;
}
setCertificate(server: string, fileName: string): void {
const filePath = `${fileName}`;
this.db.push(`/${server}`, filePath, true);
this.reloadDB();
}
removeCertificate(server: string): void {
this.db.delete(`/${server}`);
this.reloadDB();
}
reloadDB(): void {
const settingsJsonPath = path.join(app.getPath('userData'), '/config/certificates.json');
try {
const file = fs.readFileSync(settingsJsonPath, 'utf8');
JSON.parse(file);
} catch (err) {
if (fs.existsSync(settingsJsonPath)) {
fs.unlinkSync(settingsJsonPath);
dialog.showErrorBox(
'Error saving settings',
'We encountered error while saving the certificate.'
);
logger.error('Error while JSON parsing certificates.json: ');
logger.error(err);
}
}
this.db = new JsonDB(settingsJsonPath, true, true);
}
} }
export = new CertificateUtil(); // Function to copy the certificate to userData folder
export function copyCertificate(_server: string, location: string, fileName: string): boolean {
let copied = false;
const filePath = `${certificatesDir}/${fileName}`;
try {
fs.copyFileSync(location, filePath);
copied = true;
} catch (error) {
dialog.showErrorBox(
'Error saving certificate',
'We encountered error while saving the certificate.'
);
logger.error('Error while copying the certificate to certificates folder.');
logger.error(error);
}
return copied;
}
export function setCertificate(server: string, fileName: string): void {
const filePath = `${fileName}`;
db.push(`/${server}`, filePath, true);
reloadDB();
}
export function removeCertificate(server: string): void {
db.delete(`/${server}`);
reloadDB();
}
function reloadDB(): void {
const settingsJsonPath = path.join(app.getPath('userData'), '/config/certificates.json');
try {
const file = fs.readFileSync(settingsJsonPath, 'utf8');
JSON.parse(file);
} catch (error) {
if (fs.existsSync(settingsJsonPath)) {
fs.unlinkSync(settingsJsonPath);
dialog.showErrorBox(
'Error saving settings',
'We encountered error while saving the certificate.'
);
logger.error('Error while JSON parsing certificates.json: ');
logger.error(error);
}
}
db = new JsonDB(settingsJsonPath, true, true);
}

View File

@@ -1,25 +1,8 @@
'use strict'; // Unescape already encoded/escaped strings
export function decodeString(stringInput: string): string {
let instance: null | CommonUtil = null; const parser = new DOMParser();
const dom = parser.parseFromString(
class CommonUtil { '<!doctype html><body>' + stringInput,
constructor() { 'text/html');
if (instance) { return dom.body.textContent;
return instance;
} else {
instance = this;
}
return instance;
}
// unescape already encoded/escaped strings
decodeString(stringInput: string): string {
const parser = new DOMParser();
const dom = parser.parseFromString(
'<!doctype html><body>' + stringInput,
'text/html');
return dom.body.textContent;
}
} }
export = new CommonUtil();

View File

@@ -1,24 +1,22 @@
'use strict'; import {JsonDB} from 'node-json-db';
import JsonDB from 'node-json-db';
import fs = require('fs'); import fs from 'fs';
import path = require('path'); import path from 'path';
import electron = require('electron'); import electron from 'electron';
import Logger = require('./logger-util'); import Logger from './logger-util';
import EnterpriseUtil = require('./enterprise-util'); import * as EnterpriseUtil from './enterprise-util';
const logger = new Logger({ const logger = new Logger({
file: 'config-util.log', file: 'config-util.log',
timestamp: true timestamp: true
}); });
let instance: null | ConfigUtil = null;
let dialog: Electron.Dialog = null; let dialog: Electron.Dialog = null;
let app: Electron.App = null; let app: Electron.App = null;
/* To make the util runnable in both main and renderer process */ /* To make the util runnable in both main and renderer process */
if (process.type === 'renderer') { if (process.type === 'renderer') {
const { remote } = electron; const {remote} = electron;
dialog = remote.dialog; dialog = remote.dialog;
app = remote.app; app = remote.app;
} else { } else {
@@ -26,81 +24,82 @@ if (process.type === 'renderer') {
app = electron.app; app = electron.app;
} }
class ConfigUtil { let db: JsonDB;
db: JsonDB;
constructor() { reloadDB();
if (instance) {
return instance;
} else {
instance = this;
}
this.reloadDB(); export function getConfigItem(key: string, defaultValue: unknown = null): any {
return instance; try {
db.reload();
} catch (error) {
logger.error('Error while reloading settings.json: ');
logger.error(error);
} }
getConfigItem(key: string, defaultValue: any = null): any { const value = db.getData('/')[key];
try { if (value === undefined) {
this.db.reload(); setConfigItem(key, defaultValue);
} catch (err) { return defaultValue;
logger.error('Error while reloading settings.json: ');
logger.error(err);
}
const value = this.db.getData('/')[key];
if (value === undefined) {
this.setConfigItem(key, defaultValue);
return defaultValue;
} else {
return value;
}
} }
// This function returns whether a key exists in the configuration file (settings.json) return value;
isConfigItemExists(key: string): boolean {
try {
this.db.reload();
} catch (err) {
logger.error('Error while reloading settings.json: ');
logger.error(err);
}
const value = this.db.getData('/')[key];
return (value !== undefined);
}
setConfigItem(key: string, value: any, override? : boolean): void {
if (EnterpriseUtil.configItemExists(key) && !override) {
// if item is in global config and we're not trying to override
return;
}
this.db.push(`/${key}`, value, true);
this.db.save();
}
removeConfigItem(key: string): void {
this.db.delete(`/${key}`);
this.db.save();
}
reloadDB(): void {
const settingsJsonPath = path.join(app.getPath('userData'), '/config/settings.json');
try {
const file = fs.readFileSync(settingsJsonPath, 'utf8');
JSON.parse(file);
} catch (err) {
if (fs.existsSync(settingsJsonPath)) {
fs.unlinkSync(settingsJsonPath);
dialog.showErrorBox(
'Error saving settings',
'We encountered an error while saving the settings.'
);
logger.error('Error while JSON parsing settings.json: ');
logger.error(err);
logger.reportSentry(err);
}
}
this.db = new JsonDB(settingsJsonPath, true, true);
}
} }
export = new ConfigUtil(); export function getConfigString(key: string, defaultValue: string): string {
const value = getConfigItem(key, defaultValue);
if (typeof value === 'string') {
return value;
}
setConfigItem(key, defaultValue);
return defaultValue;
}
// This function returns whether a key exists in the configuration file (settings.json)
export function isConfigItemExists(key: string): boolean {
try {
db.reload();
} catch (error) {
logger.error('Error while reloading settings.json: ');
logger.error(error);
}
const value = db.getData('/')[key];
return (value !== undefined);
}
export function setConfigItem(key: string, value: unknown, override? : boolean): void {
if (EnterpriseUtil.configItemExists(key) && !override) {
// If item is in global config and we're not trying to override
return;
}
db.push(`/${key}`, value, true);
db.save();
}
export function removeConfigItem(key: string): void {
db.delete(`/${key}`);
db.save();
}
function reloadDB(): void {
const settingsJsonPath = path.join(app.getPath('userData'), '/config/settings.json');
try {
const file = fs.readFileSync(settingsJsonPath, 'utf8');
JSON.parse(file);
} catch (error) {
if (fs.existsSync(settingsJsonPath)) {
fs.unlinkSync(settingsJsonPath);
dialog.showErrorBox(
'Error saving settings',
'We encountered an error while saving the settings.'
);
logger.error('Error while JSON parsing settings.json: ');
logger.error(error);
logger.reportSentry(error);
}
}
db = new JsonDB(settingsJsonPath, true, true);
}

View File

@@ -1,11 +1,12 @@
import fs = require('fs'); import electron from 'electron';
import fs from 'fs';
let app: Electron.App = null; let app: Electron.App = null;
let setupCompleted = false; let setupCompleted = false;
if (process.type === 'renderer') { if (process.type === 'renderer') {
app = require('electron').remote.app; app = electron.remote.app;
} else { } else {
app = require('electron').app; app = electron.app;
} }
const zulipDir = app.getPath('userData'); const zulipDir = app.getPath('userData');
@@ -13,7 +14,7 @@ const logDir = `${zulipDir}/Logs/`;
const certificatesDir = `${zulipDir}/certificates/`; const certificatesDir = `${zulipDir}/certificates/`;
const configDir = `${zulipDir}/config/`; const configDir = `${zulipDir}/config/`;
export const initSetUp = (): void => { export const initSetUp = (): void => {
// if it is the first time the app is running // If it is the first time the app is running
// create zulip dir in userData folder to // create zulip dir in userData folder to
// avoid errors // avoid errors
if (!setupCompleted) { if (!setupCompleted) {
@@ -41,19 +42,19 @@ export const initSetUp = (): void => {
const configData = [ const configData = [
{ {
path: domainJson, path: domainJson,
fileName: `domain.json` fileName: 'domain.json'
}, },
{ {
path: certificatesJson, path: certificatesJson,
fileName: `certificates.json` fileName: 'certificates.json'
}, },
{ {
path: settingsJson, path: settingsJson,
fileName: `settings.json` fileName: 'settings.json'
}, },
{ {
path: updatesJson, path: updatesJson,
fileName: `updates.json` fileName: 'updates.json'
} }
]; ];
configData.forEach(data => { configData.forEach(data => {
@@ -62,7 +63,7 @@ export const initSetUp = (): void => {
fs.unlinkSync(data.path); fs.unlinkSync(data.path);
} }
}); });
// window-state.json is only deleted not moved, as the electron-window-state // `window-state.json` is only deleted not moved, as the electron-window-state
// package will recreate the file in the config folder. // package will recreate the file in the config folder.
if (fs.existsSync(windowStateJson)) { if (fs.existsSync(windowStateJson)) {
fs.unlinkSync(windowStateJson); fs.unlinkSync(windowStateJson);

View File

@@ -1,30 +1,28 @@
'use strict'; import * as ConfigUtil from './config-util';
import ConfigUtil = require('./config-util'); type SettingName = 'showNotification' | 'silent' | 'flashTaskbarOnMessage';
// TODO: TypeScript - add to Setting interface export interface DNDSettings {
// the list of settings since we have fixed amount of them showNotification?: boolean;
// We want to do this by creating a new module that exports silent?: boolean;
// this interface flashTaskbarOnMessage?: boolean;
interface Setting {
[key: string]: any;
} }
interface Toggle { interface Toggle {
dnd: boolean; dnd: boolean;
newSettings: Setting; newSettings: DNDSettings;
} }
export function toggle(): Toggle { export function toggle(): Toggle {
const dnd = !ConfigUtil.getConfigItem('dnd', false); const dnd = !ConfigUtil.getConfigItem('dnd', false);
const dndSettingList = ['showNotification', 'silent']; const dndSettingList: SettingName[] = ['showNotification', 'silent'];
if (process.platform === 'win32') { if (process.platform === 'win32') {
dndSettingList.push('flashTaskbarOnMessage'); dndSettingList.push('flashTaskbarOnMessage');
} }
let newSettings: Setting; let newSettings: DNDSettings;
if (dnd) { if (dnd) {
const oldSettings: Setting = {}; const oldSettings: DNDSettings = {};
newSettings = {}; newSettings = {};
// Iterate through the dndSettingList. // Iterate through the dndSettingList.

View File

@@ -1,331 +1,321 @@
'use strict'; import {JsonDB} from 'node-json-db';
import JsonDB from 'node-json-db';
import escape = require('escape-html'); import escape from 'escape-html';
import request = require('request'); import request from 'request';
import fs = require('fs'); import fs from 'fs';
import path = require('path'); import path from 'path';
import Logger = require('./logger-util'); import Logger from './logger-util';
import electron = require('electron'); import {remote} from 'electron';
import RequestUtil = require('./request-util'); import * as RequestUtil from './request-util';
import EnterpriseUtil = require('./enterprise-util'); import * as EnterpriseUtil from './enterprise-util';
import Messages = require('../../../resources/messages'); import * as Messages from '../../../resources/messages';
const { ipcRenderer } = electron; const {app, dialog} = remote;
const { app, dialog } = electron.remote;
export interface ServerConf {
url: string;
alias?: string;
icon?: string;
ignoreCerts?: boolean;
}
const logger = new Logger({ const logger = new Logger({
file: `domain-util.log`, file: 'domain-util.log',
timestamp: true timestamp: true
}); });
let instance: null | DomainUtil = null;
const defaultIconUrl = '../renderer/img/icon.png'; const defaultIconUrl = '../renderer/img/icon.png';
class DomainUtil { let db: JsonDB;
db: JsonDB;
constructor() {
if (instance) {
return instance;
} else {
instance = this;
}
this.reloadDB(); reloadDB();
// Migrate from old schema // Migrate from old schema
if (this.db.getData('/').domain) { if (db.getData('/').domain) {
this.addDomain({ (async () => {
alias: 'Zulip', await addDomain({
url: this.db.getData('/domain') alias: 'Zulip',
}); url: db.getData('/domain')
this.db.delete('/domain');
}
return instance;
}
getDomains(): any {
this.reloadDB();
if (this.db.getData('/').domains === undefined) {
return [];
} else {
return this.db.getData('/domains');
}
}
getDomain(index: number): any {
this.reloadDB();
return this.db.getData(`/domains[${index}]`);
}
shouldIgnoreCerts(url: string): boolean {
const domains = this.getDomains();
for (const domain of domains) {
if (domain.url === url) {
return domain.ignoreCerts;
}
}
return null;
}
updateDomain(index: number, server: object): void {
this.reloadDB();
this.db.push(`/domains[${index}]`, server, true);
}
addDomain(server: any): Promise<void> {
const { ignoreCerts } = server;
return new Promise(resolve => {
if (server.icon) {
this.saveServerIcon(server, ignoreCerts).then(localIconUrl => {
server.icon = localIconUrl;
this.db.push('/domains[]', server, true);
this.reloadDB();
resolve();
});
} else {
server.icon = defaultIconUrl;
this.db.push('/domains[]', server, true);
this.reloadDB();
resolve();
}
}); });
db.delete('/domain');
})();
}
export function getDomains(): ServerConf[] {
reloadDB();
if (db.getData('/').domains === undefined) {
return [];
} }
removeDomains(): void { return db.getData('/domains');
this.db.delete('/domains'); }
this.reloadDB();
}
removeDomain(index: number): boolean { export function getDomain(index: number): ServerConf {
if (EnterpriseUtil.isPresetOrg(this.getDomain(index).url)) { reloadDB();
return false; return db.getData(`/domains[${index}]`);
}
export function shouldIgnoreCerts(url: string): boolean {
const domains = getDomains();
for (const domain of domains) {
if (domain.url === url) {
return domain.ignoreCerts;
} }
this.db.delete(`/domains[${index}]`);
this.reloadDB();
return true;
} }
// Check if domain is already added return null;
duplicateDomain(domain: any): boolean { }
domain = this.formatUrl(domain);
const servers = this.getDomains(); export function updateDomain(index: number, server: ServerConf): void {
for (const i in servers) { reloadDB();
if (servers[i].url === domain) { db.push(`/domains[${index}]`, server, true);
return true; }
}
} export async function addDomain(server: ServerConf): Promise<void> {
const {ignoreCerts} = server;
if (server.icon) {
const localIconUrl = await saveServerIcon(server, ignoreCerts);
server.icon = localIconUrl;
db.push('/domains[]', server, true);
reloadDB();
} else {
server.icon = defaultIconUrl;
db.push('/domains[]', server, true);
reloadDB();
}
}
export function removeDomains(): void {
db.delete('/domains');
reloadDB();
}
export function removeDomain(index: number): boolean {
if (EnterpriseUtil.isPresetOrg(getDomain(index).url)) {
return false; return false;
} }
async checkCertError(domain: any, serverConf: any, error: string, silent: boolean): Promise<string | object> { db.delete(`/domains[${index}]`);
if (silent) { reloadDB();
// since getting server settings has already failed return true;
return serverConf; }
} else {
// Report error to sentry to get idea of possible certificate errors
// users get when adding the servers
logger.reportSentry(new Error(error).toString());
const certErrorMessage = Messages.certErrorMessage(domain, error);
const certErrorDetail = Messages.certErrorDetail();
const response = await (dialog.showMessageBox({ // Check if domain is already added
type: 'warning', export function duplicateDomain(domain: string): boolean {
buttons: ['Yes', 'No'], domain = formatUrl(domain);
defaultId: 1, return getDomains().some(server => server.url === domain);
message: certErrorMessage, }
detail: certErrorDetail
}) as any); // TODO: TypeScript - Figure this out async function checkCertError(domain: string, serverConf: ServerConf, error: any, silent: boolean): Promise<ServerConf> {
if (response === 0) { if (silent) {
// set ignoreCerts parameter to true in case user responds with yes // Since getting server settings has already failed
serverConf.ignoreCerts = true; return serverConf;
try {
return await this.getServerSettings(domain, serverConf.ignoreCerts);
} catch (_) {
if (error === Messages.noOrgsError(domain)) {
throw new Error(error);
}
return serverConf;
}
} else {
throw new Error('Untrusted certificate.');
}
}
} }
// ignoreCerts parameter helps in fetching server icon and // Report error to sentry to get idea of possible certificate errors
// other server details when user chooses to ignore certificate warnings // users get when adding the servers
async checkDomain(domain: any, ignoreCerts = false, silent = false): Promise<any> { logger.reportSentry(error);
if (!silent && this.duplicateDomain(domain)) { const certErrorMessage = Messages.certErrorMessage(domain, error);
// Do not check duplicate in silent mode const certErrorDetail = Messages.certErrorDetail();
throw new Error('This server has been added.');
}
domain = this.formatUrl(domain);
const serverConf = {
icon: defaultIconUrl,
url: domain,
alias: domain,
ignoreCerts
};
const {response} = await dialog.showMessageBox({
type: 'warning',
buttons: ['Yes', 'No'],
defaultId: 1,
message: certErrorMessage,
detail: certErrorDetail
});
if (response === 0) {
// Set ignoreCerts parameter to true in case user responds with yes
serverConf.ignoreCerts = true;
try { try {
return await this.getServerSettings(domain, serverConf.ignoreCerts); return await getServerSettings(domain, serverConf.ignoreCerts);
} catch (err) { } catch (_) {
// If the domain contains following strings we just bypass the server if (error === Messages.noOrgsError(domain)) {
const whitelistDomains = [ throw new Error(error);
'zulipdev.org'
];
// make sure that error is an error or string not undefined
// so validation does not throw error.
const error = err || '';
const certsError = error.toString().includes('certificate');
if (domain.indexOf(whitelistDomains) >= 0 || certsError) {
return this.checkCertError(domain, serverConf, error, silent);
} else {
throw Messages.invalidZulipServerError(domain);
} }
return serverConf;
} }
} else {
throw new Error('Untrusted certificate.');
}
}
// ignoreCerts parameter helps in fetching server icon and
// other server details when user chooses to ignore certificate warnings
export async function checkDomain(domain: string, ignoreCerts = false, silent = false): Promise<ServerConf> {
if (!silent && duplicateDomain(domain)) {
// Do not check duplicate in silent mode
throw new Error('This server has been added.');
} }
getServerSettings(domain: any, ignoreCerts = false): Promise<object | string> { domain = formatUrl(domain);
const serverSettingsOptions = {
url: domain + '/api/v1/server_settings',
...RequestUtil.requestOptions(domain, ignoreCerts)
};
return new Promise((resolve, reject) => { const serverConf = {
request(serverSettingsOptions, (error: string, response: any) => { icon: defaultIconUrl,
if (!error && response.statusCode === 200) { url: domain,
const data = JSON.parse(response.body); alias: domain,
if (data.hasOwnProperty('realm_icon') && data.realm_icon) { ignoreCerts
resolve({ };
// Some Zulip Servers use absolute URL for server icon whereas others use relative URL
// Following check handles both the cases try {
icon: data.realm_icon.startsWith('/') ? data.realm_uri + data.realm_icon : data.realm_icon, return await getServerSettings(domain, serverConf.ignoreCerts);
url: data.realm_uri, } catch (error_) {
alias: escape(data.realm_name), // Make sure that error is an error or string not undefined
ignoreCerts // so validation does not throw error.
}); const error = error_ || '';
} else {
reject(Messages.noOrgsError(domain)); const certsError = error.toString().includes('certificate');
} if (certsError) {
const result = await checkCertError(domain, serverConf, error, silent);
return result;
}
throw new Error(Messages.invalidZulipServerError(domain));
}
}
async function getServerSettings(domain: string, ignoreCerts = false): Promise<ServerConf> {
const serverSettingsOptions = {
url: domain + '/api/v1/server_settings',
...RequestUtil.requestOptions(domain, ignoreCerts)
};
return new Promise((resolve, reject) => {
request(serverSettingsOptions, (error: Error, response: request.Response) => {
if (!error && response.statusCode === 200) {
const {realm_name, realm_uri, realm_icon} = JSON.parse(response.body);
if (
typeof realm_name === 'string' &&
typeof realm_uri === 'string' &&
typeof realm_icon === 'string'
) {
resolve({
// Some Zulip Servers use absolute URL for server icon whereas others use relative URL
// Following check handles both the cases
icon: realm_icon.startsWith('/') ? realm_uri + realm_icon : realm_icon,
url: realm_uri,
alias: escape(realm_name),
ignoreCerts
});
} else { } else {
reject(response); reject(Messages.noOrgsError(domain));
} }
}); } else {
reject(response);
}
}); });
} });
}
saveServerIcon(server: any, ignoreCerts = false): Promise<string> { export async function saveServerIcon(server: ServerConf, ignoreCerts = false): Promise<string> {
const url = server.icon; const url = server.icon;
const domain = server.url; const domain = server.url;
const serverIconOptions = { const serverIconOptions = {
url, url,
...RequestUtil.requestOptions(domain, ignoreCerts) ...RequestUtil.requestOptions(domain, ignoreCerts)
}; };
// The save will always succeed. If url is invalid, downgrade to default icon. // The save will always succeed. If url is invalid, downgrade to default icon.
return new Promise(resolve => { return new Promise(resolve => {
const filePath = this.generateFilePath(url); const filePath = generateFilePath(url);
const file = fs.createWriteStream(filePath); const file = fs.createWriteStream(filePath);
try { try {
request(serverIconOptions).on('response', (response: any) => { request(serverIconOptions).on('response', (response: request.Response) => {
response.on('error', (err: string) => { response.on('error', (err: Error) => {
logger.log('Could not get server icon.');
logger.log(err);
logger.reportSentry(err);
resolve(defaultIconUrl);
});
response.pipe(file).on('finish', () => {
resolve(filePath);
});
}).on('error', (err: string) => {
logger.log('Could not get server icon.'); logger.log('Could not get server icon.');
logger.log(err); logger.log(err);
logger.reportSentry(err); logger.reportSentry(err);
resolve(defaultIconUrl); resolve(defaultIconUrl);
}); });
} catch (err) { response.pipe(file).on('finish', () => {
resolve(filePath);
});
}).on('error', (err: Error) => {
logger.log('Could not get server icon.'); logger.log('Could not get server icon.');
logger.log(err); logger.log(err);
logger.reportSentry(err); logger.reportSentry(err);
resolve(defaultIconUrl); resolve(defaultIconUrl);
} });
}); } catch (error) {
} logger.log('Could not get server icon.');
logger.log(error);
async updateSavedServer(url: string, index: number): Promise<void> { logger.reportSentry(error);
// Does not promise successful update resolve(defaultIconUrl);
const oldIcon = this.getDomain(index).icon;
const { ignoreCerts } = this.getDomain(index);
try {
const newServerConf = await this.checkDomain(url, ignoreCerts, true);
const localIconUrl = await this.saveServerIcon(newServerConf, ignoreCerts);
if (!oldIcon || localIconUrl !== '../renderer/img/icon.png') {
newServerConf.icon = localIconUrl;
this.updateDomain(index, newServerConf);
this.reloadDB();
}
} catch (err) {
ipcRenderer.send('forward-message', 'show-network-error', index);
} }
} });
}
reloadDB(): void { export async function updateSavedServer(url: string, index: number): Promise<void> {
const domainJsonPath = path.join(app.getPath('userData'), 'config/domain.json'); // Does not promise successful update
try { const oldIcon = getDomain(index).icon;
const file = fs.readFileSync(domainJsonPath, 'utf8'); const {ignoreCerts} = getDomain(index);
JSON.parse(file); try {
} catch (err) { const newServerConf = await checkDomain(url, ignoreCerts, true);
if (fs.existsSync(domainJsonPath)) { const localIconUrl = await saveServerIcon(newServerConf, ignoreCerts);
fs.unlinkSync(domainJsonPath); if (!oldIcon || localIconUrl !== '../renderer/img/icon.png') {
dialog.showErrorBox( newServerConf.icon = localIconUrl;
'Error saving new organization', updateDomain(index, newServerConf);
'There seems to be error while saving new organization, ' + reloadDB();
'you may have to re-add your previous organizations back.'
);
logger.error('Error while JSON parsing domain.json: ');
logger.error(err);
logger.reportSentry(err);
}
}
this.db = new JsonDB(domainJsonPath, true, true);
}
generateFilePath(url: string): string {
const dir = `${app.getPath('userData')}/server-icons`;
const extension = path.extname(url).split('?')[0];
let hash = 5381;
let len = url.length;
while (len) {
hash = (hash * 33) ^ url.charCodeAt(--len);
}
// Create 'server-icons' directory if not existed
if (!fs.existsSync(dir)) {
fs.mkdirSync(dir);
}
return `${dir}/${hash >>> 0}${extension}`;
}
formatUrl(domain: any): string {
const hasPrefix = (domain.indexOf('http') === 0);
if (hasPrefix) {
return domain;
} else {
return (domain.indexOf('localhost:') >= 0) ? `http://${domain}` : `https://${domain}`;
} }
} catch (error) {
logger.log('Could not update server icon.');
logger.log(error);
logger.reportSentry(error);
} }
} }
export = new DomainUtil(); function reloadDB(): void {
const domainJsonPath = path.join(app.getPath('userData'), 'config/domain.json');
try {
const file = fs.readFileSync(domainJsonPath, 'utf8');
JSON.parse(file);
} catch (error) {
if (fs.existsSync(domainJsonPath)) {
fs.unlinkSync(domainJsonPath);
dialog.showErrorBox(
'Error saving new organization',
'There seems to be error while saving new organization, ' +
'you may have to re-add your previous organizations back.'
);
logger.error('Error while JSON parsing domain.json: ');
logger.error(error);
logger.reportSentry(error);
}
}
db = new JsonDB(domainJsonPath, true, true);
}
function generateFilePath(url: string): string {
const dir = `${app.getPath('userData')}/server-icons`;
const extension = path.extname(url).split('?')[0];
let hash = 5381;
let {length} = url;
while (length) {
hash = (hash * 33) ^ url.charCodeAt(--length);
}
// Create 'server-icons' directory if not existed
if (!fs.existsSync(dir)) {
fs.mkdirSync(dir);
}
return `${dir}/${hash >>> 0}${extension}`;
}
export function formatUrl(domain: string): string {
if (domain.startsWith('http://') || domain.startsWith('https://')) {
return domain;
}
if (domain.startsWith('localhost:')) {
return `http://${domain}`;
}
return `https://${domain}`;
}

View File

@@ -1,80 +1,81 @@
import fs = require('fs'); import fs from 'fs';
import path = require('path'); import path from 'path';
import Logger = require('./logger-util'); import Logger from './logger-util';
const logger = new Logger({ const logger = new Logger({
file: 'enterprise-util.log', file: 'enterprise-util.log',
timestamp: true timestamp: true
}); });
let instance: null | EnterpriseUtil = null; // TODO: replace enterpriseSettings type with an interface once settings are final
let enterpriseSettings: {[key: string]: unknown};
let configFile: boolean;
class EnterpriseUtil { reloadDB();
// todo: replace enterpriseSettings type with an interface once settings are final
enterpriseSettings: any;
configFile: boolean;
constructor() {
if (instance) {
return instance;
}
instance = this;
this.reloadDB(); function reloadDB(): void {
let enterpriseFile = '/etc/zulip-desktop-config/global_config.json';
if (process.platform === 'win32') {
enterpriseFile = 'C:\\Program Files\\Zulip-Desktop-Config\\global_config.json';
} }
reloadDB(): void { enterpriseFile = path.resolve(enterpriseFile);
let enterpriseFile = '/etc/zulip-desktop-config/global_config.json'; if (fs.existsSync(enterpriseFile)) {
if (process.platform === 'win32') { configFile = true;
enterpriseFile = 'C:\\Program Files\\Zulip-Desktop-Config\\global_config.json'; try {
const file = fs.readFileSync(enterpriseFile, 'utf8');
enterpriseSettings = JSON.parse(file);
} catch (error) {
logger.log('Error while JSON parsing global_config.json: ');
logger.log(error);
} }
} else {
enterpriseFile = path.resolve(enterpriseFile); configFile = false;
if (fs.existsSync(enterpriseFile)) {
this.configFile = true;
try {
const file = fs.readFileSync(enterpriseFile, 'utf8');
this.enterpriseSettings = JSON.parse(file);
} catch (err) {
logger.log('Error while JSON parsing global_config.json: ');
logger.log(err);
}
} else {
this.configFile = false;
}
}
getConfigItem(key: string, defaultValue?: any): any {
this.reloadDB();
if (!this.configFile) {
return defaultValue;
}
if (defaultValue === undefined) {
defaultValue = null;
}
return this.configItemExists(key) ? this.enterpriseSettings[key] : defaultValue;
}
configItemExists(key: string): boolean {
this.reloadDB();
if (!this.configFile) {
return false;
}
return (this.enterpriseSettings[key] !== undefined);
}
isPresetOrg(url: string): boolean {
if (!this.configFile || !this.configItemExists('presetOrganizations')) {
return false;
}
const presetOrgs = this.enterpriseSettings.presetOrganizations;
for (const org of presetOrgs) {
if (url.includes(org)) {
return true;
}
}
return false;
} }
} }
export = new EnterpriseUtil(); export function hasConfigFile(): boolean {
return configFile;
}
export function getConfigItem(key: string, defaultValue?: unknown): any {
reloadDB();
if (!configFile) {
return defaultValue;
}
if (defaultValue === undefined) {
defaultValue = null;
}
return configItemExists(key) ? enterpriseSettings[key] : defaultValue;
}
export function configItemExists(key: string): boolean {
reloadDB();
if (!configFile) {
return false;
}
return (enterpriseSettings[key] !== undefined);
}
export function isPresetOrg(url: string): boolean {
if (!configFile || !configItemExists('presetOrganizations')) {
return false;
}
const presetOrgs = enterpriseSettings.presetOrganizations;
if (!Array.isArray(presetOrgs)) {
throw new TypeError('Expected array for presetOrgs');
}
for (const org of presetOrgs) {
if (url.includes(org)) {
return true;
}
}
return false;
}

View File

@@ -1,51 +1,45 @@
'use strict'; import {shell} from 'electron';
import escape from 'escape-html';
import fs from 'fs';
import os from 'os';
import path from 'path';
// TODO: TypeScript - Add @types/ export function isUploadsUrl(server: string, url: URL): boolean {
import wurl = require('wurl'); return url.origin === server && url.pathname.startsWith('/user_uploads/');
let instance: null | LinkUtil = null;
interface IsInternalResponse {
isInternalUrl: boolean;
isUploadsUrl: boolean;
} }
class LinkUtil { export async function openBrowser(url: URL): Promise<void> {
constructor() { if (['http:', 'https:', 'mailto:'].includes(url.protocol)) {
if (instance) { await shell.openExternal(url.href);
return instance; } else {
} else { // For security, indirect links to non-whitelisted protocols
instance = this; // through a real web browser via a local HTML file.
} const dir = fs.mkdtempSync(
path.join(os.tmpdir(), 'zulip-redirect-')
return instance; );
} const file = path.join(dir, 'redirect.html');
fs.writeFileSync(file, `\
isInternal(currentUrl: string, newUrl: string): IsInternalResponse { <!DOCTYPE html>
const currentDomain = wurl('hostname', currentUrl); <html>
const newDomain = wurl('hostname', newUrl); <head>
<meta charset="UTF-8" />
const sameDomainUrl = (currentDomain === newDomain || newUrl === currentUrl + '/'); <meta http-equiv="Refresh" content="0; url=${escape(url.href)}" />
const isUploadsUrl = newUrl.includes(currentUrl + '/user_uploads/'); <title>Redirecting</title>
const isInternalUrl = newUrl.includes('/#narrow') || isUploadsUrl; <style>
html {
return { font-family: menu, "Helvetica Neue", sans-serif;
isInternalUrl: sameDomainUrl && isInternalUrl, }
isUploadsUrl </style>
}; </head>
} <body>
<p>Opening <a href="${escape(url.href)}">${escape(url.href)}</a>…</p>
isImage(url: string): boolean { </body>
// test for images extension as well as urls like .png?s=100 </html>
const isImageUrl = /\.(bmp|gif|jpg|jpeg|png|webp)\?*.*$/i; `);
return isImageUrl.test(url); shell.openItem(file);
} setTimeout(() => {
fs.unlinkSync(file);
isPDF(url: string): boolean { fs.rmdirSync(dir);
// test for pdf extension }, 15000);
const isPDFUrl = /\.(pdf)\?*.*$/i;
return isPDFUrl.test(url);
} }
} }
export = new LinkUtil();

View File

@@ -1,10 +1,9 @@
'use strict'; import {JsonDB} from 'node-json-db';
import JsonDB from 'node-json-db';
import fs = require('fs'); import fs from 'fs';
import path = require('path'); import path from 'path';
import electron = require('electron'); import electron from 'electron';
import Logger = require('./logger-util'); import Logger from './logger-util';
const remote = const remote =
process.type === 'renderer' ? electron.remote : electron; process.type === 'renderer' ? electron.remote : electron;
@@ -15,62 +14,49 @@ const logger = new Logger({
}); });
/* To make the util runnable in both main and renderer process */ /* To make the util runnable in both main and renderer process */
const { dialog, app } = remote; const {dialog, app} = remote;
let instance: null | LinuxUpdateUtil = null;
class LinuxUpdateUtil { let db: JsonDB;
db: JsonDB;
constructor() { reloadDB();
if (instance) {
return instance;
} else {
instance = this;
}
this.reloadDB(); export function getUpdateItem(key: string, defaultValue: unknown = null): any {
return instance; reloadDB();
const value = db.getData('/')[key];
if (value === undefined) {
setUpdateItem(key, defaultValue);
return defaultValue;
} }
getUpdateItem(key: string, defaultValue: any = null): any { return value;
this.reloadDB();
const value = this.db.getData('/')[key];
if (value === undefined) {
this.setUpdateItem(key, defaultValue);
return defaultValue;
} else {
return value;
}
}
setUpdateItem(key: string, value: any): void {
this.db.push(`/${key}`, value, true);
this.reloadDB();
}
removeUpdateItem(key: string): void {
this.db.delete(`/${key}`);
this.reloadDB();
}
reloadDB(): void {
const linuxUpdateJsonPath = path.join(app.getPath('userData'), '/config/updates.json');
try {
const file = fs.readFileSync(linuxUpdateJsonPath, 'utf8');
JSON.parse(file);
} catch (err) {
if (fs.existsSync(linuxUpdateJsonPath)) {
fs.unlinkSync(linuxUpdateJsonPath);
dialog.showErrorBox(
'Error saving update notifications.',
'We encountered an error while saving the update notifications.'
);
logger.error('Error while JSON parsing updates.json: ');
logger.error(err);
}
}
this.db = new JsonDB(linuxUpdateJsonPath, true, true);
}
} }
export = new LinuxUpdateUtil(); export function setUpdateItem(key: string, value: unknown): void {
db.push(`/${key}`, value, true);
reloadDB();
}
export function removeUpdateItem(key: string): void {
db.delete(`/${key}`);
reloadDB();
}
function reloadDB(): void {
const linuxUpdateJsonPath = path.join(app.getPath('userData'), '/config/updates.json');
try {
const file = fs.readFileSync(linuxUpdateJsonPath, 'utf8');
JSON.parse(file);
} catch (error) {
if (fs.existsSync(linuxUpdateJsonPath)) {
fs.unlinkSync(linuxUpdateJsonPath);
dialog.showErrorBox(
'Error saving update notifications.',
'We encountered an error while saving the update notifications.'
);
logger.error('Error while JSON parsing updates.json: ');
logger.error(error);
}
}
db = new JsonDB(linuxUpdateJsonPath, true, true);
}

View File

@@ -1,19 +1,14 @@
import { Console as NodeConsole } from 'console'; // eslint-disable-line node/prefer-global/console import {Console} from 'console'; // eslint-disable-line node/prefer-global/console
import { initSetUp } from './default-util'; import {initSetUp} from './default-util';
import { sentryInit, captureException } from './sentry-util'; import {sentryInit, captureException} from './sentry-util';
import fs = require('fs'); import fs from 'fs';
import os = require('os'); import os from 'os';
import isDev = require('electron-is-dev'); import isDev from 'electron-is-dev';
import electron = require('electron'); import electron from 'electron';
// this interface adds [key: string]: any so
// we can do console[type] later on in the code
interface PatchedConsole extends Console {
[key: string]: any;
}
interface LoggerOptions { interface LoggerOptions {
timestamp?: any; timestamp?: true | (() => string);
file?: string; file?: string;
level?: boolean; level?: boolean;
logInDevMode?: boolean; logInDevMode?: boolean;
@@ -29,9 +24,9 @@ if (process.type === 'renderer') {
// Report Errors to Sentry only if it is enabled in settings // Report Errors to Sentry only if it is enabled in settings
// Gets the value of reportErrors from config-util for renderer process // Gets the value of reportErrors from config-util for renderer process
// For main process, sentryInit() is handled in index.js // For main process, sentryInit() is handled in index.js
const { ipcRenderer } = electron; const {ipcRenderer} = electron;
ipcRenderer.send('error-reporting'); ipcRenderer.send('error-reporting');
ipcRenderer.on('error-reporting-val', (_event: any, errorReporting: boolean) => { ipcRenderer.on('error-reporting-val', (_event: Event, errorReporting: boolean) => {
reportErrors = errorReporting; reportErrors = errorReporting;
if (reportErrors) { if (reportErrors) {
sentryInit(); sentryInit();
@@ -41,23 +36,31 @@ if (process.type === 'renderer') {
app = electron.app; app = electron.app;
} }
const browserConsole: PatchedConsole = console;
const logDir = `${app.getPath('userData')}/Logs`; const logDir = `${app.getPath('userData')}/Logs`;
class Logger { type Level = 'log' | 'debug' | 'info' | 'warn' | 'error';
nodeConsole: PatchedConsole; const levels: Level[] = ['log', 'debug', 'info', 'warn', 'error'];
timestamp: any; // TODO: TypeScript - Figure out how to make this work with string | Function. type LogMethod = (...args: unknown[]) => void;
export default class Logger {
log: LogMethod;
debug: LogMethod;
info: LogMethod;
warn: LogMethod;
error: LogMethod;
nodeConsole: Console;
timestamp?: () => string;
level: boolean; level: boolean;
logInDevMode: boolean; logInDevMode: boolean;
[key: string]: any;
constructor(opts: LoggerOptions = {}) { constructor(options: LoggerOptions = {}) {
let { let {
timestamp = true, timestamp = true,
file = 'console.log', file = 'console.log',
level = true, level = true,
logInDevMode = false logInDevMode = false
} = opts; } = options;
file = `${logDir}/${file}`; file = `${logDir}/${file}`;
if (timestamp === true) { if (timestamp === true) {
@@ -71,8 +74,8 @@ class Logger {
process.nextTick(() => this.trimLog(file)); process.nextTick(() => this.trimLog(file));
} }
const fileStream = fs.createWriteStream(file, { flags: 'a' }); const fileStream = fs.createWriteStream(file, {flags: 'a'});
const nodeConsole = new NodeConsole(fileStream); const nodeConsole = new Console(fileStream);
this.nodeConsole = nodeConsole; this.nodeConsole = nodeConsole;
this.timestamp = timestamp; this.timestamp = timestamp;
@@ -81,42 +84,37 @@ class Logger {
this.setUpConsole(); this.setUpConsole();
} }
_log(type: string, ...args: any[]): void { _log(type: Level, ...args: unknown[]): void {
const { const {
nodeConsole, timestamp, level, logInDevMode nodeConsole, timestamp, level, logInDevMode
} = this; } = this;
let nodeConsoleLog;
/* eslint-disable no-fallthrough */ /* eslint-disable no-fallthrough */
switch (true) { switch (true) {
case typeof timestamp === 'function': case typeof timestamp === 'function':
args.unshift(timestamp() + ' |\t'); args.unshift(timestamp() + ' |\t');
case (level !== false): case (level):
args.unshift(type.toUpperCase() + ' |'); args.unshift(type.toUpperCase() + ' |');
case isDev || logInDevMode: case isDev || logInDevMode:
nodeConsoleLog = nodeConsole[type] || nodeConsole.log; nodeConsole[type](...args);
nodeConsoleLog.apply(null, args); // eslint-disable-line prefer-spread
default: break; default: break;
} }
/* eslint-enable no-fallthrough */ /* eslint-enable no-fallthrough */
browserConsole[type].apply(null, args); console[type](...args);
} }
setUpConsole(): void { setUpConsole(): void {
for (const type in browserConsole) { for (const type of levels) {
this.setupConsoleMethod(type); this.setupConsoleMethod(type);
} }
} }
setupConsoleMethod(type: string): void { setupConsoleMethod(type: Level): void {
this[type] = (...args: any[]) => { this[type] = (...args: unknown[]) => this._log(type, ...args);
const log = this._log.bind(this, type, ...args);
log();
};
} }
getTimestamp(): string { getTimestamp(): string {
@@ -127,7 +125,7 @@ class Logger {
return timestamp; return timestamp;
} }
reportSentry(err: string): void { reportSentry(err: unknown): void {
if (reportErrors) { if (reportErrors) {
captureException(err); captureException(err);
} }
@@ -138,6 +136,7 @@ class Logger {
if (err) { if (err) {
throw err; throw err;
} }
const MAX_LOG_FILE_LINES = 500; const MAX_LOG_FILE_LINES = 500;
const logs = data.split(os.EOL); const logs = data.split(os.EOL);
const logLength = logs.length - 1; const logLength = logs.length - 1;
@@ -151,5 +150,3 @@ class Logger {
}); });
} }
} }
export = Logger;

View File

@@ -1,11 +0,0 @@
// This util function returns the page params if they're present else returns null
export function isPageParams(): null | object {
let webpageParams = null;
try {
// eslint-disable-next-line no-undef, @typescript-eslint/camelcase
webpageParams = page_params;
} catch (_) {
webpageParams = null;
}
return webpageParams;
}

View File

@@ -1,142 +1,122 @@
'use strict'; import * as ConfigUtil from './config-util';
import url = require('url'); export interface ProxyRule {
import ConfigUtil = require('./config-util');
let instance: null | ProxyUtil = null;
interface ProxyRule {
hostname?: string; hostname?: string;
port?: number; port?: number;
} }
class ProxyUtil { // Return proxy to be used for a particular uri, to be used for request
constructor() { export function getProxy(_uri: string): ProxyRule | void {
if (instance) { let uri;
return instance; try {
} else { uri = new URL(_uri);
instance = this; } catch (_) {
} return;
return instance;
} }
// Return proxy to be used for a particular uri, to be used for request const proxyRules = ConfigUtil.getConfigItem('proxyRules', '').split(';');
getProxy(_uri: string): ProxyRule | void { // If SPS is on and system uses no proxy then request should not try to use proxy from
const parsedUri = url.parse(_uri); // environment. NO_PROXY = '*' makes request ignore all environment proxy variables.
if (parsedUri === null) { if (proxyRules[0] === '') {
return; process.env.NO_PROXY = '*';
} return;
const uri = parsedUri;
const proxyRules = ConfigUtil.getConfigItem('proxyRules', '').split(';');
// If SPS is on and system uses no proxy then request should not try to use proxy from
// environment. NO_PROXY = '*' makes request ignore all environment proxy variables.
if (proxyRules[0] === '') {
process.env.NO_PROXY = '*';
return;
}
const proxyRule: any = {};
if (uri.protocol === 'http:') {
proxyRules.forEach((proxy: string) => {
if (proxy.includes('http=')) {
proxyRule.hostname = proxy.split('http=')[1].trim().split(':')[0];
proxyRule.port = proxy.split('http=')[1].trim().split(':')[1];
}
});
return proxyRule;
}
if (uri.protocol === 'https:') {
proxyRules.forEach((proxy: string) => {
if (proxy.includes('https=')) {
proxyRule.hostname = proxy.split('https=')[1].trim().split(':')[0];
proxyRule.port = proxy.split('https=')[1].trim().split(':')[1];
}
});
return proxyRule;
}
} }
// TODO: Refactor to async function const proxyRule: any = {};
resolveSystemProxy(mainWindow: Electron.BrowserWindow): void { if (uri.protocol === 'http:') {
const page = mainWindow.webContents; proxyRules.forEach((proxy: string) => {
const ses = page.session; if (proxy.includes('http=')) {
const resolveProxyUrl = 'www.example.com'; proxyRule.hostname = proxy.split('http=')[1].trim().split(':')[0];
proxyRule.port = proxy.split('http=')[1].trim().split(':')[1];
// Check HTTP Proxy
const httpProxy = new Promise(resolve => {
ses.resolveProxy('http://' + resolveProxyUrl, (proxy: string) => {
let httpString = '';
if (proxy !== 'DIRECT') {
// in case of proxy HTTPS url:port, windows gives first word as HTTPS while linux gives PROXY
// for all other HTTP or direct url:port both uses PROXY
if (proxy.includes('PROXY') || proxy.includes('HTTPS')) {
httpString = 'http=' + proxy.split('PROXY')[1] + ';';
}
}
resolve(httpString);
});
});
// Check HTTPS Proxy
const httpsProxy = new Promise(resolve => {
ses.resolveProxy('https://' + resolveProxyUrl, (proxy: string) => {
let httpsString = '';
if (proxy !== 'DIRECT' || proxy.includes('HTTPS')) {
// in case of proxy HTTPS url:port, windows gives first word as HTTPS while linux gives PROXY
// for all other HTTP or direct url:port both uses PROXY
if (proxy.includes('PROXY') || proxy.includes('HTTPS')) {
httpsString += 'https=' + proxy.split('PROXY')[1] + ';';
}
}
resolve(httpsString);
});
});
// Check FTP Proxy
const ftpProxy = new Promise(resolve => {
ses.resolveProxy('ftp://' + resolveProxyUrl, (proxy: string) => {
let ftpString = '';
if (proxy !== 'DIRECT') {
if (proxy.includes('PROXY')) {
ftpString += 'ftp=' + proxy.split('PROXY')[1] + ';';
}
}
resolve(ftpString);
});
});
// Check SOCKS Proxy
const socksProxy = new Promise(resolve => {
ses.resolveProxy('socks4://' + resolveProxyUrl, (proxy: string) => {
let socksString = '';
if (proxy !== 'DIRECT') {
if (proxy.includes('SOCKS5')) {
socksString += 'socks=' + proxy.split('SOCKS5')[1] + ';';
} else if (proxy.includes('SOCKS4')) {
socksString += 'socks=' + proxy.split('SOCKS4')[1] + ';';
} else if (proxy.includes('PROXY')) {
socksString += 'socks=' + proxy.split('PROXY')[1] + ';';
}
}
resolve(socksString);
});
});
Promise.all([httpProxy, httpsProxy, ftpProxy, socksProxy]).then(values => {
let proxyString = '';
values.forEach(proxy => {
proxyString += proxy;
});
ConfigUtil.setConfigItem('systemProxyRules', proxyString);
const useSystemProxy = ConfigUtil.getConfigItem('useSystemProxy');
if (useSystemProxy) {
ConfigUtil.setConfigItem('proxyRules', proxyString);
} }
}); });
return proxyRule;
}
if (uri.protocol === 'https:') {
proxyRules.forEach((proxy: string) => {
if (proxy.includes('https=')) {
proxyRule.hostname = proxy.split('https=')[1].trim().split(':')[0];
proxyRule.port = proxy.split('https=')[1].trim().split(':')[1];
}
});
return proxyRule;
} }
} }
export = new ProxyUtil(); // TODO: Refactor to async function
export async function resolveSystemProxy(mainWindow: Electron.BrowserWindow): Promise<void> {
const page = mainWindow.webContents;
const ses = page.session;
const resolveProxyUrl = 'www.example.com';
// Check HTTP Proxy
const httpProxy = (async () => {
const proxy = await ses.resolveProxy('http://' + resolveProxyUrl);
let httpString = '';
if (proxy !== 'DIRECT') {
// In case of proxy HTTPS url:port, windows gives first word as HTTPS while linux gives PROXY
// for all other HTTP or direct url:port both uses PROXY
if (proxy.includes('PROXY') || proxy.includes('HTTPS')) {
httpString = 'http=' + proxy.split('PROXY')[1] + ';';
}
}
return httpString;
})();
// Check HTTPS Proxy
const httpsProxy = (async () => {
const proxy = await ses.resolveProxy('https://' + resolveProxyUrl);
let httpsString = '';
if (proxy !== 'DIRECT' || proxy.includes('HTTPS')) {
// In case of proxy HTTPS url:port, windows gives first word as HTTPS while linux gives PROXY
// for all other HTTP or direct url:port both uses PROXY
if (proxy.includes('PROXY') || proxy.includes('HTTPS')) {
httpsString += 'https=' + proxy.split('PROXY')[1] + ';';
}
}
return httpsString;
})();
// Check FTP Proxy
const ftpProxy = (async () => {
const proxy = await ses.resolveProxy('ftp://' + resolveProxyUrl);
let ftpString = '';
if (proxy !== 'DIRECT') {
if (proxy.includes('PROXY')) {
ftpString += 'ftp=' + proxy.split('PROXY')[1] + ';';
}
}
return ftpString;
})();
// Check SOCKS Proxy
const socksProxy = (async () => {
const proxy = await ses.resolveProxy('socks4://' + resolveProxyUrl);
let socksString = '';
if (proxy !== 'DIRECT') {
if (proxy.includes('SOCKS5')) {
socksString += 'socks=' + proxy.split('SOCKS5')[1] + ';';
} else if (proxy.includes('SOCKS4')) {
socksString += 'socks=' + proxy.split('SOCKS4')[1] + ';';
} else if (proxy.includes('PROXY')) {
socksString += 'socks=' + proxy.split('PROXY')[1] + ';';
}
}
return socksString;
})();
const values = await Promise.all([httpProxy, httpsProxy, ftpProxy, socksProxy]);
let proxyString = '';
values.forEach(proxy => {
proxyString += proxy;
});
ConfigUtil.setConfigItem('systemProxyRules', proxyString);
const useSystemProxy = ConfigUtil.getConfigItem('useSystemProxy');
if (useSystemProxy) {
ConfigUtil.setConfigItem('proxyRules', proxyString);
}
}

View File

@@ -1,26 +1,24 @@
import { ipcRenderer } from 'electron'; import {ipcRenderer} from 'electron';
import backoff = require('backoff'); import type WebView from '../components/webview';
import request = require('request'); import backoff from 'backoff';
import Logger = require('./logger-util'); import request from 'request';
import RequestUtil = require('./request-util'); import Logger from './logger-util';
import DomainUtil = require('./domain-util'); import * as RequestUtil from './request-util';
import * as DomainUtil from './domain-util';
const logger = new Logger({ const logger = new Logger({
file: `domain-util.log`, file: 'domain-util.log',
timestamp: true timestamp: true
}); });
class ReconnectUtil { export default class ReconnectUtil {
// TODO: TypeScript - Figure out how to annotate webview webview: WebView;
// it should be WebView; maybe make it a generic so we can
// pass the class from main.ts
webview: any;
url: string; url: string;
alreadyReloaded: boolean; alreadyReloaded: boolean;
fibonacciBackoff: any; fibonacciBackoff: backoff.Backoff;
constructor(webview: any) { constructor(webview: WebView) {
this.webview = webview; this.webview = webview;
this.url = webview.props.url; this.url = webview.props.url;
this.alreadyReloaded = false; this.alreadyReloaded = false;
@@ -34,69 +32,61 @@ class ReconnectUtil {
}); });
} }
isOnline(): Promise<boolean> { async isOnline(): Promise<boolean> {
return new Promise(resolve => { return new Promise(resolve => {
try { try {
const ignoreCerts = DomainUtil.shouldIgnoreCerts(this.url); const ignoreCerts = DomainUtil.shouldIgnoreCerts(this.url);
if (ignoreCerts === null) { if (ignoreCerts === null) {
return; return;
} }
request( request(
{ {
url: `${this.url}/static/favicon.ico`, url: `${this.url}/static/favicon.ico`,
...RequestUtil.requestOptions(this.url, ignoreCerts) ...RequestUtil.requestOptions(this.url, ignoreCerts)
}, },
(error: Error, response: any) => { (error: Error, response: request.Response) => {
const isValidResponse = const isValidResponse =
!error && response.statusCode >= 200 && response.statusCode < 400; !error && response.statusCode >= 200 && response.statusCode < 400;
resolve(isValidResponse); resolve(isValidResponse);
} }
); );
} catch (err) { } catch (error) {
logger.log(err); logger.log(error);
} }
}); });
} }
pollInternetAndReload(): void { pollInternetAndReload(): void {
this.fibonacciBackoff.backoff(); this.fibonacciBackoff.backoff();
this.fibonacciBackoff.on('ready', () => { this.fibonacciBackoff.on('ready', async () => {
this._checkAndReload().then(status => { if (await this._checkAndReload()) {
if (status) { this.fibonacciBackoff.reset();
this.fibonacciBackoff.reset();
} else {
this.fibonacciBackoff.backoff();
}
});
});
}
// TODO: Make this a async function
_checkAndReload(): Promise<boolean> {
return new Promise(resolve => {
if (!this.alreadyReloaded) { // eslint-disable-line no-negated-condition
this.isOnline()
.then((online: boolean) => {
if (online) {
ipcRenderer.send('forward-message', 'reload-viewer');
logger.log('You\'re back online.');
return resolve(true);
}
logger.log('There is no internet connection, try checking network cables, modem and router.');
const errMsgHolder = document.querySelector('#description');
if (errMsgHolder) {
errMsgHolder.innerHTML = `
<div>Your internet connection doesn't seem to work properly!</div>
<div>Verify that it works and then click try again.</div>`;
}
return resolve(false);
});
} else { } else {
return resolve(true); this.fibonacciBackoff.backoff();
} }
}); });
} }
}
export = ReconnectUtil; async _checkAndReload(): Promise<boolean> {
if (this.alreadyReloaded) {
return true;
}
if (await this.isOnline()) {
ipcRenderer.send('forward-message', 'reload-viewer');
logger.log('You\'re back online.');
return true;
}
logger.log('There is no internet connection, try checking network cables, modem and router.');
const errorMessageHolder = document.querySelector('#description');
if (errorMessageHolder) {
errorMessageHolder.innerHTML = `
<div>Your internet connection doesn't seem to work properly!</div>
<div>Verify that it works and then click try again.</div>`;
}
return false;
}
}

View File

@@ -1,87 +1,71 @@
import { remote } from 'electron'; import {remote} from 'electron';
import fs = require('fs'); import fs from 'fs';
import path = require('path'); import path from 'path';
import ConfigUtil = require('./config-util'); import * as ConfigUtil from './config-util';
import Logger = require('./logger-util'); import Logger from './logger-util';
import ProxyUtil = require('./proxy-util'); import * as ProxyUtil from './proxy-util';
import CertificateUtil = require('./certificate-util'); import * as CertificateUtil from './certificate-util';
import SystemUtil = require('./system-util'); import * as SystemUtil from './system-util';
const { app } = remote; const {app} = remote;
const logger = new Logger({ const logger = new Logger({
file: `request-util.log`, file: 'request-util.log',
timestamp: true timestamp: true
}); });
let instance: null | RequestUtil = null;
// TODO: TypeScript - Use ProxyRule for the proxy property
// we can do this now since we use export = ProxyUtil syntax
interface RequestUtilResponse { interface RequestUtilResponse {
ca: string; ca: string;
proxy: string | void | object; proxy: string | void | ProxyUtil.ProxyRule;
ecdhCurve: 'auto'; ecdhCurve: 'auto';
headers: { 'User-Agent': string }; headers: { 'User-Agent': string };
rejectUnauthorized: boolean; rejectUnauthorized: boolean;
} }
class RequestUtil { // ignoreCerts parameter helps in fetching server icon and
constructor() { // other server details when user chooses to ignore certificate warnings
if (!instance) { export function requestOptions(domain: string, ignoreCerts: boolean): RequestUtilResponse {
instance = this; domain = formatUrl(domain);
} const certificate = CertificateUtil.getCertificate(
encodeURIComponent(domain)
);
return instance; let certificateFile = null;
if (certificate?.includes('/')) {
// Certificate saved using old app version
certificateFile = certificate;
} else if (certificate) {
certificateFile = path.join(`${app.getPath('userData')}/certificates`, certificate);
} }
// ignoreCerts parameter helps in fetching server icon and let certificateLocation = '';
// other server details when user chooses to ignore certificate warnings if (certificate) {
requestOptions(domain: string, ignoreCerts: boolean): RequestUtilResponse { // To handle case where certificate has been moved from the location in certificates.json
domain = this.formatUrl(domain); try {
const certificate = CertificateUtil.getCertificate( certificateLocation = fs.readFileSync(certificateFile, 'utf8');
encodeURIComponent(domain) } catch (error) {
); logger.warn('Error while trying to get certificate:', error);
let certificateFile = null;
if (certificate && certificate.includes('/')) {
// certificate saved using old app version
certificateFile = certificate;
} else if (certificate) {
certificateFile = path.join(`${app.getPath('userData')}/certificates`, certificate);
}
let certificateLocation = '';
if (certificate) {
// To handle case where certificate has been moved from the location in certificates.json
try {
certificateLocation = fs.readFileSync(certificateFile, 'utf8');
} catch (err) {
logger.warn(`Error while trying to get certificate: ${err}`);
}
}
const proxyEnabled = ConfigUtil.getConfigItem('useManualProxy') || ConfigUtil.getConfigItem('useSystemProxy');
// If certificate for the domain exists add it as a ca key in the request's parameter else consider only domain as the parameter for request
// Add proxy as a parameter if it is being used.
return {
ca: certificateLocation ? certificateLocation : '',
proxy: proxyEnabled ? ProxyUtil.getProxy(domain) : '',
ecdhCurve: 'auto',
headers: { 'User-Agent': SystemUtil.getUserAgent() },
rejectUnauthorized: !ignoreCerts
};
}
formatUrl(domain: string): string {
const hasPrefix = domain.startsWith('http', 0);
if (hasPrefix) {
return domain;
} else {
return domain.includes('localhost:') ? `http://${domain}` : `https://${domain}`;
} }
} }
const proxyEnabled = ConfigUtil.getConfigItem('useManualProxy') || ConfigUtil.getConfigItem('useSystemProxy');
// If certificate for the domain exists add it as a ca key in the request's parameter else consider only domain as the parameter for request
// Add proxy as a parameter if it is being used.
return {
ca: certificateLocation ? certificateLocation : '',
proxy: proxyEnabled ? ProxyUtil.getProxy(domain) : '',
ecdhCurve: 'auto',
headers: {'User-Agent': SystemUtil.getUserAgent()},
rejectUnauthorized: !ignoreCerts
};
} }
const requestUtil = new RequestUtil(); function formatUrl(domain: string): string {
export = requestUtil; const hasPrefix = domain.startsWith('http', 0);
if (hasPrefix) {
return domain;
}
return domain.includes('localhost:') ? `http://${domain}` : `https://${domain}`;
}

View File

@@ -1,21 +1,18 @@
import { init } from '@sentry/electron'; import {init} from '@sentry/electron';
import isDev = require('electron-is-dev'); import isDev from 'electron-is-dev';
import path = require('path');
import dotenv = require('dotenv');
dotenv.config({ path: path.resolve(__dirname, '/../../../../.env') });
export const sentryInit = (): void => { export const sentryInit = (): void => {
if (!isDev) { if (!isDev) {
init({ init({
dsn: process.env.SENTRY_DSN, dsn: 'https://628dc2f2864243a08ead72e63f94c7b1@sentry.io/204668',
// We should ignore this error since it's harmless and we know the reason behind this // We should ignore this error since it's harmless and we know the reason behind this
// This error mainly comes from the console logs. // This error mainly comes from the console logs.
// This is a temp solution until Sentry supports disabling the console logs // This is a temp solution until Sentry supports disabling the console logs
ignoreErrors: ['does not appear to be a valid Zulip server'] ignoreErrors: ['does not appear to be a valid Zulip server']
// sendTimeout: 30 // wait 30 seconds before considering the sending capture to have failed, default is 1 second /// sendTimeout: 30 // wait 30 seconds before considering the sending capture to have failed, default is 1 second
}); });
} }
}; };
export { captureException } from '@sentry/electron'; export {captureException} from '@sentry/electron';

View File

@@ -1,64 +1,39 @@
'use strict'; import {ipcRenderer} from 'electron';
import { remote } from 'electron';
import os = require('os'); import os from 'os';
import ConfigUtil = require('./config-util');
const { app } = remote; export const connectivityERR: string[] = [
let instance: null | SystemUtil = null; 'ERR_INTERNET_DISCONNECTED',
'ERR_PROXY_CONNECTION_FAILED',
'ERR_CONNECTION_RESET',
'ERR_NOT_CONNECTED',
'ERR_NAME_NOT_RESOLVED',
'ERR_NETWORK_CHANGED'
];
class SystemUtil { const userAgent = ipcRenderer.sendSync('fetch-user-agent');
connectivityERR: string[];
userAgent: string | null; export function getOS(): string {
const platform = os.platform();
if (platform === 'darwin') {
return 'Mac';
}
constructor() { if (platform === 'linux') {
if (instance) { return 'Linux';
return instance; }
} else {
instance = this; if (platform === 'win32') {
if (Number.parseFloat(os.release()) < 6.2) {
return 'Windows 7';
} }
this.connectivityERR = [ return 'Windows 10';
'ERR_INTERNET_DISCONNECTED',
'ERR_PROXY_CONNECTION_FAILED',
'ERR_CONNECTION_RESET',
'ERR_NOT_CONNECTED',
'ERR_NAME_NOT_RESOLVED',
'ERR_NETWORK_CHANGED'
];
this.userAgent = null;
return instance;
} }
getOS(): string { return '';
const platform = os.platform();
if (platform === 'darwin') {
return 'Mac';
} else if (platform === 'linux') {
return 'Linux';
} else if (platform === 'win32') {
if (parseFloat(os.release()) < 6.2) {
return 'Windows 7';
} else {
return 'Windows 10';
}
} else {
return '';
}
}
setUserAgent(webViewUserAgent: string): void {
this.userAgent = `ZulipElectron/${app.getVersion()} ${webViewUserAgent}`;
}
getUserAgent(): string | null {
if (!this.userAgent) {
this.setUserAgent(ConfigUtil.getConfigItem('userAgent', null));
}
return this.userAgent;
}
} }
export = new SystemUtil(); export function getUserAgent(): string {
return userAgent;
}

View File

@@ -1,35 +1,15 @@
'use strict'; import path from 'path';
import i18n from 'i18n';
import * as ConfigUtil from './config-util';
import path = require('path'); i18n.configure({
import electron = require('electron'); directory: path.join(__dirname, '../../../translations/')
import i18n = require('i18n'); });
let instance: TranslationUtil = null; /* Fetches the current appLocale from settings.json */
let app: Electron.App = null; const appLocale = ConfigUtil.getConfigItem('appLanguage');
/* To make the util runnable in both main and renderer process */ /* If no locale present in the json, en is set default */
if (process.type === 'renderer') { export function __(phrase: string): string {
app = electron.remote.app; return i18n.__({phrase, locale: appLocale ? appLocale : 'en'});
} else {
app = electron.app;
} }
class TranslationUtil {
constructor() {
if (instance) {
return this;
}
instance = this;
i18n.configure({
directory: path.join(__dirname, '../../../translations/'),
register: this
});
}
__(phrase: string): string {
return i18n.__({ phrase, locale: app.getLocale() ? app.getLocale() : 'en' });
}
}
export = new TranslationUtil();

View File

@@ -23,7 +23,4 @@
</div> </div>
</div> </div>
</body> </body>
<script>var exports = {};</script>
<script src="js/preload.js"></script>
<script>require('./js/shared/preventdrag.js')</script>
</html> </html>

Binary file not shown.

View File

@@ -3,50 +3,47 @@ interface DialogBoxError {
content: string; content: string;
} }
class Messages { export function invalidZulipServerError(domain: string): string {
invalidZulipServerError(domain: string): string { return `${domain} does not appear to be a valid Zulip server. Make sure that
return `${domain} does not appear to be a valid Zulip server. Make sure that \n • You can connect to that URL in a web browser.\
\n • You can connect to that URL in a web browser.\ \n • If you need a proxy to connect to the Internet, that you've configured your proxy in the Network settings.\
\n • If you need a proxy to connect to the Internet, that you've configured your proxy in the Network settings.\ \n • It's a Zulip server. (The oldest supported version is 1.6).\
\n • It's a Zulip server. (The oldest supported version is 1.6).\ \n • The server has a valid certificate. (You can add custom certificates in Settings > Organizations). \
\n • The server has a valid certificate. (You can add custom certificates in Settings > Organizations). \ \n • The SSL is correctly configured for the certificate. Check out the SSL troubleshooting guide -
\n • The SSL is correctly configured for the certificate. Check out the SSL troubleshooting guide - \n https://zulip.readthedocs.io/en/stable/production/ssl-certificates.html`;
\n https://zulip.readthedocs.io/en/stable/production/ssl-certificates.html`;
}
noOrgsError(domain: string): string {
return `${domain} does not have any organizations added.\
\nPlease contact your server administrator.`;
}
certErrorMessage(domain: string, error: string): string {
return `Do you trust certificate from ${domain}? \n ${error}`;
}
certErrorDetail(): string {
return `The organization you're connecting to is either someone impersonating the Zulip server you entered, or the server you're trying to connect to is configured in an insecure way.
\nIf you have a valid certificate please add it from Settings>Organizations and try to add the organization again.
\nUnless you have a good reason to believe otherwise, you should not proceed.
\nYou can click here if you'd like to proceed with the connection.`;
}
enterpriseOrgError(length: number, domains: string[]): DialogBoxError {
let domainList = '';
for (const domain of domains) {
domainList += `${domain}\n`;
}
return {
title: `Could not add the following ${length === 1 ? `organization` : `organizations`}`,
content: `${domainList}\nPlease contact your system administrator.`
};
}
orgRemovalError(url: string): DialogBoxError {
return {
title: `Removing ${url} is a restricted operation.`,
content: `Please contact your system administrator.`
};
}
} }
export = new Messages(); export function noOrgsError(domain: string): string {
return `${domain} does not have any organizations added.\
\nPlease contact your server administrator.`;
}
export function certErrorMessage(domain: string, error: string): string {
return `Do you trust certificate from ${domain}? \n ${error}`;
}
export function certErrorDetail(): string {
return `The organization you're connecting to is either someone impersonating the Zulip server you entered, or the server you're trying to connect to is configured in an insecure way.
\nIf you have a valid certificate please add it from Settings>Organizations and try to add the organization again.
\nUnless you have a good reason to believe otherwise, you should not proceed.
\nYou can click here if you'd like to proceed with the connection.`;
}
export function enterpriseOrgError(length: number, domains: string[]): DialogBoxError {
let domainList = '';
for (const domain of domains) {
domainList += `${domain}\n`;
}
return {
title: `Could not add the following ${length === 1 ? 'organization' : 'organizations'}`,
content: `${domainList}\nPlease contact your system administrator.`
};
}
export function orgRemovalError(url: string): DialogBoxError {
return {
title: `Removing ${url} is a restricted operation.`,
content: 'Please contact your system administrator.'
};
}

Binary file not shown.

After

Width:  |  Height:  |  Size: 436 B

Binary file not shown.

After

Width:  |  Height:  |  Size: 900 B

Binary file not shown.

After

Width:  |  Height:  |  Size: 1.4 KiB

Binary file not shown.

After

Width:  |  Height:  |  Size: 1.4 KiB

View File

Before

Width:  |  Height:  |  Size: 737 B

After

Width:  |  Height:  |  Size: 737 B

View File

Before

Width:  |  Height:  |  Size: 1.7 KiB

After

Width:  |  Height:  |  Size: 1.7 KiB

View File

Before

Width:  |  Height:  |  Size: 2.8 KiB

After

Width:  |  Height:  |  Size: 2.8 KiB

View File

Before

Width:  |  Height:  |  Size: 3.8 KiB

After

Width:  |  Height:  |  Size: 3.8 KiB

View File

@@ -114,5 +114,9 @@
"Emoji & Symbols": "Emoji & Symbols", "Emoji & Symbols": "Emoji & Symbols",
"View Shortcuts": "View Shortcuts", "View Shortcuts": "View Shortcuts",
"Enter Full Screen": "Enter Full Screen", "Enter Full Screen": "Enter Full Screen",
"History Shortcuts": "History Shortcuts" "History Shortcuts": "History Shortcuts",
"Quit when the window is closed": "Quit when the window is closed",
"File": "File",
"Network and Proxy Settings": "Network and Proxy Settings",
"Ask where to save files before downloading": "Ask where to save files before downloading"
} }

View File

@@ -104,5 +104,16 @@
"Edit Shortcuts": "Edit Shortcuts", "Edit Shortcuts": "Edit Shortcuts",
"View Shortcuts": "View Shortcuts", "View Shortcuts": "View Shortcuts",
"History Shortcuts": "History Shortcuts", "History Shortcuts": "History Shortcuts",
"Window Shortcuts": "Window Shortcuts" "Window Shortcuts": "Window Shortcuts",
} "Quit when the window is closed": "Quit when the window is closed",
"Force social login in app instead of browser": "Force social login in app instead of browser",
"Ask where to save files before downloading": "Ask where to save files before downloading",
"Add a Zulip organization": "Add a Zulip organization",
"Connect": "Connect",
"OR": "OR",
"Create a new organization": "Create a new organization",
"Network and Proxy Settings": "Network and Proxy Settings",
"YES": "YES",
"NO": "NO",
"Are you sure you want to disconnect this organization?": "Are you sure you want to disconnect this organization?"
}

View File

@@ -114,5 +114,6 @@
"Zulip Help": "Zulip Help", "Zulip Help": "Zulip Help",
"keyboard shortcuts": "keyboard shortcuts", "keyboard shortcuts": "keyboard shortcuts",
"script": "script", "script": "script",
"Quit when the window is closed": "Quit when the window is closed" "Quit when the window is closed": "Quit when the window is closed",
"Ask where to save files before downloading": "Ask where to save files before downloading"
} }

View File

@@ -0,0 +1,23 @@
{
"bg": "Bulgarian",
"cs": "Czech",
"de": "Deutsch",
"en-GB": "English (UK)",
"en-US": "English (US)",
"en": "English",
"es": "Español",
"fr": "French",
"hi": "Hindi",
"hu": "Hungarian",
"id": "Indonesian",
"ja": "Japanese",
"ko": "Korean",
"ml": "Malayalam",
"nl": "Dutch",
"pl": "Polish",
"pt": "Portuguese",
"ru": "Russian",
"sr": "Macedonian",
"ta": "Tamil",
"tr": "Turkish"
}

View File

@@ -5,17 +5,16 @@ platform:
os: Previous Visual Studio 2015 os: Previous Visual Studio 2015
cache: cache:
- node_modules - node_modules -> appveyor.yml
install: install:
- ps: Install-Product node 8 x64 - ps: Install-Product node 10 x64
- git reset --hard HEAD - git reset --hard HEAD
- npm install npm -g - npm install npm -g
- node --version - node --version
- npm --version - npm --version
- python --version - python --version
- npm install - npm ci
- npm install -g gulp
build: off build: off

Binary file not shown.

View File

@@ -2,6 +2,94 @@
All notable changes to the Zulip desktop app are documented in this file. All notable changes to the Zulip desktop app are documented in this file.
### v5.2.0 --2020-05-04
**Security fixes**:
* CVE-2020-12637: Do not ignore certificate errors in webviews unless the (unsupported, deprecated) `ignoreCerts` option is enabled.
**Fixes**:
* Avoid opening the file chooser dialog twice when downloading a file.
**New features**:
* Provide clipboard decryption helper for use in new social login flow.
**Dependencies**:
* Upgrade all dependencies, including Electron 8.2.5.
### v5.1.0 --2020-04-29
**Fixes**:
* macOS: If the app is in foreground, the app will no longer hide upon clicking on dock again.
* Synchronise debian scripts with electron-builder 22.4.1, thus fixing SUID sandbox binary issues.
* Dock icon on macOS used to be larger than the other applications, which is now updated to the appropriate size.
* Upon catching error in updating the server icon, the app will log the error and make a sentry report instead of triggering user-facing network error
**New features**:
* User can now set application language without changing the language on their operating system.
**Dependencies**:
* Upgrade all dependencies, including Electron 8.2.3.
### v5.0.0 --2020-03-30
**Security fixes**:
* CVE-2020-10856: Enable Electron context isolation. (Reported by Matt Austin.)
* CVE-2020-10857: Fix unsafe use of `shell.openExternal`/`shell.openItem`. (Reported by Matt Austin.)
* Downloaded files will no longer be opened directly; the previous option to show downloaded files in the file manager is now always on.
* CVE-2020-10858: Add permission request handler to guard against audio/video recording by a malicious server. (Reported by Matt Austin.)
**New features**:
* Add an option to prompt for the location to save each downloaded file.
**Fixes**:
* Fix automatic launching at startup.
* Fix Undo and Redo functionality on macOS.
**Dependencies**:
* Upgrade all dependencies, including Electron 8.0.3.
* Remove `assert`, `cp-file`, `dotenv`, `electron-debug`, and `wurl`.
**Deprecations**:
* Since Electron upstream has discontinued support for 32-bit Linux, we will only provide 32-bit Linux builds on a best effort basis, and they will likely be removed in a future release.
### v4.0.3 --2020-02-29
**Security fixes**:
* CVE-2020-9443: Do not disable web security in the Electron webview. (Reported by Matt Austin.)
### v4.0.2-beta --2019-11-13
**New features**:
* Add support for MSI installers.
* Show badge count on Linux.
* Sync system presence info to web app.
* Add option to open notification settings from the context menu of organization icons in the sidebar.
* Tackle network issues with each Zulip organization independently.
* Add option to quit on closing the window.
* Make certificate location dynamic.
* Add option to specify network settings when adding a new organization.
**Enhancements**:
* Load last active tab before others, speeding up user experience and eliminating flashing of server icons.
* Improve UX for notification settings.
* Set User-Agent from the main process for communication with the Zulip API.
* Add SSL troubleshooting guide in error message when adding an organization fails.
**Fixes**:
* Fix translations for `ru` locales.
* Fix trailing brackets in settings page.
* Fix broken icon issue faced by the snap package on Linux.
* Reactivate `network.js` script.
* Enable notarization for macOS Catalina.
**Documentation**:
* Document enterprise configuration features.
* Update the Electron tutorial guide.
* Explicitly address where to report bugs in `README.md`.
* Fix typo in the link to server/webapp repository in `README.md`.
* Add documentation for translation.
### v4.0.0 --2019-08-08 ### v4.0.0 --2019-08-08
**New features**: **New features**:

View File

@@ -9,7 +9,7 @@ To build and run the app from source, you'll need the following:
* [Git](http://git-scm.com/book/en/v2/Getting-Started-Installing-Git) * [Git](http://git-scm.com/book/en/v2/Getting-Started-Installing-Git)
* Use our [Git Guide](https://zulip.readthedocs.io/en/latest/git/setup.html) to get started with Git and GitHub. * Use our [Git Guide](https://zulip.readthedocs.io/en/latest/git/setup.html) to get started with Git and GitHub.
* [Node.js](https://nodejs.org) >= v6.9.0 * [Node.js](https://nodejs.org) >= v10.16.3
* [NPM](https://www.npmjs.com/get-npm) and * [NPM](https://www.npmjs.com/get-npm) and
[node-gyp](https://github.com/nodejs/node-gyp#installation), [node-gyp](https://github.com/nodejs/node-gyp#installation),
if they don't come bundled with your Node.js installation if they don't come bundled with your Node.js installation
@@ -111,4 +111,4 @@ operating system you're running on:
To generate all three types of files, you will need all three operating To generate all three types of files, you will need all three operating
systems. systems.
The output distributable packages appear in the `dist/` directory. The output distributable packages appear in the `dist/` directory.

View File

@@ -5,14 +5,14 @@ const electron = require('electron-connect').server.create({
}); });
const tape = require('gulp-tape'); const tape = require('gulp-tape');
const tapColorize = require('tap-colorize'); const tapColorize = require('tap-colorize');
const ts = require("gulp-typescript"); const ts = require('gulp-typescript');
const tsProject = ts.createProject("tsconfig.json"); const tsProject = ts.createProject('tsconfig.json');
const glob = require('glob'); const glob = require('glob');
const { execSync } = require('child_process'); const {execSync} = require('child_process');
const baseFilePattern = 'app/+(main|renderer)/**/*'; const baseFilePattern = 'app/+(main|renderer)/**/*';
const globOptions = { cwd: __dirname }; const globOptions = {cwd: __dirname};
const jsFiles = glob.sync(baseFilePattern + '.js', globOptions); const jsFiles = glob.sync(baseFilePattern + '.js', globOptions);
const tsFiles = glob.sync(baseFilePattern + '.ts', globOptions); const tsFiles = glob.sync(baseFilePattern + '.ts', globOptions);
if (jsFiles.length !== tsFiles.length) { if (jsFiles.length !== tsFiles.length) {
@@ -21,18 +21,18 @@ if (jsFiles.length !== tsFiles.length) {
execSync(`${npx} tsc`); execSync(`${npx} tsc`);
} }
gulp.task("compile", function () { gulp.task('compile', () => {
return tsProject.src() return tsProject.src()
.pipe(tsProject()) .pipe(tsProject())
.js.pipe(gulp.dest("app")); .js.pipe(gulp.dest('app'));
}); });
gulp.task('dev', () => { gulp.task('dev', () => {
// Start browser process // Start browser process
electron.start(); electron.start();
// Restart browser process // Restart browser process
gulp.watch('app/main/*.ts', gulp.series('compile', 'restart:browser')); gulp.watch('app/main/*.ts', gulp.series('compile', 'restart:browser'));
// Reload renderer process // Reload renderer process
gulp.watch('app/renderer/css/*.css', gulp.series('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/*.html', gulp.series('reload:renderer'));
gulp.watch('app/renderer/js/**/*.ts', gulp.series('compile', 'reload:renderer')); gulp.watch('app/renderer/js/**/*.ts', gulp.series('compile', 'reload:renderer'));
@@ -45,16 +45,16 @@ gulp.task('restart:browser', done => {
}); });
gulp.task('reload:renderer', done => { gulp.task('reload:renderer', done => {
// Reload renderer process // Reload renderer process
electron.reload(); electron.reload();
done(); done();
}); });
gulp.task('test-e2e', () => { gulp.task('test-e2e', () => {
return gulp.src('tests/*.js') return gulp.src('tests/*.js')
.pipe(tape({ .pipe(tape({
reporter: tapColorize() reporter: tapColorize()
})); }));
}); });
gulp.task('default', gulp.parallel('dev', 'test-e2e')); gulp.task('default', gulp.parallel('dev', 'test-e2e'));

13140
package-lock.json generated

File diff suppressed because it is too large Load Diff

View File

@@ -1,7 +1,7 @@
{ {
"name": "zulip", "name": "zulip",
"productName": "Zulip", "productName": "Zulip",
"version": "4.0.2-beta", "version": "5.2.0",
"main": "./app/main", "main": "./app/main",
"description": "Zulip Desktop App", "description": "Zulip Desktop App",
"license": "Apache-2.0", "license": "Apache-2.0",
@@ -18,25 +18,24 @@
"url": "https://github.com/zulip/zulip-desktop/issues" "url": "https://github.com/zulip/zulip-desktop/issues"
}, },
"engines": { "engines": {
"node": ">=6.0.0" "node": ">=10.0.0"
}, },
"scripts": { "scripts": {
"start": "node tools/run-dev", "start": "tsc && electron .",
"clean-ts-files": "git clean app/*.js -xf", "clean-ts-files": "git clean app/*.js -e node_modules -xf",
"watch-ts": "tsc -w", "watch-ts": "tsc -w",
"reinstall": "node ./tools/reinstall-node-modules.js", "reinstall": "node ./tools/reinstall-node-modules.js",
"postinstall": "electron-builder install-app-deps", "postinstall": "electron-builder install-app-deps",
"lint-css": "stylelint app/renderer/css/*.css", "lint-css": "stylelint app/renderer/css/*.css",
"lint-html": "./node_modules/.bin/htmlhint \"app/renderer/*.html\" ", "lint-html": "./node_modules/.bin/htmlhint \"app/renderer/*.html\" ",
"lint-js": "xo", "lint-js": "xo",
"test": "npm run lint-html && npm run lint-css && npm run lint-js", "test": "tsc --noEmit && npm run lint-html && npm run lint-css && npm run lint-js",
"test-e2e": "gulp test-e2e", "test-e2e": "gulp test-e2e",
"compile": "gulp compile", "compile": "gulp compile",
"dev": "gulp dev && npm test", "dev": "gulp dev && npm test",
"pack": "tsc && electron-builder --dir", "pack": "tsc && electron-builder --dir",
"dist": "tsc && electron-builder", "dist": "tsc && electron-builder",
"mas": "tsc && electron-builder --mac mas", "mas": "tsc && electron-builder --mac mas",
"travis": "cd ./scripts && ./travis-build-test.sh",
"build-locales": "node tools/locale-helper" "build-locales": "node tools/locale-helper"
}, },
"pre-commit": [ "pre-commit": [
@@ -50,9 +49,8 @@
"**/*.node" "**/*.node"
], ],
"files": [ "files": [
"**/*", "app/**/*",
"!docs${/*}", "!**/node_modules/cld/deps/cld"
"!node_modules/@paulcbetts/cld/deps/cld${/*}"
], ],
"copyright": "©2019 Kandra Labs, Inc.", "copyright": "©2019 Kandra Labs, Inc.",
"mac": { "mac": {
@@ -143,97 +141,106 @@
"Desktop app", "Desktop app",
"InstantMessaging" "InstantMessaging"
], ],
"dependencies": {
"@electron-elements/send-feedback": "^1.0.8",
"@sentry/electron": "^1.3.0",
"adm-zip": "^0.4.14",
"auto-launch": "^5.0.5",
"backoff": "^2.5.0",
"electron-is-dev": "^1.2.0",
"electron-log": "^4.1.2",
"electron-spellchecker": "^2.2.1",
"electron-updater": "^4.3.1",
"electron-window-state": "^5.0.3",
"escape-html": "^1.0.3",
"fs-extra": "^9.0.0",
"i18n": "^0.9.1",
"node-json-db": "^1.1.0",
"request": "^2.88.2",
"rxjs": "^5.5.12",
"semver": "^7.3.2"
},
"optionalDependencies": {
"node-mac-notifier": "^1.1.0"
},
"devDependencies": { "devDependencies": {
"@types/adm-zip": "^0.4.32", "@types/adm-zip": "^0.4.33",
"@types/dotenv": "6.1.1", "@types/auto-launch": "^5.0.1",
"@typescript-eslint/eslint-plugin": "1.10.2", "@types/backoff": "^2.5.1",
"@typescript-eslint/parser": "1.10.2", "@types/electron-spellchecker": "^1.1.2",
"@vitalets/google-translate-api": "2.8.0", "@types/escape-html": "0.0.20",
"assert": "1.4.1", "@types/fs-extra": "^8.1.0",
"cp-file": "5.0.0", "@types/i18n": "^0.8.6",
"devtron": "1.4.0", "@types/node": "^13.13.4",
"electron": "3.1.10", "@types/request": "^2.48.4",
"electron-builder": "20.43.0", "@types/requestidlecallback": "^0.3.1",
"electron-connect": "0.6.2", "@typescript-eslint/eslint-plugin": "^2.30.0",
"electron-debug": "1.4.0", "@typescript-eslint/parser": "^2.30.0",
"electron-notarize": "0.2.0", "@vitalets/google-translate-api": "^3.0.0",
"eslint-config-xo-typescript": "0.14.0", "devtron": "^1.4.0",
"fs-extra": "8.1.0", "dotenv": "^8.2.0",
"gulp": "4.0.0", "electron": "^8.2.5",
"gulp-tape": "0.0.9", "electron-builder": "^22.6.0",
"gulp-typescript": "5.0.1", "electron-connect": "^0.6.3",
"htmlhint": "0.11.0", "electron-notarize": "^0.3.0",
"is-ci": "1.0.10", "eslint-config-xo-typescript": "^0.28.0",
"nodemon": "1.14.11", "glob": "^7.1.6",
"pre-commit": "1.2.2", "gulp": "^4.0.2",
"spectron": "5.0.0", "gulp-tape": "^1.0.0",
"stylelint": "9.10.1", "gulp-typescript": "^6.0.0-alpha.1",
"tap-colorize": "1.2.0", "htmlhint": "^0.11.0",
"tape": "4.8.0", "nodemon": "^2.0.3",
"typescript": "3.5.2", "pre-commit": "^1.2.2",
"xo": "0.24.0" "rimraf": "^3.0.2",
"spectron": "^10.0.1",
"stylelint": "^13.3.3",
"tap-colorize": "^1.2.0",
"tape": "^5.0.0",
"typescript": "^3.8.3",
"xo": "^0.30.0"
}, },
"xo": { "xo": {
"extends": "xo-typescript", "rules": {
"extensions": [ "@typescript-eslint/no-dynamic-delete": "off",
"ts" "@typescript-eslint/prefer-readonly-parameter-types": "off",
], "import/unambiguous": "error",
"parserOptions": { "max-lines": [
"ecmaVersion": 6, "warn",
"sourceType": "module", {
"ecmaFeatures": { "max": 900,
"globalReturn": true, "skipBlankLines": true,
"modules": true "skipComments": true
}
},
"esnext": true,
"overrides": [
{
"files": "app/**/*.ts",
"rules": {
"max-lines": [
"warn",
{
"max": 800,
"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,
"lines-between-class-members": 0,
"padding-line-between-statements": 0,
"quotes": 0,
"unicorn/catch-error-name": 0,
"unicorn/no-console-spaces": 0,
"node/no-deprecated-api": 0,
"@typescript-eslint/member-ordering": "never",
"@typescript-eslint/restrict-plus-operands": "never",
"import/default": 0,
"@typescript-eslint/no-unused-vars": 0
} }
} ],
], "no-warning-comments": "off",
"ignore": [ "strict": "error"
"tests/*.js", },
"tools/locale-helper/*.js",
"*/**/*.js",
"*.js",
"typings.d.ts"
],
"envs": [ "envs": [
"node", "node",
"browser", "browser"
"mocha" ],
"overrides": [
{
"files": [
"app/renderer/js/injected.ts",
"gulpfile.js",
"scripts/notarize.js",
"tests/**/*.js",
"tools/locale-helper/index.js",
"tools/reinstall-node-modules.js"
],
"parserOptions": {
"sourceType": "script"
}
},
{
"files": [
"**/*.d.ts"
],
"rules": {
"import/unambiguous": "off"
}
}
] ]
} }
} }

View File

@@ -3,8 +3,13 @@
# This script runs when user install the debian package # This script runs when user install the debian package
# Link to the binary # Link to the binary
ln -sf '/opt/${productFilename}/${executable}' '/usr/local/bin/${executable}'; ln -sf '/opt/${productFilename}/${executable}' '/usr/bin/${executable}'
echo 'Successfully added /opt/${productFilename}/${executable} to /usr/local/bin/${executable}'
# SUID chrome-sandbox for Electron 5+
chmod 4755 '/opt/${productFilename}/chrome-sandbox' || true
update-mime-database /usr/share/mime || true
update-desktop-database /usr/share/applications || true
# Install apt repository source list if it does not exist # Install apt repository source list if it does not exist
if ! grep ^ /etc/apt/sources.list /etc/apt/sources.list.d/* | grep zulip.list; then if ! grep ^ /etc/apt/sources.list /etc/apt/sources.list.d/* | grep zulip.list; then

View File

@@ -31,5 +31,4 @@ if [ -d $appDirectory ]; then
fi fi
# Delete the link to the binary # Delete the link to the binary
echo 'Removing binary link' rm -f '/usr/bin/${executable}'
sudo rm -f '/usr/local/bin/${executable}';

View File

@@ -1,22 +1,24 @@
'use strict';
const path = require('path'); const path = require('path');
const dotenv = require('dotenv'); const dotenv = require('dotenv');
dotenv.config({ path: path.join(__dirname, '/../.env') }); dotenv.config({path: path.join(__dirname, '/../.env')});
const { notarize } = require('electron-notarize'); const {notarize} = require('electron-notarize');
exports.default = async function notarizing(context) { exports.default = async function (context) {
const { electronPlatformName, appOutDir } = context; const {electronPlatformName, appOutDir} = context;
if (electronPlatformName !== 'darwin') { if (electronPlatformName !== 'darwin') {
return; return;
} }
const appName = context.packager.appInfo.productFilename; const appName = context.packager.appInfo.productFilename;
return await notarize({ return notarize({
appBundleId: 'org.zulip.zulip-electron', appBundleId: 'org.zulip.zulip-electron',
appPath: `${appOutDir}/${appName}.app`, appPath: `${appOutDir}/${appName}.app`,
appleId: process.env.APPLE_ID, appleId: process.env.APPLE_ID,
appleIdPassword: process.env.APPLE_ID_PASS, appleIdPassword: process.env.APPLE_ID_PASS,
}); ascProvider: process.env.ASC_PROVIDER // Team short name
});
}; };

View File

@@ -1,20 +0,0 @@
#!/usr/bin/env bash
# exit script if fails
set -e;
if [[ "$TRAVIS_OS_NAME" == "linux" ]]; then
export {no_proxy,NO_PROXY}="127.0.0.1,localhost"
export DISPLAY=:99.0
sh -e /etc/init.d/xvfb start
sleep 3
echo 'Travis Screen Resolution:'
xdpyinfo | grep dimensions
fi
npm run test
# if [[ "$TRAVIS_OS_NAME" == "osx" ]]; then
# npm run test-e2e
# fi

View File

@@ -1,5 +0,0 @@
#!/usr/bin/env bash
if [[ "$TRAVIS_OS_NAME" == "linux" ]]; then
/sbin/start-stop-daemon --start --quiet --pidfile /tmp/custom_xvfb_99.pid --make-pidfile --background --exec /usr/bin/Xvfb -- :99 -ac -screen 0 1280x1024x16
fi

View File

@@ -1,7 +1,7 @@
const path = require('path') 'use strict';
const TEST_APP_PRODUCT_NAME = 'ZulipTest' const TEST_APP_PRODUCT_NAME = 'ZulipTest';
module.exports = { module.exports = {
TEST_APP_PRODUCT_NAME TEST_APP_PRODUCT_NAME
} };

View File

@@ -1,183 +0,0 @@
{
"name": "zulip",
"productName": "Zulip",
"version": "2.4.0",
"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": {
"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": "3.0.10",
"electron-builder": "20.38.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": 600,
"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/*.js",
"tools/locale-helper/*.js"
],
"envs": [
"node",
"browser",
"mocha"
]
}
}

View File

@@ -1,13 +1,17 @@
const test = require('tape') 'use strict';
const setup = require('./setup') const test = require('tape');
const setup = require('./setup');
test('app runs', function (t) { test('app runs', async t => {
t.timeoutAfter(10e3) t.timeoutAfter(10e3);
setup.resetTestDataDir() setup.resetTestDataDir();
const app = setup.createApp() const app = setup.createApp();
setup.waitForLoad(app, t) try {
.then(() => app.client.windowByIndex(1)) // focus on webview await setup.waitForLoad(app, t);
.then(() => app.client.waitForExist('//*[@id="connect"]')) // id of the connect button await app.client.windowByIndex(1); // Focus on webview
.then(() => setup.endTest(app, t), await app.client.waitForExist('//*[@id="connect"]'); // Id of the connect button
(err) => setup.endTest(app, t, err || 'error')) await setup.endTest(app, t);
}) } catch (error) {
await setup.endTest(app, t, error || 'error');
}
});

View File

@@ -1,99 +1,96 @@
const Application = require('spectron').Application 'use strict';
const cpFile = require('cp-file') const {Application} = require('spectron');
const fs = require('fs') const fs = require('fs');
const isCI = require('is-ci') const path = require('path');
const mkdirp = require('mkdirp') const rimraf = require('rimraf');
const path = require('path')
const rimraf = require('rimraf')
const config = require('./config') const config = require('./config');
module.exports = { module.exports = {
createApp, createApp,
endTest, endTest,
waitForLoad, waitForLoad,
wait, wait,
resetTestDataDir resetTestDataDir
} };
// Runs Zulip Desktop. // Runs Zulip Desktop.
// Returns a promise that resolves to a Spectron Application once the app has loaded. // Returns a promise that resolves to a Spectron Application once the app has loaded.
// Takes a Tape test. Makes some basic assertions to verify that the app loaded correctly. // Takes a Tape test. Makes some basic assertions to verify that the app loaded correctly.
function createApp (t) { function createApp() {
generateTestAppPackageJson() generateTestAppPackageJson();
return new Application({ return new Application({
path: path.join(__dirname, '..', 'node_modules', '.bin', path: path.join(__dirname, '..', 'node_modules', '.bin',
'electron' + (process.platform === 'win32' ? '.cmd' : '')), 'electron' + (process.platform === 'win32' ? '.cmd' : '')),
args: [path.join(__dirname)], // Ensure this dir has a package.json file with a 'main' entry piont args: [path.join(__dirname)], // Ensure this dir has a package.json file with a 'main' entry piont
env: {NODE_ENV: 'test'}, env: {NODE_ENV: 'test'},
waitTimeout: 10e3 waitTimeout: 10e3
}) });
} }
// Generates package.json for test app // Generates package.json for test app
// Reads app package.json and updates the productName to config.TEST_APP_PRODUCT_NAME // Reads app package.json and updates the productName to config.TEST_APP_PRODUCT_NAME
// We do this so that the app integration doesn't doesn't share the same appDataDir as the dev application // We do this so that the app integration doesn't doesn't share the same appDataDir as the dev application
function generateTestAppPackageJson () { function generateTestAppPackageJson() {
let packageJson = require(path.join(__dirname, '../package.json')) const packageJson = require(path.join(__dirname, '../package.json'));
packageJson.productName = config.TEST_APP_PRODUCT_NAME packageJson.productName = config.TEST_APP_PRODUCT_NAME;
packageJson.main = '../app/main' packageJson.main = '../app/main';
const testPackageJsonPath = path.join(__dirname, 'package.json') const testPackageJsonPath = path.join(__dirname, 'package.json');
fs.writeFileSync(testPackageJsonPath, JSON.stringify(packageJson, null, ' '), 'utf-8') fs.writeFileSync(testPackageJsonPath, JSON.stringify(packageJson, null, ' '), 'utf-8');
} }
// Starts the app, waits for it to load, returns a promise // Starts the app, waits for it to load, returns a promise
function waitForLoad (app, t, opts) { async function waitForLoad(app, t, options) {
if (!opts) opts = {} if (!options) {
return app.start().then(function () { options = {};
return app.client.waitUntilWindowLoaded() }
})
.then(function() { await app.start();
return app.client.pause(2000); await app.client.waitUntilWindowLoaded();
}) await app.client.pause(2000);
.then(function () { const title = await app.webContents.getTitle();
return app.webContents.getTitle() t.equal(title, 'Zulip', 'html title');
}).then(function (title) {
t.equal(title, 'Zulip', 'html title')
})
} }
// Returns a promise that resolves after 'ms' milliseconds. Default: 1 second // Returns a promise that resolves after 'ms' milliseconds. Default: 1 second
function wait (ms) { async function wait(ms) {
if (ms === undefined) ms = 1000 // Default: wait long enough for the UI to update if (ms === undefined) {
return new Promise(function (resolve, reject) { ms = 1000;
setTimeout(resolve, ms) } // Default: wait long enough for the UI to update
})
return new Promise((resolve => {
setTimeout(resolve, ms);
}));
} }
// Quit the app, end the test, either in success (!err) or failure (err) // Quit the app, end the test, either in success (!err) or failure (err)
function endTest (app, t, err) { async function endTest(app, t, err) {
return app.stop().then(function () { await app.stop();
t.end(err) t.end(err);
})
} }
function getAppDataDir () { function getAppDataDir() {
let base let base;
if (process.platform === 'darwin') { if (process.platform === 'darwin') {
base = path.join(process.env.HOME, 'Library', 'Application Support') base = path.join(process.env.HOME, 'Library', 'Application Support');
} else if (process.platform === 'linux') { } else if (process.platform === 'linux') {
base = process.env.XDG_CONFIG_HOME ? base = process.env.XDG_CONFIG_HOME ?
process.env.XDG_CONFIG_HOME : path.join(process.env.HOME, '.config') process.env.XDG_CONFIG_HOME : path.join(process.env.HOME, '.config');
} else if (process.platform === 'win32') { } else if (process.platform === 'win32') {
base = process.env.APPDATA base = process.env.APPDATA;
} else { } else {
console.log('Could not detect app data dir base. Exiting...') throw new Error('Could not detect app data dir base.');
process.exit(1) }
}
console.log('Detected App Data Dir base:', base) console.log('Detected App Data Dir base:', base);
return path.join(base, config.TEST_APP_PRODUCT_NAME) return path.join(base, config.TEST_APP_PRODUCT_NAME);
} }
// Resets the test directory, containing domain.json, window-state.json, etc // Resets the test directory, containing domain.json, window-state.json, etc
function resetTestDataDir () { function resetTestDataDir() {
appDataDir = getAppDataDir() const appDataDir = getAppDataDir();
rimraf.sync(appDataDir) rimraf.sync(appDataDir);
rimraf.sync(path.join(__dirname, 'package.json')) rimraf.sync(path.join(__dirname, 'package.json'));
} }

View File

@@ -1,19 +1,22 @@
const test = require('tape') 'use strict';
const setup = require('./setup') const test = require('tape');
const setup = require('./setup');
test('add-organization', function (t) {
t.timeoutAfter(50e3)
setup.resetTestDataDir()
const app = setup.createApp()
setup.waitForLoad(app, t)
.then(() => app.client.windowByIndex(1)) // focus on webview
.then(() => app.client.setValue('.setting-input-value', 'chat.zulip.org'))
.then(() => app.client.click('.server-save-action'))
.then(() => setup.wait(5000))
.then(() => app.client.windowByIndex(0)) // Switch focus back to main win
.then(() => app.client.windowByIndex(1)) // Switch focus back to org webview
.then(() => app.client.waitForExist('//*[@id="id_username"]'))
.then(() => setup.endTest(app, t),
(err) => setup.endTest(app, t, err || 'error'))
})
test('add-organization', async t => {
t.timeoutAfter(50e3);
setup.resetTestDataDir();
const app = setup.createApp();
try {
await setup.waitForLoad(app, t);
await app.client.windowByIndex(1); // Focus on webview
await app.client.setValue('.setting-input-value', 'chat.zulip.org');
await app.client.click('#connect');
await setup.wait(5000);
await app.client.windowByIndex(0); // Switch focus back to main win
await app.client.windowByIndex(1); // Switch focus back to org webview
await app.client.waitForExist('//*[@id="id_username"]');
await setup.endTest(app, t);
} catch (error) {
await setup.endTest(app, t, error || 'error');
}
});

View File

@@ -1,17 +1,20 @@
const test = require('tape') 'use strict';
const setup = require('./setup') const test = require('tape');
const setup = require('./setup');
// Create new org link should open in the default browser [WIP] // Create new org link should open in the default browser [WIP]
test('new-org-link', function (t) { test('new-org-link', async t => {
t.timeoutAfter(50e3) t.timeoutAfter(50e3);
setup.resetTestDataDir() setup.resetTestDataDir();
const app = setup.createApp() const app = setup.createApp();
setup.waitForLoad(app, t) try {
.then(() => app.client.windowByIndex(1)) // focus on webview await setup.waitForLoad(app, t);
.then(() => app.client.click('#open-create-org-link')) // Click on new org link button await app.client.windowByIndex(1); // Focus on webview
.then(() => setup.wait(5000)) await app.client.click('#open-create-org-link'); // Click on new org link button
.then(() => setup.endTest(app, t), await setup.wait(5000);
(err) => setup.endTest(app, t, err || 'error')) await setup.endTest(app, t);
}) } catch (error) {
await setup.endTest(app, t, error || 'error');
}
});

View File

@@ -1,3 +1,4 @@
'use strict';
const translate = require('@vitalets/google-translate-api'); const translate = require('@vitalets/google-translate-api');
const path = require('path'); const path = require('path');
const fs = require('fs'); const fs = require('fs');
@@ -5,28 +6,30 @@ const fs = require('fs');
const translationDir = path.resolve(__dirname, '../../app/translations'); const translationDir = path.resolve(__dirname, '../../app/translations');
function writeJSON(file, data) { function writeJSON(file, data) {
const filePath = path.resolve(translationDir, file); const filePath = path.resolve(translationDir, file);
fs.writeFileSync(filePath, `${JSON.stringify(data, null, '\t')}\n`, 'utf8'); fs.writeFileSync(filePath, `${JSON.stringify(data, null, '\t')}\n`, 'utf8');
} }
const { phrases } = require('./locale-template'); const {phrases} = require('./locale-template');
const supportedLocales = require('./supported-locales'); const supportedLocales = require('./supported-locales.json');
phrases.sort(); phrases.sort();
for (let locale in supportedLocales) { for (const [locale, name] of Object.entries(supportedLocales)) {
console.log(`fetching translation for: ${supportedLocales[locale]} - ${locale}..`); console.log(`fetching translation for: ${name} - ${locale}..`);
translate(phrases.join('\n'), { to: locale }) (async () => {
.then(res => { try {
const localeFile = `${locale}.json`; const result = await translate(phrases.join('\n'), {to: locale});
const translatedText = res.text.split('\n'); const localeFile = `${locale}.json`;
const translationJSON = {}; const translatedText = result.text.split('\n');
phrases.forEach((phrase, index) => { const translationJSON = {};
translationJSON[phrase] = translatedText[index]; phrases.forEach((phrase, index) => {
}); translationJSON[phrase] = translatedText[index];
});
writeJSON(localeFile, translationJSON); writeJSON(localeFile, translationJSON);
console.log(`create: ${localeFile}`); console.log(`create: ${localeFile}`);
}).catch(err => { } catch (error) {
console.error(err); console.error(error);
}); }
})();
} }

View File

@@ -1,4 +1,4 @@
module.exports = { {
"de": "Deutsch", "de": "Deutsch",
"pl": "polski", "pl": "polski",
"en": "English", "en": "English",
@@ -18,4 +18,4 @@ module.exports = {
"es": "español", "es": "español",
"ko": "한국어", "ko": "한국어",
"fr": "français" "fr": "français"
}; }

View File

@@ -2,9 +2,8 @@
set -e set -e
set -x set -x
echo "Removing node_modules and app/node_modules" echo "Removing node_modules"
rm -rf node_modules rm -rf node_modules
rm -rf app/node_modules
echo "node_modules removed reinstalling npm packages" echo "node_modules removed reinstalling npm packages"
npm i npm i

View File

@@ -1,8 +1,7 @@
@echo off @echo off
echo "Removing node_modules and app/node_modules" echo "Removing node_modules"
rmdir /s /q node_modules rmdir /s /q node_modules
rmdir /s /q app/node_modules
echo "node_modules removed reinstalling npm packages" echo "node_modules removed reinstalling npm packages"
npm i npm i

View File

@@ -1,4 +1,5 @@
#!/usr/bin/env node #!/usr/bin/env node
'use strict';
const {exec} = require('child_process'); const {exec} = require('child_process');
const path = require('path'); const path = require('path');

Some files were not shown because too many files have changed in this diff Show More