operation

package
v1.4.0 Latest Latest
Warning

This package is not in the latest version of its module.

 Go to latest Published: Apr 14, 2022 License: MIT Imports: 39 Imported by: 5

Documentation

Index

Constants

View Source 
const (
	QINIU_ENV               = "QINIU"
	QINIU_MULTI_CLUSTER_ENV = "QINIU_MULTI_CLUSTER"
)
View Source 
const DefaultPathPrefix = ""
View Source 
const FileError = -3
View Source 
const HostError = -2
View Source 
const PathError = -1
View Source 
const QINIU_DISABLE_CONFIG_HOT_RELOADING_ENV = "QINIU_DISABLE_CONFIG_HOT_RELOADING"

Variables

View Source 
var (
	MaxContinuousFailureTimes    = 5
	MaxContinuousFailureDuration = 1 * time.Minute
	MaxFindHostsPrecent          = 50
)
View Source 
var (
	ErrUndefinedConfig                        = errors.New("undefined config")
	ErrCannotTransferBetweenDifferentClusters = errors.New("cannot transfer between different clusters")
)

Functions

func FileServer 

func FileServer(root FileSystem) http.Handler

FileServer returns a handler that serves HTTP http.Requests with the contents of the file system rooted at root.

To use the operating system's file system implementation, use http.Dir: 

http.Handle("/", http.FileServer(http.Dir("/tmp")))

As a special case, the returned file server redirects any http.Request ending in "/index.html" to the same path, without the final "index.html".

func ServeContent 

func ServeContent(w http.ResponseWriter, req *http.Request, name string, modtime time.Time, content io.ReadSeeker)

ServeContent replies to the http.Request using the content in the provided ReadSeeker. The main benefit of ServeContent over io.Copy is that it handles Range http.Requests properly, sets the MIME type, and handles If-Match, If-Unmodified-Since, If-None-Match, If-Modified-Since, and If-Range http.Requests.

If the response's Content-Type header is not set, ServeContent first tries to deduce the type from name's file extension and, if that fails, falls back to reading the first block of the content and passing it to DetectContentType. The name is otherwise unused; in particular it can be empty and is never sent in the response.

If modtime is not the zero time or Unix epoch, ServeContent includes it in a Last-Modified header in the response. If the http.Request includes an If-Modified-Since header, ServeContent uses modtime to decide whether the content needs to be sent at all.

The content's Seek method must work: ServeContent uses a seek to the end of the content to determine its size.

If the caller has set w's ETag header formatted per RFC 7232, section 2.3, ServeContent uses it to handle http.Requests using If-Match, If-None-Match, or If-Range.

Note that *os.File implements the io.ReadSeeker interface.

func ServeFile 

func ServeFile(w http.ResponseWriter, r *http.Request, name string)

ServeFile replies to the http.Request with the contents of the named file or directory.

If the provided file or directory name is a relative path, it is interpreted relative to the current directory and may ascend to parent directories. If the provided name is constructed from user input, it should be sanitized before calling ServeFile.

As a precaution, ServeFile will reject http.Requests where r.URL.Path contains a ".." path element; this protects against callers who might unsafely use filepath.Join on r.URL.Path without sanitizing it and then use that filepath.Join result as the name argument.

As another special case, ServeFile redirects any http.Request where r.URL.Path ends in "/index.html" to the same path, without the final "index.html". To avoid such redirects either modify the path or use ServeContent.

Outside of those two special cases, ServeFile does not use r.URL.Path for selecting the file or directory to serve; only the file or directory provided in the name argument is used.

func SetCacheDirectoryAndLoad 

func SetCacheDirectoryAndLoad(path string) error

设置查询结果缓存目录

func SetLogger 

func SetLogger(logger kodocli.Ilog)

设置全局 Logger

func StartServer 

func StartServer(cfg *Config) (*http.Server, error)

func StartSimulateErrorServer deprecated 

func StartSimulateErrorServer(_ *Config)

Deprecated:

func WithCurrentConfigurable added in v1.0.8 

func WithCurrentConfigurable(f func(configurable Configurable))

Types

type ApiServer added in v1.0.9 

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

func NewApiServer added in v1.0.9 

func NewApiServer(c *Config) *ApiServer

根据配置创建 API Server

func NewApiServerV2 added in v1.0.9 

func NewApiServerV2() *ApiServer

根据环境变量创建 API Server

func (*ApiServer) GetLogicalAvailableSizes added in v1.0.9 

func (svr *ApiServer) GetLogicalAvailableSizes() (map[string]uint64, error)

type Config 

type Config struct {
	UpHosts          []string `json:"up_hosts" toml:"up_hosts"`
	RsHosts          []string `json:"rs_hosts" toml:"rs_hosts"`
	RsfHosts         []string `json:"rsf_hosts" toml:"rsf_hosts"`
	ApiServerHosts   []string `json:"api_server_hosts" toml:"api_server_hosts"`
	Bucket           string   `json:"bucket" toml:"bucket"`
	Ak               string   `json:"ak" toml:"ak"`
	Sk               string   `json:"sk" toml:"sk"`
	PartSize         int64    `json:"part" toml:"part"`
	Addr             string   `json:"addr" toml:"addr"`
	Delete           bool     `json:"delete" toml:"delete"`
	UpConcurrency    int      `json:"up_concurrency" toml:"up_concurrency"`
	BatchConcurrency int      `json:"batch_concurrency" toml:"batch_concurrency"`
	BatchSize        int      `json:"batch_size" toml:"batch_size"`

	DownPath string `json:"down_path" toml:"down_path"`
	Sim      bool   `json:"sim" toml:"sim"`

	IoHosts []string `json:"io_hosts" toml:"io_hosts"`
	UcHosts []string `json:"uc_hosts" toml:"uc_hosts"`

	RecycleBin string `json:"recycle_bin" toml:"recycle_bin"`
	// contains filtered or unexported fields
}

配置文件

func Load 

func Load(file string) (*Config, error)

加载配置文件

type Configurable added in v1.0.8 

type Configurable interface {
	// contains filtered or unexported methods
}

type DeleteKeysError added in v1.3.0 

type DeleteKeysError struct {
	Error string
	Code  int
	Name  string
}

type Dir 

type Dir string

A Dir implements FileSystem using the native file system restricted to a specific directory tree.

While the FileSystem.Open method takes '/'-separated paths, a Dir's string value is a filename on the native file system, not a URL, so it is separated by filepath.Separator, which isn't necessarily '/'.

Note that Dir could expose sensitive files and directories. Dir will follow symlinks pointing out of the directory tree, which can be especially dangerous if serving from a directory in which users are able to create arbitrary symlinks. Dir will also allow access to files and directories starting with a period, which could expose sensitive directories like .git or sensitive files like .htpasswd. To exclude files with a leading period, remove the files/directories from the server or create a custom FileSystem implementation.

An empty Dir is treated as ".".

func (Dir) Open 

func (d Dir) Open(name string) (File, error)

Open implements FileSystem using os.Open, opening files for reading rooted and relative to the directory d.

type Downloader 

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

下载器

func NewDownloader 

func NewDownloader(c *Config) *Downloader

根据配置创建下载器

func NewDownloaderV2 

func NewDownloaderV2() *Downloader

根据环境变量创建下载器

func (*Downloader) DownloadBytes 

func (d *Downloader) DownloadBytes(key string) (data []byte, err error)

下载指定对象到内存中

func (*Downloader) DownloadCheck added in v1.1.1 

func (d *Downloader) DownloadCheck(key string) (l int64, err error)

检查文件

func (*Downloader) DownloadCheckList added in v1.1.1 

func (d *Downloader) DownloadCheckList(ctx context.Context, keys []string) ([]*FileStat, error)

检查多个文件

func (*Downloader) DownloadFile 

func (d *Downloader) DownloadFile(key, path string) (f *os.File, err error)

下载指定对象到文件里

func (*Downloader) DownloadRangeBytes 

func (d *Downloader) DownloadRangeBytes(key string, offset, size int64) (l int64, data []byte, err error)

下载指定对象的指定范围到内存中

func (*Downloader) DownloadRangeReader added in v1.2.0 

func (d *Downloader) DownloadRangeReader(key string, offset, size int64) (l int64, reader io.ReadCloser, err error)

下载指定对象的指定范围为Reader

func (*Downloader) DownloadRaw added in v1.2.0 

func (d *Downloader) DownloadRaw(key string, headers http.Header) (*http.Response, error)

使用给定的 HTTP Header 请求下载接口，并直接获得 http.Response 响应

type File 

type File interface {
	io.Closer
	io.Reader
	io.Seeker
	Readdir(count int) ([]os.FileInfo, error)
	Stat() (os.FileInfo, error)
}

A File is returned by a FileSystem's Open method and can be served by the FileServer implementation.

The methods should behave the same as those on an *os.File.

type FileStat 

type FileStat struct {
	Name string `json:"name"`
	Size int64  `json:"size"`
	// contains filtered or unexported fields
}

文件元信息

type FileSystem 

type FileSystem interface {
	Open(name string) (File, error)
}

A FileSystem implements access to a collection of named files. The elements in a file path are separated by slash ('/', U+002F) characters, regardless of host operating system convention.

type Lister 

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

列举器

func NewLister 

func NewLister(c *Config) *Lister

根据配置创建列举器

func NewListerV2 

func NewListerV2() *Lister

根据环境变量创建列举器

func (*Lister) Copy 

func (l *Lister) Copy(fromKey, toKey string) error

复制对象到当前存储空间的指定对象中

func (*Lister) Delete 

func (l *Lister) Delete(key string) error

删除指定对象，如果配置了回收站，该 API 将会将文件移动到回收站中，而不做实际的删除

func (*Lister) DeleteKeys added in v1.3.0 

func (l *Lister) DeleteKeys(keys []string) ([]*DeleteKeysError, error)

删除多个对象，如果配置了回收站，该 API 将会将文件移动到回收站中，而不做实际的删除

func (*Lister) ForceDelete added in v1.4.0 

func (l *Lister) ForceDelete(key string) error

强制删除指定对象，无论是否配置回收站，该 API 都会直接删除文件

func (*Lister) ForceDeleteKeys added in v1.4.0 

func (l *Lister) ForceDeleteKeys(keys []string) ([]*DeleteKeysError, error)

强制删除多个对象，无论是否配置回收站，该 API 都会直接删除文件

func (*Lister) ListPrefix 

func (l *Lister) ListPrefix(prefix string) []string

根据前缀列举存储空间

func (*Lister) ListStat 

func (l *Lister) ListStat(keys []string) []*FileStat

获取指定对象列表的元信息

func (*Lister) MoveTo 

func (l *Lister) MoveTo(fromKey, toBucket, toKey string) error

移动对象到指定存储空间的指定对象中

func (*Lister) Rename 

func (l *Lister) Rename(fromKey, toKey string) error

重命名对象

type MultiClustersConfig added in v1.0.8 

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

多集群配置文件

func LoadMultiClusterConfigs added in v1.0.8 

func LoadMultiClusterConfigs(file string) (*MultiClustersConfig, error)

加载多集群配置文件

func (*MultiClustersConfig) SetConfigSelectCallback added in v1.0.8 

func (multiConfigs *MultiClustersConfig) SetConfigSelectCallback(f func(map[string]*Config, string) (*Config, bool))

type Queryer 

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

域名查询器

func NewQueryer 

func NewQueryer(c *Config) *Queryer

根据配置创建域名查询器

func (*Queryer) QueryApiServerHosts added in v1.0.9 

func (queryer *Queryer) QueryApiServerHosts(https bool) (urls []string)

查询 APISERVER 服务器 URL

func (*Queryer) QueryIoHosts 

func (queryer *Queryer) QueryIoHosts(https bool) (urls []string)

查询 IO 服务器 URL

func (*Queryer) QueryRsHosts 

func (queryer *Queryer) QueryRsHosts(https bool) (urls []string)

查询 RS 服务器 URL

func (*Queryer) QueryRsfHosts 

func (queryer *Queryer) QueryRsfHosts(https bool) (urls []string)

查询 RSF 服务器 URL

func (*Queryer) QueryUpHosts 

func (queryer *Queryer) QueryUpHosts(https bool) (urls []string)

查询 UP 服务器 URL

type Req 

type Req struct {
	Path   string `json:"path"`
	Key    string `json:"key"`
	Delete *bool  `json:"del"`
}

type SingleClusterConfig added in v1.0.8 

type SingleClusterConfig = Config

单集群配置文件

type Uploader 

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

上传器

func NewUploader 

func NewUploader(c *Config) *Uploader

根据配置创建上传器

func NewUploaderV2 

func NewUploaderV2() *Uploader

根据环境变量创建上传器

func (*Uploader) Upload 

func (p *Uploader) Upload(file string, key string) (err error)

上传指定文件到指定对象中

func (*Uploader) UploadData 

func (p *Uploader) UploadData(data []byte, key string) (err error)

上传内存数据到指定对象中

func (*Uploader) UploadDataReader 

func (p *Uploader) UploadDataReader(data io.ReaderAt, size int, key string) (err error)

从 Reader 中阅读指定大小的数据并上传到指定对象中

func (*Uploader) UploadReader 

func (p *Uploader) UploadReader(reader io.Reader, key string) (err error)

从 Reader 中阅读全部数据并上传到指定对象中

Source Files

View all Source files

Jump to

Keyboard shortcuts

? : This menu
/ : Search site
f or F : Jump to
y or Y : Canonical URL
go.dev uses cookies from Google to deliver and enhance the quality of its services and to analyze traffic. Learn more.