emailengine-app 2.68.1 → 2.70.0

package/lib/ui-routes/account-routes.js

@@ -1,205 +1,43 @@
 'use strict';
 
-const Boom = require('@hapi/boom');
+// Admin UI routes for account management: /admin/accounts (listing), /admin/accounts/new and
+// /accounts/new* (the add-account wizard incl. IMAP autoconfig/test/server steps), and
+// /admin/accounts/{account}* (view, edit, delete, reconnect, sync, logs, browse). Extracted
+// verbatim from lib/routes-ui.js. DISABLE_MESSAGE_BROWSER and the getMailboxListing helper move
+// with the routes (only these account pages use them).
+
 const Joi = require('joi');
 const crypto = require('crypto');
-const util = require('util');
-const psl = require('psl');
+const Boom = require('@hapi/boom');
 
 const settings = require('../settings');
+const consts = require('../consts');
 const tokens = require('../tokens');
 const { redis, documentsQueue } = require('../db');
+const getSecret = require('../get-secret');
+const capa = require('../capa');
+const { Account } = require('../account');
+const { Gateway } = require('../gateway');
+const { autodetectImapSettings } = require('../autodetect-imap-settings');
+const { oauth2Apps, oauth2ProviderData, SERVICE_ACCOUNT_PROVIDERS } = require('../oauth2-apps');
 const {
-    failAction,
-    verifyAccountInfo,
-    getLogs,
-    flattenObjectKeys,
-    getSignedFormData,
     getServiceHostname,
+    getSignedFormData,
     parseSignedFormData,
+    getLogs,
+    verifyAccountInfo,
+    flattenObjectKeys,
     getBoolean,
-    readEnvValue
+    readEnvValue,
+    failAction
 } = require('../tools');
-const { Account } = require('../account');
-const { Gateway } = require('../gateway');
-const { oauth2Apps, oauth2ProviderData, SERVICE_ACCOUNT_PROVIDERS } = require('../oauth2-apps');
-const { autodetectImapSettings } = require('../autodetect-imap-settings');
-const getSecret = require('../get-secret');
-const capa = require('../capa');
-const consts = require('../consts');
-const { settingsSchema, accountIdSchema, defaultAccountTypeSchema } = require('../schemas');
-const fs = require('fs');
-const pathlib = require('path');
+const { settingsSchema, accountIdSchema, defaultAccountTypeSchema, ACCOUNT_DISPLAY_STATES } = require('../schemas');
+const { formatAccountData, cachedTemplates } = require('./route-helpers');
 
-const { DEFAULT_MAX_LOG_LINES, DEFAULT_PAGE_SIZE, REDIS_PREFIX, MAX_FORM_TTL, NONCE_BYTES } = consts;
+const { REDIS_PREFIX, DEFAULT_PAGE_SIZE, NONCE_BYTES, MAX_FORM_TTL, DEFAULT_MAX_LOG_LINES } = consts;
 
 const DISABLE_MESSAGE_BROWSER = getBoolean(readEnvValue('EENGINE_DISABLE_MESSAGE_BROWSER'));
 
-const cachedTemplates = {
-    testSend: fs.readFileSync(pathlib.join(__dirname, '..', '..', 'views', 'partials', 'test_send.hbs'), 'utf-8')
-};
-
-function formatAccountData(account, gt) {
-    account.type = {};
-
-    if (account.oauth2 && account.oauth2.app) {
-        let providerData = oauth2ProviderData(account.oauth2.app.provider);
-        account.type = providerData;
-    } else if (account.oauth2 && account.oauth2.provider) {
-        account.type = oauth2ProviderData(account.oauth2.provider);
-    } else if (account.imap && !account.imap.disabled) {
-        account.type.icon = 'fa fa-envelope-square';
-        account.type.name = 'IMAP';
-        account.type.comment = psl.get(account.imap.host) || account.imap.host;
-    } else if (account.smtp) {
-        account.type.icon = 'fa fa-paper-plane';
-        account.type.name = 'SMTP';
-        account.type.comment = psl.get(account.smtp.host) || account.smtp.host;
-    } else if (account.oauth2 && account.oauth2.auth && account.oauth2.auth.delegatedAccount) {
-        account.type.icon = 'fa fa-arrow-alt-circle-right';
-        account.type.name = gt.gettext('Delegated');
-        account.type.comment = util.format(gt.gettext('Using credentials from "%s"'), account.oauth2.auth.delegatedAccount);
-    } else {
-        account.type.name = 'N/A';
-    }
-
-    switch (account.state) {
-        case 'init':
-            account.stateLabel = {
-                type: 'info',
-                name: 'Initializing',
-                spinner: true
-            };
-            break;
-
-        case 'connecting':
-            account.stateLabel = {
-                type: 'info',
-                name: 'Connecting'
-            };
-            break;
-
-        case 'syncing':
-            account.stateLabel = {
-                type: 'info',
-                name: 'Syncing',
-                spinner: true
-            };
-            break;
-
-        case 'connected':
-            account.stateLabel = {
-                type: 'success',
-                name: 'Connected'
-            };
-            break;
-
-        case 'disabled':
-            account.stateLabel = {
-                type: 'secondary',
-                name: 'Disabled',
-                error: account.disabledReason
-            };
-            break;
-
-        case 'authenticationError':
-        case 'connectError': {
-            let errorMessage = account.lastErrorState ? account.lastErrorState.response : false;
-            if (account.lastErrorState) {
-                switch (account.lastErrorState.serverResponseCode) {
-                    case 'ETIMEDOUT':
-                        errorMessage = gt.gettext('Connection timed out. This usually occurs if you are behind a firewall or connecting to the wrong port.');
-                        break;
-                    case 'ClosedAfterConnectTLS':
-                        errorMessage = gt.gettext('The server unexpectedly closed the connection.');
-                        break;
-                    case 'ClosedAfterConnectText':
-                        errorMessage = gt.gettext(
-                            'The server unexpectedly closed the connection. This usually happens when attempting to connect to a TLS port without TLS enabled.'
-                        );
-                        break;
-                    case 'ECONNREFUSED':
-                        errorMessage = gt.gettext(
-                            'The server refused the connection. This typically occurs if the server is not running, is overloaded, or you are connecting to the wrong host or port.'
-                        );
-                        break;
-                }
-            }
-
-            account.stateLabel = {
-                type: 'danger',
-                name: 'Failed',
-                error: errorMessage
-            };
-            break;
-        }
-        case 'unset':
-            account.stateLabel = {
-                type: 'light',
-                name: 'Not syncing'
-            };
-            break;
-        case 'disconnected':
-            account.stateLabel = {
-                type: 'warning',
-                name: 'Disconnected'
-            };
-            break;
-        case 'paused':
-            account.stateLabel = {
-                type: 'secondary',
-                name: 'Paused'
-            };
-            break;
-        default:
-            account.stateLabel = {
-                type: 'secondary',
-                name: 'N/A'
-            };
-            break;
-    }
-
-    // Check if IMAP was disabled due to errors - override state label to show error
-    if (account.imap && account.imap.disabled && account.lastErrorState) {
-        account.stateLabel = {
-            type: 'danger',
-            name: 'Failed',
-            error: account.lastErrorState.description || account.lastErrorState.response
-        };
-    }
-
-    if (account.oauth2) {
-        account.oauth2.scopes = []
-            .concat(account.oauth2.scope || [])
-            .concat(account.oauth2.scopes || [])
-            .flatMap(entry => entry.split(/\s+/))
-            .map(entry => entry.trim())
-            .filter(entry => entry);
-
-        account.oauth2.expiresStr = account.oauth2.expires ? account.oauth2.expires.toISOString() : false;
-        account.oauth2.generatedStr = account.oauth2.generated ? account.oauth2.generated.toISOString() : false;
-
-        if (account.outlookSubscription) {
-            account.outlookSubscription.subscriptionExpiresStr = account.outlookSubscription.expirationDateTime
-                ? account.outlookSubscription.expirationDateTime.toISOString()
-                : false;
-
-            let state = account.outlookSubscription.state || {};
-
-            account.outlookSubscription.isValid =
-                state.state !== 'error' && account.outlookSubscription.expirationDateTime && account.outlookSubscription.expirationDateTime > new Date();
-
-            account.outlookSubscription.stateLabel = (state.state || '').replace(/^./, c => c.toUpperCase());
-
-            if ((state.state === 'created' && !account.outlookSubscription.expirationDateTime) || account.outlookSubscription.expirationDateTime < new Date()) {
-                account.outlookSubscription.stateLabel = 'Expired';
-            }
-        }
-    }
-
-    return account;
-}
-
 async function getMailboxListing(accountObject) {
     let mailboxes = [
         {
@@ -229,7 +67,7 @@ async function getMailboxListing(accountObject) {
             return a.path.toLowerCase().localeCompare(b.path.toLowerCase());
         });
     } catch (err) {
-        // ignore
+        // failed to get mailbox list
     }
 
     return mailboxes;
@@ -238,7 +76,6 @@ async function getMailboxListing(accountObject) {
 function init(args) {
     const { server, call } = args;
 
-    // Account listing route
     server.route({
         method: 'GET',
         path: '/admin/accounts',
@@ -256,14 +93,21 @@ function init(args) {
             }
 
             for (let account of accounts.accounts) {
-                let accountObj = new Account({ redis, account: account.account });
-                account.data = await accountObj.loadAccountData(null, null, runIndex);
+                let accountObject = new Account({ redis, account: account.account });
+                try {
+                    account.data = await accountObject.loadAccountData(null, null, runIndex);
 
-                if (account.data && account.data.oauth2 && account.data.oauth2.provider) {
-                    let oauth2App = await oauth2Apps.get(account.data.oauth2.provider);
-                    if (oauth2App) {
-                        account.data.oauth2.app = oauth2App;
+                    if (account.data && account.data.oauth2 && account.data.oauth2.provider) {
+                        let oauth2App = await oauth2Apps.get(account.data.oauth2.provider);
+                        if (oauth2App) {
+                            account.data.oauth2.app = oauth2App;
+                        }
                     }
+                } catch (err) {
+                    // Account has invalid config (e.g., broken delegation)
+                    account.data = {
+                        delegationError: err.message
+                    };
                 }
             }
 
@@ -333,6 +177,11 @@ function init(args) {
                     label: 'Disconnected'
                 },
 
+                {
+                    state: 'paused',
+                    label: 'Paused'
+                },
+
                 {
                     state: 'authenticationError',
                     label: 'Authentication failed'
@@ -365,7 +214,7 @@ function init(args) {
                     selectedState: stateOptions.find(entry => entry.state && entry.state === request.query.state),
 
                     searchTarget: '/admin/accounts',
-                    searchPlaceholder: 'Search for accounts...',
+                    searchPlaceholder: 'Search for accounts…',
 
                     showPaging: accounts.pages > 1,
                     nextPage,
@@ -406,7 +255,7 @@ function init(args) {
                     state: Joi.string()
                         .trim()
                         .empty('')
-                        .valid('init', 'syncing', 'connecting', 'connected', 'authenticationError', 'connectError', 'unset', 'disconnected')
+                        .valid(...ACCOUNT_DISPLAY_STATES)
                         .example('connected')
                         .description('Filter accounts by state')
                         .label('AccountState')
@@ -415,7 +264,6 @@ function init(args) {
         }
     });
 
-    // New account POST handler
     server.route({
         method: 'POST',
         path: '/admin/accounts/new',
@@ -566,7 +414,6 @@ function init(args) {
         );
     }
 
-    // Public GET new account form
     server.route({
         method: 'GET',
         path: '/accounts/new',
@@ -628,7 +475,6 @@ function init(args) {
         }
     });
 
-    // Public POST new account form
     server.route({
         method: 'POST',
         path: '/accounts/new',
@@ -669,7 +515,6 @@ function init(args) {
         }
     });
 
-    // IMAP account setup form
     server.route({
         method: 'POST',
         path: '/accounts/new/imap',
@@ -772,7 +617,6 @@ function init(args) {
         }
     });
 
-    // Test IMAP settings
     server.route({
         method: 'POST',
         path: '/accounts/new/imap/test',
@@ -924,7 +768,6 @@ function init(args) {
         }
     });
 
-    // Submit IMAP server settings
     server.route({
         method: 'POST',
         path: '/accounts/new/imap/server',
@@ -1097,7 +940,6 @@ function init(args) {
         }
     });
 
-    // View account details
     server.route({
         method: 'GET',
         path: '/admin/accounts/{account}',
@@ -1327,7 +1169,6 @@ function init(args) {
         }
     });
 
-    // Delete account
     server.route({
         method: 'POST',
         path: '/admin/accounts/{account}/delete',
@@ -1369,7 +1210,6 @@ function init(args) {
         }
     });
 
-    // Reconnect account
     server.route({
         method: 'POST',
         path: '/admin/accounts/{account}/reconnect',
@@ -1408,7 +1248,6 @@ function init(args) {
         }
     });
 
-    // Sync account
     server.route({
         method: 'POST',
         path: '/admin/accounts/{account}/sync',
@@ -1447,7 +1286,6 @@ function init(args) {
         }
     });
 
-    // Toggle account logs
     server.route({
         method: 'POST',
         path: '/admin/accounts/{account}/logs',
@@ -1495,7 +1333,6 @@ function init(args) {
         }
     });
 
-    // Flush account logs
     server.route({
         method: 'POST',
         path: '/admin/accounts/{account}/logs-flush',
@@ -1532,7 +1369,6 @@ function init(args) {
         }
     });
 
-    // Get account logs as text
     server.route({
         method: 'GET',
         path: '/admin/accounts/{account}/logs.txt',
@@ -1556,7 +1392,6 @@ function init(args) {
         }
     });
 
-    // Browse account messages
     server.route({
         method: 'GET',
         path: '/admin/accounts/{account}/browse',
@@ -1573,7 +1408,7 @@ function init(args) {
                 if (request.cookieAuth) {
                     request.cookieAuth.clear();
                 }
-                await request.flash({ type: 'info', message: `Sign in again to continue` });
+                await request.flash({ type: 'info', message: `Sign in again to continue.` });
                 return h.redirect('/admin/login?next=' + encodeURIComponent('/admin/accounts/{account}/browse'));
             }
 
@@ -1635,7 +1470,6 @@ function init(args) {
         }
     });
 
-    // Edit account (GET)
     server.route({
         method: 'GET',
         path: '/admin/accounts/{account}/edit',
@@ -1715,7 +1549,6 @@ function init(args) {
         }
     });
 
-    // Edit account (POST)
     server.route({
         method: 'POST',
         path: '/admin/accounts/{account}/edit',