2 /*********************************************************************************
3 * SugarCRM Community Edition is a customer relationship management program developed by
4 * SugarCRM, Inc. Copyright (C) 2004-2011 SugarCRM Inc.
6 * This program is free software; you can redistribute it and/or modify it under
7 * the terms of the GNU Affero General Public License version 3 as published by the
8 * Free Software Foundation with the addition of the following permission added
9 * to Section 15 as permitted in Section 7(a): FOR ANY PART OF THE COVERED WORK
10 * IN WHICH THE COPYRIGHT IS OWNED BY SUGARCRM, SUGARCRM DISCLAIMS THE WARRANTY
11 * OF NON INFRINGEMENT OF THIRD PARTY RIGHTS.
13 * This program is distributed in the hope that it will be useful, but WITHOUT
14 * ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS
15 * FOR A PARTICULAR PURPOSE. See the GNU Affero General Public License for more
18 * You should have received a copy of the GNU Affero General Public License along with
19 * this program; if not, see http://www.gnu.org/licenses or write to the Free
20 * Software Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA
23 * You can contact SugarCRM, Inc. headquarters at 10050 North Wolfe Road,
24 * SW2-130, Cupertino, CA 95014, USA. or at email address contact@sugarcrm.com.
26 * The interactive user interfaces in modified source and object code versions
27 * of this program must display Appropriate Legal Notices, as required under
28 * Section 5 of the GNU Affero General Public License version 3.
30 * In accordance with Section 7(b) of the GNU Affero General Public License version 3,
31 * these Appropriate Legal Notices must retain the display of the "Powered by
32 * SugarCRM" logo. If the display of the logo is not reasonably feasible for
33 * technical reasons, the Appropriate Legal Notices must display the words
34 * "Powered by SugarCRM".
35 ********************************************************************************/
38 require_once('include/SugarCache/SugarCacheAbstract.php');
40 class SugarCacheFile extends SugarCacheAbstract
43 * @var path and file which will store the cache used for this backend
45 protected $_cacheFileName = 'externalCache.php';
48 * @var bool true if the cache has changed and needs written to disk
50 protected $_cacheChanged = false;
53 * @see SugarCacheAbstract::$_priority
55 protected $_priority = 990;
58 * @see SugarCacheAbstract::useBackend()
60 public function useBackend()
62 if ( !parent::useBackend() )
65 if ( !empty($GLOBALS['sugar_config']['external_cache_enabled_file']) )
72 * @see SugarCacheAbstract::__construct()
74 * For this backend, we'll read from the SugarCacheFile::_cacheFileName file into
75 * the SugarCacheFile::$localCache array.
77 public function __construct()
79 parent::__construct();
81 if ( isset($GLOBALS['sugar_config']['external_cache_filename']) )
82 $this->_cacheFileName = $GLOBALS['sugar_config']['external_cache_filename'];
86 * @see SugarCacheAbstract::__destruct()
88 * For this backend, we'll write the SugarCacheFile::$localCache array serialized out to a file
90 public function __destruct()
94 if ( $this->_cacheChanged )
95 sugar_file_put_contents($GLOBALS['sugar_config']['cache_dir'].'/'.$this->_cacheFileName,
96 serialize($this->_localStore));
100 * @see SugarCacheAbstract::_setExternal()
102 * Does nothing; we write to cache on destroy
104 protected function _setExternal(
109 $this->_cacheChanged = true;
113 * @see SugarCacheAbstract::_getExternal()
115 protected function _getExternal(
119 // load up the external cache file
120 if ( sugar_is_file($GLOBALS['sugar_config']['cache_dir'].'/'.$this->_cacheFileName) )
121 $this->localCache = unserialize(
122 file_get_contents($GLOBALS['sugar_config']['cache_dir'].'/'.$this->_cacheFileName));
124 if ( isset($this->_localStore[$key]) )
125 return $this->_localStore[$key];
129 * @see SugarCacheAbstract::_clearExternal()
131 * Does nothing; we write to cache on destroy
133 protected function _clearExternal(
137 $this->_cacheChanged = true;
141 * @see SugarCacheAbstract::_resetExternal()
143 * Does nothing; we write to cache on destroy
145 protected function _resetExternal()
147 $this->_cacheChanged = true;