NodeController::lists() - Code Metrics - Inspection of "Refactor to use more laravel logic and improve com..." - Pterodactyl/Panel - Measure and Improve Code Quality continuously with Scrutinizer

Completed

Pull Request — develop (#206)

unknown

created 2016-12-11 21:55 UTC

NodeController::lists() A

↳ Parent: NodeController

Complexity

Conditions	1
Paths	1

Size

Total Lines	4
Code Lines	2

Duplication

Lines	0
Ratio	0 %

Importance

Changes

Metric	Value
dl	0
loc	4
rs	10
c	0
b	0
f	0
cc	1
eloc	2
nc	1
nop	1

<?php
/**
 * Pterodactyl - Panel
 * Copyright (c) 2015 - 2016 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;

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

/**
 * @Resource("Servers")
 */
class NodeController extends BaseController
{
    public function __construct()
    {
        //
    }

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

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

    /**
     * Create a New Node.
     *
     * @Post("/nodes")
     * @Versions({"v1"})
     * @Transaction({
     *      @Request({
     *      	'name' => 'My API Node',
     *      	'location' => 1,
     *      	'public' => 1,
     *      	'fqdn' => 'daemon.wuzzle.woo',
     *      	'scheme' => 'https',
     *      	'memory' => 10240,
     *      	'memory_overallocate' => 100,
     *      	'disk' => 204800,
     *      	'disk_overallocate' => -1,
     *      	'daemonBase' => '/srv/daemon-data',
     *      	'daemonSFTP' => 2022,
     *      	'daemonListen' => 8080
     *      }, headers={"Authorization": "Bearer <jwt-token>"}),
     *       @Response(200),
     *       @Response(422, body={
     *          "message": "A validation error occured.",
     *          "errors": {},
     *          "status_code": 422
     *       }),
     *       @Response(503, body={
     *       	"message": "There was an error while attempting to add this node to the system.",
     *       	"status_code": 503
     *       })
     * })
     */
    public function create(Request $request)

    {
        try {
            $node = new NodeRepository;
            $new = $node->create($request->all());

            return ['id' => $new];
        } 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 $e) {
            throw new BadRequestHttpException('There was an error while attempting to add this node to the system.');
        }
    }

    /**
     * List Specific Node.
     *
     * Lists specific fields about a server or all fields pertaining to that node.
     *
     * @Get("/nodes/{id}/{?fields}")
     * @Versions({"v1"})
     * @Parameters({
     *      @Parameter("id", type="integer", required=true, description="The ID of the node 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, $fields = null)

    {
        $node = Models\Node::where('id', $id);

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

            foreach (explode(',', $request->input('fields')) as $field) {
                if (! empty($field)) {
                    $node->addSelect($field);
                }
            }
        }

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

            return [
                'node' => $node->first(),
                'allocations' => [
                    'assigned' => Models\Allocation::where('node', $id)->whereNotNull('assigned_to')->get(),
                    'unassigned' => Models\Allocation::where('node', $id)->whereNull('assigned_to')->get(),
                ],
            ];
        } catch (NotFoundHttpException $ex) {
            throw $ex;
        } catch (\Exception $ex) {
            throw new BadRequestHttpException('There was an issue with the fields passed in the request.');
        }
    }

    public function config(Request $request, $id)
    {
        if (! $request->secure()) {
            throw new BadRequestHttpException('This API route can only be accessed using a secure connection.');
        }

        $node = Models\Node::where('id', $id)->first();
        if (! $node) {
            throw new NotFoundHttpException('No node by that ID was found.');
        }

        return [
            'web' => [
                'listen' => $node->daemonListen,
                'host' => '0.0.0.0',
                'ssl' => [
                    'enabled' => ($node->scheme === 'https'),
                    'certificate' => '/etc/certs/' . $node->fqdn . '/fullchain.pem',
                    'key' => '/etc/certs/' . $node->fqdn . '/privkey.pem',
                ],
            ],
            'docker' => [
                'socket' => '/var/run/docker.sock',
                'autoupdate_images' => true,
            ],
            'sftp' => [
                'path' => $node->daemonBase,
                'port' => (int) $node->daemonSFTP,
                'container' => 'ptdl-sftp',
            ],
            'query' => [
                'kill_on_fail' => true,
                'fail_limit' => 5,
            ],
            'logger' => [
                'path' => 'logs/',
                'src' => false,
                'level' => 'info',
                'period' => '1d',
                'count' => 3,
            ],
            'remote' => [
                'base' => config('app.url'),
                'download' => route('remote.download'),
                'installed' => route('remote.install'),
            ],
            'uploads' => [
                'size_limit' => $node->upload_size,
            ],
            'keys' => [
                $node->daemonSecret,
            ],
        ];
    }

     /**
      * List all Node Allocations.
      *
      * Returns a listing of all allocations for every node.
      *
      * @Get("/nodes/allocations")
      * @Versions({"v1"})
      * @Response(200)
      */
     public function allocations(Request $request)

     {
         $allocations = Models\Allocation::all();
         if ($allocations->count() < 1) {
             throw new NotFoundHttpException('No allocations have been created.');
         }

         return $allocations;
     }

     /**
      * List Node Allocation based on assigned to ID.
      *
      * Returns a listing of the allocation for the specified server id.
      *
      * @Get("/nodes/allocations/{id}")
      * @Versions({"v1"})
      * @Response(200)
      */
     public function allocationsView(Request $request, $id)

     {
         $query = Models\Allocation::where('assigned_to', $id)->get();
         try {
             if (empty($query)) {
                 throw new NotFoundHttpException('No allocations for that server were found.');
             }

             return $query;
         } catch (NotFoundHttpException $ex) {
             throw $ex;
         } catch (\Exception $ex) {
             throw new BadRequestHttpException('There was an issue with the fields passed in the request.');
         }
     }

    /**
     * Delete Node.
     *
     * @Delete("/nodes/{id}")
     * @Versions({"v1"})
     * @Parameters({
     *      @Parameter("id", type="integer", required=true, description="The ID of the node."),
     * })
     * @Response(204)
     */
    public function delete(Request $request, $id)

    {
        try {
            $node = new NodeRepository;
            $node->delete($id);

            return $this->response->noContent();
        } catch (DisplayException $ex) {
            throw new ResourceException($ex->getMessage());
        } catch (\Exception $e) {
            throw new ServiceUnavailableHttpException('An error occured while attempting to delete this node.');
        }
    }
}


1		<?php
2		/**
3		* Pterodactyl - Panel
4		* Copyright (c) 2015 - 2016 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\API;
26
27		use Pterodactyl\Models;
28		use Illuminate\Http\Request;
29		use Dingo\Api\Exception\ResourceException;
30		use Pterodactyl\Exceptions\DisplayException;
31		use Pterodactyl\Repositories\NodeRepository;
32		use Pterodactyl\Exceptions\DisplayValidationException;
33		use Symfony\Component\HttpKernel\Exception\NotFoundHttpException;
34		use Symfony\Component\HttpKernel\Exception\BadRequestHttpException;
35		use Symfony\Component\HttpKernel\Exception\ServiceUnavailableHttpException;
36
37		/**
38		* @Resource("Servers")
39		*/
40		class NodeController extends BaseController
41		{
42		public function __construct()
43		{
44		//
45		}
46
47		/**
48		* List All Nodes.
49		*
50		* Lists all nodes currently on the system.
51		*
52		* @Get("/nodes/{?page}")
53		* @Versions({"v1"})
54		* @Parameters({
55		* @Parameter("page", type="integer", description="The page of results to view.", default=1)
56		* })
57		* @Response(200)
58		*/
59		public function lists(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...
60		{
61		return Models\Node::all()->toArray();
62		}
63
64		/**
65		* Create a New Node.
66		*
67		* @Post("/nodes")
68		* @Versions({"v1"})
69		* @Transaction({
70		* @Request({
71		* 'name' => 'My API Node',
72		* 'location' => 1,
73		* 'public' => 1,
74		* 'fqdn' => 'daemon.wuzzle.woo',
75		* 'scheme' => 'https',
76		* 'memory' => 10240,
77		* 'memory_overallocate' => 100,
78		* 'disk' => 204800,
79		* 'disk_overallocate' => -1,
80		* 'daemonBase' => '/srv/daemon-data',
81		* 'daemonSFTP' => 2022,
82		* 'daemonListen' => 8080
83		* }, headers={"Authorization": "Bearer <jwt-token>"}),
84		* @Response(200),
85		* @Response(422, body={
86		* "message": "A validation error occured.",
87		* "errors": {},
88		* "status_code": 422
89		* }),
90		* @Response(503, body={
91		* "message": "There was an error while attempting to add this node to the system.",
92		* "status_code": 503
93		* })
94		* })
95		*/
96	View Code Duplication	public function create(Request $request)
		0 ignored issues – show Duplication introduced 2016-12-07 22:58 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...
97		{
98		try {
99		$node = new NodeRepository;
100		$new = $node->create($request->all());
101
102		return ['id' => $new];
103		} catch (DisplayValidationException $ex) {
104		throw new ResourceException('A validation error occured.', json_decode($ex->getMessage(), true));
105		} catch (DisplayException $ex) {
106		throw new ResourceException($ex->getMessage());
107		} catch (\Exception $e) {
108		throw new BadRequestHttpException('There was an error while attempting to add this node to the system.');
109		}
110		}
111
112		/**
113		* List Specific Node.
114		*
115		* Lists specific fields about a server or all fields pertaining to that node.
116		*
117		* @Get("/nodes/{id}/{?fields}")
118		* @Versions({"v1"})
119		* @Parameters({
120		* @Parameter("id", type="integer", required=true, description="The ID of the node to get information on."),
121		* @Parameter("fields", type="string", required=false, description="A comma delimidated list of fields to include.")
122		* })
123		* @Response(200)
124		*/
125		public function view(Request $request, $id, $fields = null)
		0 ignored issues – show Unused Code introduced 2016-12-07 22:58 UTC by Report Bug Copy Issue Report The parameter `$fields` 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...
126		{
127		$node = Models\Node::where('id', $id);
128
129	View Code Duplication	if (! is_null($request->input('fields'))) {
		0 ignored issues – show Duplication introduced 2016-12-07 22:58 UTC by Report Bug Copy Issue Report This code seems to be duplicated across 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...
130		foreach (explode(',', $request->input('fields')) as $field) {
131		if (! empty($field)) {
132		$node->addSelect($field);
133		}
134		}
135		}
136
137		try {
138		if (! $node->first()) {
139		throw new NotFoundHttpException('No node by that ID was found.');
140		}
141
142		return [
143		'node' => $node->first(),
144		'allocations' => [
145		'assigned' => Models\Allocation::where('node', $id)->whereNotNull('assigned_to')->get(),
146		'unassigned' => Models\Allocation::where('node', $id)->whereNull('assigned_to')->get(),
147		],
148		];
149		} catch (NotFoundHttpException $ex) {
150		throw $ex;
151		} catch (\Exception $ex) {
152		throw new BadRequestHttpException('There was an issue with the fields passed in the request.');
153		}
154		}
155
156		public function config(Request $request, $id)
157		{
158		if (! $request->secure()) {
159		throw new BadRequestHttpException('This API route can only be accessed using a secure connection.');
160		}
161
162		$node = Models\Node::where('id', $id)->first();
163		if (! $node) {
164		throw new NotFoundHttpException('No node by that ID was found.');
165		}
166
167		return [
168		'web' => [
169		'listen' => $node->daemonListen,
170		'host' => '0.0.0.0',
171		'ssl' => [
172		'enabled' => ($node->scheme === 'https'),
173		'certificate' => '/etc/certs/' . $node->fqdn . '/fullchain.pem',
174		'key' => '/etc/certs/' . $node->fqdn . '/privkey.pem',
175		],
176		],
177		'docker' => [
178		'socket' => '/var/run/docker.sock',
179		'autoupdate_images' => true,
180		],
181		'sftp' => [
182		'path' => $node->daemonBase,
183		'port' => (int) $node->daemonSFTP,
184		'container' => 'ptdl-sftp',
185		],
186		'query' => [
187		'kill_on_fail' => true,
188		'fail_limit' => 5,
189		],
190		'logger' => [
191		'path' => 'logs/',
192		'src' => false,
193		'level' => 'info',
194		'period' => '1d',
195		'count' => 3,
196		],
197		'remote' => [
198		'base' => config('app.url'),
199		'download' => route('remote.download'),
200		'installed' => route('remote.install'),
201		],
202		'uploads' => [
203		'size_limit' => $node->upload_size,
204		],
205		'keys' => [
206		$node->daemonSecret,
207		],
208		];
209		}
210
211		/**
212		* List all Node Allocations.
213		*
214		* Returns a listing of all allocations for every node.
215		*
216		* @Get("/nodes/allocations")
217		* @Versions({"v1"})
218		* @Response(200)
219		*/
220		public function allocations(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...
221		{
222		$allocations = Models\Allocation::all();
223		if ($allocations->count() < 1) {
224		throw new NotFoundHttpException('No allocations have been created.');
225		}
226
227		return $allocations;
228		}
229
230		/**
231		* List Node Allocation based on assigned to ID.
232		*
233		* Returns a listing of the allocation for the specified server id.
234		*
235		* @Get("/nodes/allocations/{id}")
236		* @Versions({"v1"})
237		* @Response(200)
238		*/
239		public function allocationsView(Request $request, $id)
		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...
240		{
241		$query = Models\Allocation::where('assigned_to', $id)->get();
242		try {
243		if (empty($query)) {
244		throw new NotFoundHttpException('No allocations for that server were found.');
245		}
246
247		return $query;
248		} catch (NotFoundHttpException $ex) {
249		throw $ex;
250		} catch (\Exception $ex) {
251		throw new BadRequestHttpException('There was an issue with the fields passed in the request.');
252		}
253		}
254
255		/**
256		* Delete Node.
257		*
258		* @Delete("/nodes/{id}")
259		* @Versions({"v1"})
260		* @Parameters({
261		* @Parameter("id", type="integer", required=true, description="The ID of the node."),
262		* })
263		* @Response(204)
264		*/
265	View Code Duplication	public function delete(Request $request, $id)
		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... Duplication introduced 2016-12-07 22:58 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...
266		{
267		try {
268		$node = new NodeRepository;
269		$node->delete($id);
270
271		return $this->response->noContent();
272		} catch (DisplayException $ex) {
273		throw new ResourceException($ex->getMessage());
274		} catch (\Exception $e) {
275		throw new ServiceUnavailableHttpException('An error occured while attempting to delete this node.');
276		}
277		}
278		}
279

Pterodactyl / Panel

GitHub Access Token became invalid

Pull Request — develop (#206)

NodeController::lists() A

Complexity

Size

Duplication

Importance

Duplication Side-by-Side

Filter issues like