123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359360361362363364365366367368369370 |
- /*
- * Copyright 2011 gitblit.com.
- *
- * 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.gitblit.models;
-
- import java.io.Serializable;
- import java.util.ArrayList;
- import java.util.Collection;
- import java.util.Collections;
- import java.util.HashSet;
- import java.util.LinkedHashMap;
- import java.util.List;
- import java.util.Map;
- import java.util.Set;
-
- import com.gitblit.Constants.AccessPermission;
- import com.gitblit.Constants.AccessRestrictionType;
- import com.gitblit.Constants.PermissionType;
- import com.gitblit.Constants.RegistrantType;
- import com.gitblit.Constants.Unused;
- import com.gitblit.utils.StringUtils;
-
- /**
- * TeamModel is a serializable model class that represents a group of users and
- * a list of accessible repositories.
- *
- * @author James Moger
- *
- */
- public class TeamModel implements Serializable, Comparable<TeamModel> {
-
- private static final long serialVersionUID = 1L;
-
- // field names are reflectively mapped in EditTeam page
- public String name;
- public boolean canAdmin;
- public boolean canFork;
- public boolean canCreate;
- public final Set<String> users = new HashSet<String>();
- // retained for backwards-compatibility with RPC clients
- @Deprecated
- public final Set<String> repositories = new HashSet<String>();
- public final Map<String, AccessPermission> permissions = new LinkedHashMap<String, AccessPermission>();
- public final Set<String> mailingLists = new HashSet<String>();
- public final List<String> preReceiveScripts = new ArrayList<String>();
- public final List<String> postReceiveScripts = new ArrayList<String>();
-
- public TeamModel(String name) {
- this.name = name;
- }
-
- /**
- * @use hasRepositoryPermission
- * @param name
- * @return
- */
- @Deprecated
- @Unused
- public boolean hasRepository(String name) {
- return hasRepositoryPermission(name);
- }
-
- @Deprecated
- @Unused
- public void addRepository(String name) {
- addRepositoryPermission(name);
- }
-
- @Deprecated
- @Unused
- public void addRepositories(Collection<String> names) {
- addRepositoryPermissions(names);
- }
-
- @Deprecated
- @Unused
- public void removeRepository(String name) {
- removeRepositoryPermission(name);
- }
-
-
- /**
- * Returns a list of repository permissions for this team.
- *
- * @return the team's list of permissions
- */
- public List<RegistrantAccessPermission> getRepositoryPermissions() {
- List<RegistrantAccessPermission> list = new ArrayList<RegistrantAccessPermission>();
- if (canAdmin) {
- // team has REWIND access to all repositories
- return list;
- }
- for (Map.Entry<String, AccessPermission> entry : permissions.entrySet()) {
- String registrant = entry.getKey();
- String source = null;
- boolean editable = true;
- PermissionType pType = PermissionType.EXPLICIT;
- if (StringUtils.findInvalidCharacter(registrant) != null) {
- // a regex will have at least 1 invalid character
- pType = PermissionType.REGEX;
- source = registrant;
- }
- list.add(new RegistrantAccessPermission(registrant, entry.getValue(), pType, RegistrantType.REPOSITORY, source, editable));
- }
- Collections.sort(list);
- return list;
- }
-
- /**
- * Returns true if the team has any type of specified access permission for
- * this repository.
- *
- * @param name
- * @return true if team has a specified access permission for the repository
- */
- public boolean hasRepositoryPermission(String name) {
- String repository = AccessPermission.repositoryFromRole(name).toLowerCase();
- if (permissions.containsKey(repository)) {
- // exact repository permission specified
- return true;
- } else {
- // search for regex permission match
- for (String key : permissions.keySet()) {
- if (name.matches(key)) {
- AccessPermission p = permissions.get(key);
- if (p != null) {
- return true;
- }
- }
- }
- }
- return false;
- }
-
- /**
- * Returns true if the team has an explicitly specified access permission for
- * this repository.
- *
- * @param name
- * @return if the team has an explicitly specified access permission
- */
- public boolean hasExplicitRepositoryPermission(String name) {
- String repository = AccessPermission.repositoryFromRole(name).toLowerCase();
- return permissions.containsKey(repository);
- }
-
- /**
- * Adds a repository permission to the team.
- * <p>
- * Role may be formatted as:
- * <ul>
- * <li> myrepo.git <i>(this is implicitly RW+)</i>
- * <li> RW+:myrepo.git
- * </ul>
- * @param role
- */
- public void addRepositoryPermission(String role) {
- AccessPermission permission = AccessPermission.permissionFromRole(role);
- String repository = AccessPermission.repositoryFromRole(role).toLowerCase();
- repositories.add(repository);
- permissions.put(repository, permission);
- }
-
- public void addRepositoryPermissions(Collection<String> roles) {
- for (String role:roles) {
- addRepositoryPermission(role);
- }
- }
-
- public AccessPermission removeRepositoryPermission(String name) {
- String repository = AccessPermission.repositoryFromRole(name).toLowerCase();
- repositories.remove(repository);
- return permissions.remove(repository);
- }
-
- public void setRepositoryPermission(String repository, AccessPermission permission) {
- if (permission == null) {
- // remove the permission
- permissions.remove(repository.toLowerCase());
- repositories.remove(repository.toLowerCase());
- } else {
- // set the new permission
- permissions.put(repository.toLowerCase(), permission);
- repositories.add(repository.toLowerCase());
- }
- }
-
- public RegistrantAccessPermission getRepositoryPermission(RepositoryModel repository) {
- RegistrantAccessPermission ap = new RegistrantAccessPermission();
- ap.registrant = name;
- ap.registrantType = RegistrantType.TEAM;
- ap.permission = AccessPermission.NONE;
- ap.mutable = false;
-
- // determine maximum permission for the repository
- final AccessPermission maxPermission =
- (repository.isFrozen || !repository.isBare || repository.isMirror) ?
- AccessPermission.CLONE : AccessPermission.REWIND;
-
- if (AccessRestrictionType.NONE.equals(repository.accessRestriction)) {
- // anonymous rewind
- ap.permissionType = PermissionType.ANONYMOUS;
- if (AccessPermission.REWIND.atMost(maxPermission)) {
- ap.permission = AccessPermission.REWIND;
- } else {
- ap.permission = maxPermission;
- }
- return ap;
- }
-
- if (canAdmin) {
- ap.permissionType = PermissionType.ADMINISTRATOR;
- if (AccessPermission.REWIND.atMost(maxPermission)) {
- ap.permission = AccessPermission.REWIND;
- } else {
- ap.permission = maxPermission;
- }
- return ap;
- }
-
- if (permissions.containsKey(repository.name.toLowerCase())) {
- // exact repository permission specified
- AccessPermission p = permissions.get(repository.name.toLowerCase());
- if (p != null && repository.accessRestriction.isValidPermission(p)) {
- ap.permissionType = PermissionType.EXPLICIT;
- if (p.atMost(maxPermission)) {
- ap.permission = p;
- } else {
- ap.permission = maxPermission;
- }
- ap.mutable = true;
- return ap;
- }
- } else {
- // search for case-insensitive regex permission match
- for (String key : permissions.keySet()) {
- if (StringUtils.matchesIgnoreCase(repository.name, key)) {
- AccessPermission p = permissions.get(key);
- if (p != null && repository.accessRestriction.isValidPermission(p)) {
- // take first match
- ap.permissionType = PermissionType.REGEX;
- if (p.atMost(maxPermission)) {
- ap.permission = p;
- } else {
- ap.permission = maxPermission;
- }
- ap.source = key;
- return ap;
- }
- }
- }
- }
-
- // still no explicit or regex, check for implicit permissions
- if (AccessPermission.NONE == ap.permission) {
- switch (repository.accessRestriction) {
- case VIEW:
- // no implicit permissions possible
- break;
- case CLONE:
- // implied view permission
- ap.permission = AccessPermission.VIEW;
- ap.permissionType = PermissionType.ANONYMOUS;
- break;
- case PUSH:
- // implied clone permission
- ap.permission = AccessPermission.CLONE;
- ap.permissionType = PermissionType.ANONYMOUS;
- break;
- case NONE:
- // implied REWIND or CLONE
- ap.permission = maxPermission;
- ap.permissionType = PermissionType.ANONYMOUS;
- break;
- }
- }
-
- return ap;
- }
-
- protected boolean canAccess(RepositoryModel repository, AccessRestrictionType ifRestriction, AccessPermission requirePermission) {
- if (repository.accessRestriction.atLeast(ifRestriction)) {
- RegistrantAccessPermission ap = getRepositoryPermission(repository);
- return ap.permission.atLeast(requirePermission);
- }
- return true;
- }
-
- public boolean canView(RepositoryModel repository) {
- return canAccess(repository, AccessRestrictionType.VIEW, AccessPermission.VIEW);
- }
-
- public boolean canClone(RepositoryModel repository) {
- return canAccess(repository, AccessRestrictionType.CLONE, AccessPermission.CLONE);
- }
-
- public boolean canPush(RepositoryModel repository) {
- if (repository.isFrozen) {
- return false;
- }
- return canAccess(repository, AccessRestrictionType.PUSH, AccessPermission.PUSH);
- }
-
- public boolean canCreateRef(RepositoryModel repository) {
- if (repository.isFrozen) {
- return false;
- }
- return canAccess(repository, AccessRestrictionType.PUSH, AccessPermission.CREATE);
- }
-
- public boolean canDeleteRef(RepositoryModel repository) {
- if (repository.isFrozen) {
- return false;
- }
- return canAccess(repository, AccessRestrictionType.PUSH, AccessPermission.DELETE);
- }
-
- public boolean canRewindRef(RepositoryModel repository) {
- if (repository.isFrozen) {
- return false;
- }
- return canAccess(repository, AccessRestrictionType.PUSH, AccessPermission.REWIND);
- }
-
- public boolean hasUser(String name) {
- return users.contains(name.toLowerCase());
- }
-
- public void addUser(String name) {
- users.add(name.toLowerCase());
- }
-
- public void addUsers(Collection<String> names) {
- for (String name:names) {
- users.add(name.toLowerCase());
- }
- }
-
- public void removeUser(String name) {
- users.remove(name.toLowerCase());
- }
-
- public void addMailingLists(Collection<String> addresses) {
- for (String address:addresses) {
- mailingLists.add(address.toLowerCase());
- }
- }
-
- @Override
- public String toString() {
- return name;
- }
-
- @Override
- public int compareTo(TeamModel o) {
- return name.compareTo(o.name);
- }
- }
|