3 +--------------------------------------------------------------------+
4 | Copyright CiviCRM LLC. All rights reserved. |
6 | This work is published under the GNU AGPLv3 license with some |
7 | permitted exceptions and without any warranty. For full license |
8 | and copyright information, see https://civicrm.org/licensing |
9 +--------------------------------------------------------------------+
15 * @copyright CiviCRM LLC https://civicrm.org/licensing
17 class CRM_Logging_ReportDetail
extends CRM_Report_Form
{
19 const ROW_COUNT_LIMIT
= 50;
25 * This would be set if we are viewing a merge of 2 contacts.
31 protected $log_conn_id;
34 protected $tables = [];
35 protected $interval = '10 SECOND';
37 protected $altered_name;
38 protected $altered_by;
39 protected $altered_by_id;
42 * detail/summary report ids
51 * @var CRM_Logging_Differ
56 * Array of changes made.
60 protected $diffs = [];
63 * Don't display the Add these contacts to Group button.
67 protected $_add2groupSupported = FALSE;
72 public function __construct() {
76 $this->parsePropertiesFromUrl();
78 parent
::__construct();
80 CRM_Utils_System
::resetBreadCrumb();
83 'title' => ts('Home'),
84 'url' => CRM_Utils_System
::url(),
87 'title' => ts('CiviCRM'),
88 'url' => CRM_Utils_System
::url('civicrm', 'reset=1'),
91 'title' => ts('View Contact'),
92 'url' => CRM_Utils_System
::url('civicrm/contact/view', "reset=1&cid={$this->cid}"),
95 'title' => ts('Search Results'),
96 'url' => CRM_Utils_System
::url('civicrm/contact/search', "force=1"),
99 CRM_Utils_System
::appendBreadCrumb($breadcrumb);
101 if (CRM_Utils_Request
::retrieve('revert', 'Boolean')) {
105 $this->_columnHeaders
= [
106 'field' => ['title' => ts('Field'), 'type' => CRM_Utils_Type
::T_STRING
],
107 'from' => ['title' => ts('Changed From'), 'type' => CRM_Utils_Type
::T_STRING
],
108 'to' => ['title' => ts('Changed To'), 'type' => CRM_Utils_Type
::T_STRING
],
113 * Build query for report.
115 * We override this to be empty & calculate the rows in the buildRows function.
117 * @param bool $applyLimit
119 public function buildQuery($applyLimit = TRUE) {
123 * Build rows from query.
128 public function buildRows($sql, &$rows) {
129 // safeguard for when there aren’t any log entries yet
130 if (!$this->log_conn_id
&& !$this->log_date
) {
134 $rows = $this->convertDiffsToRows();
138 * Get the diffs for the report, calculating them if not already done.
140 * Note that contact details report now uses a more comprehensive method but
141 * the contribution logging details report still uses this.
145 protected function getDiffs() {
146 if (empty($this->diffs
)) {
147 foreach ($this->tables
as $table) {
148 $this->diffs
= array_merge($this->diffs
, $this->diffsInTable($table));
159 protected function diffsInTable($table) {
161 return $this->differ
->diffsInTable($table, $this->cid
);
165 * Convert the diffs to row format.
169 protected function convertDiffsToRows() {
170 // return early if nothing found
171 if (empty($this->diffs
)) {
175 // populate $rows with only the differences between $changed and $original (skipping certain columns and NULL ↔ empty changes unless raw requested)
178 foreach ($this->diffs
as $diff) {
179 $table = $diff['table'];
180 if (empty($metadata[$table])) {
181 list($metadata[$table]['titles'], $metadata[$table]['values']) = $this->differ
->titlesAndValuesForTable($table, $diff['log_date']);
183 $values = CRM_Utils_Array
::value('values', $metadata[$diff['table']], []);
184 $titles = $metadata[$diff['table']]['titles'];
185 $field = $diff['field'];
186 $from = $diff['from'];
190 $field = "$table.$field";
193 if (in_array($field, $skipped)) {
196 // $differ filters out === values; for presentation hide changes like 42 → '42'
201 // special-case for multiple values. Also works for CRM-7251: preferred_communication_method
202 if ((substr($from, 0, 1) == CRM_Core_DAO
::VALUE_SEPARATOR
&&
203 substr($from, -1, 1) == CRM_Core_DAO
::VALUE_SEPARATOR
) ||
204 (substr($to, 0, 1) == CRM_Core_DAO
::VALUE_SEPARATOR
&&
205 substr($to, -1, 1) == CRM_Core_DAO
::VALUE_SEPARATOR
)
208 foreach (explode(CRM_Core_DAO
::VALUE_SEPARATOR
, trim($from, CRM_Core_DAO
::VALUE_SEPARATOR
)) as $val) {
209 $froms[] = $values[$field][$val] ??
NULL;
211 foreach (explode(CRM_Core_DAO
::VALUE_SEPARATOR
, trim($to, CRM_Core_DAO
::VALUE_SEPARATOR
)) as $val) {
212 $tos[] = $values[$field][$val] ??
NULL;
214 $from = implode(', ', array_filter($froms));
215 $to = implode(', ', array_filter($tos));
218 $tableDAOClass = CRM_Core_DAO_AllCoreTables
::getClassForTable($table);
219 if (!empty($tableDAOClass)) {
220 $tableDAOFields = (new $tableDAOClass())->fields();
221 // If this field is a foreign key, then we can later use the foreign
222 // class to translate the id into something more useful for display.
223 $fkClassName = $tableDAOFields[$field]['FKClassName'] ??
NULL;
225 if (isset($values[$field][$from])) {
226 $from = $values[$field][$from];
228 elseif (!empty($from) && !empty($fkClassName)) {
229 $from = $this->convertForeignKeyValuesToLabels($fkClassName, $field, $from);
231 if (isset($values[$field][$to])) {
232 $to = $values[$field][$to];
234 elseif (!empty($to) && !empty($fkClassName)) {
235 $to = $this->convertForeignKeyValuesToLabels($fkClassName, $field, $to);
237 if (isset($titles[$field])) {
238 $field = $titles[$field];
240 if ($diff['action'] == 'Insert') {
243 if ($diff['action'] == 'Delete') {
247 // Rework the results to provide grouping based on the ID
248 // We don't need that field displayed so we will output empty
249 if ($field == 'Modified Date') {
250 $nRows[$diff['id']][] = ['field' => '', 'from' => $from, 'to' => $to];
253 $nRows[$diff['id']][] = ['field' => $field . " (id: {$diff['id']})", 'from' => $from, 'to' => $to];
256 // Transform the output so that we can compact the changes into the proper amount of rows IF trData is holding more than 1 array
257 foreach ($nRows as $trData) {
258 if (count($trData) > 1) {
259 $keys = array_intersect(...array_map('array_keys', $trData));
260 $mergedRes = array_combine($keys, array_map(function ($key) use ($trData) {
261 // If more than 1 entry is found, we are assigning them as subarrays, then the tpls will be responsible for concatenating the results
262 return array_column($trData, $key);
264 $rows[] = $mergedRes;
267 // We always need the first row of that array
268 $rows[] = $trData[0];
275 public function buildQuickForm() {
276 parent
::buildQuickForm();
278 $this->assign('whom_url', CRM_Utils_System
::url('civicrm/contact/view', "reset=1&cid={$this->cid}"));
279 $this->assign('who_url', CRM_Utils_System
::url('civicrm/contact/view', "reset=1&cid={$this->altered_by_id}"));
280 $this->assign('whom_name', $this->altered_name
);
281 $this->assign('who_name', $this->altered_by
);
283 $this->assign('log_date', CRM_Utils_Date
::mysqlToIso($this->log_date
));
285 $q = "reset=1&log_conn_id={$this->log_conn_id}&log_date={$this->log_date}";
287 $q .= '&oid=' . $this->oid
;
289 $this->assign('revertURL', CRM_Report_Utils_Report
::getNextUrl($this->detail
, "$q&revert=1", FALSE, TRUE));
290 $this->assign('revertConfirm', ts('Are you sure you want to revert all changes?'));
291 $this->assign('sections', []);
295 * Store the dsn for the logging database in $this->db.
297 protected function storeDB() {
298 $dsn = defined('CIVICRM_LOGGING_DSN') ? CRM_Utils_SQL
::autoSwitchDSN(CIVICRM_LOGGING_DSN
) : CRM_Utils_SQL
::autoSwitchDSN(CIVICRM_DSN
);
299 $dsn = DB
::parseDSN($dsn);
300 $this->db
= $dsn['database'];
304 * Calculate all the contact related diffs for the change.
306 protected function calculateContactDiffs() {
307 $this->_rowsFound
= $this->getCountOfAllContactChangesForConnection();
308 // Apply some limits before asking for all contact changes
310 $this->diffs
= $this->getAllContactChangesForConnection();
314 * Get an array of changes made in the mysql connection.
318 public function getAllContactChangesForConnection() {
319 if (empty($this->log_conn_id
)) {
324 return $this->differ
->getAllChangesForConnection($this->tables
, $this->dblimit
, $this->dboffset
);
326 catch (CRM_Core_Exception
$e) {
327 CRM_Core_Error
::statusBounce($e->getMessage());
332 * Get an count of contacts with changes.
336 public function getCountOfAllContactChangesForConnection() {
337 if (empty($this->log_conn_id
)) {
342 return $this->differ
->getCountOfAllContactChangesForConnection($this->tables
);
344 catch (CRM_Core_Exception
$e) {
345 CRM_Core_Error
::statusBounce($e->getMessage());
350 * Make sure the differ is defined.
352 protected function setDiffer() {
353 if (empty($this->differ
)) {
354 $this->differ
= new CRM_Logging_Differ($this->log_conn_id
, $this->log_date
, $this->interval
);
359 * Set this tables to reflect tables changed in a merge.
361 protected function setTablesToContactRelatedTables() {
362 $schema = new CRM_Logging_Schema();
363 $this->tables
= $schema->getLogTablesForContact();
364 // allow tables to be extended by report hook query objects.
365 // This is a report specific hook. It's unclear how it interacts to / overlaps the main one.
366 // It probably precedes the main one and was never reconciled with it....
367 CRM_Report_BAO_Hook
::singleton()->alterLogTables($this, $this->tables
);
371 * Revert the changes defined by the parameters.
373 protected function revert() {
374 $reverter = new CRM_Logging_Reverter($this->log_conn_id
, $this->log_date
);
375 $reverter->calculateDiffsFromLogConnAndDate($this->tables
);
377 CRM_Core_Session
::setStatus(ts('The changes have been reverted.'), ts('Reverted'), 'success');
380 CRM_Utils_System
::redirect(CRM_Utils_System
::url(
381 'civicrm/contact/merge',
382 "reset=1&cid={$this->cid}&oid={$this->oid}",
389 CRM_Utils_System
::redirect(CRM_Utils_System
::url('civicrm/contact/view', "reset=1&selectedChild=log&cid={$this->cid}", FALSE, NULL, FALSE));
393 CRM_Utils_System
::redirect(CRM_Report_Utils_Report
::getNextUrl($this->summary
, 'reset=1', FALSE, TRUE));
398 * Get the properties that might be in the URL.
400 protected function parsePropertiesFromUrl() {
401 $this->log_conn_id
= CRM_Utils_Request
::retrieve('log_conn_id', 'String');
402 $this->log_date
= CRM_Utils_Request
::retrieve('log_date', 'String');
403 $this->cid
= CRM_Utils_Request
::retrieve('cid', 'Integer');
404 $this->raw
= CRM_Utils_Request
::retrieve('raw', 'Boolean');
406 $this->altered_name
= CRM_Utils_Request
::retrieve('alteredName', 'String');
407 $this->altered_by
= CRM_Utils_Request
::retrieve('alteredBy', 'String');
408 $this->altered_by_id
= CRM_Utils_Request
::retrieve('alteredById', 'Integer');
409 $this->layout
= CRM_Utils_Request
::retrieve('layout', 'String');
413 * Override to set limit
414 * @param int $rowCount
416 public function limit($rowCount = self
::ROW_COUNT_LIMIT
) {
417 parent
::limit($rowCount);
421 * Override to set pager with limit
422 * @param int $rowCount
424 public function setPager($rowCount = self
::ROW_COUNT_LIMIT
) {
425 // We should not be rendering the pager in overlay mode
426 if (!isset($this->layout
)) {
427 $this->_dashBoardRowCount
= $rowCount;
428 $this->_limit
= TRUE;
429 parent
::setPager($rowCount);
434 * This is a function similar to limit, in fact we copied it as-is and removed
435 * some `set` statements
438 public function getLimit($rowCount = self
::ROW_COUNT_LIMIT
) {
439 if ($this->addPaging
) {
441 $pageId = CRM_Utils_Request
::retrieve('crmPID', 'Integer');
443 // @todo all http vars should be extracted in the preProcess
444 // - not randomly in the class
445 if (!$pageId && !empty($_POST)) {
446 if (isset($_POST['PagerBottomButton']) && isset($_POST['crmPID_B'])) {
447 $pageId = max((int) $_POST['crmPID_B'], 1);
449 elseif (isset($_POST['PagerTopButton']) && isset($_POST['crmPID'])) {
450 $pageId = max((int) $_POST['crmPID'], 1);
452 unset($_POST['crmPID_B'], $_POST['crmPID']);
455 $pageId = $pageId ?
$pageId : 1;
456 $offset = ($pageId - 1) * $rowCount;
458 $offset = CRM_Utils_Type
::escape($offset, 'Int');
459 $rowCount = CRM_Utils_Type
::escape($rowCount, 'Int');
460 $this->_limit
= " LIMIT $offset, $rowCount";
461 $this->dblimit
= $rowCount;
462 $this->dboffset
= $offset;
467 * Given a key value that we know is a foreign key to another table, return
468 * what the DAO thinks is the "label" for the foreign entity. For example
469 * if it's referencing a contact then return the contact name, or if it's an
470 * activity then return the activity subject.
471 * If it's the type of DAO that doesn't have such a thing, just echo back
472 * what we were given.
474 * @param string $fkClassName
475 * @param string $field
479 private function convertForeignKeyValuesToLabels(string $fkClassName, string $field, int $keyval): string {
480 if (property_exists($fkClassName, '_labelField')) {
481 $labelValue = CRM_Core_DAO
::getFieldValue($fkClassName, $keyval, $fkClassName::$_labelField);
482 // Not sure if this should use ts - there's not a lot of context (`%1 (id: %2)`) - and also the similar field labels above don't use ts.
483 return "{$labelValue} (id: {$keyval})";
485 return (string) $keyval;