nonebot-plugin-proxy-probe 0.2.2__py3-none-any.whl

nonebot_plugin_proxy_probe/render.py

@@ -0,0 +1,266 @@
+from __future__ import annotations
+
+import base64
+from io import BytesIO
+from pathlib import Path
+
+from PIL import Image, ImageDraw, ImageFont
+
+from .models import CacheState, ProxyRecord
+
+
+FONT_PATH = Path(__file__).resolve().parent / "assets" / "原神字体.ttf"
+MAX_DISPLAY_RESULTS = 50
+IMAGE_WIDTH = 1900
+MARGIN = 42
+ROW_HEIGHT = 58
+COL_WIDTHS = (380, 180, 380, 876)
+COL_HEADERS = ("IP", "端口", "代理后 IP", "代理后属地")
+FOREIGN_ROW_COLOR = "#C0FF02"
+SINGAPORE_ROW_COLOR = "#FFCE46"
+
+
+def get_font(size: int) -> ImageFont.FreeTypeFont | ImageFont.ImageFont:
+    try:
+        return ImageFont.truetype(str(FONT_PATH), size=size)
+    except OSError:
+        return ImageFont.load_default()
+
+
+def fit_text(
+    draw: ImageDraw.ImageDraw,
+    text: str,
+    font: ImageFont.FreeTypeFont | ImageFont.ImageFont,
+    max_width: int,
+) -> str:
+    text = str(text)
+    if draw.textbbox((0, 0), text, font=font)[2] <= max_width:
+        return text
+    suffix = "…"
+    left, right = 0, len(text)
+    while left < right:
+        middle = (left + right + 1) // 2
+        candidate = text[:middle] + suffix
+        if draw.textbbox((0, 0), candidate, font=font)[2] <= max_width:
+            left = middle
+        else:
+            right = middle - 1
+    return text[:left] + suffix
+
+
+def sorted_results(results: list[ProxyRecord]) -> list[ProxyRecord]:
+    def ip_key(item: ProxyRecord) -> tuple[int, int]:
+        parts = item.ip.split(".")
+        numeric = 0
+        if len(parts) == 4 and all(part.isdigit() for part in parts):
+            for part in parts:
+                numeric = numeric * 256 + int(part)
+        return numeric, item.port
+
+    return sorted(results, key=ip_key)
+
+
+def location_row_color(location: str) -> str | None:
+    """新加坡优先高亮；其他非中国属地使用绿色。"""
+    normalized = str(location or "").strip()
+    if not normalized or normalized in {
+        "未知属地",
+        "无法探测代理后地址",
+        "未探测代理后地址",
+    }:
+        return None
+    if "新加坡" in normalized or "Singapore" in normalized:
+        return SINGAPORE_ROW_COLOR
+    if any(
+        keyword in normalized
+        for keyword in ("中国", "香港", "台湾", "澳门")
+    ):
+        return None
+    return FOREIGN_ROW_COLOR
+
+
+def render_cache_image(state: CacheState) -> bytes:
+    visible = sorted_results(state.results)[:MAX_DISPLAY_RESULTS]
+    rows = max(1, len(visible))
+    header_height = 380
+    image_height = header_height + ROW_HEIGHT * (rows + 1) + MARGIN
+    image = Image.new("RGB", (IMAGE_WIDTH, image_height), "#f3f6fb")
+    draw = ImageDraw.Draw(image)
+
+    title_font = get_font(38)
+    info_font = get_font(25)
+    table_header_font = get_font(27)
+    table_font = get_font(25)
+
+    draw.text(
+        (MARGIN, 28),
+        "Clash 代理扫描结果",
+        font=title_font,
+        fill="#172033",
+    )
+    count_text = f"共 {len(state.results)} 条"
+    if len(state.results) > MAX_DISPLAY_RESULTS:
+        count_text += f"（仅显示前 {MAX_DISPLAY_RESULTS} 条）"
+    draw.text(
+        (MARGIN, 92),
+        f"扫描时间：{state.scan_time}    刷新时间：{state.refresh_time}    {count_text}",
+        font=info_font,
+        fill="#344054",
+    )
+
+    operation_names = {"probe": "重新扫描", "refresh": "缓存刷新"}
+    operation = operation_names.get(state.operation, "无")
+    task_line = f"当前任务：{operation} / {state.task_status}"
+    if state.task_total:
+        task_line += f" / {state.task_current}/{state.task_total}"
+    draw.text(
+        (MARGIN, 140),
+        f"本机出站 IP：{state.local_ip}    目标参考 IP：{state.target_ip}",
+        font=info_font,
+        fill="#344054",
+    )
+
+    draw.text(
+        (MARGIN, 188),
+        task_line,
+        font=info_font,
+        fill="#175cd3" if state.running else "#475467",
+    )
+
+    progress = state.progress
+    draw.text(
+        (MARGIN, 236),
+        f"端口扫描：{progress.open_count} open in {progress.scan_completed}",
+        font=info_font,
+        fill="#344054",
+    )
+    draw.text(
+        (MARGIN + 540, 236),
+        f"代理验证：{progress.proxy_count} proxy in {progress.proxy_tested}",
+        font=info_font,
+        fill="#344054",
+    )
+    draw.text(
+        (MARGIN + 1080, 236),
+        f"属地探测：{progress.geo_success} tested in {progress.geo_tested}",
+        font=info_font,
+        fill="#344054",
+    )
+
+    table_left = MARGIN
+    table_top = 305
+    table_right = IMAGE_WIDTH - MARGIN
+    x_positions = [table_left]
+    for width in COL_WIDTHS:
+        x_positions.append(x_positions[-1] + width)
+    x_positions[-1] = table_right
+
+    draw.rounded_rectangle(
+        (
+            table_left,
+            table_top,
+            table_right,
+            table_top + ROW_HEIGHT * (rows + 1),
+        ),
+        radius=12,
+        fill="white",
+        outline="#cfd8e6",
+        width=2,
+    )
+    draw.rectangle(
+        (
+            table_left,
+            table_top,
+            table_right,
+            table_top + ROW_HEIGHT,
+        ),
+        fill="#dbeafe",
+    )
+
+    for index, header in enumerate(COL_HEADERS):
+        left = x_positions[index]
+        right = x_positions[index + 1]
+        bbox = draw.textbbox((0, 0), header, font=table_header_font)
+        text_width = bbox[2] - bbox[0]
+        text_height = bbox[3] - bbox[1]
+        draw.text(
+            (
+                left + (right - left - text_width) / 2,
+                table_top + (ROW_HEIGHT - text_height) / 2 - bbox[1],
+            ),
+            header,
+            font=table_header_font,
+            fill="#172033",
+        )
+
+    if visible:
+        row_values = [
+            (item.ip, str(item.port), item.public_ip, item.location)
+            for item in visible
+        ]
+    else:
+        row_values = [("暂无缓存代理", "", "", "")]
+
+    for row_index, values in enumerate(row_values, start=1):
+        top = table_top + row_index * ROW_HEIGHT
+        row_color = None
+        if visible:
+            row_color = location_row_color(
+                visible[row_index - 1].location
+            )
+        if row_color is not None:
+            draw.rectangle(
+                (table_left, top, table_right, top + ROW_HEIGHT),
+                fill=row_color,
+            )
+        elif row_index % 2 == 0:
+            draw.rectangle(
+                (table_left, top, table_right, top + ROW_HEIGHT),
+                fill="#f8fafc",
+            )
+        for column_index, value in enumerate(values):
+            left = x_positions[column_index]
+            right = x_positions[column_index + 1]
+            padding = 16
+            shown = fit_text(
+                draw,
+                value,
+                table_font,
+                right - left - padding * 2,
+            )
+            bbox = draw.textbbox((0, 0), shown, font=table_font)
+            text_height = bbox[3] - bbox[1]
+            draw.text(
+                (
+                    left + padding,
+                    top + (ROW_HEIGHT - text_height) / 2 - bbox[1],
+                ),
+                shown,
+                font=table_font,
+                fill="#172033",
+            )
+        draw.line(
+            (table_left, top, table_right, top),
+            fill="#e4e7ec",
+            width=1,
+        )
+
+    for x in x_positions[1:-1]:
+        draw.line(
+            (
+                x,
+                table_top,
+                x,
+                table_top + ROW_HEIGHT * (rows + 1),
+            ),
+            fill="#cfd8e6",
+            width=1,
+        )
+
+    output = BytesIO()
+    image.save(output, format="PNG", optimize=True)
+    return output.getvalue()
+
+
+def image_to_base64(image_bytes: bytes) -> str:
+    return "base64://" + base64.b64encode(image_bytes).decode("ascii")

nonebot_plugin_proxy_probe-0.2.2.dist-info/METADATA

@@ -0,0 +1,269 @@
+Metadata-Version: 2.4
+Name: nonebot-plugin-proxy-probe
+Version: 0.2.2
+Summary: 扫描内网 Clash 代理并缓存出口 IP 与属地的 NoneBot2 插件
+Author: lhc
+License: GPL-3.0-or-later
+Requires-Python: >=3.10
+Description-Content-Type: text/markdown
+License-File: LICENSE
+Requires-Dist: nonebot2>=2.3.0
+Requires-Dist: nonebot-adapter-onebot>=2.0.0
+Requires-Dist: nonebot-plugin-localstore>=0.7.0
+Requires-Dist: requests<3,>=2.31
+Requires-Dist: urllib3<3,>=1.26
+Requires-Dist: Pillow>=10.0.0
+Dynamic: license-file
+
+<div>
+    <a href="https://v2.nonebot.dev/store">
+    <img src="https://raw.githubusercontent.com/fllesser/nonebot-plugin-template/refs/heads/resource/.docs/NoneBotPlugin.svg" width="310" alt="logo"></a>
+</div>
+
+## ✨ 代理扫描 ✨
+
+[![LICENSE](https://img.shields.io/github/license/WhyPilotXia/nonebot_plugin_proxy_probe.svg)](./LICENSE)[![pypi](https://img.shields.io/pypi/v/nonebot-plugin-proxy-probe.svg)](https://pypi.python.org/pypi/nonebot-plugin-proxy-probe)[![python](https://img.shields.io/badge/python-3.10+-blue.svg)](https://www.python.org)[![NoneBot](https://img.shields.io/badge/NoneBot-2.x-green.svg)](https://github.com/nonebot/nonebot2)
+
+## 📖 介绍
+
+扫描目标 IPv4 网段中的 Clash HTTP 代理，验证代理可用性，查询代理出口
+IP 与属地，并将结果持久化缓存、渲染为图片的 NoneBot2 插件。
+
+功能特色：
+
+- **三级流水线**：端口扫描、代理验证、出口属地探测同时运行。
+- **后台任务**：扫描和刷新不会阻塞 NoneBot，可随时查看缓存或停止任务。
+- **自动识别网络**：可自动获取本机出站网卡 IPv4 和直连公网 IPv4。
+- **跨平台**：兼容 Windows 与 Linux 的网卡和默认路由识别。
+- **多端口支持**：可同时扫描多个 Clash HTTP 代理端口。
+- **本地缓存**：使用 `nonebot-plugin-localstore` 持久化结果与用户设置。
+- **图片输出**：使用插件自带字体绘制表格，以 Base64 图片发送。
+- **属地高亮**：新加坡和其他非中国属地使用不同底色突出显示。
+
+## 💿 安装
+
+### 使用 nb-cli 安装
+
+在 NoneBot2 项目根目录下执行：
+
+```bash
+nb plugin install nonebot-plugin-proxy-probe
+```
+
+### 使用 pip 安装
+
+```bash
+pip install nonebot-plugin-proxy-probe
+```
+
+使用 `pip` 安装后，在 NoneBot2 项目根目录的 `pyproject.toml` 中加载插件：
+
+```toml
+[tool.nonebot]
+plugins = ["nonebot_plugin_proxy_probe"]
+```
+
+如果已有其他插件，请将 `nonebot_plugin_proxy_probe` 追加到现有
+`plugins` 列表中。
+
+### 本地源码安装
+
+也可以在 NoneBot2 项目环境中安装本仓库：
+
+```bash
+pip install -e .
+```
+
+然后在 `pyproject.toml` 中加载：
+
+```toml
+[tool.nonebot]
+plugins = ["nonebot_plugin_proxy_probe"]
+```
+
+## ⚙️ 配置
+
+所有配置项均为可选项，**必填：否**。可在 NoneBot2 项目的 `.env` 或
+`.env.prod` 中覆盖默认值。
+
+| 配置项 | 必填 | 默认值 | 说明 |
+|:--:|:--:|:--:|:--|
+| `proxy_probe_local_ip` | 否 | (空字符串) | 绑定出站连接的本机 IPv4。留空时自动选择有默认网关的实体网卡。 |
+| `proxy_probe_target_ip` | 否 | (空字符串) | 用于计算扫描网段的参考 IPv4。留空时优先读取 LocalStore 用户设置，否则直连查询自身公网 IPv4。 |
+| `proxy_probe_prefix_length` | 否 | `20` | 扫描网段的 IPv4 前缀长度，默认扫描 `/20`。 |
+| `proxy_probe_ports` | 否 | `[7897,7890]` | 需要扫描和验证的代理端口列表。 |
+| `proxy_probe_connect_timeout` | 否 | `0.35` | TCP 端口连接超时时间，单位秒。 |
+| `proxy_probe_proxy_timeout` | 否 | `5.0` | HTTPS 代理验证超时时间，单位秒。 |
+| `proxy_probe_geo_timeout` | 否 | `5.0` | 出口 IP 与属地接口超时时间，单位秒。 |
+| `proxy_probe_workers` | 否 | `256` | 端口扫描工作线程数。 |
+| `proxy_probe_proxy_workers` | 否 | `256` | 代理验证工作线程数。 |
+| `proxy_probe_geo_workers` | 否 | `256` | 出口 IP 与属地探测工作线程数。 |
+| `proxy_probe_bind_source_ip` | 否 | `true` | 是否将网络连接绑定到选定的本机 IPv4。 |
+| `proxy_probe_test_urls` | 否 | ["https://api.ip.sb/ip","https://cp.cloudflare.com/generate_204","https://www.gstatic.com/generate_204"] | HTTPS 代理验证地址，按列表顺序回退。 |
+| `proxy_probe_exclude_ips` | 否 | `[]` | 扫描时需要排除的 IPv4 地址列表。 |
+
+配置示例：
+
+```dotenv
+proxy_probe_local_ip=
+proxy_probe_target_ip=
+proxy_probe_prefix_length=20
+proxy_probe_ports=[7897]
+proxy_probe_connect_timeout=0.35
+proxy_probe_proxy_timeout=5.0
+proxy_probe_geo_timeout=5.0
+proxy_probe_workers=256
+proxy_probe_proxy_workers=256
+proxy_probe_geo_workers=256
+proxy_probe_bind_source_ip=true
+proxy_probe_test_urls=["https://api.ip.sb/ip","https://cp.cloudflare.com/generate_204","https://www.gstatic.com/generate_204"]
+proxy_probe_exclude_ips=[]
+```
+
+### 自动获取 IP
+
+- `proxy_probe_local_ip` 为空时，插件自动选择有默认网关的实体 IPv4
+  网卡，并排除 Meta、Tailscale、ZeroTier 等常见虚拟接口。
+- `proxy_probe_target_ip` 为空且没有 LocalStore 用户设置时，插件禁用
+  环境代理，绑定选定网卡，直连回退接口查询自身公网 IPv4。
+- 自动成功取得本机内网 IP 与直连公网 IP 后，会给任务发起消息添加
+  表情 `4`。
+
+### 目标 IP 优先级
+
+```text
+LocalStore 用户设置 > proxy_probe_target_ip 环境变量 > 自动探测
+```
+
+如果环境变量和 LocalStore 设置同时存在，插件启动时会输出 warning，
+并使用 LocalStore 中的值。
+
+## 🎉 使用
+
+### 指令表
+
+| 指令 | 权限 | 说明 |
+|:--:|:--:|:--|
+| `/proxy` | 所有用户 | 显示当前缓存结果图片。 |
+| `/proxy -h`、`/proxy --help` | 所有用户 | 显示命令帮助。 |
+| `/proxy -i <IPv4>`、`/proxy --ip <IPv4>` | 所有用户 | 将目标参考 IPv4 持久化到 LocalStore。也支持 `--ip=<IPv4>`。 |
+| `/proxy -p`、`/proxy --probe` | 所有用户 | 在后台重新扫描目标网段，任务开始时添加表情 `427`。 |
+| `/proxy -r`、`/proxy --refresh` | 所有用户 | 刷新缓存代理的可用性、出口 IP 和属地，任务开始时添加表情 `294`。 |
+| `/proxy -s`、`/proxy --stop` | 所有用户 | 停止当前后台任务，保存并输出已有结果。 |
+
+同一时间只允许一个重新扫描或缓存刷新任务运行。任务运行期间仍可使用
+`/proxy` 查看当前缓存和实时进度。
+
+## 🔍 扫描与刷新
+
+### 重新扫描
+
+重新扫描采用动态三级流水线：
+
+1. 扫描目标网段和配置端口。
+2. 开放端口立即进入 HTTPS 代理验证队列。
+3. 确认可用的代理立即进入出口 IP 与属地探测队列。
+
+重新扫描本身已经包含代理和属地刷新，因此任务结束或停止保存部分结果
+时，扫描时间和刷新时间会同时更新。
+
+### 缓存刷新
+
+缓存刷新只处理上一次结果列表：
+
+- 已经无法代理访问 HTTPS 的项目会从结果中移除。
+- 代理仍可用但属地接口全部失败时，项目仍会保留。
+- 查询失败时，代理后 IP 和属地显示为“无法探测代理后地址”。
+
+### 流水线统计
+
+结果图片顶部显示：
+
+```text
+端口扫描：开放端口数 open in 已扫描 IP 数
+代理验证：确认代理数 proxy in 已验证开放端口数
+属地探测：查询成功数 tested in 已查询代理数
+```
+
+例如：
+
+```text
+端口扫描：500 open in 4096
+代理验证：20 proxy in 500
+属地探测：20 tested in 20
+```
+
+## 🎨 图片输出
+
+表格包含四列：
+
+| IP | 端口 | 代理后 IP | 代理后属地 |
+|:--:|:--:|:--:|:--|
+
+- 每个 `IP:端口` 固定占一行，不折行。
+- 图片最多显示前 50 条，LocalStore 中仍保存全部结果。
+- 新加坡属地整行使用 `#FFCE46`。
+- 其他非中国属地整行使用 `#C0FF02`。
+- 中国大陆、香港、台湾、澳门以及无法判断的属地保持默认底色。
+
+## 📦 数据与缓存
+
+插件在导入 LocalStore 前执行：
+
+```python
+require("nonebot_plugin_localstore")
+```
+
+数据保存在 `nonebot-plugin-localstore` 为本插件分配的数据目录：
+
+- `proxy_cache.json`：扫描结果、扫描/刷新时间、流水线进度和任务状态。
+- `settings.json`：通过 `/proxy -i` 或 `/proxy --ip` 保存的目标参考 IP。
+
+JSON 使用临时文件替换方式原子写入，降低异常退出导致缓存损坏的概率。
+Bot 重启后不会尝试恢复旧线程，未完成任务会标记为因重启中止。
+
+## 🧐 图片示例
+
+### `/proxy`
+
+<img width="486" height="503" alt="proxy command" src="https://github.com/user-attachments/assets/d4d4f917-8c16-4a28-8714-da5e30759c01" />
+
+<img width="1280" height="1378" alt="proxy result" src="https://github.com/user-attachments/assets/fe7af0c4-e7cf-4f0c-bcb8-a9181d12b2d2" />
+
+### `/proxy -h`
+
+<img width="520" height="329" alt="proxy help" src="https://github.com/user-attachments/assets/ce9804da-3c93-4667-9450-48fb7e6d64c9" />
+
+### `/proxy -r`
+
+<img width="444" height="533" alt="proxy refresh" src="https://github.com/user-attachments/assets/c3888e1a-8fbc-4fcb-b8ea-544c3ed461cc" />
+
+<img width="1900" height="1988" alt="proxy refresh result" src="https://github.com/user-attachments/assets/aae2675d-9da3-423d-a707-c6f78023048e" />
+
+## 🗂️ 项目结构
+
+```text
+nonebot_plugin_proxy_probe/
+├── __init__.py        # 插件元数据与命令模块加载
+├── cache.py           # LocalStore 结果缓存和用户设置持久化
+├── commands.py        # /proxy 命令解析与 OneBot 事件处理
+├── config.py          # NoneBot/Pydantic 配置模型
+├── manager.py         # 后台任务互斥、停止、状态更新与结果发送
+├── models.py          # 代理结果、流水线进度和缓存模型
+├── probe.py           # 网卡识别、端口扫描、代理验证和属地探测
+├── render.py          # Pillow 表格绘制与 Base64 图片转换
+└── assets/
+    └── 原神字体.ttf   # 图片渲染字体
+```
+
+## 🧩 兼容性
+
+- Python `3.10+`
+- NoneBot2 `2.3.0+`
+- OneBot v11 适配器
+- Windows / Linux
+- 依赖 `nonebot-plugin-localstore`
+
+## 📄 License
+
+本项目遵循仓库中的 [LICENSE](./LICENSE) 文件。

nonebot_plugin_proxy_probe-0.2.2.dist-info/RECORD

@@ -0,0 +1,14 @@
+nonebot_plugin_proxy_probe/__init__.py,sha256=4wZ9U0yka_MtwYAdM9OX5WPjT10-IUv4DHbO3qmMel0,799
+nonebot_plugin_proxy_probe/cache.py,sha256=vXhgtQgcsbbDLiq-VphEQ2bgp4YucxGGtHdgIYKrLp4,2371
+nonebot_plugin_proxy_probe/commands.py,sha256=S9CxRzkMQI3Ndoi_lm2Ey5kWniCW6HxkqU1zRXIsRlY,3627
+nonebot_plugin_proxy_probe/config.py,sha256=NwCEhCqutrlsILv1jTBOkBWMMTW9a6lSD89qXAxceB0,1061
+nonebot_plugin_proxy_probe/manager.py,sha256=OexRt05GlDdmLYlJhZZwVhTwgdfya_mjWPaTx51hzwQ,13753
+nonebot_plugin_proxy_probe/models.py,sha256=VjTNiiG2KOdWdE7jLoj1oBy8xKnTkEQK9jreelP5ouM,5015
+nonebot_plugin_proxy_probe/probe.py,sha256=DO2fR1aS1CYg96PY2ZE7Ysqrx61N5YYGcjimLIG9T4E,36060
+nonebot_plugin_proxy_probe/render.py,sha256=zCk84dtySfKbxYzIQnZFaboP4bTP3AIX2pvnf7JBU-g,7801
+nonebot_plugin_proxy_probe/assets/原神字体.ttf,sha256=SKjDhqZmPjPnqowBym6Es5-dPg-eA9ZGjsF4ROTkjC0,11459780
+nonebot_plugin_proxy_probe-0.2.2.dist-info/licenses/LICENSE,sha256=IwGE9guuL-ryRPEKi6wFPI_zOhg7zDZbTYuHbSt_SAk,35823
+nonebot_plugin_proxy_probe-0.2.2.dist-info/METADATA,sha256=59-uW-oPu7BkTmqy3fwe-dmL8L6ORkjm6dU1MmFyI08,10560
+nonebot_plugin_proxy_probe-0.2.2.dist-info/WHEEL,sha256=aeYiig01lYGDzBgS8HxWXOg3uV61G9ijOsup-k9o1sk,91
+nonebot_plugin_proxy_probe-0.2.2.dist-info/top_level.txt,sha256=AKbV1wHrvmoYggPMRb4ncSBosJuw0kAGGZLWWeG6QwM,27
+nonebot_plugin_proxy_probe-0.2.2.dist-info/RECORD,,

nonebot_plugin_proxy_probe-0.2.2.dist-info/WHEEL

@@ -0,0 +1,5 @@
+Wheel-Version: 1.0
+Generator: setuptools (82.0.1)
+Root-Is-Purelib: true
+Tag: py3-none-any
+