CRM/Case/BAO/Case.php

   1 <?php
   2 /*
   3  +--------------------------------------------------------------------+
   4  | Copyright CiviCRM LLC. All rights reserved.                        |
   5  |                                                                    |
   6  | This work is published under the GNU AGPLv3 license with some      |
   7  | permitted exceptions and without any warranty. For full license    |
   8  | and copyright information, see https://civicrm.org/licensing       |
   9  +--------------------------------------------------------------------+
  10  */
  11
  12 /**
  13  *
  14  * @package CRM
  15  * @copyright CiviCRM LLC https://civicrm.org/licensing
  16  */
  17
  18
  19 /**
  20  * This class contains the functions for Case Management.
  21  */
  22 class CRM_Case_BAO_Case extends CRM_Case_DAO_Case {
  23
  24   /**
  25    * Static field for all the case information that we can potentially export.
  26    *
  27    * @var array
  28    */
  29   public static $_exportableFields = NULL;
  30
  31   /**
  32    * Class constructor.
  33    */
  34   public function __construct() {
  35     parent::__construct();
  36   }
  37
  38   /**
  39    * Is CiviCase enabled?
  40    *
  41    * @return bool
  42    */
  43   public static function enabled() {
  44     $config = CRM_Core_Config::singleton();
  45     return in_array('CiviCase', $config->enableComponents);
  46   }
  47
  48   /**
  49    * Create a case object.
  50    *
  51    * The function extracts all the params it needs to initialize the create a
  52    * case object. the params array could contain additional unused name/value
  53    * pairs
  54    *
  55    * @param array $params
  56    *   (reference ) an assoc array of name/value pairs.
  57    *
  58    * @return CRM_Case_BAO_Case
  59    */
  60   public static function add(&$params) {
  61     $caseDAO = new CRM_Case_DAO_Case();
  62     $caseDAO->copyValues($params);
  63     $result = $caseDAO->save();
  64     // Get other case values (required by XML processor), this adds to $result array
  65     $caseDAO->find(TRUE);
  66     return $result;
  67   }
  68
  69   /**
  70    * Takes an associative array and creates a case object.
  71    *
  72    * @param array $params
  73    *   (reference) an assoc array of name/value pairs.
  74    *
  75    * @return CRM_Case_BAO_Case
  76    */
  77   public static function &create(&$params) {
  78     // CRM-20958 - These fields are managed by MySQL triggers. Watch out for clients resaving stale timestamps.
  79     unset($params['created_date']);
  80     unset($params['modified_date']);
  81     $caseStatus = CRM_Case_PseudoConstant::caseStatus('name');
  82     // for resolved case the end date should set to now
  83     if (!empty($params['status_id']) && $params['status_id'] == array_search('Closed', $caseStatus)) {
  84       $params['end_date'] = date("Ymd");
  85     }
  86
  87     $transaction = new CRM_Core_Transaction();
  88
  89     if (!empty($params['id'])) {
  90       CRM_Utils_Hook::pre('edit', 'Case', $params['id'], $params);
  91     }
  92     else {
  93       CRM_Utils_Hook::pre('create', 'Case', NULL, $params);
  94     }
  95
  96     $case = self::add($params);
  97
  98     if (!empty($params['custom']) &&
  99       is_array($params['custom'])
 100     ) {
 101       CRM_Core_BAO_CustomValueTable::store($params['custom'], 'civicrm_case', $case->id);
 102     }
 103
 104     if (is_a($case, 'CRM_Core_Error')) {
 105       $transaction->rollback();
 106       return $case;
 107     }
 108
 109     if (!empty($params['id'])) {
 110       CRM_Utils_Hook::post('edit', 'Case', $case->id, $case);
 111     }
 112     else {
 113       CRM_Utils_Hook::post('create', 'Case', $case->id, $case);
 114     }
 115     $transaction->commit();
 116
 117     //we are not creating log for case
 118     //since case log can be tracked using log for activity.
 119     return $case;
 120   }
 121
 122   /**
 123    * Process case activity add/delete
 124    * takes an associative array and
 125    *
 126    * @param array $params
 127    *   (reference ) an assoc array of name/value pairs.
 128    *
 129    */
 130   public static function processCaseActivity(&$params) {
 131     $caseActivityDAO = new CRM_Case_DAO_CaseActivity();
 132     $caseActivityDAO->activity_id = $params['activity_id'];
 133     $caseActivityDAO->case_id = $params['case_id'];
 134
 135     $caseActivityDAO->find(TRUE);
 136     $caseActivityDAO->save();
 137   }
 138
 139   /**
 140    * Get the case subject for Activity.
 141    *
 142    * @param int $activityId
 143    *   Activity id.
 144    *
 145    * @return string|null
 146    */
 147   public static function getCaseSubject($activityId) {
 148     $caseActivity = new CRM_Case_DAO_CaseActivity();
 149     $caseActivity->activity_id = $activityId;
 150     if ($caseActivity->find(TRUE)) {
 151       return CRM_Core_DAO::getFieldValue('CRM_Case_BAO_Case', $caseActivity->case_id, 'subject');
 152     }
 153     return NULL;
 154   }
 155
 156   /**
 157    * Get the case type.
 158    *
 159    * @param int $caseId
 160    * @param string $colName
 161    *
 162    * @return string
 163    *   case type
 164    */
 165   public static function getCaseType($caseId, $colName = 'title') {
 166     $query = "
 167 SELECT  civicrm_case_type.{$colName} FROM civicrm_case
 168 LEFT JOIN civicrm_case_type ON
 169   civicrm_case.case_type_id = civicrm_case_type.id
 170 WHERE civicrm_case.id = %1";
 171
 172     $queryParams = [1 => [$caseId, 'Integer']];
 173
 174     return CRM_Core_DAO::singleValueQuery($query, $queryParams);
 175   }
 176
 177   /**
 178    * Delete the record that are associated with this case.
 179    * record are deleted from case
 180    *
 181    * @param int $caseId
 182    *   Id of the case to delete.
 183    *
 184    * @param bool $moveToTrash
 185    *
 186    * @return bool
 187    *   is successful
 188    */
 189   public static function deleteCase($caseId, $moveToTrash = FALSE) {
 190     CRM_Utils_Hook::pre('delete', 'Case', $caseId, CRM_Core_DAO::$_nullArray);
 191
 192     //delete activities
 193     $activities = self::getCaseActivityDates($caseId);
 194     if ($activities) {
 195       foreach ($activities as $value) {
 196         CRM_Activity_BAO_Activity::deleteActivity($value, $moveToTrash);
 197       }
 198     }
 199
 200     if (!$moveToTrash) {
 201       $transaction = new CRM_Core_Transaction();
 202     }
 203     $case = new CRM_Case_DAO_Case();
 204     $case->id = $caseId;
 205     if (!$moveToTrash) {
 206       $result = $case->delete();
 207       $transaction->commit();
 208     }
 209     else {
 210       $result = $case->is_deleted = 1;
 211       $case->save();
 212     }
 213
 214     if ($result) {
 215       // CRM-7364, disable relationships
 216       self::enableDisableCaseRelationships($caseId, FALSE);
 217
 218       CRM_Utils_Hook::post('delete', 'Case', $caseId, $case);
 219
 220       // remove case from recent items.
 221       $caseRecent = [
 222         'id' => $caseId,
 223         'type' => 'Case',
 224       ];
 225       CRM_Utils_Recent::del($caseRecent);
 226       return TRUE;
 227     }
 228
 229     return FALSE;
 230   }
 231
 232   /**
 233    * Enable disable case related relationships.
 234    *
 235    * @param int $caseId
 236    *   Case id.
 237    * @param bool $enable
 238    *   Action.
 239    */
 240   public static function enableDisableCaseRelationships($caseId, $enable) {
 241     $contactIds = self::retrieveContactIdsByCaseId($caseId);
 242     if (!empty($contactIds)) {
 243       foreach ($contactIds as $cid) {
 244         $roles = self::getCaseRoles($cid, $caseId);
 245         if (!empty($roles)) {
 246           $relationshipIds = implode(',', array_keys($roles));
 247           $enable = (int) $enable;
 248           $query = "UPDATE civicrm_relationship SET is_active = {$enable}
 249                         WHERE id IN ( {$relationshipIds} )";
 250           CRM_Core_DAO::executeQuery($query);
 251         }
 252       }
 253     }
 254   }
 255
 256   /**
 257    * Retrieve contact_id by case_id.
 258    *
 259    * @param int $caseId
 260    *   ID of the case.
 261    *
 262    * @param int $contactID
 263    * @param int $startArrayAt This is to support legacy calls to Case.Get API which may rely on the first array index being set to 1
 264    *
 265    * @return array
 266    */
 267   public static function retrieveContactIdsByCaseId($caseId, $contactID = NULL, $startArrayAt = 0) {
 268     $caseContact = new CRM_Case_DAO_CaseContact();
 269     $caseContact->case_id = $caseId;
 270     $caseContact->find();
 271     $contactArray = [];
 272     $count = $startArrayAt;
 273     while ($caseContact->fetch()) {
 274       if ($contactID != $caseContact->contact_id) {
 275         $contactArray[$count] = $caseContact->contact_id;
 276         $count++;
 277       }
 278     }
 279
 280     return $contactArray;
 281   }
 282
 283   /**
 284    * Look up a case using an activity ID.
 285    *
 286    * @param int $activityId
 287    *
 288    * @return int|null, case ID
 289    */
 290   public static function getCaseIdByActivityId($activityId) {
 291     $originalId = CRM_Core_DAO::singleValueQuery(
 292       'SELECT original_id FROM civicrm_activity WHERE id = %1',
 293       ['1' => [$activityId, 'Integer']]
 294     );
 295     $caseId = CRM_Core_DAO::singleValueQuery(
 296       'SELECT case_id FROM civicrm_case_activity WHERE activity_id in (%1,%2)',
 297       [
 298         '1' => [$activityId, 'Integer'],
 299         '2' => [$originalId ? $originalId : $activityId, 'Integer'],
 300       ]
 301     );
 302     return $caseId;
 303   }
 304
 305   /**
 306    * Retrieve contact names by caseId.
 307    *
 308    * @param int $caseId
 309    *   ID of the case.
 310    *
 311    * @return array
 312    */
 313   public static function getContactNames($caseId) {
 314     $contactNames = [];
 315     if (!$caseId) {
 316       return $contactNames;
 317     }
 318
 319     $query = "
 320     SELECT  contact_a.sort_name name,
 321             contact_a.display_name as display_name,
 322             contact_a.id cid,
 323             contact_a.birth_date as birth_date,
 324             ce.email as email,
 325             cp.phone as phone
 326       FROM  civicrm_contact contact_a
 327  LEFT JOIN  civicrm_case_contact ON civicrm_case_contact.contact_id = contact_a.id
 328  LEFT JOIN  civicrm_email ce ON ( ce.contact_id = contact_a.id AND ce.is_primary = 1)
 329  LEFT JOIN  civicrm_phone cp ON ( cp.contact_id = contact_a.id AND cp.is_primary = 1)
 330      WHERE  contact_a.is_deleted = 0 AND civicrm_case_contact.case_id = %1
 331      ORDER BY civicrm_case_contact.id";
 332
 333     $dao = CRM_Core_DAO::executeQuery($query,
 334       [1 => [$caseId, 'Integer']]
 335     );
 336     while ($dao->fetch()) {
 337       $contactNames[$dao->cid]['contact_id'] = $dao->cid;
 338       $contactNames[$dao->cid]['sort_name'] = $dao->name;
 339       $contactNames[$dao->cid]['display_name'] = $dao->display_name;
 340       $contactNames[$dao->cid]['email'] = $dao->email;
 341       $contactNames[$dao->cid]['phone'] = $dao->phone;
 342       $contactNames[$dao->cid]['birth_date'] = $dao->birth_date;
 343       $contactNames[$dao->cid]['role'] = ts('Client');
 344     }
 345
 346     return $contactNames;
 347   }
 348
 349   /**
 350    * Retrieve case_id by contact_id.
 351    *
 352    * @param int $contactID
 353    * @param bool $includeDeleted
 354    *   Include the deleted cases in result.
 355    * @param null $caseType
 356    *
 357    * @return array
 358    */
 359   public static function retrieveCaseIdsByContactId($contactID, $includeDeleted = FALSE, $caseType = NULL) {
 360     $query = "
 361 SELECT ca.id as id
 362 FROM civicrm_case_contact cc
 363 INNER JOIN civicrm_case ca ON cc.case_id = ca.id
 364 ";
 365     if (isset($caseType)) {
 366       $query .=
 367         "INNER JOIN civicrm_case_type ON civicrm_case_type.id = ca.case_type_id
 368 WHERE cc.contact_id = %1 AND civicrm_case_type.name = '{$caseType}'";
 369     }
 370     if (!isset($caseType)) {
 371       $query .= "WHERE cc.contact_id = %1";
 372     }
 373     if (!$includeDeleted) {
 374       $query .= " AND ca.is_deleted = 0";
 375     }
 376
 377     $params = [1 => [$contactID, 'Integer']];
 378     $dao = CRM_Core_DAO::executeQuery($query, $params);
 379
 380     $caseArray = [];
 381     while ($dao->fetch()) {
 382       $caseArray[] = $dao->id;
 383     }
 384
 385     return $caseArray;
 386   }
 387
 388   /**
 389    * @param string $type
 390    * @param int $userID
 391    * @param string $condition
 392    *
 393    * @return string
 394    */
 395   public static function getCaseActivityCountQuery($type = 'upcoming', $userID, $condition = NULL) {
 396     return sprintf(" SELECT COUNT(*) FROM (%s) temp ", self::getCaseActivityQuery($type, $userID, $condition));
 397   }
 398
 399   /**
 400    * @param string $type
 401    * @param int $userID
 402    * @param string $condition
 403    * @param string $limit
 404    * @param string $order
 405    *
 406    * @return string
 407    */
 408   public static function getCaseActivityQuery($type = 'upcoming', $userID, $condition = NULL, $limit = NULL, $order = NULL) {
 409     $selectClauses = [
 410       'civicrm_case.id as case_id',
 411       'civicrm_case.subject as case_subject',
 412       'civicrm_contact.id as contact_id',
 413       'civicrm_contact.sort_name as sort_name',
 414       'civicrm_phone.phone as phone',
 415       'civicrm_contact.contact_type as contact_type',
 416       'civicrm_contact.contact_sub_type as contact_sub_type',
 417       't_act.activity_type_id as activity_type_id',
 418       'civicrm_case.case_type_id as case_type_id',
 419       'civicrm_case.status_id as case_status_id',
 420       't_act.status_id as status_id',
 421       'civicrm_case.start_date as case_start_date',
 422       "GROUP_CONCAT(DISTINCT IF(case_relationship.contact_id_b = $userID, case_relation_type.label_a_b, case_relation_type.label_b_a) SEPARATOR ', ') as case_role",
 423       't_act.activity_date_time as activity_date_time',
 424       't_act.id as activity_id',
 425     ];
 426
 427     $query = CRM_Contact_BAO_Query::appendAnyValueToSelect($selectClauses, 'case_id');
 428
 429     $query .= <<<HERESQL
 430       FROM civicrm_case
 431         INNER JOIN civicrm_case_contact ON civicrm_case.id = civicrm_case_contact.case_id
 432         INNER JOIN civicrm_contact ON civicrm_case_contact.contact_id = civicrm_contact.id
 433 HERESQL;
 434
 435     switch ($type) {
 436       case 'upcoming':
 437       case 'recent':
 438         // civicrm_view_case_activity_upcoming and
 439         // civicrm_view_case_activity_recent are views that show the next
 440         // scheduled and most recent not-scheduled activity on each case,
 441         // respectively.
 442         $query .= <<<HERESQL
 443         INNER JOIN civicrm_view_case_activity_$type t_act
 444           ON t_act.case_id = civicrm_case.id
 445 HERESQL;
 446         break;
 447
 448       case 'any':
 449         $query .= <<<HERESQL
 450         LEFT JOIN civicrm_case_activity ca4
 451           ON civicrm_case.id = ca4.case_id
 452         LEFT JOIN civicrm_activity t_act
 453           ON t_act.id = ca4.activity_id
 454           AND t_act.is_current_revision = 1
 455 HERESQL;
 456     }
 457
 458     $query .= <<<HERESQL
 459         LEFT JOIN civicrm_phone
 460           ON civicrm_phone.contact_id = civicrm_contact.id
 461             AND civicrm_phone.is_primary = 1
 462         LEFT JOIN civicrm_relationship case_relationship
 463           ON ((case_relationship.contact_id_a = civicrm_case_contact.contact_id AND case_relationship.contact_id_b = {$userID})
 464           OR (case_relationship.contact_id_b = civicrm_case_contact.contact_id AND case_relationship.contact_id_a = {$userID}))
 465             AND case_relationship.is_active
 466             AND case_relationship.case_id = civicrm_case.id
 467         LEFT JOIN civicrm_relationship_type case_relation_type
 468           ON case_relation_type.id = case_relationship.relationship_type_id
 469             AND case_relation_type.id = case_relationship.relationship_type_id
 470 HERESQL;
 471
 472     if ($condition) {
 473       // CRM-8749 backwards compatibility - callers of this function expect to start $condition with "AND"
 474       $query .= " WHERE (1) AND $condition ";
 475     }
 476     $query .= " GROUP BY case_id ";
 477
 478     $query .= ($order) ?: ' ORDER BY activity_date_time ASC';
 479
 480     if ($limit) {
 481       $query .= $limit;
 482     }
 483
 484     return $query;
 485   }
 486
 487   /**
 488    * Retrieve cases related to particular contact or whole contact used in Dashboard and Tab.
 489    *
 490    * @param bool $allCases
 491    * @param array $params
 492    * @param string $context
 493    * @param bool $getCount
 494    *
 495    * @return array
 496    *   Array of Cases
 497    */
 498   public static function getCases($allCases = TRUE, $params = [], $context = 'dashboard', $getCount = FALSE) {
 499     $condition = NULL;
 500     $casesList = [];
 501
 502     // validate access for own cases.
 503     if (!self::accessCiviCase()) {
 504       return $getCount ? 0 : $casesList;
 505     }
 506
 507     // Return cached value instead of re-running query
 508     if (isset(Civi::$statics[__CLASS__]['totalCount']) && $getCount) {
 509       return Civi::$statics[__CLASS__]['totalCount'];
 510     }
 511
 512     $type = CRM_Utils_Array::value('type', $params, 'upcoming');
 513     $userID = CRM_Core_Session::getLoggedInContactID();
 514
 515     // validate access for all cases.
 516     if ($allCases && !CRM_Core_Permission::check('access all cases and activities')) {
 517       $allCases = FALSE;
 518     }
 519
 520     $whereClauses = ['civicrm_case.is_deleted = 0 AND civicrm_contact.is_deleted <> 1'];
 521
 522     if (!$allCases) {
 523       $whereClauses[] = "(case_relationship.contact_id_b = {$userID} OR case_relationship.contact_id_a = {$userID})";
 524       $whereClauses[] = 'case_relationship.is_active';
 525     }
 526     if (empty($params['status_id']) && ($type == 'upcoming' || $type == 'any')) {
 527       $whereClauses[] = "civicrm_case.status_id != " . CRM_Core_PseudoConstant::getKey('CRM_Case_BAO_Case', 'case_status_id', 'Closed');
 528     }
 529
 530     foreach (['case_type_id', 'status_id'] as $column) {
 531       if (!empty($params[$column])) {
 532         $whereClauses[] = sprintf("civicrm_case.%s IN (%s)", $column, $params[$column]);
 533       }
 534     }
 535     $condition = implode(' AND ', $whereClauses);
 536
 537     Civi::$statics[__CLASS__]['totalCount'] = $totalCount = CRM_Core_DAO::singleValueQuery(self::getCaseActivityCountQuery($type, $userID, $condition));
 538     if ($getCount) {
 539       return $totalCount;
 540     }
 541     $casesList['total'] = $totalCount;
 542
 543     $limit = '';
 544     if (!empty($params['rp'])) {
 545       $params['offset'] = ($params['page'] - 1) * $params['rp'];
 546       $params['rowCount'] = $params['rp'];
 547       if (!empty($params['rowCount']) && $params['rowCount'] > 0) {
 548         $limit = " LIMIT {$params['offset']}, {$params['rowCount']} ";
 549       }
 550     }
 551
 552     $order = NULL;
 553     if (!empty($params['sortBy'])) {
 554       if (strstr($params['sortBy'], 'date ')) {
 555         $params['sortBy'] = str_replace('date', 'activity_date_time', $params['sortBy']);
 556       }
 557       $order = "ORDER BY " . $params['sortBy'];
 558     }
 559
 560     $query = self::getCaseActivityQuery($type, $userID, $condition, $limit, $order);
 561     $result = CRM_Core_DAO::executeQuery($query);
 562
 563     // we're going to use the usual actions, so doesn't make sense to duplicate definitions
 564     $actions = CRM_Case_Selector_Search::links();
 565
 566     // check is the user has view/edit signer permission
 567     $permissions = [CRM_Core_Permission::VIEW];
 568     if (CRM_Core_Permission::check('access all cases and activities') ||
 569       (!$allCases && CRM_Core_Permission::check('access my cases and activities'))
 570     ) {
 571       $permissions[] = CRM_Core_Permission::EDIT;
 572     }
 573     if (CRM_Core_Permission::check('delete in CiviCase')) {
 574       $permissions[] = CRM_Core_Permission::DELETE;
 575     }
 576     $mask = CRM_Core_Action::mask($permissions);
 577
 578     // Pseudoconstants to populate labels
 579     $caseStatuses = CRM_Case_PseudoConstant::caseStatus('label', FALSE);
 580     $caseTypes = CRM_Case_PseudoConstant::caseType('name');
 581     $caseTypeTitles = CRM_Case_PseudoConstant::caseType('title', FALSE);
 582     $activityTypeLabels = CRM_Activity_BAO_Activity::buildOptions('activity_type_id');
 583
 584     foreach ($result->fetchAll() as $case) {
 585       $key = $case['case_id'];
 586       $casesList[$key] = [];
 587       $casesList[$key]['DT_RowId'] = $case['case_id'];
 588       $casesList[$key]['DT_RowAttr'] = ['data-entity' => 'case', 'data-id' => $case['case_id']];
 589       $casesList[$key]['DT_RowClass'] = "crm-entity";
 590
 591       $casesList[$key]['activity_list'] = sprintf('<a title="%s" class="crm-expand-row" href="%s"></a>',
 592         ts('Activities'),
 593         CRM_Utils_System::url('civicrm/case/details', ['caseId' => $case['case_id'], 'cid' => $case['contact_id'], 'type' => $type])
 594       );
 595
 596       $phone = empty($case['phone']) ? '' : '<br /><span class="description">' . $case['phone'] . '</span>';
 597       $casesList[$key]['sort_name'] = sprintf('<a href="%s">%s</a>%s<br /><span class="description">%s: %d</span>',
 598         CRM_Utils_System::url('civicrm/contact/view', ['cid' => $case['contact_id']]),
 599         $case['sort_name'],
 600         $phone,
 601         ts('Case ID'),
 602         $case['case_id']
 603       );
 604       $casesList[$key]['subject'] = $case['case_subject'];
 605       $casesList[$key]['case_status'] = $caseStatuses[$case['case_status_id']] ?? NULL;
 606       if ($case['case_status_id'] == CRM_Case_PseudoConstant::getKey('CRM_Case_BAO_Case', 'case_status_id', 'Urgent')) {
 607         $casesList[$key]['case_status'] = sprintf('<strong>%s</strong>', strtoupper($casesList[$key]['case_status']));
 608       }
 609       $casesList[$key]['case_type'] = $caseTypeTitles[$case['case_type_id']] ?? NULL;
 610       $casesList[$key]['case_role'] = CRM_Utils_Array::value('case_role', $case, '---');
 611       $casesList[$key]['manager'] = self::getCaseManagerContact($caseTypes[$case['case_type_id']], $case['case_id']);
 612
 613       $casesList[$key]['date'] = $activityTypeLabels[$case['activity_type_id']] ?? NULL;
 614       if ($actId = CRM_Utils_Array::value('activity_id', $case)) {
 615         if (self::checkPermission($actId, 'view', $case['activity_type_id'], $userID)) {
 616           if ($type == 'recent') {
 617             $casesList[$key]['date'] = sprintf('<a class="action-item crm-hover-button" href="%s" title="%s">%s</a>',
 618               CRM_Utils_System::url('civicrm/case/activity/view', ['reset' => 1, 'cid' => $case['contact_id'], 'aid' => $case['activity_id']]),
 619               ts('View activity'),
 620               CRM_Utils_Array::value($case['activity_type_id'], $activityTypeLabels)
 621             );
 622           }
 623           else {
 624             $status = CRM_Utils_Date::overdue($case['activity_date_time']) ? 'status-overdue' : 'status-scheduled';
 625             $casesList[$key]['date'] = sprintf('<a class="crm-popup %s" href="%s" title="%s">%s</a> &nbsp;&nbsp;',
 626               $status,
 627               CRM_Utils_System::url('civicrm/case/activity/view', ['reset' => 1, 'cid' => $case['contact_id'], 'aid' => $case['activity_id']]),
 628               ts('View activity'),
 629               CRM_Utils_Array::value($case['activity_type_id'], $activityTypeLabels)
 630             );
 631           }
 632         }
 633         if (isset($case['activity_type_id']) && self::checkPermission($actId, 'edit', $case['activity_type_id'], $userID)) {
 634           $casesList[$key]['date'] .= sprintf('<a class="action-item crm-hover-button" href="%s" title="%s"><i class="crm-i fa-pencil" aria-hidden="true"></i></a>',
 635             CRM_Utils_System::url('civicrm/case/activity', ['reset' => 1, 'cid' => $case['contact_id'], 'caseid' => $case['case_id'], 'action' => 'update', 'id' => $actId]),
 636             ts('Edit activity')
 637           );
 638         }
 639       }
 640       $casesList[$key]['date'] .= "<br/>" . CRM_Utils_Date::customFormat($case['activity_date_time']);
 641       $casesList[$key]['links'] = CRM_Core_Action::formLink($actions['primaryActions'], $mask,
 642         [
 643           'id' => $case['case_id'],
 644           'cid' => $case['contact_id'],
 645           'cxt' => $context,
 646         ],
 647         ts('more'),
 648         FALSE,
 649         'case.actions.primary',
 650         'Case',
 651         $case['case_id']
 652       );
 653     }
 654
 655     return $casesList;
 656   }
 657
 658   /**
 659    * Get the summary of cases counts by type and status.
 660    *
 661    * @param bool $allCases
 662    *
 663    * @return array
 664    */
 665   public static function getCasesSummary($allCases = TRUE) {
 666     $caseSummary = [];
 667
 668     //validate access for civicase.
 669     if (!self::accessCiviCase()) {
 670       return $caseSummary;
 671     }
 672
 673     $userID = CRM_Core_Session::getLoggedInContactID();
 674
 675     //validate access for all cases.
 676     if ($allCases && !CRM_Core_Permission::check('access all cases and activities')) {
 677       $allCases = FALSE;
 678     }
 679
 680     $caseTypes = CRM_Case_PseudoConstant::caseType();
 681     $caseStatuses = CRM_Case_PseudoConstant::caseStatus();
 682     $caseTypes = array_flip($caseTypes);
 683
 684     // get statuses as headers for the table
 685     $url = CRM_Utils_System::url('civicrm/case/search', "reset=1&force=1&all=1&status=");
 686     foreach ($caseStatuses as $key => $name) {
 687       $caseSummary['headers'][$key]['status'] = $name;
 688       $caseSummary['headers'][$key]['url'] = $url . $key;
 689     }
 690
 691     // build rows with actual data
 692     $rows = [];
 693     $myGroupByClause = $mySelectClause = $myCaseFromClause = $myCaseWhereClauseA = $myCaseWhereClauseB = '';
 694
 695     if ($allCases) {
 696       $userID = 'null';
 697       $all = 1;
 698       $case_owner = 1;
 699       $myGroupByClauseB = ' GROUP BY civicrm_case.id';
 700     }
 701     else {
 702       $all = 0;
 703       $case_owner = 2;
 704       $myCaseWhereClauseA = " AND case_relationship.contact_id_a = {$userID} AND case_relationship.is_active ";
 705       $myGroupByClauseA = " GROUP BY CONCAT(civicrm_case.id,'-',case_relationship.contact_id_a)";
 706       $myCaseWhereClauseB = " AND case_relationship.contact_id_b = {$userID} AND case_relationship.is_active ";
 707       $myGroupByClauseB = " GROUP BY CONCAT(civicrm_case.id,'-',case_relationship.contact_id_b)";
 708     }
 709     $myGroupByClauseB .= ", case_status.label, status_id, case_type_id, civicrm_case.id";
 710     $myGroupByClauseA = $myGroupByClauseB;
 711     // FIXME: This query could be a lot more efficient if it used COUNT() instead of returning all rows and then counting them with php
 712     $query = "
 713 SELECT civicrm_case.id, case_status.label AS case_status, status_id, civicrm_case_type.title AS case_type,
 714  case_type_id, case_relationship.contact_id_b as case_contact
 715  FROM civicrm_case
 716  INNER JOIN civicrm_case_contact cc on cc.case_id = civicrm_case.id
 717  LEFT JOIN civicrm_case_type ON civicrm_case.case_type_id = civicrm_case_type.id
 718  LEFT JOIN civicrm_option_group option_group_case_status ON ( option_group_case_status.name = 'case_status' )
 719  LEFT JOIN civicrm_option_value case_status ON ( civicrm_case.status_id = case_status.value
 720  AND option_group_case_status.id = case_status.option_group_id )
 721  LEFT JOIN civicrm_relationship case_relationship ON ( case_relationship.case_id  = civicrm_case.id
 722  AND case_relationship.contact_id_b = {$userID} AND case_relationship.is_active )
 723  WHERE is_deleted = 0 AND cc.contact_id IN (SELECT id FROM civicrm_contact WHERE is_deleted <> 1)
 724 {$myCaseWhereClauseB} {$myGroupByClauseB}
 725 UNION
 726 SELECT civicrm_case.id, case_status.label AS case_status, status_id, civicrm_case_type.title AS case_type,
 727  case_type_id, case_relationship.contact_id_a as case_contact
 728  FROM civicrm_case
 729  INNER JOIN civicrm_case_contact cc on cc.case_id = civicrm_case.id
 730  LEFT JOIN civicrm_case_type ON civicrm_case.case_type_id = civicrm_case_type.id
 731  LEFT JOIN civicrm_option_group option_group_case_status ON ( option_group_case_status.name = 'case_status' )
 732  LEFT JOIN civicrm_option_value case_status ON ( civicrm_case.status_id = case_status.value
 733  AND option_group_case_status.id = case_status.option_group_id )
 734  LEFT JOIN civicrm_relationship case_relationship ON ( case_relationship.case_id  = civicrm_case.id
 735  AND case_relationship.contact_id_a = {$userID})
 736  WHERE is_deleted = 0 AND cc.contact_id IN (SELECT id FROM civicrm_contact WHERE is_deleted <> 1)
 737 {$myCaseWhereClauseA} {$myGroupByClauseA}";
 738
 739     $res = CRM_Core_DAO::executeQuery($query);
 740     while ($res->fetch()) {
 741       if (!empty($rows[$res->case_type]) && !empty($rows[$res->case_type][$res->case_status])) {
 742         $rows[$res->case_type][$res->case_status]['count'] = $rows[$res->case_type][$res->case_status]['count'] + 1;
 743       }
 744       else {
 745         $rows[$res->case_type][$res->case_status] = [
 746           'count' => 1,
 747           'url' => CRM_Utils_System::url('civicrm/case/search',
 748             "reset=1&force=1&status={$res->status_id}&type={$res->case_type_id}&case_owner={$case_owner}"
 749           ),
 750         ];
 751       }
 752     }
 753     $caseSummary['rows'] = array_merge($caseTypes, $rows);
 754
 755     return $caseSummary;
 756   }
 757
 758   /**
 759    * Get Case roles.
 760    *
 761    * @param int $contactID
 762    *   Contact id.
 763    * @param int $caseID
 764    *   Case id.
 765    * @param int $relationshipID
 766    * @param bool $activeOnly
 767    *
 768    * @return array
 769    *   case role / relationships
 770    *
 771    */
 772   public static function getCaseRoles($contactID, $caseID, $relationshipID = NULL, $activeOnly = TRUE) {
 773     $query = '
 774     SELECT  rel.id as civicrm_relationship_id,
 775             con.sort_name as sort_name,
 776             civicrm_email.email as email,
 777             civicrm_phone.phone as phone,
 778             con.id as civicrm_contact_id,
 779             IF(rel.contact_id_a = %1, civicrm_relationship_type.label_a_b, civicrm_relationship_type.label_b_a) as relation,
 780             civicrm_relationship_type.id as relation_type,
 781             IF(rel.contact_id_a = %1, "a_b", "b_a") as relationship_direction
 782       FROM  civicrm_relationship rel
 783  INNER JOIN  civicrm_relationship_type ON rel.relationship_type_id = civicrm_relationship_type.id
 784  INNER JOIN  civicrm_contact con ON ((con.id <> %1 AND con.id IN (rel.contact_id_a, rel.contact_id_b)) OR (con.id = %1 AND rel.contact_id_b = rel.contact_id_a AND rel.contact_id_a = %1 AND rel.is_active))
 785  LEFT JOIN  civicrm_phone ON (civicrm_phone.contact_id = con.id AND civicrm_phone.is_primary = 1)
 786  LEFT JOIN  civicrm_email ON (civicrm_email.contact_id = con.id AND civicrm_email.is_primary = 1)
 787      WHERE  (rel.contact_id_a = %1 OR rel.contact_id_b = %1) AND rel.case_id = %2
 788        AND con.is_deleted = 0';
 789
 790     if ($activeOnly) {
 791       $query .= ' AND rel.is_active = 1 AND (rel.end_date IS NULL OR rel.end_date > NOW())';
 792     }
 793
 794     $params = [
 795       1 => [$contactID, 'Positive'],
 796       2 => [$caseID, 'Positive'],
 797     ];
 798
 799     if ($relationshipID) {
 800       $query .= ' AND rel.id = %3 ';
 801       $params[3] = [$relationshipID, 'Integer'];
 802     }
 803     $dao = CRM_Core_DAO::executeQuery($query, $params);
 804
 805     $values = [];
 806     while ($dao->fetch()) {
 807       $rid = $dao->civicrm_relationship_id;
 808       $values[$rid]['cid'] = $dao->civicrm_contact_id;
 809       $values[$rid]['relation'] = $dao->relation;
 810       $values[$rid]['name'] = $dao->sort_name;
 811       $values[$rid]['email'] = $dao->email;
 812       $values[$rid]['phone'] = $dao->phone;
 813       $values[$rid]['relation_type'] = $dao->relation_type;
 814       $values[$rid]['rel_id'] = $dao->civicrm_relationship_id;
 815       $values[$rid]['client_id'] = $contactID;
 816       $values[$rid]['relationship_direction'] = $dao->relationship_direction;
 817     }
 818
 819     return $values;
 820   }
 821
 822   /**
 823    * Get Case Activities.
 824    *
 825    * @param int $caseID
 826    *   Case id.
 827    * @param array $params
 828    *   Posted params.
 829    * @param int $contactID
 830    *   Contact id.
 831    *
 832    * @param null $context
 833    * @param int $userID
 834    * @param null $type (deprecated)
 835    *
 836    * @return array
 837    *   Array of case activities
 838    *
 839    */
 840   public static function getCaseActivity($caseID, &$params, $contactID, $context = NULL, $userID = NULL, $type = NULL) {
 841     $activityContacts = CRM_Activity_BAO_ActivityContact::buildOptions('record_type_id', 'validate');
 842     $assigneeID = CRM_Utils_Array::key('Activity Assignees', $activityContacts);
 843     $sourceID = CRM_Utils_Array::key('Activity Source', $activityContacts);
 844     $targetID = CRM_Utils_Array::key('Activity Targets', $activityContacts);
 845
 846     // CRM-5081 - formatting the dates to omit seconds.
 847     // Note the 00 in the date format string is needed otherwise later on it thinks scheduled ones are overdue.
 848     $select = "
 849            SELECT SQL_CALC_FOUND_ROWS COUNT(ca.id) AS ismultiple,
 850                   ca.id AS id,
 851                   ca.activity_type_id AS type,
 852                   ca.activity_type_id AS activity_type_id,
 853                   tcc.sort_name AS target_contact_name,
 854                   tcc.id AS target_contact_id,
 855                   scc.sort_name AS source_contact_name,
 856                   scc.id AS source_contact_id,
 857                   acc.sort_name AS assignee_contact_name,
 858                   acc.id AS assignee_contact_id,
 859                   DATE_FORMAT(
 860                     IF(ca.activity_date_time < NOW() AND ca.status_id=ov.value,
 861                       ca.activity_date_time,
 862                       DATE_ADD(NOW(), INTERVAL 1 YEAR)
 863                     ), '%Y%m%d%H%i00') AS overdue_date,
 864                   DATE_FORMAT(ca.activity_date_time, '%Y%m%d%H%i00') AS display_date,
 865                   ca.status_id AS status,
 866                   ca.subject AS subject,
 867                   ca.is_deleted AS deleted,
 868                   ca.priority_id AS priority,
 869                   ca.weight AS weight,
 870                   GROUP_CONCAT(ef.file_id) AS attachment_ids ";
 871
 872     $from = "
 873              FROM civicrm_case_activity cca
 874        INNER JOIN civicrm_activity ca
 875                ON ca.id = cca.activity_id
 876        INNER JOIN civicrm_activity_contact cas
 877                ON cas.activity_id = ca.id
 878               AND cas.record_type_id = {$sourceID}
 879        INNER JOIN civicrm_contact scc
 880                ON scc.id = cas.contact_id
 881         LEFT JOIN civicrm_activity_contact caa
 882                ON caa.activity_id = ca.id
 883               AND caa.record_type_id = {$assigneeID}
 884         LEFT JOIN civicrm_contact acc
 885                ON acc.id = caa.contact_id
 886         LEFT JOIN civicrm_activity_contact cat
 887                ON cat.activity_id = ca.id
 888               AND cat.record_type_id = {$targetID}
 889         LEFT JOIN civicrm_contact tcc
 890                ON tcc.id = cat.contact_id
 891        INNER JOIN civicrm_option_group cog
 892                ON cog.name = 'activity_type'
 893        INNER JOIN civicrm_option_value cov
 894                ON cov.option_group_id = cog.id
 895               AND cov.value = ca.activity_type_id
 896               AND cov.is_active = 1
 897         LEFT JOIN civicrm_entity_file ef
 898                ON ef.entity_table = 'civicrm_activity'
 899               AND ef.entity_id = ca.id
 900   LEFT OUTER JOIN civicrm_option_group og
 901                ON og.name = 'activity_status'
 902   LEFT OUTER JOIN civicrm_option_value ov
 903                ON ov.option_group_id=og.id
 904               AND ov.name = 'Scheduled'";
 905
 906     $where = '
 907             WHERE cca.case_id= %1
 908               AND ca.is_current_revision = 1';
 909
 910     if (!empty($params['source_contact_id'])) {
 911       $where .= "
 912               AND cas.contact_id = " . CRM_Utils_Type::escape($params['source_contact_id'], 'Integer');
 913     }
 914
 915     if (!empty($params['status_id'])) {
 916       $where .= "
 917               AND ca.status_id = " . CRM_Utils_Type::escape($params['status_id'], 'Integer');
 918     }
 919
 920     if (!empty($params['activity_deleted'])) {
 921       $where .= "
 922               AND ca.is_deleted = 1";
 923     }
 924     else {
 925       $where .= "
 926               AND ca.is_deleted = 0";
 927     }
 928
 929     if (!empty($params['activity_type_id'])) {
 930       $where .= "
 931               AND ca.activity_type_id = " . CRM_Utils_Type::escape($params['activity_type_id'], 'Integer');
 932     }
 933
 934     if (!empty($params['activity_date_low'])) {
 935       $fromActivityDate = CRM_Utils_Type::escape(CRM_Utils_Date::processDate($params['activity_date_low']), 'Date');
 936     }
 937     if (!empty($fromActivityDate)) {
 938       $where .= "
 939               AND ca.activity_date_time >= '{$fromActivityDate}'";
 940     }
 941
 942     if (!empty($params['activity_date_high'])) {
 943       $toActivityDate = CRM_Utils_Type::escape(CRM_Utils_Date::processDate($params['activity_date_high']), 'Date');
 944       $toActivityDate = $toActivityDate ? $toActivityDate + 235959 : NULL;
 945     }
 946     if (!empty($toActivityDate)) {
 947       $where .= "
 948               AND ca.activity_date_time <= '{$toActivityDate}'";
 949     }
 950
 951     $groupBy = "
 952          GROUP BY ca.id, tcc.id, scc.id, acc.id, ov.value";
 953
 954     $sortBy = $params['sortBy'] ?? NULL;
 955     if (!$sortBy) {
 956       // CRM-5081 - added id to act like creation date
 957       $orderBy = "
 958          ORDER BY overdue_date ASC, display_date DESC, weight DESC";
 959     }
 960     else {
 961       $sortBy = CRM_Utils_Type::escape($sortBy, 'String');
 962       $orderBy = " ORDER BY $sortBy ";
 963     }
 964
 965     $page = $params['page'] ?? NULL;
 966     $rp = $params['rp'] ?? NULL;
 967
 968     if (!$page) {
 969       $page = 1;
 970     }
 971     if (!$rp) {
 972       $rp = 10;
 973     }
 974     $start = (($page - 1) * $rp);
 975     $limit = " LIMIT $start, $rp";
 976
 977     $query = $select . $from . $where . $groupBy . $orderBy . $limit;
 978     $queryParams = [1 => [$caseID, 'Integer']];
 979
 980     $dao = CRM_Core_DAO::executeQuery($query, $queryParams);
 981     $caseCount = CRM_Core_DAO::singleValueQuery('SELECT FOUND_ROWS()');
 982
 983     $activityTypes = CRM_Case_PseudoConstant::caseActivityType(FALSE, TRUE);
 984
 985     $compStatusValues = array_keys(
 986       CRM_Activity_BAO_Activity::getStatusesByType(CRM_Activity_BAO_Activity::COMPLETED) +
 987       CRM_Activity_BAO_Activity::getStatusesByType(CRM_Activity_BAO_Activity::CANCELLED)
 988     );
 989
 990     if (!$userID) {
 991       $userID = CRM_Core_Session::getLoggedInContactID();
 992     }
 993
 994     $caseActivities = [];
 995
 996     while ($dao->fetch()) {
 997       $caseActivityId = $dao->id;
 998
 999       //Do we have permission to access given case activity record.
1000       if (!self::checkPermission($caseActivityId, 'view', $dao->activity_type_id, $userID)) {
1001         continue;
1002       }
1003
1004       $caseActivities[$caseActivityId]['DT_RowId'] = $caseActivityId;
1005       //Add classes to the row, via DataTables syntax
1006       $caseActivities[$caseActivityId]['DT_RowClass'] = "crm-entity status-id-$dao->status";
1007
1008       if (CRM_Utils_Array::crmInArray($dao->status, $compStatusValues)) {
1009         $caseActivities[$caseActivityId]['DT_RowClass'] .= " status-completed";
1010       }
1011       else {
1012         if (CRM_Utils_Date::overdue($dao->display_date)) {
1013           $caseActivities[$caseActivityId]['DT_RowClass'] .= " status-overdue";
1014         }
1015         else {
1016           $caseActivities[$caseActivityId]['DT_RowClass'] .= " status-scheduled";
1017         }
1018       }
1019
1020       if (!empty($dao->priority)) {
1021         if ($dao->priority == CRM_Core_PseudoConstant::getKey('CRM_Activity_BAO_Activity', 'priority_id', 'Urgent')) {
1022           $caseActivities[$caseActivityId]['DT_RowClass'] .= " priority-urgent ";
1023         }
1024         elseif ($dao->priority == CRM_Core_PseudoConstant::getKey('CRM_Activity_BAO_Activity', 'priority_id', 'Low')) {
1025           $caseActivities[$caseActivityId]['DT_RowClass'] .= " priority-low ";
1026         }
1027       }
1028
1029       //Add data to the row for inline editing, via DataTable syntax
1030       $caseActivities[$caseActivityId]['DT_RowAttr'] = [];
1031       $caseActivities[$caseActivityId]['DT_RowAttr']['data-entity'] = 'activity';
1032       $caseActivities[$caseActivityId]['DT_RowAttr']['data-id'] = $caseActivityId;
1033
1034       //Activity Date and Time
1035       $caseActivities[$caseActivityId]['activity_date_time'] = CRM_Utils_Date::customFormat($dao->display_date);
1036
1037       //Activity Subject
1038       $caseActivities[$caseActivityId]['subject'] = $dao->subject;
1039
1040       //Activity Type
1041       $caseActivities[$caseActivityId]['type'] = (!empty($activityTypes[$dao->type]['icon']) ? '<span class="crm-i ' . $activityTypes[$dao->type]['icon'] . '"></span> ' : '')
1042         . $activityTypes[$dao->type]['label'];
1043
1044       // Activity Target (With Contact) (There can be more than one)
1045       $targetContact = self::formatContactLink($dao->target_contact_id, $dao->target_contact_name);
1046       if (empty($caseActivities[$caseActivityId]['target_contact_name'])) {
1047         $caseActivities[$caseActivityId]['target_contact_name'] = $targetContact;
1048       }
1049       else {
1050         if (strpos($caseActivities[$caseActivityId]['target_contact_name'], $targetContact) === FALSE) {
1051           $caseActivities[$caseActivityId]['target_contact_name'] .= '; ' . $targetContact;
1052         }
1053       }
1054
1055       // Activity Source Contact (Reporter) (There can only be one)
1056       $sourceContact = self::formatContactLink($dao->source_contact_id, $dao->source_contact_name);
1057       $caseActivities[$caseActivityId]['source_contact_name'] = $sourceContact;
1058
1059       // Activity Assignee (There can be more than one)
1060       $assigneeContact = self::formatContactLink($dao->assignee_contact_id, $dao->assignee_contact_name);
1061       if (empty($caseActivities[$caseActivityId]['assignee_contact_name'])) {
1062         $caseActivities[$caseActivityId]['assignee_contact_name'] = $assigneeContact;
1063       }
1064       else {
1065         if (strpos($caseActivities[$caseActivityId]['assignee_contact_name'], $assigneeContact) === FALSE) {
1066           $caseActivities[$caseActivityId]['assignee_contact_name'] .= '; ' . $assigneeContact;
1067         }
1068       }
1069
1070       // Activity Status Label for Case activities list
1071       $deleted = '';
1072       if ($dao->deleted) {
1073         $deleted = '<br /> ' . ts('(deleted)');
1074       }
1075       $caseActivities[$caseActivityId]['status_id'] = CRM_Core_PseudoConstant::getLabel('CRM_Activity_BAO_Activity', 'activity_status_id', $dao->status) . $deleted;
1076       // if there are file attachments we will return how many
1077       if (!empty($dao->attachment_ids)) {
1078         $attachmentIDs = array_unique(explode(',', $dao->attachment_ids));
1079         $caseActivity['no_attachments'] = count($attachmentIDs);
1080       }
1081
1082       $caseActivities[$caseActivityId]['links']
1083         = CRM_Case_Selector_Search::addCaseActivityLinks($caseID, $contactID, $userID, $context, $dao);
1084     }
1085
1086     $caseActivitiesDT = [];
1087     $caseActivitiesDT['data'] = array_values($caseActivities);
1088     $caseActivitiesDT['recordsTotal'] = $caseCount;
1089     $caseActivitiesDT['recordsFiltered'] = $caseCount;
1090
1091     return $caseActivitiesDT;
1092   }
1093
1094   /**
1095    * Helper function to generate a formatted contact link/name for display in the Case activities tab
1096    *
1097    * @param $contactId
1098    * @param $contactName
1099    *
1100    * @return string
1101    */
1102   private static function formatContactLink($contactId, $contactName) {
1103     if (empty($contactId)) {
1104       return NULL;
1105     }
1106
1107     $hasViewContact = CRM_Contact_BAO_Contact_Permission::allow($contactId);
1108
1109     if ($hasViewContact) {
1110       $contactViewUrl = CRM_Utils_System::url("civicrm/contact/view", "reset=1&cid={$contactId}");
1111       return "<a href=\"{$contactViewUrl}\">" . $contactName . "</a>";
1112     }
1113     else {
1114       return $contactName;
1115     }
1116   }
1117
1118   /**
1119    * Get Case Related Contacts.
1120    *
1121    * @param int $caseID
1122    *   Case id.
1123    * @param bool $includeDetails
1124    *   If true include details of contacts.
1125    *
1126    * @return array
1127    *   array of return properties
1128    *
1129    */
1130   public static function getRelatedContacts($caseID, $includeDetails = TRUE) {
1131     $caseRoles = [];
1132     if ($includeDetails) {
1133       $caseInfo = civicrm_api3('Case', 'getsingle', [
1134         'id' => $caseID,
1135         // Most efficient way of retrieving definition is to also include case type id and name so the api doesn't have to look it up separately
1136         'return' => ['case_type_id', 'case_type_id.name', 'case_type_id.definition', 'contact_id'],
1137       ]);
1138       if (!empty($caseInfo['case_type_id.definition']['caseRoles'])) {
1139         $caseRoles = CRM_Utils_Array::rekey($caseInfo['case_type_id.definition']['caseRoles'], 'name');
1140       }
1141     }
1142
1143     $values = [];
1144     $caseClientCondition = !empty($caseInfo['client_id']) ? "AND cc.id NOT IN (%2)" : '';
1145     $query = <<<HERESQL
1146     SELECT cc.display_name as name, cc.sort_name as sort_name, cc.id, cr.relationship_type_id, crt.label_b_a as role, crt.name_b_a as role_name, crt.name_a_b as role_name_reverse, ce.email, cp.phone
1147     FROM civicrm_relationship cr
1148     JOIN civicrm_relationship_type crt
1149      ON crt.id = cr.relationship_type_id
1150     JOIN civicrm_contact cc
1151      ON cc.id = cr.contact_id_a
1152      AND cc.is_deleted <> 1
1153     LEFT JOIN civicrm_email ce
1154      ON ce.contact_id = cc.id
1155      AND ce.is_primary= 1
1156     LEFT JOIN civicrm_phone cp
1157      ON cp.contact_id = cc.id
1158      AND cp.is_primary= 1
1159     WHERE cr.case_id =  %1
1160      AND cr.is_active
1161      {$caseClientCondition}
1162     UNION
1163     SELECT cc.display_name as name, cc.sort_name as sort_name, cc.id, cr.relationship_type_id, crt.label_a_b as role, crt.name_a_b as role_name, crt.name_b_a as role_name_reverse, ce.email, cp.phone
1164     FROM civicrm_relationship cr
1165     JOIN civicrm_relationship_type crt
1166      ON crt.id = cr.relationship_type_id
1167     JOIN civicrm_contact cc
1168      ON cc.id = cr.contact_id_b
1169      AND cc.is_deleted <> 1
1170     LEFT JOIN civicrm_email ce
1171      ON ce.contact_id = cc.id
1172      AND ce.is_primary= 1
1173     LEFT JOIN civicrm_phone cp
1174      ON cp.contact_id = cc.id
1175      AND cp.is_primary= 1
1176     WHERE cr.case_id =  %1
1177      AND cr.is_active
1178      {$caseClientCondition}
1179 HERESQL;
1180
1181     $params = [
1182       1 => [$caseID, 'Integer'],
1183     ];
1184
1185     if ($caseClientCondition) {
1186       $params[2] = [implode(',', $caseInfo['client_id']), 'CommaSeparatedIntegers'];
1187     }
1188     $dao = CRM_Core_DAO::executeQuery($query, $params);
1189
1190     while ($dao->fetch()) {
1191       if (!$includeDetails) {
1192         $values[$dao->id] = 1;
1193       }
1194       else {
1195         $details = [
1196           'contact_id' => $dao->id,
1197           'display_name' => $dao->name,
1198           'sort_name' => $dao->sort_name,
1199           'relationship_type_id' => $dao->relationship_type_id,
1200           'role' => $dao->role,
1201           'email' => $dao->email,
1202           'phone' => $dao->phone,
1203         ];
1204         // Add more info about the role (creator, manager)
1205         // The XML historically has the reverse direction, so look up reverse.
1206         $role = $caseRoles[$dao->role_name_reverse] ?? NULL;
1207         if ($role) {
1208           unset($role['name']);
1209           $details += $role;
1210         }
1211         $values[] = $details;
1212       }
1213     }
1214
1215     return $values;
1216   }
1217
1218   /**
1219    * Send e-mail copy of activity
1220    *
1221    * @param int $clientId
1222    * @param int $activityId
1223    *   Activity Id.
1224    * @param array $contacts
1225    *   Array of related contact.
1226    *
1227    * @param null $attachments
1228    * @param int $caseId
1229    *
1230    * @return bool |array
1231    */
1232   public static function sendActivityCopy($clientId, $activityId, $contacts, $attachments = NULL, $caseId) {
1233     if (!$activityId) {
1234       return FALSE;
1235     }
1236
1237     $tplParams = $activityInfo = [];
1238     $activityTypeId = CRM_Core_DAO::getFieldValue('CRM_Activity_DAO_Activity', $activityId, 'activity_type_id');
1239     // If it's a case activity
1240     if ($caseId) {
1241       $nonCaseActivityTypes = CRM_Core_PseudoConstant::activityType();
1242       if (!empty($nonCaseActivityTypes[$activityTypeId])) {
1243         $anyActivity = TRUE;
1244       }
1245       else {
1246         $anyActivity = FALSE;
1247       }
1248       $tplParams['isCaseActivity'] = 1;
1249       $tplParams['client_id'] = $clientId;
1250     }
1251     else {
1252       $anyActivity = TRUE;
1253     }
1254
1255     $xmlProcessorProcess = new CRM_Case_XMLProcessor_Process();
1256     $isRedact = $xmlProcessorProcess->getRedactActivityEmail();
1257
1258     $xmlProcessorReport = new CRM_Case_XMLProcessor_Report();
1259
1260     $activityInfo = $xmlProcessorReport->getActivityInfo($clientId, $activityId, $anyActivity, $isRedact);
1261     if ($caseId) {
1262       $activityInfo['fields'][] = ['label' => 'Case ID', 'type' => 'String', 'value' => $caseId];
1263     }
1264     $tplParams['activityTypeName'] = CRM_Core_PseudoConstant::getLabel('CRM_Activity_DAO_Activity', 'activity_type_id', $activityTypeId);
1265     $tplParams['activity'] = $activityInfo;
1266     foreach ($tplParams['activity']['fields'] as $k => $val) {
1267       if (CRM_Utils_Array::value('label', $val) == ts('Subject')) {
1268         $activitySubject = $val['value'];
1269         break;
1270       }
1271     }
1272
1273     // CRM-8926 If user is not logged in, use the activity creator as userID
1274     if (!($userID = CRM_Core_Session::getLoggedInContactID())) {
1275       $userID = CRM_Activity_BAO_Activity::getSourceContactID($activityId);
1276     }
1277
1278     //also create activities simultaneously of this copy.
1279     $activityParams = [];
1280
1281     $activityParams['source_record_id'] = $activityId;
1282     $activityParams['source_contact_id'] = $userID;
1283     $activityParams['activity_type_id'] = CRM_Core_PseudoConstant::getKey('CRM_Activity_DAO_Activity', 'activity_type_id', 'Email');
1284     $activityParams['activity_date_time'] = date('YmdHis');
1285     $activityParams['status_id'] = CRM_Core_PseudoConstant::getKey('CRM_Activity_DAO_Activity', 'activity_status_id', 'Completed');
1286     $activityParams['medium_id'] = CRM_Core_PseudoConstant::getKey('CRM_Activity_DAO_Activity', 'encounter_medium', 'email');
1287     $activityParams['case_id'] = $caseId;
1288     $activityParams['is_auto'] = 0;
1289     $activityParams['target_id'] = $clientId;
1290
1291     $tplParams['activitySubject'] = $activitySubject;
1292
1293     // if it’s a case activity, add hashed id to the template (CRM-5916)
1294     if ($caseId) {
1295       $tplParams['idHash'] = substr(sha1(CIVICRM_SITE_KEY . $caseId), 0, 7);
1296     }
1297
1298     $result = [];
1299     // CRM-20308 get receiptFrom defaults see https://issues.civicrm.org/jira/browse/CRM-20308
1300     $receiptFrom = self::getReceiptFrom($activityId);
1301
1302     $recordedActivityParams = [];
1303
1304     foreach ($contacts as $mail => $info) {
1305       $tplParams['contact'] = $info;
1306       self::buildPermissionLinks($tplParams, $activityParams);
1307
1308       $displayName = $info['display_name'] ?? NULL;
1309
1310       list($result[CRM_Utils_Array::value('contact_id', $info)], $subject, $message, $html) = CRM_Core_BAO_MessageTemplate::sendTemplate(
1311         [
1312           'groupName' => 'msg_tpl_workflow_case',
1313           'valueName' => 'case_activity',
1314           'contactId' => $info['contact_id'] ?? NULL,
1315           'tplParams' => $tplParams,
1316           'from' => $receiptFrom,
1317           'toName' => $displayName,
1318           'toEmail' => $mail,
1319           'attachments' => $attachments,
1320         ]
1321       );
1322
1323       $activityParams['subject'] = ts('%1 - copy sent to %2', [1 => $activitySubject, 2 => $displayName]);
1324       $activityParams['details'] = $message;
1325
1326       if (!empty($result[$info['contact_id']])) {
1327         /*
1328          * Really only need to record one activity with all the targets combined.
1329          * Originally the template was going to possibly have different content, e.g. depending on permissions,
1330          * but it's always the same content at the moment.
1331          */
1332         if (empty($recordedActivityParams)) {
1333           $recordedActivityParams = $activityParams;
1334         }
1335         else {
1336           $recordedActivityParams['subject'] .= "; $displayName";
1337         }
1338         $recordedActivityParams['target_contact_id'][] = $info['contact_id'];
1339       }
1340       else {
1341         unset($result[CRM_Utils_Array::value('contact_id', $info)]);
1342       }
1343     }
1344
1345     if (!empty($recordedActivityParams)) {
1346       $activity = CRM_Activity_BAO_Activity::create($recordedActivityParams);
1347
1348       //create case_activity record if its case activity.
1349       if ($caseId) {
1350         $caseParams = [
1351           'activity_id' => $activity->id,
1352           'case_id' => $caseId,
1353         ];
1354         self::processCaseActivity($caseParams);
1355       }
1356     }
1357
1358     return $result;
1359   }
1360
1361   /**
1362    * Retrieve count of activities having a particular type, and
1363    * associated with a particular case.
1364    *
1365    * @param int $caseId
1366    *   ID of the case.
1367    * @param int $activityTypeId
1368    *   ID of the activity type.
1369    *
1370    * @return array
1371    */
1372   public static function getCaseActivityCount($caseId, $activityTypeId) {
1373     $queryParam = [
1374       1 => [$caseId, 'Integer'],
1375       2 => [$activityTypeId, 'Integer'],
1376     ];
1377     $query = "SELECT count(ca.id) as countact
1378  FROM       civicrm_activity ca
1379  INNER JOIN civicrm_case_activity cca ON ca.id = cca.activity_id
1380  WHERE      ca.activity_type_id = %2
1381  AND       cca.case_id = %1
1382  AND        ca.is_deleted = 0";
1383
1384     $dao = CRM_Core_DAO::executeQuery($query, $queryParam);
1385     if ($dao->fetch()) {
1386       return $dao->countact;
1387     }
1388
1389     return FALSE;
1390   }
1391
1392   /**
1393    * Retrieve the scheduled activity type and date.
1394    *
1395    * @param array $cases
1396    *   Array of contact and case id.
1397    *
1398    * @param string $type
1399    *
1400    * @return array
1401    *   Array of scheduled activity type and date
1402    *
1403    *
1404    */
1405   public static function getNextScheduledActivity($cases, $type = 'upcoming') {
1406     $userID = CRM_Core_Session::getLoggedInContactID();
1407
1408     $caseID = implode(',', $cases['case_id']);
1409     $contactID = implode(',', $cases['contact_id']);
1410
1411     $condition = " civicrm_case_contact.contact_id IN( {$contactID} )
1412  AND civicrm_case.id IN( {$caseID})
1413  AND civicrm_case.is_deleted     = {$cases['case_deleted']}";
1414
1415     $query = self::getCaseActivityQuery($type, $userID, $condition);
1416     $activityTypes = CRM_Activity_BAO_Activity::buildOptions('activity_type_id');
1417
1418     $res = CRM_Core_DAO::executeQuery($query);
1419
1420     $activityInfo = [];
1421     while ($res->fetch()) {
1422       if ($type == 'upcoming') {
1423         $activityInfo[$res->case_id]['date'] = $res->activity_date_time;
1424         $activityInfo[$res->case_id]['type'] = $activityTypes[$res->activity_type_id] ?? NULL;
1425       }
1426       else {
1427         $activityInfo[$res->case_id]['date'] = $res->activity_date_time;
1428         $activityInfo[$res->case_id]['type'] = $activityTypes[$res->activity_type_id] ?? NULL;
1429       }
1430     }
1431
1432     return $activityInfo;
1433   }
1434
1435   /**
1436    * Combine all the exportable fields from the lower levels object.
1437    *
1438    * @return array
1439    *   array of exportable Fields
1440    */
1441   public static function &exportableFields() {
1442     if (!self::$_exportableFields) {
1443       if (!self::$_exportableFields) {
1444         self::$_exportableFields = [];
1445       }
1446
1447       $fields = CRM_Case_DAO_Case::export();
1448       $fields['case_role'] = ['title' => ts('Role in Case')];
1449       $fields['case_type'] = [
1450         'title' => ts('Case Type'),
1451         'name' => 'case_type',
1452       ];
1453       $fields['case_status'] = [
1454         'title' => ts('Case Status'),
1455         'name' => 'case_status',
1456       ];
1457
1458       // add custom data for cases
1459       $fields = array_merge($fields, CRM_Core_BAO_CustomField::getFieldsForImport('Case'));
1460
1461       self::$_exportableFields = $fields;
1462     }
1463     return self::$_exportableFields;
1464   }
1465
1466   /**
1467    * Restore the record that are associated with this case.
1468    *
1469    * @param int $caseId
1470    *   Id of the case to restore.
1471    *
1472    * @return bool
1473    */
1474   public static function restoreCase($caseId) {
1475     //restore activities
1476     $activities = self::getCaseActivityDates($caseId);
1477     if ($activities) {
1478       foreach ($activities as $value) {
1479         CRM_Activity_BAO_Activity::restoreActivity($value);
1480       }
1481     }
1482     //restore case
1483     $case = new CRM_Case_DAO_Case();
1484     $case->id = $caseId;
1485     $case->is_deleted = 0;
1486     $case->save();
1487
1488     //CRM-7364, enable relationships
1489     self::enableDisableCaseRelationships($caseId, TRUE);
1490     return TRUE;
1491   }
1492
1493   /**
1494    * @param $groupInfo
1495    * @param null $sort
1496    * @param null $showLinks
1497    * @param bool $returnOnlyCount
1498    * @param int $offset
1499    * @param int $rowCount
1500    *
1501    * @return array
1502    */
1503   public static function getGlobalContacts(&$groupInfo, $sort = NULL, $showLinks = NULL, $returnOnlyCount = FALSE, $offset = 0, $rowCount = 25) {
1504     $globalContacts = [];
1505
1506     $settingsProcessor = new CRM_Case_XMLProcessor_Settings();
1507     $settings = $settingsProcessor->run();
1508     if (!empty($settings)) {
1509       $groupInfo['name'] = $settings['groupname'];
1510       if ($groupInfo['name']) {
1511         $searchParams = ['name' => $groupInfo['name']];
1512         $results = [];
1513         CRM_Contact_BAO_Group::retrieve($searchParams, $results);
1514         if ($results) {
1515           $groupInfo['id'] = $results['id'];
1516           $groupInfo['title'] = $results['title'];
1517           $params = [['group', '=', $groupInfo['id'], 0, 0]];
1518           $return = ['contact_id' => 1, 'sort_name' => 1, 'display_name' => 1, 'email' => 1, 'phone' => 1];
1519           list($globalContacts) = CRM_Contact_BAO_Query::apiQuery($params, $return, NULL, $sort, $offset, $rowCount, TRUE, $returnOnlyCount, FALSE);
1520
1521           if ($returnOnlyCount) {
1522             return $globalContacts;
1523           }
1524
1525           if ($showLinks) {
1526             foreach ($globalContacts as $idx => $contact) {
1527               $globalContacts[$idx]['sort_name'] = '<a href="' . CRM_Utils_System::url('civicrm/contact/view', "reset=1&cid={$contact['contact_id']}") . '">' . $contact['sort_name'] . '</a>';
1528             }
1529           }
1530         }
1531       }
1532     }
1533     return $globalContacts;
1534   }
1535
1536   /**
1537    * Convenience function to get both case contacts and global in one array.
1538    *
1539    * @param int $caseId
1540    *
1541    * @return array
1542    */
1543   public static function getRelatedAndGlobalContacts($caseId) {
1544     $relatedContacts = self::getRelatedContacts($caseId);
1545
1546     $groupInfo = [];
1547     $globalContacts = self::getGlobalContacts($groupInfo);
1548
1549     //unset values which are not required.
1550     foreach ($globalContacts as $k => & $v) {
1551       unset($v['email_id']);
1552       unset($v['group_contact_id']);
1553       unset($v['status']);
1554       unset($v['phone']);
1555       $v['role'] = $groupInfo['title'];
1556     }
1557     //include multiple listings for the same contact/different roles.
1558     $relatedGlobalContacts = array_merge($relatedContacts, $globalContacts);
1559     return $relatedGlobalContacts;
1560   }
1561
1562   /**
1563    * Get Case ActivitiesDueDates with given criteria.
1564    *
1565    * @param int $caseID
1566    *   Case id.
1567    * @param array $criteriaParams
1568    *   Given criteria.
1569    * @param bool $latestDate
1570    *   If set newest or oldest date is selected.
1571    *
1572    * @return array
1573    *   case activities due dates
1574    *
1575    */
1576   public static function getCaseActivityDates($caseID, $criteriaParams = [], $latestDate = FALSE) {
1577     $values = [];
1578     $selectDate = " ca.activity_date_time";
1579     $where = $groupBy = ' ';
1580
1581     if (!$caseID) {
1582       return NULL;
1583     }
1584
1585     if ($latestDate) {
1586       if (!empty($criteriaParams['activity_type_id'])) {
1587         $where .= " AND ca.activity_type_id    = " . CRM_Utils_Type::escape($criteriaParams['activity_type_id'], 'Integer');
1588         $where .= " AND ca.is_current_revision = 1";
1589         $groupBy .= " GROUP BY ca.activity_type_id, ca.id";
1590       }
1591
1592       if (!empty($criteriaParams['newest'])) {
1593         $selectDate = " max(ca.activity_date_time) ";
1594       }
1595       else {
1596         $selectDate = " min(ca.activity_date_time) ";
1597       }
1598     }
1599
1600     $query = "SELECT ca.id, {$selectDate} as activity_date
1601                   FROM civicrm_activity ca
1602                   LEFT JOIN civicrm_case_activity cca ON cca.activity_id = ca.id LEFT JOIN civicrm_case cc ON cc.id = cca.case_id
1603                   WHERE cc.id = %1 {$where} {$groupBy}";
1604
1605     $params = [1 => [$caseID, 'Integer']];
1606     $dao = CRM_Core_DAO::executeQuery($query, $params);
1607
1608     while ($dao->fetch()) {
1609       $values[$dao->id]['id'] = $dao->id;
1610       $values[$dao->id]['activity_date'] = $dao->activity_date;
1611     }
1612     return $values;
1613   }
1614
1615   /**
1616    * Create activities when Case or Other roles assigned/modified/deleted.
1617    *
1618    * @param int $caseId
1619    * @param int $relationshipId
1620    *   Relationship id.
1621    * @param int $relContactId
1622    *   Case role assignee contactId.
1623    * @param int $contactId
1624    */
1625   public static function createCaseRoleActivity($caseId, $relationshipId, $relContactId = NULL, $contactId = NULL) {
1626     if (!$caseId || !$relationshipId || empty($relationshipId)) {
1627       return;
1628     }
1629
1630     $queryParam = [];
1631     if (is_array($relationshipId)) {
1632       $relationshipId = implode(',', $relationshipId);
1633       $relationshipClause = " civicrm_relationship.id IN ($relationshipId)";
1634     }
1635     else {
1636       $relationshipClause = " civicrm_relationship.id = %1";
1637       $queryParam[1] = [$relationshipId, 'Positive'];
1638     }
1639
1640     $query = "
1641    SELECT  cc.display_name as clientName,
1642            cca.display_name as  assigneeContactName,
1643            civicrm_relationship.case_id as caseId,
1644            civicrm_relationship_type.label_a_b as relation_a_b,
1645            civicrm_relationship_type.label_b_a as relation_b_a,
1646            civicrm_relationship.contact_id_b as rel_contact_id,
1647            civicrm_relationship.contact_id_a as assign_contact_id
1648      FROM  civicrm_relationship_type,  civicrm_relationship
1649  LEFT JOIN  civicrm_contact cc  ON cc.id  = civicrm_relationship.contact_id_b
1650  LEFT JOIN  civicrm_contact cca ON cca.id = civicrm_relationship.contact_id_a
1651     WHERE  civicrm_relationship.relationship_type_id = civicrm_relationship_type.id AND {$relationshipClause}";
1652
1653     $dao = CRM_Core_DAO::executeQuery($query, $queryParam);
1654
1655     while ($dao->fetch()) {
1656       // The assignee is not the client.
1657       if ($dao->rel_contact_id != $contactId) {
1658         $caseRelationship = $dao->relation_a_b;
1659         $assigneContactName = $dao->clientName;
1660         $assigneContactIds[$dao->rel_contact_id] = $dao->rel_contact_id;
1661       }
1662       else {
1663         $caseRelationship = $dao->relation_b_a;
1664         $assigneContactName = $dao->assigneeContactName;
1665         $assigneContactIds[$dao->assign_contact_id] = $dao->assign_contact_id;
1666       }
1667     }
1668
1669     $session = CRM_Core_Session::singleton();
1670     $activityParams = [
1671       'source_contact_id' => $session->get('userID'),
1672       'subject' => $caseRelationship . ' : ' . $assigneContactName,
1673       'activity_date_time' => date('YmdHis'),
1674       'status_id' => CRM_Core_PseudoConstant::getKey('CRM_Activity_BAO_Activity', 'activity_status_id', 'Completed'),
1675     ];
1676
1677     //if $relContactId is passed, role is added or modified.
1678     if (!empty($relContactId)) {
1679       $activityParams['assignee_contact_id'] = $assigneContactIds;
1680       $activityTypeID = CRM_Core_PseudoConstant::getKey('CRM_Activity_BAO_Activity', 'activity_type_id', 'Assign Case Role');
1681     }
1682     else {
1683       $activityTypeID = CRM_Core_PseudoConstant::getKey('CRM_Activity_BAO_Activity', 'activity_type_id', 'Remove Case Role');
1684     }
1685
1686     $activityParams['activity_type_id'] = $activityTypeID;
1687
1688     $activity = CRM_Activity_BAO_Activity::create($activityParams);
1689
1690     //create case_activity record.
1691     $caseParams = [
1692       'activity_id' => $activity->id,
1693       'case_id' => $caseId,
1694     ];
1695
1696     CRM_Case_BAO_Case::processCaseActivity($caseParams);
1697   }
1698
1699   /**
1700    * Get case manger
1701    * contact which is assigned a case role of case manager.
1702    *
1703    * @param int $caseType
1704    *   Case type.
1705    * @param int $caseId
1706    *   Case id.
1707    *
1708    * @return string
1709    *   html hyperlink of manager contact view page
1710    *
1711    */
1712   public static function getCaseManagerContact($caseType, $caseId) {
1713     if (!$caseType || !$caseId) {
1714       return NULL;
1715     }
1716
1717     $caseManagerName = '---';
1718     $xmlProcessor = new CRM_Case_XMLProcessor_Process();
1719
1720     $managerRoleId = $xmlProcessor->getCaseManagerRoleId($caseType);
1721
1722     if (!empty($managerRoleId)) {
1723       if (substr($managerRoleId, -4) == '_a_b') {
1724         $managerRoleQuery = "
1725           SELECT civicrm_contact.id as casemanager_id,
1726                  civicrm_contact.sort_name as casemanager
1727            FROM civicrm_contact
1728            LEFT JOIN civicrm_relationship ON (civicrm_relationship.contact_id_b = civicrm_contact.id AND civicrm_relationship.relationship_type_id = %1) AND civicrm_relationship.is_active
1729            LEFT JOIN civicrm_case ON civicrm_case.id = civicrm_relationship.case_id
1730            WHERE civicrm_case.id = %2 AND is_active = 1";
1731       }
1732       if (substr($managerRoleId, -4) == '_b_a') {
1733         $managerRoleQuery = "
1734           SELECT civicrm_contact.id as casemanager_id,
1735                  civicrm_contact.sort_name as casemanager
1736            FROM civicrm_contact
1737            LEFT JOIN civicrm_relationship ON (civicrm_relationship.contact_id_a = civicrm_contact.id AND civicrm_relationship.relationship_type_id = %1) AND civicrm_relationship.is_active
1738            LEFT JOIN civicrm_case ON civicrm_case.id = civicrm_relationship.case_id
1739            WHERE civicrm_case.id = %2 AND is_active = 1";
1740       }
1741
1742       $managerRoleParams = [
1743         1 => [substr($managerRoleId, 0, -4), 'Integer'],
1744         2 => [$caseId, 'Integer'],
1745       ];
1746
1747       $dao = CRM_Core_DAO::executeQuery($managerRoleQuery, $managerRoleParams);
1748       if ($dao->fetch()) {
1749         $caseManagerName = sprintf('<a href="%s">%s</a>',
1750           CRM_Utils_System::url('civicrm/contact/view', ['cid' => $dao->casemanager_id]),
1751           $dao->casemanager
1752         );
1753       }
1754     }
1755
1756     return $caseManagerName;
1757   }
1758
1759   /**
1760    * @param int $contactId
1761    * @param bool $excludeDeleted
1762    *
1763    * @return int
1764    */
1765   public static function caseCount($contactId = NULL, $excludeDeleted = TRUE) {
1766     $params = ['check_permissions' => TRUE];
1767     if ($excludeDeleted) {
1768       $params['is_deleted'] = 0;
1769     }
1770     if ($contactId) {
1771       $params['contact_id'] = $contactId;
1772     }
1773     try {
1774       return civicrm_api3('Case', 'getcount', $params);
1775     }
1776     catch (CiviCRM_API3_Exception $e) {
1777       // Lack of permissions will throw an exception
1778       return 0;
1779     }
1780   }
1781
1782   /**
1783    * Retrieve related case ids for given case.
1784    *
1785    * @param int $caseId
1786    * @param bool $excludeDeleted
1787    *   Do not include deleted cases.
1788    *
1789    * @return array
1790    */
1791   public static function getRelatedCaseIds($caseId, $excludeDeleted = TRUE) {
1792     //FIXME : do check for permissions.
1793
1794     if (!$caseId) {
1795       return [];
1796     }
1797
1798     $linkActType = CRM_Core_PseudoConstant::getKey('CRM_Activity_BAO_Activity', 'activity_type_id', 'Link Cases');
1799     if (!$linkActType) {
1800       return [];
1801     }
1802
1803     $whereClause = "mainCase.id = %2";
1804     if ($excludeDeleted) {
1805       $whereClause .= " AND ( relAct.is_deleted = 0 OR relAct.is_deleted IS NULL )";
1806     }
1807
1808     $query = "
1809     SELECT  relCaseAct.case_id
1810       FROM  civicrm_case mainCase
1811  INNER JOIN  civicrm_case_activity mainCaseAct ON (mainCaseAct.case_id = mainCase.id)
1812  INNER JOIN  civicrm_activity mainAct          ON (mainCaseAct.activity_id = mainAct.id AND mainAct.activity_type_id = %1)
1813  INNER JOIN  civicrm_case_activity relCaseAct  ON (relCaseAct.activity_id = mainAct.id AND mainCaseAct.id !=  relCaseAct.id)
1814  INNER JOIN  civicrm_activity relAct           ON (relCaseAct.activity_id = relAct.id  AND relAct.activity_type_id = %1)
1815      WHERE  $whereClause";
1816
1817     $dao = CRM_Core_DAO::executeQuery($query, [
1818       1 => [$linkActType, 'Integer'],
1819       2 => [$caseId, 'Integer'],
1820     ]);
1821     $relatedCaseIds = [];
1822     while ($dao->fetch()) {
1823       $relatedCaseIds[$dao->case_id] = $dao->case_id;
1824     }
1825
1826     return array_values($relatedCaseIds);
1827   }
1828
1829   /**
1830    * Retrieve related case details for given case.
1831    *
1832    * @param int $caseId
1833    * @param bool $excludeDeleted
1834    *   Do not include deleted cases.
1835    *
1836    * @return array
1837    */
1838   public static function getRelatedCases($caseId, $excludeDeleted = TRUE) {
1839     $relatedCaseIds = self::getRelatedCaseIds($caseId, $excludeDeleted);
1840     $relatedCases = [];
1841
1842     if (!$relatedCaseIds) {
1843       return [];
1844     }
1845
1846     $whereClause = 'relCase.id IN ( ' . implode(',', $relatedCaseIds) . ' )';
1847     if ($excludeDeleted) {
1848       $whereClause .= " AND ( relCase.is_deleted = 0 OR relCase.is_deleted IS NULL )";
1849     }
1850
1851     //filter for permissioned cases.
1852     $filterCases = [];
1853     $doFilterCases = FALSE;
1854     if (!CRM_Core_Permission::check('access all cases and activities')) {
1855       $doFilterCases = TRUE;
1856       $filterCases = CRM_Case_BAO_Case::getCases(FALSE);
1857     }
1858
1859     //2. fetch the details of related cases.
1860     $query = "
1861     SELECT  relCase.id as id,
1862             civicrm_case_type.title as case_type,
1863             client.display_name as client_name,
1864             client.id as client_id,
1865             relCase.status_id
1866       FROM  civicrm_case relCase
1867  INNER JOIN  civicrm_case_contact relCaseContact ON ( relCase.id = relCaseContact.case_id )
1868  INNER JOIN  civicrm_contact      client         ON ( client.id = relCaseContact.contact_id )
1869  LEFT JOIN  civicrm_case_type ON relCase.case_type_id = civicrm_case_type.id
1870      WHERE  {$whereClause}";
1871
1872     $dao = CRM_Core_DAO::executeQuery($query);
1873     $contactViewUrl = CRM_Utils_System::url("civicrm/contact/view", "reset=1&cid=");
1874     $hasViewContact = CRM_Core_Permission::giveMeAllACLs();
1875     $statuses = CRM_Case_BAO_Case::buildOptions('status_id');
1876
1877     while ($dao->fetch()) {
1878       $caseView = NULL;
1879       if (!$doFilterCases || array_key_exists($dao->id, $filterCases)) {
1880         $caseViewStr = "reset=1&id={$dao->id}&cid={$dao->client_id}&action=view&context=case&selectedChild=case";
1881         $caseViewUrl = CRM_Utils_System::url("civicrm/contact/view/case", $caseViewStr);
1882         $caseView = "<a class='action-item no-popup crm-hover-button' href='{$caseViewUrl}'>" . ts('View Case') . "</a>";
1883       }
1884       $clientView = $dao->client_name;
1885       if ($hasViewContact) {
1886         $clientView = "<a href='{$contactViewUrl}{$dao->client_id}'>$dao->client_name</a>";
1887       }
1888
1889       $relatedCases[$dao->id] = [
1890         'case_id' => $dao->id,
1891         'case_type' => $dao->case_type,
1892         'client_name' => $clientView,
1893         'case_status' => $statuses[$dao->status_id],
1894         'links' => $caseView,
1895       ];
1896     }
1897
1898     return $relatedCases;
1899   }
1900
1901   /**
1902    * Merge two duplicate contacts' cases - follow CRM-5758 rules.
1903    *
1904    * @param int $mainContactId
1905    * @param int $otherContactId
1906    *
1907    * @see CRM_Dedupe_Merger::cpTables()
1908    *
1909    * TODO: use the 3rd $sqls param to append sql statements rather than executing them here
1910    *
1911    */
1912   public static function mergeContacts($mainContactId, $otherContactId) {
1913     self::mergeCases($mainContactId, NULL, $otherContactId);
1914   }
1915
1916   /**
1917    * Function perform two task.
1918    * 1. Merge two duplicate contacts cases - follow CRM-5758 rules.
1919    * 2. Merge two cases of same contact - follow CRM-5598 rules.
1920    *
1921    * @param int $mainContactId
1922    *   Contact id of main contact record.
1923    * @param int $mainCaseId
1924    *   Case id of main case record.
1925    * @param int $otherContactId
1926    *   Contact id of record which is going to merge.
1927    * @param int $otherCaseId
1928    *   Case id of record which is going to merge.
1929    *
1930    * @param bool $changeClient
1931    *
1932    * @return int|null
1933    * @throws \CRM_Core_Exception
1934    */
1935   public static function mergeCases(
1936     $mainContactId, $mainCaseId = NULL, $otherContactId = NULL,
1937     $otherCaseId = NULL, $changeClient = FALSE) {
1938     $moveToTrash = TRUE;
1939
1940     $duplicateContacts = FALSE;
1941     if ($mainContactId && $otherContactId &&
1942       $mainContactId != $otherContactId
1943     ) {
1944       $duplicateContacts = TRUE;
1945     }
1946
1947     $duplicateCases = FALSE;
1948     if ($mainCaseId && $otherCaseId &&
1949       $mainCaseId != $otherCaseId
1950     ) {
1951       $duplicateCases = TRUE;
1952     }
1953
1954     $mainCaseIds = [];
1955     if (!$duplicateContacts && !$duplicateCases) {
1956       return $mainCaseIds;
1957     }
1958
1959     $activityTypes = CRM_Activity_BAO_Activity::buildOptions('activity_type_id', 'validate');
1960     $completedActivityStatus = CRM_Core_PseudoConstant::getKey('CRM_Activity_BAO_Activity', 'activity_status_id', 'Completed');
1961     $activityContacts = CRM_Activity_BAO_ActivityContact::buildOptions('record_type_id', 'validate');
1962     $sourceID = CRM_Utils_Array::key('Activity Source', $activityContacts);
1963     $assigneeID = CRM_Utils_Array::key('Activity Assignees', $activityContacts);
1964     $targetID = CRM_Utils_Array::key('Activity Targets', $activityContacts);
1965
1966     $processCaseIds = [$otherCaseId];
1967     if ($duplicateContacts && !$duplicateCases) {
1968       if ($changeClient) {
1969         $processCaseIds = [$mainCaseId];
1970       }
1971       else {
1972         //get all case ids for other contact.
1973         $processCaseIds = self::retrieveCaseIdsByContactId($otherContactId, TRUE);
1974       }
1975       if (!is_array($processCaseIds)) {
1976         return;
1977       }
1978     }
1979
1980     $session = CRM_Core_Session::singleton();
1981     $currentUserId = $session->get('userID');
1982
1983     CRM_Utils_Hook::pre_case_merge($mainContactId, $mainCaseId, $otherContactId, $otherCaseId, $changeClient);
1984
1985     // copy all cases and connect to main contact id.
1986     foreach ($processCaseIds as $otherCaseId) {
1987       if ($duplicateContacts) {
1988         $mainCase = CRM_Core_DAO::copyGeneric('CRM_Case_DAO_Case', ['id' => $otherCaseId]);
1989         $mainCaseId = $mainCase->id;
1990         if (!$mainCaseId) {
1991           continue;
1992         }
1993
1994         $mainCaseIds[] = $mainCaseId;
1995         //insert record for case contact.
1996         $otherCaseContact = new CRM_Case_DAO_CaseContact();
1997         $otherCaseContact->case_id = $otherCaseId;
1998         $otherCaseContact->find();
1999         while ($otherCaseContact->fetch()) {
2000           $mainCaseContact = new CRM_Case_DAO_CaseContact();
2001           $mainCaseContact->case_id = $mainCaseId;
2002           $mainCaseContact->contact_id = $otherCaseContact->contact_id;
2003           if ($mainCaseContact->contact_id == $otherContactId) {
2004             $mainCaseContact->contact_id = $mainContactId;
2005           }
2006           //avoid duplicate object.
2007           if (!$mainCaseContact->find(TRUE)) {
2008             $mainCaseContact->save();
2009           }
2010         }
2011       }
2012       elseif (!$otherContactId) {
2013         $otherContactId = $mainContactId;
2014       }
2015
2016       if (!$mainCaseId || !$otherCaseId ||
2017         !$mainContactId || !$otherContactId
2018       ) {
2019         continue;
2020       }
2021
2022       // get all activities for other case.
2023       $otherCaseActivities = [];
2024       CRM_Core_DAO::commonRetrieveAll('CRM_Case_DAO_CaseActivity', 'case_id', $otherCaseId, $otherCaseActivities);
2025
2026       //for duplicate cases do not process singleton activities.
2027       $otherActivityIds = $singletonActivityIds = [];
2028       foreach ($otherCaseActivities as $caseActivityId => $otherIds) {
2029         $otherActId = $otherIds['activity_id'] ?? NULL;
2030         if (!$otherActId || in_array($otherActId, $otherActivityIds)) {
2031           continue;
2032         }
2033         $otherActivityIds[] = $otherActId;
2034       }
2035       if ($duplicateCases) {
2036         if ($openCaseType = array_search('Open Case', $activityTypes)) {
2037           $sql = "
2038 SELECT  id
2039   FROM  civicrm_activity
2040  WHERE  activity_type_id = $openCaseType
2041    AND  id IN ( " . implode(',', array_values($otherActivityIds)) . ');';
2042           $dao = CRM_Core_DAO::executeQuery($sql);
2043           while ($dao->fetch()) {
2044             $singletonActivityIds[] = $dao->id;
2045           }
2046         }
2047       }
2048
2049       // migrate all activities and connect to main contact.
2050       $copiedActivityIds = $activityMappingIds = [];
2051       sort($otherActivityIds);
2052       foreach ($otherActivityIds as $otherActivityId) {
2053
2054         //for duplicate cases -
2055         //do not migrate singleton activities.
2056         if (!$otherActivityId || in_array($otherActivityId, $singletonActivityIds)) {
2057           continue;
2058         }
2059
2060         //migrate activity record.
2061         $otherActivity = new CRM_Activity_DAO_Activity();
2062         $otherActivity->id = $otherActivityId;
2063         if (!$otherActivity->find(TRUE)) {
2064           continue;
2065         }
2066
2067         $mainActVals = [];
2068         $mainActivity = new CRM_Activity_DAO_Activity();
2069         CRM_Core_DAO::storeValues($otherActivity, $mainActVals);
2070         $mainActivity->copyValues($mainActVals);
2071         $mainActivity->id = NULL;
2072         $mainActivity->activity_date_time = CRM_Utils_Date::isoToMysql($otherActivity->activity_date_time);
2073         $mainActivity->source_record_id = CRM_Utils_Array::value($mainActivity->source_record_id,
2074           $activityMappingIds
2075         );
2076
2077         $mainActivity->original_id = CRM_Utils_Array::value($mainActivity->original_id,
2078           $activityMappingIds
2079         );
2080
2081         $mainActivity->parent_id = CRM_Utils_Array::value($mainActivity->parent_id,
2082           $activityMappingIds
2083         );
2084         $mainActivity->save();
2085         $mainActivityId = $mainActivity->id;
2086         if (!$mainActivityId) {
2087           continue;
2088         }
2089
2090         $activityMappingIds[$otherActivityId] = $mainActivityId;
2091         // insert log of all activities
2092         CRM_Activity_BAO_Activity::logActivityAction($mainActivity);
2093
2094         $copiedActivityIds[] = $otherActivityId;
2095
2096         //create case activity record.
2097         $mainCaseActivity = new CRM_Case_DAO_CaseActivity();
2098         $mainCaseActivity->case_id = $mainCaseId;
2099         $mainCaseActivity->activity_id = $mainActivityId;
2100         $mainCaseActivity->save();
2101
2102         //migrate source activity.
2103         $otherSourceActivity = new CRM_Activity_DAO_ActivityContact();
2104         $otherSourceActivity->activity_id = $otherActivityId;
2105         $otherSourceActivity->record_type_id = $sourceID;
2106         $otherSourceActivity->find();
2107         while ($otherSourceActivity->fetch()) {
2108           $mainActivitySource = new CRM_Activity_DAO_ActivityContact();
2109           $mainActivitySource->record_type_id = $sourceID;
2110           $mainActivitySource->activity_id = $mainActivityId;
2111           $mainActivitySource->contact_id = $otherSourceActivity->contact_id;
2112           if ($mainActivitySource->contact_id == $otherContactId) {
2113             $mainActivitySource->contact_id = $mainContactId;
2114           }
2115           //avoid duplicate object.
2116           if (!$mainActivitySource->find(TRUE)) {
2117             $mainActivitySource->save();
2118           }
2119         }
2120
2121         //migrate target activities.
2122         $otherTargetActivity = new CRM_Activity_DAO_ActivityContact();
2123         $otherTargetActivity->activity_id = $otherActivityId;
2124         $otherTargetActivity->record_type_id = $targetID;
2125         $otherTargetActivity->find();
2126         while ($otherTargetActivity->fetch()) {
2127           $mainActivityTarget = new CRM_Activity_DAO_ActivityContact();
2128           $mainActivityTarget->record_type_id = $targetID;
2129           $mainActivityTarget->activity_id = $mainActivityId;
2130           $mainActivityTarget->contact_id = $otherTargetActivity->contact_id;
2131           if ($mainActivityTarget->contact_id == $otherContactId) {
2132             $mainActivityTarget->contact_id = $mainContactId;
2133           }
2134           //avoid duplicate object.
2135           if (!$mainActivityTarget->find(TRUE)) {
2136             $mainActivityTarget->save();
2137           }
2138         }
2139
2140         //migrate assignee activities.
2141         $otherAssigneeActivity = new CRM_Activity_DAO_ActivityContact();
2142         $otherAssigneeActivity->activity_id = $otherActivityId;
2143         $otherAssigneeActivity->record_type_id = $assigneeID;
2144         $otherAssigneeActivity->find();
2145         while ($otherAssigneeActivity->fetch()) {
2146           $mainAssigneeActivity = new CRM_Activity_DAO_ActivityContact();
2147           $mainAssigneeActivity->activity_id = $mainActivityId;
2148           $mainAssigneeActivity->record_type_id = $assigneeID;
2149           $mainAssigneeActivity->contact_id = $otherAssigneeActivity->contact_id;
2150           if ($mainAssigneeActivity->contact_id == $otherContactId) {
2151             $mainAssigneeActivity->contact_id = $mainContactId;
2152           }
2153           //avoid duplicate object.
2154           if (!$mainAssigneeActivity->find(TRUE)) {
2155             $mainAssigneeActivity->save();
2156           }
2157         }
2158
2159         // copy custom fields and attachments
2160         $aparams = [
2161           'activityID' => $otherActivityId,
2162           'mainActivityId' => $mainActivityId,
2163         ];
2164         CRM_Activity_BAO_Activity::copyExtendedActivityData($aparams);
2165       }
2166
2167       //copy case relationship.
2168       if ($duplicateContacts) {
2169         //migrate relationship records.
2170         $otherRelationship = new CRM_Contact_DAO_Relationship();
2171         $otherRelationship->case_id = $otherCaseId;
2172         $otherRelationship->find();
2173         $otherRelationshipIds = [];
2174         while ($otherRelationship->fetch()) {
2175           $otherRelVals = [];
2176           $updateOtherRel = FALSE;
2177           CRM_Core_DAO::storeValues($otherRelationship, $otherRelVals);
2178
2179           $mainRelationship = new CRM_Contact_DAO_Relationship();
2180           $mainRelationship->copyValues($otherRelVals);
2181           $mainRelationship->id = NULL;
2182           $mainRelationship->case_id = $mainCaseId;
2183           if ($mainRelationship->contact_id_a == $otherContactId) {
2184             $updateOtherRel = TRUE;
2185             $mainRelationship->contact_id_a = $mainContactId;
2186           }
2187
2188           //case creator change only when we merge user contact.
2189           if ($mainRelationship->contact_id_b == $otherContactId) {
2190             //do not change creator for change client.
2191             if (!$changeClient) {
2192               $updateOtherRel = TRUE;
2193               $mainRelationship->contact_id_b = ($currentUserId) ? $currentUserId : $mainContactId;
2194             }
2195           }
2196           $mainRelationship->end_date = CRM_Utils_Date::isoToMysql($otherRelationship->end_date);
2197           $mainRelationship->start_date = CRM_Utils_Date::isoToMysql($otherRelationship->start_date);
2198
2199           //avoid duplicate object.
2200           if (!$mainRelationship->find(TRUE)) {
2201             $mainRelationship->save();
2202           }
2203
2204           //get the other relationship ids to update end date.
2205           if ($updateOtherRel) {
2206             $otherRelationshipIds[$otherRelationship->id] = $otherRelationship->id;
2207           }
2208         }
2209
2210         //update other relationships end dates
2211         if (!empty($otherRelationshipIds)) {
2212           $sql = 'UPDATE  civicrm_relationship
2213                                SET  end_date = CURDATE()
2214                              WHERE  id IN ( ' . implode(',', $otherRelationshipIds) . ')';
2215           CRM_Core_DAO::executeQuery($sql);
2216         }
2217       }
2218
2219       //move other case to trash.
2220       $mergeCase = self::deleteCase($otherCaseId, $moveToTrash);
2221       if (!$mergeCase) {
2222         continue;
2223       }
2224
2225       $mergeActSubject = $mergeActSubjectDetails = $mergeActType = '';
2226       if ($changeClient) {
2227         $mainContactDisplayName = CRM_Contact_BAO_Contact::displayName($mainContactId);
2228         $otherContactDisplayName = CRM_Contact_BAO_Contact::displayName($otherContactId);
2229
2230         $mergeActType = array_search('Reassigned Case', $activityTypes);
2231         $mergeActSubject = ts("Case %1 reassigned client from %2 to %3. New Case ID is %4.",
2232           [
2233             1 => $otherCaseId,
2234             2 => $otherContactDisplayName,
2235             3 => $mainContactDisplayName,
2236             4 => $mainCaseId,
2237           ]
2238         );
2239       }
2240       elseif ($duplicateContacts) {
2241         $mergeActType = array_search('Merge Case', $activityTypes);
2242         $mergeActSubject = ts("Case %1 copied from contact id %2 to contact id %3 via merge. New Case ID is %4.",
2243           [
2244             1 => $otherCaseId,
2245             2 => $otherContactId,
2246             3 => $mainContactId,
2247             4 => $mainCaseId,
2248           ]
2249         );
2250       }
2251       else {
2252         $mergeActType = array_search('Merge Case', $activityTypes);
2253         $mergeActSubject = ts("Case %1 merged into case %2", [1 => $otherCaseId, 2 => $mainCaseId]);
2254         if (!empty($copiedActivityIds)) {
2255           $sql = '
2256 SELECT id, subject, activity_date_time, activity_type_id
2257 FROM civicrm_activity
2258 WHERE id IN (' . implode(',', $copiedActivityIds) . ')';
2259           $dao = CRM_Core_DAO::executeQuery($sql);
2260           while ($dao->fetch()) {
2261             $mergeActSubjectDetails .= "{$dao->activity_date_time} :: {$activityTypes[$dao->activity_type_id]}";
2262             if ($dao->subject) {
2263               $mergeActSubjectDetails .= " :: {$dao->subject}";
2264             }
2265             $mergeActSubjectDetails .= "<br />";
2266           }
2267         }
2268       }
2269
2270       // Create merge activity record. Source for merge activity is the logged in user's contact ID ($currentUserId).
2271       $activityParams = [
2272         'subject' => $mergeActSubject,
2273         'details' => $mergeActSubjectDetails,
2274         'status_id' => $completedActivityStatus,
2275         'activity_type_id' => $mergeActType,
2276         'source_contact_id' => $currentUserId,
2277         'activity_date_time' => date('YmdHis'),
2278       ];
2279
2280       $mergeActivity = CRM_Activity_BAO_Activity::create($activityParams);
2281       $mergeActivityId = $mergeActivity->id;
2282       if (!$mergeActivityId) {
2283         continue;
2284       }
2285
2286       //connect merge activity to case.
2287       $mergeCaseAct = [
2288         'case_id' => $mainCaseId,
2289         'activity_id' => $mergeActivityId,
2290       ];
2291
2292       self::processCaseActivity($mergeCaseAct);
2293     }
2294
2295     CRM_Utils_Hook::post_case_merge($mainContactId, $mainCaseId, $otherContactId, $otherCaseId, $changeClient);
2296
2297     return $mainCaseIds;
2298   }
2299
2300   /**
2301    * Validate contact permission for
2302    * edit/view on activity record and build links.
2303    *
2304    * @param array $tplParams
2305    *   Params to be sent to template for sending email.
2306    * @param array $activityParams
2307    *   Info of the activity.
2308    */
2309   public static function buildPermissionLinks(&$tplParams, $activityParams) {
2310     $activityTypeId = CRM_Core_DAO::getFieldValue('CRM_Activity_DAO_Activity', $activityParams['source_record_id'],
2311       'activity_type_id', 'id'
2312     );
2313
2314     if (!empty($tplParams['isCaseActivity'])) {
2315       $tplParams['editActURL'] = CRM_Utils_System::url('civicrm/case/activity',
2316         "reset=1&cid={$activityParams['target_id']}&caseid={$activityParams['case_id']}&action=update&id={$activityParams['source_record_id']}", TRUE
2317       );
2318
2319       $tplParams['viewActURL'] = CRM_Utils_System::url('civicrm/case/activity/view',
2320         "reset=1&aid={$activityParams['source_record_id']}&cid={$activityParams['target_id']}&caseID={$activityParams['case_id']}", TRUE
2321       );
2322
2323       $tplParams['manageCaseURL'] = CRM_Utils_System::url('civicrm/contact/view/case',
2324         "reset=1&id={$activityParams['case_id']}&cid={$activityParams['target_id']}&action=view&context=home", TRUE
2325       );
2326     }
2327     else {
2328       $tplParams['editActURL'] = CRM_Utils_System::url('civicrm/contact/view/activity',
2329         "atype=$activityTypeId&action=update&reset=1&id={$activityParams['source_record_id']}&cid={$tplParams['contact']['contact_id']}&context=activity", TRUE
2330       );
2331
2332       $tplParams['viewActURL'] = CRM_Utils_System::url('civicrm/contact/view/activity',
2333         "atype=$activityTypeId&action=view&reset=1&id={$activityParams['source_record_id']}&cid={$tplParams['contact']['contact_id']}&context=activity", TRUE
2334       );
2335     }
2336   }
2337
2338   /**
2339    * Validate contact permission for
2340    * given operation on activity record.
2341    *
2342    * @param int $activityId
2343    *   Activity record id.
2344    * @param string $operation
2345    *   User operation.
2346    * @param int $actTypeId
2347    *   Activity type id.
2348    * @param int $contactId
2349    *   Contact id/if not pass consider logged in.
2350    * @param bool $checkComponent
2351    *   Do we need to check component enabled.
2352    *
2353    * @return bool
2354    */
2355   public static function checkPermission($activityId, $operation, $actTypeId = NULL, $contactId = NULL, $checkComponent = TRUE) {
2356     $allow = FALSE;
2357     if (!$actTypeId && $activityId) {
2358       $actTypeId = CRM_Core_DAO::getFieldValue('CRM_Activity_DAO_Activity', $activityId, 'activity_type_id');
2359     }
2360
2361     if (!$activityId || !$operation || !$actTypeId) {
2362       return $allow;
2363     }
2364
2365     //do check for civicase component enabled.
2366     if ($checkComponent && !self::enabled()) {
2367       return $allow;
2368     }
2369
2370     //do check for cases.
2371     $caseActOperations = [
2372       'File On Case',
2373       'Link Cases',
2374       'Move To Case',
2375       'Copy To Case',
2376     ];
2377
2378     if (in_array($operation, $caseActOperations)) {
2379       static $caseCount;
2380       if (!isset($caseCount)) {
2381         try {
2382           $caseCount = civicrm_api3('Case', 'getcount', [
2383             'check_permissions' => TRUE,
2384             'status_id' => ['!=' => 'Closed'],
2385             'is_deleted' => 0,
2386             'end_date' => ['IS NULL' => 1],
2387           ]);
2388         }
2389         catch (CiviCRM_API3_Exception $e) {
2390           // Lack of permissions will throw an exception
2391           $caseCount = 0;
2392         }
2393       }
2394       if ($operation == 'File On Case') {
2395         $allow = !empty($caseCount);
2396       }
2397       else {
2398         $allow = ($caseCount > 1);
2399       }
2400     }
2401
2402     $actionOperations = ['view', 'edit', 'delete'];
2403     if (in_array($operation, $actionOperations)) {
2404
2405       //do cache when user has non/supper permission.
2406       static $allowOperations;
2407
2408       if (!is_array($allowOperations) ||
2409         !array_key_exists($operation, $allowOperations)
2410       ) {
2411
2412         if (!$contactId) {
2413           $session = CRM_Core_Session::singleton();
2414           $contactId = $session->get('userID');
2415         }
2416
2417         //check for permissions.
2418         $permissions = [
2419           'view' => [
2420             'access my cases and activities',
2421             'access all cases and activities',
2422           ],
2423           'edit' => [
2424             'access my cases and activities',
2425             'access all cases and activities',
2426           ],
2427           'delete' => ['delete activities'],
2428         ];
2429
2430         //check for core permission.
2431         $hasPermissions = [];
2432         $checkPermissions = $permissions[$operation] ?? NULL;
2433         if (is_array($checkPermissions)) {
2434           foreach ($checkPermissions as $per) {
2435             if (CRM_Core_Permission::check($per)) {
2436               $hasPermissions[$operation][] = $per;
2437             }
2438           }
2439         }
2440
2441         //has permissions.
2442         if (!empty($hasPermissions)) {
2443           //need to check activity object specific.
2444           if (in_array($operation, [
2445             'view',
2446             'edit',
2447           ])
2448           ) {
2449             //do we have supper permission.
2450             if (in_array('access all cases and activities', $hasPermissions[$operation])) {
2451               $allowOperations[$operation] = $allow = TRUE;
2452             }
2453             else {
2454               //user has only access to my cases and activity.
2455               //here object specific permmions come in picture.
2456
2457               //edit - contact must be source or assignee
2458               //view - contact must be source/assignee/target
2459               $isTarget = $isAssignee = $isSource = FALSE;
2460               $activityContacts = CRM_Activity_BAO_ActivityContact::buildOptions('record_type_id', 'validate');
2461               $sourceID = CRM_Utils_Array::key('Activity Source', $activityContacts);
2462               $assigneeID = CRM_Utils_Array::key('Activity Assignees', $activityContacts);
2463               $targetID = CRM_Utils_Array::key('Activity Targets', $activityContacts);
2464
2465               $target = new CRM_Activity_DAO_ActivityContact();
2466               $target->record_type_id = $targetID;
2467               $target->activity_id = $activityId;
2468               $target->contact_id = $contactId;
2469               if ($target->find(TRUE)) {
2470                 $isTarget = TRUE;
2471               }
2472
2473               $assignee = new CRM_Activity_DAO_ActivityContact();
2474               $assignee->activity_id = $activityId;
2475               $assignee->record_type_id = $assigneeID;
2476               $assignee->contact_id = $contactId;
2477               if ($assignee->find(TRUE)) {
2478                 $isAssignee = TRUE;
2479               }
2480
2481               $source = new CRM_Activity_DAO_ActivityContact();
2482               $source->activity_id = $activityId;
2483               $source->record_type_id = $sourceID;
2484               $source->contact_id = $contactId;
2485               if ($source->find(TRUE)) {
2486                 $isSource = TRUE;
2487               }
2488
2489               if ($operation == 'edit') {
2490                 if ($isAssignee || $isSource) {
2491                   $allow = TRUE;
2492                 }
2493               }
2494               if ($operation == 'view') {
2495                 if ($isTarget || $isAssignee || $isSource) {
2496                   $allow = TRUE;
2497                 }
2498               }
2499             }
2500           }
2501           elseif (is_array($hasPermissions[$operation])) {
2502             $allowOperations[$operation] = $allow = TRUE;
2503           }
2504         }
2505         else {
2506           //contact do not have permission.
2507           $allowOperations[$operation] = FALSE;
2508         }
2509       }
2510       else {
2511         //use cache.
2512         //here contact might have supper/non permission.
2513         $allow = $allowOperations[$operation];
2514       }
2515     }
2516
2517     //do further only when operation is granted.
2518     if ($allow) {
2519       $actTypeName = CRM_Core_PseudoConstant::getName('CRM_Activity_BAO_Activity', 'activity_type_id', $actTypeId);
2520
2521       //do not allow multiple copy / edit action.
2522       $singletonNames = [
2523         'Open Case',
2524         'Reassigned Case',
2525         'Merge Case',
2526         'Link Cases',
2527         'Assign Case Role',
2528         'Email',
2529         'Inbound Email',
2530       ];
2531
2532       //do not allow to delete these activities, CRM-4543
2533       $doNotDeleteNames = ['Open Case', 'Change Case Type', 'Change Case Status', 'Change Case Start Date'];
2534
2535       //allow edit operation.
2536       $allowEditNames = ['Open Case'];
2537
2538       if (CRM_Activity_BAO_Activity::checkEditInboundEmailsPermissions()) {
2539         $allowEditNames[] = 'Inbound Email';
2540       }
2541
2542       // do not allow File on Case
2543       $doNotFileNames = [
2544         'Open Case',
2545         'Change Case Type',
2546         'Change Case Status',
2547         'Change Case Start Date',
2548         'Reassigned Case',
2549         'Merge Case',
2550         'Link Cases',
2551         'Assign Case Role',
2552       ];
2553
2554       if (in_array($actTypeName, $singletonNames)) {
2555         $allow = FALSE;
2556         if ($operation == 'File On Case') {
2557           $allow = !in_array($actTypeName, $doNotFileNames);
2558         }
2559         if (in_array($operation, $actionOperations)) {
2560           $allow = TRUE;
2561           if ($operation == 'edit') {
2562             $allow = in_array($actTypeName, $allowEditNames);
2563           }
2564           elseif ($operation == 'delete') {
2565             $allow = !in_array($actTypeName, $doNotDeleteNames);
2566           }
2567         }
2568       }
2569       if ($allow && ($operation == 'delete') &&
2570         in_array($actTypeName, $doNotDeleteNames)
2571       ) {
2572         $allow = FALSE;
2573       }
2574
2575       if ($allow && ($operation == 'File On Case') &&
2576         in_array($actTypeName, $doNotFileNames)
2577       ) {
2578         $allow = FALSE;
2579       }
2580
2581       //check settings file for masking actions
2582       //on the basis the activity types
2583       //hide Edit link if activity type is NOT editable
2584       //(special case activities).CRM-5871
2585       if ($allow && in_array($operation, $actionOperations)) {
2586         static $actionFilter = [];
2587         if (!array_key_exists($operation, $actionFilter)) {
2588           $xmlProcessor = new CRM_Case_XMLProcessor_Process();
2589           $actionFilter[$operation] = $xmlProcessor->get('Settings', 'ActivityTypes', FALSE, $operation);
2590         }
2591         if (array_key_exists($operation, $actionFilter[$operation]) &&
2592           in_array($actTypeId, $actionFilter[$operation][$operation])
2593         ) {
2594           $allow = FALSE;
2595         }
2596       }
2597     }
2598
2599     return $allow;
2600   }
2601
2602   /**
2603    * Since we drop 'access CiviCase', allow access
2604    * if user has 'access my cases and activities'
2605    * or 'access all cases and activities'
2606    */
2607   public static function accessCiviCase() {
2608     if (!self::enabled()) {
2609       return FALSE;
2610     }
2611
2612     if (CRM_Core_Permission::check('access my cases and activities') ||
2613       CRM_Core_Permission::check('access all cases and activities')
2614     ) {
2615       return TRUE;
2616     }
2617
2618     return FALSE;
2619   }
2620
2621   /**
2622    * Verify user has permission to access a case.
2623    *
2624    * @param int $caseId
2625    * @param bool $denyClosed
2626    *   Set TRUE if one wants closed cases to be treated as inaccessible.
2627    *
2628    * @return bool
2629    */
2630   public static function accessCase($caseId, $denyClosed = TRUE) {
2631     if (!$caseId || !self::enabled()) {
2632       return FALSE;
2633     }
2634
2635     $params = ['id' => $caseId, 'check_permissions' => TRUE];
2636     if ($denyClosed && !CRM_Core_Permission::check('access all cases and activities')) {
2637       $params['status_id'] = ['!=' => 'Closed'];
2638     }
2639     try {
2640       return (bool) civicrm_api3('Case', 'getcount', $params);
2641     }
2642     catch (CiviCRM_API3_Exception $e) {
2643       // Lack of permissions will throw an exception
2644       return FALSE;
2645     }
2646   }
2647
2648   /**
2649    * Check whether activity is a case Activity.
2650    *
2651    * @param int $activityID
2652    *   Activity id.
2653    *
2654    * @return bool
2655    */
2656   public static function isCaseActivity($activityID) {
2657     $isCaseActivity = FALSE;
2658     if ($activityID) {
2659       $params = [1 => [$activityID, 'Integer']];
2660       $query = "SELECT id FROM civicrm_case_activity WHERE activity_id = %1";
2661       if (CRM_Core_DAO::singleValueQuery($query, $params)) {
2662         $isCaseActivity = TRUE;
2663       }
2664     }
2665
2666     return $isCaseActivity;
2667   }
2668
2669   /**
2670    * Get all the case type ids currently in use.
2671    *
2672    * @return array
2673    */
2674   public static function getUsedCaseType() {
2675     static $caseTypeIds;
2676
2677     if (!is_array($caseTypeIds)) {
2678       $query = "SELECT DISTINCT( civicrm_case.case_type_id ) FROM civicrm_case";
2679
2680       $dao = CRM_Core_DAO::executeQuery($query);
2681       $caseTypeIds = [];
2682       while ($dao->fetch()) {
2683         $typeId = explode(CRM_Core_DAO::VALUE_SEPARATOR,
2684           $dao->case_type_id
2685         );
2686         $caseTypeIds[] = $typeId[1];
2687       }
2688     }
2689
2690     return $caseTypeIds;
2691   }
2692
2693   /**
2694    * Get all the case status ids currently in use.
2695    *
2696    * @return array
2697    */
2698   public static function getUsedCaseStatuses() {
2699     static $caseStatusIds;
2700
2701     if (!is_array($caseStatusIds)) {
2702       $query = "SELECT DISTINCT( civicrm_case.status_id ) FROM civicrm_case";
2703
2704       $dao = CRM_Core_DAO::executeQuery($query);
2705       $caseStatusIds = [];
2706       while ($dao->fetch()) {
2707         $caseStatusIds[] = $dao->status_id;
2708       }
2709     }
2710
2711     return $caseStatusIds;
2712   }
2713
2714   /**
2715    * Get all the encounter medium ids currently in use.
2716    *
2717    * @return array
2718    */
2719   public static function getUsedEncounterMediums() {
2720     static $mediumIds;
2721
2722     if (!is_array($mediumIds)) {
2723       $query = "SELECT DISTINCT( civicrm_activity.medium_id )  FROM civicrm_activity";
2724
2725       $dao = CRM_Core_DAO::executeQuery($query);
2726       $mediumIds = [];
2727       while ($dao->fetch()) {
2728         $mediumIds[] = $dao->medium_id;
2729       }
2730     }
2731
2732     return $mediumIds;
2733   }
2734
2735   /**
2736    * Check case configuration.
2737    *
2738    * @param int $contactId
2739    *
2740    * @return array
2741    */
2742   public static function isCaseConfigured($contactId = NULL) {
2743     $configured = array_fill_keys(['configured', 'allowToAddNewCase', 'redirectToCaseAdmin'], FALSE);
2744
2745     //lets check for case configured.
2746     $allCasesCount = CRM_Case_BAO_Case::caseCount(NULL, FALSE);
2747     $configured['configured'] = (bool) $allCasesCount;
2748     if (!$configured['configured']) {
2749       //do check for case type and case status.
2750       $caseTypes = CRM_Case_PseudoConstant::caseType('title', FALSE);
2751       if (!empty($caseTypes)) {
2752         $configured['configured'] = TRUE;
2753         if (!$configured['configured']) {
2754           $caseStatuses = CRM_Case_PseudoConstant::caseStatus('label', FALSE);
2755           if (!empty($caseStatuses)) {
2756             $configured['configured'] = TRUE;
2757           }
2758         }
2759       }
2760     }
2761     if ($configured['configured']) {
2762       //do check for active case type and case status.
2763       $caseTypes = CRM_Case_PseudoConstant::caseType();
2764       if (!empty($caseTypes)) {
2765         $caseStatuses = CRM_Case_PseudoConstant::caseStatus();
2766         if (!empty($caseStatuses)) {
2767           $configured['allowToAddNewCase'] = TRUE;
2768         }
2769       }
2770
2771       //do we need to redirect user to case admin.
2772       if (!$configured['allowToAddNewCase'] && $contactId) {
2773         //check for current contact case count.
2774         $currentContatCasesCount = CRM_Case_BAO_Case::caseCount($contactId);
2775         //redirect user to case admin page.
2776         if (!$currentContatCasesCount) {
2777           $configured['redirectToCaseAdmin'] = TRUE;
2778         }
2779       }
2780     }
2781
2782     return $configured;
2783   }
2784
2785   /**
2786    * Used during case component enablement and during ugprade.
2787    *
2788    * @return bool
2789    */
2790   public static function createCaseViews() {
2791     $errorScope = CRM_Core_TemporaryErrorScope::ignoreException();
2792     $dao = new CRM_Core_DAO();
2793
2794     $sql = self::createCaseViewsQuery('upcoming');
2795     $dao->query($sql);
2796     if (PEAR::getStaticProperty('DB_DataObject', 'lastError')) {
2797       return FALSE;
2798     }
2799
2800     // Above error doesn't get caught?
2801     $doublecheck = $dao->singleValueQuery("SELECT count(id) FROM civicrm_view_case_activity_upcoming");
2802     if (is_null($doublecheck)) {
2803       return FALSE;
2804     }
2805
2806     $sql = self::createCaseViewsQuery('recent');
2807     $dao->query($sql);
2808     if (PEAR::getStaticProperty('DB_DataObject', 'lastError')) {
2809       return FALSE;
2810     }
2811
2812     // Above error doesn't get caught?
2813     $doublecheck = $dao->singleValueQuery("SELECT count(id) FROM civicrm_view_case_activity_recent");
2814     if (is_null($doublecheck)) {
2815       return FALSE;
2816     }
2817
2818     return TRUE;
2819   }
2820
2821   /**
2822    * Helper function, also used by the upgrade in case of error
2823    *
2824    * @param string $section
2825    *
2826    * @return string
2827    */
2828   public static function createCaseViewsQuery($section = 'upcoming') {
2829     $sql = "";
2830     $scheduled_id = CRM_Core_PseudoConstant::getKey('CRM_Activity_BAO_Activity', 'activity_status_id', 'Scheduled');
2831     switch ($section) {
2832       case 'upcoming':
2833         $sql = "CREATE OR REPLACE VIEW `civicrm_view_case_activity_upcoming`
2834  AS SELECT ca.case_id, a.id, a.activity_date_time, a.status_id, a.activity_type_id
2835  FROM civicrm_case_activity ca
2836  INNER JOIN civicrm_activity a ON ca.activity_id=a.id
2837  WHERE a.id =
2838 (SELECT b.id FROM civicrm_case_activity bca
2839  INNER JOIN civicrm_activity b ON bca.activity_id=b.id
2840  WHERE b.activity_date_time <= DATE_ADD( NOW(), INTERVAL 14 DAY )
2841  AND b.is_current_revision = 1 AND b.is_deleted=0 AND b.status_id = $scheduled_id
2842  AND bca.case_id = ca.case_id ORDER BY b.activity_date_time ASC LIMIT 1)";
2843         break;
2844
2845       case 'recent':
2846         $sql = "CREATE OR REPLACE VIEW `civicrm_view_case_activity_recent`
2847  AS SELECT ca.case_id, a.id, a.activity_date_time, a.status_id, a.activity_type_id
2848  FROM civicrm_case_activity ca
2849  INNER JOIN civicrm_activity a ON ca.activity_id=a.id
2850  WHERE a.id =
2851 (SELECT b.id FROM civicrm_case_activity bca
2852  INNER JOIN civicrm_activity b ON bca.activity_id=b.id
2853  WHERE b.activity_date_time >= DATE_SUB( NOW(), INTERVAL 14 DAY )
2854  AND b.is_current_revision = 1 AND b.is_deleted=0 AND b.status_id <> $scheduled_id
2855  AND bca.case_id = ca.case_id ORDER BY b.activity_date_time DESC LIMIT 1)";
2856         break;
2857     }
2858     return $sql;
2859   }
2860
2861   /**
2862    * Add/copy relationships, when new client is added for a case
2863    *
2864    * @param int $caseId
2865    *   Case id.
2866    * @param int $contactId
2867    *   Contact id / new client id.
2868    */
2869   public static function addCaseRelationships($caseId, $contactId) {
2870     // get the case role / relationships for the case
2871     $caseRelationships = new CRM_Contact_DAO_Relationship();
2872     $caseRelationships->case_id = $caseId;
2873     $caseRelationships->find();
2874     $relationshipTypes = [];
2875
2876     // make sure we don't add duplicate relationships of same relationship type.
2877     while ($caseRelationships->fetch() && !in_array($caseRelationships->relationship_type_id, $relationshipTypes)) {
2878       $values = [];
2879       CRM_Core_DAO::storeValues($caseRelationships, $values);
2880
2881       // add relationship for new client.
2882       $newRelationship = new CRM_Contact_DAO_Relationship();
2883       $newRelationship->copyValues($values);
2884       $newRelationship->id = NULL;
2885       $newRelationship->case_id = $caseId;
2886       $newRelationship->contact_id_a = $contactId;
2887       $newRelationship->end_date = CRM_Utils_Date::isoToMysql($caseRelationships->end_date);
2888       $newRelationship->start_date = CRM_Utils_Date::isoToMysql($caseRelationships->start_date);
2889
2890       // another check to avoid duplicate relationship, in cases where client is removed and re-added again.
2891       if (!$newRelationship->find(TRUE)) {
2892         $newRelationship->save();
2893       }
2894
2895       // store relationship type of newly created relationship
2896       $relationshipTypes[] = $caseRelationships->relationship_type_id;
2897     }
2898   }
2899
2900   /**
2901    * Get the list of clients for a case.
2902    *
2903    * @param int $caseId
2904    *
2905    * @return array
2906    *   associated array with client ids
2907    */
2908   public static function getCaseClients($caseId) {
2909     $clients = [];
2910     $caseContact = new CRM_Case_DAO_CaseContact();
2911     $caseContact->case_id = $caseId;
2912     $caseContact->orderBy('id');
2913     $caseContact->find();
2914
2915     while ($caseContact->fetch()) {
2916       $clients[] = $caseContact->contact_id;
2917     }
2918
2919     return $clients;
2920   }
2921
2922   /**
2923    * @param int $caseId
2924    * @param string $direction
2925    * @param int $cid
2926    * @param int $relTypeId
2927    *
2928    * @throws \CRM_Core_Exception
2929    * @throws \CiviCRM_API3_Exception
2930    */
2931   public static function endCaseRole($caseId, $direction, $cid, $relTypeId) {
2932     // Validate inputs
2933     if ($direction !== 'a' && $direction !== 'b') {
2934       throw new CRM_Core_Exception('Invalid relationship direction');
2935     }
2936
2937     // This case might have multiple clients, so we lookup by relationship instead of by id to get them all
2938     $sql = "SELECT id FROM civicrm_relationship WHERE case_id = %1 AND contact_id_{$direction} = %2 AND relationship_type_id = %3";
2939     $dao = CRM_Core_DAO::executeQuery($sql, [
2940       1 => [$caseId, 'Positive'],
2941       2 => [$cid, 'Positive'],
2942       3 => [$relTypeId, 'Positive'],
2943     ]);
2944     while ($dao->fetch()) {
2945       civicrm_api3('relationship', 'create', [
2946         'id' => $dao->id,
2947         'is_active' => 0,
2948         'end_date' => 'now',
2949       ]);
2950     }
2951   }
2952
2953   /**
2954    * Get options for a given case field.
2955    *
2956    * @param string $fieldName
2957    * @param string $context
2958    * @param array $props
2959    *   Whatever is known about this dao object.
2960    *
2961    * @return array|bool
2962    * @throws \CiviCRM_API3_Exception
2963    *
2964    * @see CRM_Core_DAO::buildOptionsContext
2965    * @see CRM_Core_DAO::buildOptions
2966    *
2967    */
2968   public static function buildOptions($fieldName, $context = NULL, $props = []) {
2969     $className = __CLASS__;
2970     $params = [];
2971     switch ($fieldName) {
2972       // This field is not part of this object but the api supports it
2973       case 'medium_id':
2974         $className = 'CRM_Activity_BAO_Activity';
2975         break;
2976
2977       // Filter status id by case type id
2978       case 'status_id':
2979         if (!empty($props['case_type_id'])) {
2980           $idField = is_numeric($props['case_type_id']) ? 'id' : 'name';
2981           $caseType = civicrm_api3('CaseType', 'getsingle', [$idField => $props['case_type_id'], 'return' => 'definition']);
2982           if (!empty($caseType['definition']['statuses'])) {
2983             $params['condition'] = 'v.name IN ("' . implode('","', $caseType['definition']['statuses']) . '")';
2984           }
2985         }
2986         break;
2987     }
2988     return CRM_Core_PseudoConstant::get($className, $fieldName, $params, $context);
2989   }
2990
2991   /**
2992    * @inheritDoc
2993    */
2994   public function addSelectWhereClause() {
2995     // We always return an array with these keys, even if they are empty,
2996     // because this tells the query builder that we have considered these fields for acls
2997     $clauses = [
2998       'id' => [],
2999       // Only case admins can view deleted cases
3000       'is_deleted' => CRM_Core_Permission::check('administer CiviCase') ? [] : ["= 0"],
3001     ];
3002     // Ensure the user has permission to view the case client
3003     $contactClause = CRM_Utils_SQL::mergeSubquery('Contact');
3004     if ($contactClause) {
3005       $contactClause = implode(' AND contact_id ', $contactClause);
3006       $clauses['id'][] = "IN (SELECT case_id FROM civicrm_case_contact WHERE contact_id $contactClause)";
3007     }
3008     // The api gatekeeper ensures the user has at least "access my cases and activities"
3009     // so if they do not have permission to see all cases we'll assume they can only access their own
3010     if (!CRM_Core_Permission::check('access all cases and activities')) {
3011       $user = (int) CRM_Core_Session::getLoggedInContactID();
3012       $clauses['id'][] = "IN (
3013         SELECT r.case_id FROM civicrm_relationship r, civicrm_case_contact cc WHERE r.is_active = 1 AND cc.case_id = r.case_id AND (
3014           (r.contact_id_a = cc.contact_id AND r.contact_id_b = $user) OR (r.contact_id_b = cc.contact_id AND r.contact_id_a = $user)
3015         )
3016       )";
3017     }
3018     CRM_Utils_Hook::selectWhereClause($this, $clauses);
3019     return $clauses;
3020   }
3021
3022   /**
3023    * CRM-20308: Method to get the contact id to use as from contact for email copy
3024    * 1. Activity Added by Contact's email address
3025    * 2. System Default From Address
3026    * 3. Default Organization Contact email address
3027    * 4. Logged in user
3028    *
3029    * @param int $activityID
3030    *
3031    * @return mixed $emailFromContactId
3032    *
3033    * @throws \CiviCRM_API3_Exception
3034    * @see https://issues.civicrm.org/jira/browse/CRM-20308
3035    */
3036   public static function getReceiptFrom($activityID) {
3037     $name = $address = NULL;
3038
3039     if (!empty($activityID) && (Civi::settings()->get('allow_mail_from_logged_in_contact'))) {
3040       // This breaks SPF/DMARC if email is sent from an email address that the server is not authorised to send from.
3041       //    so we can disable this behaviour with the "allow_mail_from_logged_in_contact" setting.
3042       // There is always a 'Added by' contact for a activity,
3043       //  so we can safely use ActivityContact.Getvalue API
3044       $sourceContactId = civicrm_api3('ActivityContact', 'getvalue', [
3045         'activity_id' => $activityID,
3046         'record_type_id' => 'Activity Source',
3047         'return' => 'contact_id',
3048       ]);
3049       list($name, $address) = CRM_Contact_BAO_Contact_Location::getEmailDetails($sourceContactId);
3050     }
3051
3052     // If 'From' email address not found for Source Activity Contact then
3053     //   fetch the email from domain or logged in user.
3054     if (empty($address)) {
3055       list($name, $address) = CRM_Core_BAO_Domain::getDefaultReceiptFrom();
3056     }
3057
3058     return "$name <$address>";
3059   }
3060
3061   /**
3062    * @return array
3063    */
3064   public static function getEntityRefFilters() {
3065     $filters = [
3066       [
3067         'key' => 'case_id.case_type_id',
3068         'value' => ts('Case Type'),
3069         'entity' => 'Case',
3070       ],
3071       [
3072         'key' => 'case_id.status_id',
3073         'value' => ts('Case Status'),
3074         'entity' => 'Case',
3075       ],
3076     ];
3077     foreach (CRM_Contact_BAO_Contact::getEntityRefFilters() as $filter) {
3078       $filter += ['entity' => 'Contact'];
3079       $filter['key'] = 'contact_id.' . $filter['key'];
3080       $filters[] = $filter;
3081     }
3082     return $filters;
3083   }
3084
3085   /**
3086    * Fetch Case Role direction from Case Type
3087    */
3088   public static function getCaseRoleDirection($caseId, $roleTypeId = NULL) {
3089     try {
3090       $case = civicrm_api3('Case', 'getsingle', ['id' => $caseId]);
3091     }
3092     catch (CiviCRM_API3_Exception $e) {
3093       // Lack of permissions will throw an exception
3094       return 0;
3095     }
3096     if (!empty($case['case_type_id'])) {
3097       try {
3098         $caseType = civicrm_api3('CaseType', 'getsingle', ['id' => $case['case_type_id'], 'return' => ['definition']]);
3099       }
3100       catch (CiviCRM_API3_Exception $e) {
3101         // Lack of permissions will throw an exception
3102         return 'no case type found';
3103       }
3104       if (!empty($caseType['definition']['caseRoles'])) {
3105         $caseRoles = [];
3106         foreach ($caseType['definition']['caseRoles'] as $key => $roleDetails) {
3107           // Check if its an a_b label
3108           try {
3109             $relType = civicrm_api3('RelationshipType', 'getsingle', ['label_a_b' => $roleDetails['name']]);
3110           }
3111           catch (CiviCRM_API3_Exception $e) {
3112           }
3113           if (!empty($relType['id'])) {
3114             $roleDetails['id'] = $relType['id'];
3115             $roleDetails['direction'] = 'b_a';
3116           }
3117           // Check if its a b_a label
3118           try {
3119             $relTypeBa = civicrm_api3('RelationshipType', 'getsingle', ['label_b_a' => $roleDetails['name']]);
3120           }
3121           catch (CiviCRM_API3_Exception $e) {
3122           }
3123           if (!empty($relTypeBa['id'])) {
3124             if (!empty($roleDetails['direction'])) {
3125               $roleDetails['direction'] = 'bidrectional';
3126             }
3127             else {
3128               $roleDetails['id'] = $relTypeBa['id'];
3129               $roleDetails['direction'] = 'a_b';
3130             }
3131           }
3132           $caseRoles[$roleDetails['id']] = $roleDetails;
3133         }
3134       }
3135       return $caseRoles;
3136     }
3137   }
3138
3139 }