clickgo-native 2.0.1 → 2.0.3

package/README.md

@@ -42,6 +42,8 @@ native.launcher(new Boot());
 
 ## Build a ClickGo Application as a Native Package
 
+The application project does not need to install `electron` directly when using ClickGo Compiler to run and package it. The compiler supplies the Electron runtime. Native main-process code can use `native.getAppVersion()` to read the application's `package.json` version and `native.isPackaged()` to distinguish a packaged application from development runs. These APIs do not expose Electron to the HTML page.
+
 Building a desktop application consists of two steps: compile the ClickGo application into a `.cga` file, then package the Native project with Electron.
 
 Install the compiler globally first:

package/dist/index.d.ts

@@ -91,6 +91,16 @@ export declare function showMainForm(path: string, opt?: {
     /** --- 应用启动后、网页加载成功前显示的底色 --- */
     'background'?: string;
 }): void;
+/**
+ * --- 获取当前桌面应用的版本，来自应用 package.json ---
+ * @returns 应用版本
+ */
+export declare function getAppVersion(): string;
+/**
+ * --- 判断当前应用是否为已打包运行 ---
+ * @returns 是否已打包
+ */
+export declare function isPackaged(): boolean;
 /** --- 用户调用运行 boot 类 --- */
 export declare function launcher(boot: AbstractBoot): void;
 /**

package/dist/index.js

@@ -1,5 +1,6 @@
 import * as electron from 'electron';
 import * as nodePath from 'path';
+import { pathToFileURL } from 'node:url';
 import * as lFs from './lib/fs.js';
 import * as lTool from './lib/tool.js';
 // npm publish --tag dev --access public
@@ -12,6 +13,10 @@ let isNoFormQuit = true;
 let form;
 /** --- 当前设定的通讯 token --- */
 let token = '';
+/** --- 主窗体唯一允许使用 Native 通讯的页面地址（不含 hash） --- */
+let mainPage = '';
+/** --- 主框架正在更换文档时暂停 Native 通讯 --- */
+let mainNavigating = false;
 /** --- 当前系统平台 --- */
 const platform = process.platform;
 // const platform: NodeJS.Platform = 'darwin';
@@ -42,6 +47,8 @@ const methods = {
             }
             form.setSize(width, height);
             form.center();
+            // --- 首个应用窗体设置尺寸后再允许缩放，启动屏保持固定大小 ---
+            form.resizable = true;
         }
     },
     // --- 设置窗体最大化、最小化、还原（从最大化还原） ---
@@ -471,18 +478,7 @@ export function showMainForm(path, opt = {}) {
         // --- 有主窗体了就不能创建了 ---
         return;
     }
-    // --- 成功运行一个 task 后再次添加 init ---
-    methods['cg-init'] = {
-        'once': true,
-        handler: function (t) {
-            // --- t 是网页传来的 token ---
-            if (!t || !form) {
-                return;
-            }
-            form.resizable = true;
-            token = t;
-        },
-    };
+    resetMainSession();
     const frm = createForm(path, {
         'width': opt.width,
         'height': opt.height,
@@ -495,6 +491,40 @@ export function showMainForm(path, opt = {}) {
         frm.webContents.openDevTools();
     }
 }
+/**
+ * --- 更换主页面文档时撤销旧 token，重新允许一次合法初始化 ---
+ * @returns 无
+ */
+function resetMainSession() {
+    token = '';
+    methods['cg-init'] = {
+        'once': true,
+        handler: function (t) {
+            // --- t 是网页传来的 token ---
+            if ((typeof t !== 'string') || !t || !form || token) {
+                return;
+            }
+            if (hasFrame) {
+                form.resizable = true;
+            }
+            token = t;
+        },
+    };
+}
+/**
+ * --- 获取当前桌面应用的版本，来自应用 package.json ---
+ * @returns 应用版本
+ */
+export function getAppVersion() {
+    return electron.app.getVersion();
+}
+/**
+ * --- 判断当前应用是否为已打包运行 ---
+ * @returns 是否已打包
+ */
+export function isPackaged() {
+    return electron.app.isPackaged;
+}
 /** --- 用户调用运行 boot 类 --- */
 export function launcher(boot) {
     (async function () {
@@ -511,24 +541,44 @@ export function launcher(boot) {
 electron.Menu.setApplicationMenu(null);
 // --- 实际用来监听网页传输过来的数据 ---
 electron.ipcMain.handle('pre', function (e, name, ...param) {
-    if (!methods[name]) {
+    if (!form || form.isDestroyed() || mainNavigating ||
+        (e.sender !== form.webContents) ||
+        !e.senderFrame || (e.senderFrame !== form.webContents.mainFrame) ||
+        !mainPage || (getPageUrl(e.senderFrame.url) !== mainPage) ||
+        (typeof name !== 'string') || !Object.hasOwn(methods, name)) {
         return;
     }
-    const r = methods[name].handler(...param);
-    if (methods[name].once) {
+    // --- 无效初始化不能消耗一次性监听 ---
+    if ((name === 'cg-init') && ((typeof param[0] !== 'string') || !param[0] || token)) {
+        return;
+    }
+    const method = methods[name];
+    if (method.once) {
         delete methods[name];
     }
-    return r;
+    return method.handler(...param);
 });
+/**
+ * --- 精确匹配页面地址，允许同一页面改变 hash ---
+ * @param value 页面地址
+ * @returns 不含 hash 的地址，无效地址返回空字符串
+ */
+function getPageUrl(value) {
+    try {
+        const url = new URL(value);
+        url.hash = '';
+        return url.href;
+    }
+    catch {
+        return '';
+    }
+}
 /**
  * --- 验证 token 是否正确 ---
  * @param t 要验证的 token
  */
 export function verifyToken(t) {
-    if (t !== token) {
-        return false;
-    }
-    return true;
+    return (typeof t === 'string') && (token !== '') && (t === token);
 }
 /**
  * --- 内部调用用来创建实体窗体的函数 ---
@@ -554,6 +604,52 @@ function createForm(p, opt = {}) {
         'transparent': opt.transparent,
     };
     form = new electron.BrowserWindow(op);
+    // --- 页面地址由本地主进程确定，不接受网页修改 ---
+    const lio = p.indexOf('?');
+    const pageUrl = (p.startsWith('https://') || p.startsWith('http://')) ?
+        new URL(p) : pathToFileURL(lio === -1 ? p : p.slice(0, lio));
+    if ((pageUrl.protocol === 'file:') && (lio !== -1)) {
+        pageUrl.search = p.slice(lio + 1);
+    }
+    mainPage = getPageUrl(pageUrl.href);
+    mainNavigating = true;
+    /** --- 主动拦截初始页面重定向产生的加载失败无需再次抛出 --- */
+    let redirectBlocked = false;
+    form.webContents.on('will-navigate', (event) => {
+        if (getPageUrl(event.url) !== mainPage) {
+            event.preventDefault();
+        }
+    });
+    form.webContents.on('will-redirect', (event) => {
+        if (event.isMainFrame && (getPageUrl(event.url) !== mainPage)) {
+            redirectBlocked = true;
+            event.preventDefault();
+            mainNavigating = false;
+        }
+    });
+    form.webContents.setWindowOpenHandler(() => ({ 'action': 'deny' }));
+    form.webContents.on('did-start-navigation', (event) => {
+        if (event.isMainFrame && !event.isSameDocument && (getPageUrl(event.url) === mainPage)) {
+            mainNavigating = true;
+            resetMainSession();
+        }
+    });
+    form.webContents.on('did-navigate', () => {
+        mainNavigating = false;
+        if (form && (getPageUrl(form.webContents.getURL()) !== mainPage)) {
+            token = '';
+            delete methods['cg-init'];
+        }
+    });
+    form.webContents.on('did-fail-load', (_event, _code, _description, _url, isMainFrame) => {
+        if (isMainFrame) {
+            mainNavigating = false;
+        }
+    });
+    form.webContents.on('render-process-gone', () => {
+        token = '';
+        mainNavigating = true;
+    });
     form.webContents.userAgent = 'electron/' + electron.app.getVersion() + ' ' + platform + '/' + process.arch + ' frame/' + (hasFrame ? '1' : '0') + ' chrome/' + process.versions.chrome;
     form.once('ready-to-show', function () {
         if (!form) {
@@ -570,6 +666,9 @@ function createForm(p, opt = {}) {
     if (p.startsWith('https://') || p.startsWith('http://')) {
         // --- 加载网页 ---
         form.loadURL(p).catch(function (e) {
+            if (redirectBlocked) {
+                return;
+            }
             throw e;
         });
     }
@@ -586,8 +685,12 @@ function createForm(p, opt = {}) {
             throw e;
         });
     }
-    form.on('close', function () {
+    form.on('closed', function () {
         form = undefined;
+        token = '';
+        mainPage = '';
+        mainNavigating = false;
+        delete methods['cg-init'];
     });
     // --- 最大化事件 ---
     form.on('maximize', function () {

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "clickgo-native",
-  "version": "2.0.1",
+  "version": "2.0.3",
   "description": "The software developed with ClickGo will run in Windows, Mac OS, Linux.",
   "type": "module",
   "keywords": [