Fix handling for backups; correctly send along ignored files & directories

Author: DaneEveritt

app/Http/Controllers/Api/Client/Servers/BackupController.php

@@ -87,7 +87,9 @@ public function store(StoreBackupRequest $request, Server $server)
         }
 
         $backup = $this->initiateBackupService
-            ->setIgnoredFiles($request->input('ignored'))
+            ->setIgnoredFiles(
+                explode(PHP_EOL, $request->input('ignored') ?? '')
+            )
             ->handle($server, $request->input('name'));
 
         return $this->fractal->item($backup)

app/Http/Requests/Api/Client/Servers/Backups/StoreBackupRequest.php

@@ -22,7 +22,7 @@ public function rules(): array
     {
         return [
             'name' => 'nullable|string|max:255',
-            'ignore' => 'nullable|string',
+            'ignored' => 'nullable|string',
         ];
     }
 }

app/Http/Requests/Api/Remote/ReportBackupCompleteRequest.php

@@ -13,8 +13,8 @@ public function rules()
     {
         return [
             'successful' => 'boolean',
-            'checksum' => 'string|required_if:successful,true',
-            'size' => 'numeric|required_if:successful,true',
+            'checksum' => 'nullable|string|required_if:successful,true',
+            'size' => 'nullable|numeric|required_if:successful,true',
         ];
     }
 }

app/Models/Backup.php

@@ -9,7 +9,7 @@
  * @property int $server_id
  * @property int $uuid
  * @property string $name
- * @property string $ignored_files
+ * @property string[] $ignored_files
  * @property string $disk
  * @property string|null $sha256_hash
  * @property int $bytes
@@ -45,6 +45,7 @@ class Backup extends Model
     protected $casts = [
         'id' => 'int',
         'bytes' => 'int',
+        'ignored_files' => 'array',
     ];
 
     /**
@@ -69,7 +70,7 @@ class Backup extends Model
         'server_id' => 'bail|required|numeric|exists:servers,id',
         'uuid' => 'required|uuid',
         'name' => 'required|string',
-        'ignored_files' => 'string',
+        'ignored_files' => 'array',
         'disk' => 'required|string',
         'sha256_hash' => 'nullable|string',
         'bytes' => 'numeric',

app/Repositories/Wings/DaemonBackupRepository.php

@@ -29,7 +29,7 @@ public function backup(Backup $backup): ResponseInterface
                 [
                     'json' => [
                         'uuid' => $backup->uuid,
-                        'ignored_files' => explode(PHP_EOL, $backup->ignored_files),
+                        'ignored_files' => $backup->ignored_files,
                     ],
                 ]
             );

app/Services/Backups/InitiateBackupService.php

@@ -4,6 +4,7 @@
 
 use Ramsey\Uuid\Uuid;
 use Carbon\CarbonImmutable;
+use Webmozart\Assert\Assert;
 use Pterodactyl\Models\Backup;
 use Pterodactyl\Models\Server;
 use Illuminate\Database\ConnectionInterface;
@@ -13,7 +14,7 @@
 class InitiateBackupService
 {
     /**
-     * @var string|null
+     * @var string[]|null
      */
     private $ignoredFiles;
 
@@ -52,12 +53,23 @@ public function __construct(
     /**
      * Sets the files to be ignored by this backup.
      *
-     * @param string|null $ignored
+     * @param string[]|null $ignored
      * @return $this
      */
-    public function setIgnoredFiles(?string $ignored)
+    public function setIgnoredFiles(?array $ignored)
     {
-        $this->ignoredFiles = $ignored;
+        if (is_array($ignored)) {
+            foreach ($ignored as $value) {
+                Assert::string($value);
+            }
+        }
+
+        // Set the ignored files to be any values that are not empty in the array. Don't use
+        // the PHP empty function here incase anything that is "empty" by default (0, false, etc.)
+        // were passed as a file or folder name.
+        $this->ignoredFiles = is_null($ignored) ? [] : array_filter($ignored, function ($value) {
+            return strlen($value) > 0;
+        });
 
         return $this;
     }
@@ -79,7 +91,7 @@ public function handle(Server $server, string $name = null): Backup
                 'server_id' => $server->id,
                 'uuid' => Uuid::uuid4()->toString(),
                 'name' => trim($name) ?: sprintf('Backup at %s', CarbonImmutable::now()->toDateTimeString()),
-                'ignored_files' => $this->ignoredFiles ?? '',
+                'ignored_files' => is_array($this->ignoredFiles) ? array_values($this->ignoredFiles) : [],
                 'disk' => 'local',
             ], true, true);
 

resources/scripts/api/server/backups/createServerBackup.ts

@@ -1,10 +1,10 @@
 import { rawDataToServerBackup, ServerBackup } from '@/api/server/backups/getServerBackups';
 import http from '@/api/http';
 
-export default (uuid: string, name?: string, ignore?: string): Promise<ServerBackup> => {
+export default (uuid: string, name?: string, ignored?: string): Promise<ServerBackup> => {
     return new Promise((resolve, reject) => {
         http.post(`/api/client/servers/${uuid}/backups`, {
-            name, ignore,
+            name, ignored,
         })
             .then(({ data }) => resolve(rawDataToServerBackup(data)))
             .catch(reject);

resources/scripts/components/server/backups/CreateBackupButton.tsx

@@ -33,7 +33,7 @@ const ModalContent = ({ ...props }: RequiredModalProps) => {
                 </div>
                 <div className={'mb-6'}>
                     <FormikFieldWrapper
-                        name={'ignore'}
+                        name={'ignored'}
                         label={'Ignored Files & Directories'}
                         description={`
                             Enter the files or folders to ignore while generating this backup. Leave blank to use
@@ -43,7 +43,7 @@ const ModalContent = ({ ...props }: RequiredModalProps) => {
                         `}
                     >
                         <FormikField
-                            name={'contents'}
+                            name={'ignored'}
                             component={'textarea'}
                             className={'input-dark h-32'}
                         />