@ives_xxz/packages 1.0.0

package/Quick Finder/src/eazax/file-util.js

@@ -0,0 +1,158 @@
+const Fs = require('fs');
+const Path = require('path');
+const { promisify } = require('util');
+
+/**
+ * 文件工具 (Promise 化)
+ * @author 陈皮皮 (ifaswind)
+ * @version 20210818
+ */
+const FileUtil = {
+
+    /**
+     * 获取文件状态
+     * @param {Fs.PathLike} path 路径
+     * @returns {Promise<Fs.stats>}
+     */
+    stat: promisify(Fs.stat),
+
+    /**
+     * 创建文件夹
+     * @param {Fs.PathLike} path 路径
+     * @param {Fs.MakeDirectoryOptions?} options 选项
+     * @returns {Promise<void>}
+     */
+    mkdir: promisify(Fs.mkdir),
+
+    /**
+     * 读取文件夹
+     * @param {Fs.PathLike} path 路径
+     * @param {any} options 选项
+     * @returns {Promise<string[]>}
+     */
+    readdir: promisify(Fs.readdir),
+
+    /**
+     * 移除文件夹
+     * @param {Fs.PathLike} path 路径
+     * @param {Fs.RmDirOptions?} options 选项
+     * @returns {Promise<void>}
+     */
+    rmdir: promisify(Fs.rmdir),
+
+    /**
+     * 读取文件
+     * @param {Fs.PathLike} path 路径
+     * @param {any} options 选项
+     * @returns {Promise<Buffer>}
+     */
+    readFile: promisify(Fs.readFile),
+
+    /**
+     * 创建文件
+     * @param {Fs.PathLike} path 路径
+     * @param {string | NodeJS.ArrayBufferView} data 数据
+     * @param {Fs.WriteFileOptions?} options 选项
+     * @returns {Promise<void>}
+     */
+    writeFile: promisify(Fs.writeFile),
+
+    /**
+     * 移除文件
+     * @param {Fs.PathLike} path 路径
+     * @returns {Promise<void>}
+     */
+    unlink: promisify(Fs.unlink),
+
+    /**
+     * 测试路径是否存在 (同步)
+     * @param {Fs.PathLike} path 路径
+     */
+    existsSync: Fs.existsSync,
+
+    /**
+     * 复制文件/文件夹
+     * @param {Fs.PathLike} srcPath 源路径
+     * @param {Fs.PathLike} destPath 目标路径
+     * @returns {Promise<boolean>}
+     */
+    async copy(srcPath, destPath) {
+        if (!FileUtil.existsSync(srcPath)) {
+            return false;
+        }
+        const stats = await FileUtil.stat(srcPath);
+        if (stats.isDirectory()) {
+            if (!FileUtil.existsSync(destPath)) {
+                await FileUtil.createDir(destPath);
+            }
+            const names = await FileUtil.readdir(srcPath);
+            for (const name of names) {
+                await FileUtil.copy(Path.join(srcPath, name), Path.join(destPath, name));
+            }
+        } else {
+            await FileUtil.writeFile(destPath, await FileUtil.readFile(srcPath));
+        }
+        return true;
+    },
+
+    /**
+     * 创建文件夹 (递归)
+     * @param {Fs.PathLike} path 路径
+     * @returns {Promise<boolean>}
+     */
+    async createDir(path) {
+        if (FileUtil.existsSync(path)) {
+            return true;
+        } else {
+            const dir = Path.dirname(path);
+            if (await FileUtil.createDir(dir)) {
+                await FileUtil.mkdir(path);
+                return true;
+            }
+        }
+        return false;
+    },
+
+    /**
+     * 移除文件/文件夹 (递归)
+     * @param {Fs.PathLike} path 路径
+     */
+    async remove(path) {
+        if (!FileUtil.existsSync(path)) {
+            return;
+        }
+        const stats = await FileUtil.stat(path);
+        if (stats.isDirectory()) {
+            const names = await FileUtil.readdir(path);
+            for (const name of names) {
+                await FileUtil.remove(Path.join(path, name));
+            }
+            await FileUtil.rmdir(path);
+        } else {
+            await FileUtil.unlink(path);
+        }
+    },
+
+    /**
+     * 遍历文件/文件夹并执行函数
+     * @param {Fs.PathLike} path 路径
+     * @param {(filePath: Fs.PathLike, stat: Fs.Stats) => void | Promise<void>} handler 处理函数
+     */
+    async map(path, handler) {
+        if (!FileUtil.existsSync(path)) {
+            return;
+        }
+        const stats = await FileUtil.stat(path);
+        if (stats.isDirectory()) {
+            const names = await FileUtil.readdir(path);
+            for (const name of names) {
+                await FileUtil.map(Path.join(path, name), handler);
+            }
+        } else {
+           await handler(path, stats);
+        }
+    },
+
+};
+
+module.exports = FileUtil;

package/Quick Finder/src/eazax/i18n.js

@@ -0,0 +1,36 @@
+const zh = require('../../i18n/zh');
+const en = require('../../i18n/en');
+
+/**
+ * 多语言
+ * @author 陈皮皮 (ifaswind)
+ * @version 20210713
+ */
+const I18n = {
+
+    /**
+     * 中文
+     */
+    zh,
+
+    /**
+     * 英文
+     */
+    en,
+
+    /**
+     * 多语言文本
+     * @param {string} lang 语言
+     * @param {string} key 关键字
+     * @returns {string}
+     */
+    translate(lang, key) {
+        if (I18n[lang] && I18n[lang][key]) {
+            return I18n[lang][key];
+        }
+        return key;
+    },
+
+};
+
+module.exports = I18n;

package/Quick Finder/src/eazax/main-event.js

@@ -0,0 +1,81 @@
+const { ipcMain } = require('electron');
+const PackageUtil = require('./package-util');
+
+/** 包名 */
+const PACKAGE_NAME = PackageUtil.name;
+
+/**
+ * 主进程 IPC 事件
+ * @author 陈皮皮 (ifaswind)
+ * @version 20210818
+ */
+const MainEvent = {
+
+    /**
+     * 监听事件（一次性）
+     * @param {string} channel 频道
+     * @param {Function} callback 回调
+     */
+    once(channel, callback) {
+        return ipcMain.once(`${PACKAGE_NAME}:${channel}`, callback);
+    },
+
+    /**
+     * 监听事件
+     * @param {string} channel 频道
+     * @param {Function} callback 回调
+     */
+    on(channel, callback) {
+        return ipcMain.on(`${PACKAGE_NAME}:${channel}`, callback);
+    },
+
+    /**
+     * 取消事件监听
+     * @param {string} channel 频道
+     * @param {Function} callback 回调
+     */
+    removeListener(channel, callback) {
+        return ipcMain.removeListener(`${PACKAGE_NAME}:${channel}`, callback);
+    },
+
+    /**
+     * 取消事件的所有监听
+     * @param {string} channel 频道
+     */
+    removeAllListeners(channel) {
+        return ipcMain.removeAllListeners(`${PACKAGE_NAME}:${channel}`);
+    },
+
+    /**
+     * 发送事件到指定渲染进程
+     * @param {Electron.WebContents} webContents 渲染进程事件对象
+     * @param {string} channel 频道
+     * @param {any[]?} args 参数
+     */
+    send(webContents, channel) {
+        // return webContents.send(`${PACKAGE_NAME}:${channel}`, ...args);
+        const args = [`${PACKAGE_NAME}:${channel}`];
+        for (let i = 2, l = arguments.length; i < l; i++) {
+            args.push(arguments[i]);
+        }
+        return webContents.send.apply(webContents, args);
+    },
+
+    /**
+     * 回复事件给渲染进程
+     * @param {Electron.IpcMainEvent} ipcMainEvent 事件对象
+     * @param {string} channel 频道
+     * @param {any[]?} args 参数
+     */
+    reply(ipcMainEvent, channel) {
+        // return ipcMainEvent.reply(`${PACKAGE_NAME}:${channel}`, ...args);
+        const args = [`${PACKAGE_NAME}:${channel}`];
+        for (let i = 2, l = arguments.length; i < l; i++) {
+            args.push(arguments[i]);
+        }
+        return ipcMainEvent.reply.apply(ipcMainEvent, args);
+    },
+
+};
+
+module.exports = MainEvent;

package/Quick Finder/src/eazax/package-util.js

@@ -0,0 +1,47 @@
+const { shell } = require('electron');
+
+/** 包信息 */
+const PACKAGE_JSON = require('../../package.json');
+
+/**
+ * 包工具
+ * @author 陈皮皮 (ifaswind)
+ * @version 20210908
+ */
+const PackageUtil = {
+
+    /**
+     * 包名
+     * @type {string}
+     */
+    get name() {
+        return PACKAGE_JSON.name;
+    },
+
+    /**
+     * 版本
+     * @type {string}
+     */
+    get version() {
+        return PACKAGE_JSON.version;
+    },
+
+    /**
+     * 仓库地址
+     * @type {string}
+     */
+    get repository() {
+        return PACKAGE_JSON.repository;
+    },
+
+    /**
+     * 打开仓库页面
+     */
+    openRepository() {
+        const url = PackageUtil.repository;
+        shell.openExternal(url);
+    },
+
+};
+
+module.exports = PackageUtil;

package/Quick Finder/src/eazax/renderer-event.js

@@ -0,0 +1,80 @@
+const { ipcRenderer } = require('electron');
+const PackageUtil = require('./package-util');
+
+/** 包名 */
+const PACKAGE_NAME = PackageUtil.name;
+
+/**
+ * 渲染进程 IPC 事件
+ * @author 陈皮皮 (ifaswind)
+ * @version 20210818
+ */
+const RendererEvent = {
+
+    /**
+     * 监听事件（一次性）
+     * @param {string} channel 频道
+     * @param {Function} callback 回调
+     */
+    once(channel, callback) {
+        return ipcRenderer.once(`${PACKAGE_NAME}:${channel}`, callback);
+    },
+
+    /**
+     * 监听事件
+     * @param {string} channel 频道
+     * @param {Function} callback 回调
+     */
+    on(channel, callback) {
+        return ipcRenderer.on(`${PACKAGE_NAME}:${channel}`, callback);
+    },
+
+    /**
+     * 取消事件监听
+     * @param {string} channel 频道
+     * @param {Function} callback 回调
+     */
+    removeListener(channel, callback) {
+        return ipcRenderer.removeListener(`${PACKAGE_NAME}:${channel}`, callback);
+    },
+
+    /**
+     * 取消事件的所有监听
+     * @param {string} channel 频道
+     */
+    removeAllListeners(channel) {
+        return ipcRenderer.removeAllListeners(`${PACKAGE_NAME}:${channel}`);
+    },
+
+    /**
+     * 发送事件到主进程
+     * @param {string} channel 频道
+     * @param {...any} args 参数
+     */
+    send(channel) {
+        // return ipcRenderer.send(`${PACKAGE_NAME}:${channel}`, ...args);
+        const args = [`${PACKAGE_NAME}:${channel}`];
+        for (let i = 1, l = arguments.length; i < l; i++) {
+            args.push(arguments[i]);
+        }
+        return ipcRenderer.send.apply(ipcRenderer, args);
+    },
+
+    /**
+     * 发送事件到主进程（同步）
+     * @param {string} channel 频道
+     * @param {...any} args 参数
+     * @returns {Promise<any>}
+     */
+    sendSync(channel) {
+        // return ipcRenderer.sendSync(`${PACKAGE_NAME}:${channel}`, ...args);
+        const args = [`${PACKAGE_NAME}:${channel}`];
+        for (let i = 1, l = arguments.length; i < l; i++) {
+            args.push(arguments[i]);
+        }
+        return ipcRenderer.sendSync.apply(ipcRenderer, args);
+    },
+
+};
+
+module.exports = RendererEvent;

package/Quick Finder/src/eazax/updater.js

@@ -0,0 +1,92 @@
+const fetch = require('../../lib/node-fetch');
+const PackageUtil = require('./package-util');
+const { compareVersion } = require('./version-util');
+
+/** 本地版本 */
+const LOCAL_VERSION = PackageUtil.version;
+
+/** 远程仓库地址 */
+const REMOTE_URL = PackageUtil.repository;
+
+/**
+ * 更新器
+ * @author 陈皮皮 (ifaswind)
+ * @version 20210804
+ */
+const Updater = {
+
+    /**
+     * 远程仓库地址
+     * @type {string}
+     */
+    get remote() {
+        return REMOTE_URL;
+    },
+
+    /**
+     * 分支
+     * @type {string}
+     */
+    branch: 'master',
+
+    /**
+     * 获取远端的 package.json
+     * @returns {Promise<object>}
+     */
+    async getRemotePackageJson() {
+        const packageJsonUrl = `${Updater.remote}/raw/${Updater.branch}/package.json`;
+        // 发起网络请求
+        const response = await fetch(packageJsonUrl, {
+            method: 'GET',
+            cache: 'no-cache',
+            mode: 'no-cors',
+        });
+        // 请求结果
+        if (response.status !== 200) {
+            return null;
+        }
+        // 读取 json
+        const json = response.json();
+        return json;
+    },
+
+    /**
+     * 获取远端版本号
+     * @returns {Promise<string>}
+     */
+    async getRemoteVersion() {
+        const package = await Updater.getRemotePackageJson();
+        if (package && package.version) {
+            return package.version;
+        }
+        return null;
+    },
+
+    /**
+     * 获取本地版本号
+     * @returns {string}
+     */
+    getLocalVersion() {
+        return LOCAL_VERSION;
+    },
+
+    /**
+     * 检查远端是否有新版本
+     * @returns {Promise<boolean>}
+     */
+    async check() {
+        // 远端版本号
+        const remoteVersion = await Updater.getRemoteVersion();
+        if (!remoteVersion) {
+            return false;
+        }
+        // 本地版本号
+        const localVersion = Updater.getLocalVersion();
+        // 对比版本号
+        const result = compareVersion(localVersion, remoteVersion);
+        return (result < 0);
+    },
+
+};
+
+module.exports = Updater;

package/Quick Finder/src/eazax/version-util.js

@@ -0,0 +1,61 @@
+/**
+ * 版本工具
+ * @author 陈皮皮 (ifaswind)
+ * @version 20210814
+ */
+const VersionUtil = {
+
+    /**
+     * 拆分版本号
+     * @param {string | number} version 版本号文本
+     * @returns {number[]}
+     * @example
+     * splitVersionString('1.2.0');  // [1, 2, 0]
+     */
+    splitVersionString(version) {
+        if (typeof version === 'number') {
+            return [version];
+        }
+        if (typeof version === 'string') {
+            return (
+                version.replace(/-/g, '.')
+                    .split('.')
+                    .map(v => (parseInt(v) || 0))
+            );
+        }
+        return [0];
+    },
+
+    /**
+     * 对比版本号
+     * @param {string | number} a 版本 a
+     * @param {string | number} b 版本 b
+     * @returns {-1 | 0 | 1}
+     * @example
+     * compareVersion('1.0.0', '1.0.1');    // -1
+     * compareVersion('1.1.0', '1.1.0');    // 0
+     * compareVersion('1.2.1', '1.2.0');    // 1
+     * compareVersion('1.2.0.1', '1.2.0');  // 1
+     */
+    compareVersion(a, b) {
+        const acs = VersionUtil.splitVersionString(a),
+            bcs = VersionUtil.splitVersionString(b);
+        const count = Math.max(acs.length, bcs.length);
+        for (let i = 0; i < count; i++) {
+            const ac = acs[i],
+                bc = bcs[i];
+            // 前者缺少分量或前者小于后者
+            if (ac == undefined || ac < bc) {
+                return -1;
+            }
+            // 后者缺少分量或前者大于后者
+            if (bc == undefined || ac > bc) {
+                return 1;
+            }
+        }
+        return 0;
+    },
+
+};
+
+module.exports = VersionUtil;

package/Quick Finder/src/eazax/window-util.js

@@ -0,0 +1,80 @@
+const { BrowserWindow } = require('electron');
+
+/**
+ * 窗口工具（主进程）
+ * @author 陈皮皮 (ifaswind)
+ * @version 20210825
+ */
+const WindowUtil = {
+
+    /**
+     * 最先打开的窗口
+     * @returns {BrowserWindow}
+     */
+    getFirstWindow() {
+        const wins = BrowserWindow.getAllWindows();
+        return wins[wins.length - 1];
+    },
+
+    /**
+     * 获取当前聚焦的窗口
+     * @returns {BrowserWindow}
+     */
+    getFocusedWindow() {
+        return BrowserWindow.getFocusedWindow();
+    },
+
+    /**
+     * 计算窗口位置（相对于最先打开的窗口）
+     * @param {[number, number]} size 窗口尺寸
+     * @param {'top' | 'center'} anchor 锚点
+     * @returns {[number, number]}
+     */
+    calcWindowPosition(size, anchor) {
+        const win = WindowUtil.getFirstWindow();
+        return WindowUtil.calcWindowPositionByTarget(size, anchor, win);
+    },
+
+    /**
+     * 计算窗口位置（相对于当前聚焦的窗口）
+     * @param {[number, number]} size 窗口尺寸
+     * @param {'top' | 'center'} anchor 锚点
+     * @returns {[number, number]}
+     */
+    calcWindowPositionByFocused(size, anchor) {
+        const win = WindowUtil.getFocusedWindow();
+        return WindowUtil.calcWindowPositionByTarget(size, anchor, win);
+    },
+
+    /**
+     * 计算窗口位置（相对于当前聚焦的窗口）
+     * @param {[number, number]} size 窗口尺寸
+     * @param {'top' | 'center'} anchor 锚点
+     * @param {BrowserWindow} win 目标窗口
+     * @returns {[number, number]}
+     */
+    calcWindowPositionByTarget(size, anchor, win) {
+        // 根据目标窗口的位置和尺寸来计算
+        const winSize = win.getSize(),
+            winPos = win.getPosition();
+        // 注意：原点 (0, 0) 在屏幕左上角
+        // 另外，窗口的位置值必须是整数，否则修改无效（像素的最小粒度为 1）
+        const x = Math.floor(winPos[0] + (winSize[0] / 2) - (size[0] / 2));
+        let y;
+        switch (anchor) {
+            case 'top': {
+                y = Math.floor(winPos[1]);
+                break;
+            }
+            default:
+            case 'center': {
+                y = Math.floor(winPos[1] + (winSize[1] / 2) - (size[1] / 2));
+                break;
+            }
+        }
+        return [x, y];
+    },
+
+};
+
+module.exports = WindowUtil;