ServerController - Code Metrics - Inspection of "Add console popout option." - Pterodactyl/Panel - Measure and Improve Code Quality continuously with Scrutinizer

Completed

Push — develop ( eeeb4b...f58858 )

by Dane

created 2017-04-15 22:23 UTC

ServerController A

↳ Parent: Project

Complexity

Total Complexity

Size/Duplication

Total Lines	333
Duplicated Lines	23.42 %

Coupling/Cohesion

Components	1
Dependencies	10

Importance

Changes

Metric	Value
wmc	24
lcom	1
cbo	10
dl	78
loc	333
rs	10
c	0
b	0
f	0

12 Methods

Rating	Name	Duplication	Size	Complexity
A	getIndex()	0	20	1
A	getConsole()	0	17	1
B	getFiles()	0	26	1
A	getAddFile()	13	13	2
B	getEditFile()	0	34	4
A	getDownloadFile()	0	15	1
A	getAllocation()	0	14	1
B	getStartup()	0	29	3
A	getDatabases()	14	14	1
A	getSFTP()	11	11	1
A	postSettingsSFTP()	20	20	4
A	postSettingsStartup()	20	20	4

How to fix Duplicated Code

<?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\Server;

use Log;
use Uuid;
use Alert;
use Pterodactyl\Models;
use Illuminate\Http\Request;
use Pterodactyl\Exceptions\DisplayException;
use Pterodactyl\Http\Controllers\Controller;
use Pterodactyl\Repositories\ServerRepository;
use Pterodactyl\Repositories\Daemon\FileRepository;
use Pterodactyl\Exceptions\DisplayValidationException;

class ServerController extends Controller
{
    /**
     * Renders server index page for specified server.
     *
     * @param  \Illuminate\Http\Request  $request
     * @param  string                    $uuid
     * @return \Illuminate\View\View
     */
    public function getIndex(Request $request, $uuid)

    {
        $server = Models\Server::byUuid($uuid);

        $server->js([
            'meta' => [
                'saveFile' => route('server.files.save', $server->uuidShort),
                'csrfToken' => csrf_token(),
            ],
            'config' => [
                'console_count' => config('pterodactyl.console.count'),
                'console_freq' => config('pterodactyl.console.freq'),
            ],
        ]);

        return view('server.index', [

            'server' => $server,
            'node' => $server->node,
        ]);
    }

    /**
     * Renders server console as an individual item.
     *
     * @param  \Illuminate\Http\Request  $request
     * @param  string                    $uuid
     * @return \Illuminate\View\View
     */
    public function getConsole(Request $request, $uuid)

    {
        \Debugbar::disable();
        $server = Models\Server::byUuid($uuid);

        $server->js([
            'config' => [
                'console_count' => config('pterodactyl.console.count'),
                'console_freq' => config('pterodactyl.console.freq'),
            ],
        ]);

        return view('server.console', [

            'server' => $server,
            'node' => $server->node,
        ]);
    }

    /**
     * Renders file overview page.
     *
     * @param  \Illuminate\Http\Request  $request
     * @param  string                    $uuid
     * @return \Illuminate\View\View
     */
    public function getFiles(Request $request, $uuid)
    {
        $server = Models\Server::byUuid($uuid);
        $this->authorize('list-files', $server);

        $server->js([
            'meta' => [
                'directoryList' => route('server.files.directory-list', $server->uuidShort),
                'csrftoken' => csrf_token(),
            ],
            'permissions' => [
                'moveFiles' => $request->user()->can('move-files', $server),
                'copyFiles' => $request->user()->can('copy-files', $server),
                'compressFiles' => $request->user()->can('compress-files', $server),
                'decompressFiles' => $request->user()->can('decompress-files', $server),
                'createFiles' => $request->user()->can('create-files', $server),
                'downloadFiles' => $request->user()->can('download-files', $server),
                'deleteFiles' => $request->user()->can('delete-files', $server),
            ],
        ]);

        return view('server.files.index', [

            'server' => $server,
            'node' => $server->node,
        ]);
    }

    /**
     * Renders add file page.
     *
     * @param  \Illuminate\Http\Request  $request
     * @param  string                    $uuid
     * @return \Illuminate\View\View
     */
    public function getAddFile(Request $request, $uuid)

    {
        $server = Models\Server::byUuid($uuid);
        $this->authorize('create-files', $server);

        $server->js();

        return view('server.files.add', [

            'server' => $server,
            'node' => $server->node,
            'directory' => (in_array($request->get('dir'), [null, '/', ''])) ? '' : trim($request->get('dir'), '/') . '/',
        ]);
    }

    /**
     * Renders edit file page for a given file.
     *
     * @param  \Illuminate\Http\Request  $request
     * @param  string                    $uuid
     * @param  string                    $file
     * @return \Illuminate\View\View
     */
    public function getEditFile(Request $request, $uuid, $file)

    {
        $server = Models\Server::byUuid($uuid);
        $this->authorize('edit-files', $server);

        $fileInfo = (object) pathinfo($file);
        $controller = new FileRepository($uuid);

        try {
            $fileContent = $controller->returnFileContents($file);
        } catch (DisplayException $ex) {
            Alert::danger($ex->getMessage())->flash();

            return redirect()->route('server.files.index', $uuid);
function acceptsInteger($int) { }

$x = '123'; // string "123"

// Instead of
acceptsInteger($x);

// we recommend to use
acceptsInteger((integer) $x);
        } catch (\Exception $ex) {
            Log::error($ex);
            Alert::danger('An error occured while attempting to load the requested file for editing, please try again.')->flash();

            return redirect()->route('server.files.index', $uuid);
function acceptsInteger($int) { }

$x = '123'; // string "123"

// Instead of
acceptsInteger($x);

// we recommend to use
acceptsInteger((integer) $x);
        }

        $server->js([
            'stat' => $fileContent['stat'],
        ]);

        return view('server.files.edit', [

            'server' => $server,
            'node' => $server->node,
            'file' => $file,
            'stat' => $fileContent['stat'],
            'contents' => $fileContent['file']->content,
            'directory' => (in_array($fileInfo->dirname, ['.', './', '/'])) ? '/' : trim($fileInfo->dirname, '/') . '/',
        ]);
    }

    /**
     * Handles downloading a file for the user.
     *
     * @param  \Illuminate\Http\Request  $request
     * @param  string                    $uuid
     * @param  string                    $file
     * @return \Illuminate\View\View
     */
    public function getDownloadFile(Request $request, $uuid, $file)

    {
        $server = Models\Server::byUuid($uuid);
        $this->authorize('download-files', $server);

        $download = new Models\Download;

        $download->token = (string) Uuid::generate(4);
        $download->server = $server->uuid;
        $download->path = $file;

        $download->save();

        return redirect($server->node->scheme . '://' . $server->node->fqdn . ':' . $server->node->daemonListen . '/server/file/download/' . $download->token);
    }

    /**
     * Returns the allocation overview for a server.
     *
     * @param  \Illuminate\Http\Request  $request
     * @param  string                    $uuid
     * @return \Illuminate\View\View
     */
    public function getAllocation(Request $request, $uuid)

    {
        $server = Models\Server::byUuid($uuid);
        $this->authorize('view-allocation', $server);
        $server->js();

        return view('server.settings.allocation', [

            'server' => $server->load(['allocations' => function ($query) {
                $query->orderBy('ip', 'asc');
                $query->orderBy('port', 'asc');
            }]),
            'node' => $server->node,
        ]);
    }

    /**
     * Returns the startup overview for a server.
     *
     * @param  \Illuminate\Http\Request  $request
     * @param  string                    $uuid
     * @return \Illuminate\View\View
     */
    public function getStartup(Request $request, $uuid)

    {
        $server = Models\Server::byUuid($uuid);
        $server->load(['node', 'allocation', 'variables.variable']);

        $this->authorize('view-startup', $server);

        $replacements = [
            '{{SERVER_MEMORY}}' => $server->memory,
            '{{SERVER_IP}}' => $server->allocation->ip,
            '{{SERVER_PORT}}' => $server->allocation->port,
        ];

        $processed = str_replace(array_keys($replacements), array_values($replacements), $server->startup);
        foreach ($server->variables as $v) {
            $replace = ($v->user_can_view) ? $v->variable_value : '[hidden]';
            $processed = str_replace('{{' . $v->variable->env_variable . '}}', $replace, $processed);
        }

        $server->js();

        return view('server.settings.startup', [

            'server' => $server,
            'node' => $server->node,
            'variables' => $server->variables->where('user_can_view', true),
            'service' => $server->service,
            'processedStartup' => $processed,
        ]);
    }

    /**
     * Returns the database overview for a server.
     *
     * @param  \Illuminate\Http\Request  $request
     * @param  string                    $uuid
     * @return \Illuminate\View\View
     */
    public function getDatabases(Request $request, $uuid)

    {
        $server = Models\Server::byUuid($uuid);
        $this->authorize('view-databases', $server);

        $server->load('node', 'databases.host');
        $server->js();

        return view('server.settings.databases', [

            'server' => $server,
            'node' => $server->node,
            'databases' => $server->databases,
        ]);
    }

    /**
     * Returns the SFTP overview for a server.
     *
     * @param  \Illuminate\Http\Request  $request
     * @param  string                    $uuid
     * @return \Illuminate\View\View
     */
    public function getSFTP(Request $request, $uuid)

    {
        $server = Models\Server::byUuid($uuid);
        $this->authorize('view-sftp', $server);
        $server->js();

        return view('server.settings.sftp', [

            'server' => $server,
            'node' => $server->node,
        ]);
    }

    /**
     * Handles changing the SFTP password for a server.
     *
     * @param  \Illuminate\Http\Request  $request
     * @param  string                    $uuid
     * @return \Illuminate\Http\RedirectResponse
     */
    public function postSettingsSFTP(Request $request, $uuid)

    {
        $server = Models\Server::byUuid($uuid);
        $this->authorize('reset-sftp', $server);

        try {
            $repo = new ServerRepository;
            $repo->updateSFTPPassword($server->id, $request->input('sftp_pass'));

            Alert::success('Successfully updated this servers SFTP password.')->flash();
        } catch (DisplayValidationException $ex) {
            return redirect()->route('server.settings.sftp', $uuid)->withErrors(json_decode($ex->getMessage()));
function acceptsInteger($int) { }

$x = '123'; // string "123"

// Instead of
acceptsInteger($x);

// we recommend to use
acceptsInteger((integer) $x);
        } catch (DisplayException $ex) {
            Alert::danger($ex->getMessage())->flash();
        } catch (\Exception $ex) {
            Log::error($ex);
            Alert::danger('An unknown error occured while attempting to update this server\'s SFTP settings.')->flash();
        }

        return redirect()->route('server.settings.sftp', $uuid);
function acceptsInteger($int) { }

$x = '123'; // string "123"

// Instead of
acceptsInteger($x);

// we recommend to use
acceptsInteger((integer) $x);
    }

    /**
     * Handles changing the startup settings for a server.
     *
     * @param  \Illuminate\Http\Request  $request
     * @param  string                    $uuid
     * @return \Illuminate\Http\RedirectResponse
     */
    public function postSettingsStartup(Request $request, $uuid)

    {
        $server = Models\Server::byUuid($uuid);
        $this->authorize('edit-startup', $server);

        try {
            $repo = new ServerRepository;
            $repo->updateStartup($server->id, $request->except('_token'));
            Alert::success('Server startup variables were successfully updated.')->flash();
        } catch (DisplayValidationException $ex) {
            return redirect()->route('server.settings.startup', $uuid)->withErrors(json_decode($ex->getMessage()));
function acceptsInteger($int) { }

$x = '123'; // string "123"

// Instead of
acceptsInteger($x);

// we recommend to use
acceptsInteger((integer) $x);
        } catch (DisplayException $ex) {
            Alert::danger($ex->getMessage())->flash();
        } catch (\Exception $ex) {
            Log::error($ex);
            Alert::danger('An unhandled exception occured while attemping to update startup variables for this server. Please try again.')->flash();
        }

        return redirect()->route('server.settings.startup', $uuid);
function acceptsInteger($int) { }

$x = '123'; // string "123"

// Instead of
acceptsInteger($x);

// we recommend to use
acceptsInteger((integer) $x);
    }
}


1			<?php
2			/**
3			* Pterodactyl - Panel
4			* Copyright (c) 2015 - 2017 Dane Everitt <[email protected]>.
5			*
6			* Permission is hereby granted, free of charge, to any person obtaining a copy
7			* of this software and associated documentation files (the "Software"), to deal
8			* in the Software without restriction, including without limitation the rights
9			* to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
10			* copies of the Software, and to permit persons to whom the Software is
11			* furnished to do so, subject to the following conditions:
12			*
13			* The above copyright notice and this permission notice shall be included in all
14			* copies or substantial portions of the Software.
15			*
16			* THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
17			* IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
18			* FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
19			* AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
20			* LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
21			* OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
22			* SOFTWARE.
23			*/
24
25			namespace Pterodactyl\Http\Controllers\Server;
26
27			use Log;
28			use Uuid;
29			use Alert;
30			use Pterodactyl\Models;
31			use Illuminate\Http\Request;
32			use Pterodactyl\Exceptions\DisplayException;
33			use Pterodactyl\Http\Controllers\Controller;
34			use Pterodactyl\Repositories\ServerRepository;
35			use Pterodactyl\Repositories\Daemon\FileRepository;
36			use Pterodactyl\Exceptions\DisplayValidationException;
37
38			class ServerController extends Controller
39			{
40			/**

Pterodactyl / Panel

GitHub Access Token became invalid

Push — develop ( eeeb4b...f58858 )

ServerController A

Complexity

Size/Duplication

Coupling/Cohesion

Importance

12 Methods

How to fix Duplicated Code

Duplicated Code

Duplication Side-by-Side

Filter issues like