CRM/Utils/ReCAPTCHA.php

   1 <?php
   2 /*
   3  +--------------------------------------------------------------------+
   4  | CiviCRM version 4.5                                                |
   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    * @static
  51    */
  52   static private $_singleton = NULL;
  53
  54   /**
  55    * singleton function used to manage this object
  56    *
  57    * @param string the key to permit session scope's
  58    *
  59    * @return object
  60    * @static
  61    *
  62    */
  63   static function &singleton() {
  64     if (self::$_singleton === NULL) {
  65       self::$_singleton = new CRM_Utils_ReCAPTCHA();
  66     }
  67     return self::$_singleton;
  68   }
  69
  70   function __construct() {}
  71
  72   /**
  73    * Add element to form
  74    *
  75    */
  76   static function add(&$form) {
  77     $error  = NULL;
  78     $config = CRM_Core_Config::singleton();
  79     $useSSL = FALSE;
  80     if ( !function_exists( 'recaptcha_get_html' ) ) {
  81       require_once 'packages/recaptcha/recaptchalib.php';
  82     }
  83
  84     // See if we are using SSL
  85     if (CRM_Utils_System::isSSL()) {
  86       $useSSL = TRUE;
  87     }
  88     $html = recaptcha_get_html($config->recaptchaPublicKey, $error, $useSSL);
  89
  90     $form->assign('recaptchaHTML', $html);
  91     $form->assign('recaptchaOptions', $config->recaptchaOptions);
  92     $form->add(
  93       'text',
  94       'recaptcha_challenge_field',
  95       NULL,
  96       NULL,
  97       TRUE
  98     );
  99     $form->add(
 100       'hidden',
 101       'recaptcha_response_field',
 102       'manual_challenge'
 103     );
 104
 105     $form->registerRule('recaptcha', 'callback', 'validate', 'CRM_Utils_ReCAPTCHA');
 106     $form->addRule(
 107       'recaptcha_challenge_field',
 108       ts('Input text must match the phrase in the image. Please review the image and re-enter matching text.'),
 109       'recaptcha',
 110       $form
 111     );
 112   }
 113
 114   static function validate($value, $form) {
 115     $config = CRM_Core_Config::singleton();
 116
 117     $resp = recaptcha_check_answer($config->recaptchaPrivateKey,
 118       $_SERVER['REMOTE_ADDR'],
 119       $_POST["recaptcha_challenge_field"],
 120       $_POST["recaptcha_response_field"]
 121     );
 122     return $resp->is_valid;
 123   }
 124 }
 125