2016-03-21 09:53:04 -07:00
|
|
|
// Copyright 2016 The Gogs Authors. All rights reserved.
|
2019-01-16 17:39:50 -07:00
|
|
|
// Copyright 2019 The Gitea Authors. All rights reserved.
|
2022-11-27 11:20:29 -07:00
|
|
|
// SPDX-License-Identifier: MIT
|
2016-03-21 09:53:04 -07:00
|
|
|
|
|
|
|
package org
|
|
|
|
|
|
|
|
import (
|
2022-01-04 20:37:00 -07:00
|
|
|
"errors"
|
2019-12-20 10:07:12 -07:00
|
|
|
"net/http"
|
2019-09-30 22:32:28 -07:00
|
|
|
|
2016-12-27 18:36:04 -07:00
|
|
|
"code.gitea.io/gitea/models"
|
2023-04-04 06:35:31 -07:00
|
|
|
activities_model "code.gitea.io/gitea/models/activities"
|
2022-03-28 23:29:02 -07:00
|
|
|
"code.gitea.io/gitea/models/organization"
|
2021-11-28 04:58:28 -07:00
|
|
|
"code.gitea.io/gitea/models/perm"
|
2022-05-11 03:09:36 -07:00
|
|
|
access_model "code.gitea.io/gitea/models/perm/access"
|
2021-12-09 18:27:50 -07:00
|
|
|
repo_model "code.gitea.io/gitea/models/repo"
|
2021-11-09 12:57:58 -07:00
|
|
|
unit_model "code.gitea.io/gitea/models/unit"
|
2016-11-10 09:24:48 -07:00
|
|
|
"code.gitea.io/gitea/modules/context"
|
2019-09-30 22:32:28 -07:00
|
|
|
"code.gitea.io/gitea/modules/log"
|
2019-08-23 09:40:30 -07:00
|
|
|
api "code.gitea.io/gitea/modules/structs"
|
2021-01-26 08:36:53 -07:00
|
|
|
"code.gitea.io/gitea/modules/web"
|
2017-01-19 22:16:10 -07:00
|
|
|
"code.gitea.io/gitea/routers/api/v1/user"
|
2020-01-24 12:00:29 -07:00
|
|
|
"code.gitea.io/gitea/routers/api/v1/utils"
|
2022-12-28 19:57:15 -07:00
|
|
|
"code.gitea.io/gitea/services/convert"
|
2022-08-24 19:31:57 -07:00
|
|
|
org_service "code.gitea.io/gitea/services/org"
|
2016-03-21 09:53:04 -07:00
|
|
|
)
|
|
|
|
|
2016-11-24 00:04:31 -07:00
|
|
|
// ListTeams list all the teams of an organization
|
2016-03-21 09:53:04 -07:00
|
|
|
func ListTeams(ctx *context.APIContext) {
|
2017-11-13 00:02:25 -07:00
|
|
|
// swagger:operation GET /orgs/{org}/teams organization orgListTeams
|
|
|
|
// ---
|
|
|
|
// summary: List an organization's teams
|
|
|
|
// produces:
|
|
|
|
// - application/json
|
|
|
|
// parameters:
|
|
|
|
// - name: org
|
|
|
|
// in: path
|
|
|
|
// description: name of the organization
|
|
|
|
// type: string
|
|
|
|
// required: true
|
2020-01-24 12:00:29 -07:00
|
|
|
// - name: page
|
|
|
|
// in: query
|
|
|
|
// description: page number of results to return (1-based)
|
|
|
|
// type: integer
|
|
|
|
// - name: limit
|
|
|
|
// in: query
|
2020-06-08 21:57:38 -07:00
|
|
|
// description: page size of results
|
2020-01-24 12:00:29 -07:00
|
|
|
// type: integer
|
2017-11-13 00:02:25 -07:00
|
|
|
// responses:
|
|
|
|
// "200":
|
|
|
|
// "$ref": "#/responses/TeamList"
|
2019-12-20 10:07:12 -07:00
|
|
|
|
2022-03-28 23:29:02 -07:00
|
|
|
teams, count, err := organization.SearchTeam(&organization.SearchTeamOptions{
|
2020-01-24 12:00:29 -07:00
|
|
|
ListOptions: utils.GetListOptions(ctx),
|
2021-08-12 05:43:08 -07:00
|
|
|
OrgID: ctx.Org.Organization.ID,
|
|
|
|
})
|
|
|
|
if err != nil {
|
|
|
|
ctx.Error(http.StatusInternalServerError, "LoadTeams", err)
|
2016-03-21 09:53:04 -07:00
|
|
|
return
|
|
|
|
}
|
|
|
|
|
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 06:37:34 -07:00
|
|
|
apiTeams, err := convert.ToTeams(ctx, teams, false)
|
2022-05-13 10:27:58 -07:00
|
|
|
if err != nil {
|
|
|
|
ctx.Error(http.StatusInternalServerError, "ConvertToTeams", err)
|
|
|
|
return
|
2016-03-21 09:53:04 -07:00
|
|
|
}
|
2021-08-12 05:43:08 -07:00
|
|
|
|
|
|
|
ctx.SetTotalCountHeader(count)
|
2019-12-20 10:07:12 -07:00
|
|
|
ctx.JSON(http.StatusOK, apiTeams)
|
2016-03-21 09:53:04 -07:00
|
|
|
}
|
2016-12-27 18:36:04 -07:00
|
|
|
|
2019-01-16 17:39:50 -07:00
|
|
|
// ListUserTeams list all the teams a user belongs to
|
|
|
|
func ListUserTeams(ctx *context.APIContext) {
|
|
|
|
// swagger:operation GET /user/teams user userListTeams
|
|
|
|
// ---
|
|
|
|
// summary: List all the teams a user belongs to
|
|
|
|
// produces:
|
|
|
|
// - application/json
|
2020-01-24 12:00:29 -07:00
|
|
|
// parameters:
|
|
|
|
// - name: page
|
|
|
|
// in: query
|
|
|
|
// description: page number of results to return (1-based)
|
|
|
|
// type: integer
|
|
|
|
// - name: limit
|
|
|
|
// in: query
|
2020-06-08 21:57:38 -07:00
|
|
|
// description: page size of results
|
2020-01-24 12:00:29 -07:00
|
|
|
// type: integer
|
2019-01-16 17:39:50 -07:00
|
|
|
// responses:
|
|
|
|
// "200":
|
|
|
|
// "$ref": "#/responses/TeamList"
|
2019-12-20 10:07:12 -07:00
|
|
|
|
2022-03-28 23:29:02 -07:00
|
|
|
teams, count, err := organization.SearchTeam(&organization.SearchTeamOptions{
|
2021-08-12 05:43:08 -07:00
|
|
|
ListOptions: utils.GetListOptions(ctx),
|
2022-03-22 00:03:22 -07:00
|
|
|
UserID: ctx.Doer.ID,
|
2021-08-12 05:43:08 -07:00
|
|
|
})
|
2019-01-16 17:39:50 -07:00
|
|
|
if err != nil {
|
2019-12-20 10:07:12 -07:00
|
|
|
ctx.Error(http.StatusInternalServerError, "GetUserTeams", err)
|
2019-01-16 17:39:50 -07:00
|
|
|
return
|
|
|
|
}
|
|
|
|
|
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 06:37:34 -07:00
|
|
|
apiTeams, err := convert.ToTeams(ctx, teams, true)
|
2022-05-13 10:27:58 -07:00
|
|
|
if err != nil {
|
|
|
|
ctx.Error(http.StatusInternalServerError, "ConvertToTeams", err)
|
|
|
|
return
|
2019-01-16 17:39:50 -07:00
|
|
|
}
|
2021-08-12 05:43:08 -07:00
|
|
|
|
|
|
|
ctx.SetTotalCountHeader(count)
|
2019-12-20 10:07:12 -07:00
|
|
|
ctx.JSON(http.StatusOK, apiTeams)
|
2019-01-16 17:39:50 -07:00
|
|
|
}
|
|
|
|
|
2016-12-27 18:36:04 -07:00
|
|
|
// GetTeam api for get a team
|
|
|
|
func GetTeam(ctx *context.APIContext) {
|
2017-11-13 00:02:25 -07:00
|
|
|
// swagger:operation GET /teams/{id} organization orgGetTeam
|
|
|
|
// ---
|
|
|
|
// summary: Get a team
|
|
|
|
// produces:
|
|
|
|
// - application/json
|
|
|
|
// parameters:
|
|
|
|
// - name: id
|
|
|
|
// in: path
|
|
|
|
// description: id of the team to get
|
|
|
|
// type: integer
|
2018-10-20 20:40:42 -07:00
|
|
|
// format: int64
|
2017-11-13 00:02:25 -07:00
|
|
|
// required: true
|
|
|
|
// responses:
|
|
|
|
// "200":
|
|
|
|
// "$ref": "#/responses/Team"
|
2019-12-20 10:07:12 -07:00
|
|
|
|
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 06:37:34 -07:00
|
|
|
apiTeam, err := convert.ToTeam(ctx, ctx.Org.Team)
|
2022-05-13 10:27:58 -07:00
|
|
|
if err != nil {
|
|
|
|
ctx.InternalServerError(err)
|
2022-01-04 20:37:00 -07:00
|
|
|
return
|
|
|
|
}
|
|
|
|
|
2022-05-13 10:27:58 -07:00
|
|
|
ctx.JSON(http.StatusOK, apiTeam)
|
2016-12-27 18:36:04 -07:00
|
|
|
}
|
|
|
|
|
2022-03-28 23:29:02 -07:00
|
|
|
func attachTeamUnits(team *organization.Team, units []string) {
|
2023-04-03 01:42:38 -07:00
|
|
|
unitTypes, _ := unit_model.FindUnitTypes(units...)
|
2022-03-28 23:29:02 -07:00
|
|
|
team.Units = make([]*organization.TeamUnit, 0, len(units))
|
2022-01-04 20:37:00 -07:00
|
|
|
for _, tp := range unitTypes {
|
2022-03-28 23:29:02 -07:00
|
|
|
team.Units = append(team.Units, &organization.TeamUnit{
|
2022-01-04 20:37:00 -07:00
|
|
|
OrgID: team.OrgID,
|
|
|
|
Type: tp,
|
|
|
|
AccessMode: team.AccessMode,
|
|
|
|
})
|
|
|
|
}
|
|
|
|
}
|
|
|
|
|
|
|
|
func convertUnitsMap(unitsMap map[string]string) map[unit_model.Type]perm.AccessMode {
|
|
|
|
res := make(map[unit_model.Type]perm.AccessMode, len(unitsMap))
|
|
|
|
for unitKey, p := range unitsMap {
|
|
|
|
res[unit_model.TypeFromKey(unitKey)] = perm.ParseAccessMode(p)
|
|
|
|
}
|
|
|
|
return res
|
|
|
|
}
|
|
|
|
|
2022-03-28 23:29:02 -07:00
|
|
|
func attachTeamUnitsMap(team *organization.Team, unitsMap map[string]string) {
|
|
|
|
team.Units = make([]*organization.TeamUnit, 0, len(unitsMap))
|
2022-01-04 20:37:00 -07:00
|
|
|
for unitKey, p := range unitsMap {
|
2022-03-28 23:29:02 -07:00
|
|
|
team.Units = append(team.Units, &organization.TeamUnit{
|
2022-01-04 20:37:00 -07:00
|
|
|
OrgID: team.OrgID,
|
|
|
|
Type: unit_model.TypeFromKey(unitKey),
|
|
|
|
AccessMode: perm.ParseAccessMode(p),
|
|
|
|
})
|
|
|
|
}
|
|
|
|
}
|
|
|
|
|
2023-04-13 12:06:10 -07:00
|
|
|
func attachAdminTeamUnits(team *organization.Team) {
|
|
|
|
team.Units = make([]*organization.TeamUnit, 0, len(unit_model.AllRepoUnitTypes))
|
|
|
|
for _, ut := range unit_model.AllRepoUnitTypes {
|
|
|
|
up := perm.AccessModeAdmin
|
|
|
|
if ut == unit_model.TypeExternalTracker || ut == unit_model.TypeExternalWiki {
|
|
|
|
up = perm.AccessModeRead
|
|
|
|
}
|
|
|
|
team.Units = append(team.Units, &organization.TeamUnit{
|
|
|
|
OrgID: team.OrgID,
|
|
|
|
Type: ut,
|
|
|
|
AccessMode: up,
|
|
|
|
})
|
|
|
|
}
|
|
|
|
}
|
|
|
|
|
2017-01-19 22:16:10 -07:00
|
|
|
// CreateTeam api for create a team
|
2021-01-26 08:36:53 -07:00
|
|
|
func CreateTeam(ctx *context.APIContext) {
|
2017-11-13 00:02:25 -07:00
|
|
|
// swagger:operation POST /orgs/{org}/teams organization orgCreateTeam
|
|
|
|
// ---
|
|
|
|
// summary: Create a team
|
|
|
|
// consumes:
|
|
|
|
// - application/json
|
|
|
|
// produces:
|
|
|
|
// - application/json
|
|
|
|
// parameters:
|
|
|
|
// - name: org
|
|
|
|
// in: path
|
|
|
|
// description: name of the organization
|
|
|
|
// type: string
|
|
|
|
// required: true
|
|
|
|
// - name: body
|
|
|
|
// in: body
|
|
|
|
// schema:
|
|
|
|
// "$ref": "#/definitions/CreateTeamOption"
|
|
|
|
// responses:
|
|
|
|
// "201":
|
|
|
|
// "$ref": "#/responses/Team"
|
2019-12-20 10:07:12 -07:00
|
|
|
// "422":
|
|
|
|
// "$ref": "#/responses/validationError"
|
2021-01-26 08:36:53 -07:00
|
|
|
form := web.GetForm(ctx).(*api.CreateTeamOption)
|
2022-01-04 20:37:00 -07:00
|
|
|
p := perm.ParseAccessMode(form.Permission)
|
|
|
|
if p < perm.AccessModeAdmin && len(form.UnitsMap) > 0 {
|
|
|
|
p = unit_model.MinUnitAccessMode(convertUnitsMap(form.UnitsMap))
|
|
|
|
}
|
2022-03-28 23:29:02 -07:00
|
|
|
team := &organization.Team{
|
2019-11-06 02:37:14 -07:00
|
|
|
OrgID: ctx.Org.Organization.ID,
|
|
|
|
Name: form.Name,
|
|
|
|
Description: form.Description,
|
|
|
|
IncludesAllRepositories: form.IncludesAllRepositories,
|
2019-11-20 04:27:49 -07:00
|
|
|
CanCreateOrgRepo: form.CanCreateOrgRepo,
|
2022-01-04 20:37:00 -07:00
|
|
|
AccessMode: p,
|
2017-01-19 22:16:10 -07:00
|
|
|
}
|
2018-11-10 12:45:32 -07:00
|
|
|
|
2022-01-04 20:37:00 -07:00
|
|
|
if team.AccessMode < perm.AccessModeAdmin {
|
|
|
|
if len(form.UnitsMap) > 0 {
|
|
|
|
attachTeamUnitsMap(team, form.UnitsMap)
|
|
|
|
} else if len(form.Units) > 0 {
|
|
|
|
attachTeamUnits(team, form.Units)
|
|
|
|
} else {
|
|
|
|
ctx.Error(http.StatusInternalServerError, "getTeamUnits", errors.New("units permission should not be empty"))
|
|
|
|
return
|
2018-11-10 12:45:32 -07:00
|
|
|
}
|
2023-04-13 12:06:10 -07:00
|
|
|
} else {
|
|
|
|
attachAdminTeamUnits(team)
|
2018-11-10 12:45:32 -07:00
|
|
|
}
|
|
|
|
|
2017-01-19 22:16:10 -07:00
|
|
|
if err := models.NewTeam(team); err != nil {
|
2022-03-28 23:29:02 -07:00
|
|
|
if organization.IsErrTeamAlreadyExist(err) {
|
2019-12-20 10:07:12 -07:00
|
|
|
ctx.Error(http.StatusUnprocessableEntity, "", err)
|
2017-01-19 22:16:10 -07:00
|
|
|
} else {
|
2019-12-20 10:07:12 -07:00
|
|
|
ctx.Error(http.StatusInternalServerError, "NewTeam", err)
|
2017-01-19 22:16:10 -07:00
|
|
|
}
|
|
|
|
return
|
|
|
|
}
|
|
|
|
|
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 06:37:34 -07:00
|
|
|
apiTeam, err := convert.ToTeam(ctx, team)
|
2022-05-13 10:27:58 -07:00
|
|
|
if err != nil {
|
|
|
|
ctx.InternalServerError(err)
|
|
|
|
return
|
|
|
|
}
|
|
|
|
ctx.JSON(http.StatusCreated, apiTeam)
|
2017-01-19 22:16:10 -07:00
|
|
|
}
|
|
|
|
|
|
|
|
// EditTeam api for edit a team
|
2021-01-26 08:36:53 -07:00
|
|
|
func EditTeam(ctx *context.APIContext) {
|
2017-11-13 00:02:25 -07:00
|
|
|
// swagger:operation PATCH /teams/{id} organization orgEditTeam
|
|
|
|
// ---
|
|
|
|
// summary: Edit a team
|
|
|
|
// consumes:
|
|
|
|
// - application/json
|
|
|
|
// produces:
|
|
|
|
// - application/json
|
|
|
|
// parameters:
|
|
|
|
// - name: id
|
|
|
|
// in: path
|
|
|
|
// description: id of the team to edit
|
|
|
|
// type: integer
|
|
|
|
// required: true
|
|
|
|
// - name: body
|
|
|
|
// in: body
|
|
|
|
// schema:
|
|
|
|
// "$ref": "#/definitions/EditTeamOption"
|
|
|
|
// responses:
|
|
|
|
// "200":
|
|
|
|
// "$ref": "#/responses/Team"
|
2019-12-20 10:07:12 -07:00
|
|
|
|
2021-01-26 08:36:53 -07:00
|
|
|
form := web.GetForm(ctx).(*api.EditTeamOption)
|
2018-04-28 22:22:57 -07:00
|
|
|
team := ctx.Org.Team
|
2023-02-19 01:31:39 -07:00
|
|
|
if err := team.LoadUnits(ctx); err != nil {
|
2020-01-09 06:15:14 -07:00
|
|
|
ctx.InternalServerError(err)
|
|
|
|
return
|
|
|
|
}
|
|
|
|
|
|
|
|
if form.CanCreateOrgRepo != nil {
|
2022-08-18 01:58:21 -07:00
|
|
|
team.CanCreateOrgRepo = team.IsOwnerTeam() || *form.CanCreateOrgRepo
|
2020-01-09 06:15:14 -07:00
|
|
|
}
|
|
|
|
|
|
|
|
if len(form.Name) > 0 {
|
|
|
|
team.Name = form.Name
|
|
|
|
}
|
|
|
|
|
|
|
|
if form.Description != nil {
|
|
|
|
team.Description = *form.Description
|
|
|
|
}
|
2018-11-10 12:45:32 -07:00
|
|
|
|
2019-11-06 02:37:14 -07:00
|
|
|
isAuthChanged := false
|
|
|
|
isIncludeAllChanged := false
|
2020-01-09 06:15:14 -07:00
|
|
|
if !team.IsOwnerTeam() && len(form.Permission) != 0 {
|
2019-11-06 02:37:14 -07:00
|
|
|
// Validate permission level.
|
2022-01-04 20:37:00 -07:00
|
|
|
p := perm.ParseAccessMode(form.Permission)
|
|
|
|
if p < perm.AccessModeAdmin && len(form.UnitsMap) > 0 {
|
|
|
|
p = unit_model.MinUnitAccessMode(convertUnitsMap(form.UnitsMap))
|
|
|
|
}
|
2019-11-06 02:37:14 -07:00
|
|
|
|
2022-01-04 20:37:00 -07:00
|
|
|
if team.AccessMode != p {
|
2019-11-06 02:37:14 -07:00
|
|
|
isAuthChanged = true
|
2022-01-04 20:37:00 -07:00
|
|
|
team.AccessMode = p
|
2019-11-06 02:37:14 -07:00
|
|
|
}
|
|
|
|
|
2020-01-09 06:15:14 -07:00
|
|
|
if form.IncludesAllRepositories != nil {
|
2019-11-06 02:37:14 -07:00
|
|
|
isIncludeAllChanged = true
|
2020-01-09 06:15:14 -07:00
|
|
|
team.IncludesAllRepositories = *form.IncludesAllRepositories
|
2019-11-06 02:37:14 -07:00
|
|
|
}
|
|
|
|
}
|
|
|
|
|
2022-01-04 20:37:00 -07:00
|
|
|
if team.AccessMode < perm.AccessModeAdmin {
|
|
|
|
if len(form.UnitsMap) > 0 {
|
|
|
|
attachTeamUnitsMap(team, form.UnitsMap)
|
|
|
|
} else if len(form.Units) > 0 {
|
|
|
|
attachTeamUnits(team, form.Units)
|
2018-11-10 12:45:32 -07:00
|
|
|
}
|
2023-04-13 12:06:10 -07:00
|
|
|
} else {
|
|
|
|
attachAdminTeamUnits(team)
|
2018-11-10 12:45:32 -07:00
|
|
|
}
|
|
|
|
|
2019-11-06 02:37:14 -07:00
|
|
|
if err := models.UpdateTeam(team, isAuthChanged, isIncludeAllChanged); err != nil {
|
2019-12-20 10:07:12 -07:00
|
|
|
ctx.Error(http.StatusInternalServerError, "EditTeam", err)
|
2017-01-19 22:16:10 -07:00
|
|
|
return
|
|
|
|
}
|
2022-05-13 10:27:58 -07:00
|
|
|
|
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 06:37:34 -07:00
|
|
|
apiTeam, err := convert.ToTeam(ctx, team)
|
2022-05-13 10:27:58 -07:00
|
|
|
if err != nil {
|
|
|
|
ctx.InternalServerError(err)
|
|
|
|
return
|
|
|
|
}
|
|
|
|
ctx.JSON(http.StatusOK, apiTeam)
|
2017-01-19 22:16:10 -07:00
|
|
|
}
|
|
|
|
|
|
|
|
// DeleteTeam api for delete a team
|
|
|
|
func DeleteTeam(ctx *context.APIContext) {
|
2017-11-13 00:02:25 -07:00
|
|
|
// swagger:operation DELETE /teams/{id} organization orgDeleteTeam
|
|
|
|
// ---
|
|
|
|
// summary: Delete a team
|
|
|
|
// parameters:
|
|
|
|
// - name: id
|
|
|
|
// in: path
|
|
|
|
// description: id of the team to delete
|
|
|
|
// type: integer
|
2018-10-20 20:40:42 -07:00
|
|
|
// format: int64
|
2017-11-13 00:02:25 -07:00
|
|
|
// required: true
|
|
|
|
// responses:
|
|
|
|
// "204":
|
|
|
|
// description: team deleted
|
2019-12-20 10:07:12 -07:00
|
|
|
|
2017-01-19 22:16:10 -07:00
|
|
|
if err := models.DeleteTeam(ctx.Org.Team); err != nil {
|
2019-12-20 10:07:12 -07:00
|
|
|
ctx.Error(http.StatusInternalServerError, "DeleteTeam", err)
|
2017-01-19 22:16:10 -07:00
|
|
|
return
|
|
|
|
}
|
2019-12-20 10:07:12 -07:00
|
|
|
ctx.Status(http.StatusNoContent)
|
2017-01-19 22:16:10 -07:00
|
|
|
}
|
|
|
|
|
|
|
|
// GetTeamMembers api for get a team's members
|
|
|
|
func GetTeamMembers(ctx *context.APIContext) {
|
2017-11-13 00:02:25 -07:00
|
|
|
// swagger:operation GET /teams/{id}/members organization orgListTeamMembers
|
|
|
|
// ---
|
|
|
|
// summary: List a team's members
|
|
|
|
// produces:
|
|
|
|
// - application/json
|
|
|
|
// parameters:
|
|
|
|
// - name: id
|
|
|
|
// in: path
|
|
|
|
// description: id of the team
|
|
|
|
// type: integer
|
2018-10-20 20:40:42 -07:00
|
|
|
// format: int64
|
2017-11-13 00:02:25 -07:00
|
|
|
// required: true
|
2020-01-24 12:00:29 -07:00
|
|
|
// - name: page
|
|
|
|
// in: query
|
|
|
|
// description: page number of results to return (1-based)
|
|
|
|
// type: integer
|
|
|
|
// - name: limit
|
|
|
|
// in: query
|
2020-06-08 21:57:38 -07:00
|
|
|
// description: page size of results
|
2020-01-24 12:00:29 -07:00
|
|
|
// type: integer
|
2017-11-13 00:02:25 -07:00
|
|
|
// responses:
|
|
|
|
// "200":
|
|
|
|
// "$ref": "#/responses/UserList"
|
2019-12-20 10:07:12 -07:00
|
|
|
|
2022-03-28 23:29:02 -07:00
|
|
|
isMember, err := organization.IsOrganizationMember(ctx, ctx.Org.Team.OrgID, ctx.Doer.ID)
|
2017-12-21 00:43:26 -07:00
|
|
|
if err != nil {
|
2019-12-20 10:07:12 -07:00
|
|
|
ctx.Error(http.StatusInternalServerError, "IsOrganizationMember", err)
|
2017-12-21 00:43:26 -07:00
|
|
|
return
|
2022-03-22 00:03:22 -07:00
|
|
|
} else if !isMember && !ctx.Doer.IsAdmin {
|
2019-03-18 19:29:43 -07:00
|
|
|
ctx.NotFound()
|
2017-01-19 22:16:10 -07:00
|
|
|
return
|
|
|
|
}
|
2021-08-12 05:43:08 -07:00
|
|
|
|
2022-03-28 23:29:02 -07:00
|
|
|
teamMembers, err := organization.GetTeamMembers(ctx, &organization.SearchMembersOptions{
|
2020-01-24 12:00:29 -07:00
|
|
|
ListOptions: utils.GetListOptions(ctx),
|
2022-03-28 23:29:02 -07:00
|
|
|
TeamID: ctx.Org.Team.ID,
|
|
|
|
})
|
|
|
|
if err != nil {
|
2019-12-20 10:07:12 -07:00
|
|
|
ctx.Error(http.StatusInternalServerError, "GetTeamMembers", err)
|
2017-01-19 22:16:10 -07:00
|
|
|
return
|
|
|
|
}
|
2022-03-28 23:29:02 -07:00
|
|
|
|
2022-04-11 05:49:49 -07:00
|
|
|
members := make([]*api.User, len(teamMembers))
|
2022-03-28 23:29:02 -07:00
|
|
|
for i, member := range teamMembers {
|
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 06:37:34 -07:00
|
|
|
members[i] = convert.ToUser(ctx, member, ctx.Doer)
|
2017-01-19 22:16:10 -07:00
|
|
|
}
|
2021-08-12 05:43:08 -07:00
|
|
|
|
|
|
|
ctx.SetTotalCountHeader(int64(ctx.Org.Team.NumMembers))
|
2019-12-20 10:07:12 -07:00
|
|
|
ctx.JSON(http.StatusOK, members)
|
2017-01-19 22:16:10 -07:00
|
|
|
}
|
|
|
|
|
2019-01-16 17:39:50 -07:00
|
|
|
// GetTeamMember api for get a particular member of team
|
|
|
|
func GetTeamMember(ctx *context.APIContext) {
|
|
|
|
// swagger:operation GET /teams/{id}/members/{username} organization orgListTeamMember
|
|
|
|
// ---
|
|
|
|
// summary: List a particular member of team
|
|
|
|
// produces:
|
|
|
|
// - application/json
|
|
|
|
// parameters:
|
|
|
|
// - name: id
|
|
|
|
// in: path
|
|
|
|
// description: id of the team
|
|
|
|
// type: integer
|
|
|
|
// format: int64
|
|
|
|
// required: true
|
|
|
|
// - name: username
|
|
|
|
// in: path
|
|
|
|
// description: username of the member to list
|
|
|
|
// type: string
|
|
|
|
// required: true
|
|
|
|
// responses:
|
|
|
|
// "200":
|
|
|
|
// "$ref": "#/responses/User"
|
2019-12-20 10:07:12 -07:00
|
|
|
// "404":
|
|
|
|
// "$ref": "#/responses/notFound"
|
|
|
|
|
2019-01-16 17:39:50 -07:00
|
|
|
u := user.GetUserByParams(ctx)
|
|
|
|
if ctx.Written() {
|
|
|
|
return
|
|
|
|
}
|
2019-09-15 05:22:02 -07:00
|
|
|
teamID := ctx.ParamsInt64("teamid")
|
2022-03-28 23:29:02 -07:00
|
|
|
isTeamMember, err := organization.IsUserInTeams(ctx, u.ID, []int64{teamID})
|
2019-09-15 05:22:02 -07:00
|
|
|
if err != nil {
|
2019-12-20 10:07:12 -07:00
|
|
|
ctx.Error(http.StatusInternalServerError, "IsUserInTeams", err)
|
2019-09-15 05:22:02 -07:00
|
|
|
return
|
|
|
|
} else if !isTeamMember {
|
|
|
|
ctx.NotFound()
|
|
|
|
return
|
|
|
|
}
|
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 06:37:34 -07:00
|
|
|
ctx.JSON(http.StatusOK, convert.ToUser(ctx, u, ctx.Doer))
|
2019-01-16 17:39:50 -07:00
|
|
|
}
|
|
|
|
|
2017-01-19 22:16:10 -07:00
|
|
|
// AddTeamMember api for add a member to a team
|
|
|
|
func AddTeamMember(ctx *context.APIContext) {
|
2017-11-13 00:02:25 -07:00
|
|
|
// swagger:operation PUT /teams/{id}/members/{username} organization orgAddTeamMember
|
|
|
|
// ---
|
|
|
|
// summary: Add a team member
|
|
|
|
// produces:
|
|
|
|
// - application/json
|
|
|
|
// parameters:
|
|
|
|
// - name: id
|
|
|
|
// in: path
|
|
|
|
// description: id of the team
|
|
|
|
// type: integer
|
2018-10-20 20:40:42 -07:00
|
|
|
// format: int64
|
2017-11-13 00:02:25 -07:00
|
|
|
// required: true
|
|
|
|
// - name: username
|
|
|
|
// in: path
|
|
|
|
// description: username of the user to add
|
|
|
|
// type: string
|
|
|
|
// required: true
|
|
|
|
// responses:
|
|
|
|
// "204":
|
|
|
|
// "$ref": "#/responses/empty"
|
2019-12-20 10:07:12 -07:00
|
|
|
// "404":
|
|
|
|
// "$ref": "#/responses/notFound"
|
|
|
|
|
2017-01-19 22:16:10 -07:00
|
|
|
u := user.GetUserByParams(ctx)
|
|
|
|
if ctx.Written() {
|
|
|
|
return
|
|
|
|
}
|
2022-03-28 23:29:02 -07:00
|
|
|
if err := models.AddTeamMember(ctx.Org.Team, u.ID); err != nil {
|
2019-12-20 10:07:12 -07:00
|
|
|
ctx.Error(http.StatusInternalServerError, "AddMember", err)
|
2017-01-19 22:16:10 -07:00
|
|
|
return
|
|
|
|
}
|
2019-12-20 10:07:12 -07:00
|
|
|
ctx.Status(http.StatusNoContent)
|
2017-01-19 22:16:10 -07:00
|
|
|
}
|
|
|
|
|
|
|
|
// RemoveTeamMember api for remove one member from a team
|
|
|
|
func RemoveTeamMember(ctx *context.APIContext) {
|
2018-06-12 07:59:22 -07:00
|
|
|
// swagger:operation DELETE /teams/{id}/members/{username} organization orgRemoveTeamMember
|
2017-11-13 00:02:25 -07:00
|
|
|
// ---
|
|
|
|
// summary: Remove a team member
|
|
|
|
// produces:
|
|
|
|
// - application/json
|
|
|
|
// parameters:
|
|
|
|
// - name: id
|
|
|
|
// in: path
|
|
|
|
// description: id of the team
|
|
|
|
// type: integer
|
2018-10-20 20:40:42 -07:00
|
|
|
// format: int64
|
2017-11-13 00:02:25 -07:00
|
|
|
// required: true
|
|
|
|
// - name: username
|
|
|
|
// in: path
|
|
|
|
// description: username of the user to remove
|
|
|
|
// type: string
|
|
|
|
// required: true
|
|
|
|
// responses:
|
|
|
|
// "204":
|
|
|
|
// "$ref": "#/responses/empty"
|
2019-12-20 10:07:12 -07:00
|
|
|
// "404":
|
|
|
|
// "$ref": "#/responses/notFound"
|
|
|
|
|
2017-01-19 22:16:10 -07:00
|
|
|
u := user.GetUserByParams(ctx)
|
|
|
|
if ctx.Written() {
|
|
|
|
return
|
|
|
|
}
|
|
|
|
|
2022-03-28 23:29:02 -07:00
|
|
|
if err := models.RemoveTeamMember(ctx.Org.Team, u.ID); err != nil {
|
|
|
|
ctx.Error(http.StatusInternalServerError, "RemoveTeamMember", err)
|
2017-01-19 22:16:10 -07:00
|
|
|
return
|
|
|
|
}
|
2019-12-20 10:07:12 -07:00
|
|
|
ctx.Status(http.StatusNoContent)
|
2017-01-19 22:16:10 -07:00
|
|
|
}
|
2017-01-26 04:54:04 -07:00
|
|
|
|
|
|
|
// GetTeamRepos api for get a team's repos
|
|
|
|
func GetTeamRepos(ctx *context.APIContext) {
|
2017-11-13 00:02:25 -07:00
|
|
|
// swagger:operation GET /teams/{id}/repos organization orgListTeamRepos
|
|
|
|
// ---
|
|
|
|
// summary: List a team's repos
|
|
|
|
// produces:
|
|
|
|
// - application/json
|
|
|
|
// parameters:
|
|
|
|
// - name: id
|
|
|
|
// in: path
|
|
|
|
// description: id of the team
|
|
|
|
// type: integer
|
2018-10-20 20:40:42 -07:00
|
|
|
// format: int64
|
2017-11-13 00:02:25 -07:00
|
|
|
// required: true
|
2020-01-24 12:00:29 -07:00
|
|
|
// - name: page
|
|
|
|
// in: query
|
|
|
|
// description: page number of results to return (1-based)
|
|
|
|
// type: integer
|
|
|
|
// - name: limit
|
|
|
|
// in: query
|
2020-06-08 21:57:38 -07:00
|
|
|
// description: page size of results
|
2020-01-24 12:00:29 -07:00
|
|
|
// type: integer
|
2017-11-13 00:02:25 -07:00
|
|
|
// responses:
|
|
|
|
// "200":
|
|
|
|
// "$ref": "#/responses/RepositoryList"
|
2019-12-20 10:07:12 -07:00
|
|
|
|
2017-01-26 04:54:04 -07:00
|
|
|
team := ctx.Org.Team
|
2022-03-28 23:29:02 -07:00
|
|
|
teamRepos, err := organization.GetTeamRepositories(ctx, &organization.SearchTeamRepoOptions{
|
2020-01-24 12:00:29 -07:00
|
|
|
ListOptions: utils.GetListOptions(ctx),
|
2022-03-28 23:29:02 -07:00
|
|
|
TeamID: team.ID,
|
|
|
|
})
|
|
|
|
if err != nil {
|
2019-12-20 10:07:12 -07:00
|
|
|
ctx.Error(http.StatusInternalServerError, "GetTeamRepos", err)
|
2022-03-28 23:29:02 -07:00
|
|
|
return
|
2017-01-26 04:54:04 -07:00
|
|
|
}
|
2022-04-20 03:43:26 -07:00
|
|
|
repos := make([]*api.Repository, len(teamRepos))
|
2022-03-28 23:29:02 -07:00
|
|
|
for i, repo := range teamRepos {
|
2022-11-19 01:12:33 -07:00
|
|
|
access, err := access_model.AccessLevel(ctx, ctx.Doer, repo)
|
2017-01-26 04:54:04 -07:00
|
|
|
if err != nil {
|
2019-12-20 10:07:12 -07:00
|
|
|
ctx.Error(http.StatusInternalServerError, "GetTeamRepos", err)
|
2017-01-26 04:54:04 -07:00
|
|
|
return
|
|
|
|
}
|
2022-12-02 19:48:26 -07:00
|
|
|
repos[i] = convert.ToRepo(ctx, repo, access)
|
2017-01-26 04:54:04 -07:00
|
|
|
}
|
2021-12-14 22:39:34 -07:00
|
|
|
ctx.SetTotalCountHeader(int64(team.NumRepos))
|
2019-12-20 10:07:12 -07:00
|
|
|
ctx.JSON(http.StatusOK, repos)
|
2017-01-26 04:54:04 -07:00
|
|
|
}
|
|
|
|
|
2022-05-01 08:39:04 -07:00
|
|
|
// GetTeamRepo api for get a particular repo of team
|
|
|
|
func GetTeamRepo(ctx *context.APIContext) {
|
|
|
|
// swagger:operation GET /teams/{id}/repos/{org}/{repo} organization orgListTeamRepo
|
|
|
|
// ---
|
|
|
|
// summary: List a particular repo of team
|
|
|
|
// produces:
|
|
|
|
// - application/json
|
|
|
|
// parameters:
|
|
|
|
// - name: id
|
|
|
|
// in: path
|
|
|
|
// description: id of the team
|
|
|
|
// type: integer
|
|
|
|
// format: int64
|
|
|
|
// required: true
|
|
|
|
// - name: org
|
|
|
|
// in: path
|
|
|
|
// description: organization that owns the repo to list
|
|
|
|
// type: string
|
|
|
|
// required: true
|
|
|
|
// - name: repo
|
|
|
|
// in: path
|
|
|
|
// description: name of the repo to list
|
|
|
|
// type: string
|
|
|
|
// required: true
|
|
|
|
// responses:
|
|
|
|
// "200":
|
|
|
|
// "$ref": "#/responses/Repository"
|
|
|
|
// "404":
|
|
|
|
// "$ref": "#/responses/notFound"
|
|
|
|
|
|
|
|
repo := getRepositoryByParams(ctx)
|
|
|
|
if ctx.Written() {
|
|
|
|
return
|
|
|
|
}
|
|
|
|
|
|
|
|
if !organization.HasTeamRepo(ctx, ctx.Org.Team.OrgID, ctx.Org.Team.ID, repo.ID) {
|
|
|
|
ctx.NotFound()
|
|
|
|
return
|
|
|
|
}
|
|
|
|
|
2022-11-19 01:12:33 -07:00
|
|
|
access, err := access_model.AccessLevel(ctx, ctx.Doer, repo)
|
2022-05-01 08:39:04 -07:00
|
|
|
if err != nil {
|
|
|
|
ctx.Error(http.StatusInternalServerError, "GetTeamRepos", err)
|
|
|
|
return
|
|
|
|
}
|
|
|
|
|
2022-12-02 19:48:26 -07:00
|
|
|
ctx.JSON(http.StatusOK, convert.ToRepo(ctx, repo, access))
|
2022-05-01 08:39:04 -07:00
|
|
|
}
|
|
|
|
|
2017-01-26 04:54:04 -07:00
|
|
|
// getRepositoryByParams get repository by a team's organization ID and repo name
|
2021-12-09 18:27:50 -07:00
|
|
|
func getRepositoryByParams(ctx *context.APIContext) *repo_model.Repository {
|
|
|
|
repo, err := repo_model.GetRepositoryByName(ctx.Org.Team.OrgID, ctx.Params(":reponame"))
|
2017-01-26 04:54:04 -07:00
|
|
|
if err != nil {
|
2021-12-09 18:27:50 -07:00
|
|
|
if repo_model.IsErrRepoNotExist(err) {
|
2019-03-18 19:29:43 -07:00
|
|
|
ctx.NotFound()
|
2017-01-26 04:54:04 -07:00
|
|
|
} else {
|
2019-12-20 10:07:12 -07:00
|
|
|
ctx.Error(http.StatusInternalServerError, "GetRepositoryByName", err)
|
2017-01-26 04:54:04 -07:00
|
|
|
}
|
|
|
|
return nil
|
|
|
|
}
|
|
|
|
return repo
|
|
|
|
}
|
|
|
|
|
|
|
|
// AddTeamRepository api for adding a repository to a team
|
|
|
|
func AddTeamRepository(ctx *context.APIContext) {
|
2018-06-12 07:59:22 -07:00
|
|
|
// swagger:operation PUT /teams/{id}/repos/{org}/{repo} organization orgAddTeamRepository
|
2017-11-13 00:02:25 -07:00
|
|
|
// ---
|
|
|
|
// summary: Add a repository to a team
|
|
|
|
// produces:
|
|
|
|
// - application/json
|
|
|
|
// parameters:
|
|
|
|
// - name: id
|
|
|
|
// in: path
|
|
|
|
// description: id of the team
|
|
|
|
// type: integer
|
2018-10-20 20:40:42 -07:00
|
|
|
// format: int64
|
2017-11-13 00:02:25 -07:00
|
|
|
// required: true
|
|
|
|
// - name: org
|
|
|
|
// in: path
|
|
|
|
// description: organization that owns the repo to add
|
|
|
|
// type: string
|
|
|
|
// required: true
|
|
|
|
// - name: repo
|
|
|
|
// in: path
|
|
|
|
// description: name of the repo to add
|
|
|
|
// type: string
|
|
|
|
// required: true
|
|
|
|
// responses:
|
|
|
|
// "204":
|
|
|
|
// "$ref": "#/responses/empty"
|
2019-12-20 10:07:12 -07:00
|
|
|
// "403":
|
|
|
|
// "$ref": "#/responses/forbidden"
|
|
|
|
|
2017-01-26 04:54:04 -07:00
|
|
|
repo := getRepositoryByParams(ctx)
|
|
|
|
if ctx.Written() {
|
|
|
|
return
|
|
|
|
}
|
2022-11-19 01:12:33 -07:00
|
|
|
if access, err := access_model.AccessLevel(ctx, ctx.Doer, repo); err != nil {
|
2019-12-20 10:07:12 -07:00
|
|
|
ctx.Error(http.StatusInternalServerError, "AccessLevel", err)
|
2017-01-26 04:54:04 -07:00
|
|
|
return
|
2021-11-28 04:58:28 -07:00
|
|
|
} else if access < perm.AccessModeAdmin {
|
2019-12-20 10:07:12 -07:00
|
|
|
ctx.Error(http.StatusForbidden, "", "Must have admin-level access to the repository")
|
2017-01-26 04:54:04 -07:00
|
|
|
return
|
|
|
|
}
|
2022-08-24 19:31:57 -07:00
|
|
|
if err := org_service.TeamAddRepository(ctx.Org.Team, repo); err != nil {
|
|
|
|
ctx.Error(http.StatusInternalServerError, "TeamAddRepository", err)
|
2017-01-26 04:54:04 -07:00
|
|
|
return
|
|
|
|
}
|
2019-12-20 10:07:12 -07:00
|
|
|
ctx.Status(http.StatusNoContent)
|
2017-01-26 04:54:04 -07:00
|
|
|
}
|
|
|
|
|
|
|
|
// RemoveTeamRepository api for removing a repository from a team
|
|
|
|
func RemoveTeamRepository(ctx *context.APIContext) {
|
2018-06-12 07:59:22 -07:00
|
|
|
// swagger:operation DELETE /teams/{id}/repos/{org}/{repo} organization orgRemoveTeamRepository
|
2017-11-13 00:02:25 -07:00
|
|
|
// ---
|
|
|
|
// summary: Remove a repository from a team
|
|
|
|
// description: This does not delete the repository, it only removes the
|
|
|
|
// repository from the team.
|
|
|
|
// produces:
|
|
|
|
// - application/json
|
|
|
|
// parameters:
|
|
|
|
// - name: id
|
|
|
|
// in: path
|
|
|
|
// description: id of the team
|
|
|
|
// type: integer
|
2018-10-20 20:40:42 -07:00
|
|
|
// format: int64
|
2017-11-13 00:02:25 -07:00
|
|
|
// required: true
|
|
|
|
// - name: org
|
|
|
|
// in: path
|
|
|
|
// description: organization that owns the repo to remove
|
|
|
|
// type: string
|
|
|
|
// required: true
|
|
|
|
// - name: repo
|
|
|
|
// in: path
|
|
|
|
// description: name of the repo to remove
|
|
|
|
// type: string
|
|
|
|
// required: true
|
|
|
|
// responses:
|
|
|
|
// "204":
|
|
|
|
// "$ref": "#/responses/empty"
|
2019-12-20 10:07:12 -07:00
|
|
|
// "403":
|
|
|
|
// "$ref": "#/responses/forbidden"
|
|
|
|
|
2017-01-26 04:54:04 -07:00
|
|
|
repo := getRepositoryByParams(ctx)
|
|
|
|
if ctx.Written() {
|
|
|
|
return
|
|
|
|
}
|
2022-11-19 01:12:33 -07:00
|
|
|
if access, err := access_model.AccessLevel(ctx, ctx.Doer, repo); err != nil {
|
2019-12-20 10:07:12 -07:00
|
|
|
ctx.Error(http.StatusInternalServerError, "AccessLevel", err)
|
2017-01-26 04:54:04 -07:00
|
|
|
return
|
2021-11-28 04:58:28 -07:00
|
|
|
} else if access < perm.AccessModeAdmin {
|
2019-12-20 10:07:12 -07:00
|
|
|
ctx.Error(http.StatusForbidden, "", "Must have admin-level access to the repository")
|
2017-01-26 04:54:04 -07:00
|
|
|
return
|
|
|
|
}
|
2022-03-28 23:29:02 -07:00
|
|
|
if err := models.RemoveRepository(ctx.Org.Team, repo.ID); err != nil {
|
2019-12-20 10:07:12 -07:00
|
|
|
ctx.Error(http.StatusInternalServerError, "RemoveRepository", err)
|
2017-01-26 04:54:04 -07:00
|
|
|
return
|
|
|
|
}
|
2019-12-20 10:07:12 -07:00
|
|
|
ctx.Status(http.StatusNoContent)
|
2017-01-26 04:54:04 -07:00
|
|
|
}
|
2019-09-30 22:32:28 -07:00
|
|
|
|
|
|
|
// SearchTeam api for searching teams
|
|
|
|
func SearchTeam(ctx *context.APIContext) {
|
|
|
|
// swagger:operation GET /orgs/{org}/teams/search organization teamSearch
|
|
|
|
// ---
|
|
|
|
// summary: Search for teams within an organization
|
|
|
|
// produces:
|
|
|
|
// - application/json
|
|
|
|
// parameters:
|
|
|
|
// - name: org
|
|
|
|
// in: path
|
|
|
|
// description: name of the organization
|
|
|
|
// type: string
|
|
|
|
// required: true
|
|
|
|
// - name: q
|
|
|
|
// in: query
|
|
|
|
// description: keywords to search
|
|
|
|
// type: string
|
|
|
|
// - name: include_desc
|
|
|
|
// in: query
|
|
|
|
// description: include search within team description (defaults to true)
|
|
|
|
// type: boolean
|
|
|
|
// - name: page
|
|
|
|
// in: query
|
|
|
|
// description: page number of results to return (1-based)
|
|
|
|
// type: integer
|
2020-01-24 12:00:29 -07:00
|
|
|
// - name: limit
|
|
|
|
// in: query
|
2020-06-08 21:57:38 -07:00
|
|
|
// description: page size of results
|
2020-01-24 12:00:29 -07:00
|
|
|
// type: integer
|
2019-09-30 22:32:28 -07:00
|
|
|
// responses:
|
|
|
|
// "200":
|
|
|
|
// description: "SearchResults of a successful search"
|
|
|
|
// schema:
|
|
|
|
// type: object
|
|
|
|
// properties:
|
|
|
|
// ok:
|
|
|
|
// type: boolean
|
|
|
|
// data:
|
|
|
|
// type: array
|
|
|
|
// items:
|
|
|
|
// "$ref": "#/definitions/Team"
|
2019-12-20 10:07:12 -07:00
|
|
|
|
2020-06-21 01:22:06 -07:00
|
|
|
listOptions := utils.GetListOptions(ctx)
|
|
|
|
|
2022-03-28 23:29:02 -07:00
|
|
|
opts := &organization.SearchTeamOptions{
|
2021-08-11 08:08:52 -07:00
|
|
|
Keyword: ctx.FormTrim("q"),
|
2019-09-30 22:32:28 -07:00
|
|
|
OrgID: ctx.Org.Organization.ID,
|
2021-08-10 17:31:13 -07:00
|
|
|
IncludeDesc: ctx.FormString("include_desc") == "" || ctx.FormBool("include_desc"),
|
2020-06-21 01:22:06 -07:00
|
|
|
ListOptions: listOptions,
|
2019-09-30 22:32:28 -07:00
|
|
|
}
|
|
|
|
|
2022-09-19 05:02:29 -07:00
|
|
|
// Only admin is allowd to search for all teams
|
|
|
|
if !ctx.Doer.IsAdmin {
|
|
|
|
opts.UserID = ctx.Doer.ID
|
|
|
|
}
|
|
|
|
|
2022-03-28 23:29:02 -07:00
|
|
|
teams, maxResults, err := organization.SearchTeam(opts)
|
2019-09-30 22:32:28 -07:00
|
|
|
if err != nil {
|
|
|
|
log.Error("SearchTeam failed: %v", err)
|
2019-12-20 10:07:12 -07:00
|
|
|
ctx.JSON(http.StatusInternalServerError, map[string]interface{}{
|
2019-09-30 22:32:28 -07:00
|
|
|
"ok": false,
|
|
|
|
"error": "SearchTeam internal failure",
|
|
|
|
})
|
|
|
|
return
|
|
|
|
}
|
|
|
|
|
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 06:37:34 -07:00
|
|
|
apiTeams, err := convert.ToTeams(ctx, teams, false)
|
2022-05-13 10:27:58 -07:00
|
|
|
if err != nil {
|
|
|
|
ctx.InternalServerError(err)
|
|
|
|
return
|
2019-09-30 22:32:28 -07:00
|
|
|
}
|
|
|
|
|
2020-06-21 01:22:06 -07:00
|
|
|
ctx.SetLinkHeader(int(maxResults), listOptions.PageSize)
|
2021-08-12 05:43:08 -07:00
|
|
|
ctx.SetTotalCountHeader(maxResults)
|
2019-12-20 10:07:12 -07:00
|
|
|
ctx.JSON(http.StatusOK, map[string]interface{}{
|
2019-09-30 22:32:28 -07:00
|
|
|
"ok": true,
|
|
|
|
"data": apiTeams,
|
|
|
|
})
|
|
|
|
}
|
2023-04-04 06:35:31 -07:00
|
|
|
|
|
|
|
func ListTeamActivityFeeds(ctx *context.APIContext) {
|
|
|
|
// swagger:operation GET /teams/{id}/activities/feeds organization orgListTeamActivityFeeds
|
|
|
|
// ---
|
|
|
|
// summary: List a team's activity feeds
|
|
|
|
// produces:
|
|
|
|
// - application/json
|
|
|
|
// parameters:
|
|
|
|
// - name: id
|
|
|
|
// in: path
|
|
|
|
// description: id of the team
|
|
|
|
// type: integer
|
|
|
|
// format: int64
|
|
|
|
// required: true
|
|
|
|
// - name: date
|
|
|
|
// in: query
|
|
|
|
// description: the date of the activities to be found
|
|
|
|
// type: string
|
|
|
|
// format: date
|
|
|
|
// - name: page
|
|
|
|
// in: query
|
|
|
|
// description: page number of results to return (1-based)
|
|
|
|
// type: integer
|
|
|
|
// - name: limit
|
|
|
|
// in: query
|
|
|
|
// description: page size of results
|
|
|
|
// type: integer
|
|
|
|
// responses:
|
|
|
|
// "200":
|
|
|
|
// "$ref": "#/responses/ActivityFeedsList"
|
|
|
|
// "404":
|
|
|
|
// "$ref": "#/responses/notFound"
|
|
|
|
|
|
|
|
listOptions := utils.GetListOptions(ctx)
|
|
|
|
|
|
|
|
opts := activities_model.GetFeedsOptions{
|
|
|
|
RequestedTeam: ctx.Org.Team,
|
|
|
|
Actor: ctx.Doer,
|
|
|
|
IncludePrivate: true,
|
|
|
|
Date: ctx.FormString("date"),
|
|
|
|
ListOptions: listOptions,
|
|
|
|
}
|
|
|
|
|
|
|
|
feeds, count, err := activities_model.GetFeeds(ctx, opts)
|
|
|
|
if err != nil {
|
|
|
|
ctx.Error(http.StatusInternalServerError, "GetFeeds", err)
|
|
|
|
return
|
|
|
|
}
|
|
|
|
ctx.SetTotalCountHeader(count)
|
|
|
|
|
|
|
|
ctx.JSON(http.StatusOK, convert.ToActivities(ctx, feeds, ctx.Doer))
|
|
|
|
}
|