common

package

v0.0.0-...-6e53ccd Latest Latest Go to latest Published: Jul 29, 2025 License: AGPL-3.0 Imports: 26 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 ¶

Variables
func CanAccess(user *model.User, meta *model.Meta, reqPath string, password string) bool
func CanWrite(meta *model.Meta, path string) bool
func ErrorResp(c *gin.Context, err error, code int, l ...bool)
func ErrorStrResp(c *gin.Context, str string, code int, l ...bool)
func ErrorWithDataResp(c *gin.Context, err error, code int, data interface{}, l ...bool)
func GenerateToken(user *model.User) (tokenString string, err error)
func GetApiUrl(r *http.Request) string
func GetEtag(file model.Obj) string
func GetHttpReq(ctx context.Context) *http.Request
func InvalidateToken(tokenString string) error
func IsApply(metaPath, reqPath string, applySub bool) bool
func IsStorageSignEnabled(rawPath string) bool
func IsTokenInvalidated(tokenString string) bool
func Pluralize(count int, singular, plural string) string
func Proxy(w http.ResponseWriter, r *http.Request, link *model.Link, file model.Obj) error
func ProxyRange(link *model.Link, size int64)
func ShouldProxy(storage driver.Driver, filename string) bool
func Sign(obj model.Obj, parent string, encrypt bool) string
func SuccessResp(c *gin.Context, data ...interface{})
func SuccessWithMsgResp(c *gin.Context, msg string, data ...interface{})
type InterceptResponseWriter
- func (iw *InterceptResponseWriter) Write(p []byte) (int, error)
type PageResp
type Resp
type UserClaims
- func ParseToken(tokenString string) (*UserClaims, error)
type WrittenResponseWriter
- func (ww *WrittenResponseWriter) IsWritten() bool
- func (ww *WrittenResponseWriter) Write(p []byte) (int, error)

Constants ¶

This section is empty.

Variables ¶

View Source

var NoProxyRange = &model.RangeReadCloser{}

View Source

var SecretKey []byte

Functions ¶

func CanAccess ¶

func CanAccess(user *model.User, meta *model.Meta, reqPath string, password string) bool

func CanWrite ¶

func CanWrite(meta *model.Meta, path string) bool

func ErrorResp ¶

func ErrorResp(c *gin.Context, err error, code int, l ...bool)

ErrorResp is used to return error response @param l: if true, log error

func ErrorStrResp ¶

func ErrorStrResp(c *gin.Context, str string, code int, l ...bool)

func ErrorWithDataResp ¶

func ErrorWithDataResp(c *gin.Context, err error, code int, data interface{}, l ...bool)

func GenerateToken ¶

func GenerateToken(user *model.User) (tokenString string, err error)

func GetApiUrl ¶

func GetApiUrl(r *http.Request) string

func GetEtag ¶

func GetEtag(file model.Obj) string

func GetHttpReq ¶

func GetHttpReq(ctx context.Context) *http.Request

func InvalidateToken ¶

func InvalidateToken(tokenString string) error

func IsApply ¶

func IsApply(metaPath, reqPath string, applySub bool) bool

func IsStorageSignEnabled ¶

func IsStorageSignEnabled(rawPath string) bool

func IsTokenInvalidated ¶

func IsTokenInvalidated(tokenString string) bool

func Pluralize ¶

func Pluralize(count int, singular, plural string) string

func Proxy ¶

func Proxy(w http.ResponseWriter, r *http.Request, link *model.Link, file model.Obj) error

func ProxyRange ¶

func ProxyRange(link *model.Link, size int64)

func ShouldProxy ¶

func ShouldProxy(storage driver.Driver, filename string) bool

ShouldProxy TODO need optimize when should be proxy? 1. config.MustProxy() 2. storage.WebProxy 3. proxy_types

func Sign ¶

func Sign(obj model.Obj, parent string, encrypt bool) string

func SuccessResp ¶

func SuccessResp(c *gin.Context, data ...interface{})

func SuccessWithMsgResp ¶

func SuccessWithMsgResp(c *gin.Context, msg string, data ...interface{})

Types ¶

type InterceptResponseWriter ¶

type InterceptResponseWriter struct {
	http.ResponseWriter
	io.Writer
}

func (*InterceptResponseWriter) Write ¶

func (iw *InterceptResponseWriter) Write(p []byte) (int, error)

type PageResp ¶

type PageResp struct {
	Content interface{} `json:"content"`
	Total   int64       `json:"total"`
}

type Resp ¶

type Resp[T any] struct {
	Code    int    `json:"code"`
	Message string `json:"message"`
	Data    T      `json:"data"`
}

type UserClaims ¶

type UserClaims struct {
	Username string `json:"username"`
	PwdTS    int64  `json:"pwd_ts"`
	jwt.RegisteredClaims
}

func ParseToken ¶

func ParseToken(tokenString string) (*UserClaims, error)

type WrittenResponseWriter ¶

type WrittenResponseWriter struct {
	http.ResponseWriter
	// contains filtered or unexported fields
}

func (*WrittenResponseWriter) IsWritten ¶

func (ww *WrittenResponseWriter) IsWritten() bool

func (*WrittenResponseWriter) Write ¶

func (ww *WrittenResponseWriter) Write(p []byte) (int, error)

Source Files ¶

View all Source files

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