base

Documentation

Index

• Constants
• Variables
• func ParseOptsExtra[E any](opts *Options) error
• func ParseReqExtra[E any](req *Request) error
• type DownloaderProxyConfig
  • func (cfg *DownloaderProxyConfig) ToHandler() func(r *http.Request) (*url.URL, error)
  • func (cfg *DownloaderProxyConfig) ToUrl() *url.URL
• type DownloaderStoreConfig
  • func (cfg *DownloaderStoreConfig) Init() *DownloaderStoreConfig
  • func (cfg *DownloaderStoreConfig) Merge(beforeCfg *DownloaderStoreConfig) *DownloaderStoreConfig
• type FileInfo
• type Options
  • func (o *Options) Clone() *Options
  • func (o *Options) InitSelectFiles(fileSize int)
• type Request
  • func (r *Request) Validate() error
• type Resource
  • func (r *Resource) CalcSize(selectFiles []int)
  • func (r *Resource) Validate() error
• type Status

Constants

const (
	HttpCodeOK             = 200
	HttpCodePartialContent = 206

	HttpHeaderRange              = "Range"
	HttpHeaderAcceptRanges       = "Accept-Ranges"
	HttpHeaderContentLength      = "Content-Length"
	HttpHeaderContentRange       = "Content-Range"
	HttpHeaderContentDisposition = "Content-Disposition"
	HttpHeaderUserAgent          = "User-Agent"
	HttpHeaderLastModified       = "Last-Modified"

	HttpHeaderBytes       = "bytes"
	HttpHeaderRangeFormat = "bytes=%d-%d"
)

Variables

var (
	NotFound  = errors.New("not found")
	BadParams = errors.New("bad params")
)

var InDocker string

var Version string

Version is the build version, set at build time, using `go build -ldflags "-X github.com/GopeedLab/gopeed/pkg/base.Version=1.0.0"`.

Functions

func ParseOptsExtra

func ParseOptsExtra[E any](opts *Options) error

func ParseReqExtra

func ParseReqExtra[E any](req *Request) error

Types

type DownloaderProxyConfig

type DownloaderProxyConfig struct {
	Enable bool `json:"enable"`
	// System is the flag that use system proxy
	System bool   `json:"system"`
	Scheme string `json:"scheme"`
	Host   string `json:"host"`
	Usr    string `json:"usr"`
	Pwd    string `json:"pwd"`
}

func (*DownloaderProxyConfig) ToHandler

func (cfg *DownloaderProxyConfig) ToHandler() func(r *http.Request) (*url.URL, error)

func (*DownloaderProxyConfig) ToUrl

func (cfg *DownloaderProxyConfig) ToUrl() *url.URL

ToUrl returns the proxy url, just for git clone

type DownloaderStoreConfig

type DownloaderStoreConfig struct {
	FirstLoad bool `json:"-"` // FirstLoad is the flag that the config is first time init and not from store

	DownloadDir    string                 `json:"downloadDir"`    // DownloadDir is the default directory to save the downloaded files
	MaxRunning     int                    `json:"maxRunning"`     // MaxRunning is the max running download count
	ProtocolConfig map[string]any         `json:"protocolConfig"` // ProtocolConfig is special config for each protocol
	Extra          map[string]any         `json:"extra"`
	Proxy          *DownloaderProxyConfig `json:"proxy"`
}

DownloaderStoreConfig is the config that can restore the downloader.

func (*DownloaderStoreConfig) Init

func (cfg *DownloaderStoreConfig) Init() *DownloaderStoreConfig

func (*DownloaderStoreConfig) Merge

func (cfg *DownloaderStoreConfig) Merge(beforeCfg *DownloaderStoreConfig) *DownloaderStoreConfig

type FileInfo

type FileInfo struct {
	Name  string     `json:"name"`
	Path  string     `json:"path"`
	Size  int64      `json:"size"`
	Ctime *time.Time `json:"ctime"`

	Req *Request `json:"req"`
}

type Options

type Options struct {
	// Download file name
	Name string `json:"name"`
	// Download file path
	Path string `json:"path"`
	// Select file indexes to download
	SelectFiles []int `json:"selectFiles"`
	// Extra info for specific fetcher
	Extra any `json:"extra"`
}

Options for download

func (*Options) Clone

func (o *Options) Clone() *Options

func (*Options) InitSelectFiles

func (o *Options) InitSelectFiles(fileSize int)

type Request

type Request struct {
	URL   string `json:"url"`
	Extra any    `json:"extra"`
	// Labels is used to mark the download task
	Labels map[string]string `json:"labels"`
}

Request download request

func (*Request) Validate

func (r *Request) Validate() error

type Resource

type Resource struct {
	// if name is not empty, the resource is a folder and the name is the folder name
	Name string `json:"name"`
	Size int64  `json:"size"`
	// is support range download
	Range bool `json:"range"`
	// file list
	Files []*FileInfo `json:"files"`
	Hash  string      `json:"hash"`
}

Resource download resource

func (*Resource) CalcSize

func (r *Resource) CalcSize(selectFiles []int)

func (*Resource) Validate

func (r *Resource) Validate() error

type Status

type Status string

const (
	DownloadStatusReady   Status = "ready" // task create but not start
	DownloadStatusRunning Status = "running"
	DownloadStatusPause   Status = "pause"
	DownloadStatusWait    Status = "wait" // task is wait for running
	DownloadStatusError   Status = "error"
	DownloadStatusDone    Status = "done"
)