ServiceController - Code Metrics - Inspection of "Initial implementation of improved sever model and..." - Pterodactyl/Panel - Measure and Improve Code Quality continuously with Scrutinizer

Completed

Pull Request — develop (#286)

by Dane

created 2017-02-09 22:45 UTC

ServiceController B

↳ Parent: Project

Complexity

Total Complexity

Size/Duplication

Total Lines	295
Duplicated Lines	27.46 %

Coupling/Cohesion

Components	0
Dependencies	12

Importance

Changes

Metric	Value
wmc	44
c	0
b	0
f	0
lcom	0
cbo	12
dl	81
loc	295
rs	8.3396

18 Methods

Rating	Name	Duplication	Size	Complexity
A	__construct()	0	4	1
B	postOptionVariable()	0	33	6
A	getIndex()	0	6	1
A	getNew()	0	4	1
B	postNew()	25	25	4
A	getService()	0	6	1
B	postService()	23	23	4
A	deleteService()	15	17	3
A	getOption()	0	9	1
A	postOption()	0	22	3
A	deleteOption()	18	18	3
A	getNewVariable()	0	6	1
B	postNewVariable()	0	28	4
A	newOption()	0	6	1
A	postNewOption()	0	19	3
A	deleteVariable()	0	15	3
A	getConfiguration()	0	12	1
A	postConfiguration()	0	22	3

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 ServiceController 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 ServiceController, 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\Admin;

use DB;
use Log;
use Alert;
use Storage;
use Pterodactyl\Models;
use Illuminate\Http\Request;
use Pterodactyl\Exceptions\DisplayException;
use Pterodactyl\Http\Controllers\Controller;
use Pterodactyl\Repositories\ServiceRepository;
use Pterodactyl\Exceptions\DisplayValidationException;

class ServiceController extends Controller
{
    public function __construct()
    {
        //
    }

    public function getIndex(Request $request)

    {
        return view('admin.services.index', [
            'services' => Models\Service::withCount('servers')->get(),
        ]);
    }

    public function getNew(Request $request)

    {
        return view('admin.services.new');
    }

    public function postNew(Request $request)

    {
        try {
            $repo = new ServiceRepository\Service;
            $service = $repo->create($request->only([
                'name',
                'description',
                'file',
                'executable',
                'startup',
            ]));
            Alert::success('Successfully created new service!')->flash();

            return redirect()->route('admin.services.service', $service->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 (DisplayValidationException $ex) {
            return redirect()->route('admin.services.new')->withErrors(json_decode($ex->getMessage()))->withInput();
        } catch (DisplayException $ex) {
            Alert::danger($ex->getMessage())->flash();
        } catch (\Exception $ex) {
            Log::error($ex);
            Alert::danger('An error occured while attempting to add a new service.')->flash();
        }

        return redirect()->route('admin.services.new')->withInput();
    }

    public function getService(Request $request, $service)

    {
        return view('admin.services.view', [
            'service' => Models\Service::with('options', 'options.servers')->findOrFail($service),
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.
}
        ]);
    }

    public function postService(Request $request, $service)

    {
        try {
            $repo = new ServiceRepository\Service;
            $repo->update($service, $request->only([
                'name',
                'description',
                'file',
                'executable',
                'startup',
            ]));
            Alert::success('Successfully updated this service.')->flash();
        } catch (DisplayValidationException $ex) {
            return redirect()->route('admin.services.service', $service)->withErrors(json_decode($ex->getMessage()))->withInput();
        } catch (DisplayException $ex) {
            Alert::danger($ex->getMessage())->flash();
        } catch (\Exception $ex) {
            Log::error($ex);
            Alert::danger('An error occurred while attempting to update this service.')->flash();
        }

        return redirect()->route('admin.services.service', $service)->withInput();
    }

    public function deleteService(Request $request, $service)

    {
        try {
            $repo = new ServiceRepository\Service;
            $repo->delete($service);
            Alert::success('Successfully deleted that service.')->flash();

            return redirect()->route('admin.services');
        } catch (DisplayException $ex) {
            Alert::danger($ex->getMessage())->flash();
        } catch (\Exception $ex) {
            Log::error($ex);
            Alert::danger('An error was encountered while attempting to delete that service.')->flash();
        }

        return redirect()->route('admin.services.service', $service);
    }

    public function getOption(Request $request, $service, $option)

    {
        $option = Models\ServiceOptions::with('service', 'variables')->findOrFail($option);
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.
}
        $option->setRelation('servers', $option->servers()->with('user')->paginate(25));

        return view('admin.services.options.view', [
            'option' => $option,
        ]);
    }

    public function postOption(Request $request, $service, $option)
    {
        try {
            $repo = new ServiceRepository\Option;
            $repo->update($option, $request->only([
                'name',
                'description',
                'tag',
                'executable',
                'docker_image',
                'startup',
            ]));
            Alert::success('Option settings successfully updated.')->flash();
        } catch (DisplayValidationException $ex) {
            return redirect()->route('admin.services.option', [$service, $option])->withErrors(json_decode($ex->getMessage()))->withInput();
        } catch (\Exception $ex) {
            Log::error($ex);
            Alert::danger('An error occured while attempting to modify this option.')->flash();
        }

        return redirect()->route('admin.services.option', [$service, $option])->withInput();
    }

    public function deleteOption(Request $request, $service, $option)

    {
        try {
            $repo = new ServiceRepository\Option;
            $repo->delete($option);

            Alert::success('Successfully deleted that option.')->flash();

            return redirect()->route('admin.services.service', $service);
        } catch (DisplayException $ex) {
            Alert::danger($ex->getMessage())->flash();
        } catch (\Exception $ex) {
            Log::error($ex);
            Alert::danger('An error was encountered while attempting to delete this option.')->flash();
        }

        return redirect()->route('admin.services.option', [$service, $option]);
    }

    public function postOptionVariable(Request $request, $service, $option, $variable)
    {
        try {
            $repo = new ServiceRepository\Variable;

            // Because of the way old() works on the display side we prefix all of the variables with thier ID
            // We need to remove that prefix here since the repo doesn't want it.
            $data = [
                'user_viewable' => '0',
                'user_editable' => '0',
                'required' => '0',
            ];
            foreach ($request->except(['_token']) as $id => $val) {
                $data[str_replace($variable . '_', '', $id)] = $val;
            }
            $repo->update($variable, $data);
            Alert::success('Successfully updated variable.')->flash();
        } catch (DisplayValidationException $ex) {
            $data = [];
            foreach (json_decode($ex->getMessage(), true) as $id => $val) {
                $data[$variable . '_' . $id] = $val;
            }

            return redirect()->route('admin.services.option', [$service, $option])->withErrors((object) $data)->withInput();
        } catch (DisplayException $ex) {
            Alert::danger($ex->getMessage())->flash();
        } catch (\Exception $ex) {
            Log::error($ex);
            Alert::danger('An error occurred while attempting to update this service.')->flash();
        }

        return redirect()->route('admin.services.option', [$service, $option])->withInput();
    }

    public function getNewVariable(Request $request, $service, $option)

    {
        return view('admin.services.options.variable', [
            'option' => Models\ServiceOptions::with('service')->findOrFail($option),
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.
}
        ]);
    }

    public function postNewVariable(Request $request, $service, $option)
    {
        try {
            $repo = new ServiceRepository\Variable;
            $repo->create($option, $request->only([
                'name',
                'description',
                'env_variable',
                'default_value',
                'user_viewable',
                'user_editable',
                'required',
                'regex',
            ]));
            Alert::success('Successfully added new variable to this option.')->flash();

            return redirect()->route('admin.services.option', [$service, $option]);
        } catch (DisplayValidationException $ex) {
            return redirect()->route('admin.services.option.variable.new', [$service, $option])->withErrors(json_decode($ex->getMessage()))->withInput();
        } catch (DisplayException $ex) {
            Alert::danger($ex->getMessage())->flash();
        } catch (\Exception $ex) {
            Log::error($ex);
            Alert::danger('An error occurred while attempting to add this variable.')->flash();
        }

        return redirect()->route('admin.services.option.variable.new', [$service, $option])->withInput();
    }

    public function newOption(Request $request, $service)

    {
        return view('admin.services.options.new', [
            'service' => Models\Service::findOrFail($service),
        ]);
    }

    public function postNewOption(Request $request, $service)
    {
        try {
            $repo = new ServiceRepository\Option;
            $id = $repo->create($service, $request->except([
                '_token',
            ]));
            Alert::success('Successfully created new service option.')->flash();

            return redirect()->route('admin.services.option', [$service, $id]);
        } catch (DisplayValidationException $ex) {
            return redirect()->route('admin.services.option.new', $service)->withErrors(json_decode($ex->getMessage()))->withInput();
        } catch (\Exception $ex) {
            Log::error($ex);
            Alert::danger('An error occured while attempting to add this service option.')->flash();
        }

        return redirect()->route('admin.services.option.new', $service)->withInput();
    }

    public function deleteVariable(Request $request, $service, $option, $variable)

    {
        try {
            $repo = new ServiceRepository\Variable;
            $repo->delete($variable);
            Alert::success('Deleted variable.')->flash();
        } catch (DisplayException $ex) {
            Alert::danger($ex->getMessage())->flash();
        } catch (\Exception $ex) {
            Log::error($ex);
            Alert::danger('An error occured while attempting to delete that variable.')->flash();
        }

        return redirect()->route('admin.services.option', [$service, $option]);
    }

    public function getConfiguration(Request $request, $serviceId)

    {
        $service = Models\Service::findOrFail($serviceId);

        return view('admin.services.config', [
            'service' => $service,
            'contents' => [
                'json' => Storage::get('services/' . $service->file . '/main.json'),
                'index' => Storage::get('services/' . $service->file . '/index.js'),
            ],
        ]);
    }

    public function postConfiguration(Request $request, $serviceId)
    {
        try {
            $repo = new ServiceRepository\Service;
            $repo->updateFile($serviceId, $request->only([
                'file',
                'contents',
            ]));

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

            return response()->json([
                'error' => 'An error occured while attempting to save the file.',
            ], 503);
        }
    }
}


GitHub Access Token became invalid

Pull Request — develop (#286)

ServiceController B

Complexity

Size/Duplication

Coupling/Cohesion

Importance

18 Methods

How to fix Duplicated Code Complexity

Duplicated Code

Complex Class

Available Fixes

Available Fixes

Available Fixes

Pterodactyl / Panel

GitHub Access Token became invalid

Pull Request — develop (#286)

ServiceController B

Complexity

Size/Duplication

Coupling/Cohesion

Importance

18 Methods

How to fix Duplicated Code Complexity

Duplicated Code

Complex Class

Available Fixes

Available Fixes

Available Fixes

Duplication Side-by-Side

Filter issues like