DatabaseController::index() - Code Metrics - Inspection of "Add database host management to panel." - Pterodactyl/Panel - Measure and Improve Code Quality continuously with Scrutinizer

Completed

Push — develop ( 05d2a6...198a02 )

by Dane

created 2017-03-16 23:35 UTC

DatabaseController::index() A

↳ Parent: DatabaseController

Complexity

Conditions	1
Paths	1

Size

Total Lines	7
Code Lines	4

Duplication

Lines	0
Ratio	0 %

Importance

Changes

Metric	Value
dl	0
loc	7
rs	9.4285
c	0
b	0
f	0
cc	1
eloc	4
nc	1
nop	1

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

use Log;
use Alert;
use Illuminate\Http\Request;
use Pterodactyl\Models\Database;
use Pterodactyl\Models\Location;
use Pterodactyl\Models\DatabaseHost;
use Pterodactyl\Exceptions\DisplayException;
use Pterodactyl\Http\Controllers\Controller;
use Pterodactyl\Repositories\DatabaseRepository;
use Pterodactyl\Exceptions\DisplayValidationException;

class DatabaseController extends Controller
{
    /**
     * Display database host index.
     *
     * @param  Request $request
     * @return \Illuminate\View\View
     */
    public function index(Request $request)

    {
        return view('admin.databases.index', [

            'locations' => Location::with('nodes')->get(),
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.
}
            'hosts' => DatabaseHost::withCount('databases')->with('node')->get(),
        ]);
    }

    /**
     * Display database host to user.
     *
     * @param  Request $request
     * @param  int     $id
     * @return \Illuminate\View\View
     */
    public function view(Request $request, $id)

    {
        return view('admin.databases.view', [

            'locations' => Location::with('nodes')->get(),
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.
}
            'host' => DatabaseHost::with('databases.server')->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.
}
        ]);
    }

    /**
     * Handle post request to create database host.
     *
     * @param  Request $request
     * @return \Illuminate\Response\RedirectResponse
     */
    public function create(Request $request)

    {
        $repo = new DatabaseRepository;

        try {
            $host = $repo->add($request->intersect([
                'name', 'username', 'password',
                'host', 'port', 'node_id',
            ]));
            Alert::success('Successfully created new database host on the system.')->flash();

            return redirect()->route('admin.databases.view', $host->id);
<?php

/**
 * @property int $x
 * @property int $y
 * @property string $text
 */
class MyLabel
{
    private $properties;

    private $allowedProperties = array('x', 'y', 'text');

    public function __get($name)
    {
        if (isset($properties[$name]) && in_array($name, $this->allowedProperties)) {
            return $properties[$name];
        } else {
            return null;
        }
    }

    public function __set($name, $value)
    {
        if (in_array($name, $this->allowedProperties)) {
            $properties[$name] = $value;
        } else {
            throw new \LogicException("Property $name is not defined.");
        }
    }

}
        } catch (\PDOException $ex) {
            Alert::danger($ex->getMessage())->flash();
        } catch (DisplayValidationException $ex) {
            return redirect()->route('admin.databases')->withErrors(json_decode($ex->getMessage()));
        } catch (\Exception $ex) {
            Log::error($ex);
            Alert::danger('An error was encountered while trying to process this request. This error has been logged.')->flash();
        }

        return redirect()->route('admin.databases');
    }

    /**
     * Handle post request to update a database host.
     *
     * @param  Request $request
     * @param  int     $id
     * @return \Illuminate\Response\RedirectResponse
     */
    public function update(Request $request, $id)

    {
        $repo = new DatabaseRepository;

        try {
            if ($request->input('action') !== 'delete') {
                $host = $repo->update($id, $request->intersect([
$myVar = 'Value';
$higher = false;

if (rand(1, 6) > 3) {
    $higher = true;
} else {
    $higher = false;
}
                    'name', 'username', 'password',
                    'host', 'port', 'node_id',
                ]));
                Alert::success('Database host was updated successfully.')->flash();
            } else {
                $repo->delete($id);

                return redirect()->route('admin.databases');
            }
        } catch (\PDOException $ex) {
            Alert::danger($ex->getMessage())->flash();
        } catch (DisplayException $ex) {
            Alert::danger($ex->getMessage())->flash();
        } catch (DisplayValidationException $ex) {
            return redirect()->route('admin.databases.view', $id)->withErrors(json_decode($ex->getMessage()));
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 was encountered while trying to process this request. This error has been logged.')->flash();
        }

        return redirect()->route('admin.databases.view', $id);
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\Admin;
26
27		use Log;
28		use Alert;
29		use Illuminate\Http\Request;
30		use Pterodactyl\Models\Database;
31		use Pterodactyl\Models\Location;
32		use Pterodactyl\Models\DatabaseHost;
33		use Pterodactyl\Exceptions\DisplayException;
34		use Pterodactyl\Http\Controllers\Controller;
35		use Pterodactyl\Repositories\DatabaseRepository;
36		use Pterodactyl\Exceptions\DisplayValidationException;
37
38		class DatabaseController extends Controller
39		{
40		/**
41		* Display database host index.
42		*
43		* @param Request $request
44		* @return \Illuminate\View\View
45		*/
46		public function index(Request $request)
		0 ignored issues – show Unused Code introduced 2016-12-07 22:58 UTC by Report Bug Copy Issue Report The parameter `$request` is not used and could be removed. This check looks from parameters that have been defined for a function or method, but which are not used in the method body. Loading history...
47		{
48		return view('admin.databases.index', [
		0 ignored issues – show Bug Compatibility introduced 2017-03-16 23:38 UTC by Report Bug Copy Issue Report The expression `view('admin.databases.in...>with('node')->get()));` of type `Illuminate\View\View\|Ill...\Contracts\View\Factory` adds the type `Illuminate\Contracts\View\Factory` to the return on line 48 which is incompatible with the return type documented by `Pterodactyl\Http\Control...tabaseController::index` of type `Illuminate\View\View`. Loading history...
49		'locations' => Location::with('nodes')->get(),
		0 ignored issues – show Bug introduced 2017-03-16 23:38 UTC by Report Bug Copy Issue Report The method `get` does only exist in `Illuminate\Database\Eloquent\Builder`, but not in `Illuminate\Database\Eloquent\Model`. It seems like the method you are trying to call exists only in some of the possible types. Let’s take a look at an example: 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. } Available Fixes Add an additional type-check: /* * @param A\|B $x / function someFunction($x) { $x->foo(); if ($x instanceof B) { $x->bar(); } } Only allow a single type to be passed if the variable comes from a parameter: function someFunction(B $x) { /* ... */ } Loading history...
50		'hosts' => DatabaseHost::withCount('databases')->with('node')->get(),
51		]);
52		}
53
54		/**
55		* Display database host to user.
56		*
57		* @param Request $request
58		* @param int $id
59		* @return \Illuminate\View\View
60		*/
61		public function view(Request $request, $id)
		0 ignored issues – show Unused Code introduced 2017-03-16 23:38 UTC by Report Bug Copy Issue Report The parameter `$request` is not used and could be removed. This check looks from parameters that have been defined for a function or method, but which are not used in the method body. Loading history...
62		{
63		return view('admin.databases.view', [
		0 ignored issues – show Bug Compatibility introduced 2017-03-16 23:38 UTC by Report Bug Copy Issue Report The expression `view('admin.databases.vi...r')->findOrFail($id)));` of type `Illuminate\View\View\|Ill...\Contracts\View\Factory` adds the type `Illuminate\Contracts\View\Factory` to the return on line 63 which is incompatible with the return type documented by `Pterodactyl\Http\Control...atabaseController::view` of type `Illuminate\View\View`. Loading history...
64		'locations' => Location::with('nodes')->get(),
		0 ignored issues – show Bug introduced 2017-03-16 23:38 UTC by Report Bug Copy Issue Report The method `get` does only exist in `Illuminate\Database\Eloquent\Builder`, but not in `Illuminate\Database\Eloquent\Model`. It seems like the method you are trying to call exists only in some of the possible types. Let’s take a look at an example: 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. } Available Fixes Add an additional type-check: /* * @param A\|B $x / function someFunction($x) { $x->foo(); if ($x instanceof B) { $x->bar(); } } Only allow a single type to be passed if the variable comes from a parameter: function someFunction(B $x) { /* ... */ } Loading history...
65		'host' => DatabaseHost::with('databases.server')->findOrFail($id),
		0 ignored issues – show Bug introduced 2017-03-16 23:38 UTC by Report Bug Copy Issue Report The method `findOrFail` does only exist in `Illuminate\Database\Eloquent\Builder`, but not in `Illuminate\Database\Eloquent\Model`. It seems like the method you are trying to call exists only in some of the possible types. Let’s take a look at an example: 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. } Available Fixes Add an additional type-check: /* * @param A\|B $x / function someFunction($x) { $x->foo(); if ($x instanceof B) { $x->bar(); } } Only allow a single type to be passed if the variable comes from a parameter: function someFunction(B $x) { /* ... */ } Loading history...
66		]);
67		}
68
69		/**
70		* Handle post request to create database host.
71		*
72		* @param Request $request
73		* @return \Illuminate\Response\RedirectResponse
74		*/
75	View Code Duplication	public function create(Request $request)
		0 ignored issues – show Duplication introduced 2017-03-16 23:38 UTC by Report Bug Copy Issue Report This method seems to be duplicated in your project. Duplicated code is one of the most pungent code smells. If you need to duplicate the same code in three or more different places, we strongly encourage you to look into extracting the code into a single class or operation. You can also find more detailed suggestions in the “Code” section of your repository. Loading history...
76		{
77		$repo = new DatabaseRepository;
78
79		try {
80		$host = $repo->add($request->intersect([
81		'name', 'username', 'password',
82		'host', 'port', 'node_id',
83		]));
84		Alert::success('Successfully created new database host on the system.')->flash();
85
86		return redirect()->route('admin.databases.view', $host->id);
		0 ignored issues – show Documentation introduced 2017-03-16 23:38 UTC by Report Bug Copy Issue Report The property `id` does not exist on `object<Pterodactyl\Models\DatabaseHost>`. Since you implemented `__get`, maybe consider adding a @property annotation. Since your code implements the magic getter `_get`, this function will be called for any read access on an undefined variable. You can add the `@property` annotation to your class or interface to document the existence of this variable. <?php /** * @property int $x * @property int $y * @property string $text */ class MyLabel { private $properties; private $allowedProperties = array('x', 'y', 'text'); public function __get($name) { if (isset($properties[$name]) && in_array($name, $this->allowedProperties)) { return $properties[$name]; } else { return null; } } public function __set($name, $value) { if (in_array($name, $this->allowedProperties)) { $properties[$name] = $value; } else { throw new \LogicException("Property $name is not defined."); } } } If the property has read access only, you can use the @property-read annotation instead. Of course, you may also just have mistyped another name, in which case you should fix the error. See also the PhpDoc documentation for @property. Loading history...
87		} catch (\PDOException $ex) {
88		Alert::danger($ex->getMessage())->flash();
89		} catch (DisplayValidationException $ex) {
90		return redirect()->route('admin.databases')->withErrors(json_decode($ex->getMessage()));
91		} catch (\Exception $ex) {
92		Log::error($ex);
93		Alert::danger('An error was encountered while trying to process this request. This error has been logged.')->flash();
94		}
95
96		return redirect()->route('admin.databases');
97		}
98
99		/**
100		* Handle post request to update a database host.
101		*
102		* @param Request $request
103		* @param int $id
104		* @return \Illuminate\Response\RedirectResponse
105		*/
106	View Code Duplication	public function update(Request $request, $id)
		0 ignored issues – show Duplication introduced 2017-03-16 23:38 UTC by Report Bug Copy Issue Report This method seems to be duplicated in your project. Duplicated code is one of the most pungent code smells. If you need to duplicate the same code in three or more different places, we strongly encourage you to look into extracting the code into a single class or operation. You can also find more detailed suggestions in the “Code” section of your repository. Loading history...
107		{
108		$repo = new DatabaseRepository;
109
110		try {
111		if ($request->input('action') !== 'delete') {
112		$host = $repo->update($id, $request->intersect([
		0 ignored issues – show Unused Code introduced 2017-03-16 23:38 UTC by Report Bug Copy Issue Report `$host` is not used, you could remove the assignment. This check looks for variable assignements that are either overwritten by other assignments or where the variable is not used subsequently. $myVar = 'Value'; $higher = false; if (rand(1, 6) > 3) { $higher = true; } else { $higher = false; } Both the `$myVar` assignment in line 1 and the `$higher` assignment in line 2 are dead. The first because `$myVar` is never used and the second because `$higher` is always overwritten for every possible time line. Loading history...
113		'name', 'username', 'password',
114		'host', 'port', 'node_id',
115		]));
116		Alert::success('Database host was updated successfully.')->flash();
117		} else {
118		$repo->delete($id);
119
120		return redirect()->route('admin.databases');
121		}
122		} catch (\PDOException $ex) {
123		Alert::danger($ex->getMessage())->flash();
124		} catch (DisplayException $ex) {
125		Alert::danger($ex->getMessage())->flash();
126		} catch (DisplayValidationException $ex) {
127		return redirect()->route('admin.databases.view', $id)->withErrors(json_decode($ex->getMessage()));
		0 ignored issues – show Documentation introduced 2017-03-16 23:38 UTC by Report Bug Copy Issue Report `$id` is of type `integer`, but the function expects a `array`. It seems like the type of the argument is not accepted by the function/method which you are calling. In some cases, in particular if PHP’s automatic type-juggling kicks in this might be fine. In other cases, however this might be a bug. We suggest to add an explicit type cast like in the following example: function acceptsInteger($int) { } $x = '123'; // string "123" // Instead of acceptsInteger($x); // we recommend to use acceptsInteger((integer) $x); Loading history...
128		} catch (\Exception $ex) {
129		Log::error($ex);
130		Alert::danger('An error was encountered while trying to process this request. This error has been logged.')->flash();
131		}
132
133		return redirect()->route('admin.databases.view', $id);
		0 ignored issues – show Documentation introduced 2017-03-16 23:38 UTC by Report Bug Copy Issue Report `$id` is of type `integer`, but the function expects a `array`. It seems like the type of the argument is not accepted by the function/method which you are calling. In some cases, in particular if PHP’s automatic type-juggling kicks in this might be fine. In other cases, however this might be a bug. We suggest to add an explicit type cast like in the following example: function acceptsInteger($int) { } $x = '123'; // string "123" // Instead of acceptsInteger($x); // we recommend to use acceptsInteger((integer) $x); Loading history...
134		}
135		}
136

Pterodactyl / Panel

GitHub Access Token became invalid

Push — develop ( 05d2a6...198a02 )

DatabaseController::index() A

Complexity

Size

Duplication

Importance

Available Fixes

Available Fixes

Available Fixes

Duplication Side-by-Side

Filter issues like