Documentation
¶
Index ¶
- Constants
- func NewGetRequest(url string) *http.Request
- func NewHTTPClient(timeout int) *http.Client
- func NewPostFormRequest(url string, data url.Values) *http.Request
- func OptionsToMap(opts []Option) map[string]interface{}
- func PanicForStatus(resp *http.Response, msg string)
- type BoolOption
- type Downloader
- type ErrHTTPStatusCode
- type FloatOption
- type IntOption
- type Option
- type Plugin
- type Reporter
- type StringOption
Constants ¶
const FirefoxUserAgent = "Mozilla/5.0 (compatible; MSIE 9.0; Windows NT 6.1; Trident/5.0)"
const UnknownTotal = 0
Variables ¶
This section is empty.
Functions ¶
func NewGetRequest ¶
Create a new GET request with a Firefox user agent.
func NewHTTPClient ¶
Create an HTTP client with a proper timeout timer.
func NewPostFormRequest ¶
Create a new POST request with a Firefox user agent using form data.
func OptionsToMap ¶
Convert a slice of Option into a map[string]interface{}.
func PanicForStatus ¶
Panic with an ErrHTTPStatusCode if the status code isn't 200.
Types ¶
type BoolOption ¶
An implementation of Option that tries to convert the user input into a bool. Using strconv.ParseBool, it accepts 1, t, T, TRUE, true, True, 0, f, F, FALSE, false, False.
func (*BoolOption) Comment ¶
func (opt *BoolOption) Comment() string
func (*BoolOption) IsRequired ¶
func (opt *BoolOption) IsRequired() bool
func (*BoolOption) Key ¶
func (opt *BoolOption) Key() string
func (*BoolOption) Set ¶
func (opt *BoolOption) Set(v string) (err error)
func (*BoolOption) Value ¶
func (opt *BoolOption) Value() interface{}
type Downloader ¶
type ErrHTTPStatusCode ¶
type ErrHTTPStatusCode struct {
StatusCode int
}
Implements the error interface.
func (*ErrHTTPStatusCode) String ¶
func (e *ErrHTTPStatusCode) String() string
type FloatOption ¶
An implementation of Option that tries to convert the user input into a float64.
func (*FloatOption) Comment ¶
func (opt *FloatOption) Comment() string
func (*FloatOption) IsRequired ¶
func (opt *FloatOption) IsRequired() bool
func (*FloatOption) Key ¶
func (opt *FloatOption) Key() string
func (*FloatOption) Set ¶
func (opt *FloatOption) Set(v string) (err error)
func (*FloatOption) Value ¶
func (opt *FloatOption) Value() interface{}
type IntOption ¶
An implementation of Option that tries to convert the user input into an integer.
func (*IntOption) IsRequired ¶
type Option ¶
type Option interface {
Key() string
Value() interface{}
// Set the value using user input.
Set(string) error
IsRequired() bool
Comment() string
}
An option the plugin provides that the user can set. The input is through a string provided by the user.
type Plugin ¶
type Plugin interface {
// The name of the plugin.
Name() string
// The version of the plugin. Do not prefix it with "v" or anything like that.
// Can return an empty string.
Version() string
// Should return whether or not it can deal with a URL.
// There is no guarantee that DownloadGenerator() will be called later.
// There is also no guarantee that the last call to this is the URL that
// will be passed to DownloadGenerator(). In other words, don't store stuff
// here for later use.
CanHandle(url string) bool
// Returns a slice of all the options. If the user wants to, they can
// be set. Of course, if an option needs a value and the user does not
// set it, either make sure you have a default value or that IsRequired()
// returns true. The latter will not allow the plugin to run without setting it.
Options() []Option
// A generator function that returns a generator that generates downloaders.
// Sounds overly convoluted, but when combined with closures, it's pretty damn neat.
// The outer function could theoretically be dropped and just have it directly generate
// Downloader functions, but if you have to initialize stuff first, you'd have to check
// whether or not you've initialized at the start of the function for every call.
// With this signature, you can just initialize and return the generator as a closure to
// keep all the local variables and not have to store them anywhere first. This also
// makes it ideal for having one single object per plugin without ever having to remake it.
//
// The "dls" is the number of downloaders that are going to be returned. Use UnknownTotal
// if it's unknown. You can go over or under the total without it breaking anything important.
// It's simply used for displaying progress through the interface.
//
// See the Dummy plugin for an example implementation.
DownloadGenerator(url string) (dlgen func() Downloader, dls int)
}
The interface all plugins must implement.
A single object is used for multiple URLs that concern the plugin, so the implementation must deal with a call to DownloadGenerator() as a new download and reset any variables and whatnot that could affect the result.
type Reporter ¶
type Reporter interface {
// Should be used when you have something you need to download, but not
// actually something you want the manager to save and count as part of
// the resulting files.
//
// This doesn't directly benefit the downloader, but it allows the manager
// to keep track of download speeds, and more importantly if something were
// to go wrong in another downloader, it can detect that and stop the downloader
// from keeping the application from exiting.
Copy(dst io.Writer, src io.Reader) (written int64, err error)
// Saves the data/file into a file as a successful download.
// The path must be relative, as the downloader will take care of where to save files.
// The report bool determines whether or not it should report download speeds.
// In other words, whether or not src is getting its data straight from the network.
SaveData(dst string, src io.Reader, report bool) (written int64, err error)
// Saves the file as a successful download. The destination path must be relative,
// as the downloader will take care of where to save files. The file is renamed (moved)
// to the final destination rather than copied. This only works if the file resides on
// the same disk drive as the the destination, so use SaveFile() if unsure.
// Should be safe to use with TempFile() files. src must be closed before using this.
SaveFile(dst, src string) (size int64, err error)
// For when you need a temporary file. Should ensure the file resides on the same
// disk drive as the download directory, allowing for use with SaveFile().
TempFile() (*os.File, error)
// Returns a writer to the destination file. The caller must close it.
// Download completion is reported on close.
FileWriter(dst string, report bool) (io.WriteCloser, error)
}
An interface passed to Downloader that allows it to get a destination to write downloads to and to get temporary files. Using this interface instead of opening files inside the plugin allows the download manager to control the flow of downloads (e.g. pausing, aborting), track download speeds, stay aware of downloaded files for further processing, and so on.
All paths used to save files with must relative and be in a directory. If the user wants to have the files zipped, all the top-level directories will be zipped.
type StringOption ¶
A basic Option implementation that keeps all user input as-is instead of trying to convert stuff.
func (*StringOption) Comment ¶
func (opt *StringOption) Comment() string
func (*StringOption) IsRequired ¶
func (opt *StringOption) IsRequired() bool
func (*StringOption) Key ¶
func (opt *StringOption) Key() string
func (*StringOption) Set ¶
func (opt *StringOption) Set(v string) error
func (*StringOption) Value ¶
func (opt *StringOption) Value() interface{}
Source Files
Directories
¶
| Path | Synopsis |
|---|---|
|
A helper package to make calls to the API served by BinB Reader.
|
A helper package to make calls to the API served by BinB Reader. |