Add 1.0.1 changes

Fixes #383

CHANGES

@@ -888,6 +888,9 @@
 [1.0.0]
 * Make selfhosting great again
 
+[1.0.1]
+* Notification improvements
+
 [1.1.0]
 * Add support for email catch-all
 * Support Cloudrons on subdomains

src/appstore.js

@@ -17,6 +17,7 @@ exports = module.exports = {
 var assert = require('assert'),
     config = require('./config.js'),
     debug = require('debug')('box:appstore'),
+    eventlog = require('./eventlog.js'),
     os = require('os'),
     settings = require('./settings.js'),
     superagent = require('superagent'),
@@ -149,45 +150,52 @@ function sendAliveStatus(data, callback) {
     settings.getAll(function (error, result) {
         if (error) return callback(new AppstoreError(AppstoreError.INTERNAL_ERROR, error));
 
-        var backendSettings = {
-            dnsConfig: {
-                provider: result[settings.DNS_CONFIG_KEY].provider,
-                wildcard: result[settings.DNS_CONFIG_KEY].provider === 'manual' ? result[settings.DNS_CONFIG_KEY].wildcard : undefined
-            },
-            tlsConfig: {
-                provider: result[settings.TLS_CONFIG_KEY].provider
-            },
-            backupConfig: {
-                provider: result[settings.BACKUP_CONFIG_KEY].provider
-            },
-            mailConfig: {
-                enabled: result[settings.MAIL_CONFIG_KEY].enabled
-            },
-            autoupdatePattern: result[settings.AUTOUPDATE_PATTERN_KEY],
-            timeZone: result[settings.TIME_ZONE_KEY]
-        };
+        eventlog.getAllPaged(eventlog.ACTION_USER_LOGIN, null, 1, 1, function (error, loginEvents) {
+            if (error) return callback(new AppstoreError(AppstoreError.INTERNAL_ERROR, error));
 
-        var data = {
-            domain: config.fqdn(),
-            version: config.version(),
-            provider: config.provider(),
-            backendSettings: backendSettings,
-            machine: {
-                cpus: os.cpus(),
-                totalmem: os.totalmem()
-            }
-        };
+            var backendSettings = {
+                dnsConfig: {
+                    provider: result[settings.DNS_CONFIG_KEY].provider,
+                    wildcard: result[settings.DNS_CONFIG_KEY].provider === 'manual' ? result[settings.DNS_CONFIG_KEY].wildcard : undefined
+                },
+                tlsConfig: {
+                    provider: result[settings.TLS_CONFIG_KEY].provider
+                },
+                backupConfig: {
+                    provider: result[settings.BACKUP_CONFIG_KEY].provider
+                },
+                mailConfig: {
+                    enabled: result[settings.MAIL_CONFIG_KEY].enabled
+                },
+                autoupdatePattern: result[settings.AUTOUPDATE_PATTERN_KEY],
+                timeZone: result[settings.TIME_ZONE_KEY],
+            };
 
-        getAppstoreConfig(function (error, appstoreConfig) {
-            if (error) return callback(error);
+            var data = {
+                domain: config.fqdn(),
+                version: config.version(),
+                provider: config.provider(),
+                backendSettings: backendSettings,
+                machine: {
+                    cpus: os.cpus(),
+                    totalmem: os.totalmem()
+                },
+                events: {
+                    lastLogin: loginEvents[0] ? (new Date(loginEvents[0].creationTime).getTime()) : 0
+                }
+            };
 
-            var url = config.apiServerOrigin() + '/api/v1/users/' + appstoreConfig.userId + '/cloudrons/' + appstoreConfig.cloudronId + '/alive';
-            superagent.post(url).send(data).query({ accessToken: appstoreConfig.token }).timeout(30 * 1000).end(function (error, result) {
-                if (error && !error.response) return callback(new AppstoreError(AppstoreError.EXTERNAL_ERROR, error));
-                if (result.statusCode === 404) return callback(new AppstoreError(AppstoreError.NOT_FOUND));
-                if (result.statusCode !== 201) return callback(new AppstoreError(AppstoreError.EXTERNAL_ERROR, util.format('Sending alive status failed. %s %j', result.status, result.body)));
+            getAppstoreConfig(function (error, appstoreConfig) {
+                if (error) return callback(error);
 
-                callback(null);
+                var url = config.apiServerOrigin() + '/api/v1/users/' + appstoreConfig.userId + '/cloudrons/' + appstoreConfig.cloudronId + '/alive';
+                superagent.post(url).send(data).query({ accessToken: appstoreConfig.token }).timeout(30 * 1000).end(function (error, result) {
+                    if (error && !error.response) return callback(new AppstoreError(AppstoreError.EXTERNAL_ERROR, error));
+                    if (result.statusCode === 404) return callback(new AppstoreError(AppstoreError.NOT_FOUND));
+                    if (result.statusCode !== 201) return callback(new AppstoreError(AppstoreError.EXTERNAL_ERROR, util.format('Sending alive status failed. %s %j', result.status, result.body)));
+
+                    callback(null);
+                });
             });
         });
     });

src/cron.js

@@ -15,6 +15,7 @@ var apps = require('./apps.js'),
     constants = require('./constants.js'),
     CronJob = require('cron').CronJob,
     debug = require('debug')('box:cron'),
+    digest = require('./digest.js'),
     eventlog = require('./eventlog.js'),
     janitor = require('./janitor.js'),
     scheduler = require('./scheduler.js'),
@@ -22,20 +23,21 @@ var apps = require('./apps.js'),
     semver = require('semver'),
     updateChecker = require('./updatechecker.js');
 
-var gAutoupdaterJob = null,
-    gBoxUpdateCheckerJob = null,
+var gAliveJob = null, // send periodic stats
     gAppUpdateCheckerJob = null,
-    gHeartbeatJob = null, // for CaaS health check
-    gAliveJob = null, // send periodic stats
+    gAutoupdaterJob = null,
     gBackupJob = null,
-    gCleanupTokensJob = null,
-    gCleanupBackupsJob = null,
-    gDockerVolumeCleanerJob = null,
-    gSchedulerSyncJob = null,
+    gBoxUpdateCheckerJob = null,
     gCertificateRenewJob = null,
     gCheckDiskSpaceJob = null,
+    gCleanupBackupsJob = null,
     gCleanupEventlogJob = null,
-    gDynamicDNSJob = null;
+    gCleanupTokensJob = null,
+    gDockerVolumeCleanerJob = null,
+    gDynamicDNSJob = null,
+    gHeartbeatJob = null, // for CaaS health check
+    gSchedulerSyncJob = null,
+    gDigestEmailJob = null;
 
 var NOOP_CALLBACK = function (error) { if (error) console.error(error); };
 var AUDIT_SOURCE = { userId: null, username: 'cron' };
@@ -173,6 +175,14 @@ function recreateJobs(tz) {
         start: true,
         timeZone: tz
     });
+
+    if (gDigestEmailJob) gDigestEmailJob.stop();
+    gDigestEmailJob = new CronJob({
+        cronTime: '00 00 * * * 3', // every tuesday
+        onTick: digest.maybeSend,
+        start: true,
+        timeZone: tz
+    });
 }
 
 function autoupdatePatternChanged(pattern) {
@@ -272,5 +282,8 @@ function uninitialize(callback) {
     if (gDynamicDNSJob) gDynamicDNSJob.stop();
     gDynamicDNSJob = null;
 
+    if (gDigestEmailJob) gDigestEmailJob.stop();
+    gDigestEmailJob = null;
+
     callback();
 }

src/digest.js

@@ -0,0 +1,64 @@
+'use strict';
+
+var appstore = require('./appstore.js'),
+    debug = require('debug')('box:digest'),
+    eventlog = require('./eventlog.js'),
+    updatechecker = require('./updatechecker.js'),
+    mailer = require('./mailer.js'),
+    settings = require('./settings.js');
+
+var NOOP_CALLBACK = function (error) { if (error) debug(error); };
+
+exports = module.exports = {
+    maybeSend: maybeSend
+};
+
+function maybeSend(callback) {
+    callback = callback || NOOP_CALLBACK;
+
+    settings.getEmailDigest(function (error, enabled) {
+        if (error) return callback(error);
+
+        if (!enabled) {
+            debug('Email digest is disabled');
+            return callback();
+        }
+
+        var updateInfo = updatechecker.getUpdateInfo();
+        var pendingAppUpdates = updateInfo.apps || {};
+        pendingAppUpdates = Object.keys(pendingAppUpdates).map(function (key) { return pendingAppUpdates[key]; });
+
+        appstore.getSubscription(function (error, result) {
+            if (error) debug('Error getting subscription:', error);
+
+            var hasSubscription = result && result.plan.id !== 'free' && result.plan.id !== 'undecided';
+
+            eventlog.getByActionLastWeek(eventlog.ACTION_APP_UPDATE, function (error, appUpdates) {
+                if (error) return callback(error);
+
+                eventlog.getByActionLastWeek(eventlog.ACTION_UPDATE, function (error, boxUpdates) {
+                    if (error) return callback(error);
+
+                    var info = {
+                        hasSubscription: hasSubscription,
+
+                        pendingAppUpdates: pendingAppUpdates,
+                        pendingBoxUpdate: updateInfo.box || null,
+
+                        finishedAppUpdates: (appUpdates || []).map(function (e) { return e.data; }),
+                        finishedBoxUpdates: (boxUpdates || []).map(function (e) { return e.data; })
+                    };
+
+                    if (info.pendingAppUpdates.length || info.pendingBoxUpdate || info.finishedAppUpdates.length || info.finishedBoxUpdates.length) {
+                        debug('maybeSend: sending digest email', info);
+                        mailer.sendDigest(info);
+                    } else {
+                        debug('maybeSend: nothing happened, NOT sending digest email');
+                    }
+
+                    callback();
+                });
+            });
+        });
+    });
+}

src/eventlog.js

@@ -6,6 +6,7 @@ exports = module.exports = {
     add: add,
     get: get,
     getAllPaged: getAllPaged,
+    getByActionLastWeek: getByActionLastWeek,
     cleanup: cleanup,
 
     // keep in sync with webadmin index.js filter and CLI tool
@@ -103,6 +104,17 @@ function getAllPaged(action, search, page, perPage, callback) {
     });
 }
 
+function getByActionLastWeek(action, callback) {
+    assert(typeof action === 'string' || action === null);
+    assert.strictEqual(typeof callback, 'function');
+
+    eventlogdb.getByActionLastWeek(action, function (error, boxes) {
+        if (error) return callback(new EventLogError(EventLogError.INTERNAL_ERROR, error));
+
+        callback(null, boxes);
+    });
+}
+
 function cleanup(callback) {
     callback = callback || NOOP_CALLBACK;
 

src/eventlogdb.js

@@ -3,6 +3,7 @@
 exports = module.exports = {
     get: get,
     getAllPaged: getAllPaged,
+    getByActionLastWeek: getByActionLastWeek,
     add: add,
     count: count,
     delByCreationTime: delByCreationTime,
@@ -71,6 +72,20 @@ function getAllPaged(action, search, page, perPage, callback) {
     });
 }
 
+function getByActionLastWeek(action, callback) {
+    assert(typeof action === 'string' || action === null);
+    assert.strictEqual(typeof callback, 'function');
+
+    var query = 'SELECT ' + EVENTLOGS_FIELDS + ' FROM eventlog WHERE action=? AND creationTime >= DATE_SUB(NOW(), INTERVAL 1 WEEK) ORDER BY creationTime DESC';
+    database.query(query, [ action ], function (error, results) {
+        if (error) return callback(new DatabaseError(DatabaseError.INTERNAL_ERROR, error));
+
+        results.forEach(postProcess);
+
+        callback(null, results);
+    });
+}
+
 function add(id, action, source, data, callback) {
     assert.strictEqual(typeof id, 'string');
     assert.strictEqual(typeof action, 'string');

src/mail_templates/digest.ejs

@@ -0,0 +1,47 @@
+<% if (format === 'text') { -%>
+
+Dear <%= cloudronName %> Admin,
+
+This is the weekly summary of activities on your Cloudron <%= fqdn %>.
+<% if (info.pendingBoxUpdate) { -%>
+
+Cloudron v<%- info.pendingBoxUpdate.version %> is available:
+<% for (var i = 0; i < info.pendingBoxUpdate.changelog.length; i++) { -%>
+    * <%- info.pendingBoxUpdate.changelog[i] %>
+<% }} -%>
+<% if (info.pendingAppUpdates.length) { -%>
+
+One or more app updates are available:
+<% for (var i = 0; i < info.pendingAppUpdates.length; i++) { -%>
+    - <%= info.pendingAppUpdates[i].manifest.title %> package v<%= info.pendingAppUpdates[i].manifest.version %>
+<% for (var j = 0; j < info.pendingAppUpdates[i].manifest.changelog.trim().split('\n').length; j++) { -%>
+        <%= info.pendingAppUpdates[i].manifest.changelog.trim().split('\n')[j] %>
+<% }}} -%>
+<% if (info.finishedBoxUpdates.length) { -%>
+
+Cloudron was updated with the following releases:
+<% for (var i = 0; i < info.finishedBoxUpdates.length; i++) { -%>
+    - Version <%= info.finishedBoxUpdates[i].boxUpdateInfo.version %>
+<% for (var j = 0; j < info.finishedBoxUpdates[i].boxUpdateInfo.changelog.length; j++) { -%>
+        * <%= info.finishedBoxUpdates[i].boxUpdateInfo.changelog[j] %>
+<% }}} -%>
+<% if (info.finishedAppUpdates.length) { -%>
+
+The following apps were updated:
+<% for (var i = 0; i < info.finishedAppUpdates.length; i++) { -%>
+    - <%= info.finishedAppUpdates[i].toManifest.title %> package v<%= info.finishedAppUpdates[i].toManifest.version %>
+<% for (var j = 0; j < info.finishedAppUpdates[i].toManifest.changelog.trim().split('\n').length; j++) { -%>
+        <%= info.finishedAppUpdates[i].toManifest.changelog.trim().split('\n')[j] %>
+<% }}} -%>
+<% if (!info.hasSubscription) { -%>
+
+*Keep your Cloudron automatically up-to-date and secure by upgrading to a paid plan at* <%= webadminUrl %>/#/settings
+<% } -%>
+
+Powered by https://cloudron.io
+
+Sent at: <%= new Date().toUTCString() %>
+
+<% } else { %>
+
+<% } %>

src/mailer.js

@@ -10,6 +10,7 @@ exports = module.exports = {
     passwordReset: passwordReset,
     boxUpdateAvailable: boxUpdateAvailable,
     appUpdateAvailable: appUpdateAvailable,
+    sendDigest: sendDigest,
 
     sendInvite: sendInvite,
     unexpectedExit: unexpectedExit,
@@ -418,6 +419,30 @@ function appUpdateAvailable(app, updateInfo) {
     });
 }
 
+function sendDigest(info) {
+    assert.strictEqual(typeof info, 'object');
+
+    getAdminEmails(function (error, adminEmails) {
+        if (error) return console.log('Error getting admins', error);
+
+        settings.getCloudronName(function (error, cloudronName) {
+            if (error) {
+                debug(error);
+                cloudronName = 'Cloudron';
+            }
+
+             var mailOptions = {
+                from: mailConfig().from,
+                to: adminEmails.join(', '),
+                subject: util.format('[%s] Cloudron - Weekly activity digest', config.fqdn()),
+                text: render('digest.ejs', { fqdn: config.fqdn(), webadminUrl: config.adminOrigin(), cloudronName: cloudronName, info: info, format: 'text' })
+            };
+
+            enqueue(mailOptions);
+        });
+    });
+}
+
 function outOfDiskSpace(message) {
     assert.strictEqual(typeof message, 'string');
 

src/settings.js

@@ -48,12 +48,16 @@ exports = module.exports = {
     getCatchAllAddress: getCatchAllAddress,
 
     getDefaultSync: getDefaultSync,
+    getEmailDigest: getEmailDigest,
+    setEmailDigest: setEmailDigest,
+
     getAll: getAll,
 
     AUTOUPDATE_PATTERN_KEY: 'autoupdate_pattern',
     TIME_ZONE_KEY: 'time_zone',
     CLOUDRON_NAME_KEY: 'cloudron_name',
     DEVELOPER_MODE_KEY: 'developer_mode',
+    EMAIL_DIGEST: 'email_digest',
     DNS_CONFIG_KEY: 'dns_config',
     DYNAMIC_DNS_KEY: 'dynamic_dns',
     BACKUP_CONFIG_KEY: 'backup_config',
@@ -110,6 +114,7 @@ var gDefaults = (function () {
     result[exports.APPSTORE_CONFIG_KEY] = {};
     result[exports.MAIL_CONFIG_KEY] = { enabled: false };
     result[exports.CATCH_ALL_ADDRESS] = [ ];
+    result[exports.EMAIL_DIGEST] = true;
 
     return result;
 })();
@@ -660,11 +665,35 @@ function setMailConfig(mailConfig, callback) {
     });
 }
 
+function getEmailDigest(callback) {
+    assert.strictEqual(typeof callback, 'function');
+
+    settingsdb.get(exports.EMAIL_DIGEST, function (error, enabled) {
+        if (error && error.reason === DatabaseError.NOT_FOUND) return callback(null, gDefaults[exports.EMAIL_DIGEST]);
+        if (error) return callback(new SettingsError(SettingsError.INTERNAL_ERROR, error));
+
+        callback(null, !!enabled); // settingsdb holds string values only
+    });
+}
+
+function setEmailDigest(enabled, callback) {
+    assert.strictEqual(typeof enabled, 'boolean');
+    assert.strictEqual(typeof callback, 'function');
+
+    settingsdb.set(exports.EMAIL_DIGEST, enabled ? 'enabled' : '', function (error) {
+        if (error) return callback(new SettingsError(SettingsError.INTERNAL_ERROR, error));
+
+        exports.events.emit(exports.EMAIL_DIGEST, enabled);
+
+        callback(null);
+    });
+}
+
 function getCatchAllAddress(callback) {
     assert.strictEqual(typeof callback, 'function');
 
-    settingsdb.get(exports.CATCH_ALL_ADDRESS, function (error, value) {
-        if (error && error.reason === DatabaseError.NOT_FOUND) return callback(null, gDefaults[exports.CATCH_ALL_ADDRESS]);
+    settingsdb.get(exports.CATCH_ALL_ADDRESS_KEY, function (error, value) {
+        if (error && error.reason === DatabaseError.NOT_FOUND) return callback(null, gDefaults[exports.CATCH_ALL_ADDRESS_KEY]);
         if (error) return callback(new SettingsError(SettingsError.INTERNAL_ERROR, error));
 
         callback(null, JSON.parse(value));