Move location service to match other services

Author: DaneEveritt

app/Console/Commands/AddLocation.php

@@ -25,7 +25,6 @@
 namespace Pterodactyl\Console\Commands;
 
 use Illuminate\Console\Command;
-use Pterodactyl\Repositories\LocationRepository;
 
 class AddLocation extends Command
 {

app/Console/Commands/Inspire.php

@@ -13,7 +13,6 @@ class Kernel extends ConsoleKernel
      * @var array
      */
     protected $commands = [
-        \Pterodactyl\Console\Commands\Inspire::class,
         \Pterodactyl\Console\Commands\MakeUser::class,
         \Pterodactyl\Console\Commands\ShowVersion::class,
         \Pterodactyl\Console\Commands\UpdateEnvironment::class,

app/Console/Kernel.php

@@ -28,17 +28,6 @@
 
 interface LocationRepositoryInterface extends RepositoryInterface, SearchableInterface
 {
-    /**
-     * Delete a location only if there are no nodes attached to it.
-     *
-     * @param  $id
-     * @return bool|mixed|null
-     *
-     * @throws \Pterodactyl\Exceptions\DisplayException
-     * @throws \Pterodactyl\Exceptions\Repository\RecordNotFoundException
-     */
-    public function deleteIfNoNodes($id);
-
     /**
      * Return locations with a count of nodes and servers attached to it.
      *
@@ -62,4 +51,14 @@ public function getAllWithNodes();
      * @throws \Pterodactyl\Exceptions\Repository\RecordNotFoundException
      */
     public function getWithNodes($id);
+
+    /**
+     * Return a location and the count of nodes in that location.
+     *
+     * @param int $id
+     * @return mixed
+     *
+     * @throws \Pterodactyl\Exceptions\Repository\RecordNotFoundException
+     */
+    public function getWithNodeCount($id);
 }

app/Contracts/Repository/LocationRepositoryInterface.php

@@ -0,0 +1,31 @@
+<?php
+/*
+ * Pterodactyl - Panel
+ * Copyright (c) 2015 - 2017 Dane Everitt <dane@daneeveritt.com>.
+ *
+ * Permission is hereby granted, free of charge, to any person obtaining a copy
+ * of this software and associated documentation files (the "Software"), to deal
+ * in the Software without restriction, including without limitation the rights
+ * to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+ * copies of the Software, and to permit persons to whom the Software is
+ * furnished to do so, subject to the following conditions:
+ *
+ * The above copyright notice and this permission notice shall be included in all
+ * copies or substantial portions of the Software.
+ *
+ * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+ * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+ * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+ * AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+ * LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+ * OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+ * SOFTWARE.
+ */
+
+namespace Pterodactyl\Exceptions\Service\Location;
+
+use Pterodactyl\Exceptions\DisplayException;
+
+class HasActiveNodesException extends DisplayException
+{
+}

app/Exceptions/Service/Location/HasActiveNodesException.php

@@ -26,10 +26,12 @@
 
 use Pterodactyl\Models\Location;
 use Prologue\Alerts\AlertsMessageBag;
-use Pterodactyl\Services\LocationService;
 use Pterodactyl\Exceptions\DisplayException;
 use Pterodactyl\Http\Controllers\Controller;
 use Pterodactyl\Http\Requests\Admin\LocationFormRequest;
+use Pterodactyl\Services\Locations\LocationUpdateService;
+use Pterodactyl\Services\Locations\LocationCreationService;
+use Pterodactyl\Services\Locations\LocationDeletionService;
 use Pterodactyl\Contracts\Repository\LocationRepositoryInterface;
 
 class LocationController extends Controller
@@ -39,31 +41,47 @@ class LocationController extends Controller
      */
     protected $alert;
 
+    /**
+     * @var \Pterodactyl\Services\Locations\LocationCreationService
+     */
+    protected $creationService;
+
+    /**
+     * @var \Pterodactyl\Services\Locations\LocationDeletionService
+     */
+    protected $deletionService;
+
     /**
      * @var \Pterodactyl\Contracts\Repository\LocationRepositoryInterface
      */
     protected $repository;
 
     /**
-     * @var \Pterodactyl\Services\\LocationService
+     * @var \Pterodactyl\Services\Locations\LocationUpdateService
      */
-    protected $service;
+    protected $updateService;
 
     /**
      * LocationController constructor.
      *
      * @param \Prologue\Alerts\AlertsMessageBag                             $alert
+     * @param \Pterodactyl\Services\Locations\LocationCreationService       $creationService
+     * @param \Pterodactyl\Services\Locations\LocationDeletionService       $deletionService
      * @param \Pterodactyl\Contracts\Repository\LocationRepositoryInterface $repository
-     * @param \Pterodactyl\Services\LocationService                         $service
+     * @param \Pterodactyl\Services\Locations\LocationUpdateService         $updateService
      */
     public function __construct(
         AlertsMessageBag $alert,
+        LocationCreationService $creationService,
+        LocationDeletionService $deletionService,
         LocationRepositoryInterface $repository,
-        LocationService $service
+        LocationUpdateService $updateService
     ) {
         $this->alert = $alert;
+        $this->creationService = $creationService;
+        $this->deletionService = $deletionService;
         $this->repository = $repository;
-        $this->service = $service;
+        $this->updateService = $updateService;
     }
 
     /**
@@ -104,7 +122,7 @@ public function view($id)
      */
     public function create(LocationFormRequest $request)
     {
-        $location = $this->service->create($request->normalize());
+        $location = $this->creationService->handle($request->normalize());
         $this->alert->success('Location was created successfully.')->flash();
 
         return redirect()->route('admin.locations.view', $location->id);
@@ -126,7 +144,7 @@ public function update(LocationFormRequest $request, Location $location)
             return $this->delete($location);
         }
 
-        $this->service->update($location->id, $request->normalize());
+        $this->updateService->handle($location->id, $request->normalize());
         $this->alert->success('Location was updated successfully.')->flash();
 
         return redirect()->route('admin.locations.view', $location->id);
@@ -144,7 +162,7 @@ public function update(LocationFormRequest $request, Location $location)
     public function delete(Location $location)
     {
         try {
-            $this->service->delete($location->id);
+            $this->deletionService->handle($location->id);
 
             return redirect()->route('admin.locations');
         } catch (DisplayException $ex) {

app/Http/Controllers/Admin/LocationController.php

@@ -25,7 +25,6 @@
 namespace Pterodactyl\Repositories\Eloquent;
 
 use Pterodactyl\Models\Location;
-use Pterodactyl\Exceptions\DisplayException;
 use Pterodactyl\Repositories\Concerns\Searchable;
 use Pterodactyl\Exceptions\Repository\RecordNotFoundException;
 use Pterodactyl\Contracts\Repository\LocationRepositoryInterface;
@@ -47,25 +46,6 @@ public function model()
         return Location::class;
     }
 
-    /**
-     * {@inheritdoc}
-     * @todo remove this, do logic in service
-     */
-    public function deleteIfNoNodes($id)
-    {
-        $location = $this->getBuilder()->with('nodes')->find($id);
-
-        if (! $location) {
-            throw new RecordNotFoundException();
-        }
-
-        if ($location->nodes_count > 0) {
-            throw new DisplayException('Cannot delete a location that has nodes assigned to it.');
-        }
-
-        return $location->delete();
-    }
-
     /**
      * {@inheritdoc}
      */
@@ -88,9 +68,21 @@ public function getAllWithNodes()
     public function getWithNodes($id)
     {
         $instance = $this->getBuilder()->with('nodes.servers')->find($id, $this->getColumns());
+        if (! $instance) {
+            throw new RecordNotFoundException;
+        }
+
+        return $instance;
+    }
 
+    /**
+     * {@inheritdoc}
+     */
+    public function getWithNodeCount($id)
+    {
+        $instance = $this->getBuilder()->withCount('nodes')->find($id, $this->getColumns());
         if (! $instance) {
-            throw new RecordNotFoundException();
+            throw new RecordNotFoundException;
         }
 
         return $instance;

app/Repositories/Eloquent/LocationRepository.php

@@ -22,19 +22,19 @@
  * SOFTWARE.
  */
 
-namespace Pterodactyl\Services;
+namespace Pterodactyl\Services\Locations;
 
 use Pterodactyl\Contracts\Repository\LocationRepositoryInterface;
 
-class LocationService
+class LocationCreationService
 {
     /**
      * @var \Pterodactyl\Contracts\Repository\LocationRepositoryInterface
      */
     protected $repository;
 
     /**
-     * LocationService constructor.
+     * LocationCreationService constructor.
      *
      * @param \Pterodactyl\Contracts\Repository\LocationRepositoryInterface $repository
      */
@@ -44,42 +44,15 @@ public function __construct(LocationRepositoryInterface $repository)
     }
 
     /**
-     * Create the location in the database and return it.
+     * Create a new location.
      *
      * @param array $data
      * @return \Pterodactyl\Models\Location
      *
      * @throws \Pterodactyl\Exceptions\Model\DataValidationException
      */
-    public function create(array $data)
+    public function handle(array $data)
     {
         return $this->repository->create($data);
     }
-
-    /**
-     * Update location model in the DB.
-     *
-     * @param int   $id
-     * @param array $data
-     * @return \Pterodactyl\Models\Location
-     *
-     * @throws \Pterodactyl\Exceptions\Model\DataValidationException
-     */
-    public function update($id, array $data)
-    {
-        return $this->repository->update($id, $data);
-    }
-
-    /**
-     * Delete a model from the DB.
-     *
-     * @param int $id
-     * @return bool
-     *
-     * @throws \Pterodactyl\Exceptions\DisplayException
-     */
-    public function delete($id)
-    {
-        return $this->repository->deleteIfNoNodes($id);
-    }
 }