<?
# Module: cache
# cache-basic.inc - Basic cache functions
# Derechos Reservados (c) 2001-2003 Sandino Araico Sánchez
# Derechos Reservados (c) 2001-2003 Presidencia de la República
# Copyright (c) 2001-2003 Sandino Araico Sánchez All rights reserved

/*
 * --COMIENZA LICENCIA EN ESPAÑOL MEXICANO-------------------------------------
 * Por éste medio se otroga permiso, libre de cargo, a cualquier persona que
 * obtenga una copia de este software y archivos de documentación asociados
 * (el "Software"), a utilizar el Software sin restricción, incluyendo sin 
 * limitación los derechos de usar, copiar, modificar, unir, publicar, 
 * distribuir y/o vender copias de el Software, y permitir lo mismo a personas 
 * a quienes les sea entregado el software, siempre y cuando los avisos de 
 * Derechos reservados y Copyright que aparecen arriba y éste permiso (en 
 * español y en inglés) aparezcan en todas las copias de el Software y que 
 * tanto los avisos de Derechos reservados y Copyright que aparecen arriba como
 * éste permiso (en español y en inglés) aparezcan en la documentación de
 * soporte.
 *
 * ESTE SOFTWARE SE PROVEE "TAL CUAL", SIN NINGUNA GARANTÍA DE NINGÚN TIPO,
 * EXPRESA O IMPLÍCITA, INCLUYENDO PERO NO LIMITÁNDOSE A LAS GARANTÍAS DE
 * MERCANTIBILIDAD, ADECUACIÓN PARA UN PROPÓSITO EN PARTICULAR Y NO 
 * INFRACCIÓN DE LOS DERECHOS DE TERCERAS PARTES. EN NINGÚN MOMENTO EL O LOS 
 * TITULARES DE LOS DERECHOS DE AUTOR Y COPYRIGHT INCLUIDOS EN ESTE AVISO SERÁN
 * RESPONSABLES POR CUALQUIER RECLAMACIÓN O POR CUALQUIER DAÑO ESPECIAL,
 * INDIRECTO O CONSECUENTE, O CUALQUIER DAÑO QUE RESULTE DE LA PÉRDIDA DE USO,
 * DATOS O GANANCIAS, YA SEA EN UNA ACCIÓN DE CONTRATO, NEGLIGENCIA U OTRA 
 * ACCIÓN TORTUORIA, RESULTANTE DE O EN CONEXIÓN CON EL USO O DESEMPEÑO DE
 * ESTE SOFTWARE.
 *
 * Excepto que se incluya en éste aviso, no se debe usar el nombre de ningún 
 * titular de Derechos de autor o Copyright en publicidad o de otra manera 
 * psra promover la venta, uso u otros tratos en este Software sin previa 
 * autorización por escrito del titular de Derechos de autor o Copyright.
 * --TERMINA LICENCIA----------------------------------------------------------
 *
 * --BEGIN LICENSE IN US ENGLISH-----------------------------------------------
 * Permission is hereby granted, free of charge, to any person obtaining a
 * copy of this software and associated documentation files (the
 * "Software"), to deal in the Software without restriction, including
 * without limitation the rights to use, copy, modify, merge, publish,
 * distribute, and/or sell copies of the Software, and to permit persons
 * to whom the Software is furnished to do so, provided that the above
 * copyright and "Derechos reservados" notices and this permission notice  
 * (in spanish and english) appear in all copies of the Software and that both 
 * the above copyright and "Derechos reservados" notices and this permission 
 * notice (in spanish and english) appear in supporting documentation.
 * 
 * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS
 * OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
 * MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT
 * OF THIRD PARTY RIGHTS. IN NO EVENT SHALL THE COPYRIGHT AND "DERECHOS DE 
 * AUTOR" HOLDER OR HOLDERS INCLUDED IN THIS NOTICE BE LIABLE FOR ANY CLAIM, OR 
 * ANY SPECIAL INDIRECT OR CONSEQUENTIAL DAMAGES, OR ANY DAMAGES WHATSOEVER 
 * RESULTING FROM LOSS OF USE, DATA OR PROFITS, WHETHER IN AN ACTION OF 
 * CONTRACT, NEGLIGENCE OR OTHER TORTIOUS ACTION, ARISING OUT OF OR IN 
 * CONNECTION WITH THE USE OR PERFORMANCE OF THIS SOFTWARE.
 * 
 * Except as contained in this notice, the name of a copyright or "Derechos de
 * autor" holder shall not be used in advertising or otherwise to promote the
 * sale, use or other dealings in this Software without prior written 
 * authorization of the copyright or "Derechos de autor" holder.
 * --END LICENSE---------------------------------------------------------------
 */

# Changelog: 
# 2001-02-18 Sandino Araico Sánchez - Cache de documentos originales
# 2001-03-12 Sandino Araico Sánchez - Optimizaciones en el chequeo de directorios
# 2001-03-13 Sandino Araico Sánchez - Cache de documentos procesados
# 2001-03-16 Sandino Araico Sánchez - Librería autónoma hopp
# 2001-03-19 Sandino Araico Sánchez - Workaround: $__APP_INCLUDE_PATH_, compatibilidad con PHP3
# 2001-09-18 Sandino Araico Sánchez - Cambio de nombre, inclusión en Hopp
# 2003-02-04 Sandino Araico Sánchez - Reescritura y cambio de nombre a cache-basic.inc.
# 2003-02-05 Sandino Araico Sánchez - Wrappers de escritura de objetos.

if(!defined("__HOPP_CACHE_BASIC_"))
{
	define("__HOPP_CACHE_BASIC_",1);
#---------------------------------------------------------------------
include __HOPP_INCLUDE_PATH."s.inc";
include __HOPP_INCLUDE_PATH."fs.inc";
#---------------------------------------------------------------------
if(!defined('__HOPP_BASIC_CACHE_DEPTH'))
	define('__HOPP_BASIC_CACHE_DEPTH',2);
if(!defined('__HOPP_BASIC_CACHE_DIR_NAME'))
	define('__HOPP_BASIC_CACHE_DIR_NAME','/var/cache');
#---------------------------------------------------------------------
function h_cache_get_file($param_string, $ttl, $check_old=1, $ext='cache', $dir='')
{
	$file=h_cache_get_file_from_string($param_string, $dir).$ext;
	return h_cache_get_generic_object($ttl, $file, $check_old, 0);
}

function h_cache_get_object($param_string, $ttl, $check_old=1, $ext='cache', $dir='')
{
	$file=h_cache_get_file_from_string($param_string, $dir).$ext;
	return h_cache_get_generic_object($ttl, $file, $check_old, 1);
}

function h_cache_put_file($param_string, $object, $ext='cache', $dir='')
{
	$file=h_cache_get_file_from_string($param_string, $dir).$ext;
	return h_cache_put_generic_object($file, $object, 1, 0);
}

function h_cache_put_object($param_string, $object, $ext='cache', $dir='')
{
	$file=h_cache_get_file_from_string($param_string, $dir).$ext;
	return h_cache_put_generic_object($file, $object, 1, 1);
}

function h_cache_get_file_from_string($param_string, $dir='')
{
	if(empty($dir))
		$dir=__HOPP_BASIC_CACHE_DIR_NAME;
	$hash_pre=md5($param_string);
	$subdir=substr($hash_pre,0,__HOPP_BASIC_CACHE_DEPTH);
	$hash=substr($hash_pre,__HOPP_BASIC_CACHE_DEPTH,32);
	s_log("MD5\nhash_pre:\t$hash_pre\nsubdir\t\t$subdir\nhash:\t\t$hash",0,0,3);
	
	$filename="$dir/$subdir/$hash";

	return $filename;
}
#---------------------------------------------------------------------
function h_cache_get_generic_object($ttl, $file_name, $check_old, $unserialize=1)
{
	s_log("Looking for $file_name",0,0,3);
	if(file_exists($file_name))
	{
		s_log("Looking for $file_name: exists",0,0,3);
		if($check_old)
			if(h_cache_is_old_file($ttl, $file_name))
				return;
				
		$file_ptr=fopen($file_name,"r");
		if($file_ptr)
		{
			$file=fread($file_ptr,filesize($file_name));
			s_log("===========> file <===========\n $file\n=================================",0,0,4);
			fclose($file_ptr);
			if($unserialize)
				$file=unserialize($file);
			return $file;
		}
	}
}

function h_cache_put_generic_object($file_name, $object, $first=1, $serialize=1)
{
	if($serialize)
		$object=serialize($object);
	$file_ptr=@fopen($file_name,"w");
	if($file_ptr)
	{
		fwrite ($file_ptr, $object);
		fclose($file_ptr);
	}
	else
	{	
		if($first)
		{
			h_fs_check_dir($file_name);
			h_cache_put_generic_object($file_name, $object, 0, $serialize);
		}	
	}

}

function h_cache_is_old_file($ttl, $file_name)
{
	$oldtime=time()-filemtime ($file_name);
	s_log("file_name: $file_name\toldtime: $oldtime",0,0,3);
	if($oldtime>$ttl)
		return 1;
}
#---------------------------------------------------------------------
} //__HOPP_CACHE_BASIC_
?>