api: cleanup controllers

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

@@ -17,15 +17,8 @@ class BackupRemoteUploadController extends Controller
 {
     public const PART_SIZE = 5 * 1024 * 1024 * 1024;
 
-    /**
-     * @var \Pterodactyl\Repositories\Eloquent\BackupRepository
-     */
-    private $repository;
-
-    /**
-     * @var \Pterodactyl\Extensions\Backups\BackupManager
-     */
-    private $backupManager;
+    private BackupRepository $repository;
+    private BackupManager $backupManager;
 
     /**
      * BackupRemoteUploadController constructor.
@@ -37,15 +30,13 @@ class BackupRemoteUploadController extends Controller
     }
 
     /**
-     * Returns the required presigned urls to upload a backup to S3 cloud storage.
-     *
-     * @return \Illuminate\Http\JsonResponse
+     * Returns the required pre-signed urls to upload a backup to S3 cloud storage.
      *
      * @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');

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

@@ -4,6 +4,7 @@ namespace Pterodactyl\Http\Controllers\Api\Remote\Backups;
 
 use Carbon\CarbonImmutable;
 use Illuminate\Http\Request;
+use Illuminate\Http\Response;
 use Pterodactyl\Models\Backup;
 use Pterodactyl\Models\Server;
 use Pterodactyl\Models\AuditLog;
@@ -18,15 +19,8 @@ use Pterodactyl\Http\Requests\Api\Remote\ReportBackupCompleteRequest;
 
 class BackupStatusController extends Controller
 {
-    /**
-     * @var \Pterodactyl\Repositories\Eloquent\BackupRepository
-     */
-    private $repository;
-
-    /**
-     * @var \Pterodactyl\Extensions\Backups\BackupManager
-     */
-    private $backupManager;
+    private BackupRepository $repository;
+    private BackupManager $backupManager;
 
     /**
      * BackupStatusController constructor.
@@ -40,11 +34,9 @@ class BackupStatusController extends Controller
     /**
      * 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): Response
     {
         /** @var \Pterodactyl\Models\Backup $model */
         $model = Backup::query()->where('uuid', $backup)->firstOrFail();
@@ -77,7 +69,7 @@ class BackupStatusController extends Controller
             }
         });
 
-        return new JsonResponse([], JsonResponse::HTTP_NO_CONTENT);
+        return new Response('', Response::HTTP_NO_CONTENT);
     }
 
     /**
@@ -88,11 +80,9 @@ 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)
+    public function restore(Request $request, string $backup): Response
     {
         /** @var \Pterodactyl\Models\Backup $model */
         $model = Backup::query()->where('uuid', $backup)->firstOrFail();
@@ -108,7 +98,7 @@ class BackupStatusController extends Controller
             $server->update(['status' => null]);
         });
 
-        return new JsonResponse([], JsonResponse::HTTP_NO_CONTENT);
+        return new Response('', Response::HTTP_NO_CONTENT);
     }
 
     /**

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

@@ -10,15 +10,8 @@ use Pterodactyl\Contracts\Repository\ServerRepositoryInterface;
 
 class EggInstallController extends Controller
 {
-    /**
-     * @var \Pterodactyl\Services\Servers\EnvironmentService
-     */
-    private $environment;
-
-    /**
-     * @var \Pterodactyl\Contracts\Repository\ServerRepositoryInterface
-     */
-    private $repository;
+    private EnvironmentService $environment;
+    private ServerRepositoryInterface $repository;
 
     /**
      * EggInstallController constructor.

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

@@ -3,13 +3,13 @@
 namespace Pterodactyl\Http\Controllers\Api\Remote\Servers;
 
 use Illuminate\Http\Request;
+use Illuminate\Http\Response;
 use Pterodactyl\Models\Server;
 use Pterodactyl\Models\AuditLog;
 use Illuminate\Http\JsonResponse;
 use Illuminate\Database\Query\Builder;
 use Illuminate\Database\Query\JoinClause;
 use Pterodactyl\Http\Controllers\Controller;
-use Pterodactyl\Repositories\Eloquent\NodeRepository;
 use Pterodactyl\Services\Eggs\EggConfigurationService;
 use Pterodactyl\Repositories\Eloquent\ServerRepository;
 use Pterodactyl\Http\Resources\Wings\ServerConfigurationCollection;
@@ -17,46 +17,30 @@ use Pterodactyl\Services\Servers\ServerConfigurationStructureService;
 
 class ServerDetailsController extends Controller
 {
-    /**
-     * @var \Pterodactyl\Services\Eggs\EggConfigurationService
-     */
-    private $eggConfigurationService;
+    private ServerRepository $repository;
+    private ServerConfigurationStructureService $configurationStructureService;
+    private EggConfigurationService $eggConfigurationService;
 
     /**
-     * @var \Pterodactyl\Repositories\Eloquent\ServerRepository
-     */
-    private $repository;
-
-    /**
-     * @var \Pterodactyl\Services\Servers\ServerConfigurationStructureService
-     */
-    private $configurationStructureService;
-
-    /**
-     * ServerConfigurationController constructor.
+     * ServerDetailsController constructor.
      */
     public function __construct(
         ServerRepository $repository,
         ServerConfigurationStructureService $configurationStructureService,
-        EggConfigurationService $eggConfigurationService,
-        NodeRepository $nodeRepository
+        EggConfigurationService $eggConfigurationService
     ) {
-        $this->eggConfigurationService = $eggConfigurationService;
         $this->repository = $repository;
         $this->configurationStructureService = $configurationStructureService;
+        $this->eggConfigurationService = $eggConfigurationService;
     }
 
     /**
      * 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);
 
@@ -68,10 +52,8 @@ 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');
@@ -93,12 +75,9 @@ class ServerDetailsController extends Controller
      * do not get incorrectly stuck in installing/restoring from backup states since
      * a Wings reboot would completely stop those processes.
      *
-     * @param \Illuminate\Http\Request $request
-     * @return \Illuminate\Http\JsonResponse
-     *
      * @throws \Throwable
      */
-    public function resetState(Request $request)
+    public function resetState(Request $request): Response
     {
         $node = $request->attributes->get('node');
 
@@ -147,6 +126,6 @@ class ServerDetailsController extends Controller
             ->whereIn('status', [Server::STATUS_INSTALLING, Server::STATUS_RESTORING_BACKUP])
             ->update(['status' => null]);
 
-        return new JsonResponse([], JsonResponse::HTTP_NO_CONTENT);
+        return new Response('', JsonResponse::HTTP_NO_CONTENT);
     }
 }

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

@@ -12,10 +12,7 @@ use Pterodactyl\Http\Requests\Api\Remote\InstallationDataRequest;
 
 class ServerInstallController extends Controller
 {
-    /**
-     * @var \Pterodactyl\Repositories\Eloquent\ServerRepository
-     */
-    private $repository;
+    private ServerRepository $repository;
 
     /**
      * ServerInstallController constructor.
@@ -28,16 +25,14 @@ class ServerInstallController extends Controller
     /**
      * Returns installation information for a server.
      *
-     * @return \Illuminate\Http\JsonResponse
-     *
      * @throws \Pterodactyl\Exceptions\Repository\RecordNotFoundException
      */
-    public function index(Request $request, string $uuid)
+    public function index(Request $request, string $uuid): JsonResponse
     {
         $server = $this->repository->getByUuid($uuid);
         $egg = $server->egg;
 
-        return JsonResponse::create([
+        return new JsonResponse([
             'container_image' => $egg->copy_script_container,
             'entrypoint' => $egg->copy_script_entry,
             'script' => $egg->copy_script_install,
@@ -47,12 +42,10 @@ 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
      */
-    public function store(InstallationDataRequest $request, string $uuid)
+    public function store(InstallationDataRequest $request, string $uuid): Response
     {
         $server = $this->repository->getByUuid($uuid);
 
@@ -63,6 +56,6 @@ class ServerInstallController extends Controller
 
         $this->repository->update($server->id, ['status' => $status], true, true);
 
-        return new JsonResponse([], Response::HTTP_NO_CONTENT);
+        return new Response('', Response::HTTP_NO_CONTENT);
     }
 }

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

@@ -6,7 +6,6 @@ use Carbon\CarbonImmutable;
 use Illuminate\Support\Arr;
 use Illuminate\Http\Request;
 use Illuminate\Http\Response;
-use Illuminate\Http\JsonResponse;
 use Pterodactyl\Models\Allocation;
 use Illuminate\Support\Facades\Log;
 use Pterodactyl\Models\ServerTransfer;
@@ -21,35 +20,12 @@ 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;
+    private ConnectionInterface $connection;
+    private ServerRepository $repository;
+    private DaemonServerRepository $daemonServerRepository;
+    private DaemonTransferRepository $daemonTransferRepository;
+    private ServerConfigurationStructureService $configurationStructureService;
+    private NodeJWTService $jwtService;
 
     /**
      * ServerTransferController constructor.
@@ -73,12 +49,10 @@ class ServerTransferController extends Controller
     /**
      * 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): Response
     {
         $server = $this->repository->getByUuid($uuid);
 
@@ -122,17 +96,15 @@ class ServerTransferController extends Controller
                 ->notify($server, $data, $server->node, $token->toString());
         });
 
-        return new JsonResponse([], Response::HTTP_NO_CONTENT);
+        return new Response('', Response::HTTP_NO_CONTENT);
     }
 
     /**
      * The daemon notifies us about a transfer failure.
      *
-     * @return \Illuminate\Http\JsonResponse
-     *
      * @throws \Throwable
      */
-    public function failure(string $uuid)
+    public function failure(string $uuid): Response
     {
         $server = $this->repository->getByUuid($uuid);
 
@@ -142,11 +114,9 @@ class ServerTransferController extends Controller
     /**
      * The daemon notifies us about a transfer success.
      *
-     * @return \Illuminate\Http\JsonResponse
-     *
      * @throws \Throwable
      */
-    public function success(string $uuid)
+    public function success(string $uuid): Response
     {
         $server = $this->repository->getByUuid($uuid);
         $transfer = $server->transfer;
@@ -173,7 +143,7 @@ class ServerTransferController extends Controller
         });
 
         // Delete the server from the old node making sure to point it to the old node so
-        // that we do not delete it from the new node the server was transfered to.
+        // that we do not delete it from the new node the server was transferred to.
         try {
             $this->daemonServerRepository
                 ->setServer($server)
@@ -183,18 +153,16 @@ class ServerTransferController extends Controller
             Log::warning($exception, ['transfer_id' => $server->transfer->id]);
         }
 
-        return new JsonResponse([], Response::HTTP_NO_CONTENT);
+        return new Response('', Response::HTTP_NO_CONTENT);
     }
 
     /**
      * Release all of 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): Response
     {
         $this->connection->transaction(function () use (&$transfer) {
             $transfer->forceFill(['successful' => false])->saveOrFail();
@@ -207,6 +175,6 @@ class ServerTransferController extends Controller
             Allocation::query()->whereIn('id', $allocations)->update(['server_id' => null]);
         });
 
-        return new JsonResponse([], Response::HTTP_NO_CONTENT);
+        return new Response('', Response::HTTP_NO_CONTENT);
     }
 }

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

@@ -19,28 +19,17 @@ class SftpAuthenticationController extends Controller
 {
     use ThrottlesLogins;
 
-    /**
-     * @var \Pterodactyl\Repositories\Eloquent\UserRepository
-     */
-    private $userRepository;
+    private UserRepository $userRepository;
+    private ServerRepository $serverRepository;
+    private GetUserPermissionsService $permissionsService;
 
     /**
-     * @var \Pterodactyl\Repositories\Eloquent\ServerRepository
-     */
-    private $serverRepository;
-
-    /**
-     * @var \Pterodactyl\Services\Servers\GetUserPermissionsService
-     */
-    private $permissionsService;
-
-    /**
-     * SftpController constructor.
+     * SftpAuthenticationController constructor.
      */
     public function __construct(
-        GetUserPermissionsService $permissionsService,
         UserRepository $userRepository,
-        ServerRepository $serverRepository
+        ServerRepository $serverRepository,
+        GetUserPermissionsService $permissionsService
     ) {
         $this->userRepository = $userRepository;
         $this->serverRepository = $serverRepository;