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 ********************************************************************************/
40 const EXTERNAL_CACHE_NULL_VALUE = "SUGAR_CACHE_NULL_ZZ";
42 protected static $_cacheInstance;
45 * @var true if the cache has been reset during this request, so we no longer return values from
46 * cache until the next reset
48 public static $isCacheReset = false;
50 private function __construct() {}
53 * initializes the cache in question
55 protected static function _init()
58 $locations = array('include/SugarCache','custom/include/SugarCache');
59 foreach ( $locations as $location ) {
60 if (sugar_is_dir($location) && $dir = opendir($location)) {
61 while (($file = readdir($dir)) !== false) {
64 || !is_file("$location/$file")
67 require_once("$location/$file");
68 $cacheClass = basename($file, ".php");
69 if ( class_exists($cacheClass) && is_subclass_of($cacheClass,'SugarCacheAbstract') ) {
70 $GLOBALS['log']->debug("Found cache backend $cacheClass");
71 $cacheInstance = new $cacheClass();
72 if ( $cacheInstance->useBackend()
73 && $cacheInstance->getPriority() < $lastPriority ) {
74 $GLOBALS['log']->debug("Using cache backend $cacheClass, since ".$cacheInstance->getPriority()." is less than ".$lastPriority);
75 self::$_cacheInstance = $cacheInstance;
76 $lastPriority = $cacheInstance->getPriority();
85 * Returns the instance of the SugarCacheAbstract object, cooresponding to the external
88 public static function instance()
90 if ( !is_subclass_of(self::$_cacheInstance,'SugarCacheAbstract') )
93 return self::$_cacheInstance;
98 * Procedural API for external cache
102 * Retrieve a key from cache. For the Zend Platform, a maximum age of 5 minutes is assumed.
104 * @param String $key -- The item to retrieve.
105 * @return The item unserialized
107 function sugar_cache_retrieve($key)
109 return SugarCache::instance()->$key;
113 * Put a value in the cache under a key
115 * @param String $key -- Global namespace cache. Key for the data.
116 * @param Serializable $value -- The value to store in the cache.
118 function sugar_cache_put($key, $value)
120 SugarCache::instance()->$key = $value;
124 * Clear a key from the cache. This is used to invalidate a single key.
126 * @param String $key -- Key from global namespace
128 function sugar_cache_clear($key)
130 unset(SugarCache::instance()->$key);
134 * Turn off external caching for the rest of this round trip and for all round
135 * trips for the next cache timeout. This function should be called when global arrays
136 * are affected (studio, module loader, upgrade wizard, ... ) and it is not ok to
137 * wait for the cache to expire in order to see the change.
139 function sugar_cache_reset()
141 SugarCache::instance()->reset();
145 * Internal -- Determine if there is an external cache available for use.
149 function check_cache()
151 SugarCache::instance();
155 * This function is called once an external cache has been identified to ensure that it is correctly
160 * @return true for success, false for failure.
162 function sugar_cache_validate()
164 $instance = SugarCache::instance();
166 return is_object($instance);
170 * Internal -- This function actually retrieves information from the caches.
171 * It is a helper function that provides that actual cache API abstraction.
173 * @param unknown_type $key
176 * @see sugar_cache_retrieve
178 function external_cache_retrieve_helper($key)
180 return SugarCache::instance()->$key;