3 +--------------------------------------------------------------------+
4 | CiviCRM version 4.7 |
5 +--------------------------------------------------------------------+
6 | Copyright CiviCRM LLC (c) 2004-2016 |
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-2016
35 * This class is for activity functions.
37 class CRM_Activity_BAO_Activity
extends CRM_Activity_DAO_Activity
{
40 * Static field for all the activity information that we can potentially export.
44 static $_exportableFields = NULL;
47 * Static field for all the activity information that we can potentially import.
51 static $_importableFields = NULL;
54 * Check if there is absolute minimum of data to add the object.
56 * @param array $params
57 * (reference ) an assoc array of name/value pairs.
61 public static function dataExists(&$params) {
62 if (!empty($params['source_contact_id']) ||
!empty($params['id'])) {
69 * Fetch object based on array of properties.
71 * @param array $params
72 * (reference ) an assoc array of name/value pairs.
73 * @param array $defaults
74 * (reference ) an assoc array to hold the flattened values.
76 * @return CRM_Activity_DAO_Activity
78 public static function retrieve(&$params, &$defaults) {
79 $activity = new CRM_Activity_DAO_Activity();
80 $activity->copyValues($params);
82 if ($activity->find(TRUE)) {
83 $activityContacts = CRM_Core_OptionGroup
::values('activity_contacts', FALSE, FALSE, FALSE, NULL, 'name');
84 $targetID = CRM_Utils_Array
::key('Activity Targets', $activityContacts);
85 $sourceID = CRM_Utils_Array
::key('Activity Source', $activityContacts);
86 $assigneeID = CRM_Utils_Array
::key('Activity Assignees', $activityContacts);
88 // TODO: at some stage we'll have to deal
89 // with multiple values for assignees and targets, but
90 // for now, let's just fetch first row.
91 $defaults['assignee_contact'] = CRM_Activity_BAO_ActivityContact
::retrieveContactIdsByActivityId($activity->id
, $assigneeID);
92 $assignee_contact_names = CRM_Activity_BAO_ActivityContact
::getNames($activity->id
, $assigneeID);
93 $defaults['assignee_contact_value'] = implode('; ', $assignee_contact_names);
94 $sourceContactId = self
::getActivityContact($activity->id
, $sourceID);
95 if ($activity->activity_type_id
!= CRM_Core_OptionGroup
::getValue('activity_type', 'Bulk Email', 'name')) {
96 $defaults['target_contact'] = CRM_Activity_BAO_ActivityContact
::retrieveContactIdsByActivityId($activity->id
, $targetID);
97 $target_contact_names = CRM_Activity_BAO_ActivityContact
::getNames($activity->id
, $targetID);
98 $defaults['target_contact_value'] = implode('; ', $target_contact_names);
100 elseif (CRM_Core_Permission
::check('access CiviMail') ||
101 (CRM_Mailing_Info
::workflowEnabled() &&
102 CRM_Core_Permission
::check('create mailings')
105 $defaults['mailingId'] = CRM_Utils_System
::url('civicrm/mailing/report',
106 "mid={$activity->source_record_id}&reset=1&atype={$activity->activity_type_id}&aid={$activity->id}&cid={$sourceContactId}&context=activity"
110 $defaults['target_contact_value'] = ts('(recipients)');
113 $sourceContactId = self
::getActivityContact($activity->id
, $sourceID);
114 $defaults['source_contact_id'] = $sourceContactId;
116 if ($sourceContactId &&
117 !CRM_Core_DAO
::getFieldValue('CRM_Contact_DAO_Contact',
122 $defaults['source_contact'] = CRM_Core_DAO
::getFieldValue('CRM_Contact_DAO_Contact',
129 $defaults['case_subject'] = CRM_Case_BAO_Case
::getCaseSubject($activity->id
);
131 CRM_Core_DAO
::storeValues($activity, $defaults);
139 * Delete the activity.
141 * @param array $params
142 * @param bool $moveToTrash
146 public static function deleteActivity(&$params, $moveToTrash = FALSE) {
148 if (!empty($params['id']) && !is_array($params['id'])) {
149 CRM_Utils_Hook
::pre('delete', 'Activity', $params['id'], $params);
152 CRM_Utils_Hook
::pre('delete', 'Activity', NULL, $params);
155 $transaction = new CRM_Core_Transaction();
156 if (is_array(CRM_Utils_Array
::value('source_record_id', $params))) {
157 $sourceRecordIds = implode(',', $params['source_record_id']);
160 $sourceRecordIds = CRM_Utils_Array
::value('source_record_id', $params);
165 if (!isset($params['id'])) {
166 if (is_array($params['activity_type_id'])) {
167 $activityTypes = implode(',', $params['activity_type_id']);
170 $activityTypes = $params['activity_type_id'];
173 $query = "DELETE FROM civicrm_activity WHERE source_record_id IN ({$sourceRecordIds}) AND activity_type_id IN ( {$activityTypes} )";
174 $dao = CRM_Core_DAO
::executeQuery($query);
177 $activity = new CRM_Activity_DAO_Activity();
178 $activity->copyValues($params);
179 $result = $activity->delete();
182 $activity->case_id
= CRM_Case_BAO_Case
::getCaseIdByActivityId($activity->id
);
184 // CRM-13994 delete activity entity_tag
185 $query = "DELETE FROM civicrm_entity_tag WHERE entity_table = 'civicrm_activity' AND entity_id = {$activity->id}";
186 $dao = CRM_Core_DAO
::executeQuery($query);
190 $activity = new CRM_Activity_DAO_Activity();
191 $activity->copyValues($params);
193 $activity->is_deleted
= 1;
194 $result = $activity->save();
196 // CRM-4525 log activity delete
197 $logMsg = 'Case Activity deleted for';
200 $activityContacts = CRM_Core_OptionGroup
::values('activity_contacts', FALSE, FALSE, FALSE, NULL, 'name');
201 $sourceID = CRM_Utils_Array
::key('Activity Source', $activityContacts);
202 $assigneeID = CRM_Utils_Array
::key('Activity Assignees', $activityContacts);
203 $targetID = CRM_Utils_Array
::key('Activity Targets', $activityContacts);
204 $sourceContactId = self
::getActivityContact($activity->id
, $sourceID);
205 if ($sourceContactId) {
206 $msgs[] = " source={$sourceContactId}";
209 // get target contacts.
210 $targetContactIds = CRM_Activity_BAO_ActivityContact
::getNames($activity->id
, $targetID);
211 if (!empty($targetContactIds)) {
212 $msgs[] = " target =" . implode(',', array_keys($targetContactIds));
214 // get assignee contacts.
215 $assigneeContactIds = CRM_Activity_BAO_ActivityContact
::getNames($activity->id
, $assigneeID);
216 if (!empty($assigneeContactIds)) {
217 $msgs[] = " assignee =" . implode(',', array_keys($assigneeContactIds));
220 $logMsg .= implode(', ', $msgs);
222 self
::logActivityAction($activity, $logMsg);
225 // delete the recently created Activity
227 $activityRecent = array(
228 'id' => $activity->id
,
229 'type' => 'Activity',
231 CRM_Utils_Recent
::del($activityRecent);
234 $transaction->commit();
235 if (isset($activity)) {
237 $activity->case_id
= CRM_Case_BAO_Case
::getCaseIdByActivityId($activity->id
);
238 CRM_Utils_Hook
::post('delete', 'Activity', $activity->id
, $activity);
245 * Delete activity assignment record.
247 * @param int $activityId
248 * @param int $recordTypeID
250 public static function deleteActivityContact($activityId, $recordTypeID = NULL) {
251 $activityContact = new CRM_Activity_BAO_ActivityContact();
252 $activityContact->activity_id
= $activityId;
254 $activityContact->record_type_id
= $recordTypeID;
257 // Let's check if activity contact record exits and then delete.
258 // Looks like delete leads to deadlock when multiple simultaneous
259 // requests are done. CRM-15470
260 if ($activityContact->find()) {
261 $activityContact->delete();
266 * Process the activities.
268 * @param array $params
269 * Associated array of the submitted values.
271 * @throws CRM_Core_Exception
273 * @return CRM_Activity_BAO_Activity|null|object
275 public static function create(&$params) {
276 // check required params
277 if (!self
::dataExists($params)) {
278 throw new CRM_Core_Exception('Not enough data to create activity object');
281 $activity = new CRM_Activity_DAO_Activity();
283 if (isset($params['id']) && empty($params['id'])) {
284 unset($params['id']);
287 if (empty($params['status_id']) && empty($params['activity_status_id']) && empty($params['id'])) {
288 if (isset($params['activity_date_time']) &&
289 strcmp($params['activity_date_time'], CRM_Utils_Date
::processDate(date('Ymd')) == -1)
291 $params['status_id'] = 2;
294 $params['status_id'] = 1;
298 // Set priority to Normal for Auto-populated activities (for Cases)
299 if (CRM_Utils_Array
::value('priority_id', $params) === NULL &&
300 // if not set and not 0
301 !CRM_Utils_Array
::value('id', $params)
303 $priority = CRM_Core_PseudoConstant
::get('CRM_Activity_DAO_Activity', 'priority_id');
304 $params['priority_id'] = array_search('Normal', $priority);
307 if (!empty($params['target_contact_id']) && is_array($params['target_contact_id'])) {
308 $params['target_contact_id'] = array_unique($params['target_contact_id']);
310 if (!empty($params['assignee_contact_id']) && is_array($params['assignee_contact_id'])) {
311 $params['assignee_contact_id'] = array_unique($params['assignee_contact_id']);
315 if (!empty($params['id'])) {
316 CRM_Utils_Hook
::pre('edit', 'Activity', $activity->id
, $params);
319 CRM_Utils_Hook
::pre('create', 'Activity', NULL, $params);
322 $activity->copyValues($params);
323 if (isset($params['case_id'])) {
324 // CRM-8708, preserve case ID even though it's not part of the SQL model
325 $activity->case_id
= $params['case_id'];
327 elseif (is_numeric($activity->id
)) {
328 // CRM-8708, preserve case ID even though it's not part of the SQL model
329 $activity->case_id
= CRM_Case_BAO_Case
::getCaseIdByActivityId($activity->id
);
333 $transaction = new CRM_Core_Transaction();
335 $result = $activity->save();
337 if (is_a($result, 'CRM_Core_Error')) {
338 $transaction->rollback();
342 $activityId = $activity->id
;
343 $activityContacts = CRM_Core_OptionGroup
::values('activity_contacts', FALSE, FALSE, FALSE, NULL, 'name');
344 $sourceID = CRM_Utils_Array
::key('Activity Source', $activityContacts);
345 $assigneeID = CRM_Utils_Array
::key('Activity Assignees', $activityContacts);
346 $targetID = CRM_Utils_Array
::key('Activity Targets', $activityContacts);
348 if (isset($params['source_contact_id'])) {
350 'activity_id' => $activityId,
351 'contact_id' => $params['source_contact_id'],
352 'record_type_id' => $sourceID,
354 self
::deleteActivityContact($activityId, $sourceID);
355 CRM_Activity_BAO_ActivityContact
::create($acParams);
358 // check and attach and files as needed
359 CRM_Core_BAO_File
::processAttachment($params, 'civicrm_activity', $activityId);
361 // attempt to save activity assignment
362 $resultAssignment = NULL;
363 if (!empty($params['assignee_contact_id'])) {
365 $assignmentParams = array('activity_id' => $activityId);
367 if (is_array($params['assignee_contact_id'])) {
368 if (CRM_Utils_Array
::value('deleteActivityAssignment', $params, TRUE)) {
369 // first delete existing assignments if any
370 self
::deleteActivityContact($activityId, $assigneeID);
374 foreach ($params['assignee_contact_id'] as $acID) {
376 $values[] = "( $activityId, $acID, $assigneeID )";
379 while (!empty($values)) {
380 $input = array_splice($values, 0, CRM_Core_DAO
::BULK_INSERT_COUNT
);
381 $str = implode(',', $input);
382 $sql = "INSERT IGNORE INTO civicrm_activity_contact ( activity_id, contact_id, record_type_id ) VALUES $str;";
383 CRM_Core_DAO
::executeQuery($sql);
387 $assignmentParams['contact_id'] = $params['assignee_contact_id'];
388 $assignmentParams['record_type_id'] = $assigneeID;
389 if (!empty($params['id'])) {
390 $assignment = new CRM_Activity_BAO_ActivityContact();
391 $assignment->activity_id
= $activityId;
392 $assignment->record_type_id
= $assigneeID;
393 $assignment->find(TRUE);
395 if ($assignment->contact_id
!= $params['assignee_contact_id']) {
396 $assignmentParams['id'] = $assignment->id
;
397 $resultAssignment = CRM_Activity_BAO_ActivityContact
::create($assignmentParams);
401 $resultAssignment = CRM_Activity_BAO_ActivityContact
::create($assignmentParams);
406 if (CRM_Utils_Array
::value('deleteActivityAssignment', $params, TRUE)) {
407 self
::deleteActivityContact($activityId, $assigneeID);
411 if (is_a($resultAssignment, 'CRM_Core_Error')) {
412 $transaction->rollback();
413 return $resultAssignment;
416 // attempt to save activity targets
417 $resultTarget = NULL;
418 if (!empty($params['target_contact_id'])) {
420 $targetParams = array('activity_id' => $activityId);
421 $resultTarget = array();
422 if (is_array($params['target_contact_id'])) {
423 if (CRM_Utils_Array
::value('deleteActivityTarget', $params, TRUE)) {
424 // first delete existing targets if any
425 self
::deleteActivityContact($activityId, $targetID);
429 foreach ($params['target_contact_id'] as $tid) {
431 $values[] = "( $activityId, $tid, $targetID )";
435 while (!empty($values)) {
436 $input = array_splice($values, 0, CRM_Core_DAO
::BULK_INSERT_COUNT
);
437 $str = implode(',', $input);
438 $sql = "INSERT IGNORE INTO civicrm_activity_contact ( activity_id, contact_id, record_type_id ) VALUES $str;";
439 CRM_Core_DAO
::executeQuery($sql);
443 $targetParams['contact_id'] = $params['target_contact_id'];
444 $targetParams['record_type_id'] = $targetID;
445 if (!empty($params['id'])) {
446 $target = new CRM_Activity_BAO_ActivityContact();
447 $target->activity_id
= $activityId;
448 $target->record_type_id
= $targetID;
451 if ($target->contact_id
!= $params['target_contact_id']) {
452 $targetParams['id'] = $target->id
;
453 $resultTarget = CRM_Activity_BAO_ActivityContact
::create($targetParams);
457 $resultTarget = CRM_Activity_BAO_ActivityContact
::create($targetParams);
462 if (CRM_Utils_Array
::value('deleteActivityTarget', $params, TRUE)) {
463 self
::deleteActivityContact($activityId, $targetID);
467 // write to changelog before transaction is committed/rolled
468 // back (and prepare status to display)
469 if (!empty($params['id'])) {
470 $logMsg = "Activity (id: {$result->id} ) updated with ";
473 $logMsg = "Activity created for ";
477 if (isset($params['source_contact_id'])) {
478 $msgs[] = "source={$params['source_contact_id']}";
481 if (!empty($params['target_contact_id'])) {
482 if (is_array($params['target_contact_id']) && !CRM_Utils_Array
::crmIsEmptyArray($params['target_contact_id'])) {
483 $msgs[] = "target=" . implode(',', $params['target_contact_id']);
484 // take only first target
485 // will be used for recently viewed display
486 $t = array_slice($params['target_contact_id'], 0, 1);
487 $recentContactId = $t[0];
489 // Is array check fixes warning without degrading functionality but it seems this bit of code may no longer work
490 // as it may always be an array
491 elseif (isset($params['target_contact_id']) && !is_array($params['target_contact_id'])) {
492 $msgs[] = "target={$params['target_contact_id']}";
493 // will be used for recently viewed display
494 $recentContactId = $params['target_contact_id'];
498 // at worst, take source for recently viewed display
499 $recentContactId = CRM_Utils_Array
::value('source_contact_id', $params);
502 if (isset($params['assignee_contact_id'])) {
503 if (is_array($params['assignee_contact_id'])) {
504 $msgs[] = "assignee=" . implode(',', $params['assignee_contact_id']);
507 $msgs[] = "assignee={$params['assignee_contact_id']}";
510 $logMsg .= implode(', ', $msgs);
512 self
::logActivityAction($result, $logMsg);
514 if (!empty($params['custom']) &&
515 is_array($params['custom'])
517 CRM_Core_BAO_CustomValueTable
::store($params['custom'], 'civicrm_activity', $result->id
);
520 $transaction->commit();
521 if (empty($params['skipRecentView'])) {
522 $recentOther = array();
523 if (!empty($params['case_id'])) {
524 $caseContactID = CRM_Core_DAO
::getFieldValue('CRM_Case_DAO_CaseContact', $params['case_id'], 'contact_id', 'case_id');
525 $url = CRM_Utils_System
::url('civicrm/case/activity/view',
526 "reset=1&aid={$activity->id}&cid={$caseContactID}&caseID={$params['case_id']}&context=home"
530 $q = "action=view&reset=1&id={$activity->id}&atype={$activity->activity_type_id}&cid=" . CRM_Utils_Array
::value('source_contact_id', $params) . "&context=home";
531 if ($activity->activity_type_id
!= CRM_Core_OptionGroup
::getValue('activity_type', 'Email', 'name')) {
532 $url = CRM_Utils_System
::url('civicrm/activity', $q);
533 if ($activity->activity_type_id
== CRM_Core_OptionGroup
::getValue('activity_type', 'Print PDF Letter', 'name')) {
534 $recentOther['editUrl'] = CRM_Utils_System
::url('civicrm/activity/pdf/add',
535 "action=update&reset=1&id={$activity->id}&atype={$activity->activity_type_id}&cid={$params['source_contact_id']}&context=home"
539 $recentOther['editUrl'] = CRM_Utils_System
::url('civicrm/activity/add',
540 "action=update&reset=1&id={$activity->id}&atype={$activity->activity_type_id}&cid=" . CRM_Utils_Array
::value('source_contact_id', $params) . "&context=home"
544 if (CRM_Core_Permission
::check("delete activities")) {
545 $recentOther['deleteUrl'] = CRM_Utils_System
::url('civicrm/activity',
546 "action=delete&reset=1&id={$activity->id}&atype={$activity->activity_type_id}&cid=" . CRM_Utils_Array
::value('source_contact_id', $params) . "&context=home"
551 $url = CRM_Utils_System
::url('civicrm/activity/view', $q);
552 if (CRM_Core_Permission
::check('delete activities')) {
553 $recentOther['deleteUrl'] = CRM_Utils_System
::url('civicrm/activity',
554 "action=delete&reset=1&id={$activity->id}&atype={$activity->activity_type_id}&cid=" . CRM_Utils_Array
::value('source_contact_id', $params) . "&context=home"
560 if (!isset($activity->parent_id
)) {
561 $recentContactDisplay = CRM_Contact_BAO_Contact
::displayName($recentContactId);
562 // add the recently created Activity
563 $activityTypes = CRM_Core_PseudoConstant
::activityType(TRUE, TRUE);
564 $activitySubject = CRM_Core_DAO
::getFieldValue('CRM_Activity_DAO_Activity', $activity->id
, 'subject');
567 if (isset($activitySubject)) {
568 $title = $activitySubject . ' - ';
571 $title = $title . $recentContactDisplay;
572 if (!empty($activityTypes[$activity->activity_type_id
])) {
573 $title .= ' (' . $activityTypes[$activity->activity_type_id
] . ')';
576 CRM_Utils_Recent
::add($title,
581 $recentContactDisplay,
587 CRM_Contact_BAO_GroupContactCache
::opportunisticCacheFlush();
589 if (!empty($params['id'])) {
590 CRM_Utils_Hook
::post('edit', 'Activity', $activity->id
, $activity);
593 CRM_Utils_Hook
::post('create', 'Activity', $activity->id
, $activity);
596 // if the subject contains a ‘[case #…]’ string, file that activity on the related case (CRM-5916)
598 if (preg_match('/\[case #([0-9a-h]{7})\]/', CRM_Utils_Array
::value('subject', $params), $matches)) {
599 $key = CRM_Core_DAO
::escapeString(CIVICRM_SITE_KEY
);
601 $query = "SELECT id FROM civicrm_case WHERE SUBSTR(SHA1(CONCAT('$key', id)), 1, 7) = '$hash'";
603 'activity_id' => $activity->id
,
604 'case_id' => CRM_Core_DAO
::singleValueQuery($query),
606 if ($caseParams['case_id']) {
607 CRM_Case_BAO_Case
::processCaseActivity($caseParams);
610 self
::logActivityAction($activity, "unknown case hash encountered: $hash");
618 * Create an activity.
620 * @todo elaborate on what this does.
622 * @param CRM_Core_DAO_Activity $activity
623 * @param string $logMessage
627 public static function logActivityAction($activity, $logMessage = NULL) {
628 $id = CRM_Core_Session
::getLoggedInContactID();
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
661 * Relevant data object values of open activities
663 public static function &getActivities($input) {
664 // Step 1: Get the basic activity data.
665 $bulkActivityTypeID = CRM_Core_OptionGroup
::getValue(
671 $activityContacts = CRM_Core_OptionGroup
::values('activity_contacts', FALSE, FALSE, FALSE, NULL, 'name');
672 $sourceID = CRM_Utils_Array
::key('Activity Source', $activityContacts);
673 $assigneeID = CRM_Utils_Array
::key('Activity Assignees', $activityContacts);
674 $targetID = CRM_Utils_Array
::key('Activity Targets', $activityContacts);
676 $config = CRM_Core_Config
::singleton();
678 $randomNum = md5(uniqid());
679 $activityTempTable = "civicrm_temp_activity_details_{$randomNum}";
681 $tableFields = array(
682 'activity_id' => 'int unsigned',
683 'activity_date_time' => 'datetime',
684 'source_record_id' => 'int unsigned',
685 'status_id' => 'int unsigned',
686 'subject' => 'varchar(255)',
687 'source_contact_name' => 'varchar(255)',
688 'activity_type_id' => 'int unsigned',
689 'activity_type' => 'varchar(128)',
690 'case_id' => 'int unsigned',
691 'case_subject' => 'varchar(255)',
692 'campaign_id' => 'int unsigned',
695 $sql = "CREATE TEMPORARY TABLE {$activityTempTable} ( ";
696 $insertValueSQL = array();
697 // The activityTempTable contains the sorted rows
698 // so in order to maintain the sort order as-is we add an auto_increment
699 // field; we can sort by this later to ensure the sort order stays correct.
700 $sql .= " fixed_sort_order INT UNSIGNED NOT NULL AUTO_INCREMENT PRIMARY KEY,";
701 foreach ($tableFields as $name => $desc) {
702 $sql .= "$name $desc,\n";
703 $insertValueSQL[] = $name;
706 // add unique key on activity_id just to be sure
707 // this cannot be primary key because we need that for the auto_increment
708 // fixed_sort_order field
710 UNIQUE KEY ( activity_id )
711 ) ENGINE=HEAP DEFAULT CHARACTER SET utf8 COLLATE utf8_unicode_ci
714 CRM_Core_DAO
::executeQuery($sql);
716 $insertSQL = "INSERT INTO {$activityTempTable} (" . implode(',', $insertValueSQL) . " ) ";
718 $order = $limit = $groupBy = '';
719 $groupBy = " GROUP BY tbl.activity_id, tbl.activity_type, tbl.case_id, tbl.case_subject ";
721 if (!empty($input['sort'])) {
722 if (is_a($input['sort'], 'CRM_Utils_Sort')) {
723 $orderBy = $input['sort']->orderBy();
724 if (!empty($orderBy)) {
725 $order = " ORDER BY $orderBy";
728 elseif (trim($input['sort'])) {
729 $sort = CRM_Utils_Type
::escape($input['sort'], 'String');
730 $order = " ORDER BY $sort ";
735 // context = 'activity' in Activities tab.
736 $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 ";
739 if (!empty($input['rowCount']) &&
740 $input['rowCount'] > 0
742 $limit = " LIMIT {$input['offset']}, {$input['rowCount']} ";
745 $input['count'] = FALSE;
746 list($sqlClause, $params) = self
::getActivitySQLClause($input);
748 $query = "{$insertSQL}
749 SELECT DISTINCT tbl.* from ( {$sqlClause} )
752 // Filter case activities - CRM-5761.
753 $components = self
::activityComponents();
754 if (!in_array('CiviCase', $components)) {
756 LEFT JOIN civicrm_case_activity ON ( civicrm_case_activity.activity_id = tbl.activity_id )
757 WHERE civicrm_case_activity.id IS NULL";
760 $query = $query . $groupBy . $order . $limit;
762 $dao = CRM_Core_DAO
::executeQuery($query, $params);
764 // step 2: Get target and assignee contacts for above activities
765 // create temp table for target contacts
766 $activityContactTempTable = "civicrm_temp_activity_contact_{$randomNum}";
767 $query = "CREATE TEMPORARY TABLE {$activityContactTempTable} (
768 activity_id int unsigned, contact_id int unsigned, record_type_id varchar(16),
769 contact_name varchar(255), is_deleted int unsigned, counter int unsigned, INDEX index_activity_id( activity_id ) )
770 ENGINE=InnoDB DEFAULT CHARACTER SET utf8 COLLATE utf8_unicode_ci";
772 CRM_Core_DAO
::executeQuery($query);
774 // note that we ignore bulk email for targets, since we don't show it in selector
776 INSERT INTO {$activityContactTempTable} ( activity_id, contact_id, record_type_id, contact_name, is_deleted )
777 SELECT ac.activity_id,
782 FROM {$activityTempTable}
783 INNER JOIN civicrm_activity a ON ( a.id = {$activityTempTable}.activity_id )
784 INNER JOIN civicrm_activity_contact ac ON ( ac.activity_id = {$activityTempTable}.activity_id )
785 INNER JOIN civicrm_contact c ON c.id = ac.contact_id
786 WHERE ac.record_type_id != %1
788 $params = array(1 => array($targetID, 'Integer'));
789 CRM_Core_DAO
::executeQuery($query, $params);
791 $activityFields = array("ac.activity_id", "ac.contact_id", "ac.record_type_id", "c.sort_name", "c.is_deleted");
792 $select = CRM_Contact_BAO_Query
::appendAnyValueToSelect($activityFields, "ac.activity_id");
794 // for each activity insert one target contact
795 // if we load all target contacts the performance will suffer a lot for mass-activities.
797 INSERT INTO {$activityContactTempTable} ( activity_id, contact_id, record_type_id, contact_name, is_deleted, counter )
798 {$select}, count(ac.contact_id)
799 FROM {$activityTempTable}
800 INNER JOIN civicrm_activity a ON ( a.id = {$activityTempTable}.activity_id )
801 INNER JOIN civicrm_activity_contact ac ON ( ac.activity_id = {$activityTempTable}.activity_id )
802 INNER JOIN civicrm_contact c ON c.id = ac.contact_id
803 WHERE ac.record_type_id = %1
804 GROUP BY ac.activity_id
807 CRM_Core_DAO
::executeQuery($query, $params);
809 // step 3: Combine all temp tables to get final query for activity selector
810 // sort by the original sort order, stored in fixed_sort_order
812 SELECT {$activityTempTable}.*,
813 {$activityContactTempTable}.contact_id,
814 {$activityContactTempTable}.record_type_id,
815 {$activityContactTempTable}.contact_name,
816 {$activityContactTempTable}.is_deleted,
817 {$activityContactTempTable}.counter,
818 re.parent_id as is_recurring_activity
819 FROM {$activityTempTable}
820 INNER JOIN {$activityContactTempTable} on {$activityTempTable}.activity_id = {$activityContactTempTable}.activity_id
821 LEFT JOIN civicrm_recurring_entity re on {$activityContactTempTable}.activity_id = re.entity_id
822 ORDER BY fixed_sort_order
825 $dao = CRM_Core_DAO
::executeQuery($query);
827 // CRM-3553, need to check user has access to target groups.
828 $mailingIDs = CRM_Mailing_BAO_Mailing
::mailingACLIDs();
830 (CRM_Core_Permission
::check('access CiviMail')) ||
831 (CRM_Mailing_Info
::workflowEnabled() &&
832 CRM_Core_Permission
::check('create mailings'))
835 // Get all campaigns.
836 $allCampaigns = CRM_Campaign_BAO_Campaign
::getCampaigns(NULL, NULL, FALSE, FALSE, FALSE, TRUE);
838 while ($dao->fetch()) {
839 $activityID = $dao->activity_id
;
840 $values[$activityID]['activity_id'] = $dao->activity_id
;
841 $values[$activityID]['source_record_id'] = $dao->source_record_id
;
842 $values[$activityID]['activity_type_id'] = $dao->activity_type_id
;
843 $values[$activityID]['activity_type'] = $dao->activity_type
;
844 $values[$activityID]['activity_date_time'] = $dao->activity_date_time
;
845 $values[$activityID]['status_id'] = $dao->status_id
;
846 $values[$activityID]['subject'] = $dao->subject
;
847 $values[$activityID]['campaign_id'] = $dao->campaign_id
;
848 $values[$activityID]['is_recurring_activity'] = $dao->is_recurring_activity
;
850 if ($dao->campaign_id
) {
851 $values[$activityID]['campaign'] = $allCampaigns[$dao->campaign_id
];
854 if (empty($values[$activityID]['assignee_contact_name'])) {
855 $values[$activityID]['assignee_contact_name'] = array();
858 if (empty($values[$activityID]['target_contact_name'])) {
859 $values[$activityID]['target_contact_name'] = array();
860 $values[$activityID]['target_contact_counter'] = $dao->counter
;
863 // if deleted, wrap in <del>
864 if ($dao->is_deleted
) {
865 $dao->contact_name
= "<del>{$dao->contact_name}</del>";
868 if ($dao->record_type_id
== $sourceID && $dao->contact_id
) {
869 $values[$activityID]['source_contact_id'] = $dao->contact_id
;
870 $values[$activityID]['source_contact_name'] = $dao->contact_name
;
873 if (!$bulkActivityTypeID ||
($bulkActivityTypeID != $dao->activity_type_id
)) {
874 // build array of target / assignee names
875 if ($dao->record_type_id
== $targetID && $dao->contact_id
) {
876 $values[$activityID]['target_contact_name'][$dao->contact_id
] = $dao->contact_name
;
878 if ($dao->record_type_id
== $assigneeID && $dao->contact_id
) {
879 $values[$activityID]['assignee_contact_name'][$dao->contact_id
] = $dao->contact_name
;
882 // case related fields
883 $values[$activityID]['case_id'] = $dao->case_id
;
884 $values[$activityID]['case_subject'] = $dao->case_subject
;
887 $values[$activityID]['recipients'] = ts('(%1 recipients)', array(1 => $dao->counter
));
888 $values[$activityID]['mailingId'] = FALSE;
891 ($mailingIDs === TRUE ||
in_array($dao->source_record_id
, $mailingIDs))
893 $values[$activityID]['mailingId'] = TRUE;
902 * Get the component id and name if those are enabled and allowed.
904 * Checks whether logged in user has permission.
905 * To decide whether we are going to include
906 * component related activities with core activity retrieve process.
907 * (what did that just mean?)
910 * 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
950 * count of activities
952 public static function &getActivitiesCount($input) {
953 $input['count'] = TRUE;
954 list($sqlClause, $params) = self
::getActivitySQLClause($input);
956 //filter case activities - CRM-5761
957 $components = self
::activityComponents();
958 if (!in_array('CiviCase', $components)) {
960 SELECT COUNT(DISTINCT(tbl.activity_id)) as count
961 FROM ( {$sqlClause} ) as tbl
962 LEFT JOIN civicrm_case_activity ON ( civicrm_case_activity.activity_id = tbl.activity_id )
963 WHERE civicrm_case_activity.id IS NULL";
966 $query = "SELECT COUNT(DISTINCT(activity_id)) as count from ( {$sqlClause} ) as tbl";
969 return CRM_Core_DAO
::singleValueQuery($query, $params);
973 * Get the activity sql clause to pick activities.
975 * @param array $input
976 * Array of parameters.
978 * - contact_id int contact_id whose activities we want to retrieve
979 * - admin boolean if contact is admin
980 * - caseId int case ID
981 * - context string page on which selector is build
982 * - count boolean are we interested in the count clause only?
983 * - activity_type_id int|string the activity types we want to restrict by
986 * count of activities
988 public static function getActivitySQLClause($input) {
990 $sourceWhere = $targetWhere = $assigneeWhere = $caseWhere = 1;
992 $config = CRM_Core_Config
::singleton();
993 if (!CRM_Utils_Array
::value('admin', $input, FALSE)) {
994 $sourceWhere = ' ac.contact_id = %1 ';
995 $caseWhere = ' civicrm_case_contact.contact_id = %1 ';
997 $params = array(1 => array($input['contact_id'], 'Integer'));
1000 $commonClauses = array(
1001 "civicrm_option_group.name = 'activity_type'",
1002 "civicrm_activity.is_deleted = 0",
1003 "civicrm_activity.is_current_revision = 1",
1004 "civicrm_activity.is_test= 0",
1007 if ($input['context'] != 'activity') {
1008 $commonClauses[] = "civicrm_activity.status_id = 1";
1011 // Filter on component IDs.
1012 $components = self
::activityComponents();
1013 if (!empty($components)) {
1014 $componentsIn = implode(',', array_keys($components));
1015 $commonClauses[] = "( civicrm_option_value.component_id IS NULL OR civicrm_option_value.component_id IN ( $componentsIn ) )";
1018 $commonClauses[] = "civicrm_option_value.component_id IS NULL";
1021 // activity type ID clause
1022 if (!empty($input['activity_type_id'])) {
1023 if (is_array($input['activity_type_id'])) {
1024 foreach ($input['activity_type_id'] as $idx => $value) {
1025 $input['activity_type_id'][$idx] = CRM_Utils_Type
::escape($value, 'Positive');
1027 $commonClauses[] = "civicrm_activity.activity_type_id IN ( " . implode(",", $input['activity_type_id']) . " ) ";
1030 $activityTypeID = CRM_Utils_Type
::escape($input['activity_type_id'], 'Positive');
1031 $commonClauses[] = "civicrm_activity.activity_type_id = $activityTypeID";
1035 // exclude by activity type clause
1036 if (!empty($input['activity_type_exclude_id'])) {
1037 if (is_array($input['activity_type_exclude_id'])) {
1038 foreach ($input['activity_type_exclude_id'] as $idx => $value) {
1039 $input['activity_type_exclude_id'][$idx] = CRM_Utils_Type
::escape($value, 'Positive');
1041 $commonClauses[] = "civicrm_activity.activity_type_id NOT IN ( " . implode(",", $input['activity_type_exclude_id']) . " ) ";
1044 $activityTypeID = CRM_Utils_Type
::escape($input['activity_type_exclude_id'], 'Positive');
1045 $commonClauses[] = "civicrm_activity.activity_type_id != $activityTypeID";
1049 $commonClause = implode(' AND ', $commonClauses);
1051 $includeCaseActivities = FALSE;
1052 if (in_array('CiviCase', $components)) {
1053 $includeCaseActivities = TRUE;
1056 // build main activity table select clause
1059 $activityContacts = CRM_Core_OptionGroup
::values('activity_contacts', FALSE, FALSE, FALSE, NULL, 'name');
1060 $sourceID = CRM_Utils_Array
::key('Activity Source', $activityContacts);
1062 INNER JOIN civicrm_activity_contact ac ON ac.activity_id = civicrm_activity.id
1063 INNER JOIN civicrm_contact contact ON ac.contact_id = contact.id
1066 if (!$input['count']) {
1068 civicrm_activity.activity_date_time,
1069 civicrm_activity.source_record_id,
1070 civicrm_activity.status_id,
1071 civicrm_activity.subject,
1072 contact.sort_name as source_contact_name,
1073 civicrm_option_value.value as activity_type_id,
1074 civicrm_option_value.label as activity_type,
1075 null as case_id, null as case_subject,
1076 civicrm_activity.campaign_id as campaign_id
1080 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)
1085 SELECT civicrm_activity.id as activity_id
1087 from civicrm_activity
1088 left join civicrm_option_value on
1089 civicrm_activity.activity_type_id = civicrm_option_value.value
1090 left join civicrm_option_group on
1091 civicrm_option_group.id = civicrm_option_value.option_group_id
1098 // Build case clause
1099 // or else exclude Inbound Emails that have been filed on a case.
1102 if ($includeCaseActivities) {
1104 if (!$input['count']) {
1106 civicrm_activity.activity_date_time,
1107 civicrm_activity.source_record_id,
1108 civicrm_activity.status_id,
1109 civicrm_activity.subject,
1110 contact.sort_name as source_contact_name,
1111 civicrm_option_value.value as activity_type_id,
1112 civicrm_option_value.label as activity_type,
1113 null as case_id, null as case_subject,
1114 civicrm_activity.campaign_id as campaign_id';
1120 SELECT civicrm_activity.id as activity_id
1122 from civicrm_activity
1123 inner join civicrm_case_activity on
1124 civicrm_case_activity.activity_id = civicrm_activity.id
1125 inner join civicrm_case on
1126 civicrm_case_activity.case_id = civicrm_case.id
1127 inner join civicrm_case_contact on
1128 civicrm_case_contact.case_id = civicrm_case.id and {$caseWhere}
1129 left join civicrm_option_value on
1130 civicrm_activity.activity_type_id = civicrm_option_value.value
1131 left join civicrm_option_group on
1132 civicrm_option_group.id = civicrm_option_value.option_group_id
1137 and ( ( civicrm_case_activity.case_id IS NULL ) OR
1138 ( civicrm_option_value.name <> 'Inbound Email' AND
1139 civicrm_option_value.name <> 'Email' AND civicrm_case_activity.case_id
1145 $returnClause = " {$sourceClause} {$caseClause} ";
1147 return array($returnClause, $params);
1151 * Send the message to all the contacts.
1153 * Also insert a contact activity in each contacts record.
1155 * @param array $contactDetails
1156 * The array of contact details to send the email.
1157 * @param string $subject
1158 * The subject of the message.
1161 * @param string $emailAddress
1162 * Use this 'to' email address instead of the default Primary address.
1163 * @param int $userID
1164 * Use this userID if set.
1165 * @param string $from
1166 * @param array $attachments
1167 * The array of attachments if any.
1170 * @param string $bcc
1172 * @param array $contactIds
1174 * @param string $additionalDetails
1175 * The additional information of CC and BCC appended to the activity Details.
1178 * ( sent, activityId) if any email is sent and activityId
1180 public static function sendEmail(
1188 $attachments = NULL,
1192 $additionalDetails = NULL
1194 // get the contact details of logged in contact, which we set as from email
1195 if ($userID == NULL) {
1196 $userID = CRM_Core_Session
::getLoggedInContactID();
1199 list($fromDisplayName, $fromEmail, $fromDoNotEmail) = CRM_Contact_BAO_Contact
::getContactDetails($userID);
1201 return array(count($contactDetails), 0, count($contactDetails));
1203 if (!trim($fromDisplayName)) {
1204 $fromDisplayName = $fromEmail;
1208 // token replacement of addressee/email/postal greetings
1209 // get the tokens added in subject and message
1210 $subjectToken = CRM_Utils_Token
::getTokens($subject);
1211 $messageToken = CRM_Utils_Token
::getTokens($text);
1212 $messageToken = array_merge($messageToken, CRM_Utils_Token
::getTokens($html));
1213 $allTokens = array_merge($messageToken, $subjectToken);
1216 $from = "$fromDisplayName <$fromEmail>";
1219 //create the meta level record first ( email activity )
1220 $activityTypeID = CRM_Core_OptionGroup
::getValue('activity_type',
1225 // CRM-6265: save both text and HTML parts in details (if present)
1226 if ($html and $text) {
1227 $details = "-ALTERNATIVE ITEM 0-\n$html$additionalDetails\n-ALTERNATIVE ITEM 1-\n$text$additionalDetails\n-ALTERNATIVE END-\n";
1230 $details = $html ?
$html : $text;
1231 $details .= $additionalDetails;
1234 $activityParams = array(
1235 'source_contact_id' => $userID,
1236 'activity_type_id' => $activityTypeID,
1237 'activity_date_time' => date('YmdHis'),
1238 'subject' => $subject,
1239 'details' => $details,
1240 // FIXME: check for name Completed and get ID from that lookup
1244 // CRM-5916: strip [case #…] before saving the activity (if present in subject)
1245 $activityParams['subject'] = preg_replace('/\[case #([0-9a-h]{7})\] /', '', $activityParams['subject']);
1247 // add the attachments to activity params here
1249 // first process them
1250 $activityParams = array_merge($activityParams,
1255 $activity = self
::create($activityParams);
1257 // get the set of attachments from where they are stored
1258 $attachments = CRM_Core_BAO_File
::getEntityFile('civicrm_activity',
1261 $returnProperties = array();
1262 if (isset($messageToken['contact'])) {
1263 foreach ($messageToken['contact'] as $key => $value) {
1264 $returnProperties[$value] = 1;
1268 if (isset($subjectToken['contact'])) {
1269 foreach ($subjectToken['contact'] as $key => $value) {
1270 if (!isset($returnProperties[$value])) {
1271 $returnProperties[$value] = 1;
1276 // get token details for contacts, call only if tokens are used
1278 if (!empty($returnProperties) ||
!empty($tokens) ||
!empty($allTokens)) {
1279 list($details) = CRM_Utils_Token
::getTokenDetails(
1284 'CRM_Activity_BAO_Activity'
1290 CRM_Utils_Hook
::tokens($tokens);
1291 $categories = array_keys($tokens);
1293 $escapeSmarty = FALSE;
1294 if (defined('CIVICRM_MAIL_SMARTY') && CIVICRM_MAIL_SMARTY
) {
1295 $smarty = CRM_Core_Smarty
::singleton();
1296 $escapeSmarty = TRUE;
1299 $sent = $notSent = array();
1300 foreach ($contactDetails as $values) {
1301 $contactId = $values['contact_id'];
1302 $emailAddress = $values['email'];
1304 if (!empty($details) && is_array($details["{$contactId}"])) {
1305 // unset email from details since it always returns primary email address
1306 unset($details["{$contactId}"]['email']);
1307 unset($details["{$contactId}"]['email_id']);
1308 $values = array_merge($values, $details["{$contactId}"]);
1311 $tokenSubject = CRM_Utils_Token
::replaceContactTokens($subject, $values, FALSE, $subjectToken, FALSE, $escapeSmarty);
1312 $tokenSubject = CRM_Utils_Token
::replaceHookTokens($tokenSubject, $values, $categories, FALSE, $escapeSmarty);
1315 if ($values['preferred_mail_format'] == 'Text' ||
$values['preferred_mail_format'] == 'Both') {
1316 $tokenText = CRM_Utils_Token
::replaceContactTokens($text, $values, FALSE, $messageToken, FALSE, $escapeSmarty);
1317 $tokenText = CRM_Utils_Token
::replaceHookTokens($tokenText, $values, $categories, FALSE, $escapeSmarty);
1323 if ($values['preferred_mail_format'] == 'HTML' ||
$values['preferred_mail_format'] == 'Both') {
1324 $tokenHtml = CRM_Utils_Token
::replaceContactTokens($html, $values, TRUE, $messageToken, FALSE, $escapeSmarty);
1325 $tokenHtml = CRM_Utils_Token
::replaceHookTokens($tokenHtml, $values, $categories, TRUE, $escapeSmarty);
1331 if (defined('CIVICRM_MAIL_SMARTY') && CIVICRM_MAIL_SMARTY
) {
1332 // also add the contact tokens to the template
1333 $smarty->assign_by_ref('contact', $values);
1335 $tokenSubject = $smarty->fetch("string:$tokenSubject");
1336 $tokenText = $smarty->fetch("string:$tokenText");
1337 $tokenHtml = $smarty->fetch("string:$tokenHtml");
1341 if (self
::sendMessage(
1359 return array($sent, $activity->id
);
1365 * @param array $contactDetails
1366 * @param array $activityParams
1367 * @param array $smsParams
1368 * @param $contactIds
1369 * @param int $userID
1372 * @throws CRM_Core_Exception
1374 public static function sendSMS(
1377 &$smsParams = array(),
1381 if ($userID == NULL) {
1382 $userID = CRM_Core_Session
::getLoggedInContactID();
1385 $text = &$activityParams['sms_text_message'];
1388 // token replacement of addressee/email/postal greetings
1389 // get the tokens added in subject and message
1390 $messageToken = CRM_Utils_Token
::getTokens($text);
1392 // Create the meta level record first ( sms activity )
1393 $activityTypeID = CRM_Core_OptionGroup
::getValue('activity_type',
1400 $activitySubject = $activityParams['activity_subject'];
1401 $activityParams = array(
1402 'source_contact_id' => $userID,
1403 'activity_type_id' => $activityTypeID,
1404 'activity_date_time' => date('YmdHis'),
1405 'subject' => $activitySubject,
1406 'details' => $details,
1407 // FIXME: check for name Completed and get ID from that lookup
1411 $activity = self
::create($activityParams);
1412 $activityID = $activity->id
;
1414 $returnProperties = array();
1416 if (isset($messageToken['contact'])) {
1417 foreach ($messageToken['contact'] as $key => $value) {
1418 $returnProperties[$value] = 1;
1424 CRM_Utils_Hook
::tokens($tokens);
1425 $categories = array_keys($tokens);
1427 // get token details for contacts, call only if tokens are used
1429 if (!empty($returnProperties) ||
!empty($tokens)) {
1430 list($details) = CRM_Utils_Token
::getTokenDetails($contactIds,
1434 'CRM_Activity_BAO_Activity'
1439 $escapeSmarty = FALSE;
1441 foreach ($contactDetails as $values) {
1442 $contactId = $values['contact_id'];
1444 if (!empty($details) && is_array($details["{$contactId}"])) {
1445 // unset phone from details since it always returns primary number
1446 unset($details["{$contactId}"]['phone']);
1447 unset($details["{$contactId}"]['phone_type_id']);
1448 $values = array_merge($values, $details["{$contactId}"]);
1451 $tokenText = CRM_Utils_Token
::replaceContactTokens($text, $values, FALSE, $messageToken, FALSE, $escapeSmarty);
1452 $tokenText = CRM_Utils_Token
::replaceHookTokens($tokenText, $values, $categories, FALSE, $escapeSmarty);
1454 // Only send if the phone is of type mobile
1455 $phoneTypes = CRM_Core_OptionGroup
::values('phone_type', TRUE, FALSE, FALSE, NULL, 'name');
1456 if ($values['phone_type_id'] == CRM_Utils_Array
::value('Mobile', $phoneTypes)) {
1457 $smsParams['To'] = $values['phone'];
1460 $smsParams['To'] = '';
1463 $sendResult = self
::sendSMSMessage(
1471 if (PEAR
::isError($sendResult)) {
1472 // Collect all of the PEAR_Error objects
1473 $errMsgs[] = $sendResult;
1480 // If at least one message was sent and no errors
1481 // were generated then return a boolean value of TRUE.
1482 // Otherwise, return FALSE (no messages sent) or
1483 // and array of 1 or more PEAR_Error objects.
1485 if ($success > 0 && count($errMsgs) == 0) {
1488 elseif (count($errMsgs) > 0) {
1492 return array($sent, $activity->id
, $success);
1496 * Send the sms message to a specific contact.
1499 * The contact id of the recipient.
1501 * @param array $smsParams
1502 * The params used for sending sms.
1503 * @param int $activityID
1504 * The activity ID that tracks the message.
1505 * @param int $userID
1507 * @return bool|PEAR_Error
1508 * true on success or PEAR_Error object
1510 public static function sendSMSMessage(
1513 $smsParams = array(),
1518 $toPhoneNumber = "";
1520 if ($smsParams['To']) {
1521 $toPhoneNumber = trim($smsParams['To']);
1524 $filters = array('is_deceased' => 0, 'is_deleted' => 0, 'do_not_sms' => 0);
1525 $toPhoneNumbers = CRM_Core_BAO_Phone
::allPhones($toID, FALSE, 'Mobile', $filters);
1526 // To get primary mobile phonenumber,if not get the first mobile phonenumber
1527 if (!empty($toPhoneNumbers)) {
1528 $toPhoneNumerDetails = reset($toPhoneNumbers);
1529 $toPhoneNumber = CRM_Utils_Array
::value('phone', $toPhoneNumerDetails);
1530 // Contact allows to send sms
1535 // make sure both phone are valid
1536 // and that the recipient wants to receive sms
1537 if (empty($toPhoneNumber) or $toDoNotSms) {
1538 return PEAR
::raiseError(
1539 'Recipient phone number is invalid or recipient does not want to receive SMS',
1545 $recipient = $smsParams['To'];
1546 $smsParams['contact_id'] = $toID;
1547 $smsParams['parent_activity_id'] = $activityID;
1549 $providerObj = CRM_SMS_Provider
::singleton(array('provider_id' => $smsParams['provider_id']));
1550 $sendResult = $providerObj->send($recipient, $smsParams, $tokenText, NULL, $userID);
1551 if (PEAR
::isError($sendResult)) {
1555 $activityContacts = CRM_Core_OptionGroup
::values('activity_contacts', FALSE, FALSE, FALSE, NULL, 'name');
1556 $targetID = CRM_Utils_Array
::key('Activity Targets', $activityContacts);
1558 // add activity target record for every sms that is send
1559 $activityTargetParams = array(
1560 'activity_id' => $activityID,
1561 'contact_id' => $toID,
1562 'record_type_id' => $targetID,
1564 CRM_Activity_BAO_ActivityContact
::create($activityTargetParams);
1570 * Send the message to a specific contact.
1572 * @param string $from
1573 * The name and email of the sender.
1574 * @param int $fromID
1576 * The contact id of the recipient.
1577 * @param string $subject
1578 * The subject of the message.
1579 * @param $text_message
1580 * @param $html_message
1581 * @param string $emailAddress
1582 * Use this 'to' email address instead of the default Primary address.
1583 * @param int $activityID
1584 * The activity ID that tracks the message.
1585 * @param null $attachments
1590 * TRUE if successful else FALSE.
1592 public static function sendMessage(
1601 $attachments = NULL,
1605 list($toDisplayName, $toEmail, $toDoNotEmail) = CRM_Contact_BAO_Contact
::getContactDetails($toID);
1606 if ($emailAddress) {
1607 $toEmail = trim($emailAddress);
1610 // make sure both email addresses are valid
1611 // and that the recipient wants to receive email
1612 if (empty($toEmail) or $toDoNotEmail) {
1615 if (!trim($toDisplayName)) {
1616 $toDisplayName = $toEmail;
1619 $activityContacts = CRM_Core_OptionGroup
::values('activity_contacts', FALSE, FALSE, FALSE, NULL, 'name');
1620 $targetID = CRM_Utils_Array
::key('Activity Targets', $activityContacts);
1622 // create the params array
1623 $mailParams = array(
1624 'groupName' => 'Activity Email Sender',
1626 'toName' => $toDisplayName,
1627 'toEmail' => $toEmail,
1628 'subject' => $subject,
1631 'text' => $text_message,
1632 'html' => $html_message,
1633 'attachments' => $attachments,
1636 if (!CRM_Utils_Mail
::send($mailParams)) {
1640 // add activity target record for every mail that is send
1641 $activityTargetParams = array(
1642 'activity_id' => $activityID,
1643 'contact_id' => $toID,
1644 'record_type_id' => $targetID,
1646 CRM_Activity_BAO_ActivityContact
::create($activityTargetParams);
1651 * Combine all the importable fields from the lower levels object.
1653 * The ordering is important, since currently we do not have a weight
1654 * scheme. Adding weight is super important and should be done in the
1655 * next week or so, before this can be called complete.
1657 * @param bool $status
1660 * array of importable Fields
1662 public static function &importableFields($status = FALSE) {
1663 if (!self
::$_importableFields) {
1664 if (!self
::$_importableFields) {
1665 self
::$_importableFields = array();
1668 $fields = array('' => array('title' => ts('- do not import -')));
1671 $fields = array('' => array('title' => ts('- Activity Fields -')));
1674 $tmpFields = CRM_Activity_DAO_Activity
::import();
1675 $contactFields = CRM_Contact_BAO_Contact
::importableFields('Individual', NULL);
1677 // Using new Dedupe rule.
1678 $ruleParams = array(
1679 'contact_type' => 'Individual',
1680 'used' => 'Unsupervised',
1682 $fieldsArray = CRM_Dedupe_BAO_Rule
::dedupeRuleFields($ruleParams);
1684 $tmpConatctField = array();
1685 if (is_array($fieldsArray)) {
1686 foreach ($fieldsArray as $value) {
1687 $customFieldId = CRM_Core_DAO
::getFieldValue('CRM_Core_DAO_CustomField',
1692 $value = $customFieldId ?
'custom_' . $customFieldId : $value;
1693 $tmpConatctField[trim($value)] = $contactFields[trim($value)];
1694 $tmpConatctField[trim($value)]['title'] = $tmpConatctField[trim($value)]['title'] . " (match to contact)";
1697 $tmpConatctField['external_identifier'] = $contactFields['external_identifier'];
1698 $tmpConatctField['external_identifier']['title'] = $contactFields['external_identifier']['title'] . " (match to contact)";
1699 $fields = array_merge($fields, $tmpConatctField);
1700 $fields = array_merge($fields, $tmpFields);
1701 $fields = array_merge($fields, CRM_Core_BAO_CustomField
::getFieldsForImport('Activity'));
1702 self
::$_importableFields = $fields;
1704 return self
::$_importableFields;
1708 * Get the Activities of a target contact.
1710 * @param int $contactId
1711 * Id of the contact whose activities need to find.
1714 * array of activity fields
1716 public static function getContactActivity($contactId) {
1717 $activities = array();
1718 $activityContacts = CRM_Core_OptionGroup
::values('activity_contacts', FALSE, FALSE, FALSE, NULL, 'name');
1719 $sourceID = CRM_Utils_Array
::key('Activity Source', $activityContacts);
1720 $assigneeID = CRM_Utils_Array
::key('Activity Assignees', $activityContacts);
1721 $targetID = CRM_Utils_Array
::key('Activity Targets', $activityContacts);
1723 // First look for activities where contactId is one of the targets
1725 SELECT activity_id, record_type_id
1726 FROM civicrm_activity_contact
1727 WHERE contact_id = $contactId
1729 $dao = CRM_Core_DAO
::executeQuery($query);
1730 while ($dao->fetch()) {
1731 if ($dao->record_type_id
== $targetID) {
1732 $activities[$dao->activity_id
]['targets'][$contactId] = $contactId;
1734 elseif ($dao->record_type_id
== $assigneeID) {
1735 $activities[$dao->activity_id
]['asignees'][$contactId] = $contactId;
1738 // do source stuff here
1739 $activities[$dao->activity_id
]['source_contact_id'] = $contactId;
1743 $activityIds = array_keys($activities);
1744 if (count($activityIds) < 1) {
1748 $activityIds = implode(',', $activityIds);
1750 SELECT activity.id as activity_id,
1752 subject, location, activity_date_time, details, status_id
1753 FROM civicrm_activity activity
1754 WHERE activity.id IN ($activityIds)";
1756 $dao = CRM_Core_DAO
::executeQuery($query);
1758 $activityTypes = CRM_Core_OptionGroup
::values('activity_type');
1759 $activityStatuses = CRM_Core_OptionGroup
::values('activity_status');
1761 while ($dao->fetch()) {
1762 $activities[$dao->activity_id
]['id'] = $dao->activity_id
;
1763 $activities[$dao->activity_id
]['activity_type_id'] = $dao->activity_type_id
;
1764 $activities[$dao->activity_id
]['subject'] = $dao->subject
;
1765 $activities[$dao->activity_id
]['location'] = $dao->location
;
1766 $activities[$dao->activity_id
]['activity_date_time'] = $dao->activity_date_time
;
1767 $activities[$dao->activity_id
]['details'] = $dao->details
;
1768 $activities[$dao->activity_id
]['status_id'] = $dao->status_id
;
1769 $activities[$dao->activity_id
]['activity_name'] = $activityTypes[$dao->activity_type_id
];
1770 $activities[$dao->activity_id
]['status'] = $activityStatuses[$dao->status_id
];
1772 // set to null if not set
1773 if (!isset($activities[$dao->activity_id
]['source_contact_id'])) {
1774 $activities[$dao->activity_id
]['source_contact_id'] = NULL;
1781 * Add activity for Membership/Event/Contribution.
1783 * @param object $activity
1784 * (reference) particular component object.
1785 * @param string $activityType
1786 * For Membership Signup or Renewal.
1787 * @param int $targetContactID
1791 public static function addActivity(
1793 $activityType = 'Membership Signup',
1794 $targetContactID = NULL
1796 if ($activity->__table
== 'civicrm_membership') {
1797 $membershipType = CRM_Member_PseudoConstant
::membershipType($activity->membership_type_id
);
1799 if (!$membershipType) {
1800 $membershipType = ts('Membership');
1803 $subject = "{$membershipType}";
1805 if (!empty($activity->source
) && $activity->source
!= 'null') {
1806 $subject .= " - {$activity->source}";
1809 if ($activity->owner_membership_id
) {
1812 FROM civicrm_contact, civicrm_membership
1813 WHERE civicrm_contact.id = civicrm_membership.contact_id
1814 AND civicrm_membership.id = $activity->owner_membership_id
1816 $displayName = CRM_Core_DAO
::singleValueQuery($query);
1817 $subject .= " (by {$displayName})";
1820 $subject .= " - Status: " . CRM_Core_DAO
::getFieldValue('CRM_Member_DAO_MembershipStatus', $activity->status_id
, 'label');
1821 // CRM-72097 changed from start date to today
1822 $date = date('YmdHis');
1823 $component = 'Membership';
1825 elseif ($activity->__table
== 'civicrm_participant') {
1826 $event = CRM_Event_BAO_Event
::getEvents(1, $activity->event_id
, TRUE, FALSE);
1828 $roles = CRM_Event_PseudoConstant
::participantRole();
1829 $status = CRM_Event_PseudoConstant
::participantStatus();
1831 $subject = $event[$activity->event_id
];
1832 if (!empty($roles[$activity->role_id
])) {
1833 $subject .= ' - ' . $roles[$activity->role_id
];
1835 if (!empty($status[$activity->status_id
])) {
1836 $subject .= ' - ' . $status[$activity->status_id
];
1838 $date = date('YmdHis');
1839 if ($activityType != 'Email') {
1840 $activityType = 'Event Registration';
1842 $component = 'Event';
1844 elseif ($activity->__table
== 'civicrm_contribution') {
1845 // create activity record only for Completed Contributions
1846 if ($activity->contribution_status_id
!= 1) {
1852 $subject .= CRM_Utils_Money
::format($activity->total_amount
, $activity->currency
);
1853 if (!empty($activity->source
) && $activity->source
!= 'null') {
1854 $subject .= " - {$activity->source}";
1856 $date = CRM_Utils_Date
::isoToMysql($activity->receive_date
);
1857 $activityType = $component = 'Contribution';
1859 $activityParams = array(
1860 'source_contact_id' => $activity->contact_id
,
1861 'source_record_id' => $activity->id
,
1862 'activity_type_id' => CRM_Core_OptionGroup
::getValue('activity_type',
1866 'subject' => $subject,
1867 'activity_date_time' => $date,
1868 'is_test' => $activity->is_test
,
1869 'status_id' => CRM_Core_OptionGroup
::getValue('activity_status',
1873 'skipRecentView' => TRUE,
1874 'campaign_id' => $activity->campaign_id
,
1877 if (!empty($activity->activity_id
)) {
1878 $activityParams['id'] = $activity->activity_id
;
1880 // create activity with target contacts
1881 $id = CRM_Core_Session
::getLoggedInContactID();
1883 $activityParams['source_contact_id'] = $id;
1884 $activityParams['target_contact_id'][] = $activity->contact_id
;
1888 if (property_exists($activity, 'details')) {
1889 $activityParams['details'] = $activity->details
;
1892 if ($targetContactID) {
1893 $activityParams['target_contact_id'][] = $targetContactID;
1895 if (is_a(self
::create($activityParams), 'CRM_Core_Error')) {
1896 CRM_Core_Error
::fatal("Failed creating Activity for $component of id {$activity->id}");
1902 * Get Parent activity for currently viewed activity.
1904 * @param int $activityId
1905 * Current activity id.
1908 * Id of parent activity otherwise false.
1910 public static function getParentActivity($activityId) {
1911 static $parentActivities = array();
1913 $activityId = CRM_Utils_Type
::escape($activityId, 'Integer');
1915 if (!array_key_exists($activityId, $parentActivities)) {
1916 $parentActivities[$activityId] = array();
1918 $parentId = CRM_Core_DAO
::getFieldValue('CRM_Activity_DAO_Activity',
1923 $parentActivities[$activityId] = $parentId ?
$parentId : FALSE;
1926 return $parentActivities[$activityId];
1930 * Get total count of prior revision of currently viewed activity.
1932 * @param $activityID
1933 * Current activity id.
1936 * $params count of prior activities otherwise false.
1938 public static function getPriorCount($activityID) {
1939 static $priorCounts = array();
1941 $activityID = CRM_Utils_Type
::escape($activityID, 'Integer');
1943 if (!array_key_exists($activityID, $priorCounts)) {
1944 $priorCounts[$activityID] = array();
1945 $originalID = CRM_Core_DAO
::getFieldValue('CRM_Activity_DAO_Activity',
1952 SELECT count( id ) AS cnt
1953 FROM civicrm_activity
1954 WHERE ( id = {$originalID} OR original_id = {$originalID} )
1955 AND is_current_revision = 0
1956 AND id < {$activityID}
1958 $params = array(1 => array($originalID, 'Integer'));
1959 $count = CRM_Core_DAO
::singleValueQuery($query, $params);
1961 $priorCounts[$activityID] = $count ?
$count : 0;
1964 return $priorCounts[$activityID];
1968 * Get all prior activities of currently viewed activity.
1970 * @param $activityID
1971 * Current activity id.
1972 * @param bool $onlyPriorRevisions
1975 * prior activities info.
1977 public static function getPriorAcitivities($activityID, $onlyPriorRevisions = FALSE) {
1978 static $priorActivities = array();
1980 $activityID = CRM_Utils_Type
::escape($activityID, 'Integer');
1981 $index = $activityID . '_' . (int) $onlyPriorRevisions;
1983 if (!array_key_exists($index, $priorActivities)) {
1984 $priorActivities[$index] = array();
1986 $originalID = CRM_Core_DAO
::getFieldValue('CRM_Activity_DAO_Activity',
1991 $originalID = $activityID;
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.
2028 * current activity id.
2030 public static function getLatestActivityId($activityID) {
2031 static $latestActivityIds = array();
2033 $activityID = CRM_Utils_Type
::escape($activityID, 'Integer');
2035 if (!array_key_exists($activityID, $latestActivityIds)) {
2036 $latestActivityIds[$activityID] = array();
2038 $originalID = CRM_Core_DAO
::getFieldValue('CRM_Activity_DAO_Activity',
2043 $activityID = $originalID;
2045 $params = array(1 => array($activityID, 'Integer'));
2046 $query = "SELECT id from civicrm_activity where original_id = %1 and is_current_revision = 1";
2048 $latestActivityIds[$activityID] = CRM_Core_DAO
::singleValueQuery($query, $params);
2051 return $latestActivityIds[$activityID];
2055 * Create a follow up a given activity.
2057 * @param int $activityId
2058 * activity id of parent activity.
2059 * @param array $params
2061 * @return CRM_Activity_BAO_Activity|null|object
2063 public static function createFollowupActivity($activityId, $params) {
2068 $followupParams = array();
2069 $followupParams['parent_id'] = $activityId;
2070 $followupParams['source_contact_id'] = CRM_Core_Session
::getLoggedInContactID();
2071 $followupParams['status_id'] = CRM_Core_OptionGroup
::getValue('activity_status', 'Scheduled', 'name');
2073 $followupParams['activity_type_id'] = $params['followup_activity_type_id'];
2074 // Get Subject of Follow-up Activiity, CRM-4491
2075 $followupParams['subject'] = CRM_Utils_Array
::value('followup_activity_subject', $params);
2076 $followupParams['assignee_contact_id'] = CRM_Utils_Array
::value('followup_assignee_contact_id', $params);
2078 // Create target contact for followup.
2079 if (!empty($params['target_contact_id'])) {
2080 $followupParams['target_contact_id'] = $params['target_contact_id'];
2083 $followupParams['activity_date_time'] = CRM_Utils_Date
::processDate($params['followup_date'],
2084 $params['followup_date_time']
2086 $followupActivity = self
::create($followupParams);
2088 return $followupActivity;
2092 * Get Activity specific File according activity type Id.
2094 * @param int $activityTypeId
2096 * @param string $crmDir
2098 * @return string|bool
2099 * if file exists returns $activityTypeFile activity filename otherwise false.
2101 public static function getFileForActivityTypeId($activityTypeId, $crmDir = 'Activity') {
2102 $activityTypes = CRM_Case_PseudoConstant
::caseActivityType(FALSE, TRUE);
2104 if ($activityTypes[$activityTypeId]['name']) {
2105 $activityTypeFile = CRM_Utils_String
::munge(ucwords($activityTypes[$activityTypeId]['name']), '', 0);
2111 global $civicrm_root;
2112 $config = CRM_Core_Config
::singleton();
2113 if (!file_exists(rtrim($civicrm_root, '/') . "/CRM/{$crmDir}/Form/Activity/{$activityTypeFile}.php")) {
2114 if (empty($config->customPHPPathDir
)) {
2117 elseif (!file_exists(rtrim($config->customPHPPathDir
, '/') . "/CRM/{$crmDir}/Form/Activity/{$activityTypeFile}.php")) {
2122 return $activityTypeFile;
2126 * Restore the activity.
2128 * @param array $params
2130 * @return CRM_Activity_DAO_Activity
2132 public static function restoreActivity(&$params) {
2133 $activity = new CRM_Activity_DAO_Activity();
2134 $activity->copyValues($params);
2136 $activity->is_deleted
= 0;
2137 $result = $activity->save();
2143 * Get the exportable fields for Activities.
2145 * @param string $name
2146 * If it is called by case $name = Case else $name = Activity.
2149 * array of exportable Fields
2151 public static function &exportableFields($name = 'Activity') {
2152 if (!isset(self
::$_exportableFields[$name])) {
2153 self
::$_exportableFields[$name] = array();
2155 // TODO: ideally we should retrieve all fields from xml, in this case since activity processing is done
2156 // my case hence we have defined fields as case_*
2157 if ($name == 'Activity') {
2158 $exportableFields = CRM_Activity_DAO_Activity
::export();
2159 $exportableFields['source_contact_id']['title'] = ts('Source Contact ID');
2160 $exportableFields['source_contact'] = array(
2161 'title' => ts('Source Contact'),
2162 'type' => CRM_Utils_Type
::T_STRING
,
2165 $Activityfields = array(
2166 'activity_type' => array(
2167 'title' => ts('Activity Type'),
2168 'name' => 'activity_type',
2169 'type' => CRM_Utils_Type
::T_STRING
,
2170 'searchByLabel' => TRUE,
2172 'activity_status' => array(
2173 'title' => ts('Activity Status'),
2174 'name' => 'activity_status',
2175 'type' => CRM_Utils_Type
::T_STRING
,
2176 'searchByLabel' => TRUE,
2179 $fields = array_merge($Activityfields, $exportableFields);
2182 // Set title to activity fields.
2184 'case_activity_subject' => array('title' => ts('Activity Subject'), 'type' => CRM_Utils_Type
::T_STRING
),
2185 'case_source_contact_id' => array('title' => ts('Activity Reporter'), 'type' => CRM_Utils_Type
::T_STRING
),
2186 'case_recent_activity_date' => array('title' => ts('Activity Actual Date'), 'type' => CRM_Utils_Type
::T_DATE
),
2187 'case_scheduled_activity_date' => array(
2188 'title' => ts('Activity Scheduled Date'),
2189 'type' => CRM_Utils_Type
::T_DATE
,
2191 'case_recent_activity_type' => array('title' => ts('Activity Type'), 'type' => CRM_Utils_Type
::T_STRING
),
2192 'case_activity_status' => array('title' => ts('Activity Status'), 'type' => CRM_Utils_Type
::T_STRING
),
2193 'case_activity_duration' => array('title' => ts('Activity Duration'), 'type' => CRM_Utils_Type
::T_INT
),
2194 'case_activity_medium_id' => array('title' => ts('Activity Medium'), 'type' => CRM_Utils_Type
::T_INT
),
2195 'case_activity_details' => array('title' => ts('Activity Details'), 'type' => CRM_Utils_Type
::T_TEXT
),
2196 'case_activity_is_auto' => array(
2197 'title' => ts('Activity Auto-generated?'),
2198 'type' => CRM_Utils_Type
::T_BOOLEAN
,
2203 // add custom data for case activities
2204 $fields = array_merge($fields, CRM_Core_BAO_CustomField
::getFieldsForImport('Activity'));
2206 self
::$_exportableFields[$name] = $fields;
2208 return self
::$_exportableFields[$name];
2212 * Get the allowed profile fields for Activities.
2215 * array of activity profile Fields
2217 public static function getProfileFields() {
2218 $exportableFields = self
::exportableFields('Activity');
2219 $skipFields = array(
2222 'source_contact_id',
2224 'activity_campaign',
2226 'is_current_revision',
2227 'activity_is_deleted',
2229 $config = CRM_Core_Config
::singleton();
2230 if (!in_array('CiviCampaign', $config->enableComponents
)) {
2231 $skipFields[] = 'activity_engagement_level';
2234 foreach ($skipFields as $field) {
2235 if (isset($exportableFields[$field])) {
2236 unset($exportableFields[$field]);
2240 // hack to use 'activity_type_id' instead of 'activity_type'
2241 $exportableFields['activity_status_id'] = $exportableFields['activity_status'];
2242 unset($exportableFields['activity_status']);
2244 return $exportableFields;
2248 * This function deletes the activity record related to contact record.
2250 * This is conditional on there being no target and assignee record
2251 * with other contacts.
2253 * @param int $contactId
2258 public static function cleanupActivity($contactId) {
2263 $activityContacts = CRM_Core_OptionGroup
::values('activity_contacts', FALSE, FALSE, FALSE, NULL, 'name');
2264 $sourceID = CRM_Utils_Array
::key('Activity Source', $activityContacts);
2266 $transaction = new CRM_Core_Transaction();
2268 // delete activity if there is no record in civicrm_activity_contact
2269 // pointing to any other contact record
2270 $activityContact = new CRM_Activity_DAO_ActivityContact();
2271 $activityContact->contact_id
= $contactId;
2272 $activityContact->record_type_id
= $sourceID;
2273 $activityContact->find();
2275 while ($activityContact->fetch()) {
2276 // delete activity_contact record for the deleted contact
2277 $activityContact->delete();
2279 $activityContactOther = new CRM_Activity_DAO_ActivityContact();
2280 $activityContactOther->activity_id
= $activityContact->activity_id
;
2282 // delete activity only if no other contacts connected
2283 if (!$activityContactOther->find(TRUE)) {
2284 $activityParams = array('id' => $activityContact->activity_id
);
2285 $result = self
::deleteActivity($activityParams);
2288 $activityContactOther->free();
2291 $activityContact->free();
2292 $transaction->commit();
2298 * Does user has sufficient permission for view/edit activity record.
2300 * @param int $activityId
2301 * Activity record id.
2302 * @param int $action
2307 public static function checkPermission($activityId, $action) {
2310 !in_array($action, array(CRM_Core_Action
::UPDATE
, CRM_Core_Action
::VIEW
))
2315 $activity = new CRM_Activity_DAO_Activity();
2316 $activity->id
= $activityId;
2317 if (!$activity->find(TRUE)) {
2321 // Component related permissions.
2322 $compPermissions = array(
2323 'CiviCase' => array(
2324 'administer CiviCase',
2325 'access my cases and activities',
2326 'access all cases and activities',
2328 'CiviMail' => array('access CiviMail'),
2329 'CiviEvent' => array('access CiviEvent'),
2330 'CiviGrant' => array('access CiviGrant'),
2331 'CiviPledge' => array('access CiviPledge'),
2332 'CiviMember' => array('access CiviMember'),
2333 'CiviReport' => array('access CiviReport'),
2334 'CiviContribute' => array('access CiviContribute'),
2335 'CiviCampaign' => array('administer CiviCampaign'),
2338 // Return early when it is case activity.
2339 $isCaseActivity = CRM_Case_BAO_Case
::isCaseActivity($activityId);
2340 // Check for civicase related permission.
2341 if ($isCaseActivity) {
2343 foreach ($compPermissions['CiviCase'] as $per) {
2344 if (CRM_Core_Permission
::check($per)) {
2350 // Check for case specific permissions.
2353 if ($action == CRM_Core_Action
::UPDATE
) {
2356 $allow = CRM_Case_BAO_Case
::checkPermission($activityId,
2358 $activity->activity_type_id
2365 // First check the component permission.
2368 FROM civicrm_option_value val
2369 INNER JOIN civicrm_option_group grp ON ( grp.id = val.option_group_id AND grp.name = %1 )
2370 WHERE val.value = %2";
2372 1 => array('activity_type', 'String'),
2373 2 => array($activity->activity_type_id
, 'Integer'),
2375 $componentId = CRM_Core_DAO
::singleValueQuery($sql, $params);
2378 $componentName = CRM_Core_Component
::getComponentName($componentId);
2379 $compPermission = CRM_Utils_Array
::value($componentName, $compPermissions);
2381 // Here we are interesting in any single permission.
2382 if (is_array($compPermission)) {
2383 foreach ($compPermission as $per) {
2384 if (CRM_Core_Permission
::check($per)) {
2392 // Check for this permission related to contact.
2393 $permission = CRM_Core_Permission
::VIEW
;
2394 if ($action == CRM_Core_Action
::UPDATE
) {
2395 $permission = CRM_Core_Permission
::EDIT
;
2398 $activityContacts = CRM_Core_OptionGroup
::values('activity_contacts', FALSE, FALSE, FALSE, NULL, 'name');
2399 $sourceID = CRM_Utils_Array
::key('Activity Source', $activityContacts);
2400 $assigneeID = CRM_Utils_Array
::key('Activity Assignees', $activityContacts);
2401 $targetID = CRM_Utils_Array
::key('Activity Targets', $activityContacts);
2403 // Check for source contact.
2404 if (!$componentId ||
$allow) {
2405 $sourceContactId = self
::getActivityContact($activity->id
, $sourceID);
2406 // Account for possibility of activity not having a source contact (as it may have been deleted).
2407 $allow = $sourceContactId ? CRM_Contact_BAO_Contact_Permission
::allow($sourceContactId, $permission) : TRUE;
2410 // Check for target and assignee contacts.
2412 // First check for supper permission.
2413 $supPermission = 'view all contacts';
2414 if ($action == CRM_Core_Action
::UPDATE
) {
2415 $supPermission = 'edit all contacts';
2417 $allow = CRM_Core_Permission
::check($supPermission);
2419 // User might have sufficient permission, through acls.
2422 // Get the target contacts.
2423 $targetContacts = CRM_Activity_BAO_ActivityContact
::retrieveContactIdsByActivityId($activity->id
, $targetID);
2424 foreach ($targetContacts as $cnt => $contactId) {
2425 if (!CRM_Contact_BAO_Contact_Permission
::allow($contactId, $permission)) {
2431 // Get the assignee contacts.
2433 $assigneeContacts = CRM_Activity_BAO_ActivityContact
::retrieveContactIdsByActivityId($activity->id
, $assigneeID);
2434 foreach ($assigneeContacts as $cnt => $contactId) {
2435 if (!CRM_Contact_BAO_Contact_Permission
::allow($contactId, $permission)) {
2448 * Wrapper for ajax activity selector.
2450 * @param array $params
2451 * Associated array for params record id.
2454 * Associated array of contact activities
2456 public static function getContactActivitySelector(&$params) {
2457 // Format the params.
2458 $params['offset'] = ($params['page'] - 1) * $params['rp'];
2459 $params['rowCount'] = $params['rp'];
2460 $params['sort'] = CRM_Utils_Array
::value('sortBy', $params);
2461 $params['caseId'] = NULL;
2462 $context = CRM_Utils_Array
::value('context', $params);
2463 $showContactOverlay = !CRM_Utils_String
::startsWith($context, "dashlet");
2465 // Get contact activities.
2466 $activities = CRM_Activity_BAO_Activity
::getActivities($params);
2469 $params['total'] = CRM_Activity_BAO_Activity
::getActivitiesCount($params);
2471 // Format params and add links.
2472 $contactActivities = array();
2474 if (!empty($activities)) {
2475 $activityStatus = CRM_Core_PseudoConstant
::activityStatus();
2477 // Check logged in user for permission.
2478 $page = new CRM_Core_Page();
2479 CRM_Contact_Page_View
::checkUserPermission($page, $params['contact_id']);
2480 $permissions = array($page->_permission
);
2481 if (CRM_Core_Permission
::check('delete activities')) {
2482 $permissions[] = CRM_Core_Permission
::DELETE
;
2485 $mask = CRM_Core_Action
::mask($permissions);
2487 foreach ($activities as $activityId => $values) {
2488 $activity = array();
2489 $activity['DT_RowId'] = $activityId;
2490 // Add class to this row if overdue.
2491 $activity['DT_RowClass'] = 'crm-entity';
2492 if (CRM_Utils_Date
::overdue(CRM_Utils_Array
::value('activity_date_time', $values))
2493 && CRM_Utils_Array
::value('status_id', $values) == 1
2495 $activity['DT_RowClass'] .= ' status-overdue';
2498 $activity['DT_RowClass'] .= ' status-ontime';
2501 $activity['DT_RowAttr'] = array();
2502 $activity['DT_RowAttr']['data-entity'] = 'activity';
2503 $activity['DT_RowAttr']['data-id'] = $activityId;
2505 $activity['activity_type'] = $values['activity_type'];
2506 $activity['subject'] = $values['subject'];
2508 $activity['source_contact_name'] = '';
2509 if ($params['contact_id'] == $values['source_contact_id']) {
2510 $activity['source_contact_name'] = $values['source_contact_name'];
2512 elseif ($values['source_contact_id']) {
2514 if ($showContactOverlay) {
2515 $srcTypeImage = CRM_Contact_BAO_Contact_Utils
::getImage(
2516 CRM_Contact_BAO_Contact
::getContactType($values['source_contact_id']),
2518 $values['source_contact_id']);
2520 $activity['source_contact_name'] = $srcTypeImage . CRM_Utils_System
::href($values['source_contact_name'],
2521 'civicrm/contact/view', "reset=1&cid={$values['source_contact_id']}");
2524 $activity['source_contact_name'] = '<em>n/a</em>';
2527 $activity['target_contact_name'] = '';
2528 if (isset($values['mailingId']) && !empty($values['mailingId'])) {
2529 $activity['target_contact'] = CRM_Utils_System
::href($values['recipients'],
2530 'civicrm/mailing/report/event',
2531 "mid={$values['source_record_id']}&reset=1&event=queue&cid={$params['contact_id']}&context=activitySelector");
2533 elseif (!empty($values['recipients'])) {
2534 $activity['target_contact_name'] = $values['recipients'];
2536 elseif (isset($values['target_contact_counter']) && $values['target_contact_counter']) {
2537 $activity['target_contact_name'] = '';
2538 foreach ($values['target_contact_name'] as $tcID => $tcName) {
2539 $targetTypeImage = "";
2540 $targetLink = CRM_Utils_System
::href($tcName, 'civicrm/contact/view', "reset=1&cid={$tcID}");
2541 if ($showContactOverlay) {
2542 $targetTypeImage = CRM_Contact_BAO_Contact_Utils
::getImage(
2543 CRM_Contact_BAO_Contact
::getContactType($tcID),
2546 $activity['target_contact_name'] .= "<div>$targetTypeImage $targetLink";
2549 $activity['target_contact_name'] .= $targetLink;
2553 if ($extraCount = $values['target_contact_counter'] - 1) {
2554 $activity['target_contact_name'] .= ";<br />" . "(" . ts('%1 more', array(1 => $extraCount)) . ")";
2556 if ($showContactOverlay) {
2557 $activity['target_contact_name'] .= "</div> ";
2560 elseif (!$values['target_contact_name']) {
2561 $activity['target_contact_name'] = '<em>n/a</em>';
2564 $activity['assignee_contact_name'] = '';
2565 if (empty($values['assignee_contact_name'])) {
2566 $activity['assignee_contact_name'] = '<em>n/a</em>';
2568 elseif (!empty($values['assignee_contact_name'])) {
2570 $activity['assignee_contact_name'] = '';
2571 foreach ($values['assignee_contact_name'] as $acID => $acName) {
2572 if ($acID && $count < 5) {
2573 $assigneeTypeImage = "";
2574 $assigneeLink = CRM_Utils_System
::href($acName, 'civicrm/contact/view', "reset=1&cid={$acID}");
2575 if ($showContactOverlay) {
2576 $assigneeTypeImage = CRM_Contact_BAO_Contact_Utils
::getImage(
2577 CRM_Contact_BAO_Contact
::getContactType($acID),
2580 $activity['assignee_contact_name'] .= "<div>$assigneeTypeImage $assigneeLink";
2583 $activity['assignee_contact_name'] .= $assigneeLink;
2588 $activity['assignee_contact_name'] .= "; ";
2590 if ($showContactOverlay) {
2591 $activity['assignee_contact_name'] .= "</div> ";
2595 $activity['assignee_contact_name'] .= "(" . ts('more') . ")";
2602 $activity['activity_date_time'] = CRM_Utils_Date
::customFormat($values['activity_date_time']);
2603 $activity['status_id'] = $activityStatus[$values['status_id']];
2606 $activity['links'] = '';
2607 $accessMailingReport = FALSE;
2608 if (!empty($values['mailingId'])) {
2609 $accessMailingReport = TRUE;
2612 $actionLinks = CRM_Activity_Selector_Activity
::actionLinks(
2613 CRM_Utils_Array
::value('activity_type_id', $values),
2614 CRM_Utils_Array
::value('source_record_id', $values),
2615 $accessMailingReport,
2616 CRM_Utils_Array
::value('activity_id', $values)
2619 $actionMask = array_sum(array_keys($actionLinks)) & $mask;
2621 $activity['links'] = CRM_Core_Action
::formLink($actionLinks,
2624 'id' => $values['activity_id'],
2625 'cid' => $params['contact_id'],
2627 'caseid' => CRM_Utils_Array
::value('case_id', $values),
2633 $values['activity_id']
2636 if ($values['is_recurring_activity']) {
2637 $activity['is_recurring_activity'] = CRM_Core_BAO_RecurringEntity
::getPositionAndCount($values['activity_id'], 'civicrm_activity');
2640 array_push($contactActivities, $activity);
2644 $activitiesDT = array();
2645 $activitiesDT['data'] = $contactActivities;
2646 $activitiesDT['recordsTotal'] = $params['total'];
2647 $activitiesDT['recordsFiltered'] = $params['total'];
2649 return $activitiesDT;
2653 * Copy custom fields and attachments from an existing activity to another.
2655 * @see CRM_Case_Page_AJAX::_convertToCaseActivity()
2657 * @param array $params
2659 public static function copyExtendedActivityData($params) {
2660 // attach custom data to the new activity
2661 $customParams = $htmlType = array();
2662 $customValues = CRM_Core_BAO_CustomValueTable
::getEntityValues($params['activityID'], 'Activity');
2664 if (!empty($customValues)) {
2665 $fieldIds = implode(', ', array_keys($customValues));
2666 $sql = "SELECT id FROM civicrm_custom_field WHERE html_type = 'File' AND id IN ( {$fieldIds} )";
2667 $result = CRM_Core_DAO
::executeQuery($sql);
2669 while ($result->fetch()) {
2670 $htmlType[] = $result->id
;
2673 foreach ($customValues as $key => $value) {
2674 if ($value !== NULL) {
2676 if (in_array($key, $htmlType)) {
2677 $fileValues = CRM_Core_BAO_File
::path($value, $params['activityID']);
2678 $customParams["custom_{$key}_-1"] = array(
2679 'name' => $fileValues[0],
2680 'path' => $fileValues[1],
2684 $customParams["custom_{$key}_-1"] = $value;
2688 CRM_Core_BAO_CustomValueTable
::postProcess($customParams, 'civicrm_activity',
2689 $params['mainActivityId'], 'Activity'
2693 // copy activity attachments ( if any )
2694 CRM_Core_BAO_File
::copyEntityFile('civicrm_activity', $params['activityID'], 'civicrm_activity', $params['mainActivityId']);
2698 * Get activity contact.
2700 * @param int $activityId
2701 * @param int $recordTypeID
2702 * @param string $column
2706 public static function getActivityContact($activityId, $recordTypeID = NULL, $column = 'contact_id') {
2707 $activityContact = new CRM_Activity_BAO_ActivityContact();
2708 $activityContact->activity_id
= $activityId;
2709 if ($recordTypeID) {
2710 $activityContact->record_type_id
= $recordTypeID;
2712 if ($activityContact->find(TRUE)) {
2713 return $activityContact->$column;
2719 * Get source contact id.
2721 * @param int $activityId
2725 public static function getSourceContactID($activityId) {
2726 static $sourceID = NULL;
2728 $activityContacts = CRM_Core_OptionGroup
::values('activity_contacts', FALSE, FALSE, FALSE, NULL, 'name');
2729 $sourceID = CRM_Utils_Array
::key('Activity Source', $activityContacts);
2732 return self
::getActivityContact($activityId, $sourceID);
2738 * @todo Document what this is for.
2740 * @param array $params
2742 public function setApiFilter(&$params) {
2743 if (!empty($params['target_contact_id'])) {
2745 $activityContacts = CRM_Core_OptionGroup
::values('activity_contacts', FALSE, FALSE, FALSE, NULL, 'name');
2746 $targetID = CRM_Utils_Array
::key('Activity Targets', $activityContacts);
2747 $obj = new CRM_Activity_BAO_ActivityContact();
2748 $params['return.target_contact_id'] = 1;
2749 $this->joinAdd($obj, 'LEFT');
2750 $this->selectAdd('civicrm_activity.*');
2751 $this->whereAdd(" civicrm_activity_contact.contact_id = {$params['target_contact_id']} AND civicrm_activity_contact.record_type_id = {$targetID}");
2756 * Send activity as attachment.
2758 * @param object $activity
2759 * @param array $mailToContacts
2760 * @param array $params
2764 public static function sendToAssignee($activity, $mailToContacts, $params = array()) {
2765 if (!CRM_Utils_Array
::crmIsEmptyArray($mailToContacts)) {
2766 $clientID = CRM_Utils_Array
::value('client_id', $params);
2767 $caseID = CRM_Utils_Array
::value('case_id', $params);
2769 $ics = new CRM_Activity_BAO_ICalendar($activity);
2770 $attachments = CRM_Core_BAO_File
::getEntityFile('civicrm_activity', $activity->id
);
2771 $ics->addAttachment($attachments, $mailToContacts);
2773 $result = CRM_Case_BAO_Case
::sendActivityCopy($clientID, $activity->id
, $mailToContacts, $attachments, $caseID);