3 +--------------------------------------------------------------------+
4 | CiviCRM version 4.7 |
5 +--------------------------------------------------------------------+
6 | Copyright CiviCRM LLC (c) 2004-2017 |
7 +--------------------------------------------------------------------+
8 | This file is a part of CiviCRM. |
10 | CiviCRM is free software; you can copy, modify, and distribute it |
11 | under the terms of the GNU Affero General Public License |
12 | Version 3, 19 November 2007 and the CiviCRM Licensing Exception. |
14 | CiviCRM is distributed in the hope that it will be useful, but |
15 | WITHOUT ANY WARRANTY; without even the implied warranty of |
16 | MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. |
17 | See the GNU Affero General Public License for more details. |
19 | You should have received a copy of the GNU Affero General Public |
20 | License and the CiviCRM Licensing Exception along |
21 | with this program; if not, contact CiviCRM LLC |
22 | at info[AT]civicrm[DOT]org. If you have questions about the |
23 | GNU Affero General Public License or the licensing of CiviCRM, |
24 | see the CiviCRM license FAQ at http://civicrm.org/licensing |
25 +--------------------------------------------------------------------+
29 * This api exposes CiviCRM Activity records.
31 * @package CiviCRM_APIv3
36 * Creates or updates an Activity.
38 * @param array $params
39 * Array per getfields documentation.
41 * @throws API_Exception
45 function civicrm_api3_activity_create($params) {
47 if (empty($params['id'])) {
48 // an update does not require any mandatory parameters
49 civicrm_api3_verify_one_mandatory($params,
59 // check for various error and required conditions
60 // note that almost all the processing in there should be managed by the wrapper layer
61 // & should be removed - needs testing
62 $errors = _civicrm_api3_activity_check_params($params);
64 // this should not be required as should throw exception rather than return errors -
66 if (!empty($errors)) {
70 // processing for custom data
71 $values = $activityArray = array();
72 _civicrm_api3_custom_format_params($params, $values, 'Activity');
74 if (!empty($values['custom'])) {
75 $params['custom'] = $values['custom'];
78 // this should be set as a default rather than hard coded
80 $params['skipRecentView'] = TRUE;
82 // If this is a case activity, see if there is an existing activity
83 // and set it as an old revision. Also retrieve details we'll need.
84 // this handling should all be moved to the BAO layer
86 $createRevision = FALSE;
87 $oldActivityValues = array();
88 // Lookup case id if not supplied
89 if (!isset($params['case_id']) && !empty($params['id'])) {
90 $params['case_id'] = CRM_Core_DAO
::singleValueQuery("SELECT case_id FROM civicrm_case_activity WHERE activity_id = " . (int) $params['id']);
92 if (!empty($params['case_id'])) {
93 $case_id = $params['case_id'];
94 if (!empty($params['id'])) {
95 $oldActivityParams = array('id' => $params['id']);
96 if (!$oldActivityValues) {
97 CRM_Activity_BAO_Activity
::retrieve($oldActivityParams, $oldActivityValues);
99 if (empty($oldActivityValues)) {
100 throw new API_Exception(ts("Unable to locate existing activity."));
103 $activityDAO = new CRM_Activity_DAO_Activity();
104 $activityDAO->id
= $params['id'];
105 $activityDAO->is_current_revision
= 0;
106 if (!$activityDAO->save()) {
107 if (is_object($activityDAO)) {
108 $activityDAO->free();
110 throw new API_Exception(ts("Unable to revision existing case activity."));
112 $createRevision = TRUE;
117 $deleteActivityAssignment = FALSE;
118 if (isset($params['assignee_contact_id'])) {
119 $deleteActivityAssignment = TRUE;
122 $deleteActivityTarget = FALSE;
123 if (isset($params['target_contact_id'])) {
124 $deleteActivityTarget = TRUE;
127 // this should all be handled at the BAO layer
128 $params['deleteActivityAssignment'] = CRM_Utils_Array
::value('deleteActivityAssignment', $params, $deleteActivityAssignment);
129 $params['deleteActivityTarget'] = CRM_Utils_Array
::value('deleteActivityTarget', $params, $deleteActivityTarget);
131 if ($case_id && $createRevision) {
132 // This is very similar to the copy-to-case action.
133 if (!CRM_Utils_Array
::crmIsEmptyArray($oldActivityValues['target_contact'])) {
134 $oldActivityValues['targetContactIds'] = implode(',', array_unique($oldActivityValues['target_contact']));
136 if (!CRM_Utils_Array
::crmIsEmptyArray($oldActivityValues['assignee_contact'])) {
137 $oldActivityValues['assigneeContactIds'] = implode(',', array_unique($oldActivityValues['assignee_contact']));
139 $oldActivityValues['mode'] = 'copy';
140 $oldActivityValues['caseID'] = $case_id;
141 $oldActivityValues['activityID'] = $oldActivityValues['id'];
142 $oldActivityValues['contactID'] = $oldActivityValues['source_contact_id'];
144 $copyToCase = CRM_Activity_Page_AJAX
::_convertToCaseActivity($oldActivityValues);
145 if (empty($copyToCase['error_msg'])) {
146 // now fix some things that are different from copy-to-case
147 // then fall through to the create below to update with the passed in params
148 $params['id'] = $copyToCase['newId'];
149 $params['is_auto'] = 0;
150 $params['original_id'] = empty($oldActivityValues['original_id']) ?
$oldActivityValues['id'] : $oldActivityValues['original_id'];
153 throw new API_Exception(ts("Unable to create new revision of case activity."));
158 $activityBAO = CRM_Activity_BAO_Activity
::create($params);
160 if (isset($activityBAO->id
)) {
161 if ($case_id && !$createRevision) {
162 // If this is a brand new case activity we need to add this
163 $caseActivityParams = array('activity_id' => $activityBAO->id
, 'case_id' => $case_id);
164 CRM_Case_BAO_Case
::processCaseActivity($caseActivityParams);
167 _civicrm_api3_object_to_array($activityBAO, $activityArray[$activityBAO->id
]);
168 return civicrm_api3_create_success($activityArray, $params, 'Activity', 'get', $activityBAO);
173 * Specify Meta data for create.
175 * Note that this data is retrievable via the getfields function and is used for pre-filling defaults and
176 * ensuring mandatory requirements are met.
178 * @param array $params
179 * Array of parameters determined by getfields.
181 function _civicrm_api3_activity_create_spec(&$params) {
183 // Default for source_contact_id = currently logged in user.
184 $params['source_contact_id']['api.default'] = 'user_contact_id';
186 $params['status_id']['api.aliases'] = array('activity_status');
188 $params['assignee_contact_id'] = array(
189 'name' => 'assignee_id',
190 'title' => 'Activity Assignee',
191 'description' => 'Contact(s) assigned to this activity.',
193 'FKClassName' => 'CRM_Contact_DAO_Contact',
194 'FKApiName' => 'Contact',
196 $params['target_contact_id'] = array(
197 'name' => 'target_id',
198 'title' => 'Activity Target',
199 'description' => 'Contact(s) participating in this activity.',
201 'FKClassName' => 'CRM_Contact_DAO_Contact',
202 'FKApiName' => 'Contact',
205 $params['source_contact_id'] = array(
206 'name' => 'source_contact_id',
207 'title' => 'Activity Source Contact',
208 'description' => 'Person who created this activity. Defaults to current user.',
210 'FKClassName' => 'CRM_Contact_DAO_Contact',
211 'api.default' => 'user_contact_id',
212 'FKApiName' => 'Contact',
215 $params['case_id'] = array(
217 'title' => 'Case ID',
218 'description' => 'For creating an activity as part of a case.',
220 'FKClassName' => 'CRM_Case_DAO_Case',
221 'FKApiName' => 'Case',
227 * Specify Metadata for get.
229 * @param array $params
231 function _civicrm_api3_activity_get_spec(&$params) {
232 $params['tag_id'] = array(
235 'description' => 'Find activities with specified tags.',
237 'FKClassName' => 'CRM_Core_DAO_Tag',
238 'FKApiName' => 'Tag',
240 $params['case_id'] = array(
243 'description' => 'Find activities within specified cases.',
245 'FKClassName' => 'CRM_Case_DAO_Case',
246 'FKApiName' => 'Case',
248 $params['target_contact_id'] = array(
249 'name' => 'target_contact_id',
250 'title' => 'Target Contact ID',
251 'description' => 'Find activities with specified target contact.',
253 'FKClassName' => 'CRM_Contact_DAO_Contact',
254 'FKApiName' => 'Contact',
256 $params['source_contact_id'] = array(
257 'name' => 'source_contact_id',
258 'title' => 'Source Contact ID',
259 'description' => 'Find activities with specified source contact.',
261 'FKClassName' => 'CRM_Contact_DAO_Contact',
262 'FKApiName' => 'Contact',
264 $params['assignee_contact_id'] = array(
265 'name' => 'assignee_contact_id',
266 'title' => 'Assignee Contact ID',
267 'description' => 'Find activities with specified assignee contact.',
269 'FKClassName' => 'CRM_Contact_DAO_Contact',
270 'FKApiName' => 'Contact',
275 * Gets a CiviCRM activity according to parameters.
277 * @param array $params
278 * Array per getfields documentation.
280 * @return array API result array
283 * @throws \API_Exception
284 * @throws \CiviCRM_API3_Exception
285 * @throws \Civi\API\Exception\UnauthorizedException
287 function civicrm_api3_activity_get($params) {
288 if (!empty($params['check_permissions']) && !CRM_Core_Permission
::check('view all activities')) {
289 // In absence of view all activities permission it's possible to see a specific activity by ACL.
290 // Note still allowing view all activities to override ACLs is based on the 'don't change too much
291 // if you are not sure principle' and it could be argued that the ACLs should always be applied.
292 if (empty($params['id']) ||
!empty($params['contact_id'])) {
293 // We fall back to the original blunt permissions if we don't have an id to check or we are about
294 // to go to the weird place that the legacy 'contact_id' parameter takes us to.
295 throw new \Civi\API\Exception\
UnauthorizedException(
296 "Cannot access activities. Required permission: 'view all activities''"
300 if (!CRM_Activity_BAO_Activity
::checkPermission($params['id'], CRM_Core_Action
::VIEW
)) {
301 throw new \Civi\API\Exception\
UnauthorizedException(
302 'You do not have permission to view this activity'
307 if (!empty($params['contact_id'])) {
308 $activities = CRM_Activity_BAO_Activity
::getContactActivity($params['contact_id']);
309 // BAO function doesn't actually return a contact ID - hack api for now & add to test so when api re-write
310 // happens it won't get missed.
311 foreach ($activities as $key => $activityArray) {
312 $activities[$key]['id'] = $key;
316 $sql = CRM_Utils_SQL_Select
::fragment();
317 // Support search by activity_contact
318 $options = civicrm_api3('ActivityContact', 'getoptions', array('field' => 'record_type_id'));
319 $options = $options['values'];
320 $activityContactOptions = array(
321 'target_contact_id' => array_search('Activity Targets', $options),
322 'source_contact_id' => array_search('Activity Source', $options),
323 'assignee_contact_id' => array_search('Activity Assignees', $options),
325 foreach ($activityContactOptions as $activityContactName => $activityContactValue) {
326 if (!empty($params[$activityContactName])) {
327 if (!is_array($params[$activityContactName])) {
328 $params[$activityContactName] = array('=' => $params[$activityContactName]);
330 $clause = \CRM_Core_DAO
::createSQLFilter('contact_id', $params[$activityContactName]);
331 $sql->where('a.id IN (SELECT activity_id FROM civicrm_activity_contact WHERE record_type_id = #typeId AND !clause)',
332 array('#typeId' => $activityContactValue, '!clause' => $clause)
336 if (!empty($params['tag_id'])) {
337 if (!is_array($params['tag_id'])) {
338 $params['tag_id'] = array('=' => $params['tag_id']);
340 $clause = \CRM_Core_DAO
::createSQLFilter('tag_id', $params['tag_id']);
342 $sql->where('a.id IN (SELECT entity_id FROM civicrm_entity_tag WHERE entity_table = "civicrm_activity" AND !clause)', array('!clause' => $clause));
345 if (!empty($params['case_id'])) {
346 if (!is_array($params['case_id'])) {
347 $params['case_id'] = array('=' => $params['case_id']);
349 $clause = \CRM_Core_DAO
::createSQLFilter('case_id', $params['case_id']);
351 $sql->where('a.id IN (SELECT activity_id FROM civicrm_case_activity WHERE !clause)', array('!clause' => $clause));
354 $activities = _civicrm_api3_basic_get(_civicrm_api3_get_BAO(__FUNCTION__
), $params, FALSE, 'Activity', $sql);
356 $options = _civicrm_api3_get_options_from_params($params, FALSE, 'Activity', 'get');
357 if ($options['is_count']) {
358 return civicrm_api3_create_success($activities, $params, 'Activity', 'get');
361 $activities = _civicrm_api3_activity_get_formatResult($params, $activities);
362 //legacy custom data get - so previous formatted response is still returned too
363 return civicrm_api3_create_success($activities, $params, 'Activity', 'get');
367 * Given a list of activities, append any extra data requested about the activities.
369 * @note Called by civicrm-core and CiviHR
371 * @param array $params
372 * API request parameters.
373 * @param array $activities
376 * new activities list
378 function _civicrm_api3_activity_get_formatResult($params, $activities) {
379 $returns = CRM_Utils_Array
::value('return', $params, array());
380 if (!is_array($returns)) {
381 $returns = str_replace(' ', '', $returns);
382 $returns = explode(',', $returns);
384 $returns = array_fill_keys($returns, 1);
386 foreach ($params as $n => $v) {
387 if (substr($n, 0, 7) == 'return.') {
388 $returnkey = substr($n, 7);
389 $returns[$returnkey] = $v;
393 $returns['source_contact_id'] = 1;
394 if (!empty($returns['target_contact_name'])) {
395 $returns['target_contact_id'] = 1;
397 if (!empty($returns['assignee_contact_name'])) {
398 $returns['assignee_contact_id'] = 1;
401 foreach ($returns as $n => $v) {
403 case 'assignee_contact_id':
404 foreach ($activities as $key => $activityArray) {
405 $cids = $activities[$key]['assignee_contact_id'] = CRM_Activity_BAO_ActivityAssignment
::retrieveAssigneeIdsByActivityId($activityArray['id']);
406 if ($cids && !empty($returns['assignee_contact_name'])) {
407 foreach ($cids as $cid) {
408 $activities[$key]['assignee_contact_name'][$cid] = CRM_Core_DAO
::getFieldValue('CRM_Contact_DAO_Contact', $cid, 'display_name');
414 case 'target_contact_id':
415 foreach ($activities as $key => $activityArray) {
416 $cids = $activities[$key]['target_contact_id'] = CRM_Activity_BAO_ActivityTarget
::retrieveTargetIdsByActivityId($activityArray['id']);
417 if ($cids && !empty($returns['target_contact_name'])) {
418 foreach ($cids as $cid) {
419 $activities[$key]['target_contact_name'][$cid] = CRM_Core_DAO
::getFieldValue('CRM_Contact_DAO_Contact', $cid, 'display_name');
425 case 'source_contact_id':
426 foreach ($activities as $key => $activityArray) {
427 $cid = $activities[$key]['source_contact_id'] = CRM_Activity_BAO_Activity
::getSourceContactID($activityArray['id']);
428 if ($cid && !empty($returns['source_contact_name'])) {
429 $activities[$key]['source_contact_name'] = CRM_Core_DAO
::getFieldValue('CRM_Contact_DAO_Contact', $cid, 'display_name');
435 if (substr($n, 0, 6) == 'custom') {
436 $returnProperties[$n] = $v;
440 if (!empty($activities) && (!empty($returnProperties) ||
!empty($params['contact_id']))) {
441 foreach ($activities as $activityId => $values) {
442 //@todo - should possibly load activity type id if not loaded (update with id)
443 _civicrm_api3_custom_data_get($activities[$activityId], CRM_Utils_Array
::value('check_permissions', $params), 'Activity', $activityId, NULL, CRM_Utils_Array
::value('activity_type_id', $values));
451 * Delete a specified Activity.
453 * @param array $params
454 * Array holding 'id' of activity to be deleted.
456 * @throws API_Exception
461 function civicrm_api3_activity_delete($params) {
463 if (CRM_Activity_BAO_Activity
::deleteActivity($params)) {
464 return civicrm_api3_create_success(1, $params, 'Activity', 'delete');
467 throw new API_Exception('Could not delete Activity');
472 * Check for required params.
474 * @param array $params
475 * Associated array of fields.
477 * @throws API_Exception
482 function _civicrm_api3_activity_check_params(&$params) {
484 $contactIDFields = array_intersect_key($params,
486 'source_contact_id' => 1,
487 'assignee_contact_id' => 1,
488 'target_contact_id' => 1,
492 // this should be handled by wrapper layer & probably the api would already manage it
493 //correctly by doing post validation - ie. a failure should result in a roll-back = an error
495 if (!empty($contactIDFields)) {
496 $contactIds = array();
497 foreach ($contactIDFields as $fieldname => $contactfield) {
498 if (empty($contactfield)) {
501 if (is_array($contactfield)) {
502 foreach ($contactfield as $contactkey => $contactvalue) {
503 $contactIds[$contactvalue] = $contactvalue;
507 $contactIds[$contactfield] = $contactfield;
514 WHERE id IN (' . implode(', ', $contactIds) . ' )';
515 if (count($contactIds) != CRM_Core_DAO
::singleValueQuery($sql)) {
516 throw new API_Exception('Invalid Contact Id');
520 $activityIds = array(
521 'activity' => CRM_Utils_Array
::value('id', $params),
522 'parent' => CRM_Utils_Array
::value('parent_id', $params),
523 'original' => CRM_Utils_Array
::value('original_id', $params),
526 foreach ($activityIds as $id => $value) {
528 !CRM_Core_DAO
::getFieldValue('CRM_Activity_DAO_Activity', $value, 'id')
530 throw new API_Exception('Invalid ' . ucfirst($id) . ' Id');
533 // this should be handled by wrapper layer & probably the api would already manage it
534 //correctly by doing pseudoconstant validation
536 $activityTypes = CRM_Activity_BAO_Activity
::buildOptions('activity_type_id', 'validate');
537 $activityName = CRM_Utils_Array
::value('activity_name', $params);
538 $activityName = ucfirst($activityName);
539 $activityLabel = CRM_Utils_Array
::value('activity_label', $params);
540 if ($activityLabel) {
541 $activityTypes = CRM_Activity_BAO_Activity
::buildOptions('activity_type_id', 'create');
544 $activityTypeId = CRM_Utils_Array
::value('activity_type_id', $params);
546 if ($activityName ||
$activityLabel) {
547 $activityTypeIdInList = array_search(($activityName ?
$activityName : $activityLabel), $activityTypes);
549 if (!$activityTypeIdInList) {
550 $errorString = $activityName ?
"Invalid Activity Name : $activityName" : "Invalid Activity Type Label";
551 throw new Exception($errorString);
553 elseif ($activityTypeId && ($activityTypeId != $activityTypeIdInList)) {
554 throw new API_Exception('Mismatch in Activity');
556 $params['activity_type_id'] = $activityTypeIdInList;
558 elseif ($activityTypeId &&
559 !array_key_exists($activityTypeId, $activityTypes)
561 throw new API_Exception('Invalid Activity Type ID');
564 // check for activity duration minutes
565 // this should be validated @ the wrapper layer not here
567 if (isset($params['duration_minutes']) && !is_numeric($params['duration_minutes'])) {
568 throw new API_Exception('Invalid Activity Duration (in minutes)');
571 //if adding a new activity & date_time not set make it now
572 // this should be managed by the wrapper layer & setting ['api.default'] in speces
574 if (empty($params['id']) && empty($params['activity_date_time'])) {
575 $params['activity_date_time'] = CRM_Utils_Date
::processDate(date('Y-m-d H:i:s'));
582 * Get parameters for activity list.
584 * @see _civicrm_api3_generic_getlist_params
586 * @param array $request
589 function _civicrm_api3_activity_getlist_params(&$request) {
590 $fieldsToReturn = array(
591 'activity_date_time',
596 $request['params']['return'] = array_unique(array_merge($fieldsToReturn, $request['extra']));
597 $request['params']['options']['sort'] = 'activity_date_time DESC';
598 $request['params'] +
= array(
599 'is_current_revision' => 1,
605 * Get output for activity list.
607 * @see _civicrm_api3_generic_getlist_output
609 * @param array $result
610 * @param array $request
614 function _civicrm_api3_activity_getlist_output($result, $request) {
616 if (!empty($result['values'])) {
617 foreach ($result['values'] as $row) {
619 'id' => $row[$request['id_field']],
620 'label' => $row[$request['label_field']] ?
$row[$request['label_field']] : ts('(no subject)'),
621 'description' => array(
622 CRM_Core_Pseudoconstant
::getLabel('CRM_Activity_BAO_Activity', 'activity_type_id', $row['activity_type_id']),
625 if (!empty($row['activity_date_time'])) {
626 $data['description'][0] .= ': ' . CRM_Utils_Date
::customFormat($row['activity_date_time']);
628 if (!empty($row['source_contact_id'])) {
629 $data['description'][] = ts('By %1', array(
630 1 => CRM_Core_DAO
::getFieldValue('CRM_Contact_DAO_Contact', $row['source_contact_id'], 'display_name'),
633 // Add repeating info
634 $repeat = CRM_Core_BAO_RecurringEntity
::getPositionAndCount($row['id'], 'civicrm_activity');
635 $data['extra']['is_recur'] = FALSE;
637 $data['suffix'] = ts('(%1 of %2)', array(1 => $repeat[0], 2 => $repeat[1]));
638 $data['extra']['is_recur'] = TRUE;