3 +--------------------------------------------------------------------+
5 +--------------------------------------------------------------------+
6 | Copyright CiviCRM LLC (c) 2004-2018 |
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-2018
35 * This file contains functions for creating and altering CiviCRM-tables structure.
38 * 'name' => TABLE_NAME,
39 * 'attributes' => ATTRIBUTES,
42 * 'name' => FIELD_NAME,
43 * // can be field, index, constraint
44 * 'type' => FIELD_SQL_TYPE,
45 * 'class' => FIELD_CLASS_TYPE,
46 * 'primary' => BOOLEAN,
47 * 'required' => BOOLEAN,
48 * 'searchable' => TRUE,
49 * 'fk_table_name' => FOREIGN_KEY_TABLE_NAME,
50 * 'fk_field_name' => FOREIGN_KEY_FIELD_NAME,
51 * 'comment' => COMMENT,
52 * 'default' => DEFAULT, )
56 class CRM_Core_BAO_SchemaHandler
{
59 * Create a CiviCRM-table
61 * @param array $params
64 * TRUE if successfully created, FALSE otherwise
67 public static function createTable(&$params) {
68 $sql = self
::buildTableSQL($params);
69 // do not i18n-rewrite
70 $dao = CRM_Core_DAO
::executeQuery($sql, array(), TRUE, NULL, FALSE, FALSE);
73 $config = CRM_Core_Config
::singleton();
74 if ($config->logging
) {
76 $logging = new CRM_Logging_Schema();
77 $logging->fixSchemaDifferencesFor($params['name'], NULL, FALSE);
80 // always do a trigger rebuild for this table
81 CRM_Core_DAO
::triggerRebuild($params['name']);
87 * @param array $params
91 public static function buildTableSQL(&$params) {
92 $sql = "CREATE TABLE {$params['name']} (";
93 if (isset($params['fields']) &&
94 is_array($params['fields'])
98 foreach ($params['fields'] as $field) {
99 $sql .= self
::buildFieldSQL($field, $separator, $prefix);
102 foreach ($params['fields'] as $field) {
103 $sql .= self
::buildPrimaryKeySQL($field, $separator, $prefix);
105 foreach ($params['fields'] as $field) {
106 $sql .= self
::buildSearchIndexSQL($field, $separator, $prefix);
108 if (isset($params['indexes'])) {
109 foreach ($params['indexes'] as $index) {
110 $sql .= self
::buildIndexSQL($index, $separator, $prefix);
113 foreach ($params['fields'] as $field) {
114 $sql .= self
::buildForeignKeySQL($field, $separator, $prefix, $params['name']);
117 $sql .= "\n) {$params['attributes']};";
122 * @param array $params
128 public static function buildFieldSQL(&$params, $separator, $prefix) {
131 $sql .= str_repeat(' ', 8);
133 $sql .= "`{$params['name']}` {$params['type']}";
135 if (!empty($params['required'])) {
139 if (!empty($params['attributes'])) {
140 $sql .= " {$params['attributes']}";
143 if (!empty($params['default']) &&
144 $params['type'] != 'text'
146 $sql .= " DEFAULT {$params['default']}";
149 if (!empty($params['comment'])) {
150 $sql .= " COMMENT '{$params['comment']}'";
157 * @param array $params
161 * @return NULL|string
163 public static function buildPrimaryKeySQL(&$params, $separator, $prefix) {
165 if (!empty($params['primary'])) {
167 $sql .= str_repeat(' ', 8);
169 $sql .= "PRIMARY KEY ( {$params['name']} )";
175 * @param array $params
178 * @param bool $indexExist
180 * @return NULL|string
182 public static function buildSearchIndexSQL(&$params, $separator, $prefix, $indexExist = FALSE) {
186 if ($params['type'] == 'text') {
190 //create index only for searchable fields during ADD,
191 //create index only if field is become searchable during MODIFY,
192 //drop index only if field is no longer searchable and it does not reference
193 //a forgein key (and indexExist is true)
194 if (!empty($params['searchable']) && !$indexExist) {
196 $sql .= str_repeat(' ', 8);
198 $sql .= "INDEX_{$params['name']} ( {$params['name']} )";
200 elseif (empty($params['searchable']) && empty($params['fk_table_name']) && $indexExist) {
202 $sql .= str_repeat(' ', 8);
203 $sql .= "DROP INDEX INDEX_{$params['name']}";
209 * @param array $params
215 public static function buildIndexSQL(&$params, $separator, $prefix) {
218 $sql .= str_repeat(' ', 8);
219 if ($params['unique']) {
220 $sql .= 'UNIQUE INDEX';
221 $indexName = 'unique';
225 $indexName = 'index';
229 foreach ($params as $name => $value) {
230 if (substr($name, 0, 11) == 'field_name_') {
231 $indexName .= "_{$value}";
232 $indexFields .= " $value,";
235 $indexFields = substr($indexFields, 0, -1);
237 $sql .= " $indexName ( $indexFields )";
242 * @param string $tableName
243 * @param string $fkTableName
247 public static function changeFKConstraint($tableName, $fkTableName) {
248 $fkName = "{$tableName}_entity_id";
249 if (strlen($fkName) >= 48) {
250 $fkName = substr($fkName, 0, 32) . "_" . substr(md5($fkName), 0, 16);
253 ALTER TABLE {$tableName}
254 DROP FOREIGN KEY `FK_{$fkName}`;";
256 $dao = CRM_Core_DAO
::executeQuery($dropFKSql);
260 ALTER TABLE {$tableName}
261 ADD CONSTRAINT `FK_{$fkName}` FOREIGN KEY (`entity_id`) REFERENCES {$fkTableName} (`id`) ON DELETE CASCADE;";
262 // CRM-7007: do not i18n-rewrite this query
263 $dao = CRM_Core_DAO
::executeQuery($addFKSql, array(), TRUE, NULL, FALSE, FALSE);
270 * @param array $params
273 * @param string $tableName
275 * @return NULL|string
277 public static function buildForeignKeySQL(&$params, $separator, $prefix, $tableName) {
279 if (!empty($params['fk_table_name']) && !empty($params['fk_field_name'])) {
281 $sql .= str_repeat(' ', 8);
283 $fkName = "{$tableName}_{$params['name']}";
284 if (strlen($fkName) >= 48) {
285 $fkName = substr($fkName, 0, 32) . "_" . substr(md5($fkName), 0, 16);
288 $sql .= "CONSTRAINT FK_$fkName FOREIGN KEY ( `{$params['name']}` ) REFERENCES {$params['fk_table_name']} ( {$params['fk_field_name']} ) ";
289 $sql .= CRM_Utils_Array
::value('fk_attributes', $params);
295 * @param array $params
296 * @param bool $indexExist
297 * @param bool $triggerRebuild
301 public static function alterFieldSQL(&$params, $indexExist = FALSE, $triggerRebuild = TRUE) {
302 $sql = str_repeat(' ', 8);
303 $sql .= "ALTER TABLE {$params['table_name']}";
305 // lets suppress the required flag, since that can cause sql issue
306 $params['required'] = FALSE;
308 switch ($params['operation']) {
312 $sql .= self
::buildFieldSQL($params, $separator, "ADD COLUMN ");
314 $sql .= self
::buildPrimaryKeySQL($params, $separator, "ADD PRIMARY KEY ");
315 $sql .= self
::buildSearchIndexSQL($params, $separator, "ADD INDEX ");
316 $sql .= self
::buildForeignKeySQL($params, $separator, "ADD ", $params['table_name']);
322 $sql .= self
::buildFieldSQL($params, $separator, $prefix);
324 $sql .= self
::buildSearchIndexSQL($params, $separator, "ADD INDEX ", $indexExist);
328 $sql .= " DROP COLUMN `{$params['name']}`";
329 if (!empty($params['primary'])) {
330 $sql .= ", DROP PRIMARY KEY";
332 if (!empty($params['fk_table_name'])) {
333 $sql .= ", DROP FOREIGN KEY FK_{$params['fkName']}";
338 // CRM-7007: do not i18n-rewrite this query
339 $dao = CRM_Core_DAO
::executeQuery($sql, array(), TRUE, NULL, FALSE, FALSE);
342 $config = CRM_Core_Config
::singleton();
343 if ($config->logging
) {
344 // CRM-16717 not sure why this was originally limited to add.
345 // For example custom tables can have field length changes - which need to flow through to logging.
346 // Are there any modifies we DON'T was to call this function for (& shouldn't it be clever enough to cope?)
347 if ($params['operation'] == 'add' ||
$params['operation'] == 'modify') {
348 $logging = new CRM_Logging_Schema();
349 $logging->fixSchemaDifferencesFor($params['table_name'], array(trim($prefix) => array($params['name'])), FALSE);
353 if ($triggerRebuild) {
354 CRM_Core_DAO
::triggerRebuild($params['table_name']);
361 * Delete a CiviCRM-table.
363 * @param string $tableName
364 * Name of the table to be created.
366 public static function dropTable($tableName) {
367 $sql = "DROP TABLE $tableName";
368 CRM_Core_DAO
::executeQuery($sql);
372 * @param string $tableName
373 * @param string $columnName
375 * @param bool $isUpgradeMode
378 public static function dropColumn($tableName, $columnName, $l18n = FALSE, $isUpgradeMode = FALSE) {
379 if (self
::checkIfFieldExists($tableName, $columnName)) {
380 $sql = "ALTER TABLE $tableName DROP COLUMN $columnName";
382 CRM_Core_DAO
::executeQuery($sql);
385 CRM_Core_DAO
::executeQuery($sql, array(), TRUE, NULL, FALSE, FALSE);
387 $domain = new CRM_Core_DAO_Domain();
389 if ($domain->locales
) {
390 $locales = explode(CRM_Core_DAO
::VALUE_SEPARATOR
, $domain->locales
);
391 CRM_Core_I18n_Schema
::rebuildMultilingualSchema($locales, NULL, $isUpgradeMode);
397 * @param string $tableName
398 * @param bool $dropUnique
400 public static function changeUniqueToIndex($tableName, $dropUnique = TRUE) {
402 $sql = "ALTER TABLE $tableName
403 DROP INDEX `unique_entity_id` ,
404 ADD INDEX `FK_{$tableName}_entity_id` ( `entity_id` )";
407 $sql = " ALTER TABLE $tableName
408 DROP INDEX `FK_{$tableName}_entity_id` ,
409 ADD UNIQUE INDEX `unique_entity_id` ( `entity_id` )";
411 CRM_Core_DAO
::executeQuery($sql);
418 * Tables to create index for in the format:
419 * array('civicrm_entity_table' => 'entity_id')
421 * array('civicrm_entity_table' => array('entity_id', 'entity_table'))
422 * The latter will create a combined index on the 2 keys (in order).
424 * Side note - when creating combined indexes the one with the most variation
425 * goes first - so entity_table always goes after entity_id.
427 * It probably makes sense to consider more sophisticated options at some point
428 * but at the moment this is only being as enhanced as fast as the test is.
430 * @todo add support for length & multilingual on combined keys.
432 * @param string $createIndexPrefix
433 * @param array $substrLengths
435 public static function createIndexes($tables, $createIndexPrefix = 'index', $substrLengths = array()) {
437 $domain = new CRM_Core_DAO_Domain();
439 $locales = explode(CRM_Core_DAO
::VALUE_SEPARATOR
, $domain->locales
);
441 // if we're multilingual, cache the information on internationalised fields
442 static $columns = NULL;
443 if (!CRM_Utils_System
::isNull($locales) and $columns === NULL) {
444 $columns = CRM_Core_I18n_SchemaStructure
::columns();
447 foreach ($tables as $table => $fields) {
448 $query = "SHOW INDEX FROM $table";
449 $dao = CRM_Core_DAO
::executeQuery($query);
451 $currentIndexes = array();
452 while ($dao->fetch()) {
453 $currentIndexes[] = $dao->Key_name
;
456 // now check for all fields if the index exists
457 foreach ($fields as $field) {
458 $fieldName = implode('_', (array) $field);
460 if (is_array($field)) {
461 // No support for these for combined indexes as yet - add a test when you
467 // handle indices over substrings, CRM-6245
468 // $lengthName is appended to index name, $lengthSize is the field size modifier
469 $lengthName = isset($substrLengths[$table][$fieldName]) ?
"_{$substrLengths[$table][$fieldName]}" : '';
470 $lengthSize = isset($substrLengths[$table][$fieldName]) ?
"({$substrLengths[$table][$fieldName]})" : '';
474 "index_{$fieldName}{$lengthName}",
475 "FK_{$table}_{$fieldName}{$lengthName}",
476 "UI_{$fieldName}{$lengthName}",
477 "{$createIndexPrefix}_{$fieldName}{$lengthName}",
480 // skip to the next $field if one of the above $names exists; handle multilingual for CRM-4126
481 foreach ($names as $name) {
482 $regex = '/^' . preg_quote($name) . '(_[a-z][a-z]_[A-Z][A-Z])?$/';
483 if (preg_grep($regex, $currentIndexes)) {
488 // the index doesn't exist, so create it
489 // if we're multilingual and the field is internationalised, do it for every locale
490 // @todo remove is_array check & add multilingual support for combined indexes and add a test.
491 // Note combined indexes currently using this function are on fields like
492 // entity_id + entity_table which are not multilingual.
493 if (!is_array($field) && !CRM_Utils_System
::isNull($locales) and isset($columns[$table][$fieldName])) {
494 foreach ($locales as $locale) {
495 $queries[] = "CREATE INDEX {$createIndexPrefix}_{$fieldName}{$lengthName}_{$locale} ON {$table} ({$fieldName}_{$locale}{$lengthSize})";
499 $queries[] = "CREATE INDEX {$createIndexPrefix}_{$fieldName}{$lengthName} ON {$table} (" . implode(',', (array) $field) . "{$lengthSize})";
504 // run the queries without i18n-rewriting
505 $dao = new CRM_Core_DAO();
506 foreach ($queries as $query) {
507 $dao->query($query, FALSE);
512 * Get indexes for tables
513 * @param array $tables
514 * array of table names to find indexes for
516 * @return array('tableName' => array('index1', 'index2'))
518 public static function getIndexes($tables) {
520 foreach ($tables as $table) {
521 $query = "SHOW INDEX FROM $table";
522 $dao = CRM_Core_DAO
::executeQuery($query);
524 $tableIndexes = array();
525 while ($dao->fetch()) {
526 $tableIndexes[$dao->Key_name
]['name'] = $dao->Key_name
;
527 $tableIndexes[$dao->Key_name
]['field'][] = $dao->Column_name
.
528 ($dao->Sub_part ?
'(' . $dao->Sub_part
. ')' : '');
529 $tableIndexes[$dao->Key_name
]['unique'] = ($dao->Non_unique
== 0 ?
1 : 0);
531 $indexes[$table] = $tableIndexes;
538 * Drop an index if one by that name exists.
540 * @param string $tableName
541 * @param string $indexName
543 public static function dropIndexIfExists($tableName, $indexName) {
544 if (self
::checkIfIndexExists($tableName, $indexName)) {
545 CRM_Core_DAO
::executeQuery("DROP INDEX $indexName ON $tableName");
550 * @param int $customFieldID
551 * @param string $tableName
552 * @param string $columnName
557 public static function alterFieldLength($customFieldID, $tableName, $columnName, $length) {
558 // first update the custom field tables
560 UPDATE civicrm_custom_field
565 1 => array($length, 'Integer'),
566 2 => array($customFieldID, 'Integer'),
568 CRM_Core_DAO
::executeQuery($sql, $params);
571 SELECT is_required, default_value
572 FROM civicrm_custom_field
575 $dao = CRM_Core_DAO
::executeQuery($sql, $params);
580 if ($dao->is_required
) {
581 $clause = " NOT NULL";
584 if (!empty($dao->default_value
)) {
585 $clause .= " DEFAULT '{$dao->default_value}'";
587 // now modify the column
589 ALTER TABLE {$tableName}
590 MODIFY {$columnName} varchar( $length )
593 CRM_Core_DAO
::executeQuery($sql);
596 CRM_Core_Error
::fatal(ts('Could Not Find Custom Field Details for %1, %2, %3',
607 * Check if the table has an index matching the name.
609 * @param string $tableName
610 * @param array $indexName
614 public static function checkIfIndexExists($tableName, $indexName) {
615 $result = CRM_Core_DAO
::executeQuery(
616 "SHOW INDEX FROM $tableName WHERE key_name = %1 AND seq_in_index = 1",
617 array(1 => array($indexName, 'String'))
619 if ($result->fetch()) {
626 * Check if the table has a specified column.
628 * @param string $tableName
629 * @param string $columnName
630 * @param bool $i18nRewrite
631 * Whether to rewrite the query on multilingual setups.
635 public static function checkIfFieldExists($tableName, $columnName, $i18nRewrite = TRUE) {
636 $query = "SHOW COLUMNS FROM $tableName LIKE '%1'";
637 $dao = CRM_Core_DAO
::executeQuery($query, [1 => [$columnName, 'Alphanumeric']], TRUE, NULL, FALSE, $i18nRewrite);
638 $result = $dao->fetch() ?
TRUE : FALSE;
644 * Check if a foreign key Exists
645 * @param string $table_name
646 * @param string $constraint_name
647 * @return bool TRUE if FK is found
649 public static function checkFKExists($table_name, $constraint_name) {
650 $config = CRM_Core_Config
::singleton();
651 $dbUf = DB
::parseDSN($config->dsn
);
653 SELECT CONSTRAINT_NAME FROM INFORMATION_SCHEMA.TABLE_CONSTRAINTS
654 WHERE TABLE_SCHEMA = %1
656 AND CONSTRAINT_NAME = %3
657 AND CONSTRAINT_TYPE = 'FOREIGN KEY'
660 1 => array($dbUf['database'], 'String'),
661 2 => array($table_name, 'String'),
662 3 => array($constraint_name, 'String'),
664 $dao = CRM_Core_DAO
::executeQuery($query, $params);
673 * Remove a foreign key from a table if it exists.
676 * @param $constraint_name
680 public static function safeRemoveFK($table_name, $constraint_name) {
681 if (self
::checkFKExists($table_name, $constraint_name)) {
682 CRM_Core_DAO
::executeQuery("ALTER TABLE {$table_name} DROP FOREIGN KEY {$constraint_name}", array());
689 * Add index signature hash to DAO file calculation.
691 * @param string $table table name
692 * @param array $indices index array spec
694 public static function addIndexSignature($table, &$indices) {
695 foreach ($indices as $indexName => $index) {
696 $indices[$indexName]['sig'] = $table . "::" .
697 (array_key_exists('unique', $index) ?
$index['unique'] : 0) . "::" .
698 implode("::", $index['field']);
703 * Compare the indices specified in the XML files with those in the DB.
705 * @param bool $dropFalseIndices
706 * If set - this function deletes false indices present in the DB which mismatches the expected
707 * values of xml file so that civi re-creates them with correct values using createMissingIndices() function.
710 * index specifications
712 public static function getMissingIndices($dropFalseIndices = FALSE) {
713 $requiredSigs = $existingSigs = array();
714 // Get the indices defined (originally) in the xml files
715 $requiredIndices = CRM_Core_DAO_AllCoreTables
::indices();
717 foreach ($requiredIndices as $table => $indices) {
718 $reqSigs[] = CRM_Utils_Array
::collect('sig', $indices);
720 CRM_Utils_Array
::flatten($reqSigs, $requiredSigs);
722 // Get the indices in the database
723 $existingIndices = CRM_Core_BAO_SchemaHandler
::getIndexes(array_keys($requiredIndices));
725 foreach ($existingIndices as $table => $indices) {
726 CRM_Core_BAO_SchemaHandler
::addIndexSignature($table, $indices);
727 $extSigs[] = CRM_Utils_Array
::collect('sig', $indices);
729 CRM_Utils_Array
::flatten($extSigs, $existingSigs);
732 $missingSigs = array_diff($requiredSigs, $existingSigs);
734 //CRM-20774 - Drop index key which exist in db but the value varies.
735 $existingKeySigs = array_intersect_key($missingSigs, $existingSigs);
736 if ($dropFalseIndices && !empty($existingKeySigs)) {
737 foreach ($existingKeySigs as $sig) {
738 $sigParts = explode('::', $sig);
739 foreach ($requiredIndices[$sigParts[0]] as $index) {
740 if ($index['sig'] == $sig && !empty($index['name'])) {
741 self
::dropIndexIfExists($sigParts[0], $index['name']);
748 // Get missing indices
749 $missingIndices = array();
750 foreach ($missingSigs as $sig) {
751 $sigParts = explode('::', $sig);
752 if (array_key_exists($sigParts[0], $requiredIndices)) {
753 foreach ($requiredIndices[$sigParts[0]] as $index) {
754 if ($index['sig'] == $sig) {
755 $missingIndices[$sigParts[0]][] = $index;
761 return $missingIndices;
765 * Create missing indices.
767 * @param array $missingIndices as returned by getMissingIndices()
769 public static function createMissingIndices($missingIndices) {
771 foreach ($missingIndices as $table => $indexList) {
772 foreach ($indexList as $index) {
773 $queries[] = "CREATE " .
774 (array_key_exists('unique', $index) && $index['unique'] ?
'UNIQUE ' : '') .
775 "INDEX {$index['name']} ON {$table} (" .
776 implode(", ", $index['field']) .
781 /* FIXME potential problem if index name already exists, so check before creating */
782 $dao = new CRM_Core_DAO();
783 foreach ($queries as $query) {
784 $dao->query($query, FALSE);