ReCaptchaBuilder::htmlScriptTagJsApiV3() - Code Metrics - Inspection of "Merge branch 'release/v3'" - biscolab/laravel-recaptcha - Measure and Improve Code Quality continuously with Scrutinizer

Passed

Push — master ( 26f295...e4804f )

by Roberto

created 2019-01-31 00:38 UTC

ReCaptchaBuilder::htmlScriptTagJsApiV3() A

↳ Parent: ReCaptchaBuilder

Complexity

Conditions	1
Paths	1

Size

Total Lines	2
Code Lines	1

Duplication

Lines	0
Ratio	0 %

Importance

Changes

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

<?php
/**
 * Copyright (c) 2017 - present
 * LaravelGoogleRecaptcha - ReCaptchaBuilder.php
 * author: Roberto Belotti - [email protected]
 * web : robertobelotti.com, github.com/biscolab
 * Initial version created on: 12/9/2018
 * MIT license: https://github.com/biscolab/laravel-recaptcha/blob/master/LICENSE
 */

namespace Biscolab\ReCaptcha;

use Exception;

class ReCaptchaBuilder {

    /**
     * The Site key
     * please visit https://developers.google.com/recaptcha/docs/start
     * @var string
     */
    protected $api_site_key;

    /**
     * The Secret key
     * please visit https://developers.google.com/recaptcha/docs/start
     * @var string
     */
    protected $api_secret_key;

    /**
     * The chosen ReCAPTCHA version
     * please visit https://developers.google.com/recaptcha/docs/start
     * @var string
     */
    protected $version;

    /**
     * Whether is true the ReCAPTCHA is inactive
     * @var boolean
     */
    protected $skip_by_ip = false;

    /**
     * The API request URI
     */
    protected $api_url = 'https://www.google.com/recaptcha/api/siteverify';

    public function __construct($api_site_key, $api_secret_key, $version = 'v2') {

        $this->setApiSiteKey($api_site_key);
        $this->setApiSecretKey($api_secret_key);
        $this->setVersion($version);
        $this->setSkipByIp($this->skipByIp());
    }

    /**
     * @param string $api_site_key
     *
     * @return ReCaptchaBuilder
     */
    public function setApiSiteKey(string $api_site_key): ReCaptchaBuilder{
        $this->api_site_key = $api_site_key;

        return $this;
    }

    /**
     * @param string $api_secret_key
     *
     * @return ReCaptchaBuilder
     */
    public function setApiSecretKey(string $api_secret_key): ReCaptchaBuilder{
        $this->api_secret_key = $api_secret_key;

        return $this;
    }

    /**
     * @param string $version
     *
     * @return ReCaptchaBuilder
     */
    public function setVersion(string $version): ReCaptchaBuilder{
        $this->version = $version;

        return $this;
    }

    /**
     * @return string
     */
    public function getVersion(): string {
        return $this->version;
    }

    /**
     * @param bool $skip_by_ip
     *
     * @return ReCaptchaBuilder
     */
    public function setSkipByIp(bool $skip_by_ip): ReCaptchaBuilder {
        $this->skip_by_ip = $skip_by_ip;

        return $this;
    }

    /**
     * Checks whether the user IP address is among IPs "to be skipped"
     *
     * @return boolean
     */
    public function skipByIp(): bool {

        return (in_array(request()->ip(), config('recaptcha.skip_ip', [])));
    }

    /**
     * Write script HTML tag in you HTML code
     * Insert before </head> tag
     *
     * @param string|null    $formId
     * @param array|null $configuration
     *
     * @return string
     * @throws Exception
     */
    public function htmlScriptTagJsApi(?string $formId = '', ?array $configuration = []): string {

        if ($this->skip_by_ip) {
            return '';
        }

        switch ($this->version) {
            case 'v3':
                $html = "<script src=\"https://www.google.com/recaptcha/api.js?render={$this->api_site_key}\"></script>";
                break;
            default:
                $html = "<script src=\"https://www.google.com/recaptcha/api.js\" async defer></script>";
        }

        if ($this->version == 'invisible') {
            if (!$formId) {
                throw new Exception("formId required", 1);
            }
            $html .= '<script>
		       function biscolabLaravelReCaptcha(token) {
		         document.getElementById("' . $formId . '").submit();
		       }
		     </script>';
        }
        elseif ($this->version == 'v3') {

            $action = array_get($configuration, 'action', 'homepage');

            $js_custom_validation = array_get($configuration, 'custom_validation', '');

            // Check if set custom_validation. That function will override default fetch validation function
            if($js_custom_validation) {

                $validate_function = ($js_custom_validation) ? "{$js_custom_validation}(token);" : '';
            }
            else {

                $js_then_callback = array_get($configuration, 'callback_then', '');
                $js_callback_catch = array_get($configuration, 'callback_catch', '');

                $js_then_callback = ($js_then_callback) ? "{$js_then_callback}(response)" : '';
                $js_callback_catch = ($js_callback_catch) ? "{$js_callback_catch}(err)" : '';

                $validate_function = "
                fetch('/" . config('recaptcha.default_validation_route', 'biscolab-recaptcha/validate') . "?" . config('recaptcha.default_token_parameter_name', 'token') . "=' + token, {
                    headers: {
                        \"X-Requested-With\": \"XMLHttpRequest\",
                        \"X-CSRF-TOKEN\": csrfToken.content
                    }
                })
                .then(function(response) {
                   	{$js_then_callback}
                })
                .catch(function(err) {
                    {$js_callback_catch}
                });";
            }

            $html .= "<script>
                    var csrfToken = document.head.querySelector('meta[name=\"csrf-token\"]');
                  grecaptcha.ready(function() {
                      grecaptcha.execute('{$this->api_site_key}', {action: '{$action}'}).then(function(token) {
                        {$validate_function}
                      });
                  });
		     </script>";
        }

        return $html;
    }

    /**
     * @param array|null $configuration
     *
     * @return string
     */
    public function htmlScriptTagJsApiV3(?array $configuration = []): string {
        return $this->htmlScriptTagJsApi('', $configuration);
    }

    /**
     * Call out to reCAPTCHA and process the response
     *
     * @param string $response
     *
     * @return boolean
     */
    public function validate($response) {

        if ($this->skip_by_ip) {
            return true;
        }

        $params = http_build_query([
            'secret'   => $this->api_secret_key,
            'remoteip' => request()->getClientIp(),
            'response' => $response,
        ]);

        $url = $this->api_url . '?' . $params;

        if (function_exists('curl_version')) {
            $curl = curl_init($url);
            curl_setopt($curl, CURLOPT_HEADER, false);
            curl_setopt($curl, CURLOPT_RETURNTRANSFER, true);
            curl_setopt($curl, CURLOPT_TIMEOUT, 1);
            curl_setopt($curl, CURLOPT_SSL_VERIFYPEER, false);
            $curl_response = curl_exec($curl);
        } else {
            $curl_response = file_get_contents($url);
        }
        if (is_null($curl_response) || empty($curl_response)) {
            return false;
        }
        $response = json_decode(trim($curl_response), true);

        if($this->version == 'v3') {
            return $response;
        }

        return $response['success'];

    }
}

1			<?php
2			/**
3			* Copyright (c) 2017 - present
4			* LaravelGoogleRecaptcha - ReCaptchaBuilder.php
5			* author: Roberto Belotti - [email protected]
6			* web : robertobelotti.com, github.com/biscolab
7			* Initial version created on: 12/9/2018
8			* MIT license: https://github.com/biscolab/laravel-recaptcha/blob/master/LICENSE
9			*/
10
11			namespace Biscolab\ReCaptcha;
12
13			use Exception;
14
15			class ReCaptchaBuilder {
16
17			/**
18			* The Site key
19			* please visit https://developers.google.com/recaptcha/docs/start
20			* @var string
21			*/
22			protected $api_site_key;
23
24			/**
25			* The Secret key
26			* please visit https://developers.google.com/recaptcha/docs/start
27			* @var string
28			*/
29			protected $api_secret_key;
30
31			/**
32			* The chosen ReCAPTCHA version
33			* please visit https://developers.google.com/recaptcha/docs/start
34			* @var string
35			*/
36			protected $version;
37
38			/**
39			* Whether is true the ReCAPTCHA is inactive
40			* @var boolean
41			*/
42			protected $skip_by_ip = false;
43
44			/**
45			* The API request URI
46			*/
47			protected $api_url = 'https://www.google.com/recaptcha/api/siteverify';
48
49			public function __construct($api_site_key, $api_secret_key, $version = 'v2') {
50
51			$this->setApiSiteKey($api_site_key);
52			$this->setApiSecretKey($api_secret_key);
53			$this->setVersion($version);
54			$this->setSkipByIp($this->skipByIp());
55			}
56
57			/**
58			* @param string $api_site_key
59			*
60			* @return ReCaptchaBuilder
61			*/
62			public function setApiSiteKey(string $api_site_key): ReCaptchaBuilder{
63			$this->api_site_key = $api_site_key;
64
65			return $this;
66			}
67
68			/**
69			* @param string $api_secret_key
70			*
71			* @return ReCaptchaBuilder
72			*/
73			public function setApiSecretKey(string $api_secret_key): ReCaptchaBuilder{
74			$this->api_secret_key = $api_secret_key;
75
76			return $this;
77			}
78
79			/**
80			* @param string $version
81			*
82			* @return ReCaptchaBuilder
83			*/
84			public function setVersion(string $version): ReCaptchaBuilder{
85			$this->version = $version;
86
87			return $this;
88			}
89
90			/**
91			* @return string
92			*/
93			public function getVersion(): string {
94			return $this->version;
95			}
96
97			/**
98			* @param bool $skip_by_ip
99			*
100			* @return ReCaptchaBuilder
101			*/
102			public function setSkipByIp(bool $skip_by_ip): ReCaptchaBuilder {
103			$this->skip_by_ip = $skip_by_ip;
104
105			return $this;
106			}
107
108			/**
109			* Checks whether the user IP address is among IPs "to be skipped"
110			*
111			* @return boolean
112			*/
113			public function skipByIp(): bool {
114
115			return (in_array(request()->ip(), config('recaptcha.skip_ip', [])));
116			}
117
118			/**
119			* Write script HTML tag in you HTML code
120			* Insert before </head> tag
121			*
122			* @param string\|null $formId
123			* @param array\|null $configuration
124			*
125			* @return string
126			* @throws Exception
127			*/
128			public function htmlScriptTagJsApi(?string $formId = '', ?array $configuration = []): string {
129
130			if ($this->skip_by_ip) {
131			return '';
132			}
133
134			switch ($this->version) {
135			case 'v3':
136			$html = "<script src=\"https://www.google.com/recaptcha/api.js?render={$this->api_site_key}\"></script>";
137			break;
138			default:
139			$html = "<script src=\"https://www.google.com/recaptcha/api.js\" async defer></script>";
140			}
141
142			if ($this->version == 'invisible') {
143			if (!$formId) {
144			throw new Exception("formId required", 1);
145			}
146			$html .= '<script>
147			function biscolabLaravelReCaptcha(token) {
148			document.getElementById("' . $formId . '").submit();
149			}
150			</script>';
151			}
152			elseif ($this->version == 'v3') {
153
154			$action = array_get($configuration, 'action', 'homepage');
155
156			$js_custom_validation = array_get($configuration, 'custom_validation', '');
157
158			// Check if set custom_validation. That function will override default fetch validation function
159			if($js_custom_validation) {
160
161			$validate_function = ($js_custom_validation) ? "{$js_custom_validation}(token);" : '';
162			}
163			else {
164
165			$js_then_callback = array_get($configuration, 'callback_then', '');
166			$js_callback_catch = array_get($configuration, 'callback_catch', '');
167
168			$js_then_callback = ($js_then_callback) ? "{$js_then_callback}(response)" : '';
169			$js_callback_catch = ($js_callback_catch) ? "{$js_callback_catch}(err)" : '';
170
171			$validate_function = "
172			fetch('/" . config('recaptcha.default_validation_route', 'biscolab-recaptcha/validate') . "?" . config('recaptcha.default_token_parameter_name', 'token') . "=' + token, {
173			headers: {
174			\"X-Requested-With\": \"XMLHttpRequest\",
175			\"X-CSRF-TOKEN\": csrfToken.content
176			}
177			})
178			.then(function(response) {
179			{$js_then_callback}
180			})
181			.catch(function(err) {
182			{$js_callback_catch}
183			});";
184			}
185
186			$html .= "<script>
187			var csrfToken = document.head.querySelector('meta[name=\"csrf-token\"]');
188			grecaptcha.ready(function() {
189			grecaptcha.execute('{$this->api_site_key}', {action: '{$action}'}).then(function(token) {
190			{$validate_function}
191			});
192			});
193			</script>";
194			}
195
196			return $html;
197			}
198
199			/**
200			* @param array\|null $configuration
201			*
202			* @return string
203			*/
204			public function htmlScriptTagJsApiV3(?array $configuration = []): string {
205			return $this->htmlScriptTagJsApi('', $configuration);
206			}
207
208			/**
209			* Call out to reCAPTCHA and process the response
210			*
211			* @param string $response
212			*
213			* @return boolean
214			*/
215			public function validate($response) {
216
217			if ($this->skip_by_ip) {
218			return true;
219			}
220
221			$params = http_build_query([
222			'secret' => $this->api_secret_key,
223			'remoteip' => request()->getClientIp(),
224			'response' => $response,
225			]);
226
227			$url = $this->api_url . '?' . $params;
228
229			if (function_exists('curl_version')) {
230			$curl = curl_init($url);
231			curl_setopt($curl, CURLOPT_HEADER, false);
232			curl_setopt($curl, CURLOPT_RETURNTRANSFER, true);
233			curl_setopt($curl, CURLOPT_TIMEOUT, 1);
234			curl_setopt($curl, CURLOPT_SSL_VERIFYPEER, false);
235			$curl_response = curl_exec($curl);
236			} else {
237			$curl_response = file_get_contents($url);
238			}
239			if (is_null($curl_response) \|\| empty($curl_response)) {
240			return false;
241			}
242			$response = json_decode(trim($curl_response), true);
243
244			if($this->version == 'v3') {
245			return $response;
246			}
247
248			return $response['success'];
249
250			}
251			}

biscolab / laravel-recaptcha

Push — master ( 26f295...e4804f )

ReCaptchaBuilder::htmlScriptTagJsApiV3() A

Complexity

Size

Duplication

Importance

Duplication Side-by-Side

Filter issues like