3 +--------------------------------------------------------------------+
5 +--------------------------------------------------------------------+
6 | Copyright CiviCRM LLC (c) 2004-2019 |
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 +--------------------------------------------------------------------+
29 * The InnoDB indexer is responsible for creating and destroying
30 * full-text indices on InnoDB classes.
32 class CRM_Core_InnoDBIndexer
{
33 const IDX_PREFIX
= "civicrm_fts_";
36 * @var CRM_Core_InnoDBIndexer
38 private static $singleton = NULL;
42 * @return CRM_Core_InnoDBIndexer
44 public static function singleton($fresh = FALSE) {
45 if ($fresh || self
::$singleton === NULL) {
47 'civicrm_address' => [
48 ['street_address', 'city', 'postal_code'],
50 'civicrm_activity' => [
51 ['subject', 'details'],
53 'civicrm_contact' => [
54 ['sort_name', 'nick_name', 'display_name'],
56 'civicrm_contribution' => [
57 ['source', 'amount_level', 'trxn_Id', 'invoice_id'],
62 'civicrm_membership' => [
68 'civicrm_participant' => [
69 ['source', 'fee_level'],
78 $active = Civi
::settings()->get('enable_innodb_fts');
79 self
::$singleton = new self($active, $indices);
81 return self
::$singleton;
86 * Respond to changes in the "enable_innodb_fts" setting
88 * @param bool $oldValue
89 * @param bool $newValue
90 * @param array $metadata
91 * Specification of the setting (per *.settings.php).
93 public static function onToggleFts($oldValue, $newValue, $metadata) {
94 if (empty($oldValue) && empty($newValue)) {
98 $indexer = CRM_Core_InnoDBIndexer
::singleton();
99 $indexer->setActive($newValue);
100 $indexer->fixSchemaDifferences();
106 * (string $table => array $indices)
108 * ex: $indices['civicrm_contact'][0] = array('first_name', 'last_name');
122 * @param bool $isActive
123 * @param array $indices
125 public function __construct($isActive, $indices) {
126 $this->isActive
= $isActive;
127 $this->indices
= $this->normalizeIndices($indices);
131 * Fix schema differences.
133 * Limitation: This won't pick up stale indices on tables which are not
134 * declared in $this->indices. That's not much of an issue for now b/c
135 * we have a static list of tables.
137 public function fixSchemaDifferences() {
138 foreach ($this->indices
as $tableName => $ign) {
139 $todoSqls = $this->reconcileIndexSqls($tableName);
140 foreach ($todoSqls as $todoSql) {
141 CRM_Core_DAO
::executeQuery($todoSql);
147 * Determine if an index is expected to exist.
149 * @param string $table
150 * @param array $fields
151 * List of field names that must be in the index.
154 public function hasDeclaredIndex($table, $fields) {
155 if (!$this->isActive
) {
159 if (isset($this->indices
[$table])) {
160 foreach ($this->indices
[$table] as $idxFields) {
161 // TODO determine if $idxFields must be exact match or merely a subset
162 // if (sort($fields) == sort($idxFields)) {
163 if (array_diff($fields, $idxFields) == []) {
173 * Get a list of FTS index names that are currently defined in the database.
175 * @param string $table
177 * (string $indexName => string $indexName)
179 public function findActualFtsIndexNames($table) {
180 $mysqlVersion = CRM_Core_DAO
::singleValueQuery('SELECT VERSION()');
181 if (version_compare($mysqlVersion, '5.6', '<')) {
182 // If we're not on 5.6+, then there cannot be any InnoDB FTS indices!
183 // Also: information_schema.innodb_sys_indexes is only available on 5.6+.
187 // Note: this only works in MySQL 5.6, but this whole system is intended to only work in MySQL 5.6
189 SELECT i.name as index_name
190 FROM information_schema.innodb_sys_tables t
191 JOIN information_schema.innodb_sys_indexes i USING (table_id)
192 WHERE t.name = concat(database(),'/$table')
193 AND i.name like '" . self
::IDX_PREFIX
. "%'
195 $dao = CRM_Core_DAO
::executeQuery($sql);
197 while ($dao->fetch()) {
198 $indexNames[$dao->index_name
] = $dao->index_name
;
204 * Generate a "CREATE INDEX" statement for each desired
210 * (string $indexName => string $sql)
212 public function buildIndexSql($table) {
213 // array (string $idxName => string $sql)
215 if ($this->isActive
&& isset($this->indices
[$table])) {
216 foreach ($this->indices
[$table] as $fields) {
217 $name = self
::IDX_PREFIX
. md5($table . '::' . implode(',', $fields));
218 $sqls[$name] = sprintf("CREATE FULLTEXT INDEX %s ON %s (%s)", $name, $table, implode(',', $fields));
225 * Generate a "DROP INDEX" statement for each existing FTS index.
227 * @param string $table
230 * (string $idxName => string $sql)
232 public function dropIndexSql($table) {
234 $names = $this->findActualFtsIndexNames($table);
235 foreach ($names as $name) {
236 $sqls[$name] = sprintf("DROP INDEX %s ON %s", $name, $table);
242 * Construct a set of SQL statements which will create (or preserve)
243 * required indices and destroy unneeded indices.
245 * @param string $table
249 public function reconcileIndexSqls($table) {
250 $buildIndexSqls = $this->buildIndexSql($table);
251 $dropIndexSqls = $this->dropIndexSql($table);
253 $allIndexNames = array_unique(array_merge(
254 array_keys($dropIndexSqls),
255 array_keys($buildIndexSqls)
259 foreach ($allIndexNames as $indexName) {
260 if (isset($buildIndexSqls[$indexName]) && isset($dropIndexSqls[$indexName])) {
263 elseif (isset($buildIndexSqls[$indexName])) {
264 $todoSqls[] = $buildIndexSqls[$indexName];
267 $todoSqls[] = $dropIndexSqls[$indexName];
274 * Put the indices into a normalized format.
279 public function normalizeIndices($indices) {
281 foreach ($indices as $table => $indicesByTable) {
282 foreach ($indicesByTable as $k => $fields) {
284 $result[$table][] = $fields;
291 * Setter for isActive.
293 * @param bool $isActive
295 public function setActive($isActive) {
296 $this->isActive
= $isActive;
300 * Getter for isActive.
304 public function getActive() {
305 return $this->isActive
;