Server::getTableColumns() - Code Metrics - Pterodactyl/Panel - Measure and Improve Code Quality continuously with Scrutinizer

Server::getTableColumns() A
last analyzed 2017-06-15 01:59 UTC

↳ 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 Cache;
use Carbon;
use Schema;
use Javascript;
use Illuminate\Database\Eloquent\Model;
use Illuminate\Notifications\Notifiable;
use Nicolaslopezj\Searchable\SearchableTrait;

class Server extends Model
{
    use Notifiable, SearchableTrait;

    /**
     * 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',
        'skip_scripts' => 'boolean',
        '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',
    ];

    /**
     * Parameters for search querying.
     *
     * @var array
     */
    protected $searchable = [
        'columns' => [
            'servers.name' => 10,
            'servers.username' => 10,
            'servers.uuidShort' => 9,
            'servers.uuid' => 8,
            'packs.name' => 7,
            'users.email' => 6,
            'users.username' => 6,
            'nodes.name' => 2,
        ],
        'joins' => [
            'packs' => ['packs.id', 'servers.pack_id'],
            'users' => ['users.id', 'servers.owner_id'],
            'nodes' => ['nodes.id', 'servers.node_id'],
        ],
    ];

    /**
     * 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
     * @param  array   $with
     * @param  array   $withCount
     * @return \Pterodactyl\Models\Server
     * @todo   Remove $with and $withCount due to cache issues, they aren't used anyways.
     */
    public static function byUuid($uuid, array $with = [], array $withCount = [])
    {
        if (! Auth::check()) {
            throw new \Exception('You must call Server:byUuid as an authenticated user.');
        }

        // Results are cached because we call this functions a few times on page load.
        $result = Cache::tags(['Model:Server', 'Model:Server:byUuid:' . $uuid])->remember('Model:Server:byUuid:' . $uuid . Auth::user()->uuid, Carbon::now()->addMinutes(15), function () use ($uuid) {
            $query = self::with('service', 'node')->where(function ($q) use ($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.
}
                $q->where('uuidShort', $uuid)->orWhere('uuid', $uuid);
            });

            if (! Auth::user()->isRootAdmin()) {
                $query->whereIn('id', Auth::user()->serverAccessArray());
            }

            return $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  Pterodactyl\Models\User|null  $user
     * @return array
     */
    public function guzzleHeaders(User $user = null)
    {
        // If no specific user is passed, see if we can find an active
        // auth session to pull data from.
        if (is_null($user) && Auth::check()) {
            $user = Auth::user();
        }

        return [
            'X-Access-Server' => $this->uuid,
            'X-Access-Token' => ($user) ? $user->daemonToken($this) : $this->daemonSecret,
        ];
    }

    /**
     * Return an instance of the Guzzle client for this specific server using defined access token.
     *
     * @param  Pterodactyl\Models\User|null  $user
     * @return \GuzzleHttp\Client
     */
    public function guzzleClient(User $user = null)
    {
        return $this->node->guzzleClient($this->guzzleHeaders($user));
    }

    /**
     * Returns javascript object to be embedded on server view pages with relevant information.
     *
     * @param  array|null  $additional
     * @param  array|null  $overwrite
     * @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([
                'fqdn',
                'scheme',
                'daemonListen',
            ]),
        ];

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

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

        return Javascript::put($response);
    }

    /**
     * Return the columns available for this table.
     *
     * @return array
     */
    public function getTableColumns()
    {
        return Schema::getColumnListing($this->getTable());
    }

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

    /**
     * Gets the subusers associated with a server.
     *
     * @return \Illuminate\Database\Eloquent\Relations\HasMany
     */
    public function subusers()
    {
        return $this->hasMany(Subuser::class);
    }

    /**
     * Gets the default allocation for a server.
     *
     * @return \Illuminate\Database\Eloquent\Relations\HasOne
     */
    public function allocation()
    {
        return $this->hasOne(Allocation::class, 'id', 'allocation_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\BelongsTo
     */
    public function pack()
    {
        return $this->belongsTo(Pack::class);
    }

    /**
     * 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(ServiceOption::class);
    }

    /**
     * Gets information for the service variables associated with this server.
     *
     * @return \Illuminate\Database\Eloquent\Relations\HasMany
     */
    public function variables()
    {
        return $this->hasMany(ServerVariable::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);
    }

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

    /**
     * Gets the location of the server.
     *
     * @return \Illuminate\Database\Eloquent\Relations\BelongsTo
     */
    public function location()
    {
        return $this->node->location();
    }
}


GitHub Access Token became invalid

Server::getTableColumns() A
last analyzed 2017-06-15 01:59 UTC

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 Cache;
29			use Carbon;
30			use Schema;
31			use Javascript;
32			use Illuminate\Database\Eloquent\Model;
33			use Illuminate\Notifications\Notifiable;
34			use Nicolaslopezj\Searchable\SearchableTrait;
35
36			class Server extends Model
37			{
38			use Notifiable, SearchableTrait;
39
40			/**
41			* The table associated with the model.
42			*
43			* @var string
44			*/
45			protected $table = 'servers';
46
47			/**
48			* The attributes excluded from the model's JSON form.
49			*
50			* @var array
51			*/
52			protected $hidden = ['daemonSecret', 'sftp_password'];
53
54			/**
55			* The attributes that should be mutated to dates.
56			*
57			* @var array
58			*/
59			protected $dates = ['deleted_at'];
60
61			/**
62			* Fields that are not mass assignable.
63			*
64			* @var array
65			*/
66			protected $guarded = ['id', 'installed', 'created_at', 'updated_at', 'deleted_at'];
67
68			/**
69			* Cast values to correct type.
70			*
71			* @var array
72			*/
73			protected $casts = [
74			'node_id' => 'integer',
75			'skip_scripts' => 'boolean',
76			'suspended' => 'integer',
77			'owner_id' => 'integer',
78			'memory' => 'integer',
79			'swap' => 'integer',
80			'disk' => 'integer',
81			'io' => 'integer',
82			'cpu' => 'integer',
83			'oom_disabled' => 'integer',
84			'allocation_id' => 'integer',
85			'service_id' => 'integer',
86			'option_id' => 'integer',
87			'pack_id' => 'integer',
88			'installed' => 'integer',
89			];
90
91			/**
92			* Parameters for search querying.
93			*
94			* @var array
95			*/
96			protected $searchable = [
97			'columns' => [
98			'servers.name' => 10,
99			'servers.username' => 10,
100			'servers.uuidShort' => 9,
101			'servers.uuid' => 8,
102			'packs.name' => 7,
103			'users.email' => 6,
104			'users.username' => 6,
105			'nodes.name' => 2,
106			],
107			'joins' => [
108			'packs' => ['packs.id', 'servers.pack_id'],
109			'users' => ['users.id', 'servers.owner_id'],
110			'nodes' => ['nodes.id', 'servers.node_id'],
111			],
112			];
113
114			/**
115			* Returns a single server specified by UUID.
116			* DO NOT USE THIS TO MODIFY SERVER DETAILS OR SAVE THOSE DETAILS.
117			* YOU WILL OVERWRITE THE SECRET KEY AND BREAK THINGS.
118			*
119			* @param string $uuid
120			* @param array $with
121			* @param array $withCount
122			* @return \Pterodactyl\Models\Server
123			* @todo Remove $with and $withCount due to cache issues, they aren't used anyways.
124			*/
125			public static function byUuid($uuid, array $with = [], array $withCount = [])
126			{
127			if (! Auth::check()) {
128			throw new \Exception('You must call Server:byUuid as an authenticated user.');
129			}
130
131			// Results are cached because we call this functions a few times on page load.
132			$result = Cache::tags(['Model:Server', 'Model:Server:byUuid:' . $uuid])->remember('Model:Server:byUuid:' . $uuid . Auth::user()->uuid, Carbon::now()->addMinutes(15), function () use ($uuid) {
133			$query = self::with('service', 'node')->where(function ($q) use ($uuid) {
			0 ignored issues – show Bug introduced 2017-02-06 01:01 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...
134			$q->where('uuidShort', $uuid)->orWhere('uuid', $uuid);
135			});
136
137			if (! Auth::user()->isRootAdmin()) {
138			$query->whereIn('id', Auth::user()->serverAccessArray());
139			}
140
141			return $query->first();
142			});
143
144			if (! is_null($result)) {
145			$result->daemonSecret = Auth::user()->daemonToken($result);
146			}
147
148			return $result;
149			}
150
151			/**
152			* Returns non-administrative headers for accessing a server on the daemon.
153			*
154			* @param Pterodactyl\Models\User\|null $user
155			* @return array
156			*/
157			public function guzzleHeaders(User $user = null)
158			{
159			// If no specific user is passed, see if we can find an active
160			// auth session to pull data from.
161			if (is_null($user) && Auth::check()) {
162			$user = Auth::user();
163			}
164
165			return [
166			'X-Access-Server' => $this->uuid,
167			'X-Access-Token' => ($user) ? $user->daemonToken($this) : $this->daemonSecret,
168			];
169			}
170
171			/**
172			* Return an instance of the Guzzle client for this specific server using defined access token.
173			*
174			* @param Pterodactyl\Models\User\|null $user
175			* @return \GuzzleHttp\Client
176			*/
177			public function guzzleClient(User $user = null)
178			{
179			return $this->node->guzzleClient($this->guzzleHeaders($user));
180			}
181
182			/**
183			* Returns javascript object to be embedded on server view pages with relevant information.
184			*
185			* @param array\|null $additional
186			* @param array\|null $overwrite
187			* @return \Laracasts\Utilities\JavaScript\JavaScriptFacade
188			*/
189			public function js($additional = null, $overwrite = null)
190			{
191			$response = [
192			'server' => collect($this->makeVisible('daemonSecret'))->only([
193			'uuid',
194			'uuidShort',
195			'daemonSecret',
196			'username',
197			]),
198			'node' => collect($this->node)->only([
199			'fqdn',
200			'scheme',
201			'daemonListen',
202			]),
203			];
204
205			if (is_array($additional)) {
206			$response = array_merge($response, $additional);
207			}
208
209			if (is_array($overwrite)) {
210			$response = $overwrite;
211			}
212
213			return Javascript::put($response);
214			}
215
216			/**
217			* Return the columns available for this table.
218			*
219			* @return array
220			*/
221			public function getTableColumns()
222			{
223			return Schema::getColumnListing($this->getTable());
224			}
225
226			/**
227			* Gets the user who owns the server.
228			*
229			* @return \Illuminate\Database\Eloquent\Relations\BelongsTo
230			*/
231			public function user()
232			{
233			return $this->belongsTo(User::class, 'owner_id');
234			}
235
236			/**
237			* Gets the subusers associated with a server.
238			*
239			* @return \Illuminate\Database\Eloquent\Relations\HasMany
240			*/
241			public function subusers()
242			{
243			return $this->hasMany(Subuser::class);
244			}
245
246			/**
247			* Gets the default allocation for a server.
248			*
249			* @return \Illuminate\Database\Eloquent\Relations\HasOne
250			*/
251			public function allocation()
252			{
253			return $this->hasOne(Allocation::class, 'id', 'allocation_id');
254			}
255
256			/**
257			* Gets all allocations associated with this server.
258			*
259			* @return \Illuminate\Database\Eloquent\Relations\HasMany
260			*/
261			public function allocations()
262			{
263			return $this->hasMany(Allocation::class, 'server_id');
264			}
265
266			/**
267			* Gets information for the pack associated with this server.
268			*
269			* @return \Illuminate\Database\Eloquent\Relations\BelongsTo
270			*/
271			public function pack()
272			{
273			return $this->belongsTo(Pack::class);
274			}
275
276			/**
277			* Gets information for the service associated with this server.
278			*
279			* @return \Illuminate\Database\Eloquent\Relations\BelongsTo
280			*/
281			public function service()
282			{
283			return $this->belongsTo(Service::class);
284			}
285
286			/**
287			* Gets information for the service option associated with this server.
288			*
289			* @return \Illuminate\Database\Eloquent\Relations\BelongsTo
290			*/
291			public function option()
292			{
293			return $this->belongsTo(ServiceOption::class);
294			}
295
296			/**
297			* Gets information for the service variables associated with this server.
298			*
299			* @return \Illuminate\Database\Eloquent\Relations\HasMany
300			*/
301			public function variables()
302			{
303			return $this->hasMany(ServerVariable::class);
304			}
305
306			/**
307			* Gets information for the node associated with this server.
308			*
309			* @return \Illuminate\Database\Eloquent\Relations\BelongsTo
310			*/
311			public function node()
312			{
313			return $this->belongsTo(Node::class);
314			}
315
316			/**
317			* Gets information for the tasks associated with this server.
318			*
319			* @TODO adjust server column in tasks to be server_id
320			* @return \Illuminate\Database\Eloquent\Relations\HasMany
321			*/
322			public function tasks()
323			{
324			return $this->hasMany(Task::class);
325			}
326
327			/**
328			* Gets all databases associated with a server.
329			*
330			* @return \Illuminate\Database\Eloquent\Relations\HasMany
331			*/
332			public function databases()
333			{
334			return $this->hasMany(Database::class);
335			}
336
337			/**
338			* Gets the location of the server.
339			*
340			* @return \Illuminate\Database\Eloquent\Relations\BelongsTo
341			*/
342			public function location()
343			{
344			return $this->node->location();
345			}
346			}
347

Pterodactyl / Panel

GitHub Access Token became invalid

Server::getTableColumns() A last analyzed 2017-06-15 01:59 UTC

Complexity

Size

Duplication

Importance

Available Fixes

Duplication Side-by-Side

Filter issues like

Server::getTableColumns() A
last analyzed 2017-06-15 01:59 UTC