Upgrade to Laravel 9 (#4413)

Co-authored-by: DaneEveritt <dane@daneeveritt.com>

app/Http/Controllers/Api/Remote/ActivityProcessingController.php

@@ -4,12 +4,13 @@ namespace Pterodactyl\Http\Controllers\Api\Remote;
 
 use Exception;
 use Carbon\Carbon;
+use DateTimeInterface;
 use Illuminate\Support\Str;
 use Pterodactyl\Models\User;
 use Webmozart\Assert\Assert;
 use Pterodactyl\Models\Server;
-use Pterodactyl\Models\ActivityLog;
 use Illuminate\Support\Facades\Log;
+use Pterodactyl\Models\ActivityLog;
 use Pterodactyl\Models\ActivityLogSubject;
 use Pterodactyl\Http\Controllers\Controller;
 use Pterodactyl\Http\Requests\Api\Remote\ActivityEventRequest;
@@ -36,7 +37,7 @@ class ActivityProcessingController extends Controller
 
             try {
                 $when = Carbon::createFromFormat(
-                    Carbon::RFC3339,
+                    DateTimeInterface::RFC3339,
                     preg_replace('/(\.\d+)Z$/', 'Z', $datum['timestamp']),
                     'UTC'
                 );

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

@@ -6,10 +6,9 @@ use Carbon\CarbonImmutable;
 use Illuminate\Http\Request;
 use Pterodactyl\Models\Backup;
 use Illuminate\Http\JsonResponse;
-use League\Flysystem\AwsS3v3\AwsS3Adapter;
 use Pterodactyl\Http\Controllers\Controller;
 use Pterodactyl\Extensions\Backups\BackupManager;
-use Pterodactyl\Repositories\Eloquent\BackupRepository;
+use Pterodactyl\Extensions\Filesystem\S3Filesystem;
 use Symfony\Component\HttpKernel\Exception\ConflictHttpException;
 use Symfony\Component\HttpKernel\Exception\BadRequestHttpException;
 
@@ -17,35 +16,21 @@ class BackupRemoteUploadController extends Controller
 {
     public const DEFAULT_MAX_PART_SIZE = 5 * 1024 * 1024 * 1024;
 
-    /**
-     * @var \Pterodactyl\Repositories\Eloquent\BackupRepository
-     */
-    private $repository;
-
-    /**
-     * @var \Pterodactyl\Extensions\Backups\BackupManager
-     */
-    private $backupManager;
-
     /**
      * BackupRemoteUploadController constructor.
      */
-    public function __construct(BackupRepository $repository, BackupManager $backupManager)
+    public function __construct(private BackupManager $backupManager)
     {
-        $this->repository = $repository;
-        $this->backupManager = $backupManager;
     }
 
     /**
      * Returns the required presigned urls to upload a backup to S3 cloud storage.
      *
-     * @return \Illuminate\Http\JsonResponse
-     *
      * @throws \Exception
      * @throws \Throwable
      * @throws \Illuminate\Database\Eloquent\ModelNotFoundException
      */
-    public function __invoke(Request $request, string $backup)
+    public function __invoke(Request $request, string $backup): JsonResponse
     {
         // Get the size query parameter.
         $size = (int) $request->query('size');
@@ -64,7 +49,7 @@ class BackupRemoteUploadController extends Controller
 
         // Ensure we are using the S3 adapter.
         $adapter = $this->backupManager->adapter();
-        if (!$adapter instanceof AwsS3Adapter) {
+        if (!$adapter instanceof S3Filesystem) {
             throw new BadRequestHttpException('The configured backup adapter is not an S3 compatible adapter.');
         }
 
@@ -116,7 +101,7 @@ class BackupRemoteUploadController extends Controller
     }
 
     /**
-     * Get the configured maximum size of a single part in the multipart uplaod.
+     * Get the configured maximum size of a single part in the multipart upload.
      *
      * The function tries to retrieve a configured value from the configuration.
      * If no value is specified, a fallback value will be used.
@@ -125,10 +110,8 @@ class BackupRemoteUploadController extends Controller
      * the fallback value will be used too.
      *
      * The fallback value is {@see BackupRemoteUploadController::DEFAULT_MAX_PART_SIZE}.
-     *
-     * @return int
      */
-    private function getConfiguredMaxPartSize()
+    private function getConfiguredMaxPartSize(): int
     {
         $maxPartSize = (int) config('backups.max_part_size', self::DEFAULT_MAX_PART_SIZE);
         if ($maxPartSize <= 0) {

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

@@ -7,36 +7,28 @@ use Illuminate\Http\Request;
 use Pterodactyl\Models\Backup;
 use Illuminate\Http\JsonResponse;
 use Pterodactyl\Facades\Activity;
-use League\Flysystem\AwsS3v3\AwsS3Adapter;
 use Pterodactyl\Exceptions\DisplayException;
 use Pterodactyl\Http\Controllers\Controller;
 use Pterodactyl\Extensions\Backups\BackupManager;
+use Pterodactyl\Extensions\Filesystem\S3Filesystem;
 use Symfony\Component\HttpKernel\Exception\BadRequestHttpException;
 use Pterodactyl\Http\Requests\Api\Remote\ReportBackupCompleteRequest;
 
 class BackupStatusController extends Controller
 {
-    /**
-     * @var \Pterodactyl\Extensions\Backups\BackupManager
-     */
-    private $backupManager;
-
     /**
      * BackupStatusController constructor.
      */
-    public function __construct(BackupManager $backupManager)
+    public function __construct(private BackupManager $backupManager)
     {
-        $this->backupManager = $backupManager;
     }
 
     /**
      * Handles updating the state of a backup.
      *
-     * @return \Illuminate\Http\JsonResponse
-     *
      * @throws \Throwable
      */
-    public function index(ReportBackupCompleteRequest $request, string $backup)
+    public function index(ReportBackupCompleteRequest $request, string $backup): JsonResponse
     {
         /** @var \Pterodactyl\Models\Backup $model */
         $model = Backup::query()->where('uuid', $backup)->firstOrFail();
@@ -65,7 +57,7 @@ class BackupStatusController extends Controller
             // Check if we are using the s3 backup adapter. If so, make sure we mark the backup as
             // being completed in S3 correctly.
             $adapter = $this->backupManager->adapter();
-            if ($adapter instanceof AwsS3Adapter) {
+            if ($adapter instanceof S3Filesystem) {
                 $this->completeMultipartUpload($model, $adapter, $successful, $request->input('parts'));
             }
         });
@@ -81,8 +73,6 @@ class BackupStatusController extends Controller
      * The only thing the successful field does is update the entry value for the audit logs
      * table tracking for this restoration.
      *
-     * @return \Illuminate\Http\JsonResponse
-     *
      * @throws \Throwable
      */
     public function restore(Request $request, string $backup): JsonResponse
@@ -107,7 +97,7 @@ class BackupStatusController extends Controller
      * @throws \Exception
      * @throws \Pterodactyl\Exceptions\DisplayException
      */
-    protected function completeMultipartUpload(Backup $backup, AwsS3Adapter $adapter, bool $successful, ?array $parts): void
+    protected function completeMultipartUpload(Backup $backup, S3Filesystem $adapter, bool $successful, ?array $parts): void
     {
         // This should never really happen, but if it does don't let us fall victim to Amazon's
         // wildly fun error messaging. Just stop the process right here.

app/Http/Controllers/Api/Remote/EggInstallController.php

@@ -10,23 +10,11 @@ use Pterodactyl\Contracts\Repository\ServerRepositoryInterface;
 
 class EggInstallController extends Controller
 {
-    /**
-     * @var \Pterodactyl\Services\Servers\EnvironmentService
-     */
-    private $environment;
-
-    /**
-     * @var \Pterodactyl\Contracts\Repository\ServerRepositoryInterface
-     */
-    private $repository;
-
     /**
      * EggInstallController constructor.
      */
-    public function __construct(EnvironmentService $environment, ServerRepositoryInterface $repository)
+    public function __construct(private EnvironmentService $environment, private ServerRepositoryInterface $repository)
     {
-        $this->environment = $environment;
-        $this->repository = $repository;
     }
 
     /**

app/Http/Controllers/Api/Remote/Servers/ServerDetailsController.php

@@ -15,49 +15,24 @@ use Pterodactyl\Services\Servers\ServerConfigurationStructureService;
 
 class ServerDetailsController extends Controller
 {
-    protected ConnectionInterface $connection;
-
-    /**
-     * @var \Pterodactyl\Services\Eggs\EggConfigurationService
-     */
-    private $eggConfigurationService;
-
-    /**
-     * @var \Pterodactyl\Repositories\Eloquent\ServerRepository
-     */
-    private $repository;
-
-    /**
-     * @var \Pterodactyl\Services\Servers\ServerConfigurationStructureService
-     */
-    private $configurationStructureService;
-
     /**
      * ServerConfigurationController constructor.
      */
     public function __construct(
-        ConnectionInterface $connection,
-        ServerRepository $repository,
-        ServerConfigurationStructureService $configurationStructureService,
-        EggConfigurationService $eggConfigurationService
+        protected ConnectionInterface $connection,
+        private ServerRepository $repository,
+        private ServerConfigurationStructureService $configurationStructureService,
+        private EggConfigurationService $eggConfigurationService
     ) {
-        $this->eggConfigurationService = $eggConfigurationService;
-        $this->repository = $repository;
-        $this->configurationStructureService = $configurationStructureService;
-        $this->connection = $connection;
     }
 
     /**
      * Returns details about the server that allows Wings to self-recover and ensure
      * that the state of the server matches the Panel at all times.
      *
-     * @param string $uuid
-     *
-     * @return \Illuminate\Http\JsonResponse
-     *
      * @throws \Pterodactyl\Exceptions\Repository\RecordNotFoundException
      */
-    public function __invoke(Request $request, $uuid)
+    public function __invoke(Request $request, string $uuid): JsonResponse
     {
         $server = $this->repository->getByUuid($uuid);
 
@@ -69,15 +44,13 @@ class ServerDetailsController extends Controller
 
     /**
      * Lists all servers with their configurations that are assigned to the requesting node.
-     *
-     * @return \Pterodactyl\Http\Resources\Wings\ServerConfigurationCollection
      */
-    public function list(Request $request)
+    public function list(Request $request): ServerConfigurationCollection
     {
         /** @var \Pterodactyl\Models\Node $node */
         $node = $request->attributes->get('node');
 
-        // Avoid run-away N+1 SQL queries by pre-loading the relationships that are used
+        // Avoid run-away N+1 SQL queries by preloading the relationships that are used
         // within each of the services called below.
         $servers = Server::query()->with('allocations', 'egg', 'mounts', 'variables', 'location')
             ->where('node_id', $node->id)
@@ -94,15 +67,13 @@ class ServerDetailsController extends Controller
      * do not get incorrectly stuck in installing/restoring from backup states since
      * a Wings reboot would completely stop those processes.
      *
-     * @return \Illuminate\Http\JsonResponse
-     *
      * @throws \Throwable
      */
-    public function resetState(Request $request)
+    public function resetState(Request $request): JsonResponse
     {
         $node = $request->attributes->get('node');
 
-        // Get all of the servers that are currently marked as restoring from a backup
+        // Get all the servers that are currently marked as restoring from a backup
         // on this node that do not have a failed backup tracked in the audit logs table
         // as well.
         //

app/Http/Controllers/Api/Remote/Servers/ServerInstallController.php

@@ -15,30 +15,16 @@ use Pterodactyl\Http\Requests\Api\Remote\InstallationDataRequest;
 
 class ServerInstallController extends Controller
 {
-    /**
-     * @var \Pterodactyl\Repositories\Eloquent\ServerRepository
-     */
-    private $repository;
-
-    /**
-     * @var \Illuminate\Contracts\Events\Dispatcher
-     */
-    private $eventDispatcher;
-
     /**
      * ServerInstallController constructor.
      */
-    public function __construct(ServerRepository $repository, EventDispatcher $eventDispatcher)
+    public function __construct(private ServerRepository $repository, private EventDispatcher $eventDispatcher)
     {
-        $this->repository = $repository;
-        $this->eventDispatcher = $eventDispatcher;
     }
 
     /**
      * Returns installation information for a server.
      *
-     * @return \Illuminate\Http\JsonResponse
-     *
      * @throws \Pterodactyl\Exceptions\Repository\RecordNotFoundException
      */
     public function index(Request $request, string $uuid): JsonResponse
@@ -56,8 +42,6 @@ class ServerInstallController extends Controller
     /**
      * Updates the installation state of a server.
      *
-     * @return \Illuminate\Http\JsonResponse
-     *
      * @throws \Pterodactyl\Exceptions\Repository\RecordNotFoundException
      * @throws \Pterodactyl\Exceptions\Model\DataValidationException
      */
@@ -77,7 +61,7 @@ class ServerInstallController extends Controller
         $isInitialInstall = is_null($server->installed_at);
         if ($isInitialInstall && config()->get('pterodactyl.email.send_install_notification', true)) {
             $this->eventDispatcher->dispatch(new ServerInstalled($server));
-        } elseif (! $isInitialInstall && config()->get('pterodactyl.email.send_reinstall_notification', true)) {
+        } elseif (!$isInitialInstall && config()->get('pterodactyl.email.send_reinstall_notification', true)) {
             $this->eventDispatcher->dispatch(new ServerInstalled($server));
         }
 

app/Http/Controllers/Api/Remote/Servers/ServerTransferController.php

@@ -16,68 +16,28 @@ use Pterodactyl\Repositories\Eloquent\ServerRepository;
 use Pterodactyl\Repositories\Wings\DaemonServerRepository;
 use Pterodactyl\Repositories\Wings\DaemonTransferRepository;
 use Pterodactyl\Exceptions\Http\Connection\DaemonConnectionException;
-use Pterodactyl\Services\Servers\ServerConfigurationStructureService;
 
 class ServerTransferController extends Controller
 {
-    /**
-     * @var \Illuminate\Database\ConnectionInterface
-     */
-    private $connection;
-
-    /**
-     * @var \Pterodactyl\Repositories\Eloquent\ServerRepository
-     */
-    private $repository;
-
-    /**
-     * @var \Pterodactyl\Repositories\Wings\DaemonServerRepository
-     */
-    private $daemonServerRepository;
-
-    /**
-     * @var \Pterodactyl\Repositories\Wings\DaemonTransferRepository
-     */
-    private $daemonTransferRepository;
-
-    /**
-     * @var \Pterodactyl\Services\Servers\ServerConfigurationStructureService
-     */
-    private $configurationStructureService;
-
-    /**
-     * @var \Pterodactyl\Services\Nodes\NodeJWTService
-     */
-    private $jwtService;
-
     /**
      * ServerTransferController constructor.
      */
     public function __construct(
-        ConnectionInterface $connection,
-        ServerRepository $repository,
-        DaemonServerRepository $daemonServerRepository,
-        DaemonTransferRepository $daemonTransferRepository,
-        ServerConfigurationStructureService $configurationStructureService,
-        NodeJWTService $jwtService
+        private ConnectionInterface $connection,
+        private ServerRepository $repository,
+        private DaemonServerRepository $daemonServerRepository,
+        private DaemonTransferRepository $daemonTransferRepository,
+        private NodeJWTService $jwtService
     ) {
-        $this->connection = $connection;
-        $this->repository = $repository;
-        $this->daemonServerRepository = $daemonServerRepository;
-        $this->daemonTransferRepository = $daemonTransferRepository;
-        $this->configurationStructureService = $configurationStructureService;
-        $this->jwtService = $jwtService;
     }
 
     /**
      * The daemon notifies us about the archive status.
      *
-     * @return \Illuminate\Http\JsonResponse
-     *
      * @throws \Pterodactyl\Exceptions\Repository\RecordNotFoundException
      * @throws \Throwable
      */
-    public function archive(Request $request, string $uuid)
+    public function archive(Request $request, string $uuid): JsonResponse
     {
         $server = $this->repository->getByUuid($uuid);
 
@@ -114,11 +74,9 @@ class ServerTransferController extends Controller
     /**
      * The daemon notifies us about a transfer failure.
      *
-     * @return \Illuminate\Http\JsonResponse
-     *
      * @throws \Throwable
      */
-    public function failure(string $uuid)
+    public function failure(string $uuid): JsonResponse
     {
         $server = $this->repository->getByUuid($uuid);
 
@@ -168,14 +126,12 @@ class ServerTransferController extends Controller
     }
 
     /**
-     * Release all of the reserved allocations for this transfer and mark it as failed in
+     * Release all the reserved allocations for this transfer and mark it as failed in
      * the database.
      *
-     * @return \Illuminate\Http\JsonResponse
-     *
      * @throws \Throwable
      */
-    protected function processFailedTransfer(ServerTransfer $transfer)
+    protected function processFailedTransfer(ServerTransfer $transfer): JsonResponse
     {
         $this->connection->transaction(function () use (&$transfer) {
             $transfer->forceFill(['successful' => false])->saveOrFail();

app/Http/Controllers/Api/Remote/SftpAuthenticationController.php

@@ -22,11 +22,8 @@ class SftpAuthenticationController extends Controller
 {
     use ThrottlesLogins;
 
-    protected GetUserPermissionsService $permissions;
-
-    public function __construct(GetUserPermissionsService $permissions)
+    public function __construct(protected GetUserPermissionsService $permissions)
     {
-        $this->permissions = $permissions;
     }
 
     /**
@@ -44,7 +41,7 @@ class SftpAuthenticationController extends Controller
         if ($this->hasTooManyLoginAttempts($request)) {
             $seconds = $this->limiter()->availableIn($this->throttleKey($request));
 
-            throw new TooManyRequestsHttpException($seconds, "Too many login attempts for this account, please try again in {$seconds} seconds.");
+            throw new TooManyRequestsHttpException($seconds, "Too many login attempts for this account, please try again in $seconds seconds.");
         }
 
         $user = $this->getUser($request, $connection['username']);
@@ -60,7 +57,7 @@ class SftpAuthenticationController extends Controller
             $key = null;
             try {
                 $key = PublicKeyLoader::loadPublicKey(trim($request->input('password')));
-            } catch (NoKeyLoadedException $exception) {
+            } catch (NoKeyLoadedException) {
                 // do nothing
             }