handles

package

v0.0.0-...-6e53ccd Latest Latest Go to latest Published: Jul 29, 2025 License: AGPL-3.0 Imports: 58 Imported by: 0

Details

Valid go.mod file
Redistributable license
Tagged version
Stable version
Learn more about best practices

Repository

github.com/AlliotTech/openalist

Links

Open Source Insights

Documentation ¶

Index ¶

Constants
func AddMyPublicKey(c *gin.Context)
func AddOfflineDownload(c *gin.Context)
func ArchiveDown(c *gin.Context)
func ArchiveExtensions(c *gin.Context)
func ArchiveInternalExtract(c *gin.Context)
func ArchiveProxy(c *gin.Context)
func BeginAuthnLogin(c *gin.Context)
func BeginAuthnRegistration(c *gin.Context)
func BuildIndex(c *gin.Context)
func Cancel2FAById(c *gin.Context)
func ClearIndex(c *gin.Context)
func CreateMeta(c *gin.Context)
func CreateStorage(c *gin.Context)
func CreateUser(c *gin.Context)
func CurrentUser(c *gin.Context)
func DelUserCache(c *gin.Context)
func DeleteAuthnLogin(c *gin.Context)
func DeleteMeta(c *gin.Context)
func DeleteMyPublicKey(c *gin.Context)
func DeletePublicKey(c *gin.Context)
func DeleteSetting(c *gin.Context)
func DeleteStorage(c *gin.Context)
func DeleteUser(c *gin.Context)
func DisableStorage(c *gin.Context)
func Down(c *gin.Context)
func EnableStorage(c *gin.Context)
func Favicon(c *gin.Context)
func FinishAuthnLogin(c *gin.Context)
func FinishAuthnRegistration(c *gin.Context)
func FsArchiveDecompress(c *gin.Context)
func FsArchiveList(c *gin.Context)
func FsArchiveMeta(c *gin.Context)
func FsBatchRename(c *gin.Context)
func FsCopy(c *gin.Context)
func FsDirs(c *gin.Context)
func FsForm(c *gin.Context)
func FsGet(c *gin.Context)
func FsList(c *gin.Context)
func FsMkdir(c *gin.Context)
func FsMove(c *gin.Context)
func FsOther(c *gin.Context)
func FsRecursiveMove(c *gin.Context)
func FsRegexRename(c *gin.Context)
func FsRemove(c *gin.Context)
func FsRemoveEmptyDirectory(c *gin.Context)
func FsRename(c *gin.Context)
func FsStream(c *gin.Context)
func Generate2FA(c *gin.Context)
func GetAuthnCredentials(c *gin.Context)
func GetDriverInfo(c *gin.Context)
func GetMeta(c *gin.Context)
func GetOIDCClient(c *gin.Context, useCompatibility bool, redirectUri, method string) (*oauth2.Config, error)
func GetProgress(c *gin.Context)
func GetSetting(c *gin.Context)
func GetStorage(c *gin.Context)
func GetUser(c *gin.Context)
func Link(c *gin.Context)
func ListDriverInfo(c *gin.Context)
func ListDriverNames(c *gin.Context)
func ListMetas(c *gin.Context)
func ListMyPublicKey(c *gin.Context)
func ListPublicKeys(c *gin.Context)
func ListSettings(c *gin.Context)
func ListStorages(c *gin.Context)
func ListUsers(c *gin.Context)
func LoadAllStorages(c *gin.Context)
func LogOut(c *gin.Context)
func Login(c *gin.Context)
func LoginHash(c *gin.Context)
func LoginLdap(c *gin.Context)
func OIDCLoginCallback(c *gin.Context)
func OfflineDownloadTools(c *gin.Context)
func Plist(c *gin.Context)
func Proxy(c *gin.Context)
func PublicSettings(c *gin.Context)
func ResetToken(c *gin.Context)
func Robots(c *gin.Context)
func SSOLoginCallback(c *gin.Context)
func SSOLoginRedirect(c *gin.Context)
func SaveSettings(c *gin.Context)
func Search(c *gin.Context)
func Set115(c *gin.Context)
func SetAria2(c *gin.Context)
func SetPikPak(c *gin.Context)
func SetQbittorrent(c *gin.Context)
func SetThunder(c *gin.Context)
func SetTransmission(c *gin.Context)
func SetupTaskRoute(g *gin.RouterGroup)
func StopIndex(c *gin.Context)
func UpdateCurrent(c *gin.Context)
func UpdateIndex(c *gin.Context)
func UpdateMeta(c *gin.Context)
func UpdateStorage(c *gin.Context)
func UpdateUser(c *gin.Context)
func Verify2FA(c *gin.Context)
type AddOfflineDownloadReq
type ArchiveContentResp
type ArchiveDecompressReq
type ArchiveListReq
type ArchiveListResp
type ArchiveMetaReq
type ArchiveMetaResp
type BatchRenameReq
type DirReq
type DirResp
type FsGetReq
type FsGetResp
type FsListResp
type FsOtherReq
type ListReq
type LoginReq
type MkdirOrLinkReq
type MoveCopyReq
type ObjResp
type RecursiveMoveReq
type RegexRenameReq
type RemoveEmptyDirectoryReq
type RemoveReq
type RenameReq
type SSHKeyAddReq
type SearchReq
type SearchResp
type Set115Req
type SetAria2Req
type SetPikPakReq
type SetQbittorrentReq
type SetThunderReq
type SetTransmissionReq
type StringOrArray
- func (s *StringOrArray) UnmarshalJSON(data []byte) error
type TaskInfo
type UpdateIndexReq
type UserResp
type Verify2FAReq

Constants ¶

View Source

const (
	CANCEL    = "cancel"
	OVERWRITE = "overwrite"
	SKIP      = "skip"
)

Variables ¶

This section is empty.

Functions ¶

func AddMyPublicKey ¶

func AddMyPublicKey(c *gin.Context)

func AddOfflineDownload ¶

func AddOfflineDownload(c *gin.Context)

func ArchiveDown ¶

func ArchiveDown(c *gin.Context)

func ArchiveExtensions ¶

func ArchiveExtensions(c *gin.Context)

func ArchiveInternalExtract ¶

func ArchiveInternalExtract(c *gin.Context)

func ArchiveProxy ¶

func ArchiveProxy(c *gin.Context)

func BeginAuthnLogin ¶

func BeginAuthnLogin(c *gin.Context)

func BeginAuthnRegistration ¶

func BeginAuthnRegistration(c *gin.Context)

func BuildIndex ¶

func BuildIndex(c *gin.Context)

func Cancel2FAById ¶

func Cancel2FAById(c *gin.Context)

func ClearIndex ¶

func ClearIndex(c *gin.Context)

func CreateMeta ¶

func CreateMeta(c *gin.Context)

func CreateStorage ¶

func CreateStorage(c *gin.Context)

func CreateUser ¶

func CreateUser(c *gin.Context)

func CurrentUser ¶

func CurrentUser(c *gin.Context)

CurrentUser get current user by token if token is empty, return guest user

func DelUserCache ¶

func DelUserCache(c *gin.Context)

func DeleteAuthnLogin ¶

func DeleteAuthnLogin(c *gin.Context)

func DeleteMeta ¶

func DeleteMeta(c *gin.Context)

func DeleteMyPublicKey ¶

func DeleteMyPublicKey(c *gin.Context)

func DeletePublicKey ¶

func DeletePublicKey(c *gin.Context)

func DeleteSetting ¶

func DeleteSetting(c *gin.Context)

func DeleteStorage ¶

func DeleteStorage(c *gin.Context)

func DeleteUser ¶

func DeleteUser(c *gin.Context)

func DisableStorage ¶

func DisableStorage(c *gin.Context)

func Down ¶

func Down(c *gin.Context)

func EnableStorage ¶

func EnableStorage(c *gin.Context)

func Favicon ¶

func Favicon(c *gin.Context)

func FinishAuthnLogin ¶

func FinishAuthnLogin(c *gin.Context)

func FinishAuthnRegistration ¶

func FinishAuthnRegistration(c *gin.Context)

func FsArchiveDecompress ¶

func FsArchiveDecompress(c *gin.Context)

func FsArchiveList ¶

func FsArchiveList(c *gin.Context)

func FsArchiveMeta ¶

func FsArchiveMeta(c *gin.Context)

func FsBatchRename ¶

func FsBatchRename(c *gin.Context)

func FsCopy ¶

func FsCopy(c *gin.Context)

func FsDirs ¶

func FsDirs(c *gin.Context)

func FsForm ¶

func FsForm(c *gin.Context)

func FsGet ¶

func FsGet(c *gin.Context)

func FsList ¶

func FsList(c *gin.Context)

func FsMkdir ¶

func FsMkdir(c *gin.Context)

func FsMove ¶

func FsMove(c *gin.Context)

func FsOther ¶

func FsOther(c *gin.Context)

func FsRecursiveMove ¶

func FsRecursiveMove(c *gin.Context)

func FsRegexRename ¶

func FsRegexRename(c *gin.Context)

func FsRemove ¶

func FsRemove(c *gin.Context)

func FsRemoveEmptyDirectory ¶

func FsRemoveEmptyDirectory(c *gin.Context)

func FsRename ¶

func FsRename(c *gin.Context)

func FsStream ¶

func FsStream(c *gin.Context)

func Generate2FA ¶

func Generate2FA(c *gin.Context)

func GetAuthnCredentials ¶

func GetAuthnCredentials(c *gin.Context)

func GetDriverInfo ¶

func GetDriverInfo(c *gin.Context)

func GetMeta ¶

func GetMeta(c *gin.Context)

func GetOIDCClient ¶

func GetOIDCClient(c *gin.Context, useCompatibility bool, redirectUri, method string) (*oauth2.Config, error)

func GetProgress ¶

func GetProgress(c *gin.Context)

func GetSetting ¶

func GetSetting(c *gin.Context)

func GetStorage ¶

func GetStorage(c *gin.Context)

func GetUser ¶

func GetUser(c *gin.Context)

func Link ¶

func Link(c *gin.Context)

Link return real link, just for proxy program, it may contain cookie, so just allowed for admin

func ListDriverInfo ¶

func ListDriverInfo(c *gin.Context)

func ListDriverNames ¶

func ListDriverNames(c *gin.Context)

func ListMetas ¶

func ListMetas(c *gin.Context)

func ListMyPublicKey ¶

func ListMyPublicKey(c *gin.Context)

func ListPublicKeys ¶

func ListPublicKeys(c *gin.Context)

func ListSettings ¶

func ListSettings(c *gin.Context)

func ListStorages ¶

func ListStorages(c *gin.Context)

func ListUsers ¶

func ListUsers(c *gin.Context)

func LoadAllStorages ¶

func LoadAllStorages(c *gin.Context)

func LogOut ¶

func LogOut(c *gin.Context)

func Login(c *gin.Context)

Login Deprecated

func LoginHash ¶

func LoginHash(c *gin.Context)

LoginHash login with password hashed by sha256

func LoginLdap ¶

func LoginLdap(c *gin.Context)

func OIDCLoginCallback ¶

func OIDCLoginCallback(c *gin.Context)

func OfflineDownloadTools ¶

func OfflineDownloadTools(c *gin.Context)

func Plist ¶

func Plist(c *gin.Context)

func Proxy ¶

func Proxy(c *gin.Context)

func PublicSettings ¶

func PublicSettings(c *gin.Context)

func ResetToken ¶

func ResetToken(c *gin.Context)

func Robots ¶

func Robots(c *gin.Context)

func SSOLoginCallback ¶

func SSOLoginCallback(c *gin.Context)

func SSOLoginRedirect ¶

func SSOLoginRedirect(c *gin.Context)

func SaveSettings ¶

func SaveSettings(c *gin.Context)

func Search ¶

func Search(c *gin.Context)

func Set115 ¶

func Set115(c *gin.Context)

func SetAria2 ¶

func SetAria2(c *gin.Context)

func SetPikPak ¶

func SetPikPak(c *gin.Context)

func SetQbittorrent ¶

func SetQbittorrent(c *gin.Context)

func SetThunder ¶

func SetThunder(c *gin.Context)

func SetTransmission ¶

func SetTransmission(c *gin.Context)

func SetupTaskRoute ¶

func SetupTaskRoute(g *gin.RouterGroup)

func StopIndex ¶

func StopIndex(c *gin.Context)

func UpdateCurrent ¶

func UpdateCurrent(c *gin.Context)

func UpdateIndex ¶

func UpdateIndex(c *gin.Context)

func UpdateMeta ¶

func UpdateMeta(c *gin.Context)

func UpdateStorage ¶

func UpdateStorage(c *gin.Context)

func UpdateUser ¶

func UpdateUser(c *gin.Context)

func Verify2FA ¶

func Verify2FA(c *gin.Context)

Types ¶

type AddOfflineDownloadReq ¶

type AddOfflineDownloadReq struct {
	Urls         []string `json:"urls"`
	Path         string   `json:"path"`
	Tool         string   `json:"tool"`
	DeletePolicy string   `json:"delete_policy"`
}

type ArchiveContentResp ¶

type ArchiveContentResp struct {
	ObjResp
	Children []ArchiveContentResp `json:"children"`
}

type ArchiveDecompressReq ¶

type ArchiveDecompressReq struct {
	SrcDir        string        `json:"src_dir" form:"src_dir"`
	DstDir        string        `json:"dst_dir" form:"dst_dir"`
	Name          StringOrArray `json:"name" form:"name"`
	ArchivePass   string        `json:"archive_pass" form:"archive_pass"`
	InnerPath     string        `json:"inner_path" form:"inner_path"`
	CacheFull     bool          `json:"cache_full" form:"cache_full"`
	PutIntoNewDir bool          `json:"put_into_new_dir" form:"put_into_new_dir"`
}

type ArchiveListReq ¶

type ArchiveListReq struct {
	ArchiveMetaReq
	model.PageReq
	InnerPath string `json:"inner_path" form:"inner_path"`
}

type ArchiveListResp ¶

type ArchiveListResp struct {
	Content []ObjResp `json:"content"`
	Total   int64     `json:"total"`
}

type ArchiveMetaReq ¶

type ArchiveMetaReq struct {
	Path        string `json:"path" form:"path"`
	Password    string `json:"password" form:"password"`
	Refresh     bool   `json:"refresh" form:"refresh"`
	ArchivePass string `json:"archive_pass" form:"archive_pass"`
}

type ArchiveMetaResp ¶

type ArchiveMetaResp struct {
	Comment     string               `json:"comment"`
	IsEncrypted bool                 `json:"encrypted"`
	Content     []ArchiveContentResp `json:"content"`
	Sort        *model.Sort          `json:"sort,omitempty"`
	RawURL      string               `json:"raw_url"`
	Sign        string               `json:"sign"`
}

type BatchRenameReq ¶

type BatchRenameReq struct {
	SrcDir        string `json:"src_dir"`
	RenameObjects []struct {
		SrcName string `json:"src_name"`
		NewName string `json:"new_name"`
	} `json:"rename_objects"`
}

type DirReq ¶

type DirReq struct {
	Path      string `json:"path" form:"path"`
	Password  string `json:"password" form:"password"`
	ForceRoot bool   `json:"force_root" form:"force_root"`
}

type DirResp ¶

type DirResp struct {
	Name     string    `json:"name"`
	Modified time.Time `json:"modified"`
}

type FsGetReq ¶

type FsGetReq struct {
	Path     string `json:"path" form:"path"`
	Password string `json:"password" form:"password"`
}

type FsGetResp ¶

type FsGetResp struct {
	ObjResp
	RawURL   string    `json:"raw_url"`
	Readme   string    `json:"readme"`
	Header   string    `json:"header"`
	Provider string    `json:"provider"`
	Related  []ObjResp `json:"related"`
}

type FsListResp ¶

type FsListResp struct {
	Content  []ObjResp `json:"content"`
	Total    int64     `json:"total"`
	Readme   string    `json:"readme"`
	Header   string    `json:"header"`
	Write    bool      `json:"write"`
	Provider string    `json:"provider"`
}

type FsOtherReq ¶

type FsOtherReq struct {
	model.FsOtherArgs
	Password string `json:"password" form:"password"`
}

type ListReq ¶

type ListReq struct {
	model.PageReq
	Path     string `json:"path" form:"path"`
	Password string `json:"password" form:"password"`
	Refresh  bool   `json:"refresh"`
}

type LoginReq ¶

type LoginReq struct {
	Username string `json:"username" binding:"required"`
	Password string `json:"password"`
	OtpCode  string `json:"otp_code"`
}

type MkdirOrLinkReq ¶

type MkdirOrLinkReq struct {
	Path string `json:"path" form:"path"`
}

type MoveCopyReq ¶

type MoveCopyReq struct {
	SrcDir    string   `json:"src_dir"`
	DstDir    string   `json:"dst_dir"`
	Names     []string `json:"names"`
	Overwrite bool     `json:"overwrite"`
}

type ObjResp ¶

type ObjResp struct {
	Id          string                     `json:"id"`
	Path        string                     `json:"path"`
	Name        string                     `json:"name"`
	Size        int64                      `json:"size"`
	IsDir       bool                       `json:"is_dir"`
	Modified    time.Time                  `json:"modified"`
	Created     time.Time                  `json:"created"`
	Sign        string                     `json:"sign"`
	Thumb       string                     `json:"thumb"`
	Type        int                        `json:"type"`
	HashInfoStr string                     `json:"hashinfo"`
	HashInfo    map[*utils.HashType]string `json:"hash_info"`
}

type RecursiveMoveReq ¶

type RecursiveMoveReq struct {
	SrcDir         string `json:"src_dir"`
	DstDir         string `json:"dst_dir"`
	ConflictPolicy string `json:"conflict_policy"`
}

type RegexRenameReq ¶

type RegexRenameReq struct {
	SrcDir       string `json:"src_dir"`
	SrcNameRegex string `json:"src_name_regex"`
	NewNameRegex string `json:"new_name_regex"`
}

type RemoveEmptyDirectoryReq ¶

type RemoveEmptyDirectoryReq struct {
	SrcDir string `json:"src_dir"`
}

type RemoveReq ¶

type RemoveReq struct {
	Dir   string   `json:"dir"`
	Names []string `json:"names"`
}

type RenameReq ¶

type RenameReq struct {
	Path      string `json:"path"`
	Name      string `json:"name"`
	Overwrite bool   `json:"overwrite"`
}

type SSHKeyAddReq ¶

type SSHKeyAddReq struct {
	Title string `json:"title" binding:"required"`
	Key   string `json:"key" binding:"required"`
}

type SearchReq ¶

type SearchReq struct {
	model.SearchReq
	Password string `json:"password"`
}

type SearchResp ¶

type SearchResp struct {
	model.SearchNode
	Type int `json:"type"`
}

type Set115Req ¶

type Set115Req struct {
	TempDir string `json:"temp_dir" form:"temp_dir"`
}

type SetAria2Req ¶

type SetAria2Req struct {
	Uri    string `json:"uri" form:"uri"`
	Secret string `json:"secret" form:"secret"`
}

type SetPikPakReq ¶

type SetPikPakReq struct {
	TempDir string `json:"temp_dir" form:"temp_dir"`
}

type SetQbittorrentReq ¶

type SetQbittorrentReq struct {
	Url      string `json:"url" form:"url"`
	Seedtime string `json:"seedtime" form:"seedtime"`
}

type SetThunderReq ¶

type SetThunderReq struct {
	TempDir string `json:"temp_dir" form:"temp_dir"`
}

type SetTransmissionReq ¶

type SetTransmissionReq struct {
	Uri      string `json:"uri" form:"uri"`
	Seedtime string `json:"seedtime" form:"seedtime"`
}

type StringOrArray ¶

type StringOrArray []string

func (*StringOrArray) UnmarshalJSON ¶

func (s *StringOrArray) UnmarshalJSON(data []byte) error

type TaskInfo ¶

type TaskInfo struct {
	ID          string      `json:"id"`
	Name        string      `json:"name"`
	Creator     string      `json:"creator"`
	CreatorRole int         `json:"creator_role"`
	State       tache.State `json:"state"`
	Status      string      `json:"status"`
	Progress    float64     `json:"progress"`
	StartTime   *time.Time  `json:"start_time"`
	EndTime     *time.Time  `json:"end_time"`
	TotalBytes  int64       `json:"total_bytes"`
	Error       string      `json:"error"`
}

type UpdateIndexReq ¶

type UpdateIndexReq struct {
	Paths    []string `json:"paths"`
	MaxDepth int      `json:"max_depth"`
}

type UserResp ¶

type UserResp struct {
	model.User
	Otp bool `json:"otp"`
}

type Verify2FAReq ¶

type Verify2FAReq struct {
	Code   string `json:"code" binding:"required"`
	Secret string `json:"secret" binding:"required"`
}

?	: This menu
/	: Search site
f or F	: Jump to
y or Y	: Canonical URL