File Source for OCSP_CACHE

<?php
/**
* openCSP class file OCSP_CACHE_FILE.phpclass
*
* @project Open CSP-Management
* @package default
*
* @author Peter Krebs <pitlinz@users.sourceforge.net>
* @license http://opensource.org/licenses/gpl-license.php GNU Public License
*
* @since pk-11.06.2008
* @version $Id: OCSP_CACHE_FILE.phpclass,v 1.6 2008/12/12 17:35:14 pitlinz Exp $
*/
// ---------------------------------------------------------
// requirements
// ---------------------------------------------------------
pcf_require_class('OCSP_CACHE',dirname(__FILE__) . "/OCSP_CACHE.phpclass");
if (!function_exists('pcf_checkDir')) {
require __OCSP_PHPINCPATH__ . "common" . _OCSP_DIRSEP_ . "pcf_directory.phpinc";
}
if (!function_exists('pcf_checkFileName')) {
require __OCSP_PHPINCPATH__ . "common" . _OCSP_DIRSEP_ . "pcf_file.phpinc";
}
/**
* openCSP class OCSP_CACHE_FILE
*
* @project Open CSP-Management
* @package default
*
* @author Peter Krebs <pitlinz@users.sourceforge.net>
* @license http://opensource.org/licenses/gpl-license.php GNU Public License
*
* @since pk-11.06.2008
* @version $Id: OCSP_CACHE_FILE.phpclass,v 1.6 2008/12/12 17:35:14 pitlinz Exp $
*/
class OCSP_CACHE_FILE extends OCSP_CACHE
{
/*** class constants --------------------------------------------- */
/**
* @constant string CLASS_SRC_FILE
*
*/
const CLASS_SRC_FILE = __FILE__;
/*** class variables --------------------------------------------- */
/**
* cache subdir
* @var string $cacheSubDirName
*/
protected static $cacheSubDirName = 'ocsp_cache';
/*** class functions --------------------------------------------- */
/**
* returns if the cache type is usable on the system
*
* @param boolean $debug
*
* @return boolean
*
* @version pk-08-06-20
*/
public static function isUseable($debug=False)
{
if ($debug) echoDebugMethod(__FILE__,"static","OCSP_CACHE_FILE::isUseable()");
$str_dir = OCSP_OBJ::getConf('CACHEPATH') . self::$cacheSubDirName;
if (intval(pcf_checkDir($str_dir,True,0770)))
{
if ($debug) echoDebugLine(__FILE__,__LINE__,"cache path: " . $str_dir . " is writeable");
return (is_writable($str_dir));
} else {
if ($debug) echoDebugLine(__FILE__,__LINE__,"cache path: " . $str_dir . " is NOT writeable");
return False;
}
}
/*** compostion --------------------------------------------------- */
/*** attributes -------------------------------------------------- */
/**
* @var bool $fileLoaded
*/
private $fileLoaded = False;
/*** factory / construct ----------------------------------------- */
/**
* returns the instance of the singleton class
*
* @param string $group
*
* @return OCSP_CACHE
*/
public static function getInstance($group='DEFAULT')
{
// disable empty groups
$group = (empty($group) ? 'DEFAULT' : $group);
if (!isset(self::$cacheInstances['FILE'][$group]) || !pcf_is_instance_of(self::$cacheInstances['FILE'][$group],'OCSP_CACHE_FILE'))
{
self::$cacheInstances['FILE'][$group] = new OCSP_CACHE_FILE($group);
}
return self::$cacheInstances['FILE'][$group];
}
/*** getter / setter ---------------------------------------------- */
/**
* retuns the cache file path on the server
*
* @param boolean $debug
*
* @return string
*/
protected function getCacheFilePath($debug=False)
{
if ($debug) echoDebugMethod(__FILE__,get_class($this),"OCSP_CACHE_FILE::getCacheFilePath()","Group: " . $this->myGroup);
$str_dir = OCSP_OBJ::getConf('CACHEPATH') . self::$cacheSubDirName . _OCSP_DIRSEP_;
$str_fileName = pcf_checkFileName($this->myGroup) . ".cache";
if ($debug) echoDebugLine(__FILE__,__LINE__,"returning: ". pcf_checkFilePath($str_dir.$str_fileName));
return pcf_checkFilePath($str_dir.$str_fileName);
}
/**
* removes a value from the cache
*
* @param string $aName
* @param boolean $debug
*/
public function unsetValue($aName)
{
if (!$this->fileLoaded)
{
$this->loadMyValues();
}
unset($this->myValues[$aName]);
}
/*** persistent storage ------------------------------------------- */
/**
* loads the cache values from the file
*
* @param boolean $debug
*/
protected function loadMyValues($debug=False)
{
if ($debug) echoDebugMethod(__FILE__,get_class($this),"OCSP_CACHE_FILE::loadMyValues();");
$str_filePath = $this->getCacheFilePath();
if (pcf_is_file($str_filePath))
{
if ($debug) echoDebugLine(__FILE__,__LINE__,"loading file " . $str_filePath . "<br />\$this->myValues: <pre>" . print_r($this->myValues,True) . "</pre>");
$str_allValues = file_get_contents($str_filePath);
$this->myValues = array_merge(unserialize($str_allValues),$this->myValues);
}
if ($debug) echoDebugLine(__FILE__,__LINE__,"\$this->myValues: <pre>" . print_r($this->myValues,True) . "</pre>");
$this->fileLoaded=True;
}
/**
* returns a stored value
*
* @param string $aName
* @param boolean $debug
*
* @return array
*/
public function getStoredValueArr($aName,$debug=False)
{
if ($debug) echoDebugMethod(__FILE__,get_class($this),"OCSP_CACHE_FILE::getStoredValueArr($aName)");
if (!$this->fileLoaded)
{
$this->loadMyValues($debug);
}
if (isset($this->myValues[$aName]))
{
return $this->myValues[$aName];
} else {
return Null;
}
}
/**
* stores all temp cached values
*
* @param boolean $debug
*/
public function storeMyValues($debug=False)
{
if ($debug) echoDebugMethod(__FILE__,get_class($this),"OCSP_CACHE_FILE::storeMyValues();");
if (sizeof($this->myValues))
{
$arr_newValues = array();
$bol_changed = False;
foreach($this->myValues as $str_name => $arr_val)
{
if (intval($arr_val['TTL']))
{
if (!$arr_val['TOU'])
{
// recalculate apc's ttl
$ttl = $arr_val['EXP'] - $arr_val['TTL'];
if ($ttl < 1) // the
{
unset($this->myValues[$str_name]);
$bol_changed = True;
}
} else {
$arr_val['EXP'] = time() + intval($arr_val['TTL']);
$bol_changed = True;
}
}
$bol_changed = ((isset($arr_val['CHA']) && $arr_val['CHA']) ? True : False);
unset($this->myValues[$str_name]['CHA']);
if (!$this->fileLoaded)
{
$arr_newValues[$str_name] = $this->myValues[$str_name];
}
}
if ($bol_changed)
{
if (!$this->fileLoaded)
{
$this->loadMyValues();
$this->myValues = array_merge($this->myValues,$arr_newValues);
}
if ($debug) echoDebugLine(__FILE__,__LINE__,"<p>Setting to file " . $this->getCacheFilePath() . "<pre>" . print_r($this->myValues,True) . "</pre>");
file_put_contents($this->getCacheFilePath(),serialize($this->myValues));
}
$this->myValues=array();
$this->fileLoaded=False;
} else if($this->fileLoaded) {
@unlink($this->getCacheFilePath());
}
}
}
?>

Source for file OCSP_CACHE_FILE.phpclass