Update location and databasehost services to use repositories

Includes unit tests for both services

Author: DaneEveritt

app/Contracts/Repository/DatabaseHostInterface.php

@@ -0,0 +1,30 @@
+<?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\Contracts\Repository;
+
+interface DatabaseHostInterface extends RepositoryInterface
+{
+    public function deleteIfNoDatabases($id);
+}

app/Contracts/Repository/LocationRepositoryInterface.php

@@ -0,0 +1,32 @@
+<?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\Contracts\Repository;
+
+use Pterodactyl\Contracts\Repository\Attributes\SearchableInterface;
+
+interface LocationRepositoryInterface extends RepositoryInterface, SearchableInterface
+{
+    public function deleteIfNoNodes($id);
+}

app/Extensions/DynamicDatabaseConnection.php

@@ -24,6 +24,7 @@
 
 namespace Pterodactyl\Extensions;
 
+use Pterodactyl\Contracts\Repository\DatabaseHostInterface;
 use Pterodactyl\Models\DatabaseHost;
 use Illuminate\Contracts\Encryption\Encrypter;
 use Illuminate\Config\Repository as ConfigRepository;
@@ -45,25 +46,25 @@ class DynamicDatabaseConnection
     protected $encrypter;
 
     /**
-     * @var \Pterodactyl\Models\DatabaseHost
+     * @var \Pterodactyl\Contracts\Repository\DatabaseHostInterface
      */
-    protected $model;
+    protected $repository;
 
     /**
      * DynamicDatabaseConnection constructor.
      *
-     * @param \Illuminate\Config\Repository              $config
-     * @param \Illuminate\Contracts\Encryption\Encrypter $encrypter
-     * @param \Pterodactyl\Models\DatabaseHost           $model
+     * @param \Illuminate\Config\Repository                           $config
+     * @param \Pterodactyl\Contracts\Repository\DatabaseHostInterface $repository
+     * @param \Illuminate\Contracts\Encryption\Encrypter              $encrypter
      */
     public function __construct(
         ConfigRepository $config,
-        Encrypter $encrypter,
-        DatabaseHost $model
+        DatabaseHostInterface $repository,
+        Encrypter $encrypter
     ) {
         $this->config = $config;
         $this->encrypter = $encrypter;
-        $this->model = $model;
+        $this->repository = $repository;
     }
 
     /**
@@ -76,7 +77,7 @@ public function __construct(
     public function set($connection, $host, $database = 'mysql')
     {
         if (! $host instanceof DatabaseHost) {
-            $host = $this->model->findOrFail($host);
+            $host = $this->repository->find($host);
         }
 
         $this->config->set('database.connections.' . $connection, [

app/Providers/RepositoryServiceProvider.php

@@ -25,6 +25,10 @@
 namespace Pterodactyl\Providers;
 
 use Illuminate\Support\ServiceProvider;
+use Pterodactyl\Contracts\Repository\DatabaseHostInterface;
+use Pterodactyl\Contracts\Repository\LocationRepositoryInterface;
+use Pterodactyl\Repositories\Eloquent\DatabaseHostRepository;
+use Pterodactyl\Repositories\Eloquent\LocationRepository;
 use Pterodactyl\Repositories\Eloquent\UserRepository;
 use Pterodactyl\Contracts\Repository\UserRepositoryInterface;
 
@@ -35,6 +39,8 @@ class RepositoryServiceProvider extends ServiceProvider
      */
     public function register()
     {
+        $this->app->bind(DatabaseHostInterface::class, DatabaseHostRepository::class);
+        $this->app->bind(LocationRepositoryInterface::class, LocationRepository::class);
         $this->app->bind(UserRepositoryInterface::class, UserRepository::class);
     }
 }

app/Repositories/Eloquent/DatabaseHostRepository.php

@@ -0,0 +1,67 @@
+<?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\Repositories\Eloquent;
+
+use Pterodactyl\Contracts\Repository\DatabaseHostInterface;
+use Pterodactyl\Exceptions\DisplayException;
+use Pterodactyl\Exceptions\Repository\RecordNotFoundException;
+use Pterodactyl\Models\DatabaseHost;
+
+class DatabaseHostRepository extends EloquentRepository implements DatabaseHostInterface
+{
+    /**
+     * Setup the model to be used.
+     *
+     * @return string
+     */
+    public function model()
+    {
+        return DatabaseHost::class;
+    }
+
+    /**
+     * Delete a database host from the DB if there are no databases using it.
+     *
+     * @param  int $id
+     * @return bool|null
+     *
+     * @throws \Pterodactyl\Exceptions\DisplayException
+     * @throws \Pterodactyl\Exceptions\Repository\RecordNotFoundException
+     */
+    public function deleteIfNoDatabases($id)
+    {
+        $instance = $this->getBuilder()->withCount('databases')->find($id);
+
+        if (! $instance) {
+            throw new RecordNotFoundException();
+        }
+
+        if ($instance->databases_count > 0) {
+            throw new DisplayException('Cannot delete a database host that has active databases attached to it.');
+        }
+
+        return $instance->delete();
+    }
+}

app/Repositories/Eloquent/LocationRepository.php

@@ -0,0 +1,90 @@
+<?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\Repositories\Eloquent;
+
+use Pterodactyl\Models\Location;
+use Pterodactyl\Exceptions\DisplayException;
+use Pterodactyl\Exceptions\Repository\RecordNotFoundException;
+use Pterodactyl\Contracts\Repository\LocationRepositoryInterface;
+
+class LocationRepository extends EloquentRepository implements LocationRepositoryInterface
+{
+    /**
+     * @var string
+     */
+    protected $searchTerm;
+
+    /**
+     * Setup model.
+     *
+     * @return string
+     */
+    public function model()
+    {
+        return Location::class;
+    }
+
+    /**
+     * Setup the model for search abilities.
+     *
+     * @param  $term
+     * @return $this
+     */
+    public function search($term)
+    {
+        if (empty($term)) {
+            return $this;
+        }
+
+        $clone = clone $this;
+        $clone->searchTerm = $term;
+
+        return $clone;
+    }
+
+    /**
+     * 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)
+    {
+        $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();
+    }
+}