telegram-search-bot

一个支持CJK聊天记录搜索的Telegram Bot

Telegram自带搜索对CJK的支持仅限于整句，不支持关键词（2202年底仍未支持）。本项目通过存储聊天记录，进行数据库查询，解决CJK这类语言的搜索问题。

目录

• 功能
• 所需环境
• 使用方法
  • 创建Bot
  • 镜像运行
  • 指令控制
  • 导入历史记录
  • 限制操作用户
• 提示
• 更新记录
• 贡献者
• License

功能

• 群聊消息记录和多个关键词搜索（可翻页）
• 定位消息位置
• 带限制的命令控制
• 支持多群组查询（判断是否群成员）
• 消息编辑后数据库同步更新

所需环境

• Docker
• Docker Compose
• 外网/代理环境

使用

创建Bot

0. 与@botfather对话按照步骤创建Bot，记录token备用
1. 设置Inline Mode: 选择你的Bot进入Bot Settings，Inline Mode开启，Edit inline placeholder，设置为[keywords] {page}
2. 关闭Privacy mode，选择你的Bot进入Bot Settings，Group Privacy - Turn off
3. 按照喜好设置其他选项，将Bot添加到Group，设置权限读取发送信息

使用镜像运行

0. 支持amd64、arm64

1. 建议新建目录用于存放配置文件和数据库 mkdir tgbot && cd tgbot,

   下载配置文件和功能文件

   wget https://github.com/Taosky/telegram-search-bot/raw/master/.config.json.example

   wget https://github.com/Taosky/telegram-search-bot/raw/master/Caddyfile

   wget https://github.com/Taosky/telegram-search-bot/raw/master/docker-compose.yml

   wget https://github.com/Taosky/telegram-search-bot/raw/master/import_history.py

2. 修改docker-compose.yml, 配置运行模式、Bot Token等，配置特定用户启用停止机器人与删除消息(非必要)

3. 如使用webhook模式，查看Caddyfile进行配置，或手动进行反代设置

4. docker-compose up -d后台执行

群内指令控制

0. 首先要确认是否超级群组(supergroup)（右键消息有copy link选项），人数较多的群组应该会自动升级，手动升级需要将群组类型设置为Public（立即生效，可再改回Private）
1. /start: 在目标群内启用（需管理员/创建者）。
2. @your_bot [keywords] {page}: 用于搜索，@无参数为显示历史消息，此时翻页用* {page}
3. /help: 获取搜索帮助。
4. /chat_id: 获取当前Chat的数字ID
5. /stop: 在目标群内停用记录和搜索功能，消息记录会保存在数据库（需管理员/创建者）
6. /delete: 在目标群已停用的情况下，用于删除数据库中的消息记录（需管理员/创建者）

导入历史记录

0. 导出前确认群组为超级群组(supergroup)，否则导入将提示错误。
1. Telegram桌面客户端，点击群组右上角Export chat history，选择JSON格式(仅文本)
2. python3 import_history.py，输入JSON文件路径

特定用户启用停止机器人与删除消息

0. 复制 .config.json.example 为 .config.json
1. 编辑 .config.json 文件的第二行，将 false 改为 true
2. 按照 json 语法在 group_admins 字段内添加用户的数字 ID

注意，用户仍需在相关群组内为管理员才可以启用、停止机器人与删除消息

提示

• 如遇查询结果为空，可能是TG的Bug导致，需要把机器人踢出群，重新拉进群
• Inline Mode具有缓存效果，故连续重复搜索可能不会加载新的消息
• 修改Inline Mode placeholder需要重启客户端生效
• Inline Mode可以在任意聊天框使用，可以在收藏夹不公开的进行查询（仍需为群成员才可查询）

更新记录

2022-11-26

• 优化历史记录导入方式
• 解决Python Json读入内存爆炸问题

2022-11-23 (#24)

• 一些优化和整活

2022-11-12

• 构建镜像到ghcr.io(#22)
• 一些小改动，完善配置和说明

2022-11-06

• 修复了导入消息链接无法跳转问题

2022-10-31 (#21)

• 支持消息编辑后数据库同步更新

2022-10-30 (#21)

• 支持索引频道、匿名管理消息。
• 修复了一些 BUG

2022-10-24 (#19)

• 优化了在 inline mode下发送 /help 的逻辑
• 更好的权限控制
• 修改了引用消息时引号的用法

贡献者

License

MIT © Taosky