3 +--------------------------------------------------------------------+
4 | CiviCRM version 4.4 |
5 +--------------------------------------------------------------------+
6 | Copyright CiviCRM LLC (c) 2004-2013 |
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-2013
35 class CRM_Logging_ReportDetail
extends CRM_Report_Form
{
38 protected $log_conn_id;
41 protected $tables = array();
42 protected $interval = '10 SECOND';
44 protected $altered_name;
45 protected $altered_by;
46 protected $altered_by_id;
48 // detail/summary report ids
52 function __construct() {
53 // don’t display the ‘Add these Contacts to Group’ button
54 $this->_add2groupSupported
= FALSE;
56 $dsn = defined('CIVICRM_LOGGING_DSN') ? DB
::parseDSN(CIVICRM_LOGGING_DSN
) : DB
::parseDSN(CIVICRM_DSN
);
57 $this->db
= $dsn['database'];
59 $this->log_conn_id
= CRM_Utils_Request
::retrieve('log_conn_id', 'Integer', CRM_Core_DAO
::$_nullObject);
60 $this->log_date
= CRM_Utils_Request
::retrieve('log_date', 'String', CRM_Core_DAO
::$_nullObject);
61 $this->cid
= CRM_Utils_Request
::retrieve('cid', 'Integer', CRM_Core_DAO
::$_nullObject);
62 $this->raw
= CRM_Utils_Request
::retrieve('raw', 'Boolean', CRM_Core_DAO
::$_nullObject);
64 $this->altered_name
= CRM_Utils_Request
::retrieve('alteredName', 'String', CRM_Core_DAO
::$_nullObject);
65 $this->altered_by
= CRM_Utils_Request
::retrieve('alteredBy', 'String', CRM_Core_DAO
::$_nullObject);
66 $this->altered_by_id
= CRM_Utils_Request
::retrieve('alteredById', 'Integer', CRM_Core_DAO
::$_nullObject);
68 parent
::__construct();
70 CRM_Utils_System
::resetBreadCrumb();
73 array('title' => ts('Home'),
74 'url' => CRM_Utils_System
::url()),
75 array('title' => ts('CiviCRM'),
76 'url' => CRM_Utils_System
::url('civicrm', 'reset=1')),
77 array('title' => ts('View Contact'),
78 'url' => CRM_Utils_System
::url('civicrm/contact/view', "reset=1&cid={$this->cid}")),
79 array('title' => ts('Search Results'),
80 'url' => CRM_Utils_System
::url('civicrm/contact/search', "force=1")),
82 CRM_Utils_System
::appendBreadCrumb($breadcrumb);
84 if (CRM_Utils_Request
::retrieve('revert', 'Boolean', CRM_Core_DAO
::$_nullObject)) {
85 $reverter = new CRM_Logging_Reverter($this->log_conn_id
, $this->log_date
);
86 $reverter->revert($this->tables
);
87 CRM_Core_Session
::setStatus(ts('The changes have been reverted.'), ts('Reverted'), 'success');
89 CRM_Utils_System
::redirect(CRM_Utils_System
::url('civicrm/contact/view', "reset=1&selectedChild=log&cid={$this->cid}", FALSE, NULL, FALSE));
92 CRM_Utils_System
::redirect(CRM_Report_Utils_Report
::getNextUrl($this->summary
, 'reset=1', FALSE, TRUE));
96 // make sure the report works even without the params
97 if (!$this->log_conn_id
or !$this->log_date
) {
98 $dao = new CRM_Core_DAO
;
99 $dao->query("SELECT log_conn_id, log_date FROM `{$this->db}`.log_{$this->tables[0]} WHERE log_action = 'Update' ORDER BY log_date DESC LIMIT 1");
101 $this->log_conn_id
= $dao->log_conn_id
;
102 $this->log_date
= $dao->log_date
;
105 $this->_columnHeaders
= array(
106 'field' => array('title' => ts('Field')),
107 'from' => array('title' => ts('Changed From')),
108 'to' => array('title' => ts('Changed To')),
112 function buildQuery($applyLimit = TRUE) {}
114 function buildRows($sql, &$rows) {
115 // safeguard for when there aren’t any log entries yet
116 if (!$this->log_conn_id
or !$this->log_date
) {
126 foreach ($this->tables
as $table) {
127 $rows = array_merge($rows, $this->diffsInTable($table));
131 protected function diffsInTable($table) {
134 $differ = new CRM_Logging_Differ($this->log_conn_id
, $this->log_date
, $this->interval
);
135 $diffs = $differ->diffsInTable($table, $this->cid
);
137 // return early if nothing found
142 list($titles, $values) = $differ->titlesAndValuesForTable($table);
144 // populate $rows with only the differences between $changed and $original (skipping certain columns and NULL ↔ empty changes unless raw requested)
145 $skipped = array('contact_id', 'entity_id', 'id');
146 foreach ($diffs as $diff) {
147 $field = $diff['field'];
148 $from = $diff['from'];
152 $field = "$table.$field";
155 if (in_array($field, $skipped)) {
158 // $differ filters out === values; for presentation hide changes like 42 → '42'
163 // special-case for multiple values. Also works for CRM-7251: preferred_communication_method
164 if ((substr($from, 0, 1) == CRM_Core_DAO
::VALUE_SEPARATOR
&&
165 substr($from, -1, 1) == CRM_Core_DAO
::VALUE_SEPARATOR
) ||
166 (substr($to, 0, 1) == CRM_Core_DAO
::VALUE_SEPARATOR
&&
167 substr($to, -1, 1) == CRM_Core_DAO
::VALUE_SEPARATOR
)) {
168 $froms = $tos = array();
169 foreach (explode(CRM_Core_DAO
::VALUE_SEPARATOR
, trim($from, CRM_Core_DAO
::VALUE_SEPARATOR
)) as $val) {
170 $froms[] = CRM_Utils_Array
::value($val, $values[$field]);
172 foreach (explode(CRM_Core_DAO
::VALUE_SEPARATOR
, trim($to, CRM_Core_DAO
::VALUE_SEPARATOR
)) as $val) {
173 $tos[] = CRM_Utils_Array
::value($val, $values[$field]);
175 $from = implode(', ', array_filter($froms));
176 $to = implode(', ', array_filter($tos));
179 if (isset($values[$field][$from])) {
180 $from = $values[$field][$from];
182 if (isset($values[$field][$to])) {
183 $to = $values[$field][$to];
185 if (isset($titles[$field])) {
186 $field = $titles[$field];
188 if ($diff['action'] == 'Insert') {
191 if ($diff['action'] == 'Delete') {
196 $rows[] = array('field' => $field . " (id: {$diff['id']})", 'from' => $from, 'to' => $to);
202 function buildQuickForm() {
203 parent
::buildQuickForm();
206 1 => array($this->log_conn_id
, 'Integer'),
207 2 => array($this->log_date
, 'String'),
210 $this->assign('whom_url', CRM_Utils_System
::url('civicrm/contact/view', "reset=1&cid={$this->cid}"));
211 $this->assign('who_url', CRM_Utils_System
::url('civicrm/contact/view', "reset=1&cid={$this->altered_by_id}"));
212 $this->assign('whom_name', $this->altered_name
);
213 $this->assign('who_name', $this->altered_by
);
215 $this->assign('log_date', CRM_Utils_Date
::mysqlToIso($this->log_date
));
217 $q = "reset=1&log_conn_id={$this->log_conn_id}&log_date={$this->log_date}";
218 $this->assign('revertURL', CRM_Report_Utils_Report
::getNextUrl($this->detail
, "$q&revert=1", FALSE, TRUE));
219 $this->assign('revertConfirm', ts('Are you sure you want to revert all these changes?'));