bugnote_api.php

<?php
# MantisBT - A PHP based bugtracking system

# MantisBT 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.
#
# MantisBT 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 MantisBT.  If not, see <http://www.gnu.org/licenses/>.

/**
 * Bugnote API
 *
 * @package CoreAPI
 * @subpackage BugnoteAPI
 * @copyright Copyright 2000 - 2002  Kenzaburo Ito - kenito@300baud.org
 * @copyright Copyright 2002  MantisBT Team - mantisbt-dev@lists.sourceforge.net
 * @link http://www.mantisbt.org
 *
 * @uses access_api.php
 * @uses authentication_api.php
 * @uses bug_api.php
 * @uses bug_revision_api.php
 * @uses config_api.php
 * @uses constant_inc.php
 * @uses database_api.php
 * @uses email_api.php
 * @uses event_api.php
 * @uses helper_api.php
 * @uses history_api.php

 * @uses user_api.php
 * @uses utility_api.php
 */

require_api( 'access_api.php' );
require_api( 'authentication_api.php' );
require_api( 'bug_api.php' );
require_api( 'bug_revision_api.php' );
require_api( 'config_api.php' );
require_api( 'constant_inc.php' );
require_api( 'database_api.php' );
require_api( 'email_api.php' );
require_api( 'event_api.php' );
require_api( 'helper_api.php' );
require_api( 'history_api.php' );
require_api( 'user_api.php' );
require_api( 'utility_api.php' );

/**
 * Bugnote Data Structure Definition
 * @package MantisBT
 * @subpackage classes
 */
class BugnoteData {
	/**
	 * Bugnote ID
	 */
	var $id;

	/**
	 * Bug ID
	 */
	var $bug_id;

	/**
	 * Reporter ID
	 */
	var $reporter_id;

	/**
	 * Note text
	 */
	var $note;

	/**
	 * View State
	 */
	var $view_state;

	/**
	 * Date submitted
	 */
	var $date_submitted;

	/**
	 * Last Modified
	 */
	var $last_modified;

	/**
	 * Bugnote type
	 */
	var $note_type;

	/**
	 * ???
	 */
	var $note_attr;
	
	/**
	 * Time tracking information
	 */
	var $time_tracking;
}

/**
 * Check if a bugnote with the given ID exists
 * return true if the bugnote exists, false otherwise
 * @param int $p_bugnote_id bugnote id
 * @return bool
 * @access public
 */
function bugnote_exists( $p_bugnote_id ) {
	$t_query = 'SELECT COUNT(*) FROM {bugnote} WHERE id=%d';
	$t_result = db_query( $t_query, array( (int)$p_bugnote_id ) );

	if( 0 == db_result( $t_result ) ) {
		return false;
	} else {
		return true;
	}
}

/**
 * Check if a bugnote with the given ID exists
 * return true if the bugnote exists, raise an error if not
 * @param int $p_bugnote_id bugnote id
 * @access public
 * @throws MantisBT\Exception\Issue\Note\NoteNotFound
 */
function bugnote_ensure_exists( $p_bugnote_id ) {
	if( !bugnote_exists( $p_bugnote_id ) ) {
		throw new MantisBT\Exception\Issue\Note\NoteNotFound();
	}
}

/**
 * Check if the given user is the reporter of the bugnote
 * return true if the user is the reporter, false otherwise
 * @param int $p_bugnote_id bugnote id
 * @param int $p_user_id user id
 * @return bool
 * @access public
 */
function bugnote_is_user_reporter( $p_bugnote_id, $p_user_id ) {
	if( bugnote_get_field( $p_bugnote_id, 'reporter_id' ) == $p_user_id ) {
		return true;
	} else {
		return false;
	}
}

/**
 * Add a bugnote to a bug
 * return the ID of the new bugnote
 * @param int $p_bug_id bug id
 * @param string $p_bugnote_text bugnote text
 * @param string $p_time_tracking hh:mm string
 * @param bool $p_private whether bugnote is private
 * @param int $p_type bugnote type
 * @param string $p_attr
 * @param int $p_user_id user id
 * @param bool $p_send_email generate email?
 * @param int $p_date_submitted date submitted (defaults to now())
 * @param int $p_last_modified last modification date (defaults to now())
 * @param bool $p_skip_bug_update skip bug last modification update (useful when importing bugs/bugnotes)
 * @return bool|int false or indicating bugnote id added
 * @access public
 * @throws MantisBT\Exception\Field\EmptyField
 */
function bugnote_add( $p_bug_id, $p_bugnote_text, $p_time_tracking = '0:00', $p_private = false, $p_type = 0, $p_attr = '', $p_user_id = null, $p_send_email = TRUE, $p_date_submitted = 0, $p_last_modified = 0, $p_skip_bug_update = FALSE ) {
	$c_bug_id = (int)$p_bug_id;
	$c_time_tracking = helper_duration_to_minutes( $p_time_tracking );
	$c_type = (int)$p_type;
	$c_date_submitted = $p_date_submitted <= 0 ? db_now() : (int)$p_date_submitted;
	$c_last_modified = $p_last_modified <= 0 ? db_now() : (int)$p_last_modified;

	$t_time_tracking_enabled = config_get( 'time_tracking_enabled' );
	$t_time_tracking_without_note = config_get( 'time_tracking_without_note' );

	if( ON == $t_time_tracking_enabled && $c_time_tracking > 0 ) {
		if( is_blank( $p_bugnote_text ) && OFF == $t_time_tracking_without_note ) {
			throw new MantisBT\Exception\Field\EmptyField( _( 'Note' ) );
		}
		$c_type = TIME_TRACKING;
	} else if( is_blank( $p_bugnote_text ) ) {
		throw new MantisBT\Exception\Field\EmptyField( _( 'Note' ) );
	}

	$t_bugnote_text = trim( $p_bugnote_text );

	# Event integration
	$t_bugnote_text = event_signal( 'EVENT_BUGNOTE_DATA', $t_bugnote_text, $c_bug_id );

	# get user information
	if( $p_user_id === null ) {
		$p_user_id = auth_get_current_user_id();
	}

	# Check for private bugnotes.
	if( $p_private && access_has_bug_level( config_get( 'set_view_status_threshold' ), $p_bug_id, $p_user_id ) ) {
		$t_view_state = VS_PRIVATE;
	} else {
		$t_view_state = VS_PUBLIC;
	}

	# insert bugnote info
	$t_query = "INSERT INTO {bugnote}
				(bug_id, reporter_id, view_state, date_submitted, last_modified, note_type, note_attr, time_tracking, note )
			VALUES (%d, %d, %d, %d,%d, %d, %s, %d, %s )";
	db_query( $t_query, array( $c_bug_id, $p_user_id, $t_view_state, $c_date_submitted, $c_last_modified, $c_type, $p_attr, $c_time_tracking, $t_bugnote_text ) );

	# get bugnote id
	$t_bugnote_id = db_insert_id( '{bugnote}' );

	# update bug last updated
	if ( !$p_skip_bug_update ) {
		bug_update_date( $p_bug_id );
	}

	# log new bug
	history_log_event_special( $p_bug_id, BUGNOTE_ADDED, bugnote_format_id( $t_bugnote_id ) );

	# Event integration
	event_signal( 'EVENT_BUGNOTE_ADD', array( $p_bug_id, $t_bugnote_id ) );

	# only send email if the text is not blank, otherwise, it is just recording of time without a comment.
	if( TRUE == $p_send_email && !is_blank( $t_bugnote_text ) ) {
		email_bugnote_add( $p_bug_id );
	}

	return $t_bugnote_id;
}

/**
 * Delete a bugnote
 * @param int $p_bugnote_id bug note id
 * @return bool
 * @access public
 */
function bugnote_delete( $p_bugnote_id ) {
	$t_bug_id = bugnote_get_field( $p_bugnote_id, 'bug_id' );

	# Remove the bugnote
	$t_query = 'DELETE FROM {bugnote} WHERE id=%d';
	db_query( $t_query, array( $p_bugnote_id ) );

	# log deletion of bug
	history_log_event_special( $t_bug_id, BUGNOTE_DELETED, bugnote_format_id( $p_bugnote_id ) );

	# Event integration
	event_signal( 'EVENT_BUGNOTE_DELETED', array( $t_bug_id, $f_bugnote_id ) );

	return true;
}

/**
 * delete all bugnotes associated with the given bug
 * @param int $p_bug_id bug id
 * @return bool
 * @access public
 */
function bugnote_delete_all( $p_bug_id ) {
	$t_query = 'DELETE FROM {bugnote} WHERE bug_id=%d';
	$result = db_query( $t_query, array( (int)$p_bug_id ) );

	# db_query errors on failure so:
	return true;
}

/**
 * Get the text associated with the bugnote
 * @param int $p_bugnote_id bugnote id
 * @return string bugnote text
 * @access public
 */
function bugnote_get_text( $p_bugnote_id ) {
	# grab the bugnote text
	$t_query = 'SELECT note FROM {bugnote} WHERE id=%d';
	$t_result = db_query( $t_query, array( $p_bugnote_id ) );

	return db_result( $t_result );
}

/**
 * Get a field for the given bugnote
 * @param int $p_bugnote_id bugnote id
 * @param string $p_field_name field name
 * @return string field value
 * @access public
 * @throws MantisBT\Exception\Database\FieldNotFound
 */
function bugnote_get_field( $p_bugnote_id, $p_field_name ) {
	static $t_vars;
	global $g_cache_bugnote;

	if( isset( $g_cache_bugnote[(int)$p_bugnote_id] ) ) {
		return $g_cache_bugnote[(int)$p_bugnote_id]->$p_field_name;
	}

	if ($t_vars == null ) {
		$t_vars = getClassProperties( 'BugnoteData', 'public');
	}

	if( !array_key_exists( $p_field_name, $t_vars ) ) {
		throw new MantisBT\Exception\Database\FieldNotFound( $p_field_name );
	}

	$query = "SELECT $p_field_name FROM {bugnote} WHERE id=%d";
	$result = db_query( $query, array( $p_bugnote_id ), 1 );

	return db_result( $result );
}

/**
 * Get latest bugnote id
 * @param int $p_bug_id bug id
 * @return int latest bugnote id
 * @access public
 */
function bugnote_get_latest_id( $p_bug_id ) {
	$t_query = 'SELECT id FROM {bugnote} WHERE bug_id=%d ORDER by last_modified DESC';
	$t_result = db_query( $t_query, array( $p_bug_id ), 1 );

	return (int)db_result( $t_result );
}

/**
 * Build the bugnotes array for the given bug_id filtered by specified $p_user_access_level.
 * Bugnotes are sorted by date_submitted according to 'bugnote_order' configuration setting.
 * Return BugnoteData class object with raw values from the tables except the field
 * last_modified - it is UNIX_TIMESTAMP.
 * @param MantisBug $p_bug Bug Object
 * @param int $p_user_bugnote_order sort order
 * @param int $p_user_bugnote_limit number of bugnotes to display to user
 * @param int $p_user_id user id
 * @return array array of bugnotes
 * @access public
 */
function bugnote_get_all_visible_bugnotes( $p_bug, $p_user_bugnote_order, $p_user_bugnote_limit, $p_user_id = null ) {
	if( $p_user_id === null ) {
		$t_user_id = auth_get_current_user_id();
	} else {
		$t_user_id = $p_user_id;
	}

	$t_project_id = $p_bug->project_id;
	$t_user_access_level = user_get_access_level( $t_user_id, $t_project_id );

	$t_all_bugnotes = bugnote_get_all_bugnotes( $p_bug->id );
	$t_private_bugnote_threshold = config_get( 'private_bugnote_threshold' );

	$t_private_bugnote_visible = access_compare_level( $t_user_access_level, config_get( 'private_bugnote_threshold' ) );
	$t_time_tracking_visible = access_compare_level( $t_user_access_level, config_get( 'time_tracking_view_threshold' ) );

	$t_bugnotes = array();
	$t_bugnote_count = count( $t_all_bugnotes );
	$t_bugnote_limit = $p_user_bugnote_limit > 0 ? $p_user_bugnote_limit : $t_bugnote_count;
	$t_bugnotes_found = 0;

	# build a list of the latest bugnotes that the user can see
	for ( $i = 0; ( $i < $t_bugnote_count ) && ( $t_bugnotes_found < $t_bugnote_limit ); $i++ ) {
		$t_bugnote = array_pop( $t_all_bugnotes );

		if( $t_private_bugnote_visible || $t_bugnote->reporter_id == $t_user_id || ( VS_PUBLIC == $t_bugnote->view_state ) ) {

			# If the access level specified is not enough to see time tracking information
			# then reset it to 0.
			if( !$t_time_tracking_visible ) {
				$t_bugnote->time_tracking = 0;
			}

			$t_bugnotes[$t_bugnotes_found++] = $t_bugnote;
		}
	}

	# reverse the list for users with ascending view preferences
	if ( 'ASC' == $p_user_bugnote_order ) {
		$t_bugnotes = array_reverse( $t_bugnotes );
	}

	return $t_bugnotes;
}

/**
 * Build the bugnotes array for the given bug_id.
 * Return BugnoteData class object with raw values from the tables except the field
 * last_modified - it is UNIX_TIMESTAMP.
 * The data is not filtered by VIEW_STATE !!
 * @param int $p_bug_id bug id
 * @return array array of bugnotes
 * @access public
 */
function bugnote_get_all_bugnotes( $p_bug_id ) {
	global $g_cache_bugnotes, $g_cache_bugnote;

	if( !isset( $g_cache_bugnotes ) ) {
		$g_cache_bugnotes = array();
	}

	if( !isset( $g_cache_bugnote ) ) {
		$g_cache_bugnote = array();
	}

	# the cache should be aware of the sorting order
	if( !isset( $g_cache_bugnotes[(int)$p_bug_id] ) ) {
		# sort by bugnote id which should be more accurate than submit date, since two bugnotes
		# may be submitted at the same time if submitted using a script (eg: MantisConnect).
		$t_query = "SELECT * FROM {bugnote}
						WHERE bug_id=%d
						ORDER BY id ASC";
		$t_bugnotes = array();

		# BUILD bugnotes array
		$t_result = db_query( $t_query, array( $p_bug_id ) );

		while( $row = db_fetch_array( $t_result ) ) {
			$t_bugnote = new BugnoteData;

			$t_bugnote->id = $row['id'];
			$t_bugnote->bug_id = $row['bug_id'];
			$t_bugnote->note = $row['note'];
			$t_bugnote->view_state = $row['view_state'];
			$t_bugnote->reporter_id = $row['reporter_id'];
			$t_bugnote->date_submitted = $row['date_submitted'];
			$t_bugnote->last_modified = $row['last_modified'];
			$t_bugnote->note_type = $row['note_type'];
			$t_bugnote->note_attr = $row['note_attr'];
			$t_bugnote->time_tracking = $row['time_tracking'];

			$t_bugnotes[] = $t_bugnote;
			$g_cache_bugnote[(int)$t_bugnote->id] = $t_bugnote;
		}

		$g_cache_bugnotes[(int)$p_bug_id] = $t_bugnotes;
	}

	return $g_cache_bugnotes[(int)$p_bug_id];
}

/**
 * Update the time_tracking field of the bugnote
 * @param int $p_bugnote_id bugnote id
 * @param string $p_time_tracking timetracking string (hh:mm format)
 * @return bool
 * @access public
 */
function bugnote_set_time_tracking( $p_bugnote_id, $p_time_tracking ) {
	$c_bugnote_time_tracking = helper_duration_to_minutes( $p_time_tracking );

	$t_query = 'UPDATE {bugnote} SET time_tracking=%d WHERE id=%d';
	db_query( $t_query, array( $c_bugnote_time_tracking, $p_bugnote_id ) );

	# db_query errors if there was a problem so:
	return true;
}

/**
 * Update the last_modified field of the bugnote
 * @param int $p_bugnote_id bugnote id
 * @return bool
 * @access public
 */
function bugnote_date_update( $p_bugnote_id ) {
	$query = 'UPDATE {bugnote} SET last_modified=%d WHERE id=%d';
	db_query( $query, array( db_now(), $p_bugnote_id ) );

	# db_query errors if there was a problem so:
	return true;
}

/**
 * Set the bugnote text
 * @param int $p_bugnote_id bugnote id
 * @param string $p_bugnote_text bugnote text
 * @return bool
 * @access public
 */
function bugnote_set_text( $p_bugnote_id, $p_bugnote_text ) {
	$t_old_text = bugnote_get_text( $p_bugnote_id );

	if ( $t_old_text == $p_bugnote_text ) {
		return true;
	}

	$t_bug_id = bugnote_get_field( $p_bugnote_id, 'bug_id' );
	$t_bug = bug_get( $t_bug_id );

	# insert an 'original' revision if needed
	if ( bug_revision_count( $t_bug_id, REV_BUGNOTE, $p_bugnote_id ) < 1 ) {
		$t_user_id = bugnote_get_field( $p_bugnote_id, 'reporter_id' );
		$t_timestamp = bugnote_get_field( $p_bugnote_id, 'last_modified' );
		bug_revision_add( $t_bug, $t_user_id, REV_BUGNOTE, $t_old_text, $p_bugnote_id, $t_timestamp );
	}

	$t_query = "UPDATE {bugnote} SET note=%s WHERE id=%d";
	db_query( $t_query, array( $p_bugnote_text, $p_bugnote_id ) );

	# updated the last_updated date
	bugnote_date_update( $p_bugnote_id );

	# insert a new revision
	$t_user_id = auth_get_current_user_id();
	$t_revision_id = bug_revision_add( $t_bug_id, $t_user_id, REV_BUGNOTE, $p_bugnote_text, $p_bugnote_id );

	# log new bugnote
	history_log_event_special( $t_bug_id, BUGNOTE_UPDATED, bugnote_format_id( $p_bugnote_id ), $t_revision_id );

	return true;
}

/**
 * Set the view state of the bugnote
 * @param int $p_bugnote_id bugnote id
 * @param bool $p_private
 * @return bool
 * @access public
 */
function bugnote_set_view_state( $p_bugnote_id, $p_private ) {
	$t_bug_id = bugnote_get_field( $p_bugnote_id, 'bug_id' );

	if( $p_private ) {
		$t_view_state = VS_PRIVATE;
	} else {
		$t_view_state = VS_PUBLIC;
	}

	$t_query = "UPDATE {bugnote} SET view_state=%d WHERE id=%d";
	db_query( $t_query, array( $t_view_state, $p_bugnote_id ) );

	history_log_event_special( $t_bug_id, BUGNOTE_STATE_CHANGED, $t_view_state, bugnote_format_id( $p_bugnote_id ) );

	return true;
}

/**
 * Pad the bugnote id with the appropriate number of zeros for printing
 * @param int $p_bugnote_id bugnote id
 * @return string
 * @access public
 */
function bugnote_format_id( $p_bugnote_id ) {
	$t_padding = config_get( 'display_bugnote_padding' );
	return sprintf('%0' . (int)$t_padding . 'd', $p_bugnote_id);
}

/**
 * Returns an array of bugnote stats
 * @param int $p_bug_id bug id
 * @param string $p_from Starting date (yyyy-mm-dd) inclusive, if blank, then ignored.
 * @param string $p_to Ending date (yyyy-mm-dd) inclusive, if blank, then ignored.
 * @return array array of bugnote stats
 * @access public
 */
function bugnote_stats_get_events_array( $p_bug_id, $p_from, $p_to ) {
	$c_to = strtotime( $p_to ) + SECONDS_PER_DAY - 1;
	$c_from = strtotime( $p_from );

	if( !is_blank( $c_from ) ) {
		$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 ";
	} else {
		$t_to_where = '';
	}

	$t_results = array();

	$t_query = "SELECT username, SUM(time_tracking) AS sum_time_tracking
				FROM {user} u, {bugnote} bn
				WHERE u.id=bn.reporter_id AND bn.bug_id=%d
				$t_from_where $t_to_where
			GROUP BY u.id, u.username";

	$t_result = db_query( $t_query, array( $p_bug_id) );

	while( $t_row = db_fetch_array( $t_result ) ) {
		$t_results[] = $t_row;
	}

	return $t_results;
}

/**
 * Returns an array of bugnote stats
 * @param int $p_project_id project id
 * @param string $p_from Starting date (yyyy-mm-dd) inclusive, if blank, then ignored.
 * @param string $p_to Ending date (yyyy-mm-dd) inclusive, if blank, then ignored.
 * @param int $p_cost cost
 * @param int $p_user_id Optional user id of user who added the bugnote
 * @return array array of bugnote stats
 * @access public
 * @throws MantisBT\Exception\UnknownException
 */
function bugnote_stats_get_project_array( $p_project_id, $p_from, $p_to, $p_cost, $p_user_id = ALL_USERS ) {
	$t_params = array();

	$c_to = strtotime( $p_to ) + SECONDS_PER_DAY - 1;
	$c_from = strtotime( $p_from );

	if ( $c_to === false || $c_from === false ) {
		throw new MantisBT\Exception\UnknownException( array( $p_from, $p_to ) );
	}

	if( ALL_PROJECTS != $p_project_id ) {
		$t_project_where = " AND b.project_id=%d AND bn.bug_id = b.id";
		$t_params[] = $p_project_id;
	} else {
		$t_project_where = '';
	}

	if( !is_blank( $c_from ) ) {
		$t_from_where = " AND bn.date_submitted>=%d";
		$t_params[] = $c_from;
	} else {
		$t_from_where = '';
	}

	if( !is_blank( $c_to ) ) {
		$t_to_where = " AND bn.date_submitted<=%d";
		$t_params[] = $c_to;
	} else {
		$t_to_where = '';
	}

	if( ALL_USERS != $p_user_id ) {
		$t_reporter_where = " AND bn.reporter_id=%d";
		$t_params[] = $p_user_id;
	} else {
		$t_reporter_where = '';
	}

	$t_results = array();

	$t_query = "SELECT username, summary, bn.bug_id, SUM(time_tracking) AS sum_time_tracking
			FROM {user} u, {bugnote} bn, {bug} b
			WHERE u.id = bn.reporter_id AND bn.time_tracking != 0 AND bn.bug_id = b.id
			$t_project_where $t_from_where $t_to_where $t_reporter_where
			GROUP BY bn.bug_id, u.id, u.username, b.summary
			ORDER BY bn.bug_id";

	$t_result = db_query( $t_query, $t_params );

	$t_cost_min = $p_cost / 60.0;

	while( $t_row = db_fetch_array( $t_result ) ) {
		$t_total_cost = $t_cost_min * $t_row['sum_time_tracking'];
		$t_row['cost'] = $t_total_cost;
		$t_results[] = $t_row;
	}

	return $t_results;
}

/**
 * Clear a bugnote from the cache or all bug notes if no bugnote id specified.
 * @param int $p_bugnote_id id to clear (optional)
 * @return bool
 * @access public
 */
function bugnote_clear_cache( $p_bugnote_id = null ) {
	global $g_cache_bugnote, $g_cache_bugnotes;

	if( null === $p_bugnote_id ) {
		$g_cache_bugnote = array();
	} else {
		unset( $g_cache_bugnote[(int) $p_bugnote_id] );
	}
	$g_cache_bugnotes = array();

	return true;
}