Add support for finding a user by external ID.

Author: DaneEveritt

CHANGELOG.md

@@ -10,6 +10,7 @@ This project follows [Semantic Versioning](http://semver.org) guidelines.
 
 ### Added
 * Added ability to search the following API endpoints: list users, list servers, and list locations.
+* Add support for finding a user by external ID using `/api/application/users/external/<id>` or by passing it as the search term when listing all users.
 
 ## v0.7.0-rc.2 (Derelict Dermodactylus)
 ### Fixed

app/Http/Controllers/Api/Application/Users/ExternalUserController.php

@@ -0,0 +1,23 @@
+<?php
+
+namespace Pterodactyl\Http\Controllers\Api\Application\Users;
+
+use Pterodactyl\Transformers\Api\Application\UserTransformer;
+use Pterodactyl\Http\Controllers\Api\Application\ApplicationApiController;
+use Pterodactyl\Http\Requests\Api\Application\Users\GetExternalUserRequest;
+
+class ExternalUserController extends ApplicationApiController
+{
+    /**
+     * Retrieve a specific user from the database using their external ID.
+     *
+     * @param \Pterodactyl\Http\Requests\Api\Application\Users\GetExternalUserRequest $request
+     * @return array
+     */
+    public function index(GetExternalUserRequest $request): array
+    {
+        return $this->fractal->item($request->getUserModel())
+            ->transformWith($this->getTransformer(UserTransformer::class))
+            ->toArray();
+    }
+}

app/Http/Requests/Api/Application/ApplicationApiRequest.php

@@ -117,7 +117,7 @@ protected function passesAuthorization()
         // an item exists (or does not exist) to the user until they can prove
         // that they have permission to know about it.
         if ($this->attributes->get('is_missing_model', false) || ! $this->resourceExists()) {
-            throw new NotFoundHttpException('The requested resource does not exist on this server.');
+            throw new NotFoundHttpException(trans('exceptions.api.resource_not_found'));
         }
 
         return true;

app/Http/Requests/Api/Application/Users/GetExternalUserRequest.php

@@ -0,0 +1,56 @@
+<?php
+
+namespace Pterodactyl\Http\Requests\Api\Application\Users;
+
+use Pterodactyl\Models\User;
+use Pterodactyl\Services\Acl\Api\AdminAcl;
+use Pterodactyl\Contracts\Repository\UserRepositoryInterface;
+use Pterodactyl\Exceptions\Repository\RecordNotFoundException;
+use Pterodactyl\Http\Requests\Api\Application\ApplicationApiRequest;
+
+class GetExternalUserRequest extends ApplicationApiRequest
+{
+    /**
+     * @var User
+     */
+    private $userModel;
+
+    /**
+     * @var string
+     */
+    protected $resource = AdminAcl::RESOURCE_USERS;
+
+    /**
+     * @var int
+     */
+    protected $permission = AdminAcl::READ;
+
+    /**
+     * Determine if the requested external user exists.
+     *
+     * @return bool
+     */
+    public function resourceExists(): bool
+    {
+        $repository = $this->container->make(UserRepositoryInterface::class);
+
+        try {
+            $this->userModel = $repository->findFirstWhere([
+                ['external_id', '=', $this->route()->parameter('external_id')],
+            ]);
+        } catch (RecordNotFoundException $exception) {
+            return false;
+        }
+
+        return true;
+    }
+
+    /**
+     * Return the user model for the requested external user.
+     * @return \Pterodactyl\Models\User
+     */
+    public function getUserModel(): User
+    {
+        return $this->userModel;
+    }
+}

app/Models/User.php

@@ -105,11 +105,12 @@ class User extends Model implements
      * @var array
      */
     protected $searchableColumns = [
-        'email' => 10,
-        'username' => 9,
-        'name_first' => 6,
-        'name_last' => 6,
-        'uuid' => 1,
+        'username' => 100,
+        'email' => 100,
+        'external_id' => 80,
+        'uuid' => 80,
+        'name_first' => 40,
+        'name_last' => 40,
     ];
 
     /**

resources/lang/en/exceptions.php

@@ -60,4 +60,7 @@
         'no_viable_nodes' => 'No nodes satisfying the requirements specified for automatic deployment could be found.',
         'no_viable_allocations' => 'No allocations satisfying the requirements for automatic deployment were found.',
     ],
+    'api' => [
+        'resource_not_found' => 'The requested resource does not exist on this server.',
+    ],
 ];

routes/api-application.php

@@ -11,6 +11,7 @@
 Route::group(['prefix' => '/users'], function () {
     Route::get('/', 'Users\UserController@index')->name('api.application.users');
     Route::get('/{user}', 'Users\UserController@view')->name('api.application.users.view');
+    Route::get('/external/{external_id}', 'Users\ExternalUserController@index')->name('api.application.users.external');
 
     Route::post('/', 'Users\UserController@store');
     Route::patch('/{user}', 'Users\UserController@update');