Begin adding schedule processing jobs.

2017-09-16 23:10:00 -05:00 · 2017-09-16 23:10:00 -05:00 · c5f2dfd6f6
commit c5f2dfd6f6
parent c0d7e02481
16 changed files with 626 additions and 49 deletions
--- a/app/Jobs/Schedule/RunTaskJob.php
+++ b/app/Jobs/Schedule/RunTaskJob.php
@ -0,0 +1,191 @@
+<?php
+/*
+ * Pterodactyl - Panel
+ * Copyright (c) 2015 - 2017 Dane Everitt <dane@daneeveritt.com>.
+ *
+ * Permission is hereby granted, free of charge, to any person obtaining a copy
+ * of this software and associated documentation files (the "Software"), to deal
+ * in the Software without restriction, including without limitation the rights
+ * to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+ * copies of the Software, and to permit persons to whom the Software is
+ * furnished to do so, subject to the following conditions:
+ *
+ * The above copyright notice and this permission notice shall be included in all
+ * copies or substantial portions of the Software.
+ *
+ * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+ * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+ * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+ * AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+ * LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+ * OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+ * SOFTWARE.
+ */
+
+namespace Pterodactyl\Jobs\Schedule;
+
+use Exception;
+use Carbon\Carbon;
+use Pterodactyl\Jobs\Job;
+use Webmozart\Assert\Assert;
+use InvalidArgumentException;
+use Illuminate\Queue\SerializesModels;
+use Illuminate\Queue\InteractsWithQueue;
+use Illuminate\Contracts\Queue\ShouldQueue;
+use Illuminate\Foundation\Bus\DispatchesJobs;
+use Pterodactyl\Contracts\Repository\TaskRepositoryInterface;
+use Pterodactyl\Contracts\Repository\ScheduleRepositoryInterface;
+use Pterodactyl\Contracts\Repository\Daemon\PowerRepositoryInterface;
+use Pterodactyl\Contracts\Repository\Daemon\CommandRepositoryInterface;
+
+class RunTaskJob extends Job implements ShouldQueue
+{
+    use DispatchesJobs, InteractsWithQueue, SerializesModels;
+
+    /**
+     * @var \Pterodactyl\Contracts\Repository\Daemon\CommandRepositoryInterface
+     */
+    protected $commandRepository;
+
+    /**
+     * @var \Pterodactyl\Contracts\Repository\Daemon\PowerRepositoryInterface
+     */
+    protected $powerRepository;
+
+    /**
+     * @var int
+     */
+    protected $schedule;
+
+    /**
+     * @var int
+     */
+    public $task;
+
+    /**
+     * @var \Pterodactyl\Contracts\Repository\TaskRepositoryInterface
+     */
+    protected $taskRepository;
+
+    /**
+     * RunTaskJob constructor.
+     *
+     * @param int $task
+     * @param int $schedule
+     */
+    public function __construct($task, $schedule)
+    {
+        Assert::integerish($task, 'First argument passed to constructor must be numeric, received %s.');
+
+        $this->queue = app()->make('config')->get('pterodactyl.queues.standard');
+        $this->task = $task;
+        $this->schedule = $schedule;
+    }
+
+    /**
+     * Run the job and send actions to the daemon running the server.
+     *
+     * @param \Pterodactyl\Contracts\Repository\Daemon\CommandRepositoryInterface $commandRepository
+     * @param \Pterodactyl\Contracts\Repository\Daemon\PowerRepositoryInterface   $powerRepository
+     * @param \Pterodactyl\Contracts\Repository\TaskRepositoryInterface           $taskRepository
+     *
+     * @throws \Pterodactyl\Exceptions\Model\DataValidationException
+     * @throws \Pterodactyl\Exceptions\Repository\Daemon\InvalidPowerSignalException
+     * @throws \Pterodactyl\Exceptions\Repository\RecordNotFoundException
+     */
+    public function handle(
+        CommandRepositoryInterface $commandRepository,
+        PowerRepositoryInterface $powerRepository,
+        TaskRepositoryInterface $taskRepository
+    ) {
+        $this->commandRepository = $commandRepository;
+        $this->powerRepository = $powerRepository;
+        $this->taskRepository = $taskRepository;
+
+        $task = $this->taskRepository->getTaskWithServer($this->task);
+        $server = $task->server;
+
+        // Perform the provided task aganist the daemon.
+        switch ($task->action) {
+            case 'power':
+                $this->powerRepository->setNode($server->node_id)
+                    ->setAccessServer($server->uuid)
+                    ->setAccessToken($server->daemonSecret)
+                    ->sendSignal($task->payload);
+                break;
+            case 'command':
+                $this->commandRepository->setNode($server->node_id)
+                    ->setAccessServer($server->uuid)
+                    ->setAccessToken($server->daemonSecret)
+                    ->send($task->payload);
+                break;
+            default:
+                throw new InvalidArgumentException('Cannot run a task that points to a non-existant action.');
+        }
+
+        $this->markTaskNotQueued();
+        $this->queueNextTask($task->sequence_id);
+    }
+
+    /**
+     * Handle a failure while sending the action to the daemon or otherwise processing the job.
+     *
+     * @param null|\Exception $exception
+     *
+     * @throws \Pterodactyl\Exceptions\Model\DataValidationException
+     * @throws \Pterodactyl\Exceptions\Repository\RecordNotFoundException
+     */
+    public function failed(Exception $exception = null)
+    {
+        $this->markTaskNotQueued();
+        $this->markScheduleComplete();
+    }
+
+    /**
+     * Get the next task in the schedule and queue it for running after the defined period of wait time.
+     *
+     * @param int $sequence
+     *
+     * @throws \Pterodactyl\Exceptions\Model\DataValidationException
+     * @throws \Pterodactyl\Exceptions\Repository\RecordNotFoundException
+     */
+    private function queueNextTask($sequence)
+    {
+        $nextTask = $this->taskRepository->getNextTask($this->schedule, $sequence);
+        if (is_null($nextTask)) {
+            $this->markScheduleComplete();
+
+            return;
+        }
+
+        $this->taskRepository->update($nextTask->id, ['is_queued' => true]);
+        $this->dispatch((new self($nextTask->id, $this->schedule))->delay($nextTask->time_offset));
+    }
+
+    /**
+     * Marks the parent schedule as being complete.
+     *
+     * @throws \Pterodactyl\Exceptions\Model\DataValidationException
+     * @throws \Pterodactyl\Exceptions\Repository\RecordNotFoundException
+     */
+    private function markScheduleComplete()
+    {
+        $repository = app()->make(ScheduleRepositoryInterface::class);
+        $repository->withoutFresh()->update($this->schedule, [
+            'is_processing' => false,
+            'last_run_at' => app()->make(Carbon::class)->now()->toDateTimeString(),
+        ]);
+    }
+
+    /**
+     * Mark a specific task as no longer being queued.
+     *
+     * @throws \Pterodactyl\Exceptions\Model\DataValidationException
+     * @throws \Pterodactyl\Exceptions\Repository\RecordNotFoundException
+     */
+    private function markTaskNotQueued()
+    {
+        $repository = app()->make(TaskRepositoryInterface::class);
+        $repository->update($this->task, ['is_queued' => false]);
+    }
+}