mirror of
				https://codeberg.org/forgejo/forgejo.git
				synced 2025-11-04 00:11:04 +00:00 
			
		
		
		
	[GITEA] enable system users search via the API
Refs: https://codeberg.org/forgejo/forgejo/issues/1403
(cherry picked from commit 87bd40411e)
Conflicts:
	routers/api/v1/user/user.go
	https://codeberg.org/forgejo/forgejo/pulls/1469
	
	
This commit is contained in:
		
					parent
					
						
							
								63e99df3d1
							
						
					
				
			
			
				commit
				
					
						74f70ca873
					
				
			
		
					 3 changed files with 51 additions and 13 deletions
				
			
		| 
						 | 
					@ -9,10 +9,12 @@ import (
 | 
				
			||||||
	"code.gitea.io/gitea/modules/structs"
 | 
						"code.gitea.io/gitea/modules/structs"
 | 
				
			||||||
)
 | 
					)
 | 
				
			||||||
 | 
					
 | 
				
			||||||
 | 
					const GhostUserID = -1
 | 
				
			||||||
 | 
					
 | 
				
			||||||
// NewGhostUser creates and returns a fake user for someone has deleted their account.
 | 
					// NewGhostUser creates and returns a fake user for someone has deleted their account.
 | 
				
			||||||
func NewGhostUser() *User {
 | 
					func NewGhostUser() *User {
 | 
				
			||||||
	return &User{
 | 
						return &User{
 | 
				
			||||||
		ID:        -1,
 | 
							ID:        GhostUserID,
 | 
				
			||||||
		Name:      "Ghost",
 | 
							Name:      "Ghost",
 | 
				
			||||||
		LowerName: "ghost",
 | 
							LowerName: "ghost",
 | 
				
			||||||
	}
 | 
						}
 | 
				
			||||||
| 
						 | 
					
 | 
				
			||||||
| 
						 | 
					@ -54,10 +54,23 @@ func Search(ctx *context.APIContext) {
 | 
				
			||||||
 | 
					
 | 
				
			||||||
	listOptions := utils.GetListOptions(ctx)
 | 
						listOptions := utils.GetListOptions(ctx)
 | 
				
			||||||
 | 
					
 | 
				
			||||||
	users, maxResults, err := user_model.SearchUsers(ctx, &user_model.SearchUserOptions{
 | 
						uid := ctx.FormInt64("uid")
 | 
				
			||||||
 | 
						var users []*user_model.User
 | 
				
			||||||
 | 
						var maxResults int64
 | 
				
			||||||
 | 
						var err error
 | 
				
			||||||
 | 
					
 | 
				
			||||||
 | 
						switch uid {
 | 
				
			||||||
 | 
						case user_model.GhostUserID:
 | 
				
			||||||
 | 
							maxResults = 1
 | 
				
			||||||
 | 
							users = []*user_model.User{user_model.NewGhostUser()}
 | 
				
			||||||
 | 
						case user_model.ActionsUserID:
 | 
				
			||||||
 | 
							maxResults = 1
 | 
				
			||||||
 | 
							users = []*user_model.User{user_model.NewActionsUser()}
 | 
				
			||||||
 | 
						default:
 | 
				
			||||||
 | 
							users, maxResults, err = user_model.SearchUsers(ctx, &user_model.SearchUserOptions{
 | 
				
			||||||
			Actor:       ctx.Doer,
 | 
								Actor:       ctx.Doer,
 | 
				
			||||||
			Keyword:     ctx.FormTrim("q"),
 | 
								Keyword:     ctx.FormTrim("q"),
 | 
				
			||||||
		UID:         ctx.FormInt64("uid"),
 | 
								UID:         uid,
 | 
				
			||||||
			Type:        user_model.UserTypeIndividual,
 | 
								Type:        user_model.UserTypeIndividual,
 | 
				
			||||||
			ListOptions: listOptions,
 | 
								ListOptions: listOptions,
 | 
				
			||||||
		})
 | 
							})
 | 
				
			||||||
| 
						 | 
					@ -68,6 +81,7 @@ func Search(ctx *context.APIContext) {
 | 
				
			||||||
			})
 | 
								})
 | 
				
			||||||
			return
 | 
								return
 | 
				
			||||||
		}
 | 
							}
 | 
				
			||||||
 | 
						}
 | 
				
			||||||
 | 
					
 | 
				
			||||||
	ctx.SetLinkHeader(int(maxResults), listOptions.PageSize)
 | 
						ctx.SetLinkHeader(int(maxResults), listOptions.PageSize)
 | 
				
			||||||
	ctx.SetTotalCountHeader(maxResults)
 | 
						ctx.SetTotalCountHeader(maxResults)
 | 
				
			||||||
| 
						 | 
					
 | 
				
			||||||
| 
						 | 
					@ -56,6 +56,28 @@ func TestAPIUserSearchNotLoggedIn(t *testing.T) {
 | 
				
			||||||
	}
 | 
						}
 | 
				
			||||||
}
 | 
					}
 | 
				
			||||||
 | 
					
 | 
				
			||||||
 | 
					func TestAPIUserSearchSystemUsers(t *testing.T) {
 | 
				
			||||||
 | 
						defer tests.PrepareTestEnv(t)()
 | 
				
			||||||
 | 
						for _, systemUser := range []*user_model.User{
 | 
				
			||||||
 | 
							user_model.NewGhostUser(),
 | 
				
			||||||
 | 
							user_model.NewActionsUser(),
 | 
				
			||||||
 | 
						} {
 | 
				
			||||||
 | 
							t.Run(systemUser.Name, func(t *testing.T) {
 | 
				
			||||||
 | 
								req := NewRequestf(t, "GET", "/api/v1/users/search?uid=%d", systemUser.ID)
 | 
				
			||||||
 | 
								resp := MakeRequest(t, req, http.StatusOK)
 | 
				
			||||||
 | 
					
 | 
				
			||||||
 | 
								var results SearchResults
 | 
				
			||||||
 | 
								DecodeJSON(t, resp, &results)
 | 
				
			||||||
 | 
								assert.NotEmpty(t, results.Data)
 | 
				
			||||||
 | 
								if assert.EqualValues(t, 1, len(results.Data)) {
 | 
				
			||||||
 | 
									user := results.Data[0]
 | 
				
			||||||
 | 
									assert.EqualValues(t, user.UserName, systemUser.Name)
 | 
				
			||||||
 | 
									assert.EqualValues(t, user.ID, systemUser.ID)
 | 
				
			||||||
 | 
								}
 | 
				
			||||||
 | 
							})
 | 
				
			||||||
 | 
						}
 | 
				
			||||||
 | 
					}
 | 
				
			||||||
 | 
					
 | 
				
			||||||
func TestAPIUserSearchAdminLoggedInUserHidden(t *testing.T) {
 | 
					func TestAPIUserSearchAdminLoggedInUserHidden(t *testing.T) {
 | 
				
			||||||
	defer tests.PrepareTestEnv(t)()
 | 
						defer tests.PrepareTestEnv(t)()
 | 
				
			||||||
	adminUsername := "user1"
 | 
						adminUsername := "user1"
 | 
				
			||||||
| 
						 | 
					
 | 
				
			||||||
		Loading…
	
	Add table
		Add a link
		
	
		Reference in a new issue