✨Image Backups API endpoint

.gitignore

@@ -107,6 +107,7 @@ projectFilesBackup
 /content/media/**/*
 /content/files/**/*
 /content/public/*
+/content/backups/*
 /content/adapters/storage/**/*
 /content/adapters/scheduling/**/*
 !/content/themes/casper

core/server/api/canary/backups.js

@@ -0,0 +1,11 @@
+const backupsServices = require('../../services/backups');
+
+module.exports = {
+    docName: 'backups',
+    download: {
+        permissions: false,
+        query() {
+            return backupsServices.api.exporter();
+        }
+    }
+};

core/server/api/canary/index.js

@@ -20,6 +20,10 @@ module.exports = {
         return shared.pipeline(require('./identities'), localUtils);
     },
 
+    get backups() {
+        return shared.pipeline(require('./backups'), localUtils);
+    },
+
     get integrations() {
         return shared.pipeline(require('./integrations'), localUtils);
     },

core/server/api/canary/utils/serializers/output/backups.js

@@ -0,0 +1,9 @@
+const debug = require('@tryghost/debug');
+
+module.exports = {
+    all(data, apiConfig, frame) {
+        debug('all');
+
+        frame.response = data;
+    }
+};

core/server/api/canary/utils/serializers/output/index.js

@@ -13,6 +13,10 @@ module.exports = {
         return require('./default');
     },
 
+    get backups() {
+        return require('./backups');
+    },
+
     get authentication() {
         return require('./authentication');
     },

core/server/services/backups/BackupsExporter.js

@@ -0,0 +1,53 @@
+const {compress} = require('@tryghost/zip');
+const path = require('path');
+const config = require('../../../shared/config');
+const fs = require('fs-extra');
+
+/**
+ * Prototype for exporting images in bulk
+ */
+
+class BackupsExporter {
+    getDirectories() {
+        return {
+            images: config.getContentPath('images'),
+            backups: config.getContentPath('backups')
+        };
+    }
+    /**
+     * 
+     * @TODO: Perhaps let it multithread to avoid http timeouts and memory issues on big requests?
+     * Maybe add cases later for other types for backups?
+     */
+    serve() {
+        const self = this;
+        return function downloadBackup(req, res, next) {
+            const backupsPath = self.getDirectories().backups;
+            const imagesPath = self.getDirectories().images;
+            const zipPath = path.join(backupsPath, 'images.zip');
+            let stream;
+            fs.ensureDir(backupsPath)
+                .then(async function () {
+                    return await compress(imagesPath, zipPath);
+                })
+                .then(function (result) {
+                    res.set({
+                        'Content-disposition': 'attachment; filename={backups}.zip'.replace('{backups}', 'images'),
+                        'Content-Type': 'application/zip',
+                        'Content-Length': result.size
+                    });
+                    stream = fs.createReadStream(zipPath);
+                    stream.pipe(res);
+                })
+                .catch(function (err) {
+                    next(err);
+                })
+                .finally(function () {
+                    return;
+                });
+        };
+    }
+}
+
+module.exports = BackupsExporter;
+

core/server/services/backups/backups.js

@@ -0,0 +1,14 @@
+const BackupsExporter = require('./BackupsExporter');
+
+let backupsExporter;
+
+const getStorage = () => {
+    backupsExporter = backupsExporter || new BackupsExporter();
+    return backupsExporter;
+};
+
+module.exports = {
+    getZip: async () => {
+        return await getStorage().serve();
+    }
+};

core/server/services/backups/index.js

@@ -0,0 +1,10 @@
+const {getZip} = require('./backups');
+
+module.exports = {
+    /**
+     * Methods used in the API
+     */
+    api: {
+        exporter: getZip
+    }
+};

core/server/web/api/canary/admin/routes.js

@@ -261,6 +261,10 @@ module.exports = function apiRoutes() {
         http(api.files.upload)
     );
 
+    // ## backups
+    // @TODO make images dynamic to allow multiple use cases in future
+    router.get('/backups/images/download', mw.authAdminApi, http(api.backups.download));
+
     // ## Invites
     router.get('/invites', mw.authAdminApi, http(api.invites.browse));
     router.get('/invites/:id', mw.authAdminApi, http(api.invites.read));

core/shared/config/helpers.js

@@ -86,6 +86,8 @@ const getContentPath = function getContentPath(type) {
         return path.join(this.get('paths:contentPath'), 'settings/');
     case 'public':
         return path.join(this.get('paths:contentPath'), 'public/');
+    case 'backups':
+        return path.join(this.get('paths:contentPath'), 'backups/');
     default:
         // new Error is allowed here, as we do not want config to depend on @tryghost/error
         // @TODO: revisit this decision when @tryghost/error is no longer dependent on all of ghost-ignition