3 +--------------------------------------------------------------------+
5 +--------------------------------------------------------------------+
6 | Copyright CiviCRM LLC (c) 2004-2019 |
7 +--------------------------------------------------------------------+
8 | This file is a part of CiviCRM. |
10 | CiviCRM is free software; you can copy, modify, and distribute it |
11 | under the terms of the GNU Affero General Public License |
12 | Version 3, 19 November 2007 and the CiviCRM Licensing Exception. |
14 | CiviCRM is distributed in the hope that it will be useful, but |
15 | WITHOUT ANY WARRANTY; without even the implied warranty of |
16 | MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. |
17 | See the GNU Affero General Public License for more details. |
19 | You should have received a copy of the GNU Affero General Public |
20 | License and the CiviCRM Licensing Exception along |
21 | with this program; if not, contact CiviCRM LLC |
22 | at info[AT]civicrm[DOT]org. If you have questions about the |
23 | GNU Affero General Public License or the licensing of CiviCRM, |
24 | see the CiviCRM license FAQ at http://civicrm.org/licensing |
25 +--------------------------------------------------------------------+
31 * @copyright CiviCRM LLC (c) 2004-2019
35 * This class is for activity functions.
37 class CRM_Activity_BAO_Activity
extends CRM_Activity_DAO_Activity
{
40 * Activity status types
48 * Static field for all the activity information that we can potentially export.
52 static $_exportableFields = NULL;
55 * Static field for all the activity information that we can potentially import.
59 static $_importableFields = NULL;
62 * Check if there is absolute minimum of data to add the object.
64 * @param array $params
65 * (reference ) an assoc array of name/value pairs.
69 public static function dataExists(&$params) {
70 if (!empty($params['source_contact_id']) ||
!empty($params['id'])) {
79 * Fetch object based on array of properties.
81 * @param array $params
82 * (reference ) an assoc array of name/value pairs.
83 * @param array $defaults
84 * (reference ) an assoc array to hold the flattened values.
86 * @return CRM_Activity_DAO_Activity
88 public static function retrieve(&$params, &$defaults) {
89 // this will bypass acls - use the api instead.
90 // @todo add deprecation logging to this function.
91 $activity = new CRM_Activity_DAO_Activity();
92 $activity->copyValues($params);
94 if ($activity->find(TRUE)) {
95 $activityContacts = CRM_Activity_BAO_ActivityContact
::buildOptions('record_type_id', 'validate');
96 $targetID = CRM_Utils_Array
::key('Activity Targets', $activityContacts);
97 $sourceID = CRM_Utils_Array
::key('Activity Source', $activityContacts);
98 $assigneeID = CRM_Utils_Array
::key('Activity Assignees', $activityContacts);
100 // TODO: at some stage we'll have to deal
101 // with multiple values for assignees and targets, but
102 // for now, let's just fetch first row.
103 $defaults['assignee_contact'] = CRM_Activity_BAO_ActivityContact
::retrieveContactIdsByActivityId($activity->id
, $assigneeID);
104 $assignee_contact_names = CRM_Activity_BAO_ActivityContact
::getNames($activity->id
, $assigneeID);
105 $defaults['assignee_contact_value'] = implode('; ', $assignee_contact_names);
106 $sourceContactId = self
::getActivityContact($activity->id
, $sourceID);
107 if ($activity->activity_type_id
!= CRM_Core_PseudoConstant
::getKey('CRM_Activity_BAO_Activity', 'activity_type_id', 'Bulk Email')) {
108 $defaults['target_contact'] = CRM_Activity_BAO_ActivityContact
::retrieveContactIdsByActivityId($activity->id
, $targetID);
109 $target_contact_names = CRM_Activity_BAO_ActivityContact
::getNames($activity->id
, $targetID);
110 $defaults['target_contact_value'] = implode('; ', $target_contact_names);
112 elseif (CRM_Core_Permission
::check('access CiviMail') ||
113 (CRM_Mailing_Info
::workflowEnabled() &&
114 CRM_Core_Permission
::check('create mailings')
117 $defaults['mailingId'] = CRM_Utils_System
::url('civicrm/mailing/report',
118 "mid={$activity->source_record_id}&reset=1&atype={$activity->activity_type_id}&aid={$activity->id}&cid={$sourceContactId}&context=activity"
122 $defaults['target_contact_value'] = ts('(recipients)');
125 $sourceContactId = self
::getActivityContact($activity->id
, $sourceID);
126 $defaults['source_contact_id'] = $sourceContactId;
128 if ($sourceContactId &&
129 !CRM_Core_DAO
::getFieldValue('CRM_Contact_DAO_Contact',
134 $defaults['source_contact'] = CRM_Core_DAO
::getFieldValue('CRM_Contact_DAO_Contact',
141 $defaults['case_subject'] = CRM_Case_BAO_Case
::getCaseSubject($activity->id
);
143 CRM_Core_DAO
::storeValues($activity, $defaults);
151 * Delete the activity.
153 * @param array $params
154 * @param bool $moveToTrash
158 public static function deleteActivity(&$params, $moveToTrash = FALSE) {
160 if (!empty($params['id']) && !is_array($params['id'])) {
161 CRM_Utils_Hook
::pre('delete', 'Activity', $params['id'], $params);
164 CRM_Utils_Hook
::pre('delete', 'Activity', NULL, $params);
167 $transaction = new CRM_Core_Transaction();
168 if (is_array(CRM_Utils_Array
::value('source_record_id', $params))) {
169 $sourceRecordIds = implode(',', $params['source_record_id']);
172 $sourceRecordIds = CRM_Utils_Array
::value('source_record_id', $params);
177 if (!isset($params['id'])) {
178 if (is_array($params['activity_type_id'])) {
179 $activityTypes = implode(',', $params['activity_type_id']);
182 $activityTypes = $params['activity_type_id'];
185 $query = "DELETE FROM civicrm_activity WHERE source_record_id IN ({$sourceRecordIds}) AND activity_type_id IN ( {$activityTypes} )";
186 $dao = CRM_Core_DAO
::executeQuery($query);
189 $activity = new CRM_Activity_DAO_Activity();
190 $activity->copyValues($params);
191 $result = $activity->delete();
194 $activity->case_id
= CRM_Case_BAO_Case
::getCaseIdByActivityId($activity->id
);
196 // CRM-13994 delete activity entity_tag
197 $query = "DELETE FROM civicrm_entity_tag WHERE entity_table = 'civicrm_activity' AND entity_id = {$activity->id}";
198 $dao = CRM_Core_DAO
::executeQuery($query);
202 $activity = new CRM_Activity_DAO_Activity();
203 $activity->copyValues($params);
205 $activity->is_deleted
= 1;
206 $result = $activity->save();
208 // CRM-4525 log activity delete
209 $logMsg = 'Case Activity deleted for';
212 $activityContacts = CRM_Activity_BAO_ActivityContact
::buildOptions('record_type_id', 'validate');
213 $sourceID = CRM_Utils_Array
::key('Activity Source', $activityContacts);
214 $assigneeID = CRM_Utils_Array
::key('Activity Assignees', $activityContacts);
215 $targetID = CRM_Utils_Array
::key('Activity Targets', $activityContacts);
216 $sourceContactId = self
::getActivityContact($activity->id
, $sourceID);
217 if ($sourceContactId) {
218 $msgs[] = " source={$sourceContactId}";
221 // get target contacts.
222 $targetContactIds = CRM_Activity_BAO_ActivityContact
::getNames($activity->id
, $targetID);
223 if (!empty($targetContactIds)) {
224 $msgs[] = " target =" . implode(',', array_keys($targetContactIds));
226 // get assignee contacts.
227 $assigneeContactIds = CRM_Activity_BAO_ActivityContact
::getNames($activity->id
, $assigneeID);
228 if (!empty($assigneeContactIds)) {
229 $msgs[] = " assignee =" . implode(',', array_keys($assigneeContactIds));
232 $logMsg .= implode(', ', $msgs);
234 self
::logActivityAction($activity, $logMsg);
237 // delete the recently created Activity
239 $activityRecent = array(
240 'id' => $activity->id
,
241 'type' => 'Activity',
243 CRM_Utils_Recent
::del($activityRecent);
246 $transaction->commit();
247 if (isset($activity)) {
249 $activity->case_id
= CRM_Case_BAO_Case
::getCaseIdByActivityId($activity->id
);
250 CRM_Utils_Hook
::post('delete', 'Activity', $activity->id
, $activity);
257 * Delete activity assignment record.
259 * @param int $activityId
260 * @param int $recordTypeID
262 public static function deleteActivityContact($activityId, $recordTypeID = NULL) {
263 $activityContact = new CRM_Activity_BAO_ActivityContact();
264 $activityContact->activity_id
= $activityId;
266 $activityContact->record_type_id
= $recordTypeID;
269 // Let's check if activity contact record exits and then delete.
270 // Looks like delete leads to deadlock when multiple simultaneous
271 // requests are done. CRM-15470
272 if ($activityContact->find()) {
273 $activityContact->delete();
278 * Process the activities.
280 * @param array $params
281 * Associated array of the submitted values.
283 * @throws CRM_Core_Exception
285 * @return CRM_Activity_BAO_Activity|null|object
287 public static function create(&$params) {
288 // CRM-20958 - These fields are managed by MySQL triggers. Watch out for clients resaving stale timestamps.
289 unset($params['created_date']);
290 unset($params['modified_date']);
292 // check required params
293 if (!self
::dataExists($params)) {
294 throw new CRM_Core_Exception('Not enough data to create activity object');
297 $activity = new CRM_Activity_DAO_Activity();
299 if (isset($params['id']) && empty($params['id'])) {
300 unset($params['id']);
303 if (empty($params['status_id']) && empty($params['activity_status_id']) && empty($params['id'])) {
304 if (isset($params['activity_date_time']) &&
305 strcmp($params['activity_date_time'], CRM_Utils_Date
::processDate(date('Ymd')) == -1)
307 $params['status_id'] = CRM_Core_PseudoConstant
::getKey('CRM_Activity_BAO_Activity', 'status_id', 'Completed');
310 $params['status_id'] = CRM_Core_PseudoConstant
::getKey('CRM_Activity_BAO_Activity', 'status_id', 'Scheduled');
314 // Set priority to Normal for Auto-populated activities (for Cases)
315 if (CRM_Utils_Array
::value('priority_id', $params) === NULL &&
316 // if not set and not 0
317 !CRM_Utils_Array
::value('id', $params)
319 $priority = CRM_Core_PseudoConstant
::get('CRM_Activity_DAO_Activity', 'priority_id');
320 $params['priority_id'] = array_search('Normal', $priority);
323 if (!empty($params['target_contact_id']) && is_array($params['target_contact_id'])) {
324 $params['target_contact_id'] = array_unique($params['target_contact_id']);
326 if (!empty($params['assignee_contact_id']) && is_array($params['assignee_contact_id'])) {
327 $params['assignee_contact_id'] = array_unique($params['assignee_contact_id']);
331 if (!empty($params['id'])) {
332 CRM_Utils_Hook
::pre('edit', 'Activity', $activity->id
, $params);
335 CRM_Utils_Hook
::pre('create', 'Activity', NULL, $params);
338 $activity->copyValues($params);
339 if (isset($params['case_id'])) {
340 // CRM-8708, preserve case ID even though it's not part of the SQL model
341 $activity->case_id
= $params['case_id'];
343 elseif (is_numeric($activity->id
)) {
344 // CRM-8708, preserve case ID even though it's not part of the SQL model
345 $activity->case_id
= CRM_Case_BAO_Case
::getCaseIdByActivityId($activity->id
);
349 $transaction = new CRM_Core_Transaction();
351 $result = $activity->save();
353 if (is_a($result, 'CRM_Core_Error')) {
354 $transaction->rollback();
358 $activityId = $activity->id
;
359 $sourceID = CRM_Core_PseudoConstant
::getKey('CRM_Activity_BAO_ActivityContact', 'record_type_id', 'Activity Source');
360 $assigneeID = CRM_Core_PseudoConstant
::getKey('CRM_Activity_BAO_ActivityContact', 'record_type_id', 'Activity Assignees');
361 $targetID = CRM_Core_PseudoConstant
::getKey('CRM_Activity_BAO_ActivityContact', 'record_type_id', 'Activity Targets');
363 if (isset($params['source_contact_id'])) {
365 'activity_id' => $activityId,
366 'contact_id' => $params['source_contact_id'],
367 'record_type_id' => $sourceID,
369 self
::deleteActivityContact($activityId, $sourceID);
370 CRM_Activity_BAO_ActivityContact
::create($acParams);
373 // check and attach and files as needed
374 CRM_Core_BAO_File
::processAttachment($params, 'civicrm_activity', $activityId);
376 // attempt to save activity assignment
377 $resultAssignment = NULL;
378 if (!empty($params['assignee_contact_id'])) {
380 $assignmentParams = array('activity_id' => $activityId);
382 if (is_array($params['assignee_contact_id'])) {
383 if (CRM_Utils_Array
::value('deleteActivityAssignment', $params, TRUE)) {
384 // first delete existing assignments if any
385 self
::deleteActivityContact($activityId, $assigneeID);
388 foreach ($params['assignee_contact_id'] as $acID) {
390 $assigneeParams = array(
391 'activity_id' => $activityId,
392 'contact_id' => $acID,
393 'record_type_id' => $assigneeID,
395 CRM_Activity_BAO_ActivityContact
::create($assigneeParams);
400 $assignmentParams['contact_id'] = $params['assignee_contact_id'];
401 $assignmentParams['record_type_id'] = $assigneeID;
402 if (!empty($params['id'])) {
403 $assignment = new CRM_Activity_BAO_ActivityContact();
404 $assignment->activity_id
= $activityId;
405 $assignment->record_type_id
= $assigneeID;
406 $assignment->find(TRUE);
408 if ($assignment->contact_id
!= $params['assignee_contact_id']) {
409 $assignmentParams['id'] = $assignment->id
;
410 $resultAssignment = CRM_Activity_BAO_ActivityContact
::create($assignmentParams);
414 $resultAssignment = CRM_Activity_BAO_ActivityContact
::create($assignmentParams);
419 if (CRM_Utils_Array
::value('deleteActivityAssignment', $params, TRUE)) {
420 self
::deleteActivityContact($activityId, $assigneeID);
424 if (is_a($resultAssignment, 'CRM_Core_Error')) {
425 $transaction->rollback();
426 return $resultAssignment;
429 // attempt to save activity targets
430 $resultTarget = NULL;
431 if (!empty($params['target_contact_id'])) {
433 $targetParams = array('activity_id' => $activityId);
434 $resultTarget = array();
435 if (is_array($params['target_contact_id'])) {
436 if (CRM_Utils_Array
::value('deleteActivityTarget', $params, TRUE)) {
437 // first delete existing targets if any
438 self
::deleteActivityContact($activityId, $targetID);
441 foreach ($params['target_contact_id'] as $tid) {
443 $targetContactParams = array(
444 'activity_id' => $activityId,
445 'contact_id' => $tid,
446 'record_type_id' => $targetID,
448 CRM_Activity_BAO_ActivityContact
::create($targetContactParams);
453 $targetParams['contact_id'] = $params['target_contact_id'];
454 $targetParams['record_type_id'] = $targetID;
455 if (!empty($params['id'])) {
456 $target = new CRM_Activity_BAO_ActivityContact();
457 $target->activity_id
= $activityId;
458 $target->record_type_id
= $targetID;
461 if ($target->contact_id
!= $params['target_contact_id']) {
462 $targetParams['id'] = $target->id
;
463 $resultTarget = CRM_Activity_BAO_ActivityContact
::create($targetParams);
467 $resultTarget = CRM_Activity_BAO_ActivityContact
::create($targetParams);
472 if (CRM_Utils_Array
::value('deleteActivityTarget', $params, TRUE)) {
473 self
::deleteActivityContact($activityId, $targetID);
477 // write to changelog before transaction is committed/rolled
478 // back (and prepare status to display)
479 if (!empty($params['id'])) {
480 $logMsg = "Activity (id: {$result->id} ) updated with ";
483 $logMsg = "Activity created for ";
487 if (isset($params['source_contact_id'])) {
488 $msgs[] = "source={$params['source_contact_id']}";
491 if (!empty($params['target_contact_id'])) {
492 if (is_array($params['target_contact_id']) && !CRM_Utils_Array
::crmIsEmptyArray($params['target_contact_id'])) {
493 $msgs[] = "target=" . implode(',', $params['target_contact_id']);
494 // take only first target
495 // will be used for recently viewed display
496 $t = array_slice($params['target_contact_id'], 0, 1);
497 $recentContactId = $t[0];
499 // Is array check fixes warning without degrading functionality but it seems this bit of code may no longer work
500 // as it may always be an array
501 elseif (isset($params['target_contact_id']) && !is_array($params['target_contact_id'])) {
502 $msgs[] = "target={$params['target_contact_id']}";
503 // will be used for recently viewed display
504 $recentContactId = $params['target_contact_id'];
508 // at worst, take source for recently viewed display
509 $recentContactId = CRM_Utils_Array
::value('source_contact_id', $params);
512 if (isset($params['assignee_contact_id'])) {
513 if (is_array($params['assignee_contact_id'])) {
514 $msgs[] = "assignee=" . implode(',', $params['assignee_contact_id']);
517 $msgs[] = "assignee={$params['assignee_contact_id']}";
520 $logMsg .= implode(', ', $msgs);
522 self
::logActivityAction($result, $logMsg);
524 if (!empty($params['custom']) &&
525 is_array($params['custom'])
527 CRM_Core_BAO_CustomValueTable
::store($params['custom'], 'civicrm_activity', $result->id
);
530 $transaction->commit();
531 if (empty($params['skipRecentView'])) {
532 $recentOther = array();
533 if (!empty($params['case_id'])) {
534 $caseContactID = CRM_Core_DAO
::getFieldValue('CRM_Case_DAO_CaseContact', $params['case_id'], 'contact_id', 'case_id');
535 $url = CRM_Utils_System
::url('civicrm/case/activity/view',
536 "reset=1&aid={$activity->id}&cid={$caseContactID}&caseID={$params['case_id']}&context=home"
540 $q = "action=view&reset=1&id={$activity->id}&atype={$activity->activity_type_id}&cid=" . CRM_Utils_Array
::value('source_contact_id', $params) . "&context=home";
541 if ($activity->activity_type_id
!= CRM_Core_PseudoConstant
::getKey('CRM_Activity_BAO_Activity', 'activity_type_id', 'Email')) {
542 $url = CRM_Utils_System
::url('civicrm/activity', $q);
543 if ($activity->activity_type_id
== CRM_Core_PseudoConstant
::getKey('CRM_Activity_BAO_Activity', 'activity_type_id', 'Print PDF Letter')) {
544 $recentOther['editUrl'] = CRM_Utils_System
::url('civicrm/activity/pdf/add',
545 "action=update&reset=1&id={$activity->id}&atype={$activity->activity_type_id}&cid={$params['source_contact_id']}&context=home"
549 $recentOther['editUrl'] = CRM_Utils_System
::url('civicrm/activity/add',
550 "action=update&reset=1&id={$activity->id}&atype={$activity->activity_type_id}&cid=" . CRM_Utils_Array
::value('source_contact_id', $params) . "&context=home"
554 if (CRM_Core_Permission
::check("delete activities")) {
555 $recentOther['deleteUrl'] = CRM_Utils_System
::url('civicrm/activity',
556 "action=delete&reset=1&id={$activity->id}&atype={$activity->activity_type_id}&cid=" . CRM_Utils_Array
::value('source_contact_id', $params) . "&context=home"
561 $url = CRM_Utils_System
::url('civicrm/activity/view', $q);
562 if (CRM_Core_Permission
::check('delete activities')) {
563 $recentOther['deleteUrl'] = CRM_Utils_System
::url('civicrm/activity',
564 "action=delete&reset=1&id={$activity->id}&atype={$activity->activity_type_id}&cid=" . CRM_Utils_Array
::value('source_contact_id', $params) . "&context=home"
570 if (!isset($activity->parent_id
)) {
571 $recentContactDisplay = CRM_Contact_BAO_Contact
::displayName($recentContactId);
572 // add the recently created Activity
573 $activityTypes = CRM_Activity_BAO_Activity
::buildOptions('activity_type_id');
574 $activitySubject = CRM_Core_DAO
::getFieldValue('CRM_Activity_DAO_Activity', $activity->id
, 'subject');
577 if (isset($activitySubject)) {
578 $title = $activitySubject . ' - ';
581 $title = $title . $recentContactDisplay;
582 if (!empty($activityTypes[$activity->activity_type_id
])) {
583 $title .= ' (' . $activityTypes[$activity->activity_type_id
] . ')';
586 CRM_Utils_Recent
::add($title,
591 $recentContactDisplay,
597 CRM_Contact_BAO_GroupContactCache
::opportunisticCacheFlush();
599 // if the subject contains a ‘[case #…]’ string, file that activity on the related case (CRM-5916)
601 $subjectToMatch = CRM_Utils_Array
::value('subject', $params);
602 if (preg_match('/\[case #([0-9a-h]{7})\]/', $subjectToMatch, $matches)) {
603 $key = CRM_Core_DAO
::escapeString(CIVICRM_SITE_KEY
);
605 $query = "SELECT id FROM civicrm_case WHERE SUBSTR(SHA1(CONCAT('$key', id)), 1, 7) = '" . CRM_Core_DAO
::escapeString($hash) . "'";
607 elseif (preg_match('/\[case #(\d+)\]/', $subjectToMatch, $matches)) {
608 $query = "SELECT id FROM civicrm_case WHERE id = '" . CRM_Core_DAO
::escapeString($matches[1]) . "'";
610 if (!empty($matches)) {
612 'activity_id' => $activity->id
,
613 'case_id' => CRM_Core_DAO
::singleValueQuery($query),
615 if ($caseParams['case_id']) {
616 CRM_Case_BAO_Case
::processCaseActivity($caseParams);
619 self
::logActivityAction($activity, "Case details for {$matches[1]} not found while recording an activity on case.");
622 if (!empty($params['id'])) {
623 CRM_Utils_Hook
::post('edit', 'Activity', $activity->id
, $activity);
626 CRM_Utils_Hook
::post('create', 'Activity', $activity->id
, $activity);
633 * Create an activity.
635 * @todo elaborate on what this does.
637 * @param CRM_Core_DAO_Activity $activity
638 * @param string $logMessage
642 public static function logActivityAction($activity, $logMessage = NULL) {
643 $id = CRM_Core_Session
::getLoggedInContactID();
645 $activityContacts = CRM_Activity_BAO_ActivityContact
::buildOptions('record_type_id', 'validate');
646 $sourceID = CRM_Utils_Array
::key('Activity Source', $activityContacts);
647 $id = self
::getActivityContact($activity->id
, $sourceID);
650 'entity_table' => 'civicrm_activity',
651 'entity_id' => $activity->id
,
652 'modified_id' => $id,
653 'modified_date' => date('YmdHis'),
654 'data' => $logMessage,
656 CRM_Core_BAO_Log
::add($logParams);
661 * Get the list Activities.
663 * @param array $params
664 * Array of parameters.
666 * - contact_id int contact_id whose activities we want to retrieve
667 * - offset int which row to start from ?
668 * - rowCount int how many rows to fetch
669 * - sort object|array object or array describing sort order for sql query.
670 * - admin boolean if contact is admin
671 * - caseId int case ID
672 * - context string page on which selector is build
673 * - activity_type_id int|string the activitiy types we want to restrict by
676 * Relevant data object values of open activities
677 * @throws \CiviCRM_API3_Exception
679 public static function getActivities($params) {
680 $activities = array();
682 // Activity.Get API params
683 $activityParams = self
::getActivityParamsForDashboardFunctions($params);
685 if (!empty($params['rowCount']) &&
686 $params['rowCount'] > 0
688 $activityParams['options']['limit'] = $params['rowCount'];
691 if (!empty($params['sort'])) {
692 if (is_a($params['sort'], 'CRM_Utils_Sort')) {
693 $order = $params['sort']->orderBy();
695 elseif (trim($params['sort'])) {
696 $order = CRM_Utils_Type
::escape($params['sort'], 'String');
700 $activityParams['options']['sort'] = empty($order) ?
"activity_date_time DESC" : str_replace('activity_type ', 'activity_type_id.label ', $order);
702 $activityParams['return'] = [
703 'activity_date_time',
706 'source_contact_name',
707 'assignee_contact_id',
709 'target_contact_name',
710 'assignee_contact_name',
718 foreach (['case_id' => 'CiviCase', 'campaign_id' => 'CiviCampaign'] as $attr => $component) {
719 if (in_array($component, self
::activityComponents())) {
720 $activityParams['return'][] = $attr;
723 $result = civicrm_api3('Activity', 'Get', $activityParams);
725 $bulkActivityTypeID = CRM_Core_PseudoConstant
::getKey('CRM_Activity_BAO_Activity', 'activity_type_id', 'Bulk Email');
726 $allCampaigns = CRM_Campaign_BAO_Campaign
::getCampaigns(NULL, NULL, FALSE, FALSE, FALSE, TRUE);
728 // CRM-3553, need to check user has access to target groups.
729 $mailingIDs = CRM_Mailing_BAO_Mailing
::mailingACLIDs();
730 $accessCiviMail = ((CRM_Core_Permission
::check('access CiviMail')) ||
731 (CRM_Mailing_Info
::workflowEnabled() && CRM_Core_Permission
::check('create mailings'))
734 $mappingParams = array(
735 'id' => 'activity_id',
736 'source_record_id' => 'source_record_id',
737 'activity_type_id' => 'activity_type_id',
738 'activity_date_time' => 'activity_date_time',
739 'status_id' => 'status_id',
740 'subject' => 'subject',
741 'campaign_id' => 'campaign_id',
742 'assignee_contact_name' => 'assignee_contact_name',
743 'target_contact_name' => 'target_contact_name',
744 'source_contact_id' => 'source_contact_id',
745 'source_contact_name' => 'source_contact_name',
746 'case_id' => 'case_id',
749 foreach ($result['values'] as $id => $activity) {
751 $activities[$id] = array();
753 $isBulkActivity = (!$bulkActivityTypeID ||
($bulkActivityTypeID === $activity['activity_type_id']));
755 foreach ($mappingParams as $apiKey => $expectedName) {
756 if (in_array($apiKey, array('assignee_contact_name', 'target_contact_name'))) {
757 $activities[$id][$expectedName] = CRM_Utils_Array
::value($apiKey, $activity, array());
758 if ($apiKey == 'target_contact_name' && count($activity['target_contact_name'])) {
759 $activities[$id]['target_contact_counter'] = count($activity['target_contact_name']);
762 if ($isBulkActivity) {
763 $activities[$id]['recipients'] = ts('(%1 recipients)', array(1 => count($activity['target_contact_name'])));
764 $activities[$id]['mailingId'] = FALSE;
765 if ($accessCiviMail &&
766 ($mailingIDs === TRUE ||
in_array($activity['source_record_id'], $mailingIDs))
768 $activities[$id]['mailingId'] = TRUE;
772 // case related fields
773 elseif ($apiKey == 'case_id' && !$isBulkActivity) {
774 $activities[$id][$expectedName] = CRM_Utils_Array
::value($apiKey, $activity);
776 // fetch case subject for case ID found
777 if (!empty($activity['case_id'])) {
778 $activities[$id]['case_subject'] = CRM_Core_DAO
::executeQuery('CRM_Case_DAO_Case', $activity['case_id'], 'subject');
782 $activities[$id][$expectedName] = CRM_Utils_Array
::value($apiKey, $activity);
783 if ($apiKey == 'activity_type_id') {
784 $activities[$id]['activity_type'] = CRM_Core_PseudoConstant
::getName('CRM_Activity_BAO_Activity', 'activity_type_id', $activities[$id][$expectedName]);
786 elseif ($apiKey == 'campaign_id') {
787 $activities[$id]['campaign'] = CRM_Utils_Array
::value($activities[$id][$expectedName], $allCampaigns);
791 // if deleted, wrap in <del>
792 if (!empty($activity['source_contact_id']) &&
793 CRM_Core_DAO
::getFieldValue('CRM_Contact_DAO_Contact', $activity['source_contact_id'], 'is_deleted')
795 $activities[$id]['source_contact_name'] = sprintf("<del>%s<del>", $activity['source_contact_name']);
797 $activities[$id]['is_recurring_activity'] = CRM_Core_BAO_RecurringEntity
::getParentFor($id, 'civicrm_activity');
804 * Filter the activity types to only return the ones we actually asked for
805 * Uses params['activity_type_id'] and params['activity_type_exclude_id']
808 * @return array|null (Use in Activity.get API activity_type_id)
810 public static function filterActivityTypes($params) {
811 $activityTypes = array();
813 // If no activity types are specified, get all the active ones
814 if (empty($params['activity_type_id'])) {
815 $activityTypes = CRM_Activity_BAO_Activity
::buildOptions('activity_type_id', 'get');
818 // If no activity types are specified or excluded, return the list of all active ones
819 if (empty($params['activity_type_id']) && empty($params['activity_type_exclude_id'])) {
820 if (!empty($activityTypes)) {
821 return array('IN' => array_keys($activityTypes));
826 // If we have specified activity types, build a list to return, excluding the ones we don't want.
827 if (!empty($params['activity_type_id'])) {
828 if (!is_array($params['activity_type_id'])) {
829 // Turn it into array if only one specified, so we don't duplicate processing below
830 $params['activity_type_id'] = array($params['activity_type_id'] => $params['activity_type_id']);
832 foreach ($params['activity_type_id'] as $value) {
833 // Add each activity type that was specified to list
834 $value = CRM_Utils_Type
::escape($value, 'Positive');
835 $activityTypes[$value] = $value;
839 // Build the list of activity types to exclude (from $params['activity_type_exclude_id'])
840 if (!empty($params['activity_type_exclude_id'])) {
841 if (!is_array($params['activity_type_exclude_id'])) {
842 // Turn it into array if only one specified, so we don't duplicate processing below
843 $params['activity_type_exclude_id'] = array($params['activity_type_exclude_id'] => $params['activity_type_exclude_id']);
845 foreach ($params['activity_type_exclude_id'] as $value) {
846 // Remove each activity type from list if it should be excluded
847 $value = CRM_Utils_Type
::escape($value, 'Positive');
848 if (array_key_exists($value, $activityTypes)) {
849 unset($activityTypes[$value]);
854 return array('IN' => array_keys($activityTypes));
858 * Get the list Activities.
862 * @todo - use the api for this - this is working but have temporarily backed out
863 * due to performance issue to be resolved - CRM-20481.
865 * @param array $input
866 * Array of parameters.
868 * - contact_id int contact_id whose activities we want to retrieve
869 * - offset int which row to start from ?
870 * - rowCount int how many rows to fetch
871 * - sort object|array object or array describing sort order for sql query.
872 * - admin boolean if contact is admin
873 * - caseId int case ID
874 * - context string page on which selector is build
875 * - activity_type_id int|string the activitiy types we want to restrict by
878 * Relevant data object values of open activities
880 public static function deprecatedGetActivities($input) {
881 // Step 1: Get the basic activity data.
882 $bulkActivityTypeID = CRM_Core_PseudoConstant
::getKey('CRM_Activity_BAO_Activity',
887 $activityContacts = CRM_Activity_BAO_ActivityContact
::buildOptions('record_type_id', 'validate');
888 $sourceID = CRM_Utils_Array
::key('Activity Source', $activityContacts);
889 $assigneeID = CRM_Utils_Array
::key('Activity Assignees', $activityContacts);
890 $targetID = CRM_Utils_Array
::key('Activity Targets', $activityContacts);
892 $config = CRM_Core_Config
::singleton();
894 $activityTempTable = CRM_Utils_SQL_TempTable
::build()->setCategory('actdetail')->getName();
896 $tableFields = array(
897 'activity_id' => 'int unsigned',
898 'activity_date_time' => 'datetime',
899 'source_record_id' => 'int unsigned',
900 'status_id' => 'int unsigned',
901 'subject' => 'varchar(255)',
902 'source_contact_name' => 'varchar(255)',
903 'activity_type_id' => 'int unsigned',
904 'activity_type' => 'varchar(128)',
905 'case_id' => 'int unsigned',
906 'case_subject' => 'varchar(255)',
907 'campaign_id' => 'int unsigned',
910 $sql = "CREATE TEMPORARY TABLE {$activityTempTable} ( ";
911 $insertValueSQL = $selectColumns = array();
912 // The activityTempTable contains the sorted rows
913 // so in order to maintain the sort order as-is we add an auto_increment
914 // field; we can sort by this later to ensure the sort order stays correct.
915 $sql .= " fixed_sort_order INT UNSIGNED NOT NULL AUTO_INCREMENT PRIMARY KEY,";
916 foreach ($tableFields as $name => $desc) {
917 $sql .= "$name $desc,\n";
918 $insertValueSQL[] = $name;
919 if ($name == 'source_contact_name' && CRM_Utils_SQL
::supportsFullGroupBy()) {
920 $selectColumns[] = "ANY_VALUE(tbl.$name)";
923 $selectColumns[] = "tbl.$name";
927 // add unique key on activity_id just to be sure
928 // this cannot be primary key because we need that for the auto_increment
929 // fixed_sort_order field
931 UNIQUE KEY ( activity_id )
932 ) ENGINE=HEAP DEFAULT CHARACTER SET utf8 COLLATE utf8_unicode_ci
935 CRM_Core_DAO
::executeQuery($sql);
937 $insertSQL = "INSERT IGNORE INTO {$activityTempTable} (" . implode(',', $insertValueSQL) . " ) ";
939 $order = $limit = $groupBy = '';
940 $groupBy = " GROUP BY tbl.activity_id, tbl.activity_type, tbl.case_id, tbl.case_subject ";
942 if (!empty($input['sort'])) {
943 if (is_a($input['sort'], 'CRM_Utils_Sort')) {
944 $orderBy = $input['sort']->orderBy();
945 if (!empty($orderBy)) {
946 $order = " ORDER BY $orderBy";
949 elseif (trim($input['sort'])) {
950 $sort = CRM_Utils_Type
::escape($input['sort'], 'String');
951 $order = " ORDER BY $sort ";
956 // context = 'activity' in Activities tab.
957 $order = " ORDER BY tbl.activity_date_time desc ";
960 if (!empty($input['rowCount']) &&
961 $input['rowCount'] > 0
963 $limit = " LIMIT {$input['offset']}, {$input['rowCount']} ";
966 $input['count'] = FALSE;
967 list($sqlClause, $params) = self
::deprecatedGetActivitySQLClause($input);
969 $query = sprintf("{$insertSQL} \n SELECT DISTINCT %s from ( %s ) \n as tbl ", implode(', ', $selectColumns), $sqlClause);
971 // Filter case activities - CRM-5761.
972 $components = self
::activityComponents();
973 if (!in_array('CiviCase', $components)) {
975 LEFT JOIN civicrm_case_activity ON ( civicrm_case_activity.activity_id = tbl.activity_id )
976 WHERE civicrm_case_activity.id IS NULL";
979 $query = $query . $groupBy . $order . $limit;
981 $dao = CRM_Core_DAO
::executeQuery($query, $params);
983 // step 2: Get target and assignee contacts for above activities
984 // create temp table for target contacts
985 $activityContactTempTable = CRM_Utils_SQL_TempTable
::build()->setCategory('actcontact')->getName();
986 $query = "CREATE TEMPORARY TABLE {$activityContactTempTable} (
987 activity_id int unsigned, contact_id int unsigned, record_type_id varchar(16),
988 contact_name varchar(255), is_deleted int unsigned, counter int unsigned, INDEX index_activity_id( activity_id ) )
989 ENGINE=InnoDB DEFAULT CHARACTER SET utf8 COLLATE utf8_unicode_ci";
991 CRM_Core_DAO
::executeQuery($query);
993 // note that we ignore bulk email for targets, since we don't show it in selector
995 INSERT INTO {$activityContactTempTable} ( activity_id, contact_id, record_type_id, contact_name, is_deleted )
996 SELECT ac.activity_id,
1001 FROM {$activityTempTable}
1002 INNER JOIN civicrm_activity a ON ( a.id = {$activityTempTable}.activity_id )
1003 INNER JOIN civicrm_activity_contact ac ON ( ac.activity_id = {$activityTempTable}.activity_id )
1004 INNER JOIN civicrm_contact c ON c.id = ac.contact_id
1005 WHERE ac.record_type_id != %1
1007 $params = array(1 => array($targetID, 'Integer'));
1008 CRM_Core_DAO
::executeQuery($query, $params);
1010 $activityFields = array("ac.activity_id", "ac.contact_id", "ac.record_type_id", "c.sort_name", "c.is_deleted");
1011 $select = CRM_Contact_BAO_Query
::appendAnyValueToSelect($activityFields, "ac.activity_id");
1013 // for each activity insert one target contact
1014 // if we load all target contacts the performance will suffer a lot for mass-activities.
1016 INSERT INTO {$activityContactTempTable} ( activity_id, contact_id, record_type_id, contact_name, is_deleted, counter )
1017 {$select}, count(ac.contact_id)
1018 FROM {$activityTempTable}
1019 INNER JOIN civicrm_activity a ON ( a.id = {$activityTempTable}.activity_id )
1020 INNER JOIN civicrm_activity_contact ac ON ( ac.activity_id = {$activityTempTable}.activity_id )
1021 INNER JOIN civicrm_contact c ON c.id = ac.contact_id
1022 WHERE ac.record_type_id = %1
1023 GROUP BY ac.activity_id
1026 CRM_Core_DAO
::executeQuery($query, $params);
1028 // step 3: Combine all temp tables to get final query for activity selector
1029 // sort by the original sort order, stored in fixed_sort_order
1031 SELECT {$activityTempTable}.*,
1032 {$activityContactTempTable}.contact_id,
1033 {$activityContactTempTable}.record_type_id,
1034 {$activityContactTempTable}.contact_name,
1035 {$activityContactTempTable}.is_deleted,
1036 {$activityContactTempTable}.counter,
1037 re.parent_id as is_recurring_activity
1038 FROM {$activityTempTable}
1039 INNER JOIN {$activityContactTempTable} on {$activityTempTable}.activity_id = {$activityContactTempTable}.activity_id
1040 LEFT JOIN civicrm_recurring_entity re on {$activityContactTempTable}.activity_id = re.entity_id
1041 ORDER BY fixed_sort_order
1044 $dao = CRM_Core_DAO
::executeQuery($query);
1046 // CRM-3553, need to check user has access to target groups.
1047 $mailingIDs = CRM_Mailing_BAO_Mailing
::mailingACLIDs();
1049 (CRM_Core_Permission
::check('access CiviMail')) ||
1050 (CRM_Mailing_Info
::workflowEnabled() &&
1051 CRM_Core_Permission
::check('create mailings'))
1054 // Get all campaigns.
1055 $allCampaigns = CRM_Campaign_BAO_Campaign
::getCampaigns(NULL, NULL, FALSE, FALSE, FALSE, TRUE);
1057 while ($dao->fetch()) {
1058 $activityID = $dao->activity_id
;
1059 $values[$activityID]['activity_id'] = $dao->activity_id
;
1060 $values[$activityID]['source_record_id'] = $dao->source_record_id
;
1061 $values[$activityID]['activity_type_id'] = $dao->activity_type_id
;
1062 $values[$activityID]['activity_type'] = $dao->activity_type
;
1063 $values[$activityID]['activity_date_time'] = $dao->activity_date_time
;
1064 $values[$activityID]['status_id'] = $dao->status_id
;
1065 $values[$activityID]['subject'] = $dao->subject
;
1066 $values[$activityID]['campaign_id'] = $dao->campaign_id
;
1067 $values[$activityID]['is_recurring_activity'] = $dao->is_recurring_activity
;
1069 if ($dao->campaign_id
) {
1070 $values[$activityID]['campaign'] = $allCampaigns[$dao->campaign_id
];
1073 if (empty($values[$activityID]['assignee_contact_name'])) {
1074 $values[$activityID]['assignee_contact_name'] = array();
1077 if (empty($values[$activityID]['target_contact_name'])) {
1078 $values[$activityID]['target_contact_name'] = array();
1079 $values[$activityID]['target_contact_counter'] = $dao->counter
;
1082 // if deleted, wrap in <del>
1083 if ($dao->is_deleted
) {
1084 $dao->contact_name
= "<del>{$dao->contact_name}</del>";
1087 if ($dao->record_type_id
== $sourceID && $dao->contact_id
) {
1088 $values[$activityID]['source_contact_id'] = $dao->contact_id
;
1089 $values[$activityID]['source_contact_name'] = $dao->contact_name
;
1092 if (!$bulkActivityTypeID ||
($bulkActivityTypeID != $dao->activity_type_id
)) {
1093 // build array of target / assignee names
1094 if ($dao->record_type_id
== $targetID && $dao->contact_id
) {
1095 $values[$activityID]['target_contact_name'][$dao->contact_id
] = $dao->contact_name
;
1097 if ($dao->record_type_id
== $assigneeID && $dao->contact_id
) {
1098 $values[$activityID]['assignee_contact_name'][$dao->contact_id
] = $dao->contact_name
;
1101 // case related fields
1102 $values[$activityID]['case_id'] = $dao->case_id
;
1103 $values[$activityID]['case_subject'] = $dao->case_subject
;
1106 $values[$activityID]['recipients'] = ts('(%1 recipients)', array(1 => $dao->counter
));
1107 $values[$activityID]['mailingId'] = FALSE;
1110 ($mailingIDs === TRUE ||
in_array($dao->source_record_id
, $mailingIDs))
1112 $values[$activityID]['mailingId'] = TRUE;
1121 * Get an array of components that are accessible by the currenct user.
1123 * This means checking if they are enabled and if the user has appropriate permission.
1125 * For most components the permission is access component (e.g 'access CiviContribute').
1126 * Exceptions as CiviCampaign (administer CiviCampaign) and CiviCase
1127 * (accesses a case function which enforces edit all cases or edit my cases. Case
1128 * permissions are also handled on a per activity basis).
1130 * Checks whether logged in user has permission to the component.
1132 * @param bool $excludeComponentHandledActivities
1133 * Should we exclude components whose display is handled in the components.
1134 * In practice this means should we include CiviCase in the results. Presumbaly
1135 * at the time it was decided case activities should be shown in the case framework and
1136 * that this concept might be extended later. In practice most places that
1137 * call this then re-add CiviCase in some way so it's all a bit... odd.
1139 * @return array Array of component id and name.
1140 * Array of component id and name.
1142 public static function activityComponents($excludeComponentHandledActivities = TRUE) {
1143 $components = array();
1144 $compInfo = CRM_Core_Component
::getEnabledComponents();
1145 foreach ($compInfo as $compObj) {
1146 $includeComponent = !$excludeComponentHandledActivities ||
!empty($compObj->info
['showActivitiesInCore']);
1147 if ($includeComponent) {
1148 if ($compObj->info
['name'] == 'CiviCampaign') {
1149 $componentPermission = "administer {$compObj->name}";
1152 $componentPermission = "access {$compObj->name}";
1154 if ($compObj->info
['name'] == 'CiviCase') {
1155 if (CRM_Case_BAO_Case
::accessCiviCase()) {
1156 $components[$compObj->componentID
] = $compObj->info
['name'];
1159 elseif (CRM_Core_Permission
::check($componentPermission)) {
1160 $components[$compObj->componentID
] = $compObj->info
['name'];
1169 * Get the activity Count.
1171 * @param array $input
1172 * Array of parameters.
1174 * - contact_id int contact_id whose activities we want to retrieve
1175 * - admin boolean if contact is admin
1176 * - caseId int case ID
1177 * - context string page on which selector is build
1178 * - activity_type_id int|string the activity types we want to restrict by
1181 * count of activities
1183 public static function getActivitiesCount($input) {
1184 $activityParams = self
::getActivityParamsForDashboardFunctions($input);
1185 return civicrm_api3('Activity', 'getcount', $activityParams);
1189 * Get the activity Count.
1193 * @param array $input
1194 * Array of parameters.
1196 * - contact_id int contact_id whose activities we want to retrieve
1197 * - admin boolean if contact is admin
1198 * - caseId int case ID
1199 * - context string page on which selector is build
1200 * - activity_type_id int|string the activity types we want to restrict by
1203 * count of activities
1205 public static function deprecatedGetActivitiesCount($input) {
1206 $input['count'] = TRUE;
1207 list($sqlClause, $params) = self
::deprecatedGetActivitySQLClause($input);
1209 //filter case activities - CRM-5761
1210 $components = self
::activityComponents();
1211 if (!in_array('CiviCase', $components)) {
1213 SELECT COUNT(DISTINCT(tbl.activity_id)) as count
1214 FROM ( {$sqlClause} ) as tbl
1215 LEFT JOIN civicrm_case_activity ON ( civicrm_case_activity.activity_id = tbl.activity_id )
1216 WHERE civicrm_case_activity.id IS NULL";
1219 $query = "SELECT COUNT(DISTINCT(activity_id)) as count from ( {$sqlClause} ) as tbl";
1222 return CRM_Core_DAO
::singleValueQuery($query, $params);
1226 * Get the activity sql clause to pick activities.
1230 * @param array $input
1231 * Array of parameters.
1233 * - contact_id int contact_id whose activities we want to retrieve
1234 * - admin boolean if contact is admin
1235 * - caseId int case ID
1236 * - context string page on which selector is build
1237 * - count boolean are we interested in the count clause only?
1238 * - activity_type_id int|string the activity types we want to restrict by
1241 * count of activities
1243 public static function deprecatedGetActivitySQLClause($input) {
1245 $sourceWhere = $targetWhere = $assigneeWhere = $caseWhere = 1;
1247 $config = CRM_Core_Config
::singleton();
1248 if (!CRM_Utils_Array
::value('admin', $input, FALSE)) {
1249 $sourceWhere = ' ac.contact_id = %1 ';
1250 $caseWhere = ' civicrm_case_contact.contact_id = %1 ';
1252 $params = array(1 => array($input['contact_id'], 'Integer'));
1255 $commonClauses = array(
1256 "civicrm_option_group.name = 'activity_type'",
1257 "civicrm_activity.is_deleted = 0",
1258 "civicrm_activity.is_current_revision = 1",
1259 "civicrm_activity.is_test= 0",
1262 if (isset($input['activity_date_relative']) ||
1263 (!empty($input['activity_date_low']) ||
!empty($input['activity_date_high']))
1265 list($from, $to) = CRM_Utils_Date
::getFromTo(
1266 CRM_Utils_Array
::value('activity_date_relative', $input, 0),
1267 CRM_Utils_Array
::value('activity_date_low', $input),
1268 CRM_Utils_Array
::value('activity_date_high', $input)
1270 $commonClauses[] = sprintf('civicrm_activity.activity_date_time BETWEEN "%s" AND "%s" ', $from, $to);
1273 if (!empty($input['activity_status_id'])) {
1274 $commonClauses[] = sprintf("civicrm_activity.status_id IN (%s)", $input['activity_status_id']);
1277 // Filter on component IDs.
1278 $components = self
::activityComponents();
1279 if (!empty($components)) {
1280 $componentsIn = implode(',', array_keys($components));
1281 $commonClauses[] = "( civicrm_option_value.component_id IS NULL OR civicrm_option_value.component_id IN ( $componentsIn ) )";
1284 $commonClauses[] = "civicrm_option_value.component_id IS NULL";
1287 // activity type ID clause
1288 if (!empty($input['activity_type_id'])) {
1289 if (is_array($input['activity_type_id'])) {
1290 foreach ($input['activity_type_id'] as $idx => $value) {
1291 $input['activity_type_id'][$idx] = CRM_Utils_Type
::escape($value, 'Positive');
1293 $commonClauses[] = "civicrm_activity.activity_type_id IN ( " . implode(",", $input['activity_type_id']) . " ) ";
1296 $activityTypeID = CRM_Utils_Type
::escape($input['activity_type_id'], 'Positive');
1297 $commonClauses[] = "civicrm_activity.activity_type_id = $activityTypeID";
1301 // exclude by activity type clause
1302 if (!empty($input['activity_type_exclude_id'])) {
1303 if (is_array($input['activity_type_exclude_id'])) {
1304 foreach ($input['activity_type_exclude_id'] as $idx => $value) {
1305 $input['activity_type_exclude_id'][$idx] = CRM_Utils_Type
::escape($value, 'Positive');
1307 $commonClauses[] = "civicrm_activity.activity_type_id NOT IN ( " . implode(",", $input['activity_type_exclude_id']) . " ) ";
1310 $activityTypeID = CRM_Utils_Type
::escape($input['activity_type_exclude_id'], 'Positive');
1311 $commonClauses[] = "civicrm_activity.activity_type_id != $activityTypeID";
1315 $commonClause = implode(' AND ', $commonClauses);
1317 $includeCaseActivities = FALSE;
1318 if (in_array('CiviCase', $components)) {
1319 $includeCaseActivities = TRUE;
1322 // build main activity table select clause
1325 $activityContacts = CRM_Activity_BAO_ActivityContact
::buildOptions('record_type_id', 'validate');
1326 $sourceID = CRM_Utils_Array
::key('Activity Source', $activityContacts);
1328 INNER JOIN civicrm_activity_contact ac ON ac.activity_id = civicrm_activity.id
1329 INNER JOIN civicrm_contact contact ON ac.contact_id = contact.id
1332 if (!$input['count']) {
1334 civicrm_activity.activity_date_time,
1335 civicrm_activity.source_record_id,
1336 civicrm_activity.status_id,
1337 civicrm_activity.subject,
1338 contact.sort_name as source_contact_name,
1339 civicrm_option_value.value as activity_type_id,
1340 civicrm_option_value.label as activity_type,
1341 null as case_id, null as case_subject,
1342 civicrm_activity.campaign_id as campaign_id
1346 LEFT JOIN civicrm_activity_contact src ON (src.activity_id = ac.activity_id AND src.record_type_id = {$sourceID} AND src.contact_id = contact.id)
1351 SELECT civicrm_activity.id as activity_id
1353 from civicrm_activity
1354 left join civicrm_option_value on
1355 civicrm_activity.activity_type_id = civicrm_option_value.value
1356 left join civicrm_option_group on
1357 civicrm_option_group.id = civicrm_option_value.option_group_id
1364 // Build case clause
1365 // or else exclude Inbound Emails that have been filed on a case.
1368 if ($includeCaseActivities) {
1370 if (!$input['count']) {
1372 civicrm_activity.activity_date_time,
1373 civicrm_activity.source_record_id,
1374 civicrm_activity.status_id,
1375 civicrm_activity.subject,
1376 contact.sort_name as source_contact_name,
1377 civicrm_option_value.value as activity_type_id,
1378 civicrm_option_value.label as activity_type,
1379 null as case_id, null as case_subject,
1380 civicrm_activity.campaign_id as campaign_id';
1386 SELECT civicrm_activity.id as activity_id
1388 from civicrm_activity
1389 inner join civicrm_case_activity on
1390 civicrm_case_activity.activity_id = civicrm_activity.id
1391 inner join civicrm_case on
1392 civicrm_case_activity.case_id = civicrm_case.id
1393 inner join civicrm_case_contact on
1394 civicrm_case_contact.case_id = civicrm_case.id and {$caseWhere}
1395 left join civicrm_option_value on
1396 civicrm_activity.activity_type_id = civicrm_option_value.value
1397 left join civicrm_option_group on
1398 civicrm_option_group.id = civicrm_option_value.option_group_id
1403 and ( ( civicrm_case_activity.case_id IS NULL ) OR
1404 ( civicrm_option_value.name <> 'Inbound Email' AND
1405 civicrm_option_value.name <> 'Email' AND civicrm_case_activity.case_id
1411 $returnClause = " {$sourceClause} {$caseClause} ";
1413 return array($returnClause, $params);
1417 * Send the message to all the contacts.
1419 * Also insert a contact activity in each contacts record.
1421 * @param array $contactDetails
1422 * The array of contact details to send the email.
1423 * @param string $subject
1424 * The subject of the message.
1427 * @param string $emailAddress
1428 * Use this 'to' email address instead of the default Primary address.
1429 * @param int $userID
1430 * Use this userID if set.
1431 * @param string $from
1432 * @param array $attachments
1433 * The array of attachments if any.
1436 * @param string $bcc
1438 * @param array $contactIds
1440 * @param string $additionalDetails
1441 * The additional information of CC and BCC appended to the activity Details.
1442 * @param array $contributionIds
1443 * @param int $campaignId
1446 * ( sent, activityId) if any email is sent and activityId
1448 public static function sendEmail(
1456 $attachments = NULL,
1460 $additionalDetails = NULL,
1461 $contributionIds = NULL,
1464 // get the contact details of logged in contact, which we set as from email
1465 if ($userID == NULL) {
1466 $userID = CRM_Core_Session
::getLoggedInContactID();
1469 list($fromDisplayName, $fromEmail, $fromDoNotEmail) = CRM_Contact_BAO_Contact
::getContactDetails($userID);
1471 return array(count($contactDetails), 0, count($contactDetails));
1473 if (!trim($fromDisplayName)) {
1474 $fromDisplayName = $fromEmail;
1478 // token replacement of addressee/email/postal greetings
1479 // get the tokens added in subject and message
1480 $subjectToken = CRM_Utils_Token
::getTokens($subject);
1481 $messageToken = CRM_Utils_Token
::getTokens($text);
1482 $messageToken = array_merge($messageToken, CRM_Utils_Token
::getTokens($html));
1483 $allTokens = array_merge($messageToken, $subjectToken);
1486 $from = "$fromDisplayName <$fromEmail>";
1489 //create the meta level record first ( email activity )
1490 $activityTypeID = CRM_Core_PseudoConstant
::getKey('CRM_Activity_BAO_Activity', 'activity_type_id', 'Email');
1492 // CRM-6265: save both text and HTML parts in details (if present)
1493 if ($html and $text) {
1494 $details = "-ALTERNATIVE ITEM 0-\n$html$additionalDetails\n-ALTERNATIVE ITEM 1-\n$text$additionalDetails\n-ALTERNATIVE END-\n";
1497 $details = $html ?
$html : $text;
1498 $details .= $additionalDetails;
1501 $activityParams = array(
1502 'source_contact_id' => $userID,
1503 'activity_type_id' => $activityTypeID,
1504 'activity_date_time' => date('YmdHis'),
1505 'subject' => $subject,
1506 'details' => $details,
1507 // FIXME: check for name Completed and get ID from that lookup
1508 'status_id' => CRM_Core_PseudoConstant
::getKey('CRM_Activity_BAO_Activity', 'status_id', 'Completed'),
1509 'campaign_id' => $campaignId,
1512 // CRM-5916: strip [case #…] before saving the activity (if present in subject)
1513 $activityParams['subject'] = preg_replace('/\[case #([0-9a-h]{7})\] /', '', $activityParams['subject']);
1515 // add the attachments to activity params here
1517 // first process them
1518 $activityParams = array_merge($activityParams,
1523 $activity = self
::create($activityParams);
1525 // get the set of attachments from where they are stored
1526 $attachments = CRM_Core_BAO_File
::getEntityFile('civicrm_activity',
1529 $returnProperties = array();
1530 if (isset($messageToken['contact'])) {
1531 foreach ($messageToken['contact'] as $key => $value) {
1532 $returnProperties[$value] = 1;
1536 if (isset($subjectToken['contact'])) {
1537 foreach ($subjectToken['contact'] as $key => $value) {
1538 if (!isset($returnProperties[$value])) {
1539 $returnProperties[$value] = 1;
1544 // get token details for contacts, call only if tokens are used
1546 if (!empty($returnProperties) ||
!empty($tokens) ||
!empty($allTokens)) {
1547 list($details) = CRM_Utils_Token
::getTokenDetails(
1552 'CRM_Activity_BAO_Activity'
1558 CRM_Utils_Hook
::tokens($tokens);
1559 $categories = array_keys($tokens);
1561 $escapeSmarty = FALSE;
1562 if (defined('CIVICRM_MAIL_SMARTY') && CIVICRM_MAIL_SMARTY
) {
1563 $smarty = CRM_Core_Smarty
::singleton();
1564 $escapeSmarty = TRUE;
1567 $contributionDetails = array();
1568 if (!empty($contributionIds)) {
1569 $contributionDetails = CRM_Contribute_BAO_Contribution
::replaceContributionTokens(
1580 $sent = $notSent = array();
1581 foreach ($contactDetails as $values) {
1582 $contactId = $values['contact_id'];
1583 $emailAddress = $values['email'];
1585 if (!empty($contributionDetails)) {
1586 $subject = $contributionDetails[$contactId]['subject'];
1587 $text = $contributionDetails[$contactId]['text'];
1588 $html = $contributionDetails[$contactId]['html'];
1591 if (!empty($details) && is_array($details["{$contactId}"])) {
1592 // unset email from details since it always returns primary email address
1593 unset($details["{$contactId}"]['email']);
1594 unset($details["{$contactId}"]['email_id']);
1595 $values = array_merge($values, $details["{$contactId}"]);
1598 $tokenSubject = CRM_Utils_Token
::replaceContactTokens($subject, $values, FALSE, $subjectToken, FALSE, $escapeSmarty);
1599 $tokenSubject = CRM_Utils_Token
::replaceHookTokens($tokenSubject, $values, $categories, FALSE, $escapeSmarty);
1602 if ($values['preferred_mail_format'] == 'Text' ||
$values['preferred_mail_format'] == 'Both') {
1603 $tokenText = CRM_Utils_Token
::replaceContactTokens($text, $values, FALSE, $messageToken, FALSE, $escapeSmarty);
1604 $tokenText = CRM_Utils_Token
::replaceHookTokens($tokenText, $values, $categories, FALSE, $escapeSmarty);
1610 if ($values['preferred_mail_format'] == 'HTML' ||
$values['preferred_mail_format'] == 'Both') {
1611 $tokenHtml = CRM_Utils_Token
::replaceContactTokens($html, $values, TRUE, $messageToken, FALSE, $escapeSmarty);
1612 $tokenHtml = CRM_Utils_Token
::replaceHookTokens($tokenHtml, $values, $categories, TRUE, $escapeSmarty);
1618 if (defined('CIVICRM_MAIL_SMARTY') && CIVICRM_MAIL_SMARTY
) {
1619 // also add the contact tokens to the template
1620 $smarty->assign_by_ref('contact', $values);
1622 $tokenSubject = $smarty->fetch("string:$tokenSubject");
1623 $tokenText = $smarty->fetch("string:$tokenText");
1624 $tokenHtml = $smarty->fetch("string:$tokenHtml");
1628 if (self
::sendMessage(
1646 return array($sent, $activity->id
);
1650 * Send SMS. Returns: bool $sent, int $activityId, int $success (number of sent SMS)
1652 * @param array $contactDetails
1653 * @param array $activityParams
1654 * @param array $smsProviderParams
1655 * @param array $contactIds
1656 * @param int $sourceContactId This is the source contact Id
1658 * @return array(bool $sent, int $activityId, int $success)
1659 * @throws CRM_Core_Exception
1661 public static function sendSMS(
1662 &$contactDetails = NULL,
1664 &$smsProviderParams = array(),
1665 &$contactIds = NULL,
1666 $sourceContactId = NULL
1668 if (!CRM_Core_Permission
::check('send SMS')) {
1669 throw new CRM_Core_Exception("You do not have the 'send SMS' permission");
1672 if (!isset($contactDetails) && !isset($contactIds)) {
1673 Throw new CRM_Core_Exception('You must specify either $contactDetails or $contactIds');
1675 // Populate $contactDetails and $contactIds if only one is set
1676 if (is_array($contactIds) && !empty($contactIds) && empty($contactDetails)) {
1677 foreach ($contactIds as $id) {
1679 $contactDetails[] = civicrm_api3('Contact', 'getsingle', array('contact_id' => $id));
1681 catch (Exception
$e) {
1682 // Contact Id doesn't exist
1686 elseif (is_array($contactDetails) && !empty($contactDetails) && empty($contactIds)) {
1687 foreach ($contactDetails as $contact) {
1688 $contactIds[] = $contact['contact_id'];
1692 // Get logged in User Id
1693 if (empty($sourceContactId)) {
1694 $sourceContactId = CRM_Core_Session
::getLoggedInContactID();
1697 $text = &$activityParams['sms_text_message'];
1699 // Create the meta level record first ( sms activity )
1700 $activityParams = array(
1701 'source_contact_id' => $sourceContactId,
1702 'activity_type_id' => CRM_Core_PseudoConstant
::getKey('CRM_Activity_BAO_Activity', 'activity_type_id', 'SMS'),
1703 'activity_date_time' => date('YmdHis'),
1704 'subject' => $activityParams['activity_subject'],
1706 'status_id' => CRM_Core_PseudoConstant
::getKey('CRM_Activity_BAO_Activity', 'status_id', 'Completed'),
1708 $activity = self
::create($activityParams);
1709 $activityID = $activity->id
;
1712 // token replacement of addressee/email/postal greetings
1713 // get the tokens added in subject and message
1714 $messageToken = CRM_Utils_Token
::getTokens($text);
1715 $returnProperties = array();
1716 if (isset($messageToken['contact'])) {
1717 foreach ($messageToken['contact'] as $key => $value) {
1718 $returnProperties[$value] = 1;
1723 CRM_Utils_Hook
::tokens($tokens);
1724 $categories = array_keys($tokens);
1725 // get token details for contacts, call only if tokens are used
1726 $tokenDetails = array();
1727 if (!empty($returnProperties) ||
!empty($tokens)) {
1728 list($tokenDetails) = CRM_Utils_Token
::getTokenDetails($contactIds,
1732 'CRM_Activity_BAO_Activity'
1738 foreach ($contactDetails as $contact) {
1739 $contactId = $contact['contact_id'];
1742 if (!empty($tokenDetails) && is_array($tokenDetails["{$contactId}"])) {
1743 // unset phone from details since it always returns primary number
1744 unset($tokenDetails["{$contactId}"]['phone']);
1745 unset($tokenDetails["{$contactId}"]['phone_type_id']);
1746 $contact = array_merge($contact, $tokenDetails["{$contactId}"]);
1748 $tokenText = CRM_Utils_Token
::replaceContactTokens($text, $contact, FALSE, $messageToken, FALSE, FALSE);
1749 $tokenText = CRM_Utils_Token
::replaceHookTokens($tokenText, $contact, $categories, FALSE, FALSE);
1751 // Only send if the phone is of type mobile
1752 if ($contact['phone_type_id'] == CRM_Core_PseudoConstant
::getKey('CRM_Core_BAO_Phone', 'phone_type_id', 'Mobile')) {
1753 $smsProviderParams['To'] = $contact['phone'];
1756 $smsProviderParams['To'] = '';
1759 $doNotSms = CRM_Utils_Array
::value('do_not_sms', $contact, 0);
1762 $errMsgs[] = PEAR
::raiseError('Contact Does not accept SMS', NULL, PEAR_ERROR_RETURN
);
1765 $sendResult = self
::sendSMSMessage(
1773 if (PEAR
::isError($sendResult)) {
1774 // Collect all of the PEAR_Error objects
1775 $errMsgs[] = $sendResult;
1783 // If at least one message was sent and no errors
1784 // were generated then return a boolean value of TRUE.
1785 // Otherwise, return FALSE (no messages sent) or
1786 // and array of 1 or more PEAR_Error objects.
1788 if ($success > 0 && count($errMsgs) == 0) {
1791 elseif (count($errMsgs) > 0) {
1795 return array($sent, $activity->id
, $success);
1799 * Send the sms message to a specific contact.
1802 * The contact id of the recipient.
1804 * @param array $smsProviderParams
1805 * The params used for sending sms.
1806 * @param int $activityID
1807 * The activity ID that tracks the message.
1808 * @param int $sourceContactID
1810 * @return bool|PEAR_Error
1811 * true on success or PEAR_Error object
1813 public static function sendSMSMessage(
1816 $smsProviderParams = array(),
1818 $sourceContactID = NULL
1820 $toPhoneNumber = NULL;
1821 if ($smsProviderParams['To']) {
1822 // If phone number is specified use it
1823 $toPhoneNumber = trim($smsProviderParams['To']);
1826 // No phone number specified, so find a suitable one for the contact
1827 $filters = array('is_deceased' => 0, 'is_deleted' => 0, 'do_not_sms' => 0);
1828 $toPhoneNumbers = CRM_Core_BAO_Phone
::allPhones($toID, FALSE, 'Mobile', $filters);
1829 // To get primary mobile phonenumber, if not get the first mobile phonenumber
1830 if (!empty($toPhoneNumbers)) {
1831 $toPhoneNumberDetails = reset($toPhoneNumbers);
1832 $toPhoneNumber = CRM_Utils_Array
::value('phone', $toPhoneNumberDetails);
1833 // Contact allows to send sms
1837 // make sure both phone are valid
1838 // and that the recipient wants to receive sms
1839 if (empty($toPhoneNumber)) {
1840 return PEAR
::raiseError(
1841 'Recipient phone number is invalid or recipient does not want to receive SMS',
1847 $recipient = $toPhoneNumber;
1848 $smsProviderParams['contact_id'] = $toID;
1849 $smsProviderParams['parent_activity_id'] = $activityID;
1851 $providerObj = CRM_SMS_Provider
::singleton(array('provider_id' => $smsProviderParams['provider_id']));
1852 $sendResult = $providerObj->send($recipient, $smsProviderParams, $tokenText, NULL, $sourceContactID);
1853 if (PEAR
::isError($sendResult)) {
1857 // add activity target record for every sms that is sent
1858 $targetID = CRM_Core_PseudoConstant
::getKey('CRM_Activity_BAO_ActivityContact', 'record_type_id', 'Activity Targets');
1859 $activityTargetParams = array(
1860 'activity_id' => $activityID,
1861 'contact_id' => $toID,
1862 'record_type_id' => $targetID,
1864 CRM_Activity_BAO_ActivityContact
::create($activityTargetParams);
1870 * Send the message to a specific contact.
1872 * @param string $from
1873 * The name and email of the sender.
1874 * @param int $fromID
1876 * The contact id of the recipient.
1877 * @param string $subject
1878 * The subject of the message.
1879 * @param $text_message
1880 * @param $html_message
1881 * @param string $emailAddress
1882 * Use this 'to' email address instead of the default Primary address.
1883 * @param int $activityID
1884 * The activity ID that tracks the message.
1885 * @param null $attachments
1890 * TRUE if successful else FALSE.
1892 public static function sendMessage(
1901 $attachments = NULL,
1905 list($toDisplayName, $toEmail, $toDoNotEmail) = CRM_Contact_BAO_Contact
::getContactDetails($toID);
1906 if ($emailAddress) {
1907 $toEmail = trim($emailAddress);
1910 // make sure both email addresses are valid
1911 // and that the recipient wants to receive email
1912 if (empty($toEmail) or $toDoNotEmail) {
1915 if (!trim($toDisplayName)) {
1916 $toDisplayName = $toEmail;
1919 $activityContacts = CRM_Activity_BAO_ActivityContact
::buildOptions('record_type_id', 'validate');
1920 $targetID = CRM_Utils_Array
::key('Activity Targets', $activityContacts);
1922 // create the params array
1923 $mailParams = array(
1924 'groupName' => 'Activity Email Sender',
1926 'toName' => $toDisplayName,
1927 'toEmail' => $toEmail,
1928 'subject' => $subject,
1931 'text' => $text_message,
1932 'html' => $html_message,
1933 'attachments' => $attachments,
1936 if (!CRM_Utils_Mail
::send($mailParams)) {
1940 // add activity target record for every mail that is send
1941 $activityTargetParams = array(
1942 'activity_id' => $activityID,
1943 'contact_id' => $toID,
1944 'record_type_id' => $targetID,
1946 CRM_Activity_BAO_ActivityContact
::create($activityTargetParams);
1951 * Combine all the importable fields from the lower levels object.
1953 * The ordering is important, since currently we do not have a weight
1954 * scheme. Adding weight is super important and should be done in the
1955 * next week or so, before this can be called complete.
1957 * @param bool $status
1960 * array of importable Fields
1962 public static function &importableFields($status = FALSE) {
1963 if (!self
::$_importableFields) {
1964 if (!self
::$_importableFields) {
1965 self
::$_importableFields = array();
1968 $fields = array('' => array('title' => ts('- do not import -')));
1971 $fields = array('' => array('title' => ts('- Activity Fields -')));
1974 $tmpFields = CRM_Activity_DAO_Activity
::import();
1975 $contactFields = CRM_Contact_BAO_Contact
::importableFields('Individual', NULL);
1977 // Using new Dedupe rule.
1978 $ruleParams = array(
1979 'contact_type' => 'Individual',
1980 'used' => 'Unsupervised',
1982 $fieldsArray = CRM_Dedupe_BAO_Rule
::dedupeRuleFields($ruleParams);
1984 $tmpConatctField = array();
1985 if (is_array($fieldsArray)) {
1986 foreach ($fieldsArray as $value) {
1987 $customFieldId = CRM_Core_DAO
::getFieldValue('CRM_Core_DAO_CustomField',
1992 $value = $customFieldId ?
'custom_' . $customFieldId : $value;
1993 $tmpConatctField[trim($value)] = $contactFields[trim($value)];
1994 $tmpConatctField[trim($value)]['title'] = $tmpConatctField[trim($value)]['title'] . " (match to contact)";
1997 $tmpConatctField['external_identifier'] = $contactFields['external_identifier'];
1998 $tmpConatctField['external_identifier']['title'] = $contactFields['external_identifier']['title'] . " (match to contact)";
1999 $fields = array_merge($fields, $tmpConatctField);
2000 $fields = array_merge($fields, $tmpFields);
2001 $fields = array_merge($fields, CRM_Core_BAO_CustomField
::getFieldsForImport('Activity'));
2002 self
::$_importableFields = $fields;
2004 return self
::$_importableFields;
2008 * @deprecated - use the api instead.
2010 * Get the Activities of a target contact.
2012 * @param int $contactId
2013 * Id of the contact whose activities need to find.
2016 * array of activity fields
2018 public static function getContactActivity($contactId) {
2019 // @todo remove this function entirely.
2020 $activities = array();
2021 $activityContacts = CRM_Activity_BAO_ActivityContact
::buildOptions('record_type_id', 'validate');
2022 $sourceID = CRM_Utils_Array
::key('Activity Source', $activityContacts);
2023 $assigneeID = CRM_Utils_Array
::key('Activity Assignees', $activityContacts);
2024 $targetID = CRM_Utils_Array
::key('Activity Targets', $activityContacts);
2026 // First look for activities where contactId is one of the targets
2028 SELECT activity_id, record_type_id
2029 FROM civicrm_activity_contact
2030 WHERE contact_id = $contactId
2032 $dao = CRM_Core_DAO
::executeQuery($query);
2033 while ($dao->fetch()) {
2034 if ($dao->record_type_id
== $targetID) {
2035 $activities[$dao->activity_id
]['targets'][$contactId] = $contactId;
2037 elseif ($dao->record_type_id
== $assigneeID) {
2038 $activities[$dao->activity_id
]['asignees'][$contactId] = $contactId;
2041 // do source stuff here
2042 $activities[$dao->activity_id
]['source_contact_id'] = $contactId;
2046 $activityIds = array_keys($activities);
2047 if (count($activityIds) < 1) {
2051 $activityIds = implode(',', $activityIds);
2053 SELECT activity.id as activity_id,
2055 subject, location, activity_date_time, details, status_id
2056 FROM civicrm_activity activity
2057 WHERE activity.id IN ($activityIds)";
2059 $dao = CRM_Core_DAO
::executeQuery($query);
2061 while ($dao->fetch()) {
2062 $activities[$dao->activity_id
]['id'] = $dao->activity_id
;
2063 $activities[$dao->activity_id
]['activity_type_id'] = $dao->activity_type_id
;
2064 $activities[$dao->activity_id
]['subject'] = $dao->subject
;
2065 $activities[$dao->activity_id
]['location'] = $dao->location
;
2066 $activities[$dao->activity_id
]['activity_date_time'] = $dao->activity_date_time
;
2067 $activities[$dao->activity_id
]['details'] = $dao->details
;
2068 $activities[$dao->activity_id
]['status_id'] = $dao->status_id
;
2069 $activities[$dao->activity_id
]['activity_name'] = CRM_Core_PseudoConstant
::getLabel('CRM_Activity_BAO_Activity', 'activity_type_id', $dao->activity_type_id
);
2070 $activities[$dao->activity_id
]['status'] = CRM_Core_PseudoConstant
::getLabel('CRM_Activity_BAO_Activity', 'activity_status_id', $dao->status_id
);
2072 // set to null if not set
2073 if (!isset($activities[$dao->activity_id
]['source_contact_id'])) {
2074 $activities[$dao->activity_id
]['source_contact_id'] = NULL;
2081 * Add activity for Membership/Event/Contribution.
2083 * @param object $activity
2084 * (reference) particular component object.
2085 * @param string $activityType
2086 * For Membership Signup or Renewal.
2087 * @param int $targetContactID
2088 * @param array $params
2089 * Activity params to override.
2093 public static function addActivity(
2095 $activityType = 'Membership Signup',
2096 $targetContactID = NULL,
2099 $date = date('YmdHis');
2100 if ($activity->__table
== 'civicrm_membership') {
2101 $component = 'Membership';
2103 elseif ($activity->__table
== 'civicrm_participant') {
2104 if ($activityType != 'Email') {
2105 $activityType = 'Event Registration';
2107 $component = 'Event';
2109 elseif ($activity->__table
== 'civicrm_contribution') {
2110 // create activity record only for Completed Contributions
2111 $contributionCompletedStatusId = CRM_Core_PseudoConstant
::getKey('CRM_Contribute_BAO_Contribution', 'contribution_status_id', 'Completed');
2112 if ($activity->contribution_status_id
!= $contributionCompletedStatusId) {
2115 $activityType = $component = 'Contribution';
2117 // retrieve existing activity based on source_record_id and activity_type
2118 if (empty($params['id'])) {
2119 $params['id'] = CRM_Utils_Array
::value('id', civicrm_api3('Activity', 'Get', array(
2120 'source_record_id' => $activity->id
,
2121 'activity_type_id' => $activityType,
2124 if (!empty($params['id'])) {
2125 // CRM-13237 : if activity record found, update it with campaign id of contribution
2126 $params['campaign_id'] = $activity->campaign_id
;
2129 $date = CRM_Utils_Date
::isoToMysql($activity->receive_date
);
2132 $activityParams = array(
2133 'source_contact_id' => $activity->contact_id
,
2134 'source_record_id' => $activity->id
,
2135 'activity_type_id' => CRM_Core_PseudoConstant
::getKey('CRM_Activity_BAO_Activity', 'activity_type_id', $activityType),
2136 'activity_date_time' => $date,
2137 'is_test' => $activity->is_test
,
2138 'status_id' => CRM_Core_PseudoConstant
::getKey('CRM_Activity_BAO_Activity', 'activity_status_id', 'Completed'),
2139 'skipRecentView' => TRUE,
2140 'campaign_id' => $activity->campaign_id
,
2142 $activityParams = array_merge($activityParams, $params);
2144 if (empty($activityParams['subject'])) {
2145 $activityParams['subject'] = self
::getActivitySubject($activity);
2148 if (!empty($activity->activity_id
)) {
2149 $activityParams['id'] = $activity->activity_id
;
2151 // create activity with target contacts
2152 $id = CRM_Core_Session
::getLoggedInContactID();
2154 $activityParams['source_contact_id'] = $id;
2155 $activityParams['target_contact_id'][] = $activity->contact_id
;
2159 if (property_exists($activity, 'details')) {
2160 $activityParams['details'] = $activity->details
;
2163 if ($targetContactID) {
2164 $activityParams['target_contact_id'][] = $targetContactID;
2166 // @todo - use api - remove lots of wrangling above. Remove deprecated fatal & let form layer
2167 // deal with any exceptions.
2168 if (is_a(self
::create($activityParams), 'CRM_Core_Error')) {
2169 CRM_Core_Error
::fatal("Failed creating Activity for $component of id {$activity->id}");
2175 * Get activity subject on basis of component object.
2177 * @param object $entityObj
2178 * particular component object.
2182 public static function getActivitySubject($entityObj) {
2183 switch ($entityObj->__table
) {
2184 case 'civicrm_membership':
2185 $membershipType = CRM_Member_PseudoConstant
::membershipType($entityObj->membership_type_id
);
2186 $subject = $membershipType ?
$membershipType : ts('Membership');
2188 if (is_array($subject)) {
2189 $subject = implode(", ", $subject);
2192 if (!CRM_Utils_System
::isNull($entityObj->source
)) {
2193 $subject .= " - {$entityObj->source}";
2196 if ($entityObj->owner_membership_id
) {
2197 list($displayName) = CRM_Contact_BAO_Contact
::getDisplayAndImage(CRM_Core_DAO
::getFieldValue('CRM_Member_DAO_Membership', $entityObj->owner_membership_id
, 'contact_id'));
2198 $subject .= sprintf(' (by %s)', $displayName);
2201 $subject .= " - Status: " . CRM_Core_DAO
::getFieldValue('CRM_Member_DAO_MembershipStatus', $entityObj->status_id
, 'label');
2204 case 'civicrm_participant':
2205 $event = CRM_Event_BAO_Event
::getEvents(1, $entityObj->event_id
, TRUE, FALSE);
2206 $roles = CRM_Event_PseudoConstant
::participantRole();
2207 $status = CRM_Event_PseudoConstant
::participantStatus();
2208 $subject = $event[$entityObj->event_id
];
2210 if (!empty($roles[$entityObj->role_id
])) {
2211 $subject .= ' - ' . $roles[$entityObj->role_id
];
2213 if (!empty($status[$entityObj->status_id
])) {
2214 $subject .= ' - ' . $status[$entityObj->status_id
];
2219 case 'civicrm_contribution':
2220 $subject = CRM_Utils_Money
::format($entityObj->total_amount
, $entityObj->currency
);
2221 if (!CRM_Utils_System
::isNull($entityObj->source
)) {
2222 $subject .= " - {$entityObj->source}";
2225 // Amount and source could exceed max length of subject column.
2226 return CRM_Utils_String
::ellipsify($subject, 255);
2231 * Get Parent activity for currently viewed activity.
2233 * @param int $activityId
2234 * Current activity id.
2237 * Id of parent activity otherwise false.
2239 public static function getParentActivity($activityId) {
2240 static $parentActivities = array();
2242 $activityId = CRM_Utils_Type
::escape($activityId, 'Integer');
2244 if (!array_key_exists($activityId, $parentActivities)) {
2245 $parentActivities[$activityId] = array();
2247 $parentId = CRM_Core_DAO
::getFieldValue('CRM_Activity_DAO_Activity',
2252 $parentActivities[$activityId] = $parentId ?
$parentId : FALSE;
2255 return $parentActivities[$activityId];
2259 * Get total count of prior revision of currently viewed activity.
2261 * @param $activityID
2262 * Current activity id.
2265 * $params count of prior activities otherwise false.
2267 public static function getPriorCount($activityID) {
2268 static $priorCounts = array();
2270 $activityID = CRM_Utils_Type
::escape($activityID, 'Integer');
2272 if (!array_key_exists($activityID, $priorCounts)) {
2273 $priorCounts[$activityID] = array();
2274 $originalID = CRM_Core_DAO
::getFieldValue('CRM_Activity_DAO_Activity',
2281 SELECT count( id ) AS cnt
2282 FROM civicrm_activity
2283 WHERE ( id = {$originalID} OR original_id = {$originalID} )
2284 AND is_current_revision = 0
2285 AND id < {$activityID}
2287 $params = array(1 => array($originalID, 'Integer'));
2288 $count = CRM_Core_DAO
::singleValueQuery($query, $params);
2290 $priorCounts[$activityID] = $count ?
$count : 0;
2293 return $priorCounts[$activityID];
2297 * Get all prior activities of currently viewed activity.
2299 * @param $activityID
2300 * Current activity id.
2301 * @param bool $onlyPriorRevisions
2304 * prior activities info.
2306 public static function getPriorAcitivities($activityID, $onlyPriorRevisions = FALSE) {
2307 static $priorActivities = array();
2309 $activityID = CRM_Utils_Type
::escape($activityID, 'Integer');
2310 $index = $activityID . '_' . (int) $onlyPriorRevisions;
2312 if (!array_key_exists($index, $priorActivities)) {
2313 $priorActivities[$index] = array();
2315 $originalID = CRM_Core_DAO
::getFieldValue('CRM_Activity_DAO_Activity',
2320 $originalID = $activityID;
2324 SELECT c.display_name as name, cl.modified_date as date, ca.id as activityID
2325 FROM civicrm_log cl, civicrm_contact c, civicrm_activity ca
2326 WHERE (ca.id = %1 OR ca.original_id = %1)
2327 AND cl.entity_table = 'civicrm_activity'
2328 AND cl.entity_id = ca.id
2329 AND cl.modified_id = c.id
2331 if ($onlyPriorRevisions) {
2332 $query .= " AND ca.id < {$activityID}";
2334 $query .= " ORDER BY ca.id DESC";
2336 $params = array(1 => array($originalID, 'Integer'));
2337 $dao = CRM_Core_DAO
::executeQuery($query, $params);
2339 while ($dao->fetch()) {
2340 $priorActivities[$index][$dao->activityID
]['id'] = $dao->activityID
;
2341 $priorActivities[$index][$dao->activityID
]['name'] = $dao->name
;
2342 $priorActivities[$index][$dao->activityID
]['date'] = $dao->date
;
2347 return $priorActivities[$index];
2351 * Find the latest revision of a given activity.
2353 * @param int $activityID
2354 * Prior activity id.
2357 * current activity id.
2359 public static function getLatestActivityId($activityID) {
2360 static $latestActivityIds = array();
2362 $activityID = CRM_Utils_Type
::escape($activityID, 'Integer');
2364 if (!array_key_exists($activityID, $latestActivityIds)) {
2365 $latestActivityIds[$activityID] = array();
2367 $originalID = CRM_Core_DAO
::getFieldValue('CRM_Activity_DAO_Activity',
2372 $activityID = $originalID;
2374 $params = array(1 => array($activityID, 'Integer'));
2375 $query = "SELECT id from civicrm_activity where original_id = %1 and is_current_revision = 1";
2377 $latestActivityIds[$activityID] = CRM_Core_DAO
::singleValueQuery($query, $params);
2380 return $latestActivityIds[$activityID];
2384 * Create a follow up a given activity.
2386 * @param int $activityId
2387 * activity id of parent activity.
2388 * @param array $params
2390 * @return CRM_Activity_BAO_Activity|null|object
2392 public static function createFollowupActivity($activityId, $params) {
2397 $followupParams = array();
2398 $followupParams['parent_id'] = $activityId;
2399 $followupParams['source_contact_id'] = CRM_Core_Session
::getLoggedInContactID();
2400 $followupParams['status_id'] = CRM_Core_PseudoConstant
::getKey('CRM_Activity_BAO_Activity', 'activity_status_id', 'Scheduled');
2402 $followupParams['activity_type_id'] = $params['followup_activity_type_id'];
2403 // Get Subject of Follow-up Activiity, CRM-4491
2404 $followupParams['subject'] = CRM_Utils_Array
::value('followup_activity_subject', $params);
2405 $followupParams['assignee_contact_id'] = CRM_Utils_Array
::value('followup_assignee_contact_id', $params);
2407 // Create target contact for followup.
2408 if (!empty($params['target_contact_id'])) {
2409 $followupParams['target_contact_id'] = $params['target_contact_id'];
2412 $followupParams['activity_date_time'] = $params['followup_date'];
2413 $followupActivity = self
::create($followupParams);
2415 return $followupActivity;
2419 * Get Activity specific File according activity type Id.
2421 * @param int $activityTypeId
2423 * @param string $crmDir
2425 * @return string|bool
2426 * if file exists returns $activityTypeFile activity filename otherwise false.
2428 public static function getFileForActivityTypeId($activityTypeId, $crmDir = 'Activity') {
2429 $activityTypes = CRM_Case_PseudoConstant
::caseActivityType(FALSE, TRUE);
2431 if ($activityTypes[$activityTypeId]['name']) {
2432 $activityTypeFile = CRM_Utils_String
::munge(ucwords($activityTypes[$activityTypeId]['name']), '', 0);
2438 global $civicrm_root;
2439 $config = CRM_Core_Config
::singleton();
2440 if (!file_exists(rtrim($civicrm_root, '/') . "/CRM/{$crmDir}/Form/Activity/{$activityTypeFile}.php")) {
2441 if (empty($config->customPHPPathDir
)) {
2444 elseif (!file_exists(rtrim($config->customPHPPathDir
, '/') . "/CRM/{$crmDir}/Form/Activity/{$activityTypeFile}.php")) {
2449 return $activityTypeFile;
2453 * Restore the activity.
2455 * @param array $params
2457 * @return CRM_Activity_DAO_Activity
2459 public static function restoreActivity(&$params) {
2460 $activity = new CRM_Activity_DAO_Activity();
2461 $activity->copyValues($params);
2463 $activity->is_deleted
= 0;
2464 $result = $activity->save();
2470 * Return list of activity statuses of a given type.
2472 * Note: activity status options use the "grouping" field to distinguish status types.
2473 * Types are defined in class constants INCOMPLETE, COMPLETED, CANCELLED
2479 public static function getStatusesByType($type) {
2480 if (!isset(Civi
::$statics[__CLASS__
][__FUNCTION__
])) {
2481 $statuses = civicrm_api3('OptionValue', 'get', array(
2482 'option_group_id' => 'activity_status',
2483 'return' => array('value', 'name', 'filter'),
2484 'options' => array('limit' => 0),
2486 Civi
::$statics[__CLASS__
][__FUNCTION__
] = $statuses['values'];
2489 foreach (Civi
::$statics[__CLASS__
][__FUNCTION__
] as $status) {
2490 if ($status['filter'] == $type) {
2491 $ret[$status['value']] = $status['name'];
2498 * Check if activity is overdue.
2500 * @param array $activity
2504 public static function isOverdue($activity) {
2505 return array_key_exists($activity['status_id'], self
::getStatusesByType(self
::INCOMPLETE
)) && CRM_Utils_Date
::overdue($activity['activity_date_time']);
2509 * Get the exportable fields for Activities.
2511 * @param string $name
2512 * If it is called by case $name = Case else $name = Activity.
2515 * array of exportable Fields
2517 public static function exportableFields($name = 'Activity') {
2518 self
::$_exportableFields[$name] = array();
2520 // TODO: ideally we should retrieve all fields from xml, in this case since activity processing is done
2521 // my case hence we have defined fields as case_*
2522 if ($name == 'Activity') {
2523 $exportableFields = CRM_Activity_DAO_Activity
::export();
2524 $exportableFields['source_contact_id'] = [
2525 'title' => ts('Source Contact ID'),
2526 'type' => CRM_Utils_Type
::T_INT
,
2528 $exportableFields['source_contact'] = array(
2529 'title' => ts('Source Contact'),
2530 'type' => CRM_Utils_Type
::T_STRING
,
2533 $Activityfields = array(
2534 'activity_type' => array(
2535 'title' => ts('Activity Type'),
2536 'name' => 'activity_type',
2537 'type' => CRM_Utils_Type
::T_STRING
,
2538 'searchByLabel' => TRUE,
2540 'activity_status' => array(
2541 'title' => ts('Activity Status'),
2542 'name' => 'activity_status',
2543 'type' => CRM_Utils_Type
::T_STRING
,
2544 'searchByLabel' => TRUE,
2546 'activity_priority' => array(
2547 'title' => ts('Activity Priority'),
2548 'name' => 'activity_priority',
2549 'type' => CRM_Utils_Type
::T_STRING
,
2550 'searchByLabel' => TRUE,
2553 $fields = array_merge($Activityfields, $exportableFields);
2556 // Set title to activity fields.
2558 'case_activity_subject' => array('title' => ts('Activity Subject'), 'type' => CRM_Utils_Type
::T_STRING
),
2559 'case_source_contact_id' => array('title' => ts('Activity Reporter'), 'type' => CRM_Utils_Type
::T_STRING
),
2560 'case_recent_activity_date' => array('title' => ts('Activity Actual Date'), 'type' => CRM_Utils_Type
::T_DATE
),
2561 'case_scheduled_activity_date' => array(
2562 'title' => ts('Activity Scheduled Date'),
2563 'type' => CRM_Utils_Type
::T_DATE
,
2565 'case_recent_activity_type' => array('title' => ts('Activity Type'), 'type' => CRM_Utils_Type
::T_STRING
),
2566 'case_activity_status' => array('title' => ts('Activity Status'), 'type' => CRM_Utils_Type
::T_STRING
),
2567 'case_activity_duration' => array('title' => ts('Activity Duration'), 'type' => CRM_Utils_Type
::T_INT
),
2568 'case_activity_medium_id' => array('title' => ts('Activity Medium'), 'type' => CRM_Utils_Type
::T_INT
),
2569 'case_activity_details' => array('title' => ts('Activity Details'), 'type' => CRM_Utils_Type
::T_TEXT
),
2570 'case_activity_is_auto' => array(
2571 'title' => ts('Activity Auto-generated?'),
2572 'type' => CRM_Utils_Type
::T_BOOLEAN
,
2577 // add custom data for case activities
2578 $fields = array_merge($fields, CRM_Core_BAO_CustomField
::getFieldsForImport('Activity'));
2580 self
::$_exportableFields[$name] = $fields;
2581 return self
::$_exportableFields[$name];
2585 * Get the allowed profile fields for Activities.
2588 * array of activity profile Fields
2590 public static function getProfileFields() {
2591 $exportableFields = self
::exportableFields('Activity');
2592 $skipFields = array(
2595 'source_contact_id',
2597 'activity_campaign',
2599 'is_current_revision',
2600 'activity_is_deleted',
2602 $config = CRM_Core_Config
::singleton();
2603 if (!in_array('CiviCampaign', $config->enableComponents
)) {
2604 $skipFields[] = 'activity_engagement_level';
2607 foreach ($skipFields as $field) {
2608 if (isset($exportableFields[$field])) {
2609 unset($exportableFields[$field]);
2613 // hack to use 'activity_type_id' instead of 'activity_type'
2614 $exportableFields['activity_status_id'] = $exportableFields['activity_status'];
2615 unset($exportableFields['activity_status']);
2617 return $exportableFields;
2621 * This function deletes the activity record related to contact record.
2623 * This is conditional on there being no target and assignee record
2624 * with other contacts.
2626 * @param int $contactId
2631 public static function cleanupActivity($contactId) {
2636 $activityContacts = CRM_Activity_BAO_ActivityContact
::buildOptions('record_type_id', 'validate');
2637 $sourceID = CRM_Utils_Array
::key('Activity Source', $activityContacts);
2639 $transaction = new CRM_Core_Transaction();
2641 // delete activity if there is no record in civicrm_activity_contact
2642 // pointing to any other contact record
2643 $activityContact = new CRM_Activity_DAO_ActivityContact();
2644 $activityContact->contact_id
= $contactId;
2645 $activityContact->record_type_id
= $sourceID;
2646 $activityContact->find();
2648 while ($activityContact->fetch()) {
2649 // delete activity_contact record for the deleted contact
2650 $activityContact->delete();
2652 $activityContactOther = new CRM_Activity_DAO_ActivityContact();
2653 $activityContactOther->activity_id
= $activityContact->activity_id
;
2655 // delete activity only if no other contacts connected
2656 if (!$activityContactOther->find(TRUE)) {
2657 $activityParams = array('id' => $activityContact->activity_id
);
2658 $result = self
::deleteActivity($activityParams);
2661 $activityContactOther->free();
2664 $activityContact->free();
2665 $transaction->commit();
2671 * Does user has sufficient permission for view/edit activity record.
2673 * @param int $activityId
2674 * Activity record id.
2675 * @param int $action
2680 public static function checkPermission($activityId, $action) {
2683 !in_array($action, array(CRM_Core_Action
::UPDATE
, CRM_Core_Action
::VIEW
))
2688 $activity = new CRM_Activity_DAO_Activity();
2689 $activity->id
= $activityId;
2690 if (!$activity->find(TRUE)) {
2694 if (!self
::hasPermissionForActivityType($activity->activity_type_id
)) {
2697 // Return early when it is case activity.
2698 // Check for CiviCase related permission.
2699 if (CRM_Case_BAO_Case
::isCaseActivity($activityId)) {
2700 return self
::isContactPermittedAccessToCaseActivity($activityId, $action, $activity->activity_type_id
);
2703 // Check for this permission related to contact.
2704 $permission = CRM_Core_Permission
::VIEW
;
2705 if ($action == CRM_Core_Action
::UPDATE
) {
2706 $permission = CRM_Core_Permission
::EDIT
;
2709 $activityContacts = CRM_Activity_BAO_ActivityContact
::buildOptions('record_type_id', 'validate');
2710 $sourceID = CRM_Utils_Array
::key('Activity Source', $activityContacts);
2711 $assigneeID = CRM_Utils_Array
::key('Activity Assignees', $activityContacts);
2712 $targetID = CRM_Utils_Array
::key('Activity Targets', $activityContacts);
2714 // Check for source contact.
2715 $sourceContactId = self
::getActivityContact($activity->id
, $sourceID);
2716 // Account for possibility of activity not having a source contact (as it may have been deleted).
2717 $allow = $sourceContactId ? CRM_Contact_BAO_Contact_Permission
::allow($sourceContactId, $permission) : TRUE;
2722 // Check for target and assignee contacts.
2723 // First check for supper permission.
2724 $supPermission = 'view all contacts';
2725 if ($action == CRM_Core_Action
::UPDATE
) {
2726 $supPermission = 'edit all contacts';
2728 $allow = CRM_Core_Permission
::check($supPermission);
2730 // User might have sufficient permission, through acls.
2733 // Get the target contacts.
2734 $targetContacts = CRM_Activity_BAO_ActivityContact
::retrieveContactIdsByActivityId($activity->id
, $targetID);
2735 foreach ($targetContacts as $cnt => $contactId) {
2736 if (!CRM_Contact_BAO_Contact_Permission
::allow($contactId, $permission)) {
2742 // Get the assignee contacts.
2744 $assigneeContacts = CRM_Activity_BAO_ActivityContact
::retrieveContactIdsByActivityId($activity->id
, $assigneeID);
2745 foreach ($assigneeContacts as $cnt => $contactId) {
2746 if (!CRM_Contact_BAO_Contact_Permission
::allow($contactId, $permission)) {
2758 * Check if the logged in user has permission for the given case activity.
2760 * @param int $activityId
2761 * @param int $action
2762 * @param int $activityTypeID
2766 protected static function isContactPermittedAccessToCaseActivity($activityId, $action, $activityTypeID) {
2768 if ($action == CRM_Core_Action
::UPDATE
) {
2771 $allow = CRM_Case_BAO_Case
::checkPermission($activityId,
2780 * Check if the logged in user has permission to access the given activity type.
2782 * @param int $activityTypeID
2786 protected static function hasPermissionForActivityType($activityTypeID) {
2787 $permittedActivityTypes = self
::getPermittedActivityTypes();
2788 return isset($permittedActivityTypes[$activityTypeID]);
2792 * Get the activity types the user is permitted to access.
2794 * The types are filtered by the components they have access to. ie. a user
2795 * with access CiviContribute but not CiviMember will see contribution related
2796 * activities and activities with no component (e.g meetings) but not member related ones.
2800 public static function getPermittedActivityTypes() {
2801 $userID = (int) CRM_Core_Session
::getLoggedInContactID();
2802 if (!isset(Civi
::$statics[__CLASS__
]['permitted_activity_types'][$userID])) {
2803 $permittedActivityTypes = [];
2804 $components = self
::activityComponents(FALSE);
2805 $componentClause = empty($components) ?
'' : (' OR component_id IN (' . implode(', ', array_keys($components)) . ')');
2807 $types = CRM_Core_DAO
::executeQuery(
2809 SELECT option_value.value activity_type_id
2810 FROM civicrm_option_value option_value
2811 INNER JOIN civicrm_option_group grp ON (grp.id = option_group_id AND grp.name = 'activity_type')
2812 WHERE component_id IS NULL $componentClause")->fetchAll();
2813 foreach ($types as $type) {
2814 $permittedActivityTypes[$type['activity_type_id']] = $type['activity_type_id'];
2816 Civi
::$statics[__CLASS__
]['permitted_activity_types'][$userID] = $permittedActivityTypes;
2818 return Civi
::$statics[__CLASS__
]['permitted_activity_types'][$userID];
2825 protected static function getActivityParamsForDashboardFunctions($params) {
2828 'is_current_revision' => 1,
2830 'contact_id' => CRM_Utils_Array
::value('contact_id', $params),
2831 'check_permissions' => 1,
2833 'offset' => CRM_Utils_Array
::value('offset', $params, 0),
2837 if (!empty($params['activity_status_id'])) {
2838 $activityParams['activity_status_id'] = ['IN' => explode(',', $params['activity_status_id'])];
2841 $activityParams['activity_type_id'] = self
::filterActivityTypes($params);
2842 $enabledComponents = self
::activityComponents();
2843 // @todo - should we move this to activity get api.
2845 'case_id' => 'CiviCase',
2846 'campaign_id' => 'CiviCampaign'
2847 ] as $attr => $component) {
2848 if (!in_array($component, $enabledComponents)) {
2849 $activityParams[$attr] = ['IS NULL' => 1];
2852 return $activityParams;
2856 * Checks if user has permissions to edit inbound e-mails, either bsic info
2857 * or both basic information and content.
2861 public function checkEditInboundEmailsPermissions() {
2862 if (CRM_Core_Permission
::check('edit inbound email basic information')
2863 || CRM_Core_Permission
::check('edit inbound email basic information and content')
2872 * Wrapper for ajax activity selector.
2874 * @param array $params
2875 * Associated array for params record id.
2878 * Associated array of contact activities
2880 public static function getContactActivitySelector(&$params) {
2881 // Format the params.
2882 $params['offset'] = ($params['page'] - 1) * $params['rp'];
2883 $params['rowCount'] = $params['rp'];
2884 $params['sort'] = CRM_Utils_Array
::value('sortBy', $params);
2885 $params['caseId'] = NULL;
2886 $context = CRM_Utils_Array
::value('context', $params);
2887 $showContactOverlay = !CRM_Utils_String
::startsWith($context, "dashlet");
2888 $activityTypeInfo = civicrm_api3('OptionValue', 'get', array(
2889 'option_group_id' => "activity_type",
2890 'options' => array('limit' => 0),
2892 $activityIcons = array();
2893 foreach ($activityTypeInfo['values'] as $type) {
2894 if (!empty($type['icon'])) {
2895 $activityIcons[$type['value']] = $type['icon'];
2899 // Get contact activities.
2900 $activities = CRM_Activity_BAO_Activity
::deprecatedGetActivities($params);
2903 $params['total'] = CRM_Activity_BAO_Activity
::deprecatedGetActivitiesCount($params);
2905 // Format params and add links.
2906 $contactActivities = array();
2908 if (!empty($activities)) {
2909 $activityStatus = CRM_Core_PseudoConstant
::activityStatus();
2911 // Check logged in user for permission.
2912 $page = new CRM_Core_Page();
2913 CRM_Contact_Page_View
::checkUserPermission($page, $params['contact_id']);
2914 $permissions = array($page->_permission
);
2915 if (CRM_Core_Permission
::check('delete activities')) {
2916 $permissions[] = CRM_Core_Permission
::DELETE
;
2919 $mask = CRM_Core_Action
::mask($permissions);
2921 foreach ($activities as $activityId => $values) {
2922 $activity = array();
2923 $activity['DT_RowId'] = $activityId;
2924 // Add class to this row if overdue.
2925 $activity['DT_RowClass'] = "crm-entity status-id-{$values['status_id']}";
2926 if (self
::isOverdue($values)) {
2927 $activity['DT_RowClass'] .= ' status-overdue';
2930 $activity['DT_RowClass'] .= ' status-ontime';
2933 $activity['DT_RowAttr'] = array();
2934 $activity['DT_RowAttr']['data-entity'] = 'activity';
2935 $activity['DT_RowAttr']['data-id'] = $activityId;
2937 $activity['activity_type'] = (!empty($activityIcons[$values['activity_type_id']]) ?
'<span class="crm-i ' . $activityIcons[$values['activity_type_id']] . '"></span> ' : '') . $values['activity_type'];
2938 $activity['subject'] = $values['subject'];
2940 $activity['source_contact_name'] = '';
2941 if ($params['contact_id'] == $values['source_contact_id']) {
2942 $activity['source_contact_name'] = $values['source_contact_name'];
2944 elseif ($values['source_contact_id']) {
2946 if ($showContactOverlay) {
2947 $srcTypeImage = CRM_Contact_BAO_Contact_Utils
::getImage(
2948 CRM_Contact_BAO_Contact
::getContactType($values['source_contact_id']),
2950 $values['source_contact_id']);
2952 $activity['source_contact_name'] = $srcTypeImage . CRM_Utils_System
::href($values['source_contact_name'],
2953 'civicrm/contact/view', "reset=1&cid={$values['source_contact_id']}");
2956 $activity['source_contact_name'] = '<em>n/a</em>';
2959 $activity['target_contact_name'] = '';
2960 if (isset($values['mailingId']) && !empty($values['mailingId'])) {
2961 $activity['target_contact'] = CRM_Utils_System
::href($values['recipients'],
2962 'civicrm/mailing/report/event',
2963 "mid={$values['source_record_id']}&reset=1&event=queue&cid={$params['contact_id']}&context=activitySelector");
2965 elseif (!empty($values['recipients'])) {
2966 $activity['target_contact_name'] = $values['recipients'];
2968 elseif (isset($values['target_contact_counter']) && $values['target_contact_counter']) {
2969 $activity['target_contact_name'] = '';
2970 $firstTargetName = reset($values['target_contact_name']);
2971 $firstTargetContactID = key($values['target_contact_name']);
2973 $targetLink = CRM_Utils_System
::href($firstTargetName, 'civicrm/contact/view', "reset=1&cid={$firstTargetContactID}");
2974 if ($showContactOverlay) {
2975 $targetTypeImage = CRM_Contact_BAO_Contact_Utils
::getImage(
2976 CRM_Contact_BAO_Contact
::getContactType($firstTargetContactID),
2978 $firstTargetContactID);
2979 $activity['target_contact_name'] .= "<div>$targetTypeImage $targetLink";
2982 $activity['target_contact_name'] .= $targetLink;
2985 if ($extraCount = $values['target_contact_counter'] - 1) {
2986 $activity['target_contact_name'] .= ";<br />" . "(" . ts('%1 more', array(1 => $extraCount)) . ")";
2988 if ($showContactOverlay) {
2989 $activity['target_contact_name'] .= "</div> ";
2992 elseif (!$values['target_contact_name']) {
2993 $activity['target_contact_name'] = '<em>n/a</em>';
2996 $activity['assignee_contact_name'] = '';
2997 if (empty($values['assignee_contact_name'])) {
2998 $activity['assignee_contact_name'] = '<em>n/a</em>';
3000 elseif (!empty($values['assignee_contact_name'])) {
3002 $activity['assignee_contact_name'] = '';
3003 foreach ($values['assignee_contact_name'] as $acID => $acName) {
3004 if ($acID && $count < 5) {
3005 $assigneeTypeImage = "";
3006 $assigneeLink = CRM_Utils_System
::href($acName, 'civicrm/contact/view', "reset=1&cid={$acID}");
3007 if ($showContactOverlay) {
3008 $assigneeTypeImage = CRM_Contact_BAO_Contact_Utils
::getImage(
3009 CRM_Contact_BAO_Contact
::getContactType($acID),
3012 $activity['assignee_contact_name'] .= "<div>$assigneeTypeImage $assigneeLink";
3015 $activity['assignee_contact_name'] .= $assigneeLink;
3020 $activity['assignee_contact_name'] .= "; ";
3022 if ($showContactOverlay) {
3023 $activity['assignee_contact_name'] .= "</div> ";
3027 $activity['assignee_contact_name'] .= "(" . ts('more') . ")";
3034 $activity['activity_date_time'] = CRM_Utils_Date
::customFormat($values['activity_date_time']);
3035 $activity['status_id'] = $activityStatus[$values['status_id']];
3038 $activity['links'] = '';
3039 $accessMailingReport = FALSE;
3040 if (!empty($values['mailingId'])) {
3041 $accessMailingReport = TRUE;
3044 $actionLinks = CRM_Activity_Selector_Activity
::actionLinks(
3045 CRM_Utils_Array
::value('activity_type_id', $values),
3046 CRM_Utils_Array
::value('source_record_id', $values),
3047 $accessMailingReport,
3048 CRM_Utils_Array
::value('activity_id', $values)
3051 $actionMask = array_sum(array_keys($actionLinks)) & $mask;
3053 $activity['links'] = CRM_Core_Action
::formLink($actionLinks,
3056 'id' => $values['activity_id'],
3057 'cid' => $params['contact_id'],
3059 'caseid' => CRM_Utils_Array
::value('case_id', $values),
3065 $values['activity_id']
3068 if ($values['is_recurring_activity']) {
3069 $activity['is_recurring_activity'] = CRM_Core_BAO_RecurringEntity
::getPositionAndCount($values['activity_id'], 'civicrm_activity');
3072 array_push($contactActivities, $activity);
3076 $activitiesDT = array();
3077 $activitiesDT['data'] = $contactActivities;
3078 $activitiesDT['recordsTotal'] = $params['total'];
3079 $activitiesDT['recordsFiltered'] = $params['total'];
3081 return $activitiesDT;
3085 * Copy custom fields and attachments from an existing activity to another.
3087 * @see CRM_Case_Page_AJAX::_convertToCaseActivity()
3089 * @param array $params
3091 public static function copyExtendedActivityData($params) {
3092 // attach custom data to the new activity
3093 $customParams = $htmlType = array();
3094 $customValues = CRM_Core_BAO_CustomValueTable
::getEntityValues($params['activityID'], 'Activity');
3096 if (!empty($customValues)) {
3097 $fieldIds = implode(', ', array_keys($customValues));
3098 $sql = "SELECT id FROM civicrm_custom_field WHERE html_type = 'File' AND id IN ( {$fieldIds} )";
3099 $result = CRM_Core_DAO
::executeQuery($sql);
3101 while ($result->fetch()) {
3102 $htmlType[] = $result->id
;
3105 foreach ($customValues as $key => $value) {
3106 if ($value !== NULL) {
3108 if (in_array($key, $htmlType)) {
3109 $fileValues = CRM_Core_BAO_File
::path($value, $params['activityID']);
3110 $customParams["custom_{$key}_-1"] = array(
3111 'name' => $fileValues[0],
3112 'path' => $fileValues[1],
3116 $customParams["custom_{$key}_-1"] = $value;
3120 CRM_Core_BAO_CustomValueTable
::postProcess($customParams, 'civicrm_activity',
3121 $params['mainActivityId'], 'Activity'
3125 // copy activity attachments ( if any )
3126 CRM_Core_BAO_File
::copyEntityFile('civicrm_activity', $params['activityID'], 'civicrm_activity', $params['mainActivityId']);
3130 * Get activity contact.
3132 * @param int $activityId
3133 * @param int $recordTypeID
3134 * @param string $column
3138 public static function getActivityContact($activityId, $recordTypeID = NULL, $column = 'contact_id') {
3139 $activityContact = new CRM_Activity_BAO_ActivityContact();
3140 $activityContact->activity_id
= $activityId;
3141 if ($recordTypeID) {
3142 $activityContact->record_type_id
= $recordTypeID;
3144 if ($activityContact->find(TRUE)) {
3145 return $activityContact->$column;
3151 * Get source contact id.
3153 * @param int $activityId
3157 public static function getSourceContactID($activityId) {
3158 static $sourceID = NULL;
3160 $activityContacts = CRM_Activity_BAO_ActivityContact
::buildOptions('record_type_id', 'validate');
3161 $sourceID = CRM_Utils_Array
::key('Activity Source', $activityContacts);
3164 return self
::getActivityContact($activityId, $sourceID);
3170 * @todo Document what this is for.
3172 * @param array $params
3174 public function setApiFilter(&$params) {
3175 if (!empty($params['target_contact_id'])) {
3177 $activityContacts = CRM_Activity_BAO_ActivityContact
::buildOptions('record_type_id', 'validate');
3178 $targetID = CRM_Utils_Array
::key('Activity Targets', $activityContacts);
3179 $obj = new CRM_Activity_BAO_ActivityContact();
3180 $params['return.target_contact_id'] = 1;
3181 $this->joinAdd($obj, 'LEFT');
3182 $this->selectAdd('civicrm_activity.*');
3183 $this->whereAdd(" civicrm_activity_contact.contact_id = {$params['target_contact_id']} AND civicrm_activity_contact.record_type_id = {$targetID}");
3188 * Send activity as attachment.
3190 * @param object $activity
3191 * @param array $mailToContacts
3192 * @param array $params
3196 public static function sendToAssignee($activity, $mailToContacts, $params = array()) {
3197 if (!CRM_Utils_Array
::crmIsEmptyArray($mailToContacts)) {
3198 $clientID = CRM_Utils_Array
::value('client_id', $params);
3199 $caseID = CRM_Utils_Array
::value('case_id', $params);
3201 $ics = new CRM_Activity_BAO_ICalendar($activity);
3202 $attachments = CRM_Core_BAO_File
::getEntityFile('civicrm_activity', $activity->id
);
3203 $ics->addAttachment($attachments, $mailToContacts);
3205 $result = CRM_Case_BAO_Case
::sendActivityCopy($clientID, $activity->id
, $mailToContacts, $attachments, $caseID);