biscolab / laravel-recaptcha

src/ReCaptchaBuilderV2.php

Indentation +18 added lines, -18 removed lines

@@ -16,26 +16,26 @@
  */
 class ReCaptchaBuilderV2 extends ReCaptchaBuilder {
 
-	/**
-	 * ReCaptchaBuilderV2 constructor.
-	 *
-	 * @param string $api_site_key
-	 * @param string $api_secret_key
-	 * @param int $curl_timeout
-	 */
-	public function __construct(string $api_site_key, string $api_secret_key, int $curl_timeout) {
+    /**
+     * ReCaptchaBuilderV2 constructor.
+     *
+     * @param string $api_site_key
+     * @param string $api_secret_key
+     * @param int $curl_timeout
+     */
+    public function __construct(string $api_site_key, string $api_secret_key, int $curl_timeout) {
 
-		parent::__construct($api_site_key, $api_secret_key, 'v2', $curl_timeout);
-	}
+        parent::__construct($api_site_key, $api_secret_key, 'v2', $curl_timeout);
+    }
 
-	/**
-	 * Write ReCAPTCHA HTML tag in your FORM
-	 * Insert before </form> tag
-	 * @return string
-	 */
-	public function htmlFormSnippet(): string {
+    /**
+     * Write ReCAPTCHA HTML tag in your FORM
+     * Insert before </form> tag
+     * @return string
+     */
+    public function htmlFormSnippet(): string {
 
-		return ($this->version == 'v2') ? '<div class="g-recaptcha" data-sitekey="' . $this->api_site_key . '"></div>' : '';
-	}
+        return ($this->version == 'v2') ? '<div class="g-recaptcha" data-sitekey="' . $this->api_site_key . '"></div>' : '';
+    }
 
 }
\ No newline at end of file

src/ReCaptchaBuilder.php

Indentation +277 added lines, -277 removed lines

@@ -14,206 +14,206 @@ 
 
 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;
-
-	/**
-	 * The curl timeout
-	 * please visit https://curl.haxx.se/libcurl/c/CURLOPT_TIMEOUT.html
-	 * @var int
-	 */
-	protected $curl_timeout;
-
-	/**
-	 * 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', $curl_timeout = 3) {
-
-		$this->setApiSiteKey($api_site_key);
-		$this->setApiSecretKey($api_secret_key);
-		$this->setVersion($version);
-		$this->setCurlTimeout($curl_timeout);
-		$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 int $curl_timeout
-	 * @return ReCaptchaBuilder
-	 */
-	public function setCurlTimeout(int $curl_timeout): ReCaptchaBuilder {
-
-		$this->curl_timeout = $curl_timeout;
-
-		return $this;
-	}
-
-	/**
-	 * @return int
-	 */
-	public function getCurlTimeout(): int {
-
-		return $this->curl_timeout;
-	}
-
-	/**
-	 * @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;
-	}
-
-	/**
-	 * @return array|mixed
-	 */
-	public function getIpWhitelist() {
-		$whitelist = config('recaptcha.skip_ip', []);
-
-		if(!is_array($whitelist)) {
-			$whitelist = explode(',', $whitelist);
-		}
-
-		return $whitelist;
-	}
-
-	/**
-	 * Checks whether the user IP address is among IPs "to be skipped"
-	 *
-	 * @return boolean
-	 */
-	public function skipByIp(): bool {
-
-		return (in_array(request()->ip(), $this->getIpWhitelist()));
-	}
-
-	/**
-	 * 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>
+    /**
+     * 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;
+
+    /**
+     * The curl timeout
+     * please visit https://curl.haxx.se/libcurl/c/CURLOPT_TIMEOUT.html
+     * @var int
+     */
+    protected $curl_timeout;
+
+    /**
+     * 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', $curl_timeout = 3) {
+
+        $this->setApiSiteKey($api_site_key);
+        $this->setApiSecretKey($api_secret_key);
+        $this->setVersion($version);
+        $this->setCurlTimeout($curl_timeout);
+        $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 int $curl_timeout
+     * @return ReCaptchaBuilder
+     */
+    public function setCurlTimeout(int $curl_timeout): ReCaptchaBuilder {
+
+        $this->curl_timeout = $curl_timeout;
+
+        return $this;
+    }
+
+    /**
+     * @return int
+     */
+    public function getCurlTimeout(): int {
+
+        return $this->curl_timeout;
+    }
+
+    /**
+     * @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;
+    }
+
+    /**
+     * @return array|mixed
+     */
+    public function getIpWhitelist() {
+        $whitelist = config('recaptcha.skip_ip', []);
+
+        if(!is_array($whitelist)) {
+            $whitelist = explode(',', $whitelist);
+        }
+
+        return $whitelist;
+    }
+
+    /**
+     * Checks whether the user IP address is among IPs "to be skipped"
+     *
+     * @return boolean
+     */
+    public function skipByIp(): bool {
+
+        return (in_array(request()->ip(), $this->getIpWhitelist()));
+    }
+
+    /**
+     * 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') {
+        }
+        elseif ($this->version == 'v3') {
 
-			$action = array_get($configuration, 'action', 'homepage');
+            $action = array_get($configuration, 'action', 'homepage');
 
-			$js_custom_validation = array_get($configuration, 'custom_validation', '');
+            $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) {
+            // 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 {
+                $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 = 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)" : '';
+                $js_then_callback = ($js_then_callback) ? "{$js_then_callback}(response)" : '';
+                $js_callback_catch = ($js_callback_catch) ? "{$js_callback_catch}(err)" : '';
 
-				$validate_function = "
+                $validate_function = "
                 fetch('/" . config('recaptcha.default_validation_route', 'biscolab-recaptcha/validate') . "?" . config('recaptcha.default_token_parameter_name', 'token') . "=' + token, {
                     headers: {
                         \"X-Requested-With\": \"XMLHttpRequest\",
@@ -226,9 +226,9 @@ 
                 .catch(function(err) {
                     {$js_callback_catch}
                 });";
-			}
+            }
 
-			$html .= "<script>
+            $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) {
@@ -236,90 +236,90 @@ 
                       });
                   });
 		     </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|array
-	 */
-	public function validate($response) {
-
-		if ($this->skip_by_ip) {
-			if ($this->returnArray()) {
-				// Add 'skip_by_ip' field to response
-				return [
-					'skip_by_ip' => true,
-					'score'      => 0.9,
-					'success'    => true
-				];
-			}
-
-			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, $this->curl_timeout);
-			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)) {
-			if ($this->returnArray()) {
-				// Add 'error' field to response
-				return [
-					'error'   => 'cURL response empty',
-					'score'   => 0.1,
-					'success' => false
-				];
-			}
-
-			return false;
-		}
-		$response = json_decode(trim($curl_response), true);
-
-		if ($this->returnArray()) {
-			return $response;
-		}
-
-		return $response['success'];
-
-	}
-
-	/**
-	 * @return bool
-	 */
-	protected function returnArray(): bool {
-
-		return ($this->version == 'v3');
-	}
+        }
+
+        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|array
+     */
+    public function validate($response) {
+
+        if ($this->skip_by_ip) {
+            if ($this->returnArray()) {
+                // Add 'skip_by_ip' field to response
+                return [
+                    'skip_by_ip' => true,
+                    'score'      => 0.9,
+                    'success'    => true
+                ];
+            }
+
+            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, $this->curl_timeout);
+            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)) {
+            if ($this->returnArray()) {
+                // Add 'error' field to response
+                return [
+                    'error'   => 'cURL response empty',
+                    'score'   => 0.1,
+                    'success' => false
+                ];
+            }
+
+            return false;
+        }
+        $response = json_decode(trim($curl_response), true);
+
+        if ($this->returnArray()) {
+            return $response;
+        }
+
+        return $response['success'];
+
+    }
+
+    /**
+     * @return bool
+     */
+    protected function returnArray(): bool {
+
+        return ($this->version == 'v3');
+    }
 }
\ No newline at end of file

config/recaptcha.php

Indentation +50 added lines, -50 removed lines

@@ -13,60 +13,60 @@
  */
 return [
 
-	/**
-	 *
-	 * The site key
-	 * get site key @ www.google.com/recaptcha/admin
-	 *
-	 */
-	'api_site_key'                 => env('RECAPTCHA_SITE_KEY', ''),
+    /**
+     *
+     * The site key
+     * get site key @ www.google.com/recaptcha/admin
+     *
+     */
+    'api_site_key'                 => env('RECAPTCHA_SITE_KEY', ''),
 
-	/**
-	 *
-	 * The secret key
-	 * get secret key @ www.google.com/recaptcha/admin
-	 *
-	 */
-	'api_secret_key'               => env('RECAPTCHA_SECRET_KEY', ''),
+    /**
+     *
+     * The secret key
+     * get secret key @ www.google.com/recaptcha/admin
+     *
+     */
+    'api_secret_key'               => env('RECAPTCHA_SECRET_KEY', ''),
 
-	/**
-	 *
-	 * ReCATCHA version
-	 * Supported: "v2", "invisible", "v3",
-	 *
-	 * get more info @ https://developers.google.com/recaptcha/docs/versions
-	 *
-	 */
-	'version'                      => env('RECAPTCHA_DEFAULT_VERSION', 'v2'),
+    /**
+     *
+     * ReCATCHA version
+     * Supported: "v2", "invisible", "v3",
+     *
+     * get more info @ https://developers.google.com/recaptcha/docs/versions
+     *
+     */
+    'version'                      => env('RECAPTCHA_DEFAULT_VERSION', 'v2'),
 
-	/**
-	 *
-	 * The curl timout in seconds to validate a recaptcha token
-	 * @since v3.4.3
-	 *
-	 */
-	'curl_timeout'                 => env('RECAPTCHA_CURL_TIMEOUT', 10),
+    /**
+     *
+     * The curl timout in seconds to validate a recaptcha token
+     * @since v3.4.3
+     *
+     */
+    'curl_timeout'                 => env('RECAPTCHA_CURL_TIMEOUT', 10),
 
-	/**
-	 *
-	 * IP addresses for which validation will be skipped
-	 *
-	 */
-	'skip_ip'                      => [],
+    /**
+     *
+     * IP addresses for which validation will be skipped
+     *
+     */
+    'skip_ip'                      => [],
 
-	/**
-	 *
-	 * Default route called to check the Google reCAPTCHA token
-	 * @since v3.2.0
-	 *
-	 */
-	'default_validation_route'     => env('RECAPTCHA_DEFAULT_VALIDATION_ROUTE', 'biscolab-recaptcha/validate'),
+    /**
+     *
+     * Default route called to check the Google reCAPTCHA token
+     * @since v3.2.0
+     *
+     */
+    'default_validation_route'     => env('RECAPTCHA_DEFAULT_VALIDATION_ROUTE', 'biscolab-recaptcha/validate'),
 
-	/**
-	 *
-	 * The name of the parameter used to send Google reCAPTCHA token to verify route
-	 * @since v3.2.0
-	 *
-	 */
-	'default_token_parameter_name' => env('RECAPTCHA_DEFAULT_TOKEN_PARAMETER_NAME', 'token')
+    /**
+     *
+     * The name of the parameter used to send Google reCAPTCHA token to verify route
+     * @since v3.2.0
+     *
+     */
+    'default_token_parameter_name' => env('RECAPTCHA_DEFAULT_TOKEN_PARAMETER_NAME', 'token')
 ];