MacroServiceProvider::boot() - Code Metrics - Inspection of "Implement new API and Route Updates" - Pterodactyl/Panel - Measure and Improve Code Quality continuously with Scrutinizer

Completed

Pull Request — develop (#371)

by Dane

created 2017-04-09 23:16 UTC

MacroServiceProvider::boot() C

↳ Parent: MacroServiceProvider

Complexity

Conditions	7
Paths	1

Size

Total Lines	45
Code Lines	25

Duplication

Lines	0
Ratio	0 %

Importance

Changes

Metric	Value
dl	0
loc	45
rs	6.7272
c	0
b	0
f	0
cc	7
eloc	25
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\Providers;

use File;
use Cache;
use Carbon;
use Request;
use Pterodactyl\Models\APIKey;
use Illuminate\Support\ServiceProvider;

class MacroServiceProvider extends ServiceProvider
{
    /**
     * Bootstrap the application services.
     *
     * @return void
     */
    public function boot()
    {
        File::macro('humanReadableSize', function ($path, $precision = 2) {
            $size = File::size($path);
            static $units = ['B', 'kB', 'MB', 'GB', 'TB'];

            $i = 0;
            while (($size / 1024) > 0.9) {
                $size = $size / 1024;
                $i++;
            }

            return round($size, ($i < 2) ? 0 : $precision) . ' ' . $units[$i];
        });

        Request::macro('apiKey', function () {
            if (! Request::bearerToken()) {
''   == false // true
''   == null  // true
'ab' == false // false
'ab' == null  // false

// It is often better to use strict comparison
'' === false // false
'' === null  // false
                return false;
            }

            $parts = explode('.', Request::bearerToken());

            if (count($parts) === 2 && strlen($parts[0]) === APIKey::PUBLIC_KEY_LEN) {
                // Because the key itself isn't changing frequently, we simply cache this for
                // 15 minutes to speed up the API and keep requests flowing.
                return Cache::tags([
                    'ApiKeyMacro',
                    'ApiKeyMacro:Key:' . $parts[0],
                ])->remember('ApiKeyMacro.' . $parts[0], Carbon::now()->addMinutes(15), function () use ($parts) {
                    return APIKey::where('public', $parts[0])->first();
                });
            }

            return false;
        });

        Request::macro('apiKeyHasPermission', function ($permission) {
            $key = Request::apiKey();
            if (! $key) {
                return false;
            }

            return Request::user()->can($permission, $key);
        });
    }
}


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\Providers;
26
27			use File;
28			use Cache;
29			use Carbon;
30			use Request;
31			use Pterodactyl\Models\APIKey;
32			use Illuminate\Support\ServiceProvider;
33
34			class MacroServiceProvider extends ServiceProvider
35			{
36			/**
37			* Bootstrap the application services.
38			*
39			* @return void
40			*/
41			public function boot()
42			{
43			File::macro('humanReadableSize', function ($path, $precision = 2) {
44			$size = File::size($path);
45			static $units = ['B', 'kB', 'MB', 'GB', 'TB'];
46
47			$i = 0;
48			while (($size / 1024) > 0.9) {
49			$size = $size / 1024;
50			$i++;
51			}
52
53			return round($size, ($i < 2) ? 0 : $precision) . ' ' . $units[$i];
54			});
55
56			Request::macro('apiKey', function () {
57			if (! Request::bearerToken()) {
			0 ignored issues – show Bug Best Practice introduced 2017-04-09 23:18 UTC by Report Bug Copy Issue Report The expression `\Request::bearerToken()` of type `string\|null` is loosely compared to `false`; this is ambiguous if the string can be empty. You might want to explicitly use `=== null` instead. In PHP, under loose comparison (like `==`, or `!=`, or `switch` conditions), values of different types might be equal. For `string` values, the empty string `''` is a special case, in particular the following results might be unexpected: '' == false // true '' == null // true 'ab' == false // false 'ab' == null // false // It is often better to use strict comparison '' === false // false '' === null // false Loading history...
58			return false;
59			}
60
61			$parts = explode('.', Request::bearerToken());
62
63			if (count($parts) === 2 && strlen($parts[0]) === APIKey::PUBLIC_KEY_LEN) {
64			// Because the key itself isn't changing frequently, we simply cache this for
65			// 15 minutes to speed up the API and keep requests flowing.
66			return Cache::tags([
67			'ApiKeyMacro',
68			'ApiKeyMacro:Key:' . $parts[0],
69			])->remember('ApiKeyMacro.' . $parts[0], Carbon::now()->addMinutes(15), function () use ($parts) {
70			return APIKey::where('public', $parts[0])->first();
71			});
72			}
73
74			return false;
75			});
76
77			Request::macro('apiKeyHasPermission', function ($permission) {
78			$key = Request::apiKey();
79			if (! $key) {
80			return false;
81			}
82
83			return Request::user()->can($permission, $key);
84			});
85			}
86			}
87

Pterodactyl / Panel

GitHub Access Token became invalid

Pull Request — develop (#371)

MacroServiceProvider::boot() C

Complexity

Size

Duplication

Importance

Duplication Side-by-Side

Filter issues like