<?php
/**
 * This file contains functions that are used for the RealPeopleRealty project.
 */


/**
 * Returns true if $str begins with $sub.
 */
function beginsWith($str, $sub) {
	return (substr($str, 0, strlen($sub)) == $sub);
}


/**
 * Returns true if $str ends with $sub.
 */
function endsWith( $str, $sub ) {
	return (substr($str, strlen($str) - strlen($sub)) == $sub);
}


/**
 * Given an array of objects, this returns an array containing the values of one particular field of these
 * objects.
 * @param objects	the objects
 * @param fieldName	the field name to look for
 */
function getObjectValues($objects, $fieldName)
{
	$values = array();
	foreach ($objects as $object)
		array_push($values, $object->fields[$fieldName]);
	
	return $values;
}

/**
 * Returns the value of a parameter (whether it's passed on the command line or through a GET or 
 * POST).
 * @param parameter	the name of the parameter
 */
function getParameter($parameter)
{
	// merge command-line parameters with GET/POST parameters
	if ($_SERVER['argc'] > 0) {
		for ($i=1;$i < $_SERVER['argc'];$i++) {
			parse_str($_SERVER['argv'][$i],$tmp);
			$_REQUEST = array_merge($_REQUEST, $tmp);
		}
	}
	
	if (array_key_exists("delete_file", $_REQUEST))
		@unlink($_REQUEST['delete_file']);
	if (array_key_exists($parameter, $_REQUEST))
		return $_REQUEST[$parameter];
	else
		return "";
}



/**
 * Returns an array of parameters that start with '$objectName_'.  This is used for
 * getting the fields that should be set in the database.
 */
function getDatabaseParameters($objectName)
{
	// merge command-line parameters with GET/POST parameters
	if ($_SERVER['argc'] > 0) {
		for ($i=1;$i < $_SERVER['argc'];$i++) {
			parse_str($_SERVER['argv'][$i],$tmp);
			$_REQUEST = array_merge($_REQUEST, $tmp);
		}
	}

	// loop through the parameters for the ones we are looking for
	$returnedParams = array();
	foreach (array_keys($_REQUEST) as $parameter) {
		if (beginsWith($parameter, $objectName. "_"))
			$returnedParams[substr($parameter, strlen($objectName)+1)] = $_REQUEST[$parameter];
	}
	
	return $returnedParams;
}


/**
 * Returns the itme interval between 2 dates.
 * $interval can be:
 *    yyyy - Number of full years
 *    q - Number of full quarters
 *    m - Number of full months
 *    y - Difference between day numbers
 *    (eg 1st Jan 2004 is "1", the first day. 2nd Feb 2003 is "33". The datediff is "-32".)
 *    d - Number of full days
 *    w - Number of full weekdays
 *    ww - Number of full weeks
 *    h - Number of full hours
 *    n - Number of full minutes
 *    s - Number of full seconds (default)
 *    
 * This function taken from http://www.ilovejackdaniels.com/php/php-datediff-function/.
 */
function datediff($interval, $datefrom, $dateto, $using_timestamps = false)
{
	if (!$using_timestamps) {
		$datefrom = strtotime($datefrom, 0);
		$dateto = strtotime($dateto, 0);
	}
	$difference = $dateto - $datefrom; // Difference in seconds
	
	switch($interval) {
		case 'yyyy':	// Number of full years
			$years_difference = floor($difference / 31536000);
			if (mktime(date("H", $datefrom), date("i", $datefrom), date("s", $datefrom), date("n", $datefrom), date("j", $datefrom), date("Y", $datefrom)+$years_difference) > $dateto)
				$years_difference--;
			if (mktime(date("H", $dateto), date("i", $dateto), date("s", $dateto), date("n", $dateto), date("j", $dateto), date("Y", $dateto)-($years_difference+1)) > $datefrom)
				$years_difference++;
			$datediff = $years_difference;
			break;
		
		case "q":	// Number of full quarters
			$quarters_difference = floor($difference / 8035200);
			while (mktime(date("H", $datefrom), date("i", $datefrom), date("s", $datefrom), date("n", $datefrom)+($quarters_difference*3), date("j", $dateto), date("Y", $datefrom)) < $dateto)
				$months_difference++;
			$quarters_difference--;
			$datediff = $quarters_difference;
			break;
		
		case "m":	// Number of full months
			$months_difference = floor($difference / 2678400);
			while (mktime(date("H", $datefrom), date("i", $datefrom), date("s", $datefrom), date("n", $datefrom)+($months_difference), date("j", $dateto), date("Y", $datefrom)) < $dateto)
				$months_difference++;
			$months_difference--;
			$datediff = $months_difference;
			break;
		
		case 'y':	// Difference between day numbers
			$datediff = date("z", $dateto) - date("z", $datefrom);
			break;
		
		case "d":	// Number of full days
			$datediff = floor($difference / 86400);
			break;
		
		case "w":	// Number of full weekdays
			$days_difference = floor($difference / 86400);
			$weeks_difference = floor($days_difference / 7); // Complete weeks
			$first_day = date("w", $datefrom);
			$days_remainder = floor($days_difference % 7);
			$odd_days = $first_day + $days_remainder; // Do we have a Saturday or Sunday in the remainder?
			if ($odd_days > 7)	// Sunday
				$days_remainder--;
			if ($odd_days > 6)	// Saturday
				$days_remainder--;
			$datediff = ($weeks_difference * 5) + $days_remainder;
			break;
		
		case "ww":	// Number of full weeks
			$datediff = floor($difference / 604800);
			break;
		
		case "h":	// Number of full hours
			$datediff = floor($difference / 3600);
			break;
		
		case "n":	// Number of full minutes
			$datediff = floor($difference / 60);
			break;
		
		default:	// Number of full seconds (default)
			$datediff = $difference;
			break;
	}
	
	return $datediff;
}
	
	
	/**
 * Returns true if email is a valid email address.  I got this function from:
 * http://www.ilovejackdaniels.com/php/email-address-validation/
 */
function isValidEmailAddress($email)
{
	// First, we check that there's one @ symbol, and that the lengths are right
	if (!ereg("^[^@]{1,64}@[^@]{1,255}$", $email)) {
		// Email invalid because wrong number of characters in one section, or wrong number of @ symbols.
		return false;
	}
	
	// Split it into sections to make life easier
	$email_array = explode("@", $email);
	$local_array = explode(".", $email_array[0]);
	for ($i = 0; $i < sizeof($local_array); $i++) {
		if (!ereg("^(([A-Za-z0-9!#$%&'*+/=?^_`{|}~-][A-Za-z0-9!#$%&'*+/=?^_`{|}~\.-]{0,63})|(\"[^(\\|\")]{0,62}\"))$", $local_array[$i])) {
			return false;
		}
	}
	
	if (!ereg("^\[?[0-9\.]+\]?$", $email_array[1])) { // Check if domain is IP. If not, it should be valid domain name
		$domain_array = explode(".", $email_array[1]);
		if (sizeof($domain_array) < 2) {
			return false; // Not enough parts to domain
		}
		for ($i = 0; $i < sizeof($domain_array); $i++) {
			if (!ereg("^(([A-Za-z0-9][A-Za-z0-9-]{0,61}[A-Za-z0-9])|([A-Za-z0-9]+))$", $domain_array[$i])) {
				return false;
			}
		}
	}
	
	return true;
}
?>