Layout.php

<?php //#SCOPE_OS_PUBLIC
/*******************************************************************************
#LIC_FULL

@author Troy Hurteau <jthurtea@ncsu.edu>

Utility class for layout handling

*******************************************************************************/

class Saf_Layout {

	const LAYOUT_DEFAULT_HTML_FORMAT = 'html+javascript:css';
	const LAYOUT_BASE_HTML_FORMAT = 'html';
	const LAYOUT_DEFAULT_AJAX_FORMAT = 'json';
	const LAYOUT_DEFAULT_FILE_FORMAT = 'binary';

	protected static $_format = DEFAULT_RESPONSE_FORMAT;
	protected static $_css = array();
	protected static $_js = array();
	protected static $_min = FALSE;

	protected static $_formatMap = array(
		'text/html' => self::LAYOUT_DEFAULT_HTML_FORMAT,
		'application/xhtml+xml' => self::LAYOUT_DEFAULT_HTML_FORMAT,
		'application/xml' => self::LAYOUT_BASE_HTML_FORMAT,
		'image/webp' => self::LAYOUT_DEFAULT_FILE_FORMAT,
		'application/json' => self::LAYOUT_DEFAULT_AJAX_FORMAT,
		'text/javascript' => self::LAYOUT_DEFAULT_AJAX_FORMAT //#TODO #2.0.0 css?
	);

	/**
	 * sets the preferred output format
	 * @param string $format
	 */
	public static function setFormat($format)
	{
		if (array_key_exists($format, self::$_formatMap)) {
			$format = self::$_formatMap[$format];
		}
		self::$_format = $format;
		return self::$_format;
	}

	/**
	 * returns the preferred output format
	 * @return string
	 */
	public static function getFormat()
	{
		return self::$_format;
	}

	public static function formatIsHtml()
	{
		return strpos(self::$_format, 'html') === 0;
	}

	public static function formatIsJson()
	{
		return strpos(self::$_format, 'json') === 0;
	}

	/**
	 * autodetect the preferred output format
	 * @param unknown_type $hint
	 */
	public static function autoFormat($hint = NULL)
	{//#TODO #2.0.0
		$headers = apache_request_headers();
		$isAjax = array_key_exists('X-Requested-With', $headers)
			&& 'xmlhttprequest' == strtolower($headers['X-Requested-With']);
		$accept =
			array_key_exists('Accept', $headers)
			? explode(',', $headers['Accept'])
			: array();
		foreach($accept as $type) {
			$type = explode(';', $type);
			$mimeType = $type[0];
			if ($type != '*/*') {
				return self::setFormat(strtolower(trim($mimeType)));
			}
		}
	}

	/**
	 * ensure relative URLs work regardless of where the application is served from
	 * @param string $url
	 */
	public static function printLink($url)
	{
		print(self::getLink($url));
	}

	/**
	 * ensure relative URLs work regardless of where the application is served from
	 * @param string $url
	 */
	public static function getLink($url)
	{
		$baseUrl = Saf_Registry::get('baseUrl');
		if (strpos($url, '/') === 0) {
			$url = substr($url, 1);
		}
		return ($baseUrl . $url);
	}

	/**
	 * output the tag for an RSS Link
	 * @param string $url
	 */
	public static function printRssLink($url)
	{

	}

	public static function printCss($css, $media = 'screen')
	{
		$baseCssUrl = Saf_Registry::get('baseUrl') . 'css/';
		$css =
			strpos($css, '/') === 0
			? $css
			: "{$baseCssUrl}{$css}.css";

?>
		<link href="<?php print($css); ?>" rel="stylesheet" type="text/css" media="<?php print($media);?>"/>
<?php
	}

	/**
	 * store a css file to render a link to during layout
	 * @param string $css
	 * @param string $media default screen
	 */
	public static function autoCss($css, $media = 'screen')
	{
		if ($media === 'screen') {
			self::$_css[] = $css;
		} else {
			if (array_key_exists($media, self::$_css)) {
				self::$_css[$media][] = $css;
			} else {
				self::$_css[$media] = array($css);
			}
		}
	}

	/**
	 * output any appropriate CSS files
	 */
	public static function printAutoCss()
	{
		foreach(self::$_css as $media => $css) {
			$media = is_array($css) ? $media : 'screen';
			$css = is_array($css) ? $css : array($css);
			foreach($css as $currentCss) {
				self::printCss($currentCss, $media);
			}
		}
	}

	public static function printCoreCss()
	{
		$coreCss = array(
			'reset',
			'jquery/ui/jquery-ui',
			'foundation/5/foundation',
			'fontawesome/font-awesome',
			'saf',
			'main'
		);
		$baseCssUrl = Saf_Registry::get('baseUrl') . 'css/';
		$media = 'screen'; //#TODO 2.0.0
		foreach($coreCss as $css) {
			$css =
				strpos($css, '/') === 0
				? $css
				: "{$baseCssUrl}{$css}.css";
			self::printCss($css,$media);
		}
	}

	public static function printPreloadJs()
	{
?>
<script>

</script>
<?php
	}

	public static function printJs($js)
	{
		$baseJsUrl = Saf_Registry::get('baseUrl') . 'javascript/';
		$js =
			strpos($js, '/') === 0
			? $js
			: "{$baseJsUrl}{$js}.js";
?>
		<script src="<?php print($js); ?>"></script>
<?php
	}

	public static function printCoreJs()
	{
		$baseUrl = Saf_Registry::get('baseUrl') . 'javascript/';
		$coreJs = array(
			'jquery/2/jquery-2.1.4',
			'jquery/ui/jquery-ui',
			'foundation/5/foundation.min',
			'saf',
			'_init'
		);
		foreach($coreJs as $js) {
			if (strpos($js, '/.cdn') !== FALSE) {
				if (file_exists(PUBLIC_PATH . '/javascript/' . $js)) {
					self::printJs(file_get_contents(PUBLIC_PATH . '/javascript/' . $js));
				} else {
?>
<!-- unavailable cdn <?php print($js);?> -->
<?php
				}
			} else if ('_init' != $js) {
				self::printJs($js);
			} else {
?>
<script type="text/javascript">
$(document).ready(function() {
	saf.init({
		baseUrl: '<?php print($baseUrl); ?>'});
});
</script>
<?php
			}
		}
	}

	public static function printPostloadJs()
	{
?>
	<script>

	</script>
<?php
		}

	public static function autoJs($path){
		self::$_js[] = $path;
	}

	/**
	 * output any appropriate JS files
	 */
	public static function printAutoJs()
	{
		foreach(self::$_js as $script) {
?>
<script src="<?php self::printLink("javascript/{$script}.js")?>"></script>
<?php
		}
	}

	/**
	 * output all breadcrumbs
	 */
	public static function printBreadCrumbs()
	{
		$crumbs = Saf_Layout_Location::getCrumbs();
		if(count($crumbs) > 0) {
?>
		<ul class="breadcrumbs">
<?php
			foreach($crumbs as $label=>$info) {
				$url = is_array($info)
					? (
						array_key_exists('url', $info)
						? $info['url']
						: ''
					) : $info;
				$class =
					is_array($info) && array_key_exists('status', $info)
					? " class=\"{$info['status']}\""
					: '';
				if (is_array($info) && Saf_Array::keyExistsAndIsArray('options', $info)) {
					$prefix = Saf_Array::keyExistsAndNotBlank('prefix', $info['options'])
						? $info['options']['prefix']
						:'';
				} else {
					$prefix = '';
				}

				if ('' != $url) {
					$baseUrl = Saf_Registry::get('baseUrl');
						$url = str_replace('[[baseUrl]]', $baseUrl, $url);
?>
		<li<?php print($class);?>><?php print($prefix); ?><a href="<?php print($url); ?>"><?php print($label);?></a></li>
<?php
				} else {
?>
		<li<?php print($class);?>><?php print($prefix . $label);?></li>
<?php
				}
			}
		?>
		</ul>
<?php
		}
	}

	/**
	 * output any buffered messages
	 */
	public static function outputMessages()
	{

	}

	/**
	 * output any buffered messages
	 */
	public static function setMessage()
	{

	}

	public static function debugHeader()
	{
		if(Saf_Debug::isVerbose()) {
			Saf_Debug::printDebugAnchor();
			Saf_Debug::printDebugReveal();
			Saf_Debug::printProfileReveal();
		}
	}

	public static function debugFooter()
	{
		if(Saf_Debug::isEnabled()){
?>
<!-- debug buffer -->
<?php
			Saf_Debug::flushBuffer();
			Saf_Debug::printDebugExit();
		}
		if (Saf_Debug::isVerbose()) {
			Saf_Debug::printDebugEntry();
		}
	}

	/**
	 * output the HTML for an icon
	 * @param string $symbol
	 * @param string $altText
	 */
	public static function printIcon($symbol, $altText='')
	{
		print(self::getIcon($symbol, $altText));
	}

	/**
	 * get the HTML string for an icon
	 * @param string $symbol
	 * @param string $altText
	 */
	public static function getIcon($symbol, $altText='')
	{
		$variant = '';
		if(strpos($symbol,':')){
			$variant = substr($symbol, 0, strpos($symbol,':'));
			$symbol = substr($symbol, strpos($symbol,':') + 1);
		}
		$title = $altText ? ' title="' . htmlentities($altText) . '"' : '';
		return "<span{$title} class=\"fa{$variant} fa-{$symbol}\"></span>";
	}

	public static function isReady()
	{
		return TRUE; //#TODO #2.0.0 return false if not rendering an html view.
	}

	public static function stateCheck($request = array()) //#TODO #2.0.0 decouple from Session
	{
		if(array_key_exists('forceDesktop', $request)) {
			if (Saf_Filter_Truthy::filter($request['forceDesktop'])) {
				$_SESSION['forceDesktopView'] = TRUE;
			} else if (array_key_exists('forceDesktopView', $_SESSION)) {
				unset($_SESSION['forceDesktopView']);
			}
		}
		return array_key_exists('forceDesktopView', $_SESSION);
	}

	public static function jQueryCdn($version = NULL, $uiVersion = NULL) //#TODO move these to Layout_Cdn
	{
		if ($version) {
			print("<script src=\"//ajax.googleapis.com/ajax/libs/jquery/{$version}/jquery.min.js\"></script>");
		}
		if ($uiVersion) {
			print("<link rel=\"stylesheet\" href=\"https://ajax.googleapis.com/ajax/libs/jqueryui/{$uiVersion}/themes/smoothness/jquery-ui.css\">");
			print("<script src=\"https://ajax.googleapis.com/ajax/libs/jqueryui/{$uiVersion}/jquery-ui.min.js\"></script>");
		}
	}

	public static function externalJs($name)
	{
		$baseUrl = Saf_Registry::get('baseUrl');
		print("<script src=\"{$baseUrl}javascript/external/{$name}.js\" type=\"text/javascript\" charset=\"utf\"></script>");
	}

	public static function foundationCss($version, $addons = array())
	{
		$internal = array('magellan','dropdown'); //#TODO #1.11.0 we only need to do this when not using the min version?
		$baseUrl = Saf_Registry::get('baseUrl');
		if ($version) {
			print("<link href=\"{$baseUrl}foundation/css/foundation.min.css\" rel=\"stylesheet\" type=\"text/css\" media=\"screen\"/>");
		}
		foreach($addons as $name) {
			if (!in_array($name, $internal)) {
				print("<link href=\"{$baseUrl}foundation/css/{$name}.min.css\" rel=\"stylesheet\" type=\"text/css\" media=\"screen\"/>");
			}
		}
	}
	public static function foundationJs($version, $addons = array())
	{
		$internal = array(
			'abide',
			'accordion',
			'alert',
			'clearing',
			'dropdown',
			'equalizer',
			'interchange',
			'joyride',
			'magellan',
			'offcanvas',
			'orbit',
			'reveal',
			'slider',
			'tab',
			'tooltip',
			'topbar'
		); //#TODO #1.11.0 we only need to do this when not using the min version?
		$baseUrl = Saf_Registry::get('baseUrl');
		if ($version) {
			if (self::$_min) {
				print("<script src=\"{$baseUrl}foundation/js/foundation.min.js\" type=\"text/javascript\" charset=\"utf\"></script>");
			} else {
				print("<script src=\"{$baseUrl}foundation/js/foundation/foundation.js\" type=\"text/javascript\" charset=\"utf\"></script>");
			}
		}
		foreach($addons as $name) {
			if (in_array($name,$internal)) {
				print("<script src=\"{$baseUrl}foundation/js/foundation/foundation.{$name}.js\" type=\"text/javascript\" charset=\"utf\"></script>");
			} else {
				print("<script src=\"{$baseUrl}foundation/js/{$name}.min.js\" type=\"text/javascript\" charset=\"utf\"></script>");
			}
		}
	}

	public static function useMin()
	{
		self::$_min = TRUE;
	}

	public static function foundationPrerequisites($optional = array())
	{
		if (!is_array($optional)) {
			$optional = array($optional);
		}
		$baseUrl = Saf_Registry::get('baseUrl');
		print("<script src=\"{$baseUrl}foundation/js/vendor/modernizr.js\" type=\"text/javascript\" charset=\"utf\"></script>");
		if (in_array('jquery', $optional)) {
			print("<script src=\"{$baseUrl}foundation/js/vendor/jquery.js\" type=\"text/javascript\" charset=\"utf\"></script>");
		}
	}

	public static function foundationLateIncludes($include = array())
	{
		$baseUrl = Saf_Registry::get('baseUrl');
		if (array_key_exists('fastclick', $include) || in_array('fastclick',$include)) {
			print("<script src=\"{$baseUrl}foundation/js/vendor/fastclick.js\" type=\"text/javascript\" charset=\"utf\"></script>");
		}
		print("<script type=\"text/javascript\">saf.endBody();</script>");
	}

	public static function fontAwesomeCdn($version)
	{
		if (version_compare($version,'5.0.0', '>=')) {
			print("<link rel=\"stylesheet\" href=\"//use.fontawesome.com/releases/v5.7.2/css/all.css\" integrity=\"sha384-fnmOCqbTlWIlj8LyTjo7mOUStjsKC4pOpQbqyi7RrhN7udi9RwhKkMHpvLbHG9Sr\" crossorigin=\"anonymous\"/>");
		} else {
			print("<link rel=\"stylesheet\" href=\"//maxcdn.bootstrapcdn.com/font-awesome/{$version}/css/font-awesome.min.css\"/>");
		}
	}

	
	public static function bootStrapCdn($version)
	{
		print("");
	}

	public static function getCdnResource($url, $altContent)
	{
		try {
			$curl = new Saf_Client_Http(array(
				'url' => $url
			));
			$result = $curl->go();
			if (
				$result 
				&& array_key_exists('status', $result)
				&& $result['status'] > 99
				&& $result['status'] < 300
				&& array_key_exists('raw', $result)
			) {
				return $result['raw'];
			} else {
				Saf_Debug::outData(array('deficient cdn response', $url, $result));
			}
		} catch (Exception $e) {
			Saf_Debug::outData(array('failed to curl cdn resource', $url, $e));
		}
		return $altContent;
	}
}