-
Notifications
You must be signed in to change notification settings - Fork 17
/
Permission.java
241 lines (200 loc) · 6.42 KB
/
Permission.java
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
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
/*
* Copyright 2011 Tyler Blair. All rights reserved.
*
* Redistribution and use in source and binary forms, with or without modification, are
* permitted provided that the following conditions are met:
*
* 1. Redistributions of source code must retain the above copyright notice, this list of
* conditions and the following disclaimer.
*
* 2. Redistributions in binary form must reproduce the above copyright notice, this list
* of conditions and the following disclaimer in the documentation and/or other materials
* provided with the distribution.
*
* THIS SOFTWARE IS PROVIDED BY THE AUTHOR ''AS IS'' AND ANY EXPRESS OR IMPLIED
* WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND
* FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE AUTHOR OR
* CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR
* CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR
* SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON
* ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING
* NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF
* ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
*
* The views and conclusions contained in the software and documentation are those of the
* authors and contributors and should not be interpreted as representing official policies,
* either expressed or implied, of anybody else.
*/
package com.griefcraft.model;
import com.griefcraft.util.Colors;
import com.griefcraft.util.StringUtil;
import com.griefcraft.util.UUIDRegistry;
import org.json.simple.JSONObject;
public class Permission {
/**
* The access level
* The ordering of this enum <b>MUST NOT</b> change as ordinal values are used internally.
*/
public enum Access {
/**
* The player has no access
*/
NONE,
/**
* The player has rights that of a regular player
*/
PLAYER,
/**
* The player has admin rights
*/
ADMIN;
@Override
public String toString() {
return StringUtil.capitalizeFirstLetter(super.toString());
}
}
/**
* The type this permission applies to.
* The ordering of this enum <b>MUST NOT</b> change as ordinal values are used internally.
*/
public enum Type {
/**
* Applies to a specific group of players
*/
GROUP,
/**
* Applies to a specific player
*/
PLAYER,
/**
* Unused / reserved, has been used before
*/
RESERVED,
/**
* Applies to citizens of a Towny town
*/
TOWN,
/**
* Allows a specific item (such as a key) to open the protection when interacted with in hand
*/
ITEM,
/**
* Applies to members of a WorldGuard region
*/
REGION;
@Override
public String toString() {
return StringUtil.capitalizeFirstLetter(super.toString());
}
}
/**
* The entity this applies to
*/
private String name;
/**
* The type of access used for the permission
*/
private Type type;
/**
* The access the permission has to the protection
*/
private Access access = Access.PLAYER;
/**
* If the permission is not synchronized to the database
*/
private boolean isVolatile = false;
public Permission() {
}
public Permission(String name) {
this.name = name;
}
public Permission(String name, Type type) {
this(name);
this.type = type;
}
public Permission(String name, Type type, Access access) {
this(name, type);
this.access = access;
}
/**
* Encode the Permission object to a JSONObject
*
* @return
*/
@SuppressWarnings("unchecked")
public JSONObject encodeToJSON() {
JSONObject object = new JSONObject();
object.put("name", name);
object.put("type", getType().ordinal());
object.put("rights", getAccess().ordinal());
return object;
}
/**
* Decode a JSONObject into a Permission object
*
* @param node
* @return
*/
public static Permission decodeJSON(JSONObject node) {
Permission permission = new Permission();
Access access = Access.values()[((Long) node.get("rights")).intValue()];
if (access.ordinal() == 0) {
access = Access.PLAYER;
}
// The values are stored as longs internally, despite us passing an int
permission.setName((String) node.get("name"));
permission.setType(Type.values()[((Long) node.get("type")).intValue()]);
permission.setAccess(access);
return permission;
}
@Override
public String toString() {
StringBuilder builder = new StringBuilder();
builder.append(Colors.Yellow);
if (type == Type.PLAYER) {
builder.append(UUIDRegistry.formatPlayerName(getName()));
} else {
builder.append(getName());
}
builder.append(Colors.White);
builder.append(" (");
builder.append(Colors.Green);
builder.append(getType());
builder.append(Colors.White);
builder.append(") ");
if (getAccess() == Access.ADMIN) {
builder.append(Colors.White);
builder.append("(");
builder.append(Colors.Red);
builder.append("ADMIN");
builder.append(Colors.White);
builder.append(")");
}
return builder.toString();
// return String.format("Permission = { protection=%d name=%s rights=%d type=%s }", protectionId, name, rights, typeToString(rights));
}
public String getName() {
return name;
}
public Access getAccess() {
return access;
}
public Type getType() {
return type;
}
public void setName(String name) {
this.name = name;
}
public void setAccess(Access access) {
this.access = access;
}
public void setType(Type type) {
this.type = type;
}
public void setVolatile(boolean isVolatile) {
this.isVolatile = isVolatile;
}
public boolean isVolatile() {
return isVolatile;
}
}