CRM/Utils/ReCAPTCHA.php

   1 <?php
   2 /*
   3  +--------------------------------------------------------------------+
   4  | CiviCRM version 4.6                                                |
   5  +--------------------------------------------------------------------+
   6  | Copyright CiviCRM LLC (c) 2004-2014                                |
   7  +--------------------------------------------------------------------+
   8  | This file is a part of CiviCRM.                                    |
   9  |                                                                    |
  10  | CiviCRM is free software; you can copy, modify, and distribute it  |
  11  | under the terms of the GNU Affero General Public License           |
  12  | Version 3, 19 November 2007 and the CiviCRM Licensing Exception.   |
  13  |                                                                    |
  14  | CiviCRM is distributed in the hope that it will be useful, but     |
  15  | WITHOUT ANY WARRANTY; without even the implied warranty of         |
  16  | MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.               |
  17  | See the GNU Affero General Public License for more details.        |
  18  |                                                                    |
  19  | You should have received a copy of the GNU Affero General Public   |
  20  | License and the CiviCRM Licensing Exception along                  |
  21  | with this program; if not, contact CiviCRM LLC                     |
  22  | at info[AT]civicrm[DOT]org. If you have questions about the        |
  23  | GNU Affero General Public License or the licensing of CiviCRM,     |
  24  | see the CiviCRM license FAQ at http://civicrm.org/licensing        |
  25  +--------------------------------------------------------------------+
  26  */
  27
  28 /**
  29  *
  30  * @package CRM
  31  * @copyright CiviCRM LLC (c) 2004-2014
  32  * $Id$
  33  *
  34  */
  35 class CRM_Utils_ReCAPTCHA {
  36
  37   protected $_captcha = NULL;
  38
  39   protected $_name = NULL;
  40
  41   protected $_url = NULL;
  42
  43   protected $_phrase = NULL;
  44
  45   /**
  46    * We only need one instance of this object. So we use the singleton
  47    * pattern and cache the instance in this variable
  48    *
  49    * @var object
  50    */
  51   static private $_singleton = NULL;
  52
  53   /**
  54    * Singleton function used to manage this object
  55    *
  56    *
  57    * @return object
  58    */
  59   public static function &singleton() {
  60     if (self::$_singleton === NULL) {
  61       self::$_singleton = new CRM_Utils_ReCAPTCHA();
  62     }
  63     return self::$_singleton;
  64   }
  65
  66   /**
  67    */
  68   public function __construct() {
  69   }
  70
  71   /**
  72    * Add element to form
  73    */
  74   public static function add(&$form) {
  75     $error = NULL;
  76     $config = CRM_Core_Config::singleton();
  77     $useSSL = FALSE;
  78     if (!function_exists('recaptcha_get_html')) {
  79       require_once 'packages/recaptcha/recaptchalib.php';
  80     }
  81
  82     // See if we are using SSL
  83     if (CRM_Utils_System::isSSL()) {
  84       $useSSL = TRUE;
  85     }
  86     $html = recaptcha_get_html($config->recaptchaPublicKey, $error, $useSSL);
  87
  88     $form->assign('recaptchaHTML', $html);
  89     $form->assign('recaptchaOptions', $config->recaptchaOptions);
  90     $form->add(
  91       'text',
  92       'recaptcha_challenge_field',
  93       NULL,
  94       NULL,
  95       TRUE
  96     );
  97     $form->add(
  98       'hidden',
  99       'recaptcha_response_field',
 100       'manual_challenge'
 101     );
 102
 103     $form->registerRule('recaptcha', 'callback', 'validate', 'CRM_Utils_ReCAPTCHA');
 104     $form->addRule(
 105       'recaptcha_challenge_field',
 106       ts('Input text must match the phrase in the image. Please review the image and re-enter matching text.'),
 107       'recaptcha',
 108       $form
 109     );
 110   }
 111
 112   /**
 113    * @param $value
 114    * @param CRM_Core_Form $form
 115    *
 116    * @return mixed
 117    */
 118   public static function validate($value, $form) {
 119     $config = CRM_Core_Config::singleton();
 120
 121     $resp = recaptcha_check_answer($config->recaptchaPrivateKey,
 122       $_SERVER['REMOTE_ADDR'],
 123       $_POST["recaptcha_challenge_field"],
 124       $_POST["recaptcha_response_field"]
 125     );
 126     return $resp->is_valid;
 127   }
 128
 129 }