3 +--------------------------------------------------------------------+
4 | CiviCRM version 4.5 |
5 +--------------------------------------------------------------------+
6 | Copyright CiviCRM LLC (c) 2004-2014 |
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-2014
37 * This class is for activity functions
40 class CRM_Activity_BAO_Activity
extends CRM_Activity_DAO_Activity
{
43 * static field for all the activity information that we can potentially export
48 static $_exportableFields = NULL;
51 * static field for all the activity information that we can potentially import
56 static $_importableFields = NULL;
59 * Check if there is absolute minimum of data to add the object
61 * @param array $params (reference ) an assoc array of name/value pairs
66 public static function dataExists(&$params) {
67 if (!empty($params['source_contact_id']) ||
!empty($params['id'])) {
74 * Fetch object based on array of properties
76 * @param array $params (reference ) an assoc array of name/value pairs
77 * @param array $defaults (reference ) an assoc array to hold the flattened values
79 * @return CRM_Core_BAO_Meeting object
82 public static function retrieve(&$params, &$defaults) {
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 // TODO: with multiple values for assignees and targets, but
94 // TODO: 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_OptionGroup
::getValue('activity_type', 'Bulk Email', 'name')) {
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 associated array
146 * @param bool $moveToTrash
151 public static function deleteActivity(&$params, $moveToTrash = FALSE) {
153 if (!empty($params['id']) && !is_array($params['id'])) {
154 CRM_Utils_Hook
::pre('delete', 'Activity', $params['id'], $params);
157 CRM_Utils_Hook
::pre('delete', 'Activity', NULL, $params);
160 $transaction = new CRM_Core_Transaction();
161 if (is_array(CRM_Utils_Array
::value('source_record_id', $params))) {
162 $sourceRecordIds = implode(',', $params['source_record_id']);
165 $sourceRecordIds = CRM_Utils_Array
::value('source_record_id', $params);
170 if (!isset($params['id'])) {
171 if (is_array($params['activity_type_id'])) {
172 $activityTypes = implode(',', $params['activity_type_id']);
175 $activityTypes = $params['activity_type_id'];
178 $query = "DELETE FROM civicrm_activity WHERE source_record_id IN ({$sourceRecordIds}) AND activity_type_id IN ( {$activityTypes} )";
179 $dao = CRM_Core_DAO
::executeQuery($query);
182 $activity = new CRM_Activity_DAO_Activity();
183 $activity->copyValues($params);
184 $result = $activity->delete();
187 $activity->case_id
= CRM_Case_BAO_Case
::getCaseIdByActivityId($activity->id
);
189 // CRM-13994 delete activity entity_tag
190 $query = "DELETE FROM civicrm_entity_tag WHERE entity_table = 'civicrm_activity' AND entity_id = {$activity->id}";
191 $dao = CRM_Core_DAO
::executeQuery($query);
195 $activity = new CRM_Activity_DAO_Activity();
196 $activity->copyValues($params);
198 $activity->is_deleted
= 1;
199 $result = $activity->save();
201 // CRM-4525 log activity delete
202 $logMsg = 'Case Activity deleted for';
205 $activityContacts = CRM_Core_OptionGroup
::values('activity_contacts', FALSE, FALSE, FALSE, NULL, 'name');
206 $sourceID = CRM_Utils_Array
::key('Activity Source', $activityContacts);
207 $assigneeID = CRM_Utils_Array
::key('Activity Assignees', $activityContacts);
208 $targetID = CRM_Utils_Array
::key('Activity Targets', $activityContacts);
209 $sourceContactId = self
::getActivityContact($activity->id
, $sourceID);
210 if ($sourceContactId) {
211 $msgs[] = " source={$sourceContactId}";
214 //get target contacts.
215 $targetContactIds = CRM_Activity_BAO_ActivityContact
::getNames($activity->id
, $targetID);
216 if (!empty($targetContactIds)) {
217 $msgs[] = " target =" . implode(',', array_keys($targetContactIds));
219 //get assignee contacts.
220 $assigneeContactIds = CRM_Activity_BAO_ActivityContact
::getNames($activity->id
, $assigneeID);
221 if (!empty($assigneeContactIds)) {
222 $msgs[] = " assignee =" . implode(',', array_keys($assigneeContactIds));
225 $logMsg .= implode(', ', $msgs);
227 self
::logActivityAction($activity, $logMsg);
230 // delete the recently created Activity
232 $activityRecent = array(
233 'id' => $activity->id
,
234 'type' => 'Activity',
236 CRM_Utils_Recent
::del($activityRecent);
239 $transaction->commit();
240 if (isset($activity)) {
242 $activity->case_id
= CRM_Case_BAO_Case
::getCaseIdByActivityId($activity->id
);
243 CRM_Utils_Hook
::post('delete', 'Activity', $activity->id
, $activity);
250 * Delete activity assignment record
252 * @param int $activityId
253 * @param null $recordTypeID
258 public static function deleteActivityContact($activityId, $recordTypeID = NULL) {
259 $activityContact = new CRM_Activity_BAO_ActivityContact();
260 $activityContact->activity_id
= $activityId;
262 $activityContact->record_type_id
= $recordTypeID;
264 $activityContact->delete();
268 * process the activities
270 * @param array $params associated array of the submitted values
272 * @throws CRM_Core_Exception
275 * @return $this|null|object
277 public static function create(&$params) {
278 // check required params
279 if (!self
::dataExists($params)) {
280 throw new CRM_Core_Exception('Not enough data to create activity object');
283 $activity = new CRM_Activity_DAO_Activity();
285 if (isset($params['id']) && empty($params['id'])) {
286 unset($params['id']);
289 if (empty($params['status_id']) && empty($params['activity_status_id']) && empty($params['id'])) {
290 if (isset($params['activity_date_time']) &&
291 strcmp($params['activity_date_time'], CRM_Utils_Date
::processDate(date('Ymd')) == -1)
293 $params['status_id'] = 2;
296 $params['status_id'] = 1;
300 //set priority to Normal for Auto-populated activities (for Cases)
301 if (CRM_Utils_Array
::value('priority_id', $params) === NULL &&
302 // if not set and not 0
303 !CRM_Utils_Array
::value('id', $params)
305 $priority = CRM_Core_PseudoConstant
::get('CRM_Activity_DAO_Activity', 'priority_id');
306 $params['priority_id'] = array_search('Normal', $priority);
309 if (!empty($params['target_contact_id']) && is_array($params['target_contact_id'])) {
310 $params['target_contact_id'] = array_unique($params['target_contact_id']);
312 if (!empty($params['assignee_contact_id']) && is_array($params['assignee_contact_id'])) {
313 $params['assignee_contact_id'] = array_unique($params['assignee_contact_id']);
317 if (!empty($params['id'])) {
318 CRM_Utils_Hook
::pre('edit', 'Activity', $activity->id
, $params);
321 CRM_Utils_Hook
::pre('create', 'Activity', NULL, $params);
324 $activity->copyValues($params);
325 if (isset($params['case_id'])) {
326 // CRM-8708, preserve case ID even though it's not part of the SQL model
327 $activity->case_id
= $params['case_id'];
329 elseif (is_numeric($activity->id
)) {
330 // CRM-8708, preserve case ID even though it's not part of the SQL model
331 $activity->case_id
= CRM_Case_BAO_Case
::getCaseIdByActivityId($activity->id
);
335 $transaction = new CRM_Core_Transaction();
337 $result = $activity->save();
339 if (is_a($result, 'CRM_Core_Error')) {
340 $transaction->rollback();
344 $activityId = $activity->id
;
345 $activityContacts = CRM_Core_OptionGroup
::values('activity_contacts', FALSE, FALSE, FALSE, NULL, 'name');
346 $sourceID = CRM_Utils_Array
::key('Activity Source', $activityContacts);
347 $assigneeID = CRM_Utils_Array
::key('Activity Assignees', $activityContacts);
348 $targetID = CRM_Utils_Array
::key('Activity Targets', $activityContacts);
350 if (isset($params['source_contact_id'])) {
352 'activity_id' => $activityId,
353 'contact_id' => $params['source_contact_id'],
354 'record_type_id' => $sourceID
356 self
::deleteActivityContact($activityId, $sourceID);
357 CRM_Activity_BAO_ActivityContact
::create($acParams);
360 // check and attach and files as needed
361 CRM_Core_BAO_File
::processAttachment($params, 'civicrm_activity', $activityId);
363 // attempt to save activity assignment
364 $resultAssignment = NULL;
365 if (!empty($params['assignee_contact_id'])) {
367 $assignmentParams = array('activity_id' => $activityId);
369 if (is_array($params['assignee_contact_id'])) {
370 if (CRM_Utils_Array
::value('deleteActivityAssignment', $params, TRUE)) {
371 // first delete existing assignments if any
372 self
::deleteActivityContact($activityId, $assigneeID);
376 foreach ($params['assignee_contact_id'] as $acID) {
378 $values[] = "( $activityId, $acID, $assigneeID )";
381 while (!empty($values)) {
382 $input = array_splice($values, 0, CRM_Core_DAO
::BULK_INSERT_COUNT
);
383 $str = implode(',', $input);
384 $sql = "INSERT IGNORE INTO civicrm_activity_contact ( activity_id, contact_id, record_type_id ) VALUES $str;";
385 CRM_Core_DAO
::executeQuery($sql);
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 );
431 foreach ($params['target_contact_id'] as $tid) {
433 $values[] = "( $activityId, $tid, $targetID )";
437 while (!empty($values)) {
438 $input = array_splice($values, 0, CRM_Core_DAO
::BULK_INSERT_COUNT
);
439 $str = implode(',', $input);
440 $sql = "INSERT IGNORE INTO civicrm_activity_contact ( activity_id, contact_id, record_type_id ) VALUES $str;";
441 CRM_Core_DAO
::executeQuery($sql);
445 $targetParams['contact_id'] = $params['target_contact_id'];
446 $targetParams['record_type_id'] = $targetID;
447 if (!empty($params['id'])) {
448 $target = new CRM_Activity_BAO_ActivityContact();
449 $target->activity_id
= $activityId;
450 $target->record_type_id
= $targetID;
453 if ($target->contact_id
!= $params['target_contact_id']) {
454 $targetParams['id'] = $target->id
;
455 $resultTarget = CRM_Activity_BAO_ActivityContact
::create($targetParams);
459 $resultTarget = CRM_Activity_BAO_ActivityContact
::create($targetParams);
464 if (CRM_Utils_Array
::value('deleteActivityTarget', $params, TRUE)) {
465 self
::deleteActivityContact($activityId, $targetID );
469 // write to changelog before transaction is committed/rolled
470 // back (and prepare status to display)
471 if (!empty($params['id'])) {
472 $logMsg = "Activity (id: {$result->id} ) updated with ";
475 $logMsg = "Activity created for ";
479 if (isset($params['source_contact_id'])) {
480 $msgs[] = "source={$params['source_contact_id']}";
483 if (!empty($params['target_contact_id'])) {
484 if (is_array($params['target_contact_id']) && !CRM_Utils_array
::crmIsEmptyArray($params['target_contact_id'])) {
485 $msgs[] = "target=" . implode(',', $params['target_contact_id']);
486 // take only first target
487 // will be used for recently viewed display
488 $t = array_slice($params['target_contact_id'], 0, 1);
489 $recentContactId = $t[0];
491 //is array check fixes warning without degrading functionality but it seems this bit of code may no longer work
492 // as it may always be an array
493 elseif (isset($params['target_contact_id']) && !is_array($params['target_contact_id'])) {
494 $msgs[] = "target={$params['target_contact_id']}";
495 // will be used for recently viewed display
496 $recentContactId = $params['target_contact_id'];
500 // at worst, take source for recently viewed display
501 $recentContactId = CRM_Utils_Array
::value('source_contact_id',$params);
504 if (isset($params['assignee_contact_id'])) {
505 if (is_array($params['assignee_contact_id'])) {
506 $msgs[] = "assignee=" . implode(',', $params['assignee_contact_id']);
509 $msgs[] = "assignee={$params['assignee_contact_id']}";
512 $logMsg .= implode(', ', $msgs);
514 self
::logActivityAction($result, $logMsg);
516 if (!empty($params['custom']) &&
517 is_array($params['custom'])
519 CRM_Core_BAO_CustomValueTable
::store($params['custom'], 'civicrm_activity', $result->id
);
522 $transaction->commit();
523 if (empty($params['skipRecentView'])) {
524 $recentOther = array();
525 if (!empty($params['case_id'])) {
526 $caseContactID = CRM_Core_DAO
::getFieldValue('CRM_Case_DAO_CaseContact', $params['case_id'], 'contact_id', 'case_id');
527 $url = CRM_Utils_System
::url('civicrm/case/activity/view',
528 "reset=1&aid={$activity->id}&cid={$caseContactID}&caseID={$params['case_id']}&context=home"
532 $q = "action=view&reset=1&id={$activity->id}&atype={$activity->activity_type_id}&cid=" . CRM_Utils_Array
::value('source_contact_id', $params) . "&context=home";
533 if ($activity->activity_type_id
!= CRM_Core_OptionGroup
::getValue('activity_type', 'Email', 'name')) {
534 $url = CRM_Utils_System
::url('civicrm/activity', $q);
535 if ($activity->activity_type_id
== CRM_Core_OptionGroup
::getValue('activity_type', 'Print PDF Letter', 'name')) {
536 $recentOther['editUrl'] = CRM_Utils_System
::url('civicrm/activity/pdf/add',
537 "action=update&reset=1&id={$activity->id}&atype={$activity->activity_type_id}&cid={$params['source_contact_id']}&context=home"
541 $recentOther['editUrl'] = CRM_Utils_System
::url('civicrm/activity/add',
542 "action=update&reset=1&id={$activity->id}&atype={$activity->activity_type_id}&cid=" . CRM_Utils_Array
::value('source_contact_id', $params) . "&context=home"
546 if (CRM_Core_Permission
::check("delete activities")) {
547 $recentOther['deleteUrl'] = CRM_Utils_System
::url('civicrm/activity',
548 "action=delete&reset=1&id={$activity->id}&atype={$activity->activity_type_id}&cid=" . CRM_Utils_Array
::value('source_contact_id', $params) . "&context=home"
553 $url = CRM_Utils_System
::url('civicrm/activity/view', $q);
554 if (CRM_Core_Permission
::check('delete activities')) {
555 $recentOther['deleteUrl'] = CRM_Utils_System
::url('civicrm/activity',
556 "action=delete&reset=1&id={$activity->id}&atype={$activity->activity_type_id}&cid=" . CRM_Utils_Array
::value('source_contact_id', $params) . "&context=home"
562 if (!isset($activity->parent_id
)) {
563 $recentContactDisplay = CRM_Contact_BAO_Contact
::displayName($recentContactId);
564 // add the recently created Activity
565 $activityTypes = CRM_Core_PseudoConstant
::activityType(TRUE, TRUE);
566 $activitySubject = CRM_Core_DAO
::getFieldValue('CRM_Activity_DAO_Activity', $activity->id
, 'subject');
569 if (isset($activitySubject)) {
570 $title = $activitySubject . ' - ';
573 $title = $title . $recentContactDisplay;
574 if (!empty($activityTypes[$activity->activity_type_id
])) {
575 $title .= ' (' . $activityTypes[$activity->activity_type_id
] . ')';
578 CRM_Utils_Recent
::add($title,
583 $recentContactDisplay,
589 // reset the group contact cache since smart groups might be affected due to this
590 CRM_Contact_BAO_GroupContactCache
::remove();
592 if (!empty($params['id'])) {
593 CRM_Utils_Hook
::post('edit', 'Activity', $activity->id
, $activity);
596 CRM_Utils_Hook
::post('create', 'Activity', $activity->id
, $activity);
599 // if the subject contains a ‘[case #…]’ string, file that activity on the related case (CRM-5916)
601 if (preg_match('/\[case #([0-9a-h]{7})\]/', CRM_Utils_Array
::value('subject', $params), $matches)) {
602 $key = CRM_Core_DAO
::escapeString(CIVICRM_SITE_KEY
);
604 $query = "SELECT id FROM civicrm_case WHERE SUBSTR(SHA1(CONCAT('$key', id)), 1, 7) = '$hash'";
606 'activity_id' => $activity->id
,
607 'case_id' => CRM_Core_DAO
::singleValueQuery($query),
609 if ($caseParams['case_id']) {
610 CRM_Case_BAO_Case
::processCaseActivity($caseParams);
613 self
::logActivityAction($activity, "unknown case hash encountered: $hash");
622 * @param null $logMessage
626 public static function logActivityAction($activity, $logMessage = NULL) {
627 $session = CRM_Core_Session
::singleton();
628 $id = $session->get('userID');
630 $activityContacts = CRM_Core_OptionGroup
::values('activity_contacts', FALSE, FALSE, FALSE, NULL, 'name');
631 $sourceID = CRM_Utils_Array
::key('Activity Source', $activityContacts);
632 $id = self
::getActivityContact($activity->id
. $sourceID);
635 'entity_table' => 'civicrm_activity',
636 'entity_id' => $activity->id
,
637 'modified_id' => $id,
638 'modified_date' => date('YmdHis'),
639 'data' => $logMessage,
641 CRM_Core_BAO_Log
::add($logParams);
646 * get the list Activities
648 * @param array $input 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
659 * @return array (reference) $values the relevant data object values of open activities
664 static function &getActivities($input) {
665 //step 1: Get the basic activity data
666 $bulkActivityTypeID = CRM_Core_OptionGroup
::getValue(
672 $activityContacts = CRM_Core_OptionGroup
::values('activity_contacts', FALSE, FALSE, FALSE, NULL, 'name');
673 $sourceID = CRM_Utils_Array
::key('Activity Source', $activityContacts);
674 $assigneeID = CRM_Utils_Array
::key('Activity Assignees', $activityContacts);
675 $targetID = CRM_Utils_Array
::key('Activity Targets', $activityContacts);
677 $config = CRM_Core_Config
::singleton();
679 $randomNum = md5(uniqid());
680 $activityTempTable = "civicrm_temp_activity_details_{$randomNum}";
682 $tableFields = array(
683 'activity_id' => 'int unsigned',
684 'activity_date_time' => 'datetime',
685 'source_record_id' => 'int unsigned',
686 'status_id' => 'int unsigned',
687 'subject' => 'varchar(255)',
688 'source_contact_name' => 'varchar(255)',
689 'activity_type_id' => 'int unsigned',
690 'activity_type' => 'varchar(128)',
691 'case_id' => 'int unsigned',
692 'case_subject' => 'varchar(255)',
693 'campaign_id' => 'int unsigned',
696 $sql = "CREATE TEMPORARY TABLE {$activityTempTable} ( ";
697 $insertValueSQL = array();
698 // The activityTempTable contains the sorted rows
699 // so in order to maintain the sort order as-is we add an auto_increment
700 // field; we can sort by this later to ensure the sort order stays correct.
701 $sql .= " fixed_sort_order INT UNSIGNED NOT NULL AUTO_INCREMENT PRIMARY KEY,";
702 foreach ($tableFields as $name => $desc) {
703 $sql .= "$name $desc,\n";
704 $insertValueSQL[] = $name;
707 // add unique key on activity_id just to be sure
708 // this cannot be primary key because we need that for the auto_increment
709 // fixed_sort_order field
711 UNIQUE KEY ( activity_id )
712 ) ENGINE=HEAP DEFAULT CHARACTER SET utf8 COLLATE utf8_unicode_ci
715 CRM_Core_DAO
::executeQuery($sql);
717 $insertSQL = "INSERT INTO {$activityTempTable} (" . implode(',', $insertValueSQL) . " ) ";
719 $order = $limit = $groupBy = '';
720 $groupBy = " GROUP BY tbl.activity_id ";
722 if (!empty($input['sort'])) {
723 if (is_a($input['sort'], 'CRM_Utils_Sort')) {
724 $orderBy = $input['sort']->orderBy();
725 if (!empty($orderBy)) {
726 $order = " ORDER BY $orderBy";
729 elseif (trim($input['sort'])) {
730 $sort = CRM_Utils_Type
::escape($input['sort'], 'String');
731 $order = " ORDER BY $sort ";
736 // context = 'activity' in Activities tab.
737 $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 ";
740 if (!empty($input['rowCount']) &&
741 $input['rowCount'] > 0
743 $limit = " LIMIT {$input['offset']}, {$input['rowCount']} ";
746 $input['count'] = FALSE;
747 list($sqlClause, $params) = self
::getActivitySQLClause($input);
749 $query = "{$insertSQL}
750 SELECT DISTINCT tbl.* from ( {$sqlClause} )
753 //filter case activities - CRM-5761
754 $components = self
::activityComponents();
755 if (!in_array('CiviCase', $components)) {
757 LEFT JOIN civicrm_case_activity ON ( civicrm_case_activity.activity_id = tbl.activity_id )
758 WHERE civicrm_case_activity.id IS NULL";
761 $query = $query . $groupBy . $order . $limit;
763 $dao = CRM_Core_DAO
::executeQuery($query, $params);
765 // step 2: Get target and assignee contacts for above activities
766 // create temp table for target contacts
767 $activityContactTempTable = "civicrm_temp_activity_contact_{$randomNum}";
768 $query = "CREATE TEMPORARY TABLE {$activityContactTempTable} (
769 activity_id int unsigned, contact_id int unsigned, record_type_id varchar(16),
770 contact_name varchar(255), is_deleted int unsigned, counter int unsigned, INDEX index_activity_id( activity_id ) )
771 ENGINE=MYISAM DEFAULT CHARACTER SET utf8 COLLATE utf8_unicode_ci";
773 CRM_Core_DAO
::executeQuery($query);
775 // note that we ignore bulk email for targets, since we don't show it in selector
777 INSERT INTO {$activityContactTempTable} ( activity_id, contact_id, record_type_id, contact_name, is_deleted )
778 SELECT ac.activity_id,
783 FROM {$activityTempTable}
784 INNER JOIN civicrm_activity a ON ( a.id = {$activityTempTable}.activity_id )
785 INNER JOIN civicrm_activity_contact ac ON ( ac.activity_id = {$activityTempTable}.activity_id )
786 INNER JOIN civicrm_contact c ON c.id = ac.contact_id
787 WHERE ac.record_type_id != %1
789 $params = array(1 => array($targetID, 'Integer'));
790 CRM_Core_DAO
::executeQuery($query, $params);
792 // for each activity insert one target contact
793 // if we load all target contacts the performance will suffer a lot for mass-activities;
795 INSERT INTO {$activityContactTempTable} ( activity_id, contact_id, record_type_id, contact_name, is_deleted, counter )
796 SELECT ac.activity_id,
802 FROM {$activityTempTable}
803 INNER JOIN civicrm_activity a ON ( a.id = {$activityTempTable}.activity_id )
804 INNER JOIN civicrm_activity_contact ac ON ( ac.activity_id = {$activityTempTable}.activity_id )
805 INNER JOIN civicrm_contact c ON c.id = ac.contact_id
806 WHERE ac.record_type_id = %1
807 GROUP BY ac.activity_id
810 CRM_Core_DAO
::executeQuery($query, $params);
812 // step 3: Combine all temp tables to get final query for activity selector
813 // sort by the original sort order, stored in fixed_sort_order
815 SELECT {$activityTempTable}.*,
816 {$activityContactTempTable}.contact_id,
817 {$activityContactTempTable}.record_type_id,
818 {$activityContactTempTable}.contact_name,
819 {$activityContactTempTable}.is_deleted,
820 {$activityContactTempTable}.counter,
821 re.parent_id as is_recurring_activity
822 FROM {$activityTempTable}
823 INNER JOIN {$activityContactTempTable} on {$activityTempTable}.activity_id = {$activityContactTempTable}.activity_id
824 LEFT JOIN civicrm_recurring_entity re on {$activityContactTempTable}.activity_id = re.entity_id
825 ORDER BY fixed_sort_order
828 $dao = CRM_Core_DAO
::executeQuery($query);
830 //CRM-3553, need to check user has access to target groups.
831 $mailingIDs = CRM_Mailing_BAO_Mailing
::mailingACLIDs();
833 (CRM_Core_Permission
::check('access CiviMail')) ||
834 (CRM_Mailing_Info
::workflowEnabled() &&
835 CRM_Core_Permission
::check('create mailings'))
839 $allCampaigns = CRM_Campaign_BAO_Campaign
::getCampaigns(NULL, NULL, FALSE, FALSE, FALSE, TRUE);
841 while ($dao->fetch()) {
842 $activityID = $dao->activity_id
;
843 $values[$activityID]['activity_id'] = $dao->activity_id
;
844 $values[$activityID]['source_record_id'] = $dao->source_record_id
;
845 $values[$activityID]['activity_type_id'] = $dao->activity_type_id
;
846 $values[$activityID]['activity_type'] = $dao->activity_type
;
847 $values[$activityID]['activity_date_time'] = $dao->activity_date_time
;
848 $values[$activityID]['status_id'] = $dao->status_id
;
849 $values[$activityID]['subject'] = $dao->subject
;
850 $values[$activityID]['campaign_id'] = $dao->campaign_id
;
851 $values[$activityID]['is_recurring_activity'] = $dao->is_recurring_activity
;
853 if ($dao->campaign_id
) {
854 $values[$activityID]['campaign'] = $allCampaigns[$dao->campaign_id
];
857 if (empty($values[$activityID]['assignee_contact_name'])) {
858 $values[$activityID]['assignee_contact_name'] = array();
861 if (empty($values[$activityID]['target_contact_name'])) {
862 $values[$activityID]['target_contact_name'] = array();
863 $values[$activityID]['target_contact_counter'] = $dao->counter
;
866 // if deleted, wrap in <del>
867 if ( $dao->is_deleted
) {
868 $dao->contact_name
= "<del>{$dao->contact_name}</dao>";
871 if ($dao->record_type_id
== $sourceID && $dao->contact_id
) {
872 $values[$activityID]['source_contact_id'] = $dao->contact_id
;
873 $values[$activityID]['source_contact_name'] = $dao->contact_name
;
876 if (!$bulkActivityTypeID ||
($bulkActivityTypeID != $dao->activity_type_id
)) {
877 // build array of target / assignee names
878 if ($dao->record_type_id
== $targetID && $dao->contact_id
) {
879 $values[$activityID]['target_contact_name'][$dao->contact_id
] = $dao->contact_name
;
881 if ($dao->record_type_id
== $assigneeID && $dao->contact_id
) {
882 $values[$activityID]['assignee_contact_name'][$dao->contact_id
] = $dao->contact_name
;
885 // case related fields
886 $values[$activityID]['case_id'] = $dao->case_id
;
887 $values[$activityID]['case_subject'] = $dao->case_subject
;
890 $values[$activityID]['recipients'] = ts('(%1 recipients)', array(1 => $dao->counter
));
891 $values[$activityID]['mailingId'] = false;
894 ($mailingIDs === TRUE ||
in_array($dao->source_record_id
, $mailingIDs))
896 $values[$activityID]['mailingId'] = true;
905 * Get the component id and name those are enabled and logged in
906 * user has permission. To decide whether we are going to include
907 * component related activities w/ core activity retrieve process.
909 * @return array of component id and name.
912 static function activityComponents() {
913 $components = array();
914 $compInfo = CRM_Core_Component
::getEnabledComponents();
915 foreach ($compInfo as $compObj) {
916 if (!empty($compObj->info
['showActivitiesInCore'])) {
917 if ($compObj->info
['name'] == 'CiviCampaign') {
918 $componentPermission = "administer {$compObj->name}";
921 $componentPermission = "access {$compObj->name}";
923 if ($compObj->info
['name'] == 'CiviCase') {
924 if (CRM_Case_BAO_Case
::accessCiviCase()) {
925 $components[$compObj->componentID
] = $compObj->info
['name'];
928 elseif (CRM_Core_Permission
::check($componentPermission)) {
929 $components[$compObj->componentID
] = $compObj->info
['name'];
938 * get the activity Count
940 * @param array $input array of parameters
942 * - contact_id int contact_id whose activities we want to retrieve
943 * - admin boolean if contact is admin
944 * - caseId int case ID
945 * - context string page on which selector is build
946 * - activity_type_id int|string the activity types we want to restrict by
948 * @return int count of activities
953 static function &getActivitiesCount($input) {
954 $input['count'] = TRUE;
955 list($sqlClause, $params) = self
::getActivitySQLClause($input);
957 //filter case activities - CRM-5761
958 $components = self
::activityComponents();
959 if (!in_array('CiviCase', $components)) {
961 SELECT COUNT(DISTINCT(tbl.activity_id)) as count
962 FROM ( {$sqlClause} ) as tbl
963 LEFT JOIN civicrm_case_activity ON ( civicrm_case_activity.activity_id = tbl.activity_id )
964 WHERE civicrm_case_activity.id IS NULL";
967 $query = "SELECT COUNT(DISTINCT(activity_id)) as count from ( {$sqlClause} ) as tbl";
970 return CRM_Core_DAO
::singleValueQuery($query, $params);
974 * function to get the activity sql clause to pick activities
976 * @param array $input array of parameters
978 * - contact_id int contact_id whose activities we want to retrieve
979 * - admin boolean if contact is admin
980 * - caseId int case ID
981 * - context string page on which selector is build
982 * - count boolean are we interested in the count clause only?
983 * - activity_type_id int|string the activity types we want to restrict by
985 * @return int count of activities
990 static function getActivitySQLClause($input) {
992 $sourceWhere = $targetWhere = $assigneeWhere = $caseWhere = 1;
994 $config = CRM_Core_Config
::singleton();
995 if (!CRM_Utils_Array
::value('admin', $input, FALSE)) {
996 $sourceWhere = ' ac.contact_id = %1 ';
997 $caseWhere = ' civicrm_case_contact.contact_id = %1 ';
999 $params = array(1 => array($input['contact_id'], 'Integer'));
1002 $commonClauses = array(
1003 "civicrm_option_group.name = 'activity_type'",
1004 "civicrm_activity.is_deleted = 0",
1005 "civicrm_activity.is_current_revision = 1",
1006 "civicrm_activity.is_test= 0",
1009 if ($input['context'] != 'activity') {
1010 $commonClauses[] = "civicrm_activity.status_id = 1";
1013 //Filter on component IDs.
1014 $components = self
::activityComponents();
1015 if (!empty($components)) {
1016 $componentsIn = implode(',', array_keys($components));
1017 $commonClauses[] = "( civicrm_option_value.component_id IS NULL OR civicrm_option_value.component_id IN ( $componentsIn ) )";
1020 $commonClauses[] = "civicrm_option_value.component_id IS NULL";
1023 // activity type ID clause
1024 if (!empty($input['activity_type_id'])) {
1025 if (is_array($input['activity_type_id'])) {
1026 foreach ($input['activity_type_id'] as $idx => $value) {
1027 $input['activity_type_id'][$idx] = CRM_Utils_Type
::escape($value, 'Positive');
1029 $commonClauses[] = "civicrm_activity.activity_type_id IN ( " . implode(",", $input['activity_type_id']) . " ) ";
1032 $activityTypeID = CRM_Utils_Type
::escape($input['activity_type_id'], 'Positive');
1033 $commonClauses[] = "civicrm_activity.activity_type_id = $activityTypeID";
1037 // exclude by activity type clause
1038 if (!empty($input['activity_type_exclude_id'])) {
1039 if (is_array($input['activity_type_exclude_id'])) {
1040 foreach ($input['activity_type_exclude_id'] as $idx => $value) {
1041 $input['activity_type_exclude_id'][$idx] = CRM_Utils_Type
::escape($value, 'Positive');
1043 $commonClauses[] = "civicrm_activity.activity_type_id NOT IN ( " . implode(",", $input['activity_type_exclude_id']) . " ) ";
1046 $activityTypeID = CRM_Utils_Type
::escape($input['activity_type_exclude_id'], 'Positive');
1047 $commonClauses[] = "civicrm_activity.activity_type_id != $activityTypeID";
1051 $commonClause = implode(' AND ', $commonClauses);
1053 $includeCaseActivities = FALSE;
1054 if (in_array('CiviCase', $components)) {
1055 $includeCaseActivities = TRUE;
1059 // build main activity table select clause
1062 $activityContacts = CRM_Core_OptionGroup
::values('activity_contacts', FALSE, FALSE, FALSE, NULL, 'name');
1063 $sourceID = CRM_Utils_Array
::key('Activity Source', $activityContacts);
1065 INNER JOIN civicrm_activity_contact ac ON ac.activity_id = civicrm_activity.id
1066 INNER JOIN civicrm_contact contact ON ac.contact_id = contact.id
1069 if (!$input['count']) {
1071 civicrm_activity.activity_date_time,
1072 civicrm_activity.source_record_id,
1073 civicrm_activity.status_id,
1074 civicrm_activity.subject,
1075 contact.sort_name as source_contact_name,
1076 civicrm_option_value.value as activity_type_id,
1077 civicrm_option_value.label as activity_type,
1078 null as case_id, null as case_subject,
1079 civicrm_activity.campaign_id as campaign_id
1083 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)
1088 SELECT civicrm_activity.id as activity_id
1090 from civicrm_activity
1091 left join civicrm_option_value on
1092 civicrm_activity.activity_type_id = civicrm_option_value.value
1093 left join civicrm_option_group on
1094 civicrm_option_group.id = civicrm_option_value.option_group_id
1101 // Build case clause
1102 // or else exclude Inbound Emails that have been filed on a case.
1105 if ($includeCaseActivities) {
1107 if (!$input['count']) {
1109 civicrm_activity.activity_date_time,
1110 civicrm_activity.source_record_id,
1111 civicrm_activity.status_id,
1112 civicrm_activity.subject,
1113 contact.sort_name as source_contact_name,
1114 civicrm_option_value.value as activity_type_id,
1115 civicrm_option_value.label as activity_type,
1116 null as case_id, null as case_subject,
1117 civicrm_activity.campaign_id as campaign_id';
1123 SELECT civicrm_activity.id as activity_id
1125 from civicrm_activity
1126 inner join civicrm_case_activity on
1127 civicrm_case_activity.activity_id = civicrm_activity.id
1128 inner join civicrm_case on
1129 civicrm_case_activity.case_id = civicrm_case.id
1130 inner join civicrm_case_contact on
1131 civicrm_case_contact.case_id = civicrm_case.id and {$caseWhere}
1132 left join civicrm_option_value on
1133 civicrm_activity.activity_type_id = civicrm_option_value.value
1134 left join civicrm_option_group on
1135 civicrm_option_group.id = civicrm_option_value.option_group_id
1140 and ( ( civicrm_case_activity.case_id IS NULL ) OR
1141 ( civicrm_option_value.name <> 'Inbound Email' AND
1142 civicrm_option_value.name <> 'Email' AND civicrm_case_activity.case_id
1148 $returnClause = " {$sourceClause} {$caseClause} ";
1150 return array($returnClause, $params);
1154 * send the message to all the contacts and also insert a
1155 * contact activity in each contacts record
1157 * @param array $contactDetails the array of contact details to send the email
1158 * @param string $subject the subject of the message
1161 * @param string $emailAddress use this 'to' email address instead of the default Primary address
1162 * @param int $userID use this userID if set
1163 * @param string $from
1164 * @param array $attachments the array of attachments if any
1165 * @param string $cc cc recipient
1166 * @param string $bcc bcc recipient
1167 * @param array $contactIds contact ids
1168 * @param string $additionalDetails the additional information of CC and BCC appended to the activity Details
1170 * @return array ( sent, activityId) if any email is sent and activityId
1174 static function sendEmail(
1182 $attachments = NULL,
1185 $contactIds, // FIXME a param with no default shouldn't be last
1186 $additionalDetails = NULL
1188 // get the contact details of logged in contact, which we set as from email
1189 if ($userID == NULL) {
1190 $session = CRM_Core_Session
::singleton();
1191 $userID = $session->get('userID');
1194 list($fromDisplayName, $fromEmail, $fromDoNotEmail) = CRM_Contact_BAO_Contact
::getContactDetails($userID);
1196 return array(count($contactDetails), 0, count($contactDetails));
1198 if (!trim($fromDisplayName)) {
1199 $fromDisplayName = $fromEmail;
1203 // token replacement of addressee/email/postal greetings
1204 // get the tokens added in subject and message
1205 $subjectToken = CRM_Utils_Token
::getTokens($subject);
1206 $messageToken = CRM_Utils_Token
::getTokens($text);
1207 $messageToken = array_merge($messageToken, CRM_Utils_Token
::getTokens($html));
1208 $allTokens = array_merge($messageToken, $subjectToken);
1211 $from = "$fromDisplayName <$fromEmail>";
1214 //create the meta level record first ( email activity )
1215 $activityTypeID = CRM_Core_OptionGroup
::getValue('activity_type',
1220 // CRM-6265: save both text and HTML parts in details (if present)
1221 if ($html and $text) {
1222 $details = "-ALTERNATIVE ITEM 0-\n$html$additionalDetails\n-ALTERNATIVE ITEM 1-\n$text$additionalDetails\n-ALTERNATIVE END-\n";
1225 $details = $html ?
$html : $text;
1226 $details .= $additionalDetails;
1229 $activityParams = array(
1230 'source_contact_id' => $userID,
1231 'activity_type_id' => $activityTypeID,
1232 'activity_date_time' => date('YmdHis'),
1233 'subject' => $subject,
1234 'details' => $details,
1235 // FIXME: check for name Completed and get ID from that lookup
1239 // CRM-5916: strip [case #…] before saving the activity (if present in subject)
1240 $activityParams['subject'] = preg_replace('/\[case #([0-9a-h]{7})\] /', '', $activityParams['subject']);
1242 // add the attachments to activity params here
1244 // first process them
1245 $activityParams = array_merge($activityParams,
1250 $activity = self
::create($activityParams);
1252 // get the set of attachments from where they are stored
1253 $attachments = CRM_Core_BAO_File
::getEntityFile('civicrm_activity',
1256 $returnProperties = array();
1257 if (isset($messageToken['contact'])) {
1258 foreach ($messageToken['contact'] as $key => $value) {
1259 $returnProperties[$value] = 1;
1263 if (isset($subjectToken['contact'])) {
1264 foreach ($subjectToken['contact'] as $key => $value) {
1265 if (!isset($returnProperties[$value])) {
1266 $returnProperties[$value] = 1;
1272 // get token details for contacts, call only if tokens are used
1274 if (!empty($returnProperties) ||
!empty($tokens) ||
!empty($allTokens)) {
1275 list($details) = CRM_Utils_Token
::getTokenDetails(
1280 'CRM_Activity_BAO_Activity'
1286 CRM_Utils_Hook
::tokens($tokens);
1287 $categories = array_keys($tokens);
1289 $escapeSmarty = FALSE;
1290 if (defined('CIVICRM_MAIL_SMARTY') && CIVICRM_MAIL_SMARTY
) {
1291 $smarty = CRM_Core_Smarty
::singleton();
1292 $escapeSmarty = TRUE;
1295 $sent = $notSent = array();
1296 foreach ($contactDetails as $values) {
1297 $contactId = $values['contact_id'];
1298 $emailAddress = $values['email'];
1300 if (!empty($details) && is_array($details["{$contactId}"])) {
1301 // unset email from details since it always returns primary email address
1302 unset($details["{$contactId}"]['email']);
1303 unset($details["{$contactId}"]['email_id']);
1304 $values = array_merge($values, $details["{$contactId}"]);
1307 $tokenSubject = CRM_Utils_Token
::replaceContactTokens($subject, $values, FALSE, $subjectToken, FALSE, $escapeSmarty);
1308 $tokenSubject = CRM_Utils_Token
::replaceHookTokens($tokenSubject, $values, $categories, FALSE, $escapeSmarty);
1311 if ($values['preferred_mail_format'] == 'Text' ||
$values['preferred_mail_format'] == 'Both') {
1312 $tokenText = CRM_Utils_Token
::replaceContactTokens($text, $values, FALSE, $messageToken, FALSE, $escapeSmarty);
1313 $tokenText = CRM_Utils_Token
::replaceHookTokens($tokenText, $values, $categories, FALSE, $escapeSmarty);
1319 if ($values['preferred_mail_format'] == 'HTML' ||
$values['preferred_mail_format'] == 'Both') {
1320 $tokenHtml = CRM_Utils_Token
::replaceContactTokens($html, $values, TRUE, $messageToken, FALSE, $escapeSmarty);
1321 $tokenHtml = CRM_Utils_Token
::replaceHookTokens($tokenHtml, $values, $categories, TRUE, $escapeSmarty);
1327 if (defined('CIVICRM_MAIL_SMARTY') && CIVICRM_MAIL_SMARTY
) {
1328 // also add the contact tokens to the template
1329 $smarty->assign_by_ref('contact', $values);
1331 $tokenSubject = $smarty->fetch("string:$tokenSubject");
1332 $tokenText = $smarty->fetch("string:$tokenText");
1333 $tokenHtml = $smarty->fetch("string:$tokenHtml");
1337 if (self
::sendMessage(
1354 return array($sent, $activity->id
);
1358 * @param $contactDetails
1359 * @param $activityParams
1360 * @param array $smsParams
1361 * @param $contactIds
1362 * @param null $userID
1365 * @throws CRM_Core_Exception
1367 static function sendSMS(&$contactDetails,
1369 &$smsParams = array(),
1373 if ($userID == NULL) {
1374 $session = CRM_Core_Session
::singleton();
1375 $userID = $session->get('userID');
1378 $text = &$activityParams['text_message'];
1379 $html = &$activityParams['html_message'];
1382 // token replacement of addressee/email/postal greetings
1383 // get the tokens added in subject and message
1384 $messageToken = CRM_Utils_Token
::getTokens($text);
1385 $messageToken = array_merge($messageToken,
1386 CRM_Utils_Token
::getTokens($html)
1389 //create the meta level record first ( sms activity )
1390 $activityTypeID = CRM_Core_OptionGroup
::getValue('activity_type',
1395 // CRM-6265: save both text and HTML parts in details (if present)
1396 if ($html and $text) {
1397 $details = "-ALTERNATIVE ITEM 0-\n$html\n-ALTERNATIVE ITEM 1-\n$text\n-ALTERNATIVE END-\n";
1400 $details = $html ?
$html : $text;
1403 $activitySubject = $activityParams['activity_subject'];
1404 $activityParams = array(
1405 'source_contact_id' => $userID,
1406 'activity_type_id' => $activityTypeID,
1407 'activity_date_time' => date('YmdHis'),
1408 'subject' => $activitySubject,
1409 'details' => $details,
1410 // FIXME: check for name Completed and get ID from that lookup
1414 $activity = self
::create($activityParams);
1415 $activityID = $activity->id
;
1417 $returnProperties = array();
1419 if (isset($messageToken['contact'])) {
1420 foreach ($messageToken['contact'] as $key => $value) {
1421 $returnProperties[$value] = 1;
1427 CRM_Utils_Hook
::tokens($tokens);
1428 $categories = array_keys($tokens);
1430 // get token details for contacts, call only if tokens are used
1432 if (!empty($returnProperties) ||
!empty($tokens)) {
1433 list($details) = CRM_Utils_Token
::getTokenDetails($contactIds,
1437 'CRM_Activity_BAO_Activity'
1442 $escapeSmarty = FALSE;
1444 foreach ($contactDetails as $values) {
1445 $contactId = $values['contact_id'];
1447 if (!empty($details) && is_array($details["{$contactId}"])) {
1448 // unset email from details since it always returns primary email address
1449 unset($details["{$contactId}"]['email']);
1450 unset($details["{$contactId}"]['email_id']);
1451 $values = array_merge($values, $details["{$contactId}"]);
1454 $tokenText = CRM_Utils_Token
::replaceContactTokens($text, $values, FALSE, $messageToken, FALSE, $escapeSmarty);
1455 $tokenText = CRM_Utils_Token
::replaceHookTokens($tokenText, $values, $categories, FALSE, $escapeSmarty);
1457 $tokenHtml = CRM_Utils_Token
::replaceContactTokens($html, $values, TRUE, $messageToken, FALSE, $escapeSmarty);
1458 $tokenHtml = CRM_Utils_Token
::replaceHookTokens($tokenHtml, $values, $categories, TRUE, $escapeSmarty);
1460 // Only send if the phone is of type mobile
1461 $phoneTypes = CRM_Core_OptionGroup
::values('phone_type', TRUE, FALSE, FALSE, NULL, 'name');
1462 if ($values['phone_type_id'] == CRM_Utils_Array
::value('Mobile', $phoneTypes)) {
1463 $smsParams['To'] = $values['phone'];
1466 $smsParams['To'] = '';
1469 $sendResult = self
::sendSMSMessage(
1478 if (PEAR
::isError($sendResult)) {
1479 // Collect all of the PEAR_Error objects
1480 $errMsgs[] = $sendResult;
1486 // If at least one message was sent and no errors
1487 // were generated then return a boolean value of TRUE.
1488 // Otherwise, return FALSE (no messages sent) or
1489 // and array of 1 or more PEAR_Error objects.
1491 if ($success > 0 && count($errMsgs) == 0) {
1493 } elseif (count($errMsgs) > 0) {
1497 return array($sent, $activity->id
, $success);
1501 * send the sms message to a specific contact
1503 * @param int $toID the contact id of the recipient
1506 * @param array $smsParams the params used for sending sms
1507 * @param int $activityID the activity ID that tracks the message
1508 * @param null $userID
1510 * @return mixed true on success or PEAR_Error object
1514 static function sendSMSMessage($toID,
1517 $smsParams = array(),
1522 $toPhoneNumber = "";
1524 if ($smsParams['To']) {
1525 $toPhoneNumber = trim($smsParams['To']);
1528 $filters = array('is_deceased' => 0, 'is_deleted' => 0, 'do_not_sms' => 0);
1529 $toPhoneNumbers = CRM_Core_BAO_Phone
::allPhones($toID, FALSE, 'Mobile', $filters);
1530 //to get primary mobile ph,if not get a first mobile ph
1531 if (!empty($toPhoneNumbers)) {
1532 $toPhoneNumerDetails = reset($toPhoneNumbers);
1533 $toPhoneNumber = CRM_Utils_Array
::value('phone', $toPhoneNumerDetails);
1534 //contact allows to send sms
1539 // make sure both phone are valid
1540 // and that the recipient wants to receive sms
1541 if (empty($toPhoneNumber) or $toDoNotSms) {
1542 return PEAR
::raiseError(
1543 'Recipient phone number is invalid or recipient does not want to receive SMS',
1549 $message = $tokenHtml ?
$tokenHtml : $tokenText;
1550 $recipient = $smsParams['To'];
1551 $smsParams['contact_id'] = $toID;
1552 $smsParams['parent_activity_id'] = $activityID;
1554 $providerObj = CRM_SMS_Provider
::singleton(array('provider_id' => $smsParams['provider_id']));
1555 $sendResult = $providerObj->send($recipient, $smsParams, $message, NULL, $userID);
1556 if (PEAR
::isError($sendResult)) {
1560 $activityContacts = CRM_Core_OptionGroup
::values('activity_contacts', FALSE, FALSE, FALSE, NULL, 'name');
1561 $targetID = CRM_Utils_Array
::key('Activity Targets', $activityContacts);
1564 // add activity target record for every sms that is send
1565 $activityTargetParams = array(
1566 'activity_id' => $activityID,
1567 'contact_id' => $toID,
1568 'record_type_id' => $targetID
1570 CRM_Activity_BAO_ActivityContact
::create($activityTargetParams);
1576 * send the message to a specific contact
1578 * @param string $from the name and email of the sender
1580 * @param int $toID the contact id of the recipient
1581 * @param string $subject the subject of the message
1582 * @param $text_message
1583 * @param $html_message
1584 * @param string $emailAddress use this 'to' email address instead of the default Primary address
1585 * @param int $activityID the activity ID that tracks the message
1586 * @param null $attachments
1590 * @return boolean true if successfull else false.
1594 static function sendMessage($from,
1602 $attachments = NULL,
1606 list($toDisplayName, $toEmail, $toDoNotEmail) = CRM_Contact_BAO_Contact
::getContactDetails($toID);
1607 if ($emailAddress) {
1608 $toEmail = trim($emailAddress);
1611 // make sure both email addresses are valid
1612 // and that the recipient wants to receive email
1613 if (empty($toEmail) or $toDoNotEmail) {
1616 if (!trim($toDisplayName)) {
1617 $toDisplayName = $toEmail;
1620 $activityContacts = CRM_Core_OptionGroup
::values('activity_contacts', FALSE, FALSE, FALSE, NULL, 'name');
1621 //$sourceID = CRM_Utils_Array::key('Activity Source', $activityContacts);
1622 //$assigneeID = CRM_Utils_Array::key('Activity Assignees', $activityContacts);
1623 $targetID = CRM_Utils_Array
::key('Activity Targets', $activityContacts);
1625 // create the params array
1626 $mailParams = array(
1627 'groupName' => 'Activity Email Sender',
1629 'toName' => $toDisplayName,
1630 'toEmail' => $toEmail,
1631 'subject' => $subject,
1634 'text' => $text_message,
1635 'html' => $html_message,
1636 'attachments' => $attachments,
1639 if (!CRM_Utils_Mail
::send($mailParams)) {
1643 // add activity target record for every mail that is send
1644 $activityTargetParams = array(
1645 'activity_id' => $activityID,
1646 'contact_id' => $toID,
1647 'record_type_id' => $targetID
1649 CRM_Activity_BAO_ActivityContact
::create($activityTargetParams);
1654 * combine all the importable fields from the lower levels object
1656 * The ordering is important, since currently we do not have a weight
1657 * scheme. Adding weight is super important and should be done in the
1658 * next week or so, before this can be called complete.
1660 * @param bool $status
1662 * @return array array of importable Fields
1666 static function &importableFields($status = FALSE) {
1667 if (!self
::$_importableFields) {
1668 if (!self
::$_importableFields) {
1669 self
::$_importableFields = array();
1672 $fields = array('' => array('title' => ts('- do not import -')));
1675 $fields = array('' => array('title' => ts('- Activity Fields -')));
1678 $tmpFields = CRM_Activity_DAO_Activity
::import();
1679 $contactFields = CRM_Contact_BAO_Contact
::importableFields('Individual', NULL);
1681 // Using new Dedupe rule.
1682 $ruleParams = array(
1683 'contact_type' => 'Individual',
1684 'used' => 'Unsupervised',
1686 $fieldsArray = CRM_Dedupe_BAO_Rule
::dedupeRuleFields($ruleParams);
1688 $tmpConatctField = array();
1689 if (is_array($fieldsArray)) {
1690 foreach ($fieldsArray as $value) {
1691 $customFieldId = CRM_Core_DAO
::getFieldValue('CRM_Core_DAO_CustomField',
1696 $value = $customFieldId ?
'custom_' . $customFieldId : $value;
1697 $tmpConatctField[trim($value)] = $contactFields[trim($value)];
1698 $tmpConatctField[trim($value)]['title'] = $tmpConatctField[trim($value)]['title'] . " (match to contact)";
1701 $tmpConatctField['external_identifier'] = $contactFields['external_identifier'];
1702 $tmpConatctField['external_identifier']['title'] = $contactFields['external_identifier']['title'] . " (match to contact)";
1703 $fields = array_merge($fields, $tmpConatctField);
1704 $fields = array_merge($fields, $tmpFields);
1705 $fields = array_merge($fields, CRM_Core_BAO_CustomField
::getFieldsForImport('Activity'));
1706 self
::$_importableFields = $fields;
1708 return self
::$_importableFields;
1712 * To get the Activities of a target contact
1714 * @param int $contactId Id of the contact whose activities need to find
1716 * @return array array of activity fields
1719 static function getContactActivity($contactId) {
1720 $activities = array();
1721 $activityContacts = CRM_Core_OptionGroup
::values('activity_contacts', FALSE, FALSE, FALSE, NULL, 'name');
1722 $sourceID = CRM_Utils_Array
::key('Activity Source', $activityContacts);
1723 $assigneeID = CRM_Utils_Array
::key('Activity Assignees', $activityContacts);
1724 $targetID = CRM_Utils_Array
::key('Activity Targets', $activityContacts);
1727 // First look for activities where contactId is one of the targets
1729 SELECT activity_id, record_type_id
1730 FROM civicrm_activity_contact
1731 WHERE contact_id = $contactId
1733 $dao = CRM_Core_DAO
::executeQuery($query);
1734 while ($dao->fetch()) {
1735 if ($dao->record_type_id
== $targetID ) {
1736 $activities[$dao->activity_id
]['targets'][$contactId] = $contactId;
1738 else if ($dao->record_type_id
== $assigneeID) {
1739 $activities[$dao->activity_id
]['asignees'][$contactId] = $contactId;
1742 // do source stuff here
1743 $activities[$dao->activity_id
]['source_contact_id'] = $contactId;
1747 $activityIds = array_keys($activities);
1748 if (count($activityIds) < 1) {
1752 $activityIds = implode(',', $activityIds);
1754 SELECT activity.id as activity_id,
1756 subject, location, activity_date_time, details, status_id
1757 FROM civicrm_activity activity
1758 WHERE activity.id IN ($activityIds)";
1760 $dao = CRM_Core_DAO
::executeQuery($query);
1762 $activityTypes = CRM_Core_OptionGroup
::values('activity_type');
1763 $activityStatuses = CRM_Core_OptionGroup
::values('activity_status');
1765 while ($dao->fetch()) {
1766 $activities[$dao->activity_id
]['id'] = $dao->activity_id
;
1767 $activities[$dao->activity_id
]['activity_type_id'] = $dao->activity_type_id
;
1768 $activities[$dao->activity_id
]['subject'] = $dao->subject
;
1769 $activities[$dao->activity_id
]['location'] = $dao->location
;
1770 $activities[$dao->activity_id
]['activity_date_time'] = $dao->activity_date_time
;
1771 $activities[$dao->activity_id
]['details'] = $dao->details
;
1772 $activities[$dao->activity_id
]['status_id'] = $dao->status_id
;
1773 $activities[$dao->activity_id
]['activity_name'] = $activityTypes[$dao->activity_type_id
];
1774 $activities[$dao->activity_id
]['status'] = $activityStatuses[$dao->status_id
];
1776 // set to null if not set
1777 if (!isset($activities[$dao->activity_id
]['source_contact_id'])) {
1778 $activities[$dao->activity_id
]['source_contact_id'] = NULL;
1785 * Function to add activity for Membership/Event/Contribution
1787 * @param object $activity (reference) particular component object
1788 * @param string $activityType for Membership Signup or Renewal
1789 * @param int $targetContactID
1795 static function addActivity(&$activity,
1796 $activityType = 'Membership Signup',
1797 $targetContactID = NULL
1799 if ($activity->__table
== 'civicrm_membership') {
1800 $membershipType = CRM_Member_PseudoConstant
::membershipType($activity->membership_type_id
);
1802 if (!$membershipType) {
1803 $membershipType = ts('Membership');
1806 $subject = "{$membershipType}";
1808 if (!empty($activity->source
) && $activity->source
!= 'null') {
1809 $subject .= " - {$activity->source}";
1812 if ($activity->owner_membership_id
) {
1815 FROM civicrm_contact, civicrm_membership
1816 WHERE civicrm_contact.id = civicrm_membership.contact_id
1817 AND civicrm_membership.id = $activity->owner_membership_id
1819 $displayName = CRM_Core_DAO
::singleValueQuery($query);
1820 $subject .= " (by {$displayName})";
1823 $subject .= " - Status: " . CRM_Core_DAO
::getFieldValue('CRM_Member_DAO_MembershipStatus', $activity->status_id
, 'label');
1824 // CRM-72097 changed from start date to today
1825 $date = date('YmdHis');
1826 $component = 'Membership';
1828 elseif ($activity->__table
== 'civicrm_participant') {
1829 $event = CRM_Event_BAO_Event
::getEvents(1, $activity->event_id
, TRUE, FALSE);
1831 $roles = CRM_Event_PseudoConstant
::participantRole();
1832 $status = CRM_Event_PseudoConstant
::participantStatus();
1834 $subject = $event[$activity->event_id
];
1835 if (!empty($roles[$activity->role_id
])) {
1836 $subject .= ' - ' . $roles[$activity->role_id
];
1838 if (!empty($status[$activity->status_id
])) {
1839 $subject .= ' - ' . $status[$activity->status_id
];
1841 $date = date('YmdHis');
1842 if ($activityType != 'Email') {
1843 $activityType = 'Event Registration';
1845 $component = 'Event';
1847 elseif ($activity->__table
== 'civicrm_contribution') {
1848 //create activity record only for Completed Contributions
1849 if ($activity->contribution_status_id
!= 1) {
1855 $subject .= CRM_Utils_Money
::format($activity->total_amount
, $activity->currency
);
1856 if (!empty($activity->source
) && $activity->source
!= 'null') {
1857 $subject .= " - {$activity->source}";
1859 $date = CRM_Utils_Date
::isoToMysql($activity->receive_date
);
1860 $activityType = $component = 'Contribution';
1862 $activityParams = array(
1863 'source_contact_id' => $activity->contact_id
,
1864 'source_record_id' => $activity->id
,
1865 'activity_type_id' => CRM_Core_OptionGroup
::getValue('activity_type',
1869 'subject' => $subject,
1870 'activity_date_time' => $date,
1871 'is_test' => $activity->is_test
,
1872 'status_id' => CRM_Core_OptionGroup
::getValue('activity_status',
1876 'skipRecentView' => TRUE,
1877 'campaign_id' => $activity->campaign_id
,
1880 // create activity with target contacts
1881 $session = CRM_Core_Session
::singleton();
1882 $id = $session->get('userID');
1884 $activityParams['source_contact_id'] = $id;
1885 $activityParams['target_contact_id'][] = $activity->contact_id
;
1889 if (property_exists($activity, 'details')) {
1890 $activityParams['details'] = $activity->details
;
1893 if ($targetContactID) {
1894 $activityParams['target_contact_id'][] = $targetContactID;
1896 if (is_a(self
::create($activityParams), 'CRM_Core_Error')) {
1897 CRM_Core_Error
::fatal("Failed creating Activity for $component of id {$activity->id}");
1903 * Get Parent activity for currently viewed activity
1905 * @param int $activityId current activity id
1907 * @return int $parentId Id of parent activity otherwise false.
1910 static function getParentActivity($activityId) {
1911 static $parentActivities = array();
1913 $activityId = CRM_Utils_Type
::escape($activityId, 'Integer');
1915 if (!array_key_exists($activityId, $parentActivities)) {
1916 $parentActivities[$activityId] = array();
1918 $parentId = CRM_Core_DAO
::getFieldValue('CRM_Activity_DAO_Activity',
1923 $parentActivities[$activityId] = $parentId ?
$parentId : FALSE;
1926 return $parentActivities[$activityId];
1930 * Get total count of prior revision of currently viewd activity
1932 * @param $activityID current activity id
1934 * @return int $params count of prior activities otherwise false.
1937 static function getPriorCount($activityID) {
1938 static $priorCounts = array();
1940 $activityID = CRM_Utils_Type
::escape($activityID, 'Integer');
1942 if (!array_key_exists($activityID, $priorCounts)) {
1943 $priorCounts[$activityID] = array();
1944 $originalID = CRM_Core_DAO
::getFieldValue('CRM_Activity_DAO_Activity',
1951 SELECT count( id ) AS cnt
1952 FROM civicrm_activity
1953 WHERE ( id = {$originalID} OR original_id = {$originalID} )
1954 AND is_current_revision = 0
1955 AND id < {$activityID}
1957 $params = array(1 => array($originalID, 'Integer'));
1958 $count = CRM_Core_DAO
::singleValueQuery($query, $params);
1960 $priorCounts[$activityID] = $count ?
$count : 0;
1963 return $priorCounts[$activityID];
1967 * Get all prior activities of currently viewed activity
1969 * @param $activityID current activity id
1970 * @param bool $onlyPriorRevisions
1972 * @return array $result prior activities info.
1975 static function getPriorAcitivities($activityID, $onlyPriorRevisions = FALSE) {
1976 static $priorActivities = array();
1978 $activityID = CRM_Utils_Type
::escape($activityID, 'Integer');
1979 $index = $activityID . '_' . (int) $onlyPriorRevisions;
1981 if (!array_key_exists($index, $priorActivities)) {
1982 $priorActivities[$index] = array();
1984 $originalID = CRM_Core_DAO
::getFieldValue('CRM_Activity_DAO_Activity',
1990 SELECT c.display_name as name, cl.modified_date as date, ca.id as activityID
1991 FROM civicrm_log cl, civicrm_contact c, civicrm_activity ca
1992 WHERE (ca.id = %1 OR ca.original_id = %1)
1993 AND cl.entity_table = 'civicrm_activity'
1994 AND cl.entity_id = ca.id
1995 AND cl.modified_id = c.id
1997 if ($onlyPriorRevisions) {
1998 $query .= " AND ca.id < {$activityID}";
2000 $query .= " ORDER BY ca.id DESC";
2002 $params = array(1 => array($originalID, 'Integer'));
2003 $dao = CRM_Core_DAO
::executeQuery($query, $params);
2005 while ($dao->fetch()) {
2006 $priorActivities[$index][$dao->activityID
]['id'] = $dao->activityID
;
2007 $priorActivities[$index][$dao->activityID
]['name'] = $dao->name
;
2008 $priorActivities[$index][$dao->activityID
]['date'] = $dao->date
;
2013 return $priorActivities[$index];
2017 * Function to find the latest revision of a given activity
2019 * @param $activityID prior activity id
2021 * @return int $params current activity id.
2024 static function getLatestActivityId($activityID) {
2025 static $latestActivityIds = array();
2027 $activityID = CRM_Utils_Type
::escape($activityID, 'Integer');
2029 if (!array_key_exists($activityID, $latestActivityIds)) {
2030 $latestActivityIds[$activityID] = array();
2032 $originalID = CRM_Core_DAO
::getFieldValue('CRM_Activity_DAO_Activity',
2037 $activityID = $originalID;
2039 $params = array(1 => array($activityID, 'Integer'));
2040 $query = "SELECT id from civicrm_activity where original_id = %1 and is_current_revision = 1";
2042 $latestActivityIds[$activityID] = CRM_Core_DAO
::singleValueQuery($query, $params);
2045 return $latestActivityIds[$activityID];
2049 * Function to create a follow up a given activity
2051 * @param $activityId int activity id of parent activity
2052 * @param array $params
2054 * @return $this|null|object
2058 static function createFollowupActivity($activityId, $params) {
2063 $session = CRM_Core_Session
::singleton();
2065 $followupParams = array();
2066 $followupParams['parent_id'] = $activityId;
2067 $followupParams['source_contact_id'] = $session->get('userID');
2068 $followupParams['status_id'] = CRM_Core_OptionGroup
::getValue('activity_status', 'Scheduled', 'name');
2070 $followupParams['activity_type_id'] = $params['followup_activity_type_id'];
2071 // Get Subject of Follow-up Activiity, CRM-4491
2072 $followupParams['subject'] = CRM_Utils_Array
::value('followup_activity_subject', $params);
2073 $followupParams['assignee_contact_id'] = CRM_Utils_Array
::value('followup_assignee_contact_id', $params);
2075 //create target contact for followup
2076 if (!empty($params['target_contact_id'])) {
2077 $followupParams['target_contact_id'] = $params['target_contact_id'];
2080 $followupParams['activity_date_time'] = CRM_Utils_Date
::processDate($params['followup_date'],
2081 $params['followup_date_time']
2083 $followupActivity = self
::create($followupParams);
2085 return $followupActivity;
2089 * Function to get Activity specific File according activity type Id.
2091 * @param int $activityTypeId activity id
2092 * @param string $crmDir
2094 * @return string|bool if file exists returns $activityTypeFile activity filename otherwise false.
2098 static function getFileForActivityTypeId($activityTypeId, $crmDir = 'Activity') {
2099 $activityTypes = CRM_Case_PseudoConstant
::caseActivityType(FALSE, TRUE);
2101 if ($activityTypes[$activityTypeId]['name']) {
2102 $activityTypeFile = CRM_Utils_String
::munge(ucwords($activityTypes[$activityTypeId]['name']), '', 0);
2108 global $civicrm_root;
2109 $config = CRM_Core_Config
::singleton();
2110 if (!file_exists(rtrim($civicrm_root, '/') . "/CRM/{$crmDir}/Form/Activity/{$activityTypeFile}.php")) {
2111 if (empty($config->customPHPPathDir
)) {
2114 elseif (!file_exists(rtrim($config->customPHPPathDir
, '/') . "/CRM/{$crmDir}/Form/Activity/{$activityTypeFile}.php")) {
2119 return $activityTypeFile;
2123 * Function to restore the activity
2125 * @param array $params associated array
2131 public static function restoreActivity(&$params) {
2132 $activity = new CRM_Activity_DAO_Activity();
2133 $activity->copyValues($params);
2135 $activity->is_deleted
= 0;
2136 $result = $activity->save();
2142 * Get the exportable fields for Activities
2144 * @param string $name if it is called by case $name = Case else $name = Activity
2146 * @return array array of exportable Fields
2150 static function &exportableFields($name = 'Activity') {
2151 if (!isset(self
::$_exportableFields[$name])) {
2152 self
::$_exportableFields[$name] = array();
2154 // TO DO, ideally we should retrieve all fields from xml, in this case since activity processing is done
2155 // my case hence we have defined fields as case_*
2156 if ($name == 'Activity') {
2157 $exportableFields = CRM_Activity_DAO_Activity
::export();
2158 $exportableFields['source_contact_id']['title'] = ts('Source Contact ID');
2159 $exportableFields['source_contact'] = array(
2160 'title' => ts('Source Contact'),
2161 'type' => CRM_Utils_Type
::T_STRING
,
2165 $Activityfields = array(
2166 'activity_type' => array('title' => ts('Activity Type'), 'type' => CRM_Utils_Type
::T_STRING
),
2167 'activity_status' => array('title' => ts('Activity Status'), 'type' => CRM_Utils_Type
::T_STRING
),
2169 $fields = array_merge($Activityfields, $exportableFields);
2172 //set title to activity fields
2174 'case_activity_subject' => array('title' => ts('Activity Subject'), 'type' => CRM_Utils_Type
::T_STRING
),
2175 'case_source_contact_id' => array('title' => ts('Activity Reporter'), 'type' => CRM_Utils_Type
::T_STRING
),
2176 'case_recent_activity_date' => array('title' => ts('Activity Actual Date'), 'type' => CRM_Utils_Type
::T_DATE
),
2177 'case_scheduled_activity_date' => array('title' => ts('Activity Scheduled Date'), 'type' => CRM_Utils_Type
::T_DATE
),
2178 'case_recent_activity_type' => array('title' => ts('Activity Type'), 'type' => CRM_Utils_Type
::T_STRING
),
2179 'case_activity_status' => array('title' => ts('Activity Status'), 'type' => CRM_Utils_Type
::T_STRING
),
2180 'case_activity_duration' => array('title' => ts('Activity Duration'), 'type' => CRM_Utils_Type
::T_INT
),
2181 'case_activity_medium_id' => array('title' => ts('Activity Medium'), 'type' => CRM_Utils_Type
::T_INT
),
2182 'case_activity_details' => array('title' => ts('Activity Details'), 'type' => CRM_Utils_Type
::T_TEXT
),
2183 'case_activity_is_auto' => array('title' => ts('Activity Auto-generated?'), 'type' => CRM_Utils_Type
::T_BOOLEAN
),
2186 // add custom data for cases
2187 $fields = array_merge($fields, CRM_Core_BAO_CustomField
::getFieldsForImport('Case'));
2190 // add custom data for case activities
2191 $fields = array_merge($fields, CRM_Core_BAO_CustomField
::getFieldsForImport('Activity'));
2193 self
::$_exportableFields[$name] = $fields;
2195 return self
::$_exportableFields[$name];
2199 * Get the allowed profile fields for Activities
2201 * @return array array of activity profile Fields
2204 static function getProfileFields() {
2205 $exportableFields = self
::exportableFields('Activity');
2206 $skipFields = array(
2209 'source_contact_id',
2211 'activity_campaign',
2213 'is_current_revision',
2214 'activity_is_deleted',
2216 $config = CRM_Core_Config
::singleton();
2217 if (!in_array('CiviCampaign', $config->enableComponents
)) {
2218 $skipFields[] = 'activity_engagement_level';
2221 foreach ($skipFields as $field) {
2222 if (isset($exportableFields[$field])) {
2223 unset($exportableFields[$field]);
2227 // hack to use 'activity_type_id' instead of 'activity_type'
2228 $exportableFields['activity_status_id'] = $exportableFields['activity_status'];
2229 unset($exportableFields['activity_status']);
2231 return $exportableFields;
2235 * This function deletes the activity record related to contact record,
2236 * when there are no target and assignee record w/ other contact.
2238 * @param int $contactId contactId
2243 public static function cleanupActivity($contactId) {
2248 $activityContacts = CRM_Core_OptionGroup
::values('activity_contacts', FALSE, FALSE, FALSE, NULL, 'name');
2249 $sourceID = CRM_Utils_Array
::key('Activity Source', $activityContacts);
2251 $transaction = new CRM_Core_Transaction();
2253 // delete activity if there is no record in civicrm_activity_contact
2254 // pointing to any other contact record
2255 $activityContact = new CRM_Activity_DAO_ActivityContact();
2256 $activityContact->contact_id
= $contactId;
2257 $activityContact->record_type_id
= $sourceID;
2258 $activityContact->find();
2260 while ($activityContact->fetch()) {
2261 // delete activity_contact record for the deleted contact
2262 $activityContact->delete();
2264 $activityContactOther = new CRM_Activity_DAO_ActivityContact();
2265 $activityContactOther->activity_id
= $activityContact->activity_id
;
2267 // delete activity only if no other contacts connected
2268 if ( ! $activityContactOther->find(TRUE) ) {
2269 $activityParams = array('id' => $activityContact->activity_id
);
2270 $result = self
::deleteActivity($activityParams);
2273 $activityContactOther->free();
2276 $activityContact->free();
2277 $transaction->commit();
2283 * Does user has sufficient permission for view/edit activity record?
2285 * @param int $activityId activity record id.
2286 * @param int $action edit/view
2288 * @return boolean $allow true/false
2291 public static function checkPermission($activityId, $action) {
2294 !in_array($action, array(CRM_Core_Action
::UPDATE
, CRM_Core_Action
::VIEW
))
2299 $activity = new CRM_Activity_DAO_Activity();
2300 $activity->id
= $activityId;
2301 if (!$activity->find(TRUE)) {
2305 //component related permissions.
2306 $compPermissions = array(
2307 'CiviCase' => array('administer CiviCase',
2308 'access my cases and activities',
2309 'access all cases and activities',
2311 'CiviMail' => array('access CiviMail'),
2312 'CiviEvent' => array('access CiviEvent'),
2313 'CiviGrant' => array('access CiviGrant'),
2314 'CiviPledge' => array('access CiviPledge'),
2315 'CiviMember' => array('access CiviMember'),
2316 'CiviReport' => array('access CiviReport'),
2317 'CiviContribute' => array('access CiviContribute'),
2318 'CiviCampaign' => array('administer CiviCampaign'),
2321 //return early when it is case activity.
2322 $isCaseActivity = CRM_Case_BAO_Case
::isCaseActivity($activityId);
2323 //check for civicase related permission.
2324 if ($isCaseActivity) {
2326 foreach ($compPermissions['CiviCase'] as $per) {
2327 if (CRM_Core_Permission
::check($per)) {
2333 //check for case specific permissions.
2336 if ($action == CRM_Core_Action
::UPDATE
) {
2339 $allow = CRM_Case_BAO_Case
::checkPermission($activityId,
2341 $activity->activity_type_id
2348 //first check the component permission.
2351 FROM civicrm_option_value val
2352 INNER JOIN civicrm_option_group grp ON ( grp.id = val.option_group_id AND grp.name = %1 )
2353 WHERE val.value = %2";
2354 $params = array(1 => array('activity_type', 'String'),
2355 2 => array($activity->activity_type_id
, 'Integer'),
2357 $componentId = CRM_Core_DAO
::singleValueQuery($sql, $params);
2360 $componentName = CRM_Core_Component
::getComponentName($componentId);
2361 $compPermission = CRM_Utils_Array
::value($componentName, $compPermissions);
2363 //here we are interesting in any single permission.
2364 if (is_array($compPermission)) {
2365 foreach ($compPermission as $per) {
2366 if (CRM_Core_Permission
::check($per)) {
2374 //check for this permission related to contact.
2375 $permission = CRM_Core_Permission
::VIEW
;
2376 if ($action == CRM_Core_Action
::UPDATE
) {
2377 $permission = CRM_Core_Permission
::EDIT
;
2380 $activityContacts = CRM_Core_OptionGroup
::values('activity_contacts', FALSE, FALSE, FALSE, NULL, 'name');
2381 $sourceID = CRM_Utils_Array
::key('Activity Source', $activityContacts);
2382 $assigneeID = CRM_Utils_Array
::key('Activity Assignees', $activityContacts);
2383 $targetID = CRM_Utils_Array
::key('Activity Targets', $activityContacts);
2385 //check for source contact.
2386 if (!$componentId ||
$allow) {
2387 $sourceContactId = self
::getActivityContact($activity->id
, $sourceID);
2388 //account for possibility of activity not having a source contact (as it may have been deleted)
2389 if ( $sourceContactId ) {
2390 $allow = CRM_Contact_BAO_Contact_Permission
::allow($sourceContactId, $permission);
2394 //check for target and assignee contacts.
2396 //first check for supper permission.
2397 $supPermission = 'view all contacts';
2398 if ($action == CRM_Core_Action
::UPDATE
) {
2399 $supPermission = 'edit all contacts';
2401 $allow = CRM_Core_Permission
::check($supPermission);
2403 //user might have sufficient permission, through acls.
2406 //get the target contacts.
2407 $targetContacts = CRM_Activity_BAO_ActivityContact
::retrieveContactIdsByActivityId($activity->id
, $targetID);
2408 foreach ($targetContacts as $cnt => $contactId) {
2409 if (!CRM_Contact_BAO_Contact_Permission
::allow($contactId, $permission)) {
2415 //get the assignee contacts.
2417 $assigneeContacts = CRM_Activity_BAO_ActivityContact
::retrieveContactIdsByActivityId($activity->id
, $assigneeID);
2418 foreach ($assigneeContacts as $cnt => $contactId) {
2419 if (!CRM_Contact_BAO_Contact_Permission
::allow($contactId, $permission)) {
2432 * This function is a wrapper for ajax activity selector
2434 * @param array $params associated array for params record id.
2436 * @return array $contactActivities associated array of contact activities
2439 public static function getContactActivitySelector(&$params) {
2440 // format the params
2441 $params['offset'] = ($params['page'] - 1) * $params['rp'];
2442 $params['rowCount'] = $params['rp'];
2443 $params['sort'] = CRM_Utils_Array
::value('sortBy', $params);
2444 $params['caseId'] = NULL;
2445 $context = CRM_Utils_Array
::value('context', $params);
2447 // get contact activities
2448 $activities = CRM_Activity_BAO_Activity
::getActivities($params);
2451 $params['total'] = CRM_Activity_BAO_Activity
::getActivitiesCount($params);
2453 // format params and add links
2454 $contactActivities = array();
2456 if (!empty($activities)) {
2457 $activityStatus = CRM_Core_PseudoConstant
::activityStatus();
2459 // check logged in user for permission
2460 $page = new CRM_Core_Page();
2461 CRM_Contact_Page_View
::checkUserPermission($page, $params['contact_id']);
2462 $permissions = array($page->_permission
);
2463 if (CRM_Core_Permission
::check('delete activities')) {
2464 $permissions[] = CRM_Core_Permission
::DELETE
;
2467 $mask = CRM_Core_Action
::mask($permissions);
2469 foreach ($activities as $activityId => $values) {
2470 $contactActivities[$activityId]['activity_type'] = $values['activity_type'];
2471 $contactActivities[$activityId]['subject'] = $values['subject'];
2472 if ($params['contact_id'] == $values['source_contact_id']) {
2473 $contactActivities[$activityId]['source_contact'] = $values['source_contact_name'];
2475 elseif ($values['source_contact_id']) {
2476 $contactActivities[$activityId]['source_contact'] = CRM_Utils_System
::href($values['source_contact_name'],
2477 'civicrm/contact/view', "reset=1&cid={$values['source_contact_id']}");
2480 $contactActivities[$activityId]['source_contact'] = '<em>n/a</em>';
2483 if (isset($values['mailingId']) && !empty($values['mailingId'])) {
2484 $contactActivities[$activityId]['target_contact'] = CRM_Utils_System
::href($values['recipients'],
2485 'civicrm/mailing/report/event',
2486 "mid={$values['source_record_id']}&reset=1&event=queue&cid={$params['contact_id']}&context=activitySelector");
2488 elseif (!empty($values['recipients'])) {
2489 $contactActivities[$activityId]['target_contact'] = $values['recipients'];
2491 elseif (isset($values['target_contact_counter']) && $values['target_contact_counter']) {
2492 foreach ($values['target_contact_name'] as $tcID => $tcName) {
2493 $contactActivities[$activityId]['target_contact'] .= CRM_Utils_System
::href($tcName,
2494 'civicrm/contact/view', "reset=1&cid={$tcID}");
2497 if ($extraCount = $values['target_contact_counter'] - 1) {
2498 $contactActivities[$activityId]['target_contact'] .= ";<br />" . "(" . ts('%1 more', array(1 => $extraCount)) . ")";
2501 elseif (!$values['target_contact_name']) {
2502 $contactActivities[$activityId]['target_contact'] = '<em>n/a</em>';
2505 if (empty($values['assignee_contact_name'])) {
2506 $contactActivities[$activityId]['assignee_contact'] = '<em>n/a</em>';
2508 elseif (!empty($values['assignee_contact_name'])) {
2510 $contactActivities[$activityId]['assignee_contact'] = '';
2511 foreach ($values['assignee_contact_name'] as $acID => $acName) {
2512 if ($acID && $count < 5) {
2513 $contactActivities[$activityId]['assignee_contact'] .= CRM_Utils_System
::href($acName, 'civicrm/contact/view', "reset=1&cid={$acID}");
2516 $contactActivities[$activityId]['assignee_contact'] .= "; ";
2520 $contactActivities[$activityId]['assignee_contact'] .= "(" . ts('more') . ")";
2527 $contactActivities[$activityId]['activity_date'] = CRM_Utils_Date
::customFormat($values['activity_date_time']);
2528 $contactActivities[$activityId]['status'] = $activityStatus[$values['status_id']];
2530 // add class to this row if overdue
2531 $contactActivities[$activityId]['class'] = '';
2532 if (CRM_Utils_Date
::overdue(CRM_Utils_Array
::value('activity_date_time', $values))
2533 && CRM_Utils_Array
::value('status_id', $values) == 1
2535 $contactActivities[$activityId]['class'] = 'status-overdue';
2538 $contactActivities[$activityId]['class'] = 'status-ontime';
2542 $contactActivities[$activityId]['links'] = '';
2543 $accessMailingReport = FALSE;
2544 if (!empty($values['mailingId'])) {
2545 $accessMailingReport = TRUE;
2548 $actionLinks = CRM_Activity_Selector_Activity
::actionLinks(
2549 CRM_Utils_Array
::value('activity_type_id', $values),
2550 CRM_Utils_Array
::value('source_record_id', $values),
2551 $accessMailingReport,
2552 CRM_Utils_Array
::value('activity_id', $values)
2555 $actionMask = array_sum(array_keys($actionLinks)) & $mask;
2557 $contactActivities[$activityId]['links'] = CRM_Core_Action
::formLink($actionLinks,
2560 'id' => $values['activity_id'],
2561 'cid' => $params['contact_id'],
2563 'caseid' => CRM_Utils_Array
::value('case_id', $values),
2569 $values['activity_id']
2572 $contactActivities[$activityId]['is_recurring_activity'] = $values['is_recurring_activity'];
2576 return $contactActivities;
2580 * Used to copy custom fields and attachments from an existing activity to another.
2581 * @see CRM_Case_Page_AJAX::_convertToCaseActivity() for example
2583 * @param array $params
2585 static function copyExtendedActivityData($params) {
2586 // attach custom data to the new activity
2587 $customParams = $htmlType = array();
2588 $customValues = CRM_Core_BAO_CustomValueTable
::getEntityValues($params['activityID'], 'Activity');
2590 if (!empty($customValues)) {
2591 $fieldIds = implode(', ', array_keys($customValues));
2592 $sql = "SELECT id FROM civicrm_custom_field WHERE html_type = 'File' AND id IN ( {$fieldIds} )";
2593 $result = CRM_Core_DAO
::executeQuery($sql);
2595 while ($result->fetch()) {
2596 $htmlType[] = $result->id
;
2599 foreach ($customValues as $key => $value) {
2600 if ($value !== NULL) { // CRM-10542
2601 if (in_array($key, $htmlType)) {
2602 $fileValues = CRM_Core_BAO_File
::path($value, $params['activityID']);
2603 $customParams["custom_{$key}_-1"] = array(
2604 'name' => $fileValues[0],
2605 'path' => $fileValues[1],
2609 $customParams["custom_{$key}_-1"] = $value;
2613 CRM_Core_BAO_CustomValueTable
::postProcess($customParams, CRM_Core_DAO
::$_nullArray, 'civicrm_activity',
2614 $params['mainActivityId'], 'Activity'
2618 // copy activity attachments ( if any )
2619 CRM_Core_BAO_File
::copyEntityFile('civicrm_activity', $params['activityID'], 'civicrm_activity', $params['mainActivityId']);
2623 * @param $activityId
2624 * @param null $recordTypeID
2625 * @param string $column
2629 public static function getActivityContact($activityId, $recordTypeID = NULL, $column = 'contact_id') {
2630 $activityContact = new CRM_Activity_BAO_ActivityContact();
2631 $activityContact->activity_id
= $activityId;
2632 if ($recordTypeID) {
2633 $activityContact->record_type_id
= $recordTypeID;
2635 if ($activityContact->find(TRUE)) {
2636 return $activityContact->$column;
2642 * @param $activityId
2646 public static function getSourceContactID($activityId) {
2647 static $sourceID = NULL;
2649 $activityContacts = CRM_Core_OptionGroup
::values('activity_contacts', FALSE, FALSE, FALSE, NULL, 'name');
2650 $sourceID = CRM_Utils_Array
::key('Activity Source', $activityContacts);
2653 return self
::getActivityContact($activityId, $sourceID);
2657 * @param array $params
2659 function setApiFilter(&$params) {
2660 if (CRM_Utils_Array
::value('target_contact_id', $params)) {
2662 $activityContacts = CRM_Core_OptionGroup
::values('activity_contacts', FALSE, FALSE, FALSE, NULL, 'name');
2663 $targetID = CRM_Utils_Array
::key('Activity Targets', $activityContacts);
2664 $obj = new CRM_Activity_BAO_ActivityContact();
2665 $params['return.target_contact_id'] = 1;
2666 $this->joinAdd($obj, 'LEFT');
2667 $this->selectAdd('civicrm_activity.*');
2668 $this->whereAdd(" civicrm_activity_contact.contact_id = {$params['target_contact_id']} AND civicrm_activity_contact.record_type_id = {$targetID}");