RecaptchaAdapter::getErrorCodes() - Code Metrics - Inspection of "integrating hCaptcha and ReCaptcha adapters" - softberg/quantum-php-core - Measure and Improve Code Quality continuously with Scrutinizer

Passed

Pull Request — master (#135)

unknown

created 2023-05-19 09:53 UTC

RecaptchaAdapter::getErrorCodes() B

↳ Parent: RecaptchaAdapter

Complexity

Conditions	10
Paths	2

Size

Total Lines	66
Code Lines	44

Duplication

Lines	0
Ratio	0 %

Importance

Changes	1
Bugs	0	Features	0

Metric	Value
cc	10
eloc	44
c	1
b	0
f	0
nc	2
nop	0
dl	0
loc	66
rs	7.6666

How to fix Long Method Complexity

<?php

namespace Quantum\Libraries\Captcha\Adapters;

use Quantum\Libraries\Captcha\CaptchaInterface;
use Quantum\Libraries\Curl\HttpClient;

class RecaptchaAdapter implements CaptchaInterface
{
    /**
     * ReCAPTCHA URL verifying
     *
     * @var string
     */
    const VERIFY_URL = 'https://www.google.com/recaptcha/api/siteverify';

    const CLIENT_API = 'https://www.google.com/recaptcha/api.js';

    /**
     * Public key
     *
     * @var string
     */
    private $sitekey;

    /**
     * Private key
     *
     * @var string
     */
    private $secretkey;

    /**
     * @var HttpClient
     */
    private $http;

    /**
     * Remote IP address
     *
     * @var string
     */
    protected $remoteIp = null;

    /**
     * Captcha type. Default : image
     *
     * @var string
     * @see https://developers.google.com/recaptcha/docs/display#config
     */
    protected $type = null;

    /**
     * @var RecaptchaAdapter
     */
    private static $instance = null;

    /**
     * List of errors
     *
     * @var array
     */
    protected $errorCodes = array();

    /**
     * RecaptchaAdapter
     *
     * @param array $params
     * @return void
     */
    private function __construct(array $params)
    {
        $this->http = new HttpClient();

        $this->secretkey = $params['secret_key'];
        $this->sitekey = $params['site_key'];
        $this->type = $params['type'];
    }

    /**
     * Get Instance
     * @param array $params
     * @return RecaptchaAdapter
     */
    public static function getInstance(array $params): RecaptchaAdapter
    {
        if (self::$instance === null) {
            self::$instance = new self($params);
        }

        return self::$instance;
    }

    /**
     * Generate the JS code of the captcha
     *
     * @return string
     */
    public function renderJs(): string
    {
        return '<script src="'. self::CLIENT_API .'"></script>';
    }

    /**
     * Generate the HTML code block for the captcha
     *
     * @param string $formIdentifier
     * @param array $attributes
     * @return string
     */
    public function display(string $formIdentifier = '', array $attributes = []): string
    {
        $captchaElement = '';
        if (strtolower($this->type) == 'visible'){
            $captchaElement = $this->getVisibleElement();
        } elseif (strtolower($this->type) == 'invisible') {
            $captchaElement = $this->getInvisibleElement($formIdentifier);
        }
        return $captchaElement;
    }

    /**
     * Checks the code given by the captcha
     *
     * @param string $response Response code after submitting form (usually $_POST['g-recaptcha-response'])
     * @return bool
     */
    public function verifyResponse(string $response, $clientIp = null): bool
    {
        if (is_null($this->secretkey))

            throw new \Exception('You must set your secret key');

        if (empty($response)) {

            $this->errorCodes = array('internal-empty-response');

            return false;
        }

        $query = array(
            'secret' => $this->secretkey,
            'response' => $response,
            'remoteip' => $this->remoteIp,
        );

        $url = self::VERIFY_URL . '?' . http_build_query($query);

        $this->http->createRequest($url)->setMethod('GET')->start();
        $response = (array)$this->http->getResponseBody();

        if (empty($response) || is_null($response) || !$response) {

            return false;
        }

        if (isset($response['error-codes'])) {
            $this->errorCodes = $response['error-codes'];
        }

        return $response['success'];
    }

    /**
     * Returns the errors encountered
     *
     * @return array Errors code and name
     */
    public function getErrorCodes(): array
    {
        $errors = array();

        if (count($this->errorCodes) > 0) {
            foreach ($this->errorCodes as $error) {
                switch ($error) {
                    case 'timeout-or-duplicate':
                        $errors[] = array(
                            'code' => $error,
                            'name' => 'Timeout or duplicate.',
                        );
                        break;

                    case 'missing-input-secret':
                        $errors[] = array(
                            'code' => $error,
                            'name' => 'The secret parameter is missing.',
                        );
                        break;

                    case 'invalid-input-secret':
                        $errors[] = array(
                            'code' => $error,
                            'name' => 'The secret parameter is invalid or malformed.',
                        );
                        break;

                    case 'missing-input-response':
                        $errors[] = array(
                            'code' => $error,
                            'name' => 'The response parameter is missing.',
                        );
                        break;

                    case 'invalid-input-response':
                        $errors[] = array(
                            'code' => $error,
                            'name' => 'The response parameter is invalid or malformed.',
                        );
                        break;

                    case 'bad-request':
                        $errors[] = array(
                            'code' => $error,
                            'name' => 'The request is invalid or malformed.',
                        );
                        break;

                    case 'internal-empty-response':
                        $errors[] = array(
                            'code' => $error,
                            'name' => 'The recaptcha response is required.',
                        );
                        break;

                    default:
                        $errors[] = array(
                            'code' => $error,
                            'name' => $error,
                        );
                }
            }
        }

        return $errors;
    }

    private function getInvisibleElement(string $formIdentifier): string
    {
        return '<script>
                 document.addEventListener("DOMContentLoaded", function() {
                    let button = document.getElementsByTagName("button");
                
                    button[0].setAttribute("data-sitekey", "' . $this->sitekey . '");
                    button[0].setAttribute("data-callback", "onSubmit");
                    button[0].setAttribute("data-action", "submit");
                    button[0].classList.add("g-recaptcha");
                 })
                
                function onSubmit (){
                    document.getElementById("'. $formIdentifier .'").submit();
                }
            </script>';
    }

    private function getVisibleElement(): string
    {
        $data = 'data-sitekey="' . $this->sitekey . '"';

        return '<div class="col s1 offset-s2 g-recaptcha" ' . $data . '></div>';
    }
}

1			<?php
2
3			namespace Quantum\Libraries\Captcha\Adapters;
4
5			use Quantum\Libraries\Captcha\CaptchaInterface;
6			use Quantum\Libraries\Curl\HttpClient;
7
8			class RecaptchaAdapter implements CaptchaInterface
9			{
10			/**
11			* ReCAPTCHA URL verifying
12			*
13			* @var string
14			*/
15			const VERIFY_URL = 'https://www.google.com/recaptcha/api/siteverify';
16
17			const CLIENT_API = 'https://www.google.com/recaptcha/api.js';
18
19			/**
20			* Public key
21			*
22			* @var string
23			*/
24			private $sitekey;
25
26			/**
27			* Private key
28			*
29			* @var string
30			*/
31			private $secretkey;
32
33			/**
34			* @var HttpClient
35			*/
36			private $http;
37
38			/**
39			* Remote IP address
40			*
41			* @var string
42			*/
43			protected $remoteIp = null;
44
45			/**
46			* Captcha type. Default : image
47			*
48			* @var string
49			* @see https://developers.google.com/recaptcha/docs/display#config
50			*/
51			protected $type = null;
52
53			/**
54			* @var RecaptchaAdapter
55			*/
56			private static $instance = null;
57
58			/**
59			* List of errors
60			*
61			* @var array
62			*/
63			protected $errorCodes = array();
64
65			/**
66			* RecaptchaAdapter
67			*
68			* @param array $params
69			* @return void
70			*/
71			private function __construct(array $params)
72			{
73			$this->http = new HttpClient();
74
75			$this->secretkey = $params['secret_key'];
76			$this->sitekey = $params['site_key'];
77			$this->type = $params['type'];
78			}
79
80			/**
81			* Get Instance
82			* @param array $params
83			* @return RecaptchaAdapter
84			*/
85			public static function getInstance(array $params): RecaptchaAdapter
86			{
87			if (self::$instance === null) {
88			self::$instance = new self($params);
89			}
90
91			return self::$instance;
92			}
93
94			/**
95			* Generate the JS code of the captcha
96			*
97			* @return string
98			*/
99			public function renderJs(): string
100			{
101			return '<script src="'. self::CLIENT_API .'"></script>';
102			}
103
104			/**
105			* Generate the HTML code block for the captcha
106			*
107			* @param string $formIdentifier
108			* @param array $attributes
109			* @return string
110			*/
111			public function display(string $formIdentifier = '', array $attributes = []): string
112			{
113			$captchaElement = '';
114			if (strtolower($this->type) == 'visible'){
115			$captchaElement = $this->getVisibleElement();
116			} elseif (strtolower($this->type) == 'invisible') {
117			$captchaElement = $this->getInvisibleElement($formIdentifier);
118			}
119			return $captchaElement;
120			}
121
122			/**
123			* Checks the code given by the captcha
124			*
125			* @param string $response Response code after submitting form (usually $_POST['g-recaptcha-response'])
126			* @return bool
127			*/
128			public function verifyResponse(string $response, $clientIp = null): bool
129			{
130			if (is_null($this->secretkey))
			0 ignored issues – show introduced 2023-04-13 13:45 UTC by Report Bug Copy Issue Report The condition `is_null($this->secretkey)` is always `false`. Loading history...
131			throw new \Exception('You must set your secret key');
132
133			if (empty($response)) {
134
135			$this->errorCodes = array('internal-empty-response');
136
137			return false;
138			}
139
140			$query = array(
141			'secret' => $this->secretkey,
142			'response' => $response,
143			'remoteip' => $this->remoteIp,
144			);
145
146			$url = self::VERIFY_URL . '?' . http_build_query($query);
147
148			$this->http->createRequest($url)->setMethod('GET')->start();
149			$response = (array)$this->http->getResponseBody();
150
151			if (empty($response) \|\| is_null($response) \|\| !$response) {
			0 ignored issues – show Bug Best Practice introduced 2023-04-13 13:45 UTC by Report Bug Copy Issue Report The expression `$response` of type `array` is implicitly converted to a boolean; are you sure this is intended? If so, consider using `empty($expr)` instead to make it clear that you intend to check for an array without elements. This check marks implicit conversions of arrays to boolean values in a comparison. While in PHP an empty array is considered to be equal (but not identical) to false, this is not always apparent. Consider making the comparison explicit by using `empty(..)` or `! empty(...)` instead. Loading history...
152			return false;
153			}
154
155			if (isset($response['error-codes'])) {
156			$this->errorCodes = $response['error-codes'];
157			}
158
159			return $response['success'];
160			}
161
162			/**
163			* Returns the errors encountered
164			*
165			* @return array Errors code and name
166			*/
167			public function getErrorCodes(): array
168			{
169			$errors = array();
170
171			if (count($this->errorCodes) > 0) {
172			foreach ($this->errorCodes as $error) {
173			switch ($error) {
174			case 'timeout-or-duplicate':
175			$errors[] = array(
176			'code' => $error,
177			'name' => 'Timeout or duplicate.',
178			);
179			break;
180
181			case 'missing-input-secret':
182			$errors[] = array(
183			'code' => $error,
184			'name' => 'The secret parameter is missing.',
185			);
186			break;
187
188			case 'invalid-input-secret':
189			$errors[] = array(
190			'code' => $error,
191			'name' => 'The secret parameter is invalid or malformed.',
192			);
193			break;
194
195			case 'missing-input-response':
196			$errors[] = array(
197			'code' => $error,
198			'name' => 'The response parameter is missing.',
199			);
200			break;
201
202			case 'invalid-input-response':
203			$errors[] = array(
204			'code' => $error,
205			'name' => 'The response parameter is invalid or malformed.',
206			);
207			break;
208
209			case 'bad-request':
210			$errors[] = array(
211			'code' => $error,
212			'name' => 'The request is invalid or malformed.',
213			);
214			break;
215
216			case 'internal-empty-response':
217			$errors[] = array(
218			'code' => $error,
219			'name' => 'The recaptcha response is required.',
220			);
221			break;
222
223			default:
224			$errors[] = array(
225			'code' => $error,
226			'name' => $error,
227			);
228			}
229			}
230			}
231
232			return $errors;
233			}
234
235			private function getInvisibleElement(string $formIdentifier): string
236			{
237			return '<script>
238			document.addEventListener("DOMContentLoaded", function() {
239			let button = document.getElementsByTagName("button");
240
241			button[0].setAttribute("data-sitekey", "' . $this->sitekey . '");
242			button[0].setAttribute("data-callback", "onSubmit");
243			button[0].setAttribute("data-action", "submit");
244			button[0].classList.add("g-recaptcha");
245			})
246
247			function onSubmit (){
248			document.getElementById("'. $formIdentifier .'").submit();
249			}
250			</script>';
251			}
252
253			private function getVisibleElement(): string
254			{
255			$data = 'data-sitekey="' . $this->sitekey . '"';
256
257			return '<div class="col s1 offset-s2 g-recaptcha" ' . $data . '></div>';
258			}
259			}

softberg / quantum-php-core

Pull Request — master (#135)

RecaptchaAdapter::getErrorCodes() B

Complexity

Size

Duplication

Importance

How to fix Long Method Complexity

Long Method

Duplication Side-by-Side

Filter issues like