Update MenuFlags to work as expected
* 'popParent' has been removed * 'noHistory' now works as expected * Mods that explicitly want noHistory can state such in their constructor()
This commit is contained in:
parent
614fa2d096
commit
1cfbf4fb66
|
@ -8,6 +8,7 @@ This document attempts to track **major** changes and additions in ENiGMA½. For
|
||||||
* Routes for the file base now default to `/_f/` prefixed instead of just `/f/`. If `/f/` is in your `config.hjson` you are encouraged to update it!
|
* Routes for the file base now default to `/_f/` prefixed instead of just `/f/`. If `/f/` is in your `config.hjson` you are encouraged to update it!
|
||||||
* Finally, the system will search for `index.html` and `index.htm` in that order, if another suitable route cannot be established.
|
* Finally, the system will search for `index.html` and `index.htm` in that order, if another suitable route cannot be established.
|
||||||
* CombatNet has shut down, so the module (`combatnet.js`) has been removed.
|
* CombatNet has shut down, so the module (`combatnet.js`) has been removed.
|
||||||
|
* The Menu Flag `popParent` has been removed and `noHistory` has been updated to work as expected. In general things should "Just Work", but check your `menu.hjson` entries if you see menu stack issues.
|
||||||
|
|
||||||
## 0.0.13-beta
|
## 0.0.13-beta
|
||||||
* **Note for contributors**: ENiGMA has switched to [Prettier](https://prettier.io) for formatting/style. Please see [CONTRIBUTING](CONTRIBUTING.md) and the Prettier website for more information.
|
* **Note for contributors**: ENiGMA has switched to [Prettier](https://prettier.io) for formatting/style. Please see [CONTRIBUTING](CONTRIBUTING.md) and the Prettier website for more information.
|
||||||
|
|
|
@ -2,10 +2,8 @@
|
||||||
'use strict';
|
'use strict';
|
||||||
|
|
||||||
// ENiGMA½
|
// ENiGMA½
|
||||||
const MenuModule = require('./menu_module.js').MenuModule;
|
const { MenuModule, MenuFlags } = require('./menu_module.js');
|
||||||
const ViewController = require('./view_controller.js').ViewController;
|
|
||||||
const ansi = require('./ansi_term.js');
|
const ansi = require('./ansi_term.js');
|
||||||
const theme = require('./theme.js');
|
|
||||||
const FileEntry = require('./file_entry.js');
|
const FileEntry = require('./file_entry.js');
|
||||||
const stringFormat = require('./string_format.js');
|
const stringFormat = require('./string_format.js');
|
||||||
const FileArea = require('./file_base_area.js');
|
const FileArea = require('./file_base_area.js');
|
||||||
|
@ -77,6 +75,8 @@ exports.getModule = class FileAreaList extends MenuModule {
|
||||||
this.fileList = _.get(options, 'extraArgs.fileList');
|
this.fileList = _.get(options, 'extraArgs.fileList');
|
||||||
this.lastFileNextExit = _.get(options, 'extraArgs.lastFileNextExit', true);
|
this.lastFileNextExit = _.get(options, 'extraArgs.lastFileNextExit', true);
|
||||||
|
|
||||||
|
this.setMergedFlag(MenuFlags.NoHistory);
|
||||||
|
|
||||||
if (this.fileList) {
|
if (this.fileList) {
|
||||||
// we'll need to adjust position as well!
|
// we'll need to adjust position as well!
|
||||||
this.fileListPosition = 0;
|
this.fileListPosition = 0;
|
||||||
|
|
|
@ -2,7 +2,7 @@
|
||||||
'use strict';
|
'use strict';
|
||||||
|
|
||||||
// enigma-bbs
|
// enigma-bbs
|
||||||
const MenuModule = require('./menu_module.js').MenuModule;
|
const { MenuModule, MenuFlags } = require('./menu_module.js');
|
||||||
const { getSortedAvailableFileAreas } = require('./file_base_area.js');
|
const { getSortedAvailableFileAreas } = require('./file_base_area.js');
|
||||||
const StatLog = require('./stat_log.js');
|
const StatLog = require('./stat_log.js');
|
||||||
const SysProps = require('./system_property.js');
|
const SysProps = require('./system_property.js');
|
||||||
|
@ -24,6 +24,8 @@ exports.getModule = class FileAreaSelectModule extends MenuModule {
|
||||||
constructor(options) {
|
constructor(options) {
|
||||||
super(options);
|
super(options);
|
||||||
|
|
||||||
|
this.setMergedFlag(MenuFlags.NoHistory);
|
||||||
|
|
||||||
this.menuMethods = {
|
this.menuMethods = {
|
||||||
selectArea: (formData, extraArgs, cb) => {
|
selectArea: (formData, extraArgs, cb) => {
|
||||||
const filterCriteria = {
|
const filterCriteria = {
|
||||||
|
@ -34,7 +36,7 @@ exports.getModule = class FileAreaSelectModule extends MenuModule {
|
||||||
extraArgs: {
|
extraArgs: {
|
||||||
filterCriteria: filterCriteria,
|
filterCriteria: filterCriteria,
|
||||||
},
|
},
|
||||||
menuFlags: ['popParent', 'mergeFlags'],
|
menuFlags: [ MenuFlags.NoHistory ],
|
||||||
};
|
};
|
||||||
|
|
||||||
return this.gotoMenu(
|
return this.gotoMenu(
|
||||||
|
|
|
@ -2,10 +2,8 @@
|
||||||
'use strict';
|
'use strict';
|
||||||
|
|
||||||
// ENiGMA½
|
// ENiGMA½
|
||||||
const MenuModule = require('./menu_module.js').MenuModule;
|
const { MenuModule, MenuFlags } = require('./menu_module.js');
|
||||||
const ViewController = require('./view_controller.js').ViewController;
|
|
||||||
const DownloadQueue = require('./download_queue.js');
|
const DownloadQueue = require('./download_queue.js');
|
||||||
const theme = require('./theme.js');
|
|
||||||
const ansi = require('./ansi_term.js');
|
const ansi = require('./ansi_term.js');
|
||||||
const Errors = require('./enig_error.js').Errors;
|
const Errors = require('./enig_error.js').Errors;
|
||||||
const FileAreaWeb = require('./file_area_web.js');
|
const FileAreaWeb = require('./file_area_web.js');
|
||||||
|
@ -38,6 +36,8 @@ exports.getModule = class FileBaseDownloadQueueManager extends MenuModule {
|
||||||
constructor(options) {
|
constructor(options) {
|
||||||
super(options);
|
super(options);
|
||||||
|
|
||||||
|
this.setMergedFlag(MenuFlags.NoHistory);
|
||||||
|
|
||||||
this.dlQueue = new DownloadQueue(this.client);
|
this.dlQueue = new DownloadQueue(this.client);
|
||||||
|
|
||||||
if (_.has(options, 'lastMenuResult.sentFileIds')) {
|
if (_.has(options, 'lastMenuResult.sentFileIds')) {
|
||||||
|
|
|
@ -121,7 +121,6 @@ exports.getModule = class FileBaseSearch extends MenuModule {
|
||||||
extraArgs: {
|
extraArgs: {
|
||||||
filterCriteria: filterCriteria,
|
filterCriteria: filterCriteria,
|
||||||
},
|
},
|
||||||
menuFlags: ['popParent'],
|
|
||||||
};
|
};
|
||||||
|
|
||||||
return this.gotoMenu(
|
return this.gotoMenu(
|
||||||
|
|
|
@ -2,7 +2,7 @@
|
||||||
'use strict';
|
'use strict';
|
||||||
|
|
||||||
// ENiGMA½
|
// ENiGMA½
|
||||||
const { MenuModule } = require('./menu_module.js');
|
const { MenuModule, MenuFlags } = require('./menu_module.js');
|
||||||
const FileEntry = require('./file_entry.js');
|
const FileEntry = require('./file_entry.js');
|
||||||
const FileArea = require('./file_base_area.js');
|
const FileArea = require('./file_base_area.js');
|
||||||
const { renderSubstr } = require('./string_util.js');
|
const { renderSubstr } = require('./string_util.js');
|
||||||
|
@ -65,6 +65,9 @@ const MciViewIds = {
|
||||||
exports.getModule = class FileBaseListExport extends MenuModule {
|
exports.getModule = class FileBaseListExport extends MenuModule {
|
||||||
constructor(options) {
|
constructor(options) {
|
||||||
super(options);
|
super(options);
|
||||||
|
|
||||||
|
this.setMergedFlag(MenuFlags.NoHistory);
|
||||||
|
|
||||||
this.config = Object.assign(
|
this.config = Object.assign(
|
||||||
{},
|
{},
|
||||||
_.get(options, 'menuConfig.config'),
|
_.get(options, 'menuConfig.config'),
|
||||||
|
|
|
@ -2,10 +2,8 @@
|
||||||
'use strict';
|
'use strict';
|
||||||
|
|
||||||
// ENiGMA½
|
// ENiGMA½
|
||||||
const MenuModule = require('./menu_module.js').MenuModule;
|
const { MenuModule, MenuFlags } = require('./menu_module.js');
|
||||||
const ViewController = require('./view_controller.js').ViewController;
|
|
||||||
const DownloadQueue = require('./download_queue.js');
|
const DownloadQueue = require('./download_queue.js');
|
||||||
const theme = require('./theme.js');
|
|
||||||
const ansi = require('./ansi_term.js');
|
const ansi = require('./ansi_term.js');
|
||||||
const Errors = require('./enig_error.js').Errors;
|
const Errors = require('./enig_error.js').Errors;
|
||||||
const FileAreaWeb = require('./file_area_web.js');
|
const FileAreaWeb = require('./file_area_web.js');
|
||||||
|
@ -40,6 +38,8 @@ exports.getModule = class FileBaseWebDownloadQueueManager extends MenuModule {
|
||||||
constructor(options) {
|
constructor(options) {
|
||||||
super(options);
|
super(options);
|
||||||
|
|
||||||
|
this.setMergedFlag(MenuFlags.NoHistory);
|
||||||
|
|
||||||
this.dlQueue = new DownloadQueue(this.client);
|
this.dlQueue = new DownloadQueue(this.client);
|
||||||
|
|
||||||
this.menuMethods = {
|
this.menuMethods = {
|
||||||
|
|
|
@ -20,6 +20,23 @@ const assert = require('assert');
|
||||||
const _ = require('lodash');
|
const _ = require('lodash');
|
||||||
const iconvDecode = require('iconv-lite').decode;
|
const iconvDecode = require('iconv-lite').decode;
|
||||||
|
|
||||||
|
const MenuFlags = {
|
||||||
|
// When leaving this menu to load/chain to another, remove this
|
||||||
|
// menu from history. In other words, the fallback from
|
||||||
|
// the next menu would *not* be this one, but the previous.
|
||||||
|
NoHistory: 'noHistory',
|
||||||
|
|
||||||
|
// Generally used in code only: Request that any flags from menu.hjson
|
||||||
|
// are merged in to the total set of flags vs overriding the default.
|
||||||
|
MergeFlags: 'mergeFlags',
|
||||||
|
|
||||||
|
// Forward this menu's 'extraArgs' to the next.
|
||||||
|
ForwardArgs: 'forwardArgs',
|
||||||
|
};
|
||||||
|
|
||||||
|
exports.MenuFlags = MenuFlags;
|
||||||
|
|
||||||
|
|
||||||
exports.MenuModule = class MenuModule extends PluginModule {
|
exports.MenuModule = class MenuModule extends PluginModule {
|
||||||
constructor(options) {
|
constructor(options) {
|
||||||
super(options);
|
super(options);
|
||||||
|
@ -48,6 +65,11 @@ exports.MenuModule = class MenuModule extends PluginModule {
|
||||||
});
|
});
|
||||||
}
|
}
|
||||||
|
|
||||||
|
setMergedFlag(flag) {
|
||||||
|
this.menuConfig.config.menuFlags.push(flag);
|
||||||
|
this.menuConfig.config.menuFlags = [...new Set([...this.menuConfig.config.menuFlags, MenuFlags.MergeFlags])];
|
||||||
|
}
|
||||||
|
|
||||||
static get InterruptTypes() {
|
static get InterruptTypes() {
|
||||||
return {
|
return {
|
||||||
Never: 'never',
|
Never: 'never',
|
||||||
|
|
|
@ -5,12 +5,12 @@
|
||||||
const loadMenu = require('./menu_util.js').loadMenu;
|
const loadMenu = require('./menu_util.js').loadMenu;
|
||||||
const { Errors, ErrorReasons } = require('./enig_error.js');
|
const { Errors, ErrorReasons } = require('./enig_error.js');
|
||||||
const { getResolvedSpec } = require('./menu_util.js');
|
const { getResolvedSpec } = require('./menu_util.js');
|
||||||
|
const { MenuFlags } = require('./menu_module.js');
|
||||||
|
|
||||||
// deps
|
// deps
|
||||||
const _ = require('lodash');
|
const _ = require('lodash');
|
||||||
const assert = require('assert');
|
const assert = require('assert');
|
||||||
|
const bunyan = require('bunyan');
|
||||||
// :TODO: Stack is backwards.... top should be most recent! :)
|
|
||||||
|
|
||||||
module.exports = class MenuStack {
|
module.exports = class MenuStack {
|
||||||
constructor(client) {
|
constructor(client) {
|
||||||
|
@ -27,20 +27,12 @@ module.exports = class MenuStack {
|
||||||
}
|
}
|
||||||
|
|
||||||
peekPrev() {
|
peekPrev() {
|
||||||
if (this.stackSize > 1) {
|
|
||||||
return this.stack[this.stack.length - 2];
|
return this.stack[this.stack.length - 2];
|
||||||
}
|
}
|
||||||
}
|
|
||||||
|
|
||||||
top() {
|
top() {
|
||||||
if (this.stackSize > 0) {
|
|
||||||
return this.stack[this.stack.length - 1];
|
return this.stack[this.stack.length - 1];
|
||||||
}
|
}
|
||||||
}
|
|
||||||
|
|
||||||
get stackSize() {
|
|
||||||
return this.stack.length;
|
|
||||||
}
|
|
||||||
|
|
||||||
get currentModule() {
|
get currentModule() {
|
||||||
const top = this.top();
|
const top = this.top();
|
||||||
|
@ -81,7 +73,6 @@ module.exports = class MenuStack {
|
||||||
prev(cb) {
|
prev(cb) {
|
||||||
const menuResult = this.top().instance.getMenuResult();
|
const menuResult = this.top().instance.getMenuResult();
|
||||||
|
|
||||||
// :TODO: leave() should really take a cb...
|
|
||||||
this.pop().instance.leave(); // leave & remove current
|
this.pop().instance.leave(); // leave & remove current
|
||||||
|
|
||||||
const previousModuleInfo = this.pop(); // get previous
|
const previousModuleInfo = this.pop(); // get previous
|
||||||
|
@ -129,7 +120,7 @@ module.exports = class MenuStack {
|
||||||
client: self.client,
|
client: self.client,
|
||||||
};
|
};
|
||||||
|
|
||||||
if (currentModuleInfo && currentModuleInfo.menuFlags.includes('forwardArgs')) {
|
if (currentModuleInfo && currentModuleInfo.menuFlags.includes(MenuFlags.ForwardArgs)) {
|
||||||
loadOpts.extraArgs = currentModuleInfo.extraArgs;
|
loadOpts.extraArgs = currentModuleInfo.extraArgs;
|
||||||
} else {
|
} else {
|
||||||
loadOpts.extraArgs = options.extraArgs || _.get(options, 'formData.value');
|
loadOpts.extraArgs = options.extraArgs || _.get(options, 'formData.value');
|
||||||
|
@ -138,7 +129,6 @@ module.exports = class MenuStack {
|
||||||
|
|
||||||
loadMenu(loadOpts, (err, modInst) => {
|
loadMenu(loadOpts, (err, modInst) => {
|
||||||
if (err) {
|
if (err) {
|
||||||
// :TODO: probably should just require a cb...
|
|
||||||
const errCb = cb || self.client.defaultHandlerMissingMod();
|
const errCb = cb || self.client.defaultHandlerMissingMod();
|
||||||
errCb(err);
|
errCb(err);
|
||||||
} else {
|
} else {
|
||||||
|
@ -151,22 +141,6 @@ module.exports = class MenuStack {
|
||||||
return;
|
return;
|
||||||
}
|
}
|
||||||
|
|
||||||
//
|
|
||||||
// Handle deprecated 'options' block by merging to config and warning user.
|
|
||||||
// :TODO: Remove in 0.0.10+
|
|
||||||
//
|
|
||||||
if (modInst.menuConfig.options) {
|
|
||||||
self.client.log.warn(
|
|
||||||
{ options: modInst.menuConfig.options },
|
|
||||||
'Use of "options" is deprecated. Move relevant members to "config" block! Support will be fully removed in future versions'
|
|
||||||
);
|
|
||||||
Object.assign(
|
|
||||||
modInst.menuConfig.config || {},
|
|
||||||
modInst.menuConfig.options
|
|
||||||
);
|
|
||||||
delete modInst.menuConfig.options;
|
|
||||||
}
|
|
||||||
|
|
||||||
//
|
//
|
||||||
// If menuFlags were supplied in menu.hjson, they should win over
|
// If menuFlags were supplied in menu.hjson, they should win over
|
||||||
// anything supplied in code.
|
// anything supplied in code.
|
||||||
|
@ -180,9 +154,9 @@ module.exports = class MenuStack {
|
||||||
// in code we can ask to merge in
|
// in code we can ask to merge in
|
||||||
if (
|
if (
|
||||||
Array.isArray(options.menuFlags) &&
|
Array.isArray(options.menuFlags) &&
|
||||||
options.menuFlags.includes('mergeFlags')
|
options.menuFlags.includes(MenuFlags.MergeFlags)
|
||||||
) {
|
) {
|
||||||
menuFlags = _.uniq(menuFlags.concat(options.menuFlags));
|
menuFlags = [...new Set(options.menuFlags)]; // make unique
|
||||||
}
|
}
|
||||||
}
|
}
|
||||||
|
|
||||||
|
@ -193,12 +167,8 @@ module.exports = class MenuStack {
|
||||||
|
|
||||||
currentModuleInfo.instance.leave();
|
currentModuleInfo.instance.leave();
|
||||||
|
|
||||||
if (currentModuleInfo.menuFlags.includes('noHistory')) {
|
if (currentModuleInfo.menuFlags.includes(MenuFlags.NoHistory)) {
|
||||||
this.pop();
|
this.pop().instance.leave(); // leave & remove current from stack
|
||||||
}
|
|
||||||
|
|
||||||
if (menuFlags.includes('popParent')) {
|
|
||||||
this.pop().instance.leave(); // leave & remove current
|
|
||||||
}
|
}
|
||||||
}
|
}
|
||||||
|
|
||||||
|
@ -214,6 +184,7 @@ module.exports = class MenuStack {
|
||||||
modInst.restoreSavedState(options.savedState);
|
modInst.restoreSavedState(options.savedState);
|
||||||
}
|
}
|
||||||
|
|
||||||
|
if (self.client.log.level() <= bunyan.TRACE) {
|
||||||
const stackEntries = self.stack.map(stackEntry => {
|
const stackEntries = self.stack.map(stackEntry => {
|
||||||
let name = stackEntry.name;
|
let name = stackEntry.name;
|
||||||
if (stackEntry.instance.menuConfig.config.menuFlags.length > 0) {
|
if (stackEntry.instance.menuConfig.config.menuFlags.length > 0) {
|
||||||
|
@ -225,6 +196,7 @@ module.exports = class MenuStack {
|
||||||
});
|
});
|
||||||
|
|
||||||
self.client.log.trace({ stack: stackEntries }, 'Updated menu stack');
|
self.client.log.trace({ stack: stackEntries }, 'Updated menu stack');
|
||||||
|
}
|
||||||
|
|
||||||
modInst.enter();
|
modInst.enter();
|
||||||
|
|
||||||
|
|
|
@ -113,7 +113,6 @@ exports.getModule = class MessageBaseSearch extends MenuModule {
|
||||||
const returnNoResults = () => {
|
const returnNoResults = () => {
|
||||||
return this.gotoMenu(
|
return this.gotoMenu(
|
||||||
this.menuConfig.config.noResultsMenu || 'messageSearchNoResults',
|
this.menuConfig.config.noResultsMenu || 'messageSearchNoResults',
|
||||||
{ menuFlags: ['popParent'] },
|
|
||||||
cb
|
cb
|
||||||
);
|
);
|
||||||
};
|
};
|
||||||
|
@ -160,7 +159,6 @@ exports.getModule = class MessageBaseSearch extends MenuModule {
|
||||||
messageList,
|
messageList,
|
||||||
noUpdateLastReadId: true,
|
noUpdateLastReadId: true,
|
||||||
},
|
},
|
||||||
menuFlags: ['popParent'],
|
|
||||||
};
|
};
|
||||||
|
|
||||||
return this.gotoMenu(
|
return this.gotoMenu(
|
||||||
|
|
|
@ -2,7 +2,7 @@
|
||||||
'use strict';
|
'use strict';
|
||||||
|
|
||||||
// ENiGMA½
|
// ENiGMA½
|
||||||
const { MenuModule } = require('./menu_module.js');
|
const { MenuModule, MenuFlags } = require('./menu_module.js');
|
||||||
const messageArea = require('./message_area.js');
|
const messageArea = require('./message_area.js');
|
||||||
const { Errors } = require('./enig_error.js');
|
const { Errors } = require('./enig_error.js');
|
||||||
const UserProps = require('./user_property.js');
|
const UserProps = require('./user_property.js');
|
||||||
|
@ -29,6 +29,9 @@ exports.getModule = class MessageAreaListModule extends MenuModule {
|
||||||
constructor(options) {
|
constructor(options) {
|
||||||
super(options);
|
super(options);
|
||||||
|
|
||||||
|
// always include noHistory flag
|
||||||
|
this.setMergedFlag(MenuFlags.NoHistory);
|
||||||
|
|
||||||
this.initList();
|
this.initList();
|
||||||
|
|
||||||
this.menuMethods = {
|
this.menuMethods = {
|
||||||
|
@ -49,7 +52,7 @@ exports.getModule = class MessageAreaListModule extends MenuModule {
|
||||||
extraArgs: {
|
extraArgs: {
|
||||||
areaTag: area.areaTag,
|
areaTag: area.areaTag,
|
||||||
},
|
},
|
||||||
menuFlags: ['popParent', 'noHistory'],
|
menuFlags: [ MenuFlags.NoHistory ],
|
||||||
};
|
};
|
||||||
|
|
||||||
return this.gotoMenu(
|
return this.gotoMenu(
|
||||||
|
|
|
@ -2,7 +2,7 @@
|
||||||
'use strict';
|
'use strict';
|
||||||
|
|
||||||
// ENiGMA½
|
// ENiGMA½
|
||||||
const { MenuModule } = require('./menu_module.js');
|
const { MenuModule, MenuFlags } = require('./menu_module.js');
|
||||||
const messageArea = require('./message_area.js');
|
const messageArea = require('./message_area.js');
|
||||||
const { Errors } = require('./enig_error.js');
|
const { Errors } = require('./enig_error.js');
|
||||||
|
|
||||||
|
@ -26,6 +26,9 @@ exports.getModule = class MessageConfListModule extends MenuModule {
|
||||||
constructor(options) {
|
constructor(options) {
|
||||||
super(options);
|
super(options);
|
||||||
|
|
||||||
|
// always include noHistory flag
|
||||||
|
this.setMergedFlag(MenuFlags.NoHistory);
|
||||||
|
|
||||||
this.initList();
|
this.initList();
|
||||||
|
|
||||||
this.menuMethods = {
|
this.menuMethods = {
|
||||||
|
@ -49,7 +52,7 @@ exports.getModule = class MessageConfListModule extends MenuModule {
|
||||||
extraArgs: {
|
extraArgs: {
|
||||||
confTag: conf.confTag,
|
confTag: conf.confTag,
|
||||||
},
|
},
|
||||||
menuFlags: ['popParent', 'noHistory'],
|
menuFlags: [ MenuFlags.NoHistory ],
|
||||||
};
|
};
|
||||||
|
|
||||||
return this.gotoMenu(
|
return this.gotoMenu(
|
||||||
|
|
|
@ -2,7 +2,7 @@
|
||||||
'use strict';
|
'use strict';
|
||||||
|
|
||||||
// ENiGMA½
|
// ENiGMA½
|
||||||
const MenuModule = require('./menu_module.js').MenuModule;
|
const { MenuModule, MenuFlags } = require('./menu_module');
|
||||||
const Message = require('./message.js');
|
const Message = require('./message.js');
|
||||||
const UserProps = require('./user_property.js');
|
const UserProps = require('./user_property.js');
|
||||||
const { filterMessageListByReadACS } = require('./message_area.js');
|
const { filterMessageListByReadACS } = require('./message_area.js');
|
||||||
|
@ -16,6 +16,7 @@ exports.moduleInfo = {
|
||||||
exports.getModule = class MyMessagesModule extends MenuModule {
|
exports.getModule = class MyMessagesModule extends MenuModule {
|
||||||
constructor(options) {
|
constructor(options) {
|
||||||
super(options);
|
super(options);
|
||||||
|
this.setMergedFlag(MenuFlags.NoHistory);
|
||||||
}
|
}
|
||||||
|
|
||||||
initSequence() {
|
initSequence() {
|
||||||
|
@ -49,7 +50,6 @@ exports.getModule = class MyMessagesModule extends MenuModule {
|
||||||
if (!this.messageList || 0 === this.messageList.length) {
|
if (!this.messageList || 0 === this.messageList.length) {
|
||||||
return this.gotoMenu(
|
return this.gotoMenu(
|
||||||
this.menuConfig.config.noResultsMenu || 'messageSearchNoResults',
|
this.menuConfig.config.noResultsMenu || 'messageSearchNoResults',
|
||||||
{ menuFlags: ['popParent'] }
|
|
||||||
);
|
);
|
||||||
}
|
}
|
||||||
|
|
||||||
|
@ -58,7 +58,6 @@ exports.getModule = class MyMessagesModule extends MenuModule {
|
||||||
messageList: this.messageList,
|
messageList: this.messageList,
|
||||||
noUpdateLastReadId: true,
|
noUpdateLastReadId: true,
|
||||||
},
|
},
|
||||||
menuFlags: ['popParent'],
|
|
||||||
};
|
};
|
||||||
|
|
||||||
return this.gotoMenu(
|
return this.gotoMenu(
|
||||||
|
|
|
@ -4,7 +4,6 @@
|
||||||
// ENiGMA½
|
// ENiGMA½
|
||||||
const MenuModule = require('./menu_module.js').MenuModule;
|
const MenuModule = require('./menu_module.js').MenuModule;
|
||||||
const Errors = require('../core/enig_error.js').Errors;
|
const Errors = require('../core/enig_error.js').Errors;
|
||||||
const ANSI = require('./ansi_term.js');
|
|
||||||
const Config = require('./config.js').get;
|
const Config = require('./config.js').get;
|
||||||
const { getMessageAreaByTag } = require('./message_area.js');
|
const { getMessageAreaByTag } = require('./message_area.js');
|
||||||
|
|
||||||
|
@ -21,6 +20,7 @@ exports.moduleInfo = {
|
||||||
exports.getModule = class ShowArtModule extends MenuModule {
|
exports.getModule = class ShowArtModule extends MenuModule {
|
||||||
constructor(options) {
|
constructor(options) {
|
||||||
super(options);
|
super(options);
|
||||||
|
|
||||||
this.config = Object.assign({}, _.get(options, 'menuConfig.config'), {
|
this.config = Object.assign({}, _.get(options, 'menuConfig.config'), {
|
||||||
extraArgs: options.extraArgs,
|
extraArgs: options.extraArgs,
|
||||||
});
|
});
|
||||||
|
|
|
@ -2,7 +2,7 @@
|
||||||
'use strict';
|
'use strict';
|
||||||
|
|
||||||
// enigma-bbs
|
// enigma-bbs
|
||||||
const MenuModule = require('./menu_module.js').MenuModule;
|
const { MenuModule, MenuFlags } = require('./menu_module');
|
||||||
const stringFormat = require('./string_format.js');
|
const stringFormat = require('./string_format.js');
|
||||||
const getSortedAvailableFileAreas =
|
const getSortedAvailableFileAreas =
|
||||||
require('./file_base_area.js').getSortedAvailableFileAreas;
|
require('./file_base_area.js').getSortedAvailableFileAreas;
|
||||||
|
@ -76,6 +76,8 @@ exports.getModule = class UploadModule extends MenuModule {
|
||||||
constructor(options) {
|
constructor(options) {
|
||||||
super(options);
|
super(options);
|
||||||
|
|
||||||
|
this.setMergedFlag(MenuFlags.NoHistory);
|
||||||
|
|
||||||
this.interrupt = MenuModule.InterruptTypes.Never;
|
this.interrupt = MenuModule.InterruptTypes.Never;
|
||||||
|
|
||||||
if (_.has(options, 'lastMenuResult.recvFilePaths')) {
|
if (_.has(options, 'lastMenuResult.recvFilePaths')) {
|
||||||
|
|
|
@ -323,7 +323,7 @@ qwk-export arguments:
|
||||||
|
|
||||||
| Action | Description | Examples |
|
| Action | Description | Examples |
|
||||||
|-----------|-------------------|---------------------------------------|
|
|-----------|-------------------|---------------------------------------|
|
||||||
| `import-areas` | Imports areas using a FidoNet style *.NA or AREAS.BBS formatted file. Optionally maps areas to FTN networks. | `./oputil.js config import-areas /some/path/l33tnet.na` |
|
| `import-areas` | Imports areas using a FidoNet style *.NA or AREAS.BBS formatted file. Optionally maps areas to FTN networks. | `./oputil.js mb import-areas /some/path/l33tnet.na` |
|
||||||
| `areafix` | Utility for sending AreaFix mails without logging into the system | |
|
| `areafix` | Utility for sending AreaFix mails without logging into the system | |
|
||||||
| `qwk-dump` | Dump a QWK packet to stdout | `./oputil.js mb qwk-dump /path/to/XIBALBA.QWK` |
|
| `qwk-dump` | Dump a QWK packet to stdout | `./oputil.js mb qwk-dump /path/to/XIBALBA.QWK` |
|
||||||
| `qwk-export` | Export messages to a QWK packet | `./oputil.js mb qwk-export /path/to/XIBALBA.QWK` |
|
| `qwk-export` | Export messages to a QWK packet | `./oputil.js mb qwk-export /path/to/XIBALBA.QWK` |
|
||||||
|
|
|
@ -59,13 +59,15 @@ The `config` block for a menu entry can contain common members as well as a per-
|
||||||
| `menuFlags` | An array of menu flag(s) controlling menu behavior. See **Menu Flags** below.
|
| `menuFlags` | An array of menu flag(s) controlling menu behavior. See **Menu Flags** below.
|
||||||
|
|
||||||
#### Menu Flags
|
#### Menu Flags
|
||||||
The `menuFlags` field of a `config` block can change default behavior of a particular menu.
|
The `menuFlags` field of a `config` block can change default behavior of a particular menu:
|
||||||
|
|
||||||
| Flag | Description |
|
| Flag | Description |
|
||||||
|------|-------------|
|
|------|-------------|
|
||||||
| `noHistory` | Prevents the menu from remaining in the menu stack / history. When this flag is set, when the **next** menu falls back, this menu will be skipped and the previous menu again displayed instead. Example: menuA -> menuB(noHistory) -> menuC: Exiting menuC returns the user to menuA. |
|
| `noHistory` | When leaving the current menu to load/chain to another, remove this menu from history. In other words, the fallback from the next menu would *not* be this one, but the previous. |
|
||||||
| `popParent` | When *this* menu is exited, fall back beyond the parent as well. Often used in combination with `noHistory`. |
|
| `mergeFlags` | Generally used in code only: Request that any flags from `menu.hjson` |
|
||||||
| `forwardArgs` | If set, when the next menu is entered, forward any `extraArgs` arguments to *this* menu on to it. |
|
| `forwardArgs` | Forward this menu's `extraArgs` to the next. |
|
||||||
|
|
||||||
|
> 💡 In JavaScript code, `MenuFlags` from `menu_module.js` contains constants for these flags.
|
||||||
|
|
||||||
|
|
||||||
## Forms
|
## Forms
|
||||||
|
|
|
@ -58,7 +58,6 @@ showFileBaseAreaArt: {
|
||||||
method: fileBaseArea
|
method: fileBaseArea
|
||||||
cls: true
|
cls: true
|
||||||
pause: true
|
pause: true
|
||||||
menuFlags: [ "popParent", "noHistory" ]
|
|
||||||
}
|
}
|
||||||
}
|
}
|
||||||
```
|
```
|
||||||
|
|
|
@ -388,7 +388,7 @@
|
||||||
art: FEMPTYQ
|
art: FEMPTYQ
|
||||||
config: {
|
config: {
|
||||||
pause: true
|
pause: true
|
||||||
menuFlags: [ "noHistory", "popParent" ]
|
menuFlags: [ "noHistory" ]
|
||||||
}
|
}
|
||||||
}
|
}
|
||||||
|
|
||||||
|
@ -779,7 +779,7 @@
|
||||||
art: FBNORES
|
art: FBNORES
|
||||||
config: {
|
config: {
|
||||||
pause: true
|
pause: true
|
||||||
menuFlags: [ "noHistory", "popParent" ]
|
menuFlags: [ "noHistory" ]
|
||||||
}
|
}
|
||||||
}
|
}
|
||||||
|
|
||||||
|
@ -807,7 +807,7 @@
|
||||||
art: FBNORES
|
art: FBNORES
|
||||||
config: {
|
config: {
|
||||||
pause: true
|
pause: true
|
||||||
menuFlags: [ "noHistory", "popParent" ]
|
menuFlags: [ "noHistory" ]
|
||||||
}
|
}
|
||||||
}
|
}
|
||||||
|
|
||||||
|
@ -852,7 +852,7 @@
|
||||||
art: ULNOAREA
|
art: ULNOAREA
|
||||||
config: {
|
config: {
|
||||||
pause: true
|
pause: true
|
||||||
menuFlags: [ "noHistory", "popParent" ]
|
menuFlags: [ "noHistory" ]
|
||||||
}
|
}
|
||||||
}
|
}
|
||||||
|
|
||||||
|
|
|
@ -776,7 +776,7 @@
|
||||||
key: confTag
|
key: confTag
|
||||||
pause: true
|
pause: true
|
||||||
cls: true
|
cls: true
|
||||||
menuFlags: [ "popParent", "noHistory" ]
|
menuFlags: [ "noHistory" ]
|
||||||
}
|
}
|
||||||
}
|
}
|
||||||
|
|
||||||
|
@ -794,7 +794,7 @@
|
||||||
key: areaTag
|
key: areaTag
|
||||||
pause: true
|
pause: true
|
||||||
cls: true
|
cls: true
|
||||||
menuFlags: [ "popParent", "noHistory" ]
|
menuFlags: [ "noHistory" ]
|
||||||
}
|
}
|
||||||
}
|
}
|
||||||
}
|
}
|
||||||
|
|
Loading…
Reference in New Issue