Commit | Line | Data |
---|---|---|
6a488035 TO |
1 | <?php |
2 | /* | |
3 | +--------------------------------------------------------------------+ | |
06b69b18 | 4 | | CiviCRM version 4.5 | |
6a488035 | 5 | +--------------------------------------------------------------------+ |
06b69b18 | 6 | | Copyright CiviCRM LLC (c) 2004-2014 | |
6a488035 TO |
7 | +--------------------------------------------------------------------+ |
8 | | This file is a part of CiviCRM. | | |
9 | | | | |
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. | | |
13 | | | | |
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. | | |
18 | | | | |
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 | +--------------------------------------------------------------------+ | |
26 | */ | |
27 | ||
28 | /** | |
29 | * | |
30 | * @package CRM | |
06b69b18 | 31 | * @copyright CiviCRM LLC (c) 2004-2014 |
6a488035 TO |
32 | * $Id$ |
33 | * | |
34 | */ | |
35 | class CRM_Logging_Schema { | |
36 | private $logs = array(); | |
37 | private $tables = array(); | |
38 | ||
39 | private $db; | |
340f6aa0 | 40 | private $useDBPrefix = TRUE; |
6a488035 TO |
41 | |
42 | private $reports = array( | |
43 | 'logging/contact/detail', | |
44 | 'logging/contact/summary', | |
45 | 'logging/contribute/detail', | |
46 | 'logging/contribute/summary', | |
47 | ); | |
48 | ||
6842bb53 | 49 | //CRM-13028 / NYSS-6933 - table => array (cols) - to be excluded from the update statement |
4d1040bb DS |
50 | private $exceptions = array( |
51 | 'civicrm_job' => array('last_run'), | |
52 | 'civicrm_group' => array('cache_date'), | |
6842bb53 | 53 | ); |
4d1040bb | 54 | |
6a488035 TO |
55 | /** |
56 | * Populate $this->tables and $this->logs with current db state. | |
57 | */ | |
58 | function __construct() { | |
59 | $dao = new CRM_Contact_DAO_Contact(); | |
60 | $civiDBName = $dao->_database; | |
61 | ||
62 | $dao = CRM_Core_DAO::executeQuery(" | |
63 | SELECT TABLE_NAME | |
64 | FROM INFORMATION_SCHEMA.TABLES | |
65 | WHERE TABLE_SCHEMA = '{$civiDBName}' | |
66 | AND TABLE_TYPE = 'BASE TABLE' | |
67 | AND TABLE_NAME LIKE 'civicrm_%' | |
68 | "); | |
69 | while ($dao->fetch()) { | |
70 | $this->tables[] = $dao->TABLE_NAME; | |
71 | } | |
72 | ||
3292d079 | 73 | // do not log temp import, cache, menu and log tables |
6a488035 TO |
74 | $this->tables = preg_grep('/^civicrm_import_job_/', $this->tables, PREG_GREP_INVERT); |
75 | $this->tables = preg_grep('/_cache$/', $this->tables, PREG_GREP_INVERT); | |
76 | $this->tables = preg_grep('/_log/', $this->tables, PREG_GREP_INVERT); | |
6a488035 | 77 | $this->tables = preg_grep('/^civicrm_queue_/', $this->tables, PREG_GREP_INVERT); |
3292d079 | 78 | $this->tables = preg_grep('/^civicrm_menu/', $this->tables, PREG_GREP_INVERT); //CRM-14672 |
db70b323 | 79 | $this->tables = preg_grep('/_temp_/', $this->tables, PREG_GREP_INVERT); |
6a488035 | 80 | |
f9b793b0 DL |
81 | // do not log civicrm_mailing_event* tables, CRM-12300 |
82 | $this->tables = preg_grep('/^civicrm_mailing_event_/', $this->tables, PREG_GREP_INVERT); | |
83 | ||
340f6aa0 DL |
84 | if (defined('CIVICRM_LOGGING_DSN')) { |
85 | $dsn = DB::parseDSN(CIVICRM_LOGGING_DSN); | |
86 | $this->useDBPrefix = (CIVICRM_LOGGING_DSN != CIVICRM_DSN); | |
87 | } | |
88 | else { | |
89 | $dsn = DB::parseDSN(CIVICRM_DSN); | |
90 | $this->useDBPrefix = FALSE; | |
91 | } | |
6a488035 TO |
92 | $this->db = $dsn['database']; |
93 | ||
94 | $dao = CRM_Core_DAO::executeQuery(" | |
95 | SELECT TABLE_NAME | |
96 | FROM INFORMATION_SCHEMA.TABLES | |
97 | WHERE TABLE_SCHEMA = '{$this->db}' | |
98 | AND TABLE_TYPE = 'BASE TABLE' | |
99 | AND TABLE_NAME LIKE 'log_civicrm_%' | |
100 | "); | |
101 | while ($dao->fetch()) { | |
102 | $log = $dao->TABLE_NAME; | |
103 | $this->logs[substr($log, 4)] = $log; | |
104 | } | |
105 | } | |
106 | ||
107 | /** | |
108 | * Return logging custom data tables. | |
109 | */ | |
110 | function customDataLogTables() { | |
111 | return preg_grep('/^log_civicrm_value_/', $this->logs); | |
112 | } | |
113 | ||
694e78fd DS |
114 | /** |
115 | * Return custom data tables for specified entity / extends. | |
116 | */ | |
117 | function entityCustomDataLogTables($extends) { | |
118 | $customGroupTables = array(); | |
119 | $customGroupDAO = CRM_Core_BAO_CustomGroup::getAllCustomGroupsByBaseEntity($extends); | |
120 | $customGroupDAO->find(); | |
121 | while ($customGroupDAO->fetch()) { | |
122 | $customGroupTables[$customGroupDAO->table_name] = $this->logs[$customGroupDAO->table_name]; | |
123 | } | |
124 | return $customGroupTables; | |
125 | } | |
126 | ||
6a488035 TO |
127 | /** |
128 | * Disable logging by dropping the triggers (but keep the log tables intact). | |
129 | */ | |
130 | function disableLogging() { | |
131 | $config = CRM_Core_Config::singleton(); | |
132 | $config->logging = FALSE; | |
133 | ||
134 | $this->dropTriggers(); | |
135 | ||
136 | // invoke the meta trigger creation call | |
137 | CRM_Core_DAO::triggerRebuild(); | |
138 | ||
139 | $this->deleteReports(); | |
140 | } | |
141 | ||
142 | /** | |
143 | * Drop triggers for all logged tables. | |
144 | */ | |
145 | function dropTriggers($tableName = NULL) { | |
146 | $dao = new CRM_Core_DAO; | |
147 | ||
148 | if ($tableName) { | |
149 | $tableNames = array($tableName); | |
150 | } | |
151 | else { | |
152 | $tableNames = $this->tables; | |
153 | } | |
154 | ||
155 | foreach ($tableNames as $table) { | |
6842bb53 DL |
156 | $validName = CRM_Core_DAO::shortenSQLName($table, 48, TRUE); |
157 | ||
6a488035 | 158 | // before triggers |
6842bb53 DL |
159 | $dao->executeQuery("DROP TRIGGER IF EXISTS {$validName}_before_insert"); |
160 | $dao->executeQuery("DROP TRIGGER IF EXISTS {$validName}_before_update"); | |
161 | $dao->executeQuery("DROP TRIGGER IF EXISTS {$validName}_before_delete"); | |
6a488035 TO |
162 | |
163 | // after triggers | |
6842bb53 DL |
164 | $dao->executeQuery("DROP TRIGGER IF EXISTS {$validName}_after_insert"); |
165 | $dao->executeQuery("DROP TRIGGER IF EXISTS {$validName}_after_update"); | |
166 | $dao->executeQuery("DROP TRIGGER IF EXISTS {$validName}_after_delete"); | |
6a488035 | 167 | } |
a8dd306e DL |
168 | |
169 | // now lets also be safe and drop all triggers that start with | |
170 | // civicrm_ if we are dropping all triggers | |
171 | // we need to do this to capture all the leftover triggers since | |
172 | // we did the shortening trigger name for CRM-11794 | |
173 | if ($tableName === NULL) { | |
174 | $triggers = $dao->executeQuery("SHOW TRIGGERS LIKE 'civicrm_%'"); | |
175 | ||
176 | while ($triggers->fetch()) { | |
177 | // note that drop trigger has a wierd syntax and hence we do not | |
178 | // send the trigger name as a string (i.e. its not quoted | |
179 | $dao->executeQuery("DROP TRIGGER IF EXISTS {$triggers->Trigger}"); | |
180 | } | |
181 | } | |
6a488035 TO |
182 | } |
183 | ||
184 | /** | |
185 | * Enable sitewide logging. | |
186 | * | |
187 | * @return void | |
188 | */ | |
189 | function enableLogging() { | |
190 | $this->fixSchemaDifferences(TRUE); | |
191 | $this->addReports(); | |
192 | } | |
193 | ||
194 | /** | |
195 | * Sync log tables and rebuild triggers. | |
196 | * | |
197 | * @param bool $enableLogging: Ensure logging is enabled | |
198 | * | |
199 | * @return void | |
200 | */ | |
201 | function fixSchemaDifferences($enableLogging = FALSE) { | |
202 | $config = CRM_Core_Config::singleton(); | |
203 | if ($enableLogging) { | |
204 | $config->logging = TRUE; | |
205 | } | |
206 | if ($config->logging) { | |
bfb723bb | 207 | $this->fixSchemaDifferencesForALL(); |
6a488035 TO |
208 | } |
209 | // invoke the meta trigger creation call | |
e53944ef | 210 | CRM_Core_DAO::triggerRebuild(NULL, TRUE); |
6a488035 TO |
211 | } |
212 | ||
213 | /** | |
214 | * Add missing (potentially specified) log table columns for the given table. | |
215 | * | |
216 | * @param $table string name of the relevant table | |
217 | * @param $cols mixed array of columns to add or null (to check for the missing columns) | |
218 | * @param $rebuildTrigger boolean should we rebuild the triggers | |
219 | * | |
220 | * @return void | |
221 | */ | |
bfb723bb DS |
222 | function fixSchemaDifferencesFor($table, $cols = array(), $rebuildTrigger = FALSE) { |
223 | if (empty($table)) { | |
224 | return FALSE; | |
225 | } | |
6a488035 TO |
226 | if (empty($this->logs[$table])) { |
227 | $this->createLogTableFor($table); | |
bfb723bb | 228 | return TRUE; |
6a488035 TO |
229 | } |
230 | ||
6a488035 | 231 | if (empty($cols)) { |
bfb723bb | 232 | $cols = $this->columnsWithDiffSpecs($table, "log_$table"); |
6a488035 TO |
233 | } |
234 | ||
235 | // use the relevant lines from CREATE TABLE to add colums to the log table | |
bfb723bb DS |
236 | $create = $this->_getCreateQuery($table); |
237 | foreach ((array('ADD', 'MODIFY')) as $alterType) { | |
12de149a DS |
238 | if (!empty($cols[$alterType])) { |
239 | foreach ($cols[$alterType] as $col) { | |
240 | $line = $this->_getColumnQuery($col, $create); | |
241 | CRM_Core_DAO::executeQuery("ALTER TABLE `{$this->db}`.log_$table {$alterType} {$line}"); | |
242 | } | |
bfb723bb DS |
243 | } |
244 | } | |
245 | ||
31c270e1 DS |
246 | // for any obsolete columns (not null) we just make the column nullable. |
247 | if (!empty($cols['OBSOLETE'])) { | |
eae2404c | 248 | $create = $this->_getCreateQuery("`{$this->db}`.log_{$table}"); |
31c270e1 | 249 | foreach ($cols['OBSOLETE'] as $col) { |
bfb723bb | 250 | $line = $this->_getColumnQuery($col, $create); |
31c270e1 DS |
251 | // This is just going to make a not null column to nullable |
252 | CRM_Core_DAO::executeQuery("ALTER TABLE `{$this->db}`.log_$table MODIFY {$line}"); | |
bfb723bb DS |
253 | } |
254 | } | |
255 | ||
256 | if ($rebuildTrigger) { | |
257 | // invoke the meta trigger creation call | |
258 | CRM_Core_DAO::triggerRebuild($table); | |
259 | } | |
260 | return TRUE; | |
261 | } | |
262 | ||
e0ef6999 EM |
263 | /** |
264 | * @param $table | |
265 | * | |
266 | * @return array | |
267 | */ | |
bfb723bb DS |
268 | private function _getCreateQuery($table) { |
269 | $dao = CRM_Core_DAO::executeQuery("SHOW CREATE TABLE {$table}"); | |
6a488035 TO |
270 | $dao->fetch(); |
271 | $create = explode("\n", $dao->Create_Table); | |
bfb723bb DS |
272 | return $create; |
273 | } | |
6a488035 | 274 | |
e0ef6999 EM |
275 | /** |
276 | * @param $col | |
277 | * @param $createQuery | |
278 | * | |
279 | * @return array|mixed|string | |
280 | */ | |
bfb723bb DS |
281 | private function _getColumnQuery($col, $createQuery) { |
282 | $line = preg_grep("/^ `$col` /", $createQuery); | |
4a423b7a | 283 | $line = rtrim(array_pop($line), ','); |
bfb723bb | 284 | // CRM-11179 |
4a423b7a | 285 | $line = $this->fixTimeStampAndNotNullSQL($line); |
bfb723bb DS |
286 | return $line; |
287 | } | |
288 | ||
e0ef6999 EM |
289 | /** |
290 | * @param bool $rebuildTrigger | |
291 | */ | |
bfb723bb DS |
292 | function fixSchemaDifferencesForAll($rebuildTrigger = FALSE) { |
293 | $diffs = array(); | |
bfb723bb DS |
294 | foreach ($this->tables as $table) { |
295 | if (empty($this->logs[$table])) { | |
296 | $this->createLogTableFor($table); | |
e53944ef BS |
297 | } |
298 | else { | |
bfb723bb DS |
299 | $diffs[$table] = $this->columnsWithDiffSpecs($table, "log_$table"); |
300 | } | |
301 | } | |
6a488035 | 302 | |
bfb723bb DS |
303 | foreach ($diffs as $table => $cols) { |
304 | $this->fixSchemaDifferencesFor($table, $cols, FALSE); | |
6a488035 TO |
305 | } |
306 | ||
307 | if ($rebuildTrigger) { | |
308 | // invoke the meta trigger creation call | |
309 | CRM_Core_DAO::triggerRebuild($table); | |
310 | } | |
311 | } | |
312 | ||
bfb723bb DS |
313 | /* |
314 | * log_civicrm_contact.modified_date for example would always be copied from civicrm_contact.modified_date, | |
315 | * so there's no need for a default timestamp and therefore we remove such default timestamps | |
316 | * also eliminate the NOT NULL constraint, since we always copy and schema can change down the road) | |
317 | */ | |
e0ef6999 EM |
318 | /** |
319 | * @param $query | |
320 | * | |
321 | * @return mixed | |
322 | */ | |
c28241be | 323 | function fixTimeStampAndNotNullSQL($query) { |
6a488035 TO |
324 | $query = str_ireplace("TIMESTAMP NOT NULL", "TIMESTAMP NULL", $query); |
325 | $query = str_ireplace("DEFAULT CURRENT_TIMESTAMP ON UPDATE CURRENT_TIMESTAMP", '', $query); | |
326 | $query = str_ireplace("DEFAULT CURRENT_TIMESTAMP", '', $query); | |
c28241be | 327 | $query = str_ireplace("NOT NULL", '', $query); |
6a488035 TO |
328 | return $query; |
329 | } | |
330 | ||
6a488035 TO |
331 | private function addReports() { |
332 | $titles = array( | |
333 | 'logging/contact/detail' => ts('Logging Details'), | |
334 | 'logging/contact/summary' => ts('Contact Logging Report (Summary)'), | |
335 | 'logging/contribute/detail' => ts('Contribution Logging Report (Detail)'), | |
336 | 'logging/contribute/summary' => ts('Contribution Logging Report (Summary)'), | |
337 | ); | |
338 | // enable logging templates | |
339 | CRM_Core_DAO::executeQuery(" | |
340 | UPDATE civicrm_option_value | |
341 | SET is_active = 1 | |
342 | WHERE value IN ('" . implode("', '", $this->reports) . "') | |
343 | "); | |
344 | ||
345 | // add report instances | |
346 | $domain_id = CRM_Core_Config::domainID(); | |
347 | foreach ($this->reports as $report) { | |
0b25329b | 348 | $dao = new CRM_Report_DAO_ReportInstance; |
6a488035 TO |
349 | $dao->domain_id = $domain_id; |
350 | $dao->report_id = $report; | |
351 | $dao->title = $titles[$report]; | |
352 | $dao->permission = 'administer CiviCRM'; | |
353 | if ($report == 'logging/contact/summary') | |
354 | $dao->is_reserved = 1; | |
355 | $dao->insert(); | |
356 | } | |
357 | } | |
358 | ||
359 | /** | |
360 | * Get an array of column names of the given table. | |
361 | */ | |
e53944ef | 362 | private function columnsOf($table, $force = FALSE) { |
6a488035 TO |
363 | static $columnsOf = array(); |
364 | ||
365 | $from = (substr($table, 0, 4) == 'log_') ? "`{$this->db}`.$table" : $table; | |
366 | ||
e53944ef | 367 | if (!isset($columnsOf[$table]) || $force) { |
6a4257d4 | 368 | $errorScope = CRM_Core_TemporaryErrorScope::ignoreException(); |
6a488035 | 369 | $dao = CRM_Core_DAO::executeQuery("SHOW COLUMNS FROM $from"); |
6a488035 TO |
370 | if (is_a($dao, 'DB_Error')) { |
371 | return array(); | |
372 | } | |
373 | $columnsOf[$table] = array(); | |
374 | while ($dao->fetch()) { | |
375 | $columnsOf[$table][] = $dao->Field; | |
376 | } | |
377 | } | |
378 | ||
379 | return $columnsOf[$table]; | |
380 | } | |
381 | ||
bfb723bb DS |
382 | /** |
383 | * Get an array of columns and their details like DATA_TYPE, IS_NULLABLE, COLUMN_DEFAULT for the given table. | |
384 | */ | |
385 | private function columnSpecsOf($table) { | |
386 | static $columnSpecs = array(), $civiDB = NULL; | |
387 | ||
388 | if (empty($columnSpecs)) { | |
389 | if (!$civiDB) { | |
390 | $dao = new CRM_Contact_DAO_Contact(); | |
391 | $civiDB = $dao->_database; | |
392 | } | |
6a4257d4 | 393 | $errorScope = CRM_Core_TemporaryErrorScope::ignoreException(); |
6842bb53 | 394 | // NOTE: W.r.t Performance using one query to find all details and storing in static array is much faster |
bfb723bb DS |
395 | // than firing query for every given table. |
396 | $query = " | |
397 | SELECT TABLE_SCHEMA, TABLE_NAME, COLUMN_NAME, DATA_TYPE, IS_NULLABLE, COLUMN_DEFAULT | |
398 | FROM INFORMATION_SCHEMA.COLUMNS | |
399 | WHERE table_schema IN ('{$this->db}', '{$civiDB}')"; | |
bfb723bb | 400 | $dao = CRM_Core_DAO::executeQuery($query); |
bfb723bb DS |
401 | if (is_a($dao, 'DB_Error')) { |
402 | return array(); | |
403 | } | |
404 | while ($dao->fetch()) { | |
bfb723bb DS |
405 | if (!array_key_exists($dao->TABLE_NAME, $columnSpecs)) { |
406 | $columnSpecs[$dao->TABLE_NAME] = array(); | |
407 | } | |
6842bb53 | 408 | $columnSpecs[$dao->TABLE_NAME][$dao->COLUMN_NAME] = |
bfb723bb | 409 | array( |
6842bb53 DL |
410 | 'COLUMN_NAME' => $dao->COLUMN_NAME, |
411 | 'DATA_TYPE' => $dao->DATA_TYPE, | |
412 | 'IS_NULLABLE' => $dao->IS_NULLABLE, | |
bfb723bb DS |
413 | 'COLUMN_DEFAULT' => $dao->COLUMN_DEFAULT |
414 | ); | |
415 | } | |
bfb723bb | 416 | } |
bfb723bb DS |
417 | return $columnSpecs[$table]; |
418 | } | |
419 | ||
e0ef6999 EM |
420 | /** |
421 | * @param $civiTable | |
422 | * @param $logTable | |
423 | * | |
424 | * @return array | |
425 | */ | |
4a423b7a DS |
426 | function columnsWithDiffSpecs($civiTable, $logTable) { |
427 | $civiTableSpecs = $this->columnSpecsOf($civiTable); | |
428 | $logTableSpecs = $this->columnSpecsOf($logTable); | |
6842bb53 | 429 | |
31c270e1 | 430 | $diff = array('ADD' => array(), 'MODIFY' => array(), 'OBSOLETE' => array()); |
6842bb53 | 431 | |
4a423b7a DS |
432 | // columns to be added |
433 | $diff['ADD'] = array_diff(array_keys($civiTableSpecs), array_keys($logTableSpecs)); | |
6842bb53 | 434 | |
4a423b7a | 435 | // columns to be modified |
6842bb53 | 436 | // NOTE: we consider only those columns for modifications where there is a spec change, and that the column definition |
4a423b7a DS |
437 | // wasn't deliberately modified by fixTimeStampAndNotNullSQL() method. |
438 | foreach ($civiTableSpecs as $col => $colSpecs) { | |
c5bdd6f0 | 439 | if (!isset($logTableSpecs[$col]) || !is_array($logTableSpecs[$col]) ) { |
e53944ef BS |
440 | $logTableSpecs[$col] = array(); |
441 | } | |
442 | ||
cd71572a | 443 | $specDiff = array_diff($civiTableSpecs[$col], $logTableSpecs[$col]); |
12de149a | 444 | if (!empty($specDiff) && $col != 'id' && !array_key_exists($col, $diff['ADD'])) { |
4a423b7a | 445 | // ignore 'id' column for any spec changes, to avoid any auto-increment mysql errors |
c5bdd6f0 | 446 | if ($civiTableSpecs[$col]['DATA_TYPE'] != CRM_Utils_Array::value('DATA_TYPE', $logTableSpecs[$col])) { |
6842bb53 | 447 | // if data-type is different, surely consider the column |
4a423b7a | 448 | $diff['MODIFY'][] = $col; |
c5bdd6f0 | 449 | } else if ($civiTableSpecs[$col]['IS_NULLABLE'] != CRM_Utils_Array::value('IS_NULLABLE', $logTableSpecs[$col]) && |
4a423b7a DS |
450 | $logTableSpecs[$col]['IS_NULLABLE'] == 'NO') { |
451 | // if is-null property is different, and log table's column is NOT-NULL, surely consider the column | |
452 | $diff['MODIFY'][] = $col; | |
c5bdd6f0 | 453 | } else if ($civiTableSpecs[$col]['COLUMN_DEFAULT'] != CRM_Utils_Array::value('COLUMN_DEFAULT', $logTableSpecs[$col]) && |
4a423b7a DS |
454 | !strstr($civiTableSpecs[$col]['COLUMN_DEFAULT'], 'TIMESTAMP')) { |
455 | // if default property is different, and its not about a timestamp column, consider it | |
456 | $diff['MODIFY'][] = $col; | |
457 | } | |
6842bb53 | 458 | } |
bfb723bb DS |
459 | } |
460 | ||
4a423b7a DS |
461 | // columns to made obsolete by turning into not-null |
462 | $oldCols = array_diff(array_keys($logTableSpecs), array_keys($civiTableSpecs)); | |
31c270e1 | 463 | foreach ($oldCols as $col) { |
6842bb53 | 464 | if (!in_array($col, array('log_date', 'log_conn_id', 'log_user_id', 'log_action')) && |
4a423b7a DS |
465 | $logTableSpecs[$col]['IS_NULLABLE'] == 'NO') { |
466 | // if its a column present only in log table, not among those used by log tables for special purpose, and not-null | |
31c270e1 | 467 | $diff['OBSOLETE'][] = $col; |
bfb723bb DS |
468 | } |
469 | } | |
470 | ||
471 | return $diff; | |
472 | } | |
473 | ||
6a488035 TO |
474 | /** |
475 | * Create a log table with schema mirroring the given table’s structure and seeding it with the given table’s contents. | |
476 | */ | |
477 | private function createLogTableFor($table) { | |
478 | $dao = CRM_Core_DAO::executeQuery("SHOW CREATE TABLE $table"); | |
479 | $dao->fetch(); | |
480 | $query = $dao->Create_Table; | |
481 | ||
482 | // rewrite the queries into CREATE TABLE queries for log tables: | |
6a488035 TO |
483 | $cols = <<<COLS |
484 | log_date TIMESTAMP DEFAULT CURRENT_TIMESTAMP, | |
485 | log_conn_id INTEGER, | |
486 | log_user_id INTEGER, | |
487 | log_action ENUM('Initialization', 'Insert', 'Update', 'Delete') | |
488 | COLS; | |
c28241be DL |
489 | |
490 | // - prepend the name with log_ | |
491 | // - drop AUTO_INCREMENT columns | |
492 | // - drop non-column rows of the query (keys, constraints, etc.) | |
493 | // - set the ENGINE to ARCHIVE | |
494 | // - add log-specific columns (at the end of the table) | |
6a488035 TO |
495 | $query = preg_replace("/^CREATE TABLE `$table`/i", "CREATE TABLE `{$this->db}`.log_$table", $query); |
496 | $query = preg_replace("/ AUTO_INCREMENT/i", '', $query); | |
497 | $query = preg_replace("/^ [^`].*$/m", '', $query); | |
498 | $query = preg_replace("/^\) ENGINE=[^ ]+ /im", ') ENGINE=ARCHIVE ', $query); | |
c28241be | 499 | |
6a488035 | 500 | // log_civicrm_contact.modified_date for example would always be copied from civicrm_contact.modified_date, |
c28241be DL |
501 | // so there's no need for a default timestamp and therefore we remove such default timestamps |
502 | // also eliminate the NOT NULL constraint, since we always copy and schema can change down the road) | |
503 | $query = self::fixTimeStampAndNotNullSQL($query); | |
6a488035 TO |
504 | $query = preg_replace("/^\) /m", "$cols\n) ", $query); |
505 | ||
506 | CRM_Core_DAO::executeQuery($query); | |
507 | ||
508 | $columns = implode(', ', $this->columnsOf($table)); | |
509 | CRM_Core_DAO::executeQuery("INSERT INTO `{$this->db}`.log_$table ($columns, log_conn_id, log_user_id, log_action) SELECT $columns, CONNECTION_ID(), @civicrm_user_id, 'Initialization' FROM {$table}"); | |
510 | ||
511 | $this->tables[] = $table; | |
512 | $this->logs[$table] = "log_$table"; | |
513 | } | |
514 | ||
515 | private function deleteReports() { | |
516 | // disable logging templates | |
517 | CRM_Core_DAO::executeQuery(" | |
518 | UPDATE civicrm_option_value | |
519 | SET is_active = 0 | |
520 | WHERE value IN ('" . implode("', '", $this->reports) . "') | |
521 | "); | |
522 | ||
523 | // delete report instances | |
524 | $domain_id = CRM_Core_Config::domainID(); | |
525 | foreach ($this->reports as $report) { | |
0b25329b | 526 | $dao = new CRM_Report_DAO_ReportInstance; |
6a488035 TO |
527 | $dao->domain_id = $domain_id; |
528 | $dao->report_id = $report; | |
529 | $dao->delete(); | |
530 | } | |
531 | } | |
532 | ||
533 | /** | |
534 | * Predicate whether logging is enabled. | |
535 | */ | |
536 | public function isEnabled() { | |
537 | $config = CRM_Core_Config::singleton(); | |
538 | ||
539 | if ($config->logging) { | |
540 | return $this->tablesExist() and $this->triggersExist(); | |
541 | } | |
542 | return FALSE; | |
543 | } | |
544 | ||
545 | /** | |
546 | * Predicate whether any log tables exist. | |
547 | */ | |
548 | private function tablesExist() { | |
549 | return !empty($this->logs); | |
550 | } | |
551 | ||
552 | /** | |
553 | * Predicate whether the logging triggers are in place. | |
554 | */ | |
555 | private function triggersExist() { | |
556 | // FIXME: probably should be a bit more thorough… | |
557 | // note that the LIKE parameter is TABLE NAME | |
558 | return (bool) CRM_Core_DAO::singleValueQuery("SHOW TRIGGERS LIKE 'civicrm_contact'"); | |
559 | } | |
560 | ||
e0ef6999 EM |
561 | /** |
562 | * @param $info | |
563 | * @param null $tableName | |
564 | * @param bool $force | |
565 | */ | |
e53944ef | 566 | function triggerInfo(&$info, $tableName = NULL, $force = FALSE) { |
6a488035 TO |
567 | // check if we have logging enabled |
568 | $config =& CRM_Core_Config::singleton(); | |
569 | if (!$config->logging) { | |
570 | return; | |
571 | } | |
572 | ||
573 | $insert = array('INSERT'); | |
574 | $update = array('UPDATE'); | |
575 | $delete = array('DELETE'); | |
576 | ||
577 | if ($tableName) { | |
578 | $tableNames = array($tableName); | |
579 | } | |
580 | else { | |
581 | $tableNames = $this->tables; | |
582 | } | |
583 | ||
584 | // logging is enabled, so now lets create the trigger info tables | |
585 | foreach ($tableNames as $table) { | |
e53944ef | 586 | $columns = $this->columnsOf($table, $force); |
6a488035 TO |
587 | |
588 | // only do the change if any data has changed | |
589 | $cond = array( ); | |
590 | foreach ($columns as $column) { | |
591 | // ignore modified_date changes | |
4d1040bb | 592 | if ($column != 'modified_date' && !in_array($column, CRM_Utils_Array::value($table, $this->exceptions, array()))) { |
6a488035 TO |
593 | $cond[] = "IFNULL(OLD.$column,'') <> IFNULL(NEW.$column,'')"; |
594 | } | |
595 | } | |
596 | $suppressLoggingCond = "@civicrm_disable_logging IS NULL OR @civicrm_disable_logging = 0"; | |
597 | $updateSQL = "IF ( (" . implode( ' OR ', $cond ) . ") AND ( $suppressLoggingCond ) ) THEN "; | |
598 | ||
340f6aa0 DL |
599 | if ($this->useDBPrefix) { |
600 | $sqlStmt = "INSERT INTO `{$this->db}`.log_{tableName} ("; | |
601 | } | |
602 | else { | |
603 | $sqlStmt = "INSERT INTO log_{tableName} ("; | |
604 | } | |
6a488035 TO |
605 | foreach ($columns as $column) { |
606 | $sqlStmt .= "$column, "; | |
607 | } | |
608 | $sqlStmt .= "log_conn_id, log_user_id, log_action) VALUES ("; | |
609 | ||
610 | $insertSQL = $deleteSQL = "IF ( $suppressLoggingCond ) THEN $sqlStmt "; | |
611 | $updateSQL .= $sqlStmt; | |
612 | ||
613 | $sqlStmt = ''; | |
614 | foreach ($columns as $column) { | |
615 | $sqlStmt .= "NEW.$column, "; | |
616 | $deleteSQL .= "OLD.$column, "; | |
617 | } | |
618 | $sqlStmt .= "CONNECTION_ID(), @civicrm_user_id, '{eventName}');"; | |
619 | $deleteSQL .= "CONNECTION_ID(), @civicrm_user_id, '{eventName}');"; | |
620 | ||
621 | $sqlStmt .= "END IF;"; | |
622 | $deleteSQL .= "END IF;"; | |
623 | ||
624 | $insertSQL .= $sqlStmt; | |
625 | $updateSQL .= $sqlStmt; | |
626 | ||
627 | $info[] = array( | |
628 | 'table' => array($table), | |
629 | 'when' => 'AFTER', | |
630 | 'event' => $insert, | |
631 | 'sql' => $insertSQL, | |
632 | ); | |
633 | ||
634 | $info[] = array( | |
635 | 'table' => array($table), | |
636 | 'when' => 'AFTER', | |
637 | 'event' => $update, | |
638 | 'sql' => $updateSQL, | |
639 | ); | |
640 | ||
641 | $info[] = array( | |
642 | 'table' => array($table), | |
643 | 'when' => 'AFTER', | |
644 | 'event' => $delete, | |
645 | 'sql' => $deleteSQL, | |
646 | ); | |
647 | } | |
648 | } | |
649 | ||
650 | /** | |
651 | * This allow logging to be temporarily disabled for certain cases | |
652 | * where we want to do a mass cleanup but dont want to bother with | |
653 | * an audit trail | |
654 | * | |
655 | * @static | |
656 | * @public | |
657 | */ | |
658 | static function disableLoggingForThisConnection( ) { | |
659 | // do this only if logging is enabled | |
660 | $config = CRM_Core_Config::singleton( ); | |
661 | if ( $config->logging ) { | |
662 | CRM_Core_DAO::executeQuery( 'SET @civicrm_disable_logging = 1' ); | |
663 | } | |
664 | } | |
665 | ||
666 | } | |
667 |