3 +--------------------------------------------------------------------+
4 | Copyright CiviCRM LLC. All rights reserved. |
6 | This work is published under the GNU AGPLv3 license with some |
7 | permitted exceptions and without any warranty. For full license |
8 | and copyright information, see https://civicrm.org/licensing |
9 +--------------------------------------------------------------------+
15 * @copyright CiviCRM LLC https://civicrm.org/licensing
19 * This class is for activity functions.
21 class CRM_Activity_BAO_Activity
extends CRM_Activity_DAO_Activity
{
24 * Activity status types
32 * Static field for all the activity information that we can potentially export.
36 public static $_exportableFields = NULL;
39 * Static field for all the activity information that we can potentially import.
43 public static $_importableFields = NULL;
46 * Check if there is absolute minimum of data to add the object.
48 * @param array $params
49 * (reference ) an assoc array of name/value pairs.
53 public static function dataExists(&$params) {
54 if (!empty($params['source_contact_id']) ||
!empty($params['id'])) {
63 * Fetch object based on array of properties.
65 * @param array $params
66 * (reference ) an assoc array of name/value pairs.
67 * @param array $defaults
68 * (reference ) an assoc array to hold the flattened values.
70 * @return CRM_Activity_DAO_Activity
72 public static function retrieve(&$params, &$defaults) {
73 // this will bypass acls - use the api instead.
74 // @todo add deprecation logging to this function.
75 $activity = new CRM_Activity_DAO_Activity();
76 $activity->copyValues($params);
78 if ($activity->find(TRUE)) {
79 $activityContacts = CRM_Activity_BAO_ActivityContact
::buildOptions('record_type_id', 'validate');
80 $targetID = CRM_Utils_Array
::key('Activity Targets', $activityContacts);
81 $sourceID = CRM_Utils_Array
::key('Activity Source', $activityContacts);
82 $assigneeID = CRM_Utils_Array
::key('Activity Assignees', $activityContacts);
84 // TODO: at some stage we'll have to deal
85 // with multiple values for assignees and targets, but
86 // for now, let's just fetch first row.
87 $defaults['assignee_contact'] = CRM_Activity_BAO_ActivityContact
::retrieveContactIdsByActivityId($activity->id
, $assigneeID);
88 $assignee_contact_names = CRM_Activity_BAO_ActivityContact
::getNames($activity->id
, $assigneeID);
89 $defaults['assignee_contact_value'] = implode('; ', $assignee_contact_names);
90 $sourceContactId = self
::getActivityContact($activity->id
, $sourceID);
91 if ($activity->activity_type_id
!= CRM_Core_PseudoConstant
::getKey('CRM_Activity_BAO_Activity', 'activity_type_id', 'Bulk Email')) {
92 $defaults['target_contact'] = CRM_Activity_BAO_ActivityContact
::retrieveContactIdsByActivityId($activity->id
, $targetID);
93 $target_contact_names = CRM_Activity_BAO_ActivityContact
::getNames($activity->id
, $targetID);
94 $defaults['target_contact_value'] = implode('; ', $target_contact_names);
96 elseif (CRM_Core_Permission
::check('access CiviMail') ||
97 (CRM_Mailing_Info
::workflowEnabled() &&
98 CRM_Core_Permission
::check('create mailings')
101 $defaults['mailingId'] = CRM_Utils_System
::url('civicrm/mailing/report',
102 "mid={$activity->source_record_id}&reset=1&atype={$activity->activity_type_id}&aid={$activity->id}&cid={$sourceContactId}&context=activity"
106 $defaults['target_contact_value'] = ts('(recipients)');
109 $sourceContactId = self
::getActivityContact($activity->id
, $sourceID);
110 $defaults['source_contact_id'] = $sourceContactId;
112 if ($sourceContactId &&
113 !CRM_Core_DAO
::getFieldValue('CRM_Contact_DAO_Contact',
118 $defaults['source_contact'] = CRM_Core_DAO
::getFieldValue('CRM_Contact_DAO_Contact',
125 $defaults['case_subject'] = CRM_Case_BAO_Case
::getCaseSubject($activity->id
);
127 CRM_Core_DAO
::storeValues($activity, $defaults);
135 * Delete the activity.
137 * @param array $params
138 * @param bool $moveToTrash
142 public static function deleteActivity(&$params, $moveToTrash = FALSE) {
144 if (!empty($params['id']) && !is_array($params['id'])) {
145 CRM_Utils_Hook
::pre('delete', 'Activity', $params['id'], $params);
148 CRM_Utils_Hook
::pre('delete', 'Activity', NULL, $params);
151 $transaction = new CRM_Core_Transaction();
152 if (is_array(CRM_Utils_Array
::value('source_record_id', $params))) {
153 $sourceRecordIds = implode(',', $params['source_record_id']);
156 $sourceRecordIds = CRM_Utils_Array
::value('source_record_id', $params);
161 if (!isset($params['id'])) {
162 if (is_array($params['activity_type_id'])) {
163 $activityTypes = implode(',', $params['activity_type_id']);
166 $activityTypes = $params['activity_type_id'];
169 $query = "DELETE FROM civicrm_activity WHERE source_record_id IN ({$sourceRecordIds}) AND activity_type_id IN ( {$activityTypes} )";
170 $dao = CRM_Core_DAO
::executeQuery($query);
173 $activity = new CRM_Activity_DAO_Activity();
174 $activity->copyValues($params);
175 $result = $activity->delete();
178 $activity->case_id
= CRM_Case_BAO_Case
::getCaseIdByActivityId($activity->id
);
180 // CRM-13994 delete activity entity_tag
181 $query = "DELETE FROM civicrm_entity_tag WHERE entity_table = 'civicrm_activity' AND entity_id = {$activity->id}";
182 $dao = CRM_Core_DAO
::executeQuery($query);
186 $activity = new CRM_Activity_DAO_Activity();
187 $activity->copyValues($params);
189 $activity->is_deleted
= 1;
190 $result = $activity->save();
192 // CRM-4525 log activity delete
193 $logMsg = 'Case Activity deleted for';
196 $activityContacts = CRM_Activity_BAO_ActivityContact
::buildOptions('record_type_id', 'validate');
197 $sourceID = CRM_Utils_Array
::key('Activity Source', $activityContacts);
198 $assigneeID = CRM_Utils_Array
::key('Activity Assignees', $activityContacts);
199 $targetID = CRM_Utils_Array
::key('Activity Targets', $activityContacts);
200 $sourceContactId = self
::getActivityContact($activity->id
, $sourceID);
201 if ($sourceContactId) {
202 $msgs[] = " source={$sourceContactId}";
205 // get target contacts.
206 $targetContactIds = CRM_Activity_BAO_ActivityContact
::getNames($activity->id
, $targetID);
207 if (!empty($targetContactIds)) {
208 $msgs[] = " target =" . implode(',', array_keys($targetContactIds));
210 // get assignee contacts.
211 $assigneeContactIds = CRM_Activity_BAO_ActivityContact
::getNames($activity->id
, $assigneeID);
212 if (!empty($assigneeContactIds)) {
213 $msgs[] = " assignee =" . implode(',', array_keys($assigneeContactIds));
216 $logMsg .= implode(', ', $msgs);
218 self
::logActivityAction($activity, $logMsg);
221 // delete the recently created Activity
224 'id' => $activity->id
,
225 'type' => 'Activity',
227 CRM_Utils_Recent
::del($activityRecent);
230 $transaction->commit();
231 if (isset($activity)) {
233 $activity->case_id
= CRM_Case_BAO_Case
::getCaseIdByActivityId($activity->id
);
234 CRM_Utils_Hook
::post('delete', 'Activity', $activity->id
, $activity);
241 * Delete activity assignment record.
243 * @param int $activityId
244 * @param int $recordTypeID
246 public static function deleteActivityContact($activityId, $recordTypeID = NULL) {
247 $activityContact = new CRM_Activity_BAO_ActivityContact();
248 $activityContact->activity_id
= $activityId;
250 $activityContact->record_type_id
= $recordTypeID;
253 // Let's check if activity contact record exits and then delete.
254 // Looks like delete leads to deadlock when multiple simultaneous
255 // requests are done. CRM-15470
256 if ($activityContact->find()) {
257 $activityContact->delete();
262 * Process the activities.
264 * @param array $params
265 * Associated array of the submitted values.
267 * @throws CRM_Core_Exception
269 * @return CRM_Activity_BAO_Activity|null|object
271 public static function create(&$params) {
272 // CRM-20958 - These fields are managed by MySQL triggers. Watch out for clients resaving stale timestamps.
273 unset($params['created_date']);
274 unset($params['modified_date']);
276 // check required params
277 if (!self
::dataExists($params)) {
278 throw new CRM_Core_Exception('Not enough data to create activity object');
281 $activity = new CRM_Activity_DAO_Activity();
283 if (isset($params['id']) && empty($params['id'])) {
284 unset($params['id']);
287 if (empty($params['status_id']) && empty($params['activity_status_id']) && empty($params['id'])) {
288 if (isset($params['activity_date_time']) &&
289 strcmp($params['activity_date_time'], CRM_Utils_Date
::processDate(date('Ymd')) == -1)
291 $params['status_id'] = CRM_Core_PseudoConstant
::getKey('CRM_Activity_BAO_Activity', 'status_id', 'Completed');
294 $params['status_id'] = CRM_Core_PseudoConstant
::getKey('CRM_Activity_BAO_Activity', 'status_id', 'Scheduled');
298 // Set priority to Normal for Auto-populated activities (for Cases)
299 if (!isset($params['priority_id']) &&
300 // if not set and not 0
303 $priority = CRM_Core_PseudoConstant
::get('CRM_Activity_DAO_Activity', 'priority_id');
304 $params['priority_id'] = array_search('Normal', $priority);
307 if (!empty($params['target_contact_id']) && is_array($params['target_contact_id'])) {
308 $params['target_contact_id'] = array_unique($params['target_contact_id']);
310 if (!empty($params['assignee_contact_id']) && is_array($params['assignee_contact_id'])) {
311 $params['assignee_contact_id'] = array_unique($params['assignee_contact_id']);
315 if (!empty($params['id'])) {
316 CRM_Utils_Hook
::pre('edit', 'Activity', $params['id'], $params);
319 CRM_Utils_Hook
::pre('create', 'Activity', NULL, $params);
322 $activity->copyValues($params);
323 if (isset($params['case_id'])) {
324 // CRM-8708, preserve case ID even though it's not part of the SQL model
325 $activity->case_id
= $params['case_id'];
327 elseif (is_numeric($activity->id
)) {
328 // CRM-8708, preserve case ID even though it's not part of the SQL model
329 $activity->case_id
= CRM_Case_BAO_Case
::getCaseIdByActivityId($activity->id
);
333 $transaction = new CRM_Core_Transaction();
335 $result = $activity->save();
337 if (is_a($result, 'CRM_Core_Error')) {
338 $transaction->rollback();
342 $activityId = $activity->id
;
343 $sourceID = CRM_Core_PseudoConstant
::getKey('CRM_Activity_BAO_ActivityContact', 'record_type_id', 'Activity Source');
344 $assigneeID = CRM_Core_PseudoConstant
::getKey('CRM_Activity_BAO_ActivityContact', 'record_type_id', 'Activity Assignees');
345 $targetID = CRM_Core_PseudoConstant
::getKey('CRM_Activity_BAO_ActivityContact', 'record_type_id', 'Activity Targets');
347 if (isset($params['source_contact_id'])) {
349 'activity_id' => $activityId,
350 'contact_id' => $params['source_contact_id'],
351 'record_type_id' => $sourceID,
353 self
::deleteActivityContact($activityId, $sourceID);
354 CRM_Activity_BAO_ActivityContact
::create($acParams);
357 // check and attach and files as needed
358 CRM_Core_BAO_File
::processAttachment($params, 'civicrm_activity', $activityId);
360 // attempt to save activity assignment
361 $resultAssignment = NULL;
362 if (!empty($params['assignee_contact_id'])) {
364 $assignmentParams = ['activity_id' => $activityId];
366 if (is_array($params['assignee_contact_id'])) {
367 if (CRM_Utils_Array
::value('deleteActivityAssignment', $params, TRUE)) {
368 // first delete existing assignments if any
369 self
::deleteActivityContact($activityId, $assigneeID);
372 foreach ($params['assignee_contact_id'] as $acID) {
375 'activity_id' => $activityId,
376 'contact_id' => $acID,
377 'record_type_id' => $assigneeID,
379 CRM_Activity_BAO_ActivityContact
::create($assigneeParams);
384 $assignmentParams['contact_id'] = $params['assignee_contact_id'];
385 $assignmentParams['record_type_id'] = $assigneeID;
386 if (!empty($params['id'])) {
387 $assignment = new CRM_Activity_BAO_ActivityContact();
388 $assignment->activity_id
= $activityId;
389 $assignment->record_type_id
= $assigneeID;
390 $assignment->find(TRUE);
392 if ($assignment->contact_id
!= $params['assignee_contact_id']) {
393 $assignmentParams['id'] = $assignment->id
;
394 $resultAssignment = CRM_Activity_BAO_ActivityContact
::create($assignmentParams);
398 $resultAssignment = CRM_Activity_BAO_ActivityContact
::create($assignmentParams);
403 if (CRM_Utils_Array
::value('deleteActivityAssignment', $params, TRUE)) {
404 self
::deleteActivityContact($activityId, $assigneeID);
408 if (is_a($resultAssignment, 'CRM_Core_Error')) {
409 $transaction->rollback();
410 return $resultAssignment;
413 // attempt to save activity targets
414 $resultTarget = NULL;
415 if (!empty($params['target_contact_id'])) {
417 $targetParams = ['activity_id' => $activityId];
419 if (is_array($params['target_contact_id'])) {
420 if (CRM_Utils_Array
::value('deleteActivityTarget', $params, TRUE)) {
421 // first delete existing targets if any
422 self
::deleteActivityContact($activityId, $targetID);
425 foreach ($params['target_contact_id'] as $tid) {
427 $targetContactParams = [
428 'activity_id' => $activityId,
429 'contact_id' => $tid,
430 'record_type_id' => $targetID,
432 CRM_Activity_BAO_ActivityContact
::create($targetContactParams);
437 $targetParams['contact_id'] = $params['target_contact_id'];
438 $targetParams['record_type_id'] = $targetID;
439 if (!empty($params['id'])) {
440 $target = new CRM_Activity_BAO_ActivityContact();
441 $target->activity_id
= $activityId;
442 $target->record_type_id
= $targetID;
445 if ($target->contact_id
!= $params['target_contact_id']) {
446 $targetParams['id'] = $target->id
;
447 $resultTarget = CRM_Activity_BAO_ActivityContact
::create($targetParams);
451 $resultTarget = CRM_Activity_BAO_ActivityContact
::create($targetParams);
456 if (CRM_Utils_Array
::value('deleteActivityTarget', $params, TRUE)) {
457 self
::deleteActivityContact($activityId, $targetID);
461 // write to changelog before transaction is committed/rolled
462 // back (and prepare status to display)
463 if (!empty($params['id'])) {
464 $logMsg = "Activity (id: {$result->id} ) updated with ";
467 $logMsg = "Activity created for ";
471 if (isset($params['source_contact_id'])) {
472 $msgs[] = "source={$params['source_contact_id']}";
475 if (!empty($params['target_contact_id'])) {
476 if (is_array($params['target_contact_id']) && !CRM_Utils_Array
::crmIsEmptyArray($params['target_contact_id'])) {
477 $msgs[] = "target=" . implode(',', $params['target_contact_id']);
478 // take only first target
479 // will be used for recently viewed display
480 $t = array_slice($params['target_contact_id'], 0, 1);
481 $recentContactId = $t[0];
483 // Is array check fixes warning without degrading functionality but it seems this bit of code may no longer work
484 // as it may always be an array
485 elseif (isset($params['target_contact_id']) && !is_array($params['target_contact_id'])) {
486 $msgs[] = "target={$params['target_contact_id']}";
487 // will be used for recently viewed display
488 $recentContactId = $params['target_contact_id'];
492 // at worst, take source for recently viewed display
493 $recentContactId = CRM_Utils_Array
::value('source_contact_id', $params);
496 if (isset($params['assignee_contact_id'])) {
497 if (is_array($params['assignee_contact_id'])) {
498 $msgs[] = "assignee=" . implode(',', $params['assignee_contact_id']);
501 $msgs[] = "assignee={$params['assignee_contact_id']}";
504 $logMsg .= implode(', ', $msgs);
506 self
::logActivityAction($result, $logMsg);
508 if (!empty($params['custom']) &&
509 is_array($params['custom'])
511 CRM_Core_BAO_CustomValueTable
::store($params['custom'], 'civicrm_activity', $result->id
);
514 $transaction->commit();
515 if (empty($params['skipRecentView'])) {
517 if (!empty($params['case_id'])) {
518 $caseContactID = CRM_Core_DAO
::getFieldValue('CRM_Case_DAO_CaseContact', $params['case_id'], 'contact_id', 'case_id');
519 $url = CRM_Utils_System
::url('civicrm/case/activity/view',
520 "reset=1&aid={$activity->id}&cid={$caseContactID}&caseID={$params['case_id']}&context=home"
524 $q = "action=view&reset=1&id={$activity->id}&atype={$activity->activity_type_id}&cid=" . CRM_Utils_Array
::value('source_contact_id', $params) . "&context=home";
525 if ($activity->activity_type_id
!= CRM_Core_PseudoConstant
::getKey('CRM_Activity_BAO_Activity', 'activity_type_id', 'Email')) {
526 $url = CRM_Utils_System
::url('civicrm/activity', $q);
527 if ($activity->activity_type_id
== CRM_Core_PseudoConstant
::getKey('CRM_Activity_BAO_Activity', 'activity_type_id', 'Print PDF Letter')) {
528 $recentOther['editUrl'] = CRM_Utils_System
::url('civicrm/activity/pdf/add',
529 "action=update&reset=1&id={$activity->id}&atype={$activity->activity_type_id}&cid={$params['source_contact_id']}&context=home"
533 $recentOther['editUrl'] = CRM_Utils_System
::url('civicrm/activity/add',
534 "action=update&reset=1&id={$activity->id}&atype={$activity->activity_type_id}&cid=" . CRM_Utils_Array
::value('source_contact_id', $params) . "&context=home"
538 if (CRM_Core_Permission
::check("delete activities")) {
539 $recentOther['deleteUrl'] = CRM_Utils_System
::url('civicrm/activity',
540 "action=delete&reset=1&id={$activity->id}&atype={$activity->activity_type_id}&cid=" . CRM_Utils_Array
::value('source_contact_id', $params) . "&context=home"
545 $url = CRM_Utils_System
::url('civicrm/activity/view', $q);
546 if (CRM_Core_Permission
::check('delete activities')) {
547 $recentOther['deleteUrl'] = CRM_Utils_System
::url('civicrm/activity',
548 "action=delete&reset=1&id={$activity->id}&atype={$activity->activity_type_id}&cid=" . CRM_Utils_Array
::value('source_contact_id', $params) . "&context=home"
554 if (!isset($activity->parent_id
)) {
555 $recentContactDisplay = CRM_Contact_BAO_Contact
::displayName($recentContactId);
556 // add the recently created Activity
557 $activityTypes = CRM_Activity_BAO_Activity
::buildOptions('activity_type_id');
558 $activitySubject = CRM_Core_DAO
::getFieldValue('CRM_Activity_DAO_Activity', $activity->id
, 'subject');
561 if (isset($activitySubject)) {
562 $title = $activitySubject . ' - ';
565 $title = $title . $recentContactDisplay;
566 if (!empty($activityTypes[$activity->activity_type_id
])) {
567 $title .= ' (' . $activityTypes[$activity->activity_type_id
] . ')';
570 CRM_Utils_Recent
::add($title,
575 $recentContactDisplay,
581 CRM_Contact_BAO_GroupContactCache
::opportunisticCacheFlush();
583 // if the subject contains a ‘[case #…]’ string, file that activity on the related case (CRM-5916)
585 $subjectToMatch = CRM_Utils_Array
::value('subject', $params);
586 if (preg_match('/\[case #([0-9a-h]{7})\]/', $subjectToMatch, $matches)) {
587 $key = CRM_Core_DAO
::escapeString(CIVICRM_SITE_KEY
);
589 $query = "SELECT id FROM civicrm_case WHERE SUBSTR(SHA1(CONCAT('$key', id)), 1, 7) = '" . CRM_Core_DAO
::escapeString($hash) . "'";
591 elseif (preg_match('/\[case #(\d+)\]/', $subjectToMatch, $matches)) {
592 $query = "SELECT id FROM civicrm_case WHERE id = '" . CRM_Core_DAO
::escapeString($matches[1]) . "'";
594 if (!empty($matches)) {
596 'activity_id' => $activity->id
,
597 'case_id' => CRM_Core_DAO
::singleValueQuery($query),
599 if ($caseParams['case_id']) {
600 CRM_Case_BAO_Case
::processCaseActivity($caseParams);
603 self
::logActivityAction($activity, "Case details for {$matches[1]} not found while recording an activity on case.");
606 if (!empty($params['id'])) {
607 CRM_Utils_Hook
::post('edit', 'Activity', $activity->id
, $activity);
610 CRM_Utils_Hook
::post('create', 'Activity', $activity->id
, $activity);
617 * Create an activity.
619 * @todo elaborate on what this does.
621 * @param CRM_Core_DAO_Activity $activity
622 * @param string $logMessage
626 public static function logActivityAction($activity, $logMessage = NULL) {
627 $id = CRM_Core_Session
::getLoggedInContactID();
629 $activityContacts = CRM_Activity_BAO_ActivityContact
::buildOptions('record_type_id', 'validate');
630 $sourceID = CRM_Utils_Array
::key('Activity Source', $activityContacts);
631 $id = self
::getActivityContact($activity->id
, $sourceID);
634 'entity_table' => 'civicrm_activity',
635 'entity_id' => $activity->id
,
636 'modified_id' => $id,
637 'modified_date' => date('YmdHis'),
638 'data' => $logMessage,
640 CRM_Core_BAO_Log
::add($logParams);
645 * Get the list Activities.
647 * @param array $params
648 * Array of parameters.
650 * - contact_id int contact_id whose activities we want to retrieve
651 * - offset int which row to start from ?
652 * - rowCount int how many rows to fetch
653 * - sort object|array object or array describing sort order for sql query.
654 * - admin boolean if contact is admin
655 * - caseId int case ID
656 * - context string page on which selector is build
657 * - activity_type_id int|string the activitiy types we want to restrict by
660 * Relevant data object values of open activities
661 * @throws \CiviCRM_API3_Exception
663 public static function getActivities($params) {
666 // Activity.Get API params
667 $activityParams = self
::getActivityParamsForDashboardFunctions($params);
669 if (!empty($params['rowCount']) &&
670 $params['rowCount'] > 0
672 $activityParams['options']['limit'] = $params['rowCount'];
675 if (!empty($params['sort'])) {
676 if (is_a($params['sort'], 'CRM_Utils_Sort')) {
677 $order = $params['sort']->orderBy();
679 elseif (trim($params['sort'])) {
680 $order = CRM_Utils_Type
::escape($params['sort'], 'String');
684 $activityParams['options']['sort'] = empty($order) ?
"activity_date_time DESC" : str_replace('activity_type ', 'activity_type_id.label ', $order);
686 $activityParams['return'] = [
687 'activity_date_time',
690 'source_contact_name',
691 'assignee_contact_id',
692 'assignee_contact_name',
700 // Q. What does the code below achieve? case_id and campaign_id are already
701 // in the array, defined above, and this code adds them in again if their
702 // component is enabled? @fixme remove case_id and campaign_id from the array above?
703 foreach (['case_id' => 'CiviCase', 'campaign_id' => 'CiviCampaign'] as $attr => $component) {
704 if (in_array($component, self
::activityComponents())) {
705 $activityParams['return'][] = $attr;
708 $result = civicrm_api3('Activity', 'Get', $activityParams)['values'];
710 $bulkActivityTypeID = CRM_Core_PseudoConstant
::getKey('CRM_Activity_BAO_Activity', 'activity_type_id', 'Bulk Email');
711 $allCampaigns = CRM_Campaign_BAO_Campaign
::getCampaigns(NULL, NULL, FALSE, FALSE, FALSE, TRUE);
713 // CRM-3553, need to check user has access to target groups.
714 $mailingIDs = CRM_Mailing_BAO_Mailing
::mailingACLIDs();
715 $accessCiviMail = ((CRM_Core_Permission
::check('access CiviMail')) ||
716 (CRM_Mailing_Info
::workflowEnabled() && CRM_Core_Permission
::check('create mailings'))
719 // @todo - get rid of this & just handle in the array declaration like we do with 'subject' etc.
721 'source_record_id' => 'source_record_id',
722 'activity_type_id' => 'activity_type_id',
723 'status_id' => 'status_id',
724 'campaign_id' => 'campaign_id',
725 'case_id' => 'case_id',
728 if (empty($result)) {
732 $targetCount = CRM_Core_DAO
::executeQuery('
733 SELECT activity_id, count(*) as target_contact_count
734 FROM civicrm_activity_contact
735 INNER JOIN civicrm_contact c ON contact_id = c.id AND c.is_deleted = 0
736 WHERE activity_id IN (' . implode(',', array_keys($result)) . ')
737 AND record_type_id = %1
738 GROUP BY activity_id', [
740 CRM_Core_PseudoConstant
::getKey('CRM_Activity_BAO_ActivityContact', 'record_type_id', 'Activity Targets'),
745 foreach ($targetCount as $activityTarget) {
746 $result[$activityTarget['activity_id']]['target_contact_count'] = $activityTarget['target_contact_count'];
748 // Iterate through & do basic mappings & determine which ones we want to retrieve target count for.
749 foreach ($result as $id => $activity) {
751 'activity_id' => $activity['id'],
752 'activity_date_time' => CRM_Utils_Array
::value('activity_date_time', $activity),
753 'subject' => CRM_Utils_Array
::value('subject', $activity),
754 'assignee_contact_name' => CRM_Utils_Array
::value('assignee_contact_sort_name', $activity, []),
755 'source_contact_id' => CRM_Utils_Array
::value('source_contact_id', $activity),
756 'source_contact_name' => CRM_Utils_Array
::value('source_contact_sort_name', $activity),
758 $activities[$id]['activity_type_name'] = CRM_Core_PseudoConstant
::getName('CRM_Activity_BAO_Activity', 'activity_type_id', $activity['activity_type_id']);
759 $activities[$id]['activity_type'] = CRM_Core_PseudoConstant
::getLabel('CRM_Activity_BAO_Activity', 'activity_type_id', $activity['activity_type_id']);
760 $activities[$id]['target_contact_count'] = CRM_Utils_Array
::value('target_contact_count', $activity, 0);
761 if (!empty($activity['target_contact_count'])) {
762 $displayedTarget = civicrm_api3('ActivityContact', 'get', [
763 'activity_id' => $id,
764 'check_permissions' => TRUE,
765 'options' => ['limit' => 1],
766 'record_type_id' => 'Activity Targets',
767 'return' => ['contact_id.sort_name', 'contact_id'],
770 if (empty($displayedTarget[0])) {
771 $activities[$id]['target_contact_name'] = [];
774 $activities[$id]['target_contact_name'] = [$displayedTarget[0]['contact_id'] => $displayedTarget[0]['contact_id.sort_name']];
777 if ($activities[$id]['activity_type_name'] === 'Bulk Email') {
778 $bulkActivities[] = $id;
779 // Get the total without permissions being passed but only display names after permissioning.
780 $activities[$id]['recipients'] = ts('(%1 recipients)', [1 => $activities[$id]['target_contact_count']]);
784 // Eventually this second iteration should just handle the target contacts. It's a bit muddled at
785 // the moment as the bulk activity stuff needs unravelling & test coverage.
787 foreach ($result as $id => $activity) {
788 $isBulkActivity = (!$bulkActivityTypeID ||
($bulkActivityTypeID === $activity['activity_type_id']));
789 foreach ($mappingParams as $apiKey => $expectedName) {
790 if (in_array($apiKey, [
791 'target_contact_name',
794 if ($isBulkActivity) {
795 // @todo - how is this used? Couldn't we use 'is_bulk' or something clearer?
796 // or the calling function could handle
797 $activities[$id]['mailingId'] = FALSE;
798 if ($accessCiviMail &&
799 ($mailingIDs === TRUE ||
in_array($activity['source_record_id'], $mailingIDs))
801 $activities[$id]['mailingId'] = TRUE;
805 // case related fields
806 elseif ($apiKey == 'case_id' && !$isBulkActivity) {
807 $activities[$id][$expectedName] = CRM_Utils_Array
::value($apiKey, $activity);
809 // fetch case subject for case ID found
810 if (!empty($activity['case_id'])) {
811 // Store cases; we'll look them up in one query below. We convert
812 // to int here so we can trust it for SQL.
813 $caseIds[$id] = (int) current($activity['case_id']);
817 // @todo this generic assign could just be handled in array declaration earlier.
818 $activities[$id][$expectedName] = CRM_Utils_Array
::value($apiKey, $activity);
819 if ($apiKey == 'campaign_id') {
820 $activities[$id]['campaign'] = CRM_Utils_Array
::value($activities[$id][$expectedName], $allCampaigns);
824 // if deleted, wrap in <del>
825 if (!empty($activity['source_contact_id']) &&
826 CRM_Core_DAO
::getFieldValue('CRM_Contact_DAO_Contact', $activity['source_contact_id'], 'is_deleted')
828 $activities[$id]['source_contact_name'] = sprintf("<del>%s<del>", $activity['source_contact_name']);
830 $activities[$id]['is_recurring_activity'] = CRM_Core_BAO_RecurringEntity
::getParentFor($id, 'civicrm_activity');
833 // Look up any case subjects we need in a single query and add them in the relevant activities under 'case_subject'
835 $subjects = CRM_Core_DAO
::executeQuery('SELECT id, subject FROM civicrm_case WHERE id IN (' . implode(',', array_unique($caseIds)) . ')')
836 ->fetchMap('id', 'subject');
837 foreach ($caseIds as $activityId => $caseId) {
838 $result[$activityId]['case_subject'] = $subjects[$caseId];
846 * Filter the activity types to only return the ones we actually asked for
847 * Uses params['activity_type_id'] and params['activity_type_exclude_id']
850 * @return array|null (Use in Activity.get API activity_type_id)
852 public static function filterActivityTypes($params) {
855 // If no activity types are specified, get all the active ones
856 if (empty($params['activity_type_id'])) {
857 $activityTypes = CRM_Activity_BAO_Activity
::buildOptions('activity_type_id', 'get');
860 // If no activity types are specified or excluded, return the list of all active ones
861 if (empty($params['activity_type_id']) && empty($params['activity_type_exclude_id'])) {
862 if (!empty($activityTypes)) {
863 return ['IN' => array_keys($activityTypes)];
868 // If we have specified activity types, build a list to return, excluding the ones we don't want.
869 if (!empty($params['activity_type_id'])) {
870 if (!is_array($params['activity_type_id'])) {
871 // Turn it into array if only one specified, so we don't duplicate processing below
872 $params['activity_type_id'] = [$params['activity_type_id'] => $params['activity_type_id']];
874 foreach ($params['activity_type_id'] as $value) {
875 // Add each activity type that was specified to list
876 $value = CRM_Utils_Type
::escape($value, 'Positive');
877 $activityTypes[$value] = $value;
881 // Build the list of activity types to exclude (from $params['activity_type_exclude_id'])
882 if (!empty($params['activity_type_exclude_id'])) {
883 if (!is_array($params['activity_type_exclude_id'])) {
884 // Turn it into array if only one specified, so we don't duplicate processing below
885 $params['activity_type_exclude_id'] = [$params['activity_type_exclude_id'] => $params['activity_type_exclude_id']];
887 foreach ($params['activity_type_exclude_id'] as $value) {
888 // Remove each activity type from list if it should be excluded
889 $value = CRM_Utils_Type
::escape($value, 'Positive');
890 if (array_key_exists($value, $activityTypes)) {
891 unset($activityTypes[$value]);
896 return ['IN' => array_keys($activityTypes)];
902 public function addSelectWhereClause() {
904 // @todo - check if $permissedActivityTYpes === all activity types and do not add critieria if so.
905 $permittedActivityTypeIDs = self
::getPermittedActivityTypes();
906 if (empty($permittedActivityTypeIDs)) {
907 // This just prevents a mysql fail if they have no access - should be extremely edge case.
908 $permittedActivityTypeIDs = [0];
910 $clauses['activity_type_id'] = ('IN (' . implode(', ', $permittedActivityTypeIDs) . ')');
912 $contactClause = CRM_Utils_SQL
::mergeSubquery('Contact');
913 if ($contactClause) {
914 $contactClause = implode(' AND contact_id ', $contactClause);
915 $clauses['id'][] = "IN (SELECT activity_id FROM civicrm_activity_contact WHERE contact_id $contactClause)";
917 CRM_Utils_Hook
::selectWhereClause($this, $clauses);
922 * Get an array of components that are accessible by the currenct user.
924 * This means checking if they are enabled and if the user has appropriate permission.
926 * For most components the permission is access component (e.g 'access CiviContribute').
927 * Exceptions as CiviCampaign (administer CiviCampaign) and CiviCase
928 * (accesses a case function which enforces edit all cases or edit my cases. Case
929 * permissions are also handled on a per activity basis).
931 * Checks whether logged in user has permission to the component.
933 * @param bool $excludeComponentHandledActivities
934 * Should we exclude components whose display is handled in the components.
935 * In practice this means should we include CiviCase in the results. Presumbaly
936 * at the time it was decided case activities should be shown in the case framework and
937 * that this concept might be extended later. In practice most places that
938 * call this then re-add CiviCase in some way so it's all a bit... odd.
941 * Array of component id and name.
943 public static function activityComponents($excludeComponentHandledActivities = TRUE) {
945 $compInfo = CRM_Core_Component
::getEnabledComponents();
946 foreach ($compInfo as $compObj) {
947 $includeComponent = !$excludeComponentHandledActivities ||
!empty($compObj->info
['showActivitiesInCore']);
948 if ($includeComponent) {
949 if ($compObj->info
['name'] == 'CiviCampaign') {
950 $componentPermission = "administer {$compObj->name}";
953 $componentPermission = "access {$compObj->name}";
955 if ($compObj->info
['name'] == 'CiviCase') {
956 if (CRM_Case_BAO_Case
::accessCiviCase()) {
957 $components[$compObj->componentID
] = $compObj->info
['name'];
960 elseif (CRM_Core_Permission
::check($componentPermission)) {
961 $components[$compObj->componentID
] = $compObj->info
['name'];
970 * Get the activity Count.
972 * @param array $input
973 * Array of parameters.
975 * - contact_id int contact_id whose activities we want to retrieve
976 * - admin boolean if contact is admin
977 * - caseId int case ID
978 * - context string page on which selector is build
979 * - activity_type_id int|string the activity types we want to restrict by
982 * count of activities
984 public static function getActivitiesCount($input) {
985 $activityParams = self
::getActivityParamsForDashboardFunctions($input);
986 return civicrm_api3('Activity', 'getcount', $activityParams);
991 * @param string $subject
992 * @param string $html
993 * @param string $text
994 * @param string $additionalDetails
995 * @param int $campaignID
996 * @param array $attachments
1000 * The created activity ID
1001 * @throws \CRM_Core_Exception
1003 public static function createEmailActivity($userID, $subject, $html, $text, $additionalDetails, $campaignID, $attachments, $caseID) {
1004 $activityTypeID = CRM_Core_PseudoConstant
::getKey('CRM_Activity_BAO_Activity', 'activity_type_id', 'Email');
1006 // CRM-6265: save both text and HTML parts in details (if present)
1007 if ($html and $text) {
1008 $details = "-ALTERNATIVE ITEM 0-\n$html$additionalDetails\n-ALTERNATIVE ITEM 1-\n$text$additionalDetails\n-ALTERNATIVE END-\n";
1011 $details = $html ?
$html : $text;
1012 $details .= $additionalDetails;
1016 'source_contact_id' => $userID,
1017 'activity_type_id' => $activityTypeID,
1018 'activity_date_time' => date('YmdHis'),
1019 'subject' => $subject,
1020 'details' => $details,
1021 // FIXME: check for name Completed and get ID from that lookup
1022 'status_id' => CRM_Core_PseudoConstant
::getKey('CRM_Activity_BAO_Activity', 'status_id', 'Completed'),
1023 'campaign_id' => $campaignID,
1025 if (!empty($caseID)) {
1026 $activityParams['case_id'] = $caseID;
1029 // CRM-5916: strip [case #…] before saving the activity (if present in subject)
1030 $activityParams['subject'] = preg_replace('/\[case #([0-9a-h]{7})\] /', '', $activityParams['subject']);
1032 // add the attachments to activity params here
1034 // first process them
1035 $activityParams = array_merge($activityParams, $attachments);
1038 $activity = civicrm_api3('Activity', 'create', $activityParams);
1039 return $activity['id'];
1043 * Send the message to all the contacts.
1045 * Also insert a contact activity in each contacts record.
1047 * @param array $contactDetails
1048 * The array of contact details to send the email.
1049 * @param string $subject
1050 * The subject of the message.
1053 * @param string $emailAddress
1054 * Use this 'to' email address instead of the default Primary address.
1055 * @param int $userID
1056 * Use this userID if set.
1057 * @param string $from
1058 * @param array $attachments
1059 * The array of attachments if any.
1062 * @param string $bcc
1064 * @param array $contactIds
1066 * @param string $additionalDetails
1067 * The additional information of CC and BCC appended to the activity Details.
1068 * @param array $contributionIds
1069 * @param int $campaignId
1070 * @param int $caseId
1073 * ( sent, activityId) if any email is sent and activityId
1074 * @throws \CRM_Core_Exception
1075 * @throws \CiviCRM_API3_Exception
1077 public static function sendEmail(
1085 $attachments = NULL,
1089 $additionalDetails = NULL,
1090 $contributionIds = NULL,
1094 // get the contact details of logged in contact, which we set as from email
1095 if ($userID == NULL) {
1096 $userID = CRM_Core_Session
::getLoggedInContactID();
1099 list($fromDisplayName, $fromEmail, $fromDoNotEmail) = CRM_Contact_BAO_Contact
::getContactDetails($userID);
1101 return [count($contactDetails), 0, count($contactDetails)];
1103 if (!trim($fromDisplayName)) {
1104 $fromDisplayName = $fromEmail;
1108 // token replacement of addressee/email/postal greetings
1109 // get the tokens added in subject and message
1110 $subjectToken = CRM_Utils_Token
::getTokens($subject);
1111 $messageToken = CRM_Utils_Token
::getTokens($text);
1112 $messageToken = array_merge($messageToken, CRM_Utils_Token
::getTokens($html));
1113 $allTokens = array_merge($messageToken, $subjectToken);
1116 $from = "$fromDisplayName <$fromEmail>";
1119 //create the meta level record first ( email activity )
1120 $activityID = self
::createEmailActivity($userID, $subject, $html, $text, $additionalDetails, $campaignId, $attachments, $caseId);
1122 $returnProperties = [];
1123 if (isset($messageToken['contact'])) {
1124 foreach ($messageToken['contact'] as $key => $value) {
1125 $returnProperties[$value] = 1;
1129 if (isset($subjectToken['contact'])) {
1130 foreach ($subjectToken['contact'] as $key => $value) {
1131 if (!isset($returnProperties[$value])) {
1132 $returnProperties[$value] = 1;
1137 // get token details for contacts, call only if tokens are used
1139 if (!empty($returnProperties) ||
!empty($tokens) ||
!empty($allTokens)) {
1140 list($details) = CRM_Utils_Token
::getTokenDetails(
1145 'CRM_Activity_BAO_Activity'
1151 CRM_Utils_Hook
::tokens($tokens);
1152 $categories = array_keys($tokens);
1154 $escapeSmarty = FALSE;
1155 if (defined('CIVICRM_MAIL_SMARTY') && CIVICRM_MAIL_SMARTY
) {
1156 $smarty = CRM_Core_Smarty
::singleton();
1157 $escapeSmarty = TRUE;
1160 $contributionDetails = [];
1161 if (!empty($contributionIds)) {
1162 $contributionDetails = CRM_Contribute_BAO_Contribution
::replaceContributionTokens(
1173 $sent = $notSent = [];
1174 foreach ($contactDetails as $values) {
1175 $contactId = $values['contact_id'];
1176 $emailAddress = $values['email'];
1178 if (!empty($contributionDetails)) {
1179 $subject = $contributionDetails[$contactId]['subject'];
1180 $text = $contributionDetails[$contactId]['text'];
1181 $html = $contributionDetails[$contactId]['html'];
1184 if (!empty($details) && is_array($details["{$contactId}"])) {
1185 // unset email from details since it always returns primary email address
1186 unset($details["{$contactId}"]['email']);
1187 unset($details["{$contactId}"]['email_id']);
1188 $values = array_merge($values, $details["{$contactId}"]);
1191 $tokenSubject = CRM_Utils_Token
::replaceContactTokens($subject, $values, FALSE, $subjectToken, FALSE, $escapeSmarty);
1192 $tokenSubject = CRM_Utils_Token
::replaceHookTokens($tokenSubject, $values, $categories, FALSE, $escapeSmarty);
1195 if ($values['preferred_mail_format'] == 'Text' ||
$values['preferred_mail_format'] == 'Both') {
1196 $tokenText = CRM_Utils_Token
::replaceContactTokens($text, $values, FALSE, $messageToken, FALSE, $escapeSmarty);
1197 $tokenText = CRM_Utils_Token
::replaceHookTokens($tokenText, $values, $categories, FALSE, $escapeSmarty);
1203 if ($values['preferred_mail_format'] == 'HTML' ||
$values['preferred_mail_format'] == 'Both') {
1204 $tokenHtml = CRM_Utils_Token
::replaceContactTokens($html, $values, TRUE, $messageToken, FALSE, $escapeSmarty);
1205 $tokenHtml = CRM_Utils_Token
::replaceHookTokens($tokenHtml, $values, $categories, TRUE, $escapeSmarty);
1212 $tokenSubject = CRM_Utils_Token
::replaceCaseTokens($caseId, $tokenSubject, $subjectToken, $escapeSmarty);
1213 $tokenText = CRM_Utils_Token
::replaceCaseTokens($caseId, $tokenText, $messageToken, $escapeSmarty);
1214 $tokenHtml = CRM_Utils_Token
::replaceCaseTokens($caseId, $tokenHtml, $messageToken, $escapeSmarty);
1217 if (defined('CIVICRM_MAIL_SMARTY') && CIVICRM_MAIL_SMARTY
) {
1218 // also add the contact tokens to the template
1219 $smarty->assign_by_ref('contact', $values);
1221 $tokenSubject = $smarty->fetch("string:$tokenSubject");
1222 $tokenText = $smarty->fetch("string:$tokenText");
1223 $tokenHtml = $smarty->fetch("string:$tokenHtml");
1227 if (self
::sendMessage(
1236 // get the set of attachments from where they are stored
1237 CRM_Core_BAO_File
::getEntityFile('civicrm_activity', $activityID),
1246 return [$sent, $activityID];
1250 * Send SMS. Returns: bool $sent, int $activityId, int $success (number of sent SMS)
1252 * @param array $contactDetails
1253 * @param array $activityParams
1254 * @param array $smsProviderParams
1255 * @param array $contactIds
1256 * @param int $sourceContactId This is the source contact Id
1258 * @return array(bool $sent, int $activityId, int $success)
1259 * @throws CRM_Core_Exception
1261 public static function sendSMS(
1262 &$contactDetails = NULL,
1264 &$smsProviderParams = [],
1265 &$contactIds = NULL,
1266 $sourceContactId = NULL
1268 if (!CRM_Core_Permission
::check('send SMS')) {
1269 throw new CRM_Core_Exception("You do not have the 'send SMS' permission");
1272 if (!isset($contactDetails) && !isset($contactIds)) {
1273 throw new CRM_Core_Exception('You must specify either $contactDetails or $contactIds');
1275 // Populate $contactDetails and $contactIds if only one is set
1276 if (is_array($contactIds) && !empty($contactIds) && empty($contactDetails)) {
1277 foreach ($contactIds as $id) {
1279 $contactDetails[] = civicrm_api3('Contact', 'getsingle', ['contact_id' => $id]);
1281 catch (Exception
$e) {
1282 // Contact Id doesn't exist
1286 elseif (is_array($contactDetails) && !empty($contactDetails) && empty($contactIds)) {
1287 foreach ($contactDetails as $contact) {
1288 $contactIds[] = $contact['contact_id'];
1292 // Get logged in User Id
1293 if (empty($sourceContactId)) {
1294 $sourceContactId = CRM_Core_Session
::getLoggedInContactID();
1297 $text = &$activityParams['sms_text_message'];
1299 // Create the meta level record first ( sms activity )
1301 'source_contact_id' => $sourceContactId,
1302 'activity_type_id' => CRM_Core_PseudoConstant
::getKey('CRM_Activity_BAO_Activity', 'activity_type_id', 'SMS'),
1303 'activity_date_time' => date('YmdHis'),
1304 'subject' => $activityParams['activity_subject'],
1306 'status_id' => CRM_Core_PseudoConstant
::getKey('CRM_Activity_BAO_Activity', 'status_id', 'Completed'),
1308 $activity = self
::create($activityParams);
1309 $activityID = $activity->id
;
1312 // token replacement of addressee/email/postal greetings
1313 // get the tokens added in subject and message
1314 $messageToken = CRM_Utils_Token
::getTokens($text);
1315 $returnProperties = [];
1316 if (isset($messageToken['contact'])) {
1317 foreach ($messageToken['contact'] as $key => $value) {
1318 $returnProperties[$value] = 1;
1323 CRM_Utils_Hook
::tokens($tokens);
1324 $categories = array_keys($tokens);
1325 // get token details for contacts, call only if tokens are used
1327 if (!empty($returnProperties) ||
!empty($tokens)) {
1328 list($tokenDetails) = CRM_Utils_Token
::getTokenDetails($contactIds,
1332 'CRM_Activity_BAO_Activity'
1338 foreach ($contactDetails as $contact) {
1339 $contactId = $contact['contact_id'];
1342 if (!empty($tokenDetails) && is_array($tokenDetails["{$contactId}"])) {
1343 // unset phone from details since it always returns primary number
1344 unset($tokenDetails["{$contactId}"]['phone']);
1345 unset($tokenDetails["{$contactId}"]['phone_type_id']);
1346 $contact = array_merge($contact, $tokenDetails["{$contactId}"]);
1348 $tokenText = CRM_Utils_Token
::replaceContactTokens($text, $contact, FALSE, $messageToken, FALSE, FALSE);
1349 $tokenText = CRM_Utils_Token
::replaceHookTokens($tokenText, $contact, $categories, FALSE, FALSE);
1351 // Only send if the phone is of type mobile
1352 if ($contact['phone_type_id'] == CRM_Core_PseudoConstant
::getKey('CRM_Core_BAO_Phone', 'phone_type_id', 'Mobile')) {
1353 $smsProviderParams['To'] = $contact['phone'];
1356 $smsProviderParams['To'] = '';
1359 $doNotSms = CRM_Utils_Array
::value('do_not_sms', $contact, 0);
1362 $errMsgs[] = PEAR
::raiseError('Contact Does not accept SMS', NULL, PEAR_ERROR_RETURN
);
1366 $sendResult = self
::sendSMSMessage(
1375 catch (CRM_Core_Exception
$e) {
1376 $errMsgs[] = $e->getMessage();
1381 // If at least one message was sent and no errors
1382 // were generated then return a boolean value of TRUE.
1383 // Otherwise, return FALSE (no messages sent) or
1384 // and array of 1 or more PEAR_Error objects.
1386 if ($success > 0 && count($errMsgs) == 0) {
1389 elseif (count($errMsgs) > 0) {
1393 return [$sent, $activity->id
, $success];
1397 * Send the sms message to a specific contact.
1400 * The contact id of the recipient.
1402 * @param array $smsProviderParams
1403 * The params used for sending sms.
1404 * @param int $activityID
1405 * The activity ID that tracks the message.
1406 * @param int $sourceContactID
1408 * @return bool true on success
1409 * @throws CRM_Core_Exception
1411 public static function sendSMSMessage(
1414 $smsProviderParams = [],
1416 $sourceContactID = NULL
1418 $toPhoneNumber = NULL;
1419 if ($smsProviderParams['To']) {
1420 // If phone number is specified use it
1421 $toPhoneNumber = trim($smsProviderParams['To']);
1424 // No phone number specified, so find a suitable one for the contact
1425 $filters = ['is_deceased' => 0, 'is_deleted' => 0, 'do_not_sms' => 0];
1426 $toPhoneNumbers = CRM_Core_BAO_Phone
::allPhones($toID, FALSE, 'Mobile', $filters);
1427 // To get primary mobile phonenumber, if not get the first mobile phonenumber
1428 if (!empty($toPhoneNumbers)) {
1429 $toPhoneNumberDetails = reset($toPhoneNumbers);
1430 $toPhoneNumber = CRM_Utils_Array
::value('phone', $toPhoneNumberDetails);
1431 // Contact allows to send sms
1435 // make sure both phone are valid
1436 // and that the recipient wants to receive sms
1437 if (empty($toPhoneNumber)) {
1438 throw new CRM_Core_Exception('Recipient phone number is invalid or recipient does not want to receive SMS');
1441 $recipient = $toPhoneNumber;
1442 $smsProviderParams['contact_id'] = $toID;
1443 $smsProviderParams['parent_activity_id'] = $activityID;
1445 $providerObj = CRM_SMS_Provider
::singleton(['provider_id' => $smsProviderParams['provider_id']]);
1446 $sendResult = $providerObj->send($recipient, $smsProviderParams, $tokenText, NULL, $sourceContactID);
1447 if (PEAR
::isError($sendResult)) {
1448 throw new CRM_Core_Exception($sendResult->getMessage());
1451 // add activity target record for every sms that is sent
1452 $targetID = CRM_Core_PseudoConstant
::getKey('CRM_Activity_BAO_ActivityContact', 'record_type_id', 'Activity Targets');
1453 $activityTargetParams = [
1454 'activity_id' => $activityID,
1455 'contact_id' => $toID,
1456 'record_type_id' => $targetID,
1458 CRM_Activity_BAO_ActivityContact
::create($activityTargetParams);
1464 * Send the message to a specific contact.
1466 * @param string $from
1467 * The name and email of the sender.
1468 * @param int $fromID
1470 * The contact id of the recipient.
1471 * @param string $subject
1472 * The subject of the message.
1473 * @param $text_message
1474 * @param $html_message
1475 * @param string $emailAddress
1476 * Use this 'to' email address instead of the default Primary address.
1477 * @param int $activityID
1478 * The activity ID that tracks the message.
1479 * @param null $attachments
1484 * TRUE if successful else FALSE.
1486 public static function sendMessage(
1495 $attachments = NULL,
1499 list($toDisplayName, $toEmail, $toDoNotEmail) = CRM_Contact_BAO_Contact
::getContactDetails($toID);
1500 if ($emailAddress) {
1501 $toEmail = trim($emailAddress);
1504 // make sure both email addresses are valid
1505 // and that the recipient wants to receive email
1506 if (empty($toEmail) or $toDoNotEmail) {
1509 if (!trim($toDisplayName)) {
1510 $toDisplayName = $toEmail;
1513 $activityContacts = CRM_Activity_BAO_ActivityContact
::buildOptions('record_type_id', 'validate');
1514 $targetID = CRM_Utils_Array
::key('Activity Targets', $activityContacts);
1516 // create the params array
1518 'groupName' => 'Activity Email Sender',
1520 'toName' => $toDisplayName,
1521 'toEmail' => $toEmail,
1522 'subject' => $subject,
1525 'text' => $text_message,
1526 'html' => $html_message,
1527 'attachments' => $attachments,
1530 if (!CRM_Utils_Mail
::send($mailParams)) {
1534 // add activity target record for every mail that is send
1535 $activityTargetParams = [
1536 'activity_id' => $activityID,
1537 'contact_id' => $toID,
1538 'record_type_id' => $targetID,
1540 CRM_Activity_BAO_ActivityContact
::create($activityTargetParams);
1545 * Combine all the importable fields from the lower levels object.
1547 * The ordering is important, since currently we do not have a weight
1548 * scheme. Adding weight is super important and should be done in the
1549 * next week or so, before this can be called complete.
1551 * @param bool $status
1554 * array of importable Fields
1556 public static function &importableFields($status = FALSE) {
1557 if (!self
::$_importableFields) {
1558 if (!self
::$_importableFields) {
1559 self
::$_importableFields = [];
1562 $fields = ['' => ['title' => ts('- do not import -')]];
1565 $fields = ['' => ['title' => ts('- Activity Fields -')]];
1568 $tmpFields = CRM_Activity_DAO_Activity
::import();
1569 $contactFields = CRM_Contact_BAO_Contact
::importableFields('Individual', NULL);
1571 // Using new Dedupe rule.
1573 'contact_type' => 'Individual',
1574 'used' => 'Unsupervised',
1576 $fieldsArray = CRM_Dedupe_BAO_Rule
::dedupeRuleFields($ruleParams);
1578 $tmpConatctField = [];
1579 if (is_array($fieldsArray)) {
1580 foreach ($fieldsArray as $value) {
1581 $customFieldId = CRM_Core_DAO
::getFieldValue('CRM_Core_DAO_CustomField',
1586 $value = $customFieldId ?
'custom_' . $customFieldId : $value;
1587 $tmpConatctField[trim($value)] = $contactFields[trim($value)];
1588 $tmpConatctField[trim($value)]['title'] = $tmpConatctField[trim($value)]['title'] . " (match to contact)";
1591 $tmpConatctField['external_identifier'] = $contactFields['external_identifier'];
1592 $tmpConatctField['external_identifier']['title'] = $contactFields['external_identifier']['title'] . " (match to contact)";
1593 $fields = array_merge($fields, $tmpConatctField);
1594 $fields = array_merge($fields, $tmpFields);
1595 $fields = array_merge($fields, CRM_Core_BAO_CustomField
::getFieldsForImport('Activity'));
1596 self
::$_importableFields = $fields;
1598 return self
::$_importableFields;
1602 * @deprecated - use the api instead.
1604 * Get the Activities of a target contact.
1606 * @param int $contactId
1607 * Id of the contact whose activities need to find.
1610 * array of activity fields
1612 public static function getContactActivity($contactId) {
1613 // @todo remove this function entirely.
1615 $activityContacts = CRM_Activity_BAO_ActivityContact
::buildOptions('record_type_id', 'validate');
1616 $sourceID = CRM_Utils_Array
::key('Activity Source', $activityContacts);
1617 $assigneeID = CRM_Utils_Array
::key('Activity Assignees', $activityContacts);
1618 $targetID = CRM_Utils_Array
::key('Activity Targets', $activityContacts);
1620 // First look for activities where contactId is one of the targets
1622 SELECT activity_id, record_type_id
1623 FROM civicrm_activity_contact
1624 WHERE contact_id = $contactId
1626 $dao = CRM_Core_DAO
::executeQuery($query);
1627 while ($dao->fetch()) {
1628 if ($dao->record_type_id
== $targetID) {
1629 $activities[$dao->activity_id
]['targets'][$contactId] = $contactId;
1631 elseif ($dao->record_type_id
== $assigneeID) {
1632 $activities[$dao->activity_id
]['asignees'][$contactId] = $contactId;
1635 // do source stuff here
1636 $activities[$dao->activity_id
]['source_contact_id'] = $contactId;
1640 $activityIds = array_keys($activities);
1641 if (count($activityIds) < 1) {
1645 $activityIds = implode(',', $activityIds);
1647 SELECT activity.id as activity_id,
1649 subject, location, activity_date_time, details, status_id
1650 FROM civicrm_activity activity
1651 WHERE activity.id IN ($activityIds)";
1653 $dao = CRM_Core_DAO
::executeQuery($query);
1655 while ($dao->fetch()) {
1656 $activities[$dao->activity_id
]['id'] = $dao->activity_id
;
1657 $activities[$dao->activity_id
]['activity_type_id'] = $dao->activity_type_id
;
1658 $activities[$dao->activity_id
]['subject'] = $dao->subject
;
1659 $activities[$dao->activity_id
]['location'] = $dao->location
;
1660 $activities[$dao->activity_id
]['activity_date_time'] = $dao->activity_date_time
;
1661 $activities[$dao->activity_id
]['details'] = $dao->details
;
1662 $activities[$dao->activity_id
]['status_id'] = $dao->status_id
;
1663 $activities[$dao->activity_id
]['activity_name'] = CRM_Core_PseudoConstant
::getLabel('CRM_Activity_BAO_Activity', 'activity_type_id', $dao->activity_type_id
);
1664 $activities[$dao->activity_id
]['status'] = CRM_Core_PseudoConstant
::getLabel('CRM_Activity_BAO_Activity', 'activity_status_id', $dao->status_id
);
1666 // set to null if not set
1667 if (!isset($activities[$dao->activity_id
]['source_contact_id'])) {
1668 $activities[$dao->activity_id
]['source_contact_id'] = NULL;
1675 * Add activity for Membership/Event/Contribution.
1677 * @param object $activity
1678 * (reference) particular component object.
1679 * @param string $activityType
1680 * For Membership Signup or Renewal.
1681 * @param int $targetContactID
1682 * @param array $params
1683 * Activity params to override.
1687 public static function addActivity(
1689 $activityType = 'Membership Signup',
1690 $targetContactID = NULL,
1693 $date = date('YmdHis');
1694 if ($activity->__table
== 'civicrm_membership') {
1695 $component = 'Membership';
1697 elseif ($activity->__table
== 'civicrm_participant') {
1698 if ($activityType != 'Email') {
1699 $activityType = 'Event Registration';
1701 $component = 'Event';
1703 elseif ($activity->__table
== 'civicrm_contribution') {
1704 // create activity record only for Completed Contributions
1705 $contributionCompletedStatusId = CRM_Core_PseudoConstant
::getKey('CRM_Contribute_BAO_Contribution', 'contribution_status_id', 'Completed');
1706 if ($activity->contribution_status_id
!= $contributionCompletedStatusId) {
1709 $activityType = $component = 'Contribution';
1711 // retrieve existing activity based on source_record_id and activity_type
1712 if (empty($params['id'])) {
1713 $params['id'] = CRM_Utils_Array
::value('id', civicrm_api3('Activity', 'Get', [
1714 'source_record_id' => $activity->id
,
1715 'activity_type_id' => $activityType,
1718 if (!empty($params['id'])) {
1719 // CRM-13237 : if activity record found, update it with campaign id of contribution
1720 $params['campaign_id'] = $activity->campaign_id
;
1723 $date = CRM_Utils_Date
::isoToMysql($activity->receive_date
);
1727 'source_contact_id' => $activity->contact_id
,
1728 'source_record_id' => $activity->id
,
1729 'activity_type_id' => CRM_Core_PseudoConstant
::getKey('CRM_Activity_BAO_Activity', 'activity_type_id', $activityType),
1730 'activity_date_time' => $date,
1731 'is_test' => $activity->is_test
,
1732 'status_id' => CRM_Core_PseudoConstant
::getKey('CRM_Activity_BAO_Activity', 'activity_status_id', 'Completed'),
1733 'skipRecentView' => TRUE,
1734 'campaign_id' => $activity->campaign_id
,
1736 $activityParams = array_merge($activityParams, $params);
1738 if (empty($activityParams['subject'])) {
1739 $activityParams['subject'] = self
::getActivitySubject($activity);
1742 if (!empty($activity->activity_id
)) {
1743 $activityParams['id'] = $activity->activity_id
;
1745 // create activity with target contacts
1746 $id = CRM_Core_Session
::getLoggedInContactID();
1748 $activityParams['source_contact_id'] = $id;
1749 $activityParams['target_contact_id'][] = $activity->contact_id
;
1753 if (property_exists($activity, 'details')) {
1754 $activityParams['details'] = $activity->details
;
1757 if ($targetContactID) {
1758 $activityParams['target_contact_id'][] = $targetContactID;
1760 // @todo - use api - remove lots of wrangling above. Remove deprecated fatal & let form layer
1761 // deal with any exceptions.
1762 if (is_a(self
::create($activityParams), 'CRM_Core_Error')) {
1763 CRM_Core_Error
::fatal("Failed creating Activity for $component of id {$activity->id}");
1769 * Get activity subject on basis of component object.
1771 * @param object $entityObj
1772 * particular component object.
1776 public static function getActivitySubject($entityObj) {
1777 switch ($entityObj->__table
) {
1778 case 'civicrm_membership':
1779 $membershipType = CRM_Member_PseudoConstant
::membershipType($entityObj->membership_type_id
);
1780 $subject = $membershipType ?
$membershipType : ts('Membership');
1782 if (is_array($subject)) {
1783 $subject = implode(", ", $subject);
1786 if (!CRM_Utils_System
::isNull($entityObj->source
)) {
1787 $subject .= " - {$entityObj->source}";
1790 if ($entityObj->owner_membership_id
) {
1791 list($displayName) = CRM_Contact_BAO_Contact
::getDisplayAndImage(CRM_Core_DAO
::getFieldValue('CRM_Member_DAO_Membership', $entityObj->owner_membership_id
, 'contact_id'));
1792 $subject .= sprintf(' (by %s)', $displayName);
1795 $subject .= " - Status: " . CRM_Core_DAO
::getFieldValue('CRM_Member_DAO_MembershipStatus', $entityObj->status_id
, 'label');
1798 case 'civicrm_participant':
1799 $event = CRM_Event_BAO_Event
::getEvents(1, $entityObj->event_id
, TRUE, FALSE);
1800 $roles = CRM_Event_PseudoConstant
::participantRole();
1801 $status = CRM_Event_PseudoConstant
::participantStatus();
1802 $subject = $event[$entityObj->event_id
];
1804 if (!empty($roles[$entityObj->role_id
])) {
1805 $subject .= ' - ' . $roles[$entityObj->role_id
];
1807 if (!empty($status[$entityObj->status_id
])) {
1808 $subject .= ' - ' . $status[$entityObj->status_id
];
1813 case 'civicrm_contribution':
1814 $subject = CRM_Utils_Money
::format($entityObj->total_amount
, $entityObj->currency
);
1815 if (!CRM_Utils_System
::isNull($entityObj->source
)) {
1816 $subject .= " - {$entityObj->source}";
1819 // Amount and source could exceed max length of subject column.
1820 return CRM_Utils_String
::ellipsify($subject, 255);
1825 * Get Parent activity for currently viewed activity.
1827 * @param int $activityId
1828 * Current activity id.
1831 * Id of parent activity otherwise false.
1833 public static function getParentActivity($activityId) {
1834 static $parentActivities = [];
1836 $activityId = CRM_Utils_Type
::escape($activityId, 'Integer');
1838 if (!array_key_exists($activityId, $parentActivities)) {
1839 $parentActivities[$activityId] = [];
1841 $parentId = CRM_Core_DAO
::getFieldValue('CRM_Activity_DAO_Activity',
1846 $parentActivities[$activityId] = $parentId ?
$parentId : FALSE;
1849 return $parentActivities[$activityId];
1853 * Get total count of prior revision of currently viewed activity.
1855 * @param $activityID
1856 * Current activity id.
1859 * $params count of prior activities otherwise false.
1861 public static function getPriorCount($activityID) {
1862 static $priorCounts = [];
1864 $activityID = CRM_Utils_Type
::escape($activityID, 'Integer');
1866 if (!array_key_exists($activityID, $priorCounts)) {
1867 $priorCounts[$activityID] = [];
1868 $originalID = CRM_Core_DAO
::getFieldValue('CRM_Activity_DAO_Activity',
1875 SELECT count( id ) AS cnt
1876 FROM civicrm_activity
1877 WHERE ( id = {$originalID} OR original_id = {$originalID} )
1878 AND is_current_revision = 0
1879 AND id < {$activityID}
1881 $params = [1 => [$originalID, 'Integer']];
1882 $count = CRM_Core_DAO
::singleValueQuery($query, $params);
1884 $priorCounts[$activityID] = $count ?
$count : 0;
1887 return $priorCounts[$activityID];
1891 * Get all prior activities of currently viewed activity.
1893 * @param $activityID
1894 * Current activity id.
1895 * @param bool $onlyPriorRevisions
1898 * prior activities info.
1900 public static function getPriorAcitivities($activityID, $onlyPriorRevisions = FALSE) {
1901 static $priorActivities = [];
1903 $activityID = CRM_Utils_Type
::escape($activityID, 'Integer');
1904 $index = $activityID . '_' . (int) $onlyPriorRevisions;
1906 if (!array_key_exists($index, $priorActivities)) {
1907 $priorActivities[$index] = [];
1909 $originalID = CRM_Core_DAO
::getFieldValue('CRM_Activity_DAO_Activity',
1914 $originalID = $activityID;
1918 SELECT c.display_name as name, cl.modified_date as date, ca.id as activityID
1919 FROM civicrm_log cl, civicrm_contact c, civicrm_activity ca
1920 WHERE (ca.id = %1 OR ca.original_id = %1)
1921 AND cl.entity_table = 'civicrm_activity'
1922 AND cl.entity_id = ca.id
1923 AND cl.modified_id = c.id
1925 if ($onlyPriorRevisions) {
1926 $query .= " AND ca.id < {$activityID}";
1928 $query .= " ORDER BY ca.id DESC";
1930 $params = [1 => [$originalID, 'Integer']];
1931 $dao = CRM_Core_DAO
::executeQuery($query, $params);
1933 while ($dao->fetch()) {
1934 $priorActivities[$index][$dao->activityID
]['id'] = $dao->activityID
;
1935 $priorActivities[$index][$dao->activityID
]['name'] = $dao->name
;
1936 $priorActivities[$index][$dao->activityID
]['date'] = $dao->date
;
1940 return $priorActivities[$index];
1944 * Find the latest revision of a given activity.
1946 * @param int $activityID
1947 * Prior activity id.
1950 * current activity id.
1952 public static function getLatestActivityId($activityID) {
1953 static $latestActivityIds = [];
1955 $activityID = CRM_Utils_Type
::escape($activityID, 'Integer');
1957 if (!array_key_exists($activityID, $latestActivityIds)) {
1958 $latestActivityIds[$activityID] = [];
1960 $originalID = CRM_Core_DAO
::getFieldValue('CRM_Activity_DAO_Activity',
1965 $activityID = $originalID;
1967 $params = [1 => [$activityID, 'Integer']];
1968 $query = "SELECT id from civicrm_activity where original_id = %1 and is_current_revision = 1";
1970 $latestActivityIds[$activityID] = CRM_Core_DAO
::singleValueQuery($query, $params);
1973 return $latestActivityIds[$activityID];
1977 * Create a follow up a given activity.
1979 * @param int $activityId
1980 * activity id of parent activity.
1981 * @param array $params
1983 * @return CRM_Activity_BAO_Activity|null|object
1985 public static function createFollowupActivity($activityId, $params) {
1990 $followupParams = [];
1991 $followupParams['parent_id'] = $activityId;
1992 $followupParams['source_contact_id'] = CRM_Core_Session
::getLoggedInContactID();
1993 $followupParams['status_id'] = CRM_Core_PseudoConstant
::getKey('CRM_Activity_BAO_Activity', 'activity_status_id', 'Scheduled');
1995 $followupParams['activity_type_id'] = $params['followup_activity_type_id'];
1996 // Get Subject of Follow-up Activiity, CRM-4491
1997 $followupParams['subject'] = CRM_Utils_Array
::value('followup_activity_subject', $params);
1998 $followupParams['assignee_contact_id'] = CRM_Utils_Array
::value('followup_assignee_contact_id', $params);
2000 // Create target contact for followup.
2001 if (!empty($params['target_contact_id'])) {
2002 $followupParams['target_contact_id'] = $params['target_contact_id'];
2005 $followupParams['activity_date_time'] = $params['followup_date'];
2006 $followupActivity = self
::create($followupParams);
2008 return $followupActivity;
2012 * Get Activity specific File according activity type Id.
2014 * @param int $activityTypeId
2016 * @param string $crmDir
2018 * @return string|bool
2019 * if file exists returns $activityTypeFile activity filename otherwise false.
2021 public static function getFileForActivityTypeId($activityTypeId, $crmDir = 'Activity') {
2022 $activityTypes = CRM_Case_PseudoConstant
::caseActivityType(FALSE, TRUE);
2024 if ($activityTypes[$activityTypeId]['name']) {
2025 $activityTypeFile = CRM_Utils_String
::munge(ucwords($activityTypes[$activityTypeId]['name']), '', 0);
2031 global $civicrm_root;
2032 $config = CRM_Core_Config
::singleton();
2033 if (!file_exists(rtrim($civicrm_root, '/') . "/CRM/{$crmDir}/Form/Activity/{$activityTypeFile}.php")) {
2034 if (empty($config->customPHPPathDir
)) {
2037 elseif (!file_exists(rtrim($config->customPHPPathDir
, '/') . "/CRM/{$crmDir}/Form/Activity/{$activityTypeFile}.php")) {
2042 return $activityTypeFile;
2046 * Restore the activity.
2048 * @param array $params
2050 * @return CRM_Activity_DAO_Activity
2052 public static function restoreActivity(&$params) {
2053 $activity = new CRM_Activity_DAO_Activity();
2054 $activity->copyValues($params);
2056 $activity->is_deleted
= 0;
2057 $result = $activity->save();
2063 * Return list of activity statuses of a given type.
2065 * Note: activity status options use the "grouping" field to distinguish status types.
2066 * Types are defined in class constants INCOMPLETE, COMPLETED, CANCELLED
2072 public static function getStatusesByType($type) {
2073 if (!isset(Civi
::$statics[__CLASS__
][__FUNCTION__
])) {
2074 $statuses = civicrm_api3('OptionValue', 'get', [
2075 'option_group_id' => 'activity_status',
2076 'return' => ['value', 'name', 'filter'],
2077 'options' => ['limit' => 0],
2079 Civi
::$statics[__CLASS__
][__FUNCTION__
] = $statuses['values'];
2082 foreach (Civi
::$statics[__CLASS__
][__FUNCTION__
] as $status) {
2083 if ($status['filter'] == $type) {
2084 $ret[$status['value']] = $status['name'];
2091 * Check if activity is overdue.
2093 * @param array $activity
2097 public static function isOverdue($activity) {
2098 return array_key_exists($activity['status_id'], self
::getStatusesByType(self
::INCOMPLETE
)) && CRM_Utils_Date
::overdue($activity['activity_date_time']);
2102 * Get the exportable fields for Activities.
2104 * @param string $name
2105 * If it is called by case $name = Case else $name = Activity.
2108 * array of exportable Fields
2110 public static function exportableFields($name = 'Activity') {
2111 self
::$_exportableFields[$name] = [];
2113 // TODO: ideally we should retrieve all fields from xml, in this case since activity processing is done
2114 // my case hence we have defined fields as case_*
2115 if ($name == 'Activity') {
2116 $exportableFields = CRM_Activity_DAO_Activity
::export();
2117 $exportableFields['source_contact_id'] = [
2118 'title' => ts('Source Contact ID'),
2119 'type' => CRM_Utils_Type
::T_INT
,
2121 $exportableFields['source_contact'] = [
2122 'title' => ts('Source Contact'),
2123 'type' => CRM_Utils_Type
::T_STRING
,
2126 // @todo - remove these - they are added by CRM_Core_DAO::appendPseudoConstantsToFields
2127 // below. That search label stuff is referenced in search builder but is likely just
2128 // a hack that duplicates, maybe differently, other functionality.
2130 'activity_type' => [
2131 'title' => ts('Activity Type'),
2132 'name' => 'activity_type',
2133 'type' => CRM_Utils_Type
::T_STRING
,
2134 'searchByLabel' => TRUE,
2136 'activity_status' => [
2137 'title' => ts('Activity Status'),
2138 'name' => 'activity_status',
2139 'type' => CRM_Utils_Type
::T_STRING
,
2140 'searchByLabel' => TRUE,
2142 'activity_priority' => [
2143 'title' => ts('Activity Priority'),
2144 'name' => 'activity_priority',
2145 'type' => CRM_Utils_Type
::T_STRING
,
2146 'searchByLabel' => TRUE,
2149 $fields = array_merge($Activityfields, $exportableFields);
2150 $fields['activity_type_id']['title'] = ts('Activity Type ID');
2153 // Set title to activity fields.
2155 'case_activity_subject' => [
2156 'title' => ts('Activity Subject'),
2157 'type' => CRM_Utils_Type
::T_STRING
,
2159 'case_source_contact_id' => [
2160 'title' => ts('Activity Reporter'),
2161 'type' => CRM_Utils_Type
::T_STRING
,
2163 'case_recent_activity_date' => [
2164 'title' => ts('Activity Actual Date'),
2165 'type' => CRM_Utils_Type
::T_DATE
,
2167 'case_scheduled_activity_date' => [
2168 'title' => ts('Activity Scheduled Date'),
2169 'type' => CRM_Utils_Type
::T_DATE
,
2171 'case_recent_activity_type' => [
2172 'title' => ts('Activity Type'),
2173 'type' => CRM_Utils_Type
::T_STRING
,
2175 'case_activity_status' => [
2176 'title' => ts('Activity Status'),
2177 'type' => CRM_Utils_Type
::T_STRING
,
2179 'case_activity_duration' => [
2180 'title' => ts('Activity Duration'),
2181 'type' => CRM_Utils_Type
::T_INT
,
2183 'case_activity_medium_id' => [
2184 'title' => ts('Activity Medium'),
2185 'type' => CRM_Utils_Type
::T_INT
,
2187 'case_activity_details' => [
2188 'title' => ts('Activity Details'),
2189 'type' => CRM_Utils_Type
::T_TEXT
,
2191 'case_activity_is_auto' => [
2192 'title' => ts('Activity Auto-generated?'),
2193 'type' => CRM_Utils_Type
::T_BOOLEAN
,
2198 // add custom data for case activities
2199 $fields = array_merge($fields, CRM_Core_BAO_CustomField
::getFieldsForImport('Activity'));
2200 CRM_Core_DAO
::appendPseudoConstantsToFields($fields);
2201 self
::$_exportableFields[$name] = $fields;
2202 return self
::$_exportableFields[$name];
2206 * Get the allowed profile fields for Activities.
2209 * array of activity profile Fields
2211 public static function getProfileFields() {
2212 $exportableFields = self
::exportableFields('Activity');
2216 'source_contact_id',
2218 'activity_campaign',
2220 'is_current_revision',
2221 'activity_is_deleted',
2223 $config = CRM_Core_Config
::singleton();
2224 if (!in_array('CiviCampaign', $config->enableComponents
)) {
2225 $skipFields[] = 'activity_engagement_level';
2228 foreach ($skipFields as $field) {
2229 if (isset($exportableFields[$field])) {
2230 unset($exportableFields[$field]);
2234 // hack to use 'activity_type_id' instead of 'activity_type'
2235 $exportableFields['activity_status_id'] = $exportableFields['activity_status'];
2236 unset($exportableFields['activity_status']);
2238 return $exportableFields;
2242 * This function deletes the activity record related to contact record.
2244 * This is conditional on there being no target and assignee record
2245 * with other contacts.
2247 * @param int $contactId
2252 public static function cleanupActivity($contactId) {
2257 $activityContacts = CRM_Activity_BAO_ActivityContact
::buildOptions('record_type_id', 'validate');
2258 $sourceID = CRM_Utils_Array
::key('Activity Source', $activityContacts);
2260 $transaction = new CRM_Core_Transaction();
2262 // delete activity if there is no record in civicrm_activity_contact
2263 // pointing to any other contact record
2264 $activityContact = new CRM_Activity_DAO_ActivityContact();
2265 $activityContact->contact_id
= $contactId;
2266 $activityContact->record_type_id
= $sourceID;
2267 $activityContact->find();
2269 while ($activityContact->fetch()) {
2270 // delete activity_contact record for the deleted contact
2271 $activityContact->delete();
2273 $activityContactOther = new CRM_Activity_DAO_ActivityContact();
2274 $activityContactOther->activity_id
= $activityContact->activity_id
;
2276 // delete activity only if no other contacts connected
2277 if (!$activityContactOther->find(TRUE)) {
2278 $activityParams = ['id' => $activityContact->activity_id
];
2279 $result = self
::deleteActivity($activityParams);
2284 $transaction->commit();
2290 * Does user has sufficient permission for view/edit activity record.
2292 * @param int $activityId
2293 * Activity record id.
2294 * @param int $action
2299 public static function checkPermission($activityId, $action) {
2302 !in_array($action, [CRM_Core_Action
::UPDATE
, CRM_Core_Action
::VIEW
])
2307 $activity = new CRM_Activity_DAO_Activity();
2308 $activity->id
= $activityId;
2309 if (!$activity->find(TRUE)) {
2313 if (!self
::hasPermissionForActivityType($activity->activity_type_id
)) {
2314 // this check is redundant for api access / anything that calls the selectWhereClause
2315 // to determine ACLs.
2318 // Return early when it is case activity.
2319 // Check for CiviCase related permission.
2320 if (CRM_Case_BAO_Case
::isCaseActivity($activityId)) {
2321 return self
::isContactPermittedAccessToCaseActivity($activityId, $action, $activity->activity_type_id
);
2324 // Check for this permission related to contact.
2325 $permission = CRM_Core_Permission
::VIEW
;
2326 if ($action == CRM_Core_Action
::UPDATE
) {
2327 $permission = CRM_Core_Permission
::EDIT
;
2330 $activityContacts = CRM_Activity_BAO_ActivityContact
::buildOptions('record_type_id', 'validate');
2331 $sourceID = CRM_Utils_Array
::key('Activity Source', $activityContacts);
2332 $assigneeID = CRM_Utils_Array
::key('Activity Assignees', $activityContacts);
2333 $targetID = CRM_Utils_Array
::key('Activity Targets', $activityContacts);
2335 // Check for source contact.
2336 $sourceContactId = self
::getActivityContact($activity->id
, $sourceID);
2337 // Account for possibility of activity not having a source contact (as it may have been deleted).
2338 $allow = $sourceContactId ? CRM_Contact_BAO_Contact_Permission
::allow($sourceContactId, $permission) : TRUE;
2343 // Check for target and assignee contacts.
2344 // First check for supper permission.
2345 $supPermission = 'view all contacts';
2346 if ($action == CRM_Core_Action
::UPDATE
) {
2347 $supPermission = 'edit all contacts';
2349 $allow = CRM_Core_Permission
::check($supPermission);
2351 // User might have sufficient permission, through acls.
2354 // Get the target contacts.
2355 $targetContacts = CRM_Activity_BAO_ActivityContact
::retrieveContactIdsByActivityId($activity->id
, $targetID);
2356 foreach ($targetContacts as $cnt => $contactId) {
2357 if (!CRM_Contact_BAO_Contact_Permission
::allow($contactId, $permission)) {
2363 // Get the assignee contacts.
2365 $assigneeContacts = CRM_Activity_BAO_ActivityContact
::retrieveContactIdsByActivityId($activity->id
, $assigneeID);
2366 foreach ($assigneeContacts as $cnt => $contactId) {
2367 if (!CRM_Contact_BAO_Contact_Permission
::allow($contactId, $permission)) {
2379 * Check if the logged in user has permission for the given case activity.
2381 * @param int $activityId
2382 * @param int $action
2383 * @param int $activityTypeID
2387 protected static function isContactPermittedAccessToCaseActivity($activityId, $action, $activityTypeID) {
2389 if ($action == CRM_Core_Action
::UPDATE
) {
2392 $allow = CRM_Case_BAO_Case
::checkPermission($activityId,
2401 * Check if the logged in user has permission to access the given activity type.
2403 * @param int $activityTypeID
2407 protected static function hasPermissionForActivityType($activityTypeID) {
2408 $permittedActivityTypes = self
::getPermittedActivityTypes();
2409 return isset($permittedActivityTypes[$activityTypeID]);
2413 * Get the activity types the user is permitted to access.
2415 * The types are filtered by the components they have access to. ie. a user
2416 * with access CiviContribute but not CiviMember will see contribution related
2417 * activities and activities with no component (e.g meetings) but not member related ones.
2421 protected static function getPermittedActivityTypes() {
2422 $userID = (int) CRM_Core_Session
::getLoggedInContactID();
2423 if (!isset(Civi
::$statics[__CLASS__
]['permitted_activity_types'][$userID])) {
2424 $permittedActivityTypes = [];
2425 $components = self
::activityComponents(FALSE);
2426 $componentClause = empty($components) ?
'' : (' OR component_id IN (' . implode(', ', array_keys($components)) . ')');
2428 $types = CRM_Core_DAO
::executeQuery(
2430 SELECT option_value.value activity_type_id
2431 FROM civicrm_option_value option_value
2432 INNER JOIN civicrm_option_group grp ON (grp.id = option_group_id AND grp.name = 'activity_type')
2433 WHERE component_id IS NULL $componentClause")->fetchAll();
2434 foreach ($types as $type) {
2435 $permittedActivityTypes[$type['activity_type_id']] = (int) $type['activity_type_id'];
2437 Civi
::$statics[__CLASS__
]['permitted_activity_types'][$userID] = $permittedActivityTypes;
2439 return Civi
::$statics[__CLASS__
]['permitted_activity_types'][$userID];
2446 protected static function getActivityParamsForDashboardFunctions($params) {
2449 'is_current_revision' => 1,
2451 'contact_id' => CRM_Utils_Array
::value('contact_id', $params),
2452 'activity_date_time' => CRM_Utils_Array
::value('activity_date_time', $params),
2453 'check_permissions' => 1,
2455 'offset' => CRM_Utils_Array
::value('offset', $params, 0),
2459 if (!empty($params['activity_status_id'])) {
2460 $activityParams['activity_status_id'] = ['IN' => explode(',', $params['activity_status_id'])];
2463 $activityParams['activity_type_id'] = self
::filterActivityTypes($params);
2464 $enabledComponents = self
::activityComponents();
2465 // @todo - this appears to be duplicating the activity api.
2466 if (!in_array('CiviCase', $enabledComponents)) {
2467 $activityParams['case_id'] = ['IS NULL' => 1];
2469 return $activityParams;
2473 * Checks if user has permissions to edit inbound e-mails, either basic info
2474 * or both basic information and content.
2478 public static function checkEditInboundEmailsPermissions() {
2479 if (CRM_Core_Permission
::check('edit inbound email basic information')
2480 || CRM_Core_Permission
::check('edit inbound email basic information and content')
2489 * Get the list of view only activities
2493 public static function getViewOnlyActivityTypeIDs() {
2494 $viewOnlyActivities = [
2495 'Email' => CRM_Core_PseudoConstant
::getKey('CRM_Activity_BAO_Activity', 'activity_type_id', 'Email'),
2497 if (self
::checkEditInboundEmailsPermissions()) {
2498 $viewOnlyActivities['Inbound Email'] = CRM_Core_PseudoConstant
::getKey('CRM_Activity_BAO_Activity', 'activity_type_id', 'Inbound Email');
2500 return $viewOnlyActivities;
2504 * Wrapper for ajax activity selector.
2506 * @param array $params
2507 * Associated array for params record id.
2510 * Associated array of contact activities
2512 public static function getContactActivitySelector(&$params) {
2513 // Format the params.
2514 $params['offset'] = ($params['page'] - 1) * $params['rp'];
2515 $params['rowCount'] = $params['rp'];
2516 $params['sort'] = CRM_Utils_Array
::value('sortBy', $params);
2517 $params['caseId'] = NULL;
2518 $context = CRM_Utils_Array
::value('context', $params);
2519 $showContactOverlay = !CRM_Utils_String
::startsWith($context, "dashlet");
2520 $activityTypeInfo = civicrm_api3('OptionValue', 'get', [
2521 'option_group_id' => "activity_type",
2522 'options' => ['limit' => 0],
2524 $activityIcons = [];
2525 foreach ($activityTypeInfo['values'] as $type) {
2526 if (!empty($type['icon'])) {
2527 $activityIcons[$type['value']] = $type['icon'];
2530 CRM_Utils_Date
::convertFormDateToApiFormat($params, 'activity_date_time');
2532 // Get contact activities.
2533 $activities = CRM_Activity_BAO_Activity
::getActivities($params);
2536 $params['total'] = CRM_Activity_BAO_Activity
::getActivitiesCount($params);
2538 // Format params and add links.
2539 $contactActivities = [];
2541 // View-only activity types
2542 $viewOnlyCaseActivityTypeIDs = array_flip(CRM_Activity_BAO_Activity
::getViewOnlyActivityTypeIDs());
2544 if (!empty($activities)) {
2545 $activityStatus = CRM_Core_PseudoConstant
::activityStatus();
2547 // Check logged in user for permission.
2548 $page = new CRM_Core_Page();
2549 CRM_Contact_Page_View
::checkUserPermission($page, $params['contact_id']);
2550 $permissions = [$page->_permission
];
2551 if (CRM_Core_Permission
::check('delete activities')) {
2552 $permissions[] = CRM_Core_Permission
::DELETE
;
2555 $mask = CRM_Core_Action
::mask($permissions);
2556 $userID = CRM_Core_Session
::getLoggedInContactID();
2558 foreach ($activities as $activityId => $values) {
2559 $activity = ['source_contact_name' => '', 'target_contact_name' => ''];
2560 $activity['DT_RowId'] = $activityId;
2561 // Add class to this row if overdue.
2562 $activity['DT_RowClass'] = "crm-entity status-id-{$values['status_id']}";
2563 if (self
::isOverdue($values)) {
2564 $activity['DT_RowClass'] .= ' status-overdue';
2567 $activity['DT_RowClass'] .= ' status-ontime';
2570 $activity['DT_RowAttr'] = [];
2571 $activity['DT_RowAttr']['data-entity'] = 'activity';
2572 $activity['DT_RowAttr']['data-id'] = $activityId;
2574 $activity['activity_type'] = (!empty($activityIcons[$values['activity_type_id']]) ?
'<span class="crm-i ' . $activityIcons[$values['activity_type_id']] . '"></span> ' : '') . $values['activity_type'];
2575 $activity['subject'] = $values['subject'];
2577 if ($params['contact_id'] == $values['source_contact_id']) {
2578 $activity['source_contact_name'] = $values['source_contact_name'];
2580 elseif ($values['source_contact_id']) {
2582 if ($showContactOverlay) {
2583 $srcTypeImage = CRM_Contact_BAO_Contact_Utils
::getImage(
2584 CRM_Contact_BAO_Contact
::getContactType($values['source_contact_id']),
2586 $values['source_contact_id']);
2588 $activity['source_contact_name'] = $srcTypeImage . CRM_Utils_System
::href($values['source_contact_name'],
2589 'civicrm/contact/view', "reset=1&cid={$values['source_contact_id']}");
2592 $activity['source_contact_name'] = '<em>n/a</em>';
2595 if (isset($values['mailingId']) && !empty($values['mailingId'])) {
2596 $activity['target_contact'] = CRM_Utils_System
::href($values['recipients'],
2597 'civicrm/mailing/report/event',
2598 "mid={$values['source_record_id']}&reset=1&event=queue&cid={$params['contact_id']}&context=activitySelector");
2600 elseif (!empty($values['recipients'])) {
2601 $activity['target_contact_name'] = $values['recipients'];
2603 elseif (isset($values['target_contact_count']) && $values['target_contact_count']) {
2604 $activity['target_contact_name'] = '';
2605 $firstTargetName = reset($values['target_contact_name']);
2606 $firstTargetContactID = key($values['target_contact_name']);
2608 // The first target may not be accessable to the logged in user dev/core#1052
2609 if ($firstTargetName) {
2610 $targetLink = CRM_Utils_System
::href($firstTargetName, 'civicrm/contact/view', "reset=1&cid={$firstTargetContactID}");
2611 if ($showContactOverlay) {
2612 $targetTypeImage = CRM_Contact_BAO_Contact_Utils
::getImage(
2613 CRM_Contact_BAO_Contact
::getContactType($firstTargetContactID),
2615 $firstTargetContactID);
2616 $activity['target_contact_name'] .= "<div>$targetTypeImage $targetLink";
2619 $activity['target_contact_name'] .= $targetLink;
2622 if ($extraCount = $values['target_contact_count'] - 1) {
2623 $activity['target_contact_name'] .= ";<br />" . "(" . ts('%1 more', [1 => $extraCount]) . ")";
2625 if ($showContactOverlay) {
2626 $activity['target_contact_name'] .= "</div> ";
2630 elseif (!$values['target_contact_name']) {
2631 $activity['target_contact_name'] = '<em>n/a</em>';
2634 $activity['assignee_contact_name'] = '';
2635 if (empty($values['assignee_contact_name'])) {
2636 $activity['assignee_contact_name'] = '<em>n/a</em>';
2638 elseif (!empty($values['assignee_contact_name'])) {
2640 $activity['assignee_contact_name'] = '';
2641 foreach ($values['assignee_contact_name'] as $acID => $acName) {
2642 if ($acID && $count < 5) {
2643 $assigneeTypeImage = "";
2644 $assigneeLink = CRM_Utils_System
::href($acName, 'civicrm/contact/view', "reset=1&cid={$acID}");
2645 if ($showContactOverlay) {
2646 $assigneeTypeImage = CRM_Contact_BAO_Contact_Utils
::getImage(
2647 CRM_Contact_BAO_Contact
::getContactType($acID),
2650 $activity['assignee_contact_name'] .= "<div>$assigneeTypeImage $assigneeLink";
2653 $activity['assignee_contact_name'] .= $assigneeLink;
2658 $activity['assignee_contact_name'] .= "; ";
2660 if ($showContactOverlay) {
2661 $activity['assignee_contact_name'] .= "</div> ";
2665 $activity['assignee_contact_name'] .= "(" . ts('more') . ")";
2672 $activity['activity_date_time'] = CRM_Utils_Date
::customFormat($values['activity_date_time']);
2673 $activity['status_id'] = $activityStatus[$values['status_id']];
2676 $activity['links'] = '';
2677 $accessMailingReport = FALSE;
2678 if (!empty($values['mailingId'])) {
2679 $accessMailingReport = TRUE;
2682 // Get action links.
2684 // If this is a case activity, then we hand off to Case's actionLinks instead.
2685 if (!empty($values['case_id']) && Civi
::settings()->get('civicaseShowCaseActivities')) {
2686 // This activity belongs to a case.
2687 $caseId = current($values['case_id']);
2689 $activity['subject'] = $values['subject'];
2691 // Get the view and edit (update) links:
2693 $actionLinks = array_intersect_key(
2694 CRM_Case_Selector_Search
::actionLinks(),
2695 array_fill_keys([CRM_Core_Action
::VIEW
, CRM_Core_Action
::UPDATE
], NULL));
2697 // Create a Manage Case link (using ADVANCED as can't use two VIEW ones)
2698 $actionLinks[CRM_Core_Action
::ADVANCED
] = [
2699 "name" => 'Manage Case',
2700 "url" => 'civicrm/contact/view/case',
2701 'qs' => 'reset=1&id=%%caseid%%&cid=%%cid%%&action=view&context=&selectedChild=case',
2702 "title" => ts('Manage Case %1', [1 => $caseId]),
2703 'class' => 'no-popup',
2707 'aid' => $activityId,
2708 'caseid' => $caseId,
2709 'cid' => current(CRM_Case_BAO_Case
::getCaseClients($caseId) ??
[]),
2710 // Unlike other 'context' params, this 'ctx' param is appended raw to the URL.
2714 $caseActivityPermissions = CRM_Core_Action
::VIEW | CRM_Core_Action
::ADVANCED
;
2715 // Allow Edit link if:
2716 // 1. Activity type is NOT view-only type. CRM-5871
2717 // 2. User has edit permission.
2718 if (!isset($viewOnlyCaseActivityTypeIDs[$values['activity_type_id']])
2719 && CRM_Case_BAO_Case
::checkPermission($activityId, 'edit', $values['activity_type_id'], $userID)) {
2720 // We're allowed to edit.
2721 $caseActivityPermissions |
= CRM_Core_Action
::UPDATE
;
2724 $activity['links'] = CRM_Core_Action
::formLink($actionLinks,
2725 $caseActivityPermissions,
2731 $values['activity_id']
2735 // Non-case activity
2736 $actionLinks = CRM_Activity_Selector_Activity
::actionLinks(
2737 CRM_Utils_Array
::value('activity_type_id', $values),
2738 CRM_Utils_Array
::value('source_record_id', $values),
2739 $accessMailingReport,
2740 CRM_Utils_Array
::value('activity_id', $values)
2742 $actionMask = array_sum(array_keys($actionLinks)) & $mask;
2744 $activity['links'] = CRM_Core_Action
::formLink($actionLinks,
2747 'id' => $values['activity_id'],
2748 'cid' => $params['contact_id'],
2756 $values['activity_id']
2760 if ($values['is_recurring_activity']) {
2761 $activity['is_recurring_activity'] = CRM_Core_BAO_RecurringEntity
::getPositionAndCount($values['activity_id'], 'civicrm_activity');
2764 array_push($contactActivities, $activity);
2769 $activitiesDT['data'] = $contactActivities;
2770 $activitiesDT['recordsTotal'] = $params['total'];
2771 $activitiesDT['recordsFiltered'] = $params['total'];
2773 return $activitiesDT;
2777 * Copy custom fields and attachments from an existing activity to another.
2779 * @see CRM_Case_Page_AJAX::_convertToCaseActivity()
2781 * @param array $params
2783 public static function copyExtendedActivityData($params) {
2784 // attach custom data to the new activity
2785 $customParams = $htmlType = [];
2786 $customValues = CRM_Core_BAO_CustomValueTable
::getEntityValues($params['activityID'], 'Activity');
2788 if (!empty($customValues)) {
2789 $fieldIds = implode(', ', array_keys($customValues));
2790 $sql = "SELECT id FROM civicrm_custom_field WHERE html_type = 'File' AND id IN ( {$fieldIds} )";
2791 $result = CRM_Core_DAO
::executeQuery($sql);
2793 while ($result->fetch()) {
2794 $htmlType[] = $result->id
;
2797 foreach ($customValues as $key => $value) {
2798 if ($value !== NULL) {
2800 if (in_array($key, $htmlType)) {
2801 $fileValues = CRM_Core_BAO_File
::path($value, $params['activityID']);
2802 $customParams["custom_{$key}_-1"] = [
2803 'name' => $fileValues[0],
2804 'type' => $fileValues[1],
2808 $customParams["custom_{$key}_-1"] = $value;
2812 CRM_Core_BAO_CustomValueTable
::postProcess($customParams, 'civicrm_activity',
2813 $params['mainActivityId'], 'Activity'
2817 // copy activity attachments ( if any )
2818 CRM_Core_BAO_File
::copyEntityFile('civicrm_activity', $params['activityID'], 'civicrm_activity', $params['mainActivityId']);
2822 * Get activity contact.
2824 * @param int $activityId
2825 * @param int $recordTypeID
2826 * @param string $column
2830 public static function getActivityContact($activityId, $recordTypeID = NULL, $column = 'contact_id') {
2831 $activityContact = new CRM_Activity_BAO_ActivityContact();
2832 $activityContact->activity_id
= $activityId;
2833 if ($recordTypeID) {
2834 $activityContact->record_type_id
= $recordTypeID;
2836 if ($activityContact->find(TRUE)) {
2837 return $activityContact->$column;
2843 * Get source contact id.
2845 * @param int $activityId
2849 public static function getSourceContactID($activityId) {
2850 static $sourceID = NULL;
2852 $activityContacts = CRM_Activity_BAO_ActivityContact
::buildOptions('record_type_id', 'validate');
2853 $sourceID = CRM_Utils_Array
::key('Activity Source', $activityContacts);
2856 return self
::getActivityContact($activityId, $sourceID);
2862 * @todo Document what this is for.
2864 * @param array $params
2866 public function setApiFilter(&$params) {
2867 if (!empty($params['target_contact_id'])) {
2869 $activityContacts = CRM_Activity_BAO_ActivityContact
::buildOptions('record_type_id', 'validate');
2870 $targetID = CRM_Utils_Array
::key('Activity Targets', $activityContacts);
2871 $obj = new CRM_Activity_BAO_ActivityContact();
2872 $params['return.target_contact_id'] = 1;
2873 $this->joinAdd($obj, 'LEFT');
2874 $this->selectAdd('civicrm_activity.*');
2875 $this->whereAdd(" civicrm_activity_contact.contact_id = {$params['target_contact_id']} AND civicrm_activity_contact.record_type_id = {$targetID}");
2880 * Send activity as attachment.
2882 * @param object $activity
2883 * @param array $mailToContacts
2884 * @param array $params
2888 public static function sendToAssignee($activity, $mailToContacts, $params = []) {
2889 if (!CRM_Utils_Array
::crmIsEmptyArray($mailToContacts)) {
2890 $clientID = CRM_Utils_Array
::value('client_id', $params);
2891 $caseID = CRM_Utils_Array
::value('case_id', $params);
2893 $ics = new CRM_Activity_BAO_ICalendar($activity);
2894 $attachments = CRM_Core_BAO_File
::getEntityFile('civicrm_activity', $activity->id
);
2895 $ics->addAttachment($attachments, $mailToContacts);
2897 $result = CRM_Case_BAO_Case
::sendActivityCopy($clientID, $activity->id
, $mailToContacts, $attachments, $caseID);
2907 public static function getEntityRefFilters() {
2909 ['key' => 'activity_type_id', 'value' => ts('Activity Type')],
2910 ['key' => 'status_id', 'value' => ts('Activity Status')],