<?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

/**

[9] Fix | Delete

* Caches data to the filesystem

[10] Fix | Delete

*

[11] Fix | Delete

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

[12] Fix | Delete

*/

[13] Fix | Delete

class File implements Base

[14] Fix | Delete

{

[15] Fix | Delete

/**

[16] Fix | Delete

* Location string

[17] Fix | Delete

*

[18] Fix | Delete

* @see SimplePie::$cache_location

[19] Fix | Delete

* @var string

[20] Fix | Delete

*/

[21] Fix | Delete

protected $location;

[22] Fix | Delete

[23] Fix | Delete

/**

[24] Fix | Delete

* Filename

[25] Fix | Delete

*

[26] Fix | Delete

* @var string

[27] Fix | Delete

*/

[28] Fix | Delete

protected $filename;

[29] Fix | Delete

[30] Fix | Delete

/**

[31] Fix | Delete

* File extension

[32] Fix | Delete

*

[33] Fix | Delete

* @var string

[34] Fix | Delete

*/

[35] Fix | Delete

protected $extension;

[36] Fix | Delete

[37] Fix | Delete

/**

[38] Fix | Delete

* File path

[39] Fix | Delete

*

[40] Fix | Delete

* @var string

[41] Fix | Delete

*/

[42] Fix | Delete

protected $name;

[43] Fix | Delete

[44] Fix | Delete

/**

[45] Fix | Delete

* Create a new cache object

[46] Fix | Delete

*

[47] Fix | Delete

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

[48] Fix | Delete

* @param string $name Unique ID for the cache

[49] Fix | Delete

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

[50] Fix | Delete

*/

[51] Fix | Delete

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

[52] Fix | Delete

{

[53] Fix | Delete

$this->location = $location;

[54] Fix | Delete

$this->filename = $name;

[55] Fix | Delete

$this->extension = $type;

[56] Fix | Delete

$this->name = "$this->location/$this->filename.$this->extension";

[57] Fix | Delete

}

[58] Fix | Delete

[59] Fix | Delete

/**

[60] Fix | Delete

* Save data to the cache

[61] Fix | Delete

*

[62] Fix | Delete

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

[63] Fix | Delete

* @return bool Successfulness

[64] Fix | Delete

*/

[65] Fix | Delete

public function save($data)

[66] Fix | Delete

{

[67] Fix | Delete

if (file_exists($this->name) && is_writable($this->name) || file_exists($this->location) && is_writable($this->location)) {

[68] Fix | Delete

if ($data instanceof \SimplePie\SimplePie) {

[69] Fix | Delete

$data = $data->data;

[70] Fix | Delete

}

[71] Fix | Delete

[72] Fix | Delete

$data = serialize($data);

[73] Fix | Delete

return (bool) file_put_contents($this->name, $data);

[74] Fix | Delete

}

[75] Fix | Delete

return false;

[76] Fix | Delete

}

[77] Fix | Delete

[78] Fix | Delete

/**

[79] Fix | Delete

* Retrieve the data saved to the cache

[80] Fix | Delete

*

[81] Fix | Delete

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

[82] Fix | Delete

*/

[83] Fix | Delete

public function load()

[84] Fix | Delete

{

[85] Fix | Delete

if (file_exists($this->name) && is_readable($this->name)) {

[86] Fix | Delete

return unserialize((string) file_get_contents($this->name));

[87] Fix | Delete

}

[88] Fix | Delete

return false;

[89] Fix | Delete

}

[90] Fix | Delete

[91] Fix | Delete

/**

[92] Fix | Delete

* Retrieve the last modified time for the cache

[93] Fix | Delete

*

[94] Fix | Delete

* @return int|false Timestamp

[95] Fix | Delete

*/

[96] Fix | Delete

public function mtime()

[97] Fix | Delete

{

[98] Fix | Delete

return @filemtime($this->name);

[99] Fix | Delete

}

[100] Fix | Delete

[101] Fix | Delete

/**

[102] Fix | Delete

* Set the last modified time to the current time

[103] Fix | Delete

*

[104] Fix | Delete

* @return bool Success status

[105] Fix | Delete

*/

[106] Fix | Delete

public function touch()

[107] Fix | Delete

{

[108] Fix | Delete

return @touch($this->name);

[109] Fix | Delete

}

[110] Fix | Delete

[111] Fix | Delete

/**

[112] Fix | Delete

* Remove the cache

[113] Fix | Delete

*

[114] Fix | Delete

* @return bool Success status

[115] Fix | Delete

*/

[116] Fix | Delete

public function unlink()

[117] Fix | Delete

{

[118] Fix | Delete

if (file_exists($this->name)) {

[119] Fix | Delete

return unlink($this->name);

[120] Fix | Delete

}

[121] Fix | Delete

return false;

[122] Fix | Delete

}

[123] Fix | Delete

}

[124] Fix | Delete

[125] Fix | Delete

class_alias('SimplePie\Cache\File', 'SimplePie_Cache_File');

[126] Fix | Delete

[127] Fix | Delete