refactor: update configuration file structure and improve comments for clarity

client/middleware/retry/retry.go

@@ -5,7 +5,6 @@ import (
 	"fmt"
 
 	"github.com/charmbracelet/log"
-	"github.com/go-faster/errors"
 	"github.com/gotd/td/bin"
 	"github.com/gotd/td/telegram"
 	"github.com/gotd/td/tg"
@@ -37,7 +36,8 @@ func (r retry) Handle(next tg.Invoker) telegram.InvokeFunc {
 					retries++
 					continue
 				}
-				return errors.Wrap(err, "retry middleware skip")
+				// retry middleware skip
+				return err
 			}
 
 			return nil

config.example.toml

@@ -1,69 +1,34 @@
-#创建文件时，若需要保留中文注释，请务必确保本文件编码为 UTF-8 ，否则会无法读取。
-workers = 4 # 同时下载文件数
-retry = 3   # 下载失败重试次数
-threads = 4 # 单个任务下载最大线程数
-stream = false # 使用stream模式, 详情请查看文档
+# 创建文件时，若需要保留中文注释，请务必确保本文件编码为 UTF-8 ，否则会无法读取。
+# 更详细的配置请在 https://sabot.unv.app/deployment/configuration 查看
+workers = 4    # 同时下载文件数
+retry = 3      # 下载失败重试次数
+threads = 4    # 单个任务下载使用的最大线程数
+stream = false # 使用流式传输模式, 建议仅在硬盘空间十分有限时使用.
 
 [telegram]
 # Bot Token
-# 更换 Bot Token 后请删除数据库文件和 session.db
+# 更换 Bot Token 后请删除会话数据库文件 (默认路径为 data/session.db )
 token = ""
 # Telegram API 配置, 若不配置也可运行, 将使用默认的 API ID 和 API HASH
 # 推荐使用自己的 API ID 和 API HASH (https://my.telegram.org)
 # app_id = 1025907
 # app_hash = "452b0359b988148995f22ff0f4229750"
-
-# 初始化超时时间, 单位: 秒
-timeout = 60
-# flood_retry = 5
-# rpc_retry = 5
-
 [telegram.proxy]
 # 启用代理连接 telegram, 只支持 socks5
 enable = false
 url = "socks5://127.0.0.1:7890"
 
-# 用户列表
-[[users]]
-# telegram user id
-id = 114514
-# 使用黑名单模式，开启后下方留空以使用所有存储，反之则为白名单，白名单请在下方输入允许的存储名
-blacklist = true
-# 将列表留空并开启黑名单模式以允许使用所有存储，此处示例为黑名单模式，用户 114514 可使用所有存储
-storages = []
-
-[[users]]
-id = 123456
-blacklist = false  # 使用白名单模式，此时，用户123456 仅可使用下方列表中的存储
-# 此时该用户只能使用名为 本机1 的存储
-storages = ["本机1"]
-
 # 存储列表
 [[storages]]
 # 标识名, 需要唯一
 name = "本机1"
-# 存储类型, 目前可用: local, alist, webdav, minio
+# 存储类型, 目前可用: local, alist, webdav, minio, telegram
 type = "local"
 # 启用存储
 enable = true
 # 文件保存根路径
 base_path = "./downloads"
 
-[[storages]]
-name = "MyAlist"
-type = "alist"
-enable = false  #记得启用
-base_path = '/'
-url = 'https://alist.com'
-username = 'admin'
-password = 'password'
-# alist token 刷新时间 
-# 86400--1天   604800--7天   1296000--15天   2592000--30天   15552000--180天
-token_exp = 86400  
-# alist 可直接使用 token 登录, 此时 username, password, token_exp 将被忽略
-# 请自行在 alist 侧配置合理的 token 过期时间
-# token = ""
-
 [[storages]]
 name = "MyWebdav"
 type = "webdav"
@@ -73,28 +38,17 @@ url = 'https://example.com/dav'
 username = 'username'
 password = 'password'
 
-[[storages]]
-name = "MyMinio"
-type = "minio"
-enable = true
-endpoint = 'play.min.io'
-use_ssl = true
-access_key_id = 'Q3AM3UQ867SPQQA43P2F'
-secret_access_key = 'zuf+tfteSlswRu7BJ86wekitnifILbZam1KYY3TG'
-bucket_name = 'saveanybot'
-base_path = '/path/telegram'
-
-[[storages]]
-name = "mychannel"
-type = "telegram"
-enable = true
-chat_id = 1820371480
-
-# [temp]
-# # 下载文件临时目录, 请不要在此目录下存放任何其他文件
-# base_path = "cache/"
-
-# [db]
-# path = "data/data.db" # 数据库文件路径
-# session = "data/session.db"
+# 用户列表
+[[users]]
+# telegram user id
+id = 114514
+# 存储过滤列表, 元素为存储标识名.
+# 将该列表留空并开启黑名单过滤模式以允许使用所有存储，此处示例为黑名单模式，用户 114514 可使用所有存储
+storages = []
+# 使用列表过滤黑名单模式，反之则为白名单，白名单请在列表中指定可用的存储.
+blacklist = true
 
+[[users]]
+id = 123456
+storages = ["本机1"]
+blacklist = false  # 使用白名单模式，此时，用户 123456 仅可使用标识名为 '本地1' 的存储

docs/content/zh/deployment/configuration/_index.md

@@ -51,9 +51,20 @@ Stream 模式对于磁盘空间有限的部署环境十分有用, 但也有一
 - `app_id`, `app_hash`: Telegram API ID & Hash, 在 [Telegram API](https://my.telegram.org/apps) 创建应用获取, 若不提供则使用默认值.
 - `flood_retry`: Flood 控制重试次数, 默认为 5.
 - `rpc_retry`: RPC 请求重试次数, 默认为 5.
-- `proxy`: 代理配置, 可选项.
+- `proxy`: 代理配置, 可选.
   - `enable`: 是否启用代理.
   - `url`: 代理地址, 只支持 `socks5://`
+- `userbot`: userbot 配置, 可选.
+  - `enable`: 启用 userbot 集成, 需要登录用户账号, 此时请务必使用自己的 api id & hash.
+  - `session`: userbot 会话文件路径, 默认为 `data/usersession.db`.
+
+{{< hint warning >}}
+启用 userbot 集成后, bot 可以下载私密频道和群组的文件, 但具有无法避免的账号被封禁的风险.
+<br />
+并且, 由于上游依赖问题, 该功能不稳定, 会出现获取文件失败的情况.
+<br />
+开启 userbot 集成后第一次启动 bot 时需要通过终端交互输入手机号, 2FA 和验证码, 如果你使用 docker 部署, 请进入容器内执行相关操作.
+{{< /hint >}}
 
 ```toml
 [telegram]
@@ -65,6 +76,9 @@ rpc_retry = 5
 [telegram.proxy]
 enable = false
 url = "socks5://127.0.0.1:7890"
+[telegram.userbot]
+enable = false
+session = "data/usersession.db"
 ```
 
 ### 存储端列表

docs/content/zh/usage/_index.md

@@ -26,7 +26,6 @@ Bot 接受两种消息: 文件和链接.
 
 在开启静默模式之前, 需要使用 `/storage` 命令设置默认保存位置.
 
-
 ## 存储规则
 
 允许你为 Bot 在上传文件到存储时设置一些重定向规则, 用于自动整理所保存的文件.
@@ -37,6 +36,7 @@ Bot 接受两种消息: 文件和链接.
 
 1. FILENAME-REGEX
 2. MESSAGE-REGEX
+3. IS-ALBUM
 
 添加规则的基本语法:
 
@@ -64,4 +64,18 @@ FILENAME-REGEX (?i)\.(mp4|mkv|ts|avi|flv)$ MyAlist /视频
 
 ### MESSAGE-REGEX
 
-同上, 但是是根据消息本身的文本内容正则匹配
+同上, 但是是根据消息本身的文本内容正则匹配
+
+### IS-ALBUM
+
+匹配相册消息 (media group), 规则内容只能为 `true` 或 `false`.
+
+规则中的路径若使用 "NEW-FOR-ALBUM" , 则表示为该组消息新建一个文件夹来存储它们. 见: https://github.com/krau/SaveAny-Bot/issues/87
+
+例如:
+
+```
+IS-ALBUM true MyWebdav NEW-FOR-ALBUM
+```
+
+这将会把以 media group 形式发送的消息保存到名为 MyWebdav 的存储下, 并为每个相册新建一个文件夹(由第一个文件生成)来存储它们.

storage/telegram/telegram.go

@@ -5,8 +5,11 @@ import (
 	"fmt"
 	"io"
 	"path"
+	"strconv"
+	"strings"
 	"time"
 
+	"github.com/duke-git/lancet/v2/convertor"
 	"github.com/gabriel-vasile/mimetype"
 	"github.com/gotd/td/telegram/message"
 	"github.com/gotd/td/telegram/message/styling"
@@ -70,9 +73,17 @@ func (t *Telegram) Save(ctx context.Context, r io.Reader, storagePath string) er
 	if tctx == nil {
 		return fmt.Errorf("failed to get telegram context")
 	}
-	peer := tctx.PeerStorage.GetInputPeerById(t.config.ChatID)
+	chatID := t.config.ChatID
+	if after, ok0 := strings.CutPrefix(convertor.ToString(chatID), "-100"); ok0 {
+		cid, err := strconv.ParseInt(after, 10, 64)
+		if err != nil {
+			return fmt.Errorf("failed to parse chat ID: %w", err)
+		}
+		chatID = cid
+	}
+	peer := tctx.PeerStorage.GetInputPeerById(chatID)
 	if peer == nil {
-		return fmt.Errorf("failed to get input peer for chat ID %d", t.config.ChatID)
+		return fmt.Errorf("failed to get input peer for chat ID %d", chatID)
 	}
 	mtype, err := mimetype.DetectReader(rs)
 	if err != nil {