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