CRM/Activity/BAO/Activity.php

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