2015-12-03 00:24:37 -05:00
|
|
|
// Copyright 2015 The Gogs Authors. All rights reserved.
|
2022-11-27 13:20:29 -05:00
|
|
|
// SPDX-License-Identifier: MIT
|
2015-12-03 00:24:37 -05:00
|
|
|
|
2015-12-04 17:16:42 -05:00
|
|
|
package user
|
2015-12-03 00:24:37 -05:00
|
|
|
|
|
|
|
|
import (
|
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
|
|
|
std_ctx "context"
|
2024-03-04 02:50:21 -05:00
|
|
|
"fmt"
|
2019-12-20 12:07:12 -05:00
|
|
|
"net/http"
|
|
|
|
|
|
2021-12-10 03:14:24 -05:00
|
|
|
asymkey_model "code.gitea.io/gitea/models/asymkey"
|
2023-11-23 22:49:41 -05:00
|
|
|
"code.gitea.io/gitea/models/db"
|
2021-11-28 06:58:28 -05:00
|
|
|
"code.gitea.io/gitea/models/perm"
|
2021-11-24 04:49:20 -05:00
|
|
|
user_model "code.gitea.io/gitea/models/user"
|
2016-11-10 11:24:48 -05:00
|
|
|
"code.gitea.io/gitea/modules/setting"
|
2019-08-23 12:40:30 -04:00
|
|
|
api "code.gitea.io/gitea/modules/structs"
|
2021-01-26 10:36:53 -05:00
|
|
|
"code.gitea.io/gitea/modules/web"
|
2016-11-10 11:24:48 -05:00
|
|
|
"code.gitea.io/gitea/routers/api/v1/repo"
|
2020-01-24 14:00:29 -05:00
|
|
|
"code.gitea.io/gitea/routers/api/v1/utils"
|
2021-12-10 03:14:24 -05:00
|
|
|
asymkey_service "code.gitea.io/gitea/services/asymkey"
|
2024-02-27 02:12:22 -05:00
|
|
|
"code.gitea.io/gitea/services/context"
|
2022-12-28 21:57:15 -05:00
|
|
|
"code.gitea.io/gitea/services/convert"
|
2015-12-03 00:24:37 -05:00
|
|
|
)
|
|
|
|
|
|
2018-10-31 23:40:49 -04:00
|
|
|
// appendPrivateInformation appends the owner and key type information to api.PublicKey
|
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
|
|
|
func appendPrivateInformation(ctx std_ctx.Context, apiKey *api.PublicKey, key *asymkey_model.PublicKey, defaultUser *user_model.User) (*api.PublicKey, error) {
|
2021-12-10 03:14:24 -05:00
|
|
|
if key.Type == asymkey_model.KeyTypeDeploy {
|
2018-10-31 23:40:49 -04:00
|
|
|
apiKey.KeyType = "deploy"
|
2021-12-10 03:14:24 -05:00
|
|
|
} else if key.Type == asymkey_model.KeyTypeUser {
|
2018-10-31 23:40:49 -04:00
|
|
|
apiKey.KeyType = "user"
|
|
|
|
|
|
|
|
|
|
if defaultUser.ID == key.OwnerID {
|
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
|
|
|
apiKey.Owner = convert.ToUser(ctx, defaultUser, defaultUser)
|
2018-10-31 23:40:49 -04:00
|
|
|
} else {
|
2023-07-23 23:47:27 -04:00
|
|
|
user, err := user_model.GetUserByID(ctx, key.OwnerID)
|
2018-10-31 23:40:49 -04:00
|
|
|
if err != nil {
|
|
|
|
|
return apiKey, err
|
|
|
|
|
}
|
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
|
|
|
apiKey.Owner = convert.ToUser(ctx, user, user)
|
2018-10-31 23:40:49 -04:00
|
|
|
}
|
|
|
|
|
} else {
|
|
|
|
|
apiKey.KeyType = "unknown"
|
|
|
|
|
}
|
2021-11-28 06:58:28 -05:00
|
|
|
apiKey.ReadOnly = key.Mode == perm.AccessModeRead
|
2018-10-31 23:40:49 -04:00
|
|
|
return apiKey, nil
|
|
|
|
|
}
|
|
|
|
|
|
2015-12-03 00:24:37 -05:00
|
|
|
func composePublicKeysAPILink() string {
|
2016-11-27 05:14:25 -05:00
|
|
|
return setting.AppURL + "api/v1/user/keys/"
|
2015-12-03 00:24:37 -05:00
|
|
|
}
|
|
|
|
|
|
2021-11-24 04:49:20 -05:00
|
|
|
func listPublicKeys(ctx *context.APIContext, user *user_model.User) {
|
2021-12-10 03:14:24 -05:00
|
|
|
var keys []*asymkey_model.PublicKey
|
2018-10-31 23:40:49 -04:00
|
|
|
var err error
|
2021-08-12 08:43:08 -04:00
|
|
|
var count int
|
2018-10-31 23:40:49 -04:00
|
|
|
|
2021-08-10 20:31:13 -04:00
|
|
|
fingerprint := ctx.FormString("fingerprint")
|
2018-10-31 23:40:49 -04:00
|
|
|
username := ctx.Params("username")
|
|
|
|
|
|
|
|
|
|
if fingerprint != "" {
|
2023-11-23 22:49:41 -05:00
|
|
|
var userID int64 // Unrestricted
|
2018-10-31 23:40:49 -04:00
|
|
|
// Querying not just listing
|
|
|
|
|
if username != "" {
|
|
|
|
|
// Restrict to provided uid
|
2023-11-23 22:49:41 -05:00
|
|
|
userID = user.ID
|
2018-10-31 23:40:49 -04:00
|
|
|
}
|
2023-11-23 22:49:41 -05:00
|
|
|
keys, err = db.Find[asymkey_model.PublicKey](ctx, asymkey_model.FindPublicKeyOptions{
|
|
|
|
|
OwnerID: userID,
|
|
|
|
|
Fingerprint: fingerprint,
|
|
|
|
|
})
|
2021-08-12 08:43:08 -04:00
|
|
|
count = len(keys)
|
2018-10-31 23:40:49 -04:00
|
|
|
} else {
|
2023-11-23 22:49:41 -05:00
|
|
|
var total int64
|
2018-10-31 23:40:49 -04:00
|
|
|
// Use ListPublicKeys
|
2023-11-23 22:49:41 -05:00
|
|
|
keys, total, err = db.FindAndCount[asymkey_model.PublicKey](ctx, asymkey_model.FindPublicKeyOptions{
|
|
|
|
|
ListOptions: utils.GetListOptions(ctx),
|
|
|
|
|
OwnerID: user.ID,
|
|
|
|
|
NotKeytype: asymkey_model.KeyTypePrincipal,
|
|
|
|
|
})
|
|
|
|
|
count = int(total)
|
2018-10-31 23:40:49 -04:00
|
|
|
}
|
|
|
|
|
|
2015-12-03 00:24:37 -05:00
|
|
|
if err != nil {
|
2019-12-20 12:07:12 -05:00
|
|
|
ctx.Error(http.StatusInternalServerError, "ListPublicKeys", err)
|
2015-12-03 00:24:37 -05:00
|
|
|
return
|
|
|
|
|
}
|
|
|
|
|
|
|
|
|
|
apiLink := composePublicKeysAPILink()
|
|
|
|
|
apiKeys := make([]*api.PublicKey, len(keys))
|
|
|
|
|
for i := range keys {
|
2016-03-13 23:20:22 -04:00
|
|
|
apiKeys[i] = convert.ToPublicKey(apiLink, keys[i])
|
2022-03-22 03:03:22 -04:00
|
|
|
if ctx.Doer.IsAdmin || ctx.Doer.ID == keys[i].OwnerID {
|
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
|
|
|
apiKeys[i], _ = appendPrivateInformation(ctx, apiKeys[i], keys[i], user)
|
2018-10-31 23:40:49 -04:00
|
|
|
}
|
2015-12-03 00:24:37 -05:00
|
|
|
}
|
|
|
|
|
|
2021-08-12 08:43:08 -04:00
|
|
|
ctx.SetTotalCountHeader(int64(count))
|
2019-12-20 12:07:12 -05:00
|
|
|
ctx.JSON(http.StatusOK, &apiKeys)
|
2015-12-03 00:24:37 -05:00
|
|
|
}
|
|
|
|
|
|
2017-11-13 02:02:25 -05:00
|
|
|
// ListMyPublicKeys list all of the authenticated user's public keys
|
2016-03-13 18:49:16 -04:00
|
|
|
func ListMyPublicKeys(ctx *context.APIContext) {
|
2017-11-13 02:02:25 -05:00
|
|
|
// swagger:operation GET /user/keys user userCurrentListKeys
|
|
|
|
|
// ---
|
|
|
|
|
// summary: List the authenticated user's public keys
|
2018-10-31 23:40:49 -04:00
|
|
|
// parameters:
|
|
|
|
|
// - name: fingerprint
|
|
|
|
|
// in: query
|
|
|
|
|
// description: fingerprint of the key
|
|
|
|
|
// type: string
|
2020-01-24 14:00:29 -05:00
|
|
|
// - name: page
|
|
|
|
|
// in: query
|
|
|
|
|
// description: page number of results to return (1-based)
|
|
|
|
|
// type: integer
|
|
|
|
|
// - name: limit
|
|
|
|
|
// in: query
|
2020-06-09 00:57:38 -04:00
|
|
|
// description: page size of results
|
2020-01-24 14:00:29 -05:00
|
|
|
// type: integer
|
2017-11-13 02:02:25 -05:00
|
|
|
// produces:
|
|
|
|
|
// - application/json
|
|
|
|
|
// responses:
|
|
|
|
|
// "200":
|
|
|
|
|
// "$ref": "#/responses/PublicKeyList"
|
2024-11-23 04:33:55 -05:00
|
|
|
// "401":
|
|
|
|
|
// "$ref": "#/responses/unauthorized"
|
|
|
|
|
// "403":
|
|
|
|
|
// "$ref": "#/responses/forbidden"
|
2019-12-20 12:07:12 -05:00
|
|
|
|
2022-03-22 03:03:22 -04:00
|
|
|
listPublicKeys(ctx, ctx.Doer)
|
2015-12-04 17:16:42 -05:00
|
|
|
}
|
|
|
|
|
|
2017-11-13 02:02:25 -05:00
|
|
|
// ListPublicKeys list the given user's public keys
|
2016-03-13 18:49:16 -04:00
|
|
|
func ListPublicKeys(ctx *context.APIContext) {
|
2017-11-13 02:02:25 -05:00
|
|
|
// swagger:operation GET /users/{username}/keys user userListKeys
|
|
|
|
|
// ---
|
|
|
|
|
// summary: List the given user's public keys
|
|
|
|
|
// produces:
|
|
|
|
|
// - application/json
|
|
|
|
|
// parameters:
|
|
|
|
|
// - name: username
|
|
|
|
|
// in: path
|
|
|
|
|
// description: username of user
|
|
|
|
|
// type: string
|
|
|
|
|
// required: true
|
2018-10-31 23:40:49 -04:00
|
|
|
// - name: fingerprint
|
|
|
|
|
// in: query
|
|
|
|
|
// description: fingerprint of the key
|
|
|
|
|
// type: string
|
2020-01-24 14:00:29 -05:00
|
|
|
// - name: page
|
|
|
|
|
// in: query
|
|
|
|
|
// description: page number of results to return (1-based)
|
|
|
|
|
// type: integer
|
|
|
|
|
// - name: limit
|
|
|
|
|
// in: query
|
2020-06-09 00:57:38 -04:00
|
|
|
// description: page size of results
|
2020-01-24 14:00:29 -05:00
|
|
|
// type: integer
|
2017-11-13 02:02:25 -05:00
|
|
|
// responses:
|
|
|
|
|
// "200":
|
|
|
|
|
// "$ref": "#/responses/PublicKeyList"
|
2023-09-12 22:37:54 -04:00
|
|
|
// "404":
|
|
|
|
|
// "$ref": "#/responses/notFound"
|
2019-12-20 12:07:12 -05:00
|
|
|
|
2022-03-26 05:04:22 -04:00
|
|
|
listPublicKeys(ctx, ctx.ContextUser)
|
2015-12-03 00:24:37 -05:00
|
|
|
}
|
|
|
|
|
|
2017-11-13 02:02:25 -05:00
|
|
|
// GetPublicKey get a public key
|
2016-03-13 18:49:16 -04:00
|
|
|
func GetPublicKey(ctx *context.APIContext) {
|
2017-11-13 02:02:25 -05:00
|
|
|
// swagger:operation GET /user/keys/{id} user userCurrentGetKey
|
|
|
|
|
// ---
|
|
|
|
|
// summary: Get a public key
|
|
|
|
|
// produces:
|
|
|
|
|
// - application/json
|
|
|
|
|
// parameters:
|
|
|
|
|
// - name: id
|
|
|
|
|
// in: path
|
|
|
|
|
// description: id of key to get
|
|
|
|
|
// type: integer
|
2018-10-20 23:40:42 -04:00
|
|
|
// format: int64
|
2017-11-13 02:02:25 -05:00
|
|
|
// required: true
|
|
|
|
|
// responses:
|
|
|
|
|
// "200":
|
|
|
|
|
// "$ref": "#/responses/PublicKey"
|
2024-11-23 04:33:55 -05:00
|
|
|
// "401":
|
|
|
|
|
// "$ref": "#/responses/unauthorized"
|
|
|
|
|
// "403":
|
|
|
|
|
// "$ref": "#/responses/forbidden"
|
2017-11-13 02:02:25 -05:00
|
|
|
// "404":
|
|
|
|
|
// "$ref": "#/responses/notFound"
|
2019-12-20 12:07:12 -05:00
|
|
|
|
2023-10-11 00:24:07 -04:00
|
|
|
key, err := asymkey_model.GetPublicKeyByID(ctx, ctx.ParamsInt64(":id"))
|
2015-12-03 00:24:37 -05:00
|
|
|
if err != nil {
|
2021-12-10 03:14:24 -05:00
|
|
|
if asymkey_model.IsErrKeyNotExist(err) {
|
2019-03-18 22:29:43 -04:00
|
|
|
ctx.NotFound()
|
2015-12-03 00:24:37 -05:00
|
|
|
} else {
|
2019-12-20 12:07:12 -05:00
|
|
|
ctx.Error(http.StatusInternalServerError, "GetPublicKeyByID", err)
|
2015-12-03 00:24:37 -05:00
|
|
|
}
|
|
|
|
|
return
|
|
|
|
|
}
|
|
|
|
|
|
|
|
|
|
apiLink := composePublicKeysAPILink()
|
2018-10-31 23:40:49 -04:00
|
|
|
apiKey := convert.ToPublicKey(apiLink, key)
|
2022-03-22 03:03:22 -04:00
|
|
|
if ctx.Doer.IsAdmin || ctx.Doer.ID == key.OwnerID {
|
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
|
|
|
apiKey, _ = appendPrivateInformation(ctx, apiKey, key, ctx.Doer)
|
2018-10-31 23:40:49 -04:00
|
|
|
}
|
2019-12-20 12:07:12 -05:00
|
|
|
ctx.JSON(http.StatusOK, apiKey)
|
2015-12-03 00:24:37 -05:00
|
|
|
}
|
|
|
|
|
|
2015-12-05 17:13:13 -05:00
|
|
|
// CreateUserPublicKey creates new public key to given user by ID.
|
2016-03-13 18:49:16 -04:00
|
|
|
func CreateUserPublicKey(ctx *context.APIContext, form api.CreateKeyOption, uid int64) {
|
2024-03-29 11:05:41 -04:00
|
|
|
if user_model.IsFeatureDisabledWithLoginType(ctx.Doer, setting.UserFeatureManageSSHKeys) {
|
2024-03-04 02:50:21 -05:00
|
|
|
ctx.NotFound("Not Found", fmt.Errorf("ssh keys setting is not allowed to be visited"))
|
|
|
|
|
return
|
|
|
|
|
}
|
|
|
|
|
|
2021-12-10 03:14:24 -05:00
|
|
|
content, err := asymkey_model.CheckPublicKeyString(form.Key)
|
2015-12-03 00:24:37 -05:00
|
|
|
if err != nil {
|
2015-12-04 17:16:42 -05:00
|
|
|
repo.HandleCheckKeyStringError(ctx, err)
|
2015-12-03 00:24:37 -05:00
|
|
|
return
|
|
|
|
|
}
|
|
|
|
|
|
2023-10-11 00:24:07 -04:00
|
|
|
key, err := asymkey_model.AddPublicKey(ctx, uid, form.Title, content, 0)
|
2015-12-03 00:24:37 -05:00
|
|
|
if err != nil {
|
2015-12-04 17:16:42 -05:00
|
|
|
repo.HandleAddKeyError(ctx, err)
|
2015-12-03 00:24:37 -05:00
|
|
|
return
|
|
|
|
|
}
|
|
|
|
|
apiLink := composePublicKeysAPILink()
|
2018-10-31 23:40:49 -04:00
|
|
|
apiKey := convert.ToPublicKey(apiLink, key)
|
2022-03-22 03:03:22 -04:00
|
|
|
if ctx.Doer.IsAdmin || ctx.Doer.ID == key.OwnerID {
|
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
|
|
|
apiKey, _ = appendPrivateInformation(ctx, apiKey, key, ctx.Doer)
|
2018-10-31 23:40:49 -04:00
|
|
|
}
|
2019-12-20 12:07:12 -05:00
|
|
|
ctx.JSON(http.StatusCreated, apiKey)
|
2015-12-04 17:16:42 -05:00
|
|
|
}
|
|
|
|
|
|
2016-11-24 02:04:31 -05:00
|
|
|
// CreatePublicKey create one public key for me
|
2021-01-26 10:36:53 -05:00
|
|
|
func CreatePublicKey(ctx *context.APIContext) {
|
2017-11-13 02:02:25 -05:00
|
|
|
// swagger:operation POST /user/keys user userCurrentPostKey
|
|
|
|
|
// ---
|
|
|
|
|
// summary: Create a public key
|
|
|
|
|
// consumes:
|
|
|
|
|
// - application/json
|
|
|
|
|
// produces:
|
|
|
|
|
// - application/json
|
|
|
|
|
// parameters:
|
|
|
|
|
// - name: body
|
|
|
|
|
// in: body
|
|
|
|
|
// schema:
|
|
|
|
|
// "$ref": "#/definitions/CreateKeyOption"
|
|
|
|
|
// responses:
|
|
|
|
|
// "201":
|
|
|
|
|
// "$ref": "#/responses/PublicKey"
|
2024-11-23 04:33:55 -05:00
|
|
|
// "401":
|
|
|
|
|
// "$ref": "#/responses/unauthorized"
|
|
|
|
|
// "403":
|
|
|
|
|
// "$ref": "#/responses/forbidden"
|
2017-11-13 02:02:25 -05:00
|
|
|
// "422":
|
|
|
|
|
// "$ref": "#/responses/validationError"
|
2019-12-20 12:07:12 -05:00
|
|
|
|
2021-01-26 10:36:53 -05:00
|
|
|
form := web.GetForm(ctx).(*api.CreateKeyOption)
|
2022-03-22 03:03:22 -04:00
|
|
|
CreateUserPublicKey(ctx, *form, ctx.Doer.ID)
|
2015-12-03 00:24:37 -05:00
|
|
|
}
|
|
|
|
|
|
2017-11-13 02:02:25 -05:00
|
|
|
// DeletePublicKey delete one public key
|
2016-03-13 18:49:16 -04:00
|
|
|
func DeletePublicKey(ctx *context.APIContext) {
|
2017-11-13 02:02:25 -05:00
|
|
|
// swagger:operation DELETE /user/keys/{id} user userCurrentDeleteKey
|
|
|
|
|
// ---
|
|
|
|
|
// summary: Delete a public key
|
|
|
|
|
// produces:
|
|
|
|
|
// - application/json
|
|
|
|
|
// parameters:
|
|
|
|
|
// - name: id
|
|
|
|
|
// in: path
|
|
|
|
|
// description: id of key to delete
|
|
|
|
|
// type: integer
|
2018-10-20 23:40:42 -04:00
|
|
|
// format: int64
|
2017-11-13 02:02:25 -05:00
|
|
|
// required: true
|
|
|
|
|
// responses:
|
|
|
|
|
// "204":
|
|
|
|
|
// "$ref": "#/responses/empty"
|
2024-11-23 04:33:55 -05:00
|
|
|
// "401":
|
|
|
|
|
// "$ref": "#/responses/unauthorized"
|
2017-11-13 02:02:25 -05:00
|
|
|
// "403":
|
|
|
|
|
// "$ref": "#/responses/forbidden"
|
2017-12-06 05:27:10 -05:00
|
|
|
// "404":
|
|
|
|
|
// "$ref": "#/responses/notFound"
|
2019-12-20 12:07:12 -05:00
|
|
|
|
2024-03-29 11:05:41 -04:00
|
|
|
if user_model.IsFeatureDisabledWithLoginType(ctx.Doer, setting.UserFeatureManageSSHKeys) {
|
2024-03-04 02:50:21 -05:00
|
|
|
ctx.NotFound("Not Found", fmt.Errorf("ssh keys setting is not allowed to be visited"))
|
|
|
|
|
return
|
|
|
|
|
}
|
|
|
|
|
|
2020-12-25 23:24:47 -05:00
|
|
|
id := ctx.ParamsInt64(":id")
|
2023-10-11 00:24:07 -04:00
|
|
|
externallyManaged, err := asymkey_model.PublicKeyIsExternallyManaged(ctx, id)
|
2020-12-25 23:24:47 -05:00
|
|
|
if err != nil {
|
2022-04-20 21:08:30 -04:00
|
|
|
if asymkey_model.IsErrKeyNotExist(err) {
|
|
|
|
|
ctx.NotFound()
|
|
|
|
|
} else {
|
|
|
|
|
ctx.Error(http.StatusInternalServerError, "PublicKeyIsExternallyManaged", err)
|
|
|
|
|
}
|
|
|
|
|
return
|
2020-12-25 23:24:47 -05:00
|
|
|
}
|
2022-04-20 21:08:30 -04:00
|
|
|
|
2020-12-25 23:24:47 -05:00
|
|
|
if externallyManaged {
|
|
|
|
|
ctx.Error(http.StatusForbidden, "", "SSH Key is externally managed for this user")
|
2022-04-20 21:08:30 -04:00
|
|
|
return
|
2020-12-25 23:24:47 -05:00
|
|
|
}
|
|
|
|
|
|
2023-09-25 09:17:37 -04:00
|
|
|
if err := asymkey_service.DeletePublicKey(ctx, ctx.Doer, id); err != nil {
|
2022-04-20 21:08:30 -04:00
|
|
|
if asymkey_model.IsErrKeyAccessDenied(err) {
|
2019-12-20 12:07:12 -05:00
|
|
|
ctx.Error(http.StatusForbidden, "", "You do not have access to this key")
|
2015-12-03 00:24:37 -05:00
|
|
|
} else {
|
2019-12-20 12:07:12 -05:00
|
|
|
ctx.Error(http.StatusInternalServerError, "DeletePublicKey", err)
|
2015-12-03 00:24:37 -05:00
|
|
|
}
|
|
|
|
|
return
|
|
|
|
|
}
|
|
|
|
|
|
2019-12-20 12:07:12 -05:00
|
|
|
ctx.Status(http.StatusNoContent)
|
2015-12-03 00:24:37 -05:00
|
|
|
}
|