ServerController - Code Metrics - Pterodactyl/Panel - Measure and Improve Code Quality continuously with Scrutinizer

ServerController B
last analyzed 2017-06-15 01:59 UTC

↳ Parent: Project

Complexity

Total Complexity

Size/Duplication

Total Lines	391
Duplicated Lines	13.3 %

Coupling/Cohesion

Components	1
Dependencies	9

Importance

Changes	1
Bugs	0	Features	0

Metric	Value
wmc	46
c	1
b	0
f	0
lcom	1
cbo	9
dl	52
loc	391
rs	8.3999

11 Methods

Rating	Name	Duplication	Size	Complexity
A	index()	16	16	3
A	view()	15	15	2
B	store()	0	36	6
B	delete()	0	27	4
B	details()	0	32	5
B	container()	0	32	5
A	install()	21	21	3
A	rebuild()	0	20	2
B	suspend()	0	34	5
B	build()	0	39	6
B	startup()	0	31	5

How to fix Duplicated Code Complexity

Duplicated Code

Duplicate code is one of the most pungent code smells. A rule that is often used is to re-structure code once it is duplicated in three or more places.

Common duplication problems, and corresponding solutions are:

If you have the same expression in different places: Extract expression to a method
If you have the same method in different sub-classes: Extract method, and pull up field to the parent class
If you have the same code in unrelated classes: Consider extracting the code to a new class, and injecting that class

Complex Class

Tip: Before tackling complexity, make sure that you eliminate any duplication first. This often can reduce the size of classes significantly.

Complex classes like ServerController often do a lot of different things. To break such a class down, we need to identify a cohesive component within that class. A common approach to find such a component is to look for fields/methods that share the same prefixes, or suffixes. You can also have a look at the cohesion graph to spot any un-connected, or weakly-connected components.

Once you have determined the fields that belong together, you can apply the Extract Class refactoring. If the component makes sense as a sub-class, Extract Subclass is also a candidate, and is often faster.

While breaking up the class, it is a good idea to analyze how other classes use ServerController, and based on these observations, apply Extract Interface, too.

<?php
/**
 * Pterodactyl - Panel
 * Copyright (c) 2015 - 2017 Dane Everitt <[email protected]>.
 *
 * 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\Admin;

use Log;
use Fractal;
use Illuminate\Http\Request;
use Pterodactyl\Models\Server;
use GuzzleHttp\Exception\TransferException;
use Pterodactyl\Exceptions\DisplayException;
use Pterodactyl\Http\Controllers\Controller;
use Pterodactyl\Repositories\ServerRepository;
use Pterodactyl\Transformers\Admin\ServerTransformer;
use Pterodactyl\Exceptions\DisplayValidationException;
use League\Fractal\Pagination\IlluminatePaginatorAdapter;

class ServerController extends Controller
{
    /**
     * Controller to handle returning all servers on the system.
     *
     * @param  \Illuminate\Http\Request  $request
     * @return array
     */
    public function index(Request $request)

    {
        $this->authorize('server-list', $request->apiKey());

        $servers = Server::paginate(config('pterodactyl.paginate.api.servers'));
        $fractal = Fractal::create()->collection($servers)
            ->transformWith(new ServerTransformer($request))
            ->withResourceName('user')
            ->paginateWith(new IlluminatePaginatorAdapter($servers));

        if (config('pterodactyl.api.include_on_list') && $request->input('include')) {
            $fractal->parseIncludes(explode(',', $request->input('include')));
        }

        return $fractal->toArray();
    }

    /**
     * Controller to handle returning information on a single server.
     *
     * @param  \Illuminate\Http\Request  $request
     * @param  int                       $id
     * @return array
     */
    public function view(Request $request, $id)

    {
        $this->authorize('server-view', $request->apiKey());

        $server = Server::findOrFail($id);
        $fractal = Fractal::create()->item($server);

        if ($request->input('include')) {
            $fractal->parseIncludes(explode(',', $request->input('include')));
        }

        return $fractal->transformWith(new ServerTransformer($request))
            ->withResourceName('server')
            ->toArray();
    }

    /**
     * Create a new server on the system.
     *
     * @param  \Illuminate\Http\Request  $request
     * @return \Illuminate\Http\JsonResponse|array
     */
    public function store(Request $request)
    {
        $this->authorize('server-create', $request->apiKey());

        $repo = new ServerRepository;
        try {
            $server = $repo->create($request->all());

            $fractal = Fractal::create()->item($server)->transformWith(new ServerTransformer($request));
            if ($request->input('include')) {
                $fractal->parseIncludes(explode(',', $request->input('include')));
            }

            return $fractal->withResourceName('server')->toArray();
        } catch (DisplayValidationException $ex) {
            return response()->json([
                'error' => json_decode($ex->getMessage()),
            ], 400);
        } catch (DisplayException $ex) {
            return response()->json([
                'error' => $ex->getMessage(),
            ], 400);
        } catch (TransferException $ex) {
            Log::warning($ex);

            return response()->json([
                'error' => 'A TransferException was encountered while trying to contact the daemon, please ensure it is online and accessible. This error has been logged.',
            ], 504);
        } catch (\Exception $ex) {
            Log::error($ex);

            return response()->json([
                'error' => 'An unhandled exception occured while attemping to add this server. Please try again.',
            ], 500);
        }
    }

    /**
     * Delete a server from the system.
     *
     * @param  \Illuminate\Http\Request  $request
     * @param  int                       $id
     * @return \Illuminate\Http\Response|\Illuminate\Http\JsonResponse
     */
    public function delete(Request $request, $id)
    {
        $this->authorize('server-delete', $request->apiKey());

        $repo = new ServerRepository;
        try {
            $repo->delete($id, $request->has('force_delete'));

            return response('', 204);
        } catch (DisplayException $ex) {
            return response()->json([
                'error' => $ex->getMessage(),
            ], 400);
        } catch (TransferException $ex) {
            Log::warning($ex);

            return response()->json([
                'error' => 'A TransferException was encountered while trying to contact the daemon, please ensure it is online and accessible. This error has been logged.',
            ], 504);
        } catch (\Exception $ex) {
            Log::error($ex);

            return response()->json([
                'error' => 'An unhandled exception occured while attemping to add this server. Please try again.',
            ], 500);
        }
    }

    /**
     * Update the details for a server.
     *
     * @param  \Illuminate\Http\Request  $request
     * @param  int                       $id
     * @return \Illuminate\Http\JsonResponse|array
     */
    public function details(Request $request, $id)
    {
        $this->authorize('server-edit-details', $request->apiKey());

        $repo = new ServerRepository;
        try {
            $server = $repo->updateDetails($id, $request->intersect([
                'owner_id', 'name', 'description', 'reset_token',
            ]));

            $fractal = Fractal::create()->item($server)->transformWith(new ServerTransformer($request));
            if ($request->input('include')) {
                $fractal->parseIncludes(explode(',', $request->input('include')));
            }

            return $fractal->withResourceName('server')->toArray();
        } catch (DisplayValidationException $ex) {
            return response()->json([
                'error' => json_decode($ex->getMessage()),
            ], 400);
        } catch (DisplayException $ex) {
            return response()->json([
                'error' => $ex->getMessage(),
            ], 400);
        } catch (\Exception $ex) {
            Log::error($ex);

            return response()->json([
                'error' => 'An unhandled exception occured while attemping to modify this server. Please try again.',
            ], 500);
        }
    }

    /**
     * Set the new docker container for a server.
     *
     * @param  \Illuminate\Http\Request  $request
     * @param  int                       $id
     * @return \Illuminate\Http\RedirectResponse|array
     */
    public function container(Request $request, $id)
    {
        $this->authorize('server-edit-container', $request->apiKey());

        $repo = new ServerRepository;
        try {
            $server = $repo->updateContainer($id, $request->intersect('docker_image'));

            $fractal = Fractal::create()->item($server)->transformWith(new ServerTransformer($request));
            if ($request->input('include')) {
                $fractal->parseIncludes(explode(',', $request->input('include')));
            }

            return $fractal->withResourceName('server')->toArray();
        } catch (DisplayValidationException $ex) {
            return response()->json([
class Author {
    private $name;

    public function __construct($name) {
        $this->name = $name;
    }

    public function getName() {
        return $this->name;
    }
}

abstract class Post {
    public function getAuthor() {
        return 'Johannes';
    }
}

class BlogPost extends Post {
    public function getAuthor() {
        return new Author('Johannes');
    }
}

class ForumPost extends Post { /* ... */ }

function my_function(Post $post) {
    echo strtoupper($post->getAuthor());
}
                'error' => json_decode($ex->getMessage()),
            ], 400);
        } catch (TransferException $ex) {
            Log::warning($ex);

            return response()->json([
class Author {
    private $name;

    public function __construct($name) {
        $this->name = $name;
    }

    public function getName() {
        return $this->name;
    }
}

abstract class Post {
    public function getAuthor() {
        return 'Johannes';
    }
}

class BlogPost extends Post {
    public function getAuthor() {
        return new Author('Johannes');
    }
}

class ForumPost extends Post { /* ... */ }

function my_function(Post $post) {
    echo strtoupper($post->getAuthor());
}
                'error' => 'A TransferException was encountered while trying to contact the daemon, please ensure it is online and accessible. This error has been logged.',
            ], 504);
        } catch (\Exception $ex) {
            Log::error($ex);

            return response()->json([
class Author {
    private $name;

    public function __construct($name) {
        $this->name = $name;
    }

    public function getName() {
        return $this->name;
    }
}

abstract class Post {
    public function getAuthor() {
        return 'Johannes';
    }
}

class BlogPost extends Post {
    public function getAuthor() {
        return new Author('Johannes');
    }
}

class ForumPost extends Post { /* ... */ }

function my_function(Post $post) {
    echo strtoupper($post->getAuthor());
}
                'error' => 'An unhandled exception occured while attemping to modify this server container. Please try again.',
            ], 500);
        }
    }

    /**
     * Toggles the install status for a server.
     *
     * @param  \Illuminate\Http\Request  $request
     * @param  int                       $id
     * @return \Illuminate\Http\Response|\Illuminate\Http\JsonResponse
     */
    public function install(Request $request, $id)

    {
        $this->authorize('server-install', $request->apiKey());

        $repo = new ServerRepository;
        try {
            $repo->toggleInstall($id);

            return response('', 204);
        } catch (DisplayException $ex) {
            return response()->json([
                'error' => $ex->getMessage(),
            ], 400);
        } catch (\Exception $ex) {
            Log::error($ex);

            return response()->json([
                'error' => 'An unhandled exception occured while attemping to toggle the install status for this server. Please try again.',
            ], 500);
        }
    }

    /**
     * Setup a server to have a container rebuild.
     *
     * @param  \Illuminate\Http\Request  $request
     * @param  int                       $id
     * @return \Illuminate\Http\Response|\Illuminate\Http\JsonResponse
     */
    public function rebuild(Request $request, $id)
    {
        $this->authorize('server-rebuild', $request->apiKey());
        $server = Server::with('node')->findOrFail($id);
class A
{
    public function foo() { }
}

class B extends A
{
    public function bar() { }
}

/**
 * @param A|B $x
 */
function someFunction($x)
{
    $x->foo(); // This call is fine as the method exists in A and B.
    $x->bar(); // This method only exists in B and might cause an error.
}

        try {
            $server->node->guzzleClient([
                'X-Access-Server' => $server->uuid,
                'X-Access-Token' => $server->node->daemonSecret,
            ])->request('POST', '/server/rebuild');

            return response('', 204);
        } catch (TransferException $ex) {
            Log::warning($ex);

            return response()->json([
                'error' => 'A TransferException was encountered while trying to contact the daemon, please ensure it is online and accessible. This error has been logged.',
            ], 504);
        }
    }

    /**
     * Manage the suspension status for a server.
     *
     * @param  \Illuminate\Http\Request  $request
     * @param  int                       $id
     * @return \Illuminate\Http\Response|\Illuminate\Http\JsonResponse
     */
    public function suspend(Request $request, $id)
    {
        $this->authorize('server-suspend', $request->apiKey());

        $repo = new ServerRepository;
        $action = $request->input('action');
        if (! in_array($action, ['suspend', 'unsuspend'])) {
            return response()->json([
                'error' => 'The action provided was invalid. Action should be one of: suspend, unsuspend.',
            ], 400);
        }

        try {
            $repo->toggleAccess($id, ($action === 'unsuspend'));

            return response('', 204);
        } catch (DisplayException $ex) {
            return response()->json([
                'error' => $ex->getMessage(),
            ], 400);
        } catch (TransferException $ex) {
            Log::warning($ex);

            return response()->json([
                'error' => 'A TransferException was encountered while trying to contact the daemon, please ensure it is online and accessible. This error has been logged.',
            ], 504);
        } catch (\Exception $ex) {
            Log::error($ex);

            return response()->json([
                'error' => 'An unhandled exception occured while attemping to ' . $action . ' this server. Please try again.',
            ], 500);
        }
    }

    /**
     * Update the build configuration for a server.
     *
     * @param  \Illuminate\Http\Request  $request
     * @param  int                       $id
     * @return \Illuminate\Http\JsonResponse|array
     */
    public function build(Request $request, $id)
    {
        $this->authorize('server-edit-build', $request->apiKey());

        $repo = new ServerRepository;
        try {
            $server = $repo->changeBuild($id, $request->intersect([
                'allocation_id', 'add_allocations', 'remove_allocations',
                'memory', 'swap', 'io', 'cpu',
            ]));

            $fractal = Fractal::create()->item($server)->transformWith(new ServerTransformer($request));
            if ($request->input('include')) {
                $fractal->parseIncludes(explode(',', $request->input('include')));
            }

            return $fractal->withResourceName('server')->toArray();
        } catch (DisplayValidationException $ex) {
            return response()->json([
                'error' => json_decode($ex->getMessage()),
            ], 400);
        } catch (DisplayException $ex) {
            return response()->json([
                'error' => $ex->getMessage(),
            ], 400);
        } catch (TransferException $ex) {
            Log::warning($ex);

            return response()->json([
                'error' => 'A TransferException was encountered while trying to contact the daemon, please ensure it is online and accessible. This error has been logged.',
            ], 504);
        } catch (\Exception $ex) {
            Log::error($ex);

            return response()->json([
                'error' => 'An unhandled exception occured while attemping to modify the build settings for this server. Please try again.',
            ], 500);
        }
    }

    /**
     * Update the startup command as well as variables.
     *
     * @param  \Illuminate\Http\Request  $request
     * @param  int                       $id
     * @return \Illuminate\Http\Response|\Illuminate\Http\JsonResponse
     */
    public function startup(Request $request, $id)
    {
        $this->authorize('server-edit-startup', $request->apiKey());

        $repo = new ServerRepository;
        try {
            $repo->updateStartup($id, $request->all(), true);

            return response('', 204);
        } catch (DisplayValidationException $ex) {
            return response()->json([
                'error' => json_decode($ex->getMessage()),
            ], 400);
        } catch (DisplayException $ex) {
            return response()->json([
                'error' => $ex->getMessage(),
            ], 400);
        } catch (TransferException $ex) {
            Log::warning($ex);

            return response()->json([
                'error' => 'A TransferException was encountered while trying to contact the daemon, please ensure it is online and accessible. This error has been logged.',
            ], 504);
        } catch (\Exception $ex) {
            Log::error($ex);

            return response()->json([
                'error' => 'An unhandled exception occured while attemping to modify the startup settings for this server. Please try again.',
            ], 500);
        }
    }
}


GitHub Access Token became invalid

ServerController B
last analyzed 2017-06-15 01:59 UTC

Complexity

Size/Duplication

Coupling/Cohesion

Importance

11 Methods

How to fix Duplicated Code Complexity

Duplicated Code

Complex Class

Available Fixes

Pterodactyl / Panel

GitHub Access Token became invalid

ServerController B last analyzed 2017-06-15 01:59 UTC

Complexity

Size/Duplication

Coupling/Cohesion

Importance

11 Methods

How to fix Duplicated Code Complexity

Duplicated Code

Complex Class

Available Fixes

Duplication Side-by-Side

Filter issues like

ServerController B
last analyzed 2017-06-15 01:59 UTC