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
|
<?php declare(strict_types = 0);
/*
** Zabbix
** Copyright (C) 2001-2023 Zabbix SIA
**
** 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.
**/
/**
* A class for manage values cached in "tmp" file.
*/
class CDataCacheHelper {
/**
* Cache buffer.
*
* @var array
*/
protected static $data = null;
/**
* File name to store cache.
*
* @var string
*/
protected const DATA_CACHE_FILE_NAME = 'zbx_config_cache';
/**
* Save value in cache.
*
* @param array $values Array of key-value pairs to store in cache.
*/
public static function setValueArray(array $values): void {
if (self::$data === null) {
self::loadCache();
}
foreach ($values as $key => $value) {
self::$data[$key] = $value;
}
self::saveCache();
}
/**
* Get cached value by particular key.
*
* @param string $key Key of requested value.
* @param type $default (optional) Default value.
*
* @return mixed
*/
public static function getValue(string $key, $default = null) {
if (self::$data === null) {
self::loadCache();
}
return (array_key_exists($key, self::$data)) ? self::$data[$key] : $default;
}
/**
* Clear values of given keys from cache.
*
* @param array $keys List of keys to erase from cache.
*/
public static function clearValues(array $keys): void {
if (self::$data === null) {
self::loadCache();
}
foreach ($keys as $key) {
unset(self::$data[$key]);
}
if (count(self::$data) > 0) {
self::saveCache();
}
else {
self::deleteCacheFile();
}
}
/**
* Load cached values from file to buffer.
*/
protected static function loadCache(): void {
self::$data = (is_file(self::getDataCacheFileName()) && self::checkCacheTTL())
? (array) json_decode(file_get_contents(self::getDataCacheFileName()))
: [];
}
/**
* Save values stored in buffer into file.
*/
protected static function saveCache(): void {
if (ZBX_DATA_CACHE_TTL == 0) {
self::deleteCacheFile();
}
else {
file_put_contents(self::getDataCacheFileName(), json_encode(self::$data));
}
}
/**
* Delete cache file.
*/
protected static function deleteCacheFile(): void {
if (is_file(self::getDataCacheFileName())) {
unlink(self::getDataCacheFileName());
}
}
/**
* Return absolute path to "tmp" file to store cache.
*
* @return string
*/
protected static function getDataCacheFileName(): string {
return sys_get_temp_dir().'/'.self::DATA_CACHE_FILE_NAME;
}
/**
* Check if cached data is not expired.
*
* @return bool
*/
protected static function checkCacheTTL(): bool {
return (ZBX_DATA_CACHE_TTL != 0 && filemtime(self::getDataCacheFileName()) + ZBX_DATA_CACHE_TTL > time());
}
}
|
