Server::guzzleClient() - 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-05 23:00 UTC

Server::guzzleClient() A

↳ Parent: Server

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	0

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

use Auth;
use Javascript;
use Illuminate\Database\Eloquent\Model;
use Illuminate\Notifications\Notifiable;
use Illuminate\Database\Eloquent\SoftDeletes;

class Server extends Model
{
    use Notifiable, SoftDeletes;

    /**
     * The table associated with the model.
     *
     * @var string
     */
    protected $table = 'servers';

    /**
     * The attributes excluded from the model's JSON form.
     *
     * @var array
     */
    protected $hidden = ['daemonSecret', 'sftp_password'];

    /**
     * The attributes that should be mutated to dates.
     *
     * @var array
     */
    protected $dates = ['deleted_at'];

    /**
     * Fields that are not mass assignable.
     *
     * @var array
     */
    protected $guarded = ['id', 'installed', 'created_at', 'updated_at', 'deleted_at'];

     /**
      * Cast values to correct type.
      *
      * @var array
      */
     protected $casts = [
         'node_id' => 'integer',
         'suspended' => 'integer',
         'owner_id' => 'integer',
         'memory' => 'integer',
         'swap' => 'integer',
         'disk' => 'integer',
         'io' => 'integer',
         'cpu' => 'integer',
         'oom_disabled' => 'integer',
         'allocation_id' => 'integer',
         'service_id' => 'integer',
         'option_id' => 'integer',
         'pack_id' => 'integer',
         'installed' => 'integer',
     ];

    /**
     * @var array
     */
    protected static $serverUUIDInstance = [];

    /**
     * @var mixed
     */
    protected static $user;

    /**
     * Constructor.
     */
    public function __construct()
    {
        parent::__construct();
        self::$user = Auth::user();
    }

    /**
     * Returns array of all servers owned by the logged in user.
     * Returns all users servers if user is a root admin.
     *
     * @return \Illuminate\Database\Eloquent\Collection
     */
    public static function getUserServers($paginate = null)
    {
        $query = self::select(
            'servers.*',
            'nodes.name as nodeName',
            'locations.short as a_locationShort',
            'allocations.ip',
            'allocations.ip_alias',
            'allocations.port',
            'services.name as a_serviceName',
            'service_options.name as a_serviceOptionName'
        )->join('nodes', 'servers.node_id', '=', 'nodes.id')
        ->join('locations', 'nodes.location_id', '=', 'locations.id')
        ->join('services', 'servers.service_id', '=', 'services.id')
        ->join('service_options', 'servers.option_id', '=', 'service_options.id')
        ->join('allocations', 'servers.allocation_id', '=', 'allocations.id');

        if (self::$user->root_admin !== 1) {
            $query->whereIn('servers.id', Subuser::accessServers());
        }

        if (is_numeric($paginate)) {
            return $query->paginate($paginate);
        }

        return $query->get();
    }

    /**
     * Returns a single server specified by UUID.
     * DO NOT USE THIS TO MODIFY SERVER DETAILS OR SAVE THOSE DETAILS.
     * YOU WILL OVERWRITE THE SECRET KEY AND BREAK THINGS.
     *
     * @param  string $uuid The Short-UUID of the server to return an object about.
     * @return \Illuminate\Database\Eloquent\Collection
     */
    public static function byUuid($uuid)
    {
        $query = self::with('service', 'node')->where('uuidShort', $uuid)->orWhere('uuid', $uuid);
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 (! Auth::user()->isRootAdmin()) {
            $query->whereIn('id', Subuser::accessServers());
        }

        $result = $query->first();

        if (! is_null($result)) {
            $result->daemonSecret = Auth::user()->daemonToken($result);
        }

        return $result;
    }

    /**
     * Returns non-administrative headers for accessing a server on the daemon.
     *
     * @param  string $uuid
/**
 * @param array $germany
 * @param array $island
 * @param array $italy
 */
function finale($germany, $island) {
    return "2:1";
}
     * @return array
     */
    public function guzzleHeaders()
    {
        return [
            'X-Access-Server' => $this->uuid,
<?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.");
        }
    }

}
            'X-Access-Token' => Auth::user()->daemonToken($this),
        ];
    }

    /**
     * Return an instance of the Guzzle client for this specific server using defined access token.
     *
     * @return \GuzzleHttp\Client
     */
    public function guzzleClient()
    {
        return $this->node->guzzleClient($this->guzzleHeaders());
<?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.");
        }
    }

}
    }

    /**
     * Returns javascript object to be embedded on server view pages with relevant information.
     *
     * @return \Laracasts\Utilities\JavaScript\JavaScriptFacade
     */
    public function js($additional = null, $overwrite = null)
    {
        $response = [
            'server' => collect($this->makeVisible('daemonSecret'))->only([
                'uuid',
                'uuidShort',
                'daemonSecret',
                'username',
            ]),
            'node' => collect($this->node)->only([
<?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.");
        }
    }

}
                'fqdn',
                'scheme',
                'daemonListen',
            ]),
        ];

        if (is_array($additional)) {
            $response = array_merge($response, $additional);
        }

        if (is_array($overwrite)) {
            $response = $overwrite;
        }

        return Javascript::put($response);
    }

    /**
     * Gets the user who owns the server.
     *
     * @return \Illuminate\Database\Eloquent\Relations\BelongsTo
     */
    public function user()
    {
        return $this->belongsTo(User::class, 'owner_id');
    }

    /**
     * Gets all allocations associated with this server.
     *
     * @return \Illuminate\Database\Eloquent\Relations\HasMany
     */
    public function allocations()
    {
        return $this->hasMany(Allocation::class, 'server_id');
    }

    /**
     * Gets information for the pack associated with this server.
     *
     * @return \Illuminate\Database\Eloquent\Relations\HasOne
     */
    public function pack()
    {
        return $this->hasOne(ServicePack::class, 'id', 'pack_id');
    }

    /**
     * Gets information for the service associated with this server.
     *
     * @return \Illuminate\Database\Eloquent\Relations\BelongsTo
     */
    public function service()
    {
        return $this->belongsTo(Service::class);
    }

    /**
     * Gets information for the service option associated with this server.
     *
     * @return \Illuminate\Database\Eloquent\Relations\BelongsTo
     */
    public function option()
    {
        return $this->belongsTo(ServiceOptions::class);
    }

    /**
     * Gets information for the service variables associated with this server.
     *
     * @return \Illuminate\Database\Eloquent\Relations\HasMany
     */
    public function variables()
    {
        return $this->hasMany(ServerVariables::class);
    }

    /**
     * Gets information for the node associated with this server.
     *
     * @return \Illuminate\Database\Eloquent\Relations\BelongsTo
     */
    public function node()
    {
        return $this->belongsTo(Node::class);
    }

    /**
     * Gets information for the tasks associated with this server.
     *
     * @TODO adjust server column in tasks to be server_id
     * @return \Illuminate\Database\Eloquent\Relations\HasMany
     */
    public function tasks()
    {
        return $this->hasMany(Task::class, 'server', 'id');
    }
}


GitHub Access Token became invalid

Pull Request — develop (#286)

Server::guzzleClient() 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\Models;
26
27			use Auth;
28			use Javascript;
29			use Illuminate\Database\Eloquent\Model;
30			use Illuminate\Notifications\Notifiable;
31			use Illuminate\Database\Eloquent\SoftDeletes;
32
33			class Server extends Model
34			{
35			use Notifiable, SoftDeletes;
36
37			/**
38			* The table associated with the model.
39			*
40			* @var string
41			*/
42			protected $table = 'servers';
43
44			/**
45			* The attributes excluded from the model's JSON form.
46			*
47			* @var array
48			*/
49			protected $hidden = ['daemonSecret', 'sftp_password'];
50
51			/**
52			* The attributes that should be mutated to dates.
53			*
54			* @var array
55			*/
56			protected $dates = ['deleted_at'];
57
58			/**
59			* Fields that are not mass assignable.
60			*
61			* @var array
62			*/
63			protected $guarded = ['id', 'installed', 'created_at', 'updated_at', 'deleted_at'];
64
65			/**
66			* Cast values to correct type.
67			*
68			* @var array
69			*/
70			protected $casts = [
71			'node_id' => 'integer',
72			'suspended' => 'integer',
73			'owner_id' => 'integer',
74			'memory' => 'integer',
75			'swap' => 'integer',
76			'disk' => 'integer',
77			'io' => 'integer',
78			'cpu' => 'integer',
79			'oom_disabled' => 'integer',
80			'allocation_id' => 'integer',
81			'service_id' => 'integer',
82			'option_id' => 'integer',
83			'pack_id' => 'integer',
84			'installed' => 'integer',
85			];
86
87			/**
88			* @var array
89			*/
90			protected static $serverUUIDInstance = [];
91
92			/**
93			* @var mixed
94			*/
95			protected static $user;
96
97			/**
98			* Constructor.
99			*/
100			public function __construct()
101			{
102			parent::__construct();
103			self::$user = Auth::user();
104			}
105
106			/**
107			* Returns array of all servers owned by the logged in user.
108			* Returns all users servers if user is a root admin.
109			*
110			* @return \Illuminate\Database\Eloquent\Collection
111			*/
112			public static function getUserServers($paginate = null)
113			{
114			$query = self::select(
115			'servers.*',
116			'nodes.name as nodeName',
117			'locations.short as a_locationShort',
118			'allocations.ip',
119			'allocations.ip_alias',
120			'allocations.port',
121			'services.name as a_serviceName',
122			'service_options.name as a_serviceOptionName'
123			)->join('nodes', 'servers.node_id', '=', 'nodes.id')
124			->join('locations', 'nodes.location_id', '=', 'locations.id')
125			->join('services', 'servers.service_id', '=', 'services.id')
126			->join('service_options', 'servers.option_id', '=', 'service_options.id')
127			->join('allocations', 'servers.allocation_id', '=', 'allocations.id');
128
129			if (self::$user->root_admin !== 1) {
130			$query->whereIn('servers.id', Subuser::accessServers());
131			}
132
133			if (is_numeric($paginate)) {
134			return $query->paginate($paginate);
135			}
136
137			return $query->get();
138			}
139
140			/**
141			* Returns a single server specified by UUID.
142			* DO NOT USE THIS TO MODIFY SERVER DETAILS OR SAVE THOSE DETAILS.
143			* YOU WILL OVERWRITE THE SECRET KEY AND BREAK THINGS.
144			*
145			* @param string $uuid The Short-UUID of the server to return an object about.
146			* @return \Illuminate\Database\Eloquent\Collection
147			*/
148			public static function byUuid($uuid)
149			{
150			$query = self::with('service', 'node')->where('uuidShort', $uuid)->orWhere('uuid', $uuid);
			0 ignored issues – show Bug introduced 2017-02-02 23:25 UTC by Report Bug Copy Issue Report The method `where` 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...
151
152			if (! Auth::user()->isRootAdmin()) {
153			$query->whereIn('id', Subuser::accessServers());
154			}
155
156			$result = $query->first();
157
158			if (! is_null($result)) {
159			$result->daemonSecret = Auth::user()->daemonToken($result);
160			}
161
162			return $result;
163			}
164
165			/**
166			* Returns non-administrative headers for accessing a server on the daemon.
167			*
168			* @param string $uuid
			0 ignored issues – show Bug introduced 2017-02-02 23:25 UTC by Report Bug Copy Issue Report There is no parameter named `$uuid`. Was it maybe removed? This check looks for PHPDoc comments describing methods or function parameters that do not exist on the corresponding method or function. Consider the following example. The parameter `$italy` is not defined by the method `finale(...)`. /** * @param array $germany * @param array $island * @param array $italy */ function finale($germany, $island) { return "2:1"; } The most likely cause is that the parameter was removed, but the annotation was not. Loading history...
169			* @return array
170			*/
171			public function guzzleHeaders()
172			{
173			return [
174			'X-Access-Server' => $this->uuid,
			0 ignored issues – show Documentation introduced 2017-02-02 23:25 UTC by Report Bug Copy Issue Report The property `uuid` does not exist on `object<Pterodactyl\Models\Server>`. 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...
175			'X-Access-Token' => Auth::user()->daemonToken($this),
176			];
177			}
178
179			/**
180			* Return an instance of the Guzzle client for this specific server using defined access token.
181			*
182			* @return \GuzzleHttp\Client
183			*/
184			public function guzzleClient()
185			{
186			return $this->node->guzzleClient($this->guzzleHeaders());
			0 ignored issues – show Documentation introduced 2017-02-03 00:44 UTC by Report Bug Copy Issue Report The property `node` does not exist on `object<Pterodactyl\Models\Server>`. 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...
187			}
188
189			/**
190			* Returns javascript object to be embedded on server view pages with relevant information.
191			*
192			* @return \Laracasts\Utilities\JavaScript\JavaScriptFacade
193			*/
194			public function js($additional = null, $overwrite = null)
195			{
196			$response = [
197			'server' => collect($this->makeVisible('daemonSecret'))->only([
198			'uuid',
199			'uuidShort',
200			'daemonSecret',
201			'username',
202			]),
203			'node' => collect($this->node)->only([
			0 ignored issues – show Documentation introduced 2017-02-03 00:44 UTC by Report Bug Copy Issue Report The property `node` does not exist on `object<Pterodactyl\Models\Server>`. 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...
204			'fqdn',
205			'scheme',
206			'daemonListen',
207			]),
208			];
209
210			if (is_array($additional)) {
211			$response = array_merge($response, $additional);
212			}
213
214			if (is_array($overwrite)) {
215			$response = $overwrite;
216			}
217
218			return Javascript::put($response);
219			}
220
221			/**
222			* Gets the user who owns the server.
223			*
224			* @return \Illuminate\Database\Eloquent\Relations\BelongsTo
225			*/
226			public function user()
227			{
228			return $this->belongsTo(User::class, 'owner_id');
229			}
230
231			/**
232			* Gets all allocations associated with this server.
233			*
234			* @return \Illuminate\Database\Eloquent\Relations\HasMany
235			*/
236			public function allocations()
237			{
238			return $this->hasMany(Allocation::class, 'server_id');
239			}
240
241			/**
242			* Gets information for the pack associated with this server.
243			*
244			* @return \Illuminate\Database\Eloquent\Relations\HasOne
245			*/
246			public function pack()
247			{
248			return $this->hasOne(ServicePack::class, 'id', 'pack_id');
249			}
250
251			/**
252			* Gets information for the service associated with this server.
253			*
254			* @return \Illuminate\Database\Eloquent\Relations\BelongsTo
255			*/
256			public function service()
257			{
258			return $this->belongsTo(Service::class);
259			}
260
261			/**
262			* Gets information for the service option associated with this server.
263			*
264			* @return \Illuminate\Database\Eloquent\Relations\BelongsTo
265			*/
266			public function option()
267			{
268			return $this->belongsTo(ServiceOptions::class);
269			}
270
271			/**
272			* Gets information for the service variables associated with this server.
273			*
274			* @return \Illuminate\Database\Eloquent\Relations\HasMany
275			*/
276			public function variables()
277			{
278			return $this->hasMany(ServerVariables::class);
279			}
280
281			/**
282			* Gets information for the node associated with this server.
283			*
284			* @return \Illuminate\Database\Eloquent\Relations\BelongsTo
285			*/
286			public function node()
287			{
288			return $this->belongsTo(Node::class);
289			}
290
291			/**
292			* Gets information for the tasks associated with this server.
293			*
294			* @TODO adjust server column in tasks to be server_id
295			* @return \Illuminate\Database\Eloquent\Relations\HasMany
296			*/
297			public function tasks()
298			{
299			return $this->hasMany(Task::class, 'server', 'id');
300			}
301			}
302

Pterodactyl / Panel

GitHub Access Token became invalid

Pull Request — develop (#286)

Server::guzzleClient() A

Complexity

Size

Duplication

Importance

Available Fixes

Duplication Side-by-Side

Filter issues like