koishi-plugin-forward-hime 1.3.9 → 1.4.0-alpha.0

package/LICENSE

@@ -1,21 +1,21 @@
-MIT License
-
-Copyright (c) 2024 xianii
-
-Permission is hereby granted, free of charge, to any person obtaining a copy
-of this software and associated documentation files (the "Software"), to deal
-in the Software without restriction, including without limitation the rights
-to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
-copies of the Software, and to permit persons to whom the Software is
-furnished to do so, subject to the following conditions:
-
-The above copyright notice and this permission notice shall be included in all
-copies or substantial portions of the Software.
-
-THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
-IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
-FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
-AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
-LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
-OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
-SOFTWARE.
+MIT License
+
+Copyright (c) 2024 xianii
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

package/lib/cache.js

@@ -0,0 +1,60 @@
+import { logger } from "./logger";
+let ctx;
+let cacheTimeout = 86400 * 1000;
+function cacheNotEnabled() {
+    if (!ctx.cache) {
+        return true;
+    }
+    return false;
+}
+export function msgCacheInit(context, cfg) {
+    ctx = context;
+    cacheTimeout = 60 * cfg.CacheTimeout * 1000;
+}
+export async function msgCache(mc) {
+    if (cacheNotEnabled()) {
+        return;
+    }
+    const key = mc.guild + ":" + mc.msgid;
+    logger.debug(`[message-cache] ${mc.platform} ${key}`);
+    await ctx.cache.set("msgCache", key, mc, cacheTimeout);
+}
+export async function msgCacheDelete(key) {
+    if (cacheNotEnabled()) {
+        return;
+    }
+    await ctx.cache.delete("msgCache", key);
+}
+export async function msgCacheFindByKey(key) {
+    if (cacheNotEnabled()) {
+        return;
+    }
+    return await ctx.cache.get("msgCache", key);
+}
+export async function msgCacheFindByUUID(uuid) {
+    if (cacheNotEnabled()) {
+        return;
+    }
+    let caches = await ctx.cache.entries("msgCache");
+    let result = [];
+    for await (const item of caches) {
+        if (item[1].uuid === uuid) {
+            result.push(item);
+        }
+    }
+    return result;
+}
+export async function msgCacheGetLocalIDByUUID(node, uuid) {
+    if (cacheNotEnabled()) {
+        return;
+    }
+    let caches = await ctx.cache.entries("msgCache");
+    for await (const item of caches) {
+        if (item[1].uuid === uuid &&
+            item[1].platform === node.Platform &&
+            item[1].guild === node.Guild &&
+            item[1].bot === node.BotID) {
+            return item[1].msgid;
+        }
+    }
+}

package/lib/config.d.ts

@@ -11,6 +11,12 @@ export interface ConfigSet {
         Newline: boolean;
     };
     DefaultFallbackMsgPrefix: string;
+    MediaRelay: {
+        Enabled: boolean;
+        CacheMinutes: number;
+        RequestTimeoutSec: number;
+        MaxFileSizeMB: number;
+    };
     CacheTimeout: number;
     ForwardGroups: {
         Nodes: ForwardNode[];

package/lib/config.js

@@ -0,0 +1,56 @@
+import { Schema } from "koishi";
+export const createConfig = () => Schema.intersect([
+    Schema.object({
+        CacheTimeout: Schema.number()
+            .description("消息缓存时间（分钟）- 影响跨平台删除与回复等功能")
+            .default(120)
+            .min(120)
+            .max(1440 * 7),
+    }).description("消息缓存"),
+    Schema.object({
+        DefaultDecorator: Schema.object({
+            Prefix: Schema.string()
+                .description("转发前缀")
+                .default("${username} 转发自 ${platform}："),
+            Newline: Schema.boolean().description("是否换行").default(true),
+        }).description("默认装饰器"),
+        DefaultFallbackMsgPrefix: Schema.string()
+            .description("默认Fallback消息前缀")
+            .default("[消息降级] "),
+        MediaRelay: Schema.object({
+            Enabled: Schema.boolean()
+                .description("启用媒体中转（下载后再转发）")
+                .default(true),
+            CacheMinutes: Schema.number()
+                .description("媒体暂存时间（分钟）")
+                .default(10)
+                .min(1)
+                .max(180),
+            RequestTimeoutSec: Schema.number()
+                .description("媒体下载超时时间（秒）")
+                .default(15)
+                .min(3)
+                .max(120),
+            MaxFileSizeMB: Schema.number()
+                .description("允许中转的媒体最大大小（MB）")
+                .default(20)
+                .min(1)
+                .max(200),
+        }).description("媒体中转"),
+    }).description("转发格式"),
+    Schema.object({
+        ForwardGroups: Schema.array(Schema.object({
+            Note: Schema.string().description("互通组备注"),
+            Nodes: Schema.array(Schema.object({
+                Platform: Schema.string()
+                    .role("")
+                    .required()
+                    .description("平台"),
+                Guild: Schema.string().required().description("频道ID"),
+                BotID: Schema.string().required().description("机器人ID"),
+            }))
+                .role("table")
+                .description("转发节点"),
+        })).description("互通转发组"),
+    }).description("互通组"),
+]);

package/lib/decorator.d.ts

@@ -11,4 +11,5 @@ export declare function defaultMiddleware(session: Session): ForwardMsg;
 export declare function MsgMiddlewareCache(session: Session): Promise<void>;
 export declare function MsgDecorator(session: Session, node: ForwardNode): Promise<any>;
 export declare function MsgDecoratorFallback(session: Session, node: ForwardNode): Promise<Element[]>;
+export declare function MsgDecoratorFallbackReason(session: Session, node: ForwardNode, reason: string): Promise<Element[]>;
 export {};

package/lib/decorator.js

@@ -0,0 +1,159 @@
+import { h } from "koishi";
+import { MsgUUIDFromSession } from "./message";
+import { relayForwardContent, relayInit } from "./relay";
+import * as decorator from "./decorators";
+let defaultPrefix = "";
+let defaultFallback = "";
+let defaultPrefixNewline = true;
+export function decoratorInit(cfg) {
+    defaultPrefix = cfg.DefaultDecorator.Prefix;
+    defaultPrefixNewline = cfg.DefaultDecorator.Newline;
+    defaultFallback = cfg.DefaultFallbackMsgPrefix;
+    relayInit(cfg);
+}
+function renderTemplate(template, data) {
+    return template.replace(/\$\{(\w+)\}/g, (_, key) => {
+        return data[key] !== undefined ? data[key] : `$\{${key}}`; // 未找到则保留原模板
+    });
+}
+export function defaultDecorator({ head, content }) {
+    let msg = [];
+    msg = msg.concat(head, content);
+    return msg;
+}
+export function defaultMiddleware(session) {
+    let head = [h("span", renderTemplate(defaultPrefix, session))];
+    if (defaultPrefixNewline) {
+        head.push(h("br"));
+    }
+    return { head: head, content: session.elements };
+}
+const localDecorators = [atTranslator, quoteTranslator];
+let msgMiddleCache = [];
+function msgMiddleCacheAppend(msg) {
+    msgMiddleCache.push(msg);
+    if (msgMiddleCache.length > 16) {
+        msgMiddleCache.shift();
+    }
+    logger.debug(`[msgMiddleCache]`, msgMiddleCache.length);
+}
+function msgMiddleCacheFind(uuid) {
+    for (const item of msgMiddleCache) {
+        if (item.UUID === uuid) {
+            return item.msg;
+        }
+    }
+    return null;
+}
+function MsgToMiddleware(session) {
+    let elems = { head: [], content: [] };
+    let _platform_in = decorator[session.platform];
+    if (_platform_in && typeof _platform_in.Middleware === "function") {
+        elems = _platform_in.Middleware(session);
+    }
+    else {
+        elems = defaultMiddleware(session);
+    }
+    return elems;
+}
+export async function MsgMiddlewareCache(session) {
+    let elems = MsgToMiddleware(session);
+    msgMiddleCacheAppend({ UUID: MsgUUIDFromSession(session), msg: elems });
+    logger.debug(`[msgMiddleCache] CACHED`);
+}
+export async function MsgDecorator(session, node) {
+    let elems;
+    let _platform_out = decorator[node.Platform];
+    let elemCache = msgMiddleCacheFind(MsgUUIDFromSession(session));
+    if (elemCache) {
+        logger.debug(`[msgMiddleCache] HIT`);
+        elems = elemCache;
+    }
+    else {
+        logger.debug(`[msgMiddleCache] MISSED`);
+        elems = MsgToMiddleware(session);
+    }
+    for (const fn of localDecorators) {
+        elems = (await fn(session, node, elems));
+    }
+    elems = {
+        head: elems.head,
+        content: await relayForwardContent(elems.content),
+    };
+    if (_platform_out && typeof _platform_out.Decorator === "function") {
+        return _platform_out.Decorator(elems);
+    }
+    else {
+        return defaultDecorator(elems);
+    }
+}
+function defaultDecoratorFallback({ head, content }, reason) {
+    let msg = [];
+    let newContent = [];
+    newContent.push(h("span", reason || defaultFallback));
+    for (const key in content) {
+        if (["img", "audio", "video", "file"].includes(content[key].type)) {
+            newContent.push(h("span", ` [${content[key].type}] `));
+        }
+        else {
+            newContent.push(content[key]);
+        }
+    }
+    msg = msg.concat(head, newContent);
+    return msg;
+}
+export async function MsgDecoratorFallback(session, node) {
+    let elems = { head: [], content: [] };
+    elems = defaultMiddleware(session);
+    for (const fn of localDecorators) {
+        elems = (await fn(session, node, elems));
+    }
+    return defaultDecoratorFallback(elems);
+}
+export async function MsgDecoratorFallbackReason(session, node, reason) {
+    let elems = { head: [], content: [] };
+    elems = defaultMiddleware(session);
+    for (const fn of localDecorators) {
+        elems = (await fn(session, node, elems));
+    }
+    return defaultDecoratorFallback(elems, reason);
+}
+async function atTranslator(session, _, { head, content }) {
+    const newMsg = await new Promise((resolve, reject) => {
+        let newContent = [];
+        for (const key in content) {
+            const element = content[key];
+            if (element.type === "at") {
+                if (element.attrs.id !== session.selfId) {
+                    // Note: onebot-qq at 无昵称
+                    newContent.push(h("span", `@${element.attrs.name || element.attrs.id}`));
+                }
+            }
+            else {
+                newContent.push(element);
+            }
+        }
+        resolve({ head: head, content: newContent });
+    });
+    return newMsg;
+}
+import { logger } from "./logger";
+import { msgCacheFindByKey, msgCacheGetLocalIDByUUID } from "./cache";
+async function quoteTranslator(session, node, { head, content }) {
+    if (!session.quote || !session.quote.id) {
+        return { head: head, content: content };
+    }
+    const key = session.channelId + ":" + session.quote.id;
+    const cache = await msgCacheFindByKey(key);
+    if (cache) {
+        let msgid = await msgCacheGetLocalIDByUUID(node, cache.uuid);
+        if (msgid) {
+            let newHead = [h("quote", { id: msgid })].concat(head);
+            return { head: newHead, content: content };
+        }
+        else {
+            logger.error(`[msgCacheGetLocalIDByUUID] ${cache.uuid} not found`);
+        }
+    }
+    return { head: head, content: content };
+}

package/lib/decorators/index.js

@@ -0,0 +1,2 @@
+export { default as kook } from "./kook";
+export { default as onebot } from "./onebot";

package/lib/decorators/kook.js

@@ -0,0 +1,20 @@
+import { h } from "koishi";
+import { Buffer } from "buffer";
+const transparentPixel = Buffer.from("R0lGODlhAQABAIAAAP///wAAACH5BAEAAAAALAAAAAABAAEAAAICRAEAOw==", "base64");
+function Decorator({ head, content }) {
+    let msg = [];
+    let hasImage = false;
+    for (const key in content) {
+        if (content[key].type === "image") {
+            hasImage = true;
+        }
+    }
+    msg = msg.concat(head, h("br"), content);
+    if (!hasImage) {
+        msg = msg.concat(h.image(transparentPixel, "image/gif"));
+    }
+    return msg;
+}
+export default {
+    Decorator,
+};

package/lib/decorators/onebot.js

@@ -0,0 +1,81 @@
+import { h } from "koishi";
+import { defaultMiddleware } from "../decorator";
+function cqJsonTranslator(content, elem) {
+    let json = JSON.parse(elem.attrs.data);
+    let hit = 0;
+    if (json) {
+        if (json.prompt) {
+            hit += 1;
+            content.push(h("p", `${json.prompt}`));
+        }
+        if (json.meta && json.meta.detail_1) {
+            if (json.meta.detail_1.preview) {
+                hit += 1;
+                content.push(h.image(json.meta.detail_1.preview, "image/jpeg"));
+            }
+            if (json.meta.detail_1.qqdocurl) {
+                hit += 1;
+                content.push(h("span", `${json.meta.detail_1.qqdocurl}`));
+            }
+        }
+    }
+    if (hit === 0) {
+        content.push(h("span", `[CQ:JSON消息]`));
+    }
+}
+const IdNameCache = new Map();
+function getNameFromQQat(elem) {
+    const name = elem.attrs.name;
+    if (name) {
+        return name;
+    }
+    const id = elem.attrs.id;
+    if (IdNameCache.has(id)) {
+        return IdNameCache.get(id);
+    }
+    else {
+        return id;
+    }
+}
+function Middleware(session) {
+    const platform = guessPlatform(session);
+    let sessionTemp = session;
+    sessionTemp.platform = platform;
+    let head = defaultMiddleware(sessionTemp).head;
+    let newContent = [];
+    if (platform === "QQ") {
+        IdNameCache.set(session.userId, session.username);
+        for (const key in session.elements) {
+            switch (session.elements[key].type) {
+                case "at":
+                    newContent.push(h("span", `@${getNameFromQQat(session.elements[key])}`));
+                    break;
+                case "forward":
+                    newContent.push(h("span", `[CQ:转发消息]`));
+                    break;
+                case "json":
+                    cqJsonTranslator(newContent, session.elements[key]);
+                    break;
+                case "mface":
+                    newContent.push(h.image(session.elements[key].attrs.url));
+                    break;
+                default:
+                    newContent.push(session.elements[key]);
+                    break;
+            }
+        }
+        return { head: head, content: newContent };
+    }
+    return { head: head, content: session.elements };
+}
+function guessPlatform(session) {
+    if (session.event.user && session.event.user.avatar) {
+        if (session.event.user.avatar.includes("q.qlogo.cn")) {
+            return "QQ";
+        }
+    }
+    return session.platform;
+}
+export default {
+    Middleware,
+};