# 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) $  

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

	### Helper API ###

	# These are miscellaneous functions

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

	# alternate color function

	#  If no index is given, continue alternating based on the last index given

	function helper_alternate_colors( $p_index, $p_odd_color, $p_even_color ) {

		static $t_index = 1;

		if ( null !== $p_index ) {

			$t_index = $p_index;

		}

		if ( 1 == $t_index++ % 2 ) {

			return $p_odd_color;

		} else {

			return $p_even_color;

		}

	}

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

	# alternate classes for table rows

	#  If no index is given, continue alternating based on the last index given

	function helper_alternate_class( $p_index=null, $p_odd_class="row-1", $p_even_class="row-2" ) {

		static $t_index = 1;

		if ( null !== $p_index ) {

			$t_index = $p_index;

		}

		if ( 1 == $t_index++ % 2 ) {

			return "class=\"$p_odd_class\"";

		} else {

			return "class=\"$p_even_class\"";

		}

	}

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

	# get the color string for the given status

	function get_status_color( $p_status ) {

		$t_status_enum_string	= config_get( 'status_enum_string' );

		$t_status_colors		= config_get( 'status_colors' );

		# This code creates the appropriate variable name

		# then references that color variable

		# You could replace this with a bunch of if... then... else

		# statements

		$t_color_str	= 'closed';

		$t_color = '#ffffff';

		$t_arr			= explode_enum_string( $t_status_enum_string );

		$t_arr_count	= count( $t_arr );

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

			$elem_arr = explode_enum_arr( $t_arr[$i] );

			if ( $elem_arr[0] == $p_status ) {

				# now get the appropriate translation

				$t_color_str = $elem_arr[1];

				break;

			}

		}

        if ( isset ( $t_status_colors[$t_color_str] ) ) {

			$t_color = $t_status_colors[$t_color_str];

		}

		return $t_color;

	}

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

	# Given a enum string and num, return the appropriate string

	function get_enum_element( $p_enum_name, $p_val ) {

		$config_var = config_get( $p_enum_name.'_enum_string' );

		$string_var = lang_get(  $p_enum_name.'_enum_string' );

		# use the global enum string to search

		$t_arr			= explode_enum_string( $config_var );

		$t_arr_count	= count( $t_arr );

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

			$elem_arr = explode_enum_arr( $t_arr[$i] );

			if ( $elem_arr[0] == $p_val ) {

				# now get the appropriate translation

				return get_enum_to_string( $string_var, $p_val );

			}

		}

		return '@' . $p_val . '@';

	}

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

	# If $p_var is not an array and is equal to $p_val then we PRINT SELECTED.

	# If $p_var is an array, then if any member is equal to $p_val we PRINT SELECTED.

	# This is used when we want to know if a variable indicated a certain

	# option element is selected

	#

	# If the second parameter is not given, the first parameter is compared

	#  to the boolean value true

	function check_selected( $p_var, $p_val=true ) {

		if ( is_array( $p_var ) ) {

			foreach( $p_var as $t_this_var ) {

				# catch the case where one entry is 0 and the other is a string.

				if ( ( is_string( $t_this_var ) && !is_string( $p_val ) ) ) {

					if ( $t_this_var === $p_val ) {

						PRINT ' selected="selected" ';

						return ;

					}

				} else if ( $t_this_var == $p_val ) {

					PRINT ' selected="selected" ';

					return ; 

				}

			}

		} else {

		if ( is_string( $p_var ) && is_string( $p_val ) ) {

			if ( $p_var === $p_val ) {

				PRINT ' selected="selected" ';

				return ; 

			}

		} else if ( $p_var == $p_val ) {

			PRINT ' selected="selected" ';

			return ; 

			}

		}

	}

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

	# If $p_var and $p_val are equal to each other then we PRINT CHECKED

	# This is used when we want to know if a variable indicated a certain

	# element is checked

	#

	# If the second parameter is not given, the first parameter is compared

	#  to the boolean value true

	function check_checked( $p_var, $p_val=true ) {

		if ( $p_var == $p_val ) {

			PRINT ' checked="checked" ';

		}

	}

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

	# Set up PHP for a long process execution

	# The script timeout is set based on the value of the

	#  long_process_timeout config option.

	# $p_ignore_abort specified whether to ignore user aborts by hitting

	#  the Stop button (the default is not to ignore user aborts)

	function helper_begin_long_process( $p_ignore_abort=false ) {

		$t_timeout = config_get( 'long_process_timeout' );

		# silent errors or warnings reported when safe_mode is ON.

		@set_time_limit( $t_timeout );

		ignore_user_abort( $p_ignore_abort );

		return $t_timeout;

	}

    # this allows pages to override the current project settings.

    #  This typically applies to the view bug pages where the "current"

    #  project as used by the filters, etc, does not match the bug being viewed.

    $g_project_override = null;

    $g_cache_current_project = null;

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

	# Return the current project id as stored in a cookie

	#  If no cookie exists, the user's default project is returned

	function helper_get_current_project() {

        global $g_project_override, $g_cache_current_project;

        if ( $g_project_override !== null ) {

            return $g_project_override;

        }

        if( $g_cache_current_project === null) {

			$t_cookie_name = config_get( 'project_cookie' );

			$t_project_id = gpc_get_cookie( $t_cookie_name, null );

			if ( null === $t_project_id ) {

				$t_pref_row = user_pref_cache_row( auth_get_current_user_id(), ALL_PROJECTS, false );

				if ( false === $t_pref_row ) {

					$t_project_id = ALL_PROJECTS;

				} else {

					$t_project_id = $t_pref_row['default_project'];

				}

			} else {

				$t_project_id = split( ';', $t_project_id );

				$t_project_id = $t_project_id[ count( $t_project_id ) - 1 ];

			}

			if ( !project_exists( $t_project_id ) ||

				 ( 0 == project_get_field( $t_project_id, 'enabled' ) ) ||

				 !access_has_project_level( VIEWER, $t_project_id ) ) {

				$t_project_id = ALL_PROJECTS;

			}

			$g_cache_current_project = (int)$t_project_id;

		}

		return $g_cache_current_project;

	}

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

	# Return the current project id as stored in a cookie, in an Array

	#  If no cookie exists, the user's default project is returned

	#  If the current project is a subproject, the return value will include

	#   any parent projects

	function helper_get_current_project_trace() {

		$t_cookie_name = config_get( 'project_cookie' );

		$t_project_id = gpc_get_cookie( $t_cookie_name, null );

		if ( null === $t_project_id ) {

			$t_bottom     = current_user_get_pref( 'default_project' );

			$t_project_id = Array( $t_bottom );

		} else {

			$t_project_id = split( ';', $t_project_id );

			$t_bottom     = $t_project_id[ count( $t_project_id ) - 1 ];

		}

		if ( !project_exists( $t_bottom ) ||

			 ( 0 == project_get_field( $t_bottom, 'enabled' ) ) ||

			 !access_has_project_level( VIEWER, $t_bottom ) ) {

			$t_project_id = Array( ALL_PROJECTS );

		}

		return $t_project_id;

	}

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

	# Set the current project id (stored in a cookie)

	function helper_set_current_project( $p_project_id ) {

		$t_project_cookie_name	= config_get( 'project_cookie' );

		gpc_set_cookie( $t_project_cookie_name, $p_project_id, true );

		return true;

	}

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

	# Clear all known user preference cookies

	function helper_clear_pref_cookies() {

		gpc_clear_cookie( config_get( 'project_cookie' ) );

		gpc_clear_cookie( config_get( 'manage_cookie' ) );

	}

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

	# Check whether the user has confirmed this action.

	#

	# If the user has not confirmed the action, generate a page which asks

	#  the user to confirm and then submits a form back to the current page

	#  with all the GET and POST data and an additional field called _confirmed

	#  to indicate that confirmation has been done.

	function helper_ensure_confirmed( $p_message, $p_button_label ) {

		if (true == gpc_get_bool( '_confirmed' ) ) {

			return true;

		}

		html_page_top1();

		html_page_top2();

		# @@@ we need to improve this formatting.  I'd like the text to only

		#  be about 50% the width of the screen so that it doesn't become to hard

		#  to read.

		PRINT '
';

		PRINT '
' . $p_message . '
';

		PRINT '<form method="post" action="' . $_SERVER[ 'PHP_SELF' ] . "\">\n";

		print_hidden_inputs( gpc_strip_slashes( $_POST ) );

		print_hidden_inputs( gpc_strip_slashes( $_GET ) );

		PRINT "<input type=\"hidden\" name=\"_confirmed\" value=\"1\" />\n";

		PRINT '<input type="submit" class="button" value="' . $p_button_label . '" />';

		PRINT "\n</form>\n";

		PRINT "\n";

		html_page_bottom1();

		exit;

	}

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

	# Call custom function.

	#

	# $p_function - Name of function to call (eg: do_stuff).  The function will call custom_function_override_do_stuff()

	#		if found, otherwise, will call custom_function_default_do_stuff().

	# $p_args_array - Parameters to function as an array

	function helper_call_custom_function( $p_function, $p_args_array ) {

		$t_function = 'custom_function_override_' . $p_function;

		if ( !function_exists( $t_function ) ) {

			$t_function = 'custom_function_default_' . $p_function;

		}

		return call_user_func_array( $t_function, $p_args_array );

	}

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

	function helper_project_specific_where( $p_project_id, $p_user_id = null ) {

		if ( null === $p_user_id ) {

			$p_user_id = auth_get_current_user_id();

		}

		if ( ALL_PROJECTS == $p_project_id ) {

			$t_topprojects = $t_project_ids = user_get_accessible_projects( $p_user_id );

			foreach ( $t_topprojects as $t_project ) {

				$t_project_ids = array_merge( $t_project_ids, user_get_all_accessible_subprojects( $p_user_id, $t_project ) );

			}

			$t_project_ids = array_unique( $t_project_ids );

		} else {

			access_ensure_project_level( VIEWER, $p_project_id );

			$t_project_ids = user_get_all_accessible_subprojects( $p_user_id, $p_project_id );

			array_unshift( $t_project_ids, $p_project_id );

		}

		$t_project_ids = array_map( 'db_prepare_int', $t_project_ids );

		if ( 0 == count( $t_project_ids ) ) {

			$t_project_filter = ' 1<>1';

		} elseif ( 1 == count( $t_project_ids ) ) {

			$t_project_filter = ' project_id=' . $t_project_ids[0];

		} else {

			$t_project_filter = ' project_id IN (' . join( ',', $t_project_ids ) . ')';

		}

		return $t_project_filter;

	}

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

	function helper_get_columns_to_view( $p_columns_target = COLUMNS_TARGET_VIEW_PAGE ) {

		$t_columns = helper_call_custom_function( 'get_columns_to_view', array( $p_columns_target ) );

		$t_enable_sponsorship = config_get( 'enable_sponsorship' );

		if ( OFF == $t_enable_sponsorship ) {

			$t_keys = array_keys( $t_columns, 'sponsorship_total' );

			foreach ( $t_keys as $t_key ) {

				unset( $t_columns[$t_key] );

			}

		}

		$t_show_attachments = config_get( 'show_attachment_indicator' );

		if ( OFF == $t_show_attachments ) {

			$t_keys = array_keys( $t_columns, 'attachment' );

			foreach ( $t_keys as $t_key ) {

				unset( $t_columns[$t_key] );

			}

		}

		if ( OFF == config_get( 'enable_relationship' ) ) {

			$t_keys = array_keys( $t_columns, 'duplicate_id' );

			foreach ( $t_keys as $t_key ) {

				unset( $t_columns[$t_key] );

			}

		}

		$t_current_project_id = helper_get_current_project();

		if ( $t_current_project_id != ALL_PROJECTS && !access_has_project_level( config_get( 'roadmap_view_threshold' ), $t_current_project_id ) ) {

			$t_keys = array_keys( $t_columns, 'target_version' );

			foreach ( $t_keys as $t_key ) {

				unset( $t_columns[$t_key] );

			}

		}

		# get the array values to remove gaps in the array which causes issue

		# if the array is accessed using an index.

		return array_values( $t_columns );

	}

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

	# if all projects selected, default to <prefix><username><suffix><extension>, otherwise default to

	# <prefix><projectname><suffix><extension>.

	function helper_get_default_export_filename( $p_extension_with_dot, $p_prefix = '', $p_suffix = '' ) {

		$t_filename = $p_prefix;

		$t_current_project_id = helper_get_current_project();

		if ( ALL_PROJECTS == $t_current_project_id ) {

			$t_filename .= user_get_name( auth_get_current_user_id() );

		} else {

			$t_filename .= project_get_field( $t_current_project_id, 'name' );

		}

		return $t_filename . $p_suffix . $p_extension_with_dot;

	}

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

	# returns a tab index value and increments it by one.  This is used to give sequential tab index on

	# a form.

	function helper_get_tab_index_value() {

		static $tab_index = 0;

		return ++$tab_index;

	}

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

	# returns a tab index and increments internal state by 1.  This is used to give sequential tab index on

	# a form.  For example, this function returns: tabindex="1"

	function helper_get_tab_index() {

		return 'tabindex="' . helper_get_tab_index_value() . '"';

	}

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

	# returns a boolean indicating whether SQL queries executed should be shown

	# or not.

	function helper_show_queries() {

		# Check is authenticated before checking access level, otherwise user gets 

		# redirected to login_page.php.  See #8461.

		return	ON == config_get( 'show_queries_count' ) && 

				auth_is_user_authenticated() &&

				access_has_global_level( config_get( 'show_queries_threshold' ) );

	}

?>