3 +--------------------------------------------------------------------+
4 | CiviCRM version 4.7 |
5 +--------------------------------------------------------------------+
6 | Copyright CiviCRM LLC (c) 2004-2017 |
7 +--------------------------------------------------------------------+
8 | This file is a part of CiviCRM. |
10 | CiviCRM is free software; you can copy, modify, and distribute it |
11 | under the terms of the GNU Affero General Public License |
12 | Version 3, 19 November 2007 and the CiviCRM Licensing Exception. |
14 | CiviCRM is distributed in the hope that it will be useful, but |
15 | WITHOUT ANY WARRANTY; without even the implied warranty of |
16 | MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. |
17 | See the GNU Affero General Public License for more details. |
19 | You should have received a copy of the GNU Affero General Public |
20 | License and the CiviCRM Licensing Exception along |
21 | with this program; if not, contact CiviCRM LLC |
22 | at info[AT]civicrm[DOT]org. If you have questions about the |
23 | GNU Affero General Public License or the licensing of CiviCRM, |
24 | see the CiviCRM license FAQ at http://civicrm.org/licensing |
25 +--------------------------------------------------------------------+
31 * @copyright CiviCRM LLC (c) 2004-2017
35 * This class is for activity functions.
37 class CRM_Activity_BAO_Activity
extends CRM_Activity_DAO_Activity
{
40 * Static field for all the activity information that we can potentially export.
44 static $_exportableFields = NULL;
47 * Static field for all the activity information that we can potentially import.
51 static $_importableFields = NULL;
54 * Check if there is absolute minimum of data to add the object.
56 * @param array $params
57 * (reference ) an assoc array of name/value pairs.
61 public static function dataExists(&$params) {
62 if (!empty($params['source_contact_id']) ||
!empty($params['id'])) {
71 * Fetch object based on array of properties.
73 * @param array $params
74 * (reference ) an assoc array of name/value pairs.
75 * @param array $defaults
76 * (reference ) an assoc array to hold the flattened values.
78 * @return CRM_Activity_DAO_Activity
80 public static function retrieve(&$params, &$defaults) {
81 // this will bypass acls - use the api instead.
82 // @todo add deprecation logging to this function.
83 $activity = new CRM_Activity_DAO_Activity();
84 $activity->copyValues($params);
86 if ($activity->find(TRUE)) {
87 $activityContacts = CRM_Core_OptionGroup
::values('activity_contacts', FALSE, FALSE, FALSE, NULL, 'name');
88 $targetID = CRM_Utils_Array
::key('Activity Targets', $activityContacts);
89 $sourceID = CRM_Utils_Array
::key('Activity Source', $activityContacts);
90 $assigneeID = CRM_Utils_Array
::key('Activity Assignees', $activityContacts);
92 // TODO: at some stage we'll have to deal
93 // with multiple values for assignees and targets, but
94 // for now, let's just fetch first row.
95 $defaults['assignee_contact'] = CRM_Activity_BAO_ActivityContact
::retrieveContactIdsByActivityId($activity->id
, $assigneeID);
96 $assignee_contact_names = CRM_Activity_BAO_ActivityContact
::getNames($activity->id
, $assigneeID);
97 $defaults['assignee_contact_value'] = implode('; ', $assignee_contact_names);
98 $sourceContactId = self
::getActivityContact($activity->id
, $sourceID);
99 if ($activity->activity_type_id
!= CRM_Core_PseudoConstant
::getKey('CRM_Activity_BAO_Activity', 'activity_type_id', 'Bulk Email')) {
100 $defaults['target_contact'] = CRM_Activity_BAO_ActivityContact
::retrieveContactIdsByActivityId($activity->id
, $targetID);
101 $target_contact_names = CRM_Activity_BAO_ActivityContact
::getNames($activity->id
, $targetID);
102 $defaults['target_contact_value'] = implode('; ', $target_contact_names);
104 elseif (CRM_Core_Permission
::check('access CiviMail') ||
105 (CRM_Mailing_Info
::workflowEnabled() &&
106 CRM_Core_Permission
::check('create mailings')
109 $defaults['mailingId'] = CRM_Utils_System
::url('civicrm/mailing/report',
110 "mid={$activity->source_record_id}&reset=1&atype={$activity->activity_type_id}&aid={$activity->id}&cid={$sourceContactId}&context=activity"
114 $defaults['target_contact_value'] = ts('(recipients)');
117 $sourceContactId = self
::getActivityContact($activity->id
, $sourceID);
118 $defaults['source_contact_id'] = $sourceContactId;
120 if ($sourceContactId &&
121 !CRM_Core_DAO
::getFieldValue('CRM_Contact_DAO_Contact',
126 $defaults['source_contact'] = CRM_Core_DAO
::getFieldValue('CRM_Contact_DAO_Contact',
133 $defaults['case_subject'] = CRM_Case_BAO_Case
::getCaseSubject($activity->id
);
135 CRM_Core_DAO
::storeValues($activity, $defaults);
143 * Delete the activity.
145 * @param array $params
146 * @param bool $moveToTrash
150 public static function deleteActivity(&$params, $moveToTrash = FALSE) {
152 if (!empty($params['id']) && !is_array($params['id'])) {
153 CRM_Utils_Hook
::pre('delete', 'Activity', $params['id'], $params);
156 CRM_Utils_Hook
::pre('delete', 'Activity', NULL, $params);
159 $transaction = new CRM_Core_Transaction();
160 if (is_array(CRM_Utils_Array
::value('source_record_id', $params))) {
161 $sourceRecordIds = implode(',', $params['source_record_id']);
164 $sourceRecordIds = CRM_Utils_Array
::value('source_record_id', $params);
169 if (!isset($params['id'])) {
170 if (is_array($params['activity_type_id'])) {
171 $activityTypes = implode(',', $params['activity_type_id']);
174 $activityTypes = $params['activity_type_id'];
177 $query = "DELETE FROM civicrm_activity WHERE source_record_id IN ({$sourceRecordIds}) AND activity_type_id IN ( {$activityTypes} )";
178 $dao = CRM_Core_DAO
::executeQuery($query);
181 $activity = new CRM_Activity_DAO_Activity();
182 $activity->copyValues($params);
183 $result = $activity->delete();
186 $activity->case_id
= CRM_Case_BAO_Case
::getCaseIdByActivityId($activity->id
);
188 // CRM-13994 delete activity entity_tag
189 $query = "DELETE FROM civicrm_entity_tag WHERE entity_table = 'civicrm_activity' AND entity_id = {$activity->id}";
190 $dao = CRM_Core_DAO
::executeQuery($query);
194 $activity = new CRM_Activity_DAO_Activity();
195 $activity->copyValues($params);
197 $activity->is_deleted
= 1;
198 $result = $activity->save();
200 // CRM-4525 log activity delete
201 $logMsg = 'Case Activity deleted for';
204 $activityContacts = CRM_Core_OptionGroup
::values('activity_contacts', FALSE, FALSE, FALSE, NULL, 'name');
205 $sourceID = CRM_Utils_Array
::key('Activity Source', $activityContacts);
206 $assigneeID = CRM_Utils_Array
::key('Activity Assignees', $activityContacts);
207 $targetID = CRM_Utils_Array
::key('Activity Targets', $activityContacts);
208 $sourceContactId = self
::getActivityContact($activity->id
, $sourceID);
209 if ($sourceContactId) {
210 $msgs[] = " source={$sourceContactId}";
213 // get target contacts.
214 $targetContactIds = CRM_Activity_BAO_ActivityContact
::getNames($activity->id
, $targetID);
215 if (!empty($targetContactIds)) {
216 $msgs[] = " target =" . implode(',', array_keys($targetContactIds));
218 // get assignee contacts.
219 $assigneeContactIds = CRM_Activity_BAO_ActivityContact
::getNames($activity->id
, $assigneeID);
220 if (!empty($assigneeContactIds)) {
221 $msgs[] = " assignee =" . implode(',', array_keys($assigneeContactIds));
224 $logMsg .= implode(', ', $msgs);
226 self
::logActivityAction($activity, $logMsg);
229 // delete the recently created Activity
231 $activityRecent = array(
232 'id' => $activity->id
,
233 'type' => 'Activity',
235 CRM_Utils_Recent
::del($activityRecent);
238 $transaction->commit();
239 if (isset($activity)) {
241 $activity->case_id
= CRM_Case_BAO_Case
::getCaseIdByActivityId($activity->id
);
242 CRM_Utils_Hook
::post('delete', 'Activity', $activity->id
, $activity);
249 * Delete activity assignment record.
251 * @param int $activityId
252 * @param int $recordTypeID
254 public static function deleteActivityContact($activityId, $recordTypeID = NULL) {
255 $activityContact = new CRM_Activity_BAO_ActivityContact();
256 $activityContact->activity_id
= $activityId;
258 $activityContact->record_type_id
= $recordTypeID;
261 // Let's check if activity contact record exits and then delete.
262 // Looks like delete leads to deadlock when multiple simultaneous
263 // requests are done. CRM-15470
264 if ($activityContact->find()) {
265 $activityContact->delete();
270 * Process the activities.
272 * @param array $params
273 * Associated array of the submitted values.
275 * @throws CRM_Core_Exception
277 * @return CRM_Activity_BAO_Activity|null|object
279 public static function create(&$params) {
280 // check required params
281 if (!self
::dataExists($params)) {
282 throw new CRM_Core_Exception('Not enough data to create activity object');
285 $activity = new CRM_Activity_DAO_Activity();
287 if (isset($params['id']) && empty($params['id'])) {
288 unset($params['id']);
291 if (empty($params['status_id']) && empty($params['activity_status_id']) && empty($params['id'])) {
292 if (isset($params['activity_date_time']) &&
293 strcmp($params['activity_date_time'], CRM_Utils_Date
::processDate(date('Ymd')) == -1)
295 $params['status_id'] = 2;
298 $params['status_id'] = 1;
302 // Set priority to Normal for Auto-populated activities (for Cases)
303 if (CRM_Utils_Array
::value('priority_id', $params) === NULL &&
304 // if not set and not 0
305 !CRM_Utils_Array
::value('id', $params)
307 $priority = CRM_Core_PseudoConstant
::get('CRM_Activity_DAO_Activity', 'priority_id');
308 $params['priority_id'] = array_search('Normal', $priority);
311 if (!empty($params['target_contact_id']) && is_array($params['target_contact_id'])) {
312 $params['target_contact_id'] = array_unique($params['target_contact_id']);
314 if (!empty($params['assignee_contact_id']) && is_array($params['assignee_contact_id'])) {
315 $params['assignee_contact_id'] = array_unique($params['assignee_contact_id']);
319 if (!empty($params['id'])) {
320 CRM_Utils_Hook
::pre('edit', 'Activity', $activity->id
, $params);
323 CRM_Utils_Hook
::pre('create', 'Activity', NULL, $params);
326 $activity->copyValues($params);
327 if (isset($params['case_id'])) {
328 // CRM-8708, preserve case ID even though it's not part of the SQL model
329 $activity->case_id
= $params['case_id'];
331 elseif (is_numeric($activity->id
)) {
332 // CRM-8708, preserve case ID even though it's not part of the SQL model
333 $activity->case_id
= CRM_Case_BAO_Case
::getCaseIdByActivityId($activity->id
);
337 $transaction = new CRM_Core_Transaction();
339 $result = $activity->save();
341 if (is_a($result, 'CRM_Core_Error')) {
342 $transaction->rollback();
346 $activityId = $activity->id
;
347 $activityContacts = CRM_Core_OptionGroup
::values('activity_contacts', FALSE, FALSE, FALSE, NULL, 'name');
348 $sourceID = CRM_Utils_Array
::key('Activity Source', $activityContacts);
349 $assigneeID = CRM_Utils_Array
::key('Activity Assignees', $activityContacts);
350 $targetID = CRM_Utils_Array
::key('Activity Targets', $activityContacts);
352 if (isset($params['source_contact_id'])) {
354 'activity_id' => $activityId,
355 'contact_id' => $params['source_contact_id'],
356 'record_type_id' => $sourceID,
358 self
::deleteActivityContact($activityId, $sourceID);
359 CRM_Activity_BAO_ActivityContact
::create($acParams);
362 // check and attach and files as needed
363 CRM_Core_BAO_File
::processAttachment($params, 'civicrm_activity', $activityId);
365 // attempt to save activity assignment
366 $resultAssignment = NULL;
367 if (!empty($params['assignee_contact_id'])) {
369 $assignmentParams = array('activity_id' => $activityId);
371 if (is_array($params['assignee_contact_id'])) {
372 if (CRM_Utils_Array
::value('deleteActivityAssignment', $params, TRUE)) {
373 // first delete existing assignments if any
374 self
::deleteActivityContact($activityId, $assigneeID);
377 foreach ($params['assignee_contact_id'] as $acID) {
379 $assigneeParams = array(
380 'activity_id' => $activityId,
381 'contact_id' => $acID,
382 'record_type_id' => $assigneeID,
384 CRM_Activity_BAO_ActivityContact
::create($assigneeParams);
389 $assignmentParams['contact_id'] = $params['assignee_contact_id'];
390 $assignmentParams['record_type_id'] = $assigneeID;
391 if (!empty($params['id'])) {
392 $assignment = new CRM_Activity_BAO_ActivityContact();
393 $assignment->activity_id
= $activityId;
394 $assignment->record_type_id
= $assigneeID;
395 $assignment->find(TRUE);
397 if ($assignment->contact_id
!= $params['assignee_contact_id']) {
398 $assignmentParams['id'] = $assignment->id
;
399 $resultAssignment = CRM_Activity_BAO_ActivityContact
::create($assignmentParams);
403 $resultAssignment = CRM_Activity_BAO_ActivityContact
::create($assignmentParams);
408 if (CRM_Utils_Array
::value('deleteActivityAssignment', $params, TRUE)) {
409 self
::deleteActivityContact($activityId, $assigneeID);
413 if (is_a($resultAssignment, 'CRM_Core_Error')) {
414 $transaction->rollback();
415 return $resultAssignment;
418 // attempt to save activity targets
419 $resultTarget = NULL;
420 if (!empty($params['target_contact_id'])) {
422 $targetParams = array('activity_id' => $activityId);
423 $resultTarget = array();
424 if (is_array($params['target_contact_id'])) {
425 if (CRM_Utils_Array
::value('deleteActivityTarget', $params, TRUE)) {
426 // first delete existing targets if any
427 self
::deleteActivityContact($activityId, $targetID);
430 foreach ($params['target_contact_id'] as $tid) {
432 $targetContactParams = array(
433 'activity_id' => $activityId,
434 'contact_id' => $tid,
435 'record_type_id' => $targetID,
437 CRM_Activity_BAO_ActivityContact
::create($targetContactParams);
442 $targetParams['contact_id'] = $params['target_contact_id'];
443 $targetParams['record_type_id'] = $targetID;
444 if (!empty($params['id'])) {
445 $target = new CRM_Activity_BAO_ActivityContact();
446 $target->activity_id
= $activityId;
447 $target->record_type_id
= $targetID;
450 if ($target->contact_id
!= $params['target_contact_id']) {
451 $targetParams['id'] = $target->id
;
452 $resultTarget = CRM_Activity_BAO_ActivityContact
::create($targetParams);
456 $resultTarget = CRM_Activity_BAO_ActivityContact
::create($targetParams);
461 if (CRM_Utils_Array
::value('deleteActivityTarget', $params, TRUE)) {
462 self
::deleteActivityContact($activityId, $targetID);
466 // write to changelog before transaction is committed/rolled
467 // back (and prepare status to display)
468 if (!empty($params['id'])) {
469 $logMsg = "Activity (id: {$result->id} ) updated with ";
472 $logMsg = "Activity created for ";
476 if (isset($params['source_contact_id'])) {
477 $msgs[] = "source={$params['source_contact_id']}";
480 if (!empty($params['target_contact_id'])) {
481 if (is_array($params['target_contact_id']) && !CRM_Utils_Array
::crmIsEmptyArray($params['target_contact_id'])) {
482 $msgs[] = "target=" . implode(',', $params['target_contact_id']);
483 // take only first target
484 // will be used for recently viewed display
485 $t = array_slice($params['target_contact_id'], 0, 1);
486 $recentContactId = $t[0];
488 // Is array check fixes warning without degrading functionality but it seems this bit of code may no longer work
489 // as it may always be an array
490 elseif (isset($params['target_contact_id']) && !is_array($params['target_contact_id'])) {
491 $msgs[] = "target={$params['target_contact_id']}";
492 // will be used for recently viewed display
493 $recentContactId = $params['target_contact_id'];
497 // at worst, take source for recently viewed display
498 $recentContactId = CRM_Utils_Array
::value('source_contact_id', $params);
501 if (isset($params['assignee_contact_id'])) {
502 if (is_array($params['assignee_contact_id'])) {
503 $msgs[] = "assignee=" . implode(',', $params['assignee_contact_id']);
506 $msgs[] = "assignee={$params['assignee_contact_id']}";
509 $logMsg .= implode(', ', $msgs);
511 self
::logActivityAction($result, $logMsg);
513 if (!empty($params['custom']) &&
514 is_array($params['custom'])
516 CRM_Core_BAO_CustomValueTable
::store($params['custom'], 'civicrm_activity', $result->id
);
519 $transaction->commit();
520 if (empty($params['skipRecentView'])) {
521 $recentOther = array();
522 if (!empty($params['case_id'])) {
523 $caseContactID = CRM_Core_DAO
::getFieldValue('CRM_Case_DAO_CaseContact', $params['case_id'], 'contact_id', 'case_id');
524 $url = CRM_Utils_System
::url('civicrm/case/activity/view',
525 "reset=1&aid={$activity->id}&cid={$caseContactID}&caseID={$params['case_id']}&context=home"
529 $q = "action=view&reset=1&id={$activity->id}&atype={$activity->activity_type_id}&cid=" . CRM_Utils_Array
::value('source_contact_id', $params) . "&context=home";
530 if ($activity->activity_type_id
!= CRM_Core_PseudoConstant
::getKey('CRM_Activity_BAO_Activity', 'activity_type_id', 'Email')) {
531 $url = CRM_Utils_System
::url('civicrm/activity', $q);
532 if ($activity->activity_type_id
== CRM_Core_PseudoConstant
::getKey('CRM_Activity_BAO_Activity', 'activity_type_id', 'Print PDF Letter')) {
533 $recentOther['editUrl'] = CRM_Utils_System
::url('civicrm/activity/pdf/add',
534 "action=update&reset=1&id={$activity->id}&atype={$activity->activity_type_id}&cid={$params['source_contact_id']}&context=home"
538 $recentOther['editUrl'] = CRM_Utils_System
::url('civicrm/activity/add',
539 "action=update&reset=1&id={$activity->id}&atype={$activity->activity_type_id}&cid=" . CRM_Utils_Array
::value('source_contact_id', $params) . "&context=home"
543 if (CRM_Core_Permission
::check("delete activities")) {
544 $recentOther['deleteUrl'] = CRM_Utils_System
::url('civicrm/activity',
545 "action=delete&reset=1&id={$activity->id}&atype={$activity->activity_type_id}&cid=" . CRM_Utils_Array
::value('source_contact_id', $params) . "&context=home"
550 $url = CRM_Utils_System
::url('civicrm/activity/view', $q);
551 if (CRM_Core_Permission
::check('delete activities')) {
552 $recentOther['deleteUrl'] = CRM_Utils_System
::url('civicrm/activity',
553 "action=delete&reset=1&id={$activity->id}&atype={$activity->activity_type_id}&cid=" . CRM_Utils_Array
::value('source_contact_id', $params) . "&context=home"
559 if (!isset($activity->parent_id
)) {
560 $recentContactDisplay = CRM_Contact_BAO_Contact
::displayName($recentContactId);
561 // add the recently created Activity
562 $activityTypes = CRM_Core_PseudoConstant
::activityType(TRUE, TRUE);
563 $activitySubject = CRM_Core_DAO
::getFieldValue('CRM_Activity_DAO_Activity', $activity->id
, 'subject');
566 if (isset($activitySubject)) {
567 $title = $activitySubject . ' - ';
570 $title = $title . $recentContactDisplay;
571 if (!empty($activityTypes[$activity->activity_type_id
])) {
572 $title .= ' (' . $activityTypes[$activity->activity_type_id
] . ')';
575 CRM_Utils_Recent
::add($title,
580 $recentContactDisplay,
586 CRM_Contact_BAO_GroupContactCache
::opportunisticCacheFlush();
588 if (!empty($params['id'])) {
589 CRM_Utils_Hook
::post('edit', 'Activity', $activity->id
, $activity);
592 CRM_Utils_Hook
::post('create', 'Activity', $activity->id
, $activity);
595 // if the subject contains a ‘[case #…]’ string, file that activity on the related case (CRM-5916)
597 if (preg_match('/\[case #([0-9a-h]{7})\]/', CRM_Utils_Array
::value('subject', $params), $matches)) {
598 $key = CRM_Core_DAO
::escapeString(CIVICRM_SITE_KEY
);
600 $query = "SELECT id FROM civicrm_case WHERE SUBSTR(SHA1(CONCAT('$key', id)), 1, 7) = '$hash'";
602 'activity_id' => $activity->id
,
603 'case_id' => CRM_Core_DAO
::singleValueQuery($query),
605 if ($caseParams['case_id']) {
606 CRM_Case_BAO_Case
::processCaseActivity($caseParams);
609 self
::logActivityAction($activity, "unknown case hash encountered: $hash");
617 * Create an activity.
619 * @todo elaborate on what this does.
621 * @param CRM_Core_DAO_Activity $activity
622 * @param string $logMessage
626 public static function logActivityAction($activity, $logMessage = NULL) {
627 $id = CRM_Core_Session
::getLoggedInContactID();
629 $activityContacts = CRM_Core_OptionGroup
::values('activity_contacts', FALSE, FALSE, FALSE, NULL, 'name');
630 $sourceID = CRM_Utils_Array
::key('Activity Source', $activityContacts);
631 $id = self
::getActivityContact($activity->id
, $sourceID);
634 'entity_table' => 'civicrm_activity',
635 'entity_id' => $activity->id
,
636 'modified_id' => $id,
637 'modified_date' => date('YmdHis'),
638 'data' => $logMessage,
640 CRM_Core_BAO_Log
::add($logParams);
645 * Get the list Activities.
647 * @param array $params
648 * Array of parameters.
650 * - contact_id int contact_id whose activities we want to retrieve
651 * - offset int which row to start from ?
652 * - rowCount int how many rows to fetch
653 * - sort object|array object or array describing sort order for sql query.
654 * - admin boolean if contact is admin
655 * - caseId int case ID
656 * - context string page on which selector is build
657 * - activity_type_id int|string the activitiy types we want to restrict by
658 * @param bool $getCount
659 * Get count of the activities
662 * Relevant data object values of open activities
664 public static function getActivities($params, $getCount = FALSE) {
665 $activities = array();
667 // fetch all active activity types
668 $activityTypes = CRM_Core_OptionGroup
::values('activity_type');
670 // Activity.Get API params
671 $activityParams = array(
673 'is_current_revision' => 1,
675 'contact_id' => CRM_Utils_Array
::value('contact_id', $params),
677 'activity_date_time',
680 'source_contact_name',
681 'assignee_contact_id',
683 'target_contact_name',
684 'assignee_contact_name',
692 'check_permissions' => 1,
694 'offset' => CRM_Utils_Array
::value('offset', $params, 0),
698 if ($params['context'] != 'activity') {
699 $activityParams['status_id'] = CRM_Core_PseudoConstant
::getKey(__CLASS__
, 'status_id', 'Scheduled');
702 // activity type ID clause
703 if (!empty($params['activity_type_id'])) {
704 if (is_array($params['activity_type_id'])) {
705 foreach ($params['activity_type_id'] as $idx => $value) {
706 $params['activity_type_id'][$idx] = CRM_Utils_Type
::escape($value, 'Positive');
708 $activityParams['activity_type_id'] = array('IN' => $params['activity_type_id']);
711 $activityParams['activity_type_id'] = CRM_Utils_Type
::escape($params['activity_type_id'], 'Positive');
714 elseif (!empty($activityTypes) && count($activityTypes)) {
715 $activityParams['activity_type_id'] = array('IN' => array_keys($activityTypes));
718 $excludeActivityIDs = array();
719 if (!empty($params['activity_type_exclude_id'])) {
720 if (is_array($params['activity_type_exclude_id'])) {
721 foreach ($params['activity_type_exclude_id'] as $idx => $value) {
722 $excludeActivityIDs[$idx] = CRM_Utils_Type
::escape($value, 'Positive');
726 $excludeActivityIDs[] = CRM_Utils_Type
::escape($params['activity_type_exclude_id'], 'Positive');
730 if (!empty($params['rowCount']) &&
731 $params['rowCount'] > 0
733 $activityParams['options']['limit'] = $params['rowCount'];
735 // set limit = 0 if we need to fetch the activity count
737 $activityParams['options']['limit'] = 0;
740 if (!empty($params['sort'])) {
741 if (is_a($params['sort'], 'CRM_Utils_Sort')) {
742 $order = $params['sort']->orderBy();
744 elseif (trim($params['sort'])) {
745 $order = CRM_Utils_Type
::escape($params['sort'], 'String');
750 // context = 'activity' in Activities tab.
751 $activityParams['options']['sort'] = (CRM_Utils_Array
::value('context', $params) == 'activity') ?
"activity_date_time DESC" : "status_id ASC, activity_date_time ASC";
754 $activityParams['options']['sort'] = str_replace('activity_type ', 'activity_type_id.label ', $order);
758 // 1. we should use Activity.Getcount for fetching count only, but in order to check that
759 // current logged in user has permission to view Case activities we are performing filtering out those activities from list (see below).
760 // This logic need to be incorporated in Activity.get definition
761 $result = civicrm_api3('Activity', 'Get', $activityParams);
763 $enabledComponents = self
::activityComponents();
764 $allCampaigns = CRM_Campaign_BAO_Campaign
::getCampaigns(NULL, NULL, FALSE, FALSE, FALSE, TRUE);
765 $bulkActivityTypeID = CRM_Core_PseudoConstant
::getKey(__CLASS__
, 'activity_type_id', 'Bulk Email');
767 // CRM-3553, need to check user has access to target groups.
768 $mailingIDs = CRM_Mailing_BAO_Mailing
::mailingACLIDs();
769 $accessCiviMail = ((CRM_Core_Permission
::check('access CiviMail')) ||
770 (CRM_Mailing_Info
::workflowEnabled() && CRM_Core_Permission
::check('create mailings'))
773 $mappingParams = array(
774 'id' => 'activity_id',
775 'source_record_id' => 'source_record_id',
776 'activity_type_id' => 'activity_type_id',
777 'activity_date_time' => 'activity_date_time',
778 'status_id' => 'status_id',
779 'subject' => 'subject',
780 'campaign_id' => 'campaign_id',
781 'assignee_contact_name' => 'assignee_contact_name',
782 'target_contact_name' => 'target_contact_name',
783 'source_contact_id' => 'source_contact_id',
784 'source_contact_name' => 'source_contact_name',
785 'case_id' => 'case_id',
788 foreach ($result['values'] as $id => $activity) {
789 // skip case activities if CiviCase is not enabled OR those actvities which are
790 if ((!empty($activity['case_id']) && !in_array('CiviCase', $enabledComponents)) ||
791 (count($excludeActivityIDs) && in_array($activity['activity_type_id'], $excludeActivityIDs))
796 $activities[$id] = array();
798 // if count is needed, no need to populate the array list with attributes
803 $isBulkActivity = (!$bulkActivityTypeID ||
($bulkActivityTypeID != $activity['activity_type_id']));
804 foreach ($mappingParams as $apiKey => $expectedName) {
805 if (in_array($apiKey, array('assignee_contact_name', 'target_contact_name'))) {
806 $activities[$id][$expectedName] = CRM_Utils_Array
::value($apiKey, $activity, array());
807 if ($apiKey == 'target_contact_name' && count($activity['target_contact_name'])) {
808 $activities[$id]['target_contact_counter'] = count($activity['target_contact_name']);
811 if ($isBulkActivity) {
812 $activities[$id]['recipients'] = ts('(%1 recipients)', array(1 => count($activity['target_contact_name'])));
813 $activities[$id]['mailingId'] = FALSE;
814 if ($accessCiviMail &&
815 ($mailingIDs === TRUE ||
in_array($activity['source_record_id'], $mailingIDs))
817 $activities[$id]['mailingId'] = TRUE;
821 // case related fields
822 elseif ($apiKey == 'case_id' && !$isBulkActivity) {
823 $activities[$id][$expectedName] = CRM_Utils_Array
::value($apiKey, $activity);
825 // fetch case subject for case ID found
826 if (!empty($activity['case_id'])) {
827 $activities[$id]['case_subject'] = CRM_Core_DAO
::executeQuery('CRM_Case_DAO_Case', $activity['case_id'], 'subject');
831 $activities[$id][$expectedName] = CRM_Utils_Array
::value($apiKey, $activity);
832 if ($apiKey == 'activity_type_id') {
833 $activities[$id]['activity_type'] = CRM_Utils_Array
::value($activities[$id][$expectedName], $activityTypes);
835 elseif ($apiKey == 'campaign_id') {
836 $activities[$id]['campaign'] = CRM_Utils_Array
::value($activities[$id][$expectedName], $allCampaigns);
840 // if deleted, wrap in <del>
841 if (!empty($activity['source_contact_id']) &&
842 CRM_Core_DAO
::getFieldValue('CRM_Contact_DAO_Contact', $activity['source_contact_id'], 'is_deleted')
844 $activities[$id]['source_contact_name'] = sprintf("<del>%s<del>", $activity['source_contact_name']);
846 $activities[$id]['is_recurring_activity'] = CRM_Core_BAO_RecurringEntity
::getParentFor($id, 'civicrm_activity');
849 return $getCount ?
count($activities) : $activities;
853 * Get the list Activities.
857 * @todo - use the api for this - this is working but have temporarily backed out
858 * due to performance issue to be resolved - CRM-20481.
860 * @param array $input
861 * Array of parameters.
863 * - contact_id int contact_id whose activities we want to retrieve
864 * - offset int which row to start from ?
865 * - rowCount int how many rows to fetch
866 * - sort object|array object or array describing sort order for sql query.
867 * - admin boolean if contact is admin
868 * - caseId int case ID
869 * - context string page on which selector is build
870 * - activity_type_id int|string the activitiy types we want to restrict by
873 * Relevant data object values of open activities
875 public static function deprecatedGetActivities($input) {
876 // Step 1: Get the basic activity data.
877 $bulkActivityTypeID = CRM_Core_PseudoConstant
::getKey('CRM_Activity_BAO_Activity',
882 $activityContacts = CRM_Core_OptionGroup
::values('activity_contacts', FALSE, FALSE, FALSE, NULL, 'name');
883 $sourceID = CRM_Utils_Array
::key('Activity Source', $activityContacts);
884 $assigneeID = CRM_Utils_Array
::key('Activity Assignees', $activityContacts);
885 $targetID = CRM_Utils_Array
::key('Activity Targets', $activityContacts);
887 $config = CRM_Core_Config
::singleton();
889 $randomNum = md5(uniqid());
890 $activityTempTable = "civicrm_temp_activity_details_{$randomNum}";
892 $tableFields = array(
893 'activity_id' => 'int unsigned',
894 'activity_date_time' => 'datetime',
895 'source_record_id' => 'int unsigned',
896 'status_id' => 'int unsigned',
897 'subject' => 'varchar(255)',
898 'source_contact_name' => 'varchar(255)',
899 'activity_type_id' => 'int unsigned',
900 'activity_type' => 'varchar(128)',
901 'case_id' => 'int unsigned',
902 'case_subject' => 'varchar(255)',
903 'campaign_id' => 'int unsigned',
906 $sql = "CREATE TEMPORARY TABLE {$activityTempTable} ( ";
907 $insertValueSQL = array();
908 // The activityTempTable contains the sorted rows
909 // so in order to maintain the sort order as-is we add an auto_increment
910 // field; we can sort by this later to ensure the sort order stays correct.
911 $sql .= " fixed_sort_order INT UNSIGNED NOT NULL AUTO_INCREMENT PRIMARY KEY,";
912 foreach ($tableFields as $name => $desc) {
913 $sql .= "$name $desc,\n";
914 $insertValueSQL[] = $name;
917 // add unique key on activity_id just to be sure
918 // this cannot be primary key because we need that for the auto_increment
919 // fixed_sort_order field
921 UNIQUE KEY ( activity_id )
922 ) ENGINE=HEAP DEFAULT CHARACTER SET utf8 COLLATE utf8_unicode_ci
925 CRM_Core_DAO
::executeQuery($sql);
927 $insertSQL = "INSERT INTO {$activityTempTable} (" . implode(',', $insertValueSQL) . " ) ";
929 $order = $limit = $groupBy = '';
930 $groupBy = " GROUP BY tbl.activity_id, tbl.activity_type, tbl.case_id, tbl.case_subject ";
932 if (!empty($input['sort'])) {
933 if (is_a($input['sort'], 'CRM_Utils_Sort')) {
934 $orderBy = $input['sort']->orderBy();
935 if (!empty($orderBy)) {
936 $order = " ORDER BY $orderBy";
939 elseif (trim($input['sort'])) {
940 $sort = CRM_Utils_Type
::escape($input['sort'], 'String');
941 $order = " ORDER BY $sort ";
946 // context = 'activity' in Activities tab.
947 $order = (CRM_Utils_Array
::value('context', $input) == 'activity') ?
" ORDER BY tbl.activity_date_time desc " : " ORDER BY tbl.status_id asc, tbl.activity_date_time asc ";
950 if (!empty($input['rowCount']) &&
951 $input['rowCount'] > 0
953 $limit = " LIMIT {$input['offset']}, {$input['rowCount']} ";
956 $input['count'] = FALSE;
957 list($sqlClause, $params) = self
::deprecatedGetActivitySQLClause($input);
959 $query = "{$insertSQL}
960 SELECT DISTINCT tbl.* from ( {$sqlClause} )
963 // Filter case activities - CRM-5761.
964 $components = self
::activityComponents();
965 if (!in_array('CiviCase', $components)) {
967 LEFT JOIN civicrm_case_activity ON ( civicrm_case_activity.activity_id = tbl.activity_id )
968 WHERE civicrm_case_activity.id IS NULL";
971 $query = $query . $groupBy . $order . $limit;
973 $dao = CRM_Core_DAO
::executeQuery($query, $params);
975 // step 2: Get target and assignee contacts for above activities
976 // create temp table for target contacts
977 $activityContactTempTable = "civicrm_temp_activity_contact_{$randomNum}";
978 $query = "CREATE TEMPORARY TABLE {$activityContactTempTable} (
979 activity_id int unsigned, contact_id int unsigned, record_type_id varchar(16),
980 contact_name varchar(255), is_deleted int unsigned, counter int unsigned, INDEX index_activity_id( activity_id ) )
981 ENGINE=InnoDB DEFAULT CHARACTER SET utf8 COLLATE utf8_unicode_ci";
983 CRM_Core_DAO
::executeQuery($query);
985 // note that we ignore bulk email for targets, since we don't show it in selector
987 INSERT INTO {$activityContactTempTable} ( activity_id, contact_id, record_type_id, contact_name, is_deleted )
988 SELECT ac.activity_id,
993 FROM {$activityTempTable}
994 INNER JOIN civicrm_activity a ON ( a.id = {$activityTempTable}.activity_id )
995 INNER JOIN civicrm_activity_contact ac ON ( ac.activity_id = {$activityTempTable}.activity_id )
996 INNER JOIN civicrm_contact c ON c.id = ac.contact_id
997 WHERE ac.record_type_id != %1
999 $params = array(1 => array($targetID, 'Integer'));
1000 CRM_Core_DAO
::executeQuery($query, $params);
1002 $activityFields = array("ac.activity_id", "ac.contact_id", "ac.record_type_id", "c.sort_name", "c.is_deleted");
1003 $select = CRM_Contact_BAO_Query
::appendAnyValueToSelect($activityFields, "ac.activity_id");
1005 // for each activity insert one target contact
1006 // if we load all target contacts the performance will suffer a lot for mass-activities.
1008 INSERT INTO {$activityContactTempTable} ( activity_id, contact_id, record_type_id, contact_name, is_deleted, counter )
1009 {$select}, count(ac.contact_id)
1010 FROM {$activityTempTable}
1011 INNER JOIN civicrm_activity a ON ( a.id = {$activityTempTable}.activity_id )
1012 INNER JOIN civicrm_activity_contact ac ON ( ac.activity_id = {$activityTempTable}.activity_id )
1013 INNER JOIN civicrm_contact c ON c.id = ac.contact_id
1014 WHERE ac.record_type_id = %1
1015 GROUP BY ac.activity_id
1018 CRM_Core_DAO
::executeQuery($query, $params);
1020 // step 3: Combine all temp tables to get final query for activity selector
1021 // sort by the original sort order, stored in fixed_sort_order
1023 SELECT {$activityTempTable}.*,
1024 {$activityContactTempTable}.contact_id,
1025 {$activityContactTempTable}.record_type_id,
1026 {$activityContactTempTable}.contact_name,
1027 {$activityContactTempTable}.is_deleted,
1028 {$activityContactTempTable}.counter,
1029 re.parent_id as is_recurring_activity
1030 FROM {$activityTempTable}
1031 INNER JOIN {$activityContactTempTable} on {$activityTempTable}.activity_id = {$activityContactTempTable}.activity_id
1032 LEFT JOIN civicrm_recurring_entity re on {$activityContactTempTable}.activity_id = re.entity_id
1033 ORDER BY fixed_sort_order
1036 $dao = CRM_Core_DAO
::executeQuery($query);
1038 // CRM-3553, need to check user has access to target groups.
1039 $mailingIDs = CRM_Mailing_BAO_Mailing
::mailingACLIDs();
1041 (CRM_Core_Permission
::check('access CiviMail')) ||
1042 (CRM_Mailing_Info
::workflowEnabled() &&
1043 CRM_Core_Permission
::check('create mailings'))
1046 // Get all campaigns.
1047 $allCampaigns = CRM_Campaign_BAO_Campaign
::getCampaigns(NULL, NULL, FALSE, FALSE, FALSE, TRUE);
1049 while ($dao->fetch()) {
1050 $activityID = $dao->activity_id
;
1051 $values[$activityID]['activity_id'] = $dao->activity_id
;
1052 $values[$activityID]['source_record_id'] = $dao->source_record_id
;
1053 $values[$activityID]['activity_type_id'] = $dao->activity_type_id
;
1054 $values[$activityID]['activity_type'] = $dao->activity_type
;
1055 $values[$activityID]['activity_date_time'] = $dao->activity_date_time
;
1056 $values[$activityID]['status_id'] = $dao->status_id
;
1057 $values[$activityID]['subject'] = $dao->subject
;
1058 $values[$activityID]['campaign_id'] = $dao->campaign_id
;
1059 $values[$activityID]['is_recurring_activity'] = $dao->is_recurring_activity
;
1061 if ($dao->campaign_id
) {
1062 $values[$activityID]['campaign'] = $allCampaigns[$dao->campaign_id
];
1065 if (empty($values[$activityID]['assignee_contact_name'])) {
1066 $values[$activityID]['assignee_contact_name'] = array();
1069 if (empty($values[$activityID]['target_contact_name'])) {
1070 $values[$activityID]['target_contact_name'] = array();
1071 $values[$activityID]['target_contact_counter'] = $dao->counter
;
1074 // if deleted, wrap in <del>
1075 if ($dao->is_deleted
) {
1076 $dao->contact_name
= "<del>{$dao->contact_name}</del>";
1079 if ($dao->record_type_id
== $sourceID && $dao->contact_id
) {
1080 $values[$activityID]['source_contact_id'] = $dao->contact_id
;
1081 $values[$activityID]['source_contact_name'] = $dao->contact_name
;
1084 if (!$bulkActivityTypeID ||
($bulkActivityTypeID != $dao->activity_type_id
)) {
1085 // build array of target / assignee names
1086 if ($dao->record_type_id
== $targetID && $dao->contact_id
) {
1087 $values[$activityID]['target_contact_name'][$dao->contact_id
] = $dao->contact_name
;
1089 if ($dao->record_type_id
== $assigneeID && $dao->contact_id
) {
1090 $values[$activityID]['assignee_contact_name'][$dao->contact_id
] = $dao->contact_name
;
1093 // case related fields
1094 $values[$activityID]['case_id'] = $dao->case_id
;
1095 $values[$activityID]['case_subject'] = $dao->case_subject
;
1098 $values[$activityID]['recipients'] = ts('(%1 recipients)', array(1 => $dao->counter
));
1099 $values[$activityID]['mailingId'] = FALSE;
1102 ($mailingIDs === TRUE ||
in_array($dao->source_record_id
, $mailingIDs))
1104 $values[$activityID]['mailingId'] = TRUE;
1113 * Get the component id and name if those are enabled and allowed.
1115 * Checks whether logged in user has permission.
1116 * To decide whether we are going to include
1117 * component related activities with core activity retrieve process.
1118 * (what did that just mean?)
1121 * Array of component id and name.
1123 public static function activityComponents() {
1124 $components = array();
1125 $compInfo = CRM_Core_Component
::getEnabledComponents();
1126 foreach ($compInfo as $compObj) {
1127 if (!empty($compObj->info
['showActivitiesInCore'])) {
1128 if ($compObj->info
['name'] == 'CiviCampaign') {
1129 $componentPermission = "administer {$compObj->name}";
1132 $componentPermission = "access {$compObj->name}";
1134 if ($compObj->info
['name'] == 'CiviCase') {
1135 if (CRM_Case_BAO_Case
::accessCiviCase()) {
1136 $components[$compObj->componentID
] = $compObj->info
['name'];
1139 elseif (CRM_Core_Permission
::check($componentPermission)) {
1140 $components[$compObj->componentID
] = $compObj->info
['name'];
1149 * Get the activity Count.
1151 * @param array $input
1152 * Array of parameters.
1154 * - contact_id int contact_id whose activities we want to retrieve
1155 * - admin boolean if contact is admin
1156 * - caseId int case ID
1157 * - context string page on which selector is build
1158 * - activity_type_id int|string the activity types we want to restrict by
1161 * count of activities
1163 public static function getActivitiesCount($input) {
1164 return self
::getActivities($input, TRUE);
1168 * Get the activity Count.
1170 * @param array $input
1171 * Array of parameters.
1173 * - contact_id int contact_id whose activities we want to retrieve
1174 * - admin boolean if contact is admin
1175 * - caseId int case ID
1176 * - context string page on which selector is build
1177 * - activity_type_id int|string the activity types we want to restrict by
1180 * count of activities
1182 public static function deprecatedGetActivitiesCount($input) {
1183 $input['count'] = TRUE;
1184 list($sqlClause, $params) = self
::deprecatedGetActivitySQLClause($input);
1186 //filter case activities - CRM-5761
1187 $components = self
::activityComponents();
1188 if (!in_array('CiviCase', $components)) {
1190 SELECT COUNT(DISTINCT(tbl.activity_id)) as count
1191 FROM ( {$sqlClause} ) as tbl
1192 LEFT JOIN civicrm_case_activity ON ( civicrm_case_activity.activity_id = tbl.activity_id )
1193 WHERE civicrm_case_activity.id IS NULL";
1196 $query = "SELECT COUNT(DISTINCT(activity_id)) as count from ( {$sqlClause} ) as tbl";
1199 return CRM_Core_DAO
::singleValueQuery($query, $params);
1203 * Get the activity sql clause to pick activities.
1205 * @param array $input
1206 * Array of parameters.
1208 * - contact_id int contact_id whose activities we want to retrieve
1209 * - admin boolean if contact is admin
1210 * - caseId int case ID
1211 * - context string page on which selector is build
1212 * - count boolean are we interested in the count clause only?
1213 * - activity_type_id int|string the activity types we want to restrict by
1216 * count of activities
1218 public static function deprecatedGetActivitySQLClause($input) {
1220 $sourceWhere = $targetWhere = $assigneeWhere = $caseWhere = 1;
1222 $config = CRM_Core_Config
::singleton();
1223 if (!CRM_Utils_Array
::value('admin', $input, FALSE)) {
1224 $sourceWhere = ' ac.contact_id = %1 ';
1225 $caseWhere = ' civicrm_case_contact.contact_id = %1 ';
1227 $params = array(1 => array($input['contact_id'], 'Integer'));
1230 $commonClauses = array(
1231 "civicrm_option_group.name = 'activity_type'",
1232 "civicrm_activity.is_deleted = 0",
1233 "civicrm_activity.is_current_revision = 1",
1234 "civicrm_activity.is_test= 0",
1237 if (isset($input['activity_date_relative']) ||
1238 (!empty($input['activity_date_low']) ||
!empty($input['activity_date_high']))
1240 list($from, $to) = CRM_Utils_Date
::getFromTo(
1241 CRM_Utils_Array
::value('activity_date_relative', $input, 0),
1242 CRM_Utils_Array
::value('activity_date_low', $input),
1243 CRM_Utils_Array
::value('activity_date_high', $input)
1245 $commonClauses[] = sprintf('civicrm_activity.activity_date_time BETWEEN "%s" AND "%s" ', $from, $to);
1248 if (!empty($input['activity_status_id'])) {
1249 $commonClauses[] = sprintf("civicrm_activity.status_id IN (%s)", $input['activity_status_id']);
1251 elseif ($input['context'] != 'activity') {
1252 $commonClauses[] = "civicrm_activity.status_id = 1";
1255 // Filter on component IDs.
1256 $components = self
::activityComponents();
1257 if (!empty($components)) {
1258 $componentsIn = implode(',', array_keys($components));
1259 $commonClauses[] = "( civicrm_option_value.component_id IS NULL OR civicrm_option_value.component_id IN ( $componentsIn ) )";
1262 $commonClauses[] = "civicrm_option_value.component_id IS NULL";
1265 // activity type ID clause
1266 if (!empty($input['activity_type_id'])) {
1267 if (is_array($input['activity_type_id'])) {
1268 foreach ($input['activity_type_id'] as $idx => $value) {
1269 $input['activity_type_id'][$idx] = CRM_Utils_Type
::escape($value, 'Positive');
1271 $commonClauses[] = "civicrm_activity.activity_type_id IN ( " . implode(",", $input['activity_type_id']) . " ) ";
1274 $activityTypeID = CRM_Utils_Type
::escape($input['activity_type_id'], 'Positive');
1275 $commonClauses[] = "civicrm_activity.activity_type_id = $activityTypeID";
1279 // exclude by activity type clause
1280 if (!empty($input['activity_type_exclude_id'])) {
1281 if (is_array($input['activity_type_exclude_id'])) {
1282 foreach ($input['activity_type_exclude_id'] as $idx => $value) {
1283 $input['activity_type_exclude_id'][$idx] = CRM_Utils_Type
::escape($value, 'Positive');
1285 $commonClauses[] = "civicrm_activity.activity_type_id NOT IN ( " . implode(",", $input['activity_type_exclude_id']) . " ) ";
1288 $activityTypeID = CRM_Utils_Type
::escape($input['activity_type_exclude_id'], 'Positive');
1289 $commonClauses[] = "civicrm_activity.activity_type_id != $activityTypeID";
1293 $commonClause = implode(' AND ', $commonClauses);
1295 $includeCaseActivities = FALSE;
1296 if (in_array('CiviCase', $components)) {
1297 $includeCaseActivities = TRUE;
1300 // build main activity table select clause
1303 $activityContacts = CRM_Core_OptionGroup
::values('activity_contacts', FALSE, FALSE, FALSE, NULL, 'name');
1304 $sourceID = CRM_Utils_Array
::key('Activity Source', $activityContacts);
1306 INNER JOIN civicrm_activity_contact ac ON ac.activity_id = civicrm_activity.id
1307 INNER JOIN civicrm_contact contact ON ac.contact_id = contact.id
1310 if (!$input['count']) {
1312 civicrm_activity.activity_date_time,
1313 civicrm_activity.source_record_id,
1314 civicrm_activity.status_id,
1315 civicrm_activity.subject,
1316 contact.sort_name as source_contact_name,
1317 civicrm_option_value.value as activity_type_id,
1318 civicrm_option_value.label as activity_type,
1319 null as case_id, null as case_subject,
1320 civicrm_activity.campaign_id as campaign_id
1324 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)
1329 SELECT civicrm_activity.id as activity_id
1331 from civicrm_activity
1332 left join civicrm_option_value on
1333 civicrm_activity.activity_type_id = civicrm_option_value.value
1334 left join civicrm_option_group on
1335 civicrm_option_group.id = civicrm_option_value.option_group_id
1342 // Build case clause
1343 // or else exclude Inbound Emails that have been filed on a case.
1346 if ($includeCaseActivities) {
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';
1364 SELECT civicrm_activity.id as activity_id
1366 from civicrm_activity
1367 inner join civicrm_case_activity on
1368 civicrm_case_activity.activity_id = civicrm_activity.id
1369 inner join civicrm_case on
1370 civicrm_case_activity.case_id = civicrm_case.id
1371 inner join civicrm_case_contact on
1372 civicrm_case_contact.case_id = civicrm_case.id and {$caseWhere}
1373 left join civicrm_option_value on
1374 civicrm_activity.activity_type_id = civicrm_option_value.value
1375 left join civicrm_option_group on
1376 civicrm_option_group.id = civicrm_option_value.option_group_id
1381 and ( ( civicrm_case_activity.case_id IS NULL ) OR
1382 ( civicrm_option_value.name <> 'Inbound Email' AND
1383 civicrm_option_value.name <> 'Email' AND civicrm_case_activity.case_id
1389 $returnClause = " {$sourceClause} {$caseClause} ";
1391 return array($returnClause, $params);
1395 * Send the message to all the contacts.
1397 * Also insert a contact activity in each contacts record.
1399 * @param array $contactDetails
1400 * The array of contact details to send the email.
1401 * @param string $subject
1402 * The subject of the message.
1405 * @param string $emailAddress
1406 * Use this 'to' email address instead of the default Primary address.
1407 * @param int $userID
1408 * Use this userID if set.
1409 * @param string $from
1410 * @param array $attachments
1411 * The array of attachments if any.
1414 * @param string $bcc
1416 * @param array $contactIds
1418 * @param string $additionalDetails
1419 * The additional information of CC and BCC appended to the activity Details.
1420 * @param array $contributionIds
1421 * @param int $campaignId
1424 * ( sent, activityId) if any email is sent and activityId
1426 public static function sendEmail(
1434 $attachments = NULL,
1438 $additionalDetails = NULL,
1439 $contributionIds = NULL,
1442 // get the contact details of logged in contact, which we set as from email
1443 if ($userID == NULL) {
1444 $userID = CRM_Core_Session
::getLoggedInContactID();
1447 list($fromDisplayName, $fromEmail, $fromDoNotEmail) = CRM_Contact_BAO_Contact
::getContactDetails($userID);
1449 return array(count($contactDetails), 0, count($contactDetails));
1451 if (!trim($fromDisplayName)) {
1452 $fromDisplayName = $fromEmail;
1456 // token replacement of addressee/email/postal greetings
1457 // get the tokens added in subject and message
1458 $subjectToken = CRM_Utils_Token
::getTokens($subject);
1459 $messageToken = CRM_Utils_Token
::getTokens($text);
1460 $messageToken = array_merge($messageToken, CRM_Utils_Token
::getTokens($html));
1461 $allTokens = array_merge($messageToken, $subjectToken);
1464 $from = "$fromDisplayName <$fromEmail>";
1467 //create the meta level record first ( email activity )
1468 $activityTypeID = CRM_Core_PseudoConstant
::getKey('CRM_Activity_BAO_Activity', 'activity_type_id',
1472 // CRM-6265: save both text and HTML parts in details (if present)
1473 if ($html and $text) {
1474 $details = "-ALTERNATIVE ITEM 0-\n$html$additionalDetails\n-ALTERNATIVE ITEM 1-\n$text$additionalDetails\n-ALTERNATIVE END-\n";
1477 $details = $html ?
$html : $text;
1478 $details .= $additionalDetails;
1481 $activityParams = array(
1482 'source_contact_id' => $userID,
1483 'activity_type_id' => $activityTypeID,
1484 'activity_date_time' => date('YmdHis'),
1485 'subject' => $subject,
1486 'details' => $details,
1487 // FIXME: check for name Completed and get ID from that lookup
1489 'campaign_id' => $campaignId,
1492 // CRM-5916: strip [case #…] before saving the activity (if present in subject)
1493 $activityParams['subject'] = preg_replace('/\[case #([0-9a-h]{7})\] /', '', $activityParams['subject']);
1495 // add the attachments to activity params here
1497 // first process them
1498 $activityParams = array_merge($activityParams,
1503 $activity = self
::create($activityParams);
1505 // get the set of attachments from where they are stored
1506 $attachments = CRM_Core_BAO_File
::getEntityFile('civicrm_activity',
1509 $returnProperties = array();
1510 if (isset($messageToken['contact'])) {
1511 foreach ($messageToken['contact'] as $key => $value) {
1512 $returnProperties[$value] = 1;
1516 if (isset($subjectToken['contact'])) {
1517 foreach ($subjectToken['contact'] as $key => $value) {
1518 if (!isset($returnProperties[$value])) {
1519 $returnProperties[$value] = 1;
1524 // get token details for contacts, call only if tokens are used
1526 if (!empty($returnProperties) ||
!empty($tokens) ||
!empty($allTokens)) {
1527 list($details) = CRM_Utils_Token
::getTokenDetails(
1532 'CRM_Activity_BAO_Activity'
1538 CRM_Utils_Hook
::tokens($tokens);
1539 $categories = array_keys($tokens);
1541 $escapeSmarty = FALSE;
1542 if (defined('CIVICRM_MAIL_SMARTY') && CIVICRM_MAIL_SMARTY
) {
1543 $smarty = CRM_Core_Smarty
::singleton();
1544 $escapeSmarty = TRUE;
1547 $contributionDetails = array();
1548 if (!empty($contributionIds)) {
1549 $contributionDetails = CRM_Contribute_BAO_Contribution
::replaceContributionTokens(
1560 $sent = $notSent = array();
1561 foreach ($contactDetails as $values) {
1562 $contactId = $values['contact_id'];
1563 $emailAddress = $values['email'];
1565 if (!empty($contributionDetails)) {
1566 $subject = $contributionDetails[$contactId]['subject'];
1567 $text = $contributionDetails[$contactId]['text'];
1568 $html = $contributionDetails[$contactId]['html'];
1571 if (!empty($details) && is_array($details["{$contactId}"])) {
1572 // unset email from details since it always returns primary email address
1573 unset($details["{$contactId}"]['email']);
1574 unset($details["{$contactId}"]['email_id']);
1575 $values = array_merge($values, $details["{$contactId}"]);
1578 $tokenSubject = CRM_Utils_Token
::replaceContactTokens($subject, $values, FALSE, $subjectToken, FALSE, $escapeSmarty);
1579 $tokenSubject = CRM_Utils_Token
::replaceHookTokens($tokenSubject, $values, $categories, FALSE, $escapeSmarty);
1582 if ($values['preferred_mail_format'] == 'Text' ||
$values['preferred_mail_format'] == 'Both') {
1583 $tokenText = CRM_Utils_Token
::replaceContactTokens($text, $values, FALSE, $messageToken, FALSE, $escapeSmarty);
1584 $tokenText = CRM_Utils_Token
::replaceHookTokens($tokenText, $values, $categories, FALSE, $escapeSmarty);
1590 if ($values['preferred_mail_format'] == 'HTML' ||
$values['preferred_mail_format'] == 'Both') {
1591 $tokenHtml = CRM_Utils_Token
::replaceContactTokens($html, $values, TRUE, $messageToken, FALSE, $escapeSmarty);
1592 $tokenHtml = CRM_Utils_Token
::replaceHookTokens($tokenHtml, $values, $categories, TRUE, $escapeSmarty);
1598 if (defined('CIVICRM_MAIL_SMARTY') && CIVICRM_MAIL_SMARTY
) {
1599 // also add the contact tokens to the template
1600 $smarty->assign_by_ref('contact', $values);
1602 $tokenSubject = $smarty->fetch("string:$tokenSubject");
1603 $tokenText = $smarty->fetch("string:$tokenText");
1604 $tokenHtml = $smarty->fetch("string:$tokenHtml");
1608 if (self
::sendMessage(
1626 return array($sent, $activity->id
);
1632 * @param array $contactDetails
1633 * @param array $activityParams
1634 * @param array $smsParams
1635 * @param $contactIds
1636 * @param int $userID
1639 * @throws CRM_Core_Exception
1641 public static function sendSMS(
1644 &$smsParams = array(),
1648 if ($userID == NULL) {
1649 $userID = CRM_Core_Session
::getLoggedInContactID();
1652 $text = &$activityParams['sms_text_message'];
1655 // token replacement of addressee/email/postal greetings
1656 // get the tokens added in subject and message
1657 $messageToken = CRM_Utils_Token
::getTokens($text);
1659 // Create the meta level record first ( sms activity )
1660 $activityTypeID = CRM_Core_PseudoConstant
::getKey('CRM_Activity_BAO_Activity',
1667 $activitySubject = $activityParams['activity_subject'];
1668 $activityParams = array(
1669 'source_contact_id' => $userID,
1670 'activity_type_id' => $activityTypeID,
1671 'activity_date_time' => date('YmdHis'),
1672 'subject' => $activitySubject,
1673 'details' => $details,
1674 // FIXME: check for name Completed and get ID from that lookup
1678 $activity = self
::create($activityParams);
1679 $activityID = $activity->id
;
1681 $returnProperties = array();
1683 if (isset($messageToken['contact'])) {
1684 foreach ($messageToken['contact'] as $key => $value) {
1685 $returnProperties[$value] = 1;
1691 CRM_Utils_Hook
::tokens($tokens);
1692 $categories = array_keys($tokens);
1694 // get token details for contacts, call only if tokens are used
1696 if (!empty($returnProperties) ||
!empty($tokens)) {
1697 list($details) = CRM_Utils_Token
::getTokenDetails($contactIds,
1701 'CRM_Activity_BAO_Activity'
1706 $escapeSmarty = FALSE;
1708 foreach ($contactDetails as $values) {
1709 $contactId = $values['contact_id'];
1711 if (!empty($details) && is_array($details["{$contactId}"])) {
1712 // unset phone from details since it always returns primary number
1713 unset($details["{$contactId}"]['phone']);
1714 unset($details["{$contactId}"]['phone_type_id']);
1715 $values = array_merge($values, $details["{$contactId}"]);
1718 $tokenText = CRM_Utils_Token
::replaceContactTokens($text, $values, FALSE, $messageToken, FALSE, $escapeSmarty);
1719 $tokenText = CRM_Utils_Token
::replaceHookTokens($tokenText, $values, $categories, FALSE, $escapeSmarty);
1721 // Only send if the phone is of type mobile
1722 $phoneTypes = CRM_Core_OptionGroup
::values('phone_type', TRUE, FALSE, FALSE, NULL, 'name');
1723 if ($values['phone_type_id'] == CRM_Utils_Array
::value('Mobile', $phoneTypes)) {
1724 $smsParams['To'] = $values['phone'];
1727 $smsParams['To'] = '';
1730 $sendResult = self
::sendSMSMessage(
1738 if (PEAR
::isError($sendResult)) {
1739 // Collect all of the PEAR_Error objects
1740 $errMsgs[] = $sendResult;
1747 // If at least one message was sent and no errors
1748 // were generated then return a boolean value of TRUE.
1749 // Otherwise, return FALSE (no messages sent) or
1750 // and array of 1 or more PEAR_Error objects.
1752 if ($success > 0 && count($errMsgs) == 0) {
1755 elseif (count($errMsgs) > 0) {
1759 return array($sent, $activity->id
, $success);
1763 * Send the sms message to a specific contact.
1766 * The contact id of the recipient.
1768 * @param array $smsParams
1769 * The params used for sending sms.
1770 * @param int $activityID
1771 * The activity ID that tracks the message.
1772 * @param int $userID
1774 * @return bool|PEAR_Error
1775 * true on success or PEAR_Error object
1777 public static function sendSMSMessage(
1780 $smsParams = array(),
1785 $toPhoneNumber = "";
1787 if ($smsParams['To']) {
1788 $toPhoneNumber = trim($smsParams['To']);
1791 $filters = array('is_deceased' => 0, 'is_deleted' => 0, 'do_not_sms' => 0);
1792 $toPhoneNumbers = CRM_Core_BAO_Phone
::allPhones($toID, FALSE, 'Mobile', $filters);
1793 // To get primary mobile phonenumber,if not get the first mobile phonenumber
1794 if (!empty($toPhoneNumbers)) {
1795 $toPhoneNumerDetails = reset($toPhoneNumbers);
1796 $toPhoneNumber = CRM_Utils_Array
::value('phone', $toPhoneNumerDetails);
1797 // Contact allows to send sms
1802 // make sure both phone are valid
1803 // and that the recipient wants to receive sms
1804 if (empty($toPhoneNumber) or $toDoNotSms) {
1805 return PEAR
::raiseError(
1806 'Recipient phone number is invalid or recipient does not want to receive SMS',
1812 $recipient = $smsParams['To'];
1813 $smsParams['contact_id'] = $toID;
1814 $smsParams['parent_activity_id'] = $activityID;
1816 $providerObj = CRM_SMS_Provider
::singleton(array('provider_id' => $smsParams['provider_id']));
1817 $sendResult = $providerObj->send($recipient, $smsParams, $tokenText, NULL, $userID);
1818 if (PEAR
::isError($sendResult)) {
1822 $activityContacts = CRM_Core_OptionGroup
::values('activity_contacts', FALSE, FALSE, FALSE, NULL, 'name');
1823 $targetID = CRM_Utils_Array
::key('Activity Targets', $activityContacts);
1825 // add activity target record for every sms that is send
1826 $activityTargetParams = array(
1827 'activity_id' => $activityID,
1828 'contact_id' => $toID,
1829 'record_type_id' => $targetID,
1831 CRM_Activity_BAO_ActivityContact
::create($activityTargetParams);
1837 * Send the message to a specific contact.
1839 * @param string $from
1840 * The name and email of the sender.
1841 * @param int $fromID
1843 * The contact id of the recipient.
1844 * @param string $subject
1845 * The subject of the message.
1846 * @param $text_message
1847 * @param $html_message
1848 * @param string $emailAddress
1849 * Use this 'to' email address instead of the default Primary address.
1850 * @param int $activityID
1851 * The activity ID that tracks the message.
1852 * @param null $attachments
1857 * TRUE if successful else FALSE.
1859 public static function sendMessage(
1868 $attachments = NULL,
1872 list($toDisplayName, $toEmail, $toDoNotEmail) = CRM_Contact_BAO_Contact
::getContactDetails($toID);
1873 if ($emailAddress) {
1874 $toEmail = trim($emailAddress);
1877 // make sure both email addresses are valid
1878 // and that the recipient wants to receive email
1879 if (empty($toEmail) or $toDoNotEmail) {
1882 if (!trim($toDisplayName)) {
1883 $toDisplayName = $toEmail;
1886 $activityContacts = CRM_Core_OptionGroup
::values('activity_contacts', FALSE, FALSE, FALSE, NULL, 'name');
1887 $targetID = CRM_Utils_Array
::key('Activity Targets', $activityContacts);
1889 // create the params array
1890 $mailParams = array(
1891 'groupName' => 'Activity Email Sender',
1893 'toName' => $toDisplayName,
1894 'toEmail' => $toEmail,
1895 'subject' => $subject,
1898 'text' => $text_message,
1899 'html' => $html_message,
1900 'attachments' => $attachments,
1903 if (!CRM_Utils_Mail
::send($mailParams)) {
1907 // add activity target record for every mail that is send
1908 $activityTargetParams = array(
1909 'activity_id' => $activityID,
1910 'contact_id' => $toID,
1911 'record_type_id' => $targetID,
1913 CRM_Activity_BAO_ActivityContact
::create($activityTargetParams);
1918 * Combine all the importable fields from the lower levels object.
1920 * The ordering is important, since currently we do not have a weight
1921 * scheme. Adding weight is super important and should be done in the
1922 * next week or so, before this can be called complete.
1924 * @param bool $status
1927 * array of importable Fields
1929 public static function &importableFields($status = FALSE) {
1930 if (!self
::$_importableFields) {
1931 if (!self
::$_importableFields) {
1932 self
::$_importableFields = array();
1935 $fields = array('' => array('title' => ts('- do not import -')));
1938 $fields = array('' => array('title' => ts('- Activity Fields -')));
1941 $tmpFields = CRM_Activity_DAO_Activity
::import();
1942 $contactFields = CRM_Contact_BAO_Contact
::importableFields('Individual', NULL);
1944 // Using new Dedupe rule.
1945 $ruleParams = array(
1946 'contact_type' => 'Individual',
1947 'used' => 'Unsupervised',
1949 $fieldsArray = CRM_Dedupe_BAO_Rule
::dedupeRuleFields($ruleParams);
1951 $tmpConatctField = array();
1952 if (is_array($fieldsArray)) {
1953 foreach ($fieldsArray as $value) {
1954 $customFieldId = CRM_Core_DAO
::getFieldValue('CRM_Core_DAO_CustomField',
1959 $value = $customFieldId ?
'custom_' . $customFieldId : $value;
1960 $tmpConatctField[trim($value)] = $contactFields[trim($value)];
1961 $tmpConatctField[trim($value)]['title'] = $tmpConatctField[trim($value)]['title'] . " (match to contact)";
1964 $tmpConatctField['external_identifier'] = $contactFields['external_identifier'];
1965 $tmpConatctField['external_identifier']['title'] = $contactFields['external_identifier']['title'] . " (match to contact)";
1966 $fields = array_merge($fields, $tmpConatctField);
1967 $fields = array_merge($fields, $tmpFields);
1968 $fields = array_merge($fields, CRM_Core_BAO_CustomField
::getFieldsForImport('Activity'));
1969 self
::$_importableFields = $fields;
1971 return self
::$_importableFields;
1975 * @deprecated - use the api instead.
1977 * Get the Activities of a target contact.
1979 * @param int $contactId
1980 * Id of the contact whose activities need to find.
1983 * array of activity fields
1985 public static function getContactActivity($contactId) {
1986 // @todo remove this function entirely.
1987 $activities = array();
1988 $activityContacts = CRM_Core_OptionGroup
::values('activity_contacts', FALSE, FALSE, FALSE, NULL, 'name');
1989 $sourceID = CRM_Utils_Array
::key('Activity Source', $activityContacts);
1990 $assigneeID = CRM_Utils_Array
::key('Activity Assignees', $activityContacts);
1991 $targetID = CRM_Utils_Array
::key('Activity Targets', $activityContacts);
1993 // First look for activities where contactId is one of the targets
1995 SELECT activity_id, record_type_id
1996 FROM civicrm_activity_contact
1997 WHERE contact_id = $contactId
1999 $dao = CRM_Core_DAO
::executeQuery($query);
2000 while ($dao->fetch()) {
2001 if ($dao->record_type_id
== $targetID) {
2002 $activities[$dao->activity_id
]['targets'][$contactId] = $contactId;
2004 elseif ($dao->record_type_id
== $assigneeID) {
2005 $activities[$dao->activity_id
]['asignees'][$contactId] = $contactId;
2008 // do source stuff here
2009 $activities[$dao->activity_id
]['source_contact_id'] = $contactId;
2013 $activityIds = array_keys($activities);
2014 if (count($activityIds) < 1) {
2018 $activityIds = implode(',', $activityIds);
2020 SELECT activity.id as activity_id,
2022 subject, location, activity_date_time, details, status_id
2023 FROM civicrm_activity activity
2024 WHERE activity.id IN ($activityIds)";
2026 $dao = CRM_Core_DAO
::executeQuery($query);
2028 $activityTypes = CRM_Core_OptionGroup
::values('activity_type');
2029 $activityStatuses = CRM_Core_OptionGroup
::values('activity_status');
2031 while ($dao->fetch()) {
2032 $activities[$dao->activity_id
]['id'] = $dao->activity_id
;
2033 $activities[$dao->activity_id
]['activity_type_id'] = $dao->activity_type_id
;
2034 $activities[$dao->activity_id
]['subject'] = $dao->subject
;
2035 $activities[$dao->activity_id
]['location'] = $dao->location
;
2036 $activities[$dao->activity_id
]['activity_date_time'] = $dao->activity_date_time
;
2037 $activities[$dao->activity_id
]['details'] = $dao->details
;
2038 $activities[$dao->activity_id
]['status_id'] = $dao->status_id
;
2039 $activities[$dao->activity_id
]['activity_name'] = $activityTypes[$dao->activity_type_id
];
2040 $activities[$dao->activity_id
]['status'] = $activityStatuses[$dao->status_id
];
2042 // set to null if not set
2043 if (!isset($activities[$dao->activity_id
]['source_contact_id'])) {
2044 $activities[$dao->activity_id
]['source_contact_id'] = NULL;
2051 * Add activity for Membership/Event/Contribution.
2053 * @param object $activity
2054 * (reference) particular component object.
2055 * @param string $activityType
2056 * For Membership Signup or Renewal.
2057 * @param int $targetContactID
2058 * @param array $params
2059 * Activity params to override.
2063 public static function addActivity(
2065 $activityType = 'Membership Signup',
2066 $targetContactID = NULL,
2069 $date = date('YmdHis');
2070 if ($activity->__table
== 'civicrm_membership') {
2071 $component = 'Membership';
2073 elseif ($activity->__table
== 'civicrm_participant') {
2074 if ($activityType != 'Email') {
2075 $activityType = 'Event Registration';
2077 $component = 'Event';
2079 elseif ($activity->__table
== 'civicrm_contribution') {
2080 // create activity record only for Completed Contributions
2081 if ($activity->contribution_status_id
!= 1) {
2084 $activityType = $component = 'Contribution';
2086 // retrieve existing activity based on source_record_id and activity_type
2087 if (empty($params['id'])) {
2088 $params['id'] = CRM_Utils_Array
::value('id', civicrm_api3('Activity', 'Get', array(
2089 'source_record_id' => $activity->id
,
2090 'activity_type_id' => $activityType,
2093 if (!empty($params['id'])) {
2094 // CRM-13237 : if activity record found, update it with campaign id of contribution
2095 $params['campaign_id'] = $activity->campaign_id
;
2098 $date = CRM_Utils_Date
::isoToMysql($activity->receive_date
);
2101 $activityParams = array(
2102 'source_contact_id' => $activity->contact_id
,
2103 'source_record_id' => $activity->id
,
2104 'activity_type_id' => CRM_Core_PseudoConstant
::getKey('CRM_Activity_BAO_Activity', 'activity_type_id', $activityType),
2105 'activity_date_time' => $date,
2106 'is_test' => $activity->is_test
,
2107 'status_id' => CRM_Core_PseudoConstant
::getKey('CRM_Activity_BAO_Activity', 'activity_status_id', 'Completed'),
2108 'skipRecentView' => TRUE,
2109 'campaign_id' => $activity->campaign_id
,
2111 $activityParams = array_merge($activityParams, $params);
2113 if (empty($activityParams['subject'])) {
2114 $activityParams['subject'] = self
::getActivitySubject($activity);
2117 if (!empty($activity->activity_id
)) {
2118 $activityParams['id'] = $activity->activity_id
;
2120 // create activity with target contacts
2121 $id = CRM_Core_Session
::getLoggedInContactID();
2123 $activityParams['source_contact_id'] = $id;
2124 $activityParams['target_contact_id'][] = $activity->contact_id
;
2128 if (property_exists($activity, 'details')) {
2129 $activityParams['details'] = $activity->details
;
2132 if ($targetContactID) {
2133 $activityParams['target_contact_id'][] = $targetContactID;
2135 // @todo - use api - remove lots of wrangling above. Remove deprecated fatal & let form layer
2136 // deal with any exceptions.
2137 if (is_a(self
::create($activityParams), 'CRM_Core_Error')) {
2138 CRM_Core_Error
::fatal("Failed creating Activity for $component of id {$activity->id}");
2144 * Get activity subject on basis of component object.
2146 * @param object $entityObj
2147 * particular component object.
2151 public static function getActivitySubject($entityObj) {
2152 switch ($entityObj->__table
) {
2153 case 'civicrm_membership':
2154 $membershipType = CRM_Member_PseudoConstant
::membershipType($entityObj->membership_type_id
);
2155 $subject = $membershipType ?
$membershipType : ts('Membership');
2157 if (is_array($subject)) {
2158 $subject = implode(", ", $subject);
2161 if (!CRM_Utils_System
::isNull($entityObj->source
)) {
2162 $subject .= " - {$entityObj->source}";
2165 if ($entityObj->owner_membership_id
) {
2166 list($displayName) = CRM_Contact_BAO_Contact
::getDisplayAndImage(CRM_Core_DAO
::getFieldValue('CRM_Member_DAO_Membership', $entityObj->owner_membership_id
, 'contact_id'));
2167 $subject .= sprintf(' (by %s)', $displayName);
2170 $subject .= " - Status: " . CRM_Core_DAO
::getFieldValue('CRM_Member_DAO_MembershipStatus', $entityObj->status_id
, 'label');
2173 case 'civicrm_participant':
2174 $event = CRM_Event_BAO_Event
::getEvents(1, $entityObj->event_id
, TRUE, FALSE);
2175 $roles = CRM_Event_PseudoConstant
::participantRole();
2176 $status = CRM_Event_PseudoConstant
::participantStatus();
2177 $subject = $event[$entityObj->event_id
];
2179 if (!empty($roles[$entityObj->role_id
])) {
2180 $subject .= ' - ' . $roles[$entityObj->role_id
];
2182 if (!empty($status[$entityObj->status_id
])) {
2183 $subject .= ' - ' . $status[$entityObj->status_id
];
2188 case 'civicrm_contribution':
2189 $subject = CRM_Utils_Money
::format($entityObj->total_amount
, $entityObj->currency
);
2190 if (!CRM_Utils_System
::isNull($entityObj->source
)) {
2191 $subject .= " - {$entityObj->source}";
2199 * Get Parent activity for currently viewed activity.
2201 * @param int $activityId
2202 * Current activity id.
2205 * Id of parent activity otherwise false.
2207 public static function getParentActivity($activityId) {
2208 static $parentActivities = array();
2210 $activityId = CRM_Utils_Type
::escape($activityId, 'Integer');
2212 if (!array_key_exists($activityId, $parentActivities)) {
2213 $parentActivities[$activityId] = array();
2215 $parentId = CRM_Core_DAO
::getFieldValue('CRM_Activity_DAO_Activity',
2220 $parentActivities[$activityId] = $parentId ?
$parentId : FALSE;
2223 return $parentActivities[$activityId];
2227 * Get total count of prior revision of currently viewed activity.
2229 * @param $activityID
2230 * Current activity id.
2233 * $params count of prior activities otherwise false.
2235 public static function getPriorCount($activityID) {
2236 static $priorCounts = array();
2238 $activityID = CRM_Utils_Type
::escape($activityID, 'Integer');
2240 if (!array_key_exists($activityID, $priorCounts)) {
2241 $priorCounts[$activityID] = array();
2242 $originalID = CRM_Core_DAO
::getFieldValue('CRM_Activity_DAO_Activity',
2249 SELECT count( id ) AS cnt
2250 FROM civicrm_activity
2251 WHERE ( id = {$originalID} OR original_id = {$originalID} )
2252 AND is_current_revision = 0
2253 AND id < {$activityID}
2255 $params = array(1 => array($originalID, 'Integer'));
2256 $count = CRM_Core_DAO
::singleValueQuery($query, $params);
2258 $priorCounts[$activityID] = $count ?
$count : 0;
2261 return $priorCounts[$activityID];
2265 * Get all prior activities of currently viewed activity.
2267 * @param $activityID
2268 * Current activity id.
2269 * @param bool $onlyPriorRevisions
2272 * prior activities info.
2274 public static function getPriorAcitivities($activityID, $onlyPriorRevisions = FALSE) {
2275 static $priorActivities = array();
2277 $activityID = CRM_Utils_Type
::escape($activityID, 'Integer');
2278 $index = $activityID . '_' . (int) $onlyPriorRevisions;
2280 if (!array_key_exists($index, $priorActivities)) {
2281 $priorActivities[$index] = array();
2283 $originalID = CRM_Core_DAO
::getFieldValue('CRM_Activity_DAO_Activity',
2288 $originalID = $activityID;
2292 SELECT c.display_name as name, cl.modified_date as date, ca.id as activityID
2293 FROM civicrm_log cl, civicrm_contact c, civicrm_activity ca
2294 WHERE (ca.id = %1 OR ca.original_id = %1)
2295 AND cl.entity_table = 'civicrm_activity'
2296 AND cl.entity_id = ca.id
2297 AND cl.modified_id = c.id
2299 if ($onlyPriorRevisions) {
2300 $query .= " AND ca.id < {$activityID}";
2302 $query .= " ORDER BY ca.id DESC";
2304 $params = array(1 => array($originalID, 'Integer'));
2305 $dao = CRM_Core_DAO
::executeQuery($query, $params);
2307 while ($dao->fetch()) {
2308 $priorActivities[$index][$dao->activityID
]['id'] = $dao->activityID
;
2309 $priorActivities[$index][$dao->activityID
]['name'] = $dao->name
;
2310 $priorActivities[$index][$dao->activityID
]['date'] = $dao->date
;
2315 return $priorActivities[$index];
2319 * Find the latest revision of a given activity.
2321 * @param int $activityID
2322 * Prior activity id.
2325 * current activity id.
2327 public static function getLatestActivityId($activityID) {
2328 static $latestActivityIds = array();
2330 $activityID = CRM_Utils_Type
::escape($activityID, 'Integer');
2332 if (!array_key_exists($activityID, $latestActivityIds)) {
2333 $latestActivityIds[$activityID] = array();
2335 $originalID = CRM_Core_DAO
::getFieldValue('CRM_Activity_DAO_Activity',
2340 $activityID = $originalID;
2342 $params = array(1 => array($activityID, 'Integer'));
2343 $query = "SELECT id from civicrm_activity where original_id = %1 and is_current_revision = 1";
2345 $latestActivityIds[$activityID] = CRM_Core_DAO
::singleValueQuery($query, $params);
2348 return $latestActivityIds[$activityID];
2352 * Create a follow up a given activity.
2354 * @param int $activityId
2355 * activity id of parent activity.
2356 * @param array $params
2358 * @return CRM_Activity_BAO_Activity|null|object
2360 public static function createFollowupActivity($activityId, $params) {
2365 $followupParams = array();
2366 $followupParams['parent_id'] = $activityId;
2367 $followupParams['source_contact_id'] = CRM_Core_Session
::getLoggedInContactID();
2368 $followupParams['status_id'] = CRM_Core_OptionGroup
::getValue('activity_status', 'Scheduled', 'name');
2370 $followupParams['activity_type_id'] = $params['followup_activity_type_id'];
2371 // Get Subject of Follow-up Activiity, CRM-4491
2372 $followupParams['subject'] = CRM_Utils_Array
::value('followup_activity_subject', $params);
2373 $followupParams['assignee_contact_id'] = CRM_Utils_Array
::value('followup_assignee_contact_id', $params);
2375 // Create target contact for followup.
2376 if (!empty($params['target_contact_id'])) {
2377 $followupParams['target_contact_id'] = $params['target_contact_id'];
2380 $followupParams['activity_date_time'] = CRM_Utils_Date
::processDate($params['followup_date'],
2381 $params['followup_date_time']
2383 $followupActivity = self
::create($followupParams);
2385 return $followupActivity;
2389 * Get Activity specific File according activity type Id.
2391 * @param int $activityTypeId
2393 * @param string $crmDir
2395 * @return string|bool
2396 * if file exists returns $activityTypeFile activity filename otherwise false.
2398 public static function getFileForActivityTypeId($activityTypeId, $crmDir = 'Activity') {
2399 $activityTypes = CRM_Case_PseudoConstant
::caseActivityType(FALSE, TRUE);
2401 if ($activityTypes[$activityTypeId]['name']) {
2402 $activityTypeFile = CRM_Utils_String
::munge(ucwords($activityTypes[$activityTypeId]['name']), '', 0);
2408 global $civicrm_root;
2409 $config = CRM_Core_Config
::singleton();
2410 if (!file_exists(rtrim($civicrm_root, '/') . "/CRM/{$crmDir}/Form/Activity/{$activityTypeFile}.php")) {
2411 if (empty($config->customPHPPathDir
)) {
2414 elseif (!file_exists(rtrim($config->customPHPPathDir
, '/') . "/CRM/{$crmDir}/Form/Activity/{$activityTypeFile}.php")) {
2419 return $activityTypeFile;
2423 * Restore the activity.
2425 * @param array $params
2427 * @return CRM_Activity_DAO_Activity
2429 public static function restoreActivity(&$params) {
2430 $activity = new CRM_Activity_DAO_Activity();
2431 $activity->copyValues($params);
2433 $activity->is_deleted
= 0;
2434 $result = $activity->save();
2440 * Return list of activity statuses that are considered "completed".
2442 * Note: activity status options use the "grouping" field to distinguish complete from incomplete statuses.
2446 public static function getCompletedStatuses() {
2447 if (!isset(Civi
::$statics[__CLASS__
][__FUNCTION__
])) {
2448 $statuses = civicrm_api3('OptionValue', 'get', array(
2449 'option_group_id' => "activity_status",
2451 'return' => array('value'),
2453 'options' => array('limit' => 0),
2455 Civi
::$statics[__CLASS__
][__FUNCTION__
] = CRM_Utils_Array
::collect('value', $statuses['values']);
2457 return Civi
::$statics[__CLASS__
][__FUNCTION__
];
2461 * Check if status_id is completed.
2463 * Note: activity status options use the "grouping" field to distinguish complete from incomplete statuses.
2465 * @param int $statusId
2469 public static function isCompleted($statusId) {
2470 return in_array($statusId, self
::getCompletedStatuses());
2474 * Check if activity is overdue.
2476 * @param array $activity
2480 public static function isOverdue($activity) {
2481 return !self
::isCompleted($activity['status_id']) && CRM_Utils_Date
::overdue($activity['activity_date_time']);
2485 * Get the exportable fields for Activities.
2487 * @param string $name
2488 * If it is called by case $name = Case else $name = Activity.
2491 * array of exportable Fields
2493 public static function &exportableFields($name = 'Activity') {
2494 if (!isset(self
::$_exportableFields[$name])) {
2495 self
::$_exportableFields[$name] = array();
2497 // TODO: ideally we should retrieve all fields from xml, in this case since activity processing is done
2498 // my case hence we have defined fields as case_*
2499 if ($name == 'Activity') {
2500 $exportableFields = CRM_Activity_DAO_Activity
::export();
2501 $exportableFields['source_contact_id']['title'] = ts('Source Contact ID');
2502 $exportableFields['source_contact'] = array(
2503 'title' => ts('Source Contact'),
2504 'type' => CRM_Utils_Type
::T_STRING
,
2507 $Activityfields = array(
2508 'activity_type' => array(
2509 'title' => ts('Activity Type'),
2510 'name' => 'activity_type',
2511 'type' => CRM_Utils_Type
::T_STRING
,
2512 'searchByLabel' => TRUE,
2514 'activity_status' => array(
2515 'title' => ts('Activity Status'),
2516 'name' => 'activity_status',
2517 'type' => CRM_Utils_Type
::T_STRING
,
2518 'searchByLabel' => TRUE,
2520 'activity_priority' => array(
2521 'title' => ts('Activity Priority'),
2522 'name' => 'activity_priority',
2523 'type' => CRM_Utils_Type
::T_STRING
,
2524 'searchByLabel' => TRUE,
2527 $fields = array_merge($Activityfields, $exportableFields);
2530 // Set title to activity fields.
2532 'case_activity_subject' => array('title' => ts('Activity Subject'), 'type' => CRM_Utils_Type
::T_STRING
),
2533 'case_source_contact_id' => array('title' => ts('Activity Reporter'), 'type' => CRM_Utils_Type
::T_STRING
),
2534 'case_recent_activity_date' => array('title' => ts('Activity Actual Date'), 'type' => CRM_Utils_Type
::T_DATE
),
2535 'case_scheduled_activity_date' => array(
2536 'title' => ts('Activity Scheduled Date'),
2537 'type' => CRM_Utils_Type
::T_DATE
,
2539 'case_recent_activity_type' => array('title' => ts('Activity Type'), 'type' => CRM_Utils_Type
::T_STRING
),
2540 'case_activity_status' => array('title' => ts('Activity Status'), 'type' => CRM_Utils_Type
::T_STRING
),
2541 'case_activity_duration' => array('title' => ts('Activity Duration'), 'type' => CRM_Utils_Type
::T_INT
),
2542 'case_activity_medium_id' => array('title' => ts('Activity Medium'), 'type' => CRM_Utils_Type
::T_INT
),
2543 'case_activity_details' => array('title' => ts('Activity Details'), 'type' => CRM_Utils_Type
::T_TEXT
),
2544 'case_activity_is_auto' => array(
2545 'title' => ts('Activity Auto-generated?'),
2546 'type' => CRM_Utils_Type
::T_BOOLEAN
,
2551 // add custom data for case activities
2552 $fields = array_merge($fields, CRM_Core_BAO_CustomField
::getFieldsForImport('Activity'));
2554 self
::$_exportableFields[$name] = $fields;
2556 return self
::$_exportableFields[$name];
2560 * Get the allowed profile fields for Activities.
2563 * array of activity profile Fields
2565 public static function getProfileFields() {
2566 $exportableFields = self
::exportableFields('Activity');
2567 $skipFields = array(
2570 'source_contact_id',
2572 'activity_campaign',
2574 'is_current_revision',
2575 'activity_is_deleted',
2577 $config = CRM_Core_Config
::singleton();
2578 if (!in_array('CiviCampaign', $config->enableComponents
)) {
2579 $skipFields[] = 'activity_engagement_level';
2582 foreach ($skipFields as $field) {
2583 if (isset($exportableFields[$field])) {
2584 unset($exportableFields[$field]);
2588 // hack to use 'activity_type_id' instead of 'activity_type'
2589 $exportableFields['activity_status_id'] = $exportableFields['activity_status'];
2590 unset($exportableFields['activity_status']);
2592 return $exportableFields;
2596 * This function deletes the activity record related to contact record.
2598 * This is conditional on there being no target and assignee record
2599 * with other contacts.
2601 * @param int $contactId
2606 public static function cleanupActivity($contactId) {
2611 $activityContacts = CRM_Core_OptionGroup
::values('activity_contacts', FALSE, FALSE, FALSE, NULL, 'name');
2612 $sourceID = CRM_Utils_Array
::key('Activity Source', $activityContacts);
2614 $transaction = new CRM_Core_Transaction();
2616 // delete activity if there is no record in civicrm_activity_contact
2617 // pointing to any other contact record
2618 $activityContact = new CRM_Activity_DAO_ActivityContact();
2619 $activityContact->contact_id
= $contactId;
2620 $activityContact->record_type_id
= $sourceID;
2621 $activityContact->find();
2623 while ($activityContact->fetch()) {
2624 // delete activity_contact record for the deleted contact
2625 $activityContact->delete();
2627 $activityContactOther = new CRM_Activity_DAO_ActivityContact();
2628 $activityContactOther->activity_id
= $activityContact->activity_id
;
2630 // delete activity only if no other contacts connected
2631 if (!$activityContactOther->find(TRUE)) {
2632 $activityParams = array('id' => $activityContact->activity_id
);
2633 $result = self
::deleteActivity($activityParams);
2636 $activityContactOther->free();
2639 $activityContact->free();
2640 $transaction->commit();
2646 * Does user has sufficient permission for view/edit activity record.
2648 * @param int $activityId
2649 * Activity record id.
2650 * @param int $action
2655 public static function checkPermission($activityId, $action) {
2658 !in_array($action, array(CRM_Core_Action
::UPDATE
, CRM_Core_Action
::VIEW
))
2663 $activity = new CRM_Activity_DAO_Activity();
2664 $activity->id
= $activityId;
2665 if (!$activity->find(TRUE)) {
2669 // Component related permissions.
2670 $compPermissions = array(
2671 'CiviCase' => array(
2672 'administer CiviCase',
2673 'access my cases and activities',
2674 'access all cases and activities',
2676 'CiviMail' => array('access CiviMail'),
2677 'CiviEvent' => array('access CiviEvent'),
2678 'CiviGrant' => array('access CiviGrant'),
2679 'CiviPledge' => array('access CiviPledge'),
2680 'CiviMember' => array('access CiviMember'),
2681 'CiviReport' => array('access CiviReport'),
2682 'CiviContribute' => array('access CiviContribute'),
2683 'CiviCampaign' => array('administer CiviCampaign'),
2686 // Return early when it is case activity.
2687 $isCaseActivity = CRM_Case_BAO_Case
::isCaseActivity($activityId);
2688 // Check for civicase related permission.
2689 if ($isCaseActivity) {
2691 foreach ($compPermissions['CiviCase'] as $per) {
2692 if (CRM_Core_Permission
::check($per)) {
2698 // Check for case specific permissions.
2701 if ($action == CRM_Core_Action
::UPDATE
) {
2704 $allow = CRM_Case_BAO_Case
::checkPermission($activityId,
2706 $activity->activity_type_id
2713 // First check the component permission.
2716 FROM civicrm_option_value val
2717 INNER JOIN civicrm_option_group grp ON ( grp.id = val.option_group_id AND grp.name = %1 )
2718 WHERE val.value = %2";
2720 1 => array('activity_type', 'String'),
2721 2 => array($activity->activity_type_id
, 'Integer'),
2723 $componentId = CRM_Core_DAO
::singleValueQuery($sql, $params);
2726 $componentName = CRM_Core_Component
::getComponentName($componentId);
2727 $compPermission = CRM_Utils_Array
::value($componentName, $compPermissions);
2729 // Here we are interesting in any single permission.
2730 if (is_array($compPermission)) {
2731 foreach ($compPermission as $per) {
2732 if (CRM_Core_Permission
::check($per)) {
2740 // Check for this permission related to contact.
2741 $permission = CRM_Core_Permission
::VIEW
;
2742 if ($action == CRM_Core_Action
::UPDATE
) {
2743 $permission = CRM_Core_Permission
::EDIT
;
2746 $activityContacts = CRM_Core_OptionGroup
::values('activity_contacts', FALSE, FALSE, FALSE, NULL, 'name');
2747 $sourceID = CRM_Utils_Array
::key('Activity Source', $activityContacts);
2748 $assigneeID = CRM_Utils_Array
::key('Activity Assignees', $activityContacts);
2749 $targetID = CRM_Utils_Array
::key('Activity Targets', $activityContacts);
2751 // Check for source contact.
2752 if (!$componentId ||
$allow) {
2753 $sourceContactId = self
::getActivityContact($activity->id
, $sourceID);
2754 // Account for possibility of activity not having a source contact (as it may have been deleted).
2755 $allow = $sourceContactId ? CRM_Contact_BAO_Contact_Permission
::allow($sourceContactId, $permission) : TRUE;
2758 // Check for target and assignee contacts.
2760 // First check for supper permission.
2761 $supPermission = 'view all contacts';
2762 if ($action == CRM_Core_Action
::UPDATE
) {
2763 $supPermission = 'edit all contacts';
2765 $allow = CRM_Core_Permission
::check($supPermission);
2767 // User might have sufficient permission, through acls.
2770 // Get the target contacts.
2771 $targetContacts = CRM_Activity_BAO_ActivityContact
::retrieveContactIdsByActivityId($activity->id
, $targetID);
2772 foreach ($targetContacts as $cnt => $contactId) {
2773 if (!CRM_Contact_BAO_Contact_Permission
::allow($contactId, $permission)) {
2779 // Get the assignee contacts.
2781 $assigneeContacts = CRM_Activity_BAO_ActivityContact
::retrieveContactIdsByActivityId($activity->id
, $assigneeID);
2782 foreach ($assigneeContacts as $cnt => $contactId) {
2783 if (!CRM_Contact_BAO_Contact_Permission
::allow($contactId, $permission)) {
2796 * Wrapper for ajax activity selector.
2798 * @param array $params
2799 * Associated array for params record id.
2802 * Associated array of contact activities
2804 public static function getContactActivitySelector(&$params) {
2805 // Format the params.
2806 $params['offset'] = ($params['page'] - 1) * $params['rp'];
2807 $params['rowCount'] = $params['rp'];
2808 $params['sort'] = CRM_Utils_Array
::value('sortBy', $params);
2809 $params['caseId'] = NULL;
2810 $context = CRM_Utils_Array
::value('context', $params);
2811 $showContactOverlay = !CRM_Utils_String
::startsWith($context, "dashlet");
2812 $activityTypeInfo = civicrm_api3('OptionValue', 'get', array(
2813 'option_group_id' => "activity_type",
2814 'options' => array('limit' => 0),
2816 $activityIcons = array();
2817 foreach ($activityTypeInfo['values'] as $type) {
2818 if (!empty($type['icon'])) {
2819 $activityIcons[$type['value']] = $type['icon'];
2823 // Get contact activities.
2824 $activities = CRM_Activity_BAO_Activity
::deprecatedGetActivities($params);
2827 $params['total'] = CRM_Activity_BAO_Activity
::deprecatedGetActivitiesCount($params);
2829 // Format params and add links.
2830 $contactActivities = array();
2832 if (!empty($activities)) {
2833 $activityStatus = CRM_Core_PseudoConstant
::activityStatus();
2835 // Check logged in user for permission.
2836 $page = new CRM_Core_Page();
2837 CRM_Contact_Page_View
::checkUserPermission($page, $params['contact_id']);
2838 $permissions = array($page->_permission
);
2839 if (CRM_Core_Permission
::check('delete activities')) {
2840 $permissions[] = CRM_Core_Permission
::DELETE
;
2843 $mask = CRM_Core_Action
::mask($permissions);
2845 foreach ($activities as $activityId => $values) {
2846 $activity = array();
2847 $activity['DT_RowId'] = $activityId;
2848 // Add class to this row if overdue.
2849 $activity['DT_RowClass'] = "crm-entity status-id-{$values['status_id']}";
2850 if (self
::isOverdue($values)) {
2851 $activity['DT_RowClass'] .= ' status-overdue';
2854 $activity['DT_RowClass'] .= ' status-ontime';
2857 $activity['DT_RowAttr'] = array();
2858 $activity['DT_RowAttr']['data-entity'] = 'activity';
2859 $activity['DT_RowAttr']['data-id'] = $activityId;
2861 $activity['activity_type'] = (!empty($activityIcons[$values['activity_type_id']]) ?
'<span class="crm-i ' . $activityIcons[$values['activity_type_id']] . '"></span> ' : '') . $values['activity_type'];
2862 $activity['subject'] = $values['subject'];
2864 $activity['source_contact_name'] = '';
2865 if ($params['contact_id'] == $values['source_contact_id']) {
2866 $activity['source_contact_name'] = $values['source_contact_name'];
2868 elseif ($values['source_contact_id']) {
2870 if ($showContactOverlay) {
2871 $srcTypeImage = CRM_Contact_BAO_Contact_Utils
::getImage(
2872 CRM_Contact_BAO_Contact
::getContactType($values['source_contact_id']),
2874 $values['source_contact_id']);
2876 $activity['source_contact_name'] = $srcTypeImage . CRM_Utils_System
::href($values['source_contact_name'],
2877 'civicrm/contact/view', "reset=1&cid={$values['source_contact_id']}");
2880 $activity['source_contact_name'] = '<em>n/a</em>';
2883 $activity['target_contact_name'] = '';
2884 if (isset($values['mailingId']) && !empty($values['mailingId'])) {
2885 $activity['target_contact'] = CRM_Utils_System
::href($values['recipients'],
2886 'civicrm/mailing/report/event',
2887 "mid={$values['source_record_id']}&reset=1&event=queue&cid={$params['contact_id']}&context=activitySelector");
2889 elseif (!empty($values['recipients'])) {
2890 $activity['target_contact_name'] = $values['recipients'];
2892 elseif (isset($values['target_contact_counter']) && $values['target_contact_counter']) {
2893 $activity['target_contact_name'] = '';
2894 foreach ($values['target_contact_name'] as $tcID => $tcName) {
2895 $targetTypeImage = "";
2896 $targetLink = CRM_Utils_System
::href($tcName, 'civicrm/contact/view', "reset=1&cid={$tcID}");
2897 if ($showContactOverlay) {
2898 $targetTypeImage = CRM_Contact_BAO_Contact_Utils
::getImage(
2899 CRM_Contact_BAO_Contact
::getContactType($tcID),
2902 $activity['target_contact_name'] .= "<div>$targetTypeImage $targetLink";
2905 $activity['target_contact_name'] .= $targetLink;
2909 if ($extraCount = $values['target_contact_counter'] - 1) {
2910 $activity['target_contact_name'] .= ";<br />" . "(" . ts('%1 more', array(1 => $extraCount)) . ")";
2912 if ($showContactOverlay) {
2913 $activity['target_contact_name'] .= "</div> ";
2916 elseif (!$values['target_contact_name']) {
2917 $activity['target_contact_name'] = '<em>n/a</em>';
2920 $activity['assignee_contact_name'] = '';
2921 if (empty($values['assignee_contact_name'])) {
2922 $activity['assignee_contact_name'] = '<em>n/a</em>';
2924 elseif (!empty($values['assignee_contact_name'])) {
2926 $activity['assignee_contact_name'] = '';
2927 foreach ($values['assignee_contact_name'] as $acID => $acName) {
2928 if ($acID && $count < 5) {
2929 $assigneeTypeImage = "";
2930 $assigneeLink = CRM_Utils_System
::href($acName, 'civicrm/contact/view', "reset=1&cid={$acID}");
2931 if ($showContactOverlay) {
2932 $assigneeTypeImage = CRM_Contact_BAO_Contact_Utils
::getImage(
2933 CRM_Contact_BAO_Contact
::getContactType($acID),
2936 $activity['assignee_contact_name'] .= "<div>$assigneeTypeImage $assigneeLink";
2939 $activity['assignee_contact_name'] .= $assigneeLink;
2944 $activity['assignee_contact_name'] .= "; ";
2946 if ($showContactOverlay) {
2947 $activity['assignee_contact_name'] .= "</div> ";
2951 $activity['assignee_contact_name'] .= "(" . ts('more') . ")";
2958 $activity['activity_date_time'] = CRM_Utils_Date
::customFormat($values['activity_date_time']);
2959 $activity['status_id'] = $activityStatus[$values['status_id']];
2962 $activity['links'] = '';
2963 $accessMailingReport = FALSE;
2964 if (!empty($values['mailingId'])) {
2965 $accessMailingReport = TRUE;
2968 $actionLinks = CRM_Activity_Selector_Activity
::actionLinks(
2969 CRM_Utils_Array
::value('activity_type_id', $values),
2970 CRM_Utils_Array
::value('source_record_id', $values),
2971 $accessMailingReport,
2972 CRM_Utils_Array
::value('activity_id', $values)
2975 $actionMask = array_sum(array_keys($actionLinks)) & $mask;
2977 $activity['links'] = CRM_Core_Action
::formLink($actionLinks,
2980 'id' => $values['activity_id'],
2981 'cid' => $params['contact_id'],
2983 'caseid' => CRM_Utils_Array
::value('case_id', $values),
2989 $values['activity_id']
2992 if ($values['is_recurring_activity']) {
2993 $activity['is_recurring_activity'] = CRM_Core_BAO_RecurringEntity
::getPositionAndCount($values['activity_id'], 'civicrm_activity');
2996 array_push($contactActivities, $activity);
3000 $activitiesDT = array();
3001 $activitiesDT['data'] = $contactActivities;
3002 $activitiesDT['recordsTotal'] = $params['total'];
3003 $activitiesDT['recordsFiltered'] = $params['total'];
3005 return $activitiesDT;
3009 * Copy custom fields and attachments from an existing activity to another.
3011 * @see CRM_Case_Page_AJAX::_convertToCaseActivity()
3013 * @param array $params
3015 public static function copyExtendedActivityData($params) {
3016 // attach custom data to the new activity
3017 $customParams = $htmlType = array();
3018 $customValues = CRM_Core_BAO_CustomValueTable
::getEntityValues($params['activityID'], 'Activity');
3020 if (!empty($customValues)) {
3021 $fieldIds = implode(', ', array_keys($customValues));
3022 $sql = "SELECT id FROM civicrm_custom_field WHERE html_type = 'File' AND id IN ( {$fieldIds} )";
3023 $result = CRM_Core_DAO
::executeQuery($sql);
3025 while ($result->fetch()) {
3026 $htmlType[] = $result->id
;
3029 foreach ($customValues as $key => $value) {
3030 if ($value !== NULL) {
3032 if (in_array($key, $htmlType)) {
3033 $fileValues = CRM_Core_BAO_File
::path($value, $params['activityID']);
3034 $customParams["custom_{$key}_-1"] = array(
3035 'name' => $fileValues[0],
3036 'path' => $fileValues[1],
3040 $customParams["custom_{$key}_-1"] = $value;
3044 CRM_Core_BAO_CustomValueTable
::postProcess($customParams, 'civicrm_activity',
3045 $params['mainActivityId'], 'Activity'
3049 // copy activity attachments ( if any )
3050 CRM_Core_BAO_File
::copyEntityFile('civicrm_activity', $params['activityID'], 'civicrm_activity', $params['mainActivityId']);
3054 * Get activity contact.
3056 * @param int $activityId
3057 * @param int $recordTypeID
3058 * @param string $column
3062 public static function getActivityContact($activityId, $recordTypeID = NULL, $column = 'contact_id') {
3063 $activityContact = new CRM_Activity_BAO_ActivityContact();
3064 $activityContact->activity_id
= $activityId;
3065 if ($recordTypeID) {
3066 $activityContact->record_type_id
= $recordTypeID;
3068 if ($activityContact->find(TRUE)) {
3069 return $activityContact->$column;
3075 * Get source contact id.
3077 * @param int $activityId
3081 public static function getSourceContactID($activityId) {
3082 static $sourceID = NULL;
3084 $activityContacts = CRM_Core_OptionGroup
::values('activity_contacts', FALSE, FALSE, FALSE, NULL, 'name');
3085 $sourceID = CRM_Utils_Array
::key('Activity Source', $activityContacts);
3088 return self
::getActivityContact($activityId, $sourceID);
3094 * @todo Document what this is for.
3096 * @param array $params
3098 public function setApiFilter(&$params) {
3099 if (!empty($params['target_contact_id'])) {
3101 $activityContacts = CRM_Core_OptionGroup
::values('activity_contacts', FALSE, FALSE, FALSE, NULL, 'name');
3102 $targetID = CRM_Utils_Array
::key('Activity Targets', $activityContacts);
3103 $obj = new CRM_Activity_BAO_ActivityContact();
3104 $params['return.target_contact_id'] = 1;
3105 $this->joinAdd($obj, 'LEFT');
3106 $this->selectAdd('civicrm_activity.*');
3107 $this->whereAdd(" civicrm_activity_contact.contact_id = {$params['target_contact_id']} AND civicrm_activity_contact.record_type_id = {$targetID}");
3112 * Send activity as attachment.
3114 * @param object $activity
3115 * @param array $mailToContacts
3116 * @param array $params
3120 public static function sendToAssignee($activity, $mailToContacts, $params = array()) {
3121 if (!CRM_Utils_Array
::crmIsEmptyArray($mailToContacts)) {
3122 $clientID = CRM_Utils_Array
::value('client_id', $params);
3123 $caseID = CRM_Utils_Array
::value('case_id', $params);
3125 $ics = new CRM_Activity_BAO_ICalendar($activity);
3126 $attachments = CRM_Core_BAO_File
::getEntityFile('civicrm_activity', $activity->id
);
3127 $ics->addAttachment($attachments, $mailToContacts);
3129 $result = CRM_Case_BAO_Case
::sendActivityCopy($clientID, $activity->id
, $mailToContacts, $attachments, $caseID);