common

Documentation

Index

• func FetchRedirectDelegate(resp http.ResponseWriter, req *http.Request)
• func InitDBEngine(ctx context.Context) (err error)
• func ProtocolMiddlewares() (handlers []any)
• func RenderMarkup(ctx *context.Base, repo *context.Repository, ...)
• func RenderPanicErrorPage(w http.ResponseWriter, req *http.Request, err any)
• func ServeBlob(ctx *context.Base, filePath string, blob *git.Blob, lastModified *time.Time) error
• func ServeContentByReadSeeker(ctx *context.Base, filePath string, modTime *time.Time, reader io.ReadSeeker)
• func ServeContentByReader(ctx *context.Base, filePath string, size int64, reader io.Reader)
• func Sessioner() func(next http.Handler) http.Handler
• type AuthResult
  • func AuthShared(ctx *context.Base, sessionStore auth_service.SessionStore, ...) (ar AuthResult, err error)
• type VerifyOptions

Functions

func FetchRedirectDelegate

func FetchRedirectDelegate(resp http.ResponseWriter, req *http.Request)

FetchRedirectDelegate helps the "fetch" requests to redirect to the correct location

func InitDBEngine

func InitDBEngine(ctx context.Context) (err error)

InitDBEngine In case of problems connecting to DB, retry connection. Eg, PGSQL in Docker Container on Synology

func ProtocolMiddlewares

func ProtocolMiddlewares() (handlers []any)

ProtocolMiddlewares returns HTTP protocol related middlewares, and it provides a global panic recovery

func RenderMarkup

func RenderMarkup(ctx *context.Base, repo *context.Repository, mode, text, urlPrefix, filePath string, wiki bool)

RenderMarkup renders markup text for the /markup and /markdown endpoints

func RenderPanicErrorPage

func RenderPanicErrorPage(w http.ResponseWriter, req *http.Request, err any)

RenderPanicErrorPage renders a 500 page, and it never panics

func ServeBlob

func ServeBlob(ctx *context.Base, filePath string, blob *git.Blob, lastModified *time.Time) error

ServeBlob download a git.Blob

func ServeContentByReadSeeker

func ServeContentByReadSeeker(ctx *context.Base, filePath string, modTime *time.Time, reader io.ReadSeeker)

func ServeContentByReader

func ServeContentByReader(ctx *context.Base, filePath string, size int64, reader io.Reader)

func Sessioner

func Sessioner() func(next http.Handler) http.Handler

Types

type AuthResult

type AuthResult struct {
	Doer        *user_model.User
	IsBasicAuth bool
}

func AuthShared

func AuthShared(ctx *context.Base, sessionStore auth_service.SessionStore, authMethod auth_service.Method) (ar AuthResult, err error)

type VerifyOptions

type VerifyOptions struct {
	SignInRequired  bool
	SignOutRequired bool
	AdminRequired   bool
	DisableCSRF     bool
}

VerifyOptions contains required or check options