Commit | Line | Data |
---|---|---|
6a488035 | 1 | <?php |
6a488035 TO |
2 | /* |
3 | +--------------------------------------------------------------------+ | |
731a0992 | 4 | | CiviCRM version 4.5 | |
6a488035 | 5 | +--------------------------------------------------------------------+ |
731a0992 | 6 | | Copyright CiviCRM LLC (c) 2004-2014 | |
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 | +--------------------------------------------------------------------+ | |
26 | */ | |
27 | ||
28 | /** | |
29 | * File for CiviCRM APIv3 utilitity functions | |
30 | * | |
31 | * @package CiviCRM_APIv3 | |
32 | * @subpackage API_utils | |
33 | * | |
731a0992 | 34 | * @copyright CiviCRM LLC (c) 2004-2014 |
6a488035 TO |
35 | * @version $Id: utils.php 30879 2010-11-22 15:45:55Z shot $ |
36 | * | |
37 | */ | |
38 | ||
39 | /** | |
40 | * Initialize CiviCRM - should be run at the start of each API function | |
41 | */ | |
42 | function _civicrm_api3_initialize() { | |
22fd1690 ARW |
43 | require_once 'CRM/Core/ClassLoader.php'; |
44 | CRM_Core_ClassLoader::singleton()->register(); | |
45 | CRM_Core_Config::singleton(); | |
46 | } | |
6a488035 | 47 | |
11e09c59 | 48 | /** |
6a488035 TO |
49 | * Wrapper Function for civicrm_verify_mandatory to make it simple to pass either / or fields for checking |
50 | * | |
44248b7e | 51 | * @param array $params array of fields to checkl |
6a488035 | 52 | * @param array $daoName string DAO to check for required fields (create functions only) |
26728d3f E |
53 | * @param array $keyoptions |
54 | * | |
55 | * @internal param array $keys list of required fields options. One of the options is required | |
6a488035 | 56 | * @return null or throws error if there the required fields not present |
6a488035 | 57 | * @ |
6a488035 TO |
58 | */ |
59 | function civicrm_api3_verify_one_mandatory($params, $daoName = NULL, $keyoptions = array( | |
60 | )) { | |
61 | $keys = array(array()); | |
62 | foreach ($keyoptions as $key) { | |
63 | $keys[0][] = $key; | |
64 | } | |
65 | civicrm_api3_verify_mandatory($params, $daoName, $keys); | |
66 | } | |
67 | ||
11e09c59 | 68 | /** |
6a488035 TO |
69 | * Function to check mandatory fields are included |
70 | * | |
71 | * @param array $params array of fields to check | |
72 | * @param array $daoName string DAO to check for required fields (create functions only) | |
73 | * @param array $keys list of required fields. A value can be an array denoting that either this or that is required. | |
74 | * @param bool $verifyDAO | |
75 | * | |
916b48b6 | 76 | * @throws API_Exception |
6a488035 TO |
77 | * @return null or throws error if there the required fields not present |
78 | * | |
79 | * @todo see notes on _civicrm_api3_check_required_fields regarding removing $daoName param | |
80 | */ | |
27b9f49a | 81 | function civicrm_api3_verify_mandatory($params, $daoName = NULL, $keys = array(), $verifyDAO = TRUE) { |
6a488035 TO |
82 | |
83 | $unmatched = array(); | |
84 | if ($daoName != NULL && $verifyDAO && empty($params['id'])) { | |
85 | $unmatched = _civicrm_api3_check_required_fields($params, $daoName, TRUE); | |
86 | if (!is_array($unmatched)) { | |
87 | $unmatched = array(); | |
88 | } | |
89 | } | |
90 | ||
91 | if (!empty($params['id'])) { | |
92 | $keys = array('version'); | |
93 | } | |
94 | else { | |
95 | if (!in_array('version', $keys)) { | |
96 | // required from v3 onwards | |
97 | $keys[] = 'version'; | |
98 | } | |
99 | } | |
100 | foreach ($keys as $key) { | |
101 | if (is_array($key)) { | |
102 | $match = 0; | |
103 | $optionset = array(); | |
104 | foreach ($key as $subkey) { | |
105 | if (!array_key_exists($subkey, $params) || empty($params[$subkey])) { | |
106 | $optionset[] = $subkey; | |
107 | } | |
108 | else { | |
109 | // as long as there is one match then we don't need to rtn anything | |
110 | $match = 1; | |
111 | } | |
112 | } | |
113 | if (empty($match) && !empty($optionset)) { | |
114 | $unmatched[] = "one of (" . implode(", ", $optionset) . ")"; | |
115 | } | |
116 | } | |
117 | else { | |
5ba3bfc8 CW |
118 | // Disallow empty values except for the number zero. |
119 | // TODO: create a utility for this since it's needed in many places | |
120 | if (!array_key_exists($key, $params) || (empty($params[$key]) && $params[$key] !== 0 && $params[$key] !== '0')) { | |
6a488035 TO |
121 | $unmatched[] = $key; |
122 | } | |
123 | } | |
124 | } | |
125 | if (!empty($unmatched)) { | |
126 | throw new API_Exception("Mandatory key(s) missing from params array: " . implode(", ", $unmatched),"mandatory_missing",array("fields"=>$unmatched)); | |
127 | } | |
128 | } | |
129 | ||
130 | /** | |
131 | * | |
6a488035 | 132 | * @param <type> $data |
916b48b6 | 133 | * @param array $data |
6a488035 | 134 | * |
916b48b6 VU |
135 | * @throws API_Exception |
136 | * @return array <type> | |
6a488035 | 137 | */ |
9c465c3b | 138 | function civicrm_api3_create_error($msg, $data = array()) { |
6a488035 TO |
139 | $data['is_error'] = 1; |
140 | $data['error_message'] = $msg; | |
9c465c3b TO |
141 | // we will show sql to privileged user only (not sure of a specific |
142 | // security hole here but seems sensible - perhaps should apply to the trace as well?) | |
e7c4a581 | 143 | if(isset($data['sql']) && CRM_Core_Permission::check('Administer CiviCRM')) { |
2baf21cf TO |
144 | $data['debug_information'] = $data['sql']; // Isn't this redundant? |
145 | } else { | |
146 | unset($data['sql']); | |
e7c4a581 | 147 | } |
6a488035 TO |
148 | return $data; |
149 | } | |
150 | ||
151 | /** | |
152 | * Format array in result output styple | |
153 | * | |
77b97be7 | 154 | * @param array|int $values values generated by API operation (the result) |
6a488035 TO |
155 | * @param array $params parameters passed into API call |
156 | * @param string $entity the entity being acted on | |
157 | * @param string $action the action passed to the API | |
158 | * @param object $dao DAO object to be freed here | |
159 | * @param array $extraReturnValues additional values to be added to top level of result array( | |
160 | * - this param is currently used for legacy behaviour support | |
161 | * | |
162 | * @return array $result | |
163 | */ | |
54df0f0c | 164 | function civicrm_api3_create_success($values = 1, $params = array(), $entity = NULL, $action = NULL, &$dao = NULL, $extraReturnValues = array()) { |
6a488035 TO |
165 | $result = array(); |
166 | $result['is_error'] = 0; | |
167 | //lets set the ['id'] field if it's not set & we know what the entity is | |
168 | if (is_array($values) && !empty($entity)) { | |
169 | foreach ($values as $key => $item) { | |
170 | if (empty($item['id']) && !empty($item[$entity . "_id"])) { | |
171 | $values[$key]['id'] = $item[$entity . "_id"]; | |
172 | } | |
a1c68fd2 | 173 | if(!empty($item['financial_type_id'])){ |
797b807e | 174 | //4.3 legacy handling |
a1c68fd2 | 175 | $values[$key]['contribution_type_id'] = $item['financial_type_id']; |
176 | } | |
797b807e | 177 | if(!empty($item['next_sched_contribution_date'])){ |
178 | // 4.4 legacy handling | |
179 | $values[$key]['next_sched_contribution'] = $item['next_sched_contribution_date']; | |
180 | } | |
6a488035 TO |
181 | } |
182 | } | |
d8453bed | 183 | |
184 | if (is_array($params) && !empty($params['debug'])) { | |
6a488035 TO |
185 | if (is_string($action) && $action != 'getfields') { |
186 | $apiFields = civicrm_api($entity, 'getfields', array('version' => 3, 'action' => $action) + $params); | |
187 | } | |
188 | elseif ($action != 'getfields') { | |
189 | $apiFields = civicrm_api($entity, 'getfields', array('version' => 3) + $params); | |
190 | } | |
191 | else { | |
192 | $apiFields = FALSE; | |
193 | } | |
194 | ||
195 | $allFields = array(); | |
196 | if ($action != 'getfields' && is_array($apiFields) && is_array(CRM_Utils_Array::value('values', $apiFields))) { | |
197 | $allFields = array_keys($apiFields['values']); | |
198 | } | |
199 | $paramFields = array_keys($params); | |
e4176358 | 200 | $undefined = array_diff($paramFields, $allFields, array_keys($_COOKIE), array('action', 'entity', 'debug', 'version', 'check_permissions', 'IDS_request_uri', 'IDS_user_agent', 'return', 'sequential', 'rowCount', 'option_offset', 'option_limit', 'custom', 'option_sort', 'options', 'prettyprint')); |
6a488035 TO |
201 | if ($undefined) { |
202 | $result['undefined_fields'] = array_merge($undefined); | |
203 | } | |
204 | } | |
205 | if (is_object($dao)) { | |
206 | $dao->free(); | |
207 | } | |
208 | ||
209 | $result['version'] = 3; | |
210 | if (is_array($values)) { | |
e7c4a581 | 211 | $result['count'] = (int) count($values); |
6a488035 TO |
212 | |
213 | // Convert value-separated strings to array | |
214 | _civicrm_api3_separate_values($values); | |
215 | ||
216 | if ($result['count'] == 1) { | |
217 | list($result['id']) = array_keys($values); | |
218 | } | |
219 | elseif (!empty($values['id']) && is_int($values['id'])) { | |
220 | $result['id'] = $values['id']; | |
221 | } | |
222 | } | |
223 | else { | |
224 | $result['count'] = !empty($values) ? 1 : 0; | |
225 | } | |
226 | ||
227 | if (is_array($values) && isset($params['sequential']) && | |
228 | $params['sequential'] == 1 | |
229 | ) { | |
230 | $result['values'] = array_values($values); | |
231 | } | |
232 | else { | |
233 | $result['values'] = $values; | |
234 | } | |
44248b7e | 235 | if(!empty($params['options']['metadata'])) { |
236 | // we've made metadata an array but only supporting 'fields' atm | |
c275764e | 237 | if(in_array('fields', (array) $params['options']['metadata'])) { |
54df0f0c | 238 | $fields = civicrm_api3($entity, 'getfields', array('action' => substr($action, 0, 3) == 'get' ? 'get' : 'create')); |
dc5a7701 E |
239 | $result['metadata']['fields'] = $fields['values']; |
240 | } | |
241 | } | |
6a488035 TO |
242 | return array_merge($result, $extraReturnValues); |
243 | } | |
11e09c59 TO |
244 | |
245 | /** | |
6a488035 TO |
246 | * Load the DAO of the entity |
247 | */ | |
248 | function _civicrm_api3_load_DAO($entity) { | |
249 | $dao = _civicrm_api3_get_DAO($entity); | |
250 | if (empty($dao)) { | |
251 | return FALSE; | |
252 | } | |
6a488035 TO |
253 | $d = new $dao(); |
254 | return $d; | |
255 | } | |
11e09c59 TO |
256 | |
257 | /** | |
6a488035 | 258 | * Function to return the DAO of the function or Entity |
26728d3f | 259 | * @param String $name either a function of the api (civicrm_{entity}_create or the entity name |
6a488035 TO |
260 | * return the DAO name to manipulate this function |
261 | * eg. "civicrm_api3_contact_create" or "Contact" will return "CRM_Contact_BAO_Contact" | |
26728d3f | 262 | * @return mixed|string |
6a488035 TO |
263 | */ |
264 | function _civicrm_api3_get_DAO($name) { | |
6a488035 TO |
265 | if (strpos($name, 'civicrm_api3') !== FALSE) { |
266 | $last = strrpos($name, '_'); | |
267 | // len ('civicrm_api3_') == 13 | |
268 | $name = substr($name, 13, $last - 13); | |
269 | } | |
270 | ||
663072a5 | 271 | $name = _civicrm_api_get_camel_name($name, 3); |
6a488035 | 272 | |
663072a5 | 273 | if ($name == 'Individual' || $name == 'Household' || $name == 'Organization') { |
6a488035 TO |
274 | $name = 'Contact'; |
275 | } | |
276 | ||
da54ec85 CW |
277 | // hack to deal with incorrectly named BAO/DAO - see CRM-10859 |
278 | ||
279 | // FIXME: DAO should be renamed CRM_Mailing_DAO_MailingRecipients | |
280 | // but am not confident mailing_recipients is tested so have not tackled. | |
663072a5 | 281 | if ($name == 'MailingRecipients') { |
da54ec85 | 282 | return 'CRM_Mailing_DAO_Recipients'; |
6a488035 | 283 | } |
d615ccf5 CW |
284 | // FIXME: DAO should be renamed CRM_Mailing_DAO_MailingComponent |
285 | if ($name == 'MailingComponent') { | |
286 | return 'CRM_Mailing_DAO_Component'; | |
287 | } | |
da54ec85 | 288 | // FIXME: DAO should be renamed CRM_ACL_DAO_AclRole |
663072a5 CW |
289 | if ($name == 'AclRole') { |
290 | return 'CRM_ACL_DAO_EntityRole'; | |
291 | } | |
da54ec85 CW |
292 | // FIXME: DAO should be renamed CRM_SMS_DAO_SmsProvider |
293 | // But this would impact SMS extensions so need to coordinate | |
294 | // Probably best approach is to migrate them to use the api and decouple them from core BAOs | |
295 | if ($name == 'SmsProvider') { | |
296 | return 'CRM_SMS_DAO_Provider'; | |
297 | } | |
298 | // FIXME: DAO names should follow CamelCase convention | |
663072a5 | 299 | if ($name == 'Im' || $name == 'Acl') { |
1fe97a01 | 300 | $name = strtoupper($name); |
6a488035 | 301 | } |
23474ab3 | 302 | $dao = CRM_Core_DAO_AllCoreTables::getFullName($name); |
9537a4e1 | 303 | if ($dao || !$name) { |
23474ab3 CW |
304 | return $dao; |
305 | } | |
306 | ||
307 | // Really weird apis can declare their own DAO name. Not sure if this is a good idea... | |
db47ea7b | 308 | if(file_exists("api/v3/$name.php")) { |
309 | include_once "api/v3/$name.php"; | |
310 | } | |
23474ab3 CW |
311 | $daoFn = "_civicrm_api3_" . _civicrm_api_get_entity_name_from_camel($name) . "_DAO"; |
312 | if (function_exists($daoFn)) { | |
313 | return $daoFn(); | |
314 | } | |
315 | ||
316 | return NULL; | |
6a488035 TO |
317 | } |
318 | ||
11e09c59 | 319 | /** |
6a488035 | 320 | * Function to return the DAO of the function or Entity |
26728d3f | 321 | * @param String $name is either a function of the api (civicrm_{entity}_create or the entity name |
6a488035 TO |
322 | * return the DAO name to manipulate this function |
323 | * eg. "civicrm_contact_create" or "Contact" will return "CRM_Contact_BAO_Contact" | |
26728d3f | 324 | * @return mixed |
6a488035 TO |
325 | */ |
326 | function _civicrm_api3_get_BAO($name) { | |
da54ec85 CW |
327 | // FIXME: DAO should be renamed CRM_Badge_DAO_BadgeLayout |
328 | if ($name == 'PrintLabel') { | |
329 | return 'CRM_Badge_BAO_Layout'; | |
330 | } | |
6a488035 | 331 | $dao = _civicrm_api3_get_DAO($name); |
5c1174d3 CW |
332 | if (!$dao) { |
333 | return NULL; | |
334 | } | |
d9f036bb | 335 | $bao = str_replace("DAO", "BAO", $dao); |
49e101d0 | 336 | $file = strtr($bao, '_', '/') . '.php'; |
5c1174d3 | 337 | // Check if this entity actually has a BAO. Fall back on the DAO if not. |
49e101d0 | 338 | return stream_resolve_include_path($file) ? $bao : $dao; |
6a488035 TO |
339 | } |
340 | ||
341 | /** | |
342 | * Recursive function to explode value-separated strings into arrays | |
343 | * | |
344 | */ | |
345 | function _civicrm_api3_separate_values(&$values) { | |
346 | $sp = CRM_Core_DAO::VALUE_SEPARATOR; | |
347 | foreach ($values as $key => & $value) { | |
348 | if (is_array($value)) { | |
349 | _civicrm_api3_separate_values($value); | |
350 | } | |
351 | elseif (is_string($value)) { | |
352 | if($key == 'case_type_id'){// this is to honor the way case API was originally written | |
353 | $value = trim(str_replace($sp, ',', $value), ','); | |
354 | } | |
355 | elseif (strpos($value, $sp) !== FALSE) { | |
356 | $value = explode($sp, trim($value, $sp)); | |
357 | } | |
358 | } | |
359 | } | |
360 | } | |
11e09c59 TO |
361 | |
362 | /** | |
d4251d65 | 363 | * This is a legacy wrapper for api_store_values which will check the suitable fields using getfields |
6a488035 TO |
364 | * rather than DAO->fields |
365 | * | |
366 | * Getfields has handling for how to deal with uniquenames which dao->fields doesn't | |
367 | * | |
368 | * Note this is used by BAO type create functions - eg. contribution | |
369 | * @param string $entity | |
370 | * @param array $params | |
371 | * @param array $values | |
372 | */ | |
373 | function _civicrm_api3_filter_fields_for_bao($entity, &$params, &$values){ | |
374 | $fields = civicrm_api($entity,'getfields', array('version' => 3,'action' => 'create')); | |
375 | $fields = $fields['values']; | |
376 | _civicrm_api3_store_values($fields, $params, $values); | |
377 | } | |
378 | /** | |
379 | * | |
380 | * @param array $fields | |
381 | * @param array $params | |
382 | * @param array $values | |
383 | * | |
384 | * @return Bool $valueFound | |
385 | */ | |
386 | function _civicrm_api3_store_values(&$fields, &$params, &$values) { | |
387 | $valueFound = FALSE; | |
388 | ||
389 | $keys = array_intersect_key($params, $fields); | |
390 | foreach ($keys as $name => $value) { | |
391 | if ($name !== 'id') { | |
392 | $values[$name] = $value; | |
393 | $valueFound = TRUE; | |
394 | } | |
395 | } | |
396 | return $valueFound; | |
397 | } | |
26728d3f | 398 | |
6a488035 TO |
399 | /** |
400 | * The API supports 2 types of get requestion. The more complex uses the BAO query object. | |
401 | * This is a generic function for those functions that call it | |
402 | * | |
403 | * At the moment only called by contact we should extend to contribution & | |
404 | * others that use the query object. Note that this function passes permission information in. | |
405 | * The others don't | |
406 | * | |
82f7d8b2 EM |
407 | * * Ideally this would be merged with _civicrm_get_query_object but we need to resolve differences in what the |
408 | * 2 variants call | |
26728d3f | 409 | * @param $entity |
6a488035 | 410 | * @param array $params as passed into api get or getcount function |
26728d3f | 411 | * @param array $additional_options |
6a488035 | 412 | * @param bool $getCount are we just after the count |
26728d3f E |
413 | * |
414 | * @return | |
415 | * @internal param array $options array of options (so we can modify the filter) | |
6a488035 | 416 | */ |
53ed8466 | 417 | function _civicrm_api3_get_using_query_object($entity, $params, $additional_options = array(), $getCount = NULL){ |
6a488035 TO |
418 | |
419 | // Convert id to e.g. contact_id | |
420 | if (empty($params[$entity . '_id']) && isset($params['id'])) { | |
421 | $params[$entity . '_id'] = $params['id']; | |
422 | } | |
423 | unset($params['id']); | |
424 | ||
425 | $options = _civicrm_api3_get_options_from_params($params, TRUE); | |
426 | ||
427 | $inputParams = array_merge( | |
428 | CRM_Utils_Array::value('input_params', $options, array()), | |
429 | CRM_Utils_Array::value('input_params', $additional_options, array()) | |
430 | ); | |
431 | $returnProperties = array_merge( | |
432 | CRM_Utils_Array::value('return', $options, array()), | |
433 | CRM_Utils_Array::value('return', $additional_options, array()) | |
434 | ); | |
435 | if(empty($returnProperties)){ | |
53ed8466 | 436 | $returnProperties = NULL; |
6a488035 TO |
437 | } |
438 | if(!empty($params['check_permissions'])){ | |
439 | // we will filter query object against getfields | |
440 | $fields = civicrm_api($entity, 'getfields', array('version' => 3, 'action' => 'get')); | |
441 | // we need to add this in as earlier in this function 'id' was unset in favour of $entity_id | |
442 | $fields['values'][$entity . '_id'] = array(); | |
443 | $varsToFilter = array('returnProperties', 'inputParams'); | |
444 | foreach ($varsToFilter as $varToFilter){ | |
445 | if(!is_array($$varToFilter)){ | |
446 | continue; | |
447 | } | |
448 | //I was going to throw an exception rather than silently filter out - but | |
449 | //would need to diff out of exceptions arr other keys like 'options', 'return', 'api. etcetc | |
450 | //so we are silently ignoring parts of their request | |
451 | //$exceptionsArr = array_diff(array_keys($$varToFilter), array_keys($fields['values'])); | |
452 | $$varToFilter = array_intersect_key($$varToFilter, $fields['values']); | |
453 | } | |
454 | } | |
455 | $options = array_merge($options,$additional_options); | |
456 | $sort = CRM_Utils_Array::value('sort', $options, NULL); | |
457 | $offset = CRM_Utils_Array::value('offset', $options, NULL); | |
458 | $limit = CRM_Utils_Array::value('limit', $options, NULL); | |
459 | $smartGroupCache = CRM_Utils_Array::value('smartGroupCache', $params); | |
460 | ||
461 | if($getCount){ | |
462 | $limit = NULL; | |
463 | $returnProperties = NULL; | |
464 | } | |
465 | ||
466 | $newParams = CRM_Contact_BAO_Query::convertFormValues($inputParams); | |
78c0bfc0 | 467 | foreach ($newParams as &$newParam) { |
468 | if($newParam[1] == '=' && is_array($newParam[2])) { | |
469 | // we may be looking at an attempt to use the 'IN' style syntax | |
470 | // @todo at time of writing only 'IN' & 'NOT IN' are supported for the array style syntax | |
471 | $sqlFilter = CRM_Core_DAO::createSqlFilter($newParam[0], $params[$newParam[0]], 'String', NULL, TRUE); | |
472 | if($sqlFilter) { | |
473 | $newParam[1] = key($newParam[2]); | |
474 | $newParam[2] = $sqlFilter; | |
475 | } | |
476 | } | |
477 | ||
478 | } | |
d031c654 | 479 | |
0d8afee2 | 480 | $skipPermissions = !empty($params['check_permissions']) ? 0 :1; |
78c0bfc0 | 481 | |
6a488035 TO |
482 | list($entities, $options) = CRM_Contact_BAO_Query::apiQuery( |
483 | $newParams, | |
484 | $returnProperties, | |
485 | NULL, | |
486 | $sort, | |
487 | $offset , | |
488 | $limit, | |
489 | $smartGroupCache, | |
490 | $getCount, | |
491 | $skipPermissions | |
492 | ); | |
493 | if ($getCount) { // only return the count of contacts | |
494 | return $entities; | |
495 | } | |
496 | ||
497 | return $entities; | |
498 | } | |
11e09c59 | 499 | |
82f7d8b2 EM |
500 | /** |
501 | * get dao query object based on input params | |
502 | * Ideally this would be merged with _civicrm_get_using_query_object but we need to resolve differences in what the | |
503 | * 2 variants call | |
504 | * | |
505 | * @param array $params | |
506 | * @param string $mode | |
507 | * @param string $entity | |
508 | * @return CRM_Core_DAO query object | |
509 | */ | |
510 | function _civicrm_api3_get_query_object($params, $mode, $entity) { | |
511 | $options = _civicrm_api3_get_options_from_params($params, TRUE, $entity, 'get'); | |
512 | $sort = CRM_Utils_Array::value('sort', $options, NULL); | |
513 | $offset = CRM_Utils_Array::value('offset', $options); | |
514 | $rowCount = CRM_Utils_Array::value('limit', $options); | |
515 | $inputParams = CRM_Utils_Array::value('input_params', $options, array()); | |
516 | $returnProperties = CRM_Utils_Array::value('return', $options, NULL); | |
517 | if (empty($returnProperties)) { | |
518 | $returnProperties = CRM_Contribute_BAO_Query::defaultReturnProperties($mode); | |
519 | } | |
520 | ||
521 | $newParams = CRM_Contact_BAO_Query::convertFormValues($inputParams); | |
522 | $query = new CRM_Contact_BAO_Query($newParams, $returnProperties, NULL, | |
523 | FALSE, FALSE, $mode | |
524 | ); | |
525 | list($select, $from, $where, $having) = $query->query(); | |
526 | ||
527 | $sql = "$select $from $where $having"; | |
528 | ||
529 | if (!empty($sort)) { | |
530 | $sql .= " ORDER BY $sort "; | |
531 | } | |
532 | if(!empty($rowCount)) { | |
533 | $sql .= " LIMIT $offset, $rowCount "; | |
534 | } | |
535 | $dao = CRM_Core_DAO::executeQuery($sql); | |
536 | return array($dao, $query); | |
537 | } | |
538 | ||
11e09c59 | 539 | /** |
6a488035 | 540 | * Function transfers the filters being passed into the DAO onto the params object |
a75c13cc EM |
541 | * @param CRM_Core_DAO $dao |
542 | * @param array $params | |
543 | * @param bool $unique | |
544 | * @param string $entity | |
545 | * | |
546 | * @throws API_Exception | |
547 | * @throws Exception | |
6a488035 TO |
548 | */ |
549 | function _civicrm_api3_dao_set_filter(&$dao, $params, $unique = TRUE, $entity) { | |
550 | $entity = substr($dao->__table, 8); | |
551 | ||
552 | $allfields = _civicrm_api3_build_fields_array($dao, $unique); | |
553 | ||
554 | $fields = array_intersect(array_keys($allfields), array_keys($params)); | |
555 | if (isset($params[$entity . "_id"])) { | |
556 | //if entity_id is set then treat it as ID (will be overridden by id if set) | |
557 | $dao->id = $params[$entity . "_id"]; | |
558 | } | |
3c70d501 | 559 | |
560 | $options = _civicrm_api3_get_options_from_params($params); | |
6a488035 TO |
561 | //apply options like sort |
562 | _civicrm_api3_apply_options_to_dao($params, $dao, $entity); | |
563 | ||
564 | //accept filters like filter.activity_date_time_high | |
565 | // std is now 'filters' => .. | |
566 | if (strstr(implode(',', array_keys($params)), 'filter')) { | |
567 | if (isset($params['filters']) && is_array($params['filters'])) { | |
568 | foreach ($params['filters'] as $paramkey => $paramvalue) { | |
569 | _civicrm_api3_apply_filters_to_dao($paramkey, $paramvalue, $dao); | |
570 | } | |
571 | } | |
572 | else { | |
573 | foreach ($params as $paramkey => $paramvalue) { | |
574 | if (strstr($paramkey, 'filter')) { | |
575 | _civicrm_api3_apply_filters_to_dao(substr($paramkey, 7), $paramvalue, $dao); | |
576 | } | |
577 | } | |
578 | } | |
579 | } | |
6a488035 TO |
580 | if (!$fields) { |
581 | $fields = array(); | |
582 | } | |
583 | ||
584 | foreach ($fields as $field) { | |
585 | if (is_array($params[$field])) { | |
586 | //get the actual fieldname from db | |
587 | $fieldName = $allfields[$field]['name']; | |
a038992c | 588 | $where = CRM_Core_DAO::createSqlFilter($fieldName, $params[$field], 'String'); |
589 | if(!empty($where)) { | |
590 | $dao->whereAdd($where); | |
6a488035 TO |
591 | } |
592 | } | |
593 | else { | |
594 | if ($unique) { | |
ed22af33 TO |
595 | $daoFieldName = $allfields[$field]['name']; |
596 | if (empty($daoFieldName)) { | |
597 | throw new API_Exception("Failed to determine field name for \"$field\""); | |
598 | } | |
599 | $dao->{$daoFieldName} = $params[$field]; | |
6a488035 TO |
600 | } |
601 | else { | |
602 | $dao->$field = $params[$field]; | |
603 | } | |
604 | } | |
605 | } | |
972322c5 | 606 | if (!empty($options['return']) && is_array($options['return']) && empty($options['is_count'])) { |
6a488035 | 607 | $dao->selectAdd(); |
3c70d501 | 608 | $options['return']['id'] = TRUE;// ensure 'id' is included |
6a488035 | 609 | $allfields = _civicrm_api3_get_unique_name_array($dao); |
3c70d501 | 610 | $returnMatched = array_intersect(array_keys($options['return']), $allfields); |
6a488035 | 611 | foreach ($returnMatched as $returnValue) { |
48e1c0dc | 612 | $dao->selectAdd($returnValue); |
6a488035 | 613 | } |
48e1c0dc | 614 | |
615 | $unmatchedFields = array_diff(// not already matched on the field names | |
616 | array_keys($options['return']), | |
617 | $returnMatched | |
618 | ); | |
619 | ||
620 | $returnUniqueMatched = array_intersect( | |
621 | $unmatchedFields, | |
622 | array_flip($allfields)// but a match for the field keys | |
623 | ); | |
6a488035 TO |
624 | foreach ($returnUniqueMatched as $uniqueVal){ |
625 | $dao->selectAdd($allfields[$uniqueVal]); | |
6a488035 | 626 | } |
6a488035 | 627 | } |
6e1bb60c | 628 | $dao->setApiFilter($params); |
6a488035 TO |
629 | } |
630 | ||
11e09c59 | 631 | /** |
6a488035 TO |
632 | * Apply filters (e.g. high, low) to DAO object (prior to find) |
633 | * @param string $filterField field name of filter | |
634 | * @param string $filterValue field value of filter | |
635 | * @param object $dao DAO object | |
636 | */ | |
637 | function _civicrm_api3_apply_filters_to_dao($filterField, $filterValue, &$dao) { | |
638 | if (strstr($filterField, 'high')) { | |
639 | $fieldName = substr($filterField, 0, -5); | |
640 | $dao->whereAdd("($fieldName <= $filterValue )"); | |
641 | } | |
642 | if (strstr($filterField, 'low')) { | |
643 | $fieldName = substr($filterField, 0, -4); | |
644 | $dao->whereAdd("($fieldName >= $filterValue )"); | |
645 | } | |
646 | if($filterField == 'is_current' && $filterValue == 1){ | |
647 | $todayStart = date('Ymd000000', strtotime('now')); | |
648 | $todayEnd = date('Ymd235959', strtotime('now')); | |
649 | $dao->whereAdd("(start_date <= '$todayStart' OR start_date IS NULL) AND (end_date >= '$todayEnd' OR end_date IS NULL)"); | |
650 | if(property_exists($dao, 'is_active')){ | |
651 | $dao->whereAdd('is_active = 1'); | |
652 | } | |
653 | } | |
654 | } | |
11e09c59 TO |
655 | |
656 | /** | |
6a488035 TO |
657 | * Get sort, limit etc options from the params - supporting old & new formats. |
658 | * get returnproperties for legacy | |
26728d3f | 659 | * |
6a488035 TO |
660 | * @param array $params params array as passed into civicrm_api |
661 | * @param bool $queryObject - is this supporting a queryobject api (e.g contact) - if so we support more options | |
662 | * for legacy report & return a unique fields array | |
26728d3f E |
663 | * |
664 | * @param string $entity | |
665 | * @param string $action | |
666 | * | |
1cfa04c4 | 667 | * @throws API_Exception |
6a488035 TO |
668 | * @return array $options options extracted from params |
669 | */ | |
53ed8466 | 670 | function _civicrm_api3_get_options_from_params(&$params, $queryObject = FALSE, $entity = '', $action = '') { |
972322c5 | 671 | $is_count = FALSE; |
6a488035 TO |
672 | $sort = CRM_Utils_Array::value('sort', $params, 0); |
673 | $sort = CRM_Utils_Array::value('option.sort', $params, $sort); | |
674 | $sort = CRM_Utils_Array::value('option_sort', $params, $sort); | |
675 | ||
676 | $offset = CRM_Utils_Array::value('offset', $params, 0); | |
677 | $offset = CRM_Utils_Array::value('option.offset', $params, $offset); | |
678 | // dear PHP thought it would be a good idea to transform a.b into a_b in the get/post | |
679 | $offset = CRM_Utils_Array::value('option_offset', $params, $offset); | |
680 | ||
681 | $limit = CRM_Utils_Array::value('rowCount', $params, 25); | |
682 | $limit = CRM_Utils_Array::value('option.limit', $params, $limit); | |
683 | $limit = CRM_Utils_Array::value('option_limit', $params, $limit); | |
684 | ||
685 | if (is_array(CRM_Utils_Array::value('options', $params))) { | |
972322c5 | 686 | // is count is set by generic getcount not user |
687 | $is_count = CRM_Utils_Array::value('is_count', $params['options']); | |
6a488035 TO |
688 | $offset = CRM_Utils_Array::value('offset', $params['options'], $offset); |
689 | $limit = CRM_Utils_Array::value('limit', $params['options'], $limit); | |
690 | $sort = CRM_Utils_Array::value('sort', $params['options'], $sort); | |
691 | } | |
692 | ||
693 | $returnProperties = array(); | |
694 | // handle the format return =sort_name,display_name... | |
695 | if (array_key_exists('return', $params)) { | |
696 | if (is_array($params['return'])) { | |
697 | $returnProperties = array_fill_keys($params['return'], 1); | |
698 | } | |
699 | else { | |
700 | $returnProperties = explode(',', str_replace(' ', '', $params['return'])); | |
701 | $returnProperties = array_fill_keys($returnProperties, 1); | |
702 | } | |
703 | } | |
13c1cf91 | 704 | if ($entity && $action =='get') { |
a7488080 | 705 | if (!empty($returnProperties['id'])) { |
6a488035 TO |
706 | $returnProperties[$entity . '_id'] = 1; |
707 | unset($returnProperties['id']); | |
708 | } | |
709 | switch (trim(strtolower($sort))){ | |
710 | case 'id': | |
711 | case 'id desc': | |
712 | case 'id asc': | |
713 | $sort = str_replace('id', $entity . '_id',$sort); | |
714 | } | |
715 | } | |
716 | ||
6a488035 | 717 | $options = array( |
ba93e7ad CW |
718 | 'offset' => CRM_Utils_Rule::integer($offset) ? $offset : NULL, |
719 | 'sort' => CRM_Utils_Rule::string($sort) ? $sort : NULL, | |
720 | 'limit' => CRM_Utils_Rule::integer($limit) ? $limit : NULL, | |
6313f1f7 | 721 | 'is_count' => $is_count, |
9af2925b | 722 | 'return' => !empty($returnProperties) ? $returnProperties : array(), |
6a488035 | 723 | ); |
972322c5 | 724 | |
13c1cf91 | 725 | if ($options['sort'] && stristr($options['sort'], 'SELECT')) { |
ba93e7ad CW |
726 | throw new API_Exception('invalid string in sort options'); |
727 | } | |
13c1cf91 | 728 | |
6a488035 TO |
729 | if (!$queryObject) { |
730 | return $options; | |
731 | } | |
732 | //here comes the legacy support for $returnProperties, $inputParams e.g for contat_get | |
733 | // if the queryobject is being used this should be used | |
734 | $inputParams = array(); | |
735 | $legacyreturnProperties = array(); | |
736 | $otherVars = array( | |
737 | 'sort', 'offset', 'rowCount', 'options','return', | |
738 | ); | |
739 | foreach ($params as $n => $v) { | |
740 | if (substr($n, 0, 7) == 'return.') { | |
741 | $legacyreturnProperties[substr($n, 7)] = $v; | |
742 | } | |
13c1cf91 | 743 | elseif ($n == 'id') { |
6a488035 TO |
744 | $inputParams[$entity. '_id'] = $v; |
745 | } | |
746 | elseif (in_array($n, $otherVars)) {} | |
13c1cf91 | 747 | else { |
6a488035 | 748 | $inputParams[$n] = $v; |
13c1cf91 | 749 | if ($v && !is_array($v) && stristr($v, 'SELECT')) { |
ba93e7ad CW |
750 | throw new API_Exception('invalid string'); |
751 | } | |
6a488035 TO |
752 | } |
753 | } | |
754 | $options['return'] = array_merge($returnProperties, $legacyreturnProperties); | |
755 | $options['input_params'] = $inputParams; | |
756 | return $options; | |
757 | } | |
11e09c59 TO |
758 | |
759 | /** | |
6a488035 | 760 | * Apply options (e.g. sort, limit, order by) to DAO object (prior to find) |
26728d3f | 761 | * |
6a488035 TO |
762 | * @param array $params params array as passed into civicrm_api |
763 | * @param object $dao DAO object | |
26728d3f | 764 | * @param $entity |
6a488035 TO |
765 | */ |
766 | function _civicrm_api3_apply_options_to_dao(&$params, &$dao, $entity) { | |
767 | ||
53ed8466 | 768 | $options = _civicrm_api3_get_options_from_params($params,FALSE,$entity); |
972322c5 | 769 | if(!$options['is_count']) { |
ebddc2d9 EM |
770 | if(!empty($options['limit'])) { |
771 | $dao->limit((int)$options['offset'], (int)$options['limit']); | |
772 | } | |
972322c5 | 773 | if (!empty($options['sort'])) { |
774 | $dao->orderBy($options['sort']); | |
775 | } | |
6a488035 TO |
776 | } |
777 | } | |
778 | ||
11e09c59 | 779 | /** |
6a488035 TO |
780 | * build fields array. This is the array of fields as it relates to the given DAO |
781 | * returns unique fields as keys by default but if set but can return by DB fields | |
782 | */ | |
783 | function _civicrm_api3_build_fields_array(&$bao, $unique = TRUE) { | |
784 | $fields = $bao->fields(); | |
785 | if ($unique) { | |
a7488080 | 786 | if (empty($fields['id'])){ |
6a488035 TO |
787 | $entity = _civicrm_api_get_entity_name_from_dao($bao); |
788 | $fields['id'] = $fields[$entity . '_id']; | |
789 | unset($fields[$entity . '_id']); | |
790 | } | |
791 | return $fields; | |
792 | } | |
793 | ||
794 | foreach ($fields as $field) { | |
795 | $dbFields[$field['name']] = $field; | |
796 | } | |
797 | return $dbFields; | |
798 | } | |
799 | ||
11e09c59 | 800 | /** |
6a488035 TO |
801 | * build fields array. This is the array of fields as it relates to the given DAO |
802 | * returns unique fields as keys by default but if set but can return by DB fields | |
fb7f68eb EM |
803 | * @param CRM_Core_BAO $bao |
804 | * | |
805 | * @return mixed | |
6a488035 TO |
806 | */ |
807 | function _civicrm_api3_get_unique_name_array(&$bao) { | |
808 | $fields = $bao->fields(); | |
809 | foreach ($fields as $field => $values) { | |
810 | $uniqueFields[$field] = CRM_Utils_Array::value('name',$values, $field); | |
811 | } | |
812 | return $uniqueFields; | |
813 | } | |
814 | ||
6a488035 TO |
815 | /** |
816 | * Converts an DAO object to an array | |
817 | * | |
941feb14 | 818 | * @param object $dao (reference )object to convert |
26728d3f E |
819 | * @param null $params |
820 | * @param bool $uniqueFields | |
821 | * @param string $entity | |
822 | * | |
941feb14 EM |
823 | * @param bool $autoFind |
824 | * | |
26728d3f E |
825 | * @return array |
826 | * | |
6a488035 | 827 | * @params array of arrays (key = id) of array of fields |
26728d3f | 828 | * |
6a488035 TO |
829 | * @static void |
830 | * @access public | |
831 | */ | |
ab5fa8f2 | 832 | function _civicrm_api3_dao_to_array($dao, $params = NULL, $uniqueFields = TRUE, $entity = "", $autoFind = TRUE) { |
6a488035 | 833 | $result = array(); |
8cc574cf | 834 | if(isset($params['options']) && !empty($params['options']['is_count'])) { |
972322c5 | 835 | return $dao->count(); |
836 | } | |
ab5fa8f2 TO |
837 | if (empty($dao)) { |
838 | return array(); | |
839 | } | |
840 | if ($autoFind && !$dao->find()) { | |
6a488035 TO |
841 | return array(); |
842 | } | |
843 | ||
972322c5 | 844 | if(isset($dao->count)) { |
845 | return $dao->count; | |
846 | } | |
6a488035 TO |
847 | |
848 | $fields = array_keys(_civicrm_api3_build_fields_array($dao, $uniqueFields)); | |
849 | ||
850 | while ($dao->fetch()) { | |
851 | $tmp = array(); | |
852 | foreach ($fields as $key) { | |
853 | if (array_key_exists($key, $dao)) { | |
854 | // not sure on that one | |
855 | if ($dao->$key !== NULL) { | |
856 | $tmp[$key] = $dao->$key; | |
857 | } | |
858 | } | |
859 | } | |
860 | $result[$dao->id] = $tmp; | |
8295042e EM |
861 | |
862 | if(_civicrm_api3_custom_fields_are_required($entity, $params)) { | |
6a488035 TO |
863 | _civicrm_api3_custom_data_get($result[$dao->id], $entity, $dao->id); |
864 | } | |
865 | } | |
866 | ||
867 | ||
868 | return $result; | |
869 | } | |
870 | ||
8295042e EM |
871 | /** |
872 | * We currently retrieve all custom fields or none at this level so if we know the entity | |
873 | * && it can take custom fields & there is the string 'custom' in their return request we get them all, they are filtered on the way out | |
874 | * @todo filter so only required fields are queried | |
875 | * | |
876 | * @param $params | |
877 | * @param string $entity - entity name in CamelCase | |
878 | * | |
879 | * @return bool | |
880 | */ | |
881 | function _civicrm_api3_custom_fields_are_required($entity, $params) { | |
882 | if (!array_key_exists($entity, CRM_Core_BAO_CustomQuery::$extendsMap)) { | |
883 | return FALSE; | |
884 | } | |
885 | $options = _civicrm_api3_get_options_from_params($params); | |
886 | //we check for possibility of 'custom' => 1 as well as specific custom fields | |
887 | $returnString = implode('', $options['return']) . implode('', array_keys($options['return'])); | |
888 | if(stristr($returnString, 'custom')) { | |
889 | return TRUE; | |
890 | } | |
891 | } | |
6a488035 TO |
892 | /** |
893 | * Converts an object to an array | |
894 | * | |
26728d3f E |
895 | * @param object $dao (reference) object to convert |
896 | * @param array $values (reference) array | |
897 | * @param array|bool $uniqueFields | |
6a488035 TO |
898 | * |
899 | * @return array | |
900 | * @static void | |
901 | * @access public | |
902 | */ | |
903 | function _civicrm_api3_object_to_array(&$dao, &$values, $uniqueFields = FALSE) { | |
904 | ||
905 | $fields = _civicrm_api3_build_fields_array($dao, $uniqueFields); | |
906 | foreach ($fields as $key => $value) { | |
907 | if (array_key_exists($key, $dao)) { | |
908 | $values[$key] = $dao->$key; | |
909 | } | |
910 | } | |
911 | } | |
912 | ||
11e09c59 | 913 | /** |
6a488035 TO |
914 | * Wrapper for _civicrm_object_to_array when api supports unique fields |
915 | */ | |
916 | function _civicrm_api3_object_to_array_unique_fields(&$dao, &$values) { | |
917 | return _civicrm_api3_object_to_array($dao, $values, TRUE); | |
918 | } | |
919 | ||
920 | /** | |
921 | * | |
922 | * @param array $params | |
923 | * @param array $values | |
924 | * @param string $extends entity that this custom field extends (e.g. contribution, event, contact) | |
925 | * @param string $entityId ID of entity per $extends | |
926 | */ | |
927 | function _civicrm_api3_custom_format_params($params, &$values, $extends, $entityId = NULL) { | |
928 | $values['custom'] = array(); | |
929 | foreach ($params as $key => $value) { | |
930 | list($customFieldID, $customValueID) = CRM_Core_BAO_CustomField::getKeyID($key, TRUE); | |
fe6daa04 | 931 | if ($customFieldID && (!IS_NULL($value))) { |
6a488035 TO |
932 | CRM_Core_BAO_CustomField::formatCustomField($customFieldID, $values['custom'], |
933 | $value, $extends, $customValueID, $entityId, FALSE, FALSE | |
934 | ); | |
935 | } | |
936 | } | |
937 | } | |
938 | ||
8295042e EM |
939 | /** |
940 | * @param $params | |
941 | * @param $entity | |
942 | */ | |
943 | function _civicrm_api3_format_params_for_create(&$params, $entity) { | |
944 | $nonGenericEntities = array('Contact', 'Individual', 'Household', 'Organization'); | |
945 | ||
946 | $customFieldEntities = array_diff_key(CRM_Core_BAO_CustomQuery::$extendsMap, array_fill_keys($nonGenericEntities, 1)); | |
947 | if(!array_key_exists($entity, $customFieldEntities)) { | |
948 | return; | |
949 | } | |
950 | $values = array(); | |
951 | _civicrm_api3_custom_format_params($params, $values, $entity); | |
952 | $params = array_merge($params, $values); | |
953 | } | |
954 | ||
6a488035 TO |
955 | /** |
956 | * @deprecated | |
957 | * This function ensures that we have the right input parameters | |
958 | * | |
959 | * This function is only called when $dao is passed into verify_mandatory. | |
960 | * The practice of passing $dao into verify_mandatory turned out to be | |
961 | * unsatisfactory as the required fields @ the dao level is so diffent to the abstract | |
962 | * api level. Hence the intention is to remove this function | |
963 | * & the associated param from viery_mandatory | |
964 | * | |
26728d3f | 965 | * @param array $params Associative array of property name/value |
6a488035 | 966 | * pairs to insert in new history. |
26728d3f E |
967 | * @param $daoName |
968 | * @param bool $return | |
969 | * | |
6a488035 TO |
970 | * @daoName string DAO to check params agains |
971 | * | |
972 | * @return bool should the missing fields be returned as an array (core error created as default) | |
973 | * | |
974 | * @return bool true if all fields present, depending on $result a core error is created of an array of missing fields is returned | |
975 | * @access public | |
976 | */ | |
977 | function _civicrm_api3_check_required_fields($params, $daoName, $return = FALSE) { | |
978 | //@deprecated - see notes | |
979 | if (isset($params['extends'])) { | |
980 | if (($params['extends'] == 'Activity' || | |
981 | $params['extends'] == 'Phonecall' || | |
982 | $params['extends'] == 'Meeting' || | |
983 | $params['extends'] == 'Group' || | |
984 | $params['extends'] == 'Contribution' | |
985 | ) && | |
986 | ($params['style'] == 'Tab') | |
987 | ) { | |
988 | return civicrm_api3_create_error(ts("Can not create Custom Group in Tab for " . $params['extends'])); | |
989 | } | |
990 | } | |
991 | ||
992 | $dao = new $daoName(); | |
993 | $fields = $dao->fields(); | |
994 | ||
995 | $missing = array(); | |
996 | foreach ($fields as $k => $v) { | |
997 | if ($v['name'] == 'id') { | |
998 | continue; | |
999 | } | |
1000 | ||
a7488080 | 1001 | if (!empty($v['required'])) { |
6a488035 TO |
1002 | // 0 is a valid input for numbers, CRM-8122 |
1003 | if (!isset($params[$k]) || (empty($params[$k]) && !($params[$k] === 0))) { | |
1004 | $missing[] = $k; | |
1005 | } | |
1006 | } | |
1007 | } | |
1008 | ||
1009 | if (!empty($missing)) { | |
1010 | if (!empty($return)) { | |
1011 | return $missing; | |
1012 | } | |
1013 | else { | |
1014 | return civicrm_api3_create_error(ts("Required fields " . implode(',', $missing) . " for $daoName are not present")); | |
1015 | } | |
1016 | } | |
1017 | ||
1018 | return TRUE; | |
1019 | } | |
1020 | ||
11e09c59 | 1021 | /** |
6a488035 TO |
1022 | * Function to do a 'standard' api get - when the api is only doing a $bao->find then use this |
1023 | * | |
1024 | * @param string $bao_name name of BAO | |
1025 | * @param array $params params from api | |
1026 | * @param bool $returnAsSuccess return in api success format | |
26728d3f E |
1027 | * @param string $entity |
1028 | * | |
1029 | * @return array | |
6a488035 TO |
1030 | */ |
1031 | function _civicrm_api3_basic_get($bao_name, &$params, $returnAsSuccess = TRUE, $entity = "") { | |
1032 | $bao = new $bao_name(); | |
53949b36 | 1033 | _civicrm_api3_dao_set_filter($bao, $params, TRUE, $entity); |
6a488035 | 1034 | if ($returnAsSuccess) { |
dc5a7701 | 1035 | return civicrm_api3_create_success(_civicrm_api3_dao_to_array($bao, $params, FALSE, $entity), $params, $entity, 'get'); |
6a488035 TO |
1036 | } |
1037 | else { | |
9af2925b | 1038 | return _civicrm_api3_dao_to_array($bao, $params, FALSE, $entity, 'get'); |
6a488035 TO |
1039 | } |
1040 | } | |
1041 | ||
11e09c59 | 1042 | /** |
6a488035 | 1043 | * Function to do a 'standard' api create - when the api is only doing a $bao::create then use this |
1cfa04c4 | 1044 | * |
6a488035 TO |
1045 | * @param string $bao_name Name of BAO Class |
1046 | * @param array $params parameters passed into the api call | |
1047 | * @param string $entity Entity - pass in if entity is non-standard & required $ids array | |
1cfa04c4 EM |
1048 | * |
1049 | * @throws API_Exception | |
26728d3f | 1050 | * @return array |
6a488035 | 1051 | */ |
53ed8466 | 1052 | function _civicrm_api3_basic_create($bao_name, &$params, $entity = NULL) { |
8295042e | 1053 | _civicrm_api3_format_params_for_create($params, $entity); |
6a488035 | 1054 | $args = array(&$params); |
acde3ae0 | 1055 | if (!empty($entity)) { |
6a488035 TO |
1056 | $ids = array($entity => CRM_Utils_Array::value('id', $params)); |
1057 | $args[] = &$ids; | |
1058 | } | |
acde3ae0 | 1059 | |
6a488035 TO |
1060 | if (method_exists($bao_name, 'create')) { |
1061 | $fct = 'create'; | |
acde3ae0 TO |
1062 | $fct_name = $bao_name . '::' . $fct; |
1063 | $bao = call_user_func_array(array($bao_name, $fct), $args); | |
6a488035 TO |
1064 | } |
1065 | elseif (method_exists($bao_name, 'add')) { | |
1066 | $fct = 'add'; | |
acde3ae0 TO |
1067 | $fct_name = $bao_name . '::' . $fct; |
1068 | $bao = call_user_func_array(array($bao_name, $fct), $args); | |
6a488035 | 1069 | } |
acde3ae0 TO |
1070 | else { |
1071 | $fct_name = '_civicrm_api3_basic_create_fallback'; | |
1072 | $bao = _civicrm_api3_basic_create_fallback($bao_name, $params); | |
6a488035 | 1073 | } |
acde3ae0 | 1074 | |
6a488035 | 1075 | if (is_null($bao)) { |
acde3ae0 | 1076 | return civicrm_api3_create_error('Entity not created (' . $fct_name . ')'); |
6a488035 | 1077 | } |
736eec43 E |
1078 | elseif (is_a($bao, 'CRM_Core_Error')) { |
1079 | //some wierd circular thing means the error takes itself as an argument | |
1080 | $msg = $bao->getMessages($bao); | |
1081 | // the api deals with entities on a one-by-one basis. However, the contribution bao pushes entities | |
1082 | // onto the error object - presumably because the contribution import is not handling multiple errors correctly | |
1083 | // so we need to reset the error object here to avoid getting concatenated errors | |
1084 | //@todo - the mulitple error handling should be moved out of the contribution object to the import / multiple entity processes | |
1085 | CRM_Core_Error::singleton()->reset(); | |
1086 | throw new API_Exception($msg); | |
1087 | } | |
6a488035 TO |
1088 | else { |
1089 | $values = array(); | |
1090 | _civicrm_api3_object_to_array($bao, $values[$bao->id]); | |
504a78f6 | 1091 | return civicrm_api3_create_success($values, $params, $entity, 'create', $bao); |
6a488035 TO |
1092 | } |
1093 | } | |
1094 | ||
acde3ae0 TO |
1095 | /** |
1096 | * For BAO's which don't have a create() or add() functions, use this fallback implementation. | |
1097 | * | |
26728d3f | 1098 | * @fixme There's an intuitive sense that this behavior should be defined somehow in the BAO/DAO class |
acde3ae0 TO |
1099 | * structure. In practice, that requires a fair amount of refactoring and/or kludgery. |
1100 | * | |
1101 | * @param string $bao_name | |
1102 | * @param array $params | |
916b48b6 VU |
1103 | * |
1104 | * @throws API_Exception | |
acde3ae0 TO |
1105 | * @return CRM_Core_DAO|NULL an instance of the BAO |
1106 | */ | |
1107 | function _civicrm_api3_basic_create_fallback($bao_name, &$params) { | |
a9739e5d CW |
1108 | $dao_name = get_parent_class($bao_name); |
1109 | if ($dao_name === 'CRM_Core_DAO' || !$dao_name) { | |
1110 | $dao_name = $bao_name; | |
1111 | } | |
1112 | $entityName = CRM_Core_DAO_AllCoreTables::getBriefName($dao_name); | |
acde3ae0 TO |
1113 | if (empty($entityName)) { |
1114 | throw new API_Exception("Class \"$bao_name\" does not map to an entity name", "unmapped_class_to_entity", array( | |
1115 | 'class_name' => $bao_name, | |
1116 | )); | |
1117 | } | |
1118 | $hook = empty($params['id']) ? 'create' : 'edit'; | |
1119 | ||
1120 | CRM_Utils_Hook::pre($hook, $entityName, CRM_Utils_Array::value('id', $params), $params); | |
a9739e5d | 1121 | $instance = new $dao_name(); |
acde3ae0 TO |
1122 | $instance->copyValues($params); |
1123 | $instance->save(); | |
1124 | CRM_Utils_Hook::post($hook, $entityName, $instance->id, $instance); | |
1125 | ||
1126 | return $instance; | |
1127 | } | |
1128 | ||
11e09c59 | 1129 | /** |
6a488035 TO |
1130 | * Function to do a 'standard' api del - when the api is only doing a $bao::del then use this |
1131 | * if api::del doesn't exist it will try DAO delete method | |
3d0d359e EM |
1132 | * |
1133 | * @param $bao_name | |
1134 | * @param $params | |
1135 | * | |
1136 | * @return array API result array | |
1137 | * @throws API_Exception | |
6a488035 TO |
1138 | */ |
1139 | function _civicrm_api3_basic_delete($bao_name, &$params) { | |
1140 | ||
1141 | civicrm_api3_verify_mandatory($params, NULL, array('id')); | |
1142 | $args = array(&$params['id']); | |
1143 | if (method_exists($bao_name, 'del')) { | |
1144 | $bao = call_user_func_array(array($bao_name, 'del'), $args); | |
a65e2e55 CW |
1145 | if ($bao !== FALSE) { |
1146 | return civicrm_api3_create_success(TRUE); | |
1147 | } | |
fb32de45 | 1148 | throw new API_Exception('Could not delete entity id ' . $params['id']); |
6a488035 TO |
1149 | } |
1150 | elseif (method_exists($bao_name, 'delete')) { | |
1151 | $dao = new $bao_name(); | |
1152 | $dao->id = $params['id']; | |
1153 | if ($dao->find()) { | |
1154 | while ($dao->fetch()) { | |
1155 | $dao->delete(); | |
1156 | return civicrm_api3_create_success(); | |
1157 | } | |
1158 | } | |
1159 | else { | |
fb32de45 | 1160 | throw new API_Exception('Could not delete entity id ' . $params['id']); |
6a488035 TO |
1161 | } |
1162 | } | |
1163 | ||
fb32de45 | 1164 | throw new API_Exception('no delete method found'); |
6a488035 TO |
1165 | } |
1166 | ||
11e09c59 | 1167 | /** |
6a488035 TO |
1168 | * Get custom data for the given entity & Add it to the returnArray as 'custom_123' = 'custom string' AND 'custom_123_1' = 'custom string' |
1169 | * Where 123 is field value & 1 is the id within the custom group data table (value ID) | |
1170 | * | |
1171 | * @param array $returnArray - array to append custom data too - generally $result[4] where 4 is the entity id. | |
1172 | * @param string $entity e.g membership, event | |
26728d3f | 1173 | * @param $entity_id |
6a488035 TO |
1174 | * @param int $groupID - per CRM_Core_BAO_CustomGroup::getTree |
1175 | * @param int $subType e.g. membership_type_id where custom data doesn't apply to all membership types | |
1176 | * @param string $subName - Subtype of entity | |
6a488035 TO |
1177 | */ |
1178 | function _civicrm_api3_custom_data_get(&$returnArray, $entity, $entity_id, $groupID = NULL, $subType = NULL, $subName = NULL) { | |
9af2925b | 1179 | $groupTree = CRM_Core_BAO_CustomGroup::getTree($entity, |
6a488035 TO |
1180 | CRM_Core_DAO::$_nullObject, |
1181 | $entity_id, | |
1182 | $groupID, | |
1183 | $subType, | |
1184 | $subName | |
1185 | ); | |
1186 | $groupTree = CRM_Core_BAO_CustomGroup::formatGroupTree($groupTree, 1, CRM_Core_DAO::$_nullObject); | |
1187 | $customValues = array(); | |
1188 | CRM_Core_BAO_CustomGroup::setDefaults($groupTree, $customValues); | |
e0995951 CW |
1189 | $fieldInfo = array(); |
1190 | foreach ($groupTree as $set) { | |
1191 | $fieldInfo += $set['fields']; | |
1192 | } | |
6a488035 TO |
1193 | if (!empty($customValues)) { |
1194 | foreach ($customValues as $key => $val) { | |
e0995951 CW |
1195 | // per standard - return custom_fieldID |
1196 | $id = CRM_Core_BAO_CustomField::getKeyID($key); | |
1197 | $returnArray['custom_' . $id] = $val; | |
1198 | ||
1199 | //not standard - but some api did this so guess we should keep - cheap as chips | |
1200 | $returnArray[$key] = $val; | |
6a488035 | 1201 | |
e0995951 CW |
1202 | // Shim to restore legacy behavior of ContactReference custom fields |
1203 | if (!empty($fieldInfo[$id]) && $fieldInfo[$id]['data_type'] == 'ContactReference') { | |
1204 | $returnArray['custom_' . $id . '_id'] = $returnArray[$key . '_id'] = $val; | |
1205 | $returnArray['custom_' . $id] = $returnArray[$key] = CRM_Core_DAO::getFieldValue('CRM_Contact_DAO_Contact', $val, 'sort_name'); | |
6a488035 TO |
1206 | } |
1207 | } | |
1208 | } | |
1209 | } | |
1210 | ||
11e09c59 | 1211 | /** |
6a488035 TO |
1212 | * Validate fields being passed into API. This function relies on the getFields function working accurately |
1213 | * for the given API. If error mode is set to TRUE then it will also check | |
1214 | * foreign keys | |
1215 | * | |
1216 | * As of writing only date was implemented. | |
1217 | * @param string $entity | |
1218 | * @param string $action | |
1219 | * @param array $params - | |
916b48b6 VU |
1220 | * @param array $fields response from getfields all variables are the same as per civicrm_api |
1221 | * @param bool $errorMode errorMode do intensive post fail checks? | |
1222 | * @throws Exception | |
6a488035 | 1223 | */ |
94359f7e | 1224 | function _civicrm_api3_validate_fields($entity, $action, &$params, $fields, $errorMode = False) { |
1225 | $fields = array_intersect_key($fields, $params); | |
70f7ba9e | 1226 | foreach ($fields as $fieldName => $fieldInfo) { |
6a488035 TO |
1227 | switch (CRM_Utils_Array::value('type', $fieldInfo)) { |
1228 | case CRM_Utils_Type::T_INT: | |
1229 | //field is of type integer | |
70f7ba9e | 1230 | _civicrm_api3_validate_integer($params, $fieldName, $fieldInfo, $entity); |
6a488035 TO |
1231 | break; |
1232 | ||
1233 | case 4: | |
1234 | case 12: | |
9bee5ea2 | 1235 | case CRM_Utils_Type::T_TIMESTAMP: |
6a488035 | 1236 | //field is of type date or datetime |
70f7ba9e | 1237 | _civicrm_api3_validate_date($params, $fieldName, $fieldInfo); |
6a488035 | 1238 | break; |
83abdecd | 1239 | |
70f7ba9e CW |
1240 | case 32://blob |
1241 | _civicrm_api3_validate_html($params, $fieldName, $fieldInfo); | |
6a488035 | 1242 | break; |
6a488035 | 1243 | |
83abdecd | 1244 | case CRM_Utils_Type::T_STRING: |
70f7ba9e | 1245 | _civicrm_api3_validate_string($params, $fieldName, $fieldInfo, $entity); |
6a488035 TO |
1246 | break; |
1247 | ||
1248 | case CRM_Utils_Type::T_MONEY: | |
0c094d12 | 1249 | if (!CRM_Utils_Rule::money($params[$fieldName]) && !empty($params[$fieldName])) { |
70f7ba9e | 1250 | throw new Exception($fieldName . " is not a valid amount: " . $params[$fieldName]); |
6a488035 TO |
1251 | } |
1252 | } | |
1253 | ||
1254 | // intensive checks - usually only called after DB level fail | |
1255 | if (!empty($errorMode) && strtolower($action) == 'create') { | |
a7488080 CW |
1256 | if (!empty($fieldInfo['FKClassName'])) { |
1257 | if (!empty($params[$fieldName])) { | |
70f7ba9e | 1258 | _civicrm_api3_validate_constraint($params, $fieldName, $fieldInfo); |
6a488035 | 1259 | } |
a7488080 | 1260 | elseif (!empty($fieldInfo['required'])) { |
70f7ba9e | 1261 | throw new Exception("DB Constraint Violation - possibly $fieldName should possibly be marked as mandatory for this API. If so, please raise a bug report"); |
6a488035 TO |
1262 | } |
1263 | } | |
a7488080 | 1264 | if (!empty($fieldInfo['api.unique'])) { |
6a488035 | 1265 | $params['entity'] = $entity; |
70f7ba9e | 1266 | _civicrm_api3_validate_uniquekey($params, $fieldName, $fieldInfo); |
6a488035 TO |
1267 | } |
1268 | } | |
1269 | } | |
1270 | } | |
1271 | ||
11e09c59 | 1272 | /** |
6a488035 TO |
1273 | * Validate date fields being passed into API. |
1274 | * It currently converts both unique fields and DB field names to a mysql date. | |
1275 | * @todo - probably the unique field handling & the if exists handling is now done before this | |
1276 | * function is reached in the wrapper - can reduce this code down to assume we | |
1277 | * are only checking the passed in field | |
1278 | * | |
1279 | * It also checks against the RULE:date function. This is a centralisation of code that was scattered and | |
1280 | * may not be the best thing to do. There is no code level documentation on the existing functions to work off | |
1281 | * | |
1282 | * @param array $params params from civicrm_api | |
70f7ba9e | 1283 | * @param string $fieldName uniquename of field being checked |
9bee5ea2 | 1284 | * @param array $fieldInfo |
916b48b6 | 1285 | * @throws Exception |
6a488035 | 1286 | */ |
70f7ba9e | 1287 | function _civicrm_api3_validate_date(&$params, &$fieldName, &$fieldInfo) { |
6a488035 | 1288 | //should we check first to prevent it from being copied if they have passed in sql friendly format? |
a7488080 | 1289 | if (!empty($params[$fieldInfo['name']])) { |
9bee5ea2 | 1290 | $params[$fieldInfo['name']] = _civicrm_api3_getValidDate($params[$fieldInfo['name']], $fieldInfo['name'], $fieldInfo['type']); |
6a488035 | 1291 | } |
8cc574cf | 1292 | if ((CRM_Utils_Array::value('name', $fieldInfo) != $fieldName) && !empty($params[$fieldName])) { |
9bee5ea2 EM |
1293 | $params[$fieldName] = _civicrm_api3_getValidDate($params[$fieldName], $fieldName, $fieldInfo['type']); |
1294 | } | |
1295 | } | |
1296 | ||
1297 | /** | |
1298 | * convert date into BAO friendly date | |
1299 | * we accept 'whatever strtotime accepts' | |
1300 | * | |
1301 | * @param string $dateValue | |
1302 | * @param $fieldName | |
1303 | * @param $fieldType | |
1304 | * | |
1305 | * @throws Exception | |
1306 | * @internal param $fieldInfo | |
1307 | * | |
1308 | * @internal param $params | |
1309 | * @return mixed | |
1310 | */ | |
1311 | function _civicrm_api3_getValidDate($dateValue, $fieldName, $fieldType) { | |
1312 | if (is_array($dateValue)) { | |
1313 | foreach ($dateValue as $key => $value) { | |
1314 | $dateValue[$key] = _civicrm_api3_getValidDate($value, $fieldName, $fieldType); | |
6a488035 | 1315 | } |
9bee5ea2 EM |
1316 | return $dateValue; |
1317 | } | |
1318 | if (strtotime($dateValue) === FALSE) { | |
1319 | throw new Exception($fieldName . " is not a valid date: " . $dateValue); | |
6a488035 | 1320 | } |
9bee5ea2 EM |
1321 | $format = ($fieldType == CRM_Utils_Type::T_DATE) ? 'Ymd000000' : 'YmdHis'; |
1322 | return CRM_Utils_Date::processDate($dateValue, NULL, FALSE, $format); | |
6a488035 | 1323 | } |
11e09c59 TO |
1324 | |
1325 | /** | |
6a488035 TO |
1326 | * Validate foreign constraint fields being passed into API. |
1327 | * | |
1328 | * @param array $params params from civicrm_api | |
70f7ba9e | 1329 | * @param string $fieldName uniquename of field being checked |
916b48b6 VU |
1330 | * @param $fieldInfo |
1331 | * @throws Exception | |
1332 | * @internal param array $fieldinfo array of fields from getfields function | |
6a488035 | 1333 | */ |
70f7ba9e | 1334 | function _civicrm_api3_validate_constraint(&$params, &$fieldName, &$fieldInfo) { |
6a488035 | 1335 | $dao = new $fieldInfo['FKClassName']; |
70f7ba9e | 1336 | $dao->id = $params[$fieldName]; |
6a488035 TO |
1337 | $dao->selectAdd(); |
1338 | $dao->selectAdd('id'); | |
1339 | if (!$dao->find()) { | |
70f7ba9e | 1340 | throw new Exception("$fieldName is not valid : " . $params[$fieldName]); |
6a488035 TO |
1341 | } |
1342 | } | |
1343 | ||
11e09c59 | 1344 | /** |
6a488035 TO |
1345 | * Validate foreign constraint fields being passed into API. |
1346 | * | |
1347 | * @param array $params params from civicrm_api | |
70f7ba9e | 1348 | * @param string $fieldName uniquename of field being checked |
916b48b6 VU |
1349 | * @param $fieldInfo |
1350 | * @throws Exception | |
1351 | * @internal param array $fieldinfo array of fields from getfields function | |
6a488035 | 1352 | */ |
70f7ba9e | 1353 | function _civicrm_api3_validate_uniquekey(&$params, &$fieldName, &$fieldInfo) { |
6a488035 TO |
1354 | $existing = civicrm_api($params['entity'], 'get', array( |
1355 | 'version' => $params['version'], | |
70f7ba9e | 1356 | $fieldName => $params[$fieldName], |
6a488035 TO |
1357 | )); |
1358 | // an entry already exists for this unique field | |
1359 | if ($existing['count'] == 1) { | |
1360 | // question - could this ever be a security issue? | |
446f0940 | 1361 | throw new API_Exception("Field: `$fieldName` must be unique. An conflicting entity already exists - id: " . $existing['id']); |
6a488035 TO |
1362 | } |
1363 | } | |
1364 | ||
1365 | /** | |
1366 | * Generic implementation of the "replace" action. | |
1367 | * | |
1368 | * Replace the old set of entities (matching some given keys) with a new set of | |
1369 | * entities (matching the same keys). | |
1370 | * | |
1371 | * Note: This will verify that 'values' is present, but it does not directly verify | |
1372 | * any other parameters. | |
1373 | * | |
1374 | * @param string $entity entity name | |
1375 | * @param array $params params from civicrm_api, including: | |
1376 | * - 'values': an array of records to save | |
1377 | * - all other items: keys which identify new/pre-existing records | |
26728d3f | 1378 | * @return array|int |
6a488035 TO |
1379 | */ |
1380 | function _civicrm_api3_generic_replace($entity, $params) { | |
1381 | ||
6a488035 TO |
1382 | $transaction = new CRM_Core_Transaction(); |
1383 | try { | |
1384 | if (!is_array($params['values'])) { | |
1385 | throw new Exception("Mandatory key(s) missing from params array: values"); | |
1386 | } | |
1387 | ||
1388 | // Extract the keys -- somewhat scary, don't think too hard about it | |
e4b4e33a | 1389 | $baseParams = _civicrm_api3_generic_replace_base_params($params); |
6a488035 TO |
1390 | |
1391 | // Lookup pre-existing records | |
1392 | $preexisting = civicrm_api($entity, 'get', $baseParams, $params); | |
1393 | if (civicrm_error($preexisting)) { | |
1394 | $transaction->rollback(); | |
1395 | return $preexisting; | |
1396 | } | |
1397 | ||
1398 | // Save the new/updated records | |
1399 | $creates = array(); | |
1400 | foreach ($params['values'] as $replacement) { | |
1401 | // Sugar: Don't force clients to duplicate the 'key' data | |
1402 | $replacement = array_merge($baseParams, $replacement); | |
1403 | $action = (isset($replacement['id']) || isset($replacement[$entity . '_id'])) ? 'update' : 'create'; | |
1404 | $create = civicrm_api($entity, $action, $replacement); | |
1405 | if (civicrm_error($create)) { | |
1406 | $transaction->rollback(); | |
1407 | return $create; | |
1408 | } | |
1409 | foreach ($create['values'] as $entity_id => $entity_value) { | |
1410 | $creates[$entity_id] = $entity_value; | |
1411 | } | |
1412 | } | |
1413 | ||
1414 | // Remove stale records | |
1415 | $staleIDs = array_diff( | |
1416 | array_keys($preexisting['values']), | |
1417 | array_keys($creates) | |
1418 | ); | |
1419 | foreach ($staleIDs as $staleID) { | |
1420 | $delete = civicrm_api($entity, 'delete', array( | |
1421 | 'version' => $params['version'], | |
1422 | 'id' => $staleID, | |
1423 | )); | |
1424 | if (civicrm_error($delete)) { | |
1425 | $transaction->rollback(); | |
1426 | return $delete; | |
1427 | } | |
1428 | } | |
1429 | ||
1430 | return civicrm_api3_create_success($creates, $params); | |
1431 | } | |
1432 | catch(PEAR_Exception $e) { | |
1433 | $transaction->rollback(); | |
1434 | return civicrm_api3_create_error($e->getMessage()); | |
1435 | } | |
1436 | catch(Exception $e) { | |
1437 | $transaction->rollback(); | |
1438 | return civicrm_api3_create_error($e->getMessage()); | |
1439 | } | |
1440 | } | |
1441 | ||
26728d3f E |
1442 | /** |
1443 | * @param $params | |
1444 | * | |
1445 | * @return mixed | |
1446 | */ | |
e4b4e33a TO |
1447 | function _civicrm_api3_generic_replace_base_params($params) { |
1448 | $baseParams = $params; | |
1449 | unset($baseParams['values']); | |
1450 | unset($baseParams['sequential']); | |
1451 | unset($baseParams['options']); | |
1452 | return $baseParams; | |
1453 | } | |
1454 | ||
11e09c59 | 1455 | /** |
6a488035 | 1456 | * returns fields allowable by api |
26728d3f | 1457 | * |
6a488035 TO |
1458 | * @param $entity string Entity to query |
1459 | * @param bool $unique index by unique fields? | |
26728d3f E |
1460 | * @param array $params |
1461 | * | |
1462 | * @return array | |
6a488035 | 1463 | */ |
27b9f49a | 1464 | function _civicrm_api_get_fields($entity, $unique = FALSE, &$params = array()) { |
6a488035 TO |
1465 | $unsetIfEmpty = array('dataPattern', 'headerPattern', 'default', 'export', 'import'); |
1466 | $dao = _civicrm_api3_get_DAO($entity); | |
1467 | if (empty($dao)) { | |
1468 | return array(); | |
1469 | } | |
6a488035 TO |
1470 | $d = new $dao(); |
1471 | $fields = $d->fields(); | |
1472 | // replace uniqueNames by the normal names as the key | |
1473 | if (empty($unique)) { | |
1474 | foreach ($fields as $name => & $field) { | |
1475 | //getting rid of unused attributes | |
1476 | foreach ($unsetIfEmpty as $attr) { | |
1477 | if (empty($field[$attr])) { | |
1478 | unset($field[$attr]); | |
1479 | } | |
1480 | } | |
1481 | if ($name == $field['name']) { | |
1482 | continue; | |
1483 | } | |
1484 | if (array_key_exists($field['name'], $fields)) { | |
1485 | $field['error'] = 'name conflict'; | |
1486 | // it should never happen, but better safe than sorry | |
1487 | continue; | |
1488 | } | |
1489 | $fields[$field['name']] = $field; | |
1490 | $fields[$field['name']]['uniqueName'] = $name; | |
1491 | unset($fields[$name]); | |
1492 | } | |
1493 | } | |
1494 | $fields += _civicrm_api_get_custom_fields($entity, $params); | |
1495 | return $fields; | |
1496 | } | |
1497 | ||
11e09c59 | 1498 | /** |
6a488035 TO |
1499 | * Return an array of fields for a given entity - this is the same as the BAO function but |
1500 | * fields are prefixed with 'custom_' to represent api params | |
1501 | */ | |
1502 | function _civicrm_api_get_custom_fields($entity, &$params) { | |
6a488035 TO |
1503 | $customfields = array(); |
1504 | $entity = _civicrm_api_get_camel_name($entity); | |
1505 | if (strtolower($entity) == 'contact') { | |
837afcfe | 1506 | // Use sub-type if available, otherwise stick with 'Contact' |
0400dfac | 1507 | $entity = CRM_Utils_Array::value('contact_type', $params); |
6a488035 TO |
1508 | } |
1509 | $retrieveOnlyParent = FALSE; | |
1510 | // we could / should probably test for other subtypes here - e.g. activity_type_id | |
1511 | if($entity == 'Contact'){ | |
1512 | empty($params['contact_sub_type']); | |
1513 | } | |
1514 | $customfields = CRM_Core_BAO_CustomField::getFields($entity, | |
1515 | FALSE, | |
1516 | FALSE, | |
1517 | CRM_Utils_Array::value('contact_sub_type', $params, FALSE), | |
1518 | NULL, | |
1519 | $retrieveOnlyParent, | |
1520 | FALSE, | |
1521 | FALSE | |
1522 | ); | |
ddaac11c CW |
1523 | |
1524 | $ret = array(); | |
6a488035 TO |
1525 | |
1526 | foreach ($customfields as $key => $value) { | |
a4c5e9a3 CW |
1527 | // Regular fields have a 'name' property |
1528 | $value['name'] = 'custom_' . $key; | |
3a8e9315 | 1529 | $value['title'] = $value['label']; |
effb666a | 1530 | $value['type'] = _getStandardTypeFromCustomDataType($value['data_type']); |
ddaac11c | 1531 | $ret['custom_' . $key] = $value; |
6a488035 | 1532 | } |
ddaac11c | 1533 | return $ret; |
6a488035 | 1534 | } |
effb666a | 1535 | /** |
1536 | * Translate the custom field data_type attribute into a std 'type' | |
1537 | */ | |
1538 | function _getStandardTypeFromCustomDataType($dataType) { | |
1539 | $mapping = array( | |
1540 | 'String' => CRM_Utils_Type::T_STRING, | |
1541 | 'Int' => CRM_Utils_Type::T_INT, | |
1542 | 'Money' => CRM_Utils_Type::T_MONEY, | |
1543 | 'Memo' => CRM_Utils_Type::T_LONGTEXT, | |
1544 | 'Float' => CRM_Utils_Type::T_FLOAT, | |
1545 | 'Date' => CRM_Utils_Type::T_DATE, | |
1546 | 'Boolean' => CRM_Utils_Type::T_BOOLEAN, | |
1547 | 'StateProvince' => CRM_Utils_Type::T_INT, | |
1548 | 'File' => CRM_Utils_Type::T_STRING, | |
1549 | 'Link' => CRM_Utils_Type::T_STRING, | |
1550 | 'ContactReference' => CRM_Utils_Type::T_INT, | |
3e93ae67 | 1551 | 'Country' => CRM_Utils_Type::T_INT, |
effb666a | 1552 | ); |
1553 | return $mapping[$dataType]; | |
1554 | } | |
6a488035 | 1555 | |
6a488035 | 1556 | |
11e09c59 | 1557 | /** |
6a488035 TO |
1558 | * Fill params array with alternate (alias) values where a field has an alias and that is filled & the main field isn't |
1559 | * If multiple aliases the last takes precedence | |
1560 | * | |
1561 | * Function also swaps unique fields for non-unique fields & vice versa. | |
1562 | */ | |
94359f7e | 1563 | function _civicrm_api3_swap_out_aliases(&$apiRequest, $fields) { |
1564 | foreach ($fields as $field => $values) { | |
6a488035 | 1565 | $uniqueName = CRM_Utils_Array::value('uniqueName', $values); |
a7488080 | 1566 | if (!empty($values['api.aliases'])) { |
6a488035 TO |
1567 | // if aliased field is not set we try to use field alias |
1568 | if (!isset($apiRequest['params'][$field])) { | |
1569 | foreach ($values['api.aliases'] as $alias) { | |
1570 | if (isset($apiRequest['params'][$alias])) { | |
1571 | $apiRequest['params'][$field] = $apiRequest['params'][$alias]; | |
1572 | } | |
1573 | //unset original field nb - need to be careful with this as it may bring inconsistencies | |
1574 | // out of the woodwork but will be implementing only as _spec function extended | |
1575 | unset($apiRequest['params'][$alias]); | |
1576 | } | |
1577 | } | |
1578 | } | |
8cc574cf | 1579 | if (!isset($apiRequest['params'][$field]) && !empty($values['name']) && $field != $values['name'] |
6a488035 TO |
1580 | && isset($apiRequest['params'][$values['name']]) |
1581 | ) { | |
1582 | $apiRequest['params'][$field] = $apiRequest['params'][$values['name']]; | |
1583 | // note that it would make sense to unset the original field here but tests need to be in place first | |
1584 | } | |
1585 | if (!isset($apiRequest['params'][$field]) | |
1586 | && $uniqueName | |
1587 | && $field != $uniqueName | |
1588 | && array_key_exists($uniqueName, $apiRequest['params']) | |
1589 | ) | |
1590 | { | |
1591 | $apiRequest['params'][$field] = CRM_Utils_Array::value($values['uniqueName'], $apiRequest['params']); | |
1592 | // note that it would make sense to unset the original field here but tests need to be in place first | |
1593 | } | |
1594 | } | |
1595 | ||
1596 | } | |
11e09c59 TO |
1597 | |
1598 | /** | |
6a488035 TO |
1599 | * Validate integer fields being passed into API. |
1600 | * It currently converts the incoming value 'user_contact_id' into the id of the currenty logged in user | |
1601 | * | |
1602 | * @param array $params params from civicrm_api | |
70f7ba9e | 1603 | * @param string $fieldName uniquename of field being checked |
916b48b6 VU |
1604 | * @param $fieldInfo |
1605 | * @param $entity | |
1606 | * @throws API_Exception | |
1607 | * @internal param array $fieldinfo array of fields from getfields function | |
6a488035 | 1608 | */ |
70f7ba9e | 1609 | function _civicrm_api3_validate_integer(&$params, &$fieldName, &$fieldInfo, $entity) { |
a7488080 | 1610 | if (!empty($params[$fieldName])) { |
46b6363c | 1611 | // if value = 'user_contact_id' (or similar), replace value with contact id |
e68c64eb | 1612 | if (!is_numeric($params[$fieldName]) && is_scalar($params[$fieldName])) { |
3db3b06b | 1613 | $realContactId = _civicrm_api3_resolve_contactID($params[$fieldName]); |
17cb9f7f | 1614 | if ('unknown-user' === $realContactId) { |
3db3b06b | 1615 | throw new API_Exception("\"$fieldName\" \"{$params[$fieldName]}\" cannot be resolved to a contact ID", 2002, array('error_field' => $fieldName,"type"=>"integer")); |
17cb9f7f TO |
1616 | } elseif (is_numeric($realContactId)) { |
1617 | $params[$fieldName] = $realContactId; | |
46b6363c | 1618 | } |
6a488035 | 1619 | } |
6fa8a394 CW |
1620 | if (!empty($fieldInfo['pseudoconstant']) || !empty($fieldInfo['options'])) { |
1621 | _civicrm_api3_api_match_pseudoconstant($params, $entity, $fieldName, $fieldInfo); | |
6a488035 TO |
1622 | } |
1623 | ||
283f988c CW |
1624 | // After swapping options, ensure we have an integer(s) |
1625 | foreach ((array) ($params[$fieldName]) as $value) { | |
736f9c2d | 1626 | if ($value && !is_numeric($value) && $value !== 'null' && !is_array($value)) { |
283f988c CW |
1627 | throw new API_Exception("$fieldName is not a valid integer", 2001, array('error_field' => $fieldName, "type" => "integer")); |
1628 | } | |
6fa8a394 CW |
1629 | } |
1630 | ||
1631 | // Check our field length | |
8cc574cf | 1632 | if(is_string($params[$fieldName]) && !empty($fieldInfo['maxlength']) && strlen($params[$fieldName]) > $fieldInfo['maxlength'] |
6a488035 | 1633 | ){ |
70f7ba9e CW |
1634 | throw new API_Exception( $params[$fieldName] . " is " . strlen($params[$fieldName]) . " characters - longer than $fieldName length" . $fieldInfo['maxlength'] . ' characters', |
1635 | 2100, array('field' => $fieldName, "max_length"=>$fieldInfo['maxlength']) | |
6a488035 TO |
1636 | ); |
1637 | } | |
1638 | } | |
1639 | } | |
1640 | ||
46b6363c TO |
1641 | /** |
1642 | * Determine a contact ID using a string expression | |
1643 | * | |
1644 | * @param string $contactIdExpr e.g. "user_contact_id" or "@user:username" | |
17cb9f7f | 1645 | * @return int|NULL|'unknown-user' |
46b6363c TO |
1646 | */ |
1647 | function _civicrm_api3_resolve_contactID($contactIdExpr) { | |
1648 | //if value = 'user_contact_id' replace value with logged in user id | |
1649 | if ($contactIdExpr == "user_contact_id") { | |
bb341097 EM |
1650 | return CRM_Core_Session::getLoggedInContactID(); |
1651 | } | |
1652 | elseif (preg_match('/^@user:(.*)$/', $contactIdExpr, $matches)) { | |
46b6363c TO |
1653 | $config = CRM_Core_Config::singleton(); |
1654 | ||
1655 | $ufID = $config->userSystem->getUfId($matches[1]); | |
1656 | if (!$ufID) { | |
17cb9f7f | 1657 | return 'unknown-user'; |
46b6363c TO |
1658 | } |
1659 | ||
1660 | $contactID = CRM_Core_BAO_UFMatch::getContactId($ufID); | |
17cb9f7f TO |
1661 | if (!$contactID) { |
1662 | return 'unknown-user'; | |
46b6363c TO |
1663 | } |
1664 | ||
1665 | return $contactID; | |
1666 | } | |
31fd7b1e | 1667 | return NULL; |
46b6363c TO |
1668 | } |
1669 | ||
26728d3f E |
1670 | /** |
1671 | * Validate html (check for scripting attack) | |
1672 | * @param $params | |
1673 | * @param $fieldName | |
1674 | * @param $fieldInfo | |
1675 | * | |
1676 | * @throws API_Exception | |
1677 | */ | |
70f7ba9e CW |
1678 | function _civicrm_api3_validate_html(&$params, &$fieldName, &$fieldInfo) { |
1679 | if ($value = CRM_Utils_Array::value($fieldName, $params)) { | |
6a488035 | 1680 | if (!CRM_Utils_Rule::xssString($value)) { |
e7c4a581 | 1681 | throw new API_Exception('Illegal characters in input (potential scripting attack)', array("field"=>$fieldName,"error_code"=>"xss")); |
6a488035 TO |
1682 | } |
1683 | } | |
1684 | } | |
1685 | ||
11e09c59 | 1686 | /** |
6a488035 TO |
1687 | * Validate string fields being passed into API. |
1688 | * @param array $params params from civicrm_api | |
70f7ba9e | 1689 | * @param string $fieldName uniquename of field being checked |
a75c13cc | 1690 | * @param array $fieldInfo array of fields from getfields function |
916b48b6 VU |
1691 | * @param $entity |
1692 | * @throws API_Exception | |
1693 | * @throws Exception | |
6a488035 | 1694 | */ |
70f7ba9e | 1695 | function _civicrm_api3_validate_string(&$params, &$fieldName, &$fieldInfo, $entity) { |
6a488035 | 1696 | // If fieldname exists in params |
70f7ba9e | 1697 | $value = CRM_Utils_Array::value($fieldName, $params, ''); |
69c1fac4 | 1698 | if(!is_array($value)){ |
1699 | $value = (string) $value; | |
1700 | } | |
1701 | else{ | |
1702 | //@todo what do we do about passed in arrays. For many of these fields | |
1703 | // the missing piece of functionality is separating them to a separated string | |
1704 | // & many save incorrectly. But can we change them wholesale? | |
1705 | } | |
6a488035 TO |
1706 | if ($value ) { |
1707 | if (!CRM_Utils_Rule::xssString($value)) { | |
1708 | throw new Exception('Illegal characters in input (potential scripting attack)'); | |
1709 | } | |
70f7ba9e | 1710 | if ($fieldName == 'currency') { |
6a488035 TO |
1711 | if (!CRM_Utils_Rule::currencyCode($value)) { |
1712 | throw new Exception("Currency not a valid code: $value"); | |
1713 | } | |
1714 | } | |
4b5ff63c | 1715 | if (!empty($fieldInfo['pseudoconstant']) || !empty($fieldInfo['options'])) { |
6fa8a394 | 1716 | _civicrm_api3_api_match_pseudoconstant($params, $entity, $fieldName, $fieldInfo); |
6a488035 TO |
1717 | } |
1718 | // Check our field length | |
1719 | elseif (is_string($value) && !empty($fieldInfo['maxlength']) && strlen($value) > $fieldInfo['maxlength']) { | |
70f7ba9e CW |
1720 | throw new API_Exception("Value for $fieldName is " . strlen($value) . " characters - This field has a maxlength of {$fieldInfo['maxlength']} characters.", |
1721 | 2100, array('field' => $fieldName) | |
6a488035 TO |
1722 | ); |
1723 | } | |
1724 | } | |
1725 | } | |
70f7ba9e CW |
1726 | |
1727 | /** | |
1728 | * Validate & swap out any pseudoconstants / options | |
1729 | * | |
1730 | * @param $params: api parameters | |
1731 | * @param $entity: api entity name | |
6fa8a394 CW |
1732 | * @param $fieldName: field name used in api call (not necessarily the canonical name) |
1733 | * @param $fieldInfo: getfields meta-data | |
70f7ba9e | 1734 | */ |
6fa8a394 CW |
1735 | function _civicrm_api3_api_match_pseudoconstant(&$params, $entity, $fieldName, $fieldInfo) { |
1736 | $options = CRM_Utils_Array::value('options', $fieldInfo); | |
1737 | if (!$options) { | |
94359f7e | 1738 | if(strtolower($entity) == 'profile' && !empty($fieldInfo['entity'])) { |
1739 | // we need to get the options from the entity the field relates to | |
1740 | $entity = $fieldInfo['entity']; | |
1741 | } | |
786ad6e1 | 1742 | $options = civicrm_api($entity, 'getoptions', array('version' => 3, 'field' => $fieldInfo['name'], 'context' => 'validate')); |
6fa8a394 CW |
1743 | $options = CRM_Utils_Array::value('values', $options, array()); |
1744 | } | |
70f7ba9e | 1745 | |
5b932170 | 1746 | // If passed a value-separated string, explode to an array, then re-implode after matching values |
70f7ba9e CW |
1747 | $implode = FALSE; |
1748 | if (is_string($params[$fieldName]) && strpos($params[$fieldName], CRM_Core_DAO::VALUE_SEPARATOR) !== FALSE) { | |
1749 | $params[$fieldName] = CRM_Utils_Array::explodePadded($params[$fieldName]); | |
1750 | $implode = TRUE; | |
1751 | } | |
1752 | // If passed multiple options, validate each | |
1753 | if (is_array($params[$fieldName])) { | |
1754 | foreach ($params[$fieldName] as &$value) { | |
736f9c2d CW |
1755 | if (!is_array($value)) { |
1756 | _civicrm_api3_api_match_pseudoconstant_value($value, $options, $fieldName); | |
1757 | } | |
70f7ba9e CW |
1758 | } |
1759 | // TODO: unwrap the call to implodePadded from the conditional and do it always | |
1760 | // need to verify that this is safe and doesn't break anything though. | |
1761 | // Better yet would be to leave it as an array and ensure that every dao/bao can handle array input | |
1762 | if ($implode) { | |
1763 | CRM_Utils_Array::implodePadded($params[$fieldName]); | |
1764 | } | |
1765 | } | |
1766 | else { | |
1767 | _civicrm_api3_api_match_pseudoconstant_value($params[$fieldName], $options, $fieldName); | |
1768 | } | |
1769 | } | |
1770 | ||
1771 | /** | |
1772 | * Validate & swap a single option value for a field | |
1773 | * | |
1774 | * @param $value: field value | |
1775 | * @param $options: array of options for this field | |
6fa8a394 | 1776 | * @param $fieldName: field name used in api call (not necessarily the canonical name) |
916b48b6 | 1777 | * @throws API_Exception |
70f7ba9e CW |
1778 | */ |
1779 | function _civicrm_api3_api_match_pseudoconstant_value(&$value, $options, $fieldName) { | |
1780 | // If option is a key, no need to translate | |
b4bb913e | 1781 | if (array_key_exists($value, $options)) { |
70f7ba9e CW |
1782 | return; |
1783 | } | |
70f7ba9e | 1784 | |
a4c5e9a3 CW |
1785 | // Translate value into key |
1786 | $newValue = array_search($value, $options); | |
1787 | if ($newValue !== FALSE) { | |
1788 | $value = $newValue; | |
1789 | return; | |
1790 | } | |
70f7ba9e | 1791 | // Case-insensitive matching |
80085473 | 1792 | $newValue = strtolower($value); |
70f7ba9e | 1793 | $options = array_map("strtolower", $options); |
80085473 CW |
1794 | $newValue = array_search($newValue, $options); |
1795 | if ($newValue === FALSE) { | |
1796 | throw new API_Exception("'$value' is not a valid option for field $fieldName", 2001, array('error_field' => $fieldName)); | |
70f7ba9e | 1797 | } |
80085473 | 1798 | $value = $newValue; |
70f7ba9e CW |
1799 | } |
1800 | ||
1801 | /** | |
1802 | * Returns the canonical name of a field | |
70f7ba9e | 1803 | * |
77b97be7 EM |
1804 | * @param $entity : api entity name (string should already be standardized - no camelCase) |
1805 | * @param $fieldName : any variation of a field's name (name, unique_name, api.alias) | |
1806 | * | |
1807 | * @return bool|string (string|bool) fieldName or FALSE if the field does not exist | |
70f7ba9e CW |
1808 | */ |
1809 | function _civicrm_api3_api_resolve_alias($entity, $fieldName) { | |
a38a89fc | 1810 | if (strpos($fieldName, 'custom_') === 0 && is_numeric($fieldName[7])) { |
a4c5e9a3 CW |
1811 | return $fieldName; |
1812 | } | |
1813 | if ($fieldName == "{$entity}_id") { | |
1814 | return 'id'; | |
1815 | } | |
70f7ba9e CW |
1816 | $result = civicrm_api($entity, 'getfields', array( |
1817 | 'version' => 3, | |
1818 | 'action' => 'create', | |
1819 | )); | |
1820 | $meta = $result['values']; | |
e354351f | 1821 | if (!isset($meta[$fieldName]['name']) && isset($meta[$fieldName . '_id'])) { |
1822 | $fieldName = $fieldName . '_id'; | |
1823 | } | |
70f7ba9e CW |
1824 | if (isset($meta[$fieldName])) { |
1825 | return $meta[$fieldName]['name']; | |
1826 | } | |
70f7ba9e CW |
1827 | foreach ($meta as $info) { |
1828 | if ($fieldName == CRM_Utils_Array::value('uniqueName', $info)) { | |
1829 | return $info['name']; | |
1830 | } | |
1831 | if (array_search($fieldName, CRM_Utils_Array::value('api.aliases', $info, array())) !== FALSE) { | |
1832 | return $info['name']; | |
1833 | } | |
1834 | } | |
1835 | return FALSE; | |
1836 | } |