Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Add CiviCase option for showing case activities in normal views #16360

Merged
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
122 changes: 96 additions & 26 deletions CRM/Activity/BAO/Activity.php
Original file line number Diff line number Diff line change
Expand Up @@ -697,6 +697,9 @@ public static function getActivities($params) {
'case_id',
'campaign_id',
];
// Q. What does the code below achieve? case_id and campaign_id are already
// in the array, defined above, and this code adds them in again if their
// component is enabled? @fixme remove case_id and campaign_id from the array above?
foreach (['case_id' => 'CiviCase', 'campaign_id' => 'CiviCampaign'] as $attr => $component) {
if (in_array($component, self::activityComponents())) {
$activityParams['return'][] = $attr;
Expand Down Expand Up @@ -780,6 +783,7 @@ public static function getActivities($params) {

// Eventually this second iteration should just handle the target contacts. It's a bit muddled at
// the moment as the bulk activity stuff needs unravelling & test coverage.
$caseIds = [];
foreach ($result as $id => $activity) {
$isBulkActivity = (!$bulkActivityTypeID || ($bulkActivityTypeID === $activity['activity_type_id']));
foreach ($mappingParams as $apiKey => $expectedName) {
Expand All @@ -804,10 +808,9 @@ public static function getActivities($params) {

// fetch case subject for case ID found
if (!empty($activity['case_id'])) {
$activities[$id]['case_subject'] = civicrm_api3('Case', 'getvalue', [
'return' => 'subject',
'id' => reset($activity['case_id']),
]);
// Store cases; we'll look them up in one query below. We convert
// to int here so we can trust it for SQL.
$caseIds[$id] = (int) current($activity['case_id']);
}
}
else {
Expand All @@ -827,6 +830,15 @@ public static function getActivities($params) {
$activities[$id]['is_recurring_activity'] = CRM_Core_BAO_RecurringEntity::getParentFor($id, 'civicrm_activity');
}

// Look up any case subjects we need in a single query and add them in the relevant activities under 'case_subject'
if ($caseIds) {
$subjects = CRM_Core_DAO::executeQuery('SELECT id, subject FROM civicrm_case WHERE id IN (' . implode(',', array_unique($caseIds)) . ')')
->fetchMap('id', 'subject');
foreach ($caseIds as $activityId => $caseId) {
$result[$activityId]['case_subject'] = $subjects[$caseId];
}
}

return $activities;
}

Expand Down Expand Up @@ -2526,6 +2538,9 @@ public static function getContactActivitySelector(&$params) {
// Format params and add links.
$contactActivities = [];

// View-only activity types
$viewOnlyCaseActivityTypeIDs = array_flip(CRM_Activity_BAO_Activity::getViewOnlyActivityTypeIDs());

if (!empty($activities)) {
$activityStatus = CRM_Core_PseudoConstant::activityStatus();

Expand All @@ -2538,6 +2553,7 @@ public static function getContactActivitySelector(&$params) {
}

$mask = CRM_Core_Action::mask($permissions);
$userID = CRM_Core_Session::getLoggedInContactID();

foreach ($activities as $activityId => $values) {
$activity = ['source_contact_name' => '', 'target_contact_name' => ''];
Expand Down Expand Up @@ -2663,29 +2679,83 @@ public static function getContactActivitySelector(&$params) {
$accessMailingReport = TRUE;
}

$actionLinks = CRM_Activity_Selector_Activity::actionLinks(
CRM_Utils_Array::value('activity_type_id', $values),
CRM_Utils_Array::value('source_record_id', $values),
$accessMailingReport,
CRM_Utils_Array::value('activity_id', $values)
);
// Get action links.

// If this is a case activity, then we hand off to Case's actionLinks instead.
if (!empty($values['case_id']) && Civi::settings()->get('civicaseShowCaseActivities')) {
// This activity belongs to a case.
$caseId = current($values['case_id']);

$activity['subject'] = $values['subject'];

// Get the view and edit (update) links:
$caseActionLinks =
$actionLinks = array_intersect_key(
CRM_Case_Selector_Search::actionLinks(),
array_fill_keys([CRM_Core_Action::VIEW, CRM_Core_Action::UPDATE], NULL));

// Create a Manage Case link (using ADVANCED as can't use two VIEW ones)
$actionLinks[CRM_Core_Action::ADVANCED] = [
"name" => 'Manage Case',
"url" => 'civicrm/contact/view/case',
'qs' => 'reset=1&id=%%caseid%%&cid=%%cid%%&action=view&context=&selectedChild=case',
"title" => ts('Manage Case %1', [1 => $caseId]),
'class' => 'no-popup',
];

$caseLinkValues = [
'aid' => $activityId,
'caseid' => $caseId,
'cid' => current(CRM_Case_BAO_Case::getCaseClients($caseId) ?? []),
// Unlike other 'context' params, this 'ctx' param is appended raw to the URL.
'cxt' => '',
];

$caseActivityPermissions = CRM_Core_Action::VIEW | CRM_Core_Action::ADVANCED;
// Allow Edit link if:
// 1. Activity type is NOT view-only type. CRM-5871
// 2. User has edit permission.
if (!isset($viewOnlyCaseActivityTypeIDs[$values['activity_type_id']])
&& CRM_Case_BAO_Case::checkPermission($activityId, 'edit', $values['activity_type_id'], $userID)) {
// We're allowed to edit.
$caseActivityPermissions |= CRM_Core_Action::UPDATE;
}

$actionMask = array_sum(array_keys($actionLinks)) & $mask;

$activity['links'] = CRM_Core_Action::formLink($actionLinks,
$actionMask,
[
'id' => $values['activity_id'],
'cid' => $params['contact_id'],
'cxt' => $context,
'caseid' => CRM_Utils_Array::value('case_id', $values),
],
ts('more'),
FALSE,
'activity.tab.row',
'Activity',
$values['activity_id']
);
$activity['links'] = CRM_Core_Action::formLink($actionLinks,
$caseActivityPermissions,
$caseLinkValues,
ts('more'),
FALSE,
'activity.tab.row',
'Activity',
$values['activity_id']
);
}
else {
// Non-case activity
$actionLinks = CRM_Activity_Selector_Activity::actionLinks(
CRM_Utils_Array::value('activity_type_id', $values),
CRM_Utils_Array::value('source_record_id', $values),
$accessMailingReport,
CRM_Utils_Array::value('activity_id', $values)
);
$actionMask = array_sum(array_keys($actionLinks)) & $mask;

$activity['links'] = CRM_Core_Action::formLink($actionLinks,
$actionMask,
[
'id' => $values['activity_id'],
'cid' => $params['contact_id'],
'cxt' => $context,
'caseid' => NULL,
],
ts('more'),
FALSE,
'activity.tab.row',
'Activity',
$values['activity_id']
);
}

if ($values['is_recurring_activity']) {
$activity['is_recurring_activity'] = CRM_Core_BAO_RecurringEntity::getPositionAndCount($values['activity_id'], 'civicrm_activity');
Expand Down
2 changes: 1 addition & 1 deletion CRM/Activity/Selector/Activity.php
Original file line number Diff line number Diff line change
Expand Up @@ -459,7 +459,7 @@ public function &getRows($action, $offset, $rowCount, $sort, $output = NULL, $ca
'id' => $row['activity_id'],
'cid' => $this->_contactId,
'cxt' => $this->_context,
'caseid' => CRM_Utils_Array::value('case_id', $row),
'caseid' => isset($row['case_id']) ? current($row['case_id']) : NULL,
],
ts('more'),
FALSE,
Expand Down
1 change: 1 addition & 0 deletions CRM/Admin/Form/Setting/Case.php
Original file line number Diff line number Diff line change
Expand Up @@ -25,6 +25,7 @@ class CRM_Admin_Form_Setting_Case extends CRM_Admin_Form_Setting {
'civicaseAllowMultipleClients' => CRM_Core_BAO_Setting::SYSTEM_PREFERENCES_NAME,
'civicaseNaturalActivityTypeSort' => CRM_Core_BAO_Setting::SYSTEM_PREFERENCES_NAME,
'civicaseActivityRevisions' => CRM_Core_BAO_Setting::SYSTEM_PREFERENCES_NAME,
'civicaseShowCaseActivities' => CRM_Core_BAO_Setting::SYSTEM_PREFERENCES_NAME,
];

/**
Expand Down
3 changes: 2 additions & 1 deletion CRM/Case/BAO/Case.php
Original file line number Diff line number Diff line change
Expand Up @@ -15,6 +15,7 @@
* @copyright CiviCRM LLC https://civicrm.org/licensing
*/


/**
* This class contains the functions for Case Management.
*/
Expand Down Expand Up @@ -284,7 +285,7 @@ public static function retrieveContactIdsByCaseId($caseId, $contactID = NULL, $s
*
* @param int $activityId
*
* @return int, case ID
* @return int|null, case ID
*/
public static function getCaseIdByActivityId($activityId) {
$originalId = CRM_Core_DAO::singleValueQuery(
Expand Down
2 changes: 1 addition & 1 deletion CRM/Case/Info.php
Original file line number Diff line number Diff line change
Expand Up @@ -36,7 +36,7 @@ public function getInfo() {
'translatedName' => ts('CiviCase'),
'title' => ts('CiviCase Engine'),
'search' => 1,
'showActivitiesInCore' => 0,
'showActivitiesInCore' => Civi::settings()->get('civicaseShowCaseActivities') ?? 0,
artfulrobot marked this conversation as resolved.
Show resolved Hide resolved
];
}

Expand Down
15 changes: 15 additions & 0 deletions settings/Case.setting.php
Original file line number Diff line number Diff line change
Expand Up @@ -99,4 +99,19 @@
'description' => ts('Enable tracking of activity revisions embedded within the "civicrm_activity" table. Alternatively, see "Administer => System Settings => Misc => Logging".'),
'help_text' => '',
],
'civicaseShowCaseActivities' => [
'group_name' => 'CiviCRM Preferences',
'group' => 'core',
'name' => 'civicaseShowCaseActivities',
'type' => 'Boolean',
'quick_form_type' => 'YesNo',
'default' => FALSE,
'html_type' => 'radio',
'add' => '5.24',
'title' => ts('Include case activities in general activity views.'),
'is_domain' => 1,
'is_contact' => 0,
'description' => ts('e.g. the Contact form\'s Activity tab listing. Without this ticked, activities that belong to a case are hidden (default behavior). Warning: enabling this option means that all case activities relating to a contact will be listed which could result in users without "access all cases and activities" permission being able to see see the summarized details (date, subject, assignees, status etc.). Such users will still be prevented from managing the case and viewing/editing the activity.'),
'help_text' => '',
],
];
6 changes: 6 additions & 0 deletions templates/CRM/Admin/Form/Setting/Case.tpl
Original file line number Diff line number Diff line change
Expand Up @@ -37,6 +37,12 @@
<span class="description">{ts}Enable embedded tracking to activity revisions within the "civicrm_activity" table. Alternatively, see "Administer => System Settings => Misc => Logging".{/ts}</span>
</td>
</tr>
<tr class="crm-case-form-block-civicaseShowCaseActivities">
<td class="label">{$form.civicaseShowCaseActivities.label}</td>
<td>{$form.civicaseShowCaseActivities.html}<br />
<span class="description">{$civicaseShowCaseActivities_description}</span>
</td>
</tr>
</table>
<div class="crm-submit-buttons">{include file="CRM/common/formButtons.tpl" location="bottom"}</div>
</div>
Loading