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