mail/src/js/app-controller.js

/**
 * The main application controller
 */

'use strict';

var axe = require('axe-logger'),
    Auth = require('./bo/auth'),
    PGP = require('./crypto/pgp'),
    PgpMailer = require('pgpmailer'),
    OAuth = require('./util/oauth'),
    PgpBuilder = require('pgpbuilder'),
    OutboxBO = require('./bo/outbox'),
    mailreader = require('mailreader'),
    ImapClient = require('imap-client'),
    Crypto = require('./crypto/crypto'),
    RestDAO = require('./dao/rest-dao'),
    appConfig = require('./app-config'),
    EmailDAO = require('./dao/email-dao'),
    AdminDao = require('./dao/admin-dao'),
    KeychainDAO = require('./dao/keychain-dao'),
    PublicKeyDAO = require('./dao/publickey-dao'),
    LawnchairDAO = require('./dao/lawnchair-dao'),
    PrivateKeyDAO = require('./dao/privatekey-dao'),
    InvitationDAO = require('./dao/invitation-dao'),
    DeviceStorageDAO = require('./dao/devicestorage-dao'),
    ConnectionDoctor = require('./util/connection-doctor'),
    UpdateHandler = require('./util/update/update-handler'),
    config = appConfig.config,
    str = appConfig.string;

var ctrl = {};

/**
 * Start the application.
 */
ctrl.start = function(options, callback) {
    if (ctrl.started) {
        return callback();
    }

    ctrl.started = true;
    ctrl.onError = options.onError;

    // are we running in a cordova app or in a browser environment?
    if (window.cordova) {
        // wait for 'deviceready' event to make sure plugins are loaded
        axe.debug('Assuming Cordova environment...');
        document.addEventListener("deviceready", onDeviceReady, false);
    } else {
        // No need to wait on events... just start the app
        axe.debug('Assuming Browser environment...');
        onDeviceReady();
    }

    function onDeviceReady() {
        axe.debug('Starting app.');

        ctrl.buildModules();

        // Handle offline and online gracefully
        window.addEventListener('online', ctrl.onConnect.bind(ctrl, ctrl.onError));
        window.addEventListener('offline', ctrl.onDisconnect.bind(ctrl));

        ctrl._appConfigStore.init('app-config', callback);
    }
};

/**
 * Initialize the dependency tree.
 */
ctrl.buildModules = function() {
    var lawnchairDao, restDao, pubkeyDao, privkeyDao, crypto, emailDao, keychain, pgp, userStorage, pgpbuilder, oauth, appConfigStore, auth;

    // start the mailreader's worker thread
    mailreader.startWorker(config.workerPath + '/mailreader-parser-worker.min.js');

    // init objects and inject dependencies
    restDao = new RestDAO();
    lawnchairDao = new LawnchairDAO();
    pubkeyDao = new PublicKeyDAO(restDao);
    privkeyDao = new PrivateKeyDAO(new RestDAO(config.privkeyServerUrl));
    oauth = new OAuth(new RestDAO('https://www.googleapis.com'));

    crypto = new Crypto();
    ctrl._pgp = pgp = new PGP();
    ctrl._keychain = keychain = new KeychainDAO(lawnchairDao, pubkeyDao, privkeyDao, crypto, pgp);
    keychain.requestPermissionForKeyUpdate = function(params, callback) {
        var message = params.newKey ? str.updatePublicKeyMsgNewKey : str.updatePublicKeyMsgRemovedKey;
        message = message.replace('{0}', params.userId);

        ctrl.onError({
            title: str.updatePublicKeyTitle,
            message: message,
            positiveBtnStr: str.updatePublicKeyPosBtn,
            negativeBtnStr: str.updatePublicKeyNegBtn,
            showNegativeBtn: true,
            callback: callback
        });
    };

    ctrl._appConfigStore = appConfigStore = new DeviceStorageDAO(new LawnchairDAO());
    ctrl._auth = auth = new Auth(appConfigStore, oauth, pgp);
    ctrl._userStorage = userStorage = new DeviceStorageDAO(lawnchairDao);
    ctrl._invitationDao = new InvitationDAO(restDao);
    ctrl._pgpbuilder = pgpbuilder = new PgpBuilder();
    ctrl._emailDao = emailDao = new EmailDAO(keychain, pgp, userStorage, pgpbuilder, mailreader);
    ctrl._outboxBo = new OutboxBO(emailDao, keychain, userStorage);
    ctrl._updateHandler = new UpdateHandler(appConfigStore, userStorage, auth);
    ctrl._adminDao = new AdminDao(new RestDAO(config.adminUrl));
    ctrl._doctor = new ConnectionDoctor();

    emailDao.onError = ctrl.onError;
};

/**
 * Calls runtime hooks to check if an app update is available.
 */
ctrl.checkForUpdate = function() {
    ctrl._updateHandler.checkForUpdate(ctrl.onError);
};

/**
 * Instanciate the mail email data access object and its dependencies. Login to imap on init.
 */
ctrl.init = function(options, callback) {
    // init user's local database
    ctrl._userStorage.init(options.emailAddress, function(err) {
        if (err) {
            callback(err);
            return;
        }

        // Migrate the databases if necessary
        ctrl._updateHandler.update(onUpdate);
    });

    function onUpdate(err) {
        if (err) {
            callback({
                errMsg: 'Update failed, please reinstall the app.',
                err: err
            });
            return;
        }

        // account information for the email dao
        var account = {
            realname: options.realname,
            emailAddress: options.emailAddress,
            asymKeySize: config.asymKeySize
        };

        // init email dao
        ctrl._emailDao.init({
            account: account
        }, function(err, keypair) {
            if (err) {
                callback(err);
                return;
            }

            callback(null, keypair);
        });
    }
};

/**
 * Check if the user agent is online.
 */
ctrl.isOnline = function() {
    return navigator.onLine;
};

/**
 * Event handler that is called when the user agent goes offline.
 */
ctrl.onDisconnect = function() {
    ctrl._emailDao.onDisconnect();
};

/**
 * Log the current user out by clear the app config store and deleting instances of imap-client and pgp-mailer.
 */
ctrl.logout = function() {
    // clear app config store
    ctrl._auth.logout(function(err) {
        if (err) {
            ctrl.onError(err);
            return;
        }

        // delete instance of imap-client and pgp-mailer
        ctrl._emailDao.onDisconnect(function(err) {
            if (err) {
                ctrl.onError(err);
                return;
            }

            // navigate to login
            window.location.href = '/';
        });
    });
};

/**
 * Event that is called when the user agent goes online. This create new instances of the imap-client and pgp-mailer and connects to the mail server.
 */
ctrl.onConnect = function(callback) {
    if (!ctrl.isOnline() || !ctrl._emailDao || !ctrl._emailDao._account) {
        // prevent connection infinite loop
        callback();
        return;
    }

    ctrl._auth.getCredentials(function(err, credentials) {
        if (err) {
            callback(err);
            return;
        }

        initClients(credentials);
    });

    function initClients(credentials) {
        // add the maximum update batch size for imap folders to the imap configuration
        credentials.imap.maxUpdateSize = config.imapUpdateBatchSize;

        // tls socket worker path for multithreaded tls in non-native tls environments
        credentials.imap.tlsWorkerPath = credentials.smtp.tlsWorkerPath = config.workerPath + '/tcp-socket-tls-worker.min.js';

        var pgpMailer = new PgpMailer(credentials.smtp, ctrl._pgpbuilder);
        var imapClient = new ImapClient(credentials.imap);
        imapClient.onError = onConnectionError;
        pgpMailer.onError = onConnectionError;

        // certificate update handling
        imapClient.onCert = ctrl._auth.handleCertificateUpdate.bind(ctrl._auth, 'imap', ctrl.onConnect, ctrl.onError);
        pgpMailer.onCert = ctrl._auth.handleCertificateUpdate.bind(ctrl._auth, 'smtp', ctrl.onConnect, ctrl.onError);

        // after-setup configuration depending on the provider:
        // gmail does not require you to upload to the sent items folder
        // after successful sending, whereas most other providers do
        ctrl._emailDao.ignoreUploadOnSent = !!(config[ctrl._auth.provider] && config[ctrl._auth.provider].ignoreUploadOnSent);

        // connect to clients
        ctrl._emailDao.onConnect({
            imapClient: imapClient,
            pgpMailer: pgpMailer
        }, callback);
    }

    function onConnectionError(error) {
        axe.debug('Connection error. Attempting reconnect in ' + config.reconnectInterval + ' ms. Error: ' + (error.errMsg || error.message) + (error.stack ? ('\n' + error.stack) : ''));

        setTimeout(function() {
            axe.debug('Reconnecting...');
            // re-init client modules on error
            ctrl.onConnect(function(err) {
                if (err) {
                    axe.error('Reconnect attempt failed! ' + (err.errMsg || err.message) + (err.stack ? ('\n' + err.stack) : ''));
                    return;
                }

                axe.debug('Reconnect attempt complete.');
            });
        }, config.reconnectInterval);
    }
};

module.exports = ctrl;