<?
# Module: Calendar
# cal-dir.inc - Calendar directory navigation functions
# Derechos Reservados (c) 2002 Sandino Araico Sánchez
# Derechos Reservados (c) 2002 Presidencia de la República
# Copyright (c) 2002 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
# 2002-05-02 Sandino Araico Sánchez - navegador de calendario
# 2002-05-06 Sandino Araico Sánchez - dir-contents, year, minth, day, filtered

# TODO
# 2002-05-10 Sandino Araico Sánchez - multi-pass in-memory optimization
# 2002-05-25 Sandino Araico Sánchez - Level 3 debug

if(!defined("__CALENDAR_DIR"))
{
define ("__CALENDAR_DIR",1);
#---------------------------------------------------------------------
if(!defined('__CALENDAR_YEAR_FORMAT'))
	define('__CALENDAR_YEAR_FORMAT','D');
if(!defined('__CALENDAR_MONTH_FORMAT'))
	define('__CALENDAR_MONTH_FORMAT','D');
if(!defined('__CALENDAR_DAY_FORMAT'))
	define('__CALENDAR_DAY_FORMAT','F');
if(!defined('__CALENDAR_VALIDATE_NAME_STRICT'))	
	define('__CALENDAR_VALIDATE_NAME_STRICT',0);
if(!defined('__CALENDAR_CONSTANTS'))
{
	define('__CALENDAR_CONSTANTS',1);
	
	define('__CALENDAR_TYPE_YEAR',101);
	define('__CALENDAR_TYPE_MONTH',102);
	define('__CALENDAR_TYPE_DAY',103);

	define('__CALENDAR_FORMAT_DIR',111);
	define('__CALENDAR_FORMAT_FILE',112);

	define('__CALENDAR_FLAGS_RETURN_NAME',1);
	define('__CALENDAR_FLAGS_RETURN_FILE',2);
	define('__CALENDAR_FLAGS_RETURN_BOTH',3);
	define('__CALENDAR_FLAGS_RETURN_DEFAULT',__CALENDAR_FLAGS_RETURN_NAME);
} // __CALENDAR_CONSTANTS
#---------------------------------------------------------------------
include __HOPP_INCLUDE_PATH."s.inc";
#---------------------------------------------------------------------
# High level functions (must be documented)

function cal_get_years_from_dir($dirname, $start=0, $length=0, $flags=0)
{
	s_log("Dir: $dirname\tstart: $start length: $length",0,0,3);
	return cal_get_files_from_dir($dirname,__CALENDAR_TYPE_YEAR, $start, $length,0, $flags);
}

function cal_get_months_from_dir($dirname, $start=0, $length=0, $year='', $y_start=0, $flags=0)
{
	s_log("Dir: $dirname\tstart: $start length: $length",0,0,3);
	if($year)
		$filter[]=array('N'=>$year,'S'=>$y_start,'L'=>strlen($year));
	return cal_get_files_from_dir($dirname,__CALENDAR_TYPE_MONTH, $start, $length, $filter, $flags);
}

function cal_get_days_from_dir($dirname, $start=0, $length=0, $month='', $m_start=0, $year='', $y_start=0, $flags=0, $day='',$d_start=0)
{
	s_log("Dir: $dirname\tstart: $start length: $length",0,0,3);
	if($month)
		$filter[]=array('N'=>$month,'S'=>$m_start,'L'=>strlen($month));
	if($year)
		$filter[]=array('N'=>$year,'S'=>$y_start,'L'=>strlen($year));
	if($day)
		$filter[]=array('N'=>$day,'S'=>$d_start,'L'=>strlen($day));
	return cal_get_files_from_dir($dirname,__CALENDAR_TYPE_DAY, $start, $length, $filter, $flags);
}

#---------------------------------------------------------------------
# Medium level functions (should be documented)

# This should sometimes be faster than cal_get_days_from_dir();
function cal_get_filtered_files_from_dir($dirname, $year='', $y_start=0, $month='', $m_start=0, $day='',$d_start=0)
{
	s_log("Dir: $dirname\tyear: $year\tmonth: $month\tday: $day",0,0,3);
	if($year)
		$filter[]=array('N'=>$year,'S'=>$y_start,'L'=>strlen($year));
	if($month)
		$filter[]=array('N'=>$month,'S'=>$m_start,'L'=>strlen($month));
	if($day)
		$filter[]=array('N'=>$day,'S'=>$d_start,'L'=>strlen($day));
	return cal_get_files_from_dir($dirname,0, 0, 0, $filter, __CALENDAR_FLAGS_RETURN_FILE);
}
#---------------------------------------------------------------------
# Low (full power) level functions (want documentation? here's the code)

function cal_get_files_from_dir($dirname,$type=__CALENDAR_TYPE_YEAR, $start=0, $length=0, $filter=0, $flags=0)
{
	if(empty($flags))
		$flags=__CALENDAR_FLAGS_RETURN_DEFAULT;
	if(($flags & __CALENDAR_FLAGS_RETURN_BOTH) == __CALENDAR_FLAGS_RETURN_BOTH) $flags_both=1;
	else if (($flags & __CALENDAR_FLAGS_RETURN_FILE) == __CALENDAR_FLAGS_RETURN_FILE) $flags_file = 1;
	else if (($flags & __CALENDAR_FLAGS_RETURN_NAME) == __CALENDAR_FLAGS_RETURN_NAME) $flags_name = 1;
	s_log("Looking for files in $dirname",0,0,3);
	switch($type)
	{
	case __CALENDAR_TYPE_YEAR:
		$format=cal_get_format_from_param(__CALENDAR_YEAR_FORMAT);
		break;
	case __CALENDAR_TYPE_MONTH:
		$format=cal_get_format_from_param(__CALENDAR_MONTH_FORMAT);
		break;
	case __CALENDAR_TYPE_DAY:
		$format=cal_get_format_from_param(__CALENDAR_DAY_FORMAT);
		break;
	case 0:
		$format=0;
		break;
	default:
		$format=cal_get_format_from_param(__CALENDAR_MONTH_FORMAT);
	}
	s_log("dirname: $dirname",0,0,3);
	$dir=opendir ($dirname);
	if($dir)
	{
		while($file=readdir($dir))
		{
			if($start)
			{
				if($length)
					$name=substr($file,$start,$length);
				else	
					$name=substr($file,$start);
			}
			else
				$name=$file;
			#s_log("Dir file: $file\tstart: $start length: $length");
			s_log("File: $file\tformat: $format",0,0,3);
			if(cal_is_valid_dir_line($dirname,$file, $name, $format, $filter))
			{
				s_log("Valid file: $file",0,0,3);
				$array_file[]=$file;
				$array_name[]=$name;
			}
		}
		closedir($dir);
	}
	if(is_array($array_file)) asort($array_file);
	else return 0;
	if(is_array($array_name)) asort($array_name,SORT_NUMERIC);
	else return 0;
	if($flags_both)
		return array(
			'FILES'=>$array_file,
			'NAMES'=>$array_name,
			'FILES_U'=>array_unique($array_file),
			'NAMES_U'=>array_unique($array_name)
		);
	else if($flags_file)	
		return array_unique($array_file);
	else if($flags_name)	
		return array_unique($array_name);
	return 0;
}

function cal_get_format_from_param($param)
{
	s_log("param: $param",0,0,3);
	switch($param)
	{
	case 'D':
		s_log('return __CALENDAR_FORMAT_DIR',0,0,3);
		return __CALENDAR_FORMAT_DIR;
	case 'F':
		s_log('return __CALENDAR_FORMAT_FILE',0,0,3);
		return __CALENDAR_FORMAT_FILE;
	case 'd': case 'DIR': case 'dir':
		s_log('return __CALENDAR_FORMAT_DIR',0,0,3);
		return __CALENDAR_FORMAT_DIR;
	case 'f': case 'FILE': case 'file': 
		s_log('return __CALENDAR_FORMAT_FILE',0,0,3);
		return __CALENDAR_FORMAT_FILE;
	default:
		s_log_error("Using default format for $param",0,0,3);
		return __CALENDAR_FORMAT_DIR;
	}
}

function cal_is_valid_dir_line($dir,$file, $name, $format=__CALENDAR_FORMAT_DIR, $filter=0)
{
	s_log("dir: $dir\tfile: $file\tformat: $format",0,0,3);
	if(is_array($filter))
	{	
		foreach($filter as $ifi)
		{
			if(!cal_is_valid_dir_filtered_name($file, $ifi)) return 0;
		}	
	}
	if($format)
	{
		if(!cal_is_valid_dir_line_name($name)) return 0;
		switch($format)
		{
		case __CALENDAR_FORMAT_DIR:
			return cal_is_valid_dir_line_dir($dir,$file);
		case __CALENDAR_FORMAT_FILE:
			return cal_is_valid_dir_line_file($dir,$file);
		}
		s_log_error("Not a known format $format for $dir/$file",0,0,3);
	}	
	return 1;
}

function cal_is_valid_dir_line_dir($dir,$file)
{
	s_log("dir: $dir\tfile: $file",0,0,3);
	if(!is_dir("$dir/$file")) return 0;
	return 1;	
}

function cal_is_valid_dir_line_file($dir,$file)
{
	s_log("dir: $dir\tfile: $file",0,0,3);
	if(!is_file("$dir/$file")) return 0;
	return 1;
}

function cal_is_valid_dir_filtered_name($file, $filter=0)
{
	if(is_array($filter))
	{
		if($filter['N'])
		{	
			s_log('Using filter: '.$filter['N'],0,0,3);
			$name=substr($file,$filter['S'], $filter['L']);
			s_log("Filter name: $name",0,0,3);
			if($name != $filter['N']) return 0;
		}
	}
	return 1;
}

function cal_is_valid_dir_line_name($name)
{
	if(__CALENDAR_VALIDATE_NAME_STRICT)
	{
		$fslen=strlen($name);
		s_log("fslen: $fslen",0,0,3);
		if(($fslen<1)||($fslen>4)) return 0;
		s_log("fslen: OK",0,0,3);
	}
	if(!is_numeric($name)) return 0;
	s_log("Is Numeric $name: OK",0,0,3);
	if(__CALENDAR_VALIDATE_NAME_STRICT)
	{
		if(!s_is_int($name)) return 0;	
		s_log("Is Int $name: OK",0,0,3);
	}	
	return 1;	
}

#---------------------------------------------------------------------
} // __CALENDAR_DIR
?>