CRM/Utils/ReCAPTCHA.php

   1 <?php
   2 /*
   3  +--------------------------------------------------------------------+
   4  | CiviCRM version 5                                                  |
   5  +--------------------------------------------------------------------+
   6  | Copyright CiviCRM LLC (c) 2004-2019                                |
   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-2019
  32  */
  33 class CRM_Utils_ReCAPTCHA {
  34
  35   protected $_captcha = NULL;
  36
  37   protected $_name = NULL;
  38
  39   protected $_url = NULL;
  40
  41   protected $_phrase = NULL;
  42
  43   /**
  44    * Singleton.
  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 CRM_Utils_ReCAPTCHA
  50    */
  51   static private $_singleton = NULL;
  52
  53   /**
  54    * Singleton function used to manage this object.
  55    *
  56    * @return object
  57    */
  58   public static function &singleton() {
  59     if (self::$_singleton === NULL) {
  60       self::$_singleton = new CRM_Utils_ReCAPTCHA();
  61     }
  62     return self::$_singleton;
  63   }
  64
  65   /**
  66    * Check if reCaptcha settings is avilable to add on form.
  67    */
  68   public static function hasSettingsAvailable() {
  69     $config = CRM_Core_Config::singleton();
  70     if ($config->recaptchaPublicKey == NULL || $config->recaptchaPublicKey == "") {
  71       return FALSE;
  72     }
  73     return TRUE;
  74   }
  75
  76   /**
  77    * Check if reCaptcha has to be added on form forcefully.
  78    */
  79   public static function hasToAddForcefully() {
  80     $config = CRM_Core_Config::singleton();
  81     if (!$config->forceRecaptcha) {
  82       return FALSE;
  83     }
  84     return TRUE;
  85   }
  86
  87   /**
  88    * Add element to form.
  89    *
  90    * @param CRM_Core_Form $form
  91    */
  92   public static function add(&$form) {
  93     $error = NULL;
  94     $config = CRM_Core_Config::singleton();
  95     $useSSL = FALSE;
  96     if (!function_exists('recaptcha_get_html')) {
  97       require_once 'packages/recaptcha/recaptchalib.php';
  98     }
  99
 100     // Load the Recaptcha api.js over HTTPS
 101     $useHTTPS = TRUE;
 102
 103     $html = recaptcha_get_html($config->recaptchaPublicKey, $error, $useHTTPS);
 104
 105     $form->assign('recaptchaHTML', $html);
 106     $form->assign('recaptchaOptions', $config->recaptchaOptions);
 107     $form->add(
 108       'text',
 109       'g-recaptcha-response',
 110       'reCaptcha',
 111       NULL,
 112       TRUE
 113     );
 114     $form->registerRule('recaptcha', 'callback', 'validate', 'CRM_Utils_ReCAPTCHA');
 115     if ($form->isSubmitted() && empty($form->_submitValues['g-recaptcha-response'])) {
 116       $form->setElementError(
 117         'g-recaptcha-response',
 118         ts('Please go back and complete the CAPTCHA at the bottom of this form.')
 119       );
 120     }
 121   }
 122
 123   /**
 124    * Enable ReCAPTCHA on Contribution form
 125    *
 126    * @param CRM_Core_Form $form
 127    */
 128   public static function enableCaptchaOnForm(&$form) {
 129     $captcha = CRM_Utils_ReCAPTCHA::singleton();
 130     if ($captcha->hasSettingsAvailable()) {
 131       $captcha->add($form);
 132       $form->assign('isCaptcha', TRUE);
 133     }
 134   }
 135
 136 }