Add underlying data changes necessary for new task & schedule features

Author: DaneEveritt

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

@@ -16,7 +16,6 @@
 use Pterodactyl\Transformers\Api\Client\ScheduleTransformer;
 use Pterodactyl\Http\Controllers\Api\Client\ClientApiController;
 use Symfony\Component\HttpKernel\Exception\NotFoundHttpException;
-use Symfony\Component\HttpKernel\Exception\BadRequestHttpException;
 use Pterodactyl\Http\Requests\Api\Client\Servers\Schedules\ViewScheduleRequest;
 use Pterodactyl\Http\Requests\Api\Client\Servers\Schedules\StoreScheduleRequest;
 use Pterodactyl\Http\Requests\Api\Client\Servers\Schedules\DeleteScheduleRequest;
@@ -81,6 +80,7 @@ public function store(StoreScheduleRequest $request, Server $server)
             'cron_hour' => $request->input('hour'),
             'cron_minute' => $request->input('minute'),
             'is_active' => (bool) $request->input('is_active'),
+            'only_when_online' => (bool) $request->input('only_when_online'),
             'next_run_at' => $this->getNextRunAt($request),
         ]);
 
@@ -128,6 +128,7 @@ public function update(UpdateScheduleRequest $request, Server $server, Schedule
             'cron_hour' => $request->input('hour'),
             'cron_minute' => $request->input('minute'),
             'is_active' => $active,
+            'only_when_online' => (bool) $request->input('only_when_online'),
             'next_run_at' => $this->getNextRunAt($request),
         ];
 

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

@@ -59,6 +59,7 @@ public function store(StoreTaskRequest $request, Server $server, Schedule $sched
             'action' => $request->input('action'),
             'payload' => $request->input('payload') ?? '',
             'time_offset' => $request->input('time_offset'),
+            'continue_on_failure' => (bool) $request->input('continue_on_failure'),
         ]);
 
         return $this->fractal->item($task)
@@ -84,6 +85,7 @@ public function update(StoreTaskRequest $request, Server $server, Schedule $sche
             'action' => $request->input('action'),
             'payload' => $request->input('payload') ?? '',
             'time_offset' => $request->input('time_offset'),
+            'continue_on_failure' => (bool) $request->input('continue_on_failure'),
         ]);
 
         return $this->fractal->item($task->refresh())

app/Jobs/Schedule/RunTaskJob.php

@@ -7,6 +7,7 @@
 use Carbon\CarbonImmutable;
 use Pterodactyl\Models\Task;
 use InvalidArgumentException;
+use Illuminate\Http\Response;
 use Pterodactyl\Models\Schedule;
 use Illuminate\Queue\SerializesModels;
 use Illuminate\Queue\InteractsWithQueue;
@@ -15,6 +16,7 @@
 use Pterodactyl\Services\Backups\InitiateBackupService;
 use Pterodactyl\Repositories\Wings\DaemonPowerRepository;
 use Pterodactyl\Repositories\Wings\DaemonCommandRepository;
+use Pterodactyl\Exceptions\Http\Connection\DaemonConnectionException;
 
 class RunTaskJob extends Job implements ShouldQueue
 {
@@ -62,18 +64,32 @@ public function handle(
 
         $server = $this->task->server;
         // Perform the provided task against the daemon.
-        switch ($this->task->action) {
-            case 'power':
-                $powerRepository->setServer($server)->send($this->task->payload);
-                break;
-            case 'command':
-                $commandRepository->setServer($server)->send($this->task->payload);
-                break;
-            case 'backup':
-                $backupService->setIgnoredFiles(explode(PHP_EOL, $this->task->payload))->handle($server, null, true);
-                break;
-            default:
-                throw new InvalidArgumentException('Cannot run a task that points to a non-existent action.');
+        try {
+            switch ($this->task->action) {
+                case Task::ACTION_POWER:
+                    $powerRepository->setServer($server)->send($this->task->payload);
+                    break;
+                case Task::ACTION_COMMAND:
+                    $commandRepository->setServer($server)->send($this->task->payload);
+                    break;
+                case Task::ACTION_BACKUP:
+                    $backupService->setIgnoredFiles(explode(PHP_EOL, $this->task->payload))->handle($server, null, true);
+                    break;
+                default:
+                    throw new InvalidArgumentException('Cannot run a task that points to a non-existent action.');
+            }
+        } catch (Exception $exception) {
+            if ($exception instanceof DaemonConnectionException) {
+                // If the task "failed" because the server is offline and it was sending a command or
+                // executing a power action (which shouldn't happen?) then just stop trying to process
+                // the schedule, but don't actually log the failure.
+                if ($this->task->action === Task::ACTION_POWER || $this->task->action === Task::ACTION_COMMAND) {
+                    // Do the thing
+                    if ($exception->getStatusCode() === Response::HTTP_CONFLICT) {
+                    }
+                }
+            }
+            throw $exception;
         }
 
         $this->markTaskNotQueued();

app/Models/Schedule.php

@@ -18,6 +18,7 @@
  * @property string $cron_minute
  * @property bool $is_active
  * @property bool $is_processing
+ * @property bool $only_when_online
  * @property \Carbon\Carbon|null $last_run_at
  * @property \Carbon\Carbon|null $next_run_at
  * @property \Carbon\Carbon $created_at
@@ -63,6 +64,7 @@ class Schedule extends Model
         'cron_minute',
         'is_active',
         'is_processing',
+        'only_when_online',
         'last_run_at',
         'next_run_at',
     ];
@@ -75,6 +77,7 @@ class Schedule extends Model
         'server_id' => 'integer',
         'is_active' => 'boolean',
         'is_processing' => 'boolean',
+        'only_when_online' => 'boolean',
     ];
 
     /**
@@ -99,6 +102,7 @@ class Schedule extends Model
         'cron_minute' => '*',
         'is_active' => true,
         'is_processing' => false,
+        'only_when_online' => false,
     ];
 
     /**
@@ -114,6 +118,7 @@ class Schedule extends Model
         'cron_minute' => 'required|string',
         'is_active' => 'boolean',
         'is_processing' => 'boolean',
+        'only_when_online' => 'boolean',
         'last_run_at' => 'nullable|date',
         'next_run_at' => 'nullable|date',
     ];
@@ -122,6 +127,7 @@ class Schedule extends Model
      * Returns the schedule's execution crontab entry as a string.
      *
      * @return \Carbon\CarbonImmutable
+     *
      * @throws \Exception
      */
     public function getNextRunDate()

app/Models/Task.php

@@ -14,6 +14,7 @@
  * @property string $payload
  * @property int $time_offset
  * @property bool $is_queued
+ * @property bool $continue_on_failure
  * @property \Carbon\Carbon $created_at
  * @property \Carbon\Carbon $updated_at
  * @property string $hashid
@@ -30,6 +31,13 @@ class Task extends Model
      */
     public const RESOURCE_NAME = 'schedule_task';
 
+    /**
+     * The default actions that can exist for a task in Pterodactyl.
+     */
+    public const ACTION_POWER = 'power';
+    public const ACTION_COMMAND = 'command';
+    public const ACTION_BACKUP = 'backup';
+
     /**
      * The table associated with the model.
      *
@@ -56,6 +64,7 @@ class Task extends Model
         'payload',
         'time_offset',
         'is_queued',
+        'continue_on_failure',
     ];
 
     /**
@@ -69,6 +78,7 @@ class Task extends Model
         'sequence_id' => 'integer',
         'time_offset' => 'integer',
         'is_queued' => 'boolean',
+        'continue_on_failure' => 'boolean',
     ];
 
     /**
@@ -79,6 +89,7 @@ class Task extends Model
     protected $attributes = [
         'time_offset' => 0,
         'is_queued' => false,
+        'continue_on_failure' => false,
     ];
 
     /**
@@ -91,6 +102,7 @@ class Task extends Model
         'payload' => 'required_unless:action,backup|string',
         'time_offset' => 'required|numeric|between:0,900',
         'is_queued' => 'boolean',
+        'continue_on_failure' => 'boolean',
     ];
 
     /**

app/Transformers/Api/Client/ScheduleTransformer.php

@@ -45,6 +45,7 @@ public function transform(Schedule $model)
             ],
             'is_active' => $model->is_active,
             'is_processing' => $model->is_processing,
+            'only_when_online' => $model->only_when_online,
             'last_run_at' => $model->last_run_at ? $model->last_run_at->toIso8601String() : null,
             'next_run_at' => $model->next_run_at ? $model->next_run_at->toIso8601String() : null,
             'created_at' => $model->created_at->toIso8601String(),

app/Transformers/Api/Client/TaskTransformer.php

@@ -28,6 +28,7 @@ public function transform(Task $model)
             'payload' => $model->payload,
             'time_offset' => $model->time_offset,
             'is_queued' => $model->is_queued,
+            'continue_on_failure' => $model->continue_on_failure,
             'created_at' => $model->created_at->toIso8601String(),
             'updated_at' => $model->updated_at->toIso8601String(),
         ];

database/migrations/2021_05_01_092457_add_continue_on_failure_option_to_tasks.php

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

database/migrations/2021_05_01_092523_add_only_run_when_server_online_option_to_schedules.php

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

resources/scripts/api/server/schedules/createOrUpdateSchedule.ts

@@ -1,20 +1,19 @@
 import { rawDataToServerSchedule, Schedule } from '@/api/server/schedules/getServerSchedules';
 import http from '@/api/http';
 
-type Data = Pick<Schedule, 'cron' | 'name' | 'isActive'> & { id?: number }
+type Data = Pick<Schedule, 'cron' | 'name' | 'onlyWhenOnline' | 'isActive'> & { id?: number }
 
-export default (uuid: string, schedule: Data): Promise<Schedule> => {
-    return new Promise((resolve, reject) => {
-        http.post(`/api/client/servers/${uuid}/schedules${schedule.id ? `/${schedule.id}` : ''}`, {
-            is_active: schedule.isActive,
-            name: schedule.name,
-            minute: schedule.cron.minute,
-            hour: schedule.cron.hour,
-            day_of_month: schedule.cron.dayOfMonth,
-            month: schedule.cron.month,
-            day_of_week: schedule.cron.dayOfWeek,
-        })
-            .then(({ data }) => resolve(rawDataToServerSchedule(data.attributes)))
-            .catch(reject);
+export default async (uuid: string, schedule: Data): Promise<Schedule> => {
+    const { data } = await http.post(`/api/client/servers/${uuid}/schedules${schedule.id ? `/${schedule.id}` : ''}`, {
+        is_active: schedule.isActive,
+        only_when_online: schedule.onlyWhenOnline,
+        name: schedule.name,
+        minute: schedule.cron.minute,
+        hour: schedule.cron.hour,
+        day_of_month: schedule.cron.dayOfMonth,
+        month: schedule.cron.month,
+        day_of_week: schedule.cron.dayOfWeek,
     });
+
+    return rawDataToServerSchedule(data.attributes);
 };