├── Cells
    └── ReCaptcha.php
├── Config
    ├── Events.php
    ├── ReCaptcha2.php
    ├── ReCaptcha3.php
    └── Services.php
├── Helpers
    └── reCaptcha_helper.php
├── Language
    └── en
    │   └── ReCaptcha.php
├── Libraries
    └── ReCaptcha.php
├── README.md
├── Validation
    └── ReCaptchaRules.php
├── Views
    ├── init_v2.php
    └── init_v3.php
└── composer.json


/Cells/ReCaptcha.php:
--------------------------------------------------------------------------------
 1 | <?php
 2 | 
 3 | namespace Denis303\ReCaptcha\Cells;
 4 | 
 5 | use Denis303\ReCaptcha\Config\ReCaptcha2;
 6 | 
 7 | class ReCaptcha
 8 | {
 9 | 
10 |     public function init_v2(array $params)
11 |     {
12 |         static $num = 0;
13 | 
14 |         $num++;
15 | 
16 |         $params['num'] = $num;
17 | 
18 |         $config = config(ReCaptcha2::class);
19 | 
20 |         assert($config ? true : false, ReCaptcha2::class);
21 | 
22 |         $params['key'] = $config->key;
23 | 
24 |         return view('Denis303\ReCaptcha\Views\init_v2', $params);
25 |     }
26 | 
27 |     public function init_v3(array $params)
28 |     {
29 |         static $inited = [];
30 | 
31 |         if (array_search($params['key'], $inited) === false)
32 |         {
33 |             $params['init'] = true;
34 | 
35 |             $inited[] = $params['key'];
36 |         }
37 |         else
38 |         {
39 |             $params['init'] = false;
40 |         }
41 | 
42 |         return view('Denis303\ReCaptcha\Views\init_v3', $params);
43 |     }
44 |     
45 | }


--------------------------------------------------------------------------------
/Config/Events.php:
--------------------------------------------------------------------------------
1 | <?php
2 | 
3 | use CodeIgniter\Events\Events;
4 | 
5 | //Events::on('pre_system', function() {
6 | //    helper(['reCaptcha']);
7 | //});


--------------------------------------------------------------------------------
/Config/ReCaptcha2.php:
--------------------------------------------------------------------------------
 1 | <?php
 2 | 
 3 | namespace Denis303\ReCaptcha\Config;
 4 | 
 5 | class ReCaptcha2 extends \CodeIgniter\Config\BaseConfig
 6 | {
 7 | 
 8 |     public $key;
 9 | 
10 |     public $secret;
11 | 
12 |     public $expectedHostname;
13 | 
14 |     public $challengeTimeout;    
15 |     
16 | }


--------------------------------------------------------------------------------
/Config/ReCaptcha3.php:
--------------------------------------------------------------------------------
 1 | <?php
 2 | 
 3 | namespace Denis303\ReCaptcha\Config;
 4 | 
 5 | class ReCaptcha3 extends \CodeIgniter\Config\BaseConfig
 6 | {
 7 | 
 8 |     public $key;
 9 | 
10 |     public $secret;
11 | 
12 |     public $expectedHostname;
13 | 
14 |     public $scoreThreshold = 0.5;
15 | 
16 |     public $challengeTimeout;
17 |     
18 | }


--------------------------------------------------------------------------------
/Config/Services.php:
--------------------------------------------------------------------------------
 1 | <?php
 2 | 
 3 | namespace Denis303\ReCaptcha\Config;
 4 | 
 5 | use Exception;
 6 | use Denis303\ReCaptcha\Libraries\ReCaptcha;
 7 | 
 8 | class Services extends \CodeIgniter\Config\Services
 9 | {
10 | 
11 |     public static function reCaptcha2($getShared = true)
12 |     {
13 |         if ($getShared)
14 |         {
15 |             return static::getSharedInstance(__FUNCTION__);
16 |         }
17 | 
18 |         $config = config(ReCaptcha2::class);
19 | 
20 |         if (!$config)
21 |         {
22 |             throw new Exception(ReCaptcha2::class . ' not found.');
23 |         }
24 | 
25 |         if (!$config->secret)
26 |         {
27 |             throw new Exception('The secret parameter is missing.');
28 |         }
29 | 
30 |         $return = new ReCaptcha($config->secret);
31 | 
32 |         if ($config->expectedHostname !== null)
33 |         {
34 |             $return->setExpectedHostname($config->expectedHostname);
35 |         }
36 | 
37 |         if ($config->challengeTimeout !== null)
38 |         {
39 |             $return->setChallengeTimeout($config->challengeTimeout);
40 |         }
41 | 
42 |         return $return;
43 |     }
44 | 
45 |     public static function reCaptcha3($getShared = true)
46 |     {
47 |         if ($getShared)
48 |         {
49 |             return static::getSharedInstance(__FUNCTION__);
50 |         }
51 | 
52 |         $config = config(ReCaptcha3::class);
53 | 
54 |         if (!$config)
55 |         {
56 |             throw new Exception(ReCaptcha3::class . ' not found.');
57 |         }
58 | 
59 |         if (!$config->secret)
60 |         {
61 |             throw new Exception('The secret parameter is missing.');
62 |         }
63 | 
64 |         $return = new ReCaptcha($config->secret);
65 | 
66 |         if ($config->scoreThreshold !== null)
67 |         {
68 |             $return->setScoreThreshold($config->scoreThreshold);
69 |         }
70 | 
71 |         if ($config->expectedHostname !== null)
72 |         {
73 |             $return->setExpectedHostname($config->expectedHostname);
74 |         }
75 | 
76 |         if ($config->challengeTimeout !== null)
77 |         {
78 |             $return->setChallengeTimeout($config->challengeTimeout);
79 |         }
80 | 
81 |         return $return;
82 |     }
83 | 
84 | }


--------------------------------------------------------------------------------
/Helpers/reCaptcha_helper.php:
--------------------------------------------------------------------------------
 1 | <?php
 2 | 
 3 | use Denis303\ReCaptcha\Config\ReCaptcha2;
 4 | use Denis303\ReCaptcha\Config\ReCaptcha3;
 5 | 
 6 | if (!function_exists('reCaptcha2'))
 7 | {
 8 |     function reCaptcha2(string $name, array $attributes = [], array $options = [], bool $init = true)
 9 |     {
10 |         $config = config(ReCaptcha2::class);
11 | 
12 |         if (!$config)
13 |         {
14 |             throw new Exception(ReCaptcha2::class . ' not found.');
15 |         }
16 | 
17 |         if (empty($attributes['id']))
18 |         {
19 |             $attributes['id'] = $name;
20 |         }
21 | 
22 |         helper('form');
23 | 
24 |         $attributes['type'] = 'hidden';
25 | 
26 |         $attributes['name'] = $name;
27 | 
28 |         $return = form_input($attributes) . PHP_EOL;
29 | 
30 |         if ($init)
31 |         {
32 |             $return .= view_cell('Denis303\ReCaptcha\Cells\ReCaptcha::init_v2', [
33 |                 'key' => $config->key,
34 |                 'id' => $attributes['id'],
35 |                 'options' => $options
36 |             ]);
37 |         }
38 | 
39 |         return $return;
40 |     }
41 | }
42 | 
43 | if (!function_exists('reCaptcha3'))
44 | {
45 |     function reCaptcha3(string $name, array $attributes = [], array $options = [], bool $init = true)
46 |     {
47 |         $config = config(ReCaptcha3::class);
48 | 
49 |         if (!$config)
50 |         {
51 |             throw new Exception(ReCaptcha3::class . ' not found.');
52 |         }
53 | 
54 |         helper('form');
55 | 
56 |         if (empty($attributes['id']))
57 |         {
58 |             $attributes['id'] = $name;
59 |         }
60 | 
61 |         $attributes['type'] = 'hidden';
62 | 
63 |         $attributes['name'] = $name;
64 | 
65 |         $return = form_input($attributes) . PHP_EOL;
66 | 
67 |         if ($init)
68 |         {
69 |             $return .= view_cell('Denis303\ReCaptcha\Cells\ReCaptcha::init_v3', [
70 |                 'key' => $config->key,
71 |                 'id' => $attributes['id'],
72 |                 'options' => $options
73 |             ]);
74 |         }
75 | 
76 |         return $return;
77 |     }
78 |     
79 | }


--------------------------------------------------------------------------------
/Language/en/ReCaptcha.php:
--------------------------------------------------------------------------------
 1 | <?php
 2 | 
 3 | return [
 4 |     'missing-input-secret' => 'The secret parameter is missing.',
 5 |     'invalid-input-secret' => 'The secret parameter is invalid or malformed.',
 6 |     'missing-input-response' => 'The response parameter is missing.',
 7 |     'invalid-input-response' => 'The response parameter is invalid or malformed.',
 8 |     'bad-request The request' => 'is invalid or malformed.',
 9 |     'timeout-or-duplicate' => 'The response is no longer valid: either is too old or has been used previously.'
10 | ];


--------------------------------------------------------------------------------
/Libraries/ReCaptcha.php:
--------------------------------------------------------------------------------
 1 | <?php
 2 | 
 3 | namespace Denis303\ReCaptcha\Libraries;
 4 | 
 5 | class ReCaptcha extends \ReCaptcha\ReCaptcha
 6 | {
 7 | 
 8 |     public function verify($response, $remoteIp = null)
 9 |     {
10 |         if (!$remoteIp)
11 |         {
12 |             $ip = service('request')->getIPAddress();
13 | 
14 |             if ($ip && ($ip != '0.0.0.0'))
15 |             {
16 |                 $remoteIp = $ip;
17 |             }
18 |         }
19 | 
20 |         return parent::verify($response, $remoteIp);
21 |     }
22 |     
23 | }


--------------------------------------------------------------------------------
/README.md:
--------------------------------------------------------------------------------
 1 | Google reCAPTCHA CodeIgniter 4 Library
 2 | ======================================
 3 | 
 4 | ## Installation
 5 | 
 6 | ```composer require denis303/codeigniter4-recaptcha:dev-master```
 7 | 
 8 | ## Configuration
 9 | 
10 | In the .env file you need to add your personal ReCaptcha keys.
11 | 
12 | ```
13 | # --------------------------------------------------------------------
14 | # ReCaptcha 2
15 | # --------------------------------------------------------------------
16 | recaptcha2.key = 'XXXXXXXX-XXXXXXXX'
17 | recaptcha2.secret = 'XXXXXXXX-XXXXXXXX'
18 | 
19 | # --------------------------------------------------------------------
20 | # ReCaptcha 3
21 | # --------------------------------------------------------------------
22 | recaptcha3.key = 'XXXXXXXX-XXXXXXXX'
23 | recaptcha3.secret = 'XXXXXXXX-XXXXXXXX'
24 | recaptcha3.scoreThreshold = 0.5
25 | ```
26 | 
27 | In the /app/Config/Validation.php file you need to add settings for validator:
28 | 
29 | ```
30 | public $ruleSets = [
31 |     ...
32 |     \Denis303\ReCaptcha\Validation\ReCaptchaRules::class
33 | ];
34 | ```
35 | 
36 | ### Rendering ReCaptcha v2
37 | 
38 | ```
39 | helper(['form', 'reCaptcha']);
40 | 
41 | echo form_open();
42 | 
43 | echo reCaptcha2('reCaptcha2', ['id' => 'recaptcha_v2'], ['theme' => 'dark']);
44 | 
45 | echo form_submit('submit', 'Submit');
46 | 
47 | echo form_close();
48 | ```
49 | 
50 | ### Rendering ReCaptcha v3
51 | 
52 | ```
53 | helper(['form', 'reCaptcha']);
54 | 
55 | echo form_open();
56 | 
57 | echo reCaptcha3('reCaptcha3', ['id' => 'recaptcha_v3'], ['action' => 'contactForm']);
58 | 
59 | echo form_submit('submit', 'Submit');
60 | 
61 | echo form_close();
62 | ```
63 | 
64 | ### Checking ReCaptcha in a model:
65 | 
66 | ```
67 | public $validationRules = [
68 |     'reCaptcha2' => 'required|reCaptcha2[]'
69 |     'reCaptcha3' => 'required|reCaptcha3[contactForm,0.9]'
70 |     ....
71 | ];
72 | ```
73 | 
74 | In the settings of the reCaptcha3 validator, the first parameter you specify is expectedAction, this parameter is not required.
75 | 
76 | You can override a global scoreThreshold parameter in the second reCaptcha3 rule parameter.


--------------------------------------------------------------------------------
/Validation/ReCaptchaRules.php:
--------------------------------------------------------------------------------
 1 | <?php
 2 | 
 3 | namespace Denis303\ReCaptcha\Validation;
 4 | 
 5 | use Exception;
 6 | 
 7 | class ReCaptchaRules
 8 | {
 9 | 
10 |     public function reCaptcha2(string $token, string $params, array $data, &$error = null)
11 |     {
12 |         $service = service('reCaptcha2');
13 | 
14 |         $params = explode(',', $params);
15 |         
16 |         $response = $service->verify($token);
17 | 
18 |         if ($response->isSuccess())
19 |         {
20 |             return true;
21 |         }
22 | 
23 |         foreach($response->getErrorCodes() as $key => $value)
24 |         {
25 |             $error = lang('ReCaptcha.' . $value);
26 |         
27 |             break;
28 |         }
29 | 
30 |         return false;
31 |     }
32 | 
33 |     public function reCaptcha3(string $token, string $params, array $data, &$error = null)
34 |     {
35 |         $service = service('reCaptcha3');
36 | 
37 |         $params = explode(',', $params);
38 | 
39 |         if (count($params) > 0)
40 |         {
41 |             $service->setExpectedAction($params[0]);
42 |         }
43 | 
44 |         if (count($params) > 1)
45 |         {
46 |             $service->setScoreThreshold($params[1]);
47 |         }
48 |         
49 |         $response = $service->verify($token);
50 | 
51 |         if ($response->isSuccess())
52 |         {
53 |             return true;
54 |         }
55 | 
56 |         foreach($response->getErrorCodes() as $key => $value)
57 |         {
58 |             $error = lang('ReCaptcha.' . $value);
59 |         
60 |             break;
61 |         }
62 | 
63 |         return false;
64 |     }
65 | 
66 | }


--------------------------------------------------------------------------------
/Views/init_v2.php:
--------------------------------------------------------------------------------
 1 | <?php
 2 | 
 3 | $options['sitekey'] = $key;
 4 | $options['callback'] = 'reCaptcha2VerifyCallback_' . $num;
 5 | 
 6 | ?>
 7 | 
 8 | <div id="reCaptcha2_<?= $num;?>"></div>
 9 | 
10 | <script type="text/javascript">
11 | 
12 |     var reCaptcha2VerifyCallback_<?= $num;?> = function(response) {
13 |         document.getElementById('<?= $id;?>').value = response;
14 |     };
15 | 
16 |     var reCaptcha2Callback_<?= $num;?> = function() {
17 |         grecaptcha.render('reCaptcha2_<?= $num;?>', <?= json_encode($options);?>);
18 |     };
19 | </script>
20 | 
21 | <script src="https://www.google.com/recaptcha/api.js?onload=reCaptcha2Callback_<?= $num;?>&render=explicit" async defer></script>
22 | 


--------------------------------------------------------------------------------
/Views/init_v3.php:
--------------------------------------------------------------------------------
 1 | <?php if($init):?>
 2 | 
 3 | <script type="text/javascript" src="https://www.google.com/recaptcha/api.js?render=<?= $key;?>"></script>
 4 | 
 5 | <?php endif;?>
 6 | 
 7 | <script type="text/javascript">
 8 | 
 9 | grecaptcha.ready(function() {
10 |     grecaptcha.execute('<?= $key;?>', <?= json_encode($options);?>).then(function(token) {
11 |         document.getElementById('<?= $id;?>').value = token;
12 |         document.getElementById('<?= $id;?>').oninput();
13 |     });
14 | });
15 | 
16 | </script>


--------------------------------------------------------------------------------
/composer.json:
--------------------------------------------------------------------------------
 1 | {
 2 |     "name": "denis303/codeigniter4-recaptcha",
 3 |     "license": "MIT",
 4 |     "autoload": {
 5 |         "psr-4": {
 6 |             "Denis303\\ReCaptcha\\" : ""
 7 |         }
 8 |     },
 9 |     "require": {
10 |         "google/recaptcha": "^1.2"
11 |     }
12 | }
13 | 


--------------------------------------------------------------------------------