3 +--------------------------------------------------------------------+
4 | CiviCRM version 4.4 |
5 +--------------------------------------------------------------------+
6 | Copyright CiviCRM LLC (c) 2004-2013 |
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-2013
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 (CRM_Utils_Array
::value('source_contact_id', $params) ||
68 CRM_Utils_Array
::value('id', $params)
76 * Takes a bunch of params that are needed to match certain criteria and
77 * retrieves the relevant objects. Typically the valid params are only
78 * contact_id. We'll tweak this function to be more full featured over a period
79 * of time. This is the inverse function of create. It also stores all the retrieved
80 * values in the default array
82 * @param array $params (reference ) an assoc array of name/value pairs
83 * @param array $defaults (reference ) an assoc array to hold the flattened values
84 * @param string $activityType activity type
86 * @return object CRM_Core_BAO_Meeting object
89 public static function retrieve(&$params, &$defaults) {
90 $activity = new CRM_Activity_DAO_Activity();
91 $activity->copyValues($params);
93 if ($activity->find(TRUE)) {
94 $activityContacts = CRM_Core_OptionGroup
::values('activity_contacts', FALSE, FALSE, FALSE, NULL, 'name');
95 $targetID = CRM_Utils_Array
::key('Activity Targets', $activityContacts);
96 $sourceID = CRM_Utils_Array
::key('Activity Source', $activityContacts);
97 $assigneeID = CRM_Utils_Array
::key('Activity Assignees', $activityContacts);
99 // TODO: at some stage we'll have to deal
100 // TODO: with multiple values for assignees and targets, but
101 // TODO: for now, let's just fetch first row
102 $defaults['assignee_contact'] = CRM_Activity_BAO_ActivityContact
::retrieveContactIdsByActivityId($activity->id
, $assigneeID);
103 $assignee_contact_names = CRM_Activity_BAO_ActivityContact
::getNames($activity->id
, $assigneeID);
104 $defaults['assignee_contact_value'] = implode('; ', $assignee_contact_names);
105 $sourceContactId = self
::getActivityContact($activity->id
, $sourceID);
106 if ($activity->activity_type_id
!= CRM_Core_OptionGroup
::getValue('activity_type', 'Bulk Email', 'name')) {
107 $defaults['target_contact'] = CRM_Activity_BAO_ActivityContact
::retrieveContactIdsByActivityId($activity->id
, $targetID);
108 $target_contact_names = CRM_Activity_BAO_ActivityContact
::getNames($activity->id
, $targetID);
109 $defaults['target_contact_value'] = implode('; ', $target_contact_names);
111 elseif (CRM_Core_Permission
::check('access CiviMail') ||
112 (CRM_Mailing_Info
::workflowEnabled() &&
113 CRM_Core_Permission
::check('create mailings')
116 $defaults['mailingId'] = CRM_Utils_System
::url('civicrm/mailing/report',
117 "mid={$activity->source_record_id}&reset=1&atype={$activity->activity_type_id}&aid={$activity->id}&cid={$sourceContactId}&context=activity"
121 $defaults['target_contact_value'] = ts('(recipients)');
124 $sourceContactId = self
::getActivityContact($activity->id
, $sourceID);
125 $defaults['source_contact_id'] = $sourceContactId;
127 if ($sourceContactId &&
128 !CRM_Core_DAO
::getFieldValue('CRM_Contact_DAO_Contact',
133 $defaults['source_contact'] = CRM_Core_DAO
::getFieldValue('CRM_Contact_DAO_Contact',
140 $defaults['case_subject'] = CRM_Case_BAO_Case
::getCaseSubject($activity->id
);
142 CRM_Core_DAO
::storeValues($activity, $defaults);
150 * Function to delete the activity
152 * @param array $params associated array
158 public static function deleteActivity(&$params, $moveToTrash = FALSE) {
160 if (CRM_Utils_Array
::value('id', $params) && !is_array($params['id'])) {
161 CRM_Utils_Hook
::pre('delete', 'Activity', $params['id'], $params);
164 CRM_Utils_Hook
::pre('delete', 'Activity', NULL, $params);
167 $transaction = new CRM_Core_Transaction();
168 if (is_array(CRM_Utils_Array
::value('source_record_id', $params))) {
169 $sourceRecordIds = implode(',', $params['source_record_id']);
172 $sourceRecordIds = CRM_Utils_Array
::value('source_record_id', $params);
177 if (!isset($params['id'])) {
178 if (is_array($params['activity_type_id'])) {
179 $activityTypes = implode(',', $params['activity_type_id']);
182 $activityTypes = $params['activity_type_id'];
185 $query = "DELETE FROM civicrm_activity WHERE source_record_id IN ({$sourceRecordIds}) AND activity_type_id IN ( {$activityTypes} )";
186 $dao = CRM_Core_DAO
::executeQuery($query);
189 $activity = new CRM_Activity_DAO_Activity();
190 $activity->copyValues($params);
191 $result = $activity->delete();
194 $activity->case_id
= CRM_Case_BAO_Case
::getCaseIdByActivityId($activity->id
);
198 $activity = new CRM_Activity_DAO_Activity();
199 $activity->copyValues($params);
201 $activity->is_deleted
= 1;
202 $result = $activity->save();
204 //log activty delete.CRM-4525.
205 $logMsg = 'Case Activity deleted for';
208 $activityContacts = CRM_Core_OptionGroup
::values('activity_contacts', FALSE, FALSE, FALSE, NULL, 'name');
209 $sourceID = CRM_Utils_Array
::key('Activity Source', $activityContacts);
210 $assigneeID = CRM_Utils_Array
::key('Activity Assignees', $activityContacts);
211 $targetID = CRM_Utils_Array
::key('Activity Targets', $activityContacts);
212 $sourceContactId = self
::getActivityContact($activity->id
, $sourceID);
213 if ($sourceContactId) {
214 $msgs[] = " source={$sourceContactId}";
217 //get target contacts.
218 $targetContactIds = CRM_Activity_BAO_ActivityContact
::getNames($activity->id
, $targetID);
219 if (!empty($targetContactIds)) {
220 $msgs[] = " target =" . implode(',', array_keys($targetContactIds));
222 //get assignee contacts.
223 $assigneeContactIds = CRM_Activity_BAO_ActivityContact
::getNames($activity->id
, $assigneeID);
224 if (!empty($assigneeContactIds)) {
225 $msgs[] = " assignee =" . implode(',', array_keys($assigneeContactIds));
228 $logMsg .= implode(', ', $msgs);
230 self
::logActivityAction($activity, $logMsg);
233 // delete the recently created Activity
235 $activityRecent = array(
236 'id' => $activity->id
,
237 'type' => 'Activity',
239 CRM_Utils_Recent
::del($activityRecent);
242 $transaction->commit();
243 if (isset($activity)) {
245 $activity->case_id
= CRM_Case_BAO_Case
::getCaseIdByActivityId($activity->id
);
246 CRM_Utils_Hook
::post('delete', 'Activity', $activity->id
, $activity);
253 * Delete activity assignment record
255 * @param int $id activity id
260 public static function deleteActivityContact($activityId, $recordTypeID = NULL) {
261 $activityContact = new CRM_Activity_BAO_ActivityContact();
262 $activityContact->activity_id
= $activityId;
264 $activityContact->record_type_id
= $recordTypeID;
266 $activityContact->delete();
270 * Function to process the activities
272 * @param object $form form object
273 * @param array $params associated array of the submitted values
274 * @param array $ids array of ids
275 * @param string $activityType activity Type
276 * @param boolean $record true if it is Record Activity
281 public static function create(&$params) {
282 // check required params
283 if (!self
::dataExists($params)) {
284 CRM_Core_Error
::fatal('Not enough data to create activity object,');
287 $activity = new CRM_Activity_DAO_Activity();
289 if (isset($params['id']) && empty($params['id'])) {
290 unset($params['id']);
293 if (!CRM_Utils_Array
::value('status_id', $params) &&
294 !CRM_Utils_Array
::value('activity_status_id', $params) &&
295 !CRM_Utils_Array
::value('id', $params)
297 if (isset($params['activity_date_time']) &&
298 strcmp($params['activity_date_time'], CRM_Utils_Date
::processDate(date('Ymd')) == -1)
300 $params['status_id'] = 2;
303 $params['status_id'] = 1;
307 //set priority to Normal for Auto-populated activities (for Cases)
308 if (CRM_Utils_Array
::value('priority_id', $params) === NULL &&
309 // if not set and not 0
310 !CRM_Utils_Array
::value('id', $params)
312 $priority = CRM_Core_PseudoConstant
::get('CRM_Activity_DAO_Activity', 'priority_id');
313 $params['priority_id'] = array_search('Normal', $priority);
316 if (!empty($params['target_contact_id']) && is_array($params['target_contact_id'])) {
317 $params['target_contact_id'] = array_unique($params['target_contact_id']);
319 if (!empty($params['assignee_contact_id']) && is_array($params['assignee_contact_id'])) {
320 $params['assignee_contact_id'] = array_unique($params['assignee_contact_id']);
324 if (CRM_Utils_Array
::value('id', $params)) {
325 CRM_Utils_Hook
::pre('edit', 'Activity', $activity->id
, $params);
328 CRM_Utils_Hook
::pre('create', 'Activity', NULL, $params);
331 $activity->copyValues($params);
332 if (isset($params['case_id'])) {
333 // CRM-8708, preserve case ID even though it's not part of the SQL model
334 $activity->case_id
= $params['case_id'];
336 elseif (is_numeric($activity->id
)) {
337 // CRM-8708, preserve case ID even though it's not part of the SQL model
338 $activity->case_id
= CRM_Case_BAO_Case
::getCaseIdByActivityId($activity->id
);
342 $transaction = new CRM_Core_Transaction();
344 $result = $activity->save();
346 if (is_a($result, 'CRM_Core_Error')) {
347 $transaction->rollback();
351 $activityId = $activity->id
;
352 $activityContacts = CRM_Core_OptionGroup
::values('activity_contacts', FALSE, FALSE, FALSE, NULL, 'name');
353 $sourceID = CRM_Utils_Array
::key('Activity Source', $activityContacts);
354 $assigneeID = CRM_Utils_Array
::key('Activity Assignees', $activityContacts);
355 $targetID = CRM_Utils_Array
::key('Activity Targets', $activityContacts);
357 if (isset($params['source_contact_id'])) {
359 'activity_id' => $activityId,
360 'contact_id' => $params['source_contact_id'],
361 'record_type_id' => $sourceID
363 self
::deleteActivityContact($activityId, $sourceID);
364 CRM_Activity_BAO_ActivityContact
::create($acParams);
367 // check and attach and files as needed
368 CRM_Core_BAO_File
::processAttachment($params, 'civicrm_activity', $activityId);
370 // attempt to save activity assignment
371 $resultAssignment = NULL;
372 if (CRM_Utils_Array
::value('assignee_contact_id', $params)) {
374 $assignmentParams = array('activity_id' => $activityId);
376 if (is_array($params['assignee_contact_id'])) {
377 if (CRM_Utils_Array
::value('deleteActivityAssignment', $params, TRUE)) {
378 // first delete existing assignments if any
379 self
::deleteActivityContact($activityId, $assigneeID);
383 foreach ($params['assignee_contact_id'] as $acID) {
385 $values[] = "( $activityId, $acID, $assigneeID )";
388 while (!empty($values)) {
389 $input = array_splice($values, 0, CRM_Core_DAO
::BULK_INSERT_COUNT
);
390 $str = implode(',', $input);
391 $sql = "INSERT IGNORE INTO civicrm_activity_contact ( activity_id, contact_id, record_type_id ) VALUES $str;";
392 CRM_Core_DAO
::executeQuery($sql);
396 $assignmentParams['contact_id'] = $params['assignee_contact_id'];
397 $assignmentParams['record_type_id'] = $assigneeID;
398 if (CRM_Utils_Array
::value('id', $params)) {
399 $assignment = new CRM_Activity_BAO_ActivityContact();
400 $assignment->activity_id
= $activityId;
401 $assignment->record_type_id
= $assigneeID;
402 $assignment->find(TRUE);
404 if ($assignment->contact_id
!= $params['assignee_contact_id']) {
405 $assignmentParams['id'] = $assignment->id
;
406 $resultAssignment = CRM_Activity_BAO_ActivityContact
::create($assignmentParams);
410 $resultAssignment = CRM_Activity_BAO_ActivityContact
::create($assignmentParams);
415 if (CRM_Utils_Array
::value('deleteActivityAssignment', $params, TRUE)) {
416 self
::deleteActivityContact($activityId, $assigneeID);
420 if (is_a($resultAssignment, 'CRM_Core_Error')) {
421 $transaction->rollback();
422 return $resultAssignment;
425 // attempt to save activity targets
426 $resultTarget = NULL;
427 if (CRM_Utils_Array
::value('target_contact_id', $params)) {
429 $targetParams = array('activity_id' => $activityId);
430 $resultTarget = array();
431 if (is_array($params['target_contact_id'])) {
432 if (CRM_Utils_Array
::value('deleteActivityTarget', $params, TRUE)) {
433 // first delete existing targets if any
434 self
::deleteActivityContact($activityId, $targetID );
438 foreach ($params['target_contact_id'] as $tid) {
440 $values[] = "( $activityId, $tid, $targetID )";
444 while (!empty($values)) {
445 $input = array_splice($values, 0, CRM_Core_DAO
::BULK_INSERT_COUNT
);
446 $str = implode(',', $input);
447 $sql = "INSERT IGNORE INTO civicrm_activity_contact ( activity_id, contact_id, record_type_id ) VALUES $str;";
448 CRM_Core_DAO
::executeQuery($sql);
452 $targetParams['contact_id'] = $params['target_contact_id'];
453 $targetParams['record_type_id'] = $targetID;
454 if (CRM_Utils_Array
::value('id', $params)) {
455 $target = new CRM_Activity_BAO_ActivityContact();
456 $target->activity_id
= $activityId;
457 $target->record_type_id
= $targetID;
460 if ($target->contact_id
!= $params['target_contact_id']) {
461 $targetParams['id'] = $target->id
;
462 $resultTarget = CRM_Activity_BAO_ActivityContact
::create($targetParams);
466 $resultTarget = CRM_Activity_BAO_ActivityContact
::create($targetParams);
471 if (CRM_Utils_Array
::value('deleteActivityTarget', $params, TRUE)) {
472 self
::deleteActivityContact($activityId, $targetID );
476 // write to changelog before transaction is committed/rolled
477 // back (and prepare status to display)
478 if (CRM_Utils_Array
::value('id', $params)) {
479 $logMsg = "Activity (id: {$result->id} ) updated with ";
482 $logMsg = "Activity created for ";
486 if (isset($params['source_contact_id'])) {
487 $msgs[] = "source={$params['source_contact_id']}";
490 if (CRM_Utils_Array
::value('target_contact_id', $params)) {
491 if (is_array($params['target_contact_id']) && !CRM_Utils_array
::crmIsEmptyArray($params['target_contact_id'])) {
492 $msgs[] = "target=" . implode(',', $params['target_contact_id']);
493 // take only first target
494 // will be used for recently viewed display
495 $t = array_slice($params['target_contact_id'], 0, 1);
496 $recentContactId = $t[0];
498 elseif (isset($params['target_contact_id'])) {
499 $msgs[] = "target={$params['target_contact_id']}";
500 // will be used for recently viewed display
501 $recentContactId = $params['target_contact_id'];
505 // at worst, take source for recently viewed display
506 $recentContactId = CRM_Utils_Array
::value('source_contact_id',$params);
509 if (isset($params['assignee_contact_id'])) {
510 if (is_array($params['assignee_contact_id'])) {
511 $msgs[] = "assignee=" . implode(',', $params['assignee_contact_id']);
514 $msgs[] = "assignee={$params['assignee_contact_id']}";
517 $logMsg .= implode(', ', $msgs);
519 self
::logActivityAction($result, $logMsg);
521 if (CRM_Utils_Array
::value('custom', $params) &&
522 is_array($params['custom'])
524 CRM_Core_BAO_CustomValueTable
::store($params['custom'], 'civicrm_activity', $result->id
);
527 $transaction->commit();
528 if (!CRM_Utils_Array
::value('skipRecentView', $params)) {
529 $recentOther = array();
530 if (CRM_Utils_Array
::value('case_id', $params)) {
531 $caseContactID = CRM_Core_DAO
::getFieldValue('CRM_Case_DAO_CaseContact', $params['case_id'], 'contact_id', 'case_id');
532 $url = CRM_Utils_System
::url('civicrm/case/activity/view',
533 "reset=1&aid={$activity->id}&cid={$caseContactID}&caseID={$params['case_id']}&context=home"
537 $q = "action=view&reset=1&id={$activity->id}&atype={$activity->activity_type_id}&cid={$params['source_contact_id']}&context=home";
538 if ($activity->activity_type_id
!= CRM_Core_OptionGroup
::getValue('activity_type', 'Email', 'name')) {
539 $url = CRM_Utils_System
::url('civicrm/activity', $q);
540 if ($activity->activity_type_id
== CRM_Core_OptionGroup
::getValue('activity_type', 'Print PDF Letter', 'name')) {
541 $recentOther['editUrl'] = CRM_Utils_System
::url('civicrm/activity/pdf/add',
542 "action=update&reset=1&id={$activity->id}&atype={$activity->activity_type_id}&cid={$params['source_contact_id']}&context=home"
546 $recentOther['editUrl'] = CRM_Utils_System
::url('civicrm/activity/add',
547 "action=update&reset=1&id={$activity->id}&atype={$activity->activity_type_id}&cid={$params['source_contact_id']}&context=home"
551 if (CRM_Core_Permission
::check("delete activities")) {
552 $recentOther['deleteUrl'] = CRM_Utils_System
::url('civicrm/activity',
553 "action=delete&reset=1&id={$activity->id}&atype={$activity->activity_type_id}&cid={$params['source_contact_id']}&context=home"
558 $url = CRM_Utils_System
::url('civicrm/activity/view', $q);
559 if (CRM_Core_Permission
::check('delete activities')) {
560 $recentOther['deleteUrl'] = CRM_Utils_System
::url('civicrm/activity',
561 "action=delete&reset=1&id={$activity->id}&atype={$activity->activity_type_id}&cid={$params['source_contact_id']}&context=home"
567 if (!isset($activity->parent_id
)) {
568 $recentContactDisplay = CRM_Contact_BAO_Contact
::displayName($recentContactId);
569 // add the recently created Activity
570 $activityTypes = CRM_Core_PseudoConstant
::activityType(TRUE, TRUE);
571 $activitySubject = CRM_Core_DAO
::getFieldValue('CRM_Activity_DAO_Activity', $activity->id
, 'subject');
574 if (isset($activitySubject)) {
575 $title = $activitySubject . ' - ';
578 $title = $title . $recentContactDisplay;
579 if (CRM_Utils_Array
::value($activity->activity_type_id
, $activityTypes)) {
580 $title .= ' (' . $activityTypes[$activity->activity_type_id
] . ')';
583 CRM_Utils_Recent
::add($title,
588 $recentContactDisplay,
594 // reset the group contact cache since smart groups might be affected due to this
595 CRM_Contact_BAO_GroupContactCache
::remove();
597 if (CRM_Utils_Array
::value('id', $params)) {
598 CRM_Utils_Hook
::post('edit', 'Activity', $activity->id
, $activity);
601 CRM_Utils_Hook
::post('create', 'Activity', $activity->id
, $activity);
604 // if the subject contains a ‘[case #…]’ string, file that activity on the related case (CRM-5916)
606 if (preg_match('/\[case #([0-9a-h]{7})\]/', CRM_Utils_Array
::value('subject', $params), $matches)) {
607 $key = CRM_Core_DAO
::escapeString(CIVICRM_SITE_KEY
);
609 $query = "SELECT id FROM civicrm_case WHERE SUBSTR(SHA1(CONCAT('$key', id)), 1, 7) = '$hash'";
611 'activity_id' => $activity->id
,
612 'case_id' => CRM_Core_DAO
::singleValueQuery($query),
614 if ($caseParams['case_id']) {
615 CRM_Case_BAO_Case
::processCaseActivity($caseParams);
618 self
::logActivityAction($activity, "unknown case hash encountered: $hash");
625 public static function logActivityAction($activity, $logMessage = NULL) {
626 $session = CRM_Core_Session
::singleton();
627 $id = $session->get('userID');
629 $activityContacts = CRM_Core_OptionGroup
::values('activity_contacts', FALSE, FALSE, FALSE, NULL, 'name');
630 $sourceID = CRM_Utils_Array
::key('Activity Source', $activityContacts);
631 $id = self
::getActivityContact($activity->id
. $sourceID);
634 'entity_table' => 'civicrm_activity',
635 'entity_id' => $activity->id
,
636 'modified_id' => $id,
637 'modified_date' => date('YmdHis'),
638 'data' => $logMessage,
640 CRM_Core_BAO_Log
::add($logParams);
645 * function to get the list Activities
647 * @param array $input array of parameters
649 * - contact_id int contact_id whose activities we want to retrieve
650 * - offset int which row to start from ?
651 * - rowCount int how many rows to fetch
652 * - sort object|array object or array describing sort order for sql query.
653 * - admin boolean if contact is admin
654 * - caseId int case ID
655 * - context string page on which selector is build
656 * - activity_type_id int|string the activitiy types we want to restrict by
658 * @return array (reference) $values the relevant data object values of open activities
663 static function &getActivities($input) {
664 //step 1: Get the basic activity data
665 $bulkActivityTypeID = CRM_Core_OptionGroup
::getValue(
671 $config = CRM_Core_Config
::singleton();
673 $randomNum = md5(uniqid());
674 $activityTempTable = "civicrm_temp_activity_details_{$randomNum}";
676 $tableFields = array(
677 'activity_id' => 'int unsigned',
678 'activity_date_time' => 'datetime',
679 'status_id' => 'int unsigned',
680 'subject' => 'varchar(255)',
681 'source_contact_name' => 'varchar(255)',
682 'activity_type_id' => 'int unsigned',
683 'activity_type' => 'varchar(128)',
684 'case_id' => 'int unsigned',
685 'case_subject' => 'varchar(255)',
686 'campaign_id' => 'int unsigned',
689 $sql = "CREATE TEMPORARY TABLE {$activityTempTable} ( ";
690 $insertValueSQL = array();
691 // The activityTempTable contains the sorted rows
692 // so in order to maintain the sort order as-is we add an auto_increment
693 // field; we can sort by this later to ensure the sort order stays correct.
694 $sql .= " fixed_sort_order INT UNSIGNED NOT NULL AUTO_INCREMENT PRIMARY KEY,";
695 foreach ($tableFields as $name => $desc) {
696 $sql .= "$name $desc,\n";
697 $insertValueSQL[] = $name;
700 // add unique key on activity_id just to be sure
701 // this cannot be primary key because we need that for the auto_increment
702 // fixed_sort_order field
704 UNIQUE KEY ( activity_id )
705 ) ENGINE=HEAP DEFAULT CHARACTER SET utf8 COLLATE utf8_unicode_ci
708 CRM_Core_DAO
::executeQuery($sql);
710 $insertSQL = "INSERT INTO {$activityTempTable} (" . implode(',', $insertValueSQL) . " ) ";
712 $order = $limit = $groupBy = '';
714 if (!empty($input['sort'])) {
715 if (is_a($input['sort'], 'CRM_Utils_Sort')) {
716 $orderBy = $input['sort']->orderBy();
717 if (!empty($orderBy)) {
718 $order = " ORDER BY $orderBy";
721 elseif (trim($input['sort'])) {
722 $sort = CRM_Utils_Type
::escape($input['sort'], 'String');
723 $order = " ORDER BY $sort ";
728 // context = 'activity' in Activities tab.
729 $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 ";
732 if (!empty($input['rowCount']) &&
733 $input['rowCount'] > 0
735 $limit = " LIMIT {$input['offset']}, {$input['rowCount']} ";
738 $input['count'] = FALSE;
739 list($sqlClause, $params) = self
::getActivitySQLClause($input);
741 $query = "{$insertSQL}
742 SELECT DISTINCT tbl.* from ( {$sqlClause} )
745 //filter case activities - CRM-5761
746 $components = self
::activityComponents();
747 if (!in_array('CiviCase', $components)) {
749 LEFT JOIN civicrm_case_activity ON ( civicrm_case_activity.activity_id = tbl.activity_id )
750 WHERE civicrm_case_activity.id IS NULL";
753 $query = $query . $groupBy . $order . $limit;
755 $dao = CRM_Core_DAO
::executeQuery($query, $params);
757 // step 2: Get target and assignee contacts for above activities
758 // create temp table for target contacts
759 $activityContactTempTable = "civicrm_temp_activity_contact_{$randomNum}";
760 $query = "CREATE TEMPORARY TABLE {$activityContactTempTable} (
761 activity_id int unsigned, contact_id int unsigned, record_type_id varchar(16), contact_name varchar(255) )
762 ENGINE=MYISAM DEFAULT CHARACTER SET utf8 COLLATE utf8_unicode_ci";
764 CRM_Core_DAO
::executeQuery($query);
766 // note that we ignore bulk email for targets, since we don't show it in selector
768 INSERT INTO {$activityContactTempTable} ( activity_id, contact_id, record_type_id, contact_name )
769 SELECT ac.activity_id,
773 FROM civicrm_activity_contact ac
774 INNER JOIN {$activityTempTable} ON ( ac.activity_id = {$activityTempTable}.activity_id )
775 INNER JOIN civicrm_contact c ON c.id = ac.contact_id
776 WHERE c.is_deleted = 0
779 CRM_Core_DAO
::executeQuery($query);
781 // step 3: Combine all temp tables to get final query for activity selector
782 // sort by the original sort order, stored in fixed_sort_order
784 SELECT {$activityTempTable}.*,
785 {$activityContactTempTable}.contact_id,
786 {$activityContactTempTable}.record_type_id,
787 {$activityContactTempTable}.contact_name
788 FROM {$activityTempTable}
789 INNER JOIN {$activityContactTempTable} on {$activityTempTable}.activity_id = {$activityContactTempTable}.activity_id
790 ORDER BY fixed_sort_order
794 $dao = CRM_Core_DAO
::executeQuery($query);
796 //CRM-3553, need to check user has access to target groups.
797 $mailingIDs = CRM_Mailing_BAO_Mailing
::mailingACLIDs();
799 (CRM_Core_Permission
::check('access CiviMail')) ||
800 (CRM_Mailing_Info
::workflowEnabled() &&
801 CRM_Core_Permission
::check('create mailings'))
805 $allCampaigns = CRM_Campaign_BAO_Campaign
::getCampaigns(NULL, NULL, FALSE, FALSE, FALSE, TRUE);
808 $activityContacts = CRM_Core_OptionGroup
::values('activity_contacts', FALSE, FALSE, FALSE, NULL, 'name');
809 $sourceID = CRM_Utils_Array
::key('Activity Source', $activityContacts);
810 $assigneeID = CRM_Utils_Array
::key('Activity Assignees', $activityContacts);
811 $targetID = CRM_Utils_Array
::key('Activity Targets', $activityContacts);
814 while ($dao->fetch()) {
815 $activityID = $dao->activity_id
;
816 $values[$activityID]['activity_id'] = $dao->activity_id
;
817 $values[$activityID]['source_record_id'] = $dao->source_record_id
;
818 $values[$activityID]['activity_type_id'] = $dao->activity_type_id
;
819 $values[$activityID]['activity_type'] = $dao->activity_type
;
820 $values[$activityID]['activity_date_time'] = $dao->activity_date_time
;
821 $values[$activityID]['status_id'] = $dao->status_id
;
822 $values[$activityID]['subject'] = $dao->subject
;
823 $values[$activityID]['campaign_id'] = $dao->campaign_id
;
825 if ($dao->campaign_id
) {
826 $values[$activityID]['campaign'] = $allCampaigns[$dao->campaign_id
];
829 if (!CRM_Utils_Array
::value('assignee_contact_name', $values[$activityID])) {
830 $values[$activityID]['assignee_contact_name'] = array();
833 if (!CRM_Utils_Array
::value('target_contact_name', $values[$activityID])) {
834 $values[$activityID]['target_contact_name'] = array();
837 if ($dao->record_type_id
== $sourceID && $dao->contact_id
) {
838 $values[$activityID]['source_contact_id'] = $dao->contact_id
;
839 $values[$activityID]['source_contact_name'] = $dao->contact_name
;
842 if (!$bulkActivityTypeID ||
($bulkActivityTypeID != $dao->activity_type_id
)) {
843 // build array of target / assignee names
844 if ($dao->record_type_id
== $targetID && $dao->contact_id
) {
845 $values[$activityID]['target_contact_name'][$dao->contact_id
] = $dao->contact_name
;
847 if ($dao->record_type_id
== $assigneeID && $dao->contact_id
) {
848 $values[$activityID]['assignee_contact_name'][$dao->contact_id
] = $dao->contact_name
;
851 // case related fields
852 $values[$activityID]['case_id'] = $dao->case_id
;
853 $values[$activityID]['case_subject'] = $dao->case_subject
;
856 $values[$activityID]['recipients'] = ts('(recipients)');
857 $values[$activityID]['mailingId'] = false;
860 ($mailingIDs === TRUE ||
in_array($dao->source_record_id
, $mailingIDs))
862 $values[$activityID]['mailingId'] = true;
867 // add info on whether the related contacts are deleted (CRM-5673)
868 // FIXME: ideally this should be tied to ACLs
870 // grab all the related contact ids
872 foreach ($values as $value) {
873 $cids[] = $value['source_contact_id'];
875 $cids = array_filter(array_unique($cids));
877 // see which of the cids are of deleted contacts
879 $sql = 'SELECT id FROM civicrm_contact WHERE id IN (' . implode(', ', $cids) . ') AND is_deleted = 1';
880 $dao = CRM_Core_DAO
::executeQuery($sql);
882 while ($dao->fetch()) {
886 // hide the deleted contacts
887 foreach ($values as & $value) {
888 if (in_array($value['source_contact_id'], $dels)) {
889 unset($value['source_contact_id'], $value['source_contact_name']);
898 * Get the component id and name those are enabled and logged in
899 * user has permission. To decide whether we are going to include
900 * component related activities w/ core activity retrieve process.
902 * return an array of component id and name.
905 static function activityComponents() {
906 $components = array();
907 $compInfo = CRM_Core_Component
::getEnabledComponents();
908 foreach ($compInfo as $compObj) {
909 if (CRM_Utils_Array
::value('showActivitiesInCore', $compObj->info
)) {
910 if ($compObj->info
['name'] == 'CiviCampaign') {
911 $componentPermission = "administer {$compObj->name}";
914 $componentPermission = "access {$compObj->name}";
916 if ($compObj->info
['name'] == 'CiviCase') {
917 if (CRM_Case_BAO_Case
::accessCiviCase()) {
918 $components[$compObj->componentID
] = $compObj->info
['name'];
921 elseif (CRM_Core_Permission
::check($componentPermission)) {
922 $components[$compObj->componentID
] = $compObj->info
['name'];
931 * function to get the activity Count
933 * @param array $input array of parameters
935 * - contact_id int contact_id whose activities we want to retrieve
936 * - admin boolean if contact is admin
937 * - caseId int case ID
938 * - context string page on which selector is build
939 * - activity_type_id int|string the activity types we want to restrict by
941 * @return int count of activities
946 static function &getActivitiesCount($input) {
947 $input['count'] = TRUE;
948 list($sqlClause, $params) = self
::getActivitySQLClause($input);
950 //filter case activities - CRM-5761
951 $components = self
::activityComponents();
952 if (!in_array('CiviCase', $components)) {
954 SELECT COUNT(DISTINCT(tbl.activity_id)) as count
955 FROM ( {$sqlClause} ) as tbl
956 LEFT JOIN civicrm_case_activity ON ( civicrm_case_activity.activity_id = tbl.activity_id )
957 WHERE civicrm_case_activity.id IS NULL";
960 $query = "SELECT COUNT(DISTINCT(activity_id)) as count from ( {$sqlClause} ) as tbl";
963 return CRM_Core_DAO
::singleValueQuery($query, $params);
967 * function to get the activity sql clause to pick activities
969 * @param array $input array of parameters
971 * - contact_id int contact_id whose activities we want to retrieve
972 * - admin boolean if contact is admin
973 * - caseId int case ID
974 * - context string page on which selector is build
975 * - count boolean are we interested in the count clause only?
976 * - activity_type_id int|string the activity types we want to restrict by
978 * @return int count of activities
983 static function getActivitySQLClause($input) {
985 $sourceWhere = $targetWhere = $assigneeWhere = $caseWhere = 1;
987 $config = CRM_Core_Config
::singleton();
988 if (!CRM_Utils_Array
::value('admin', $input, FALSE)) {
989 $sourceWhere = ' ac.contact_id = %1 ';
990 $caseWhere = ' civicrm_case_contact.contact_id = %1 ';
992 $params = array(1 => array($input['contact_id'], 'Integer'));
995 $commonClauses = array(
996 "civicrm_option_group.name = 'activity_type'",
997 "civicrm_activity.is_deleted = 0",
998 "civicrm_activity.is_current_revision = 1",
999 "civicrm_activity.is_test= 0",
1002 if ($input['context'] != 'activity') {
1003 $commonClauses[] = "civicrm_activity.status_id = 1";
1006 //Filter on component IDs.
1007 $components = self
::activityComponents();
1008 if (!empty($components)) {
1009 $componentsIn = implode(',', array_keys($components));
1010 $commonClauses[] = "( civicrm_option_value.component_id IS NULL OR civicrm_option_value.component_id IN ( $componentsIn ) )";
1013 $commonClauses[] = "civicrm_option_value.component_id IS NULL";
1016 // activity type ID clause
1017 if (!empty($input['activity_type_id'])) {
1018 if (is_array($input['activity_type_id'])) {
1019 foreach ($input['activity_type_id'] as $idx => $value) {
1020 $input['activity_type_id'][$idx] = CRM_Utils_Type
::escape($value, 'Positive');
1022 $commonClauses[] = "civicrm_activity.activity_type_id IN ( " . implode(",", $input['activity_type_id']) . " ) ";
1025 $activityTypeID = CRM_Utils_Type
::escape($input['activity_type_id'], 'Positive');
1026 $commonClauses[] = "civicrm_activity.activity_type_id = $activityTypeID";
1030 // exclude by activity type clause
1031 if (!empty($input['activity_type_exclude_id'])) {
1032 if (is_array($input['activity_type_exclude_id'])) {
1033 foreach ($input['activity_type_exclude_id'] as $idx => $value) {
1034 $input['activity_type_exclude_id'][$idx] = CRM_Utils_Type
::escape($value, 'Positive');
1036 $commonClauses[] = "civicrm_activity.activity_type_id NOT IN ( " . implode(",", $input['activity_type_exclude_id']) . " ) ";
1039 $activityTypeID = CRM_Utils_Type
::escape($input['activity_type_exclude_id'], 'Positive');
1040 $commonClauses[] = "civicrm_activity.activity_type_id != $activityTypeID";
1044 $commonClause = implode(' AND ', $commonClauses);
1046 $includeCaseActivities = FALSE;
1047 if (in_array('CiviCase', $components)) {
1048 $includeCaseActivities = TRUE;
1052 // build main activity table select clause
1055 $activityContacts = CRM_Core_OptionGroup
::values('activity_contacts', FALSE, FALSE, FALSE, NULL, 'name');
1056 $sourceID = CRM_Utils_Array
::key('Activity Source', $activityContacts);
1058 INNER JOIN civicrm_activity_contact ac ON ac.activity_id = civicrm_activity.id AND record_type_id = {$sourceID}
1059 INNER JOIN civicrm_contact contact ON ac.contact_id = contact.id
1062 if (!$input['count']) {
1064 civicrm_activity.activity_date_time,
1065 civicrm_activity.status_id,
1066 civicrm_activity.subject,
1067 contact.sort_name as source_contact_name,
1068 civicrm_option_value.value as activity_type_id,
1069 civicrm_option_value.label as activity_type,
1070 null as case_id, null as case_subject,
1071 civicrm_activity.campaign_id as campaign_id
1077 SELECT civicrm_activity.id as activity_id
1079 from civicrm_activity
1080 left join civicrm_option_value on
1081 civicrm_activity.activity_type_id = civicrm_option_value.value
1082 left join civicrm_option_group on
1083 civicrm_option_group.id = civicrm_option_value.option_group_id
1090 // Build case clause
1091 // or else exclude Inbound Emails that have been filed on a case.
1094 if ($includeCaseActivities) {
1096 if (!$input['count']) {
1098 civicrm_activity.activity_date_time,
1099 civicrm_activity.status_id,
1100 civicrm_activity.subject,
1102 contact.sort_name as source_contact_name,
1103 civicrm_option_value.value as activity_type_id,
1104 civicrm_option_value.label as activity_type,
1105 null as case_id, null as case_subject,
1106 civicrm_activity.campaign_id as campaign_id';
1112 SELECT civicrm_activity.id as activity_id
1114 from civicrm_activity
1115 inner join civicrm_case_activity on
1116 civicrm_case_activity.activity_id = civicrm_activity.id
1117 inner join civicrm_case on
1118 civicrm_case_activity.case_id = civicrm_case.id
1119 inner join civicrm_case_contact on
1120 civicrm_case_contact.case_id = civicrm_case.id and {$caseWhere}
1121 left join civicrm_option_value on
1122 civicrm_activity.activity_type_id = civicrm_option_value.value
1123 left join civicrm_option_group on
1124 civicrm_option_group.id = civicrm_option_value.option_group_id
1129 and ( ( civicrm_case_activity.case_id IS NULL ) OR
1130 ( civicrm_option_value.name <> 'Inbound Email' AND
1131 civicrm_option_value.name <> 'Email' AND civicrm_case_activity.case_id
1137 $returnClause = " {$sourceClause} {$caseClause} ";
1139 return array($returnClause, $params);
1143 * send the message to all the contacts and also insert a
1144 * contact activity in each contacts record
1146 * @param array $contactDetails the array of contact details to send the email
1147 * @param string $subject the subject of the message
1148 * @param string $message the message contents
1149 * @param string $emailAddress use this 'to' email address instead of the default Primary address
1150 * @param int $userID use this userID if set
1151 * @param string $from
1152 * @param array $attachments the array of attachments if any
1153 * @param string $cc cc recipient
1154 * @param string $bcc bcc recipient
1155 * @param array $contactIds contact ids
1156 * @param string $additionalDetails the additional information of CC and BCC appended to the activity Details
1158 * @return array ( sent, activityId) if any email is sent and activityId
1162 static function sendEmail(
1170 $attachments = NULL,
1173 $contactIds, // FIXME a param with no default shouldn't be last
1174 $additionalDetails = NULL
1176 // get the contact details of logged in contact, which we set as from email
1177 if ($userID == NULL) {
1178 $session = CRM_Core_Session
::singleton();
1179 $userID = $session->get('userID');
1182 list($fromDisplayName, $fromEmail, $fromDoNotEmail) = CRM_Contact_BAO_Contact
::getContactDetails($userID);
1184 return array(count($contactDetails), 0, count($contactDetails));
1186 if (!trim($fromDisplayName)) {
1187 $fromDisplayName = $fromEmail;
1191 // token replacement of addressee/email/postal greetings
1192 // get the tokens added in subject and message
1193 $subjectToken = CRM_Utils_Token
::getTokens($subject);
1194 $messageToken = CRM_Utils_Token
::getTokens($text);
1195 $messageToken = array_merge($messageToken, CRM_Utils_Token
::getTokens($html));
1198 $from = "$fromDisplayName <$fromEmail>";
1201 //create the meta level record first ( email activity )
1202 $activityTypeID = CRM_Core_OptionGroup
::getValue('activity_type',
1207 // CRM-6265: save both text and HTML parts in details (if present)
1208 if ($html and $text) {
1209 $details = "-ALTERNATIVE ITEM 0-\n$html$additionalDetails\n-ALTERNATIVE ITEM 1-\n$text$additionalDetails\n-ALTERNATIVE END-\n";
1212 $details = $html ?
$html : $text;
1213 $details .= $additionalDetails;
1216 $activityParams = array(
1217 'source_contact_id' => $userID,
1218 'activity_type_id' => $activityTypeID,
1219 'activity_date_time' => date('YmdHis'),
1220 'subject' => $subject,
1221 'details' => $details,
1222 // FIXME: check for name Completed and get ID from that lookup
1226 // CRM-5916: strip [case #…] before saving the activity (if present in subject)
1227 $activityParams['subject'] = preg_replace('/\[case #([0-9a-h]{7})\] /', '', $activityParams['subject']);
1229 // add the attachments to activity params here
1231 // first process them
1232 $activityParams = array_merge($activityParams,
1237 $activity = self
::create($activityParams);
1239 // get the set of attachments from where they are stored
1240 $attachments = CRM_Core_BAO_File
::getEntityFile('civicrm_activity',
1243 $returnProperties = array();
1244 if (isset($messageToken['contact'])) {
1245 foreach ($messageToken['contact'] as $key => $value) {
1246 $returnProperties[$value] = 1;
1250 if (isset($subjectToken['contact'])) {
1251 foreach ($subjectToken['contact'] as $key => $value) {
1252 if (!isset($returnProperties[$value])) {
1253 $returnProperties[$value] = 1;
1259 // get token details for contacts, call only if tokens are used
1261 if (!empty($returnProperties)) {
1262 list($details) = CRM_Utils_Token
::getTokenDetails(
1267 'CRM_Activity_BAO_Activity'
1273 CRM_Utils_Hook
::tokens($tokens);
1274 $categories = array_keys($tokens);
1276 $escapeSmarty = FALSE;
1277 if (defined('CIVICRM_MAIL_SMARTY') && CIVICRM_MAIL_SMARTY
) {
1278 $smarty = CRM_Core_Smarty
::singleton();
1279 $escapeSmarty = TRUE;
1282 $sent = $notSent = array();
1283 foreach ($contactDetails as $values) {
1284 $contactId = $values['contact_id'];
1285 $emailAddress = $values['email'];
1287 if (!empty($details) && is_array($details["{$contactId}"])) {
1288 // unset email from details since it always returns primary email address
1289 unset($details["{$contactId}"]['email']);
1290 unset($details["{$contactId}"]['email_id']);
1291 $values = array_merge($values, $details["{$contactId}"]);
1294 $tokenSubject = CRM_Utils_Token
::replaceContactTokens($subject, $values, FALSE, $subjectToken, FALSE, $escapeSmarty);
1295 $tokenSubject = CRM_Utils_Token
::replaceHookTokens($tokenSubject, $values, $categories, FALSE, $escapeSmarty);
1298 if ($values['preferred_mail_format'] == 'Text' ||
$values['preferred_mail_format'] == 'Both') {
1299 $tokenText = CRM_Utils_Token
::replaceContactTokens($text, $values, FALSE, $messageToken, FALSE, $escapeSmarty);
1300 $tokenText = CRM_Utils_Token
::replaceHookTokens($tokenText, $values, $categories, FALSE, $escapeSmarty);
1306 if ($values['preferred_mail_format'] == 'HTML' ||
$values['preferred_mail_format'] == 'Both') {
1307 $tokenHtml = CRM_Utils_Token
::replaceContactTokens($html, $values, TRUE, $messageToken, FALSE, $escapeSmarty);
1308 $tokenHtml = CRM_Utils_Token
::replaceHookTokens($tokenHtml, $values, $categories, TRUE, $escapeSmarty);
1314 if (defined('CIVICRM_MAIL_SMARTY') && CIVICRM_MAIL_SMARTY
) {
1315 // also add the contact tokens to the template
1316 $smarty->assign_by_ref('contact', $values);
1318 $tokenSubject = $smarty->fetch("string:$tokenSubject");
1319 $tokenText = $smarty->fetch("string:$tokenText");
1320 $tokenHtml = $smarty->fetch("string:$tokenHtml");
1324 if (self
::sendMessage(
1341 return array($sent, $activity->id
);
1344 static function sendSMS(&$contactDetails,
1346 &$smsParams = array(),
1350 if ($userID == NULL) {
1351 $session = CRM_Core_Session
::singleton();
1352 $userID = $session->get('userID');
1355 $text = &$activityParams['text_message'];
1356 $html = &$activityParams['html_message'];
1359 // token replacement of addressee/email/postal greetings
1360 // get the tokens added in subject and message
1361 $messageToken = CRM_Utils_Token
::getTokens($text);
1362 $messageToken = array_merge($messageToken,
1363 CRM_Utils_Token
::getTokens($html)
1366 //create the meta level record first ( sms activity )
1367 $activityTypeID = CRM_Core_OptionGroup
::getValue('activity_type',
1372 // CRM-6265: save both text and HTML parts in details (if present)
1373 if ($html and $text) {
1374 $details = "-ALTERNATIVE ITEM 0-\n$html\n-ALTERNATIVE ITEM 1-\n$text\n-ALTERNATIVE END-\n";
1377 $details = $html ?
$html : $text;
1380 $activitySubject = $activityParams['activity_subject'];
1381 $activityParams = array(
1382 'source_contact_id' => $userID,
1383 'activity_type_id' => $activityTypeID,
1384 'activity_date_time' => date('YmdHis'),
1385 'subject' => $activitySubject,
1386 'details' => $details,
1387 // FIXME: check for name Completed and get ID from that lookup
1391 $activity = self
::create($activityParams);
1392 $activityID = $activity->id
;
1394 $returnProperties = array();
1396 if (isset($messageToken['contact'])) {
1397 foreach ($messageToken['contact'] as $key => $value) {
1398 $returnProperties[$value] = 1;
1404 CRM_Utils_Hook
::tokens($tokens);
1405 $categories = array_keys($tokens);
1407 // get token details for contacts, call only if tokens are used
1409 if (!empty($returnProperties) ||
!empty($tokens)) {
1410 list($details) = CRM_Utils_Token
::getTokenDetails($contactIds,
1414 'CRM_Activity_BAO_Activity'
1419 $escapeSmarty = FALSE;
1421 foreach ($contactDetails as $values) {
1422 $contactId = $values['contact_id'];
1424 if (!empty($details) && is_array($details["{$contactId}"])) {
1425 // unset email from details since it always returns primary email address
1426 unset($details["{$contactId}"]['email']);
1427 unset($details["{$contactId}"]['email_id']);
1428 $values = array_merge($values, $details["{$contactId}"]);
1431 $tokenText = CRM_Utils_Token
::replaceContactTokens($text, $values, FALSE, $messageToken, FALSE, $escapeSmarty);
1432 $tokenText = CRM_Utils_Token
::replaceHookTokens($tokenText, $values, $categories, FALSE, $escapeSmarty);
1434 $tokenHtml = CRM_Utils_Token
::replaceContactTokens($html, $values, TRUE, $messageToken, FALSE, $escapeSmarty);
1435 $tokenHtml = CRM_Utils_Token
::replaceHookTokens($tokenHtml, $values, $categories, TRUE, $escapeSmarty);
1437 // Only send if the phone is of type mobile
1438 $phoneTypes = CRM_Core_OptionGroup
::values('phone_type', TRUE, FALSE, FALSE, NULL, 'name');
1439 if ($values['phone_type_id'] == CRM_Utils_Array
::value('Mobile', $phoneTypes)) {
1440 $smsParams['To'] = $values['phone'];
1443 $smsParams['To'] = '';
1446 $sendResult = self
::sendSMSMessage(
1455 if (PEAR
::isError($sendResult)) {
1456 // Collect all of the PEAR_Error objects
1457 $errMsgs[] = $sendResult;
1463 // If at least one message was sent and no errors
1464 // were generated then return a boolean value of TRUE.
1465 // Otherwise, return FALSE (no messages sent) or
1466 // and array of 1 or more PEAR_Error objects.
1468 if ($success > 0 && count($errMsgs) == 0) {
1470 } elseif (count($errMsgs) > 0) {
1474 return array($sent, $activity->id
, $success);
1478 * send the sms message to a specific contact
1480 * @param int $toID the contact id of the recipient
1481 * @param int $activityID the activity ID that tracks the message
1482 * @param array $smsParams the params used for sending sms
1484 * @return mixed true on success or PEAR_Error object
1488 static function sendSMSMessage($toID,
1491 $smsParams = array(),
1496 $toPhoneNumber = "";
1498 if ($smsParams['To']) {
1499 $toPhoneNumber = trim($smsParams['To']);
1502 $filters = array('is_deceased' => 0, 'is_deleted' => 0, 'do_not_sms' => 0);
1503 $toPhoneNumbers = CRM_Core_BAO_Phone
::allPhones($toID, FALSE, 'Mobile', $filters);
1504 //to get primary mobile ph,if not get a first mobile ph
1505 if (!empty($toPhoneNumbers)) {
1506 $toPhoneNumerDetails = reset($toPhoneNumbers);
1507 $toPhoneNumber = CRM_Utils_Array
::value('phone', $toPhoneNumerDetails);
1508 //contact allows to send sms
1513 // make sure both phone are valid
1514 // and that the recipient wants to receive sms
1515 if (empty($toPhoneNumber) or $toDoNotSms) {
1516 return PEAR
::raiseError(
1517 'Recipient phone number is invalid or recipient does not want to receive SMS',
1523 $message = $tokenHtml ?
$tokenHtml : $tokenText;
1524 $recipient = $smsParams['To'];
1525 $smsParams['contact_id'] = $toID;
1526 $smsParams['parent_activity_id'] = $activityID;
1528 $providerObj = CRM_SMS_Provider
::singleton(array('provider_id' => $smsParams['provider_id']));
1529 $sendResult = $providerObj->send($recipient, $smsParams, $message, NULL, $userID);
1530 if (PEAR
::isError($sendResult)) {
1534 $activityContacts = CRM_Core_OptionGroup
::values('activity_contacts', FALSE, FALSE, FALSE, NULL, 'name');
1535 $targetID = CRM_Utils_Array
::key('Activity Targets', $activityContacts);
1538 // add activity target record for every sms that is send
1539 $activityTargetParams = array(
1540 'activity_id' => $activityID,
1541 'contact_id' => $toID,
1542 'record_type_id' => $targetID
1544 CRM_Activity_BAO_ActivityContact
::create($activityTargetParams);
1550 * send the message to a specific contact
1552 * @param string $from the name and email of the sender
1553 * @param int $toID the contact id of the recipient
1554 * @param string $subject the subject of the message
1555 * @param string $message the message contents
1556 * @param string $emailAddress use this 'to' email address instead of the default Primary address
1557 * @param int $activityID the activity ID that tracks the message
1559 * @return boolean true if successfull else false.
1563 static function sendMessage($from,
1571 $attachments = NULL,
1575 list($toDisplayName, $toEmail, $toDoNotEmail) = CRM_Contact_BAO_Contact
::getContactDetails($toID);
1576 if ($emailAddress) {
1577 $toEmail = trim($emailAddress);
1580 // make sure both email addresses are valid
1581 // and that the recipient wants to receive email
1582 if (empty($toEmail) or $toDoNotEmail) {
1585 if (!trim($toDisplayName)) {
1586 $toDisplayName = $toEmail;
1589 $activityContacts = CRM_Core_OptionGroup
::values('activity_contacts', FALSE, FALSE, FALSE, NULL, 'name');
1590 //$sourceID = CRM_Utils_Array::key('Activity Source', $activityContacts);
1591 //$assigneeID = CRM_Utils_Array::key('Activity Assignees', $activityContacts);
1592 $targetID = CRM_Utils_Array
::key('Activity Targets', $activityContacts);
1594 // create the params array
1595 $mailParams = array(
1596 'groupName' => 'Activity Email Sender',
1598 'toName' => $toDisplayName,
1599 'toEmail' => $toEmail,
1600 'subject' => $subject,
1603 'text' => $text_message,
1604 'html' => $html_message,
1605 'attachments' => $attachments,
1608 if (!CRM_Utils_Mail
::send($mailParams)) {
1612 // add activity target record for every mail that is send
1613 $activityTargetParams = array(
1614 'activity_id' => $activityID,
1615 'contact_id' => $toID,
1616 'record_type_id' => $targetID
1618 CRM_Activity_BAO_ActivityContact
::create($activityTargetParams);
1623 * combine all the importable fields from the lower levels object
1625 * The ordering is important, since currently we do not have a weight
1626 * scheme. Adding weight is super important and should be done in the
1627 * next week or so, before this can be called complete.
1631 * @return array array of importable Fields
1635 static function &importableFields($status = FALSE) {
1636 if (!self
::$_importableFields) {
1637 if (!self
::$_importableFields) {
1638 self
::$_importableFields = array();
1641 $fields = array('' => array('title' => ts('- do not import -')));
1644 $fields = array('' => array('title' => ts('- Activity Fields -')));
1647 $tmpFields = CRM_Activity_DAO_Activity
::import();
1648 $contactFields = CRM_Contact_BAO_Contact
::importableFields('Individual', NULL);
1650 // Using new Dedupe rule.
1651 $ruleParams = array(
1652 'contact_type' => 'Individual',
1653 'used' => 'Unsupervised',
1655 $fieldsArray = CRM_Dedupe_BAO_Rule
::dedupeRuleFields($ruleParams);
1657 $tmpConatctField = array();
1658 if (is_array($fieldsArray)) {
1659 foreach ($fieldsArray as $value) {
1660 $customFieldId = CRM_Core_DAO
::getFieldValue('CRM_Core_DAO_CustomField',
1665 $value = $customFieldId ?
'custom_' . $customFieldId : $value;
1666 $tmpConatctField[trim($value)] = $contactFields[trim($value)];
1667 $tmpConatctField[trim($value)]['title'] = $tmpConatctField[trim($value)]['title'] . " (match to contact)";
1670 $tmpConatctField['external_identifier'] = $contactFields['external_identifier'];
1671 $tmpConatctField['external_identifier']['title'] = $contactFields['external_identifier']['title'] . " (match to contact)";
1672 $fields = array_merge($fields, $tmpConatctField);
1673 $fields = array_merge($fields, $tmpFields);
1674 $fields = array_merge($fields, CRM_Core_BAO_CustomField
::getFieldsForImport('Activity'));
1675 self
::$_importableFields = $fields;
1677 return self
::$_importableFields;
1681 * To get the Activities of a target contact
1683 * @param $contactId Integer ContactId of the contact whose activities
1686 * @return array array of activity fields
1689 static function getContactActivity($contactId) {
1690 $activities = array();
1691 $activityContacts = CRM_Core_OptionGroup
::values('activity_contacts', FALSE, FALSE, FALSE, NULL, 'name');
1692 $sourceID = CRM_Utils_Array
::key('Activity Source', $activityContacts);
1693 $assigneeID = CRM_Utils_Array
::key('Activity Assignees', $activityContacts);
1694 $targetID = CRM_Utils_Array
::key('Activity Targets', $activityContacts);
1697 // First look for activities where contactId is one of the targets
1699 SELECT activity_id, record_type_id
1700 FROM civicrm_activity_contact
1701 WHERE contact_id = $contactId
1703 $dao = CRM_Core_DAO
::executeQuery($query);
1704 while ($dao->fetch()) {
1705 if ($dao->record_type_id
== $targetID ) {
1706 $activities[$dao->activity_id
]['targets'][$contactId] = $contactId;
1708 else if ($dao->record_type_id
== $assigneeID) {
1709 $activities[$dao->activity_id
]['asignees'][$contactId] = $contactId;
1712 // do source stuff here
1713 $activities[$dao->activity_id
]['source_contact_id'] = $contactId;
1717 $activityIds = array_keys($activities);
1718 if (count($activityIds) < 1) {
1722 $activityIds = implode(',', $activityIds);
1724 SELECT activity.id as activity_id,
1726 subject, location, activity_date_time, details, status_id
1727 FROM civicrm_activity activity
1728 WHERE activity.id IN ($activityIds)";
1730 $dao = CRM_Core_DAO
::executeQuery($query);
1732 $activityTypes = CRM_Core_OptionGroup
::values('activity_type');
1733 $activityStatuses = CRM_Core_OptionGroup
::values('activity_status');
1735 while ($dao->fetch()) {
1736 $activities[$dao->activity_id
]['id'] = $dao->activity_id
;
1737 $activities[$dao->activity_id
]['activity_type_id'] = $dao->activity_type_id
;
1738 $activities[$dao->activity_id
]['subject'] = $dao->subject
;
1739 $activities[$dao->activity_id
]['location'] = $dao->location
;
1740 $activities[$dao->activity_id
]['activity_date_time'] = $dao->activity_date_time
;
1741 $activities[$dao->activity_id
]['details'] = $dao->details
;
1742 $activities[$dao->activity_id
]['status_id'] = $dao->status_id
;
1743 $activities[$dao->activity_id
]['activity_name'] = $activityTypes[$dao->activity_type_id
];
1744 $activities[$dao->activity_id
]['status'] = $activityStatuses[$dao->status_id
];
1746 // set to null if not set
1747 if (!isset($activities[$dao->activity_id
]['source_contact_id'])) {
1748 $activities[$dao->activity_id
]['source_contact_id'] = NULL;
1755 * Function to add activity for Membership/Event/Contribution
1757 * @param object $activity (reference) particular component object
1758 * @param string $activityType for Membership Signup or Renewal
1764 static function addActivity(&$activity,
1765 $activityType = 'Membership Signup',
1766 $targetContactID = NULL
1768 if ($activity->__table
== 'civicrm_membership') {
1769 $membershipType = CRM_Member_PseudoConstant
::membershipType($activity->membership_type_id
);
1771 if (!$membershipType) {
1772 $membershipType = ts('Membership');
1775 $subject = "{$membershipType}";
1777 if (!empty($activity->source
) && $activity->source
!= 'null') {
1778 $subject .= " - {$activity->source}";
1781 if ($activity->owner_membership_id
) {
1784 FROM civicrm_contact, civicrm_membership
1785 WHERE civicrm_contact.id = civicrm_membership.contact_id
1786 AND civicrm_membership.id = $activity->owner_membership_id
1788 $displayName = CRM_Core_DAO
::singleValueQuery($query);
1789 $subject .= " (by {$displayName})";
1792 $subject .= " - Status: " . CRM_Core_DAO
::getFieldValue('CRM_Member_DAO_MembershipStatus', $activity->status_id
);
1793 // CRM-72097 changed from start date to today
1794 $date = date('YmdHis');
1795 $component = 'Membership';
1797 elseif ($activity->__table
== 'civicrm_participant') {
1798 $event = CRM_Event_BAO_Event
::getEvents(1, $activity->event_id
, TRUE, FALSE);
1800 $roles = CRM_Event_PseudoConstant
::participantRole();
1801 $status = CRM_Event_PseudoConstant
::participantStatus();
1803 $subject = $event[$activity->event_id
];
1804 if (CRM_Utils_Array
::value($activity->role_id
, $roles)) {
1805 $subject .= ' - ' . $roles[$activity->role_id
];
1807 if (CRM_Utils_Array
::value($activity->status_id
, $status)) {
1808 $subject .= ' - ' . $status[$activity->status_id
];
1810 $date = date('YmdHis');
1811 if ($activityType != 'Email') {
1812 $activityType = 'Event Registration';
1814 $component = 'Event';
1816 elseif ($activity->__table
== 'civicrm_contribution') {
1817 //create activity record only for Completed Contributions
1818 if ($activity->contribution_status_id
!= 1) {
1824 $subject .= CRM_Utils_Money
::format($activity->total_amount
, $activity->currency
);
1825 if (!empty($activity->source
) && $activity->source
!= 'null') {
1826 $subject .= " - {$activity->source}";
1828 $date = CRM_Utils_Date
::isoToMysql($activity->receive_date
);
1829 $activityType = $component = 'Contribution';
1831 $activityParams = array(
1832 'source_contact_id' => $activity->contact_id
,
1833 'source_record_id' => $activity->id
,
1834 'activity_type_id' => CRM_Core_OptionGroup
::getValue('activity_type',
1838 'subject' => $subject,
1839 'activity_date_time' => $date,
1840 'is_test' => $activity->is_test
,
1841 'status_id' => CRM_Core_OptionGroup
::getValue('activity_status',
1845 'skipRecentView' => TRUE,
1846 'campaign_id' => $activity->campaign_id
,
1849 // create activity with target contacts
1850 $session = CRM_Core_Session
::singleton();
1851 $id = $session->get('userID');
1853 $activityParams['source_contact_id'] = $id;
1854 $activityParams['target_contact_id'][] = $activity->contact_id
;
1858 if ($targetContactID) {
1859 $activityParams['target_contact_id'][] = $targetContactID;
1861 if (is_a(self
::create($activityParams), 'CRM_Core_Error')) {
1862 CRM_Core_Error
::fatal("Failed creating Activity for $component of id {$activity->id}");
1868 * Function to get Parent activity for currently viewed activity
1870 * @param int $activityId current activity id
1872 * @return int $parentId Id of parent activity otherwise false.
1875 static function getParentActivity($activityId) {
1876 static $parentActivities = array();
1878 $activityId = CRM_Utils_Type
::escape($activityId, 'Integer');
1880 if (!array_key_exists($activityId, $parentActivities)) {
1881 $parentActivities[$activityId] = array();
1883 $parentId = CRM_Core_DAO
::getFieldValue('CRM_Activity_DAO_Activity',
1888 $parentActivities[$activityId] = $parentId ?
$parentId : FALSE;
1891 return $parentActivities[$activityId];
1895 * Function to get total count of prior revision of currently viewd activity
1897 * @param int $activityId current activity id
1899 * @return int $params count of prior activities otherwise false.
1902 static function getPriorCount($activityID) {
1903 static $priorCounts = array();
1905 $activityID = CRM_Utils_Type
::escape($activityID, 'Integer');
1907 if (!array_key_exists($activityID, $priorCounts)) {
1908 $priorCounts[$activityID] = array();
1909 $originalID = CRM_Core_DAO
::getFieldValue('CRM_Activity_DAO_Activity',
1916 SELECT count( id ) AS cnt
1917 FROM civicrm_activity
1918 WHERE ( id = {$originalID} OR original_id = {$originalID} )
1919 AND is_current_revision = 0
1920 AND id < {$activityID}
1922 $params = array(1 => array($originalID, 'Integer'));
1923 $count = CRM_Core_DAO
::singleValueQuery($query, $params);
1925 $priorCounts[$activityID] = $count ?
$count : 0;
1928 return $priorCounts[$activityID];
1932 * Function to get all prior activities of currently viewe
1935 * @param int $activityId current activity id
1937 * @return array $result prior activities info.
1940 static function getPriorAcitivities($activityID, $onlyPriorRevisions = FALSE) {
1941 static $priorActivities = array();
1943 $activityID = CRM_Utils_Type
::escape($activityID, 'Integer');
1944 $index = $activityID . '_' . (int) $onlyPriorRevisions;
1946 if (!array_key_exists($index, $priorActivities)) {
1947 $priorActivities[$index] = array();
1949 $originalID = CRM_Core_DAO
::getFieldValue('CRM_Activity_DAO_Activity',
1955 SELECT c.display_name as name, cl.modified_date as date, ca.id as activityID
1956 FROM civicrm_log cl, civicrm_contact c, civicrm_activity ca
1957 WHERE (ca.id = %1 OR ca.original_id = %1)
1958 AND cl.entity_table = 'civicrm_activity'
1959 AND cl.entity_id = ca.id
1960 AND cl.modified_id = c.id
1962 if ($onlyPriorRevisions) {
1963 $query .= " AND ca.id < {$activityID}";
1965 $query .= " ORDER BY ca.id DESC";
1967 $params = array(1 => array($originalID, 'Integer'));
1968 $dao = CRM_Core_DAO
::executeQuery($query, $params);
1970 while ($dao->fetch()) {
1971 $priorActivities[$index][$dao->activityID
]['id'] = $dao->activityID
;
1972 $priorActivities[$index][$dao->activityID
]['name'] = $dao->name
;
1973 $priorActivities[$index][$dao->activityID
]['date'] = $dao->date
;
1974 $priorActivities[$index][$dao->activityID
]['link'] = 'javascript:viewActivity( $dao->activityID );';
1979 return $priorActivities[$index];
1983 * Function to find the latest revision of a given activity
1985 * @param int $activityId prior activity id
1987 * @return int $params current activity id.
1990 static function getLatestActivityId($activityID) {
1991 static $latestActivityIds = array();
1993 $activityID = CRM_Utils_Type
::escape($activityID, 'Integer');
1995 if (!array_key_exists($activityID, $latestActivityIds)) {
1996 $latestActivityIds[$activityID] = array();
1998 $originalID = CRM_Core_DAO
::getFieldValue('CRM_Activity_DAO_Activity',
2003 $activityID = $originalID;
2005 $params = array(1 => array($activityID, 'Integer'));
2006 $query = "SELECT id from civicrm_activity where original_id = %1 and is_current_revision = 1";
2008 $latestActivityIds[$activityID] = CRM_Core_DAO
::singleValueQuery($query, $params);
2011 return $latestActivityIds[$activityID];
2015 * Function to create a follow up a given activity
2017 * @activityId int activity id of parent activity
2019 * @param array $activity details
2023 static function createFollowupActivity($activityId, $params) {
2028 $session = CRM_Core_Session
::singleton();
2030 $followupParams = array();
2031 $followupParams['parent_id'] = $activityId;
2032 $followupParams['source_contact_id'] = $session->get('userID');
2033 $followupParams['status_id'] = CRM_Core_OptionGroup
::getValue('activity_status', 'Scheduled', 'name');
2035 $followupParams['activity_type_id'] = $params['followup_activity_type_id'];
2036 // Get Subject of Follow-up Activiity, CRM-4491
2037 $followupParams['subject'] = CRM_Utils_Array
::value('followup_activity_subject', $params);
2039 //create target contact for followup
2040 if (CRM_Utils_Array
::value('target_contact_id', $params)) {
2041 $followupParams['target_contact_id'] = $params['target_contact_id'];
2044 $followupParams['activity_date_time'] = CRM_Utils_Date
::processDate($params['followup_date'],
2045 $params['followup_date_time']
2047 $followupActivity = self
::create($followupParams);
2049 return $followupActivity;
2053 * Function to get Activity specific File according activity type Id.
2055 * @param int $activityTypeId activity id
2057 * @return if file exists returns $activityTypeFile activity filename otherwise false.
2061 static function getFileForActivityTypeId($activityTypeId, $crmDir = 'Activity') {
2062 $activityTypes = CRM_Case_PseudoConstant
::caseActivityType(FALSE, TRUE);
2064 if ($activityTypes[$activityTypeId]['name']) {
2065 $activityTypeFile = CRM_Utils_String
::munge(ucwords($activityTypes[$activityTypeId]['name']), '', 0);
2071 global $civicrm_root;
2072 $config = CRM_Core_Config
::singleton();
2073 if (!file_exists(rtrim($civicrm_root, '/') . "/CRM/{$crmDir}/Form/Activity/{$activityTypeFile}.php")) {
2074 if (empty($config->customPHPPathDir
)) {
2077 elseif (!file_exists(rtrim($config->customPHPPathDir
, '/') . "/CRM/{$crmDir}/Form/Activity/{$activityTypeFile}.php")) {
2082 return $activityTypeFile;
2086 * Function to restore the activity
2088 * @param array $params associated array
2094 public static function restoreActivity(&$params) {
2095 $activity = new CRM_Activity_DAO_Activity();
2096 $activity->copyValues($params);
2098 $activity->is_deleted
= 0;
2099 $result = $activity->save();
2105 * Get the exportable fields for Activities
2107 * @param string $name if it is called by case $name = Case else $name = Activity
2109 * @return array array of exportable Fields
2113 static function &exportableFields($name = 'Activity') {
2114 if (!isset(self
::$_exportableFields[$name])) {
2115 self
::$_exportableFields[$name] = array();
2117 // TO DO, ideally we should retrieve all fields from xml, in this case since activity processing is done
2118 // my case hence we have defined fields as case_*
2119 if ($name == 'Activity') {
2120 $exportableFields = CRM_Activity_DAO_Activity
::export();
2121 if (isset($exportableFields['activity_campaign_id'])) {
2122 $exportableFields['activity_campaign'] = array('title' => ts('Campaign Title'));
2124 $exportableFields['source_contact_id']['title'] = ts('Source Contact ID');
2125 $exportableFields['source_contact'] = array(
2126 'title' => ts('Source Contact'),
2127 'type' => CRM_Utils_Type
::T_STRING
,
2131 $Activityfields = array(
2132 'activity_type' => array('title' => ts('Activity Type'), 'type' => CRM_Utils_Type
::T_STRING
),
2133 'activity_status' => array('title' => ts('Activity Status'), 'type' => CRM_Utils_Type
::T_STRING
),
2135 $fields = array_merge($Activityfields, $exportableFields);
2138 //set title to activity fields
2140 'case_activity_subject' => array('title' => ts('Activity Subject'), 'type' => CRM_Utils_Type
::T_STRING
),
2141 'case_source_contact_id' => array('title' => ts('Activity Reporter'), 'type' => CRM_Utils_Type
::T_STRING
),
2142 'case_recent_activity_date' => array('title' => ts('Activity Actual Date'), 'type' => CRM_Utils_Type
::T_DATE
),
2143 'case_scheduled_activity_date' => array('title' => ts('Activity Scheduled Date'), 'type' => CRM_Utils_Type
::T_DATE
),
2144 'case_recent_activity_type' => array('title' => ts('Activity Type'), 'type' => CRM_Utils_Type
::T_STRING
),
2145 'case_activity_status' => array('title' => ts('Activity Status'), 'type' => CRM_Utils_Type
::T_STRING
),
2146 'case_activity_duration' => array('title' => ts('Activity Duration'), 'type' => CRM_Utils_Type
::T_INT
),
2147 'case_activity_medium_id' => array('title' => ts('Activity Medium'), 'type' => CRM_Utils_Type
::T_INT
),
2148 'case_activity_details' => array('title' => ts('Activity Details'), 'type' => CRM_Utils_Type
::T_TEXT
),
2149 'case_activity_is_auto' => array('title' => ts('Activity Auto-generated?'), 'type' => CRM_Utils_Type
::T_BOOLEAN
),
2152 // add custom data for cases
2153 $fields = array_merge($fields, CRM_Core_BAO_CustomField
::getFieldsForImport('Case'));
2156 // add custom data for case activities
2157 $fields = array_merge($fields, CRM_Core_BAO_CustomField
::getFieldsForImport('Activity'));
2159 self
::$_exportableFields[$name] = $fields;
2161 return self
::$_exportableFields[$name];
2165 * Get the allowed profile fields for Activities
2167 * @return array array of activity profile Fields
2170 static function getProfileFields() {
2171 $exportableFields = self
::exportableFields('Activity');
2172 $skipFields = array(
2175 'source_contact_id',
2177 'activity_campaign',
2179 'is_current_revision',
2180 'activity_is_deleted',
2182 $config = CRM_Core_Config
::singleton();
2183 if (!in_array('CiviCampaign', $config->enableComponents
)) {
2184 $skipFields[] = 'activity_engagement_level';
2187 foreach ($skipFields as $field) {
2188 if (isset($exportableFields[$field])) {
2189 unset($exportableFields[$field]);
2193 // hack to use 'activity_type_id' instead of 'activity_type'
2194 $exportableFields['activity_status_id'] = $exportableFields['activity_status'];
2195 unset($exportableFields['activity_status']);
2197 return $exportableFields;
2201 * This function delete activity record related to contact record,
2202 * when there are no target and assignee record w/ other contact.
2204 * @param int $contactId contactId
2209 public static function cleanupActivity($contactId) {
2214 $activityContacts = CRM_Core_OptionGroup
::values('activity_contacts', FALSE, FALSE, FALSE, NULL, 'name');
2215 $sourceID = CRM_Utils_Array
::key('Activity Source', $activityContacts);
2217 $transaction = new CRM_Core_Transaction();
2219 // delete activity if there is no record in
2220 // civicrm_activity_contact
2221 // pointing to any other contact record.
2222 $activityContact = new CRM_Activity_DAO_ActivityContact();
2223 $activityContact->contact_id
= $contactId;
2224 $activityContact->record_type_id
= $sourceID;
2225 $activityContact->find();
2227 while ($activityContact->fetch()) {
2228 // finally delete activity.
2229 $activityParams = array('id' => $activityContact->activity_id
);
2230 $result = self
::deleteActivity($activityParams);
2233 $activityContact->free();
2234 $transaction->commit();
2240 * Does user has sufficient permission for view/edit activity record.
2242 * @param int $activityId activity record id.
2243 * @param int $action edit/view
2245 * @return boolean $allow true/false
2248 public static function checkPermission($activityId, $action) {
2251 !in_array($action, array(CRM_Core_Action
::UPDATE
, CRM_Core_Action
::VIEW
))
2256 $activity = new CRM_Activity_DAO_Activity();
2257 $activity->id
= $activityId;
2258 if (!$activity->find(TRUE)) {
2262 //component related permissions.
2263 $compPermissions = array(
2264 'CiviCase' => array('administer CiviCase',
2265 'access my cases and activities',
2266 'access all cases and activities',
2268 'CiviMail' => array('access CiviMail'),
2269 'CiviEvent' => array('access CiviEvent'),
2270 'CiviGrant' => array('access CiviGrant'),
2271 'CiviPledge' => array('access CiviPledge'),
2272 'CiviMember' => array('access CiviMember'),
2273 'CiviReport' => array('access CiviReport'),
2274 'CiviContribute' => array('access CiviContribute'),
2275 'CiviCampaign' => array('administer CiviCampaign'),
2278 //return early when it is case activity.
2279 $isCaseActivity = CRM_Case_BAO_Case
::isCaseActivity($activityId);
2280 //check for civicase related permission.
2281 if ($isCaseActivity) {
2283 foreach ($compPermissions['CiviCase'] as $per) {
2284 if (CRM_Core_Permission
::check($per)) {
2290 //check for case specific permissions.
2293 if ($action == CRM_Core_Action
::UPDATE
) {
2296 $allow = CRM_Case_BAO_Case
::checkPermission($activityId,
2298 $activity->activity_type_id
2305 //first check the component permission.
2308 FROM civicrm_option_value val
2309 INNER JOIN civicrm_option_group grp ON ( grp.id = val.option_group_id AND grp.name = %1 )
2310 WHERE val.value = %2";
2311 $params = array(1 => array('activity_type', 'String'),
2312 2 => array($activity->activity_type_id
, 'Integer'),
2314 $componentId = CRM_Core_DAO
::singleValueQuery($sql, $params);
2317 $componentName = CRM_Core_Component
::getComponentName($componentId);
2318 $compPermission = CRM_Utils_Array
::value($componentName, $compPermissions);
2320 //here we are interesting in any single permission.
2321 if (is_array($compPermission)) {
2322 foreach ($compPermission as $per) {
2323 if (CRM_Core_Permission
::check($per)) {
2331 //check for this permission related to contact.
2332 $permission = CRM_Core_Permission
::VIEW
;
2333 if ($action == CRM_Core_Action
::UPDATE
) {
2334 $permission = CRM_Core_Permission
::EDIT
;
2337 $activityContacts = CRM_Core_OptionGroup
::values('activity_contacts', FALSE, FALSE, FALSE, NULL, 'name');
2338 $sourceID = CRM_Utils_Array
::key('Activity Source', $activityContacts);
2339 $assigneeID = CRM_Utils_Array
::key('Activity Assignees', $activityContacts);
2340 $targetID = CRM_Utils_Array
::key('Activity Targets', $activityContacts);
2342 //check for source contact.
2343 if (!$componentId ||
$allow) {
2344 $sourceContactId = self
::getActivityContact($activity->id
, $sourceID);
2345 $allow = CRM_Contact_BAO_Contact_Permission
::allow($sourceContactId, $permission);
2348 //check for target and assignee contacts.
2350 //first check for supper permission.
2351 $supPermission = 'view all contacts';
2352 if ($action == CRM_Core_Action
::UPDATE
) {
2353 $supPermission = 'edit all contacts';
2355 $allow = CRM_Core_Permission
::check($supPermission);
2357 //user might have sufficient permission, through acls.
2360 //get the target contacts.
2361 $targetContacts = CRM_Activity_BAO_ActivityContact
::retrieveContactIdsByActivityId($activity->id
, $targetID);
2362 foreach ($targetContacts as $cnt => $contactId) {
2363 if (!CRM_Contact_BAO_Contact_Permission
::allow($contactId, $permission)) {
2369 //get the assignee contacts.
2371 $assigneeContacts = CRM_Activity_BAO_Contact
::retrieveContactIdsByActivityId($activity->id
, $assigneeID);
2372 foreach ($assigneeContacts as $cnt => $contactId) {
2373 if (!CRM_Contact_BAO_Contact_Permission
::allow($contactId, $permission)) {
2386 * This function is a wrapper for ajax activity selector
2388 * @param array $params associated array for params record id.
2390 * @return array $contactActivities associated array of contact activities
2393 public static function getContactActivitySelector(&$params) {
2394 // format the params
2395 $params['offset'] = ($params['page'] - 1) * $params['rp'];
2396 $params['rowCount'] = $params['rp'];
2397 $params['sort'] = CRM_Utils_Array
::value('sortBy', $params);
2398 $params['caseId'] = NULL;
2399 $context = CRM_Utils_Array
::value('context', $params);
2401 // get contact activities
2402 $activities = CRM_Activity_BAO_Activity
::getActivities($params);
2405 $params['total'] = CRM_Activity_BAO_Activity
::getActivitiesCount($params);
2407 // format params and add links
2408 $contactActivities = array();
2410 if (!empty($activities)) {
2411 $activityStatus = CRM_Core_PseudoConstant
::activityStatus();
2413 // check logged in user for permission
2414 $page = new CRM_Core_Page();
2415 CRM_Contact_Page_View
::checkUserPermission($page, $params['contact_id']);
2416 $permissions = array($page->_permission
);
2417 if (CRM_Core_Permission
::check('delete activities')) {
2418 $permissions[] = CRM_Core_Permission
::DELETE
;
2421 $mask = CRM_Core_Action
::mask($permissions);
2423 foreach ($activities as $activityId => $values) {
2424 $contactActivities[$activityId]['activity_type'] = $values['activity_type'];
2425 $contactActivities[$activityId]['subject'] = $values['subject'];
2426 if ($params['contact_id'] == $values['source_contact_id']) {
2427 $contactActivities[$activityId]['source_contact'] = $values['source_contact_name'];
2429 elseif ($values['source_contact_id']) {
2430 $contactActivities[$activityId]['source_contact'] = CRM_Utils_System
::href($values['source_contact_name'],
2431 'civicrm/contact/view', "reset=1&cid={$values['source_contact_id']}");
2434 $contactActivities[$activityId]['source_contact'] = '<em>n/a</em>';
2437 if (isset($values['mailingId']) && !empty($values['mailingId'])) {
2438 $contactActivities[$activityId]['target_contact'] = CRM_Utils_System
::href($values['recipients'],
2439 'civicrm/mailing/report/event',
2440 "mid={$values['source_record_id']}&reset=1&event=queue&cid={$params['contact_id']}&context=activitySelector");
2442 elseif (CRM_Utils_Array
::value('recipients', $values)) {
2443 $contactActivities[$activityId]['target_contact'] = $values['recipients'];
2445 elseif (!$values['target_contact_name']) {
2446 $contactActivities[$activityId]['target_contact'] = '<em>n/a</em>';
2448 elseif (!empty($values['target_contact_name'])) {
2450 $contactActivities[$activityId]['target_contact'] = '';
2451 foreach ($values['target_contact_name'] as $tcID => $tcName) {
2452 if ($tcID && $count < 5) {
2453 $contactActivities[$activityId]['target_contact'] .= CRM_Utils_System
::href($tcName,
2454 'civicrm/contact/view', "reset=1&cid={$tcID}");
2457 $contactActivities[$activityId]['target_contact'] .= "; ";
2461 $contactActivities[$activityId]['target_contact'] .= "(" . ts('more') . ")";
2468 if (empty($values['assignee_contact_name'])) {
2469 $contactActivities[$activityId]['assignee_contact'] = '<em>n/a</em>';
2471 elseif (!empty($values['assignee_contact_name'])) {
2473 $contactActivities[$activityId]['assignee_contact'] = '';
2474 foreach ($values['assignee_contact_name'] as $acID => $acName) {
2475 if ($acID && $count < 5) {
2476 $contactActivities[$activityId]['assignee_contact'] .= CRM_Utils_System
::href($acName, 'civicrm/contact/view', "reset=1&cid={$acID}");
2479 $contactActivities[$activityId]['assignee_contact'] .= "; ";
2483 $contactActivities[$activityId]['assignee_contact'] .= "(" . ts('more') . ")";
2490 $contactActivities[$activityId]['activity_date'] = CRM_Utils_Date
::customFormat($values['activity_date_time']);
2491 $contactActivities[$activityId]['status'] = $activityStatus[$values['status_id']];
2493 // add class to this row if overdue
2494 $contactActivities[$activityId]['class'] = '';
2495 if (CRM_Utils_Date
::overdue(CRM_Utils_Array
::value('activity_date_time', $values))
2496 && CRM_Utils_Array
::value('status_id', $values) == 1
2498 $contactActivities[$activityId]['class'] = 'status-overdue';
2501 $contactActivities[$activityId]['class'] = 'status-ontime';
2505 $contactActivities[$activityId]['links'] = '';
2506 $accessMailingReport = FALSE;
2507 if (CRM_Utils_Array
::value('mailingId', $values)) {
2508 $accessMailingReport = TRUE;
2511 $actionLinks = CRM_Activity_Selector_Activity
::actionLinks(
2512 CRM_Utils_Array
::value('activity_type_id', $values),
2513 CRM_Utils_Array
::value('source_record_id', $values),
2514 $accessMailingReport,
2515 CRM_Utils_Array
::value('activity_id', $values)
2518 $actionMask = array_sum(array_keys($actionLinks)) & $mask;
2520 $contactActivities[$activityId]['links'] = CRM_Core_Action
::formLink($actionLinks,
2523 'id' => $values['activity_id'],
2524 'cid' => $params['contact_id'],
2526 'caseid' => CRM_Utils_Array
::value('case_id', $values),
2532 return $contactActivities;
2536 * Used to copy custom fields and attachments from an existing activity to another.
2537 * see CRM_Case_Page_AJAX::_convertToCaseActivity() for example
2539 static function copyExtendedActivityData($params) {
2540 // attach custom data to the new activity
2541 $customParams = $htmlType = array();
2542 $customValues = CRM_Core_BAO_CustomValueTable
::getEntityValues($params['activityID'], 'Activity');
2544 if (!empty($customValues)) {
2545 $fieldIds = implode(', ', array_keys($customValues));
2546 $sql = "SELECT id FROM civicrm_custom_field WHERE html_type = 'File' AND id IN ( {$fieldIds} )";
2547 $result = CRM_Core_DAO
::executeQuery($sql);
2549 while ($result->fetch()) {
2550 $htmlType[] = $result->id
;
2553 foreach ($customValues as $key => $value) {
2554 if ($value !== NULL) { // CRM-10542
2555 if (in_array($key, $htmlType)) {
2556 $fileValues = CRM_Core_BAO_File
::path($value, $params['activityID']);
2557 $customParams["custom_{$key}_-1"] = array(
2558 'name' => $fileValues[0],
2559 'path' => $fileValues[1],
2563 $customParams["custom_{$key}_-1"] = $value;
2567 CRM_Core_BAO_CustomValueTable
::postProcess($customParams, CRM_Core_DAO
::$_nullArray, 'civicrm_activity',
2568 $params['mainActivityId'], 'Activity'
2572 // copy activity attachments ( if any )
2573 CRM_Core_BAO_File
::copyEntityFile('civicrm_activity', $params['activityID'], 'civicrm_activity', $params['mainActivityId']);
2576 public static function getActivityContact($activityId, $recordTypeID = NULL, $column = 'contact_id') {
2577 $activityContact = new CRM_Activity_BAO_ActivityContact();
2578 $activityContact->activity_id
= $activityId;
2579 if ($recordTypeID) {
2580 $activityContact->record_type_id
= $recordTypeID;
2582 if ($activityContact->find(TRUE)) {
2583 return $activityContact->$column;
2588 public static function getSourceContactID($activityId) {
2589 static $sourceID = NULL;
2591 $activityContacts = CRM_Core_OptionGroup
::values('activity_contacts', FALSE, FALSE, FALSE, NULL, 'name');
2592 $sourceID = CRM_Utils_Array
::key('Activity Source', $activityContacts);
2595 return self
::getActivityContact($activityId, $sourceID);