1. sfSQLiteCache.class.php
  2. /**
 * Cache class that stores cached content in a SQLite database.
 *
 * @package    symfony
 * @subpackage cache
 * @author     Fabien Potencier 
 * @version    SVN: $Id: sfSQLiteCache.class.php 23501 2009-11-01 22:54:37Z FabianLange $
 */
  3. class sfSQLiteCache extends sfCache
  4. {
  5.   protected
  6.     $dbh      = null,
  7.     $database = '';
  9.   /**
  10.    * Initializes this sfCache instance.
  11.    *
  12.    * Available options:
  13.    *
  14.    * * database: File where to put the cache database (or :memory: to store cache in memory)
  15.    *
  16.    * * see sfCache for options available for all drivers
  17.    *
  18.    * @see sfCache
  19.    */
  20.   public function initialize($options = array())
  21.   {
  22.     if (!extension_loaded('SQLite') && !extension_loaded('pdo_SQLite'))
  23.     {
  24.       throw new sfConfigurationException('sfSQLiteCache class needs "sqlite" or "pdo_sqlite" extension to be loaded.');
  25.     }
  27.     parent::initialize($options);
  29.     if (!$this->getOption('database'))
  30.     {
  31.       throw new sfInitializationException('You must pass a "database" option to initialize a sfSQLiteCache object.');
  32.     }
  34.     $this->setDatabase($this->getOption('database'));
  35.   }
  37.   /**
  38.    * @see sfCache
  39.    */
  40.   public function getBackend()
  41.   {
  42.     return $this->dbh;
  43.   }
  45.   /**
  46.    * @see sfCache
  47.    */
  48.   public function get($key, $default = null)
  49.   {
  50.     $data = $this->dbh->singleQuery(sprintf("SELECT data FROM cache WHERE key = '%s' AND timeout > %d", sqlite_escape_string($key), time()));
  52.     return null === $data ? $default : $data;
  53.   }
  55.   /**
  56.    * @see sfCache
  57.    */
  58.   public function has($key)
  59.   {
  60.     return (boolean) $this->dbh->query(sprintf("SELECT key FROM cache WHERE key = '%s' AND timeout > %d", sqlite_escape_string($key), time()))->numRows();
  61.   }
  63.   /**
  64.    * @see sfCache
  65.    */
  66.   public function set($key, $data, $lifetime = null)
  67.   {
  68.     if ($this->getOption('automatic_cleaning_factor') > 0 && rand(1, $this->getOption('automatic_cleaning_factor')) == 1)
  69.     {
  70.       $this->clean(sfCache::OLD);
  71.     }
  73.     return (boolean) $this->dbh->query(sprintf("INSERT OR REPLACE INTO cache (key, data, timeout, last_modified) VALUES ('%s', '%s', %d, %d)", sqlite_escape_string($key), sqlite_escape_string($data), time() + $this->getLifetime($lifetime), time()));
  74.   }
  76.   /**
  77.    * @see sfCache
  78.    */
  79.   public function remove($key)
  80.   {
  81.     return (boolean) $this->dbh->query(sprintf("DELETE FROM cache WHERE key = '%s'", sqlite_escape_string($key)));
  82.   }
  84.   /**
  85.    * @see sfCache
  86.    */
  87.   public function removePattern($pattern)
  88.   {
  89.     return (boolean) $this->dbh->query(sprintf("DELETE FROM cache WHERE REGEXP('%s', key)", sqlite_escape_string(self::patternToRegexp($pattern))));
  90.   }
  92.   /**
  93.    * @see sfCache
  94.    */
  95.   public function clean($mode = sfCache::ALL)
  96.   {
  97.     return (boolean) $this->dbh->query("DELETE FROM cache".(sfCache::OLD == $mode ? sprintf(" WHERE timeout < '%s'", time()) : ''))->numRows();
  98.   }
  100.   /**
  101.    * @see sfCache
  102.    */
  103.   public function getTimeout($key)
  104.   {
  105.     $rs = $this->dbh->query(sprintf("SELECT timeout FROM cache WHERE key = '%s' AND timeout > %d", sqlite_escape_string($key), time()));
  107.     return $rs->numRows() ? intval($rs->fetchSingle()) : 0;
  108.   }
  110.   /**
  111.    * @see sfCache
  112.    */
  113.   public function getLastModified($key)
  114.   {
  115.     $rs = $this->dbh->query(sprintf("SELECT last_modified FROM cache WHERE key = '%s' AND timeout > %d", sqlite_escape_string($key), time()));
  117.     return $rs->numRows() ? intval($rs->fetchSingle()) : 0;
  118.   }
  120.   /**
  121.    * Sets the database name.
  122.    *
  123.    * @param string $database The database name where to store the cache
  124.    */
  125.   protected function setDatabase($database)
  126.   {
  127.     $this->database = $database;
  129.     $new = false;
  130.     if (':memory:' == $database)
  131.     {
  132.       $new = true;
  133.     }
  134.     else if (!is_file($database))
  135.     {
  136.       $new = true;
  138.       // create cache dir if needed
  139.       $dir = dirname($database);
  140.       $current_umask = umask(0000);
  141.       if (!is_dir($dir))
  142.       {
  143.         @mkdir($dir, 0777, true);
  144.       }
  146.       touch($database);
  147.       umask($current_umask);
  148.     }
  150.     if (!$this->dbh = new SQLiteDatabase($this->database, 0644, $errmsg))
  151.     {
  152.       throw new sfCacheException(sprintf('Unable to connect to SQLite database: %s.', $errmsg));
  153.     }
  155.     $this->dbh->createFunction('regexp', array($this, 'removePatternRegexpCallback'), 2);
  157.     if ($new)
  158.     {
  159.       $this->createSchema();
  160.     }
  161.   }
  163.   /**
  164.    * Callback used when deleting keys from cache.
  165.    */
  166.   public function removePatternRegexpCallback($regexp, $key)
  167.   {
  168.     return preg_match($regexp, $key);
  169.   }
  171.   /**
  172.    * @see sfCache
  173.    */
  174.   public function getMany($keys)
  175.   {
  176.     $rows = $this->dbh->arrayQuery(sprintf("SELECT key, data FROM cache WHERE key IN ('%s') AND timeout > %d", implode('\', \'', array_map('sqlite_escape_string', $keys)), time()));
  178.     $data = array();
  179.     foreach ($rows as $row)
  180.     {
  181.       $data[$row['key']] = $row['data'];
  182.     }
  184.     return $data;
  185.   }
  187.   /**
  188.    * Creates the database schema.
  189.    *
  190.    * @throws sfCacheException
  191.    */
  192.   protected function createSchema()
  193.   {
  194.     $statements = array(
  195.       'CREATE TABLE [cache] (
  196.         [key] VARCHAR(255),
  197.         [data] LONGVARCHAR,
  198.         [timeout] TIMESTAMP,
  199.         [last_modified] TIMESTAMP
  200.       )',
  201.       'CREATE UNIQUE INDEX [cache_unique] ON [cache] ([key])',
  202.     );
  204.     foreach ($statements as $statement)
  205.     {
  206.       if (!$this->dbh->query($statement))
  207.       {
  208.         throw new sfCacheException(sqlite_error_string($this->dbh->lastError()));
  209.       }
  210.     }
  211.   }
  212. }
Debug toolbar