CRM/Activity/BAO/Activity.php

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