Commit | Line | Data |
---|---|---|
6a488035 TO |
1 | <?php |
2 | /* | |
3 | +--------------------------------------------------------------------+ | |
fee14197 | 4 | | CiviCRM version 5 | |
6a488035 | 5 | +--------------------------------------------------------------------+ |
6b83d5bd | 6 | | Copyright CiviCRM LLC (c) 2004-2019 | |
6a488035 TO |
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 | +--------------------------------------------------------------------+ | |
d25dd0ee | 26 | */ |
6a488035 TO |
27 | |
28 | /** | |
29 | * | |
30 | * @package CRM | |
6b83d5bd | 31 | * @copyright CiviCRM LLC (c) 2004-2019 |
6a488035 TO |
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 | /** | |
e8e8f3ad | 44 | * Singleton. |
45 | * | |
6a488035 TO |
46 | * We only need one instance of this object. So we use the singleton |
47 | * pattern and cache the instance in this variable | |
48 | * | |
e8e8f3ad | 49 | * @var CRM_Utils_ReCAPTCHA |
6a488035 TO |
50 | */ |
51 | static private $_singleton = NULL; | |
52 | ||
53 | /** | |
fe482240 | 54 | * Singleton function used to manage this object. |
6a488035 | 55 | * |
6a488035 | 56 | * @return object |
6a488035 | 57 | */ |
00be9182 | 58 | public static function &singleton() { |
6a488035 TO |
59 | if (self::$_singleton === NULL) { |
60 | self::$_singleton = new CRM_Utils_ReCAPTCHA(); | |
61 | } | |
62 | return self::$_singleton; | |
63 | } | |
64 | ||
8237b510 AP |
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 | ||
ce287b85 AP |
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 | ||
6a488035 | 87 | /** |
fe482240 | 88 | * Add element to form. |
54957108 | 89 | * |
90 | * @param CRM_Core_Form $form | |
6a488035 | 91 | */ |
00be9182 | 92 | public static function add(&$form) { |
353ffa53 | 93 | $error = NULL; |
6a488035 TO |
94 | $config = CRM_Core_Config::singleton(); |
95 | $useSSL = FALSE; | |
481a74f4 | 96 | if (!function_exists('recaptcha_get_html')) { |
14e15f46 | 97 | require_once 'packages/recaptcha/recaptchalib.php'; |
d2485799 | 98 | } |
6a488035 | 99 | |
4ab92bbc AM |
100 | // Load the Recaptcha api.js over HTTPS |
101 | $useHTTPS = TRUE; | |
102 | ||
103 | $html = recaptcha_get_html($config->recaptchaPublicKey, $error, $useHTTPS); | |
6a488035 TO |
104 | |
105 | $form->assign('recaptchaHTML', $html); | |
106 | $form->assign('recaptchaOptions', $config->recaptchaOptions); | |
107 | $form->add( | |
108 | 'text', | |
3c275f0d WA |
109 | 'g-recaptcha-response', |
110 | 'reCaptcha', | |
6a488035 TO |
111 | NULL, |
112 | TRUE | |
113 | ); | |
6a488035 | 114 | $form->registerRule('recaptcha', 'callback', 'validate', 'CRM_Utils_ReCAPTCHA'); |
3c275f0d WA |
115 | if ($form->isSubmitted() && empty($form->_submitValues['g-recaptcha-response'])) { |
116 | $form->setElementError( | |
117 | 'g-recaptcha-response', | |
50c010c7 | 118 | ts('Please go back and complete the CAPTCHA at the bottom of this form.') |
3c275f0d WA |
119 | ); |
120 | } | |
6a488035 | 121 | } |
96025800 | 122 | |
6a488035 | 123 | } |