# Mantis - a php based bugtracking system

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

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

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

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

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

# (at your option) any later version.

#

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

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

# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the

# GNU General Public License for more details.

#

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

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

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

	#   $Revision: 2643 $

	#     $Author: al $    

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

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

	$t_core_dir = dirname( __FILE__ ).DIRECTORY_SEPARATOR;

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

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

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

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

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

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

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

	# Filter Property Names

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

	define( 'FILTER_PROPERTY_FREE_TEXT', 'search' );

	define( 'FILTER_PROPERTY_CATEGORY', 'show_category' );

	define( 'FILTER_PROPERTY_SEVERITY_ID', 'show_severity' );

	define( 'FILTER_PROPERTY_STATUS_ID', 'show_status' );

	define( 'FILTER_PROPERTY_PRIORITY_ID', 'show_priority' );

	define( 'FILTER_PROPERTY_HIGHLIGHT_CHANGED', 'highlight_changed' );

	define( 'FILTER_PROPERTY_REPORTER_ID', 'reporter_id' );

	define( 'FILTER_PROPERTY_HANDLER_ID', 'handler_id' );

	define( 'FILTER_PROPERTY_PROJECT_ID', 'project_id' );

	define( 'FILTER_PROPERTY_RESOLUTION_ID', 'show_resolution' );

	define( 'FILTER_PROPERTY_PRODUCT_BUILD', 'show_build' );

	define( 'FILTER_PROPERTY_PRODUCT_VERSION', 'show_version' );

	define( 'FILTER_PROPERTY_MONITOR_USER_ID', 'user_monitor' );

	define( 'FILTER_PROPERTY_HIDE_STATUS_ID', 'hide_status' );

	define( 'FILTER_PROPERTY_SORT_FIELD_NAME', 'sort' );

	define( 'FILTER_PROPERTY_SORT_DIRECTION', 'dir' );

	define( 'FILTER_PROPERTY_SHOW_STICKY_ISSUES', 'sticky_issues' );

	define( 'FILTER_PROPERTY_VIEW_STATE_ID', 'view_state' );

	define( 'FILTER_PROPERTY_FIXED_IN_VERSION', 'fixed_in_version' );

	define( 'FILTER_PROPERTY_TARGET_VERSION', 'target_version' );

	define( 'FILTER_PROPERTY_ISSUES_PER_PAGE', 'per_page' );

	define( 'FILTER_PROPERTY_PROFILE', 'profile_id' );

	define( 'FILTER_PROPERTY_PLATFORM', 'platform' );

	define( 'FILTER_PROPERTY_OS', 'os' );

	define( 'FILTER_PROPERTY_OS_BUILD', 'os_build' );

	define( 'FILTER_PROPERTY_START_DAY', 'start_day' );

	define( 'FILTER_PROPERTY_START_MONTH', 'start_month' );

	define( 'FILTER_PROPERTY_START_YEAR', 'start_year' );

	define( 'FILTER_PROPERTY_END_DAY', 'end_day' );

	define( 'FILTER_PROPERTY_END_MONTH', 'end_month' );

	define( 'FILTER_PROPERTY_END_YEAR', 'end_year' );

	define( 'FILTER_PROPERTY_NOT_ASSIGNED', 'and_not_assigned' );

	define( 'FILTER_PROPERTY_FILTER_BY_DATE', 'do_filter_by_date' );

	define( 'FILTER_PROPERTY_RELATIONSHIP_TYPE', 'relationship_type' );

	define( 'FILTER_PROPERTY_RELATIONSHIP_BUG', 'relationship_bug' );

	define( 'FILTER_PROPERTY_TAG_STRING', 'tag_string' );

	define( 'FILTER_PROPERTY_TAG_SELECT', 'tag_select' );

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

	# Filter Query Parameter Names

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

	define( 'FILTER_SEARCH_FREE_TEXT', 'search' );

	define( 'FILTER_SEARCH_CATEGORY', 'category' );

	define( 'FILTER_SEARCH_SEVERITY_ID', 'severity_id');

	define( 'FILTER_SEARCH_STATUS_ID', 'status_id' );

	define( 'FILTER_SEARCH_REPORTER_ID', 'reporter_id' );

	define( 'FILTER_SEARCH_HANDLER_ID', 'handler_id' );

	define( 'FILTER_SEARCH_PROJECT_ID', 'project_id' );

	define( 'FILTER_SEARCH_RESOLUTION_ID', 'resolution_id' );

	define( 'FILTER_SEARCH_FIXED_IN_VERSION', 'fixed_in_version' );

	define( 'FILTER_SEARCH_TARGET_VERSION', 'target_version' );

	define( 'FILTER_SEARCH_START_DAY', 'start_day' );

	define( 'FILTER_SEARCH_START_MONTH', 'start_month' );

	define( 'FILTER_SEARCH_START_YEAR', 'start_year' );

	define( 'FILTER_SEARCH_END_DAY', 'end_day' );

	define( 'FILTER_SEARCH_END_MONTH', 'end_month' );

	define( 'FILTER_SEARCH_END_YEAR', 'end_year' );

	define( 'FILTER_SEARCH_PRIORITY_ID', 'priority_id' );

	define( 'FILTER_SEARCH_PROFILE', 'profile_id' );

	define( 'FILTER_SEARCH_PLATFORM', 'platform' );

	define( 'FILTER_SEARCH_OS', 'os' );

	define( 'FILTER_SEARCH_OS_BUILD', 'os_build' );

	define( 'FILTER_SEARCH_MONITOR_USER_ID', 'monitor_user_id' );

	define( 'FILTER_SEARCH_PRODUCT_BUILD', 'product_build' );

	define( 'FILTER_SEARCH_PRODUCT_VERSION', 'product_version' );

	define( 'FILTER_SEARCH_VIEW_STATE_ID', 'view_state_id' );

	define( 'FILTER_SEARCH_SHOW_STICKY_ISSUES', 'sticky_issues' );

	define( 'FILTER_SEARCH_SORT_FIELD_NAME', 'sortby' );

	define( 'FILTER_SEARCH_SORT_DIRECTION', 'dir' );

	define( 'FILTER_SEARCH_ISSUES_PER_PAGE', 'per_page' );

	define( 'FILTER_SEARCH_HIGHLIGHT_CHANGED', 'highlight_changed' );

	define( 'FILTER_SEARCH_HIDE_STATUS_ID', 'hide_status_id' );

	define( 'FILTER_SEARCH_NOT_ASSIGNED', 'not_assigned' );

	define( 'FILTER_SEARCH_FILTER_BY_DATE', 'filter_by_date' );

	define( 'FILTER_SEARCH_RELATIONSHIP_TYPE', 'relationship_type' );

	define( 'FILTER_SEARCH_RELATIONSHIP_BUG', 'relationship_bug' );

	define( 'FILTER_SEARCH_TAG_STRING', 'tag_string' );

	define( 'FILTER_SEARCH_TAG_SELECT', 'tag_select' );

	# Checks the supplied value to see if it is an ANY value.

	# $p_field_value - The value to check.

	# Returns true for "ANY" values and false for others.  "ANY" means filter criteria not active.

	function filter_str_field_is_any( $p_field_value ) {

		if ( is_array( $p_field_value ) ) {

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

				return true;

			}

			foreach( $p_field_value as $t_value ) {

				if ( ( META_FILTER_ANY == $t_value ) && ( is_numeric( $t_value ) ) ) {

					return true;

				}

			}

		} else {

			if ( is_string( $p_field_value ) && is_blank( $p_field_value ) ) {

				return true;

			}

			if ( is_bool( $p_field_value ) && !$p_field_value ) {

				return true;

			}

			if ( ( META_FILTER_ANY == $p_field_value ) && ( is_numeric( $p_field_value ) ) ) {

				return true;

			}

		}

		return false;

	}

	# Encodes a field and it's value for the filter URL.  This handles the URL encoding

	# and arrays.

	# $p_field_name - The field name.

	# $p_field_value - The field value (can be an array)

	function filter_encode_field_and_value( $p_field_name, $p_field_value ) {

		$t_query_array = array();		

		if ( is_array( $p_field_value ) ) {

			$t_count = count( $p_field_value );

			if ( $t_count > 1 ) {

				foreach ( $p_field_value as $t_value ) {

					$t_query_array[] = urlencode( $p_field_name . '[]' ) . '=' . urlencode( $t_value );

				}

			} else if ( $t_count == 1 ) {

				$t_query_array[] = urlencode( $p_field_name ) . '=' . urlencode( $p_field_value[0] );

			}

		} else {

			$t_query_array[] = urlencode( $p_field_name ) . '=' . urlencode( $p_field_value );

		}

		return implode( $t_query_array, '&' );

	}

	# Get a permalink for the current active filter.  The results of using these fields by other users

	# can be inconsistent with the original results due to fields like "Myself", "Current Project",

	# and due to access level.

	# Returns the search.php?xxxx or an empty string if no criteria applied. 

	function filter_get_url( $p_custom_filter ) {

		$t_query = array();

		if ( !filter_str_field_is_any( $p_custom_filter[FILTER_PROPERTY_PROJECT_ID] ) ) {

			$t_project_id = $p_custom_filter[FILTER_PROPERTY_PROJECT_ID];

			if ( count( $t_project_id ) == 1 && $t_project_id[0] == META_FILTER_CURRENT ) {

				$t_project_id = array( helper_get_current_project() );

			}

			$t_query[] = filter_encode_field_and_value( FILTER_SEARCH_PROJECT_ID, $t_project_id );

		}

		if ( !filter_str_field_is_any( $p_custom_filter[FILTER_PROPERTY_FREE_TEXT] ) ) {

			$t_query[] = filter_encode_field_and_value( FILTER_SEARCH_FREE_TEXT, $p_custom_filter[FILTER_PROPERTY_FREE_TEXT] );

		}

		if ( !filter_str_field_is_any( $p_custom_filter[FILTER_PROPERTY_CATEGORY] ) ) {

			$t_query[] = filter_encode_field_and_value( FILTER_SEARCH_CATEGORY, $p_custom_filter[FILTER_PROPERTY_CATEGORY] );

		}

		if ( !filter_str_field_is_any( $p_custom_filter[FILTER_PROPERTY_REPORTER_ID] ) ) {

			$t_query[] = filter_encode_field_and_value( FILTER_SEARCH_REPORTER_ID, $p_custom_filter[FILTER_PROPERTY_REPORTER_ID] );

		}

		if ( !filter_str_field_is_any( $p_custom_filter[FILTER_PROPERTY_STATUS_ID] ) ) {

			$t_query[] = filter_encode_field_and_value( FILTER_SEARCH_STATUS_ID, $p_custom_filter[FILTER_PROPERTY_STATUS_ID] );

		}

		if ( !filter_str_field_is_any( $p_custom_filter[FILTER_PROPERTY_MONITOR_USER_ID] ) ) {

			$t_query[] = filter_encode_field_and_value( FILTER_SEARCH_MONITOR_USER_ID, $p_custom_filter[FILTER_PROPERTY_MONITOR_USER_ID] );

		}

		if ( !filter_str_field_is_any( $p_custom_filter[FILTER_PROPERTY_HANDLER_ID] ) ) {

			$t_query[] = filter_encode_field_and_value( FILTER_SEARCH_HANDLER_ID, $p_custom_filter[FILTER_PROPERTY_HANDLER_ID] );

		}

		if ( !filter_str_field_is_any( $p_custom_filter[FILTER_PROPERTY_SEVERITY_ID] ) ) {

			$t_query[] = filter_encode_field_and_value( FILTER_SEARCH_SEVERITY_ID, $p_custom_filter[FILTER_PROPERTY_SEVERITY_ID] );

		}

		if ( !filter_str_field_is_any( $p_custom_filter[FILTER_PROPERTY_RESOLUTION_ID] ) ) {

			$t_query[] = filter_encode_field_and_value( FILTER_SEARCH_RESOLUTION_ID, $p_custom_filter[FILTER_PROPERTY_RESOLUTION_ID] );

		}

		if ( !filter_str_field_is_any( $p_custom_filter[FILTER_PROPERTY_PRIORITY_ID] ) ) {

			$t_query[] = filter_encode_field_and_value( FILTER_SEARCH_PRIORITY_ID, $p_custom_filter[FILTER_PROPERTY_PRIORITY_ID] );

		}

		if ( !filter_str_field_is_any( $p_custom_filter[FILTER_PROPERTY_VIEW_STATE_ID] ) ) {

			$t_query[] = filter_encode_field_and_value( FILTER_SEARCH_VIEW_STATE_ID, $p_custom_filter[FILTER_PROPERTY_VIEW_STATE_ID] );

		}

		if ( !filter_str_field_is_any( $p_custom_filter[FILTER_PROPERTY_SHOW_STICKY_ISSUES] ) ) {

			$t_query[] = filter_encode_field_and_value( FILTER_SEARCH_SHOW_STICKY_ISSUES, $p_custom_filter[FILTER_PROPERTY_SHOW_STICKY_ISSUES] );

		}

		if ( !filter_str_field_is_any( $p_custom_filter[FILTER_PROPERTY_PRODUCT_VERSION] ) ) {

			$t_query[] = filter_encode_field_and_value( FILTER_SEARCH_PRODUCT_VERSION, $p_custom_filter[FILTER_PROPERTY_PRODUCT_VERSION] );

		}

		if ( !filter_str_field_is_any( $p_custom_filter[FILTER_PROPERTY_PRODUCT_BUILD] ) ) {

			$t_query[] = filter_encode_field_and_value( FILTER_SEARCH_PRODUCT_BUILD, $p_custom_filter[FILTER_PROPERTY_PRODUCT_BUILD] );

		}

		if ( !filter_str_field_is_any( $p_custom_filter[FILTER_PROPERTY_FIXED_IN_VERSION] ) ) {

			$t_query[] = filter_encode_field_and_value( FILTER_SEARCH_FIXED_IN_VERSION, $p_custom_filter[FILTER_PROPERTY_FIXED_IN_VERSION] );

		}

		if ( !filter_str_field_is_any( $p_custom_filter[FILTER_PROPERTY_TARGET_VERSION] ) ) {

			$t_query[] = filter_encode_field_and_value( FILTER_SEARCH_TARGET_VERSION, $p_custom_filter[FILTER_PROPERTY_TARGET_VERSION] );

		}

		if ( !filter_str_field_is_any( $p_custom_filter[FILTER_PROPERTY_SORT_FIELD_NAME] ) ) {

			$t_query[] = filter_encode_field_and_value( FILTER_SEARCH_SORT_FIELD_NAME, $p_custom_filter[FILTER_PROPERTY_SORT_FIELD_NAME] );

		}

		if ( !filter_str_field_is_any( $p_custom_filter[FILTER_PROPERTY_SORT_DIRECTION] ) ) {

			$t_query[] = filter_encode_field_and_value( FILTER_SEARCH_SORT_DIRECTION, $p_custom_filter[FILTER_PROPERTY_SORT_DIRECTION] );

		}

		if ( !filter_str_field_is_any( $p_custom_filter[FILTER_SEARCH_ISSUES_PER_PAGE] ) ) {

			if ( $p_custom_filter[FILTER_SEARCH_ISSUES_PER_PAGE] != config_get( 'default_limit_view' ) ) {

				$t_query[] = filter_encode_field_and_value( FILTER_PROPERTY_ISSUES_PER_PAGE, $p_custom_filter[FILTER_SEARCH_ISSUES_PER_PAGE] );

			}

		}

		if ( !filter_str_field_is_any( $p_custom_filter[FILTER_PROPERTY_HIGHLIGHT_CHANGED] ) ) {

			if ( $p_custom_filter[FILTER_PROPERTY_HIGHLIGHT_CHANGED] != config_get( 'default_show_changed' ) ) {

				$t_query[] = filter_encode_field_and_value( FILTER_SEARCH_HIGHLIGHT_CHANGED, $p_custom_filter[FILTER_PROPERTY_HIGHLIGHT_CHANGED] );

			}

		}

		if ( !filter_str_field_is_any( $p_custom_filter[FILTER_PROPERTY_HIDE_STATUS_ID] ) ) {

			$t_query[] = filter_encode_field_and_value( FILTER_SEARCH_HIDE_STATUS_ID, $p_custom_filter[FILTER_PROPERTY_HIDE_STATUS_ID] );

		}

		if ( !filter_str_field_is_any( $p_custom_filter[FILTER_PROPERTY_NOT_ASSIGNED] ) ) {

			$t_query[] = filter_encode_field_and_value( FILTER_SEARCH_NOT_ASSIGNED, $p_custom_filter[FILTER_PROPERTY_NOT_ASSIGNED] );

		}

		if ( !filter_str_field_is_any( $p_custom_filter[FILTER_PROPERTY_FILTER_BY_DATE] ) ) {

			$t_query[] = filter_encode_field_and_value( FILTER_SEARCH_FILTER_BY_DATE, $p_custom_filter[FILTER_PROPERTY_FILTER_BY_DATE] );

			# The start and end dates are only applicable if filter by date is set.

			if ( !filter_str_field_is_any( $p_custom_filter[FILTER_PROPERTY_START_DAY] ) ) {

				$t_query[] = filter_encode_field_and_value( FILTER_SEARCH_START_DAY, $p_custom_filter[FILTER_PROPERTY_START_DAY] );

			}

			if ( !filter_str_field_is_any( $p_custom_filter[FILTER_PROPERTY_END_DAY] ) ) {

				$t_query[] = filter_encode_field_and_value( FILTER_SEARCH_END_DAY, $p_custom_filter[FILTER_PROPERTY_END_DAY] );

			}

			if ( !filter_str_field_is_any( $p_custom_filter[FILTER_PROPERTY_START_MONTH] ) ) {

				$t_query[] = filter_encode_field_and_value( FILTER_SEARCH_START_MONTH, $p_custom_filter[FILTER_PROPERTY_START_MONTH] );

			}

			if ( !filter_str_field_is_any( $p_custom_filter[FILTER_PROPERTY_END_MONTH] ) ) {

				$t_query[] = filter_encode_field_and_value( FILTER_SEARCH_END_MONTH, $p_custom_filter[FILTER_PROPERTY_END_MONTH] );

			}

			if ( !filter_str_field_is_any( $p_custom_filter[FILTER_PROPERTY_START_YEAR] ) ) {

				$t_query[] = filter_encode_field_and_value( FILTER_SEARCH_START_YEAR, $p_custom_filter[FILTER_PROPERTY_START_YEAR] );

			}

			if ( !filter_str_field_is_any( $p_custom_filter[FILTER_PROPERTY_END_YEAR] ) ) {

				$t_query[] = filter_encode_field_and_value( FILTER_SEARCH_END_YEAR, $p_custom_filter[FILTER_PROPERTY_END_YEAR] );

			}	

		}

		if ( !filter_str_field_is_any( $p_custom_filter[FILTER_PROPERTY_RELATIONSHIP_TYPE] ) ) {

			if ( $p_custom_filter[FILTER_PROPERTY_RELATIONSHIP_TYPE] != -1 ) {

				$t_query[] = filter_encode_field_and_value( FILTER_SEARCH_RELATIONSHIP_TYPE, $p_custom_filter[FILTER_PROPERTY_RELATIONSHIP_TYPE] );

			}

		}

		if ( !filter_str_field_is_any( $p_custom_filter[FILTER_PROPERTY_RELATIONSHIP_BUG] ) ) {

			$t_query[] = filter_encode_field_and_value( FILTER_SEARCH_RELATIONSHIP_BUG, $p_custom_filter[FILTER_PROPERTY_RELATIONSHIP_BUG] );

		}

		if ( !filter_str_field_is_any( $p_custom_filter[FILTER_PROPERTY_PLATFORM] ) ) {

			$t_query[] = filter_encode_field_and_value( FILTER_SEARCH_PLATFORM, $p_custom_filter[FILTER_PROPERTY_PLATFORM] );

		}

		if ( !filter_str_field_is_any( $p_custom_filter[FILTER_PROPERTY_OS] ) ) {

			$t_query[] = filter_encode_field_and_value( FILTER_SEARCH_OS, $p_custom_filter[FILTER_PROPERTY_OS] );

		}

		if ( !filter_str_field_is_any( $p_custom_filter[FILTER_PROPERTY_OS_BUILD] ) ) {

			$t_query[] = filter_encode_field_and_value( FILTER_SEARCH_OS_BUILD, $p_custom_filter[FILTER_PROPERTY_OS_BUILD] );

		}

		if ( !filter_str_field_is_any( $p_custom_filter[FILTER_PROPERTY_TAG_STRING] ) ) {

			$t_query[] = filter_encode_field_and_value( FILTER_SEARCH_TAG_STRING, $p_custom_filter[FILTER_PROPERTY_TAG_STRING] );

		}

		if ( !filter_str_field_is_any( $p_custom_filter[FILTER_PROPERTY_TAG_SELECT] ) ) {

			$t_query[] = filter_encode_field_and_value( FILTER_SEARCH_TAG_SELECT, $p_custom_filter[FILTER_PROPERTY_TAG_SELECT] );

		}

		if ( isset( $p_custom_filter['custom_fields'] ) ) {

			foreach( $p_custom_filter['custom_fields'] as $t_custom_field_id => $t_custom_field_values ) {

				if ( !filter_str_field_is_any( $t_custom_field_values ) ) {

					$t_query[] = filter_encode_field_and_value( 'custom_field_' . $t_custom_field_id, $t_custom_field_values );

				}

			}

		}

		if ( count( $t_query ) > 0 ) {

			$t_query_str = implode( $t_query, '&' );

			$t_url = config_get( 'path' ) . 'search.php?' . $t_query_str;

		} else {

			$t_url = '';

		}

		return $t_url;

	}

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

	# Filter API

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

	# Get the standard filter that is to be used when no filter was previously saved.

	# When creating specific filters, this can be used as a basis for the filter, where

	# specific entries can be overridden.

	function filter_get_default() {

		$t_hide_status_default  = config_get( 'hide_status_default' );

		$t_default_show_changed = config_get( 'default_show_changed' );

		$t_filter = array(

			'show_category'		=> Array ( '0' => META_FILTER_ANY ),

			'show_severity'		=> Array ( '0' => META_FILTER_ANY ),

			'show_status'		=> Array ( '0' => META_FILTER_ANY ),

			'highlight_changed'	=> $t_default_show_changed,

			'reporter_id'		=> Array ( '0' => META_FILTER_ANY ),

			'handler_id'		=> Array ( '0' => META_FILTER_ANY ),

			'project_id'		=> Array ( '0' => META_FILTER_CURRENT ),

			'show_resolution'	=> Array ( '0' => META_FILTER_ANY ),

			'show_build'		=> Array ( '0' => META_FILTER_ANY ),

			'show_version'		=> Array ( '0' => META_FILTER_ANY ),

			'hide_status'		=> Array ( '0' => $t_hide_status_default ),

			'user_monitor'		=> Array ( '0' => META_FILTER_ANY ),

			'sort'              => 'last_updated',

			'dir'               => 'DESC'

		);

		return filter_ensure_valid_filter( $t_filter );

	}

	# @@@ Had to make all these parameters required because we can't use

	#  call-time pass by reference anymore.  I really preferred not having

	#  to pass all the params in if you didn't want to, but I wanted to get

	#  rid of the errors for now.  If we can think of a better way later

	#  (maybe return an object) that would be great.

	#

	# $p_page_numer

	#   - the page you want to see (set to the actual page on return)

	# $p_per_page

	#   - the number of bugs to see per page (set to actual on return)

	#     -1   indicates you want to see all bugs

	#     null indicates you want to use the value specified in the filter

	# $p_page_count

	#   - you don't need to give a value here, the number of pages will be

	#     stored here on return

	# $p_bug_count

	#   - you don't need to give a value here, the number of bugs will be

	#     stored here on return

	# $p_custom_filter

	#   - Filter to use.

	# $p_project_id

	#   - project id to use in filtering.

	# $p_user_id

	#   - user id to use as current user when filtering.

	# $p_show_sticky

	#	- get sticky issues only.

	function filter_get_bug_rows( &$p_page_number, &$p_per_page, &$p_page_count, &$p_bug_count, $p_custom_filter = null, $p_project_id = null, $p_user_id = null, $p_show_sticky = null ) {

		log_event( LOG_FILTERING, 'FILTERING: START NEW FILTER QUERY' );

		$t_bug_table			= config_get( 'mantis_bug_table' );

		$t_bug_text_table		= config_get( 'mantis_bug_text_table' );

		$t_bugnote_table		= config_get( 'mantis_bugnote_table' );

		$t_custom_field_string_table	= config_get( 'mantis_custom_field_string_table' );

		$t_bugnote_text_table	= config_get( 'mantis_bugnote_text_table' );

		$t_project_table		= config_get( 'mantis_project_table' );

		$t_bug_monitor_table	= config_get( 'mantis_bug_monitor_table' );

		$t_limit_reporters		= config_get( 'limit_reporters' );

		$t_bug_relationship_table	= config_get( 'mantis_bug_relationship_table' );

		$t_report_bug_threshold		= config_get( 'report_bug_threshold' );

		$t_current_user_id = auth_get_current_user_id();

		if ( null === $p_user_id ) {

			$t_user_id = $t_current_user_id;

		} else {

			$t_user_id = $p_user_id;

		}

		$c_user_id = db_prepare_int( $t_user_id );

		if ( null === $p_project_id ) {

			# @@@ If project_id is not specified, then use the project id(s) in the filter if set, otherwise, use current project.

			$t_project_id	= helper_get_current_project();

		} else {

			$t_project_id	= $p_project_id;

		}

		if ( $p_custom_filter === null ) {

			# Prefer current_user_get_bug_filter() over user_get_filter() when applicable since it supports

			# cookies set by previous version of the code.

			if ( $t_user_id == $t_current_user_id ) {

				$t_filter = current_user_get_bug_filter();

			} else {

				$t_filter = user_get_bug_filter( $t_user_id, $t_project_id );

			}

		} else {

			$t_filter = $p_custom_filter;

		}

		$t_filter = filter_ensure_valid_filter( $t_filter );

		if ( false === $t_filter ) {

			return false; # signify a need to create a cookie

			#@@@ error instead?

		}

		$t_view_type = $t_filter['_view_type'];

		$t_where_clauses = array( "$t_project_table.enabled = 1", "$t_project_table.id = $t_bug_table.project_id" );

		$t_select_clauses = array( "$t_bug_table.*" );

		$t_join_clauses = array();

		$t_from_clauses = array();

		// normalize the project filtering into an array $t_project_ids

		if ( 'simple' == $t_view_type ) {

			log_event( LOG_FILTERING, 'FILTERING: Simple Filter' );

			$t_project_ids = array( $t_project_id );

			$t_include_sub_projects = true;

		} else {

			log_event( LOG_FILTERING, 'FILTERING: Advanced Filter' );

			if ( !is_array( $t_filter['project_id'] ) ) {

				$t_project_ids = array( db_prepare_int( $t_filter['project_id'] ) );

			} else {

				$t_project_ids = array_map( 'db_prepare_int', $t_filter['project_id'] );

			}

			$t_include_sub_projects = ( ( count( $t_project_ids ) == 1 ) && ( $t_project_ids[0] == META_FILTER_CURRENT ) );

		}

		log_event( LOG_FILTERING, 'FILTERING: project_ids = ' . implode( ',', $t_project_ids ) );

		log_event( LOG_FILTERING, 'FILTERING: include sub-projects = ' . ( $t_include_sub_projects ? '1' : '0' ) );

		// if the array has ALL_PROJECTS, then reset the array to only contain ALL_PROJECTS.

		// replace META_FILTER_CURRENT with the actualy current project id.

		$t_all_projects_found = false;

		$t_new_project_ids = array();

		foreach ( $t_project_ids as $t_pid ) {

			if ( $t_pid == META_FILTER_CURRENT ) { 

				$t_pid = $t_project_id;

			}

			if ( $t_pid == ALL_PROJECTS ) {

				$t_all_projects_found = true;

				log_event( LOG_FILTERING, 'FILTERING: all projects selected' );

				break;

			}

			// filter out inaccessible projects.

			if ( !access_has_project_level( VIEWER, $t_pid, $t_user_id ) ) {

				continue;

			}

			$t_new_project_ids[] = $t_pid;

		}

		$t_projects_query_required = true;

		if ( $t_all_projects_found ) {

			if ( user_is_administrator( $t_user_id ) ) {

				log_event( LOG_FILTERING, 'FILTERING: all projects + administrator, hence no project filter.' );

				$t_projects_query_required = false;

			} else {

				$t_project_ids = user_get_accessible_projects( $t_user_id );

			}

		} else {

			$t_project_ids = $t_new_project_ids;

		}

		if ( $t_projects_query_required ) {

			// expand project ids to include sub-projects

			if ( $t_include_sub_projects ) {

				$t_top_project_ids = $t_project_ids;

				foreach ( $t_top_project_ids as $t_pid ) {

					log_event( LOG_FILTERING, 'FILTERING: Getting sub-projects for project id ' . $t_pid );

					$t_project_ids = array_merge( $t_project_ids, user_get_all_accessible_subprojects( $t_user_id, $t_pid ) );

				}

				$t_project_ids = array_unique( $t_project_ids );

			}

			// if no projects are accessible, then return an empty array.

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

				log_event( LOG_FILTERING, 'FILTERING: no accessible projects' );

				return array();

			}

			log_event( LOG_FILTERING, 'FILTERING: project_ids after including sub-projects = ' . implode( ',', $t_project_ids ) );

			// this array is to be populated with project ids for which we only want to show public issues.  This is due to the limited

			// access of the current user.

			$t_public_only_project_ids = array();

			// this array is populated with project ids that the current user has full access to.

			$t_private_and_public_project_ids = array();

			$t_access_required_to_view_private_bugs = config_get( 'private_bug_threshold' );

			foreach ( $t_project_ids as $t_pid ) {

				if ( access_has_project_level( $t_access_required_to_view_private_bugs, $t_pid, $t_user_id ) ) {

					$t_private_and_public_project_ids[] = $t_pid;

				} else {

					$t_public_only_project_ids[] = $t_pid;

				}

			}

			log_event( LOG_FILTERING, 'FILTERING: project_ids (with public/private access) = ' . implode( ',', $t_private_and_public_project_ids ) );

			log_event( LOG_FILTERING, 'FILTERING: project_ids (with public access) = ' . implode( ',', $t_public_only_project_ids ) );

			$t_count_private_and_public_project_ids = count( $t_private_and_public_project_ids );

			if ( $t_count_private_and_public_project_ids == 1 ) {

				$t_private_and_public_query = "( $t_bug_table.project_id = " . $t_private_and_public_project_ids[0] . " )";

			} else if ( $t_count_private_and_public_project_ids > 1 ) {

				$t_private_and_public_query = "( $t_bug_table.project_id in (". implode( ', ', $t_private_and_public_project_ids ) . ") )";

			} else {

				$t_private_and_public_query = null;

			}

			$t_count_public_only_project_ids = count( $t_public_only_project_ids );

			$t_public_view_state_check = "( ( $t_bug_table.view_state = " . VS_PUBLIC . " ) OR ( $t_bug_table.reporter_id = $t_user_id ) )";

			if ( $t_count_public_only_project_ids == 1 ) {

				$t_public_only_query = "( ( $t_bug_table.project_id = " . $t_public_only_project_ids[0] . " ) AND $t_public_view_state_check )";

			} else if ( $t_count_public_only_project_ids > 1 ) {

				$t_public_only_query = "( ( $t_bug_table.project_id in (". implode( ', ', $t_public_only_project_ids ) . ") ) AND $t_public_view_state_check )";

			} else {

				$t_public_only_query = null;

			}

			// both queries can't be null, so we either have one of them or both.

			if ( $t_private_and_public_query === null ) {

				$t_project_query = $t_public_only_query;

			} else if ( $t_public_only_query === null ) {

				$t_project_query = $t_private_and_public_query;

			} else {

				$t_project_query = "( $t_public_only_query OR $t_private_and_public_query )";

			}

			log_event( LOG_FILTERING, 'FILTERING: project query = ' . $t_project_query );

			array_push( $t_where_clauses, $t_project_query );

		}

		# view state

		$t_view_state = db_prepare_int( $t_filter['view_state'] );

		if ( ( $t_filter['view_state'] !== META_FILTER_ANY ) && ( !is_blank( $t_filter['view_state'] ) ) ) {

			$t_view_state_query = "($t_bug_table.view_state='$t_view_state')";

			log_event( LOG_FILTERING, 'FILTERING: view_state query = ' . $t_view_state_query );

			array_push( $t_where_clauses, $t_view_state_query );

		} else {

			log_event( LOG_FILTERING, 'FILTERING: no view_state query' );

		}

		# reporter

		$t_any_found = false;

		foreach( $t_filter['reporter_id'] as $t_filter_member ) {

			if ( ( META_FILTER_ANY === $t_filter_member ) || ( 0 === $t_filter_member ) ) {

				$t_any_found = true;

			}

		}

		if ( count( $t_filter['reporter_id'] ) == 0 ) {

			$t_any_found = true;

		}

		if ( !$t_any_found ) {

			$t_clauses = array();

			foreach( $t_filter['reporter_id'] as $t_filter_member ) {

				if ( META_FILTER_NONE == $t_filter_member ) {

					array_push( $t_clauses, "0" );

				} else {

					$c_reporter_id = db_prepare_int( $t_filter_member );

					if ( META_FILTER_MYSELF == $c_reporter_id ) {

						array_push( $t_clauses, $c_user_id );

					} else {

						array_push( $t_clauses, $c_reporter_id );

					}

				}

			}

			if ( 1 < count( $t_clauses ) ) {

				$t_reporter_query = "( $t_bug_table.reporter_id in (". implode( ', ', $t_clauses ) .") )";

			} else {

				$t_reporter_query = "( $t_bug_table.reporter_id=$t_clauses[0] )";

			}

			log_event( LOG_FILTERING, 'FILTERING: reporter query = ' . $t_reporter_query );

			array_push( $t_where_clauses, $t_reporter_query );

		} else {

			log_event( LOG_FILTERING, 'FILTERING: no reporter query' );

		}

		# limit reporter

		# @@@ thraxisp - access_has_project_level checks greater than or equal to,

		#   this assumed that there aren't any holes above REPORTER where the limit would apply

		#

		if ( ( ON === $t_limit_reporters ) && ( ! access_has_project_level( REPORTER + 1, $t_project_id, $t_user_id ) ) ) {

			$c_reporter_id = $c_user_id;

			array_push( $t_where_clauses, "($t_bug_table.reporter_id='$c_reporter_id')" );

		}

		# handler

		$t_any_found = false;

		foreach( $t_filter['handler_id'] as $t_filter_member ) {

			if ( ( META_FILTER_ANY === $t_filter_member ) || ( 0 === $t_filter_member ) ) {

				$t_any_found = true;

			}

		}

		if ( count( $t_filter['handler_id'] ) == 0 ) {

			$t_any_found = true;

		}

		if ( !$t_any_found ) {

			$t_clauses = array();

			foreach( $t_filter['handler_id'] as $t_filter_member ) {

				if ( META_FILTER_NONE == $t_filter_member ) {

					array_push( $t_clauses, 0 );

				} else {

					$c_handler_id = db_prepare_int( $t_filter_member );

					if ( META_FILTER_MYSELF == $c_handler_id ) {

						array_push( $t_clauses, $c_user_id );

					} else {

						array_push( $t_clauses, $c_handler_id );

					}

				}

			}

			if ( 1 < count( $t_clauses ) ) {

				$t_handler_query = "( $t_bug_table.handler_id in (". implode( ', ', $t_clauses ) .") )";

			} else {

				$t_handler_query = "( $t_bug_table.handler_id=$t_clauses[0] )";

			}

			log_event( LOG_FILTERING, 'FILTERING: handler query = ' . $t_handler_query );

			array_push( $t_where_clauses, $t_handler_query );

		} else {

			log_event( LOG_FILTERING, 'FILTERING: no handler query' );

		}

		# category

		if ( !_filter_is_any( $t_filter['show_category'] ) ) {

			$t_clauses = array();

			foreach( $t_filter['show_category'] as $t_filter_member ) {

				$t_filter_member = stripslashes( $t_filter_member );

				if ( META_FILTER_NONE == $t_filter_member ) {

					array_push( $t_clauses, "''" );

				} else {

					$c_show_category = db_prepare_string( $t_filter_member );

					array_push( $t_clauses, "'$c_show_category'" );

				}

			}

			if ( 1 < count( $t_clauses ) ) {

				array_push( $t_where_clauses, "( $t_bug_table.category in (". implode( ', ', $t_clauses ) .") )" );

			} else {

				array_push( $t_where_clauses, "( $t_bug_table.category=$t_clauses[0] )" );

			}

		}

		# severity

		$t_any_found = false;

		foreach( $t_filter['show_severity'] as $t_filter_member ) {

			if ( ( META_FILTER_ANY == $t_filter_member ) || ( 0 === $t_filter_member ) ) {