Add check for existing key index in table

civicrm · Jun 26, 2017 · 5cff2b6 · xurizaemon · Jun 27, 2017 · 5cff2b6
1 parent 5a80680
commit 5cff2b6
Show file tree

Hide file tree

Showing 3 changed files with 45 additions and 5 deletions.
diff --git a/CRM/Core/BAO/SchemaHandler.php b/CRM/Core/BAO/SchemaHandler.php
@@ -723,6 +723,27 @@ public static function getMissingIndices() {
 
     // Compare
     $missingSigs = array_diff($requiredSigs, $existingSigs);
+
+    //This gets the index key which do exist in the table but the value varies.
+    //Updating this key would produce duplicate error and eventually skips
+    //further updates of indices in other tables. Hence remove this from $missingSigs
+    //while updating indices from sytem status page.
+    $existingKeyIndices = array();
+    $existingKeySigs = array_intersect_key($missingSigs, $existingSigs);
+    if (!empty($existingKeySigs)) {
+      $missingSigs = array_diff_key($missingSigs, $existingKeySigs);
+
+      foreach ($existingKeySigs as $sig) {
+        $sigParts = explode('::', $sig);
+        foreach ($requiredIndices[$sigParts[0]] as $index) {
+          if ($index['sig'] == $sig) {
+            $existingKeyIndices[$sigParts[0]][] = $index;
+            continue;
+          }
+        }
+      }
+    }
+
     // Get missing indices
     $missingIndices = array();
     foreach ($missingSigs as $sig) {
@@ -734,7 +755,7 @@ public static function getMissingIndices() {
         }
       }
     }
-    return $missingIndices;
+    return array($missingIndices, $existingKeyIndices);
   }
 
   /**

diff --git a/CRM/Utils/Check/Component/Schema.php b/CRM/Utils/Check/Component/Schema.php
@@ -37,11 +37,29 @@ class CRM_Utils_Check_Component_Schema extends CRM_Utils_Check_Component {
    */
   public function checkIndices() {
     $messages = array();
-    $missingIndices = CRM_Core_BAO_SchemaHandler::getMissingIndices();
-    if ($missingIndices) {
+    list($missingIndices, $existingKeyIndices) = CRM_Core_BAO_SchemaHandler::getMissingIndices();
+    if ($existingKeyIndices) {
+      $html = '';
+      foreach ($existingKeyIndices as $tableName => $indices) {
+        foreach ($indices as $index) {
+          $fields = implode(', ', $index['field']);
+          $html .= "<tr><td>{$tableName}</td><td>{$index['name']}</td><td>$fields</td>";
+        }
+      }
+      $keyMessage = "<p>The following tables have an index key with a mismatch in value. Please delete the key indices listed from the below table and then click on 'Update Indices' button. <p>
+        <p><table><thead><tr><th>Table Name</th><th>Key Name</th><th>Fields</th>
+        </tr></thead><tbody>
+        $html
+        </tbody></table></p>";
+    }
+    if ($missingIndices || $existingKeyIndices) {
+      $message = "You have missing indices on some tables. This may cause poor performance.";
+      if ($keyMessage) {
+        $message = $keyMessage;
+      }
       $msg = new CRM_Utils_Check_Message(
         __FUNCTION__,
-        ts('You have missing indices on some tables. This may cause poor performance.'),
+        ts($message),
         ts('Performance warning: Missing indices'),
         \Psr\Log\LogLevel::WARNING,
         'fa-server'

diff --git a/api/v3/System.php b/api/v3/System.php
@@ -408,6 +408,7 @@ function civicrm_api3_system_updatelogtables() {
  * This adds any indexes that exist in the schema but not the database.
  */
 function civicrm_api3_system_updateindexes() {
-  CRM_Core_BAO_SchemaHandler::createMissingIndices(CRM_Core_BAO_SchemaHandler::getMissingIndices());
+  list($missingIndices) = CRM_Core_BAO_SchemaHandler::getMissingIndices();
+  CRM_Core_BAO_SchemaHandler::createMissingIndices($missingIndices);
   return civicrm_api3_create_success(1);
 }