summaryrefslogtreecommitdiffstats
path: root/src/main/java/com/gitblit/models/RegistrantAccessPermission.java
blob: a7fcde4484c3955af0fdbce8a163f63fa70b7a2a (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
/*
 * Copyright 2012 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 com.gitblit.Constants.AccessPermission;
import com.gitblit.Constants.PermissionType;
import com.gitblit.Constants.RegistrantType;
import com.gitblit.utils.StringUtils;

/**
 * Represents a Registrant-AccessPermission tuple.
 *
 * @author James Moger
 */
public class RegistrantAccessPermission implements Serializable, Comparable<RegistrantAccessPermission> {

	private static final long serialVersionUID = 1L;

	public String registrant;
	public AccessPermission permission;
	public RegistrantType registrantType;
	public PermissionType permissionType;
	public boolean mutable;
	public String source;

	public RegistrantAccessPermission() {
	}

	public RegistrantAccessPermission(RegistrantType registrantType) {
		this.registrantType = registrantType;
		this.permissionType = PermissionType.EXPLICIT;
		this.mutable = true;
	}

	public RegistrantAccessPermission(String registrant, AccessPermission permission, PermissionType permissionType, RegistrantType registrantType, String source, boolean mutable) {
		this.registrant = registrant;
		this.permission = permission;
		this.permissionType = permissionType;
		this.registrantType = registrantType;
		this.source = source;
		this.mutable = mutable;
	}

	public boolean isAdmin() {
		return PermissionType.ADMINISTRATOR.equals(permissionType);
	}

	public boolean isOwner() {
		return PermissionType.OWNER.equals(permissionType);
	}

	public boolean isExplicit() {
		return PermissionType.EXPLICIT.equals(permissionType);
	}

	public boolean isRegex() {
		return PermissionType.REGEX.equals(permissionType);
	}

	public boolean isTeam() {
		return PermissionType.TEAM.equals(permissionType);
	}

	public boolean isMissing() {
		return PermissionType.MISSING.equals(permissionType);
	}

	public int getScore() {
		switch (registrantType) {
		case REPOSITORY:
			if (isAdmin()) {
				return 0;
			}
			if (isOwner()) {
				return 1;
			}
			if (isExplicit()) {
				return 2;
			}
			if (isRegex()) {
				return 3;
			}
			if (isTeam()) {
				return 4;
			}
		default:
			return 0;
		}
	}

	@Override
	public int compareTo(RegistrantAccessPermission p) {
		switch (registrantType) {
		case REPOSITORY:
			// repository permissions are sorted in score order
			// to convey the order in which permissions are tested
			int score1 = getScore();
			int score2 = p.getScore();
			if (score1 <= 2 && score2 <= 2) {
				// group admin, owner, and explicit together
				return StringUtils.compareRepositoryNames(registrant, p.registrant);
			}
			if (score1 < score2) {
				return -1;
			} else if (score2 < score1) {
				return 1;
			}
			return StringUtils.compareRepositoryNames(registrant, p.registrant);
		default:
			// user and team permissions are string sorted
			return registrant.toLowerCase().compareTo(p.registrant.toLowerCase());
		}
	}

	@Override
	public int hashCode() {
		return registrant.hashCode();
	}

	@Override
	public boolean equals(Object o) {
		if (o instanceof RegistrantAccessPermission) {
			RegistrantAccessPermission p = (RegistrantAccessPermission) o;
			return registrant.equals(p.registrant);
		}

		return false;
	}

	@Override
	public String toString() {
		return permission.asRole(registrant);
	}
}