html.general.php

<?php

/** function get_header
 *        Generate the HTML header portion of the page
 *
 * @param null $meta
 *
 * @return string HTML header for page
 * @throws MyException
 * @throws MySQLException
 * @option string 'title' the page title
 * @option string 'head_data' any HTML to be inserted in the head tag
 * @option array 'menu_data' the data for the counts in the menu
 * @option array 'game_data' the game data for my game list under the menu
 * @option bool 'show_menu' show the menu
 * @option string 'file_name' becomes the body id with _page appended
 */
function get_header($meta = null) {
	if ( ! defined('GAME_NAME')) {
		define('GAME_NAME', 'Game');
	}

	$title = ( ! empty($meta['title'])) ? GAME_NAME.' :: '.$meta['title'] : GAME_NAME;
	$show_menu = (isset($meta['show_menu'])) ? (bool) $meta['show_menu'] : true;
	$show_nav_links = (isset($meta['show_nav_links'])) ? (bool) $meta['show_nav_links'] : true;
	$menu_data = (isset($meta['menu_data'])) ? $meta['menu_data'] : false;
	$head_data = (isset($meta['head_data'])) ? $meta['head_data'] : '';
	$file_name = (isset($meta['file_name'])) ? $meta['file_name'] : basename($_SERVER['SCRIPT_NAME']);
	$file_name = substr($file_name, 0, strrpos($file_name, '.'));

	// make sure we have these
	$GLOBALS['_&_DEBUG_QUERY'] = ( ! empty($GLOBALS['_&_DEBUG_QUERY'])) ? $GLOBALS['_&_DEBUG_QUERY'] : '';
	$GLOBALS['_?_DEBUG_QUERY'] = ( ! empty($GLOBALS['_?_DEBUG_QUERY'])) ? $GLOBALS['_?_DEBUG_QUERY'] : ((defined('DEBUG') && DEBUG) ? '?' : '');

	$flash = '';
	if (class_exists('Flash')) {
		$flash = Flash::retrieve( );
	}

	if ($show_menu) {
		if ( ! $menu_data) {
			$menu_data = [
				'my_turn' => 0,
				'my_games' => 0,
				'games' => 0,
				'in_vites' => 0,
				'out_vites' => 0,
				'new_msgs' => 0,
				'msgs' => 0,
			];

// TODO: convert the following to something like on pharaoh
			$list = Game::get_list($_SESSION['player_id']);
			$invites = Game::get_invites($_SESSION['player_id']);

			if (is_array($list)) {
				foreach ($list as $game) {
					++$menu_data['games'];

					if ($game['in_game'] && ! in_array($game['state'], ['Finished', 'Draw'])) {
						++$menu_data['my_games'];
					}

					if ($game['my_turn'] && ('Placing' != $game['state'])) {
						++$menu_data['my_turn'];
					}
				}
			}

			if (is_array($invites)) {
				foreach ($invites as $game) {
					if ($game['invite']) {
						++$menu_data['in_vites'];
					}
					else {
						++$menu_data['out_vites'];
					}
				}
			}

			$messages = Message::get_count($_SESSION['player_id']);
			$menu_data['msgs'] = (int) @$messages[0];
			$menu_data['new_msgs'] = (int) @$messages[1];

			$allow_blink = ('index.php' == basename($_SERVER['PHP_SELF']));
		}

		// highlight the important menu values
		foreach ($menu_data as $key => $value) {
			switch ($key) {
				case 'my_turn' :
				case 'new_msgs' :
				case 'in_vites' :
					if (0 < $value) {
						$menu_data[$key] = '<span class="notice">'.$value.'</span>';
					}
					break;

				default :
					// do nothing
					break;
			}
		}

		$game_data = (isset($meta['game_data'])) ? $meta['game_data'] : Game::get_list($_SESSION['player_id'], false);
	}

	// if we are admin logged in as someone else, let us know
	$admin_css = $admin_div = '';
	if (isset($_SESSION['admin_id']) && isset($_SESSION['player_id']) && ($_SESSION['player_id'] != $_SESSION['admin_id'])) {
		$admin_css = '
			<style type="text/css">
				html { border: 5px solid red; }
				#admin_username {
					background: red;
					color: black;
					position: fixed;
					top: 0;
					left: 50%;
					z-index: 99999;
					width: 200px;
					margin-left: -100px;
					text-align: center;
					font-weight: bold;
					font-size: larger;
					padding: 3px;
				}
			</style>';
		$admin_div = '<div id="admin_username">'.$GLOBALS['Player']->username.' [ '.$GLOBALS['Player']->id.' ]</div>';
	}

	$query_strings = 'var debug_query_ = "'.$GLOBALS['_&_DEBUG_QUERY'].'"; var debug_query = "'.$GLOBALS['_?_DEBUG_QUERY'].'";';
	$debug_string = (defined('DEBUG') && DEBUG) ? 'var debug = true;' : 'var debug = false;';

	$nav_links = '';
	if ($show_nav_links && class_exists('Settings') && Settings::test( )) {
		$nav_links = Settings::read('nav_links');
	}

	$GAME_NAME = GAME_NAME;

	$html = <<< EOF
<!DOCTYPE html>
<html lang="en-us">
<head>

	<title>{$title}</title>

	<meta http-equiv="Content-Type" content="text/html; charset=UTF-8" />

	<script type="text/javascript">
		{$debug_string}
		{$query_strings}
	</script>

	<script type="text/javascript" src="scripts/json.js"></script>
	<script type="text/javascript" src="scripts/jquery-1.8.0.min.js"></script>
	<script type="text/javascript" src="scripts/jquery.tablesorter.js"></script>

	<!-- fancybox -->
	<link rel="stylesheet" type="text/css" media="screen" href="scripts/jquery.fancybox/jquery.fancybox-1.3.4.css" />
	<script type="text/javascript" src="scripts/jquery.fancybox/jquery.fancybox-1.3.4.pack.js"></script>
	<script type="text/javascript">
		$(document).ready( function( ) {
			// set fancybox defaults
			$.fn.fancybox.defaults['overlayColor'] = '#000';

			$('a.help').fancybox({
				autoDimensions : false,
				width: 500,
				padding : 10,
				hideOnContentClick : false
			});
		});
	</script>
	<!-- hide the fancybox titles -->
	<style type="text/css">
		#fancy_title { display: none !important; }
	</style>

	<link rel="stylesheet" type="text/css" media="screen" href="css/layout.css" />

	{$head_data}
	{$flash}

	<link rel="stylesheet" type="text/css" media="screen" href="css/c_{$GLOBALS['_DEFAULT_COLOR']}.css" />

	{$admin_css}

</head>

<body id="{$file_name}_page">
	{$admin_div}

	<header>
		<h1><a href="index.php">{$GAME_NAME}</a></h1>
		<nav class="site">{$nav_links}</nav>
	</header>

EOF;

	if ($show_menu) {
		$html .= '
	<aside id="nav">';

		if ($menu_data) {
			$html .= '
		<nav id="menu" class="box">
			<ul>
				<li'.get_active('index').'><a href="index.php'.$GLOBALS['_?_DEBUG_QUERY'].'" title="(Your Turn | Your Games | Total Games)"'.(($allow_blink && $menu_data['my_turn']) ? ' class="blink"' : '').'>Games <span class="sep">(</span> '.$menu_data['my_turn'].' <span class="sep">|</span> '.$menu_data['my_games'].' <span class="sep">|</span> '.$menu_data['games'].' <span class="sep">)</span></a></li>
				<li'.get_active('invite').'><a href="invite.php'.$GLOBALS['_?_DEBUG_QUERY'].'" title="(Received | Sent)"'.(($allow_blink && $menu_data['in_vites']) ? ' class="blink"' : '').'>Invitations <span class="sep">(</span> '.$menu_data['in_vites'].' <span class="sep">|</span> '.$menu_data['out_vites'].' <span class="sep">)</span></a></li>
				<li'.get_active('messages', 'read', 'send').'><a href="messages.php'.$GLOBALS['_?_DEBUG_QUERY'].'" title="(New Messages | Total Messages)"'.(($allow_blink && $menu_data['new_msgs']) ? ' class="blink"' : '').'>Messages <span class="sep">(</span> '.$menu_data['new_msgs'].' <span class="sep">|</span> '.$menu_data['msgs'].' <span class="sep">)</span></a></li>
				<li'.get_active('stats').'><a href="stats.php'.$GLOBALS['_?_DEBUG_QUERY'].'">Statistics</a></li>
				<li'.get_active('prefs').'><a href="prefs.php'.$GLOBALS['_?_DEBUG_QUERY'].'">Preferences</a></li>
				<li'.get_active('profile').'><a href="profile.php'.$GLOBALS['_?_DEBUG_QUERY'].'">Profile</a></li>
				';

				if (true == $GLOBALS['Player']->is_admin) {
					$html .= '<li'.get_active('admin').'><a href="admin.php'.$GLOBALS['_?_DEBUG_QUERY'].'">Admin</a></li>';
				}

			$html .= '
				<li><a href="login.php'.$GLOBALS['_?_DEBUG_QUERY'].'">Logout</a></li>
			</ul>
		</nav><!-- #menu -->';
		}

		if ($game_data) {
			$html .= '
		<div id="mygames_title">My Games</div>
		<nav id="mygames" class="box">
			<ul>';

			foreach ($game_data as $game) {
				$class = ($game['my_turn']) ? 'playing' : ((in_array($game['state'], ['Finished', 'Draw'])) ? 'finished' : 'waiting');
				$html .= '
				<li class="'.$class.'"><a href="game.php?id='.$game['game_id'].$GLOBALS['_&_DEBUG_QUERY'].'">'.htmlentities($game['opponent'], ENT_QUOTES, 'ISO-8859-1', false).'</a></li>';
			}

			$html .= '
			</ul>
		</nav><!-- #mygames -->';
		}

		$html .= '
	</aside><!-- #nav -->';
	}

	return $html;
}

/** function get_footer
 *        Generate the HTML footer portion of the page
 *
 * @param array option meta info
 * @return string HTML footer for page
 * @throws MySQLException
 */
function get_footer($meta = []) {
	$foot_data = isset($meta['foot_data']) ? $meta['foot_data'] : '';

	$players = GamePlayer::get_count( );
	list($cur_games, $total_games) = Game::get_count( );

	$Mysql = Mysql::get_instance( );

	$html = '
	<div id="footerspacer">&nbsp;</div>
	<footer>
		<span>Total Players - '.$players.'</span>
		<span>Active Games - '.$cur_games.'</span>
		<span>Games Played - '.$total_games.'</span>
	</footer>

	'.$foot_data.'

	<!-- Queries = '.$Mysql->query_count.' -->
</body>
</html>';

	return $html;
}


/** function get_item
 *		Generate the HTML content portion of the page
 *
 * @param string contents
 * @param string instructions for page
 * @param string [optional] title for page
 * @return string HTML content for page
 */
function get_item($contents, $hint, $title = '', $extra_html = '') {
	$hint_html = "\n\t\t\t<p><strong>Welcome";
	if ( ! empty($GLOBALS['Player']) && ! empty($_SESSION['player_id'])) {
		$hint_html .= ", {$GLOBALS['Player']->username}";
	}
	$hint_html .= '</strong></p>';

	if (is_array($hint)) {
		foreach ($hint as $line) {
			$hint_html .= "\n\t\t\t<p>{$line}</p>";
		}
	}
	else {
		$hint_html .= "\n\t\t\t<p>{$hint}</p>";
	}

	if ('' != $title) {
		$title = '<h2>'.$title.'</h2>';
	}

	$long_date = (class_exists('Settings') && Settings::test( )) ? Settings::read('long_date') : 'M j, Y g:i a';

	$html = '
		<aside id="info">
			<div id="notes" class="box">
				<div>
					<div id="date">'.date($long_date).'</div>
					'.$hint_html.'
				</div>
			</div>
			'.$extra_html.'
		</aside><!-- #info -->
		<div id="content" class="box">
			<div>
				'.$title.'
				'.$contents.'
			</div>
		</div><!-- #content -->
	';

	return $html;
}


/** function get_active
 *		Returns an active class string based on
 *		our current location
 *
 * @param string link URL to test against
 * @return string HTML active class attribute (or empty string)
 */
function get_active($value) {
	$values = func_get_args( );

	$self = substr(basename($_SERVER['SCRIPT_NAME']), 0, -4);

	foreach ($values as $value) {
		if ($value == $self) {
			return ' class="active"';
		}
	}

	return '';
}


/** function get_piece_image
 *		Returns the img tag for the given piece
 *		NOTE: Quarto specific
 *
 * @param string piece code
 * @return string HTML img tag
 */
function get_piece_image($piece) {
	$pt = [ // pieces text
			['black', 'white'],
			['short', 'tall'],
			['hollow', 'solid'],
			['round', 'square'],
	];

	$p = str_pad(decbin(hexdec($piece)), 4, '0', STR_PAD_LEFT);

	return '<img id="p_'.$piece.'" src="images/'.$pt[0][$p[0]].'-'.$pt[1][$p[1]].'-'.$pt[2][$p[2]].'-'.$pt[3][$p[3]].'.png" alt="'.$pt[0][$p[0]].' '.$pt[1][$p[1]].' '.$pt[2][$p[2]].' '.$pt[3][$p[3]].'" class="piece '.$pt[0][$p[0]].' '.$pt[1][$p[1]].' '.$pt[2][$p[2]].' '.$pt[3][$p[3]].'" />';
}