backend: support is_successful state for backups rather than deleting it when failing

This allows the UI to correctly show failed backups to the user and require them to manually delete those backups, rather than them mysteriously disappearing.

We can also hook into this later to send a notification to the user when the backup fails.

Author: DaneEveritt

app/Console/Commands/Maintenance/PruneOrphanedBackupsCommand.php

@@ -17,15 +17,15 @@ class PruneOrphanedBackupsCommand extends Command
     /**
      * @var string
      */
-    protected $description = 'Removes all backups that have existed for more than "n" minutes which are not marked as completed.';
+    protected $description = 'Marks all backups that have not completed in the last "n" minutes as being failed.';
 
     /**
      * @param \Pterodactyl\Repositories\Eloquent\BackupRepository $repository
      */
     public function handle(BackupRepository $repository)
     {
         $since = $this->option('since-minutes');
-        if (!is_digit($since)) {
+        if (! is_digit($since)) {
             throw new InvalidArgumentException('The --since-minutes option must be a valid numeric digit.');
         }
 
@@ -34,14 +34,18 @@ public function handle(BackupRepository $repository)
             ->whereDate('created_at', '<=', CarbonImmutable::now()->subMinutes($since));
 
         $count = $query->count();
-        if (!$count) {
-            $this->info('There are no orphaned backups to be removed.');
+        if (! $count) {
+            $this->info('There are no orphaned backups to be marked as failed.');
 
             return;
         }
 
-        $this->warn("Deleting {$count} backups that have not been marked as completed in the last {$since} minutes.");
+        $this->warn("Marking {$count} backups that have not been marked as completed in the last {$since} minutes as failed.");
 
-        $query->delete();
+        $query->update([
+            'is_successful' => false,
+            'completed_at' => CarbonImmutable::now(),
+            'updated_at' => CarbonImmutable::now(),
+        ]);
     }
 }

app/Http/Controllers/Api/Remote/Backups/BackupStatusController.php

@@ -3,6 +3,7 @@
 namespace Pterodactyl\Http\Controllers\Api\Remote\Backups;
 
 use Carbon\Carbon;
+use Carbon\CarbonImmutable;
 use Illuminate\Http\JsonResponse;
 use Pterodactyl\Http\Controllers\Controller;
 use Pterodactyl\Repositories\Eloquent\BackupRepository;
@@ -31,25 +32,16 @@ public function __construct(BackupRepository $repository)
      * @param \Pterodactyl\Http\Requests\Api\Remote\ReportBackupCompleteRequest $request
      * @param string $backup
      * @return \Illuminate\Http\JsonResponse
-     *
-     * @throws \Pterodactyl\Exceptions\Model\DataValidationException
-     * @throws \Pterodactyl\Exceptions\Repository\RecordNotFoundException
      */
     public function __invoke(ReportBackupCompleteRequest $request, string $backup)
     {
-        /** @var \Pterodactyl\Models\Backup $backup */
-        $backup = $this->repository->findFirstWhere([['uuid', '=', $backup]]);
-
-        if ($request->input('successful')) {
-            $this->repository->update($backup->id, [
-                'sha256_hash' => $request->input('checksum'),
-                'bytes' => $request->input('size'),
-                'completed_at' => Carbon::now(),
-            ], true, true);
-        } else {
-            $this->repository->delete($backup->id);
-        }
+        $this->repository->updateWhere([['uuid', '=', $backup]], [
+            'is_successful' => $request->input('successful') ? true : false,
+            'sha256_hash' => $request->input('checksum'),
+            'bytes' => $request->input('size'),
+            'completed_at' => CarbonImmutable::now(),
+        ]);
 
-        return JsonResponse::create([], JsonResponse::HTTP_NO_CONTENT);
+        return new JsonResponse([], JsonResponse::HTTP_NO_CONTENT);
     }
 }

app/Models/Backup.php

@@ -8,6 +8,7 @@
  * @property int $id
  * @property int $server_id
  * @property int $uuid
+ * @property bool $is_successful
  * @property string $name
  * @property string[] $ignored_files
  * @property string $disk
@@ -44,6 +45,7 @@ class Backup extends Model
      */
     protected $casts = [
         'id' => 'int',
+        'is_successful' => 'bool',
         'bytes' => 'int',
         'ignored_files' => 'array',
     ];
@@ -59,6 +61,7 @@ class Backup extends Model
      * @var array
      */
     protected $attributes = [
+        'is_successful' => true,
         'sha256_hash' => null,
         'bytes' => 0,
     ];
@@ -69,6 +72,7 @@ class Backup extends Model
     public static $validationRules = [
         'server_id' => 'bail|required|numeric|exists:servers,id',
         'uuid' => 'required|uuid',
+        'is_successful' => 'boolean',
         'name' => 'required|string',
         'ignored_files' => 'array',
         'disk' => 'required|string',

app/Repositories/Eloquent/BackupRepository.php

@@ -27,6 +27,7 @@ public function getBackupsGeneratedDuringTimespan(int $server, int $minutes = 10
         return $this->getBuilder()
             ->withTrashed()
             ->where('server_id', $server)
+            ->where('is_successful', true)
             ->where('created_at', '>=', Carbon::now()->subMinutes($minutes)->toDateTimeString())
             ->get()
             ->toBase();

app/Services/Backups/InitiateBackupService.php

@@ -2,7 +2,6 @@
 
 namespace Pterodactyl\Services\Backups;
 
-use Carbon\Carbon;
 use Ramsey\Uuid\Uuid;
 use Carbon\CarbonImmutable;
 use Webmozart\Assert\Assert;
@@ -101,14 +100,14 @@ public function setIgnoredFiles(?array $ignored)
     public function handle(Server $server, string $name = null): Backup
     {
         // Do not allow the user to continue if this server is already at its limit.
-        if (! $server->backup_limit || $server->backups()->count() >= $server->backup_limit) {
+        if (! $server->backup_limit || $server->backups()->where('is_successful', true)->count() >= $server->backup_limit) {
             throw new TooManyBackupsException($server->backup_limit);
         }
 
         $previous = $this->repository->getBackupsGeneratedDuringTimespan($server->id, 10);
         if ($previous->count() >= 2) {
             throw new TooManyRequestsHttpException(
-                Carbon::now()->diffInSeconds($previous->last()->created_at->addMinutes(10)),
+                CarbonImmutable::now()->diffInSeconds($previous->last()->created_at->addMinutes(10)),
                 'Only two backups may be generated within a 10 minute span of time.'
             );
         }

app/Transformers/Api/Client/BackupTransformer.php

@@ -22,6 +22,7 @@ public function transform(Backup $backup)
     {
         return [
             'uuid' => $backup->uuid,
+            'is_successful' => $backup->is_successful,
             'name' => $backup->name,
             'ignored_files' => $backup->ignored_files,
             'sha256_hash' => $backup->sha256_hash,

database/migrations/2020_08_20_205533_add_backup_state_column_to_backups.php

@@ -0,0 +1,32 @@
+<?php
+
+use Illuminate\Database\Migrations\Migration;
+use Illuminate\Database\Schema\Blueprint;
+use Illuminate\Support\Facades\Schema;
+
+class AddBackupStateColumnToBackups extends Migration
+{
+    /**
+     * Run the migrations.
+     *
+     * @return void
+     */
+    public function up()
+    {
+        Schema::table('backups', function (Blueprint $table) {
+            $table->boolean('is_successful')->after('uuid')->default(true);
+        });
+    }
+
+    /**
+     * Reverse the migrations.
+     *
+     * @return void
+     */
+    public function down()
+    {
+        Schema::table('backups', function (Blueprint $table) {
+            $table->dropColumn('is_successful');
+        });
+    }
+}