feat: 自动推送新版本

Author: TomyJan

CHANGELOG.md

@@ -1,3 +1,6 @@
+## [0.1.3-dev](https://github.com/TomyJan/Yunzai-Kuro-Plugin/compare/v0.1.2-rel...v0.1.3-dev) (2023-07-29)
+
+
 ## [0.1.2-rel](https://github.com/TomyJan/Yunzai-Kuro-Plugin/compare/v0.1.1-rel...v0.1.2-rel) (2023-07-28)
 
 

README.md

@@ -10,24 +10,46 @@
 
 > js真你妈难写, 操
 
-## 安装教程
-
-1. 下载插件压缩包, 解压至Yunzai `./plugin` 目录并重命名文件夹为 `Yunzai-Kuro-Plugin`
-
-   (推荐) 或通过 Git 在 Yunzai 根目录运行命令拉取插件: 
-   ```shell
-   git clone https://github.com/TomyJan/Yunzai-Kuro-Plugin.git ./plugins/Yunzai-Kuro-Plugin/
-   ```
-   
-   也可使用 Gitee 镜像(可能会滞后): 
-   ```shell
-   git clone https://gitee.com/TomyJan/Yunzai-Kuro-Plugin.git ./plugins/Yunzai-Kuro-Plugin/
-   ```
-   
-2. 安装依赖
-   ```shell
-   pnpm install
-   ```
+## 安装与维护
+
+### 安装插件
+
+插件更新强依赖 Git, 建议通过 Git 安装
+
+#### 通过 Git 安装
+
+在 Yunzai 根目录运行命令拉取插件: 
+```shell
+git clone https://github.com/TomyJan/Yunzai-Kuro-Plugin.git ./plugins/Yunzai-Kuro-Plugin/
+```
+
+也可使用 Gitee 镜像(可能会滞后): 
+```shell
+git clone https://gitee.com/TomyJan/Yunzai-Kuro-Plugin.git ./plugins/Yunzai-Kuro-Plugin/
+```
+
+#### 自行下载安装
+
+下载插件包, 解压至 Yunzai `./plugins` 目录内并重命名文件夹为 `Yunzai-Kuro-Plugin`
+
+### 安装依赖
+
+```shell
+pnpm install
+```
+### 更新插件
+
+如是通过 Git 安装, 在 Yunzai 根目录运行以下命令即可
+
+```shell
+git -C ./plugins/Yunzai-Kuro-Plugin/ pull
+```
+
+如为手动安装, 需要先备份插件用户数据目录, 删除插件并解压新的插件后, 再将插件用户数据目录恢复进去
+
+### 用户数据目录
+
+`./data` 为插件数据目录. 其中, `./data/system` 为插件系统数据, 不用理会, 其他目录和文件为插件的用户数据, 迁移/更新时备份这些目录即可
 
 ## 功能介绍
 
@@ -59,13 +81,25 @@
 
 - [x] 代码重构: 将所有fetch请求提取到一个方法
 - [ ] 代码重构: logger 套娃
+- [x] 检查更新通知
+- [ ] 部分项目可配置化, 适配锅巴
 
 ## 关于
 
+### 免责声明
+
+- 功能仅限内部交流与小范围使用，请勿将 Yunzai-Kuro-Plugin 用于以盈利为目的的场景
+- 图片与其他素材均来自于网络，仅供交流学习使用，如有侵权请联系处理
+
 ### 贡献/帮助
 
 [提交 issue](https://github.com/TomyJan/Yunzai-Kuro-Plugin/issues/new) | [提交 pr](https://github.com/TomyJan/Yunzai-Kuro-Plugin/compare)
 
+### 链接
+
+- [Miao-Yunzai](https://github.com/yoimiya-kokomi/Miao-Yunzai)
+- [Yunzai-Bot 索引库](https://gitee.com/yhArcadia/Yunzai-Bot-plugins-index)
+
 ### 致谢
 
 - [xiaoyao-cvs-plugin](https://github.com/ctrlcvs/xiaoyao-cvs-plugin) 插件部分代码来源

data/system/versionCache.json

@@ -0,0 +1 @@
+{}

index.js

@@ -1,8 +1,7 @@
 import chalk from 'chalk'
 import fs from 'node:fs'
-import schedule from 'node-schedule'
 import { appsPath, pluginVer } from './data/system/pluginConstants.js'
-import { gameSignTask, bbsDailyTask } from './model/autoTask.js'
+import initAutoTask from './model/autoTask.js'
 
 logger.info(chalk.rgb(253, 235, 255)('-----------(≧∇≦)ﾉ-----------'))
 logger.info(chalk.rgb(134, 142, 204)(`[库洛插件] V${pluginVer} 初始化中~`))
@@ -35,24 +34,6 @@ logger.info(chalk.rgb(134, 142, 204)(`[库洛插件] 载入模块完成!`))
 export { apps }
 
 logger.info(chalk.rgb(134, 142, 204)(`[库洛插件] 载入定时任务中...`))
-task()
-async function task() {
-  logger.info(
-    chalk.rgb(134, 142, 204)(`[库洛插件] 载入定时任务 gameSignTask:pns`)
-  )
-  schedule.scheduleJob('0 2 0 * * ? ', function () {
-    gameSignTask('pns')
-  })
-  logger.info(
-    chalk.rgb(134, 142, 204)(`[库洛插件] 载入定时任务 gameSignTask:mc`)
-  )
-  schedule.scheduleJob('0 2 0 * * ? ', function () {
-    gameSignTask('mc')
-  })
-  logger.info(chalk.rgb(134, 142, 204)(`[库洛插件] 载入定时任务 bbsDailyTask`))
-  schedule.scheduleJob('0 2 0 * * ? ', function () {
-    bbsDailyTask()
-  })
-}
+initAutoTask()
 
 logger.info(chalk.rgb(134, 142, 204)(`[库洛插件] 载入定时任务完成!`))

model/autoTask.js

@@ -1,11 +1,38 @@
+import chalk from 'chalk'
 import fs from 'node:fs'
+import schedule from 'node-schedule'
 import { doBBSDailyTask } from './bbsTask.js'
 import { doPnsSignIn } from './gameSignIn.js'
-import { dataPath } from '../data/system/pluginConstants.js'
+import { dataPath, pluginVer } from '../data/system/pluginConstants.js'
 import { getRandomInt, sendMsgFriend, sleepAsync } from './utils.js'
 import { getToken } from '../model/kuroBBSTokenHandler.js'
+import cfg from '../../../lib/config/config.js'
 
-export async function gameSignTask(gameName) {
+export default async function initAutoTask() {
+  logger.info(
+    chalk.rgb(134, 142, 204)(`[库洛插件] 载入定时任务 gameSignTask:pns`)
+  )
+  schedule.scheduleJob('0 2 0 * * ? ', function () {
+    gameSignTask('pns')
+  })
+  logger.info(
+    chalk.rgb(134, 142, 204)(`[库洛插件] 载入定时任务 gameSignTask:mc`)
+  )
+  schedule.scheduleJob('0 2 0 * * ? ', function () {
+    gameSignTask('mc')
+  })
+  logger.info(chalk.rgb(134, 142, 204)(`[库洛插件] 载入定时任务 bbsDailyTask`))
+  schedule.scheduleJob('0 2 0 * * ? ', function () {
+    bbsDailyTask()
+  })
+
+  logger.info(chalk.rgb(134, 142, 204)(`[库洛插件] 载入定时任务 checkUpdateTask`))
+  schedule.scheduleJob('0 0 6/12 * * ? ', function () {
+    checkUpdateTask()
+  })
+}
+
+async function gameSignTask(gameName) {
   if (!gameName || (gameName !== 'pns' && gameName !== 'mc')) {
     logger.error(`[库洛插件] 自动游戏签到: 游戏 ${gameName} 未定义!`)
     return false
@@ -45,7 +72,7 @@ export async function gameSignTask(gameName) {
   }
 }
 
-export async function bbsDailyTask() {
+async function bbsDailyTask() {
   logger.info(`[库洛插件] 自动社区游戏签到开始...`)
 
   const gameSignUins = fs
@@ -74,3 +101,64 @@ export async function bbsDailyTask() {
   logger.info(`[库洛插件] 自动社区签到: 任务完成`)
   return true
 }
+
+async function checkUpdateTask() {
+  logger.info(`[库洛插件] 检查更新任务开始...`)
+  let remoteVersion = await getRemoteVersion('GitHub')
+  if (!remoteVersion) {
+    remoteVersion = await getRemoteVersion('GHProxy')
+    if (!remoteVersion) {
+      logger.warn(`[库洛插件] 检查更新任务失败`)
+      await sendMsgFriend(cfg.masterQQ[0], `[库洛插件]自动检查更新失败!`)
+      return false
+    }
+  }
+  logger.info(`[库洛插件] 检查更新任务: 获取到最新版本 ${remoteVersion}, 本地版本 ${pluginVer}`)
+  if (remoteVersion != pluginVer) {
+    // 推送并缓存
+    const cacheFilePath = '../data/system/versionCache.json'
+    let versionCache = ''
+    fs.readFile(cacheFilePath, 'utf8', (err, data) => {
+      if (err) {
+        logger.error('读取 versionCache.json 时出现错误：', err.message);
+      } else {
+        versionCache = data;
+        logger.mark('versionCache: ', versionCache);
+      }
+    });
+    if (versionCache?.remoteVersion == remoteVersion) {
+      // 已经推送过了
+      return false
+    }
+    versionCache = {remoteVersion: remoteVersion}
+    let isCacheSucceed = false
+
+    fs.writeFile(cacheFilePath, versionCache, (err) => {
+      if (err) {
+        logger.error('写入versionCache.json 时出现错误: ', err.message);
+      } else {
+        logger.mark('缓存远程版本成功!');
+        isCacheSucceed = true
+      }
+    });
+    await sendMsgFriend(cfg.masterQQ[0], `[库洛插件]自动检查更新\n发现新版本: ${remoteVersion}, 本地版本 ${pluginVer}` + (isCacheSucceed ? '' : '\n缓存版本信息失败, 该信息可能会重复推送'))
+
+  }
+
+  async function getRemoteVersion(type) {
+    let checkUrl = 'https://github.com/TomyJan/Yunzai-Kuro-Plugin/raw/master/CHANGELOG.md'
+    if (type == 'GHProxy') checkUrl = 'https://ghproxy.com/' + checkUrl
+    try {
+      let rsp = await fetch(checkUrl)
+      if (!rsp.ok) {
+        logger.warn(`[库洛插件] 从 ${type} 检查更新失败: ${rsp.status} ${rsp.statusText}`)
+        return false
+      }
+      return await rsp.text()
+    } catch (error) {
+      logger.warn(`[库洛插件] 从 ${type} 检查更新失败: ${error.message}`)
+      return false
+    }
+  }
+  
+}

package.json

@@ -1,6 +1,6 @@
 {
   "name": "Yunzai-Kuro-Plugin",
-  "version": "0.1.2-rel",
+  "version": "0.1.3-dev",
   "author": "TomyJan",
   "description": "Yunzai-Bot plugin for kuro games.",
   "type": "module",