mirror of
https://codeberg.org/forgejo/forgejo.git
synced 2024-05-28 21:28:30 +00:00
2373c801ee
- Follow up for: #540, #802 - Add API routes for user blocking from user and organization perspective. - The new routes have integration testing. - The new model functions have unit tests. - Actually quite boring to write and to read this pull request. (cherry picked from commitf3afaf15c7) (cherry picked from commit6d754db3e5) (cherry picked from commit2a89ddc0ac) (cherry picked from commit4a147bff7e) Conflicts: routers/api/v1/api.go templates/swagger/v1_json.tmpl (cherry picked from commitbb8c339185) (cherry picked from commit5a11569a01)
532 lines
14 KiB
Go
532 lines
14 KiB
Go
// Copyright 2015 The Gogs Authors. All rights reserved.
|
|
// Copyright 2018 The Gitea Authors. All rights reserved.
|
|
// SPDX-License-Identifier: MIT
|
|
|
|
package org
|
|
|
|
import (
|
|
"net/http"
|
|
|
|
activities_model "code.gitea.io/gitea/models/activities"
|
|
"code.gitea.io/gitea/models/db"
|
|
"code.gitea.io/gitea/models/organization"
|
|
"code.gitea.io/gitea/models/perm"
|
|
user_model "code.gitea.io/gitea/models/user"
|
|
"code.gitea.io/gitea/modules/context"
|
|
api "code.gitea.io/gitea/modules/structs"
|
|
"code.gitea.io/gitea/modules/web"
|
|
"code.gitea.io/gitea/routers/api/v1/user"
|
|
"code.gitea.io/gitea/routers/api/v1/utils"
|
|
"code.gitea.io/gitea/services/convert"
|
|
"code.gitea.io/gitea/services/org"
|
|
)
|
|
|
|
func listUserOrgs(ctx *context.APIContext, u *user_model.User) {
|
|
listOptions := utils.GetListOptions(ctx)
|
|
showPrivate := ctx.IsSigned && (ctx.Doer.IsAdmin || ctx.Doer.ID == u.ID)
|
|
|
|
opts := organization.FindOrgOptions{
|
|
ListOptions: listOptions,
|
|
UserID: u.ID,
|
|
IncludePrivate: showPrivate,
|
|
}
|
|
orgs, err := organization.FindOrgs(opts)
|
|
if err != nil {
|
|
ctx.Error(http.StatusInternalServerError, "FindOrgs", err)
|
|
return
|
|
}
|
|
maxResults, err := organization.CountOrgs(opts)
|
|
if err != nil {
|
|
ctx.Error(http.StatusInternalServerError, "CountOrgs", err)
|
|
return
|
|
}
|
|
|
|
apiOrgs := make([]*api.Organization, len(orgs))
|
|
for i := range orgs {
|
|
apiOrgs[i] = convert.ToOrganization(ctx, orgs[i])
|
|
}
|
|
|
|
ctx.SetLinkHeader(int(maxResults), listOptions.PageSize)
|
|
ctx.SetTotalCountHeader(maxResults)
|
|
ctx.JSON(http.StatusOK, &apiOrgs)
|
|
}
|
|
|
|
// ListMyOrgs list all my orgs
|
|
func ListMyOrgs(ctx *context.APIContext) {
|
|
// swagger:operation GET /user/orgs organization orgListCurrentUserOrgs
|
|
// ---
|
|
// summary: List the current user's organizations
|
|
// produces:
|
|
// - application/json
|
|
// parameters:
|
|
// - 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/OrganizationList"
|
|
|
|
listUserOrgs(ctx, ctx.Doer)
|
|
}
|
|
|
|
// ListUserOrgs list user's orgs
|
|
func ListUserOrgs(ctx *context.APIContext) {
|
|
// swagger:operation GET /users/{username}/orgs organization orgListUserOrgs
|
|
// ---
|
|
// summary: List a user's organizations
|
|
// produces:
|
|
// - application/json
|
|
// parameters:
|
|
// - name: username
|
|
// in: path
|
|
// description: username of user
|
|
// type: string
|
|
// required: true
|
|
// - 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/OrganizationList"
|
|
|
|
listUserOrgs(ctx, ctx.ContextUser)
|
|
}
|
|
|
|
// GetUserOrgsPermissions get user permissions in organization
|
|
func GetUserOrgsPermissions(ctx *context.APIContext) {
|
|
// swagger:operation GET /users/{username}/orgs/{org}/permissions organization orgGetUserPermissions
|
|
// ---
|
|
// summary: Get user permissions in organization
|
|
// produces:
|
|
// - application/json
|
|
// parameters:
|
|
// - name: username
|
|
// in: path
|
|
// description: username of user
|
|
// type: string
|
|
// required: true
|
|
// - name: org
|
|
// in: path
|
|
// description: name of the organization
|
|
// type: string
|
|
// required: true
|
|
// responses:
|
|
// "200":
|
|
// "$ref": "#/responses/OrganizationPermissions"
|
|
// "403":
|
|
// "$ref": "#/responses/forbidden"
|
|
// "404":
|
|
// "$ref": "#/responses/notFound"
|
|
|
|
var o *user_model.User
|
|
if o = user.GetUserByParamsName(ctx, ":org"); o == nil {
|
|
return
|
|
}
|
|
|
|
op := api.OrganizationPermissions{}
|
|
|
|
if !organization.HasOrgOrUserVisible(ctx, o, ctx.ContextUser) {
|
|
ctx.NotFound("HasOrgOrUserVisible", nil)
|
|
return
|
|
}
|
|
|
|
org := organization.OrgFromUser(o)
|
|
authorizeLevel, err := org.GetOrgUserMaxAuthorizeLevel(ctx.ContextUser.ID)
|
|
if err != nil {
|
|
ctx.Error(http.StatusInternalServerError, "GetOrgUserAuthorizeLevel", err)
|
|
return
|
|
}
|
|
|
|
if authorizeLevel > perm.AccessModeNone {
|
|
op.CanRead = true
|
|
}
|
|
if authorizeLevel > perm.AccessModeRead {
|
|
op.CanWrite = true
|
|
}
|
|
if authorizeLevel > perm.AccessModeWrite {
|
|
op.IsAdmin = true
|
|
}
|
|
if authorizeLevel > perm.AccessModeAdmin {
|
|
op.IsOwner = true
|
|
}
|
|
|
|
op.CanCreateRepository, err = org.CanCreateOrgRepo(ctx.ContextUser.ID)
|
|
if err != nil {
|
|
ctx.Error(http.StatusInternalServerError, "CanCreateOrgRepo", err)
|
|
return
|
|
}
|
|
|
|
ctx.JSON(http.StatusOK, op)
|
|
}
|
|
|
|
// GetAll return list of all public organizations
|
|
func GetAll(ctx *context.APIContext) {
|
|
// swagger:operation Get /orgs organization orgGetAll
|
|
// ---
|
|
// summary: Get list of organizations
|
|
// produces:
|
|
// - application/json
|
|
// parameters:
|
|
// - 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/OrganizationList"
|
|
|
|
vMode := []api.VisibleType{api.VisibleTypePublic}
|
|
if ctx.IsSigned {
|
|
vMode = append(vMode, api.VisibleTypeLimited)
|
|
if ctx.Doer.IsAdmin {
|
|
vMode = append(vMode, api.VisibleTypePrivate)
|
|
}
|
|
}
|
|
|
|
listOptions := utils.GetListOptions(ctx)
|
|
|
|
publicOrgs, maxResults, err := user_model.SearchUsers(&user_model.SearchUserOptions{
|
|
Actor: ctx.Doer,
|
|
ListOptions: listOptions,
|
|
Type: user_model.UserTypeOrganization,
|
|
OrderBy: db.SearchOrderByAlphabetically,
|
|
Visible: vMode,
|
|
})
|
|
if err != nil {
|
|
ctx.Error(http.StatusInternalServerError, "SearchOrganizations", err)
|
|
return
|
|
}
|
|
orgs := make([]*api.Organization, len(publicOrgs))
|
|
for i := range publicOrgs {
|
|
orgs[i] = convert.ToOrganization(ctx, organization.OrgFromUser(publicOrgs[i]))
|
|
}
|
|
|
|
ctx.SetLinkHeader(int(maxResults), listOptions.PageSize)
|
|
ctx.SetTotalCountHeader(maxResults)
|
|
ctx.JSON(http.StatusOK, &orgs)
|
|
}
|
|
|
|
// Create api for create organization
|
|
func Create(ctx *context.APIContext) {
|
|
// swagger:operation POST /orgs organization orgCreate
|
|
// ---
|
|
// summary: Create an organization
|
|
// consumes:
|
|
// - application/json
|
|
// produces:
|
|
// - application/json
|
|
// parameters:
|
|
// - name: organization
|
|
// in: body
|
|
// required: true
|
|
// schema: { "$ref": "#/definitions/CreateOrgOption" }
|
|
// responses:
|
|
// "201":
|
|
// "$ref": "#/responses/Organization"
|
|
// "403":
|
|
// "$ref": "#/responses/forbidden"
|
|
// "422":
|
|
// "$ref": "#/responses/validationError"
|
|
form := web.GetForm(ctx).(*api.CreateOrgOption)
|
|
if !ctx.Doer.CanCreateOrganization() {
|
|
ctx.Error(http.StatusForbidden, "Create organization not allowed", nil)
|
|
return
|
|
}
|
|
|
|
visibility := api.VisibleTypePublic
|
|
if form.Visibility != "" {
|
|
visibility = api.VisibilityModes[form.Visibility]
|
|
}
|
|
|
|
org := &organization.Organization{
|
|
Name: form.UserName,
|
|
FullName: form.FullName,
|
|
Description: form.Description,
|
|
Website: form.Website,
|
|
Location: form.Location,
|
|
IsActive: true,
|
|
Type: user_model.UserTypeOrganization,
|
|
Visibility: visibility,
|
|
RepoAdminChangeTeamAccess: form.RepoAdminChangeTeamAccess,
|
|
}
|
|
if err := organization.CreateOrganization(org, ctx.Doer); err != nil {
|
|
if user_model.IsErrUserAlreadyExist(err) ||
|
|
db.IsErrNameReserved(err) ||
|
|
db.IsErrNameCharsNotAllowed(err) ||
|
|
db.IsErrNamePatternNotAllowed(err) {
|
|
ctx.Error(http.StatusUnprocessableEntity, "", err)
|
|
} else {
|
|
ctx.Error(http.StatusInternalServerError, "CreateOrganization", err)
|
|
}
|
|
return
|
|
}
|
|
|
|
ctx.JSON(http.StatusCreated, convert.ToOrganization(ctx, org))
|
|
}
|
|
|
|
// Get get an organization
|
|
func Get(ctx *context.APIContext) {
|
|
// swagger:operation GET /orgs/{org} organization orgGet
|
|
// ---
|
|
// summary: Get an organization
|
|
// produces:
|
|
// - application/json
|
|
// parameters:
|
|
// - name: org
|
|
// in: path
|
|
// description: name of the organization to get
|
|
// type: string
|
|
// required: true
|
|
// responses:
|
|
// "200":
|
|
// "$ref": "#/responses/Organization"
|
|
|
|
if !organization.HasOrgOrUserVisible(ctx, ctx.Org.Organization.AsUser(), ctx.Doer) {
|
|
ctx.NotFound("HasOrgOrUserVisible", nil)
|
|
return
|
|
}
|
|
ctx.JSON(http.StatusOK, convert.ToOrganization(ctx, ctx.Org.Organization))
|
|
}
|
|
|
|
// Edit change an organization's information
|
|
func Edit(ctx *context.APIContext) {
|
|
// swagger:operation PATCH /orgs/{org} organization orgEdit
|
|
// ---
|
|
// summary: Edit an organization
|
|
// consumes:
|
|
// - application/json
|
|
// produces:
|
|
// - application/json
|
|
// parameters:
|
|
// - name: org
|
|
// in: path
|
|
// description: name of the organization to edit
|
|
// type: string
|
|
// required: true
|
|
// - name: body
|
|
// in: body
|
|
// required: true
|
|
// schema:
|
|
// "$ref": "#/definitions/EditOrgOption"
|
|
// responses:
|
|
// "200":
|
|
// "$ref": "#/responses/Organization"
|
|
form := web.GetForm(ctx).(*api.EditOrgOption)
|
|
org := ctx.Org.Organization
|
|
org.FullName = form.FullName
|
|
org.Description = form.Description
|
|
org.Website = form.Website
|
|
org.Location = form.Location
|
|
if form.Visibility != "" {
|
|
org.Visibility = api.VisibilityModes[form.Visibility]
|
|
}
|
|
if form.RepoAdminChangeTeamAccess != nil {
|
|
org.RepoAdminChangeTeamAccess = *form.RepoAdminChangeTeamAccess
|
|
}
|
|
if err := user_model.UpdateUserCols(ctx, org.AsUser(),
|
|
"full_name", "description", "website", "location",
|
|
"visibility", "repo_admin_change_team_access",
|
|
); err != nil {
|
|
ctx.Error(http.StatusInternalServerError, "EditOrganization", err)
|
|
return
|
|
}
|
|
|
|
ctx.JSON(http.StatusOK, convert.ToOrganization(ctx, org))
|
|
}
|
|
|
|
// Delete an organization
|
|
func Delete(ctx *context.APIContext) {
|
|
// swagger:operation DELETE /orgs/{org} organization orgDelete
|
|
// ---
|
|
// summary: Delete an organization
|
|
// produces:
|
|
// - application/json
|
|
// parameters:
|
|
// - name: org
|
|
// in: path
|
|
// description: organization that is to be deleted
|
|
// type: string
|
|
// required: true
|
|
// responses:
|
|
// "204":
|
|
// "$ref": "#/responses/empty"
|
|
|
|
if err := org.DeleteOrganization(ctx.Org.Organization); err != nil {
|
|
ctx.Error(http.StatusInternalServerError, "DeleteOrganization", err)
|
|
return
|
|
}
|
|
ctx.Status(http.StatusNoContent)
|
|
}
|
|
|
|
func ListOrgActivityFeeds(ctx *context.APIContext) {
|
|
// swagger:operation GET /orgs/{org}/activities/feeds organization orgListActivityFeeds
|
|
// ---
|
|
// summary: List an organization's activity feeds
|
|
// produces:
|
|
// - application/json
|
|
// parameters:
|
|
// - name: org
|
|
// in: path
|
|
// description: name of the org
|
|
// type: string
|
|
// 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"
|
|
|
|
includePrivate := false
|
|
if ctx.IsSigned {
|
|
if ctx.Doer.IsAdmin {
|
|
includePrivate = true
|
|
} else {
|
|
org := organization.OrgFromUser(ctx.ContextUser)
|
|
isMember, err := org.IsOrgMember(ctx.Doer.ID)
|
|
if err != nil {
|
|
ctx.Error(http.StatusInternalServerError, "IsOrgMember", err)
|
|
return
|
|
}
|
|
includePrivate = isMember
|
|
}
|
|
}
|
|
|
|
listOptions := utils.GetListOptions(ctx)
|
|
|
|
opts := activities_model.GetFeedsOptions{
|
|
RequestedUser: ctx.ContextUser,
|
|
Actor: ctx.Doer,
|
|
IncludePrivate: includePrivate,
|
|
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))
|
|
}
|
|
|
|
// ListBlockedUsers list the organization's blocked users.
|
|
func ListBlockedUsers(ctx *context.APIContext) {
|
|
// swagger:operation GET /orgs/{org}/list_blocked organization orgListBlockedUsers
|
|
// ---
|
|
// summary: List the organization's blocked users
|
|
// produces:
|
|
// - application/json
|
|
// parameters:
|
|
// - name: org
|
|
// in: path
|
|
// description: name of the org
|
|
// type: string
|
|
// required: true
|
|
// - 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/BlockedUserList"
|
|
|
|
utils.ListUserBlockedUsers(ctx, ctx.ContextUser)
|
|
}
|
|
|
|
// BlockUser blocks a user from the organization.
|
|
func BlockUser(ctx *context.APIContext) {
|
|
// swagger:operation PUT /orgs/{org}/block/{username} organization orgBlockUser
|
|
// ---
|
|
// summary: Blocks a user from the organization
|
|
// produces:
|
|
// - application/json
|
|
// parameters:
|
|
// - name: org
|
|
// in: path
|
|
// description: name of the org
|
|
// type: string
|
|
// required: true
|
|
// - name: username
|
|
// in: path
|
|
// description: username of the user
|
|
// type: string
|
|
// required: true
|
|
// responses:
|
|
// "204":
|
|
// "$ref": "#/responses/empty"
|
|
// "404":
|
|
// "$ref": "#/responses/notFound"
|
|
|
|
user := user.GetUserByParams(ctx)
|
|
if ctx.Written() {
|
|
return
|
|
}
|
|
|
|
utils.BlockUser(ctx, ctx.Org.Organization.AsUser(), user)
|
|
}
|
|
|
|
// UnblockUser unblocks a user from the organization.
|
|
func UnblockUser(ctx *context.APIContext) {
|
|
// swagger:operation PUT /orgs/{org}/unblock/{username} organization orgUnblockUser
|
|
// ---
|
|
// summary: Unblock a user from the organization
|
|
// produces:
|
|
// - application/json
|
|
// parameters:
|
|
// - name: org
|
|
// in: path
|
|
// description: name of the org
|
|
// type: string
|
|
// required: true
|
|
// - name: username
|
|
// in: path
|
|
// description: username of the user
|
|
// type: string
|
|
// required: true
|
|
// responses:
|
|
// "204":
|
|
// "$ref": "#/responses/empty"
|
|
// "404":
|
|
// "$ref": "#/responses/notFound"
|
|
|
|
user := user.GetUserByParams(ctx)
|
|
if ctx.Written() {
|
|
return
|
|
}
|
|
|
|
utils.UnblockUser(ctx, ctx.Org.Organization.AsUser(), user)
|
|
}
|