[Summary view] [Print] [Text view]

   1  <?php
   2  /**
   3   * SimplePie
   4   *
   5   * A PHP-Based RSS and Atom Feed Framework.
   6   * Takes the hard work out of managing a complete RSS/Atom solution.
   7   *
   8   * Copyright (c) 2004-2012, Ryan Parman, Geoffrey Sneddon, Ryan McCue, and contributors
   9   * All rights reserved.
  10   *
  11   * Redistribution and use in source and binary forms, with or without modification, are
  12   * permitted provided that the following conditions are met:
  13   *
  14   *     * Redistributions of source code must retain the above copyright notice, this list of
  15   *       conditions and the following disclaimer.
  16   *
  17   *     * Redistributions in binary form must reproduce the above copyright notice, this list
  18   *       of conditions and the following disclaimer in the documentation and/or other materials
  19   *       provided with the distribution.
  20   *
  21   *     * Neither the name of the SimplePie Team nor the names of its contributors may be used
  22   *       to endorse or promote products derived from this software without specific prior
  23   *       written permission.
  24   *
  25   * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" AND ANY EXPRESS
  26   * OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY
  27   * AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDERS
  28   * AND CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR
  29   * CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR
  30   * SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
  31   * THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR
  32   * OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
  33   * POSSIBILITY OF SUCH DAMAGE.
  34   *
  35   * @package SimplePie
  36   * @version 1.3.1
  37   * @copyright 2004-2012 Ryan Parman, Geoffrey Sneddon, Ryan McCue
  38   * @author Ryan Parman
  39   * @author Geoffrey Sneddon
  40   * @author Ryan McCue
  41   * @link http://simplepie.org/ SimplePie
  42   * @license http://www.opensource.org/licenses/bsd-license.php BSD License
  43   */
  44  
  45  /**
  46   * Caches data to memcache
  47   *
  48   * Registered for URLs with the "memcache" protocol
  49   *
  50   * For example, `memcache://localhost:11211/?timeout=3600&prefix=sp_` will
  51   * connect to memcache on `localhost` on port 11211. All tables will be
  52   * prefixed with `sp_` and data will expire after 3600 seconds
  53   *
  54   * @package SimplePie
  55   * @subpackage Caching
  56   * @uses Memcache
  57   */
  58  class SimplePie_Cache_Memcache implements SimplePie_Cache_Base
  59  {
  60      /**
  61       * Memcache instance
  62       *
  63       * @var Memcache
  64       */
  65      protected $cache;
  66  
  67      /**
  68       * Options
  69       *
  70       * @var array
  71       */
  72      protected $options;
  73  
  74      /**
  75       * Cache name
  76       *
  77       * @var string
  78       */
  79      protected $name;
  80  
  81      /**
  82       * Create a new cache object
  83       *
  84       * @param string $location Location string (from SimplePie::$cache_location)
  85       * @param string $name Unique ID for the cache
  86       * @param string $type Either TYPE_FEED for SimplePie data, or TYPE_IMAGE for image data
  87       */
  88  	public function __construct($location, $name, $type)
  89      {
  90          $this->options = array(
  91              'host' => '127.0.0.1',
  92              'port' => 11211,
  93              'extras' => array(
  94                  'timeout' => 3600, // one hour
  95                  'prefix' => 'simplepie_',
  96              ),
  97          );
  98          $parsed = SimplePie_Cache::parse_URL($location);
  99          $this->options['host'] = empty($parsed['host']) ? $this->options['host'] : $parsed['host'];
 100          $this->options['port'] = empty($parsed['port']) ? $this->options['port'] : $parsed['port'];
 101          $this->options['extras'] = array_merge($this->options['extras'], $parsed['extras']);
 102          $this->name = $this->options['extras']['prefix'] . md5("$name:$type");
 103  
 104          $this->cache = new Memcache();
 105          $this->cache->addServer($this->options['host'], (int) $this->options['port']);
 106      }
 107  
 108      /**
 109       * Save data to the cache
 110       *
 111       * @param array|SimplePie $data Data to store in the cache. If passed a SimplePie object, only cache the $data property
 112       * @return bool Successfulness
 113       */
 114  	public function save($data)
 115      {
 116          if ($data instanceof SimplePie)
 117          {
 118              $data = $data->data;
 119          }
 120          return $this->cache->set($this->name, serialize($data), MEMCACHE_COMPRESSED, (int) $this->options['extras']['timeout']);
 121      }
 122  
 123      /**
 124       * Retrieve the data saved to the cache
 125       *
 126       * @return array Data for SimplePie::$data
 127       */
 128  	public function load()
 129      {
 130          $data = $this->cache->get($this->name);
 131  
 132          if ($data !== false)
 133          {
 134              return unserialize($data);
 135          }
 136          return false;
 137      }
 138  
 139      /**
 140       * Retrieve the last modified time for the cache
 141       *
 142       * @return int Timestamp
 143       */
 144  	public function mtime()
 145      {
 146          $data = $this->cache->get($this->name);
 147  
 148          if ($data !== false)
 149          {
 150              // essentially ignore the mtime because Memcache expires on it's own
 151              return time();
 152          }
 153  
 154          return false;
 155      }
 156  
 157      /**
 158       * Set the last modified time to the current time
 159       *
 160       * @return bool Success status
 161       */
 162  	public function touch()
 163      {
 164          $data = $this->cache->get($this->name);
 165  
 166          if ($data !== false)
 167          {
 168              return $this->cache->set($this->name, $data, MEMCACHE_COMPRESSED, (int) $this->duration);
 169          }
 170  
 171          return false;
 172      }
 173  
 174      /**
 175       * Remove the cache
 176       *
 177       * @return bool Success status
 178       */
 179  	public function unlink()
 180      {
 181          return $this->cache->delete($this->name, 0);
 182      }
 183  }