torznab

type Caps struct {
	XMLName    xml.Name       `xml:"caps"`
	Server     CapsServer     `xml:"server"`
	Limits     CapsLimits     `xml:"limits"`
	Searching  CapsSearching  `xml:"searching"`
	Categories CapsCategories `xml:"categories"`
	Tags       string         `xml:"tags"`
}

type CapsCategories struct {
	Categories []Category `xml:"category"`
}

type CapsLimits struct {
	Max     uint `xml:"max,attr,omitempty"`
	Default uint `xml:"default,attr,omitempty"`
}

type CapsSearch struct {
	Available       string `xml:"available,attr"`
	SupportedParams string `xml:"supportedParams,attr,omitempty"`
}

type CapsSearching struct {
	Search      CapsSearch `xml:"search,omitempty"`
	TvSearch    CapsSearch `xml:"tv-search,omitempty"`
	MovieSearch CapsSearch `xml:"movie-search,omitempty"`
	MusicSearch CapsSearch `xml:"music-search,omitempty"`
	AudioSearch CapsSearch `xml:"audio-search,omitempty"`
	BookSearch  CapsSearch `xml:"book-search,omitempty"`
}

type CapsServer struct {
	Title string `xml:"title,attr"`
}

type Category struct {
	ID     int           `xml:"id,attr"`
	Name   string        `xml:"name,attr"`
	Subcat []Subcategory `xml:"subcat"`
}

type Client interface {
	Caps(context.Context) (Caps, error)
	Search(context.Context, SearchRequest) (SearchResult, error)
}

type Error struct {
	XMLName xml.Name `xml:"error"`

	// Code the Error code.
	//
	// From https://torznab.github.io/spec-1.3-draft/external/newznab/api.html#newznab-error-codes:
	//
	// 100 Incorrect user credentials
	// 101 Account suspended
	// 102 Insufficient privileges/not authorized
	// 103 Registration denied
	// 104 Registrations are closed
	// 105 Invalid registration (Email Address Taken)
	// 106 Invalid registration (Email Address Bad Format)
	// 107 Registration Failed (Data error)
	// 200 Missing parameter
	// 201 Incorrect parameter
	// 202 No such function. (Function not defined in this specification).
	// 203 Function not available. (Optional function is not implemented).
	// 300 No such item.
	// 300 Item already exists.
	// 900 Unknown error
	// 910 API Disabled
	Code        int    `xml:"error,attr"`
	Description string `xml:"description,attr"`
}

type RssDate time.Time

type SearchRequest struct {
	Query    string
	Type     string
	Cats     []int
	ImdbId   model.NullString
	TmdbId   model.NullString
	Season   model.NullInt
	Episode  model.NullInt
	Attrs    []string
	Extended bool
	Limit    model.NullUint
	Offset   model.NullUint
}

type SearchResult struct {
	XMLName    xml.Name            `xml:"rss"`
	RssVersion rssVersion          `xml:"version,attr"`
	AtomNs     customNs            `xml:"xmlns:atom,attr"`
	TorznabNs  customNs            `xml:"xmlns:torznab,attr"`
	Channel    SearchResultChannel `xml:"channel"`
}

type SearchResultChannel struct {
	Title         string               `xml:"title,omitempty"`
	Link          string               `xml:"link,omitempty"`
	Description   string               `xml:"description,omitempty"`
	Language      string               `xml:"language,omitempty"`
	PubDate       RssDate              `xml:"pubDate,omitempty"`
	LastBuildDate RssDate              `xml:"lastBuildDate,omitempty"`
	Docs          string               `xml:"docs,omitempty"`
	Generator     string               `xml:"generator,omitempty"`
	Response      SearchResultResponse `xml:"http://www.newznab.com/DTD/2010/feeds/attributes/ response"`
	Items         []SearchResultItem   `xml:"item"`
}

type SearchResultItem struct {
	Title        string                        `xml:"title"`
	GUID         string                        `xml:"guid,omitempty"`
	PubDate      RssDate                       `xml:"pubDate,omitempty"`
	Category     string                        `xml:"category,omitempty"`
	Link         string                        `xml:"link,omitempty"`
	Size         uint64                        `xml:"size"`
	Description  string                        `xml:"description,omitempty"`
	Comments     string                        `xml:"comments,omitempty"`
	Enclosure    SearchResultItemEnclosure     `xml:"enclosure"`
	TorznabAttrs []SearchResultItemTorznabAttr `xml:"torznab:attr"`
}

type SearchResultItemEnclosure struct {
	URL    string `xml:"url,attr"`
	Length string `xml:"length,attr"`
	Type   string `xml:"type,attr"`
}

type SearchResultItemTorznabAttr struct {
	AttrName  string `xml:"name,attr"`
	AttrValue string `xml:"value,attr"`
}

type SearchResultResponse struct {
	Offset uint `xml:"offset,attr,omitempty"`
	Total  uint `xml:"total,attr,omitempty"`
}

type Subcategory struct {
	ID   int    `xml:"id,attr"`
	Name string `xml:"name,attr"`
}

type Xmler interface {
	Xml() ([]byte, error)
}