-
Notifications
You must be signed in to change notification settings - Fork 0
/
addonMenu.js
563 lines (437 loc) · 15 KB
/
addonMenu.js
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
"use strict";
// Add global section to register addon actions if it doesn't exist yet
if(typeof window.window.addons == "undefined" )
window.window.addons = {};
window.addons.addonMenu = {
rootNode: {
type: "root",
id: "root",
actions: []
},
editNode: {
type: "root",
id: "root",
actions: []
},
miscCategoryName: "Misc",
addonName: () => "AddonMenu",
refresh: async function(){
let _this = this;
_this.reloadActionTree();
let menu = _this.buildMainMenuArray()
await _this.pushToUi(menu);
},
pushToUi: async function(Menu){
// pushes the internal menu to the ui
let _this = this;
if(Menu.length == 0)
return;
// Check if the menu was already pushed to UI, and only update the menu items if it was
for (let i = 0; i < window.mainMenuItems.length; i++) {
const itm = window.mainMenuItems[i].action;
if(itm.hasOwnProperty('title') && itm.title instanceof Function && itm.title() == '&Addons'){
itm.submenu = Menu;
return;
}
}
// The addons menu item has not yet been added to the main menu
// The help menu is, by convention, the last item on a menu bar, so the addon menu should be positioned before it.
let helpMenu = window.mainMenuItems.filter(itm => itm.action.title instanceof Function && itm.action.title() == "&Help")[0]
// While just taking the first index before the helpmenu could cause a collision with other items,
// it doesn't matter because what ultimately decides the used order is the position within the mainMenuItems array,
// not the order property
let extMenuIndex = helpMenu.order -1;
let newMenu = {
action: {
title: function () {
return _('&Addons');
},
visible: !webApp,
submenu: Menu
},
order: extMenuIndex,
grouporder: 10,
}
window.mainMenuItems.push(newMenu);
window.mainMenuItems.sort((a,b) => !a.hasOwnProperty('order') || a.order - b.order);
uitools.switchMainMenu(false);
uitools.switchMainMenu(true);
},
getAddonActions: function(){
// returns a list of all actions with an addon property
return Object.keys(actions)
.filter((key) => actions[key].hasOwnProperty("addon")
&& actions[key].addon instanceof Function
&& (actions[key].addon()))
.map(function(key){return {key:key,action:actions[key]}})
},
getValidActions: function(){
// returns a list of all addon actions with valid properties
let allActions = this.getAddonActions();
let validActions = allActions.filter(ext => {
return (ext.action.hasOwnProperty('execute')
&& ext.action.hasOwnProperty('title')
&& ext.action.title instanceof Function
&& (ext.action.title())
);
})
return validActions;
},
getAddonList: function(actionObjects){
// Returns the grouped addon list of all loaded actions
return [...new Set(actionObjects.map(act => act.action.addon()))]
},
groupActions: function(actionObjects){
// returns an array of all valid actions grouped by their addon;
let groupedActions = [];
let addonList = this.getAddonList(actionObjects);
// expand valid actions to full object to be able to group them
// let actionFunctions = Object.keys(actions)
// .filter(key => validActions.includes(key))
// .map(function(key){return {key:key,action:actions[key]}})
// get the actions for each addon and group them
addonList.forEach(ext =>{
let filteredActions = actionObjects
.filter(act => act.action.addon() == ext)
.map(act => act.key)
groupedActions.push({
addon: ext,
actions: filteredActions
});
});
return groupedActions;
},
buildNodeTree: function(actionObjects){
// builds a node tree from a list of actions
let groupedActions = this.groupActions(actionObjects);
groupedActions.sort();
let nodeTree = [];
let extSortOrder = 0;
groupedActions.forEach(ext =>{
// map each action with its order within the addon and an unique ID
let actionSortOrder = 0;
let newGroup = this.newGroup(ext.addon, [], (extSortOrder += 10))
let extActions = ext.actions.map(act => {
return {
action: act,
id: `actions.${act}`,
type: "action",
group: newGroup.id,
order: (actionSortOrder += 10),
show: true
}
});
newGroup.actions = extActions;
nodeTree.push(newGroup);
})
return nodeTree;
},
buildActionTree: function(){
// Creates an addon tree from the currently loaded actions
let validActions = this.getValidActions();
return this.buildNodeTree(validActions);
},
buildUserActionTree: function(){
// Creates an addon tree from the currently loaded actions
// and applies user settings to it
let validActions = this.getValidActions();
let userSettings = this.loadSettings();
userSettings.sort(this.sortGroup);
let validActionsKeys = validActions.map(itm => itm.key);
let userSettingsKeys = userSettings
.filter(itm => itm.type == 'action')
.map(itm => itm.action);
// remove user preferences if their related action is not available anymore in case the addon was removed
userSettingsKeys = userSettingsKeys.filter(itm => validActionsKeys.includes(itm))
let userActions = userSettings.filter(itm => userSettingsKeys.includes(itm.action));
// only include addon actions if they don't have a user preference yet
validActionsKeys = validActionsKeys.filter(itm => !userSettingsKeys.includes(itm))
let extActions = validActions.filter(itm => validActionsKeys.includes(itm.key))
// create node tree from the filtered actions
let actionNodes = this.buildNodeTree(extActions);
// build node tree from loaded user settings
let userGroups = userSettings.filter(itm => itm.type == 'group');
let actionTree = []
userGroups.forEach(grp => {
let grpActions = userActions.filter(act => act.group == grp.id);
if(grpActions.length > 0){
grp.actions = grpActions;
actionTree.push(grp);
}
});
let rootActions = userActions.filter(act => act.group == 'root');
rootActions.forEach(act =>{
actionTree.push(act);
})
actionTree.sort(this.sortGroup);
// add all new actions to the bottom of the list
let groupOrder = 0;
if(actionTree[actionTree.length -1]){
groupOrder = actionTree[actionTree.length -1].order;
}
actionNodes.forEach(node => {
node.order = (groupOrder += 10);
actionTree.push(node);
})
return actionTree;
},
getRootNode: function(){
// returns the main addon menu root node
if(this.rootNode.actions.length == 0)
this.rootNode.actions = this.buildUserActionTree();
return this.rootNode;
},
getEditRootNode: function(){
// returns a temporary addon menu root node
if(this.editNode.actions.length == 0)
this.editNode.actions = this.buildUserActionTree();
return this.editNode;
},
applyChanges: function(){
// applies all changes from the edit root node
// to the main root node
this.rootNode.actions = this.editNode.actions;
this.discardChanges();
},
buildMainMenuArray: function(){
// Creates menu that can be pushed to the main menu
let menu = []
let extTree = this.getRootNode().actions;
let groups = extTree.filter(itm => itm.type == "group");
groups.forEach(ext =>{
// Unwrap each tree item and reorganize it to a structure
// that can be understood by the main menu
let actionList = ext.actions
.filter(act => act.show == true)
.map(act => {
return {
grouporder:10,
order: act.order,
action: actions[act.action]
}
})
let addonAction = {
title: () => ext.title,
submenu: actionList
};
menu.push({
grouporder: 10,
order: ext.order,
action: addonAction
});
});
// remove groups without visible actions
menu = menu.filter(x => x.action.submenu.length > 0)
let rootActions = extTree
.filter(itm => itm.type == "action" && itm.group == "root");
rootActions.forEach(ext =>{
menu.push({
grouporder: 10,
order: ext.order,
action: actions[ext.action]
});
});
return menu;
},
resetActionTree: function(){
// discards all user settings and rebuilds the action tree
this.rootNode.actions = this.buildActionTree();
this.editNode.actions = this.buildActionTree();
},
reloadActionTree: function(){
// discards the current action tree and rebuilds it
this.discardChanges();
this.rootNode.actions = this.buildUserActionTree();
},
discardChanges: function(){
// discards all changes in the edit root node
this.editNode.actions = this.buildUserActionTree();
},
moveGroup: function(group, target){
// moves the provided group to a new parent
this.editNode.actions.sort(this.sortGroup);
if(target.type == "action"){
if(target.group == "root"){
// move group behind target in root
this.moveToIndex(group, target.order)
return;
}
if(group.id != target.group){
// group was dropped on an action in a different group
// action is in a group, move the current group behind the parent of the target
let targetIndex = this.getActionParent(target).order;
this.moveToIndex(group, targetIndex)
}
// else group was dropped on action in same group, nothing to do here
} else {
if(target.type == "group"){
this.moveToIndex(group, target.order);
} else {
// group was dropped on root, move the group to the last index
this.moveToIndex(group, this.editNode.actions[this.editNode.actions.length -1].order);
}
}
},
moveAction: function(action, target){
// moves the provided action to a new parent
if(target.type == "action"){
if(action.group == target.group){
// action was dropped on action in same group, move action behind target
this.moveToIndex(action, target.order);
} else {
// action was dropped on action in different group
// move action behind target in the new group
let targetParent = this.getActionParent(target)
this.moveActionToGroup(action, targetParent)
this.moveToIndex(action, target.order);
}
} else{
if(action.group != target.id || target.id == "root"){
// action was dropped on different group, move to last index of the group
this.moveActionToGroup(action, target)
}
// else action was dropped on same group, nothing to do here
}
this.cleanupGroups();
},
moveActionToGroup: function(item, target){
// moves action to the last position of a group
let oldParent = this.getActionParent(item)
let actionIndex = oldParent.actions.findIndex(x => x.id == item.id);
let newParent = (target.type == 'root' ? this.editNode : this.editNode.actions.filter(x => x.id == target.id)[0]);
if(!oldParent || !newParent || actionIndex == null)
return;
// move action to new group, and assign the order
// of the current highest element +10
newParent.actions.sort(this.sortGroup);
let highestOrder = 0;
if(newParent.actions.length > 0)
highestOrder = newParent.actions[newParent.actions.length - 1].order
newParent.actions.push(item);
item.group = newParent.id;
item.order = highestOrder + 10
// Reorder the old parent by shifting down the order of
// all elements beginning from the order of the moved item
oldParent = oldParent.actions;
oldParent.splice(actionIndex,1);
if(oldParent.length == 0){
// the last node was moved away, remove the parent
return;
}
oldParent.sort(this.sortGroup);
let newItemOrder = (actionIndex == 0 ? 10 : (oldParent[actionIndex-1].order) + 10);
for (let index = actionIndex; index < oldParent.length; index++) {
oldParent[index].order = (newItemOrder += 10);
}
},
moveToIndex: function(item, order){
// moves the item to the specified index of a group
// shifting up the order of all elements after it
let itemParent = this.getActionParent(item).actions;
itemParent.sort(this.sortGroup);
let currentItemIndex = itemParent.findIndex(x =>x.id == item.id);
let targetIndex = itemParent.length
if(itemParent[targetIndex-1].order > order){
targetIndex = itemParent.findIndex(x => x.order >= order);
}
itemParent.splice(targetIndex, 0, itemParent.splice(currentItemIndex, 1)[0]);
// Assign a new order value to each item to
// keep the order in sync with the array position
let itemOrder = 0;
for (let index = 0; index < itemParent.length; index++) {
itemParent[index].order = (itemOrder += 10);
}
},
getActionParent: function(action){
return (action.group == "root" ? this.editNode : this.editNode.actions.filter(x => x.type == "group" && x.id == action.group)[0]);
},
sortGroup: function(a,b) {
return a.order-b.order;
},
removeGroup: function(group){
// removes a group from the action tree if the group
// contains actions, they will be moved to the root node
if(group.type == "action")
return;
let groupIndex = this.editNode.actions.findIndex(x => x.type == "group" && x.id == group.id);
if(groupIndex < 0)
return;
if(group.actions.length > 0){
for (let index = (group.actions.length - 1); index >= 0; index--) {
const action = group.actions[index];
this.moveActionToGroup(action, this.editNode);
}
}
this.editNode.actions.splice(groupIndex, 1);
let newGroupOrder = 0;
for (let index = 0; index < this.editNode.actions.length; index++) {
this.editNode.actions[index].order = (newGroupOrder += 10);
}
},
cleanupGroups: function(){
// removes all groups without action
for (let index = this.editNode.actions.length-1; index >= 0 ; index--) {
const treeElement = this.editNode.actions[index];
if(treeElement.type != "action" && treeElement.actions.length == 0){
this.removeGroup(this.editNode.actions[index]);
}
}
},
newGroup: function(title, actionList, sortOrder){
// adds a new group edit root node and returns a reference to the group
if(!sortOrder){
sortOrder = 10;
if(this.editNode.actions.length > 0)
sortOrder = this.editNode.actions[this.editNode.actions.length -1].order;
}
if(!title)
title = "";
if(!actionList)
actionList = [];
let randomString = Math.random().toString(36).substring(2, 15) + Math.random().toString(36).substring(2, 15);
let newGroup = {
id: `groups.${randomString}`,
order: sortOrder,
title: title,
group: "root",
type: "group",
actions: actionList
}
return newGroup;
},
setTitle: function(item, newTitle){
// changes the display title of an element
let actionTree = this.getEditRootNode().actions;
actionTree[0].title = "eeee";
},
saveSettings: function(){
// persists user settings
// flatten the array to save all actions and groups as
// list for easier comparison when loading them later
let saveArr = this.rootNode.actions
.filter(itm => itm.type == 'group')
.map(itm => itm = itm.actions)
.flat();
let rootActions = this.rootNode.actions
.filter(itm => itm.type == 'action');
// also append the empty groups to preserve their names and order
let rootGroups = this.rootNode.actions
.filter(itm => itm.type == 'group')
.map(itm => {
return {
id: itm.id,
group: itm.group,
order: itm.order,
title: itm.title,
type: itm.type
}
})
saveArr.push(...rootActions);
saveArr.push(...rootGroups);
app.setValue(this.addonName(), saveArr);
},
loadSettings: function(){
// loads saved user settings
return app.getValue(this.addonName(), []);
}
}