koishi-plugin-audiomeme 1.2.0 → 1.2.2

package/README.md

@@ -1,30 +1,39 @@
 # koishi-plugin-audiomeme
 
-Play meme sounds from a bundled JSON database.
+播放内置 JSON 数据库中的 meme 音效，并支持 ChatLuna 工具调用。
 
 ## Usage
 
 ```text
-memeaudio
-memeaudio <name>
-memeaudio.list [page]
-memeaudio.list [keyword]
-memeaudio.list [page] [keyword]
+audiomeme
+audiomeme <音效名>
+audiomeme list [页码]
+audiomeme list [关键词]
+audiomeme list [页码] [关键词]
+audiomeme random
 ```
 
-- `memeaudio` shows the first page of available sounds.
-- `memeaudio <name>` downloads and plays a sound.
-- `memeaudio.list` shows a paginated list without a wide table.
-- `memeaudio.list cat` searches by sound name.
+- `audiomeme` 显示第一页可用音效。
+- `audiomeme <音效名>` 下载并播放指定音效。
+- `audiomeme list` 显示分页列表。
+- `audiomeme list cat` 按音效名搜索。
+- `audiomeme random` 随机播放一个音效。
+- 兼容旧命令：`memeaudio`、`memeaudio.list`、`memeaudio.random`。
+
+## Audio Sending
+
+默认使用“远程链接”模式发送音效，适合 OneBot 等适配器，避免本地 `file://` 缓存路径在机器人端不可见导致 0 秒语音。
+
+如需让 Koishi 先下载音频再发送本地文件，可以在配置中把“音效发送模式”改为“缓存文件”。缓存模式会校验已下载文件，发现空文件、HTML 错误页或无效音频时会自动重新下载。
 
 ## ChatLuna Tool Calls
 
-This plugin can optionally integrate with `chatluna_character`.
+本插件可以选择接入 `chatluna_character`。
 
-- `enableAudioMemeXmlTool`: enables XML audio meme tool calls in ChatLuna replies.
-- `injectAudioMemeXmlToolAsReplyTool`: injects the same XML tool as an experimental reply tool field. When this is available, direct XML action execution is disabled to avoid double playback.
+- `enableAudioMemeXmlTool`：启用 ChatLuna 回复中的 XML 音效工具调用。
+- `injectAudioMemeXmlToolAsReplyTool`：将同一个 XML 音效工具注入实验性“工具调用回复”参数中；可用时会关闭直接 XML 动作执行，避免重复播放。
 
-XML examples:
+XML 示例：
 
 ```xml
 <audiomeme name="bruh" />
@@ -32,13 +41,13 @@ XML examples:
 <audio-meme key="cat-laugh-meme-1" />
 ```
 
-Reply tool field name:
+Reply tool 字段名：
 
 ```text
 audiomeme_play
 ```
 
-Reply tool payload example:
+Reply tool 参数示例：
 
 ```json
 [{ "name": "bruh" }]

package/lib/index.d.ts

@@ -9,6 +9,7 @@ export interface Config {
     cacheMaxAge: number;
     pageSize: number;
     downloadTimeout: number;
+    sendMode: 'remote' | 'cache';
     enableAudioMemeXmlTool: boolean;
     injectAudioMemeXmlToolAsReplyTool: boolean;
 }

package/lib/index.js

@@ -16,40 +16,108 @@ exports.inject = {
     optional: ['chatluna_character'],
 };
 exports.Config = koishi_1.Schema.object({
-    cachePath: koishi_1.Schema.string().default('cache/audiomeme').description('Cache directory for audio files.'),
-    cleanupInterval: koishi_1.Schema.number().default(10 * 60 * 1000).description('Cleanup interval in milliseconds (default 10 minutes).'),
-    cacheMaxAge: koishi_1.Schema.number().default(60 * 60 * 1000).description('Maximum age for cached files in milliseconds (default 1 hour).'),
-    pageSize: koishi_1.Schema.number().min(5).max(50).default(20).description('Number of meme sounds shown per list page.'),
-    downloadTimeout: koishi_1.Schema.number().min(1000).default(30 * 1000).description('Download timeout in milliseconds.'),
-    enableAudioMemeXmlTool: koishi_1.Schema.boolean().default(false).description('Enable XML audio meme tool calls from ChatLuna replies.'),
-    injectAudioMemeXmlToolAsReplyTool: koishi_1.Schema.boolean().default(false).description('Inject the XML tool as an experimental ChatLuna reply tool field.'),
+    cachePath: koishi_1.Schema.string().default('cache/audiomeme').description('音频文件缓存目录。'),
+    cleanupInterval: koishi_1.Schema.number().default(10 * 60 * 1000).description('缓存清理间隔，单位为毫秒，默认 10 分钟。'),
+    cacheMaxAge: koishi_1.Schema.number().default(60 * 60 * 1000).description('缓存文件最长保留时间，单位为毫秒，默认 1 小时。'),
+    pageSize: koishi_1.Schema.number().min(5).max(50).default(20).description('列表每页显示的音效数量。'),
+    downloadTimeout: koishi_1.Schema.number().min(1000).default(30 * 1000).description('音频下载超时时间，单位为毫秒。'),
+    sendMode: koishi_1.Schema.union([
+        koishi_1.Schema.const('remote').description('远程链接：直接把音频 URL 交给平台发送，推荐 OneBot 使用。'),
+        koishi_1.Schema.const('cache').description('缓存文件：下载到 Koishi 缓存目录后以本地文件发送。'),
+    ]).role('radio').default('remote').description('音效发送模式。'),
+    enableAudioMemeXmlTool: koishi_1.Schema.boolean().default(false).description('是否启用 ChatLuna 回复中的 XML 音效工具调用。'),
+    injectAudioMemeXmlToolAsReplyTool: koishi_1.Schema.boolean().default(false).description('是否将 XML 音效工具注入实验性“工具调用回复”参数中。'),
 });
+const MIN_AUDIO_FILE_SIZE = 1024;
 function matchSounds(sounds, keyword) {
     if (!keyword)
         return sounds;
     const normalizedKeyword = keyword.toLowerCase();
     return sounds.filter(sound => sound.name.toLowerCase().includes(normalizedKeyword));
 }
+function parseListArgs(input) {
+    const normalizedInput = (input || '').trim();
+    if (!normalizedInput)
+        return { page: 1, keyword: undefined };
+    const [first, ...rest] = normalizedInput.split(/\s+/);
+    const page = Number(first);
+    if (Number.isInteger(page) && page > 0) {
+        return {
+            page,
+            keyword: rest.join(' ') || undefined,
+        };
+    }
+    return {
+        page: 1,
+        keyword: normalizedInput,
+    };
+}
+function pickRandomSound(sounds) {
+    return sounds[Math.floor(Math.random() * sounds.length)];
+}
+function hasAudioMagic(buffer) {
+    if (buffer.length < 4)
+        return false;
+    if (buffer.subarray(0, 3).toString('ascii') === 'ID3')
+        return true;
+    if (buffer[0] === 0xff && (buffer[1] & 0xe0) === 0xe0)
+        return true;
+    if (buffer.subarray(0, 4).toString('ascii') === 'OggS')
+        return true;
+    if (buffer.subarray(0, 4).toString('ascii') === 'RIFF')
+        return true;
+    if (buffer.length >= 12 && buffer.subarray(4, 8).toString('ascii') === 'ftyp')
+        return true;
+    return false;
+}
+function isLikelyTextResponse(buffer) {
+    const head = buffer.subarray(0, Math.min(buffer.length, 64)).toString('utf8').trimStart().toLowerCase();
+    return head.startsWith('<!doctype') || head.startsWith('<html') || head.startsWith('{') || head.startsWith('[');
+}
+async function validateAudioFile(filePath) {
+    try {
+        const stats = await fs_extra_1.default.stat(filePath);
+        if (!stats.isFile() || stats.size < MIN_AUDIO_FILE_SIZE)
+            return false;
+        const buffer = await fs_extra_1.default.readFile(filePath);
+        const head = buffer.subarray(0, 16);
+        return hasAudioMagic(head) && !isLikelyTextResponse(head);
+    }
+    catch {
+        return false;
+    }
+}
+function assertAudioResponse(contentType, data) {
+    if (data.length < MIN_AUDIO_FILE_SIZE) {
+        throw new Error(`downloaded audio is too small: ${data.length} bytes`);
+    }
+    if (contentType && !/audio|mpeg|octet-stream/i.test(contentType)) {
+        throw new Error(`unexpected content type: ${contentType}`);
+    }
+    if (!hasAudioMagic(data.subarray(0, 16)) || isLikelyTextResponse(data)) {
+        throw new Error('downloaded file does not look like an audio file');
+    }
+}
 function formatSoundList(sounds, page, pageSize, keyword) {
     const totalPages = Math.max(1, Math.ceil(sounds.length / pageSize));
     const currentPage = Math.min(Math.max(page, 1), totalPages);
     const start = (currentPage - 1) * pageSize;
     const pageSounds = sounds.slice(start, start + pageSize);
     const title = keyword
-        ? `Meme sounds matching "${keyword}" (${sounds.length})`
-        : `Meme sounds (${sounds.length})`;
+        ? `匹配 "${keyword}" 的音效 (${sounds.length})`
+        : `可用音效 (${sounds.length})`;
     if (!sounds.length) {
-        return `No meme sounds found for "${keyword}".`;
+        return `没有找到匹配 "${keyword}" 的音效。`;
     }
     return [
-        `${title} - page ${currentPage}/${totalPages}`,
+        `${title} - 第 ${currentPage}/${totalPages} 页`,
         ...pageSounds.map((sound, index) => `${String(start + index + 1).padStart(3, ' ')}. ${sound.name}`),
         '',
-        `Play: memeaudio <name>`,
-        `Search: memeaudio.list <keyword>`,
+        `播放：audiomeme <音效名>`,
+        `搜索：audiomeme list <关键词>`,
         currentPage < totalPages
-            ? `Next: memeaudio.list ${currentPage + 1}${keyword ? ` ${keyword}` : ''}`
-            : 'End of results.',
+            ? `下一页：audiomeme list ${currentPage + 1}${keyword ? ` ${keyword}` : ''}`
+            : '已经是最后一页。',
     ].join('\n');
 }
 function apply(ctx, config) {
@@ -64,40 +132,74 @@ function apply(ctx, config) {
         if (!sound) {
             const suggestions = matchSounds(sounds, name).slice(0, 5).map(s => s.name);
             return suggestions.length
-                ? [`Meme sound not found: ${name}`, 'Maybe you meant:', ...suggestions.map(s => `- ${s}`)].join('\n')
-                : `Meme sound not found: ${name}`;
+                ? [`未找到音效：${name}`, '你可能想找：', ...suggestions.map(s => `- ${s}`)].join('\n')
+                : `未找到音效：${name}`;
+        }
+        if (config.sendMode === 'remote') {
+            return koishi_1.h.audio(sound.url);
         }
         const fileName = `${encodeURIComponent(sound.name)}.mp3`;
         const filePath = path_1.default.join(cacheDir, fileName);
+        const tempFilePath = `${filePath}.${process.pid}.${Date.now()}.tmp`;
         try {
-            if (!await fs_extra_1.default.pathExists(filePath)) {
+            if (!await validateAudioFile(filePath)) {
+                await fs_extra_1.default.unlink(filePath).catch(() => { });
                 const response = await axios_1.default.get(sound.url, {
                     responseType: 'arraybuffer',
                     timeout: config.downloadTimeout,
                 });
-                await fs_extra_1.default.writeFile(filePath, response.data);
+                const data = Buffer.from(response.data);
+                const contentType = response.headers['content-type'];
+                assertAudioResponse(typeof contentType === 'string' ? contentType : undefined, data);
+                await fs_extra_1.default.writeFile(tempFilePath, data);
+                if (!await validateAudioFile(tempFilePath)) {
+                    throw new Error('downloaded audio failed validation');
+                }
+                await fs_extra_1.default.move(tempFilePath, filePath, { overwrite: true });
             }
             lastAccess.set(fileName, Date.now());
             return koishi_1.h.audio((0, url_1.pathToFileURL)(filePath).href);
         }
         catch (error) {
+            await fs_extra_1.default.unlink(tempFilePath).catch(() => { });
             logger.error(error);
-            return 'Failed to download or play meme sound.';
+            return '下载或播放音效失败。';
         }
     };
-    ctx.command('memeaudio <name:string>', 'Play a meme sound')
-        .action(async ({ session }, name) => {
-        if (!name)
-            return formatSoundList(sounds, 1, config.pageSize);
-        return playSound(name);
+    const playRandomSound = async () => {
+        const sound = pickRandomSound(sounds);
+        if (!sound)
+            return '当前没有可用音效。';
+        return playSound(sound.name);
+    };
+    const listSounds = (input) => {
+        const { page, keyword } = parseListArgs(input);
+        const matchedSounds = matchSounds(sounds, keyword);
+        return formatSoundList(matchedSounds, page, config.pageSize, keyword);
+    };
+    ctx.command('audiomeme [action:text]', '播放或查看音效 meme')
+        .alias('memeaudio')
+        .action(async ({ session }, action) => {
+        const normalizedAction = (action || '').trim();
+        if (!normalizedAction)
+            return listSounds();
+        const [command, ...rest] = normalizedAction.split(/\s+/);
+        const commandArgs = rest.join(' ');
+        if (command === 'list')
+            return listSounds(commandArgs);
+        if (command === 'random')
+            return playRandomSound();
+        return playSound(normalizedAction);
+    });
+    ctx.command('audiomeme.list [query:text]', '查看音效 meme 列表')
+        .alias('memeaudio.list')
+        .action(({ session }, query) => {
+        return listSounds(query);
     });
-    ctx.command('memeaudio.list [pageOrKeyword:string] [keyword:text]', 'List meme sounds')
-        .action(({ session }, pageOrKeyword, keyword) => {
-        const page = Number(pageOrKeyword);
-        const hasPage = Number.isInteger(page) && page > 0;
-        const searchKeyword = hasPage ? keyword : [pageOrKeyword, keyword].filter(Boolean).join(' ');
-        const matchedSounds = matchSounds(sounds, searchKeyword);
-        return formatSoundList(matchedSounds, hasPage ? page : 1, config.pageSize, searchKeyword);
+    ctx.command('audiomeme.random', '随机播放音效 meme')
+        .alias('memeaudio.random')
+        .action(async () => {
+        return playRandomSound();
     });
     (0, chatluna_1.installChatlunaAudioMemeTools)({
         ctx,

package/package.json

@@ -1,7 +1,7 @@
 {
   "name": "koishi-plugin-audiomeme",
   "description": "Play meme sounds from a JSON database with cache cleanup.",
-  "version": "1.2.0",
+  "version": "1.2.2",
   "main": "lib/index.js",
   "typings": "lib/index.d.ts",
   "files": [