-
Notifications
You must be signed in to change notification settings - Fork 17
/
Protection.java
635 lines (510 loc) · 14.1 KB
/
Protection.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
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
/**
* This file is part of LWC (https://github.com/Hidendra/LWC)
*
* This program is free software: you can redistribute it and/or modify
* it under the terms of the GNU General Public License as published by
* the Free Software Foundation, either version 3 of the License, or
* (at your option) any later version.
*
* This program is distributed in the hope that it will be useful,
* but WITHOUT ANY WARRANTY; without even the implied warranty of
* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
* GNU General Public License for more details.
*
* You should have received a copy of the GNU General Public License
* along with this program. If not, see <http://www.gnu.org/licenses/>.
*/
package com.griefcraft.model;
import com.griefcraft.cache.CacheSet;
import com.griefcraft.cache.LRUCache;
import com.griefcraft.lwc.LWC;
import com.griefcraft.scripting.ModuleLoader;
import com.griefcraft.scripting.event.LWCProtectionRemovePostEvent;
import com.griefcraft.util.Colors;
import com.griefcraft.util.StringUtils;
import org.bukkit.Bukkit;
import org.bukkit.World;
import org.bukkit.block.Block;
import org.bukkit.entity.Player;
import java.util.ArrayList;
import java.util.Iterator;
import java.util.List;
import java.util.logging.Logger;
public class Protection {
// re-use LWC logger
@SuppressWarnings("unused")
private Logger logger = Logger.getLogger("LWC");
// just a footnote, if a flag is "on", it is SET in the database, however if it's set to "off"
// it is REMOVED from the database if it is in it!
public enum Flag {
/**
* If set, redstone use is DISABLED if protections.denyRedstone = FALSE
*/
REDSTONE(0x02),
/**
* Attracts dropped items into the inventory
*/
MAGNET(0x03);
Flag(int bit) {
this.bit = bit;
}
private int bit;
public int getBit() {
return bit;
}
}
/**
* List of the access rights for the protection
*/
private List<AccessRight> access = new ArrayList<AccessRight>();
/**
* The block id
*/
private int blockId;
/**
* The password for the chest
*/
private String data;
/**
* The date created
*/
private String date;
/**
* Unique id (in sql)
*/
private int id;
/**
* Bit-packed flags
*/
private int flags;
/**
* The owner of the chest
*/
private String owner;
/**
* The chest type
*/
private int type;
/**
* The world this protection is in
*/
private String world;
/**
* The x coordinate
*/
private int x;
/**
* The y coordinate
*/
private int y;
/**
* The z coordinate
*/
private int z;
/**
* The timestamp of when the protection was last accessed
*/
private long lastAccessed;
/**
* Immutable flag for the protection. When removed, this bool is switched to true and any setters
* will no longer work. However, everything is still intact and in memory at this point (for now.)
*/
private boolean removed = false;
/**
* Check if a player is the owner of the protection
*
* @param player
* @return
*/
public boolean isOwner(Player player) {
LWC lwc = LWC.getInstance();
return player != null && (owner.equals(player.getName()) || lwc.isAdmin(player));
}
/**
* Create a History object that is attached to this protection
*
* @return
*/
public History createHistoryObject() {
History history = new History();
history.setProtectionId(id);
history.setStatus(History.Status.INACTIVE);
return history;
}
/**
* @return the related history for this protection
*/
public List<History> getRelatedHistory() {
return LWC.getInstance().getPhysicalDatabase().loadHistory(this);
}
/**
* Get the related history for this protection using the given type
*
* @param type
* @return
*/
public List<History> getRelatedHistory(History.Type type) {
List<History> matches = new ArrayList<History>();
List<History> relatedHistory = getRelatedHistory();
for (History history : relatedHistory) {
if (history.getType() == type) {
matches.add(history);
}
}
return matches;
}
/**
* Check if a flag is toggled
*
* @param flag
* @return
*/
public boolean hasFlag(Flag flag) {
return (flags & flag.getBit()) == flag.getBit();
}
/**
* Add a flag to the protection
*
* @param flag
* @return
*/
public boolean addFlag(Flag flag) {
if (removed) {
return false;
}
if (!hasFlag(flag)) {
flags |= flag.getBit();
return true;
}
return false;
}
/**
* Remove a flag from the protection
* TODO: redo? :s
*
* @param flag
* @return
*/
public void removeFlag(Flag flag) {
if (removed) {
return;
}
if (!hasFlag(flag)) {
return;
}
flags = 0;
for (Flag tmp : Flag.values()) {
if (flag != tmp) {
addFlag(tmp);
}
}
}
/**
* Check if the entity + access type exists, and if so return the rights (-1 if it does not exist)
*
* @param type
* @param name
* @return the access the player has
*/
public int getAccess(int type, String name) {
for (AccessRight right : access) {
if (right.getType() == type && right.getName().equalsIgnoreCase(name)) {
return right.getRights();
}
}
return -1;
}
/**
* @return the list of access rights
*/
public List<AccessRight> getAccessRights() {
return access;
}
/**
* Remove temporary access rights from the protection
*/
public void removeTemporaryAccessRights() {
Iterator<AccessRight> iter = access.iterator();
while (iter.hasNext()) {
AccessRight right = iter.next();
if (right.getType() == AccessRight.TEMPORARY) {
iter.remove();
}
}
}
/**
* Add an access right to the stored list
*
* @param right
*/
public void addAccessRight(AccessRight right) {
if (removed) {
return;
}
access.add(right);
}
public int getFlags() {
return flags;
}
public int getBlockId() {
return blockId;
}
public String getData() {
return data;
}
public String getDate() {
return date;
}
public int getId() {
return id;
}
public String getOwner() {
return owner;
}
public int getType() {
return type;
}
public String getWorld() {
return world;
}
public int getX() {
return x;
}
public int getY() {
return y;
}
public int getZ() {
return z;
}
public long getLastAccessed() {
return lastAccessed;
}
public void setBlockId(int blockId) {
if (removed) {
return;
}
this.blockId = blockId;
}
public void setData(String data) {
if (removed) {
return;
}
this.data = data;
}
public void setDate(String date) {
if (removed) {
return;
}
this.date = date;
}
public void setId(int id) {
if (removed) {
return;
}
this.id = id;
}
public void setFlags(int flags) {
if (removed) {
return;
}
this.flags = flags;
}
public void setOwner(String owner) {
if (removed) {
return;
}
this.owner = owner;
}
public void setType(int type) {
if (removed) {
return;
}
this.type = type;
}
public void setWorld(String world) {
if (removed) {
return;
}
this.world = world;
}
public void setX(int x) {
if (removed) {
return;
}
this.x = x;
}
public void setY(int y) {
if (removed) {
return;
}
this.y = y;
}
public void setZ(int z) {
if (removed) {
return;
}
this.z = z;
}
public void setLastAccessed(long lastAccessed) {
if (removed) {
return;
}
this.lastAccessed = lastAccessed;
}
/**
* Remove the protection from the database
*/
public void remove() {
if (removed) {
return;
}
LWC lwc = LWC.getInstance();
removeTemporaryAccessRights();
removeCache();
// make this protection immutable
removed = true;
// broadcast the removal event
// we broadcast before actually removing to give them a chance to use any data that would be removed otherwise
lwc.getModuleLoader().dispatchEvent(ModuleLoader.Event.POST_REMOVAL, this);
lwc.getModuleLoader().dispatchEvent(new LWCProtectionRemovePostEvent(this));
// and now finally remove it from the database
lwc.getPhysicalDatabase().unregisterProtection(id);
// mark related transactions as inactive
for (History history : getRelatedHistory(History.Type.TRANSACTION)) {
if (history.getStatus() != History.Status.ACTIVE) {
continue;
}
history.setStatus(History.Status.INACTIVE);
history.save();
}
}
/**
* Remove the protection from cache
*/
public void removeCache() {
if (removed) {
return;
}
LWC lwc = LWC.getInstance();
LRUCache<String, Protection> cache = lwc.getCaches().getProtections();
cache.remove(getCacheKey());
/* For Bug 656 workaround we record in-memory any double-chests/etc we find as
* we find them, since we can't count on Bukkit to reliably return that info later.
* As a result, when we are removing a protection (and therefore LWC calls this method
* to remove it's cache object), we need to remove the adjacent block from memory also.
*/
if (lwc.isBug656WorkAround()) {
World worldObject = lwc.getPlugin().getServer().getWorld(world);
List<Block> blocks = lwc.getRelatedBlocks(worldObject, x, y, z);
for (Block b : blocks) {
String cacheKey = b.getWorld().getName() + ":" + b.getX() + ":" + b.getY() + ":" + b.getZ();
cache.remove(cacheKey);
}
}
}
/**
* Updates the protection in the protection cache
* Note that save() and saveNow() call this
*/
public void update() {
if (removed) {
return;
}
CacheSet caches = LWC.getInstance().getCaches();
removeCache();
Protection temp = LWC.getInstance().getPhysicalDatabase().loadProtection(id);
if (temp != null) {
caches.getProtections().put(getCacheKey(), temp);
}
}
/**
* Queue the protection to be saved
*/
public void save() {
if (removed) {
return;
}
LWC.getInstance().getUpdateThread().queueProtectionUpdate(this);
}
/**
* Force a protection update in the live database
*/
public void saveNow() {
if (removed) {
return;
}
LWC.getInstance().getPhysicalDatabase().saveProtection(this);
update();
}
/**
* @return the key used for the protection cache
*/
public String getCacheKey() {
return world + ":" + x + ":" + y + ":" + z;
}
/**
* @return the Bukkit world the protection should be located in
*/
public World getBukkitWorld() {
if (world == null || world.isEmpty()) {
return Bukkit.getServer().getWorlds().get(0);
}
return Bukkit.getServer().getWorld(world);
}
/**
* @return the Bukkit Player object of the owner
*/
public Player getBukkitOwner() {
return Bukkit.getServer().getPlayer(owner);
}
/**
* @return the block representing the protection in the world
*/
public Block getBlock() {
World world = getBukkitWorld();
if (world == null) {
return null;
}
return world.getBlockAt(x, y, z);
}
/**
* @return
*/
@Override
public String toString() {
// format the flags prettily
String flags = "";
for (Flag flag : Flag.values()) {
if (hasFlag(flag)) {
flags += flag.toString() + ",";
}
}
if (flags.endsWith(",")) {
flags = flags.substring(0, flags.length() - 1);
}
// format the last accessed time
String lastAccessed = StringUtils.timeToString((System.currentTimeMillis() / 1000L) - this.lastAccessed);
if (!lastAccessed.equals("Not yet known")) {
lastAccessed += " ago";
}
return String.format("%s %s" + Colors.White + " " + Colors.Green + "Id=%d Owner=%s Location=[%s %d,%d,%d] Created=%s Flags=%s LastAccessed=%s", typeToString(), (blockId > 0 ? (LWC.materialToString(blockId)) : "Not yet cached"), id, owner, world, x, y, z, date, flags, lastAccessed);
}
/**
* @return string representation of the protection type
*/
public String typeToString() {
switch (type) {
case ProtectionTypes.PRIVATE:
return "Private";
case ProtectionTypes.PUBLIC:
return "Public";
case ProtectionTypes.PASSWORD:
return "Password";
case ProtectionTypes.TRAP_KICK:
return "Kick trap";
case ProtectionTypes.TRAP_BAN:
return "Ban trap";
}
return "Unknown(raw:" + type + ")";
}
}