ReCaptcha.php 3.2 KB

12345678910111213141516171819202122232425262728293031323334353637383940414243444546474849505152535455565758596061626364656667686970717273747576777879808182838485868788899091929394959697
  1. <?php
  2. /**
  3. * This is a PHP library that handles calling reCAPTCHA.
  4. *
  5. * @copyright Copyright (c) 2015, Google Inc.
  6. * @link http://www.google.com/recaptcha
  7. *
  8. * Permission is hereby granted, free of charge, to any person obtaining a copy
  9. * of this software and associated documentation files (the "Software"), to deal
  10. * in the Software without restriction, including without limitation the rights
  11. * to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
  12. * copies of the Software, and to permit persons to whom the Software is
  13. * furnished to do so, subject to the following conditions:
  14. *
  15. * The above copyright notice and this permission notice shall be included in
  16. * all copies or substantial portions of the Software.
  17. *
  18. * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
  19. * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
  20. * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
  21. * AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
  22. * LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
  23. * OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
  24. * THE SOFTWARE.
  25. */
  26. namespace ReCaptcha;
  27. /**
  28. * reCAPTCHA client.
  29. */
  30. class ReCaptcha
  31. {
  32. /**
  33. * Version of this client library.
  34. * @const string
  35. */
  36. const VERSION = 'php_1.1.0';
  37. /**
  38. * Shared secret for the site.
  39. * @var type string
  40. */
  41. private $secret;
  42. /**
  43. * Method used to communicate with service. Defaults to POST request.
  44. * @var RequestMethod
  45. */
  46. private $requestMethod;
  47. /**
  48. * Create a configured instance to use the reCAPTCHA service.
  49. *
  50. * @param string $secret shared secret between site and reCAPTCHA server.
  51. * @param RequestMethod $requestMethod method used to send the request. Defaults to POST.
  52. */
  53. public function __construct($secret, RequestMethod $requestMethod = null)
  54. {
  55. if (empty($secret)) {
  56. throw new \RuntimeException('No secret provided');
  57. }
  58. if (!is_string($secret)) {
  59. throw new \RuntimeException('The provided secret must be a string');
  60. }
  61. $this->secret = $secret;
  62. if (!is_null($requestMethod)) {
  63. $this->requestMethod = $requestMethod;
  64. } else {
  65. $this->requestMethod = new RequestMethod\Post();
  66. }
  67. }
  68. /**
  69. * Calls the reCAPTCHA siteverify API to verify whether the user passes
  70. * CAPTCHA test.
  71. *
  72. * @param string $response The value of 'g-recaptcha-response' in the submitted form.
  73. * @param string $remoteIp The end user's IP address.
  74. * @return Response Response from the service.
  75. */
  76. public function verify($response, $remoteIp = null)
  77. {
  78. // Discard empty solution submissions
  79. if (empty($response)) {
  80. $recaptchaResponse = new Response(false, array('missing-input-response'));
  81. return $recaptchaResponse;
  82. }
  83. $params = new RequestParameters($this->secret, $response, $remoteIp, self::VERSION);
  84. $rawResponse = $this->requestMethod->submit($params);
  85. return Response::fromJson($rawResponse);
  86. }
  87. }