Addition of repository to ease testing and maintainability

app/Repositories/Eloquent/EloquentRepository.php

@@ -0,0 +1,150 @@
+<?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\Exceptions\Model\DataValidationException;
+use Pterodactyl\Exceptions\Repository\RecordNotFoundException;
+use Pterodactyl\Repository\Repository;
+use Pterodactyl\Contracts\Repository\RepositoryInterface;
+
+abstract class EloquentRepository extends Repository implements RepositoryInterface
+{
+    /**
+     * @return \Illuminate\Database\Eloquent\Builder
+     */
+    public function getBuilder()
+    {
+        return $this->getModel()->newQuery();
+    }
+
+    /**
+     * Create a new model instance and persist it to the database.
+     * @param  array $fields
+     * @param  bool  $validate
+     * @param  bool  $force
+     * @return bool|\Illuminate\Database\Eloquent\Model
+     * @throws \Pterodactyl\Exceptions\Model\DataValidationException
+     */
+    public function create($fields, $validate = true, $force = false)
+    {
+        $instance = $this->getBuilder()->newModelInstance();
+
+        if ($force) {
+            $instance->forceFill($fields);
+        } else {
+            $instance->fill($fields);
+        }
+
+        if (! $validate) {
+            $saved = $instance->skipValidation()->save();
+        } else {
+            if (! $saved = $instance->save()) {
+                throw new DataValidationException($instance->getValidator());
+            }
+        }
+
+        return ($this->withFresh) ? $instance->fresh() : $saved;
+    }
+
+    /**
+     * Return a record from the database for a given ID.
+     *
+     * @param  int $id
+     * @return \Illuminate\Database\Eloquent\Builder|\Illuminate\Database\Eloquent\Model
+     *
+     * @throws \Pterodactyl\Exceptions\Repository\RecordNotFoundException
+     */
+    public function find($id)
+    {
+        $instance = $this->getBuilder()->find($id, $this->getColumns());
+
+        if (! $instance) {
+            throw new RecordNotFoundException();
+        }
+
+        return $instance;
+    }
+
+    public function findWhere($fields)
+    {
+        // TODO: Implement findWhere() method.
+    }
+
+    /**
+     * Delete a record from the DB given an ID.
+     *
+     * @param  int $id
+     * @param  bool $destroy
+     * @return bool|null
+     */
+    public function delete($id, $destroy = false)
+    {
+        if ($destroy) {
+            return $this->getBuilder()->where($this->getModel()->getKeyName(), $id)->forceDelete();
+        }
+
+        return $this->getBuilder()->where($this->getModel()->getKeyName(), $id)->delete();
+    }
+
+    /**
+     * @param  int   $id
+     * @param  array $fields
+     * @param  bool  $validate
+     * @param  bool  $force
+     * @return mixed
+     *
+     * @throws \Pterodactyl\Exceptions\Model\DataValidationException
+     * @throws \Pterodactyl\Exceptions\Repository\RecordNotFoundException
+     */
+    public function update($id, $fields, $validate = true, $force = false)
+    {
+        $instance = $this->getBuilder()->where('id', $id)->first();
+
+        if (! $instance) {
+            throw new RecordNotFoundException();
+        }
+
+        if ($force) {
+            $instance->forceFill($fields);
+        } else {
+            $instance->fill($fields);
+        }
+
+        if (! $validate) {
+            $saved = $instance->skipValidation()->save();
+        } else {
+            if (! $saved = $instance->save()) {
+                throw new DataValidationException($instance->getValidator());
+            }
+        }
+
+        return ($this->withFresh) ? $instance->fresh($this->getColumns()) : $saved;
+    }
+
+    public function massUpdate($fields)
+    {
+        // TODO: Implement massUpdate() method.
+    }
+}

app/Repositories/Eloquent/UserRepository.php

@@ -24,52 +24,85 @@
 
 namespace Pterodactyl\Repositories\Eloquent;
 
-use Pterodactyl\Models\User;
-use Illuminate\Contracts\Auth\Guard;
-use Pterodactyl\Repositories\Repository;
+use Illuminate\Contracts\Config\Repository as ConfigRepository;
+use Illuminate\Foundation\Application;
+use Pterodactyl\Contracts\Repository\UserRepositoryInterface;
 use Pterodactyl\Exceptions\DisplayException;
-use Pterodactyl\Contracts\Repositories\UserInterface;
+use Pterodactyl\Exceptions\Repository\RecordNotFoundException;
+use Pterodactyl\Models\User;
 
-class UserRepository extends Repository implements UserInterface
+class UserRepository extends EloquentRepository implements UserRepositoryInterface
 {
     /**
-     * Dependencies to automatically inject into the repository.
-     *
-     * @var array
+     * @var \Illuminate\Contracts\Config\Repository
      */
-    protected $inject = [
-        'guard' => Guard::class,
-    ];
+    protected $config;
 
     /**
-     * Return the model to be used for the repository.
-     *
-     * @return string
+     * @var bool|array
      */
+    protected $searchTerm = false;
+
+    /**
+     * UserRepository constructor.
+     *
+     * @param \Illuminate\Foundation\Application      $application
+     * @param \Illuminate\Contracts\Config\Repository $config
+     */
+    public function __construct(Application $application, ConfigRepository $config)
+    {
+        parent::__construct($application);
+
+        $this->config = $config;
+    }
+
     public function model()
     {
         return User::class;
     }
 
-    /**
-     * {@inheritdoc}
-     */
     public function search($term)
     {
-        $this->model->search($term);
-
-        return $this;
-    }
-
-    public function delete($id)
-    {
-        $user = $this->model->withCount('servers')->find($id);
-
-        if ($this->guard->user() && $this->guard->user()->id === $user->id) {
-            throw new DisplayException('You cannot delete your own account.');
+        if (empty($term)) {
+            return $this;
         }
 
-        if ($user->server_count > 0) {
+        $clone = clone $this;
+        $clone->searchTerm = $term;
+
+        return $clone;
+    }
+
+    public function getAllUsersWithCounts()
+    {
+        $users = $this->getBuilder()->withCount('servers', 'subuserOf');
+
+        if ($this->searchTerm) {
+            $users->search($this->searchTerm);
+        }
+
+        return $users->paginate(
+            $this->config->get('pterodactyl.paginate.admin.users'), $this->getColumns()
+        );
+    }
+
+    /**
+     * Delete a user if they have no servers attached to their account.
+     *
+     * @param  int $id
+     * @return bool
+     *
+     * @throws \Pterodactyl\Exceptions\DisplayException
+     */
+    public function deleteIfNoServers($id)
+    {
+        $user = $this->getBuilder()->withCount('servers')->where('id', $id)->first();
+
+        if (! $user) {
+            throw new RecordNotFoundException();
+        }
+
+        if ($user->servers_count > 0) {
             throw new DisplayException('Cannot delete an account that has active servers attached to it.');
         }