Server::downloads() - Code Metrics - Inspection of "Fix server deletion logic, and clean up suspend/un..." - Pterodactyl/Panel - Measure and Improve Code Quality continuously with Scrutinizer

Completed

Push — develop ( 91ce97...de923b )

by Dane

created 2017-04-18 00:16 UTC

Server::downloads() A

↳ Parent: Server

Complexity

Conditions	1
Paths	1

Size

Total Lines	4
Code Lines	2

Duplication

Lines	0
Ratio	0 %

Importance

Changes

Metric	Value
c	0
b	0
f	0
dl	0
loc	4
rs	10
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',
        '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 all downloads associated with a server.
     *
     * @return \Illuminate\Database\Eloquent\Relations\HasMany
     */
    public function downloads()
    {
        return $this->hasMany(Download::class, 'server', 'id');
    }

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


GitHub Access Token became invalid

Push — develop ( 91ce97...de923b )

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

Pterodactyl / Panel

GitHub Access Token became invalid

Push — develop ( 91ce97...de923b )

Server::downloads() A

Complexity

Size

Duplication

Importance

Available Fixes

Duplication Side-by-Side

Filter issues like