Add APCu support

Support for the APCu extension (through sfAPCuCache) as an alternative to APC which longer works with recent versions of PHP.

Author: mentalstring

data/bin/check_configuration.php

@@ -84,7 +84,7 @@ function get_ini_path()
 check(function_exists('posix_isatty'), 'The posix_isatty() is available', 'Install and enable the php_posix extension (used to colorized the CLI output)', false);
 
 $accelerator =
-  (function_exists('apc_store') && ini_get('apc.enabled'))
+  ((function_exists('apc_store') || function_exists('apcu_store')) && ini_get('apc.enabled'))
   ||
   function_exists('eaccelerator_put') && ini_get('eaccelerator.enable')
   ||

lib/autoload/sfCoreAutoload.class.php

@@ -194,6 +194,7 @@ static public function make()
     'sfcoreautoload' => 'autoload/sfCoreAutoload.class.php',
     'sfsimpleautoload' => 'autoload/sfSimpleAutoload.class.php',
     'sfapccache' => 'cache/sfAPCCache.class.php',
+    'sfapcucache' => 'cache/sfAPCuCache.class.php',
     'sfcache' => 'cache/sfCache.class.php',
     'sfeacceleratorcache' => 'cache/sfEAcceleratorCache.class.php',
     'sffilecache' => 'cache/sfFileCache.class.php',

lib/cache/sfAPCuCache.class.php

@@ -0,0 +1,221 @@
+<?php
+
+/*
+ * This file is part of the symfony package.
+ * (c) 2004-2006 Fabien Potencier <fabien.potencier@symfony-project.com>
+ *
+ * For the full copyright and license information, please view the LICENSE
+ * file that was distributed with this source code.
+ */
+
+/**
+ * Cache class that stores cached content in APCu.
+ *
+ * @package    symfony
+ * @subpackage cache
+ * @author     Fabien Potencier <fabien.potencier@symfony-project.com>
+ * @author     Paulo M
+ * @version    SVN: $Id$
+ */
+class sfAPCuCache extends sfCache
+{
+  protected $enabled;
+
+  /**
+   * Initializes this sfCache instance.
+   *
+   * Available options:
+   *
+   * * see sfCache for options available for all drivers
+   *
+   * @see sfCache
+   * @inheritdoc
+   */
+  public function initialize($options = array())
+  {
+    parent::initialize($options);
+
+    $this->enabled = function_exists('apcu_store') && ini_get('apc.enabled');
+  }
+
+  /**
+   * @see sfCache
+   * @inheritdoc
+   */
+  public function get($key, $default = null)
+  {
+    if (!$this->enabled)
+    {
+      return $default;
+    }
+
+    $value = $this->fetch($this->getOption('prefix').$key, $has);
+
+    return $has ? $value : $default;
+  }
+
+  /**
+   * @see sfCache
+   * @inheritdoc
+   */
+  public function has($key)
+  {
+    if (!$this->enabled)
+    {
+      return false;
+    }
+
+    $this->fetch($this->getOption('prefix').$key, $has);
+
+    return $has;
+  }
+
+  private function fetch($key, &$success)
+  {
+    $has = null;
+    $value = apcu_fetch($key, $has);
+    // the second argument was added in APC 3.0.17. If it is still null we fall back to the value returned
+    if (null !== $has)
+    {
+      $success = $has;
+    }
+    else
+    {
+      $success = $value !== false;
+    }
+
+    return $value;
+  }
+
+
+  /**
+   * @see sfCache
+   * @inheritdoc
+   */
+  public function set($key, $data, $lifetime = null)
+  {
+    if (!$this->enabled)
+    {
+      return true;
+    }
+
+    return apcu_store($this->getOption('prefix').$key, $data, $this->getLifetime($lifetime));
+  }
+
+  /**
+   * @see sfCache
+   * @inheritdoc
+   */
+  public function remove($key)
+  {
+    if (!$this->enabled)
+    {
+      return true;
+    }
+
+    return apcu_delete($this->getOption('prefix').$key);
+  }
+
+  /**
+   * @see sfCache
+   * @inheritdoc
+   */
+  public function clean($mode = sfCache::ALL)
+  {
+    if (!$this->enabled)
+    {
+      return true;
+    }
+
+    if (sfCache::ALL === $mode)
+    {
+      return apcu_clear_cache();
+    }
+  }
+
+  /**
+   * @see sfCache
+   * @inheritdoc
+   */
+  public function getLastModified($key)
+  {
+    if ($info = $this->getCacheInfo($key))
+    {
+      return $info['creation_time'] + $info['ttl'] > time() ? $info['mtime'] : 0;
+    }
+
+    return 0;
+  }
+
+  /**
+   * @see sfCache
+   * @inheritdoc
+   */
+  public function getTimeout($key)
+  {
+    if ($info = $this->getCacheInfo($key))
+    {
+      return $info['creation_time'] + $info['ttl'] > time() ? $info['creation_time'] + $info['ttl'] : 0;
+    }
+
+    return 0;
+  }
+
+  /**
+   * @see sfCache
+   * @inheritdoc
+   */
+  public function removePattern($pattern)
+  {
+    if (!$this->enabled)
+    {
+      return true;
+    }
+
+    $infos = apcu_cache_info();
+    if (!is_array($infos['cache_list']))
+    {
+      return;
+    }
+
+    $regexp = self::patternToRegexp($this->getOption('prefix').$pattern);
+
+    foreach ($infos['cache_list'] as $info)
+    {
+      if (preg_match($regexp, $info['info']))
+      {
+        apcu_delete($info['info']);
+      }
+    }
+  }
+
+  /**
+   * Gets the cache info
+   *
+   * @param  string $key The cache key
+   *
+   * @return string
+   */
+  protected function getCacheInfo($key)
+  {
+    if (!$this->enabled)
+    {
+      return false;
+    }
+
+    $infos = apcu_cache_info();
+
+    if (is_array($infos['cache_list']))
+    {
+      foreach ($infos['cache_list'] as $info)
+      {
+        if ($this->getOption('prefix').$key == $info['info'])
+        {
+          return $info;
+        }
+      }
+    }
+
+    return null;
+  }
+}

test/unit/cache/sfAPCCacheTest.php

@@ -13,9 +13,18 @@
 $plan = 64;
 $t = new lime_test($plan);
 
+if (extension_loaded('apc')) {
+  $cacheClass = 'sfAPCCache';
+} elseif (extension_loaded('apcu')) {
+  $cacheClass = 'sfAPCuCache';
+} else {
+  $t->skip('APC or APCu must be loaded to run these tests', $plan);
+  return;
+}
+
 try
 {
-  new sfAPCCache();
+  new $cacheClass();
 }
 catch (sfInitializationException $e)
 {
@@ -36,7 +45,7 @@
 
 // ->initialize()
 $t->diag('->initialize()');
-$cache = new sfAPCCache();
+$cache = new $cacheClass();
 $cache->initialize();
 
 // make sure expired keys are dropped