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
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
|
<?php
declare(strict_types=1);
namespace SimpleSAML\Module\core\Storage;
use PDO;
use SimpleSAML\Configuration;
/**
* SQLPermanentStorage
*
* Generic SQL Store to store key value pairs. To be used in several other modules that needs
* to store data permanently.
*
* @author Andreas Åkre Solberg <andreas@uninett.no>, UNINETT AS.
* @package SimpleSAMLphp
*/
class SQLPermanentStorage
{
/** @var \PDO */
private $db;
/**
* @param string $name
* @param \SimpleSAML\Configuration|null $config
* @throws \Exception
*/
public function __construct($name, $config = null)
{
if (is_null($config)) {
$config = Configuration::getInstance();
}
$datadir = $config->getPathValue('datadir', 'data/') ?: 'data/';
if (!is_dir($datadir)) {
throw new \Exception('Data directory [' . $datadir . '] does not exist');
} elseif (!is_writable($datadir)) {
throw new \Exception('Data directory [' . $datadir . '] is not writable');
}
$sqllitedir = $datadir . 'sqllite/';
if (!is_dir($sqllitedir)) {
mkdir($sqllitedir);
}
$dbfile = 'sqlite:' . $sqllitedir . $name . '.sqlite';
if ($this->db = new PDO($dbfile)) {
$this->db->setAttribute(PDO::ATTR_ERRMODE, PDO::ERRMODE_SILENT);
$q = @$this->db->query('SELECT key1 FROM data LIMIT 1');
if ($q === false) {
$this->db->exec('
CREATE TABLE data (
key1 text,
key2 text,
type text,
value text,
created timestamp,
updated timestamp,
expire timestamp,
PRIMARY KEY (key1,key2,type)
);
');
}
} else {
throw new \Exception('Error creating SQL lite database [' . $dbfile . '].');
}
}
/**
* @param string $type
* @param string $key1
* @param string $key2
* @param string $value
* @param int|null $duration
* @return void
*/
public function set($type, $key1, $key2, $value, $duration = null)
{
if ($this->exists($type, $key1, $key2)) {
$this->update($type, $key1, $key2, $value, $duration);
} else {
$this->insert($type, $key1, $key2, $value, $duration);
}
}
/**
* @param string $type
* @param string $key1
* @param string $key2
* @param string $value
* @param int|null $duration
* @return array
*/
private function insert(string $type, string $key1, string $key2, string $value, int $duration = null): array
{
$expire = is_null($duration) ? null : (time() + $duration);
$query = "INSERT INTO data (key1, key2, type, created, updated, expire, value)" .
" VALUES(:key1, :key2, :type, :created, :updated, :expire, :value)";
$prepared = $this->db->prepare($query);
$data = [':key1' => $key1, ':key2' => $key2,
':type' => $type, ':created' => time(),
':updated' => time(), ':expire' => $expire,
':value' => serialize($value)
];
$prepared->execute($data);
$results = $prepared->fetchAll(PDO::FETCH_ASSOC);
return $results;
}
/**
* @param string $type
* @param string $key1
* @param string $key2
* @param string $value
* @param int|null $duration
* @return array
*/
private function update(string $type, string $key1, string $key2, string $value, int $duration = null): array
{
$expire = is_null($duration) ? null : (time() + $duration);
$query = "UPDATE data SET updated = :updated, value = :value, " .
"expire = :expire WHERE key1 = :key1 AND key2 = :key2 AND type = :type";
$prepared = $this->db->prepare($query);
$data = [':key1' => $key1, ':key2' => $key2,
':type' => $type, ':updated' => time(),
':expire' => $expire, ':value' => serialize($value)
];
$prepared->execute($data);
$results = $prepared->fetchAll(PDO::FETCH_ASSOC);
return $results;
}
/**
* @param string $type
* @param string $key1
* @param string $key2
* @return array|null
*/
public function get($type = null, $key1 = null, $key2 = null)
{
$conditions = $this->getCondition($type, $key1, $key2);
$query = 'SELECT * FROM data WHERE ' . $conditions;
$prepared = $this->db->prepare($query);
$prepared->execute();
$results = $prepared->fetchAll(PDO::FETCH_ASSOC);
if (count($results) !== 1) {
return null;
}
$res = $results[0];
$res['value'] = unserialize($res['value']);
return $res;
}
/**
* Return the value directly (not in a container)
*
* @param string $type
* @param string $key1
* @param string $key2
* @return array|null
*/
public function getValue($type = null, $key1 = null, $key2 = null)
{
$res = $this->get($type, $key1, $key2);
if ($res === null) {
return null;
}
return $res['value'];
}
/**
* @param string $type
* @param string $key1
* @param string $key2
* @return bool
*/
public function exists($type, $key1, $key2)
{
$query = 'SELECT * FROM data WHERE type = :type AND key1 = :key1 AND key2 = :key2 LIMIT 1';
$prepared = $this->db->prepare($query);
$data = [':type' => $type, ':key1' => $key1, ':key2' => $key2];
$prepared->execute($data);
$results = $prepared->fetchAll(PDO::FETCH_ASSOC);
return (count($results) == 1);
}
/**
* @param string $type
* @param string $key1
* @param string $key2
* @return array|false
*/
public function getList($type = null, $key1 = null, $key2 = null)
{
$conditions = $this->getCondition($type, $key1, $key2);
$query = 'SELECT * FROM data WHERE ' . $conditions;
$prepared = $this->db->prepare($query);
$prepared->execute();
$results = $prepared->fetchAll(PDO::FETCH_ASSOC);
if ($results === false) {
return false;
}
foreach ($results as $key => $value) {
$results[$key]['value'] = unserialize($results[$key]['value']);
}
return $results;
}
/**
* @param string $type
* @param string $key1
* @param string $key2
* @param string $whichKey
* @throws \Exception
* @return array|null
*/
public function getKeys($type = null, $key1 = null, $key2 = null, $whichKey = 'type')
{
if (!in_array($whichKey, ['key1', 'key2', 'type'], true)) {
throw new \Exception('Invalid key type');
}
$conditions = $this->getCondition($type, $key1, $key2);
$query = 'SELECT DISTINCT :whichKey FROM data WHERE ' . $conditions;
$prepared = $this->db->prepare($query);
$data = ['whichKey' => $whichKey];
$prepared->execute($data);
$results = $prepared->fetchAll(PDO::FETCH_ASSOC);
if (count($results) == 0) {
return null;
}
$resarray = [];
foreach ($results as $key => $value) {
$resarray[] = $value[$whichKey];
}
return $resarray;
}
/**
* @param string $type
* @param string $key1
* @param string $key2
* @return bool
*/
public function remove($type, $key1, $key2)
{
$query = 'DELETE FROM data WHERE type = :type AND key1 = :key1 AND key2 = :key2';
$prepared = $this->db->prepare($query);
$data = [':type' => $type, ':key1' => $key1, ':key2' => $key2];
$prepared->execute($data);
$results = $prepared->fetchAll(PDO::FETCH_ASSOC);
return (count($results) == 1);
}
/**
* @return int
*/
public function removeExpired()
{
$query = "DELETE FROM data WHERE expire IS NOT NULL AND expire < :expire";
$prepared = $this->db->prepare($query);
$data = [':expire' => time()];
$prepared->execute($data);
return $prepared->rowCount();
}
/**
* Create a SQL condition statement based on parameters
*
* @param string $type
* @param string $key1
* @param string $key2
* @return string
*/
private function getCondition(string $type = null, string $key1 = null, string $key2 = null): string
{
$conditions = [];
if (!is_null($type)) {
$conditions[] = "type = " . $this->db->quote($type);
}
if (!is_null($key1)) {
$conditions[] = "key1 = " . $this->db->quote($key1);
}
if (!is_null($key2)) {
$conditions[] = "key2 = " . $this->db->quote($key2);
}
$conditions[] = "(expire IS NULL OR expire >= " . time() . ")";
return join(' AND ', $conditions);
}
}
|
