.
/**
* this file handles printing functions
* @package CoreAPI
* @subpackage PrintAPI
* @copyright Copyright (C) 2000 - 2002 Kenzaburo Ito - kenito@300baud.org
* @copyright Copyright (C) 2002 - 2012 MantisBT Team - mantisbt-dev@lists.sourceforge.net
* @link http://www.mantisbt.org
*/
/**
* requires current_user_api
*/
require_once( 'current_user_api.php' );
/**
* requires string_api
*/
require_once( 'string_api.php' );
/**
* requires prepare_api
*/
require_once( 'prepare_api.php' );
/**
* requires profile_api
*/
require_once( 'profile_api.php' );
/**
* requires last_visited_api
*/
require_once( 'last_visited_api.php' );
/**
* requires file_api
*/
require_once( 'file_api.php' );
require_once( 'bug_group_action_api.php' );
# --------------------
# Print the headers to cause the page to redirect to $p_url
# If $p_die is true (default), terminate the execution of the script
# immediately
# 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.
# $p_sanitize - true/false - true in the case where the URL is extracted from GET/POST or untrusted source.
# This would be false if the URL is trusted (e.g. read from config_inc.php).
#
# @param string The page to redirect: has to be a relative path
# @param boolean if true, stop the script after redirecting
# @param boolean apply string_sanitize_url to passed url
# @return boolean
function print_header_redirect( $p_url, $p_die = true, $p_sanitize = false, $p_absolute = false ) {
$t_use_iis = config_get( 'use_iis' );
if( ON == config_get_global( 'stop_on_errors' ) && error_handled() ) {
return false;
}
# validate the url as part of this site before continuing
if( $p_absolute ) {
if( $p_sanitize ) {
$t_url = string_sanitize_url( $p_url );
} else {
$t_url = $p_url;
}
} else {
if( $p_sanitize ) {
$t_url = string_sanitize_url( $p_url, true );
} else {
$t_url = config_get( 'path' ) . $p_url;
}
}
$t_url = string_prepare_header( $t_url );
# don't send more headers if they have already been sent (guideweb)
if( !headers_sent() ) {
header( 'Content-Type: text/html; charset=utf-8' );
if( ON == $t_use_iis ) {
header( "Refresh: 0;url=$t_url" );
} else {
header( "Location: $t_url" );
}
} else {
trigger_error( ERROR_PAGE_REDIRECTION, ERROR );
return false;
}
if( $p_die ) {
die;
# additional output can cause problems so let's just stop output here
}
return true;
}
# --------------------
# Print a redirect header to view a bug
function print_header_redirect_view( $p_bug_id ) {
print_header_redirect( string_get_bug_view_url( $p_bug_id ) );
}
# --------------------
# Get a view URL for the bug id based on the user's preference and
# call print_successful_redirect() with that URL
function print_successful_redirect_to_bug( $p_bug_id ) {
$t_url = string_get_bug_view_url( $p_bug_id, auth_get_current_user_id() );
print_successful_redirect( $t_url );
}
# --------------------
# If the show query count is ON, print success and redirect after the
# configured system wait time.
# If the show query count is OFF, redirect right away.
function print_successful_redirect( $p_redirect_to ) {
if( helper_show_queries() ) {
html_page_top( null, $p_redirect_to );
echo '';
echo lang_get( 'operation_successful' ) . '
';
html_page_bottom();
} else {
print_header_redirect( $p_redirect_to );
}
}
# Print avatar image for the given user ID
function print_avatar( $p_user_id, $p_size = 80 ) {
if ( OFF == config_get( 'show_avatar' ) ) {
return;
}
if( !user_exists( $p_user_id ) ) {
return;
}
if( access_has_project_level( config_get( 'show_avatar_threshold' ), null, $p_user_id ) ) {
$t_avatar = user_get_avatar( $p_user_id, $p_size );
if( false !== $t_avatar ) {
$t_avatar_url = htmlspecialchars( $t_avatar[0] );
$t_width = $t_avatar[1];
$t_height = $t_avatar[2];
echo '';
echo $t_username;
echo ' ';
}
}
# --------------------
# print out an email editing input
function print_email_input( $p_field_name, $p_email ) {
$t_limit_email_domain = config_get( 'limit_email_domain' );
if( $t_limit_email_domain ) {
# remove the domain part
$p_email = preg_replace( '/@' . preg_quote( $t_limit_email_domain, '/' ) . '$/i', '', $p_email );
echo '' . $t_display[$i] . ' ';
}
}
# --------------------
# ugly functions need to be refactored
# This populates the reporter option list with the appropriate users
#
# @todo This function really ought to print out all the users, I think.
# I just encountered a situation where a project used to be public and
# was made private, so now I can't filter on any of the reporters who
# actually reported the bugs at the time. Maybe we could get all user
# who are listed as the reporter in any bug? It would probably be a
# faster query actually.
function print_reporter_option_list( $p_user_id, $p_project_id = null ) {
print_user_option_list( $p_user_id, $p_project_id, config_get( 'report_bug_threshold' ) );
}
/**
* Print the entire form for attaching a tag to a bug.
* @param integer Bug ID
* @param string Default contents of the input box
*/
function print_tag_attach_form( $p_bug_id, $p_string = '' ) {
?>
name="tag_select" id="tag_select" onchange="tag_string_append( this.options[ this.selectedIndex ].title );">
', string_html_specialchars( lang_get( 'tag_existing' ) ), '';
foreach ( $t_rows as $row ) {
$t_string = $row['name'];
if ( !empty( $row['description'] ) ) {
$t_string .= ' - ' . utf8_substr( $row['description'], 0, 20 );
}
echo '', string_attribute( $t_string ), ' ';
}
}
# --------------------
# Get current headlines and id prefix with v_
function print_news_item_option_list() {
$t_mantis_news_table = db_get_table( 'mantis_news_table' );
$t_project_id = helper_get_current_project();
$t_global = access_has_global_level( config_get_global( 'admin_site_threshold' ) );
if( $t_global ) {
$query = "SELECT id, headline, announcement, view_state
FROM $t_mantis_news_table
ORDER BY date_posted DESC";
} else {
$query = "SELECT id, headline, announcement, view_state
FROM $t_mantis_news_table
WHERE project_id=" . db_param() . "
ORDER BY date_posted DESC";
}
$result = db_query_bound( $query, ($t_global == true ? Array() : Array( $t_project_id ) ) );
$news_count = db_num_rows( $result );
for( $i = 0;$i < $news_count;$i++ ) {
$row = db_fetch_array( $result );
$t_headline = string_display( $row['headline'] );
$t_announcement = $row['announcement'];
$t_view_state = $row['view_state'];
$t_id = $row['id'];
$t_notes = array();
$t_note_string = '';
if ( 1 == $t_announcement ) {
array_push( $t_notes, lang_get( 'announcement' ) );
}
if ( VS_PRIVATE == $t_view_state ) {
array_push( $t_notes, lang_get( 'private' ) );
}
if ( count( $t_notes ) > 0 ) {
$t_note_string = ' [' . implode( ' ', $t_notes ) . ']';
}
echo "$t_headline$t_note_string ";
}
}
# ---------------
# Constructs the string for one news entry given the row retrieved from the news table.
function print_news_entry( $p_headline, $p_body, $p_poster_id, $p_view_state, $p_announcement, $p_date_posted ) {
$t_headline = string_display_links( $p_headline );
$t_body = string_display_links( $p_body );
$t_date_posted = date( config_get( 'normal_date_format' ), $p_date_posted );
if( VS_PRIVATE == $p_view_state ) {
$t_news_css = 'news-heading-private';
} else {
$t_news_css = 'news-heading-public';
}
$output = '';
$output .= '
';
$output .= '';
$output .= "";
$output .= "$t_headline - ";
$output .= "$t_date_posted - ";
echo $output;
/** @todo eventually we should replace print's with methods to construct the strings. */
print_user( $p_poster_id );
$output = '';
if( 1 == $p_announcement ) {
$output .= ' ';
$output .= '[' . lang_get( 'announcement' ) . ']';
$output .= ' ';
}
if( VS_PRIVATE == $p_view_state ) {
$output .= ' ';
$output .= '[' . lang_get( 'private' ) . ']';
$output .= ' ';
}
$output .= ' ';
$output .= ' ';
$output .= '';
$output .= "$t_body ";
$output .= ' ';
$output .= '
';
$output .= '
' . lang_get( 'all_projects' ) . ' ' . "\n";
}
$t_project_count = count( $t_project_ids );
for( $i = 0;$i < $t_project_count;$i++ ) {
$t_id = $t_project_ids[$i];
if( $t_id != $p_filter_project_id ) {
echo '' . string_attribute( project_get_field( $t_id, 'name' ) ) . ' ' . "\n";
print_subproject_option_list( $t_id, $p_project_id, $p_filter_project_id, $p_trace, Array() );
}
}
}
# --------------------
# List projects that the current user has access to
function print_subproject_option_list( $p_parent_id, $p_project_id = null, $p_filter_project_id = null, $p_trace = false, $p_parents = Array() ) {
array_push( $p_parents, $p_parent_id );
$t_project_ids = current_user_get_accessible_subprojects( $p_parent_id );
$t_project_count = count( $t_project_ids );
for( $i = 0;$i < $t_project_count;$i++ ) {
$t_full_id = $t_id = $t_project_ids[$i];
if( $t_id != $p_filter_project_id ) {
echo "' . str_repeat( ' ', count( $p_parents ) ) . str_repeat( '»', count( $p_parents ) ) . ' ' . string_attribute( project_get_field( $t_id, 'name' ) ) . ' ' . "\n";
print_subproject_option_list( $t_id, $p_project_id, $p_filter_project_id, $p_trace, $p_parents );
}
}
}
# --------------------
# Print extended project browser
function print_extended_project_browser( $p_trace = Array(), $p_project_id = null ) {
project_cache_all();
$t_project_ids = current_user_get_accessible_projects();
echo '' . "\n";
echo '' . "\n";
echo '' . lang_get( 'all_projects' ) . ' ' . "\n";
foreach( $t_projects as $t_id => $t_name ) {
$c_name = string_attribute( $t_name );
echo '' . $c_name . ' ' . "\n";
}
echo ' ' . "\n";
if( 0 === count( $p_trace ) ) {
$t_top_id = ALL_PROJECTS;
} else {
$t_top_id = $p_trace[0];
$t_trace_str = join( ';', $p_trace );
}
echo '' . $t_platform . ' ' . $t_os . ' ' . $t_os_build . ' ';
}
}
# --------------------
# Since categories can be orphaned we need to grab all unique instances of category
# We check in the project category table and in the bug table
# We put them all in one array and make sure the entries are unique
function print_category_option_list( $p_category_id = 0, $p_project_id = null ) {
$t_category_table = db_get_table( 'mantis_category_table' );
$t_project_table = db_get_table( 'mantis_project_table' );
if( null === $p_project_id ) {
$t_project_id = helper_get_current_project();
} else {
$t_project_id = $p_project_id;
}
if( config_get( 'allow_no_category' ) ) {
echo "';
echo category_full_name( 0, /* show project */ false ), ' ';
} else {
if( 0 == $p_category_id ) {
echo "';
echo string_attribute( lang_get( 'select_option' ) ), ' ';
}
}
$cat_arr = category_get_all_rows( $t_project_id, /* inherit */ null, /* sortByProject */ true );
foreach( $cat_arr as $t_category_row ) {
$t_category_id = $t_category_row['id'];
echo "' . string_attribute( category_full_name( $t_category_id, $t_category_row['project_id'] != $t_project_id ) ) . ' ';
}
}
/**
* Now that categories are identified by numerical ID, we need an old-style name
* based option list to keep existing filter functionality.
* @param string $p_category_name The selected category
* @param mixed $p_project_id A specific project or null
*/
function print_category_filter_option_list( $p_category_name = '', $p_project_id = null ) {
$t_cat_arr = category_get_filter_list( $p_project_id );
natcasesort( $t_cat_arr );
foreach( $t_cat_arr as $t_cat ) {
$t_name = string_attribute( $t_cat );
echo '' . $t_name . ' ';
}
}
# --------------------
# Print the option list for platforms accessible for the specified user.
function print_platform_option_list( $p_platform, $p_user_id = null ) {
$t_platforms_array = profile_get_field_all_for_user( 'platform', $p_user_id );
foreach( $t_platforms_array as $t_platform ) {
$t_platform = string_attribute( $t_platform );
echo '' . $t_platform . ' ';
}
}
# --------------------
# Print the option list for OSes accessible for the specified user.
function print_os_option_list( $p_os, $p_user_id = null ) {
$t_os_array = profile_get_field_all_for_user( 'os', $p_user_id );
foreach( $t_os_array as $t_os ) {
$t_os = string_attribute( $t_os );
echo '' . $t_os . ' ';
}
}
# Print the option list for os_build accessible for the specified user.
function print_os_build_option_list( $p_os_build, $p_user_id = null ) {
$t_os_build_array = profile_get_field_all_for_user( 'os_build', $p_user_id );
foreach( $t_os_build_array as $t_os_build ) {
$t_os_build = string_attribute( $t_os_build );
echo '' . $t_os_build . ' ';
}
}
# Print the option list for versions
# $p_version = currently selected version.
# $p_project_id = project id, otherwise current project will be used.
# $p_released = null to get all, 1: only released, 0: only future versions
# $p_leading_black = allow selection of no version
# $p_with_subs = include subprojects
function print_version_option_list( $p_version = '', $p_project_id = null, $p_released = null, $p_leading_blank = true, $p_with_subs = false ) {
if( null === $p_project_id ) {
$c_project_id = helper_get_current_project();
} else {
$c_project_id = db_prepare_int( $p_project_id );
}
if( $p_with_subs ) {
$versions = version_get_all_rows_with_subs( $c_project_id, $p_released,
/* obsolete */
null );
} else {
$versions = version_get_all_rows( $c_project_id, $p_released,
/* obsolete */
null );
}
# Ensure the selected version (if specified) is included in the list
# Note: Filter API specifies selected versions as an array
if( !is_array( $p_version ) ) {
if( !empty( $p_version ) ) {
$t_version_id = version_get_id( $p_version, $c_project_id );
if( $t_version_id !== false ) {
$versions[] = version_cache_row( $t_version_id );
}
}
}
if( $p_leading_blank ) {
echo '', string_shorten( $t_version_string , $t_max_length ), ' ';
}
}
}
function print_build_option_list( $p_build = '' ) {
$t_bug_table = db_get_table( 'mantis_bug_table' );
$t_overall_build_arr = array();
$t_project_id = helper_get_current_project();
$t_project_where = helper_project_specific_where( $t_project_id );
# Get the "found in" build list
$query = "SELECT DISTINCT build
FROM $t_bug_table
WHERE $t_project_where
ORDER BY build DESC";
$result = db_query_bound( $query );
$option_count = db_num_rows( $result );
for( $i = 0;$i < $option_count;$i++ ) {
$row = db_fetch_array( $result );
$t_overall_build_arr[] = $row['build'];
}
$t_max_length = config_get( 'max_dropdown_length' );
foreach( $t_overall_build_arr as $t_build ) {
$t_build = string_attribute( $t_build );
echo "" . string_shorten( $t_build, $t_max_length ) . " ";
}
}
# select the proper enum values based on the input parameter
# $p_enum_name - name of enumeration (eg: status)
# $p_val: current value
function print_enum_string_option_list( $p_enum_name, $p_val = 0 ) {
$t_config_var_name = $p_enum_name . '_enum_string';
$t_config_var_value = config_get( $t_config_var_name );
$t_enum_values = MantisEnum::getValues( $t_config_var_value );
foreach ( $t_enum_values as $t_key ) {
$t_elem2 = get_enum_element( $p_enum_name, $t_key );
echo '' . $t_elem2 . ' ';
}
}
# Select the proper enum values for status based on workflow
# or the input parameter if workflows are not used
# $p_enum_name : name of enumeration (eg: status)
# $p_current_value : current value
function get_status_option_list( $p_user_auth = 0, $p_current_value = 0, $p_show_current = true, $p_add_close = false, $p_project_id = ALL_PROJECTS ) {
$t_config_var_value = config_get( 'status_enum_string', null, null, $p_project_id );
$t_enum_workflow = config_get( 'status_enum_workflow', null, null, $p_project_id );
if( count( $t_enum_workflow ) < 1 ) {
# workflow not defined, use default enum
$t_enum_values = MantisEnum::getValues( $t_config_var_value );
} else {
# workflow defined - find allowed states
if( isset( $t_enum_workflow[$p_current_value] ) ) {
$t_enum_values = MantisEnum::getValues( $t_enum_workflow[$p_current_value] );
} else {
# workflow was not set for this status, this shouldn't happen
$t_enum_values = MantisEnum::getValues( $t_config_var_value );
}
}
$t_enum_list = array();
foreach ( $t_enum_values as $t_enum_value ) {
if ( ( access_compare_level( $p_user_auth, access_get_status_threshold( $t_enum_value, $p_project_id ) ) )
&& ( !(( false == $p_show_current ) && ( $p_current_value == $t_enum_value ) ) ) ) {
$t_enum_list[$t_enum_value] = get_enum_element( 'status', $t_enum_value );
}
}
if ( $p_show_current ) {
$t_enum_list[$p_current_value] = get_enum_element( 'status', $p_current_value );
}
if ( $p_add_close && access_compare_level( $p_current_value, config_get( 'bug_resolved_status_threshold', null, null, $p_project_id ) ) ) {
$t_closed = config_get( 'bug_closed_status_threshold', null, null, $p_project_id );
$t_enum_list[$t_closed] = get_enum_element( 'status', $t_closed );
}
return $t_enum_list;
}
# print the status option list for the bug_update pages
function print_status_option_list( $p_select_label, $p_current_value = 0, $p_allow_close = false, $p_project_id = ALL_PROJECTS ) {
$t_current_auth = access_get_project_level( $p_project_id );
$t_enum_list = get_status_option_list( $t_current_auth, $p_current_value, true, $p_allow_close, $p_project_id );
if( count( $t_enum_list ) > 1 ) {
# resort the list into ascending order
ksort( $t_enum_list );
reset( $t_enum_list );
echo '';
foreach( $t_enum_list as $key => $val ) {
echo '' . $val . ' ';
}
echo ' ';
} else if ( count( $t_enum_list ) == 1 ) {
echo array_pop( $t_enum_list );
} else {
echo MantisEnum::getLabel( lang_get( 'status_enum_string' ), $p_current_value );
}
}
# prints the list of a project's users
# if no project is specified uses the current project
function print_project_user_option_list( $p_project_id = null ) {
print_user_option_list( 0, $p_project_id );
}
# prints the list of access levels that are less than or equal to the access level of the
# logged in user. This is used when adding users to projects
function print_project_access_levels_option_list( $p_val, $p_project_id = null ) {
$t_current_user_access_level = access_get_project_level( $p_project_id );
$t_access_levels_enum_string = config_get( 'access_levels_enum_string' );
$t_enum_values = MantisEnum::getValues( $t_access_levels_enum_string );
foreach ( $t_enum_values as $t_enum_value ) {
# a user must not be able to assign another user an access level that is higher than theirs.
if ( $t_enum_value > $t_current_user_access_level ) {
continue;
}
$t_access_level = get_enum_element( 'access_levels', $t_enum_value );
echo '' . $t_access_level . ' ';
}
}
function print_language_option_list( $p_language ) {
$t_arr = config_get( 'language_choices_arr' );
$enum_count = count( $t_arr );
for( $i = 0;$i < $enum_count;$i++ ) {
$t_language = string_attribute( $t_arr[$i] );
echo '' . $t_language . ' ';
}
}
/**
* Print a dropdown list of all bug actions available to a user for a specified
* set of projects.
* @param array $p_projects An array containing one or more project IDs
* @return null
*/
function print_all_bug_action_option_list( $p_project_ids = null ) {
$t_commands = bug_group_action_get_commands( $p_project_ids);
while( list( $t_action_id, $t_action_label ) = each( $t_commands ) ) {
echo '' . $t_action_label . ' ';
}
}
# --------------------
# list of users that are NOT in the specified project and that are enabled
# if no project is specified use the current project
# also exclude any administrators
function print_project_user_list_option_list( $p_project_id = null ) {
$t_mantis_project_user_list_table = db_get_table( 'mantis_project_user_list_table' );
$t_mantis_user_table = db_get_table( 'mantis_user_table' );
if( null === $p_project_id ) {
$p_project_id = helper_get_current_project();
}
$c_project_id = (int) $p_project_id;
$t_adm = config_get_global( 'admin_site_threshold' );
$query = "SELECT DISTINCT u.id, u.username, u.realname
FROM $t_mantis_user_table u
LEFT JOIN $t_mantis_project_user_list_table p
ON p.user_id=u.id AND p.project_id=" . db_param() . "
WHERE u.access_level<" . db_param() . " AND
u.enabled = " . db_param() . " AND
p.user_id IS NULL
ORDER BY u.realname, u.username";
$result = db_query_bound( $query, Array( $c_project_id, $t_adm, true ) );
$t_display = array();
$t_sort = array();
$t_users = array();
$t_show_realname = ( ON == config_get( 'show_realname' ) );
$t_sort_by_last_name = ( ON == config_get( 'sort_by_last_name' ) );
$category_count = db_num_rows( $result );
for( $i = 0;$i < $category_count;$i++ ) {
$row = db_fetch_array( $result );
$t_users[] = $row['id'];
$t_user_name = string_attribute( $row['username'] );
$t_sort_name = $t_user_name;
if(( isset( $row['realname'] ) ) && ( $row['realname'] <> '' ) && $t_show_realname ) {
$t_user_name = string_attribute( $row['realname'] );
if( $t_sort_by_last_name ) {
$t_sort_name_bits = explode( ' ', utf8_strtolower( $t_user_name ), 2 );
$t_sort_name = ( isset( $t_sort_name_bits[1] ) ? $t_sort_name_bits[1] . ', ' : '' ) . $t_sort_name_bits[0];
} else {
$t_sort_name = utf8_strtolower( $t_user_name );
}
}
$t_display[] = $t_user_name;
$t_sort[] = $t_sort_name;
}
array_multisort( $t_sort, SORT_ASC, SORT_STRING, $t_users, $t_display );
$t_count = count( $t_sort );
for( $i = 0;$i < $t_count; $i++ ) {
echo '' . $t_display[$i] . ' ';
}
}
# list of projects that a user is NOT in
function print_project_user_list_option_list2( $p_user_id ) {
$t_mantis_project_user_list_table = db_get_table( 'mantis_project_user_list_table' );
$t_mantis_project_table = db_get_table( 'mantis_project_table' );
$c_user_id = db_prepare_int( $p_user_id );
$query = "SELECT DISTINCT p.id, p.name
FROM $t_mantis_project_table p
LEFT JOIN $t_mantis_project_user_list_table u
ON p.id=u.project_id AND u.user_id=" . db_param() . "
WHERE p.enabled = " . db_param() . " AND
u.user_id IS NULL
ORDER BY p.name";
$result = db_query_bound( $query, Array( $c_user_id, true ) );
$category_count = db_num_rows( $result );
for( $i = 0;$i < $category_count;$i++ ) {
$row = db_fetch_array( $result );
$t_project_name = string_attribute( $row['name'] );
$t_user_id = $row['id'];
echo "$t_project_name ";
}
}
# list of projects that a user is in
function print_project_user_list( $p_user_id, $p_include_remove_link = true ) {
$t_mantis_project_user_list_table = db_get_table( 'mantis_project_user_list_table' );
$t_mantis_project_table = db_get_table( 'mantis_project_table' );
$c_user_id = db_prepare_int( $p_user_id );
$query = "SELECT DISTINCT p.id, p.name, p.view_state, u.access_level
FROM $t_mantis_project_table p
LEFT JOIN $t_mantis_project_user_list_table u
ON p.id=u.project_id
WHERE p.enabled = '1' AND
u.user_id=" . db_param() . "
ORDER BY p.name";
$result = db_query_bound( $query, Array( $c_user_id ) );
$category_count = db_num_rows( $result );
for( $i = 0;$i < $category_count;$i++ ) {
$row = db_fetch_array( $result );
$t_project_id = $row['id'];
$t_project_name = string_attribute( $row['name'] );
$t_view_state = $row['view_state'];
$t_access_level = $row['access_level'];
$t_access_level = get_enum_element( 'access_levels', $t_access_level );
$t_view_state = get_enum_element( 'project_view_state', $t_view_state );
echo $t_project_name . ' [' . $t_access_level . '] (' . $t_view_state . ')';
if( $p_include_remove_link && access_has_project_level( config_get( 'project_user_threshold' ), $t_project_id ) ) {
html_button( 'manage_user_proj_delete.php', lang_get( 'remove_link' ), array( 'project_id' => $t_project_id, 'user_id' => $p_user_id ) );
}
echo '', string_display_line( $t_project_name ), ' : ';
print_bracket_link( "manage_proj_custom_field_remove.php?field_id=$c_field_id&project_id=$t_project_id&return=custom_field$t_security_token", lang_get( 'remove_link' ) );
echo '';
}
echo string_display_line( custom_field_get_field( $t_current_field_id, 'name' ) );
echo ' (', custom_field_get_sequence( $t_current_field_id, $t_project_id ), ')';
if( $t_current_field_id == $p_field_id ) {
echo ' ';
}
}
echo '', $p_priority, ' ';
}
for( $i = 5;$i >= 1;$i-- ) {
echo '', $i, ' ';
}
}
# ##########################################################################
# String printing API
# ##########################################################################
# prints a link to VIEW a bug given an ID
# account for the user preference and site override
function print_bug_link( $p_bug_id, $p_detail_info = true ) {
echo string_get_bug_view_link( $p_bug_id, null, $p_detail_info );
}
# formats the priority given the status
# shows the priority in BOLD if the bug is NOT closed and is of significant priority
function print_formatted_priority_string( $p_bug ) {
$t_pri_str = get_enum_element( 'priority', $p_bug->priority, auth_get_current_user_id(), $p_bug->project_id );
$t_priority_threshold = config_get( 'priority_significant_threshold' );
if( $t_priority_threshold >= 0 &&
$p_bug->priority >= $t_priority_threshold &&
$p_bug->status < config_get( 'bug_closed_status_threshold' ) ) {
echo "$t_pri_str ";
} else {
echo $t_pri_str;
}
}
# formats the severity given the status
# shows the severity in BOLD if the bug is NOT closed and is of significant severity
function print_formatted_severity_string( $p_bug ) {
$t_sev_str = get_enum_element( 'severity', $p_bug->severity, auth_get_current_user_id(), $p_bug->project_id );
$t_severity_threshold = config_get( 'severity_significant_threshold' );
if( $t_severity_threshold >= 0 &&
$p_bug->severity >= $t_severity_threshold &&
$p_bug->status < config_get( 'bug_closed_status_threshold' ) ) {
echo "$t_sev_str ";
} else {
echo $t_sev_str;
}
}
# ##########################################################################
# Link Printing API
# ##########################################################################
# $p_columns_target: see COLUMNS_TARGET_* in constant_inc.php
function print_view_bug_sort_link( $p_string, $p_sort_field, $p_sort, $p_dir, $p_columns_target = COLUMNS_TARGET_VIEW_PAGE ) {
if( $p_columns_target == COLUMNS_TARGET_PRINT_PAGE ) {
if( $p_sort_field == $p_sort ) {
# We toggle between ASC and DESC if the user clicks the same sort order
if( 'ASC' == $p_dir ) {
$p_dir = 'DESC';
} else {
$p_dir = 'ASC';
}
} else {
# Otherwise always start with ASCending
$t_dir = 'ASC';
}
$t_sort_field = rawurlencode( $p_sort_field );
print_link( "view_all_set.php?sort=$t_sort_field&dir=$p_dir&type=2&print=1", $p_string );
}
else if( $p_columns_target == COLUMNS_TARGET_VIEW_PAGE ) {
if( $p_sort_field == $p_sort ) {
# we toggle between ASC and DESC if the user clicks the same sort order
if( 'ASC' == $p_dir ) {
$p_dir = 'DESC';
} else {
$p_dir = 'ASC';
}
} else {
# Otherwise always start with ASCending
$t_dir = 'ASC';
}
$t_sort_field = rawurlencode( $p_sort_field );
print_link( "view_all_set.php?sort=$t_sort_field&dir=$p_dir&type=2", $p_string );
} else {
echo $p_string;
}
}
function print_manage_user_sort_link( $p_page, $p_string, $p_field, $p_dir, $p_sort_by, $p_hide = 0, $p_filter = ALL ) {
if( $p_sort_by == $p_field ) {
# If this is the selected field flip the order
if( 'ASC' == $p_dir || ASCENDING == $p_dir ) {
$t_dir = 'DESC';
} else {
$t_dir = 'ASC';
}
} else {
# Otherwise always start with ASCending
$t_dir = 'ASC';
}
$t_field = rawurlencode( $p_field );
print_link( "$p_page?sort=$t_field&dir=$t_dir&save=1&hide=$p_hide&filter=$p_filter", $p_string );
}
function print_manage_project_sort_link( $p_page, $p_string, $p_field, $p_dir, $p_sort_by ) {
if( $p_sort_by == $p_field ) {
# If this is the selected field flip the order
if( 'ASC' == $p_dir || ASCENDING == $p_dir ) {
$t_dir = 'DESC';
} else {
$t_dir = 'ASC';
}
} else {
# Otherwise always start with ASCending
$t_dir = 'ASC';
}
$t_field = rawurlencode( $p_field );
print_link( "$p_page?sort=$t_field&dir=$t_dir", $p_string );
}
# print a button which presents a standalone form.
# $p_action_page - The action page
# $p_label - The button label
# $p_args_to_post - An associative array with key => value to be posted, can be null.
function print_button( $p_action_page, $p_label, $p_args_to_post = null ) {
$t_form_name = explode( '.php', $p_action_page, 2 );
# TODO: ensure all uses of print_button supply arguments via $p_args_to_post (POST)
# instead of via $p_action_page (GET). Then only add the CSRF form token if
# arguments are being sent via the POST method.
echo '';
}
# print brackets around a pre-prepared link (i.e. '[ ' . $p_link . ' ] ';
}
# print the bracketed links used near the top
# if the $p_link is blank then the text is printed but no link is created
# if $p_new_window is true, link will open in a new window, default false.
function print_bracket_link( $p_link, $p_url_text, $p_new_window = false, $p_class = '' ) {
echo '[ ';
print_link( $p_link, $p_url_text, $p_new_window, $p_class );
echo ' ] ';
}
# print a HTML link
function print_link( $p_link, $p_url_text, $p_new_window = false, $p_class = '' ) {
if( is_blank( $p_link ) ) {
echo $p_url_text;
} else {
$t_link = htmlspecialchars( $p_link );
if( $p_new_window === true ) {
if( $p_class !== '') {
echo " $p_url_text ";
} else {
echo "$p_url_text ";
}
} else {
if( $p_class !== '') {
echo "$p_url_text ";
} else {
echo "$p_url_text ";
}
}
}
}
# print a HTML page link
function print_page_link( $p_page_url, $p_text = '', $p_page_no = 0, $p_page_cur = 0, $p_temp_filter_id = 0 ) {
if( is_blank( $p_text ) ) {
$p_text = $p_page_no;
}
if( ( 0 < $p_page_no ) && ( $p_page_no != $p_page_cur ) ) {
$t_delimiter = ( strpos( $p_page_url, "?" ) ? "&" : "?" );
if( $p_temp_filter_id !== 0 ) {
print_link( "$p_page_url${t_delimiter}filter=$p_temp_filter_id&page_number=$p_page_no", $p_text );
} else {
print_link( "$p_page_url${t_delimiter}page_number=$p_page_no", $p_text );
}
} else {
echo $p_text;
}
}
# print a list of page number links (eg [1 2 3])
function print_page_links( $p_page, $p_start, $p_end, $p_current, $p_temp_filter_id = 0 ) {
$t_items = array();
$t_link = '';
# Check if we have more than one page,
# otherwise return without doing anything.
if( $p_end - $p_start < 1 ) {
return;
}
# Get localized strings
$t_first = lang_get( 'first' );
$t_last = lang_get( 'last' );
$t_prev = lang_get( 'prev' );
$t_next = lang_get( 'next' );
$t_page_links = 10;
print( "[ " );
# First and previous links
print_page_link( $p_page, $t_first, 1, $p_current, $p_temp_filter_id );
echo ' ';
print_page_link( $p_page, $t_prev, $p_current - 1, $p_current, $p_temp_filter_id );
echo ' ';
# Page numbers ...
$t_first_page = max( $p_start, $p_current - $t_page_links / 2 );
$t_first_page = min( $t_first_page, $p_end - $t_page_links );
$t_first_page = max( $t_first_page, $p_start );
if( $t_first_page > 1 ) {
print( " ... " );
}
$t_last_page = $t_first_page + $t_page_links;
$t_last_page = min( $t_last_page, $p_end );
for( $i = $t_first_page;$i <= $t_last_page;$i++ ) {
if( $i == $p_current ) {
array_push( $t_items, $i );
} else {
$t_delimiter = ( strpos( $p_page, "?" ) ? "&" : "?" ) ;
if( $p_temp_filter_id !== 0 ) {
array_push( $t_items, "$i " );
} else {
array_push( $t_items, "$i " );
}
}
}
echo implode( ' ', $t_items );
if( $t_last_page < $p_end ) {
print( ' ... ' );
}
# Next and Last links
echo ' ';
if( $p_current < $p_end ) {
print_page_link( $p_page, $t_next, $p_current + 1, $p_current, $p_temp_filter_id );
} else {
print_page_link( $p_page, $t_next, null, null, $p_temp_filter_id );
}
echo ' ';
print_page_link( $p_page, $t_last, $p_end, $p_current, $p_temp_filter_id );
print( ' ]' );
}
# print a mailto: href link
function print_email_link( $p_email, $p_text ) {
echo get_email_link( $p_email, $p_text );
}
# return the mailto: href string link instead of printing it
function get_email_link( $p_email, $p_text ) {
return prepare_email_link( $p_email, $p_text );
}
# print a mailto: href link with subject
function print_email_link_with_subject( $p_email, $p_text, $p_bug_id ) {
$t_subject = email_build_subject( $p_bug_id );
echo get_email_link_with_subject( $p_email, $p_text, $t_subject );
}
# return the mailto: href string link instead of printing it
# add subject line
function get_email_link_with_subject( $p_email, $p_text, $p_summary ) {
if( !access_has_project_level( config_get( 'show_user_email_threshold' ) ) ) {
return $p_text;
}
# If we apply string_url() to the whole mailto: link then the @
# gets turned into a %40 and you can't right click in browsers to
# do Copy Email Address. If we don't apply string_url() to the
# summary text then an ampersand (for example) will truncate the text
$t_summary = string_url( $p_summary );
$t_email = string_url( $p_email );
$t_mailto = string_attribute( "mailto:$t_email?subject=$t_summary" );
$t_text = string_display( $p_text );
return "$t_text ";
}
# Print a hidden input for each name=>value pair in the array
#
# If a value is an array an input will be created for each item with a name
# that ends with []
# The names and values are passed through htmlspecialchars() before being displayed
function print_hidden_inputs( $p_assoc_array ) {
foreach( $p_assoc_array as $t_key => $t_val ) {
print_hidden_input( $t_key, $t_val );
}
}
function print_hidden_input( $p_field_key, $p_field_val ) {
if( is_array( $p_field_val ) ) {
foreach( $p_field_val AS $t_key => $t_value ) {
if( is_array( $t_value ) ) {
$t_key = string_html_entities( $t_key );
$t_field_key = $p_field_key . '[' . $t_key . ']';
print_hidden_input( $t_field_key, $t_value );
} else {
$t_field_key = $p_field_key . '[' . $t_key . ']';
print_hidden_input( $t_field_key, $t_value );
}
}
} else {
$t_key = string_html_entities( $p_field_key );
$t_val = string_html_entities( $p_field_val );
echo "[?] ";
}
# print the hr
function print_hr( $p_hr_size = null, $p_hr_width = null ) {
if( null === $p_hr_size ) {
$p_hr_size = config_get( 'hr_size' );
}
if( null === $p_hr_width ) {
$p_hr_width = config_get( 'hr_width' );
}
echo "' . lang_get( 'recently_visited' ) . ': ';
$t_first = true;
foreach( $t_ids as $t_id ) {
if( !$t_first ) {
echo ', ';
} else {
$t_first = false;
}
echo string_get_bug_view_link( $t_id );
}
echo '
';
}
# print a dropdown box from input array
function get_dropdown( $p_control_array, $p_control_name, $p_match = '', $p_add_any = false, $p_multiple = false, $p_change_script = '' ) {
$t_control_array = $p_control_array;
if( $p_multiple ) {
$t_size = ' size="5"';
$t_multiple = ' multiple="multiple"';
} else {
$t_size = '';
$t_multiple = '';
}
$t_script = ( $p_change_script == '' ? '' : ' onchange="' . $p_change_script . '"' );
$t_info = sprintf( "", $t_multiple, $p_control_name, $p_control_name, $t_size, $t_script );
if( $p_add_any ) {
array_unshift_assoc( $t_control_array, META_FILTER_ANY, lang_trans( '[any]' ) );
}
while( list( $t_name, $t_desc ) = each( $t_control_array ) ) {
$t_sel = '';
if( is_array( $p_match ) ) {
if( in_array( $t_name, array_values( $p_match ) ) || in_array( $t_desc, array_values( $p_match ) ) ) {
$t_sel = ' selected="selected"';
}
} else {
if(( $t_name === $p_match ) || ( $t_desc === $p_match ) ) {
$t_sel = ' selected="selected"';
}
}
$t_info .= sprintf( "%s", $t_sel, $t_name, $t_desc );
}
$t_info .= " \n";
return $t_info;
}
# List the attachments belonging to the specified bug. This is used from within
# bug_view_inc.php
function print_bug_attachments_list( $p_bug_id ) {
$t_attachments = file_get_visible_attachments( $p_bug_id );
$t_attachments_count = count( $t_attachments );
$i = 0;
$image_previewed = false;
foreach ( $t_attachments as $t_attachment ) {
$t_file_display_name = string_display_line( $t_attachment['display_name'] );
$t_filesize = number_format( $t_attachment['size'] );
$t_date_added = date( config_get( 'normal_date_format' ), $t_attachment['date_added'] );
if ( $image_previewed ) {
$image_previewed = false;
echo '';
$t_href_end = ' ';
$t_href_clicket = " [^ ]";
} else {
$t_href_start = '';
$t_href_end = '';
$t_href_clicket = '';
}
if ( !$t_attachment['exists'] ) {
print_file_icon( $t_file_display_name );
echo ' ' . $t_file_display_name . ' ' . lang_get( 'word_separator' ) . '(' . lang_get( 'attachment_missing' ) . ')';
} else {
echo $t_href_start;
print_file_icon( $t_file_display_name );
echo $t_href_end . ' ' . $t_href_start . $t_file_display_name . $t_href_end . $t_href_clicket . ' (' . $t_filesize . ' ' . lang_get( 'bytes' ) . ') ' . '' . $t_date_added . ' ';
}
if ( $t_attachment['can_delete'] ) {
echo ' [';
print_link( 'bug_file_delete.php?file_id=' . $t_attachment['id'] . form_security_param( 'bug_file_delete' ), lang_get( 'delete_link' ), false, 'small' );
echo ']';
}
if ( $t_attachment['exists'] ) {
if ( ( FTP == config_get( 'file_upload_method' ) ) && $t_attachment['exists'] ) {
echo ' (' . lang_get( 'cached' ) . ')';
}
if ( $t_attachment['preview'] && ( $t_attachment['type'] == 'text' ) ) {
$c_id = db_prepare_int( $t_attachment['id'] );
$t_bug_file_table = db_get_table( 'mantis_bug_file_table' );
echo "";
echo " [" . lang_get( 'show_content' ) . " ] ";
echo " [" . lang_get( 'hide_content' ) . " ]";
echo "";
/** @todo Refactor into a method that gets contents for download / preview. */
switch( config_get( 'file_upload_method' ) ) {
case DISK:
if ( $t_attachment['exists'] ) {
$v_content = file_get_contents( $t_attachment['diskfile'] );
}
break;
case FTP:
if( file_exists( $t_attachment['exists'] ) ) {
file_get_contents( $t_attachment['diskfile'] );
} else {
$ftp = file_ftp_connect();
file_ftp_get( $ftp, $t_attachment['diskfile'], $t_attachment['diskfile'] );
file_ftp_disconnect( $ftp );
$v_content = file_get_contents( $t_attachment['diskfile'] );
}
break;
default:
$query = "SELECT *
FROM $t_bug_file_table
WHERE id=" . db_param();
$result = db_query_bound( $query, Array( $c_id ) );
$row = db_fetch_array( $result );
$v_content = $row['content'];
}
echo htmlspecialchars( $v_content );
echo " \n";
}
if ( $t_attachment['can_download'] && $t_attachment['preview'] && $t_attachment['type'] == 'image' ) {
$t_preview_style = 'border: 0;';
$t_max_width = config_get( 'preview_max_width' );
if( $t_max_width > 0 ) {
$t_preview_style .= ' max-width:' . $t_max_width . 'px;';
}
$t_max_height = config_get( 'preview_max_height' );
if( $t_max_height > 0 ) {
$t_preview_style .= ' max-height:' . $t_max_height . 'px;';
}
$t_preview_style = 'style="' . $t_preview_style . '"';
$t_title = file_get_field( $t_attachment['id'], 'title' );
$t_image_url = $t_attachment['download_url'] . '&show_inline=1' . form_security_param( 'file_show_inline' );
echo "\n', $p_timezone, ' ';
return;
}
$t_identifiers = timezone_identifiers_list();
foreach ( $t_identifiers as $t_identifier )
{
$t_zone = explode( '/', $t_identifier );
// Only use "friendly" continent names - http://us.php.net/manual/en/timezones.others.php
if ($t_zone[0] == 'Africa' ||
$t_zone[0] == 'America' ||
$t_zone[0] == 'Antarctica' ||
$t_zone[0] == 'Arctic' ||
$t_zone[0] == 'Asia' ||
$t_zone[0] == 'Atlantic' ||
$t_zone[0] == 'Australia' ||
$t_zone[0] == 'Europe' ||
$t_zone[0] == 'Indian' ||
$t_zone[0] == 'Pacific' )
{
if ( isset( $t_zone[1] ) != '' )
{
$t_locations[$t_zone[0]][$t_zone[0] . '/' . $t_zone[1]] = array( str_replace( '_', ' ', $t_zone[1] ), $t_identifier );
}
}
}
foreach( $t_locations as $t_continent => $t_locations ) {
echo '';
foreach ( $t_locations as $t_location ) {
echo '' . $t_location[0] . ' ';
}
}
}
';
}
# Prints the recently visited issues.
function print_recently_visited() {
if( !last_visited_enabled() ) {
return;
}
$t_ids = last_visited_get_array();
if( count( $t_ids ) == 0 ) {
return;
}
echo '