. /** * HTML API * * These functions control the HTML output 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 * * @package CoreAPI * @subpackage HTMLAPI * @copyright Copyright (C) 2000 - 2002 Kenzaburo Ito - kenito@300baud.org * @copyright Copyright (C) 2002 - 2011 MantisBT Team - mantisbt-dev@lists.sourceforge.net * @link http://www.mantisbt.org * * @uses access_api.php * @uses authentication_api.php * @uses bug_api.php * @uses config_api.php * @uses constant_inc.php * @uses current_user_api.php * @uses database_api.php * @uses error_api.php * @uses event_api.php * @uses file_api.php * @uses filter_api.php * @uses filter_constants_inc.php * @uses form_api.php * @uses helper_api.php * @uses lang_api.php * @uses news_api.php * @uses php_api.php * @uses print_api.php * @uses project_api.php * @uses rss_api.php * @uses string_api.php * @uses user_api.php * @uses utility_api.php */ require_api( 'access_api.php' ); require_api( 'authentication_api.php' ); require_api( 'bug_api.php' ); require_api( 'config_api.php' ); require_api( 'constant_inc.php' ); require_api( 'current_user_api.php' ); require_api( 'database_api.php' ); require_api( 'error_api.php' ); require_api( 'event_api.php' ); require_api( 'file_api.php' ); require_api( 'filter_api.php' ); require_api( 'filter_constants_inc.php' ); require_api( 'form_api.php' ); require_api( 'helper_api.php' ); require_api( 'lang_api.php' ); require_api( 'news_api.php' ); require_api( 'php_api.php' ); require_api( 'print_api.php' ); require_api( 'project_api.php' ); require_api( 'rss_api.php' ); require_api( 'string_api.php' ); require_api( 'user_api.php' ); require_api( 'utility_api.php' ); $g_rss_feed_url = null; $g_robots_meta = ''; # flag for error handler to skip header menus $g_error_send_page_header = true; $g_stylesheets_included = array(); $g_scripts_included = array(); /** * Sets the url for the rss link associated with the current page. * null: means no feed (default). * @param string $p_rss_feed_url rss feed url * @return null */ 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; } } /** * This method must be called before the html_page_top* methods. It marks the page as not * for indexing. * @return null */ function html_robots_noindex() { global $g_robots_meta; $g_robots_meta = 'noindex,follow'; } /** * Prints the link that allows auto-detection of the associated feed. * @return null */ function html_rss_link() { global $g_rss_feed_url; if( $g_rss_feed_url !== null ) { echo '\n"; } } /** * Prints a ' . "\n"; } /** * Defines the top of a HTML page * @param string $p_page_title html page title * @param string $p_redirect_url url to redirect to if necessary * @return null */ function html_page_top( $p_page_title = null, $p_redirect_url = null ) { html_page_top1( $p_page_title ); if ( $p_redirect_url !== null ) { html_meta_redirect( $p_redirect_url ); } html_page_top2(); } /** * Print the part of the page that comes before meta redirect tags should be inserted * @param string $p_page_title page title * @return null */ function html_page_top1( $p_page_title = null ) { html_begin(); html_head_begin(); html_css(); html_content_type(); include( config_get( 'meta_include_file' ) ); global $g_robots_meta; if ( !is_blank( $g_robots_meta ) ) { echo "\t", '', "\n"; } html_rss_link(); $t_favicon_image = config_get( 'favicon_image' ); if( !is_blank( $t_favicon_image ) ) { echo "\t", '', "\n"; } // Advertise the availability of the browser search plug-ins. echo "\t", '' . "\n"; echo "\t", '' . "\n"; 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 * @return null */ function html_page_top2() { html_page_top2a(); if( !db_is_connected() ) { return; } if( auth_is_user_authenticated() ) { html_login_info(); if( ON == config_get( 'show_project_menu_bar' ) ) { print_project_menu_bar(); echo '
'; } } print_menu(); echo '
', "\n"; event_signal( 'EVENT_LAYOUT_CONTENT_BEGIN' ); } /** * 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 * @return null */ 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 * @param string $p_file should always be the __FILE__ variable. This is passed to show source * @return null */ function html_page_bottom( $p_file = null ) { html_page_bottom1( $p_file ); } /** * 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 * @param string $p_file should always be the __FILE__ variable. This is passed to show source * @return null */ function html_page_bottom1( $p_file = null ) { if( !db_is_connected() ) { return; } event_signal( 'EVENT_LAYOUT_CONTENT_END' ); echo '
', "\n"; if( config_get( 'show_footer_menu' ) ) { echo '
'; print_menu(); } 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. * @param string $p_file should always be the __FILE__ variable. * @return null */ function html_page_bottom1a( $p_file = null ) { if( null === $p_file ) { $p_file = basename( $_SERVER['SCRIPT_NAME'] ); } html_bottom_banner(); html_footer(); html_body_end(); html_end(); } /** * (1) Print the document type and the opening tag * @return null */ function html_begin() { echo ''; echo ''; echo ''; } /** * (2) Begin the section * @return null */ function html_head_begin() { echo '', "\n"; } /** * (3) Print the content-type * @return null */ function html_content_type() { echo "\t", '', "\n"; } /** * (4) Print the window title * @param string $p_page_title window title * @return null */ function html_title( $p_page_title = null ) { $t_page_title = string_html_specialchars( $p_page_title ); $t_title = string_html_specialchars( config_get( 'window_title' ) ); echo "\t", ''; if( empty( $t_page_title ) ) { echo $t_title; } else { if( empty( $t_title ) ) { echo $t_page_title; } else { echo $t_page_title . ' - ' . $t_title; } } echo '', "\n"; } function require_css( $p_stylesheet_path ) { global $g_stylesheets_included; $g_stylesheets_included[$p_stylesheet_path] = $p_stylesheet_path; } /** * (5) Print the link to include the css file * @return null */ function html_css() { global $g_stylesheets_included; html_css_link( config_get( 'css_include_file' ) ); html_css_link( 'jquery-ui.css' ); html_css_link( 'common_config.php' ); # Add right-to-left css if needed if ( lang_get( 'directionality' ) == 'rtl' ) { html_css_link( config_get( 'css_rtl_include_file' ) ); } foreach ( $g_stylesheets_included as $t_stylesheet_path ) { html_css_link ( $t_stylesheet_path ); } } /** * Prints a css link * @return null */ function html_css_link( $p_filename ) { echo "\t", '' . "\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. * * @param string $p_url The page to redirect: has to be a relative path * @param integer $p_time seconds to wait for before redirecting * @param boolean $p_sanitize apply string_sanitize_url to passed url * @return boolean */ function html_meta_redirect( $p_url, $p_time = null, $p_sanitize = true ) { if( ON == config_get_global( 'stop_on_errors' ) && error_handled() ) { return false; } if( null === $p_time ) { $p_time = current_user_get_pref( 'redirect_delay' ); } $t_url = config_get( 'path' ); if( $p_sanitize ) { $t_url .= string_sanitize_url( $p_url ); } else { $t_url .= $p_url; } $t_url = htmlspecialchars( $t_url ); echo "\t\n"; return true; } function require_js( $p_script_path ) { global $g_scripts_included; $g_scripts_included[$p_script_path] = $p_script_path; } /** * (6a) Javascript... * @return null */ function html_head_javascript() { if ( config_get( 'use_javascript' ) ) { global $g_scripts_included; echo "\t' . "\n"; echo "\t' . "\n"; html_javascript_link( 'jquery.js' ); html_javascript_link( 'jquery-ui.js' ); html_javascript_link( 'common.js' ); foreach ( $g_scripts_included as $t_script_path ) { html_javascript_link( $t_script_path ); } } } /** * (7) End the section * @return null */ function html_head_end() { event_signal( 'EVENT_LAYOUT_RESOURCES' ); echo '', "\n"; } /** * (8) Begin the section * @return null */ function html_body_begin() { echo '', "\n"; echo '
', "\n"; event_signal( 'EVENT_LAYOUT_BODY_BEGIN' ); } /** * (9) Print the title displayed at the top of the page * @return null */ function html_header() { $t_title = config_get( 'page_title' ); if( !is_blank( $t_title ) ) { echo '
', string_display( $t_title ), '
', "\n"; } } /** * (10) Print a user-defined banner at the top of the page if there is one. * @return null */ function html_top_banner() { $t_page = config_get( 'top_include_page' ); $t_logo_image = config_get( 'logo_image' ); $t_logo_url = config_get( 'logo_url' ); if( is_blank( $t_logo_image ) ) { $t_show_logo = false; } else { $t_show_logo = true; if( is_blank( $t_logo_url ) ) { $t_show_url = false; } else { $t_show_url = true; } } if( !is_blank( $t_page ) && file_exists( $t_page ) && !is_dir( $t_page ) ) { include( $t_page ); } else if( $t_show_logo ) { echo ''; } event_signal( 'EVENT_LAYOUT_PAGE_HEADER' ); } /** * (11) Print the user's account information * Also print the select box where users can switch projects * @return null */ function html_login_info() { $t_username = current_user_get_field( 'username' ); $t_access_level = get_enum_element( 'access_levels', current_user_get_access_level() ); $t_now = date( config_get( 'complete_date_format' ) ); $t_realname = current_user_get_field( 'realname' ); echo '
'; if( current_user_is_anonymous() ) { $t_return_page = $_SERVER['SCRIPT_NAME']; if( isset( $_SERVER['QUERY_STRING'] ) ) { $t_return_page .= '?' . $_SERVER['QUERY_STRING']; } $t_return_page = string_url( $t_return_page ); echo '' . lang_get( 'anonymous' ) . ''; echo '' . lang_get( 'login_link' ) . ''; if( config_get_global( 'allow_signup' ) == ON ) { echo '' . lang_get( 'signup_link' ) . ''; } } else { echo '' . lang_get( 'logged_in_as' ) . ''; echo '' . string_html_specialchars( $t_username ) . ''; echo ''; echo !is_blank( $t_realname ) ? '' . string_html_specialchars( $t_realname ) . '' : ''; echo '' . $t_access_level . ''; echo ''; } echo '
'; $t_show_project_selector = true; if( count( current_user_get_accessible_projects() ) == 1 ) { // >1 $t_project_ids = current_user_get_accessible_projects(); $t_project_id = (int) $t_project_ids[0]; if( count( current_user_get_accessible_subprojects( $t_project_id ) ) == 0 ) { $t_show_project_selector = false; } } if( OFF != config_get( 'rss_enabled' ) ) { echo '
'; # Link to RSS issues feed for the selected project, including authentication details. echo ''; echo '' . lang_get( 'rss' ) . ''; echo ''; echo '
'; } if( $t_show_project_selector ) { echo '
'; echo '
'; # CSRF protection not required here - form does not result in modifications echo ''; echo ' '; echo ''; echo '
'; echo '
'; echo '
' . $t_now . '
'; } else { echo '
' . $t_now . '
'; } } /** * (12) Print a user-defined banner at the bottom of the page if there is one. * @return null */ 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 * @param string $p_file * @return null */ function html_footer( $p_file = null ) { global $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() && !current_user_is_anonymous() && !( 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 ); } echo "
\n"; echo "\t
\n"; echo "\t
\n"; $t_mantisbt_logo_url = helper_mantis_url( 'images/mantis_logo_button.gif' ); echo "\t\t\"Powered\n"; echo "\t
\n"; # Show optional user-specificed custom copyright statement $t_copyright_statement = config_get( 'copyright_statement' ); if ( $t_copyright_statement ) { echo "\t
$t_copyright_statement
\n"; } # Show MantisBT version and copyright statement $t_version_suffix = ''; $t_copyright_years = ''; if ( config_get( 'show_version' ) ) { $t_version_suffix = htmlentities( ' ' . MANTIS_VERSION . config_get_global( 'version_suffix' ) ); $t_copyright_years = ' 2000 - 2011'; } echo "\t
Powered by Mantis Bug Tracker (MantisBT)$t_version_suffix. Copyright ©$t_copyright_years MantisBT contributors. Licensed under the terms of the GNU General Public License (GPL) version 2 or a later version.
\n"; # Show contact information $t_webmaster_contact_information = sprintf( lang_get( 'webmaster_contact_information' ), string_html_specialchars( config_get( 'webmaster_email' ) ) ); echo "\t
$t_webmaster_contact_information
\n"; event_signal( 'EVENT_LAYOUT_PAGE_FOOTER' ); # Print horizontal rule if any debugging stats follow if ( config_get( 'show_timer' ) || config_get( 'show_memory_usage' ) || config_get( 'show_queries_count' ) ) { echo "\t
\n"; } # Print the page execution time if ( config_get( 'show_timer' ) ) { $t_page_execution_time = sprintf( lang_get( 'page_execution_time' ), number_format( microtime( true ) - $g_request_time, 4 ) ); echo "\t

$t_page_execution_time

\n"; } # Print the page memory usage if ( config_get( 'show_memory_usage' ) ) { $t_page_memory_usage = sprintf( lang_get( 'memory_usage_in_kb' ), number_format( memory_get_peak_usage() / 1024 ) ); echo "\t

$t_page_memory_usage

\n"; } # Determine number of unique queries executed if ( config_get( 'show_queries_count' ) ) { $t_total_queries_count = count( $g_queries_array ); $t_unique_queries_count = 0; $t_total_query_execution_time = 0; $t_unique_queries = array(); for ( $i = 0; $i < $t_total_queries_count; $i++ ) { if ( !in_array( $g_queries_array[$i][0], $t_unique_queries ) ) { $t_unique_queries_count++; $g_queries_array[$i][3] = false; array_push( $t_unique_queries, $g_queries_array[$i][0] ); } else { $g_queries_array[$i][3] = true; } $t_total_query_execution_time += $g_queries_array[$i][1]; } $t_total_queries_executed = sprintf( lang_get( 'total_queries_executed' ), $t_total_queries_count ); echo "\t

$t_total_queries_executed

\n"; if ( config_get_global( 'db_log_queries' ) ) { $t_unique_queries_executed = sprintf( lang_get( 'unique_queries_executed' ), $t_unique_queries_count ); echo "\t

$t_unique_queries_executed

\n"; } $t_total_query_time = sprintf( lang_get( 'total_query_execution_time' ), $t_total_query_execution_time ); echo "\t

$t_total_query_time

\n"; } # Print table of log events log_print_to_page(); echo "
\n"; } /** * (14) End the section * @return null */ function html_body_end() { event_signal( 'EVENT_LAYOUT_BODY_END' ); echo '
', "\n"; echo '', "\n"; } /** * (15) Print the closing tag * @return null */ function html_end() { echo '', "\n"; } /** * Prepare an array of additional menu options from a config variable * @param string $p_config config name * @return array */ 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 = string_html_specialchars( lang_get_defaulted( $t_custom_option[0] ) ); $t_link = string_attribute( $t_custom_option[2] ); $t_options[] = "$t_caption"; } } return $t_options; } /** * Print the main menu * @return null */ function print_menu() { if( auth_is_user_authenticated() ) { $t_protected = current_user_get_field( 'protected' ); $t_current_project = helper_get_current_project(); $t_menu_options = array(); # Main Page $t_menu_options[] = '' . lang_get( 'main_link' ) . ''; # Plugin / Event added options $t_event_menu_options = event_signal( 'EVENT_MENU_MAIN_FRONT' ); foreach( $t_event_menu_options as $t_plugin => $t_plugin_menu_options ) { foreach( $t_plugin_menu_options as $t_callback => $t_callback_menu_options ) { if( is_array( $t_callback_menu_options ) ) { $t_menu_options = array_merge( $t_menu_options, $t_callback_menu_options ); } else { if ( !is_null( $t_callback_menu_options ) ) { $t_menu_options[] = $t_callback_menu_options; } } } } # 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( config_get_global( 'wiki_enable' ) == ON ) { $t_menu_options[] = '' . lang_get( 'wiki' ) . ''; } # Plugin / Event added options $t_event_menu_options = event_signal( 'EVENT_MENU_MAIN' ); foreach( $t_event_menu_options as $t_plugin => $t_plugin_menu_options ) { foreach( $t_plugin_menu_options as $t_callback => $t_callback_menu_options ) { if( is_array( $t_callback_menu_options ) ) { $t_menu_options = array_merge( $t_menu_options, $t_callback_menu_options ); } else { if ( !is_null( $t_callback_menu_options ) ) { $t_menu_options[] = $t_callback_menu_options; } } } } # Manage Users (admins) or Manage Project (managers) or Manage Custom Fields if( access_has_global_level( config_get( 'manage_site_threshold' ) ) ) { $t_link = helper_mantis_url( 'manage_overview_page.php' ); $t_menu_options[] = '' . lang_get( 'manage_link' ) . ''; } else { $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 = helper_mantis_url( '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 = helper_mantis_url( 'manage_proj_edit_page.php?project_id=' ) . $t_current_project; } else { $t_link = helper_mantis_url( 'manage_proj_page.php' ); } } $t_menu_options[] = "" . lang_get( 'manage_link' ) . ''; } } # News Page if ( news_is_enabled() && 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() || current_user_is_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' ) && access_has_global_level( config_get( 'time_tracking_reporting_threshold' ) ) ) { $t_menu_options[] = '' ) . lang_get( 'time_tracking_billing_link' ) . ''; } # Logout (no if anonymously logged in) if( !current_user_is_anonymous() ) { $t_menu_options[] = '' ) . lang_get( 'logout_link' ) . ''; } echo '
' ); echo '
'; # CSRF protection not required here - form does not result in modifications $t_bug_label = lang_get( 'issue_id' ); echo ''; echo ' '; echo ' '; echo '
'; echo '
'; echo '
'; echo '
'; echo ''; echo '
'; echo '
'; } } /** * Print the menu bar with a list of projects to which the user has access * @return null */ function print_project_menu_bar() { $t_project_ids = current_user_get_accessible_projects(); echo ''; echo ''; echo ''; echo ''; echo '
'; echo '' . lang_get( 'all_projects' ) . ''; foreach( $t_project_ids as $t_id ) { echo ' | ' . string_html_specialchars( project_get_field( $t_id, 'name' ) ) . ''; print_subproject_menu_bar( $t_id, $t_id . ';' ); } echo '
'; } /** * Print the menu bar with a list of projects to which the user has access * @return null */ 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 ) { echo $t_char . ' ' . string_html_specialchars( 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 * @return null */ function print_summary_submenu() { # Plugin / Event added options $t_event_menu_options = event_signal( 'EVENT_SUBMENU_SUMMARY' ); $t_menu_options = array(); foreach( $t_event_menu_options as $t_plugin => $t_plugin_menu_options ) { foreach( $t_plugin_menu_options as $t_callback => $t_callback_menu_options ) { if( is_array( $t_callback_menu_options ) ) { $t_menu_options = array_merge( $t_menu_options, $t_callback_menu_options ); } else { if ( !is_null( $t_callback_menu_options ) ) { $t_menu_options[] = $t_callback_menu_options; } } } } echo '
'; echo ''; echo '
'; } /** * Print the menu for the manage section * * @param string $p_page specifies the current page name so it's link can be disabled * @return null */ function print_manage_menu( $p_page = '' ) { if( access_has_global_level( config_get( 'manage_user_threshold' ) ) ) { $t_pages['manage_user_page.php'] = array( 'url' => 'manage_user_page.php', 'label' => 'manage_users_link' ); } if( access_has_project_level( config_get( 'manage_project_threshold' ) ) ) { $t_pages['manage_proj_page.php'] = array( 'url' => 'manage_proj_page.php', 'label' => 'manage_projects_link' ); } if( access_has_project_level( config_get( 'tag_edit_threshold' ) ) ) { $t_pages['manage_tags_page.php'] = array( 'url' => 'manage_tags_page.php', 'label' => 'manage_tags_link' ); } if( access_has_global_level( config_get( 'manage_custom_fields_threshold' ) ) ) { $t_pages['manage_custom_field_page.php'] = array( 'url' => 'manage_custom_field_page.php', 'label' => 'manage_custom_field_link' ); } if( access_has_global_level( config_get( 'manage_global_profile_threshold' ) ) ) { $t_pages['manage_prof_menu_page.php'] = array( 'url' => 'manage_prof_menu_page.php', 'label' => 'manage_global_profiles_link' ); } if( access_has_global_level( config_get( 'manage_plugin_threshold' ) ) ) { $t_pages['manage_plugin_page.php'] = array( 'url' => 'manage_plugin_page.php', 'label' => 'manage_plugin_link' ); } if ( access_has_project_level( config_get( 'manage_configuration_threshold' ) ) ) { if ( access_has_global_level( config_get( 'view_configuration_threshold' ) ) ) { $t_pages['adm_config_report.php'] = array( 'url' => 'adm_config_report.php', 'label' => 'manage_config_link' ); } else { $t_pages['adm_permissions_report.php'] = array( 'url' => 'adm_permissions_report.php', 'label' => 'manage_config_link' ); } } # Remove the link from the current page if ( isset( $t_pages[$p_page] ) ) { $t_pages[$p_page]['url'] = ''; } # Plugin / Event added options $t_event_menu_options = event_signal( 'EVENT_MENU_MANAGE' ); $t_menu_options = array(); foreach( $t_event_menu_options as $t_plugin => $t_plugin_menu_options ) { foreach( $t_plugin_menu_options as $t_callback => $t_callback_menu_options ) { if( is_array( $t_callback_menu_options ) ) { $t_menu_options = array_merge( $t_menu_options, $t_callback_menu_options ); } else { if ( !is_null( $t_callback_menu_options ) ) { $t_menu_options[] = $t_callback_menu_options; } } } } echo '
'; echo ''; echo '
'; } /** * Print the menu for the manage configuration section * @param string $p_page specifies the current page name so it's link can be disabled * @return null */ function print_manage_config_menu( $p_page = '' ) { if ( !access_has_project_level( config_get( 'manage_configuration_threshold' ) ) ) { return; } $t_pages = array(); if ( access_has_global_level( config_get( 'view_configuration_threshold' ) ) ) { $t_pages['adm_config_report.php'] = array( 'url' => 'adm_config_report.php', 'label' => 'configuration_report' ); } $t_pages['adm_permissions_report.php'] = array( 'url' => 'adm_permissions_report.php', 'label' => 'permissions_summary_report' ); $t_pages['manage_config_work_threshold_page.php'] = array( 'url' => 'manage_config_work_threshold_page.php', 'label' => 'manage_threshold_config' ); $t_pages['manage_config_workflow_page.php'] = array( 'url' => 'manage_config_workflow_page.php', 'label' => 'manage_workflow_config' ); if ( config_get( 'relationship_graph_enable' ) ) { $t_pages['manage_config_workflow_graph_page.php'] = array( 'url' => 'manage_config_workflow_graph_page.php', 'label' => 'manage_workflow_graph' ); } $t_pages['manage_config_email_page.php'] = array( 'url' => 'manage_config_email_page.php', 'label' => 'manage_email_config' ); $t_pages['manage_config_columns_page.php'] = array( 'url' => 'manage_config_columns_page.php', 'label' => 'manage_columns_config' ); # Remove the link from the current page if ( isset( $t_pages[$p_page] ) ) { $t_pages[$p_page]['url'] = ''; } # Plugin / Event added options $t_event_menu_options = event_signal( 'EVENT_MENU_MANAGE_CONFIG' ); $t_menu_options = array(); foreach ( $t_event_menu_options as $t_plugin => $t_plugin_menu_options ) { foreach ( $t_plugin_menu_options as $t_callback => $t_callback_menu_options ) { if ( is_array( $t_callback_menu_options ) ) { $t_menu_options = array_merge( $t_menu_options, $t_callback_menu_options ); } else { if ( !is_null( $t_callback_menu_options ) ) { $t_menu_options[] = $t_callback_menu_options; } } } } echo '
'; echo ''; echo '
'; } /** * Print the menu for the account section * @param string $p_page specifies the current page name so it's link can be disabled * @return null */ function print_account_menu( $p_page = '' ) { $t_pages['account_page.php'] = array( 'url'=>'account_page.php', 'label'=>'account_link' ); $t_pages['account_prefs_page.php'] = array( 'url'=>'account_prefs_page.php', 'label'=>'change_preferences_link' ); $t_pages['account_manage_columns_page.php'] = array( 'url'=>'account_manage_columns_page.php', 'label'=>'manage_columns_config' ); if( config_get ( 'enable_profiles' ) == ON && access_has_project_level( config_get( 'add_profile_threshold' ) ) ) { $t_pages['account_prof_menu_page.php'] = array( 'url'=>'account_prof_menu_page.php', 'label'=>'manage_profiles_link' ); } if( config_get( 'enable_sponsorship' ) == ON && access_has_project_level( config_get( 'view_sponsorship_total_threshold' ) ) && !current_user_is_anonymous() ) { $t_pages['account_sponsor_page.php'] = array( 'url'=>'account_sponsor_page.php', 'label'=>'my_sponsorship' ); } # Remove the link from the current page if ( isset( $t_pages[$p_page] ) ) { $t_pages[$p_page]['url'] = ''; } # Plugin / Event added options $t_event_menu_options = event_signal( 'EVENT_MENU_ACCOUNT' ); $t_menu_options = array(); foreach( $t_event_menu_options as $t_plugin => $t_plugin_menu_options ) { foreach( $t_plugin_menu_options as $t_callback => $t_callback_menu_options ) { if( is_array( $t_callback_menu_options ) ) { $t_menu_options = array_merge( $t_menu_options, $t_callback_menu_options ); } else { if ( !is_null( $t_callback_menu_options ) ) { $t_menu_options[] = $t_callback_menu_options; } } } } echo '
'; echo ''; echo '
'; } /** * Print the menu for the docs section * @param string $p_page specifies the current page name so it's link can be disabled * @return null */ function print_doc_menu( $p_page = '' ) { $t_documentation_html = config_get( 'manual_url' ); $t_pages[$t_documentation_html] = array( 'url'=>$t_documentation_html, 'label'=>'user_documentation' ); $t_pages['proj_doc_page.php'] = array( 'url'=>'proj_doc_page.php', 'label'=>'project_documentation' ); if( file_allow_project_upload() ) { $t_pages['proj_doc_add_page.php'] = array( 'url'=>'proj_doc_add_page.php', 'label'=>'add_file' ); } # Remove the link from the current page if ( isset( $t_pages[$p_page] ) ) { $t_pages[$p_page]['url'] = ''; } echo '
'; echo ''; echo '
'; } /** * Print the menu for the summary section * @param string $p_page specifies the current page name so it's link can be disabled * @return null */ function print_summary_menu( $p_page = '' ) { # Plugin / Event added options $t_event_menu_options = event_signal( 'EVENT_MENU_SUMMARY' ); $t_menu_options = array(); foreach( $t_event_menu_options as $t_plugin => $t_plugin_menu_options ) { foreach( $t_plugin_menu_options as $t_callback => $t_callback_menu_options ) { if( is_array( $t_callback_menu_options ) ) { $t_menu_options = array_merge( $t_menu_options, $t_callback_menu_options ); } else { if ( !is_null( $t_callback_menu_options ) ) { $t_menu_options[] = $t_callback_menu_options; } } } } $t_pages['print_all_bug_page.php'] = array( 'url'=>'print_all_bug_page.php', 'label'=>'print_all_bug_page_link' ); $t_pages['summary_page.php'] = array( 'url'=>'summary_page.php', 'label'=>'summary_link' ); # Remove the link from the current page if ( isset( $t_pages[$p_page] ) ) { $t_pages[$p_page]['url'] = ''; } echo '
'; echo ''; echo '
'; } /** * Print the color legend for the status colors * @param string * @return null */ function html_status_legend() { # Don't show the legend if only one status is selected by the current filter $t_current_filter = current_user_get_bug_filter(); if ( $t_current_filter === false ) { $t_current_filter = filter_get_default(); } $t_simple_filter = $t_current_filter['_view_type'] == 'simple'; if( $t_simple_filter ) { if( !filter_field_is_any( $t_current_filter[FILTER_PROPERTY_STATUS][0] ) ) { return null; } } $t_status_array = MantisEnum::getAssocArrayIndexedByValues( config_get( 'status_enum_string' ) ); $t_status_names = MantisEnum::getAssocArrayIndexedByValues( lang_get( 'status_enum_string' ) ); $enum_count = count( $t_status_array ); # read through the list and eliminate unused ones for the selected project # assumes that all status are are in the enum array $t_workflow = config_get( 'status_enum_workflow' ); if( !empty( $t_workflow ) ) { foreach( $t_status_array as $t_status => $t_name ) { if( !isset( $t_workflow[$t_status] ) ) { # drop elements that are not in the workflow unset( $t_status_array[$t_status] ); } } } # Remove status values that won't appear as a result of the current filter foreach( $t_status_array as $t_status => $t_name ) { if( $t_simple_filter ) { if( !filter_field_is_none( $t_current_filter[FILTER_PROPERTY_HIDE_STATUS][0] ) && $t_status >= $t_current_filter[FILTER_PROPERTY_HIDE_STATUS][0] ) { unset( $t_status_array[$t_status] ); } } else { if( !in_array( META_FILTER_ANY, $t_current_filter[FILTER_PROPERTY_STATUS] ) && !in_array( $t_status, $t_current_filter[FILTER_PROPERTY_STATUS] ) ) { unset( $t_status_array[$t_status] ); } } } # If there aren't at least two statuses showable by the current filter, # don't draw the status bar if( count( $t_status_array ) <= 1 ) { return null; } echo '
'; echo ''; echo ''; # draw the status bar $width = (int)( 100 / count( $t_status_array ) ); $t_status_enum_string = config_get('status_enum_string' ); foreach( $t_status_array as $t_status => $t_name ) { $t_val = $t_status_names[$t_status]; $t_status_label = MantisEnum::getLabel( $t_status_enum_string, $t_status ); echo ""; } echo ''; echo '
$t_val
'; if( ON == config_get( 'status_percentage_legend' ) ) { html_status_percentage_legend(); } } /** * Print the legend for the status percentage * @return null */ function html_status_percentage_legend() { $t_status_percents = get_percentage_by_status(); $t_status_enum_string = config_get('status_enum_string' ); $t_enum_values = MantisEnum::getValues( $t_status_enum_string ); $enum_count = count( $t_enum_values ); $t_bug_count = array_sum( $t_status_percents ); if( $t_bug_count > 0 ) { echo '
'; echo ''; echo ''; echo ''; echo ''; echo ''; foreach ( $t_enum_values as $t_status ) { $t_percent = ( isset( $t_status_percents[$t_status] ) ? $t_status_percents[$t_status] : 0 ); if( $t_percent > 0 ) { $t_status_label = MantisEnum::getLabel( $t_status_enum_string, $t_status ); echo ""; } } echo ''; echo '
' . lang_get( 'issue_status_percentage' ) . '
$t_percent%
'; } } /** * Print an html button inside a form * @param string $p_action * @param string $p_buttion_text * @param array $p_fields * @param string $p_method * @return null */ function html_button( $p_action, $p_button_text, $p_fields = null, $p_method = 'post' ) { $t_form_name = explode( '.php', $p_action, 2 ); $p_action = urlencode( $p_action ); $p_button_text = string_attribute( $p_button_text ); if( null === $p_fields ) { $p_fields = array(); } if( utf8_strtolower( $p_method ) == 'get' ) { $t_method = 'get'; } else { $t_method = 'post'; } echo "
\n"; echo "\t
"; # Add a CSRF token only when the form is being sent via the POST method if ( $t_method == 'post' ) { echo form_security_field( $t_form_name[0] ); } foreach( $p_fields as $key => $val ) { $key = string_attribute( $key ); $val = string_attribute( $val ); echo "\t\t\n"; } echo "\t\t\n"; echo "\t
"; echo "
\n"; } /** * Print a button to update the given bug * @param int $p_bug_id * @return null */ function html_button_bug_update( $p_bug_id ) { if( access_has_bug_level( config_get( 'update_bug_threshold' ), $p_bug_id ) ) { html_button( string_get_bug_update_page(), lang_get( 'update_bug_button' ), array( 'bug_id' => $p_bug_id ) ); } } /** * Print Change Status to: button * This code is similar to print_status_option_list except * there is no masking, except for the current state * * @param int $p_bug_id * @return null */ function html_button_bug_change_status( $p_bug_id ) { $t_bug_project_id = bug_get_field( $p_bug_id, 'project_id' ); $t_bug_current_state = bug_get_field( $p_bug_id, 'status' ); $t_current_access = access_get_project_level( $t_bug_project_id ); $t_enum_list = get_status_option_list( $t_current_access, $t_bug_current_state, false, ( bug_get_field( $p_bug_id, 'reporter_id' ) == auth_get_current_user_id() && ( ON == config_get( 'allow_reporter_close' ) ) ), $t_bug_project_id ); if( count( $t_enum_list ) > 0 ) { # resort the list into ascending order after noting the key from the first element (the default) $t_default_arr = each( $t_enum_list ); $t_default = $t_default_arr['key']; ksort( $t_enum_list ); reset( $t_enum_list ); echo "
"; # CSRF protection not required here - form does not result in modifications $t_button_text = lang_get( 'bug_status_to_button' ); echo ""; echo " '; $t_bug_id = string_attribute( $p_bug_id ); echo "\n"; echo "
\n"; } } /** * Print Assign To: combo box of possible handlers * @param int $p_bug_id * @return null */ function html_button_bug_assign_to( $p_bug_id ) { # make sure status is allowed of assign would cause auto-set-status $t_status = bug_get_field( $p_bug_id, 'status' ); # workflow implementation if( ON == config_get( 'auto_set_status_to_assigned' ) && !bug_check_workflow( $t_status, config_get( 'bug_assigned_status' ) ) ) { # workflow return; } # make sure current user has access to modify bugs. if( !access_has_bug_level( config_get( 'update_bug_assign_threshold', config_get( 'update_bug_threshold' ) ), $p_bug_id ) ) { return; } $t_reporter_id = bug_get_field( $p_bug_id, 'reporter_id' ); $t_handler_id = bug_get_field( $p_bug_id, 'handler_id' ); $t_current_user_id = auth_get_current_user_id(); $t_new_status = ( ON == config_get( 'auto_set_status_to_assigned' ) ) ? config_get( 'bug_assigned_status' ) : $t_status; $t_options = array(); $t_default_assign_to = null; if(( $t_handler_id != $t_current_user_id ) && ( access_has_bug_level( config_get( 'handle_bug_threshold' ), $p_bug_id, $t_current_user_id ) ) ) { $t_options[] = array( $t_current_user_id, '[' . lang_get( 'myself' ) . ']', ); $t_default_assign_to = $t_current_user_id; } if(( $t_handler_id != $t_reporter_id ) && user_exists( $t_reporter_id ) && ( access_has_bug_level( config_get( 'handle_bug_threshold' ), $p_bug_id, $t_reporter_id ) ) ) { $t_options[] = array( $t_reporter_id, '[' . lang_get( 'reporter' ) . ']', ); if( $t_default_assign_to === null ) { $t_default_assign_to = $t_reporter_id; } } echo "
"; echo form_security_field( 'bug_update' ); $t_button_text = lang_get( 'bug_assign_to_button' ); echo ""; echo " "; $t_bug_id = string_attribute( $p_bug_id ); echo "\n"; echo "
\n"; } /** * Print a button to move the given bug to a different project * @param int $p_bug_id * @return null */ function html_button_bug_move( $p_bug_id ) { if( access_has_bug_level( config_get( 'move_bug_threshold' ), $p_bug_id ) ) { html_button( 'bug_actiongroup_page.php', lang_get( 'move_bug_button' ), array( 'bug_arr[]' => $p_bug_id, 'action' => 'MOVE' ) ); } } /** * Print a button to move the given bug to a different project * @param int $p_bug_id * @return null */ function html_button_bug_create_child( $p_bug_id ) { if( access_has_bug_level( config_get( 'update_bug_threshold' ), $p_bug_id ) ) { html_button( string_get_bug_report_url(), lang_get( 'create_child_bug_button' ), array( 'm_id' => $p_bug_id ) ); } } /** * Print a button to reopen the given bug * @param int $p_bug_id * @return null */ function html_button_bug_reopen( $p_bug_id ) { $t_status = bug_get_field( $p_bug_id, 'status' ); $t_project = bug_get_field( $p_bug_id, 'project_id' ); $t_reopen_status = config_get( 'bug_reopen_status', null, null, $t_project ); if( access_has_bug_level( config_get( 'reopen_bug_threshold', null, null, $t_project ), $p_bug_id ) || (( bug_get_field( $p_bug_id, 'reporter_id' ) == auth_get_current_user_id() ) && ( ON == config_get( 'allow_reporter_reopen', null, null, $t_project ) ) ) ) { html_button( 'bug_change_status_page.php', lang_get( 'reopen_bug_button' ), array( 'id' => $p_bug_id, 'new_status' => $t_reopen_status, 'reopen_flag' => ON ) ); } } /** * Print a button to monitor the given bug * @param int $p_bug_id * @return null */ function html_button_bug_monitor( $p_bug_id ) { if( access_has_bug_level( config_get( 'monitor_bug_threshold' ), $p_bug_id ) ) { html_button( 'bug_monitor_add.php', lang_get( 'monitor_bug_button' ), array( 'bug_id' => $p_bug_id ) ); } } /** * Print a button to unmonitor the given bug * no reason to ever disallow someone from unmonitoring a bug * @param int $p_bug_id * @return null */ function html_button_bug_unmonitor( $p_bug_id ) { html_button( 'bug_monitor_delete.php', lang_get( 'unmonitor_bug_button' ), array( 'bug_id' => $p_bug_id ) ); } /** * Print a button to stick the given bug * @param int $p_bug_id * @return null */ function html_button_bug_stick( $p_bug_id ) { if ( access_has_bug_level( config_get( 'set_bug_sticky_threshold' ), $p_bug_id ) ) { html_button( 'bug_stick.php', lang_get( 'stick_bug_button' ), array( 'bug_id' => $p_bug_id, 'action' => 'stick' ) ); } } /** * Print a button to unstick the given bug * @param int $p_bug_id * @return null */ function html_button_bug_unstick( $p_bug_id ) { if ( access_has_bug_level( config_get( 'set_bug_sticky_threshold' ), $p_bug_id ) ) { html_button( 'bug_stick.php', lang_get( 'unstick_bug_button' ), array( 'bug_id' => $p_bug_id, 'action' => 'unstick' ) ); } } /** * Print a button to delete the given bug * @param int $p_bug_id * @return null */ function html_button_bug_delete( $p_bug_id ) { if( access_has_bug_level( config_get( 'delete_bug_threshold' ), $p_bug_id ) ) { html_button( 'bug_actiongroup_page.php', lang_get( 'delete_bug_button' ), array( 'bug_arr[]' => $p_bug_id, 'action' => 'DELETE' ) ); } } /** * Print a button to create a wiki page * @param int $p_bug_id * @return null */ function html_button_wiki( $p_bug_id ) { if( config_get_global( 'wiki_enable' ) == ON ) { if( access_has_bug_level( config_get( 'update_bug_threshold' ), $p_bug_id ) ) { html_button( 'wiki.php', lang_get_defaulted( 'Wiki' ), array( 'id' => $p_bug_id, 'type' => 'issue' ), 'get' ); } } } /** * Print all buttons for view bug pages * @param int $p_bug_id * @return null */ function html_buttons_view_bug_page( $p_bug_id ) { $t_resolved = config_get( 'bug_resolved_status_threshold' ); $t_status = bug_get_field( $p_bug_id, 'status' ); $t_readonly = bug_is_readonly( $p_bug_id ); $t_sticky = config_get( 'set_bug_sticky_threshold' ); echo ''; if( !$t_readonly ) { # UPDATE button echo ''; # ASSIGN button echo ''; } # Change status button/dropdown if ( !$t_readonly || config_get( 'allow_reporter_close' ) ) { echo ''; } # MONITOR/UNMONITOR button if( !current_user_is_anonymous() ) { echo ''; } # STICK/UNSTICK button if ( access_has_bug_level( $t_sticky, $p_bug_id ) ) { echo ''; } if( !$t_readonly ) { # CREATE CHILD button echo ''; } if( $t_resolved <= $t_status ) { # resolved is not the same as readonly echo ''; } # MOVE button echo ''; # DELETE button echo ''; helper_call_custom_function( 'print_bug_view_page_custom_buttons', array( $p_bug_id ) ); echo '
'; html_button_bug_update( $p_bug_id ); echo ''; html_button_bug_assign_to( $p_bug_id ); echo ''; html_button_bug_change_status( $p_bug_id ); echo ''; if( user_is_monitoring_bug( auth_get_current_user_id(), $p_bug_id ) ) { html_button_bug_unmonitor( $p_bug_id ); } else { html_button_bug_monitor( $p_bug_id ); } echo ''; if ( !bug_get_field( $p_bug_id, 'sticky' ) ) { html_button_bug_stick( $p_bug_id ); } else { html_button_bug_unstick( $p_bug_id ); } echo ''; html_button_bug_create_child( $p_bug_id ); echo ''; # REOPEN button html_button_bug_reopen( $p_bug_id ); echo ''; html_button_bug_move( $p_bug_id ); echo ''; html_button_bug_delete( $p_bug_id ); echo '
'; } /** * get the css class name for the given status * @param int $p_status * @return string */ function html_get_status_css_class( $p_status ) { return string_attribute( MantisEnum::getLabel( config_get('status_enum_string' ), $p_status ) . '-color' ); }