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