feat: create menu items with check for updates action

This commit is contained in:
Louis 2023-10-02 15:26:44 +07:00 committed by Louis
parent 34103b9701
commit 0a5a39c720
2 changed files with 244 additions and 151 deletions

View File

@ -1,30 +1,41 @@
import { import { app, BrowserWindow, ipcMain, dialog, shell } from "electron";
app,
BrowserWindow,
screen as electronScreen,
ipcMain,
dialog,
shell,
} from "electron";
import { readdirSync } from "fs"; import { readdirSync } from "fs";
import { resolve, join, extname } from "path"; import { resolve, join, extname } from "path";
import { rmdir, unlink, createWriteStream } from "fs"; import { rmdir, unlink, createWriteStream } from "fs";
import isDev = require("electron-is-dev");
import { init } from "./core/plugin-manager/pluginMgr"; import { init } from "./core/plugin-manager/pluginMgr";
const { autoUpdater } = require("electron-updater"); import { setupMenu } from "./utils/menu";
const Store = require("electron-store");
import isDev = require("electron-is-dev");
// @ts-ignore // @ts-ignore
import request = require("request"); import request = require("request");
// @ts-ignore // @ts-ignore
import progress = require("request-progress"); import progress = require("request-progress");
const { autoUpdater } = require("electron-updater");
const Store = require("electron-store");
let mainWindow: BrowserWindow | undefined = undefined; let mainWindow: BrowserWindow | undefined = undefined;
const store = new Store();
autoUpdater.autoDownload = false; app
autoUpdater.autoInstallOnAppQuit = true; .whenReady()
.then(migratePlugins)
.then(setupPlugins)
.then(setupMenu)
.then(handleIPCs)
.then(handleAppUpdates)
.then(createMainWindow)
.then(() => {
app.on("activate", () => {
if (!BrowserWindow.getAllWindows().length) {
createMainWindow();
}
});
});
const createMainWindow = () => { app.on("window-all-closed", () => {
app.quit();
});
function createMainWindow() {
mainWindow = new BrowserWindow({ mainWindow = new BrowserWindow({
width: 1200, width: 1200,
height: 800, height: 800,
@ -37,6 +48,61 @@ const createMainWindow = () => {
}, },
}); });
const startURL = isDev
? "http://localhost:3000"
: `file://${join(__dirname, "../renderer/index.html")}`;
mainWindow.loadURL(startURL);
mainWindow.once("ready-to-show", () => mainWindow?.show());
mainWindow.on("closed", () => {
if (process.platform !== "darwin") app.quit();
});
if (isDev) mainWindow.webContents.openDevTools();
}
function handleAppUpdates() {
/*New Update Available*/
autoUpdater.on("update-available", async (_info: any) => {
const action = await dialog.showMessageBox({
message: `Update available. Do you want to download the latest update?`,
buttons: ["Download", "Later"],
});
if (action.response === 0) await autoUpdater.downloadUpdate();
});
/*App Update Completion Message*/
autoUpdater.on("update-downloaded", async (_info: any) => {
mainWindow?.webContents.send("APP_UPDATE_COMPLETE", {});
const action = await dialog.showMessageBox({
message: `Update downloaded. Please restart the application to apply the updates.`,
buttons: ["Restart", "Later"],
});
if (action.response === 0) {
autoUpdater.quitAndInstall();
}
});
/*App Update Error */
autoUpdater.on("error", (info: any) => {
dialog.showMessageBox({ message: info.message });
mainWindow?.webContents.send("APP_UPDATE_ERROR", {});
});
/*App Update Progress */
autoUpdater.on("download-progress", (progress: any) => {
console.log("app update progress: ", progress.percent);
mainWindow?.webContents.send("APP_UPDATE_PROGRESS", {
percent: progress.percent,
});
});
autoUpdater.autoDownload = false;
autoUpdater.autoInstallOnAppQuit = true;
autoUpdater.checkForUpdates();
}
function handleIPCs() {
ipcMain.handle( ipcMain.handle(
"invokePluginFunc", "invokePluginFunc",
async (_event, modulePath, method, ...args) => { async (_event, modulePath, method, ...args) => {
@ -56,152 +122,81 @@ const createMainWindow = () => {
.catch((err) => console.log(err)); .catch((err) => console.log(err));
} }
); );
ipcMain.handle("basePlugins", async (_event) => {
const startURL = isDev const basePluginPath = join(
? "http://localhost:3000" __dirname,
: `file://${join(__dirname, "../renderer/index.html")}`; "../",
isDev ? "/core/pre-install" : "../app.asar.unpacked/core/pre-install"
mainWindow.loadURL(startURL); );
return readdirSync(basePluginPath)
mainWindow.once("ready-to-show", () => mainWindow?.show()); .filter((file) => extname(file) === ".tgz")
mainWindow.on("closed", () => { .map((file) => join(basePluginPath, file));
if (process.platform !== "darwin") app.quit();
}); });
if (isDev) mainWindow.webContents.openDevTools(); ipcMain.handle("pluginPath", async (_event) => {
}; return join(app.getPath("userData"), "plugins");
});
ipcMain.handle("appVersion", async (_event) => {
return app.getVersion();
});
ipcMain.handle("openExternalUrl", async (_event, url) => {
shell.openExternal(url);
});
app /**
.whenReady() * Used to delete a file from the user data folder
.then(migratePlugins) */
.then(() => { ipcMain.handle("deleteFile", async (_event, filePath) => {
createMainWindow(); const userDataPath = app.getPath("userData");
setupPlugins(); const fullPath = join(userDataPath, filePath);
autoUpdater.checkForUpdates();
ipcMain.handle("basePlugins", async (event) => { let result = "NULL";
const basePluginPath = join( unlink(fullPath, function (err) {
__dirname, if (err && err.code == "ENOENT") {
"../", result = `File not exist: ${err}`;
isDev ? "/core/pre-install" : "../app.asar.unpacked/core/pre-install" } else if (err) {
); result = `File delete error: ${err}`;
return readdirSync(basePluginPath) } else {
.filter((file) => extname(file) === ".tgz") result = "File deleted successfully";
.map((file) => join(basePluginPath, file));
});
ipcMain.handle("pluginPath", async (event) => {
return join(app.getPath("userData"), "plugins");
});
ipcMain.handle("appVersion", async (event) => {
return app.getVersion();
});
ipcMain.handle("openExternalUrl", async (event, url) => {
shell.openExternal(url);
});
/**
* Used to delete a file from the user data folder
*/
ipcMain.handle("deleteFile", async (_event, filePath) => {
const userDataPath = app.getPath("userData");
const fullPath = join(userDataPath, filePath);
let result = "NULL";
unlink(fullPath, function (err) {
if (err && err.code == "ENOENT") {
result = `File not exist: ${err}`;
} else if (err) {
result = `File delete error: ${err}`;
} else {
result = "File deleted successfully";
}
console.log(
`Delete file ${filePath} from ${fullPath} result: ${result}`
);
});
return result;
});
/**
* Used to download a file from a given url
*/
ipcMain.handle("downloadFile", async (_event, url, fileName) => {
const userDataPath = app.getPath("userData");
const destination = resolve(userDataPath, fileName);
progress(request(url), {})
.on("progress", function (state: any) {
mainWindow?.webContents.send("FILE_DOWNLOAD_UPDATE", {
...state,
fileName,
});
})
.on("error", function (err: Error) {
mainWindow?.webContents.send("FILE_DOWNLOAD_ERROR", {
fileName,
err,
});
})
.on("end", function () {
mainWindow?.webContents.send("FILE_DOWNLOAD_COMPLETE", {
fileName,
});
})
.pipe(createWriteStream(destination));
});
app.on("activate", () => {
if (!BrowserWindow.getAllWindows().length) {
createMainWindow();
} }
console.log(`Delete file ${filePath} from ${fullPath} result: ${result}`);
}); });
return result;
}); });
/*New Update Available*/ /**
autoUpdater.on("update-available", async (info: any) => { * Used to download a file from a given url
const action = await dialog.showMessageBox({ */
message: `Update available. Do you want to download the latest update?`, ipcMain.handle("downloadFile", async (_event, url, fileName) => {
buttons: ["Download", "Later"], const userDataPath = app.getPath("userData");
const destination = resolve(userDataPath, fileName);
progress(request(url), {})
.on("progress", function (state: any) {
mainWindow?.webContents.send("FILE_DOWNLOAD_UPDATE", {
...state,
fileName,
});
})
.on("error", function (err: Error) {
mainWindow?.webContents.send("FILE_DOWNLOAD_ERROR", {
fileName,
err,
});
})
.on("end", function () {
mainWindow?.webContents.send("FILE_DOWNLOAD_COMPLETE", {
fileName,
});
})
.pipe(createWriteStream(destination));
}); });
if (action.response === 0) await autoUpdater.downloadUpdate(); }
});
/*App Update Completion Message*/
autoUpdater.on("update-downloaded", async (info: any) => {
mainWindow?.webContents.send("APP_UPDATE_COMPLETE", {});
const action = await dialog.showMessageBox({
message: `Update downloaded. Please restart the application to apply the updates.`,
buttons: ["Restart", "Later"],
});
if (action.response === 0) {
autoUpdater.quitAndInstall();
}
});
/*App Update Error */
autoUpdater.on("error", (info: any) => {
dialog.showMessageBox({ message: info.message });
mainWindow?.webContents.send("APP_UPDATE_ERROR", {});
});
/*App Update Progress */
autoUpdater.on("download-progress", (progress: any) => {
console.log("app update progress: ", progress.percent);
mainWindow?.webContents.send("APP_UPDATE_PROGRESS", {
percent: progress.percent,
});
});
app.on("window-all-closed", () => {
if (process.platform !== "darwin") {
app.quit();
}
});
function migratePlugins() { function migratePlugins() {
return new Promise((resolve) => { return new Promise((resolve) => {
const store = new Store();
if (store.get("migrated_version") !== app.getVersion()) { if (store.get("migrated_version") !== app.getVersion()) {
console.log("start migration:", store.get("migrated_version")); console.log("start migration:", store.get("migrated_version"));
const userDataPath = app.getPath("userData"); const userDataPath = app.getPath("userData");
@ -217,12 +212,12 @@ function migratePlugins() {
resolve(undefined); resolve(undefined);
} }
}); });
}; }
function setupPlugins() { function setupPlugins() {
init({ init({
// Function to check from the main process that user wants to install a plugin // Function to check from the main process that user wants to install a plugin
confirmInstall: async (plugins: string[]) => { confirmInstall: async (_plugins: string[]) => {
return true; return true;
}, },
// Path to install plugin to // Path to install plugin to

98
electron/utils/menu.ts Normal file
View File

@ -0,0 +1,98 @@
// @ts-nocheck
const { app, Menu } = require("electron");
const isMac = process.platform === "darwin";
const { autoUpdater } = require("electron-updater");
const template: (Electron.MenuItemConstructorOptions | Electron.MenuItem)[] = [
...(isMac
? [
{
label: app.name,
submenu: [
{ role: "about" },
{
label: "Check for Updates...",
click: () => autoUpdater.checkForUpdates(),
},
{ type: "separator" },
{ role: "services" },
{ type: "separator" },
{ role: "hide" },
{ role: "hideOthers" },
{ role: "unhide" },
{ type: "separator" },
{ role: "quit" },
],
},
]
: []),
{
label: "Edit",
submenu: [
{ role: "undo" },
{ role: "redo" },
{ type: "separator" },
{ role: "cut" },
{ role: "copy" },
{ role: "paste" },
...(isMac
? [
{ role: "pasteAndMatchStyle" },
{ role: "delete" },
{ role: "selectAll" },
{ type: "separator" },
{
label: "Speech",
submenu: [{ role: "startSpeaking" }, { role: "stopSpeaking" }],
},
]
: [{ role: "delete" }, { type: "separator" }, { role: "selectAll" }]),
],
},
{
label: "View",
submenu: [
{ role: "reload" },
{ role: "forceReload" },
{ role: "toggleDevTools" },
{ type: "separator" },
{ role: "resetZoom" },
{ role: "zoomIn" },
{ role: "zoomOut" },
{ type: "separator" },
{ role: "togglefullscreen" },
],
},
{
label: "Window",
submenu: [
{ role: "minimize" },
{ role: "zoom" },
...(isMac
? [
{ type: "separator" },
{ role: "front" },
{ type: "separator" },
{ role: "window" },
]
: [{ role: "close" }]),
],
},
{
role: "help",
submenu: [
{
label: "Learn More",
click: async () => {
const { shell } = require("electron");
await shell.openExternal("https://jan.ai/");
},
},
],
},
];
export const setupMenu = () => {
const menu = Menu.buildFromTemplate(template);
Menu.setApplicationMenu(menu);
};