CRM/Activity/BAO/Activity.php

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