// Copyright (C) 2011 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.account;
import com.google.gerrit.common.data.GroupDetail;
import com.google.gerrit.common.data.GroupList;
import com.google.gerrit.common.data.GroupReference;
import com.google.gerrit.common.errors.NoSuchGroupException;
import com.google.gerrit.reviewdb.client.AccountGroup;
import com.google.gerrit.server.IdentifiedUser;
import com.google.gerrit.server.project.ProjectControl;
import com.google.gwtorm.server.OrmException;
import com.google.inject.Inject;
import com.google.inject.Provider;
import java.util.ArrayList;
import java.util.Collection;
import java.util.LinkedList;
import java.util.List;
import java.util.Set;
import java.util.TreeSet;
public class VisibleGroups {
public interface Factory {
VisibleGroups create();
}
private final Provider<IdentifiedUser> identifiedUser;
private final GroupCache groupCache;
private final GroupControl.Factory groupControlFactory;
private final GroupDetailFactory.Factory groupDetailFactory;
private boolean onlyVisibleToAll;
private AccountGroup.Type groupType;
@Inject
VisibleGroups(final Provider<IdentifiedUser> currentUser,
final GroupCache groupCache,
final GroupControl.Factory groupControlFactory,
final GroupDetailFactory.Factory groupDetailFactory) {
this.identifiedUser = currentUser;
this.groupCache = groupCache;
this.groupControlFactory = groupControlFactory;
this.groupDetailFactory = groupDetailFactory;
}
public void setOnlyVisibleToAll(final boolean onlyVisibleToAll) {
this.onlyVisibleToAll = onlyVisibleToAll;
}
public void setGroupType(final AccountGroup.Type groupType) {
this.groupType = groupType;
}
public GroupList get() throws OrmException, NoSuchGroupException {
final Iterable<AccountGroup> groups = groupCache.all();
return createGroupList(filterGroups(groups));
}
public GroupList get(final Collection<ProjectControl> projects)
throws OrmException, NoSuchGroupException {
final Set<AccountGroup> groups =
new TreeSet<AccountGroup>(new GroupComparator());
for (final ProjectControl projectControl : projects) {
final Set<GroupReference> groupsRefs = projectControl.getAllGroups();
for (final GroupReference groupRef : groupsRefs) {
final AccountGroup group = groupCache.get(groupRef.getUUID());
if (group == null) {
throw new NoSuchGroupException(groupRef.getUUID());
}
groups.add(group);
}
}
return createGroupList(filterGroups(groups));
}
/**
* Returns visible list of known groups for the user. Depending on the group
* membership realms supported, this may only return a subset of the effective
* groups.
* @See GroupMembership#getKnownGroups()
*/
public GroupList get(final IdentifiedUser user) throws OrmException,
NoSuchGroupException {
if (identifiedUser.get().getAccountId().equals(user.getAccountId())
|| identifiedUser.get().getCapabilities().canAdministrateServer()) {
final Set<AccountGroup.UUID> effective =
user.getEffectiveGroups().getKnownGroups();
final Set<AccountGroup> groups =
new TreeSet<AccountGroup>(new GroupComparator());
for (final AccountGroup.UUID groupId : effective) {
AccountGroup group = groupCache.get(groupId);
if (group != null) {
groups.add(group);
}
}
return createGroupList(filterGroups(groups));
} else {
throw new NoSuchGroupException("Groups of user '" + user.getAccountId()
+ "' are not visible.");
}
}
private List<AccountGroup> filterGroups(final Iterable<AccountGroup> groups) {
final List<AccountGroup> filteredGroups = new LinkedList<AccountGroup>();
final boolean isAdmin =
identifiedUser.get().getCapabilities().canAdministrateServer();
for (final AccountGroup group : groups) {
if (!isAdmin) {
final GroupControl c = groupControlFactory.controlFor(group);
if (!c.isVisible()) {
continue;
}
}
if ((onlyVisibleToAll && !group.isVisibleToAll())
|| (groupType != null && !groupType.equals(group.getType()))) {
continue;
}
filteredGroups.add(group);
}
return filteredGroups;
}
private GroupList createGroupList(final List<AccountGroup> groups)
throws OrmException, NoSuchGroupException {
final List<GroupDetail> groupDetailList = new ArrayList<GroupDetail>();
for (final AccountGroup group : groups) {
groupDetailList.add(groupDetailFactory.create(group.getId()).call());
}
return new GroupList(groupDetailList, identifiedUser.get()
.getCapabilities().canCreateGroup());
}
}