pcsconfig

Documentation

Overview

Package pcsconfig 配置包

Index

• Constants
• Variables
• func GetConfigDir() string
• type Baidu
  • func NewUserInfoByBDUSS(bduss string) (b *Baidu, err error)
  • func (baidu *Baidu) BaiduPCS() *baidupcs.BaiduPCS
  • func (baidu *Baidu) GetSavePath(path string) string
• type BaiduBase
• type BaiduUserList
  • func (bl *BaiduUserList) String() string
• type PCSConfig
  • func NewConfig(configFilePath string) *PCSConfig
  • func (c *PCSConfig) ActiveUser() *Baidu
  • func (c *PCSConfig) ActiveUserBaiduPCS() *baidupcs.BaiduPCS
  • func (c *PCSConfig) AppID() int
  • func (c *PCSConfig) BaiduUserList() BaiduUserList
  • func (c *PCSConfig) CacheSize() int
  • func (c *PCSConfig) CheckBaiduUserExist(baidubase *BaiduBase) bool
  • func (c *PCSConfig) Close() error
  • func (c *PCSConfig) DeleteUser(baiduBase *BaiduBase) (*Baidu, error)
  • func (c *PCSConfig) EnableHTTPS() bool
  • func (c *PCSConfig) GetBaiduUser(baidubase *BaiduBase) (*Baidu, error)
  • func (c *PCSConfig) Init() error
  • func (c *PCSConfig) MaxParallel() int
  • func (c *PCSConfig) NumLogins() int
  • func (c *PCSConfig) PrintTable()
  • func (c *PCSConfig) Reload() error
  • func (c *PCSConfig) Save() error
  • func (c *PCSConfig) SaveDir() string
  • func (c *PCSConfig) SetAppID(appID int)
  • func (c *PCSConfig) SetCacheSize(cacheSize int)
  • func (c *PCSConfig) SetEnableHTTPS(https bool)
  • func (c *PCSConfig) SetMaxParallel(maxParallel int)
  • func (c *PCSConfig) SetSaveDir(saveDir string)
  • func (c *PCSConfig) SetUserAgent(userAgent string)
  • func (c *PCSConfig) SetupUserByBDUSS(bduss, ptoken, stoken string) (baidu *Baidu, err error)
  • func (c *PCSConfig) SwitchUser(baiduBase *BaiduBase) (*Baidu, error)
  • func (c *PCSConfig) UserAgent() string

Constants

const (
	// EnvConfigDir 配置路径环境变量
	EnvConfigDir = "BAIDUPCS_GO_CONFIG_DIR"
	// ConfigName 配置文件名
	ConfigName = "pcs_config.json"
)

Variables

var (
	//ErrNoSuchBaiduUser 未登录任何百度帐号
	ErrNoSuchBaiduUser = errors.New("no such baidu user")
	//ErrBaiduUserNotFound 未找到百度帐号
	ErrBaiduUserNotFound = errors.New("baidu user not found")
)

var (
	//ErrNotLogin 未登录帐号错误
	ErrNotLogin = errors.New("baidu user not login")
	//ErrConfigFilePathNotSet 未设置配置文件
	ErrConfigFilePathNotSet = errors.New("config file not set")
	//ErrConfigFileNotExist 未设置Config, 未初始化
	ErrConfigFileNotExist = errors.New("config file not exist")
	//ErrConfigFileNoPermission Config文件无权限访问
	ErrConfigFileNoPermission = errors.New("config file permission denied")
	//ErrConfigContentsParseError 解析Config数据错误
	ErrConfigContentsParseError = errors.New("config contents parse error")
)

var (

	// Config 配置信息, 由外部调用
	Config = NewConfig(configFilePath)
)

Functions

func GetConfigDir

func GetConfigDir() string

GetConfigDir 获取配置路径

Types

type Baidu

type Baidu struct {
	BaiduBase
	Sex string  `json:"sex"` // 性别
	Age float64 `json:"age"` // 帐号年龄

	BDUSS  string `json:"bduss"`
	PTOKEN string `json:"ptoken"`
	STOKEN string `json:"stoken"`

	Workdir string `json:"workdir"` // 工作目录
}

Baidu 百度帐号对象

func NewUserInfoByBDUSS

func NewUserInfoByBDUSS(bduss string) (b *Baidu, err error)

NewUserInfoByBDUSS 检测BDUSS有效性, 同时获取百度详细信息 (无法获取 ptoken 和 stoken)

func (*Baidu) BaiduPCS

func (baidu *Baidu) BaiduPCS() *baidupcs.BaiduPCS

BaiduPCS 初始化*baidupcs.BaiduPCS

func (*Baidu) GetSavePath

func (baidu *Baidu) GetSavePath(path string) string

GetSavePath 根据提供的网盘文件路径 path, 返回本地储存路径, 返回绝对路径, 获取绝对路径出错时才返回相对路径...

type BaiduBase

type BaiduBase struct {
	UID  uint64 `json:"uid"`  // 百度ID对应的uid
	Name string `json:"name"` // 真实ID
}

BaiduBase Baidu基

type BaiduUserList

type BaiduUserList []*Baidu

BaiduUserList 百度帐号列表

func (*BaiduUserList) String

func (bl *BaiduUserList) String() string

String 格式输出百度帐号列表

type PCSConfig

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

PCSConfig 配置详情

func NewConfig

func NewConfig(configFilePath string) *PCSConfig

NewConfig 返回 PCSConfig 指针对象

func (*PCSConfig) ActiveUser

func (c *PCSConfig) ActiveUser() *Baidu

ActiveUser 获取当前登录的用户

func (*PCSConfig) ActiveUserBaiduPCS

func (c *PCSConfig) ActiveUserBaiduPCS() *baidupcs.BaiduPCS

ActiveUserBaiduPCS 获取当前登录的用户的baidupcs.BaiduPCS

func (*PCSConfig) AppID

func (c *PCSConfig) AppID() int

AppID 返回app_id

func (*PCSConfig) BaiduUserList

func (c *PCSConfig) BaiduUserList() BaiduUserList

BaiduUserList 获取百度用户列表

func (*PCSConfig) CacheSize

func (c *PCSConfig) CacheSize() int

CacheSize 返回cache_size, 下载缓存

func (*PCSConfig) CheckBaiduUserExist

func (c *PCSConfig) CheckBaiduUserExist(baidubase *BaiduBase) bool

CheckBaiduUserExist 检查百度用户是否存在于已登录列表

func (*PCSConfig) Close

func (c *PCSConfig) Close() error

Close 关闭配置文件

func (*PCSConfig) DeleteUser

func (c *PCSConfig) DeleteUser(baiduBase *BaiduBase) (*Baidu, error)

DeleteUser 删除用户, 返回删除成功的用户

func (*PCSConfig) EnableHTTPS

func (c *PCSConfig) EnableHTTPS() bool

EnableHTTPS 返回是否启用https

func (*PCSConfig) GetBaiduUser

func (c *PCSConfig) GetBaiduUser(baidubase *BaiduBase) (*Baidu, error)

GetBaiduUser 获取百度用户信息

func (*PCSConfig) Init

func (c *PCSConfig) Init() error

Init 初始化配置

func (*PCSConfig) MaxParallel

func (c *PCSConfig) MaxParallel() int

MaxParallel 返回max_parallel, 下载最大并发量

func (*PCSConfig) NumLogins

func (c *PCSConfig) NumLogins() int

NumLogins 获取登录的用户数量

func (*PCSConfig) PrintTable

func (c *PCSConfig) PrintTable()

PrintTable 输出表格

func (*PCSConfig) Reload

func (c *PCSConfig) Reload() error

Reload 从文件重载配置

func (*PCSConfig) Save

func (c *PCSConfig) Save() error

Save 保存配置信息到配置文件

func (*PCSConfig) SaveDir

func (c *PCSConfig) SaveDir() string

SaveDir 返回下载保存路径

func (*PCSConfig) SetAppID

func (c *PCSConfig) SetAppID(appID int)

SetAppID 设置app_id

func (*PCSConfig) SetCacheSize

func (c *PCSConfig) SetCacheSize(cacheSize int)

SetCacheSize 设置cache_size, 下载缓存

func (*PCSConfig) SetEnableHTTPS

func (c *PCSConfig) SetEnableHTTPS(https bool)

SetEnableHTTPS 设置是否启用https

func (*PCSConfig) SetMaxParallel

func (c *PCSConfig) SetMaxParallel(maxParallel int)

SetMaxParallel 设置max_parallel, 下载最大并发量

func (*PCSConfig) SetSaveDir

func (c *PCSConfig) SetSaveDir(saveDir string)

SetSaveDir 设置下载保存路径

func (*PCSConfig) SetUserAgent

func (c *PCSConfig) SetUserAgent(userAgent string)

SetUserAgent 设置User-Agent

func (*PCSConfig) SetupUserByBDUSS

func (c *PCSConfig) SetupUserByBDUSS(bduss, ptoken, stoken string) (baidu *Baidu, err error)

SetupUserByBDUSS 设置百度 bduss, ptoken, stoken 并保存

func (*PCSConfig) SwitchUser

func (c *PCSConfig) SwitchUser(baiduBase *BaiduBase) (*Baidu, error)

SwitchUser 切换用户, 返回切换成功的用户

func (*PCSConfig) UserAgent

func (c *PCSConfig) UserAgent() string

UserAgent 返回User-Agent