Respect "Do Not Disturb" on macOS (#760)

package.json

@@ -25,6 +25,7 @@
 		"publish-snap": "del dist && tsc && electron-builder --linux && snapcraft push --release=stable dist/*.snap"
 	},
 	"dependencies": {
+		"@sindresorhus/do-not-disturb": "^1.1.0",
 		"electron-context-menu": "^0.15.0",
 		"electron-debug": "^3.0.1",
 		"electron-dl": "^1.14.0",

readme.md

@@ -29,6 +29,7 @@ Caprine is an unofficial and privacy-focused Facebook Messenger app with many us
 - Silent auto-updates
 - Custom text size
 - Emoji style setting
+- Respects Do Not Disturb\*
 
 \*macOS only
 

source/browser.ts

@@ -10,6 +10,7 @@ import './browser/conversation-list'; // eslint-disable-line import/no-unassigne
 
 const selectedConversationSelector = '._5l-3._1ht1._1ht2';
 const preferencesSelector = '._10._4ebx.uiLayer._4-hy';
+const messengerSoundsSelector = `${preferencesSelector} ._374d ._6bkz`;
 
 async function withMenu(
 	menuButtonElement: HTMLElement,
@@ -55,7 +56,9 @@ function selectMenuItem(itemNumber: number): void {
 		`.uiLayer:not(.hidden_elem) ._54nq._2i-c._558b._2n_z li:nth-child(${itemNumber}) a`
 	)!;
 
-	selector.click();
+	if (selector) {
+		selector.click();
+	}
 }
 
 async function selectOtherListViews(itemNumber: number): Promise<void> {
@@ -183,10 +186,8 @@ function setSidebarVisibility(): void {
 	ipc.send('set-sidebar-visibility');
 }
 
-ipc.on('toggle-mute-notifications', async (_event: ElectronEvent, defaultStatus: boolean) => {
-	const preferencesAreOpen = isPreferencesOpen();
-
-	if (!preferencesAreOpen) {
+async function openHiddenPreferences(): Promise<boolean> {
+	if (!isPreferencesOpen()) {
 		const style = document.createElement('style');
 		// Hide both the backdrop and the preferences dialog
 		style.textContent = `${preferencesSelector} ._3ixn, ${preferencesSelector} ._59s7 { opacity: 0 !important }`;
@@ -196,7 +197,31 @@ ipc.on('toggle-mute-notifications', async (_event: ElectronEvent, defaultStatus:
 
 		// Will clean up itself after the preferences are closed
 		document.querySelector<HTMLElement>(preferencesSelector)!.append(style);
+
+		return true;
+	}
+
+	return false;
+}
+
+ipc.on(
+	'toggle-sounds',
+	async (_event: ElectronEvent, checked: boolean): Promise<void> => {
+		const shouldClosePreferences = await openHiddenPreferences();
+
+		const soundsCheckbox = document.querySelector<HTMLInputElement>(messengerSoundsSelector)!;
+		if (typeof checked === 'undefined' || checked !== soundsCheckbox.checked) {
+			soundsCheckbox.click();
+		}
+
+		if (shouldClosePreferences) {
+			closePreferences();
+		}
 	}
+);
+
+ipc.on('toggle-mute-notifications', async (_event: ElectronEvent, defaultStatus: boolean) => {
+	const shouldClosePreferences = await openHiddenPreferences();
 
 	const notificationCheckbox = document.querySelector<HTMLInputElement>(
 		selectors.notificationCheckbox
@@ -213,7 +238,7 @@ ipc.on('toggle-mute-notifications', async (_event: ElectronEvent, defaultStatus:
 
 	ipc.send('mute-notifications-toggled', !notificationCheckbox.checked);
 
-	if (!preferencesAreOpen) {
+	if (shouldClosePreferences) {
 		closePreferences();
 	}
 });
@@ -274,6 +299,17 @@ function updateVibrancy(): void {
 	ipc.send('set-vibrancy');
 }
 
+async function updateDoNotDisturb(): Promise<void> {
+	const shouldClosePreferences = await openHiddenPreferences();
+	const soundsCheckbox = document.querySelector<HTMLInputElement>(messengerSoundsSelector)!;
+
+	if (shouldClosePreferences) {
+		closePreferences();
+	}
+
+	ipc.send('update-dnd-mode', soundsCheckbox.checked);
+}
+
 function renderOverlayIcon(messageCount: number): HTMLCanvasElement {
 	const canvas = document.createElement('canvas');
 	canvas.height = 128;
@@ -482,7 +518,7 @@ function insertionListener(event: AnimationEvent): void {
 document.addEventListener('animationstart', insertionListener, false);
 
 // Inject a global style node to maintain custom appearance after conversation change or startup
-document.addEventListener('DOMContentLoaded', () => {
+document.addEventListener('DOMContentLoaded', async () => {
 	const style = document.createElement('style');
 	style.id = 'zoomFactor';
 	document.body.append(style);
@@ -503,6 +539,11 @@ document.addEventListener('DOMContentLoaded', () => {
 	// Activate Private Mode if it was set before quitting
 	setPrivateMode();
 
+	// Configure do not disturb
+	if (is.macos) {
+		await updateDoNotDisturb();
+	}
+
 	// Prevent flash of white on startup when in dark mode
 	// TODO: find a CSS-only solution
 	if (!is.macos && config.get('darkMode')) {

source/do-not-disturb.d.ts

@@ -0,0 +1 @@
+declare module '@sindresorhus/do-not-disturb';

source/index.ts

@@ -24,6 +24,7 @@ import electronLocalshortcut = require('electron-localshortcut');
 import electronDebug = require('electron-debug');
 import {is, darkMode} from 'electron-util';
 import {bestFacebookLocaleFor} from 'facebook-locales';
+import doNotDisturb = require('@sindresorhus/do-not-disturb');
 import updateAppMenu from './menu';
 import config from './config';
 import tray from './tray';
@@ -69,6 +70,7 @@ let mainWindow: BrowserWindow;
 let isQuitting = false;
 let prevMessageCount = 0;
 let dockMenu: Menu;
+let isDNDEnabled = false;
 
 if (!app.requestSingleInstanceLock()) {
 	app.quit();
@@ -97,11 +99,16 @@ function updateBadge(conversations: Conversation[]): void {
 	const messageCount = getMessageCount(conversations);
 
 	if (is.macos || is.linux) {
-		if (config.get('showUnreadBadge')) {
+		if (config.get('showUnreadBadge') && !isDNDEnabled) {
 			app.setBadgeCount(messageCount);
 		}
 
-		if (is.macos && config.get('bounceDockOnMessage') && prevMessageCount !== messageCount) {
+		if (
+			is.macos &&
+			!isDNDEnabled &&
+			config.get('bounceDockOnMessage') &&
+			prevMessageCount !== messageCount
+		) {
 			app.dock.bounce('informational');
 			prevMessageCount = messageCount;
 		}
@@ -395,6 +402,19 @@ function createMainWindow(): BrowserWindow {
 			mainWindow.show();
 		}
 
+		if (is.macos) {
+			ipcMain.on('update-dnd-mode', async (_event: ElectronEvent, initialSoundsValue) => {
+				doNotDisturb.on('change', (doNotDisturb: boolean) => {
+					isDNDEnabled = doNotDisturb;
+					webContents.send('toggle-sounds', isDNDEnabled ? false : initialSoundsValue);
+				});
+
+				isDNDEnabled = await doNotDisturb.isEnabled();
+
+				webContents.send('toggle-sounds', isDNDEnabled ? false : initialSoundsValue);
+			});
+		}
+
 		webContents.send('toggle-mute-notifications', config.get('notificationsMuted'));
 		webContents.send('toggle-message-buttons', config.get('showMessageButtons'));