3 +--------------------------------------------------------------------+
5 +--------------------------------------------------------------------+
6 | Copyright CiviCRM LLC (c) 2004-2020 |
7 +--------------------------------------------------------------------+
8 | This file is a part of CiviCRM. |
10 | CiviCRM is free software; you can copy, modify, and distribute it |
11 | under the terms of the GNU Affero General Public License |
12 | Version 3, 19 November 2007 and the CiviCRM Licensing Exception. |
14 | CiviCRM is distributed in the hope that it will be useful, but |
15 | WITHOUT ANY WARRANTY; without even the implied warranty of |
16 | MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. |
17 | See the GNU Affero General Public License for more details. |
19 | You should have received a copy of the GNU Affero General Public |
20 | License and the CiviCRM Licensing Exception along |
21 | with this program; if not, contact CiviCRM LLC |
22 | at info[AT]civicrm[DOT]org. If you have questions about the |
23 | GNU Affero General Public License or the licensing of CiviCRM, |
24 | see the CiviCRM license FAQ at http://civicrm.org/licensing |
25 +--------------------------------------------------------------------+
31 * @copyright CiviCRM LLC (c) 2004-2020
35 * This class contains the functions for Case Management.
37 class CRM_Case_BAO_Case
extends CRM_Case_DAO_Case
{
40 * Static field for all the case information that we can potentially export.
44 public static $_exportableFields = NULL;
49 public function __construct() {
50 parent
::__construct();
54 * Is CiviCase enabled?
58 public static function enabled() {
59 $config = CRM_Core_Config
::singleton();
60 return in_array('CiviCase', $config->enableComponents
);
64 * Create a case object.
66 * The function extracts all the params it needs to initialize the create a
67 * case object. the params array could contain additional unused name/value
70 * @param array $params
71 * (reference ) an assoc array of name/value pairs.
73 * @return CRM_Case_BAO_Case
75 public static function add(&$params) {
76 $caseDAO = new CRM_Case_DAO_Case();
77 $caseDAO->copyValues($params);
78 $result = $caseDAO->save();
79 // Get other case values (required by XML processor), this adds to $result array
85 * Takes an associative array and creates a case object.
87 * @param array $params
88 * (reference) an assoc array of name/value pairs.
90 * @return CRM_Case_BAO_Case
92 public static function &create(&$params) {
93 // CRM-20958 - These fields are managed by MySQL triggers. Watch out for clients resaving stale timestamps.
94 unset($params['created_date']);
95 unset($params['modified_date']);
96 $caseStatus = CRM_Case_PseudoConstant
::caseStatus('name');
97 // for resolved case the end date should set to now
98 if (!empty($params['status_id']) && $params['status_id'] == array_search('Closed', $caseStatus)) {
99 $params['end_date'] = date("Ymd");
102 $transaction = new CRM_Core_Transaction();
104 if (!empty($params['id'])) {
105 CRM_Utils_Hook
::pre('edit', 'Case', $params['id'], $params);
108 CRM_Utils_Hook
::pre('create', 'Case', NULL, $params);
111 $case = self
::add($params);
113 if (!empty($params['custom']) &&
114 is_array($params['custom'])
116 CRM_Core_BAO_CustomValueTable
::store($params['custom'], 'civicrm_case', $case->id
);
119 if (is_a($case, 'CRM_Core_Error')) {
120 $transaction->rollback();
124 if (!empty($params['id'])) {
125 CRM_Utils_Hook
::post('edit', 'Case', $case->id
, $case);
128 CRM_Utils_Hook
::post('create', 'Case', $case->id
, $case);
130 $transaction->commit();
132 //we are not creating log for case
133 //since case log can be tracked using log for activity.
138 * Process case activity add/delete
139 * takes an associative array and
141 * @param array $params
142 * (reference ) an assoc array of name/value pairs.
145 public static function processCaseActivity(&$params) {
146 $caseActivityDAO = new CRM_Case_DAO_CaseActivity();
147 $caseActivityDAO->activity_id
= $params['activity_id'];
148 $caseActivityDAO->case_id
= $params['case_id'];
150 $caseActivityDAO->find(TRUE);
151 $caseActivityDAO->save();
155 * Get the case subject for Activity.
157 * @param int $activityId
160 * @return string|null
162 public static function getCaseSubject($activityId) {
163 $caseActivity = new CRM_Case_DAO_CaseActivity();
164 $caseActivity->activity_id
= $activityId;
165 if ($caseActivity->find(TRUE)) {
166 return CRM_Core_DAO
::getFieldValue('CRM_Case_BAO_Case', $caseActivity->case_id
, 'subject');
175 * @param string $colName
180 public static function getCaseType($caseId, $colName = 'title') {
182 SELECT civicrm_case_type.{$colName} FROM civicrm_case
183 LEFT JOIN civicrm_case_type ON
184 civicrm_case.case_type_id = civicrm_case_type.id
185 WHERE civicrm_case.id = %1";
187 $queryParams = [1 => [$caseId, 'Integer']];
189 return CRM_Core_DAO
::singleValueQuery($query, $queryParams);
193 * Delete the record that are associated with this case.
194 * record are deleted from case
197 * Id of the case to delete.
199 * @param bool $moveToTrash
204 public static function deleteCase($caseId, $moveToTrash = FALSE) {
205 CRM_Utils_Hook
::pre('delete', 'Case', $caseId, CRM_Core_DAO
::$_nullArray);
208 $activities = self
::getCaseActivityDates($caseId);
210 foreach ($activities as $value) {
211 CRM_Activity_BAO_Activity
::deleteActivity($value, $moveToTrash);
216 $transaction = new CRM_Core_Transaction();
218 $case = new CRM_Case_DAO_Case();
221 $result = $case->delete();
222 $transaction->commit();
225 $result = $case->is_deleted
= 1;
230 // CRM-7364, disable relationships
231 self
::enableDisableCaseRelationships($caseId, FALSE);
233 CRM_Utils_Hook
::post('delete', 'Case', $caseId, $case);
235 // remove case from recent items.
240 CRM_Utils_Recent
::del($caseRecent);
248 * Enable disable case related relationships.
252 * @param bool $enable
255 public static function enableDisableCaseRelationships($caseId, $enable) {
256 $contactIds = self
::retrieveContactIdsByCaseId($caseId);
257 if (!empty($contactIds)) {
258 foreach ($contactIds as $cid) {
259 $roles = self
::getCaseRoles($cid, $caseId);
260 if (!empty($roles)) {
261 $relationshipIds = implode(',', array_keys($roles));
262 $enable = (int) $enable;
263 $query = "UPDATE civicrm_relationship SET is_active = {$enable}
264 WHERE id IN ( {$relationshipIds} )";
265 CRM_Core_DAO
::executeQuery($query);
272 * Retrieve contact_id by case_id.
277 * @param int $contactID
278 * @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
282 public static function retrieveContactIdsByCaseId($caseId, $contactID = NULL, $startArrayAt = 0) {
283 $caseContact = new CRM_Case_DAO_CaseContact();
284 $caseContact->case_id
= $caseId;
285 $caseContact->find();
287 $count = $startArrayAt;
288 while ($caseContact->fetch()) {
289 if ($contactID != $caseContact->contact_id
) {
290 $contactArray[$count] = $caseContact->contact_id
;
295 return $contactArray;
299 * Look up a case using an activity ID.
301 * @param int $activityId
303 * @return int, case ID
305 public static function getCaseIdByActivityId($activityId) {
306 $originalId = CRM_Core_DAO
::singleValueQuery(
307 'SELECT original_id FROM civicrm_activity WHERE id = %1',
308 ['1' => [$activityId, 'Integer']]
310 $caseId = CRM_Core_DAO
::singleValueQuery(
311 'SELECT case_id FROM civicrm_case_activity WHERE activity_id in (%1,%2)',
313 '1' => [$activityId, 'Integer'],
314 '2' => [$originalId ?
$originalId : $activityId, 'Integer'],
321 * Retrieve contact names by caseId.
328 public static function getContactNames($caseId) {
331 return $contactNames;
335 SELECT contact_a.sort_name name,
336 contact_a.display_name as display_name,
338 contact_a.birth_date as birth_date,
341 FROM civicrm_contact contact_a
342 LEFT JOIN civicrm_case_contact ON civicrm_case_contact.contact_id = contact_a.id
343 LEFT JOIN civicrm_email ce ON ( ce.contact_id = contact_a.id AND ce.is_primary = 1)
344 LEFT JOIN civicrm_phone cp ON ( cp.contact_id = contact_a.id AND cp.is_primary = 1)
345 WHERE contact_a.is_deleted = 0 AND civicrm_case_contact.case_id = %1
346 ORDER BY civicrm_case_contact.id";
348 $dao = CRM_Core_DAO
::executeQuery($query,
349 [1 => [$caseId, 'Integer']]
351 while ($dao->fetch()) {
352 $contactNames[$dao->cid
]['contact_id'] = $dao->cid
;
353 $contactNames[$dao->cid
]['sort_name'] = $dao->name
;
354 $contactNames[$dao->cid
]['display_name'] = $dao->display_name
;
355 $contactNames[$dao->cid
]['email'] = $dao->email
;
356 $contactNames[$dao->cid
]['phone'] = $dao->phone
;
357 $contactNames[$dao->cid
]['birth_date'] = $dao->birth_date
;
358 $contactNames[$dao->cid
]['role'] = ts('Client');
361 return $contactNames;
365 * Retrieve case_id by contact_id.
367 * @param int $contactID
368 * @param bool $includeDeleted
369 * Include the deleted cases in result.
370 * @param null $caseType
374 public static function retrieveCaseIdsByContactId($contactID, $includeDeleted = FALSE, $caseType = NULL) {
377 FROM civicrm_case_contact cc
378 INNER JOIN civicrm_case ca ON cc.case_id = ca.id
380 if (isset($caseType)) {
382 "INNER JOIN civicrm_case_type ON civicrm_case_type.id = ca.case_type_id
383 WHERE cc.contact_id = %1 AND civicrm_case_type.name = '{$caseType}'";
385 if (!isset($caseType)) {
386 $query .= "WHERE cc.contact_id = %1";
388 if (!$includeDeleted) {
389 $query .= " AND ca.is_deleted = 0";
392 $params = [1 => [$contactID, 'Integer']];
393 $dao = CRM_Core_DAO
::executeQuery($query, $params);
396 while ($dao->fetch()) {
397 $caseArray[] = $dao->id
;
404 * @param string $type
406 * @param string $condition
410 public static function getCaseActivityCountQuery($type = 'upcoming', $userID, $condition = NULL) {
411 return sprintf(" SELECT COUNT(*) FROM (%s) temp ", self
::getCaseActivityQuery($type, $userID, $condition));
415 * @param string $type
417 * @param string $condition
418 * @param string $limit
419 * @param string $order
423 public static function getCaseActivityQuery($type = 'upcoming', $userID, $condition = NULL, $limit = NULL, $order = NULL) {
425 'civicrm_case.id as case_id',
426 'civicrm_case.subject as case_subject',
427 'civicrm_contact.id as contact_id',
428 'civicrm_contact.sort_name as sort_name',
429 'civicrm_phone.phone as phone',
430 'civicrm_contact.contact_type as contact_type',
431 'civicrm_contact.contact_sub_type as contact_sub_type',
432 't_act.activity_type_id as activity_type_id',
433 'civicrm_case.case_type_id as case_type_id',
434 'civicrm_case.status_id as case_status_id',
435 't_act.status_id as status_id',
436 'civicrm_case.start_date as case_start_date',
437 "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",
438 't_act.activity_date_time as activity_date_time',
439 't_act.id as activity_id',
442 $query = CRM_Contact_BAO_Query
::appendAnyValueToSelect($selectClauses, 'case_id');
446 INNER JOIN civicrm_case_contact ON civicrm_case.id = civicrm_case_contact.case_id
447 INNER JOIN civicrm_contact ON civicrm_case_contact.contact_id = civicrm_contact.id
453 // civicrm_view_case_activity_upcoming and
454 // civicrm_view_case_activity_recent are views that show the next
455 // scheduled and most recent not-scheduled activity on each case,
458 INNER JOIN civicrm_view_case_activity_$type t_act
459 ON t_act.case_id = civicrm_case.id
465 LEFT JOIN civicrm_case_activity ca4
466 ON civicrm_case.id = ca4.case_id
467 LEFT JOIN civicrm_activity t_act
468 ON t_act.id = ca4.activity_id
469 AND t_act.is_current_revision = 1
474 LEFT JOIN civicrm_phone
475 ON civicrm_phone.contact_id = civicrm_contact.id
476 AND civicrm_phone.is_primary = 1
477 LEFT JOIN civicrm_relationship case_relationship
478 ON ((case_relationship.contact_id_a = civicrm_case_contact.contact_id AND case_relationship.contact_id_b = {$userID})
479 OR (case_relationship.contact_id_b = civicrm_case_contact.contact_id AND case_relationship.contact_id_a = {$userID}))
480 AND case_relationship.is_active
481 AND case_relationship.case_id = civicrm_case.id
482 LEFT JOIN civicrm_relationship_type case_relation_type
483 ON case_relation_type.id = case_relationship.relationship_type_id
484 AND case_relation_type.id = case_relationship.relationship_type_id
488 // CRM-8749 backwards compatibility - callers of this function expect to start $condition with "AND"
489 $query .= " WHERE (1) AND $condition ";
491 $query .= " GROUP BY case_id ";
493 $query .= ($order) ?
: ' ORDER BY activity_date_time ASC';
503 * Retrieve cases related to particular contact or whole contact used in Dashboard and Tab.
505 * @param bool $allCases
506 * @param array $params
507 * @param string $context
508 * @param bool $getCount
513 public static function getCases($allCases = TRUE, $params = [], $context = 'dashboard', $getCount = FALSE) {
517 // validate access for own cases.
518 if (!self
::accessCiviCase()) {
519 return $getCount ?
0 : $casesList;
522 // Return cached value instead of re-running query
523 if (isset(Civi
::$statics[__CLASS__
]['totalCount']) && $getCount) {
524 return Civi
::$statics[__CLASS__
]['totalCount'];
527 $type = CRM_Utils_Array
::value('type', $params, 'upcoming');
528 $userID = CRM_Core_Session
::singleton()->get('userID');
530 // validate access for all cases.
531 if ($allCases && !CRM_Core_Permission
::check('access all cases and activities')) {
535 $whereClauses = ['civicrm_case.is_deleted = 0 AND civicrm_contact.is_deleted <> 1'];
538 $whereClauses[] = "(case_relationship.contact_id_b = {$userID} OR case_relationship.contact_id_a = {$userID})";
539 $whereClauses[] = 'case_relationship.is_active';
541 if (empty($params['status_id']) && ($type == 'upcoming' ||
$type == 'any')) {
542 $whereClauses[] = "civicrm_case.status_id != " . CRM_Core_PseudoConstant
::getKey('CRM_Case_BAO_Case', 'case_status_id', 'Closed');
545 foreach (['case_type_id', 'status_id'] as $column) {
546 if (!empty($params[$column])) {
547 $whereClauses[] = sprintf("civicrm_case.%s IN (%s)", $column, $params[$column]);
550 $condition = implode(' AND ', $whereClauses);
552 Civi
::$statics[__CLASS__
]['totalCount'] = $totalCount = CRM_Core_DAO
::singleValueQuery(self
::getCaseActivityCountQuery($type, $userID, $condition));
556 $casesList['total'] = $totalCount;
559 if (!empty($params['rp'])) {
560 $params['offset'] = ($params['page'] - 1) * $params['rp'];
561 $params['rowCount'] = $params['rp'];
562 if (!empty($params['rowCount']) && $params['rowCount'] > 0) {
563 $limit = " LIMIT {$params['offset']}, {$params['rowCount']} ";
568 if (!empty($params['sortBy'])) {
569 if (strstr($params['sortBy'], 'date ')) {
570 $params['sortBy'] = str_replace('date', 'activity_date_time', $params['sortBy']);
572 $order = "ORDER BY " . $params['sortBy'];
575 $query = self
::getCaseActivityQuery($type, $userID, $condition, $limit, $order);
576 $result = CRM_Core_DAO
::executeQuery($query);
578 // we're going to use the usual actions, so doesn't make sense to duplicate definitions
579 $actions = CRM_Case_Selector_Search
::links();
581 // check is the user has view/edit signer permission
582 $permissions = [CRM_Core_Permission
::VIEW
];
583 if (CRM_Core_Permission
::check('access all cases and activities') ||
584 (!$allCases && CRM_Core_Permission
::check('access my cases and activities'))
586 $permissions[] = CRM_Core_Permission
::EDIT
;
588 if (CRM_Core_Permission
::check('delete in CiviCase')) {
589 $permissions[] = CRM_Core_Permission
::DELETE
;
591 $mask = CRM_Core_Action
::mask($permissions);
593 // Pseudoconstants to populate labels
594 $caseStatuses = CRM_Case_PseudoConstant
::caseStatus('label', FALSE);
595 $caseTypes = CRM_Case_PseudoConstant
::caseType('name');
596 $caseTypeTitles = CRM_Case_PseudoConstant
::caseType('title', FALSE);
597 $activityTypeLabels = CRM_Activity_BAO_Activity
::buildOptions('activity_type_id');
599 foreach ($result->fetchAll() as $case) {
600 $key = $case['case_id'];
601 $casesList[$key] = [];
602 $casesList[$key]['DT_RowId'] = $case['case_id'];
603 $casesList[$key]['DT_RowAttr'] = ['data-entity' => 'case', 'data-id' => $case['case_id']];
604 $casesList[$key]['DT_RowClass'] = "crm-entity";
606 $casesList[$key]['activity_list'] = sprintf('<a title="%s" class="crm-expand-row" href="%s"></a>',
608 CRM_Utils_System
::url('civicrm/case/details', ['caseId' => $case['case_id'], 'cid' => $case['contact_id'], 'type' => $type])
611 $phone = empty($case['phone']) ?
'' : '<br /><span class="description">' . $case['phone'] . '</span>';
612 $casesList[$key]['contact_id'] = sprintf('<a href="%s">%s</a>%s<br /><span class="description">%s: %d</span>',
613 CRM_Utils_System
::url('civicrm/contact/view', ['cid' => $case['contact_id']]),
619 $casesList[$key]['subject'] = $case['case_subject'];
620 $casesList[$key]['case_status'] = CRM_Utils_Array
::value($case['case_status_id'], $caseStatuses);
621 if ($case['case_status_id'] == CRM_Case_PseudoConstant
::getKey('CRM_Case_BAO_Case', 'case_status_id', 'Urgent')) {
622 $casesList[$key]['case_status'] = sprintf('<strong>%s</strong>', strtoupper($casesList[$key]['case_status']));
624 $casesList[$key]['case_type'] = CRM_Utils_Array
::value($case['case_type_id'], $caseTypeTitles);
625 $casesList[$key]['case_role'] = CRM_Utils_Array
::value('case_role', $case, '---');
626 $casesList[$key]['manager'] = self
::getCaseManagerContact($caseTypes[$case['case_type_id']], $case['case_id']);
628 $casesList[$key]['date'] = CRM_Utils_Array
::value($case['activity_type_id'], $activityTypeLabels);
629 if ($actId = CRM_Utils_Array
::value('activity_id', $case)) {
630 if (self
::checkPermission($actId, 'view', $case['activity_type_id'], $userID)) {
631 if ($type == 'recent') {
632 $casesList[$key]['date'] = sprintf('<a class="action-item crm-hover-button" href="%s" title="%s">%s</a>',
633 CRM_Utils_System
::url('civicrm/case/activity/view', ['reset' => 1, 'cid' => $case['contact_id'], 'aid' => $case['activity_id']]),
635 CRM_Utils_Array
::value($case['activity_type_id'], $activityTypeLabels)
639 $status = CRM_Utils_Date
::overdue($case['activity_date_time']) ?
'status-overdue' : 'status-scheduled';
640 $casesList[$key]['date'] = sprintf('<a class="crm-popup %s" href="%s" title="%s">%s</a> ',
642 CRM_Utils_System
::url('civicrm/case/activity/view', ['reset' => 1, 'cid' => $case['contact_id'], 'aid' => $case['activity_id']]),
644 CRM_Utils_Array
::value($case['activity_type_id'], $activityTypeLabels)
648 if (isset($case['activity_type_id']) && self
::checkPermission($actId, 'edit', $case['activity_type_id'], $userID)) {
649 $casesList[$key]['date'] .= sprintf('<a class="action-item crm-hover-button" href="%s" title="%s"><i class="crm-i fa-pencil"></i></a>',
650 CRM_Utils_System
::url('civicrm/case/activity', ['reset' => 1, 'cid' => $case['contact_id'], 'caseid' => $case['case_id'], 'action' => 'update', 'id' => $actId]),
655 $casesList[$key]['date'] .= "<br/>" . CRM_Utils_Date
::customFormat($case['activity_date_time']);
656 $casesList[$key]['links'] = CRM_Core_Action
::formLink($actions['primaryActions'], $mask,
658 'id' => $case['case_id'],
659 'cid' => $case['contact_id'],
664 'case.actions.primary',
674 * Get the summary of cases counts by type and status.
676 * @param bool $allCases
680 public static function getCasesSummary($allCases = TRUE) {
683 //validate access for civicase.
684 if (!self
::accessCiviCase()) {
688 $userID = CRM_Core_Session
::singleton()->get('userID');
690 //validate access for all cases.
691 if ($allCases && !CRM_Core_Permission
::check('access all cases and activities')) {
695 $caseTypes = CRM_Case_PseudoConstant
::caseType();
696 $caseStatuses = CRM_Case_PseudoConstant
::caseStatus();
697 $caseTypes = array_flip($caseTypes);
699 // get statuses as headers for the table
700 $url = CRM_Utils_System
::url('civicrm/case/search', "reset=1&force=1&all=1&status=");
701 foreach ($caseStatuses as $key => $name) {
702 $caseSummary['headers'][$key]['status'] = $name;
703 $caseSummary['headers'][$key]['url'] = $url . $key;
706 // build rows with actual data
708 $myGroupByClause = $mySelectClause = $myCaseFromClause = $myCaseWhereClauseA = $myCaseWhereClauseB = '';
714 $myGroupByClauseB = ' GROUP BY civicrm_case.id';
719 $myCaseWhereClauseA = " AND case_relationship.contact_id_a = {$userID} AND case_relationship.is_active ";
720 $myGroupByClauseA = " GROUP BY CONCAT(civicrm_case.id,'-',case_relationship.contact_id_a)";
721 $myCaseWhereClauseB = " AND case_relationship.contact_id_b = {$userID} AND case_relationship.is_active ";
722 $myGroupByClauseB = " GROUP BY CONCAT(civicrm_case.id,'-',case_relationship.contact_id_b)";
724 $myGroupByClauseB .= ", case_status.label, status_id, case_type_id, civicrm_case.id";
725 $myGroupByClauseA = $myGroupByClauseB;
726 // FIXME: This query could be a lot more efficient if it used COUNT() instead of returning all rows and then counting them with php
728 SELECT civicrm_case.id, case_status.label AS case_status, status_id, civicrm_case_type.title AS case_type,
729 case_type_id, case_relationship.contact_id_b as case_contact
731 INNER JOIN civicrm_case_contact cc on cc.case_id = civicrm_case.id
732 LEFT JOIN civicrm_case_type ON civicrm_case.case_type_id = civicrm_case_type.id
733 LEFT JOIN civicrm_option_group option_group_case_status ON ( option_group_case_status.name = 'case_status' )
734 LEFT JOIN civicrm_option_value case_status ON ( civicrm_case.status_id = case_status.value
735 AND option_group_case_status.id = case_status.option_group_id )
736 LEFT JOIN civicrm_relationship case_relationship ON ( case_relationship.case_id = civicrm_case.id
737 AND case_relationship.contact_id_b = {$userID} AND case_relationship.is_active )
738 WHERE is_deleted = 0 AND cc.contact_id IN (SELECT id FROM civicrm_contact WHERE is_deleted <> 1)
739 {$myCaseWhereClauseB} {$myGroupByClauseB}
741 SELECT civicrm_case.id, case_status.label AS case_status, status_id, civicrm_case_type.title AS case_type,
742 case_type_id, case_relationship.contact_id_a as case_contact
744 INNER JOIN civicrm_case_contact cc on cc.case_id = civicrm_case.id
745 LEFT JOIN civicrm_case_type ON civicrm_case.case_type_id = civicrm_case_type.id
746 LEFT JOIN civicrm_option_group option_group_case_status ON ( option_group_case_status.name = 'case_status' )
747 LEFT JOIN civicrm_option_value case_status ON ( civicrm_case.status_id = case_status.value
748 AND option_group_case_status.id = case_status.option_group_id )
749 LEFT JOIN civicrm_relationship case_relationship ON ( case_relationship.case_id = civicrm_case.id
750 AND case_relationship.contact_id_a = {$userID})
751 WHERE is_deleted = 0 AND cc.contact_id IN (SELECT id FROM civicrm_contact WHERE is_deleted <> 1)
752 {$myCaseWhereClauseA} {$myGroupByClauseA}";
754 $res = CRM_Core_DAO
::executeQuery($query);
755 while ($res->fetch()) {
756 if (!empty($rows[$res->case_type
]) && !empty($rows[$res->case_type
][$res->case_status
])) {
757 $rows[$res->case_type
][$res->case_status
]['count'] = $rows[$res->case_type
][$res->case_status
]['count'] +
1;
760 $rows[$res->case_type
][$res->case_status
] = [
762 'url' => CRM_Utils_System
::url('civicrm/case/search',
763 "reset=1&force=1&status={$res->status_id}&type={$res->case_type_id}&case_owner={$case_owner}"
768 $caseSummary['rows'] = array_merge($caseTypes, $rows);
776 * @param int $contactID
780 * @param int $relationshipID
781 * @param bool $activeOnly
784 * case role / relationships
787 public static function getCaseRoles($contactID, $caseID, $relationshipID = NULL, $activeOnly = TRUE) {
789 SELECT rel.id as civicrm_relationship_id,
790 con.sort_name as sort_name,
791 civicrm_email.email as email,
792 civicrm_phone.phone as phone,
793 con.id as civicrm_contact_id,
794 IF(rel.contact_id_a = %1, civicrm_relationship_type.label_a_b, civicrm_relationship_type.label_b_a) as relation,
795 civicrm_relationship_type.id as relation_type,
796 IF(rel.contact_id_a = %1, "a_b", "b_a") as relationship_direction
797 FROM civicrm_relationship rel
798 INNER JOIN civicrm_relationship_type ON rel.relationship_type_id = civicrm_relationship_type.id
799 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))
800 LEFT JOIN civicrm_phone ON (civicrm_phone.contact_id = con.id AND civicrm_phone.is_primary = 1)
801 LEFT JOIN civicrm_email ON (civicrm_email.contact_id = con.id AND civicrm_email.is_primary = 1)
802 WHERE (rel.contact_id_a = %1 OR rel.contact_id_b = %1) AND rel.case_id = %2
803 AND con.is_deleted = 0';
806 $query .= ' AND rel.is_active = 1 AND (rel.end_date IS NULL OR rel.end_date > NOW())';
810 1 => [$contactID, 'Positive'],
811 2 => [$caseID, 'Positive'],
814 if ($relationshipID) {
815 $query .= ' AND rel.id = %3 ';
816 $params[3] = [$relationshipID, 'Integer'];
818 $dao = CRM_Core_DAO
::executeQuery($query, $params);
821 while ($dao->fetch()) {
822 $rid = $dao->civicrm_relationship_id
;
823 $values[$rid]['cid'] = $dao->civicrm_contact_id
;
824 $values[$rid]['relation'] = $dao->relation
;
825 $values[$rid]['name'] = $dao->sort_name
;
826 $values[$rid]['email'] = $dao->email
;
827 $values[$rid]['phone'] = $dao->phone
;
828 $values[$rid]['relation_type'] = $dao->relation_type
;
829 $values[$rid]['rel_id'] = $dao->civicrm_relationship_id
;
830 $values[$rid]['client_id'] = $contactID;
831 $values[$rid]['relationship_direction'] = $dao->relationship_direction
;
838 * Get Case Activities.
842 * @param array $params
844 * @param int $contactID
847 * @param null $context
849 * @param null $type (deprecated)
852 * Array of case activities
855 public static function getCaseActivity($caseID, &$params, $contactID, $context = NULL, $userID = NULL, $type = NULL) {
856 $activityContacts = CRM_Activity_BAO_ActivityContact
::buildOptions('record_type_id', 'validate');
857 $assigneeID = CRM_Utils_Array
::key('Activity Assignees', $activityContacts);
858 $sourceID = CRM_Utils_Array
::key('Activity Source', $activityContacts);
859 $targetID = CRM_Utils_Array
::key('Activity Targets', $activityContacts);
861 // CRM-5081 - formatting the dates to omit seconds.
862 // Note the 00 in the date format string is needed otherwise later on it thinks scheduled ones are overdue.
864 SELECT SQL_CALC_FOUND_ROWS COUNT(ca.id) AS ismultiple,
866 ca.activity_type_id AS type,
867 ca.activity_type_id AS activity_type_id,
868 tcc.sort_name AS target_contact_name,
869 tcc.id AS target_contact_id,
870 scc.sort_name AS source_contact_name,
871 scc.id AS source_contact_id,
872 acc.sort_name AS assignee_contact_name,
873 acc.id AS assignee_contact_id,
875 IF(ca.activity_date_time < NOW() AND ca.status_id=ov.value,
876 ca.activity_date_time,
877 DATE_ADD(NOW(), INTERVAL 1 YEAR)
878 ), '%Y%m%d%H%i00') AS overdue_date,
879 DATE_FORMAT(ca.activity_date_time, '%Y%m%d%H%i00') AS display_date,
880 ca.status_id AS status,
881 ca.subject AS subject,
882 ca.is_deleted AS deleted,
883 ca.priority_id AS priority,
885 GROUP_CONCAT(ef.file_id) AS attachment_ids ";
888 FROM civicrm_case_activity cca
889 INNER JOIN civicrm_activity ca
890 ON ca.id = cca.activity_id
891 INNER JOIN civicrm_activity_contact cas
892 ON cas.activity_id = ca.id
893 AND cas.record_type_id = {$sourceID}
894 INNER JOIN civicrm_contact scc
895 ON scc.id = cas.contact_id
896 LEFT JOIN civicrm_activity_contact caa
897 ON caa.activity_id = ca.id
898 AND caa.record_type_id = {$assigneeID}
899 LEFT JOIN civicrm_contact acc
900 ON acc.id = caa.contact_id
901 LEFT JOIN civicrm_activity_contact cat
902 ON cat.activity_id = ca.id
903 AND cat.record_type_id = {$targetID}
904 LEFT JOIN civicrm_contact tcc
905 ON tcc.id = cat.contact_id
906 INNER JOIN civicrm_option_group cog
907 ON cog.name = 'activity_type'
908 INNER JOIN civicrm_option_value cov
909 ON cov.option_group_id = cog.id
910 AND cov.value = ca.activity_type_id
911 AND cov.is_active = 1
912 LEFT JOIN civicrm_entity_file ef
913 ON ef.entity_table = 'civicrm_activity'
914 AND ef.entity_id = ca.id
915 LEFT OUTER JOIN civicrm_option_group og
916 ON og.name = 'activity_status'
917 LEFT OUTER JOIN civicrm_option_value ov
918 ON ov.option_group_id=og.id
919 AND ov.name = 'Scheduled'";
922 WHERE cca.case_id= %1
923 AND ca.is_current_revision = 1';
925 if (!empty($params['source_contact_id'])) {
927 AND cas.contact_id = " . CRM_Utils_Type
::escape($params['source_contact_id'], 'Integer');
930 if (!empty($params['status_id'])) {
932 AND ca.status_id = " . CRM_Utils_Type
::escape($params['status_id'], 'Integer');
935 if (!empty($params['activity_deleted'])) {
937 AND ca.is_deleted = 1";
941 AND ca.is_deleted = 0";
944 if (!empty($params['activity_type_id'])) {
946 AND ca.activity_type_id = " . CRM_Utils_Type
::escape($params['activity_type_id'], 'Integer');
949 if (!empty($params['activity_date_low'])) {
950 $fromActivityDate = CRM_Utils_Type
::escape(CRM_Utils_Date
::processDate($params['activity_date_low']), 'Date');
952 if (!empty($fromActivityDate)) {
954 AND ca.activity_date_time >= '{$fromActivityDate}'";
957 if (!empty($params['activity_date_high'])) {
958 $toActivityDate = CRM_Utils_Type
::escape(CRM_Utils_Date
::processDate($params['activity_date_high']), 'Date');
959 $toActivityDate = $toActivityDate ?
$toActivityDate +
235959 : NULL;
961 if (!empty($toActivityDate)) {
963 AND ca.activity_date_time <= '{$toActivityDate}'";
967 GROUP BY ca.id, tcc.id, scc.id, acc.id, ov.value";
969 $sortBy = CRM_Utils_Array
::value('sortBy', $params);
971 // CRM-5081 - added id to act like creation date
973 ORDER BY overdue_date ASC, display_date DESC, weight DESC";
976 $sortBy = CRM_Utils_Type
::escape($sortBy, 'String');
977 $orderBy = " ORDER BY $sortBy ";
980 $page = CRM_Utils_Array
::value('page', $params);
981 $rp = CRM_Utils_Array
::value('rp', $params);
989 $start = (($page - 1) * $rp);
990 $limit = " LIMIT $start, $rp";
992 $query = $select . $from . $where . $groupBy . $orderBy . $limit;
993 $queryParams = [1 => [$caseID, 'Integer']];
995 $dao = CRM_Core_DAO
::executeQuery($query, $queryParams);
996 $caseCount = CRM_Core_DAO
::singleValueQuery('SELECT FOUND_ROWS()');
998 $activityTypes = CRM_Case_PseudoConstant
::caseActivityType(FALSE, TRUE);
1000 $compStatusValues = array_keys(
1001 CRM_Activity_BAO_Activity
::getStatusesByType(CRM_Activity_BAO_Activity
::COMPLETED
) +
1002 CRM_Activity_BAO_Activity
::getStatusesByType(CRM_Activity_BAO_Activity
::CANCELLED
)
1006 $userID = CRM_Core_Session
::getLoggedInContactID();
1009 $caseActivities = [];
1011 while ($dao->fetch()) {
1012 $caseActivityId = $dao->id
;
1014 //Do we have permission to access given case activity record.
1015 if (!self
::checkPermission($caseActivityId, 'view', $dao->activity_type_id
, $userID)) {
1019 $caseActivities[$caseActivityId]['DT_RowId'] = $caseActivityId;
1020 //Add classes to the row, via DataTables syntax
1021 $caseActivities[$caseActivityId]['DT_RowClass'] = "crm-entity status-id-$dao->status";
1023 if (CRM_Utils_Array
::crmInArray($dao->status
, $compStatusValues)) {
1024 $caseActivities[$caseActivityId]['DT_RowClass'] .= " status-completed";
1027 if (CRM_Utils_Date
::overdue($dao->display_date
)) {
1028 $caseActivities[$caseActivityId]['DT_RowClass'] .= " status-overdue";
1031 $caseActivities[$caseActivityId]['DT_RowClass'] .= " status-scheduled";
1035 if (!empty($dao->priority
)) {
1036 if ($dao->priority
== CRM_Core_PseudoConstant
::getKey('CRM_Activity_BAO_Activity', 'priority_id', 'Urgent')) {
1037 $caseActivities[$caseActivityId]['DT_RowClass'] .= " priority-urgent ";
1039 elseif ($dao->priority
== CRM_Core_PseudoConstant
::getKey('CRM_Activity_BAO_Activity', 'priority_id', 'Low')) {
1040 $caseActivities[$caseActivityId]['DT_RowClass'] .= " priority-low ";
1044 //Add data to the row for inline editing, via DataTable syntax
1045 $caseActivities[$caseActivityId]['DT_RowAttr'] = [];
1046 $caseActivities[$caseActivityId]['DT_RowAttr']['data-entity'] = 'activity';
1047 $caseActivities[$caseActivityId]['DT_RowAttr']['data-id'] = $caseActivityId;
1049 //Activity Date and Time
1050 $caseActivities[$caseActivityId]['activity_date_time'] = CRM_Utils_Date
::customFormat($dao->display_date
);
1053 $caseActivities[$caseActivityId]['subject'] = $dao->subject
;
1056 $caseActivities[$caseActivityId]['type'] = (!empty($activityTypes[$dao->type
]['icon']) ?
'<span class="crm-i ' . $activityTypes[$dao->type
]['icon'] . '"></span> ' : '')
1057 . $activityTypes[$dao->type
]['label'];
1059 // Activity Target (With Contact) (There can be more than one)
1060 $targetContact = self
::formatContactLink($dao->target_contact_id
, $dao->target_contact_name
);
1061 if (empty($caseActivities[$caseActivityId]['target_contact_name'])) {
1062 $caseActivities[$caseActivityId]['target_contact_name'] = $targetContact;
1065 if (strpos($caseActivities[$caseActivityId]['target_contact_name'], $targetContact) === FALSE) {
1066 $caseActivities[$caseActivityId]['target_contact_name'] .= '; ' . $targetContact;
1070 // Activity Source Contact (Reporter) (There can only be one)
1071 $sourceContact = self
::formatContactLink($dao->source_contact_id
, $dao->source_contact_name
);
1072 $caseActivities[$caseActivityId]['source_contact_name'] = $sourceContact;
1074 // Activity Assignee (There can be more than one)
1075 $assigneeContact = self
::formatContactLink($dao->assignee_contact_id
, $dao->assignee_contact_name
);
1076 if (empty($caseActivities[$caseActivityId]['assignee_contact_name'])) {
1077 $caseActivities[$caseActivityId]['assignee_contact_name'] = $assigneeContact;
1080 if (strpos($caseActivities[$caseActivityId]['assignee_contact_name'], $assigneeContact) === FALSE) {
1081 $caseActivities[$caseActivityId]['assignee_contact_name'] .= '; ' . $assigneeContact;
1085 // Activity Status Label for Case activities list
1087 if ($dao->deleted
) {
1088 $deleted = '<br /> ' . ts('(deleted)');
1090 $caseActivities[$caseActivityId]['status_id'] = CRM_Core_PseudoConstant
::getLabel('CRM_Activity_BAO_Activity', 'activity_status_id', $dao->status
) . $deleted;
1091 // if there are file attachments we will return how many
1092 if (!empty($dao->attachment_ids
)) {
1093 $attachmentIDs = array_unique(explode(',', $dao->attachment_ids
));
1094 $caseActivity['no_attachments'] = count($attachmentIDs);
1097 $caseActivities[$caseActivityId]['links']
1098 = CRM_Case_Selector_Search
::addCaseActivityLinks($caseID, $contactID, $userID, $context, $dao);
1101 $caseActivitiesDT = [];
1102 $caseActivitiesDT['data'] = array_values($caseActivities);
1103 $caseActivitiesDT['recordsTotal'] = $caseCount;
1104 $caseActivitiesDT['recordsFiltered'] = $caseCount;
1106 return $caseActivitiesDT;
1110 * Helper function to generate a formatted contact link/name for display in the Case activities tab
1113 * @param $contactName
1117 private static function formatContactLink($contactId, $contactName) {
1118 if (empty($contactId)) {
1122 $hasViewContact = CRM_Contact_BAO_Contact_Permission
::allow($contactId);
1124 if ($hasViewContact) {
1125 $contactViewUrl = CRM_Utils_System
::url("civicrm/contact/view", "reset=1&cid={$contactId}");
1126 return "<a href=\"{$contactViewUrl}\">" . $contactName . "</a>";
1129 return $contactName;
1134 * Get Case Related Contacts.
1136 * @param int $caseID
1138 * @param bool $includeDetails
1139 * If true include details of contacts.
1142 * array of return properties
1145 public static function getRelatedContacts($caseID, $includeDetails = TRUE) {
1147 if ($includeDetails) {
1148 $caseInfo = civicrm_api3('Case', 'getsingle', [
1150 // 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
1151 'return' => ['case_type_id', 'case_type_id.name', 'case_type_id.definition', 'contact_id'],
1153 if (!empty($caseInfo['case_type_id.definition']['caseRoles'])) {
1154 $caseRoles = CRM_Utils_Array
::rekey($caseInfo['case_type_id.definition']['caseRoles'], 'name');
1160 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, ce.email, cp.phone
1161 FROM civicrm_relationship cr
1162 JOIN civicrm_relationship_type crt
1163 ON crt.id = cr.relationship_type_id
1164 JOIN civicrm_contact cc
1165 ON cc.id = cr.contact_id_a
1166 AND cc.is_deleted <> 1
1167 LEFT JOIN civicrm_email ce
1168 ON ce.contact_id = cc.id
1169 AND ce.is_primary= 1
1170 LEFT JOIN civicrm_phone cp
1171 ON cp.contact_id = cc.id
1172 AND cp.is_primary= 1
1173 WHERE cr.case_id = %1
1175 AND cc.id NOT IN (%2)
1177 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, ce.email, cp.phone
1178 FROM civicrm_relationship cr
1179 JOIN civicrm_relationship_type crt
1180 ON crt.id = cr.relationship_type_id
1181 JOIN civicrm_contact cc
1182 ON cc.id = cr.contact_id_b
1183 AND cc.is_deleted <> 1
1184 LEFT JOIN civicrm_email ce
1185 ON ce.contact_id = cc.id
1186 AND ce.is_primary= 1
1187 LEFT JOIN civicrm_phone cp
1188 ON cp.contact_id = cc.id
1189 AND cp.is_primary= 1
1190 WHERE cr.case_id = %1
1192 AND cc.id NOT IN (%2)
1195 1 => [$caseID, 'Integer'],
1196 2 => [implode(',', $caseInfo['client_id']), 'String'],
1198 $dao = CRM_Core_DAO
::executeQuery($query, $params);
1200 while ($dao->fetch()) {
1201 if (!$includeDetails) {
1202 $values[$dao->id
] = 1;
1206 'contact_id' => $dao->id
,
1207 'display_name' => $dao->name
,
1208 'sort_name' => $dao->sort_name
,
1209 'relationship_type_id' => $dao->relationship_type_id
,
1210 'role' => $dao->role
,
1211 'email' => $dao->email
,
1212 'phone' => $dao->phone
,
1214 // Add more info about the role (creator, manager)
1215 $role = CRM_Utils_Array
::value($dao->role_name
, $caseRoles);
1217 unset($role['name']);
1220 $values[] = $details;
1228 * Send e-mail copy of activity
1230 * @param int $clientId
1231 * @param int $activityId
1233 * @param array $contacts
1234 * Array of related contact.
1236 * @param null $attachments
1237 * @param int $caseId
1239 * @return bool |array
1241 public static function sendActivityCopy($clientId, $activityId, $contacts, $attachments = NULL, $caseId) {
1246 $tplParams = $activityInfo = [];
1247 $activityTypeId = CRM_Core_DAO
::getFieldValue('CRM_Activity_DAO_Activity', $activityId, 'activity_type_id');
1248 // If it's a case activity
1250 $nonCaseActivityTypes = CRM_Core_PseudoConstant
::activityType();
1251 if (!empty($nonCaseActivityTypes[$activityTypeId])) {
1252 $anyActivity = TRUE;
1255 $anyActivity = FALSE;
1257 $tplParams['isCaseActivity'] = 1;
1258 $tplParams['client_id'] = $clientId;
1261 $anyActivity = TRUE;
1264 $xmlProcessorProcess = new CRM_Case_XMLProcessor_Process();
1265 $isRedact = $xmlProcessorProcess->getRedactActivityEmail();
1267 $xmlProcessorReport = new CRM_Case_XMLProcessor_Report();
1269 $activityInfo = $xmlProcessorReport->getActivityInfo($clientId, $activityId, $anyActivity, $isRedact);
1271 $activityInfo['fields'][] = ['label' => 'Case ID', 'type' => 'String', 'value' => $caseId];
1273 $tplParams['activityTypeName'] = CRM_Core_PseudoConstant
::getLabel('CRM_Activity_DAO_Activity', 'activity_type_id', $activityTypeId);
1274 $tplParams['activity'] = $activityInfo;
1275 foreach ($tplParams['activity']['fields'] as $k => $val) {
1276 if (CRM_Utils_Array
::value('label', $val) == ts('Subject')) {
1277 $activitySubject = $val['value'];
1281 $session = CRM_Core_Session
::singleton();
1282 // CRM-8926 If user is not logged in, use the activity creator as userID
1283 if (!($userID = $session->get('userID'))) {
1284 $userID = CRM_Activity_BAO_Activity
::getSourceContactID($activityId);
1287 //also create activities simultaneously of this copy.
1288 $activityParams = [];
1290 $activityParams['source_record_id'] = $activityId;
1291 $activityParams['source_contact_id'] = $userID;
1292 $activityParams['activity_type_id'] = CRM_Core_PseudoConstant
::getKey('CRM_Activity_DAO_Activity', 'activity_type_id', 'Email');
1293 $activityParams['activity_date_time'] = date('YmdHis');
1294 $activityParams['status_id'] = CRM_Core_PseudoConstant
::getKey('CRM_Activity_DAO_Activity', 'activity_status_id', 'Completed');
1295 $activityParams['medium_id'] = CRM_Core_PseudoConstant
::getKey('CRM_Activity_DAO_Activity', 'encounter_medium', 'email');
1296 $activityParams['case_id'] = $caseId;
1297 $activityParams['is_auto'] = 0;
1298 $activityParams['target_id'] = $clientId;
1300 $tplParams['activitySubject'] = $activitySubject;
1302 // if it’s a case activity, add hashed id to the template (CRM-5916)
1304 $tplParams['idHash'] = substr(sha1(CIVICRM_SITE_KEY
. $caseId), 0, 7);
1308 // CRM-20308 get receiptFrom defaults see https://issues.civicrm.org/jira/browse/CRM-20308
1309 $receiptFrom = self
::getReceiptFrom($activityId);
1311 $recordedActivityParams = [];
1313 foreach ($contacts as $mail => $info) {
1314 $tplParams['contact'] = $info;
1315 self
::buildPermissionLinks($tplParams, $activityParams);
1317 $displayName = CRM_Utils_Array
::value('display_name', $info);
1319 list($result[CRM_Utils_Array
::value('contact_id', $info)], $subject, $message, $html) = CRM_Core_BAO_MessageTemplate
::sendTemplate(
1321 'groupName' => 'msg_tpl_workflow_case',
1322 'valueName' => 'case_activity',
1323 'contactId' => CRM_Utils_Array
::value('contact_id', $info),
1324 'tplParams' => $tplParams,
1325 'from' => $receiptFrom,
1326 'toName' => $displayName,
1328 'attachments' => $attachments,
1332 $activityParams['subject'] = ts('%1 - copy sent to %2', [1 => $activitySubject, 2 => $displayName]);
1333 $activityParams['details'] = $message;
1335 if (!empty($result[$info['contact_id']])) {
1337 * Really only need to record one activity with all the targets combined.
1338 * Originally the template was going to possibly have different content, e.g. depending on permissions,
1339 * but it's always the same content at the moment.
1341 if (empty($recordedActivityParams)) {
1342 $recordedActivityParams = $activityParams;
1345 $recordedActivityParams['subject'] .= "; $displayName";
1347 $recordedActivityParams['target_contact_id'][] = $info['contact_id'];
1350 unset($result[CRM_Utils_Array
::value('contact_id', $info)]);
1354 if (!empty($recordedActivityParams)) {
1355 $activity = CRM_Activity_BAO_Activity
::create($recordedActivityParams);
1357 //create case_activity record if its case activity.
1360 'activity_id' => $activity->id
,
1361 'case_id' => $caseId,
1363 self
::processCaseActivity($caseParams);
1371 * Retrieve count of activities having a particular type, and
1372 * associated with a particular case.
1374 * @param int $caseId
1376 * @param int $activityTypeId
1377 * ID of the activity type.
1381 public static function getCaseActivityCount($caseId, $activityTypeId) {
1383 1 => [$caseId, 'Integer'],
1384 2 => [$activityTypeId, 'Integer'],
1386 $query = "SELECT count(ca.id) as countact
1387 FROM civicrm_activity ca
1388 INNER JOIN civicrm_case_activity cca ON ca.id = cca.activity_id
1389 WHERE ca.activity_type_id = %2
1390 AND cca.case_id = %1
1391 AND ca.is_deleted = 0";
1393 $dao = CRM_Core_DAO
::executeQuery($query, $queryParam);
1394 if ($dao->fetch()) {
1395 return $dao->countact
;
1402 * Create an activity for a case via email.
1407 * @return array|void
1408 * $activity object of newly creted activity via email
1410 public static function recordActivityViaEmail($file) {
1411 if (!file_exists($file) ||
1414 return CRM_Core_Error
::fatal(ts('File %1 does not exist or is not readable',
1419 $result = CRM_Utils_Mail_Incoming
::parse($file);
1420 if ($result['is_error']) {
1424 foreach ($result['to'] as $to) {
1427 $emailPattern = '/^([A-Z0-9._%+-]+)\+([\d]+)@[A-Z0-9.-]+\.[A-Z]{2,4}$/i';
1428 $replacement = preg_replace($emailPattern, '$2', $to['email']);
1430 if ($replacement !== $to['email']) {
1431 $caseId = $replacement;
1432 //if caseId is invalid, return as error file
1433 if (!CRM_Core_DAO
::getFieldValue('CRM_Case_DAO_Case', $caseId, 'id')) {
1434 return CRM_Core_Error
::createAPIError(ts('Invalid case ID ( %1 ) in TO: field.',
1443 // TODO: May want to replace this with a call to getRelatedAndGlobalContacts() when this feature is revisited.
1444 // (Or for efficiency call the global one outside the loop and then union with this each time.)
1445 $contactDetails = self
::getRelatedContacts($caseId, FALSE);
1447 if (!empty($contactDetails[$result['from']['id']])) {
1449 $params['subject'] = $result['subject'];
1450 $params['activity_date_time'] = $result['date'];
1451 $params['details'] = $result['body'];
1452 $params['source_contact_id'] = $result['from']['id'];
1453 $params['status_id'] = CRM_Core_PseudoConstant
::getKey('CRM_Activity_BAO_Activity', 'activity_status_id', 'Completed');
1455 $details = CRM_Case_PseudoConstant
::caseActivityType();
1457 preg_match('/^\W+([a-zA-Z0-9_ ]+)(\W+)?\n/i',
1458 $result['body'], $matches
1461 if (!empty($matches) && isset($matches[1])) {
1462 $activityType = trim($matches[1]);
1463 if (isset($details[$activityType])) {
1464 $params['activity_type_id'] = $details[$activityType]['id'];
1467 if (!isset($params['activity_type_id'])) {
1468 $params['activity_type_id'] = CRM_Core_PseudoConstant
::getKey('CRM_Activity_BAO_Activity', 'activity_type_id', 'Inbound Email');
1472 $activity = CRM_Activity_BAO_Activity
::create($params);
1475 'activity_id' => $activity->id
,
1476 'case_id' => $caseId,
1478 self
::processCaseActivity($caseParams);
1481 return CRM_Core_Error
::createAPIError(ts('FROM email contact %1 doesn\'t have a relationship to the referenced case.',
1482 [1 => $result['from']['email']]
1489 * Retrieve the scheduled activity type and date.
1491 * @param array $cases
1492 * Array of contact and case id.
1494 * @param string $type
1497 * Array of scheduled activity type and date
1501 public static function getNextScheduledActivity($cases, $type = 'upcoming') {
1502 $session = CRM_Core_Session
::singleton();
1503 $userID = $session->get('userID');
1505 $caseID = implode(',', $cases['case_id']);
1506 $contactID = implode(',', $cases['contact_id']);
1508 $condition = " civicrm_case_contact.contact_id IN( {$contactID} )
1509 AND civicrm_case.id IN( {$caseID})
1510 AND civicrm_case.is_deleted = {$cases['case_deleted']}";
1512 $query = self
::getCaseActivityQuery($type, $userID, $condition);
1513 $activityTypes = CRM_Activity_BAO_Activity
::buildOptions('activity_type_id');
1515 $res = CRM_Core_DAO
::executeQuery($query);
1518 while ($res->fetch()) {
1519 if ($type == 'upcoming') {
1520 $activityInfo[$res->case_id
]['date'] = $res->activity_date_time
;
1521 $activityInfo[$res->case_id
]['type'] = CRM_Utils_Array
::value($res->activity_type_id
, $activityTypes);
1524 $activityInfo[$res->case_id
]['date'] = $res->activity_date_time
;
1525 $activityInfo[$res->case_id
]['type'] = CRM_Utils_Array
::value($res->activity_type_id
, $activityTypes);
1529 return $activityInfo;
1533 * Combine all the exportable fields from the lower levels object.
1536 * array of exportable Fields
1538 public static function &exportableFields() {
1539 if (!self
::$_exportableFields) {
1540 if (!self
::$_exportableFields) {
1541 self
::$_exportableFields = [];
1544 $fields = CRM_Case_DAO_Case
::export();
1545 $fields['case_role'] = ['title' => ts('Role in Case')];
1546 $fields['case_type'] = [
1547 'title' => ts('Case Type'),
1548 'name' => 'case_type',
1550 $fields['case_status'] = [
1551 'title' => ts('Case Status'),
1552 'name' => 'case_status',
1555 // add custom data for cases
1556 $fields = array_merge($fields, CRM_Core_BAO_CustomField
::getFieldsForImport('Case'));
1558 self
::$_exportableFields = $fields;
1560 return self
::$_exportableFields;
1564 * Restore the record that are associated with this case.
1566 * @param int $caseId
1567 * Id of the case to restore.
1571 public static function restoreCase($caseId) {
1572 //restore activities
1573 $activities = self
::getCaseActivityDates($caseId);
1575 foreach ($activities as $value) {
1576 CRM_Activity_BAO_Activity
::restoreActivity($value);
1580 $case = new CRM_Case_DAO_Case();
1581 $case->id
= $caseId;
1582 $case->is_deleted
= 0;
1585 //CRM-7364, enable relationships
1586 self
::enableDisableCaseRelationships($caseId, TRUE);
1593 * @param null $showLinks
1594 * @param bool $returnOnlyCount
1595 * @param int $offset
1596 * @param int $rowCount
1600 public static function getGlobalContacts(&$groupInfo, $sort = NULL, $showLinks = NULL, $returnOnlyCount = FALSE, $offset = 0, $rowCount = 25) {
1601 $globalContacts = [];
1603 $settingsProcessor = new CRM_Case_XMLProcessor_Settings();
1604 $settings = $settingsProcessor->run();
1605 if (!empty($settings)) {
1606 $groupInfo['name'] = $settings['groupname'];
1607 if ($groupInfo['name']) {
1608 $searchParams = ['name' => $groupInfo['name']];
1610 CRM_Contact_BAO_Group
::retrieve($searchParams, $results);
1612 $groupInfo['id'] = $results['id'];
1613 $groupInfo['title'] = $results['title'];
1614 $params = [['group', '=', $groupInfo['id'], 0, 0]];
1615 $return = ['contact_id' => 1, 'sort_name' => 1, 'display_name' => 1, 'email' => 1, 'phone' => 1];
1616 list($globalContacts) = CRM_Contact_BAO_Query
::apiQuery($params, $return, NULL, $sort, $offset, $rowCount, TRUE, $returnOnlyCount);
1618 if ($returnOnlyCount) {
1619 return $globalContacts;
1623 foreach ($globalContacts as $idx => $contact) {
1624 $globalContacts[$idx]['sort_name'] = '<a href="' . CRM_Utils_System
::url('civicrm/contact/view', "reset=1&cid={$contact['contact_id']}") . '">' . $contact['sort_name'] . '</a>';
1630 return $globalContacts;
1634 * Convenience function to get both case contacts and global in one array.
1636 * @param int $caseId
1640 public static function getRelatedAndGlobalContacts($caseId) {
1641 $relatedContacts = self
::getRelatedContacts($caseId);
1644 $globalContacts = self
::getGlobalContacts($groupInfo);
1646 //unset values which are not required.
1647 foreach ($globalContacts as $k => & $v) {
1648 unset($v['email_id']);
1649 unset($v['group_contact_id']);
1650 unset($v['status']);
1652 $v['role'] = $groupInfo['title'];
1654 //include multiple listings for the same contact/different roles.
1655 $relatedGlobalContacts = array_merge($relatedContacts, $globalContacts);
1656 return $relatedGlobalContacts;
1660 * Get Case ActivitiesDueDates with given criteria.
1662 * @param int $caseID
1664 * @param array $criteriaParams
1666 * @param bool $latestDate
1667 * If set newest or oldest date is selected.
1670 * case activities due dates
1673 public static function getCaseActivityDates($caseID, $criteriaParams = [], $latestDate = FALSE) {
1675 $selectDate = " ca.activity_date_time";
1676 $where = $groupBy = ' ';
1683 if (!empty($criteriaParams['activity_type_id'])) {
1684 $where .= " AND ca.activity_type_id = " . CRM_Utils_Type
::escape($criteriaParams['activity_type_id'], 'Integer');
1685 $where .= " AND ca.is_current_revision = 1";
1686 $groupBy .= " GROUP BY ca.activity_type_id, ca.id";
1689 if (!empty($criteriaParams['newest'])) {
1690 $selectDate = " max(ca.activity_date_time) ";
1693 $selectDate = " min(ca.activity_date_time) ";
1697 $query = "SELECT ca.id, {$selectDate} as activity_date
1698 FROM civicrm_activity ca
1699 LEFT JOIN civicrm_case_activity cca ON cca.activity_id = ca.id LEFT JOIN civicrm_case cc ON cc.id = cca.case_id
1700 WHERE cc.id = %1 {$where} {$groupBy}";
1702 $params = [1 => [$caseID, 'Integer']];
1703 $dao = CRM_Core_DAO
::executeQuery($query, $params);
1705 while ($dao->fetch()) {
1706 $values[$dao->id
]['id'] = $dao->id
;
1707 $values[$dao->id
]['activity_date'] = $dao->activity_date
;
1713 * Create activities when Case or Other roles assigned/modified/deleted.
1715 * @param int $caseId
1716 * @param int $relationshipId
1718 * @param int $relContactId
1719 * Case role assignee contactId.
1720 * @param int $contactId
1722 public static function createCaseRoleActivity($caseId, $relationshipId, $relContactId = NULL, $contactId = NULL) {
1723 if (!$caseId ||
!$relationshipId ||
empty($relationshipId)) {
1728 if (is_array($relationshipId)) {
1729 $relationshipId = implode(',', $relationshipId);
1730 $relationshipClause = " civicrm_relationship.id IN ($relationshipId)";
1733 $relationshipClause = " civicrm_relationship.id = %1";
1734 $queryParam[1] = [$relationshipId, 'Positive'];
1738 SELECT cc.display_name as clientName,
1739 cca.display_name as assigneeContactName,
1740 civicrm_relationship.case_id as caseId,
1741 civicrm_relationship_type.label_a_b as relation_a_b,
1742 civicrm_relationship_type.label_b_a as relation_b_a,
1743 civicrm_relationship.contact_id_b as rel_contact_id,
1744 civicrm_relationship.contact_id_a as assign_contact_id
1745 FROM civicrm_relationship_type, civicrm_relationship
1746 LEFT JOIN civicrm_contact cc ON cc.id = civicrm_relationship.contact_id_b
1747 LEFT JOIN civicrm_contact cca ON cca.id = civicrm_relationship.contact_id_a
1748 WHERE civicrm_relationship.relationship_type_id = civicrm_relationship_type.id AND {$relationshipClause}";
1750 $dao = CRM_Core_DAO
::executeQuery($query, $queryParam);
1752 while ($dao->fetch()) {
1753 // The assignee is not the client.
1754 if ($dao->rel_contact_id
!= $contactId) {
1755 $caseRelationship = $dao->relation_a_b
;
1756 $assigneContactName = $dao->clientName
;
1757 $assigneContactIds[$dao->rel_contact_id
] = $dao->rel_contact_id
;
1760 $caseRelationship = $dao->relation_b_a
;
1761 $assigneContactName = $dao->assigneeContactName
;
1762 $assigneContactIds[$dao->assign_contact_id
] = $dao->assign_contact_id
;
1766 $session = CRM_Core_Session
::singleton();
1768 'source_contact_id' => $session->get('userID'),
1769 'subject' => $caseRelationship . ' : ' . $assigneContactName,
1770 'activity_date_time' => date('YmdHis'),
1771 'status_id' => CRM_Core_PseudoConstant
::getKey('CRM_Activity_BAO_Activity', 'activity_status_id', 'Completed'),
1774 //if $relContactId is passed, role is added or modified.
1775 if (!empty($relContactId)) {
1776 $activityParams['assignee_contact_id'] = $assigneContactIds;
1777 $activityTypeID = CRM_Core_PseudoConstant
::getKey('CRM_Activity_BAO_Activity', 'activity_type_id', 'Assign Case Role');
1780 $activityTypeID = CRM_Core_PseudoConstant
::getKey('CRM_Activity_BAO_Activity', 'activity_type_id', 'Remove Case Role');
1783 $activityParams['activity_type_id'] = $activityTypeID;
1785 $activity = CRM_Activity_BAO_Activity
::create($activityParams);
1787 //create case_activity record.
1789 'activity_id' => $activity->id
,
1790 'case_id' => $caseId,
1793 CRM_Case_BAO_Case
::processCaseActivity($caseParams);
1798 * contact which is assigned a case role of case manager.
1800 * @param int $caseType
1802 * @param int $caseId
1806 * html hyperlink of manager contact view page
1809 public static function getCaseManagerContact($caseType, $caseId) {
1810 if (!$caseType ||
!$caseId) {
1814 $caseManagerName = '---';
1815 $xmlProcessor = new CRM_Case_XMLProcessor_Process();
1817 $managerRoleId = $xmlProcessor->getCaseManagerRoleId($caseType);
1819 if (!empty($managerRoleId)) {
1820 if (substr($managerRoleId, -4) == '_a_b') {
1821 $managerRoleQuery = "
1822 SELECT civicrm_contact.id as casemanager_id,
1823 civicrm_contact.sort_name as casemanager
1824 FROM civicrm_contact
1825 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
1826 LEFT JOIN civicrm_case ON civicrm_case.id = civicrm_relationship.case_id
1827 WHERE civicrm_case.id = %2 AND is_active = 1";
1829 if (substr($managerRoleId, -4) == '_b_a') {
1830 $managerRoleQuery = "
1831 SELECT civicrm_contact.id as casemanager_id,
1832 civicrm_contact.sort_name as casemanager
1833 FROM civicrm_contact
1834 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
1835 LEFT JOIN civicrm_case ON civicrm_case.id = civicrm_relationship.case_id
1836 WHERE civicrm_case.id = %2 AND is_active = 1";
1839 $managerRoleParams = [
1840 1 => [substr($managerRoleId, 0, -4), 'Integer'],
1841 2 => [$caseId, 'Integer'],
1844 $dao = CRM_Core_DAO
::executeQuery($managerRoleQuery, $managerRoleParams);
1845 if ($dao->fetch()) {
1846 $caseManagerName = sprintf('<a href="%s">%s</a>',
1847 CRM_Utils_System
::url('civicrm/contact/view', ['cid' => $dao->casemanager_id
]),
1853 return $caseManagerName;
1857 * @param int $contactId
1858 * @param bool $excludeDeleted
1862 public static function caseCount($contactId = NULL, $excludeDeleted = TRUE) {
1863 $params = ['check_permissions' => TRUE];
1864 if ($excludeDeleted) {
1865 $params['is_deleted'] = 0;
1868 $params['contact_id'] = $contactId;
1871 return civicrm_api3('Case', 'getcount', $params);
1873 catch (CiviCRM_API3_Exception
$e) {
1874 // Lack of permissions will throw an exception
1880 * Retrieve related case ids for given case.
1882 * @param int $caseId
1883 * @param bool $excludeDeleted
1884 * Do not include deleted cases.
1888 public static function getRelatedCaseIds($caseId, $excludeDeleted = TRUE) {
1889 //FIXME : do check for permissions.
1895 $linkActType = CRM_Core_PseudoConstant
::getKey('CRM_Activity_BAO_Activity', 'activity_type_id', 'Link Cases');
1896 if (!$linkActType) {
1900 $whereClause = "mainCase.id = %2";
1901 if ($excludeDeleted) {
1902 $whereClause .= " AND ( relAct.is_deleted = 0 OR relAct.is_deleted IS NULL )";
1906 SELECT relCaseAct.case_id
1907 FROM civicrm_case mainCase
1908 INNER JOIN civicrm_case_activity mainCaseAct ON (mainCaseAct.case_id = mainCase.id)
1909 INNER JOIN civicrm_activity mainAct ON (mainCaseAct.activity_id = mainAct.id AND mainAct.activity_type_id = %1)
1910 INNER JOIN civicrm_case_activity relCaseAct ON (relCaseAct.activity_id = mainAct.id AND mainCaseAct.id != relCaseAct.id)
1911 INNER JOIN civicrm_activity relAct ON (relCaseAct.activity_id = relAct.id AND relAct.activity_type_id = %1)
1912 WHERE $whereClause";
1914 $dao = CRM_Core_DAO
::executeQuery($query, [
1915 1 => [$linkActType, 'Integer'],
1916 2 => [$caseId, 'Integer'],
1918 $relatedCaseIds = [];
1919 while ($dao->fetch()) {
1920 $relatedCaseIds[$dao->case_id
] = $dao->case_id
;
1923 return array_values($relatedCaseIds);
1927 * Retrieve related case details for given case.
1929 * @param int $caseId
1930 * @param bool $excludeDeleted
1931 * Do not include deleted cases.
1935 public static function getRelatedCases($caseId, $excludeDeleted = TRUE) {
1936 $relatedCaseIds = self
::getRelatedCaseIds($caseId, $excludeDeleted);
1939 if (!$relatedCaseIds) {
1943 $whereClause = 'relCase.id IN ( ' . implode(',', $relatedCaseIds) . ' )';
1944 if ($excludeDeleted) {
1945 $whereClause .= " AND ( relCase.is_deleted = 0 OR relCase.is_deleted IS NULL )";
1948 //filter for permissioned cases.
1950 $doFilterCases = FALSE;
1951 if (!CRM_Core_Permission
::check('access all cases and activities')) {
1952 $doFilterCases = TRUE;
1953 $filterCases = CRM_Case_BAO_Case
::getCases(FALSE);
1956 //2. fetch the details of related cases.
1958 SELECT relCase.id as id,
1959 civicrm_case_type.title as case_type,
1960 client.display_name as client_name,
1961 client.id as client_id,
1963 FROM civicrm_case relCase
1964 INNER JOIN civicrm_case_contact relCaseContact ON ( relCase.id = relCaseContact.case_id )
1965 INNER JOIN civicrm_contact client ON ( client.id = relCaseContact.contact_id )
1966 LEFT JOIN civicrm_case_type ON relCase.case_type_id = civicrm_case_type.id
1967 WHERE {$whereClause}";
1969 $dao = CRM_Core_DAO
::executeQuery($query);
1970 $contactViewUrl = CRM_Utils_System
::url("civicrm/contact/view", "reset=1&cid=");
1971 $hasViewContact = CRM_Core_Permission
::giveMeAllACLs();
1972 $statuses = CRM_Case_BAO_Case
::buildOptions('status_id');
1974 while ($dao->fetch()) {
1976 if (!$doFilterCases ||
array_key_exists($dao->id
, $filterCases)) {
1977 $caseViewStr = "reset=1&id={$dao->id}&cid={$dao->client_id}&action=view&context=case&selectedChild=case";
1978 $caseViewUrl = CRM_Utils_System
::url("civicrm/contact/view/case", $caseViewStr);
1979 $caseView = "<a class='action-item no-popup crm-hover-button' href='{$caseViewUrl}'>" . ts('View Case') . "</a>";
1981 $clientView = $dao->client_name
;
1982 if ($hasViewContact) {
1983 $clientView = "<a href='{$contactViewUrl}{$dao->client_id}'>$dao->client_name</a>";
1986 $relatedCases[$dao->id
] = [
1987 'case_id' => $dao->id
,
1988 'case_type' => $dao->case_type
,
1989 'client_name' => $clientView,
1990 'case_status' => $statuses[$dao->status_id
],
1991 'links' => $caseView,
1995 return $relatedCases;
1999 * Merge two duplicate contacts' cases - follow CRM-5758 rules.
2001 * @param int $mainContactId
2002 * @param int $otherContactId
2004 * @see CRM_Dedupe_Merger::cpTables()
2006 * TODO: use the 3rd $sqls param to append sql statements rather than executing them here
2009 public static function mergeContacts($mainContactId, $otherContactId) {
2010 self
::mergeCases($mainContactId, NULL, $otherContactId);
2014 * Function perform two task.
2015 * 1. Merge two duplicate contacts cases - follow CRM-5758 rules.
2016 * 2. Merge two cases of same contact - follow CRM-5598 rules.
2018 * @param int $mainContactId
2019 * Contact id of main contact record.
2020 * @param int $mainCaseId
2021 * Case id of main case record.
2022 * @param int $otherContactId
2023 * Contact id of record which is going to merge.
2024 * @param int $otherCaseId
2025 * Case id of record which is going to merge.
2027 * @param bool $changeClient
2030 * @throws \CRM_Core_Exception
2032 public static function mergeCases(
2033 $mainContactId, $mainCaseId = NULL, $otherContactId = NULL,
2034 $otherCaseId = NULL, $changeClient = FALSE) {
2035 $moveToTrash = TRUE;
2037 $duplicateContacts = FALSE;
2038 if ($mainContactId && $otherContactId &&
2039 $mainContactId != $otherContactId
2041 $duplicateContacts = TRUE;
2044 $duplicateCases = FALSE;
2045 if ($mainCaseId && $otherCaseId &&
2046 $mainCaseId != $otherCaseId
2048 $duplicateCases = TRUE;
2052 if (!$duplicateContacts && !$duplicateCases) {
2053 return $mainCaseIds;
2056 $activityTypes = CRM_Activity_BAO_Activity
::buildOptions('activity_type_id', 'validate');
2057 $completedActivityStatus = CRM_Core_PseudoConstant
::getKey('CRM_Activity_BAO_Activity', 'activity_status_id', 'Completed');
2058 $activityContacts = CRM_Activity_BAO_ActivityContact
::buildOptions('record_type_id', 'validate');
2059 $sourceID = CRM_Utils_Array
::key('Activity Source', $activityContacts);
2060 $assigneeID = CRM_Utils_Array
::key('Activity Assignees', $activityContacts);
2061 $targetID = CRM_Utils_Array
::key('Activity Targets', $activityContacts);
2063 $processCaseIds = [$otherCaseId];
2064 if ($duplicateContacts && !$duplicateCases) {
2065 if ($changeClient) {
2066 $processCaseIds = [$mainCaseId];
2069 //get all case ids for other contact.
2070 $processCaseIds = self
::retrieveCaseIdsByContactId($otherContactId, TRUE);
2072 if (!is_array($processCaseIds)) {
2077 $session = CRM_Core_Session
::singleton();
2078 $currentUserId = $session->get('userID');
2080 CRM_Utils_Hook
::pre_case_merge($mainContactId, $mainCaseId, $otherContactId, $otherCaseId, $changeClient);
2082 // copy all cases and connect to main contact id.
2083 foreach ($processCaseIds as $otherCaseId) {
2084 if ($duplicateContacts) {
2085 $mainCase = CRM_Core_DAO
::copyGeneric('CRM_Case_DAO_Case', ['id' => $otherCaseId]);
2086 $mainCaseId = $mainCase->id
;
2091 $mainCaseIds[] = $mainCaseId;
2092 //insert record for case contact.
2093 $otherCaseContact = new CRM_Case_DAO_CaseContact();
2094 $otherCaseContact->case_id
= $otherCaseId;
2095 $otherCaseContact->find();
2096 while ($otherCaseContact->fetch()) {
2097 $mainCaseContact = new CRM_Case_DAO_CaseContact();
2098 $mainCaseContact->case_id
= $mainCaseId;
2099 $mainCaseContact->contact_id
= $otherCaseContact->contact_id
;
2100 if ($mainCaseContact->contact_id
== $otherContactId) {
2101 $mainCaseContact->contact_id
= $mainContactId;
2103 //avoid duplicate object.
2104 if (!$mainCaseContact->find(TRUE)) {
2105 $mainCaseContact->save();
2109 elseif (!$otherContactId) {
2110 $otherContactId = $mainContactId;
2113 if (!$mainCaseId ||
!$otherCaseId ||
2114 !$mainContactId ||
!$otherContactId
2119 // get all activities for other case.
2120 $otherCaseActivities = [];
2121 CRM_Core_DAO
::commonRetrieveAll('CRM_Case_DAO_CaseActivity', 'case_id', $otherCaseId, $otherCaseActivities);
2123 //for duplicate cases do not process singleton activities.
2124 $otherActivityIds = $singletonActivityIds = [];
2125 foreach ($otherCaseActivities as $caseActivityId => $otherIds) {
2126 $otherActId = CRM_Utils_Array
::value('activity_id', $otherIds);
2127 if (!$otherActId ||
in_array($otherActId, $otherActivityIds)) {
2130 $otherActivityIds[] = $otherActId;
2132 if ($duplicateCases) {
2133 if ($openCaseType = array_search('Open Case', $activityTypes)) {
2136 FROM civicrm_activity
2137 WHERE activity_type_id = $openCaseType
2138 AND id IN ( " . implode(',', array_values($otherActivityIds)) . ');';
2139 $dao = CRM_Core_DAO
::executeQuery($sql);
2140 while ($dao->fetch()) {
2141 $singletonActivityIds[] = $dao->id
;
2146 // migrate all activities and connect to main contact.
2147 $copiedActivityIds = $activityMappingIds = [];
2148 sort($otherActivityIds);
2149 foreach ($otherActivityIds as $otherActivityId) {
2151 //for duplicate cases -
2152 //do not migrate singleton activities.
2153 if (!$otherActivityId ||
in_array($otherActivityId, $singletonActivityIds)) {
2157 //migrate activity record.
2158 $otherActivity = new CRM_Activity_DAO_Activity();
2159 $otherActivity->id
= $otherActivityId;
2160 if (!$otherActivity->find(TRUE)) {
2165 $mainActivity = new CRM_Activity_DAO_Activity();
2166 CRM_Core_DAO
::storeValues($otherActivity, $mainActVals);
2167 $mainActivity->copyValues($mainActVals);
2168 $mainActivity->id
= NULL;
2169 $mainActivity->activity_date_time
= CRM_Utils_Date
::isoToMysql($otherActivity->activity_date_time
);
2170 $mainActivity->source_record_id
= CRM_Utils_Array
::value($mainActivity->source_record_id
,
2174 $mainActivity->original_id
= CRM_Utils_Array
::value($mainActivity->original_id
,
2178 $mainActivity->parent_id
= CRM_Utils_Array
::value($mainActivity->parent_id
,
2181 $mainActivity->save();
2182 $mainActivityId = $mainActivity->id
;
2183 if (!$mainActivityId) {
2187 $activityMappingIds[$otherActivityId] = $mainActivityId;
2188 // insert log of all activities
2189 CRM_Activity_BAO_Activity
::logActivityAction($mainActivity);
2191 $copiedActivityIds[] = $otherActivityId;
2193 //create case activity record.
2194 $mainCaseActivity = new CRM_Case_DAO_CaseActivity();
2195 $mainCaseActivity->case_id
= $mainCaseId;
2196 $mainCaseActivity->activity_id
= $mainActivityId;
2197 $mainCaseActivity->save();
2199 //migrate source activity.
2200 $otherSourceActivity = new CRM_Activity_DAO_ActivityContact();
2201 $otherSourceActivity->activity_id
= $otherActivityId;
2202 $otherSourceActivity->record_type_id
= $sourceID;
2203 $otherSourceActivity->find();
2204 while ($otherSourceActivity->fetch()) {
2205 $mainActivitySource = new CRM_Activity_DAO_ActivityContact();
2206 $mainActivitySource->record_type_id
= $sourceID;
2207 $mainActivitySource->activity_id
= $mainActivityId;
2208 $mainActivitySource->contact_id
= $otherSourceActivity->contact_id
;
2209 if ($mainActivitySource->contact_id
== $otherContactId) {
2210 $mainActivitySource->contact_id
= $mainContactId;
2212 //avoid duplicate object.
2213 if (!$mainActivitySource->find(TRUE)) {
2214 $mainActivitySource->save();
2218 //migrate target activities.
2219 $otherTargetActivity = new CRM_Activity_DAO_ActivityContact();
2220 $otherTargetActivity->activity_id
= $otherActivityId;
2221 $otherTargetActivity->record_type_id
= $targetID;
2222 $otherTargetActivity->find();
2223 while ($otherTargetActivity->fetch()) {
2224 $mainActivityTarget = new CRM_Activity_DAO_ActivityContact();
2225 $mainActivityTarget->record_type_id
= $targetID;
2226 $mainActivityTarget->activity_id
= $mainActivityId;
2227 $mainActivityTarget->contact_id
= $otherTargetActivity->contact_id
;
2228 if ($mainActivityTarget->contact_id
== $otherContactId) {
2229 $mainActivityTarget->contact_id
= $mainContactId;
2231 //avoid duplicate object.
2232 if (!$mainActivityTarget->find(TRUE)) {
2233 $mainActivityTarget->save();
2237 //migrate assignee activities.
2238 $otherAssigneeActivity = new CRM_Activity_DAO_ActivityContact();
2239 $otherAssigneeActivity->activity_id
= $otherActivityId;
2240 $otherAssigneeActivity->record_type_id
= $assigneeID;
2241 $otherAssigneeActivity->find();
2242 while ($otherAssigneeActivity->fetch()) {
2243 $mainAssigneeActivity = new CRM_Activity_DAO_ActivityContact();
2244 $mainAssigneeActivity->activity_id
= $mainActivityId;
2245 $mainAssigneeActivity->record_type_id
= $assigneeID;
2246 $mainAssigneeActivity->contact_id
= $otherAssigneeActivity->contact_id
;
2247 if ($mainAssigneeActivity->contact_id
== $otherContactId) {
2248 $mainAssigneeActivity->contact_id
= $mainContactId;
2250 //avoid duplicate object.
2251 if (!$mainAssigneeActivity->find(TRUE)) {
2252 $mainAssigneeActivity->save();
2256 // copy custom fields and attachments
2258 'activityID' => $otherActivityId,
2259 'mainActivityId' => $mainActivityId,
2261 CRM_Activity_BAO_Activity
::copyExtendedActivityData($aparams);
2264 //copy case relationship.
2265 if ($duplicateContacts) {
2266 //migrate relationship records.
2267 $otherRelationship = new CRM_Contact_DAO_Relationship();
2268 $otherRelationship->case_id
= $otherCaseId;
2269 $otherRelationship->find();
2270 $otherRelationshipIds = [];
2271 while ($otherRelationship->fetch()) {
2273 $updateOtherRel = FALSE;
2274 CRM_Core_DAO
::storeValues($otherRelationship, $otherRelVals);
2276 $mainRelationship = new CRM_Contact_DAO_Relationship();
2277 $mainRelationship->copyValues($otherRelVals);
2278 $mainRelationship->id
= NULL;
2279 $mainRelationship->case_id
= $mainCaseId;
2280 if ($mainRelationship->contact_id_a
== $otherContactId) {
2281 $updateOtherRel = TRUE;
2282 $mainRelationship->contact_id_a
= $mainContactId;
2285 //case creator change only when we merge user contact.
2286 if ($mainRelationship->contact_id_b
== $otherContactId) {
2287 //do not change creator for change client.
2288 if (!$changeClient) {
2289 $updateOtherRel = TRUE;
2290 $mainRelationship->contact_id_b
= ($currentUserId) ?
$currentUserId : $mainContactId;
2293 $mainRelationship->end_date
= CRM_Utils_Date
::isoToMysql($otherRelationship->end_date
);
2294 $mainRelationship->start_date
= CRM_Utils_Date
::isoToMysql($otherRelationship->start_date
);
2296 //avoid duplicate object.
2297 if (!$mainRelationship->find(TRUE)) {
2298 $mainRelationship->save();
2301 //get the other relationship ids to update end date.
2302 if ($updateOtherRel) {
2303 $otherRelationshipIds[$otherRelationship->id
] = $otherRelationship->id
;
2307 //update other relationships end dates
2308 if (!empty($otherRelationshipIds)) {
2309 $sql = 'UPDATE civicrm_relationship
2310 SET end_date = CURDATE()
2311 WHERE id IN ( ' . implode(',', $otherRelationshipIds) . ')';
2312 CRM_Core_DAO
::executeQuery($sql);
2316 //move other case to trash.
2317 $mergeCase = self
::deleteCase($otherCaseId, $moveToTrash);
2322 $mergeActSubject = $mergeActSubjectDetails = $mergeActType = '';
2323 if ($changeClient) {
2324 $mainContactDisplayName = CRM_Contact_BAO_Contact
::displayName($mainContactId);
2325 $otherContactDisplayName = CRM_Contact_BAO_Contact
::displayName($otherContactId);
2327 $mergeActType = array_search('Reassigned Case', $activityTypes);
2328 $mergeActSubject = ts("Case %1 reassigned client from %2 to %3. New Case ID is %4.",
2331 2 => $otherContactDisplayName,
2332 3 => $mainContactDisplayName,
2337 elseif ($duplicateContacts) {
2338 $mergeActType = array_search('Merge Case', $activityTypes);
2339 $mergeActSubject = ts("Case %1 copied from contact id %2 to contact id %3 via merge. New Case ID is %4.",
2342 2 => $otherContactId,
2343 3 => $mainContactId,
2349 $mergeActType = array_search('Merge Case', $activityTypes);
2350 $mergeActSubject = ts("Case %1 merged into case %2", [1 => $otherCaseId, 2 => $mainCaseId]);
2351 if (!empty($copiedActivityIds)) {
2353 SELECT id, subject, activity_date_time, activity_type_id
2354 FROM civicrm_activity
2355 WHERE id IN (' . implode(',', $copiedActivityIds) . ')';
2356 $dao = CRM_Core_DAO
::executeQuery($sql);
2357 while ($dao->fetch()) {
2358 $mergeActSubjectDetails .= "{$dao->activity_date_time} :: {$activityTypes[$dao->activity_type_id]}";
2359 if ($dao->subject
) {
2360 $mergeActSubjectDetails .= " :: {$dao->subject}";
2362 $mergeActSubjectDetails .= "<br />";
2367 // Create merge activity record. Source for merge activity is the logged in user's contact ID ($currentUserId).
2369 'subject' => $mergeActSubject,
2370 'details' => $mergeActSubjectDetails,
2371 'status_id' => $completedActivityStatus,
2372 'activity_type_id' => $mergeActType,
2373 'source_contact_id' => $currentUserId,
2374 'activity_date_time' => date('YmdHis'),
2377 $mergeActivity = CRM_Activity_BAO_Activity
::create($activityParams);
2378 $mergeActivityId = $mergeActivity->id
;
2379 if (!$mergeActivityId) {
2383 //connect merge activity to case.
2385 'case_id' => $mainCaseId,
2386 'activity_id' => $mergeActivityId,
2389 self
::processCaseActivity($mergeCaseAct);
2392 CRM_Utils_Hook
::post_case_merge($mainContactId, $mainCaseId, $otherContactId, $otherCaseId, $changeClient);
2394 return $mainCaseIds;
2398 * Validate contact permission for
2399 * edit/view on activity record and build links.
2401 * @param array $tplParams
2402 * Params to be sent to template for sending email.
2403 * @param array $activityParams
2404 * Info of the activity.
2406 public static function buildPermissionLinks(&$tplParams, $activityParams) {
2407 $activityTypeId = CRM_Core_DAO
::getFieldValue('CRM_Activity_DAO_Activity', $activityParams['source_record_id'],
2408 'activity_type_id', 'id'
2411 if (!empty($tplParams['isCaseActivity'])) {
2412 $tplParams['editActURL'] = CRM_Utils_System
::url('civicrm/case/activity',
2413 "reset=1&cid={$activityParams['target_id']}&caseid={$activityParams['case_id']}&action=update&id={$activityParams['source_record_id']}", TRUE
2416 $tplParams['viewActURL'] = CRM_Utils_System
::url('civicrm/case/activity/view',
2417 "reset=1&aid={$activityParams['source_record_id']}&cid={$activityParams['target_id']}&caseID={$activityParams['case_id']}", TRUE
2420 $tplParams['manageCaseURL'] = CRM_Utils_System
::url('civicrm/contact/view/case',
2421 "reset=1&id={$activityParams['case_id']}&cid={$activityParams['target_id']}&action=view&context=home", TRUE
2425 $tplParams['editActURL'] = CRM_Utils_System
::url('civicrm/contact/view/activity',
2426 "atype=$activityTypeId&action=update&reset=1&id={$activityParams['source_record_id']}&cid={$tplParams['contact']['contact_id']}&context=activity", TRUE
2429 $tplParams['viewActURL'] = CRM_Utils_System
::url('civicrm/contact/view/activity',
2430 "atype=$activityTypeId&action=view&reset=1&id={$activityParams['source_record_id']}&cid={$tplParams['contact']['contact_id']}&context=activity", TRUE
2436 * Validate contact permission for
2437 * given operation on activity record.
2439 * @param int $activityId
2440 * Activity record id.
2441 * @param string $operation
2443 * @param int $actTypeId
2445 * @param int $contactId
2446 * Contact id/if not pass consider logged in.
2447 * @param bool $checkComponent
2448 * Do we need to check component enabled.
2452 public static function checkPermission($activityId, $operation, $actTypeId = NULL, $contactId = NULL, $checkComponent = TRUE) {
2454 if (!$actTypeId && $activityId) {
2455 $actTypeId = CRM_Core_DAO
::getFieldValue('CRM_Activity_DAO_Activity', $activityId, 'activity_type_id');
2458 if (!$activityId ||
!$operation ||
!$actTypeId) {
2462 //do check for civicase component enabled.
2463 if ($checkComponent && !self
::enabled()) {
2467 //do check for cases.
2468 $caseActOperations = [
2475 if (in_array($operation, $caseActOperations)) {
2477 if (!isset($caseCount)) {
2479 $caseCount = civicrm_api3('Case', 'getcount', [
2480 'check_permissions' => TRUE,
2481 'status_id' => ['!=' => 'Closed'],
2483 'end_date' => ['IS NULL' => 1],
2486 catch (CiviCRM_API3_Exception
$e) {
2487 // Lack of permissions will throw an exception
2491 if ($operation == 'File On Case') {
2492 $allow = !empty($caseCount);
2495 $allow = ($caseCount > 1);
2499 $actionOperations = ['view', 'edit', 'delete'];
2500 if (in_array($operation, $actionOperations)) {
2502 //do cache when user has non/supper permission.
2503 static $allowOperations;
2505 if (!is_array($allowOperations) ||
2506 !array_key_exists($operation, $allowOperations)
2510 $session = CRM_Core_Session
::singleton();
2511 $contactId = $session->get('userID');
2514 //check for permissions.
2517 'access my cases and activities',
2518 'access all cases and activities',
2521 'access my cases and activities',
2522 'access all cases and activities',
2524 'delete' => ['delete activities'],
2527 //check for core permission.
2528 $hasPermissions = [];
2529 $checkPermissions = CRM_Utils_Array
::value($operation, $permissions);
2530 if (is_array($checkPermissions)) {
2531 foreach ($checkPermissions as $per) {
2532 if (CRM_Core_Permission
::check($per)) {
2533 $hasPermissions[$operation][] = $per;
2539 if (!empty($hasPermissions)) {
2540 //need to check activity object specific.
2541 if (in_array($operation, [
2546 //do we have supper permission.
2547 if (in_array('access all cases and activities', $hasPermissions[$operation])) {
2548 $allowOperations[$operation] = $allow = TRUE;
2551 //user has only access to my cases and activity.
2552 //here object specific permmions come in picture.
2554 //edit - contact must be source or assignee
2555 //view - contact must be source/assignee/target
2556 $isTarget = $isAssignee = $isSource = FALSE;
2557 $activityContacts = CRM_Activity_BAO_ActivityContact
::buildOptions('record_type_id', 'validate');
2558 $sourceID = CRM_Utils_Array
::key('Activity Source', $activityContacts);
2559 $assigneeID = CRM_Utils_Array
::key('Activity Assignees', $activityContacts);
2560 $targetID = CRM_Utils_Array
::key('Activity Targets', $activityContacts);
2562 $target = new CRM_Activity_DAO_ActivityContact();
2563 $target->record_type_id
= $targetID;
2564 $target->activity_id
= $activityId;
2565 $target->contact_id
= $contactId;
2566 if ($target->find(TRUE)) {
2570 $assignee = new CRM_Activity_DAO_ActivityContact();
2571 $assignee->activity_id
= $activityId;
2572 $assignee->record_type_id
= $assigneeID;
2573 $assignee->contact_id
= $contactId;
2574 if ($assignee->find(TRUE)) {
2578 $source = new CRM_Activity_DAO_ActivityContact();
2579 $source->activity_id
= $activityId;
2580 $source->record_type_id
= $sourceID;
2581 $source->contact_id
= $contactId;
2582 if ($source->find(TRUE)) {
2586 if ($operation == 'edit') {
2587 if ($isAssignee ||
$isSource) {
2591 if ($operation == 'view') {
2592 if ($isTarget ||
$isAssignee ||
$isSource) {
2598 elseif (is_array($hasPermissions[$operation])) {
2599 $allowOperations[$operation] = $allow = TRUE;
2603 //contact do not have permission.
2604 $allowOperations[$operation] = FALSE;
2609 //here contact might have supper/non permission.
2610 $allow = $allowOperations[$operation];
2614 //do further only when operation is granted.
2616 $actTypeName = CRM_Core_PseudoConstant
::getName('CRM_Activity_BAO_Activity', 'activity_type_id', $actTypeId);
2618 //do not allow multiple copy / edit action.
2629 //do not allow to delete these activities, CRM-4543
2630 $doNotDeleteNames = ['Open Case', 'Change Case Type', 'Change Case Status', 'Change Case Start Date'];
2632 //allow edit operation.
2633 $allowEditNames = ['Open Case'];
2635 if (CRM_Activity_BAO_Activity
::checkEditInboundEmailsPermissions()) {
2636 $allowEditNames[] = 'Inbound Email';
2639 // do not allow File on Case
2643 'Change Case Status',
2644 'Change Case Start Date',
2651 if (in_array($actTypeName, $singletonNames)) {
2653 if ($operation == 'File On Case') {
2654 $allow = (in_array($actTypeName, $doNotFileNames)) ?
FALSE : TRUE;
2656 if (in_array($operation, $actionOperations)) {
2658 if ($operation == 'edit') {
2659 $allow = (in_array($actTypeName, $allowEditNames)) ?
TRUE : FALSE;
2661 elseif ($operation == 'delete') {
2662 $allow = (in_array($actTypeName, $doNotDeleteNames)) ?
FALSE : TRUE;
2666 if ($allow && ($operation == 'delete') &&
2667 in_array($actTypeName, $doNotDeleteNames)
2672 if ($allow && ($operation == 'File On Case') &&
2673 in_array($actTypeName, $doNotFileNames)
2678 //check settings file for masking actions
2679 //on the basis the activity types
2680 //hide Edit link if activity type is NOT editable
2681 //(special case activities).CRM-5871
2682 if ($allow && in_array($operation, $actionOperations)) {
2683 static $actionFilter = [];
2684 if (!array_key_exists($operation, $actionFilter)) {
2685 $xmlProcessor = new CRM_Case_XMLProcessor_Process();
2686 $actionFilter[$operation] = $xmlProcessor->get('Settings', 'ActivityTypes', FALSE, $operation);
2688 if (array_key_exists($operation, $actionFilter[$operation]) &&
2689 in_array($actTypeId, $actionFilter[$operation][$operation])
2700 * Since we drop 'access CiviCase', allow access
2701 * if user has 'access my cases and activities'
2702 * or 'access all cases and activities'
2704 public static function accessCiviCase() {
2705 if (!self
::enabled()) {
2709 if (CRM_Core_Permission
::check('access my cases and activities') ||
2710 CRM_Core_Permission
::check('access all cases and activities')
2719 * Verify user has permission to access a case.
2721 * @param int $caseId
2722 * @param bool $denyClosed
2723 * Set TRUE if one wants closed cases to be treated as inaccessible.
2727 public static function accessCase($caseId, $denyClosed = TRUE) {
2728 if (!$caseId ||
!self
::enabled()) {
2732 $params = ['id' => $caseId, 'check_permissions' => TRUE];
2733 if ($denyClosed && !CRM_Core_Permission
::check('access all cases and activities')) {
2734 $params['status_id'] = ['!=' => 'Closed'];
2737 return (bool) civicrm_api3('Case', 'getcount', $params);
2739 catch (CiviCRM_API3_Exception
$e) {
2740 // Lack of permissions will throw an exception
2746 * Check whether activity is a case Activity.
2748 * @param int $activityID
2753 public static function isCaseActivity($activityID) {
2754 $isCaseActivity = FALSE;
2756 $params = [1 => [$activityID, 'Integer']];
2757 $query = "SELECT id FROM civicrm_case_activity WHERE activity_id = %1";
2758 if (CRM_Core_DAO
::singleValueQuery($query, $params)) {
2759 $isCaseActivity = TRUE;
2763 return $isCaseActivity;
2767 * Get all the case type ids currently in use.
2771 public static function getUsedCaseType() {
2772 static $caseTypeIds;
2774 if (!is_array($caseTypeIds)) {
2775 $query = "SELECT DISTINCT( civicrm_case.case_type_id ) FROM civicrm_case";
2777 $dao = CRM_Core_DAO
::executeQuery($query);
2779 while ($dao->fetch()) {
2780 $typeId = explode(CRM_Core_DAO
::VALUE_SEPARATOR
,
2783 $caseTypeIds[] = $typeId[1];
2787 return $caseTypeIds;
2791 * Get all the case status ids currently in use.
2795 public static function getUsedCaseStatuses() {
2796 static $caseStatusIds;
2798 if (!is_array($caseStatusIds)) {
2799 $query = "SELECT DISTINCT( civicrm_case.status_id ) FROM civicrm_case";
2801 $dao = CRM_Core_DAO
::executeQuery($query);
2802 $caseStatusIds = [];
2803 while ($dao->fetch()) {
2804 $caseStatusIds[] = $dao->status_id
;
2808 return $caseStatusIds;
2812 * Get all the encounter medium ids currently in use.
2816 public static function getUsedEncounterMediums() {
2819 if (!is_array($mediumIds)) {
2820 $query = "SELECT DISTINCT( civicrm_activity.medium_id ) FROM civicrm_activity";
2822 $dao = CRM_Core_DAO
::executeQuery($query);
2824 while ($dao->fetch()) {
2825 $mediumIds[] = $dao->medium_id
;
2833 * Check case configuration.
2835 * @param int $contactId
2839 public static function isCaseConfigured($contactId = NULL) {
2840 $configured = array_fill_keys(['configured', 'allowToAddNewCase', 'redirectToCaseAdmin'], FALSE);
2842 //lets check for case configured.
2843 $allCasesCount = CRM_Case_BAO_Case
::caseCount(NULL, FALSE);
2844 $configured['configured'] = ($allCasesCount) ?
TRUE : FALSE;
2845 if (!$configured['configured']) {
2846 //do check for case type and case status.
2847 $caseTypes = CRM_Case_PseudoConstant
::caseType('title', FALSE);
2848 if (!empty($caseTypes)) {
2849 $configured['configured'] = TRUE;
2850 if (!$configured['configured']) {
2851 $caseStatuses = CRM_Case_PseudoConstant
::caseStatus('label', FALSE);
2852 if (!empty($caseStatuses)) {
2853 $configured['configured'] = TRUE;
2858 if ($configured['configured']) {
2859 //do check for active case type and case status.
2860 $caseTypes = CRM_Case_PseudoConstant
::caseType();
2861 if (!empty($caseTypes)) {
2862 $caseStatuses = CRM_Case_PseudoConstant
::caseStatus();
2863 if (!empty($caseStatuses)) {
2864 $configured['allowToAddNewCase'] = TRUE;
2868 //do we need to redirect user to case admin.
2869 if (!$configured['allowToAddNewCase'] && $contactId) {
2870 //check for current contact case count.
2871 $currentContatCasesCount = CRM_Case_BAO_Case
::caseCount($contactId);
2872 //redirect user to case admin page.
2873 if (!$currentContatCasesCount) {
2874 $configured['redirectToCaseAdmin'] = TRUE;
2883 * Used during case component enablement and during ugprade.
2887 public static function createCaseViews() {
2888 $errorScope = CRM_Core_TemporaryErrorScope
::ignoreException();
2889 $dao = new CRM_Core_DAO();
2891 $sql = self
::createCaseViewsQuery('upcoming');
2893 if (PEAR
::getStaticProperty('DB_DataObject', 'lastError')) {
2897 // Above error doesn't get caught?
2898 $doublecheck = $dao->singleValueQuery("SELECT count(id) FROM civicrm_view_case_activity_upcoming");
2899 if (is_null($doublecheck)) {
2903 $sql = self
::createCaseViewsQuery('recent');
2905 if (PEAR
::getStaticProperty('DB_DataObject', 'lastError')) {
2909 // Above error doesn't get caught?
2910 $doublecheck = $dao->singleValueQuery("SELECT count(id) FROM civicrm_view_case_activity_recent");
2911 if (is_null($doublecheck)) {
2919 * Helper function, also used by the upgrade in case of error
2921 * @param string $section
2925 public static function createCaseViewsQuery($section = 'upcoming') {
2927 $scheduled_id = CRM_Core_PseudoConstant
::getKey('CRM_Activity_BAO_Activity', 'activity_status_id', 'Scheduled');
2930 $sql = "CREATE OR REPLACE VIEW `civicrm_view_case_activity_upcoming`
2931 AS SELECT ca.case_id, a.id, a.activity_date_time, a.status_id, a.activity_type_id
2932 FROM civicrm_case_activity ca
2933 INNER JOIN civicrm_activity a ON ca.activity_id=a.id
2935 (SELECT b.id FROM civicrm_case_activity bca
2936 INNER JOIN civicrm_activity b ON bca.activity_id=b.id
2937 WHERE b.activity_date_time <= DATE_ADD( NOW(), INTERVAL 14 DAY )
2938 AND b.is_current_revision = 1 AND b.is_deleted=0 AND b.status_id = $scheduled_id
2939 AND bca.case_id = ca.case_id ORDER BY b.activity_date_time ASC LIMIT 1)";
2943 $sql = "CREATE OR REPLACE VIEW `civicrm_view_case_activity_recent`
2944 AS SELECT ca.case_id, a.id, a.activity_date_time, a.status_id, a.activity_type_id
2945 FROM civicrm_case_activity ca
2946 INNER JOIN civicrm_activity a ON ca.activity_id=a.id
2948 (SELECT b.id FROM civicrm_case_activity bca
2949 INNER JOIN civicrm_activity b ON bca.activity_id=b.id
2950 WHERE b.activity_date_time >= DATE_SUB( NOW(), INTERVAL 14 DAY )
2951 AND b.is_current_revision = 1 AND b.is_deleted=0 AND b.status_id <> $scheduled_id
2952 AND bca.case_id = ca.case_id ORDER BY b.activity_date_time DESC LIMIT 1)";
2959 * Add/copy relationships, when new client is added for a case
2961 * @param int $caseId
2963 * @param int $contactId
2964 * Contact id / new client id.
2966 public static function addCaseRelationships($caseId, $contactId) {
2967 // get the case role / relationships for the case
2968 $caseRelationships = new CRM_Contact_DAO_Relationship();
2969 $caseRelationships->case_id
= $caseId;
2970 $caseRelationships->find();
2971 $relationshipTypes = [];
2973 // make sure we don't add duplicate relationships of same relationship type.
2974 while ($caseRelationships->fetch() && !in_array($caseRelationships->relationship_type_id
, $relationshipTypes)) {
2976 CRM_Core_DAO
::storeValues($caseRelationships, $values);
2978 // add relationship for new client.
2979 $newRelationship = new CRM_Contact_DAO_Relationship();
2980 $newRelationship->copyValues($values);
2981 $newRelationship->id
= NULL;
2982 $newRelationship->case_id
= $caseId;
2983 $newRelationship->contact_id_a
= $contactId;
2984 $newRelationship->end_date
= CRM_Utils_Date
::isoToMysql($caseRelationships->end_date
);
2985 $newRelationship->start_date
= CRM_Utils_Date
::isoToMysql($caseRelationships->start_date
);
2987 // another check to avoid duplicate relationship, in cases where client is removed and re-added again.
2988 if (!$newRelationship->find(TRUE)) {
2989 $newRelationship->save();
2992 // store relationship type of newly created relationship
2993 $relationshipTypes[] = $caseRelationships->relationship_type_id
;
2998 * Get the list of clients for a case.
3000 * @param int $caseId
3003 * associated array with client ids
3005 public static function getCaseClients($caseId) {
3007 $caseContact = new CRM_Case_DAO_CaseContact();
3008 $caseContact->case_id
= $caseId;
3009 $caseContact->orderBy('id');
3010 $caseContact->find();
3012 while ($caseContact->fetch()) {
3013 $clients[] = $caseContact->contact_id
;
3020 * @param int $caseId
3021 * @param string $direction
3023 * @param int $relTypeId
3025 * @throws \CRM_Core_Exception
3026 * @throws \CiviCRM_API3_Exception
3028 public static function endCaseRole($caseId, $direction, $cid, $relTypeId) {
3030 if ($direction !== 'a' && $direction !== 'b') {
3031 throw new CRM_Core_Exception('Invalid relationship direction');
3034 // This case might have multiple clients, so we lookup by relationship instead of by id to get them all
3035 $sql = "SELECT id FROM civicrm_relationship WHERE case_id = %1 AND contact_id_{$direction} = %2 AND relationship_type_id = %3";
3036 $dao = CRM_Core_DAO
::executeQuery($sql, [
3037 1 => [$caseId, 'Positive'],
3038 2 => [$cid, 'Positive'],
3039 3 => [$relTypeId, 'Positive'],
3041 while ($dao->fetch()) {
3042 civicrm_api3('relationship', 'create', [
3045 'end_date' => 'now',
3051 * Get options for a given case field.
3053 * @param string $fieldName
3054 * @param string $context
3055 * @param array $props
3056 * Whatever is known about this dao object.
3058 * @return array|bool
3059 * @throws \CiviCRM_API3_Exception
3061 * @see CRM_Core_DAO::buildOptionsContext
3062 * @see CRM_Core_DAO::buildOptions
3065 public static function buildOptions($fieldName, $context = NULL, $props = []) {
3066 $className = __CLASS__
;
3068 switch ($fieldName) {
3069 // This field is not part of this object but the api supports it
3071 $className = 'CRM_Activity_BAO_Activity';
3074 // Filter status id by case type id
3076 if (!empty($props['case_type_id'])) {
3077 $idField = is_numeric($props['case_type_id']) ?
'id' : 'name';
3078 $caseType = civicrm_api3('CaseType', 'getsingle', [$idField => $props['case_type_id'], 'return' => 'definition']);
3079 if (!empty($caseType['definition']['statuses'])) {
3080 $params['condition'] = 'v.name IN ("' . implode('","', $caseType['definition']['statuses']) . '")';
3085 return CRM_Core_PseudoConstant
::get($className, $fieldName, $params, $context);
3091 public function addSelectWhereClause() {
3092 // We always return an array with these keys, even if they are empty,
3093 // because this tells the query builder that we have considered these fields for acls
3096 // Only case admins can view deleted cases
3097 'is_deleted' => CRM_Core_Permission
::check('administer CiviCase') ?
[] : ["= 0"],
3099 // Ensure the user has permission to view the case client
3100 $contactClause = CRM_Utils_SQL
::mergeSubquery('Contact');
3101 if ($contactClause) {
3102 $contactClause = implode(' AND contact_id ', $contactClause);
3103 $clauses['id'][] = "IN (SELECT case_id FROM civicrm_case_contact WHERE contact_id $contactClause)";
3105 // The api gatekeeper ensures the user has at least "access my cases and activities"
3106 // so if they do not have permission to see all cases we'll assume they can only access their own
3107 if (!CRM_Core_Permission
::check('access all cases and activities')) {
3108 $user = (int) CRM_Core_Session
::getLoggedInContactID();
3109 $clauses['id'][] = "IN (
3110 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 (
3111 (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)
3115 CRM_Utils_Hook
::selectWhereClause($this, $clauses);
3120 * CRM-20308: Method to get the contact id to use as from contact for email copy
3121 * 1. Activity Added by Contact's email address
3122 * 2. System Default From Address
3123 * 3. Default Organization Contact email address
3126 * @param int $activityID
3128 * @return mixed $emailFromContactId
3130 * @throws \CiviCRM_API3_Exception
3131 * @see https://issues.civicrm.org/jira/browse/CRM-20308
3133 public static function getReceiptFrom($activityID) {
3134 $name = $address = NULL;
3136 if (!empty($activityID) && (Civi
::settings()->get('allow_mail_from_logged_in_contact'))) {
3137 // This breaks SPF/DMARC if email is sent from an email address that the server is not authorised to send from.
3138 // so we can disable this behaviour with the "allow_mail_from_logged_in_contact" setting.
3139 // There is always a 'Added by' contact for a activity,
3140 // so we can safely use ActivityContact.Getvalue API
3141 $sourceContactId = civicrm_api3('ActivityContact', 'getvalue', [
3142 'activity_id' => $activityID,
3143 'record_type_id' => 'Activity Source',
3144 'return' => 'contact_id',
3146 list($name, $address) = CRM_Contact_BAO_Contact_Location
::getEmailDetails($sourceContactId);
3149 // If 'From' email address not found for Source Activity Contact then
3150 // fetch the email from domain or logged in user.
3151 if (empty($address)) {
3152 list($name, $address) = CRM_Core_BAO_Domain
::getDefaultReceiptFrom();
3155 return "$name <$address>";
3161 public static function getEntityRefFilters() {
3164 'key' => 'case_id.case_type_id',
3165 'value' => ts('Case Type'),
3169 'key' => 'case_id.status_id',
3170 'value' => ts('Case Status'),
3174 foreach (CRM_Contact_BAO_Contact
::getEntityRefFilters() as $filter) {
3175 $filter +
= ['entity' => 'Contact'];
3176 $filter['key'] = 'contact_id.' . $filter['key'];
3177 $filters[] = $filter;
3183 * Fetch Case Role direction from Case Type
3185 public static function getCaseRoleDirection($caseId, $roleTypeId = NULL) {
3187 $case = civicrm_api3('Case', 'getsingle', ['id' => $caseId]);
3189 catch (CiviCRM_API3_Exception
$e) {
3190 // Lack of permissions will throw an exception
3193 if (!empty($case['case_type_id'])) {
3195 $caseType = civicrm_api3('CaseType', 'getsingle', ['id' => $case['case_type_id'], 'return' => ['definition']]);
3197 catch (CiviCRM_API3_Exception
$e) {
3198 // Lack of permissions will throw an exception
3199 return 'no case type found';
3201 if (!empty($caseType['definition']['caseRoles'])) {
3203 foreach ($caseType['definition']['caseRoles'] as $key => $roleDetails) {
3204 // Check if its an a_b label
3206 $relType = civicrm_api3('RelationshipType', 'getsingle', ['label_a_b' => $roleDetails['name']]);
3208 catch (CiviCRM_API3_Exception
$e) {
3210 if (!empty($relType['id'])) {
3211 $roleDetails['id'] = $relType['id'];
3212 $roleDetails['direction'] = 'b_a';
3214 // Check if its a b_a label
3216 $relTypeBa = civicrm_api3('RelationshipType', 'getsingle', ['label_b_a' => $roleDetails['name']]);
3218 catch (CiviCRM_API3_Exception
$e) {
3220 if (!empty($relTypeBa['id'])) {
3221 if (!empty($roleDetails['direction'])) {
3222 $roleDetails['direction'] = 'bidrectional';
3225 $roleDetails['id'] = $relTypeBa['id'];
3226 $roleDetails['direction'] = 'a_b';
3229 $caseRoles[$roleDetails['id']] = $roleDetails;