@plasosdk/plaso-electron-sdk 1.3.7 → 1.3.8-beta.1

package/README.md

@@ -1,14 +1,29 @@
 # Plaso SDK for Electron
 
-## 🖥 环境支持
-
-- 🌈 支持 MacOS x86-64 和 arm64
-- ⚙️ 支持 Windows ia32 和 x64
-- [Electron](https://www.electronjs.org/): 14.0.0~22.3.27
-
-| MacOS | Windows | Electron |
-| --- | --- | --- |
-| x86 \| arm64 | ia32 \| x64 | 14.0.0~22.3.27                                                                        
+## 目录
+
+<!-- toc -->
+- [环境支持](#环境支持)
+- [安装](#安装)
+- [electron-builder打包特别说明](#electron-builder打包特别说明)
+- [使用](#使用)
+  - [在主进程中使用](#在主进程中使用)
+  - [在渲染进程中使用](#在渲染进程中使用)
+    - [打开实时课堂](#打开实时课堂)
+    - [打开备课课堂](#打开备课课堂)
+    - [打开实时课堂/备课课堂通用参数说明](#打开实时课堂备课课堂通用参数说明)
+    - [API参考](#api参考)
+- [资料中心](#资料中心)
+- [播放历史课堂](#播放历史课堂)
+- [注意点](#注意点)
+- [Q&A](#qa)
+<!-- tocstop -->
+
+## 环境支持
+
+- MacOS：x86-64、arm64
+- Windows：ia32、x64
+- Electron：14.0.0~22.3.27
 
 ## 安装
 
@@ -128,7 +143,8 @@ interface CreateClassWindowPamras {
         callback: (result: boolean) => void,
     ) => void;
     onOpenResourceCenterFn?: () => void;
-    onGetExtFileNameFn?: (...args: any[]) => Promise<string>;
+    onGetExtFileNameFn?: (info: any[], ...args: any[]) => Promise<string>;
+    onGetPreParseFileNameFn?: (info: any[], option: { suffix: string }) => Promise<string>;
 }
 ```
 
@@ -422,7 +438,16 @@ type onOpenResourceCenterFn = () => void;
 // 通过 insertObject 插入的文件传入 参数 info 时，怎么从info中获取文件的可访问地址的逻辑在用户那，所以需要函数从外部用户获取外部用户传入的文件地址
 // 其中info会作为args中的第一个参数回传
 
-type onGetExtFileNameFn = (...args: any[]) => Promise<string>;
+type onGetExtFileNameFn = (info: any, ...args: any[]) => Promise<string>;
+```
+
+##### onGetPreParseFileNameFn
+```ts
+// 通过 insertObject 插入的文件传入 参数 info 时，如果该资源是预解析资源，SDK需要访问解析后的文件
+// 其中info会作为args中的第一个参数回传
+// 预解析结果是一个文件夹，要访问文件夹里的哪个文件，会通过suffix指出，如/index.html、/pre1.jpg等
+
+type onGetPreParseFileNameFn = (info: any, option: { suffix: string }) => Promise<string>;
 ```
 
 #### API参考
@@ -449,21 +474,169 @@ PlasoElectronSdk.initLogConfig(logDir);
 ```
 
 > 重要：用户需要对日志目录做定期清理和及时上传日志到自己的服务器或OSS。推荐在退出SDK后做一次清理和上传，建议清理创建时间超过7天的日志即可。
-清理日志代码示例如下：
-```ts
-function clearExpireLog() {
-    // logDir为日志目录，即initLogConfig方法设置的路径或者SDK默认路径
-    const fs = require('fs');
-    const path = require('path');
-    const logFile = fs
-        .readdirSync(logDir)
-        .filter((fileName) => /\.(log|dmp)/.test(path.extname(fileName)));
-    logFile.forEach((fileName) => {
-        const fileInfo = fs.statSync(path.join(logDir, fileName));
-        const fileDate = new Date(fileInfo.birthtime).setHours(0, 0, 0, 0).valueOf();
-        const currentDate = new Date().setHours(0, 0, 0, 0);
-        if (currentDate - fileDate > 7 * 24 * 60 * 60 * 1000) {
-            fs.unlinkSync(path.join(logDir, fileName));
+相关代码示例如下：
+```ts
+import fs from 'fs';
+import path from 'path';
+
+/**
+ * 清理创建时间超过7天的日志
+ * @param logDir 日志目录
+ */
+function clearExpireLogs(logDir: string) {
+    try {
+        const logFile = fs.readdirSync(logDir).filter((fileName) => /\.(log|dmp|ips|diag)/.test(path.extname(fileName)));
+        logFile.forEach((fileName) => {
+            const fileInfo = fs.statSync(path.join(logDir, fileName));
+            const fileDate = new Date(fileInfo.birthtime).setHours(0, 0, 0, 0).valueOf();
+            const currentDate = new Date().setHours(0, 0, 0, 0);
+            if (currentDate - fileDate > 7 * 24 * 60 * 60 * 1000) {
+                fs.unlinkSync(path.join(logDir, fileName));
+            }
+        });
+    } catch (e) {
+        console.error('clear expire log error', e);
+    }
+}
+
+/**
+ * 收集崩溃日志
+ * @param logDir 日志目录
+ * @param pendingUploadDir 待上传目录
+ */
+function collectCrashLogs(logDir: string, pendingUploadDir: string) {
+    const platform = require('os').platform();
+    switch (platform) {
+        case 'darwin':
+            const newDumpFolder = path.join(logDir, '/new/');
+            const pendingDumpFolder = path.join(logDir, '/pending/');
+            const completedDumpFolder = path.join(logDir, '/completed/');
+            const diagnosticReports = path.normalize('/Library/Logs/DiagnosticReports');
+            collectDumpFiles(newDumpFolder);
+            collectDumpFiles(pendingDumpFolder);
+            collectDumpFiles(completedDumpFolder);
+            collectSystemLogs(diagnosticReports);
+            break;
+        case 'win32':
+            const reportsDumpFolder = path.join(logDir, '/reports/');
+            collectDumpFiles(reportsDumpFolder);
+            break;
+        default:
+            break;
+    }
+
+    function collectSystemLogs(folder: string) {
+        try {
+            const files = fs.readdirSync(folder);
+            const todayDate = new Date();
+            const formatDate = `${todayDate.getFullYear()}-${(todayDate.getMonth() + 1).toString().padStart(2, '0')}-${todayDate
+                .getDate()
+                .toString()
+                .padStart(2, '0')}`;
+            files.forEach((name) => {
+                const reg = new RegExp(`Electron Helper.*${formatDate}`);
+                if (name && name.match(reg)) {
+                    fs.copyFileSync(path.join(folder, name), path.join(pendingUploadDir, name));
+                }
+            });
+        } catch (e) {
+            console.error(e);
+        }
+    }
+
+    function collectDumpFiles(folder: string) {
+        try {
+            const files = fs.readdirSync(folder);
+            files.forEach((name) => {
+                if (name) {
+                    fs.copyFileSync(path.join(folder, name), path.join(pendingUploadDir, name));
+                    fs.unlinkSync(path.join(folder, name));
+                }
+            });
+        } catch (e) {
+            console.error(e);
+        }
+    }
+}
+
+/**
+ * 收集业务日志
+ * @param logDir 日志目录
+ * @param pendingUploadDir 待上传目录
+ */
+function collectBussinessLogs(logDir: string, pendingUploadDir: string) {
+    const logFiles = fs.readdirSync(logDir).filter((fileName) => /\.(log|dmp|ips|diag)/.test(path.extname(fileName)));
+    logFiles.forEach((fileName) => {
+        fs.copyFileSync(path.join(logDir, fileName), path.join(pendingUploadDir, fileName));
+    });
+}
+
+/**
+ * 收集日志
+ * @param logDir 日志目录
+ * @param pendingUploadDir 待上传目录
+ */
+function collectLogs(logDir: string, pendingUploadDir: string) {
+    collectCrashLogs(logDir, pendingUploadDir);
+    collectBussinessLogs(logDir, pendingUploadDir);
+}
+
+/**
+ * 压缩日志
+ * @param pendingUploadDir 待上传目录
+ */
+function zipLogs(pendingUploadDir: string): Promise<string> {
+    return new Promise((resolve) => {
+        const zipLogPath = path.join(pendingUploadDir, 'xxx.zip'); // 这边的xxx.zip取名时建议将用户名以及上传时间拼接上去，方便查询
+        // TODO: 这边做压缩，压缩完毕后将zip文件路径返回
+        resolve(zipLogPath);
+    });
+}
+
+/**
+ * 上传日志到服务器
+ * @param filePath zip文件路径
+ */
+function uploadToServer(filePath: string): Promise<boolean> {
+    return new Promise((resolve) => {
+        // TODO: 这边做上传
+        resolve(true);
+    });
+}
+
+/**
+ * 上传日志
+ * @param logDir 日志目录
+ */
+export function uploadLogs(logDir: string): Promise<boolean> {
+    return new Promise(async (resolve) => {
+        try {
+            // 上传前先清理过期的日志，避免垃圾日志太多
+            clearExpireLogs(logDir);
+
+            // 创建待上传目录
+            const pendingUploadDir = path.join(logDir, 'pendingUpload');
+            if (fs.existsSync(pendingUploadDir)) {
+                fs.rmdirSync(pendingUploadDir, { recursive: true });
+            }
+            fs.mkdirSync(pendingUploadDir);
+
+            // 将日志复制到待上传目录
+            collectLogs(logDir, pendingUploadDir);
+
+            // 压缩待上传目录
+            const zipName = await zipLogs(pendingUploadDir);
+
+            // 将压缩后的日志上传到服务器
+            await uploadToServer(zipName);
+
+            // 上传完成后删除临时文件
+            fs.unlinkSync(zipName);
+            fs.rmdirSync(pendingUploadDir, { recursive: true });
+
+            resolve(true);
+        } catch (error) {
+            resolve(false);
         }
     });
 }
@@ -517,6 +690,8 @@ const enum FILE_TYPE {
     DOC,
     /** 这种模式传入真实EXCEL地址 */
     XLS,
+    /** 预解析PPT */
+    ISPRINGPPT,
     /** 备课文件 */
     PREPARE_LESSONS,
 };
@@ -535,6 +710,9 @@ interface IFileData {
     /** 访问权限为公开的全地址，建议使用https协议的全地址，传入`info`时会忽略该属性 */
     url?: string;
 
+    /** 预解析结果的页数（插入预解析PDF/DOC/XLS时要传入这个属性） */
+    totalPages?: number;
+
     /**
      * 当用户插入的文件有签名时效时需要以info属性插入文件，这种方式需要配合onGetExtFileNameFn回调使用。
      * `info`的值由SDK用户自行决定，SDK内部会把`info`作为onGetExtFileNameFn回调函数的参数传入，由SDK用户
@@ -605,6 +783,18 @@ const fileDataWithUrl = {
 };
 ```
 
+###### 插入预解析PPT
+
+```ts
+// 预解析PPT仅支持info插入
+
+const fileDataWithInfo = {
+    type: PlasoElectronSdk.FILE_TYPE.ISPRINGPPT,
+    title: 'xxx',
+	info: ['xxx', ...],
+};
+```
+
 ###### 插入音视频
 
 ```ts
@@ -641,6 +831,17 @@ const fileDataWithInfo = {
 }
 ```
 
+###### 插入预解析PDF
+```ts
+// 预解析PDF仅支持info接入，且需要传入totalPages总页数
+
+const fileDataWithInfo = {
+	type: PlasoElectronSdk.FILE_TYPE.PDF,
+	title: 'xxx',
+	info: ['xxx', ...],
+    totalPages: 12,
+}
+```
 
 ###### 插入WORD/EXCEL/DOC/XLS
 
@@ -654,6 +855,19 @@ const fileDataWithUrl = {
 }
 ```
 
+###### 插入预解析DOC/XLS
+
+```ts
+// 预解析DOC/XLS仅支持info插入，且需要传入totalPages总页数
+
+const fileDataWithInfo = {
+	type: PlasoElectronSdk.FILE_TYPE/.DOC/.XLS,
+	title: 'xxx',
+	info: ['xxx', ...],
+    totalPages: 12,
+}
+```
+
 ## 资料中心
 
 step1、进课堂时，对象 **classOptions.supportShowResourceCenter** 需要是 true
@@ -662,7 +876,9 @@ step2、在课堂内点击资料中心后，会触发进课堂时传入的回调
 
 step3、选择文件后，通过 **PlasoElectronSdk.insertObject** 方法插入文件,方法入参参考 [insertObject](#insert-object) 说明
 
-step4、insertObject 方法 入参 有 info 时，此时 会触发进课堂时传入的回调函数 **onGetExtFileNameFn** 来获取文件的全地址
+step4.1、insertObject 方法 入参 有 info 时，此时 会触发进课堂时传入的回调函数 **onGetExtFileNameFn** 来获取文件的全地址
+
+step4.2、insertObject 方法插入的如果是预解析资源，那么就会触发回调 **onGetPreParseFileNameFn** 来获取解析后资源的全地址
 
 ## 播放历史课堂
 
@@ -670,6 +886,8 @@ step4、insertObject 方法 入参 有 info 时，此时 会触发进课堂时
 
 2、当课堂中insertObject使用了`info`属性时，SDK内部需要外部传入`getExtFileName`，因此历史课堂需要使用jssdk的接入方式， 详见：**[Web播放器-jssdk接入](https://open.plaso.cn/doc-6285192#jssdk%E6%8E%A5%E5%85%A5)**
 
+3、当课堂中insertObject插入了预解析资源时，SDK内部需要外部传入`getPreParseFileName`，因此历史课堂需要使用jssdk的接入方式，同上。
+
 ## 注意点
 
 （1）用户的课堂外主窗口销毁时需要销毁课堂窗口
@@ -677,3 +895,10 @@ step4、insertObject 方法 入参 有 info 时，此时 会触发进课堂时
 （2）**基于 此包封装新包时**：注意 @electron/remote 这个包的位置需要 和新包处于同级目录，需要把 和该包同级的@electron/remote 移到新包的同级目录处
 
 （3）确保 仅最后的 node_moudles 的顶层有 @electron/remote
+
+## Q&A
+
+### 进课堂遇到闪退/崩溃怎么办？
+- 检查应用程序路径中是否存在中文，路径中不应出现中文</br>
+可通过在主进程中，用`console.log(require.resolve('@plasosdk/plaso-electron-sdk'))`来检查路径
+- 如果是Mac，进课堂会需要麦克风权限。打开系统设置->隐私与安全性->麦克风，查看列表里你的应用程序是否被授权。

package/js/macro.js

@@ -42,6 +42,10 @@ const CLASS_WINDOW_MESG_TYPE = {
     GET_EXT_FILE_NAME: 'getExtFileName',
     /** 响应getExtFileName */
     RESP_GET_EXT_FILE_NAME: 'respGetExtFileName',
+    /** 通知外部调用getPreParseFileName */
+    GET_PRE_PARSE_FILE_NAME: 'getPreParseFileName',
+    /** 响应getPreParseFileName */
+    RESP_GET_PRE_PARSE_FILE_NAME: 'respGetPreParseFileName',
 };
 
 const LEVEL = {
@@ -68,6 +72,7 @@ const FILE_TYPE = {
     VIDEO: 7,
     DOC: 14,
     XLS: 15,
+    ISPRINGPPT: 21,
     PREPARE_LESSONS: 22,
 };
 

package/js/render.js

@@ -46,7 +46,8 @@ let currentWebContentsId = null;
  *   callback: (result: boolean) => void
  * ) => void} [onSaveBoardFn] 保存板书，具体的保存逻辑由外部实现，取消保存板书时，callback传false, 不然传true
  * @property {()=>void} [onOpenResourceCenterFn] 通知外部用户打开自己的资料中心，资料中心的具体ui和逻辑由外部用户自己实现
- * @property {(...args: any[])=>Promise<string>} [onGetExtFileNameFn] 通过insertObject插入的文件传入 参数 info 时，怎么从info中获取文件的可访问地址的逻辑在用户那，所以需要函数从外部用户获取外部用户传入的文件地址
+ * @property {(info: any, option: any)=>Promise<string>} [onGetExtFileNameFn] 通过insertObject插入的文件传入 参数 info 时，怎么从info中获取文件的可访问地址的逻辑在用户那，所以需要函数从外部用户获取外部用户传入的文件地址
+ * @property {(info: any, option: { suffix: string })=>Promise<string>} [onGetPreParseFileNameFn] 类似onGetExtFileNameFn，只是获取的文件地址是预解析文件地址，通过suffix得到预解析文件路径
  *
  */
 
@@ -64,10 +65,11 @@ function createClassWindow(classWindowProps) {
         onSaveBoardFn,
         onOpenResourceCenterFn,
         onGetExtFileNameFn,
+        onGetPreParseFileNameFn,
     } = classWindowProps;
 
     logger.info(
-        `课堂窗口创建信息: classOptions is ${JSON.stringify(classOptions)},electronWinOptions is ${JSON.stringify(
+        `课堂窗口创建信息: version is ${getVersion()}, classOptions is ${JSON.stringify(classOptions)},electronWinOptions is ${JSON.stringify(
             electronWinOptions,
         )}`,
     );
@@ -258,12 +260,22 @@ function createClassWindow(classWindowProps) {
                     }
                 };
 
+                const onGetPreParseFileName = async (event, requestId, ...args) => {
+                    if (onGetPreParseFileNameFn && args.length > 0) {
+                        const url = await onGetPreParseFileNameFn(...args);
+                        if (url) {
+                            ipcRenderer.sendTo(currentWebContentsId, CLASS_WINDOW_MESG_TYPE.RESP_GET_PRE_PARSE_FILE_NAME, requestId, url);
+                        }
+                    }
+                };
+
                 ipcRenderer.on(CLASS_WINDOW_MESG_TYPE.LIVE_WINDOW_READY, onClassWindowReady);
                 ipcRenderer.on(CLASS_WINDOW_MESG_TYPE.ON_CLASS_FINISHED, onClassFinished);
                 ipcRenderer.on(CLASS_WINDOW_MESG_TYPE.HTML_READY, onHtmlReady);
                 ipcRenderer.on(CLASS_WINDOW_MESG_TYPE.SAVE_BOARD, onSaveBoard);
                 ipcRenderer.on(CLASS_WINDOW_MESG_TYPE.OPEN_RESOURCE_CENTER, onOpenResourceCenter);
                 ipcRenderer.on(CLASS_WINDOW_MESG_TYPE.GET_EXT_FILE_NAME, onGetExtFileName);
+                ipcRenderer.on(CLASS_WINDOW_MESG_TYPE.GET_PRE_PARSE_FILE_NAME, onGetPreParseFileName);
 
                 const url = require('url');
                 const htmlPath =
@@ -297,6 +309,7 @@ function createClassWindow(classWindowProps) {
                             ipcRenderer.removeListener(CLASS_WINDOW_MESG_TYPE.SAVE_BOARD, onSaveBoard);
                             ipcRenderer.removeListener(CLASS_WINDOW_MESG_TYPE.OPEN_RESOURCE_CENTER, onOpenResourceCenter);
                             ipcRenderer.removeListener(CLASS_WINDOW_MESG_TYPE.GET_EXT_FILE_NAME, onGetExtFileName);
+                            ipcRenderer.removeListener(CLASS_WINDOW_MESG_TYPE.GET_PRE_PARSE_FILE_NAME, onGetPreParseFileName);
                         });
                     },
                 );

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@plasosdk/plaso-electron-sdk",
-  "version": "1.3.7",
+  "version": "1.3.8-beta.1",
   "description": "伯索课堂Electron SDK",
   "main": "index.js",
   "scripts": {
@@ -14,6 +14,9 @@
     "electron",
     "classroom"
   ],
+  "peerDependencies": {
+    "@electron/remote": "^2.1.2"
+  },
   "dependencies": {
     "@plasosdk/screenshot": "^1.3.4",
     "@plasosdk/winproxy": "^1.1.5",