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_Schema
{
20 * Default storage engine for log tables
24 const ENGINE
= 'InnoDB';
30 private $useDBPrefix = TRUE;
33 'logging/contact/detail',
34 'logging/contact/summary',
35 'logging/contribute/detail',
36 'logging/contribute/summary',
40 * Columns that should never be subject to logging.
42 * CRM-13028 / NYSS-6933 - table => array (cols) - to be excluded from the update statement
46 private $exceptions = [
47 'civicrm_job' => ['last_run'],
48 'civicrm_group' => ['cache_date', 'refresh_date'],
52 * Specifications of all log table including
53 * - engine (default is InnoDB, if not set.)
54 * - engine_config, a string appended to the engine type.
55 * For INNODB space can be saved with 'ROW_FORMAT=COMPRESSED KEY_BLOCK_SIZE=4'
56 * - indexes (default is none and they cannot be added unless engine is innodb. If they are added and
57 * engine is not set to innodb an exception will be thrown since quiet acquiescence is easier to miss).
58 * - exceptions (by default those stored in $this->exceptions are included). These are
59 * excluded from the triggers.
63 private $logTableSpec = [];
66 * Setting Callback - Validate.
69 * @param array $fieldSpec
72 * @throws API_Exception
74 public static function checkLoggingSupport(&$value, $fieldSpec) {
75 $domain = new CRM_Core_DAO_Domain();
77 if (!(CRM_Core_DAO
::checkTriggerViewPermission(FALSE)) && $value) {
78 throw new API_Exception(ts("In order to use this functionality, the installation's database user must have privileges to create triggers and views (if binary logging is enabled – this means the SUPER privilege). This install does not have the required privilege(s) enabled."));
84 * Setting Callback - On Change.
86 * Respond to changes in the "logging" setting. Set up or destroy
89 * @param array $oldValue
90 * List of component names.
91 * @param array $newValue
92 * List of component names.
93 * @param array $metadata
94 * Specification of the setting (per *.settings.php).
96 public static function onToggle($oldValue, $newValue, $metadata) {
97 if ($oldValue == $newValue) {
101 $logging = new CRM_Logging_Schema();
103 $logging->enableLogging();
106 $logging->disableLogging();
111 * Populate $this->tables and $this->logs with current db state.
113 public function __construct() {
114 $dao = new CRM_Contact_DAO_Contact();
115 $civiDBName = $dao->_database
;
117 $dao = CRM_Core_DAO
::executeQuery("
119 FROM INFORMATION_SCHEMA.TABLES
120 WHERE TABLE_SCHEMA = '{$civiDBName}'
121 AND TABLE_TYPE = 'BASE TABLE'
122 AND TABLE_NAME LIKE 'civicrm_%'
124 while ($dao->fetch()) {
125 $this->tables
[] = $dao->TABLE_NAME
;
128 // do not log temp import, cache, menu and log tables
129 $this->tables
= preg_grep('/^civicrm_import_job_/', $this->tables
, PREG_GREP_INVERT
);
130 $this->tables
= preg_grep('/_cache$/', $this->tables
, PREG_GREP_INVERT
);
131 $this->tables
= preg_grep('/_log/', $this->tables
, PREG_GREP_INVERT
);
132 $this->tables
= preg_grep('/^civicrm_queue_/', $this->tables
, PREG_GREP_INVERT
);
134 $this->tables
= preg_grep('/^civicrm_menu/', $this->tables
, PREG_GREP_INVERT
);
135 $this->tables
= preg_grep('/_temp_/', $this->tables
, PREG_GREP_INVERT
);
137 $this->tables
= preg_grep('/_bak$/', $this->tables
, PREG_GREP_INVERT
);
138 $this->tables
= preg_grep('/_backup$/', $this->tables
, PREG_GREP_INVERT
);
140 $this->tables
= preg_grep('/^civicrm_tmp_/', $this->tables
, PREG_GREP_INVERT
);
142 // do not log civicrm_mailing_event* tables, CRM-12300
143 $this->tables
= preg_grep('/^civicrm_mailing_event_/', $this->tables
, PREG_GREP_INVERT
);
145 // do not log civicrm_mailing_recipients table, CRM-16193
146 $this->tables
= array_diff($this->tables
, ['civicrm_mailing_recipients']);
147 $this->logTableSpec
= array_fill_keys($this->tables
, []);
148 foreach ($this->exceptions
as $tableName => $fields) {
149 $this->logTableSpec
[$tableName]['exceptions'] = $fields;
151 CRM_Utils_Hook
::alterLogTables($this->logTableSpec
);
152 $this->tables
= array_keys($this->logTableSpec
);
153 $nonStandardTableNameString = $this->getNonStandardTableNameFilterString();
155 if (defined('CIVICRM_LOGGING_DSN')) {
156 $dsn = DB
::parseDSN(CIVICRM_LOGGING_DSN
);
157 $this->useDBPrefix
= (CIVICRM_LOGGING_DSN
!= CIVICRM_DSN
);
160 $dsn = DB
::parseDSN(CIVICRM_DSN
);
161 $this->useDBPrefix
= FALSE;
163 $this->db
= $dsn['database'];
165 $dao = CRM_Core_DAO
::executeQuery("
167 FROM INFORMATION_SCHEMA.TABLES
168 WHERE TABLE_SCHEMA = '{$this->db}'
169 AND TABLE_TYPE = 'BASE TABLE'
170 AND (TABLE_NAME LIKE 'log_civicrm_%' $nonStandardTableNameString )
172 while ($dao->fetch()) {
173 $log = $dao->TABLE_NAME
;
174 $this->logs
[substr($log, 4)] = $log;
179 * Return logging custom data tables.
181 public function customDataLogTables() {
182 return preg_grep('/^log_civicrm_value_/', $this->logs
);
186 * Return custom data tables for specified entity / extends.
188 * @param string $extends
192 public function entityCustomDataLogTables($extends) {
193 $customGroupTables = [];
194 $customGroupDAO = CRM_Core_BAO_CustomGroup
::getAllCustomGroupsByBaseEntity($extends);
195 $customGroupDAO->find();
196 while ($customGroupDAO->fetch()) {
197 // logging is disabled for the table (e.g by hook) then $this->logs[$customGroupDAO->table_name]
199 if (!empty($this->logs
[$customGroupDAO->table_name
])) {
200 $customGroupTables[$customGroupDAO->table_name
] = $this->logs
[$customGroupDAO->table_name
];
203 return $customGroupTables;
207 * Disable logging by dropping the triggers (but keep the log tables intact).
209 public function disableLogging() {
210 $config = CRM_Core_Config
::singleton();
211 $config->logging
= FALSE;
213 $this->dropTriggers();
215 // invoke the meta trigger creation call
216 CRM_Core_DAO
::triggerRebuild();
218 $this->deleteReports();
222 * Drop triggers for all logged tables.
224 * @param string $tableName
226 public function dropTriggers($tableName = NULL) {
227 /** @var \Civi\Core\SqlTriggers $sqlTriggers */
228 $sqlTriggers = Civi
::service('sql_triggers');
229 $dao = new CRM_Core_DAO();
232 $tableNames = [$tableName];
235 $tableNames = $this->tables
;
238 foreach ($tableNames as $table) {
239 $validName = CRM_Core_DAO
::shortenSQLName($table, 48, TRUE);
242 $sqlTriggers->enqueueQuery("DROP TRIGGER IF EXISTS {$validName}_before_insert");
243 $sqlTriggers->enqueueQuery("DROP TRIGGER IF EXISTS {$validName}_before_update");
244 $sqlTriggers->enqueueQuery("DROP TRIGGER IF EXISTS {$validName}_before_delete");
247 $sqlTriggers->enqueueQuery("DROP TRIGGER IF EXISTS {$validName}_after_insert");
248 $sqlTriggers->enqueueQuery("DROP TRIGGER IF EXISTS {$validName}_after_update");
249 $sqlTriggers->enqueueQuery("DROP TRIGGER IF EXISTS {$validName}_after_delete");
252 // now lets also be safe and drop all triggers that start with
253 // civicrm_ if we are dropping all triggers
254 // we need to do this to capture all the leftover triggers since
255 // we did the shortening trigger name for CRM-11794
256 if ($tableName === NULL) {
257 $triggers = $dao->executeQuery("SHOW TRIGGERS LIKE 'civicrm_%'");
259 while ($triggers->fetch()) {
260 $sqlTriggers->enqueueQuery("DROP TRIGGER IF EXISTS {$triggers->Trigger}");
266 * Enable site-wide logging.
268 public function enableLogging() {
269 $this->fixSchemaDifferences(TRUE);
274 * Sync log tables and rebuild triggers.
276 * @param bool $enableLogging : Ensure logging is enabled
278 public function fixSchemaDifferences($enableLogging = FALSE) {
279 $config = CRM_Core_Config
::singleton();
280 if ($enableLogging) {
281 $config->logging
= TRUE;
283 if ($config->logging
) {
284 $this->fixSchemaDifferencesForALL();
286 // invoke the meta trigger creation call
287 CRM_Core_DAO
::triggerRebuild(NULL, TRUE);
291 * Update log tables structure.
293 * This function updates log tables to have the log_conn_id type of varchar
294 * and also implements the engine change defined by the hook (i.e. INNODB).
296 * Note changing engine & adding hook-defined indexes, but not changing back
297 * to INNODB if engine has not been deliberately set (by hook) and not
298 * dropping indexes. Sysadmin will need to manually intervene to revert to
301 * @param array $params
302 * 'updateChangedEngineConfig' - update if the engine config changes?
303 * 'forceEngineMigration' - force engine upgrade from ARCHIVE to InnoDB?
305 * @return int $updateTablesCount
306 * @throws \CiviCRM_API3_Exception
308 public function updateLogTableSchema($params) {
309 $updateLogConn = FALSE;
310 $updatedTablesCount = 0;
311 foreach ($this->logs
as $mainTable => $logTable) {
313 $tableSpec = $this->logTableSpec
[$mainTable];
314 $currentEngine = strtoupper($this->getEngineForLogTable($logTable));
315 if (!isset($tableSpec['engine']) && $currentEngine == 'ARCHIVE' && $params['forceEngineMigration']) {
316 // table uses ARCHIVE engine (the previous default) and no one set an
317 // alternative engine via hook_civicrm_alterLogTables => force change to
319 $tableSpec['engine'] = self
::ENGINE
;
321 $engineChanged = isset($tableSpec['engine']) && (strtoupper($tableSpec['engine']) != $currentEngine);
322 $engineConfigChanged = isset($tableSpec['engine_config']) && (strtoupper($tableSpec['engine_config']) != $this->getEngineConfigForLogTable($logTable));
323 if ($engineChanged ||
($engineConfigChanged && $params['updateChangedEngineConfig'])) {
324 $alterSql[] = "ENGINE=" . $tableSpec['engine'] . " " . CRM_Utils_Array
::value('engine_config', $tableSpec);
326 if (!empty($tableSpec['indexes'])) {
327 $indexes = $this->getIndexesForTable($logTable);
328 foreach ($tableSpec['indexes'] as $indexName => $indexSpec) {
329 if (!in_array($indexName, $indexes)) {
330 if (is_array($indexSpec)) {
331 $indexSpec = implode(" , ", $indexSpec);
333 $alterSql[] = "ADD INDEX {$indexName}($indexSpec)";
337 $columns = $this->columnSpecsOf($logTable);
338 if (empty($columns['log_conn_id'])) {
339 throw new Exception($logTable . print_r($columns, TRUE));
341 if ($columns['log_conn_id']['DATA_TYPE'] != 'varchar' ||
$columns['log_conn_id']['LENGTH'] != 17) {
342 $alterSql[] = "MODIFY log_conn_id VARCHAR(17)";
343 $updateLogConn = TRUE;
345 if (!empty($alterSql)) {
346 CRM_Core_DAO
::executeQuery("ALTER TABLE {$this->db}.{$logTable} " . implode(', ', $alterSql), [], TRUE, NULL, FALSE, FALSE);
347 $updatedTablesCount++
;
350 if ($updateLogConn) {
351 civicrm_api3('Setting', 'create', ['logging_uniqueid_date' => date('Y-m-d H:i:s')]);
353 return $updatedTablesCount;
357 * Get the engine for the given table.
359 * @param string $table
363 public function getEngineForLogTable($table) {
364 return strtoupper(CRM_Core_DAO
::singleValueQuery("
365 SELECT ENGINE FROM information_schema.tables WHERE TABLE_NAME = %1
366 AND table_schema = %2
367 ", [1 => [$table, 'String'], 2 => [$this->db
, 'String']]));
371 * Get the engine config for the given table.
373 * @param string $table
377 public function getEngineConfigForLogTable($table) {
378 return strtoupper(CRM_Core_DAO
::singleValueQuery("
379 SELECT CREATE_OPTIONS FROM information_schema.tables WHERE TABLE_NAME = %1
380 AND table_schema = %2
381 ", [1 => [$table, 'String'], 2 => [$this->db
, 'String']]));
385 * Get all the indexes in the table.
387 * @param string $table
391 public function getIndexesForTable($table) {
393 $result = CRM_Core_DAO
::executeQuery("
394 SELECT constraint_name AS index_name
395 FROM information_schema.key_column_usage
396 WHERE table_schema = %2 AND table_name = %1
398 SELECT index_name AS index_name
399 FROM information_schema.statistics
400 WHERE table_schema = %2 AND table_name = %1
402 [1 => [$table, 'String'], 2 => [$this->db
, 'String']]
404 while ($result->fetch()) {
405 $indexes[] = $result->index_name
;
411 * Add missing (potentially specified) log table columns for the given table.
413 * @param string $table
414 * name of the relevant table.
416 * Mixed array of columns to add or null (to check for the missing columns).
420 public function fixSchemaDifferencesFor($table, $cols = []) {
424 if (empty($this->logs
[$table])) {
425 $this->createLogTableFor($table);
430 $cols = $this->columnsWithDiffSpecs($table, "log_$table");
433 // If a column that already exists on logging table is being added, we
434 // should treat it as a modification.
435 $this->resetSchemaCacheForTable("log_$table");
436 $logTableSchema = $this->columnSpecsOf("log_$table");
437 foreach ($cols['ADD'] as $colKey => $col) {
438 if (array_key_exists($col, $logTableSchema)) {
439 $cols['MODIFY'][] = $col;
440 unset($cols['ADD'][$colKey]);
444 // use the relevant lines from CREATE TABLE to add colums to the log table
445 $create = $this->_getCreateQuery($table);
446 foreach ((['ADD', 'MODIFY']) as $alterType) {
447 if (!empty($cols[$alterType])) {
448 foreach ($cols[$alterType] as $col) {
449 $line = $this->_getColumnQuery($col, $create);
450 CRM_Core_DAO
::executeQuery("ALTER TABLE `{$this->db}`.log_$table {$alterType} {$line}", [], TRUE, NULL, FALSE, FALSE);
455 // for any obsolete columns (not null) we just make the column nullable.
456 if (!empty($cols['OBSOLETE'])) {
457 $create = $this->_getCreateQuery("`{$this->db}`.log_{$table}");
458 foreach ($cols['OBSOLETE'] as $col) {
459 $line = $this->_getColumnQuery($col, $create);
460 // This is just going to make a not null column to nullable
461 CRM_Core_DAO
::executeQuery("ALTER TABLE `{$this->db}`.log_$table MODIFY {$line}", [], TRUE, NULL, FALSE, FALSE);
465 $this->resetSchemaCacheForTable("log_$table");
471 * Resets schema cache for the given table.
473 * @param string $table
476 private function resetSchemaCacheForTable($table) {
477 unset(\Civi
::$statics[__CLASS__
]['columnSpecs'][$table]);
483 * @param string $table
487 private function _getCreateQuery($table) {
488 $dao = CRM_Core_DAO
::executeQuery("SHOW CREATE TABLE {$table}", [], TRUE, NULL, FALSE, FALSE);
490 $create = explode("\n", $dao->Create_Table
);
498 * @param bool $createQuery
500 * @return array|mixed|string
502 private function _getColumnQuery($col, $createQuery) {
503 $line = preg_grep("/^ `$col` /", $createQuery);
504 $line = rtrim(array_pop($line), ',');
506 $line = self
::fixTimeStampAndNotNullSQL($line);
511 * Fix schema differences.
513 * @param bool $rebuildTrigger
515 public function fixSchemaDifferencesForAll($rebuildTrigger = FALSE) {
517 $this->resetTableColumnsCache();
519 foreach ($this->tables
as $table) {
520 if (empty($this->logs
[$table])) {
521 $this->createLogTableFor($table);
524 $diffs[$table] = $this->columnsWithDiffSpecs($table, "log_$table");
528 foreach ($diffs as $table => $cols) {
529 $this->fixSchemaDifferencesFor($table, $cols);
531 if ($rebuildTrigger) {
532 // invoke the meta trigger creation call
533 CRM_Core_DAO
::triggerRebuild(NULL, TRUE);
538 * Resets columnSpecs.
540 * Resets columnSpecs static array in Civi's $statics to make sure we use the
541 * real state of the schema to perform sync operations between core and
544 private function resetTableColumnsCache() {
545 unset(\Civi
::$statics[__CLASS__
]['columnSpecs']);
551 * Log_civicrm_contact.modified_date for example would always be copied from civicrm_contact.modified_date,
552 * so there's no need for a default timestamp and therefore we remove such default timestamps
553 * also eliminate the NOT NULL constraint, since we always copy and schema can change down the road)
555 * @param string $query
559 public static function fixTimeStampAndNotNullSQL($query) {
560 $query = str_ireplace("TIMESTAMP() NOT NULL", "TIMESTAMP NULL", $query);
561 $query = str_ireplace("TIMESTAMP NOT NULL", "TIMESTAMP NULL", $query);
562 $query = str_ireplace("DEFAULT CURRENT_TIMESTAMP() ON UPDATE CURRENT_TIMESTAMP()", '', $query);
563 $query = str_ireplace("DEFAULT CURRENT_TIMESTAMP ON UPDATE CURRENT_TIMESTAMP", '', $query);
564 $query = str_ireplace("DEFAULT CURRENT_TIMESTAMP()", '', $query);
565 $query = str_ireplace("DEFAULT CURRENT_TIMESTAMP", '', $query);
566 $query = str_ireplace("NOT NULL", '', $query);
573 private function addReports() {
575 'logging/contact/detail' => ts('Logging Details'),
576 'logging/contact/summary' => ts('Contact Logging Report (Summary)'),
577 'logging/contribute/detail' => ts('Contribution Logging Report (Detail)'),
578 'logging/contribute/summary' => ts('Contribution Logging Report (Summary)'),
580 // enable logging templates
581 CRM_Core_DAO
::executeQuery("
582 UPDATE civicrm_option_value
584 WHERE value IN ('" . implode("', '", $this->reports
) . "')
587 // add report instances
588 $domain_id = CRM_Core_Config
::domainID();
589 foreach ($this->reports
as $report) {
590 $dao = new CRM_Report_DAO_ReportInstance();
591 $dao->domain_id
= $domain_id;
592 $dao->report_id
= $report;
593 $dao->title
= $titles[$report];
594 $dao->permission
= 'administer CiviCRM';
595 if ($report == 'logging/contact/summary') {
596 $dao->is_reserved
= 1;
603 * Get an array of column names of the given table.
605 * @param string $table
610 private function columnsOf($table, $force = FALSE) {
611 if ($force ||
!isset(\Civi
::$statics[__CLASS__
]['columnsOf'][$table])) {
612 $from = (substr($table, 0, 4) == 'log_') ?
"`{$this->db}`.$table" : $table;
613 CRM_Core_TemporaryErrorScope
::ignoreException();
614 $dao = CRM_Core_DAO
::executeQuery("SHOW COLUMNS FROM $from", [], TRUE, NULL, FALSE, FALSE);
615 if (is_a($dao, 'DB_Error')) {
618 \Civi
::$statics[__CLASS__
]['columnsOf'][$table] = [];
619 while ($dao->fetch()) {
620 \Civi
::$statics[__CLASS__
]['columnsOf'][$table][] = CRM_Utils_Type
::escape($dao->Field
, 'MysqlColumnNameOrAlias');
623 return \Civi
::$statics[__CLASS__
]['columnsOf'][$table];
627 * Get an array of columns and their details like DATA_TYPE, IS_NULLABLE, COLUMN_DEFAULT for the given table.
629 * @param string $table
633 private function columnSpecsOf($table) {
634 static $civiDB = NULL;
635 if (empty(\Civi
::$statics[__CLASS__
]['columnSpecs'])) {
636 \Civi
::$statics[__CLASS__
]['columnSpecs'] = [];
638 if (empty(\Civi
::$statics[__CLASS__
]['columnSpecs']) ||
!isset(\Civi
::$statics[__CLASS__
]['columnSpecs'][$table])) {
640 $dao = new CRM_Contact_DAO_Contact();
641 $civiDB = $dao->_database
;
643 CRM_Core_TemporaryErrorScope
::ignoreException();
644 // NOTE: W.r.t Performance using one query to find all details and storing in static array is much faster
645 // than firing query for every given table.
647 SELECT TABLE_SCHEMA, TABLE_NAME, COLUMN_NAME, DATA_TYPE, IS_NULLABLE, COLUMN_DEFAULT, COLUMN_TYPE, EXTRA
648 FROM INFORMATION_SCHEMA.COLUMNS
649 WHERE table_schema IN ('{$this->db}', '{$civiDB}')";
650 $dao = CRM_Core_DAO
::executeQuery($query);
651 if (is_a($dao, 'DB_Error')) {
654 while ($dao->fetch()) {
655 if (!array_key_exists($dao->TABLE_NAME
, \Civi
::$statics[__CLASS__
]['columnSpecs'])) {
656 \Civi
::$statics[__CLASS__
]['columnSpecs'][$dao->TABLE_NAME
] = [];
658 \Civi
::$statics[__CLASS__
]['columnSpecs'][$dao->TABLE_NAME
][$dao->COLUMN_NAME
] = [
659 'COLUMN_NAME' => $dao->COLUMN_NAME
,
660 'DATA_TYPE' => $dao->DATA_TYPE
,
661 'IS_NULLABLE' => $dao->IS_NULLABLE
,
662 'COLUMN_DEFAULT' => $dao->COLUMN_DEFAULT
,
663 'EXTRA' => $dao->EXTRA
,
665 if (($first = strpos($dao->COLUMN_TYPE
, '(')) != 0) {
666 // this extracts the value between parentheses after the column type.
667 // it could be the column length, i.e. "int(8)", "decimal(20,2)")
668 // or the permitted values of an enum (e.g. "enum('A','B')")
670 $dao->COLUMN_TYPE
, $first +
1, strpos($dao->COLUMN_TYPE
, ')') - $first - 1
672 if (strpos($parValue, "'") === FALSE) {
673 // no quote in value means column length
674 \Civi
::$statics[__CLASS__
]['columnSpecs'][$dao->TABLE_NAME
][$dao->COLUMN_NAME
]['LENGTH'] = $parValue;
677 // single quote means enum permitted values
678 \Civi
::$statics[__CLASS__
]['columnSpecs'][$dao->TABLE_NAME
][$dao->COLUMN_NAME
]['ENUM_VALUES'] = $parValue;
683 return \Civi
::$statics[__CLASS__
]['columnSpecs'][$table];
687 * Get columns that have changed.
689 * @param string $civiTable
690 * @param string $logTable
694 public function columnsWithDiffSpecs($civiTable, $logTable) {
695 $civiTableSpecs = $this->columnSpecsOf($civiTable);
696 $logTableSpecs = $this->columnSpecsOf($logTable);
698 $diff = ['ADD' => [], 'MODIFY' => [], 'OBSOLETE' => []];
699 // columns to be added
700 $diff['ADD'] = array_diff(array_keys($civiTableSpecs), array_keys($logTableSpecs));
701 // columns to be modified
702 // NOTE: we consider only those columns for modifications where there is a spec change, and that the column definition
703 // wasn't deliberately modified by fixTimeStampAndNotNullSQL() method.
704 foreach ($civiTableSpecs as $col => $colSpecs) {
705 if (!isset($logTableSpecs[$col]) ||
!is_array($logTableSpecs[$col])) {
706 $logTableSpecs[$col] = [];
708 $specDiff = array_diff($civiTableSpecs[$col], $logTableSpecs[$col]);
709 if (!empty($specDiff) && $col != 'id' && !in_array($col, $diff['ADD'])) {
710 if (empty($colSpecs['EXTRA']) ||
(!empty($colSpecs['EXTRA']) && $colSpecs['EXTRA'] !== 'auto_increment')) {
711 // ignore 'id' column for any spec changes, to avoid any auto-increment mysql errors
712 if ($civiTableSpecs[$col]['DATA_TYPE'] != CRM_Utils_Array
::value('DATA_TYPE', $logTableSpecs[$col])
713 // We won't alter the log if the length is decreased in case some of the existing data won't fit.
714 || CRM_Utils_Array
::value('LENGTH', $civiTableSpecs[$col]) > CRM_Utils_Array
::value('LENGTH', $logTableSpecs[$col])
716 // if data-type is different, surely consider the column
717 $diff['MODIFY'][] = $col;
719 elseif ($civiTableSpecs[$col]['DATA_TYPE'] == 'enum' &&
720 CRM_Utils_Array
::value('ENUM_VALUES', $civiTableSpecs[$col]) != CRM_Utils_Array
::value('ENUM_VALUES', $logTableSpecs[$col])
722 // column is enum and the permitted values have changed
723 $diff['MODIFY'][] = $col;
725 elseif ($civiTableSpecs[$col]['IS_NULLABLE'] != CRM_Utils_Array
::value('IS_NULLABLE', $logTableSpecs[$col]) &&
726 $logTableSpecs[$col]['IS_NULLABLE'] == 'NO'
728 // if is-null property is different, and log table's column is NOT-NULL, surely consider the column
729 $diff['MODIFY'][] = $col;
731 elseif ($civiTableSpecs[$col]['COLUMN_DEFAULT'] != CRM_Utils_Array
::value('COLUMN_DEFAULT', $logTableSpecs[$col]) &&
732 !strstr($civiTableSpecs[$col]['COLUMN_DEFAULT'], 'TIMESTAMP')
734 // if default property is different, and its not about a timestamp column, consider it
735 $diff['MODIFY'][] = $col;
741 // columns to made obsolete by turning into not-null
742 $oldCols = array_diff(array_keys($logTableSpecs), array_keys($civiTableSpecs));
743 foreach ($oldCols as $col) {
744 if (!in_array($col, ['log_date', 'log_conn_id', 'log_user_id', 'log_action']) &&
745 $logTableSpecs[$col]['IS_NULLABLE'] == 'NO'
747 // if its a column present only in log table, not among those used by log tables for special purpose, and not-null
748 $diff['OBSOLETE'][] = $col;
756 * Getter for logTableSpec.
760 public function getLogTableSpec() {
761 return $this->logTableSpec
;
765 * Create a log table with schema mirroring the given table’s structure and seeding it with the given table’s contents.
767 * @param string $table
769 private function createLogTableFor($table) {
770 $dao = CRM_Core_DAO
::executeQuery("SHOW CREATE TABLE $table", [], TRUE, NULL, FALSE, FALSE);
772 $query = $dao->Create_Table
;
774 // rewrite the queries into CREATE TABLE queries for log tables:
777 log_date TIMESTAMP NOT NULL DEFAULT CURRENT_TIMESTAMP,
778 log_conn_id VARCHAR(17),
780 log_action ENUM('Initialization', 'Insert', 'Update', 'Delete')
783 if (!empty($this->logTableSpec
[$table]['indexes'])) {
784 foreach ($this->logTableSpec
[$table]['indexes'] as $indexName => $indexSpec) {
785 if (is_array($indexSpec)) {
786 $indexSpec = implode(" , ", $indexSpec);
788 $cols .= ", INDEX {$indexName}($indexSpec)";
792 // - prepend the name with log_
793 // - drop AUTO_INCREMENT columns
794 // - drop non-column rows of the query (keys, constraints, etc.)
795 // - set the ENGINE to the specified engine (default is INNODB)
796 // - add log-specific columns (at the end of the table)
798 $engines = CRM_Core_DAO
::executeQuery("SHOW ENGINES");
799 while ($engines->fetch()) {
800 if ($engines->Support
== 'YES' ||
$engines->Support
== 'DEFAULT') {
801 $mysqlEngines[] = $engines->Engine
;
804 $query = preg_replace("/^CREATE TABLE `$table`/i", "CREATE TABLE `{$this->db}`.log_$table", $query);
805 $query = preg_replace("/ AUTO_INCREMENT/i", '', $query);
806 $query = preg_replace("/^ [^`].*$/m", '', $query);
807 $engine = strtoupper(CRM_Utils_Array
::value('engine', $this->logTableSpec
[$table], self
::ENGINE
));
808 $engine .= " " . CRM_Utils_Array
::value('engine_config', $this->logTableSpec
[$table]);
809 $query = preg_replace("/^\) ENGINE=[^ ]+ /im", ') ENGINE=' . $engine . ' ', $query);
811 // log_civicrm_contact.modified_date for example would always be copied from civicrm_contact.modified_date,
812 // so there's no need for a default timestamp and therefore we remove such default timestamps
813 // also eliminate the NOT NULL constraint, since we always copy and schema can change down the road)
814 $query = self
::fixTimeStampAndNotNullSQL($query);
815 $query = preg_replace("/(,*\n*\) )ENGINE/m", "$cols\n) ENGINE", $query);
817 CRM_Core_DAO
::executeQuery($query, [], TRUE, NULL, FALSE, FALSE);
819 $columns = implode(', ', $this->columnsOf($table));
820 CRM_Core_DAO
::executeQuery("INSERT INTO `{$this->db}`.log_$table ($columns, log_conn_id, log_user_id, log_action) SELECT $columns, @uniqueID, @civicrm_user_id, 'Initialization' FROM {$table}", [], TRUE, NULL, FALSE, FALSE);
822 $this->tables
[] = $table;
823 if (empty($this->logs
)) {
824 civicrm_api3('Setting', 'create', ['logging_uniqueid_date' => date('Y-m-d H:i:s')]);
825 civicrm_api3('Setting', 'create', ['logging_all_tables_uniquid' => 1]);
827 $this->logs
[$table] = "log_$table";
833 private function deleteReports() {
834 // disable logging templates
835 CRM_Core_DAO
::executeQuery("
836 UPDATE civicrm_option_value
838 WHERE value IN ('" . implode("', '", $this->reports
) . "')
841 // delete report instances
842 $domain_id = CRM_Core_Config
::domainID();
843 foreach ($this->reports
as $report) {
844 $dao = new CRM_Report_DAO_ReportInstance();
845 $dao->domain_id
= $domain_id;
846 $dao->report_id
= $report;
852 * Predicate whether logging is enabled.
854 public function isEnabled() {
855 if (\Civi
::settings()->get('logging')) {
856 return ($this->tablesExist() && (\Civi
::settings()->get('logging_no_trigger_permission') ||
$this->triggersExist()));
862 * Predicate whether any log tables exist.
864 private function tablesExist() {
865 return !empty($this->logs
);
869 * Drop all log tables.
871 * This does not currently have a usage outside the tests.
873 public function dropAllLogTables() {
874 if ($this->tablesExist()) {
875 foreach ($this->logs
as $log_table) {
876 CRM_Core_DAO
::executeQuery("DROP TABLE $log_table");
882 * Get an sql clause to find the names of any log tables that do not match the normal pattern.
884 * Most tables are civicrm_xxx with the log table being log_civicrm_xxx
885 * However, they don't have to match this pattern (e.g when defined by hook) so find the
886 * anomalies and return a filter string to include them.
890 public function getNonStandardTableNameFilterString() {
891 $nonStandardTableNames = preg_grep('/^civicrm_/', $this->tables
, PREG_GREP_INVERT
);
892 if (empty($nonStandardTableNames)) {
895 $nonStandardTableLogs = [];
896 foreach ($nonStandardTableNames as $nonStandardTableName) {
897 $nonStandardTableLogs[] = "'log_{$nonStandardTableName}'";
899 return " OR TABLE_NAME IN (" . implode(',', $nonStandardTableLogs) . ")";
903 * Predicate whether the logging triggers are in place.
905 private function triggersExist() {
906 // FIXME: probably should be a bit more thorough…
907 // note that the LIKE parameter is TABLE NAME
908 return (bool) CRM_Core_DAO
::singleValueQuery("SHOW TRIGGERS LIKE 'civicrm_contact'");
915 * @param null $tableName
918 public function triggerInfo(&$info, $tableName = NULL, $force = FALSE) {
919 if (!CRM_Core_Config
::singleton()->logging
) {
923 $insert = ['INSERT'];
924 $update = ['UPDATE'];
925 $delete = ['DELETE'];
928 $tableNames = [$tableName];
931 $tableNames = $this->tables
;
934 // logging is enabled, so now lets create the trigger info tables
935 foreach ($tableNames as $table) {
936 if (!isset($this->logTableSpec
[$table])) {
937 // Per testIgnoreCustomTableByHook this would be unset if a hook had
938 // intervened to prevent logging / triggers on this table.
939 // This could go to the extent of blocking the updates to 'modified_date'
940 // which makes sense, in particular, for calculated fields.
943 $columns = $this->columnsOf($table, $force);
945 // only do the change if any data has changed
947 foreach ($columns as $column) {
948 $tableExceptions = array_key_exists('exceptions', $this->logTableSpec
[$table]) ?
$this->logTableSpec
[$table]['exceptions'] : [];
949 // ignore modified_date changes
950 $tableExceptions[] = 'modified_date';
951 // exceptions may be provided with or without backticks
952 $excludeColumn = in_array($column, $tableExceptions) ||
953 in_array(str_replace('`', '', $column), $tableExceptions);
954 if (!$excludeColumn) {
955 $cond[] = "IFNULL(OLD.$column,'') <> IFNULL(NEW.$column,'')";
958 $suppressLoggingCond = "@civicrm_disable_logging IS NULL OR @civicrm_disable_logging = 0";
959 $updateSQL = "IF ( (" . implode(' OR ', $cond) . ") AND ( $suppressLoggingCond ) ) THEN ";
961 if ($this->useDBPrefix
) {
962 $sqlStmt = "INSERT INTO `{$this->db}`.log_{tableName} (";
965 $sqlStmt = "INSERT INTO log_{tableName} (";
967 foreach ($columns as $column) {
968 $sqlStmt .= "$column, ";
970 $sqlStmt .= "log_conn_id, log_user_id, log_action) VALUES (";
972 $insertSQL = $deleteSQL = "IF ( $suppressLoggingCond ) THEN $sqlStmt ";
973 $updateSQL .= $sqlStmt;
976 foreach ($columns as $column) {
977 $sqlStmt .= "NEW.$column, ";
978 $deleteSQL .= "OLD.$column, ";
980 if (civicrm_api3('Setting', 'getvalue', ['name' => 'logging_uniqueid_date'])) {
981 // Note that when connecting directly via mysql @uniqueID may not be set so a fallback is
982 // 'c_' to identify a non-CRM connection + timestamp to the hour + connection_id
983 // If the connection_id is longer than 6 chars it will be truncated.
984 // We tried setting the @uniqueID in the trigger but it was unreliable.
985 // An external interaction could split over 2 connections & it seems worth blocking the revert on
986 // these reports & adding extra permissioning to the api for this.
987 $connectionSQLString = "COALESCE(@uniqueID, LEFT(CONCAT('c_', unix_timestamp()/3600, CONNECTION_ID()), 17))";
990 // The log tables have not yet been converted to have varchar(17) fields for log_conn_id.
991 // Continue to use the less reliable connection_id for al tables for now.
992 $connectionSQLString = "CONNECTION_ID()";
994 $sqlStmt .= $connectionSQLString . ", @civicrm_user_id, '{eventName}'); END IF;";
995 $deleteSQL .= $connectionSQLString . ", @civicrm_user_id, '{eventName}'); END IF;";
997 $insertSQL .= $sqlStmt;
998 $updateSQL .= $sqlStmt;
1001 'table' => [$table],
1004 'sql' => $insertSQL,
1008 'table' => [$table],
1011 'sql' => $updateSQL,
1015 'table' => [$table],
1018 'sql' => $deleteSQL,
1024 * Disable logging temporarily.
1026 * This allow logging to be temporarily disabled for certain cases
1027 * where we want to do a mass cleanup but do not want to bother with
1030 public static function disableLoggingForThisConnection() {
1031 if (CRM_Core_Config
::singleton()->logging
) {
1032 CRM_Core_DAO
::executeQuery('SET @civicrm_disable_logging = 1');
1037 * Get all the log tables that reference civicrm_contact.
1039 * Note that it might make sense to wrap this in a getLogTablesForEntity
1040 * but this is the only entity currently available...
1042 public function getLogTablesForContact() {
1043 $tables = array_keys(CRM_Core_DAO
::getReferencesToContactTable());
1044 return array_intersect($tables, $this->tables
);
1048 * Retrieve missing log tables.
1052 public function getMissingLogTables() {
1053 if ($this->tablesExist()) {
1054 return array_diff($this->tables
, array_keys($this->logs
));