csv_api.php

<?php
# Mantis - a php based bugtracking system

# 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/>.

/**
 * CSV API
 * Names for formatting functions are csv_format_*, where * corresponds to the
 * field name as return get csv_get_columns() and by the filter api.
 *
 * @package CoreAPI
 * @subpackage CSVAPI
 * @copyright Copyright (C) 2000 - 2002  Kenzaburo Ito - kenito@300baud.org
 * @copyright Copyright (C) 2002 - 2008  Mantis Team   - mantisbt-dev@lists.sourceforge.net
 * @link http://www.mantisbt.org
 */

/**
 * get the csv file new line, can be moved to config in the future
 * @return string containing new line character
 * @access public
 */
function csv_get_newline() {
	return "\r\n";
}

/**
 * get the csv file separator, can be moved to config in the future
 * @return string
 * @access public
 */
function csv_get_separator() {
	return config_get( 'csv_separator' );
}

/**
 * if all projects selected, default to <username>.csv, otherwise default to
 * <projectname>.csv.
 * @return string filename
 * @access public
 */
function csv_get_default_filename() {
	$t_current_project_id = helper_get_current_project();

	if( ALL_PROJECTS == $t_current_project_id ) {
		$t_filename = user_get_name( auth_get_current_user_id() );
	} else {
		$t_filename = project_get_field( $t_current_project_id, 'name' );
	}

	return $t_filename . '.csv';
}

/**
 * escape a string before writing it to csv file. 
 * @param type $todo TODO
 * @return  TODO
 * @access public
 */
function csv_escape_string( $p_str ) {

	# enclose strings with separators with quotaiton marks
	if( strpos( $p_str, csv_get_separator() ) !== false ) {
		$p_str = '"' . str_replace( '"', '""', $p_str ) . '"';
	}

	# enclose multi-line strings with quotaiton marks
	if( strpos( $p_str, "\n" ) !== false ) {
		$p_str = '"' . str_replace( '"', '""', $p_str ) . '"';
	}

	return $p_str;
}

/**
 * An array of column names that are used to identify  fields to include and in which order.
 * @param type $todo TODO
 * @return  TODO
 * @access public
 */
function csv_get_columns() {
	$t_columns = helper_get_columns_to_view( COLUMNS_TARGET_CSV_PAGE );
	return $t_columns;
}

/**
 * format bug id
 * @param int $p_bug_id bug id
 * @return string csv formatted bug
 * @access public
 */
function csv_format_id( $p_bug_id ) {
	return bug_format_id( $p_bug_id );
}

/**
 * returns the project name corresponding to the supplied project id.
 * @param int $p_project_id project id
 * @return string csv formatted project name
 * @access public
 */
function csv_format_project_id( $p_project_id ) {
	return csv_escape_string( project_get_name( $p_project_id ) );
}

/**
 * returns the reporter name corresponding to the supplied id.
 * @param int $p_reporter_id user id
 * @return string formatted user name
 * @access public
 */
function csv_format_reporter_id( $p_reporter_id ) {
	return csv_escape_string( user_get_name( $p_reporter_id ) );
}

/**
 * returns the handler name corresponding to the supplied id
 * @param int $p_handler_id user id
 * @return string formatted user name
 * @access public
 */
function csv_format_handler_id( $p_handler_id ) {
	if( $p_handler_id > 0 ) {
		return csv_escape_string( user_get_name( $p_handler_id ) );
	}
}

/**
 * return the priority string
 * @param int $p_priority
 * @return string formatted priority string
 * @access public
 */
function csv_format_priority( $p_priority ) {
	return csv_escape_string( get_enum_element( 'priority', $p_priority ) );
}

/**
 * return the severity string
 * @param int $p_severity
 * @return string formatted severity string
 * @access public
 */
function csv_format_severity( $p_severity ) {
	return csv_escape_string( get_enum_element( 'severity', $p_severity ) );
}

/**
 * return the reproducability string
 * @param int $p_reproducibility
 * @return string formatted reproducibility string
 * @access public
 */
function csv_format_reproducibility( $p_reproducibility ) {
	return csv_escape_string( get_enum_element( 'reproducibility', $p_reproducibility ) );
}

/**
 * return the version
 * @param string $p_version version string
 * @return string formatted version string
 * @access public
 */
function csv_format_version( $p_version ) {
	return csv_escape_string( $p_version );
}

/**
 * return the fixed_in_version
 * @param string $p_fixed_in_version fixed in version string
 * @return string formatted fixed in version string
 * @access public
 */
function csv_format_fixed_in_version( $p_fixed_in_version ) {
	return csv_escape_string( $p_fixed_in_version );
}

/**
 * return the target_version
 * @param string $p_target_version target version string
 * @return string formatted target version string
 * @access public
 */
function csv_format_target_version( $p_target_version ) {
	return csv_escape_string( $p_target_version );
}

/**
 * return the projection
 * @param int $p_projection
 * @return string formatted projection string
 * @access public
 */
function csv_format_projection( $p_projection ) {
	return csv_escape_string( get_enum_element( 'projection', $p_projection ) );
}

/**
 * return the category
 * @param int $p_category_id
 * @return string formatted category string
 * @access public
 */
function csv_format_category_id( $p_category_id ) {
	return csv_escape_string( category_full_name( $p_category_id, false ) );
}

/**
 * return the date submitted
 * @param string $p_date_submitted
 * @return string formatted date
 * @access public
 */
function csv_format_date_submitted( $p_date_submitted ) {
	return date( config_get( 'short_date_format' ), $p_date_submitted );
}

/**
 * return the eta
 * @param int $p_eta eta
 * @return string formatted eta
 * @access public
 */
function csv_format_eta( $p_eta ) {
	return csv_escape_string( get_enum_element( 'eta', $p_eta ) );
}

/**
 * return the operating system
 * @param string $p_os operating system
 * @return string formatted operating system
 * @access public
 */
function csv_format_os( $p_os ) {
	return csv_escape_string( $p_os );
}

/**
 * return the os build (os version)
 * @param string $p_os_build operating system build
 * @return string formatted operating system build
 * @access public
 */
function csv_format_os_build( $p_os_build ) {
	return csv_escape_string( $p_os_build );
}

/**
 * return the build
 * @param string $p_build
 * @return string formatted build
 * @access public
 */
function csv_format_build( $p_build ) {
	return csv_escape_string( $p_build );
}

/**
 * return the platform
 * @param string $p_platform platform
 * @return string formatted platform
 * @access public
 */
function csv_format_platform( $p_platform ) {
	return csv_escape_string( $p_platform );
}

/**
 * return the view state (eg: private / public)
 * @param int $p_view_state view state
 * @return string formatted view state
 * @access public
 */
function csv_format_view_state( $p_view_state ) {
	return csv_escape_string( get_enum_element( 'view_state', $p_view_state ) );
}

/**
 * return the last updated date
 * @param string $p_last_updated last updated
 * @return string formated last updated string
 * @access public
 */
function csv_format_last_updated( $p_last_updated ) {
	return date( config_get( 'short_date_format' ), $p_last_updated );
}

/**
 * return the summary
 * @param string $p_summary summary
 * @return string formatted summary
 * @access public
 */
function csv_format_summary( $p_summary ) {
	return csv_escape_string( $p_summary );
}

/**
 * return the description 
 * @param string $p_description description
 * @return string formatted description
 * @access public
 */
function csv_format_description( $p_description ) {
	return csv_escape_string( $p_description );
}

/**
 * return the steps to reproduce
 * @param string $p_steps_to_reproduce steps to reproduce
 * @return string formatted steps to reproduce
 * @access public
 */
function csv_format_steps_to_reproduce( $p_steps_to_reproduce ) {
	return csv_escape_string( $p_steps_to_reproduce );
}

/**
 * return the additional information
 * @param string $p_additional_information
 * @return string formatted additional information
 * @access public
 */
function csv_format_additional_information( $p_additional_information ) {
	return csv_escape_string( $p_additional_information );
}

/**
 * return the status string
 * @param string $p_status status
 * @return string formatted status
 * @access public
 */
function csv_format_status( $p_status ) {
	return csv_escape_string( get_enum_element( 'status', $p_status ) );
}

/**
 * return the resolution string
 * @param int $p_resolution resolution
 * @return string formatted resolution string
 * @access public
 */
function csv_format_resolution( $p_resolution ) {
	return csv_escape_string( get_enum_element( 'resolution', $p_resolution ) );
}

/**
 * return the duplicate bug id
 * @param int $p_duplicate_id
 * @return string formatted bug id
 * @access public
 */
function csv_format_duplicate_id( $p_duplicate_id ) {
	return bug_format_id( $p_duplicate_id );
}

/**
 * return the selection
 * @param int $p_duplicate_id
 * @return string
 * @access public
 */
function csv_format_selection( $p_duplicate_id ) {
	return csv_escape_string( '' );
}