-
Notifications
You must be signed in to change notification settings - Fork 0
/
Cachix.php
258 lines (226 loc) · 6.16 KB
/
Cachix.php
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
<?php
/**
* Cachix.php
*
* @require Linux commands `rm`, `find` and `grep` to be executable via shell_exec
* @example
*
* // init Config
* \Cachix::init(array(
* 'bCaching' => true,
* 'sCacheDir' => '/tmp/',
* 'iDeleteAfterMinutes' => 10,
* 'sBinRemove' => '/bin/rm',
* 'sBinFind' => '/usr/bin/find',
* 'sBinGrep' => '/bin/grep'
* ));
*
* // Data to be cached
* $aData = ['foo' => 'bar'];
*
* // build a Cache-Key
* $sKey = 'myCacheKey.whatever';
*
* // autodelete cachefiles
* // which contain the string ".whatever" in key-name
* \Cachix::autoDeleteCache('.whatever');
*
* // first time saving data to cache...
* if (empty(\Cachix::getCache($sKey)))
* {
* \Cachix::saveCache(
* $sKey,
* $aData
* );
* }
* // ...or read from existing Cache
* else
* {
* $aData = \Cachix::getCache($sKey);
* }
*
* @package Cachix
* @copyright ueffing.net
* @author Guido K.B.W. Üffing <[email protected]>
* @license GNU GENERAL PUBLIC LICENSE Version 3. See application/doc/COPYING
*/
/**
* Cachix
*/
class Cachix
{
/**
* caching true/false; default=true
* @access public
* @static
* @var boolean
*/
public static $bCaching;
/**
* delete cache files when this vaue is reached
* @access public
* @static
* @var integer
*/
public static $iDeleteAfterMinutes;
/**
* absolute path to cache dir
* @access public
* @static
* @var string
*/
public static $sCacheDir;
/**
* linux binary `rm'
* @access public
* @static
* @var string
*/
public static $sBinRemove;
/**
* linux binary `find'
* @access public
* @static
* @var string
*/
public static $sBinFind;
/**
* linux binary `grep'
* @access public
* @static
* @var string
*/
public static $sBinGrep;
/**
* sets configuration; if none is given by param, defaults are set
*
* @access public
* @static
* @param array $aConfig array(
* 'bCaching' => true,
* 'sCacheDir' => '/tmp/',
* 'iDeleteAfterMinutes' => 1440,
* 'sBinRemove' => '/bin/rm',
* 'sBinFind' => '/usr/bin/find',
* 'sBinGrep' => '/bin/grep',
* )
* @return void
*/
public static function init(array $aConfig = array())
{
(is_null(self::$bCaching)) ? (self::$bCaching = (isset($aConfig['bCaching'])) ? $aConfig['bCaching'] : true) : false;
(is_null(self::$sCacheDir)) ? (self::$sCacheDir = (isset($aConfig['sCacheDir'])) ? $aConfig['sCacheDir'] : sys_get_temp_dir()) : false;
(is_null(self::$iDeleteAfterMinutes)) ? (self::$iDeleteAfterMinutes = (isset($aConfig['iDeleteAfterMinutes'])) ? $aConfig['iDeleteAfterMinutes'] : 1440) : false; // 1440min === 1 day
(is_null(self::$sBinRemove)) ? (self::$sBinRemove = (isset($aConfig['sBinRemove'])) ? $aConfig['sBinRemove'] : '/bin/rm') : false;
(is_null(self::$sBinFind)) ? (self::$sBinFind = (isset($aConfig['sBinFind'])) ? $aConfig['sBinFind'] : '/usr/bin/find') : false;
(is_null(self::$sBinGrep)) ? (self::$sBinGrep = (isset($aConfig['sBinGrep'])) ? $aConfig['sBinGrep'] : '/bin/grep') : false;
}
/**
* gets data from cache by key
* @access public
* @static
* @param type $sKey
* @return string $sContent content of requested | empty on fail
*/
public static function getCache(string $sKey = '')
{
self::init();
if (false === self::$bCaching || '' === $sKey)
{
return '';
}
$sFilename = self::$sCacheDir . '/' . $sKey;
$sContent = '';
if (file_exists($sFilename))
{
$sContent = unserialize(
base64_decode(
file_get_contents($sFilename)
)
);
}
return $sContent;
}
/**
* saves data into cache on key
* @access public
* @static
* @param string $sKey
* @param boolean success
* @return boolean success
*/
public static function saveCache(string $sKey, $mData) : bool
{
self::init();
if (false === self::$bCaching)
{
return false;
}
$sFilename = self::$sCacheDir . '/' . $sKey;
$mData = base64_encode(
serialize($mData)
);
if (!is_dir ($sFilename))
{
(is_file($sFilename) && file_exists($sFilename)) ? unlink($sFilename) : false;
if (false === file_put_contents($sFilename, $mData, LOCK_EX))
{
return false;
}
}
return true;
}
/**
* deletes cachefiles after certain time
* @require Linux commands `rm`, `find` and `grep` executable via shell_exec
* @access public
* @static
* @param string $sToken optional; default='' (all cachefiles)
* @param string $sMinutes optional; default=self::$iDeleteAfterMinutes
* @return boolean success
*/
public static function autoDeleteCache(string $sToken = '', string $sMinutes = null) : bool
{
self::init();
if (false === self::$bCaching)
{
return false;
}
if (null === $sMinutes)
{
$sMinutes = self::$iDeleteAfterMinutes;
}
$sCmd = self::$sBinFind . ' ' . self::$sCacheDir . ' -type f -mmin +' . $sMinutes;
('' !== $sToken) ? $sCmd.= ' | ' . self::$sBinGrep . ' ' . escapeshellarg(addslashes($sToken)) : false;
$mFind = trim((string) shell_exec($sCmd));
if (!is_null($mFind) && !empty($mFind))
{
$aLine = explode("\n", $mFind);
foreach ($aLine as $sLine)
{
$sCmd = self::$sBinRemove . ' "' . $sLine . '"';
$mRemove = shell_exec((string) $sCmd);
}
return (boolean) $mRemove;
}
return (boolean) $mFind;
}
/**
* flushes cache (deletes all cachefiles immediatly)
* @require Linux command `rm` executable via shell_exec
* @access public
* @static
* @return boolean success
*/
public static function flushCache() : bool
{
self::init();
if (false === self::$bCaching)
{
return false;
}
$sCmd = self::$sBinRemove . ' -rf ' . self::$sCacheDir . '/*';
$mResult = shell_exec($sCmd);
return (boolean) $mResult;
}
}