James Moger
2015-09-18 a592329a82d0a85d33abcc63f08df20b79e8e4f7
src/main/java/com/gitblit/Constants.java
@@ -19,14 +19,16 @@
import java.lang.annotation.Retention;
import java.lang.annotation.RetentionPolicy;
import java.net.URL;
import java.util.Arrays;
import java.util.List;
import java.util.jar.Attributes;
import java.util.jar.Manifest;
/**
 * Constant values used by Gitblit.
 *
 *
 * @author James Moger
 *
 *
 */
public class Constants {
@@ -34,17 +36,28 @@
   public static final String FULL_NAME = "Gitblit - a pure Java Git solution";
   @Deprecated
   public static final String ADMIN_ROLE = "#admin";
   @Deprecated
   public static final String FORK_ROLE = "#fork";
   @Deprecated
   public static final String CREATE_ROLE = "#create";
   @Deprecated
   public static final String NOT_FEDERATED_ROLE = "#notfederated";
   @Deprecated
   public static final String NO_ROLE = "#none";
   public static final String EXTERNAL_ACCOUNT = "#externalAccount";
   public static final String PROPERTIES_FILE = "gitblit.properties";
   public static final String DEFAULT_USER_REPOSITORY_PREFIX = "~";
   public static final String R_PATH = "/r/";
   public static final String GIT_PATH = "/git/";
@@ -55,38 +68,76 @@
   public static final String FEDERATION_PATH = "/federation/";
   public static final String RPC_PATH = "/rpc/";
   public static final String PAGES = "/pages/";
   public static final String SPARKLESHARE_INVITE_PATH = "/sparkleshare/";
   public static final String BORDER = "***********************************************************";
   public static final String RAW_PATH = "/raw/";
   public static final String PT_PATH = "/pt";
   public static final String BRANCH_GRAPH_PATH = "/graph/";
   public static final String BORDER = "*****************************************************************";
   public static final String BORDER2 = "#################################################################";
   public static final String FEDERATION_USER = "$gitblit";
   public static final String PROPOSAL_EXT = ".json";
   public static final String ENCODING = "UTF-8";
   public static final int LEN_SHORTLOG = 78;
   public static final int LEN_SHORTLOG_REFS = 60;
   public static final String DEFAULT_BRANCH = "default";
   public static final String CONFIG_GITBLIT = "gitblit";
   public static final String CONFIG_CUSTOM_FIELDS = "customFields";
   public static final String ISO8601 = "yyyy-MM-dd'T'HH:mm:ssZ";
   public static final String R_GITBLIT = "refs/gitblit/";
   public static final String baseFolder = "baseFolder";
   public static final String baseFolder$ = "${" + baseFolder + "}";
   public static final String contextFolder$ = "${contextFolder}";
   public static final String HEAD = "HEAD";
   public static final String R_META = "refs/meta/";
   public static final String R_HEADS = "refs/heads/";
   public static final String R_NOTES = "refs/notes/";
   public static final String R_CHANGES = "refs/changes/";
   public static final String R_PULL = "refs/pull/";
   public static final String R_TAGS = "refs/tags/";
   public static final String R_REMOTES = "refs/remotes/";
   public static final String R_FOR = "refs/for/";
   public static final String R_TICKET = "refs/heads/ticket/";
   public static final String R_TICKETS_PATCHSETS = "refs/tickets/";
   public static final String R_MASTER = "refs/heads/master";
   public static final String MASTER = "master";
   public static final String R_DEVELOP = "refs/heads/develop";
   public static final String DEVELOP = "develop";
   public static final String AUTHENTICATION_TYPE = "authentication-type";
   public static String getVersion() {
      String v = Constants.class.getPackage().getImplementationVersion();
@@ -99,11 +150,22 @@
   public static String getGitBlitVersion() {
      return NAME + " v" + getVersion();
   }
   public static String getBuildDate() {
      return getManifestValue("build-date", "PENDING");
   }
   public static String getASCIIArt() {
      StringBuilder sb = new StringBuilder();
      sb.append("  _____  _  _    _      _  _  _").append('\n');
      sb.append(" |  __ \\(_)| |  | |    | |(_)| |").append('\n');
      sb.append(" | |  \\/ _ | |_ | |__  | | _ | |_").append('\n');
      sb.append(" | | __ | || __|| '_ \\ | || || __|").append("  ").append("http://gitblit.com").append('\n');
      sb.append(" | |_\\ \\| || |_ | |_) || || || |_").append("   ").append("@gitblit").append('\n');
      sb.append("  \\____/|_| \\__||_.__/ |_||_| \\__|").append("  ").append(Constants.getVersion()).append('\n');
      return sb.toString();
   }
   private static String getManifestValue(String attrib, String defaultValue) {
      Class<?> clazz = Constants.class;
      String className = clazz.getSimpleName() + ".class";
@@ -122,12 +184,27 @@
      }
      return defaultValue;
   }
   public static enum Role {
      NONE, ADMIN, CREATE, FORK, NOT_FEDERATED;
      public String getRole() {
         return "#" + name().replace("_", "").toLowerCase();
      }
      @Override
      public String toString() {
         return getRole();
      }
   }
   /**
    * Enumeration representing the four access restriction levels.
    */
   public static enum AccessRestrictionType {
      NONE, PUSH, CLONE, VIEW;
      private static final AccessRestrictionType [] AUTH_TYPES = { PUSH, CLONE, VIEW };
      public static AccessRestrictionType fromName(String name) {
         for (AccessRestrictionType type : values()) {
@@ -138,6 +215,13 @@
         return NONE;
      }
      public static List<AccessRestrictionType> choices(boolean allowAnonymousPush) {
         if (allowAnonymousPush) {
            return Arrays.asList(values());
         }
         return Arrays.asList(AUTH_TYPES);
      }
      public boolean exceeds(AccessRestrictionType type) {
         return this.ordinal() > type.ordinal();
      }
@@ -146,10 +230,11 @@
         return this.ordinal() >= type.ordinal();
      }
      @Override
      public String toString() {
         return name();
      }
      public boolean isValidPermission(AccessPermission permission) {
         switch (this) {
         case VIEW:
@@ -162,7 +247,7 @@
            return permission.atLeast(AccessPermission.CLONE);
         case PUSH:
            // PUSH restriction
            // only PUSH or greater access permissions are valid
            // only PUSH or greater access permissions are valid
            return permission.atLeast(AccessPermission.PUSH);
         case NONE:
            // NO access restriction
@@ -172,14 +257,14 @@
         return false;
      }
   }
   /**
    * Enumeration representing the types of authorization control for an
    * access restricted resource.
    */
   public static enum AuthorizationControl {
      AUTHENTICATED, NAMED;
      public static AuthorizationControl fromName(String name) {
         for (AuthorizationControl type : values()) {
            if (type.name().equalsIgnoreCase(name)) {
@@ -188,7 +273,8 @@
         }
         return NAMED;
      }
      @Override
      public String toString() {
         return name();
      }
@@ -210,6 +296,7 @@
         return REPOSITORIES;
      }
      @Override
      public String toString() {
         return name();
      }
@@ -230,6 +317,7 @@
         return PULL_REPOSITORIES;
      }
      @Override
      public String toString() {
         return name();
      }
@@ -303,14 +391,15 @@
    * a client.
    */
   public static enum RpcRequest {
      // Order is important here.  anything above LIST_SETTINGS requires
      // Order is important here.  anything after LIST_SETTINGS requires
      // administrator privileges and web.allowRpcManagement.
      CLEAR_REPOSITORY_CACHE, GET_PROTOCOL, LIST_REPOSITORIES, LIST_BRANCHES, LIST_SETTINGS,
      CREATE_REPOSITORY, EDIT_REPOSITORY, DELETE_REPOSITORY,
      LIST_USERS, CREATE_USER, EDIT_USER, DELETE_USER,
      CLEAR_REPOSITORY_CACHE, REINDEX_TICKETS, GET_PROTOCOL, LIST_REPOSITORIES, LIST_BRANCHES, GET_USER,
      FORK_REPOSITORY, LIST_SETTINGS,
      CREATE_REPOSITORY, EDIT_REPOSITORY, DELETE_REPOSITORY,
      LIST_USERS, CREATE_USER, EDIT_USER, DELETE_USER,
      LIST_TEAMS, CREATE_TEAM, EDIT_TEAM, DELETE_TEAM,
      LIST_REPOSITORY_MEMBERS, SET_REPOSITORY_MEMBERS, LIST_REPOSITORY_TEAMS, SET_REPOSITORY_TEAMS,
      LIST_REPOSITORY_MEMBER_PERMISSIONS, SET_REPOSITORY_MEMBER_PERMISSIONS, LIST_REPOSITORY_TEAM_PERMISSIONS, SET_REPOSITORY_TEAM_PERMISSIONS,
      LIST_REPOSITORY_MEMBERS, SET_REPOSITORY_MEMBERS, LIST_REPOSITORY_TEAMS, SET_REPOSITORY_TEAMS,
      LIST_REPOSITORY_MEMBER_PERMISSIONS, SET_REPOSITORY_MEMBER_PERMISSIONS, LIST_REPOSITORY_TEAM_PERMISSIONS, SET_REPOSITORY_TEAM_PERMISSIONS,
      LIST_FEDERATION_REGISTRATIONS, LIST_FEDERATION_RESULTS, LIST_FEDERATION_PROPOSALS, LIST_FEDERATION_SETS,
      EDIT_SETTINGS, LIST_STATUS;
@@ -321,7 +410,7 @@
            }
         }
         return null;
      }
      }
      public boolean exceeds(RpcRequest type) {
         return this.ordinal() > type.ordinal();
@@ -338,7 +427,7 @@
    */
   public static enum SearchType {
      AUTHOR, COMMITTER, COMMIT;
      public static SearchType forName(String name) {
         for (SearchType type : values()) {
            if (type.name().equalsIgnoreCase(name)) {
@@ -347,20 +436,41 @@
         }
         return COMMIT;
      }
      @Override
      public String toString() {
         return name().toLowerCase();
      }
   }
   /**
    * Enumeration of the feed content object types.
    */
   public static enum FeedObjectType {
      COMMIT, TAG;
      public static FeedObjectType forName(String name) {
         for (FeedObjectType type : values()) {
            if (type.name().equalsIgnoreCase(name)) {
               return type;
            }
         }
         return COMMIT;
      }
      @Override
      public String toString() {
         return name().toLowerCase();
      }
   }
   /**
    * The types of objects that can be indexed and queried.
    */
   public static enum SearchObjectType {
      commit, blob, issue;
      commit, blob;
      static SearchObjectType fromName(String name) {
      public static SearchObjectType fromName(String name) {
         for (SearchObjectType value : values()) {
            if (value.name().equals(name)) {
               return value;
@@ -369,19 +479,21 @@
         return null;
      }
   }
   /**
    * The access permissions available for a repository.
    * The access permissions available for a repository.
    */
   public static enum AccessPermission {
      NONE("N"), EXCLUDE("X"), VIEW("V"), CLONE("R"), PUSH("RW"), CREATE("RWC"), DELETE("RWD"), REWIND("RW+"), OWNER("RW+");
      public static final AccessPermission [] NEWPERMISSIONS = { EXCLUDE, VIEW, CLONE, PUSH, CREATE, DELETE, REWIND };
      public static final AccessPermission [] SSHPERMISSIONS = { VIEW, CLONE, PUSH };
      public static AccessPermission LEGACY = REWIND;
      public final String code;
      private AccessPermission(String code) {
         this.code = code;
      }
@@ -397,16 +509,16 @@
      public boolean exceeds(AccessPermission perm) {
         return ordinal() > perm.ordinal();
      }
      public String asRole(String repository) {
         return code + ":" + repository;
      }
      @Override
      public String toString() {
         return code;
      }
      public static AccessPermission permissionFromRole(String role) {
         String [] fields = role.split(":", 2);
         if (fields.length == 1) {
@@ -417,7 +529,7 @@
            return AccessPermission.fromCode(fields[0]);
         }
      }
      public static String repositoryFromRole(String role) {
         String [] fields = role.split(":", 2);
         if (fields.length == 1) {
@@ -428,7 +540,7 @@
            return fields[1];
         }
      }
      public static AccessPermission fromCode(String code) {
         for (AccessPermission perm : values()) {
            if (perm.code.equalsIgnoreCase(code)) {
@@ -438,39 +550,85 @@
         return AccessPermission.NONE;
      }
   }
   public static enum RegistrantType {
      REPOSITORY, USER, TEAM;
   }
   public static enum PermissionType {
      MISSING, ANONYMOUS, EXPLICIT, TEAM, REGEX, OWNER, ADMINISTRATOR;
   }
   public static enum GCStatus {
      READY, COLLECTING;
      public boolean exceeds(GCStatus s) {
         return ordinal() > s.ordinal();
      }
   }
   public static enum AuthenticationType {
      CREDENTIALS, COOKIE, CERTIFICATE, CONTAINER;
      PUBLIC_KEY, CREDENTIALS, COOKIE, CERTIFICATE, CONTAINER;
      public boolean isStandard() {
         return ordinal() <= COOKIE.ordinal();
      }
   }
   public static enum AccountType {
      LOCAL, LDAP, REDMINE;
      LOCAL, EXTERNAL, CONTAINER, LDAP, REDMINE, SALESFORCE, WINDOWS, PAM, HTPASSWD;
      public static AccountType fromString(String value) {
         for (AccountType type : AccountType.values()) {
            if (type.name().equalsIgnoreCase(value)) {
               return type;
            }
         }
         return AccountType.LOCAL;
      }
      public boolean isLocal() {
         return this == LOCAL;
      }
   }
   public static enum CommitMessageRenderer {
      PLAIN, MARKDOWN;
      public static CommitMessageRenderer fromName(String name) {
         for (CommitMessageRenderer renderer : values()) {
            if (renderer.name().equalsIgnoreCase(name)) {
               return renderer;
            }
         }
         return CommitMessageRenderer.PLAIN;
      }
   }
   public static enum Transport {
      // ordered for url advertisements, assuming equal access permissions
      SSH, HTTPS, HTTP, GIT;
      public static Transport fromString(String value) {
         for (Transport t : values()) {
            if (t.name().equalsIgnoreCase(value)) {
               return t;
            }
         }
         return null;
      }
      public static Transport fromUrl(String url) {
         int delim = url.indexOf("://");
         if (delim == -1) {
            // if no protocol is specified, SSH is assumed by git clients
            return SSH;
         }
         String scheme = url.substring(0, delim);
         return fromString(scheme);
      }
   }
   @Documented
   @Retention(RetentionPolicy.RUNTIME)
   public @interface Unused {