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 +--------------------------------------------------------------------+
13 * The InnoDB indexer is responsible for creating and destroying
14 * full-text indices on InnoDB classes.
16 class CRM_Core_InnoDBIndexer
{
17 const IDX_PREFIX
= "civicrm_fts_";
20 * @var CRM_Core_InnoDBIndexer
22 private static $singleton = NULL;
26 * @return CRM_Core_InnoDBIndexer
28 public static function singleton($fresh = FALSE) {
29 if ($fresh || self
::$singleton === NULL) {
31 'civicrm_address' => [
32 ['street_address', 'city', 'postal_code'],
34 'civicrm_activity' => [
35 ['subject', 'details'],
37 'civicrm_contact' => [
38 ['sort_name', 'nick_name', 'display_name'],
40 'civicrm_contribution' => [
41 ['source', 'amount_level', 'trxn_Id', 'invoice_id'],
46 'civicrm_membership' => [
52 'civicrm_participant' => [
53 ['source', 'fee_level'],
62 $active = Civi
::settings()->get('enable_innodb_fts');
63 self
::$singleton = new self($active, $indices);
65 return self
::$singleton;
70 * Respond to changes in the "enable_innodb_fts" setting
72 * @param bool $oldValue
73 * @param bool $newValue
74 * @param array $metadata
75 * Specification of the setting (per *.settings.php).
77 public static function onToggleFts($oldValue, $newValue, $metadata) {
78 if (empty($oldValue) && empty($newValue)) {
82 $indexer = CRM_Core_InnoDBIndexer
::singleton();
83 $indexer->setActive($newValue);
84 $indexer->fixSchemaDifferences();
90 * (string $table => array $indices)
92 * ex: $indices['civicrm_contact'][0] = array('first_name', 'last_name');
106 * @param bool $isActive
107 * @param array $indices
109 public function __construct($isActive, $indices) {
110 $this->isActive
= $isActive;
111 $this->indices
= $this->normalizeIndices($indices);
115 * Fix schema differences.
117 * Limitation: This won't pick up stale indices on tables which are not
118 * declared in $this->indices. That's not much of an issue for now b/c
119 * we have a static list of tables.
121 public function fixSchemaDifferences() {
122 foreach ($this->indices
as $tableName => $ign) {
123 $todoSqls = $this->reconcileIndexSqls($tableName);
124 foreach ($todoSqls as $todoSql) {
125 CRM_Core_DAO
::executeQuery($todoSql);
131 * Determine if an index is expected to exist.
133 * @param string $table
134 * @param array $fields
135 * List of field names that must be in the index.
138 public function hasDeclaredIndex($table, $fields) {
139 if (!$this->isActive
) {
143 if (isset($this->indices
[$table])) {
144 foreach ($this->indices
[$table] as $idxFields) {
145 // TODO determine if $idxFields must be exact match or merely a subset
146 // if (sort($fields) == sort($idxFields)) {
147 if (array_diff($fields, $idxFields) == []) {
157 * Get a list of FTS index names that are currently defined in the database.
159 * @param string $table
161 * (string $indexName => string $indexName)
163 public function findActualFtsIndexNames($table) {
164 $mysqlVersion = CRM_Core_DAO
::singleValueQuery('SELECT VERSION()');
165 if (version_compare($mysqlVersion, '5.6', '<')) {
166 // If we're not on 5.6+, then there cannot be any InnoDB FTS indices!
167 // Also: information_schema.innodb_sys_indexes is only available on 5.6+.
171 // Note: this only works in MySQL 5.6, but this whole system is intended to only work in MySQL 5.6
173 SELECT i.name as index_name
174 FROM information_schema.innodb_sys_tables t
175 JOIN information_schema.innodb_sys_indexes i USING (table_id)
176 WHERE t.name = concat(database(),'/$table')
177 AND i.name like '" . self
::IDX_PREFIX
. "%'
179 $dao = CRM_Core_DAO
::executeQuery($sql);
181 while ($dao->fetch()) {
182 $indexNames[$dao->index_name
] = $dao->index_name
;
188 * Generate a "CREATE INDEX" statement for each desired
194 * (string $indexName => string $sql)
196 public function buildIndexSql($table) {
197 // array (string $idxName => string $sql)
199 if ($this->isActive
&& isset($this->indices
[$table])) {
200 foreach ($this->indices
[$table] as $fields) {
201 $name = self
::IDX_PREFIX
. md5($table . '::' . implode(',', $fields));
202 $sqls[$name] = sprintf("CREATE FULLTEXT INDEX %s ON %s (%s)", $name, $table, implode(',', $fields));
209 * Generate a "DROP INDEX" statement for each existing FTS index.
211 * @param string $table
214 * (string $idxName => string $sql)
216 public function dropIndexSql($table) {
218 $names = $this->findActualFtsIndexNames($table);
219 foreach ($names as $name) {
220 $sqls[$name] = sprintf("DROP INDEX %s ON %s", $name, $table);
226 * Construct a set of SQL statements which will create (or preserve)
227 * required indices and destroy unneeded indices.
229 * @param string $table
233 public function reconcileIndexSqls($table) {
234 $buildIndexSqls = $this->buildIndexSql($table);
235 $dropIndexSqls = $this->dropIndexSql($table);
237 $allIndexNames = array_unique(array_merge(
238 array_keys($dropIndexSqls),
239 array_keys($buildIndexSqls)
243 foreach ($allIndexNames as $indexName) {
244 if (isset($buildIndexSqls[$indexName]) && isset($dropIndexSqls[$indexName])) {
247 elseif (isset($buildIndexSqls[$indexName])) {
248 $todoSqls[] = $buildIndexSqls[$indexName];
251 $todoSqls[] = $dropIndexSqls[$indexName];
258 * Put the indices into a normalized format.
263 public function normalizeIndices($indices) {
265 foreach ($indices as $table => $indicesByTable) {
266 foreach ($indicesByTable as $k => $fields) {
268 $result[$table][] = $fields;
275 * Setter for isActive.
277 * @param bool $isActive
279 public function setActive($isActive) {
280 $this->isActive
= $isActive;
284 * Getter for isActive.
288 public function getActive() {
289 return $this->isActive
;