From: <nuc...@us...> - 2007-11-09 15:59:52
|
Revision: 4729 http://mantisbt.svn.sourceforge.net/mantisbt/?rev=4729&view=rev Author: nuclear_eclipse Date: 2007-11-09 07:59:40 -0800 (Fri, 09 Nov 2007) Log Message: ----------- Modified event names to match final specification. Added menu item events to declaration. Implemented main menu event hook. Added copyright notice to event declaration page. Modified Paths: -------------- trunk/mantisbt/core/events_inc.php trunk/mantisbt/core/html_api.php trunk/mantisbt/core/string_api.php Modified: trunk/mantisbt/core/events_inc.php =================================================================== --- trunk/mantisbt/core/events_inc.php 2007-11-09 00:17:52 UTC (rev 4728) +++ trunk/mantisbt/core/events_inc.php 2007-11-09 15:59:40 UTC (rev 4729) @@ -1,37 +1,57 @@ <?php +# Mantis - a php based bugtracking system +# Copyright (C) 2000 - 2002 Kenzaburo Ito - ke...@30... +# Copyright (C) 2002 - 2007 Mantis Team - man...@li...urceforge. + +# 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/>. + +# -------------------------------------------------------- +# $Id: $ +# -------------------------------------------------------- + +# +# Event Declarations +# Please view the Plugin Events Reference for details on each event. +# http://www.mantisbt.org/wiki/doku.php/mantisbt:plugins_events +# + # Declare supported plugin events event_declare_many( array( ##### Events specific to plugins ##### + 'EVENT_PLUGIN_INIT' => EVENT_TYPE_EXECUTE, - # Called when all plugins have been initialized - 'EVENT_PLUGIN_INIT' => EVENT_TYPE_EXECUTE, + ##### Mantis Layout Events ##### + 'EVENT_LAYOUT_RESOURCES' => EVENT_TYPE_OUTPUT, + 'EVENT_LAYOUT_PAGE_HEADER' => EVENT_TYPE_OUTPUT, + 'EVENT_LAYOUT_CONTENT_BEGIN' => EVENT_TYPE_OUTPUT, + 'EVENT_LAYOUT_CONTENT_END' => EVENT_TYPE_OUTPUT, + 'EVENT_LAYOUT_PAGE_FOOTER' => EVENT_TYPE_OUTPUT, - ##### Events for processing data ##### + ##### Events for displaying data ##### + 'EVENT_DISPLAY_GENERAL' => EVENT_TYPE_CHAIN, + 'EVENT_DISPLAY_GENERAL_LINKS' => EVENT_TYPE_CHAIN, + 'EVENT_DISPLAY_RSS' => EVENT_TYPE_CHAIN, - # Called to process generic strings for output - 'EVENT_TEXT_GENERAL' => EVENT_TYPE_CHAIN, - - # Called to process strings with linkable content - 'EVENT_TEXT_LINKS' => EVENT_TYPE_CHAIN, - - # Called to process RSS output - 'EVENT_TEXT_RSS' => EVENT_TYPE_CHAIN, + ##### Menu Events ##### + 'EVENT_MENU_MAIN' => EVENT_TYPE_DEFAULT, + 'EVENT_MENU_MANAGE' => EVENT_TYPE_DEFAULT, + 'EVENT_MENU_MANAGE_CONFIG' => EVENT_TYPE_DEFAULT, + 'EVENT_MENU_SUMMARY' => EVENT_TYPE_DEFAULT, + 'EVENT_MENU_DOCS' => EVENT_TYPE_DEFAULT, + 'EVENT_MENU_ACCOUNT' => EVENT_TYPE_DEFAULT, - ##### Events for layout additions ##### - - # Called just before ending the <head> tag - 'EVENT_PAGE_HEAD' => EVENT_TYPE_OUTPUT, - - # Called after the page logo has been included - 'EVENT_PAGE_TOP' => EVENT_TYPE_OUTPUT, - - # Called before the page footer - 'EVENT_PAGE_BOTTOM' => EVENT_TYPE_OUTPUT, - - # Called just before ending the <body> tag - 'EVENT_PAGE_END' => EVENT_TYPE_OUTPUT, - ) ); Modified: trunk/mantisbt/core/html_api.php =================================================================== --- trunk/mantisbt/core/html_api.php 2007-11-09 00:17:52 UTC (rev 4728) +++ trunk/mantisbt/core/html_api.php 2007-11-09 15:59:40 UTC (rev 4729) @@ -136,6 +136,8 @@ } } print_menu(); + + event_signal( 'EVENT_LAYOUT_CONTENT_BEGIN' ); } # -------------------- @@ -161,6 +163,8 @@ return; } + event_signal( 'EVENT_LAYOUT_CONTENT_END' ); + if ( config_get( 'show_footer_menu' ) ) { PRINT '<br />'; print_menu(); @@ -283,7 +287,7 @@ # -------------------- # (7) End the <head> section function html_head_end() { - event_signal( 'EVENT_PAGE_HEAD' ); + event_signal( 'EVENT_LAYOUT_RESOURCES' ); echo '</head>', "\n"; } @@ -320,7 +324,7 @@ echo '</div>'; } - event_signal( 'EVENT_PAGE_TOP' ); + event_signal( 'EVENT_LAYOUT_PAGE_HEADER' ); } # -------------------- @@ -393,8 +397,6 @@ if ( !is_blank( $t_page ) && file_exists( $t_page ) && !is_dir( $t_page ) ) { include( $t_page ); } - - event_signal( 'EVENT_PAGE_BOTTOM' ); } # -------------------- @@ -480,7 +482,7 @@ # -------------------- # (14) End the <body> section function html_body_end() { - event_signal( 'EVENT_PAGE_END' ); + event_signal( 'EVENT_LAYOUT_PAGE_FOOTER' ); echo '</body>', "\n"; } @@ -563,6 +565,16 @@ $t_menu_options[] = '<a href="wiki.php?type=project&id=' . $t_current_project . '">' . lang_get( 'wiki' ) . '</a>'; } + # Plugin / Event added options + $t_event_menu_options = event_signal( 'EVENT_MENU_MAIN' ); + foreach ( $t_event_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 { + $t_menu_options[] = $t_callback_menu_options; + } + } + # Manage Users (admins) or Manage Project (managers) or Manage Custom Fields $t_show_access = min( config_get( 'manage_user_threshold' ), config_get( 'manage_project_threshold' ), config_get( 'manage_custom_fields_threshold' ) ); if ( access_has_global_level( $t_show_access) || access_has_any_project( $t_show_access ) ) { Modified: trunk/mantisbt/core/string_api.php =================================================================== --- trunk/mantisbt/core/string_api.php 2007-11-09 00:17:52 UTC (rev 4728) +++ trunk/mantisbt/core/string_api.php 2007-11-09 15:59:40 UTC (rev 4729) @@ -101,7 +101,7 @@ $p_string = string_preserve_spaces_at_bol( $p_string ); $p_string = string_nl2br( $p_string ); - return event_signal( 'EVENT_TEXT_GENERAL', $p_string ); + return event_signal( 'EVENT_DISPLAY_GENERAL', $p_string ); } # -------------------- @@ -111,7 +111,7 @@ $p_string = string_html_specialchars( $p_string ); $p_string = string_restore_valid_html_tags( $p_string, /* multiline = */ false ); - return event_signal( 'EVENT_TEXT_GENERAL', $p_string ); + return event_signal( 'EVENT_DISPLAY_GENERAL', $p_string ); } # -------------------- @@ -124,7 +124,7 @@ $p_string = string_process_bugnote_link( $p_string ); $p_string = string_process_cvs_link( $p_string ); - return event_signal( 'EVENT_TEXT_LINKS', $p_string ); + return event_signal( 'EVENT_DISPLAY_GENERAL_LINKS', $p_string ); } # -------------------- @@ -137,7 +137,7 @@ $p_string = string_process_bugnote_link( $p_string ); $p_string = string_process_cvs_link( $p_string ); - return event_signal( 'EVENT_TEXT_LINKS', $p_string ); + return event_signal( 'EVENT_DISPLAY_GENERAL_LINKS', $p_string ); } # -------------------- @@ -156,7 +156,7 @@ $t_string = string_process_bugnote_link( $t_string, /* anchor */ true, /* detailInfo */ false, /* fqdn */ true ); $t_string = string_process_cvs_link( $t_string ); - $t_string = event_signal( 'EVENT_TEXT_RSS', $t_string ); + $t_string = event_signal( 'EVENT_DISPLAY_RSS', $t_string ); # another escaping to escape the special characters created by the generated links return string_html_specialchars( $t_string ); This was sent by the SourceForge.net collaborative development platform, the world's largest Open Source development site. |
From: <pri...@us...> - 2007-11-11 13:06:08
|
Revision: 4744 http://mantisbt.svn.sourceforge.net/mantisbt/?rev=4744&view=rev Author: prichards Date: 2007-11-11 05:05:45 -0800 (Sun, 11 Nov 2007) Log Message: ----------- Fix: 0007463: Issue with many child issues produced performance problem Add a bug_cache_array_rows function which instead of taking a bug id to cache, takes a simple array of id's. Unlike bug_cache_row, this function does not return a result set - it simply populates the cache table for a batch of bug id's. Modified Paths: -------------- trunk/mantisbt/core/bug_api.php trunk/mantisbt/core/relationship_api.php Modified: trunk/mantisbt/core/bug_api.php =================================================================== --- trunk/mantisbt/core/bug_api.php 2007-11-11 10:14:09 UTC (rev 4743) +++ trunk/mantisbt/core/bug_api.php 2007-11-11 13:05:45 UTC (rev 4744) @@ -150,6 +150,34 @@ return $row; } + function bug_cache_array_rows( $p_bug_id_array ) { + global $g_cache_bug; + $c_bug_id_array = array(); + + foreach( $p_bug_id_array as $t_bug_id ) { + if ( !isset( $g_cache_bug[(int)$t_bug_id] ) ) { + $c_bug_id_array[] = (int)$t_bug_id; + } + } + + if( empty( $c_bug_id_array ) ) + return; + + $t_bug_table = config_get_global( 'mantis_bug_table' ); + + $query = "SELECT * + FROM $t_bug_table + WHERE id IN (" . implode( ',', $c_bug_id_array ) . ')'; + $result = db_query( $query ); + + while ( $row = db_fetch_array( $result ) ) { + $row['date_submitted'] = db_unixtimestamp( $row['date_submitted'] ); + $row['last_updated'] = db_unixtimestamp( $row['last_updated'] ); + $g_cache_bug[(int)$row['id']] = $row; + } + return; + } + # -------------------- # Inject a bug into the bug cache function bug_add_to_cache( $p_bug_row ) { Modified: trunk/mantisbt/core/relationship_api.php =================================================================== --- trunk/mantisbt/core/relationship_api.php 2007-11-11 10:14:09 UTC (rev 4743) +++ trunk/mantisbt/core/relationship_api.php 2007-11-11 13:05:45 UTC (rev 4744) @@ -295,6 +295,7 @@ $t_bug_relationship_data = array( new BugRelationshipData ); $t_relationship_count = db_num_rows( $result ); + $t_bug_array = Array(); for ( $i = 0 ; $i < $t_relationship_count ; $i++ ) { $row = db_fetch_array( $result ); $t_bug_relationship_data[$i]->id = $row['id']; @@ -303,8 +304,12 @@ $t_bug_relationship_data[$i]->dest_bug_id = $row['destination_bug_id']; $t_bug_relationship_data[$i]->dest_project_id = $row['project_id']; $t_bug_relationship_data[$i]->type = $row['relationship_type']; + $t_bug_array[] = $row['destination_bug_id']; + } unset( $t_bug_relationship_data[$t_relationship_count] ); + if (!empty( $t_bug_array ) ) + bug_cache_array_rows ( $t_bug_array ); return $t_bug_relationship_data; } @@ -329,6 +334,7 @@ $t_bug_relationship_data = array( new BugRelationshipData ); $t_relationship_count = db_num_rows( $result ); + $t_bug_array = Array(); for ( $i = 0 ; $i < $t_relationship_count ; $i++ ) { $row = db_fetch_array( $result ); $t_bug_relationship_data[$i]->id = $row['id']; @@ -337,9 +343,12 @@ $t_bug_relationship_data[$i]->dest_bug_id = $row['destination_bug_id']; $t_bug_relationship_data[$i]->dest_project_id = $t_dest_project_id; $t_bug_relationship_data[$i]->type = $row['relationship_type']; + $t_bug_array[] = $row['source_bug_id']; } unset( $t_bug_relationship_data[$t_relationship_count] ); + if (!empty( $t_bug_array ) ) + bug_cache_array_rows ( $t_bug_array ); return $t_bug_relationship_data; } This was sent by the SourceForge.net collaborative development platform, the world's largest Open Source development site. |
From: <nuc...@us...> - 2007-11-20 01:04:22
|
Revision: 4769 http://mantisbt.svn.sourceforge.net/mantisbt/?rev=4769&view=rev Author: nuclear_eclipse Date: 2007-11-19 17:04:16 -0800 (Mon, 19 Nov 2007) Log Message: ----------- Fix: #8263 Improve email address recognition. Used new, more compliant email regex to find and replace addresses in a comment or description. Modified Paths: -------------- trunk/mantisbt/core/email_api.php trunk/mantisbt/core/string_api.php Modified: trunk/mantisbt/core/email_api.php =================================================================== --- trunk/mantisbt/core/email_api.php 2007-11-19 22:06:49 UTC (rev 4768) +++ trunk/mantisbt/core/email_api.php 2007-11-20 01:04:16 UTC (rev 4769) @@ -42,6 +42,14 @@ # Email API ########################################################################### + # Use a simple perl regex for valid email addresses. This is not a complete regex, + # as it does not cover quoted addresses or domain literals, but it is simple and + # covers the vast majority of all email addresses without being overly complex. + # Callers must surround this with appropriate delimiters with case insentive options. + function email_regex_simple() { + return "(([a-z0-9!#*+\/=?^_{|}~-]+(?:\.[a-z0-9!#*+\/=?^_{|}~-]+)*)" . # recipient + "\@((?:[a-z0-9](?:[a-z0-9-]*[a-z0-9])?\.)+[a-z0-9](?:[a-z0-9-]*[a-z0-9])?))"; # @domain + } # -------------------- # Return a perl compatible regular expression that will Modified: trunk/mantisbt/core/string_api.php =================================================================== --- trunk/mantisbt/core/string_api.php 2007-11-19 22:06:49 UTC (rev 4768) +++ trunk/mantisbt/core/string_api.php 2007-11-20 01:04:16 UTC (rev 4769) @@ -391,35 +391,8 @@ ini_set( 'magic_quotes_sybase', true ); } - # Set up a simple subset of RFC 822 email address parsing - # We don't allow domain literals or quoted strings - # We also don't allow the & character in domains even though the RFC - # appears to do so. This was to prevent > etc from being included. - # Note: we could use email_get_rfc822_regex() but it doesn't work well - # when applied to data that has already had entities inserted. - # - # bpfennig: '@' doesn't accepted anymore - # achumakov: characters 0x80-0xFF aren't acceptable, too - $t_atom = '[^\'@\'](?:[^()<>@,;:\\\".\[\]\000-\037\177-\377 &]+)'; - - # In order to avoid selecting URLs containing @ characters as email - # addresses we limit our selection to addresses that are preceded by: - # * the beginning of the string - # * a < entity (allowing '<fo...@ba...z>') - # * whitespace - # * a : (allowing 'send email to:fo...@ba...z') - # * a \n, \r, or > (because newlines have been replaced with <br /> - # and > isn't valid in URLs anyway - # - # At the end of the string we allow the opposite: - # * the end of the string - # * a > entity - # * whitespace - # * a , character (allowing 'email fo...@ba...z, or ...') - # * a \n, \r, or < - - $p_string = preg_replace( '/(?<=^|"|<|[\s\:\>\n\r])('.$t_atom.'(?:\.'.$t_atom.')*\@'.$t_atom.'(?:\.'.$t_atom.')*)(?=$|"|>|[\s\,\<\n\r])/s', - '<a href="mailto:\1">\1</a>', + $p_string = preg_replace( '/\b' . email_regex_simple() . '\b/i', + '<a href="mailto:\0">\0</a>', $p_string); return $p_string; This was sent by the SourceForge.net collaborative development platform, the world's largest Open Source development site. |
From: <nuc...@us...> - 2007-11-28 21:03:19
|
Revision: 4804 http://mantisbt.svn.sourceforge.net/mantisbt/?rev=4804&view=rev Author: nuclear_eclipse Date: 2007-11-28 13:02:54 -0800 (Wed, 28 Nov 2007) Log Message: ----------- Fix: config_set_cache() did not set option type, breaking subsequent config_get() calls. Modified Paths: -------------- trunk/mantisbt/core/config_api.php trunk/mantisbt/core/project_api.php Modified: trunk/mantisbt/core/config_api.php =================================================================== --- trunk/mantisbt/core/config_api.php 2007-11-28 19:35:14 UTC (rev 4803) +++ trunk/mantisbt/core/config_api.php 2007-11-28 21:02:54 UTC (rev 4804) @@ -325,7 +325,7 @@ $result = db_query( $t_set_query ); } - config_set_cache( $p_option, $p_value, $p_user, $p_project, $p_access ); + config_set_cache( $p_option, $p_value, $t_type, $p_user, $p_project, $p_access ); return true; } @@ -333,9 +333,9 @@ # ------------------ # Sets the value of the given config option to the given value # If the config option does not exist, an ERROR is triggered - function config_set_cache( $p_option, $p_value, $p_user = NO_USER, $p_project = ALL_PROJECTS, $p_access = ADMINISTRATOR ) { + function config_set_cache( $p_option, $p_value, $p_type, $p_user = NO_USER, $p_project = ALL_PROJECTS, $p_access = ADMINISTRATOR ) { global $g_cache_config, $g_cache_config_access; - $g_cache_config[$p_option][$p_user][$p_project] = $p_value; + $g_cache_config[$p_option][$p_user][$p_project] = $p_type . ';' . $p_value; $g_cache_config_access[$p_option][$p_user][$p_project] = $p_access; return true; Modified: trunk/mantisbt/core/project_api.php =================================================================== --- trunk/mantisbt/core/project_api.php 2007-11-28 19:35:14 UTC (rev 4803) +++ trunk/mantisbt/core/project_api.php 2007-11-28 21:02:54 UTC (rev 4804) @@ -249,7 +249,7 @@ function project_delete( $p_project_id ) { $t_email_notifications = config_get( 'enable_email_notification' ); # temporarily disable all notifications - config_set_cache( 'enable_email_notification', OFF ); + config_set_cache( 'enable_email_notification', OFF, CONFIG_TYPE_INT ); $c_project_id = db_prepare_int( $p_project_id ); @@ -291,7 +291,7 @@ db_query_bound( $query, Array( $c_project_id ) ); - config_set_cache( 'enable_email_notification', $t_email_notifications ); + config_set_cache( 'enable_email_notification', $t_email_notifications, CONFIG_TYPE_INT ); project_clear_cache( $p_project_id ); This was sent by the SourceForge.net collaborative development platform, the world's largest Open Source development site. |
From: <nuc...@us...> - 2007-11-30 16:11:25
|
Revision: 4805 http://mantisbt.svn.sourceforge.net/mantisbt/?rev=4805&view=rev Author: nuclear_eclipse Date: 2007-11-30 08:11:22 -0800 (Fri, 30 Nov 2007) Log Message: ----------- Added config_set_global() to config API for plugin system. Implemented plugin configuration handling, with default and explicit configuration options. Minor sanity check in plugin API. Modified Paths: -------------- trunk/mantisbt/core/config_api.php trunk/mantisbt/core/plugin_api.php Modified: trunk/mantisbt/core/config_api.php =================================================================== --- trunk/mantisbt/core/config_api.php 2007-11-28 21:02:54 UTC (rev 4804) +++ trunk/mantisbt/core/config_api.php 2007-11-30 16:11:22 UTC (rev 4805) @@ -329,6 +329,18 @@ return true; } + + # ------------------ + # Sets the value of the given config option in the global namespace. + # Does *not* persist the value between sessions. If override set to + # false, then the value will only be set if not already existent. + function config_set_global( $p_option, $p_value, $p_override=true ) { + if ( $p_override || !isset( $GLOBALS['g_' . $p_option] ) ) { + $GLOBALS['g_' . $p_option] = $p_value; + } + + return true; + } # ------------------ # Sets the value of the given config option to the given value Modified: trunk/mantisbt/core/plugin_api.php =================================================================== --- trunk/mantisbt/core/plugin_api.php 2007-11-28 21:02:54 UTC (rev 4804) +++ trunk/mantisbt/core/plugin_api.php 2007-11-30 16:11:22 UTC (rev 4805) @@ -157,6 +157,56 @@ } } +/** + * Get a plugin configuration option. + * @param string Configuration option name + * @param multi Default option value + */ +function plugin_config_get( $p_option, $p_default=null, $p_global=false ) { + $t_basename = plugin_get_current(); + $t_full_option = 'plugin_' . $t_basename . '_' . $p_option; + + if ( $p_global ) { + return config_get_global( $t_full_option, $p_default ); + } else { + return config_get( $t_full_option, $p_default ); + } +} + +/** + * Set a plugin configuration option in the database. + * @param string Configuration option name + * @param multi Option value + * @param int User ID + * @param int Project ID + * @param int Access threshold + */ +function plugin_config_set( $p_option, $p_value, $p_user=NO_USER, $p_project=ALL_PROJECTS, $p_access=ADMINISTRATOR ) { + $t_basename = plugin_get_current(); + $t_full_option = 'plugin_' . $t_basename . '_' . $p_option; + + config_set( $t_full_option, $p_value, $p_user, $p_project, $p_access ); +} + +/** + * Set plugin default values to global values without overriding anything. + * @param array Array of configuration option name/value pairs. + */ +function plugin_config_defaults( $p_options ) { + if ( ! is_array( $p_options ) ) { + return; + } + + $t_basename = plugin_get_current(); + $t_option_base = 'plugin_' . $t_basename . '_'; + + foreach( $p_options as $t_option => $t_value ) { + $t_full_option = $t_option_base . $t_option; + + config_set_global( $t_full_option, $t_value, false ); + } +} + ### Plugin management functions /** @@ -201,6 +251,10 @@ $t_info_function = 'plugin_callback_'.$p_basename.'_info'; if ( function_exists( $t_info_function ) ) { $t_plugin_info = $t_info_function(); + + if ( ! is_array( $t_plugin_info ) ) { + return null; + } if ( !isset( $t_plugin_info['name'] ) ) { $t_plugin_info['name'] = $p_basename; @@ -644,6 +698,13 @@ } } + $t_config_function = 'plugin_callback_'.$p_basename.'_config'; + if ( function_exists( $t_config_function ) ) { + plugin_push_current( $p_basename ); + plugin_config_defaults( $t_config_function() ); + plugin_pop_current(); + } + $t_init_function = 'plugin_callback_'.$p_basename.'_init'; if ( function_exists( $t_init_function ) ) { plugin_push_current( $p_basename ); This was sent by the SourceForge.net collaborative development platform, the world's largest Open Source development site. |
From: <nuc...@us...> - 2007-11-30 16:19:46
|
Revision: 4806 http://mantisbt.svn.sourceforge.net/mantisbt/?rev=4806&view=rev Author: nuclear_eclipse Date: 2007-11-30 08:19:32 -0800 (Fri, 30 Nov 2007) Log Message: ----------- Renamed display events for clarity of purpose. Modified Paths: -------------- trunk/mantisbt/core/events_inc.php trunk/mantisbt/core/string_api.php Modified: trunk/mantisbt/core/events_inc.php =================================================================== --- trunk/mantisbt/core/events_inc.php 2007-11-30 16:11:22 UTC (rev 4805) +++ trunk/mantisbt/core/events_inc.php 2007-11-30 16:19:32 UTC (rev 4806) @@ -41,8 +41,8 @@ 'EVENT_LAYOUT_PAGE_FOOTER' => EVENT_TYPE_OUTPUT, ##### Events for displaying data ##### - 'EVENT_DISPLAY_GENERAL' => EVENT_TYPE_CHAIN, - 'EVENT_DISPLAY_GENERAL_LINKS' => EVENT_TYPE_CHAIN, + 'EVENT_DISPLAY_TEXT' => EVENT_TYPE_CHAIN, + 'EVENT_DISPLAY_FORMATTED' => EVENT_TYPE_CHAIN, 'EVENT_DISPLAY_RSS' => EVENT_TYPE_CHAIN, ##### Menu Events ##### Modified: trunk/mantisbt/core/string_api.php =================================================================== --- trunk/mantisbt/core/string_api.php 2007-11-30 16:11:22 UTC (rev 4805) +++ trunk/mantisbt/core/string_api.php 2007-11-30 16:19:32 UTC (rev 4806) @@ -104,7 +104,7 @@ $p_string = string_preserve_spaces_at_bol( $p_string ); $p_string = string_nl2br( $p_string ); - return event_signal( 'EVENT_DISPLAY_GENERAL', $p_string ); + return event_signal( 'EVENT_DISPLAY_TEXT', $p_string ); } # -------------------- @@ -114,7 +114,7 @@ $p_string = string_html_specialchars( $p_string ); $p_string = string_restore_valid_html_tags( $p_string, /* multiline = */ false ); - return event_signal( 'EVENT_DISPLAY_GENERAL', $p_string ); + return event_signal( 'EVENT_DISPLAY_TEXT', $p_string ); } # -------------------- @@ -127,7 +127,7 @@ $p_string = string_process_bugnote_link( $p_string ); $p_string = string_process_cvs_link( $p_string ); - return event_signal( 'EVENT_DISPLAY_GENERAL_LINKS', $p_string ); + return event_signal( 'EVENT_DISPLAY_FORMATTED', $p_string ); } # -------------------- @@ -140,7 +140,7 @@ $p_string = string_process_bugnote_link( $p_string ); $p_string = string_process_cvs_link( $p_string ); - return event_signal( 'EVENT_DISPLAY_GENERAL_LINKS', $p_string ); + return event_signal( 'EVENT_DISPLAY_FORMATTED', $p_string ); } # -------------------- This was sent by the SourceForge.net collaborative development platform, the world's largest Open Source development site. |
From: <nuc...@us...> - 2007-12-07 21:33:27
|
Revision: 4818 http://mantisbt.svn.sourceforge.net/mantisbt/?rev=4818&view=rev Author: nuclear_eclipse Date: 2007-12-07 13:33:22 -0800 (Fri, 07 Dec 2007) Log Message: ----------- Fix and improve handling of _hook_many() options. Add event for Email text display. Improve functionality of event callbacks. Modified Paths: -------------- trunk/mantisbt/core/event_api.php trunk/mantisbt/core/events_inc.php trunk/mantisbt/core/plugin_api.php Modified: trunk/mantisbt/core/event_api.php =================================================================== --- trunk/mantisbt/core/event_api.php 2007-12-07 13:56:49 UTC (rev 4817) +++ trunk/mantisbt/core/event_api.php 2007-12-07 21:33:22 UTC (rev 4818) @@ -82,6 +82,28 @@ } /** + * Hook multiple callback functions to multiple events. + * @param array Event name/callback pairs + * @param string Plugin basename + */ +function event_hook_many( $p_hooks, $p_plugin=false ) { + if ( ! is_array( $p_hooks ) ) { + return; + } + + foreach( $p_hooks as $t_name => $t_callbacks ) { + if ( !is_array( $t_callbacks ) ) { + event_hook( $t_name, $t_callback, $p_plugin ); + continue; + } + + foreach( $t_callbacks as $t_callback ) { + event_hook( $t_name, $t_callback, $p_plugin ); + } + } +} + +/** * Signal an event to execute and handle callbacks as necessary. * @param string Event name * @param multi Event parameters @@ -137,7 +159,10 @@ $t_value = null; if ( function_exists( $p_callback ) ) { - $t_value = $p_callback( $p_event, $p_params ); + if ( !is_array( $p_params ) ) { + $p_params = array( $p_params ); + } + $t_value = call_user_func_array( $p_callback, array_merge( array( $p_event ), $p_params ) ); } if ( $p_plugin !== false ) { Modified: trunk/mantisbt/core/events_inc.php =================================================================== --- trunk/mantisbt/core/events_inc.php 2007-12-07 13:56:49 UTC (rev 4817) +++ trunk/mantisbt/core/events_inc.php 2007-12-07 21:33:22 UTC (rev 4818) @@ -44,6 +44,7 @@ 'EVENT_DISPLAY_TEXT' => EVENT_TYPE_CHAIN, 'EVENT_DISPLAY_FORMATTED' => EVENT_TYPE_CHAIN, 'EVENT_DISPLAY_RSS' => EVENT_TYPE_CHAIN, + 'EVENT_DISPLAY_EMAIL' => EVENT_TYPE_CHAIN, ##### Menu Events ##### 'EVENT_MENU_MAIN' => EVENT_TYPE_DEFAULT, Modified: trunk/mantisbt/core/plugin_api.php =================================================================== --- trunk/mantisbt/core/plugin_api.php 2007-12-07 13:56:49 UTC (rev 4817) +++ trunk/mantisbt/core/plugin_api.php 2007-12-07 21:33:22 UTC (rev 4818) @@ -151,9 +151,17 @@ $t_basename = plugin_get_current(); $t_function_base = 'plugin_event_' . $t_basename . '_'; - foreach( $p_hooks as $t_event => $t_callback ) { - $t_function = $t_function_base . $t_callback; - event_hook( $t_event, $t_function, $t_basename ); + foreach( $p_hooks as $t_event => $t_callbacks ) { + if ( !is_array( $t_callbacks ) ) { + $t_function = $t_function_base . $t_callbacks; + event_hook( $t_event, $t_function, $t_basename ); + continue; + } + + foreach( $t_callbacks as $t_callback ) { + $t_function = $t_function_base . $t_callback; + event_hook( $t_event, $t_function, $t_basename ); + } } } This was sent by the SourceForge.net collaborative development platform, the world's largest Open Source development site. |
From: <pri...@us...> - 2007-12-09 13:57:44
|
Revision: 4823 http://mantisbt.svn.sourceforge.net/mantisbt/?rev=4823&view=rev Author: prichards Date: 2007-12-09 05:57:42 -0800 (Sun, 09 Dec 2007) Log Message: ----------- possibly improve performance - seems to knock about a second off displaying summary page. Modified Paths: -------------- trunk/mantisbt/core/summary_api.php trunk/mantisbt/core/user_api.php Modified: trunk/mantisbt/core/summary_api.php =================================================================== --- trunk/mantisbt/core/summary_api.php 2007-12-09 13:40:04 UTC (rev 4822) +++ trunk/mantisbt/core/summary_api.php 2007-12-09 13:57:42 UTC (rev 4823) @@ -413,6 +413,13 @@ $t_closed_val = CLOSED; while ( $row = db_fetch_array( $result ) ) { + $t_summarydata[] = $row; + $t_summaryusers[] = $row['handler_id']; + } + + user_cache_array_rows( array_unique( $t_summaryusers ) ); + + foreach ($t_summarydata as $row) { extract( $row, EXTR_PREFIX_ALL, 'v' ); if ( ($v_handler_id != $t_last_handler) && (-1 != $t_last_handler) ) { Modified: trunk/mantisbt/core/user_api.php =================================================================== --- trunk/mantisbt/core/user_api.php 2007-12-09 13:40:04 UTC (rev 4822) +++ trunk/mantisbt/core/user_api.php 2007-12-09 13:57:42 UTC (rev 4823) @@ -74,6 +74,33 @@ return $row; } + function user_cache_array_rows( $p_user_id_array ) { + global $g_cache_user; + $c_user_id_array = array(); + + foreach( $p_user_id_array as $t_user_id ) { + if ( !isset( $g_cache_user[(int)$t_user_id] ) ) { + $c_user_id_array[] = (int)$t_user_id; + } + } + + if( empty( $c_user_id_array ) ) + return; + + + $t_user_table = db_get_table( 'mantis_user_table' ); + + $query = "SELECT * + FROM $t_user_table + WHERE id IN (" . implode( ',', $c_user_id_array ) . ')'; + $result = db_query_bound( $query ); + + while ( $row = db_fetch_array( $result ) ) { + $g_cache_user[(int)$row['id']] = $row; + } + return; + } + # -------------------- # Clear the user cache (or just the given id if specified) function user_clear_cache( $p_user_id = null ) { This was sent by the SourceForge.net collaborative development platform, the world's largest Open Source development site. |
From: <pri...@us...> - 2007-12-09 17:33:42
|
Revision: 4825 http://mantisbt.svn.sourceforge.net/mantisbt/?rev=4825&view=rev Author: prichards Date: 2007-12-09 09:33:32 -0800 (Sun, 09 Dec 2007) Log Message: ----------- Performance optimisation - more caching of db queries ;/ Modified Paths: -------------- trunk/mantisbt/core/authentication_api.php trunk/mantisbt/core/user_api.php Modified: trunk/mantisbt/core/authentication_api.php =================================================================== --- trunk/mantisbt/core/authentication_api.php 2007-12-09 16:13:45 UTC (rev 4824) +++ trunk/mantisbt/core/authentication_api.php 2007-12-09 17:33:32 UTC (rev 4825) @@ -193,6 +193,7 @@ global $g_cache_current_user_id, $g_cache_cookie_valid; # clear cached userid + user_clear_cache( $g_cache_current_user_id ); $g_cache_current_user_id = null; $g_cache_cookie_valid = null; @@ -572,16 +573,25 @@ return true; } + if ( user_search_cache('cookie_string', $p_cookie_string ) ) { + return true; + } + # look up cookie in the database to see if it is valid $t_user_table = db_get_table( 'mantis_user_table' ); - $query = "SELECT id + $query = "SELECT * FROM $t_user_table WHERE cookie_string=" . db_param(0); $result = db_query_bound( $query, Array( $p_cookie_string ) ); # return true if a matching cookie was found - return ( 1 == db_num_rows( $result ) ); + if ( 1 == db_num_rows( $result ) ) { + user_cache_database_result( db_fetch_array( $result ) ); + return true; + } else { + return false; + } } ######################################### @@ -597,10 +607,16 @@ return $g_cache_current_user_id; } + $t_cookie_string = auth_get_current_user_cookie(); + + if ( $t_result = user_search_cache('cookie_string', $t_cookie_string ) ) { + $t_user_id = (int) $t_result['id']; + $g_cache_current_user_id = $t_user_id; + return $t_user_id; + } + $t_user_table = db_get_table( 'mantis_user_table' ); - $t_cookie_string = auth_get_current_user_cookie(); - # @@@ error with an error saying they aren't logged in? # Or redirect to the login page maybe? Modified: trunk/mantisbt/core/user_api.php =================================================================== --- trunk/mantisbt/core/user_api.php 2007-12-09 16:13:45 UTC (rev 4824) +++ trunk/mantisbt/core/user_api.php 2007-12-09 17:33:32 UTC (rev 4825) @@ -100,8 +100,19 @@ } return; } - + # -------------------- + # Cache an object as a bug. + function user_cache_database_result( $p_user_database_result ) { + global $g_cache_user; + + if ( isset( $g_cache_user[ $p_user_database_result['id'] ] ) ) { + return $g_cache_user[ $p_user_database_result['id'] ]; + } + + $g_cache_user[ $p_user_database_result['id'] ] = $p_user_database_result; + } + # -------------------- # Clear the user cache (or just the given id if specified) function user_clear_cache( $p_user_id = null ) { global $g_cache_user; @@ -125,6 +136,15 @@ } } + function user_search_cache( $p_field, $p_value ) { + global $g_cache_user; + foreach ($g_cache_user as $t_user ) { + if ($t_user[$p_field] == $p_value ) { + return $t_user; + } + } + return false; + } #=================================== # Boolean queries and ensures #=================================== @@ -576,15 +596,13 @@ # return false if the username does not exist function user_get_id_by_name( $p_username ) { global $g_cache_user; - foreach ($g_cache_user as $t_user ) { - if ($t_user['username'] == $p_username ) { - return $t_user['id']; - } + if ( $t_user = user_search_cache('username', $p_username ) ) { + return $t_user['id']; } $t_user_table = db_get_table( 'mantis_user_table' ); - $query = "SELECT id + $query = "SELECT * FROM $t_user_table WHERE username=" . db_param(0); $result = db_query_bound( $query, Array( $p_username ) ); @@ -592,7 +610,9 @@ if ( 0 == db_num_rows( $result ) ) { return false; } else { - return db_result( $result ); + $row = db_fetch_array( $result ); + user_cache_database_result( $row ); + return $row['id']; } } This was sent by the SourceForge.net collaborative development platform, the world's largest Open Source development site. |
From: <vb...@us...> - 2008-01-05 07:07:49
|
Revision: 4860 http://mantisbt.svn.sourceforge.net/mantisbt/?rev=4860&view=rev Author: vboctor Date: 2008-01-04 23:07:46 -0800 (Fri, 04 Jan 2008) Log Message: ----------- Fixed #8707: "My View" shows warnings about "sort" / "dir" not defined. Modified Paths: -------------- trunk/mantisbt/core/current_user_api.php trunk/mantisbt/core/filter_api.php Modified: trunk/mantisbt/core/current_user_api.php =================================================================== --- trunk/mantisbt/core/current_user_api.php 2008-01-05 06:58:22 UTC (rev 4859) +++ trunk/mantisbt/core/current_user_api.php 2008-01-05 07:07:46 UTC (rev 4860) @@ -217,7 +217,7 @@ return false; } else { $t_user_id = auth_get_current_user_id(); - return user_get_bug_filter( $t_user_id, $p_project_id ); + $t_filter = user_get_bug_filter( $t_user_id, $p_project_id ); } $t_filter = filter_ensure_valid_filter( $t_filter ); Modified: trunk/mantisbt/core/filter_api.php =================================================================== --- trunk/mantisbt/core/filter_api.php 2008-01-05 06:58:22 UTC (rev 4859) +++ trunk/mantisbt/core/filter_api.php 2008-01-05 07:07:46 UTC (rev 4860) @@ -378,7 +378,7 @@ 'per_page' => config_get( 'default_limit_view' ) ); - return $t_filter; + return filter_ensure_valid_filter( $t_filter ); } # @@@ Had to make all these parameters required because we can't use This was sent by the SourceForge.net collaborative development platform, the world's largest Open Source development site. |
From: <vb...@us...> - 2008-01-20 22:58:01
|
Revision: 4919 http://mantisbt.svn.sourceforge.net/mantisbt/?rev=4919&view=rev Author: vboctor Date: 2008-01-20 14:57:52 -0800 (Sun, 20 Jan 2008) Log Message: ----------- More fixes for cases where category id = 0 Modified Paths: -------------- trunk/mantisbt/core/columns_api.php trunk/mantisbt/core/custom_function_api.php Modified: trunk/mantisbt/core/columns_api.php =================================================================== --- trunk/mantisbt/core/columns_api.php 2008-01-20 22:17:27 UTC (rev 4918) +++ trunk/mantisbt/core/columns_api.php 2008-01-20 22:57:52 UTC (rev 4919) @@ -534,7 +534,10 @@ echo ']</small><br />'; } - echo string_display( category_full_name( $p_row['category_id'], false ) ); + if ( $p_row['category_id'] != 0 ) { + echo string_display( category_get_name( $p_row['category_id'] ) ); + } + echo '</td>'; } Modified: trunk/mantisbt/core/custom_function_api.php =================================================================== --- trunk/mantisbt/core/custom_function_api.php 2008-01-20 22:17:27 UTC (rev 4918) +++ trunk/mantisbt/core/custom_function_api.php 2008-01-20 22:57:52 UTC (rev 4919) @@ -44,7 +44,12 @@ function custom_function_default_changelog_print_issue( $p_issue_id, $p_issue_level = 0 ) { $t_bug = bug_get( $p_issue_id ); - $t_category_name = category_full_name( $t_bug->category_id, false ); + if ( $t_bug->category_id ) { + $t_category_name = category_get_name( $t_bug->category_id ); + } else { + $t_category_name = ''; + } + $t_category = is_blank( $t_category_name ) ? '' : '<b>[' . $t_category_name . ']</b> '; echo str_pad( '', $p_issue_level * 6, ' ' ), '- ', string_get_bug_view_link( $p_issue_id ), ': ', $t_category, string_display_line_links( $t_bug->summary ); @@ -75,8 +80,15 @@ } else { $t_strike_start = $t_strike_end = ''; } - - $t_category = is_blank( $t_bug->category ) ? '' : '<b>[' . $t_bug->category . ']</b> '; + + if ( $t_bug->category_id ) { + $t_category_name = category_get_name( $t_bug->category_id ); + } else { + $t_category_name = ''; + } + + $t_category = is_blank( $t_category_name ) ? '' : '<b>[' . $t_category_name . ']</b> '; + echo str_pad( '', $p_issue_level * 6, ' ' ), '- ', $t_strike_start, string_get_bug_view_link( $p_issue_id ), ': ', $t_category, string_display_line_links( $t_bug->summary ); if ( $t_bug->handler_id != 0 ) { This was sent by the SourceForge.net collaborative development platform, the world's largest Open Source development site. |
From: <nuc...@us...> - 2008-01-28 14:42:20
|
Revision: 4934 http://mantisbt.svn.sourceforge.net/mantisbt/?rev=4934&view=rev Author: nuclear_eclipse Date: 2008-01-28 06:42:17 -0800 (Mon, 28 Jan 2008) Log Message: ----------- Added BODY_BEGIN and BODY_END events, rearranged PAGE_FOOTER event to match PAGE_HEADER. Modified Paths: -------------- trunk/mantisbt/core/events_inc.php trunk/mantisbt/core/html_api.php Modified: trunk/mantisbt/core/events_inc.php =================================================================== --- trunk/mantisbt/core/events_inc.php 2008-01-28 14:28:15 UTC (rev 4933) +++ trunk/mantisbt/core/events_inc.php 2008-01-28 14:42:17 UTC (rev 4934) @@ -35,10 +35,12 @@ ##### Mantis Layout Events ##### 'EVENT_LAYOUT_RESOURCES' => EVENT_TYPE_OUTPUT, + 'EVENT_LAYOUT_BODY_BEGIN' => EVENT_TYPE_OUTPUT, 'EVENT_LAYOUT_PAGE_HEADER' => EVENT_TYPE_OUTPUT, 'EVENT_LAYOUT_CONTENT_BEGIN' => EVENT_TYPE_OUTPUT, 'EVENT_LAYOUT_CONTENT_END' => EVENT_TYPE_OUTPUT, 'EVENT_LAYOUT_PAGE_FOOTER' => EVENT_TYPE_OUTPUT, + 'EVENT_LAYOUT_BODY_END' => EVENT_TYPE_OUTPUT, ##### Events for displaying data ##### 'EVENT_DISPLAY_TEXT' => EVENT_TYPE_CHAIN, Modified: trunk/mantisbt/core/html_api.php =================================================================== --- trunk/mantisbt/core/html_api.php 2008-01-28 14:28:15 UTC (rev 4933) +++ trunk/mantisbt/core/html_api.php 2008-01-28 14:42:17 UTC (rev 4934) @@ -306,6 +306,8 @@ # (8) Begin the <body> section function html_body_begin() { echo '<body>', "\n"; + + event_signal( 'EVENT_LAYOUT_BODY_BEGIN' ); } # -------------------- @@ -504,12 +506,14 @@ echo '</td><td><div align="right">'; echo '<a href="http://www.mantisbt.org" title="Free Web Based Bug Tracker"><img src="' . helper_mantis_url( 'images/mantis_logo_button.gif' ) . '" width="88" height="35" alt="Powered by Mantis Bugtracker" border="0" /></a>'; echo '</div></td></tr></table>'; + + event_signal( 'EVENT_LAYOUT_PAGE_FOOTER' ); } # -------------------- # (14) End the <body> section function html_body_end() { - event_signal( 'EVENT_LAYOUT_PAGE_FOOTER' ); + event_signal( 'EVENT_LAYOUT_BODY_END' ); echo '</body>', "\n"; } This was sent by the SourceForge.net collaborative development platform, the world's largest Open Source development site. |
From: <vb...@us...> - 2008-02-04 08:17:52
|
Revision: 4951 http://mantisbt.svn.sourceforge.net/mantisbt/?rev=4951&view=rev Author: vboctor Date: 2008-02-04 00:17:50 -0800 (Mon, 04 Feb 2008) Log Message: ----------- Change avatar apis to allow specifying custom size. Modified Paths: -------------- trunk/mantisbt/core/print_api.php trunk/mantisbt/core/user_api.php Modified: trunk/mantisbt/core/print_api.php =================================================================== --- trunk/mantisbt/core/print_api.php 2008-02-04 08:17:06 UTC (rev 4950) +++ trunk/mantisbt/core/print_api.php 2008-02-04 08:17:50 UTC (rev 4951) @@ -129,13 +129,13 @@ # Print avatar image for the given user ID - function print_avatar( $p_user_id ) { + function print_avatar( $p_user_id, $p_size = 80 ) { 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 ); + $t_avatar = user_get_avatar( $p_user_id, $p_size ); if ( false !== $t_avatar ) { $t_avatar_url = $t_avatar[0]; $t_width = $t_avatar[1]; Modified: trunk/mantisbt/core/user_api.php =================================================================== --- trunk/mantisbt/core/user_api.php 2008-02-04 08:17:06 UTC (rev 4950) +++ trunk/mantisbt/core/user_api.php 2008-02-04 08:17:50 UTC (rev 4951) @@ -710,13 +710,13 @@ * in this first implementation, only gravatar.com avatars are supported * @return array|bool an array( URL, width, height ) or false when the given user has no avatar */ - function user_get_avatar( $p_user_id ) { + function user_get_avatar( $p_user_id, $p_size = 80 ) { $t_email = strtolower( user_get_email( $p_user_id ) ); if ( is_blank( $t_email ) ) { $t_result = false; } else { $t_default_image = config_get( 'default_avatar' ); - $t_size = 80; + $t_size = $p_size; $t_avatar_url = "http://www.gravatar.com/avatar.php?gravatar_id=" . md5( $t_email ) . "&default=" . urlencode( $t_default_image ) . "&size=" . $t_size . This was sent by the SourceForge.net collaborative development platform, the world's largest Open Source development site. |
From: <pri...@us...> - 2008-02-14 17:19:52
|
Revision: 5001 http://mantisbt.svn.sourceforge.net/mantisbt/?rev=5001&view=rev Author: prichards Date: 2008-02-14 09:19:48 -0800 (Thu, 14 Feb 2008) Log Message: ----------- drop db_prepare_date - it's not database api's 'job' to check that dates are not >2100 etc. Additionally this function ignores adodb's date handling. add db_bind_date and db_bind_timestamp. fix timetracking stats to work with the above changes. Modified Paths: -------------- trunk/mantisbt/core/bugnote_api.php trunk/mantisbt/core/database_api.php Modified: trunk/mantisbt/core/bugnote_api.php =================================================================== --- trunk/mantisbt/core/bugnote_api.php 2008-02-14 17:16:50 UTC (rev 5000) +++ trunk/mantisbt/core/bugnote_api.php 2008-02-14 17:19:48 UTC (rev 5001) @@ -476,20 +476,20 @@ # $p_to - Ending date (yyyy-mm-dd) inclusive, if blank, then ignored. function bugnote_stats_get_events_array( $p_bug_id, $p_from, $p_to ) { $c_bug_id = db_prepare_int( $p_bug_id ); - $c_from = db_prepare_date( $p_from ); - $c_to = db_prepare_date( $p_to ); + $c_from = db_bind_timestamp( $p_from . ' 00:00:00'); + $c_to = db_bind_timestamp( $p_to . ' 23:59:59' ); $t_user_table = db_get_table( 'mantis_user_table' ); $t_bugnote_table = db_get_table( 'mantis_bugnote_table' ); if ( !is_blank( $c_from ) ) { - $t_from_where = " AND bn.date_submitted >= '$c_from 00:00:00'"; + $t_from_where = " AND bn.date_submitted >= '$c_from '"; } else { $t_from_where = ''; } if ( !is_blank( $c_to ) ) { - $t_to_where = " AND bn.date_submitted <= '$c_to 23:59:59'"; + $t_to_where = " AND bn.date_submitted <= '$c_to '"; } else { $t_to_where = ''; } @@ -518,8 +518,8 @@ # $p_to - Ending date (yyyy-mm-dd) inclusive, if blank, then ignored. function bugnote_stats_get_project_array( $p_project_id, $p_from, $p_to, $p_cost ) { $c_project_id = db_prepare_int( $p_project_id ); - $c_to = db_prepare_date( $p_to ); - $c_from = db_prepare_date( $p_from ); + $c_to = db_bind_timestamp( $p_to . ' 23:59:59' ); + $c_from = db_bind_timestamp( $p_from . ' 00:00:00'); $c_cost = db_prepare_double( $p_cost ); // MySQL @@ -528,13 +528,13 @@ $t_bugnote_table = db_get_table( 'mantis_bugnote_table' ); if ( !is_blank( $c_from ) ) { - $t_from_where = " AND bn.date_submitted >= '$c_from 00:00:00'"; + $t_from_where = " AND bn.date_submitted >= '$c_from'"; } else { $t_from_where = ''; } if ( !is_blank( $c_to ) ) { - $t_to_where = " AND bn.date_submitted <= '$c_to 23:59:59'"; + $t_to_where = " AND bn.date_submitted <= '$c_to'"; } else { $t_to_where = ''; } Modified: trunk/mantisbt/core/database_api.php =================================================================== --- trunk/mantisbt/core/database_api.php 2008-02-14 17:16:50 UTC (rev 5000) +++ trunk/mantisbt/core/database_api.php 2008-02-14 17:19:48 UTC (rev 5001) @@ -587,47 +587,18 @@ return (int)$t_min; } - # -------------------- - # prepare a date string in "yyyy-mm-dd" - function db_prepare_date( $p_yyyymmdd ) { - if ( is_blank( $p_yyyymmdd ) ) { - return ""; - } - - $t_a = explode( '-', $p_yyyymmdd ); - - // date can be composed of max 3 parts (yyyy-mm-dd) - if ( count( $t_a ) > 3 ) { - error_parameters( 'p_yyyymmdd', $p_yyyymmdd ); - trigger_error( ERROR_CONFIG_OPT_INVALID, ERROR ); - } - - // Check years - if ( !is_numeric( $t_a[0] ) || ( (integer)$t_a[0] < 1900 || (integer)$t_a[0] > 2100) ) { - error_parameters( 'p_yyyymmdd', $p_yyyymmdd ); - trigger_error( ERROR_CONFIG_OPT_INVALID, ERROR ); - } - - // Check months - if ( !is_numeric( $t_a[1] ) || ( (integer)$t_a[1] < 1 || (integer)$t_a[1] > 12) ) { - error_parameters( 'p_yyyymmdd', $p_yyyymmdd ); - trigger_error( ERROR_CONFIG_OPT_INVALID, ERROR ); - } - - // Check days - if ( !is_numeric( $t_a[2] ) || ( (integer)$t_a[2] < 1 || (integer)$t_a[2] > 31) ) { - error_parameters( 'p_yyyymmdd', $p_yyyymmdd ); - trigger_error( ERROR_CONFIG_OPT_INVALID, ERROR ); - } - - // Format - $t_formatted = $t_a[0] . '-'; - $t_formatted .= ($t_a[1] < 10 ? "0" . $t_a[1] : $t_a[1]) . '-'; - $t_formatted .= ($t_a[2] < 10 ? "0" . $t_a[2] : $t_a[2]); - - return $t_formatted; + # prepare a date for binding in the format database accepts. + # @param p_date can be a Unix integer timestamp or an ISO format Y-m-d. If null or false or '' is passed in, it will be converted to an SQL null. + function db_bind_date( $p_date ) { + global $g_db; + return $g_db->BindDate( $p_date ); } + function db_bind_timestamp( $p_date ) { + global $g_db; + return $g_db->BindTimeStamp( $p_date ); + } + # -------------------- # prepare an integer before DB insertion function db_prepare_int( $p_int ) { This was sent by the SourceForge.net collaborative development platform, the world's largest Open Source development site. |
From: <pri...@us...> - 2008-02-21 14:25:36
|
Revision: 5024 http://mantisbt.svn.sourceforge.net/mantisbt/?rev=5024&view=rev Author: prichards Date: 2008-02-21 06:25:22 -0800 (Thu, 21 Feb 2008) Log Message: ----------- Allow string_sanitize_url to return either an absolute or relative link. This should allow us to simplify things elsewhere (I hope) Modified Paths: -------------- trunk/mantisbt/core/print_api.php trunk/mantisbt/core/string_api.php Modified: trunk/mantisbt/core/print_api.php =================================================================== --- trunk/mantisbt/core/print_api.php 2008-02-20 12:38:58 UTC (rev 5023) +++ trunk/mantisbt/core/print_api.php 2008-02-21 14:25:22 UTC (rev 5024) @@ -57,12 +57,19 @@ # validate the url as part of this site before continuing if ( $p_absolute ) { - $t_url = ''; + if ( $p_sanitize ) { + $t_url = string_sanitize_url( $p_url ); + } else { + $t_url = $p_url; + } } else { - $t_url = config_get( 'path' ); + if ( $p_sanitize ) { + $t_url = string_sanitize_url( $p_url, true ); + } else { + $t_url = config_get( 'path' ) . $p_url; + } } - $t_url .= $p_sanitize ? string_sanitize_url( $p_url ) : $p_url; - + # don't send more headers if they have already been sent (guideweb) if ( ! headers_sent() ) { header( 'Content-Type: text/html; charset=' . lang_get( 'charset' ) ); Modified: trunk/mantisbt/core/string_api.php =================================================================== --- trunk/mantisbt/core/string_api.php 2008-02-20 12:38:58 UTC (rev 5023) +++ trunk/mantisbt/core/string_api.php 2008-02-21 14:25:22 UTC (rev 5024) @@ -188,18 +188,40 @@ # -------------------- # validate the url as part of this site before continuing - function string_sanitize_url( $p_url ) { + function string_sanitize_url( $p_url, $return_absolute = false ) { $t_url = strip_tags( urldecode( $p_url ) ); if ( preg_match( '?http(s)*://?', $t_url ) > 0 ) { // no embedded addresses if ( preg_match( '?^' . config_get( 'path' ) . '?', $t_url ) == 0 ) { // url is ok if it begins with our path, if not, replace it - $t_url = 'index.php'; + if ( $return_absolute == true ) { + $t_url = config_get_global( 'path' ) . 'index.php'; + } else { + $t_url = 'index.php'; + } + } else { + if ( $return_absolute == false ) { + str_replace( config_get_global( 'path' ), '', $t_url ); + } } + } else { + // relative hyperlink + if ( $return_absolute == true ) { + if ( strpos( $p_url, config_get_global( 'short_path' ) ) === 0) { + $t_url = str_replace( config_get_global( 'short_path' ), '', config_get_global( 'path' ) ) . $t_url; + } else { + $t_url = config_get_global( 'path' ) . $t_url; + } + } } if ( $t_url == '' ) { - $t_url = 'index.php'; + if ( $return_absolute == true ) { + $t_url = config_get_global( 'path' ) . 'index.php'; + } else { + $t_url = 'index.php'; + } } + // split and encode parameters if ( strpos( $t_url, '?' ) !== FALSE ) { This was sent by the SourceForge.net collaborative development platform, the world's largest Open Source development site. |
From: <pri...@us...> - 2008-02-23 17:54:36
|
Revision: 5045 http://mantisbt.svn.sourceforge.net/mantisbt/?rev=5045&view=rev Author: prichards Date: 2008-02-23 09:54:29 -0800 (Sat, 23 Feb 2008) Log Message: ----------- Squashed commit of the following: commit ac6cd1fda123ab4c039e3a3430432c597492e5f3 Author: Paul <gra...@bl...> Date: Sat Feb 23 17:47:06 2008 +0000 fix postgres Modified Paths: -------------- trunk/mantisbt/core/constant_inc.php trunk/mantisbt/core/plugin_api.php Modified: trunk/mantisbt/core/constant_inc.php =================================================================== --- trunk/mantisbt/core/constant_inc.php 2008-02-23 17:09:35 UTC (rev 5044) +++ trunk/mantisbt/core/constant_inc.php 2008-02-23 17:54:29 UTC (rev 5045) @@ -404,6 +404,13 @@ define( 'CUSTOM_FIELD_DATE_AFTER', 6 ) ; define( 'CUSTOM_FIELD_DATE_ONORAFTER', 7 ) ; + # custom field types + define( 'CUSTOM_FIELD_TYPE_BUG', 0 ); + define( 'CUSTOM_FIELD_TYPE_USER', 1 ); + define( 'CUSTOM_FIELD_TYPE_BUGNOTE', 2 ); + define( 'CUSTOM_FIELD_TYPE_PROJECT', 3 ); + define( 'CUSTOM_FIELD_TYPE_FILE', 4 ); + # system logging # logging levels, can be OR'd together define( 'LOG_NONE', 0 ); # no logging Modified: trunk/mantisbt/core/plugin_api.php =================================================================== --- trunk/mantisbt/core/plugin_api.php 2008-02-23 17:09:35 UTC (rev 5044) +++ trunk/mantisbt/core/plugin_api.php 2008-02-23 17:54:29 UTC (rev 5045) @@ -568,8 +568,8 @@ function plugin_register_installed() { $t_plugin_table = db_get_table( 'mantis_plugin_table' ); - $t_query = "SELECT basename FROM $t_plugin_table WHERE enabled=1"; - $t_result = db_query( $t_query ); + $t_query = "SELECT basename FROM $t_plugin_table WHERE enabled=" . db_param(0); + $t_result = db_query_bound( $t_query, Array(1) ); while ( $t_row = db_fetch_array( $t_result ) ) { $t_basename = $t_row['basename']; This was sent by the SourceForge.net collaborative development platform, the world's largest Open Source development site. |
From: <nuc...@us...> - 2008-03-05 18:52:45
|
Revision: 5087 http://mantisbt.svn.sourceforge.net/mantisbt/?rev=5087&view=rev Author: nuclear_eclipse Date: 2008-03-05 10:52:19 -0800 (Wed, 05 Mar 2008) Log Message: ----------- Added the First-Return event type for use in wiki and authentication plugins. Modified Paths: -------------- trunk/mantisbt/core/constant_inc.php trunk/mantisbt/core/event_api.php Modified: trunk/mantisbt/core/constant_inc.php =================================================================== --- trunk/mantisbt/core/constant_inc.php 2008-03-04 05:27:41 UTC (rev 5086) +++ trunk/mantisbt/core/constant_inc.php 2008-03-05 18:52:19 UTC (rev 5087) @@ -439,4 +439,5 @@ define( 'EVENT_TYPE_EXECUTE', 1 ); define( 'EVENT_TYPE_OUTPUT', 2 ); define( 'EVENT_TYPE_CHAIN', 3 ); + define( 'EVENT_TYPE_FIRST', 4 ); ?> Modified: trunk/mantisbt/core/event_api.php =================================================================== --- trunk/mantisbt/core/event_api.php 2008-03-04 05:27:41 UTC (rev 5086) +++ trunk/mantisbt/core/event_api.php 2008-03-05 18:52:19 UTC (rev 5087) @@ -136,6 +136,9 @@ case EVENT_TYPE_CHAIN: return event_type_chain( $p_name, $t_callbacks, $p_params, $p_params_dynamic ); + case EVENT_TYPE_FIRST: + return event_type_first( $p_name, $t_callbacks, $p_params ); + default: return event_type_default( $p_name, $t_callbacks, $p_params ); } @@ -260,6 +263,32 @@ } /** + * Process a first-return event. + * Callbacks will be called with the given parameters until a callback + * returns a non-null value; at this point, no other callbacks will be + * processed, and the return value be passed back to the event origin. + * @param string Event name + * @param array Array of callback function/plugin basename key/value pairs + * @param multi Parameters passed to callbacks + * @return multi The first non-null callback result, or null otherwise + */ +function event_type_first( $p_event, $p_callbacks, $p_params ) { + $t_output = null; + + foreach( $p_callbacks as $t_plugin => $t_callbacks ) { + foreach( $t_callbacks as $t_callback ) { + $t_output = event_callback( $p_event, $t_callback, $t_plugin, $p_params ); + + if ( !is_null( $t_output ) ) { + return $t_output; + } + } + } + + return null; +} + +/** * Process a default event type. * All callbacks will be called with the given data parameters. The * return value of each callback will be appended to an array with the callback's This was sent by the SourceForge.net collaborative development platform, the world's largest Open Source development site. |
From: <nuc...@us...> - 2008-04-18 15:25:42
|
Revision: 5172 http://mantisbt.svn.sourceforge.net/mantisbt/?rev=5172&view=rev Author: nuclear_eclipse Date: 2008-04-18 08:24:50 -0700 (Fri, 18 Apr 2008) Log Message: ----------- Added EVENT_MENU_MAIN_FRONT to allow menu items placed before the My View item. Modified Paths: -------------- trunk/mantisbt/core/events_inc.php trunk/mantisbt/core/html_api.php Modified: trunk/mantisbt/core/events_inc.php =================================================================== --- trunk/mantisbt/core/events_inc.php 2008-04-16 22:51:52 UTC (rev 5171) +++ trunk/mantisbt/core/events_inc.php 2008-04-18 15:24:50 UTC (rev 5172) @@ -49,6 +49,7 @@ ##### Menu Events 'EVENT_MENU_MAIN' => EVENT_TYPE_DEFAULT, + 'EVENT_MENU_MAIN_FRONT' => EVENT_TYPE_DEFAULT, 'EVENT_MENU_MANAGE' => EVENT_TYPE_DEFAULT, 'EVENT_MENU_MANAGE_CONFIG' => EVENT_TYPE_DEFAULT, 'EVENT_MENU_SUMMARY' => EVENT_TYPE_DEFAULT, Modified: trunk/mantisbt/core/html_api.php =================================================================== --- trunk/mantisbt/core/html_api.php 2008-04-16 22:51:52 UTC (rev 5171) +++ trunk/mantisbt/core/html_api.php 2008-04-18 15:24:50 UTC (rev 5172) @@ -561,6 +561,18 @@ # Main Page $t_menu_options[] = '<a href="' . helper_mantis_url( 'main_page.php">' ) . lang_get( 'main_link' ) . '</a>'; + # 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 { + $t_menu_options[] = $t_callback_menu_options; + } + } + } + # My View $t_menu_options[] = '<a href="' . helper_mantis_url( 'my_view_page.php">' ) . lang_get( 'my_view_link' ) . '</a>'; This was sent by the SourceForge.net collaborative development platform, the world's largest Open Source development site. |
From: <vb...@us...> - 2008-04-20 04:14:29
|
Revision: 5176 http://mantisbt.svn.sourceforge.net/mantisbt/?rev=5176&view=rev Author: vboctor Date: 2008-04-19 21:14:20 -0700 (Sat, 19 Apr 2008) Log Message: ----------- Fixed #9088: After upgrade all issues are assigned 1970-01-01 and some are considered overdue + misc other due date fixes Modified Paths: -------------- trunk/mantisbt/core/bug_api.php trunk/mantisbt/core/columns_api.php trunk/mantisbt/core/date_api.php trunk/mantisbt/core/version_api.php Modified: trunk/mantisbt/core/bug_api.php =================================================================== --- trunk/mantisbt/core/bug_api.php 2008-04-19 07:00:35 UTC (rev 5175) +++ trunk/mantisbt/core/bug_api.php 2008-04-20 04:14:20 UTC (rev 5176) @@ -109,7 +109,7 @@ if( !is_int( $p_bug_database_result['last_updated'] ) ) $p_bug_database_result['last_updated'] = db_unixtimestamp( $p_bug_database_result['last_updated'] ); if( !is_int( $p_bug_database_result['due_date'] ) ) - $p_bug_datebase_result['due_date'] = db_unixtimestamp( $p_bug_datebase_result['due_date'] ); + $p_bug_database_result['due_date'] = db_unixtimestamp( $p_bug_database_result['due_date'] ); $g_cache_bug[ $p_bug_database_result['id'] ] = $p_bug_database_result; if( !is_null( $p_stats ) ) { $g_cache_bug[ $p_bug_database_result['id'] ]['_stats'] = $p_stats; @@ -1242,7 +1242,7 @@ if ( $p_field_name == 'due_date' ) { if ( !date_is_null( $h_status ) ) { - $h_status = date( config_get ( 'short_date_format' ), $h_status ); + $h_status = date( config_get( 'short_date_format' ), $h_status ); } else { $h_status = ''; } @@ -1251,7 +1251,7 @@ $t_tmp = strtotime( $p_status ); } if ( !date_is_null( $t_tmp ) ) { - $c_status = date( 'Y-m-d', $t_tmp ); + $c_status = date( config_get( 'short_date_format' ), $t_tmp ); } else { $c_status = ''; } Modified: trunk/mantisbt/core/columns_api.php =================================================================== --- trunk/mantisbt/core/columns_api.php 2008-04-19 07:00:35 UTC (rev 5175) +++ trunk/mantisbt/core/columns_api.php 2008-04-20 04:14:20 UTC (rev 5176) @@ -521,14 +521,16 @@ # $p_columns_target: see COLUMNS_TARGET_* in constant_inc.php function print_column_edit( $p_row, $p_columns_target = COLUMNS_TARGET_VIEW_PAGE ) { global $t_icon_path, $t_update_bug_threshold; + $t_is_overdue = bug_is_overdue( $p_row[ 'id' ] ); + $t_view_level = access_has_bug_level( config_get( 'due_date_view_threshold' ), $p_row['id'] ); - if ( bug_is_overdue( $p_row['id'] ) && access_has_bug_level( config_get( 'due_date_view_threshold' ), $p_row['id'] )) { + if ( $t_is_overdue && $t_view_level ) { print "<td class=\"overdue\">"; } else { echo '<td>'; } if ( !bug_is_readonly( $p_row['id'] ) - && access_has_bug_level( $t_update_bug_threshold, $p_row['id'] ) ) { + && access_has_bug_level( config_get( 'update_bug_threshold' ), $p_row['id'] ) ) { echo '<a href="' . string_get_bug_update_url( $p_row['id'] ) . '">'; echo '<img border="0" width="16" height="16" src="' . $t_icon_path . 'update.png'; echo '" alt="' . lang_get( 'update_bug_button' ) . '"'; @@ -536,12 +538,12 @@ } else { echo ' '; } - if ( bug_is_overdue( $p_row['id'] ) && access_has_bug_level( config_get( 'due_date_view_threshold' ), $p_row['id'] ) ) { + if ( $t_is_overdue && $t_view_level ) { echo '<a href="' . string_get_bug_update_url( $p_row['id'] ) . '">'; echo '<img border="0" width="16" height="16" src="' . $t_icon_path . 'overdue.png'; echo '" alt="' . lang_get( 'overdue' ) . '"'; echo ' title="' . lang_get( 'overdue' ) . '" /></a>'; - } else if ( ! date_is_null( $p_row[ 'due_date' ] ) && access_has_bug_level( config_get( 'due_date_view_threshold' ), $p_row['id'] )) { + } else if ( ! date_is_null( $p_row[ 'due_date' ] ) && $t_view_level ) { echo '<a href="' . string_get_bug_update_url( $p_row['id'] ) . '">'; echo '<img border="0" width="16" height="16" src="' . $t_icon_path . 'clock.png'; echo '" alt="' . lang_get( 'due_date' ) . '"'; Modified: trunk/mantisbt/core/date_api.php =================================================================== --- trunk/mantisbt/core/date_api.php 2008-04-19 07:00:35 UTC (rev 5175) +++ trunk/mantisbt/core/date_api.php 2008-04-20 04:14:20 UTC (rev 5176) @@ -25,7 +25,7 @@ # -------------------- # checks if date is null function date_is_null ( $p_date ) { - if ( $p_date == date_get_null( ) ) { + if ( $p_date <= date_get_null( ) ) { return true; } return false; Modified: trunk/mantisbt/core/version_api.php =================================================================== --- trunk/mantisbt/core/version_api.php 2008-04-19 07:00:35 UTC (rev 5175) +++ trunk/mantisbt/core/version_api.php 2008-04-20 04:14:20 UTC (rev 5176) @@ -315,18 +315,23 @@ function version_get_all_rows_with_subs( $p_project_id, $p_released = null, $p_obsolete = false ) { $t_project_where = helper_project_specific_where( $p_project_id ); + $t_param_count = 0; + $t_query_params = array(); + if ( $p_released === null ) { $t_released_where = ''; } else { $c_released = db_prepare_int( $p_released ); - $t_released_where = "AND ( released = $c_released )"; + $t_released_where = "AND ( released = ". db_param($t_param_count++)." )"; + $t_query_params[] = $c_released; } if ( $p_obsolete === null ) { $t_obsolete_where = ''; } else { $c_obsolete = db_prepare_bool( $p_obsolete ); - $t_obsolete_where = "AND ( obsolete = $c_obsolete )"; + $t_obsolete_where = "AND ( obsolete = ". db_param($t_param_count++)." )"; + $t_query_params[] = $c_obsolete; } $t_project_version_table = db_get_table( 'mantis_project_version_table' ); @@ -335,7 +340,7 @@ FROM $t_project_version_table WHERE $t_project_where $t_released_where $t_obsolete_where ORDER BY date_order DESC"; - $result = db_query( $query ); + $result = db_query_bound( $query, $t_query_params ); $count = db_num_rows( $result ); $rows = array(); for ( $i = 0 ; $i < $count ; $i++ ) { This was sent by the SourceForge.net collaborative development platform, the world's largest Open Source development site. |
From: <dwa...@us...> - 2008-06-12 17:55:34
|
Revision: 5359 http://mantisbt.svn.sourceforge.net/mantisbt/?rev=5359&view=rev Author: dwarrine5 Date: 2008-06-12 10:55:28 -0700 (Thu, 12 Jun 2008) Log Message: ----------- Add package/subpackage documentation references for core apis Modified Paths: -------------- trunk/mantisbt/core/access_api.php trunk/mantisbt/core/ajax_api.php trunk/mantisbt/core/authentication_api.php trunk/mantisbt/core/bug_api.php trunk/mantisbt/core/bug_group_action_api.php trunk/mantisbt/core/bugnote_api.php trunk/mantisbt/core/category_api.php trunk/mantisbt/core/collapse_api.php trunk/mantisbt/core/columns_api.php trunk/mantisbt/core/compress_api.php trunk/mantisbt/core/config_api.php trunk/mantisbt/core/csv_api.php trunk/mantisbt/core/current_user_api.php trunk/mantisbt/core/custom_field_api.php trunk/mantisbt/core/custom_function_api.php trunk/mantisbt/core/database_api.php trunk/mantisbt/core/date_api.php trunk/mantisbt/core/email_api.php trunk/mantisbt/core/email_queue_api.php trunk/mantisbt/core/error_api.php trunk/mantisbt/core/event_api.php trunk/mantisbt/core/excel_api.php trunk/mantisbt/core/file_api.php trunk/mantisbt/core/filter_api.php trunk/mantisbt/core/form_api.php trunk/mantisbt/core/freemind_api.php trunk/mantisbt/core/gpc_api.php trunk/mantisbt/core/graph_api.php trunk/mantisbt/core/graphviz_api.php trunk/mantisbt/core/helper_api.php trunk/mantisbt/core/history_api.php trunk/mantisbt/core/html_api.php trunk/mantisbt/core/icon_api.php trunk/mantisbt/core/json_api.php trunk/mantisbt/core/lang_api.php trunk/mantisbt/core/last_visited_api.php trunk/mantisbt/core/ldap_api.php trunk/mantisbt/core/logging_api.php trunk/mantisbt/core/news_api.php trunk/mantisbt/core/php_api.php trunk/mantisbt/core/plugin_api.php trunk/mantisbt/core/prepare_api.php trunk/mantisbt/core/print_api.php trunk/mantisbt/core/profile_api.php trunk/mantisbt/core/projax_api.php trunk/mantisbt/core/project_api.php trunk/mantisbt/core/project_hierarchy_api.php trunk/mantisbt/core/relationship_api.php trunk/mantisbt/core/relationship_graph_api.php trunk/mantisbt/core/rss_api.php trunk/mantisbt/core/session_api.php trunk/mantisbt/core/sponsorship_api.php trunk/mantisbt/core/string_api.php trunk/mantisbt/core/summary_api.php trunk/mantisbt/core/tag_api.php trunk/mantisbt/core/timer_api.php trunk/mantisbt/core/tokens_api.php trunk/mantisbt/core/twitter_api.php trunk/mantisbt/core/user_api.php trunk/mantisbt/core/user_pref_api.php trunk/mantisbt/core/utility_api.php trunk/mantisbt/core/version_api.php trunk/mantisbt/core/wiki_api.php trunk/mantisbt/core/xmlhttprequest_api.php Modified: trunk/mantisbt/core/access_api.php =================================================================== --- trunk/mantisbt/core/access_api.php 2008-06-12 15:25:26 UTC (rev 5358) +++ trunk/mantisbt/core/access_api.php 2008-06-12 17:55:28 UTC (rev 5359) @@ -21,6 +21,10 @@ # $Id$ # -------------------------------------------------------- + /** + * @package CoreAPI + * @subpackage AccessAPI + */ $t_core_dir = dirname( __FILE__ ).DIRECTORY_SEPARATOR; require_once( $t_core_dir . 'constant_inc.php' ); Modified: trunk/mantisbt/core/ajax_api.php =================================================================== --- trunk/mantisbt/core/ajax_api.php 2008-06-12 15:25:26 UTC (rev 5358) +++ trunk/mantisbt/core/ajax_api.php 2008-06-12 17:55:28 UTC (rev 5359) @@ -21,6 +21,10 @@ # $Id$ # -------------------------------------------------------- + /** + * @package CoreAPI + * @subpackage AjaxAPI + */ $t_core_dir = dirname( __FILE__ ).DIRECTORY_SEPARATOR; require_once( $t_core_dir . 'bug_api.php' ); Modified: trunk/mantisbt/core/authentication_api.php =================================================================== --- trunk/mantisbt/core/authentication_api.php 2008-06-12 15:25:26 UTC (rev 5358) +++ trunk/mantisbt/core/authentication_api.php 2008-06-12 17:55:28 UTC (rev 5359) @@ -21,6 +21,10 @@ # $Id$ # -------------------------------------------------------- + /** + * @package CoreAPI + * @subpackage AuthenticationAPI + */ require_once( dirname( __FILE__ ) . DIRECTORY_SEPARATOR . 'gpc_api.php' ); ### Authentication API ### Modified: trunk/mantisbt/core/bug_api.php =================================================================== --- trunk/mantisbt/core/bug_api.php 2008-06-12 15:25:26 UTC (rev 5358) +++ trunk/mantisbt/core/bug_api.php 2008-06-12 17:55:28 UTC (rev 5359) @@ -21,6 +21,10 @@ # $Id$ # -------------------------------------------------------- + /** + * @package CoreAPI + * @subpackage BugAPI + */ $t_core_dir = dirname( __FILE__ ).DIRECTORY_SEPARATOR; require_once( $t_core_dir . 'history_api.php' ); Modified: trunk/mantisbt/core/bug_group_action_api.php =================================================================== --- trunk/mantisbt/core/bug_group_action_api.php 2008-06-12 15:25:26 UTC (rev 5358) +++ trunk/mantisbt/core/bug_group_action_api.php 2008-06-12 17:55:28 UTC (rev 5359) @@ -20,9 +20,13 @@ # -------------------------------------------------------- # $Id$ # -------------------------------------------------------- -?> -<?php + /** + * @package CoreAPI + * @subpackage BugGroupActionAPI + */ + + /** * Print the top part for the bug action group page. */ function bug_group_action_print_top() { Modified: trunk/mantisbt/core/bugnote_api.php =================================================================== --- trunk/mantisbt/core/bugnote_api.php 2008-06-12 15:25:26 UTC (rev 5358) +++ trunk/mantisbt/core/bugnote_api.php 2008-06-12 17:55:28 UTC (rev 5359) @@ -21,6 +21,11 @@ # $Id$ # -------------------------------------------------------- + /** + * @package CoreAPI + * @subpackage BugnoteAPI + */ + $t_core_dir = dirname( __FILE__ ).DIRECTORY_SEPARATOR; require_once( $t_core_dir . 'current_user_api.php' ); Modified: trunk/mantisbt/core/category_api.php =================================================================== --- trunk/mantisbt/core/category_api.php 2008-06-12 15:25:26 UTC (rev 5358) +++ trunk/mantisbt/core/category_api.php 2008-06-12 17:55:28 UTC (rev 5359) @@ -21,6 +21,11 @@ # $Id$ # -------------------------------------------------------- + /** + * @package CoreAPI + * @subpackage CategoryAPI + */ + ### Category API ### # Category data cache (to prevent excessive db queries) Modified: trunk/mantisbt/core/collapse_api.php =================================================================== --- trunk/mantisbt/core/collapse_api.php 2008-06-12 15:25:26 UTC (rev 5358) +++ trunk/mantisbt/core/collapse_api.php 2008-06-12 17:55:28 UTC (rev 5359) @@ -21,6 +21,11 @@ # $Id$ # -------------------------------------------------------- + /** + * @package CoreAPI + * @subpackage CollapseAPI + */ + $t_core_dir = dirname( __FILE__ ).DIRECTORY_SEPARATOR; require_once( $t_core_dir . 'tokens_api.php' ); Modified: trunk/mantisbt/core/columns_api.php =================================================================== --- trunk/mantisbt/core/columns_api.php 2008-06-12 15:25:26 UTC (rev 5358) +++ trunk/mantisbt/core/columns_api.php 2008-06-12 17:55:28 UTC (rev 5359) @@ -21,6 +21,11 @@ # $Id$ # -------------------------------------------------------- + /** + * @package CoreAPI + * @subpackage ColumnsAPI + */ + /** * Get all accessible columns for the current project / current user.. */ Modified: trunk/mantisbt/core/compress_api.php =================================================================== --- trunk/mantisbt/core/compress_api.php 2008-06-12 15:25:26 UTC (rev 5358) +++ trunk/mantisbt/core/compress_api.php 2008-06-12 17:55:28 UTC (rev 5359) @@ -21,6 +21,11 @@ # $Id$ # -------------------------------------------------------- + /** + * @package CoreAPI + * @subpackage CompressionAPI + */ + ### Compression API ### # Starts the buffering/compression (only if the compression option is ON) Modified: trunk/mantisbt/core/config_api.php =================================================================== --- trunk/mantisbt/core/config_api.php 2008-06-12 15:25:26 UTC (rev 5358) +++ trunk/mantisbt/core/config_api.php 2008-06-12 17:55:28 UTC (rev 5359) @@ -21,6 +21,11 @@ # $Id$ # -------------------------------------------------------- + /** + * @package CoreAPI + * @subpackage ConfigurationAPI + */ + require_once( dirname( __FILE__ ) . DIRECTORY_SEPARATOR . 'error_api.php' ); # cache for config variables Modified: trunk/mantisbt/core/csv_api.php =================================================================== --- trunk/mantisbt/core/csv_api.php 2008-06-12 15:25:26 UTC (rev 5358) +++ trunk/mantisbt/core/csv_api.php 2008-06-12 17:55:28 UTC (rev 5359) @@ -21,6 +21,11 @@ # $Id$ # -------------------------------------------------------- + /** + * @package CoreAPI + * @subpackage CSVAPI + */ + ### CSV API ### # -------------------- Modified: trunk/mantisbt/core/current_user_api.php =================================================================== --- trunk/mantisbt/core/current_user_api.php 2008-06-12 15:25:26 UTC (rev 5358) +++ trunk/mantisbt/core/current_user_api.php 2008-06-12 17:55:28 UTC (rev 5359) @@ -21,6 +21,11 @@ # $Id$ # -------------------------------------------------------- + /** + * @package CoreAPI + * @subpackage CurrentUserAPI + */ + $t_core_dir = dirname( __FILE__ ).DIRECTORY_SEPARATOR; require_once( $t_core_dir . 'filter_api.php' ); Modified: trunk/mantisbt/core/custom_field_api.php =================================================================== --- trunk/mantisbt/core/custom_field_api.php 2008-06-12 15:25:26 UTC (rev 5358) +++ trunk/mantisbt/core/custom_field_api.php 2008-06-12 17:55:28 UTC (rev 5359) @@ -21,6 +21,11 @@ # $Id$ # -------------------------------------------------------- + /** + * @package CoreAPI + * @subpackage CustomFieldAPI + */ + $t_core_dir = dirname( __FILE__ ).DIRECTORY_SEPARATOR; require_once( $t_core_dir . 'bug_api.php' ); Modified: trunk/mantisbt/core/custom_function_api.php =================================================================== --- trunk/mantisbt/core/custom_function_api.php 2008-06-12 15:25:26 UTC (rev 5358) +++ trunk/mantisbt/core/custom_function_api.php 2008-06-12 17:55:28 UTC (rev 5359) @@ -21,6 +21,11 @@ # $Id$ # -------------------------------------------------------- + /** + * @package CoreAPI + * @subpackage CustomFunctionAPI + */ + $t_core_dir = dirname( __FILE__ ).DIRECTORY_SEPARATOR; require_once( $t_core_dir . 'prepare_api.php' ); Modified: trunk/mantisbt/core/database_api.php =================================================================== --- trunk/mantisbt/core/database_api.php 2008-06-12 15:25:26 UTC (rev 5358) +++ trunk/mantisbt/core/database_api.php 2008-06-12 17:55:28 UTC (rev 5359) @@ -27,7 +27,8 @@ * This is the general interface for all database calls. * Modifications required for database support, outside of adodb support should occur here. * - * @package DatabaseAPI + * @package CoreAPI + * @subpackage DatabaseAPI * @uses config_api.php * @uses gpc_api.php */ Modified: trunk/mantisbt/core/date_api.php =================================================================== --- trunk/mantisbt/core/date_api.php 2008-06-12 15:25:26 UTC (rev 5358) +++ trunk/mantisbt/core/date_api.php 2008-06-12 17:55:28 UTC (rev 5359) @@ -21,6 +21,11 @@ # $Id$ # -------------------------------------------------------- + /** + * @package CoreAPI + * @subpackage DateAPI + */ + ### Date API ### # -------------------- # checks if date is null Modified: trunk/mantisbt/core/email_api.php =================================================================== --- trunk/mantisbt/core/email_api.php 2008-06-12 15:25:26 UTC (rev 5358) +++ trunk/mantisbt/core/email_api.php 2008-06-12 17:55:28 UTC (rev 5359) @@ -21,6 +21,11 @@ # $Id$ # -------------------------------------------------------- + /** + * @package CoreAPI + * @subpackage EmailAPI + */ + $t_core_dir = dirname( __FILE__ ).DIRECTORY_SEPARATOR; define( 'PHPMAILER_PATH', $t_core_dir . 'phpmailer' . DIRECTORY_SEPARATOR ); Modified: trunk/mantisbt/core/email_queue_api.php =================================================================== --- trunk/mantisbt/core/email_queue_api.php 2008-06-12 15:25:26 UTC (rev 5358) +++ trunk/mantisbt/core/email_queue_api.php 2008-06-12 17:55:28 UTC (rev 5359) @@ -21,6 +21,12 @@ # $Id$ # -------------------------------------------------------- + /** + * @package CoreAPI + * @subpackage EmailQueueAPI + */ + + class EmailData { // properties set during creation var $email = ''; Modified: trunk/mantisbt/core/error_api.php =================================================================== --- trunk/mantisbt/core/error_api.php 2008-06-12 15:25:26 UTC (rev 5358) +++ trunk/mantisbt/core/error_api.php 2008-06-12 17:55:28 UTC (rev 5359) @@ -21,6 +21,11 @@ # $Id$ # -------------------------------------------------------- + /** + * @package CoreAPI + * @subpackage ErrorAPI + */ + ### Error API ### # set up error_handler() as the new default error handling function Modified: trunk/mantisbt/core/event_api.php =================================================================== --- trunk/mantisbt/core/event_api.php 2008-06-12 15:25:26 UTC (rev 5358) +++ trunk/mantisbt/core/event_api.php 2008-06-12 17:55:28 UTC (rev 5359) @@ -23,6 +23,8 @@ /** * Event API * Handles the event system. + * @package CoreAPI + * @subpackage EventAPI * * @author John Reese */ Modified: trunk/mantisbt/core/excel_api.php =================================================================== --- trunk/mantisbt/core/excel_api.php 2008-06-12 15:25:26 UTC (rev 5358) +++ trunk/mantisbt/core/excel_api.php 2008-06-12 17:55:28 UTC (rev 5359) @@ -21,6 +21,11 @@ # $Id$ # -------------------------------------------------------- + /** + * @package CoreAPI + * @subpackage ExcelAPI + */ + ### Excel API ### /** @@ -423,4 +428,4 @@ // field is not linked to project return excel_prepare_string( '' ); } -?> \ No newline at end of file +?> Modified: trunk/mantisbt/core/file_api.php =================================================================== --- trunk/mantisbt/core/file_api.php 2008-06-12 15:25:26 UTC (rev 5358) +++ trunk/mantisbt/core/file_api.php 2008-06-12 17:55:28 UTC (rev 5359) @@ -21,6 +21,11 @@ # $Id$ # -------------------------------------------------------- + /** + * @package CoreAPI + * @subpackage FileAPI + */ + $t_core_dir = dirname( __FILE__ ).DIRECTORY_SEPARATOR; require_once( $t_core_dir . 'history_api.php' ); Modified: trunk/mantisbt/core/filter_api.php =================================================================== --- trunk/mantisbt/core/filter_api.php 2008-06-12 15:25:26 UTC (rev 5358) +++ trunk/mantisbt/core/filter_api.php 2008-06-12 17:55:28 UTC (rev 5359) @@ -21,6 +21,11 @@ # $Id$ # -------------------------------------------------------- + /** + * @package CoreAPI + * @subpackage FilterAPI + */ + $t_core_dir = dirname( __FILE__ ).DIRECTORY_SEPARATOR; require_once( $t_core_dir . 'current_user_api.php' ); Modified: trunk/mantisbt/core/form_api.php =================================================================== --- trunk/mantisbt/core/form_api.php 2008-06-12 15:25:26 UTC (rev 5358) +++ trunk/mantisbt/core/form_api.php 2008-06-12 17:55:28 UTC (rev 5359) @@ -21,7 +21,8 @@ * Security methods are targetted to work with both GET and POST form types, * and should allow multiple simultaneous edits of the form to be submitted. * - * @package FormAPI + * @package CoreAPI + * @subpackage FormAPI * @uses session_api.php */ Modified: trunk/mantisbt/core/freemind_api.php =================================================================== --- trunk/mantisbt/core/freemind_api.php 2008-06-12 15:25:26 UTC (rev 5358) +++ trunk/mantisbt/core/freemind_api.php 2008-06-12 17:55:28 UTC (rev 5359) @@ -26,6 +26,11 @@ # $Id$ # -------------------------------------------------------- + /** + * @package CoreAPI + * @subpackage FreemindAPI + */ + $t_core_dir = dirname( __FILE__ ) . DIRECTORY_SEPARATOR; require_once( $t_core_dir . 'filter_api.php' ); Modified: trunk/mantisbt/core/gpc_api.php =================================================================== --- trunk/mantisbt/core/gpc_api.php 2008-06-12 15:25:26 UTC (rev 5358) +++ trunk/mantisbt/core/gpc_api.php 2008-06-12 17:55:28 UTC (rev 5359) @@ -21,6 +21,11 @@ # $Id$ # -------------------------------------------------------- + /** + * @package CoreAPI + * @subpackage GPCAPI + */ + ### GET, POST, and Cookie API ### # --------------- Modified: trunk/mantisbt/core/graph_api.php =================================================================== --- trunk/mantisbt/core/graph_api.php 2008-06-12 15:25:26 UTC (rev 5358) +++ trunk/mantisbt/core/graph_api.php 2008-06-12 17:55:28 UTC (rev 5359) @@ -20,7 +20,12 @@ # -------------------------------------------------------- # $Id$ # -------------------------------------------------------- + /** + * @package CoreAPI + * @subpackage GraphAPI + */ + if ( ON == config_get( 'use_jpgraph' ) ) { $t_jpgraph_path = config_get( 'jpgraph_path' ); Modified: trunk/mantisbt/core/graphviz_api.php =================================================================== --- trunk/mantisbt/core/graphviz_api.php 2008-06-12 15:25:26 UTC (rev 5358) +++ trunk/mantisbt/core/graphviz_api.php 2008-06-12 17:55:28 UTC (rev 5359) @@ -23,24 +23,23 @@ ### GraphViz API ### - # ================================================================ - # Author: Juliano Ravasi Ferraz <jferraz at users sourceforge net> - # ================================================================ - # - # Wrapper classes around GraphViz utilities (dot and neato) for - # directed and undirected graph generation. Under Windows, the COM - # API provided by WinGraphviz is used. These wrappers are enhanced - # enough just to support relationship_graph_api.php. They don't - # support subgraphs yet. - # - # The original Graphviz package is available at: - # - http://www.research.att.com/sw/tools/graphviz/ - # - # WinGraphviz can be installed from: - # - http://home.so-net.net.tw/oodtsen/wingraphviz/ - # - # Additional documentation can be found at: - # - http://www.graphviz.org/Documentation.html + /** + * Wrapper classes around GraphViz utilities (dot and neato) for + * directed and undirected graph generation. Under Windows, the COM + * API provided by WinGraphviz is used. These wrappers are enhanced + * enough just to support relationship_graph_api.php. They don't + * support subgraphs yet. + * + * The original Graphviz package is available at: + * - http://www.research.att.com/sw/tools/graphviz/ + * WinGraphviz can be installed from: + * - http://home.so-net.net.tw/oodtsen/wingraphviz/ + * Additional documentation can be found at: + * - http://www.graphviz.org/Documentation.html + * @package CoreAPI + * @subpackage GraphVizAPI + * @author Juliano Ravasi Ferraz <jferraz at users sourceforge net> + */ # -------------------- # These constants define the output formats supported by dot and neato. Modified: trunk/mantisbt/core/helper_api.php =================================================================== --- trunk/mantisbt/core/helper_api.php 2008-06-12 15:25:26 UTC (rev 5358) +++ trunk/mantisbt/core/helper_api.php 2008-06-12 17:55:28 UTC (rev 5359) @@ -21,7 +21,10 @@ # $Id$ # -------------------------------------------------------- - ### Helper API ### + /** + * @package CoreAPI + * @subpackage HelperAPI + */ # These are miscellaneous functions Modified: trunk/mantisbt/core/history_api.php =================================================================== --- trunk/mantisbt/core/history_api.php 2008-06-12 15:25:26 UTC (rev 5358) +++ trunk/mantisbt/core/history_api.php 2008-06-12 17:55:28 UTC (rev 5359) @@ -21,7 +21,10 @@ # $Id$ # -------------------------------------------------------- - ### History API ### + /** + * @package CoreAPI + * @subpackage HistoryAPI + */ # -------------------- # log the changes (old / new value are supplied to reduce db access) Modified: trunk/mantisbt/core/html_api.php =================================================================== --- trunk/mantisbt/core/html_api.php 2008-06-12 15:25:26 UTC (rev 5358) +++ trunk/mantisbt/core/html_api.php 2008-06-12 17:55:28 UTC (rev 5359) @@ -21,44 +21,43 @@ # $Id$ # -------------------------------------------------------- - ########################################################################### - # HTML API - # - # These functions control the display of each page - # - # This is the call order of these functions, should you need to figure out - # which to modify or which to leave out. - # - # html_page_top1 - # html_begin - # html_head_begin - # html_css - # html_content_type - # html_rss_link - # (html_meta_redirect) - # html_title - # html_page_top2 - # html_page_top2a - # html_head_end - # html_body_begin - # html_header - # html_top_banner - # html_login_info - # (print_project_menu_bar) - # print_menu - # - # ...Page content here... - # - # html_page_bottom1 - # (print_menu) - # html_page_bottom1a - # html_bottom_banner - # html_footer - # html_body_end - # html_end - # - ########################################################################### - + /** + * @package CoreAPI + * @subpackage HTMLAPI + * + * These functions control the display of each page + * + * This is the call order of these functions, should you need to figure out + * which to modify or which to leave out. + * + * html_page_top1 + * html_begin + * html_head_begin + * html_css + * html_content_type + * html_rss_link + * (html_meta_redirect) + * html_title + * html_page_top2 + * html_page_top2a + * html_head_end + * html_body_begin + * html_header + * html_top_banner + * html_login_info + * (print_project_menu_bar) + * print_menu + * + * ...Page content here... + * + * html_page_bottom1 + * (print_menu) + * html_page_bottom1a + * html_bottom_banner + * html_footer + * html_body_end + * html_end + */ $t_core_dir = dirname( __FILE__ ).DIRECTORY_SEPARATOR; require_once( $t_core_dir . 'current_user_api.php' ); Modified: trunk/mantisbt/core/icon_api.php =================================================================== --- trunk/mantisbt/core/icon_api.php 2008-06-12 15:25:26 UTC (rev 5358) +++ trunk/mantisbt/core/icon_api.php 2008-06-12 17:55:28 UTC (rev 5359) @@ -21,6 +21,11 @@ # $Id$ # -------------------------------------------------------- + /** + * @package CoreAPI + * @subpackage IconAPI + */ + ### Icon API ### # -------------------- Modified: trunk/mantisbt/core/json_api.php =================================================================== --- trunk/mantisbt/core/json_api.php 2008-06-12 15:25:26 UTC (rev 5358) +++ trunk/mantisbt/core/json_api.php 2008-06-12 17:55:28 UTC (rev 5359) @@ -18,6 +18,8 @@ /** * API for simplifying some JSON interactions. + * @package CoreAPI + * @subpackage JSONAPI */ /** Modified: trunk/mantisbt/core/lang_api.php =================================================================== --- trunk/mantisbt/core/lang_api.php 2008-06-12 15:25:26 UTC (rev 5358) +++ trunk/mantisbt/core/lang_api.php 2008-06-12 17:55:28 UTC (rev 5359) @@ -21,8 +21,13 @@ # $Id$ # -------------------------------------------------------- - ### Language (Internationalization) API ## + /** + * Language (Internationalization) API + * @package CoreAPI + * @subpackage LanguageAPI + */ + # Cache of localization strings in the language specified by the last # lang_load call $g_lang_strings = array(); Modified: trunk/mantisbt/core/last_visited_api.php =================================================================== --- trunk/mantisbt/core/last_visited_api.php 2008-06-12 15:25:26 UTC (rev 5358) +++ trunk/mantisbt/core/last_visited_api.php 2008-06-12 17:55:28 UTC (rev 5359) @@ -20,6 +20,10 @@ # -------------------------------------------------------- # $Id$ # -------------------------------------------------------- + /** + * @package CoreAPI + * @subpackage LastVisitedAPI + */ $t_core_dir = dirname( __FILE__ ) . DIRECTORY_SEPARATOR; Modified: trunk/mantisbt/core/ldap_api.php =================================================================== --- trunk/mantisbt/core/ldap_api.php 2008-06-12 15:25:26 UTC (rev 5358) +++ trunk/mantisbt/core/ldap_api.php 2008-06-12 17:55:28 UTC (rev 5359) @@ -21,9 +21,11 @@ # $Id$ # -------------------------------------------------------- - ########################################################################### - # LDAP API - ########################################################################### + /** + * LDAP API + * @package CoreAPI + * @subpackage LDAPAPI + */ # -------------------- # Connect and bind to the LDAP directory Modified: trunk/mantisbt/core/logging_api.php =================================================================== --- trunk/mantisbt/core/logging_api.php 2008-06-12 15:25:26 UTC (rev 5358) +++ trunk/mantisbt/core/logging_api.php 2008-06-12 17:55:28 UTC (rev 5359) @@ -21,6 +21,13 @@ # $Id$ # -------------------------------------------------------- + /** + * Logging api + * This is used to log system events other than bug related history + * @package CoreAPI + * @subpackage LoggingAPI + */ + $t_core_dir = dirname( __FILE__ ).DIRECTORY_SEPARATOR; @@ -31,11 +38,6 @@ LOG_AJAX => 'ajax' ); - ########################################################################### - # Logging api - # This is used to log system events other than bug related history - ########################################################################### - function log_event( $p_level, $p_msg ) { global $g_log_levels; Modified: trunk/mantisbt/core/news_api.php =================================================================== --- trunk/mantisbt/core/news_api.php 2008-06-12 15:25:26 UTC (rev 5358) +++ trunk/mantisbt/core/news_api.php 2008-06-12 17:55:28 UTC (rev 5359) @@ -21,8 +21,13 @@ # $Id$ # -------------------------------------------------------- - ### News API ### + /** + * News API + * @package CoreAPI + * @subpackage NewsAPI + */ + $t_core_path = config_get( 'core_path' ); require_once( $t_core_path . 'current_user_api.php' ); Modified: trunk/mantisbt/core/php_api.php =================================================================== --- trunk/mantisbt/core/php_api.php 2008-06-12 15:25:26 UTC (rev 5358) +++ trunk/mantisbt/core/php_api.php 2008-06-12 17:55:28 UTC (rev 5359) @@ -21,10 +21,12 @@ # $Id$ # -------------------------------------------------------- - ### PHP Compatibility API ### + /** + * Functions to help in backwards compatibility of PHP versions, etc. + * @package CoreAPI + * @subpackage PHPCompatibilityAPI + */ - # Functions to help in backwards compatibility of PHP versions, etc. - # Constant for our minimum required PHP version define( 'PHP_MIN_VERSION', '5.1.0' ); Modified: trunk/mantisbt/core/plugin_api.php =================================================================== --- trunk/mantisbt/core/plugin_api.php 2008-06-12 15:25:26 UTC (rev 5358) +++ trunk/mantisbt/core/plugin_api.php 2008-06-12 17:55:28 UTC (rev 5359) @@ -17,10 +17,10 @@ # along with Mantis. If not, see <http://www.gnu.org/licenses/>. /** - * Plugin API - * Handles the initialisation, management, and execution of plugins. - * - * @package PluginAPI + * Plugin API + * Handles the initialisation, management, and execution of plugins. + * @package CoreAPI + * @subpackage PluginAPI */ $t_class_path = config_get_global( 'class_path' ); Modified: trunk/mantisbt/core/prepare_api.php =================================================================== --- trunk/mantisbt/core/prepare_api.php 2008-06-12 15:25:26 UTC (rev 5358) +++ trunk/mantisbt/core/prepare_api.php 2008-06-12 17:55:28 UTC (rev 5359) @@ -21,14 +21,16 @@ # $Id$ # -------------------------------------------------------- + /** + * this file handles preparing of strings like to be printed + * or stored. print_api.php will gradually be replaced by + * think calls to echo the results of functions implemented here. + * @package CoreAPI + * @subpackage PrepareAPI + */ + $t_core_dir = dirname( __FILE__ ).DIRECTORY_SEPARATOR; - ### Prepare API ### - - # this file handles preparing of strings like to be printed - # or stored. print_api.php will gradually be replaced by - # think calls to echo the results of functions implemented here. - # -------------------- # return the mailto: href string link function prepare_email_link( $p_email, $p_text ) { Modified: trunk/mantisbt/core/print_api.php =================================================================== --- trunk/mantisbt/core/print_api.php 2008-06-12 15:25:26 UTC (rev 5358) +++ trunk/mantisbt/core/print_api.php 2008-06-12 17:55:28 UTC (rev 5359) @@ -21,6 +21,12 @@ # $Id$ # -------------------------------------------------------- + /** + * this file handles printing functions + * @package CoreAPI + * @subpackage PrintAPI + */ + $t_core_dir = dirname( __FILE__ ).DIRECTORY_SEPARATOR; require_once( $t_core_dir . 'ajax_api.php' ); @@ -31,10 +37,7 @@ require_once( $t_core_dir . 'last_visited_api.php' ); require_once( $t_core_dir . 'file_api.php' ); - ### Print API ### - # this file handles printing functions - # -------------------- # Print the headers to cause the page to redirect to $p_url # If $p_die is true (default), terminate the execution of the script Modified: trunk/mantisbt/core/profile_api.php =================================================================== --- trunk/mantisbt/core/profile_api.php 2008-06-12 15:25:26 UTC (rev 5358) +++ trunk/mantisbt/core/profile_api.php 2008-06-12 17:55:28 UTC (rev 5359) @@ -21,7 +21,10 @@ # $Id$ # -------------------------------------------------------- - ### Profile API ### + /** + * @package CoreAPI + * @subpackage ProfileAPI + */ #=================================== # Boolean queries and ensures Modified: trunk/mantisbt/core/projax_api.php =================================================================== --- trunk/mantisbt/core/projax_api.php 2008-06-12 15:25:26 UTC (rev 5358) +++ trunk/mantisbt/core/projax_api.php 2008-06-12 17:55:28 UTC (rev 5359) @@ -21,6 +21,11 @@ # $Id$ # -------------------------------------------------------- + /** + * @package CoreAPI + * @subpackage ProjaxAPI + */ + require_once( dirname( __FILE__ ) . DIRECTORY_SEPARATOR . 'projax' . DIRECTORY_SEPARATOR . 'projax.php' ); # enables the projax library for this page. Modified: trunk/mantisbt/core/project_api.php =================================================================== --- trunk/mantisbt/core/project_api.php 2008-06-12 15:25:26 UTC (rev 5358) +++ trunk/mantisbt/core/project_api.php 2008-06-12 17:55:28 UTC (rev 5359) @@ -21,6 +21,11 @@ # $Id$ # -------------------------------------------------------- + /** + * @package CoreAPI + * @subpackage ProjectAPI + */ + $t_core_dir = dirname( __FILE__ ).DIRECTORY_SEPARATOR; require_once( $t_core_dir . 'category_api.php' ); Modified: trunk/mantisbt/core/project_hierarchy_api.php =================================================================== --- trunk/mantisbt/core/project_hierarchy_api.php 2008-06-12 15:25:26 UTC (rev 5358) +++ trunk/mantisbt/core/project_hierarchy_api.php 2008-06-12 17:55:28 UTC (rev 5359) @@ -21,8 +21,13 @@ # $Id$ # -------------------------------------------------------- - ### Project Hierarchy API ### + /** + * Project Hierarchy API + * @package CoreAPI + * @subpackage ProjectHierarchyAPI + */ + $t_core_dir = dirname( __FILE__ ).DIRECTORY_SEPARATOR; # -------------------- Modified: trunk/mantisbt/core/relationship_api.php =================================================================== --- trunk/mantisbt/core/relationship_api.php 2008-06-12 15:25:26 UTC (rev 5358) +++ trunk/mantisbt/core/relationship_api.php 2008-06-12 17:55:28 UTC (rev 5359) @@ -64,7 +64,8 @@ * - not copy history, bugnotes, monitoring users * - set a relationship between parent and child * - * @package RelationshipAPI + * @package CoreAPI + * @subpackage RelationshipAPI * @author Marcello Scata' <marcelloscata at users.sourceforge.net> ITALY */ Modified: trunk/mantisbt/core/relationship_graph_api.php =================================================================== --- trunk/mantisbt/core/relationship_graph_api.php 2008-06-12 15:25:26 UTC (rev 5358) +++ trunk/mantisbt/core/relationship_graph_api.php 2008-06-12 17:55:28 UTC (rev 5359) @@ -21,34 +21,33 @@ # $Id$ # -------------------------------------------------------- - ### Relationship Graph API ### + /** + * This uses GraphViz utilities to generate relationship graphs for + * issues. Either GraphViz (for all OSs except Windows) or + * WinGraphviz (for Windows) must be installed in order to use this + * feature. + * + * Graphviz is available at: + * - http://www.graphviz.org/ + * - http://www.research.att.com/sw/tools/graphviz/ + * + * WinGraphviz is available at: + * - http://home.so-net.net.tw/oodtsen/wingraphviz/ + * + * Most Linux distributions already have a GraphViz package + * conveniently available for download and install. Refer to + * config_defaults_inc.php for how to enable this feature once + * GraphViz is installed. + * @package CoreAPI + * @subpackage RelationshipGraphAPI + * @author Juliano Ravasi Ferraz <jferraz at users sourceforge net> + */ $t_core_dir = dirname( __FILE__ ).DIRECTORY_SEPARATOR; require_once( $t_core_dir . 'relationship_api.php' ); require_once( $t_core_dir . 'graphviz_api.php' ); - # ================================================================ - # Author: Juliano Ravasi Ferraz <jferraz at users sourceforge net> - # ================================================================ - # - # This uses GraphViz utilities to generate relationship graphs for - # issues. Either GraphViz (for all OSs except Windows) or - # WinGraphviz (for Windows) must be installed in order to use this - # feature. - # - # Graphviz is available at: - # - http://www.graphviz.org/ - # - http://www.research.att.com/sw/tools/graphviz/ - # - # WinGraphviz is available at: - # - http://home.so-net.net.tw/oodtsen/wingraphviz/ - # - # Most Linux distributions already have a GraphViz package - # conveniently available for download and install. Refer to - # config_defaults_inc.php for how to enable this feature once - # GraphViz is installed. - # -------------------- # Generate a relationship graph for the given issue. function relgraph_generate_rel_graph( $p_bug_id, $p_bug = null ) { Modified: trunk/mantisbt/core/rss_api.php =================================================================== --- trunk/mantisbt/core/rss_api.php 2008-06-12 15:25:26 UTC (rev 5358) +++ trunk/mantisbt/core/rss_api.php 2008-06-12 17:55:28 UTC (rev 5359) @@ -21,7 +21,10 @@ # $Id$ # -------------------------------------------------------- - ### RSS API ### + /** + * @package CoreAPI + * @subpackage RSSAPI + */ # -------------------- # Calculates a key to be used for RSS authentication based on user name, cookie and password. Modified: trunk/mantisbt/core/session_api.php =================================================================== --- trunk/mantisbt/core/session_api.php 2008-06-12 15:25:26 UTC (rev 5358) +++ trunk/mantisbt/core/session_api.php 2008-06-12 17:55:28 UTC (rev 5359) @@ -22,7 +22,8 @@ * the API is used. Calls to session_*() are appropriately directed at the * session handler class as chosen in config_inc.php. * - * @package SessionAPI + * @package CoreAPI + * @subpackage SessionAPI */ $g_session = null; Modified: trunk/mantisbt/core/sponsorship_api.php =================================================================== --- trunk/mantisbt/core/sponsorship_api.php 2008-06-12 15:25:26 UTC (rev 5358) +++ trunk/mantisbt/core/sponsorship_api.php 2008-06-12 17:55:28 UTC (rev 5359) @@ -21,6 +21,11 @@ # $Id$ # -------------------------------------------------------- + /** + * @package CoreAPI + * @subpackage SponsorshipAPI + */ + $t_core_dir = dirname( __FILE__ ).DIRECTORY_SEPARATOR; require_once( $t_core_dir . 'email_api.php' ); Modified: trunk/mantisbt/core/string_api.php =================================================================== --- trunk/mantisbt/core/string_api.php 2008-06-12 15:25:26 UTC (rev 5358) +++ trunk/mantisbt/core/string_api.php 2008-06-12 17:55:28 UTC (rev 5359) @@ -21,12 +21,16 @@ # $Id$ # -------------------------------------------------------- + /** + * @package CoreAPI + * @subpackage StringProcessingAPI + */ + $t_core_dir = dirname( __FILE__ ).DIRECTORY_SEPARATOR; require_once( $t_core_dir . 'bug_api.php' ); require_once( $t_core_dir . 'user_pref_api.php' ); - ### String Processing API ### $g_cache_html_valid_tags = ''; $g_cache_html_valid_tags_single_line = ''; Modified: trunk/mantisbt/core/summary_api.php =================================================================== --- trunk/mantisbt/core/summary_api.php 2008-06-12 15:25:26 UTC (rev 5358) +++ trunk/mantisbt/core/summary_api.php 2008-06-12 17:55:28 UTC (rev 5359) @@ -21,7 +21,10 @@ # $Id$ # -------------------------------------------------------- - ### Summary printing API ### + /** + * @package CoreAPI + * @subpackage SummaryAPI + */ # -------------------- function summary_helper_print_row( $p_label, $p_open, $p_resolved, $p_closed, $p_total ) { Modified: trunk/mantisbt/core/tag_api.php =================================================================== --- trunk/mantisbt/core/tag_api.php 2008-06-12 15:25:26 UTC (rev 5358) +++ trunk/mantisbt/core/tag_api.php 2008-06-12 17:55:28 UTC (rev 5359) @@ -23,7 +23,8 @@ /** * Tag API * - * @package TagAPI + * @package CoreAPI + * @subpackage TagAPI * @author John Reese */ Modified: trunk/mantisbt/core/timer_api.php =================================================================== --- trunk/mantisbt/core/timer_api.php 2008-06-12 15:25:26 UTC (rev 5358) +++ trunk/mantisbt/core/timer_api.php 2008-06-12 17:55:28 UTC (rev 5359) @@ -21,18 +21,20 @@ # $Id$ # -------------------------------------------------------- - ### Timer API ### + /** + * --- BC Timer ------- + * USAGE: set $g_debug_timer to ON and just call mark_time( 'token name' ); + * where 'token name' is descriptive of what is happening at that point + * + * Normally you would mark_time() before and after a critical section of + * code that you are timing. Remember to test more than once since various + * factors can affect actual runtime. + * @author Charles Killian, modified by Kenzaburo Ito + * @package CoreAPI + * @subpackage TimerAPI + */ - # --- BC Timer ------- - # Charles Killian, modified by Kenzaburo Ito - # USAGE: set $g_debug_timer to ON and just call mark_time( 'token name' ); - # where 'token name' is descriptive of what is happening at that point - - # Normally you would mark_time() before and after a critical section of - # code that you are timing. Remember to test more than once since various - # factors can affect actual runtime. - # -------------------- # You should use this function instead of the class function function mark_time( $p_marker_name ) { Modified: trunk/mantisbt/core/tokens_api.php =================================================================== --- trunk/mantisbt/core/tokens_api.php 2008-06-12 15:25:26 UTC (rev 5358) +++ trunk/mantisbt/core/tokens_api.php 2008-06-12 17:55:28 UTC (rev 5359) @@ -21,9 +21,14 @@ # $Id$ # -------------------------------------------------------- - # This implements temporary storage of strings. - # DB schema: id, type, owner, timestamp, value + /** + * This implements temporary storage of strings. + * DB schema: id, type, owner, timestamp, value + * @package CoreAPI + * @subpackage TokensAPI + */ + # Set up global for token_purge_expired_once() $g_tokens_purged = false; Modified: trunk/mantisbt/core/twitter_api.php =================================================================== --- trunk/mantisbt/core/twitter_api.php 2008-06-12 15:25:26 UTC (rev 5358) +++ trunk/mantisbt/core/twitter_api.php 2008-06-12 17:55:28 UTC (rev 5359) @@ -21,6 +21,11 @@ # $Id$ # -------------------------------------------------------- + /** + * @package CoreAPI + * @subpackage TwitterAPI + */ + $t_core_dir = dirname( __FILE__ ).DIRECTORY_SEPARATOR; require_once( $t_core_dir . 'config_api.php' ); Modified: trunk/mantisbt/core/user_api.php =================================================================== --- trunk/mantisbt/core/user_api.php 2008-06-12 15:25:26 UTC (rev 5358) +++ trunk/mantisbt/core/user_api.php 2008-06-12 17:55:28 UTC (rev 5359) @@ -21,12 +21,16 @@ # $Id$ # -------------------------------------------------------- + /** + * @package CoreAPI + * @subpackage UserAPI + */ + $t_core_dir = dirname( __FILE__ ).DIRECTORY_SEPARATOR; require_once( $t_core_dir . 'email_api.php' ); require_once( $t_core_dir . 'ldap_api.php' ); - ### User API ### #=================================== # Caching Modified: trunk/mantisbt/core/user_pref_api.php =================================================================== --- trunk/mantisbt/core/user_pref_api.php 2008-06-12 15:25:26 UTC (rev 5358) +++ trunk/mantisbt/core/user_pref_api.php 2008-06-12 17:55:28 UTC (rev 5359) @@ -21,6 +21,11 @@ # $Id$ # -------------------------------------------------------- + /** + * @package CoreAPI + * @subpackage UserPreferencesAPI + */ + ### User Preferences API ### $g_default_mapping = array( 'default_profile' => 'default_profile', Modified: trunk/mantisbt/core/utility_api.php =================================================================== --- trunk/mantisbt/core/utility_api.php 2008-06-12 15:25:26 UTC (rev 5358) +++ trunk/mantisbt/core/utility_api.php 2008-06-12 17:55:28 UTC (rev 5359) @@ -21,16 +21,18 @@ # $Id$ # -------------------------------------------------------- - ### Utility API ### + /** + * Utility functions are *small* functions that are used often and therefore + * have *no* prefix, to keep their names short. + * + * Utility functions have *no* dependencies on any other APIs, since they are + * included first in order to make them available to all the APIs. + * Miscellaneous functions that provide functionality on top of other APIS + * are found in the helper_api. + * @package CoreAPI + * @subpackage UtilityAPI + */ - # Utility functions are *small* functions that are used often and therefore - # have *no* prefix, to keep their names short. - # - # Utility functions have *no* dependencies on any other APIs, since they are - # included first in order to make them available to all the APIs. - # Miscellaneous functions that provide functionality on top of other APIS - # are found in the helper_api. - # -------------------- # converts a 1 value to X # converts a 0 value to a space Modified: trunk/mantisbt/core/version_api.php =================================================================== --- trunk/mantisbt/core/version_api.php 2008-06-12 15:25:26 UTC (rev 5358) +++ trunk/mantisbt/core/version_api.php 2008-06-12 17:55:28 UTC (rev 5359) @@ -21,7 +21,10 @@ # $Id$ # -------------------------------------------------------- - ### Version API ### + /** + * @package CoreAPI + * @subpackage VersionAPI + */ #========================================= # Version Data Structure Definition Modified: trunk/mantisbt/core/wiki_api.php =================================================================== --- trunk/mantisbt/core/wiki_api.php 2008-06-12 15:25:26 UTC (rev 5358) +++ trunk/mantisbt/core/wiki_api.php 2008-06-12 17:55:28 UTC (rev 5359) @@ -16,6 +16,12 @@ # # You should have received a copy of the GNU General Public License # along with Mantis. If not, see <http://www.gnu.org/licenses/>. + + /** + * @package CoreAPI + * @subpackage WikiAPI + */ + function wiki_enabled() { return ( config_get_global( 'wiki_enable' ) == ON ); Modified: trunk/mantisbt/core/xmlhttprequest_api.php =================================================================== --- trunk/mantisbt/core/xmlhttprequest_api.php 2008-06-12 15:25:26 UTC (rev 5358) +++ trunk/mantisbt/core/xmlhttprequest_api.php 2008-06-12 17:55:28 UTC (rev 5359) @@ -21,6 +21,11 @@ # $Id$ # -------------------------------------------------------- + /** + * @package CoreAPI + * @subpackage XMLHttpRequestAPI + */ + $t_core_dir = dirname( __FILE__ ).DIRECTORY_SEPARATOR; require_once( $t_core_dir . 'bug_api.php' ); @@ -28,7 +33,6 @@ require_once( $t_core_dir . 'logging_api.php' ); require_once( $t_core_dir . 'projax_api.php' ); - ### XmlHttpRequest API ### function xmlhttprequest_issue_reporter_combobox() { $f_bug_id = gpc_get_int( 'issue_id' ); This was sent by the SourceForge.net collaborative development platform, the world's largest Open Source development site. |