First pass formatting with Prettier
* Added .prettierrc.json * Added .prettierignore * Formatted
This commit is contained in:
Bryan Ashby
229
core/new_scan.js
229
core/new_scan.js
@@ -2,24 +2,24 @@
|
||||
'use strict';
|
||||
|
||||
// ENiGMA½
|
||||
const msgArea = require('./message_area.js');
|
||||
const MenuModule = require('./menu_module.js').MenuModule;
|
||||
const ViewController = require('./view_controller.js').ViewController;
|
||||
const stringFormat = require('./string_format.js');
|
||||
const FileEntry = require('./file_entry.js');
|
||||
const FileBaseFilters = require('./file_base_filter.js');
|
||||
const Errors = require('./enig_error.js').Errors;
|
||||
const { getAvailableFileAreaTags } = require('./file_base_area.js');
|
||||
const { valueAsArray } = require('./misc_util.js');
|
||||
const msgArea = require('./message_area.js');
|
||||
const MenuModule = require('./menu_module.js').MenuModule;
|
||||
const ViewController = require('./view_controller.js').ViewController;
|
||||
const stringFormat = require('./string_format.js');
|
||||
const FileEntry = require('./file_entry.js');
|
||||
const FileBaseFilters = require('./file_base_filter.js');
|
||||
const Errors = require('./enig_error.js').Errors;
|
||||
const { getAvailableFileAreaTags } = require('./file_base_area.js');
|
||||
const { valueAsArray } = require('./misc_util.js');
|
||||
|
||||
// deps
|
||||
const _ = require('lodash');
|
||||
const async = require('async');
|
||||
const _ = require('lodash');
|
||||
const async = require('async');
|
||||
|
||||
exports.moduleInfo = {
|
||||
name : 'New Scan',
|
||||
desc : 'Performs a new scan against various areas of the system',
|
||||
author : 'NuSkooler',
|
||||
name: 'New Scan',
|
||||
desc: 'Performs a new scan against various areas of the system',
|
||||
author: 'NuSkooler',
|
||||
};
|
||||
|
||||
/*
|
||||
@@ -31,34 +31,33 @@ exports.moduleInfo = {
|
||||
*/
|
||||
|
||||
const MciCodeIds = {
|
||||
ScanStatusLabel : 1, // TL1
|
||||
ScanStatusList : 2, // VM2 (appends)
|
||||
ScanStatusLabel: 1, // TL1
|
||||
ScanStatusList: 2, // VM2 (appends)
|
||||
};
|
||||
|
||||
const Steps = {
|
||||
MessageConfs : 'messageConferences',
|
||||
FileBase : 'fileBase',
|
||||
MessageConfs: 'messageConferences',
|
||||
FileBase: 'fileBase',
|
||||
|
||||
Finished : 'finished',
|
||||
Finished: 'finished',
|
||||
};
|
||||
|
||||
exports.getModule = class NewScanModule extends MenuModule {
|
||||
constructor(options) {
|
||||
super(options);
|
||||
|
||||
this.newScanFullExit = _.get(options, 'lastMenuResult.fullExit', false);
|
||||
|
||||
this.newScanFullExit = _.get(options, 'lastMenuResult.fullExit', false);
|
||||
|
||||
this.currentStep = Steps.MessageConfs;
|
||||
this.currentScanAux = {};
|
||||
this.currentStep = Steps.MessageConfs;
|
||||
this.currentScanAux = {};
|
||||
|
||||
// :TODO: Make this conf/area specific:
|
||||
// :TODO: Use newer custom info format - TL10+
|
||||
const config = this.menuConfig.config;
|
||||
this.scanStartFmt = config.scanStartFmt || 'Scanning {confName} - {areaName}...';
|
||||
this.scanFinishNoneFmt = config.scanFinishNoneFmt || 'Nothing new';
|
||||
this.scanFinishNewFmt = config.scanFinishNewFmt || '{count} entries found';
|
||||
this.scanCompleteMsg = config.scanCompleteMsg || 'Finished newscan';
|
||||
const config = this.menuConfig.config;
|
||||
this.scanStartFmt = config.scanStartFmt || 'Scanning {confName} - {areaName}...';
|
||||
this.scanFinishNoneFmt = config.scanFinishNoneFmt || 'Nothing new';
|
||||
this.scanFinishNewFmt = config.scanFinishNewFmt || '{count} entries found';
|
||||
this.scanCompleteMsg = config.scanCompleteMsg || 'Finished newscan';
|
||||
}
|
||||
|
||||
updateScanStatus(statusText) {
|
||||
@@ -67,15 +66,18 @@ exports.getModule = class NewScanModule extends MenuModule {
|
||||
|
||||
newScanMessageConference(cb) {
|
||||
// lazy init
|
||||
if(!this.sortedMessageConfs) {
|
||||
const getAvailOpts = { includeSystemInternal : true }; // find new private messages, bulletins, etc.
|
||||
if (!this.sortedMessageConfs) {
|
||||
const getAvailOpts = { includeSystemInternal: true }; // find new private messages, bulletins, etc.
|
||||
|
||||
this.sortedMessageConfs = _.map(msgArea.getAvailableMessageConferences(this.client, getAvailOpts), (v, k) => {
|
||||
return {
|
||||
confTag : k,
|
||||
conf : v,
|
||||
};
|
||||
});
|
||||
this.sortedMessageConfs = _.map(
|
||||
msgArea.getAvailableMessageConferences(this.client, getAvailOpts),
|
||||
(v, k) => {
|
||||
return {
|
||||
confTag: k,
|
||||
conf: v,
|
||||
};
|
||||
}
|
||||
);
|
||||
|
||||
//
|
||||
// Sort conferences by name, other than 'system_internal' which should
|
||||
@@ -83,10 +85,13 @@ exports.getModule = class NewScanModule extends MenuModule {
|
||||
// other conferences & areas
|
||||
//
|
||||
this.sortedMessageConfs.sort((a, b) => {
|
||||
if('system_internal' === a.confTag) {
|
||||
if ('system_internal' === a.confTag) {
|
||||
return -1;
|
||||
} else {
|
||||
return a.conf.name.localeCompare(b.conf.name, { sensitivity : false, numeric : true } );
|
||||
return a.conf.name.localeCompare(b.conf.name, {
|
||||
sensitivity: false,
|
||||
numeric: true,
|
||||
});
|
||||
}
|
||||
});
|
||||
|
||||
@@ -97,11 +102,11 @@ exports.getModule = class NewScanModule extends MenuModule {
|
||||
const currentConf = this.sortedMessageConfs[this.currentScanAux.conf];
|
||||
|
||||
this.newScanMessageArea(currentConf, () => {
|
||||
if(this.sortedMessageConfs.length > this.currentScanAux.conf + 1) {
|
||||
if (this.sortedMessageConfs.length > this.currentScanAux.conf + 1) {
|
||||
this.currentScanAux.conf += 1;
|
||||
this.currentScanAux.area = 0;
|
||||
|
||||
return this.newScanMessageConference(cb); // recursive to next conf
|
||||
return this.newScanMessageConference(cb); // recursive to next conf
|
||||
}
|
||||
|
||||
this.updateScanStatus(this.scanCompleteMsg);
|
||||
@@ -111,10 +116,14 @@ exports.getModule = class NewScanModule extends MenuModule {
|
||||
|
||||
newScanMessageArea(conf, cb) {
|
||||
// :TODO: it would be nice to cache this - must be done by conf!
|
||||
const omitMessageAreaTags = valueAsArray(_.get(this, 'menuConfig.config.omitMessageAreaTags', []));
|
||||
const sortedAreas = msgArea.getSortedAvailMessageAreasByConfTag(conf.confTag, { client : this.client } ).filter(area => {
|
||||
return !omitMessageAreaTags.includes(area.areaTag);
|
||||
});
|
||||
const omitMessageAreaTags = valueAsArray(
|
||||
_.get(this, 'menuConfig.config.omitMessageAreaTags', [])
|
||||
);
|
||||
const sortedAreas = msgArea
|
||||
.getSortedAvailMessageAreasByConfTag(conf.confTag, { client: this.client })
|
||||
.filter(area => {
|
||||
return !omitMessageAreaTags.includes(area.areaTag);
|
||||
});
|
||||
const currentArea = sortedAreas[this.currentScanAux.area];
|
||||
|
||||
//
|
||||
@@ -126,43 +135,50 @@ exports.getModule = class NewScanModule extends MenuModule {
|
||||
[
|
||||
function checkAndUpdateIndex(callback) {
|
||||
// Advance to next area if possible
|
||||
if(sortedAreas.length >= self.currentScanAux.area + 1) {
|
||||
if (sortedAreas.length >= self.currentScanAux.area + 1) {
|
||||
self.currentScanAux.area += 1;
|
||||
return callback(null);
|
||||
} else {
|
||||
self.updateScanStatus(self.scanCompleteMsg);
|
||||
return callback(Errors.DoesNotExist('No more areas')); // this will stop our scan
|
||||
return callback(Errors.DoesNotExist('No more areas')); // this will stop our scan
|
||||
}
|
||||
},
|
||||
function updateStatusScanStarted(callback) {
|
||||
self.updateScanStatus(stringFormat(self.scanStartFmt, {
|
||||
confName : conf.conf.name,
|
||||
confDesc : conf.conf.desc,
|
||||
areaName : currentArea.area.name,
|
||||
areaDesc : currentArea.area.desc
|
||||
}));
|
||||
self.updateScanStatus(
|
||||
stringFormat(self.scanStartFmt, {
|
||||
confName: conf.conf.name,
|
||||
confDesc: conf.conf.desc,
|
||||
areaName: currentArea.area.name,
|
||||
areaDesc: currentArea.area.desc,
|
||||
})
|
||||
);
|
||||
return callback(null);
|
||||
},
|
||||
function getNewMessagesCountInArea(callback) {
|
||||
msgArea.getNewMessageCountInAreaForUser(
|
||||
self.client.user.userId, currentArea.areaTag, (err, newMessageCount) => {
|
||||
self.client.user.userId,
|
||||
currentArea.areaTag,
|
||||
(err, newMessageCount) => {
|
||||
callback(err, newMessageCount);
|
||||
}
|
||||
);
|
||||
},
|
||||
function displayMessageList(newMessageCount) {
|
||||
if(newMessageCount <= 0) {
|
||||
return self.newScanMessageArea(conf, cb); // next area, if any
|
||||
if (newMessageCount <= 0) {
|
||||
return self.newScanMessageArea(conf, cb); // next area, if any
|
||||
}
|
||||
|
||||
const nextModuleOpts = {
|
||||
extraArgs: {
|
||||
messageAreaTag : currentArea.areaTag,
|
||||
}
|
||||
messageAreaTag: currentArea.areaTag,
|
||||
},
|
||||
};
|
||||
|
||||
return self.gotoMenu(self.menuConfig.config.newScanMessageList || 'newScanMessageList', nextModuleOpts);
|
||||
}
|
||||
return self.gotoMenu(
|
||||
self.menuConfig.config.newScanMessageList || 'newScanMessageList',
|
||||
nextModuleOpts
|
||||
);
|
||||
},
|
||||
],
|
||||
err => {
|
||||
return cb(err);
|
||||
@@ -172,78 +188,90 @@ exports.getModule = class NewScanModule extends MenuModule {
|
||||
|
||||
newScanFileBase(cb) {
|
||||
// :TODO: add in steps
|
||||
const omitFileAreaTags = valueAsArray(_.get(this, 'menuConfig.config.omitFileAreaTags', []));
|
||||
const omitFileAreaTags = valueAsArray(
|
||||
_.get(this, 'menuConfig.config.omitFileAreaTags', [])
|
||||
);
|
||||
const filterCriteria = {
|
||||
newerThanFileId : FileBaseFilters.getFileBaseLastViewedFileIdByUser(this.client.user),
|
||||
areaTag : getAvailableFileAreaTags(this.client).filter(ft => !omitFileAreaTags.includes(ft)),
|
||||
order : 'ascending', // oldest first
|
||||
newerThanFileId: FileBaseFilters.getFileBaseLastViewedFileIdByUser(
|
||||
this.client.user
|
||||
),
|
||||
areaTag: getAvailableFileAreaTags(this.client).filter(
|
||||
ft => !omitFileAreaTags.includes(ft)
|
||||
),
|
||||
order: 'ascending', // oldest first
|
||||
};
|
||||
|
||||
FileEntry.findFiles(
|
||||
filterCriteria,
|
||||
(err, fileIds) => {
|
||||
if(err || 0 === fileIds.length) {
|
||||
return cb(err ? err : Errors.DoesNotExist('No more new files'));
|
||||
}
|
||||
|
||||
FileBaseFilters.setFileBaseLastViewedFileIdForUser( this.client.user, fileIds[fileIds.length - 1] );
|
||||
|
||||
const menuOpts = {
|
||||
extraArgs : {
|
||||
fileList : fileIds,
|
||||
},
|
||||
};
|
||||
|
||||
return this.gotoMenu(this.menuConfig.config.newScanFileBaseList || 'newScanFileBaseList', menuOpts);
|
||||
FileEntry.findFiles(filterCriteria, (err, fileIds) => {
|
||||
if (err || 0 === fileIds.length) {
|
||||
return cb(err ? err : Errors.DoesNotExist('No more new files'));
|
||||
}
|
||||
);
|
||||
|
||||
FileBaseFilters.setFileBaseLastViewedFileIdForUser(
|
||||
this.client.user,
|
||||
fileIds[fileIds.length - 1]
|
||||
);
|
||||
|
||||
const menuOpts = {
|
||||
extraArgs: {
|
||||
fileList: fileIds,
|
||||
},
|
||||
};
|
||||
|
||||
return this.gotoMenu(
|
||||
this.menuConfig.config.newScanFileBaseList || 'newScanFileBaseList',
|
||||
menuOpts
|
||||
);
|
||||
});
|
||||
}
|
||||
|
||||
getSaveState() {
|
||||
return {
|
||||
currentStep : this.currentStep,
|
||||
currentScanAux : this.currentScanAux,
|
||||
currentStep: this.currentStep,
|
||||
currentScanAux: this.currentScanAux,
|
||||
};
|
||||
}
|
||||
|
||||
restoreSavedState(savedState) {
|
||||
this.currentStep = savedState.currentStep;
|
||||
this.currentStep = savedState.currentStep;
|
||||
this.currentScanAux = savedState.currentScanAux;
|
||||
}
|
||||
|
||||
performScanCurrentStep(cb) {
|
||||
switch(this.currentStep) {
|
||||
case Steps.MessageConfs :
|
||||
this.newScanMessageConference( () => {
|
||||
switch (this.currentStep) {
|
||||
case Steps.MessageConfs:
|
||||
this.newScanMessageConference(() => {
|
||||
this.currentStep = Steps.FileBase;
|
||||
return this.performScanCurrentStep(cb);
|
||||
});
|
||||
break;
|
||||
|
||||
case Steps.FileBase :
|
||||
this.newScanFileBase( () => {
|
||||
case Steps.FileBase:
|
||||
this.newScanFileBase(() => {
|
||||
this.currentStep = Steps.Finished;
|
||||
return this.performScanCurrentStep(cb);
|
||||
});
|
||||
break;
|
||||
|
||||
default : return cb(null);
|
||||
default:
|
||||
return cb(null);
|
||||
}
|
||||
}
|
||||
|
||||
mciReady(mciData, cb) {
|
||||
if(this.newScanFullExit) {
|
||||
if (this.newScanFullExit) {
|
||||
// user has canceled the entire scan @ message list view
|
||||
return cb(null);
|
||||
}
|
||||
|
||||
super.mciReady(mciData, err => {
|
||||
if(err) {
|
||||
if (err) {
|
||||
return cb(err);
|
||||
}
|
||||
|
||||
const self = this;
|
||||
const vc = self.viewControllers.allViews = new ViewController( { client : self.client } );
|
||||
const self = this;
|
||||
const vc = (self.viewControllers.allViews = new ViewController({
|
||||
client: self.client,
|
||||
}));
|
||||
|
||||
// :TODO: display scan step/etc.
|
||||
|
||||
@@ -251,20 +279,23 @@ exports.getModule = class NewScanModule extends MenuModule {
|
||||
[
|
||||
function loadFromConfig(callback) {
|
||||
const loadOpts = {
|
||||
callingMenu : self,
|
||||
mciMap : mciData.menu,
|
||||
noInput : true,
|
||||
callingMenu: self,
|
||||
mciMap: mciData.menu,
|
||||
noInput: true,
|
||||
};
|
||||
|
||||
vc.loadFromMenuConfig(loadOpts, callback);
|
||||
},
|
||||
function performCurrentStepScan(callback) {
|
||||
return self.performScanCurrentStep(callback);
|
||||
}
|
||||
},
|
||||
],
|
||||
err => {
|
||||
if(err) {
|
||||
self.client.log.error( { error : err.toString() }, 'Error during new scan');
|
||||
if (err) {
|
||||
self.client.log.error(
|
||||
{ error: err.toString() },
|
||||
'Error during new scan'
|
||||
);
|
||||
}
|
||||
return cb(err);
|
||||
}
|
||||
|
||||
Reference in New Issue
Block a user