3 +--------------------------------------------------------------------+
4 | CiviCRM version 4.7 |
5 +--------------------------------------------------------------------+
6 | Copyright CiviCRM LLC (c) 2004-2015 |
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-2015
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 // reset the group contact cache since smart groups might be affected due to this
588 CRM_Contact_BAO_GroupContactCache
::remove();
590 if (!empty($params['id'])) {
591 CRM_Utils_Hook
::post('edit', 'Activity', $activity->id
, $activity);
594 CRM_Utils_Hook
::post('create', 'Activity', $activity->id
, $activity);
597 // if the subject contains a ‘[case #…]’ string, file that activity on the related case (CRM-5916)
599 if (preg_match('/\[case #([0-9a-h]{7})\]/', CRM_Utils_Array
::value('subject', $params), $matches)) {
600 $key = CRM_Core_DAO
::escapeString(CIVICRM_SITE_KEY
);
602 $query = "SELECT id FROM civicrm_case WHERE SUBSTR(SHA1(CONCAT('$key', id)), 1, 7) = '$hash'";
604 'activity_id' => $activity->id
,
605 'case_id' => CRM_Core_DAO
::singleValueQuery($query),
607 if ($caseParams['case_id']) {
608 CRM_Case_BAO_Case
::processCaseActivity($caseParams);
611 self
::logActivityAction($activity, "unknown case hash encountered: $hash");
619 * Create an activity.
621 * @todo elaborate on what this does.
623 * @param CRM_Core_DAO_Activity $activity
624 * @param string $logMessage
628 public static function logActivityAction($activity, $logMessage = NULL) {
629 $session = CRM_Core_Session
::singleton();
630 $id = $session->get('userID');
632 $activityContacts = CRM_Core_OptionGroup
::values('activity_contacts', FALSE, FALSE, FALSE, NULL, 'name');
633 $sourceID = CRM_Utils_Array
::key('Activity Source', $activityContacts);
634 $id = self
::getActivityContact($activity->id
, $sourceID);
637 'entity_table' => 'civicrm_activity',
638 'entity_id' => $activity->id
,
639 'modified_id' => $id,
640 'modified_date' => date('YmdHis'),
641 'data' => $logMessage,
643 CRM_Core_BAO_Log
::add($logParams);
648 * Get the list Activities.
650 * @param array $input
651 * Array of parameters.
653 * - contact_id int contact_id whose activities we want to retrieve
654 * - offset int which row to start from ?
655 * - rowCount int how many rows to fetch
656 * - sort object|array object or array describing sort order for sql query.
657 * - admin boolean if contact is admin
658 * - caseId int case ID
659 * - context string page on which selector is build
660 * - activity_type_id int|string the activitiy types we want to restrict by
663 * Relevant data object values of open activities
665 public static function &getActivities($input) {
666 // Step 1: Get the basic activity data.
667 $bulkActivityTypeID = CRM_Core_OptionGroup
::getValue(
673 $activityContacts = CRM_Core_OptionGroup
::values('activity_contacts', FALSE, FALSE, FALSE, NULL, 'name');
674 $sourceID = CRM_Utils_Array
::key('Activity Source', $activityContacts);
675 $assigneeID = CRM_Utils_Array
::key('Activity Assignees', $activityContacts);
676 $targetID = CRM_Utils_Array
::key('Activity Targets', $activityContacts);
678 $config = CRM_Core_Config
::singleton();
680 $randomNum = md5(uniqid());
681 $activityTempTable = "civicrm_temp_activity_details_{$randomNum}";
683 $tableFields = array(
684 'activity_id' => 'int unsigned',
685 'activity_date_time' => 'datetime',
686 'source_record_id' => 'int unsigned',
687 'status_id' => 'int unsigned',
688 'subject' => 'varchar(255)',
689 'source_contact_name' => 'varchar(255)',
690 'activity_type_id' => 'int unsigned',
691 'activity_type' => 'varchar(128)',
692 'case_id' => 'int unsigned',
693 'case_subject' => 'varchar(255)',
694 'campaign_id' => 'int unsigned',
697 $sql = "CREATE TEMPORARY TABLE {$activityTempTable} ( ";
698 $insertValueSQL = array();
699 // The activityTempTable contains the sorted rows
700 // so in order to maintain the sort order as-is we add an auto_increment
701 // field; we can sort by this later to ensure the sort order stays correct.
702 $sql .= " fixed_sort_order INT UNSIGNED NOT NULL AUTO_INCREMENT PRIMARY KEY,";
703 foreach ($tableFields as $name => $desc) {
704 $sql .= "$name $desc,\n";
705 $insertValueSQL[] = $name;
708 // add unique key on activity_id just to be sure
709 // this cannot be primary key because we need that for the auto_increment
710 // fixed_sort_order field
712 UNIQUE KEY ( activity_id )
713 ) ENGINE=HEAP DEFAULT CHARACTER SET utf8 COLLATE utf8_unicode_ci
716 CRM_Core_DAO
::executeQuery($sql);
718 $insertSQL = "INSERT INTO {$activityTempTable} (" . implode(',', $insertValueSQL) . " ) ";
720 $order = $limit = $groupBy = '';
721 $groupBy = " GROUP BY tbl.activity_id ";
723 if (!empty($input['sort'])) {
724 if (is_a($input['sort'], 'CRM_Utils_Sort')) {
725 $orderBy = $input['sort']->orderBy();
726 if (!empty($orderBy)) {
727 $order = " ORDER BY $orderBy";
730 elseif (trim($input['sort'])) {
731 $sort = CRM_Utils_Type
::escape($input['sort'], 'String');
732 $order = " ORDER BY $sort ";
737 // context = 'activity' in Activities tab.
738 $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 ";
741 if (!empty($input['rowCount']) &&
742 $input['rowCount'] > 0
744 $limit = " LIMIT {$input['offset']}, {$input['rowCount']} ";
747 $input['count'] = FALSE;
748 list($sqlClause, $params) = self
::getActivitySQLClause($input);
750 $query = "{$insertSQL}
751 SELECT DISTINCT tbl.* from ( {$sqlClause} )
754 // Filter case activities - CRM-5761.
755 $components = self
::activityComponents();
756 if (!in_array('CiviCase', $components)) {
758 LEFT JOIN civicrm_case_activity ON ( civicrm_case_activity.activity_id = tbl.activity_id )
759 WHERE civicrm_case_activity.id IS NULL";
762 $query = $query . $groupBy . $order . $limit;
764 $dao = CRM_Core_DAO
::executeQuery($query, $params);
766 // step 2: Get target and assignee contacts for above activities
767 // create temp table for target contacts
768 $activityContactTempTable = "civicrm_temp_activity_contact_{$randomNum}";
769 $query = "CREATE TEMPORARY TABLE {$activityContactTempTable} (
770 activity_id int unsigned, contact_id int unsigned, record_type_id varchar(16),
771 contact_name varchar(255), is_deleted int unsigned, counter int unsigned, INDEX index_activity_id( activity_id ) )
772 ENGINE=MYISAM DEFAULT CHARACTER SET utf8 COLLATE utf8_unicode_ci";
774 CRM_Core_DAO
::executeQuery($query);
776 // note that we ignore bulk email for targets, since we don't show it in selector
778 INSERT INTO {$activityContactTempTable} ( activity_id, contact_id, record_type_id, contact_name, is_deleted )
779 SELECT ac.activity_id,
784 FROM {$activityTempTable}
785 INNER JOIN civicrm_activity a ON ( a.id = {$activityTempTable}.activity_id )
786 INNER JOIN civicrm_activity_contact ac ON ( ac.activity_id = {$activityTempTable}.activity_id )
787 INNER JOIN civicrm_contact c ON c.id = ac.contact_id
788 WHERE ac.record_type_id != %1
790 $params = array(1 => array($targetID, 'Integer'));
791 CRM_Core_DAO
::executeQuery($query, $params);
793 // for each activity insert one target contact
794 // if we load all target contacts the performance will suffer a lot for mass-activities.
796 INSERT INTO {$activityContactTempTable} ( activity_id, contact_id, record_type_id, contact_name, is_deleted, counter )
797 SELECT ac.activity_id,
803 FROM {$activityTempTable}
804 INNER JOIN civicrm_activity a ON ( a.id = {$activityTempTable}.activity_id )
805 INNER JOIN civicrm_activity_contact ac ON ( ac.activity_id = {$activityTempTable}.activity_id )
806 INNER JOIN civicrm_contact c ON c.id = ac.contact_id
807 WHERE ac.record_type_id = %1
808 GROUP BY ac.activity_id
811 CRM_Core_DAO
::executeQuery($query, $params);
813 // step 3: Combine all temp tables to get final query for activity selector
814 // sort by the original sort order, stored in fixed_sort_order
816 SELECT {$activityTempTable}.*,
817 {$activityContactTempTable}.contact_id,
818 {$activityContactTempTable}.record_type_id,
819 {$activityContactTempTable}.contact_name,
820 {$activityContactTempTable}.is_deleted,
821 {$activityContactTempTable}.counter,
822 re.parent_id as is_recurring_activity
823 FROM {$activityTempTable}
824 INNER JOIN {$activityContactTempTable} on {$activityTempTable}.activity_id = {$activityContactTempTable}.activity_id
825 LEFT JOIN civicrm_recurring_entity re on {$activityContactTempTable}.activity_id = re.entity_id
826 ORDER BY fixed_sort_order
829 $dao = CRM_Core_DAO
::executeQuery($query);
831 // CRM-3553, need to check user has access to target groups.
832 $mailingIDs = CRM_Mailing_BAO_Mailing
::mailingACLIDs();
834 (CRM_Core_Permission
::check('access CiviMail')) ||
835 (CRM_Mailing_Info
::workflowEnabled() &&
836 CRM_Core_Permission
::check('create mailings'))
839 // Get all campaigns.
840 $allCampaigns = CRM_Campaign_BAO_Campaign
::getCampaigns(NULL, NULL, FALSE, FALSE, FALSE, TRUE);
842 while ($dao->fetch()) {
843 $activityID = $dao->activity_id
;
844 $values[$activityID]['activity_id'] = $dao->activity_id
;
845 $values[$activityID]['source_record_id'] = $dao->source_record_id
;
846 $values[$activityID]['activity_type_id'] = $dao->activity_type_id
;
847 $values[$activityID]['activity_type'] = $dao->activity_type
;
848 $values[$activityID]['activity_date_time'] = $dao->activity_date_time
;
849 $values[$activityID]['status_id'] = $dao->status_id
;
850 $values[$activityID]['subject'] = $dao->subject
;
851 $values[$activityID]['campaign_id'] = $dao->campaign_id
;
852 $values[$activityID]['is_recurring_activity'] = $dao->is_recurring_activity
;
854 if ($dao->campaign_id
) {
855 $values[$activityID]['campaign'] = $allCampaigns[$dao->campaign_id
];
858 if (empty($values[$activityID]['assignee_contact_name'])) {
859 $values[$activityID]['assignee_contact_name'] = array();
862 if (empty($values[$activityID]['target_contact_name'])) {
863 $values[$activityID]['target_contact_name'] = array();
864 $values[$activityID]['target_contact_counter'] = $dao->counter
;
867 // if deleted, wrap in <del>
868 if ($dao->is_deleted
) {
869 $dao->contact_name
= "<del>{$dao->contact_name}</del>";
872 if ($dao->record_type_id
== $sourceID && $dao->contact_id
) {
873 $values[$activityID]['source_contact_id'] = $dao->contact_id
;
874 $values[$activityID]['source_contact_name'] = $dao->contact_name
;
877 if (!$bulkActivityTypeID ||
($bulkActivityTypeID != $dao->activity_type_id
)) {
878 // build array of target / assignee names
879 if ($dao->record_type_id
== $targetID && $dao->contact_id
) {
880 $values[$activityID]['target_contact_name'][$dao->contact_id
] = $dao->contact_name
;
882 if ($dao->record_type_id
== $assigneeID && $dao->contact_id
) {
883 $values[$activityID]['assignee_contact_name'][$dao->contact_id
] = $dao->contact_name
;
886 // case related fields
887 $values[$activityID]['case_id'] = $dao->case_id
;
888 $values[$activityID]['case_subject'] = $dao->case_subject
;
891 $values[$activityID]['recipients'] = ts('(%1 recipients)', array(1 => $dao->counter
));
892 $values[$activityID]['mailingId'] = FALSE;
895 ($mailingIDs === TRUE ||
in_array($dao->source_record_id
, $mailingIDs))
897 $values[$activityID]['mailingId'] = TRUE;
906 * Get the component id and name if those are enabled and allowed.
908 * Checks whether logged in user has permission.
909 * To decide whether we are going to include
910 * component related activities with core activity retrieve process.
911 * (what did that just mean?)
914 * Array of component id and name.
916 public static function activityComponents() {
917 $components = array();
918 $compInfo = CRM_Core_Component
::getEnabledComponents();
919 foreach ($compInfo as $compObj) {
920 if (!empty($compObj->info
['showActivitiesInCore'])) {
921 if ($compObj->info
['name'] == 'CiviCampaign') {
922 $componentPermission = "administer {$compObj->name}";
925 $componentPermission = "access {$compObj->name}";
927 if ($compObj->info
['name'] == 'CiviCase') {
928 if (CRM_Case_BAO_Case
::accessCiviCase()) {
929 $components[$compObj->componentID
] = $compObj->info
['name'];
932 elseif (CRM_Core_Permission
::check($componentPermission)) {
933 $components[$compObj->componentID
] = $compObj->info
['name'];
942 * Get the activity Count.
944 * @param array $input
945 * Array of parameters.
947 * - contact_id int contact_id whose activities we want to retrieve
948 * - admin boolean if contact is admin
949 * - caseId int case ID
950 * - context string page on which selector is build
951 * - activity_type_id int|string the activity types we want to restrict by
954 * count of activities
956 public static function &getActivitiesCount($input) {
957 $input['count'] = TRUE;
958 list($sqlClause, $params) = self
::getActivitySQLClause($input);
960 //filter case activities - CRM-5761
961 $components = self
::activityComponents();
962 if (!in_array('CiviCase', $components)) {
964 SELECT COUNT(DISTINCT(tbl.activity_id)) as count
965 FROM ( {$sqlClause} ) as tbl
966 LEFT JOIN civicrm_case_activity ON ( civicrm_case_activity.activity_id = tbl.activity_id )
967 WHERE civicrm_case_activity.id IS NULL";
970 $query = "SELECT COUNT(DISTINCT(activity_id)) as count from ( {$sqlClause} ) as tbl";
973 return CRM_Core_DAO
::singleValueQuery($query, $params);
977 * Get the activity sql clause to pick activities.
979 * @param array $input
980 * Array of parameters.
982 * - contact_id int contact_id whose activities we want to retrieve
983 * - admin boolean if contact is admin
984 * - caseId int case ID
985 * - context string page on which selector is build
986 * - count boolean are we interested in the count clause only?
987 * - activity_type_id int|string the activity types we want to restrict by
990 * count of activities
992 public static function getActivitySQLClause($input) {
994 $sourceWhere = $targetWhere = $assigneeWhere = $caseWhere = 1;
996 $config = CRM_Core_Config
::singleton();
997 if (!CRM_Utils_Array
::value('admin', $input, FALSE)) {
998 $sourceWhere = ' ac.contact_id = %1 ';
999 $caseWhere = ' civicrm_case_contact.contact_id = %1 ';
1001 $params = array(1 => array($input['contact_id'], 'Integer'));
1004 $commonClauses = array(
1005 "civicrm_option_group.name = 'activity_type'",
1006 "civicrm_activity.is_deleted = 0",
1007 "civicrm_activity.is_current_revision = 1",
1008 "civicrm_activity.is_test= 0",
1011 if ($input['context'] != 'activity') {
1012 $commonClauses[] = "civicrm_activity.status_id = 1";
1015 // Filter on component IDs.
1016 $components = self
::activityComponents();
1017 if (!empty($components)) {
1018 $componentsIn = implode(',', array_keys($components));
1019 $commonClauses[] = "( civicrm_option_value.component_id IS NULL OR civicrm_option_value.component_id IN ( $componentsIn ) )";
1022 $commonClauses[] = "civicrm_option_value.component_id IS NULL";
1025 // activity type ID clause
1026 if (!empty($input['activity_type_id'])) {
1027 if (is_array($input['activity_type_id'])) {
1028 foreach ($input['activity_type_id'] as $idx => $value) {
1029 $input['activity_type_id'][$idx] = CRM_Utils_Type
::escape($value, 'Positive');
1031 $commonClauses[] = "civicrm_activity.activity_type_id IN ( " . implode(",", $input['activity_type_id']) . " ) ";
1034 $activityTypeID = CRM_Utils_Type
::escape($input['activity_type_id'], 'Positive');
1035 $commonClauses[] = "civicrm_activity.activity_type_id = $activityTypeID";
1039 // exclude by activity type clause
1040 if (!empty($input['activity_type_exclude_id'])) {
1041 if (is_array($input['activity_type_exclude_id'])) {
1042 foreach ($input['activity_type_exclude_id'] as $idx => $value) {
1043 $input['activity_type_exclude_id'][$idx] = CRM_Utils_Type
::escape($value, 'Positive');
1045 $commonClauses[] = "civicrm_activity.activity_type_id NOT IN ( " . implode(",", $input['activity_type_exclude_id']) . " ) ";
1048 $activityTypeID = CRM_Utils_Type
::escape($input['activity_type_exclude_id'], 'Positive');
1049 $commonClauses[] = "civicrm_activity.activity_type_id != $activityTypeID";
1053 $commonClause = implode(' AND ', $commonClauses);
1055 $includeCaseActivities = FALSE;
1056 if (in_array('CiviCase', $components)) {
1057 $includeCaseActivities = TRUE;
1060 // build main activity table select clause
1063 $activityContacts = CRM_Core_OptionGroup
::values('activity_contacts', FALSE, FALSE, FALSE, NULL, 'name');
1064 $sourceID = CRM_Utils_Array
::key('Activity Source', $activityContacts);
1066 INNER JOIN civicrm_activity_contact ac ON ac.activity_id = civicrm_activity.id
1067 INNER JOIN civicrm_contact contact ON ac.contact_id = contact.id
1070 if (!$input['count']) {
1072 civicrm_activity.activity_date_time,
1073 civicrm_activity.source_record_id,
1074 civicrm_activity.status_id,
1075 civicrm_activity.subject,
1076 contact.sort_name as source_contact_name,
1077 civicrm_option_value.value as activity_type_id,
1078 civicrm_option_value.label as activity_type,
1079 null as case_id, null as case_subject,
1080 civicrm_activity.campaign_id as campaign_id
1084 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)
1089 SELECT civicrm_activity.id as activity_id
1091 from civicrm_activity
1092 left join civicrm_option_value on
1093 civicrm_activity.activity_type_id = civicrm_option_value.value
1094 left join civicrm_option_group on
1095 civicrm_option_group.id = civicrm_option_value.option_group_id
1102 // Build case clause
1103 // or else exclude Inbound Emails that have been filed on a case.
1106 if ($includeCaseActivities) {
1108 if (!$input['count']) {
1110 civicrm_activity.activity_date_time,
1111 civicrm_activity.source_record_id,
1112 civicrm_activity.status_id,
1113 civicrm_activity.subject,
1114 contact.sort_name as source_contact_name,
1115 civicrm_option_value.value as activity_type_id,
1116 civicrm_option_value.label as activity_type,
1117 null as case_id, null as case_subject,
1118 civicrm_activity.campaign_id as campaign_id';
1124 SELECT civicrm_activity.id as activity_id
1126 from civicrm_activity
1127 inner join civicrm_case_activity on
1128 civicrm_case_activity.activity_id = civicrm_activity.id
1129 inner join civicrm_case on
1130 civicrm_case_activity.case_id = civicrm_case.id
1131 inner join civicrm_case_contact on
1132 civicrm_case_contact.case_id = civicrm_case.id and {$caseWhere}
1133 left join civicrm_option_value on
1134 civicrm_activity.activity_type_id = civicrm_option_value.value
1135 left join civicrm_option_group on
1136 civicrm_option_group.id = civicrm_option_value.option_group_id
1141 and ( ( civicrm_case_activity.case_id IS NULL ) OR
1142 ( civicrm_option_value.name <> 'Inbound Email' AND
1143 civicrm_option_value.name <> 'Email' AND civicrm_case_activity.case_id
1149 $returnClause = " {$sourceClause} {$caseClause} ";
1151 return array($returnClause, $params);
1155 * Send the message to all the contacts.
1157 * Also insert a contact activity in each contacts record.
1159 * @param array $contactDetails
1160 * The array of contact details to send the email.
1161 * @param string $subject
1162 * The subject of the message.
1165 * @param string $emailAddress
1166 * Use this 'to' email address instead of the default Primary address.
1167 * @param int $userID
1168 * Use this userID if set.
1169 * @param string $from
1170 * @param array $attachments
1171 * The array of attachments if any.
1174 * @param string $bcc
1176 * @param array $contactIds
1178 * @param string $additionalDetails
1179 * The additional information of CC and BCC appended to the activity Details.
1182 * ( sent, activityId) if any email is sent and activityId
1184 public static function sendEmail(
1192 $attachments = NULL,
1196 $additionalDetails = NULL
1198 // get the contact details of logged in contact, which we set as from email
1199 if ($userID == NULL) {
1200 $session = CRM_Core_Session
::singleton();
1201 $userID = $session->get('userID');
1204 list($fromDisplayName, $fromEmail, $fromDoNotEmail) = CRM_Contact_BAO_Contact
::getContactDetails($userID);
1206 return array(count($contactDetails), 0, count($contactDetails));
1208 if (!trim($fromDisplayName)) {
1209 $fromDisplayName = $fromEmail;
1213 // token replacement of addressee/email/postal greetings
1214 // get the tokens added in subject and message
1215 $subjectToken = CRM_Utils_Token
::getTokens($subject);
1216 $messageToken = CRM_Utils_Token
::getTokens($text);
1217 $messageToken = array_merge($messageToken, CRM_Utils_Token
::getTokens($html));
1218 $allTokens = array_merge($messageToken, $subjectToken);
1221 $from = "$fromDisplayName <$fromEmail>";
1224 //create the meta level record first ( email activity )
1225 $activityTypeID = CRM_Core_OptionGroup
::getValue('activity_type',
1230 // CRM-6265: save both text and HTML parts in details (if present)
1231 if ($html and $text) {
1232 $details = "-ALTERNATIVE ITEM 0-\n$html$additionalDetails\n-ALTERNATIVE ITEM 1-\n$text$additionalDetails\n-ALTERNATIVE END-\n";
1235 $details = $html ?
$html : $text;
1236 $details .= $additionalDetails;
1239 $activityParams = array(
1240 'source_contact_id' => $userID,
1241 'activity_type_id' => $activityTypeID,
1242 'activity_date_time' => date('YmdHis'),
1243 'subject' => $subject,
1244 'details' => $details,
1245 // FIXME: check for name Completed and get ID from that lookup
1249 // CRM-5916: strip [case #…] before saving the activity (if present in subject)
1250 $activityParams['subject'] = preg_replace('/\[case #([0-9a-h]{7})\] /', '', $activityParams['subject']);
1252 // add the attachments to activity params here
1254 // first process them
1255 $activityParams = array_merge($activityParams,
1260 $activity = self
::create($activityParams);
1262 // get the set of attachments from where they are stored
1263 $attachments = CRM_Core_BAO_File
::getEntityFile('civicrm_activity',
1266 $returnProperties = array();
1267 if (isset($messageToken['contact'])) {
1268 foreach ($messageToken['contact'] as $key => $value) {
1269 $returnProperties[$value] = 1;
1273 if (isset($subjectToken['contact'])) {
1274 foreach ($subjectToken['contact'] as $key => $value) {
1275 if (!isset($returnProperties[$value])) {
1276 $returnProperties[$value] = 1;
1281 // get token details for contacts, call only if tokens are used
1283 if (!empty($returnProperties) ||
!empty($tokens) ||
!empty($allTokens)) {
1284 list($details) = CRM_Utils_Token
::getTokenDetails(
1289 'CRM_Activity_BAO_Activity'
1295 CRM_Utils_Hook
::tokens($tokens);
1296 $categories = array_keys($tokens);
1298 $escapeSmarty = FALSE;
1299 if (defined('CIVICRM_MAIL_SMARTY') && CIVICRM_MAIL_SMARTY
) {
1300 $smarty = CRM_Core_Smarty
::singleton();
1301 $escapeSmarty = TRUE;
1304 $sent = $notSent = array();
1305 foreach ($contactDetails as $values) {
1306 $contactId = $values['contact_id'];
1307 $emailAddress = $values['email'];
1309 if (!empty($details) && is_array($details["{$contactId}"])) {
1310 // unset email from details since it always returns primary email address
1311 unset($details["{$contactId}"]['email']);
1312 unset($details["{$contactId}"]['email_id']);
1313 $values = array_merge($values, $details["{$contactId}"]);
1316 $tokenSubject = CRM_Utils_Token
::replaceContactTokens($subject, $values, FALSE, $subjectToken, FALSE, $escapeSmarty);
1317 $tokenSubject = CRM_Utils_Token
::replaceHookTokens($tokenSubject, $values, $categories, FALSE, $escapeSmarty);
1320 if ($values['preferred_mail_format'] == 'Text' ||
$values['preferred_mail_format'] == 'Both') {
1321 $tokenText = CRM_Utils_Token
::replaceContactTokens($text, $values, FALSE, $messageToken, FALSE, $escapeSmarty);
1322 $tokenText = CRM_Utils_Token
::replaceHookTokens($tokenText, $values, $categories, FALSE, $escapeSmarty);
1328 if ($values['preferred_mail_format'] == 'HTML' ||
$values['preferred_mail_format'] == 'Both') {
1329 $tokenHtml = CRM_Utils_Token
::replaceContactTokens($html, $values, TRUE, $messageToken, FALSE, $escapeSmarty);
1330 $tokenHtml = CRM_Utils_Token
::replaceHookTokens($tokenHtml, $values, $categories, TRUE, $escapeSmarty);
1336 if (defined('CIVICRM_MAIL_SMARTY') && CIVICRM_MAIL_SMARTY
) {
1337 // also add the contact tokens to the template
1338 $smarty->assign_by_ref('contact', $values);
1340 $tokenSubject = $smarty->fetch("string:$tokenSubject");
1341 $tokenText = $smarty->fetch("string:$tokenText");
1342 $tokenHtml = $smarty->fetch("string:$tokenHtml");
1346 if (self
::sendMessage(
1364 return array($sent, $activity->id
);
1370 * @param array $contactDetails
1371 * @param array $activityParams
1372 * @param array $smsParams
1373 * @param $contactIds
1374 * @param int $userID
1377 * @throws CRM_Core_Exception
1379 public static function sendSMS(
1382 &$smsParams = array(),
1386 if ($userID == NULL) {
1387 $session = CRM_Core_Session
::singleton();
1388 $userID = $session->get('userID');
1391 $text = &$activityParams['sms_text_message'];
1394 // token replacement of addressee/email/postal greetings
1395 // get the tokens added in subject and message
1396 $messageToken = CRM_Utils_Token
::getTokens($text);
1398 // Create the meta level record first ( sms activity )
1399 $activityTypeID = CRM_Core_OptionGroup
::getValue('activity_type',
1406 $activitySubject = $activityParams['activity_subject'];
1407 $activityParams = array(
1408 'source_contact_id' => $userID,
1409 'activity_type_id' => $activityTypeID,
1410 'activity_date_time' => date('YmdHis'),
1411 'subject' => $activitySubject,
1412 'details' => $details,
1413 // FIXME: check for name Completed and get ID from that lookup
1417 $activity = self
::create($activityParams);
1418 $activityID = $activity->id
;
1420 $returnProperties = array();
1422 if (isset($messageToken['contact'])) {
1423 foreach ($messageToken['contact'] as $key => $value) {
1424 $returnProperties[$value] = 1;
1430 CRM_Utils_Hook
::tokens($tokens);
1431 $categories = array_keys($tokens);
1433 // get token details for contacts, call only if tokens are used
1435 if (!empty($returnProperties) ||
!empty($tokens)) {
1436 list($details) = CRM_Utils_Token
::getTokenDetails($contactIds,
1440 'CRM_Activity_BAO_Activity'
1445 $escapeSmarty = FALSE;
1447 foreach ($contactDetails as $values) {
1448 $contactId = $values['contact_id'];
1450 if (!empty($details) && is_array($details["{$contactId}"])) {
1451 // unset email from details since it always returns primary email address
1452 unset($details["{$contactId}"]['email']);
1453 unset($details["{$contactId}"]['email_id']);
1454 $values = array_merge($values, $details["{$contactId}"]);
1457 $tokenText = CRM_Utils_Token
::replaceContactTokens($text, $values, FALSE, $messageToken, FALSE, $escapeSmarty);
1458 $tokenText = CRM_Utils_Token
::replaceHookTokens($tokenText, $values, $categories, FALSE, $escapeSmarty);
1460 // Only send if the phone is of type mobile
1461 $phoneTypes = CRM_Core_OptionGroup
::values('phone_type', TRUE, FALSE, FALSE, NULL, 'name');
1462 if ($values['phone_type_id'] == CRM_Utils_Array
::value('Mobile', $phoneTypes)) {
1463 $smsParams['To'] = $values['phone'];
1466 $smsParams['To'] = '';
1469 $sendResult = self
::sendSMSMessage(
1477 if (PEAR
::isError($sendResult)) {
1478 // Collect all of the PEAR_Error objects
1479 $errMsgs[] = $sendResult;
1486 // If at least one message was sent and no errors
1487 // were generated then return a boolean value of TRUE.
1488 // Otherwise, return FALSE (no messages sent) or
1489 // and array of 1 or more PEAR_Error objects.
1491 if ($success > 0 && count($errMsgs) == 0) {
1494 elseif (count($errMsgs) > 0) {
1498 return array($sent, $activity->id
, $success);
1502 * Send the sms message to a specific contact.
1505 * The contact id of the recipient.
1507 * @param array $smsParams
1508 * The params used for sending sms.
1509 * @param int $activityID
1510 * The activity ID that tracks the message.
1511 * @param int $userID
1513 * @return bool|PEAR_Error
1514 * true on success or PEAR_Error object
1516 public static function sendSMSMessage(
1519 $smsParams = array(),
1524 $toPhoneNumber = "";
1526 if ($smsParams['To']) {
1527 $toPhoneNumber = trim($smsParams['To']);
1530 $filters = array('is_deceased' => 0, 'is_deleted' => 0, 'do_not_sms' => 0);
1531 $toPhoneNumbers = CRM_Core_BAO_Phone
::allPhones($toID, FALSE, 'Mobile', $filters);
1532 // To get primary mobile phonenumber,if not get the first mobile phonenumber
1533 if (!empty($toPhoneNumbers)) {
1534 $toPhoneNumerDetails = reset($toPhoneNumbers);
1535 $toPhoneNumber = CRM_Utils_Array
::value('phone', $toPhoneNumerDetails);
1536 // Contact allows to send sms
1541 // make sure both phone are valid
1542 // and that the recipient wants to receive sms
1543 if (empty($toPhoneNumber) or $toDoNotSms) {
1544 return PEAR
::raiseError(
1545 'Recipient phone number is invalid or recipient does not want to receive SMS',
1551 $recipient = $smsParams['To'];
1552 $smsParams['contact_id'] = $toID;
1553 $smsParams['parent_activity_id'] = $activityID;
1555 $providerObj = CRM_SMS_Provider
::singleton(array('provider_id' => $smsParams['provider_id']));
1556 $sendResult = $providerObj->send($recipient, $smsParams, $tokenText, NULL, $userID);
1557 if (PEAR
::isError($sendResult)) {
1561 $activityContacts = CRM_Core_OptionGroup
::values('activity_contacts', FALSE, FALSE, FALSE, NULL, 'name');
1562 $targetID = CRM_Utils_Array
::key('Activity Targets', $activityContacts);
1564 // add activity target record for every sms that is send
1565 $activityTargetParams = array(
1566 'activity_id' => $activityID,
1567 'contact_id' => $toID,
1568 'record_type_id' => $targetID,
1570 CRM_Activity_BAO_ActivityContact
::create($activityTargetParams);
1576 * Send the message to a specific contact.
1578 * @param string $from
1579 * The name and email of the sender.
1580 * @param int $fromID
1582 * The contact id of the recipient.
1583 * @param string $subject
1584 * The subject of the message.
1585 * @param $text_message
1586 * @param $html_message
1587 * @param string $emailAddress
1588 * Use this 'to' email address instead of the default Primary address.
1589 * @param int $activityID
1590 * The activity ID that tracks the message.
1591 * @param null $attachments
1596 * TRUE if successful else FALSE.
1598 public static function sendMessage(
1607 $attachments = NULL,
1611 list($toDisplayName, $toEmail, $toDoNotEmail) = CRM_Contact_BAO_Contact
::getContactDetails($toID);
1612 if ($emailAddress) {
1613 $toEmail = trim($emailAddress);
1616 // make sure both email addresses are valid
1617 // and that the recipient wants to receive email
1618 if (empty($toEmail) or $toDoNotEmail) {
1621 if (!trim($toDisplayName)) {
1622 $toDisplayName = $toEmail;
1625 $activityContacts = CRM_Core_OptionGroup
::values('activity_contacts', FALSE, FALSE, FALSE, NULL, 'name');
1626 $targetID = CRM_Utils_Array
::key('Activity Targets', $activityContacts);
1628 // create the params array
1629 $mailParams = array(
1630 'groupName' => 'Activity Email Sender',
1632 'toName' => $toDisplayName,
1633 'toEmail' => $toEmail,
1634 'subject' => $subject,
1637 'text' => $text_message,
1638 'html' => $html_message,
1639 'attachments' => $attachments,
1642 if (!CRM_Utils_Mail
::send($mailParams)) {
1646 // add activity target record for every mail that is send
1647 $activityTargetParams = array(
1648 'activity_id' => $activityID,
1649 'contact_id' => $toID,
1650 'record_type_id' => $targetID,
1652 CRM_Activity_BAO_ActivityContact
::create($activityTargetParams);
1657 * Combine all the importable fields from the lower levels object.
1659 * The ordering is important, since currently we do not have a weight
1660 * scheme. Adding weight is super important and should be done in the
1661 * next week or so, before this can be called complete.
1663 * @param bool $status
1666 * array of importable Fields
1668 public static function &importableFields($status = FALSE) {
1669 if (!self
::$_importableFields) {
1670 if (!self
::$_importableFields) {
1671 self
::$_importableFields = array();
1674 $fields = array('' => array('title' => ts('- do not import -')));
1677 $fields = array('' => array('title' => ts('- Activity Fields -')));
1680 $tmpFields = CRM_Activity_DAO_Activity
::import();
1681 $contactFields = CRM_Contact_BAO_Contact
::importableFields('Individual', NULL);
1683 // Using new Dedupe rule.
1684 $ruleParams = array(
1685 'contact_type' => 'Individual',
1686 'used' => 'Unsupervised',
1688 $fieldsArray = CRM_Dedupe_BAO_Rule
::dedupeRuleFields($ruleParams);
1690 $tmpConatctField = array();
1691 if (is_array($fieldsArray)) {
1692 foreach ($fieldsArray as $value) {
1693 $customFieldId = CRM_Core_DAO
::getFieldValue('CRM_Core_DAO_CustomField',
1698 $value = $customFieldId ?
'custom_' . $customFieldId : $value;
1699 $tmpConatctField[trim($value)] = $contactFields[trim($value)];
1700 $tmpConatctField[trim($value)]['title'] = $tmpConatctField[trim($value)]['title'] . " (match to contact)";
1703 $tmpConatctField['external_identifier'] = $contactFields['external_identifier'];
1704 $tmpConatctField['external_identifier']['title'] = $contactFields['external_identifier']['title'] . " (match to contact)";
1705 $fields = array_merge($fields, $tmpConatctField);
1706 $fields = array_merge($fields, $tmpFields);
1707 $fields = array_merge($fields, CRM_Core_BAO_CustomField
::getFieldsForImport('Activity'));
1708 self
::$_importableFields = $fields;
1710 return self
::$_importableFields;
1714 * Get the Activities of a target contact.
1716 * @param int $contactId
1717 * Id of the contact whose activities need to find.
1720 * array of activity fields
1722 public static function getContactActivity($contactId) {
1723 $activities = array();
1724 $activityContacts = CRM_Core_OptionGroup
::values('activity_contacts', FALSE, FALSE, FALSE, NULL, 'name');
1725 $sourceID = CRM_Utils_Array
::key('Activity Source', $activityContacts);
1726 $assigneeID = CRM_Utils_Array
::key('Activity Assignees', $activityContacts);
1727 $targetID = CRM_Utils_Array
::key('Activity Targets', $activityContacts);
1729 // First look for activities where contactId is one of the targets
1731 SELECT activity_id, record_type_id
1732 FROM civicrm_activity_contact
1733 WHERE contact_id = $contactId
1735 $dao = CRM_Core_DAO
::executeQuery($query);
1736 while ($dao->fetch()) {
1737 if ($dao->record_type_id
== $targetID) {
1738 $activities[$dao->activity_id
]['targets'][$contactId] = $contactId;
1740 elseif ($dao->record_type_id
== $assigneeID) {
1741 $activities[$dao->activity_id
]['asignees'][$contactId] = $contactId;
1744 // do source stuff here
1745 $activities[$dao->activity_id
]['source_contact_id'] = $contactId;
1749 $activityIds = array_keys($activities);
1750 if (count($activityIds) < 1) {
1754 $activityIds = implode(',', $activityIds);
1756 SELECT activity.id as activity_id,
1758 subject, location, activity_date_time, details, status_id
1759 FROM civicrm_activity activity
1760 WHERE activity.id IN ($activityIds)";
1762 $dao = CRM_Core_DAO
::executeQuery($query);
1764 $activityTypes = CRM_Core_OptionGroup
::values('activity_type');
1765 $activityStatuses = CRM_Core_OptionGroup
::values('activity_status');
1767 while ($dao->fetch()) {
1768 $activities[$dao->activity_id
]['id'] = $dao->activity_id
;
1769 $activities[$dao->activity_id
]['activity_type_id'] = $dao->activity_type_id
;
1770 $activities[$dao->activity_id
]['subject'] = $dao->subject
;
1771 $activities[$dao->activity_id
]['location'] = $dao->location
;
1772 $activities[$dao->activity_id
]['activity_date_time'] = $dao->activity_date_time
;
1773 $activities[$dao->activity_id
]['details'] = $dao->details
;
1774 $activities[$dao->activity_id
]['status_id'] = $dao->status_id
;
1775 $activities[$dao->activity_id
]['activity_name'] = $activityTypes[$dao->activity_type_id
];
1776 $activities[$dao->activity_id
]['status'] = $activityStatuses[$dao->status_id
];
1778 // set to null if not set
1779 if (!isset($activities[$dao->activity_id
]['source_contact_id'])) {
1780 $activities[$dao->activity_id
]['source_contact_id'] = NULL;
1787 * Add activity for Membership/Event/Contribution.
1789 * @param object $activity
1790 * (reference) particular component object.
1791 * @param string $activityType
1792 * For Membership Signup or Renewal.
1793 * @param int $targetContactID
1797 public static function addActivity(
1799 $activityType = 'Membership Signup',
1800 $targetContactID = NULL
1802 if ($activity->__table
== 'civicrm_membership') {
1803 $membershipType = CRM_Member_PseudoConstant
::membershipType($activity->membership_type_id
);
1805 if (!$membershipType) {
1806 $membershipType = ts('Membership');
1809 $subject = "{$membershipType}";
1811 if (!empty($activity->source
) && $activity->source
!= 'null') {
1812 $subject .= " - {$activity->source}";
1815 if ($activity->owner_membership_id
) {
1818 FROM civicrm_contact, civicrm_membership
1819 WHERE civicrm_contact.id = civicrm_membership.contact_id
1820 AND civicrm_membership.id = $activity->owner_membership_id
1822 $displayName = CRM_Core_DAO
::singleValueQuery($query);
1823 $subject .= " (by {$displayName})";
1826 $subject .= " - Status: " . CRM_Core_DAO
::getFieldValue('CRM_Member_DAO_MembershipStatus', $activity->status_id
, 'label');
1827 // CRM-72097 changed from start date to today
1828 $date = date('YmdHis');
1829 $component = 'Membership';
1831 elseif ($activity->__table
== 'civicrm_participant') {
1832 $event = CRM_Event_BAO_Event
::getEvents(1, $activity->event_id
, TRUE, FALSE);
1834 $roles = CRM_Event_PseudoConstant
::participantRole();
1835 $status = CRM_Event_PseudoConstant
::participantStatus();
1837 $subject = $event[$activity->event_id
];
1838 if (!empty($roles[$activity->role_id
])) {
1839 $subject .= ' - ' . $roles[$activity->role_id
];
1841 if (!empty($status[$activity->status_id
])) {
1842 $subject .= ' - ' . $status[$activity->status_id
];
1844 $date = date('YmdHis');
1845 if ($activityType != 'Email') {
1846 $activityType = 'Event Registration';
1848 $component = 'Event';
1850 elseif ($activity->__table
== 'civicrm_contribution') {
1851 // create activity record only for Completed Contributions
1852 if ($activity->contribution_status_id
!= 1) {
1858 $subject .= CRM_Utils_Money
::format($activity->total_amount
, $activity->currency
);
1859 if (!empty($activity->source
) && $activity->source
!= 'null') {
1860 $subject .= " - {$activity->source}";
1862 $date = CRM_Utils_Date
::isoToMysql($activity->receive_date
);
1863 $activityType = $component = 'Contribution';
1865 $activityParams = array(
1866 'source_contact_id' => $activity->contact_id
,
1867 'source_record_id' => $activity->id
,
1868 'activity_type_id' => CRM_Core_OptionGroup
::getValue('activity_type',
1872 'subject' => $subject,
1873 'activity_date_time' => $date,
1874 'is_test' => $activity->is_test
,
1875 'status_id' => CRM_Core_OptionGroup
::getValue('activity_status',
1879 'skipRecentView' => TRUE,
1880 'campaign_id' => $activity->campaign_id
,
1883 // create activity with target contacts
1884 $session = CRM_Core_Session
::singleton();
1885 $id = $session->get('userID');
1887 $activityParams['source_contact_id'] = $id;
1888 $activityParams['target_contact_id'][] = $activity->contact_id
;
1892 if (property_exists($activity, 'details')) {
1893 $activityParams['details'] = $activity->details
;
1896 if ($targetContactID) {
1897 $activityParams['target_contact_id'][] = $targetContactID;
1899 if (is_a(self
::create($activityParams), 'CRM_Core_Error')) {
1900 CRM_Core_Error
::fatal("Failed creating Activity for $component of id {$activity->id}");
1906 * Get Parent activity for currently viewed activity.
1908 * @param int $activityId
1909 * Current activity id.
1912 * Id of parent activity otherwise false.
1914 public static function getParentActivity($activityId) {
1915 static $parentActivities = array();
1917 $activityId = CRM_Utils_Type
::escape($activityId, 'Integer');
1919 if (!array_key_exists($activityId, $parentActivities)) {
1920 $parentActivities[$activityId] = array();
1922 $parentId = CRM_Core_DAO
::getFieldValue('CRM_Activity_DAO_Activity',
1927 $parentActivities[$activityId] = $parentId ?
$parentId : FALSE;
1930 return $parentActivities[$activityId];
1934 * Get total count of prior revision of currently viewed activity.
1936 * @param $activityID
1937 * Current activity id.
1940 * $params count of prior activities otherwise false.
1942 public static function getPriorCount($activityID) {
1943 static $priorCounts = array();
1945 $activityID = CRM_Utils_Type
::escape($activityID, 'Integer');
1947 if (!array_key_exists($activityID, $priorCounts)) {
1948 $priorCounts[$activityID] = array();
1949 $originalID = CRM_Core_DAO
::getFieldValue('CRM_Activity_DAO_Activity',
1956 SELECT count( id ) AS cnt
1957 FROM civicrm_activity
1958 WHERE ( id = {$originalID} OR original_id = {$originalID} )
1959 AND is_current_revision = 0
1960 AND id < {$activityID}
1962 $params = array(1 => array($originalID, 'Integer'));
1963 $count = CRM_Core_DAO
::singleValueQuery($query, $params);
1965 $priorCounts[$activityID] = $count ?
$count : 0;
1968 return $priorCounts[$activityID];
1972 * Get all prior activities of currently viewed activity.
1974 * @param $activityID
1975 * Current activity id.
1976 * @param bool $onlyPriorRevisions
1979 * prior activities info.
1981 public static function getPriorAcitivities($activityID, $onlyPriorRevisions = FALSE) {
1982 static $priorActivities = array();
1984 $activityID = CRM_Utils_Type
::escape($activityID, 'Integer');
1985 $index = $activityID . '_' . (int) $onlyPriorRevisions;
1987 if (!array_key_exists($index, $priorActivities)) {
1988 $priorActivities[$index] = array();
1990 $originalID = CRM_Core_DAO
::getFieldValue('CRM_Activity_DAO_Activity',
1995 $originalID = $activityID;
1999 SELECT c.display_name as name, cl.modified_date as date, ca.id as activityID
2000 FROM civicrm_log cl, civicrm_contact c, civicrm_activity ca
2001 WHERE (ca.id = %1 OR ca.original_id = %1)
2002 AND cl.entity_table = 'civicrm_activity'
2003 AND cl.entity_id = ca.id
2004 AND cl.modified_id = c.id
2006 if ($onlyPriorRevisions) {
2007 $query .= " AND ca.id < {$activityID}";
2009 $query .= " ORDER BY ca.id DESC";
2011 $params = array(1 => array($originalID, 'Integer'));
2012 $dao = CRM_Core_DAO
::executeQuery($query, $params);
2014 while ($dao->fetch()) {
2015 $priorActivities[$index][$dao->activityID
]['id'] = $dao->activityID
;
2016 $priorActivities[$index][$dao->activityID
]['name'] = $dao->name
;
2017 $priorActivities[$index][$dao->activityID
]['date'] = $dao->date
;
2022 return $priorActivities[$index];
2026 * Find the latest revision of a given activity.
2028 * @param int $activityID
2029 * Prior activity id.
2032 * current activity id.
2034 public static function getLatestActivityId($activityID) {
2035 static $latestActivityIds = array();
2037 $activityID = CRM_Utils_Type
::escape($activityID, 'Integer');
2039 if (!array_key_exists($activityID, $latestActivityIds)) {
2040 $latestActivityIds[$activityID] = array();
2042 $originalID = CRM_Core_DAO
::getFieldValue('CRM_Activity_DAO_Activity',
2047 $activityID = $originalID;
2049 $params = array(1 => array($activityID, 'Integer'));
2050 $query = "SELECT id from civicrm_activity where original_id = %1 and is_current_revision = 1";
2052 $latestActivityIds[$activityID] = CRM_Core_DAO
::singleValueQuery($query, $params);
2055 return $latestActivityIds[$activityID];
2059 * Create a follow up a given activity.
2061 * @param int $activityId
2062 * activity id of parent activity.
2063 * @param array $params
2065 * @return CRM_Activity_BAO_Activity|null|object
2067 public static function createFollowupActivity($activityId, $params) {
2072 $session = CRM_Core_Session
::singleton();
2074 $followupParams = array();
2075 $followupParams['parent_id'] = $activityId;
2076 $followupParams['source_contact_id'] = $session->get('userID');
2077 $followupParams['status_id'] = CRM_Core_OptionGroup
::getValue('activity_status', 'Scheduled', 'name');
2079 $followupParams['activity_type_id'] = $params['followup_activity_type_id'];
2080 // Get Subject of Follow-up Activiity, CRM-4491
2081 $followupParams['subject'] = CRM_Utils_Array
::value('followup_activity_subject', $params);
2082 $followupParams['assignee_contact_id'] = CRM_Utils_Array
::value('followup_assignee_contact_id', $params);
2084 // Create target contact for followup.
2085 if (!empty($params['target_contact_id'])) {
2086 $followupParams['target_contact_id'] = $params['target_contact_id'];
2089 $followupParams['activity_date_time'] = CRM_Utils_Date
::processDate($params['followup_date'],
2090 $params['followup_date_time']
2092 $followupActivity = self
::create($followupParams);
2094 return $followupActivity;
2098 * Get Activity specific File according activity type Id.
2100 * @param int $activityTypeId
2102 * @param string $crmDir
2104 * @return string|bool
2105 * if file exists returns $activityTypeFile activity filename otherwise false.
2107 public static function getFileForActivityTypeId($activityTypeId, $crmDir = 'Activity') {
2108 $activityTypes = CRM_Case_PseudoConstant
::caseActivityType(FALSE, TRUE);
2110 if ($activityTypes[$activityTypeId]['name']) {
2111 $activityTypeFile = CRM_Utils_String
::munge(ucwords($activityTypes[$activityTypeId]['name']), '', 0);
2117 global $civicrm_root;
2118 $config = CRM_Core_Config
::singleton();
2119 if (!file_exists(rtrim($civicrm_root, '/') . "/CRM/{$crmDir}/Form/Activity/{$activityTypeFile}.php")) {
2120 if (empty($config->customPHPPathDir
)) {
2123 elseif (!file_exists(rtrim($config->customPHPPathDir
, '/') . "/CRM/{$crmDir}/Form/Activity/{$activityTypeFile}.php")) {
2128 return $activityTypeFile;
2132 * Restore the activity.
2134 * @param array $params
2136 * @return CRM_Activity_DAO_Activity
2138 public static function restoreActivity(&$params) {
2139 $activity = new CRM_Activity_DAO_Activity();
2140 $activity->copyValues($params);
2142 $activity->is_deleted
= 0;
2143 $result = $activity->save();
2149 * Get the exportable fields for Activities.
2151 * @param string $name
2152 * If it is called by case $name = Case else $name = Activity.
2155 * array of exportable Fields
2157 public static function &exportableFields($name = 'Activity') {
2158 if (!isset(self
::$_exportableFields[$name])) {
2159 self
::$_exportableFields[$name] = array();
2161 // TODO: ideally we should retrieve all fields from xml, in this case since activity processing is done
2162 // my case hence we have defined fields as case_*
2163 if ($name == 'Activity') {
2164 $exportableFields = CRM_Activity_DAO_Activity
::export();
2165 $exportableFields['source_contact_id']['title'] = ts('Source Contact ID');
2166 $exportableFields['source_contact'] = array(
2167 'title' => ts('Source Contact'),
2168 'type' => CRM_Utils_Type
::T_STRING
,
2171 $Activityfields = array(
2172 'activity_type' => array(
2173 'title' => ts('Activity Type'),
2174 'name' => 'activity_type',
2175 'type' => CRM_Utils_Type
::T_STRING
,
2177 'activity_status' => array(
2178 'title' => ts('Activity Status'),
2179 'name' => 'activity_status',
2180 'type' => CRM_Utils_Type
::T_STRING
,
2183 $fields = array_merge($Activityfields, $exportableFields);
2186 // Set title to activity fields.
2188 'case_activity_subject' => array('title' => ts('Activity Subject'), 'type' => CRM_Utils_Type
::T_STRING
),
2189 'case_source_contact_id' => array('title' => ts('Activity Reporter'), 'type' => CRM_Utils_Type
::T_STRING
),
2190 'case_recent_activity_date' => array('title' => ts('Activity Actual Date'), 'type' => CRM_Utils_Type
::T_DATE
),
2191 'case_scheduled_activity_date' => array(
2192 'title' => ts('Activity Scheduled Date'),
2193 'type' => CRM_Utils_Type
::T_DATE
,
2195 'case_recent_activity_type' => array('title' => ts('Activity Type'), 'type' => CRM_Utils_Type
::T_STRING
),
2196 'case_activity_status' => array('title' => ts('Activity Status'), 'type' => CRM_Utils_Type
::T_STRING
),
2197 'case_activity_duration' => array('title' => ts('Activity Duration'), 'type' => CRM_Utils_Type
::T_INT
),
2198 'case_activity_medium_id' => array('title' => ts('Activity Medium'), 'type' => CRM_Utils_Type
::T_INT
),
2199 'case_activity_details' => array('title' => ts('Activity Details'), 'type' => CRM_Utils_Type
::T_TEXT
),
2200 'case_activity_is_auto' => array(
2201 'title' => ts('Activity Auto-generated?'),
2202 'type' => CRM_Utils_Type
::T_BOOLEAN
,
2207 // add custom data for case activities
2208 $fields = array_merge($fields, CRM_Core_BAO_CustomField
::getFieldsForImport('Activity'));
2210 self
::$_exportableFields[$name] = $fields;
2212 return self
::$_exportableFields[$name];
2216 * Get the allowed profile fields for Activities.
2219 * array of activity profile Fields
2221 public static function getProfileFields() {
2222 $exportableFields = self
::exportableFields('Activity');
2223 $skipFields = array(
2226 'source_contact_id',
2228 'activity_campaign',
2230 'is_current_revision',
2231 'activity_is_deleted',
2233 $config = CRM_Core_Config
::singleton();
2234 if (!in_array('CiviCampaign', $config->enableComponents
)) {
2235 $skipFields[] = 'activity_engagement_level';
2238 foreach ($skipFields as $field) {
2239 if (isset($exportableFields[$field])) {
2240 unset($exportableFields[$field]);
2244 // hack to use 'activity_type_id' instead of 'activity_type'
2245 $exportableFields['activity_status_id'] = $exportableFields['activity_status'];
2246 unset($exportableFields['activity_status']);
2248 return $exportableFields;
2252 * This function deletes the activity record related to contact record.
2254 * This is conditional on there being no target and assignee record
2255 * with other contacts.
2257 * @param int $contactId
2262 public static function cleanupActivity($contactId) {
2267 $activityContacts = CRM_Core_OptionGroup
::values('activity_contacts', FALSE, FALSE, FALSE, NULL, 'name');
2268 $sourceID = CRM_Utils_Array
::key('Activity Source', $activityContacts);
2270 $transaction = new CRM_Core_Transaction();
2272 // delete activity if there is no record in civicrm_activity_contact
2273 // pointing to any other contact record
2274 $activityContact = new CRM_Activity_DAO_ActivityContact();
2275 $activityContact->contact_id
= $contactId;
2276 $activityContact->record_type_id
= $sourceID;
2277 $activityContact->find();
2279 while ($activityContact->fetch()) {
2280 // delete activity_contact record for the deleted contact
2281 $activityContact->delete();
2283 $activityContactOther = new CRM_Activity_DAO_ActivityContact();
2284 $activityContactOther->activity_id
= $activityContact->activity_id
;
2286 // delete activity only if no other contacts connected
2287 if (!$activityContactOther->find(TRUE)) {
2288 $activityParams = array('id' => $activityContact->activity_id
);
2289 $result = self
::deleteActivity($activityParams);
2292 $activityContactOther->free();
2295 $activityContact->free();
2296 $transaction->commit();
2302 * Does user has sufficient permission for view/edit activity record.
2304 * @param int $activityId
2305 * Activity record id.
2306 * @param int $action
2311 public static function checkPermission($activityId, $action) {
2314 !in_array($action, array(CRM_Core_Action
::UPDATE
, CRM_Core_Action
::VIEW
))
2319 $activity = new CRM_Activity_DAO_Activity();
2320 $activity->id
= $activityId;
2321 if (!$activity->find(TRUE)) {
2325 // Component related permissions.
2326 $compPermissions = array(
2327 'CiviCase' => array(
2328 'administer CiviCase',
2329 'access my cases and activities',
2330 'access all cases and activities',
2332 'CiviMail' => array('access CiviMail'),
2333 'CiviEvent' => array('access CiviEvent'),
2334 'CiviGrant' => array('access CiviGrant'),
2335 'CiviPledge' => array('access CiviPledge'),
2336 'CiviMember' => array('access CiviMember'),
2337 'CiviReport' => array('access CiviReport'),
2338 'CiviContribute' => array('access CiviContribute'),
2339 'CiviCampaign' => array('administer CiviCampaign'),
2342 // Return early when it is case activity.
2343 $isCaseActivity = CRM_Case_BAO_Case
::isCaseActivity($activityId);
2344 // Check for civicase related permission.
2345 if ($isCaseActivity) {
2347 foreach ($compPermissions['CiviCase'] as $per) {
2348 if (CRM_Core_Permission
::check($per)) {
2354 // Check for case specific permissions.
2357 if ($action == CRM_Core_Action
::UPDATE
) {
2360 $allow = CRM_Case_BAO_Case
::checkPermission($activityId,
2362 $activity->activity_type_id
2369 // First check the component permission.
2372 FROM civicrm_option_value val
2373 INNER JOIN civicrm_option_group grp ON ( grp.id = val.option_group_id AND grp.name = %1 )
2374 WHERE val.value = %2";
2376 1 => array('activity_type', 'String'),
2377 2 => array($activity->activity_type_id
, 'Integer'),
2379 $componentId = CRM_Core_DAO
::singleValueQuery($sql, $params);
2382 $componentName = CRM_Core_Component
::getComponentName($componentId);
2383 $compPermission = CRM_Utils_Array
::value($componentName, $compPermissions);
2385 // Here we are interesting in any single permission.
2386 if (is_array($compPermission)) {
2387 foreach ($compPermission as $per) {
2388 if (CRM_Core_Permission
::check($per)) {
2396 // Check for this permission related to contact.
2397 $permission = CRM_Core_Permission
::VIEW
;
2398 if ($action == CRM_Core_Action
::UPDATE
) {
2399 $permission = CRM_Core_Permission
::EDIT
;
2402 $activityContacts = CRM_Core_OptionGroup
::values('activity_contacts', FALSE, FALSE, FALSE, NULL, 'name');
2403 $sourceID = CRM_Utils_Array
::key('Activity Source', $activityContacts);
2404 $assigneeID = CRM_Utils_Array
::key('Activity Assignees', $activityContacts);
2405 $targetID = CRM_Utils_Array
::key('Activity Targets', $activityContacts);
2407 // Check for source contact.
2408 if (!$componentId ||
$allow) {
2409 $sourceContactId = self
::getActivityContact($activity->id
, $sourceID);
2410 // Account for possibility of activity not having a source contact (as it may have been deleted).
2411 if ($sourceContactId) {
2412 $allow = CRM_Contact_BAO_Contact_Permission
::allow($sourceContactId, $permission);
2416 // Check for target and assignee contacts.
2418 // First check for supper permission.
2419 $supPermission = 'view all contacts';
2420 if ($action == CRM_Core_Action
::UPDATE
) {
2421 $supPermission = 'edit all contacts';
2423 $allow = CRM_Core_Permission
::check($supPermission);
2425 // User might have sufficient permission, through acls.
2428 // Get the target contacts.
2429 $targetContacts = CRM_Activity_BAO_ActivityContact
::retrieveContactIdsByActivityId($activity->id
, $targetID);
2430 foreach ($targetContacts as $cnt => $contactId) {
2431 if (!CRM_Contact_BAO_Contact_Permission
::allow($contactId, $permission)) {
2437 // Get the assignee contacts.
2439 $assigneeContacts = CRM_Activity_BAO_ActivityContact
::retrieveContactIdsByActivityId($activity->id
, $assigneeID);
2440 foreach ($assigneeContacts as $cnt => $contactId) {
2441 if (!CRM_Contact_BAO_Contact_Permission
::allow($contactId, $permission)) {
2454 * Wrapper for ajax activity selector.
2456 * @param array $params
2457 * Associated array for params record id.
2460 * Associated array of contact activities
2462 public static function getContactActivitySelector(&$params) {
2463 // Format the params.
2464 $params['offset'] = ($params['page'] - 1) * $params['rp'];
2465 $params['rowCount'] = $params['rp'];
2466 $params['sort'] = CRM_Utils_Array
::value('sortBy', $params);
2467 $params['caseId'] = NULL;
2468 $context = CRM_Utils_Array
::value('context', $params);
2470 // Get contact activities.
2471 $activities = CRM_Activity_BAO_Activity
::getActivities($params);
2474 $params['total'] = CRM_Activity_BAO_Activity
::getActivitiesCount($params);
2476 // Format params and add links.
2477 $contactActivities = array();
2479 if (!empty($activities)) {
2480 $activityStatus = CRM_Core_PseudoConstant
::activityStatus();
2482 // Check logged in user for permission.
2483 $page = new CRM_Core_Page();
2484 CRM_Contact_Page_View
::checkUserPermission($page, $params['contact_id']);
2485 $permissions = array($page->_permission
);
2486 if (CRM_Core_Permission
::check('delete activities')) {
2487 $permissions[] = CRM_Core_Permission
::DELETE
;
2490 $mask = CRM_Core_Action
::mask($permissions);
2492 foreach ($activities as $activityId => $values) {
2493 $activity = array();
2494 $activity['DT_RowId'] = $activityId;
2495 // Add class to this row if overdue.
2496 $activity['DT_RowClass'] = 'crm-entity';
2497 if (CRM_Utils_Date
::overdue(CRM_Utils_Array
::value('activity_date_time', $values))
2498 && CRM_Utils_Array
::value('status_id', $values) == 1
2500 $activity['DT_RowClass'] .= ' status-overdue';
2503 $activity['DT_RowClass'] .= ' status-ontime';
2506 $activity['DT_RowAttr'] = array();
2507 $activity['DT_RowAttr']['data-entity'] = 'activity';
2508 $activity['DT_RowAttr']['data-id'] = $activityId;
2510 $activity['activity_type'] = $values['activity_type'];
2511 $activity['subject'] = $values['subject'];
2513 $activity['source_contact_name'] = '';
2514 if ($params['contact_id'] == $values['source_contact_id']) {
2515 $activity['source_contact_name'] = $values['source_contact_name'];
2517 elseif ($values['source_contact_id']) {
2518 $activity['source_contact_name'] = CRM_Utils_System
::href($values['source_contact_name'],
2519 'civicrm/contact/view', "reset=1&cid={$values['source_contact_id']}");
2522 $activity['source_contact_name'] = '<em>n/a</em>';
2525 $activity['target_contact_name'] = '';
2526 if (isset($values['mailingId']) && !empty($values['mailingId'])) {
2527 $activity['target_contact'] = CRM_Utils_System
::href($values['recipients'],
2528 'civicrm/mailing/report/event',
2529 "mid={$values['source_record_id']}&reset=1&event=queue&cid={$params['contact_id']}&context=activitySelector");
2531 elseif (!empty($values['recipients'])) {
2532 $activity['target_contact_name'] = $values['recipients'];
2534 elseif (isset($values['target_contact_counter']) && $values['target_contact_counter']) {
2535 $activity['target_contact_name'] = '';
2536 foreach ($values['target_contact_name'] as $tcID => $tcName) {
2537 $activity['target_contact_name'] .= CRM_Utils_System
::href($tcName,
2538 'civicrm/contact/view', "reset=1&cid={$tcID}");
2541 if ($extraCount = $values['target_contact_counter'] - 1) {
2542 $activity['target_contact_name'] .= ";<br />" . "(" . ts('%1 more', array(1 => $extraCount)) . ")";
2545 elseif (!$values['target_contact_name']) {
2546 $activity['target_contact_name'] = '<em>n/a</em>';
2549 $activity['assignee_contact_name'] = '';
2550 if (empty($values['assignee_contact_name'])) {
2551 $activity['assignee_contact_name'] = '<em>n/a</em>';
2553 elseif (!empty($values['assignee_contact_name'])) {
2555 $activity['assignee_contact_name'] = '';
2556 foreach ($values['assignee_contact_name'] as $acID => $acName) {
2557 if ($acID && $count < 5) {
2558 $activity['assignee_contact_name'] .= CRM_Utils_System
::href($acName, 'civicrm/contact/view', "reset=1&cid={$acID}");
2561 $activity['assignee_contact_name'] .= "; ";
2565 $activity['assignee_contact_name'] .= "(" . ts('more') . ")";
2572 $activity['activity_date_time'] = CRM_Utils_Date
::customFormat($values['activity_date_time']);
2573 $activity['status_id'] = $activityStatus[$values['status_id']];
2576 $activity['links'] = '';
2577 $accessMailingReport = FALSE;
2578 if (!empty($values['mailingId'])) {
2579 $accessMailingReport = TRUE;
2582 $actionLinks = CRM_Activity_Selector_Activity
::actionLinks(
2583 CRM_Utils_Array
::value('activity_type_id', $values),
2584 CRM_Utils_Array
::value('source_record_id', $values),
2585 $accessMailingReport,
2586 CRM_Utils_Array
::value('activity_id', $values)
2589 $actionMask = array_sum(array_keys($actionLinks)) & $mask;
2591 $activity['links'] = CRM_Core_Action
::formLink($actionLinks,
2594 'id' => $values['activity_id'],
2595 'cid' => $params['contact_id'],
2597 'caseid' => CRM_Utils_Array
::value('case_id', $values),
2603 $values['activity_id']
2606 if ($values['is_recurring_activity']) {
2607 $contactActivities[$activityId]['is_recurring_activity'] = CRM_Core_BAO_RecurringEntity
::getPositionAndCount($values['activity_id'], 'civicrm_activity');
2610 array_push($contactActivities, $activity);
2614 $activitiesDT = array();
2615 $activitiesDT['data'] = $contactActivities;
2616 $activitiesDT['recordsTotal'] = $params['total'];
2617 $activitiesDT['recordsFiltered'] = $params['total'];
2619 return $activitiesDT;
2623 * Copy custom fields and attachments from an existing activity to another.
2625 * @see CRM_Case_Page_AJAX::_convertToCaseActivity()
2627 * @param array $params
2629 public static function copyExtendedActivityData($params) {
2630 // attach custom data to the new activity
2631 $customParams = $htmlType = array();
2632 $customValues = CRM_Core_BAO_CustomValueTable
::getEntityValues($params['activityID'], 'Activity');
2634 if (!empty($customValues)) {
2635 $fieldIds = implode(', ', array_keys($customValues));
2636 $sql = "SELECT id FROM civicrm_custom_field WHERE html_type = 'File' AND id IN ( {$fieldIds} )";
2637 $result = CRM_Core_DAO
::executeQuery($sql);
2639 while ($result->fetch()) {
2640 $htmlType[] = $result->id
;
2643 foreach ($customValues as $key => $value) {
2644 if ($value !== NULL) {
2646 if (in_array($key, $htmlType)) {
2647 $fileValues = CRM_Core_BAO_File
::path($value, $params['activityID']);
2648 $customParams["custom_{$key}_-1"] = array(
2649 'name' => $fileValues[0],
2650 'path' => $fileValues[1],
2654 $customParams["custom_{$key}_-1"] = $value;
2658 CRM_Core_BAO_CustomValueTable
::postProcess($customParams, 'civicrm_activity',
2659 $params['mainActivityId'], 'Activity'
2663 // copy activity attachments ( if any )
2664 CRM_Core_BAO_File
::copyEntityFile('civicrm_activity', $params['activityID'], 'civicrm_activity', $params['mainActivityId']);
2668 * Get activity contact.
2670 * @param int $activityId
2671 * @param int $recordTypeID
2672 * @param string $column
2676 public static function getActivityContact($activityId, $recordTypeID = NULL, $column = 'contact_id') {
2677 $activityContact = new CRM_Activity_BAO_ActivityContact();
2678 $activityContact->activity_id
= $activityId;
2679 if ($recordTypeID) {
2680 $activityContact->record_type_id
= $recordTypeID;
2682 if ($activityContact->find(TRUE)) {
2683 return $activityContact->$column;
2689 * Get source contact id.
2691 * @param int $activityId
2695 public static function getSourceContactID($activityId) {
2696 static $sourceID = NULL;
2698 $activityContacts = CRM_Core_OptionGroup
::values('activity_contacts', FALSE, FALSE, FALSE, NULL, 'name');
2699 $sourceID = CRM_Utils_Array
::key('Activity Source', $activityContacts);
2702 return self
::getActivityContact($activityId, $sourceID);
2708 * @todo Document what this is for.
2710 * @param array $params
2712 public function setApiFilter(&$params) {
2713 if (!empty($params['target_contact_id'])) {
2715 $activityContacts = CRM_Core_OptionGroup
::values('activity_contacts', FALSE, FALSE, FALSE, NULL, 'name');
2716 $targetID = CRM_Utils_Array
::key('Activity Targets', $activityContacts);
2717 $obj = new CRM_Activity_BAO_ActivityContact();
2718 $params['return.target_contact_id'] = 1;
2719 $this->joinAdd($obj, 'LEFT');
2720 $this->selectAdd('civicrm_activity.*');
2721 $this->whereAdd(" civicrm_activity_contact.contact_id = {$params['target_contact_id']} AND civicrm_activity_contact.record_type_id = {$targetID}");
2726 * Send activity as attachment.
2728 * @param object $activity
2729 * @param array $mailToContacts
2730 * @param array $params
2734 public static function sendToAssignee($activity, $mailToContacts, $params = array()) {
2735 if (!CRM_Utils_Array
::crmIsEmptyArray($mailToContacts)) {
2736 $clientID = CRM_Utils_Array
::value('client_id', $params);
2737 $caseID = CRM_Utils_Array
::value('case_id', $params);
2739 $ics = new CRM_Activity_BAO_ICalendar($activity);
2740 $attachments = CRM_Core_BAO_File
::getEntityFile('civicrm_activity', $activity->id
);
2741 $ics->addAttachment($attachments, $mailToContacts);
2743 $result = CRM_Case_BAO_Case
::sendActivityCopy($clientID, $activity->id
, $mailToContacts, $attachments, $caseID);