Remove smarty_prefix config setting
[gitphp.git] / include / cache / Cache.class.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
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
312
<?php
/**
 * GitPHP Cache
 *
 * Class to store arbitrary data objects in smarty cache
 *
 * @author Christopher Han <xiphux@gmail.com>
 * @copyright Copyright (c) 2010 Christopher Han
 * @package GitPHP
 * @subpackage Cache
 */
 
/**
 * Cache class
 *
 * @package GitPHP
 * @subpackage Cache
 */
class GitPHP_Cache
{
        /**
         * Template
         *
         * Cache template
         */
        const Template = 'data.tpl';
 
        /**
         * objectCacheInstance
         *
         * Stores the singleton instance of the object cache
         *
         * @access protected
         * @static
         */
        protected static $objectCacheInstance;
 
        /**
         * GetObjectCacheInstance
         *
         * Return the singleton instance of the object cache
         *
         * @access public
         * @static
         * @return mixed instance of cache class
         */
        public static function GetObjectCacheInstance()
        {
                if (!self::$objectCacheInstance) {
                        self::$objectCacheInstance = new GitPHP_Cache();
                        if (GitPHP_Config::GetInstance()->GetValue('objectcache', false)) {
                                self::$objectCacheInstance->SetEnabled(true);
                                self::$objectCacheInstance->SetLifetime(GitPHP_Config::GetInstance()->GetValue('objectcachelifetime', 86400));
                        }
                }
                return self::$objectCacheInstance;
        }
 
        /**
         * tpl
         *
         * Smarty instance
         *
         * @access protected
         */
        protected $tpl = null;
 
        /**
         * enabled
         *
         * Stores whether the cache is enabled
         *
         * @access protected
         */
        protected $enabled = false;
 
        /**
         * __construct
         *
         * Constructor
         *
         * @access public
         * @return mixed cache object
         */
        public function __construct()
        {
        }
 
        /**
         * GetEnabled
         *
         * Gets whether the cache is enabled
         *
         * @access public
         * @return boolean true if enabled
         */
        public function GetEnabled()
        {
                return $this->enabled;
        }
 
        /**
         * SetEnabled
         *
         * Sets whether the cache is enabled
         *
         * @access public
         * @param boolean $enable true to enable, false to disable
         */
        public function SetEnabled($enable)
        {
                if ($enable == $this->enabled)
                        return;
 
                $this->enabled = $enable;
 
                if ($this->enabled)
                        $this->CreateSmarty();
                else
                        $this->DestroySmarty();
        }
 
        /**
         * GetLifetime
         *
         * Gets the cache lifetime
         *
         * @access public
         * @return int cache lifetime in seconds
         */
        public function GetLifetime()
        {
                if (!$this->enabled)
                        return false;
 
                return $this->tpl->cache_lifetime;
        }
 
        /**
         * SetLifetime
         *
         * Sets the cache lifetime
         *
         * @access public
         * @param int $lifetime cache lifetime in seconds
         */
        public function SetLifetime($lifetime)
        {
                if (!$this->enabled)
                        return;
 
                $this->tpl->cache_lifetime = $lifetime;
        }
 
        /**
         * Get
         *
         * Get an item from the cache
         *
         * @access public
         * @param string $key cache key
         * @return the cached object, or false
         */
        public function Get($key = null)
        {
                if (empty($key))
                        return false;
 
                if (!$this->enabled)
                        return false;
 
                if (!$this->tpl->isCached(GitPHP_Cache::Template, $key))
                        return false;
 
                $data = $this->tpl->fetch(GitPHP_Cache::Template, $key);
 
                return unserialize(trim($data));
        }
 
        /**
         * Set
         *
         * Set an item in the cache
         *
         * @access public
         * @param string $key cache key
         * @param mixed $value value
         * @param int $lifetime override the lifetime for this data
         */
        public function Set($key = null, $value = null, $lifetime = null)
        {
                if (empty($key) || empty($value))
                        return;
 
                if (!$this->enabled)
                        return;
 
                $oldLifetime = null;
                if ($lifetime !== null) {
                        $oldLifetime = $this->tpl->cache_lifetime;
                        $this->tpl->cache_lifetime = $lifetime;
                }
 
                $this->Delete($key);
                $this->tpl->clearAllAssign();
                $this->tpl->assign('data', serialize($value));
 
                // Force it into smarty's cache
                $tmp = $this->tpl->fetch(GitPHP_Cache::Template, $key);
                unset($tmp);
 
                if ($lifetime !== null) {
                        $this->tpl->cache_lifetime = $oldLifetime;
                }
        }
 
        /**
         * Exists
         *
         * Tests if a key is cached
         *
         * @access public
         * @param string $key cache key
         * @return boolean true if cached, false otherwise
         */
        public function Exists($key = null)
        {
                if (empty($key))
                        return false;
 
                if (!$this->enabled)
                        return false;
 
                return $this->tpl->isCached(GitPHP_Cache::Template, $key);
        }
 
        /**
         * Delete
         *
         * Delete an item from the cache
         *
         * @access public
         * @param string $key cache key
         */
        public function Delete($key = null)
        {
                if (empty($key))
                        return;
 
                if (!$this->enabled)
                        return;
 
                $this->tpl->clearCache(GitPHP_Cache::Template, $key);
        }
 
        /**
         * Clear
         *
         * Clear the cache
         *
         * @access public
         */
        public function Clear()
        {
                if (!$this->enabled)
                        return;
 
                $this->tpl->clearAllCache();
        }
 
        /**
         * CreateSmarty
         *
         * Instantiates Smarty cache
         *
         * @access private
         */
        private function CreateSmarty()
        {
                if ($this->tpl)
                        return;
 
                require_once(GITPHP_SMARTYDIR . 'Smarty.class.php');
                $this->tpl = new Smarty;
                $this->tpl->addPluginsDir(GITPHP_INCLUDEDIR . 'smartyplugins');
 
                $this->tpl->caching = Smarty::CACHING_LIFETIME_SAVED;
 
                $servers = GitPHP_Config::GetInstance()->GetValue('memcache', null);
                if (isset($servers) && is_array($servers) && (count($servers) > 0)) {
                        $this->tpl->caching_type = 'memcache';
                }
 
        }
 
        /**
         * DestroySmarty
         *
         * Destroys Smarty cache
         *
         * @access private
         */
        private function DestroySmarty()
        {
                if (!$this->tpl)
                        return;
 
                $this->tpl = null;
        }
 
}
 
comments