From 552b9d3c33d9528f02b25d23bd2fc5a2f86bc08e Mon Sep 17 00:00:00 2001 From: Julien Tant Date: Sat, 24 Apr 2021 15:06:21 -0700 Subject: [PATCH 1/5] Add possibility to run disabled cron --- .../Api/Client/Servers/ScheduleController.php | 4 ---- app/Jobs/Schedule/RunTaskJob.php | 14 ++++++++++---- app/Services/Schedules/ProcessScheduleService.php | 2 +- .../server/schedules/ScheduleEditContainer.tsx | 2 +- 4 files changed, 12 insertions(+), 10 deletions(-) diff --git a/app/Http/Controllers/Api/Client/Servers/ScheduleController.php b/app/Http/Controllers/Api/Client/Servers/ScheduleController.php index 320133595..5b2609e58 100644 --- a/app/Http/Controllers/Api/Client/Servers/ScheduleController.php +++ b/app/Http/Controllers/Api/Client/Servers/ScheduleController.php @@ -156,10 +156,6 @@ class ScheduleController extends ClientApiController */ public function execute(TriggerScheduleRequest $request, Server $server, Schedule $schedule) { - if (!$schedule->is_active) { - throw new BadRequestHttpException('Cannot trigger schedule exection for a schedule that is not currently active.'); - } - $this->service->handle($schedule, true); return new JsonResponse([], JsonResponse::HTTP_ACCEPTED); diff --git a/app/Jobs/Schedule/RunTaskJob.php b/app/Jobs/Schedule/RunTaskJob.php index 3dd8e920d..b2b51578c 100644 --- a/app/Jobs/Schedule/RunTaskJob.php +++ b/app/Jobs/Schedule/RunTaskJob.php @@ -27,13 +27,19 @@ class RunTaskJob extends Job implements ShouldQueue */ public $task; + /** + * @var bool + */ + public $now; + /** * RunTaskJob constructor. */ - public function __construct(Task $task) + public function __construct(Task $task, $now = false) { $this->queue = config('pterodactyl.queues.standard'); $this->task = $task; + $this->now = $now; } /** @@ -46,8 +52,8 @@ class RunTaskJob extends Job implements ShouldQueue InitiateBackupService $backupService, DaemonPowerRepository $powerRepository ) { - // Do not process a task that is not set to active. - if (!$this->task->schedule->is_active) { + // Do not process a task that is not set to active, unless it's been trigger by the run now API. + if ($this->task->schedule->is_active && !$this->now) { $this->markTaskNotQueued(); $this->markScheduleComplete(); @@ -101,7 +107,7 @@ class RunTaskJob extends Job implements ShouldQueue $nextTask->update(['is_queued' => true]); - $this->dispatch((new self($nextTask))->delay($nextTask->time_offset)); + $this->dispatch((new self($nextTask, $this->now))->delay($nextTask->time_offset)); } /** diff --git a/app/Services/Schedules/ProcessScheduleService.php b/app/Services/Schedules/ProcessScheduleService.php index 23c9ea5e8..9e62d45cb 100644 --- a/app/Services/Schedules/ProcessScheduleService.php +++ b/app/Services/Schedules/ProcessScheduleService.php @@ -53,7 +53,7 @@ class ProcessScheduleService $task->update(['is_queued' => true]); }); - $job = new RunTaskJob($task); + $job = new RunTaskJob($task, $now); if (!$now) { $this->dispatcher->dispatch($job->delay($task->time_offset)); diff --git a/resources/scripts/components/server/schedules/ScheduleEditContainer.tsx b/resources/scripts/components/server/schedules/ScheduleEditContainer.tsx index df0af5b99..60d7ca943 100644 --- a/resources/scripts/components/server/schedules/ScheduleEditContainer.tsx +++ b/resources/scripts/components/server/schedules/ScheduleEditContainer.tsx @@ -161,7 +161,7 @@ export default () => { onDeleted={() => history.push(`/server/${id}/schedules`)} /> - {schedule.isActive && schedule.tasks.length > 0 && + {schedule.tasks.length > 0 && From 6ef60633d3b73a1fe1d65b1fe54aa4d510f883e1 Mon Sep 17 00:00:00 2001 From: Dane Everitt Date: Sat, 24 Apr 2021 16:39:56 -0700 Subject: [PATCH 2/5] Additional coverage to ensure values are wrapped as expected; ref #3287 --- .../Commands/EnvironmentWriterTrait.php | 30 ++++++------- .../Helpers/EnvironmentWriterTraitTest.php | 43 +++++++++++++++++++ 2 files changed, 58 insertions(+), 15 deletions(-) create mode 100644 tests/Unit/Helpers/EnvironmentWriterTraitTest.php diff --git a/app/Traits/Commands/EnvironmentWriterTrait.php b/app/Traits/Commands/EnvironmentWriterTrait.php index 10692a9a4..5435dc321 100644 --- a/app/Traits/Commands/EnvironmentWriterTrait.php +++ b/app/Traits/Commands/EnvironmentWriterTrait.php @@ -1,11 +1,4 @@ . - * - * This software is licensed under the terms of the MIT license. - * https://opensource.org/licenses/MIT - */ namespace Pterodactyl\Traits\Commands; @@ -13,6 +6,20 @@ use Pterodactyl\Exceptions\PterodactylException; trait EnvironmentWriterTrait { + /** + * Escapes an environment value by looking for any characters that could + * reasonablly cause environment parsing issues. Those values are then wrapped + * in quotes before being returned. + */ + public function escapeEnvironmentValue(string $value): string + { + if (!preg_match('/^\"(.*)\"$/', $value) && preg_match('/([^\w.\-+\/])+/', $value)) { + return sprintf('"%s"', addslashes($value)); + } + + return $value; + } + /** * Update the .env file for the application using the passed in values. * @@ -28,14 +35,7 @@ trait EnvironmentWriterTrait $saveContents = file_get_contents($path); collect($values)->each(function ($value, $key) use (&$saveContents) { $key = strtoupper($key); - // If the key value is not sorrounded by quotation marks, and contains anything that could reasonably - // cause environment parsing issues, wrap it in quotes before writing it. This also adds slashes to the - // value to ensure quotes within it don't cause us issues. - if (!preg_match('/^\"(.*)\"$/', $value) && preg_match('/([^\w.\-+\/])+/', $value)) { - $value = sprintf('"%s"', addslashes($value)); - } - - $saveValue = sprintf('%s=%s', $key, $value); + $saveValue = sprintf('%s=%s', $key, $this->escapeEnvironmentValue($value)); if (preg_match_all('/^' . $key . '=(.*)$/m', $saveContents) < 1) { $saveContents = $saveContents . PHP_EOL . $saveValue; diff --git a/tests/Unit/Helpers/EnvironmentWriterTraitTest.php b/tests/Unit/Helpers/EnvironmentWriterTraitTest.php new file mode 100644 index 000000000..f2022f798 --- /dev/null +++ b/tests/Unit/Helpers/EnvironmentWriterTraitTest.php @@ -0,0 +1,43 @@ +escapeEnvironmentValue($input); + + $this->assertSame($expected, $output); + } + + public function variableDataProvider(): array + { + return [ + ['foo', 'foo'], + ['abc123', 'abc123'], + ['val"ue', '"val\"ue"'], + ['my test value', '"my test value"'], + ['mysql_p@assword', '"mysql_p@assword"'], + ['mysql_p#assword', '"mysql_p#assword"'], + ['mysql p@$$word', '"mysql p@$$word"'], + ['mysql p%word', '"mysql p%word"'], + ['mysql p#word', '"mysql p#word"'], + ['abc_@#test', '"abc_@#test"'], + ['test 123 $$$', '"test 123 $$$"'], + ['#password%', '"#password%"'], + ['$pass ', '"$pass "'], + ]; + } +} + +class FooClass +{ + use EnvironmentWriterTrait; +} From d0c7e2c0e62f67ae3b78bc64c61d472bfeffc72f Mon Sep 17 00:00:00 2001 From: Dane Everitt Date: Sat, 24 Apr 2021 16:45:54 -0700 Subject: [PATCH 3/5] Update CHANGELOG.md --- CHANGELOG.md | 11 +++++++++++ 1 file changed, 11 insertions(+) diff --git a/CHANGELOG.md b/CHANGELOG.md index f070441be..dbf875146 100644 --- a/CHANGELOG.md +++ b/CHANGELOG.md @@ -3,6 +3,17 @@ This file is a running track of new features and fixes to each version of the pa This project follows [Semantic Versioning](http://semver.org) guidelines. +## v1.4.0 +### Fixed +* Removes the use of tagging when storing server resource usage in the cache. This addresses errors encountered when using the `file` driver. +* Fixes Wings response handling if Wings returns an error response with a 200-level status code that would improperly be passed back to the client as a successful request. +* Fixes use of JSON specific functions in SQL queries to better support MariaDB users. +* Fixes a migration that could fail on some MySQL/MariaDB setups when trying to encrypt node token values. + +### Changed +* Increases the maximum length allowed for a server name using the Rust egg. +* Updated server resource utilization API call to Wings to use new API response format used by `Wings@1.4.0`. + ## v1.3.2 ### Fixed * Fixes self-upgrade incorrectly executing the command to un-tar downloaded archives. From f7f972b33dac2885821ac5d551a0d0617df13f75 Mon Sep 17 00:00:00 2001 From: Julien Tant Date: Sat, 24 Apr 2021 18:18:29 -0700 Subject: [PATCH 4/5] rename now variable & fix condition --- app/Jobs/Schedule/RunTaskJob.php | 12 ++++++------ 1 file changed, 6 insertions(+), 6 deletions(-) diff --git a/app/Jobs/Schedule/RunTaskJob.php b/app/Jobs/Schedule/RunTaskJob.php index b2b51578c..f60711f43 100644 --- a/app/Jobs/Schedule/RunTaskJob.php +++ b/app/Jobs/Schedule/RunTaskJob.php @@ -30,16 +30,16 @@ class RunTaskJob extends Job implements ShouldQueue /** * @var bool */ - public $now; + public $manualRun; /** * RunTaskJob constructor. */ - public function __construct(Task $task, $now = false) + public function __construct(Task $task, $manualRun = false) { $this->queue = config('pterodactyl.queues.standard'); $this->task = $task; - $this->now = $now; + $this->manualRun = $manualRun; } /** @@ -52,8 +52,8 @@ class RunTaskJob extends Job implements ShouldQueue InitiateBackupService $backupService, DaemonPowerRepository $powerRepository ) { - // Do not process a task that is not set to active, unless it's been trigger by the run now API. - if ($this->task->schedule->is_active && !$this->now) { + // Do not process a task that is not set to active, unless it's been manually triggered. + if (!$this->task->schedule->is_active && !$this->manualRun) { $this->markTaskNotQueued(); $this->markScheduleComplete(); @@ -107,7 +107,7 @@ class RunTaskJob extends Job implements ShouldQueue $nextTask->update(['is_queued' => true]); - $this->dispatch((new self($nextTask, $this->now))->delay($nextTask->time_offset)); + $this->dispatch((new self($nextTask, $this->manualRun))->delay($nextTask->time_offset)); } /** From b10f6184e043a5deb3a45bc7b607c149a728f3f5 Mon Sep 17 00:00:00 2001 From: Julien Tant Date: Sat, 24 Apr 2021 18:30:48 -0700 Subject: [PATCH 5/5] remove the test preventing disabled schedule to be manually executed --- .../Server/Schedule/ExecuteScheduleTest.php | 20 ------------------- 1 file changed, 20 deletions(-) diff --git a/tests/Integration/Api/Client/Server/Schedule/ExecuteScheduleTest.php b/tests/Integration/Api/Client/Server/Schedule/ExecuteScheduleTest.php index 7c9d34d18..9964691aa 100644 --- a/tests/Integration/Api/Client/Server/Schedule/ExecuteScheduleTest.php +++ b/tests/Integration/Api/Client/Server/Schedule/ExecuteScheduleTest.php @@ -51,26 +51,6 @@ class ExecuteScheduleTest extends ClientApiIntegrationTestCase }); } - /** - * Test that the schedule is not executed if it is not currently active. - */ - public function testScheduleIsNotExecutedIfNotActive() - { - [$user, $server] = $this->generateTestAccount(); - - /** @var \Pterodactyl\Models\Schedule $schedule */ - $schedule = Schedule::factory()->create([ - 'server_id' => $server->id, - 'is_active' => false, - ]); - - $response = $this->actingAs($user)->postJson($this->link($schedule, '/execute')); - - $response->assertStatus(Response::HTTP_BAD_REQUEST); - $response->assertJsonPath('errors.0.code', 'BadRequestHttpException'); - $response->assertJsonPath('errors.0.detail', 'Cannot trigger schedule exection for a schedule that is not currently active.'); - } - /** * Test that a user without the schedule update permission cannot execute it. */