NoCaptchaV2::getScriptSrc() - Code Metrics - Inspection of "Merge pull request #80 from ARCANEDEV/update-html" - ARCANEDEV/noCAPTCHA - Measure and Improve Code Quality continuously with Scrutinizer

Completed

Push — master ( 0b3f53...63947c )

by ARCANEDEV

created 2019-01-31 11:51 UTC

NoCaptchaV2::getScriptSrc() A

↳ Parent: NoCaptchaV2

Complexity

Conditions	4
Paths	8

Size

Total Lines

Duplication

Lines	0
Ratio	0 %

Code Coverage

Tests	8
CRAP Score	4

Importance

Changes

Metric	Value
cc	4
nc	8
nop	1
dl	0
loc	14
rs	9.7998
c	0
b	0
f	0
ccs	8
cts	8
cp	1
crap	4

<?php namespace Arcanedev\NoCaptcha;

use Arcanedev\Html\Elements\Button;
use Arcanedev\Html\Elements\Div;
use Arcanedev\NoCaptcha\Exceptions\InvalidArgumentException;
use Arcanedev\NoCaptcha\Utilities\ResponseV2;
use Illuminate\Support\Arr;

/**
 * Class     NoCaptchaV2
 *
 * @package  Arcanedev\NoCaptcha
 * @author   ARCANEDEV <[email protected]>
 */
class NoCaptchaV2 extends AbstractNoCaptcha
{
    /* -----------------------------------------------------------------
     |  Properties
     | -----------------------------------------------------------------
     */

    /**
     * Decides if we've already loaded the script file or not.
     *
     * @param bool
     */
    protected $scriptLoaded = false;

    /* -----------------------------------------------------------------
     |  Getters & Setters
     | -----------------------------------------------------------------
     */

    /**
     * Get script source link.
     *
     * @param  string|null  $callbackName
     *
     * @return string
     */
    private function getScriptSrc($callbackName = null)
    {
        $queries = [];

        if ($this->hasLang())
            Arr::set($queries, 'hl', $this->lang);

        if ($this->hasCallbackName($callbackName)) {
            Arr::set($queries, 'onload', $callbackName);
            Arr::set($queries, 'render', 'explicit');
        }

        return static::CLIENT_URL . (count($queries) ? '?' . http_build_query($queries) : '');
    }

    /* -----------------------------------------------------------------
     |  Main Methods
     | -----------------------------------------------------------------
     */

    /**
     * Display Captcha.
     *
     * @param  string|null  $name
     * @param  array        $attributes
     *
     * @return \Arcanedev\Html\Elements\Div
     */
    public function display($name = null, array $attributes = [])
    {
        return Div::make()->attributes(array_merge(
            static::prepareNameAttribute($name),
            $this->prepareAttributes($attributes)
        ));
    }

    /**
     * Display image Captcha.
     *
     * @param  string|null  $name
     * @param  array        $attributes
     *
     * @return \Arcanedev\Html\Elements\Div
     */
    public function image($name = null, array $attributes = [])
    {
        return $this->display($name, array_merge(
            $attributes,
            ['data-type' => 'image']
        ));
    }

    /**
     * Display audio Captcha.
     *
     * @param  string|null  $name
     * @param  array        $attributes
     *
     * @return \Arcanedev\Html\Elements\Div
     */
    public function audio($name = null, array $attributes = [])
    {
        return $this->display($name, array_merge(
            $attributes,
            ['data-type' => 'audio']
        ));
    }

    /**
     * Display an invisible Captcha (bind the challenge to a button).
     *
     * @param  string  $value
     * @param  array   $attributes
     *
     * @return \Arcanedev\Html\Elements\Button
     */
    public function button($value, array $attributes = [])
    {
        return Button::make()->text($value)->attributes(array_merge(
            ['data-callback' => 'onSubmit'],
            $this->prepareAttributes($attributes)
        ));
    }

    /**
     * Get script tag.
     *
     * @param  string|null  $callbackName
     *
     * @return \Illuminate\Support\HtmlString
     */
    public function script($callbackName = null)
    {
        $script = '';

        if ( ! $this->scriptLoaded) {
            $script = '<script src="'.$this->getScriptSrc($callbackName).'" async defer></script>';
            $this->scriptLoaded = true;
        }

        return $this->toHtmlString($script);
    }

    /**
     * Get the NoCaptcha API Script.
     *
     * @return \Illuminate\Support\HtmlString
     */
    public function getApiScript()
    {
        return $this->toHtmlString(
            "<script>
                window.noCaptcha = {
                    captchas: [],
                    reset: function(name) {
                        var captcha = window.noCaptcha.get(name);
        
                        if (captcha)
                            window.noCaptcha.resetById(captcha.id);
                    },
                    resetById: function(id) {
                        grecaptcha.reset(id);
                    },
                    get: function(name) {
                        return window.noCaptcha.find(function (captcha) {
                            return captcha.name === name;
                        });
                    },
                    getById: function(id) {
                        return window.noCaptcha.find(function (captcha) {
                            return captcha.id === id;
                        });
                    },
                    find: function(callback) {
                        return window.noCaptcha.captchas.find(callback);
                    },
                    render: function(name, sitekey) {
                        var captcha = {
                            id: grecaptcha.render(name, {'sitekey' : sitekey}),
                            name: name
                        };
                        
                        window.noCaptcha.captchas.push(captcha);
                        
                        return captcha;
                    }
                }
            </script>"
        );
    }

    /**
     * Get script tag with a callback function.
     *
     * @param  array   $captchas
     * @param  string  $callbackName
     *
     * @return \Illuminate\Support\HtmlString
     */
    public function scriptWithCallback(array $captchas, $callbackName = 'captchaRenderCallback')
    {
        $script = $this->script($callbackName)->toHtml();

        if ( ! empty($script) && ! empty($captchas)) {
            $script = implode(PHP_EOL, [
                $this->getApiScript()->toHtml(),
                '<script>',
                    "var $callbackName = function() {",
                        $this->renderCaptchas($captchas),
                    '};',
                '</script>',
                $script,
            ]);
        }

        return $this->toHtmlString($script);
    }

    /**
     * Rendering captchas with callback function.
     *
     * @param  array  $captchas
     *
     * @return string
     */
    private function renderCaptchas(array $captchas)
    {
        return implode(PHP_EOL, array_map(function($captcha) {
            return "if (document.getElementById('{$captcha}')) { window.noCaptcha.render('{$captcha}', '{$this->siteKey}'); }";
        }, $captchas));
    }

    /* -----------------------------------------------------------------
     |  Check Methods
     | -----------------------------------------------------------------
     */

    /**
     * Check if callback is not empty.
     *
     * @param  string|null  $callbackName
     *
     * @return bool
     */
    private function hasCallbackName($callbackName)
    {
        return ! (is_null($callbackName) || trim($callbackName) === '');
    }

    /* -----------------------------------------------------------------
     |  Other Methods
     | -----------------------------------------------------------------
     */

    /**
     * Parse the response.
     *
     * @param  string  $json
     *
     * @return \Arcanedev\NoCaptcha\Utilities\AbstractResponse|mixed
     */
    protected function parseResponse($json)
    {
        return ResponseV2::fromJson($json);
    }

    /**
     * Prepare the attributes.
     *
     * @param  array  $attributes
     *
     * @return array
     */
    private function prepareAttributes(array $attributes)
    {
        $attributes = array_merge(
            ['class' => 'g-recaptcha', 'data-sitekey' => $this->siteKey],
            array_filter($attributes)
        );

        self::checkDataAttribute($attributes, 'data-type', ['image', 'audio'], 'image');
        self::checkDataAttribute($attributes, 'data-theme', ['light', 'dark'], 'light');
        self::checkDataAttribute($attributes, 'data-size', ['normal', 'compact', 'invisible'], 'normal');
        self::checkDataAttribute($attributes, 'data-badge', ['bottomright', 'bottomleft', 'inline'], 'bottomright');

        return $attributes;
    }

    /**
     * Check the `data-*` attribute.
     *
     * @param  array   $attributes
     * @param  string  $name
     * @param  array   $supported
     * @param  string  $default
     */
    private static function checkDataAttribute(array &$attributes, $name, array $supported, $default)
    {
        $attribute = $attributes[$name] ?? null;

        if ( ! is_null($attribute)) {
            $attribute = (is_string($attribute) && in_array($attribute, $supported))
                ? strtolower(trim($attribute))
                : $default;

            $attributes[$name] = $attribute;
        }
    }

    /**
     * Prepare the name and id attributes.
     *
     * @param  string|null  $name
     *
     * @return array
     *
     * @throws \Arcanedev\NoCaptcha\Exceptions\InvalidArgumentException
     */
    protected static function prepareNameAttribute($name)
    {
        if (is_null($name))
            return [];

        if ($name === AbstractNoCaptcha::CAPTCHA_NAME) {
            throw new InvalidArgumentException(
                'The captcha name must be different from "' . AbstractNoCaptcha::CAPTCHA_NAME . '".'
            );
        }

        return array_combine(['id', 'name'], [$name, $name]);
    }
}


1		<?php namespace Arcanedev\NoCaptcha;
2
3		use Arcanedev\Html\Elements\Button;
4		use Arcanedev\Html\Elements\Div;
5		use Arcanedev\NoCaptcha\Exceptions\InvalidArgumentException;
6		use Arcanedev\NoCaptcha\Utilities\ResponseV2;
7		use Illuminate\Support\Arr;
8
9		/**
10		* Class NoCaptchaV2
11		*
12		* @package Arcanedev\NoCaptcha
13		* @author ARCANEDEV <[email protected]>
14		*/
15		class NoCaptchaV2 extends AbstractNoCaptcha
16		{
17		/* -----------------------------------------------------------------
18		\| Properties
19		\| -----------------------------------------------------------------
20		*/
21
22		/**
23		* Decides if we've already loaded the script file or not.
24		*
25		* @param bool
26		*/
27		protected $scriptLoaded = false;
28
29		/* -----------------------------------------------------------------
30		\| Getters & Setters
31		\| -----------------------------------------------------------------
32		*/
33
34		/**
35		* Get script source link.
36		*
37		* @param string\|null $callbackName
38		*
39		* @return string
40		*/
41	20	private function getScriptSrc($callbackName = null)
42		{
43	20	$queries = [];
44
45	20	if ($this->hasLang())
46	8	Arr::set($queries, 'hl', $this->lang);
47
48	20	if ($this->hasCallbackName($callbackName)) {
49	4	Arr::set($queries, 'onload', $callbackName);
50	4	Arr::set($queries, 'render', 'explicit');
51		}
52
53	20	return static::CLIENT_URL . (count($queries) ? '?' . http_build_query($queries) : '');
54		}
55
56		/* -----------------------------------------------------------------
57		\| Main Methods
58		\| -----------------------------------------------------------------
59		*/
60
61		/**
62		* Display Captcha.
63		*
64		* @param string\|null $name
65		* @param array $attributes
66		*
67		* @return \Arcanedev\Html\Elements\Div
68		*/
69	76	public function display($name = null, array $attributes = [])
70		{
71	76	return Div::make()->attributes(array_merge(
72	76	static::prepareNameAttribute($name),
73	64	$this->prepareAttributes($attributes)
74		));
75		}
76
77		/**
78		* Display image Captcha.
79		*
80		* @param string\|null $name
81		* @param array $attributes
82		*
83		* @return \Arcanedev\Html\Elements\Div
84		*/
85	12	public function image($name = null, array $attributes = [])
86		{
87	12	return $this->display($name, array_merge(
88	9	$attributes,
89	12	['data-type' => 'image']
90		));
91		}
92
93		/**
94		* Display audio Captcha.
95		*
96		* @param string\|null $name
97		* @param array $attributes
98		*
99		* @return \Arcanedev\Html\Elements\Div
100		*/
101	12	public function audio($name = null, array $attributes = [])
102		{
103	12	return $this->display($name, array_merge(
104	9	$attributes,
105	12	['data-type' => 'audio']
106		));
107		}
108
109		/**
110		* Display an invisible Captcha (bind the challenge to a button).
111		*
112		* @param string $value
113		* @param array $attributes
114		*
115		* @return \Arcanedev\Html\Elements\Button
116		*/
117	4	public function button($value, array $attributes = [])
118		{
119	4	return Button::make()->text($value)->attributes(array_merge(
120	4	['data-callback' => 'onSubmit'],
121	4	$this->prepareAttributes($attributes)
122		));
123		}
124
125		/**
126		* Get script tag.
127		*
128		* @param string\|null $callbackName
129		*
130		* @return \Illuminate\Support\HtmlString
131		*/
132	20	public function script($callbackName = null)
133		{
134	20	$script = '';
135
136	20	if ( ! $this->scriptLoaded) {
137	20	$script = '<script src="'.$this->getScriptSrc($callbackName).'" async defer></script>';
138	20	$this->scriptLoaded = true;
139		}
140
141	20	return $this->toHtmlString($script);
142		}
143
144		/**
145		* Get the NoCaptcha API Script.
146		*
147		* @return \Illuminate\Support\HtmlString
148		*/
149	4	public function getApiScript()
150		{
151	4	return $this->toHtmlString(
152	3	"<script>
153		window.noCaptcha = {
154		captchas: [],
155		reset: function(name) {
156		var captcha = window.noCaptcha.get(name);
157
158		if (captcha)
159		window.noCaptcha.resetById(captcha.id);
160		},
161		resetById: function(id) {
162		grecaptcha.reset(id);
163		},
164		get: function(name) {
165		return window.noCaptcha.find(function (captcha) {
166		return captcha.name === name;
167		});
168		},
169		getById: function(id) {
170		return window.noCaptcha.find(function (captcha) {
171		return captcha.id === id;
172		});
173		},
174		find: function(callback) {
175		return window.noCaptcha.captchas.find(callback);
176		},
177		render: function(name, sitekey) {
178		var captcha = {
179		id: grecaptcha.render(name, {'sitekey' : sitekey}),
180		name: name
181		};
182
183		window.noCaptcha.captchas.push(captcha);
184
185		return captcha;
186		}
187		}
188	1	</script>"
189		);
190		}
191
192		/**
193		* Get script tag with a callback function.
194		*
195		* @param array $captchas
196		* @param string $callbackName
197		*
198		* @return \Illuminate\Support\HtmlString
199		*/
200	4	public function scriptWithCallback(array $captchas, $callbackName = 'captchaRenderCallback')
201		{
202	4	$script = $this->script($callbackName)->toHtml();
203
204	4	if ( ! empty($script) && ! empty($captchas)) {
205	4	$script = implode(PHP_EOL, [
206	4	$this->getApiScript()->toHtml(),
207	4	'<script>',
208	4	"var $callbackName = function() {",
209	4	$this->renderCaptchas($captchas),
210	4	'};',
211	4	'</script>',
212	4	$script,
213		]);
214		}
215
216	4	return $this->toHtmlString($script);
217		}
218
219		/**
220		* Rendering captchas with callback function.
221		*
222		* @param array $captchas
223		*
224		* @return string
225		*/
226	4	private function renderCaptchas(array $captchas)
227		{
228		return implode(PHP_EOL, array_map(function($captcha) {
229	4	return "if (document.getElementById('{$captcha}')) { window.noCaptcha.render('{$captcha}', '{$this->siteKey}'); }";
230	4	}, $captchas));
231		}
232
233		/* -----------------------------------------------------------------
234		\| Check Methods
235		\| -----------------------------------------------------------------
236		*/
237
238		/**
239		* Check if callback is not empty.
240		*
241		* @param string\|null $callbackName
242		*
243		* @return bool
244		*/
245	20	private function hasCallbackName($callbackName)
246		{
247	20	return ! (is_null($callbackName) \|\| trim($callbackName) === '');
248		}
249
250		/* -----------------------------------------------------------------
251		\| Other Methods
252		\| -----------------------------------------------------------------
253		*/
254
255		/**
256		* Parse the response.
257		*
258		* @param string $json
259		*
260		* @return \Arcanedev\NoCaptcha\Utilities\AbstractResponse\|mixed
261		*/
262	12	protected function parseResponse($json)
263		{
264	12	return ResponseV2::fromJson($json);
265		}
266
267		/**
268		* Prepare the attributes.
269		*
270		* @param array $attributes
271		*
272		* @return array
273		*/
274	68	private function prepareAttributes(array $attributes)
275		{
276	68	$attributes = array_merge(
277	68	['class' => 'g-recaptcha', 'data-sitekey' => $this->siteKey],
278	51	array_filter($attributes)
279		);
280
281	68	self::checkDataAttribute($attributes, 'data-type', ['image', 'audio'], 'image');
282	68	self::checkDataAttribute($attributes, 'data-theme', ['light', 'dark'], 'light');
283	68	self::checkDataAttribute($attributes, 'data-size', ['normal', 'compact', 'invisible'], 'normal');
284	68	self::checkDataAttribute($attributes, 'data-badge', ['bottomright', 'bottomleft', 'inline'], 'bottomright');
285
286	68	return $attributes;
287		}
288
289		/**
290		* Check the `data-*` attribute.
291		*
292		* @param array $attributes
293		* @param string $name
294		* @param array $supported
295		* @param string $default
296		*/
297	68	private static function checkDataAttribute(array &$attributes, $name, array $supported, $default)
298		{
299	68	$attribute = $attributes[$name] ?? null;
300
301	68	if ( ! is_null($attribute)) {
302	60	$attribute = (is_string($attribute) && in_array($attribute, $supported))
303	44	? strtolower(trim($attribute))
304	60	: $default;
305
306	60	$attributes[$name] = $attribute;
307		}
308	68	}
309
310		/**
311		* Prepare the name and id attributes.
312		*
313		* @param string\|null $name
314		*
315		* @return array
316		*
317		* @throws \Arcanedev\NoCaptcha\Exceptions\InvalidArgumentException
318		*/
319	76	protected static function prepareNameAttribute($name)
320		{
321	76	if (is_null($name))
322	4	return [];
323
324	72	if ($name === AbstractNoCaptcha::CAPTCHA_NAME) {
325	12	throw new InvalidArgumentException(
326	12	'The captcha name must be different from "' . AbstractNoCaptcha::CAPTCHA_NAME . '".'
327		);
328		}
329
330	60	return array_combine(['id', 'name'], [$name, $name]);
331		}
332		}
333

ARCANEDEV / noCAPTCHA

Push — master ( 0b3f53...63947c )

NoCaptchaV2::getScriptSrc() A

Complexity

Size

Duplication

Code Coverage

Importance

Duplication Side-by-Side

Filter issues like