Merge pull request #1915 from pterodactyl/feature/server-mounts

Add configurable server mounts

app/Http/Controllers/Admin/MountController.php

@@ -0,0 +1,248 @@
+<?php
+
+namespace Pterodactyl\Http\Controllers\Admin;
+
+use Illuminate\Http\Request;
+use Pterodactyl\Models\Mount;
+use Prologue\Alerts\AlertsMessageBag;
+use Pterodactyl\Exceptions\DisplayException;
+use Pterodactyl\Http\Controllers\Controller;
+use Pterodactyl\Services\Mounts\MountUpdateService;
+use Pterodactyl\Http\Requests\Admin\MountFormRequest;
+use Pterodactyl\Services\Mounts\MountCreationService;
+use Pterodactyl\Services\Mounts\MountDeletionService;
+use Pterodactyl\Repositories\Eloquent\MountRepository;
+use Pterodactyl\Contracts\Repository\NestRepositoryInterface;
+use Pterodactyl\Contracts\Repository\LocationRepositoryInterface;
+
+class MountController extends Controller
+{
+    /**
+     * @var \Prologue\Alerts\AlertsMessageBag
+     */
+    protected $alert;
+
+    /**
+     * @var \Pterodactyl\Contracts\Repository\NestRepositoryInterface
+     */
+    protected $nestRepository;
+
+    /**
+     * @var \Pterodactyl\Contracts\Repository\LocationRepositoryInterface
+     */
+    protected $locationRepository;
+
+    /**
+     * @var \Pterodactyl\Repositories\Eloquent\MountRepository
+     */
+    protected $repository;
+
+    /**
+     * @var \Pterodactyl\Services\Mounts\MountCreationService
+     */
+    protected $creationService;
+
+    /**
+     * @var \Pterodactyl\Services\Mounts\MountDeletionService
+     */
+    protected $deletionService;
+
+    /**
+     * @var \Pterodactyl\Services\Mounts\MountUpdateService
+     */
+    protected $updateService;
+
+    /**
+     * MountController constructor.
+     *
+     * @param \Prologue\Alerts\AlertsMessageBag $alert
+     * @param \Pterodactyl\Contracts\Repository\NestRepositoryInterface $nestRepository
+     * @param \Pterodactyl\Contracts\Repository\LocationRepositoryInterface $locationRepository
+     * @param \Pterodactyl\Repositories\Eloquent\MountRepository $repository
+     * @param \Pterodactyl\Services\Mounts\MountCreationService $creationService
+     * @param \Pterodactyl\Services\Mounts\MountDeletionService $deletionService
+     * @param \Pterodactyl\Services\Mounts\MountUpdateService $updateService
+     */
+    public function __construct(
+        AlertsMessageBag $alert,
+        NestRepositoryInterface $nestRepository,
+        LocationRepositoryInterface $locationRepository,
+        MountRepository $repository,
+        MountCreationService $creationService,
+        MountDeletionService $deletionService,
+        MountUpdateService $updateService
+    ) {
+        $this->alert = $alert;
+        $this->nestRepository = $nestRepository;
+        $this->locationRepository = $locationRepository;
+        $this->repository = $repository;
+        $this->creationService = $creationService;
+        $this->deletionService = $deletionService;
+        $this->updateService = $updateService;
+    }
+
+    /**
+     * Return the mount overview page.
+     *
+     * @return \Illuminate\View\View
+     */
+    public function index()
+    {
+        return view('admin.mounts.index', [
+            'mounts' => $this->repository->getAllWithDetails(),
+        ]);
+    }
+
+    /**
+     * Return the mount view page.
+     *
+     * @param string $id
+     * @return \Illuminate\View\View
+     *
+     * @throws \Pterodactyl\Exceptions\Repository\RecordNotFoundException
+     */
+    public function view($id)
+    {
+        $nests = $this->nestRepository->all();
+        $nests->load('eggs');
+
+        $locations = $this->locationRepository->all();
+        $locations->load('nodes');
+
+        return view('admin.mounts.view', [
+            'mount' => $this->repository->getWithRelations($id),
+            'nests' => $nests,
+            'locations' => $locations,
+        ]);
+    }
+
+    /**
+     * Handle request to create new mount.
+     *
+     * @param \Pterodactyl\Http\Requests\Admin\MountFormRequest $request
+     * @return \Illuminate\Http\RedirectResponse
+     *
+     * @throws \Throwable
+     */
+    public function create(MountFormRequest $request)
+    {
+        $mount = $this->creationService->handle($request->normalize());
+        $this->alert->success('Mount was created successfully.')->flash();
+
+        return redirect()->route('admin.mounts.view', $mount->id);
+    }
+
+    /**
+     * Handle request to update or delete location.
+     *
+     * @param \Pterodactyl\Http\Requests\Admin\MountFormRequest $request
+     * @param \Pterodactyl\Models\Mount $mount
+     * @return \Illuminate\Http\RedirectResponse
+     *
+     * @throws \Throwable
+     */
+    public function update(MountFormRequest $request, Mount $mount)
+    {
+        if ($request->input('action') === 'delete') {
+            return $this->delete($mount);
+        }
+
+        $this->updateService->handle($mount->id, $request->normalize());
+        $this->alert->success('Mount was updated successfully.')->flash();
+
+        return redirect()->route('admin.mounts.view', $mount->id);
+    }
+
+    /**
+     * Delete a location from the system.
+     *
+     * @param \Pterodactyl\Models\Mount $mount
+     * @return \Illuminate\Http\RedirectResponse
+     *
+     * @throws \Exception
+     */
+    public function delete(Mount $mount)
+    {
+        try {
+            $this->deletionService->handle($mount->id);
+
+            return redirect()->route('admin.mounts');
+        } catch (DisplayException $ex) {
+            $this->alert->danger($ex->getMessage())->flash();
+        }
+
+        return redirect()->route('admin.mounts.view', $mount->id);
+    }
+
+    /**
+     * Adds eggs to the mount's many to many relation.
+     *
+     * @param \Illuminate\Http\Request $request
+     * @param \Pterodactyl\Models\Mount $mount
+     * @return \Illuminate\Http\RedirectResponse
+     */
+    public function addEggs(Request $request, Mount $mount)
+    {
+        $validatedData = $request->validate([
+            'eggs' => 'required|exists:eggs,id',
+        ]);
+
+        $eggs = $validatedData['eggs'] ?? [];
+        if (sizeof($eggs) > 0) {
+            $mount->eggs()->attach(array_map('intval', $eggs));
+            $this->alert->success('Mount was updated successfully.')->flash();
+        }
+
+        return redirect()->route('admin.mounts.view', $mount->id);
+    }
+
+    /**
+     * Adds nodes to the mount's many to many relation.
+     *
+     * @param \Illuminate\Http\Request $request
+     * @param \Pterodactyl\Models\Mount $mount
+     * @return \Illuminate\Http\RedirectResponse
+     */
+    public function addNodes(Request $request, Mount $mount)
+    {
+        $validatedData = $request->validate([
+            'nodes' => 'required|exists:nodes,id',
+        ]);
+
+        $nodes = $validatedData['nodes'] ?? [];
+        if (sizeof($nodes) > 0) {
+            $mount->nodes()->attach(array_map('intval', $nodes));
+            $this->alert->success('Mount was updated successfully.')->flash();
+        }
+
+        return redirect()->route('admin.mounts.view', $mount->id);
+    }
+
+    /**
+     * Deletes an egg from the mount's many to many relation.
+     *
+     * @param \Pterodactyl\Models\Mount $mount
+     * @param int $egg_id
+     * @return \Illuminate\Http\Response
+     */
+    public function deleteEgg(Mount $mount, int $egg_id)
+    {
+        $mount->eggs()->detach($egg_id);
+
+        return response('', 204);
+    }
+
+    /**
+     * Deletes an node from the mount's many to many relation.
+     *
+     * @param \Pterodactyl\Models\Mount $mount
+     * @param int $node_id
+     * @return \Illuminate\Http\Response
+     */
+    public function deleteNode(Mount $mount, int $node_id)
+    {
+        $mount->nodes()->detach($node_id);
+
+        return response('', 204);
+    }
+}

app/Http/Controllers/Admin/Servers/ServerViewController.php

@@ -11,6 +11,7 @@ use Pterodactyl\Exceptions\DisplayException;
 use Pterodactyl\Http\Controllers\Controller;
 use Pterodactyl\Repositories\Eloquent\NestRepository;
 use Pterodactyl\Repositories\Eloquent\NodeRepository;
+use Pterodactyl\Repositories\Eloquent\MountRepository;
 use Pterodactyl\Repositories\Eloquent\ServerRepository;
 use Pterodactyl\Traits\Controllers\JavascriptInjection;
 use Pterodactyl\Repositories\Eloquent\LocationRepository;
@@ -35,6 +36,11 @@ class ServerViewController extends Controller
      */
     private $repository;
 
+    /**
+     * @var \Pterodactyl\Repositories\Eloquent\MountRepository
+     */
+    protected $mountRepository;
+
     /**
      * @var \Pterodactyl\Repositories\Eloquent\NestRepository
      */
@@ -53,27 +59,30 @@ class ServerViewController extends Controller
     /**
      * ServerViewController constructor.
      *
+     * @param \Illuminate\Contracts\View\Factory $view
      * @param \Pterodactyl\Repositories\Eloquent\DatabaseHostRepository $databaseHostRepository
-     * @param \Pterodactyl\Repositories\Eloquent\NestRepository $nestRepository
      * @param \Pterodactyl\Repositories\Eloquent\LocationRepository $locationRepository
+     * @param \Pterodactyl\Repositories\Eloquent\MountRepository $mountRepository
+     * @param \Pterodactyl\Repositories\Eloquent\NestRepository $nestRepository
      * @param \Pterodactyl\Repositories\Eloquent\NodeRepository $nodeRepository
      * @param \Pterodactyl\Repositories\Eloquent\ServerRepository $repository
-     * @param \Illuminate\Contracts\View\Factory $view
      */
     public function __construct(
+        Factory $view,
         DatabaseHostRepository $databaseHostRepository,
-        NestRepository $nestRepository,
         LocationRepository $locationRepository,
+        MountRepository $mountRepository,
+        NestRepository $nestRepository,
         NodeRepository $nodeRepository,
-        ServerRepository $repository,
-        Factory $view
+        ServerRepository $repository
     ) {
         $this->view = $view;
         $this->databaseHostRepository = $databaseHostRepository;
-        $this->repository = $repository;
+        $this->locationRepository = $locationRepository;
+        $this->mountRepository = $mountRepository;
         $this->nestRepository = $nestRepository;
         $this->nodeRepository = $nodeRepository;
-        $this->locationRepository = $locationRepository;
+        $this->repository = $repository;
     }
 
     /**
@@ -160,6 +169,23 @@ class ServerViewController extends Controller
         ]);
     }
 
+    /**
+     * Returns all of the mounts that exist for the server.
+     *
+     * @param \Illuminate\Http\Request $request
+     * @param \Pterodactyl\Models\Server $server
+     * @return \Illuminate\Contracts\View\View
+     */
+    public function mounts(Request $request, Server $server)
+    {
+        $server->load('mounts');
+
+        return $this->view->make('admin.servers.view.mounts', [
+            'mounts' => $this->mountRepository->getMountListForServer($server),
+            'server' => $server,
+        ]);
+    }
+
     /**
      * Returns the base server management page, or an exception if the server
      * is in a state that cannot be recovered from.
@@ -169,7 +195,6 @@ class ServerViewController extends Controller
      * @return \Illuminate\Contracts\View\View
      *
      * @throws \Pterodactyl\Exceptions\DisplayException
-     * @throws \Pterodactyl\Exceptions\Repository\RecordNotFoundException
      */
     public function manage(Request $request, Server $server)
     {

app/Http/Controllers/Admin/ServersController.php

@@ -9,17 +9,21 @@
 
 namespace Pterodactyl\Http\Controllers\Admin;
 
+use Illuminate\Support\Arr;
 use Illuminate\Http\Request;
 use Pterodactyl\Models\User;
 use Pterodactyl\Models\Server;
 use Prologue\Alerts\AlertsMessageBag;
+use GuzzleHttp\Exception\RequestException;
 use Pterodactyl\Exceptions\DisplayException;
 use Pterodactyl\Http\Controllers\Controller;
 use Illuminate\Validation\ValidationException;
 use Pterodactyl\Services\Servers\SuspensionService;
+use Pterodactyl\Repositories\Eloquent\MountRepository;
 use Pterodactyl\Services\Servers\ServerDeletionService;
 use Pterodactyl\Services\Servers\ReinstallServerService;
 use Pterodactyl\Exceptions\Model\DataValidationException;
+use Pterodactyl\Repositories\Wings\DaemonServerRepository;
 use Pterodactyl\Services\Servers\BuildModificationService;
 use Pterodactyl\Services\Databases\DatabasePasswordService;
 use Pterodactyl\Services\Servers\DetailsModificationService;
@@ -31,6 +35,8 @@ use Illuminate\Contracts\Config\Repository as ConfigRepository;
 use Pterodactyl\Contracts\Repository\ServerRepositoryInterface;
 use Pterodactyl\Contracts\Repository\DatabaseRepositoryInterface;
 use Pterodactyl\Contracts\Repository\AllocationRepositoryInterface;
+use Pterodactyl\Exceptions\Http\Connection\DaemonConnectionException;
+use Pterodactyl\Services\Servers\ServerConfigurationStructureService;
 use Pterodactyl\Http\Requests\Admin\Servers\Databases\StoreServerDatabaseRequest;
 
 class ServersController extends Controller
@@ -55,6 +61,11 @@ class ServersController extends Controller
      */
     protected $config;
 
+    /**
+     * @var \Pterodactyl\Repositories\Wings\DaemonServerRepository
+     */
+    private $daemonServerRepository;
+
     /**
      * @var \Pterodactyl\Contracts\Repository\DatabaseRepositoryInterface
      */
@@ -85,6 +96,11 @@ class ServersController extends Controller
      */
     protected $detailsModificationService;
 
+    /**
+     * @var \Pterodactyl\Repositories\Eloquent\MountRepository
+     */
+    protected $mountRepository;
+
     /**
      * @var \Pterodactyl\Contracts\Repository\NestRepositoryInterface
      */
@@ -100,6 +116,11 @@ class ServersController extends Controller
      */
     protected $repository;
 
+    /**
+     * @var \Pterodactyl\Services\Servers\ServerConfigurationStructureService
+     */
+    private $serverConfigurationStructureService;
+
     /**
      * @var \Pterodactyl\Services\Servers\StartupModificationService
      */
@@ -117,6 +138,7 @@ class ServersController extends Controller
      * @param \Pterodactyl\Contracts\Repository\AllocationRepositoryInterface $allocationRepository
      * @param \Pterodactyl\Services\Servers\BuildModificationService $buildModificationService
      * @param \Illuminate\Contracts\Config\Repository $config
+     * @param \Pterodactyl\Repositories\Wings\DaemonServerRepository $daemonServerRepository
      * @param \Pterodactyl\Services\Databases\DatabaseManagementService $databaseManagementService
      * @param \Pterodactyl\Services\Databases\DatabasePasswordService $databasePasswordService
      * @param \Pterodactyl\Contracts\Repository\DatabaseRepositoryInterface $databaseRepository
@@ -125,7 +147,9 @@ class ServersController extends Controller
      * @param \Pterodactyl\Services\Servers\DetailsModificationService $detailsModificationService
      * @param \Pterodactyl\Services\Servers\ReinstallServerService $reinstallService
      * @param \Pterodactyl\Contracts\Repository\ServerRepositoryInterface $repository
+     * @param \Pterodactyl\Repositories\Eloquent\MountRepository $mountRepository
      * @param \Pterodactyl\Contracts\Repository\NestRepositoryInterface $nestRepository
+     * @param \Pterodactyl\Services\Servers\ServerConfigurationStructureService $serverConfigurationStructureService
      * @param \Pterodactyl\Services\Servers\StartupModificationService $startupModificationService
      * @param \Pterodactyl\Services\Servers\SuspensionService $suspensionService
      */
@@ -134,6 +158,7 @@ class ServersController extends Controller
         AllocationRepositoryInterface $allocationRepository,
         BuildModificationService $buildModificationService,
         ConfigRepository $config,
+        DaemonServerRepository $daemonServerRepository,
         DatabaseManagementService $databaseManagementService,
         DatabasePasswordService $databasePasswordService,
         DatabaseRepositoryInterface $databaseRepository,
@@ -142,7 +167,9 @@ class ServersController extends Controller
         DetailsModificationService $detailsModificationService,
         ReinstallServerService $reinstallService,
         ServerRepositoryInterface $repository,
+        MountRepository $mountRepository,
         NestRepositoryInterface $nestRepository,
+        ServerConfigurationStructureService $serverConfigurationStructureService,
         StartupModificationService $startupModificationService,
         SuspensionService $suspensionService
     ) {
@@ -150,6 +177,7 @@ class ServersController extends Controller
         $this->allocationRepository = $allocationRepository;
         $this->buildModificationService = $buildModificationService;
         $this->config = $config;
+        $this->daemonServerRepository = $daemonServerRepository;
         $this->databaseHostRepository = $databaseHostRepository;
         $this->databaseManagementService = $databaseManagementService;
         $this->databasePasswordService = $databasePasswordService;
@@ -159,6 +187,8 @@ class ServersController extends Controller
         $this->nestRepository = $nestRepository;
         $this->reinstallService = $reinstallService;
         $this->repository = $repository;
+        $this->mountRepository = $mountRepository;
+        $this->serverConfigurationStructureService = $serverConfigurationStructureService;
         $this->startupModificationService = $startupModificationService;
         $this->suspensionService = $suspensionService;
     }
@@ -170,7 +200,6 @@ class ServersController extends Controller
      * @param \Pterodactyl\Models\Server $server
      * @return \Illuminate\Http\RedirectResponse
      *
-     * @throws \Pterodactyl\Exceptions\DisplayException
      * @throws \Pterodactyl\Exceptions\Model\DataValidationException
      * @throws \Pterodactyl\Exceptions\Repository\RecordNotFoundException
      */
@@ -378,4 +407,59 @@ class ServersController extends Controller
 
         return response('', 204);
     }
+
+    /**
+     * Add a mount to a server.
+     *
+     * @param Server $server
+     * @param int $mount_id
+     * @return \Illuminate\Http\RedirectResponse
+     */
+    public function addMount(Server $server, int $mount_id)
+    {
+        $server->mounts()->attach($mount_id);
+
+        $data = $this->serverConfigurationStructureService->handle($server);
+
+        try {
+            $this->daemonServerRepository
+                ->setServer($server)
+                ->update(Arr::only($data, ['mounts']));
+        } catch (RequestException $exception) {
+            throw new DaemonConnectionException($exception);
+        }
+
+        $this->alert->success('Mount was added successfully.')->flash();
+
+        return redirect()->route('admin.servers.view.mounts', $server->id);
+    }
+
+    /**
+     * Remove a mount from a server.
+     *
+     * @param Server $server
+     * @param int $mount_id
+     * @return \Illuminate\Http\RedirectResponse
+     *
+     * @throws DaemonConnectionException
+     * @throws \Pterodactyl\Exceptions\Repository\RecordNotFoundException
+     */
+    public function deleteMount(Server $server, int $mount_id)
+    {
+        $server->mounts()->detach($mount_id);
+
+        $data = $this->serverConfigurationStructureService->handle($server);
+
+        try {
+            $this->daemonServerRepository
+                ->setServer($server)
+                ->update(Arr::only($data, ['mounts']));
+        } catch (RequestException $exception) {
+            throw new DaemonConnectionException($exception);
+        }
+
+        $this->alert->success('Mount was removed successfully.')->flash();
+
+        return redirect()->route('admin.servers.view.mounts', $server->id);
+    }
 }

app/Http/Requests/Admin/MountFormRequest.php

@@ -0,0 +1,29 @@
+<?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\Http\Requests\Admin;
+
+use Pterodactyl\Models\Mount;
+
+class MountFormRequest extends AdminFormRequest
+{
+    /**
+     * Setup the validation rules to use for these requests.
+     *
+     * @return array
+     */
+    public function rules()
+    {
+        if ($this->method() === 'PATCH') {
+            return Mount::getRulesForUpdate($this->route()->parameter('mount')->id);
+        }
+
+        return Mount::getRules();
+    }
+}