<?php

[0] Fix | Delete

[1] Fix | Delete

// SPDX-FileCopyrightText: 2004-2023 Ryan Parman, Sam Sneddon, Ryan McCue

[2] Fix | Delete

// SPDX-License-Identifier: BSD-3-Clause

[3] Fix | Delete

[4] Fix | Delete

declare(strict_types=1);

[5] Fix | Delete

[6] Fix | Delete

namespace SimplePie\Cache;

[7] Fix | Delete

[8] Fix | Delete

use Memcache as NativeMemcache;

[9] Fix | Delete

[10] Fix | Delete

/**

[11] Fix | Delete

* Caches data to memcache

[12] Fix | Delete

*

[13] Fix | Delete

* Registered for URLs with the "memcache" protocol

[14] Fix | Delete

*

[15] Fix | Delete

* For example, `memcache://localhost:11211/?timeout=3600&prefix=sp_` will

[16] Fix | Delete

* connect to memcache on `localhost` on port 11211. All tables will be

[17] Fix | Delete

* prefixed with `sp_` and data will expire after 3600 seconds

[18] Fix | Delete

*

[19] Fix | Delete

* @uses Memcache

[20] Fix | Delete

* @deprecated since SimplePie 1.8.0, use implementation of "Psr\SimpleCache\CacheInterface" instead

[21] Fix | Delete

*/

[22] Fix | Delete

class Memcache implements Base

[23] Fix | Delete

{

[24] Fix | Delete

/**

[25] Fix | Delete

* Memcache instance

[26] Fix | Delete

*

[27] Fix | Delete

* @var NativeMemcache

[28] Fix | Delete

*/

[29] Fix | Delete

protected $cache;

[30] Fix | Delete

[31] Fix | Delete

/**

[32] Fix | Delete

* Options

[33] Fix | Delete

*

[34] Fix | Delete

* @var array<string, mixed>

[35] Fix | Delete

*/

[36] Fix | Delete

protected $options;

[37] Fix | Delete

[38] Fix | Delete

/**

[39] Fix | Delete

* Cache name

[40] Fix | Delete

*

[41] Fix | Delete

* @var string

[42] Fix | Delete

*/

[43] Fix | Delete

protected $name;

[44] Fix | Delete

[45] Fix | Delete

/**

[46] Fix | Delete

* Create a new cache object

[47] Fix | Delete

*

[48] Fix | Delete

* @param string $location Location string (from SimplePie::$cache_location)

[49] Fix | Delete

* @param string $name Unique ID for the cache

[50] Fix | Delete

* @param Base::TYPE_FEED|Base::TYPE_IMAGE $type Either TYPE_FEED for SimplePie data, or TYPE_IMAGE for image data

[51] Fix | Delete

*/

[52] Fix | Delete

public function __construct(string $location, string $name, $type)

[53] Fix | Delete

{

[54] Fix | Delete

$this->options = [

[55] Fix | Delete

'host' => '127.0.0.1',

[56] Fix | Delete

'port' => 11211,

[57] Fix | Delete

'extras' => [

[58] Fix | Delete

'timeout' => 3600, // one hour

[59] Fix | Delete

'prefix' => 'simplepie_',

[60] Fix | Delete

],

[61] Fix | Delete

];

[62] Fix | Delete

$this->options = array_replace_recursive($this->options, \SimplePie\Cache::parse_URL($location));

[63] Fix | Delete

[64] Fix | Delete

$this->name = $this->options['extras']['prefix'] . md5("$name:$type");

[65] Fix | Delete

[66] Fix | Delete

$this->cache = new NativeMemcache();

[67] Fix | Delete

$this->cache->addServer($this->options['host'], (int) $this->options['port']);

[68] Fix | Delete

}

[69] Fix | Delete

[70] Fix | Delete

/**

[71] Fix | Delete

* Save data to the cache

[72] Fix | Delete

*

[73] Fix | Delete

* @param array<mixed>|\SimplePie\SimplePie $data Data to store in the cache. If passed a SimplePie object, only cache the $data property

[74] Fix | Delete

* @return bool Successfulness

[75] Fix | Delete

*/

[76] Fix | Delete

public function save($data)

[77] Fix | Delete

{

[78] Fix | Delete

if ($data instanceof \SimplePie\SimplePie) {

[79] Fix | Delete

$data = $data->data;

[80] Fix | Delete

}

[81] Fix | Delete

return $this->cache->set($this->name, serialize($data), MEMCACHE_COMPRESSED, (int) $this->options['extras']['timeout']);

[82] Fix | Delete

}

[83] Fix | Delete

[84] Fix | Delete

/**

[85] Fix | Delete

* Retrieve the data saved to the cache

[86] Fix | Delete

*

[87] Fix | Delete

* @return array<mixed>|false Data for SimplePie::$data

[88] Fix | Delete

*/

[89] Fix | Delete

public function load()

[90] Fix | Delete

{

[91] Fix | Delete

$data = $this->cache->get($this->name);

[92] Fix | Delete

[93] Fix | Delete

if ($data !== false) {

[94] Fix | Delete

return unserialize($data);

[95] Fix | Delete

}

[96] Fix | Delete

return false;

[97] Fix | Delete

}

[98] Fix | Delete

[99] Fix | Delete

/**

[100] Fix | Delete

* Retrieve the last modified time for the cache

[101] Fix | Delete

*

[102] Fix | Delete

* @return int|false Timestamp

[103] Fix | Delete

*/

[104] Fix | Delete

public function mtime()

[105] Fix | Delete

{

[106] Fix | Delete

$data = $this->cache->get($this->name);

[107] Fix | Delete

[108] Fix | Delete

if ($data !== false) {

[109] Fix | Delete

// essentially ignore the mtime because Memcache expires on its own

[110] Fix | Delete

return time();

[111] Fix | Delete

}

[112] Fix | Delete

[113] Fix | Delete

return false;

[114] Fix | Delete

}

[115] Fix | Delete

[116] Fix | Delete

/**

[117] Fix | Delete

* Set the last modified time to the current time

[118] Fix | Delete

*

[119] Fix | Delete

* @return bool Success status

[120] Fix | Delete

*/

[121] Fix | Delete

public function touch()

[122] Fix | Delete

{

[123] Fix | Delete

$data = $this->cache->get($this->name);

[124] Fix | Delete

[125] Fix | Delete

if ($data !== false) {

[126] Fix | Delete

return $this->cache->set($this->name, $data, MEMCACHE_COMPRESSED, (int) $this->options['extras']['timeout']);

[127] Fix | Delete

}

[128] Fix | Delete

[129] Fix | Delete

return false;

[130] Fix | Delete

}

[131] Fix | Delete

[132] Fix | Delete

/**

[133] Fix | Delete

* Remove the cache

[134] Fix | Delete

*

[135] Fix | Delete

* @return bool Success status

[136] Fix | Delete

*/

[137] Fix | Delete

public function unlink()

[138] Fix | Delete

{

[139] Fix | Delete

return $this->cache->delete($this->name, 0);

[140] Fix | Delete

}

[141] Fix | Delete

}

[142] Fix | Delete

[143] Fix | Delete

class_alias('SimplePie\Cache\Memcache', 'SimplePie_Cache_Memcache');

[144] Fix | Delete

[145] Fix | Delete