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
174
175
176
177
178
|
<?php
/**
* This program is free software; you can redistribute it and/or modify
* it under the terms of the GNU General Public License as published by
* the Free Software Foundation; either version 2 of the License, or
* (at your option) any later version.
*
* This program is distributed in the hope that it will be useful,
* but WITHOUT ANY WARRANTY; without even the implied warranty of
* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
* GNU General Public License for more details.
*
* You should have received a copy of the GNU General Public License along
* with this program; if not, write to the Free Software Foundation, Inc.,
* 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA.
* http://www.gnu.org/copyleft/gpl.html
*
* @file
*/
namespace Wikimedia\ObjectCache;
use InvalidArgumentException;
/**
* Store data in a memory for the current request/process only.
*
* This keeps values in a simple associative array.
* Data will not persist and is not shared with other requests
* on the same server.
*
* @newable
* @ingroup Cache
*/
class HashBagOStuff extends MediumSpecificBagOStuff {
/** @var mixed[] */
protected $bag = [];
/** @var int|double Max entries allowed, INF for unlimited */
protected $maxCacheKeys;
/** @var string CAS token prefix for this instance */
private $token;
/** @var int CAS token counter */
private static $casCounter = 0;
public const KEY_VAL = 0;
public const KEY_EXP = 1;
public const KEY_CAS = 2;
/**
* @stable to call
*
* @param array $params Additional parameters include:
* - maxKeys : only allow this many keys (using oldest-first eviction)
*
* @phpcs:ignore Generic.Files.LineLength
* @phan-param array{logger?:\Psr\Log\LoggerInterface,asyncHandler?:callable,keyspace?:string,reportDupes?:bool,segmentationSize?:int,segmentedValueMaxSize?:int,maxKeys?:int} $params
*/
public function __construct( $params = [] ) {
$params['segmentationSize'] ??= INF;
parent::__construct( $params );
$this->token = microtime( true ) . ':' . mt_rand();
$maxKeys = $params['maxKeys'] ?? INF;
if ( $maxKeys !== INF && ( !is_int( $maxKeys ) || $maxKeys <= 0 ) ) {
throw new InvalidArgumentException( '$maxKeys parameter must be above zero' );
}
$this->maxCacheKeys = $maxKeys;
$this->attrMap[self::ATTR_DURABILITY] = self::QOS_DURABILITY_SCRIPT;
}
protected function doGet( $key, $flags = 0, &$casToken = null ) {
$getToken = ( $casToken === self::PASS_BY_REF );
$casToken = null;
if ( !$this->hasKey( $key ) || $this->expire( $key ) ) {
return false;
}
// Refresh key position for maxCacheKeys eviction
$temp = $this->bag[$key];
unset( $this->bag[$key] );
$this->bag[$key] = $temp;
$value = $this->bag[$key][self::KEY_VAL];
if ( $getToken && $value !== false ) {
$casToken = $this->bag[$key][self::KEY_CAS];
}
return $value;
}
protected function doSet( $key, $value, $exptime = 0, $flags = 0 ) {
// Refresh key position for maxCacheKeys eviction
unset( $this->bag[$key] );
$this->bag[$key] = [
self::KEY_VAL => $value,
self::KEY_EXP => $this->getExpirationAsTimestamp( $exptime ),
self::KEY_CAS => $this->token . ':' . ++self::$casCounter
];
if ( count( $this->bag ) > $this->maxCacheKeys ) {
$evictKey = array_key_first( $this->bag );
unset( $this->bag[$evictKey] );
}
return true;
}
protected function doAdd( $key, $value, $exptime = 0, $flags = 0 ) {
if ( $this->hasKey( $key ) && !$this->expire( $key ) ) {
// key already set
return false;
}
return $this->doSet( $key, $value, $exptime, $flags );
}
protected function doDelete( $key, $flags = 0 ) {
unset( $this->bag[$key] );
return true;
}
protected function doIncrWithInit( $key, $exptime, $step, $init, $flags ) {
$curValue = $this->doGet( $key );
if ( $curValue === false ) {
$newValue = $this->doSet( $key, $init, $exptime ) ? $init : false;
} elseif ( $this->isInteger( $curValue ) ) {
$newValue = max( $curValue + $step, 0 );
$this->bag[$key][self::KEY_VAL] = $newValue;
} else {
$newValue = false;
}
return $newValue;
}
/**
* Clear all values in cache
*/
public function clear() {
$this->bag = [];
}
/**
* @param string $key
*
* @return bool
*/
protected function expire( $key ) {
$et = $this->bag[$key][self::KEY_EXP];
if ( $et == self::TTL_INDEFINITE || $et > $this->getCurrentTime() ) {
return false;
}
$this->doDelete( $key );
return true;
}
/**
* Does this bag have a non-null value for the given key?
*
* @param string $key
*
* @return bool
* @since 1.27
*/
public function hasKey( $key ) {
return isset( $this->bag[$key] );
}
}
/** @deprecated class alias since 1.43 */
class_alias( HashBagOStuff::class, 'HashBagOStuff' );
|
