-
Notifications
You must be signed in to change notification settings - Fork 52
/
AbstractNoCaptcha.php
358 lines (311 loc) · 7.99 KB
/
AbstractNoCaptcha.php
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
<?php
declare(strict_types=1);
namespace Arcanedev\NoCaptcha;
use Arcanedev\NoCaptcha\Utilities\Request;
use Illuminate\Support\HtmlString;
use Psr\Http\Message\ServerRequestInterface;
/**
* Class AbstractNoCaptcha
*
* @author ARCANEDEV <arcanedev.maroc@gmail.com>
*/
abstract class AbstractNoCaptcha implements Contracts\NoCaptcha
{
/* -----------------------------------------------------------------
| Constants
| -----------------------------------------------------------------
*/
const CAPTCHA_NAME = 'g-recaptcha-response';
/* -----------------------------------------------------------------
| Properties
| -----------------------------------------------------------------
*/
/**
* The shared key between your site and ReCAPTCHA
*
* @var string
*/
protected $secret;
/**
* Your site key
*
* @var string
*/
protected $siteKey;
/**
* Forces the widget to render in a specific language.
* Auto-detects the user's language if unspecified.
*
* @var string
*/
protected $lang;
/**
* HTTP Request Client
*
* @var \Arcanedev\NoCaptcha\Contracts\Utilities\Request
*/
protected $request;
/**
* ReCaptcha's response.
*
* @var \Arcanedev\NoCaptcha\Utilities\ResponseV3|null
*/
protected $response;
/**
* Use the global domain.
*
* @var bool
*/
public static $useGlobalDomain = false;
/* -----------------------------------------------------------------
| Constructor
| -----------------------------------------------------------------
*/
/**
* NoCaptcha constructor.
*
* @param string $secret
* @param string $siteKey
* @param string|null $lang
*/
public function __construct($secret, $siteKey, $lang = null)
{
$this->setSecret($secret);
$this->setSiteKey($siteKey);
$this->setLang($lang);
$this->setRequestClient(new Request);
}
/* -----------------------------------------------------------------
| Getters & Setters
| -----------------------------------------------------------------
*/
/**
* Set the secret key.
*
* @param string $secret
*
* @return $this
*/
protected function setSecret($secret)
{
self::checkKey('secret key', $secret);
$this->secret = $secret;
return $this;
}
/**
* Get the site key.
*
* @return string
*/
public function getSiteKey()
{
return $this->siteKey;
}
/**
* Set Site key.
*
* @param string $siteKey
*
* @return $this
*/
protected function setSiteKey($siteKey)
{
self::checkKey('site key', $siteKey);
$this->siteKey = $siteKey;
return $this;
}
/**
* Set language code.
*
* @param string $lang
*
* @return $this
*/
public function setLang($lang)
{
$this->lang = $lang;
return $this;
}
/**
* Get language code.
*
* @return string|null
*/
public function getLang()
{
return $this->lang;
}
/**
* Set HTTP Request Client.
*
* @param \Arcanedev\NoCaptcha\Contracts\Utilities\Request $request
*
* @return $this
*/
public function setRequestClient(Contracts\Utilities\Request $request)
{
$this->request = $request;
return $this;
}
/**
* Get the last response.
*
* @return \Arcanedev\NoCaptcha\Utilities\AbstractResponse|null
*/
public function getLastResponse()
{
return $this->response;
}
/**
* Get the client url.
*
* @return string
*/
public static function getClientUrl()
{
return static::$useGlobalDomain
? 'https://www.recaptcha.net/recaptcha/api.js'
: 'https://www.google.com/recaptcha/api.js';
}
/**
* Get the verification url.
*
* @return string
*/
public static function getVerificationUrl()
{
return static::$useGlobalDomain
? 'https://www.recaptcha.net/recaptcha/api/siteverify'
: 'https://www.google.com/recaptcha/api/siteverify';
}
/* -----------------------------------------------------------------
| Main Methods
| -----------------------------------------------------------------
*/
/**
* Verify Response.
*
* @param string $response
* @param string $clientIp
*
* @return \Arcanedev\NoCaptcha\Utilities\AbstractResponse|mixed
*/
public function verify($response, $clientIp = null)
{
return $this->response = $this->sendVerifyRequest([
'secret' => $this->secret,
'response' => $response,
'remoteip' => $clientIp
]);
}
/**
* Calls the reCAPTCHA siteverify API to verify whether the user passes CAPTCHA
* test using a PSR-7 ServerRequest object.
*
* @param \Psr\Http\Message\ServerRequestInterface $request
*
* @return \Arcanedev\NoCaptcha\Utilities\AbstractResponse
*/
public function verifyRequest(ServerRequestInterface $request)
{
$body = $request->getParsedBody();
$server = $request->getServerParams();
return $this->verify(
$body[self::CAPTCHA_NAME] ?? '',
$server['REMOTE_ADDR'] ?? null
);
}
/**
* Send verify request to API and get response.
*
* @param array $query
*
* @return \Arcanedev\NoCaptcha\Contracts\Utilities\Response
*/
protected function sendVerifyRequest(array $query = [])
{
$query = array_filter($query);
$json = $this->request->send(
$this->getVerificationUrl().'?'.http_build_query($query)
);
return $this->parseResponse($json);
}
/**
* Parse the response.
*
* @param string $json
*
* @return \Arcanedev\NoCaptcha\Contracts\Utilities\Response|mixed
*/
abstract protected function parseResponse($json);
/* -----------------------------------------------------------------
| Check Methods
| -----------------------------------------------------------------
*/
/**
* Check if has lang.
*
* @return bool
*/
protected function hasLang()
{
return ! empty($this->getLang());
}
/**
* Check key.
*
* @param string $name
* @param string $value
*/
private static function checkKey($name, &$value): void
{
self::checkIsString($name, $value);
$value = trim($value);
self::checkIsNotEmpty($name, $value);
}
/**
* Check if the value is a string value.
*
* @param string $name
* @param string $value
*
* @throws \Arcanedev\NoCaptcha\Exceptions\ApiException
*/
private static function checkIsString($name, $value): void
{
if ( ! is_string($value)) {
throw new Exceptions\ApiException(
"The {$name} must be a string value, ".gettype($value).' given.'
);
}
}
/**
* Check if the value is not empty.
*
* @param string $name
* @param string $value
*
* @throws \Arcanedev\NoCaptcha\Exceptions\ApiException
*/
private static function checkIsNotEmpty($name, $value): void
{
if (empty($value)) {
throw new Exceptions\ApiException("The {$name} must not be empty");
}
}
/* -----------------------------------------------------------------
| Other Methods
| -----------------------------------------------------------------
*/
/**
* Transform the string to an Html serializable object
*
* @param string $html
*
* @return \Illuminate\Support\HtmlString
*/
protected function toHtmlString($html)
{
return new HtmlString($html);
}
}