fixed activity count bug, CRM-14175
[civicrm-core.git] / CRM / Activity / BAO / Activity.php
CommitLineData
6a488035
TO
1<?php
2/*
3 +--------------------------------------------------------------------+
232624b1 4 | CiviCRM version 4.4 |
6a488035
TO
5 +--------------------------------------------------------------------+
6 | Copyright CiviCRM LLC (c) 2004-2013 |
7 +--------------------------------------------------------------------+
8 | This file is a part of CiviCRM. |
9 | |
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. |
13 | |
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. |
18 | |
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 +--------------------------------------------------------------------+
26*/
27
28/**
29 *
30 * @package CRM
31 * @copyright CiviCRM LLC (c) 2004-2013
32 * $Id$
33 *
34 */
35
36/**
37 * This class is for activity functions
38 *
39 */
40class CRM_Activity_BAO_Activity extends CRM_Activity_DAO_Activity {
41
42 /**
43 * static field for all the activity information that we can potentially export
44 *
45 * @var array
46 * @static
47 */
48 static $_exportableFields = NULL;
49
50 /**
51 * static field for all the activity information that we can potentially import
52 *
53 * @var array
54 * @static
55 */
56 static $_importableFields = NULL;
57
58 /**
59 * Check if there is absolute minimum of data to add the object
60 *
61 * @param array $params (reference ) an assoc array of name/value pairs
62 *
63 * @return boolean
64 * @access public
65 */
66 public static function dataExists(&$params) {
67 if (CRM_Utils_Array::value('source_contact_id', $params) ||
68 CRM_Utils_Array::value('id', $params)
69 ) {
70 return TRUE;
71 }
72 return FALSE;
73 }
74
75 /**
76 * Takes a bunch of params that are needed to match certain criteria and
77 * retrieves the relevant objects. Typically the valid params are only
78 * contact_id. We'll tweak this function to be more full featured over a period
79 * of time. This is the inverse function of create. It also stores all the retrieved
80 * values in the default array
81 *
82 * @param array $params (reference ) an assoc array of name/value pairs
83 * @param array $defaults (reference ) an assoc array to hold the flattened values
84 * @param string $activityType activity type
85 *
86 * @return object CRM_Core_BAO_Meeting object
87 * @access public
88 */
89 public static function retrieve(&$params, &$defaults) {
90 $activity = new CRM_Activity_DAO_Activity();
91 $activity->copyValues($params);
92
93 if ($activity->find(TRUE)) {
e7e657f0 94 $activityContacts = CRM_Core_OptionGroup::values('activity_contacts', FALSE, FALSE, FALSE, NULL, 'name');
034500d4 95 $targetID = CRM_Utils_Array::key('Activity Targets', $activityContacts);
96 $sourceID = CRM_Utils_Array::key('Activity Source', $activityContacts);
97 $assigneeID = CRM_Utils_Array::key('Activity Assignees', $activityContacts);
98
6a488035
TO
99 // TODO: at some stage we'll have to deal
100 // TODO: with multiple values for assignees and targets, but
101 // TODO: for now, let's just fetch first row
034500d4 102 $defaults['assignee_contact'] = CRM_Activity_BAO_ActivityContact::retrieveContactIdsByActivityId($activity->id, $assigneeID);
103 $assignee_contact_names = CRM_Activity_BAO_ActivityContact::getNames($activity->id, $assigneeID);
6a488035 104 $defaults['assignee_contact_value'] = implode('; ', $assignee_contact_names);
eb873b6e 105 $sourceContactId = self::getActivityContact($activity->id, $sourceID);
6a488035 106 if ($activity->activity_type_id != CRM_Core_OptionGroup::getValue('activity_type', 'Bulk Email', 'name')) {
034500d4 107 $defaults['target_contact'] = CRM_Activity_BAO_ActivityContact::retrieveContactIdsByActivityId($activity->id, $targetID);
108 $target_contact_names = CRM_Activity_BAO_ActivityContact::getNames($activity->id, $targetID);
6a488035
TO
109 $defaults['target_contact_value'] = implode('; ', $target_contact_names);
110 }
111 elseif (CRM_Core_Permission::check('access CiviMail') ||
112 (CRM_Mailing_Info::workflowEnabled() &&
113 CRM_Core_Permission::check('create mailings')
114 )
115 ) {
116 $defaults['mailingId'] = CRM_Utils_System::url('civicrm/mailing/report',
eb873b6e 117 "mid={$activity->source_record_id}&reset=1&atype={$activity->activity_type_id}&aid={$activity->id}&cid={$sourceContactId}&context=activity"
6a488035
TO
118 );
119 }
120 else {
121 $defaults['target_contact_value'] = ts('(recipients)');
122 }
b319d00a 123
65ebc887 124 $sourceContactId = self::getActivityContact($activity->id, $sourceID);
ad674e50 125 $defaults['source_contact_id'] = $sourceContactId;
6a488035 126
65ebc887 127 if ($sourceContactId &&
6a488035 128 !CRM_Core_DAO::getFieldValue('CRM_Contact_DAO_Contact',
65ebc887 129 $sourceContactId,
6a488035
TO
130 'is_deleted'
131 )
132 ) {
133 $defaults['source_contact'] = CRM_Core_DAO::getFieldValue('CRM_Contact_DAO_Contact',
65ebc887 134 $sourceContactId,
6a488035
TO
135 'sort_name'
136 );
137 }
138
139 //get case subject
140 $defaults['case_subject'] = CRM_Case_BAO_Case::getCaseSubject($activity->id);
141
142 CRM_Core_DAO::storeValues($activity, $defaults);
143
144 return $activity;
145 }
146 return NULL;
147 }
148
149 /**
150 * Function to delete the activity
151 *
152 * @param array $params associated array
153 *
154 * @return void
155 * @access public
156 *
157 */
158 public static function deleteActivity(&$params, $moveToTrash = FALSE) {
159 // CRM-9137
160 if (CRM_Utils_Array::value('id', $params) && !is_array($params['id'])) {
161 CRM_Utils_Hook::pre('delete', 'Activity', $params['id'], $params);
162 }
163 else {
164 CRM_Utils_Hook::pre('delete', 'Activity', NULL, $params);
165 }
166
167 $transaction = new CRM_Core_Transaction();
168 if (is_array(CRM_Utils_Array::value('source_record_id', $params))) {
169 $sourceRecordIds = implode(',', $params['source_record_id']);
170 }
171 else {
172 $sourceRecordIds = CRM_Utils_Array::value('source_record_id', $params);
173 }
174
175 $result = NULL;
176 if (!$moveToTrash) {
177 if (!isset($params['id'])) {
178 if (is_array($params['activity_type_id'])) {
179 $activityTypes = implode(',', $params['activity_type_id']);
180 }
181 else {
182 $activityTypes = $params['activity_type_id'];
183 }
184
185 $query = "DELETE FROM civicrm_activity WHERE source_record_id IN ({$sourceRecordIds}) AND activity_type_id IN ( {$activityTypes} )";
186 $dao = CRM_Core_DAO::executeQuery($query);
187 }
188 else {
189 $activity = new CRM_Activity_DAO_Activity();
190 $activity->copyValues($params);
191 $result = $activity->delete();
192
193 // CRM-8708
194 $activity->case_id = CRM_Case_BAO_Case::getCaseIdByActivityId($activity->id);
195 }
196 }
197 else {
198 $activity = new CRM_Activity_DAO_Activity();
199 $activity->copyValues($params);
200
201 $activity->is_deleted = 1;
202 $result = $activity->save();
203
204 //log activty delete.CRM-4525.
205 $logMsg = 'Case Activity deleted for';
206 $msgs = array();
034500d4 207
e7e657f0 208 $activityContacts = CRM_Core_OptionGroup::values('activity_contacts', FALSE, FALSE, FALSE, NULL, 'name');
034500d4 209 $sourceID = CRM_Utils_Array::key('Activity Source', $activityContacts);
210 $assigneeID = CRM_Utils_Array::key('Activity Assignees', $activityContacts);
211 $targetID = CRM_Utils_Array::key('Activity Targets', $activityContacts);
212 $sourceContactId = self::getActivityContact($activity->id, $sourceID);
6a488035
TO
213 if ($sourceContactId) {
214 $msgs[] = " source={$sourceContactId}";
215 }
034500d4 216
6a488035 217 //get target contacts.
034500d4 218 $targetContactIds = CRM_Activity_BAO_ActivityContact::getNames($activity->id, $targetID);
6a488035
TO
219 if (!empty($targetContactIds)) {
220 $msgs[] = " target =" . implode(',', array_keys($targetContactIds));
221 }
222 //get assignee contacts.
034500d4 223 $assigneeContactIds = CRM_Activity_BAO_ActivityContact::getNames($activity->id, $assigneeID);
6a488035
TO
224 if (!empty($assigneeContactIds)) {
225 $msgs[] = " assignee =" . implode(',', array_keys($assigneeContactIds));
226 }
227
228 $logMsg .= implode(', ', $msgs);
229
230 self::logActivityAction($activity, $logMsg);
231 }
232
233 // delete the recently created Activity
234 if ($result) {
235 $activityRecent = array(
236 'id' => $activity->id,
237 'type' => 'Activity',
238 );
239 CRM_Utils_Recent::del($activityRecent);
240 }
241
242 $transaction->commit();
243 if (isset($activity)) {
244 // CRM-8708
245 $activity->case_id = CRM_Case_BAO_Case::getCaseIdByActivityId($activity->id);
246 CRM_Utils_Hook::post('delete', 'Activity', $activity->id, $activity);
247 }
248
249 return $result;
250 }
251
252 /**
253 * Delete activity assignment record
254 *
255 * @param int $id activity id
256 *
257 * @return null
258 * @access public
259 */
a24b3694 260 public static function deleteActivityContact($activityId, $recordTypeID = NULL) {
1d85d241
DL
261 $activityContact = new CRM_Activity_BAO_ActivityContact();
262 $activityContact->activity_id = $activityId;
a24b3694 263 if ($recordTypeID) {
264 $activityContact->record_type_id = $recordTypeID;
6a488035 265 }
1d85d241 266 $activityContact->delete();
6a488035
TO
267 }
268
269 /**
270 * Function to process the activities
271 *
272 * @param object $form form object
273 * @param array $params associated array of the submitted values
274 * @param array $ids array of ids
275 * @param string $activityType activity Type
276 * @param boolean $record true if it is Record Activity
277 * @access public
278 *
279 * @return
280 */
281 public static function create(&$params) {
282 // check required params
283 if (!self::dataExists($params)) {
284 CRM_Core_Error::fatal('Not enough data to create activity object,');
285 }
286
287 $activity = new CRM_Activity_DAO_Activity();
288
289 if (isset($params['id']) && empty($params['id'])) {
290 unset($params['id']);
291 }
292
293 if (!CRM_Utils_Array::value('status_id', $params) &&
294 !CRM_Utils_Array::value('activity_status_id', $params) &&
295 !CRM_Utils_Array::value('id', $params)
296 ) {
297 if (isset($params['activity_date_time']) &&
298 strcmp($params['activity_date_time'], CRM_Utils_Date::processDate(date('Ymd')) == -1)
299 ) {
300 $params['status_id'] = 2;
301 }
302 else {
303 $params['status_id'] = 1;
304 }
305 }
306
307 //set priority to Normal for Auto-populated activities (for Cases)
308 if (CRM_Utils_Array::value('priority_id', $params) === NULL &&
309 // if not set and not 0
310 !CRM_Utils_Array::value('id', $params)
311 ) {
cbf48754 312 $priority = CRM_Core_PseudoConstant::get('CRM_Activity_DAO_Activity', 'priority_id');
6a488035
TO
313 $params['priority_id'] = array_search('Normal', $priority);
314 }
315
316 if (!empty($params['target_contact_id']) && is_array($params['target_contact_id'])) {
317 $params['target_contact_id'] = array_unique($params['target_contact_id']);
318 }
319 if (!empty($params['assignee_contact_id']) && is_array($params['assignee_contact_id'])) {
320 $params['assignee_contact_id'] = array_unique($params['assignee_contact_id']);
321 }
322
323 // CRM-9137
324 if (CRM_Utils_Array::value('id', $params)) {
325 CRM_Utils_Hook::pre('edit', 'Activity', $activity->id, $params);
326 }
327 else {
328 CRM_Utils_Hook::pre('create', 'Activity', NULL, $params);
329 }
330
331 $activity->copyValues($params);
332 if (isset($params['case_id'])) {
333 // CRM-8708, preserve case ID even though it's not part of the SQL model
334 $activity->case_id = $params['case_id'];
335 }
336 elseif (is_numeric($activity->id)) {
337 // CRM-8708, preserve case ID even though it's not part of the SQL model
338 $activity->case_id = CRM_Case_BAO_Case::getCaseIdByActivityId($activity->id);
339 }
340
341 // start transaction
342 $transaction = new CRM_Core_Transaction();
343
344 $result = $activity->save();
345
346 if (is_a($result, 'CRM_Core_Error')) {
347 $transaction->rollback();
348 return $result;
349 }
350
351 $activityId = $activity->id;
e7e657f0 352 $activityContacts = CRM_Core_OptionGroup::values('activity_contacts', FALSE, FALSE, FALSE, NULL, 'name');
a24b3694 353 $sourceID = CRM_Utils_Array::key('Activity Source', $activityContacts);
354 $assigneeID = CRM_Utils_Array::key('Activity Assignees', $activityContacts);
355 $targetID = CRM_Utils_Array::key('Activity Targets', $activityContacts);
6a488035 356
1d85d241
DL
357 if (isset($params['source_contact_id'])) {
358 $acParams = array(
359 'activity_id' => $activityId,
360 'contact_id' => $params['source_contact_id'],
a24b3694 361 'record_type_id' => $sourceID
1d85d241 362 );
8ea7ce5d 363 self::deleteActivityContact($activityId, $sourceID);
1d85d241
DL
364 CRM_Activity_BAO_ActivityContact::create($acParams);
365 }
366
6a488035
TO
367 // check and attach and files as needed
368 CRM_Core_BAO_File::processAttachment($params, 'civicrm_activity', $activityId);
369
370 // attempt to save activity assignment
371 $resultAssignment = NULL;
372 if (CRM_Utils_Array::value('assignee_contact_id', $params)) {
373
374 $assignmentParams = array('activity_id' => $activityId);
375
376 if (is_array($params['assignee_contact_id'])) {
377 if (CRM_Utils_Array::value('deleteActivityAssignment', $params, TRUE)) {
378 // first delete existing assignments if any
a24b3694 379 self::deleteActivityContact($activityId, $assigneeID);
6a488035
TO
380 }
381
382 $values = array();
383 foreach ($params['assignee_contact_id'] as $acID) {
384 if ($acID) {
a24b3694 385 $values[] = "( $activityId, $acID, $assigneeID )";
6a488035
TO
386 }
387 }
388 while (!empty($values)) {
389 $input = array_splice($values, 0, CRM_Core_DAO::BULK_INSERT_COUNT);
390 $str = implode(',', $input);
a24b3694 391 $sql = "INSERT IGNORE INTO civicrm_activity_contact ( activity_id, contact_id, record_type_id ) VALUES $str;";
6a488035
TO
392 CRM_Core_DAO::executeQuery($sql);
393 }
394 }
395 else {
b319d00a 396 $assignmentParams['contact_id'] = $params['assignee_contact_id'];
034500d4 397 $assignmentParams['record_type_id'] = $assigneeID;
6a488035 398 if (CRM_Utils_Array::value('id', $params)) {
cc1c86e9 399 $assignment = new CRM_Activity_BAO_ActivityContact();
6a488035 400 $assignment->activity_id = $activityId;
034500d4 401 $assignment->record_type_id = $assigneeID;
6a488035
TO
402 $assignment->find(TRUE);
403
b319d00a 404 if ($assignment->contact_id != $params['assignee_contact_id']) {
6a488035 405 $assignmentParams['id'] = $assignment->id;
034500d4 406 $resultAssignment = CRM_Activity_BAO_ActivityContact::create($assignmentParams);
6a488035
TO
407 }
408 }
409 else {
034500d4 410 $resultAssignment = CRM_Activity_BAO_ActivityContact::create($assignmentParams);
6a488035
TO
411 }
412 }
413 }
414 else {
415 if (CRM_Utils_Array::value('deleteActivityAssignment', $params, TRUE)) {
a24b3694 416 self::deleteActivityContact($activityId, $assigneeID);
6a488035
TO
417 }
418 }
419
420 if (is_a($resultAssignment, 'CRM_Core_Error')) {
421 $transaction->rollback();
422 return $resultAssignment;
423 }
424
425 // attempt to save activity targets
426 $resultTarget = NULL;
427 if (CRM_Utils_Array::value('target_contact_id', $params)) {
428
429 $targetParams = array('activity_id' => $activityId);
430 $resultTarget = array();
431 if (is_array($params['target_contact_id'])) {
432 if (CRM_Utils_Array::value('deleteActivityTarget', $params, TRUE)) {
433 // first delete existing targets if any
a24b3694 434 self::deleteActivityContact($activityId, $targetID );
6a488035
TO
435 }
436
437 $values = array();
438 foreach ($params['target_contact_id'] as $tid) {
439 if ($tid) {
a24b3694 440 $values[] = "( $activityId, $tid, $targetID )";
6a488035
TO
441 }
442 }
443
444 while (!empty($values)) {
445 $input = array_splice($values, 0, CRM_Core_DAO::BULK_INSERT_COUNT);
446 $str = implode(',', $input);
a24b3694 447 $sql = "INSERT IGNORE INTO civicrm_activity_contact ( activity_id, contact_id, record_type_id ) VALUES $str;";
6a488035
TO
448 CRM_Core_DAO::executeQuery($sql);
449 }
450 }
451 else {
b319d00a 452 $targetParams['contact_id'] = $params['target_contact_id'];
034500d4 453 $targetParams['record_type_id'] = $targetID;
6a488035 454 if (CRM_Utils_Array::value('id', $params)) {
034500d4 455 $target = new CRM_Activity_BAO_ActivityContact();
6a488035 456 $target->activity_id = $activityId;
034500d4 457 $target->record_type_id = $targetID;
6a488035
TO
458 $target->find(TRUE);
459
b319d00a 460 if ($target->contact_id != $params['target_contact_id']) {
6a488035 461 $targetParams['id'] = $target->id;
034500d4 462 $resultTarget = CRM_Activity_BAO_ActivityContact::create($targetParams);
6a488035
TO
463 }
464 }
465 else {
034500d4 466 $resultTarget = CRM_Activity_BAO_ActivityContact::create($targetParams);
6a488035
TO
467 }
468 }
469 }
470 else {
471 if (CRM_Utils_Array::value('deleteActivityTarget', $params, TRUE)) {
a24b3694 472 self::deleteActivityContact($activityId, $targetID );
6a488035
TO
473 }
474 }
475
0a9f61c4 476 // write to changelog before transaction is committed/rolled
6a488035
TO
477 // back (and prepare status to display)
478 if (CRM_Utils_Array::value('id', $params)) {
479 $logMsg = "Activity (id: {$result->id} ) updated with ";
480 }
481 else {
482 $logMsg = "Activity created for ";
483 }
484
485 $msgs = array();
486 if (isset($params['source_contact_id'])) {
487 $msgs[] = "source={$params['source_contact_id']}";
488 }
489
490 if (CRM_Utils_Array::value('target_contact_id', $params)) {
491 if (is_array($params['target_contact_id']) && !CRM_Utils_array::crmIsEmptyArray($params['target_contact_id'])) {
492 $msgs[] = "target=" . implode(',', $params['target_contact_id']);
493 // take only first target
494 // will be used for recently viewed display
495 $t = array_slice($params['target_contact_id'], 0, 1);
496 $recentContactId = $t[0];
497 }
498 elseif (isset($params['target_contact_id'])) {
499 $msgs[] = "target={$params['target_contact_id']}";
500 // will be used for recently viewed display
501 $recentContactId = $params['target_contact_id'];
502 }
503 }
504 else {
505 // at worst, take source for recently viewed display
506 $recentContactId = CRM_Utils_Array::value('source_contact_id',$params);
507 }
508
509 if (isset($params['assignee_contact_id'])) {
510 if (is_array($params['assignee_contact_id'])) {
511 $msgs[] = "assignee=" . implode(',', $params['assignee_contact_id']);
512 }
513 else {
514 $msgs[] = "assignee={$params['assignee_contact_id']}";
515 }
516 }
517 $logMsg .= implode(', ', $msgs);
518
519 self::logActivityAction($result, $logMsg);
520
521 if (CRM_Utils_Array::value('custom', $params) &&
522 is_array($params['custom'])
523 ) {
524 CRM_Core_BAO_CustomValueTable::store($params['custom'], 'civicrm_activity', $result->id);
525 }
526
527 $transaction->commit();
528 if (!CRM_Utils_Array::value('skipRecentView', $params)) {
529 $recentOther = array();
530 if (CRM_Utils_Array::value('case_id', $params)) {
531 $caseContactID = CRM_Core_DAO::getFieldValue('CRM_Case_DAO_CaseContact', $params['case_id'], 'contact_id', 'case_id');
532 $url = CRM_Utils_System::url('civicrm/case/activity/view',
533 "reset=1&aid={$activity->id}&cid={$caseContactID}&caseID={$params['case_id']}&context=home"
534 );
535 }
536 else {
eb873b6e 537 $q = "action=view&reset=1&id={$activity->id}&atype={$activity->activity_type_id}&cid={$params['source_contact_id']}&context=home";
6a488035
TO
538 if ($activity->activity_type_id != CRM_Core_OptionGroup::getValue('activity_type', 'Email', 'name')) {
539 $url = CRM_Utils_System::url('civicrm/activity', $q);
540 if ($activity->activity_type_id == CRM_Core_OptionGroup::getValue('activity_type', 'Print PDF Letter', 'name')) {
541 $recentOther['editUrl'] = CRM_Utils_System::url('civicrm/activity/pdf/add',
eb873b6e 542 "action=update&reset=1&id={$activity->id}&atype={$activity->activity_type_id}&cid={$params['source_contact_id']}&context=home"
6a488035
TO
543 );
544 }
545 else {
546 $recentOther['editUrl'] = CRM_Utils_System::url('civicrm/activity/add',
eb873b6e 547 "action=update&reset=1&id={$activity->id}&atype={$activity->activity_type_id}&cid={$params['source_contact_id']}&context=home"
6a488035
TO
548 );
549 }
550
551 if (CRM_Core_Permission::check("delete activities")) {
552 $recentOther['deleteUrl'] = CRM_Utils_System::url('civicrm/activity',
eb873b6e 553 "action=delete&reset=1&id={$activity->id}&atype={$activity->activity_type_id}&cid={$params['source_contact_id']}&context=home"
6a488035
TO
554 );
555 }
556 }
557 else {
558 $url = CRM_Utils_System::url('civicrm/activity/view', $q);
559 if (CRM_Core_Permission::check('delete activities')) {
560 $recentOther['deleteUrl'] = CRM_Utils_System::url('civicrm/activity',
eb873b6e 561 "action=delete&reset=1&id={$activity->id}&atype={$activity->activity_type_id}&cid={$params['source_contact_id']}&context=home"
6a488035
TO
562 );
563 }
564 }
565 }
566
567 if (!isset($activity->parent_id)) {
568 $recentContactDisplay = CRM_Contact_BAO_Contact::displayName($recentContactId);
569 // add the recently created Activity
570 $activityTypes = CRM_Core_PseudoConstant::activityType(TRUE, TRUE);
571 $activitySubject = CRM_Core_DAO::getFieldValue('CRM_Activity_DAO_Activity', $activity->id, 'subject');
572
573 $title = "";
574 if (isset($activitySubject)) {
575 $title = $activitySubject . ' - ';
576 }
577
578 $title = $title . $recentContactDisplay;
579 if (CRM_Utils_Array::value($activity->activity_type_id, $activityTypes)) {
580 $title .= ' (' . $activityTypes[$activity->activity_type_id] . ')';
581 }
582
583 CRM_Utils_Recent::add($title,
584 $url,
585 $activity->id,
586 'Activity',
587 $recentContactId,
588 $recentContactDisplay,
589 $recentOther
590 );
591 }
592 }
593
594 // reset the group contact cache since smart groups might be affected due to this
595 CRM_Contact_BAO_GroupContactCache::remove();
596
597 if (CRM_Utils_Array::value('id', $params)) {
598 CRM_Utils_Hook::post('edit', 'Activity', $activity->id, $activity);
599 }
600 else {
601 CRM_Utils_Hook::post('create', 'Activity', $activity->id, $activity);
602 }
603
604 // if the subject contains a ‘[case #…]’ string, file that activity on the related case (CRM-5916)
605 $matches = array();
606 if (preg_match('/\[case #([0-9a-h]{7})\]/', CRM_Utils_Array::value('subject', $params), $matches)) {
607 $key = CRM_Core_DAO::escapeString(CIVICRM_SITE_KEY);
608 $hash = $matches[1];
609 $query = "SELECT id FROM civicrm_case WHERE SUBSTR(SHA1(CONCAT('$key', id)), 1, 7) = '$hash'";
610 $caseParams = array(
611 'activity_id' => $activity->id,
612 'case_id' => CRM_Core_DAO::singleValueQuery($query),
613 );
614 if ($caseParams['case_id']) {
615 CRM_Case_BAO_Case::processCaseActivity($caseParams);
616 }
617 else {
618 self::logActivityAction($activity, "unknown case hash encountered: $hash");
619 }
620 }
621
622 return $result;
623 }
624
625 public static function logActivityAction($activity, $logMessage = NULL) {
626 $session = CRM_Core_Session::singleton();
627 $id = $session->get('userID');
628 if (!$id) {
e7e657f0 629 $activityContacts = CRM_Core_OptionGroup::values('activity_contacts', FALSE, FALSE, FALSE, NULL, 'name');
8a6844b3
DL
630 $sourceID = CRM_Utils_Array::key('Activity Source', $activityContacts);
631 $id = self::getActivityContact($activity->id. $sourceID);
6a488035
TO
632 }
633 $logParams = array(
634 'entity_table' => 'civicrm_activity',
635 'entity_id' => $activity->id,
636 'modified_id' => $id,
637 'modified_date' => date('YmdHis'),
638 'data' => $logMessage,
639 );
640 CRM_Core_BAO_Log::add($logParams);
641 return TRUE;
642 }
643
644 /**
0a9f61c4 645 * function to get the list Activities
6a488035
TO
646 *
647 * @param array $input array of parameters
648 * Keys include
0a9f61c4 649 * - contact_id int contact_id whose activities we want to retrieve
6a488035
TO
650 * - offset int which row to start from ?
651 * - rowCount int how many rows to fetch
652 * - sort object|array object or array describing sort order for sql query.
653 * - admin boolean if contact is admin
654 * - caseId int case ID
655 * - context string page on which selector is build
656 * - activity_type_id int|string the activitiy types we want to restrict by
657 *
0a9f61c4 658 * @return array (reference) $values the relevant data object values of open activities
6a488035
TO
659 *
660 * @access public
661 * @static
662 */
663 static function &getActivities($input) {
664 //step 1: Get the basic activity data
2517d079
DL
665 $bulkActivityTypeID = CRM_Core_OptionGroup::getValue(
666 'activity_type',
6a488035
TO
667 'Bulk Email',
668 'name'
669 );
670
671 $config = CRM_Core_Config::singleton();
672
673 $randomNum = md5(uniqid());
674 $activityTempTable = "civicrm_temp_activity_details_{$randomNum}";
675
676 $tableFields = array(
677 'activity_id' => 'int unsigned',
678 'activity_date_time' => 'datetime',
b8cab202 679 'source_record_id' => 'int unsigned',
6a488035
TO
680 'status_id' => 'int unsigned',
681 'subject' => 'varchar(255)',
cec82bce 682 'source_contact_name' => 'varchar(255)',
6a488035
TO
683 'activity_type_id' => 'int unsigned',
684 'activity_type' => 'varchar(128)',
685 'case_id' => 'int unsigned',
686 'case_subject' => 'varchar(255)',
687 'campaign_id' => 'int unsigned',
688 );
689
690 $sql = "CREATE TEMPORARY TABLE {$activityTempTable} ( ";
691 $insertValueSQL = array();
6da5bfce 692 // The activityTempTable contains the sorted rows
693 // so in order to maintain the sort order as-is we add an auto_increment
694 // field; we can sort by this later to ensure the sort order stays correct.
695 $sql .= " fixed_sort_order INT UNSIGNED NOT NULL AUTO_INCREMENT PRIMARY KEY,";
6a488035
TO
696 foreach ($tableFields as $name => $desc) {
697 $sql .= "$name $desc,\n";
698 $insertValueSQL[] = $name;
699 }
700
6da5bfce 701 // add unique key on activity_id just to be sure
702 // this cannot be primary key because we need that for the auto_increment
703 // fixed_sort_order field
6a488035 704 $sql .= "
c1d26519 705 UNIQUE KEY ( activity_id )
6a488035
TO
706 ) ENGINE=HEAP DEFAULT CHARACTER SET utf8 COLLATE utf8_unicode_ci
707 ";
708
709 CRM_Core_DAO::executeQuery($sql);
710
711 $insertSQL = "INSERT INTO {$activityTempTable} (" . implode(',', $insertValueSQL) . " ) ";
712
713 $order = $limit = $groupBy = '';
b8cab202 714 $groupBy = " GROUP BY tbl.activity_id ";
6a488035
TO
715
716 if (!empty($input['sort'])) {
717 if (is_a($input['sort'], 'CRM_Utils_Sort')) {
718 $orderBy = $input['sort']->orderBy();
719 if (!empty($orderBy)) {
720 $order = " ORDER BY $orderBy";
721 }
722 }
723 elseif (trim($input['sort'])) {
21d32567
DL
724 $sort = CRM_Utils_Type::escape($input['sort'], 'String');
725 $order = " ORDER BY $sort ";
6a488035
TO
726 }
727 }
728
729 if (empty($order)) {
6da5bfce 730 // context = 'activity' in Activities tab.
6a488035
TO
731 $order = (CRM_Utils_Array::value('context', $input) == 'activity') ? " ORDER BY tbl.activity_date_time desc " : " ORDER BY tbl.status_id asc, tbl.activity_date_time asc ";
732 }
733
734 if (!empty($input['rowCount']) &&
735 $input['rowCount'] > 0
736 ) {
737 $limit = " LIMIT {$input['offset']}, {$input['rowCount']} ";
738 }
739
740 $input['count'] = FALSE;
eacfbd68 741
742 // skip bulk activities in activity tab
743 $input['activity_type_exclude_id'][$bulkActivityTypeID] = $bulkActivityTypeID;
6a488035
TO
744 list($sqlClause, $params) = self::getActivitySQLClause($input);
745
746 $query = "{$insertSQL}
747 SELECT DISTINCT tbl.* from ( {$sqlClause} )
748as tbl ";
749
750 //filter case activities - CRM-5761
751 $components = self::activityComponents();
752 if (!in_array('CiviCase', $components)) {
753 $query .= "
754LEFT JOIN civicrm_case_activity ON ( civicrm_case_activity.activity_id = tbl.activity_id )
755 WHERE civicrm_case_activity.id IS NULL";
756 }
757
758 $query = $query . $groupBy . $order . $limit;
759
760 $dao = CRM_Core_DAO::executeQuery($query, $params);
761
6a488035
TO
762 // step 2: Get target and assignee contacts for above activities
763 // create temp table for target contacts
91da6cd5
DL
764 $activityContactTempTable = "civicrm_temp_activity_contact_{$randomNum}";
765 $query = "CREATE TEMPORARY TABLE {$activityContactTempTable} (
d10f9247 766 activity_id int unsigned, contact_id int unsigned, record_type_id varchar(16),
767 contact_name varchar(255), is_deleted int unsigned, INDEX index_activity_id( activity_id ) )
6a488035
TO
768 ENGINE=MYISAM DEFAULT CHARACTER SET utf8 COLLATE utf8_unicode_ci";
769
770 CRM_Core_DAO::executeQuery($query);
771
772 // note that we ignore bulk email for targets, since we don't show it in selector
91da6cd5 773 $query = "
d8a22375 774INSERT INTO {$activityContactTempTable} ( activity_id, contact_id, record_type_id, contact_name, is_deleted )
91da6cd5
DL
775SELECT ac.activity_id,
776 ac.contact_id,
5b5da1ef 777 ac.record_type_id,
d8a22375
BS
778 c.sort_name,
779 c.is_deleted
d10f9247 780FROM {$activityTempTable}
eacfbd68 781INNER JOIN civicrm_activity a ON ( a.id = {$activityTempTable}.activity_id )
d10f9247 782INNER JOIN civicrm_activity_contact ac ON ( ac.activity_id = {$activityTempTable}.activity_id )
5b5da1ef 783INNER JOIN civicrm_contact c ON c.id = ac.contact_id
91da6cd5 784";
6a488035
TO
785 CRM_Core_DAO::executeQuery($query);
786
6a488035 787 // step 3: Combine all temp tables to get final query for activity selector
6da5bfce 788 // sort by the original sort order, stored in fixed_sort_order
6a488035 789 $query = "
91da6cd5
DL
790SELECT {$activityTempTable}.*,
791 {$activityContactTempTable}.contact_id,
a24b3694 792 {$activityContactTempTable}.record_type_id,
d8a22375
BS
793 {$activityContactTempTable}.contact_name,
794 {$activityContactTempTable}.is_deleted
91da6cd5
DL
795FROM {$activityTempTable}
796INNER JOIN {$activityContactTempTable} on {$activityTempTable}.activity_id = {$activityContactTempTable}.activity_id
6da5bfce 797ORDER BY fixed_sort_order
6a488035
TO
798 ";
799
800
801 $dao = CRM_Core_DAO::executeQuery($query);
802
803 //CRM-3553, need to check user has access to target groups.
804 $mailingIDs = CRM_Mailing_BAO_Mailing::mailingACLIDs();
805 $accessCiviMail = (
806 (CRM_Core_Permission::check('access CiviMail')) ||
807 (CRM_Mailing_Info::workflowEnabled() &&
808 CRM_Core_Permission::check('create mailings'))
809 );
810
811 //get all campaigns.
812 $allCampaigns = CRM_Campaign_BAO_Campaign::getCampaigns(NULL, NULL, FALSE, FALSE, FALSE, TRUE);
813
814 $values = array();
e7e657f0 815 $activityContacts = CRM_Core_OptionGroup::values('activity_contacts', FALSE, FALSE, FALSE, NULL, 'name');
a24b3694 816 $sourceID = CRM_Utils_Array::key('Activity Source', $activityContacts);
817 $assigneeID = CRM_Utils_Array::key('Activity Assignees', $activityContacts);
818 $targetID = CRM_Utils_Array::key('Activity Targets', $activityContacts);
b319d00a 819
a24b3694 820
6a488035
TO
821 while ($dao->fetch()) {
822 $activityID = $dao->activity_id;
823 $values[$activityID]['activity_id'] = $dao->activity_id;
824 $values[$activityID]['source_record_id'] = $dao->source_record_id;
825 $values[$activityID]['activity_type_id'] = $dao->activity_type_id;
826 $values[$activityID]['activity_type'] = $dao->activity_type;
827 $values[$activityID]['activity_date_time'] = $dao->activity_date_time;
828 $values[$activityID]['status_id'] = $dao->status_id;
829 $values[$activityID]['subject'] = $dao->subject;
6a488035
TO
830 $values[$activityID]['campaign_id'] = $dao->campaign_id;
831
832 if ($dao->campaign_id) {
833 $values[$activityID]['campaign'] = $allCampaigns[$dao->campaign_id];
834 }
835
836 if (!CRM_Utils_Array::value('assignee_contact_name', $values[$activityID])) {
837 $values[$activityID]['assignee_contact_name'] = array();
838 }
839
840 if (!CRM_Utils_Array::value('target_contact_name', $values[$activityID])) {
841 $values[$activityID]['target_contact_name'] = array();
842 }
843
d8a22375
BS
844 // if deleted, wrap in <del>
845 if ( $dao->is_deleted ) {
846 $dao->contact_name = "<del>{$dao->contact_name}</dao>";
847 }
848
a24b3694 849 if ($dao->record_type_id == $sourceID && $dao->contact_id) {
91da6cd5
DL
850 $values[$activityID]['source_contact_id'] = $dao->contact_id;
851 $values[$activityID]['source_contact_name'] = $dao->contact_name;
852 }
853
6a488035
TO
854 if (!$bulkActivityTypeID || ($bulkActivityTypeID != $dao->activity_type_id)) {
855 // build array of target / assignee names
a24b3694 856 if ($dao->record_type_id == $targetID && $dao->contact_id) {
91da6cd5 857 $values[$activityID]['target_contact_name'][$dao->contact_id] = $dao->contact_name;
6a488035 858 }
a24b3694 859 if ($dao->record_type_id == $assigneeID && $dao->contact_id) {
91da6cd5 860 $values[$activityID]['assignee_contact_name'][$dao->contact_id] = $dao->contact_name;
6a488035
TO
861 }
862
863 // case related fields
864 $values[$activityID]['case_id'] = $dao->case_id;
865 $values[$activityID]['case_subject'] = $dao->case_subject;
866 }
867 else {
868 $values[$activityID]['recipients'] = ts('(recipients)');
2678caac 869 $values[$activityID]['mailingId'] = false;
6a488035
TO
870 if (
871 $accessCiviMail &&
872 ($mailingIDs === TRUE || in_array($dao->source_record_id, $mailingIDs))
873 ) {
2678caac 874 $values[$activityID]['mailingId'] = true;
6a488035
TO
875 }
876 }
877 }
878
6a488035
TO
879 return $values;
880 }
881
882 /**
883 * Get the component id and name those are enabled and logged in
884 * user has permission. To decide whether we are going to include
885 * component related activities w/ core activity retrieve process.
886 *
887 * return an array of component id and name.
888 * @static
889 **/
890 static function activityComponents() {
891 $components = array();
892 $compInfo = CRM_Core_Component::getEnabledComponents();
893 foreach ($compInfo as $compObj) {
894 if (CRM_Utils_Array::value('showActivitiesInCore', $compObj->info)) {
895 if ($compObj->info['name'] == 'CiviCampaign') {
896 $componentPermission = "administer {$compObj->name}";
897 }
898 else {
899 $componentPermission = "access {$compObj->name}";
900 }
901 if ($compObj->info['name'] == 'CiviCase') {
902 if (CRM_Case_BAO_Case::accessCiviCase()) {
903 $components[$compObj->componentID] = $compObj->info['name'];
904 }
905 }
906 elseif (CRM_Core_Permission::check($componentPermission)) {
907 $components[$compObj->componentID] = $compObj->info['name'];
908 }
909 }
910 }
911
912 return $components;
913 }
914
915 /**
916 * function to get the activity Count
917 *
918 * @param array $input array of parameters
919 * Keys include
0a9f61c4 920 * - contact_id int contact_id whose activities we want to retrieve
6a488035
TO
921 * - admin boolean if contact is admin
922 * - caseId int case ID
923 * - context string page on which selector is build
0a9f61c4 924 * - activity_type_id int|string the activity types we want to restrict by
6a488035
TO
925 *
926 * @return int count of activities
927 *
928 * @access public
929 * @static
930 */
931 static function &getActivitiesCount($input) {
eacfbd68 932 // skip bulk activities in activity tab
933 $bulkActivityTypeID = CRM_Core_OptionGroup::getValue(
934 'activity_type',
935 'Bulk Email',
936 'name'
937 );
938 $input['activity_type_exclude_id'][$bulkActivityTypeID] = $bulkActivityTypeID;
939
6a488035
TO
940 $input['count'] = TRUE;
941 list($sqlClause, $params) = self::getActivitySQLClause($input);
942
943 //filter case activities - CRM-5761
944 $components = self::activityComponents();
945 if (!in_array('CiviCase', $components)) {
946 $query = "
947 SELECT COUNT(DISTINCT(tbl.activity_id)) as count
948 FROM ( {$sqlClause} ) as tbl
949LEFT JOIN civicrm_case_activity ON ( civicrm_case_activity.activity_id = tbl.activity_id )
950 WHERE civicrm_case_activity.id IS NULL";
951 }
952 else {
953 $query = "SELECT COUNT(DISTINCT(activity_id)) as count from ( {$sqlClause} ) as tbl";
954 }
955
956 return CRM_Core_DAO::singleValueQuery($query, $params);
957 }
958
959 /**
960 * function to get the activity sql clause to pick activities
961 *
962 * @param array $input array of parameters
963 * Keys include
0a9f61c4 964 * - contact_id int contact_id whose activities we want to retrieve
6a488035
TO
965 * - admin boolean if contact is admin
966 * - caseId int case ID
967 * - context string page on which selector is build
968 * - count boolean are we interested in the count clause only?
0a9f61c4 969 * - activity_type_id int|string the activity types we want to restrict by
6a488035
TO
970 *
971 * @return int count of activities
972 *
973 * @access public
974 * @static
975 */
976 static function getActivitySQLClause($input) {
977 $params = array();
978 $sourceWhere = $targetWhere = $assigneeWhere = $caseWhere = 1;
979
980 $config = CRM_Core_Config::singleton();
981 if (!CRM_Utils_Array::value('admin', $input, FALSE)) {
91da6cd5 982 $sourceWhere = ' ac.contact_id = %1 ';
6a488035
TO
983 $caseWhere = ' civicrm_case_contact.contact_id = %1 ';
984
985 $params = array(1 => array($input['contact_id'], 'Integer'));
986 }
987
988 $commonClauses = array(
989 "civicrm_option_group.name = 'activity_type'",
990 "civicrm_activity.is_deleted = 0",
991 "civicrm_activity.is_current_revision = 1",
2517d079 992 "civicrm_activity.is_test= 0",
6a488035
TO
993 );
994
995 if ($input['context'] != 'activity') {
996 $commonClauses[] = "civicrm_activity.status_id = 1";
997 }
998
999 //Filter on component IDs.
1000 $components = self::activityComponents();
1001 if (!empty($components)) {
1002 $componentsIn = implode(',', array_keys($components));
1003 $commonClauses[] = "( civicrm_option_value.component_id IS NULL OR civicrm_option_value.component_id IN ( $componentsIn ) )";
1004 }
1005 else {
1006 $commonClauses[] = "civicrm_option_value.component_id IS NULL";
1007 }
1008
1009 // activity type ID clause
1010 if (!empty($input['activity_type_id'])) {
1011 if (is_array($input['activity_type_id'])) {
1012 foreach ($input['activity_type_id'] as $idx => $value) {
1013 $input['activity_type_id'][$idx] = CRM_Utils_Type::escape($value, 'Positive');
1014 }
1015 $commonClauses[] = "civicrm_activity.activity_type_id IN ( " . implode(",", $input['activity_type_id']) . " ) ";
1016 }
1017 else {
1018 $activityTypeID = CRM_Utils_Type::escape($input['activity_type_id'], 'Positive');
1019 $commonClauses[] = "civicrm_activity.activity_type_id = $activityTypeID";
1020 }
1021 }
1022
1023 // exclude by activity type clause
1024 if (!empty($input['activity_type_exclude_id'])) {
1025 if (is_array($input['activity_type_exclude_id'])) {
1026 foreach ($input['activity_type_exclude_id'] as $idx => $value) {
1027 $input['activity_type_exclude_id'][$idx] = CRM_Utils_Type::escape($value, 'Positive');
1028 }
1029 $commonClauses[] = "civicrm_activity.activity_type_id NOT IN ( " . implode(",", $input['activity_type_exclude_id']) . " ) ";
1030 }
1031 else {
1032 $activityTypeID = CRM_Utils_Type::escape($input['activity_type_exclude_id'], 'Positive');
1033 $commonClauses[] = "civicrm_activity.activity_type_id != $activityTypeID";
1034 }
1035 }
1036
1037 $commonClause = implode(' AND ', $commonClauses);
1038
1039 $includeCaseActivities = FALSE;
1040 if (in_array('CiviCase', $components)) {
1041 $includeCaseActivities = TRUE;
1042 }
1043
1044
1045 // build main activity table select clause
1046 $sourceSelect = '';
cec82bce 1047
1048 $activityContacts = CRM_Core_OptionGroup::values('activity_contacts', FALSE, FALSE, FALSE, NULL, 'name');
1049 $sourceID = CRM_Utils_Array::key('Activity Source', $activityContacts);
a3696ce8 1050 $sourceJoin = "
b8cab202 1051INNER JOIN civicrm_activity_contact ac ON ac.activity_id = civicrm_activity.id
a3696ce8
DL
1052INNER JOIN civicrm_contact contact ON ac.contact_id = contact.id
1053";
6a488035
TO
1054
1055 if (!$input['count']) {
1056 $sourceSelect = ',
1057 civicrm_activity.activity_date_time,
b8cab202 1058 civicrm_activity.source_record_id,
6a488035
TO
1059 civicrm_activity.status_id,
1060 civicrm_activity.subject,
cec82bce 1061 contact.sort_name as source_contact_name,
6a488035
TO
1062 civicrm_option_value.value as activity_type_id,
1063 civicrm_option_value.label as activity_type,
1064 null as case_id, null as case_subject,
5b5da1ef 1065 civicrm_activity.campaign_id as campaign_id
6a488035
TO
1066 ';
1067
b8cab202
PJ
1068 $sourceJoin .= "
1069LEFT JOIN civicrm_activity_contact src ON (src.activity_id = ac.activity_id AND src.record_type_id = {$sourceID} AND src.contact_id = contact.id)
1070";
6a488035
TO
1071 }
1072
1073 $sourceClause = "
1074 SELECT civicrm_activity.id as activity_id
1075 {$sourceSelect}
1076 from civicrm_activity
1077 left join civicrm_option_value on
1078 civicrm_activity.activity_type_id = civicrm_option_value.value
1079 left join civicrm_option_group on
1080 civicrm_option_group.id = civicrm_option_value.option_group_id
1081 {$sourceJoin}
1082 where
1083 {$sourceWhere}
1084 AND $commonClause
1085 ";
1086
6a488035
TO
1087 // Build case clause
1088 // or else exclude Inbound Emails that have been filed on a case.
1089 $caseClause = '';
1090
1091 if ($includeCaseActivities) {
1092 $caseSelect = '';
1093 if (!$input['count']) {
1094 $caseSelect = ',
1095 civicrm_activity.activity_date_time,
b8cab202 1096 civicrm_activity.source_record_id,
6a488035
TO
1097 civicrm_activity.status_id,
1098 civicrm_activity.subject,
cec82bce 1099 contact.sort_name as source_contact_name,
6a488035
TO
1100 civicrm_option_value.value as activity_type_id,
1101 civicrm_option_value.label as activity_type,
1102 null as case_id, null as case_subject,
1103 civicrm_activity.campaign_id as campaign_id';
1104 }
1105
1106 $caseClause = "
1107 union all
1108
1109 SELECT civicrm_activity.id as activity_id
1110 {$caseSelect}
1111 from civicrm_activity
1112 inner join civicrm_case_activity on
1113 civicrm_case_activity.activity_id = civicrm_activity.id
1114 inner join civicrm_case on
1115 civicrm_case_activity.case_id = civicrm_case.id
1116 inner join civicrm_case_contact on
1117 civicrm_case_contact.case_id = civicrm_case.id and {$caseWhere}
1118 left join civicrm_option_value on
1119 civicrm_activity.activity_type_id = civicrm_option_value.value
1120 left join civicrm_option_group on
1121 civicrm_option_group.id = civicrm_option_value.option_group_id
1122 {$sourceJoin}
1123 where
1124 {$caseWhere}
1125 AND $commonClause
1126 and ( ( civicrm_case_activity.case_id IS NULL ) OR
1127 ( civicrm_option_value.name <> 'Inbound Email' AND
1128 civicrm_option_value.name <> 'Email' AND civicrm_case_activity.case_id
1129 IS NOT NULL )
1130 )
1131 ";
1132 }
1133
a3696ce8 1134 $returnClause = " {$sourceClause} {$caseClause} ";
6a488035
TO
1135
1136 return array($returnClause, $params);
1137 }
1138
1139 /**
1140 * send the message to all the contacts and also insert a
1141 * contact activity in each contacts record
1142 *
1143 * @param array $contactDetails the array of contact details to send the email
1144 * @param string $subject the subject of the message
1145 * @param string $message the message contents
1146 * @param string $emailAddress use this 'to' email address instead of the default Primary address
1147 * @param int $userID use this userID if set
1148 * @param string $from
1149 * @param array $attachments the array of attachments if any
0a9f61c4 1150 * @param string $cc cc recipient
1151 * @param string $bcc bcc recipient
6a488035 1152 * @param array $contactIds contact ids
c1d26519 1153 * @param string $additionalDetails the additional information of CC and BCC appended to the activity Details
6a488035
TO
1154 *
1155 * @return array ( sent, activityId) if any email is sent and activityId
1156 * @access public
1157 * @static
1158 */
1159 static function sendEmail(
1160 &$contactDetails,
1161 &$subject,
1162 &$text,
1163 &$html,
1164 $emailAddress,
1165 $userID = NULL,
1166 $from = NULL,
1167 $attachments = NULL,
1168 $cc = NULL,
1169 $bcc = NULL,
c1d26519 1170 $contactIds, // FIXME a param with no default shouldn't be last
1171 $additionalDetails = NULL
6a488035
TO
1172 ) {
1173 // get the contact details of logged in contact, which we set as from email
1174 if ($userID == NULL) {
1175 $session = CRM_Core_Session::singleton();
1176 $userID = $session->get('userID');
1177 }
1178
1179 list($fromDisplayName, $fromEmail, $fromDoNotEmail) = CRM_Contact_BAO_Contact::getContactDetails($userID);
1180 if (!$fromEmail) {
1181 return array(count($contactDetails), 0, count($contactDetails));
1182 }
1183 if (!trim($fromDisplayName)) {
1184 $fromDisplayName = $fromEmail;
1185 }
1186
1187 // CRM-4575
1188 // token replacement of addressee/email/postal greetings
1189 // get the tokens added in subject and message
1190 $subjectToken = CRM_Utils_Token::getTokens($subject);
1191 $messageToken = CRM_Utils_Token::getTokens($text);
1192 $messageToken = array_merge($messageToken, CRM_Utils_Token::getTokens($html));
c7436e9c 1193 $allTokens = array_merge($messageToken, $subjectToken);
6a488035
TO
1194
1195 if (!$from) {
1196 $from = "$fromDisplayName <$fromEmail>";
1197 }
1198
1199 //create the meta level record first ( email activity )
1200 $activityTypeID = CRM_Core_OptionGroup::getValue('activity_type',
1201 'Email',
1202 'name'
1203 );
1204
1205 // CRM-6265: save both text and HTML parts in details (if present)
1206 if ($html and $text) {
c1d26519 1207 $details = "-ALTERNATIVE ITEM 0-\n$html$additionalDetails\n-ALTERNATIVE ITEM 1-\n$text$additionalDetails\n-ALTERNATIVE END-\n";
6a488035
TO
1208 }
1209 else {
1210 $details = $html ? $html : $text;
c1d26519 1211 $details .= $additionalDetails;
6a488035
TO
1212 }
1213
1214 $activityParams = array(
1215 'source_contact_id' => $userID,
1216 'activity_type_id' => $activityTypeID,
1217 'activity_date_time' => date('YmdHis'),
1218 'subject' => $subject,
1219 'details' => $details,
1220 // FIXME: check for name Completed and get ID from that lookup
1221 'status_id' => 2,
1222 );
1223
1224 // CRM-5916: strip [case #…] before saving the activity (if present in subject)
1225 $activityParams['subject'] = preg_replace('/\[case #([0-9a-h]{7})\] /', '', $activityParams['subject']);
1226
1227 // add the attachments to activity params here
1228 if ($attachments) {
1229 // first process them
1230 $activityParams = array_merge($activityParams,
1231 $attachments
1232 );
1233 }
1234
1235 $activity = self::create($activityParams);
1236
1237 // get the set of attachments from where they are stored
1238 $attachments = CRM_Core_BAO_File::getEntityFile('civicrm_activity',
1239 $activity->id
1240 );
1241 $returnProperties = array();
1242 if (isset($messageToken['contact'])) {
1243 foreach ($messageToken['contact'] as $key => $value) {
1244 $returnProperties[$value] = 1;
1245 }
1246 }
1247
1248 if (isset($subjectToken['contact'])) {
1249 foreach ($subjectToken['contact'] as $key => $value) {
1250 if (!isset($returnProperties[$value])) {
1251 $returnProperties[$value] = 1;
1252 }
1253 }
1254 }
1255
1256
1257 // get token details for contacts, call only if tokens are used
1258 $details = array();
db969160 1259 if (!empty($returnProperties) || !empty($tokens) || !empty($allTokens)) {
6a488035
TO
1260 list($details) = CRM_Utils_Token::getTokenDetails(
1261 $contactIds,
1262 $returnProperties,
1263 NULL, NULL, FALSE,
c7436e9c 1264 $allTokens,
6a488035
TO
1265 'CRM_Activity_BAO_Activity'
1266 );
1267 }
1268
1269 // call token hook
1270 $tokens = array();
1271 CRM_Utils_Hook::tokens($tokens);
1272 $categories = array_keys($tokens);
1273
1274 $escapeSmarty = FALSE;
1275 if (defined('CIVICRM_MAIL_SMARTY') && CIVICRM_MAIL_SMARTY) {
1276 $smarty = CRM_Core_Smarty::singleton();
1277 $escapeSmarty = TRUE;
1278 }
1279
1280 $sent = $notSent = array();
1281 foreach ($contactDetails as $values) {
1282 $contactId = $values['contact_id'];
1283 $emailAddress = $values['email'];
1284
1285 if (!empty($details) && is_array($details["{$contactId}"])) {
1286 // unset email from details since it always returns primary email address
1287 unset($details["{$contactId}"]['email']);
1288 unset($details["{$contactId}"]['email_id']);
1289 $values = array_merge($values, $details["{$contactId}"]);
1290 }
1291
1292 $tokenSubject = CRM_Utils_Token::replaceContactTokens($subject, $values, FALSE, $subjectToken, FALSE, $escapeSmarty);
1293 $tokenSubject = CRM_Utils_Token::replaceHookTokens($tokenSubject, $values, $categories, FALSE, $escapeSmarty);
1294
1295 //CRM-4539
1296 if ($values['preferred_mail_format'] == 'Text' || $values['preferred_mail_format'] == 'Both') {
1297 $tokenText = CRM_Utils_Token::replaceContactTokens($text, $values, FALSE, $messageToken, FALSE, $escapeSmarty);
1298 $tokenText = CRM_Utils_Token::replaceHookTokens($tokenText, $values, $categories, FALSE, $escapeSmarty);
1299 }
1300 else {
1301 $tokenText = NULL;
1302 }
1303
1304 if ($values['preferred_mail_format'] == 'HTML' || $values['preferred_mail_format'] == 'Both') {
1305 $tokenHtml = CRM_Utils_Token::replaceContactTokens($html, $values, TRUE, $messageToken, FALSE, $escapeSmarty);
1306 $tokenHtml = CRM_Utils_Token::replaceHookTokens($tokenHtml, $values, $categories, TRUE, $escapeSmarty);
1307 }
1308 else {
1309 $tokenHtml = NULL;
1310 }
1311
1312 if (defined('CIVICRM_MAIL_SMARTY') && CIVICRM_MAIL_SMARTY) {
1313 // also add the contact tokens to the template
1314 $smarty->assign_by_ref('contact', $values);
1315
1316 $tokenSubject = $smarty->fetch("string:$tokenSubject");
1317 $tokenText = $smarty->fetch("string:$tokenText");
1318 $tokenHtml = $smarty->fetch("string:$tokenHtml");
1319 }
1320
1321 $sent = FALSE;
1322 if (self::sendMessage(
1323 $from,
1324 $userID,
1325 $contactId,
1326 $tokenSubject,
1327 $tokenText,
1328 $tokenHtml,
1329 $emailAddress,
1330 $activity->id,
1331 $attachments,
1332 $cc,
1333 $bcc
1334 )) {
1335 $sent = TRUE;
1336 }
1337 }
1338
1339 return array($sent, $activity->id);
1340 }
1341
1342 static function sendSMS(&$contactDetails,
1343 &$activityParams,
1344 &$smsParams = array(),
1345 &$contactIds,
1346 $userID = NULL
1347 ) {
1348 if ($userID == NULL) {
1349 $session = CRM_Core_Session::singleton();
1350 $userID = $session->get('userID');
1351 }
1352
1353 $text = &$activityParams['text_message'];
1354 $html = &$activityParams['html_message'];
1355
1356 // CRM-4575
1357 // token replacement of addressee/email/postal greetings
1358 // get the tokens added in subject and message
1359 $messageToken = CRM_Utils_Token::getTokens($text);
1360 $messageToken = array_merge($messageToken,
1361 CRM_Utils_Token::getTokens($html)
1362 );
1363
1364 //create the meta level record first ( sms activity )
1365 $activityTypeID = CRM_Core_OptionGroup::getValue('activity_type',
1366 'SMS',
1367 'name'
1368 );
1369
1370 // CRM-6265: save both text and HTML parts in details (if present)
1371 if ($html and $text) {
1372 $details = "-ALTERNATIVE ITEM 0-\n$html\n-ALTERNATIVE ITEM 1-\n$text\n-ALTERNATIVE END-\n";
1373 }
1374 else {
1375 $details = $html ? $html : $text;
1376 }
1377
1378 $activitySubject = $activityParams['activity_subject'];
1379 $activityParams = array(
1380 'source_contact_id' => $userID,
1381 'activity_type_id' => $activityTypeID,
1382 'activity_date_time' => date('YmdHis'),
1383 'subject' => $activitySubject,
1384 'details' => $details,
1385 // FIXME: check for name Completed and get ID from that lookup
1386 'status_id' => 2,
1387 );
1388
1389 $activity = self::create($activityParams);
1390 $activityID = $activity->id;
1391
1392 $returnProperties = array();
1393
1394 if (isset($messageToken['contact'])) {
1395 foreach ($messageToken['contact'] as $key => $value) {
1396 $returnProperties[$value] = 1;
1397 }
1398 }
1399
1400 // call token hook
1401 $tokens = array();
1402 CRM_Utils_Hook::tokens($tokens);
1403 $categories = array_keys($tokens);
1404
1405 // get token details for contacts, call only if tokens are used
1406 $details = array();
1407 if (!empty($returnProperties) || !empty($tokens)) {
1408 list($details) = CRM_Utils_Token::getTokenDetails($contactIds,
1409 $returnProperties,
1410 NULL, NULL, FALSE,
1411 $messageToken,
1412 'CRM_Activity_BAO_Activity'
1413 );
1414 }
1415
f53ea1ce 1416 $success = 0;
c5a6413b
DS
1417 $escapeSmarty = FALSE;
1418 $errMsgs = array();
6a488035
TO
1419 foreach ($contactDetails as $values) {
1420 $contactId = $values['contact_id'];
1421
1422 if (!empty($details) && is_array($details["{$contactId}"])) {
1423 // unset email from details since it always returns primary email address
1424 unset($details["{$contactId}"]['email']);
1425 unset($details["{$contactId}"]['email_id']);
1426 $values = array_merge($values, $details["{$contactId}"]);
1427 }
1428
1429 $tokenText = CRM_Utils_Token::replaceContactTokens($text, $values, FALSE, $messageToken, FALSE, $escapeSmarty);
1430 $tokenText = CRM_Utils_Token::replaceHookTokens($tokenText, $values, $categories, FALSE, $escapeSmarty);
1431
1432 $tokenHtml = CRM_Utils_Token::replaceContactTokens($html, $values, TRUE, $messageToken, FALSE, $escapeSmarty);
1433 $tokenHtml = CRM_Utils_Token::replaceHookTokens($tokenHtml, $values, $categories, TRUE, $escapeSmarty);
1434
d65e1a68 1435 // Only send if the phone is of type mobile
9357a775
DS
1436 $phoneTypes = CRM_Core_OptionGroup::values('phone_type', TRUE, FALSE, FALSE, NULL, 'name');
1437 if ($values['phone_type_id'] == CRM_Utils_Array::value('Mobile', $phoneTypes)) {
d65e1a68 1438 $smsParams['To'] = $values['phone'];
01aca362
DL
1439 }
1440 else {
d65e1a68
TW
1441 $smsParams['To'] = '';
1442 }
6a488035 1443
c5a6413b
DS
1444 $sendResult = self::sendSMSMessage(
1445 $contactId,
1446 $tokenText,
1447 $tokenHtml,
1448 $smsParams,
e8cb3963
DS
1449 $activityID,
1450 $userID
c5a6413b
DS
1451 );
1452
1453 if (PEAR::isError($sendResult)) {
1454 // Collect all of the PEAR_Error objects
1455 $errMsgs[] = $sendResult;
1456 } else {
f53ea1ce 1457 $success++;
6a488035
TO
1458 }
1459 }
1460
c5a6413b
DS
1461 // If at least one message was sent and no errors
1462 // were generated then return a boolean value of TRUE.
1463 // Otherwise, return FALSE (no messages sent) or
1464 // and array of 1 or more PEAR_Error objects.
1465 $sent = FALSE;
1466 if ($success > 0 && count($errMsgs) == 0) {
1467 $sent = TRUE;
1468 } elseif (count($errMsgs) > 0) {
1469 $sent = $errMsgs;
1470 }
1471
f53ea1ce 1472 return array($sent, $activity->id, $success);
6a488035
TO
1473 }
1474
1475 /**
1476 * send the sms message to a specific contact
1477 *
1478 * @param int $toID the contact id of the recipient
1479 * @param int $activityID the activity ID that tracks the message
1480 * @param array $smsParams the params used for sending sms
1481 *
c5a6413b 1482 * @return mixed true on success or PEAR_Error object
6a488035
TO
1483 * @access public
1484 * @static
1485 */
1486 static function sendSMSMessage($toID,
1487 &$tokenText,
1488 &$tokenHtml,
1489 $smsParams = array(),
e8cb3963
DS
1490 $activityID,
1491 $userID = null
6a488035
TO
1492 ) {
1493 $toDoNotSms = "";
1494 $toPhoneNumber = "";
1495
1496 if ($smsParams['To']) {
1497 $toPhoneNumber = trim($smsParams['To']);
1498 }
1499 elseif ($toID) {
1500 $filters = array('is_deceased' => 0, 'is_deleted' => 0, 'do_not_sms' => 0);
1501 $toPhoneNumbers = CRM_Core_BAO_Phone::allPhones($toID, FALSE, 'Mobile', $filters);
1502 //to get primary mobile ph,if not get a first mobile ph
1503 if (!empty($toPhoneNumbers)) {
1504 $toPhoneNumerDetails = reset($toPhoneNumbers);
1505 $toPhoneNumber = CRM_Utils_Array::value('phone', $toPhoneNumerDetails);
1506 //contact allows to send sms
1507 $toDoNotSms = 0;
1508 }
1509 }
1510
1511 // make sure both phone are valid
1512 // and that the recipient wants to receive sms
1513 if (empty($toPhoneNumber) or $toDoNotSms) {
c5a6413b
DS
1514 return PEAR::raiseError(
1515 'Recipient phone number is invalid or recipient does not want to receive SMS',
1516 null,
1517 PEAR_ERROR_RETURN
1518 );
6a488035
TO
1519 }
1520
1521 $message = $tokenHtml ? $tokenHtml : $tokenText;
1522 $recipient = $smsParams['To'];
1523 $smsParams['contact_id'] = $toID;
1524 $smsParams['parent_activity_id'] = $activityID;
1525
1526 $providerObj = CRM_SMS_Provider::singleton(array('provider_id' => $smsParams['provider_id']));
e8cb3963 1527 $sendResult = $providerObj->send($recipient, $smsParams, $message, NULL, $userID);
c5a6413b
DS
1528 if (PEAR::isError($sendResult)) {
1529 return $sendResult;
6a488035
TO
1530 }
1531
e7e657f0 1532 $activityContacts = CRM_Core_OptionGroup::values('activity_contacts', FALSE, FALSE, FALSE, NULL, 'name');
a24b3694 1533 $targetID = CRM_Utils_Array::key('Activity Targets', $activityContacts);
b319d00a 1534
a24b3694 1535
6a488035
TO
1536 // add activity target record for every sms that is send
1537 $activityTargetParams = array(
1538 'activity_id' => $activityID,
1d85d241 1539 'contact_id' => $toID,
a24b3694 1540 'record_type_id' => $targetID
6a488035 1541 );
1d85d241 1542 CRM_Activity_BAO_ActivityContact::create($activityTargetParams);
6a488035
TO
1543
1544 return TRUE;
1545 }
1546
1547 /**
1548 * send the message to a specific contact
1549 *
1550 * @param string $from the name and email of the sender
1551 * @param int $toID the contact id of the recipient
1552 * @param string $subject the subject of the message
1553 * @param string $message the message contents
1554 * @param string $emailAddress use this 'to' email address instead of the default Primary address
1555 * @param int $activityID the activity ID that tracks the message
1556 *
1557 * @return boolean true if successfull else false.
1558 * @access public
1559 * @static
1560 */
1561 static function sendMessage($from,
1562 $fromID,
1563 $toID,
1564 &$subject,
1565 &$text_message,
1566 &$html_message,
1567 $emailAddress,
1568 $activityID,
1569 $attachments = NULL,
1570 $cc = NULL,
1571 $bcc = NULL
1572 ) {
1573 list($toDisplayName, $toEmail, $toDoNotEmail) = CRM_Contact_BAO_Contact::getContactDetails($toID);
1574 if ($emailAddress) {
1575 $toEmail = trim($emailAddress);
1576 }
1577
1578 // make sure both email addresses are valid
1579 // and that the recipient wants to receive email
1580 if (empty($toEmail) or $toDoNotEmail) {
1581 return FALSE;
1582 }
1583 if (!trim($toDisplayName)) {
1584 $toDisplayName = $toEmail;
1585 }
1586
e7e657f0 1587 $activityContacts = CRM_Core_OptionGroup::values('activity_contacts', FALSE, FALSE, FALSE, NULL, 'name');
a24b3694 1588 //$sourceID = CRM_Utils_Array::key('Activity Source', $activityContacts);
1589 //$assigneeID = CRM_Utils_Array::key('Activity Assignees', $activityContacts);
1590 $targetID = CRM_Utils_Array::key('Activity Targets', $activityContacts);
1591
6a488035
TO
1592 // create the params array
1593 $mailParams = array(
1594 'groupName' => 'Activity Email Sender',
1595 'from' => $from,
1596 'toName' => $toDisplayName,
1597 'toEmail' => $toEmail,
1598 'subject' => $subject,
1599 'cc' => $cc,
1600 'bcc' => $bcc,
1601 'text' => $text_message,
1602 'html' => $html_message,
1603 'attachments' => $attachments,
1604 );
1605
1606 if (!CRM_Utils_Mail::send($mailParams)) {
1607 return FALSE;
1608 }
1609
1610 // add activity target record for every mail that is send
1611 $activityTargetParams = array(
1612 'activity_id' => $activityID,
1d85d241 1613 'contact_id' => $toID,
b319d00a 1614 'record_type_id' => $targetID
6a488035 1615 );
1d85d241 1616 CRM_Activity_BAO_ActivityContact::create($activityTargetParams);
6a488035
TO
1617 return TRUE;
1618 }
1619
1620 /**
1621 * combine all the importable fields from the lower levels object
1622 *
1623 * The ordering is important, since currently we do not have a weight
1624 * scheme. Adding weight is super important and should be done in the
1625 * next week or so, before this can be called complete.
1626 *
1627 * @param NULL
1628 *
1629 * @return array array of importable Fields
1630 * @access public
1631 * @static
1632 */
1633 static function &importableFields($status = FALSE) {
1634 if (!self::$_importableFields) {
1635 if (!self::$_importableFields) {
1636 self::$_importableFields = array();
1637 }
1638 if (!$status) {
1639 $fields = array('' => array('title' => ts('- do not import -')));
1640 }
1641 else {
1642 $fields = array('' => array('title' => ts('- Activity Fields -')));
1643 }
1644
1645 $tmpFields = CRM_Activity_DAO_Activity::import();
1646 $contactFields = CRM_Contact_BAO_Contact::importableFields('Individual', NULL);
1647
1648 // Using new Dedupe rule.
1649 $ruleParams = array(
1650 'contact_type' => 'Individual',
1651 'used' => 'Unsupervised',
1652 );
1653 $fieldsArray = CRM_Dedupe_BAO_Rule::dedupeRuleFields($ruleParams);
1654
1655 $tmpConatctField = array();
1656 if (is_array($fieldsArray)) {
1657 foreach ($fieldsArray as $value) {
1658 $customFieldId = CRM_Core_DAO::getFieldValue('CRM_Core_DAO_CustomField',
1659 $value,
1660 'id',
1661 'column_name'
1662 );
1663 $value = $customFieldId ? 'custom_' . $customFieldId : $value;
1664 $tmpConatctField[trim($value)] = $contactFields[trim($value)];
1665 $tmpConatctField[trim($value)]['title'] = $tmpConatctField[trim($value)]['title'] . " (match to contact)";
1666 }
1667 }
1668 $tmpConatctField['external_identifier'] = $contactFields['external_identifier'];
1669 $tmpConatctField['external_identifier']['title'] = $contactFields['external_identifier']['title'] . " (match to contact)";
1670 $fields = array_merge($fields, $tmpConatctField);
1671 $fields = array_merge($fields, $tmpFields);
1672 $fields = array_merge($fields, CRM_Core_BAO_CustomField::getFieldsForImport('Activity'));
1673 self::$_importableFields = $fields;
1674 }
1675 return self::$_importableFields;
1676 }
1677
1678 /**
1679 * To get the Activities of a target contact
1680 *
1681 * @param $contactId Integer ContactId of the contact whose activities
1682 * need to find
1683 *
1684 * @return array array of activity fields
1685 * @access public
1686 */
1687 static function getContactActivity($contactId) {
1688 $activities = array();
e7e657f0 1689 $activityContacts = CRM_Core_OptionGroup::values('activity_contacts', FALSE, FALSE, FALSE, NULL, 'name');
a24b3694 1690 $sourceID = CRM_Utils_Array::key('Activity Source', $activityContacts);
1691 $assigneeID = CRM_Utils_Array::key('Activity Assignees', $activityContacts);
1692 $targetID = CRM_Utils_Array::key('Activity Targets', $activityContacts);
b319d00a 1693
6a488035
TO
1694
1695 // First look for activities where contactId is one of the targets
91da6cd5 1696 $query = "
a24b3694 1697SELECT activity_id, record_type_id
91da6cd5
DL
1698FROM civicrm_activity_contact
1699WHERE contact_id = $contactId
1700";
1701 $dao = CRM_Core_DAO::executeQuery($query);
6a488035 1702 while ($dao->fetch()) {
a24b3694 1703 if ($dao->record_type_id == $targetID ) {
91da6cd5
DL
1704 $activities[$dao->activity_id]['targets'][$contactId] = $contactId;
1705 }
a24b3694 1706 else if ($dao->record_type_id == $assigneeID) {
91da6cd5
DL
1707 $activities[$dao->activity_id]['asignees'][$contactId] = $contactId;
1708 }
1709 else {
1710 // do source stuff here
42d30b83 1711 $activities[$dao->activity_id]['source_contact_id'] = $contactId;
91da6cd5 1712 }
6a488035
TO
1713 }
1714
91da6cd5 1715 $activityIds = array_keys($activities);
6a488035
TO
1716 if (count($activityIds) < 1) {
1717 return array();
1718 }
91da6cd5 1719
6a488035 1720 $activityIds = implode(',', $activityIds);
91da6cd5
DL
1721 $query = "
1722SELECT activity.id as activity_id,
1723 activity_type_id,
1724 subject, location, activity_date_time, details, status_id
1725FROM civicrm_activity activity
1726WHERE activity.id IN ($activityIds)";
6a488035 1727
91da6cd5 1728 $dao = CRM_Core_DAO::executeQuery($query);
6a488035
TO
1729
1730 $activityTypes = CRM_Core_OptionGroup::values('activity_type');
1731 $activityStatuses = CRM_Core_OptionGroup::values('activity_status');
1732
1733 while ($dao->fetch()) {
6a488035 1734 $activities[$dao->activity_id]['id'] = $dao->activity_id;
6a488035
TO
1735 $activities[$dao->activity_id]['activity_type_id'] = $dao->activity_type_id;
1736 $activities[$dao->activity_id]['subject'] = $dao->subject;
1737 $activities[$dao->activity_id]['location'] = $dao->location;
1738 $activities[$dao->activity_id]['activity_date_time'] = $dao->activity_date_time;
1739 $activities[$dao->activity_id]['details'] = $dao->details;
1740 $activities[$dao->activity_id]['status_id'] = $dao->status_id;
1741 $activities[$dao->activity_id]['activity_name'] = $activityTypes[$dao->activity_type_id];
1742 $activities[$dao->activity_id]['status'] = $activityStatuses[$dao->status_id];
42d30b83
DL
1743
1744 // set to null if not set
1745 if (!isset($activities[$dao->activity_id]['source_contact_id'])) {
1746 $activities[$dao->activity_id]['source_contact_id'] = NULL;
1747 }
6a488035
TO
1748 }
1749 return $activities;
1750 }
1751
1752 /**
1753 * Function to add activity for Membership/Event/Contribution
1754 *
0a9f61c4 1755 * @param object $activity (reference) particular component object
6a488035
TO
1756 * @param string $activityType for Membership Signup or Renewal
1757 *
1758 *
1759 * @static
1760 * @access public
1761 */
1762 static function addActivity(&$activity,
1763 $activityType = 'Membership Signup',
1764 $targetContactID = NULL
1765 ) {
1766 if ($activity->__table == 'civicrm_membership') {
1767 $membershipType = CRM_Member_PseudoConstant::membershipType($activity->membership_type_id);
1768
1769 if (!$membershipType) {
1770 $membershipType = ts('Membership');
1771 }
1772
1773 $subject = "{$membershipType}";
1774
1775 if (!empty($activity->source) && $activity->source != 'null') {
1776 $subject .= " - {$activity->source}";
1777 }
1778
1779 if ($activity->owner_membership_id) {
1780 $query = "
1781SELECT display_name
1782 FROM civicrm_contact, civicrm_membership
1783 WHERE civicrm_contact.id = civicrm_membership.contact_id
1784 AND civicrm_membership.id = $activity->owner_membership_id
1785";
1786 $displayName = CRM_Core_DAO::singleValueQuery($query);
1787 $subject .= " (by {$displayName})";
1788 }
1789
1790 $subject .= " - Status: " . CRM_Core_DAO::getFieldValue('CRM_Member_DAO_MembershipStatus', $activity->status_id);
1791 // CRM-72097 changed from start date to today
1792 $date = date('YmdHis');
1793 $component = 'Membership';
1794 }
1795 elseif ($activity->__table == 'civicrm_participant') {
c2be40dc 1796 $event = CRM_Event_BAO_Event::getEvents(1, $activity->event_id, TRUE, FALSE);
6a488035
TO
1797
1798 $roles = CRM_Event_PseudoConstant::participantRole();
1799 $status = CRM_Event_PseudoConstant::participantStatus();
1800
1801 $subject = $event[$activity->event_id];
1802 if (CRM_Utils_Array::value($activity->role_id, $roles)) {
1803 $subject .= ' - ' . $roles[$activity->role_id];
1804 }
1805 if (CRM_Utils_Array::value($activity->status_id, $status)) {
1806 $subject .= ' - ' . $status[$activity->status_id];
1807 }
1808 $date = date('YmdHis');
1809 if ($activityType != 'Email') {
1810 $activityType = 'Event Registration';
1811 }
1812 $component = 'Event';
1813 }
1814 elseif ($activity->__table == 'civicrm_contribution') {
1815 //create activity record only for Completed Contributions
1816 if ($activity->contribution_status_id != 1) {
1817 return;
1818 }
1819
1820 $subject = NULL;
1821
1822 $subject .= CRM_Utils_Money::format($activity->total_amount, $activity->currency);
1823 if (!empty($activity->source) && $activity->source != 'null') {
1824 $subject .= " - {$activity->source}";
1825 }
1826 $date = CRM_Utils_Date::isoToMysql($activity->receive_date);
1827 $activityType = $component = 'Contribution';
1828 }
1829 $activityParams = array(
1830 'source_contact_id' => $activity->contact_id,
1831 'source_record_id' => $activity->id,
1832 'activity_type_id' => CRM_Core_OptionGroup::getValue('activity_type',
1833 $activityType,
1834 'name'
1835 ),
1836 'subject' => $subject,
1837 'activity_date_time' => $date,
1838 'is_test' => $activity->is_test,
1839 'status_id' => CRM_Core_OptionGroup::getValue('activity_status',
1840 'Completed',
1841 'name'
1842 ),
1843 'skipRecentView' => TRUE,
1844 'campaign_id' => $activity->campaign_id,
1845 );
1846
1847 // create activity with target contacts
1848 $session = CRM_Core_Session::singleton();
1849 $id = $session->get('userID');
1850 if ($id) {
1851 $activityParams['source_contact_id'] = $id;
1852 $activityParams['target_contact_id'][] = $activity->contact_id;
1853 }
1854
1855 //CRM-4027
1856 if ($targetContactID) {
1857 $activityParams['target_contact_id'][] = $targetContactID;
1858 }
1859 if (is_a(self::create($activityParams), 'CRM_Core_Error')) {
1860 CRM_Core_Error::fatal("Failed creating Activity for $component of id {$activity->id}");
1861 return FALSE;
1862 }
1863 }
1864
1865 /**
0a9f61c4 1866 * Function to get Parent activity for currently viewed activity
6a488035
TO
1867 *
1868 * @param int $activityId current activity id
1869 *
0a9f61c4 1870 * @return int $parentId Id of parent activity otherwise false.
6a488035
TO
1871 * @access public
1872 */
1873 static function getParentActivity($activityId) {
1874 static $parentActivities = array();
1875
1876 $activityId = CRM_Utils_Type::escape($activityId, 'Integer');
1877
1878 if (!array_key_exists($activityId, $parentActivities)) {
1879 $parentActivities[$activityId] = array();
1880
1881 $parentId = CRM_Core_DAO::getFieldValue('CRM_Activity_DAO_Activity',
1882 $activityId,
1883 'parent_id'
1884 );
1885
1886 $parentActivities[$activityId] = $parentId ? $parentId : FALSE;
1887 }
1888
1889 return $parentActivities[$activityId];
1890 }
1891
1892 /**
1893 * Function to get total count of prior revision of currently viewd activity
1894 *
1895 * @param int $activityId current activity id
1896 *
0a9f61c4 1897 * @return int $params count of prior activities otherwise false.
6a488035
TO
1898 * @access public
1899 */
1900 static function getPriorCount($activityID) {
1901 static $priorCounts = array();
1902
1903 $activityID = CRM_Utils_Type::escape($activityID, 'Integer');
1904
1905 if (!array_key_exists($activityID, $priorCounts)) {
1906 $priorCounts[$activityID] = array();
1907 $originalID = CRM_Core_DAO::getFieldValue('CRM_Activity_DAO_Activity',
1908 $activityID,
1909 'original_id'
1910 );
1911 $count = 0;
1912 if ($originalID) {
1913 $query = "
1914SELECT count( id ) AS cnt
1915FROM civicrm_activity
1916WHERE ( id = {$originalID} OR original_id = {$originalID} )
1917AND is_current_revision = 0
1918AND id < {$activityID}
1919";
1920 $params = array(1 => array($originalID, 'Integer'));
1921 $count = CRM_Core_DAO::singleValueQuery($query, $params);
1922 }
1923 $priorCounts[$activityID] = $count ? $count : 0;
1924 }
1925
1926 return $priorCounts[$activityID];
1927 }
1928
1929 /**
0a9f61c4 1930 * Function to get all prior activities of currently viewe
1931 * d activity
6a488035
TO
1932 *
1933 * @param int $activityId current activity id
1934 *
0a9f61c4 1935 * @return array $result prior activities info.
6a488035
TO
1936 * @access public
1937 */
1938 static function getPriorAcitivities($activityID, $onlyPriorRevisions = FALSE) {
1939 static $priorActivities = array();
1940
1941 $activityID = CRM_Utils_Type::escape($activityID, 'Integer');
1942 $index = $activityID . '_' . (int) $onlyPriorRevisions;
1943
1944 if (!array_key_exists($index, $priorActivities)) {
1945 $priorActivities[$index] = array();
1946
1947 $originalID = CRM_Core_DAO::getFieldValue('CRM_Activity_DAO_Activity',
1948 $activityID,
1949 'original_id'
1950 );
1951 if ($originalID) {
1952 $query = "
1953SELECT c.display_name as name, cl.modified_date as date, ca.id as activityID
1954FROM civicrm_log cl, civicrm_contact c, civicrm_activity ca
1955WHERE (ca.id = %1 OR ca.original_id = %1)
1956AND cl.entity_table = 'civicrm_activity'
1957AND cl.entity_id = ca.id
1958AND cl.modified_id = c.id
1959";
1960 if ($onlyPriorRevisions) {
1961 $query .= " AND ca.id < {$activityID}";
1962 }
1963 $query .= " ORDER BY ca.id DESC";
1964
1965 $params = array(1 => array($originalID, 'Integer'));
1966 $dao = CRM_Core_DAO::executeQuery($query, $params);
1967
1968 while ($dao->fetch()) {
1969 $priorActivities[$index][$dao->activityID]['id'] = $dao->activityID;
1970 $priorActivities[$index][$dao->activityID]['name'] = $dao->name;
1971 $priorActivities[$index][$dao->activityID]['date'] = $dao->date;
1972 $priorActivities[$index][$dao->activityID]['link'] = 'javascript:viewActivity( $dao->activityID );';
1973 }
1974 $dao->free();
1975 }
1976 }
1977 return $priorActivities[$index];
1978 }
1979
1980 /**
1981 * Function to find the latest revision of a given activity
1982 *
1983 * @param int $activityId prior activity id
1984 *
1985 * @return int $params current activity id.
1986 * @access public
1987 */
1988 static function getLatestActivityId($activityID) {
1989 static $latestActivityIds = array();
1990
1991 $activityID = CRM_Utils_Type::escape($activityID, 'Integer');
1992
1993 if (!array_key_exists($activityID, $latestActivityIds)) {
1994 $latestActivityIds[$activityID] = array();
1995
1996 $originalID = CRM_Core_DAO::getFieldValue('CRM_Activity_DAO_Activity',
1997 $activityID,
1998 'original_id'
1999 );
2000 if ($originalID) {
2001 $activityID = $originalID;
2002 }
2003 $params = array(1 => array($activityID, 'Integer'));
2004 $query = "SELECT id from civicrm_activity where original_id = %1 and is_current_revision = 1";
2005
2006 $latestActivityIds[$activityID] = CRM_Core_DAO::singleValueQuery($query, $params);
2007 }
2008
2009 return $latestActivityIds[$activityID];
2010 }
2011
2012 /**
2013 * Function to create a follow up a given activity
2014 *
2015 * @activityId int activity id of parent activity
2016 *
2017 * @param array $activity details
2018 *
2019 * @access public
2020 */
2021 static function createFollowupActivity($activityId, $params) {
2022 if (!$activityId) {
2023 return;
2024 }
2025
2026 $session = CRM_Core_Session::singleton();
2027
2028 $followupParams = array();
2029 $followupParams['parent_id'] = $activityId;
2030 $followupParams['source_contact_id'] = $session->get('userID');
2031 $followupParams['status_id'] = CRM_Core_OptionGroup::getValue('activity_status', 'Scheduled', 'name');
2032
2033 $followupParams['activity_type_id'] = $params['followup_activity_type_id'];
2034 // Get Subject of Follow-up Activiity, CRM-4491
2035 $followupParams['subject'] = CRM_Utils_Array::value('followup_activity_subject', $params);
2036
2037 //create target contact for followup
2038 if (CRM_Utils_Array::value('target_contact_id', $params)) {
2039 $followupParams['target_contact_id'] = $params['target_contact_id'];
2040 }
2041
2042 $followupParams['activity_date_time'] = CRM_Utils_Date::processDate($params['followup_date'],
2043 $params['followup_date_time']
2044 );
2045 $followupActivity = self::create($followupParams);
2046
2047 return $followupActivity;
2048 }
2049
2050 /**
2051 * Function to get Activity specific File according activity type Id.
2052 *
2053 * @param int $activityTypeId activity id
2054 *
2055 * @return if file exists returns $activityTypeFile activity filename otherwise false.
2056 *
2057 * @static
2058 */
2059 static function getFileForActivityTypeId($activityTypeId, $crmDir = 'Activity') {
2060 $activityTypes = CRM_Case_PseudoConstant::caseActivityType(FALSE, TRUE);
2061
2062 if ($activityTypes[$activityTypeId]['name']) {
2063 $activityTypeFile = CRM_Utils_String::munge(ucwords($activityTypes[$activityTypeId]['name']), '', 0);
2064 }
2065 else {
2066 return FALSE;
2067 }
2068
2069 global $civicrm_root;
2070 $config = CRM_Core_Config::singleton();
2071 if (!file_exists(rtrim($civicrm_root, '/') . "/CRM/{$crmDir}/Form/Activity/{$activityTypeFile}.php")) {
2072 if (empty($config->customPHPPathDir)) {
2073 return FALSE;
2074 }
2075 elseif (!file_exists(rtrim($config->customPHPPathDir, '/') . "/CRM/{$crmDir}/Form/Activity/{$activityTypeFile}.php")) {
2076 return FALSE;
2077 }
2078 }
2079
2080 return $activityTypeFile;
2081 }
2082
2083 /**
2084 * Function to restore the activity
2085 *
2086 * @param array $params associated array
2087 *
2088 * @return void
2089 * @access public
2090 *
2091 */
2092 public static function restoreActivity(&$params) {
2093 $activity = new CRM_Activity_DAO_Activity();
2094 $activity->copyValues($params);
2095
2096 $activity->is_deleted = 0;
2097 $result = $activity->save();
2098
2099 return $result;
2100 }
2101
2102 /**
2103 * Get the exportable fields for Activities
2104 *
2105 * @param string $name if it is called by case $name = Case else $name = Activity
2106 *
2107 * @return array array of exportable Fields
2108 * @access public
2109 * @static
2110 */
2111 static function &exportableFields($name = 'Activity') {
2112 if (!isset(self::$_exportableFields[$name])) {
2113 self::$_exportableFields[$name] = array();
2114
2115 // TO DO, ideally we should retrieve all fields from xml, in this case since activity processing is done
2116 // my case hence we have defined fields as case_*
2117 if ($name == 'Activity') {
2118 $exportableFields = CRM_Activity_DAO_Activity::export();
6a488035
TO
2119 $exportableFields['source_contact_id']['title'] = ts('Source Contact ID');
2120 $exportableFields['source_contact'] = array(
2121 'title' => ts('Source Contact'),
2122 'type' => CRM_Utils_Type::T_STRING,
2123 );
2124
2125
2126 $Activityfields = array(
2127 'activity_type' => array('title' => ts('Activity Type'), 'type' => CRM_Utils_Type::T_STRING),
2128 'activity_status' => array('title' => ts('Activity Status'), 'type' => CRM_Utils_Type::T_STRING),
2129 );
2130 $fields = array_merge($Activityfields, $exportableFields);
2131 }
2132 else {
2133 //set title to activity fields
2134 $fields = array(
2135 'case_activity_subject' => array('title' => ts('Activity Subject'), 'type' => CRM_Utils_Type::T_STRING),
2136 'case_source_contact_id' => array('title' => ts('Activity Reporter'), 'type' => CRM_Utils_Type::T_STRING),
2137 'case_recent_activity_date' => array('title' => ts('Activity Actual Date'), 'type' => CRM_Utils_Type::T_DATE),
2138 'case_scheduled_activity_date' => array('title' => ts('Activity Scheduled Date'), 'type' => CRM_Utils_Type::T_DATE),
2139 'case_recent_activity_type' => array('title' => ts('Activity Type'), 'type' => CRM_Utils_Type::T_STRING),
2140 'case_activity_status' => array('title' => ts('Activity Status'), 'type' => CRM_Utils_Type::T_STRING),
2141 'case_activity_duration' => array('title' => ts('Activity Duration'), 'type' => CRM_Utils_Type::T_INT),
2142 'case_activity_medium_id' => array('title' => ts('Activity Medium'), 'type' => CRM_Utils_Type::T_INT),
2143 'case_activity_details' => array('title' => ts('Activity Details'), 'type' => CRM_Utils_Type::T_TEXT),
2144 'case_activity_is_auto' => array('title' => ts('Activity Auto-generated?'), 'type' => CRM_Utils_Type::T_BOOLEAN),
2145 );
2146
2147 // add custom data for cases
2148 $fields = array_merge($fields, CRM_Core_BAO_CustomField::getFieldsForImport('Case'));
2149 }
2150
2151 // add custom data for case activities
2152 $fields = array_merge($fields, CRM_Core_BAO_CustomField::getFieldsForImport('Activity'));
2153
2154 self::$_exportableFields[$name] = $fields;
2155 }
2156 return self::$_exportableFields[$name];
2157 }
2158
2159 /**
2160 * Get the allowed profile fields for Activities
2161 *
2162 * @return array array of activity profile Fields
2163 * @access public
2164 */
2165 static function getProfileFields() {
2166 $exportableFields = self::exportableFields('Activity');
4f79a2f5 2167 $skipFields = array(
2168 'activity_id',
2169 'activity_type',
2170 'source_contact_id',
2171 'source_contact',
2172 'activity_campaign',
2173 'activity_is_test',
2174 'is_current_revision',
2175 'activity_is_deleted',
2176 );
6a488035
TO
2177 $config = CRM_Core_Config::singleton();
2178 if (!in_array('CiviCampaign', $config->enableComponents)) {
2179 $skipFields[] = 'activity_engagement_level';
2180 }
2181
2182 foreach ($skipFields as $field) {
2183 if (isset($exportableFields[$field])) {
2184 unset($exportableFields[$field]);
2185 }
2186 }
2187
2188 // hack to use 'activity_type_id' instead of 'activity_type'
2189 $exportableFields['activity_status_id'] = $exportableFields['activity_status'];
2190 unset($exportableFields['activity_status']);
2191
2192 return $exportableFields;
2193 }
2194
2195 /**
f1504541 2196 * This function deletes the activity record related to contact record,
6a488035
TO
2197 * when there are no target and assignee record w/ other contact.
2198 *
2199 * @param int $contactId contactId
2200 *
2201 * @return true/null
2202 * @access public
2203 */
2204 public static function cleanupActivity($contactId) {
2205 $result = NULL;
2206 if (!$contactId) {
2207 return $result;
2208 }
e7e657f0 2209 $activityContacts = CRM_Core_OptionGroup::values('activity_contacts', FALSE, FALSE, FALSE, NULL, 'name');
2bf96211 2210 $sourceID = CRM_Utils_Array::key('Activity Source', $activityContacts);
6a488035
TO
2211
2212 $transaction = new CRM_Core_Transaction();
2213
f1504541
DL
2214 // delete activity if there is no record in civicrm_activity_contact
2215 // pointing to any other contact record
2bf96211 2216 $activityContact = new CRM_Activity_DAO_ActivityContact();
2217 $activityContact->contact_id = $contactId;
2218 $activityContact->record_type_id = $sourceID;
2219 $activityContact->find();
6a488035 2220
2bf96211 2221 while ($activityContact->fetch()) {
f1504541 2222 // delete activity_contact record for the deleted contact
32ecf7bb
BS
2223 $activityContact->delete();
2224
2225 $activityContactOther = new CRM_Activity_DAO_ActivityContact();
2226 $activityContactOther->activity_id = $activityContact->activity_id;
32ecf7bb 2227
83e0a89c 2228 // delete activity only if no other contacts connected
f1504541 2229 if ( ! $activityContactOther->find(TRUE) ) {
32ecf7bb
BS
2230 $activityParams = array('id' => $activityContact->activity_id);
2231 $result = self::deleteActivity($activityParams);
2232 }
2233
2234 $activityContactOther->free();
6a488035 2235 }
6a488035 2236
2bf96211 2237 $activityContact->free();
6a488035
TO
2238 $transaction->commit();
2239
2240 return $result;
2241 }
2242
2243 /**
2244 * Does user has sufficient permission for view/edit activity record.
2245 *
2246 * @param int $activityId activity record id.
2247 * @param int $action edit/view
2248 *
2249 * @return boolean $allow true/false
2250 * @access public
2251 */
2252 public static function checkPermission($activityId, $action) {
2253 $allow = FALSE;
2254 if (!$activityId ||
2255 !in_array($action, array(CRM_Core_Action::UPDATE, CRM_Core_Action::VIEW))
2256 ) {
2257 return $allow;
2258 }
2259
2260 $activity = new CRM_Activity_DAO_Activity();
2261 $activity->id = $activityId;
2262 if (!$activity->find(TRUE)) {
2263 return $allow;
2264 }
2265
2266 //component related permissions.
2267 $compPermissions = array(
2268 'CiviCase' => array('administer CiviCase',
2269 'access my cases and activities',
2270 'access all cases and activities',
2271 ),
2272 'CiviMail' => array('access CiviMail'),
2273 'CiviEvent' => array('access CiviEvent'),
2274 'CiviGrant' => array('access CiviGrant'),
2275 'CiviPledge' => array('access CiviPledge'),
2276 'CiviMember' => array('access CiviMember'),
2277 'CiviReport' => array('access CiviReport'),
2278 'CiviContribute' => array('access CiviContribute'),
2279 'CiviCampaign' => array('administer CiviCampaign'),
2280 );
2281
2282 //return early when it is case activity.
2283 $isCaseActivity = CRM_Case_BAO_Case::isCaseActivity($activityId);
2284 //check for civicase related permission.
2285 if ($isCaseActivity) {
2286 $allow = FALSE;
2287 foreach ($compPermissions['CiviCase'] as $per) {
2288 if (CRM_Core_Permission::check($per)) {
2289 $allow = TRUE;
2290 break;
2291 }
2292 }
2293
2294 //check for case specific permissions.
2295 if ($allow) {
2296 $oper = 'view';
2297 if ($action == CRM_Core_Action::UPDATE) {
2298 $oper = 'edit';
2299 }
2300 $allow = CRM_Case_BAO_Case::checkPermission($activityId,
2301 $oper,
2302 $activity->activity_type_id
2303 );
2304 }
2305
2306 return $allow;
2307 }
2308
6a488035
TO
2309 //first check the component permission.
2310 $sql = "
2311 SELECT component_id
2312 FROM civicrm_option_value val
2313INNER JOIN civicrm_option_group grp ON ( grp.id = val.option_group_id AND grp.name = %1 )
2314 WHERE val.value = %2";
2315 $params = array(1 => array('activity_type', 'String'),
2316 2 => array($activity->activity_type_id, 'Integer'),
2317 );
2318 $componentId = CRM_Core_DAO::singleValueQuery($sql, $params);
2319
2320 if ($componentId) {
2321 $componentName = CRM_Core_Component::getComponentName($componentId);
2322 $compPermission = CRM_Utils_Array::value($componentName, $compPermissions);
2323
2324 //here we are interesting in any single permission.
2325 if (is_array($compPermission)) {
2326 foreach ($compPermission as $per) {
2327 if (CRM_Core_Permission::check($per)) {
2328 $allow = TRUE;
2329 break;
2330 }
2331 }
2332 }
2333 }
2334
2335 //check for this permission related to contact.
2336 $permission = CRM_Core_Permission::VIEW;
2337 if ($action == CRM_Core_Action::UPDATE) {
2338 $permission = CRM_Core_Permission::EDIT;
2339 }
2340
e7e657f0 2341 $activityContacts = CRM_Core_OptionGroup::values('activity_contacts', FALSE, FALSE, FALSE, NULL, 'name');
034500d4 2342 $sourceID = CRM_Utils_Array::key('Activity Source', $activityContacts);
2343 $assigneeID = CRM_Utils_Array::key('Activity Assignees', $activityContacts);
2344 $targetID = CRM_Utils_Array::key('Activity Targets', $activityContacts);
2345
6a488035
TO
2346 //check for source contact.
2347 if (!$componentId || $allow) {
65ebc887 2348 $sourceContactId = self::getActivityContact($activity->id, $sourceID);
32ecf7bb
BS
2349 //account for possibility of activity not having a source contact (as it may have been deleted)
2350 if ( $sourceContactId ) {
2351 $allow = CRM_Contact_BAO_Contact_Permission::allow($sourceContactId, $permission);
2352 }
6a488035
TO
2353 }
2354
2355 //check for target and assignee contacts.
2356 if ($allow) {
2357 //first check for supper permission.
2358 $supPermission = 'view all contacts';
2359 if ($action == CRM_Core_Action::UPDATE) {
2360 $supPermission = 'edit all contacts';
2361 }
2362 $allow = CRM_Core_Permission::check($supPermission);
2363
2364 //user might have sufficient permission, through acls.
2365 if (!$allow) {
2366 $allow = TRUE;
2367 //get the target contacts.
034500d4 2368 $targetContacts = CRM_Activity_BAO_ActivityContact::retrieveContactIdsByActivityId($activity->id, $targetID);
6a488035
TO
2369 foreach ($targetContacts as $cnt => $contactId) {
2370 if (!CRM_Contact_BAO_Contact_Permission::allow($contactId, $permission)) {
2371 $allow = FALSE;
2372 break;
2373 }
2374 }
2375
2376 //get the assignee contacts.
2377 if ($allow) {
d7f083ac 2378 $assigneeContacts = CRM_Activity_BAO_ActivityContact::retrieveContactIdsByActivityId($activity->id, $assigneeID);
6a488035
TO
2379 foreach ($assigneeContacts as $cnt => $contactId) {
2380 if (!CRM_Contact_BAO_Contact_Permission::allow($contactId, $permission)) {
2381 $allow = FALSE;
2382 break;
2383 }
2384 }
2385 }
2386 }
2387 }
2388
2389 return $allow;
2390 }
2391
2392 /**
2393 * This function is a wrapper for ajax activity selector
2394 *
2395 * @param array $params associated array for params record id.
2396 *
2397 * @return array $contactActivities associated array of contact activities
2398 * @access public
2399 */
2400 public static function getContactActivitySelector(&$params) {
2401 // format the params
2402 $params['offset'] = ($params['page'] - 1) * $params['rp'];
2403 $params['rowCount'] = $params['rp'];
2404 $params['sort'] = CRM_Utils_Array::value('sortBy', $params);
2405 $params['caseId'] = NULL;
2406 $context = CRM_Utils_Array::value('context', $params);
2407
2408 // get contact activities
2409 $activities = CRM_Activity_BAO_Activity::getActivities($params);
2410
2411 // add total
2412 $params['total'] = CRM_Activity_BAO_Activity::getActivitiesCount($params);
2413
2414 // format params and add links
2415 $contactActivities = array();
2416
2417 if (!empty($activities)) {
2418 $activityStatus = CRM_Core_PseudoConstant::activityStatus();
2419
2420 // check logged in user for permission
2421 $page = new CRM_Core_Page();
2422 CRM_Contact_Page_View::checkUserPermission($page, $params['contact_id']);
2423 $permissions = array($page->_permission);
2424 if (CRM_Core_Permission::check('delete activities')) {
2425 $permissions[] = CRM_Core_Permission::DELETE;
2426 }
2427
2428 $mask = CRM_Core_Action::mask($permissions);
2429
2430 foreach ($activities as $activityId => $values) {
2431 $contactActivities[$activityId]['activity_type'] = $values['activity_type'];
2432 $contactActivities[$activityId]['subject'] = $values['subject'];
2433 if ($params['contact_id'] == $values['source_contact_id']) {
2434 $contactActivities[$activityId]['source_contact'] = $values['source_contact_name'];
2435 }
2436 elseif ($values['source_contact_id']) {
5a99d240
KJ
2437 $contactActivities[$activityId]['source_contact'] = CRM_Utils_System::href($values['source_contact_name'],
2438 'civicrm/contact/view', "reset=1&cid={$values['source_contact_id']}");
6a488035
TO
2439 }
2440 else {
2441 $contactActivities[$activityId]['source_contact'] = '<em>n/a</em>';
2442 }
2443
2444 if (isset($values['mailingId']) && !empty($values['mailingId'])) {
5a99d240
KJ
2445 $contactActivities[$activityId]['target_contact'] = CRM_Utils_System::href($values['recipients'],
2446 'civicrm/mailing/report/event',
2447 "mid={$values['source_record_id']}&reset=1&event=queue&cid={$params['contact_id']}&context=activitySelector");
6a488035
TO
2448 }
2449 elseif (CRM_Utils_Array::value('recipients', $values)) {
2450 $contactActivities[$activityId]['target_contact'] = $values['recipients'];
2451 }
2452 elseif (!$values['target_contact_name']) {
2453 $contactActivities[$activityId]['target_contact'] = '<em>n/a</em>';
2454 }
2455 elseif (!empty($values['target_contact_name'])) {
2456 $count = 0;
2457 $contactActivities[$activityId]['target_contact'] = '';
2458 foreach ($values['target_contact_name'] as $tcID => $tcName) {
2459 if ($tcID && $count < 5) {
5a99d240
KJ
2460 $contactActivities[$activityId]['target_contact'] .= CRM_Utils_System::href($tcName,
2461 'civicrm/contact/view', "reset=1&cid={$tcID}");
6a488035
TO
2462 $count++;
2463 if ($count) {
2464 $contactActivities[$activityId]['target_contact'] .= ";&nbsp;";
2465 }
2466
2467 if ($count == 4) {
2468 $contactActivities[$activityId]['target_contact'] .= "(" . ts('more') . ")";
2469 break;
2470 }
2471 }
2472 }
2473 }
2474
2475 if (empty($values['assignee_contact_name'])) {
2476 $contactActivities[$activityId]['assignee_contact'] = '<em>n/a</em>';
2477 }
2478 elseif (!empty($values['assignee_contact_name'])) {
2479 $count = 0;
2480 $contactActivities[$activityId]['assignee_contact'] = '';
2481 foreach ($values['assignee_contact_name'] as $acID => $acName) {
2482 if ($acID && $count < 5) {
2483 $contactActivities[$activityId]['assignee_contact'] .= CRM_Utils_System::href($acName, 'civicrm/contact/view', "reset=1&cid={$acID}");
2484 $count++;
2485 if ($count) {
2486 $contactActivities[$activityId]['assignee_contact'] .= ";&nbsp;";
2487 }
2488
2489 if ($count == 4) {
2490 $contactActivities[$activityId]['assignee_contact'] .= "(" . ts('more') . ")";
2491 break;
2492 }
2493 }
2494 }
2495 }
6a488035
TO
2496
2497 $contactActivities[$activityId]['activity_date'] = CRM_Utils_Date::customFormat($values['activity_date_time']);
2498 $contactActivities[$activityId]['status'] = $activityStatus[$values['status_id']];
2499
2500 // add class to this row if overdue
2501 $contactActivities[$activityId]['class'] = '';
2502 if (CRM_Utils_Date::overdue(CRM_Utils_Array::value('activity_date_time', $values))
2503 && CRM_Utils_Array::value('status_id', $values) == 1
2504 ) {
2505 $contactActivities[$activityId]['class'] = 'status-overdue';
2506 }
2507 else {
2508 $contactActivities[$activityId]['class'] = 'status-ontime';
2509 }
2510
2511 // build links
2512 $contactActivities[$activityId]['links'] = '';
2513 $accessMailingReport = FALSE;
2514 if (CRM_Utils_Array::value('mailingId', $values)) {
2515 $accessMailingReport = TRUE;
2516 }
2517
2518 $actionLinks = CRM_Activity_Selector_Activity::actionLinks(
2519 CRM_Utils_Array::value('activity_type_id', $values),
2520 CRM_Utils_Array::value('source_record_id', $values),
2521 $accessMailingReport,
2522 CRM_Utils_Array::value('activity_id', $values)
2523 );
2524
2525 $actionMask = array_sum(array_keys($actionLinks)) & $mask;
2526
2527 $contactActivities[$activityId]['links'] = CRM_Core_Action::formLink($actionLinks,
2528 $actionMask,
2529 array(
2530 'id' => $values['activity_id'],
2531 'cid' => $params['contact_id'],
2532 'cxt' => $context,
2533 'caseid' => CRM_Utils_Array::value('case_id', $values),
2534 )
2535 );
2536 }
2537 }
2538
2539 return $contactActivities;
2540 }
2541
2542 /*
2543 * Used to copy custom fields and attachments from an existing activity to another.
2544 * see CRM_Case_Page_AJAX::_convertToCaseActivity() for example
2545 */
2546 static function copyExtendedActivityData($params) {
2547 // attach custom data to the new activity
2548 $customParams = $htmlType = array();
2549 $customValues = CRM_Core_BAO_CustomValueTable::getEntityValues($params['activityID'], 'Activity');
2550
2551 if (!empty($customValues)) {
2552 $fieldIds = implode(', ', array_keys($customValues));
2553 $sql = "SELECT id FROM civicrm_custom_field WHERE html_type = 'File' AND id IN ( {$fieldIds} )";
2554 $result = CRM_Core_DAO::executeQuery($sql);
2555
2556 while ($result->fetch()) {
2557 $htmlType[] = $result->id;
2558 }
2559
2560 foreach ($customValues as $key => $value) {
2561 if ($value !== NULL) { // CRM-10542
2562 if (in_array($key, $htmlType)) {
2563 $fileValues = CRM_Core_BAO_File::path($value, $params['activityID']);
2564 $customParams["custom_{$key}_-1"] = array(
2565 'name' => $fileValues[0],
2566 'path' => $fileValues[1],
2567 );
2568 }
2569 else {
2570 $customParams["custom_{$key}_-1"] = $value;
2571 }
2572 }
2573 }
2574 CRM_Core_BAO_CustomValueTable::postProcess($customParams, CRM_Core_DAO::$_nullArray, 'civicrm_activity',
2575 $params['mainActivityId'], 'Activity'
2576 );
2577 }
2578
2579 // copy activity attachments ( if any )
2580 CRM_Core_BAO_File::copyEntityFile('civicrm_activity', $params['activityID'], 'civicrm_activity', $params['mainActivityId']);
2581 }
65ebc887 2582
2583 public static function getActivityContact($activityId, $recordTypeID = NULL, $column = 'contact_id') {
2584 $activityContact = new CRM_Activity_BAO_ActivityContact();
2585 $activityContact->activity_id = $activityId;
2586 if ($recordTypeID) {
2587 $activityContact->record_type_id = $recordTypeID;
2588 }
2589 if ($activityContact->find(TRUE)) {
b319d00a 2590 return $activityContact->$column;
65ebc887 2591 }
42d30b83
DL
2592 return NULL;
2593 }
2594
2595 public static function getSourceContactID($activityId) {
2596 static $sourceID = NULL;
2597 if (!$sourceID) {
e7e657f0 2598 $activityContacts = CRM_Core_OptionGroup::values('activity_contacts', FALSE, FALSE, FALSE, NULL, 'name');
42d30b83
DL
2599 $sourceID = CRM_Utils_Array::key('Activity Source', $activityContacts);
2600 }
2601
2602 return self::getActivityContact($activityId, $sourceID);
65ebc887 2603 }
42d30b83 2604
6e1bb60c
N
2605 function setApiFilter(&$params) {
2606 if (CRM_Utils_Array::value('target_contact_id', $params)) {
2607 $this->selectAdd();
2608 $activityContacts = CRM_Core_OptionGroup::values('activity_contacts', FALSE, FALSE, FALSE, NULL, 'name');
2609 $targetID = CRM_Utils_Array::key('Activity Targets', $activityContacts);
2610 $obj = new CRM_Activity_BAO_ActivityContact();
2611 $params['return.target_contact_id'] = 1;
2612 $this->joinAdd($obj, 'LEFT');
2613 $this->selectAdd('civicrm_activity.*');
2614 $this->whereAdd(" civicrm_activity_contact.contact_id = {$params['target_contact_id']} AND civicrm_activity_contact.record_type_id = {$targetID}");
2615 }
2616 }
2617
6a488035
TO
2618}
2619