2021-06-08 18:33:54 -05:00
|
|
|
// Copyright 2021 The Gitea Authors. All rights reserved.
|
2022-11-27 13:20:29 -05:00
|
|
|
// SPDX-License-Identifier: MIT
|
2021-06-08 18:33:54 -05:00
|
|
|
|
|
|
|
package common
|
|
|
|
|
|
|
|
import (
|
|
|
|
"fmt"
|
|
|
|
"net/http"
|
|
|
|
"strings"
|
|
|
|
|
Add context cache as a request level cache (#22294)
To avoid duplicated load of the same data in an HTTP request, we can set
a context cache to do that. i.e. Some pages may load a user from a
database with the same id in different areas on the same page. But the
code is hidden in two different deep logic. How should we share the
user? As a result of this PR, now if both entry functions accept
`context.Context` as the first parameter and we just need to refactor
`GetUserByID` to reuse the user from the context cache. Then it will not
be loaded twice on an HTTP request.
But of course, sometimes we would like to reload an object from the
database, that's why `RemoveContextData` is also exposed.
The core context cache is here. It defines a new context
```go
type cacheContext struct {
ctx context.Context
data map[any]map[any]any
lock sync.RWMutex
}
var cacheContextKey = struct{}{}
func WithCacheContext(ctx context.Context) context.Context {
return context.WithValue(ctx, cacheContextKey, &cacheContext{
ctx: ctx,
data: make(map[any]map[any]any),
})
}
```
Then you can use the below 4 methods to read/write/del the data within
the same context.
```go
func GetContextData(ctx context.Context, tp, key any) any
func SetContextData(ctx context.Context, tp, key, value any)
func RemoveContextData(ctx context.Context, tp, key any)
func GetWithContextCache[T any](ctx context.Context, cacheGroupKey string, cacheTargetID any, f func() (T, error)) (T, error)
```
Then let's take a look at how `system.GetString` implement it.
```go
func GetSetting(ctx context.Context, key string) (string, error) {
return cache.GetWithContextCache(ctx, contextCacheKey, key, func() (string, error) {
return cache.GetString(genSettingCacheKey(key), func() (string, error) {
res, err := GetSettingNoCache(ctx, key)
if err != nil {
return "", err
}
return res.SettingValue, nil
})
})
}
```
First, it will check if context data include the setting object with the
key. If not, it will query from the global cache which may be memory or
a Redis cache. If not, it will get the object from the database. In the
end, if the object gets from the global cache or database, it will be
set into the context cache.
An object stored in the context cache will only be destroyed after the
context disappeared.
2023-02-15 08:37:34 -05:00
|
|
|
"code.gitea.io/gitea/modules/cache"
|
2021-11-30 15:06:32 -05:00
|
|
|
"code.gitea.io/gitea/modules/process"
|
2021-06-08 18:33:54 -05:00
|
|
|
"code.gitea.io/gitea/modules/setting"
|
2023-05-04 01:36:34 -05:00
|
|
|
"code.gitea.io/gitea/modules/web/middleware"
|
2022-01-20 06:41:25 -05:00
|
|
|
"code.gitea.io/gitea/modules/web/routing"
|
2024-02-27 02:12:22 -05:00
|
|
|
"code.gitea.io/gitea/services/context"
|
2021-06-08 18:33:54 -05:00
|
|
|
|
2024-08-22 20:08:06 -05:00
|
|
|
"code.forgejo.org/go-chi/session"
|
2021-06-08 18:33:54 -05:00
|
|
|
"github.com/chi-middleware/proxy"
|
2023-03-04 08:31:24 -05:00
|
|
|
chi "github.com/go-chi/chi/v5"
|
2021-06-08 18:33:54 -05:00
|
|
|
)
|
|
|
|
|
2023-05-04 01:36:34 -05:00
|
|
|
// ProtocolMiddlewares returns HTTP protocol related middlewares, and it provides a global panic recovery
|
2023-04-27 01:06:45 -05:00
|
|
|
func ProtocolMiddlewares() (handlers []any) {
|
2023-05-04 01:36:34 -05:00
|
|
|
// first, normalize the URL path
|
|
|
|
handlers = append(handlers, stripSlashesMiddleware)
|
|
|
|
|
|
|
|
// prepare the ContextData and panic recovery
|
2023-04-27 01:06:45 -05:00
|
|
|
handlers = append(handlers, func(next http.Handler) http.Handler {
|
|
|
|
return http.HandlerFunc(func(resp http.ResponseWriter, req *http.Request) {
|
2023-05-04 01:36:34 -05:00
|
|
|
defer func() {
|
|
|
|
if err := recover(); err != nil {
|
|
|
|
RenderPanicErrorPage(resp, req, err) // it should never panic
|
|
|
|
}
|
|
|
|
}()
|
|
|
|
req = req.WithContext(middleware.WithContextData(req.Context()))
|
|
|
|
next.ServeHTTP(resp, req)
|
|
|
|
})
|
|
|
|
})
|
2021-12-24 11:50:49 -05:00
|
|
|
|
2024-03-02 19:14:12 -05:00
|
|
|
// wrap the request and response, use the process context and add it to the process manager
|
2023-05-04 01:36:34 -05:00
|
|
|
handlers = append(handlers, func(next http.Handler) http.Handler {
|
|
|
|
return http.HandlerFunc(func(resp http.ResponseWriter, req *http.Request) {
|
2023-04-27 01:06:45 -05:00
|
|
|
ctx, _, finished := process.GetManager().AddTypedContext(req.Context(), fmt.Sprintf("%s: %s", req.Method, req.RequestURI), process.RequestProcessType, true)
|
|
|
|
defer finished()
|
2023-05-20 20:50:53 -05:00
|
|
|
next.ServeHTTP(context.WrapResponseWriter(resp), req.WithContext(cache.WithCacheContext(ctx)))
|
2023-04-27 01:06:45 -05:00
|
|
|
})
|
|
|
|
})
|
2021-06-08 18:33:54 -05:00
|
|
|
|
|
|
|
if setting.ReverseProxyLimit > 0 {
|
|
|
|
opt := proxy.NewForwardedHeadersOptions().
|
|
|
|
WithForwardLimit(setting.ReverseProxyLimit).
|
|
|
|
ClearTrustedProxies()
|
|
|
|
for _, n := range setting.ReverseProxyTrustedProxies {
|
|
|
|
if !strings.Contains(n, "/") {
|
|
|
|
opt.AddTrustedProxy(n)
|
|
|
|
} else {
|
|
|
|
opt.AddTrustedNetwork(n)
|
|
|
|
}
|
|
|
|
}
|
|
|
|
handlers = append(handlers, proxy.ForwardedHeaders(opt))
|
|
|
|
}
|
|
|
|
|
Rewrite logger system (#24726)
## ⚠️ Breaking
The `log.<mode>.<logger>` style config has been dropped. If you used it,
please check the new config manual & app.example.ini to make your
instance output logs as expected.
Although many legacy options still work, it's encouraged to upgrade to
the new options.
The SMTP logger is deleted because SMTP is not suitable to collect logs.
If you have manually configured Gitea log options, please confirm the
logger system works as expected after upgrading.
## Description
Close #12082 and maybe more log-related issues, resolve some related
FIXMEs in old code (which seems unfixable before)
Just like rewriting queue #24505 : make code maintainable, clear legacy
bugs, and add the ability to support more writers (eg: JSON, structured
log)
There is a new document (with examples): `logging-config.en-us.md`
This PR is safer than the queue rewriting, because it's just for
logging, it won't break other logic.
## The old problems
The logging system is quite old and difficult to maintain:
* Unclear concepts: Logger, NamedLogger, MultiChannelledLogger,
SubLogger, EventLogger, WriterLogger etc
* Some code is diffuclt to konw whether it is right:
`log.DelNamedLogger("console")` vs `log.DelNamedLogger(log.DEFAULT)` vs
`log.DelLogger("console")`
* The old system heavily depends on ini config system, it's difficult to
create new logger for different purpose, and it's very fragile.
* The "color" trick is difficult to use and read, many colors are
unnecessary, and in the future structured log could help
* It's difficult to add other log formats, eg: JSON format
* The log outputer doesn't have full control of its goroutine, it's
difficult to make outputer have advanced behaviors
* The logs could be lost in some cases: eg: no Fatal error when using
CLI.
* Config options are passed by JSON, which is quite fragile.
* INI package makes the KEY in `[log]` section visible in `[log.sub1]`
and `[log.sub1.subA]`, this behavior is quite fragile and would cause
more unclear problems, and there is no strong requirement to support
`log.<mode>.<logger>` syntax.
## The new design
See `logger.go` for documents.
## Screenshot
<details>
![image](https://github.com/go-gitea/gitea/assets/2114189/4462d713-ba39-41f5-bb08-de912e67e1ff)
![image](https://github.com/go-gitea/gitea/assets/2114189/b188035e-f691-428b-8b2d-ff7b2199b2f9)
![image](https://github.com/go-gitea/gitea/assets/2114189/132e9745-1c3b-4e00-9e0d-15eaea495dee)
</details>
## TODO
* [x] add some new tests
* [x] fix some tests
* [x] test some sub-commands (manually ....)
---------
Co-authored-by: Jason Song <i@wolfogre.com>
Co-authored-by: delvh <dev.lh@web.de>
Co-authored-by: Giteabot <teabot@gitea.io>
2023-05-21 17:35:11 -05:00
|
|
|
if setting.IsRouteLogEnabled() {
|
2022-01-20 06:41:25 -05:00
|
|
|
handlers = append(handlers, routing.NewLoggerHandler())
|
2021-06-08 18:33:54 -05:00
|
|
|
}
|
2022-01-20 06:41:25 -05:00
|
|
|
|
Rewrite logger system (#24726)
## ⚠️ Breaking
The `log.<mode>.<logger>` style config has been dropped. If you used it,
please check the new config manual & app.example.ini to make your
instance output logs as expected.
Although many legacy options still work, it's encouraged to upgrade to
the new options.
The SMTP logger is deleted because SMTP is not suitable to collect logs.
If you have manually configured Gitea log options, please confirm the
logger system works as expected after upgrading.
## Description
Close #12082 and maybe more log-related issues, resolve some related
FIXMEs in old code (which seems unfixable before)
Just like rewriting queue #24505 : make code maintainable, clear legacy
bugs, and add the ability to support more writers (eg: JSON, structured
log)
There is a new document (with examples): `logging-config.en-us.md`
This PR is safer than the queue rewriting, because it's just for
logging, it won't break other logic.
## The old problems
The logging system is quite old and difficult to maintain:
* Unclear concepts: Logger, NamedLogger, MultiChannelledLogger,
SubLogger, EventLogger, WriterLogger etc
* Some code is diffuclt to konw whether it is right:
`log.DelNamedLogger("console")` vs `log.DelNamedLogger(log.DEFAULT)` vs
`log.DelLogger("console")`
* The old system heavily depends on ini config system, it's difficult to
create new logger for different purpose, and it's very fragile.
* The "color" trick is difficult to use and read, many colors are
unnecessary, and in the future structured log could help
* It's difficult to add other log formats, eg: JSON format
* The log outputer doesn't have full control of its goroutine, it's
difficult to make outputer have advanced behaviors
* The logs could be lost in some cases: eg: no Fatal error when using
CLI.
* Config options are passed by JSON, which is quite fragile.
* INI package makes the KEY in `[log]` section visible in `[log.sub1]`
and `[log.sub1.subA]`, this behavior is quite fragile and would cause
more unclear problems, and there is no strong requirement to support
`log.<mode>.<logger>` syntax.
## The new design
See `logger.go` for documents.
## Screenshot
<details>
![image](https://github.com/go-gitea/gitea/assets/2114189/4462d713-ba39-41f5-bb08-de912e67e1ff)
![image](https://github.com/go-gitea/gitea/assets/2114189/b188035e-f691-428b-8b2d-ff7b2199b2f9)
![image](https://github.com/go-gitea/gitea/assets/2114189/132e9745-1c3b-4e00-9e0d-15eaea495dee)
</details>
## TODO
* [x] add some new tests
* [x] fix some tests
* [x] test some sub-commands (manually ....)
---------
Co-authored-by: Jason Song <i@wolfogre.com>
Co-authored-by: delvh <dev.lh@web.de>
Co-authored-by: Giteabot <teabot@gitea.io>
2023-05-21 17:35:11 -05:00
|
|
|
if setting.IsAccessLogEnabled() {
|
2021-06-08 18:33:54 -05:00
|
|
|
handlers = append(handlers, context.AccessLogger())
|
|
|
|
}
|
|
|
|
|
|
|
|
return handlers
|
|
|
|
}
|
2023-03-04 08:31:24 -05:00
|
|
|
|
|
|
|
func stripSlashesMiddleware(next http.Handler) http.Handler {
|
|
|
|
return http.HandlerFunc(func(resp http.ResponseWriter, req *http.Request) {
|
2023-05-04 01:36:34 -05:00
|
|
|
// First of all escape the URL RawPath to ensure that all routing is done using a correctly escaped URL
|
|
|
|
req.URL.RawPath = req.URL.EscapedPath()
|
|
|
|
|
|
|
|
urlPath := req.URL.RawPath
|
2023-03-04 08:31:24 -05:00
|
|
|
rctx := chi.RouteContext(req.Context())
|
|
|
|
if rctx != nil && rctx.RoutePath != "" {
|
|
|
|
urlPath = rctx.RoutePath
|
|
|
|
}
|
|
|
|
|
|
|
|
sanitizedPath := &strings.Builder{}
|
|
|
|
prevWasSlash := false
|
|
|
|
for _, chr := range strings.TrimRight(urlPath, "/") {
|
|
|
|
if chr != '/' || !prevWasSlash {
|
|
|
|
sanitizedPath.WriteRune(chr)
|
|
|
|
}
|
|
|
|
prevWasSlash = chr == '/'
|
|
|
|
}
|
|
|
|
|
|
|
|
if rctx == nil {
|
|
|
|
req.URL.Path = sanitizedPath.String()
|
|
|
|
} else {
|
|
|
|
rctx.RoutePath = sanitizedPath.String()
|
|
|
|
}
|
|
|
|
next.ServeHTTP(resp, req)
|
|
|
|
})
|
|
|
|
}
|
2023-04-27 01:06:45 -05:00
|
|
|
|
|
|
|
func Sessioner() func(next http.Handler) http.Handler {
|
|
|
|
return session.Sessioner(session.Options{
|
|
|
|
Provider: setting.SessionConfig.Provider,
|
|
|
|
ProviderConfig: setting.SessionConfig.ProviderConfig,
|
|
|
|
CookieName: setting.SessionConfig.CookieName,
|
|
|
|
CookiePath: setting.SessionConfig.CookiePath,
|
|
|
|
Gclifetime: setting.SessionConfig.Gclifetime,
|
|
|
|
Maxlifetime: setting.SessionConfig.Maxlifetime,
|
|
|
|
Secure: setting.SessionConfig.Secure,
|
|
|
|
SameSite: setting.SessionConfig.SameSite,
|
|
|
|
Domain: setting.SessionConfig.Domain,
|
|
|
|
})
|
|
|
|
}
|