cardigann

type Caps struct {
	// CategoryMappings maps a site category id to a Newznab category.
	CategoryMappings []CategoryMapping
	Modes            map[string][]string
	AllowRawSearch   bool
}

type CatalogEntry struct {
	ID        string `json:"id"`
	File      string `json:"file"`
	Installed bool   `json:"installed"`
	// UpdateAvailable is set when the installed copy came from this source
	// at a different revision.
	UpdateAvailable bool   `json:"updateAvailable,omitempty"`
	URL             string `json:"-"`
	SHA             string `json:"-"`
}

type CategoryMapping struct {
	ID      string
	Cat     string // Newznab category name, e.g. "Movies/HD"
	Desc    string
	Default bool
	Newznab int // resolved Newznab category id; 0 when Cat is unknown
}

type Definition struct {
	ID              string
	Name            string
	Description     string
	Language        string
	Type            string // public, semi-private, private
	Encoding        string
	Links           []string
	LegacyLinks     []string
	FollowRedirect  bool
	TestLinkTorrent bool
	RequestDelay    float64 // seconds between requests
	// Protocol is "torrent" (the Cardigann default) or "usenet" for a site
	// whose downloads are NZB documents. Definitions may declare
	// `protocol: usenet`; anything else is a torrent site.
	Protocol string
	Caps     Caps
	Settings []Setting
	Login    *Login
	Search   Search
	Download *Download
}

type Download struct {
	Selectors []Selector
	Method    string
	Before    *Request
	InfoHash  *InfoHashBlock
}

type ErrorBlock struct {
	Path     string
	Selector string
	Message  *Selector
}

type Field struct {
	Name      string
	Modifiers []string
	Selector  Selector
}

type Filter struct {
	Name string
	Args []string
}

type HandlerDeps struct {
	// Indexers returns the configured indexers (to refuse removing a
	// definition that is in use).
	Indexers func() []config.Indexer
	// Unredact restores secrets the UI sent back as placeholders.
	Unredact func(config.Indexer) config.Indexer
}

type HeaderKV struct {
	Name   string
	Values []string
}

type InfoHashBlock struct {
	Hash              Selector
	Title             Selector
	UseBeforeResponse bool
}

type KV struct {
	Key   string
	Value string
}

type Login struct {
	Path              string
	SubmitPath        string
	Method            string // post, form, cookie, get, oneurl
	Form              string
	Inputs            []KV
	SelectorInputs    []NamedSelector
	GetSelectorInputs []NamedSelector
	Cookies           []string
	Headers           []HeaderKV
	Error             []ErrorBlock
	Test              *LoginTest
	Captcha           bool
}

type LoginLock func(ctx context.Context, key string) (unlock func(), err error)

type LoginTest struct {
	Path     string
	Selector string
}

type NamedSelector struct {
	Name     string
	Selector Selector
}

type Option struct {
	Value string `json:"value"`
	Label string `json:"label"`
}

type Options struct {
	DB *sql.DB // nil keeps definitions and sessions in memory
	// HTTPClient supplies the transport and timeout for site, definitions
	// source and FlareSolverr requests (tests inject fakes).
	HTTPClient *http.Client
	Logger     *slog.Logger
	Now        func() time.Time
	// LoginLock serialises logins per indexer across nodes; nil uses an
	// in-process lock.
	LoginLock LoginLock
	Sites     config.IndexerSites
	// Sealer protects stored login cookies; nil stores them as given.
	Sealer config.FieldSealer
}

type Request struct {
	Path   string
	Method string
	Inputs []KV
}

type Reserver func(ctx context.Context, kind string) error

type Response struct {
	Type             string // html (default), json, xml
	NoResultsMessage string
}

type Rows struct {
	Selector                        string
	After                           int
	Remove                          string
	DateHeaders                     *Selector
	Count                           *Selector
	Multiple                        bool
	MissingAttributeEqualsNoResults bool
	Attribute                       string
	Filters                         []Filter
}

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

type Search struct {
	Paths                []SearchPath
	Inputs               []KV
	Headers              []HeaderKV
	KeywordsFilters      []Filter
	PreprocessingFilters []Filter
	Rows                 Rows
	Fields               []Field
	Error                []ErrorBlock
	AllowEmptyInputs     bool
}

type SearchPath struct {
	Path           string
	Method         string
	Inputs         []KV
	InheritInputs  bool
	Categories     []string
	FollowRedirect bool
	Response       Response
}

type Selector struct {
	Selector          string
	Attribute         string
	Remove            string
	Filters           []Filter
	Case              []KV
	Optional          bool
	Text              string
	HasText           bool
	Default           string
	HasDefault        bool
	UseBeforeResponse bool
}

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

type Setting struct {
	Name     string   `json:"name"`
	Type     string   `json:"type"`
	Label    string   `json:"label,omitempty"`
	Default  string   `json:"default,omitempty"`
	Defaults []string `json:"defaults,omitempty"`
	Options  []Option `json:"options,omitempty"`
}

type Summary struct {
	ID          string    `json:"id"`
	Name        string    `json:"name"`
	Description string    `json:"description,omitempty"`
	Language    string    `json:"language,omitempty"`
	Type        string    `json:"type,omitempty"`
	Protocol    string    `json:"protocol"`
	Links       []string  `json:"links"`
	Settings    []Setting `json:"settings"`
	Movies      bool      `json:"movies"`
	TV          bool      `json:"tv"`
	Login       string    `json:"login,omitempty"`
	Source      string    `json:"source"` // "upload" or "source"
	Warnings    []string  `json:"warnings,omitempty"`
	InstalledAt time.Time `json:"installedAt"`
	UpdatedAt   time.Time `json:"updatedAt"`
}

type TestResult struct {
	OK      bool     `json:"ok"`
	Results int      `json:"results"`
	Titles  []string `json:"titles,omitempty"`
	Error   string   `json:"error,omitempty"`
}

type TestStatus struct {
	IndexerID string    `json:"indexerId"`
	OK        bool      `json:"ok"`
	Message   string    `json:"message,omitempty"`
	Results   int       `json:"results"`
	TestedAt  time.Time `json:"testedAt"`
}

type UpdateFailed struct {
	ID    string `json:"id"`
	Error string `json:"error"`
}

type UpdateReport struct {
	Updated   []string       `json:"updated"`
	Unchanged int            `json:"unchanged"`
	Failed    []UpdateFailed `json:"failed"`
}

type ValidationError struct{ Problems []string }