Code cleanup, use some defaults

core/download_queue.js

@@ -1,11 +1,12 @@
 /* jslint node: true */
 'use strict';
 
-const FileEntry     = require('./file_entry.js');
+const FileEntry     = require('./file_entry');
-const UserProps     = require('./user_property.js');
+const UserProps     = require('./user_property');
+const Events        = require('./events');
 
 //  deps
-const { partition } = require('lodash');
+const _ = require('lodash');
 
 module.exports = class DownloadQueue {
     constructor(client) {
@@ -20,6 +21,10 @@ module.exports = class DownloadQueue {
         }
     }
 
+    static get(client) {
+        return new DownloadQueue(client);
+    }
+
     get items() {
         return this.client.user.downloadQueue;
     }
@@ -52,7 +57,7 @@ module.exports = class DownloadQueue {
             fileIds = [ fileIds ];
         }
 
-        const [ remain, removed ] = partition(this.client.user.downloadQueue, e => ( -1 === fileIds.indexOf(e.fileId) ));
+        const [ remain, removed ] = _.partition(this.client.user.downloadQueue, e => ( -1 === fileIds.indexOf(e.fileId) ));
         this.client.user.downloadQueue = remain;
         return removed;
     }
@@ -76,4 +81,23 @@ module.exports = class DownloadQueue {
             this.client.log.error( { error : e.message, property : prop }, 'Failed parsing download queue property');
         }
     }
+
+    addTemporaryDownload(entry) {
+        this.add(entry, true);    //  true=systemFile
+
+        //  clean up after ourselves when the session ends
+        const thisClientId = this.client.session.id;
+        Events.once(Events.getSystemEvents().ClientDisconnected, evt => {
+            if(thisClientId === _.get(evt, 'client.session.id')) {
+                FileEntry.removeEntry(entry, { removePhysFile : true }, err => {
+                    const Log = require('./logger').log;
+                    if(err) {
+                        Log.warn( { fileId : entry.fileId, path : outputFileName }, 'Failed removing temporary session download' );
+                    } else {
+                        Log.debug( { fileId : entry.fileId, path : outputFileName }, 'Removed temporary session download item' );
+                    }
+                });
+            }
+        });
+    }
 };

core/file_base_user_list_export.js

@@ -7,8 +7,6 @@ const FileEntry             = require('./file_entry.js');
 const FileArea              = require('./file_base_area.js');
 const { renderSubstr }      = require('./string_util.js');
 const { Errors }            = require('./enig_error.js');
-const Events                = require('./events.js');
-const Log                   = require('./logger.js').log;
 const DownloadQueue         = require('./download_queue.js');
 const { exportFileList }    = require('./file_base_list_export.js');
 
@@ -222,22 +220,7 @@ exports.getModule = class FileBaseListExport extends MenuModule {
                     newEntry.persist(err => {
                         if(!err) {
                             //  queue it!
-                            const dlQueue = new DownloadQueue(self.client);
+                            DownloadQueue.get(self.client).addTemporaryDownload(newEntry);
-                            dlQueue.add(newEntry, true);    //  true=systemFile
-
-                            //  clean up after ourselves when the session ends
-                            const thisClientId = self.client.session.id;
-                            Events.once(Events.getSystemEvents().ClientDisconnected, evt => {
-                                if(thisClientId === _.get(evt, 'client.session.id')) {
-                                    FileEntry.removeEntry(newEntry, { removePhysFile : true }, err => {
-                                        if(err) {
-                                            Log.warn( { fileId : newEntry.fileId, path : outputFileName }, 'Failed removing temporary session download' );
-                                        } else {
-                                            Log.debug( { fileId : newEntry.fileId, path : outputFileName }, 'Removed temporary session download item' );
-                                        }
-                                    });
-                                }
-                            });
                         }
                         return callback(err);
                     });

core/message_base_qwk_export.js

@@ -5,14 +5,15 @@ const { Errors } = require('./enig_error');
 const {
     getMessageAreaByTag,
     hasMessageConfAndAreaRead,
+    getAllAvailableMessageAreaTags,
 } = require('./message_area');
 const FileArea = require('./file_base_area');
 const { QWKPacketWriter } = require('./qwk_mail_packet');
 const { renderSubstr } = require('./string_util');
 const Config = require('./config').get;
 const FileEntry = require('./file_entry');
-const Events = require('./events');
 const DownloadQueue = require('./download_queue');
+const { Log } = require('./logger').log;
 
 //  deps
 const async = require('async');
@@ -85,7 +86,7 @@ exports.getModule = class MessageBaseQWKExport extends MenuModule {
                         });
                     },
                     (sysTempDownloadDir, callback) => {
-                        this.performExport(sysTempDownloadDir, err => {
+                        this._performExport(sysTempDownloadDir, err => {
                             return callback(err);
                         });
                     },
@@ -111,7 +112,41 @@ exports.getModule = class MessageBaseQWKExport extends MenuModule {
         this.prevMenu();
     }
 
-    performExport(sysTempDownloadDir, cb) {
+    _getUserQWKExportOptions() {
+        let qwkOptions = this.client.user.getProperty('qwk_export_options');
+        try {
+            qwkOptions = JSON.parse(qwkOptions);
+        } catch(e) {
+            qwkOptions = {
+                enableQWKE              : true,
+                enableHeadersExtension  : true,
+                enableAtKludges         : true,
+                archiveFormat           : 'application/zip',
+            };
+        }
+        return qwkOptions;
+    }
+
+    _getUserQWKExportAreas() {
+        let qwkExportAreas = this.client.user.getProperty('qwk_export_msg_areas');
+        try {
+            qwkExportAreas = JSON.parse(qwkExportAreas);
+        } catch(e) {
+            //  default to all public and private without 'since'
+            qwkExportAreas = getAllAvailableMessageAreaTags(this.client).map(areaTag => {
+                return { areaTag };
+            });
+
+            //  Include user's private area
+            qwkExportAreas.push({
+                areaTag : Message.WellKnownAreaTags.Private,
+            });
+        }
+
+        return qwkExportAreas;
+    }
+
+    _performExport(sysTempDownloadDir, cb) {
         const statusView = this.viewControllers.main.getView(MciViewIds.main.status);
         const updateStatus = (status) => {
             if (statusView) {
@@ -202,10 +237,12 @@ exports.getModule = class MessageBaseQWKExport extends MenuModule {
             });
         };
 
-        const packetWriter = new QWKPacketWriter({
+        const packetWriter = new QWKPacketWriter(
-            user    : this.client.user,
+            Object.assign(this._getUserQWKExportOptions(), {
-            bbsID   : this.config.bbsID,
+                user    : this.client.user,
-        });   //  :TODO: User configuration here
+                bbsID   : this.config.bbsID,
+            })
+        );
 
         packetWriter.on('warning', warning => {
             this.client.log.warn( { warning }, 'QWK packet writer warning');
@@ -232,26 +269,9 @@ exports.getModule = class MessageBaseQWKExport extends MenuModule {
                     packetWriter.init();
                 },
                 (callback) => {
-                    //
+                    //  For each public area -> for each message
-                    //  Fetch messages for user-configured area tags.
+                    const userExportAreas = this._getUserQWKExportAreas();
-                    //  - If private tag is present, we fetch this separately.
+                    async.eachSeries(userExportAreas, (exportArea, nextExportArea) => {
-                    //  - User property determines newscan timestamps dates if present for tag, else "all"
-                    //  - We have to fetch one area at a time in order to process message pointers/timestamps.
-                    //    ...this also allows for better progress.
-                    //
-                    //  TL;DR: for each area -> for each message
-                    //
-                    const exportAreas = [ //  :TODO: Load in something like this
-                        {
-                            areaTag : 'general',
-                            newerThanTimestamp : '2018-01-01',
-                        },
-                        {
-                            areaTag : 'fsx_gen',
-                        }
-                    ];
-
-                    async.eachSeries(exportAreas, (exportArea, nextExportArea) => {
                         const area = getMessageAreaByTag(exportArea.areaTag);
                         if (!area) {
                             //  :TODO: remove from user properties - this area does not exist
@@ -291,6 +311,8 @@ exports.getModule = class MessageBaseQWKExport extends MenuModule {
                     });
                 },
                 (callback) => {
+                    //  private messages to current user
+                    //  :TODO: Only if user property has private area tag
                     const filter = {
                         resultType          : 'id',
                         privateTagUserId    : this.client.user.userId,
@@ -339,23 +361,7 @@ exports.getModule = class MessageBaseQWKExport extends MenuModule {
                     newEntry.persist(err => {
                         if(!err) {
                             //  queue it!
-                            const dlQueue = new DownloadQueue(this.client);
+                            DownloadQueue.get(this.client).addTemporaryDownload(newEntry);
-                            dlQueue.add(newEntry, true);    //  true=systemFile
-
-                            //  clean up after ourselves when the session ends
-                            //  :TODO: DRY this with that in file_base_user_export
-                            const thisClientId = this.client.session.id;
-                            Events.once(Events.getSystemEvents().ClientDisconnected, evt => {
-                                if(thisClientId === _.get(evt, 'client.session.id')) {
-                                    FileEntry.removeEntry(newEntry, { removePhysFile : true }, err => {
-                                        if(err) {
-                                            Log.warn( { fileId : newEntry.fileId, path : outputFileName }, 'Failed removing temporary session download' );
-                                        } else {
-                                            Log.debug( { fileId : newEntry.fileId, path : outputFileName }, 'Removed temporary session download item' );
-                                        }
-                                    });
-                                }
-                            });
                         }
                         return callback(err);
                     });
@@ -369,8 +375,6 @@ exports.getModule = class MessageBaseQWKExport extends MenuModule {
                     updateStatus('A QWK packet has been placed in your download queue');
                 }
 
-                //  :TODO: send user to download manager with pop flags/etc.
-
                 return cb(err);
             }
         );

core/user_property.js

@@ -29,7 +29,7 @@ module.exports = {
     UserComment                     : 'user_comment',               //  NYI
     AutoSignature                   : 'auto_signature',
 
-    DownloadQueue                   : 'dl_queue',                   // download_queue.js
+    DownloadQueue                   : 'dl_queue',                   // see download_queue.js
 
     FailedLoginAttempts             : 'failed_login_attempts',
     AccountLockedTs                 : 'account_locked_timestamp',
@@ -64,5 +64,6 @@ module.exports = {
     AuthFactor2OTP                  : 'auth_factor2_otp',           //  If present, OTP type for 2FA. See OTPTypes
     AuthFactor2OTPSecret            : 'auth_factor2_otp_secret',    //  Secret used in conjunction with OTP 2FA
     AuthFactor2OTPBackupCodes       : 'auth_factor2_otp_backup',    //  JSON array of backup codes
+
 };