@plasosdk/plaso-electron-sdk 1.3.17-beta.2 → 1.3.17

package/js/render.js

@@ -1,523 +1,509 @@
-const path = require('path');
-const { ERROR_CODE, LESSON_TYPE, CLASS_WINDOW_MESG_TYPE, RENDER_TO_MAIN_MESG_TYPE, FILE_TYPE } = require('./macro');
-const getConfig = require('../scripts/getConfig');
-const LogFormatter = require('../scripts/logger');
-const { getElectronRemote, parseUrlParams, getDisplayMatching } = require('./util');
-
-const remote = getElectronRemote();
-const isMac = getConfig().platform === 'darwin';
-
-// logger
-const defaultLoggerPath = remote ? path.join(remote.app.getPath('userData'), '/P403FileTemp/') : '';
-const logger = new LogFormatter(defaultLoggerPath);
-logger.init();
-
-let currentWinId = null;
-let currentWebContentsId = null;
-
-/**
- * @param {import('./render').ClassWindowType} classWindowProps
- * @returns {number}
- */
-function createClassWindow(classWindowProps) {
-    const {
-        classOptions,
-        electronWinOptions,
-        onClassWindowReadyFn,
-        onClassWindowLeaveFn,
-        onClassFinishedFn,
-        onSaveBoardFn,
-        onOpenResourceCenterFn,
-        onGetExtFileNameFn,
-        onGetPreParseFileNameFn,
-        onReportIssuesFn,
-    } = classWindowProps;
-
-    const onFetchFavoritesFn = classWindowProps.browserOptions?.onFetchFavoritesFn;
-    const onFetchCategoriesFn = classWindowProps.browserOptions?.onFetchCategoriesFn;
-    const onAddFavoriteFn = classWindowProps.browserOptions?.onAddFavoriteFn;
-    const onRemoveFavoriteFn = classWindowProps.browserOptions?.onRemoveFavoriteFn;
-
-    logger.info('课堂窗口创建信息', {
-        version: getVersion(),
-        classOptions: classOptions,
-        electronWinOptions: electronWinOptions,
-    });
-
-    /* ----------------------------------- 守卫 ----------------------------------- */
-    if (currentWinId) {
-        logger.warn('课堂窗口同时仅能存在一个');
-        return ERROR_CODE.CLASS_WINODW_GREATER_THAN_ONE;
-    }
-
-    const isElectron = !!process?.versions?.['electron'];
-    if (!isElectron) {
-        logger.error('非 Electron 环境');
-        return ERROR_CODE.NO_ELECTRON_ENVIRONMENT;
-    }
-
-    if (!remote) {
-        logger.error('获取 remote 失败');
-        return ERROR_CODE.GET_REMOTE_FAIL;
-    }
-
-    const displayInfo = getDisplayMatching();
-    if (!displayInfo) {
-        logger.error('获取 displayInfo 失败');
-        return ERROR_CODE.GET_DISPLAY_INFO_FAIL;
-    }
-
-    /* ---------------------------- 拼凑 globalAppInfo ---------------------------- */
-    const openerId = remote.getCurrentWebContents().id;
-    const queryObj = classOptions.query ? parseUrlParams(classOptions.query) : {};
-    const autoMaximized = true;
-    const env = classOptions.env ? classOptions.env.toLowerCase() : 'www';
-
-    const getHost = () => {
-        let rhost, dhost;
-        switch (env) {
-            case 'local':
-                rhost = 'http://localhost:4399/';
-                dhost = 'https://dev.plaso.cn/';
-                break;
-            case 'dev':
-                // rhost = `https://${env}.plaso.cn/static/yxtelectronsdk/`;
-                rhost = `https://${env}.plaso.cn/static/yxtsdk/`;
-                dhost = `https://${env}.plaso.cn/`;
-                break;
-            case 'test':
-            case 'itest':
-            case 'ftest':
-                rhost = `https://${env}.plaso.cn/static/yxtsdk/`;
-                dhost = `https://${env}.plaso.cn/`;
-                break;
-            default:
-                rhost = `https://wwwr.plaso.cn/static/sdk/styleupime/${classOptions.version ?? '1.60.139'}/`;
-                dhost = 'https://www.plaso.cn/';
-                break;
-        }
-        return { rhost, dhost };
-    };
-
-    const globalAppInfo = {
-        ...classOptions,
-        ...queryObj,
-        ...getHost(),
-        query: classOptions.query,
-        appType: classOptions.appType,
-        markString: env,
-        env,
-        classType: classOptions.classType,
-        onClose: 'close', // 让课堂里退出时标识状态，详情见commFunction.js
-        electronSdkLoggerPath: logger.loggerPath ?? '',
-        electronSdkLoggerName: logger.logFileName ?? '',
-        flameshotPath: isMac
-            ? path.join(__dirname, '../lib/flameshot.app/Contents/MacOS/flameshot')
-            : path.join(__dirname, '../lib/flameshot/flameshot.exe'),
-        PlasoALDPath: isMac //
-            ? path.join(__dirname, '../lib/PlasoALD')
-            : '',
-        clientType: 'electron',
-        isElectronSdk: true,
-        openerId,
-        memoryConfigKey: classOptions.memoryConfigKey ?? queryObj.loginName ?? classOptions.loginName ?? '',
-        maximized: autoMaximized,
-        fullScreenable: queryObj.userType === 'listener', // 课堂最大化按钮是否是切换全屏模式
-        supportOnReportIssues: !!onReportIssuesFn,
-        supportOnFetchFavorites: !!onFetchFavoritesFn,
-        supportOnFetchCategories: !!onFetchCategoriesFn,
-        supportOnAddFavorite: !!onAddFavoriteFn,
-        supportOnRemoveFavorite: !!onRemoveFavoriteFn,
-    };
-
-    if (globalAppInfo.userType === 'monitor') {
-        globalAppInfo.monitor = true;
-    }
-
-    /* ------------------------------ electron 窗口配置 ----------------------------- */
-    const buildElectronWinOptions = () => {
-        const buildBounds = () => {
-            const bounds = remote.getCurrentWindow().getBounds();
-            const screenWidth = displayInfo.size.width;
-            const screenWorkAreaWidth = displayInfo.workAreaSize.width;
-            const screenHeight = displayInfo.size.height;
-            const screenWorkAreaHeight = displayInfo.workAreaSize.height;
-
-            const changeBoundsDate = (ischangeWidth, baseWidthOrHeight) => {
-                const newWidthOrHeight = baseWidthOrHeight - 10;
-                if (ischangeWidth) {
-                    bounds.height = Math.round((bounds.height * newWidthOrHeight) / bounds.width);
-                    bounds.width = newWidthOrHeight;
-                } else {
-                    bounds.width = Math.round((bounds.width * newWidthOrHeight) / bounds.height);
-                    bounds.height = newWidthOrHeight;
-                }
-            };
-            // 课堂窗口创建时的宽或高和 屏幕宽高或屏幕工作区宽高 一致时，此时透明窗口会失效，需要调整进课堂时的窗口宽高
-            if (bounds.width === screenWidth || bounds.width === screenWorkAreaWidth) {
-                changeBoundsDate(true, Math.min(screenWidth, screenWorkAreaWidth));
-            }
-            if (bounds.height === screenHeight || bounds.height === screenWorkAreaHeight) {
-                changeBoundsDate(false, Math.min(screenHeight, screenWorkAreaHeight));
-            }
-            return bounds;
-        };
-
-        const defaultElectronWinOptions = {
-            frame: false,
-            /**
-             * electron 12.0.18之后，resizable设为true才能全屏和最大化，
-             * 而课堂窗口不允许通过electron自身的缩放行为来改变大小，因此进入课堂后会将resizable设为false
-             */
-            resizable: true,
-            /** 设置为true，mac上setFullScreen(true)才生效，setSimpleFullScreen(true)不依赖此参数 */
-            fullscreenable: true,
-            ...buildBounds(),
-            webPreferences: {
-                nodeIntegration: true,
-                enableRemoteModule: true,
-                contextIsolation: false,
-                nodeIntegrationInWorker: true,
-                webviewTag: true,
-            },
-        };
-
-        if (isMac) {
-            // 在Mac下要显式设置fullscreen为false，防止客户端全屏时进入课堂，课堂窗口也默认全屏，
-            // 导致部分按钮失效，以及独立窗口打开异常
-            defaultElectronWinOptions.fullscreen = false;
-        }
-
-        // 学生无需使用透明窗口（透明窗口问题多），减少影响
-        if (queryObj.userType !== 'listener') {
-            defaultElectronWinOptions.transparent = true;
-            defaultElectronWinOptions.backgroundColor = '#00ffffff';
-        }
-
-        if (queryObj.topic) {
-            defaultElectronWinOptions.title = queryObj.topic + '';
-        }
-        if (classOptions.topic && classOptions.classType === LESSON_TYPE.PREPARE_LESSONS) {
-            defaultElectronWinOptions.title = classOptions.topic + '';
-        }
-
-        return {
-            ...defaultElectronWinOptions,
-            ...(electronWinOptions || {}),
-        };
-    };
-
-    /* -------------------------------- 回调 bridge ------------------------------- */
-    const { ipcRenderer } = window.require('electron');
-
-    /**
-     * 适用范围
-     * 用于创建带回复的回调，要求
-     * ipc-request payload 格式为 (requestId, ...args)
-     * ipc-response payload 格式为 (requestId, returnValue)
-     *
-     * 整条链路
-     * [课堂窗口] --ipc-request--> [Handler] --> [classWindowProps.onXxxFn] --> [Handler] --ipc-response--> [课堂窗口]
-     * 本函数用来构建这个桥接用的 handler
-     *
-     * 内部流程
-     * - step 1 执行 beforeCallback，如果返回 false 则中止
-     * - step 2 如果 callback 不存在则中止
-     * - step 3 执行 callback
-     * - step 4 执行 afterCallback，如果返回 false 则中止
-     * - step 5 则把 callback 返回值发给课堂窗口
-     */
-    /** @type {import('./render').BuildReplyingCallback} */
-    const buildReplyingCallback = ({ requestMsgType, responseMsgType, callback, beforeCallback, afterCallback }) => {
-        return {
-            requestMsgType,
-            responseMsgType,
-            handler: async (event, requestId, ...args) => {
-                const info = `${requestMsgType} ${responseMsgType} ${requestId}`;
-                try {
-                    logger.info(`[callback bridge] start ${info}`);
-                    if (!currentWebContentsId || !responseMsgType || !requestId) {
-                        return;
-                    }
-                    if (beforeCallback?.(...args) === false) {
-                        logger.info(`[callback bridge] beforeCallback guard, ${info}`);
-                        return;
-                    }
-                    if (!callback) {
-                        logger.info(`[callback bridge] callback is null, skip, ${info}`);
-                        return;
-                    }
-                    const result = await callback(...args);
-                    if (afterCallback?.(result) === false) {
-                        logger.info(`[callback bridge] afterCallback guard, ${info}`);
-                        return;
-                    }
-                    ipcRenderer.sendTo(currentWebContentsId, responseMsgType, requestId, result);
-                    logger.info(`[callback bridge] end ${info}`);
-                } catch (error) {
-                    logger.error(`[callback bridge] error ${info}`, error);
-                }
-            },
-        };
-    };
-
-    const onClassWindowReady = (event) => {
-        const classWindow = remote.BrowserWindow.fromId(currentWinId);
-        classWindow.moveTop();
-        classWindow.focus();
-        logger.info(`课堂窗口ready，id:${currentWinId}`);
-        if (onClassWindowReadyFn && currentWinId) {
-            onClassWindowReadyFn(currentWinId);
-        }
-    };
-
-    const onClassFinished = (event, value) => {
-        const meetingId = value?.meetingId;
-        logger.info(`课堂已结束，id:${currentWinId}, meetingId is ${meetingId}`);
-        if (onClassFinishedFn && currentWinId) {
-            onClassFinishedFn(meetingId);
-        }
-    };
-
-    const onHtmlReady = (event, value) => {
-        currentWebContentsId = value?.webContentId;
-        logger.info(`课堂窗口 html ready，web contents id:${currentWebContentsId}`);
-        if (currentWebContentsId) {
-            ipcRenderer.sendTo(currentWebContentsId, CLASS_WINDOW_MESG_TYPE.INIT_GLOBAL_APPINFO, globalAppInfo);
-        }
-    };
-
-    const onSaveBoard = (event, value) => {
-        logger.info(`保存板书:${JSON.stringify(value)}`);
-        if (onSaveBoardFn && value) {
-            onSaveBoardFn(value, (value) => {
-                if (currentWebContentsId) {
-                    ipcRenderer.sendTo(currentWebContentsId, CLASS_WINDOW_MESG_TYPE.RESP_SAVE_BOARD, value);
-                }
-            });
-        }
-    };
-
-    const onOpenResourceCenter = (event) => {
-        onOpenResourceCenterFn?.();
-    };
-
-    const onReportIssues = (event, info) => {
-        onReportIssuesFn?.(info);
-    };
-
-    const onGetExtFileName = buildReplyingCallback({
-        requestMsgType: CLASS_WINDOW_MESG_TYPE.GET_EXT_FILE_NAME,
-        beforeCallback: (...args) => args.length > 0,
-        callback: onGetExtFileNameFn,
-        afterCallback: (result) => !!result,
-        responseMsgType: CLASS_WINDOW_MESG_TYPE.RESP_GET_EXT_FILE_NAME,
-    });
-
-    const onGetPreParseFileName = buildReplyingCallback({
-        requestMsgType: CLASS_WINDOW_MESG_TYPE.GET_PRE_PARSE_FILE_NAME,
-        beforeCallback: (...args) => args.length > 0,
-        callback: onGetPreParseFileNameFn,
-        afterCallback: (result) => !!result,
-        responseMsgType: CLASS_WINDOW_MESG_TYPE.RESP_GET_PRE_PARSE_FILE_NAME,
-    });
-
-    const onFetchFavorites = buildReplyingCallback({
-        requestMsgType: CLASS_WINDOW_MESG_TYPE.FETCH_FAVORITES,
-        responseMsgType: CLASS_WINDOW_MESG_TYPE.RESP_FETCH_FAVORITES,
-        callback: onFetchFavoritesFn,
-    });
-
-    const onFetchCategories = buildReplyingCallback({
-        requestMsgType: CLASS_WINDOW_MESG_TYPE.FETCH_CATEGORIES,
-        responseMsgType: CLASS_WINDOW_MESG_TYPE.RESP_FETCH_CATEGORIES,
-        callback: onFetchCategoriesFn,
-    });
-
-    const onAddFavorite = buildReplyingCallback({
-        requestMsgType: CLASS_WINDOW_MESG_TYPE.ADD_FAVORITE,
-        responseMsgType: CLASS_WINDOW_MESG_TYPE.RESP_ADD_FAVORITE,
-        callback: onAddFavoriteFn,
-    });
-
-    const onRemoveFavorite = buildReplyingCallback({
-        requestMsgType: CLASS_WINDOW_MESG_TYPE.REMOVE_FAVORITE,
-        responseMsgType: CLASS_WINDOW_MESG_TYPE.RESP_REMOVE_FAVORITE,
-        callback: onRemoveFavoriteFn,
-    });
-
-    const callbacks = {
-        [CLASS_WINDOW_MESG_TYPE.LIVE_WINDOW_READY]: onClassWindowReady,
-        [CLASS_WINDOW_MESG_TYPE.ON_CLASS_FINISHED]: onClassFinished,
-        [CLASS_WINDOW_MESG_TYPE.HTML_READY]: onHtmlReady,
-        [CLASS_WINDOW_MESG_TYPE.SAVE_BOARD]: onSaveBoard,
-        [CLASS_WINDOW_MESG_TYPE.OPEN_RESOURCE_CENTER]: onOpenResourceCenter,
-        [CLASS_WINDOW_MESG_TYPE.REPORT_ISSUES]: onReportIssues,
-        [onGetExtFileName.requestMsgType]: onGetExtFileName.handler,
-        [onGetPreParseFileName.requestMsgType]: onGetPreParseFileName.handler,
-        [onFetchFavorites.requestMsgType]: onFetchFavorites.handler,
-        [onFetchCategories.requestMsgType]: onFetchCategories.handler,
-        [onAddFavorite.requestMsgType]: onAddFavorite.handler,
-        [onRemoveFavorite.requestMsgType]: onRemoveFavorite.handler,
-    };
-
-    Object.entries(callbacks).forEach(([type, callback]) => {
-        ipcRenderer.on(type, callback);
-    });
-
-    /* ---------------------------------- 窗口创建 ---------------------------------- */
-    const appProxy = require('@plasosdk/winproxy');
-
-    const indexHtmlPath = isMac
-        ? require('url').format({
-              pathname: path.join(__dirname, '../index.html'),
-              protocol: 'file:',
-              slashes: true,
-          })
-        : path.join(__dirname, '../index.html');
-
-    appProxy.createWindow(
-        {
-            path: indexHtmlPath + `?openerId=${openerId}`,
-            debug: classOptions?.debug ?? false,
-            maximize: autoMaximized,
-            windowOptions: buildElectronWinOptions(),
-        },
-        onWindowCreated,
-    );
-
-    async function onWindowCreated(id) {
-        currentWinId = id;
-        appProxy.addWinEventListener(id, 'closed', onWindowClosed);
-    }
-
-    /* ---------------------------------- 窗口关闭 ---------------------------------- */
-    function onWindowClosed() {
-        logger.info(`课堂窗口关闭，id:${currentWinId}`);
-        onClassWindowLeaveFn?.(currentWinId);
-        currentWinId = null;
-        currentWebContentsId = null;
-        Object.entries(callbacks).forEach(([type, callback]) => {
-            ipcRenderer.removeListener(type, callback);
-        });
-    }
-
-    return 0;
-}
-
-function getVersion() {
-    try {
-        const packageJson = require('../package.json');
-        return packageJson.version;
-    } catch (error) {
-        logger.error(`getVersion error is: ${JSON.stringify(error)}}`);
-        return ERROR_CODE.COMMOM_ERROR;
-    }
-}
-
-/** Plaso Electron SDK */
-module.exports = {
-    /**
-     * 课堂
-     * @param {import('./render').ClassWindowType} liveClassWindowProps
-     * @returns {number}
-     */
-    createLiveClassWindow(liveClassWindowProps) {
-        try {
-            return createClassWindow({
-                ...liveClassWindowProps,
-                classOptions: {
-                    ...liveClassWindowProps.classOptions,
-                    appType: 'liveclassSDK',
-                    classType: LESSON_TYPE.LIVECLASS,
-                },
-            });
-        } catch (error) {
-            logger.error(`异常错误，${JSON.stringify(error)}`);
-            return ERROR_CODE.COMMOM_ERROR;
-        }
-    },
-
-    /**
-     * 备课
-     * @param {import('./render').ClassWindowType} prepareClassWindowProps
-     * @returns {number}
-     */
-    createPrepareClassWindow(prepareClassWindowProps) {
-        try {
-            return createClassWindow({
-                ...prepareClassWindowProps,
-                classOptions: {
-                    ...prepareClassWindowProps.classOptions,
-                    appType: 'prepareLessonSdk',
-                    meetingType: LESSON_TYPE.PREPARE_LESSONS,
-                    classType: LESSON_TYPE.PREPARE_LESSONS,
-                    userType: 'speaker',
-                    topic: prepareClassWindowProps.classOptions.topic ?? '备课课堂',
-                },
-            });
-        } catch (error) {
-            logger.error(`异常错误，${JSON.stringify(error)}`);
-            return ERROR_CODE.COMMOM_ERROR;
-        }
-    },
-
-    /**
-     * 获取 sdk 版本
-     */
-    getVersion,
-
-    /**
-     *初始化日志文件路径
-     * @param {string} logFilePath 日志文件路径
-     */
-    initLogConfig(logFilePath) {
-        if (logFilePath) {
-            logger.initLoggerFilePath(logFilePath);
-            require('electron')
-                .ipcRenderer //
-                .send(RENDER_TO_MAIN_MESG_TYPE.PLASO_INIT_LOG_PATH, logFilePath);
-        }
-    },
-
-    /**
-     * 插入的资源文件类型定义
-     */
-    FILE_TYPE,
-
-    /**
-     * 插入外部云盘里的文件，文件需要遵循特定的数据结构
-     * @param {import('./render').FileDataObj} fileData 文件数据
-     */
-    insertObject(fileData) {
-        try {
-            if (currentWebContentsId) {
-                window
-                    .require('electron')
-                    .ipcRenderer //
-                    .sendTo(currentWebContentsId, CLASS_WINDOW_MESG_TYPE.INSERT_OBJECT, fileData);
-            }
-        } catch (error) {
-            logger.error(`insertObject error is: ${JSON.stringify(error)}}`);
-            return ERROR_CODE.COMMOM_ERROR;
-        }
-    },
-
-    /**
-     * 更新严禁词列表
-     * @param {string[]} words 严禁词数组
-     */
-    updateProhibitedWords(words) {
-        try {
-            if (currentWebContentsId) {
-                window
-                    .require('electron')
-                    .ipcRenderer //
-                    .sendTo(currentWebContentsId, CLASS_WINDOW_MESG_TYPE.UPDATE_SENSITIVE_WORDS, words || []);
-            }
-        } catch (error) {
-            logger.error(`updateProhibitedWords error is: ${JSON.stringify(error)}}`);
-            return ERROR_CODE.COMMOM_ERROR;
-        }
-    },
-};
+const path = require('path');
+const { ERROR_CODE, LESSON_TYPE, CLASS_WINDOW_MESG_TYPE, RENDER_TO_MAIN_MESG_TYPE, FILE_TYPE } = require('./macro');
+const getConfig = require('../scripts/getConfig');
+const LogFormatter = require('../scripts/logger');
+const { getElectronRemote, parseUrlParams, getDisplayMatching } = require('./util');
+
+const remote = getElectronRemote();
+const isMac = getConfig().platform === 'darwin';
+
+// logger
+const defaultLoggerPath = remote ? path.join(remote.app.getPath('userData'), '/P403FileTemp/') : '';
+const logger = new LogFormatter(defaultLoggerPath);
+logger.init();
+
+let currentWinId = null;
+let currentWebContentsId = null;
+
+/**
+ * @param {import('./render').ClassWindowType} classWindowProps
+ * @returns {number}
+ */
+function createClassWindow(classWindowProps) {
+    const {
+        classOptions,
+        electronWinOptions,
+        onClassWindowReadyFn,
+        onClassWindowLeaveFn,
+        onClassFinishedFn,
+        onSaveBoardFn,
+        onOpenResourceCenterFn,
+        onGetExtFileNameFn,
+        onGetPreParseFileNameFn,
+        onReportIssuesFn,
+    } = classWindowProps;
+
+    const onFetchFavoritesFn = classWindowProps.browserOptions?.onFetchFavoritesFn;
+    const onFetchCategoriesFn = classWindowProps.browserOptions?.onFetchCategoriesFn;
+    const onAddFavoriteFn = classWindowProps.browserOptions?.onAddFavoriteFn;
+    const onRemoveFavoriteFn = classWindowProps.browserOptions?.onRemoveFavoriteFn;
+
+    logger.info('课堂窗口创建信息', {
+        version: getVersion(),
+        classOptions: classOptions,
+        electronWinOptions: electronWinOptions,
+    });
+
+    /* ----------------------------------- 守卫 ----------------------------------- */
+    if (currentWinId) {
+        logger.warn('课堂窗口同时仅能存在一个');
+        return ERROR_CODE.CLASS_WINODW_GREATER_THAN_ONE;
+    }
+
+    const isElectron = !!process?.versions?.['electron'];
+    if (!isElectron) {
+        logger.error('非 Electron 环境');
+        return ERROR_CODE.NO_ELECTRON_ENVIRONMENT;
+    }
+
+    if (!remote) {
+        logger.error('获取 remote 失败');
+        return ERROR_CODE.GET_REMOTE_FAIL;
+    }
+
+    const displayInfo = getDisplayMatching();
+    if (!displayInfo) {
+        logger.error('获取 displayInfo 失败');
+        return ERROR_CODE.GET_DISPLAY_INFO_FAIL;
+    }
+
+    /* ---------------------------- 拼凑 globalAppInfo ---------------------------- */
+    const openerId = remote.getCurrentWebContents().id;
+    const queryObj = classOptions.query ? parseUrlParams(classOptions.query) : {};
+    const autoMaximized = true;
+    const env = classOptions.env ? classOptions.env.toLowerCase() : 'www';
+
+    const getHost = () => {
+        let rhost = `https://wwwr.plaso.cn/static/sdk/styleupime/${classOptions.version ?? '1.68.110'}/`;
+        let dhost = 'https://www.plaso.cn/';
+        if (classOptions.rhost) {
+            rhost = classOptions.rhost; // 调试用，不对外
+        }
+        if (classOptions.dhost) {
+            dhost = classOptions.dhost;
+        }
+        return { rhost, dhost };
+    };
+
+    const globalAppInfo = {
+        ...classOptions,
+        ...queryObj,
+        ...getHost(),
+        query: classOptions.query,
+        appType: classOptions.appType,
+        markString: env,
+        env,
+        classType: classOptions.classType,
+        onClose: 'close', // 让课堂里退出时标识状态，详情见commFunction.js
+        electronSdkLoggerPath: logger.loggerPath ?? '',
+        electronSdkLoggerName: logger.logFileName ?? '',
+        flameshotPath: isMac
+            ? path.join(__dirname, '../lib/flameshot.app/Contents/MacOS/flameshot')
+            : path.join(__dirname, '../lib/flameshot/flameshot.exe'),
+        PlasoALDPath: isMac //
+            ? path.join(__dirname, '../lib/PlasoALD')
+            : '',
+        clientType: 'electron',
+        isElectronSdk: true,
+        openerId,
+        memoryConfigKey: classOptions.memoryConfigKey ?? queryObj.loginName ?? classOptions.loginName ?? '',
+        maximized: autoMaximized,
+        fullScreenable: queryObj.userType === 'listener', // 课堂最大化按钮是否是切换全屏模式
+        supportOnReportIssues: !!onReportIssuesFn,
+        supportOnFetchFavorites: !!onFetchFavoritesFn,
+        supportOnFetchCategories: !!onFetchCategoriesFn,
+        supportOnAddFavorite: !!onAddFavoriteFn,
+        supportOnRemoveFavorite: !!onRemoveFavoriteFn,
+    };
+
+    if (globalAppInfo.userType === 'monitor') {
+        globalAppInfo.monitor = true;
+    }
+
+    /* ------------------------------ electron 窗口配置 ----------------------------- */
+    const buildElectronWinOptions = () => {
+        const buildBounds = () => {
+            const bounds = remote.getCurrentWindow().getBounds();
+            const screenWidth = displayInfo.size.width;
+            const screenWorkAreaWidth = displayInfo.workAreaSize.width;
+            const screenHeight = displayInfo.size.height;
+            const screenWorkAreaHeight = displayInfo.workAreaSize.height;
+
+            const changeBoundsDate = (ischangeWidth, baseWidthOrHeight) => {
+                const newWidthOrHeight = baseWidthOrHeight - 10;
+                if (ischangeWidth) {
+                    bounds.height = Math.round((bounds.height * newWidthOrHeight) / bounds.width);
+                    bounds.width = newWidthOrHeight;
+                } else {
+                    bounds.width = Math.round((bounds.width * newWidthOrHeight) / bounds.height);
+                    bounds.height = newWidthOrHeight;
+                }
+            };
+            // 课堂窗口创建时的宽或高和 屏幕宽高或屏幕工作区宽高 一致时，此时透明窗口会失效，需要调整进课堂时的窗口宽高
+            if (bounds.width === screenWidth || bounds.width === screenWorkAreaWidth) {
+                changeBoundsDate(true, Math.min(screenWidth, screenWorkAreaWidth));
+            }
+            if (bounds.height === screenHeight || bounds.height === screenWorkAreaHeight) {
+                changeBoundsDate(false, Math.min(screenHeight, screenWorkAreaHeight));
+            }
+            return bounds;
+        };
+
+        const defaultElectronWinOptions = {
+            frame: false,
+            /**
+             * electron 12.0.18之后，resizable设为true才能全屏和最大化，
+             * 而课堂窗口不允许通过electron自身的缩放行为来改变大小，因此进入课堂后会将resizable设为false
+             */
+            resizable: true,
+            /** 设置为true，mac上setFullScreen(true)才生效，setSimpleFullScreen(true)不依赖此参数 */
+            fullscreenable: true,
+            ...buildBounds(),
+            webPreferences: {
+                nodeIntegration: true,
+                enableRemoteModule: true,
+                contextIsolation: false,
+                nodeIntegrationInWorker: true,
+                webviewTag: true,
+            },
+        };
+
+        if (isMac) {
+            // 在Mac下要显式设置fullscreen为false，防止客户端全屏时进入课堂，课堂窗口也默认全屏，
+            // 导致部分按钮失效，以及独立窗口打开异常
+            defaultElectronWinOptions.fullscreen = false;
+        }
+
+        // 学生无需使用透明窗口（透明窗口问题多），减少影响
+        if (queryObj.userType !== 'listener') {
+            defaultElectronWinOptions.transparent = true;
+            defaultElectronWinOptions.backgroundColor = '#00ffffff';
+        }
+
+        if (queryObj.topic) {
+            defaultElectronWinOptions.title = queryObj.topic + '';
+        }
+        if (classOptions.topic && classOptions.classType === LESSON_TYPE.PREPARE_LESSONS) {
+            defaultElectronWinOptions.title = classOptions.topic + '';
+        }
+
+        return {
+            ...defaultElectronWinOptions,
+            ...(electronWinOptions || {}),
+        };
+    };
+
+    /* -------------------------------- 回调 bridge ------------------------------- */
+    const { ipcRenderer } = window.require('electron');
+
+    /**
+     * 适用范围
+     * 用于创建带回复的回调，要求
+     * ipc-request payload 格式为 (requestId, ...args)
+     * ipc-response payload 格式为 (requestId, returnValue)
+     *
+     * 整条链路
+     * [课堂窗口] --ipc-request--> [Handler] --> [classWindowProps.onXxxFn] --> [Handler] --ipc-response--> [课堂窗口]
+     * 本函数用来构建这个桥接用的 handler
+     *
+     * 内部流程
+     * - step 1 执行 beforeCallback，如果返回 false 则中止
+     * - step 2 如果 callback 不存在则中止
+     * - step 3 执行 callback
+     * - step 4 执行 afterCallback，如果返回 false 则中止
+     * - step 5 则把 callback 返回值发给课堂窗口
+     */
+    /** @type {import('./render').BuildReplyingCallback} */
+    const buildReplyingCallback = ({ requestMsgType, responseMsgType, callback, beforeCallback, afterCallback }) => {
+        return {
+            requestMsgType,
+            responseMsgType,
+            handler: async (event, requestId, ...args) => {
+                const info = `${requestMsgType} ${responseMsgType} ${requestId}`;
+                try {
+                    logger.info(`[callback bridge] start ${info}`);
+                    if (!currentWebContentsId || !responseMsgType || !requestId) {
+                        return;
+                    }
+                    if (beforeCallback?.(...args) === false) {
+                        logger.info(`[callback bridge] beforeCallback guard, ${info}`);
+                        return;
+                    }
+                    if (!callback) {
+                        logger.info(`[callback bridge] callback is null, skip, ${info}`);
+                        return;
+                    }
+                    const result = await callback(...args);
+                    if (afterCallback?.(result) === false) {
+                        logger.info(`[callback bridge] afterCallback guard, ${info}`);
+                        return;
+                    }
+                    ipcRenderer.sendTo(currentWebContentsId, responseMsgType, requestId, result);
+                    logger.info(`[callback bridge] end ${info}`);
+                } catch (error) {
+                    logger.error(`[callback bridge] error ${info}`, error);
+                }
+            },
+        };
+    };
+
+    const onClassWindowReady = (event) => {
+        const classWindow = remote.BrowserWindow.fromId(currentWinId);
+        classWindow.moveTop();
+        classWindow.focus();
+        logger.info(`课堂窗口ready，id:${currentWinId}`);
+        if (onClassWindowReadyFn && currentWinId) {
+            onClassWindowReadyFn(currentWinId);
+        }
+    };
+
+    const onClassFinished = (event, value) => {
+        const meetingId = value?.meetingId;
+        logger.info(`课堂已结束，id:${currentWinId}, meetingId is ${meetingId}`);
+        if (onClassFinishedFn && currentWinId) {
+            onClassFinishedFn(meetingId);
+        }
+    };
+
+    const onHtmlReady = (event, value) => {
+        currentWebContentsId = value?.webContentId;
+        logger.info(`课堂窗口 html ready，web contents id:${currentWebContentsId}`);
+        if (currentWebContentsId) {
+            ipcRenderer.sendTo(currentWebContentsId, CLASS_WINDOW_MESG_TYPE.INIT_GLOBAL_APPINFO, globalAppInfo);
+        }
+    };
+
+    const onSaveBoard = (event, value) => {
+        logger.info(`保存板书:${JSON.stringify(value)}`);
+        if (onSaveBoardFn && value) {
+            onSaveBoardFn(value, (value) => {
+                if (currentWebContentsId) {
+                    ipcRenderer.sendTo(currentWebContentsId, CLASS_WINDOW_MESG_TYPE.RESP_SAVE_BOARD, value);
+                }
+            });
+        }
+    };
+
+    const onOpenResourceCenter = (event) => {
+        onOpenResourceCenterFn?.();
+    };
+
+    const onReportIssues = (event, info) => {
+        onReportIssuesFn?.(info);
+    };
+
+    const onGetExtFileName = buildReplyingCallback({
+        requestMsgType: CLASS_WINDOW_MESG_TYPE.GET_EXT_FILE_NAME,
+        beforeCallback: (...args) => args.length > 0,
+        callback: onGetExtFileNameFn,
+        afterCallback: (result) => !!result,
+        responseMsgType: CLASS_WINDOW_MESG_TYPE.RESP_GET_EXT_FILE_NAME,
+    });
+
+    const onGetPreParseFileName = buildReplyingCallback({
+        requestMsgType: CLASS_WINDOW_MESG_TYPE.GET_PRE_PARSE_FILE_NAME,
+        beforeCallback: (...args) => args.length > 0,
+        callback: onGetPreParseFileNameFn,
+        afterCallback: (result) => !!result,
+        responseMsgType: CLASS_WINDOW_MESG_TYPE.RESP_GET_PRE_PARSE_FILE_NAME,
+    });
+
+    const onFetchFavorites = buildReplyingCallback({
+        requestMsgType: CLASS_WINDOW_MESG_TYPE.FETCH_FAVORITES,
+        responseMsgType: CLASS_WINDOW_MESG_TYPE.RESP_FETCH_FAVORITES,
+        callback: onFetchFavoritesFn,
+    });
+
+    const onFetchCategories = buildReplyingCallback({
+        requestMsgType: CLASS_WINDOW_MESG_TYPE.FETCH_CATEGORIES,
+        responseMsgType: CLASS_WINDOW_MESG_TYPE.RESP_FETCH_CATEGORIES,
+        callback: onFetchCategoriesFn,
+    });
+
+    const onAddFavorite = buildReplyingCallback({
+        requestMsgType: CLASS_WINDOW_MESG_TYPE.ADD_FAVORITE,
+        responseMsgType: CLASS_WINDOW_MESG_TYPE.RESP_ADD_FAVORITE,
+        callback: onAddFavoriteFn,
+    });
+
+    const onRemoveFavorite = buildReplyingCallback({
+        requestMsgType: CLASS_WINDOW_MESG_TYPE.REMOVE_FAVORITE,
+        responseMsgType: CLASS_WINDOW_MESG_TYPE.RESP_REMOVE_FAVORITE,
+        callback: onRemoveFavoriteFn,
+    });
+
+    const callbacks = {
+        [CLASS_WINDOW_MESG_TYPE.LIVE_WINDOW_READY]: onClassWindowReady,
+        [CLASS_WINDOW_MESG_TYPE.ON_CLASS_FINISHED]: onClassFinished,
+        [CLASS_WINDOW_MESG_TYPE.HTML_READY]: onHtmlReady,
+        [CLASS_WINDOW_MESG_TYPE.SAVE_BOARD]: onSaveBoard,
+        [CLASS_WINDOW_MESG_TYPE.OPEN_RESOURCE_CENTER]: onOpenResourceCenter,
+        [CLASS_WINDOW_MESG_TYPE.REPORT_ISSUES]: onReportIssues,
+        [onGetExtFileName.requestMsgType]: onGetExtFileName.handler,
+        [onGetPreParseFileName.requestMsgType]: onGetPreParseFileName.handler,
+        [onFetchFavorites.requestMsgType]: onFetchFavorites.handler,
+        [onFetchCategories.requestMsgType]: onFetchCategories.handler,
+        [onAddFavorite.requestMsgType]: onAddFavorite.handler,
+        [onRemoveFavorite.requestMsgType]: onRemoveFavorite.handler,
+    };
+
+    Object.entries(callbacks).forEach(([type, callback]) => {
+        ipcRenderer.on(type, callback);
+    });
+
+    /* ---------------------------------- 窗口创建 ---------------------------------- */
+    const appProxy = require('@plasosdk/winproxy');
+
+    const indexHtmlPath = isMac
+        ? require('url').format({
+              pathname: path.join(__dirname, '../index.html'),
+              protocol: 'file:',
+              slashes: true,
+          })
+        : path.join(__dirname, '../index.html');
+
+    appProxy.createWindow(
+        {
+            path: indexHtmlPath + `?openerId=${openerId}`,
+            debug: classOptions?.debug ?? false,
+            maximize: autoMaximized,
+            windowOptions: buildElectronWinOptions(),
+        },
+        onWindowCreated,
+    );
+
+    async function onWindowCreated(id) {
+        currentWinId = id;
+        appProxy.addWinEventListener(id, 'closed', onWindowClosed);
+    }
+
+    /* ---------------------------------- 窗口关闭 ---------------------------------- */
+    function onWindowClosed() {
+        logger.info(`课堂窗口关闭，id:${currentWinId}`);
+        onClassWindowLeaveFn?.(currentWinId);
+        currentWinId = null;
+        currentWebContentsId = null;
+        Object.entries(callbacks).forEach(([type, callback]) => {
+            ipcRenderer.removeListener(type, callback);
+        });
+    }
+
+    return 0;
+}
+
+function getVersion() {
+    try {
+        const packageJson = require('../package.json');
+        return packageJson.version;
+    } catch (error) {
+        logger.error(`getVersion error is: ${JSON.stringify(error)}}`);
+        return ERROR_CODE.COMMOM_ERROR;
+    }
+}
+
+/** Plaso Electron SDK */
+module.exports = {
+    /**
+     * 课堂
+     * @param {import('./render').ClassWindowType} liveClassWindowProps
+     * @returns {number}
+     */
+    createLiveClassWindow(liveClassWindowProps) {
+        try {
+            return createClassWindow({
+                ...liveClassWindowProps,
+                classOptions: {
+                    ...liveClassWindowProps.classOptions,
+                    appType: 'liveclassSDK',
+                    classType: LESSON_TYPE.LIVECLASS,
+                },
+            });
+        } catch (error) {
+            logger.error(`异常错误，${JSON.stringify(error)}`);
+            return ERROR_CODE.COMMOM_ERROR;
+        }
+    },
+
+    /**
+     * 备课
+     * @param {import('./render').ClassWindowType} prepareClassWindowProps
+     * @returns {number}
+     */
+    createPrepareClassWindow(prepareClassWindowProps) {
+        try {
+            return createClassWindow({
+                ...prepareClassWindowProps,
+                classOptions: {
+                    ...prepareClassWindowProps.classOptions,
+                    appType: 'prepareLessonSdk',
+                    meetingType: LESSON_TYPE.PREPARE_LESSONS,
+                    classType: LESSON_TYPE.PREPARE_LESSONS,
+                    userType: 'speaker',
+                    topic: prepareClassWindowProps.classOptions.topic ?? '备课课堂',
+                },
+            });
+        } catch (error) {
+            logger.error(`异常错误，${JSON.stringify(error)}`);
+            return ERROR_CODE.COMMOM_ERROR;
+        }
+    },
+
+    /**
+     * 获取 sdk 版本
+     */
+    getVersion,
+
+    /**
+     *初始化日志文件路径
+     * @param {string} logFilePath 日志文件路径
+     */
+    initLogConfig(logFilePath) {
+        if (logFilePath) {
+            logger.initLoggerFilePath(logFilePath);
+            require('electron')
+                .ipcRenderer //
+                .send(RENDER_TO_MAIN_MESG_TYPE.PLASO_INIT_LOG_PATH, logFilePath);
+        }
+    },
+
+    /**
+     * 插入的资源文件类型定义
+     */
+    FILE_TYPE,
+
+    /**
+     * 插入外部云盘里的文件，文件需要遵循特定的数据结构
+     * @param {import('./render').FileDataObj} fileData 文件数据
+     */
+    insertObject(fileData) {
+        try {
+            if (currentWebContentsId) {
+                window
+                    .require('electron')
+                    .ipcRenderer //
+                    .sendTo(currentWebContentsId, CLASS_WINDOW_MESG_TYPE.INSERT_OBJECT, fileData);
+            }
+        } catch (error) {
+            logger.error(`insertObject error is: ${JSON.stringify(error)}}`);
+            return ERROR_CODE.COMMOM_ERROR;
+        }
+    },
+
+    /**
+     * 更新严禁词列表
+     * @param {string[]} words 严禁词数组
+     */
+    updateProhibitedWords(words) {
+        try {
+            if (currentWebContentsId) {
+                window
+                    .require('electron')
+                    .ipcRenderer //
+                    .sendTo(currentWebContentsId, CLASS_WINDOW_MESG_TYPE.UPDATE_SENSITIVE_WORDS, words || []);
+            }
+        } catch (error) {
+            logger.error(`updateProhibitedWords error is: ${JSON.stringify(error)}}`);
+            return ERROR_CODE.COMMOM_ERROR;
+        }
+    },
+};