3 +--------------------------------------------------------------------+
4 | CiviCRM version 4.6 |
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
62 * (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
77 * (reference ) an assoc array of name/value pairs.
78 * @param array $defaults
79 * (reference ) an assoc array to hold the flattened values.
81 * @return CRM_Activity_DAO_Activity object
83 public static function retrieve(&$params, &$defaults) {
84 $activity = new CRM_Activity_DAO_Activity();
85 $activity->copyValues($params);
87 if ($activity->find(TRUE)) {
88 $activityContacts = CRM_Core_OptionGroup
::values('activity_contacts', FALSE, FALSE, FALSE, NULL, 'name');
89 $targetID = CRM_Utils_Array
::key('Activity Targets', $activityContacts);
90 $sourceID = CRM_Utils_Array
::key('Activity Source', $activityContacts);
91 $assigneeID = CRM_Utils_Array
::key('Activity Assignees', $activityContacts);
93 // TODO: at some stage we'll have to deal
94 // TODO: with multiple values for assignees and targets, but
95 // TODO: for now, let's just fetch first row
96 $defaults['assignee_contact'] = CRM_Activity_BAO_ActivityContact
::retrieveContactIdsByActivityId($activity->id
, $assigneeID);
97 $assignee_contact_names = CRM_Activity_BAO_ActivityContact
::getNames($activity->id
, $assigneeID);
98 $defaults['assignee_contact_value'] = implode('; ', $assignee_contact_names);
99 $sourceContactId = self
::getActivityContact($activity->id
, $sourceID);
100 if ($activity->activity_type_id
!= CRM_Core_OptionGroup
::getValue('activity_type', 'Bulk Email', 'name')) {
101 $defaults['target_contact'] = CRM_Activity_BAO_ActivityContact
::retrieveContactIdsByActivityId($activity->id
, $targetID);
102 $target_contact_names = CRM_Activity_BAO_ActivityContact
::getNames($activity->id
, $targetID);
103 $defaults['target_contact_value'] = implode('; ', $target_contact_names);
105 elseif (CRM_Core_Permission
::check('access CiviMail') ||
106 (CRM_Mailing_Info
::workflowEnabled() &&
107 CRM_Core_Permission
::check('create mailings')
110 $defaults['mailingId'] = CRM_Utils_System
::url('civicrm/mailing/report',
111 "mid={$activity->source_record_id}&reset=1&atype={$activity->activity_type_id}&aid={$activity->id}&cid={$sourceContactId}&context=activity"
115 $defaults['target_contact_value'] = ts('(recipients)');
118 $sourceContactId = self
::getActivityContact($activity->id
, $sourceID);
119 $defaults['source_contact_id'] = $sourceContactId;
121 if ($sourceContactId &&
122 !CRM_Core_DAO
::getFieldValue('CRM_Contact_DAO_Contact',
127 $defaults['source_contact'] = CRM_Core_DAO
::getFieldValue('CRM_Contact_DAO_Contact',
134 $defaults['case_subject'] = CRM_Case_BAO_Case
::getCaseSubject($activity->id
);
136 CRM_Core_DAO
::storeValues($activity, $defaults);
144 * Delete the activity
146 * @param array $params
148 * @param bool $moveToTrash
152 public static function deleteActivity(&$params, $moveToTrash = FALSE) {
154 if (!empty($params['id']) && !is_array($params['id'])) {
155 CRM_Utils_Hook
::pre('delete', 'Activity', $params['id'], $params);
158 CRM_Utils_Hook
::pre('delete', 'Activity', NULL, $params);
161 $transaction = new CRM_Core_Transaction();
162 if (is_array(CRM_Utils_Array
::value('source_record_id', $params))) {
163 $sourceRecordIds = implode(',', $params['source_record_id']);
166 $sourceRecordIds = CRM_Utils_Array
::value('source_record_id', $params);
171 if (!isset($params['id'])) {
172 if (is_array($params['activity_type_id'])) {
173 $activityTypes = implode(',', $params['activity_type_id']);
176 $activityTypes = $params['activity_type_id'];
179 $query = "DELETE FROM civicrm_activity WHERE source_record_id IN ({$sourceRecordIds}) AND activity_type_id IN ( {$activityTypes} )";
180 $dao = CRM_Core_DAO
::executeQuery($query);
183 $activity = new CRM_Activity_DAO_Activity();
184 $activity->copyValues($params);
185 $result = $activity->delete();
188 $activity->case_id
= CRM_Case_BAO_Case
::getCaseIdByActivityId($activity->id
);
190 // CRM-13994 delete activity entity_tag
191 $query = "DELETE FROM civicrm_entity_tag WHERE entity_table = 'civicrm_activity' AND entity_id = {$activity->id}";
192 $dao = CRM_Core_DAO
::executeQuery($query);
196 $activity = new CRM_Activity_DAO_Activity();
197 $activity->copyValues($params);
199 $activity->is_deleted
= 1;
200 $result = $activity->save();
202 // CRM-4525 log activity delete
203 $logMsg = 'Case Activity deleted for';
206 $activityContacts = CRM_Core_OptionGroup
::values('activity_contacts', FALSE, FALSE, FALSE, NULL, 'name');
207 $sourceID = CRM_Utils_Array
::key('Activity Source', $activityContacts);
208 $assigneeID = CRM_Utils_Array
::key('Activity Assignees', $activityContacts);
209 $targetID = CRM_Utils_Array
::key('Activity Targets', $activityContacts);
210 $sourceContactId = self
::getActivityContact($activity->id
, $sourceID);
211 if ($sourceContactId) {
212 $msgs[] = " source={$sourceContactId}";
215 //get target contacts.
216 $targetContactIds = CRM_Activity_BAO_ActivityContact
::getNames($activity->id
, $targetID);
217 if (!empty($targetContactIds)) {
218 $msgs[] = " target =" . implode(',', array_keys($targetContactIds));
220 //get assignee contacts.
221 $assigneeContactIds = CRM_Activity_BAO_ActivityContact
::getNames($activity->id
, $assigneeID);
222 if (!empty($assigneeContactIds)) {
223 $msgs[] = " assignee =" . implode(',', array_keys($assigneeContactIds));
226 $logMsg .= implode(', ', $msgs);
228 self
::logActivityAction($activity, $logMsg);
231 // delete the recently created Activity
233 $activityRecent = array(
234 'id' => $activity->id
,
235 'type' => 'Activity',
237 CRM_Utils_Recent
::del($activityRecent);
240 $transaction->commit();
241 if (isset($activity)) {
243 $activity->case_id
= CRM_Case_BAO_Case
::getCaseIdByActivityId($activity->id
);
244 CRM_Utils_Hook
::post('delete', 'Activity', $activity->id
, $activity);
251 * Delete activity assignment record
253 * @param int $activityId
254 * @param int $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
271 * Associated array of the submitted values.
273 * @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
649 * Array of parameters.
651 * - contact_id int contact_id whose activities we want to retrieve
652 * - offset int which row to start from ?
653 * - rowCount int how many rows to fetch
654 * - sort object|array object or array describing sort order for sql query.
655 * - admin boolean if contact is admin
656 * - caseId int case ID
657 * - context string page on which selector is build
658 * - activity_type_id int|string the activitiy types we want to restrict by
660 * @return array (reference) $values the relevant data object values of open activities
664 public 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 public 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
941 * Array of parameters.
943 * - contact_id int contact_id whose activities we want to retrieve
944 * - admin boolean if contact is admin
945 * - caseId int case ID
946 * - context string page on which selector is build
947 * - activity_type_id int|string the activity types we want to restrict by
949 * @return int count of activities
953 public 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 * Get the activity sql clause to pick activities
976 * @param array $input
977 * Array of parameters.
979 * - contact_id int contact_id whose activities we want to retrieve
980 * - admin boolean if contact is admin
981 * - caseId int case ID
982 * - context string page on which selector is build
983 * - count boolean are we interested in the count clause only?
984 * - activity_type_id int|string the activity types we want to restrict by
986 * @return int count of activities
990 public 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
1158 * The array of contact details to send the email.
1159 * @param string $subject
1160 * The subject of the message.
1163 * @param string $emailAddress
1164 * Use this 'to' email address instead of the default Primary address.
1165 * @param int $userID
1166 * Use this userID if set.
1167 * @param string $from
1168 * @param array $attachments
1169 * The array of attachments if any.
1172 * @param string $bcc
1174 * @param array $contactIds
1176 * @param string $additionalDetails
1177 * The additional information of CC and BCC appended to the activity Details.
1179 * @return array ( sent, activityId) if any email is sent and activityId
1182 static function sendEmail(
1190 $attachments = NULL,
1193 $contactIds, // FIXME a param with no default shouldn't be last
1194 $additionalDetails = NULL
1196 // get the contact details of logged in contact, which we set as from email
1197 if ($userID == NULL) {
1198 $session = CRM_Core_Session
::singleton();
1199 $userID = $session->get('userID');
1202 list($fromDisplayName, $fromEmail, $fromDoNotEmail) = CRM_Contact_BAO_Contact
::getContactDetails($userID);
1204 return array(count($contactDetails), 0, count($contactDetails));
1206 if (!trim($fromDisplayName)) {
1207 $fromDisplayName = $fromEmail;
1211 // token replacement of addressee/email/postal greetings
1212 // get the tokens added in subject and message
1213 $subjectToken = CRM_Utils_Token
::getTokens($subject);
1214 $messageToken = CRM_Utils_Token
::getTokens($text);
1215 $messageToken = array_merge($messageToken, CRM_Utils_Token
::getTokens($html));
1216 $allTokens = array_merge($messageToken, $subjectToken);
1219 $from = "$fromDisplayName <$fromEmail>";
1222 //create the meta level record first ( email activity )
1223 $activityTypeID = CRM_Core_OptionGroup
::getValue('activity_type',
1228 // CRM-6265: save both text and HTML parts in details (if present)
1229 if ($html and $text) {
1230 $details = "-ALTERNATIVE ITEM 0-\n$html$additionalDetails\n-ALTERNATIVE ITEM 1-\n$text$additionalDetails\n-ALTERNATIVE END-\n";
1233 $details = $html ?
$html : $text;
1234 $details .= $additionalDetails;
1237 $activityParams = array(
1238 'source_contact_id' => $userID,
1239 'activity_type_id' => $activityTypeID,
1240 'activity_date_time' => date('YmdHis'),
1241 'subject' => $subject,
1242 'details' => $details,
1243 // FIXME: check for name Completed and get ID from that lookup
1247 // CRM-5916: strip [case #…] before saving the activity (if present in subject)
1248 $activityParams['subject'] = preg_replace('/\[case #([0-9a-h]{7})\] /', '', $activityParams['subject']);
1250 // add the attachments to activity params here
1252 // first process them
1253 $activityParams = array_merge($activityParams,
1258 $activity = self
::create($activityParams);
1260 // get the set of attachments from where they are stored
1261 $attachments = CRM_Core_BAO_File
::getEntityFile('civicrm_activity',
1264 $returnProperties = array();
1265 if (isset($messageToken['contact'])) {
1266 foreach ($messageToken['contact'] as $key => $value) {
1267 $returnProperties[$value] = 1;
1271 if (isset($subjectToken['contact'])) {
1272 foreach ($subjectToken['contact'] as $key => $value) {
1273 if (!isset($returnProperties[$value])) {
1274 $returnProperties[$value] = 1;
1280 // get token details for contacts, call only if tokens are used
1282 if (!empty($returnProperties) ||
!empty($tokens) ||
!empty($allTokens)) {
1283 list($details) = CRM_Utils_Token
::getTokenDetails(
1288 'CRM_Activity_BAO_Activity'
1294 CRM_Utils_Hook
::tokens($tokens);
1295 $categories = array_keys($tokens);
1297 $escapeSmarty = FALSE;
1298 if (defined('CIVICRM_MAIL_SMARTY') && CIVICRM_MAIL_SMARTY
) {
1299 $smarty = CRM_Core_Smarty
::singleton();
1300 $escapeSmarty = TRUE;
1303 $sent = $notSent = array();
1304 foreach ($contactDetails as $values) {
1305 $contactId = $values['contact_id'];
1306 $emailAddress = $values['email'];
1308 if (!empty($details) && is_array($details["{$contactId}"])) {
1309 // unset email from details since it always returns primary email address
1310 unset($details["{$contactId}"]['email']);
1311 unset($details["{$contactId}"]['email_id']);
1312 $values = array_merge($values, $details["{$contactId}"]);
1315 $tokenSubject = CRM_Utils_Token
::replaceContactTokens($subject, $values, FALSE, $subjectToken, FALSE, $escapeSmarty);
1316 $tokenSubject = CRM_Utils_Token
::replaceHookTokens($tokenSubject, $values, $categories, FALSE, $escapeSmarty);
1319 if ($values['preferred_mail_format'] == 'Text' ||
$values['preferred_mail_format'] == 'Both') {
1320 $tokenText = CRM_Utils_Token
::replaceContactTokens($text, $values, FALSE, $messageToken, FALSE, $escapeSmarty);
1321 $tokenText = CRM_Utils_Token
::replaceHookTokens($tokenText, $values, $categories, FALSE, $escapeSmarty);
1327 if ($values['preferred_mail_format'] == 'HTML' ||
$values['preferred_mail_format'] == 'Both') {
1328 $tokenHtml = CRM_Utils_Token
::replaceContactTokens($html, $values, TRUE, $messageToken, FALSE, $escapeSmarty);
1329 $tokenHtml = CRM_Utils_Token
::replaceHookTokens($tokenHtml, $values, $categories, TRUE, $escapeSmarty);
1335 if (defined('CIVICRM_MAIL_SMARTY') && CIVICRM_MAIL_SMARTY
) {
1336 // also add the contact tokens to the template
1337 $smarty->assign_by_ref('contact', $values);
1339 $tokenSubject = $smarty->fetch("string:$tokenSubject");
1340 $tokenText = $smarty->fetch("string:$tokenText");
1341 $tokenHtml = $smarty->fetch("string:$tokenHtml");
1345 if (self
::sendMessage(
1363 return array($sent, $activity->id
);
1367 * @param array $contactDetails
1368 * @param array $activityParams
1369 * @param array $smsParams
1370 * @param $contactIds
1371 * @param int $userID
1374 * @throws CRM_Core_Exception
1376 static function sendSMS(
1379 &$smsParams = array(),
1383 if ($userID == NULL) {
1384 $session = CRM_Core_Session
::singleton();
1385 $userID = $session->get('userID');
1388 $text = &$activityParams['sms_text_message'];
1391 // token replacement of addressee/email/postal greetings
1392 // get the tokens added in subject and message
1393 $messageToken = CRM_Utils_Token
::getTokens($text);
1395 //create the meta level record first ( sms activity )
1396 $activityTypeID = CRM_Core_OptionGroup
::getValue('activity_type',
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 // Only send if the phone is of type mobile
1458 $phoneTypes = CRM_Core_OptionGroup
::values('phone_type', TRUE, FALSE, FALSE, NULL, 'name');
1459 if ($values['phone_type_id'] == CRM_Utils_Array
::value('Mobile', $phoneTypes)) {
1460 $smsParams['To'] = $values['phone'];
1463 $smsParams['To'] = '';
1466 $sendResult = self
::sendSMSMessage(
1474 if (PEAR
::isError($sendResult)) {
1475 // Collect all of the PEAR_Error objects
1476 $errMsgs[] = $sendResult;
1483 // If at least one message was sent and no errors
1484 // were generated then return a boolean value of TRUE.
1485 // Otherwise, return FALSE (no messages sent) or
1486 // and array of 1 or more PEAR_Error objects.
1488 if ($success > 0 && count($errMsgs) == 0) {
1491 elseif (count($errMsgs) > 0) {
1495 return array($sent, $activity->id
, $success);
1499 * Send the sms message to a specific contact
1502 * The contact id of the recipient.
1505 * @param array $smsParams
1506 * The params used for sending sms.
1507 * @param int $activityID
1508 * The activity ID that tracks the message.
1509 * @param int $userID
1511 * @return mixed true on success or PEAR_Error object
1514 static function sendSMSMessage(
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 $recipient = $smsParams['To'];
1550 $smsParams['contact_id'] = $toID;
1551 $smsParams['parent_activity_id'] = $activityID;
1553 $providerObj = CRM_SMS_Provider
::singleton(array('provider_id' => $smsParams['provider_id']));
1554 $sendResult = $providerObj->send($recipient, $smsParams, $tokenText, NULL, $userID);
1555 if (PEAR
::isError($sendResult)) {
1559 $activityContacts = CRM_Core_OptionGroup
::values('activity_contacts', FALSE, FALSE, FALSE, NULL, 'name');
1560 $targetID = CRM_Utils_Array
::key('Activity Targets', $activityContacts);
1563 // add activity target record for every sms that is send
1564 $activityTargetParams = array(
1565 'activity_id' => $activityID,
1566 'contact_id' => $toID,
1567 'record_type_id' => $targetID,
1569 CRM_Activity_BAO_ActivityContact
::create($activityTargetParams);
1575 * Send the message to a specific contact
1577 * @param string $from
1578 * The name and email of the sender.
1579 * @param int $fromID
1581 * The contact id of the recipient.
1582 * @param string $subject
1583 * The subject of the message.
1584 * @param $text_message
1585 * @param $html_message
1586 * @param string $emailAddress
1587 * Use this 'to' email address instead of the default Primary address.
1588 * @param int $activityID
1589 * The activity ID that tracks the message.
1590 * @param null $attachments
1594 * @return boolean true if successfull else false.
1597 static function sendMessage(
1606 $attachments = NULL,
1610 list($toDisplayName, $toEmail, $toDoNotEmail) = CRM_Contact_BAO_Contact
::getContactDetails($toID);
1611 if ($emailAddress) {
1612 $toEmail = trim($emailAddress);
1615 // make sure both email addresses are valid
1616 // and that the recipient wants to receive email
1617 if (empty($toEmail) or $toDoNotEmail) {
1620 if (!trim($toDisplayName)) {
1621 $toDisplayName = $toEmail;
1624 $activityContacts = CRM_Core_OptionGroup
::values('activity_contacts', FALSE, FALSE, FALSE, NULL, 'name');
1625 //$sourceID = CRM_Utils_Array::key('Activity Source', $activityContacts);
1626 //$assigneeID = CRM_Utils_Array::key('Activity Assignees', $activityContacts);
1627 $targetID = CRM_Utils_Array
::key('Activity Targets', $activityContacts);
1629 // create the params array
1630 $mailParams = array(
1631 'groupName' => 'Activity Email Sender',
1633 'toName' => $toDisplayName,
1634 'toEmail' => $toEmail,
1635 'subject' => $subject,
1638 'text' => $text_message,
1639 'html' => $html_message,
1640 'attachments' => $attachments,
1643 if (!CRM_Utils_Mail
::send($mailParams)) {
1647 // add activity target record for every mail that is send
1648 $activityTargetParams = array(
1649 'activity_id' => $activityID,
1650 'contact_id' => $toID,
1651 'record_type_id' => $targetID,
1653 CRM_Activity_BAO_ActivityContact
::create($activityTargetParams);
1658 * Combine all the importable fields from the lower levels object
1660 * The ordering is important, since currently we do not have a weight
1661 * scheme. Adding weight is super important and should be done in the
1662 * next week or so, before this can be called complete.
1664 * @param bool $status
1666 * @return array array of importable Fields
1669 public static function &importableFields($status = FALSE) {
1670 if (!self
::$_importableFields) {
1671 if (!self
::$_importableFields) {
1672 self
::$_importableFields = array();
1675 $fields = array('' => array('title' => ts('- do not import -')));
1678 $fields = array('' => array('title' => ts('- Activity Fields -')));
1681 $tmpFields = CRM_Activity_DAO_Activity
::import();
1682 $contactFields = CRM_Contact_BAO_Contact
::importableFields('Individual', NULL);
1684 // Using new Dedupe rule.
1685 $ruleParams = array(
1686 'contact_type' => 'Individual',
1687 'used' => 'Unsupervised',
1689 $fieldsArray = CRM_Dedupe_BAO_Rule
::dedupeRuleFields($ruleParams);
1691 $tmpConatctField = array();
1692 if (is_array($fieldsArray)) {
1693 foreach ($fieldsArray as $value) {
1694 $customFieldId = CRM_Core_DAO
::getFieldValue('CRM_Core_DAO_CustomField',
1699 $value = $customFieldId ?
'custom_' . $customFieldId : $value;
1700 $tmpConatctField[trim($value)] = $contactFields[trim($value)];
1701 $tmpConatctField[trim($value)]['title'] = $tmpConatctField[trim($value)]['title'] . " (match to contact)";
1704 $tmpConatctField['external_identifier'] = $contactFields['external_identifier'];
1705 $tmpConatctField['external_identifier']['title'] = $contactFields['external_identifier']['title'] . " (match to contact)";
1706 $fields = array_merge($fields, $tmpConatctField);
1707 $fields = array_merge($fields, $tmpFields);
1708 $fields = array_merge($fields, CRM_Core_BAO_CustomField
::getFieldsForImport('Activity'));
1709 self
::$_importableFields = $fields;
1711 return self
::$_importableFields;
1715 * To get the Activities of a target contact
1717 * @param int $contactId
1718 * Id of the contact whose activities need to find.
1720 * @return array array of activity fields
1722 public static function getContactActivity($contactId) {
1723 $activities = array();
1724 $activityContacts = CRM_Core_OptionGroup
::values('activity_contacts', FALSE, FALSE, FALSE, NULL, 'name');
1725 $sourceID = CRM_Utils_Array
::key('Activity Source', $activityContacts);
1726 $assigneeID = CRM_Utils_Array
::key('Activity Assignees', $activityContacts);
1727 $targetID = CRM_Utils_Array
::key('Activity Targets', $activityContacts);
1730 // First look for activities where contactId is one of the targets
1732 SELECT activity_id, record_type_id
1733 FROM civicrm_activity_contact
1734 WHERE contact_id = $contactId
1736 $dao = CRM_Core_DAO
::executeQuery($query);
1737 while ($dao->fetch()) {
1738 if ($dao->record_type_id
== $targetID) {
1739 $activities[$dao->activity_id
]['targets'][$contactId] = $contactId;
1741 elseif ($dao->record_type_id
== $assigneeID) {
1742 $activities[$dao->activity_id
]['asignees'][$contactId] = $contactId;
1745 // do source stuff here
1746 $activities[$dao->activity_id
]['source_contact_id'] = $contactId;
1750 $activityIds = array_keys($activities);
1751 if (count($activityIds) < 1) {
1755 $activityIds = implode(',', $activityIds);
1757 SELECT activity.id as activity_id,
1759 subject, location, activity_date_time, details, status_id
1760 FROM civicrm_activity activity
1761 WHERE activity.id IN ($activityIds)";
1763 $dao = CRM_Core_DAO
::executeQuery($query);
1765 $activityTypes = CRM_Core_OptionGroup
::values('activity_type');
1766 $activityStatuses = CRM_Core_OptionGroup
::values('activity_status');
1768 while ($dao->fetch()) {
1769 $activities[$dao->activity_id
]['id'] = $dao->activity_id
;
1770 $activities[$dao->activity_id
]['activity_type_id'] = $dao->activity_type_id
;
1771 $activities[$dao->activity_id
]['subject'] = $dao->subject
;
1772 $activities[$dao->activity_id
]['location'] = $dao->location
;
1773 $activities[$dao->activity_id
]['activity_date_time'] = $dao->activity_date_time
;
1774 $activities[$dao->activity_id
]['details'] = $dao->details
;
1775 $activities[$dao->activity_id
]['status_id'] = $dao->status_id
;
1776 $activities[$dao->activity_id
]['activity_name'] = $activityTypes[$dao->activity_type_id
];
1777 $activities[$dao->activity_id
]['status'] = $activityStatuses[$dao->status_id
];
1779 // set to null if not set
1780 if (!isset($activities[$dao->activity_id
]['source_contact_id'])) {
1781 $activities[$dao->activity_id
]['source_contact_id'] = NULL;
1788 * Add activity for Membership/Event/Contribution
1790 * @param object $activity
1791 * (reference) particular component object.
1792 * @param string $activityType
1793 * For Membership Signup or Renewal.
1794 * @param int $targetContactID
1799 static function addActivity(
1801 $activityType = 'Membership Signup',
1802 $targetContactID = NULL
1804 if ($activity->__table
== 'civicrm_membership') {
1805 $membershipType = CRM_Member_PseudoConstant
::membershipType($activity->membership_type_id
);
1807 if (!$membershipType) {
1808 $membershipType = ts('Membership');
1811 $subject = "{$membershipType}";
1813 if (!empty($activity->source
) && $activity->source
!= 'null') {
1814 $subject .= " - {$activity->source}";
1817 if ($activity->owner_membership_id
) {
1820 FROM civicrm_contact, civicrm_membership
1821 WHERE civicrm_contact.id = civicrm_membership.contact_id
1822 AND civicrm_membership.id = $activity->owner_membership_id
1824 $displayName = CRM_Core_DAO
::singleValueQuery($query);
1825 $subject .= " (by {$displayName})";
1828 $subject .= " - Status: " . CRM_Core_DAO
::getFieldValue('CRM_Member_DAO_MembershipStatus', $activity->status_id
, 'label');
1829 // CRM-72097 changed from start date to today
1830 $date = date('YmdHis');
1831 $component = 'Membership';
1833 elseif ($activity->__table
== 'civicrm_participant') {
1834 $event = CRM_Event_BAO_Event
::getEvents(1, $activity->event_id
, TRUE, FALSE);
1836 $roles = CRM_Event_PseudoConstant
::participantRole();
1837 $status = CRM_Event_PseudoConstant
::participantStatus();
1839 $subject = $event[$activity->event_id
];
1840 if (!empty($roles[$activity->role_id
])) {
1841 $subject .= ' - ' . $roles[$activity->role_id
];
1843 if (!empty($status[$activity->status_id
])) {
1844 $subject .= ' - ' . $status[$activity->status_id
];
1846 $date = date('YmdHis');
1847 if ($activityType != 'Email') {
1848 $activityType = 'Event Registration';
1850 $component = 'Event';
1852 elseif ($activity->__table
== 'civicrm_contribution') {
1853 //create activity record only for Completed Contributions
1854 if ($activity->contribution_status_id
!= 1) {
1860 $subject .= CRM_Utils_Money
::format($activity->total_amount
, $activity->currency
);
1861 if (!empty($activity->source
) && $activity->source
!= 'null') {
1862 $subject .= " - {$activity->source}";
1864 $date = CRM_Utils_Date
::isoToMysql($activity->receive_date
);
1865 $activityType = $component = 'Contribution';
1867 $activityParams = array(
1868 'source_contact_id' => $activity->contact_id
,
1869 'source_record_id' => $activity->id
,
1870 'activity_type_id' => CRM_Core_OptionGroup
::getValue('activity_type',
1874 'subject' => $subject,
1875 'activity_date_time' => $date,
1876 'is_test' => $activity->is_test
,
1877 'status_id' => CRM_Core_OptionGroup
::getValue('activity_status',
1881 'skipRecentView' => TRUE,
1882 'campaign_id' => $activity->campaign_id
,
1885 // create activity with target contacts
1886 $session = CRM_Core_Session
::singleton();
1887 $id = $session->get('userID');
1889 $activityParams['source_contact_id'] = $id;
1890 $activityParams['target_contact_id'][] = $activity->contact_id
;
1894 if (property_exists($activity, 'details')) {
1895 $activityParams['details'] = $activity->details
;
1898 if ($targetContactID) {
1899 $activityParams['target_contact_id'][] = $targetContactID;
1901 if (is_a(self
::create($activityParams), 'CRM_Core_Error')) {
1902 CRM_Core_Error
::fatal("Failed creating Activity for $component of id {$activity->id}");
1908 * Get Parent activity for currently viewed activity
1910 * @param int $activityId
1911 * Current activity id.
1913 * @return int $parentId Id of parent activity otherwise false.
1915 public static function getParentActivity($activityId) {
1916 static $parentActivities = array();
1918 $activityId = CRM_Utils_Type
::escape($activityId, 'Integer');
1920 if (!array_key_exists($activityId, $parentActivities)) {
1921 $parentActivities[$activityId] = array();
1923 $parentId = CRM_Core_DAO
::getFieldValue('CRM_Activity_DAO_Activity',
1928 $parentActivities[$activityId] = $parentId ?
$parentId : FALSE;
1931 return $parentActivities[$activityId];
1935 * Get total count of prior revision of currently viewd activity
1937 * @param $activityID
1938 * Current activity id.
1940 * @return int $params count of prior activities otherwise false.
1942 public static function getPriorCount($activityID) {
1943 static $priorCounts = array();
1945 $activityID = CRM_Utils_Type
::escape($activityID, 'Integer');
1947 if (!array_key_exists($activityID, $priorCounts)) {
1948 $priorCounts[$activityID] = array();
1949 $originalID = CRM_Core_DAO
::getFieldValue('CRM_Activity_DAO_Activity',
1956 SELECT count( id ) AS cnt
1957 FROM civicrm_activity
1958 WHERE ( id = {$originalID} OR original_id = {$originalID} )
1959 AND is_current_revision = 0
1960 AND id < {$activityID}
1962 $params = array(1 => array($originalID, 'Integer'));
1963 $count = CRM_Core_DAO
::singleValueQuery($query, $params);
1965 $priorCounts[$activityID] = $count ?
$count : 0;
1968 return $priorCounts[$activityID];
1972 * Get all prior activities of currently viewed activity
1974 * @param $activityID
1975 * Current activity id.
1976 * @param bool $onlyPriorRevisions
1978 * @return array $result prior activities info.
1980 public static function getPriorAcitivities($activityID, $onlyPriorRevisions = FALSE) {
1981 static $priorActivities = array();
1983 $activityID = CRM_Utils_Type
::escape($activityID, 'Integer');
1984 $index = $activityID . '_' . (int) $onlyPriorRevisions;
1986 if (!array_key_exists($index, $priorActivities)) {
1987 $priorActivities[$index] = array();
1989 $originalID = CRM_Core_DAO
::getFieldValue('CRM_Activity_DAO_Activity',
1995 SELECT c.display_name as name, cl.modified_date as date, ca.id as activityID
1996 FROM civicrm_log cl, civicrm_contact c, civicrm_activity ca
1997 WHERE (ca.id = %1 OR ca.original_id = %1)
1998 AND cl.entity_table = 'civicrm_activity'
1999 AND cl.entity_id = ca.id
2000 AND cl.modified_id = c.id
2002 if ($onlyPriorRevisions) {
2003 $query .= " AND ca.id < {$activityID}";
2005 $query .= " ORDER BY ca.id DESC";
2007 $params = array(1 => array($originalID, 'Integer'));
2008 $dao = CRM_Core_DAO
::executeQuery($query, $params);
2010 while ($dao->fetch()) {
2011 $priorActivities[$index][$dao->activityID
]['id'] = $dao->activityID
;
2012 $priorActivities[$index][$dao->activityID
]['name'] = $dao->name
;
2013 $priorActivities[$index][$dao->activityID
]['date'] = $dao->date
;
2018 return $priorActivities[$index];
2022 * Find the latest revision of a given activity
2024 * @param int $activityID
2025 * Prior activity id.
2027 * @return int current activity id.
2029 public static function getLatestActivityId($activityID) {
2030 static $latestActivityIds = array();
2032 $activityID = CRM_Utils_Type
::escape($activityID, 'Integer');
2034 if (!array_key_exists($activityID, $latestActivityIds)) {
2035 $latestActivityIds[$activityID] = array();
2037 $originalID = CRM_Core_DAO
::getFieldValue('CRM_Activity_DAO_Activity',
2042 $activityID = $originalID;
2044 $params = array(1 => array($activityID, 'Integer'));
2045 $query = "SELECT id from civicrm_activity where original_id = %1 and is_current_revision = 1";
2047 $latestActivityIds[$activityID] = CRM_Core_DAO
::singleValueQuery($query, $params);
2050 return $latestActivityIds[$activityID];
2054 * Create a follow up a given activity
2056 * @param $activityId
2057 * Int activity id of parent activity.
2058 * @param array $params
2060 * @return $this|null|object
2063 public static function createFollowupActivity($activityId, $params) {
2068 $session = CRM_Core_Session
::singleton();
2070 $followupParams = array();
2071 $followupParams['parent_id'] = $activityId;
2072 $followupParams['source_contact_id'] = $session->get('userID');
2073 $followupParams['status_id'] = CRM_Core_OptionGroup
::getValue('activity_status', 'Scheduled', 'name');
2075 $followupParams['activity_type_id'] = $params['followup_activity_type_id'];
2076 // Get Subject of Follow-up Activiity, CRM-4491
2077 $followupParams['subject'] = CRM_Utils_Array
::value('followup_activity_subject', $params);
2078 $followupParams['assignee_contact_id'] = CRM_Utils_Array
::value('followup_assignee_contact_id', $params);
2080 //create target contact for followup
2081 if (!empty($params['target_contact_id'])) {
2082 $followupParams['target_contact_id'] = $params['target_contact_id'];
2085 $followupParams['activity_date_time'] = CRM_Utils_Date
::processDate($params['followup_date'],
2086 $params['followup_date_time']
2088 $followupActivity = self
::create($followupParams);
2090 return $followupActivity;
2094 * Get Activity specific File according activity type Id.
2096 * @param int $activityTypeId
2098 * @param string $crmDir
2100 * @return string|bool if file exists returns $activityTypeFile activity filename otherwise false.
2104 public static function getFileForActivityTypeId($activityTypeId, $crmDir = 'Activity') {
2105 $activityTypes = CRM_Case_PseudoConstant
::caseActivityType(FALSE, TRUE);
2107 if ($activityTypes[$activityTypeId]['name']) {
2108 $activityTypeFile = CRM_Utils_String
::munge(ucwords($activityTypes[$activityTypeId]['name']), '', 0);
2114 global $civicrm_root;
2115 $config = CRM_Core_Config
::singleton();
2116 if (!file_exists(rtrim($civicrm_root, '/') . "/CRM/{$crmDir}/Form/Activity/{$activityTypeFile}.php")) {
2117 if (empty($config->customPHPPathDir
)) {
2120 elseif (!file_exists(rtrim($config->customPHPPathDir
, '/') . "/CRM/{$crmDir}/Form/Activity/{$activityTypeFile}.php")) {
2125 return $activityTypeFile;
2129 * Restore the activity
2131 * @param array $params
2137 public static function restoreActivity(&$params) {
2138 $activity = new CRM_Activity_DAO_Activity();
2139 $activity->copyValues($params);
2141 $activity->is_deleted
= 0;
2142 $result = $activity->save();
2148 * Get the exportable fields for Activities
2150 * @param string $name
2151 * If it is called by case $name = Case else $name = Activity.
2153 * @return array array of exportable Fields
2156 public static function &exportableFields($name = 'Activity') {
2157 if (!isset(self
::$_exportableFields[$name])) {
2158 self
::$_exportableFields[$name] = array();
2160 // TO DO, ideally we should retrieve all fields from xml, in this case since activity processing is done
2161 // my case hence we have defined fields as case_*
2162 if ($name == 'Activity') {
2163 $exportableFields = CRM_Activity_DAO_Activity
::export();
2164 $exportableFields['source_contact_id']['title'] = ts('Source Contact ID');
2165 $exportableFields['source_contact'] = array(
2166 'title' => ts('Source Contact'),
2167 'type' => CRM_Utils_Type
::T_STRING
,
2171 $Activityfields = array(
2172 'activity_type' => array('title' => ts('Activity Type'), 'type' => CRM_Utils_Type
::T_STRING
),
2173 'activity_status' => array('title' => ts('Activity Status'), 'type' => CRM_Utils_Type
::T_STRING
),
2175 $fields = array_merge($Activityfields, $exportableFields);
2178 //set title to activity fields
2180 'case_activity_subject' => array('title' => ts('Activity Subject'), 'type' => CRM_Utils_Type
::T_STRING
),
2181 'case_source_contact_id' => array('title' => ts('Activity Reporter'), 'type' => CRM_Utils_Type
::T_STRING
),
2182 'case_recent_activity_date' => array('title' => ts('Activity Actual Date'), 'type' => CRM_Utils_Type
::T_DATE
),
2183 'case_scheduled_activity_date' => array(
2184 'title' => ts('Activity Scheduled Date'),
2185 'type' => CRM_Utils_Type
::T_DATE
,
2187 'case_recent_activity_type' => array('title' => ts('Activity Type'), 'type' => CRM_Utils_Type
::T_STRING
),
2188 'case_activity_status' => array('title' => ts('Activity Status'), 'type' => CRM_Utils_Type
::T_STRING
),
2189 'case_activity_duration' => array('title' => ts('Activity Duration'), 'type' => CRM_Utils_Type
::T_INT
),
2190 'case_activity_medium_id' => array('title' => ts('Activity Medium'), 'type' => CRM_Utils_Type
::T_INT
),
2191 'case_activity_details' => array('title' => ts('Activity Details'), 'type' => CRM_Utils_Type
::T_TEXT
),
2192 'case_activity_is_auto' => array(
2193 'title' => ts('Activity Auto-generated?'),
2194 'type' => CRM_Utils_Type
::T_BOOLEAN
,
2198 // add custom data for cases
2199 $fields = array_merge($fields, CRM_Core_BAO_CustomField
::getFieldsForImport('Case'));
2202 // add custom data for case activities
2203 $fields = array_merge($fields, CRM_Core_BAO_CustomField
::getFieldsForImport('Activity'));
2205 self
::$_exportableFields[$name] = $fields;
2207 return self
::$_exportableFields[$name];
2211 * Get the allowed profile fields for Activities
2213 * @return array array of activity profile Fields
2215 public static function getProfileFields() {
2216 $exportableFields = self
::exportableFields('Activity');
2217 $skipFields = array(
2220 'source_contact_id',
2222 'activity_campaign',
2224 'is_current_revision',
2225 'activity_is_deleted',
2227 $config = CRM_Core_Config
::singleton();
2228 if (!in_array('CiviCampaign', $config->enableComponents
)) {
2229 $skipFields[] = 'activity_engagement_level';
2232 foreach ($skipFields as $field) {
2233 if (isset($exportableFields[$field])) {
2234 unset($exportableFields[$field]);
2238 // hack to use 'activity_type_id' instead of 'activity_type'
2239 $exportableFields['activity_status_id'] = $exportableFields['activity_status'];
2240 unset($exportableFields['activity_status']);
2242 return $exportableFields;
2246 * This function deletes the activity record related to contact record,
2247 * when there are no target and assignee record w/ other contact.
2249 * @param int $contactId
2254 public static function cleanupActivity($contactId) {
2259 $activityContacts = CRM_Core_OptionGroup
::values('activity_contacts', FALSE, FALSE, FALSE, NULL, 'name');
2260 $sourceID = CRM_Utils_Array
::key('Activity Source', $activityContacts);
2262 $transaction = new CRM_Core_Transaction();
2264 // delete activity if there is no record in civicrm_activity_contact
2265 // pointing to any other contact record
2266 $activityContact = new CRM_Activity_DAO_ActivityContact();
2267 $activityContact->contact_id
= $contactId;
2268 $activityContact->record_type_id
= $sourceID;
2269 $activityContact->find();
2271 while ($activityContact->fetch()) {
2272 // delete activity_contact record for the deleted contact
2273 $activityContact->delete();
2275 $activityContactOther = new CRM_Activity_DAO_ActivityContact();
2276 $activityContactOther->activity_id
= $activityContact->activity_id
;
2278 // delete activity only if no other contacts connected
2279 if (!$activityContactOther->find(TRUE)) {
2280 $activityParams = array('id' => $activityContact->activity_id
);
2281 $result = self
::deleteActivity($activityParams);
2284 $activityContactOther->free();
2287 $activityContact->free();
2288 $transaction->commit();
2294 * Does user has sufficient permission for view/edit activity record?
2296 * @param int $activityId
2297 * Activity record id.
2298 * @param int $action
2301 * @return boolean $allow true/false
2303 public static function checkPermission($activityId, $action) {
2306 !in_array($action, array(CRM_Core_Action
::UPDATE
, CRM_Core_Action
::VIEW
))
2311 $activity = new CRM_Activity_DAO_Activity();
2312 $activity->id
= $activityId;
2313 if (!$activity->find(TRUE)) {
2317 //component related permissions.
2318 $compPermissions = array(
2319 'CiviCase' => array(
2320 'administer CiviCase',
2321 'access my cases and activities',
2322 'access all cases and activities',
2324 'CiviMail' => array('access CiviMail'),
2325 'CiviEvent' => array('access CiviEvent'),
2326 'CiviGrant' => array('access CiviGrant'),
2327 'CiviPledge' => array('access CiviPledge'),
2328 'CiviMember' => array('access CiviMember'),
2329 'CiviReport' => array('access CiviReport'),
2330 'CiviContribute' => array('access CiviContribute'),
2331 'CiviCampaign' => array('administer CiviCampaign'),
2334 //return early when it is case activity.
2335 $isCaseActivity = CRM_Case_BAO_Case
::isCaseActivity($activityId);
2336 //check for civicase related permission.
2337 if ($isCaseActivity) {
2339 foreach ($compPermissions['CiviCase'] as $per) {
2340 if (CRM_Core_Permission
::check($per)) {
2346 //check for case specific permissions.
2349 if ($action == CRM_Core_Action
::UPDATE
) {
2352 $allow = CRM_Case_BAO_Case
::checkPermission($activityId,
2354 $activity->activity_type_id
2361 //first check the component permission.
2364 FROM civicrm_option_value val
2365 INNER JOIN civicrm_option_group grp ON ( grp.id = val.option_group_id AND grp.name = %1 )
2366 WHERE val.value = %2";
2368 1 => array('activity_type', 'String'),
2369 2 => array($activity->activity_type_id
, 'Integer'),
2371 $componentId = CRM_Core_DAO
::singleValueQuery($sql, $params);
2374 $componentName = CRM_Core_Component
::getComponentName($componentId);
2375 $compPermission = CRM_Utils_Array
::value($componentName, $compPermissions);
2377 //here we are interesting in any single permission.
2378 if (is_array($compPermission)) {
2379 foreach ($compPermission as $per) {
2380 if (CRM_Core_Permission
::check($per)) {
2388 //check for this permission related to contact.
2389 $permission = CRM_Core_Permission
::VIEW
;
2390 if ($action == CRM_Core_Action
::UPDATE
) {
2391 $permission = CRM_Core_Permission
::EDIT
;
2394 $activityContacts = CRM_Core_OptionGroup
::values('activity_contacts', FALSE, FALSE, FALSE, NULL, 'name');
2395 $sourceID = CRM_Utils_Array
::key('Activity Source', $activityContacts);
2396 $assigneeID = CRM_Utils_Array
::key('Activity Assignees', $activityContacts);
2397 $targetID = CRM_Utils_Array
::key('Activity Targets', $activityContacts);
2399 //check for source contact.
2400 if (!$componentId ||
$allow) {
2401 $sourceContactId = self
::getActivityContact($activity->id
, $sourceID);
2402 //account for possibility of activity not having a source contact (as it may have been deleted)
2403 if ($sourceContactId) {
2404 $allow = CRM_Contact_BAO_Contact_Permission
::allow($sourceContactId, $permission);
2408 //check for target and assignee contacts.
2410 //first check for supper permission.
2411 $supPermission = 'view all contacts';
2412 if ($action == CRM_Core_Action
::UPDATE
) {
2413 $supPermission = 'edit all contacts';
2415 $allow = CRM_Core_Permission
::check($supPermission);
2417 //user might have sufficient permission, through acls.
2420 //get the target contacts.
2421 $targetContacts = CRM_Activity_BAO_ActivityContact
::retrieveContactIdsByActivityId($activity->id
, $targetID);
2422 foreach ($targetContacts as $cnt => $contactId) {
2423 if (!CRM_Contact_BAO_Contact_Permission
::allow($contactId, $permission)) {
2429 //get the assignee contacts.
2431 $assigneeContacts = CRM_Activity_BAO_ActivityContact
::retrieveContactIdsByActivityId($activity->id
, $assigneeID);
2432 foreach ($assigneeContacts as $cnt => $contactId) {
2433 if (!CRM_Contact_BAO_Contact_Permission
::allow($contactId, $permission)) {
2446 * This function is a wrapper for ajax activity selector
2448 * @param array $params
2449 * Associated array for params record id.
2451 * @return array $contactActivities associated array of contact activities
2453 public static function getContactActivitySelector(&$params) {
2454 // format the params
2455 $params['offset'] = ($params['page'] - 1) * $params['rp'];
2456 $params['rowCount'] = $params['rp'];
2457 $params['sort'] = CRM_Utils_Array
::value('sortBy', $params);
2458 $params['caseId'] = NULL;
2459 $context = CRM_Utils_Array
::value('context', $params);
2461 // get contact activities
2462 $activities = CRM_Activity_BAO_Activity
::getActivities($params);
2465 $params['total'] = CRM_Activity_BAO_Activity
::getActivitiesCount($params);
2467 // format params and add links
2468 $contactActivities = array();
2470 if (!empty($activities)) {
2471 $activityStatus = CRM_Core_PseudoConstant
::activityStatus();
2473 // check logged in user for permission
2474 $page = new CRM_Core_Page();
2475 CRM_Contact_Page_View
::checkUserPermission($page, $params['contact_id']);
2476 $permissions = array($page->_permission
);
2477 if (CRM_Core_Permission
::check('delete activities')) {
2478 $permissions[] = CRM_Core_Permission
::DELETE
;
2481 $mask = CRM_Core_Action
::mask($permissions);
2483 foreach ($activities as $activityId => $values) {
2484 $contactActivities[$activityId]['activity_type'] = $values['activity_type'];
2485 $contactActivities[$activityId]['subject'] = $values['subject'];
2486 if ($params['contact_id'] == $values['source_contact_id']) {
2487 $contactActivities[$activityId]['source_contact'] = $values['source_contact_name'];
2489 elseif ($values['source_contact_id']) {
2490 $contactActivities[$activityId]['source_contact'] = CRM_Utils_System
::href($values['source_contact_name'],
2491 'civicrm/contact/view', "reset=1&cid={$values['source_contact_id']}");
2494 $contactActivities[$activityId]['source_contact'] = '<em>n/a</em>';
2497 if (isset($values['mailingId']) && !empty($values['mailingId'])) {
2498 $contactActivities[$activityId]['target_contact'] = CRM_Utils_System
::href($values['recipients'],
2499 'civicrm/mailing/report/event',
2500 "mid={$values['source_record_id']}&reset=1&event=queue&cid={$params['contact_id']}&context=activitySelector");
2502 elseif (!empty($values['recipients'])) {
2503 $contactActivities[$activityId]['target_contact'] = $values['recipients'];
2505 elseif (isset($values['target_contact_counter']) && $values['target_contact_counter']) {
2506 $contactActivities[$activityId]['target_contact'] = '';
2507 foreach ($values['target_contact_name'] as $tcID => $tcName) {
2508 $contactActivities[$activityId]['target_contact'] .= CRM_Utils_System
::href($tcName,
2509 'civicrm/contact/view', "reset=1&cid={$tcID}");
2512 if ($extraCount = $values['target_contact_counter'] - 1) {
2513 $contactActivities[$activityId]['target_contact'] .= ";<br />" . "(" . ts('%1 more', array(1 => $extraCount)) . ")";
2516 elseif (!$values['target_contact_name']) {
2517 $contactActivities[$activityId]['target_contact'] = '<em>n/a</em>';
2520 if (empty($values['assignee_contact_name'])) {
2521 $contactActivities[$activityId]['assignee_contact'] = '<em>n/a</em>';
2523 elseif (!empty($values['assignee_contact_name'])) {
2525 $contactActivities[$activityId]['assignee_contact'] = '';
2526 foreach ($values['assignee_contact_name'] as $acID => $acName) {
2527 if ($acID && $count < 5) {
2528 $contactActivities[$activityId]['assignee_contact'] .= CRM_Utils_System
::href($acName, 'civicrm/contact/view', "reset=1&cid={$acID}");
2531 $contactActivities[$activityId]['assignee_contact'] .= "; ";
2535 $contactActivities[$activityId]['assignee_contact'] .= "(" . ts('more') . ")";
2542 $contactActivities[$activityId]['activity_date'] = CRM_Utils_Date
::customFormat($values['activity_date_time']);
2543 $contactActivities[$activityId]['status'] = $activityStatus[$values['status_id']];
2545 // add class to this row if overdue
2546 $contactActivities[$activityId]['class'] = '';
2547 if (CRM_Utils_Date
::overdue(CRM_Utils_Array
::value('activity_date_time', $values))
2548 && CRM_Utils_Array
::value('status_id', $values) == 1
2550 $contactActivities[$activityId]['class'] = 'status-overdue';
2553 $contactActivities[$activityId]['class'] = 'status-ontime';
2557 $contactActivities[$activityId]['links'] = '';
2558 $accessMailingReport = FALSE;
2559 if (!empty($values['mailingId'])) {
2560 $accessMailingReport = TRUE;
2563 $actionLinks = CRM_Activity_Selector_Activity
::actionLinks(
2564 CRM_Utils_Array
::value('activity_type_id', $values),
2565 CRM_Utils_Array
::value('source_record_id', $values),
2566 $accessMailingReport,
2567 CRM_Utils_Array
::value('activity_id', $values)
2570 $actionMask = array_sum(array_keys($actionLinks)) & $mask;
2572 $contactActivities[$activityId]['links'] = CRM_Core_Action
::formLink($actionLinks,
2575 'id' => $values['activity_id'],
2576 'cid' => $params['contact_id'],
2578 'caseid' => CRM_Utils_Array
::value('case_id', $values),
2584 $values['activity_id']
2587 $contactActivities[$activityId]['is_recurring_activity'] = $values['is_recurring_activity'];
2591 return $contactActivities;
2595 * Used to copy custom fields and attachments from an existing activity to another.
2596 * @see CRM_Case_Page_AJAX::_convertToCaseActivity()
2598 * @param array $params
2600 public static function copyExtendedActivityData($params) {
2601 // attach custom data to the new activity
2602 $customParams = $htmlType = array();
2603 $customValues = CRM_Core_BAO_CustomValueTable
::getEntityValues($params['activityID'], 'Activity');
2605 if (!empty($customValues)) {
2606 $fieldIds = implode(', ', array_keys($customValues));
2607 $sql = "SELECT id FROM civicrm_custom_field WHERE html_type = 'File' AND id IN ( {$fieldIds} )";
2608 $result = CRM_Core_DAO
::executeQuery($sql);
2610 while ($result->fetch()) {
2611 $htmlType[] = $result->id
;
2614 foreach ($customValues as $key => $value) {
2615 if ($value !== NULL) { // CRM-10542
2616 if (in_array($key, $htmlType)) {
2617 $fileValues = CRM_Core_BAO_File
::path($value, $params['activityID']);
2618 $customParams["custom_{$key}_-1"] = array(
2619 'name' => $fileValues[0],
2620 'path' => $fileValues[1],
2624 $customParams["custom_{$key}_-1"] = $value;
2628 CRM_Core_BAO_CustomValueTable
::postProcess($customParams, CRM_Core_DAO
::$_nullArray, 'civicrm_activity',
2629 $params['mainActivityId'], 'Activity'
2633 // copy activity attachments ( if any )
2634 CRM_Core_BAO_File
::copyEntityFile('civicrm_activity', $params['activityID'], 'civicrm_activity', $params['mainActivityId']);
2638 * @param int $activityId
2639 * @param int $recordTypeID
2640 * @param string $column
2644 public static function getActivityContact($activityId, $recordTypeID = NULL, $column = 'contact_id') {
2645 $activityContact = new CRM_Activity_BAO_ActivityContact();
2646 $activityContact->activity_id
= $activityId;
2647 if ($recordTypeID) {
2648 $activityContact->record_type_id
= $recordTypeID;
2650 if ($activityContact->find(TRUE)) {
2651 return $activityContact->$column;
2657 * @param int $activityId
2661 public static function getSourceContactID($activityId) {
2662 static $sourceID = NULL;
2664 $activityContacts = CRM_Core_OptionGroup
::values('activity_contacts', FALSE, FALSE, FALSE, NULL, 'name');
2665 $sourceID = CRM_Utils_Array
::key('Activity Source', $activityContacts);
2668 return self
::getActivityContact($activityId, $sourceID);
2672 * @param array $params
2674 public function setApiFilter(&$params) {
2675 if (CRM_Utils_Array
::value('target_contact_id', $params)) {
2677 $activityContacts = CRM_Core_OptionGroup
::values('activity_contacts', FALSE, FALSE, FALSE, NULL, 'name');
2678 $targetID = CRM_Utils_Array
::key('Activity Targets', $activityContacts);
2679 $obj = new CRM_Activity_BAO_ActivityContact();
2680 $params['return.target_contact_id'] = 1;
2681 $this->joinAdd($obj, 'LEFT');
2682 $this->selectAdd('civicrm_activity.*');
2683 $this->whereAdd(" civicrm_activity_contact.contact_id = {$params['target_contact_id']} AND civicrm_activity_contact.record_type_id = {$targetID}");