[Summary view] [Print] [Text view]

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