Updated documentation

James Moger

2013-01-05 9e186eedf1a09ca7ac4fbdea32b00e7e5331f7eb

 src/com/gitblit/models/TeamModel.java

@@ -18,15 +18,19 @@
import java.io.Serializable;

import java.util.ArrayList;

import java.util.Collection;

import java.util.HashMap;

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

@@ -41,11 +45,14 @@


   // 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 HashMap<String, AccessPermission>();

   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>();

@@ -82,6 +89,34 @@
   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

@@ -92,7 +127,33 @@
    */

   public boolean hasRepositoryPermission(String name) {

      String repository = AccessPermission.repositoryFromRole(name).toLowerCase();

      return permissions.containsKey(repository) || repositories.contains(repository);

      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);

   }

   

   /**

@@ -129,32 +190,50 @@
      repositories.add(repository.toLowerCase());

   }

   

   public AccessPermission getRepositoryPermission(RepositoryModel repository) {

      AccessPermission permission = AccessPermission.NONE;

   public RegistrantAccessPermission getRepositoryPermission(RepositoryModel repository) {

      RegistrantAccessPermission ap = new RegistrantAccessPermission();

      ap.registrant = name;

      ap.registrantType = RegistrantType.TEAM;

      ap.permission = AccessPermission.NONE;

      ap.mutable = false;

		
      if (canAdmin) {

         ap.permissionType = PermissionType.ADMINISTRATOR;

         ap.permission = AccessPermission.REWIND;

         return ap;

      }

		
      if (permissions.containsKey(repository.name.toLowerCase())) {

         // exact repository permission specified

         AccessPermission p = permissions.get(repository.name.toLowerCase());

         if (p != null) {

            permission = p;

            ap.permissionType = PermissionType.EXPLICIT;

            ap.permission = p;

            ap.mutable = true;

            return ap;

         }

      } else {

         // search for regex permission match

         // search for case-insensitive regex permission match

         for (String key : permissions.keySet()) {

            if (repository.name.matches(key)) {

            if (StringUtils.matchesIgnoreCase(repository.name, key)) {

               AccessPermission p = permissions.get(key);

               if (p != null) {

                  permission = p;

                  // take first match

                  ap.permissionType = PermissionType.REGEX;

                  ap.permission = p;

                  ap.source = key;

                  return ap;

               }

            }

         }

      }

      return permission;

      return ap;

   }

   

   private boolean canAccess(RepositoryModel repository, AccessRestrictionType ifRestriction, AccessPermission requirePermission) {

   protected boolean canAccess(RepositoryModel repository, AccessRestrictionType ifRestriction, AccessPermission requirePermission) {

      if (repository.accessRestriction.atLeast(ifRestriction)) {

         AccessPermission permission = getRepositoryPermission(repository);

         return permission.atLeast(requirePermission);

         RegistrantAccessPermission ap = getRepositoryPermission(repository);

         return ap.permission.atLeast(requirePermission);

      }

      return true;

   }