nonebot-plugin-savepic 0.4.1__tar.gz → 0.6.7__tar.gz

nonebot_plugin_savepic-0.4.1/README.md → nonebot_plugin_savepic-0.6.7/PKG-INFO

@@ -1,3 +1,19 @@
+Metadata-Version: 2.1
+Name: nonebot-plugin-savepic
+Version: 0.6.7
+Summary: 保存表情包（语录）与随机出图
+Author-Email: Yan <1964649083@qq.com>
+License: MIT
+Project-URL: homepage, https://github.com/Yan-Zero/nonebot-plugin-savepic
+Requires-Python: <4.0,>=3.11
+Requires-Dist: nonebot2<3.0.0,>=2.4.0
+Requires-Dist: asyncpg<1.0.0,>=0.28.0
+Requires-Dist: nonebot-adapter-onebot<3.0.0,>=2.4.6
+Requires-Dist: numpy<3.0.0,>=2.1.3
+Requires-Dist: httpx<1.0.0,>=0.28.0
+Requires-Dist: nonebot-plugin-alconna>=0.59.4
+Description-Content-Type: text/markdown
+
 <div align="center">
   <a href="https://v2.nonebot.dev/store"><img src="https://github.com/A-kirami/nonebot-plugin-template/blob/resources/nbp_logo.png" width="180" height="180" alt="NoneBotPluginLogo"></a>
   <br>
@@ -29,63 +45,25 @@ _✨ 一个存取图片的插件 ✨_
 重命名表情包，或者修改表情包所属的群域
 
 例如：
+
 ```
 /mvpic -l name.jpg -g waaaaa.gif
 ```
+
 就是把本群的 name.jpg 改成全局名为 waaaaa.gif 的表情包
 
 同理
+
 ```
 /mvpic -g waaaaa.gif -l waaaaa.gif
 ```
+
 就是从全局移到本群（接收到命令的群）
 
 ### 直接发送文件名
 
 发送文件名即可发送表情包
 
-
-## 💿 安装
-
-<details open>
-<summary>使用 nb-cli 安装</summary>
-在 nonebot2 项目的根目录下打开命令行, 输入以下指令即可安装
-
-    nb plugin install nonebot-plugin-savepic
-
-</details>
-
-<details>
-<summary>使用包管理器安装</summary>
-在 nonebot2 项目的插件目录下, 打开命令行, 根据你使用的包管理器, 输入相应的安装命令
-
-<details>
-<summary>pip</summary>
-
-    pip install nonebot-plugin-savepic
-</details>
-<details>
-<summary>pdm</summary>
-
-    pdm add nonebot-plugin-savepic
-</details>
-<details>
-<summary>poetry</summary>
-
-    poetry add nonebot-plugin-savepic
-</details>
-<details>
-<summary>conda</summary>
-
-    conda install nonebot-plugin-savepic
-</details>
-
-打开 nonebot2 项目根目录下的 `pyproject.toml` 文件, 在 `[tool.nonebot]` 部分追加写入
-
-    plugins = ["nonebot_plugin_savepic"]
-
-</details>
-
 ## ⚙️ 配置
 
 在 nonebot2 项目的`.env`文件中添加下表中的必填配置
@@ -94,11 +72,6 @@ _✨ 一个存取图片的插件 ✨_
 |:-----:|:----:|:----:|:----:|
 | savepic_admin | 否 | 无 | 权限用户 |
 | savepic_dir | 否 | savepic | 图片本地保存位置 |
-| simpic_enable | 否 | False | 是否开启基于RNN模型的AI相似度检索功能，如果开启要填写 Pinecone 相关配置 |
-| pinecone_apikey | 否 | 无 | pinecone 的 Key |
-| pinecone_environment | 否 | 无 | pinecone 的 enviroment，是数据库的属性之一 |
-| pinecone_index | 否 | savepic | 同上。 |
-| dashscope_api | 否 | 无 | dashscope 的 APIKey。 用于开启基于语义的相似度检索功能 |
 
 ## 🎉 使用
 

nonebot_plugin_savepic-0.6.7/README.md

@@ -0,0 +1,68 @@
+<div align="center">
+  <a href="https://v2.nonebot.dev/store"><img src="https://github.com/A-kirami/nonebot-plugin-template/blob/resources/nbp_logo.png" width="180" height="180" alt="NoneBotPluginLogo"></a>
+  <br>
+  <p><img src="https://github.com/A-kirami/nonebot-plugin-template/blob/resources/NoneBotPlugin.svg" width="240" alt="NoneBotPluginText"></p>
+</div>
+
+<div align="center">
+
+# nonebot-plugin-savepic
+
+_✨ 一个存取图片的插件 ✨_
+
+</div>
+
+## 📖 介绍
+
+重写自 Fran 的 Savepic
+
+### savepic
+
+保存表情包
+
+### randpic
+
+抽取表情包
+
+### mvpic
+
+重命名表情包，或者修改表情包所属的群域
+
+例如：
+
+```
+/mvpic -l name.jpg -g waaaaa.gif
+```
+
+就是把本群的 name.jpg 改成全局名为 waaaaa.gif 的表情包
+
+同理
+
+```
+/mvpic -g waaaaa.gif -l waaaaa.gif
+```
+
+就是从全局移到本群（接收到命令的群）
+
+### 直接发送文件名
+
+发送文件名即可发送表情包
+
+## ⚙️ 配置
+
+在 nonebot2 项目的`.env`文件中添加下表中的必填配置
+
+| 配置项 | 必填 | 默认值 | 说明 |
+|:-----:|:----:|:----:|:----:|
+| savepic_admin | 否 | 无 | 权限用户 |
+| savepic_dir | 否 | savepic | 图片本地保存位置 |
+
+## 🎉 使用
+
+### 指令表
+
+| 指令 | 权限 | 需要@ | 范围 | 说明 |
+|:-----:|:----:|:----:|:----:|:----:|
+| savepic | 群员 | 否 | 群聊 | 保存图片 |
+| randpic | 群员 | 否 | 全部 | 随机图片 |
+| mvpic | 管理员 | 否 | 群聊 | 重命名图片 |

nonebot_plugin_savepic-0.6.7/nonebot_plugin_savepic/__init__.py

@@ -0,0 +1,171 @@
+from nonebot import on_command
+from nonebot.params import CommandArg, Arg
+from nonebot.adapters.onebot.v11.message import Message as V11Msg
+from nonebot.adapters.onebot.v11.message import MessageSegment as V11Seg
+from nonebot.adapters.onebot.v11.event import GroupMessageEvent
+from nonebot.matcher import Matcher
+from nonebot.plugin import PluginMetadata
+from nonebot.typing import T_State
+from arclet.alconna import Alconna, Args, Option, CommandMeta, Arparma
+from nonebot_plugin_alconna import on_alconna, Image
+from nonebot.internal.adapter import Bot
+
+from .fun import cipr  # noqa: F401
+from .rule import PIC_ADMIN
+from .config import Config, plugin_config
+from .listpic import rkey
+from .command import url_to_image
+from .core.sql import savepic, regexp_pic
+from .core.utils import img2vec
+from .core.error import SameNameException
+from .core.error import SimilarPictureException
+from .core.fileio import write_pic, del_pic
+
+
+__plugin_meta__ = PluginMetadata(
+    name="Savepic",
+    description="表情包保存",
+    usage="""用法:
+/savepic <文件名> <图片>
+/savepic -g <文件名> <全局图片>
+/savepic -d <文件名> 删除图图片
+/randpic <关键词> 随机图片
+<文件名> 发送图片""",
+    config=Config,
+    homepage="https://github.com/Yan-Zero/nonebot-plugin-savepic",
+    type="application",
+    supported_adapters=set(["~onebot.v11"]),
+)
+
+repic = on_command("repic", priority=5)
+spic = on_alconna(
+    Alconna(
+        "savepic",
+        Option("-g", help_text="全局"),
+        Option("-ac", help_text="允许相似碰撞"),
+        Args["filename", str],
+        Args["picture?", Image],
+        meta=CommandMeta(description="保存图片，默认保存到本群"),
+    ),
+    use_cmd_start=True,
+    skip_for_unmatch=False,
+)
+
+
+@repic.handle()
+async def _(bot: Bot, event, args: V11Msg = CommandArg()):
+    reg = args.extract_plain_text().strip()
+    group_id = (
+        "globe"
+        if not isinstance(event, GroupMessageEvent)
+        else f"qq_group:{event.group_id}"
+    )
+    try:
+        if pic := await regexp_pic(reg, group_id):
+            await bot.send(
+                event, V11Msg([V11Seg.text(pic.name), await url_to_image(pic.url)])
+            )
+    except Exception as ex:
+        await repic.finish(f"出错了。{ex}")
+
+
+@spic.handle()
+async def _(
+    bot: Bot,
+    matcher: Matcher,
+    event: GroupMessageEvent,
+    state: T_State,
+    command: Arparma,
+):
+    if not command.matched:
+        await spic.finish(str(command.error_info))
+
+    filename = command.filename
+    if not isinstance(filename, str):
+        await spic.finish("文件名无效")
+
+    if not filename.endswith((".jpg", ".png", ".gif")):
+        filename += ".jpg"
+
+    state["savepiv_group"] = (
+        "globe"
+        if command.g and await PIC_ADMIN(bot, event)
+        else f"qq_group:{event.group_id}"
+    )
+
+    if command.g and not await PIC_ADMIN(bot, event):
+        await spic.send("你的 -g 选项没有用哟")
+
+    state["savepiv_filename"] = filename
+    state["savepiv_ac"] = command.ac is not None
+
+    picture = event.message.get("image")
+    if not picture and event.reply:
+        picture = event.reply.message.get("image")
+    if picture:
+        matcher.set_arg("picture", picture)
+
+
+@spic.got("picture", "图呢？")
+async def _(bot: Bot, state: T_State, event, picture: V11Msg = Arg()):
+    picture = picture.get("image")
+    if not picture:
+        await spic.finish("6，这也不是图啊")
+
+    try:
+        url = await rkey(
+            bot,
+            (
+                picture[0].data["url"]
+                if "url" in picture[0].data
+                else picture[0].data["file"]
+            ),
+        )
+        dir = await write_pic(url, plugin_config.savepic_dir)
+    except Exception as ex:
+        await spic.finish("存图失败。" + "\n" + str(ex))
+
+    try:
+        r = await savepic(
+            filename=state["savepiv_filename"],
+            url=dir,
+            scope=state["savepiv_group"],
+            uploader=f"{bot.adapter.get_name().split(maxsplit=1)[0].lower()}:{event.get_user_id()}",
+            vec=await img2vec(url, state["savepiv_filename"]),
+            collision_allow=state["savepiv_ac"],
+        )
+    except SameNameException:
+        await del_pic(dir)
+        await spic.finish("文件名重复")
+    except SimilarPictureException as ex:
+        if ex.similarity >= 0.999:
+            await spic.finish(
+                V11Msg(
+                    [
+                        V11Seg.text("这图存过了，无法再保存" + "\n\n" + ex.name + "\n"),
+                        await url_to_image(ex.url),
+                    ]
+                )
+            )
+        await del_pic(dir)
+        await spic.finish(
+            V11Msg(
+                [
+                    V11Seg.text(
+                        "存在相似图片"
+                        + "\n\n"
+                        + ex.name
+                        + f"\n(相似度：{'%.4g' % (min(ex.similarity * 100, 100.0))}%)\n"
+                    ),
+                    await url_to_image(ex.url),
+                ]
+            )
+        )
+    except Exception as ex:
+        await del_pic(dir)
+        await spic.finish(f"出错了。{ex}")
+
+    if r:
+        await spic.send(f"保存成功，但是名字为`{r}`")
+    else:
+        await spic.send("保存成功")

nonebot_plugin_savepic-0.6.7/nonebot_plugin_savepic/command.py

@@ -0,0 +1,138 @@
+import traceback
+
+from pathlib import Path
+from nonebot import on_command
+from nonebot.plugin import on_endswith
+from nonebot.params import CommandArg
+from nonebot.adapters import Bot
+from nonebot.adapters import Message
+from nonebot.adapters import Event
+from nonebot.permission import SUPERUSER
+from nonebot.adapters.onebot.v11.event import GroupMessageEvent as V11GME
+from nonebot.adapters.onebot.v11.message import Message as V11Msg
+from nonebot.adapters.onebot.v11.message import MessageSegment as V11Seg
+
+from .listpic import rkey
+from .core.sql import simpic, randpic, countpic, select_pic
+from .core.utils import img2vec
+
+cpic = on_command("countpic", priority=5)
+rpic = on_command("randpic", priority=5)
+s_simpic = on_command("simpic", priority=5)
+pic_listen = on_endswith((".jpg", ".png", ".gif"), priority=50, block=False)
+pic_clear = on_command("pic.clear", permission=SUPERUSER, priority=1, block=True)
+
+
+async def url_to_image(url: str) -> V11Seg:
+    if url.startswith("http"):
+        return V11Seg.image(url)
+    return V11Seg.image(Path(url))
+
+
+@cpic.handle()
+async def _(bot: Bot, event: Event, args: Message = CommandArg()):
+    reg = args.extract_plain_text().strip()
+    group_id = (
+        "globe" if not isinstance(event, V11GME) else f"qq_group:{event.group_id}"
+    )
+    try:
+        await bot.send(event, f"共查找到 {await countpic(reg, group_id)} 张图片。")
+    except Exception as ex:
+        await cpic.finish(f"出错了喵~\n\n{ex}")
+
+
+@pic_listen.handle()
+async def _(bot: Bot, event: Event):
+    name = event.get_plaintext().strip()
+    group_id = (
+        "globe" if not isinstance(event, V11GME) else f"qq_group:{event.group_id}"
+    )
+    try:
+        if url := await select_pic(name, group_id):
+            await pic_listen.send(await url_to_image(url))
+    except Exception as ex:
+        await pic_listen.finish(str(ex))
+
+
+@rpic.handle()
+async def _(bot: Bot, event: Event, args: V11Msg = CommandArg()):
+    name = args.extract_plain_text().strip()
+    group_id = (
+        "globe" if not isinstance(event, V11GME) else f"qq_group:{event.group_id}"
+    )
+    try:
+        pic, t = await randpic(name, group_id, True)
+        if not pic:
+            await rpic.send("404 Not Found.")
+            return
+        await rpic.send(
+            V11Msg(
+                [
+                    V11Seg.text(pic.name + ("\n" + t if t else "")),
+                    await url_to_image(pic.url),
+                ]
+            )
+        )
+    except Exception as ex:
+        with open("error.txt", "w+") as f:
+            f.write("\n")
+            traceback.print_exc(file=f)
+        await rpic.finish(str(ex))
+
+
+@s_simpic.handle()
+async def _(bot: Bot, event: Event, args: Message = CommandArg()):
+    picture = args.get("image")
+    if not picture and hasattr(event, "reply"):
+        picture = event.reply.message.get("image") if event.reply else None  # type: ignore
+        if not picture:
+            picture = event.reply.message.get("mface") if event.reply else None  # type: ignore
+    if not picture:
+        await s_simpic.finish("请发送图片后再使用该指令喵~")
+    try:
+        vec = await img2vec(
+            await rkey(bot, picture[0].data["url"]),
+            title=args.extract_plain_text().strip(),
+        )
+        if vec is None:
+            await s_simpic.finish("图片特征提取失败喵~")
+        group_id = (
+            "globe" if not isinstance(event, V11GME) else f"qq_group:{event.group_id}"
+        )
+        sim, pic = await simpic(vec, group_id)
+    except Exception as ex:
+        await s_simpic.finish(str(ex))
+
+    if pic:
+        ret = []
+        if event.reply:  # type: ignore
+            ret.append(V11Seg.reply(event.reply.message_id))  # type: ignore
+        ret.append(f"{pic.name}\n(相似性：{'%.4g' % (min(sim * 100, 100.0))}%)")
+        ret.append(await url_to_image(pic.url))
+        await s_simpic.send(V11Msg(ret))
+    else:
+        await s_simpic.send("没有找到相似的图片喵~")
+
+
+@pic_clear.handle()
+async def _():
+    # 清理孤儿图片
+    from .core import sql
+
+    if not sql.POOL:
+        await pic_clear.finish("数据库未初始化")
+    await pic_clear.send("开始清理孤儿图片...")
+    img = set(Path("savepic").glob("*"))
+    async with sql.POOL.acquire() as conn, conn.transaction():
+        async for record in conn.cursor("SELECT name, url FROM picdata;"):
+            if not record["url"].startswith("savepic/"):
+                continue
+            p = Path(record["url"])
+            img.remove(p)
+    if img:
+        await pic_clear.send(f"发现 {len(img)} 张孤儿图片，正在删除...")
+        for p in img:
+            p.unlink(missing_ok=True)
+        await pic_clear.send("删除完成！")
+    else:
+        await pic_clear.send("没有发现孤儿图片！")

{nonebot_plugin_savepic-0.4.1 → nonebot_plugin_savepic-0.6.7}/nonebot_plugin_savepic/config.py

@@ -1,6 +1,6 @@
-from pydantic import Field
-from pydantic import BaseModel
+from typing import Optional
 from nonebot import get_plugin_config
+from pydantic import BaseModel
 
 
 class Config(BaseModel):
@@ -10,16 +10,9 @@ class Config(BaseModel):
     savepic_dir: str = "savepic"
     savepic_sqlurl: str
 
-    pinecone_apikey: str
-    pinecone_index: str = "savepic"
-    pinecone_environment: str
-
-    embedding_sqlurl: str
-    openai_apikey: str
-    openai_baseurl: str
-    embedding_model: str = "BAAI/bge-m3"
-    simpic_model: str = Field(default="")
-    p_model_path: str = Field(default="")
+    embedding_key: str
+    embedding_url: str
+    embedding_model: str
 
     notfound_with_jpg: bool = True
     """ randpic 的时候，尝试带 .jpg 再度检索向量 """
@@ -30,9 +23,11 @@ class Config(BaseModel):
     max_page_in_listpic: int = 20
     """ 合并转发中所能显示的最大页数 """
 
-    chat_mode: bool = False
-    ocr_model: str = "gpt-4o-mini"
-    local_sqlite_path: str = Field(default="sqlite+aiosqlite:///./savepic.db")
+    cache_sqlurl: Optional[str] = None
+    """ 额外的只读连接池地址，若不填写则与 savepic_sqlurl 共用 """
+
+    normalize_vector: Optional[str] = None
+    """ 向量归一化，路径指向一个 txt 文件，文件内是均值向量 """
 
 
-plugin_config = get_plugin_config(Config)
+plugin_config: Config = get_plugin_config(Config)

{nonebot_plugin_savepic-0.4.1 → nonebot_plugin_savepic-0.6.7}/nonebot_plugin_savepic/core/error.py

@@ -1,9 +1,10 @@
 class SameNameException(Exception):
-    def __init__(self, name):
+    def __init__(self, name, scope):
         self.name = name
+        self.scope = scope
 
     def __str__(self):
-        return "Name {} already exists".format(self.name)
+        return "Name {} already exists in scope {}".format(self.name, self.scope)
 
 
 class SimilarPictureException(Exception):
@@ -22,3 +23,12 @@ class NoPictureException(Exception):
 
     def __str__(self):
         return "Picture {} not found".format(self.name)
+
+
+class PermissionException(Exception):
+    def __init__(self, name, reason="No permission"):
+        self.name = name
+        self.reason = reason
+
+    def __str__(self):
+        return "No permission to access {}: {}".format(self.name, self.reason)

nonebot_plugin_savepic-0.6.7/nonebot_plugin_savepic/core/fileio.py

@@ -0,0 +1,43 @@
+import httpx
+import hashlib
+import pathlib
+
+
+async def del_pic(url: str | pathlib.Path):
+    if isinstance(url, pathlib.Path):
+        url = url.as_posix()
+    if url.startswith("http"):
+        return
+    if isinstance(url, str):
+        _ = pathlib.Path(url)
+    else:
+        _ = url
+    if _.exists():
+        _.unlink()
+
+
+async def load_pic(url: str) -> bytes:
+    if url.startswith("http"):
+        async with httpx.AsyncClient() as client:
+            resp = await client.get(url)
+            resp.raise_for_status()
+            return resp.content
+
+    if pathlib.Path(url).exists():
+        with open(url, "rb") as f:
+            return f.read()
+    raise Exception(f"不支持的 URL\n{url}")
+
+
+async def write_pic(url: str, des_dir: str | None = None) -> str:
+    if not des_dir:
+        des_dir = "savepic"
+    path = pathlib.Path(des_dir)
+    path.mkdir(parents=True, exist_ok=True)
+
+    byte = await load_pic(url)
+    file = path / hashlib.sha256(byte).hexdigest()
+
+    with open(file, "wb") as f:
+        f.write(byte)
+    return file.as_posix()