Start ripping out old search functionality for models

DaneEveritt · DaneEveritt · commit 4dddcaebb042 · 2020-09-13T11:29:47.000-07:00
diff --git a/app/Contracts/Repository/Attributes/SearchableInterface.php b/app/Contracts/Repository/Attributes/SearchableInterface.php
diff --git a/app/Contracts/Repository/LocationRepositoryInterface.php b/app/Contracts/Repository/LocationRepositoryInterface.php
@@ -4,9 +4,8 @@
 
 use Pterodactyl\Models\Location;
 use Illuminate\Support\Collection;
-use Pterodactyl\Contracts\Repository\Attributes\SearchableInterface;
 
-interface LocationRepositoryInterface extends RepositoryInterface, SearchableInterface
+interface LocationRepositoryInterface extends RepositoryInterface
 {
     /**
      * Return locations with a count of nodes and servers attached to it.
diff --git a/app/Contracts/Repository/NodeRepositoryInterface.php b/app/Contracts/Repository/NodeRepositoryInterface.php
@@ -8,7 +8,7 @@
 use Illuminate\Contracts\Pagination\LengthAwarePaginator;
 use Pterodactyl\Contracts\Repository\Attributes\SearchableInterface;
 
-interface NodeRepositoryInterface extends RepositoryInterface, SearchableInterface
+interface NodeRepositoryInterface extends RepositoryInterface
 {
     const THRESHOLD_PERCENTAGE_LOW = 75;
     const THRESHOLD_PERCENTAGE_MEDIUM = 90;
diff --git a/app/Contracts/Repository/ServerRepositoryInterface.php b/app/Contracts/Repository/ServerRepositoryInterface.php
@@ -5,9 +5,8 @@
 use Pterodactyl\Models\Server;
 use Illuminate\Support\Collection;
 use Illuminate\Contracts\Pagination\LengthAwarePaginator;
-use Pterodactyl\Contracts\Repository\Attributes\SearchableInterface;
 
-interface ServerRepositoryInterface extends RepositoryInterface, SearchableInterface
+interface ServerRepositoryInterface extends RepositoryInterface
 {
     /**
      * Returns a listing of all servers that exist including relationships.
diff --git a/app/Contracts/Repository/UserRepositoryInterface.php b/app/Contracts/Repository/UserRepositoryInterface.php
@@ -6,7 +6,7 @@
 use Illuminate\Contracts\Pagination\LengthAwarePaginator;
 use Pterodactyl\Contracts\Repository\Attributes\SearchableInterface;
 
-interface UserRepositoryInterface extends RepositoryInterface, SearchableInterface
+interface UserRepositoryInterface extends RepositoryInterface
 {
     /**
      * Return all users with counts of servers and subusers of servers.
diff --git a/app/Models/Node.php b/app/Models/Node.php
@@ -5,7 +5,6 @@
 use Symfony\Component\Yaml\Yaml;
 use Illuminate\Container\Container;
 use Illuminate\Notifications\Notifiable;
-use Pterodactyl\Models\Traits\Searchable;
 use Illuminate\Contracts\Encryption\Encrypter;
 
 /**
@@ -40,7 +39,6 @@
 class Node extends Model
 {
     use Notifiable;
-    use Searchable;
 
     /**
      * The resource name for this model when it is transformed into an
@@ -95,18 +93,6 @@ class Node extends Model
         'description', 'maintenance_mode',
     ];
 
-    /**
-     * Fields that are searchable.
-     *
-     * @var array
-     */
-    protected $searchableColumns = [
-        'name' => 10,
-        'fqdn' => 8,
-        'location.short' => 4,
-        'location.long' => 4,
-    ];
-
     /**
      * @var array
      */
@@ -216,7 +202,7 @@ public function getJsonConfiguration(bool $pretty = false)
      */
     public function getDecryptedKey(): string
     {
-        return (string) Container::getInstance()->make(Encrypter::class)->decrypt(
+        return (string)Container::getInstance()->make(Encrypter::class)->decrypt(
             $this->daemon_token
         );
     }
diff --git a/app/Models/Server.php b/app/Models/Server.php
@@ -3,7 +3,6 @@
 namespace Pterodactyl\Models;
 
 use Illuminate\Notifications\Notifiable;
-use Pterodactyl\Models\Traits\Searchable;
 use Illuminate\Database\Query\JoinClause;
 use Znck\Eloquent\Traits\BelongsToThrough;
 
@@ -58,7 +57,6 @@ class Server extends Model
 {
     use BelongsToThrough;
     use Notifiable;
-    use Searchable;
 
     /**
      * The resource name for this model when it is transformed into an
@@ -154,21 +152,6 @@ class Server extends Model
         'backup_limit' => 'integer',
     ];
 
-    /**
-     * Parameters for search querying.
-     *
-     * @var array
-     */
-    protected $searchableColumns = [
-        'name' => 100,
-        'uuid' => 80,
-        'uuidShort' => 80,
-        'external_id' => 50,
-        'user.email' => 40,
-        'user.username' => 30,
-        'node.name' => 10,
-    ];
-
     /**
      * Returns the format for server allocations when communicating with the Daemon.
      *
diff --git a/app/Models/Traits/Searchable.php b/app/Models/Traits/Searchable.php
diff --git a/app/Models/User.php b/app/Models/User.php
@@ -8,7 +8,6 @@
 use Illuminate\Auth\Authenticatable;
 use Illuminate\Notifications\Notifiable;
 use Illuminate\Database\Eloquent\Builder;
-use Pterodactyl\Models\Traits\Searchable;
 use Illuminate\Auth\Passwords\CanResetPassword;
 use Pterodactyl\Traits\Helpers\AvailableLanguages;
 use Illuminate\Foundation\Auth\Access\Authorizable;
@@ -52,7 +51,6 @@ class User extends Model implements
     use AvailableLanguages;
     use CanResetPassword;
     use Notifiable;
-    use Searchable;
 
     const USER_LEVEL_USER = 0;
     const USER_LEVEL_ADMIN = 1;
@@ -120,20 +118,6 @@ class User extends Model implements
      */
     protected $hidden = ['password', 'remember_token', 'totp_secret', 'totp_authenticated_at'];
 
-    /**
-     * Parameters for search querying.
-     *
-     * @var array
-     */
-    protected $searchableColumns = [
-        'username' => 100,
-        'email' => 100,
-        'external_id' => 80,
-        'uuid' => 80,
-        'name_first' => 40,
-        'name_last' => 40,
-    ];
-
     /**
      * Default values for specific fields in the database.
      *
diff --git a/app/Repositories/Concerns/Searchable.php b/app/Repositories/Concerns/Searchable.php
@@ -11,18 +11,6 @@ trait Searchable
      */
     protected $searchTerm;
 
-    /**
-     * Set the search term.
-     *
-     * @param string|null $term
-     * @return $this
-     * @deprecated
-     */
-    public function search($term)
-    {
-        return $this->setSearchTerm($term);
-    }
-
     /**
      * Set the search term to use when requesting all records from
      * the model.
@@ -41,24 +29,4 @@ public function setSearchTerm(string $term = null)
 
         return $clone;
     }
-
-    /**
-     * Determine if a valid search term is set on this repository.
-     *
-     * @return bool
-     */
-    public function hasSearchTerm(): bool
-    {
-        return ! empty($this->searchTerm);
-    }
-
-    /**
-     * Return the search term.
-     *
-     * @return string|null
-     */
-    public function getSearchTerm()
-    {
-        return $this->searchTerm;
-    }
 }
diff --git a/app/Repositories/Eloquent/EloquentRepository.php b/app/Repositories/Eloquent/EloquentRepository.php
@@ -289,12 +289,7 @@ public function updateOrCreate(array $where, array $fields, bool $validate = tru
      */
     public function all(): Collection
     {
-        $instance = $this->getBuilder();
-        if (is_subclass_of(get_called_class(), SearchableInterface::class) && $this->hasSearchTerm()) {
-            $instance = $instance->search($this->getSearchTerm());
-        }
-
-        return $instance->get($this->getColumns());
+        return $this->getBuilder()->get($this->getColumns());
     }
 
     /**
@@ -305,12 +300,7 @@ public function all(): Collection
      */
     public function paginated(int $perPage): LengthAwarePaginator
     {
-        $instance = $this->getBuilder();
-        if (is_subclass_of(get_called_class(), SearchableInterface::class) && $this->hasSearchTerm()) {
-            $instance = $instance->search($this->getSearchTerm());
-        }
-
-        return $instance->paginate($perPage, $this->getColumns());
+        return $this->getBuilder()->paginate($perPage, $this->getColumns());
     }
 
     /**
diff --git a/app/Repositories/Eloquent/LocationRepository.php b/app/Repositories/Eloquent/LocationRepository.php
@@ -4,15 +4,12 @@
 
 use Pterodactyl\Models\Location;
 use Illuminate\Support\Collection;
-use Pterodactyl\Repositories\Concerns\Searchable;
 use Illuminate\Database\Eloquent\ModelNotFoundException;
 use Pterodactyl\Exceptions\Repository\RecordNotFoundException;
 use Pterodactyl\Contracts\Repository\LocationRepositoryInterface;
 
 class LocationRepository extends EloquentRepository implements LocationRepositoryInterface
 {
-    use Searchable;
-
     /**
      * Return the model backing this repository.
      *
diff --git a/app/Repositories/Eloquent/MountRepository.php b/app/Repositories/Eloquent/MountRepository.php
@@ -5,14 +5,11 @@
 use Pterodactyl\Models\Mount;
 use Pterodactyl\Models\Server;
 use Illuminate\Support\Collection;
-use Pterodactyl\Repositories\Concerns\Searchable;
 use Illuminate\Database\Eloquent\ModelNotFoundException;
 use Pterodactyl\Exceptions\Repository\RecordNotFoundException;
 
 class MountRepository extends EloquentRepository
 {
-    use Searchable;
-
     /**
      * Return the model backing this repository.
      *
diff --git a/app/Repositories/Eloquent/NodeRepository.php b/app/Repositories/Eloquent/NodeRepository.php
@@ -5,14 +5,11 @@
 use Pterodactyl\Models\Node;
 use Illuminate\Support\Collection;
 use Illuminate\Support\LazyCollection;
-use Pterodactyl\Repositories\Concerns\Searchable;
 use Illuminate\Contracts\Pagination\LengthAwarePaginator;
 use Pterodactyl\Contracts\Repository\NodeRepositoryInterface;
 
 class NodeRepository extends EloquentRepository implements NodeRepositoryInterface
 {
-    use Searchable;
-
     /**
      * Return the model backing this repository.
      *
@@ -92,13 +89,7 @@ public function getUsageStatsRaw(Node $node): array
      */
     public function getNodeListingData(): LengthAwarePaginator
     {
-        $instance = $this->getBuilder()->with('location')->withCount('servers');
-
-        if ($this->hasSearchTerm()) {
-            $instance->search($this->getSearchTerm());
-        }
-
-        return $instance->paginate(25, $this->getColumns());
+        return $this->getBuilder()->with('location')->withCount('servers')->paginate(25, $this->getColumns());
     }
 
     /**
diff --git a/app/Repositories/Eloquent/ServerRepository.php b/app/Repositories/Eloquent/ServerRepository.php
diff --git a/app/Repositories/Eloquent/UserRepository.php b/app/Repositories/Eloquent/UserRepository.php

Original file line number	Diff line number	Diff line change
`@@ -4,9 +4,8 @@`
`4`	`4`
`5`	`5`	`use Pterodactyl\Models\Location;`
`6`	`6`	`use Illuminate\Support\Collection;`
`7`		`-use Pterodactyl\Contracts\Repository\Attributes\SearchableInterface;`
`8`	`7`
`9`		`-interface LocationRepositoryInterface extends RepositoryInterface, SearchableInterface`
	`8`	`+interface LocationRepositoryInterface extends RepositoryInterface`
`10`	`9`	`{`
`11`	`10`	`/**`
`12`	`11`	`* Return locations with a count of nodes and servers attached to it.`
Original file line number	Diff line number	Diff line change
`@@ -8,7 +8,7 @@`
`8`	`8`	`use Illuminate\Contracts\Pagination\LengthAwarePaginator;`
`9`	`9`	`use Pterodactyl\Contracts\Repository\Attributes\SearchableInterface;`
`10`	`10`
`11`		`-interface NodeRepositoryInterface extends RepositoryInterface, SearchableInterface`
	`11`	`+interface NodeRepositoryInterface extends RepositoryInterface`
`12`	`12`	`{`
`13`	`13`	`const THRESHOLD_PERCENTAGE_LOW = 75;`
`14`	`14`	`const THRESHOLD_PERCENTAGE_MEDIUM = 90;`
Original file line number	Diff line number	Diff line change
`@@ -6,7 +6,7 @@`
`6`	`6`	`use Illuminate\Contracts\Pagination\LengthAwarePaginator;`
`7`	`7`	`use Pterodactyl\Contracts\Repository\Attributes\SearchableInterface;`
`8`	`8`
`9`		`-interface UserRepositoryInterface extends RepositoryInterface, SearchableInterface`
	`9`	`+interface UserRepositoryInterface extends RepositoryInterface`
`10`	`10`	`{`
`11`	`11`	`/**`
`12`	`12`	`* Return all users with counts of servers and subusers of servers.`