CRM/Activity/BAO/Activity.php

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