actor-manager.js
25 KB
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
/// <reference path="lodash-3.10.d.ts" />
/// <reference path="knockout.d.ts" />
/// <reference path="common.d.ts" />
class AmeBaseActor {
constructor(id, displayName, capabilities, metaCapabilities = {}) {
this.displayName = '[Error: No displayName set]';
this.groupActors = [];
this.id = id;
this.displayName = displayName;
this.capabilities = capabilities;
this.metaCapabilities = metaCapabilities;
}
/**
* Get the capability setting directly from this actor, ignoring capabilities
* granted by roles, the Super Admin flag, or the grantedCapabilities feature.
*
* Returns NULL for capabilities that are neither explicitly granted nor denied.
*
* @param {string} capability
* @returns {boolean|null}
*/
hasOwnCap(capability) {
if (this.capabilities.hasOwnProperty(capability)) {
return this.capabilities[capability];
}
if (this.metaCapabilities.hasOwnProperty(capability)) {
return this.metaCapabilities[capability];
}
return null;
}
static getActorSpecificity(actorId) {
let actorType = actorId.substring(0, actorId.indexOf(':')), specificity;
switch (actorType) {
case 'role':
specificity = 1;
break;
case 'special':
specificity = 2;
break;
case 'user':
specificity = 10;
break;
default:
specificity = 0;
}
return specificity;
}
toString() {
return this.displayName + ' [' + this.id + ']';
}
getId() {
return this.id;
}
getDisplayName() {
return this.displayName;
}
}
class AmeRole extends AmeBaseActor {
constructor(roleId, displayName, capabilities, metaCapabilities = {}) {
super('role:' + roleId, displayName, capabilities, metaCapabilities);
this.name = roleId;
}
hasOwnCap(capability) {
//In WordPress, a role name is also a capability name. Users that have the role "foo" always
//have the "foo" capability. It's debatable whether the role itself actually has that capability
//(WP_Role says no), but it's convenient to treat it that way.
if (capability === this.name) {
return true;
}
return super.hasOwnCap(capability);
}
}
class AmeUser extends AmeBaseActor {
constructor(userLogin, displayName, capabilities, roles, isSuperAdmin = false, userId, metaCapabilities = {}) {
super('user:' + userLogin, displayName, capabilities, metaCapabilities);
this.userId = 0;
this.isSuperAdmin = false;
this.avatarHTML = '';
this.userLogin = userLogin;
this.roles = roles;
this.isSuperAdmin = isSuperAdmin;
this.userId = userId || 0;
if (this.isSuperAdmin) {
this.groupActors.push(AmeSuperAdmin.permanentActorId);
}
for (let i = 0; i < this.roles.length; i++) {
this.groupActors.push('role:' + this.roles[i]);
}
}
static createFromProperties(properties) {
let user = new AmeUser(properties.user_login, properties.display_name, properties.capabilities, properties.roles, properties.is_super_admin, properties.hasOwnProperty('id') ? properties.id : null, properties.meta_capabilities);
if (properties.avatar_html) {
user.avatarHTML = properties.avatar_html;
}
return user;
}
}
class AmeSuperAdmin extends AmeBaseActor {
constructor() {
super(AmeSuperAdmin.permanentActorId, 'Super Admin', {});
}
hasOwnCap(capability) {
//The Super Admin has all possible capabilities except the special "do_not_allow" flag.
return (capability !== 'do_not_allow');
}
}
AmeSuperAdmin.permanentActorId = 'special:super_admin';
class AmeActorManager {
constructor(roles, users, isMultisite = false, suspectedMetaCaps = {}) {
this.roles = {};
this.users = {};
this.grantedCapabilities = {};
this.isMultisite = false;
this.exclusiveSuperAdminCapabilities = {};
this.tagMetaCaps = {};
this.suggestedCapabilities = [];
this.isMultisite = !!isMultisite;
AmeActorManager._.forEach(roles, (roleDetails, id) => {
const role = new AmeRole(id, roleDetails.name, roleDetails.capabilities, AmeActorManager._.get(roleDetails, 'meta_capabilities', {}));
this.roles[role.name] = role;
});
AmeActorManager._.forEach(users, (userDetails) => {
const user = AmeUser.createFromProperties(userDetails);
this.users[user.userLogin] = user;
});
this.superAdmin = new AmeSuperAdmin();
this.suspectedMetaCaps = suspectedMetaCaps;
const exclusiveCaps = [
'update_core', 'update_plugins', 'delete_plugins', 'install_plugins', 'upload_plugins', 'update_themes',
'delete_themes', 'install_themes', 'upload_themes', 'update_core', 'edit_css', 'unfiltered_html',
'edit_files', 'edit_plugins', 'edit_themes', 'delete_user', 'delete_users'
];
for (let i = 0; i < exclusiveCaps.length; i++) {
this.exclusiveSuperAdminCapabilities[exclusiveCaps[i]] = true;
}
const tagMetaCaps = [
'manage_post_tags', 'edit_categories', 'edit_post_tags', 'delete_categories',
'delete_post_tags'
];
for (let i = 0; i < tagMetaCaps.length; i++) {
this.tagMetaCaps[tagMetaCaps[i]] = true;
}
}
// noinspection JSUnusedGlobalSymbols
actorCanAccess(actorId, grantAccess, defaultCapability = null) {
if (grantAccess.hasOwnProperty(actorId)) {
return grantAccess[actorId];
}
if (defaultCapability !== null) {
return this.hasCap(actorId, defaultCapability, grantAccess);
}
return true;
}
getActor(actorId) {
if (actorId === AmeSuperAdmin.permanentActorId) {
return this.superAdmin;
}
const separator = actorId.indexOf(':'), actorType = actorId.substring(0, separator), actorKey = actorId.substring(separator + 1);
if (actorType === 'role') {
return this.roles.hasOwnProperty(actorKey) ? this.roles[actorKey] : null;
}
else if (actorType === 'user') {
return this.users.hasOwnProperty(actorKey) ? this.users[actorKey] : null;
}
throw {
name: 'InvalidActorException',
message: "There is no actor with that ID, or the ID is invalid.",
value: actorId
};
}
actorExists(actorId) {
try {
return (this.getActor(actorId) !== null);
}
catch (exception) {
if (exception.hasOwnProperty('name') && (exception.name === 'InvalidActorException')) {
return false;
}
else {
throw exception;
}
}
}
hasCap(actorId, capability, context) {
context = context || {};
return this.actorHasCap(actorId, capability, [context, this.grantedCapabilities]);
}
hasCapByDefault(actorId, capability) {
return this.actorHasCap(actorId, capability);
}
actorHasCap(actorId, capability, contextList) {
//It's like the chain-of-responsibility pattern.
//Everybody has the "exist" cap and it can't be removed or overridden by plugins.
if (capability === 'exist') {
return true;
}
capability = this.mapMetaCap(capability);
let result = null;
//Step #1: Check temporary context - unsaved caps, etc. Optional.
//Step #2: Check granted capabilities. Default on, but can be skipped.
if (contextList) {
//Check for explicit settings first.
let actorValue, len = contextList.length;
for (let i = 0; i < len; i++) {
if (contextList[i].hasOwnProperty(actorId)) {
actorValue = contextList[i][actorId];
if (typeof actorValue === 'boolean') {
//Context: grant_access[actorId] = boolean. Necessary because enabling a menu item for a role
//should also enable it for all users who have that role (unless explicitly disabled for a user).
return actorValue;
}
else if (actorValue.hasOwnProperty(capability)) {
//Context: grantedCapabilities[actor][capability] = boolean|[boolean, ...]
result = actorValue[capability];
return (typeof result === 'boolean') ? result : result[0];
}
}
}
}
//Step #3: Check owned/default capabilities. Always checked.
let actor = this.getActor(actorId);
if (actor === null) {
return false;
}
let hasOwnCap = actor.hasOwnCap(capability);
if (hasOwnCap !== null) {
return hasOwnCap;
}
//Step #4: Users can get a capability through their roles or the "super admin" flag.
//Only users can have inherited capabilities, so if this actor is not a user, we're done.
if (actor instanceof AmeUser) {
//Note that Super Admin has priority. If the user is a super admin, their roles are ignored.
if (actor.isSuperAdmin) {
return this.actorHasCap('special:super_admin', capability, contextList);
}
//Check if any of the user's roles have the capability.
result = null;
for (let index = 0; index < actor.roles.length; index++) {
let roleHasCap = this.actorHasCap('role:' + actor.roles[index], capability, contextList);
if (roleHasCap !== null) {
result = result || roleHasCap;
}
}
if (result !== null) {
return result;
}
}
if (this.suspectedMetaCaps.hasOwnProperty(capability)) {
return null;
}
return false;
}
mapMetaCap(capability) {
if (capability === 'customize') {
return 'edit_theme_options';
}
else if (capability === 'delete_site') {
return 'manage_options';
}
//In Multisite, some capabilities are only available to Super Admins.
if (this.isMultisite && this.exclusiveSuperAdminCapabilities.hasOwnProperty(capability)) {
return AmeSuperAdmin.permanentActorId;
}
if (this.tagMetaCaps.hasOwnProperty(capability)) {
return 'manage_categories';
}
if ((capability === 'assign_categories') || (capability === 'assign_post_tags')) {
return 'edit_posts';
}
return capability;
}
/* -------------------------------
* Roles
* ------------------------------- */
getRoles() {
return this.roles;
}
roleExists(roleId) {
return this.roles.hasOwnProperty(roleId);
}
;
getSuperAdmin() {
return this.superAdmin;
}
/* -------------------------------
* Users
* ------------------------------- */
getUsers() {
return this.users;
}
getUser(login) {
return this.users.hasOwnProperty(login) ? this.users[login] : null;
}
addUsers(newUsers) {
AmeActorManager._.forEach(newUsers, (user) => {
this.users[user.userLogin] = user;
});
}
getGroupActorsFor(userLogin) {
return this.users[userLogin].groupActors;
}
/* -------------------------------
* Granted capability manipulation
* ------------------------------- */
setGrantedCapabilities(newGrants) {
this.grantedCapabilities = AmeActorManager._.cloneDeep(newGrants);
}
getGrantedCapabilities() {
return this.grantedCapabilities;
}
/**
* Grant or deny a capability to an actor.
*/
setCap(actor, capability, hasCap, sourceType, sourceName) {
this.setCapInContext(this.grantedCapabilities, actor, capability, hasCap, sourceType, sourceName);
}
setCapInContext(context, actor, capability, hasCap, sourceType, sourceName) {
capability = this.mapMetaCap(capability);
const grant = sourceType ? [hasCap, sourceType, sourceName || null] : hasCap;
AmeActorManager._.set(context, [actor, capability], grant);
}
resetCapInContext(context, actor, capability) {
capability = this.mapMetaCap(capability);
if (AmeActorManager._.has(context, [actor, capability])) {
delete context[actor][capability];
}
}
/**
* Reset all capabilities granted to an actor.
* @param actor
* @return boolean TRUE if anything was reset or FALSE if the actor didn't have any granted capabilities.
*/
resetActorCaps(actor) {
if (AmeActorManager._.has(this.grantedCapabilities, actor)) {
delete this.grantedCapabilities[actor];
return true;
}
return false;
}
/**
* Remove redundant granted capabilities.
*
* For example, if user "jane" has been granted the "edit_posts" capability both directly and via the Editor role,
* the direct grant is redundant. We can remove it. Jane will still have "edit_posts" because she's an editor.
*/
pruneGrantedUserCapabilities() {
let _ = AmeActorManager._, pruned = _.cloneDeep(this.grantedCapabilities), context = [pruned];
let actorKeys = _(pruned).keys().filter((actorId) => {
//Skip users that are not loaded.
const actor = this.getActor(actorId);
if (actor === null) {
return false;
}
return (actor instanceof AmeUser);
}).value();
_.forEach(actorKeys, (actor) => {
_.forEach(_.keys(pruned[actor]), (capability) => {
const grant = pruned[actor][capability];
delete pruned[actor][capability];
const hasCap = _.isArray(grant) ? grant[0] : grant, hasCapWhenPruned = !!this.actorHasCap(actor, capability, context);
if (hasCap !== hasCapWhenPruned) {
pruned[actor][capability] = grant; //Restore.
}
});
});
this.setGrantedCapabilities(pruned);
return pruned;
}
;
/**
* Compare the specificity of two actors.
*
* Returns 1 if the first actor is more specific than the second, 0 if they're both
* equally specific, and -1 if the second actor is more specific.
*
* @return {Number}
*/
static compareActorSpecificity(actor1, actor2) {
let delta = AmeBaseActor.getActorSpecificity(actor1) - AmeBaseActor.getActorSpecificity(actor2);
if (delta !== 0) {
delta = (delta > 0) ? 1 : -1;
}
return delta;
}
;
generateCapabilitySuggestions(capPower) {
let _ = AmeActorManager._;
let capsByPower = _.memoize((role) => {
let sortedCaps = _.reduce(role.capabilities, (result, hasCap, capability) => {
if (hasCap) {
result.push({
capability: capability,
power: _.get(capPower, [capability], 0)
});
}
return result;
}, []);
sortedCaps = _.sortBy(sortedCaps, (item) => -item.power);
return sortedCaps;
});
let rolesByPower = _.values(this.getRoles()).sort(function (a, b) {
let aCaps = capsByPower(a), bCaps = capsByPower(b);
//Prioritise roles with the highest number of the most powerful capabilities.
let i = 0, limit = Math.min(aCaps.length, bCaps.length);
for (; i < limit; i++) {
let delta = bCaps[i].power - aCaps[i].power;
if (delta !== 0) {
return delta;
}
}
//Give a tie to the role that has more capabilities.
let delta = bCaps.length - aCaps.length;
if (delta !== 0) {
return delta;
}
//Failing that, just sort alphabetically.
if (a.displayName > b.displayName) {
return 1;
}
else if (a.displayName < b.displayName) {
return -1;
}
return 0;
});
let preferredCaps = [
'manage_network_options',
'install_plugins', 'edit_plugins', 'delete_users',
'manage_options', 'switch_themes',
'edit_others_pages', 'edit_others_posts', 'edit_pages',
'unfiltered_html',
'publish_posts', 'edit_posts',
'read'
];
let deprecatedCaps = _(_.range(0, 10)).map((level) => 'level_' + level).value();
deprecatedCaps.push('edit_files');
let findDiscriminant = (caps, includeRoles, excludeRoles) => {
let getEnabledCaps = (role) => {
return _.keys(_.pick(role.capabilities, _.identity));
};
//Find caps that all of the includeRoles have and excludeRoles don't.
let includeCaps = _.intersection.apply(_, _.map(includeRoles, getEnabledCaps)), excludeCaps = _.union.apply(_, _.map(excludeRoles, getEnabledCaps)), possibleCaps = _.without.apply(_, [includeCaps].concat(excludeCaps).concat(deprecatedCaps));
let bestCaps = _.intersection(preferredCaps, possibleCaps);
if (bestCaps.length > 0) {
return bestCaps[0];
}
else if (possibleCaps.length > 0) {
return possibleCaps[0];
}
return null;
};
let suggestedCapabilities = [];
for (let i = 0; i < rolesByPower.length; i++) {
let role = rolesByPower[i];
let cap = findDiscriminant(preferredCaps, _.slice(rolesByPower, 0, i + 1), _.slice(rolesByPower, i + 1, rolesByPower.length));
suggestedCapabilities.push({ role: role, capability: cap });
}
let previousSuggestion = null;
for (let i = suggestedCapabilities.length - 1; i >= 0; i--) {
if (suggestedCapabilities[i].capability === null) {
suggestedCapabilities[i].capability =
previousSuggestion ? previousSuggestion : 'exist';
}
else {
previousSuggestion = suggestedCapabilities[i].capability;
}
}
this.suggestedCapabilities = suggestedCapabilities;
}
getSuggestedCapabilities() {
return this.suggestedCapabilities;
}
createUserFromProperties(properties) {
return AmeUser.createFromProperties(properties);
}
}
AmeActorManager._ = wsAmeLodash;
class AmeObservableActorSettings {
constructor(initialData) {
this.items = {};
this.numberOfObservables = ko.observable(0);
if (initialData) {
this.setAll(initialData);
}
}
get(actor, defaultValue = null) {
if (this.items.hasOwnProperty(actor)) {
let value = this.items[actor]();
if (value === null) {
return defaultValue;
}
return value;
}
this.numberOfObservables(); //Establish a dependency.
return defaultValue;
}
set(actor, value) {
if (!this.items.hasOwnProperty(actor)) {
this.items[actor] = ko.observable(value);
this.numberOfObservables(this.numberOfObservables() + 1);
}
else {
this.items[actor](value);
}
}
getAll() {
let result = {};
for (let actorId in this.items) {
if (this.items.hasOwnProperty(actorId)) {
let value = this.items[actorId]();
if (value !== null) {
result[actorId] = value;
}
}
}
return result;
}
setAll(values) {
for (let actorId in values) {
if (values.hasOwnProperty(actorId)) {
this.set(actorId, values[actorId]);
}
}
}
/**
* Reset all values to null.
*/
resetAll() {
for (let actorId in this.items) {
if (this.items.hasOwnProperty(actorId)) {
this.items[actorId](null);
}
}
}
isEnabledFor(selectedActor, allActors = null, roleDefault = false, superAdminDefault = null, noValueDefault = false, outIsIndeterminate = null) {
if ((selectedActor === null) && (allActors === null)) {
throw 'When the selected actor is NULL, you must provide ' +
'a list of all visible actors to determine if the item is enabled for all/any of them';
}
if (selectedActor === null) {
//All: Enabled only if it's enabled for all actors.
//Handle the theoretically impossible case where the actor list is empty.
const actorCount = allActors.length;
if (actorCount <= 0) {
return noValueDefault;
}
let isEnabledForSome = false, isDisabledForSome = false;
for (let index = 0; index < actorCount; index++) {
if (this.isEnabledFor(allActors[index], allActors, roleDefault, superAdminDefault, noValueDefault)) {
isEnabledForSome = true;
}
else {
isDisabledForSome = true;
}
}
if (outIsIndeterminate !== null) {
outIsIndeterminate(isEnabledForSome && isDisabledForSome);
}
return isEnabledForSome && (!isDisabledForSome);
}
//Is there an explicit setting for this actor?
let ownSetting = this.get(selectedActor.getId(), null);
if (ownSetting !== null) {
return ownSetting;
}
if (selectedActor instanceof AmeUser) {
//The "Super Admin" setting takes precedence over regular roles.
if (selectedActor.isSuperAdmin) {
let superAdminSetting = this.get(AmeSuperAdmin.permanentActorId, superAdminDefault);
if (superAdminSetting !== null) {
return superAdminSetting;
}
}
//Use role settings.
//Enabled for at least one role = enabled.
//Disabled for at least one role and no settings for other roles = disabled.
let isEnabled = null;
for (let i = 0; i < selectedActor.roles.length; i++) {
let roleSetting = this.get('role:' + selectedActor.roles[i], roleDefault);
if (roleSetting !== null) {
if (isEnabled === null) {
isEnabled = roleSetting;
}
else {
isEnabled = isEnabled || roleSetting;
}
}
}
if (isEnabled !== null) {
return isEnabled;
}
//If we get this far, it means that none of the user's roles have
//a setting for this item. Fall through to the final default.
}
return noValueDefault;
}
setEnabledFor(selectedActor, enabled, allActors = null, defaultValue = null) {
if ((selectedActor === null) && (allActors === null)) {
throw 'When the selected actor is NULL, you must provide ' +
'a list of all visible actors so that the item can be enabled or disabled for all of them';
}
if (selectedActor === null) {
//Enable/disable the item for all actors.
if (enabled === defaultValue) {
//Since the new value is the same as the default,
//this is equivalent to removing all settings.
this.resetAll();
}
else {
for (let i = 0; i < allActors.length; i++) {
this.set(allActors[i].getId(), enabled);
}
}
}
else {
this.set(selectedActor.getId(), enabled);
}
}
}
if (typeof wsAmeActorData !== 'undefined') {
AmeActors = new AmeActorManager(wsAmeActorData.roles, wsAmeActorData.users, wsAmeActorData.isMultisite, wsAmeActorData.suspectedMetaCaps);
if (typeof wsAmeActorData['capPower'] !== 'undefined') {
AmeActors.generateCapabilitySuggestions(wsAmeActorData['capPower']);
}
}
//# sourceMappingURL=actor-manager.js.map