Code Coverage |
||||||||||
Lines |
Functions and Methods |
Classes and Traits |
||||||||
Total | |
0.00% |
0 / 7 |
|
0.00% |
0 / 4 |
CRAP | |
0.00% |
0 / 1 |
ReCaptcha | |
0.00% |
0 / 7 |
|
0.00% |
0 / 4 |
20 | |
0.00% |
0 / 1 |
__construct | |
0.00% |
0 / 2 |
|
0.00% |
0 / 1 |
2 | |||
getJsIncludes | |
0.00% |
0 / 2 |
|
0.00% |
0 / 1 |
2 | |||
getHtml | |
0.00% |
0 / 1 |
|
0.00% |
0 / 1 |
2 | |||
verify | |
0.00% |
0 / 2 |
|
0.00% |
0 / 1 |
2 |
1 | <?php |
2 | |
3 | /** |
4 | * ReCaptcha CAPTCHA. |
5 | * |
6 | * PHP version 8 |
7 | * |
8 | * Copyright (C) Villanova University 2020. |
9 | * |
10 | * This program is free software; you can redistribute it and/or modify |
11 | * it under the terms of the GNU General Public License version 2, |
12 | * as published by the Free Software Foundation. |
13 | * |
14 | * This program is distributed in the hope that it will be useful, |
15 | * but WITHOUT ANY WARRANTY; without even the implied warranty of |
16 | * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the |
17 | * GNU General Public License for more details. |
18 | * |
19 | * You should have received a copy of the GNU General Public License |
20 | * along with this program; if not, write to the Free Software |
21 | * Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA |
22 | * |
23 | * @category VuFind |
24 | * @package CAPTCHA |
25 | * @author Mario Trojan <mario.trojan@uni-tuebingen.de> |
26 | * @license http://opensource.org/licenses/gpl-2.0.php GNU General Public License |
27 | * @link https://vufind.org Main Page |
28 | */ |
29 | |
30 | namespace VuFind\Captcha; |
31 | |
32 | use Laminas\Mvc\Controller\Plugin\Params; |
33 | |
34 | /** |
35 | * ReCaptcha CAPTCHA. |
36 | * |
37 | * @category VuFind |
38 | * @package CAPTCHA |
39 | * @author Mario Trojan <mario.trojan@uni-tuebingen.de> |
40 | * @license http://opensource.org/licenses/gpl-2.0.php GNU General Public License |
41 | * @link https://vufind.org/wiki/development Wiki |
42 | */ |
43 | class ReCaptcha extends AbstractBase |
44 | { |
45 | /** |
46 | * ReCaptcha Service. |
47 | * |
48 | * @var \VuFind\Service\ReCaptcha |
49 | */ |
50 | protected $recaptcha; |
51 | |
52 | /** |
53 | * Language |
54 | * |
55 | * @var string |
56 | */ |
57 | protected $language; |
58 | |
59 | /** |
60 | * Constructor |
61 | * |
62 | * @param \VuFind\Service\ReCaptcha $recaptcha ReCaptcha Service |
63 | * @param string $language Translator locale |
64 | */ |
65 | public function __construct( |
66 | \VuFind\Service\ReCaptcha $recaptcha, |
67 | string $language |
68 | ) { |
69 | $this->recaptcha = $recaptcha; |
70 | $this->language = $language; |
71 | } |
72 | |
73 | /** |
74 | * Get list of URLs with JS dependencies to load for the active CAPTCHA type. |
75 | * |
76 | * @return array |
77 | */ |
78 | public function getJsIncludes(): array |
79 | { |
80 | return ['https://www.google.com/recaptcha/api.js' |
81 | . '?onload=recaptchaOnLoad&render=explicit&hl=' . $this->language]; |
82 | } |
83 | |
84 | /** |
85 | * Generate HTML depending on CAPTCHA type. |
86 | * |
87 | * @return string |
88 | */ |
89 | public function getHtml(): string |
90 | { |
91 | return $this->recaptcha->getHtml(); |
92 | } |
93 | |
94 | /** |
95 | * Pull the captcha field from controller params and check them for accuracy |
96 | * |
97 | * @param Params $params Controller params |
98 | * |
99 | * @return bool |
100 | */ |
101 | public function verify(Params $params): bool |
102 | { |
103 | $responseField = $params->fromPost('g-recaptcha-response'); |
104 | return $this->recaptcha->verify($responseField)->isValid(); |
105 | } |
106 | } |