Support Joomla!

Joomla! 1.5 Documentation

Packages

Package: Joomla-Framework

License

Content on this site is copyright © 2005 - 2008 by the individual contributors and can be used in accordance with the Creative Commons License, Attribution- NonCommercial- ShareAlike 2.5. Some parts of this website may be subject to other licenses.
Source code for file /joomla/cache/storage/memcache.php

Documentation is available at memcache.php

  1. <?php
  2. /**
  3.  * @version        $Id: memcache.php 9764 2007-12-30 07:48:11Z ircmaxell $
  4.  * @package        Joomla.Framework
  5.  * @subpackage    Cache
  6.  * @copyright    Copyright (C) 2005 - 2008 Open Source Matters. All rights reserved.
  7.  * @license        GNU/GPL, see LICENSE.php
  8.  *  Joomla! is free software. This version may have been modified pursuant
  9.  *  to the GNU General Public License, and as distributed it includes or
  10.  *  is derivative of works licensed under the GNU General Public License or
  11.  *  other free or open source software licenses.
  12.  *  See COPYRIGHT.php for copyright notices and details.
  13.  */
  14.  
  15. // Check to ensure this file is within the rest of the framework
  16. defined('JPATH_BASE') or die();
  17.  
  18. /**
  19.  * Memcache cache storage handler
  20.  *
  21.  * @author        Louis Landry <louis.landry@joomla.org>
  22.  * @author        Mitch Pirtle
  23.  * @package        Joomla.Framework
  24.  * @subpackage    Cache
  25.  * @since        1.5
  26.  */
  27. class JCacheStorageMemcache extends JCacheStorage
  28. {
  29.     /**
  30.      * Resource for the current memcached connection.
  31.      * @var resource 
  32.      */
  33.     var $_db;
  34.  
  35.     /**
  36.      * Use compression?
  37.      * @var int 
  38.      */
  39.     var $_compress = null;
  40.  
  41.     /**
  42.      * Use persistent connections
  43.      * @var boolean 
  44.      */
  45.     var $_persistent = false;
  46.  
  47.     /**
  48.      * Constructor
  49.      *
  50.      * @access protected
  51.      * @param array $options optional parameters
  52.      */
  53.     function __construct( $options = array() )
  54.     {
  55.         if (!$this->test()) {
  56.             return JError::raiseError(404, "The memcache extension is not available");
  57.         }
  58.  
  59.         parent::__construct($options);
  60.  
  61.         $config =& JFactory::getConfig();
  62.  
  63.         $params = $config->getValue('config.memcache_settings');
  64.         if (!is_array($params)) {
  65.             $params = unserialize(stripslashes($params));
  66.         }
  67.  
  68.         if (!$params) {
  69.             $params = array();
  70.         }
  71.  
  72.         $this->_compress    = (isset($params['compression'])) ? $params['compression'] : 0;
  73.         $this->_persistent    = (isset($params['persistent'])) ? $params['persistent'] : false;
  74.  
  75.         // This will be an array of loveliness
  76.         $this->_servers    = (isset($params['servers'])) ? $params['servers'] : array();
  77.  
  78.         // Create the memcache connection
  79.         $this->_db = new Memcache;
  80.         for ($i=0, $n=count($this->_servers); $i < $n; $i++)
  81.         {
  82.             $server = $this->_servers[$i];
  83.             $this->_db->addServer($server['host'], $server['port'], $this->_persistent);
  84.         }
  85.  
  86.         // Get the site hash
  87.         $this->_hash = $config->getValue('config.secret');
  88.     }
  89.  
  90.     /**
  91.      * Get cached data from memcache by id and group
  92.      *
  93.      * @access    public
  94.      * @param    string    $id            The cache data id
  95.      * @param    string    $group        The cache data group
  96.      * @param    boolean    $checkTime    True to verify cache time expiration threshold
  97.      * @return    mixed    Boolean false on failure or a cached data string
  98.      * @since    1.5
  99.      */
  100.     function get($id, $group, $checkTime)
  101.     {
  102.         $cache_id = $this->_getCacheId($id, $group);
  103.         $this->_setExpire($cache_id);
  104.         return $this->_db->get($cache_id);
  105.     }
  106.  
  107.     /**
  108.      * Store the data to memcache by id and group
  109.      *
  110.      * @access    public
  111.      * @param    string    $id        The cache data id
  112.      * @param    string    $group    The cache data group
  113.      * @param    string    $data    The data to store in cache
  114.      * @return    boolean    True on success, false otherwise
  115.      * @since    1.5
  116.      */
  117.     function store($id, $group, $data)
  118.     {
  119.         $cache_id = $this->_getCacheId($id, $group);
  120.         $this->_db->set($cache_id.'_expire', time(), 0, 0);
  121.         return $this->_db->set($cache_id, $data, $this->_compress, 0);
  122.     }
  123.  
  124.     /**
  125.      * Remove a cached data entry by id and group
  126.      *
  127.      * @access    public
  128.      * @param    string    $id        The cache data id
  129.      * @param    string    $group    The cache data group
  130.      * @return    boolean    True on success, false otherwise
  131.      * @since    1.5
  132.      */
  133.     function remove($id, $group)
  134.     {
  135.         $cache_id = $this->_getCacheId($id, $group);
  136.         $this->_db->delete($cache_id.'_expire');
  137.         return $this->_db->delete($cache_id);
  138.     }
  139.  
  140.     /**
  141.      * Clean cache for a group given a mode.
  142.      *
  143.      * group mode        : cleans all cache in the group
  144.      * notgroup mode    : cleans all cache not in the group
  145.      *
  146.      * @access    public
  147.      * @param    string    $group    The cache data group
  148.      * @param    string    $mode    The mode for cleaning cache [group|notgroup]
  149.      * @return    boolean    True on success, false otherwise
  150.      * @since    1.5
  151.      */
  152.     function clean($group, $mode)
  153.     {
  154.         return true;
  155.     }
  156.  
  157.     /**
  158.      * Garbage collect expired cache data
  159.      *
  160.      * @access public
  161.      * @return boolean  True on success, false otherwise.
  162.      */
  163.     function gc()
  164.     {
  165.         return true;
  166.     }
  167.  
  168.     /**
  169.      * Test to see if the cache storage is available.
  170.      *
  171.      * @static
  172.      * @access public
  173.      * @return boolean  True on success, false otherwise.
  174.      */
  175.     function test()
  176.     {
  177.         return (extension_loaded('memcache') && class_exists('Memcache'));
  178.     }
  179.  
  180.     /**
  181.      * Set expire time on each call since memcache sets it on cache creation.
  182.      *
  183.      * @access private
  184.      *
  185.      * @param string  $key   Cache key to expire.
  186.      * @param integer $lifetime  Lifetime of the data in seconds.
  187.      */
  188.     function _setExpire($key)
  189.     {
  190.         $lifetime    = $this->_lifetime;
  191.         $expire        = $this->_db->get($key.'_expire');
  192.  
  193.         // set prune period
  194.         if ($expire + $lifetime < time()) {
  195.             $this->_db->delete($key);
  196.             $this->_db->delete($key.'_expire');
  197.         } else {
  198.             $this->_db->replace($key.'_expire', time());
  199.         }
  200.     }
  201.  
  202.     /**
  203.      * Get a cache_id string from an id/group pair
  204.      *
  205.      * @access    private
  206.      * @param    string    $id        The cache data id
  207.      * @param    string    $group    The cache data group
  208.      * @return    string    The cache_id string
  209.      * @since    1.5
  210.      */
  211.     function _getCacheId($id, $group)
  212.     {
  213.         $name    = md5($this->_application.'-'.$id.'-'.$this->_hash.'-'.$this->_language);
  214.         return 'cache_'.$group.'-'.$name;
  215.     }
  216. }
Documentation generated on Tue, 29 Jan 2008 18:48:18 +0000 by phpDocumentor 1.3.1