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']);
96 static function buildTableSQL(&$params) {
97 $sql = "CREATE TABLE {$params['name']} (";
98 if (isset($params['fields']) &&
99 is_array($params['fields'])
103 foreach ($params['fields'] as $field) {
104 $sql .= self
::buildFieldSQL($field, $separator, $prefix);
107 foreach ($params['fields'] as $field) {
108 $sql .= self
::buildPrimaryKeySQL($field, $separator, $prefix);
110 foreach ($params['fields'] as $field) {
111 $sql .= self
::buildSearchIndexSQL($field, $separator, $prefix);
113 if (isset($params['indexes'])) {
114 foreach ($params['indexes'] as $index) {
115 $sql .= self
::buildIndexSQL($index, $separator, $prefix);
118 foreach ($params['fields'] as $field) {
119 $sql .= self
::buildForeignKeySQL($field, $separator, $prefix, $params['name']);
122 $sql .= "\n) {$params['attributes']};";
126 static function buildFieldSQL(&$params, $separator, $prefix) {
129 $sql .= str_repeat(' ', 8);
131 $sql .= "`{$params['name']}` {$params['type']}";
133 if (!empty($params['required'])) {
137 if (!empty($params['attributes'])) {
138 $sql .= " {$params['attributes']}";
141 if (!empty($params['default']) &&
142 $params['type'] != 'text'
144 $sql .= " DEFAULT {$params['default']}";
147 if (!empty($params['comment'])) {
148 $sql .= " COMMENT '{$params['comment']}'";
154 static function buildPrimaryKeySQL(&$params, $separator, $prefix) {
156 if (!empty($params['primary'])) {
158 $sql .= str_repeat(' ', 8);
160 $sql .= "PRIMARY KEY ( {$params['name']} )";
165 static function buildSearchIndexSQL(&$params, $separator, $prefix, $indexExist = FALSE) {
169 if ($params['type'] == 'text') {
173 //create index only for searchable fields during ADD,
174 //create index only if field is become searchable during MODIFY,
175 //drop index only if field is no more searchable and index was exist.
176 if (!empty($params['searchable']) && !$indexExist) {
178 $sql .= str_repeat(' ', 8);
180 $sql .= "INDEX_{$params['name']} ( {$params['name']} )";
182 elseif (empty($params['searchable']) && $indexExist) {
184 $sql .= str_repeat(' ', 8);
185 $sql .= "DROP INDEX INDEX_{$params['name']}";
190 static function buildIndexSQL(&$params, $separator, $prefix) {
193 $sql .= str_repeat(' ', 8);
194 if ($params['unique']) {
195 $sql .= 'UNIQUE INDEX';
196 $indexName = 'unique';
200 $indexName = 'index';
204 foreach ($params as $name => $value) {
205 if (substr($name, 0, 11) == 'field_name_') {
206 $indexName .= "_{$value}";
207 $indexFields .= " $value,";
210 $indexFields = substr($indexFields, 0, -1);
212 $sql .= " $indexName ( $indexFields )";
216 static function changeFKConstraint($tableName, $fkTableName) {
217 $fkName = "{$tableName}_entity_id";
218 if (strlen($fkName) >= 48) {
219 $fkName = substr($fkName, 0, 32) . "_" . substr(md5($fkName), 0, 16);
222 ALTER TABLE {$tableName}
223 DROP FOREIGN KEY `FK_{$fkName}`;";
225 $dao = CRM_Core_DAO
::executeQuery($dropFKSql);
229 ALTER TABLE {$tableName}
230 ADD CONSTRAINT `FK_{$fkName}` FOREIGN KEY (`entity_id`) REFERENCES {$fkTableName} (`id`) ON DELETE CASCADE;";
231 // CRM-7007: do not i18n-rewrite this query
232 $dao = CRM_Core_DAO
::executeQuery($addFKSql, array(), TRUE, NULL, FALSE, FALSE);
238 static function buildForeignKeySQL(&$params, $separator, $prefix, $tableName) {
240 if (!empty($params['fk_table_name']) && !empty($params['fk_field_name'])) {
242 $sql .= str_repeat(' ', 8);
244 $fkName = "{$tableName}_{$params['name']}";
245 if (strlen($fkName) >= 48) {
246 $fkName = substr($fkName, 0, 32) . "_" . substr(md5($fkName), 0, 16);
249 $sql .= "CONSTRAINT FK_$fkName FOREIGN KEY ( `{$params['name']}` ) REFERENCES {$params['fk_table_name']} ( {$params['fk_field_name']} ) ";
250 $sql .= CRM_Utils_Array
::value('fk_attributes', $params);
255 static function alterFieldSQL(&$params, $indexExist = FALSE, $triggerRebuild = TRUE) {
256 $sql = str_repeat(' ', 8);
257 $sql .= "ALTER TABLE {$params['table_name']}";
259 // lets suppress the required flag, since that can cause sql issue
260 $params['required'] = FALSE;
262 switch ($params['operation']) {
266 $sql .= self
::buildFieldSQL($params, $separator, "ADD COLUMN ");
268 $sql .= self
::buildPrimaryKeySQL($params, $separator, "ADD PRIMARY KEY ");
269 $sql .= self
::buildSearchIndexSQL($params, $separator, "ADD INDEX ");
270 $sql .= self
::buildForeignKeySQL($params, $separator, "ADD ", $params['table_name']);
276 $sql .= self
::buildFieldSQL($params, $separator, $prefix);
278 $sql .= self
::buildSearchIndexSQL($params, $separator, "ADD INDEX ", $indexExist);
282 $sql .= " DROP COLUMN `{$params['name']}`";
283 if (!empty($params['primary'])) {
284 $sql .= ", DROP PRIMARY KEY";
286 if (!empty($params['fk_table_name'])) {
287 $sql .= ", DROP FOREIGN KEY FK_{$params['fkName']}";
292 // CRM-7007: do not i18n-rewrite this query
293 $dao = CRM_Core_DAO
::executeQuery($sql, array(), TRUE, NULL, FALSE, FALSE);
296 $config = CRM_Core_Config
::singleton();
297 if ($config->logging
) {
298 // logging support: if we’re adding a column (but only then!) make sure the potential relevant log table gets a column as well
299 if ($params['operation'] == 'add') {
300 $logging = new CRM_Logging_Schema
;
301 $logging->fixSchemaDifferencesFor($params['table_name'], array('ADD' => array($params['name'])), FALSE);
305 if($triggerRebuild) {
306 CRM_Core_DAO
::triggerRebuild($params['table_name']);
313 * Function to delete a civiCRM-table
315 * @param String $tableName name of the table to be created.
317 * @return true if successfully deleted, false otherwise
322 static function dropTable($tableName) {
323 $sql = "DROP TABLE $tableName";
324 $dao = CRM_Core_DAO
::executeQuery($sql);
327 static function dropColumn($tableName, $columnName) {
328 $sql = "ALTER TABLE $tableName DROP COLUMN $columnName";
329 $dao = CRM_Core_DAO
::executeQuery($sql);
332 static function changeUniqueToIndex($tableName, $dropUnique = TRUE) {
334 $sql = "ALTER TABLE $tableName
335 DROP INDEX `unique_entity_id` ,
336 ADD INDEX `FK_{$tableName}_entity_id` ( `entity_id` )";
339 $sql = " ALTER TABLE $tableName
340 DROP INDEX `FK_{$tableName}_entity_id` ,
341 ADD UNIQUE INDEX `unique_entity_id` ( `entity_id` )";
343 $dao = CRM_Core_DAO
::executeQuery($sql);
346 static function createIndexes(&$tables, $createIndexPrefix = 'index', $substrLenghts = array(
350 require_once 'CRM/Core/DAO/Domain.php';
351 $domain = new CRM_Core_DAO_Domain
;
353 $locales = explode(CRM_Core_DAO
::VALUE_SEPARATOR
, $domain->locales
);
355 // if we're multilingual, cache the information on internationalised fields
356 static $columns = NULL;
357 if (!CRM_Utils_System
::isNull($locales) and $columns === NULL) {
358 $columns = CRM_Core_I18n_SchemaStructure
::columns();
361 foreach ($tables as $table => $fields) {
362 $query = "SHOW INDEX FROM $table";
363 $dao = CRM_Core_DAO
::executeQuery($query);
365 $currentIndexes = array();
366 while ($dao->fetch()) {
367 $currentIndexes[] = $dao->Key_name
;
370 // now check for all fields if the index exists
371 foreach ($fields as $field) {
372 // handle indices over substrings, CRM-6245
373 // $lengthName is appended to index name, $lengthSize is the field size modifier
374 $lengthName = isset($substrLenghts[$table][$field]) ?
"_{$substrLenghts[$table][$field]}" : '';
375 $lengthSize = isset($substrLenghts[$table][$field]) ?
"({$substrLenghts[$table][$field]})" : '';
377 $names = array("index_{$field}{$lengthName}", "FK_{$table}_{$field}{$lengthName}", "UI_{$field}{$lengthName}", "{$createIndexPrefix}_{$field}{$lengthName}");
379 // skip to the next $field if one of the above $names exists; handle multilingual for CRM-4126
380 foreach ($names as $name) {
381 $regex = '/^' . preg_quote($name) . '(_[a-z][a-z]_[A-Z][A-Z])?$/';
382 if (preg_grep($regex, $currentIndexes)) {
387 // the index doesn't exist, so create it
388 // if we're multilingual and the field is internationalised, do it for every locale
389 if (!CRM_Utils_System
::isNull($locales) and isset($columns[$table][$field])) {
390 foreach ($locales as $locale) {
391 $queries[] = "CREATE INDEX {$createIndexPrefix}_{$field}{$lengthName}_{$locale} ON {$table} ({$field}_{$locale}{$lengthSize})";
395 $queries[] = "CREATE INDEX {$createIndexPrefix}_{$field}{$lengthName} ON {$table} ({$field}{$lengthSize})";
400 // run the queries without i18n-rewriting
401 $dao = new CRM_Core_DAO
;
402 foreach ($queries as $query) {
403 $dao->query($query, FALSE);
407 static function alterFieldLength($customFieldID, $tableName, $columnName, $length) {
408 // first update the custom field tables
410 UPDATE civicrm_custom_field
414 $params = array(1 => array($length, 'Integer'),
415 2 => array($customFieldID, 'Integer'),
417 CRM_Core_DAO
::executeQuery($sql, $params);
420 SELECT is_required, default_value
421 FROM civicrm_custom_field
424 $dao = CRM_Core_DAO
::executeQuery($sql, $params);
429 if ($dao->is_required
) {
430 $clause = " NOT NULL";
433 if (!empty($dao->default_value
)) {
434 $clause .= " DEFAULT '{$dao->default_value}'";
436 // now modify the column
438 ALTER TABLE {$tableName}
439 MODIFY {$columnName} varchar( $length )
442 CRM_Core_DAO
::executeQuery($sql);
445 CRM_Core_Error
::fatal(ts('Could Not Find Custom Field Details for %1, %2, %3',