model

package
v3.35.3-8Mi Latest Latest
Warning

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

 Go to latest Published: Jul 3, 2024 License: AGPL-3.0 Imports: 18 Imported by: 0

Documentation

Index

Constants

View Source 
const (
	SINGLE = iota
	SITE
	STYLE
	PREVIEW
	GLOBAL
	OFFLINE_DOWNLOAD
	INDEX
	SSO
	LDAP
	S3
)
View Source 
const (
	PUBLIC = iota
	PRIVATE
	READONLY
	DEPRECATED
)
View Source 
const (
	GENERAL = iota
	GUEST   // only one exists
	ADMIN
)
View Source 
const MaxInt = int(MaxUint >> 1)
View Source 
const MaxUint = ^uint(0)
View Source 
const MinInt = -MaxInt - 1
View Source 
const MinUint = 0
View Source 
const StaticHashSalt = "https://github.com/8Mi-Tech/alist"

Variables

This section is empty.

Functions

func ExtractFolder 

func ExtractFolder(objs []Obj, extractFolder string)

func GetThumb 

func GetThumb(obj Obj) (thumb string, ok bool)

func GetUrl 

func GetUrl(obj Obj) (url string, ok bool)

func HashPwd 

func HashPwd(static string, salt string) string

func SortFiles 

func SortFiles(objs []Obj, orderBy, orderDirection string)

func StaticHash 

func StaticHash(password string) string

func TwoHashPwd 

func TwoHashPwd(password string, salt string) string

func WrapObjsName 

func WrapObjsName(objs []Obj)

Types

type File 

type File interface {
	io.Reader
	io.ReaderAt
	io.Seeker
	io.Closer
}

File is basic file level accessing interface

func NewNopMFile 

func NewNopMFile(r NopMFileIF) File

type FileStreamer 

type FileStreamer interface {
	io.Reader
	io.Closer
	Obj
	GetMimetype() string
	//SetReader(io.Reader)
	NeedStore() bool
	IsForceStreamUpload() bool
	GetExist() Obj
	SetExist(Obj)
	//for a non-seekable Stream, RangeRead supports peeking some data, and CacheFullInTempFile still works
	RangeRead(http_range.Range) (io.Reader, error)
	//for a non-seekable Stream, if Read is called, this function won't work
	CacheFullInTempFile() (File, error)
}

FileStreamer ->check FileStream for more comments

type FsOtherArgs 

type FsOtherArgs struct {
	Path   string      `json:"path" form:"path"`
	Method string      `json:"method" form:"method"`
	Data   interface{} `json:"data" form:"data"`
}

type IndexProgress 

type IndexProgress struct {
	ObjCount     uint64     `json:"obj_count"`
	IsDone       bool       `json:"is_done"`
	LastDoneTime *time.Time `json:"last_done_time"`
	Error        string     `json:"error"`
}
type Link struct {
	URL             string            `json:"url"`    // most common way
	Header          http.Header       `json:"header"` // needed header (for url)
	RangeReadCloser RangeReadCloserIF `json:"-"`      // recommended way if can't use URL
	MFile           File              `json:"-"`      // best for local,smb... file system, which exposes MFile

	Expiration *time.Duration // local cache expire Duration
	IPCacheKey bool           `json:"-"` // add ip to cache key

	//for accelerating request, use multi-thread downloading
	Concurrency int `json:"concurrency"`
	PartSize    int `json:"part_size"`
}

type LinkArgs 

type LinkArgs struct {
	IP      string
	Header  http.Header
	Type    string
	HttpReq *http.Request
}

type ListArgs 

type ListArgs struct {
	ReqPath           string
	S3ShowPlaceholder bool
	Refresh           bool
}

type Meta 

type Meta struct {
	ID        uint   `json:"id" gorm:"primaryKey"`
	Path      string `json:"path" gorm:"unique" binding:"required"`
	Password  string `json:"password"`
	PSub      bool   `json:"p_sub"`
	Write     bool   `json:"write"`
	WSub      bool   `json:"w_sub"`
	Hide      string `json:"hide"`
	HSub      bool   `json:"h_sub"`
	Readme    string `json:"readme"`
	RSub      bool   `json:"r_sub"`
	Header    string `json:"header"`
	HeaderSub bool   `json:"header_sub"`
}

type NopMFile 

type NopMFile struct {
	NopMFileIF
}

func (NopMFile) Close 

func (NopMFile) Close() error

type NopMFileIF 

type NopMFileIF interface {
	io.Reader
	io.ReaderAt
	io.Seeker
}

type Obj 

type Obj interface {
	GetSize() int64
	GetName() string
	ModTime() time.Time
	CreateTime() time.Time
	IsDir() bool
	GetHash() utils.HashInfo

	// The internal information of the driver.
	// If you want to use it, please understand what it means
	GetID() string
	GetPath() string
}

func UnwrapObj 

func UnwrapObj(obj Obj) Obj

func WrapObjName 

func WrapObjName(objs Obj) Obj

type ObjMerge 

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

func NewObjMerge 

func NewObjMerge() *ObjMerge

Merge

func (*ObjMerge) InitHideReg 

func (om *ObjMerge) InitHideReg(hides string)

func (*ObjMerge) Merge 

func (om *ObjMerge) Merge(objs []Obj, objs_ ...Obj) []Obj

func (*ObjMerge) Reset 

func (om *ObjMerge) Reset()

type ObjThumb 

type ObjThumb struct {
	Object
	Thumbnail
}

type ObjThumbURL 

type ObjThumbURL struct {
	Object
	Thumbnail
	Url
}

type ObjUnwrap 

type ObjUnwrap interface {
	Unwrap() Obj
}

type ObjWrapName 

type ObjWrapName struct {
	Name string
	Obj
}

func (*ObjWrapName) GetName 

func (o *ObjWrapName) GetName() string

func (*ObjWrapName) Unwrap 

func (o *ObjWrapName) Unwrap() Obj

type Object 

type Object struct {
	ID       string
	Path     string
	Name     string
	Size     int64
	Modified time.Time
	Ctime    time.Time // file create time
	IsFolder bool
	HashInfo utils.HashInfo
}

func GetRawObject 

func GetRawObject(obj Obj) *Object

func (*Object) CreateTime 

func (o *Object) CreateTime() time.Time

func (*Object) GetHash 

func (o *Object) GetHash() utils.HashInfo

func (*Object) GetID 

func (o *Object) GetID() string

func (*Object) GetName 

func (o *Object) GetName() string

func (*Object) GetPath 

func (o *Object) GetPath() string

func (*Object) GetSize 

func (o *Object) GetSize() int64

func (*Object) IsDir 

func (o *Object) IsDir() bool

func (*Object) ModTime 

func (o *Object) ModTime() time.Time

func (*Object) SetPath 

func (o *Object) SetPath(path string)

type ObjectURL 

type ObjectURL struct {
	Object
	Url
}

type OtherArgs 

type OtherArgs struct {
	Obj    Obj
	Method string
	Data   interface{}
}

type PageReq 

type PageReq struct {
	Page    int `json:"page" form:"page"`
	PerPage int `json:"per_page" form:"per_page"`
}

func (*PageReq) Validate 

func (p *PageReq) Validate()

type Proxy 

type Proxy struct {
	WebProxy     bool   `json:"web_proxy"`
	WebdavPolicy string `json:"webdav_policy"`
	ProxyRange   bool   `json:"proxy_range"`
	DownProxyUrl string `json:"down_proxy_url"`
}

func (Proxy) Webdav302 

func (p Proxy) Webdav302() bool

func (Proxy) WebdavNative 

func (p Proxy) WebdavNative() bool

func (Proxy) WebdavProxy 

func (p Proxy) WebdavProxy() bool

type RangeReadCloser 

type RangeReadCloser struct {
	RangeReader RangeReaderFunc
	utils.Closers
}

func (RangeReadCloser) RangeRead 

func (r RangeReadCloser) RangeRead(ctx context.Context, httpRange http_range.Range) (io.ReadCloser, error)

type RangeReadCloserIF 

type RangeReadCloserIF interface {
	RangeRead(ctx context.Context, httpRange http_range.Range) (io.ReadCloser, error)
	utils.ClosersIF
}

type RangeReaderFunc 

type RangeReaderFunc func(ctx context.Context, httpRange http_range.Range) (io.ReadCloser, error)

type WriterFunc func(w io.Writer) error

type SearchNode 

type SearchNode struct {
	Parent string `json:"parent" gorm:"index"`
	Name   string `json:"name"`
	IsDir  bool   `json:"is_dir"`
	Size   int64  `json:"size"`
}

func (*SearchNode) Type 

func (s *SearchNode) Type() string

type SearchReq 

type SearchReq struct {
	Parent   string `json:"parent"`
	Keywords string `json:"keywords"`
	// 0 for all, 1 for dir, 2 for file
	Scope int `json:"scope"`
	PageReq
}

func (*SearchReq) Validate 

func (p *SearchReq) Validate() error

type SetPath 

type SetPath interface {
	SetPath(path string)
}

type SettingItem 

type SettingItem struct {
	Key        string `json:"key" gorm:"primaryKey" binding:"required"` // unique key
	Value      string `json:"value"`                                    // value
	PreDefault string `json:"-" gorm:"-:all"`                           // deprecated value
	Help       string `json:"help"`                                     // help message
	Type       string `json:"type"`                                     // string, number, bool, select
	Options    string `json:"options"`                                  // values for select
	Group      int    `json:"group"`                                    // use to group setting in frontend
	Flag       int    `json:"flag"`                                     // 0 = public, 1 = private, 2 = readonly, 3 = deprecated, etc.
}

func (SettingItem) IsDeprecated 

func (s SettingItem) IsDeprecated() bool

type Sort 

type Sort struct {
	OrderBy        string `json:"order_by"`
	OrderDirection string `json:"order_direction"`
	ExtractFolder  string `json:"extract_folder"`
}

type Storage 

type Storage struct {
	ID              uint      `json:"id" gorm:"primaryKey"`                        // unique key
	MountPath       string    `json:"mount_path" gorm:"unique" binding:"required"` // must be standardized
	Order           int       `json:"order"`                                       // use to sort
	Driver          string    `json:"driver"`                                      // driver used
	CacheExpiration int       `json:"cache_expiration"`                            // cache expire time
	Status          string    `json:"status"`
	Addition        string    `json:"addition" gorm:"type:text"` // Additional information, defined in the corresponding driver
	Remark          string    `json:"remark"`
	Modified        time.Time `json:"modified"`
	Disabled        bool      `json:"disabled"` // if disabled
	EnableSign      bool      `json:"enable_sign"`
	Sort
	Proxy
}

func (*Storage) GetStorage 

func (s *Storage) GetStorage() *Storage

func (*Storage) SetStatus 

func (s *Storage) SetStatus(status string)

func (*Storage) SetStorage 

func (s *Storage) SetStorage(storage Storage)

type Thumb 

type Thumb interface {
	Thumb() string
}

type Thumbnail 

type Thumbnail struct {
	Thumbnail string
}

func (Thumbnail) Thumb 

func (t Thumbnail) Thumb() string

type URL 

type URL interface {
	URL() string
}

type Url 

type Url struct {
	Url string
}

func (Url) URL 

func (w Url) URL() string

type User 

type User struct {
	ID       uint   `json:"id" gorm:"primaryKey"`                      // unique key
	Username string `json:"username" gorm:"unique" binding:"required"` // username
	PwdHash  string `json:"-"`                                         // password hash
	PwdTS    int64  `json:"-"`                                         // password timestamp
	Salt     string `json:"-"`                                         // unique salt
	Password string `json:"password"`                                  // password
	BasePath string `json:"base_path"`                                 // base path
	Role     int    `json:"role"`                                      // user's role
	Disabled bool   `json:"disabled"`
	// Determine permissions by bit
	//   0: can see hidden files
	//   1: can access without password
	//   2: can add offline download tasks
	//   3: can mkdir and upload
	//   4: can rename
	//   5: can move
	//   6: can copy
	//   7: can remove
	//   8: webdav read
	//   9: webdav write
	Permission int32  `json:"permission"`
	OtpSecret  string `json:"-"`
	SsoID      string `json:"sso_id"` // unique by sso platform
	Authn      string `gorm:"type:text" json:"-"`
}

func (*User) CanAccessWithoutPassword 

func (u *User) CanAccessWithoutPassword() bool

func (*User) CanAddOfflineDownloadTasks 

func (u *User) CanAddOfflineDownloadTasks() bool

func (*User) CanCopy 

func (u *User) CanCopy() bool

func (*User) CanMove 

func (u *User) CanMove() bool

func (*User) CanRemove 

func (u *User) CanRemove() bool

func (*User) CanRename 

func (u *User) CanRename() bool

func (*User) CanSeeHides 

func (u *User) CanSeeHides() bool

func (*User) CanWebdavManage 

func (u *User) CanWebdavManage() bool

func (*User) CanWebdavRead 

func (u *User) CanWebdavRead() bool

func (*User) CanWrite 

func (u *User) CanWrite() bool

func (*User) IsAdmin 

func (u *User) IsAdmin() bool

func (*User) IsGuest 

func (u *User) IsGuest() bool

func (*User) JoinPath 

func (u *User) JoinPath(reqPath string) (string, error)

func (*User) SetPassword 

func (u *User) SetPassword(pwd string) *User

func (*User) ValidatePwdStaticHash 

func (u *User) ValidatePwdStaticHash(pwdStaticHash string) error

func (*User) ValidateRawPassword 

func (u *User) ValidateRawPassword(password string) error

func (*User) WebAuthnCredentials 

func (u *User) WebAuthnCredentials() []webauthn.Credential

func (*User) WebAuthnDisplayName 

func (u *User) WebAuthnDisplayName() string

func (*User) WebAuthnID 

func (u *User) WebAuthnID() []byte

func (*User) WebAuthnIcon 

func (u *User) WebAuthnIcon() string

func (*User) WebAuthnName 

func (u *User) WebAuthnName() string

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.