CRM/Activity/BAO/Activity.php

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