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