Extract UserManager from GitBlit singleton

James Moger

2013-11-20 8f1c9fd7e0f7ea3d7d0b87788eb92ba2f0f09d59

 src/main/java/com/gitblit/models/UserModel.java

@@ -35,22 +35,23 @@
import com.gitblit.Constants.RegistrantType;

import com.gitblit.Constants.Unused;

import com.gitblit.utils.ArrayUtils;

import com.gitblit.utils.ModelUtils;

import com.gitblit.utils.StringUtils;



/**

 * UserModel is a serializable model class that represents a user and the user's

 * restricted repository memberships. Instances of UserModels are also used as

 * servlet user principals.

 * 
 *

 * @author James Moger

 * 
 *

 */

public class UserModel implements Principal, Serializable, Comparable<UserModel> {



   private static final long serialVersionUID = 1L;



   public static final UserModel ANONYMOUS = new UserModel();

	


   // field names are reflectively mapped in EditUser page

   public String username;

   public String password;

@@ -77,7 +78,7 @@
   public AccountType accountType;



   public UserPreferences userPreferences;

	


   public UserModel(String username) {

      this.username = username;

      this.isAuthenticated = true;

@@ -91,7 +92,7 @@
      this.accountType = AccountType.LOCAL;

      this.userPreferences = new UserPreferences(this.username);

   }

	


   public boolean isLocalAccount() {

      return accountType.isLocal();

   }

@@ -99,7 +100,7 @@
   /**

    * This method does not take into consideration Ownership where the

    * administrator has not explicitly granted access to the owner.

    * 
    *

    * @param repositoryName

    * @return

    */

@@ -128,7 +129,7 @@
      }

      return false;

   }

	


   @Deprecated

   @Unused

   public boolean hasRepository(String name) {

@@ -146,11 +147,11 @@
   public void removeRepository(String name) {

      removeRepositoryPermission(name);

   }

	


   /**

    * Returns a list of repository permissions for this user exclusive of

    * permissions inherited from team memberships.

    * 
    *

    * @return the user's list of permissions

    */

   public List<RegistrantAccessPermission> getRepositoryPermissions() {

@@ -177,7 +178,7 @@
         list.add(new RegistrantAccessPermission(registrant, ap, pType, RegistrantType.REPOSITORY, source, mutable));

      }

      Collections.sort(list);

		


      // include immutable team permissions, being careful to preserve order

      Set<RegistrantAccessPermission> set = new LinkedHashSet<RegistrantAccessPermission>(list);

      for (TeamModel team : teams) {

@@ -192,11 +193,11 @@
      }

      return new ArrayList<RegistrantAccessPermission>(set);

   }

	


   /**

    * Returns true if the user has any type of specified access permission for

    * this repository.

    * 
    *

    * @param name

    * @return true if user has a specified access permission for the repository

    */

@@ -218,11 +219,11 @@
      }

      return false;

   }

	


   /**

    * Returns true if the user has an explicitly specified access permission for

    * this repository.

    * 
    *

    * @param name

    * @return if the user has an explicitly specified access permission

    */

@@ -230,11 +231,11 @@
      String repository = AccessPermission.repositoryFromRole(name).toLowerCase();

      return permissions.containsKey(repository);

   }

	


   /**

    * Returns true if the user's team memberships specify an access permission for

    * this repository.

    * 
    *

    * @param name

    * @return if the user's team memberships specifi an access permission

    */

@@ -248,7 +249,7 @@
      }

      return false;

   }

	


   /**

    * Adds a repository permission to the team.

    * <p>

@@ -265,13 +266,13 @@
      repositories.add(repository);

      permissions.put(repository, permission);

   }

	


   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

@@ -288,10 +289,10 @@
      ap.registrantType = RegistrantType.USER;

      ap.permission = AccessPermission.NONE;

      ap.mutable = false;

		


      // determine maximum permission for the repository

      final AccessPermission maxPermission = 
            (repository.isFrozen || !repository.isBare) ?

      final AccessPermission maxPermission =

            (repository.isFrozen || !repository.isBare || repository.isMirror) ?

                  AccessPermission.CLONE : AccessPermission.REWIND;



      if (AccessRestrictionType.NONE.equals(repository.accessRestriction)) {

@@ -324,7 +325,7 @@
         }

         return ap;

      }

		


      // repository owner - either specified owner or personal repository

      if (repository.isOwner(username) || repository.isUsersPersonalRepository(username)) {

         ap.permissionType = PermissionType.OWNER;

@@ -335,7 +336,7 @@
         }

         return ap;

      }

		


      if (AuthorizationControl.AUTHENTICATED.equals(repository.authorizationControl) && isAuthenticated) {

         // AUTHENTICATED is a shortcut for authorizing all logged-in users RW+ access

         if (AccessPermission.REWIND.atMost(maxPermission)) {

@@ -345,7 +346,7 @@
         }

         return ap;

      }

		


      // explicit user permission OR user regex match is used

      // if that fails, then the best team permission is used

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

@@ -380,7 +381,7 @@
            }

         }

      }

		


      // try to find a team match

      for (TeamModel team : teams) {

         RegistrantAccessPermission p = team.getRepositoryPermission(repository);

@@ -391,7 +392,7 @@
            ap.permissionType = PermissionType.TEAM;

         }

      }

		


      // still no explicit, regex, or team match, check for implicit permissions

      if (AccessPermission.NONE == ap.permission) {

         switch (repository.accessRestriction) {

@@ -415,10 +416,10 @@
            break;

         }

      }

		


      return ap;

   }

	


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

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

         RegistrantAccessPermission ap = getRepositoryPermission(repository);

@@ -426,11 +427,11 @@
      }

      return true;

   }

	


   public boolean canView(RepositoryModel repository) {

      return canAccess(repository, AccessRestrictionType.VIEW, AccessPermission.VIEW);

   }

	


   public boolean canView(RepositoryModel repository, String ref) {

      // Default UserModel doesn't implement ref-level security.

      // Other Realms (i.e. Gerrit) may override this method.

@@ -485,19 +486,19 @@
      }

      return canClone(repository);

   }

	


   public boolean canDelete(RepositoryModel model) {

      return canAdmin() || model.isUsersPersonalRepository(username);

   }

	


   public boolean canEdit(RepositoryModel model) {

      return canAdmin() || model.isUsersPersonalRepository(username) || model.isOwner(username);

   }

	


   /**

    * This returns true if the user has fork privileges or the user has fork

    * privileges because of a team membership.

    * 
    *

    * @return true if the user can fork

    */

   public boolean canFork() {

@@ -517,7 +518,7 @@
   /**

    * This returns true if the user has admin privileges or the user has admin

    * privileges because of a team membership.

    * 
    *

    * @return true if the user can admin

    */

   public boolean canAdmin() {

@@ -537,7 +538,7 @@
   /**

    * This returns true if the user has create privileges or the user has create

    * privileges because of a team membership.

    * 
    *

    * @return true if the user can admin

    */

   public boolean canCreate() {

@@ -553,10 +554,10 @@
      }

      return false;

   }

	


   /**

    * Returns true if the user is allowed to create the specified repository.

    * 
    *

    * @param repository

    * @return true if the user can create the repository

    */

@@ -567,7 +568,7 @@
      }

      if (canCreate) {

         String projectPath = StringUtils.getFirstPathElement(repository);

         if (!StringUtils.isEmpty(projectPath) && projectPath.equalsIgnoreCase("~" + username)) {

         if (!StringUtils.isEmpty(projectPath) && projectPath.equalsIgnoreCase(getPersonalPath())) {

            // personal repository

            return true;

         }

@@ -600,27 +601,27 @@
   public String getName() {

      return username;

   }

	


   public String getDisplayName() {

      if (StringUtils.isEmpty(displayName)) {

         return username;

      }

      return displayName;

   }

	


   public String getPersonalPath() {

      return "~" + username;

      return ModelUtils.getPersonalPath(username);

   }

	


   public UserPreferences getPreferences() {

      return userPreferences;

   }

	


   @Override

   public int hashCode() {

      return username.hashCode();

   }

	


   @Override

   public boolean equals(Object o) {

      if (o instanceof UserModel) {

@@ -638,10 +639,10 @@
   public int compareTo(UserModel o) {

      return username.compareTo(o.username);

   }

	


   /**

    * Returns true if the name/email pair match this user account.

    * 
    *

    * @param name

    * @param email

    * @return true, if the name and email address match this account

@@ -666,15 +667,15 @@
      }

      return nameVerified && emailVerified;

   }

	


   @Deprecated

   public boolean hasBranchPermission(String repositoryName, String branch) {

      // Default UserModel doesn't implement branch-level security. Other Realms (i.e. Gerrit) may override this method.

      return hasRepositoryPermission(repositoryName) || hasTeamRepositoryPermission(repositoryName);

   }

	


   public boolean isMyPersonalRepository(String repository) {

      String projectPath = StringUtils.getFirstPathElement(repository);

      return !StringUtils.isEmpty(projectPath) && projectPath.equalsIgnoreCase("~" + username);

      return !StringUtils.isEmpty(projectPath) && projectPath.equalsIgnoreCase(getPersonalPath());

   }

}