clickgo-native 0.0.2-dev2 → 0.0.3-dev3

package/dist/index.ts

@@ -1,25 +1,34 @@
-// npm publish --tag dev --access public
-// --- sass --watch dist/:dist/ --style compressed --no-source-map ---
 import * as electron from 'electron';
 import * as path from 'path';
+import * as libFs from './lib/fs';
+export const fs = libFs;
+import * as libTool from './lib/tool';
+export const tool = libTool;
 
-electron.Menu.setApplicationMenu(null);
+// npm publish --tag dev --access public
+// --- sass --watch dist/:dist/ --style compressed --no-source-map ---
+
+/** --- 是否是沉浸式的 --- */
+let isImmersion: boolean = false;
+// --- windows 下是且只会是沉浸式，其他系统以启动的第一个窗体为准绑定大小最小化最大化关闭等功能 ---
+
+/** --- 窗体是否含有 border 边框，有的话将不是沉浸式，也不会绑定任何窗体的大小和相关事件 --- */
+let hasFrame: boolean = false;
+
+/** --- 是否没有物理窗体时就主动退出软件（进程结束），如果不要窗体只有 node 的话，会用到 false 的情况 --- */
+let isNoFormQuit: boolean = true;
 
-/** --- 环境是否已经准备好了 --- */
-let isReady: boolean = false;
-/** --- 窗体是否显示边框 --- */
-let isFrame: boolean = false;
-/** --- 是否关闭窗口就退出 --- */
-let isQuit: boolean = true;
 /** --- 主窗体 --- */
-let win: electron.BrowserWindow | undefined;
+let form: electron.BrowserWindow | undefined;
+
+/** --- 当前设定的通讯 token --- */
+let token: string = '';
+
 /** --- 当前系统平台 --- */
 const platform: NodeJS.Platform = process.platform;
 // const platform: NodeJS.Platform = 'darwin';
-/** --- 当前设定的 token --- */
-let token: string = '';
 
-/** --- 监听前台的执行的方法 --- */
+/** --- 监听前台的执行的方法，内置的方法，用户可调用方法自行添加 --- */
 const methods: Record<string, {
     'once': boolean;
     'handler': (...param: any[]) => any | Promise<any>;
@@ -28,18 +37,19 @@ const methods: Record<string, {
     'cg-init': {
         'once': true,
         handler: function(t: string) {
-            if (!t || !win) {
+            // --- t 是网页传来的 token ---
+            if (!t || !form) {
                 return;
             }
-            win.resizable = true;
+            form.resizable = true;
             token = t;
         }
     },
-    // --- 完全退出软件 ---
+    // --- 完全退出软件进程 ---
     'cg-quit': {
         'once': false,
         handler: function(t: string): void {
-            if (!win || !t) {
+            if (!t || !form) {
                 return;
             }
             if (!verifyToken(t)) {
@@ -48,25 +58,25 @@ const methods: Record<string, {
             electron.app.quit();
         }
     },
-    // --- 设置实体窗体大小，推荐仅限非 windows ---
+    // --- 设置实体窗体大小，仅非沉浸式可设置 ---
     'cg-set-size': {
         'once': false,
         handler: function(t: string, width: number, height: number): void {
-            if (!win || !width || !height) {
+            if (isImmersion || !form || !width || !height) {
                 return;
             }
             if (!verifyToken(t)) {
                 return;
             }
-            win.setSize(width, height);
-            win.center();
+            form.setSize(width, height);
+            form.center();
         }
     },
-    // --- 设置窗体最大化、最小化、还原 ---
+    // --- 设置窗体最大化、最小化、还原，仅非 frame 可设置 ---
     'cg-set-state': {
         'once': false,
         handler: function(t: string, state: string): void {
-            if (!win || !state) {
+            if (hasFrame || !form || !state) {
                 return;
             }
             if (!verifyToken(t)) {
@@ -74,90 +84,350 @@ const methods: Record<string, {
             }
             switch (state) {
                 case 'max': {
-                    win.maximize();
+                    form.maximize();
                     break;
                 }
                 case 'min': {
-                    win.minimize();
+                    form.minimize();
                     break;
                 }
                 default: {
-                    win.restore();
+                    form.restore();
                 }
             }
         }
     },
-    // --- 关闭窗体但不退出软件 ---
+    // --- 关闭窗体（可能软件进程不会被退出） ---
     'cg-close': {
         'once': false,
         handler: function(t: string): void {
-            if (!win) {
+            if (!form) {
                 return;
             }
             if (!verifyToken(t)) {
                 return;
             }
-            win.close();
+            form.close();
         }
     },
-    // --- 设置 IgnoreMouseEvents，仅限 windows ---
+    // --- 设置 IgnoreMouseEvents，仅限沉浸式 ---
     'cg-mouse-ignore': {
         'once': false,
         handler: function(t: string, val: boolean): void {
-            if (!win) {
+            if (!isImmersion || !form) {
                 return;
             }
             if (!verifyToken(t)) {
                 return;
             }
             if (val) {
-                win.setIgnoreMouseEvents(true, { 'forward': true });
+                form.setIgnoreMouseEvents(true, { 'forward': true });
             }
             else {
-                win.setIgnoreMouseEvents(false);
+                form.setIgnoreMouseEvents(false);
+            }
+        }
+    },
+    // --- 是否允许最大化 ---
+    'cg-maximizable': {
+        'once': false,
+        handler: function(t: string, val: boolean): void {
+            if (isImmersion || !form) {
+                return;
+            }
+            if (!verifyToken(t)) {
+                return;
+            }
+            form.setMaximizable(val);
+        }
+    },
+
+    // --- fs 相关操作 ---
+
+    'cg-fs-getContent': {
+        'once': false,
+        handler: async function(
+            t: string,
+            path: string,
+            options: Record<string, any>
+        ): Promise<string | Buffer | null> {
+            if (!verifyToken(t)) {
+                return null;
+            }
+            return libFs.getContent(path, options);
+        }
+    },
+    'cg-fs-putContent': {
+        'once': false,
+        handler: async function(
+            t: string, path: string, data: string | Buffer, options: Record<string, any>
+        ): Promise<boolean> {
+            if (!verifyToken(t)) {
+                return false;
+            }
+            return fs.putContent(path, data, options);
+        }
+    },
+    'cg-fs-readLink': {
+        'once': false,
+        handler: async function(t: string, path: string, encoding?: BufferEncoding): Promise<string | null> {
+            if (!verifyToken(t)) {
+                return null;
             }
+            return fs.readLink(path, encoding);
+        }
+    },
+    'cg-fs-symlink': {
+        'once': false,
+        handler: async function(t: string, filePath: string, linkPath: string, type?: 'dir' | 'file' | 'junction'): Promise<boolean> {
+            if (!verifyToken(t)) {
+                return false;
+            }
+            return fs.symlink(filePath, linkPath, type);
+        }
+    },
+    'cg-fs-unlink': {
+        'once': false,
+        handler: async function(t: string, path: string): Promise<boolean> {
+            if (!verifyToken(t)) {
+                return false;
+            }
+            return fs.unlink(path);
+        }
+    },
+    'cg-fs-stats': {
+        'once': false,
+        handler: async function(t: string, path: string): Promise<Record<string, any> | null> {
+            if (!verifyToken(t)) {
+                return null;
+            }
+            return fs.stats(path);
+        }
+    },
+    'cg-fs-mkdir': {
+        'once': false,
+        handler: async function(t: string, path: string, mode: number): Promise<boolean> {
+            if (!verifyToken(t)) {
+                return false;
+            }
+            return fs.mkdir(path, mode);
+        }
+    },
+    'cg-fs-rmdir': {
+        'once': false,
+        handler: async function(t: string, path: string): Promise<boolean> {
+            if (!verifyToken(t)) {
+                return false;
+            }
+            return fs.rmdir(path);
+        }
+    },
+    'cg-fs-chmod': {
+        'once': false,
+        handler: async function(t: string, path: string, mod: string | number): Promise<boolean> {
+            if (!verifyToken(t)) {
+                return false;
+            }
+            return fs.chmod(path, mod);
+        }
+    },
+    'cg-fs-rename': {
+        'once': false,
+        handler: async function(t: string, oldPath: string, newPath: string): Promise<boolean> {
+            if (!verifyToken(t)) {
+                return false;
+            }
+            return fs.rename(oldPath, newPath);
+        }
+    },
+    'cg-fs-readDir': {
+        'once': false,
+        handler: async function(t: string, path: string, encoding?: BufferEncoding): Promise<any[]> {
+            if (!verifyToken(t)) {
+                return [];
+            }
+            return fs.readDir(path, encoding);
+        }
+    },
+    'cg-fs-copyFile': {
+        'once': false,
+        handler: async function(t: string, src: string, dest: string): Promise<boolean> {
+            if (!verifyToken(t)) {
+                return false;
+            }
+            return fs.copyFile(src, dest);
+        }
+    },
+
+    // --- 无需校验码 ---
+
+    // --- 测试与 native 的连通性 ---
+    'cg-ping': {
+        'once': false,
+        handler: function(t: string): string {
+            // --- t 不是 token，传过来什么就会传回去 ---
+            return 'pong: ' + t;
+        }
+    },
+    // --- 判断窗体是否是最大化状态 ---
+    'cg-is-max': {
+        'once': false,
+        handler: function(): boolean {
+            return form?.isMaximized ? true : false;
         }
     }
 };
 
-/**
- * --- node 端绑定前端来调用的方法 ---
- * @param name 方法名
- * @param handler 执行的函数
- * @param once 是否只执行一次
- */
-export function bind(
-    name: string,
-    handler: (...param: any[]) => any | Promise<any>,
-    once: boolean = false
-): void {
-    methods[name] = {
-        'once': once,
-        'handler': handler
-    };
-}
+/** --- 全局类 --- */
+export abstract class AbstractBoot {
+
+    /**
+     * --- 是否是沉浸式运行 ---
+     */
+    public get isImmersion(): boolean {
+        return isImmersion;
+    }
+
+    /**
+     * --- 是否含有实体窗体边框和标题 ---
+     */
+    public get hasFrame(): boolean {
+        return hasFrame;
+    }
+
+    /**
+     * --- 没有实体窗体时整个实体进程是不是会被结束 ---
+     */
+    public get isNoFormQuit(): boolean {
+        return isNoFormQuit;
+    }
+
+    /**
+     * --- 当前系统代号 ---
+     */
+    public get platform(): NodeJS.Platform {
+        return platform;
+    }
+
+    /**
+     * --- 当前的通讯 token ---
+     */
+    public get token(): string {
+        return token;
+    }
+
+    /** --- 入口方法 --- */
+    public abstract main(): void | Promise<void>;
+
+    /**
+     * --- 开始运行起来一个主实体窗体，整个进程本方法只能执行一次 ---
+     * @param path 实体窗体网页路径
+     * @param opt 参数
+     */
+    public run(path: string, opt: { 'frame'?: boolean; 'quit'?: boolean; } = {}): void {
+        if (opt.frame !== undefined) {
+            // --- 默认 false ---
+            hasFrame = opt.frame;
+        }
+        if (opt.quit !== undefined) {
+            // --- 默认 true ---
+            isNoFormQuit = opt.quit;
+        }
+        // --- 判断是否是沉浸式 ---
+        if (platform === 'win32') {
+            // --- 是 Windows 才有可能是沉浸式 ---
+            if (!hasFrame) {
+                // --- 实体窗体没有边框，一定是沉浸式 ---
+                isImmersion = true;
+            }
+        }
+        // --- 创建实体窗体 ---
+        createForm(path);
+        // --- 监听所有实体窗体关闭事件 ---
+        electron.app.on('window-all-closed', function(): void {
+            if (isNoFormQuit) {
+                electron.app.quit();
+            }
+        });
+        // --- 软件被活动性激活的事件 ---
+        electron.app.on('activate', function(): void {
+            if (electron.BrowserWindow.getAllWindows().length > 0) {
+                return;
+            }
+            createForm(path);
+            // --- 成功运行一个 task 后再次添加 init ---
+            methods['cg-init'] = {
+                'once': true,
+                handler: function(t: string) {
+                    // --- t 是网页传来的 token ---
+                    if (!t || !form) {
+                        return;
+                    }
+                    form.resizable = true;
+                    token = t;
+                }
+            };
+        });
+    }
+
+    /**
+     * --- 绑定监听网页调用方法的方法 ---
+     * @param name 方法名
+     * @param handler 要执行的函数
+     * @param once 是否只执行一次
+     */
+    public on(
+        name: string,
+        handler: (...param: any[]) => any | Promise<any>,
+        once: boolean = false
+    ): void {
+        methods[name] = {
+            'once': once,
+            'handler': handler
+        };
+    }
+
+    /**
+     * --- 绑定监听网页调用方法的方法但只会执行一次 ---
+     * @param name 方法名
+     * @param handler 要执行的函数
+     */
+    public once(name: string, handler: (...param: any[]) => any | Promise<any>): void {
+        this.on(name, handler, true);
+    }
+
+    /**
+     * --- 解绑监听的方法 ---
+     * @param name 方法名
+     */
+    public off(name: string): void {
+        if (!methods[name]) {
+            return;
+        }
+        delete methods[name];
+    }
 
-/**
- * --- node 端绑定前端来调用的方法只执行一次 ---
- * @param name 方法名
- * @param handler 执行的函数
- */
-export function once(name: string, handler: (...param: any[]) => any | Promise<any>): void {
-    bind(name, handler, true);
 }
 
-/**
- * --- 解绑 node 方法 ---
- * @param name 方法名
- */
-export function unbind(name: string): void {
-    if (!methods[name]) {
+/** --- 用户调用运行 boot 类 --- */
+export function launcher(boot: AbstractBoot): void {
+    (async function() {
+        // --- 等到 native 环境装载完毕 ---
+        await electron.app.whenReady();
+        await fs.refreshDrives();
+        // --- 执行回调 ---
+        await boot.main();
+    })().catch(function() {
         return;
-    }
-    delete methods[name];
+    });
 }
 
-electron.ipcMain.handle('pre', function(e: electron.IpcMainInvokeEvent, name: string, ...param: any[]): any | Promise<any> {
+// --- 系统启动 ---
+
+electron.Menu.setApplicationMenu(null);
+
+// --- 实际用来监听网页传输过来的数据 ---
+electron.ipcMain.handle('pre', function(e: electron.IpcMainInvokeEvent, name: string, ...param: any[]): any {
     if (!methods[name]) {
         return;
     }
@@ -180,13 +450,9 @@ export function verifyToken(t: string): boolean {
 }
 
 /**
- * --- 等到 native 环境装载完毕 ---
+ * --- 内部调用用来创建实体窗体的函数 ---
+ * @param p 窗体网页路径
  */
-export async function ready(): Promise<void> {
-    await electron.app.whenReady();
-    isReady = true;
-}
-
 function createForm(p: string): void {
     const op: Electron.BrowserWindowConstructorOptions = {
         'webPreferences': {
@@ -194,82 +460,50 @@ function createForm(p: string): void {
             'contextIsolation': true,
             'preload': path.join(__dirname, '/pre.js')
         },
-        'width': 500,
-        'height': 400,
-        'frame': isFrame,
+        'width': hasFrame ? 800 : 500,
+        'height': hasFrame ? 600 : 300,
+        'frame': hasFrame,
         'resizable': false,
         'show': false,
         'center': true,
-        'transparent': isFrame ? undefined : true
+        'transparent': isImmersion ? true : false
     };
-    win = new electron.BrowserWindow(op);
-    win.webContents.userAgent = 'electron/' + electron.app.getVersion() + ' ' + platform + '/' + process.arch;
-    // win.webContents.openDevTools();
-    win.once('ready-to-show', function(): void {
-        if (!win) {
+    form = new electron.BrowserWindow(op);
+    form.webContents.userAgent = 'electron/' + electron.app.getVersion() + ' ' + platform + '/' + process.arch + ' immersion/' + (isImmersion ? '1' : '0') + ' frame/' + (hasFrame ? '1' : '0');
+    // form.webContents.openDevTools();
+    form.once('ready-to-show', function(): void {
+        if (!form) {
             return;
         }
-        if (platform === 'win32') {
-            win.maximize();
-            win.setIgnoreMouseEvents(true, { 'forward': true });
+        if (isImmersion) {
+            // --- 沉浸式默认最大化 ---
+            form.maximize();
+            form.setIgnoreMouseEvents(true, { 'forward': true });
         }
         else {
             // --- 设置为第一个窗体的大小 ---
         }
-        win.show();
+        form.show();
     });
     const lio = p.indexOf('?');
     const search = lio === -1 ? '' : p.slice(lio + 1);
     if (lio !== -1) {
         p = p.slice(0, lio);
     }
-    win.loadFile(p, {
+    form.loadFile(p, {
         'search': search
     }).catch(function(e): void {
         throw e;
     });
-    win.on('close', function() {
-        win = undefined;
+    form.on('close', function() {
+        form = undefined;
     });
-}
-
-export function run(path: string, opt: { 'frame'?: boolean; 'quit'?: boolean; } = {}): void {
-    if (!isReady) {
-        return;
-    }
-    if (opt.frame !== undefined) {
-        isFrame = opt.frame;
-    }
-    if (opt.quit !== undefined) {
-        isQuit = opt.quit;
-    }
-    createForm(path);
-    electron.app.on('window-all-closed', function(): void {
-        /*
-        // --- MAC ---
-        if (platform !== 'darwin') {
-            electron.app.quit();
-        }
-        */
-        if (isQuit) {
-            electron.app.quit();
-        }
+    // --- 最大化事件 ---
+    form.on('maximize', function() {
+        form?.webContents.executeJavaScript('if(window.clickgoNativeWeb){clickgoNativeWeb.invoke("maximize")}') as any;
     });
-    electron.app.on('activate', function(): void {
-        if (electron.BrowserWindow.getAllWindows().length > 0) {
-            return;
-        }
-        createForm(path);
-        // --- 成功运行一个 task 后 init ---
-        methods['cg-init'] = {
-            'once': true,
-            handler: function(t: string) {
-                if (!t || !win) {
-                    return;
-                }
-                win.resizable = true;
-                token = t;
-            }
-        };
+    // --- 最大化还原 ---
+    form.on('unmaximize', function() {
+        form?.webContents.executeJavaScript('if(window.clickgoNativeWeb){clickgoNativeWeb.invoke("unmaximize")}') as any;
     });
 }