Convert custom data and CiviCRM Search PrevNextCache search groups

Streamline caches calls as per Monish's comments Split prevNextCache out on its own as it needs to be SQLbacked all the time for the moment whilst clearing is hard coded
civicrm · Jun 14, 2019 · 93a63a5 · 93a63a5
1 parent 3e03283
commit 93a63a5
Show file tree

Hide file tree

Showing 16 changed files with 37 additions and 49 deletions.
diff --git a/CRM/ACL/BAO/ACL.php b/CRM/ACL/BAO/ACL.php
@@ -688,8 +688,7 @@ public static function retrieve(&$params, &$defaults) {
    */
   public static function setIsActive($id, $is_active) {
     // note this also resets any ACL cache
-    $cache = Civi::cache('fields');
-    $cache->flush();
+    Civi::cache('fields')->flush();
 
     return CRM_Core_DAO::setFieldValue('CRM_ACL_DAO_ACL', $id, 'is_active', $is_active);
   }

diff --git a/CRM/ACL/Form/ACL.php b/CRM/ACL/Form/ACL.php
@@ -254,8 +254,7 @@ public static function formRule($params) {
    */
   public function postProcess() {
     // note this also resets any ACL cache
-    $cache = Civi::cache('fields');
-    $cache->flush();
+    Civi::cache('fields')->flush();
 
     if ($this->_action & CRM_Core_Action::DELETE) {
       CRM_ACL_BAO_ACL::del($this->_id);

diff --git a/CRM/Admin/Form/Setting/Localization.php b/CRM/Admin/Form/Setting/Localization.php
@@ -184,12 +184,10 @@ public function postProcess() {
 
     //cache contact fields retaining localized titles
     //though we changed localization, so reseting cache.
-    $contactCache = Civi::cache('fields');
-    $contactCache->flush();
+    Civi::cache('fields')->flush();
 
     //CRM-8559, cache navigation do not respect locale if it is changed, so reseting cache.
-    $navigationCache = Civi::cache('navigation');
-    $navigationCache->flush();
+    Civi::cache('navigation')->flush();
 
     // we do this only to initialize monetary decimal point and thousand separator
     $config = CRM_Core_Config::singleton();

diff --git a/CRM/Campaign/Selector/Search.php b/CRM/Campaign/Selector/Search.php
@@ -296,7 +296,7 @@ public function buildPrevNextCache($sort) {
 
       if (Civi::service('prevnext') instanceof CRM_Core_PrevNextCache_Sql) {
         // SQL-backed prevnext cache uses an extra record for pruning the cache.
-        CRM_Core_BAO_Cache::setItem($cacheKey, 'CiviCRM Search PrevNextCache', $cacheKey);
+        Civi::cache('prevNextCache')->set($cacheKey, $cacheKey);
       }
     }
   }

diff --git a/CRM/Contact/BAO/Contact.php b/CRM/Contact/BAO/Contact.php
@@ -1317,13 +1317,7 @@ public static function importableFields(
     $cacheKeyString .= $checkPermission ? '_1' : '_0';
     $cacheKeyString .= '_' . CRM_Core_Config::domainID() . '_';
 
-    $fields = CRM_Utils_Array::value($cacheKeyString, self::$_importableFields);
-
-    $cache = Civi::cache('fields');
-    if (!$fields) {
-      // check if we can retrieve from database cache
-      $fields = $cache->get($cacheKeyString);
-    }
+    $fields = CRM_Utils_Array::value($cacheKeyString, self::$_importableFields) ?: Civi::cache('fields')->get($cacheKeyString);
 
     if (!$fields) {
       $fields = CRM_Contact_DAO_Contact::import();
@@ -1461,7 +1455,7 @@ public static function importableFields(
       //Sorting fields in alphabetical order(CRM-1507)
       $fields = CRM_Utils_Array::crmArraySortByField($fields, 'title');
 
-      $cache->set($cacheKeyString, $fields);
+      Civi::cache('fields')->set($cacheKeyString, $fields);
     }
 
     self::$_importableFields[$cacheKeyString] = $fields;
@@ -1519,8 +1513,7 @@ public static function &exportableFields($contactType = 'Individual', $status =
       }
 
       // check if we can retrieve from database cache
-      $cache = Civi::cache('fields');
-      $fields = $cache->get($cacheKeyString);
+      $fields = Civi::cache('fields')->get($cacheKeyString);
 
       if (!$fields) {
         $fields = CRM_Contact_DAO_Contact::export();
@@ -1710,7 +1703,7 @@ public static function &exportableFields($contactType = 'Individual', $status =
           }
         }
 
-        $cache->set($cacheKeyString, $fields);
+        Civi::cache('fields')->set($cacheKeyString, $fields);
       }
       self::$_exportableFields[$cacheKeyString] = $fields;
     }

diff --git a/CRM/Contact/BAO/GroupNestingCache.php b/CRM/Contact/BAO/GroupNestingCache.php
@@ -100,8 +100,7 @@ public static function update() {
     }
 
     // this tree stuff is quite useful, so lets store it in the cache
-    $cache = Civi::cache('groups');
-    $cache->set('nestable tree hierarchy', $tree);
+    Civi::cache('groups')->set('nestable tree hierarchy', $tree);
   }
 
   /**
@@ -154,12 +153,11 @@ public static function isCyclic(&$tree, $id) {
    * @return array
    */
   public static function getPotentialCandidates($id, &$groups) {
-    $cache = Civi::cache('groups');
-    $tree = $cache->get('nestable tree hierarchy');
+    $tree = Civi::cache('groups')->get('nestable tree hierarchy');
 
     if ($tree === NULL) {
       self::update();
-      $tree = $cache->get('nestable tree hierarchy');
+      $tree = Civi::cache('groups')->get('nestable tree hierarchy');
     }
 
     $potential = $groups;
@@ -221,12 +219,11 @@ public static function getAll(&$all, &$tree, $id, $token) {
    * @return string
    */
   public static function json() {
-    $cache = Civi::cache('groups');
-    $tree = $cache->get('nestable tree hierarchy');
+    $tree = Civi::cache('groups')->get('nestable tree hierarchy');
 
     if ($tree === NULL) {
       self::update();
-      $tree = $cache->get('nestable tree hierarchy');
+      $tree = Civi::cache('groups')->get('nestable tree hierarchy');
     }
 
     // get all the groups

diff --git a/CRM/Contact/Selector.php b/CRM/Contact/Selector.php
@@ -1063,7 +1063,7 @@ public function fillupPrevNextCache($sort, $cacheKey, $start = 0, $end = self::C
 
     if (Civi::service('prevnext') instanceof CRM_Core_PrevNextCache_Sql) {
       // SQL-backed prevnext cache uses an extra record for pruning the cache.
-      CRM_Core_BAO_Cache::setItem($cacheKey, 'CiviCRM Search PrevNextCache', $cacheKey);
+      Civi::cache('prevNextCache')->set($cacheKey, $cacheKey);
     }
   }
 

diff --git a/CRM/Core/BAO/Cache/Psr16.php b/CRM/Core/BAO/Cache/Psr16.php
@@ -181,9 +181,6 @@ public static function clearDBCache() {
    */
   public static function getLegacyGroups() {
     return [
-      // Core
-      'CiviCRM Search PrevNextCache',
-      'custom data',
 
       // Universe
 

diff --git a/CRM/Core/BAO/CustomField.php b/CRM/Core/BAO/CustomField.php
@@ -530,9 +530,8 @@ public static function &getFields(
       if (!self::$_importFields) {
         self::$_importFields = array();
       }
-      $cache = Civi::cache('fields');
       // check if we can retrieve from database cache
-      $fields = $cache->get("custom importableFields $cacheKey");
+      $fields = Civi::cache('fields')->get("custom importableFields $cacheKey");
 
       if ($fields === NULL) {
         $cfTable = self::getTableName();
@@ -677,7 +676,7 @@ public static function &getFields(
           self::getOptionsForField($fields[$dao->id], $dao->option_group_name);
 
         }
-        $cache->set("custom importableFields $cacheKey", $fields);
+        Civi::cache('fields')->set("custom importableFields $cacheKey", $fields);
       }
       self::$_importFields[$cacheKey] = $fields;
     }

diff --git a/CRM/Core/BAO/CustomGroup.php b/CRM/Core/BAO/CustomGroup.php
@@ -259,8 +259,7 @@ public static function retrieve(&$params, &$defaults) {
    */
   public static function setIsActive($id, $is_active) {
     // reset the cache
-    $cache = Civi::cache('fields');
-    $cache->flush();
+    Civi::cache('fields')->flush();
 
     if (!$is_active) {
       CRM_Core_BAO_UFField::setUFFieldStatus($id, $is_active);
@@ -1819,7 +1818,7 @@ public static function formatGroupTree(&$groupTree, $groupCount = 1, &$form = NU
 
     // fetch submitted custom field values later use to set as a default values
     if ($qfKey) {
-      $submittedValues = CRM_Core_BAO_Cache::getItem('custom data', $qfKey);
+      $submittedValues = Civi::cache('customData')->get($qfKey);
     }
 
     foreach ($groupTree as $key => $value) {
@@ -1878,7 +1877,7 @@ public static function formatGroupTree(&$groupTree, $groupCount = 1, &$form = NU
       if (count($formValues)) {
         $qf = $form->get('qfKey');
         $form->assign('qfKey', $qf);
-        CRM_Core_BAO_Cache::setItem($formValues, 'custom data', $qf);
+        Civi::cache('customData')->set($qf, $formValues);
       }
 
       // hack for field type File

diff --git a/CRM/Core/BAO/Navigation.php b/CRM/Core/BAO/Navigation.php
@@ -165,8 +165,7 @@ public static function getNavigationList() {
     $config = CRM_Core_Config::singleton();
 
     // check if we can retrieve from database cache
-    $cache = Civi::cache('navigation');
-    $navigations = $cache->get($cacheKeyString);
+    $navigations = Civi::cache('navigation')->get($cacheKeyString);
 
     if (!$navigations) {
       $domainID = CRM_Core_Config::domainID();
@@ -187,7 +186,7 @@ public static function getNavigationList() {
       $navigations = [];
       self::_getNavigationLabel($pidGroups[''], $navigations);
 
-      $cache->set($cacheKeyString, $navigations);
+      Civi::cache('navigation')->set($cacheKeyString, $navigations);
     }
     return $navigations;
   }

diff --git a/CRM/Core/BAO/PrevNextCache.php b/CRM/Core/BAO/PrevNextCache.php
@@ -424,7 +424,7 @@ public static function cleanupCache() {
 AND        c.created_date < date_sub( NOW( ), INTERVAL %2 day )
 ";
     $params = [
-      1 => ['CiviCRM Search PrevNextCache', 'String'],
+      1 => [CRM_Core_BAO_Cache::cleanKey('CiviCRM Search PrevNextCache'), 'String'],
       2 => [$cacheTimeIntervalDays, 'Integer'],
     ];
     CRM_Core_DAO::executeQuery($sql, $params);

diff --git a/CRM/Custom/Form/ChangeFieldType.php b/CRM/Custom/Form/ChangeFieldType.php
@@ -187,8 +187,7 @@ public function postProcess() {
     $customField->save();
 
     // Reset cache for custom fields
-    $cache = Civi::cache('fields');
-    $cache->flush();
+    Civi::cache('fields')->flush();
 
     CRM_Core_Session::setStatus(ts('Input type of custom field \'%1\' has been successfully changed to \'%2\'.',
       [1 => $this->_values['label'], 2 => $dstHtmlType]

diff --git a/CRM/Custom/Form/Field.php b/CRM/Custom/Form/Field.php
@@ -1019,8 +1019,7 @@ public function postProcess() {
     $this->_id = $customField->id;
 
     // reset the cache
-    $cache = Civi::cache('fields');
-    $cache->flush();
+    Civi::cache('fields')->flush();
 
     $msg = '<p>' . ts("Custom field '%1' has been saved.", [1 => $customField->label]) . '</p>';
 

diff --git a/CRM/Custom/Form/Group.php b/CRM/Custom/Form/Group.php
@@ -457,8 +457,7 @@ public function postProcess() {
     $group = CRM_Core_BAO_CustomGroup::create($params);
 
     // reset the cache
-    $cache = Civi::cache('fields');
-    $cache->flush();
+    Civi::cache('fields')->flush();
 
     if ($this->_action & CRM_Core_Action::UPDATE) {
       CRM_Core_Session::setStatus(ts('Your custom field set \'%1 \' has been saved.', [1 => $group->title]), ts('Saved'), 'success');

diff --git a/Civi/Core/Container.php b/Civi/Core/Container.php
@@ -159,6 +159,7 @@ public function createContainer() {
       'fields' => 'contact fields',
       'navigation' => 'navigation',
       'groups' => 'contact groups',
+      'customData' => 'custom data',
     ];
     foreach ($basicCaches as $cacheSvc => $cacheGrp) {
       $container->setDefinition("cache.{$cacheSvc}", new Definition(
@@ -172,6 +173,16 @@ public function createContainer() {
       ))->setFactory('CRM_Utils_Cache::create');
     }
 
+    $container->setDefinition("cache.prevNextCache", new Definition(
+      'CRM_Utils_Cache_Interface',
+      [
+        [
+          'name' => 'CiviCRM Search PrevNextCache',
+          'type' => ['SqlGroup'],
+        ],
+      ]
+    ))->setFactory('CRM_Utils_Cache::create');
+
     $container->setDefinition('sql_triggers', new Definition(
       'Civi\Core\SqlTriggers',
       []