alemonjs 1.0.28 → 1.0.30

package/README.md

@@ -1,33 +1,26 @@
 ☞[English document](./README_English.md)
 
-## Almeon 阿柠檬跨平台开发框架机器人
-
-> 支持 NtQQ、QQ 频道、Discord、米游社大别野、KOOK
-
-| 分支  | 类型   | 说明                 |
-| ----- | ------ | -------------------- |
-| main  | 核心   | 机器实例             |
-| redis | 数据库 | 特殊连接独立         |
-| cli   | 脚手架 | 开发模板脚手架       |
-| web   | 网站   | 共享平台插件贡献地址 |
+## 阿柠檬跨平台开发框架机器人
 
 > 需要配置机器人才可启动
 
-文档查看 OPEN[alemonjs.com](https://alemonjs.com)
+开发文档 OPEN[https://alemonjs.com](https://alemonjs.com)
 
-开发模板 GITEE[create-alemonjs](https://gitee.com/ningmengchongshui/alemon/tree/cli/bin/template)
+类型/接口 OPEN[docs](https://ningmengchongshui.github.io/alemon/)
 
-开发模板 GITHUB[create-alemonjs](https://github.com/ningmengchongshui/alemon/tree/cli/bin/template)
+开发模板 GITEE[create-alemonjs](https://gitee.com/ningmengchongshui/alemon/tree/cli/bin)
 
-### 共享平台
+开发模板 GITHUB[create-alemonjs](https://github.com/ningmengchongshui/alemon/tree/cli/bin)
 
-> 仓库只做资源收集,对齐安全性不做任何检查,请谨慎选择
+### 共享平台
 
 贡献资源 OPEN[Gitee](https://gitee.com/ningmengchongshui/alemon/blob/web/docs/about/plugins.md)
 
 贡献资源 OPEN[Github](https://gitee.com/ningmengchongshui/alemon/blob/web/docs/about/plugins.md)
 
-> 仅限签署开源协议的仓库、不开源将不做考虑范围内
+- 仓库只做资源收集,对齐安全性不做任何检查,请谨慎选择
+
+- 仅限签署开源协议的仓库、不开源将不做考虑范围内
 
 ## 开源协议
 

package/lib/config/login.js

@@ -2,7 +2,6 @@ import redis from '../default/redis.js';
 import mysql from '../default/mysql.js';
 import server from '../default/server.js';
 import puppeteer from '../default/pup.js';
-import discord from '../discord/discord.js';
 import kook from '../kook/kook.js';
 import villa from '../villa/villa.js';
 import qq from '../qq/qq.js';
@@ -15,7 +14,6 @@ import ntqq from '../ntqq/ntqq.js';
 const config = {
     redis,
     mysql,
-    discord,
     kook,
     villa,
     qq,
@@ -24,41 +22,9 @@ const config = {
     puppeteer
 };
 /**
- * init config
- * @param val
- */
-export function setBotConfig(val) {
-    // 分布覆盖
-    for (const i in val) {
-        // 当且仅当存在同key的时候才会覆盖默认配置
-        if (Object.prototype.hasOwnProperty.call(config, i)) {
-            if (i == 'puppeteer') {
-                // pup 不用检查 直接覆盖
-                for (const j in val[i]) {
-                    config[i][j] = val[i][j];
-                }
-            }
-            else {
-                for (const j in val[i]) {
-                    // 当前仅当同属性名的时候才会覆盖默认配置
-                    if (Object.prototype.hasOwnProperty.call(config[i], j)) {
-                        config[i][j] = val[i][j];
-                    }
-                    else {
-                        console.info('[alemonjs][存在无效参数]', val[i]);
-                    }
-                }
-            }
-        }
-        else {
-            console.info('[alemonjs][存在无效参数]', val[i]);
-        }
-    }
-}
-/**
- * set
- * @param key
- * @param val
+ * 设置机器人基础配置
+ * @param key 配置名
+ * @param val 配置值
  */
 export function setBotConfigByKey(key, val) {
     if (key == 'puppeteer') {
@@ -74,15 +40,22 @@ export function setBotConfigByKey(key, val) {
                 config[key][item] = val[item];
             }
             else {
-                console.info('[alemonjs][存在无效参数]', val[item]);
+                try {
+                    config[key] = {};
+                    config[key] = val[item];
+                    console.info('[alemonjs][新增KEY成功]');
+                }
+                catch {
+                    console.info('[alemonjs][新增KEY失败]');
+                }
             }
         }
     }
 }
 /**
- * get
- * @param key
- * @returns
+ * g得到机器人基础配置
+ * @param key 配置名
+ * @returns 得到配置值
  */
 export function getBotConfigByKey(key) {
     return config[key];

package/lib/config/pup.js

@@ -60,7 +60,9 @@ else if (platform == 'linux' || platform == 'android') {
     }
 }
 /**
+ * 得到pup可寻地址
  * @type {import("puppeteer").Configuration}
+ * @returns 得到配置对象
  */
 export function getPupPath() {
     return {

package/lib/core/app.js

@@ -3,7 +3,7 @@ const APP = {};
 /**
  * 得到应用
  * @param key 插件名
- * @returns
+ * @returns 得到应用集
  */
 export function getApp(key) {
     return APP[key];
@@ -27,7 +27,7 @@ export function delApp(key) {
 }
 /**
  * 得到应用
- * @returns
+ * @returns 得到指定应用值
  */
 export function getAppKey() {
     const arr = [];

package/lib/core/apps.js

@@ -4,16 +4,16 @@ import { setMessage } from './message.js';
 import { setApp } from './app.js';
 /**
  * 得到执行路径
- * @param url
- * @returns
+ * @param url  import.meta.url
+ * @returns AppName目录名
  */
 export function getAppPath(url) {
     return dirname(fileURLToPath(url)).replace(/\\/g, '/');
 }
 /**
  * 得到执行目录
- * @param {} url
- * @returns
+ * @param {} url import.meta.url
+ * @returns AppName目录名
  */
 export function getAppName(url) {
     return basename(getAppPath(url));
@@ -21,15 +21,15 @@ export function getAppName(url) {
 /**
  * 创建应用对象
  * @param url import.meta.url
- * @returns
+ * @returns AppName目录名
  */
 export function createApps(url) {
     return createApp(getAppName(url));
 }
 /**
  * 创建应用对象
- * @param AppName
- * @returns
+ * @param AppName 目录名 getAppName(import.meta.url)
+ * @returns 应用app对象
  */
 export function createApp(AppName) {
     /**
@@ -43,8 +43,8 @@ export function createApp(AppName) {
     return {
         /**
          * 重定义消息
-         * @param fnc
-         * @returns
+         * @param fnc 回调函数
+         * @returns 是否成功定义
          */
         setMessage: (fnc) => {
             try {
@@ -106,7 +106,6 @@ export function createApp(AppName) {
         },
         /**
          * 挂起应用
-         * @returns
          */
         mount: () => {
             try {

package/lib/core/buffer.js

@@ -4,8 +4,8 @@ import https from 'https';
 import { join } from 'path';
 /**
  * 异步请求图片
- * @param url
- * @returns
+ * @param url 网络地址
+ * @returns buffer
  */
 export function getUrlbuffer(url) {
     return new Promise((resolve, reject) => {
@@ -26,8 +26,8 @@ export function getUrlbuffer(url) {
 }
 /**
  * 读取本地图片
- * @param path 根路径
- * @returns
+ * @param path 本地地址 /public/img/xx.png
+ * @returns buffer
  */
 export function getPathBuffer(path) {
     // 读取本地图片

package/lib/core/configs.js

@@ -1,3 +1,8 @@
+/**
+ * ***********
+ * 插件解析配置
+ * ***********
+ */
 const ApplicationProcessingConfiguration = {
     dir: '/application',
     main: '/index',
@@ -7,12 +12,22 @@ const ApplicationProcessingConfiguration = {
     route: '/public/defset',
     regex: true
 };
+/**
+ * 设置插件解析配置
+ * @param key 配置名
+ * @param val 配置值
+ */
 export function setAppProCoinfg(key, val) {
     // 当前仅当同属性名的时候才会覆盖默认配置
     if (Object.prototype.hasOwnProperty.call(ApplicationProcessingConfiguration, key)) {
         ApplicationProcessingConfiguration[key] = val;
     }
 }
+/**
+ * 得到插件解析配置
+ * @param key 配置名
+ * @returns 配置值
+ */
 export function getAppProCoinfg(key) {
     return ApplicationProcessingConfiguration[key];
 }

package/lib/core/dealmsg.js

@@ -9,6 +9,7 @@ import { conversationHandlers, getConversationState } from './dialogue.js';
 import { getAppProCoinfg } from './configs.js';
 const Command = {};
 const CommandNotMessage = {};
+const CommandApp = {};
 /**
  * 机器人统计
  */
@@ -18,7 +19,7 @@ let mergedRegex;
 /**
  * 得到机器人帮助
  * @param AppName
- * @returns
+ * @returns 指令对象
  */
 export function getPluginHelp(AppName) {
     const c = getAppProCoinfg('regex');
@@ -63,8 +64,8 @@ function createPluginHelp() {
 }
 /**
  * 应用挂载
- * @param AppsObj
- * @param appname
+ * @param AppsObj 插件集成对象
+ * @param appname 插件名
  */
 async function synthesis(AppsObj, appname) {
     // 没有记载
@@ -72,6 +73,7 @@ async function synthesis(AppsObj, appname) {
         plugins[appname] = [];
     }
     for (const item in AppsObj) {
+        // 解析class
         const keys = new AppsObj[item]();
         // 控制类型
         const eventType = keys['eventType'] ?? 'CREATE';
@@ -81,6 +83,25 @@ async function synthesis(AppsObj, appname) {
             keys['rule'].length == 0) {
             continue;
         }
+        /**
+         * 收藏app
+         */
+        let x = 1;
+        let itemX = item;
+        const T = true;
+        while (T) {
+            // 名字不重复
+            if (!Object.prototype.hasOwnProperty.call(CommandApp, itemX)) {
+                break;
+            }
+            // 同名了 需要重命名
+            itemX = `${item}${x}`;
+            x++;
+        }
+        CommandApp[itemX] = {
+            name: appname,
+            APP: AppsObj[item]
+        };
         // 指令不存在
         for await (const key of keys['rule']) {
             if (!key['fnc'] ||
@@ -93,8 +114,6 @@ async function synthesis(AppsObj, appname) {
             const priority = key['priority'] ?? keys['priority'] ?? 9000;
             // 得到函数名
             const fncName = key['fnc'];
-            // 得到函数
-            const fnc = keys[fncName];
             const doc = key['doc'] ?? '';
             const dsc = key['dsc'] ?? '';
             // 如果类型正确
@@ -103,6 +122,8 @@ async function synthesis(AppsObj, appname) {
                 const event = 'MESSAGES';
                 // 得到解析
                 const reg = key['reg'];
+                if (!reg)
+                    continue;
                 // 推送
                 plugins[appname].push({
                     event: event,
@@ -119,8 +140,7 @@ async function synthesis(AppsObj, appname) {
                     reg: new RegExp(reg),
                     priority,
                     fncName,
-                    fnc,
-                    AppName: appname
+                    APP: itemX
                 });
             }
             else {
@@ -139,9 +159,9 @@ async function synthesis(AppsObj, appname) {
                     event: event,
                     eventType: eventType,
                     priority,
+                    reg: /./,
                     fncName,
-                    fnc,
-                    AppName: appname
+                    APP: itemX
                 });
             }
         }
@@ -150,7 +170,7 @@ async function synthesis(AppsObj, appname) {
 }
 /**
  * 加载应用插件
- * @param dir
+ * @param dir 插件路径
  */
 async function loadPlugins(dir) {
     if (!existsSync(dir))
@@ -169,9 +189,7 @@ async function loadPlugins(dir) {
             return true;
         return !close.test(item);
     });
-    /**
-     * 动态扫描
-     */
+    //动态扫描
     const main = getAppProCoinfg('main');
     const type = getAppProCoinfg('type');
     for await (const appname of apps) {
@@ -189,17 +207,21 @@ async function loadPlugins(dir) {
  * 初始化应用
  */
 function dataInit() {
+    // 清事件
     for (const item of EventEnum) {
         if (isNaN(Number(item))) {
             Command[item] = [];
             CommandNotMessage[item] = [];
         }
     }
+    // 清class
+    for (const item in CommandApp) {
+        delete CommandApp[item];
+    }
     return;
 }
 /**
- * 应用初始化
- * @returns
+ * 插件初始化
  */
 export async function appsInit() {
     // 清空当前的apps
@@ -236,83 +258,112 @@ export async function appsInit() {
     createPluginHelp();
     // 打印
     console.info(`[LOAD] APPS*${Object.keys(plugins).length} `);
-    return;
 }
 /**
- * 得到大正则
- * @returns
+ * 得到指令大正则
+ * @returns 正则
  */
 export function getMergedRegex() {
     return mergedRegex;
 }
 /**
- * 初始化应用
- * @returns
+ * 扫描插件
  */
 export async function loadInit() {
     await loadPlugins(join(process.cwd(), getAppProCoinfg('dir')));
-    return;
 }
 /**
  * 指令匹配
- * @param e
- * @returns
+ * @param e alemonjs message
+ * @returns 是否处理完成
  */
 export async function InstructionMatching(e) {
     /**
-     * 获取对话状态
+     * 对话机
      */
     const state = await getConversationState(e.user_id);
-    /**
-     * 获取对话处理函数
-     */
     const handler = conversationHandlers.get(e.user_id);
-    /**
-     * 拦截
-     */
     if (handler && state) {
-        /**
-         * 如果用户处于对话状态
-         * 则调用对话处理函数
-         */
         await handler(e, state);
         return true;
     }
     /**
-     *  撤回事件 匹配不到事件 或者 大正则不匹配
+     *
+     */
+    const APPCACHE = {};
+    /**
+     * 上下文
+     */
+    for (const item in CommandApp) {
+        const { name, APP } = CommandApp[item];
+        const AppFnc = getMessage(name);
+        try {
+            if (typeof AppFnc == 'function')
+                e = AppFnc(e);
+            const app = new APP(e);
+            // 设置this.e
+            app.e = e;
+            // 如果存在用户上下文
+            if (app.getContext) {
+                // 得到缓存
+                const context = app.getContext();
+                // 是否为 null && undefined && '' && [] && {}
+                if (!lodash.isEmpty(context)) {
+                    // 得到缓存中的e消息
+                    for (const fnc in context) {
+                        // 丢给自己
+                        if (app[fnc])
+                            app[fnc](context[fnc]);
+                    }
+                    return;
+                }
+            }
+            // 如果存在频道上下文
+            if (app.getContextGroup) {
+                // 得到缓存
+                const context = app.getContextGroup();
+                // 是否为 null && undefined && '' && [] && {}
+                if (!lodash.isEmpty(context)) {
+                    // 得到缓存中的e消息
+                    for (const fnc in context) {
+                        // 丢给自己
+                        if (app[fnc])
+                            app[fnc](context[fnc]);
+                        return;
+                    }
+                }
+            }
+            APPCACHE[item] = app;
+        }
+        catch (err) {
+            console.log('[AlemonJS]上下文出错', err);
+            return;
+        }
+    }
+    /**
+     *  撤回事件 || 匹配不到事件 || 大正则不匹配
      */
     if (e.isRecall || !Command[e.event] || !mergedRegex.test(e.msg))
         return true;
     /**
-     * 循环所有指令 用 awwat确保指令顺序
+     * 循环所有指令
      */
-    for await (const data of Command[e.event]) {
+    for (const data of Command[e.event]) {
         if (e.eventType != data.eventType ||
             data.reg === undefined ||
             !data.reg.test(e.msg)) {
             continue;
         }
-        const AppFnc = getMessage(data.AppName);
         try {
-            if (typeof AppFnc == 'function')
-                e = AppFnc(e);
-            const res = await data
-                .fnc(e)
-                .then((res) => {
-                console.info(`\n[${data.event}][${data.AppName}][${data.fncName}][${true}]`);
-                return res;
-            })
-                .catch((err) => {
-                console.error(`\n[${data.event}][${data.AppName}][${data.fncName}][${false}]\n[${err}]`);
-                return false;
-            });
-            // 不是false都直接中断匹配
-            if (res !== false) {
+            const app = APPCACHE[data.APP];
+            const res = await app[data.fncName](e)
+                .then(info(data))
+                .catch(logErr(data));
+            if (res != false)
                 break;
-            }
         }
         catch (err) {
-            logErr(err, data);
+            logErr(data)(err);
             return false;
         }
     }
@@ -321,47 +372,56 @@ export async function InstructionMatching(e) {
 /**
  * 不匹配指令的方法
  * 只用匹配类型函数
- * @param e
- * @returns
+ * @param e alemonjs message
+ * @returns 是否处理完成
  */
 export async function typeMessage(e) {
     if (!CommandNotMessage[e.event])
         return true;
+    const APPCACHE = {};
+    for (const item in CommandApp) {
+        const { name, APP } = CommandApp[item];
+        const AppFnc = getMessage(name);
+        try {
+            if (typeof AppFnc == 'function')
+                e = AppFnc(e);
+            const app = new APP(e);
+            app.e = e;
+            APPCACHE[item] = app;
+        }
+        catch (err) {
+            console.log('[AlemonJS]上下文出错', err);
+            return;
+        }
+    }
     // 循环查找
     for (const data of CommandNotMessage[e.event]) {
         if (e.eventType != data.eventType)
             continue;
         try {
-            const AppFnc = getMessage(data.AppName);
-            if (typeof AppFnc == 'function')
-                e = AppFnc(e);
-            const res = await data
-                .fnc(e)
-                .then((res) => {
-                console.info(`\n[${data.event}][${data.AppName}][${data.fncName}][${true}]`);
-                return res;
-            })
-                .catch((err) => {
-                console.error(`\n[${data.event}][${data.AppName}][${data.fncName}][${false}]\n[${err}]`);
-                return false;
-            });
-            if (res) {
+            const app = APPCACHE[data.APP];
+            const res = await app[data.fncName](e)
+                .then(info(data))
+                .catch(logErr(data));
+            if (res != false)
                 break;
-            }
         }
         catch (err) {
-            logErr(err, data);
+            logErr(data)(err);
             continue;
         }
     }
     return true;
 }
-/**
- * 错误信息反馈
- * @param err
- * @param data
- */
-function logErr(err, data) {
-    console.error(`\n[${data.event}][${data.AppName}][${data.fncName}][${false}]\n[${err}]`);
-    return;
+function logErr(data) {
+    return (err) => {
+        console.error(`\n[${data.event}][${data.fncName}][${false}]\n[${err}]`);
+        return false;
+    };
+}
+function info(data) {
+    return (res) => {
+        console.info(`\n[${data.event}][${data.fncName}][${true}]`);
+        return res;
+    };
 }