|
1
|
|
|
<?php |
|
2
|
|
|
/** |
|
3
|
|
|
* Copyright 2022 SURF B.V. |
|
4
|
|
|
* |
|
5
|
|
|
* Licensed under the Apache License, Version 2.0 (the "License"); |
|
6
|
|
|
* you may not use this file except in compliance with the License. |
|
7
|
|
|
* You may obtain a copy of the License at |
|
8
|
|
|
* |
|
9
|
|
|
* http://www.apache.org/licenses/LICENSE-2.0 |
|
10
|
|
|
* |
|
11
|
|
|
* Unless required by applicable law or agreed to in writing, software |
|
12
|
|
|
* distributed under the License is distributed on an "AS IS" BASIS, |
|
13
|
|
|
* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. |
|
14
|
|
|
* See the License for the specific language governing permissions and |
|
15
|
|
|
* limitations under the License. |
|
16
|
|
|
*/ |
|
17
|
|
|
|
|
18
|
|
|
trait FileTrait |
|
19
|
|
|
{ |
|
20
|
|
|
/** |
|
21
|
|
|
* This function takes care of actually saving the user data to a JSON file. |
|
22
|
|
|
* @param string $userId |
|
23
|
|
|
* @param array $data |
|
24
|
|
|
* @throws ReadWriteException |
|
25
|
|
|
*/ |
|
26
|
4 |
|
protected function _saveUser(string $userId, array $data): void |
|
27
|
|
|
{ |
|
28
|
4 |
|
if (file_put_contents($this->getPath().$userId.".json", json_encode($data)) === false) { |
|
29
|
|
|
throw new ReadWriteException('Unable to save the user to user storage (file storage)'); |
|
30
|
|
|
} |
|
31
|
|
|
} |
|
32
|
|
|
|
|
33
|
|
|
/** |
|
34
|
|
|
* @param string $userId |
|
35
|
|
|
* @return bool true when the user exists, false otherwise |
|
36
|
|
|
* |
|
37
|
|
|
* Does not throw |
|
38
|
|
|
*/ |
|
39
|
4 |
|
protected function _userExists(string $userId): bool { |
|
40
|
4 |
|
$fileName = $this->getPath().$userId.".json"; |
|
41
|
|
|
|
|
42
|
4 |
|
return file_exists($fileName); |
|
43
|
|
|
} |
|
44
|
|
|
|
|
45
|
|
|
/** |
|
46
|
|
|
* This function takes care of loading the user data from a JSON file. |
|
47
|
|
|
* |
|
48
|
|
|
* @param string $userId |
|
49
|
|
|
* |
|
50
|
|
|
* @return array containing the user data on success. |
|
51
|
|
|
* |
|
52
|
|
|
* @throws Exception when the data can not be found |
|
53
|
|
|
*/ |
|
54
|
4 |
|
protected function _loadUser(string $userId): array |
|
55
|
|
|
{ |
|
56
|
4 |
|
$fileName = $this->getPath().$userId.".json"; |
|
57
|
|
|
|
|
58
|
4 |
|
$data = NULL; |
|
59
|
4 |
|
if (file_exists($fileName)) { |
|
60
|
4 |
|
$data = json_decode(file_get_contents($this->getPath().$userId.".json"), true); |
|
61
|
|
|
} |
|
62
|
|
|
|
|
63
|
4 |
|
if ($data === NULL) { |
|
64
|
|
|
$this->logger->error(sprintf('Error loading user data (File) for user "%s"', $userId)); |
|
65
|
|
|
throw new RuntimeException('Error loading user data (File)'); |
|
66
|
|
|
} |
|
67
|
|
|
|
|
68
|
4 |
|
return $data; |
|
69
|
|
|
} |
|
70
|
|
|
|
|
71
|
|
|
/** |
|
72
|
|
|
* Retrieve the path where the json files are stored. |
|
73
|
|
|
* @return String |
|
74
|
|
|
*/ |
|
75
|
4 |
|
public function getPath(): string |
|
76
|
|
|
{ |
|
77
|
4 |
|
if (substr($this->path, -1)!="/") return $this->path."/"; |
|
78
|
|
|
return $this->path; |
|
79
|
|
|
} |
|
80
|
|
|
|
|
81
|
|
|
/** |
|
82
|
|
|
* @see Tiqr_HealthCheck_Interface::healthCheck() |
|
83
|
|
|
*/ |
|
84
|
4 |
|
public function healthCheck(string &$statusMessage = ''): bool |
|
85
|
|
|
{ |
|
86
|
4 |
|
if (!is_dir($this->path)) { |
|
87
|
2 |
|
$statusMessage = "FileStorage: Path does not exist"; |
|
88
|
2 |
|
return false; |
|
89
|
|
|
} |
|
90
|
|
|
// Check if the path is writable |
|
91
|
2 |
|
if (!is_writable($this->path)) { |
|
92
|
|
|
$statusMessage = "FileStorage: Path is not writable"; |
|
93
|
|
|
return false; |
|
94
|
|
|
} |
|
95
|
|
|
|
|
96
|
2 |
|
return true; |
|
97
|
|
|
} |
|
98
|
|
|
} |
|
99
|
|
|
|
Tiqr /
tiqr-server-libphp
