backup serving, storing and restoring

src/controller/admin/club/backupController.ts

@@ -0,0 +1,75 @@
+import { Request, Response } from "express";
+import { FileSystemHelper } from "../../../helpers/fileSystemHelper";
+import BackupHelper from "../../../helpers/backupHelper";
+import InternalException from "../../../exceptions/internalException";
+
+/**
+ * @description get generated backups
+ * @param req {Request} Express req object
+ * @param res {Response} Express res object
+ * @returns {Promise<*>}
+ */
+export async function getGeneratedBackups(req: Request, res: Response): Promise<any> {
+  let filesInFolder = FileSystemHelper.getFilesInDirectory(`backup`);
+
+  res.json(filesInFolder);
+}
+
+/**
+ * @description download backup file
+ * @param req {Request} Express req object
+ * @param res {Response} Express res object
+ * @returns {Promise<*>}
+ */
+export async function downloadBackupFile(req: Request, res: Response): Promise<any> {
+  let filename = req.params.filename;
+
+  let filepath = FileSystemHelper.formatPath("backup", filename);
+
+  res.sendFile(filepath, {
+    headers: {
+      "Content-Type": "application/json",
+    },
+  });
+}
+
+/**
+ * @description create backup manually
+ * @param req {Request} Express req object
+ * @param res {Response} Express res object
+ * @returns {Promise<*>}
+ */
+export async function createManualBackup(req: Request, res: Response): Promise<any> {
+  await BackupHelper.createBackup({});
+
+  res.sendStatus(204);
+}
+
+/**
+ * @description restore backup by selected
+ * @param req {Request} Express req object
+ * @param res {Response} Express res object
+ * @returns {Promise<*>}
+ */
+export async function restoreBackupByLocalFile(req: Request, res: Response): Promise<any> {
+  let filename = req.body.filename;
+  let partial = req.body.partial;
+  let include = req.body.includes;
+
+  await BackupHelper.loadBackup({ filename, include, partial });
+
+  res.sendStatus(204);
+}
+
+/**
+ * @description upload backup
+ * @param req {Request} Express req object
+ * @param res {Response} Express res object
+ * @returns {Promise<*>}
+ */
+export async function uploadBackupFile(req: Request, res: Response): Promise<any> {
+  if (!req.file) {
+    throw new InternalException("File upload failed");
+  }
+  res.sendStatus(204);
+}

src/helpers/backupHelper.ts

@@ -96,6 +96,8 @@ export default abstract class BackupHelper {
     }
 
     FileSystemHelper.writeFile(path, filename + ".json", JSON.stringify(json, null, 2));
+
+    // TODO: delete older backups by copies env
   }
 
   static async loadBackup({
@@ -114,6 +116,10 @@ export default abstract class BackupHelper {
     let file = FileSystemHelper.readFile(`${path}/${filename}`);
     let backup: BackupFileContent = JSON.parse(file);
 
+    if ((partial && include.length == 0) || (!partial && include.length != 0)) {
+      throw new InternalException("partial and include have to be set correctly for restoring backup.");
+    }
+
     dataSource.manager
       .transaction(async (transaction) => {
         this.transactionManager = transaction;

src/index.ts

@@ -40,4 +40,5 @@ import RefreshCommandHandler from "./command/refreshCommandHandler";
 const job = schedule.scheduleJob("0 0 * * *", async () => {
   console.log(`${new Date().toISOString()}: running Cron`);
   await RefreshCommandHandler.deleteExpired();
+  // TODO: create backup by interval env
 });

src/routes/admin/index.ts

@@ -1,5 +1,6 @@
 import express from "express";
 import PermissionHelper from "../../helpers/permissionHelper";
+import preventWebapiAccess from "../../middleware/preventWebApiAccess";
 
 import award from "./settings/award";
 import communicationType from "./settings/communicationType";
@@ -23,7 +24,7 @@ import role from "./user/role";
 import user from "./user/user";
 import invite from "./user/invite";
 import api from "./user/webapi";
-import preventWebapiAccess from "../../middleware/preventWebApiAccess";
+import backup from "./user/backup";
 
 var router = express.Router({ mergeParams: true });
 
@@ -143,5 +144,6 @@ router.use(
 );
 router.use("/invite", PermissionHelper.passCheckMiddleware("read", "user", "user"), invite);
 router.use("/webapi", preventWebapiAccess, PermissionHelper.passCheckMiddleware("read", "user", "webapi"), api);
+router.use("/backup", preventWebapiAccess, PermissionHelper.passCheckMiddleware("read", "user", "backup"), backup);
 
 export default router;

src/routes/admin/user/backup.ts

@@ -0,0 +1,67 @@
+import express, { Request, Response } from "express";
+import PermissionHelper from "../../../helpers/permissionHelper";
+import multer from "multer";
+import {
+  createManualBackup,
+  downloadBackupFile,
+  getGeneratedBackups,
+  restoreBackupByLocalFile,
+  uploadBackupFile,
+} from "../../../controller/admin/club/backupController";
+
+const storage = multer.diskStorage({
+  destination: (req, file, cb) => {
+    cb(null, "files/backup/");
+  },
+  filename: (req, file, cb) => {
+    cb(null, `${new Date().toISOString().split("T")[0]}-uploaded-${file.originalname}`);
+  },
+});
+
+const upload = multer({
+  storage,
+  fileFilter: (req: Request, file, cb) => {
+    if (file.mimetype === "application/json") {
+      cb(null, true);
+    } else {
+      cb(new Error("Only JSON files are allowed!"));
+    }
+  },
+});
+
+var router = express.Router({ mergeParams: true });
+
+router.get("/", async (req: Request, res: Response) => {
+  await getGeneratedBackups(req, res);
+});
+
+router.get("/:filename", async (req: Request, res: Response) => {
+  await downloadBackupFile(req, res);
+});
+
+router.post(
+  "/",
+  PermissionHelper.passCheckMiddleware("create", "user", "backup"),
+  async (req: Request, res: Response) => {
+    await createManualBackup(req, res);
+  }
+);
+
+router.post(
+  "/restore",
+  PermissionHelper.passCheckMiddleware("admin", "user", "backup"),
+  async (req: Request, res: Response) => {
+    await restoreBackupByLocalFile(req, res);
+  }
+);
+
+router.post(
+  "/upload",
+  PermissionHelper.passCheckMiddleware("create", "user", "backup"),
+  upload.single("file"),
+  async (req: Request, res: Response) => {
+    await uploadBackupFile(req, res);
+  }
+);
+
+export default router;

src/type/permissionTypes.ts

@@ -19,7 +19,8 @@ export type PermissionModule =
   | "query"
   | "query_store"
   | "template"
-  | "template_usage";
+  | "template_usage"
+  | "backup";
 
 export type PermissionType = "read" | "create" | "update" | "delete";
 
@@ -63,6 +64,7 @@ export const permissionModules: Array<PermissionModule> = [
   "query_store",
   "template",
   "template_usage",
+  "backup",
 ];
 export const permissionTypes: Array<PermissionType> = ["read", "create", "update", "delete"];
 export const sectionsAndModules: SectionsAndModulesObject = {
@@ -80,5 +82,5 @@ export const sectionsAndModules: SectionsAndModulesObject = {
     "template_usage",
     "newsletter_config",
   ],
-  user: ["user", "role", "webapi"],
+  user: ["user", "role", "webapi", "backup"],
 };