CRM/Logging/ReportDetail.php

   1 <?php
   2 /*
   3  +--------------------------------------------------------------------+
   4  | Copyright CiviCRM LLC. All rights reserved.                        |
   5  |                                                                    |
   6  | This work is published under the GNU AGPLv3 license with some      |
   7  | permitted exceptions and without any warranty. For full license    |
   8  | and copyright information, see https://civicrm.org/licensing       |
   9  +--------------------------------------------------------------------+
  10  */
  11
  12 /**
  13  *
  14  * @package CRM
  15  * @copyright CiviCRM LLC https://civicrm.org/licensing
  16  */
  17 class CRM_Logging_ReportDetail extends CRM_Report_Form {
  18
  19   const ROW_COUNT_LIMIT = 50;
  20   protected $cid;
  21
  22   /**
  23    * Other contact ID.
  24    *
  25    * This would be set if we are viewing a merge of 2 contacts.
  26    *
  27    * @var int
  28    */
  29   protected $oid;
  30   protected $db;
  31   protected $log_conn_id;
  32   protected $log_date;
  33   protected $raw;
  34   protected $tables = [];
  35   protected $interval = '10 SECOND';
  36
  37   protected $altered_name;
  38   protected $altered_by;
  39   protected $altered_by_id;
  40
  41   /**
  42    * detail/summary report ids
  43    * @var int
  44    */
  45   protected $detail;
  46   protected $summary;
  47
  48   /**
  49    * Instance of Differ.
  50    *
  51    * @var CRM_Logging_Differ
  52    */
  53   protected $differ;
  54
  55   /**
  56    * Array of changes made.
  57    *
  58    * @var array
  59    */
  60   protected $diffs = [];
  61
  62   /**
  63    * Don't display the Add these contacts to Group button.
  64    *
  65    * @var bool
  66    */
  67   protected $_add2groupSupported = FALSE;
  68
  69   /**
  70    * Class constructor.
  71    */
  72   public function __construct() {
  73
  74     $this->storeDB();
  75
  76     $this->parsePropertiesFromUrl();
  77
  78     parent::__construct();
  79
  80     CRM_Utils_System::resetBreadCrumb();
  81     $breadcrumb = [
  82       [
  83         'title' => ts('Home'),
  84         'url' => CRM_Utils_System::url(),
  85       ],
  86       [
  87         'title' => ts('CiviCRM'),
  88         'url' => CRM_Utils_System::url('civicrm', 'reset=1'),
  89       ],
  90       [
  91         'title' => ts('View Contact'),
  92         'url' => CRM_Utils_System::url('civicrm/contact/view', "reset=1&cid={$this->cid}"),
  93       ],
  94       [
  95         'title' => ts('Search Results'),
  96         'url' => CRM_Utils_System::url('civicrm/contact/search', "force=1"),
  97       ],
  98     ];
  99     CRM_Utils_System::appendBreadCrumb($breadcrumb);
 100
 101     if (CRM_Utils_Request::retrieve('revert', 'Boolean')) {
 102       $this->revert();
 103     }
 104
 105     $this->_columnHeaders = [
 106       'field' => ['title' => ts('Field')],
 107       'from' => ['title' => ts('Changed From')],
 108       'to' => ['title' => ts('Changed To')],
 109     ];
 110   }
 111
 112   /**
 113    * Build query for report.
 114    *
 115    * We override this to be empty & calculate the rows in the buildRows function.
 116    *
 117    * @param bool $applyLimit
 118    */
 119   public function buildQuery($applyLimit = TRUE) {
 120   }
 121
 122   /**
 123    * Build rows from query.
 124    *
 125    * @param string $sql
 126    * @param array $rows
 127    */
 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) {
 131       return;
 132     }
 133     $this->getDiffs();
 134     $rows = $this->convertDiffsToRows();
 135   }
 136
 137   /**
 138    * Get the diffs for the report, calculating them if not already done.
 139    *
 140    * Note that contact details report now uses a more comprehensive method but
 141    * the contribution logging details report still uses this.
 142    *
 143    * @return array
 144    */
 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));
 149       }
 150     }
 151     return $this->diffs;
 152   }
 153
 154   /**
 155    * @param $table
 156    *
 157    * @return array
 158    */
 159   protected function diffsInTable($table) {
 160     $this->setDiffer();
 161     return $this->differ->diffsInTable($table, $this->cid);
 162   }
 163
 164   /**
 165    * Convert the diffs to row format.
 166    *
 167    * @return array
 168    */
 169   protected function convertDiffsToRows() {
 170     // return early if nothing found
 171     if (empty($this->diffs)) {
 172       return [];
 173     }
 174
 175     // populate $rows with only the differences between $changed and $original (skipping certain columns and NULL ↔ empty changes unless raw requested)
 176     $skipped = ['id'];
 177     $nRows = $rows = [];
 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']);
 182       }
 183       $values = CRM_Utils_Array::value('values', $metadata[$diff['table']], []);
 184       $titles = $metadata[$diff['table']]['titles'];
 185       $field = $diff['field'];
 186       $from = $diff['from'];
 187       $to = $diff['to'];
 188
 189       if ($this->raw) {
 190         $field = "$table.$field";
 191       }
 192       else {
 193         if (in_array($field, $skipped)) {
 194           continue;
 195         }
 196         // $differ filters out === values; for presentation hide changes like 42 → '42'
 197         if ($from == $to) {
 198           continue;
 199         }
 200
 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)
 206         ) {
 207           $froms = $tos = [];
 208           foreach (explode(CRM_Core_DAO::VALUE_SEPARATOR, trim($from, CRM_Core_DAO::VALUE_SEPARATOR)) as $val) {
 209             $froms[] = $values[$field][$val] ?? NULL;
 210           }
 211           foreach (explode(CRM_Core_DAO::VALUE_SEPARATOR, trim($to, CRM_Core_DAO::VALUE_SEPARATOR)) as $val) {
 212             $tos[] = $values[$field][$val] ?? NULL;
 213           }
 214           $from = implode(', ', array_filter($froms));
 215           $to = implode(', ', array_filter($tos));
 216         }
 217
 218         if (isset($values[$field][$from])) {
 219           $from = $values[$field][$from];
 220         }
 221         if (isset($values[$field][$to])) {
 222           $to = $values[$field][$to];
 223         }
 224         if (isset($titles[$field])) {
 225           $field = $titles[$field];
 226         }
 227         if ($diff['action'] == 'Insert') {
 228           $from = '';
 229         }
 230         if ($diff['action'] == 'Delete') {
 231           $to = '';
 232         }
 233       }
 234       // Rework the results to provide grouping based on the ID
 235       // We don't need that field displayed so we will output empty
 236       if ($field == 'Modified Date') {
 237         $nRows[$diff['id']][] = ['field' => '', 'from' => $from, 'to' => $to];
 238       }
 239       else {
 240         $nRows[$diff['id']][] = ['field' => $field . " (id: {$diff['id']})", 'from' => $from, 'to' => $to];
 241       }
 242     }
 243     // Transform the output so that we can compact the changes into the proper amount of rows IF trData is holding more than 1 array
 244     foreach ($nRows as $trData) {
 245       if (count($trData) > 1) {
 246         $keys = array_intersect(...array_map('array_keys', $trData));
 247         $mergedRes = array_combine($keys, array_map(function ($key) use ($trData) {
 248           // If more than 1 entry is found, we are assigning them as subarrays, then the tpls will be responsible for concatenating the results
 249           return array_column($trData, $key);
 250         }, $keys));
 251         $rows[] = $mergedRes;
 252       }
 253       else {
 254         // We always need the first row of that array
 255         $rows[] = $trData[0];
 256       }
 257
 258     }
 259     return $rows;
 260   }
 261
 262   public function buildQuickForm() {
 263     parent::buildQuickForm();
 264
 265     $this->assign('whom_url', CRM_Utils_System::url('civicrm/contact/view', "reset=1&cid={$this->cid}"));
 266     $this->assign('who_url', CRM_Utils_System::url('civicrm/contact/view', "reset=1&cid={$this->altered_by_id}"));
 267     $this->assign('whom_name', $this->altered_name);
 268     $this->assign('who_name', $this->altered_by);
 269
 270     $this->assign('log_date', CRM_Utils_Date::mysqlToIso($this->log_date));
 271
 272     $q = "reset=1&log_conn_id={$this->log_conn_id}&log_date={$this->log_date}";
 273     if ($this->oid) {
 274       $q .= '&oid=' . $this->oid;
 275     }
 276     $this->assign('revertURL', CRM_Report_Utils_Report::getNextUrl($this->detail, "$q&revert=1", FALSE, TRUE));
 277     $this->assign('revertConfirm', ts('Are you sure you want to revert all changes?'));
 278   }
 279
 280   /**
 281    * Store the dsn for the logging database in $this->db.
 282    */
 283   protected function storeDB() {
 284     $dsn = defined('CIVICRM_LOGGING_DSN') ? CRM_Utils_SQL::autoSwitchDSN(CIVICRM_LOGGING_DSN) : CRM_Utils_SQL::autoSwitchDSN(CIVICRM_DSN);
 285     $dsn = DB::parseDSN($dsn);
 286     $this->db = $dsn['database'];
 287   }
 288
 289   /**
 290    * Calculate all the contact related diffs for the change.
 291    */
 292   protected function calculateContactDiffs() {
 293     $this->_rowsFound = $this->getCountOfAllContactChangesForConnection();
 294     // Apply some limits before asking for all contact changes
 295     $this->getLimit();
 296     $this->diffs = $this->getAllContactChangesForConnection();
 297   }
 298
 299   /**
 300    * Get an array of changes made in the mysql connection.
 301    *
 302    * @return mixed
 303    */
 304   public function getAllContactChangesForConnection() {
 305     if (empty($this->log_conn_id)) {
 306       return [];
 307     }
 308     $this->setDiffer();
 309     try {
 310       return $this->differ->getAllChangesForConnection($this->tables, $this->dblimit, $this->dboffset);
 311     }
 312     catch (CRM_Core_Exception $e) {
 313       CRM_Core_Error::statusBounce($e->getMessage());
 314     }
 315   }
 316
 317   /**
 318    * Get an count of contacts with changes.
 319    *
 320    * @return mixed
 321    */
 322   public function getCountOfAllContactChangesForConnection() {
 323     if (empty($this->log_conn_id)) {
 324       return [];
 325     }
 326     $this->setDiffer();
 327     try {
 328       return $this->differ->getCountOfAllContactChangesForConnection($this->tables);
 329     }
 330     catch (CRM_Core_Exception $e) {
 331       CRM_Core_Error::statusBounce($e->getMessage());
 332     }
 333   }
 334
 335   /**
 336    * Make sure the differ is defined.
 337    */
 338   protected function setDiffer() {
 339     if (empty($this->differ)) {
 340       $this->differ = new CRM_Logging_Differ($this->log_conn_id, $this->log_date, $this->interval);
 341     }
 342   }
 343
 344   /**
 345    * Set this tables to reflect tables changed in a merge.
 346    */
 347   protected function setTablesToContactRelatedTables() {
 348     $schema = new CRM_Logging_Schema();
 349     $this->tables = $schema->getLogTablesForContact();
 350     // allow tables to be extended by report hook query objects.
 351     // This is a report specific hook. It's unclear how it interacts to / overlaps the main one.
 352     // It probably precedes the main one and was never reconciled with it....
 353     CRM_Report_BAO_Hook::singleton()->alterLogTables($this, $this->tables);
 354   }
 355
 356   /**
 357    * Revert the changes defined by the parameters.
 358    */
 359   protected function revert() {
 360     $reverter = new CRM_Logging_Reverter($this->log_conn_id, $this->log_date);
 361     $reverter->calculateDiffsFromLogConnAndDate($this->tables);
 362     $reverter->revert();
 363     CRM_Core_Session::setStatus(ts('The changes have been reverted.'), ts('Reverted'), 'success');
 364     if ($this->cid) {
 365       if ($this->oid) {
 366         CRM_Utils_System::redirect(CRM_Utils_System::url(
 367           'civicrm/contact/merge',
 368           "reset=1&cid={$this->cid}&oid={$this->oid}",
 369           FALSE,
 370           NULL,
 371           FALSE)
 372         );
 373       }
 374       else {
 375         CRM_Utils_System::redirect(CRM_Utils_System::url('civicrm/contact/view', "reset=1&selectedChild=log&cid={$this->cid}", FALSE, NULL, FALSE));
 376       }
 377     }
 378     else {
 379       CRM_Utils_System::redirect(CRM_Report_Utils_Report::getNextUrl($this->summary, 'reset=1', FALSE, TRUE));
 380     }
 381   }
 382
 383   /**
 384    * Get the properties that might be in the URL.
 385    */
 386   protected function parsePropertiesFromUrl() {
 387     $this->log_conn_id = CRM_Utils_Request::retrieve('log_conn_id', 'String');
 388     $this->log_date = CRM_Utils_Request::retrieve('log_date', 'String');
 389     $this->cid = CRM_Utils_Request::retrieve('cid', 'Integer');
 390     $this->raw = CRM_Utils_Request::retrieve('raw', 'Boolean');
 391
 392     $this->altered_name = CRM_Utils_Request::retrieve('alteredName', 'String');
 393     $this->altered_by = CRM_Utils_Request::retrieve('alteredBy', 'String');
 394     $this->altered_by_id = CRM_Utils_Request::retrieve('alteredById', 'Integer');
 395     $this->layout = CRM_Utils_Request::retrieve('layout', 'String');
 396   }
 397
 398   /**
 399    * Override to set limit
 400    * @param int $rowCount
 401    */
 402   public function limit($rowCount = self::ROW_COUNT_LIMIT) {
 403     parent::limit($rowCount);
 404   }
 405
 406   /**
 407    * Override to set pager with limit
 408    * @param int $rowCount
 409    */
 410   public function setPager($rowCount = self::ROW_COUNT_LIMIT) {
 411     // We should not be rendering the pager in overlay mode
 412     if (!isset($this->layout)) {
 413       $this->_dashBoardRowCount = $rowCount;
 414       $this->_limit = TRUE;
 415       parent::setPager($rowCount);
 416     }
 417   }
 418
 419   /**
 420    * This is a function similar to limit, in fact we copied it as-is and removed
 421    * some `set` statements
 422    *
 423    */
 424   public function getLimit($rowCount = self::ROW_COUNT_LIMIT) {
 425     if ($this->addPaging) {
 426
 427       $pageId = CRM_Utils_Request::retrieve('crmPID', 'Integer');
 428
 429       // @todo all http vars should be extracted in the preProcess
 430       // - not randomly in the class
 431       if (!$pageId && !empty($_POST)) {
 432         if (isset($_POST['PagerBottomButton']) && isset($_POST['crmPID_B'])) {
 433           $pageId = max((int) $_POST['crmPID_B'], 1);
 434         }
 435         elseif (isset($_POST['PagerTopButton']) && isset($_POST['crmPID'])) {
 436           $pageId = max((int) $_POST['crmPID'], 1);
 437         }
 438         unset($_POST['crmPID_B'], $_POST['crmPID']);
 439       }
 440
 441       $pageId = $pageId ? $pageId : 1;
 442       $offset = ($pageId - 1) * $rowCount;
 443
 444       $offset = CRM_Utils_Type::escape($offset, 'Int');
 445       $rowCount = CRM_Utils_Type::escape($rowCount, 'Int');
 446       $this->_limit = " LIMIT $offset, $rowCount";
 447       $this->dblimit = $rowCount;
 448       $this->dboffset = $offset;
 449     }
 450   }
 451
 452 }