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 * Create a CiviCRM-table
67 * @param array $params
69 * @return true if successfully created, false otherwise
74 static function createTable(&$params) {
75 $sql = self
::buildTableSQL($params);
76 // do not i18n-rewrite
77 $dao = CRM_Core_DAO
::executeQuery($sql, array(), TRUE, NULL, FALSE, FALSE);
80 $config = CRM_Core_Config
::singleton();
81 if ($config->logging
) {
83 $logging = new CRM_Logging_Schema
;
84 $logging->fixSchemaDifferencesFor($params['name'], null, FALSE);
87 // always do a trigger rebuild for this table
88 CRM_Core_DAO
::triggerRebuild($params['name']);
94 * @param array $params
98 static function buildTableSQL(&$params) {
99 $sql = "CREATE TABLE {$params['name']} (";
100 if (isset($params['fields']) &&
101 is_array($params['fields'])
105 foreach ($params['fields'] as $field) {
106 $sql .= self
::buildFieldSQL($field, $separator, $prefix);
109 foreach ($params['fields'] as $field) {
110 $sql .= self
::buildPrimaryKeySQL($field, $separator, $prefix);
112 foreach ($params['fields'] as $field) {
113 $sql .= self
::buildSearchIndexSQL($field, $separator, $prefix);
115 if (isset($params['indexes'])) {
116 foreach ($params['indexes'] as $index) {
117 $sql .= self
::buildIndexSQL($index, $separator, $prefix);
120 foreach ($params['fields'] as $field) {
121 $sql .= self
::buildForeignKeySQL($field, $separator, $prefix, $params['name']);
124 $sql .= "\n) {$params['attributes']};";
129 * @param array $params
135 static function buildFieldSQL(&$params, $separator, $prefix) {
138 $sql .= str_repeat(' ', 8);
140 $sql .= "`{$params['name']}` {$params['type']}";
142 if (!empty($params['required'])) {
146 if (!empty($params['attributes'])) {
147 $sql .= " {$params['attributes']}";
150 if (!empty($params['default']) &&
151 $params['type'] != 'text'
153 $sql .= " DEFAULT {$params['default']}";
156 if (!empty($params['comment'])) {
157 $sql .= " COMMENT '{$params['comment']}'";
164 * @param array $params
168 * @return null|string
170 static function buildPrimaryKeySQL(&$params, $separator, $prefix) {
172 if (!empty($params['primary'])) {
174 $sql .= str_repeat(' ', 8);
176 $sql .= "PRIMARY KEY ( {$params['name']} )";
182 * @param array $params
185 * @param bool $indexExist
187 * @return null|string
189 static function buildSearchIndexSQL(&$params, $separator, $prefix, $indexExist = FALSE) {
193 if ($params['type'] == 'text') {
197 //create index only for searchable fields during ADD,
198 //create index only if field is become searchable during MODIFY,
199 //drop index only if field is no more searchable and index was exist.
200 if (!empty($params['searchable']) && !$indexExist) {
202 $sql .= str_repeat(' ', 8);
204 $sql .= "INDEX_{$params['name']} ( {$params['name']} )";
206 elseif (empty($params['searchable']) && $indexExist) {
208 $sql .= str_repeat(' ', 8);
209 $sql .= "DROP INDEX INDEX_{$params['name']}";
215 * @param array $params
221 static function buildIndexSQL(&$params, $separator, $prefix) {
224 $sql .= str_repeat(' ', 8);
225 if ($params['unique']) {
226 $sql .= 'UNIQUE INDEX';
227 $indexName = 'unique';
231 $indexName = 'index';
235 foreach ($params as $name => $value) {
236 if (substr($name, 0, 11) == 'field_name_') {
237 $indexName .= "_{$value}";
238 $indexFields .= " $value,";
241 $indexFields = substr($indexFields, 0, -1);
243 $sql .= " $indexName ( $indexFields )";
249 * @param $fkTableName
253 static function changeFKConstraint($tableName, $fkTableName) {
254 $fkName = "{$tableName}_entity_id";
255 if (strlen($fkName) >= 48) {
256 $fkName = substr($fkName, 0, 32) . "_" . substr(md5($fkName), 0, 16);
259 ALTER TABLE {$tableName}
260 DROP FOREIGN KEY `FK_{$fkName}`;";
262 $dao = CRM_Core_DAO
::executeQuery($dropFKSql);
266 ALTER TABLE {$tableName}
267 ADD CONSTRAINT `FK_{$fkName}` FOREIGN KEY (`entity_id`) REFERENCES {$fkTableName} (`id`) ON DELETE CASCADE;";
268 // CRM-7007: do not i18n-rewrite this query
269 $dao = CRM_Core_DAO
::executeQuery($addFKSql, array(), TRUE, NULL, FALSE, FALSE);
276 * @param array $params
281 * @return null|string
283 static function buildForeignKeySQL(&$params, $separator, $prefix, $tableName) {
285 if (!empty($params['fk_table_name']) && !empty($params['fk_field_name'])) {
287 $sql .= str_repeat(' ', 8);
289 $fkName = "{$tableName}_{$params['name']}";
290 if (strlen($fkName) >= 48) {
291 $fkName = substr($fkName, 0, 32) . "_" . substr(md5($fkName), 0, 16);
294 $sql .= "CONSTRAINT FK_$fkName FOREIGN KEY ( `{$params['name']}` ) REFERENCES {$params['fk_table_name']} ( {$params['fk_field_name']} ) ";
295 $sql .= CRM_Utils_Array
::value('fk_attributes', $params);
301 * @param array $params
302 * @param bool $indexExist
303 * @param bool $triggerRebuild
307 static function alterFieldSQL(&$params, $indexExist = FALSE, $triggerRebuild = TRUE) {
308 $sql = str_repeat(' ', 8);
309 $sql .= "ALTER TABLE {$params['table_name']}";
311 // lets suppress the required flag, since that can cause sql issue
312 $params['required'] = FALSE;
314 switch ($params['operation']) {
318 $sql .= self
::buildFieldSQL($params, $separator, "ADD COLUMN ");
320 $sql .= self
::buildPrimaryKeySQL($params, $separator, "ADD PRIMARY KEY ");
321 $sql .= self
::buildSearchIndexSQL($params, $separator, "ADD INDEX ");
322 $sql .= self
::buildForeignKeySQL($params, $separator, "ADD ", $params['table_name']);
328 $sql .= self
::buildFieldSQL($params, $separator, $prefix);
330 $sql .= self
::buildSearchIndexSQL($params, $separator, "ADD INDEX ", $indexExist);
334 $sql .= " DROP COLUMN `{$params['name']}`";
335 if (!empty($params['primary'])) {
336 $sql .= ", DROP PRIMARY KEY";
338 if (!empty($params['fk_table_name'])) {
339 $sql .= ", DROP FOREIGN KEY FK_{$params['fkName']}";
344 // CRM-7007: do not i18n-rewrite this query
345 $dao = CRM_Core_DAO
::executeQuery($sql, array(), TRUE, NULL, FALSE, FALSE);
348 $config = CRM_Core_Config
::singleton();
349 if ($config->logging
) {
350 // logging support: if we’re adding a column (but only then!) make sure the potential relevant log table gets a column as well
351 if ($params['operation'] == 'add') {
352 $logging = new CRM_Logging_Schema
;
353 $logging->fixSchemaDifferencesFor($params['table_name'], array('ADD' => array($params['name'])), FALSE);
357 if($triggerRebuild) {
358 CRM_Core_DAO
::triggerRebuild($params['table_name']);
365 * delete a civiCRM-table
367 * @param String $tableName name of the table to be created.
369 * @return true if successfully deleted, false otherwise
374 static function dropTable($tableName) {
375 $sql = "DROP TABLE $tableName";
376 $dao = CRM_Core_DAO
::executeQuery($sql);
383 static function dropColumn($tableName, $columnName) {
384 $sql = "ALTER TABLE $tableName DROP COLUMN $columnName";
385 $dao = CRM_Core_DAO
::executeQuery($sql);
390 * @param bool $dropUnique
392 static function changeUniqueToIndex($tableName, $dropUnique = TRUE) {
394 $sql = "ALTER TABLE $tableName
395 DROP INDEX `unique_entity_id` ,
396 ADD INDEX `FK_{$tableName}_entity_id` ( `entity_id` )";
399 $sql = " ALTER TABLE $tableName
400 DROP INDEX `FK_{$tableName}_entity_id` ,
401 ADD UNIQUE INDEX `unique_entity_id` ( `entity_id` )";
403 $dao = CRM_Core_DAO
::executeQuery($sql);
408 * @param string $createIndexPrefix
409 * @param array $substrLenghts
411 static function createIndexes(&$tables, $createIndexPrefix = 'index', $substrLenghts = array()) {
413 require_once 'CRM/Core/DAO/Domain.php';
414 $domain = new CRM_Core_DAO_Domain
;
416 $locales = explode(CRM_Core_DAO
::VALUE_SEPARATOR
, $domain->locales
);
418 // if we're multilingual, cache the information on internationalised fields
419 static $columns = NULL;
420 if (!CRM_Utils_System
::isNull($locales) and $columns === NULL) {
421 $columns = CRM_Core_I18n_SchemaStructure
::columns();
424 foreach ($tables as $table => $fields) {
425 $query = "SHOW INDEX FROM $table";
426 $dao = CRM_Core_DAO
::executeQuery($query);
428 $currentIndexes = array();
429 while ($dao->fetch()) {
430 $currentIndexes[] = $dao->Key_name
;
433 // now check for all fields if the index exists
434 foreach ($fields as $field) {
435 // handle indices over substrings, CRM-6245
436 // $lengthName is appended to index name, $lengthSize is the field size modifier
437 $lengthName = isset($substrLenghts[$table][$field]) ?
"_{$substrLenghts[$table][$field]}" : '';
438 $lengthSize = isset($substrLenghts[$table][$field]) ?
"({$substrLenghts[$table][$field]})" : '';
440 $names = array("index_{$field}{$lengthName}", "FK_{$table}_{$field}{$lengthName}", "UI_{$field}{$lengthName}", "{$createIndexPrefix}_{$field}{$lengthName}");
442 // skip to the next $field if one of the above $names exists; handle multilingual for CRM-4126
443 foreach ($names as $name) {
444 $regex = '/^' . preg_quote($name) . '(_[a-z][a-z]_[A-Z][A-Z])?$/';
445 if (preg_grep($regex, $currentIndexes)) {
450 // the index doesn't exist, so create it
451 // if we're multilingual and the field is internationalised, do it for every locale
452 if (!CRM_Utils_System
::isNull($locales) and isset($columns[$table][$field])) {
453 foreach ($locales as $locale) {
454 $queries[] = "CREATE INDEX {$createIndexPrefix}_{$field}{$lengthName}_{$locale} ON {$table} ({$field}_{$locale}{$lengthSize})";
458 $queries[] = "CREATE INDEX {$createIndexPrefix}_{$field}{$lengthName} ON {$table} ({$field}{$lengthSize})";
463 // run the queries without i18n-rewriting
464 $dao = new CRM_Core_DAO
;
465 foreach ($queries as $query) {
466 $dao->query($query, FALSE);
471 * @param $customFieldID
478 static function alterFieldLength($customFieldID, $tableName, $columnName, $length) {
479 // first update the custom field tables
481 UPDATE civicrm_custom_field
485 $params = array(1 => array($length, 'Integer'),
486 2 => array($customFieldID, 'Integer'),
488 CRM_Core_DAO
::executeQuery($sql, $params);
491 SELECT is_required, default_value
492 FROM civicrm_custom_field
495 $dao = CRM_Core_DAO
::executeQuery($sql, $params);
500 if ($dao->is_required
) {
501 $clause = " NOT NULL";
504 if (!empty($dao->default_value
)) {
505 $clause .= " DEFAULT '{$dao->default_value}'";
507 // now modify the column
509 ALTER TABLE {$tableName}
510 MODIFY {$columnName} varchar( $length )
513 CRM_Core_DAO
::executeQuery($sql);
516 CRM_Core_Error
::fatal(ts('Could Not Find Custom Field Details for %1, %2, %3',