Memcache.php 4.8 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180
  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-2016, Ryan Parman, Sam 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. * @copyright 2004-2016 Ryan Parman, Sam Sneddon, Ryan McCue
  37. * @author Ryan Parman
  38. * @author Sam Sneddon
  39. * @author Ryan McCue
  40. * @link http://simplepie.org/ SimplePie
  41. * @license http://www.opensource.org/licenses/bsd-license.php BSD License
  42. */
  43. /**
  44. * Caches data to memcache
  45. *
  46. * Registered for URLs with the "memcache" protocol
  47. *
  48. * For example, `memcache://localhost:11211/?timeout=3600&prefix=sp_` will
  49. * connect to memcache on `localhost` on port 11211. All tables will be
  50. * prefixed with `sp_` and data will expire after 3600 seconds
  51. *
  52. * @package SimplePie
  53. * @subpackage Caching
  54. * @uses Memcache
  55. */
  56. class SimplePie_Cache_Memcache implements SimplePie_Cache_Base
  57. {
  58. /**
  59. * Memcache instance
  60. *
  61. * @var Memcache
  62. */
  63. protected $cache;
  64. /**
  65. * Options
  66. *
  67. * @var array
  68. */
  69. protected $options;
  70. /**
  71. * Cache name
  72. *
  73. * @var string
  74. */
  75. protected $name;
  76. /**
  77. * Create a new cache object
  78. *
  79. * @param string $location Location string (from SimplePie::$cache_location)
  80. * @param string $name Unique ID for the cache
  81. * @param string $type Either TYPE_FEED for SimplePie data, or TYPE_IMAGE for image data
  82. */
  83. public function __construct($location, $name, $type)
  84. {
  85. $this->options = array(
  86. 'host' => '127.0.0.1',
  87. 'port' => 11211,
  88. 'extras' => array(
  89. 'timeout' => 3600, // one hour
  90. 'prefix' => 'simplepie_',
  91. ),
  92. );
  93. $this->options = SimplePie_Misc::array_merge_recursive($this->options, SimplePie_Cache::parse_URL($location));
  94. $this->name = $this->options['extras']['prefix'] . md5("$name:$type");
  95. $this->cache = new Memcache();
  96. $this->cache->addServer($this->options['host'], (int) $this->options['port']);
  97. }
  98. /**
  99. * Save data to the cache
  100. *
  101. * @param array|SimplePie $data Data to store in the cache. If passed a SimplePie object, only cache the $data property
  102. * @return bool Successfulness
  103. */
  104. public function save($data)
  105. {
  106. if ($data instanceof SimplePie)
  107. {
  108. $data = $data->data;
  109. }
  110. return $this->cache->set($this->name, serialize($data), MEMCACHE_COMPRESSED, (int) $this->options['extras']['timeout']);
  111. }
  112. /**
  113. * Retrieve the data saved to the cache
  114. *
  115. * @return array Data for SimplePie::$data
  116. */
  117. public function load()
  118. {
  119. $data = $this->cache->get($this->name);
  120. if ($data !== false)
  121. {
  122. return unserialize($data);
  123. }
  124. return false;
  125. }
  126. /**
  127. * Retrieve the last modified time for the cache
  128. *
  129. * @return int Timestamp
  130. */
  131. public function mtime()
  132. {
  133. $data = $this->cache->get($this->name);
  134. if ($data !== false)
  135. {
  136. // essentially ignore the mtime because Memcache expires on its own
  137. return time();
  138. }
  139. return false;
  140. }
  141. /**
  142. * Set the last modified time to the current time
  143. *
  144. * @return bool Success status
  145. */
  146. public function touch()
  147. {
  148. $data = $this->cache->get($this->name);
  149. if ($data !== false)
  150. {
  151. return $this->cache->set($this->name, $data, MEMCACHE_COMPRESSED, (int) $this->options['extras']['timeout']);
  152. }
  153. return false;
  154. }
  155. /**
  156. * Remove the cache
  157. *
  158. * @return bool Success status
  159. */
  160. public function unlink()
  161. {
  162. return $this->cache->delete($this->name, 0);
  163. }
  164. }