kokkoro-plugin-saucenao 1.0.2 → 2.0.0

package/LICENSE

@@ -1,21 +1,21 @@
-MIT License
-
-Copyright (c) 2022 yuki
-
-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) 2020 Yuki
+
+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/README.md

@@ -1,41 +1,39 @@
-# kokkoro-plugin-saucenao
-
-> SauceNAO 图片搜索
-
-## 安装
-
-```shell
-# 切换至 bot 目录
-cd bot
-
-# 安装 npm 包
-npm i kokkoro-plugin-saucenao
-```
-
-## 配置项
-
-```typescript
-interface SaucenaoOption extends Option {
-  /** 结果返回数 */
-  results: number;
-  /** 数据库索引数组，例如只搜索 Pixiv [5] */
-  mask: number[];
-  /** 数据库索引（结果排除） */
-  excludeMask: number[];
-  /** 测试模式 */
-  testMode: boolean;
-  /** 搜索特定数据库索引而不必生成掩码 */
-  db: number;
-  /** 最低相似度，低于该数值的略缩图将会和谐 */
-  similarity: number;
-}
-```
-
-## 环境变量
-
-你可以在项目根目录下创建 `.env` 文件
-
-```ini
-# API key
-SAUCENAO_API_KEY=3d14159265358979323846264338327950288419
-```
+# kokkoro-plugin-saucenao
+
+使用 SauceNAO 搜索图片来源。
+
+## 安装
+
+```shell
+bun add kokkoro-plugin-saucenao
+```
+
+## 指令
+
+```text
+/搜图
+```
+
+发送「/搜图」时附带图片，插件会搜索消息中的第一张图片，并以 Markdown 返回搜索结果，默认显示相似度最高的 3 条。
+
+## 快捷方式
+
+发送「搜图」时附带图片，也会返回搜索结果。群聊需要开启「获取群内全部消息」权限。
+
+```text
+搜图
+```
+
+## 环境变量
+
+使用插件前，需要在项目根目录的 `.env` 文件中填写 [SauceNAO API Key](https://saucenao.com/user.php?page=search-api)。
+
+```ini
+SAUCENAO_API_KEY=xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx
+SAUCENAO_NUMRES=3
+SAUCENAO_SIMILARITY_THRESHOLD=50
+```
+
+`SAUCENAO_NUMRES` 表示返回结果数量，默认值为 `3`。
+
+`SAUCENAO_SIMILARITY_THRESHOLD` 表示显示原缩略图的最低相似度，默认值为 `50`。低于该数值时，插件会使用表情包替换缩略图，避免搜出奇怪的图社死。

package/package.json

@@ -1,33 +1,28 @@
 {
   "name": "kokkoro-plugin-saucenao",
-  "version": "1.0.2",
+  "version": "2.0.0",
   "description": "SauceNAO 图片搜索",
-  "main": "lib/index.js",
-  "scripts": {
-    "test": "echo \"Error: no test specified\" && exit 1"
-  },
+  "keywords": [
+    "bot",
+    "kokkoro",
+    "saucenao",
+    "qq"
+  ],
+  "bugs": "https://github.com/kokkorojs/kokkoro/issues",
   "repository": {
     "type": "git",
-    "url": "git+https://github.com/kokkorojs/kokkoro-plugin-saucenao.git"
+    "url": "git+https://github.com/kokkorojs/kokkoro.git",
+    "directory": "plugins/saucenao"
   },
-  "keywords": [
-    "kokkoro"
-  ],
-  "author": "yuki <mail@yuki.sh>",
   "license": "MIT",
-  "bugs": {
-    "url": "https://github.com/kokkorojs/kokkoro-plugin-saucenao/issues"
-  },
-  "homepage": "https://github.com/kokkorojs/kokkoro-plugin-saucenao#readme",
-  "devDependencies": {
-    "@types/node": "^18.11.18",
-    "kokkoro": "^1.3.0"
-  },
+  "author": "Yuki <admin@yuki.sh>",
+  "type": "module",
+  "exports": "./src/index.ts",
   "files": [
-    "lib",
-    "images"
+    "src"
   ],
-  "dependencies": {
-    "sagiri": "^3.2.4"
+  "peerDependencies": {
+    "@kokkoro/core": "^3.1.3",
+    "typescript": "^6.0.3"
   }
-}
+}

package/src/index.ts

@@ -0,0 +1,230 @@
+import { Image } from 'bun';
+
+import { type CommandReply, useCommand } from '@kokkoro/core';
+
+/**
+ * SauceNAO JSON API 搜索响应。
+ *
+ * @see https://saucenao.com/user.php?page=search-api
+ */
+interface SauceNao {
+  /** 搜索请求、配额和索引状态。 */
+  readonly header: {
+    /** SauceNAO 用户 ID。 */
+    readonly user_id: string;
+    /** 账户类型。 */
+    readonly account_type: string;
+    /** 30 秒内允许的请求数量。 */
+    readonly short_limit: string;
+    /** 24 小时内允许的请求数量。 */
+    readonly long_limit: string;
+    /** 24 小时内剩余的请求数量。 */
+    readonly long_remaining: number;
+    /** 30 秒内剩余的请求数量。 */
+    readonly short_remaining: number;
+    /** 请求状态，`0` 表示成功。 */
+    readonly status: number;
+    /** 请求失败时返回的错误信息。 */
+    readonly message?: string;
+    /** `numres` 请求的结果数量。 */
+    readonly results_requested: string;
+    /** 参与搜索的索引状态，以索引编号为键。 */
+    readonly index: Readonly<
+      Record<
+        string,
+        {
+          /** 索引状态。 */
+          readonly status: number;
+          /** 父索引编号。 */
+          readonly parent_id: number;
+          /** 索引编号。 */
+          readonly id: number;
+          /** 该索引匹配到的结果数量。 */
+          readonly results: number;
+        }
+      >
+    >;
+    /** 本次搜索的深度。 */
+    readonly search_depth: string;
+    /** 返回结果中的最低相似度。 */
+    readonly minimum_similarity: number;
+    /** 用于显示查询图片的路径。 */
+    readonly query_image_display: string;
+    /** 查询图片的文件名。 */
+    readonly query_image: string;
+    /** 实际返回的结果数量。 */
+    readonly results_returned: number;
+  };
+  /** 匹配到的图片来源。 */
+  readonly results: readonly ImageSource[];
+}
+
+/** SauceNAO 返回的一条图片来源。 */
+interface ImageSource {
+  /** 匹配结果信息。 */
+  readonly header: {
+    /** 相似度百分比。 */
+    readonly similarity: string;
+    /** 缩略图地址。 */
+    readonly thumbnail: string;
+    /** 搜索索引编号。 */
+    readonly index_id: number;
+    /** 搜索索引名称。 */
+    readonly index_name: string;
+    /** 重复结果数量。 */
+    readonly dupes: number;
+    /** 隐藏状态。 */
+    readonly hidden: number;
+  };
+  /** 来源数据。字段由 `header.index_id` 对应的搜索索引决定。 */
+  readonly data: {
+    /** 搜索索引可能返回的其他专有字段。 */
+    readonly [key: string]: unknown;
+    /** 来源页面地址。 */
+    readonly ext_urls?: readonly string[];
+    /** 作品标题。 */
+    readonly title?: string;
+    /** 作品或系列名称。 */
+    readonly material?: string;
+    /** 日文名称。 */
+    readonly jp_name?: string;
+    /** 英文名称。 */
+    readonly eng_name?: string;
+    /** 原始来源。 */
+    readonly source?: string;
+    /** 创作者名称。 */
+    readonly creator?: string | readonly string[];
+    /** 角色名称。 */
+    readonly characters?: string;
+    /** 发布时间。 */
+    readonly created_at?: string;
+    /** Danbooru 作品 ID。 */
+    readonly danbooru_id?: number;
+    /** e621 作品 ID。 */
+    readonly e621_id?: number;
+    /** Gelbooru 作品 ID。 */
+    readonly gelbooru_id?: number;
+    /** Pixiv 作者 ID。 */
+    readonly member_id?: number;
+    /** Pixiv 作者名称。 */
+    readonly member_name?: string;
+    /** Pixiv 作品 ID。 */
+    readonly pixiv_id?: number;
+    /** 推文 ID。 */
+    readonly tweet_id?: string;
+    /** Twitter 用户名。 */
+    readonly twitter_user_handle?: string;
+    /** Twitter 用户 ID。 */
+    readonly twitter_user_id?: string;
+  };
+}
+
+const { SAUCENAO_API_KEY, SAUCENAO_NUMRES = 3, SAUCENAO_SIMILARITY_THRESHOLD = 50 } = import.meta.env;
+const SAUCENAO_API = new URL('https://saucenao.com/search.php');
+const LOW_SIMILARITY_THUMBNAIL = 'https://kokkoro.js.org/saucenao-low-similarity.jpg';
+const similarityThreshold = Number(SAUCENAO_SIMILARITY_THRESHOLD);
+
+function getTitle(data: ImageSource['data']) {
+  const { eng_name: engName, jp_name: jpName, material, source, title } = data;
+  return title || material || jpName || engName || source;
+}
+
+function getPlatform(indexName: string) {
+  const [, platform] = indexName.match(/^Index #\d+:\s*(.*?)(?:\s+-\s+.*)?$/) ?? [];
+  return platform ?? indexName;
+}
+
+function getUrl(data: ImageSource['data']) {
+  const [url] = data.ext_urls ?? [];
+
+  if (url) {
+    return url;
+  }
+
+  if (data.source && URL.canParse(data.source)) {
+    return data.source;
+  }
+}
+
+async function searchImage(image: string) {
+  if (!SAUCENAO_API_KEY) {
+    throw new Error('未配置 SAUCENAO_API_KEY 环境变量');
+  }
+  const form = new FormData();
+
+  form.set('api_key', SAUCENAO_API_KEY);
+  form.set('output_type', '2');
+  form.set('numres', String(SAUCENAO_NUMRES));
+  form.set('db', '999');
+  form.set('url', image);
+
+  const response = await fetch(SAUCENAO_API, { method: 'POST', body: form });
+
+  if (!response.ok) {
+    throw new Error(`接口请求失败，状态码 ${response.status}`);
+  }
+  const { header, results } = <SauceNao>await response.json();
+
+  if (header.status !== 0) {
+    throw new Error(header.message ?? `SauceNAO 搜索失败，状态码 ${header.status}`);
+  }
+
+  if (results.length === 0) {
+    throw new Error('没有找到图片来源');
+  }
+  return results;
+}
+
+async function createMessage(results: readonly ImageSource[]) {
+  const content = await Promise.all(
+    results.map(async ({ data, header }, index) => {
+      const { index_name: indexName, similarity, thumbnail } = header;
+      const platform = getPlatform(indexName);
+      const title = getTitle(data) || platform;
+      const url = getUrl(data);
+      const lines = ['### 标题', `- ${title}`, '### 平台', `- ${platform}`, '### 相似度', `- ${similarity}%`];
+
+      if (thumbnail) {
+        if (Number(similarity) < similarityThreshold) {
+          lines.push('### 缩略图', `![缩略图 #168px #142px](${LOW_SIMILARITY_THUMBNAIL})`);
+        } else {
+          const response = await fetch(thumbnail);
+
+          if (!response.ok) {
+            throw new Error(`缩略图请求失败，状态码 ${response.status}`);
+          }
+          const { height, width } = await new Image(await response.blob()).metadata();
+
+          lines.push('### 缩略图', `![缩略图 #${width}px #${height}px](${thumbnail})`);
+        }
+      }
+
+      if (url) {
+        lines.push(`[查看来源](${url})`);
+      }
+
+      if (index < results.length - 1) {
+        lines.push('***');
+      }
+      return lines.join('\n');
+    }),
+  );
+
+  return {
+    msg_type: 2,
+    markdown: {
+      content: ['## SauceNAO 搜图结果', '***', ...content].join('\n\n'),
+    },
+  } satisfies CommandReply;
+}
+
+export default () => {
+  useCommand('/搜图', async context => {
+    const image = context.attachments?.find(attachment => attachment.content_type?.startsWith('image/'));
+
+    if (!image?.url) {
+      throw new Error('请在指令中附带需要搜索的图片');
+    }
+    return createMessage(await searchImage(image.url));
+  }).shortcut('搜图');
+};

package/lib/index.js

@@ -1,47 +0,0 @@
-"use strict";
-Object.defineProperty(exports, "__esModule", { value: true });
-const kokkoro_1 = require("kokkoro");
-const service_1 = require("./service");
-const option = {
-    apply: true,
-    lock: false,
-    results: 5,
-    mask: [],
-    excludeMask: [],
-    testMode: false,
-    db: 999,
-    similarity: 50,
-};
-const { version } = require('../package.json');
-const plugin = new kokkoro_1.Plugin('saucenao', option);
-const service = new service_1.SaucenaoService(plugin.logger, process.env.SAUCENAO_API_KEY);
-plugin
-    .version(version);
-plugin
-    .command('search', 'group')
-    .sugar(/^搜图$/)
-    .action(async (ctx) => {
-    const { bot, option, sender, group_id } = ctx;
-    const { user_id } = sender;
-    const scanner = new kokkoro_1.Scanner(bot);
-    await ctx.reply(`请发送你要搜索的图片 (●'◡'●)`);
-    const { url } = await scanner.nextImage({
-        user_id, group_id,
-    });
-    const results = await service.searchImage(url, option);
-    const results_length = results.length;
-    const forwardMessage = [];
-    for (let i = 0; i < results_length; i++) {
-        const result = results[i];
-        const { site, similarity, thumbnail, authorName, url } = result;
-        const message = {
-            message: [`封面：\n`, kokkoro_1.segment.image(thumbnail), `\n平台：${site}\n相似度：${similarity}\n作者：${authorName}\n来源：${url}`],
-            user_id: ctx.self_id,
-            nickname: bot.nickname,
-        };
-        forwardMessage.push(message);
-    }
-    await bot
-        .makeForwardMsg(forwardMessage)
-        .then(xml => ctx.reply(xml));
-});

package/lib/service.js

@@ -1,50 +0,0 @@
-"use strict";
-var __importDefault = (this && this.__importDefault) || function (mod) {
-    return (mod && mod.__esModule) ? mod : { "default": mod };
-};
-Object.defineProperty(exports, "__esModule", { value: true });
-exports.SaucenaoService = void 0;
-const path_1 = require("path");
-const sagiri_1 = __importDefault(require("sagiri"));
-const xcw = (0, path_1.join)(__dirname, '../images/h.jpg');
-class SaucenaoService {
-    logger;
-    api_key;
-    /** API */
-    api;
-    client;
-    constructor(
-    /** 日志 */
-    logger, 
-    /** API key */
-    api_key) {
-        this.logger = logger;
-        this.api_key = api_key;
-        this.api = 'https://saucenao.com/search.php';
-        this.client = this.api_key ? (0, sagiri_1.default)(this.api_key) : undefined;
-        if (!this.api_key) {
-            this.logger.warn('你没有添加 api key ，saucenao 服务将无法正常使用');
-        }
-    }
-    async searchImage(url, option) {
-        if (!this.client) {
-            throw new Error('你没有添加 api key ，saucenao 服务将无法正常使用');
-        }
-        const options = {
-            results: option.results,
-            mask: option.mask.length ? option.mask : undefined,
-            excludeMask: option.excludeMask,
-            testMode: option.testMode,
-            db: option.db,
-        };
-        const results = await this.client(url, options);
-        results.map((result) => {
-            if (result.similarity < option.similarity) {
-                result.thumbnail = xcw;
-            }
-            return result;
-        });
-        return results;
-    }
-}
-exports.SaucenaoService = SaucenaoService;