CRM/Activity/BAO/Activity.php

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