From aaabfe43c00f8559f8cf922b8d198166dafd9aca Mon Sep 17 00:00:00 2001
From: Vehikl <pelican.vehikl@gmail.com>
Date: Thu, 20 Feb 2025 17:12:54 -0500
Subject: [PATCH] Separate out description and rename api routes

---
 .../Api/Client/Servers/SettingsController.php | 29 ++++++++++--------
 .../Settings/DescriptionServerRequest.php     | 30 +++++++++++++++++++
 .../Servers/Settings/RenameServerRequest.php  |  1 -
 app/Models/Permission.php                     |  2 ++
 routes/api-client.php                         |  1 +
 5 files changed, 50 insertions(+), 13 deletions(-)
 create mode 100644 app/Http/Requests/Api/Client/Servers/Settings/DescriptionServerRequest.php

diff --git a/app/Http/Controllers/Api/Client/Servers/SettingsController.php b/app/Http/Controllers/Api/Client/Servers/SettingsController.php
index ddb512b9f..05ad07d60 100644
--- a/app/Http/Controllers/Api/Client/Servers/SettingsController.php
+++ b/app/Http/Controllers/Api/Client/Servers/SettingsController.php
@@ -4,6 +4,7 @@ namespace App\Http\Controllers\Api\Client\Servers;
 
 use App\Facades\Activity;
 use App\Http\Controllers\Api\Client\ClientApiController;
+use App\Http\Requests\Api\Client\Servers\Settings\DescriptionServerRequest;
 use App\Http\Requests\Api\Client\Servers\Settings\ReinstallServerRequest;
 use App\Http\Requests\Api\Client\Servers\Settings\RenameServerRequest;
 use App\Http\Requests\Api\Client\Servers\Settings\SetDockerImageRequest;
@@ -34,23 +35,27 @@ class SettingsController extends ClientApiController
     public function rename(RenameServerRequest $request, Server $server): JsonResponse
     {
         $name = $request->input('name');
-        $description = $request->has('description') ? (string) $request->input('description') : $server->description;
 
-        $server->name = $name;
+        $server->update(['name' => $name]);
 
-        if (config('panel.editable_server_descriptions')) {
-            $server->description = $description;
-        }
-
-        $server->save();
-
-        if ($server->name !== $name) {
+        if ($server->wasChanged('name')) {
             Activity::event('server:settings.rename')
-                ->property(['old' => $server->name, 'new' => $name])
+                ->property(['old' => $server->getOriginal('name'), 'new' => $name])
                 ->log();
         }
 
-        if ($server->description !== $description) {
+        return new JsonResponse([], Response::HTTP_NO_CONTENT);
+    }
+
+    /**
+     * Update server description
+     */
+    public function description(DescriptionServerRequest $request, Server $server): JsonResponse
+    {
+        $description = $request->has('description') ? $request->input('description') : $server->description;
+
+        if ($server->description !== $description && config('panel.editable_server_descriptions')) {
+            $server->update(['description' => $description]);
             Activity::event('server:settings.description')
                 ->property(['old' => $server->description, 'new' => $description])
                 ->log();
@@ -84,7 +89,7 @@ class SettingsController extends ClientApiController
      */
     public function dockerImage(SetDockerImageRequest $request, Server $server): JsonResponse
     {
-        if (!in_array($server->image, array_values($server->egg->docker_images))) {
+        if (!in_array($server->image, $server->egg->docker_images)) {
             throw new BadRequestHttpException('This server\'s Docker image has been manually set by an administrator and cannot be updated.');
         }
 
diff --git a/app/Http/Requests/Api/Client/Servers/Settings/DescriptionServerRequest.php b/app/Http/Requests/Api/Client/Servers/Settings/DescriptionServerRequest.php
new file mode 100644
index 000000000..ba2fa2125
--- /dev/null
+++ b/app/Http/Requests/Api/Client/Servers/Settings/DescriptionServerRequest.php
@@ -0,0 +1,30 @@
+<?php
+
+namespace App\Http\Requests\Api\Client\Servers\Settings;
+
+use App\Contracts\Http\ClientPermissionsRequest;
+use App\Http\Requests\Api\Client\ClientApiRequest;
+use App\Models\Permission;
+
+class DescriptionServerRequest extends ClientApiRequest implements ClientPermissionsRequest
+{
+    /**
+     * Returns the permissions string indicating which permission should be used to
+     * validate that the authenticated user has permission to perform this action against
+     * the given resource (server).
+     */
+    public function permission(): string
+    {
+        return Permission::ACTION_SETTINGS_DESCRIPTION;
+    }
+
+    /**
+     * The rules to apply when validating this request.
+     */
+    public function rules(): array
+    {
+        return [
+            'description' => 'string|nullable',
+        ];
+    }
+}
diff --git a/app/Http/Requests/Api/Client/Servers/Settings/RenameServerRequest.php b/app/Http/Requests/Api/Client/Servers/Settings/RenameServerRequest.php
index c68e0d444..fb7d8e677 100644
--- a/app/Http/Requests/Api/Client/Servers/Settings/RenameServerRequest.php
+++ b/app/Http/Requests/Api/Client/Servers/Settings/RenameServerRequest.php
@@ -26,7 +26,6 @@ class RenameServerRequest extends ClientApiRequest implements ClientPermissionsR
     {
         return [
             'name' => Server::getRules()['name'],
-            'description' => 'string|nullable',
         ];
     }
 }
diff --git a/app/Models/Permission.php b/app/Models/Permission.php
index 02b3870b6..a950cd4f7 100644
--- a/app/Models/Permission.php
+++ b/app/Models/Permission.php
@@ -96,6 +96,8 @@ class Permission extends Model implements Validatable
 
     public const ACTION_SETTINGS_RENAME = 'settings.rename';
 
+    public const ACTION_SETTINGS_DESCRIPTION = 'settings.description';
+
     public const ACTION_SETTINGS_REINSTALL = 'settings.reinstall';
 
     public const ACTION_ACTIVITY_READ = 'activity.read';
diff --git a/routes/api-client.php b/routes/api-client.php
index 0feceeb78..c5ab1d3ba 100644
--- a/routes/api-client.php
+++ b/routes/api-client.php
@@ -129,6 +129,7 @@ Route::prefix('/servers/{server:uuid}')->middleware([ServerSubject::class, Authe
 
     Route::prefix('/settings')->group(function () {
         Route::post('/rename', [Client\Servers\SettingsController::class, 'rename']);
+        Route::post('/description', [Client\Servers\SettingsController::class, 'description']);
         Route::post('/reinstall', [Client\Servers\SettingsController::class, 'reinstall']);
         Route::put('/docker-image', [Client\Servers\SettingsController::class, 'dockerImage']);
     });