opendev/gerrit
Code Issues Proposed changes

Add REST endpoint to remove members from a group

Browse Source 
With DELETE on 'groups/*/members/<MEMBER>' it is now possible to remove
a member from a group.

In addition with DELETE on 'groups/*/members' it is possible to remove
multiple members from a group at once.

The AccountGroupMembersScreen uses the new REST endpoint to remove
members.

Change-Id: I13036333f1c23fa0c33e09ddf0cec27e95265b9d
Signed-off-by: Edwin Kempin <edwin.kempin@sap.com>
This commit is contained in:
Edwin Kempin
2013-01-14 14:22:03 +01:00
parent 9a701696ae
commit 3adce619c9
7 changed files with 230 additions and 9 deletions
Download Patch File Download Diff File Expand all files Collapse all files

22
gerrit-gwtui/src/main/java/com/google/gerrit/client/VoidResult.java Normal file
View File

@@ -0,0 +1,22 @@
// Copyright (C) 2013 The Android Open Source Project
//
// Licensed under the Apache License, Version 2.0 (the "License");
// you may not use this file except in compliance with the License.
// You may obtain a copy of the License at
//
// http://www.apache.org/licenses/LICENSE-2.0
//
// Unless required by applicable law or agreed to in writing, software
// distributed under the License is distributed on an "AS IS" BASIS,
// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
// See the License for the specific language governing permissions and
// limitations under the License.
package com.google.gerrit.client;
import com.google.gwt.core.client.JavaScriptObject;
public final class VoidResult extends JavaScriptObject {
protected VoidResult() {
}
}

13
gerrit-gwtui/src/main/java/com/google/gerrit/client/admin/AccountGroupMembersScreen.java
View File

@@ -241,21 +241,20 @@ public class AccountGroupMembersScreen extends AccountGroupScreen {
}
void deleteChecked() {
final HashSet<AccountGroupMember.Key> ids =
new HashSet<AccountGroupMember.Key>();
final HashSet<Account.Id> ids = new HashSet<Account.Id>();
for (int row = 1; row < table.getRowCount(); row++) {
final AccountGroupMember k = getRowItem(row);
if (k != null && ((CheckBox) table.getWidget(row, 1)).getValue()) {
ids.add(k.getKey());
ids.add(k.getAccountId());
}
}
if (!ids.isEmpty()) {
Util.GROUP_SVC.deleteGroupMembers(getGroupId(), ids,
new GerritCallback<VoidResult>() {
public void onSuccess(final VoidResult result) {
GroupApi.removeMembers(getGroupUUID(), ids,
new GerritCallback<com.google.gerrit.client.VoidResult>() {
public void onSuccess(final com.google.gerrit.client.VoidResult result) {
for (int row = 1; row < table.getRowCount();) {
final AccountGroupMember k = getRowItem(row);
if (k != null && ids.contains(k.getKey())) {
if (k != null && ids.contains(k.getAccountId())) {
table.removeRow(row);
} else {
row++;

13
gerrit-gwtui/src/main/java/com/google/gerrit/client/groups/GroupApi.java
View File

@@ -14,8 +14,10 @@
package com.google.gerrit.client.groups;
import com.google.gerrit.client.VoidResult;
import com.google.gerrit.client.rpc.NativeList;
import com.google.gerrit.client.rpc.RestApi;
import com.google.gerrit.reviewdb.client.Account;
import com.google.gerrit.reviewdb.client.AccountGroup;
import com.google.gwt.core.client.JavaScriptObject;
import com.google.gwt.http.client.URL;
@@ -46,6 +48,17 @@ public class GroupApi {
call.data(input).put(cb);
}
/** Remove members from a group. */
public static void removeMembers(AccountGroup.UUID groupUUID,
Set<Account.Id> ids, AsyncCallback<VoidResult> cb) {
RestApi call = new RestApi(membersBase(groupUUID));
MemberInput input = MemberInput.create();
for (Account.Id id : ids) {
input.add_member(id.toString());
}
call.data(input).delete(cb);
}
private static String membersBase(AccountGroup.UUID groupUUID) {
return base(groupUUID) + "members";
}

176
gerrit-server/src/main/java/com/google/gerrit/server/group/DeleteMembers.java Normal file
View File

@@ -0,0 +1,176 @@
// Copyright (C) 2013 The Android Open Source Project
//
// Licensed under the Apache License, Version 2.0 (the "License");
// you may not use this file except in compliance with the License.
// You may obtain a copy of the License at
//
// http://www.apache.org/licenses/LICENSE-2.0
//
// Unless required by applicable law or agreed to in writing, software
// distributed under the License is distributed on an "AS IS" BASIS,
// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
// See the License for the specific language governing permissions and
// limitations under the License.
package com.google.gerrit.server.group;
import com.google.common.collect.Lists;
import com.google.common.collect.Maps;
import com.google.gerrit.common.data.GroupDescription;
import com.google.gerrit.common.errors.NoSuchAccountException;
import com.google.gerrit.common.errors.NoSuchGroupException;
import com.google.gerrit.extensions.restapi.AuthException;
import com.google.gerrit.extensions.restapi.BadRequestException;
import com.google.gerrit.extensions.restapi.MethodNotAllowedException;
import com.google.gerrit.extensions.restapi.Response;
import com.google.gerrit.extensions.restapi.RestModifyView;
import com.google.gerrit.reviewdb.client.Account;
import com.google.gerrit.reviewdb.client.AccountGroup;
import com.google.gerrit.reviewdb.client.AccountGroupMember;
import com.google.gerrit.reviewdb.client.AccountGroupMemberAudit;
import com.google.gerrit.reviewdb.server.ReviewDb;
import com.google.gerrit.server.BadRequestHandler;
import com.google.gerrit.server.CurrentUser;
import com.google.gerrit.server.IdentifiedUser;
import com.google.gerrit.server.account.AccountCache;
import com.google.gerrit.server.account.AccountResolver;
import com.google.gerrit.server.account.GroupControl;
import com.google.gerrit.server.group.PutMembers.Input;
import com.google.gwtorm.server.OrmException;
import com.google.inject.Inject;
import com.google.inject.Provider;
import java.util.List;
import java.util.Map;
public class DeleteMembers implements RestModifyView<GroupResource, Input> {
private final GroupControl.Factory groupControlFactory;
private final AccountResolver accountResolver;
private final AccountCache accountCache;
private final ReviewDb db;
private final Provider<CurrentUser> self;
@Inject
DeleteMembers(final GroupControl.Factory groupControlFactory,
final AccountResolver accountResolver, final AccountCache accountCache,
final ReviewDb db, final Provider<CurrentUser> self) {
this.groupControlFactory = groupControlFactory;
this.accountResolver = accountResolver;
this.accountCache = accountCache;
this.db = db;
this.self = self;
}
@Override
public Class<Input> inputType() {
return Input.class;
}
@Override
public Object apply(GroupResource resource, Input input)
throws AuthException, MethodNotAllowedException, BadRequestException,
OrmException, NoSuchGroupException {
final GroupDescription.Basic group = resource.getGroup();
if (!(group instanceof GroupDescription.Internal)) {
throw new MethodNotAllowedException();
}
input = Input.init(input);
final AccountGroup internalGroup = ((GroupDescription.Internal) group).getAccountGroup();
final GroupControl control = groupControlFactory.controlFor(internalGroup);
final Map<Account.Id, AccountGroupMember> members = getMembers(internalGroup.getId());
final List<AccountGroupMember> toRemove = Lists.newLinkedList();
final BadRequestHandler badRequest = new BadRequestHandler("removing group members");
for (final String nameOrEmail : input.members) {
Account a = accountResolver.find(nameOrEmail);
if (a == null) {
badRequest.addError(new NoSuchAccountException(nameOrEmail));
continue;
}
if (!control.canRemoveMember(a.getId())) {
throw new AuthException("Cannot delete member: " + a.getFullName());
}
final AccountGroupMember m = members.remove(a.getId());
if (m != null) {
toRemove.add(m);
}
}
badRequest.failOnError();
writeAudits(toRemove);
db.accountGroupMembers().delete(toRemove);
for (final AccountGroupMember m : toRemove) {
accountCache.evict(m.getAccountId());
}
return Response.none();
}
private void writeAudits(final List<AccountGroupMember> toBeRemoved)
throws OrmException {
final Account.Id me = ((IdentifiedUser) self.get()).getAccountId();
final List<AccountGroupMemberAudit> auditUpdates = Lists.newLinkedList();
final List<AccountGroupMemberAudit> auditInserts = Lists.newLinkedList();
for (final AccountGroupMember m : toBeRemoved) {
AccountGroupMemberAudit audit = null;
for (AccountGroupMemberAudit a : db.accountGroupMembersAudit()
.byGroupAccount(m.getAccountGroupId(), m.getAccountId())) {
if (a.isActive()) {
audit = a;
break;
}
}
if (audit != null) {
audit.removed(me);
auditUpdates.add(audit);
} else {
audit = new AccountGroupMemberAudit(m, me);
audit.removedLegacy();
auditInserts.add(audit);
}
}
db.accountGroupMembersAudit().update(auditUpdates);
db.accountGroupMembersAudit().insert(auditInserts);
}
private Map<Account.Id, AccountGroupMember> getMembers(
final AccountGroup.Id groupId) throws OrmException, NoSuchGroupException {
final Map<Account.Id, AccountGroupMember> members = Maps.newHashMap();
for (final AccountGroupMember m : db.accountGroupMembers().byGroup(groupId)) {
members.put(m.getAccountId(), m);
}
return members;
}
static class DeleteMember implements RestModifyView<MemberResource, DeleteMember.Input> {
static class Input {
}
private final Provider<DeleteMembers> delete;
@Inject
DeleteMember(final Provider<DeleteMembers> delete) {
this.delete = delete;
}
@Override
public Class<Input> inputType() {
return DeleteMember.Input.class;
}
@Override
public Object apply(MemberResource resource, Input input)
throws AuthException, MethodNotAllowedException, BadRequestException,
OrmException, NoSuchGroupException {
PutMembers.Input in = new PutMembers.Input();
in._oneMember = resource.getUser().getAccountId().toString();
return delete.get().apply(resource.getGroup(), in);
}
}
}

9
gerrit-server/src/main/java/com/google/gerrit/server/group/MemberResource.java
View File

@@ -23,7 +23,14 @@ public class MemberResource extends AccountResource {
public static final TypeLiteral<RestView<MemberResource>> MEMBER_KIND =
new TypeLiteral<RestView<MemberResource>>() {};
public MemberResource(IdentifiedUser user) {
private final GroupResource group;
public MemberResource(GroupResource group, IdentifiedUser user) {
super(user);
this.group = group;
}
public GroupResource getGroup() {
return group;
}
}

3
gerrit-server/src/main/java/com/google/gerrit/server/group/MembersCollection.java
View File

@@ -83,7 +83,8 @@ public class MembersCollection implements
if (groupDetail.members != null) {
for (final AccountGroupMember member : groupDetail.members) {
if (member.getAccountId().equals(a.getId())) {
return new MemberResource(userGenericFactory.create(a.getId()));
return new MemberResource(parent,
userGenericFactory.create(a.getId()));
}
}
}

3
gerrit-server/src/main/java/com/google/gerrit/server/group/Module.java
View File

@@ -20,6 +20,7 @@ import static com.google.gerrit.server.group.MemberResource.MEMBER_KIND;
import com.google.gerrit.extensions.registration.DynamicMap;
import com.google.gerrit.extensions.restapi.RestApiModule;
import com.google.gerrit.server.group.DeleteMembers.DeleteMember;
public class Module extends RestApiModule {
@Override
@@ -35,6 +36,8 @@ public class Module extends RestApiModule {
child(GROUP_KIND, "members").to(MembersCollection.class);
get(MEMBER_KIND).to(GetMember.class);
put(GROUP_KIND, "members").to(PutMembers.class);
delete(GROUP_KIND, "members").to(DeleteMembers.class);
delete(MEMBER_KIND).to(DeleteMember.class);
child(GROUP_KIND, "groups").to(IncludedGroupsCollection.class);
get(INCLUDED_GROUP_KIND).to(GetIncludedGroup.class);