From 7c7e8285a45550ef189887abce3111794e2876f0 Mon Sep 17 00:00:00 2001
From: Selfhost Alt <selfhost.alt@gmail.com>
Date: Sat, 23 Apr 2022 10:19:31 -0700
Subject: [PATCH 1/3] Make maximum backup size configurable

---
 client/pages/config/backups.vue           | 15 ++++++++++++++-
 server/managers/BackupManager.js          |  5 +----
 server/objects/settings/ServerSettings.js |  3 +++
 3 files changed, 18 insertions(+), 5 deletions(-)

diff --git a/client/pages/config/backups.vue b/client/pages/config/backups.vue
index f6adb3f2..20b3beda 100644
--- a/client/pages/config/backups.vue
+++ b/client/pages/config/backups.vue
@@ -20,6 +20,12 @@
         <p class="pl-4 text-lg">Number of backups to keep</p>
       </div>
 
+      <div class="flex items-center py-2">
+        <ui-text-input type="number" v-model="maxBackupSize" no-spinner :disabled="updatingServerSettings" :padding-x="1" text-center class="w-10" @change="updateBackupsSettings" />
+
+        <p class="pl-4 text-lg">Maximum backup size (in GB)</p>
+      </div>
+
       <tables-backups-table />
     </div>
   </div>
@@ -32,6 +38,7 @@ export default {
       updatingServerSettings: false,
       dailyBackups: true,
       backupsToKeep: 2,
+      maxBackupSize: 1,
       newServerSettings: {}
     }
   },
@@ -53,13 +60,18 @@ export default {
   },
   methods: {
     updateBackupsSettings() {
+      if (isNaN(this.maxBackupSize) || this.maxBackupSize <= 0) {
+        this.$toast.error('Invalid maximum backup size')
+        return
+      }
       if (isNaN(this.backupsToKeep) || this.backupsToKeep <= 0 || this.backupsToKeep > 99) {
         this.$toast.error('Invalid number of backups to keep')
         return
       }
       var updatePayload = {
         backupSchedule: this.dailyBackups ? '0 1 * * *' : false,
-        backupsToKeep: Number(this.backupsToKeep)
+        backupsToKeep: Number(this.backupsToKeep),
+        maxBackupSize: Number(this.maxBackupSize)
       }
       this.updateServerSettings(updatePayload)
     },
@@ -81,6 +93,7 @@ export default {
 
       this.backupsToKeep = this.newServerSettings.backupsToKeep || 2
       this.dailyBackups = !!this.newServerSettings.backupSchedule
+      this.maxBackupSize = this.newServerSettings.maxBackupSize || 1
     }
   },
   mounted() {
diff --git a/server/managers/BackupManager.js b/server/managers/BackupManager.js
index 9c1002cd..472fdd9b 100644
--- a/server/managers/BackupManager.js
+++ b/server/managers/BackupManager.js
@@ -23,9 +23,6 @@ class BackupManager {
     this.scheduleTask = null
 
     this.backups = []
-
-    // If backup exceeds this value it will be aborted
-    this.MaxBytesBeforeAbort = 1000000000 // ~ 1GB
   }
 
   get serverSettings() {
@@ -263,7 +260,7 @@ class BackupManager {
         reject(err)
       })
       archive.on('progress', ({ fs: fsobj }) => {
-        if (fsobj.processedBytes > this.MaxBytesBeforeAbort) {
+        if (fsobj.processedBytes > this.serverSettings.maxBackupSize * 1000 * 1000 * 1000) {
           Logger.error(`[BackupManager] Archiver is too large - aborting to prevent endless loop, Bytes Processed: ${fsobj.processedBytes}`)
           archive.abort()
           setTimeout(() => {
diff --git a/server/objects/settings/ServerSettings.js b/server/objects/settings/ServerSettings.js
index 86cb33fb..7be8f9de 100644
--- a/server/objects/settings/ServerSettings.js
+++ b/server/objects/settings/ServerSettings.js
@@ -29,6 +29,7 @@ class ServerSettings {
     // this.backupSchedule = '0 1 * * *' // If false then auto-backups are disabled (default every day at 1am)
     this.backupSchedule = false
     this.backupsToKeep = 2
+    this.maxBackupSize = 1
     this.backupMetadataCovers = true
 
     // Logger
@@ -78,6 +79,7 @@ class ServerSettings {
 
     this.backupSchedule = settings.backupSchedule || false
     this.backupsToKeep = settings.backupsToKeep || 2
+    this.maxBackupSize  = settings.maxBackupSize || 1
     this.backupMetadataCovers = settings.backupMetadataCovers !== false
 
     this.loggerDailyLogsToKeep = settings.loggerDailyLogsToKeep || 7
@@ -114,6 +116,7 @@ class ServerSettings {
       rateLimitLoginWindow: this.rateLimitLoginWindow,
       backupSchedule: this.backupSchedule,
       backupsToKeep: this.backupsToKeep,
+      maxBackupSize: this.maxBackupSize,
       backupMetadataCovers: this.backupMetadataCovers,
       loggerDailyLogsToKeep: this.loggerDailyLogsToKeep,
       loggerScannerLogsToKeep: this.loggerScannerLogsToKeep,

From f9530897c06e3439534f95178bfd74ae5faf1776 Mon Sep 17 00:00:00 2001
From: Selfhost Alt <selfhost.alt@gmail.com>
Date: Sat, 23 Apr 2022 10:23:01 -0700
Subject: [PATCH 2/3] Add tooltip to explain the max backup size

---
 client/pages/config/backups.vue | 7 ++++++-
 1 file changed, 6 insertions(+), 1 deletion(-)

diff --git a/client/pages/config/backups.vue b/client/pages/config/backups.vue
index 20b3beda..aeffa96e 100644
--- a/client/pages/config/backups.vue
+++ b/client/pages/config/backups.vue
@@ -23,7 +23,9 @@
       <div class="flex items-center py-2">
         <ui-text-input type="number" v-model="maxBackupSize" no-spinner :disabled="updatingServerSettings" :padding-x="1" text-center class="w-10" @change="updateBackupsSettings" />
 
-        <p class="pl-4 text-lg">Maximum backup size (in GB)</p>
+        <ui-tooltip :text="maxBackupSizeTooltip">
+          <p class="pl-4 text-lg">Maximum backup size (in GB) <span class="material-icons icon-text">info_outlined</span></p>
+        </ui-tooltip>
       </div>
 
       <tables-backups-table />
@@ -54,6 +56,9 @@ export default {
     dailyBackupsTooltip() {
       return 'Runs at 1am every day (your server time). Saved in /metadata/backups.'
     },
+    maxBackupSizeTooltip() {
+      return 'As a safeguard against misconfiguration, backups will fail if they exceed the configured size.'
+    },
     serverSettings() {
       return this.$store.state.serverSettings
     }

From cb5d9a8287d15a830d3e2337bea838b07fb2d3b5 Mon Sep 17 00:00:00 2001
From: Selfhost Alt <selfhost.alt@gmail.com>
Date: Sat, 23 Apr 2022 10:26:37 -0700
Subject: [PATCH 3/3] Add explicit byte conversion variable to make code more
 self-documenting

---
 server/managers/BackupManager.js | 3 ++-
 1 file changed, 2 insertions(+), 1 deletion(-)

diff --git a/server/managers/BackupManager.js b/server/managers/BackupManager.js
index 472fdd9b..f66d40cf 100644
--- a/server/managers/BackupManager.js
+++ b/server/managers/BackupManager.js
@@ -260,7 +260,8 @@ class BackupManager {
         reject(err)
       })
       archive.on('progress', ({ fs: fsobj }) => {
-        if (fsobj.processedBytes > this.serverSettings.maxBackupSize * 1000 * 1000 * 1000) {
+        const maxBackupSizeInBytes = this.serverSettings.maxBackupSize * 1000 * 1000 * 1000 
+        if (fsobj.processedBytes > maxBackupSizeInBytes) {
           Logger.error(`[BackupManager] Archiver is too large - aborting to prevent endless loop, Bytes Processed: ${fsobj.processedBytes}`)
           archive.abort()
           setTimeout(() => {