DeploymentService::randomAllocation() - Code Metrics - Inspection of "Cleanup auto-deployment functions substantially" - Pterodactyl/Panel - Measure and Improve Code Quality continuously with Scrutinizer

Completed

Push — develop ( c59cfc...b3e556 )

by Dane

created 2017-05-02 03:00 UTC

DeploymentService::randomAllocation() A

↳ Parent: DeploymentService

Complexity

Conditions	2
Paths	2

Size

Total Lines	9
Code Lines	5

Duplication

Lines	0
Ratio	0 %

Importance

Changes

Metric	Value
dl	0
loc	9
rs	9.6666
c	0
b	0
f	0
cc	2
eloc	5
nc	2
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\Services;

use DB;
use Pterodactyl\Models\Node;
use Pterodactyl\Models\Server;
use Pterodactyl\Models\Location;
use Pterodactyl\Exceptions\AutoDeploymentException;

class DeploymentService
{
    /**
     * Eloquent model representing the allocation to use.
     *
     * @var \Pterodactyl\Models\Allocation
     */
    protected $allocation;

    /**
     * Amount of disk to be used by the server.
     *
     * @var int
     */
    protected $disk;

    /**
     * Amount of memory to be used by the sever.
     *
     * @var int
     */
    protected $memory;

    /**
     * Eloquent model representing the location to use.
     *
     * @var \Pterodactyl\Models\Location
     */
    protected $location;

    /**
     * Eloquent model representing the node to use.
     *
     * @var \Pterodactyl\Models\Node
     */
    protected $node;

    /**
     * Set the location to use when auto-deploying.
     *
     * @param  int|\Pterodactyl\Models\Location  $location
     * @return void
     */
    public function setLocation($location)
    {
        $this->location = ($location instanceof Location) ? $location : Location::with('nodes')->findOrFail($location);
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.
}
        if (! $this->location->relationLoaded('nodes')) {
            $this->location->load('nodes');
        }

        if (count($this->location->nodes) < 1) {
            throw new AutoDeploymentException('The location provided does not contain any nodes and cannot be used.');
        }

        return $this;
    }

    /**
     * Set the node to use when auto-deploying.
     *
     * @param  int|\Pterodactyl\Models\Node  $node
     * @return void
     */
    public function setNode($node)
    {
        $this->node = ($node instanceof Node) ? $node : Node::findOrFail($node);
        if (! $this->node->relationLoaded('allocations')) {
            $this->node->load('allocations');
        }

        $this->setLocation($this->node->location);

        return $this;
    }

    /**
     * Set the amount of disk space to be used by the new server.
     *
     * @param  int  $disk
     * @return void
     */
    public function setDisk(int $disk)
    {
        $this->disk = $disk;

        return $this;
    }

    /**
     * Set the amount of memory to be used by the new server.
     *
     * @param  int  $memory
     * @return void
     */
    public function setMemory(int $memory)
    {
        $this->memory = $memory;

        return $this;
    }

    /**
     * Return a random location model.
     *
     * @param  array  $exclude
     * @return void;

     */
    protected function findLocation(array $exclude = [])
    {
        $location = Location::with('nodes')->whereNotIn('id', $exclude)->inRandomOrder()->first();

        if (! $location) {
            throw new AutoDeploymentException('Unable to locate a suitable location to select a node from.');
        }

        if (count($location->nodes) < 1) {
            return $this->findLocation(array_merge($exclude, [$location->id]));
        }

        $this->setLocation($location);
    }

    /**
     * Return a model instance of a random node.
     *
     * @return void;

     */
    protected function findNode(array $exclude = [])
    {
        if (! $this->location) {
            $this->setLocation($this->findLocation());
        }

        $select = $this->location->nodes->whereNotIn('id', $exclude);
        if (count($select) < 1) {
            throw new AutoDeploymentException('Unable to find a suitable node within the assigned location with enough space.');
        }

        // Check usage, select new node if necessary
        $this->setNode($select->random());
        if (! $this->checkNodeUsage()) {
            return $this->findNode(array_merge($exclude, [$this->node()->id]));
        }
    }

    /**
     * Checks that a node's allocation limits will not be passed
     * with the assigned limits.
     *
     * @return bool
     */
    protected function checkNodeUsage()
    {
        if (! $this->disk && ! $this->memory) {
            return true;
        }

        $totals = Server::select(DB::raw('SUM(memory) as memory, SUM(disk) as disk'))->where('node_id', $this->node()->id)->first();

        if ($this->memory) {
            $limit = ($this->node()->memory * (1 + ($this->node()->memory_overallocate / 100)));

            if (($totals->memory + $this->memory) > $limit) {
                return false;
            }
        }

        if ($this->disk) {
            $limit = ($this->node()->disk * (1 + ($this->node()->disk_overallocate / 100)));

            if (($totals->disk + $this->disk) > $limit) {
                return false;
            }
        }

        return true;
    }

    /**
     * Return the assigned node for this auto-deployment.
     *
     * @return \Pterodactyl\Models\Node
     */
    public function node() {
        return $this->node;
    }

    /**
     * Return the assigned location for this auto-deployment.
     *
     * @return \Pterodactyl\Models\Location
     */
    public function location() {
        return $this->location;
    }

    /**
     * Return the assigned location for this auto-deployment.
     *
     * @return \Pterodactyl\Models\Allocation
     */
    public function allocation() {
        return $this->allocation;
    }

    /**
     * Select and return the node to be used by the auto-deployment system.
     *
     * @return void
     */
    public function select() {
        if (! $this->node) {
            $this->findNode();
        }

        // Set the Allocation
        $this->allocation = $this->node()->allocations->where('server_id', null)->random();
        if (! $this->allocation) {
            throw new AutoDeploymentException('Unable to find a suitable allocation to assign to this server.');
        }
    }
}


GitHub Access Token became invalid

Push — develop ( c59cfc...b3e556 )

DeploymentService::randomAllocation() A

Complexity

Size

Duplication

Importance

Available Fixes

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\Services;
26
27			use DB;
28			use Pterodactyl\Models\Node;
29			use Pterodactyl\Models\Server;
30			use Pterodactyl\Models\Location;
31			use Pterodactyl\Exceptions\AutoDeploymentException;
32
33			class DeploymentService
34			{
35			/**
36			* Eloquent model representing the allocation to use.
37			*
38			* @var \Pterodactyl\Models\Allocation
39			*/
40			protected $allocation;
41
42			/**
43			* Amount of disk to be used by the server.
44			*
45			* @var int
46			*/
47			protected $disk;
48
49			/**
50			* Amount of memory to be used by the sever.
51			*
52			* @var int
53			*/
54			protected $memory;
55
56			/**
57			* Eloquent model representing the location to use.
58			*
59			* @var \Pterodactyl\Models\Location
60			*/
61			protected $location;
62
63			/**
64			* Eloquent model representing the node to use.
65			*
66			* @var \Pterodactyl\Models\Node
67			*/
68			protected $node;
69
70			/**
71			* Set the location to use when auto-deploying.
72			*
73			* @param int\|\Pterodactyl\Models\Location $location
74			* @return void
75			*/
76			public function setLocation($location)
77			{
78			$this->location = ($location instanceof Location) ? $location : Location::with('nodes')->findOrFail($location);
			0 ignored issues – show Bug introduced 2017-05-02 03:02 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...
79			if (! $this->location->relationLoaded('nodes')) {
80			$this->location->load('nodes');
81			}
82
83			if (count($this->location->nodes) < 1) {
84			throw new AutoDeploymentException('The location provided does not contain any nodes and cannot be used.');
85			}
86
87			return $this;
88			}
89
90			/**
91			* Set the node to use when auto-deploying.
92			*
93			* @param int\|\Pterodactyl\Models\Node $node
94			* @return void
95			*/
96			public function setNode($node)
97			{
98			$this->node = ($node instanceof Node) ? $node : Node::findOrFail($node);
99			if (! $this->node->relationLoaded('allocations')) {
100			$this->node->load('allocations');
101			}
102
103			$this->setLocation($this->node->location);
104
105			return $this;
106			}
107
108			/**
109			* Set the amount of disk space to be used by the new server.
110			*
111			* @param int $disk
112			* @return void
113			*/
114			public function setDisk(int $disk)
115			{
116			$this->disk = $disk;
117
118			return $this;
119			}
120
121			/**
122			* Set the amount of memory to be used by the new server.
123			*
124			* @param int $memory
125			* @return void
126			*/
127			public function setMemory(int $memory)
128			{
129			$this->memory = $memory;
130
131			return $this;
132			}
133
134			/**
135			* Return a random location model.
136			*
137			* @param array $exclude
138			* @return void;
			0 ignored issues – show Documentation introduced 2017-05-02 03:02 UTC by Report Bug Copy Issue Report The doc-type `void;` could not be parsed: Expected "\|" or "end of type", but got ";" at position 4. (view supported doc-types) This check marks PHPDoc comments that could not be parsed by our parser. To see which comment annotations we can parse, please refer to our documentation on supported doc-types. Loading history...
139			*/
140			protected function findLocation(array $exclude = [])
141			{
142			$location = Location::with('nodes')->whereNotIn('id', $exclude)->inRandomOrder()->first();
143
144			if (! $location) {
145			throw new AutoDeploymentException('Unable to locate a suitable location to select a node from.');
146			}
147
148			if (count($location->nodes) < 1) {
149			return $this->findLocation(array_merge($exclude, [$location->id]));
150			}
151
152			$this->setLocation($location);
153			}
154
155			/**
156			* Return a model instance of a random node.
157			*
158			* @return void;
			0 ignored issues – show Documentation introduced 2017-05-02 03:02 UTC by Report Bug Copy Issue Report The doc-type `void;` could not be parsed: Expected "\|" or "end of type", but got ";" at position 4. (view supported doc-types) This check marks PHPDoc comments that could not be parsed by our parser. To see which comment annotations we can parse, please refer to our documentation on supported doc-types. Loading history...
159			*/
160			protected function findNode(array $exclude = [])
161			{
162			if (! $this->location) {
163			$this->setLocation($this->findLocation());
164			}
165
166			$select = $this->location->nodes->whereNotIn('id', $exclude);
167			if (count($select) < 1) {
168			throw new AutoDeploymentException('Unable to find a suitable node within the assigned location with enough space.');
169			}
170
171			// Check usage, select new node if necessary
172			$this->setNode($select->random());
173			if (! $this->checkNodeUsage()) {
174			return $this->findNode(array_merge($exclude, [$this->node()->id]));
175			}
176			}
177
178			/**
179			* Checks that a node's allocation limits will not be passed
180			* with the assigned limits.
181			*
182			* @return bool
183			*/
184			protected function checkNodeUsage()
185			{
186			if (! $this->disk && ! $this->memory) {
187			return true;
188			}
189
190			$totals = Server::select(DB::raw('SUM(memory) as memory, SUM(disk) as disk'))->where('node_id', $this->node()->id)->first();
191
192			if ($this->memory) {
193			$limit = ($this->node()->memory * (1 + ($this->node()->memory_overallocate / 100)));
194
195			if (($totals->memory + $this->memory) > $limit) {
196			return false;
197			}
198			}
199
200			if ($this->disk) {
201			$limit = ($this->node()->disk * (1 + ($this->node()->disk_overallocate / 100)));
202
203			if (($totals->disk + $this->disk) > $limit) {
204			return false;
205			}
206			}
207
208			return true;
209			}
210
211			/**
212			* Return the assigned node for this auto-deployment.
213			*
214			* @return \Pterodactyl\Models\Node
215			*/
216			public function node() {
217			return $this->node;
218			}
219
220			/**
221			* Return the assigned location for this auto-deployment.
222			*
223			* @return \Pterodactyl\Models\Location
224			*/
225			public function location() {
226			return $this->location;
227			}
228
229			/**
230			* Return the assigned location for this auto-deployment.
231			*
232			* @return \Pterodactyl\Models\Allocation
233			*/
234			public function allocation() {
235			return $this->allocation;
236			}
237
238			/**
239			* Select and return the node to be used by the auto-deployment system.
240			*
241			* @return void
242			*/
243			public function select() {
244			if (! $this->node) {
245			$this->findNode();
246			}
247
248			// Set the Allocation
249			$this->allocation = $this->node()->allocations->where('server_id', null)->random();
250			if (! $this->allocation) {
251			throw new AutoDeploymentException('Unable to find a suitable allocation to assign to this server.');
252			}
253			}
254			}
255

Pterodactyl / Panel

GitHub Access Token became invalid

Push — develop ( c59cfc...b3e556 )

DeploymentService::randomAllocation() A

Complexity

Size

Duplication

Importance

Available Fixes

Duplication Side-by-Side

Filter issues like