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 $sqlWhereParams = $where = [];
153 if (isset($params['source_record_id']) && is_array($params['source_record_id'])) {
154 $sourceRecordIds = implode(',', $params['source_record_id']);
157 $sourceRecordIds = $params['source_record_id'] ??
NULL;
160 if ($sourceRecordIds) {
161 $where[] = 'source_record_id IN ( %1 )';
162 $sqlWhereParams[1] = [$sourceRecordIds, 'CommaSeparatedIntegers'];
166 if (!isset($params['id'])) {
167 if (!empty($params['activity_type_id'])) {
168 $where[] = 'activity_type_id IN ( %2 )';
169 $sqlWhereParams[2] = [implode(',', (array) $params['activity_type_id']), 'CommaSeparatedIntegers'];
171 $query = "DELETE FROM civicrm_activity WHERE " . implode(' AND ', $where);
172 $dao = CRM_Core_DAO
::executeQuery($query, $sqlWhereParams);
175 $activity = new CRM_Activity_DAO_Activity();
176 $activity->copyValues($params);
177 $result = $activity->delete();
180 $activity->case_id
= CRM_Case_BAO_Case
::getCaseIdByActivityId($activity->id
);
182 // CRM-13994 delete activity entity_tag
183 $query = "DELETE FROM civicrm_entity_tag WHERE entity_table = 'civicrm_activity' AND entity_id = %1";
184 $dao = CRM_Core_DAO
::executeQuery($query, [1 => [$activity->id
, 'Positive']]);
186 CRM_Core_BAO_File
::deleteEntityFile('civicrm_activity', $activity->id
);
190 $activity = new CRM_Activity_DAO_Activity();
191 $activity->copyValues($params);
193 $activity->is_deleted
= 1;
194 $result = $activity->save();
196 // CRM-4525 log activity delete
197 $logMsg = 'Case Activity deleted for';
200 $activityContacts = CRM_Activity_BAO_ActivityContact
::buildOptions('record_type_id', 'validate');
201 $sourceID = CRM_Utils_Array
::key('Activity Source', $activityContacts);
202 $assigneeID = CRM_Utils_Array
::key('Activity Assignees', $activityContacts);
203 $targetID = CRM_Utils_Array
::key('Activity Targets', $activityContacts);
204 $sourceContactId = self
::getActivityContact($activity->id
, $sourceID);
205 if ($sourceContactId) {
206 $msgs[] = " source={$sourceContactId}";
209 // get target contacts.
210 $targetContactIds = CRM_Activity_BAO_ActivityContact
::getNames($activity->id
, $targetID);
211 if (!empty($targetContactIds)) {
212 $msgs[] = " target =" . implode(',', array_keys($targetContactIds));
214 // get assignee contacts.
215 $assigneeContactIds = CRM_Activity_BAO_ActivityContact
::getNames($activity->id
, $assigneeID);
216 if (!empty($assigneeContactIds)) {
217 $msgs[] = " assignee =" . implode(',', array_keys($assigneeContactIds));
220 $logMsg .= implode(', ', $msgs);
222 self
::logActivityAction($activity, $logMsg);
225 // delete the recently created Activity
228 'id' => $activity->id
,
229 'type' => 'Activity',
231 CRM_Utils_Recent
::del($activityRecent);
234 $transaction->commit();
235 if (isset($activity)) {
237 $activity->case_id
= CRM_Case_BAO_Case
::getCaseIdByActivityId($activity->id
);
238 CRM_Utils_Hook
::post('delete', 'Activity', $activity->id
, $activity);
245 * Delete activity assignment record.
247 * @param int $activityId
248 * @param int $recordTypeID
250 public static function deleteActivityContact($activityId, $recordTypeID = NULL) {
251 $activityContact = new CRM_Activity_BAO_ActivityContact();
252 $activityContact->activity_id
= $activityId;
254 $activityContact->record_type_id
= $recordTypeID;
257 // Let's check if activity contact record exits and then delete.
258 // Looks like delete leads to deadlock when multiple simultaneous
259 // requests are done. CRM-15470
260 if ($activityContact->find()) {
261 $activityContact->delete();
266 * Process the activities.
268 * @param array $params
269 * Associated array of the submitted values.
271 * @throws CRM_Core_Exception
273 * @return CRM_Activity_BAO_Activity|null|object
275 public static function create(&$params) {
276 // CRM-20958 - These fields are managed by MySQL triggers. Watch out for clients resaving stale timestamps.
277 unset($params['created_date']);
278 unset($params['modified_date']);
280 // check required params
281 if (!self
::dataExists($params)) {
282 throw new CRM_Core_Exception('Not enough data to create activity object');
285 $activity = new CRM_Activity_DAO_Activity();
287 if (isset($params['id']) && empty($params['id'])) {
288 unset($params['id']);
291 if (empty($params['status_id']) && empty($params['activity_status_id']) && empty($params['id'])) {
292 if (isset($params['activity_date_time']) &&
293 strcmp($params['activity_date_time'], CRM_Utils_Date
::processDate(date('Ymd')) == -1)
295 $params['status_id'] = CRM_Core_PseudoConstant
::getKey('CRM_Activity_BAO_Activity', 'status_id', 'Completed');
298 $params['status_id'] = CRM_Core_PseudoConstant
::getKey('CRM_Activity_BAO_Activity', 'status_id', 'Scheduled');
302 // Set priority to Normal for Auto-populated activities (for Cases)
303 if (!isset($params['priority_id']) &&
304 // if not set and not 0
307 $priority = CRM_Core_PseudoConstant
::get('CRM_Activity_DAO_Activity', 'priority_id');
308 $params['priority_id'] = array_search('Normal', $priority);
311 if (!empty($params['target_contact_id']) && is_array($params['target_contact_id'])) {
312 $params['target_contact_id'] = array_unique($params['target_contact_id']);
314 if (!empty($params['assignee_contact_id']) && is_array($params['assignee_contact_id'])) {
315 $params['assignee_contact_id'] = array_unique($params['assignee_contact_id']);
319 if (!empty($params['id'])) {
320 CRM_Utils_Hook
::pre('edit', 'Activity', $params['id'], $params);
323 CRM_Utils_Hook
::pre('create', 'Activity', NULL, $params);
326 $activity->copyValues($params);
327 if (isset($params['case_id'])) {
328 // CRM-8708, preserve case ID even though it's not part of the SQL model
329 $activity->case_id
= $params['case_id'];
331 elseif (is_numeric($activity->id
)) {
332 // CRM-8708, preserve case ID even though it's not part of the SQL model
333 $activity->case_id
= CRM_Case_BAO_Case
::getCaseIdByActivityId($activity->id
);
337 $transaction = new CRM_Core_Transaction();
339 $result = $activity->save();
341 if (is_a($result, 'CRM_Core_Error')) {
342 $transaction->rollback();
346 $activityId = $activity->id
;
347 $sourceID = CRM_Core_PseudoConstant
::getKey('CRM_Activity_BAO_ActivityContact', 'record_type_id', 'Activity Source');
348 $assigneeID = CRM_Core_PseudoConstant
::getKey('CRM_Activity_BAO_ActivityContact', 'record_type_id', 'Activity Assignees');
349 $targetID = CRM_Core_PseudoConstant
::getKey('CRM_Activity_BAO_ActivityContact', 'record_type_id', 'Activity Targets');
351 if (isset($params['source_contact_id'])) {
353 'activity_id' => $activityId,
354 'contact_id' => $params['source_contact_id'],
355 'record_type_id' => $sourceID,
357 self
::deleteActivityContact($activityId, $sourceID);
358 CRM_Activity_BAO_ActivityContact
::create($acParams);
361 // check and attach and files as needed
362 CRM_Core_BAO_File
::processAttachment($params, 'civicrm_activity', $activityId);
364 // attempt to save activity assignment
365 $resultAssignment = NULL;
366 if (!empty($params['assignee_contact_id'])) {
368 $assignmentParams = ['activity_id' => $activityId];
370 if (is_array($params['assignee_contact_id'])) {
371 if (CRM_Utils_Array
::value('deleteActivityAssignment', $params, TRUE)) {
372 // first delete existing assignments if any
373 self
::deleteActivityContact($activityId, $assigneeID);
376 foreach ($params['assignee_contact_id'] as $acID) {
379 'activity_id' => $activityId,
380 'contact_id' => $acID,
381 'record_type_id' => $assigneeID,
383 CRM_Activity_BAO_ActivityContact
::create($assigneeParams);
388 $assignmentParams['contact_id'] = $params['assignee_contact_id'];
389 $assignmentParams['record_type_id'] = $assigneeID;
390 if (!empty($params['id'])) {
391 $assignment = new CRM_Activity_BAO_ActivityContact();
392 $assignment->activity_id
= $activityId;
393 $assignment->record_type_id
= $assigneeID;
394 $assignment->find(TRUE);
396 if ($assignment->contact_id
!= $params['assignee_contact_id']) {
397 $assignmentParams['id'] = $assignment->id
;
398 $resultAssignment = CRM_Activity_BAO_ActivityContact
::create($assignmentParams);
402 $resultAssignment = CRM_Activity_BAO_ActivityContact
::create($assignmentParams);
407 if (CRM_Utils_Array
::value('deleteActivityAssignment', $params, TRUE)) {
408 self
::deleteActivityContact($activityId, $assigneeID);
412 if (is_a($resultAssignment, 'CRM_Core_Error')) {
413 $transaction->rollback();
414 return $resultAssignment;
417 // attempt to save activity targets
418 $resultTarget = NULL;
419 if (!empty($params['target_contact_id'])) {
421 $targetParams = ['activity_id' => $activityId];
423 if (is_array($params['target_contact_id'])) {
424 if (CRM_Utils_Array
::value('deleteActivityTarget', $params, TRUE)) {
425 // first delete existing targets if any
426 self
::deleteActivityContact($activityId, $targetID);
429 foreach ($params['target_contact_id'] as $tid) {
431 $targetContactParams = [
432 'activity_id' => $activityId,
433 'contact_id' => $tid,
434 'record_type_id' => $targetID,
436 CRM_Activity_BAO_ActivityContact
::create($targetContactParams);
441 $targetParams['contact_id'] = $params['target_contact_id'];
442 $targetParams['record_type_id'] = $targetID;
443 if (!empty($params['id'])) {
444 $target = new CRM_Activity_BAO_ActivityContact();
445 $target->activity_id
= $activityId;
446 $target->record_type_id
= $targetID;
449 if ($target->contact_id
!= $params['target_contact_id']) {
450 $targetParams['id'] = $target->id
;
451 $resultTarget = CRM_Activity_BAO_ActivityContact
::create($targetParams);
455 $resultTarget = CRM_Activity_BAO_ActivityContact
::create($targetParams);
460 if (CRM_Utils_Array
::value('deleteActivityTarget', $params, TRUE)) {
461 self
::deleteActivityContact($activityId, $targetID);
465 // write to changelog before transaction is committed/rolled
466 // back (and prepare status to display)
467 if (!empty($params['id'])) {
468 $logMsg = "Activity (id: {$result->id} ) updated with ";
471 $logMsg = "Activity created for ";
475 if (isset($params['source_contact_id'])) {
476 $msgs[] = "source={$params['source_contact_id']}";
479 if (!empty($params['target_contact_id'])) {
480 if (is_array($params['target_contact_id']) && !CRM_Utils_Array
::crmIsEmptyArray($params['target_contact_id'])) {
481 $msgs[] = "target=" . implode(',', $params['target_contact_id']);
482 // take only first target
483 // will be used for recently viewed display
484 $t = array_slice($params['target_contact_id'], 0, 1);
485 $recentContactId = $t[0];
487 // Is array check fixes warning without degrading functionality but it seems this bit of code may no longer work
488 // as it may always be an array
489 elseif (isset($params['target_contact_id']) && !is_array($params['target_contact_id'])) {
490 $msgs[] = "target={$params['target_contact_id']}";
491 // will be used for recently viewed display
492 $recentContactId = $params['target_contact_id'];
496 // at worst, take source for recently viewed display
497 $recentContactId = $params['source_contact_id'] ??
NULL;
500 if (isset($params['assignee_contact_id'])) {
501 if (is_array($params['assignee_contact_id'])) {
502 $msgs[] = "assignee=" . implode(',', $params['assignee_contact_id']);
505 $msgs[] = "assignee={$params['assignee_contact_id']}";
508 $logMsg .= implode(', ', $msgs);
510 self
::logActivityAction($result, $logMsg);
512 if (!empty($params['custom']) &&
513 is_array($params['custom'])
515 CRM_Core_BAO_CustomValueTable
::store($params['custom'], 'civicrm_activity', $result->id
);
518 $transaction->commit();
519 if (empty($params['skipRecentView'])) {
521 if (!empty($params['case_id'])) {
522 $caseContactID = CRM_Core_DAO
::getFieldValue('CRM_Case_DAO_CaseContact', $params['case_id'], 'contact_id', 'case_id');
523 $url = CRM_Utils_System
::url('civicrm/case/activity/view',
524 "reset=1&aid={$activity->id}&cid={$caseContactID}&caseID={$params['case_id']}&context=home"
528 $q = "action=view&reset=1&id={$activity->id}&atype={$activity->activity_type_id}&cid=" . CRM_Utils_Array
::value('source_contact_id', $params) . "&context=home";
529 if ($activity->activity_type_id
!= CRM_Core_PseudoConstant
::getKey('CRM_Activity_BAO_Activity', 'activity_type_id', 'Email')) {
530 $url = CRM_Utils_System
::url('civicrm/activity', $q);
531 if ($activity->activity_type_id
== CRM_Core_PseudoConstant
::getKey('CRM_Activity_BAO_Activity', 'activity_type_id', 'Print PDF Letter')) {
532 $recentOther['editUrl'] = CRM_Utils_System
::url('civicrm/activity/pdf/add',
533 "action=update&reset=1&id={$activity->id}&atype={$activity->activity_type_id}&cid={$params['source_contact_id']}&context=home"
537 $recentOther['editUrl'] = CRM_Utils_System
::url('civicrm/activity/add',
538 "action=update&reset=1&id={$activity->id}&atype={$activity->activity_type_id}&cid=" . CRM_Utils_Array
::value('source_contact_id', $params) . "&context=home"
542 if (CRM_Core_Permission
::check("delete activities")) {
543 $recentOther['deleteUrl'] = CRM_Utils_System
::url('civicrm/activity',
544 "action=delete&reset=1&id={$activity->id}&atype={$activity->activity_type_id}&cid=" . CRM_Utils_Array
::value('source_contact_id', $params) . "&context=home"
549 $url = CRM_Utils_System
::url('civicrm/activity/view', $q);
550 if (CRM_Core_Permission
::check('delete activities')) {
551 $recentOther['deleteUrl'] = CRM_Utils_System
::url('civicrm/activity',
552 "action=delete&reset=1&id={$activity->id}&atype={$activity->activity_type_id}&cid=" . CRM_Utils_Array
::value('source_contact_id', $params) . "&context=home"
558 if (!isset($activity->parent_id
)) {
559 $recentContactDisplay = CRM_Contact_BAO_Contact
::displayName($recentContactId);
560 // add the recently created Activity
561 $activityTypes = CRM_Activity_BAO_Activity
::buildOptions('activity_type_id');
562 $activitySubject = CRM_Core_DAO
::getFieldValue('CRM_Activity_DAO_Activity', $activity->id
, 'subject');
565 if (isset($activitySubject)) {
566 $title = $activitySubject . ' - ';
569 $title = $title . $recentContactDisplay;
570 if (!empty($activityTypes[$activity->activity_type_id
])) {
571 $title .= ' (' . $activityTypes[$activity->activity_type_id
] . ')';
574 CRM_Utils_Recent
::add($title,
579 $recentContactDisplay,
585 CRM_Contact_BAO_GroupContactCache
::opportunisticCacheFlush();
587 // if the subject contains a ‘[case #…]’ string, file that activity on the related case (CRM-5916)
589 $subjectToMatch = $params['subject'] ??
NULL;
590 if (preg_match('/\[case #([0-9a-h]{7})\]/', $subjectToMatch, $matches)) {
591 $key = CRM_Core_DAO
::escapeString(CIVICRM_SITE_KEY
);
593 $query = "SELECT id FROM civicrm_case WHERE SUBSTR(SHA1(CONCAT('$key', id)), 1, 7) = '" . CRM_Core_DAO
::escapeString($hash) . "'";
595 elseif (preg_match('/\[case #(\d+)\]/', $subjectToMatch, $matches)) {
596 $query = "SELECT id FROM civicrm_case WHERE id = '" . CRM_Core_DAO
::escapeString($matches[1]) . "'";
598 if (!empty($matches)) {
600 'activity_id' => $activity->id
,
601 'case_id' => CRM_Core_DAO
::singleValueQuery($query),
603 if ($caseParams['case_id']) {
604 CRM_Case_BAO_Case
::processCaseActivity($caseParams);
607 self
::logActivityAction($activity, "Case details for {$matches[1]} not found while recording an activity on case.");
610 if (!empty($params['id'])) {
611 CRM_Utils_Hook
::post('edit', 'Activity', $activity->id
, $activity);
614 CRM_Utils_Hook
::post('create', 'Activity', $activity->id
, $activity);
621 * Create an activity.
623 * @todo elaborate on what this does.
625 * @param CRM_Activity_DAO_Activity $activity
626 * @param string $logMessage
630 public static function logActivityAction($activity, $logMessage = NULL) {
631 $id = CRM_Core_Session
::getLoggedInContactID();
633 $activityContacts = CRM_Activity_BAO_ActivityContact
::buildOptions('record_type_id', 'validate');
634 $sourceID = CRM_Utils_Array
::key('Activity Source', $activityContacts);
635 $id = self
::getActivityContact($activity->id
, $sourceID);
638 'entity_table' => 'civicrm_activity',
639 'entity_id' => $activity->id
,
640 'modified_id' => $id,
641 'modified_date' => date('YmdHis'),
642 'data' => $logMessage,
644 CRM_Core_BAO_Log
::add($logParams);
649 * Get the list Activities.
651 * @param array $params
652 * Array of parameters.
654 * - contact_id int contact_id whose activities we want to retrieve
655 * - offset int which row to start from ?
656 * - rowCount int how many rows to fetch
657 * - sort object|array object or array describing sort order for sql query.
658 * - admin boolean if contact is admin
659 * - caseId int case ID
660 * - context string page on which selector is build
661 * - activity_type_id int|string the activitiy types we want to restrict by
664 * Relevant data object values of open activities
665 * @throws \CiviCRM_API3_Exception
667 public static function getActivities($params) {
670 // Activity.Get API params
671 $activityParams = self
::getActivityParamsForDashboardFunctions($params);
673 if (!empty($params['rowCount']) &&
674 $params['rowCount'] > 0
676 $activityParams['options']['limit'] = $params['rowCount'];
679 if (!empty($params['sort'])) {
680 if (is_a($params['sort'], 'CRM_Utils_Sort')) {
681 $order = $params['sort']->orderBy();
683 elseif (trim($params['sort'])) {
684 $order = CRM_Utils_Type
::escape($params['sort'], 'String');
688 $activityParams['options']['sort'] = empty($order) ?
"activity_date_time DESC" : str_replace('activity_type ', 'activity_type_id.label ', $order);
690 $activityParams['return'] = [
691 'activity_date_time',
694 'source_contact_name',
695 'assignee_contact_id',
696 'assignee_contact_name',
704 // Q. What does the code below achieve? case_id and campaign_id are already
705 // in the array, defined above, and this code adds them in again if their
706 // component is enabled? @fixme remove case_id and campaign_id from the array above?
707 foreach (['case_id' => 'CiviCase', 'campaign_id' => 'CiviCampaign'] as $attr => $component) {
708 if (in_array($component, self
::activityComponents())) {
709 $activityParams['return'][] = $attr;
712 $result = civicrm_api3('Activity', 'Get', $activityParams)['values'];
714 $bulkActivityTypeID = CRM_Core_PseudoConstant
::getKey('CRM_Activity_BAO_Activity', 'activity_type_id', 'Bulk Email');
715 $allCampaigns = CRM_Campaign_BAO_Campaign
::getCampaigns(NULL, NULL, FALSE, FALSE, FALSE, TRUE);
717 // CRM-3553, need to check user has access to target groups.
718 $mailingIDs = CRM_Mailing_BAO_Mailing
::mailingACLIDs();
719 $accessCiviMail = ((CRM_Core_Permission
::check('access CiviMail')) ||
720 (CRM_Mailing_Info
::workflowEnabled() && CRM_Core_Permission
::check('create mailings'))
723 // @todo - get rid of this & just handle in the array declaration like we do with 'subject' etc.
725 'source_record_id' => 'source_record_id',
726 'activity_type_id' => 'activity_type_id',
727 'status_id' => 'status_id',
728 'campaign_id' => 'campaign_id',
729 'case_id' => 'case_id',
732 if (empty($result)) {
736 $targetCount = CRM_Core_DAO
::executeQuery('
737 SELECT activity_id, count(*) as target_contact_count
738 FROM civicrm_activity_contact
739 INNER JOIN civicrm_contact c ON contact_id = c.id AND c.is_deleted = 0
740 WHERE activity_id IN (' . implode(',', array_keys($result)) . ')
741 AND record_type_id = %1
742 GROUP BY activity_id', [
744 CRM_Core_PseudoConstant
::getKey('CRM_Activity_BAO_ActivityContact', 'record_type_id', 'Activity Targets'),
749 foreach ($targetCount as $activityTarget) {
750 $result[$activityTarget['activity_id']]['target_contact_count'] = $activityTarget['target_contact_count'];
752 // Iterate through & do basic mappings & determine which ones we want to retrieve target count for.
753 foreach ($result as $id => $activity) {
755 'activity_id' => $activity['id'],
756 'activity_date_time' => $activity['activity_date_time'] ??
NULL,
757 'subject' => $activity['subject'] ??
NULL,
758 'assignee_contact_name' => $activity['assignee_contact_sort_name'] ??
[],
759 'source_contact_id' => $activity['source_contact_id'] ??
NULL,
760 'source_contact_name' => $activity['source_contact_sort_name'] ??
NULL,
762 $activities[$id]['activity_type_name'] = CRM_Core_PseudoConstant
::getName('CRM_Activity_BAO_Activity', 'activity_type_id', $activity['activity_type_id']);
763 $activities[$id]['activity_type'] = CRM_Core_PseudoConstant
::getLabel('CRM_Activity_BAO_Activity', 'activity_type_id', $activity['activity_type_id']);
764 $activities[$id]['target_contact_count'] = $activity['target_contact_count'] ??
0;
765 if (!empty($activity['target_contact_count'])) {
766 $displayedTarget = civicrm_api3('ActivityContact', 'get', [
767 'activity_id' => $id,
768 'check_permissions' => TRUE,
769 'options' => ['limit' => 1],
770 'record_type_id' => 'Activity Targets',
771 'return' => ['contact_id.sort_name', 'contact_id'],
774 if (empty($displayedTarget[0])) {
775 $activities[$id]['target_contact_name'] = [];
778 $activities[$id]['target_contact_name'] = [$displayedTarget[0]['contact_id'] => $displayedTarget[0]['contact_id.sort_name']];
781 if ($activities[$id]['activity_type_name'] === 'Bulk Email') {
782 $bulkActivities[] = $id;
783 // Get the total without permissions being passed but only display names after permissioning.
784 $activities[$id]['recipients'] = ts('(%1 recipients)', [1 => $activities[$id]['target_contact_count']]);
788 // Eventually this second iteration should just handle the target contacts. It's a bit muddled at
789 // the moment as the bulk activity stuff needs unravelling & test coverage.
791 foreach ($result as $id => $activity) {
792 $isBulkActivity = (!$bulkActivityTypeID ||
($bulkActivityTypeID === $activity['activity_type_id']));
793 foreach ($mappingParams as $apiKey => $expectedName) {
794 if (in_array($apiKey, [
795 'target_contact_name',
798 if ($isBulkActivity) {
799 // @todo - how is this used? Couldn't we use 'is_bulk' or something clearer?
800 // or the calling function could handle
801 $activities[$id]['mailingId'] = FALSE;
802 if ($accessCiviMail &&
803 ($mailingIDs === TRUE ||
in_array($activity['source_record_id'], $mailingIDs))
805 $activities[$id]['mailingId'] = TRUE;
809 // case related fields
810 elseif ($apiKey == 'case_id' && !$isBulkActivity) {
811 $activities[$id][$expectedName] = $activity[$apiKey] ??
NULL;
813 // fetch case subject for case ID found
814 if (!empty($activity['case_id'])) {
815 // Store cases; we'll look them up in one query below. We convert
816 // to int here so we can trust it for SQL.
817 $caseIds[$id] = (int) current($activity['case_id']);
821 // @todo this generic assign could just be handled in array declaration earlier.
822 $activities[$id][$expectedName] = $activity[$apiKey] ??
NULL;
823 if ($apiKey == 'campaign_id') {
824 $activities[$id]['campaign'] = $allCampaigns[$activities[$id][$expectedName]] ??
NULL;
828 // if deleted, wrap in <del>
829 if (!empty($activity['source_contact_id']) &&
830 CRM_Core_DAO
::getFieldValue('CRM_Contact_DAO_Contact', $activity['source_contact_id'], 'is_deleted')
832 $activities[$id]['source_contact_name'] = sprintf("<del>%s<del>", $activity['source_contact_name']);
834 $activities[$id]['is_recurring_activity'] = CRM_Core_BAO_RecurringEntity
::getParentFor($id, 'civicrm_activity');
837 // Look up any case subjects we need in a single query and add them in the relevant activities under 'case_subject'
839 $subjects = CRM_Core_DAO
::executeQuery('SELECT id, subject FROM civicrm_case WHERE id IN (' . implode(',', array_unique($caseIds)) . ')')
840 ->fetchMap('id', 'subject');
841 foreach ($caseIds as $activityId => $caseId) {
842 $result[$activityId]['case_subject'] = $subjects[$caseId];
850 * Filter the activity types to only return the ones we actually asked for
851 * Uses params['activity_type_id'] and params['activity_type_exclude_id']
854 * @return array|null (Use in Activity.get API activity_type_id)
856 public static function filterActivityTypes($params) {
859 // If no activity types are specified, get all the active ones
860 if (empty($params['activity_type_id'])) {
861 $activityTypes = CRM_Activity_BAO_Activity
::buildOptions('activity_type_id', 'get');
864 // If no activity types are specified or excluded, return the list of all active ones
865 if (empty($params['activity_type_id']) && empty($params['activity_type_exclude_id'])) {
866 if (!empty($activityTypes)) {
867 return ['IN' => array_keys($activityTypes)];
872 // If we have specified activity types, build a list to return, excluding the ones we don't want.
873 if (!empty($params['activity_type_id'])) {
874 if (!is_array($params['activity_type_id'])) {
875 // Turn it into array if only one specified, so we don't duplicate processing below
876 $params['activity_type_id'] = [$params['activity_type_id'] => $params['activity_type_id']];
878 foreach ($params['activity_type_id'] as $value) {
879 // Add each activity type that was specified to list
880 $value = CRM_Utils_Type
::escape($value, 'Positive');
881 $activityTypes[$value] = $value;
885 // Build the list of activity types to exclude (from $params['activity_type_exclude_id'])
886 if (!empty($params['activity_type_exclude_id'])) {
887 if (!is_array($params['activity_type_exclude_id'])) {
888 // Turn it into array if only one specified, so we don't duplicate processing below
889 $params['activity_type_exclude_id'] = [$params['activity_type_exclude_id'] => $params['activity_type_exclude_id']];
891 foreach ($params['activity_type_exclude_id'] as $value) {
892 // Remove each activity type from list if it should be excluded
893 $value = CRM_Utils_Type
::escape($value, 'Positive');
894 if (array_key_exists($value, $activityTypes)) {
895 unset($activityTypes[$value]);
900 return ['IN' => array_keys($activityTypes)];
906 public function addSelectWhereClause() {
908 $permittedActivityTypeIDs = self
::getPermittedActivityTypes();
909 $allActivityTypes = self
::buildOptions('activity_type_id');
910 if (empty($permittedActivityTypeIDs)) {
911 // This just prevents a mysql fail if they have no access - should be extremely edge case.
912 $permittedActivityTypeIDs = [0];
914 if (array_keys($allActivityTypes) !== array_keys($permittedActivityTypeIDs)) {
915 $clauses['activity_type_id'] = ('IN (' . implode(', ', $permittedActivityTypeIDs) . ')');
918 $contactClause = CRM_Utils_SQL
::mergeSubquery('Contact');
919 if ($contactClause) {
920 $contactClause = implode(' AND contact_id ', $contactClause);
921 $clauses['id'][] = "IN (SELECT activity_id FROM civicrm_activity_contact WHERE contact_id $contactClause)";
923 CRM_Utils_Hook
::selectWhereClause($this, $clauses);
928 * Get an array of components that are accessible by the currenct user.
930 * This means checking if they are enabled and if the user has appropriate permission.
932 * For most components the permission is access component (e.g 'access CiviContribute').
933 * Exceptions as CiviCampaign (administer CiviCampaign) and CiviCase
934 * (accesses a case function which enforces edit all cases or edit my cases. Case
935 * permissions are also handled on a per activity basis).
937 * Checks whether logged in user has permission to the component.
939 * @param bool $excludeComponentHandledActivities
940 * Should we exclude components whose display is handled in the components.
941 * In practice this means should we include CiviCase in the results. Presumbaly
942 * at the time it was decided case activities should be shown in the case framework and
943 * that this concept might be extended later. In practice most places that
944 * call this then re-add CiviCase in some way so it's all a bit... odd.
947 * Array of component id and name.
949 public static function activityComponents($excludeComponentHandledActivities = TRUE) {
951 $compInfo = CRM_Core_Component
::getEnabledComponents();
952 foreach ($compInfo as $compObj) {
953 $includeComponent = !$excludeComponentHandledActivities ||
!empty($compObj->info
['showActivitiesInCore']);
954 if ($includeComponent) {
955 if ($compObj->info
['name'] == 'CiviCampaign') {
956 $componentPermission = "administer {$compObj->name}";
959 $componentPermission = "access {$compObj->name}";
961 if ($compObj->info
['name'] == 'CiviCase') {
962 if (CRM_Case_BAO_Case
::accessCiviCase()) {
963 $components[$compObj->componentID
] = $compObj->info
['name'];
966 elseif (CRM_Core_Permission
::check($componentPermission)) {
967 $components[$compObj->componentID
] = $compObj->info
['name'];
976 * Get the activity Count.
978 * @param array $input
979 * Array of parameters.
981 * - contact_id int contact_id whose activities we want to retrieve
982 * - admin boolean if contact is admin
983 * - caseId int case ID
984 * - context string page on which selector is build
985 * - activity_type_id int|string the activity types we want to restrict by
988 * count of activities
990 public static function getActivitiesCount($input) {
991 $activityParams = self
::getActivityParamsForDashboardFunctions($input);
992 return civicrm_api3('Activity', 'getcount', $activityParams);
996 * @param int $sourceContactID
997 * The contact ID of the email "from".
998 * @param string $subject
999 * @param string $html
1000 * @param string $text
1001 * @param string $additionalDetails
1002 * The additional information of CC and BCC appended to the activity details.
1003 * @param int $campaignID
1004 * @param array $attachments
1005 * @param int $caseID
1008 * The created activity ID
1009 * @throws \CRM_Core_Exception
1011 public static function createEmailActivity($sourceContactID, $subject, $html, $text, $additionalDetails, $campaignID, $attachments, $caseID) {
1012 $activityTypeID = CRM_Core_PseudoConstant
::getKey('CRM_Activity_BAO_Activity', 'activity_type_id', 'Email');
1014 // CRM-6265: save both text and HTML parts in details (if present)
1015 if ($html and $text) {
1016 $details = "-ALTERNATIVE ITEM 0-\n{$html}{$additionalDetails}\n-ALTERNATIVE ITEM 1-\n{$text}{$additionalDetails}\n-ALTERNATIVE END-\n";
1019 $details = $html ?
$html : $text;
1020 $details .= $additionalDetails;
1024 'source_contact_id' => $sourceContactID,
1025 'activity_type_id' => $activityTypeID,
1026 'activity_date_time' => date('YmdHis'),
1027 'subject' => $subject,
1028 'details' => $details,
1029 'status_id' => CRM_Core_PseudoConstant
::getKey('CRM_Activity_BAO_Activity', 'status_id', 'Completed'),
1030 'campaign_id' => $campaignID,
1032 if (!empty($caseID)) {
1033 $activityParams['case_id'] = $caseID;
1036 // CRM-5916: strip [case #…] before saving the activity (if present in subject)
1037 $activityParams['subject'] = preg_replace('/\[case #([0-9a-h]{7})\] /', '', $activityParams['subject']);
1039 // add the attachments to activity params here
1041 // first process them
1042 $activityParams = array_merge($activityParams, $attachments);
1045 $activity = civicrm_api3('Activity', 'create', $activityParams);
1047 return $activity['id'];
1051 * Send the message to all the contacts.
1053 * Also insert a contact activity in each contacts record.
1055 * @param array $contactDetails
1056 * The array of contact details to send the email.
1057 * @param string $subject
1058 * The subject of the message.
1061 * @param string $emailAddress
1062 * Use this 'to' email address instead of the default Primary address.
1063 * @param int $userID
1064 * Use this userID if set.
1065 * @param string $from
1066 * @param array $attachments
1067 * The array of attachments if any.
1070 * @param string $bcc
1072 * @param array $contactIds
1074 * @param string $additionalDetails
1075 * The additional information of CC and BCC appended to the activity Details.
1076 * @param array $contributionIds
1077 * @param int $campaignId
1078 * @param int $caseId
1081 * ( sent, activityId) if any email is sent and activityId
1082 * @throws \CRM_Core_Exception
1083 * @throws \CiviCRM_API3_Exception
1085 public static function sendEmail(
1093 $attachments = NULL,
1097 $additionalDetails = NULL,
1098 $contributionIds = NULL,
1102 // get the contact details of logged in contact, which we set as from email
1103 if ($userID == NULL) {
1104 $userID = CRM_Core_Session
::getLoggedInContactID();
1107 list($fromDisplayName, $fromEmail, $fromDoNotEmail) = CRM_Contact_BAO_Contact
::getContactDetails($userID);
1109 return [count($contactDetails), 0, count($contactDetails)];
1111 if (!trim($fromDisplayName)) {
1112 $fromDisplayName = $fromEmail;
1116 // token replacement of addressee/email/postal greetings
1117 // get the tokens added in subject and message
1118 $subjectToken = CRM_Utils_Token
::getTokens($subject);
1119 $messageToken = CRM_Utils_Token
::getTokens($text);
1120 $messageToken = array_merge($messageToken, CRM_Utils_Token
::getTokens($html));
1121 $allTokens = array_merge($messageToken, $subjectToken);
1124 $from = "$fromDisplayName <$fromEmail>";
1127 //create the meta level record first ( email activity )
1128 $activityID = self
::createEmailActivity($userID, $subject, $html, $text, $additionalDetails, $campaignId, $attachments, $caseId);
1130 $returnProperties = [];
1131 if (isset($messageToken['contact'])) {
1132 foreach ($messageToken['contact'] as $key => $value) {
1133 $returnProperties[$value] = 1;
1137 if (isset($subjectToken['contact'])) {
1138 foreach ($subjectToken['contact'] as $key => $value) {
1139 if (!isset($returnProperties[$value])) {
1140 $returnProperties[$value] = 1;
1145 // get token details for contacts, call only if tokens are used
1147 if (!empty($returnProperties) ||
!empty($tokens) ||
!empty($allTokens)) {
1148 list($details) = CRM_Utils_Token
::getTokenDetails(
1153 'CRM_Activity_BAO_Activity'
1159 CRM_Utils_Hook
::tokens($tokens);
1160 $categories = array_keys($tokens);
1162 $escapeSmarty = FALSE;
1163 if (defined('CIVICRM_MAIL_SMARTY') && CIVICRM_MAIL_SMARTY
) {
1164 $smarty = CRM_Core_Smarty
::singleton();
1165 $escapeSmarty = TRUE;
1168 $contributionDetails = [];
1169 if (!empty($contributionIds)) {
1170 $contributionDetails = CRM_Contribute_BAO_Contribution
::replaceContributionTokens(
1181 $sent = $notSent = [];
1182 foreach ($contactDetails as $values) {
1183 $contactId = $values['contact_id'];
1184 $emailAddress = $values['email'];
1186 if (!empty($contributionDetails)) {
1187 $subject = $contributionDetails[$contactId]['subject'];
1188 $text = $contributionDetails[$contactId]['text'];
1189 $html = $contributionDetails[$contactId]['html'];
1192 if (!empty($details) && is_array($details["{$contactId}"])) {
1193 // unset email from details since it always returns primary email address
1194 unset($details["{$contactId}"]['email']);
1195 unset($details["{$contactId}"]['email_id']);
1196 $values = array_merge($values, $details["{$contactId}"]);
1199 $tokenSubject = CRM_Utils_Token
::replaceContactTokens($subject, $values, FALSE, $subjectToken, FALSE, $escapeSmarty);
1200 $tokenSubject = CRM_Utils_Token
::replaceHookTokens($tokenSubject, $values, $categories, FALSE, $escapeSmarty);
1203 if ($values['preferred_mail_format'] == 'Text' ||
$values['preferred_mail_format'] == 'Both') {
1204 $tokenText = CRM_Utils_Token
::replaceContactTokens($text, $values, FALSE, $messageToken, FALSE, $escapeSmarty);
1205 $tokenText = CRM_Utils_Token
::replaceHookTokens($tokenText, $values, $categories, FALSE, $escapeSmarty);
1211 if ($values['preferred_mail_format'] == 'HTML' ||
$values['preferred_mail_format'] == 'Both') {
1212 $tokenHtml = CRM_Utils_Token
::replaceContactTokens($html, $values, TRUE, $messageToken, FALSE, $escapeSmarty);
1213 $tokenHtml = CRM_Utils_Token
::replaceHookTokens($tokenHtml, $values, $categories, TRUE, $escapeSmarty);
1220 $tokenSubject = CRM_Utils_Token
::replaceCaseTokens($caseId, $tokenSubject, $subjectToken, $escapeSmarty);
1221 $tokenText = CRM_Utils_Token
::replaceCaseTokens($caseId, $tokenText, $messageToken, $escapeSmarty);
1222 $tokenHtml = CRM_Utils_Token
::replaceCaseTokens($caseId, $tokenHtml, $messageToken, $escapeSmarty);
1225 if (defined('CIVICRM_MAIL_SMARTY') && CIVICRM_MAIL_SMARTY
) {
1226 // also add the contact tokens to the template
1227 $smarty->assign_by_ref('contact', $values);
1229 $tokenSubject = $smarty->fetch("string:$tokenSubject");
1230 $tokenText = $smarty->fetch("string:$tokenText");
1231 $tokenHtml = $smarty->fetch("string:$tokenHtml");
1235 if (self
::sendMessage(
1244 // get the set of attachments from where they are stored
1245 CRM_Core_BAO_File
::getEntityFile('civicrm_activity', $activityID),
1254 return [$sent, $activityID];
1258 * Send SMS. Returns: bool $sent, int $activityId, int $success (number of sent SMS)
1260 * @param array $contactDetails
1261 * @param array $activityParams
1262 * @param array $smsProviderParams
1263 * @param array $contactIds
1264 * @param int $sourceContactId This is the source contact Id
1266 * @return array(bool $sent, int $activityId, int $success)
1267 * @throws CRM_Core_Exception
1269 public static function sendSMS(
1270 &$contactDetails = NULL,
1272 &$smsProviderParams = [],
1273 &$contactIds = NULL,
1274 $sourceContactId = NULL
1276 if (!CRM_Core_Permission
::check('send SMS')) {
1277 throw new CRM_Core_Exception("You do not have the 'send SMS' permission");
1280 if (!isset($contactDetails) && !isset($contactIds)) {
1281 throw new CRM_Core_Exception('You must specify either $contactDetails or $contactIds');
1283 // Populate $contactDetails and $contactIds if only one is set
1284 if (is_array($contactIds) && !empty($contactIds) && empty($contactDetails)) {
1285 foreach ($contactIds as $id) {
1287 $contactDetails[] = civicrm_api3('Contact', 'getsingle', ['contact_id' => $id]);
1289 catch (Exception
$e) {
1290 // Contact Id doesn't exist
1294 elseif (is_array($contactDetails) && !empty($contactDetails) && empty($contactIds)) {
1295 foreach ($contactDetails as $contact) {
1296 $contactIds[] = $contact['contact_id'];
1300 // Get logged in User Id
1301 if (empty($sourceContactId)) {
1302 $sourceContactId = CRM_Core_Session
::getLoggedInContactID();
1305 $text = &$activityParams['sms_text_message'];
1307 // Create the meta level record first ( sms activity )
1309 'source_contact_id' => $sourceContactId,
1310 'activity_type_id' => CRM_Core_PseudoConstant
::getKey('CRM_Activity_BAO_Activity', 'activity_type_id', 'SMS'),
1311 'activity_date_time' => date('YmdHis'),
1312 'subject' => $activityParams['activity_subject'],
1314 'status_id' => CRM_Core_PseudoConstant
::getKey('CRM_Activity_BAO_Activity', 'status_id', 'Completed'),
1316 $activity = self
::create($activityParams);
1317 $activityID = $activity->id
;
1320 // token replacement of addressee/email/postal greetings
1321 // get the tokens added in subject and message
1322 $messageToken = CRM_Utils_Token
::getTokens($text);
1323 $returnProperties = [];
1324 if (isset($messageToken['contact'])) {
1325 foreach ($messageToken['contact'] as $key => $value) {
1326 $returnProperties[$value] = 1;
1331 CRM_Utils_Hook
::tokens($tokens);
1332 $categories = array_keys($tokens);
1333 // get token details for contacts, call only if tokens are used
1335 if (!empty($returnProperties) ||
!empty($tokens)) {
1336 list($tokenDetails) = CRM_Utils_Token
::getTokenDetails($contactIds,
1340 'CRM_Activity_BAO_Activity'
1346 foreach ($contactDetails as $contact) {
1347 $contactId = $contact['contact_id'];
1350 if (!empty($tokenDetails) && is_array($tokenDetails["{$contactId}"])) {
1351 // unset phone from details since it always returns primary number
1352 unset($tokenDetails["{$contactId}"]['phone']);
1353 unset($tokenDetails["{$contactId}"]['phone_type_id']);
1354 $contact = array_merge($contact, $tokenDetails["{$contactId}"]);
1356 $tokenText = CRM_Utils_Token
::replaceContactTokens($text, $contact, FALSE, $messageToken, FALSE, FALSE);
1357 $tokenText = CRM_Utils_Token
::replaceHookTokens($tokenText, $contact, $categories, FALSE, FALSE);
1359 // Only send if the phone is of type mobile
1360 if ($contact['phone_type_id'] == CRM_Core_PseudoConstant
::getKey('CRM_Core_BAO_Phone', 'phone_type_id', 'Mobile')) {
1361 $smsProviderParams['To'] = $contact['phone'];
1364 $smsProviderParams['To'] = '';
1367 $doNotSms = $contact['do_not_sms'] ??
0;
1370 $errMsgs[] = PEAR
::raiseError('Contact Does not accept SMS', NULL, PEAR_ERROR_RETURN
);
1374 $sendResult = self
::sendSMSMessage(
1383 catch (CRM_Core_Exception
$e) {
1384 $errMsgs[] = $e->getMessage();
1389 // If at least one message was sent and no errors
1390 // were generated then return a boolean value of TRUE.
1391 // Otherwise, return FALSE (no messages sent) or
1392 // and array of 1 or more PEAR_Error objects.
1394 if ($success > 0 && count($errMsgs) == 0) {
1397 elseif (count($errMsgs) > 0) {
1401 return [$sent, $activity->id
, $success];
1405 * Send the sms message to a specific contact.
1408 * The contact id of the recipient.
1410 * @param array $smsProviderParams
1411 * The params used for sending sms.
1412 * @param int $activityID
1413 * The activity ID that tracks the message.
1414 * @param int $sourceContactID
1416 * @return bool true on success
1417 * @throws CRM_Core_Exception
1419 public static function sendSMSMessage(
1422 $smsProviderParams = [],
1424 $sourceContactID = NULL
1426 $toPhoneNumber = NULL;
1427 if ($smsProviderParams['To']) {
1428 // If phone number is specified use it
1429 $toPhoneNumber = trim($smsProviderParams['To']);
1432 // No phone number specified, so find a suitable one for the contact
1433 $filters = ['is_deceased' => 0, 'is_deleted' => 0, 'do_not_sms' => 0];
1434 $toPhoneNumbers = CRM_Core_BAO_Phone
::allPhones($toID, FALSE, 'Mobile', $filters);
1435 // To get primary mobile phonenumber, if not get the first mobile phonenumber
1436 if (!empty($toPhoneNumbers)) {
1437 $toPhoneNumberDetails = reset($toPhoneNumbers);
1438 $toPhoneNumber = $toPhoneNumberDetails['phone'] ??
NULL;
1439 // Contact allows to send sms
1443 // make sure both phone are valid
1444 // and that the recipient wants to receive sms
1445 if (empty($toPhoneNumber)) {
1446 throw new CRM_Core_Exception('Recipient phone number is invalid or recipient does not want to receive SMS');
1449 $recipient = $toPhoneNumber;
1450 $smsProviderParams['contact_id'] = $toID;
1451 $smsProviderParams['parent_activity_id'] = $activityID;
1453 $providerObj = CRM_SMS_Provider
::singleton(['provider_id' => $smsProviderParams['provider_id']]);
1454 $sendResult = $providerObj->send($recipient, $smsProviderParams, $tokenText, NULL, $sourceContactID);
1455 if (PEAR
::isError($sendResult)) {
1456 throw new CRM_Core_Exception($sendResult->getMessage());
1459 // add activity target record for every sms that is sent
1460 $targetID = CRM_Core_PseudoConstant
::getKey('CRM_Activity_BAO_ActivityContact', 'record_type_id', 'Activity Targets');
1461 $activityTargetParams = [
1462 'activity_id' => $activityID,
1463 'contact_id' => $toID,
1464 'record_type_id' => $targetID,
1466 CRM_Activity_BAO_ActivityContact
::create($activityTargetParams);
1472 * Send the message to a specific contact.
1474 * @param string $from
1475 * The name and email of the sender.
1476 * @param int $fromID
1478 * The contact id of the recipient.
1479 * @param string $subject
1480 * The subject of the message.
1481 * @param $text_message
1482 * @param $html_message
1483 * @param string $emailAddress
1484 * Use this 'to' email address instead of the default Primary address.
1485 * @param int $activityID
1486 * The activity ID that tracks the message.
1487 * @param null $attachments
1492 * TRUE if successful else FALSE.
1494 public static function sendMessage(
1503 $attachments = NULL,
1507 list($toDisplayName, $toEmail, $toDoNotEmail) = CRM_Contact_BAO_Contact
::getContactDetails($toID);
1508 if ($emailAddress) {
1509 $toEmail = trim($emailAddress);
1512 // make sure both email addresses are valid
1513 // and that the recipient wants to receive email
1514 if (empty($toEmail) or $toDoNotEmail) {
1517 if (!trim($toDisplayName)) {
1518 $toDisplayName = $toEmail;
1521 $activityContacts = CRM_Activity_BAO_ActivityContact
::buildOptions('record_type_id', 'validate');
1522 $targetID = CRM_Utils_Array
::key('Activity Targets', $activityContacts);
1524 // create the params array
1526 'groupName' => 'Activity Email Sender',
1528 'toName' => $toDisplayName,
1529 'toEmail' => $toEmail,
1530 'subject' => $subject,
1533 'text' => $text_message,
1534 'html' => $html_message,
1535 'attachments' => $attachments,
1538 if (!CRM_Utils_Mail
::send($mailParams)) {
1542 // add activity target record for every mail that is send
1543 $activityTargetParams = [
1544 'activity_id' => $activityID,
1545 'contact_id' => $toID,
1546 'record_type_id' => $targetID,
1548 CRM_Activity_BAO_ActivityContact
::create($activityTargetParams);
1553 * Combine all the importable fields from the lower levels object.
1555 * The ordering is important, since currently we do not have a weight
1556 * scheme. Adding weight is super important and should be done in the
1557 * next week or so, before this can be called complete.
1559 * @param bool $status
1562 * array of importable Fields
1564 public static function &importableFields($status = FALSE) {
1565 if (!self
::$_importableFields) {
1566 if (!self
::$_importableFields) {
1567 self
::$_importableFields = [];
1570 $fields = ['' => ['title' => ts('- do not import -')]];
1573 $fields = ['' => ['title' => ts('- Activity Fields -')]];
1576 $tmpFields = CRM_Activity_DAO_Activity
::import();
1577 $contactFields = CRM_Contact_BAO_Contact
::importableFields('Individual', NULL);
1579 // Using new Dedupe rule.
1581 'contact_type' => 'Individual',
1582 'used' => 'Unsupervised',
1584 $fieldsArray = CRM_Dedupe_BAO_Rule
::dedupeRuleFields($ruleParams);
1586 $tmpConatctField = [];
1587 if (is_array($fieldsArray)) {
1588 foreach ($fieldsArray as $value) {
1589 $customFieldId = CRM_Core_DAO
::getFieldValue('CRM_Core_DAO_CustomField',
1594 $value = $customFieldId ?
'custom_' . $customFieldId : $value;
1595 $tmpConatctField[trim($value)] = $contactFields[trim($value)];
1596 $tmpConatctField[trim($value)]['title'] = $tmpConatctField[trim($value)]['title'] . " (match to contact)";
1599 $tmpConatctField['external_identifier'] = $contactFields['external_identifier'];
1600 $tmpConatctField['external_identifier']['title'] = $contactFields['external_identifier']['title'] . " (match to contact)";
1601 $fields = array_merge($fields, $tmpConatctField);
1602 $fields = array_merge($fields, $tmpFields);
1603 $fields = array_merge($fields, CRM_Core_BAO_CustomField
::getFieldsForImport('Activity'));
1604 self
::$_importableFields = $fields;
1606 return self
::$_importableFields;
1610 * @deprecated - use the api instead.
1612 * Get the Activities of a target contact.
1614 * @param int $contactId
1615 * Id of the contact whose activities need to find.
1618 * array of activity fields
1620 public static function getContactActivity($contactId) {
1621 // @todo remove this function entirely.
1623 $activityContacts = CRM_Activity_BAO_ActivityContact
::buildOptions('record_type_id', 'validate');
1624 $sourceID = CRM_Utils_Array
::key('Activity Source', $activityContacts);
1625 $assigneeID = CRM_Utils_Array
::key('Activity Assignees', $activityContacts);
1626 $targetID = CRM_Utils_Array
::key('Activity Targets', $activityContacts);
1628 // First look for activities where contactId is one of the targets
1630 SELECT activity_id, record_type_id
1631 FROM civicrm_activity_contact
1632 WHERE contact_id = $contactId
1634 $dao = CRM_Core_DAO
::executeQuery($query);
1635 while ($dao->fetch()) {
1636 if ($dao->record_type_id
== $targetID) {
1637 $activities[$dao->activity_id
]['targets'][$contactId] = $contactId;
1639 elseif ($dao->record_type_id
== $assigneeID) {
1640 $activities[$dao->activity_id
]['asignees'][$contactId] = $contactId;
1643 // do source stuff here
1644 $activities[$dao->activity_id
]['source_contact_id'] = $contactId;
1648 $activityIds = array_keys($activities);
1649 if (count($activityIds) < 1) {
1653 $activityIds = implode(',', $activityIds);
1655 SELECT activity.id as activity_id,
1657 subject, location, activity_date_time, details, status_id
1658 FROM civicrm_activity activity
1659 WHERE activity.id IN ($activityIds)";
1661 $dao = CRM_Core_DAO
::executeQuery($query);
1663 while ($dao->fetch()) {
1664 $activities[$dao->activity_id
]['id'] = $dao->activity_id
;
1665 $activities[$dao->activity_id
]['activity_type_id'] = $dao->activity_type_id
;
1666 $activities[$dao->activity_id
]['subject'] = $dao->subject
;
1667 $activities[$dao->activity_id
]['location'] = $dao->location
;
1668 $activities[$dao->activity_id
]['activity_date_time'] = $dao->activity_date_time
;
1669 $activities[$dao->activity_id
]['details'] = $dao->details
;
1670 $activities[$dao->activity_id
]['status_id'] = $dao->status_id
;
1671 $activities[$dao->activity_id
]['activity_name'] = CRM_Core_PseudoConstant
::getLabel('CRM_Activity_BAO_Activity', 'activity_type_id', $dao->activity_type_id
);
1672 $activities[$dao->activity_id
]['status'] = CRM_Core_PseudoConstant
::getLabel('CRM_Activity_BAO_Activity', 'activity_status_id', $dao->status_id
);
1674 // set to null if not set
1675 if (!isset($activities[$dao->activity_id
]['source_contact_id'])) {
1676 $activities[$dao->activity_id
]['source_contact_id'] = NULL;
1683 * Add activity for Membership/Event/Contribution.
1685 * @param object $activity
1686 * particular component object.
1687 * @param string $activityType
1688 * For Membership Signup or Renewal.
1689 * @param int $targetContactID
1690 * @param array $params
1691 * Activity params to override.
1695 public static function addActivity(
1697 $activityType = 'Membership Signup',
1698 $targetContactID = NULL,
1701 $date = date('YmdHis');
1702 if ($activity->__table
== 'civicrm_membership') {
1703 $component = 'Membership';
1705 elseif ($activity->__table
== 'civicrm_participant') {
1706 if ($activityType != 'Email') {
1707 $activityType = 'Event Registration';
1709 $component = 'Event';
1711 elseif ($activity->__table
== 'civicrm_contribution') {
1712 // create activity record only for Completed Contributions
1713 $contributionCompletedStatusId = CRM_Core_PseudoConstant
::getKey('CRM_Contribute_BAO_Contribution', 'contribution_status_id', 'Completed');
1714 if ($activity->contribution_status_id
!= $contributionCompletedStatusId) {
1715 //For onbehalf payments, create a scheduled activity.
1716 if (empty($params['on_behalf'])) {
1719 $params['status_id'] = CRM_Core_PseudoConstant
::getKey('CRM_Activity_BAO_Activity', 'activity_status_id', 'Scheduled');
1721 $activityType = $component = 'Contribution';
1723 // retrieve existing activity based on source_record_id and activity_type
1724 if (empty($params['id'])) {
1725 $params['id'] = CRM_Utils_Array
::value('id', civicrm_api3('Activity', 'Get', [
1726 'source_record_id' => $activity->id
,
1727 'activity_type_id' => $activityType,
1730 if (!empty($params['id'])) {
1731 // CRM-13237 : if activity record found, update it with campaign id of contribution
1732 $params['campaign_id'] = $activity->campaign_id
;
1735 $date = CRM_Utils_Date
::isoToMysql($activity->receive_date
);
1739 'source_contact_id' => $activity->contact_id
,
1740 'source_record_id' => $activity->id
,
1741 'activity_type_id' => CRM_Core_PseudoConstant
::getKey('CRM_Activity_BAO_Activity', 'activity_type_id', $activityType),
1742 'activity_date_time' => $date,
1743 'is_test' => $activity->is_test
,
1744 'status_id' => CRM_Core_PseudoConstant
::getKey('CRM_Activity_BAO_Activity', 'activity_status_id', 'Completed'),
1745 'skipRecentView' => TRUE,
1746 'campaign_id' => $activity->campaign_id
,
1748 $activityParams = array_merge($activityParams, $params);
1750 if (empty($activityParams['subject'])) {
1751 $activityParams['subject'] = self
::getActivitySubject($activity);
1754 if (!empty($activity->activity_id
)) {
1755 $activityParams['id'] = $activity->activity_id
;
1757 // create activity with target contacts
1758 $id = CRM_Core_Session
::getLoggedInContactID();
1760 $activityParams['source_contact_id'] = $id;
1761 $activityParams['target_contact_id'][] = $activity->contact_id
;
1765 if (property_exists($activity, 'details')) {
1766 $activityParams['details'] = $activity->details
;
1769 if ($targetContactID) {
1770 $activityParams['target_contact_id'][] = $targetContactID;
1772 // @todo - use api - remove lots of wrangling above. Remove deprecated fatal & let form layer
1773 // deal with any exceptions.
1774 if (is_a(self
::create($activityParams), 'CRM_Core_Error')) {
1775 throw new CRM_Core_Exception("Failed creating Activity for $component of id {$activity->id}");
1780 * Get activity subject on basis of component object.
1782 * @param object $entityObj
1783 * particular component object.
1787 public static function getActivitySubject($entityObj) {
1788 switch ($entityObj->__table
) {
1789 case 'civicrm_membership':
1790 $membershipType = CRM_Member_PseudoConstant
::membershipType($entityObj->membership_type_id
);
1791 $subject = $membershipType ?
$membershipType : ts('Membership');
1793 if (is_array($subject)) {
1794 $subject = implode(", ", $subject);
1797 if (!CRM_Utils_System
::isNull($entityObj->source
)) {
1798 $subject .= " - {$entityObj->source}";
1801 if ($entityObj->owner_membership_id
) {
1802 list($displayName) = CRM_Contact_BAO_Contact
::getDisplayAndImage(CRM_Core_DAO
::getFieldValue('CRM_Member_DAO_Membership', $entityObj->owner_membership_id
, 'contact_id'));
1803 $subject .= sprintf(' (by %s)', $displayName);
1806 $subject .= " - Status: " . CRM_Core_DAO
::getFieldValue('CRM_Member_DAO_MembershipStatus', $entityObj->status_id
, 'label');
1809 case 'civicrm_participant':
1810 $event = CRM_Event_BAO_Event
::getEvents(1, $entityObj->event_id
, TRUE, FALSE);
1811 $roles = CRM_Event_PseudoConstant
::participantRole();
1812 $status = CRM_Event_PseudoConstant
::participantStatus();
1813 $subject = $event[$entityObj->event_id
];
1815 if (!empty($roles[$entityObj->role_id
])) {
1816 $subject .= ' - ' . $roles[$entityObj->role_id
];
1818 if (!empty($status[$entityObj->status_id
])) {
1819 $subject .= ' - ' . $status[$entityObj->status_id
];
1824 case 'civicrm_contribution':
1825 $subject = CRM_Utils_Money
::format($entityObj->total_amount
, $entityObj->currency
);
1826 if (!CRM_Utils_System
::isNull($entityObj->source
)) {
1827 $subject .= " - {$entityObj->source}";
1830 // Amount and source could exceed max length of subject column.
1831 return CRM_Utils_String
::ellipsify($subject, 255);
1836 * Get Parent activity for currently viewed activity.
1838 * @param int $activityId
1839 * Current activity id.
1842 * Id of parent activity otherwise false.
1843 * @throws \CRM_Core_Exception
1845 public static function getParentActivity($activityId) {
1846 static $parentActivities = [];
1848 $activityId = CRM_Utils_Type
::escape($activityId, 'Integer');
1850 if (!array_key_exists($activityId, $parentActivities)) {
1851 $parentActivities[$activityId] = [];
1853 $parentId = CRM_Core_DAO
::getFieldValue('CRM_Activity_DAO_Activity',
1858 $parentActivities[$activityId] = $parentId ?
$parentId : FALSE;
1861 return $parentActivities[$activityId];
1865 * Get total count of prior revision of currently viewed activity.
1867 * @param $activityID
1868 * Current activity id.
1871 * $params count of prior activities otherwise false.
1872 * @throws \CRM_Core_Exception
1874 public static function getPriorCount($activityID) {
1875 CRM_Core_Error
::deprecatedFunctionWarning('unused function to be removed');
1876 static $priorCounts = [];
1878 $activityID = CRM_Utils_Type
::escape($activityID, 'Integer');
1880 if (!array_key_exists($activityID, $priorCounts)) {
1881 $priorCounts[$activityID] = [];
1882 $originalID = CRM_Core_DAO
::getFieldValue('CRM_Activity_DAO_Activity',
1889 SELECT count( id ) AS cnt
1890 FROM civicrm_activity
1891 WHERE ( id = {$originalID} OR original_id = {$originalID} )
1892 AND is_current_revision = 0
1893 AND id < {$activityID}
1895 $params = [1 => [$originalID, 'Integer']];
1896 $count = CRM_Core_DAO
::singleValueQuery($query, $params);
1898 $priorCounts[$activityID] = $count ?
$count : 0;
1901 return $priorCounts[$activityID];
1905 * Get all prior activities of currently viewed activity.
1907 * @param $activityID
1908 * Current activity id.
1909 * @param bool $onlyPriorRevisions
1912 * prior activities info.
1913 * @throws \CRM_Core_Exception
1915 public static function getPriorAcitivities($activityID, $onlyPriorRevisions = FALSE) {
1916 static $priorActivities = [];
1918 $activityID = CRM_Utils_Type
::escape($activityID, 'Integer');
1919 $index = $activityID . '_' . (int) $onlyPriorRevisions;
1921 if (!array_key_exists($index, $priorActivities)) {
1922 $priorActivities[$index] = [];
1924 $originalID = CRM_Core_DAO
::getFieldValue('CRM_Activity_DAO_Activity',
1929 $originalID = $activityID;
1933 SELECT c.display_name as name, cl.modified_date as date, ca.id as activityID
1934 FROM civicrm_log cl, civicrm_contact c, civicrm_activity ca
1935 WHERE (ca.id = %1 OR ca.original_id = %1)
1936 AND cl.entity_table = 'civicrm_activity'
1937 AND cl.entity_id = ca.id
1938 AND cl.modified_id = c.id
1940 if ($onlyPriorRevisions) {
1941 $query .= " AND ca.id < {$activityID}";
1943 $query .= " ORDER BY ca.id DESC";
1945 $params = [1 => [$originalID, 'Integer']];
1946 $dao = CRM_Core_DAO
::executeQuery($query, $params);
1948 while ($dao->fetch()) {
1949 $priorActivities[$index][$dao->activityID
]['id'] = $dao->activityID
;
1950 $priorActivities[$index][$dao->activityID
]['name'] = $dao->name
;
1951 $priorActivities[$index][$dao->activityID
]['date'] = $dao->date
;
1955 return $priorActivities[$index];
1959 * Find the latest revision of a given activity.
1961 * @param int $activityID
1962 * Prior activity id.
1965 * current activity id.
1967 * @throws \CRM_Core_Exception
1969 public static function getLatestActivityId($activityID) {
1970 static $latestActivityIds = [];
1972 $activityID = CRM_Utils_Type
::escape($activityID, 'Integer');
1974 if (!array_key_exists($activityID, $latestActivityIds)) {
1975 $latestActivityIds[$activityID] = [];
1977 $originalID = CRM_Core_DAO
::getFieldValue('CRM_Activity_DAO_Activity',
1982 $activityID = $originalID;
1984 $params = [1 => [$activityID, 'Integer']];
1985 $query = 'SELECT id from civicrm_activity where original_id = %1 and is_current_revision = 1';
1987 $latestActivityIds[$activityID] = CRM_Core_DAO
::singleValueQuery($query, $params);
1990 return $latestActivityIds[$activityID];
1994 * Create a follow up a given activity.
1996 * @param int $activityId
1997 * activity id of parent activity.
1998 * @param array $params
2000 * @return CRM_Activity_BAO_Activity|null|object
2002 * @throws \CRM_Core_Exception
2004 public static function createFollowupActivity($activityId, $params) {
2009 $followupParams = [];
2010 $followupParams['parent_id'] = $activityId;
2011 $followupParams['source_contact_id'] = CRM_Core_Session
::getLoggedInContactID();
2012 $followupParams['status_id'] = CRM_Core_PseudoConstant
::getKey('CRM_Activity_BAO_Activity', 'activity_status_id', 'Scheduled');
2014 $followupParams['activity_type_id'] = $params['followup_activity_type_id'];
2015 // Get Subject of Follow-up Activiity, CRM-4491
2016 $followupParams['subject'] = $params['followup_activity_subject'] ??
NULL;
2017 $followupParams['assignee_contact_id'] = $params['followup_assignee_contact_id'] ??
NULL;
2019 // Create target contact for followup.
2020 if (!empty($params['target_contact_id'])) {
2021 $followupParams['target_contact_id'] = $params['target_contact_id'];
2024 $followupParams['activity_date_time'] = $params['followup_date'];
2025 $followupActivity = self
::create($followupParams);
2027 return $followupActivity;
2031 * Get Activity specific File according activity type Id.
2033 * @param int $activityTypeId
2035 * @param string $crmDir
2037 * @return string|bool
2038 * if file exists returns $activityTypeFile activity filename otherwise false.
2040 public static function getFileForActivityTypeId($activityTypeId, $crmDir = 'Activity') {
2041 $activityTypes = CRM_Case_PseudoConstant
::caseActivityType(FALSE, TRUE);
2043 if ($activityTypes[$activityTypeId]['name']) {
2044 $activityTypeFile = CRM_Utils_String
::munge(ucwords($activityTypes[$activityTypeId]['name']), '', 0);
2050 global $civicrm_root;
2051 $config = CRM_Core_Config
::singleton();
2052 if (!file_exists(rtrim($civicrm_root, '/') . "/CRM/{$crmDir}/Form/Activity/{$activityTypeFile}.php")) {
2053 if (empty($config->customPHPPathDir
)) {
2056 elseif (!file_exists(rtrim($config->customPHPPathDir
, '/') . "/CRM/{$crmDir}/Form/Activity/{$activityTypeFile}.php")) {
2061 return $activityTypeFile;
2065 * Restore the activity.
2067 * @param array $params
2069 * @return CRM_Activity_DAO_Activity
2071 public static function restoreActivity(&$params) {
2072 $activity = new CRM_Activity_DAO_Activity();
2073 $activity->copyValues($params);
2075 $activity->is_deleted
= 0;
2076 $result = $activity->save();
2082 * Return list of activity statuses of a given type.
2084 * Note: activity status options use the "grouping" field to distinguish status types.
2085 * Types are defined in class constants INCOMPLETE, COMPLETED, CANCELLED
2090 * @throws \CiviCRM_API3_Exception
2092 public static function getStatusesByType($type) {
2093 if (!isset(Civi
::$statics[__CLASS__
][__FUNCTION__
])) {
2094 $statuses = civicrm_api3('OptionValue', 'get', [
2095 'option_group_id' => 'activity_status',
2096 'return' => ['value', 'name', 'filter'],
2097 'options' => ['limit' => 0],
2099 Civi
::$statics[__CLASS__
][__FUNCTION__
] = $statuses['values'];
2102 foreach (Civi
::$statics[__CLASS__
][__FUNCTION__
] as $status) {
2103 if ($status['filter'] == $type) {
2104 $ret[$status['value']] = $status['name'];
2111 * Check if activity is overdue.
2113 * @param array $activity
2116 * @throws \CiviCRM_API3_Exception
2118 public static function isOverdue($activity) {
2119 return array_key_exists($activity['status_id'], self
::getStatusesByType(self
::INCOMPLETE
)) && CRM_Utils_Date
::overdue($activity['activity_date_time']);
2123 * Get the exportable fields for Activities.
2125 * @param string $name
2126 * If it is called by case $name = Case else $name = Activity.
2129 * array of exportable Fields
2131 public static function exportableFields($name = 'Activity') {
2132 self
::$_exportableFields[$name] = [];
2134 // TODO: ideally we should retrieve all fields from xml, in this case since activity processing is done
2135 // my case hence we have defined fields as case_*
2136 if ($name === 'Activity') {
2137 $exportableFields = CRM_Activity_DAO_Activity
::export();
2138 $exportableFields['source_contact_id'] = [
2139 'title' => ts('Source Contact ID'),
2140 'type' => CRM_Utils_Type
::T_INT
,
2142 $exportableFields['source_contact'] = [
2143 'title' => ts('Source Contact'),
2144 'type' => CRM_Utils_Type
::T_STRING
,
2147 // @todo - remove these - they are added by CRM_Core_DAO::appendPseudoConstantsToFields
2148 // below. That search label stuff is referenced in search builder but is likely just
2149 // a hack that duplicates, maybe differently, other functionality.
2151 'activity_type' => [
2152 'title' => ts('Activity Type'),
2153 'name' => 'activity_type',
2154 'type' => CRM_Utils_Type
::T_STRING
,
2155 'searchByLabel' => TRUE,
2157 'activity_status' => [
2158 'title' => ts('Activity Status'),
2159 'name' => 'activity_status',
2160 'type' => CRM_Utils_Type
::T_STRING
,
2161 'searchByLabel' => TRUE,
2163 'activity_priority' => [
2164 'title' => ts('Activity Priority'),
2165 'name' => 'activity_priority',
2166 'type' => CRM_Utils_Type
::T_STRING
,
2167 'searchByLabel' => TRUE,
2170 $fields = array_merge($Activityfields, $exportableFields);
2171 $fields['activity_type_id']['title'] = ts('Activity Type ID');
2174 // Set title to activity fields.
2176 'case_activity_subject' => [
2177 'title' => ts('Activity Subject'),
2178 'type' => CRM_Utils_Type
::T_STRING
,
2180 'case_source_contact_id' => [
2181 'title' => ts('Activity Reporter'),
2182 'type' => CRM_Utils_Type
::T_STRING
,
2184 'case_recent_activity_date' => [
2185 'title' => ts('Activity Actual Date'),
2186 'type' => CRM_Utils_Type
::T_DATE
,
2188 'case_scheduled_activity_date' => [
2189 'title' => ts('Activity Scheduled Date'),
2190 'type' => CRM_Utils_Type
::T_DATE
,
2192 'case_recent_activity_type' => [
2193 'title' => ts('Activity Type'),
2194 'type' => CRM_Utils_Type
::T_STRING
,
2196 'case_activity_status' => [
2197 'title' => ts('Activity Status'),
2198 'type' => CRM_Utils_Type
::T_STRING
,
2200 'case_activity_duration' => [
2201 'title' => ts('Activity Duration'),
2202 'type' => CRM_Utils_Type
::T_INT
,
2204 'case_activity_medium_id' => [
2205 'title' => ts('Activity Medium'),
2206 'type' => CRM_Utils_Type
::T_INT
,
2208 'case_activity_details' => [
2209 'title' => ts('Activity Details'),
2210 'type' => CRM_Utils_Type
::T_TEXT
,
2212 'case_activity_is_auto' => [
2213 'title' => ts('Activity Auto-generated?'),
2214 'type' => CRM_Utils_Type
::T_BOOLEAN
,
2219 // add custom data for case activities
2220 $fields = array_merge($fields, CRM_Core_BAO_CustomField
::getFieldsForImport('Activity'));
2221 CRM_Core_DAO
::appendPseudoConstantsToFields($fields);
2222 self
::$_exportableFields[$name] = $fields;
2223 return self
::$_exportableFields[$name];
2227 * Get the allowed profile fields for Activities.
2230 * array of activity profile Fields
2232 public static function getProfileFields() {
2233 $exportableFields = self
::exportableFields('Activity');
2237 'source_contact_id',
2239 'activity_campaign',
2241 'is_current_revision',
2242 'activity_is_deleted',
2244 $config = CRM_Core_Config
::singleton();
2245 if (!in_array('CiviCampaign', $config->enableComponents
)) {
2246 $skipFields[] = 'activity_engagement_level';
2249 foreach ($skipFields as $field) {
2250 if (isset($exportableFields[$field])) {
2251 unset($exportableFields[$field]);
2255 // hack to use 'activity_type_id' instead of 'activity_type'
2256 $exportableFields['activity_status_id'] = $exportableFields['activity_status'];
2257 unset($exportableFields['activity_status']);
2259 return $exportableFields;
2263 * This function deletes the activity record related to contact record.
2265 * This is conditional on there being no target and assignee record
2266 * with other contacts.
2268 * @param int $contactId
2273 public static function cleanupActivity($contactId) {
2278 $activityContacts = CRM_Activity_BAO_ActivityContact
::buildOptions('record_type_id', 'validate');
2279 $sourceID = CRM_Utils_Array
::key('Activity Source', $activityContacts);
2281 $transaction = new CRM_Core_Transaction();
2283 // delete activity if there is no record in civicrm_activity_contact
2284 // pointing to any other contact record
2285 $activityContact = new CRM_Activity_DAO_ActivityContact();
2286 $activityContact->contact_id
= $contactId;
2287 $activityContact->record_type_id
= $sourceID;
2288 $activityContact->find();
2290 while ($activityContact->fetch()) {
2291 // delete activity_contact record for the deleted contact
2292 $activityContact->delete();
2294 $activityContactOther = new CRM_Activity_DAO_ActivityContact();
2295 $activityContactOther->activity_id
= $activityContact->activity_id
;
2297 // delete activity only if no other contacts connected
2298 if (!$activityContactOther->find(TRUE)) {
2299 $activityParams = ['id' => $activityContact->activity_id
];
2300 $result = self
::deleteActivity($activityParams);
2305 $transaction->commit();
2311 * Does user has sufficient permission for view/edit activity record.
2313 * @param int $activityId
2314 * Activity record id.
2315 * @param int $action
2320 public static function checkPermission($activityId, $action) {
2323 !in_array($action, [CRM_Core_Action
::UPDATE
, CRM_Core_Action
::VIEW
])
2328 $activity = new CRM_Activity_DAO_Activity();
2329 $activity->id
= $activityId;
2330 if (!$activity->find(TRUE)) {
2334 if (!self
::hasPermissionForActivityType($activity->activity_type_id
)) {
2335 // this check is redundant for api access / anything that calls the selectWhereClause
2336 // to determine ACLs.
2339 // Return early when it is case activity.
2340 // Check for CiviCase related permission.
2341 if (CRM_Case_BAO_Case
::isCaseActivity($activityId)) {
2342 return self
::isContactPermittedAccessToCaseActivity($activityId, $action, $activity->activity_type_id
);
2345 // Check for this permission related to contact.
2346 $permission = CRM_Core_Permission
::VIEW
;
2347 if ($action == CRM_Core_Action
::UPDATE
) {
2348 $permission = CRM_Core_Permission
::EDIT
;
2351 $activityContacts = CRM_Activity_BAO_ActivityContact
::buildOptions('record_type_id', 'validate');
2352 $sourceID = CRM_Utils_Array
::key('Activity Source', $activityContacts);
2353 $assigneeID = CRM_Utils_Array
::key('Activity Assignees', $activityContacts);
2354 $targetID = CRM_Utils_Array
::key('Activity Targets', $activityContacts);
2356 // Check for source contact.
2357 $sourceContactId = self
::getActivityContact($activity->id
, $sourceID);
2358 // Account for possibility of activity not having a source contact (as it may have been deleted).
2359 $allow = $sourceContactId ? CRM_Contact_BAO_Contact_Permission
::allow($sourceContactId, $permission) : TRUE;
2364 // Check for target and assignee contacts.
2365 // First check for supper permission.
2366 $supPermission = 'view all contacts';
2367 if ($action == CRM_Core_Action
::UPDATE
) {
2368 $supPermission = 'edit all contacts';
2370 $allow = CRM_Core_Permission
::check($supPermission);
2372 // User might have sufficient permission, through acls.
2375 // Get the target contacts.
2376 $targetContacts = CRM_Activity_BAO_ActivityContact
::retrieveContactIdsByActivityId($activity->id
, $targetID);
2377 foreach ($targetContacts as $cnt => $contactId) {
2378 if (!CRM_Contact_BAO_Contact_Permission
::allow($contactId, $permission)) {
2384 // Get the assignee contacts.
2386 $assigneeContacts = CRM_Activity_BAO_ActivityContact
::retrieveContactIdsByActivityId($activity->id
, $assigneeID);
2387 foreach ($assigneeContacts as $cnt => $contactId) {
2388 if (!CRM_Contact_BAO_Contact_Permission
::allow($contactId, $permission)) {
2400 * Check if the logged in user has permission for the given case activity.
2402 * @param int $activityId
2403 * @param int $action
2404 * @param int $activityTypeID
2408 protected static function isContactPermittedAccessToCaseActivity($activityId, $action, $activityTypeID) {
2410 if ($action == CRM_Core_Action
::UPDATE
) {
2413 $allow = CRM_Case_BAO_Case
::checkPermission($activityId,
2422 * Check if the logged in user has permission to access the given activity type.
2424 * @param int $activityTypeID
2428 protected static function hasPermissionForActivityType($activityTypeID) {
2429 $permittedActivityTypes = self
::getPermittedActivityTypes();
2430 return isset($permittedActivityTypes[$activityTypeID]);
2434 * Get the activity types the user is permitted to access.
2436 * The types are filtered by the components they have access to. ie. a user
2437 * with access CiviContribute but not CiviMember will see contribution related
2438 * activities and activities with no component (e.g meetings) but not member related ones.
2442 protected static function getPermittedActivityTypes() {
2443 $userID = (int) CRM_Core_Session
::getLoggedInContactID();
2444 if (!isset(Civi
::$statics[__CLASS__
]['permitted_activity_types'][$userID])) {
2445 $permittedActivityTypes = [];
2446 $components = self
::activityComponents(FALSE);
2447 $componentClause = empty($components) ?
'' : (' OR component_id IN (' . implode(', ', array_keys($components)) . ')');
2449 $types = CRM_Core_DAO
::executeQuery(
2451 SELECT option_value.value activity_type_id
2452 FROM civicrm_option_value option_value
2453 INNER JOIN civicrm_option_group grp ON (grp.id = option_group_id AND grp.name = 'activity_type')
2454 WHERE component_id IS NULL $componentClause")->fetchAll();
2455 foreach ($types as $type) {
2456 $permittedActivityTypes[$type['activity_type_id']] = (int) $type['activity_type_id'];
2458 Civi
::$statics[__CLASS__
]['permitted_activity_types'][$userID] = $permittedActivityTypes;
2460 return Civi
::$statics[__CLASS__
]['permitted_activity_types'][$userID];
2467 protected static function getActivityParamsForDashboardFunctions($params) {
2470 'is_current_revision' => 1,
2472 'contact_id' => $params['contact_id'] ??
NULL,
2473 'activity_date_time' => $params['activity_date_time'] ??
NULL,
2474 'check_permissions' => 1,
2476 'offset' => $params['offset'] ??
0,
2480 if (!empty($params['activity_status_id'])) {
2481 $activityParams['activity_status_id'] = ['IN' => explode(',', $params['activity_status_id'])];
2484 $activityParams['activity_type_id'] = self
::filterActivityTypes($params);
2485 $enabledComponents = self
::activityComponents();
2486 // @todo - this appears to be duplicating the activity api.
2487 if (!in_array('CiviCase', $enabledComponents)) {
2488 $activityParams['case_id'] = ['IS NULL' => 1];
2490 return $activityParams;
2494 * Checks if user has permissions to edit inbound e-mails, either basic info
2495 * or both basic information and content.
2499 public static function checkEditInboundEmailsPermissions() {
2500 if (CRM_Core_Permission
::check('edit inbound email basic information')
2501 || CRM_Core_Permission
::check('edit inbound email basic information and content')
2510 * Get the list of view only activities
2514 public static function getViewOnlyActivityTypeIDs() {
2515 $viewOnlyActivities = [
2516 'Email' => CRM_Core_PseudoConstant
::getKey('CRM_Activity_BAO_Activity', 'activity_type_id', 'Email'),
2518 if (self
::checkEditInboundEmailsPermissions()) {
2519 $viewOnlyActivities['Inbound Email'] = CRM_Core_PseudoConstant
::getKey('CRM_Activity_BAO_Activity', 'activity_type_id', 'Inbound Email');
2521 return $viewOnlyActivities;
2525 * Wrapper for ajax activity selector.
2527 * @param array $params
2528 * Associated array for params record id.
2531 * Associated array of contact activities
2533 public static function getContactActivitySelector(&$params) {
2534 // Format the params.
2535 $params['offset'] = ($params['page'] - 1) * $params['rp'];
2536 $params['rowCount'] = $params['rp'];
2537 $params['sort'] = $params['sortBy'] ??
NULL;
2538 $params['caseId'] = NULL;
2539 $context = $params['context'] ??
NULL;
2540 $showContactOverlay = !CRM_Utils_String
::startsWith($context, "dashlet");
2541 $activityTypeInfo = civicrm_api3('OptionValue', 'get', [
2542 'option_group_id' => "activity_type",
2543 'options' => ['limit' => 0],
2545 $activityIcons = [];
2546 foreach ($activityTypeInfo['values'] as $type) {
2547 if (!empty($type['icon'])) {
2548 $activityIcons[$type['value']] = $type['icon'];
2551 CRM_Utils_Date
::convertFormDateToApiFormat($params, 'activity_date_time');
2553 // Get contact activities.
2554 $activities = CRM_Activity_BAO_Activity
::getActivities($params);
2557 $params['total'] = CRM_Activity_BAO_Activity
::getActivitiesCount($params);
2559 // Format params and add links.
2560 $contactActivities = [];
2562 // View-only activity types
2563 $viewOnlyCaseActivityTypeIDs = array_flip(CRM_Activity_BAO_Activity
::getViewOnlyActivityTypeIDs());
2565 if (!empty($activities)) {
2566 $activityStatus = CRM_Core_PseudoConstant
::activityStatus();
2568 // Check logged in user for permission.
2569 $page = new CRM_Core_Page();
2570 CRM_Contact_Page_View
::checkUserPermission($page, $params['contact_id']);
2571 $permissions = [$page->_permission
];
2572 if (CRM_Core_Permission
::check('delete activities')) {
2573 $permissions[] = CRM_Core_Permission
::DELETE
;
2576 $mask = CRM_Core_Action
::mask($permissions);
2577 $userID = CRM_Core_Session
::getLoggedInContactID();
2579 foreach ($activities as $activityId => $values) {
2580 $activity = ['source_contact_name' => '', 'target_contact_name' => ''];
2581 $activity['DT_RowId'] = $activityId;
2582 // Add class to this row if overdue.
2583 $activity['DT_RowClass'] = "crm-entity status-id-{$values['status_id']}";
2584 if (self
::isOverdue($values)) {
2585 $activity['DT_RowClass'] .= ' status-overdue';
2588 $activity['DT_RowClass'] .= ' status-ontime';
2591 $activity['DT_RowAttr'] = [];
2592 $activity['DT_RowAttr']['data-entity'] = 'activity';
2593 $activity['DT_RowAttr']['data-id'] = $activityId;
2595 $activity['activity_type'] = (!empty($activityIcons[$values['activity_type_id']]) ?
'<span class="crm-i ' . $activityIcons[$values['activity_type_id']] . '" aria-hidden="true"></span> ' : '') . $values['activity_type'];
2596 $activity['subject'] = $values['subject'];
2598 if ($params['contact_id'] == $values['source_contact_id']) {
2599 $activity['source_contact_name'] = $values['source_contact_name'];
2601 elseif ($values['source_contact_id']) {
2603 if ($showContactOverlay) {
2604 $srcTypeImage = CRM_Contact_BAO_Contact_Utils
::getImage(
2605 CRM_Contact_BAO_Contact
::getContactType($values['source_contact_id']),
2607 $values['source_contact_id']);
2609 $activity['source_contact_name'] = $srcTypeImage . CRM_Utils_System
::href($values['source_contact_name'],
2610 'civicrm/contact/view', "reset=1&cid={$values['source_contact_id']}");
2613 $activity['source_contact_name'] = '<em>n/a</em>';
2616 if (isset($values['mailingId']) && !empty($values['mailingId'])) {
2617 $activity['target_contact'] = CRM_Utils_System
::href($values['recipients'],
2618 'civicrm/mailing/report/event',
2619 "mid={$values['source_record_id']}&reset=1&event=queue&cid={$params['contact_id']}&context=activitySelector");
2621 elseif (!empty($values['recipients'])) {
2622 $activity['target_contact_name'] = $values['recipients'];
2624 elseif (isset($values['target_contact_count']) && $values['target_contact_count']) {
2625 $activity['target_contact_name'] = '';
2626 $firstTargetName = reset($values['target_contact_name']);
2627 $firstTargetContactID = key($values['target_contact_name']);
2629 // The first target may not be accessable to the logged in user dev/core#1052
2630 if ($firstTargetName) {
2631 $targetLink = CRM_Utils_System
::href($firstTargetName, 'civicrm/contact/view', "reset=1&cid={$firstTargetContactID}");
2632 if ($showContactOverlay) {
2633 $targetTypeImage = CRM_Contact_BAO_Contact_Utils
::getImage(
2634 CRM_Contact_BAO_Contact
::getContactType($firstTargetContactID),
2636 $firstTargetContactID);
2637 $activity['target_contact_name'] .= "<div>$targetTypeImage $targetLink";
2640 $activity['target_contact_name'] .= $targetLink;
2643 if ($extraCount = $values['target_contact_count'] - 1) {
2644 $activity['target_contact_name'] .= ";<br />" . "(" . ts('%1 more', [1 => $extraCount]) . ")";
2646 if ($showContactOverlay) {
2647 $activity['target_contact_name'] .= "</div> ";
2651 elseif (!$values['target_contact_name']) {
2652 $activity['target_contact_name'] = '<em>n/a</em>';
2655 $activity['assignee_contact_name'] = '';
2656 if (empty($values['assignee_contact_name'])) {
2657 $activity['assignee_contact_name'] = '<em>n/a</em>';
2659 elseif (!empty($values['assignee_contact_name'])) {
2661 $activity['assignee_contact_name'] = '';
2662 foreach ($values['assignee_contact_name'] as $acID => $acName) {
2663 if ($acID && $count < 5) {
2664 $assigneeTypeImage = "";
2665 $assigneeLink = CRM_Utils_System
::href($acName, 'civicrm/contact/view', "reset=1&cid={$acID}");
2666 if ($showContactOverlay) {
2667 $assigneeTypeImage = CRM_Contact_BAO_Contact_Utils
::getImage(
2668 CRM_Contact_BAO_Contact
::getContactType($acID),
2671 $activity['assignee_contact_name'] .= "<div>$assigneeTypeImage $assigneeLink";
2674 $activity['assignee_contact_name'] .= $assigneeLink;
2679 $activity['assignee_contact_name'] .= "; ";
2681 if ($showContactOverlay) {
2682 $activity['assignee_contact_name'] .= "</div> ";
2686 $activity['assignee_contact_name'] .= "(" . ts('more') . ")";
2693 $activity['activity_date_time'] = CRM_Utils_Date
::customFormat($values['activity_date_time']);
2694 $activity['status_id'] = $activityStatus[$values['status_id']];
2697 $activity['links'] = '';
2698 $accessMailingReport = FALSE;
2699 if (!empty($values['mailingId'])) {
2700 $accessMailingReport = TRUE;
2703 // Get action links.
2705 // If this is a case activity, then we hand off to Case's actionLinks instead.
2706 if (!empty($values['case_id']) && Civi
::settings()->get('civicaseShowCaseActivities')) {
2707 // This activity belongs to a case.
2708 $caseId = current($values['case_id']);
2710 $activity['subject'] = $values['subject'];
2712 // Get the view and edit (update) links:
2714 $actionLinks = array_intersect_key(
2715 CRM_Case_Selector_Search
::actionLinks(),
2716 array_fill_keys([CRM_Core_Action
::VIEW
, CRM_Core_Action
::UPDATE
], NULL));
2718 // Create a Manage Case link (using ADVANCED as can't use two VIEW ones)
2719 $actionLinks[CRM_Core_Action
::ADVANCED
] = [
2720 "name" => 'Manage Case',
2721 "url" => 'civicrm/contact/view/case',
2722 'qs' => 'reset=1&id=%%caseid%%&cid=%%cid%%&action=view&context=&selectedChild=case',
2723 "title" => ts('Manage Case %1', [1 => $caseId]),
2724 'class' => 'no-popup',
2728 'aid' => $activityId,
2729 'caseid' => $caseId,
2730 'cid' => current(CRM_Case_BAO_Case
::getCaseClients($caseId) ??
[]),
2731 // Unlike other 'context' params, this 'ctx' param is appended raw to the URL.
2735 $caseActivityPermissions = CRM_Core_Action
::VIEW | CRM_Core_Action
::ADVANCED
;
2736 // Allow Edit link if:
2737 // 1. Activity type is NOT view-only type. CRM-5871
2738 // 2. User has edit permission.
2739 if (!isset($viewOnlyCaseActivityTypeIDs[$values['activity_type_id']])
2740 && CRM_Case_BAO_Case
::checkPermission($activityId, 'edit', $values['activity_type_id'], $userID)) {
2741 // We're allowed to edit.
2742 $caseActivityPermissions |
= CRM_Core_Action
::UPDATE
;
2745 $activity['links'] = CRM_Core_Action
::formLink($actionLinks,
2746 $caseActivityPermissions,
2752 $values['activity_id']
2756 // Non-case activity
2757 $actionLinks = CRM_Activity_Selector_Activity
::actionLinks(
2758 CRM_Utils_Array
::value('activity_type_id', $values),
2759 CRM_Utils_Array
::value('source_record_id', $values),
2760 $accessMailingReport,
2761 CRM_Utils_Array
::value('activity_id', $values)
2763 $actionMask = array_sum(array_keys($actionLinks)) & $mask;
2765 $activity['links'] = CRM_Core_Action
::formLink($actionLinks,
2768 'id' => $values['activity_id'],
2769 'cid' => $params['contact_id'],
2777 $values['activity_id']
2781 if ($values['is_recurring_activity']) {
2782 $activity['is_recurring_activity'] = CRM_Core_BAO_RecurringEntity
::getPositionAndCount($values['activity_id'], 'civicrm_activity');
2785 array_push($contactActivities, $activity);
2790 $activitiesDT['data'] = $contactActivities;
2791 $activitiesDT['recordsTotal'] = $params['total'];
2792 $activitiesDT['recordsFiltered'] = $params['total'];
2794 return $activitiesDT;
2798 * Copy custom fields and attachments from an existing activity to another.
2800 * @see CRM_Case_Page_AJAX::_convertToCaseActivity()
2802 * @param array $params
2804 public static function copyExtendedActivityData($params) {
2805 // attach custom data to the new activity
2806 $customParams = $htmlType = [];
2807 $customValues = CRM_Core_BAO_CustomValueTable
::getEntityValues($params['activityID'], 'Activity');
2809 if (!empty($customValues)) {
2810 $fieldIds = implode(', ', array_keys($customValues));
2811 $sql = "SELECT id FROM civicrm_custom_field WHERE html_type = 'File' AND id IN ( {$fieldIds} )";
2812 $result = CRM_Core_DAO
::executeQuery($sql);
2814 while ($result->fetch()) {
2815 $htmlType[] = $result->id
;
2818 foreach ($customValues as $key => $value) {
2819 if ($value !== NULL) {
2821 if (in_array($key, $htmlType)) {
2822 $fileValues = CRM_Core_BAO_File
::path($value, $params['activityID']);
2823 $customParams["custom_{$key}_-1"] = [
2824 'name' => $fileValues[0],
2825 'type' => $fileValues[1],
2829 $customParams["custom_{$key}_-1"] = $value;
2833 CRM_Core_BAO_CustomValueTable
::postProcess($customParams, 'civicrm_activity',
2834 $params['mainActivityId'], 'Activity'
2838 // copy activity attachments ( if any )
2839 CRM_Core_BAO_File
::copyEntityFile('civicrm_activity', $params['activityID'], 'civicrm_activity', $params['mainActivityId']);
2843 * Get activity contact.
2845 * @param int $activityId
2846 * @param int $recordTypeID
2847 * @param string $column
2851 public static function getActivityContact($activityId, $recordTypeID = NULL, $column = 'contact_id') {
2852 $activityContact = new CRM_Activity_BAO_ActivityContact();
2853 $activityContact->activity_id
= $activityId;
2854 if ($recordTypeID) {
2855 $activityContact->record_type_id
= $recordTypeID;
2857 if ($activityContact->find(TRUE)) {
2858 return $activityContact->$column;
2864 * Get source contact id.
2866 * @param int $activityId
2870 public static function getSourceContactID($activityId) {
2871 static $sourceID = NULL;
2873 $activityContacts = CRM_Activity_BAO_ActivityContact
::buildOptions('record_type_id', 'validate');
2874 $sourceID = CRM_Utils_Array
::key('Activity Source', $activityContacts);
2877 return self
::getActivityContact($activityId, $sourceID);
2883 * @todo Document what this is for.
2885 * @param array $params
2887 public function setApiFilter(&$params) {
2888 if (!empty($params['target_contact_id'])) {
2890 $activityContacts = CRM_Activity_BAO_ActivityContact
::buildOptions('record_type_id', 'validate');
2891 $targetID = CRM_Utils_Array
::key('Activity Targets', $activityContacts);
2892 $obj = new CRM_Activity_BAO_ActivityContact();
2893 $params['return.target_contact_id'] = 1;
2894 $this->joinAdd($obj, 'LEFT');
2895 $this->selectAdd('civicrm_activity.*');
2896 $this->whereAdd(" civicrm_activity_contact.contact_id = {$params['target_contact_id']} AND civicrm_activity_contact.record_type_id = {$targetID}");
2901 * Send activity as attachment.
2903 * @param object $activity
2904 * @param array $mailToContacts
2905 * @param array $params
2909 public static function sendToAssignee($activity, $mailToContacts, $params = []) {
2910 if (!CRM_Utils_Array
::crmIsEmptyArray($mailToContacts)) {
2911 $clientID = $params['client_id'] ??
NULL;
2912 $caseID = $params['case_id'] ??
NULL;
2914 $ics = new CRM_Activity_BAO_ICalendar($activity);
2915 $attachments = CRM_Core_BAO_File
::getEntityFile('civicrm_activity', $activity->id
);
2916 $ics->addAttachment($attachments, $mailToContacts);
2918 $result = CRM_Case_BAO_Case
::sendActivityCopy($clientID, $activity->id
, $mailToContacts, $attachments, $caseID);
2928 public static function getEntityRefFilters() {
2930 ['key' => 'activity_type_id', 'value' => ts('Activity Type')],
2931 ['key' => 'status_id', 'value' => ts('Activity Status')],