format.php

<?php
//todo ~ deprecate this entire library and start a string library?
error_debug('including format.php', __file__, __line__);

function format_accents_convert($string) {
	$string = html_entity_decode($string);
    $transliterations = array('á' => 'a', 'Á' => 'A', 'à' => 'a', 'À' => 'A', 'ă' => 'a', 'Ă' => 'A', 'â' => 'a', 'Â' => 'A', 'å' => 'a', 'Å' => 'A', 'ã' => 'a', 'Ã' => 'A', 'ą' => 'a', 'Ą' => 'A', 'ā' => 'a', 'Ā' => 'A', 'ä' => 'ae', 'Ä' => 'AE', 'æ' => 'ae', 'Æ' => 'AE', 'ḃ' => 'b', 'Ḃ' => 'B', 'ć' => 'c', 'Ć' => 'C', 'ĉ' => 'c', 'Ĉ' => 'C', 'č' => 'c', 'Č' => 'C', 'ċ' => 'c', 'Ċ' => 'C', 'ç' => 'c', 'Ç' => 'C', 'ď' => 'd', 'Ď' => 'D', 'ḋ' => 'd', 'Ḋ' => 'D', 'đ' => 'd', 'Đ' => 'D', 'ð' => 'dh', 'Ð' => 'Dh', 'é' => 'e', 'É' => 'E', 'è' => 'e', 'È' => 'E', 'ĕ' => 'e', 'Ĕ' => 'E', 'ê' => 'e', 'Ê' => 'E', 'ě' => 'e', 'Ě' => 'E', 'ë' => 'e', 'Ë' => 'E', 'ė' => 'e', 'Ė' => 'E', 'ę' => 'e', 'Ę' => 'E', 'ē' => 'e', 'Ē' => 'E', 'ḟ' => 'f', 'Ḟ' => 'F', 'ƒ' => 'f', 'Ƒ' => 'F', 'ğ' => 'g', 'Ğ' => 'G', 'ĝ' => 'g', 'Ĝ' => 'G', 'ġ' => 'g', 'Ġ' => 'G', 'ģ' => 'g', 'Ģ' => 'G', 'ĥ' => 'h', 'Ĥ' => 'H', 'ħ' => 'h', 'Ħ' => 'H', 'í' => 'i', 'Í' => 'I', 'ì' => 'i', 'Ì' => 'I', 'î' => 'i', 'Î' => 'I', 'ï' => 'i', 'Ï' => 'I', 'ĩ' => 'i', 'Ĩ' => 'I', 'į' => 'i', 'Į' => 'I', 'ī' => 'i', 'Ī' => 'I', 'ĵ' => 'j', 'Ĵ' => 'J', 'ķ' => 'k', 'Ķ' => 'K', 'ĺ' => 'l', 'Ĺ' => 'L', 'ľ' => 'l', 'Ľ' => 'L', 'ļ' => 'l', 'Ļ' => 'L', 'ł' => 'l', 'Ł' => 'L', 'ṁ' => 'm', 'Ṁ' => 'M', 'ń' => 'n', 'Ń' => 'N', 'ň' => 'n', 'Ň' => 'N', 'ñ' => 'n', 'Ñ' => 'N', 'ņ' => 'n', 'Ņ' => 'N', 'ó' => 'o', 'Ó' => 'O', 'ò' => 'o', 'Ò' => 'O', 'ô' => 'o', 'Ô' => 'O', 'ő' => 'o', 'Ő' => 'O', 'õ' => 'o', 'Õ' => 'O', 'ø' => 'oe', 'Ø' => 'OE', 'ō' => 'o', 'Ō' => 'O', 'ơ' => 'o', 'Ơ' => 'O', 'ö' => 'oe', 'Ö' => 'OE', 'ṗ' => 'p', 'Ṗ' => 'P', 'ŕ' => 'r', 'Ŕ' => 'R', 'ř' => 'r', 'Ř' => 'R', 'ŗ' => 'r', 'Ŗ' => 'R', 'ś' => 's', 'Ś' => 'S', 'ŝ' => 's', 'Ŝ' => 'S', 'š' => 's', 'Š' => 'S', 'ṡ' => 's', 'Ṡ' => 'S', 'ş' => 's', 'Ş' => 'S', 'ș' => 's', 'Ș' => 'S', 'ß' => 'SS', 'ť' => 't', 'Ť' => 'T', 'ṫ' => 't', 'Ṫ' => 'T', 'ţ' => 't', 'Ţ' => 'T', 'ț' => 't', 'Ț' => 'T', 'ŧ' => 't', 'Ŧ' => 'T', 'ú' => 'u', 'Ú' => 'U', 'ù' => 'u', 'Ù' => 'U', 'ŭ' => 'u', 'Ŭ' => 'U', 'û' => 'u', 'Û' => 'U', 'ů' => 'u', 'Ů' => 'U', 'ű' => 'u', 'Ű' => 'U', 'ũ' => 'u', 'Ũ' => 'U', 'ų' => 'u', 'Ų' => 'U', 'ū' => 'u', 'Ū' => 'U', 'ư' => 'u', 'Ư' => 'U', 'ü' => 'ue', 'Ü' => 'UE', 'ẃ' => 'w', 'Ẃ' => 'W', 'ẁ' => 'w', 'Ẁ' => 'W', 'ŵ' => 'w', 'Ŵ' => 'W', 'ẅ' => 'w', 'Ẅ' => 'W', 'ý' => 'y', 'Ý' => 'Y', 'ỳ' => 'y', 'Ỳ' => 'Y', 'ŷ' => 'y', 'Ŷ' => 'Y', 'ÿ' => 'y', 'Ÿ' => 'Y', 'ź' => 'z', 'Ź' => 'Z', 'ž' => 'z', 'Ž' => 'Z', 'ż' => 'z', 'Ż' => 'Z', 'þ' => 'th', 'Þ' => 'Th', 'µ' => 'u', 'а' => 'a', 'А' => 'a', 'б' => 'b', 'Б' => 'b', 'в' => 'v', 'В' => 'v', 'г' => 'g', 'Г' => 'g', 'д' => 'd', 'Д' => 'd', 'е' => 'e', 'Е' => 'E', 'ё' => 'e', 'Ё' => 'E', 'ж' => 'zh', 'Ж' => 'zh', 'з' => 'z', 'З' => 'z', 'и' => 'i', 'И' => 'i', 'й' => 'j', 'Й' => 'j', 'к' => 'k', 'К' => 'k', 'л' => 'l', 'Л' => 'l', 'м' => 'm', 'М' => 'm', 'н' => 'n', 'Н' => 'n', 'о' => 'o', 'О' => 'o', 'п' => 'p', 'П' => 'p', 'р' => 'r', 'Р' => 'r', 'с' => 's', 'С' => 's', 'т' => 't', 'Т' => 't', 'у' => 'u', 'У' => 'u', 'ф' => 'f', 'Ф' => 'f', 'х' => 'h', 'Х' => 'h', 'ц' => 'c', 'Ц' => 'c', 'ч' => 'ch', 'Ч' => 'ch', 'ш' => 'sh', 'Ш' => 'sh', 'щ' => 'sch', 'Щ' => 'sch', 'ъ' => '', 'Ъ' => '', 'ы' => 'y', 'Ы' => 'y', 'ь' => '', 'Ь' => '', 'э' => 'e', 'Э' => 'e', 'ю' => 'ju', 'Ю' => 'ju', 'я' => 'ja', 'Я' => 'ja');
    return str_replace(array_keys($transliterations), array_values($transliterations), $string);
}

function format_accents_encode($string) {
	//not sure if this is necessary anymore with the conversion to utf8
	//update: it is, email not supporting utf8
	$string = str_replace('“', '&ldquo;',	$string);
	$string = str_replace('”', '&rdquo;',	$string);
	$string = str_replace('‘', '&lsquo;',	$string);
	$string = str_replace('’', '&rsquo;',	$string);
	$string = str_replace('–', '&ndash;',	$string);
	$string = str_replace('—', '&mdash;',	$string);

	$string = str_replace('ä', '&auml;',	$string);
	$string = str_replace('ë', '&euml;',	$string);
	$string = str_replace('ï', '&iuml;',	$string);
	$string = str_replace('ö', '&ouml;',	$string);
	$string = str_replace('ü', '&uuml;',	$string);

	$string = str_replace('á', '&aacute;',	$string);
	$string = str_replace('é', '&eacute;',	$string);
	$string = str_replace('í', '&iacute;',	$string);
	$string = str_replace('ó', '&oacute;',	$string);
	$string = str_replace('ú', '&uacute;',	$string);

	$string = str_replace('à', '&agrave;',	$string);
	$string = str_replace('è', '&egrave;',	$string);
	$string = str_replace('ì', '&igrave;',	$string);
	$string = str_replace('ò', '&ograve;',	$string);
	$string = str_replace('ù', '&ugrave;',	$string);

	$string = str_replace('ç', '&ccedil;',	$string);
	$string = str_replace('ñ', '&ntilde;',	$string);
	return $string;
}

function format_accents_remove($string) {
	//translate accents	
	$string = html_entity_decode($string);
	$from	= 'áàäâçéèëêíìïîóòöôøúùüûñ';
	$to		= 'aaaaceeeeiiiiooooouuuun';
	
	$string = str_replace('&rsquo;', "'", $string);
	$string = str_replace('&lsquo;', "'", $string);
	$string = str_replace('&rdsquo;', '"', $string);
	$string = str_replace('&ldsquo;', '"', $string);
	
    return strtr(utf8_decode($string), utf8_decode($from), $to);
}

function format_array_text($array, $separator='and') {
	if (!is_array($array)) {
		//string
		return $array;
	} elseif (!count($array)) {
		//empty array
		return '';
	} elseif (count($array) == 1) {
		return $array[0];
	} else {
		$last = array_pop($array);
		return implode(', ', $array) . ' ' . $separator . ' ' . $last;
	}
}

function format_ascii($string) {
	//used by draw_link() for email obfuscation
	$len = strlen($string);
	$return = '';
	for ($i = 0; $i < $len; $i++) $return .= '&#' . ord($string[$i]) . ';';
	return $return;
}

function format_binary($blob) {
	//todo -- db_binary?
	global $_josh;
	if ($_josh['db']['language'] == 'mssql') {
		$return = unpack('H*hex', $blob);
		return '0x' . $return['hex'];
	} elseif ($_josh['db']['language'] == 'mysql') {
		return '"' . addslashes($blob) . '"';
	}
}

function format_boolean($value, $options='Yes|No') {
	list($yes, $no) = explode('|', $options);
	if ($value) return $yes;
	return $no;
}

function format_check($variable, $type='int') {
	//todo compile a set of cases where we use format_check, format_num, format_numeric, format_verify.  i think this can be simplifed
	//alias
	return format_verify($variable, $type);
}

function format_class($string) {
	//used by draw_nav and admiral center to derive an HTML-safe class name from a URL
	$string = str_replace('/', '', $string);
	$string = str_replace('?', '_', $string);
	$string = str_replace('=', '_', $string);
	if (empty($string)) $string = 'home';
	return $string;
}

function format_code($code) {
	//afaik this is just for formatting error messages.  
	return '<p style="font-family:courier; font-size:13px;">' . nl2br(str_replace('\t', '&nbsp;', htmlentities($code))) . '</p>';
}

function format_date($timestamp=false, $error='', $format=false, $relativetime=true, $todaytime=false) {
	global $_josh;

	if ($timestamp === false) $timestamp = time();
	if (!$format) $format = $_josh['date']['format'];
	
	//reject or convert
	if (empty($timestamp) || ($timestamp == 'Jan 1 1900 12:00AM')) return $error;
	if (!is_int($timestamp)) $timestamp = strToTime($timestamp);
	
	//special thing to format for sql
	if (stristr($format, 'sql')) return date('Y-m-d H:i:00', $timestamp);

	//special thing to format for sql
	if ($format == 'unix') return date('U', $timestamp);

	if ($relativetime) {
		//get timestamp for today
		$todaysdate = mktime(0, 0, 1, $_josh['month'], $_josh['today'], $_josh['year']);
	
		//get timestamp for argument, without time
		$returnday    = date('d', $timestamp);
		$returnyear   = date('Y', $timestamp);
		$returnmonth  = date('n', $timestamp);
		$returndate   = mktime(0, 0, 1, $returnmonth, $returnday, $returnyear);
			
		//setup return date
		$datediff = ($returndate - $todaysdate) / 86400;
		if ($datediff == 0) {
			$return = ($todaytime) ? format_time($timestamp) : $_josh['date']['strings'][1];
		} elseif ($datediff == -1) {
			$return = $_josh['date']['strings'][0];
		} elseif ($datediff == 1) {
			$return = $_josh['date']['strings'][2];
		} elseif (($datediff < -1) && ($datediff > -7)) { //last six days
			$return = strftime('%A', $timestamp); //return day of week
			//$return = date('l', $timestamp); //return day of week
		} else {
			$return = strftime($format, $timestamp);
			//$return = date($format, $timestamp); //M d, Y
		}
	} else {
		$return = strftime($format, $timestamp);
		//$return = date($format, $timestamp);
	}
	
	if ($return === 1) return $error;
	
	return draw_tag('time', array('datetime'=>date('Y-m-d', $timestamp) . 'T' . date('H:i:s', $timestamp)), $return);
}

function format_date_iso8601($timestamp=false) {
	//this looks like DATE_W3C http://www.php.net/manual/en/datetime.constants.php
	//use this for xml
	if (!$timestamp) $timestamp = time();
	if (!is_int($timestamp)) $timestamp = strToTime($timestamp);
	return date('Y-m-d', $timestamp) . 'T' . date('H:i:s', $timestamp) . '-07:00';
}

function format_date_rss($timestamp=false) {
	//todo ~ define difference between this and format_date_iso8601 above?
	if (!$timestamp) $timestamp = time();
	if (!is_int($timestamp)) $timestamp = strToTime($timestamp);
	return date(DATE_RSS, $timestamp);
}

function format_date_sql($month, $day=false, $year=false, $hour=false, $minute=false, $second=false) {	
	//format a date for sql

	if (!$day || !$year) {
		/* new functionality; month could be a timestamp that needs to be converted a sql-ready date 
		update 9/25/12: since when can this accept a month and nothing else?  updating to return null for FSS
		if (empty($month)) return 'NULL';
		$date = strToTime($month);*/
		return 'NULL';
	} elseif (!$hour) {
		//restore old defaults
		$hour = 0;
		$minute = 0;
		$second = 1;
		$date = mktime($hour, $minute, $second, $month, $day, $year);
	} else {
		$date = mktime($hour, $minute, $second, $month, $day, $year);
	}
	
	return '\'' . date('Y-m-d H:i:00', $date) . '\'';
}

function format_date_time($timestamp=false, $error='', $separator=' ', $suppressMidnight=true, $relativetime=true) {
	//string_datetime?
	if ($timestamp === false) $timestamp = time();
	$return = format_date($timestamp, $error, false, $relativetime);
	//if (($return == 'Today') || ($return == 'Yesterday') || ($return == 'Tomorrow')) 
	$time = format_time($timestamp);
	if ($suppressMidnight && ($time == '12:00am')) return $return;
	return $return . $separator . $time;
}

function format_date_range($start, $end, $separator='&ndash;') {
	//return a string date range, like Jan 21-22 2010, or Jan 8 from 11-11:30am
	if (!is_integer($start)) $start	= strtotime($start);
	if (!is_integer($end)) $end	= strtotime($end);
	
	if (date('Y', $start) == date('Y', $end)) {
		if (date('n', $start) == date('n', $end)) {
			if (date('j', $start) == date('j', $end)) {
				//same day
				return format_date($start);
			}
			//same month
			return strftime('%b', $start) . ' ' . strftime('%e', $start) . $separator . strftime('%e', $end) . ', ' . strftime('%Y', $end);
		}
		//same year
		return strftime('%b %e', $start) . $separator . strftime('%b %e', $end)  . ', ' . strftime('%Y', $end);
	}
	//same year
	return strftime('%b %e, %Y', $start) . $separator . strftime('%b %e, %Y', $end);
}

function format_date_time_range($start, $end) {
	//return a string date range, like Jan 21-22 2010, or Jan 8 from 11-11:30am
	if (!is_integer($start)) $start	= strtotime($start);
	if (!is_integer($end)) $end	= strtotime($end);
	
	if (date('Y', $start) == date('Y', $end)) {
		if (date('n', $start) == date('n', $end)) {
			if (date('j', $start) == date('j', $end)) {
				if (date('a', $start) == date('a', $end)) {
					//same am/pm
					$starttime = (date('i', $start) == '00') ? date('g', $start) :  date('g:i', $start);
					$endtime = (date('i', $end) == '00') ? date('g', $end) :  date('g:i', $end);
					return format_date($start) . ' ' . $starttime . '-' . $endtime . date('a', $end);
				}
				//same day
				return format_date($start) . ' from ' . format_time($start) . ' to ' . format_time($end);
			}
			//same month
			return date('M', $start) . ' ' . date('j', $start) . '&ndash;' . date('j', $end) . ', ' . date('Y', $end);
		}
		//same year
		return format_date_time($start, false, ' at ') . ' to ' . format_date_time($end, false, ' at ');
	}
	//different years
	return format_date_time($start, false, ' at ') . ' to ' . format_date_time($end, false, ' at ');
}

function format_date_excel($timestamp) {
	if (!empty($timestamp)) return @date('n/j/Y', strToTime($timestamp));
}

function format_date_xml($timestamp=false) {
	//difference between this and format_date_rss and format_date_iso8601?
	if (!$timestamp) $timestamp = 'now';
	if (!empty($timestamp) && $timestamp) return @date('Y-m-d', strToTime($timestamp)) . 'T00:00:00.000';
}

function format_email($address) {
	//clean up email address or return false if invalid

	$address = trim($address);
	$address = strToLower($address); //technically, local part could be case-sensitive, but i don't think this happens enough to be significant
	$address = str_replace("'", '', $address);
	$address = str_replace('"', '', $address);
	$address = preg_replace('/\r/', '', $address);
	$address = preg_replace('/\n/', '', $address);
	
	//this section of code adapted from http://www.linuxjournal.com/article/9585
	$atIndex = strrpos($address, "@");
	if (is_bool($atIndex) && !$atIndex) {
		return false; //no @ symbol
	} else {
		$domain = substr($address, $atIndex+1);
		$local = substr($address, 0, $atIndex);
		$localLen = strlen($local);
		$domainLen = strlen($domain);
		if ($localLen < 1 || $localLen > 64) {
			return false; //local part length wrong
		} elseif ($domainLen < 1 || $domainLen > 255) {
			return false; //domain part length wrong
		} elseif ($local[0] == '.' || $local[$localLen-1] == '.') {
			return false; //local part starts or ends with '.'
		} elseif (preg_match('/\\.\\./', $local)) {
			return false; //local part has two consecutive dots
		} elseif (!preg_match('/^[A-Za-z0-9\\-\\.]+$/', $domain)) {
			return false; //character not valid in domain part
		} else if (preg_match('/\\.\\./', $domain)) {
			return false; //domain part has two consecutive dots
		} elseif (!preg_match('/^(\\\\.|[A-Za-z0-9!#%&`_=\\/$\'*+?^{}|~.-])+$/', str_replace("\\\\", '', $local))) {
			//character not valid in local part unless local part is quoted (and we just stripped the quotes, so)
			if (!preg_match('/^"(\\\\"|[^"])+"$/', str_replace("\\\\","",$local))) return false;
		}
		//todo enable dns lookup
		//if ($isValid && !(checkdnsrr($domain,"MX") || checkdnsrr($domain,"A"))) return false; //domain not found in DNS
	}

	return $address;
}

function format_file_name($str, $ext) {
	//formatting for downloaded files
	//TODO: only truly invalid characters should be checked.  i'm sure it's ok to download files with spaces, for example.
	
	$str = html_entity_decode($str);
	
	$str = str_replace('"',		'', 	$str);
	$str = str_replace("'",		'', 	$str);
	$str = str_replace('.',		'', 	$str);
	$str = str_replace(':',		'',		$str);
	$str = str_replace('/',		'',		$str);
	$str = str_replace('\\',	'',		$str);
	
	$str = str_replace('  ',	' ',	$str);
	$str = str_replace('  ',	' ',	$str);

	//$str = str_replace(' ',		'_',	$str);
	$str = format_string($str, 60, ''); //substr($str, 0, 60);

	return $str . '.' . $ext;
	return strtolower($str . '.' . $ext);
}  

function format_file_size($file) {
	$size = @filesize($file);
	return format_size($size);
} 

function format_get($value) {
	//returns int, decimal, text, textarea
	//used by db_table_from_array
	if (empty($value)) return false;
	if (is_numeric($value) || is_numeric(str_replace(',', '', $value))) {
		if (strstr($value, '.')) return 'decimal';
		return 'int';
	} elseif (strlen($value) > 255) {
		return 'text';
	}
	return 'varchar';
}

function format_highlight($haystack, $needles=false) {
	//sometimes you want to use a highlighter on html -- usually in search results
	if (!$needles) return $haystack; //$needles is optional
	if (is_array($needles)) $needles = implode('|', $needles);
	
	//pattern is not yet bulletproof, but supports html now
	//thanks to ddrudik at http://www.experts-exchange.com/Web_Development/Web_Languages-Standards/PHP/Q_22713827.html
	$pattern = '/(?<=^|[> ])(' . $needles . ')(?=$|[^a-z])/is';
	
	return preg_replace($pattern, draw_span('highlight', '\\0'), $haystack);
}

function format_html($text, $profile='user') {
	//profile can be public, user or admin, with decreasing restrictions
	//todo tie this programmically to user() and admin()

	//replace links not already in <a> tags
	//why was this commented?
	$bits = preg_split('/(<a(?:\s+[^>]*)?>.*?<\/a>|<[a-z][^>]*>)/is', $text, null, PREG_SPLIT_DELIM_CAPTURE);
	$reconstructed = '';
	foreach ($bits as $bit) {
		if (strpos($bit, '<') !== 0) $bit = format_html_links($bit);
		$reconstructed .= $bit;
	}	
	$text = $reconstructed;
	
	lib_get('simple_html_dom');
	$html = str_get_html($text);
	
	if (($profile == 'public') || ($profile == 'user')) $html->set_callback('cleanupUser');
	//if ($profile == 'public') $html->set_callback('cleanupPublic');
	//$html->set_callback('cleanupAdmin');
		
	if (!function_exists('cleanupAdmin')) {
		function cleanupAdmin() {
			//todo
		}
		
		function cleanupPublic($e) {
			//person off the street, aka hacker
			
			if (in_array($e->tag, array('blockquote', 'h1', 'h2', 'h3', 'h4', 'h5', 'h6', 'li'))) {
				//replace these with <p> tags so as to keep the formatting but losing the styling
				$e->outertext = ($e->innertext) ? '<p>' . $e->innertext . '</p>' : '';
			} elseif (!in_array($e->tag, array('a', 'b', 'br', 'dir', 'div', 'hgroup', 'i', 'p', 'strike', 'strong', 'text'))) {
				//narrower list of acceptable tags
				$e->outertext = ($e->innertext) ? ' ' . $e->innertext . ' ' : '';
			}
		}

		function cleanupUser($e) {
			//this callback is used to clear out bad tags and attributes
						
			//kill bad tags
			//never want these tags, or anything inside them
			$bad_tags = array('comment', 'form', 'label', 'input', 'link', 'noscript', 'script', 'select', 'style', 'textarea', 'unknown'); //new iframe whitelist			
			if (in_array($e->tag, $bad_tags)) tagUnset($e);		
			
			//these are the tags we want.  if you're not one of these, remove but keep your contents eg <NYT_HEADLINE>
			//what's a <text> tag?  maybe this means actual text to simple_html_dom
			if (!in_array($e->tag, array(
				'a', 'article', 'aside', 'b', 'blockquote', 'br', 'caption', 'dir', 'div', 'dd', 'dl', 'dt', 'em', 'h1', 'h2', 'h3', 'h4', 'h5', 'h6', 'hgroup', 'hr', 'i', 'iframe', 'img',
				'ol', 'li', 'p', 'section', 'span', 'strike', 'strong', 'tbody', 'text', 'table', 'td', 'th', 'tr', 'ul',
				'object', 'embed', 'param'
			))) $e->outertext = ($e->innertext) ? $e->innertext : '';
					
			//never want these attributes
			$bad_attributes = array('onclick', 'onmouseout', 'onmouseover', 'onload');
			foreach ($bad_attributes as $b) if (isset($e->$b)) unset($e->$b);
						
			//certain tags we are wary of
			if ($e->tag == 'a') {
				if ($e->parent->tag == 'a') $e->parent->innertext = $e->innertext;
				if ($local_url = format_text_starts(url_base(), $e->href)) {
					//local hyperlinks if possible (except backend.livingcities.org situation)
					if (url_base() != 'http://backend.livingcities.org') $e->href = $local_url;
				}
				if ($e->href) $e->href = strip_tags($e->href);
			} elseif ($e->tag == 'b') {
				//deprecated tag: replace <b> with <strong>
				$e->outertext = '<strong>' . $e->innertext . '</strong>';
			} elseif ($e->tag == 'i') {
				//deprecated tag: replace <i> with <em>
				$e->outertext = '<em>' . $e->innertext . '</em>';
			} elseif ($e->tag == 'iframe') {
				//be cautious with iframes, they can be malicious
				if (!in_array(url_domain($e->src), array('google.com', 'vimeo.com', 'youtube.com'))) $e->outertext = '';
			} elseif (($e->tag == 'p') && (!$e->innertext || ($e->innertext == '&nbsp;'))) {
				//kill empty p tags (msword and tinymce)
				$e->outertext = '';
			}
		}
		
		function tagUnset($e) {
			if (@$e->children) foreach($e->children as $f) tagUnset($f);
			if (@$e->innertext) $e->innertext = '';
			if (@$e->outertext) $e->outertext = '';
		}		
	}
		
	//reset html to get rid of artifacts and compress
	$text = trim($html->save());
	$html->clear();
	
	//special josh function to replace email addresses with obfuscated ones via format_ascii
	preg_match_all("/[A-Z0-9._%+-]+@[A-Z0-9.-]+\.[A-Z]{2,4}/i", $text, $matches);
	foreach ($matches[0] as $m) $text = str_replace($m, format_ascii($m), $text);
	
	$text = str_replace('&nbsp;', ' ', $text);
	
	return $text;
}

function format_html_entities($string) {
	//$string = htmlentities($string);
	$string = str_replace('‘', '&lsquo;', $string); //left single quote
	$string = str_replace('’', '&rsquo;', $string); //right single quote
	$string = str_replace('“', '&ldquo;', $string); //left double quote
	$string = str_replace('”', '&rdquo;', $string); //right double quote
	$string = str_replace('—', '&mdash;', $string); //em dash
	return $string;
}

function format_html_img($url, $text=false) {
	//returns the largest (jpg) image from the specified $url or within the provided $text
	//you have to provide the URL because it might need to correct the images
	lib_get('simple_html_dom');
	$found = array();	
	
	if (!$text) $text = url_get($url);
	
	if ($text) {
		$text = str_get_html($text);
		$images = array();
		$supported_types = array('jpg', 'tif', 'png', 'jpeg');
		
		//first, look for facebook share title http://developers.facebook.com/docs/share/
		$blocks = $text->find('meta');
		foreach ($blocks as $b) if (($b->property == 'og:image') && (file_type($b->content) == 'jpg')) return trim($b->content);
	
		//quick search for <link rel="image_src">, 
		$blocks = $text->find('link');
		foreach ($blocks as $b) if (($b->rel == 'image_src') && $b->href && (file_type($b->href) == 'jpg')) { 
			if($b->width && $b->height) {
				$area = $b->width * $b->height;
				max_num($area);
				error_debug('<b>' . __function__ . '</b> <link> using ' . htmlentities($b) . ' with area ' . $area, __file__, __line__);
				$images[$area] = $b->href;
			}
		}
		
		//loop through images		
		$blocks = $text->find('img');
		
		error_debug('<b>' . __function__ . '</b> found ' . count($blocks) . ' images within ' . strlen($text) . ' char text', __file__, __line__);
		
		foreach ($blocks as $b) {
			if ($b->width && $b->height && (in_array(file_type($b->src), $supported_types))) {
				$area = $b->width * $b->height;
				max_num($area);
				error_debug('<b>' . __function__ . '</b> using ' . htmlentities($b) . ' with area ' . $area, __file__, __line__);
				$images[$area] = $b->src;
			} else {
				error_debug('<b>' . __function__ . '</b> skipping ' . htmlentities($b) . ' because either width, height or src is missing or src is not jpg', __file__, __line__);
			}
		}
		if ($max = max_num()) {
			error_debug('<b>' . __function__ . '</b> found max, which was ' . $max, __file__, __line__);
			if (substr($images[$max], 0, 1) == '/') {
				$url = url_parse($url);
				$images[$max] = $url['base'] . $images[$max];
			}
			error_debug('<b>' . __function__ . '</b> returning ' . $images[$max], __file__, __line__);
			return $images[$max];
		} else {
			error_debug('<b>' . __function__ . '</b> not returning anything', __file__, __line__);
			return false;
		}
	} else {
		error_debug('<b>' . __function__ . '</b> quitting because no text', __file__, __line__);
		return false;
	}
}

function format_html_links($str) {
	//from here: http://snipplr.com/view/2371/regex-regular-expression-to-match-a-url/
	//$regex = '@(https?://([-\w\.]+)+(:\d+)?(/([\w/_\.]*(\?\S+)?)?)?)@';
	
	//daring fireball regex, can't get it to encapsulate correctly (from here: http://daringfireball.net/2010/07/improved_regex_for_matching_urls)
	$regex = '@((?i)\b((?:https?://|www\d{0,3}[.]|[a-z0-9.\-]+[.][a-z]{2,4}/)(?:[^\s()<>]+|\(([^\s()<>]+|(\([^\s()<>]+\)))*\))+(?:\(([^\s()<>]+|(\([^\s()<>]+\)))*\)|[^\s`!()\[\]{};:\'".,<>?«»“”‘’])))@';
	$matches = array();
	if ($num = preg_match_all($regex, $str, $matches)) {
		$matches = array_unique($matches[0]);
		//echo 'matches were ' . draw_array($matches);
		foreach($matches as $m) {
			if (format_text_starts('http://', $m) || format_text_starts('https://', $m)) {
				$str = str_replace($m, draw_link($m, $m), $str);
			} else {
				$str = str_replace($m, draw_link('http://' . $m, $m), $str);
			}
		}
	}
	return $str;
}

function format_html_paragraphs($text, $limit=false) {
	lib_get('simple_html_dom');
	$text = str_get_html($text);
	
	//first, look for facebook share or meta description http://developers.facebook.com/docs/share/
	$blocks = $text->find('meta');
	foreach ($blocks as $b) if (($b->property == 'og:description') || ($b->name == 'description')) return trim($b->content);
		
	//otherwise loop through paragraphs and sentences
	$blocks = $text->find('p');
	error_debug('<b>' . __function__ . '</b> found ' . count($blocks) . ' ps within ' . strlen($text) . ' char text', __file__, __line__);
	$return = '';
	$total_length = 0;
	foreach ($blocks as $b) {
		if (!$b->class) {
			$b = draw_p(strip_tags($b));
			$length = strlen($b);
			if ($limit && $length + $total_length > $limit) {
				if (!$total_length) {
					$sentences = array_separated(strip_tags($b), '.');
					error_debug('<b>' . __function__ . '</b> reached limit in first paragraph, breaking into ' . count($sentences) . ' sentences', __file__, __line__);					
					foreach ($sentences as $s) {
						$length = strlen($s) + 2;
						if ($length + $total_length <= $limit) {
							$return .= $s . '. ';
							$total_length += $length;
						}
					}
					$return = draw_p($return);
				}
				break;
			}
			$return .= $b;
			$total_length += $length;
		}
	}
	return $return;
}

function format_html_text($str) {
	$return = strip_tags($str);
	$return = str_replace('&nbsp;', ' ', $return);
	$return = trim($return);
	if (empty($return)) return false;
	return $return;
}

function format_html_title($text) {
	lib_get('simple_html_dom');
	$text = str_get_html($text);
	
	$return = '';

	//first, look for facebook share title http://developers.facebook.com/docs/share/
	$blocks = $text->find('meta');
	foreach ($blocks as $b) if ($b->property == 'og:title') return trim($b->content);
	
	//otherwise gather all the h1s, since those aren't usually gamed for SEO
	$blocks = $text->find('h1');
	foreach ($blocks as $b) $return .= strip_tags($b->innertext) . ' ';
	
	//otherwise go with the page title
	if (empty($return)) {
		$blocks = $text->find('title');
		foreach ($blocks as $b) $return .= strip_tags($b->innertext);
	}
	
	return trim($return);
}

function format_html_trim($text) {
	global $_josh;
	$text = format_html($text);
	
	lib_get('simple_html_dom');

	//find td, div or body with longest text block
	$html = str_get_html($text);
	$blocks = $html->find('text');
	foreach ($blocks as $b) max_num(strlen(trim($b)));
	
	if (!function_exists('get_parent')) {
		function get_parent($e) {
			$options = array('td', 'div', 'body');
			if (!is_object($e)) die($e);
			return (in_array($e->tag, $options)) ? $e : get_parent($e->parent);
		}
	}

	foreach ($blocks as $b) {
		$len = strlen(trim($b));
		if ($len == max_num()) {
			$e = get_parent($b->parent);
			$text = $e->innertext;
			echo $text;
		}
	}
	
	$html->clear();
	unset($html);
	
	$html = str_get_html($text);

	//get rid of any sub-divs
	$blocks = $html->find('div');
	foreach ($blocks as $b) $b->outertext = '';
	
	//reset html to get rid of artifacts and compress
	$text = trim($html->save());
	$html->clear();
	
	return $text;
}

function format_image($path, $type=false) {
	global $_josh;
	//function to take any image and return JPG encoded binary.  could send to format image resize at that point
	//type should be used if you're sending a temp name (eg file upload)
	//requires the imagemagick convert unix command
	
	if (!$file = file_get($path)) return false;
	
	if (!$type) $type = file_ext($path);
	$target_name = DIRECTORY_WRITE . '/temp-target.jpg';
	
	$imagick = exec('which convert');
	if (empty($imagick)) $imagick = '/usr/local/bin/convert'; //not able to get correct path on my mac now
	
	if (($type == 'jpg') || ($type == 'jpeg')) {
		return $file;
	} elseif (($type == 'gif') || ($type == 'png')) {
		//convert
		$cmd = $imagick . ' ' . realpath($path) . ' ' . DIRECTORY_ROOT . $target_name;
		exec($cmd);
	} elseif ($type == 'pdf') {
		//return a screenshot of the first page
		exec($imagick . ' ' . realpath($path) . '[0] ' . DIRECTORY_ROOT . $target_name);
	} else {
		error_handle('unhandled image convert', __function__ . ' ran into a problem converting ' . $path, __file__, __line__);
		return false;
	}
		
	if ($source = file_get($target_name)) {
		file_delete($target_name);
		return $source;
	} else {
		error_handle('ImageMagick Not Installed', __function__ . ' requires the ' . draw_link('http://www.imagemagick.org/', 'ImageMagick PHP library') . ' to work on the command line.  Please install it and try again.  ', __file__, __line__);
		return false;
	}
}

function format_image_resize($source, $max_width=false, $max_height=false) {
	if (!function_exists('imagecreatefromjpeg')) error_handle('library missing', 'the GD library needs to be installed to run format_image_resize', __file__, __line__);
	if (empty($source)) return null;

	if (!function_exists('resize')) {
		function resize($new_width, $new_height, $source_name, $target_name, $width, $height) {
			//resize an image and save to the $target_name
			$tmp = imagecreatetruecolor($new_width, $new_height);
			if (!$image = imagecreatefromjpeg(DIRECTORY_ROOT . $source_name)) error_handle('could not create image', 'the system could not create an image from ' . $source_name, __file__, __line__);
			imagecopyresampled($tmp, $image, 0, 0, 0, 0, $new_width, $new_height, $width, $height);
			imagejpeg($tmp, DIRECTORY_ROOT . $target_name, 100);
			imagedestroy($tmp);
			imagedestroy($image);
		}

		function crop($new_width, $new_height, $target_name) {
			//crop an image and save to the $target_name
			list($width, $height) = getimagesize(DIRECTORY_ROOT . $target_name);

			//by default, crop from center
			$offsetx = ($width - $new_width) / 2;
			$offsety = ($height - $new_height) / 2;
			if ($offsetx < 0) $offsetx = 0;
			if ($offsety < 0) $offsety = 0;

			//this crops from top-left
			//$offsetx = $offsety = 0; 
			
			$tmp = imagecreatetruecolor($new_width, $new_height);
			if (!$image = @imagecreatefromjpeg(DIRECTORY_ROOT . $target_name)) error_handle('could not create image', 'the system could not create an image from ' . $source_name, __file__, __line__);
			imagecopyresized($tmp, $image, 0, 0, $offsetx, $offsety, $new_width, $new_height, $new_width, $new_height);
			imagejpeg($tmp, DIRECTORY_ROOT . $target_name, 100);
			imagedestroy($tmp);
			imagedestroy($image);
		}
	}

	//save to file, is file-based operation, unfortunately
	$source_name = DIRECTORY_WRITE . '/temp-source.jpg';
	$target_name = DIRECTORY_WRITE . '/temp-target.jpg';
	file_put($source_name, $source);

	//get source image dimensions
	list($width, $height) = getimagesize(DIRECTORY_ROOT . $source_name);
	
	if(!$width || !$height) {
		// image is probably corrupt
		echo draw_page('image corrupt', 'the uploaded image cannot be read, try opening the image in photo editing software, re-saving it, and then try again');
		exit();
	}
	
	//execute differently depending on target parameters	
	if ($max_width && $max_height) {
		//resizing both
		if (($width == $max_width) && ($height == $max_height)) {
			//already exact width and height, skip resizing
			copy(DIRECTORY_ROOT . $source_name, DIRECTORY_ROOT . $target_name);
		} else {
			//this was for the scenario where your target was a long landscape and you got a squarish image.
			//this doesn't work if your target is squarish and you get a long landscape
			//maybe we need a ratio function?  
			//square to long scenario: input 400 x 300 (actual 1.3 ratio), target 400 x 100 (target 4) need to resize width then crop target > actual
			//long to square scenario: input 400 x 100 (actual 4 ratio), target 400 x 300 (target 1.3) need to resize height then crop target < actual
			$target_ratio = $max_width / $max_height;
			$actual_ratio = $width / $height;
			//if ($max_width >= $max_height) {
			if ($target_ratio >= $actual_ratio) {
				//landscape or square.  resize width, then crop height
				$new_height = ($height / $width) * $max_width;
				resize($max_width, $new_height, $source_name, $target_name, $width, $height);
			} else {
				//portrait.  resize height, then crop width
				$new_width = ($width / $height) * $max_height;
				resize($new_width, $max_height, $source_name, $target_name, $width, $height);
			}
			crop($max_width, $max_height, $target_name);						
		}
	} elseif ($max_width) { 
		//only resizing width
		if ($width == $max_width) {
			//already exact width, skip resizing
			copy(DIRECTORY_ROOT . $source_name, DIRECTORY_ROOT . $target_name);
		} else {
			//resize width
			$new_height = ($height / $width) * $max_width;
			resize($max_width, $new_height, $source_name, $target_name, $width, $height);

		}
	} elseif ($max_height) { 
		//only resizing height	
		if ($height == $max_height) {
			//already exact height, skip resizing
			copy(DIRECTORY_ROOT . $source_name, DIRECTORY_ROOT . $target_name);
		} else {
			//resize height
			$new_width = ($width / $height) * $max_height;
			resize($new_width, $max_height, $source_name, $target_name, $width, $height);
		}
	}
	$return = file_get($target_name);
	
	//clean up
	file_delete($source_name);
	file_delete($target_name);
	
	return $return;
}

function format_inches($inches) {
	//for naomi osnos dec 4, 2011
	if ($inches < 12) return $inches . '"';
	$return = round($inches / 12) . '\'';
	if ($inches = $inches % 12) $return .= ' ' . $inches . '"';
	return $return;
}

function format_js_desanitize() {
	error_deprecated(__FUNCTION__ . ' was deprecated on 3/11/2010 because css should be used for rollovers from now on');
	//javascript function for decoding sanitized strings
	return '
	function desanitize(string) {
		return string.replace(/replacedash/g, "-").replace(/replaceslash/g, "/").replace(/replacespace/g, " ").substring(1);
	}
	';
}

function format_js_sanitize($string) {
	error_deprecated(__FUNCTION__ . ' was deprecated on 3/11/2010 because css or draw_navigation should be used for rollovers from now on');
	//return javascript-sanitized key
	//need for rollover script for seedco financial and phoebe murer
	$string = 'a' . $string; //doesn't like variables that start with numbers
	$string = str_replace('-', 'replacedash', $string); //or contain dashes
	$string = str_replace('/', 'replaceslash', $string); //or contain slashes
	$string = str_replace(' ', 'replacespace', $string); //or contain spaces
	return $string;
}

function format_money($value, $dollarsign=true, $comma=true, $error='') {
	$negative = ($value < 0);
	$value = format_num($value, 2, $comma, $error);
	if ($value == $error) return $value;
	if ($dollarsign) {
		if ($negative) {
			$value = '-$' . str_replace('-', '', $value);
		} else {
			$value = '$' . $value;
		}
	}
	return $value;
}

function format_more($string, $link=false, $separator='<p>[more]</p>') {
	if (!$link) return str_replace($separator, '', $string);
	if ($jump = strpos($string, $separator)) return substr($string, 0, $jump) . draw_p(draw_link($link, 'Read more&hellip;'), 'more');
	return $string;
}

function format_null($value) {
	//should this really be named db_null()?
	if (!strlen($value)) return 'NULL'; //don't use empty() here because 0s will be replaced with NULLs
	if (!is_numeric($value)) return '\'' . $value . '\'';
	return $value;
}

function format_num($value, $decimals=false, $comma=true, $error='') {
	//output function
	if (empty($value)) return $error;
	if (!format_verify($value, 'num')) return $error;
	if ($comma) $comma = ',';
	return number_format($value, $decimals, '.', $comma);
}

/* 
this relationship between above and below is confusing! 
format_num is like number_format but with some checking.
format_numeric forces out a number from a string
*/

function format_numeric($value, $integer=false) {
	//takes a string and reduces to just its numeric elements
	$characters = '-0123456789';
	$value = $value . ''; //force it to be a string
	if (!$integer) $characters .= '.';
	$newval = '';
	for ($i = 0; $i < strlen($value); $i++) if (strpos($characters, $value[$i]) !== false) $newval .= $value[$i];
	if (!strlen($newval)) {
		error_debug('<b>format_numeric</b> received ' . $value . ' and is sending back false', __file__, __line__);
		return false;
	} else {
		error_debug('<b>format_numeric</b> received ' . $value . ' and is sending back ' . $newval, __file__, __line__);
		return $newval - 0;
	}
}

function format_percentage($float, $precision=2) {
	return round($float * 100, $precision) . '%';
}

function format_phone($string, $fail=false) { //format a phone number to (123) 456-7890 format
	$number = '';
	for ($i = 0; $i < strlen($string); $i++) if (is_numeric($string[$i])) $number .= $string[$i];
	if ((strlen($number) != 10) || ($number == '9999999999')) {
		if ($fail) return false;
		return $string;
	}
	return '(' . substr($number, 0, 3) . ') ' . substr($number, 3, 3) . '-' . substr($number, 6, 4);
}

function format_pluralize($entity, $count=2) {
	if ($count == 1) return $entity;
	
	$length = strlen($entity);
	if (substr($entity, -1) == 's') {
		//already ends in an s
		return $entity;
	} elseif (substr(strtolower($entity), -6) == ' media') {
		//needs no change
		return $entity;
	} elseif (in_array($entity, array('day'))) {
		//nonstandard behavior
		return $entity . 's';	
	} elseif (substr($entity, -1) == 'y') {
		//ends in an ies
		return substr($entity, 0, ($length - 1)) . 'ies';
	} else {
		//needs just an s
		return $entity . 's';
	}
}

function format_post_bits($fieldnames) {
	//takes a comma-separated list of POST keys (checkboxes) and sets bit values in their places
	global $_POST;
	$fields = array_separated($fieldnames);
	foreach ($fields as $field) $_POST[$field] = (isset($_POST[$field])) ? 1 : 0;
}

function format_post_date($str, $array=false) {
	global $_POST;
	
	if (!$array) $array = $_POST;
	
	$month  = $array[$str . 'Month'];
	$day    = $array[$str . 'Day'];
	$year   = $array[$str . 'Year'];
	
	$hour   = isset($array[$str . 'Hour'])   ? $array[$str . 'Hour']   : 0;
	$minute = isset($array[$str . 'Minute']) ? $array[$str . 'Minute'] : 0;
	$second = isset($array[$str . 'Second']) ? $array[$str . 'Second'] : 0;
	
	if (isset($array[$str . 'AMPM'])) {
		if ($array[$str . 'AMPM'] == 'AM') {
			if ($hour == 12) $hour = 0;
		} else {
			if ($hour != 12) $hour +=12;
		}
	}

	error_debug('<b>format_post_date</b> for ' . $str . ' into mdyhms: ' . $month . ', ' . $day . ', ' . $year . ', ' . $hour . ', ' . $minute . ', ' . $second, __file__, __line__);
	return format_date_sql($month, $day, $year, $hour, $minute, $second);
}

function format_post_float($fieldnames) {
	//takes a comma-separated list of POST keys and replaces them with monetary values or NULLs if they're empty
	global $_POST;
	$fields = array_separated($fieldnames);
	foreach ($fields as $field) {
		$_POST[$field] = format_numeric($_POST[$field]);
		if ($_POST[$field] === false) $_POST[$field] = 'NULL';
	}
}

function format_post_html($fieldnames) {
	//takes a comma-separated list of POST keys and formats the html in them
	global $_POST;
	$fields = array_separated($fieldnames);
	foreach ($fields as $field) {
		$return = format_html($_POST[$field]);
		$_POST[$field] = (empty($return)) ? 'NULL' : '"' . $_POST[$field] . '"';
	}
}

function format_post_nulls($fieldnames) {
	//takes a comma-separated list of POST keys and replaces them with NULLs if they're empty
	global $_POST;
	error_debug('<b>format_post_nulls</b> for ' . $fieldnames, __file__, __line__);
	$fields = array_separated($fieldnames);
	foreach ($fields as $field) {
		if (!isset($_POST[$field]) || !strlen($_POST[$field])) {
			error_debug('<b>format_post_nulls</b> nullifying ' . $field, __file__, __line__);
			$_POST[$field] = 'NULL';
		}
	}
}

function format_post_urls($fieldnames) {
	//takes a comma-separated list of POST keys and formats them as NULLs or urls
	global $_POST;
	error_debug('<b>format_post_urls</b> for ' . $fieldnames, __file__, __line__);
	$fields = array_separated($fieldnames);
	foreach ($fields as $field) $_POST[$field] = format_null(format_url($_POST[$field]));
}

function format_quantity($quantity, $title_case=true) {
	global $_josh;
	if ($quantity == 0) {
		$return = 'no';
	} elseif (($quantity > 0) && ($quantity < 10)) {
		$return = $_josh['numbers'][$quantity];
	} else {
		$return = $quantity;
	}
	if (!$title_case) $return = format_title($return);
	return $return;
}

function format_quantitize($quantity, $entity, $title_case=true) {
	$quantity = format_quantity($quantity) . ' ';
	if ($quantity == 'one ') {
		$return = $quantity . format_singular($entity);
	} else {
		$return = $quantity . format_pluralize($entity);
	}
	if ($title_case) $return = format_title($return);
	return $return;
}

function format_quotes($string, $reverse=false) {
	if ($reverse) {
		$string = trim(str_replace("''", "'", stripslashes($string)));
	} else {
		if (format_verify($string, 'string')) $string = trim(str_replace("'", "''", stripslashes($string)));
	}
	return $string;
}

function format_quotes_remove($string) {
	return str_replace('"', '', str_replace("'", '', $string));
}

function format_random($length=40) {
	$characters = '0123456789abcdefghijklmnopqrstuvwxyzABCDEFGHIJKLMNOPQRSTUVWXYZ';
	$charactersLength = strlen($characters) - 1;
	$return = '';
	for ($i = 0; $i < $length; $i++) {
	    $return .= $characters[rand(0, $charactersLength)];
	}
	return $return;
}

function format_singular($string) {
	if (format_text_ends('ies', $string)) {
		return substr($string, 0, $string-3) . 'y';
	} elseif (format_text_ends('s', $string)) {
		return substr($string, 0, $string-1);
	}
	return $string;
}

function format_size($size) {
	//take bytes and make pretty
	$a = array('B', 'K', 'M', 'G', 'T', 'P');
	$pos = 0;
	while ($size >= 1024) {
		$size /= 1024;
		$pos++;
	}
	return round($size) . $a[$pos];
}

function format_size_bytes($size) {
	//take pretty and make bytes
	$multiplier = 1;
	$size = strtoupper($size);
	if (format_text_ends('P', $size)) {
		$multiplier = pow(1024, 5);
	} elseif (format_text_ends('T', $size)) {
		$multiplier = pow(1024, 4);
	} elseif (format_text_ends('G', $size)) {
		$multiplier = pow(1024, 3);
	} elseif (format_text_ends('M', $size)) {
		$multiplier = pow(1024, 2);
	} elseif (format_text_ends('K', $size)) {
		$multiplier = 1024;
	}
	return format_numeric($size) * $multiplier;
}

function format_ssn($str) {
	$str = str_pad(format_numeric(str_replace('-', '', $str)), 9, '0', STR_PAD_LEFT);
	return substr($str, 0, 3) . '-' . substr($str, 3, 2) . '-' . substr($str, 5, 4);
}

function format_string($string, $target=30, $append='&hellip; ') {
	//shorten a $string to $target length, breaking on the ends of words
	$str_new = html_entity_decode($string, ENT_QUOTES, 'UTF-8');
	$encoded = ($str_new != $string);
	$str_new = str_replace(NEWLINE, ' ', strip_tags(trim($str_new)));
	
	if (!function_exists('mb_strlen')) {
		function mb_strlen($str) {
			return strlen($str);
		}
	}
	
	if (mb_strlen($str_new, 'utf-8') > $target) {
		$words = explode(' ', $str_new);
		$length = 0;
		$return = '';
		foreach ($words as $w) {
			if ($wordlength = mb_strlen($w, 'utf-8')) { //skip empty words
				if ($length == 0) {
					//first word -- add it no matter what.
					$return .= $w;
				} else {
					$wordlength++; //add one for the space
					if ($length + $wordlength > $target) break;
					$return .= ' ' . $w;
				}
				$length += $wordlength;
			}
		}
		if ($encoded) $return = htmlentities($return, ENT_QUOTES, 'UTF-8');
		$return .= $append;
	} else {
		$return = $str_new;
		if ($encoded) $return = htmlentities($return, ENT_QUOTES, 'UTF-8');
	}
	//die('the length is ' . strlen($return));
	return $return;
}

function format_text_code($string) {
	$string = format_accents_remove(strToLower(trim(strip_tags($string))));
	
	//remove special characters
	$string = str_replace('/',	'_',	$string);
	$string = str_replace(' ',	'_',	$string);
	$string = str_replace('&',	'and',	$string);
	$string = str_replace('+',	'and',	$string);
	
	$string = preg_replace("/[^A-Za-z0-9_-]/", '', $string); 
	$string = preg_replace('/\s\s+/', ' ', $string);
	
	return urlencode($string);
}

function format_text_ends($needle, $haystack) {
	$needle_length = strlen($needle);
	if (strToLower(substr($haystack, (0 - $needle_length))) == strToLower($needle)) return substr($haystack, 0, strlen($haystack) - $needle_length);
	return false;
}

function format_text_human($str, $convertdashes=true) {
	$return = str_replace('_', ' ', strToLower($str));
	if ($convertdashes) $return = str_replace('-', ' ', $return);
	return format_title($return);
}

function format_text_starts($needle, $haystack) {
	//function to see if a $haystack starts with $needle
	//returns $haystack without the needle
	$needle_len = strlen($needle);
	if ($needle == $haystack) return true;
	if (strToLower(substr($haystack, 0, $needle_len)) == strToLower($needle)) return substr($haystack, $needle_len);
	return false;
}

function format_thumbnail_pdf($source, $width=false, $height=false) {
	global $_josh;
	
	//returns a JPG thumbnail for supplied PDF content in $source
	//todo make legacy function, deprecate
	
	$source_name = DIRECTORY_WRITE . '/temp-source.pdf';
	$target_name = DIRECTORY_WRITE . '/temp-target.jpg';
	
	file_put($source_name, $source);
	
	if (empty($_josh['path_imagemagick'])) $_josh['path_imagemagick'] = '';
	
	exec($_josh['path_imagemagick'] . 'convert ' . DIRECTORY_ROOT . $source_name . '[0] ' . DIRECTORY_ROOT . $target_name);
		
	if ($source = file_get($target_name)) {
		//operation worked
		if ($width || $height) $source = format_image_resize($source, $width, $height);
	} else {
		//did not work
		error_handle('ImageMagick Not Installed', __function__ . ' requires the ' . draw_link('http://www.imagemagick.org/', 'ImageMagick PHP library') . ' to work on the command line.  Please install it and try again.  On a Mac, consider installing imagemagick and ghostscript via MacPorts.', __file__, __line__);
	}
	
	//clean up
	file_delete($source_name);
	file_delete($target_name);
	return $source;
}

function format_time($timestamp=false, $error='') {
	if ($timestamp === false) {
		$timestamp = time();
	} else {
		if (empty($timestamp) || ($timestamp == 'Jan 1 1900 12:00AM')) return $error;
		if (!is_int($timestamp)) $timestamp = strToTime($timestamp);
	}
	return strftime('%l:%M%p', $timestamp);
}

function format_time_business($start, $end=false) {
	if (!function_exists('isBusinessHours')) {
		function isBusinessHours($udate) {
			$hourOfDay = date('G', $udate);
			return (($hourOfDay > 9) && ($hourOfDay < 17));
		}
	}
	
	if (!function_exists('isWeekDay')) {
		function isWeekDay($udate) {
			$dayOfWeek = date('w', $udate);
			return (($dayOfWeek > 0) && ($dayOfWeek < 6));
		}	
	}

	$start = strToTime($start);
	if (empty($end) || !$end) {
		$end = date('U');
	} else {
		$end = strToTime($end);
	}
	$age = $end - $start;
	
	//days
	if ($age > 86400) {
		$days = 0;
		$finished = $start + 86400;
		for ($i = $finished; $i < $end; $i += 86400) {
			if (isWeekDay($i)) $days++;
			$finished = $i;
		}
		if ($days == 1) {
			$return[] = $days . ' day';
		} elseif ($days > 1) {
			$return[] = $days . ' days';
		}
	} else {
		$finished = $start;
	}

	//hours
	$hours = 0;
	for ($i = $finished + 3600; $i < $end; $i += 3600) {
		if (isBusinessHours($i)) $hours++;
		$finished = $i;
	}
	if ($hours == 1) {
		$return[] = $hours . ' hour';
	} elseif ($hours > 1) {
		$return[] = $hours . ' hours';
	}

	//minutes
	$minutes = round(($age % 3600) / 60);
	if ($minutes == 1) {
		$return[] = $minutes . ' minute';
	} elseif ($minutes > 1) {
		$return[] = $minutes . ' minutes';
	}
	
	if (empty($return)) {
		return '<i>just opened</i>';
	} else {
		return implode(', ', $return);
	}
}

function format_time_elapsed($timestamp) {
	if (!is_int($timestamp)) $timestamp = strtotime($timestamp);
	$elapsed = date("U") - $timestamp;
	
	if ($elapsed > 604800) {
		return format_quantitize(round($elapsed / 604800), 'week') . ' ago';
	} elseif ($elapsed > 86400) {
		return format_quantitize(round($elapsed / 86400), 'day') . ' ago';
	} elseif ($elapsed > 3600) {
		return format_quantitize(round($elapsed / 3600), 'hour') . ' ago';
	} elseif ($elapsed > 60) {
		return format_quantitize(round($elapsed / 60), 'minute') . ' ago';
	} elseif ($elapsed > 0) {
		return 'Just Now';	
	} else { 
		return 'Future';
	}
}

function format_time_exec($start_time=false, $descriptor=' seconds') {
	return round(microtime(true) - TIME_START, 2) . $descriptor;
}

function format_times($num) {
	global $_josh;
	if ($num == 1) {
		return 'once';
	} elseif ($num == 2) {
		return 'twice';
	} elseif ($num < 10) {
		return $_josh['numbers'][$num] . ' times';
	} else {
		return number_format($num) . ' times';
	}
}

function format_title($str, $force_upper=false) {
	//force upper is a comma-separated string of additional uppercased words
	error_debug('<b>format_title</b> starting with ' . $str, __file__, __line__);
	$return = array();
	$lower = array('a', 'an', 'and', 'but', 'for', 'from', 'if', 'in', 'nor', 'of', 'on', 'or', 'so', 'the', 'to', 'via', 'with');
	$mixed = array('DBs', 'iPhone', 'iPhones', 'IDs', 'IPs', 'LLCs', 'MySQL', 'SSNs', 'TinyMCE', 'URLs', 'WordPress');
	$upper = array('ADA', 'API', 'ASAP', 'CMS', 'CSS', 'DB', 'DC', 'FTP', 'HR', 'HTML', 'I', 'IE', 'II', 'III', 'IP', 'IV', 
		'LLC', 'OMG', 'ONYC', 'OS', 'PC', 'PDF', 'PHP', 'RSS', 'SF', 'SFS', 'SQL', 'SSI', 'SSN', 'SVN', 'SWF', 'URL', 'U.S.', 
		'V', 'VI', 'VII', 'VIII', 'WTF', 'X', 'XML');
		
	//seedco 
	$mixed = array_merge($mixed, array('CBOs'));
	$upper = array_merge($upper, array('BIF', 'CCT', 'EBO', 'FSS', 'NHP', 'NVN', 'PLC', 'TANF'));
		
	if ($force_upper) {
		$force_upper = array_separated($force_upper);
		$upper2 = array();
		foreach ($force_upper as $word) $upper2[] = trim(strToUpper($word));
		$upper = array_merge($upper, $upper2);
	}
	
	$words = explode(' ', ucwords(strToLower(trim($str))));
	$counter = 1;
	$max = count($words);
	foreach ($words as $word) {
		if (in_array(strToLower($word), $lower) && ($counter != 1) && ($counter != $max)) {
			$return[] = strToLower($word);
		} elseif (in_array(strToUpper($word), $upper)) {
			$return[] = strToUpper($word);
		} elseif (!empty($word)) {
			$index = array_search(strToLower($word), array_to_lower($mixed));
			if ($index !== false) { //could return 0, which would be valid
				$return[] = $mixed[$index];
			} else {
				$return[] = $word;
			}
		}
		$counter++;
	}
	return implode(' ', $return);
}

function format_url($str='') {
	if (empty($str)) return false;
	if (format_text_starts('http://', $str) || format_text_starts('https://', $str)) return $str;
	return 'http://' . $str;
}

function format_verify($variable, $type='int') {
	error_debug(__function__ . ' running for variable ' . $variable . ' of type ' . $type, __file__, __line__);
	if ($type == 'int') {
		if (!is_numeric($variable)) return false;
		return ((string) $variable) === ((string)(int) $variable);
	} elseif ($type == 'num') {
		if (!is_numeric($variable)) return false;
	} elseif ($type == 'key') {
		if (strlen($variable) > 13) return false;
	} elseif ($type == 'string') {
		if (!is_string($variable)) return false;
	}
	return true;
}

function format_zip($string, $error=false) { //format a ZIP (5-digit)
	$return = '';
	for ($i = 0; $i < strlen($string); $i++) if (is_numeric($string[$i])) $return .= $string[$i];
	if (strlen($return) > 4) return substr($return, 0, 5);
	return $error;
}