Fix handling of backup tasks; closes pterodactyl#2067

Author: DaneEveritt

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

@@ -58,7 +58,7 @@ public function store(StoreTaskRequest $request, Server $server, Schedule $sched
             'schedule_id' => $schedule->id,
             'sequence_id' => ($lastTask->sequence_id ?? 0) + 1,
             'action' => $request->input('action'),
-            'payload' => $request->input('payload'),
+            'payload' => $request->input('payload') ?? '',
             'time_offset' => $request->input('time_offset'),
         ]);
 
@@ -87,7 +87,7 @@ public function update(StoreTaskRequest $request, Server $server, Schedule $sche
 
         $this->repository->update($task->id, [
             'action' => $request->input('action'),
-            'payload' => $request->input('payload'),
+            'payload' => $request->input('payload') ?? '',
             'time_offset' => $request->input('time_offset'),
         ]);
 

app/Http/Requests/Api/Client/Servers/Schedules/StoreTaskRequest.php

@@ -25,7 +25,7 @@ public function rules(): array
     {
         return [
             'action' => 'required|in:command,power,backup',
-            'payload' => 'required_unless:action,backup|string',
+            'payload' => 'required_unless:action,backup|string|nullable',
             'time_offset' => 'required|numeric|min:0|max:900',
             'sequence_id' => 'sometimes|required|numeric|min:1',
         ];

app/Models/Task.php

@@ -90,7 +90,7 @@ class Task extends Model
         'schedule_id' => 'required|numeric|exists:schedules,id',
         'sequence_id' => 'required|numeric|min:1',
         'action' => 'required|string',
-        'payload' => 'required|string',
+        'payload' => 'required_unless:action,backup|string',
         'time_offset' => 'required|numeric|between:0,900',
         'is_queued' => 'boolean',
     ];

resources/scripts/components/server/schedules/ScheduleTaskRow.tsx

@@ -14,12 +14,26 @@ import Can from '@/components/elements/Can';
 import useServer from '@/plugins/useServer';
 import useFlash from '@/plugins/useFlash';
 import { ServerContext } from '@/state/server';
+import { faFileArchive } from '@fortawesome/free-solid-svg-icons/faFileArchive';
 
 interface Props {
     schedule: Schedule;
     task: Task;
 }
 
+const getActionDetails = (action: string): [ string, any ] => {
+    switch (action) {
+    case 'command':
+        return ['Send Command', faCode];
+    case 'power':
+        return ['Send Power Action', faToggleOn];
+    case 'backup':
+        return ['Create Backup', faFileArchive];
+    default:
+        return ['Unknown Action', faCode];
+    }
+};
+
 export default ({ schedule, task }: Props) => {
     const { uuid } = useServer();
     const { clearFlashes, addError } = useFlash();
@@ -43,6 +57,8 @@ export default ({ schedule, task }: Props) => {
             });
     };
 
+    const [ title, icon ] = getActionDetails(task.action);
+
     return (
         <div className={'flex items-center bg-neutral-700 border border-neutral-600 mb-2 px-6 py-4 rounded'}>
             <SpinnerOverlay visible={isLoading} fixed={true} size={'large'}/>
@@ -56,14 +72,19 @@ export default ({ schedule, task }: Props) => {
                 onDismissed={() => setVisible(false)}
                 onConfirmed={() => onConfirmDeletion()}
             />
-            <FontAwesomeIcon icon={task.action === 'command' ? faCode : faToggleOn} className={'text-lg text-white'}/>
+            <FontAwesomeIcon icon={icon} className={'text-lg text-white'}/>
             <div className={'flex-1'}>
-                <p className={'ml-6 text-neutral-300 mb-2 uppercase text-xs'}>
-                    {task.action === 'command' ? 'Send command' : 'Send power action'}
+                <p className={'ml-6 text-neutral-300 uppercase text-xs'}>
+                    {title}
                 </p>
-                <code className={'ml-6 font-mono bg-neutral-800 rounded py-1 px-2 text-sm'}>
-                    {task.payload}
-                </code>
+                {task.payload &&
+                <div className={'ml-6 mt-2'}>
+                    {task.action === 'backup' && <p className={'text-xs uppercase text-neutral-400 mb-1'}>Ignoring files & folders:</p>}
+                    <div className={'font-mono bg-neutral-800 rounded py-1 px-2 text-sm w-auto whitespace-pre inline-block'}>
+                        {task.payload}
+                    </div>
+                </div>
+                }
             </div>
             {task.sequenceId > 1 &&
             <div className={'mr-6'}>

resources/scripts/components/server/schedules/TaskDetailsModal.tsx

@@ -71,7 +71,10 @@ const TaskDetailsForm = ({ isEditingTask }: { isEditingTask: boolean }) => {
                             :
                             <div>
                                 <label className={'input-dark-label'}>Ignored Files</label>
-                                <FormikFieldWrapper name={'payload'}>
+                                <FormikFieldWrapper
+                                    name={'payload'}
+                                    description={'Optional. Include the files and folders to be excluded in this backup. By default, the contents of your .pteroignore file will be used.'}
+                                >
                                     <FormikField as={'textarea'} name={'payload'} className={'input-dark h-32'}/>
                                 </FormikFieldWrapper>
                             </div>