3 +--------------------------------------------------------------------+
5 +--------------------------------------------------------------------+
6 | Copyright CiviCRM LLC (c) 2004-2018 |
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-2018
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
674 * @param bool $getCount
675 * Get count of the activities
678 * Relevant data object values of open activities
679 * @throws \CiviCRM_API3_Exception
681 public static function getActivities($params, $getCount = FALSE) {
682 $activities = array();
684 // Activity.Get API params
685 $activityParams = array(
687 'is_current_revision' => 1,
689 'contact_id' => CRM_Utils_Array
::value('contact_id', $params),
691 'activity_date_time',
694 'source_contact_name',
695 'assignee_contact_id',
697 'target_contact_name',
698 'assignee_contact_name',
706 'check_permissions' => 1,
708 'offset' => CRM_Utils_Array
::value('offset', $params, 0),
712 if (!empty($params['activity_status_id'])) {
713 $activityParams['activity_status_id'] = array('IN' => explode(',', $params['activity_status_id']));
716 $activityParams['activity_type_id'] = self
::filterActivityTypes($params);
718 if (!empty($params['rowCount']) &&
719 $params['rowCount'] > 0
721 $activityParams['options']['limit'] = $params['rowCount'];
723 // set limit = 0 if we need to fetch the activity count
725 $activityParams['options']['limit'] = 0;
728 if (!empty($params['sort'])) {
729 if (is_a($params['sort'], 'CRM_Utils_Sort')) {
730 $order = $params['sort']->orderBy();
732 elseif (trim($params['sort'])) {
733 $order = CRM_Utils_Type
::escape($params['sort'], 'String');
737 $activityParams['options']['sort'] = empty($order) ?
"activity_date_time DESC" : str_replace('activity_type ', 'activity_type_id.label ', $order);
740 // 1. we should use Activity.Getcount for fetching count only, but in order to check that
741 // current logged in user has permission to view Case activities we are performing filtering out those activities from list (see below).
742 // This logic need to be incorporated in Activity.get definition
743 $result = civicrm_api3('Activity', 'Get', $activityParams);
745 $enabledComponents = self
::activityComponents();
746 $bulkActivityTypeID = CRM_Core_PseudoConstant
::getKey('CRM_Activity_BAO_Activity', 'activity_type_id', 'Bulk Email');
747 $allCampaigns = CRM_Campaign_BAO_Campaign
::getCampaigns(NULL, NULL, FALSE, FALSE, FALSE, TRUE);
749 // CRM-3553, need to check user has access to target groups.
750 $mailingIDs = CRM_Mailing_BAO_Mailing
::mailingACLIDs();
751 $accessCiviMail = ((CRM_Core_Permission
::check('access CiviMail')) ||
752 (CRM_Mailing_Info
::workflowEnabled() && CRM_Core_Permission
::check('create mailings'))
755 $mappingParams = array(
756 'id' => 'activity_id',
757 'source_record_id' => 'source_record_id',
758 'activity_type_id' => 'activity_type_id',
759 'activity_date_time' => 'activity_date_time',
760 'status_id' => 'status_id',
761 'subject' => 'subject',
762 'campaign_id' => 'campaign_id',
763 'assignee_contact_name' => 'assignee_contact_name',
764 'target_contact_name' => 'target_contact_name',
765 'source_contact_id' => 'source_contact_id',
766 'source_contact_name' => 'source_contact_name',
767 'case_id' => 'case_id',
770 foreach ($result['values'] as $id => $activity) {
771 // skip case activities if CiviCase is not enabled OR those actvities which are
772 if (!empty($activity['case_id']) && !in_array('CiviCase', $enabledComponents)) {
776 $activities[$id] = array();
778 // if count is needed, no need to populate the array list with attributes
783 $isBulkActivity = (!$bulkActivityTypeID ||
($bulkActivityTypeID === $activity['activity_type_id']));
784 foreach ($mappingParams as $apiKey => $expectedName) {
785 if (in_array($apiKey, array('assignee_contact_name', 'target_contact_name'))) {
786 $activities[$id][$expectedName] = CRM_Utils_Array
::value($apiKey, $activity, array());
787 if ($apiKey == 'target_contact_name' && count($activity['target_contact_name'])) {
788 $activities[$id]['target_contact_counter'] = count($activity['target_contact_name']);
791 if ($isBulkActivity) {
792 $activities[$id]['recipients'] = ts('(%1 recipients)', array(1 => count($activity['target_contact_name'])));
793 $activities[$id]['mailingId'] = FALSE;
794 if ($accessCiviMail &&
795 ($mailingIDs === TRUE ||
in_array($activity['source_record_id'], $mailingIDs))
797 $activities[$id]['mailingId'] = TRUE;
801 // case related fields
802 elseif ($apiKey == 'case_id' && !$isBulkActivity) {
803 $activities[$id][$expectedName] = CRM_Utils_Array
::value($apiKey, $activity);
805 // fetch case subject for case ID found
806 if (!empty($activity['case_id'])) {
807 $activities[$id]['case_subject'] = CRM_Core_DAO
::executeQuery('CRM_Case_DAO_Case', $activity['case_id'], 'subject');
811 $activities[$id][$expectedName] = CRM_Utils_Array
::value($apiKey, $activity);
812 if ($apiKey == 'activity_type_id') {
813 $activities[$id]['activity_type'] = CRM_Core_PseudoConstant
::getName('CRM_Activity_BAO_Activity', 'activity_type_id', $activities[$id][$expectedName]);
815 elseif ($apiKey == 'campaign_id') {
816 $activities[$id]['campaign'] = CRM_Utils_Array
::value($activities[$id][$expectedName], $allCampaigns);
820 // if deleted, wrap in <del>
821 if (!empty($activity['source_contact_id']) &&
822 CRM_Core_DAO
::getFieldValue('CRM_Contact_DAO_Contact', $activity['source_contact_id'], 'is_deleted')
824 $activities[$id]['source_contact_name'] = sprintf("<del>%s<del>", $activity['source_contact_name']);
826 $activities[$id]['is_recurring_activity'] = CRM_Core_BAO_RecurringEntity
::getParentFor($id, 'civicrm_activity');
829 return $getCount ?
count($activities) : $activities;
833 * Filter the activity types to only return the ones we actually asked for
834 * Uses params['activity_type_id'] and params['activity_type_exclude_id']
837 * @return array|null (Use in Activity.get API activity_type_id)
839 public static function filterActivityTypes($params) {
840 $activityTypes = array();
842 // If no activity types are specified, get all the active ones
843 if (empty($params['activity_type_id'])) {
844 $activityTypes = CRM_Activity_BAO_Activity
::buildOptions('activity_type_id', 'get');
847 // If no activity types are specified or excluded, return the list of all active ones
848 if (empty($params['activity_type_id']) && empty($params['activity_type_exclude_id'])) {
849 if (!empty($activityTypes)) {
850 return array('IN' => array_keys($activityTypes));
855 // If we have specified activity types, build a list to return, excluding the ones we don't want.
856 if (!empty($params['activity_type_id'])) {
857 if (!is_array($params['activity_type_id'])) {
858 // Turn it into array if only one specified, so we don't duplicate processing below
859 $params['activity_type_id'] = array($params['activity_type_id'] => $params['activity_type_id']);
861 foreach ($params['activity_type_id'] as $value) {
862 // Add each activity type that was specified to list
863 $value = CRM_Utils_Type
::escape($value, 'Positive');
864 $activityTypes[$value] = $value;
868 // Build the list of activity types to exclude (from $params['activity_type_exclude_id'])
869 if (!empty($params['activity_type_exclude_id'])) {
870 if (!is_array($params['activity_type_exclude_id'])) {
871 // Turn it into array if only one specified, so we don't duplicate processing below
872 $params['activity_type_exclude_id'] = array($params['activity_type_exclude_id'] => $params['activity_type_exclude_id']);
874 foreach ($params['activity_type_exclude_id'] as $value) {
875 // Remove each activity type from list if it should be excluded
876 $value = CRM_Utils_Type
::escape($value, 'Positive');
877 if (array_key_exists($value, $activityTypes)) {
878 unset($activityTypes[$value]);
883 return array('IN' => array_keys($activityTypes));
887 * Get the list Activities.
891 * @todo - use the api for this - this is working but have temporarily backed out
892 * due to performance issue to be resolved - CRM-20481.
894 * @param array $input
895 * Array of parameters.
897 * - contact_id int contact_id whose activities we want to retrieve
898 * - offset int which row to start from ?
899 * - rowCount int how many rows to fetch
900 * - sort object|array object or array describing sort order for sql query.
901 * - admin boolean if contact is admin
902 * - caseId int case ID
903 * - context string page on which selector is build
904 * - activity_type_id int|string the activitiy types we want to restrict by
907 * Relevant data object values of open activities
909 public static function deprecatedGetActivities($input) {
910 // Step 1: Get the basic activity data.
911 $bulkActivityTypeID = CRM_Core_PseudoConstant
::getKey('CRM_Activity_BAO_Activity',
916 $activityContacts = CRM_Activity_BAO_ActivityContact
::buildOptions('record_type_id', 'validate');
917 $sourceID = CRM_Utils_Array
::key('Activity Source', $activityContacts);
918 $assigneeID = CRM_Utils_Array
::key('Activity Assignees', $activityContacts);
919 $targetID = CRM_Utils_Array
::key('Activity Targets', $activityContacts);
921 $config = CRM_Core_Config
::singleton();
923 $activityTempTable = CRM_Utils_SQL_TempTable
::build()->setCategory('actdetail')->getName();
925 $tableFields = array(
926 'activity_id' => 'int unsigned',
927 'activity_date_time' => 'datetime',
928 'source_record_id' => 'int unsigned',
929 'status_id' => 'int unsigned',
930 'subject' => 'varchar(255)',
931 'source_contact_name' => 'varchar(255)',
932 'activity_type_id' => 'int unsigned',
933 'activity_type' => 'varchar(128)',
934 'case_id' => 'int unsigned',
935 'case_subject' => 'varchar(255)',
936 'campaign_id' => 'int unsigned',
939 $sql = "CREATE TEMPORARY TABLE {$activityTempTable} ( ";
940 $insertValueSQL = $selectColumns = array();
941 // The activityTempTable contains the sorted rows
942 // so in order to maintain the sort order as-is we add an auto_increment
943 // field; we can sort by this later to ensure the sort order stays correct.
944 $sql .= " fixed_sort_order INT UNSIGNED NOT NULL AUTO_INCREMENT PRIMARY KEY,";
945 foreach ($tableFields as $name => $desc) {
946 $sql .= "$name $desc,\n";
947 $insertValueSQL[] = $name;
948 if ($name == 'source_contact_name' && CRM_Utils_SQL
::supportsFullGroupBy()) {
949 $selectColumns[] = "ANY_VALUE(tbl.$name)";
952 $selectColumns[] = "tbl.$name";
956 // add unique key on activity_id just to be sure
957 // this cannot be primary key because we need that for the auto_increment
958 // fixed_sort_order field
960 UNIQUE KEY ( activity_id )
961 ) ENGINE=HEAP DEFAULT CHARACTER SET utf8 COLLATE utf8_unicode_ci
964 CRM_Core_DAO
::executeQuery($sql);
966 $insertSQL = "INSERT IGNORE INTO {$activityTempTable} (" . implode(',', $insertValueSQL) . " ) ";
968 $order = $limit = $groupBy = '';
969 $groupBy = " GROUP BY tbl.activity_id, tbl.activity_type, tbl.case_id, tbl.case_subject ";
971 if (!empty($input['sort'])) {
972 if (is_a($input['sort'], 'CRM_Utils_Sort')) {
973 $orderBy = $input['sort']->orderBy();
974 if (!empty($orderBy)) {
975 $order = " ORDER BY $orderBy";
978 elseif (trim($input['sort'])) {
979 $sort = CRM_Utils_Type
::escape($input['sort'], 'String');
980 $order = " ORDER BY $sort ";
985 // context = 'activity' in Activities tab.
986 $order = " ORDER BY tbl.activity_date_time desc ";
989 if (!empty($input['rowCount']) &&
990 $input['rowCount'] > 0
992 $limit = " LIMIT {$input['offset']}, {$input['rowCount']} ";
995 $input['count'] = FALSE;
996 list($sqlClause, $params) = self
::deprecatedGetActivitySQLClause($input);
998 $query = sprintf("{$insertSQL} \n SELECT DISTINCT %s from ( %s ) \n as tbl ", implode(', ', $selectColumns), $sqlClause);
1000 // Filter case activities - CRM-5761.
1001 $components = self
::activityComponents();
1002 if (!in_array('CiviCase', $components)) {
1004 LEFT JOIN civicrm_case_activity ON ( civicrm_case_activity.activity_id = tbl.activity_id )
1005 WHERE civicrm_case_activity.id IS NULL";
1008 $query = $query . $groupBy . $order . $limit;
1010 $dao = CRM_Core_DAO
::executeQuery($query, $params);
1012 // step 2: Get target and assignee contacts for above activities
1013 // create temp table for target contacts
1014 $activityContactTempTable = CRM_Utils_SQL_TempTable
::build()->setCategory('actcontact')->getName();
1015 $query = "CREATE TEMPORARY TABLE {$activityContactTempTable} (
1016 activity_id int unsigned, contact_id int unsigned, record_type_id varchar(16),
1017 contact_name varchar(255), is_deleted int unsigned, counter int unsigned, INDEX index_activity_id( activity_id ) )
1018 ENGINE=InnoDB DEFAULT CHARACTER SET utf8 COLLATE utf8_unicode_ci";
1020 CRM_Core_DAO
::executeQuery($query);
1022 // note that we ignore bulk email for targets, since we don't show it in selector
1024 INSERT INTO {$activityContactTempTable} ( activity_id, contact_id, record_type_id, contact_name, is_deleted )
1025 SELECT ac.activity_id,
1030 FROM {$activityTempTable}
1031 INNER JOIN civicrm_activity a ON ( a.id = {$activityTempTable}.activity_id )
1032 INNER JOIN civicrm_activity_contact ac ON ( ac.activity_id = {$activityTempTable}.activity_id )
1033 INNER JOIN civicrm_contact c ON c.id = ac.contact_id
1034 WHERE ac.record_type_id != %1
1036 $params = array(1 => array($targetID, 'Integer'));
1037 CRM_Core_DAO
::executeQuery($query, $params);
1039 $activityFields = array("ac.activity_id", "ac.contact_id", "ac.record_type_id", "c.sort_name", "c.is_deleted");
1040 $select = CRM_Contact_BAO_Query
::appendAnyValueToSelect($activityFields, "ac.activity_id");
1042 // for each activity insert one target contact
1043 // if we load all target contacts the performance will suffer a lot for mass-activities.
1045 INSERT INTO {$activityContactTempTable} ( activity_id, contact_id, record_type_id, contact_name, is_deleted, counter )
1046 {$select}, count(ac.contact_id)
1047 FROM {$activityTempTable}
1048 INNER JOIN civicrm_activity a ON ( a.id = {$activityTempTable}.activity_id )
1049 INNER JOIN civicrm_activity_contact ac ON ( ac.activity_id = {$activityTempTable}.activity_id )
1050 INNER JOIN civicrm_contact c ON c.id = ac.contact_id
1051 WHERE ac.record_type_id = %1
1052 GROUP BY ac.activity_id
1055 CRM_Core_DAO
::executeQuery($query, $params);
1057 // step 3: Combine all temp tables to get final query for activity selector
1058 // sort by the original sort order, stored in fixed_sort_order
1060 SELECT {$activityTempTable}.*,
1061 {$activityContactTempTable}.contact_id,
1062 {$activityContactTempTable}.record_type_id,
1063 {$activityContactTempTable}.contact_name,
1064 {$activityContactTempTable}.is_deleted,
1065 {$activityContactTempTable}.counter,
1066 re.parent_id as is_recurring_activity
1067 FROM {$activityTempTable}
1068 INNER JOIN {$activityContactTempTable} on {$activityTempTable}.activity_id = {$activityContactTempTable}.activity_id
1069 LEFT JOIN civicrm_recurring_entity re on {$activityContactTempTable}.activity_id = re.entity_id
1070 ORDER BY fixed_sort_order
1073 $dao = CRM_Core_DAO
::executeQuery($query);
1075 // CRM-3553, need to check user has access to target groups.
1076 $mailingIDs = CRM_Mailing_BAO_Mailing
::mailingACLIDs();
1078 (CRM_Core_Permission
::check('access CiviMail')) ||
1079 (CRM_Mailing_Info
::workflowEnabled() &&
1080 CRM_Core_Permission
::check('create mailings'))
1083 // Get all campaigns.
1084 $allCampaigns = CRM_Campaign_BAO_Campaign
::getCampaigns(NULL, NULL, FALSE, FALSE, FALSE, TRUE);
1086 while ($dao->fetch()) {
1087 $activityID = $dao->activity_id
;
1088 $values[$activityID]['activity_id'] = $dao->activity_id
;
1089 $values[$activityID]['source_record_id'] = $dao->source_record_id
;
1090 $values[$activityID]['activity_type_id'] = $dao->activity_type_id
;
1091 $values[$activityID]['activity_type'] = $dao->activity_type
;
1092 $values[$activityID]['activity_date_time'] = $dao->activity_date_time
;
1093 $values[$activityID]['status_id'] = $dao->status_id
;
1094 $values[$activityID]['subject'] = $dao->subject
;
1095 $values[$activityID]['campaign_id'] = $dao->campaign_id
;
1096 $values[$activityID]['is_recurring_activity'] = $dao->is_recurring_activity
;
1098 if ($dao->campaign_id
) {
1099 $values[$activityID]['campaign'] = $allCampaigns[$dao->campaign_id
];
1102 if (empty($values[$activityID]['assignee_contact_name'])) {
1103 $values[$activityID]['assignee_contact_name'] = array();
1106 if (empty($values[$activityID]['target_contact_name'])) {
1107 $values[$activityID]['target_contact_name'] = array();
1108 $values[$activityID]['target_contact_counter'] = $dao->counter
;
1111 // if deleted, wrap in <del>
1112 if ($dao->is_deleted
) {
1113 $dao->contact_name
= "<del>{$dao->contact_name}</del>";
1116 if ($dao->record_type_id
== $sourceID && $dao->contact_id
) {
1117 $values[$activityID]['source_contact_id'] = $dao->contact_id
;
1118 $values[$activityID]['source_contact_name'] = $dao->contact_name
;
1121 if (!$bulkActivityTypeID ||
($bulkActivityTypeID != $dao->activity_type_id
)) {
1122 // build array of target / assignee names
1123 if ($dao->record_type_id
== $targetID && $dao->contact_id
) {
1124 $values[$activityID]['target_contact_name'][$dao->contact_id
] = $dao->contact_name
;
1126 if ($dao->record_type_id
== $assigneeID && $dao->contact_id
) {
1127 $values[$activityID]['assignee_contact_name'][$dao->contact_id
] = $dao->contact_name
;
1130 // case related fields
1131 $values[$activityID]['case_id'] = $dao->case_id
;
1132 $values[$activityID]['case_subject'] = $dao->case_subject
;
1135 $values[$activityID]['recipients'] = ts('(%1 recipients)', array(1 => $dao->counter
));
1136 $values[$activityID]['mailingId'] = FALSE;
1139 ($mailingIDs === TRUE ||
in_array($dao->source_record_id
, $mailingIDs))
1141 $values[$activityID]['mailingId'] = TRUE;
1150 * Get the component id and name if those are enabled and allowed.
1152 * Checks whether logged in user has permission.
1153 * To decide whether we are going to include
1154 * component related activities with core activity retrieve process.
1155 * (what did that just mean?)
1158 * Array of component id and name.
1160 public static function activityComponents() {
1161 $components = array();
1162 $compInfo = CRM_Core_Component
::getEnabledComponents();
1163 foreach ($compInfo as $compObj) {
1164 if (!empty($compObj->info
['showActivitiesInCore'])) {
1165 if ($compObj->info
['name'] == 'CiviCampaign') {
1166 $componentPermission = "administer {$compObj->name}";
1169 $componentPermission = "access {$compObj->name}";
1171 if ($compObj->info
['name'] == 'CiviCase') {
1172 if (CRM_Case_BAO_Case
::accessCiviCase()) {
1173 $components[$compObj->componentID
] = $compObj->info
['name'];
1176 elseif (CRM_Core_Permission
::check($componentPermission)) {
1177 $components[$compObj->componentID
] = $compObj->info
['name'];
1186 * Get the activity Count.
1188 * @param array $input
1189 * Array of parameters.
1191 * - contact_id int contact_id whose activities we want to retrieve
1192 * - admin boolean if contact is admin
1193 * - caseId int case ID
1194 * - context string page on which selector is build
1195 * - activity_type_id int|string the activity types we want to restrict by
1198 * count of activities
1200 public static function getActivitiesCount($input) {
1201 return self
::getActivities($input, TRUE);
1205 * Get the activity Count.
1209 * @param array $input
1210 * Array of parameters.
1212 * - contact_id int contact_id whose activities we want to retrieve
1213 * - admin boolean if contact is admin
1214 * - caseId int case ID
1215 * - context string page on which selector is build
1216 * - activity_type_id int|string the activity types we want to restrict by
1219 * count of activities
1221 public static function deprecatedGetActivitiesCount($input) {
1222 $input['count'] = TRUE;
1223 list($sqlClause, $params) = self
::deprecatedGetActivitySQLClause($input);
1225 //filter case activities - CRM-5761
1226 $components = self
::activityComponents();
1227 if (!in_array('CiviCase', $components)) {
1229 SELECT COUNT(DISTINCT(tbl.activity_id)) as count
1230 FROM ( {$sqlClause} ) as tbl
1231 LEFT JOIN civicrm_case_activity ON ( civicrm_case_activity.activity_id = tbl.activity_id )
1232 WHERE civicrm_case_activity.id IS NULL";
1235 $query = "SELECT COUNT(DISTINCT(activity_id)) as count from ( {$sqlClause} ) as tbl";
1238 return CRM_Core_DAO
::singleValueQuery($query, $params);
1242 * Get the activity sql clause to pick activities.
1246 * @param array $input
1247 * Array of parameters.
1249 * - contact_id int contact_id whose activities we want to retrieve
1250 * - admin boolean if contact is admin
1251 * - caseId int case ID
1252 * - context string page on which selector is build
1253 * - count boolean are we interested in the count clause only?
1254 * - activity_type_id int|string the activity types we want to restrict by
1257 * count of activities
1259 public static function deprecatedGetActivitySQLClause($input) {
1261 $sourceWhere = $targetWhere = $assigneeWhere = $caseWhere = 1;
1263 $config = CRM_Core_Config
::singleton();
1264 if (!CRM_Utils_Array
::value('admin', $input, FALSE)) {
1265 $sourceWhere = ' ac.contact_id = %1 ';
1266 $caseWhere = ' civicrm_case_contact.contact_id = %1 ';
1268 $params = array(1 => array($input['contact_id'], 'Integer'));
1271 $commonClauses = array(
1272 "civicrm_option_group.name = 'activity_type'",
1273 "civicrm_activity.is_deleted = 0",
1274 "civicrm_activity.is_current_revision = 1",
1275 "civicrm_activity.is_test= 0",
1278 if (isset($input['activity_date_relative']) ||
1279 (!empty($input['activity_date_low']) ||
!empty($input['activity_date_high']))
1281 list($from, $to) = CRM_Utils_Date
::getFromTo(
1282 CRM_Utils_Array
::value('activity_date_relative', $input, 0),
1283 CRM_Utils_Array
::value('activity_date_low', $input),
1284 CRM_Utils_Array
::value('activity_date_high', $input)
1286 $commonClauses[] = sprintf('civicrm_activity.activity_date_time BETWEEN "%s" AND "%s" ', $from, $to);
1289 if (!empty($input['activity_status_id'])) {
1290 $commonClauses[] = sprintf("civicrm_activity.status_id IN (%s)", $input['activity_status_id']);
1293 // Filter on component IDs.
1294 $components = self
::activityComponents();
1295 if (!empty($components)) {
1296 $componentsIn = implode(',', array_keys($components));
1297 $commonClauses[] = "( civicrm_option_value.component_id IS NULL OR civicrm_option_value.component_id IN ( $componentsIn ) )";
1300 $commonClauses[] = "civicrm_option_value.component_id IS NULL";
1303 // activity type ID clause
1304 if (!empty($input['activity_type_id'])) {
1305 if (is_array($input['activity_type_id'])) {
1306 foreach ($input['activity_type_id'] as $idx => $value) {
1307 $input['activity_type_id'][$idx] = CRM_Utils_Type
::escape($value, 'Positive');
1309 $commonClauses[] = "civicrm_activity.activity_type_id IN ( " . implode(",", $input['activity_type_id']) . " ) ";
1312 $activityTypeID = CRM_Utils_Type
::escape($input['activity_type_id'], 'Positive');
1313 $commonClauses[] = "civicrm_activity.activity_type_id = $activityTypeID";
1317 // exclude by activity type clause
1318 if (!empty($input['activity_type_exclude_id'])) {
1319 if (is_array($input['activity_type_exclude_id'])) {
1320 foreach ($input['activity_type_exclude_id'] as $idx => $value) {
1321 $input['activity_type_exclude_id'][$idx] = CRM_Utils_Type
::escape($value, 'Positive');
1323 $commonClauses[] = "civicrm_activity.activity_type_id NOT IN ( " . implode(",", $input['activity_type_exclude_id']) . " ) ";
1326 $activityTypeID = CRM_Utils_Type
::escape($input['activity_type_exclude_id'], 'Positive');
1327 $commonClauses[] = "civicrm_activity.activity_type_id != $activityTypeID";
1331 $commonClause = implode(' AND ', $commonClauses);
1333 $includeCaseActivities = FALSE;
1334 if (in_array('CiviCase', $components)) {
1335 $includeCaseActivities = TRUE;
1338 // build main activity table select clause
1341 $activityContacts = CRM_Activity_BAO_ActivityContact
::buildOptions('record_type_id', 'validate');
1342 $sourceID = CRM_Utils_Array
::key('Activity Source', $activityContacts);
1344 INNER JOIN civicrm_activity_contact ac ON ac.activity_id = civicrm_activity.id
1345 INNER JOIN civicrm_contact contact ON ac.contact_id = contact.id
1348 if (!$input['count']) {
1350 civicrm_activity.activity_date_time,
1351 civicrm_activity.source_record_id,
1352 civicrm_activity.status_id,
1353 civicrm_activity.subject,
1354 contact.sort_name as source_contact_name,
1355 civicrm_option_value.value as activity_type_id,
1356 civicrm_option_value.label as activity_type,
1357 null as case_id, null as case_subject,
1358 civicrm_activity.campaign_id as campaign_id
1362 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)
1367 SELECT civicrm_activity.id as activity_id
1369 from civicrm_activity
1370 left join civicrm_option_value on
1371 civicrm_activity.activity_type_id = civicrm_option_value.value
1372 left join civicrm_option_group on
1373 civicrm_option_group.id = civicrm_option_value.option_group_id
1380 // Build case clause
1381 // or else exclude Inbound Emails that have been filed on a case.
1384 if ($includeCaseActivities) {
1386 if (!$input['count']) {
1388 civicrm_activity.activity_date_time,
1389 civicrm_activity.source_record_id,
1390 civicrm_activity.status_id,
1391 civicrm_activity.subject,
1392 contact.sort_name as source_contact_name,
1393 civicrm_option_value.value as activity_type_id,
1394 civicrm_option_value.label as activity_type,
1395 null as case_id, null as case_subject,
1396 civicrm_activity.campaign_id as campaign_id';
1402 SELECT civicrm_activity.id as activity_id
1404 from civicrm_activity
1405 inner join civicrm_case_activity on
1406 civicrm_case_activity.activity_id = civicrm_activity.id
1407 inner join civicrm_case on
1408 civicrm_case_activity.case_id = civicrm_case.id
1409 inner join civicrm_case_contact on
1410 civicrm_case_contact.case_id = civicrm_case.id and {$caseWhere}
1411 left join civicrm_option_value on
1412 civicrm_activity.activity_type_id = civicrm_option_value.value
1413 left join civicrm_option_group on
1414 civicrm_option_group.id = civicrm_option_value.option_group_id
1419 and ( ( civicrm_case_activity.case_id IS NULL ) OR
1420 ( civicrm_option_value.name <> 'Inbound Email' AND
1421 civicrm_option_value.name <> 'Email' AND civicrm_case_activity.case_id
1427 $returnClause = " {$sourceClause} {$caseClause} ";
1429 return array($returnClause, $params);
1433 * Send the message to all the contacts.
1435 * Also insert a contact activity in each contacts record.
1437 * @param array $contactDetails
1438 * The array of contact details to send the email.
1439 * @param string $subject
1440 * The subject of the message.
1443 * @param string $emailAddress
1444 * Use this 'to' email address instead of the default Primary address.
1445 * @param int $userID
1446 * Use this userID if set.
1447 * @param string $from
1448 * @param array $attachments
1449 * The array of attachments if any.
1452 * @param string $bcc
1454 * @param array $contactIds
1456 * @param string $additionalDetails
1457 * The additional information of CC and BCC appended to the activity Details.
1458 * @param array $contributionIds
1459 * @param int $campaignId
1462 * ( sent, activityId) if any email is sent and activityId
1464 public static function sendEmail(
1472 $attachments = NULL,
1476 $additionalDetails = NULL,
1477 $contributionIds = NULL,
1480 // get the contact details of logged in contact, which we set as from email
1481 if ($userID == NULL) {
1482 $userID = CRM_Core_Session
::getLoggedInContactID();
1485 list($fromDisplayName, $fromEmail, $fromDoNotEmail) = CRM_Contact_BAO_Contact
::getContactDetails($userID);
1487 return array(count($contactDetails), 0, count($contactDetails));
1489 if (!trim($fromDisplayName)) {
1490 $fromDisplayName = $fromEmail;
1494 // token replacement of addressee/email/postal greetings
1495 // get the tokens added in subject and message
1496 $subjectToken = CRM_Utils_Token
::getTokens($subject);
1497 $messageToken = CRM_Utils_Token
::getTokens($text);
1498 $messageToken = array_merge($messageToken, CRM_Utils_Token
::getTokens($html));
1499 $allTokens = array_merge($messageToken, $subjectToken);
1502 $from = "$fromDisplayName <$fromEmail>";
1505 //create the meta level record first ( email activity )
1506 $activityTypeID = CRM_Core_PseudoConstant
::getKey('CRM_Activity_BAO_Activity', 'activity_type_id', 'Email');
1508 // CRM-6265: save both text and HTML parts in details (if present)
1509 if ($html and $text) {
1510 $details = "-ALTERNATIVE ITEM 0-\n$html$additionalDetails\n-ALTERNATIVE ITEM 1-\n$text$additionalDetails\n-ALTERNATIVE END-\n";
1513 $details = $html ?
$html : $text;
1514 $details .= $additionalDetails;
1517 $activityParams = array(
1518 'source_contact_id' => $userID,
1519 'activity_type_id' => $activityTypeID,
1520 'activity_date_time' => date('YmdHis'),
1521 'subject' => $subject,
1522 'details' => $details,
1523 // FIXME: check for name Completed and get ID from that lookup
1524 'status_id' => CRM_Core_PseudoConstant
::getKey('CRM_Activity_BAO_Activity', 'status_id', 'Completed'),
1525 'campaign_id' => $campaignId,
1528 // CRM-5916: strip [case #…] before saving the activity (if present in subject)
1529 $activityParams['subject'] = preg_replace('/\[case #([0-9a-h]{7})\] /', '', $activityParams['subject']);
1531 // add the attachments to activity params here
1533 // first process them
1534 $activityParams = array_merge($activityParams,
1539 $activity = self
::create($activityParams);
1541 // get the set of attachments from where they are stored
1542 $attachments = CRM_Core_BAO_File
::getEntityFile('civicrm_activity',
1545 $returnProperties = array();
1546 if (isset($messageToken['contact'])) {
1547 foreach ($messageToken['contact'] as $key => $value) {
1548 $returnProperties[$value] = 1;
1552 if (isset($subjectToken['contact'])) {
1553 foreach ($subjectToken['contact'] as $key => $value) {
1554 if (!isset($returnProperties[$value])) {
1555 $returnProperties[$value] = 1;
1560 // get token details for contacts, call only if tokens are used
1562 if (!empty($returnProperties) ||
!empty($tokens) ||
!empty($allTokens)) {
1563 list($details) = CRM_Utils_Token
::getTokenDetails(
1568 'CRM_Activity_BAO_Activity'
1574 CRM_Utils_Hook
::tokens($tokens);
1575 $categories = array_keys($tokens);
1577 $escapeSmarty = FALSE;
1578 if (defined('CIVICRM_MAIL_SMARTY') && CIVICRM_MAIL_SMARTY
) {
1579 $smarty = CRM_Core_Smarty
::singleton();
1580 $escapeSmarty = TRUE;
1583 $contributionDetails = array();
1584 if (!empty($contributionIds)) {
1585 $contributionDetails = CRM_Contribute_BAO_Contribution
::replaceContributionTokens(
1596 $sent = $notSent = array();
1597 foreach ($contactDetails as $values) {
1598 $contactId = $values['contact_id'];
1599 $emailAddress = $values['email'];
1601 if (!empty($contributionDetails)) {
1602 $subject = $contributionDetails[$contactId]['subject'];
1603 $text = $contributionDetails[$contactId]['text'];
1604 $html = $contributionDetails[$contactId]['html'];
1607 if (!empty($details) && is_array($details["{$contactId}"])) {
1608 // unset email from details since it always returns primary email address
1609 unset($details["{$contactId}"]['email']);
1610 unset($details["{$contactId}"]['email_id']);
1611 $values = array_merge($values, $details["{$contactId}"]);
1614 $tokenSubject = CRM_Utils_Token
::replaceContactTokens($subject, $values, FALSE, $subjectToken, FALSE, $escapeSmarty);
1615 $tokenSubject = CRM_Utils_Token
::replaceHookTokens($tokenSubject, $values, $categories, FALSE, $escapeSmarty);
1618 if ($values['preferred_mail_format'] == 'Text' ||
$values['preferred_mail_format'] == 'Both') {
1619 $tokenText = CRM_Utils_Token
::replaceContactTokens($text, $values, FALSE, $messageToken, FALSE, $escapeSmarty);
1620 $tokenText = CRM_Utils_Token
::replaceHookTokens($tokenText, $values, $categories, FALSE, $escapeSmarty);
1626 if ($values['preferred_mail_format'] == 'HTML' ||
$values['preferred_mail_format'] == 'Both') {
1627 $tokenHtml = CRM_Utils_Token
::replaceContactTokens($html, $values, TRUE, $messageToken, FALSE, $escapeSmarty);
1628 $tokenHtml = CRM_Utils_Token
::replaceHookTokens($tokenHtml, $values, $categories, TRUE, $escapeSmarty);
1634 if (defined('CIVICRM_MAIL_SMARTY') && CIVICRM_MAIL_SMARTY
) {
1635 // also add the contact tokens to the template
1636 $smarty->assign_by_ref('contact', $values);
1638 $tokenSubject = $smarty->fetch("string:$tokenSubject");
1639 $tokenText = $smarty->fetch("string:$tokenText");
1640 $tokenHtml = $smarty->fetch("string:$tokenHtml");
1644 if (self
::sendMessage(
1662 return array($sent, $activity->id
);
1666 * Send SMS. Returns: bool $sent, int $activityId, int $success (number of sent SMS)
1668 * @param array $contactDetails
1669 * @param array $activityParams
1670 * @param array $smsProviderParams
1671 * @param array $contactIds
1672 * @param int $sourceContactId This is the source contact Id
1674 * @return array(bool $sent, int $activityId, int $success)
1675 * @throws CRM_Core_Exception
1677 public static function sendSMS(
1678 &$contactDetails = NULL,
1680 &$smsProviderParams = array(),
1681 &$contactIds = NULL,
1682 $sourceContactId = NULL
1684 if (!CRM_Core_Permission
::check('send SMS')) {
1685 throw new CRM_Core_Exception("You do not have the 'send SMS' permission");
1688 if (!isset($contactDetails) && !isset($contactIds)) {
1689 Throw new CRM_Core_Exception('You must specify either $contactDetails or $contactIds');
1691 // Populate $contactDetails and $contactIds if only one is set
1692 if (is_array($contactIds) && !empty($contactIds) && empty($contactDetails)) {
1693 foreach ($contactIds as $id) {
1695 $contactDetails[] = civicrm_api3('Contact', 'getsingle', array('contact_id' => $id));
1697 catch (Exception
$e) {
1698 // Contact Id doesn't exist
1702 elseif (is_array($contactDetails) && !empty($contactDetails) && empty($contactIds)) {
1703 foreach ($contactDetails as $contact) {
1704 $contactIds[] = $contact['contact_id'];
1708 // Get logged in User Id
1709 if (empty($sourceContactId)) {
1710 $sourceContactId = CRM_Core_Session
::getLoggedInContactID();
1713 $text = &$activityParams['sms_text_message'];
1715 // Create the meta level record first ( sms activity )
1716 $activityParams = array(
1717 'source_contact_id' => $sourceContactId,
1718 'activity_type_id' => CRM_Core_PseudoConstant
::getKey('CRM_Activity_BAO_Activity', 'activity_type_id', 'SMS'),
1719 'activity_date_time' => date('YmdHis'),
1720 'subject' => $activityParams['activity_subject'],
1722 'status_id' => CRM_Core_PseudoConstant
::getKey('CRM_Activity_BAO_Activity', 'status_id', 'Completed'),
1724 $activity = self
::create($activityParams);
1725 $activityID = $activity->id
;
1728 // token replacement of addressee/email/postal greetings
1729 // get the tokens added in subject and message
1730 $messageToken = CRM_Utils_Token
::getTokens($text);
1731 $returnProperties = array();
1732 if (isset($messageToken['contact'])) {
1733 foreach ($messageToken['contact'] as $key => $value) {
1734 $returnProperties[$value] = 1;
1739 CRM_Utils_Hook
::tokens($tokens);
1740 $categories = array_keys($tokens);
1741 // get token details for contacts, call only if tokens are used
1742 $tokenDetails = array();
1743 if (!empty($returnProperties) ||
!empty($tokens)) {
1744 list($tokenDetails) = CRM_Utils_Token
::getTokenDetails($contactIds,
1748 'CRM_Activity_BAO_Activity'
1754 foreach ($contactDetails as $contact) {
1755 $contactId = $contact['contact_id'];
1758 if (!empty($tokenDetails) && is_array($tokenDetails["{$contactId}"])) {
1759 // unset phone from details since it always returns primary number
1760 unset($tokenDetails["{$contactId}"]['phone']);
1761 unset($tokenDetails["{$contactId}"]['phone_type_id']);
1762 $contact = array_merge($contact, $tokenDetails["{$contactId}"]);
1764 $tokenText = CRM_Utils_Token
::replaceContactTokens($text, $contact, FALSE, $messageToken, FALSE, FALSE);
1765 $tokenText = CRM_Utils_Token
::replaceHookTokens($tokenText, $contact, $categories, FALSE, FALSE);
1767 // Only send if the phone is of type mobile
1768 if ($contact['phone_type_id'] == CRM_Core_PseudoConstant
::getKey('CRM_Core_BAO_Phone', 'phone_type_id', 'Mobile')) {
1769 $smsProviderParams['To'] = $contact['phone'];
1772 $smsProviderParams['To'] = '';
1775 $doNotSms = CRM_Utils_Array
::value('do_not_sms', $contact, 0);
1778 $errMsgs[] = PEAR
::raiseError('Contact Does not accept SMS', NULL, PEAR_ERROR_RETURN
);
1781 $sendResult = self
::sendSMSMessage(
1789 if (PEAR
::isError($sendResult)) {
1790 // Collect all of the PEAR_Error objects
1791 $errMsgs[] = $sendResult;
1799 // If at least one message was sent and no errors
1800 // were generated then return a boolean value of TRUE.
1801 // Otherwise, return FALSE (no messages sent) or
1802 // and array of 1 or more PEAR_Error objects.
1804 if ($success > 0 && count($errMsgs) == 0) {
1807 elseif (count($errMsgs) > 0) {
1811 return array($sent, $activity->id
, $success);
1815 * Send the sms message to a specific contact.
1818 * The contact id of the recipient.
1820 * @param array $smsProviderParams
1821 * The params used for sending sms.
1822 * @param int $activityID
1823 * The activity ID that tracks the message.
1824 * @param int $sourceContactID
1826 * @return bool|PEAR_Error
1827 * true on success or PEAR_Error object
1829 public static function sendSMSMessage(
1832 $smsProviderParams = array(),
1834 $sourceContactID = NULL
1836 $toPhoneNumber = NULL;
1837 if ($smsProviderParams['To']) {
1838 // If phone number is specified use it
1839 $toPhoneNumber = trim($smsProviderParams['To']);
1842 // No phone number specified, so find a suitable one for the contact
1843 $filters = array('is_deceased' => 0, 'is_deleted' => 0, 'do_not_sms' => 0);
1844 $toPhoneNumbers = CRM_Core_BAO_Phone
::allPhones($toID, FALSE, 'Mobile', $filters);
1845 // To get primary mobile phonenumber, if not get the first mobile phonenumber
1846 if (!empty($toPhoneNumbers)) {
1847 $toPhoneNumberDetails = reset($toPhoneNumbers);
1848 $toPhoneNumber = CRM_Utils_Array
::value('phone', $toPhoneNumberDetails);
1849 // Contact allows to send sms
1853 // make sure both phone are valid
1854 // and that the recipient wants to receive sms
1855 if (empty($toPhoneNumber)) {
1856 return PEAR
::raiseError(
1857 'Recipient phone number is invalid or recipient does not want to receive SMS',
1863 $recipient = $toPhoneNumber;
1864 $smsProviderParams['contact_id'] = $toID;
1865 $smsProviderParams['parent_activity_id'] = $activityID;
1867 $providerObj = CRM_SMS_Provider
::singleton(array('provider_id' => $smsProviderParams['provider_id']));
1868 $sendResult = $providerObj->send($recipient, $smsProviderParams, $tokenText, NULL, $sourceContactID);
1869 if (PEAR
::isError($sendResult)) {
1873 // add activity target record for every sms that is sent
1874 $targetID = CRM_Core_PseudoConstant
::getKey('CRM_Activity_BAO_ActivityContact', 'record_type_id', 'Activity Targets');
1875 $activityTargetParams = array(
1876 'activity_id' => $activityID,
1877 'contact_id' => $toID,
1878 'record_type_id' => $targetID,
1880 CRM_Activity_BAO_ActivityContact
::create($activityTargetParams);
1886 * Send the message to a specific contact.
1888 * @param string $from
1889 * The name and email of the sender.
1890 * @param int $fromID
1892 * The contact id of the recipient.
1893 * @param string $subject
1894 * The subject of the message.
1895 * @param $text_message
1896 * @param $html_message
1897 * @param string $emailAddress
1898 * Use this 'to' email address instead of the default Primary address.
1899 * @param int $activityID
1900 * The activity ID that tracks the message.
1901 * @param null $attachments
1906 * TRUE if successful else FALSE.
1908 public static function sendMessage(
1917 $attachments = NULL,
1921 list($toDisplayName, $toEmail, $toDoNotEmail) = CRM_Contact_BAO_Contact
::getContactDetails($toID);
1922 if ($emailAddress) {
1923 $toEmail = trim($emailAddress);
1926 // make sure both email addresses are valid
1927 // and that the recipient wants to receive email
1928 if (empty($toEmail) or $toDoNotEmail) {
1931 if (!trim($toDisplayName)) {
1932 $toDisplayName = $toEmail;
1935 $activityContacts = CRM_Activity_BAO_ActivityContact
::buildOptions('record_type_id', 'validate');
1936 $targetID = CRM_Utils_Array
::key('Activity Targets', $activityContacts);
1938 // create the params array
1939 $mailParams = array(
1940 'groupName' => 'Activity Email Sender',
1942 'toName' => $toDisplayName,
1943 'toEmail' => $toEmail,
1944 'subject' => $subject,
1947 'text' => $text_message,
1948 'html' => $html_message,
1949 'attachments' => $attachments,
1952 if (!CRM_Utils_Mail
::send($mailParams)) {
1956 // add activity target record for every mail that is send
1957 $activityTargetParams = array(
1958 'activity_id' => $activityID,
1959 'contact_id' => $toID,
1960 'record_type_id' => $targetID,
1962 CRM_Activity_BAO_ActivityContact
::create($activityTargetParams);
1967 * Combine all the importable fields from the lower levels object.
1969 * The ordering is important, since currently we do not have a weight
1970 * scheme. Adding weight is super important and should be done in the
1971 * next week or so, before this can be called complete.
1973 * @param bool $status
1976 * array of importable Fields
1978 public static function &importableFields($status = FALSE) {
1979 if (!self
::$_importableFields) {
1980 if (!self
::$_importableFields) {
1981 self
::$_importableFields = array();
1984 $fields = array('' => array('title' => ts('- do not import -')));
1987 $fields = array('' => array('title' => ts('- Activity Fields -')));
1990 $tmpFields = CRM_Activity_DAO_Activity
::import();
1991 $contactFields = CRM_Contact_BAO_Contact
::importableFields('Individual', NULL);
1993 // Using new Dedupe rule.
1994 $ruleParams = array(
1995 'contact_type' => 'Individual',
1996 'used' => 'Unsupervised',
1998 $fieldsArray = CRM_Dedupe_BAO_Rule
::dedupeRuleFields($ruleParams);
2000 $tmpConatctField = array();
2001 if (is_array($fieldsArray)) {
2002 foreach ($fieldsArray as $value) {
2003 $customFieldId = CRM_Core_DAO
::getFieldValue('CRM_Core_DAO_CustomField',
2008 $value = $customFieldId ?
'custom_' . $customFieldId : $value;
2009 $tmpConatctField[trim($value)] = $contactFields[trim($value)];
2010 $tmpConatctField[trim($value)]['title'] = $tmpConatctField[trim($value)]['title'] . " (match to contact)";
2013 $tmpConatctField['external_identifier'] = $contactFields['external_identifier'];
2014 $tmpConatctField['external_identifier']['title'] = $contactFields['external_identifier']['title'] . " (match to contact)";
2015 $fields = array_merge($fields, $tmpConatctField);
2016 $fields = array_merge($fields, $tmpFields);
2017 $fields = array_merge($fields, CRM_Core_BAO_CustomField
::getFieldsForImport('Activity'));
2018 self
::$_importableFields = $fields;
2020 return self
::$_importableFields;
2024 * @deprecated - use the api instead.
2026 * Get the Activities of a target contact.
2028 * @param int $contactId
2029 * Id of the contact whose activities need to find.
2032 * array of activity fields
2034 public static function getContactActivity($contactId) {
2035 // @todo remove this function entirely.
2036 $activities = array();
2037 $activityContacts = CRM_Activity_BAO_ActivityContact
::buildOptions('record_type_id', 'validate');
2038 $sourceID = CRM_Utils_Array
::key('Activity Source', $activityContacts);
2039 $assigneeID = CRM_Utils_Array
::key('Activity Assignees', $activityContacts);
2040 $targetID = CRM_Utils_Array
::key('Activity Targets', $activityContacts);
2042 // First look for activities where contactId is one of the targets
2044 SELECT activity_id, record_type_id
2045 FROM civicrm_activity_contact
2046 WHERE contact_id = $contactId
2048 $dao = CRM_Core_DAO
::executeQuery($query);
2049 while ($dao->fetch()) {
2050 if ($dao->record_type_id
== $targetID) {
2051 $activities[$dao->activity_id
]['targets'][$contactId] = $contactId;
2053 elseif ($dao->record_type_id
== $assigneeID) {
2054 $activities[$dao->activity_id
]['asignees'][$contactId] = $contactId;
2057 // do source stuff here
2058 $activities[$dao->activity_id
]['source_contact_id'] = $contactId;
2062 $activityIds = array_keys($activities);
2063 if (count($activityIds) < 1) {
2067 $activityIds = implode(',', $activityIds);
2069 SELECT activity.id as activity_id,
2071 subject, location, activity_date_time, details, status_id
2072 FROM civicrm_activity activity
2073 WHERE activity.id IN ($activityIds)";
2075 $dao = CRM_Core_DAO
::executeQuery($query);
2077 while ($dao->fetch()) {
2078 $activities[$dao->activity_id
]['id'] = $dao->activity_id
;
2079 $activities[$dao->activity_id
]['activity_type_id'] = $dao->activity_type_id
;
2080 $activities[$dao->activity_id
]['subject'] = $dao->subject
;
2081 $activities[$dao->activity_id
]['location'] = $dao->location
;
2082 $activities[$dao->activity_id
]['activity_date_time'] = $dao->activity_date_time
;
2083 $activities[$dao->activity_id
]['details'] = $dao->details
;
2084 $activities[$dao->activity_id
]['status_id'] = $dao->status_id
;
2085 $activities[$dao->activity_id
]['activity_name'] = CRM_Core_PseudoConstant
::getLabel('CRM_Activity_BAO_Activity', 'activity_type_id', $dao->activity_type_id
);
2086 $activities[$dao->activity_id
]['status'] = CRM_Core_PseudoConstant
::getLabel('CRM_Activity_BAO_Activity', 'activity_status_id', $dao->status_id
);
2088 // set to null if not set
2089 if (!isset($activities[$dao->activity_id
]['source_contact_id'])) {
2090 $activities[$dao->activity_id
]['source_contact_id'] = NULL;
2097 * Add activity for Membership/Event/Contribution.
2099 * @param object $activity
2100 * (reference) particular component object.
2101 * @param string $activityType
2102 * For Membership Signup or Renewal.
2103 * @param int $targetContactID
2104 * @param array $params
2105 * Activity params to override.
2109 public static function addActivity(
2111 $activityType = 'Membership Signup',
2112 $targetContactID = NULL,
2115 $date = date('YmdHis');
2116 if ($activity->__table
== 'civicrm_membership') {
2117 $component = 'Membership';
2119 elseif ($activity->__table
== 'civicrm_participant') {
2120 if ($activityType != 'Email') {
2121 $activityType = 'Event Registration';
2123 $component = 'Event';
2125 elseif ($activity->__table
== 'civicrm_contribution') {
2126 // create activity record only for Completed Contributions
2127 $contributionCompletedStatusId = CRM_Core_PseudoConstant
::getKey('CRM_Contribute_BAO_Contribution', 'contribution_status_id', 'Completed');
2128 if ($activity->contribution_status_id
!= $contributionCompletedStatusId) {
2131 $activityType = $component = 'Contribution';
2133 // retrieve existing activity based on source_record_id and activity_type
2134 if (empty($params['id'])) {
2135 $params['id'] = CRM_Utils_Array
::value('id', civicrm_api3('Activity', 'Get', array(
2136 'source_record_id' => $activity->id
,
2137 'activity_type_id' => $activityType,
2140 if (!empty($params['id'])) {
2141 // CRM-13237 : if activity record found, update it with campaign id of contribution
2142 $params['campaign_id'] = $activity->campaign_id
;
2145 $date = CRM_Utils_Date
::isoToMysql($activity->receive_date
);
2148 $activityParams = array(
2149 'source_contact_id' => $activity->contact_id
,
2150 'source_record_id' => $activity->id
,
2151 'activity_type_id' => CRM_Core_PseudoConstant
::getKey('CRM_Activity_BAO_Activity', 'activity_type_id', $activityType),
2152 'activity_date_time' => $date,
2153 'is_test' => $activity->is_test
,
2154 'status_id' => CRM_Core_PseudoConstant
::getKey('CRM_Activity_BAO_Activity', 'activity_status_id', 'Completed'),
2155 'skipRecentView' => TRUE,
2156 'campaign_id' => $activity->campaign_id
,
2158 $activityParams = array_merge($activityParams, $params);
2160 if (empty($activityParams['subject'])) {
2161 $activityParams['subject'] = self
::getActivitySubject($activity);
2164 if (!empty($activity->activity_id
)) {
2165 $activityParams['id'] = $activity->activity_id
;
2167 // create activity with target contacts
2168 $id = CRM_Core_Session
::getLoggedInContactID();
2170 $activityParams['source_contact_id'] = $id;
2171 $activityParams['target_contact_id'][] = $activity->contact_id
;
2175 if (property_exists($activity, 'details')) {
2176 $activityParams['details'] = $activity->details
;
2179 if ($targetContactID) {
2180 $activityParams['target_contact_id'][] = $targetContactID;
2182 // @todo - use api - remove lots of wrangling above. Remove deprecated fatal & let form layer
2183 // deal with any exceptions.
2184 if (is_a(self
::create($activityParams), 'CRM_Core_Error')) {
2185 CRM_Core_Error
::fatal("Failed creating Activity for $component of id {$activity->id}");
2191 * Get activity subject on basis of component object.
2193 * @param object $entityObj
2194 * particular component object.
2198 public static function getActivitySubject($entityObj) {
2199 switch ($entityObj->__table
) {
2200 case 'civicrm_membership':
2201 $membershipType = CRM_Member_PseudoConstant
::membershipType($entityObj->membership_type_id
);
2202 $subject = $membershipType ?
$membershipType : ts('Membership');
2204 if (is_array($subject)) {
2205 $subject = implode(", ", $subject);
2208 if (!CRM_Utils_System
::isNull($entityObj->source
)) {
2209 $subject .= " - {$entityObj->source}";
2212 if ($entityObj->owner_membership_id
) {
2213 list($displayName) = CRM_Contact_BAO_Contact
::getDisplayAndImage(CRM_Core_DAO
::getFieldValue('CRM_Member_DAO_Membership', $entityObj->owner_membership_id
, 'contact_id'));
2214 $subject .= sprintf(' (by %s)', $displayName);
2217 $subject .= " - Status: " . CRM_Core_DAO
::getFieldValue('CRM_Member_DAO_MembershipStatus', $entityObj->status_id
, 'label');
2220 case 'civicrm_participant':
2221 $event = CRM_Event_BAO_Event
::getEvents(1, $entityObj->event_id
, TRUE, FALSE);
2222 $roles = CRM_Event_PseudoConstant
::participantRole();
2223 $status = CRM_Event_PseudoConstant
::participantStatus();
2224 $subject = $event[$entityObj->event_id
];
2226 if (!empty($roles[$entityObj->role_id
])) {
2227 $subject .= ' - ' . $roles[$entityObj->role_id
];
2229 if (!empty($status[$entityObj->status_id
])) {
2230 $subject .= ' - ' . $status[$entityObj->status_id
];
2235 case 'civicrm_contribution':
2236 $subject = CRM_Utils_Money
::format($entityObj->total_amount
, $entityObj->currency
);
2237 if (!CRM_Utils_System
::isNull($entityObj->source
)) {
2238 $subject .= " - {$entityObj->source}";
2241 // Amount and source could exceed max length of subject column.
2242 return CRM_Utils_String
::ellipsify($subject, 255);
2247 * Get Parent activity for currently viewed activity.
2249 * @param int $activityId
2250 * Current activity id.
2253 * Id of parent activity otherwise false.
2255 public static function getParentActivity($activityId) {
2256 static $parentActivities = array();
2258 $activityId = CRM_Utils_Type
::escape($activityId, 'Integer');
2260 if (!array_key_exists($activityId, $parentActivities)) {
2261 $parentActivities[$activityId] = array();
2263 $parentId = CRM_Core_DAO
::getFieldValue('CRM_Activity_DAO_Activity',
2268 $parentActivities[$activityId] = $parentId ?
$parentId : FALSE;
2271 return $parentActivities[$activityId];
2275 * Get total count of prior revision of currently viewed activity.
2277 * @param $activityID
2278 * Current activity id.
2281 * $params count of prior activities otherwise false.
2283 public static function getPriorCount($activityID) {
2284 static $priorCounts = array();
2286 $activityID = CRM_Utils_Type
::escape($activityID, 'Integer');
2288 if (!array_key_exists($activityID, $priorCounts)) {
2289 $priorCounts[$activityID] = array();
2290 $originalID = CRM_Core_DAO
::getFieldValue('CRM_Activity_DAO_Activity',
2297 SELECT count( id ) AS cnt
2298 FROM civicrm_activity
2299 WHERE ( id = {$originalID} OR original_id = {$originalID} )
2300 AND is_current_revision = 0
2301 AND id < {$activityID}
2303 $params = array(1 => array($originalID, 'Integer'));
2304 $count = CRM_Core_DAO
::singleValueQuery($query, $params);
2306 $priorCounts[$activityID] = $count ?
$count : 0;
2309 return $priorCounts[$activityID];
2313 * Get all prior activities of currently viewed activity.
2315 * @param $activityID
2316 * Current activity id.
2317 * @param bool $onlyPriorRevisions
2320 * prior activities info.
2322 public static function getPriorAcitivities($activityID, $onlyPriorRevisions = FALSE) {
2323 static $priorActivities = array();
2325 $activityID = CRM_Utils_Type
::escape($activityID, 'Integer');
2326 $index = $activityID . '_' . (int) $onlyPriorRevisions;
2328 if (!array_key_exists($index, $priorActivities)) {
2329 $priorActivities[$index] = array();
2331 $originalID = CRM_Core_DAO
::getFieldValue('CRM_Activity_DAO_Activity',
2336 $originalID = $activityID;
2340 SELECT c.display_name as name, cl.modified_date as date, ca.id as activityID
2341 FROM civicrm_log cl, civicrm_contact c, civicrm_activity ca
2342 WHERE (ca.id = %1 OR ca.original_id = %1)
2343 AND cl.entity_table = 'civicrm_activity'
2344 AND cl.entity_id = ca.id
2345 AND cl.modified_id = c.id
2347 if ($onlyPriorRevisions) {
2348 $query .= " AND ca.id < {$activityID}";
2350 $query .= " ORDER BY ca.id DESC";
2352 $params = array(1 => array($originalID, 'Integer'));
2353 $dao = CRM_Core_DAO
::executeQuery($query, $params);
2355 while ($dao->fetch()) {
2356 $priorActivities[$index][$dao->activityID
]['id'] = $dao->activityID
;
2357 $priorActivities[$index][$dao->activityID
]['name'] = $dao->name
;
2358 $priorActivities[$index][$dao->activityID
]['date'] = $dao->date
;
2363 return $priorActivities[$index];
2367 * Find the latest revision of a given activity.
2369 * @param int $activityID
2370 * Prior activity id.
2373 * current activity id.
2375 public static function getLatestActivityId($activityID) {
2376 static $latestActivityIds = array();
2378 $activityID = CRM_Utils_Type
::escape($activityID, 'Integer');
2380 if (!array_key_exists($activityID, $latestActivityIds)) {
2381 $latestActivityIds[$activityID] = array();
2383 $originalID = CRM_Core_DAO
::getFieldValue('CRM_Activity_DAO_Activity',
2388 $activityID = $originalID;
2390 $params = array(1 => array($activityID, 'Integer'));
2391 $query = "SELECT id from civicrm_activity where original_id = %1 and is_current_revision = 1";
2393 $latestActivityIds[$activityID] = CRM_Core_DAO
::singleValueQuery($query, $params);
2396 return $latestActivityIds[$activityID];
2400 * Create a follow up a given activity.
2402 * @param int $activityId
2403 * activity id of parent activity.
2404 * @param array $params
2406 * @return CRM_Activity_BAO_Activity|null|object
2408 public static function createFollowupActivity($activityId, $params) {
2413 $followupParams = array();
2414 $followupParams['parent_id'] = $activityId;
2415 $followupParams['source_contact_id'] = CRM_Core_Session
::getLoggedInContactID();
2416 $followupParams['status_id'] = CRM_Core_PseudoConstant
::getKey('CRM_Activity_BAO_Activity', 'activity_status_id', 'Scheduled');
2418 $followupParams['activity_type_id'] = $params['followup_activity_type_id'];
2419 // Get Subject of Follow-up Activiity, CRM-4491
2420 $followupParams['subject'] = CRM_Utils_Array
::value('followup_activity_subject', $params);
2421 $followupParams['assignee_contact_id'] = CRM_Utils_Array
::value('followup_assignee_contact_id', $params);
2423 // Create target contact for followup.
2424 if (!empty($params['target_contact_id'])) {
2425 $followupParams['target_contact_id'] = $params['target_contact_id'];
2428 $followupParams['activity_date_time'] = CRM_Utils_Date
::processDate($params['followup_date'],
2429 $params['followup_date_time']
2431 $followupActivity = self
::create($followupParams);
2433 return $followupActivity;
2437 * Get Activity specific File according activity type Id.
2439 * @param int $activityTypeId
2441 * @param string $crmDir
2443 * @return string|bool
2444 * if file exists returns $activityTypeFile activity filename otherwise false.
2446 public static function getFileForActivityTypeId($activityTypeId, $crmDir = 'Activity') {
2447 $activityTypes = CRM_Case_PseudoConstant
::caseActivityType(FALSE, TRUE);
2449 if ($activityTypes[$activityTypeId]['name']) {
2450 $activityTypeFile = CRM_Utils_String
::munge(ucwords($activityTypes[$activityTypeId]['name']), '', 0);
2456 global $civicrm_root;
2457 $config = CRM_Core_Config
::singleton();
2458 if (!file_exists(rtrim($civicrm_root, '/') . "/CRM/{$crmDir}/Form/Activity/{$activityTypeFile}.php")) {
2459 if (empty($config->customPHPPathDir
)) {
2462 elseif (!file_exists(rtrim($config->customPHPPathDir
, '/') . "/CRM/{$crmDir}/Form/Activity/{$activityTypeFile}.php")) {
2467 return $activityTypeFile;
2471 * Restore the activity.
2473 * @param array $params
2475 * @return CRM_Activity_DAO_Activity
2477 public static function restoreActivity(&$params) {
2478 $activity = new CRM_Activity_DAO_Activity();
2479 $activity->copyValues($params);
2481 $activity->is_deleted
= 0;
2482 $result = $activity->save();
2488 * Return list of activity statuses of a given type.
2490 * Note: activity status options use the "grouping" field to distinguish status types.
2491 * Types are defined in class constants INCOMPLETE, COMPLETED, CANCELLED
2497 public static function getStatusesByType($type) {
2498 if (!isset(Civi
::$statics[__CLASS__
][__FUNCTION__
])) {
2499 $statuses = civicrm_api3('OptionValue', 'get', array(
2500 'option_group_id' => 'activity_status',
2501 'return' => array('value', 'name', 'filter'),
2502 'options' => array('limit' => 0),
2504 Civi
::$statics[__CLASS__
][__FUNCTION__
] = $statuses['values'];
2507 foreach (Civi
::$statics[__CLASS__
][__FUNCTION__
] as $status) {
2508 if ($status['filter'] == $type) {
2509 $ret[$status['value']] = $status['name'];
2516 * Check if activity is overdue.
2518 * @param array $activity
2522 public static function isOverdue($activity) {
2523 return array_key_exists($activity['status_id'], self
::getStatusesByType(self
::INCOMPLETE
)) && CRM_Utils_Date
::overdue($activity['activity_date_time']);
2527 * Get the exportable fields for Activities.
2529 * @param string $name
2530 * If it is called by case $name = Case else $name = Activity.
2533 * array of exportable Fields
2535 public static function exportableFields($name = 'Activity') {
2536 self
::$_exportableFields[$name] = array();
2538 // TODO: ideally we should retrieve all fields from xml, in this case since activity processing is done
2539 // my case hence we have defined fields as case_*
2540 if ($name == 'Activity') {
2541 $exportableFields = CRM_Activity_DAO_Activity
::export();
2542 $exportableFields['source_contact_id'] = [
2543 'title' => ts('Source Contact ID'),
2544 'type' => CRM_Utils_Type
::T_INT
,
2546 $exportableFields['source_contact'] = array(
2547 'title' => ts('Source Contact'),
2548 'type' => CRM_Utils_Type
::T_STRING
,
2551 $Activityfields = array(
2552 'activity_type' => array(
2553 'title' => ts('Activity Type'),
2554 'name' => 'activity_type',
2555 'type' => CRM_Utils_Type
::T_STRING
,
2556 'searchByLabel' => TRUE,
2558 'activity_status' => array(
2559 'title' => ts('Activity Status'),
2560 'name' => 'activity_status',
2561 'type' => CRM_Utils_Type
::T_STRING
,
2562 'searchByLabel' => TRUE,
2564 'activity_priority' => array(
2565 'title' => ts('Activity Priority'),
2566 'name' => 'activity_priority',
2567 'type' => CRM_Utils_Type
::T_STRING
,
2568 'searchByLabel' => TRUE,
2571 $fields = array_merge($Activityfields, $exportableFields);
2574 // Set title to activity fields.
2576 'case_activity_subject' => array('title' => ts('Activity Subject'), 'type' => CRM_Utils_Type
::T_STRING
),
2577 'case_source_contact_id' => array('title' => ts('Activity Reporter'), 'type' => CRM_Utils_Type
::T_STRING
),
2578 'case_recent_activity_date' => array('title' => ts('Activity Actual Date'), 'type' => CRM_Utils_Type
::T_DATE
),
2579 'case_scheduled_activity_date' => array(
2580 'title' => ts('Activity Scheduled Date'),
2581 'type' => CRM_Utils_Type
::T_DATE
,
2583 'case_recent_activity_type' => array('title' => ts('Activity Type'), 'type' => CRM_Utils_Type
::T_STRING
),
2584 'case_activity_status' => array('title' => ts('Activity Status'), 'type' => CRM_Utils_Type
::T_STRING
),
2585 'case_activity_duration' => array('title' => ts('Activity Duration'), 'type' => CRM_Utils_Type
::T_INT
),
2586 'case_activity_medium_id' => array('title' => ts('Activity Medium'), 'type' => CRM_Utils_Type
::T_INT
),
2587 'case_activity_details' => array('title' => ts('Activity Details'), 'type' => CRM_Utils_Type
::T_TEXT
),
2588 'case_activity_is_auto' => array(
2589 'title' => ts('Activity Auto-generated?'),
2590 'type' => CRM_Utils_Type
::T_BOOLEAN
,
2595 // add custom data for case activities
2596 $fields = array_merge($fields, CRM_Core_BAO_CustomField
::getFieldsForImport('Activity'));
2598 self
::$_exportableFields[$name] = $fields;
2599 return self
::$_exportableFields[$name];
2603 * Get the allowed profile fields for Activities.
2606 * array of activity profile Fields
2608 public static function getProfileFields() {
2609 $exportableFields = self
::exportableFields('Activity');
2610 $skipFields = array(
2613 'source_contact_id',
2615 'activity_campaign',
2617 'is_current_revision',
2618 'activity_is_deleted',
2620 $config = CRM_Core_Config
::singleton();
2621 if (!in_array('CiviCampaign', $config->enableComponents
)) {
2622 $skipFields[] = 'activity_engagement_level';
2625 foreach ($skipFields as $field) {
2626 if (isset($exportableFields[$field])) {
2627 unset($exportableFields[$field]);
2631 // hack to use 'activity_type_id' instead of 'activity_type'
2632 $exportableFields['activity_status_id'] = $exportableFields['activity_status'];
2633 unset($exportableFields['activity_status']);
2635 return $exportableFields;
2639 * This function deletes the activity record related to contact record.
2641 * This is conditional on there being no target and assignee record
2642 * with other contacts.
2644 * @param int $contactId
2649 public static function cleanupActivity($contactId) {
2654 $activityContacts = CRM_Activity_BAO_ActivityContact
::buildOptions('record_type_id', 'validate');
2655 $sourceID = CRM_Utils_Array
::key('Activity Source', $activityContacts);
2657 $transaction = new CRM_Core_Transaction();
2659 // delete activity if there is no record in civicrm_activity_contact
2660 // pointing to any other contact record
2661 $activityContact = new CRM_Activity_DAO_ActivityContact();
2662 $activityContact->contact_id
= $contactId;
2663 $activityContact->record_type_id
= $sourceID;
2664 $activityContact->find();
2666 while ($activityContact->fetch()) {
2667 // delete activity_contact record for the deleted contact
2668 $activityContact->delete();
2670 $activityContactOther = new CRM_Activity_DAO_ActivityContact();
2671 $activityContactOther->activity_id
= $activityContact->activity_id
;
2673 // delete activity only if no other contacts connected
2674 if (!$activityContactOther->find(TRUE)) {
2675 $activityParams = array('id' => $activityContact->activity_id
);
2676 $result = self
::deleteActivity($activityParams);
2679 $activityContactOther->free();
2682 $activityContact->free();
2683 $transaction->commit();
2689 * Does user has sufficient permission for view/edit activity record.
2691 * @param int $activityId
2692 * Activity record id.
2693 * @param int $action
2698 public static function checkPermission($activityId, $action) {
2701 !in_array($action, array(CRM_Core_Action
::UPDATE
, CRM_Core_Action
::VIEW
))
2706 $activity = new CRM_Activity_DAO_Activity();
2707 $activity->id
= $activityId;
2708 if (!$activity->find(TRUE)) {
2712 // Component related permissions.
2713 $compPermissions = array(
2714 'CiviCase' => array(
2715 'administer CiviCase',
2716 'access my cases and activities',
2717 'access all cases and activities',
2719 'CiviMail' => array('access CiviMail'),
2720 'CiviEvent' => array('access CiviEvent'),
2721 'CiviGrant' => array('access CiviGrant'),
2722 'CiviPledge' => array('access CiviPledge'),
2723 'CiviMember' => array('access CiviMember'),
2724 'CiviReport' => array('access CiviReport'),
2725 'CiviContribute' => array('access CiviContribute'),
2726 'CiviCampaign' => array('administer CiviCampaign'),
2729 // Return early when it is case activity.
2730 $isCaseActivity = CRM_Case_BAO_Case
::isCaseActivity($activityId);
2731 // Check for civicase related permission.
2732 if ($isCaseActivity) {
2734 foreach ($compPermissions['CiviCase'] as $per) {
2735 if (CRM_Core_Permission
::check($per)) {
2741 // Check for case specific permissions.
2744 if ($action == CRM_Core_Action
::UPDATE
) {
2747 $allow = CRM_Case_BAO_Case
::checkPermission($activityId,
2749 $activity->activity_type_id
2756 // First check the component permission.
2759 FROM civicrm_option_value val
2760 INNER JOIN civicrm_option_group grp ON ( grp.id = val.option_group_id AND grp.name = %1 )
2761 WHERE val.value = %2";
2763 1 => array('activity_type', 'String'),
2764 2 => array($activity->activity_type_id
, 'Integer'),
2766 $componentId = CRM_Core_DAO
::singleValueQuery($sql, $params);
2769 $componentName = CRM_Core_Component
::getComponentName($componentId);
2770 $compPermission = CRM_Utils_Array
::value($componentName, $compPermissions);
2772 // Here we are interesting in any single permission.
2773 if (is_array($compPermission)) {
2774 foreach ($compPermission as $per) {
2775 if (CRM_Core_Permission
::check($per)) {
2783 // Check for this permission related to contact.
2784 $permission = CRM_Core_Permission
::VIEW
;
2785 if ($action == CRM_Core_Action
::UPDATE
) {
2786 $permission = CRM_Core_Permission
::EDIT
;
2789 $activityContacts = CRM_Activity_BAO_ActivityContact
::buildOptions('record_type_id', 'validate');
2790 $sourceID = CRM_Utils_Array
::key('Activity Source', $activityContacts);
2791 $assigneeID = CRM_Utils_Array
::key('Activity Assignees', $activityContacts);
2792 $targetID = CRM_Utils_Array
::key('Activity Targets', $activityContacts);
2794 // Check for source contact.
2795 if (!$componentId ||
$allow) {
2796 $sourceContactId = self
::getActivityContact($activity->id
, $sourceID);
2797 // Account for possibility of activity not having a source contact (as it may have been deleted).
2798 $allow = $sourceContactId ? CRM_Contact_BAO_Contact_Permission
::allow($sourceContactId, $permission) : TRUE;
2801 // Check for target and assignee contacts.
2803 // First check for supper permission.
2804 $supPermission = 'view all contacts';
2805 if ($action == CRM_Core_Action
::UPDATE
) {
2806 $supPermission = 'edit all contacts';
2808 $allow = CRM_Core_Permission
::check($supPermission);
2810 // User might have sufficient permission, through acls.
2813 // Get the target contacts.
2814 $targetContacts = CRM_Activity_BAO_ActivityContact
::retrieveContactIdsByActivityId($activity->id
, $targetID);
2815 foreach ($targetContacts as $cnt => $contactId) {
2816 if (!CRM_Contact_BAO_Contact_Permission
::allow($contactId, $permission)) {
2822 // Get the assignee contacts.
2824 $assigneeContacts = CRM_Activity_BAO_ActivityContact
::retrieveContactIdsByActivityId($activity->id
, $assigneeID);
2825 foreach ($assigneeContacts as $cnt => $contactId) {
2826 if (!CRM_Contact_BAO_Contact_Permission
::allow($contactId, $permission)) {
2839 * Checks if user has permissions to edit inbound e-mails, either bsic info
2840 * or both basic information and content.
2844 public function checkEditInboundEmailsPermissions() {
2845 if (CRM_Core_Permission
::check('edit inbound email basic information')
2846 || CRM_Core_Permission
::check('edit inbound email basic information and content')
2855 * Wrapper for ajax activity selector.
2857 * @param array $params
2858 * Associated array for params record id.
2861 * Associated array of contact activities
2863 public static function getContactActivitySelector(&$params) {
2864 // Format the params.
2865 $params['offset'] = ($params['page'] - 1) * $params['rp'];
2866 $params['rowCount'] = $params['rp'];
2867 $params['sort'] = CRM_Utils_Array
::value('sortBy', $params);
2868 $params['caseId'] = NULL;
2869 $context = CRM_Utils_Array
::value('context', $params);
2870 $showContactOverlay = !CRM_Utils_String
::startsWith($context, "dashlet");
2871 $activityTypeInfo = civicrm_api3('OptionValue', 'get', array(
2872 'option_group_id' => "activity_type",
2873 'options' => array('limit' => 0),
2875 $activityIcons = array();
2876 foreach ($activityTypeInfo['values'] as $type) {
2877 if (!empty($type['icon'])) {
2878 $activityIcons[$type['value']] = $type['icon'];
2882 // Get contact activities.
2883 $activities = CRM_Activity_BAO_Activity
::deprecatedGetActivities($params);
2886 $params['total'] = CRM_Activity_BAO_Activity
::deprecatedGetActivitiesCount($params);
2888 // Format params and add links.
2889 $contactActivities = array();
2891 if (!empty($activities)) {
2892 $activityStatus = CRM_Core_PseudoConstant
::activityStatus();
2894 // Check logged in user for permission.
2895 $page = new CRM_Core_Page();
2896 CRM_Contact_Page_View
::checkUserPermission($page, $params['contact_id']);
2897 $permissions = array($page->_permission
);
2898 if (CRM_Core_Permission
::check('delete activities')) {
2899 $permissions[] = CRM_Core_Permission
::DELETE
;
2902 $mask = CRM_Core_Action
::mask($permissions);
2904 foreach ($activities as $activityId => $values) {
2905 $activity = array();
2906 $activity['DT_RowId'] = $activityId;
2907 // Add class to this row if overdue.
2908 $activity['DT_RowClass'] = "crm-entity status-id-{$values['status_id']}";
2909 if (self
::isOverdue($values)) {
2910 $activity['DT_RowClass'] .= ' status-overdue';
2913 $activity['DT_RowClass'] .= ' status-ontime';
2916 $activity['DT_RowAttr'] = array();
2917 $activity['DT_RowAttr']['data-entity'] = 'activity';
2918 $activity['DT_RowAttr']['data-id'] = $activityId;
2920 $activity['activity_type'] = (!empty($activityIcons[$values['activity_type_id']]) ?
'<span class="crm-i ' . $activityIcons[$values['activity_type_id']] . '"></span> ' : '') . $values['activity_type'];
2921 $activity['subject'] = $values['subject'];
2923 $activity['source_contact_name'] = '';
2924 if ($params['contact_id'] == $values['source_contact_id']) {
2925 $activity['source_contact_name'] = $values['source_contact_name'];
2927 elseif ($values['source_contact_id']) {
2929 if ($showContactOverlay) {
2930 $srcTypeImage = CRM_Contact_BAO_Contact_Utils
::getImage(
2931 CRM_Contact_BAO_Contact
::getContactType($values['source_contact_id']),
2933 $values['source_contact_id']);
2935 $activity['source_contact_name'] = $srcTypeImage . CRM_Utils_System
::href($values['source_contact_name'],
2936 'civicrm/contact/view', "reset=1&cid={$values['source_contact_id']}");
2939 $activity['source_contact_name'] = '<em>n/a</em>';
2942 $activity['target_contact_name'] = '';
2943 if (isset($values['mailingId']) && !empty($values['mailingId'])) {
2944 $activity['target_contact'] = CRM_Utils_System
::href($values['recipients'],
2945 'civicrm/mailing/report/event',
2946 "mid={$values['source_record_id']}&reset=1&event=queue&cid={$params['contact_id']}&context=activitySelector");
2948 elseif (!empty($values['recipients'])) {
2949 $activity['target_contact_name'] = $values['recipients'];
2951 elseif (isset($values['target_contact_counter']) && $values['target_contact_counter']) {
2952 $activity['target_contact_name'] = '';
2953 $firstTargetName = reset($values['target_contact_name']);
2954 $firstTargetContactID = key($values['target_contact_name']);
2956 $targetLink = CRM_Utils_System
::href($firstTargetName, 'civicrm/contact/view', "reset=1&cid={$firstTargetContactID}");
2957 if ($showContactOverlay) {
2958 $targetTypeImage = CRM_Contact_BAO_Contact_Utils
::getImage(
2959 CRM_Contact_BAO_Contact
::getContactType($firstTargetContactID),
2961 $firstTargetContactID);
2962 $activity['target_contact_name'] .= "<div>$targetTypeImage $targetLink";
2965 $activity['target_contact_name'] .= $targetLink;
2968 if ($extraCount = $values['target_contact_counter'] - 1) {
2969 $activity['target_contact_name'] .= ";<br />" . "(" . ts('%1 more', array(1 => $extraCount)) . ")";
2971 if ($showContactOverlay) {
2972 $activity['target_contact_name'] .= "</div> ";
2975 elseif (!$values['target_contact_name']) {
2976 $activity['target_contact_name'] = '<em>n/a</em>';
2979 $activity['assignee_contact_name'] = '';
2980 if (empty($values['assignee_contact_name'])) {
2981 $activity['assignee_contact_name'] = '<em>n/a</em>';
2983 elseif (!empty($values['assignee_contact_name'])) {
2985 $activity['assignee_contact_name'] = '';
2986 foreach ($values['assignee_contact_name'] as $acID => $acName) {
2987 if ($acID && $count < 5) {
2988 $assigneeTypeImage = "";
2989 $assigneeLink = CRM_Utils_System
::href($acName, 'civicrm/contact/view', "reset=1&cid={$acID}");
2990 if ($showContactOverlay) {
2991 $assigneeTypeImage = CRM_Contact_BAO_Contact_Utils
::getImage(
2992 CRM_Contact_BAO_Contact
::getContactType($acID),
2995 $activity['assignee_contact_name'] .= "<div>$assigneeTypeImage $assigneeLink";
2998 $activity['assignee_contact_name'] .= $assigneeLink;
3003 $activity['assignee_contact_name'] .= "; ";
3005 if ($showContactOverlay) {
3006 $activity['assignee_contact_name'] .= "</div> ";
3010 $activity['assignee_contact_name'] .= "(" . ts('more') . ")";
3017 $activity['activity_date_time'] = CRM_Utils_Date
::customFormat($values['activity_date_time']);
3018 $activity['status_id'] = $activityStatus[$values['status_id']];
3021 $activity['links'] = '';
3022 $accessMailingReport = FALSE;
3023 if (!empty($values['mailingId'])) {
3024 $accessMailingReport = TRUE;
3027 $actionLinks = CRM_Activity_Selector_Activity
::actionLinks(
3028 CRM_Utils_Array
::value('activity_type_id', $values),
3029 CRM_Utils_Array
::value('source_record_id', $values),
3030 $accessMailingReport,
3031 CRM_Utils_Array
::value('activity_id', $values)
3034 $actionMask = array_sum(array_keys($actionLinks)) & $mask;
3036 $activity['links'] = CRM_Core_Action
::formLink($actionLinks,
3039 'id' => $values['activity_id'],
3040 'cid' => $params['contact_id'],
3042 'caseid' => CRM_Utils_Array
::value('case_id', $values),
3048 $values['activity_id']
3051 if ($values['is_recurring_activity']) {
3052 $activity['is_recurring_activity'] = CRM_Core_BAO_RecurringEntity
::getPositionAndCount($values['activity_id'], 'civicrm_activity');
3055 array_push($contactActivities, $activity);
3059 $activitiesDT = array();
3060 $activitiesDT['data'] = $contactActivities;
3061 $activitiesDT['recordsTotal'] = $params['total'];
3062 $activitiesDT['recordsFiltered'] = $params['total'];
3064 return $activitiesDT;
3068 * Copy custom fields and attachments from an existing activity to another.
3070 * @see CRM_Case_Page_AJAX::_convertToCaseActivity()
3072 * @param array $params
3074 public static function copyExtendedActivityData($params) {
3075 // attach custom data to the new activity
3076 $customParams = $htmlType = array();
3077 $customValues = CRM_Core_BAO_CustomValueTable
::getEntityValues($params['activityID'], 'Activity');
3079 if (!empty($customValues)) {
3080 $fieldIds = implode(', ', array_keys($customValues));
3081 $sql = "SELECT id FROM civicrm_custom_field WHERE html_type = 'File' AND id IN ( {$fieldIds} )";
3082 $result = CRM_Core_DAO
::executeQuery($sql);
3084 while ($result->fetch()) {
3085 $htmlType[] = $result->id
;
3088 foreach ($customValues as $key => $value) {
3089 if ($value !== NULL) {
3091 if (in_array($key, $htmlType)) {
3092 $fileValues = CRM_Core_BAO_File
::path($value, $params['activityID']);
3093 $customParams["custom_{$key}_-1"] = array(
3094 'name' => $fileValues[0],
3095 'path' => $fileValues[1],
3099 $customParams["custom_{$key}_-1"] = $value;
3103 CRM_Core_BAO_CustomValueTable
::postProcess($customParams, 'civicrm_activity',
3104 $params['mainActivityId'], 'Activity'
3108 // copy activity attachments ( if any )
3109 CRM_Core_BAO_File
::copyEntityFile('civicrm_activity', $params['activityID'], 'civicrm_activity', $params['mainActivityId']);
3113 * Get activity contact.
3115 * @param int $activityId
3116 * @param int $recordTypeID
3117 * @param string $column
3121 public static function getActivityContact($activityId, $recordTypeID = NULL, $column = 'contact_id') {
3122 $activityContact = new CRM_Activity_BAO_ActivityContact();
3123 $activityContact->activity_id
= $activityId;
3124 if ($recordTypeID) {
3125 $activityContact->record_type_id
= $recordTypeID;
3127 if ($activityContact->find(TRUE)) {
3128 return $activityContact->$column;
3134 * Get source contact id.
3136 * @param int $activityId
3140 public static function getSourceContactID($activityId) {
3141 static $sourceID = NULL;
3143 $activityContacts = CRM_Activity_BAO_ActivityContact
::buildOptions('record_type_id', 'validate');
3144 $sourceID = CRM_Utils_Array
::key('Activity Source', $activityContacts);
3147 return self
::getActivityContact($activityId, $sourceID);
3153 * @todo Document what this is for.
3155 * @param array $params
3157 public function setApiFilter(&$params) {
3158 if (!empty($params['target_contact_id'])) {
3160 $activityContacts = CRM_Activity_BAO_ActivityContact
::buildOptions('record_type_id', 'validate');
3161 $targetID = CRM_Utils_Array
::key('Activity Targets', $activityContacts);
3162 $obj = new CRM_Activity_BAO_ActivityContact();
3163 $params['return.target_contact_id'] = 1;
3164 $this->joinAdd($obj, 'LEFT');
3165 $this->selectAdd('civicrm_activity.*');
3166 $this->whereAdd(" civicrm_activity_contact.contact_id = {$params['target_contact_id']} AND civicrm_activity_contact.record_type_id = {$targetID}");
3171 * Send activity as attachment.
3173 * @param object $activity
3174 * @param array $mailToContacts
3175 * @param array $params
3179 public static function sendToAssignee($activity, $mailToContacts, $params = array()) {
3180 if (!CRM_Utils_Array
::crmIsEmptyArray($mailToContacts)) {
3181 $clientID = CRM_Utils_Array
::value('client_id', $params);
3182 $caseID = CRM_Utils_Array
::value('case_id', $params);
3184 $ics = new CRM_Activity_BAO_ICalendar($activity);
3185 $attachments = CRM_Core_BAO_File
::getEntityFile('civicrm_activity', $activity->id
);
3186 $ics->addAttachment($attachments, $mailToContacts);
3188 $result = CRM_Case_BAO_Case
::sendActivityCopy($clientID, $activity->id
, $mailToContacts, $attachments, $caseID);