client

type Client interface {
	// download / export .torrent file for a torrent in client
	ExportTorrentFile(infoHash string) ([]byte, error)
	GetTorrent(infoHash string) (*Torrent, error)
	// category: "none" is a special value to select uncategoried torrents.
	// stateFilter: _all|_active|_done|_undone, or any state value (possibly with a _ prefix)
	GetTorrents(stateFilter string, category string, showAll bool) ([]*Torrent, error)
	GetTorrentsByContentPath(contentPath string) ([]*Torrent, error)
	AddTorrent(torrentContent []byte, option *TorrentOption, meta map[string]int64) error
	ModifyTorrent(infoHash string, option *TorrentOption, meta map[string]int64) error
	DeleteTorrents(infoHashes []string, deleteFiles bool) error
	PauseTorrents(infoHashes []string) error
	ResumeTorrents(infoHashes []string) error
	RecheckTorrents(infoHashes []string) error
	ReannounceTorrents(infoHashes []string) error
	AddTagsToTorrents(infoHashes []string, tags []string) error
	RemoveTagsFromTorrents(infoHashes []string, tags []string) error
	SetTorrentsSavePath(infoHashes []string, savePath string) error
	PauseAllTorrents() error
	ResumeAllTorrents() error
	RecheckAllTorrents() error
	ReannounceAllTorrents() error
	AddTagsToAllTorrents(tags []string) error
	RemoveTagsFromAllTorrents(tags []string) error
	SetAllTorrentsSavePath(savePath string) error
	GetTags() ([]string, error)
	CreateTags(tags ...string) error
	DeleteTags(tags ...string) error
	// create category if not existed, edit category if already exists
	MakeCategory(category string, savePath string) error
	DeleteCategories(categories []string) error
	GetCategories() ([]*TorrentCategory, error)
	SetTorrentsCatetory(infoHashes []string, category string) error
	SetAllTorrentsCatetory(category string) error
	SetTorrentsShareLimits(infoHashes []string, ratioLimit float64, seedingTimeLimit int64) error
	SetAllTorrentsShareLimits(ratioLimit float64, seedingTimeLimit int64) error
	TorrentRootPathExists(rootFolder string) bool
	GetTorrentContents(infoHash string) ([]*TorrentContentFile, error)
	PurgeCache()
	GetStatus() (*Status, error)
	GetName() string
	GetClientConfig() *config.ClientConfigStruct
	SetConfig(variable string, value string) error
	GetConfig(variable string) (string, error)
	GetTorrentTrackers(infoHash string) (TorrentTrackers, error)
	EditTorrentTracker(infoHash string, oldTracker string, newTracker string, replaceHost bool) error
	AddTorrentTrackers(infoHash string, trackers []string, oldTracker string, removeExisting bool) error
	RemoveTorrentTrackers(infoHash string, trackers []string) error
	// QB only, priority: 0	Do not download; 1	Normal priority; 6	High priority; 7	Maximal priority
	SetFilePriority(infoHash string, fileIndexes []int64, priority int64) error
	Cached() bool
	Close()
}

type ClientCreator func(*RegInfo) (Client, error)

type RegInfo struct {
	Name    string
	Creator func(string, *config.ClientConfigStruct, *config.ConfigStruct) (Client, error)
}

type Status struct {
	FreeSpaceOnDisk           int64 // -1 means unknown
	UnfinishedSize            int64
	UnfinishedDownloadingSize int64
	DownloadSpeed             int64
	UploadSpeed               int64
	DownloadSpeedLimit        int64 // <= 0 means no limit
	UploadSpeedLimit          int64 // <= 0 means no limit
	NoAdd                     bool  // if true, brush and other tasks will NOT add any torrent to client
	NoDel                     bool  // if true, brush and other tasks will NOT delete any torrent from client
}

type Torrent struct {
	InfoHash           string
	Name               string
	TrackerDomain      string // e.g. tracker.m-team.cc
	TrackerBaseDomain  string // e.g. m-team.cc
	Tracker            string
	State              string // simplified state: seeding|downloading|completed|paused|checking|error|unknown
	LowLevelState      string // original state value returned by bt client
	Atime              int64  // timestamp torrent added
	Ctime              int64  // timestamp torrent completed. <=0 if not completed.
	ActivityTime       int64  // timestamp of torrent latest activity (a chunk being downloaded / uploaded)
	Category           string
	SavePath           string
	ContentPath        string
	Tags               []string
	Downloaded         int64
	DownloadSpeed      int64
	DownloadSpeedLimit int64 // -1 means no limit
	Uploaded           int64
	UploadSpeed        int64
	UploadedSpeedLimit int64 // -1 means no limit
	Size               int64 // size of torrent files that selected for downloading
	SizeTotal          int64 // Total size of all file in the torrent (including unselected ones)
	SizeCompleted      int64
	Seeders            int64 // Cnt of seeders (including self client, if it's seeding), returned by tracker
	Leechers           int64
	Meta               map[string]int64
}

type TorrentCategory struct {
	Name     string `json:"name"`
	SavePath string `json:"savePath"`
}

type TorrentContentFile struct {
	Index    int64
	Path     string // full file path
	Size     int64
	Progress float64 // [0, 1]
	Ignored  bool    // true if file is ignored (excluded from downloading)
	Complete bool    // true if file is fullly downloaded
}

type TorrentOption struct {
	Name               string // if not empty, set name of torrent in client to this value
	Category           string
	SavePath           string
	Tags               []string
	RemoveTags         []string // used only in ModifyTorrent
	DownloadSpeedLimit int64
	UploadSpeedLimit   int64
	RatioLimit         float64 // If > 0, will stop seeding after ratio (up/dl) exceeds this value
	SeedingTimeLimit   int64   // If > 0, will stop seeding after be seeded for this time (seconds)
	SkipChecking       bool
	Pause              bool
	Resume             bool // use only in ModifyTorrent, to start a paused torrent
	SequentialDownload bool // qb only
}

type TorrentTracker struct {
	Status string //working|notcontacted|error|updating|disabled|unknown
	Url    string
	Msg    string
}

type TorrentTrackers []TorrentTracker

type TrackerValidity int64

type TrackerValidityInfoStruct = struct {
	Value TrackerValidity
	Name  string
	Desc  string
}