blob: 20d42cfe7066103e9863abab8e2e145c49a5b56f (
plain)
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
|
<?php
/**
* SPDX-FileCopyrightText: 2022-2024 Nextcloud GmbH and Nextcloud contributors
* SPDX-FileCopyrightText: 2016 ownCloud, Inc.
* SPDX-License-Identifier: AGPL-3.0-only
*/
namespace OCP\Cache;
use OCP\ICache;
/**
* In-memory cache with a capacity limit to keep memory usage in check
*
* Uses a simple FIFO expiry mechanism
*
* @since 25.0.0
* @template T
* @template-implements \ArrayAccess<string,T>
*/
class CappedMemoryCache implements ICache, \ArrayAccess {
private int $capacity;
/** @var T[] */
private array $cache = [];
/**
* @inheritdoc
* @since 25.0.0
*/
public function __construct(int $capacity = 512) {
$this->capacity = $capacity;
}
/**
* @inheritdoc
* @since 25.0.0
*/
public function hasKey($key): bool {
return isset($this->cache[$key]);
}
/**
* @return ?T
* @since 25.0.0
*/
public function get($key) {
return $this->cache[$key] ?? null;
}
/**
* @inheritdoc
* @param string $key
* @param T $value
* @param int $ttl
* @since 25.0.0
* @return bool
*/
public function set($key, $value, $ttl = 0): bool {
if (is_null($key)) {
$this->cache[] = $value;
} else {
$this->cache[$key] = $value;
}
$this->garbageCollect();
return true;
}
/**
* @since 25.0.0
*/
public function remove($key): bool {
unset($this->cache[$key]);
return true;
}
/**
* @inheritdoc
* @since 25.0.0
*/
public function clear($prefix = ''): bool {
$this->cache = [];
return true;
}
/**
* @since 25.0.0
*/
public function offsetExists($offset): bool {
return $this->hasKey($offset);
}
/**
* @inheritdoc
* @return T
* @since 25.0.0
*/
#[\ReturnTypeWillChange]
public function &offsetGet($offset) {
return $this->cache[$offset];
}
/**
* @inheritdoc
* @param string $offset
* @param T $value
* @since 25.0.0
*/
public function offsetSet($offset, $value): void {
$this->set($offset, $value);
}
/**
* @inheritdoc
* @since 25.0.0
*/
public function offsetUnset($offset): void {
$this->remove($offset);
}
/**
* @return T[]
* @since 25.0.0
*/
public function getData(): array {
return $this->cache;
}
/**
* @since 25.0.0
*/
private function garbageCollect(): void {
while (count($this->cache) > $this->capacity) {
reset($this->cache);
$key = key($this->cache);
$this->remove($key);
}
}
/**
* @inheritdoc
* @since 25.0.0
*/
public static function isAvailable(): bool {
return true;
}
}
|
