internal

package
v1.0.0-rc.55 Latest Latest
Warning

This package is not in the latest version of its module.

Go to latest
Published: Nov 9, 2026 License: MIT Imports: 40 Imported by: 0

Documentation

Index

Constants

View Source
const (
	SourceKindRSS           = "rss"            // RSS 自动推送
	SourceKindRSSNotify     = "rss_notify"     // RSS 通知里的「立即下载」按钮
	SourceKindManual        = "manual"         // 网页里手动推送
	SourceKindApp           = "app"            // App API(含 MCP、AI 助手)
	SourceKindSubscribe     = "subscribe"      // 媒体订阅
	SourceKindBrush         = "brush"          // 刷流
	SourceKindQbitCompat    = "qbit_compat"    // qB 兼容入口
	SourceKindTransfer      = "transfer"       // 转移做种、辅种(复用已有数据)
	SourceKindDownloaderAdd = "downloader_add" // 下载器页面直接加任务
	SourceKindFreeWatch     = "free_watch"     // 等免费再下:免费了才推
)

推送入口(AdmissionPolicy.SourceKind)

View Source
const (
	// SnapshotMaxAge 是要求免费时资格快照最多能旧多久(另外还不能早于本次尝试的开始)
	SnapshotMaxAge = 15 * time.Minute
	// MinSafetyMargin 是要求免费时免费剩余时间至少要超过的量
	MinSafetyMargin = 5 * time.Minute
)
View Source
const SkipRecheckHours = 6

SkipRecheckHours defines how long a skipped non-free torrent should remain skipped before re-checking This allows torrents marked as non-free to be re-checked after becoming free during promotions

Variables

View Source
var ErrRSSInvalidURL = errors.New("RSS 链接不对")

ErrRSSInvalidURL 是 RSS 链接写得不对(不是 http(s) 链接)。

View Source
var ErrRSSPlaceholder = errors.New("RSS 地址是示例里的占位地址")

ErrRSSPlaceholder 是 RSS 地址还是示例里的占位地址(hdsky.xxx 这类):它永远取不到,不去请求。

View Source
var ErrSiteCapacityExceeded = errors.New("站点做种容量已满")

ErrSiteCapacityExceeded 表示推送会让站点做种总量超过 SeedingCapacityGB,或读不到做种总量时 fail-closed 拒绝。

Functions

func DBTime

func DBTime(t time.Time) time.Time

DBTime 是写进库里、会在 SQL 里和别的时间比较的时间:一律换成进程本地时区。SQLite 按文本存时间、 带各自的时区,文本比较不认时区,同一列混着 UTC 与本地时间会差出几个小时(与 time.Now() 写的列保持一致)。

func DefaultSafetyMargin

func DefaultSafetyMargin() time.Duration

DefaultSafetyMargin 是按全局免费结束提前量算出的安全余量(读不到设置时按 0,即 5 分钟)。

func FetchAndDownloadFreeRSS

func FetchAndDownloadFreeRSS[T models.ResType](ctx context.Context, siteName models.SiteGroup, m PTSiteInter[T], rssCfg models.RSSConfig) error

FetchAndDownloadFreeRSS 旧的泛型版本(已废弃,请使用 FetchAndDownloadFreeRSSUnified) Deprecated: Use FetchAndDownloadFreeRSSUnified instead for new implementations

func FetchAndDownloadFreeRSSUnified added in v0.2.0

func FetchAndDownloadFreeRSSUnified(ctx context.Context, m UnifiedPTSite, rssCfg models.RSSConfig) error

FetchAndDownloadFreeRSSUnified 使用 UnifiedPTSite 接口获取并下载免费 RSS 种子

func FetchRSSFeed

func FetchRSSFeed(ctx context.Context, siteID, rawURL string) (*gofeed.Feed, error)

FetchRSSFeed 取站点 siteID 的一个 RSS 并解析。全局设置的「站点代理」开着时按 RSS 绑定的站点判定走不走代理, 关着(或者 siteID 为空)时和以前一样按环境变量(HTTP_PROXY/HTTPS_PROXY)。

func FreshPromotion

func FreshPromotion(ctx context.Context, site v2.Site, siteName, torrentID string, attemptStart time.Time) *v2.PromotionSnapshot

FreshPromotion 推送前按站点详情读一次免费资格,只认 attemptStart 以后取得的数据(缓存详情的驱动先刷新)。 站点不支持读详情、读取失败时返回 nil:要求免费的推送会被门禁拒绝。

func GetAllSupportedSiteGroups added in v0.2.0

func GetAllSupportedSiteGroups() []models.SiteGroup

func GetDownloaderForRSS added in v0.2.0

func GetDownloaderForRSS(rssCfg models.RSSConfig) (downloader.Downloader, error)

GetDownloaderForRSS 根据 RSS 配置获取下载器 优先级:RSS 指定的下载器 > 默认下载器 返回下载器实例和下载器信息

func GetGlobalDownloaderManager added in v0.6.0

func GetGlobalDownloaderManager() *downloader.DownloaderManager

func HRSeedTimeH

func HRSeedTimeH(siteName string, def *v2.SiteDefinition, sizeBytes int64) int

HRSeedTimeH 是一个种子的 H&R 做种要求(小时):按站点定义算,定义里没有时用站点设置里填的「H&R 做种要求」, 都没有时为 0(要求未知),见 v2.ResolveHRSeedTimeH。def 可以为 nil。

func IsSiteGroupSupported added in v0.2.0

func IsSiteGroupSupported(siteGroup models.SiteGroup) bool

func LogPromotionLookupFailure

func LogPromotionLookupFailure(siteName, torrentID string, err error)

LogPromotionLookupFailure 记下推送前读详情失败(不写种子编号以外的内容,错误里不含密钥)。

func PendingForGate

func PendingForGate(ctx context.Context, dl downloader.Downloader, name string) (int64, error)

PendingForGate 读下载器 dl(预留记在名字 name 下,见 ReserveTorrent)的「下载中待占用」,同时丢掉这台下载器上、 种子已经出现在下载器里的预留:两件事出自同一份种子列表,丢掉的预留在这份待占用里一定已经算上了(下完的已经占了磁盘), 不会少算。下载器给不出种子列表(没实现 downloader.PendingSnapshotter)时只读待占用,预留等过期或清理监控清零。 调用方持有 PushMutex。

func ProcessTorrentsWithDBUpdate

func ProcessTorrentsWithDBUpdate(
	ctx context.Context,
	qbitClient *qbit.QbitClient,
	dirPath, category, tags string,
	siteName models.SiteGroup,
) error

func ProcessTorrentsWithDownloaderByRSS added in v0.2.0

func ProcessTorrentsWithDownloaderByRSS(
	ctx context.Context,
	rssCfg models.RSSConfig,
	dirPath, category, tags string,
	siteName models.SiteGroup,
	revalidate DetailRevalidator,
) error

ProcessTorrentsWithDownloaderByRSS 根据 RSS 配置选择下载器,推送这条 RSS 暂存目录里属于它的种子。 revalidate 用于推送前重新读详情(要求免费、承诺到期暂停而记录里的资格不是这一轮读到的时候);为空时只能等下一轮取详情。

func PushMutex added in v0.28.1

func PushMutex() *sync.Mutex

PushMutex 返回全局推送互斥锁。调用方应在 disk-check 前 Lock, 推送结束后 Unlock。注意:锁的范围是单实例进程级,多实例部署需要外部协调。

func RSSAttemptStart

func RSSAttemptStart(ctx context.Context) (time.Time, bool)

RSSAttemptStart 是 WithRSSAttempt 记下的开始时间。

func RegisterTorrentScheduler added in v0.3.0

func RegisterTorrentScheduler(f TorrentScheduleFunc)

func RemovalMutex

func RemovalMutex() *sync.Mutex

RemovalMutex 返回删除锁。自动删种、做种竞争度、刷流删种、免费结束时的删除持锁后重新读下载器里的种子,按最新的标签复查保护才执行; 网页的「保留 / 取消保留」持锁加、去标签。所以保留先完成时,之后的删除一定看得到标签;删除先完成时,保留会发现种子已经不在。 与 PushMutex 不嵌套持有(持着一把时不去拿另一把),锁里只做「重新读 → 复查 → 执行」这一段。

func SafetyMarginFor

func SafetyMarginFor(advanceMinutes int) time.Duration

SafetyMarginFor 按免费结束提前量(分钟)给出安全余量:不少于 5 分钟,不超过一小时。

func ScheduleTorrentForMonitoring added in v0.3.0

func ScheduleTorrentForMonitoring(torrent models.TorrentInfo)

func SetGlobalDownloaderManager added in v0.6.0

func SetGlobalDownloaderManager(dm *downloader.DownloaderManager)

func SetRSSNotifier added in v0.31.0

func SetRSSNotifier(n RSSNotifier)

func SetSubscriptionOffer

func SetSubscriptionOffer(f SubscriptionOfferFunc)

SetSubscriptionOffer 登记订阅的入口(启动时由 cmd 接上;为 nil 时 RSS 不交给订阅)。

func SiteHRSeedTimeH

func SiteHRSeedTimeH(siteName string) int

SiteHRSeedTimeH 读站点设置里用户填的 H&R 做种要求(小时);没填、查不到、库不可用时为 0。

func SnapshotColumns

func SnapshotColumns(s v2.PromotionSnapshot) map[string]any

SnapshotColumns 是一份资格快照对应的种子记录列(每次读到站点详情都整套写入,不留旧值)。

func SnapshotFromDetail

func SnapshotFromDetail(siteName models.SiteGroup, torrentID string, d *v2.TorrentItem, requestedAt time.Time) v2.PromotionSnapshot

SnapshotFromDetail 是 detailSnapshot 的导出形式(RSS 通知按钮等在别的包里取详情的入口用)。

func SwapPushDownloaderFactory

func SwapPushDownloaderFactory(f func(models.DownloaderSetting) (downloader.Downloader, error)) (restore func())

SwapPushDownloaderFactory 只给其他包的测试用:把推送用的下载器实例换成假实现,返回还原函数。 刷流等调用 PushTorrentToDownloader 的后台任务靠它在测试里走真实的磁盘与站点容量闸门。

func WithRSSAttempt

func WithRSSAttempt(ctx context.Context, start time.Time) context.Context

WithRSSAttempt 记下这一轮 RSS 的开始时间:取详情与推送两个阶段共用,推送阶段只认这一轮读到的资格。

Types

type AdmissionDecision

type AdmissionDecision struct {
	Allow bool
	// Status 是不放行时的状态
	Status PushStatus
	// Monitor:承诺了到期暂停且结束时间可信,要登记免费结束监控(先暂停加入,记账成功后再开始)
	Monitor bool
	// KeepPaused:承诺了到期暂停但结束时间不可信,只能暂停加入,不能自动开始
	KeepPaused bool
	// Reason 是给日志、页面与 last_error 的说明
	Reason string
}

AdmissionDecision 是门禁的结论。

func CheckAdmission

func CheckAdmission(p AdmissionPolicy, snap *v2.PromotionSnapshot, now time.Time) AdmissionDecision

CheckAdmission 是加入下载器之前的最后一道纯函数判定。

type AdmissionPolicy

type AdmissionPolicy struct {
	// RequireFree 为 true 时只有本次尝试取得、仍在免费期内的快照才放行
	RequireFree bool
	// PauseOnFreeEnd 为 true 时承诺免费结束时暂停(FreeEndDelete 为 true 时删除)
	PauseOnFreeEnd bool
	// FreeEndDelete 是免费结束时删除而不是暂停(来自 RSS 的选择),只在 PauseOnFreeEnd 为 true 时生效,推送时写进种子记录
	FreeEndDelete bool
	// SafetyMargin 是免费剩余时间至少要超过的量(见 SafetyMarginFor)
	SafetyMargin time.Duration
	// SourceRSSID 是这个推送所属的 RSS(RSS 自动推送与通知按钮)
	SourceRSSID *uint
	// SourceKind 是推送入口,见 SourceKind* 常量
	SourceKind string
	// AttemptStart 是本次尝试开始的时间(RSS 是这一轮的开始)。RequireFree 时必须给出,快照不能早于它
	AttemptStart time.Time
	// Clock 是调用方的时钟(刷流、订阅在测试里用假时钟);为空时用 time.Now
	Clock func() time.Time
}

AdmissionPolicy 是一次推送的入场策略。零值是「不要求免费、不承诺暂停」,即明确的手动推送。

func (AdmissionPolicy) Now

func (p AdmissionPolicy) Now() time.Time

Now 是门禁判断用的当前时间。

type DetailRevalidator

type DetailRevalidator func(ctx context.Context, rec models.TorrentInfo) (*v2.TorrentItem, error)

DetailRevalidator 按记录里的种子编号重新取一次站点详情(推送前验证资格用)。ctx 里带着 v2.WithFreshAfter。

func RevalidateFromSite

func RevalidateFromSite(site UnifiedPTSite) DetailRevalidator

RevalidateFromSite 返回用站点详情接口重新验证资格的函数。种子编号用记录里不含密钥的 DetailID,没有时用 TorrentID。

type DiskBudget added in v0.18.0

type DiskBudget struct {
	// contains filtered or unexported fields
}

DiskBudget 跟踪推送了、但下载器还没算进去的种子要占的磁盘空间。

多个并发 RSS worker 推送前先预留,防止它们同时观察到相同的 OS 空闲空间而并发越界(Issue #299)。 每份预留记着推给了哪个下载器、哪个种子:下次检查这个下载器时(见 PendingForGate),已经出现在下载器里的 种子丢掉预留——没下完的剩余体积已经算在「下载中待占用」里,下完的已经占了磁盘,再预留就算了两遍。 一直没出现的(例如种子的 hash 对不上)过 reservationTTL 丢掉;清理监控每轮还会全部清零(Reset)。

典型用法(持有 PushMutex):

pending, err := internal.PendingForGate(ctx, dl, name) // 顺带丢掉已经出现在下载器里的
effective := free - pending - budget.Reserved()
release := budget.ReserveTorrent(name, hash, size)
if pushErr != nil {
    release() // 推送失败时归还
}

func GetDiskBudget added in v0.18.0

func GetDiskBudget() *DiskBudget

GetDiskBudget 返回全局磁盘预算实例。

func (*DiskBudget) EffectiveFreeBytes added in v0.28.1

func (b *DiskBudget) EffectiveFreeBytes(actualFreeBytes int64) int64

EffectiveFreeBytes 同 EffectiveFreeGB 但返回字节数。供下游做更精细比较。

func (*DiskBudget) EffectiveFreeGB added in v0.18.0

func (b *DiskBudget) EffectiveFreeGB(actualFreeBytes int64) float64

EffectiveFreeGB 计算"扣除已预留后"的有效可用空间(GB)。 actualFreeBytes 通常来自 downloader.GetClientFreeSpace。下溢钳位为 0。

func (*DiskBudget) Release added in v0.18.0

func (b *DiskBudget) Release(bytes int64)

Release 按体积归还(配 Reserve 用):从最近的预留扣起,扣完为止,不会扣成负数。

func (*DiskBudget) Reserve added in v0.18.0

func (b *DiskBudget) Reserve(bytes int64) int64

Reserve 预留 bytes,不记下载器与种子(只能等过期或清零)。bytes <= 0 视为 no-op。返回预留后的合计。

func (*DiskBudget) ReserveTorrent

func (b *DiskBudget) ReserveTorrent(downloaderName, hash string, bytes int64) (release func())

ReserveTorrent 为推给下载器 downloaderName 的种子 hash 预留 bytes,返回归还用的函数:推送失败时调用,调用多次也只归还一次; 推送成功的不用调(种子出现在下载器里、过期或清零时丢掉)。bytes <= 0 时什么也不记。

func (*DiskBudget) Reserved added in v0.18.0

func (b *DiskBudget) Reserved() int64

Reserved 返回还没过期的预留合计。

func (*DiskBudget) Reset added in v0.18.0

func (b *DiskBudget) Reset()

Reset 清零(清理监控每轮开始时调用,重新校准)。

func (*DiskBudget) Seen

func (b *DiskBudget) Seen(downloaderName string, hashes map[string]struct{}) (freed int64, n int)

Seen 丢掉下载器 downloaderName 上、种子已经出现在下载器里的预留(hashes 是下载器里所有种子的 info hash,小写), 返回丢掉的字节数与份数。

type DownloaderInfo added in v0.3.0

type DownloaderInfo struct {
	ID        uint
	Name      string
	AutoStart bool
	NeedClose bool
}

GetDownloaderForRSS 根据 RSS 配置获取下载器 DownloaderInfo 下载器附加信息,用于记录推送来源

func GetDownloaderForRSSAndSiteWithInfo added in v0.34.0

func GetDownloaderForRSSAndSiteWithInfo(rssCfg models.RSSConfig, siteName string) (downloader.Downloader, *DownloaderInfo, error)

GetDownloaderForRSSAndSiteWithInfo 根据 RSS 配置 + 站点名解析下载器。

优先级(新):

  1. rssCfg.DownloaderID(RSS 行级覆盖)
  2. SiteSetting.DownloaderID(站点绑定,issue #373 修复点)
  3. is_default=true(兜底)

siteName 为空时退化为 GetDownloaderForRSSWithInfo 的旧行为。

func GetDownloaderForRSSWithInfo added in v0.3.0

func GetDownloaderForRSSWithInfo(rssCfg models.RSSConfig) (downloader.Downloader, *DownloaderInfo, error)

GetDownloaderForRSSWithInfo 根据 RSS 配置获取下载器及其信息(无站点上下文)。 优先级:RSS.DownloaderID > is_default。**不查站点绑定** —— 仅用于无站点 信息可用的旧调用点(CLI、cmd/rss 等)。新代码请用 GetDownloaderForRSSAndSiteWithInfo。

type PTSiteInter

type PTSiteInter[T models.ResType] interface {
	GetTorrentDetails(item *gofeed.Item) (*models.APIResponse[T], error)
	IsEnabled() bool
	DownloadTorrent(url, title, downloadDir string) (string, error)
	MaxRetries() int
	RetryDelay() time.Duration
	SendTorrentToDownloader(ctx context.Context, rssCfg models.RSSConfig) error
	Context() context.Context
}

PTSiteInter 旧的泛型接口(已废弃,请使用 UnifiedPTSite) Deprecated: Use UnifiedPTSite instead for new implementations

type PushMedia

type PushMedia struct {
	Type   string
	TMDBID int
	Season int
}

PushMedia 是推送时说明的条目。Type 是 movie 或 tv;Season 是剧集的季(电影不记)。

type PushStatus

type PushStatus string

PushStatus 是推送结果的机器可判定状态(§8.1)。

const (
	PushStatusPushed            PushStatus = "pushed"
	PushStatusPushedPaused      PushStatus = "pushed_paused"
	PushStatusMonitorDegraded   PushStatus = "pushed_monitor_degraded"
	PushStatusDuplicate         PushStatus = "skipped_duplicate"
	PushStatusHeldFreeUnknown   PushStatus = "held_free_unknown"
	PushStatusRejectedNotFree   PushStatus = "rejected_not_free"
	PushStatusRejectedExpired   PushStatus = "rejected_free_expired"
	PushStatusRejectedStale     PushStatus = "rejected_free_stale"
	PushStatusRejectedPlacement PushStatus = "rejected_active_placement"
	PushStatusRejectedDisk      PushStatus = "rejected_disk_space"
	PushStatusRejectedTooLarge  PushStatus = "rejected_too_large"
	PushStatusRejectedCapacity  PushStatus = "rejected_site_capacity"
	PushStatusFailed            PushStatus = "failed"
)

func (PushStatus) IsFreeRejection

func (s PushStatus) IsFreeRejection() bool

IsFreeRejection 报告状态是不是免费资格门禁的拒绝(不是磁盘、容量这类暂时问题)。

type PushTorrentMeta

type PushTorrentMeta struct {
	SizeBytes   int64
	HasHR       bool
	HRSeedTimeH int
	IsFree      bool
	FreeLevel   string
	FreeEndTime *time.Time
}

PushTorrentMeta 是推送时一并写进 TorrentInfo 的种子信息。H&R 与体积会被自动清理的 H&R 保护用到 (scheduler/cleanup_monitor.go 的 getHRInfoMap 按 has_hr、hr_seed_time_h、torrent_size 判断)。 IsFree、FreeLevel、FreeEndTime 只在没有 Snapshot 时用来生成记录用的快照。

type PushTorrentRequest added in v0.2.0

type PushTorrentRequest struct {
	SiteID      string // 站点ID (如 hdsky, mteam)
	TorrentID   string // 种子ID
	TorrentData []byte // 种子文件数据
	Title       string // 种子标题
	Category    string // 分类
	Tags        string // 标签
	SavePath    string // 保存路径(可选)
	// ForceSavePath 要下载器照 SavePath 放(qBittorrent 另外传 autoTMM=false):订阅与按条目推送「按条目建子目录」时用
	ForceSavePath bool
	DownloaderID  uint // 下载器ID
	// Source 写入 TorrentInfo.DownloadSource(如 brush);为空时是 manual_push。
	Source string
	// Meta 是调用方已经知道的种子信息(刷流从搜索结果里带来);为空时不覆盖库里已有的值。
	Meta *PushTorrentMeta
	// ReuseExistingData 用于转移做种与辅种:数据已经在盘上。强制暂停添加(校验完才开始),
	// 跳过磁盘预留,站点容量闸门照常(辅种记录里的原种子还在这台下载器里时不占容量,见 siteSeedingUsage);
	// 不写种子记录,成功后由调用方更新。
	ReuseExistingData bool
	// IMDbID、DoubanID 是调用方已经知道的外部编号(刷流、订阅从搜索结果带来);为空的不覆盖库里已有的值。
	IMDbID   string
	DoubanID string
	// Media 是调用方说明的条目(订阅推送、网页上按条目推送):合法的写进种子记录、覆盖旧值,整理入库按它整理;
	// 为空或不合法时不动库里的值。RSS、刷流、辅种、qB 兼容入口不带
	Media *PushMedia
	// AddPaused 要求以暂停状态添加(qB 兼容入口的 paused/stopped);下载器本身设成不自动开始时照样暂停。
	AddPaused bool
	// Rename 是加进下载器以后显示的名字(qB 的 rename;Transmission 没有这个选项,忽略)。
	Rename string
	// UpLimitKBs、DlLimitKBs 是调用方要的限速(KB/s,0 表示不限),和站点设置的限速取更严的。
	UpLimitKBs int
	DlLimitKBs int

	// Policy 是这次推送的入场策略(docs/design/free-expiry-safety.md)。零值是明确的手动推送:不要求免费、不承诺暂停。
	Policy AdmissionPolicy
	// Snapshot 是这次推送依据的资格快照;要求免费时必须是本次尝试取得的(见 CheckAdmission)。
	// 为空时用 Meta 里的优惠信息(只用于记录与是否需要暂停加入,不能当作要求免费的凭据)。
	Snapshot *v2.PromotionSnapshot
	// AdoptExisting:下载器里已经有这个种子时照样记账、按策略登记监控(RSS 暂存推送用);否则只返回跳过。
	AdoptExisting bool
	// KeepRecord:种子记录由调用方维护(RSS),不覆盖标题、标签、分类与来源。
	KeepRecord bool
}

PushTorrentRequest 推送种子请求参数

type PushTorrentResult added in v0.2.0

type PushTorrentResult struct {
	Success     bool
	Skipped     bool // 是否跳过(如已存在)
	TorrentHash string
	Message     string
	// Status 是机器可判定的结果(见 PushStatus*)
	Status PushStatus
}

PushTorrentResult 推送种子结果

func PushTorrentToDownloader added in v0.2.0

func PushTorrentToDownloader(ctx context.Context, req PushTorrentRequest) (*PushTorrentResult, error)

PushTorrentToDownloader 将种子推送到下载器:资格门禁、磁盘与站点容量闸门、加入、记账与免费结束监控登记都在这里。 RSS 暂存推送用同一个实现(pushTorrent),只是带着已经连好的下载器。

type RSSFetchError

type RSSFetchError struct {
	Message string
	Err     error
}

RSSFetchError 是取 RSS 失败:Message 是给人看的说明(不带地址的查询串),Err 是原来的错误(errors.Is 用)。

func (*RSSFetchError) Error

func (e *RSSFetchError) Error() string

func (*RSSFetchError) Unwrap

func (e *RSSFetchError) Unwrap() error

type RSSFilteredNotice added in v0.31.0

type RSSFilteredNotice struct {
	RSS       *models.RSSConfig
	Torrent   *v2.TorrentItem
	Rule      *models.FilterRule
	SiteName  string
	TorrentID string
}

RSSFilteredNotice is the payload for the 'filtered' RSS notification path. Mirror of app.RSSFilteredEvent but defined here to avoid the internal → internal/app import cycle. Bridged by rssNotifierAdapter in cmd/web.go.

type RSSItemNotice added in v0.31.0

type RSSItemNotice struct {
	RSS       *models.RSSConfig
	FeedItem  *gofeed.Item
	SiteName  string
	TorrentID string
}

RSSItemNotice is the minimal payload the RSS pipeline needs to fire an "all" notification — purposely dependency-light so internal does not import internal/app (which would create a cycle via scheduler).

type RSSNotifier added in v0.31.0

type RSSNotifier interface {
	NotifyNewItem(ctx context.Context, ev RSSItemNotice) error
	NotifyFilteredItem(ctx context.Context, ev RSSFilteredNotice) error
}

RSSNotifier is the structural contract internal/app/rssNotifier satisfies. The concrete adapter lives in cmd/web.go and bridges this minimal type to app.RSSItemEvent before delegating to the real app.RSSNotifier.

type SubscriptionOfferFunc

type SubscriptionOfferFunc func(site string, item v2.TorrentItem)

SubscriptionOfferFunc 把 RSS 取到详情的种子交给订阅(实现不能阻塞:订阅自己排队处理)。

type TorrentDetailForTest added in v0.2.0

type TorrentDetailForTest struct {
	Title     string // 种子标题(优先使用中文名)
	Tag       string // 种子标签/副标题
	IsFree    bool   // 是否免费
	SizeBytes int64  // 种子大小(详情里的,没有时用 RSS 附件的长度;都没有是 0)
	// DetailMissing 是详情没取到:标题与标签按 RSS 条目里的,免费状态不知道(按非免费算)
	DetailMissing bool
}

TorrentDetailForTest 用于测试的种子详情

func GetTorrentDetailForTest added in v0.2.0

func GetTorrentDetailForTest(ctx context.Context, siteName models.SiteGroup, item *gofeed.Item) (*TorrentDetailForTest, error)

GetTorrentDetailForTest 获取种子详情用于过滤规则测试 根据站点类型调用对应的 API 获取完整的种子信息

type TorrentScheduleFunc added in v0.3.0

type TorrentScheduleFunc func(torrent models.TorrentInfo)

type UnifiedPTSite added in v0.2.0

type UnifiedPTSite interface {
	// GetTorrentDetails 获取种子详情,返回统一的 TorrentItem
	GetTorrentDetails(item *gofeed.Item) (*v2.TorrentItem, error)
	// IsEnabled 检查站点是否启用
	IsEnabled() bool
	// DownloadTorrent 下载种子文件,返回 torrent hash
	DownloadTorrent(url, title, downloadDir string) (string, error)
	// MaxRetries 返回最大重试次数
	MaxRetries() int
	// RetryDelay 返回重试间隔
	RetryDelay() time.Duration
	// SendTorrentToDownloader 发送种子到下载器
	SendTorrentToDownloader(ctx context.Context, rssCfg models.RSSConfig) error
	// Context 返回上下文
	Context() context.Context
	// SiteGroup 返回站点分组标识
	SiteGroup() models.SiteGroup
}

UnifiedPTSite 统一的 PT 站点接口(非泛型) 新增站点应使用此接口,无需创建新的实现类

type UnifiedSiteImpl added in v0.2.0

type UnifiedSiteImpl struct {
	// contains filtered or unexported fields
}

UnifiedSiteImpl 统一站点实现 使用 site/v2 的 Driver 模式,无需为每个站点创建单独的实现

func NewUnifiedSiteImpl added in v0.2.0

func NewUnifiedSiteImpl(ctx context.Context, siteGroup models.SiteGroup) (*UnifiedSiteImpl, error)

func (*UnifiedSiteImpl) Context added in v0.2.0

func (u *UnifiedSiteImpl) Context() context.Context

Context 返回上下文

func (*UnifiedSiteImpl) DownloadTorrent added in v0.2.0

func (u *UnifiedSiteImpl) DownloadTorrent(url, title, downloadDir string) (string, error)

DownloadTorrent 下载种子文件,返回 torrent hash

func (*UnifiedSiteImpl) GetTorrentDetails added in v0.2.0

func (u *UnifiedSiteImpl) GetTorrentDetails(item *gofeed.Item) (*v2.TorrentItem, error)

GetTorrentDetails 获取种子详情,返回统一的 TorrentItem

func (*UnifiedSiteImpl) GetTorrentDetailsContext

func (u *UnifiedSiteImpl) GetTorrentDetailsContext(ctx context.Context, item *gofeed.Item) (*v2.TorrentItem, error)

GetTorrentDetailsContext 按调用方的 ctx 取详情:取消、超时与 v2.WithFreshAfter(只用这之后取得的数据)都传到驱动。

func (*UnifiedSiteImpl) IsEnabled added in v0.2.0

func (u *UnifiedSiteImpl) IsEnabled() bool

IsEnabled 检查站点是否启用

func (*UnifiedSiteImpl) MaxRetries added in v0.2.0

func (u *UnifiedSiteImpl) MaxRetries() int

MaxRetries 返回最大重试次数

func (*UnifiedSiteImpl) RetryDelay added in v0.2.0

func (u *UnifiedSiteImpl) RetryDelay() time.Duration

RetryDelay 返回重试间隔

func (*UnifiedSiteImpl) SendTorrentToDownloader added in v0.6.0

func (u *UnifiedSiteImpl) SendTorrentToDownloader(ctx context.Context, rssCfg models.RSSConfig) error

SendTorrentToDownloader 发送种子到下载器

func (*UnifiedSiteImpl) SiteGroup added in v0.2.0

func (u *UnifiedSiteImpl) SiteGroup() models.SiteGroup

SiteGroup 返回站点分组标识

Directories

Path Synopsis
Package apitoken 管理 API 令牌(路线图 M12):给 App、MCP、qB 兼容入口与 Servarr 兼容入口用,网页登录仍然只认 session。
Package apitoken 管理 API 令牌(路线图 M12):给 App、MCP、qB 兼容入口与 Servarr 兼容入口用,网页登录仍然只认 session。
Package assistant 是 pt-tools 内置的 AI 助手(路线图 M19):经 OpenAI 兼容的 Chat Completions 接口(官方 openai-go) 调大模型,工具是每次运行在进程内连上的 MCP 服务(internal/mcp 的同一套工具,经 App API v1 执行)。
Package assistant 是 pt-tools 内置的 AI 助手(路线图 M19):经 OpenAI 兼容的 Chat Completions 接口(官方 openai-go) 调大模型,工具是每次运行在进程内连上的 MCP 服务(internal/mcp 的同一套工具,经 App API v1 执行)。
Package backup 做 pt-tools 数据的备份与恢复(媒体中心方案 M0)。
Package backup 做 pt-tools 数据的备份与恢复(媒体中心方案 M0)。
Package cloakdriver provides Go bindings for CloakBrowser-Manager REST API and CDP automation.
Package cloakdriver provides Go bindings for CloakBrowser-Manager REST API and CDP automation.
gazelle
Package gazelle implements the Gazelle-schema CloakBrowser driver (T13).
Package gazelle implements the Gazelle-schema CloakBrowser driver (T13).
mtorrent
Package mtorrent implements the mTorrent (M-Team) CloakBrowser driver.
Package mtorrent implements the mTorrent (M-Team) CloakBrowser driver.
nexusphp
Package nexusphp implements the NexusPHP-schema CloakBrowser driver.
Package nexusphp implements the NexusPHP-schema CloakBrowser driver.
transport
Package transport 把 CloakBrowser 的各架构驱动接成登录探测的后备通道(sitelogin.Transport)。
Package transport 把 CloakBrowser 的各架构驱动接成登录探测的后备通道(sitelogin.Transport)。
unit3d
Package unit3d implements the Unit3D-schema CloakBrowser driver.
Package unit3d implements the Unit3D-schema CloakBrowser driver.
Package cookiecloud 从自建的 CookieCloud 服务取回加密的 Cookie,在本地解密,按站点地址挑出 pt-tools 已配置站点的 Cookie。
Package cookiecloud 从自建的 CookieCloud 服务取回加密的 Cookie,在本地解密,按站点地址挑出 pt-tools 已配置站点的 Cookie。
Package dlassistant 是下载器助手:给缺站点标签的种子补标签、批量替换 tracker 地址、找出 tracker 报告 未注册或不存在的失效种子。
Package dlassistant 是下载器助手:给缺站点标签的种子补标签、批量替换 tracker 地址、找出 tracker 报告 未注册或不存在的失效种子。
Package extension implements the pending-actions queue for browser extension polling.
Package extension implements the pending-actions queue for browser extension polling.
Package filter provides pattern matching and filtering functionality for RSS items.
Package filter provides pattern matching and filtering functionality for RSS items.
Package freewatch 是「等免费再下」(媒体中心 M2b):记下一个现在不免费的种子要推到哪里,后台定时读它现在的优惠, 免费了才推送(照常过免费门禁、磁盘与站点容量闸门,免费结束时暂停),等到期了还没免费就放弃。
Package freewatch 是「等免费再下」(媒体中心 M2b):记下一个现在不免费的种子要推到哪里,后台定时读它现在的优惠, 免费了才推送(照常过免费门禁、磁盘与站点容量闸门,免费结束时暂停),等到期了还没免费就放弃。
Package fsutil 读本机磁盘的剩余空间(媒体中心 M8 的首页存储与系统体检)。
Package fsutil 读本机磁盘的剩余空间(媒体中心 M8 的首页存储与系统体检)。
Package health 是系统体检(媒体中心 M8):一次检查 TMDB、站点、下载器、媒体服务器、路径映射、媒体库、磁盘、NAS、时间、备份与密钥, 每项给出状态、说明与怎么修。
Package health 是系统体检(媒体中心 M8):一次检查 TMDB、站点、下载器、媒体服务器、路径映射、媒体库、磁盘、NAS、时间、备份与密钥, 每项给出状态、说明与怎么修。
Package home 是首页(媒体中心 M8):同时取各块的数据,一块出错不影响别的;另算待处理、存储与状态行。
Package home 是首页(媒体中心 M8):同时取各块的数据,一块出错不影响别的;另算待处理、存储与状态行。
Package iyuu 是 IYUU 辅种接口的客户端。
Package iyuu 是 IYUU 辅种接口的客户端。
MIT License Copyright (c) 2025 pt-tools
MIT License Copyright (c) 2025 pt-tools
Package mcp 是 pt-tools 的 MCP(Model Context Protocol)服务(路线图 M14):工具定义、权限检查与写操作的审计。
Package mcp 是 pt-tools 的 MCP(Model Context Protocol)服务(路线图 M14):工具定义、权限检查与写操作的审计。
media
bangumi
Package bangumi 从 Bangumi(bgm.tv)取动画的中文简介、评分与每一集的中文标题(刮削时补充 TMDB 的数据),以及探索页的番剧日历。
Package bangumi 从 Bangumi(bgm.tv)取动画的中文简介、评分与每一集的中文标题(刮削时补充 TMDB 的数据),以及探索页的番剧日历。
cachectl
Package cachectl 是媒体数据来源(TMDB、豆瓣、Bangumi、Fanart.tv、OMDb)的响应缓存共用的开关: 显式重新刮削时不读缓存,直接问来源要现在的数据(取到的照样写进缓存,替换旧的)。
Package cachectl 是媒体数据来源(TMDB、豆瓣、Bangumi、Fanart.tv、OMDb)的响应缓存共用的开关: 显式重新刮削时不读缓存,直接问来源要现在的数据(取到的照样写进缓存,替换旧的)。
csf
Package csf 是 ChineseSubFinder(自动下载中文字幕的工具)的外部接口客户端:整理出新视频以后交给它下载字幕。
Package csf 是 ChineseSubFinder(自动下载中文字幕的工具)的外部接口客户端:整理出新视频以后交给它下载字幕。
douban
Package douban 从豆瓣取电影与剧集(一季)的简介和评分,刮削时补充 TMDB 的数据。
Package douban 从豆瓣取电影与剧集(一季)的简介和评分,刮削时补充 TMDB 的数据。
epgroup
Package epgroup 按 TMDB 的剧集组换算季与集。
Package epgroup 按 TMDB 的剧集组换算季与集。
fanart
Package fanart 从 Fanart.tv 取电影与剧集的图片:高清 Logo、clearart、横幅、横版海报、碟片、海报、背景与季海报。
Package fanart 从 Fanart.tv 取电影与剧集的图片:高清 Logo、clearart、横幅、横版海报、碟片、海报、背景与季海报。
meta
Package meta 解析 PT 种子的标题与副标题:中英文名、年份、类型、季与集(含范围、「全 N 集」「第 1-10 集」)、 分辨率、来源、编码、HDR、音轨、制作组、版本,以及中字、国语、粤语等标记。
Package meta 解析 PT 种子的标题与副标题:中英文名、年份、类型、季与集(含范围、「全 N 集」「第 1-10 集」)、 分辨率、来源、编码、HDR、音轨、制作组、版本,以及中字、国语、粤语等标记。
metadata
Package metadata 是刮削用的元数据:与来源无关的电影、剧集、季、集与图片,各个来源(TMDB、豆瓣、Bangumi、 Fanart.tv、OMDb)的适配,以及按媒体库的设置把几个来源的数据合在一起(每一项记下来自哪个来源)。
Package metadata 是刮削用的元数据:与来源无关的电影、剧集、季、集与图片,各个来源(TMDB、豆瓣、Bangumi、 Fanart.tv、OMDb)的适配,以及按媒体库的设置把几个来源的数据合在一起(每一项记下来自哪个来源)。
omdb
Package omdb 从 OMDb(omdbapi.com)按 IMDb 编号取评分与分级:IMDb 评分与人数、烂番茄、Metacritic。
Package omdb 从 OMDb(omdbapi.com)按 IMDb 编号取评分与分级:IMDb 评分与人数、烂番茄、Metacritic。
organize
Package organize 是整理入库服务:种子下载完成后识别出电影或剧集,按媒体库的模板与整理方式放进库里, 写 NFO 与图片,通知媒体服务器扫描,发入库通知。
Package organize 是整理入库服务:种子下载完成后识别出电影或剧集,按媒体库的模板与整理方式放进库里, 写 NFO 与图片,通知媒体服务器扫描,发入库通知。
recognize
Package recognize 是媒体识别服务:套用识别词、解析标题,再到 TMDB 找对应的条目 (有 IMDb 编号时直接查找,否则按中英文名和年份搜索打分),支持按 TMDB 编号手动纠正。
Package recognize 是媒体识别服务:套用识别词、解析标题,再到 TMDB 找对应的条目 (有 IMDb 编号时直接查找,否则按中英文名和年份搜索打分),支持按 TMDB 编号手动纠正。
scrape
Package scrape 为整理进媒体库的电影与剧集写 Kodi 格式的 NFO(Emby、Jellyfin、Plex 的 NFO 插件都认), 并下载海报、背景、Logo 等图片。
Package scrape 为整理进媒体库的电影与剧集写 Kodi 格式的 NFO(Emby、Jellyfin、Plex 的 NFO 插件都认), 并下载海报、背景、Logo 等图片。
server
Package server 是媒体服务器的客户端:Emby、Jellyfin 与 Plex。
Package server 是媒体服务器的客户端:Emby、Jellyfin 与 Plex。
serverindex
Package serverindex 是媒体服务器索引:把服务器里的电影、剧与集全量同步进 media_server_items(拉全以后在一个事务里写, 没拉到的打删除标记、90 天后删行),同步时对 pt-tools 整理过、服务器里没有了的写待处理问题(media_issues 的 server_removed),并提供查询:条目在哪台服务器里、一季的哪些集在服务器里、算作已入库的集、问题列表。
Package serverindex 是媒体服务器索引:把服务器里的电影、剧与集全量同步进 media_server_items(拉全以后在一个事务里写, 没拉到的打删除标记、90 天后删行),同步时对 pt-tools 整理过、服务器里没有了的写待处理问题(media_issues 的 server_removed),并提供查询:条目在哪台服务器里、一季的哪些集在服务器里、算作已入库的集、问题列表。
subscribe
Package subscribe 是订阅:按电影或剧集的一季找资源(RSS 拉到的种子与定时主动搜索),按质量档案挑、推送到下载器, 剧集按 TMDB 的分集找缺的集;洗版时接着找更好的版本,入库后替换旧文件;豆瓣想看定时建订阅。
Package subscribe 是订阅:按电影或剧集的一季找资源(RSS 拉到的种子与定时主动搜索),按质量档案挑、推送到下载器, 剧集按 TMDB 的分集找缺的集;洗版时接着找更好的版本,入库后替换旧文件;豆瓣想看定时建订阅。
tmdb
Package tmdb 是 TMDB v3 接口的客户端:搜索电影与剧集、按 IMDb 编号查找、取详情。
Package tmdb 是 TMDB v3 接口的客户端:搜索电影与剧集、按 IMDb 编号查找、取详情。
transfer
Package transfer 是整理入库的文件操作:从种子的文件里挑出要整理的视频与字幕、按模板算出库里的路径, 再用硬链接、复制、软链接或移动放进媒体库。
Package transfer 是整理入库的文件操作:从种子的文件里挑出要整理的视频与字幕、按模板算出库里的路径, 再用硬链接、复制、软链接或移动放进媒体库。
words
Package words 套用识别词:解析标题之前屏蔽或替换文字,解析之后按规则偏移集数。
Package words 套用识别词:解析标题之前屏蔽或替换文字,解析之后按规则偏移集数。
Package nas 是首页「NAS 概览」与设置页「NAS 监控」的数据层(首页 NAS 概览 H2):来源类型的注册表、地址与传输规则、 证书钉住、本机来源与采集器。
Package nas 是首页「NAS 概览」与设置页「NAS 监控」的数据层(首页 NAS 概览 H2):来源类型的注册表、地址与传输规则、 证书钉住、本机来源与采集器。
adapter/bark
Package bark 是 Bark(iOS 推送)出站通道:POST {server}/push,JSON 里带 device_key;返回 code 为 200 才算成功。
Package bark 是 Bark(iOS 推送)出站通道:POST {server}/push,JSON 里带 device_key;返回 code 为 200 才算成功。
adapter/dingtalk
Package dingtalk 是钉钉群自定义机器人出站通道。
Package dingtalk 是钉钉群自定义机器人出站通道。
adapter/feishu
Package feishu 是飞书(Lark)群自定义机器人出站通道。
Package feishu 是飞书(Lark)群自定义机器人出站通道。
adapter/ntfy
Package ntfy 是 ntfy 出站通道:按 JSON 发布,POST 到服务器根地址 {topic, title, message, priority, click}; 可选 access token(Bearer)或用户名密码(Basic)。
Package ntfy 是 ntfy 出站通道:按 JSON 发布,POST 到服务器根地址 {topic, title, message, priority, click}; 可选 access token(Bearer)或用户名密码(Basic)。
adapter/outbound
Package outbound 是只出站的通知适配器(Bark、Server 酱、ntfy、钉钉、飞书、企业微信群机器人)共用的发送工具。
Package outbound 是只出站的通知适配器(Bark、Server 酱、ntfy、钉钉、飞书、企业微信群机器人)共用的发送工具。
adapter/serverchan
Package serverchan 是 Server 酱出站通道。
Package serverchan 是 Server 酱出站通道。
adapter/telegram
Package telegram implements the notify.Channel adapter for Telegram bots using mymmrac/telego with long-polling.
Package telegram implements the notify.Channel adapter for Telegram bots using mymmrac/telego with long-polling.
tmpl
Package tmpl 是通知的模板引擎:Go 的 text/template,加上一组受控的函数与防护。
Package tmpl 是通知的模板引擎:Go 的 text/template,加上一组受控的函数与防护。
Package redact 遮住要交给外部的文本里可能带的凭证:App API 的错误信息、AI 助手存下来与发给各入口的会话内容。
Package redact 遮住要交给外部的文本里可能带的凭证:App API 的错误信息、AI 助手存下来与发给各入口的会话内容。
Package remote 是远程访问(路线图 M15)的协议与主机端:手机 App 扫码配对以后,经直连 WebSocket 或 relay 调用这台 pt-tools 的 App API v1。
Package remote 是远程访问(路线图 M15)的协议与主机端:手机 App 扫码配对以后,经直连 WebSocket 或 relay 调用这台 pt-tools 的 App API v1。
relayserver
Package relayserver 是 relay 的 Go 自建版(路线图 M16):只做转发,看不到明文。
Package relayserver 是 relay 的 Go 自建版(路线图 M16):只做转发,看不到明文。
relaytest
Package relaytest 是 relay 的一致性测试(黑盒):Go 自建版与 Cloudflare 版跑同一套用例, 对着一个已经起好的 relay(ws:// 或 wss:// 地址)连主机与客户端,只看线上的行为。
Package relaytest 是 relay 的一致性测试(黑盒):Go 自建版与 Cloudflare 版跑同一套用例, 对着一个已经起好的 relay(ws:// 或 wss:// 地址)连主机与客户端,只看线上的行为。
testhost command
Command testhost 是手机 App(apps/mobile)互通测试用的主机:真正的 internal/remote 主机端(直连入口与 relay 客户端), App API 换成固定的回应,加一台进程内的 Go relay(relayserver)。
Command testhost 是手机 App(apps/mobile)互通测试用的主机:真正的 internal/remote 主机端(直连入口与 relay 客户端), App API 换成固定的回应,加一台进程内的 Go relay(relayserver)。
Package reseed 实现 IYUU 辅种:把下载器里已经下完的种子的 info hash 交给 IYUU 查询,找出其他站点上数据相同的种子, 从站点下载种子文件、核对 info hash 与文件列表后,暂停加入同一台下载器(保存路径用原种子的),校验到 100% 才开始做种。
Package reseed 实现 IYUU 辅种:把下载器里已经下完的种子的 info hash 交给 IYUU 查询,找出其他站点上数据相同的种子, 从站点下载种子文件、核对 info hash 与文件列表后,暂停加入同一台下载器(保存路径用原种子的),校验到 100% 才开始做种。
Package schedule 算定时的下次时间:每天、每隔几天、每周、每月、cron 表达式与一次(追剧的主动搜索与定时 AI 任务共用)。
Package schedule 算定时的下次时间:每天、每隔几天、每周、每月、cron 表达式与一次(追剧的主动搜索与定时 AI 任务共用)。
Package transfer 实现转移做种:把下载器里已经下完的种子搬到另一个下载器继续做种,数据不动。
Package transfer 实现转移做种:把下载器里已经下完的种子搬到另一个下载器继续做种,数据不动。

Jump to

Keyboard shortcuts

? : This menu
/ : Search site
f or F : Jump to
y or Y : Canonical URL