include/SugarCache/SugarCacheFile.php

   1 <?php
   2 /*********************************************************************************
   3  * SugarCRM Community Edition is a customer relationship management program developed by
   4  * SugarCRM, Inc. Copyright (C) 2004-2011 SugarCRM Inc.
   5  *
   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.
  12  *
  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
  16  * details.
  17  *
  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
  21  * 02110-1301 USA.
  22  *
  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.
  25  *
  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.
  29  *
  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  ********************************************************************************/
  36
  37
  38 require_once('include/SugarCache/SugarCacheAbstract.php');
  39
  40 class SugarCacheFile extends SugarCacheAbstract
  41 {
  42     /**
  43      * @var path and file which will store the cache used for this backend
  44      */
  45     protected $_cacheFileName = 'externalCache.php';
  46
  47     /**
  48      * @var bool true if the cache has changed and needs written to disk
  49      */
  50     protected $_cacheChanged = false;
  51
  52     /**
  53      * @see SugarCacheAbstract::$_priority
  54      */
  55     protected $_priority = 990;
  56
  57     /**
  58      * @see SugarCacheAbstract::useBackend()
  59      */
  60     public function useBackend()
  61     {
  62         if ( !parent::useBackend() )
  63             return false;
  64
  65         if ( !empty($GLOBALS['sugar_config']['external_cache_enabled_file']) )
  66             return true;
  67
  68         return false;
  69     }
  70
  71     /**
  72      * @see SugarCacheAbstract::__construct()
  73      *
  74      * For this backend, we'll read from the SugarCacheFile::_cacheFileName file into
  75      * the SugarCacheFile::$localCache array.
  76      */
  77     public function __construct()
  78     {
  79         parent::__construct();
  80
  81         if ( isset($GLOBALS['sugar_config']['external_cache_filename']) )
  82             $this->_cacheFileName = $GLOBALS['sugar_config']['external_cache_filename'];
  83     }
  84
  85     /**
  86      * @see SugarCacheAbstract::__destruct()
  87      *
  88      * For this backend, we'll write the SugarCacheFile::$localCache array serialized out to a file
  89      */
  90     public function __destruct()
  91     {
  92         parent::__destruct();
  93
  94         if ( $this->_cacheChanged )
  95             sugar_file_put_contents($GLOBALS['sugar_config']['cache_dir'].'/'.$this->_cacheFileName,
  96                 serialize($this->_localStore));
  97     }
  98
  99     /**
 100      * @see SugarCacheAbstract::_setExternal()
 101      *
 102      * Does nothing; we write to cache on destroy
 103      */
 104     protected function _setExternal(
 105         $key,
 106         $value
 107         )
 108     {
 109         $this->_cacheChanged = true;
 110     }
 111
 112     /**
 113      * @see SugarCacheAbstract::_getExternal()
 114      */
 115     protected function _getExternal(
 116         $key
 117         )
 118     {
 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));
 123
 124         if ( isset($this->_localStore[$key]) )
 125             return $this->_localStore[$key];
 126     }
 127
 128     /**
 129      * @see SugarCacheAbstract::_clearExternal()
 130      *
 131      * Does nothing; we write to cache on destroy
 132      */
 133     protected function _clearExternal(
 134         $key
 135         )
 136     {
 137         $this->_cacheChanged = true;
 138     }
 139
 140     /**
 141      * @see SugarCacheAbstract::_resetExternal()
 142      *
 143      * Does nothing; we write to cache on destroy
 144      */
 145     protected function _resetExternal()
 146     {
 147         $this->_cacheChanged = true;
 148     }
 149 }