Add server details modification endpoint to API.

app/Http/Controllers/Admin/ServersController.php

@@ -401,7 +401,7 @@ class ServersController extends Controller
      */
     public function setDetails(Request $request, Server $server)
     {
-        $this->detailsModificationService->edit($server, $request->only([
+        $this->detailsModificationService->handle($server, $request->only([
             'owner_id', 'name', 'description',
         ]));
 

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

@@ -0,0 +1,47 @@
+<?php
+
+namespace Pterodactyl\Http\Controllers\Api\Application\Servers;
+
+use Pterodactyl\Models\Server;
+use Pterodactyl\Services\Servers\DetailsModificationService;
+use Pterodactyl\Transformers\Api\Application\ServerTransformer;
+use Pterodactyl\Http\Controllers\Api\Application\ApplicationApiController;
+use Pterodactyl\Http\Requests\Api\Application\Servers\UpdateServerDetailsRequest;
+
+class ServerDetailsController extends ApplicationApiController
+{
+    /**
+     * @var \Pterodactyl\Services\Servers\DetailsModificationService
+     */
+    private $modificationService;
+
+    /**
+     * ServerDetailsController constructor.
+     *
+     * @param \Pterodactyl\Services\Servers\DetailsModificationService $modificationService
+     */
+    public function __construct(DetailsModificationService $modificationService)
+    {
+        parent::__construct();
+
+        $this->modificationService = $modificationService;
+    }
+
+    /**
+     * @param \Pterodactyl\Http\Requests\Api\Application\Servers\UpdateServerDetailsRequest $request
+     * @param \Pterodactyl\Models\Server                                                    $server
+     * @return array
+     *
+     * @throws \Pterodactyl\Exceptions\DisplayException
+     * @throws \Pterodactyl\Exceptions\Model\DataValidationException
+     * @throws \Pterodactyl\Exceptions\Repository\RecordNotFoundException
+     */
+    public function details(UpdateServerDetailsRequest $request, Server $server): array
+    {
+        $server = $this->modificationService->returnUpdatedModel()->handle($server, $request->validated());
+
+        return $this->fractal->item($server)
+            ->transformWith($this->getTransformer(ServerTransformer::class))
+            ->toArray();
+    }
+}

app/Http/Requests/Api/Application/Servers/UpdateServerDetailsRequest.php

@@ -0,0 +1,53 @@
+<?php
+
+namespace Pterodactyl\Http\Requests\Api\Application\Servers;
+
+use Pterodactyl\Models\Server;
+
+class UpdateServerDetailsRequest extends ServerWriteRequest
+{
+    /**
+     * Rules to apply to a server details update request.
+     *
+     * @return array
+     */
+    public function rules(): array
+    {
+        $rules = Server::getUpdateRulesForId($this->route()->parameter('server')->id);
+
+        return [
+            'name' => $rules['name'],
+            'user' => $rules['owner_id'],
+            'description' => $rules['description'],
+        ];
+    }
+
+    /**
+     * Convert the posted data into the correct format that is expected
+     * by the application.
+     *
+     * @return array
+     */
+    public function validated(): array
+    {
+        return [
+            'name' => $this->input('name'),
+            'owner_id' => $this->input('user'),
+            'description' => $this->input('description'),
+        ];
+    }
+
+    /**
+     * Rename some of the attributes in error messages to clarify the field
+     * being discussed.
+     *
+     * @return array
+     */
+    public function attributes(): array
+    {
+        return [
+            'user' => 'User ID',
+            'name' => 'Server Name',
+        ];
+    }
+}

app/Models/Server.php

@@ -80,7 +80,7 @@ class Server extends Model implements CleansAttributes, ValidableContract
      */
     protected static $dataIntegrityRules = [
         'owner_id' => 'exists:users,id',
-        'name' => 'regex:/^([\w .-]{1,200})$/',
+        'name' => 'string|min:1|max:255',
         'node_id' => 'exists:nodes,id',
         'description' => 'string',
         'memory' => 'numeric|min:0',

app/Services/Servers/DetailsModificationService.php

@@ -1,55 +1,37 @@
 <?php
-/**
- * Pterodactyl - Panel
- * Copyright (c) 2015 - 2017 Dane Everitt <dane@daneeveritt.com>.
- *
- * This software is licensed under the terms of the MIT license.
- * https://opensource.org/licenses/MIT
- */
 
 namespace Pterodactyl\Services\Servers;
 
-use Illuminate\Log\Writer;
 use Pterodactyl\Models\Server;
-use GuzzleHttp\Exception\RequestException;
 use Illuminate\Database\ConnectionInterface;
-use Pterodactyl\Exceptions\DisplayException;
+use Pterodactyl\Traits\Services\ReturnsUpdatedModels;
 use Pterodactyl\Repositories\Eloquent\ServerRepository;
 use Pterodactyl\Services\DaemonKeys\DaemonKeyCreationService;
 use Pterodactyl\Services\DaemonKeys\DaemonKeyDeletionService;
-use Pterodactyl\Repositories\Daemon\ServerRepository as DaemonServerRepository;
 
 class DetailsModificationService
 {
+    use ReturnsUpdatedModels;
+
     /**
      * @var \Illuminate\Database\ConnectionInterface
      */
-    protected $connection;
+    private $connection;
-
-    /**
-     * @var \Pterodactyl\Repositories\Daemon\ServerRepository
-     */
-    protected $daemonServerRepository;
 
     /**
      * @var \Pterodactyl\Services\DaemonKeys\DaemonKeyCreationService
      */
-    protected $keyCreationService;
+    private $keyCreationService;
 
     /**
      * @var \Pterodactyl\Services\DaemonKeys\DaemonKeyDeletionService
      */
-    protected $keyDeletionService;
+    private $keyDeletionService;
 
     /**
      * @var \Pterodactyl\Repositories\Eloquent\ServerRepository
      */
-    protected $repository;
+    private $repository;
-
-    /**
-     * @var \Illuminate\Log\Writer
-     */
-    protected $writer;
 
     /**
      * DetailsModificationService constructor.
@@ -57,92 +39,48 @@ class DetailsModificationService
      * @param \Illuminate\Database\ConnectionInterface                  $connection
      * @param \Pterodactyl\Services\DaemonKeys\DaemonKeyCreationService $keyCreationService
      * @param \Pterodactyl\Services\DaemonKeys\DaemonKeyDeletionService $keyDeletionService
-     * @param \Pterodactyl\Repositories\Daemon\ServerRepository         $daemonServerRepository
      * @param \Pterodactyl\Repositories\Eloquent\ServerRepository       $repository
-     * @param \Illuminate\Log\Writer                                    $writer
      */
     public function __construct(
         ConnectionInterface $connection,
         DaemonKeyCreationService $keyCreationService,
         DaemonKeyDeletionService $keyDeletionService,
-        DaemonServerRepository $daemonServerRepository,
+        ServerRepository $repository
-        ServerRepository $repository,
-        Writer $writer
     ) {
         $this->connection = $connection;
-        $this->daemonServerRepository = $daemonServerRepository;
         $this->keyCreationService = $keyCreationService;
         $this->keyDeletionService = $keyDeletionService;
         $this->repository = $repository;
-        $this->writer = $writer;
     }
 
     /**
      * Update the details for a single server instance.
      *
-     * @param int|\Pterodactyl\Models\Server $server
+     * @param \Pterodactyl\Models\Server $server
-     * @param array                          $data
+     * @param array                      $data
+     * @return bool|\Pterodactyl\Models\Server
      *
      * @throws \Pterodactyl\Exceptions\DisplayException
      * @throws \Pterodactyl\Exceptions\Model\DataValidationException
      * @throws \Pterodactyl\Exceptions\Repository\RecordNotFoundException
      */
-    public function edit($server, array $data)
+    public function handle(Server $server, array $data)
     {
-        if (! $server instanceof Server) {
-            $server = $this->repository->find($server);
-        }
-
         $this->connection->beginTransaction();
-        $this->repository->withoutFreshModel()->update($server->id, [
+
+        $response = $this->repository->setFreshModel($this->getUpdatedModel())->update($server->id, [
             'owner_id' => array_get($data, 'owner_id'),
             'name' => array_get($data, 'name'),
             'description' => array_get($data, 'description', ''),
         ], true, true);
 
-        if (array_get($data, 'owner_id') != $server->owner_id) {
+        if ((int) array_get($data, 'owner_id', 0) !== (int) $server->owner_id) {
             $this->keyDeletionService->handle($server, $server->owner_id);
             $this->keyCreationService->handle($server->id, array_get($data, 'owner_id'));
         }
 
         $this->connection->commit();
-    }
 
-    /**
+        return $response;
-     * Update the docker container for a specified server.
-     *
-     * @param int|\Pterodactyl\Models\Server $server
-     * @param string                         $image
-     *
-     * @throws \Pterodactyl\Exceptions\DisplayException
-     * @throws \Pterodactyl\Exceptions\Model\DataValidationException
-     * @throws \Pterodactyl\Exceptions\Repository\RecordNotFoundException
-     */
-    public function setDockerImage($server, $image)
-    {
-        if (! $server instanceof Server) {
-            $server = $this->repository->find($server);
-        }
-
-        $this->connection->beginTransaction();
-        $this->repository->withoutFreshModel()->update($server->id, ['image' => $image]);
-
-        try {
-            $this->daemonServerRepository->setServer($server)->update([
-                'build' => [
-                    'image' => $image,
-                ],
-            ]);
-        } catch (RequestException $exception) {
-            $this->connection->rollBack();
-            $response = $exception->getResponse();
-            $this->writer->warning($exception);
-
-            throw new DisplayException(trans('admin/server.exceptions.daemon_exception', [
-                'code' => is_null($response) ? 'E_CONN_REFUSED' : $response->getStatusCode(),
-            ]));
-        }
-
-        $this->connection->commit();
     }
 }

routes/api-application.php

@@ -72,6 +72,8 @@ Route::group(['prefix' => '/servers'], function () {
     Route::get('/', 'Servers\ServerController@index')->name('api.application.servers');
     Route::get('/{server}', 'Servers\ServerController@view')->name('api.application.servers.view');
 
+    Route::patch('/{server}/details', 'Servers\ServerDetailsController@details')->name('api.application.servers.details');
+
     Route::post('/{server}/suspend', 'Servers\ServerManagementController@suspend')->name('api.application.servers.suspend');
     Route::post('/{server}/unsuspend', 'Servers\ServerManagementController@unsuspend')->name('api.application.servers.unsuspend');
     Route::post('/{server}/reinstall', 'Servers\ServerManagementController@reinstall')->name('api.application.servers.reinstall');

tests/Unit/Services/Servers/DetailsModificationServiceTest.php

@@ -1,71 +1,37 @@
 <?php
-/**
- * Pterodactyl - Panel
- * Copyright (c) 2015 - 2017 Dane Everitt <dane@daneeveritt.com>.
- *
- * This software is licensed under the terms of the MIT license.
- * https://opensource.org/licenses/MIT
- */
 
 namespace Tests\Unit\Services\Servers;
 
-use Exception;
 use Mockery as m;
 use Tests\TestCase;
-use Illuminate\Log\Writer;
-use GuzzleHttp\Psr7\Response;
 use Pterodactyl\Models\Server;
-use GuzzleHttp\Exception\RequestException;
 use Illuminate\Database\ConnectionInterface;
-use Pterodactyl\Exceptions\DisplayException;
-use Pterodactyl\Exceptions\PterodactylException;
 use Pterodactyl\Repositories\Eloquent\ServerRepository;
 use Pterodactyl\Services\Servers\DetailsModificationService;
 use Pterodactyl\Services\DaemonKeys\DaemonKeyCreationService;
 use Pterodactyl\Services\DaemonKeys\DaemonKeyDeletionService;
-use Pterodactyl\Repositories\Daemon\ServerRepository as DaemonServerRepository;
 
 class DetailsModificationServiceTest extends TestCase
 {
     /**
      * @var \Illuminate\Database\ConnectionInterface|\Mockery\Mock
      */
-    protected $connection;
+    private $connection;
-
-    /**
-     * @var \Pterodactyl\Repositories\Daemon\ServerRepository|\Mockery\Mock
-     */
-    protected $daemonServerRepository;
-
-    /**
-     * @var \GuzzleHttp\Exception\RequestException|\Mockery\Mock
-     */
-    protected $exception;
 
     /**
      * @var \Pterodactyl\Services\DaemonKeys\DaemonKeyCreationService|\Mockery\Mock
      */
-    protected $keyCreationService;
+    private $keyCreationService;
 
     /**
      * @var \Pterodactyl\Services\DaemonKeys\DaemonKeyDeletionService|\Mockery\Mock
      */
-    protected $keyDeletionService;
+    private $keyDeletionService;
 
     /**
      * @var \Pterodactyl\Repositories\Eloquent\ServerRepository|\Mockery\Mock
      */
-    protected $repository;
+    private $repository;
-
-    /**
-     * @var \Pterodactyl\Services\Servers\DetailsModificationService
-     */
-    protected $service;
-
-    /**
-     * @var \Illuminate\Log\Writer|\Mockery\Mock
-     */
-    protected $writer;
 
     /**
      * Setup tests.
@@ -75,72 +41,49 @@ class DetailsModificationServiceTest extends TestCase
         parent::setUp();
 
         $this->connection = m::mock(ConnectionInterface::class);
-        $this->exception = m::mock(RequestException::class)->makePartial();
-        $this->daemonServerRepository = m::mock(DaemonServerRepository::class);
         $this->keyCreationService = m::mock(DaemonKeyCreationService::class);
         $this->keyDeletionService = m::mock(DaemonKeyDeletionService::class);
         $this->repository = m::mock(ServerRepository::class);
-        $this->writer = m::mock(Writer::class);
-
-        $this->service = new DetailsModificationService(
-            $this->connection,
-            $this->keyCreationService,
-            $this->keyDeletionService,
-            $this->daemonServerRepository,
-            $this->repository,
-            $this->writer
-        );
     }
 
     /**
      * Test basic updating of core variables when a model is provided.
      */
-    public function testEditShouldSkipDatabaseSearchIfModelIsPassed()
+    public function testDetailsAreEdited()
     {
-        $server = factory(Server::class)->make([
+        $server = factory(Server::class)->make(['owner_id' => 1]);
-            'owner_id' => 1,
-        ]);
 
         $data = ['owner_id' => 1, 'name' => 'New Name', 'description' => 'New Description'];
 
-        $this->connection->shouldReceive('beginTransaction')->withNoArgs()->once()->andReturnNull();
+        $this->connection->shouldReceive('beginTransaction')->once()->withNoArgs()->andReturnNull();
-        $this->repository->shouldReceive('withoutFreshModel')->withNoArgs()->once()->andReturnSelf()
+        $this->repository->shouldReceive('setFreshModel')->once()->with(false)->andReturnSelf();
-            ->shouldReceive('update')->with($server->id, [
+        $this->repository->shouldReceive('update')->once()->with($server->id, [
                 'owner_id' => $data['owner_id'],
                 'name' => $data['name'],
                 'description' => $data['description'],
-            ], true, true)->once()->andReturnNull();
+            ], true, true)->andReturn(true);
 
-        $this->connection->shouldReceive('commit')->withNoArgs()->once()->andReturnNull();
+        $this->connection->shouldReceive('commit')->once()->withNoArgs()->andReturnNull();
 
-        $this->service->edit($server, $data);
+        $response = $this->getService()->handle($server, $data);
-        $this->assertTrue(true);
+        $this->assertTrue($response);
     }
 
     /**
-     * Test that repository attempts to find model in database if no model is passed.
+     * Test that a model is returned if requested.
      */
-    public function testEditShouldGetModelFromRepositoryIfNotPassed()
+    public function testModelIsReturned()
     {
-        $server = factory(Server::class)->make([
+        $server = factory(Server::class)->make(['owner_id' => 1]);
-            'owner_id' => 1,
-        ]);
 
-        $data = ['owner_id' => 1, 'name' => 'New Name', 'description' => 'New Description'];
+        $this->connection->shouldReceive('beginTransaction')->once()->withNoArgs()->andReturnNull();
+        $this->repository->shouldReceive('setFreshModel')->once()->with(true)->andReturnSelf();
+        $this->repository->shouldReceive('update')->once()->andReturn($server);
 
-        $this->repository->shouldReceive('find')->with($server->id)->once()->andReturn($server);
+        $this->connection->shouldReceive('commit')->once()->withNoArgs()->andReturnNull();
-        $this->connection->shouldReceive('beginTransaction')->withNoArgs()->once()->andReturnNull();
-        $this->repository->shouldReceive('withoutFreshModel')->withNoArgs()->once()->andReturnSelf()
-            ->shouldReceive('update')->with($server->id, [
-                'owner_id' => $data['owner_id'],
-                'name' => $data['name'],
-                'description' => $data['description'],
-            ], true, true)->once()->andReturnNull();
 
-        $this->connection->shouldReceive('commit')->withNoArgs()->once()->andReturnNull();
+        $response = $this->getService()->returnUpdatedModel()->handle($server, ['owner_id' => 1]);
-
+        $this->assertInstanceOf(Server::class, $response);
-        $this->service->edit($server->id, $data);
-        $this->assertTrue(true);
     }
 
     /**
@@ -150,128 +93,38 @@ class DetailsModificationServiceTest extends TestCase
     {
         $server = factory(Server::class)->make([
             'owner_id' => 1,
-            'node_id' => 1,
         ]);
 
         $data = ['owner_id' => 2, 'name' => 'New Name', 'description' => 'New Description'];
 
-        $this->connection->shouldReceive('beginTransaction')->withNoArgs()->once()->andReturnNull();
+        $this->connection->shouldReceive('beginTransaction')->once()->withNoArgs()->andReturnNull();
-        $this->repository->shouldReceive('withoutFreshModel')->withNoArgs()->once()->andReturnSelf()
+        $this->repository->shouldReceive('setFreshModel')->once()->with(false)->andReturnSelf();
-            ->shouldReceive('update')->with($server->id, [
+        $this->repository->shouldReceive('update')->once()->with($server->id, [
                 'owner_id' => $data['owner_id'],
                 'name' => $data['name'],
                 'description' => $data['description'],
-            ], true, true)->once()->andReturnNull();
+            ], true, true)->andReturn(true);
 
-        $this->keyDeletionService->shouldReceive('handle')->with($server, $server->owner_id)->once()->andReturnNull();
+        $this->keyDeletionService->shouldReceive('handle')->once()->with($server, $server->owner_id)->andReturnNull();
-        $this->keyCreationService->shouldReceive('handle')->with($server->id, $data['owner_id']);
+        $this->keyCreationService->shouldReceive('handle')->once()->with($server->id, $data['owner_id'])->andReturnNull();
-        $this->connection->shouldReceive('commit')->withNoArgs()->once()->andReturnNull();
+        $this->connection->shouldReceive('commit')->once()->withNoArgs()->andReturnNull();
 
-        $this->service->edit($server, $data);
+        $response = $this->getService()->handle($server, $data);
-        $this->assertTrue(true);
+        $this->assertTrue($response);
     }
 
     /**
-     * Test that the docker image for a server can be updated if a model is provided.
+     * Return an instance of the service with mocked dependencies for testing.
-     */
-    public function testDockerImageCanBeUpdatedWhenAServerModelIsProvided()
-    {
-        $server = factory(Server::class)->make(['node_id' => 1]);
-
-        $this->connection->shouldReceive('beginTransaction')->withNoArgs()->once()->andReturnNull();
-        $this->repository->shouldReceive('withoutFreshModel')->withNoArgs()->once()->andReturnSelf()
-            ->shouldReceive('update')->with($server->id, [
-                'image' => 'new/image',
-            ])->once()->andReturnNull();
-
-        $this->daemonServerRepository->shouldReceive('setServer')->with($server)->once()->andReturnSelf()
-            ->shouldReceive('update')->with([
-                'build' => [
-                    'image' => 'new/image',
-                ],
-            ])->once()->andReturn(new Response);
-
-        $this->connection->shouldReceive('commit')->withNoArgs()->once()->andReturnNull();
-
-        $this->service->setDockerImage($server, 'new/image');
-        $this->assertTrue(true);
-    }
-
-    /**
-     * Test that the docker image for a server can be updated if a model is provided.
-     */
-    public function testDockerImageCanBeUpdatedWhenNoModelIsProvided()
-    {
-        $server = factory(Server::class)->make(['node_id' => 1]);
-
-        $this->repository->shouldReceive('find')->with($server->id)->once()->andReturn($server);
-        $this->connection->shouldReceive('beginTransaction')->withNoArgs()->once()->andReturnNull();
-        $this->repository->shouldReceive('withoutFreshModel')->withNoArgs()->once()->andReturnSelf()
-            ->shouldReceive('update')->with($server->id, [
-                'image' => 'new/image',
-            ])->once()->andReturnNull();
-
-        $this->daemonServerRepository->shouldReceive('setServer')->with($server)->once()->andReturnSelf()
-            ->shouldReceive('update')->with([
-                'build' => [
-                    'image' => 'new/image',
-                ],
-            ])->once()->andReturn(new Response);
-
-        $this->connection->shouldReceive('commit')->withNoArgs()->once()->andReturnNull();
-
-        $this->service->setDockerImage($server->id, 'new/image');
-        $this->assertTrue(true);
-    }
-
-    /**
-     * Test that an exception thrown by Guzzle is rendered as a displayable exception.
-     */
-    public function testExceptionThrownByGuzzleWhenSettingDockerImageShouldBeRenderedAsADisplayableException()
-    {
-        $server = factory(Server::class)->make(['node_id' => 1]);
-
-        $this->connection->shouldReceive('beginTransaction')->withNoArgs()->once()->andReturnNull();
-        $this->repository->shouldReceive('withoutFreshModel')->withNoArgs()->once()->andReturnSelf()
-            ->shouldReceive('update')->with($server->id, [
-                'image' => 'new/image',
-            ])->once()->andReturnNull();
-
-        $this->daemonServerRepository->shouldReceive('setServer')->andThrow($this->exception);
-        $this->connection->shouldReceive('rollBack')->withNoArgs()->once()->andReturnNull();
-        $this->exception->shouldReceive('getResponse')->withNoArgs()->once()->andReturnSelf()
-            ->shouldReceive('getStatusCode')->withNoArgs()->once()->andReturn(400);
-
-        $this->writer->shouldReceive('warning')->with($this->exception)->once()->andReturnNull();
-
-        try {
-            $this->service->setDockerImage($server, 'new/image');
-        } catch (PterodactylException $exception) {
-            $this->assertInstanceOf(DisplayException::class, $exception);
-            $this->assertEquals(
-                trans('admin/server.exceptions.daemon_exception', ['code' => 400]),
-                $exception->getMessage()
-            );
-        }
-    }
-
-    /**
-     * Test that an exception not thrown by Guzzle is not transformed to a displayable exception.
      *
-     * @expectedException \Exception
+     * @return \Pterodactyl\Services\Servers\DetailsModificationService
      */
-    public function testExceptionNotThrownByGuzzleWhenSettingDockerImageShouldNotBeRenderedAsADisplayableException()
+    private function getService(): DetailsModificationService
     {
-        $server = factory(Server::class)->make(['node_id' => 1]);
+        return new DetailsModificationService(
-
+            $this->connection,
-        $this->database->shouldReceive('beginTransaction')->withNoArgs()->once()->andReturnNull();
+            $this->keyCreationService,
-        $this->repository->shouldReceive('withoutFreshModel')->withNoArgs()->once()->andReturnSelf()
+            $this->keyDeletionService,
-            ->shouldReceive('update')->with($server->id, [
+            $this->repository
-                'image' => 'new/image',
+        );
-            ])->once()->andReturnNull();
-
-        $this->daemonServerRepository->shouldReceive('setNode')->andThrow(new Exception());
-
-        $this->service->setDockerImage($server, 'new/image');
     }
 }