File size: 4,286 Bytes
800aa60 | 1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 | <?php
/**
* Matomo - free/libre analytics platform
*
* @link https://matomo.org
* @license https://www.gnu.org/licenses/gpl-3.0.html GPL v3 or later
*/
namespace Piwik\Concurrency;
use Piwik\Common;
use Piwik\Container\StaticContainer;
use Piwik\Option;
use Piwik\Log\LoggerInterface;
/**
* Manages a simple distributed list stored in an Option. No locking occurs, so the list
* is not thread safe, and should only be used for use cases where atomicity is not
* important.
*
* The list of items is serialized and stored in an Option. Items are converted to string
* before being persisted, so it is not expected to unserialize objects.
*/
class DistributedList
{
/**
* The name of the option to store the list in.
*
* @var string
*/
private $optionName;
/**
* @var LoggerInterface
*/
private $logger;
/**
* @param string $optionName
*/
public function __construct($optionName, ?LoggerInterface $logger = null)
{
$this->optionName = $optionName;
$this->logger = $logger ?: StaticContainer::get(LoggerInterface::class);
}
/**
* Queries the option table and returns all items in this list.
*
* @return array
*/
public function getAll()
{
$result = $this->getListOptionValue();
foreach ($result as $key => $item) {
// remove non-array items (unexpected state, though can happen when upgrading from an old Piwik)
if (is_array($item)) {
$this->logger->info("Found array item in DistributedList option value '{name}': {data}", array(
'name' => $this->optionName,
'data' => var_export($result, true),
));
unset($result[$key]);
}
}
return $result;
}
/**
* Sets the contents of the list in the option table.
*
* @param string[] $items
*/
public function setAll($items)
{
foreach ($items as $key => &$item) {
if (is_array($item)) {
throw new \InvalidArgumentException("Array item encountered in DistributedList::setAll() [ key = $key ].");
} else {
$item = (string)$item;
}
}
Option::set($this->optionName, serialize($items));
}
/**
* Adds one or more items to the list in the option table.
*
* @param string|array $item
*/
public function add($item)
{
$allItems = $this->getAll();
if (is_array($item)) {
$allItems = array_merge($allItems, $item);
} else {
$allItems[] = $item;
}
$this->setAll($allItems);
}
/**
* Removes one or more items by value from the list in the option table.
*
* Does not preserve array keys.
*
* @param string|array $items
*/
public function remove($items)
{
if (!is_array($items)) {
$items = array($items);
}
$allItems = $this->getAll();
foreach ($items as $item) {
$existingIndex = array_search($item, $allItems);
if ($existingIndex === false) {
return;
}
unset($allItems[$existingIndex]);
}
$this->setAll(array_values($allItems));
}
/**
* Removes one or more items by index from the list in the option table.
*
* Does not preserve array keys.
*
* @param int[]|int $indices
*/
public function removeByIndex($indices)
{
if (!is_array($indices)) {
$indices = array($indices);
}
$indices = array_unique($indices);
$allItems = $this->getAll();
foreach ($indices as $index) {
unset($allItems[$index]);
}
$this->setAll(array_values($allItems));
}
protected function getListOptionValue()
{
Option::clearCachedOption($this->optionName);
$array = Option::get($this->optionName);
$result = array();
if (
$array
&& ($array = Common::safe_unserialize($array))
&& count($array)
) {
$result = $array;
}
return $result;
}
}
|