3a4559878662c5bd9ca12ed1f8b56298b3f0ac30
3 +--------------------------------------------------------------------+
4 | CiviCRM version 4.7 |
5 +--------------------------------------------------------------------+
6 | Copyright CiviCRM LLC (c) 2004-2016 |
7 +--------------------------------------------------------------------+
8 | This file is a part of CiviCRM. |
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. |
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. |
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 +--------------------------------------------------------------------+
31 * @copyright CiviCRM LLC (c) 2004-2016
37 * This is base class for all ajax calls
39 class CRM_Core_Page_AJAX
{
42 * Call generic ajax forms.
45 public static function run() {
46 $className = CRM_Utils_Type
::escape($_REQUEST['class_name'], 'String');
48 if (!empty($_REQUEST['type'])) {
49 $type = CRM_Utils_Type
::escape($_REQUEST['type'], 'String');
53 CRM_Core_Error
::fatal(ts('Invalid className: %1', array(1 => $className)));
57 if (isset($_REQUEST['fn_name'])) {
58 $fnName = CRM_Utils_Type
::escape($_REQUEST['fn_name'], 'String');
61 if (!self
::checkAuthz($type, $className, $fnName)) {
62 CRM_Utils_System
::civiExit();
67 call_user_func(array($className, $fnName));
73 // FIXME: This is done to maintain current wire protocol, but it might be
74 // simpler to just require different 'types' for pages and forms
75 if (preg_match('/^CRM_[a-zA-Z0-9]+_Page_Inline_/', $className)) {
76 $page = new $className();
80 $wrapper = new CRM_Utils_Wrapper();
81 $wrapper->run($className);
86 CRM_Core_Error
::debug_log_message('Unsupported inline request type: ' . var_export($type, TRUE));
88 CRM_Utils_System
::civiExit();
92 * Change is_quick_config priceSet to complex.
95 public static function setIsQuickConfig() {
96 $id = $context = NULL;
97 if (!empty($_REQUEST['id'])) {
98 $id = CRM_Utils_Type
::escape($_REQUEST['id'], 'Integer');
101 if (!empty($_REQUEST['context'])) {
102 $context = CRM_Utils_Type
::escape($_REQUEST['context'], 'String');
104 // return false if $id is null and
105 // $context is not civicrm_event or civicrm_contribution_page
106 if (!$id ||
!in_array($context, array('civicrm_event', 'civicrm_contribution_page'))) {
109 $priceSetId = CRM_Price_BAO_PriceSet
::getFor($context, $id, NULL);
111 $result = CRM_Price_BAO_PriceSet
::setIsQuickConfig($priceSetId, 0);
112 if ($context == 'civicrm_event') {
114 civicrm_price_set cps
115 INNER JOIN civicrm_discount cd ON cd.price_set_id = cps.id
116 SET cps.is_quick_config = 0
117 WHERE cd.entity_id = (%1) AND cd.entity_table = 'civicrm_event' ";
118 $params = array(1 => array($id, 'Integer'));
119 CRM_Core_DAO
::executeQuery($sql, $params);
120 CRM_Core_BAO_Discount
::del($id, $context);
126 CRM_Utils_JSON
::output($priceSetId);
130 * Determine whether the request is for a valid class/method name.
132 * @param string $type
133 * 'method'|'class'|''.
134 * @param string $className
136 * @param string $fnName
141 public static function checkAuthz($type, $className, $fnName = NULL) {
144 if (!preg_match('/^CRM_[a-zA-Z0-9]+_Page_AJAX$/', $className)) {
147 if (!preg_match('/^[a-zA-Z0-9]+$/', $fnName)) {
151 // ensure that function exists
152 return method_exists($className, $fnName);
157 if (!preg_match('/^CRM_[a-zA-Z0-9]+_(Page|Form)_Inline_[a-zA-Z0-9]+$/', $className)) {
160 return class_exists($className);
168 * Outputs the CiviCRM standard json-formatted page/form response
169 * @param array|string $response
171 public static function returnJsonResponse($response) {
172 // Allow lazy callers to not wrap content in an array
173 if (is_string($response)) {
174 $response = array('content' => $response);
176 // Add session variables to response
177 $session = CRM_Core_Session
::singleton();
179 'status' => 'success',
180 'userContext' => htmlspecialchars_decode($session->readUserContext()),
181 'title' => CRM_Utils_System
::$title,
183 // crmMessages will be automatically handled by our ajax preprocessor
185 if ($session->getStatus(FALSE)) {
186 $response['crmMessages'] = $session->getStatus(TRUE);
188 $output = json_encode($response);
190 // CRM-11831 @see http://www.malsup.com/jquery/form/#file-upload
191 if (isset($_SERVER['HTTP_X_REQUESTED_WITH']) && $_SERVER['HTTP_X_REQUESTED_WITH'] == 'XMLHttpRequest') {
192 CRM_Utils_System
::setHttpHeader('Content-Type', 'application/json');
195 $output = "<textarea>$output</textarea>";
198 CRM_Utils_System
::civiExit();
202 * Set headers appropriate for a js file.
204 * @param int|NULL $ttl
205 * Time-to-live (seconds).
207 public static function setJsHeaders($ttl = NULL) {
209 // Encourage browsers to cache for a long time - 1 year
210 $ttl = 60 * 60 * 24 * 364;
212 CRM_Utils_System
::setHttpHeader('Expires', gmdate('D, d M Y H:i:s \G\M\T', time() +
$ttl));
213 CRM_Utils_System
::setHttpHeader('Content-Type', 'application/javascript');
214 CRM_Utils_System
::setHttpHeader('Cache-Control', "max-age=$ttl, public");
217 public static function defaultSortAndPagerParams($defaultOffset = 0, $defaultRowCount = 25, $defaultSort = NULL, $defaultsortOrder = 'asc') {
219 '_raw_values' => array(),
222 $sortMapper = array();
223 foreach ($_GET['columns'] as $key => $value) {
224 $sortMapper[$key] = CRM_Utils_Type
::escape($value['data'], 'MysqlColumnName');
227 $offset = isset($_GET['start']) ? CRM_Utils_Type
::validate($_GET['start'], 'Integer') : $defaultOffset;
228 $rowCount = isset($_GET['length']) ? CRM_Utils_Type
::validate($_GET['length'], 'Integer') : $defaultRowCount;
229 // Why is the number of order by columns limited to 1?
230 $sort = isset($_GET['order'][0]['column']) ? CRM_Utils_Array
::value(CRM_Utils_Type
::validate($_GET['order'][0]['column'], 'Integer'), $sortMapper) : $defaultSort;
231 $sortOrder = isset($_GET['order'][0]['dir']) ? CRM_Utils_Type
::validate($_GET['order'][0]['dir'], 'MysqlOrderByDirection') : $defaultsortOrder;
234 $params['sortBy'] = "`{$sort}` {$sortOrder}";
236 $params['_raw_values']['sort'][0] = $sort;
237 $params['_raw_values']['order'][0] = $sortOrder;
240 $params['offset'] = $offset;
241 $params['rp'] = $rowCount;
242 $params['page'] = ($offset / $rowCount) +
1;
247 public static function validateParams($requiredParams = array(), $optionalParams = array()) {
250 foreach ($requiredParams as $param => $type) {
251 $params[$param] = CRM_Utils_Type
::validate(CRM_Utils_Array
::value($param, $_GET), $type);
254 foreach ($optionalParams as $param => $type) {
255 if (CRM_Utils_Array
::value($param, $_GET)) {
256 $params[$param] = CRM_Utils_Type
::validate(CRM_Utils_Array
::value($param, $_GET), $type);