-
Notifications
You must be signed in to change notification settings - Fork 40
/
Permission.cs
1302 lines (1089 loc) · 40.9 KB
/
Permission.cs
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
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
676
677
678
679
680
681
682
683
684
685
686
687
688
689
690
691
692
693
694
695
696
697
698
699
700
701
702
703
704
705
706
707
708
709
710
711
712
713
714
715
716
717
718
719
720
721
722
723
724
725
726
727
728
729
730
731
732
733
734
735
736
737
738
739
740
741
742
743
744
745
746
747
748
749
750
751
752
753
754
755
756
757
758
759
760
761
762
763
764
765
766
767
768
769
770
771
772
773
774
775
776
777
778
779
780
781
782
783
784
785
786
787
788
789
790
791
792
793
794
795
796
797
798
799
800
801
802
803
804
805
806
807
808
809
810
811
812
813
814
815
816
817
818
819
820
821
822
823
824
825
826
827
828
829
830
831
832
833
834
835
836
837
838
839
840
841
842
843
844
845
846
847
848
849
850
851
852
853
854
855
856
857
858
859
860
861
862
863
864
865
866
867
868
869
870
871
872
873
874
875
876
877
878
879
880
881
882
883
884
885
886
887
888
889
890
891
892
893
894
895
896
897
898
899
900
901
902
903
904
905
906
907
908
909
910
911
912
913
914
915
916
917
918
919
920
921
922
923
924
925
926
927
928
929
930
931
932
933
934
935
936
937
938
939
940
941
942
943
944
945
946
947
948
949
950
951
952
953
954
955
956
957
958
959
960
961
962
963
964
965
966
967
968
969
970
971
972
973
974
975
976
977
978
979
980
981
982
983
984
985
986
987
988
989
990
991
992
993
994
995
996
997
998
999
1000
extern alias References;
using Oxide.Core.Plugins;
using References::ProtoBuf;
using System;
using System.Collections.Generic;
using System.Data;
using System.IO;
using System.Linq;
namespace Oxide.Core.Libraries
{
/// <summary>
/// Contains all data for a specified user
/// </summary>
[ProtoContract(ImplicitFields = ImplicitFields.AllFields)]
public class UserData
{
/// <summary>
/// Gets or sets the last seen nickname for this player
/// </summary>
public string LastSeenNickname { get; set; } = "Unnamed";
/// <summary>
/// Gets or sets the individual permissions for this player
/// </summary>
public HashSet<string> Perms { get; set; } = new HashSet<string>(StringComparer.OrdinalIgnoreCase);
/// <summary>
/// Gets or sets the group for this player
/// </summary>
public HashSet<string> Groups { get; set; } = new HashSet<string>(StringComparer.OrdinalIgnoreCase);
}
/// <summary>
/// Contains all data for a specified group
/// </summary>
[ProtoContract(ImplicitFields = ImplicitFields.AllFields)]
public class GroupData
{
/// <summary>
/// Gets or sets the title of this group
/// </summary>
public string Title { get; set; } = string.Empty;
/// <summary>
/// Gets or sets the rank of this group
/// </summary>
public int Rank { get; set; }
/// <summary>
/// Gets or sets the individual permissions for this group
/// </summary>
public HashSet<string> Perms { get; set; } = new HashSet<string>(StringComparer.OrdinalIgnoreCase);
/// <summary>
/// Gets or sets the parent for this group
/// </summary>
public string ParentGroup { get; set; } = string.Empty;
}
/// <summary>
/// A library providing a unified permissions system
/// </summary>
public class Permission : Library
{
/// <summary>
/// Returns if this library should be loaded into the global namespace
/// </summary>
public override bool IsGlobal => false;
// All registered permissions
private readonly Dictionary<Plugin, HashSet<string>> registeredPermissions;
// All users data
private Dictionary<string, UserData> usersData;
// All groups data
private Dictionary<string, GroupData> groupsData;
private Func<string, bool> validate;
// Permission status
public bool IsLoaded { get; private set; }
/// <summary>
/// Initializes a new instance of the Permission library
/// </summary>
public Permission()
{
// Initialize
registeredPermissions = new Dictionary<Plugin, HashSet<string>>();
// Load the datafile
LoadFromDatafile();
}
/// <summary>
/// Loads all permissions data from the datafile
/// </summary>
private void LoadFromDatafile()
{
VerifyAndLoadUsersData();
VerifyAndLoadGroupsData();
bool circularReference = false;
foreach (KeyValuePair<string, GroupData> pair in groupsData)
{
if (string.IsNullOrEmpty(pair.Value.ParentGroup) || !HasCircularParent(pair.Key, pair.Value.ParentGroup))
{
continue;
}
Interface.Oxide.LogWarning("Detected circular parent group for '{0}'; removing parent '{1}'", pair.Key, pair.Value.ParentGroup);
pair.Value.ParentGroup = null;
circularReference = true;
}
if (circularReference)
{
SaveGroups();
}
IsLoaded = true;
}
private void VerifyAndLoadUsersData()
{
Utility.DatafileToProto<Dictionary<string, UserData>>("oxide.users");
Dictionary<string, UserData> storedUserData = ProtoStorage.Load<Dictionary<string, UserData>>("oxide.users") ?? new Dictionary<string, UserData>(StringComparer.OrdinalIgnoreCase);
Dictionary<string, UserData> result = new Dictionary<string, UserData>(StringComparer.OrdinalIgnoreCase);
HashSet<string> groups = new HashSet<string>(StringComparer.OrdinalIgnoreCase);
HashSet<string> permissions = new HashSet<string>(StringComparer.OrdinalIgnoreCase);
bool changed = false;
foreach (KeyValuePair<string, UserData> entry in storedUserData)
{
UserData user = entry.Value;
permissions.Clear();
groups.Clear();
foreach (string perm in user.Perms)
{
permissions.Add(perm);
}
user.Perms = new HashSet<string>(permissions, StringComparer.OrdinalIgnoreCase);
foreach (string group in user.Groups)
{
groups.Add(group);
}
user.Groups = new HashSet<string>(groups, StringComparer.OrdinalIgnoreCase);
if (result.ContainsKey(entry.Key))
{
UserData existing = result[entry.Key];
existing.Perms.UnionWith(user.Perms);
existing.Groups.UnionWith(user.Groups);
changed = true;
continue;
}
result.Add(entry.Key, user);
}
usersData = result;
if (changed)
{
SaveUsers();
}
}
private void VerifyAndLoadGroupsData()
{
Utility.DatafileToProto<Dictionary<string, GroupData>>("oxide.groups");
Dictionary<string, GroupData> storedGroupData = ProtoStorage.Load<Dictionary<string, GroupData>>("oxide.groups") ?? new Dictionary<string, GroupData>(StringComparer.OrdinalIgnoreCase);
Dictionary<string, GroupData> result = new Dictionary<string, GroupData>(StringComparer.OrdinalIgnoreCase);
HashSet<string> permissions = new HashSet<string>(StringComparer.OrdinalIgnoreCase);
bool changed = false;
foreach (KeyValuePair<string, GroupData> entry in storedGroupData)
{
GroupData group = entry.Value;
permissions.Clear();
foreach (string perm in group.Perms)
{
permissions.Add(perm);
}
group.Perms = new HashSet<string>(permissions, StringComparer.OrdinalIgnoreCase);
if (result.ContainsKey(entry.Key))
{
GroupData existing = result[entry.Key];
existing.Perms.UnionWith(group.Perms);
changed = true;
continue;
}
result.Add(entry.Key, group);
}
groupsData = result;
if (changed)
{
SaveGroups();
}
}
private Dictionary<string, GroupData> VerifyGroupData(Dictionary<string, GroupData> data)
{
Dictionary<string, GroupData> result = new Dictionary<string, GroupData>(StringComparer.OrdinalIgnoreCase);
HashSet<string> permissions = new HashSet<string>(StringComparer.OrdinalIgnoreCase);
foreach (KeyValuePair<string, GroupData> entry in data)
{
GroupData group = entry.Value;
permissions.Clear();
foreach (string perm in group.Perms)
{
permissions.Add(perm);
}
group.Perms = new HashSet<string>(permissions, StringComparer.OrdinalIgnoreCase);
if (result.ContainsKey(entry.Key))
{
GroupData existing = result[entry.Key];
// Get a matching entry.key from result.keys
var existingKey = result.Keys.FirstOrDefault(x => x.Equals(entry.Key, StringComparison.OrdinalIgnoreCase));
existing.Perms.UnionWith(group.Perms);
Interface.Oxide.LogWarning("Duplicate group '{0}' found, merged entries with {1}", entry.Key, existingKey);
continue;
}
result.Add(entry.Key, group);
}
return result;
}
/// <summary>
/// Exports user/group data to json
/// </summary>
[LibraryFunction("Export")]
public void Export(string prefix = "auth")
{
if (IsLoaded)
{
Interface.Oxide.DataFileSystem.WriteObject(prefix + ".groups", groupsData);
Interface.Oxide.DataFileSystem.WriteObject(prefix + ".users", usersData);
}
}
/// <summary>
/// Saves all permissions data to the data files
/// </summary>
public void SaveData()
{
SaveUsers();
SaveGroups();
}
/// <summary>
/// Saves users permissions data to the data file
/// </summary>
public void SaveUsers() => ProtoStorage.Save(usersData, "oxide.users");
/// <summary>
/// Saves groups permissions data to the data file
/// </summary>
public void SaveGroups() => ProtoStorage.Save(groupsData, "oxide.groups");
/// <summary>
/// Register user ID validation
/// </summary>
/// <param name="val"></param>
public void RegisterValidate(Func<string, bool> val) => validate = val;
/// <summary>
/// Clean invalid user ID entries
/// </summary>
public void CleanUp()
{
if (IsLoaded && validate != null)
{
string[] invalidData = usersData.Keys.Where(i => !validate(i)).ToArray();
if (invalidData.Length <= 0)
{
return;
}
foreach (string i in invalidData)
{
usersData.Remove(i);
}
}
}
/// <summary>
/// Migrate permissions from one group to another
/// </summary>
public void MigrateGroup(string oldGroupName, string newGroupName)
{
if (IsLoaded && GroupExists(oldGroupName))
{
string groups = ProtoStorage.GetFileDataPath("oxide.groups.data");
File.Copy(groups, groups + ".old", true);
foreach (string permission in GetGroupPermissions(oldGroupName))
{
GrantGroupPermission(newGroupName, permission, null);
}
if (GetUsersInGroup(oldGroupName).Length == 0)
{
RemoveGroup(oldGroupName);
}
}
}
#region Permission Management
/// <summary>
/// Registers the specified permission
/// </summary>
/// <param name="permission"></param>
/// <param name="owner"></param>
[LibraryFunction("RegisterPermission")]
public void RegisterPermission(string permission, Plugin owner)
{
if (string.IsNullOrEmpty(permission))
{
return;
}
if (PermissionExists(permission))
{
Interface.Oxide.LogWarning("Duplicate permission registered '{0}' (by plugin '{1}')", permission, owner.Title);
return;
}
if (!registeredPermissions.TryGetValue(owner, out HashSet<string> set))
{
set = new HashSet<string>(StringComparer.OrdinalIgnoreCase);
registeredPermissions.Add(owner, set);
owner.OnRemovedFromManager.Add(owner_OnRemovedFromManager);
}
set.Add(permission);
Interface.CallHook("OnPermissionRegistered", permission, owner);
if (!permission.StartsWith($"{owner.Name}.", StringComparison.OrdinalIgnoreCase) && !owner.IsCorePlugin)
{
Interface.Oxide.LogWarning("Missing plugin name prefix '{0}' for permission '{1}' (by plugin '{2}')", owner.Name.ToLower(), permission, owner.Title);
}
}
/// <summary>
/// Returns if the specified permission exists or not
/// </summary>
/// <param name="permission"></param>
/// <param name="owner"></param>
/// <returns></returns>
[LibraryFunction("PermissionExists")]
public bool PermissionExists(string permission, Plugin owner = null)
{
if (string.IsNullOrEmpty(permission))
{
return false;
}
if (owner == null)
{
if (registeredPermissions.Count > 0)
{
if (permission.Equals("*"))
{
return true;
}
if (permission.EndsWith("*"))
{
return registeredPermissions.Values.SelectMany(v => v).Any(p => p.StartsWith(permission.TrimEnd('*'), StringComparison.OrdinalIgnoreCase));
}
}
return registeredPermissions.Values.Any(v => v.Contains(permission, StringComparer.OrdinalIgnoreCase));
}
if (!registeredPermissions.TryGetValue(owner, out HashSet<string> set))
{
return false;
}
if (set.Count > 0)
{
if (permission.Equals("*"))
{
return true;
}
if (permission.EndsWith("*"))
{
return set.Any(p => p.StartsWith(permission.TrimEnd('*'), StringComparison.OrdinalIgnoreCase));
}
}
return set.Contains(permission, StringComparer.OrdinalIgnoreCase);
}
#endregion Permission Management
/// <summary>
/// Called when a plugin has been unloaded
/// </summary>
/// <param name="sender"></param>
/// <param name="manager"></param>
private void owner_OnRemovedFromManager(Plugin sender, PluginManager manager) => registeredPermissions.Remove(sender);
#region Querying
/// <summary>
/// Returns if the specified user id is valid
/// </summary>
/// <param name="playerId"></param>
/// <returns></returns>
[LibraryFunction("UserIdValid")]
public bool UserIdValid(string playerId) => validate == null || validate(playerId);
/// <summary>
/// Returns if the specified user exists
/// </summary>
/// <param name="playerId"></param>
/// <returns></returns>
[LibraryFunction("UserExists")]
public bool UserExists(string playerId) => usersData.ContainsKey(playerId);
/// <summary>
/// Returns the data for the specified user
/// </summary>
/// <param name="playerId"></param>
/// <returns></returns>
public UserData GetUserData(string playerId)
{
if (!usersData.TryGetValue(playerId, out UserData userData))
{
usersData.Add(playerId, userData = new UserData());
}
// Return the data
return userData;
}
/// <summary>
/// Updates the nickname
/// </summary>
/// <param name="playerId"></param>
/// <param name="playerName"></param>
[LibraryFunction("UpdateNickname")]
public void UpdateNickname(string playerId, string playerName)
{
if (UserExists(playerId))
{
UserData userData = GetUserData(playerId);
string oldName = userData.LastSeenNickname;
string newName = playerName.Sanitize();
userData.LastSeenNickname = playerName.Sanitize();
Interface.CallHook("OnUserNameUpdated", playerId, oldName, newName);
}
}
/// <summary>
/// Check if user has a group
/// </summary>
/// <param name="playerId"></param>
[LibraryFunction("UserHasAnyGroup")]
public bool UserHasAnyGroup(string playerId) => UserExists(playerId) && GetUserData(playerId).Groups.Count > 0;
/// <summary>
/// Returns if the specified group has the specified permission or not
/// </summary>
/// <param name="groupNames"></param>
/// <param name="permission"></param>
/// <returns></returns>
[LibraryFunction("GroupsHavePermission")]
public bool GroupsHavePermission(HashSet<string> groupNames, string permission) => groupNames.Any(g => GroupHasPermission(g, permission));
/// <summary>
/// Returns if the specified group has the specified permission or not
/// </summary>
/// <param name="groupName"></param>
/// <param name="permission"></param>
/// <returns></returns>
[LibraryFunction("GroupHasPermission")]
public bool GroupHasPermission(string groupName, string permission)
{
if (!GroupExists(groupName) || string.IsNullOrEmpty(permission))
{
return false;
}
// Check if the group has the permission
if (!groupsData.TryGetValue(groupName, out GroupData groupData))
{
return false;
}
return groupData.Perms.Contains(permission, StringComparer.OrdinalIgnoreCase) || GroupHasPermission(groupData.ParentGroup, permission);
}
/// <summary>
/// Returns if the specified user has the specified permission
/// </summary>
/// <param name="playerId"></param>
/// <param name="permission"></param>
/// <returns></returns>
[LibraryFunction("UserHasPermission")]
public bool UserHasPermission(string playerId, string permission)
{
if (string.IsNullOrEmpty(permission))
{
return false;
}
// Always allow the server console
if (playerId.Equals("server_console"))
{
return true;
}
// First, get the player data
UserData userData = GetUserData(playerId);
// Check if they have the permission
if (userData.Perms.Contains(permission, StringComparer.OrdinalIgnoreCase))
{
return true;
}
// Check if their group has the permission
return GroupsHavePermission(userData.Groups, permission);
}
/// <summary>
/// Returns the group to which the specified user belongs
/// </summary>
/// <param name="playerId"></param>
/// <returns></returns>
[LibraryFunction("GetUserGroups")]
public string[] GetUserGroups(string playerId) => GetUserData(playerId).Groups.ToArray();
/// <summary>
/// Returns the permissions which the specified user has
/// </summary>
/// <param name="playerId"></param>
/// <returns></returns>
[LibraryFunction("GetUserPermissions")]
public string[] GetUserPermissions(string playerId)
{
UserData userData = GetUserData(playerId);
HashSet<string> permissions = new HashSet<string>(userData.Perms, StringComparer.OrdinalIgnoreCase);
foreach (string groupName in userData.Groups)
{
permissions.UnionWith(GetGroupPermissions(groupName));
}
return permissions.ToArray();
}
/// <summary>
/// Returns the permissions which the specified group has, with optional transversing of parent groups
/// </summary>
/// <param name="groupName"></param>
/// <param name="parents"></param>
/// <returns></returns>
[LibraryFunction("GetGroupPermissions")]
public string[] GetGroupPermissions(string groupName, bool parents = false)
{
if (!GroupExists(groupName))
{
return new string[0];
}
if (!groupsData.TryGetValue(groupName, out GroupData groupData))
{
return new string[0];
}
HashSet<string> permissions = new HashSet<string>(groupData.Perms);
if (parents)
{
permissions.UnionWith(GetGroupPermissions(groupData.ParentGroup));
}
return permissions.ToArray();
}
/// <summary>
/// Returns the permissions which are registered
/// </summary>
/// <returns></returns>
[LibraryFunction("GetPermissions")]
public string[] GetPermissions() => new HashSet<string>(registeredPermissions.Values.SelectMany(v => v)).ToArray();
/// <summary>
/// Returns the players with given permission
/// </summary>
/// <param name="permission"></param>
/// <returns></returns>
[LibraryFunction("GetPermissionUsers")]
public string[] GetPermissionUsers(string permission)
{
if (string.IsNullOrEmpty(permission))
{
return new string[0];
}
HashSet<string> permissionUsers = new HashSet<string>();
foreach (KeyValuePair<string, UserData> data in usersData)
{
if (data.Value.Perms.Contains(permission, StringComparer.OrdinalIgnoreCase))
{
permissionUsers.Add($"{data.Key}({data.Value.LastSeenNickname})");
}
}
return permissionUsers.ToArray();
}
/// <summary>
/// Returns the groups with given permission
/// </summary>
/// <param name="permission"></param>
/// <returns></returns>
[LibraryFunction("GetPermissionGroups")]
public string[] GetPermissionGroups(string permission)
{
if (string.IsNullOrEmpty(permission))
{
return new string[0];
}
HashSet<string> permissionGroups = new HashSet<string>();
foreach (KeyValuePair<string, GroupData> data in groupsData)
{
if (data.Value.Perms.Contains(permission, StringComparer.OrdinalIgnoreCase))
{
permissionGroups.Add(data.Key);
}
}
return permissionGroups.ToArray();
}
/// <summary>
/// Set the group to which the specified user belongs
/// </summary>
/// <param name="playerId"></param>
/// <param name="groupName"></param>
/// <returns></returns>
[LibraryFunction("AddUserGroup")]
public void AddUserGroup(string playerId, string groupName)
{
if (!GroupExists(groupName))
{
return;
}
UserData userData = GetUserData(playerId);
if (!userData.Groups.Add(groupName))
{
return;
}
// Call hook for plugins
Interface.Call("OnUserGroupAdded", playerId, groupName);
}
/// <summary>
/// Set the group to which the specified user belongs
/// </summary>
/// <param name="playerId"></param>
/// <param name="groupName"></param>
/// <returns></returns>
[LibraryFunction("RemoveUserGroup")]
public void RemoveUserGroup(string playerId, string groupName)
{
if (!GroupExists(groupName))
{
return;
}
UserData userData = GetUserData(playerId);
if (groupName.Equals("*"))
{
if (userData.Groups.Count <= 0)
{
return;
}
userData.Groups.Clear();
return;
}
if (!userData.Groups.Remove(groupName))
{
return;
}
// Call hook for plugins
Interface.Call("OnUserGroupRemoved", playerId, groupName);
}
/// <summary>
/// Get if the player belongs to given group
/// </summary>
/// <param name="playerId"></param>
/// <param name="groupName"></param>
/// <returns></returns>
[LibraryFunction("UserHasGroup")]
public bool UserHasGroup(string playerId, string groupName)
{
if (!GroupExists(groupName))
{
return false;
}
return GetUserData(playerId).Groups.Contains(groupName, StringComparer.OrdinalIgnoreCase);
}
/// <summary>
/// Returns if the specified group exists or not
/// </summary>
/// <param name="groupName"></param>
/// <returns></returns>
[LibraryFunction("GroupExists")]
public bool GroupExists(string groupName)
{
return !string.IsNullOrEmpty(groupName) && (groupName.Equals("*") || groupsData.ContainsKey(groupName));
}
/// <summary>
/// Returns the data for the specified group
/// </summary>
/// <param name="groupName"></param>
/// <returns></returns>
public GroupData GetGroupData(string groupName)
{
if (!groupsData.TryGetValue(groupName, out GroupData groupData))
{
return null;
}
// Return the data
return groupData;
}
/// <summary>
/// Returns existing groups
/// </summary>
/// <returns></returns>
[LibraryFunction("GetGroups")]
public string[] GetGroups() => groupsData.Keys.ToArray();
/// <summary>
/// Returns users in that group
/// </summary>
/// <param name="groupName"></param>
/// <returns></returns>
[LibraryFunction("GetUsersInGroup")]
public string[] GetUsersInGroup(string groupName)
{
if (!GroupExists(groupName))
{
return new string[0];
}
return usersData.Where(u => u.Value.Groups.Contains(groupName, StringComparer.OrdinalIgnoreCase)).Select(u => $"{u.Key} ({u.Value.LastSeenNickname})").ToArray();
}
/// <summary>
/// Returns the title of the specified group
/// </summary>
/// <param name="groupName"></param>
[LibraryFunction("GetGroupTitle")]
public string GetGroupTitle(string groupName)
{
if (!GroupExists(groupName))
{
return string.Empty;
}
// First, get the group data
if (!groupsData.TryGetValue(groupName, out GroupData groupData))
{
return string.Empty;
}
// Return the group title
return groupData.Title;
}
/// <summary>
/// Returns the rank of the specified group
/// </summary>
/// <param name="groupName"></param>
/// <returns></returns>
[LibraryFunction("GetGroupRank")]
public int GetGroupRank(string groupName)
{
if (!GroupExists(groupName))
{
return 0;
}
// First, get the group data
if (!groupsData.TryGetValue(groupName, out GroupData groupData))
{
return 0;
}
// Return the group rank
return groupData.Rank;
}
#endregion Querying
#region User Permission
/// <summary>
/// Grants the specified permission to the specified user
/// </summary>
/// <param name="playerId"></param>
/// <param name="permission"></param>
/// <param name="owner"></param>
[LibraryFunction("GrantUserPermission")]
public void GrantUserPermission(string playerId, string permission, Plugin owner)
{
// Check it is even a permission
if (!PermissionExists(permission, owner))
{
return;
}
// Get the player data
UserData userData = GetUserData(playerId);
if (permission.EndsWith("*"))
{
HashSet<string> permissions;
if (owner == null)
{
permissions = new HashSet<string>(registeredPermissions.Values.SelectMany(v => v));
}
else if (!registeredPermissions.TryGetValue(owner, out permissions))
{
return;
}
if (permission.Equals("*"))
{
if (!permissions.Aggregate(false, (c, s) => c | userData.Perms.Add(s)))
{
return;
}
}
else
{
if (!permissions.Where(p => p.StartsWith(permission.TrimEnd('*'), StringComparison.OrdinalIgnoreCase)).Aggregate(false, (c, s) => c | userData.Perms.Add(s)))
{
return;
}
}
return;
}
// Add the permission
if (!userData.Perms.Add(permission))
{
return;
}
// Call hook for plugins
Interface.Call("OnUserPermissionGranted", playerId, permission);
}
/// <summary>
/// Revokes the specified permission from the specified user
/// </summary>
/// <param name="playerId"></param>
/// <param name="permission"></param>
[LibraryFunction("RevokeUserPermission")]
public void RevokeUserPermission(string playerId, string permission)
{
if (string.IsNullOrEmpty(permission))
{
return;
}
// Get the player data
UserData userData = GetUserData(playerId);
if (permission.EndsWith("*"))
{
if (permission.Equals("*"))
{
if (userData.Perms.Count <= 0)
{
return;
}
userData.Perms.Clear();
}
else
{
if (userData.Perms.RemoveWhere(p => p.StartsWith(permission.TrimEnd('*'), StringComparison.OrdinalIgnoreCase)) <= 0)
{
return;
}
}
return;
}
// Remove the permission
if (!userData.Perms.Remove(permission))
{
return;
}
// Call hook for plugins
Interface.Call("OnUserPermissionRevoked", playerId, permission);
}
#endregion User Permission
#region Group Permission
/// <summary>
/// Grant the specified permission to the specified group
/// </summary>
/// <param name="groupName"></param>
/// <param name="permission"></param>
/// <param name="owner"></param>
[LibraryFunction("GrantGroupPermission")]
public void GrantGroupPermission(string groupName, string permission, Plugin owner)
{
// Check it is even a permission
if (!PermissionExists(permission, owner) || !GroupExists(groupName))
{
return;
}
// Get the group data
if (!groupsData.TryGetValue(groupName, out GroupData groupData))
{
return;
}
if (permission.EndsWith("*"))
{
HashSet<string> permissions;
if (owner == null)
{
permissions = new HashSet<string>(registeredPermissions.Values.SelectMany(v => v));
}
else if (!registeredPermissions.TryGetValue(owner, out permissions))
{
return;
}
if (permission.Equals("*"))
{
if (!permissions.Aggregate(false, (c, s) => c | groupData.Perms.Add(s)))
{
return;