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 ($input['context'] != 'activity') {
1238 $commonClauses[] = "civicrm_activity.status_id = 1";
1241 // Filter on component IDs.
1242 $components = self
::activityComponents();
1243 if (!empty($components)) {
1244 $componentsIn = implode(',', array_keys($components));
1245 $commonClauses[] = "( civicrm_option_value.component_id IS NULL OR civicrm_option_value.component_id IN ( $componentsIn ) )";
1248 $commonClauses[] = "civicrm_option_value.component_id IS NULL";
1251 // activity type ID clause
1252 if (!empty($input['activity_type_id'])) {
1253 if (is_array($input['activity_type_id'])) {
1254 foreach ($input['activity_type_id'] as $idx => $value) {
1255 $input['activity_type_id'][$idx] = CRM_Utils_Type
::escape($value, 'Positive');
1257 $commonClauses[] = "civicrm_activity.activity_type_id IN ( " . implode(",", $input['activity_type_id']) . " ) ";
1260 $activityTypeID = CRM_Utils_Type
::escape($input['activity_type_id'], 'Positive');
1261 $commonClauses[] = "civicrm_activity.activity_type_id = $activityTypeID";
1265 // exclude by activity type clause
1266 if (!empty($input['activity_type_exclude_id'])) {
1267 if (is_array($input['activity_type_exclude_id'])) {
1268 foreach ($input['activity_type_exclude_id'] as $idx => $value) {
1269 $input['activity_type_exclude_id'][$idx] = CRM_Utils_Type
::escape($value, 'Positive');
1271 $commonClauses[] = "civicrm_activity.activity_type_id NOT IN ( " . implode(",", $input['activity_type_exclude_id']) . " ) ";
1274 $activityTypeID = CRM_Utils_Type
::escape($input['activity_type_exclude_id'], 'Positive');
1275 $commonClauses[] = "civicrm_activity.activity_type_id != $activityTypeID";
1279 $commonClause = implode(' AND ', $commonClauses);
1281 $includeCaseActivities = FALSE;
1282 if (in_array('CiviCase', $components)) {
1283 $includeCaseActivities = TRUE;
1286 // build main activity table select clause
1289 $activityContacts = CRM_Core_OptionGroup
::values('activity_contacts', FALSE, FALSE, FALSE, NULL, 'name');
1290 $sourceID = CRM_Utils_Array
::key('Activity Source', $activityContacts);
1292 INNER JOIN civicrm_activity_contact ac ON ac.activity_id = civicrm_activity.id
1293 INNER JOIN civicrm_contact contact ON ac.contact_id = contact.id
1296 if (!$input['count']) {
1298 civicrm_activity.activity_date_time,
1299 civicrm_activity.source_record_id,
1300 civicrm_activity.status_id,
1301 civicrm_activity.subject,
1302 contact.sort_name as source_contact_name,
1303 civicrm_option_value.value as activity_type_id,
1304 civicrm_option_value.label as activity_type,
1305 null as case_id, null as case_subject,
1306 civicrm_activity.campaign_id as campaign_id
1310 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)
1315 SELECT civicrm_activity.id as activity_id
1317 from civicrm_activity
1318 left join civicrm_option_value on
1319 civicrm_activity.activity_type_id = civicrm_option_value.value
1320 left join civicrm_option_group on
1321 civicrm_option_group.id = civicrm_option_value.option_group_id
1328 // Build case clause
1329 // or else exclude Inbound Emails that have been filed on a case.
1332 if ($includeCaseActivities) {
1334 if (!$input['count']) {
1336 civicrm_activity.activity_date_time,
1337 civicrm_activity.source_record_id,
1338 civicrm_activity.status_id,
1339 civicrm_activity.subject,
1340 contact.sort_name as source_contact_name,
1341 civicrm_option_value.value as activity_type_id,
1342 civicrm_option_value.label as activity_type,
1343 null as case_id, null as case_subject,
1344 civicrm_activity.campaign_id as campaign_id';
1350 SELECT civicrm_activity.id as activity_id
1352 from civicrm_activity
1353 inner join civicrm_case_activity on
1354 civicrm_case_activity.activity_id = civicrm_activity.id
1355 inner join civicrm_case on
1356 civicrm_case_activity.case_id = civicrm_case.id
1357 inner join civicrm_case_contact on
1358 civicrm_case_contact.case_id = civicrm_case.id and {$caseWhere}
1359 left join civicrm_option_value on
1360 civicrm_activity.activity_type_id = civicrm_option_value.value
1361 left join civicrm_option_group on
1362 civicrm_option_group.id = civicrm_option_value.option_group_id
1367 and ( ( civicrm_case_activity.case_id IS NULL ) OR
1368 ( civicrm_option_value.name <> 'Inbound Email' AND
1369 civicrm_option_value.name <> 'Email' AND civicrm_case_activity.case_id
1375 $returnClause = " {$sourceClause} {$caseClause} ";
1377 return array($returnClause, $params);
1381 * Send the message to all the contacts.
1383 * Also insert a contact activity in each contacts record.
1385 * @param array $contactDetails
1386 * The array of contact details to send the email.
1387 * @param string $subject
1388 * The subject of the message.
1391 * @param string $emailAddress
1392 * Use this 'to' email address instead of the default Primary address.
1393 * @param int $userID
1394 * Use this userID if set.
1395 * @param string $from
1396 * @param array $attachments
1397 * The array of attachments if any.
1400 * @param string $bcc
1402 * @param array $contactIds
1404 * @param string $additionalDetails
1405 * The additional information of CC and BCC appended to the activity Details.
1406 * @param array $contributionIds
1407 * @param int $campaignId
1410 * ( sent, activityId) if any email is sent and activityId
1412 public static function sendEmail(
1420 $attachments = NULL,
1424 $additionalDetails = NULL,
1425 $contributionIds = NULL,
1428 // get the contact details of logged in contact, which we set as from email
1429 if ($userID == NULL) {
1430 $userID = CRM_Core_Session
::getLoggedInContactID();
1433 list($fromDisplayName, $fromEmail, $fromDoNotEmail) = CRM_Contact_BAO_Contact
::getContactDetails($userID);
1435 return array(count($contactDetails), 0, count($contactDetails));
1437 if (!trim($fromDisplayName)) {
1438 $fromDisplayName = $fromEmail;
1442 // token replacement of addressee/email/postal greetings
1443 // get the tokens added in subject and message
1444 $subjectToken = CRM_Utils_Token
::getTokens($subject);
1445 $messageToken = CRM_Utils_Token
::getTokens($text);
1446 $messageToken = array_merge($messageToken, CRM_Utils_Token
::getTokens($html));
1447 $allTokens = array_merge($messageToken, $subjectToken);
1450 $from = "$fromDisplayName <$fromEmail>";
1453 //create the meta level record first ( email activity )
1454 $activityTypeID = CRM_Core_PseudoConstant
::getKey('CRM_Activity_BAO_Activity', 'activity_type_id',
1458 // CRM-6265: save both text and HTML parts in details (if present)
1459 if ($html and $text) {
1460 $details = "-ALTERNATIVE ITEM 0-\n$html$additionalDetails\n-ALTERNATIVE ITEM 1-\n$text$additionalDetails\n-ALTERNATIVE END-\n";
1463 $details = $html ?
$html : $text;
1464 $details .= $additionalDetails;
1467 $activityParams = array(
1468 'source_contact_id' => $userID,
1469 'activity_type_id' => $activityTypeID,
1470 'activity_date_time' => date('YmdHis'),
1471 'subject' => $subject,
1472 'details' => $details,
1473 // FIXME: check for name Completed and get ID from that lookup
1475 'campaign_id' => $campaignId,
1478 // CRM-5916: strip [case #…] before saving the activity (if present in subject)
1479 $activityParams['subject'] = preg_replace('/\[case #([0-9a-h]{7})\] /', '', $activityParams['subject']);
1481 // add the attachments to activity params here
1483 // first process them
1484 $activityParams = array_merge($activityParams,
1489 $activity = self
::create($activityParams);
1491 // get the set of attachments from where they are stored
1492 $attachments = CRM_Core_BAO_File
::getEntityFile('civicrm_activity',
1495 $returnProperties = array();
1496 if (isset($messageToken['contact'])) {
1497 foreach ($messageToken['contact'] as $key => $value) {
1498 $returnProperties[$value] = 1;
1502 if (isset($subjectToken['contact'])) {
1503 foreach ($subjectToken['contact'] as $key => $value) {
1504 if (!isset($returnProperties[$value])) {
1505 $returnProperties[$value] = 1;
1510 // get token details for contacts, call only if tokens are used
1512 if (!empty($returnProperties) ||
!empty($tokens) ||
!empty($allTokens)) {
1513 list($details) = CRM_Utils_Token
::getTokenDetails(
1518 'CRM_Activity_BAO_Activity'
1524 CRM_Utils_Hook
::tokens($tokens);
1525 $categories = array_keys($tokens);
1527 $escapeSmarty = FALSE;
1528 if (defined('CIVICRM_MAIL_SMARTY') && CIVICRM_MAIL_SMARTY
) {
1529 $smarty = CRM_Core_Smarty
::singleton();
1530 $escapeSmarty = TRUE;
1533 $contributionDetails = array();
1534 if (!empty($contributionIds)) {
1535 $contributionDetails = CRM_Contribute_BAO_Contribution
::replaceContributionTokens(
1546 $sent = $notSent = array();
1547 foreach ($contactDetails as $values) {
1548 $contactId = $values['contact_id'];
1549 $emailAddress = $values['email'];
1551 if (!empty($contributionDetails)) {
1552 $subject = $contributionDetails[$contactId]['subject'];
1553 $text = $contributionDetails[$contactId]['text'];
1554 $html = $contributionDetails[$contactId]['html'];
1557 if (!empty($details) && is_array($details["{$contactId}"])) {
1558 // unset email from details since it always returns primary email address
1559 unset($details["{$contactId}"]['email']);
1560 unset($details["{$contactId}"]['email_id']);
1561 $values = array_merge($values, $details["{$contactId}"]);
1564 $tokenSubject = CRM_Utils_Token
::replaceContactTokens($subject, $values, FALSE, $subjectToken, FALSE, $escapeSmarty);
1565 $tokenSubject = CRM_Utils_Token
::replaceHookTokens($tokenSubject, $values, $categories, FALSE, $escapeSmarty);
1568 if ($values['preferred_mail_format'] == 'Text' ||
$values['preferred_mail_format'] == 'Both') {
1569 $tokenText = CRM_Utils_Token
::replaceContactTokens($text, $values, FALSE, $messageToken, FALSE, $escapeSmarty);
1570 $tokenText = CRM_Utils_Token
::replaceHookTokens($tokenText, $values, $categories, FALSE, $escapeSmarty);
1576 if ($values['preferred_mail_format'] == 'HTML' ||
$values['preferred_mail_format'] == 'Both') {
1577 $tokenHtml = CRM_Utils_Token
::replaceContactTokens($html, $values, TRUE, $messageToken, FALSE, $escapeSmarty);
1578 $tokenHtml = CRM_Utils_Token
::replaceHookTokens($tokenHtml, $values, $categories, TRUE, $escapeSmarty);
1584 if (defined('CIVICRM_MAIL_SMARTY') && CIVICRM_MAIL_SMARTY
) {
1585 // also add the contact tokens to the template
1586 $smarty->assign_by_ref('contact', $values);
1588 $tokenSubject = $smarty->fetch("string:$tokenSubject");
1589 $tokenText = $smarty->fetch("string:$tokenText");
1590 $tokenHtml = $smarty->fetch("string:$tokenHtml");
1594 if (self
::sendMessage(
1612 return array($sent, $activity->id
);
1618 * @param array $contactDetails
1619 * @param array $activityParams
1620 * @param array $smsParams
1621 * @param $contactIds
1622 * @param int $userID
1625 * @throws CRM_Core_Exception
1627 public static function sendSMS(
1630 &$smsParams = array(),
1634 if ($userID == NULL) {
1635 $userID = CRM_Core_Session
::getLoggedInContactID();
1638 $text = &$activityParams['sms_text_message'];
1641 // token replacement of addressee/email/postal greetings
1642 // get the tokens added in subject and message
1643 $messageToken = CRM_Utils_Token
::getTokens($text);
1645 // Create the meta level record first ( sms activity )
1646 $activityTypeID = CRM_Core_PseudoConstant
::getKey('CRM_Activity_BAO_Activity',
1653 $activitySubject = $activityParams['activity_subject'];
1654 $activityParams = array(
1655 'source_contact_id' => $userID,
1656 'activity_type_id' => $activityTypeID,
1657 'activity_date_time' => date('YmdHis'),
1658 'subject' => $activitySubject,
1659 'details' => $details,
1660 // FIXME: check for name Completed and get ID from that lookup
1664 $activity = self
::create($activityParams);
1665 $activityID = $activity->id
;
1667 $returnProperties = array();
1669 if (isset($messageToken['contact'])) {
1670 foreach ($messageToken['contact'] as $key => $value) {
1671 $returnProperties[$value] = 1;
1677 CRM_Utils_Hook
::tokens($tokens);
1678 $categories = array_keys($tokens);
1680 // get token details for contacts, call only if tokens are used
1682 if (!empty($returnProperties) ||
!empty($tokens)) {
1683 list($details) = CRM_Utils_Token
::getTokenDetails($contactIds,
1687 'CRM_Activity_BAO_Activity'
1692 $escapeSmarty = FALSE;
1694 foreach ($contactDetails as $values) {
1695 $contactId = $values['contact_id'];
1697 if (!empty($details) && is_array($details["{$contactId}"])) {
1698 // unset phone from details since it always returns primary number
1699 unset($details["{$contactId}"]['phone']);
1700 unset($details["{$contactId}"]['phone_type_id']);
1701 $values = array_merge($values, $details["{$contactId}"]);
1704 $tokenText = CRM_Utils_Token
::replaceContactTokens($text, $values, FALSE, $messageToken, FALSE, $escapeSmarty);
1705 $tokenText = CRM_Utils_Token
::replaceHookTokens($tokenText, $values, $categories, FALSE, $escapeSmarty);
1707 // Only send if the phone is of type mobile
1708 $phoneTypes = CRM_Core_OptionGroup
::values('phone_type', TRUE, FALSE, FALSE, NULL, 'name');
1709 if ($values['phone_type_id'] == CRM_Utils_Array
::value('Mobile', $phoneTypes)) {
1710 $smsParams['To'] = $values['phone'];
1713 $smsParams['To'] = '';
1716 $sendResult = self
::sendSMSMessage(
1724 if (PEAR
::isError($sendResult)) {
1725 // Collect all of the PEAR_Error objects
1726 $errMsgs[] = $sendResult;
1733 // If at least one message was sent and no errors
1734 // were generated then return a boolean value of TRUE.
1735 // Otherwise, return FALSE (no messages sent) or
1736 // and array of 1 or more PEAR_Error objects.
1738 if ($success > 0 && count($errMsgs) == 0) {
1741 elseif (count($errMsgs) > 0) {
1745 return array($sent, $activity->id
, $success);
1749 * Send the sms message to a specific contact.
1752 * The contact id of the recipient.
1754 * @param array $smsParams
1755 * The params used for sending sms.
1756 * @param int $activityID
1757 * The activity ID that tracks the message.
1758 * @param int $userID
1760 * @return bool|PEAR_Error
1761 * true on success or PEAR_Error object
1763 public static function sendSMSMessage(
1766 $smsParams = array(),
1771 $toPhoneNumber = "";
1773 if ($smsParams['To']) {
1774 $toPhoneNumber = trim($smsParams['To']);
1777 $filters = array('is_deceased' => 0, 'is_deleted' => 0, 'do_not_sms' => 0);
1778 $toPhoneNumbers = CRM_Core_BAO_Phone
::allPhones($toID, FALSE, 'Mobile', $filters);
1779 // To get primary mobile phonenumber,if not get the first mobile phonenumber
1780 if (!empty($toPhoneNumbers)) {
1781 $toPhoneNumerDetails = reset($toPhoneNumbers);
1782 $toPhoneNumber = CRM_Utils_Array
::value('phone', $toPhoneNumerDetails);
1783 // Contact allows to send sms
1788 // make sure both phone are valid
1789 // and that the recipient wants to receive sms
1790 if (empty($toPhoneNumber) or $toDoNotSms) {
1791 return PEAR
::raiseError(
1792 'Recipient phone number is invalid or recipient does not want to receive SMS',
1798 $recipient = $smsParams['To'];
1799 $smsParams['contact_id'] = $toID;
1800 $smsParams['parent_activity_id'] = $activityID;
1802 $providerObj = CRM_SMS_Provider
::singleton(array('provider_id' => $smsParams['provider_id']));
1803 $sendResult = $providerObj->send($recipient, $smsParams, $tokenText, NULL, $userID);
1804 if (PEAR
::isError($sendResult)) {
1808 $activityContacts = CRM_Core_OptionGroup
::values('activity_contacts', FALSE, FALSE, FALSE, NULL, 'name');
1809 $targetID = CRM_Utils_Array
::key('Activity Targets', $activityContacts);
1811 // add activity target record for every sms that is send
1812 $activityTargetParams = array(
1813 'activity_id' => $activityID,
1814 'contact_id' => $toID,
1815 'record_type_id' => $targetID,
1817 CRM_Activity_BAO_ActivityContact
::create($activityTargetParams);
1823 * Send the message to a specific contact.
1825 * @param string $from
1826 * The name and email of the sender.
1827 * @param int $fromID
1829 * The contact id of the recipient.
1830 * @param string $subject
1831 * The subject of the message.
1832 * @param $text_message
1833 * @param $html_message
1834 * @param string $emailAddress
1835 * Use this 'to' email address instead of the default Primary address.
1836 * @param int $activityID
1837 * The activity ID that tracks the message.
1838 * @param null $attachments
1843 * TRUE if successful else FALSE.
1845 public static function sendMessage(
1854 $attachments = NULL,
1858 list($toDisplayName, $toEmail, $toDoNotEmail) = CRM_Contact_BAO_Contact
::getContactDetails($toID);
1859 if ($emailAddress) {
1860 $toEmail = trim($emailAddress);
1863 // make sure both email addresses are valid
1864 // and that the recipient wants to receive email
1865 if (empty($toEmail) or $toDoNotEmail) {
1868 if (!trim($toDisplayName)) {
1869 $toDisplayName = $toEmail;
1872 $activityContacts = CRM_Core_OptionGroup
::values('activity_contacts', FALSE, FALSE, FALSE, NULL, 'name');
1873 $targetID = CRM_Utils_Array
::key('Activity Targets', $activityContacts);
1875 // create the params array
1876 $mailParams = array(
1877 'groupName' => 'Activity Email Sender',
1879 'toName' => $toDisplayName,
1880 'toEmail' => $toEmail,
1881 'subject' => $subject,
1884 'text' => $text_message,
1885 'html' => $html_message,
1886 'attachments' => $attachments,
1889 if (!CRM_Utils_Mail
::send($mailParams)) {
1893 // add activity target record for every mail that is send
1894 $activityTargetParams = array(
1895 'activity_id' => $activityID,
1896 'contact_id' => $toID,
1897 'record_type_id' => $targetID,
1899 CRM_Activity_BAO_ActivityContact
::create($activityTargetParams);
1904 * Combine all the importable fields from the lower levels object.
1906 * The ordering is important, since currently we do not have a weight
1907 * scheme. Adding weight is super important and should be done in the
1908 * next week or so, before this can be called complete.
1910 * @param bool $status
1913 * array of importable Fields
1915 public static function &importableFields($status = FALSE) {
1916 if (!self
::$_importableFields) {
1917 if (!self
::$_importableFields) {
1918 self
::$_importableFields = array();
1921 $fields = array('' => array('title' => ts('- do not import -')));
1924 $fields = array('' => array('title' => ts('- Activity Fields -')));
1927 $tmpFields = CRM_Activity_DAO_Activity
::import();
1928 $contactFields = CRM_Contact_BAO_Contact
::importableFields('Individual', NULL);
1930 // Using new Dedupe rule.
1931 $ruleParams = array(
1932 'contact_type' => 'Individual',
1933 'used' => 'Unsupervised',
1935 $fieldsArray = CRM_Dedupe_BAO_Rule
::dedupeRuleFields($ruleParams);
1937 $tmpConatctField = array();
1938 if (is_array($fieldsArray)) {
1939 foreach ($fieldsArray as $value) {
1940 $customFieldId = CRM_Core_DAO
::getFieldValue('CRM_Core_DAO_CustomField',
1945 $value = $customFieldId ?
'custom_' . $customFieldId : $value;
1946 $tmpConatctField[trim($value)] = $contactFields[trim($value)];
1947 $tmpConatctField[trim($value)]['title'] = $tmpConatctField[trim($value)]['title'] . " (match to contact)";
1950 $tmpConatctField['external_identifier'] = $contactFields['external_identifier'];
1951 $tmpConatctField['external_identifier']['title'] = $contactFields['external_identifier']['title'] . " (match to contact)";
1952 $fields = array_merge($fields, $tmpConatctField);
1953 $fields = array_merge($fields, $tmpFields);
1954 $fields = array_merge($fields, CRM_Core_BAO_CustomField
::getFieldsForImport('Activity'));
1955 self
::$_importableFields = $fields;
1957 return self
::$_importableFields;
1961 * @deprecated - use the api instead.
1963 * Get the Activities of a target contact.
1965 * @param int $contactId
1966 * Id of the contact whose activities need to find.
1969 * array of activity fields
1971 public static function getContactActivity($contactId) {
1972 // @todo remove this function entirely.
1973 $activities = array();
1974 $activityContacts = CRM_Core_OptionGroup
::values('activity_contacts', FALSE, FALSE, FALSE, NULL, 'name');
1975 $sourceID = CRM_Utils_Array
::key('Activity Source', $activityContacts);
1976 $assigneeID = CRM_Utils_Array
::key('Activity Assignees', $activityContacts);
1977 $targetID = CRM_Utils_Array
::key('Activity Targets', $activityContacts);
1979 // First look for activities where contactId is one of the targets
1981 SELECT activity_id, record_type_id
1982 FROM civicrm_activity_contact
1983 WHERE contact_id = $contactId
1985 $dao = CRM_Core_DAO
::executeQuery($query);
1986 while ($dao->fetch()) {
1987 if ($dao->record_type_id
== $targetID) {
1988 $activities[$dao->activity_id
]['targets'][$contactId] = $contactId;
1990 elseif ($dao->record_type_id
== $assigneeID) {
1991 $activities[$dao->activity_id
]['asignees'][$contactId] = $contactId;
1994 // do source stuff here
1995 $activities[$dao->activity_id
]['source_contact_id'] = $contactId;
1999 $activityIds = array_keys($activities);
2000 if (count($activityIds) < 1) {
2004 $activityIds = implode(',', $activityIds);
2006 SELECT activity.id as activity_id,
2008 subject, location, activity_date_time, details, status_id
2009 FROM civicrm_activity activity
2010 WHERE activity.id IN ($activityIds)";
2012 $dao = CRM_Core_DAO
::executeQuery($query);
2014 $activityTypes = CRM_Core_OptionGroup
::values('activity_type');
2015 $activityStatuses = CRM_Core_OptionGroup
::values('activity_status');
2017 while ($dao->fetch()) {
2018 $activities[$dao->activity_id
]['id'] = $dao->activity_id
;
2019 $activities[$dao->activity_id
]['activity_type_id'] = $dao->activity_type_id
;
2020 $activities[$dao->activity_id
]['subject'] = $dao->subject
;
2021 $activities[$dao->activity_id
]['location'] = $dao->location
;
2022 $activities[$dao->activity_id
]['activity_date_time'] = $dao->activity_date_time
;
2023 $activities[$dao->activity_id
]['details'] = $dao->details
;
2024 $activities[$dao->activity_id
]['status_id'] = $dao->status_id
;
2025 $activities[$dao->activity_id
]['activity_name'] = $activityTypes[$dao->activity_type_id
];
2026 $activities[$dao->activity_id
]['status'] = $activityStatuses[$dao->status_id
];
2028 // set to null if not set
2029 if (!isset($activities[$dao->activity_id
]['source_contact_id'])) {
2030 $activities[$dao->activity_id
]['source_contact_id'] = NULL;
2037 * Add activity for Membership/Event/Contribution.
2039 * @param object $activity
2040 * (reference) particular component object.
2041 * @param string $activityType
2042 * For Membership Signup or Renewal.
2043 * @param int $targetContactID
2044 * @param array $params
2045 * Activity params to override.
2049 public static function addActivity(
2051 $activityType = 'Membership Signup',
2052 $targetContactID = NULL,
2055 $date = date('YmdHis');
2056 if ($activity->__table
== 'civicrm_membership') {
2057 $component = 'Membership';
2059 elseif ($activity->__table
== 'civicrm_participant') {
2060 if ($activityType != 'Email') {
2061 $activityType = 'Event Registration';
2063 $component = 'Event';
2065 elseif ($activity->__table
== 'civicrm_contribution') {
2066 // create activity record only for Completed Contributions
2067 if ($activity->contribution_status_id
!= 1) {
2070 $activityType = $component = 'Contribution';
2072 // retrieve existing activity based on source_record_id and activity_type
2073 if (empty($params['id'])) {
2074 $params['id'] = CRM_Utils_Array
::value('id', civicrm_api3('Activity', 'Get', array(
2075 'source_record_id' => $activity->id
,
2076 'activity_type_id' => $activityType,
2079 if (!empty($params['id'])) {
2080 // CRM-13237 : if activity record found, update it with campaign id of contribution
2081 $params['campaign_id'] = $activity->campaign_id
;
2084 $date = CRM_Utils_Date
::isoToMysql($activity->receive_date
);
2087 $activityParams = array(
2088 'source_contact_id' => $activity->contact_id
,
2089 'source_record_id' => $activity->id
,
2090 'activity_type_id' => CRM_Core_PseudoConstant
::getKey('CRM_Activity_BAO_Activity', 'activity_type_id', $activityType),
2091 'activity_date_time' => $date,
2092 'is_test' => $activity->is_test
,
2093 'status_id' => CRM_Core_PseudoConstant
::getKey('CRM_Activity_BAO_Activity', 'activity_status_id', 'Completed'),
2094 'skipRecentView' => TRUE,
2095 'campaign_id' => $activity->campaign_id
,
2097 $activityParams = array_merge($activityParams, $params);
2099 if (empty($activityParams['subject'])) {
2100 $activityParams['subject'] = self
::getActivitySubject($activity);
2103 if (!empty($activity->activity_id
)) {
2104 $activityParams['id'] = $activity->activity_id
;
2106 // create activity with target contacts
2107 $id = CRM_Core_Session
::getLoggedInContactID();
2109 $activityParams['source_contact_id'] = $id;
2110 $activityParams['target_contact_id'][] = $activity->contact_id
;
2114 if (property_exists($activity, 'details')) {
2115 $activityParams['details'] = $activity->details
;
2118 if ($targetContactID) {
2119 $activityParams['target_contact_id'][] = $targetContactID;
2121 // @todo - use api - remove lots of wrangling above. Remove deprecated fatal & let form layer
2122 // deal with any exceptions.
2123 if (is_a(self
::create($activityParams), 'CRM_Core_Error')) {
2124 CRM_Core_Error
::fatal("Failed creating Activity for $component of id {$activity->id}");
2130 * Get activity subject on basis of component object.
2132 * @param object $entityObj
2133 * particular component object.
2137 public static function getActivitySubject($entityObj) {
2138 switch ($entityObj->__table
) {
2139 case 'civicrm_membership':
2140 $membershipType = CRM_Member_PseudoConstant
::membershipType($entityObj->membership_type_id
);
2141 $subject = $membershipType ?
$membershipType : ts('Membership');
2143 if (is_array($subject)) {
2144 $subject = implode(", ", $subject);
2147 if (!CRM_Utils_System
::isNull($entityObj->source
)) {
2148 $subject .= " - {$entityObj->source}";
2151 if ($entityObj->owner_membership_id
) {
2152 list($displayName) = CRM_Contact_BAO_Contact
::getDisplayAndImage(CRM_Core_DAO
::getFieldValue('CRM_Member_DAO_Membership', $entityObj->owner_membership_id
, 'contact_id'));
2153 $subject .= sprintf(' (by %s)', $displayName);
2156 $subject .= " - Status: " . CRM_Core_DAO
::getFieldValue('CRM_Member_DAO_MembershipStatus', $entityObj->status_id
, 'label');
2159 case 'civicrm_participant':
2160 $event = CRM_Event_BAO_Event
::getEvents(1, $entityObj->event_id
, TRUE, FALSE);
2161 $roles = CRM_Event_PseudoConstant
::participantRole();
2162 $status = CRM_Event_PseudoConstant
::participantStatus();
2163 $subject = $event[$entityObj->event_id
];
2165 if (!empty($roles[$entityObj->role_id
])) {
2166 $subject .= ' - ' . $roles[$entityObj->role_id
];
2168 if (!empty($status[$entityObj->status_id
])) {
2169 $subject .= ' - ' . $status[$entityObj->status_id
];
2174 case 'civicrm_contribution':
2175 $subject = CRM_Utils_Money
::format($entityObj->total_amount
, $entityObj->currency
);
2176 if (!CRM_Utils_System
::isNull($entityObj->source
)) {
2177 $subject .= " - {$entityObj->source}";
2185 * Get Parent activity for currently viewed activity.
2187 * @param int $activityId
2188 * Current activity id.
2191 * Id of parent activity otherwise false.
2193 public static function getParentActivity($activityId) {
2194 static $parentActivities = array();
2196 $activityId = CRM_Utils_Type
::escape($activityId, 'Integer');
2198 if (!array_key_exists($activityId, $parentActivities)) {
2199 $parentActivities[$activityId] = array();
2201 $parentId = CRM_Core_DAO
::getFieldValue('CRM_Activity_DAO_Activity',
2206 $parentActivities[$activityId] = $parentId ?
$parentId : FALSE;
2209 return $parentActivities[$activityId];
2213 * Get total count of prior revision of currently viewed activity.
2215 * @param $activityID
2216 * Current activity id.
2219 * $params count of prior activities otherwise false.
2221 public static function getPriorCount($activityID) {
2222 static $priorCounts = array();
2224 $activityID = CRM_Utils_Type
::escape($activityID, 'Integer');
2226 if (!array_key_exists($activityID, $priorCounts)) {
2227 $priorCounts[$activityID] = array();
2228 $originalID = CRM_Core_DAO
::getFieldValue('CRM_Activity_DAO_Activity',
2235 SELECT count( id ) AS cnt
2236 FROM civicrm_activity
2237 WHERE ( id = {$originalID} OR original_id = {$originalID} )
2238 AND is_current_revision = 0
2239 AND id < {$activityID}
2241 $params = array(1 => array($originalID, 'Integer'));
2242 $count = CRM_Core_DAO
::singleValueQuery($query, $params);
2244 $priorCounts[$activityID] = $count ?
$count : 0;
2247 return $priorCounts[$activityID];
2251 * Get all prior activities of currently viewed activity.
2253 * @param $activityID
2254 * Current activity id.
2255 * @param bool $onlyPriorRevisions
2258 * prior activities info.
2260 public static function getPriorAcitivities($activityID, $onlyPriorRevisions = FALSE) {
2261 static $priorActivities = array();
2263 $activityID = CRM_Utils_Type
::escape($activityID, 'Integer');
2264 $index = $activityID . '_' . (int) $onlyPriorRevisions;
2266 if (!array_key_exists($index, $priorActivities)) {
2267 $priorActivities[$index] = array();
2269 $originalID = CRM_Core_DAO
::getFieldValue('CRM_Activity_DAO_Activity',
2274 $originalID = $activityID;
2278 SELECT c.display_name as name, cl.modified_date as date, ca.id as activityID
2279 FROM civicrm_log cl, civicrm_contact c, civicrm_activity ca
2280 WHERE (ca.id = %1 OR ca.original_id = %1)
2281 AND cl.entity_table = 'civicrm_activity'
2282 AND cl.entity_id = ca.id
2283 AND cl.modified_id = c.id
2285 if ($onlyPriorRevisions) {
2286 $query .= " AND ca.id < {$activityID}";
2288 $query .= " ORDER BY ca.id DESC";
2290 $params = array(1 => array($originalID, 'Integer'));
2291 $dao = CRM_Core_DAO
::executeQuery($query, $params);
2293 while ($dao->fetch()) {
2294 $priorActivities[$index][$dao->activityID
]['id'] = $dao->activityID
;
2295 $priorActivities[$index][$dao->activityID
]['name'] = $dao->name
;
2296 $priorActivities[$index][$dao->activityID
]['date'] = $dao->date
;
2301 return $priorActivities[$index];
2305 * Find the latest revision of a given activity.
2307 * @param int $activityID
2308 * Prior activity id.
2311 * current activity id.
2313 public static function getLatestActivityId($activityID) {
2314 static $latestActivityIds = array();
2316 $activityID = CRM_Utils_Type
::escape($activityID, 'Integer');
2318 if (!array_key_exists($activityID, $latestActivityIds)) {
2319 $latestActivityIds[$activityID] = array();
2321 $originalID = CRM_Core_DAO
::getFieldValue('CRM_Activity_DAO_Activity',
2326 $activityID = $originalID;
2328 $params = array(1 => array($activityID, 'Integer'));
2329 $query = "SELECT id from civicrm_activity where original_id = %1 and is_current_revision = 1";
2331 $latestActivityIds[$activityID] = CRM_Core_DAO
::singleValueQuery($query, $params);
2334 return $latestActivityIds[$activityID];
2338 * Create a follow up a given activity.
2340 * @param int $activityId
2341 * activity id of parent activity.
2342 * @param array $params
2344 * @return CRM_Activity_BAO_Activity|null|object
2346 public static function createFollowupActivity($activityId, $params) {
2351 $followupParams = array();
2352 $followupParams['parent_id'] = $activityId;
2353 $followupParams['source_contact_id'] = CRM_Core_Session
::getLoggedInContactID();
2354 $followupParams['status_id'] = CRM_Core_OptionGroup
::getValue('activity_status', 'Scheduled', 'name');
2356 $followupParams['activity_type_id'] = $params['followup_activity_type_id'];
2357 // Get Subject of Follow-up Activiity, CRM-4491
2358 $followupParams['subject'] = CRM_Utils_Array
::value('followup_activity_subject', $params);
2359 $followupParams['assignee_contact_id'] = CRM_Utils_Array
::value('followup_assignee_contact_id', $params);
2361 // Create target contact for followup.
2362 if (!empty($params['target_contact_id'])) {
2363 $followupParams['target_contact_id'] = $params['target_contact_id'];
2366 $followupParams['activity_date_time'] = CRM_Utils_Date
::processDate($params['followup_date'],
2367 $params['followup_date_time']
2369 $followupActivity = self
::create($followupParams);
2371 return $followupActivity;
2375 * Get Activity specific File according activity type Id.
2377 * @param int $activityTypeId
2379 * @param string $crmDir
2381 * @return string|bool
2382 * if file exists returns $activityTypeFile activity filename otherwise false.
2384 public static function getFileForActivityTypeId($activityTypeId, $crmDir = 'Activity') {
2385 $activityTypes = CRM_Case_PseudoConstant
::caseActivityType(FALSE, TRUE);
2387 if ($activityTypes[$activityTypeId]['name']) {
2388 $activityTypeFile = CRM_Utils_String
::munge(ucwords($activityTypes[$activityTypeId]['name']), '', 0);
2394 global $civicrm_root;
2395 $config = CRM_Core_Config
::singleton();
2396 if (!file_exists(rtrim($civicrm_root, '/') . "/CRM/{$crmDir}/Form/Activity/{$activityTypeFile}.php")) {
2397 if (empty($config->customPHPPathDir
)) {
2400 elseif (!file_exists(rtrim($config->customPHPPathDir
, '/') . "/CRM/{$crmDir}/Form/Activity/{$activityTypeFile}.php")) {
2405 return $activityTypeFile;
2409 * Restore the activity.
2411 * @param array $params
2413 * @return CRM_Activity_DAO_Activity
2415 public static function restoreActivity(&$params) {
2416 $activity = new CRM_Activity_DAO_Activity();
2417 $activity->copyValues($params);
2419 $activity->is_deleted
= 0;
2420 $result = $activity->save();
2426 * Get the exportable fields for Activities.
2428 * @param string $name
2429 * If it is called by case $name = Case else $name = Activity.
2432 * array of exportable Fields
2434 public static function &exportableFields($name = 'Activity') {
2435 if (!isset(self
::$_exportableFields[$name])) {
2436 self
::$_exportableFields[$name] = array();
2438 // TODO: ideally we should retrieve all fields from xml, in this case since activity processing is done
2439 // my case hence we have defined fields as case_*
2440 if ($name == 'Activity') {
2441 $exportableFields = CRM_Activity_DAO_Activity
::export();
2442 $exportableFields['source_contact_id']['title'] = ts('Source Contact ID');
2443 $exportableFields['source_contact'] = array(
2444 'title' => ts('Source Contact'),
2445 'type' => CRM_Utils_Type
::T_STRING
,
2448 $Activityfields = array(
2449 'activity_type' => array(
2450 'title' => ts('Activity Type'),
2451 'name' => 'activity_type',
2452 'type' => CRM_Utils_Type
::T_STRING
,
2453 'searchByLabel' => TRUE,
2455 'activity_status' => array(
2456 'title' => ts('Activity Status'),
2457 'name' => 'activity_status',
2458 'type' => CRM_Utils_Type
::T_STRING
,
2459 'searchByLabel' => TRUE,
2461 'activity_priority' => array(
2462 'title' => ts('Activity Priority'),
2463 'name' => 'activity_priority',
2464 'type' => CRM_Utils_Type
::T_STRING
,
2465 'searchByLabel' => TRUE,
2468 $fields = array_merge($Activityfields, $exportableFields);
2471 // Set title to activity fields.
2473 'case_activity_subject' => array('title' => ts('Activity Subject'), 'type' => CRM_Utils_Type
::T_STRING
),
2474 'case_source_contact_id' => array('title' => ts('Activity Reporter'), 'type' => CRM_Utils_Type
::T_STRING
),
2475 'case_recent_activity_date' => array('title' => ts('Activity Actual Date'), 'type' => CRM_Utils_Type
::T_DATE
),
2476 'case_scheduled_activity_date' => array(
2477 'title' => ts('Activity Scheduled Date'),
2478 'type' => CRM_Utils_Type
::T_DATE
,
2480 'case_recent_activity_type' => array('title' => ts('Activity Type'), 'type' => CRM_Utils_Type
::T_STRING
),
2481 'case_activity_status' => array('title' => ts('Activity Status'), 'type' => CRM_Utils_Type
::T_STRING
),
2482 'case_activity_duration' => array('title' => ts('Activity Duration'), 'type' => CRM_Utils_Type
::T_INT
),
2483 'case_activity_medium_id' => array('title' => ts('Activity Medium'), 'type' => CRM_Utils_Type
::T_INT
),
2484 'case_activity_details' => array('title' => ts('Activity Details'), 'type' => CRM_Utils_Type
::T_TEXT
),
2485 'case_activity_is_auto' => array(
2486 'title' => ts('Activity Auto-generated?'),
2487 'type' => CRM_Utils_Type
::T_BOOLEAN
,
2492 // add custom data for case activities
2493 $fields = array_merge($fields, CRM_Core_BAO_CustomField
::getFieldsForImport('Activity'));
2495 self
::$_exportableFields[$name] = $fields;
2497 return self
::$_exportableFields[$name];
2501 * Get the allowed profile fields for Activities.
2504 * array of activity profile Fields
2506 public static function getProfileFields() {
2507 $exportableFields = self
::exportableFields('Activity');
2508 $skipFields = array(
2511 'source_contact_id',
2513 'activity_campaign',
2515 'is_current_revision',
2516 'activity_is_deleted',
2518 $config = CRM_Core_Config
::singleton();
2519 if (!in_array('CiviCampaign', $config->enableComponents
)) {
2520 $skipFields[] = 'activity_engagement_level';
2523 foreach ($skipFields as $field) {
2524 if (isset($exportableFields[$field])) {
2525 unset($exportableFields[$field]);
2529 // hack to use 'activity_type_id' instead of 'activity_type'
2530 $exportableFields['activity_status_id'] = $exportableFields['activity_status'];
2531 unset($exportableFields['activity_status']);
2533 return $exportableFields;
2537 * This function deletes the activity record related to contact record.
2539 * This is conditional on there being no target and assignee record
2540 * with other contacts.
2542 * @param int $contactId
2547 public static function cleanupActivity($contactId) {
2552 $activityContacts = CRM_Core_OptionGroup
::values('activity_contacts', FALSE, FALSE, FALSE, NULL, 'name');
2553 $sourceID = CRM_Utils_Array
::key('Activity Source', $activityContacts);
2555 $transaction = new CRM_Core_Transaction();
2557 // delete activity if there is no record in civicrm_activity_contact
2558 // pointing to any other contact record
2559 $activityContact = new CRM_Activity_DAO_ActivityContact();
2560 $activityContact->contact_id
= $contactId;
2561 $activityContact->record_type_id
= $sourceID;
2562 $activityContact->find();
2564 while ($activityContact->fetch()) {
2565 // delete activity_contact record for the deleted contact
2566 $activityContact->delete();
2568 $activityContactOther = new CRM_Activity_DAO_ActivityContact();
2569 $activityContactOther->activity_id
= $activityContact->activity_id
;
2571 // delete activity only if no other contacts connected
2572 if (!$activityContactOther->find(TRUE)) {
2573 $activityParams = array('id' => $activityContact->activity_id
);
2574 $result = self
::deleteActivity($activityParams);
2577 $activityContactOther->free();
2580 $activityContact->free();
2581 $transaction->commit();
2587 * Does user has sufficient permission for view/edit activity record.
2589 * @param int $activityId
2590 * Activity record id.
2591 * @param int $action
2596 public static function checkPermission($activityId, $action) {
2599 !in_array($action, array(CRM_Core_Action
::UPDATE
, CRM_Core_Action
::VIEW
))
2604 $activity = new CRM_Activity_DAO_Activity();
2605 $activity->id
= $activityId;
2606 if (!$activity->find(TRUE)) {
2610 // Component related permissions.
2611 $compPermissions = array(
2612 'CiviCase' => array(
2613 'administer CiviCase',
2614 'access my cases and activities',
2615 'access all cases and activities',
2617 'CiviMail' => array('access CiviMail'),
2618 'CiviEvent' => array('access CiviEvent'),
2619 'CiviGrant' => array('access CiviGrant'),
2620 'CiviPledge' => array('access CiviPledge'),
2621 'CiviMember' => array('access CiviMember'),
2622 'CiviReport' => array('access CiviReport'),
2623 'CiviContribute' => array('access CiviContribute'),
2624 'CiviCampaign' => array('administer CiviCampaign'),
2627 // Return early when it is case activity.
2628 $isCaseActivity = CRM_Case_BAO_Case
::isCaseActivity($activityId);
2629 // Check for civicase related permission.
2630 if ($isCaseActivity) {
2632 foreach ($compPermissions['CiviCase'] as $per) {
2633 if (CRM_Core_Permission
::check($per)) {
2639 // Check for case specific permissions.
2642 if ($action == CRM_Core_Action
::UPDATE
) {
2645 $allow = CRM_Case_BAO_Case
::checkPermission($activityId,
2647 $activity->activity_type_id
2654 // First check the component permission.
2657 FROM civicrm_option_value val
2658 INNER JOIN civicrm_option_group grp ON ( grp.id = val.option_group_id AND grp.name = %1 )
2659 WHERE val.value = %2";
2661 1 => array('activity_type', 'String'),
2662 2 => array($activity->activity_type_id
, 'Integer'),
2664 $componentId = CRM_Core_DAO
::singleValueQuery($sql, $params);
2667 $componentName = CRM_Core_Component
::getComponentName($componentId);
2668 $compPermission = CRM_Utils_Array
::value($componentName, $compPermissions);
2670 // Here we are interesting in any single permission.
2671 if (is_array($compPermission)) {
2672 foreach ($compPermission as $per) {
2673 if (CRM_Core_Permission
::check($per)) {
2681 // Check for this permission related to contact.
2682 $permission = CRM_Core_Permission
::VIEW
;
2683 if ($action == CRM_Core_Action
::UPDATE
) {
2684 $permission = CRM_Core_Permission
::EDIT
;
2687 $activityContacts = CRM_Core_OptionGroup
::values('activity_contacts', FALSE, FALSE, FALSE, NULL, 'name');
2688 $sourceID = CRM_Utils_Array
::key('Activity Source', $activityContacts);
2689 $assigneeID = CRM_Utils_Array
::key('Activity Assignees', $activityContacts);
2690 $targetID = CRM_Utils_Array
::key('Activity Targets', $activityContacts);
2692 // Check for source contact.
2693 if (!$componentId ||
$allow) {
2694 $sourceContactId = self
::getActivityContact($activity->id
, $sourceID);
2695 // Account for possibility of activity not having a source contact (as it may have been deleted).
2696 $allow = $sourceContactId ? CRM_Contact_BAO_Contact_Permission
::allow($sourceContactId, $permission) : TRUE;
2699 // Check for target and assignee contacts.
2701 // First check for supper permission.
2702 $supPermission = 'view all contacts';
2703 if ($action == CRM_Core_Action
::UPDATE
) {
2704 $supPermission = 'edit all contacts';
2706 $allow = CRM_Core_Permission
::check($supPermission);
2708 // User might have sufficient permission, through acls.
2711 // Get the target contacts.
2712 $targetContacts = CRM_Activity_BAO_ActivityContact
::retrieveContactIdsByActivityId($activity->id
, $targetID);
2713 foreach ($targetContacts as $cnt => $contactId) {
2714 if (!CRM_Contact_BAO_Contact_Permission
::allow($contactId, $permission)) {
2720 // Get the assignee contacts.
2722 $assigneeContacts = CRM_Activity_BAO_ActivityContact
::retrieveContactIdsByActivityId($activity->id
, $assigneeID);
2723 foreach ($assigneeContacts as $cnt => $contactId) {
2724 if (!CRM_Contact_BAO_Contact_Permission
::allow($contactId, $permission)) {
2737 * Wrapper for ajax activity selector.
2739 * @param array $params
2740 * Associated array for params record id.
2743 * Associated array of contact activities
2745 public static function getContactActivitySelector(&$params) {
2746 // Format the params.
2747 $params['offset'] = ($params['page'] - 1) * $params['rp'];
2748 $params['rowCount'] = $params['rp'];
2749 $params['sort'] = CRM_Utils_Array
::value('sortBy', $params);
2750 $params['caseId'] = NULL;
2751 $context = CRM_Utils_Array
::value('context', $params);
2752 $showContactOverlay = !CRM_Utils_String
::startsWith($context, "dashlet");
2753 $activityTypeInfo = civicrm_api3('OptionValue', 'get', array(
2754 'option_group_id' => "activity_type",
2755 'options' => array('limit' => 0),
2757 $activityIcons = array();
2758 foreach ($activityTypeInfo['values'] as $type) {
2759 if (!empty($type['icon'])) {
2760 $activityIcons[$type['value']] = $type['icon'];
2764 // Get contact activities.
2765 $activities = CRM_Activity_BAO_Activity
::deprecatedGetActivities($params);
2768 $params['total'] = CRM_Activity_BAO_Activity
::deprecatedGetActivitiesCount($params);
2770 // Format params and add links.
2771 $contactActivities = array();
2773 if (!empty($activities)) {
2774 $activityStatus = CRM_Core_PseudoConstant
::activityStatus();
2776 // Check logged in user for permission.
2777 $page = new CRM_Core_Page();
2778 CRM_Contact_Page_View
::checkUserPermission($page, $params['contact_id']);
2779 $permissions = array($page->_permission
);
2780 if (CRM_Core_Permission
::check('delete activities')) {
2781 $permissions[] = CRM_Core_Permission
::DELETE
;
2784 $mask = CRM_Core_Action
::mask($permissions);
2786 foreach ($activities as $activityId => $values) {
2787 $activity = array();
2788 $activity['DT_RowId'] = $activityId;
2789 // Add class to this row if overdue.
2790 $activity['DT_RowClass'] = "crm-entity status-id-{$values['status_id']}";
2791 if (CRM_Utils_Date
::overdue(CRM_Utils_Array
::value('activity_date_time', $values))
2792 && CRM_Utils_Array
::value('status_id', $values) == 1
2794 $activity['DT_RowClass'] .= ' status-overdue';
2797 $activity['DT_RowClass'] .= ' status-ontime';
2800 $activity['DT_RowAttr'] = array();
2801 $activity['DT_RowAttr']['data-entity'] = 'activity';
2802 $activity['DT_RowAttr']['data-id'] = $activityId;
2804 $activity['activity_type'] = (!empty($activityIcons[$values['activity_type_id']]) ?
'<span class="crm-i ' . $activityIcons[$values['activity_type_id']] . '"></span> ' : '') . $values['activity_type'];
2805 $activity['subject'] = $values['subject'];
2807 $activity['source_contact_name'] = '';
2808 if ($params['contact_id'] == $values['source_contact_id']) {
2809 $activity['source_contact_name'] = $values['source_contact_name'];
2811 elseif ($values['source_contact_id']) {
2813 if ($showContactOverlay) {
2814 $srcTypeImage = CRM_Contact_BAO_Contact_Utils
::getImage(
2815 CRM_Contact_BAO_Contact
::getContactType($values['source_contact_id']),
2817 $values['source_contact_id']);
2819 $activity['source_contact_name'] = $srcTypeImage . CRM_Utils_System
::href($values['source_contact_name'],
2820 'civicrm/contact/view', "reset=1&cid={$values['source_contact_id']}");
2823 $activity['source_contact_name'] = '<em>n/a</em>';
2826 $activity['target_contact_name'] = '';
2827 if (isset($values['mailingId']) && !empty($values['mailingId'])) {
2828 $activity['target_contact'] = CRM_Utils_System
::href($values['recipients'],
2829 'civicrm/mailing/report/event',
2830 "mid={$values['source_record_id']}&reset=1&event=queue&cid={$params['contact_id']}&context=activitySelector");
2832 elseif (!empty($values['recipients'])) {
2833 $activity['target_contact_name'] = $values['recipients'];
2835 elseif (isset($values['target_contact_counter']) && $values['target_contact_counter']) {
2836 $activity['target_contact_name'] = '';
2837 foreach ($values['target_contact_name'] as $tcID => $tcName) {
2838 $targetTypeImage = "";
2839 $targetLink = CRM_Utils_System
::href($tcName, 'civicrm/contact/view', "reset=1&cid={$tcID}");
2840 if ($showContactOverlay) {
2841 $targetTypeImage = CRM_Contact_BAO_Contact_Utils
::getImage(
2842 CRM_Contact_BAO_Contact
::getContactType($tcID),
2845 $activity['target_contact_name'] .= "<div>$targetTypeImage $targetLink";
2848 $activity['target_contact_name'] .= $targetLink;
2852 if ($extraCount = $values['target_contact_counter'] - 1) {
2853 $activity['target_contact_name'] .= ";<br />" . "(" . ts('%1 more', array(1 => $extraCount)) . ")";
2855 if ($showContactOverlay) {
2856 $activity['target_contact_name'] .= "</div> ";
2859 elseif (!$values['target_contact_name']) {
2860 $activity['target_contact_name'] = '<em>n/a</em>';
2863 $activity['assignee_contact_name'] = '';
2864 if (empty($values['assignee_contact_name'])) {
2865 $activity['assignee_contact_name'] = '<em>n/a</em>';
2867 elseif (!empty($values['assignee_contact_name'])) {
2869 $activity['assignee_contact_name'] = '';
2870 foreach ($values['assignee_contact_name'] as $acID => $acName) {
2871 if ($acID && $count < 5) {
2872 $assigneeTypeImage = "";
2873 $assigneeLink = CRM_Utils_System
::href($acName, 'civicrm/contact/view', "reset=1&cid={$acID}");
2874 if ($showContactOverlay) {
2875 $assigneeTypeImage = CRM_Contact_BAO_Contact_Utils
::getImage(
2876 CRM_Contact_BAO_Contact
::getContactType($acID),
2879 $activity['assignee_contact_name'] .= "<div>$assigneeTypeImage $assigneeLink";
2882 $activity['assignee_contact_name'] .= $assigneeLink;
2887 $activity['assignee_contact_name'] .= "; ";
2889 if ($showContactOverlay) {
2890 $activity['assignee_contact_name'] .= "</div> ";
2894 $activity['assignee_contact_name'] .= "(" . ts('more') . ")";
2901 $activity['activity_date_time'] = CRM_Utils_Date
::customFormat($values['activity_date_time']);
2902 $activity['status_id'] = $activityStatus[$values['status_id']];
2905 $activity['links'] = '';
2906 $accessMailingReport = FALSE;
2907 if (!empty($values['mailingId'])) {
2908 $accessMailingReport = TRUE;
2911 $actionLinks = CRM_Activity_Selector_Activity
::actionLinks(
2912 CRM_Utils_Array
::value('activity_type_id', $values),
2913 CRM_Utils_Array
::value('source_record_id', $values),
2914 $accessMailingReport,
2915 CRM_Utils_Array
::value('activity_id', $values)
2918 $actionMask = array_sum(array_keys($actionLinks)) & $mask;
2920 $activity['links'] = CRM_Core_Action
::formLink($actionLinks,
2923 'id' => $values['activity_id'],
2924 'cid' => $params['contact_id'],
2926 'caseid' => CRM_Utils_Array
::value('case_id', $values),
2932 $values['activity_id']
2935 if ($values['is_recurring_activity']) {
2936 $activity['is_recurring_activity'] = CRM_Core_BAO_RecurringEntity
::getPositionAndCount($values['activity_id'], 'civicrm_activity');
2939 array_push($contactActivities, $activity);
2943 $activitiesDT = array();
2944 $activitiesDT['data'] = $contactActivities;
2945 $activitiesDT['recordsTotal'] = $params['total'];
2946 $activitiesDT['recordsFiltered'] = $params['total'];
2948 return $activitiesDT;
2952 * Copy custom fields and attachments from an existing activity to another.
2954 * @see CRM_Case_Page_AJAX::_convertToCaseActivity()
2956 * @param array $params
2958 public static function copyExtendedActivityData($params) {
2959 // attach custom data to the new activity
2960 $customParams = $htmlType = array();
2961 $customValues = CRM_Core_BAO_CustomValueTable
::getEntityValues($params['activityID'], 'Activity');
2963 if (!empty($customValues)) {
2964 $fieldIds = implode(', ', array_keys($customValues));
2965 $sql = "SELECT id FROM civicrm_custom_field WHERE html_type = 'File' AND id IN ( {$fieldIds} )";
2966 $result = CRM_Core_DAO
::executeQuery($sql);
2968 while ($result->fetch()) {
2969 $htmlType[] = $result->id
;
2972 foreach ($customValues as $key => $value) {
2973 if ($value !== NULL) {
2975 if (in_array($key, $htmlType)) {
2976 $fileValues = CRM_Core_BAO_File
::path($value, $params['activityID']);
2977 $customParams["custom_{$key}_-1"] = array(
2978 'name' => $fileValues[0],
2979 'path' => $fileValues[1],
2983 $customParams["custom_{$key}_-1"] = $value;
2987 CRM_Core_BAO_CustomValueTable
::postProcess($customParams, 'civicrm_activity',
2988 $params['mainActivityId'], 'Activity'
2992 // copy activity attachments ( if any )
2993 CRM_Core_BAO_File
::copyEntityFile('civicrm_activity', $params['activityID'], 'civicrm_activity', $params['mainActivityId']);
2997 * Get activity contact.
2999 * @param int $activityId
3000 * @param int $recordTypeID
3001 * @param string $column
3005 public static function getActivityContact($activityId, $recordTypeID = NULL, $column = 'contact_id') {
3006 $activityContact = new CRM_Activity_BAO_ActivityContact();
3007 $activityContact->activity_id
= $activityId;
3008 if ($recordTypeID) {
3009 $activityContact->record_type_id
= $recordTypeID;
3011 if ($activityContact->find(TRUE)) {
3012 return $activityContact->$column;
3018 * Get source contact id.
3020 * @param int $activityId
3024 public static function getSourceContactID($activityId) {
3025 static $sourceID = NULL;
3027 $activityContacts = CRM_Core_OptionGroup
::values('activity_contacts', FALSE, FALSE, FALSE, NULL, 'name');
3028 $sourceID = CRM_Utils_Array
::key('Activity Source', $activityContacts);
3031 return self
::getActivityContact($activityId, $sourceID);
3037 * @todo Document what this is for.
3039 * @param array $params
3041 public function setApiFilter(&$params) {
3042 if (!empty($params['target_contact_id'])) {
3044 $activityContacts = CRM_Core_OptionGroup
::values('activity_contacts', FALSE, FALSE, FALSE, NULL, 'name');
3045 $targetID = CRM_Utils_Array
::key('Activity Targets', $activityContacts);
3046 $obj = new CRM_Activity_BAO_ActivityContact();
3047 $params['return.target_contact_id'] = 1;
3048 $this->joinAdd($obj, 'LEFT');
3049 $this->selectAdd('civicrm_activity.*');
3050 $this->whereAdd(" civicrm_activity_contact.contact_id = {$params['target_contact_id']} AND civicrm_activity_contact.record_type_id = {$targetID}");
3055 * Send activity as attachment.
3057 * @param object $activity
3058 * @param array $mailToContacts
3059 * @param array $params
3063 public static function sendToAssignee($activity, $mailToContacts, $params = array()) {
3064 if (!CRM_Utils_Array
::crmIsEmptyArray($mailToContacts)) {
3065 $clientID = CRM_Utils_Array
::value('client_id', $params);
3066 $caseID = CRM_Utils_Array
::value('case_id', $params);
3068 $ics = new CRM_Activity_BAO_ICalendar($activity);
3069 $attachments = CRM_Core_BAO_File
::getEntityFile('civicrm_activity', $activity->id
);
3070 $ics->addAttachment($attachments, $mailToContacts);
3072 $result = CRM_Case_BAO_Case
::sendActivityCopy($clientID, $activity->id
, $mailToContacts, $attachments, $caseID);