Pterodactyl\Http\Controllers\API\UserController

Complexity

Total Complexity

19

Size/Duplication

Total Lines	164
Duplicated Lines	22.56 %

Coupling/Cohesion

Components	1
Dependencies	9

Importance

Changes	2
Bugs	0	Features	0

6 Methods

Rating	Name	Duplication	Size	Complexity
A	delete()	12	13	3
A	__construct()	0	3	1
A	lists()	0	4	1
B	view()	6	24	6
A	create()	0	20	4
A	update()	19	19	4

<?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\Http\Controllers\API;

use Pterodactyl\Models;
use Illuminate\Http\Request;
use Dingo\Api\Exception\ResourceException;
use Pterodactyl\Exceptions\DisplayException;
use Pterodactyl\Repositories\UserRepository;
use Pterodactyl\Exceptions\DisplayValidationException;
use Symfony\Component\HttpKernel\Exception\NotFoundHttpException;
use Symfony\Component\HttpKernel\Exception\ServiceUnavailableHttpException;

/**
 * @Resource("Users")
 */
class UserController extends BaseController
{
    public function __construct()
    {
    }

    /**
     * List All Users.
     *
     * Lists all users currently on the system.
     *
     * @Get("/users/{?page}")
     * @Versions({"v1"})
     * @Parameters({
     *      @Parameter("page", type="integer", description="The page of results to view.", default=1)
     * })
     * @Response(200)
     */
    public function lists(Request $request)

The parameter $request is not used and could be removed.

    {
        return Models\User::all()->toArray();
    }

    /**
     * List Specific User.
     *
     * Lists specific fields about a user or all fields pertaining to that user.
     *
     * @Get("/users/{id}/{fields}")
     * @Versions({"v1"})
     * @Parameters({
     *      @Parameter("id", type="integer", required=true, description="The ID of the user to get information on."),
     *      @Parameter("fields", type="string", required=false, description="A comma delimidated list of fields to include.")
     * })
     * @Response(200)
     */
    public function view(Request $request, $id)
    {
        $user = Models\User::with('servers')->where((is_numeric($id) ? 'id' : 'email'), $id)->first();

The method where does only exist in Illuminate\Database\Eloquent\Builder, but not in Illuminate\Database\Eloquent\Model.

        if (! $user->first()) {
            throw new NotFoundHttpException('No user by that ID was found.');
        }

        $user->servers->transform(function ($item) {
            return collect($item)->only([
                'id', 'node_id', 'uuidShort',
                'uuid', 'name', 'suspended',
                'owner_id',
            ]);
        });

        if (! is_null($request->input('fields'))) {

This code seems to be duplicated across your project.

            $fields = explode(',', $request->input('fields'));
            if (! empty($fields) && is_array($fields)) {
                return collect($user)->only($fields);
            }
        }

        return $user->toArray();
    }

    /**
     * Create a New User.
     *
     * @Post("/users")
     * @Versions({"v1"})
     * @Transaction({
     *      @Request({
     *          "email": "foo@example.com",
     *          "password": "foopassword",
     *          "admin": false,
     *          "custom_id": 123
     *       }, headers={"Authorization": "Bearer <token>"}),
     *       @Response(201),
     *       @Response(422)
     * })
     */
    public function create(Request $request)
    {
        try {
            $user = new UserRepository;
            $create = $user->create($request->only([
                'email', 'username', 'name_first',
                'name_last', 'password',
                'root_admin', 'custom_id',
            ]));
            $create = $user->create($request->input('email'), $request->input('password'), $request->input('admin'), $request->input('custom_id'));

It seems like $request->input('email') targeting Illuminate\Http\Request::input() can also be of type string; however, Pterodactyl\Repositories\UserRepository::create() does only seem to accept array, maybe add an additional type check?

The call to UserRepository::create() has too many arguments starting with $request->input('password').

            return ['id' => $create];
        } catch (DisplayValidationException $ex) {
            throw new ResourceException('A validation error occured.', json_decode($ex->getMessage(), true));
        } catch (DisplayException $ex) {
            throw new ResourceException($ex->getMessage());
        } catch (\Exception $ex) {
            throw new ServiceUnavailableHttpException('Unable to create a user on the system due to an error.');
        }
    }

    /**
     * Update an Existing User.
     *
     * The data sent in the request will be used to update the existing user on the system.
     *
     * @Patch("/users/{id}")
     * @Versions({"v1"})
     * @Transaction({
     *      @Request({
     *          "email": "new@email.com"
     *      }, headers={"Authorization": "Bearer <token>"}),
     *      @Response(200, body={"email": "new@email.com"}),
     *      @Response(422)
     * })
     * @Parameters({
     *         @Parameter("id", type="integer", required=true, description="The ID of the user to modify.")
     * })
     */
    public function update(Request $request, $id)

This method seems to be duplicated in your project.

    {
        try {
            $user = new UserRepository;
            $user->update($id, $request->only([
                'username', 'email', 'name_first',
                'name_last', 'password',
                'root_admin', 'language',
            ]));

            return Models\User::findOrFail($id);
        } catch (DisplayValidationException $ex) {
            throw new ResourceException('A validation error occured.', json_decode($ex->getMessage(), true));
        } catch (DisplayException $ex) {
            throw new ResourceException($ex->getMessage());
        } catch (\Exception $ex) {
            throw new ServiceUnavailableHttpException('Unable to update a user on the system due to an error.');
        }
    }

    /**
     * Delete a User.
     *
     * @Delete("/users/{id}")
     * @Versions({"v1"})
     * @Transaction({
     *      @Request(headers={"Authorization": "Bearer <token>"}),
     *      @Response(204),
     *      @Response(422)
     * })
     * @Parameters({
     *      @Parameter("id", type="integer", required=true, description="The ID of the user to delete.")
     * })
     */
    public function delete(Request $request, $id)

The parameter $request is not used and could be removed.

This method seems to be duplicated in your project.

    {
        try {
            $user = new UserRepository;
            $user->delete($id);

            return $this->response->noContent();
        } catch (DisplayException $ex) {
            throw new ResourceException($ex->getMessage());
        } catch (\Exception $ex) {
            throw new ServiceUnavailableHttpException('Unable to delete this user due to an error.');
        }
    }
}