1
0
Fork 0
forked from forgejo/forgejo

Update docs and comments to remove macaron (#14491)

This commit is contained in:
Lunny Xiao 2021-01-29 23:35:30 +08:00 committed by GitHub
parent 25b6255b92
commit 0cd87d64ff
No known key found for this signature in database
GPG key ID: 4AEE18F83AFDEB23
29 changed files with 32 additions and 78 deletions

View file

@ -23,7 +23,7 @@ import (
"gitea.com/go-chi/session"
)
// APIContext is a specific macaron context for API service
// APIContext is a specific context for API service
type APIContext struct {
*Context
Org *APIOrganization
@ -217,7 +217,7 @@ func (ctx *APIContext) CheckForOTP() {
}
}
// APIContexter returns apicontext as macaron middleware
// APIContexter returns apicontext as middleware
func APIContexter() func(http.Handler) http.Handler {
var csrfOpts = getCsrfOpts()

View file

@ -170,7 +170,7 @@ func HandleOrgAssignment(ctx *Context, args ...bool) {
}
}
// OrgAssignment returns a macaron middleware to handle organization assignment
// OrgAssignment returns a middleware to handle organization assignment
func OrgAssignment(args ...bool) func(ctx *Context) {
return func(ctx *Context) {
HandleOrgAssignment(ctx, args...)

View file

@ -9,7 +9,7 @@ import (
"code.gitea.io/gitea/modules/log"
)
// RequireRepoAdmin returns a macaron middleware for requiring repository admin permission
// RequireRepoAdmin returns a middleware for requiring repository admin permission
func RequireRepoAdmin() func(ctx *Context) {
return func(ctx *Context) {
if !ctx.IsSigned || !ctx.Repo.IsAdmin() {
@ -19,7 +19,7 @@ func RequireRepoAdmin() func(ctx *Context) {
}
}
// RequireRepoWriter returns a macaron middleware for requiring repository write to the specify unitType
// RequireRepoWriter returns a middleware for requiring repository write to the specify unitType
func RequireRepoWriter(unitType models.UnitType) func(ctx *Context) {
return func(ctx *Context) {
if !ctx.Repo.CanWrite(unitType) {
@ -29,7 +29,7 @@ func RequireRepoWriter(unitType models.UnitType) func(ctx *Context) {
}
}
// RequireRepoWriterOr returns a macaron middleware for requiring repository write to one of the unit permission
// RequireRepoWriterOr returns a middleware for requiring repository write to one of the unit permission
func RequireRepoWriterOr(unitTypes ...models.UnitType) func(ctx *Context) {
return func(ctx *Context) {
for _, unitType := range unitTypes {
@ -41,7 +41,7 @@ func RequireRepoWriterOr(unitTypes ...models.UnitType) func(ctx *Context) {
}
}
// RequireRepoReader returns a macaron middleware for requiring repository read to the specify unitType
// RequireRepoReader returns a middleware for requiring repository read to the specify unitType
func RequireRepoReader(unitType models.UnitType) func(ctx *Context) {
return func(ctx *Context) {
if !ctx.Repo.CanRead(unitType) {
@ -67,7 +67,7 @@ func RequireRepoReader(unitType models.UnitType) func(ctx *Context) {
}
}
// RequireRepoReaderOr returns a macaron middleware for requiring repository write to one of the unit permission
// RequireRepoReaderOr returns a middleware for requiring repository write to one of the unit permission
func RequireRepoReaderOr(unitTypes ...models.UnitType) func(ctx *Context) {
return func(ctx *Context) {
for _, unitType := range unitTypes {

View file

@ -28,7 +28,7 @@ func GetPrivateContext(req *http.Request) *PrivateContext {
return req.Context().Value(privateContextKey).(*PrivateContext)
}
// PrivateContexter returns apicontext as macaron middleware
// PrivateContexter returns apicontext as middleware
func PrivateContexter() func(http.Handler) http.Handler {
return func(next http.Handler) http.Handler {
return http.HandlerFunc(func(w http.ResponseWriter, req *http.Request) {

View file

@ -373,7 +373,7 @@ func repoAssignment(ctx *Context, repo *models.Repository) {
ctx.Data["IsEmptyRepo"] = ctx.Repo.Repository.IsEmpty
}
// RepoIDAssignment returns a macaron handler which assigns the repo to the context.
// RepoIDAssignment returns a handler which assigns the repo to the context.
func RepoIDAssignment() func(ctx *Context) {
return func(ctx *Context) {
repoID := ctx.ParamsInt64(":repoid")
@ -393,7 +393,7 @@ func RepoIDAssignment() func(ctx *Context) {
}
}
// RepoAssignment returns a macaron to handle repository assignment
// RepoAssignment returns a middleware to handle repository assignment
func RepoAssignment() func(http.Handler) http.Handler {
return func(next http.Handler) http.Handler {
return http.HandlerFunc(func(w http.ResponseWriter, req *http.Request) {
@ -849,7 +849,7 @@ func GitHookService() func(ctx *Context) {
}
}
// UnitTypes returns a macaron middleware to set unit types to context variables.
// UnitTypes returns a middleware to set unit types to context variables.
func UnitTypes() func(ctx *Context) {
return func(ctx *Context) {
ctx.Data["UnitTypeCode"] = models.UnitTypeCode

View file

@ -267,7 +267,7 @@ func NewLoggerAsWriter(level string, ourLoggers ...*MultiChannelledLogger) *Logg
return l
}
// Write implements the io.Writer interface to allow spoofing of macaron
// Write implements the io.Writer interface to allow spoofing of chi
func (l *LoggerAsWriter) Write(p []byte) (int, error) {
for _, logger := range l.ourLoggers {
// Skip = 3 because this presumes that we have been called by log.Println()

View file

@ -13,7 +13,7 @@ import (
"time"
)
// Static implements the macaron static handler for serving assets.
// Static implements the static handler for serving assets.
func Static(opts *Options) func(next http.Handler) http.Handler {
return opts.staticHandler(opts.Directory)
}

View file

@ -15,7 +15,7 @@ import (
"code.gitea.io/gitea/modules/setting"
)
// Options represents the available options to configure the macaron handler.
// Options represents the available options to configure the handler.
type Options struct {
Directory string
IndexFile string
@ -34,7 +34,7 @@ var KnownPublicEntries = []string{
"favicon.ico",
}
// Custom implements the macaron static handler for serving custom assets.
// Custom implements the static handler for serving custom assets.
func Custom(opts *Options) func(next http.Handler) http.Handler {
return opts.staticHandler(path.Join(setting.CustomPath, "public"))
}

View file

@ -20,7 +20,7 @@ import (
"code.gitea.io/gitea/modules/log"
)
// Static implements the macaron static handler for serving assets.
// Static implements the static handler for serving assets.
func Static(opts *Options) func(next http.Handler) http.Handler {
opts.FileSystem = Assets
// we don't need to pass the directory, because the directory var is only

View file

@ -273,7 +273,7 @@ func newRouterLogService() {
// Allow [log] DISABLE_ROUTER_LOG to override [server] DISABLE_ROUTER_LOG
DisableRouterLog = Cfg.Section("log").Key("DISABLE_ROUTER_LOG").MustBool(DisableRouterLog)
if !DisableRouterLog && RedirectMacaronLog {
if !DisableRouterLog {
options := newDefaultLogOptions()
options.filename = filepath.Join(LogRootPath, "router.log")
options.flags = "date,time" // For the router we don't want any prefixed flags

View file

@ -288,7 +288,6 @@ var (
LogLevel string
StacktraceLogLevel string
LogRootPath string
RedirectMacaronLog bool
DisableRouterLog bool
RouterLogLevel log.Level
RouterLogMode string
@ -539,7 +538,6 @@ func NewContext() {
StacktraceLogLevel = getStacktraceLogLevel(Cfg.Section("log"), "STACKTRACE_LEVEL", "None")
LogRootPath = Cfg.Section("log").Key("ROOT_PATH").MustString(path.Join(AppWorkPath, "log"))
forcePathSeparator(LogRootPath)
RedirectMacaronLog = Cfg.Section("log").Key("REDIRECT_MACARON_LOG").MustBool(false)
RouterLogLevel = log.FromString(Cfg.Section("log").Key("ROUTER_LOG_LEVEL").MustString("Info"))
sec := Cfg.Section("server")

View file

@ -49,7 +49,6 @@ func InitLocales() {
}
}
// These codes will be used once macaron removed
tags := make([]language.Tag, len(setting.Langs))
for i, lang := range setting.Langs {
tags[i] = language.Raw.Make(lang)