# Mantis - a php based bugtracking system

# Copyright (C) 2000 - 2002  Kenzaburo Ito - kenito@300baud.org

# Copyright (C) 2002 - 2007  Mantis Team   - mantisbt-dev@lists.sourceforge.net

# Mantis is free software: you can redistribute it and/or modify

# it under the terms of the GNU General Public License as published by

# the Free Software Foundation, either version 2 of the License, or

# (at your option) any later version.

#

# Mantis is distributed in the hope that it will be useful,

# but WITHOUT ANY WARRANTY; without even the implied warranty of

# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the

# GNU General Public License for more details.

#

# You should have received a copy of the GNU General Public License

# along with Mantis.  If not, see <http://www.gnu.org/licenses/>.

	#------------------------------

	#   $Revision: 2643 $

	#     $Author: al $    

	#       $Date: 2009-06-18 19:06:27 -0400 (Thu, 18 Jun 2009) $  

	#------------------------------

	###########################################################################

	# HTML API

	#

	# These functions control the display of each page

	#

	# This is the call order of these functions, should you need to figure out

	#  which to modify or which to leave out.

	#

	#   html_page_top1

	#     html_begin

	#     html_head_begin

	#     html_css

	#     html_content_type

	#     html_rss_link

	#  (html_meta_redirect)

	#     html_title

	#   html_page_top2

	#     html_page_top2a

	#       html_head_end

	#       html_body_begin

	#       html_header

	#       html_top_banner

	#     html_login_info

	#    (print_project_menu_bar)

	#     print_menu

	#

	#  ...Page content here...

	#

	#   html_page_bottom1

	#    (print_menu)

	#     html_page_bottom1a

	#       html_bottom_banner

	#  	 html_footer

	#  	 html_body_end

	#  	 html_end

	#

	###########################################################################

	$t_core_dir = dirname( __FILE__ ).DIRECTORY_SEPARATOR;

	require_once( $t_core_dir . 'current_user_api.php' );

	require_once( $t_core_dir . 'string_api.php' );

	require_once( $t_core_dir . 'bug_api.php' );

	require_once( $t_core_dir . 'project_api.php' );

	require_once( $t_core_dir . 'helper_api.php' );

	require_once( $t_core_dir . 'authentication_api.php' );

	require_once( $t_core_dir . 'user_api.php' );

	require_once( $t_core_dir . 'rss_api.php' );

	require_once( $t_core_dir . 'wiki_api.php' );

	$g_rss_feed_url = null;

	# flag for error handler to skip header menus

	$g_error_send_page_header = true;

	# Projax library disabled by default.  It will be enabled if projax_api.php

	# is included.  But it must be included after html_api.php

	$g_enable_projax = false;

	# --------------------

	# Sets the url for the rss link associated with the current page.

	# null: means no feed (default).

	function html_set_rss_link( $p_rss_feed_url )

	{

		if ( OFF != config_get( 'rss_enabled' ) ) {

			global $g_rss_feed_url;

			$g_rss_feed_url = $p_rss_feed_url;

		}

	}

	# --------------------

	# Prints the link that allows auto-detection of the associated feed.

	function html_rss_link()

	{

		global $g_rss_feed_url;

		if ( $g_rss_feed_url !== null ) {

			echo "<link rel=\"alternate\" type=\"application/rss+xml\" title=\"RSS\" href=\"$g_rss_feed_url\" />";

		}

	}

	# --------------------

	# Print the part of the page that comes before meta redirect tags should

	#  be inserted

	function html_page_top1( $p_page_title = null ) {

		html_begin();

		html_head_begin();

		html_css();

		html_content_type();

		include( config_get( 'meta_include_file' ) );

		html_rss_link();

		echo '<link rel="shortcut icon" href="images/favicon.ico" type="image/x-icon" />';

		html_title( $p_page_title );

		html_head_javascript();

	}

	# --------------------

	# Print the part of the page that comes after meta tags, but before the

	#  actual page content

	function html_page_top2() {

		html_page_top2a();

		if ( !db_is_connected() ) {

			return;

		}

	}

	# --------------------

	# Print the part of the page that comes after meta tags and before the

	#  actual page content, but without login info or menus.  This is used

	#  directly during the login process and other times when the user may

	#  not be authenticated

	function html_page_top2a() {

		global $g_error_send_page_header;

		html_head_end();

		html_body_begin();

		$g_error_send_page_header = false;

		html_header();

		html_top_banner();

	}

	# --------------------

	# Print the part of the page that comes below the page content

	# $p_file should always be the __FILE__ variable. This is passed to show source

	function html_page_bottom1( $p_file = null ) {

		if ( !db_is_connected() ) {

			return;

		}

		html_page_bottom1a( $p_file );

	}

	# --------------------

	# Print the part of the page that comes below the page content but leave off

	#  the menu.  This is used during the login process and other times when the

	#  user may not be authenticated.

	function html_page_bottom1a( $p_file = null ) {

		if ( null === $p_file ) {

			$p_file = basename( $_SERVER['PHP_SELF'] );

		}

		html_bottom_banner();

		html_footer( $p_file );

		html_body_end();

		html_end();

	}

	# --------------------

	# (1) Print the document type and the opening <html> tag

	function html_begin() {

		# @@@ NOTE make this a configurable global.

		#echo '', "\n";

		#echo '', "\n";

		echo '', "\n";

		echo '<html>', "\n";

	}

	# --------------------

	# (2) Begin the <head> section

	function html_head_begin() {

		echo '<head>', "\n";

	}

	# --------------------

	# (3) Print the content-type

	function html_content_type() {

		echo "\t", '<meta http-equiv="Content-type" content="text/html;charset=', lang_get( 'charset' ), '" />', "\n";

	}

	# --------------------

	# (4) Print the window title

	function html_title( $p_page_title = null ) {

		$t_title = config_get( 'window_title' );

		echo "\t", '<title>';

		if ( 0 == strlen( $p_page_title ) ) {

			echo string_display( $t_title );

		} else {

			if ( 0 == strlen( $t_title ) ) {

				echo $p_page_title;

			} else {

				echo $p_page_title . ' - ' . string_display( $t_title );

			}

		}

		echo '</title>', "\n";

	}

	# --------------------

	# (5) Print the link to include the css file

	function html_css() {

		$t_css_url = config_get( 'css_include_file' );

		echo "\t", '<link rel="stylesheet" type="text/css" href="', $t_css_url, '" />', "\n";

		# fix for NS 4.x css

		echo "\t", '<script type="text/javascript" language="JavaScript">

		echo "\t\t", 'if(document.layers) {document.write("<style>td{padding:0px;}<\/style>")}', "\n";

		echo "\t", '// --></script>', "\n";

	}

	# --------------------

	# (6) Print an HTML meta tag to redirect to another page

	# This function is optional and may be called by pages that need a redirect.

	# $p_time is the number of seconds to wait before redirecting.

	# If we have handled any errors on this page and the 'stop_on_errors' config

	#  option is turned on, return false and don't redirect.

	function html_meta_redirect( $p_url, $p_time = null, $p_sanitize = false ) {

		if ( ON == config_get( 'stop_on_errors' ) && error_handled() ) {

			return false;

		}

		if ( null === $p_time ) {

			$p_time = current_user_get_pref( 'redirect_delay' );

		}

		if ( $p_sanitize ) {

			$t_url = string_sanitize_url( $p_url );

		} else {

			$t_url = $p_url;

		}

		echo "\t<meta http-equiv=\"Refresh\" content=\"$p_time;URL=$t_url\" />\n";

		return true;

	}

	# ---------------------

	# (6a) Javascript...

	function html_head_javascript() {

		if ( ON == config_get( 'use_javascript' ) ) {

			echo "\t" . '<script type="text/javascript" language="JavaScript" src="javascript/common.js">';

			echo '</script>' . "\n";

			echo "\t" . '<script type="text/JavaScript" src="javascript/ajax.js">';

			echo '</script>' . "\n";

			global $g_enable_projax;

			if ( $g_enable_projax ) {

				echo '<script type="text/javascript" src="javascript/projax/prototype.js"></script>';

				echo '<script type="text/javascript" src="javascript/projax/scriptaculous.js"></script>';

			}

		}

	}

	# --------------------

	# (7) End the <head> section

	function html_head_end() {

		echo '</head>', "\n";

	}

	# --------------------

	# (8) Begin the <body> section

	function html_body_begin() {

		echo '<body>', "\n";

	}

	# --------------------

	# (9) Print the title displayed at the top of the page

	function html_header() {

		#$t_title = config_get( 'page_title' );

		#echo '
', string_display( $t_title ), '
', "\n";

	}

	# --------------------

	# (10) Print a user-defined banner at the top of the page if there is one.

	function html_top_banner() {

		$t_page = config_get( 'top_include_page' );

		if ( !is_blank( $t_page ) && file_exists( $t_page ) && !is_dir( $t_page ) ) {

			PRINT '
';

			include( $t_page );

			if ( auth_is_user_authenticated() ) {

				html_login_info();

				if( ON == config_get( 'show_project_menu_bar' ) ) {

					print_project_menu_bar();

				}

			}

			PRINT '
';

			print_menu();

			PRINT '';

			print '
';

			if ( auth_is_user_authenticated() ) {

			print '
';

			print_recently_visited();

			print '';

			print_projectinfo();	

			PRINT '
';

			}

		} else {

			if ( is_page_name( 'login_page' ) ) {

				$t_align = 'center';

			} else {

				$t_align = 'left';

			}

			echo '
';

			echo '';

			echo '';

		}

	}

	# --------------------

	# (11) Print the user's account information

	function html_login_info() {

		$t_now		= date( config_get( 'complete_date_format' ) );

		$t_username	= current_user_get_field( 'username' );

		$t_access_level	= get_enum_element( 'access_levels', current_user_get_access_level() );

		$t_realname 	= current_user_get_field( 'realname' );

		print '
';

			print '
';

			print '
';

				print $t_now;

			print '';

			print '';

			print '
';

			print '
';

				if ( current_user_is_anonymous() ) {

					$t_return_page = $_SERVER['PHP_SELF'];

					if ( isset( $_SERVER['QUERY_STRING'] ) ) {

						$t_return_page .=  '?' . $_SERVER['QUERY_STRING'];

					}

					$t_return_page = string_url(  $t_return_page );

					PRINT lang_get( 'anonymous' ) . ' | ' . lang_get( 'login_link' ) . '';

					if ( config_get( 'allow_signup' ) == ON ) {

						PRINT ' | ' . lang_get( 'signup_link' ) . '';

					}

				} else {

					echo lang_get( 'logged_in_as' ), ": ", string_display( $t_username ), "";

					echo is_blank( $t_realname ) ? "($t_access_level)" : "(" . string_display( $t_realname ) . " - $t_access_level)";

					echo "";

				}

			PRINT '';

			PRINT '
';

				# Logout (no if anonymously logged in)

				if ( !current_user_is_anonymous() ) {

					echo '' . lang_get( 'logout_link' ) . '';

				}

			PRINT '';

		PRINT '';

		print '';

	}

	# --------------------

	# (12) Print a user-defined banner at the bottom of the page if there is one.

	function html_bottom_banner() {

		$t_page = config_get( 'bottom_include_page' );

		if ( !is_blank( $t_page ) && file_exists( $t_page ) && !is_dir( $t_page ) ) {

			include( $t_page );

		}

	}

	# --------------------

	# (13) Print the page footer information

	function html_footer( $p_file ) {

		global $g_timer, $g_queries_array, $g_request_time;

		# If a user is logged in, update their last visit time.

		# We do this at the end of the page so that:

		#  1) we can display the user's last visit time on a page before updating it

		#  2) we don't invalidate the user cache immediately after fetching it

		#  3) don't do this on the password verification or update page, as it causes the

		#    verification comparison to fail

		if ( auth_is_user_authenticated() && !( is_page_name( 'verify.php' ) || is_page_name( 'account_update.php' ) ) ) {

			$t_user_id = auth_get_current_user_id();

			user_update_last_visit( $t_user_id );

		}

		print ''; # close page div. Opened at html_top_banner.

		print '
';

		if ( config_get( 'show_footer_menu' ) ) {

			print_menu();

		}

		PRINT '
';

		# print powered by Mantis button.

		echo '
';

		print '
';

		# print Mantis version

		if ( ON == config_get( 'show_version' ) ) {

			echo "\t", 'Mantis ', MANTIS_VERSION, '', '[^]
', "\n";

		}

		# only display webmaster email is current user is not the anonymous user

		if ( ! is_page_name( 'login_page.php' ) && !current_user_is_anonymous() ) {

			echo "\t", '', config_get( 'webmaster_email' ), '
', "\n";

		}

		# print timings

		if ( ON == config_get( 'show_timer' ) ) {

			$g_timer->print_times();

		}

		# print db queries that were run

		if ( helper_show_queries() ) {

			$t_count = count( $g_queries_array );

			echo "\t",  $t_count, ' total queries executed. 
 ', "\n";

			$t_unique_queries = 0;

			$t_shown_queries = array();

			for ( $i = 0; $i < $t_count; $i++ ) {

				if ( ! in_array( $g_queries_array[$i][0], $t_shown_queries ) ) {

					$t_unique_queries++;

					$g_queries_array[$i][3] = false;

					array_push( $t_shown_queries, $g_queries_array[$i][0] );

				} else {

					$g_queries_array[$i][3] = true;

				}

			}

			echo "\t",  $t_unique_queries . ' unique queries executed.', "\n";

			if ( ON == config_get( 'show_queries_list' ) ) {

				echo "\t",  '', "\n";

				$t_total = 0;

				for ( $i = 0; $i < $t_count; $i++ ) {

					$t_time = $g_queries_array[$i][1];

					$t_caller = $g_queries_array[$i][2];

					$t_total += $t_time;

					$t_style_tag = '';

					if ( true == $g_queries_array[$i][3] ) {

						$t_style_tag = ' style="color: red;"';

					}

					echo "\t",  '<td', $t_style_tag, '>', ($i+1), '';

					echo '<td', $t_style_tag, '>', $t_time , '';

					echo '<td', $t_style_tag, '>', $t_caller, '
', string_html_specialchars($g_queries_array[$i][0]), '', "\n";

				}

				# @@@ Note sure if we should localize them given that they are debug info.  Will add if requested by users.

				echo "\t", '', $t_total, 'SQL Queries Total Time', "\n";

				echo "\t", '', round( microtime_float() - $g_request_time, 4 ), 'Page Request Total Time', "\n";

				echo "\t",  '', "\n";

			}

		}

		echo '
';

		echo '';

		PRINT '
';

		print '';

		print '';

	}

	# --------------------

	# (14) End the <body> section

	function html_body_end() {

		echo '</body>', "\n";

	}

	# --------------------

	# (15) Print the closing <html> tag

	function html_end() {

		echo '</html>', "\n";

	}

	###########################################################################

	# HTML Menu API

	###########################################################################

	function prepare_custom_menu_options( $p_config ) {

		$t_custom_menu_options = config_get( $p_config );

		$t_options = array();

		foreach( $t_custom_menu_options as $t_custom_option ) {

			$t_access_level = $t_custom_option[1];

			if ( access_has_project_level( $t_access_level ) ) {

				$t_caption = lang_get_defaulted( $t_custom_option[0] );

				$t_link = $t_custom_option[2];

				$t_options[] = "$t_caption";

			}

		}

		return $t_options;

	}

	# --------------------

	# Print the main menu

	function print_menu() {

		if ( auth_is_user_authenticated() ) {

			$t_protected = current_user_get_field( 'protected' );

			$t_current_project = helper_get_current_project();

			PRINT '
';

				$t_menu_options = array();

				# Main Page

				$t_menu_options[] = '
' . lang_get( 'main_link' ) . '
';

				# My View

				$t_menu_options[] = '
' . lang_get( 'my_view_link' ) . '
';

				# View Bugs

				$t_menu_options[] = '
' . lang_get( 'view_bugs_link' ) . '
';

				# Report Bugs

				if ( access_has_project_level( config_get( 'report_bug_threshold' ) ) ) {

					$t_menu_options[] = '
' . string_get_bug_report_link() . '
';

				}

				# Changelog Page

				if ( access_has_project_level( config_get( 'view_changelog_threshold' ) ) ) {

					$t_menu_options[] = '
' . lang_get( 'changelog_link' ) . '
';

				}

				# Roadmap Page

				if ( access_has_project_level( config_get( 'roadmap_view_threshold' ) ) ) {

					$t_menu_options[] = '
' . lang_get( 'roadmap_link' ) . '
';

				}

				# Summary Page

				if ( access_has_project_level( config_get( 'view_summary_threshold' ) ) ) {

					$t_menu_options[] = '
' . lang_get( 'summary_link' ) . '
';

				}

				# Project Documentation Page

				if( ON == config_get( 'enable_project_documentation' ) ) {

					$t_menu_options[] = '
' . lang_get( 'docs_link' ) . '
';

				}

				# Project Wiki

				if ( wiki_is_enabled() ) {

					$t_menu_options[] = '
' . lang_get( 'wiki' ) . '
';

				}

				# Manage Users (admins) or Manage Project (managers) or Manage Custom Fields

				$t_show_access = min( config_get( 'manage_user_threshold' ), config_get( 'manage_project_threshold' ), config_get( 'manage_custom_fields_threshold' ) );

				if ( access_has_global_level( $t_show_access) || access_has_any_project( $t_show_access ) )  {

					$t_current_project = helper_get_current_project();

					if ( access_has_global_level( config_get( 'manage_user_threshold' ) ) ) {

						$t_link = 'manage_user_page.php';

					} else {

						if ( access_has_project_level( config_get( 'manage_project_threshold' ), $t_current_project )

								&& ( $t_current_project <> ALL_PROJECTS ) ) {

							$t_link = 'manage_proj_edit_page.php?project_id=' . $t_current_project;

						} else {

							$t_link = 'manage_proj_page.php';

						}

					}

					$t_menu_options[] = "
" . lang_get( 'manage_link' ) . '
';

				}

				# News Page

				if ( access_has_project_level( config_get( 'manage_news_threshold' ) ) ) {

					# Admin can edit news for All Projects (site-wide)

					if ( ( ALL_PROJECTS != helper_get_current_project() ) || ( access_has_project_level( ADMINISTRATOR ) ) ) {

						$t_menu_options[] = '
' . lang_get( 'edit_news_link' ) . '
';

					} else {

						$t_menu_options[] = '
' . lang_get( 'edit_news_link' ) . '
';

					}

				}

				# Account Page (only show accounts that are NOT protected)

				if ( OFF == $t_protected ) {

					$t_menu_options[] = '
' . lang_get( 'account_link' ) . '
';

				}

				# Add custom options

				$t_custom_options = prepare_custom_menu_options( 'main_menu_custom_options' );

				$t_menu_options = array_merge( $t_menu_options, $t_custom_options );

				if ( config_get('time_tracking_enabled') && config_get('time_tracking_with_billing') )

					$t_menu_options[] = '
' . lang_get( 'time_tracking_billing_link' ) . '
';

				PRINT implode( $t_menu_options );

			PRINT '';

		}

	}

	# --------------------

	# Print the project switcher and issues jumper if user is authenticated

	function print_projectinfo() {

		if ( auth_is_user_authenticated() ) {

		print '
';

		print '
';

			PRINT '
';

				PRINT '<form method="post" name="form_set_project" action="set_project.php">';

				echo lang_get( 'email_project' ), ': ';

				if ( ON == config_get( 'show_extended_project_browser' ) ) {

					PRINT_extended_project_browser( helper_get_current_project_trace() );

				} else {

					if ( ON == config_get( 'use_javascript' ) ) {

						PRINT '<select name="project_id" class="small" onchange="document.forms.form_set_project.submit();">';

					} else {

						PRINT '<select name="project_id" class="small">';

					}

					PRINT_project_option_list( join( ';', helper_get_current_project_trace() ), true, null, true );

					PRINT '</select> ';

				}

				PRINT '<input type="submit" class="button-small" value="' . lang_get( 'switch' ) . '" />';

				if ( OFF != config_get( 'rss_enabled' ) ) {

					# Link to RSS issues feed for the selected project, including authentication details.

					PRINT '';

					PRINT '';

					PRINT '';

				}

				PRINT '</form>';

			PRINT '';

			PRINT '
';

				PRINT '<form method="post" action="jump_to_bug.php">';

				if ( ON == config_get( 'use_javascript' ) ) {

					$t_bug_label = lang_get( 'issue_id' );

					PRINT "<input type=\"text\" name=\"bug_id\" size=\"10\" class=\"small\" value=\"$t_bug_label\" onfocus=\"if (this.value == '$t_bug_label') this.value = ''\" onblur=\"if (this.value == '') this.value = '$t_bug_label'\" /> ";

				} else {

					PRINT "<input type=\"text\" name=\"bug_id\" size=\"10\" class=\"small\" /> ";

				}

				PRINT '<input type="submit" class="button-small" value="' . lang_get( 'jump' ) . '" /> ';

				PRINT '</form>';

			PRINT '';

		print '';

		print '';

		}

		}

	# --------------------

	# Print the menu bar with a list of projects to which the user has access

	function print_project_menu_bar() {

		$t_project_ids = current_user_get_accessible_projects();

		PRINT '';

		PRINT '';

			PRINT '';

			PRINT '' . lang_get( 'all_projects' ) . '';

			foreach ( $t_project_ids as $t_id ) {

				PRINT " | " . string_display( project_get_field( $t_id, 'name' ) ) . '';

				print_subproject_menu_bar( $t_id, $t_id . ';' );

			}

			PRINT '';

		PRINT '';

		PRINT '';

	}

	# --------------------

	# Print the menu bar with a list of projects to which the user has access

	function print_subproject_menu_bar( $p_project_id, $p_parents = '' ) {

		$t_subprojects = current_user_get_accessible_subprojects( $p_project_id );

		$t_char = ':';

		foreach ( $t_subprojects as $t_subproject ) {

			PRINT "$t_char " . string_display( project_get_field( $t_subproject, 'name' ) ) . '';

			print_subproject_menu_bar( $t_subproject, $p_parents . $t_subproject . ';' );

			$t_char = ',';

		}

	}

	# --------------------

	# Print the menu for the graph summary section

	function print_menu_graph() {

		if ( config_get( 'use_jpgraph' ) ) {

			$t_icon_path = config_get( 'icon_path' );