[mms] Improved prefs caching.

Use Horde_Core_Cache_Session to store data in the session, allowing for offloading of data if it becomes too large. Deprecate Horde_Core_Prefs_Cache_Session
horde · Dec 3, 2014 · 297c714 · 297c714
1 parent d246adc
commit 297c714
Show file tree

Hide file tree

Showing 3 changed files with 57 additions and 11 deletions.
diff --git a/framework/Core/lib/Horde/Core/Factory/Prefs.php b/framework/Core/lib/Horde/Core/Factory/Prefs.php
@@ -170,7 +170,7 @@ function_exists($params['user_hook'])) {
             : array($config_driver, $hooks_driver);
 
         if ($driver && $opts['cache']) {
-            $opts['cache'] = new Horde_Core_Prefs_Cache_Session($opts['user']);
+            $opts['cache'] = $this->_getCache($opts['user'], false);
         } else {
             unset($opts['cache']);
         }
@@ -180,9 +180,15 @@ function_exists($params['user_hook'])) {
         } catch (Horde_Prefs_Exception $e) {
             $this->_notifyError($e);
 
-            /* Store data in the cached session object. */
-            $opts['cache'] = new Horde_Core_Prefs_Cache_Session($opts['user']);
-            $this->_instances[$sig] = new Horde_Prefs($scope, array($config_driver, $hooks_driver), $opts);
+            /* Store data in the cached session object. This cache data is
+             * stored for the life of the session. */
+            $opts['cache'] = $this->_getCache($opts['user'], true);
+
+            $this->_instances[$sig] = new Horde_Prefs(
+                $scope,
+                array($config_driver, $hooks_driver),
+                $opts
+            );
         }
 
         return $this->_instances[$sig];
@@ -205,6 +211,44 @@ protected function _notifyError($e)
         }
     }
 
+    /**
+     * Return the cache object to use for the prefs driver.
+     *
+     * @param string $user       Username.
+     * @param boolean $fallback  Return the fallback cache driver?
+     *
+     * @return Horde_Cache  Cache object.
+     */
+    protected function _getCache($user, $fallback)
+    {
+        global $injector;
+
+        $params = array(
+            'app' => 'horde',
+            'storage_key' => 'horde_prefs_cache'
+        );
+
+        if ($fallback) {
+            $params['cache'] = new Horde_Cache_Storage_Null();
+            $params['maxsize'] = 0;
+        } else {
+            $params['cache'] = $injector->getInstance('Horde_Cache');
+        }
+
+        return new Horde_Prefs_Cache_HordeCache(
+            $user,
+            array(
+                'cache' => new Horde_Cache(
+                    new Horde_Core_Cache_Session($params),
+                    array(
+                        'compress' => true,
+                        'logger' => $injector->getInstance('Horde_Core_Log_Wrapper')
+                    )
+                )
+            )
+        );
+    }
+
     /**
      * Clear the instances cache.
      *

diff --git a/framework/Core/lib/Horde/Core/Prefs/Cache/Session.php b/framework/Core/lib/Horde/Core/Prefs/Cache/Session.php
@@ -14,11 +14,13 @@
 /**
  * Cache storage implementation using Horde_Session.
  *
- * @author    Michael Slusarz <slusarz@horde.org>
- * @category  Horde
- * @copyright 2010-2014 Horde LLC
- * @license   http://www.horde.org/licenses/lgpl21 LGPL 2.1
- * @package   Core
+ * @author     Michael Slusarz <slusarz@horde.org>
+ * @category   Horde
+ * @copyright  2010-2014 Horde LLC
+ * @deprecated Use Horde_Prefs_Cache_HordeCache with the
+ *             Horde_Core_Cache_Session driver instead.
+ * @license    http://www.horde.org/licenses/lgpl21 LGPL 2.1
+ * @package    Core
  */
 class Horde_Core_Prefs_Cache_Session extends Horde_Prefs_Cache_Base
 {

diff --git a/framework/Core/package.xml b/framework/Core/package.xml
@@ -28,7 +28,7 @@
   <email>mrubinsk@horde.org</email>
   <active>yes</active>
  </developer>
- <date>2014-11-25</date>
+ <date>2014-12-03</date>
  <version>
   <release>2.17.2</release>
   <api>2.17.0</api>
@@ -3739,7 +3739,7 @@
    <stability>
     <release>stable</release>
     <api>stable</api></stability>
-   <date>2014-11-25</date>
+   <date>2014-12-03</date>
    <license uri="http://www.horde.org/licenses/lgpl21">LGPL-2.1</license>
    <notes>
 *