3 +--------------------------------------------------------------------+
4 | CiviCRM version 4.5 |
5 +--------------------------------------------------------------------+
6 | Copyright CiviCRM LLC (c) 2004-2014 |
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-2014
37 * This file contains functions for creating and altering CiviCRM-tables.
41 * structure, similar to what is used in GenCode.php
45 * 'attributes' => ATTRIBUTES,
49 * 'type' => FIELD_SQL_TYPE,
50 // can be field, index, constraint
51 * 'class' => FIELD_CLASS_TYPE,
52 * 'primary' => BOOLEAN,
53 * 'required' => BOOLEAN,
54 * 'searchable' => true,
55 * 'fk_table_name' => FOREIGN_KEY_TABLE_NAME,
56 * 'fk_field_name' => FOREIGN_KEY_FIELD_NAME,
57 * 'comment' => COMMENT,
58 * 'default' => DEFAULT, )
62 class CRM_Core_BAO_SchemaHandler
{
65 * Function for creating a civiCRM-table
69 * @internal param String $tableName name of the table to be created.
70 * @internal param Array $tableAttributes array containing atrributes for the table that needs to be created
72 * @return true if successfully created, false otherwise
77 static function createTable(&$params) {
78 $sql = self
::buildTableSQL($params);
79 // do not i18n-rewrite
80 $dao = CRM_Core_DAO
::executeQuery($sql, array(), TRUE, NULL, FALSE, FALSE);
83 $config = CRM_Core_Config
::singleton();
84 if ($config->logging
) {
86 $logging = new CRM_Logging_Schema
;
87 $logging->fixSchemaDifferencesFor($params['name'], null, FALSE);
90 // always do a trigger rebuild for this table
91 CRM_Core_DAO
::triggerRebuild($params['name']);
101 static function buildTableSQL(&$params) {
102 $sql = "CREATE TABLE {$params['name']} (";
103 if (isset($params['fields']) &&
104 is_array($params['fields'])
108 foreach ($params['fields'] as $field) {
109 $sql .= self
::buildFieldSQL($field, $separator, $prefix);
112 foreach ($params['fields'] as $field) {
113 $sql .= self
::buildPrimaryKeySQL($field, $separator, $prefix);
115 foreach ($params['fields'] as $field) {
116 $sql .= self
::buildSearchIndexSQL($field, $separator, $prefix);
118 if (isset($params['indexes'])) {
119 foreach ($params['indexes'] as $index) {
120 $sql .= self
::buildIndexSQL($index, $separator, $prefix);
123 foreach ($params['fields'] as $field) {
124 $sql .= self
::buildForeignKeySQL($field, $separator, $prefix, $params['name']);
127 $sql .= "\n) {$params['attributes']};";
138 static function buildFieldSQL(&$params, $separator, $prefix) {
141 $sql .= str_repeat(' ', 8);
143 $sql .= "`{$params['name']}` {$params['type']}";
145 if (!empty($params['required'])) {
149 if (!empty($params['attributes'])) {
150 $sql .= " {$params['attributes']}";
153 if (!empty($params['default']) &&
154 $params['type'] != 'text'
156 $sql .= " DEFAULT {$params['default']}";
159 if (!empty($params['comment'])) {
160 $sql .= " COMMENT '{$params['comment']}'";
171 * @return null|string
173 static function buildPrimaryKeySQL(&$params, $separator, $prefix) {
175 if (!empty($params['primary'])) {
177 $sql .= str_repeat(' ', 8);
179 $sql .= "PRIMARY KEY ( {$params['name']} )";
188 * @param bool $indexExist
190 * @return null|string
192 static function buildSearchIndexSQL(&$params, $separator, $prefix, $indexExist = FALSE) {
196 if ($params['type'] == 'text') {
200 //create index only for searchable fields during ADD,
201 //create index only if field is become searchable during MODIFY,
202 //drop index only if field is no more searchable and index was exist.
203 if (!empty($params['searchable']) && !$indexExist) {
205 $sql .= str_repeat(' ', 8);
207 $sql .= "INDEX_{$params['name']} ( {$params['name']} )";
209 elseif (empty($params['searchable']) && $indexExist) {
211 $sql .= str_repeat(' ', 8);
212 $sql .= "DROP INDEX INDEX_{$params['name']}";
224 static function buildIndexSQL(&$params, $separator, $prefix) {
227 $sql .= str_repeat(' ', 8);
228 if ($params['unique']) {
229 $sql .= 'UNIQUE INDEX';
230 $indexName = 'unique';
234 $indexName = 'index';
238 foreach ($params as $name => $value) {
239 if (substr($name, 0, 11) == 'field_name_') {
240 $indexName .= "_{$value}";
241 $indexFields .= " $value,";
244 $indexFields = substr($indexFields, 0, -1);
246 $sql .= " $indexName ( $indexFields )";
252 * @param $fkTableName
256 static function changeFKConstraint($tableName, $fkTableName) {
257 $fkName = "{$tableName}_entity_id";
258 if (strlen($fkName) >= 48) {
259 $fkName = substr($fkName, 0, 32) . "_" . substr(md5($fkName), 0, 16);
262 ALTER TABLE {$tableName}
263 DROP FOREIGN KEY `FK_{$fkName}`;";
265 $dao = CRM_Core_DAO
::executeQuery($dropFKSql);
269 ALTER TABLE {$tableName}
270 ADD CONSTRAINT `FK_{$fkName}` FOREIGN KEY (`entity_id`) REFERENCES {$fkTableName} (`id`) ON DELETE CASCADE;";
271 // CRM-7007: do not i18n-rewrite this query
272 $dao = CRM_Core_DAO
::executeQuery($addFKSql, array(), TRUE, NULL, FALSE, FALSE);
284 * @return null|string
286 static function buildForeignKeySQL(&$params, $separator, $prefix, $tableName) {
288 if (!empty($params['fk_table_name']) && !empty($params['fk_field_name'])) {
290 $sql .= str_repeat(' ', 8);
292 $fkName = "{$tableName}_{$params['name']}";
293 if (strlen($fkName) >= 48) {
294 $fkName = substr($fkName, 0, 32) . "_" . substr(md5($fkName), 0, 16);
297 $sql .= "CONSTRAINT FK_$fkName FOREIGN KEY ( `{$params['name']}` ) REFERENCES {$params['fk_table_name']} ( {$params['fk_field_name']} ) ";
298 $sql .= CRM_Utils_Array
::value('fk_attributes', $params);
305 * @param bool $indexExist
306 * @param bool $triggerRebuild
310 static function alterFieldSQL(&$params, $indexExist = FALSE, $triggerRebuild = TRUE) {
311 $sql = str_repeat(' ', 8);
312 $sql .= "ALTER TABLE {$params['table_name']}";
314 // lets suppress the required flag, since that can cause sql issue
315 $params['required'] = FALSE;
317 switch ($params['operation']) {
321 $sql .= self
::buildFieldSQL($params, $separator, "ADD COLUMN ");
323 $sql .= self
::buildPrimaryKeySQL($params, $separator, "ADD PRIMARY KEY ");
324 $sql .= self
::buildSearchIndexSQL($params, $separator, "ADD INDEX ");
325 $sql .= self
::buildForeignKeySQL($params, $separator, "ADD ", $params['table_name']);
331 $sql .= self
::buildFieldSQL($params, $separator, $prefix);
333 $sql .= self
::buildSearchIndexSQL($params, $separator, "ADD INDEX ", $indexExist);
337 $sql .= " DROP COLUMN `{$params['name']}`";
338 if (!empty($params['primary'])) {
339 $sql .= ", DROP PRIMARY KEY";
341 if (!empty($params['fk_table_name'])) {
342 $sql .= ", DROP FOREIGN KEY FK_{$params['fkName']}";
347 // CRM-7007: do not i18n-rewrite this query
348 $dao = CRM_Core_DAO
::executeQuery($sql, array(), TRUE, NULL, FALSE, FALSE);
351 $config = CRM_Core_Config
::singleton();
352 if ($config->logging
) {
353 // logging support: if we’re adding a column (but only then!) make sure the potential relevant log table gets a column as well
354 if ($params['operation'] == 'add') {
355 $logging = new CRM_Logging_Schema
;
356 $logging->fixSchemaDifferencesFor($params['table_name'], array('ADD' => array($params['name'])), FALSE);
360 if($triggerRebuild) {
361 CRM_Core_DAO
::triggerRebuild($params['table_name']);
368 * Function to delete a civiCRM-table
370 * @param String $tableName name of the table to be created.
372 * @return true if successfully deleted, false otherwise
377 static function dropTable($tableName) {
378 $sql = "DROP TABLE $tableName";
379 $dao = CRM_Core_DAO
::executeQuery($sql);
386 static function dropColumn($tableName, $columnName) {
387 $sql = "ALTER TABLE $tableName DROP COLUMN $columnName";
388 $dao = CRM_Core_DAO
::executeQuery($sql);
393 * @param bool $dropUnique
395 static function changeUniqueToIndex($tableName, $dropUnique = TRUE) {
397 $sql = "ALTER TABLE $tableName
398 DROP INDEX `unique_entity_id` ,
399 ADD INDEX `FK_{$tableName}_entity_id` ( `entity_id` )";
402 $sql = " ALTER TABLE $tableName
403 DROP INDEX `FK_{$tableName}_entity_id` ,
404 ADD UNIQUE INDEX `unique_entity_id` ( `entity_id` )";
406 $dao = CRM_Core_DAO
::executeQuery($sql);
411 * @param string $createIndexPrefix
412 * @param array $substrLenghts
414 static function createIndexes(&$tables, $createIndexPrefix = 'index', $substrLenghts = array(
418 require_once 'CRM/Core/DAO/Domain.php';
419 $domain = new CRM_Core_DAO_Domain
;
421 $locales = explode(CRM_Core_DAO
::VALUE_SEPARATOR
, $domain->locales
);
423 // if we're multilingual, cache the information on internationalised fields
424 static $columns = NULL;
425 if (!CRM_Utils_System
::isNull($locales) and $columns === NULL) {
426 $columns = CRM_Core_I18n_SchemaStructure
::columns();
429 foreach ($tables as $table => $fields) {
430 $query = "SHOW INDEX FROM $table";
431 $dao = CRM_Core_DAO
::executeQuery($query);
433 $currentIndexes = array();
434 while ($dao->fetch()) {
435 $currentIndexes[] = $dao->Key_name
;
438 // now check for all fields if the index exists
439 foreach ($fields as $field) {
440 // handle indices over substrings, CRM-6245
441 // $lengthName is appended to index name, $lengthSize is the field size modifier
442 $lengthName = isset($substrLenghts[$table][$field]) ?
"_{$substrLenghts[$table][$field]}" : '';
443 $lengthSize = isset($substrLenghts[$table][$field]) ?
"({$substrLenghts[$table][$field]})" : '';
445 $names = array("index_{$field}{$lengthName}", "FK_{$table}_{$field}{$lengthName}", "UI_{$field}{$lengthName}", "{$createIndexPrefix}_{$field}{$lengthName}");
447 // skip to the next $field if one of the above $names exists; handle multilingual for CRM-4126
448 foreach ($names as $name) {
449 $regex = '/^' . preg_quote($name) . '(_[a-z][a-z]_[A-Z][A-Z])?$/';
450 if (preg_grep($regex, $currentIndexes)) {
455 // the index doesn't exist, so create it
456 // if we're multilingual and the field is internationalised, do it for every locale
457 if (!CRM_Utils_System
::isNull($locales) and isset($columns[$table][$field])) {
458 foreach ($locales as $locale) {
459 $queries[] = "CREATE INDEX {$createIndexPrefix}_{$field}{$lengthName}_{$locale} ON {$table} ({$field}_{$locale}{$lengthSize})";
463 $queries[] = "CREATE INDEX {$createIndexPrefix}_{$field}{$lengthName} ON {$table} ({$field}{$lengthSize})";
468 // run the queries without i18n-rewriting
469 $dao = new CRM_Core_DAO
;
470 foreach ($queries as $query) {
471 $dao->query($query, FALSE);
476 * @param $customFieldID
483 static function alterFieldLength($customFieldID, $tableName, $columnName, $length) {
484 // first update the custom field tables
486 UPDATE civicrm_custom_field
490 $params = array(1 => array($length, 'Integer'),
491 2 => array($customFieldID, 'Integer'),
493 CRM_Core_DAO
::executeQuery($sql, $params);
496 SELECT is_required, default_value
497 FROM civicrm_custom_field
500 $dao = CRM_Core_DAO
::executeQuery($sql, $params);
505 if ($dao->is_required
) {
506 $clause = " NOT NULL";
509 if (!empty($dao->default_value
)) {
510 $clause .= " DEFAULT '{$dao->default_value}'";
512 // now modify the column
514 ALTER TABLE {$tableName}
515 MODIFY {$columnName} varchar( $length )
518 CRM_Core_DAO
::executeQuery($sql);
521 CRM_Core_Error
::fatal(ts('Could Not Find Custom Field Details for %1, %2, %3',