3 +--------------------------------------------------------------------+
5 +--------------------------------------------------------------------+
6 | Copyright CiviCRM LLC (c) 2004-2019 |
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-2019
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 = array(1 => array($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();
286 $contactArray = array();
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 array('1' => array($activityId, 'Integer'))
310 $caseId = CRM_Core_DAO
::singleValueQuery(
311 'SELECT case_id FROM civicrm_case_activity WHERE activity_id in (%1,%2)',
313 '1' => array($activityId, 'Integer'),
314 '2' => array($originalId ?
$originalId : $activityId, 'Integer'),
321 * Retrieve contact names by caseId.
328 public static function getContactNames($caseId) {
329 $contactNames = array();
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 array(1 => array($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 = array(1 => array($contactID, 'Integer'));
393 $dao = CRM_Core_DAO
::executeQuery($query, $params);
395 $caseArray = array();
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) {
424 $selectClauses = array(
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',
433 'c_type.title as case_type',
434 'civicrm_case.case_type_id as case_type_id',
435 'cov_status.label as case_status',
436 'cov_status.label as case_status_name',
438 'civicrm_case.start_date as case_start_date',
439 'case_relation_type.label_b_a as case_role',
442 if ($type == 'upcoming') {
443 $selectClauses = array_merge($selectClauses, array(
444 't_act.desired_date as case_scheduled_activity_date',
445 't_act.id as case_scheduled_activity_id',
446 't_act.act_type_name as case_scheduled_activity_type_name',
447 't_act.act_type AS case_scheduled_activity_type',
450 elseif ($type == 'recent') {
451 $selectClauses = array_merge($selectClauses, array(
452 't_act.desired_date as case_recent_activity_date',
453 't_act.id as case_recent_activity_id',
454 't_act.act_type_name as case_recent_activity_type_name',
455 't_act.act_type AS case_recent_activity_type',
458 elseif ($type == 'any') {
459 $selectClauses = array_merge($selectClauses, array(
460 't_act.desired_date as case_activity_date',
461 't_act.id as case_activity_id',
462 't_act.act_type_name as case_activity_type_name',
463 't_act.act_type AS case_activity_type',
467 $query = CRM_Contact_BAO_Query
::appendAnyValueToSelect($selectClauses, 'case_id');
469 $query .= " FROM civicrm_case
470 INNER JOIN civicrm_case_contact ON civicrm_case.id = civicrm_case_contact.case_id
471 INNER JOIN civicrm_contact ON civicrm_case_contact.contact_id = civicrm_contact.id ";
473 if ($type == 'upcoming') {
474 // This gets the earliest activity per case that's scheduled within 14 days from now.
475 // Note we have an inner select to get the min activity id in order to remove duplicates in case there are two with the same datetime.
476 // In this case we don't really care which one, so min(id) works.
477 // optimized in CRM-11837
478 $query .= " INNER JOIN
480 SELECT case_id, act.id, activity_date_time AS desired_date, activity_type_id, status_id, aov.name AS act_type_name, aov.label AS act_type
485 FROM civicrm_view_case_activity_upcoming
486 ORDER BY activity_date_time ASC, id ASC
489 LEFT JOIN civicrm_option_group aog ON aog.name='activity_type'
490 LEFT JOIN civicrm_option_value aov ON ( aov.option_group_id = aog.id AND aov.value = act.activity_type_id )
494 elseif ($type == 'recent') {
495 // Similarly, the most recent activity in the past 14 days, and exclude scheduled.
496 //improve query performance - CRM-10598
497 $query .= " INNER JOIN
499 SELECT case_id, act.id, activity_date_time AS desired_date, activity_type_id, status_id, aov.name AS act_type_name, aov.label AS act_type
504 FROM civicrm_view_case_activity_recent
505 ORDER BY activity_date_time DESC, id ASC
508 LEFT JOIN civicrm_option_group aog ON aog.name='activity_type'
509 LEFT JOIN civicrm_option_value aov ON ( aov.option_group_id = aog.id AND aov.value = act.activity_type_id )
512 elseif ($type == 'any') {
513 $query .= " LEFT JOIN
515 SELECT ca4.case_id, act4.id AS id, act4.activity_date_time AS desired_date, act4.activity_type_id, act4.status_id, aov.name AS act_type_name, aov.label AS act_type
516 FROM civicrm_activity act4
517 LEFT JOIN civicrm_case_activity ca4
518 ON ca4.activity_id = act4.id
519 AND act4.is_current_revision = 1
520 LEFT JOIN civicrm_option_group aog
521 ON aog.name='activity_type'
522 LEFT JOIN civicrm_option_value aov
523 ON aov.option_group_id = aog.id
524 AND aov.value = act4.activity_type_id
529 ON t_act.case_id = civicrm_case.id
530 LEFT JOIN civicrm_phone ON (civicrm_phone.contact_id = civicrm_contact.id AND civicrm_phone.is_primary=1)
531 LEFT JOIN civicrm_relationship case_relationship
532 ON ( case_relationship.contact_id_a = civicrm_case_contact.contact_id AND case_relationship.contact_id_b = {$userID} AND case_relationship.is_active AND case_relationship.case_id = civicrm_case.id )
533 LEFT JOIN civicrm_relationship_type case_relation_type
534 ON ( case_relation_type.id = case_relationship.relationship_type_id
535 AND case_relation_type.id = case_relationship.relationship_type_id )
537 LEFT JOIN civicrm_case_type c_type
538 ON civicrm_case.case_type_id = c_type.id
540 LEFT JOIN civicrm_option_group cog_status
541 ON cog_status.name = 'case_status'
543 LEFT JOIN civicrm_option_value cov_status
544 ON ( civicrm_case.status_id = cov_status.value
545 AND cog_status.id = cov_status.option_group_id )
549 // CRM-8749 backwards compatibility - callers of this function expect to start $condition with "AND"
550 $query .= " WHERE (1) AND $condition ";
552 $query .= " GROUP BY case_id ";
558 if ($type == 'upcoming') {
559 $query .= " ORDER BY case_scheduled_activity_date ASC ";
561 elseif ($type == 'recent') {
562 $query .= " ORDER BY case_recent_activity_date ASC ";
564 elseif ($type == 'any') {
565 $query .= " ORDER BY case_activity_date ASC ";
577 * Retrieve cases related to particular contact or whole contact used in Dashboard and Tab.
579 * @param bool $allCases
580 * @param array $params
581 * @param string $context
582 * @param bool $getCount
587 public static function getCases($allCases = TRUE, $params = array(), $context = 'dashboard', $getCount = FALSE) {
589 $casesList = array();
591 // validate access for own cases.
592 if (!self
::accessCiviCase()) {
593 return $getCount ?
0 : $casesList;
596 // Return cached value instead of re-running query
597 if (isset(Civi
::$statics[__CLASS__
]['totalCount']) && $getCount) {
598 return Civi
::$statics[__CLASS__
]['totalCount'];
601 $type = CRM_Utils_Array
::value('type', $params, 'upcoming');
602 $userID = CRM_Core_Session
::singleton()->get('userID');
604 $caseActivityTypeColumn = 'case_activity_type_name';
605 $caseActivityDateColumn = 'case_activity_date';
606 $caseActivityIDColumn = 'case_activity_id';
607 if ($type == 'upcoming') {
608 $caseActivityDateColumn = 'case_scheduled_activity_date';
609 $caseActivityTypeColumn = 'case_scheduled_activity_type';
610 $caseActivityIDColumn = 'case_scheduled_activity_id';
612 elseif ($type == 'recent') {
613 $caseActivityDateColumn = 'case_recent_activity_date';
614 $caseActivityTypeColumn = 'case_recent_activity_type';
615 $caseActivityIDColumn = 'case_recent_activity_id';
618 // validate access for all cases.
619 if ($allCases && !CRM_Core_Permission
::check('access all cases and activities')) {
623 $whereClauses = array('civicrm_case.is_deleted = 0 AND civicrm_contact.is_deleted <> 1');
626 $whereClauses[] .= " case_relationship.contact_id_b = {$userID} AND case_relationship.is_active ";
628 if (empty($params['status_id']) && ($type == 'upcoming' ||
$type == 'any')) {
629 $whereClauses[] = " civicrm_case.status_id != " . CRM_Core_PseudoConstant
::getKey('CRM_Case_BAO_Case', 'case_status_id', 'Closed');
632 foreach (array('case_type_id', 'status_id') as $column) {
633 if (!empty($params[$column])) {
634 $whereClauses[] = sprintf("civicrm_case.%s IN (%s)", $column, $params[$column]);
637 $condition = implode(' AND ', $whereClauses);
639 Civi
::$statics[__CLASS__
]['totalCount'] = $totalCount = CRM_Core_DAO
::singleValueQuery(self
::getCaseActivityCountQuery($type, $userID, $condition));
643 $casesList['total'] = $totalCount;
646 if (!empty($params['rp'])) {
647 $params['offset'] = ($params['page'] - 1) * $params['rp'];
648 $params['rowCount'] = $params['rp'];
649 if (!empty($params['rowCount']) && $params['rowCount'] > 0) {
650 $limit = " LIMIT {$params['offset']}, {$params['rowCount']} ";
655 if (!empty($params['sortBy'])) {
656 if (strstr($params['sortBy'], 'date ')) {
657 $params['sortBy'] = str_replace('date', $caseActivityDateColumn, $params['sortBy']);
659 $order = "ORDER BY " . $params['sortBy'];
662 $query = self
::getCaseActivityQuery($type, $userID, $condition, $limit, $order);
663 $result = CRM_Core_DAO
::executeQuery($query);
665 $caseStatus = CRM_Core_OptionGroup
::values('case_status', FALSE, FALSE, FALSE, " AND v.name = 'Urgent' ");
667 // we're going to use the usual actions, so doesn't make sense to duplicate definitions
668 $actions = CRM_Case_Selector_Search
::links();
670 // check is the user has view/edit signer permission
671 $permissions = array(CRM_Core_Permission
::VIEW
);
672 if (CRM_Core_Permission
::check('access all cases and activities') ||
673 (!$allCases && CRM_Core_Permission
::check('access my cases and activities'))
675 $permissions[] = CRM_Core_Permission
::EDIT
;
677 if (CRM_Core_Permission
::check('delete in CiviCase')) {
678 $permissions[] = CRM_Core_Permission
::DELETE
;
680 $mask = CRM_Core_Action
::mask($permissions);
682 $caseTypes = CRM_Case_PseudoConstant
::caseType('name');
683 foreach ($result->fetchAll() as $case) {
684 $key = $case['case_id'];
685 $casesList[$key] = array();
686 $casesList[$key]['DT_RowId'] = $case['case_id'];
687 $casesList[$key]['DT_RowAttr'] = array('data-entity' => 'case', 'data-id' => $case['case_id']);
688 $casesList[$key]['DT_RowClass'] = "crm-entity";
690 $casesList[$key]['activity_list'] = sprintf('<a title="%s" class="crm-expand-row" href="%s"></a>',
692 CRM_Utils_System
::url('civicrm/case/details', array('caseId' => $case['case_id'], 'cid' => $case['contact_id'], 'type' => $type))
695 $phone = empty($case['phone']) ?
'' : '<br /><span class="description">' . $case['phone'] . '</span>';
696 $casesList[$key]['contact_id'] = sprintf('<a href="%s">%s</a>%s<br /><span class="description">%s: %d</span>',
697 CRM_Utils_System
::url('civicrm/contact/view', array('cid' => $case['contact_id'])),
703 $casesList[$key]['subject'] = $case['case_subject'];
704 $casesList[$key]['case_status'] = in_array($case['case_status'], $caseStatus) ?
sprintf('<strong>%s</strong>', strtoupper($case['case_status'])) : $case['case_status'];
705 $casesList[$key]['case_type'] = $case['case_type'];
706 $casesList[$key]['case_role'] = CRM_Utils_Array
::value('case_role', $case, '---');
707 $casesList[$key]['manager'] = self
::getCaseManagerContact($caseTypes[$case['case_type_id']], $case['case_id']);
709 $casesList[$key]['date'] = $case[$caseActivityTypeColumn];
710 if (($actId = CRM_Utils_Array
::value('case_scheduled_activity_id', $case)) ||
711 ($actId = CRM_Utils_Array
::value('case_recent_activity_id', $case))
713 if (self
::checkPermission($actId, 'view', $case['activity_type_id'], $userID)) {
714 if ($type == 'recent') {
715 $casesList[$key]['date'] = sprintf('<a class="action-item crm-hover-button" href="%s" title="%s">%s</a>',
716 CRM_Utils_System
::url('civicrm/case/activity/view', array('reset' => 1, 'cid' => $case['contact_id'], 'aid' => $case[$caseActivityIDColumn])),
718 $case[$caseActivityTypeColumn]
722 $status = CRM_Utils_Date
::overdue($case[$caseActivityDateColumn]) ?
'status-overdue' : 'status-scheduled';
723 $casesList[$key]['date'] = sprintf('<a class="crm-popup %s" href="%s" title="%s">%s</a> ',
725 CRM_Utils_System
::url('civicrm/case/activity/view', array('reset' => 1, 'cid' => $case['contact_id'], 'aid' => $case[$caseActivityIDColumn])),
727 $case[$caseActivityTypeColumn]
731 if (isset($case['activity_type_id']) && self
::checkPermission($actId, 'edit', $case['activity_type_id'], $userID)) {
732 $casesList[$key]['date'] .= sprintf('<a class="action-item crm-hover-button" href="%s" title="%s"><i class="crm-i fa-pencil"></i></a>',
733 CRM_Utils_System
::url('civicrm/case/activity', array('reset' => 1, 'cid' => $case['contact_id'], 'caseid' => $case['case_id'], 'action' => 'update', 'id' => $actId)),
738 $casesList[$key]['date'] .= "<br/>" . CRM_Utils_Date
::customFormat($case[$caseActivityDateColumn]);
739 $casesList[$key]['links'] = CRM_Core_Action
::formLink($actions['primaryActions'], $mask,
741 'id' => $case['case_id'],
742 'cid' => $case['contact_id'],
747 'case.actions.primary',
757 * Get the summary of cases counts by type and status.
759 * @param bool $allCases
762 public static function getCasesSummary($allCases = TRUE) {
763 $caseSummary = array();
765 //validate access for civicase.
766 if (!self
::accessCiviCase()) {
770 $userID = CRM_Core_Session
::singleton()->get('userID');
772 //validate access for all cases.
773 if ($allCases && !CRM_Core_Permission
::check('access all cases and activities')) {
777 $caseTypes = CRM_Case_PseudoConstant
::caseType();
778 $caseStatuses = CRM_Case_PseudoConstant
::caseStatus();
779 $caseTypes = array_flip($caseTypes);
781 // get statuses as headers for the table
782 $url = CRM_Utils_System
::url('civicrm/case/search', "reset=1&force=1&all=1&status=");
783 foreach ($caseStatuses as $key => $name) {
784 $caseSummary['headers'][$key]['status'] = $name;
785 $caseSummary['headers'][$key]['url'] = $url . $key;
788 // build rows with actual data
790 $myGroupByClause = $mySelectClause = $myCaseFromClause = $myCaseWhereClause = '';
796 $myGroupByClause = ' GROUP BY civicrm_case.id';
801 $myCaseWhereClause = " AND case_relationship.contact_id_b = {$userID} AND case_relationship.is_active ";
802 $myGroupByClause = " GROUP BY CONCAT(case_relationship.case_id,'-',case_relationship.contact_id_b)";
804 $myGroupByClause .= ", case_status.label, status_id, case_type_id";
806 // FIXME: This query could be a lot more efficient if it used COUNT() instead of returning all rows and then counting them with php
808 SELECT case_status.label AS case_status, status_id, civicrm_case_type.title AS case_type,
809 case_type_id, case_relationship.contact_id_b
811 INNER JOIN civicrm_case_contact cc on cc.case_id = civicrm_case.id
812 LEFT JOIN civicrm_case_type ON civicrm_case.case_type_id = civicrm_case_type.id
813 LEFT JOIN civicrm_option_group option_group_case_status ON ( option_group_case_status.name = 'case_status' )
814 LEFT JOIN civicrm_option_value case_status ON ( civicrm_case.status_id = case_status.value
815 AND option_group_case_status.id = case_status.option_group_id )
816 LEFT JOIN civicrm_relationship case_relationship ON ( case_relationship.case_id = civicrm_case.id
817 AND case_relationship.contact_id_b = {$userID} AND case_relationship.is_active )
818 WHERE is_deleted = 0 AND cc.contact_id IN (SELECT id FROM civicrm_contact WHERE is_deleted <> 1)
819 {$myCaseWhereClause} {$myGroupByClause}";
821 $res = CRM_Core_DAO
::executeQuery($query);
822 while ($res->fetch()) {
823 if (!empty($rows[$res->case_type
]) && !empty($rows[$res->case_type
][$res->case_status
])) {
824 $rows[$res->case_type
][$res->case_status
]['count'] = $rows[$res->case_type
][$res->case_status
]['count'] +
1;
827 $rows[$res->case_type
][$res->case_status
] = array(
829 'url' => CRM_Utils_System
::url('civicrm/case/search',
830 "reset=1&force=1&status={$res->status_id}&type={$res->case_type_id}&case_owner={$case_owner}"
835 $caseSummary['rows'] = array_merge($caseTypes, $rows);
843 * @param int $contactID
847 * @param int $relationshipID
848 * @param bool $activeOnly
851 * case role / relationships
854 public static function getCaseRoles($contactID, $caseID, $relationshipID = NULL, $activeOnly = TRUE) {
856 SELECT rel.id as civicrm_relationship_id,
857 con.sort_name as sort_name,
858 civicrm_email.email as email,
859 civicrm_phone.phone as phone,
860 con.id as civicrm_contact_id,
861 IF(rel.contact_id_a = %1, civicrm_relationship_type.label_a_b, civicrm_relationship_type.label_b_a) as relation,
862 civicrm_relationship_type.id as relation_type,
863 IF(rel.contact_id_a = %1, "a_b", "b_a") as relationship_direction
864 FROM civicrm_relationship rel
865 INNER JOIN civicrm_relationship_type ON rel.relationship_type_id = civicrm_relationship_type.id
866 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))
867 LEFT JOIN civicrm_phone ON (civicrm_phone.contact_id = con.id AND civicrm_phone.is_primary = 1)
868 LEFT JOIN civicrm_email ON (civicrm_email.contact_id = con.id AND civicrm_email.is_primary = 1)
869 WHERE (rel.contact_id_a = %1 OR rel.contact_id_b = %1) AND rel.case_id = %2
870 AND con.is_deleted = 0';
873 $query .= ' AND rel.is_active = 1 AND (rel.end_date IS NULL OR rel.end_date > NOW())';
877 1 => array($contactID, 'Positive'),
878 2 => array($caseID, 'Positive'),
881 if ($relationshipID) {
882 $query .= ' AND rel.id = %3 ';
883 $params[3] = array($relationshipID, 'Integer');
885 $dao = CRM_Core_DAO
::executeQuery($query, $params);
888 while ($dao->fetch()) {
889 $rid = $dao->civicrm_relationship_id
;
890 $values[$rid]['cid'] = $dao->civicrm_contact_id
;
891 $values[$rid]['relation'] = $dao->relation
;
892 $values[$rid]['name'] = $dao->sort_name
;
893 $values[$rid]['email'] = $dao->email
;
894 $values[$rid]['phone'] = $dao->phone
;
895 $values[$rid]['relation_type'] = $dao->relation_type
;
896 $values[$rid]['rel_id'] = $dao->civicrm_relationship_id
;
897 $values[$rid]['client_id'] = $contactID;
898 $values[$rid]['relationship_direction'] = $dao->relationship_direction
;
905 * Get Case Activities.
909 * @param array $params
911 * @param int $contactID
914 * @param null $context
916 * @param null $type (deprecated)
919 * Array of case activities
922 public static function getCaseActivity($caseID, &$params, $contactID, $context = NULL, $userID = NULL, $type = NULL) {
923 $activityContacts = CRM_Activity_BAO_ActivityContact
::buildOptions('record_type_id', 'validate');
924 $assigneeID = CRM_Utils_Array
::key('Activity Assignees', $activityContacts);
925 $sourceID = CRM_Utils_Array
::key('Activity Source', $activityContacts);
926 $targetID = CRM_Utils_Array
::key('Activity Targets', $activityContacts);
928 // CRM-5081 - formatting the dates to omit seconds.
929 // Note the 00 in the date format string is needed otherwise later on it thinks scheduled ones are overdue.
931 SELECT SQL_CALC_FOUND_ROWS COUNT(ca.id) AS ismultiple,
933 ca.activity_type_id AS type,
934 ca.activity_type_id AS activity_type_id,
935 tcc.sort_name AS target_contact_name,
936 tcc.id AS target_contact_id,
937 scc.sort_name AS source_contact_name,
938 scc.id AS source_contact_id,
939 acc.sort_name AS assignee_contact_name,
940 acc.id AS assignee_contact_id,
942 IF(ca.activity_date_time < NOW() AND ca.status_id=ov.value,
943 ca.activity_date_time,
944 DATE_ADD(NOW(), INTERVAL 1 YEAR)
945 ), '%Y%m%d%H%i00') AS overdue_date,
946 DATE_FORMAT(ca.activity_date_time, '%Y%m%d%H%i00') AS display_date,
947 ca.status_id AS status,
948 ca.subject AS subject,
949 ca.is_deleted AS deleted,
950 ca.priority_id AS priority,
952 GROUP_CONCAT(ef.file_id) AS attachment_ids ";
955 FROM civicrm_case_activity cca
956 INNER JOIN civicrm_activity ca
957 ON ca.id = cca.activity_id
958 INNER JOIN civicrm_activity_contact cas
959 ON cas.activity_id = ca.id
960 AND cas.record_type_id = {$sourceID}
961 INNER JOIN civicrm_contact scc
962 ON scc.id = cas.contact_id
963 LEFT JOIN civicrm_activity_contact caa
964 ON caa.activity_id = ca.id
965 AND caa.record_type_id = {$assigneeID}
966 LEFT JOIN civicrm_contact acc
967 ON acc.id = caa.contact_id
968 LEFT JOIN civicrm_activity_contact cat
969 ON cat.activity_id = ca.id
970 AND cat.record_type_id = {$targetID}
971 LEFT JOIN civicrm_contact tcc
972 ON tcc.id = cat.contact_id
973 INNER JOIN civicrm_option_group cog
974 ON cog.name = 'activity_type'
975 INNER JOIN civicrm_option_value cov
976 ON cov.option_group_id = cog.id
977 AND cov.value = ca.activity_type_id
978 AND cov.is_active = 1
979 LEFT JOIN civicrm_entity_file ef
980 ON ef.entity_table = 'civicrm_activity'
981 AND ef.entity_id = ca.id
982 LEFT OUTER JOIN civicrm_option_group og
983 ON og.name = 'activity_status'
984 LEFT OUTER JOIN civicrm_option_value ov
985 ON ov.option_group_id=og.id
986 AND ov.name = 'Scheduled'";
989 WHERE cca.case_id= %1
990 AND ca.is_current_revision = 1';
992 if (!empty($params['source_contact_id'])) {
994 AND cas.contact_id = " . CRM_Utils_Type
::escape($params['source_contact_id'], 'Integer');
997 if (!empty($params['status_id'])) {
999 AND ca.status_id = " . CRM_Utils_Type
::escape($params['status_id'], 'Integer');
1002 if (!empty($params['activity_deleted'])) {
1004 AND ca.is_deleted = 1";
1008 AND ca.is_deleted = 0";
1011 if (!empty($params['activity_type_id'])) {
1013 AND ca.activity_type_id = " . CRM_Utils_Type
::escape($params['activity_type_id'], 'Integer');
1016 if (!empty($params['activity_date_low'])) {
1017 $fromActivityDate = CRM_Utils_Type
::escape(CRM_Utils_Date
::processDate($params['activity_date_low']), 'Date');
1019 if (!empty($fromActivityDate)) {
1021 AND ca.activity_date_time >= '{$fromActivityDate}'";
1024 if (!empty($params['activity_date_high'])) {
1025 $toActivityDate = CRM_Utils_Type
::escape(CRM_Utils_Date
::processDate($params['activity_date_high']), 'Date');
1026 $toActivityDate = $toActivityDate ?
$toActivityDate +
235959 : NULL;
1028 if (!empty($toActivityDate)) {
1030 AND ca.activity_date_time <= '{$toActivityDate}'";
1034 GROUP BY ca.id, tcc.id, scc.id, acc.id, ov.value";
1036 $sortBy = CRM_Utils_Array
::value('sortBy', $params);
1038 // CRM-5081 - added id to act like creation date
1040 ORDER BY overdue_date ASC, display_date DESC, weight DESC";
1043 $sortBy = CRM_Utils_Type
::escape($sortBy, 'String');
1044 $orderBy = " ORDER BY $sortBy ";
1047 $page = CRM_Utils_Array
::value('page', $params);
1048 $rp = CRM_Utils_Array
::value('rp', $params);
1056 $start = (($page - 1) * $rp);
1057 $limit = " LIMIT $start, $rp";
1059 $query = $select . $from . $where . $groupBy . $orderBy . $limit;
1060 $queryParams = array(1 => array($caseID, 'Integer'));
1062 $dao = CRM_Core_DAO
::executeQuery($query, $queryParams);
1063 $caseCount = CRM_Core_DAO
::singleValueQuery('SELECT FOUND_ROWS()');
1065 $activityTypes = CRM_Case_PseudoConstant
::caseActivityType(FALSE, TRUE);
1067 $compStatusValues = array_keys(
1068 CRM_Activity_BAO_Activity
::getStatusesByType(CRM_Activity_BAO_Activity
::COMPLETED
) +
1069 CRM_Activity_BAO_Activity
::getStatusesByType(CRM_Activity_BAO_Activity
::CANCELLED
)
1073 $userID = CRM_Core_Session
::getLoggedInContactID();
1076 $caseActivities = [];
1078 while ($dao->fetch()) {
1079 $caseActivityId = $dao->id
;
1081 //Do we have permission to access given case activity record.
1082 if (!self
::checkPermission($caseActivityId, 'view', $dao->activity_type_id
, $userID)) {
1086 $caseActivities[$caseActivityId]['DT_RowId'] = $caseActivityId;
1087 //Add classes to the row, via DataTables syntax
1088 $caseActivities[$caseActivityId]['DT_RowClass'] = "crm-entity status-id-$dao->status";
1090 if (CRM_Utils_Array
::crmInArray($dao->status
, $compStatusValues)) {
1091 $caseActivities[$caseActivityId]['DT_RowClass'] .= " status-completed";
1094 if (CRM_Utils_Date
::overdue($dao->display_date
)) {
1095 $caseActivities[$caseActivityId]['DT_RowClass'] .= " status-overdue";
1098 $caseActivities[$caseActivityId]['DT_RowClass'] .= " status-scheduled";
1102 if (!empty($dao->priority
)) {
1103 if ($dao->priority
== CRM_Core_PseudoConstant
::getKey('CRM_Activity_BAO_Activity', 'priority_id', 'Urgent')) {
1104 $caseActivities[$caseActivityId]['DT_RowClass'] .= " priority-urgent ";
1106 elseif ($dao->priority
== CRM_Core_PseudoConstant
::getKey('CRM_Activity_BAO_Activity', 'priority_id', 'Low')) {
1107 $caseActivities[$caseActivityId]['DT_RowClass'] .= " priority-low ";
1111 //Add data to the row for inline editing, via DataTable syntax
1112 $caseActivities[$caseActivityId]['DT_RowAttr'] = array();
1113 $caseActivities[$caseActivityId]['DT_RowAttr']['data-entity'] = 'activity';
1114 $caseActivities[$caseActivityId]['DT_RowAttr']['data-id'] = $caseActivityId;
1116 //Activity Date and Time
1117 $caseActivities[$caseActivityId]['activity_date_time'] = CRM_Utils_Date
::customFormat($dao->display_date
);
1120 $caseActivities[$caseActivityId]['subject'] = $dao->subject
;
1123 $caseActivities[$caseActivityId]['type'] = (!empty($activityTypes[$dao->type
]['icon']) ?
'<span class="crm-i ' . $activityTypes[$dao->type
]['icon'] . '"></span> ' : '')
1124 . $activityTypes[$dao->type
]['label'];
1126 // Activity Target (With Contact) (There can be more than one)
1127 $targetContact = self
::formatContactLink($dao->target_contact_id
, $dao->target_contact_name
);
1128 if (empty($caseActivities[$caseActivityId]['target_contact_name'])) {
1129 $caseActivities[$caseActivityId]['target_contact_name'] = $targetContact;
1132 if (strpos($caseActivities[$caseActivityId]['target_contact_name'], $targetContact) === FALSE) {
1133 $caseActivities[$caseActivityId]['target_contact_name'] .= '; ' . $targetContact;
1137 // Activity Source Contact (Reporter) (There can only be one)
1138 $sourceContact = self
::formatContactLink($dao->source_contact_id
, $dao->source_contact_name
);
1139 $caseActivities[$caseActivityId]['source_contact_name'] = $sourceContact;
1141 // Activity Assignee (There can be more than one)
1142 $assigneeContact = self
::formatContactLink($dao->assignee_contact_id
, $dao->assignee_contact_name
);
1143 if (empty($caseActivities[$caseActivityId]['assignee_contact_name'])) {
1144 $caseActivities[$caseActivityId]['assignee_contact_name'] = $assigneeContact;
1147 if (strpos($caseActivities[$caseActivityId]['assignee_contact_name'], $assigneeContact) === FALSE) {
1148 $caseActivities[$caseActivityId]['assignee_contact_name'] .= '; ' . $assigneeContact;
1152 // Activity Status Label for Case activities list
1153 $caseActivities[$caseActivityId]['status_id'] = CRM_Core_PseudoConstant
::getLabel('CRM_Activity_BAO_Activity', 'activity_status_id', $dao->status
);
1155 $caseActivities[$caseActivityId]
1156 = self
::addCaseActivityLinks($caseID, $contactID, $userID, $context, $dao, $caseActivities[$caseActivityId]);
1159 $caseActivitiesDT = array();
1160 $caseActivitiesDT['data'] = array_values($caseActivities);
1161 $caseActivitiesDT['recordsTotal'] = $caseCount;
1162 $caseActivitiesDT['recordsFiltered'] = $caseCount;
1164 return $caseActivitiesDT;
1168 * FIXME: This is a transitional function to facilitate a refactor of this to use CRM_Core_Action and actionLinks
1169 * Add the set of "actionLinks" to the case activity
1171 * @param int $caseID
1172 * @param int $contactID
1173 * @param int $userID
1174 * @param string $context
1175 * @param \CRM_Core_DAO $dao
1176 * @param array $caseActivity
1178 * @return array caseActivity
1180 public static function addCaseActivityLinks($caseID, $contactID, $userID, $context, $dao, $caseActivity) {
1181 // FIXME: Why are we not using CRM_Core_Action for these links? This is too much manual work and likely to get out-of-sync with core markup.
1182 $caseActivityId = $dao->id
;
1183 $allowView = self
::checkPermission($caseActivityId, 'view', $dao->activity_type_id
, $userID);
1184 $allowEdit = self
::checkPermission($caseActivityId, 'edit', $dao->activity_type_id
, $userID);
1185 $allowDelete = self
::checkPermission($caseActivityId, 'delete', $dao->activity_type_id
, $userID);
1186 $emailActivityTypeIDs = [
1187 'Email' => CRM_Core_PseudoConstant
::getKey('CRM_Activity_BAO_Activity', 'activity_type_id', 'Email'),
1188 'Inbound Email' => CRM_Core_PseudoConstant
::getKey('CRM_Activity_BAO_Activity', 'activity_type_id', 'Inbound Email'),
1190 $url = CRM_Utils_System
::url("civicrm/case/activity",
1191 "reset=1&cid={$contactID}&caseid={$caseID}", FALSE, NULL, FALSE
1194 if ($context == 'fulltext') {
1195 $contextUrl = "&context={$context}";
1197 $editUrl = "{$url}&action=update{$contextUrl}";
1198 $deleteUrl = "{$url}&action=delete{$contextUrl}";
1199 $restoreUrl = "{$url}&action=renew{$contextUrl}";
1200 $viewTitle = ts('View activity');
1201 $caseDeleted = CRM_Core_DAO
::getFieldValue('CRM_Case_DAO_Case', $caseID, 'is_deleted');
1204 $css = 'class="action-item crm-hover-button"';
1206 $viewUrl = CRM_Utils_System
::url('civicrm/case/activity/view', array('cid' => $contactID, 'aid' => $caseActivityId));
1207 $url = '<a ' . str_replace('action-item', 'action-item medium-pop-up', $css) . 'href="' . $viewUrl . '" title="' . $viewTitle . '">' . ts('View') . '</a>';
1209 $additionalUrl = "&id={$caseActivityId}";
1210 if (!$dao->deleted
) {
1211 //hide edit link of activity type email.CRM-4530.
1212 if (!in_array($dao->type
, $emailActivityTypeIDs)) {
1213 //hide Edit link if activity type is NOT editable (special case activities).CRM-5871
1215 $url .= '<a ' . $css . ' href="' . $editUrl . $additionalUrl . '">' . ts('Edit') . '</a> ';
1219 $url .= ' <a ' . str_replace('action-item', 'action-item small-popup', $css) . ' href="' . $deleteUrl . $additionalUrl . '">' . ts('Delete') . '</a>';
1222 elseif (!$caseDeleted) {
1223 $url = ' <a ' . $css . ' href="' . $restoreUrl . $additionalUrl . '">' . ts('Restore') . '</a>';
1224 $caseActivity['status_id'] = $caseActivity['status_id'] . '<br /> (deleted)';
1227 //check for operations.
1228 if (self
::checkPermission($caseActivityId, 'Move To Case', $dao->activity_type_id
)) {
1229 $url .= ' <a ' . $css . ' href="#" onClick="Javascript:fileOnCase( \'move\',' . $caseActivityId . ', ' . $caseID . ', this ); return false;">' . ts('Move To Case') . '</a> ';
1231 if (self
::checkPermission($caseActivityId, 'Copy To Case', $dao->activity_type_id
)) {
1232 $url .= ' <a ' . $css . ' href="#" onClick="Javascript:fileOnCase( \'copy\',' . $caseActivityId . ',' . $caseID . ', this ); return false;">' . ts('Copy To Case') . '</a> ';
1234 // if there are file attachments we will return how many and, if only one, add a link to it
1235 if (!empty($dao->attachment_ids
)) {
1236 $attachmentIDs = array_unique(explode(',', $dao->attachment_ids
));
1237 $caseActivity['no_attachments'] = count($attachmentIDs);
1238 $url .= implode(' ', CRM_Core_BAO_File
::paperIconAttachment('civicrm_activity', $caseActivityId));
1240 $caseActivity['links'] = $url;
1241 return $caseActivity;
1245 * Helper function to generate a formatted contact link/name for display in the Case activities tab
1248 * @param $contactName
1252 private static function formatContactLink($contactId, $contactName) {
1253 if (empty($contactId)) {
1257 $hasViewContact = CRM_Contact_BAO_Contact_Permission
::allow($contactId);
1259 if ($hasViewContact) {
1260 $contactViewUrl = CRM_Utils_System
::url("civicrm/contact/view", "reset=1&cid={$contactId}");
1261 return "<a href=\"{$contactViewUrl}\">" . $contactName . "</a>";
1264 return $contactName;
1269 * Get Case Related Contacts.
1271 * @param int $caseID
1273 * @param bool $includeDetails
1274 * If true include details of contacts.
1277 * array of return properties
1280 public static function getRelatedContacts($caseID, $includeDetails = TRUE) {
1281 $caseRoles = array();
1282 if ($includeDetails) {
1283 $caseInfo = civicrm_api3('Case', 'getsingle', array(
1285 // 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
1286 'return' => array('case_type_id', 'case_type_id.name', 'case_type_id.definition'),
1288 if (!empty($caseInfo['case_type_id.definition']['caseRoles'])) {
1289 $caseRoles = CRM_Utils_Array
::rekey($caseInfo['case_type_id.definition']['caseRoles'], 'name');
1294 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, ce.email, cp.phone
1295 FROM civicrm_relationship cr
1296 LEFT JOIN civicrm_relationship_type crt
1297 ON crt.id = cr.relationship_type_id
1298 LEFT JOIN civicrm_contact cc
1299 ON cc.id = cr.contact_id_b
1300 LEFT JOIN civicrm_email ce
1301 ON ce.contact_id = cc.id
1302 AND ce.is_primary= 1
1303 LEFT JOIN civicrm_phone cp
1304 ON cp.contact_id = cc.id
1305 AND cp.is_primary= 1
1306 WHERE cr.case_id = %1 AND cr.is_active AND cc.is_deleted <> 1';
1308 $params = array(1 => array($caseID, 'Integer'));
1309 $dao = CRM_Core_DAO
::executeQuery($query, $params);
1311 while ($dao->fetch()) {
1312 if (!$includeDetails) {
1313 $values[$dao->id
] = 1;
1317 'contact_id' => $dao->id
,
1318 'display_name' => $dao->name
,
1319 'sort_name' => $dao->sort_name
,
1320 'relationship_type_id' => $dao->relationship_type_id
,
1321 'role' => $dao->role
,
1322 'email' => $dao->email
,
1323 'phone' => $dao->phone
,
1325 // Add more info about the role (creator, manager)
1326 $role = CRM_Utils_Array
::value($dao->name_b_a
, $caseRoles);
1328 unset($role['name']);
1331 $values[] = $details;
1339 * Send e-mail copy of activity
1341 * @param int $clientId
1342 * @param int $activityId
1344 * @param array $contacts
1345 * Array of related contact.
1347 * @param null $attachments
1348 * @param int $caseId
1350 * @return bool |array
1352 public static function sendActivityCopy($clientId, $activityId, $contacts, $attachments = NULL, $caseId) {
1357 $tplParams = $activityInfo = array();
1358 $activityTypeId = CRM_Core_DAO
::getFieldValue('CRM_Activity_DAO_Activity', $activityId, 'activity_type_id');
1359 // If it's a case activity
1361 $nonCaseActivityTypes = CRM_Core_PseudoConstant
::activityType();
1362 if (!empty($nonCaseActivityTypes[$activityTypeId])) {
1363 $anyActivity = TRUE;
1366 $anyActivity = FALSE;
1368 $tplParams['isCaseActivity'] = 1;
1369 $tplParams['client_id'] = $clientId;
1372 $anyActivity = TRUE;
1375 $xmlProcessorProcess = new CRM_Case_XMLProcessor_Process();
1376 $isRedact = $xmlProcessorProcess->getRedactActivityEmail();
1378 $xmlProcessorReport = new CRM_Case_XMLProcessor_Report();
1380 $activityInfo = $xmlProcessorReport->getActivityInfo($clientId, $activityId, $anyActivity, $isRedact);
1382 $activityInfo['fields'][] = array('label' => 'Case ID', 'type' => 'String', 'value' => $caseId);
1384 $tplParams['activityTypeName'] = CRM_Core_PseudoConstant
::getLabel('CRM_Activity_DAO_Activity', 'activity_type_id', $activityTypeId);
1385 $tplParams['activity'] = $activityInfo;
1386 foreach ($tplParams['activity']['fields'] as $k => $val) {
1387 if (CRM_Utils_Array
::value('label', $val) == ts('Subject')) {
1388 $activitySubject = $val['value'];
1392 $session = CRM_Core_Session
::singleton();
1393 // CRM-8926 If user is not logged in, use the activity creator as userID
1394 if (!($userID = $session->get('userID'))) {
1395 $userID = CRM_Activity_BAO_Activity
::getSourceContactID($activityId);
1398 //also create activities simultaneously of this copy.
1399 $activityParams = array();
1401 $activityParams['source_record_id'] = $activityId;
1402 $activityParams['source_contact_id'] = $userID;
1403 $activityParams['activity_type_id'] = CRM_Core_PseudoConstant
::getKey('CRM_Activity_DAO_Activity', 'activity_type_id', 'Email');
1404 $activityParams['activity_date_time'] = date('YmdHis');
1405 $activityParams['status_id'] = CRM_Core_PseudoConstant
::getKey('CRM_Activity_DAO_Activity', 'activity_status_id', 'Completed');
1406 $activityParams['medium_id'] = CRM_Core_PseudoConstant
::getKey('CRM_Activity_DAO_Activity', 'encounter_medium', 'email');
1407 $activityParams['case_id'] = $caseId;
1408 $activityParams['is_auto'] = 0;
1409 $activityParams['target_id'] = $clientId;
1411 $tplParams['activitySubject'] = $activitySubject;
1413 // if it’s a case activity, add hashed id to the template (CRM-5916)
1415 $tplParams['idHash'] = substr(sha1(CIVICRM_SITE_KEY
. $caseId), 0, 7);
1419 // CRM-20308 get receiptFrom defaults see https://issues.civicrm.org/jira/browse/CRM-20308
1420 $receiptFrom = self
::getReceiptFrom($activityId);
1422 $recordedActivityParams = array();
1424 foreach ($contacts as $mail => $info) {
1425 $tplParams['contact'] = $info;
1426 self
::buildPermissionLinks($tplParams, $activityParams);
1428 $displayName = CRM_Utils_Array
::value('display_name', $info);
1430 list($result[CRM_Utils_Array
::value('contact_id', $info)], $subject, $message, $html) = CRM_Core_BAO_MessageTemplate
::sendTemplate(
1432 'groupName' => 'msg_tpl_workflow_case',
1433 'valueName' => 'case_activity',
1434 'contactId' => CRM_Utils_Array
::value('contact_id', $info),
1435 'tplParams' => $tplParams,
1436 'from' => $receiptFrom,
1437 'toName' => $displayName,
1439 'attachments' => $attachments,
1443 $activityParams['subject'] = ts('%1 - copy sent to %2', [1 => $activitySubject, 2 => $displayName]);
1444 $activityParams['details'] = $message;
1446 if (!empty($result[$info['contact_id']])) {
1448 * Really only need to record one activity with all the targets combined.
1449 * Originally the template was going to possibly have different content, e.g. depending on permissions,
1450 * but it's always the same content at the moment.
1452 if (empty($recordedActivityParams)) {
1453 $recordedActivityParams = $activityParams;
1456 $recordedActivityParams['subject'] .= "; $displayName";
1458 $recordedActivityParams['target_contact_id'][] = $info['contact_id'];
1461 unset($result[CRM_Utils_Array
::value('contact_id', $info)]);
1465 if (!empty($recordedActivityParams)) {
1466 $activity = CRM_Activity_BAO_Activity
::create($recordedActivityParams);
1468 //create case_activity record if its case activity.
1470 $caseParams = array(
1471 'activity_id' => $activity->id
,
1472 'case_id' => $caseId,
1474 self
::processCaseActivity($caseParams);
1482 * Retrieve count of activities having a particular type, and
1483 * associated with a particular case.
1485 * @param int $caseId
1487 * @param int $activityTypeId
1488 * ID of the activity type.
1492 public static function getCaseActivityCount($caseId, $activityTypeId) {
1493 $queryParam = array(
1494 1 => array($caseId, 'Integer'),
1495 2 => array($activityTypeId, 'Integer'),
1497 $query = "SELECT count(ca.id) as countact
1498 FROM civicrm_activity ca
1499 INNER JOIN civicrm_case_activity cca ON ca.id = cca.activity_id
1500 WHERE ca.activity_type_id = %2
1501 AND cca.case_id = %1
1502 AND ca.is_deleted = 0";
1504 $dao = CRM_Core_DAO
::executeQuery($query, $queryParam);
1505 if ($dao->fetch()) {
1506 return $dao->countact
;
1513 * Create an activity for a case via email.
1518 * @return array|void
1519 * $activity object of newly creted activity via email
1521 public static function recordActivityViaEmail($file) {
1522 if (!file_exists($file) ||
1525 return CRM_Core_Error
::fatal(ts('File %1 does not exist or is not readable',
1530 $result = CRM_Utils_Mail_Incoming
::parse($file);
1531 if ($result['is_error']) {
1535 foreach ($result['to'] as $to) {
1538 $emailPattern = '/^([A-Z0-9._%+-]+)\+([\d]+)@[A-Z0-9.-]+\.[A-Z]{2,4}$/i';
1539 $replacement = preg_replace($emailPattern, '$2', $to['email']);
1541 if ($replacement !== $to['email']) {
1542 $caseId = $replacement;
1543 //if caseId is invalid, return as error file
1544 if (!CRM_Core_DAO
::getFieldValue('CRM_Case_DAO_Case', $caseId, 'id')) {
1545 return CRM_Core_Error
::createAPIError(ts('Invalid case ID ( %1 ) in TO: field.',
1554 // TODO: May want to replace this with a call to getRelatedAndGlobalContacts() when this feature is revisited.
1555 // (Or for efficiency call the global one outside the loop and then union with this each time.)
1556 $contactDetails = self
::getRelatedContacts($caseId, FALSE);
1558 if (!empty($contactDetails[$result['from']['id']])) {
1560 $params['subject'] = $result['subject'];
1561 $params['activity_date_time'] = $result['date'];
1562 $params['details'] = $result['body'];
1563 $params['source_contact_id'] = $result['from']['id'];
1564 $params['status_id'] = CRM_Core_PseudoConstant
::getKey('CRM_Activity_BAO_Activity', 'activity_status_id', 'Completed');
1566 $details = CRM_Case_PseudoConstant
::caseActivityType();
1568 preg_match('/^\W+([a-zA-Z0-9_ ]+)(\W+)?\n/i',
1569 $result['body'], $matches
1572 if (!empty($matches) && isset($matches[1])) {
1573 $activityType = trim($matches[1]);
1574 if (isset($details[$activityType])) {
1575 $params['activity_type_id'] = $details[$activityType]['id'];
1578 if (!isset($params['activity_type_id'])) {
1579 $params['activity_type_id'] = CRM_Core_PseudoConstant
::getKey('CRM_Activity_BAO_Activity', 'activity_type_id', 'Inbound Email');
1583 $activity = CRM_Activity_BAO_Activity
::create($params);
1585 $caseParams = array(
1586 'activity_id' => $activity->id
,
1587 'case_id' => $caseId,
1589 self
::processCaseActivity($caseParams);
1592 return CRM_Core_Error
::createAPIError(ts('FROM email contact %1 doesn\'t have a relationship to the referenced case.',
1593 array(1 => $result['from']['email'])
1600 * Retrieve the scheduled activity type and date.
1602 * @param array $cases
1603 * Array of contact and case id.
1605 * @param string $type
1608 * Array of scheduled activity type and date
1612 public static function getNextScheduledActivity($cases, $type = 'upcoming') {
1613 $session = CRM_Core_Session
::singleton();
1614 $userID = $session->get('userID');
1616 $caseID = implode(',', $cases['case_id']);
1617 $contactID = implode(',', $cases['contact_id']);
1619 $condition = " civicrm_case_contact.contact_id IN( {$contactID} )
1620 AND civicrm_case.id IN( {$caseID})
1621 AND civicrm_case.is_deleted = {$cases['case_deleted']}";
1623 $query = self
::getCaseActivityQuery($type, $userID, $condition);
1625 $res = CRM_Core_DAO
::executeQuery($query);
1627 $activityInfo = array();
1628 while ($res->fetch()) {
1629 if ($type == 'upcoming') {
1630 $activityInfo[$res->case_id
]['date'] = $res->case_scheduled_activity_date
;
1631 $activityInfo[$res->case_id
]['type'] = $res->case_scheduled_activity_type
;
1634 $activityInfo[$res->case_id
]['date'] = $res->case_recent_activity_date
;
1635 $activityInfo[$res->case_id
]['type'] = $res->case_recent_activity_type
;
1639 return $activityInfo;
1643 * Combine all the exportable fields from the lower levels object.
1646 * array of exportable Fields
1648 public static function &exportableFields() {
1649 if (!self
::$_exportableFields) {
1650 if (!self
::$_exportableFields) {
1651 self
::$_exportableFields = array();
1654 $fields = CRM_Case_DAO_Case
::export();
1655 $fields['case_role'] = array('title' => ts('Role in Case'));
1656 $fields['case_type'] = array(
1657 'title' => ts('Case Type'),
1658 'name' => 'case_type',
1660 $fields['case_status'] = array(
1661 'title' => ts('Case Status'),
1662 'name' => 'case_status',
1665 // add custom data for cases
1666 $fields = array_merge($fields, CRM_Core_BAO_CustomField
::getFieldsForImport('Case'));
1668 self
::$_exportableFields = $fields;
1670 return self
::$_exportableFields;
1674 * Restore the record that are associated with this case.
1676 * @param int $caseId
1677 * Id of the case to restore.
1681 public static function restoreCase($caseId) {
1682 //restore activities
1683 $activities = self
::getCaseActivityDates($caseId);
1685 foreach ($activities as $value) {
1686 CRM_Activity_BAO_Activity
::restoreActivity($value);
1690 $case = new CRM_Case_DAO_Case();
1691 $case->id
= $caseId;
1692 $case->is_deleted
= 0;
1695 //CRM-7364, enable relationships
1696 self
::enableDisableCaseRelationships($caseId, TRUE);
1703 * @param null $showLinks
1704 * @param bool $returnOnlyCount
1705 * @param int $offset
1706 * @param int $rowCount
1710 public static function getGlobalContacts(&$groupInfo, $sort = NULL, $showLinks = NULL, $returnOnlyCount = FALSE, $offset = 0, $rowCount = 25) {
1711 $globalContacts = array();
1713 $settingsProcessor = new CRM_Case_XMLProcessor_Settings();
1714 $settings = $settingsProcessor->run();
1715 if (!empty($settings)) {
1716 $groupInfo['name'] = $settings['groupname'];
1717 if ($groupInfo['name']) {
1718 $searchParams = array('name' => $groupInfo['name']);
1720 CRM_Contact_BAO_Group
::retrieve($searchParams, $results);
1722 $groupInfo['id'] = $results['id'];
1723 $groupInfo['title'] = $results['title'];
1724 $params = array(array('group', '=', $groupInfo['id'], 0, 0));
1725 $return = array('contact_id' => 1, 'sort_name' => 1, 'display_name' => 1, 'email' => 1, 'phone' => 1);
1726 list($globalContacts) = CRM_Contact_BAO_Query
::apiQuery($params, $return, NULL, $sort, $offset, $rowCount, TRUE, $returnOnlyCount);
1728 if ($returnOnlyCount) {
1729 return $globalContacts;
1733 foreach ($globalContacts as $idx => $contact) {
1734 $globalContacts[$idx]['sort_name'] = '<a href="' . CRM_Utils_System
::url('civicrm/contact/view', "reset=1&cid={$contact['contact_id']}") . '">' . $contact['sort_name'] . '</a>';
1740 return $globalContacts;
1744 * Convenience function to get both case contacts and global in one array.
1745 * @param int $caseId
1749 public static function getRelatedAndGlobalContacts($caseId) {
1750 $relatedContacts = self
::getRelatedContacts($caseId);
1752 $groupInfo = array();
1753 $globalContacts = self
::getGlobalContacts($groupInfo);
1755 //unset values which are not required.
1756 foreach ($globalContacts as $k => & $v) {
1757 unset($v['email_id']);
1758 unset($v['group_contact_id']);
1759 unset($v['status']);
1761 $v['role'] = $groupInfo['title'];
1763 //include multiple listings for the same contact/different roles.
1764 $relatedGlobalContacts = array_merge($relatedContacts, $globalContacts);
1765 return $relatedGlobalContacts;
1769 * Get Case ActivitiesDueDates with given criteria.
1771 * @param int $caseID
1773 * @param array $criteriaParams
1775 * @param bool $latestDate
1776 * If set newest or oldest date is selected.
1779 * case activities due dates
1782 public static function getCaseActivityDates($caseID, $criteriaParams = array(), $latestDate = FALSE) {
1784 $selectDate = " ca.activity_date_time";
1785 $where = $groupBy = ' ';
1792 if (!empty($criteriaParams['activity_type_id'])) {
1793 $where .= " AND ca.activity_type_id = " . CRM_Utils_Type
::escape($criteriaParams['activity_type_id'], 'Integer');
1794 $where .= " AND ca.is_current_revision = 1";
1795 $groupBy .= " GROUP BY ca.activity_type_id, ca.id";
1798 if (!empty($criteriaParams['newest'])) {
1799 $selectDate = " max(ca.activity_date_time) ";
1802 $selectDate = " min(ca.activity_date_time) ";
1806 $query = "SELECT ca.id, {$selectDate} as activity_date
1807 FROM civicrm_activity ca
1808 LEFT JOIN civicrm_case_activity cca ON cca.activity_id = ca.id LEFT JOIN civicrm_case cc ON cc.id = cca.case_id
1809 WHERE cc.id = %1 {$where} {$groupBy}";
1811 $params = array(1 => array($caseID, 'Integer'));
1812 $dao = CRM_Core_DAO
::executeQuery($query, $params);
1814 while ($dao->fetch()) {
1815 $values[$dao->id
]['id'] = $dao->id
;
1816 $values[$dao->id
]['activity_date'] = $dao->activity_date
;
1822 * Create activities when Case or Other roles assigned/modified/deleted.
1824 * @param int $caseId
1825 * @param int $relationshipId
1827 * @param int $relContactId
1828 * Case role assignee contactId.
1829 * @param int $contactId
1831 public static function createCaseRoleActivity($caseId, $relationshipId, $relContactId = NULL, $contactId = NULL) {
1832 if (!$caseId ||
!$relationshipId ||
empty($relationshipId)) {
1836 $queryParam = array();
1837 if (is_array($relationshipId)) {
1838 $relationshipId = implode(',', $relationshipId);
1839 $relationshipClause = " civicrm_relationship.id IN ($relationshipId)";
1842 $relationshipClause = " civicrm_relationship.id = %1";
1843 $queryParam[1] = array($relationshipId, 'Positive');
1847 SELECT cc.display_name as clientName,
1848 cca.display_name as assigneeContactName,
1849 civicrm_relationship.case_id as caseId,
1850 civicrm_relationship_type.label_a_b as relation_a_b,
1851 civicrm_relationship_type.label_b_a as relation_b_a,
1852 civicrm_relationship.contact_id_b as rel_contact_id,
1853 civicrm_relationship.contact_id_a as assign_contact_id
1854 FROM civicrm_relationship_type, civicrm_relationship
1855 LEFT JOIN civicrm_contact cc ON cc.id = civicrm_relationship.contact_id_b
1856 LEFT JOIN civicrm_contact cca ON cca.id = civicrm_relationship.contact_id_a
1857 WHERE civicrm_relationship.relationship_type_id = civicrm_relationship_type.id AND {$relationshipClause}";
1859 $dao = CRM_Core_DAO
::executeQuery($query, $queryParam);
1861 while ($dao->fetch()) {
1862 // The assignee is not the client.
1863 if ($dao->rel_contact_id
!= $contactId) {
1864 $caseRelationship = $dao->relation_a_b
;
1865 $assigneContactName = $dao->clientName
;
1866 $assigneContactIds[$dao->rel_contact_id
] = $dao->rel_contact_id
;
1869 $caseRelationship = $dao->relation_b_a
;
1870 $assigneContactName = $dao->assigneeContactName
;
1871 $assigneContactIds[$dao->assign_contact_id
] = $dao->assign_contact_id
;
1875 $session = CRM_Core_Session
::singleton();
1876 $activityParams = array(
1877 'source_contact_id' => $session->get('userID'),
1878 'subject' => $caseRelationship . ' : ' . $assigneContactName,
1879 'activity_date_time' => date('YmdHis'),
1880 'status_id' => CRM_Core_PseudoConstant
::getKey('CRM_Activity_BAO_Activity', 'activity_status_id', 'Completed'),
1883 //if $relContactId is passed, role is added or modified.
1884 if (!empty($relContactId)) {
1885 $activityParams['assignee_contact_id'] = $assigneContactIds;
1886 $activityTypeID = CRM_Core_PseudoConstant
::getKey('CRM_Activity_BAO_Activity', 'activity_type_id', 'Assign Case Role');
1889 $activityTypeID = CRM_Core_PseudoConstant
::getKey('CRM_Activity_BAO_Activity', 'activity_type_id', 'Remove Case Role');
1892 $activityParams['activity_type_id'] = $activityTypeID;
1894 $activity = CRM_Activity_BAO_Activity
::create($activityParams);
1896 //create case_activity record.
1897 $caseParams = array(
1898 'activity_id' => $activity->id
,
1899 'case_id' => $caseId,
1902 CRM_Case_BAO_Case
::processCaseActivity($caseParams);
1907 * contact which is assigned a case role of case manager.
1909 * @param int $caseType
1911 * @param int $caseId
1915 * html hyperlink of manager contact view page
1918 public static function getCaseManagerContact($caseType, $caseId) {
1919 if (!$caseType ||
!$caseId) {
1923 $caseManagerName = '---';
1924 $xmlProcessor = new CRM_Case_XMLProcessor_Process();
1926 $managerRoleId = $xmlProcessor->getCaseManagerRoleId($caseType);
1928 if (!empty($managerRoleId)) {
1929 $managerRoleQuery = "
1930 SELECT civicrm_contact.id as casemanager_id,
1931 civicrm_contact.sort_name as casemanager
1932 FROM civicrm_contact
1933 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
1934 LEFT JOIN civicrm_case ON civicrm_case.id = civicrm_relationship.case_id
1935 WHERE civicrm_case.id = %2 AND is_active = 1";
1937 $managerRoleParams = array(
1938 1 => array($managerRoleId, 'Integer'),
1939 2 => array($caseId, 'Integer'),
1942 $dao = CRM_Core_DAO
::executeQuery($managerRoleQuery, $managerRoleParams);
1943 if ($dao->fetch()) {
1944 $caseManagerName = sprintf('<a href="%s">%s</a>',
1945 CRM_Utils_System
::url('civicrm/contact/view', array('cid' => $dao->casemanager_id
)),
1951 return $caseManagerName;
1955 * @param int $contactId
1956 * @param bool $excludeDeleted
1960 public static function caseCount($contactId = NULL, $excludeDeleted = TRUE) {
1961 $params = array('check_permissions' => TRUE);
1962 if ($excludeDeleted) {
1963 $params['is_deleted'] = 0;
1966 $params['contact_id'] = $contactId;
1969 return civicrm_api3('Case', 'getcount', $params);
1971 catch (CiviCRM_API3_Exception
$e) {
1972 // Lack of permissions will throw an exception
1978 * Retrieve related case ids for given case.
1980 * @param int $caseId
1981 * @param bool $excludeDeleted
1982 * Do not include deleted cases.
1986 public static function getRelatedCaseIds($caseId, $excludeDeleted = TRUE) {
1987 //FIXME : do check for permissions.
1993 $linkActType = CRM_Core_PseudoConstant
::getKey('CRM_Activity_BAO_Activity', 'activity_type_id', 'Link Cases');
1994 if (!$linkActType) {
1998 $whereClause = "mainCase.id = %2";
1999 if ($excludeDeleted) {
2000 $whereClause .= " AND ( relAct.is_deleted = 0 OR relAct.is_deleted IS NULL )";
2004 SELECT relCaseAct.case_id
2005 FROM civicrm_case mainCase
2006 INNER JOIN civicrm_case_activity mainCaseAct ON (mainCaseAct.case_id = mainCase.id)
2007 INNER JOIN civicrm_activity mainAct ON (mainCaseAct.activity_id = mainAct.id AND mainAct.activity_type_id = %1)
2008 INNER JOIN civicrm_case_activity relCaseAct ON (relCaseAct.activity_id = mainAct.id AND mainCaseAct.id != relCaseAct.id)
2009 INNER JOIN civicrm_activity relAct ON (relCaseAct.activity_id = relAct.id AND relAct.activity_type_id = %1)
2010 WHERE $whereClause";
2012 $dao = CRM_Core_DAO
::executeQuery($query, array(
2013 1 => array($linkActType, 'Integer'),
2014 2 => array($caseId, 'Integer'),
2016 $relatedCaseIds = array();
2017 while ($dao->fetch()) {
2018 $relatedCaseIds[$dao->case_id
] = $dao->case_id
;
2021 return array_values($relatedCaseIds);
2025 * Retrieve related case details for given case.
2027 * @param int $caseId
2028 * @param bool $excludeDeleted
2029 * Do not include deleted cases.
2033 public static function getRelatedCases($caseId, $excludeDeleted = TRUE) {
2034 $relatedCaseIds = self
::getRelatedCaseIds($caseId, $excludeDeleted);
2035 $relatedCases = array();
2037 if (!$relatedCaseIds) {
2041 $whereClause = 'relCase.id IN ( ' . implode(',', $relatedCaseIds) . ' )';
2042 if ($excludeDeleted) {
2043 $whereClause .= " AND ( relCase.is_deleted = 0 OR relCase.is_deleted IS NULL )";
2046 //filter for permissioned cases.
2047 $filterCases = array();
2048 $doFilterCases = FALSE;
2049 if (!CRM_Core_Permission
::check('access all cases and activities')) {
2050 $doFilterCases = TRUE;
2051 $filterCases = CRM_Case_BAO_Case
::getCases(FALSE);
2054 //2. fetch the details of related cases.
2056 SELECT relCase.id as id,
2057 civicrm_case_type.title as case_type,
2058 client.display_name as client_name,
2059 client.id as client_id,
2061 FROM civicrm_case relCase
2062 INNER JOIN civicrm_case_contact relCaseContact ON ( relCase.id = relCaseContact.case_id )
2063 INNER JOIN civicrm_contact client ON ( client.id = relCaseContact.contact_id )
2064 LEFT JOIN civicrm_case_type ON relCase.case_type_id = civicrm_case_type.id
2065 WHERE {$whereClause}";
2067 $dao = CRM_Core_DAO
::executeQuery($query);
2068 $contactViewUrl = CRM_Utils_System
::url("civicrm/contact/view", "reset=1&cid=");
2069 $hasViewContact = CRM_Core_Permission
::giveMeAllACLs();
2070 $statuses = CRM_Case_BAO_Case
::buildOptions('status_id');
2072 while ($dao->fetch()) {
2074 if (!$doFilterCases ||
array_key_exists($dao->id
, $filterCases)) {
2075 $caseViewStr = "reset=1&id={$dao->id}&cid={$dao->client_id}&action=view&context=case&selectedChild=case";
2076 $caseViewUrl = CRM_Utils_System
::url("civicrm/contact/view/case", $caseViewStr);
2077 $caseView = "<a class='action-item no-popup crm-hover-button' href='{$caseViewUrl}'>" . ts('View Case') . "</a>";
2079 $clientView = $dao->client_name
;
2080 if ($hasViewContact) {
2081 $clientView = "<a href='{$contactViewUrl}{$dao->client_id}'>$dao->client_name</a>";
2084 $relatedCases[$dao->id
] = array(
2085 'case_id' => $dao->id
,
2086 'case_type' => $dao->case_type
,
2087 'client_name' => $clientView,
2088 'case_status' => $statuses[$dao->status_id
],
2089 'links' => $caseView,
2093 return $relatedCases;
2097 * Merge two duplicate contacts' cases - follow CRM-5758 rules.
2099 * @see CRM_Dedupe_Merger::cpTables()
2101 * TODO: use the 3rd $sqls param to append sql statements rather than executing them here
2103 * @param int $mainContactId
2104 * @param int $otherContactId
2106 public static function mergeContacts($mainContactId, $otherContactId) {
2107 self
::mergeCases($mainContactId, NULL, $otherContactId);
2111 * Function perform two task.
2112 * 1. Merge two duplicate contacts cases - follow CRM-5758 rules.
2113 * 2. Merge two cases of same contact - follow CRM-5598 rules.
2115 * @param int $mainContactId
2116 * Contact id of main contact record.
2117 * @param int $mainCaseId
2118 * Case id of main case record.
2119 * @param int $otherContactId
2120 * Contact id of record which is going to merge.
2121 * @param int $otherCaseId
2122 * Case id of record which is going to merge.
2124 * @param bool $changeClient
2128 public static function mergeCases(
2129 $mainContactId, $mainCaseId = NULL, $otherContactId = NULL,
2130 $otherCaseId = NULL, $changeClient = FALSE) {
2131 $moveToTrash = TRUE;
2133 $duplicateContacts = FALSE;
2134 if ($mainContactId && $otherContactId &&
2135 $mainContactId != $otherContactId
2137 $duplicateContacts = TRUE;
2140 $duplicateCases = FALSE;
2141 if ($mainCaseId && $otherCaseId &&
2142 $mainCaseId != $otherCaseId
2144 $duplicateCases = TRUE;
2147 $mainCaseIds = array();
2148 if (!$duplicateContacts && !$duplicateCases) {
2149 return $mainCaseIds;
2152 $activityTypes = CRM_Activity_BAO_Activity
::buildOptions('activity_type_id', 'validate');
2153 $completedActivityStatus = CRM_Core_PseudoConstant
::getKey('CRM_Activity_BAO_Activity', 'activity_status_id', 'Completed');
2154 $activityContacts = CRM_Activity_BAO_ActivityContact
::buildOptions('record_type_id', 'validate');
2155 $sourceID = CRM_Utils_Array
::key('Activity Source', $activityContacts);
2156 $assigneeID = CRM_Utils_Array
::key('Activity Assignees', $activityContacts);
2157 $targetID = CRM_Utils_Array
::key('Activity Targets', $activityContacts);
2159 $processCaseIds = array($otherCaseId);
2160 if ($duplicateContacts && !$duplicateCases) {
2161 if ($changeClient) {
2162 $processCaseIds = array($mainCaseId);
2165 //get all case ids for other contact.
2166 $processCaseIds = self
::retrieveCaseIdsByContactId($otherContactId, TRUE);
2168 if (!is_array($processCaseIds)) {
2173 $session = CRM_Core_Session
::singleton();
2174 $currentUserId = $session->get('userID');
2176 CRM_Utils_Hook
::pre_case_merge($mainContactId, $mainCaseId, $otherContactId, $otherCaseId, $changeClient);
2178 // copy all cases and connect to main contact id.
2179 foreach ($processCaseIds as $otherCaseId) {
2180 if ($duplicateContacts) {
2181 $mainCase = CRM_Core_DAO
::copyGeneric('CRM_Case_DAO_Case', array('id' => $otherCaseId));
2182 $mainCaseId = $mainCase->id
;
2187 // CRM-11662 Copy Case custom data
2188 $extends = array('case');
2189 $groupTree = CRM_Core_BAO_CustomGroup
::getGroupDetail(NULL, NULL, $extends);
2191 foreach ($groupTree as $groupID => $group) {
2192 $table[$groupTree[$groupID]['table_name']] = array('entity_id');
2193 foreach ($group['fields'] as $fieldID => $field) {
2194 $table[$groupTree[$groupID]['table_name']][] = $groupTree[$groupID]['fields'][$fieldID]['column_name'];
2198 foreach ($table as $tableName => $tableColumns) {
2199 $insert = 'INSERT INTO ' . $tableName . ' (' . implode(', ', $tableColumns) . ') ';
2200 $tableColumns[0] = $mainCaseId;
2201 $select = 'SELECT ' . implode(', ', $tableColumns);
2202 $from = ' FROM ' . $tableName;
2203 $where = " WHERE {$tableName}.entity_id = {$otherCaseId}";
2204 $query = $insert . $select . $from . $where;
2205 $dao = CRM_Core_DAO
::executeQuery($query);
2209 $mainCaseIds[] = $mainCaseId;
2210 //insert record for case contact.
2211 $otherCaseContact = new CRM_Case_DAO_CaseContact();
2212 $otherCaseContact->case_id
= $otherCaseId;
2213 $otherCaseContact->find();
2214 while ($otherCaseContact->fetch()) {
2215 $mainCaseContact = new CRM_Case_DAO_CaseContact();
2216 $mainCaseContact->case_id
= $mainCaseId;
2217 $mainCaseContact->contact_id
= $otherCaseContact->contact_id
;
2218 if ($mainCaseContact->contact_id
== $otherContactId) {
2219 $mainCaseContact->contact_id
= $mainContactId;
2221 //avoid duplicate object.
2222 if (!$mainCaseContact->find(TRUE)) {
2223 $mainCaseContact->save();
2227 elseif (!$otherContactId) {
2228 $otherContactId = $mainContactId;
2231 if (!$mainCaseId ||
!$otherCaseId ||
2232 !$mainContactId ||
!$otherContactId
2237 // get all activities for other case.
2238 $otherCaseActivities = array();
2239 CRM_Core_DAO
::commonRetrieveAll('CRM_Case_DAO_CaseActivity', 'case_id', $otherCaseId, $otherCaseActivities);
2241 //for duplicate cases do not process singleton activities.
2242 $otherActivityIds = $singletonActivityIds = array();
2243 foreach ($otherCaseActivities as $caseActivityId => $otherIds) {
2244 $otherActId = CRM_Utils_Array
::value('activity_id', $otherIds);
2245 if (!$otherActId ||
in_array($otherActId, $otherActivityIds)) {
2248 $otherActivityIds[] = $otherActId;
2250 if ($duplicateCases) {
2251 if ($openCaseType = array_search('Open Case', $activityTypes)) {
2254 FROM civicrm_activity
2255 WHERE activity_type_id = $openCaseType
2256 AND id IN ( " . implode(',', array_values($otherActivityIds)) . ');';
2257 $dao = CRM_Core_DAO
::executeQuery($sql);
2258 while ($dao->fetch()) {
2259 $singletonActivityIds[] = $dao->id
;
2264 // migrate all activities and connect to main contact.
2265 $copiedActivityIds = $activityMappingIds = array();
2266 sort($otherActivityIds);
2267 foreach ($otherActivityIds as $otherActivityId) {
2269 //for duplicate cases -
2270 //do not migrate singleton activities.
2271 if (!$otherActivityId ||
in_array($otherActivityId, $singletonActivityIds)) {
2275 //migrate activity record.
2276 $otherActivity = new CRM_Activity_DAO_Activity();
2277 $otherActivity->id
= $otherActivityId;
2278 if (!$otherActivity->find(TRUE)) {
2282 $mainActVals = array();
2283 $mainActivity = new CRM_Activity_DAO_Activity();
2284 CRM_Core_DAO
::storeValues($otherActivity, $mainActVals);
2285 $mainActivity->copyValues($mainActVals);
2286 $mainActivity->id
= NULL;
2287 $mainActivity->activity_date_time
= CRM_Utils_Date
::isoToMysql($otherActivity->activity_date_time
);
2288 $mainActivity->source_record_id
= CRM_Utils_Array
::value($mainActivity->source_record_id
,
2292 $mainActivity->original_id
= CRM_Utils_Array
::value($mainActivity->original_id
,
2296 $mainActivity->parent_id
= CRM_Utils_Array
::value($mainActivity->parent_id
,
2299 $mainActivity->save();
2300 $mainActivityId = $mainActivity->id
;
2301 if (!$mainActivityId) {
2305 $activityMappingIds[$otherActivityId] = $mainActivityId;
2306 // insert log of all activities
2307 CRM_Activity_BAO_Activity
::logActivityAction($mainActivity);
2309 $copiedActivityIds[] = $otherActivityId;
2311 //create case activity record.
2312 $mainCaseActivity = new CRM_Case_DAO_CaseActivity();
2313 $mainCaseActivity->case_id
= $mainCaseId;
2314 $mainCaseActivity->activity_id
= $mainActivityId;
2315 $mainCaseActivity->save();
2317 //migrate source activity.
2318 $otherSourceActivity = new CRM_Activity_DAO_ActivityContact();
2319 $otherSourceActivity->activity_id
= $otherActivityId;
2320 $otherSourceActivity->record_type_id
= $sourceID;
2321 $otherSourceActivity->find();
2322 while ($otherSourceActivity->fetch()) {
2323 $mainActivitySource = new CRM_Activity_DAO_ActivityContact();
2324 $mainActivitySource->record_type_id
= $sourceID;
2325 $mainActivitySource->activity_id
= $mainActivityId;
2326 $mainActivitySource->contact_id
= $otherSourceActivity->contact_id
;
2327 if ($mainActivitySource->contact_id
== $otherContactId) {
2328 $mainActivitySource->contact_id
= $mainContactId;
2330 //avoid duplicate object.
2331 if (!$mainActivitySource->find(TRUE)) {
2332 $mainActivitySource->save();
2336 //migrate target activities.
2337 $otherTargetActivity = new CRM_Activity_DAO_ActivityContact();
2338 $otherTargetActivity->activity_id
= $otherActivityId;
2339 $otherTargetActivity->record_type_id
= $targetID;
2340 $otherTargetActivity->find();
2341 while ($otherTargetActivity->fetch()) {
2342 $mainActivityTarget = new CRM_Activity_DAO_ActivityContact();
2343 $mainActivityTarget->record_type_id
= $targetID;
2344 $mainActivityTarget->activity_id
= $mainActivityId;
2345 $mainActivityTarget->contact_id
= $otherTargetActivity->contact_id
;
2346 if ($mainActivityTarget->contact_id
== $otherContactId) {
2347 $mainActivityTarget->contact_id
= $mainContactId;
2349 //avoid duplicate object.
2350 if (!$mainActivityTarget->find(TRUE)) {
2351 $mainActivityTarget->save();
2355 //migrate assignee activities.
2356 $otherAssigneeActivity = new CRM_Activity_DAO_ActivityContact();
2357 $otherAssigneeActivity->activity_id
= $otherActivityId;
2358 $otherAssigneeActivity->record_type_id
= $assigneeID;
2359 $otherAssigneeActivity->find();
2360 while ($otherAssigneeActivity->fetch()) {
2361 $mainAssigneeActivity = new CRM_Activity_DAO_ActivityContact();
2362 $mainAssigneeActivity->activity_id
= $mainActivityId;
2363 $mainAssigneeActivity->record_type_id
= $assigneeID;
2364 $mainAssigneeActivity->contact_id
= $otherAssigneeActivity->contact_id
;
2365 if ($mainAssigneeActivity->contact_id
== $otherContactId) {
2366 $mainAssigneeActivity->contact_id
= $mainContactId;
2368 //avoid duplicate object.
2369 if (!$mainAssigneeActivity->find(TRUE)) {
2370 $mainAssigneeActivity->save();
2374 // copy custom fields and attachments
2376 'activityID' => $otherActivityId,
2377 'mainActivityId' => $mainActivityId,
2379 CRM_Activity_BAO_Activity
::copyExtendedActivityData($aparams);
2382 //copy case relationship.
2383 if ($duplicateContacts) {
2384 //migrate relationship records.
2385 $otherRelationship = new CRM_Contact_DAO_Relationship();
2386 $otherRelationship->case_id
= $otherCaseId;
2387 $otherRelationship->find();
2388 $otherRelationshipIds = array();
2389 while ($otherRelationship->fetch()) {
2390 $otherRelVals = array();
2391 $updateOtherRel = FALSE;
2392 CRM_Core_DAO
::storeValues($otherRelationship, $otherRelVals);
2394 $mainRelationship = new CRM_Contact_DAO_Relationship();
2395 $mainRelationship->copyValues($otherRelVals);
2396 $mainRelationship->id
= NULL;
2397 $mainRelationship->case_id
= $mainCaseId;
2398 if ($mainRelationship->contact_id_a
== $otherContactId) {
2399 $updateOtherRel = TRUE;
2400 $mainRelationship->contact_id_a
= $mainContactId;
2403 //case creator change only when we merge user contact.
2404 if ($mainRelationship->contact_id_b
== $otherContactId) {
2405 //do not change creator for change client.
2406 if (!$changeClient) {
2407 $updateOtherRel = TRUE;
2408 $mainRelationship->contact_id_b
= ($currentUserId) ?
$currentUserId : $mainContactId;
2411 $mainRelationship->end_date
= CRM_Utils_Date
::isoToMysql($otherRelationship->end_date
);
2412 $mainRelationship->start_date
= CRM_Utils_Date
::isoToMysql($otherRelationship->start_date
);
2414 //avoid duplicate object.
2415 if (!$mainRelationship->find(TRUE)) {
2416 $mainRelationship->save();
2419 //get the other relationship ids to update end date.
2420 if ($updateOtherRel) {
2421 $otherRelationshipIds[$otherRelationship->id
] = $otherRelationship->id
;
2425 //update other relationships end dates
2426 if (!empty($otherRelationshipIds)) {
2427 $sql = 'UPDATE civicrm_relationship
2428 SET end_date = CURDATE()
2429 WHERE id IN ( ' . implode(',', $otherRelationshipIds) . ')';
2430 CRM_Core_DAO
::executeQuery($sql);
2434 //move other case to trash.
2435 $mergeCase = self
::deleteCase($otherCaseId, $moveToTrash);
2440 $mergeActSubject = $mergeActSubjectDetails = $mergeActType = '';
2441 if ($changeClient) {
2442 $mainContactDisplayName = CRM_Contact_BAO_Contact
::displayName($mainContactId);
2443 $otherContactDisplayName = CRM_Contact_BAO_Contact
::displayName($otherContactId);
2445 $mergeActType = array_search('Reassigned Case', $activityTypes);
2446 $mergeActSubject = ts("Case %1 reassigned client from %2 to %3. New Case ID is %4.",
2449 2 => $otherContactDisplayName,
2450 3 => $mainContactDisplayName,
2455 elseif ($duplicateContacts) {
2456 $mergeActType = array_search('Merge Case', $activityTypes);
2457 $mergeActSubject = ts("Case %1 copied from contact id %2 to contact id %3 via merge. New Case ID is %4.",
2460 2 => $otherContactId,
2461 3 => $mainContactId,
2467 $mergeActType = array_search('Merge Case', $activityTypes);
2468 $mergeActSubject = ts("Case %1 merged into case %2", array(1 => $otherCaseId, 2 => $mainCaseId));
2469 if (!empty($copiedActivityIds)) {
2471 SELECT id, subject, activity_date_time, activity_type_id
2472 FROM civicrm_activity
2473 WHERE id IN (' . implode(',', $copiedActivityIds) . ')';
2474 $dao = CRM_Core_DAO
::executeQuery($sql);
2475 while ($dao->fetch()) {
2476 $mergeActSubjectDetails .= "{$dao->activity_date_time} :: {$activityTypes[$dao->activity_type_id]}";
2477 if ($dao->subject
) {
2478 $mergeActSubjectDetails .= " :: {$dao->subject}";
2480 $mergeActSubjectDetails .= "<br />";
2485 // Create merge activity record. Source for merge activity is the logged in user's contact ID ($currentUserId).
2486 $activityParams = array(
2487 'subject' => $mergeActSubject,
2488 'details' => $mergeActSubjectDetails,
2489 'status_id' => $completedActivityStatus,
2490 'activity_type_id' => $mergeActType,
2491 'source_contact_id' => $currentUserId,
2492 'activity_date_time' => date('YmdHis'),
2495 $mergeActivity = CRM_Activity_BAO_Activity
::create($activityParams);
2496 $mergeActivityId = $mergeActivity->id
;
2497 if (!$mergeActivityId) {
2501 //connect merge activity to case.
2502 $mergeCaseAct = array(
2503 'case_id' => $mainCaseId,
2504 'activity_id' => $mergeActivityId,
2507 self
::processCaseActivity($mergeCaseAct);
2510 CRM_Utils_Hook
::post_case_merge($mainContactId, $mainCaseId, $otherContactId, $otherCaseId, $changeClient);
2512 return $mainCaseIds;
2516 * Validate contact permission for
2517 * edit/view on activity record and build links.
2519 * @param array $tplParams
2520 * Params to be sent to template for sending email.
2521 * @param array $activityParams
2522 * Info of the activity.
2524 public static function buildPermissionLinks(&$tplParams, $activityParams) {
2525 $activityTypeId = CRM_Core_DAO
::getFieldValue('CRM_Activity_DAO_Activity', $activityParams['source_record_id'],
2526 'activity_type_id', 'id'
2529 if (!empty($tplParams['isCaseActivity'])) {
2530 $tplParams['editActURL'] = CRM_Utils_System
::url('civicrm/case/activity',
2531 "reset=1&cid={$activityParams['target_id']}&caseid={$activityParams['case_id']}&action=update&id={$activityParams['source_record_id']}", TRUE
2534 $tplParams['viewActURL'] = CRM_Utils_System
::url('civicrm/case/activity/view',
2535 "reset=1&aid={$activityParams['source_record_id']}&cid={$activityParams['target_id']}&caseID={$activityParams['case_id']}", TRUE
2538 $tplParams['manageCaseURL'] = CRM_Utils_System
::url('civicrm/contact/view/case',
2539 "reset=1&id={$activityParams['case_id']}&cid={$activityParams['target_id']}&action=view&context=home", TRUE
2543 $tplParams['editActURL'] = CRM_Utils_System
::url('civicrm/contact/view/activity',
2544 "atype=$activityTypeId&action=update&reset=1&id={$activityParams['source_record_id']}&cid={$tplParams['contact']['contact_id']}&context=activity", TRUE
2547 $tplParams['viewActURL'] = CRM_Utils_System
::url('civicrm/contact/view/activity',
2548 "atype=$activityTypeId&action=view&reset=1&id={$activityParams['source_record_id']}&cid={$tplParams['contact']['contact_id']}&context=activity", TRUE
2554 * Validate contact permission for
2555 * given operation on activity record.
2557 * @param int $activityId
2558 * Activity record id.
2559 * @param string $operation
2561 * @param int $actTypeId
2563 * @param int $contactId
2564 * Contact id/if not pass consider logged in.
2565 * @param bool $checkComponent
2566 * Do we need to check component enabled.
2570 public static function checkPermission($activityId, $operation, $actTypeId = NULL, $contactId = NULL, $checkComponent = TRUE) {
2572 if (!$actTypeId && $activityId) {
2573 $actTypeId = CRM_Core_DAO
::getFieldValue('CRM_Activity_DAO_Activity', $activityId, 'activity_type_id');
2576 if (!$activityId ||
!$operation ||
!$actTypeId) {
2580 //do check for civicase component enabled.
2581 if ($checkComponent && !self
::enabled()) {
2585 //do check for cases.
2586 $caseActOperations = array(
2593 if (in_array($operation, $caseActOperations)) {
2595 if (!isset($caseCount)) {
2597 $caseCount = civicrm_api3('Case', 'getcount', array(
2598 'check_permissions' => TRUE,
2599 'status_id' => array('!=' => 'Closed'),
2601 'end_date' => array('IS NULL' => 1),
2604 catch (CiviCRM_API3_Exception
$e) {
2605 // Lack of permissions will throw an exception
2609 if ($operation == 'File On Case') {
2610 $allow = !empty($caseCount);
2613 $allow = ($caseCount > 1);
2617 $actionOperations = array('view', 'edit', 'delete');
2618 if (in_array($operation, $actionOperations)) {
2620 //do cache when user has non/supper permission.
2621 static $allowOperations;
2623 if (!is_array($allowOperations) ||
2624 !array_key_exists($operation, $allowOperations)
2628 $session = CRM_Core_Session
::singleton();
2629 $contactId = $session->get('userID');
2632 //check for permissions.
2633 $permissions = array(
2635 'access my cases and activities',
2636 'access all cases and activities',
2639 'access my cases and activities',
2640 'access all cases and activities',
2642 'delete' => array('delete activities'),
2645 //check for core permission.
2646 $hasPermissions = array();
2647 $checkPermissions = CRM_Utils_Array
::value($operation, $permissions);
2648 if (is_array($checkPermissions)) {
2649 foreach ($checkPermissions as $per) {
2650 if (CRM_Core_Permission
::check($per)) {
2651 $hasPermissions[$operation][] = $per;
2657 if (!empty($hasPermissions)) {
2658 //need to check activity object specific.
2659 if (in_array($operation, array(
2664 //do we have supper permission.
2665 if (in_array('access all cases and activities', $hasPermissions[$operation])) {
2666 $allowOperations[$operation] = $allow = TRUE;
2669 //user has only access to my cases and activity.
2670 //here object specific permmions come in picture.
2672 //edit - contact must be source or assignee
2673 //view - contact must be source/assignee/target
2674 $isTarget = $isAssignee = $isSource = FALSE;
2675 $activityContacts = CRM_Activity_BAO_ActivityContact
::buildOptions('record_type_id', 'validate');
2676 $sourceID = CRM_Utils_Array
::key('Activity Source', $activityContacts);
2677 $assigneeID = CRM_Utils_Array
::key('Activity Assignees', $activityContacts);
2678 $targetID = CRM_Utils_Array
::key('Activity Targets', $activityContacts);
2680 $target = new CRM_Activity_DAO_ActivityContact();
2681 $target->record_type_id
= $targetID;
2682 $target->activity_id
= $activityId;
2683 $target->contact_id
= $contactId;
2684 if ($target->find(TRUE)) {
2688 $assignee = new CRM_Activity_DAO_ActivityContact();
2689 $assignee->activity_id
= $activityId;
2690 $assignee->record_type_id
= $assigneeID;
2691 $assignee->contact_id
= $contactId;
2692 if ($assignee->find(TRUE)) {
2696 $source = new CRM_Activity_DAO_ActivityContact();
2697 $source->activity_id
= $activityId;
2698 $source->record_type_id
= $sourceID;
2699 $source->contact_id
= $contactId;
2700 if ($source->find(TRUE)) {
2704 if ($operation == 'edit') {
2705 if ($isAssignee ||
$isSource) {
2709 if ($operation == 'view') {
2710 if ($isTarget ||
$isAssignee ||
$isSource) {
2716 elseif (is_array($hasPermissions[$operation])) {
2717 $allowOperations[$operation] = $allow = TRUE;
2721 //contact do not have permission.
2722 $allowOperations[$operation] = FALSE;
2727 //here contact might have supper/non permission.
2728 $allow = $allowOperations[$operation];
2732 //do further only when operation is granted.
2734 $actTypeName = CRM_Core_PseudoConstant
::getName('CRM_Activity_BAO_Activity', 'activity_type_id', $actTypeId);
2736 //do not allow multiple copy / edit action.
2737 $singletonNames = array(
2747 //do not allow to delete these activities, CRM-4543
2748 $doNotDeleteNames = array('Open Case', 'Change Case Type', 'Change Case Status', 'Change Case Start Date');
2750 //allow edit operation.
2751 $allowEditNames = array('Open Case');
2753 if (CRM_Core_Permission
::check('edit inbound email basic information') ||
2754 CRM_Core_Permission
::check('edit inbound email basic information and content')
2756 $allowEditNames[] = 'Inbound Email';
2759 // do not allow File on Case
2760 $doNotFileNames = array(
2763 'Change Case Status',
2764 'Change Case Start Date',
2771 if (in_array($actTypeName, $singletonNames)) {
2773 if ($operation == 'File On Case') {
2774 $allow = (in_array($actTypeName, $doNotFileNames)) ?
FALSE : TRUE;
2776 if (in_array($operation, $actionOperations)) {
2778 if ($operation == 'edit') {
2779 $allow = (in_array($actTypeName, $allowEditNames)) ?
TRUE : FALSE;
2781 elseif ($operation == 'delete') {
2782 $allow = (in_array($actTypeName, $doNotDeleteNames)) ?
FALSE : TRUE;
2786 if ($allow && ($operation == 'delete') &&
2787 in_array($actTypeName, $doNotDeleteNames)
2792 if ($allow && ($operation == 'File On Case') &&
2793 in_array($actTypeName, $doNotFileNames)
2798 //check settings file for masking actions
2799 //on the basis the activity types
2800 //hide Edit link if activity type is NOT editable
2801 //(special case activities).CRM-5871
2802 if ($allow && in_array($operation, $actionOperations)) {
2803 static $actionFilter = array();
2804 if (!array_key_exists($operation, $actionFilter)) {
2805 $xmlProcessor = new CRM_Case_XMLProcessor_Process();
2806 $actionFilter[$operation] = $xmlProcessor->get('Settings', 'ActivityTypes', FALSE, $operation);
2808 if (array_key_exists($operation, $actionFilter[$operation]) &&
2809 in_array($actTypeId, $actionFilter[$operation][$operation])
2820 * Since we drop 'access CiviCase', allow access
2821 * if user has 'access my cases and activities'
2822 * or 'access all cases and activities'
2824 public static function accessCiviCase() {
2825 if (!self
::enabled()) {
2829 if (CRM_Core_Permission
::check('access my cases and activities') ||
2830 CRM_Core_Permission
::check('access all cases and activities')
2839 * Verify user has permission to access a case.
2841 * @param int $caseId
2842 * @param bool $denyClosed
2843 * Set TRUE if one wants closed cases to be treated as inaccessible.
2847 public static function accessCase($caseId, $denyClosed = TRUE) {
2848 if (!$caseId ||
!self
::enabled()) {
2852 $params = array('id' => $caseId, 'check_permissions' => TRUE);
2853 if ($denyClosed && !CRM_Core_Permission
::check('access all cases and activities')) {
2854 $params['status_id'] = array('!=' => 'Closed');
2857 return (bool) civicrm_api3('Case', 'getcount', $params);
2859 catch (CiviCRM_API3_Exception
$e) {
2860 // Lack of permissions will throw an exception
2866 * Check whether activity is a case Activity.
2868 * @param int $activityID
2873 public static function isCaseActivity($activityID) {
2874 $isCaseActivity = FALSE;
2876 $params = array(1 => array($activityID, 'Integer'));
2877 $query = "SELECT id FROM civicrm_case_activity WHERE activity_id = %1";
2878 if (CRM_Core_DAO
::singleValueQuery($query, $params)) {
2879 $isCaseActivity = TRUE;
2883 return $isCaseActivity;
2887 * Get all the case type ids currently in use.
2891 public static function getUsedCaseType() {
2892 static $caseTypeIds;
2894 if (!is_array($caseTypeIds)) {
2895 $query = "SELECT DISTINCT( civicrm_case.case_type_id ) FROM civicrm_case";
2897 $dao = CRM_Core_DAO
::executeQuery($query);
2898 $caseTypeIds = array();
2899 while ($dao->fetch()) {
2900 $typeId = explode(CRM_Core_DAO
::VALUE_SEPARATOR
,
2903 $caseTypeIds[] = $typeId[1];
2907 return $caseTypeIds;
2911 * Get all the case status ids currently in use.
2915 public static function getUsedCaseStatuses() {
2916 static $caseStatusIds;
2918 if (!is_array($caseStatusIds)) {
2919 $query = "SELECT DISTINCT( civicrm_case.status_id ) FROM civicrm_case";
2921 $dao = CRM_Core_DAO
::executeQuery($query);
2922 $caseStatusIds = array();
2923 while ($dao->fetch()) {
2924 $caseStatusIds[] = $dao->status_id
;
2928 return $caseStatusIds;
2932 * Get all the encounter medium ids currently in use.
2936 public static function getUsedEncounterMediums() {
2939 if (!is_array($mediumIds)) {
2940 $query = "SELECT DISTINCT( civicrm_activity.medium_id ) FROM civicrm_activity";
2942 $dao = CRM_Core_DAO
::executeQuery($query);
2943 $mediumIds = array();
2944 while ($dao->fetch()) {
2945 $mediumIds[] = $dao->medium_id
;
2953 * Check case configuration.
2955 * @param int $contactId
2959 public static function isCaseConfigured($contactId = NULL) {
2960 $configured = array_fill_keys(array('configured', 'allowToAddNewCase', 'redirectToCaseAdmin'), FALSE);
2962 //lets check for case configured.
2963 $allCasesCount = CRM_Case_BAO_Case
::caseCount(NULL, FALSE);
2964 $configured['configured'] = ($allCasesCount) ?
TRUE : FALSE;
2965 if (!$configured['configured']) {
2966 //do check for case type and case status.
2967 $caseTypes = CRM_Case_PseudoConstant
::caseType('title', FALSE);
2968 if (!empty($caseTypes)) {
2969 $configured['configured'] = TRUE;
2970 if (!$configured['configured']) {
2971 $caseStatuses = CRM_Case_PseudoConstant
::caseStatus('label', FALSE);
2972 if (!empty($caseStatuses)) {
2973 $configured['configured'] = TRUE;
2978 if ($configured['configured']) {
2979 //do check for active case type and case status.
2980 $caseTypes = CRM_Case_PseudoConstant
::caseType();
2981 if (!empty($caseTypes)) {
2982 $caseStatuses = CRM_Case_PseudoConstant
::caseStatus();
2983 if (!empty($caseStatuses)) {
2984 $configured['allowToAddNewCase'] = TRUE;
2988 //do we need to redirect user to case admin.
2989 if (!$configured['allowToAddNewCase'] && $contactId) {
2990 //check for current contact case count.
2991 $currentContatCasesCount = CRM_Case_BAO_Case
::caseCount($contactId);
2992 //redirect user to case admin page.
2993 if (!$currentContatCasesCount) {
2994 $configured['redirectToCaseAdmin'] = TRUE;
3003 * Used during case component enablement and during ugprade.
3007 public static function createCaseViews() {
3008 $errorScope = CRM_Core_TemporaryErrorScope
::ignoreException();
3009 $dao = new CRM_Core_DAO();
3011 $sql = self
::createCaseViewsQuery('upcoming');
3013 if (PEAR
::getStaticProperty('DB_DataObject', 'lastError')) {
3017 // Above error doesn't get caught?
3018 $doublecheck = $dao->singleValueQuery("SELECT count(id) FROM civicrm_view_case_activity_upcoming");
3019 if (is_null($doublecheck)) {
3023 $sql = self
::createCaseViewsQuery('recent');
3025 if (PEAR
::getStaticProperty('DB_DataObject', 'lastError')) {
3029 // Above error doesn't get caught?
3030 $doublecheck = $dao->singleValueQuery("SELECT count(id) FROM civicrm_view_case_activity_recent");
3031 if (is_null($doublecheck)) {
3039 * Helper function, also used by the upgrade in case of error
3041 * @param string $section
3045 public static function createCaseViewsQuery($section = 'upcoming') {
3047 $scheduled_id = CRM_Core_Pseudoconstant
::getKey('CRM_Activity_BAO_Activity', 'activity_status_id', 'Scheduled');
3050 $sql = "CREATE OR REPLACE VIEW `civicrm_view_case_activity_upcoming`
3051 AS SELECT ca.case_id, a.id, a.activity_date_time, a.status_id, a.activity_type_id
3052 FROM civicrm_case_activity ca
3053 INNER JOIN civicrm_activity a ON ca.activity_id=a.id
3054 WHERE a.activity_date_time =
3055 (SELECT b.activity_date_time FROM civicrm_case_activity bca
3056 INNER JOIN civicrm_activity b ON bca.activity_id=b.id
3057 WHERE b.activity_date_time <= DATE_ADD( NOW(), INTERVAL 14 DAY )
3058 AND b.is_current_revision = 1 AND b.is_deleted=0 AND b.status_id = $scheduled_id
3059 AND bca.case_id = ca.case_id ORDER BY b.activity_date_time ASC LIMIT 1)";
3063 $sql = "CREATE OR REPLACE VIEW `civicrm_view_case_activity_recent`
3064 AS SELECT ca.case_id, a.id, a.activity_date_time, a.status_id, a.activity_type_id
3065 FROM civicrm_case_activity ca
3066 INNER JOIN civicrm_activity a ON ca.activity_id=a.id
3067 WHERE a.activity_date_time =
3068 (SELECT b.activity_date_time FROM civicrm_case_activity bca
3069 INNER JOIN civicrm_activity b ON bca.activity_id=b.id
3070 WHERE b.activity_date_time >= DATE_SUB( NOW(), INTERVAL 14 DAY )
3071 AND b.is_current_revision = 1 AND b.is_deleted=0 AND b.status_id <> $scheduled_id
3072 AND bca.case_id = ca.case_id ORDER BY b.activity_date_time DESC LIMIT 1)";
3079 * Add/copy relationships, when new client is added for a case
3081 * @param int $caseId
3083 * @param int $contactId
3084 * Contact id / new client id.
3086 public static function addCaseRelationships($caseId, $contactId) {
3087 // get the case role / relationships for the case
3088 $caseRelationships = new CRM_Contact_DAO_Relationship();
3089 $caseRelationships->case_id
= $caseId;
3090 $caseRelationships->find();
3091 $relationshipTypes = array();
3093 // make sure we don't add duplicate relationships of same relationship type.
3094 while ($caseRelationships->fetch() && !in_array($caseRelationships->relationship_type_id
, $relationshipTypes)) {
3096 CRM_Core_DAO
::storeValues($caseRelationships, $values);
3098 // add relationship for new client.
3099 $newRelationship = new CRM_Contact_DAO_Relationship();
3100 $newRelationship->copyValues($values);
3101 $newRelationship->id
= NULL;
3102 $newRelationship->case_id
= $caseId;
3103 $newRelationship->contact_id_a
= $contactId;
3104 $newRelationship->end_date
= CRM_Utils_Date
::isoToMysql($caseRelationships->end_date
);
3105 $newRelationship->start_date
= CRM_Utils_Date
::isoToMysql($caseRelationships->start_date
);
3107 // another check to avoid duplicate relationship, in cases where client is removed and re-added again.
3108 if (!$newRelationship->find(TRUE)) {
3109 $newRelationship->save();
3112 // store relationship type of newly created relationship
3113 $relationshipTypes[] = $caseRelationships->relationship_type_id
;
3118 * Get the list of clients for a case.
3120 * @param int $caseId
3123 * associated array with client ids
3125 public static function getCaseClients($caseId) {
3127 $caseContact = new CRM_Case_DAO_CaseContact();
3128 $caseContact->case_id
= $caseId;
3129 $caseContact->orderBy('id');
3130 $caseContact->find();
3132 while ($caseContact->fetch()) {
3133 $clients[] = $caseContact->contact_id
;
3140 * @param int $caseId
3141 * @param string $direction
3143 * @param int $relTypeId
3144 * @throws \CRM_Core_Exception
3145 * @throws \CiviCRM_API3_Exception
3147 public static function endCaseRole($caseId, $direction, $cid, $relTypeId) {
3149 if ($direction !== 'a' && $direction !== 'b') {
3150 throw new CRM_Core_Exception('Invalid relationship direction');
3153 // This case might have multiple clients, so we lookup by relationship instead of by id to get them all
3154 $sql = "SELECT id FROM civicrm_relationship WHERE case_id = %1 AND contact_id_{$direction} = %2 AND relationship_type_id = %3";
3155 $dao = CRM_Core_DAO
::executeQuery($sql, array(
3156 1 => array($caseId, 'Positive'),
3157 2 => array($cid, 'Positive'),
3158 3 => array($relTypeId, 'Positive'),
3160 while ($dao->fetch()) {
3161 civicrm_api3('relationship', 'create', array(
3164 'end_date' => 'now',
3170 * Get options for a given case field.
3171 * @see CRM_Core_DAO::buildOptions
3173 * @param string $fieldName
3174 * @param string $context
3175 * @see CRM_Core_DAO::buildOptionsContext
3176 * @param array $props
3177 * Whatever is known about this dao object.
3179 * @return array|bool
3181 public static function buildOptions($fieldName, $context = NULL, $props = array()) {
3182 $className = __CLASS__
;
3184 switch ($fieldName) {
3185 // This field is not part of this object but the api supports it
3187 $className = 'CRM_Activity_BAO_Activity';
3190 // Filter status id by case type id
3192 if (!empty($props['case_type_id'])) {
3193 $idField = is_numeric($props['case_type_id']) ?
'id' : 'name';
3194 $caseType = civicrm_api3('CaseType', 'getsingle', array($idField => $props['case_type_id'], 'return' => 'definition'));
3195 if (!empty($caseType['definition']['statuses'])) {
3196 $params['condition'] = 'v.name IN ("' . implode('","', $caseType['definition']['statuses']) . '")';
3201 return CRM_Core_PseudoConstant
::get($className, $fieldName, $params, $context);
3207 public function addSelectWhereClause() {
3208 // We always return an array with these keys, even if they are empty,
3209 // because this tells the query builder that we have considered these fields for acls
3212 // Only case admins can view deleted cases
3213 'is_deleted' => CRM_Core_Permission
::check('administer CiviCase') ?
array() : array("= 0"),
3215 // Ensure the user has permission to view the case client
3216 $contactClause = CRM_Utils_SQL
::mergeSubquery('Contact');
3217 if ($contactClause) {
3218 $contactClause = implode(' AND contact_id ', $contactClause);
3219 $clauses['id'][] = "IN (SELECT case_id FROM civicrm_case_contact WHERE contact_id $contactClause)";
3221 // The api gatekeeper ensures the user has at least "access my cases and activities"
3222 // so if they do not have permission to see all cases we'll assume they can only access their own
3223 if (!CRM_Core_Permission
::check('access all cases and activities')) {
3224 $user = (int) CRM_Core_Session
::getLoggedInContactID();
3225 $clauses['id'][] = "IN (
3226 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 (
3227 (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)
3231 CRM_Utils_Hook
::selectWhereClause($this, $clauses);
3236 * CRM-20308: Method to get the contact id to use as from contact for email copy
3237 * 1. Activity Added by Contact's email address
3238 * 2. System Default From Address
3239 * 3. Default Organization Contact email address
3242 * @param int $activityID
3244 * @return mixed $emailFromContactId
3245 * @see https://issues.civicrm.org/jira/browse/CRM-20308
3247 public static function getReceiptFrom($activityID) {
3248 $name = $address = NULL;
3250 if (!empty($activityID) && (Civi
::settings()->get('allow_mail_from_logged_in_contact'))) {
3251 // This breaks SPF/DMARC if email is sent from an email address that the server is not authorised to send from.
3252 // so we can disable this behaviour with the "allow_mail_from_logged_in_contact" setting.
3253 // There is always a 'Added by' contact for a activity,
3254 // so we can safely use ActivityContact.Getvalue API
3255 $sourceContactId = civicrm_api3('ActivityContact', 'getvalue', array(
3256 'activity_id' => $activityID,
3257 'record_type_id' => 'Activity Source',
3258 'return' => 'contact_id',
3260 list($name, $address) = CRM_Contact_BAO_Contact_Location
::getEmailDetails($sourceContactId);
3263 // If 'From' email address not found for Source Activity Contact then
3264 // fetch the email from domain or logged in user.
3265 if (empty($address)) {
3266 list($name, $address) = CRM_Core_BAO_Domain
::getDefaultReceiptFrom();
3269 return "$name <$address>";
3275 public static function getEntityRefFilters() {
3278 'key' => 'case_id.case_type_id',
3279 'value' => ts('Case Type'),
3283 'key' => 'case_id.status_id',
3284 'value' => ts('Case Status'),
3288 foreach (CRM_Contact_BAO_Contact
::getEntityRefFilters() as $filter) {
3289 $filter +
= ['entity' => 'Contact'];
3290 $filter['key'] = 'contact_id.' . $filter['key'];
3291 $filters[] = $filter;