CRM/Activity/BAO/Activity.php

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