super-productivity/electron/main.ts
2022-10-28 17:15:05 +02:00

511 lines
13 KiB
TypeScript

'use strict';
import {
App,
app,
BrowserWindow,
globalShortcut,
ipcMain,
powerMonitor,
protocol,
} from 'electron';
import * as electronDl from 'electron-dl';
import { info, log } from 'electron-log';
import { CONFIG } from './CONFIG';
import { initIndicator } from './indicator';
import { createWindow } from './main-window';
import { sendJiraRequest, setupRequestHeadersForImages } from './jira';
import { errorHandlerWithFrontendInform } from './error-handler-with-frontend-inform';
import { initDebug } from './debug';
import { IPC } from './shared-with-frontend/ipc-events.const';
import { initBackupAdapter } from './backup';
import { initLocalFileSyncAdapter } from './local-file-sync';
import { JiraCfg } from '../src/app/features/issue/providers/jira/jira.model';
import { lockscreen } from './lockscreen';
import { lazySetInterval } from './shared-with-frontend/lazy-set-interval';
import { KeyboardConfig } from '../src/app/features/config/keyboard-config.model';
import { initialize } from '@electron/remote/main';
import { join } from 'path';
import {
existsSync,
mkdirSync,
readdirSync,
readFileSync,
statSync,
writeFileSync,
} from 'fs';
import { exec } from 'child_process';
import { initFullScreenBlocker } from './full-screen-blocker';
initialize();
const ICONS_FOLDER = __dirname + '/assets/icons/';
const IS_MAC = process.platform === 'darwin';
// const DESKTOP_ENV = process.env.DESKTOP_SESSION;
// const IS_GNOME = DESKTOP_ENV === 'gnome' || DESKTOP_ENV === 'gnome-xorg';
const IS_DEV = process.env.NODE_ENV === 'DEV';
let isShowDevTools: boolean = IS_DEV;
let customUrl: string;
let isDisableTray = false;
let forceDarkTray = false;
let wasUserDataDirSet = false;
if (IS_DEV) {
log('Starting in DEV Mode!!!');
}
// NOTE: needs to be executed before everything else
process.argv.forEach((val) => {
if (val && val.includes('--disable-tray')) {
isDisableTray = true;
log('Disable tray icon');
}
if (val && val.includes('--force-dark-tray')) {
forceDarkTray = true;
log('Force dark mode for tray icon');
}
if (val && val.includes('--user-data-dir=')) {
const customUserDir = val.replace('--user-data-dir=', '').trim();
log('Using custom directory for user data', customUserDir);
app.setPath('userData', customUserDir);
wasUserDataDirSet = true;
}
if (val && val.includes('--custom-url=')) {
customUrl = val.replace('--custom-url=', '').trim();
log('Using custom url', customUrl);
}
if (val && val.includes('--dev-tools')) {
isShowDevTools = true;
}
});
// TODO remove at one point in the future and only leave the directory setting part
if (
!wasUserDataDirSet &&
process.platform === 'linux' &&
process.env.SNAP &&
process.env.SNAP_USER_COMMON
) {
// COPY LEGACY SNAP DATA TO COMMON DIRECTORY
// -----------------------------------------
const appName = app.getName();
const commonDir = process.env.SNAP_USER_COMMON;
const currentDir = commonDir.replace(/common$/, 'current');
const oldPath = join(currentDir, '.config', appName);
const newPath = join(commonDir, '.config', appName);
const isExistsOldPath = existsSync(oldPath);
const isExistsNewPath = existsSync(newPath);
if (isExistsOldPath && !isExistsNewPath) {
console.log('\n');
console.log('-------------------------------------------------------------');
console.log('Detected legacy snap user data. Copying it over to common...');
console.log('-------------------------------------------------------------');
console.log('oldPath', oldPath);
console.log('newPath', newPath);
console.log('isExistsOldPath', isExistsOldPath);
console.log('isExistsNewPath', isExistsNewPath);
console.log('\n');
mkdirSync(newPath, { recursive: true });
const copyDir = (srcDir: string, dstDir: string): string[] => {
let results: string[] = [];
const list = readdirSync(srcDir);
let src;
let dst;
list.forEach((file) => {
src = srcDir + '/' + file;
dst = dstDir + '/' + file;
const stat = statSync(src);
if (stat && stat.isDirectory()) {
mkdirSync(dst);
results = results.concat(copyDir(src, dst));
} else {
writeFileSync(dst, readFileSync(src));
results.push(src);
}
});
return results;
};
copyDir(oldPath, newPath);
} else {
console.log('SNAP: common directory is used');
}
// SET COMMON DIRECTORY AS USER DATA DIRECTORY
// -------------------------------------------
// set userDa dir to common data to avoid the data being accessed by the update process
app.setPath('userData', newPath);
app.setAppLogsPath();
}
const BACKUP_DIR = `${app.getPath('userData')}/backups`;
interface MyApp extends App {
isQuiting?: boolean;
}
const appIN: MyApp = app;
initDebug({ showDevTools: isShowDevTools }, IS_DEV);
// NOTE: opening the folder crashes the mas build
if (!IS_MAC) {
electronDl({
openFolderWhenDone: true,
onCompleted: (file) => {
if (mainWin) {
mainWin.webContents.send(IPC.ANY_FILE_DOWNLOADED, file);
}
},
});
}
let mainWin: BrowserWindow;
// keep app active to keep time tracking running
// powerSaveBlocker.start('prevent-app-suspension');
appIN.on('second-instance', () => {
if (mainWin) {
showApp();
if (mainWin.isMinimized()) {
mainWin.restore();
}
mainWin.focus();
}
});
if (!IS_MAC) {
// make it a single instance by closing other instances but allow for dev mode
// because of https://github.com/electron/electron/issues/14094
const isLockObtained = appIN.requestSingleInstanceLock();
if (!isLockObtained && !IS_DEV) {
quitApp();
}
}
// Allow invalid certificates for jira requests
appIN.on('certificate-error', (event, webContents, url, err, certificate, callback) => {
log(err);
event.preventDefault();
callback(true);
});
// APP EVENT LISTENERS
// -------------------
appIN.on('ready', createMainWin);
appIN.on('ready', () => initBackupAdapter(BACKUP_DIR));
appIN.on('ready', () => initLocalFileSyncAdapter());
appIN.on('ready', () => initFullScreenBlocker(IS_DEV));
if (!isDisableTray) {
appIN.on('ready', createIndicator);
}
appIN.on('activate', () => {
// On OS X it's common to re-create a window in the app when the
// dock icon is clicked and there are no other windows open.
if (mainWin === null) {
createMainWin();
} else {
showApp();
}
});
let isLocked = false;
appIN.on('ready', () => {
let suspendStart: number;
const sendIdleMsgIfOverMin = (idleTime: number): void => {
// sometimes when starting a second instance we get here although we don't want to
if (!mainWin) {
info(
'special case occurred when trackTimeFn is called even though, this is a second instance of the app',
);
return;
}
// don't update if the user is about to close
if (!appIN.isQuiting && idleTime > CONFIG.MIN_IDLE_TIME) {
mainWin.webContents.send(IPC.IDLE_TIME, idleTime);
}
};
const checkIdle = (): void =>
sendIdleMsgIfOverMin(powerMonitor.getSystemIdleTime() * 1000);
// init time tracking interval
lazySetInterval(checkIdle, CONFIG.IDLE_PING_INTERVAL);
powerMonitor.on('suspend', () => {
isLocked = true;
suspendStart = Date.now();
mainWin.webContents.send(IPC.SUSPEND);
});
powerMonitor.on('lock-screen', () => {
isLocked = true;
suspendStart = Date.now();
mainWin.webContents.send(IPC.SUSPEND);
});
powerMonitor.on('resume', () => {
isLocked = false;
sendIdleMsgIfOverMin(Date.now() - suspendStart);
mainWin.webContents.send(IPC.RESUME);
});
powerMonitor.on('unlock-screen', () => {
isLocked = false;
sendIdleMsgIfOverMin(Date.now() - suspendStart);
mainWin.webContents.send(IPC.RESUME);
});
protocol.registerFileProtocol('file', (request, callback) => {
const pathname = decodeURI(request.url.replace('file:///', ''));
callback(pathname);
});
});
appIN.on('will-quit', () => {
// un-register all shortcuts.
globalShortcut.unregisterAll();
});
appIN.on('window-all-closed', () => {
log('Quit after all windows being closed');
// if (!IS_MAC) {
app.quit();
// }
});
// AUTO-UPDATER
// ------------
// appIN.on('ready', () => {
// // init auto-updates
// log.info('INIT AUTO UPDATES');
// // log.info(autoUpdater.getFeedURL());
// autoUpdater.logger = log;
// autoUpdater.logger.transports.file.level = 'info';
// autoUpdater.checkForUpdatesAndNotify();
// });
//
// autoUpdater.on('update-downloaded', (ev, info) => {
// log(ev);
// // Wait 5 seconds, then quit and install
// // In your application, you don't need to wait 5 seconds.
// // You could call autoUpdater.quitAndInstall(); immediately
// setTimeout(function() {
// autoUpdater.quitAndInstall();
// }, 5000)
// });
// FRONTEND EVENTS
// ---------------
ipcMain.on(IPC.SHUTDOWN_NOW, quitApp);
ipcMain.on(IPC.EXEC, execWithFrontendErrorHandlerInform);
ipcMain.on(IPC.LOCK_SCREEN, () => {
if (isLocked) {
return;
}
try {
lockscreen();
} catch (e) {
errorHandlerWithFrontendInform(e);
}
});
ipcMain.on(IPC.SET_PROGRESS_BAR, (ev, { progress, mode }) => {
if (mainWin) {
mainWin.setProgressBar(Math.min(Math.max(progress, 0), 1), { mode });
}
});
ipcMain.on(IPC.FLASH_PROGRESS_BAR, (ev) => {
if (mainWin) {
mainWin.flashFrame(true);
mainWin.once('focus', () => {
mainWin.flashFrame(false);
});
}
});
ipcMain.on(IPC.REGISTER_GLOBAL_SHORTCUTS_EVENT, (ev, cfg) => {
registerShowAppShortCuts(cfg);
});
ipcMain.on(
IPC.JIRA_SETUP_IMG_HEADERS,
(ev, { jiraCfg, wonkyCookie }: { jiraCfg: JiraCfg; wonkyCookie?: string }) => {
setupRequestHeadersForImages(jiraCfg, wonkyCookie);
},
);
ipcMain.on(IPC.JIRA_MAKE_REQUEST_EVENT, (ev, request) => {
sendJiraRequest(request);
});
ipcMain.on(IPC.SHOW_OR_FOCUS, () => {
showOrFocus(mainWin);
});
// HELPER FUNCTIONS
// ----------------
// eslint-disable-next-line prefer-arrow/prefer-arrow-functions
function createIndicator(): void {
initIndicator({
app,
showApp,
quitApp,
ICONS_FOLDER,
forceDarkTray,
});
}
// eslint-disable-next-line prefer-arrow/prefer-arrow-functions
function createMainWin(): void {
mainWin = createWindow({
app,
IS_DEV,
ICONS_FOLDER,
IS_MAC,
quitApp,
customUrl,
});
}
// eslint-disable-next-line prefer-arrow/prefer-arrow-functions
function registerShowAppShortCuts(cfg: KeyboardConfig): void {
// unregister all previous
globalShortcut.unregisterAll();
const GLOBAL_KEY_CFG_KEYS: (keyof KeyboardConfig)[] = [
'globalShowHide',
'globalToggleTaskStart',
'globalAddNote',
'globalAddTask',
];
if (cfg) {
Object.keys(cfg)
.filter((key: string) => GLOBAL_KEY_CFG_KEYS.includes(key as keyof KeyboardConfig))
.forEach((key: string) => {
let actionFn: () => void;
const shortcut = cfg[key as keyof KeyboardConfig];
switch (key) {
case 'globalShowHide':
actionFn = () => {
if (mainWin.isFocused()) {
// we need to blur the window for windows
mainWin.blur();
mainWin.hide();
} else {
showOrFocus(mainWin);
}
};
break;
case 'globalToggleTaskStart':
actionFn = () => {
mainWin.webContents.send(IPC.TASK_TOGGLE_START);
};
break;
case 'globalAddNote':
actionFn = () => {
showOrFocus(mainWin);
mainWin.webContents.send(IPC.ADD_NOTE);
};
break;
case 'globalAddTask':
actionFn = () => {
showOrFocus(mainWin);
// NOTE: delay slightly to make sure app is ready
mainWin.webContents.send(IPC.ADD_TASK);
};
break;
default:
actionFn = () => undefined;
}
if (shortcut && shortcut.length > 0) {
const ret = globalShortcut.register(shortcut, actionFn) as unknown;
if (!ret) {
errorHandlerWithFrontendInform(
'Global Shortcut registration failed: ' + shortcut,
shortcut,
);
}
}
});
}
}
// eslint-disable-next-line prefer-arrow/prefer-arrow-functions
function showApp(): void {
showOrFocus(mainWin);
}
// eslint-disable-next-line prefer-arrow/prefer-arrow-functions
function quitApp(): void {
// tslint:disable-next-line
appIN.isQuiting = true;
appIN.quit();
}
// eslint-disable-next-line prefer-arrow/prefer-arrow-functions
function showOrFocus(passedWin: BrowserWindow): void {
// default to main winpc
const win = passedWin || mainWin;
// sometimes when starting a second instance we get here although we don't want to
if (!win) {
info(
'special case occurred when showOrFocus is called even though, this is a second instance of the app',
);
return;
}
if (win.isVisible()) {
win.focus();
} else {
win.show();
}
// focus window afterwards always
setTimeout(() => {
win.focus();
}, 60);
}
// eslint-disable-next-line prefer-arrow/prefer-arrow-functions
function execWithFrontendErrorHandlerInform(ev: Event, command: string): void {
log('running command ' + command);
exec(command, (err) => {
if (err) {
errorHandlerWithFrontendInform(err);
}
});
}
// required for graceful closing
// @see: https://github.com/electron/electron/issues/5708
process.on('exit', () => {
setTimeout(() => {
log('Quit after process exit');
app.quit();
}, 100);
});