<?php

/**

 * bbPress Common Functions

 *

 * Common functions are ones that are used by more than one component, like

 * forums, topics, replies, users, topic tags, etc...

 *

 * @package bbPress

 * @subpackage Functions

 */

// Exit if accessed directly

if ( !defined( 'ABSPATH' ) ) exit;

/** Formatting ****************************************************************/

/**

 * A bbPress specific method of formatting numeric values

 *

 * @since bbPress (r2486)

 *

 * @param string $number Number to format

 * @param string $decimals Optional. Display decimals

 * @uses apply_filters() Calls 'bbp_number_format' with the formatted values,

 *                        number and display decimals bool

 * @return string Formatted string

 */

function bbp_number_format( $number = 0, $decimals = false, $dec_point = '.', $thousands_sep = ',' ) {

	// If empty, set $number to (int) 0

	if ( ! is_numeric( $number ) )

		$number = 0;

	return apply_filters( 'bbp_number_format', number_format( $number, $decimals, $dec_point, $thousands_sep ), $number, $decimals, $dec_point, $thousands_sep );

}

/**

 * A bbPress specific method of formatting numeric values

 *

 * @since bbPress (r3857)

 *

 * @param string $number Number to format

 * @param string $decimals Optional. Display decimals

 * @uses apply_filters() Calls 'bbp_number_format' with the formatted values,

 *                        number and display decimals bool

 * @return string Formatted string

 */

function bbp_number_format_i18n( $number = 0, $decimals = false ) {

	// If empty, set $number to (int) 0

	if ( ! is_numeric( $number ) )

		$number = 0;

	return apply_filters( 'bbp_number_format_i18n', number_format_i18n( $number, $decimals ), $number, $decimals );

}

/**

 * Convert time supplied from database query into specified date format.

 *

 * @since bbPress (r2455)

 *

 * @param int|object $post Optional. Default is global post object. A post_id or

 *                          post object

 * @param string $d Optional. Default is 'U'. Either 'G', 'U', or php date

 *                             format

 * @param bool $translate Optional. Default is false. Whether to translate the

 *                                   result

 * @uses mysql2date() To convert the format

 * @uses apply_filters() Calls 'bbp_convert_date' with the time, date format

 *                        and translate bool

 * @return string Returns timestamp

 */

function bbp_convert_date( $time, $d = 'U', $translate = false ) {

	$time = mysql2date( $d, $time, $translate );

	return apply_filters( 'bbp_convert_date', $time, $d, $translate );

}

/**

 * Output formatted time to display human readable time difference.

 *

 * @since bbPress (r2544)

 *

 * @param string $older_date Unix timestamp from which the difference begins.

 * @param string $newer_date Optional. Unix timestamp from which the

 *                            difference ends. False for current time.

 * @uses bbp_get_time_since() To get the formatted time

 */

function bbp_time_since( $older_date, $newer_date = false ) {

	echo bbp_get_time_since( $older_date, $newer_date = false );

}

	/**

	 * Return formatted time to display human readable time difference.

	 *

	 * @since bbPress (r2544)

	 *

	 * @param string $older_date Unix timestamp from which the difference begins.

	 * @param string $newer_date Optional. Unix timestamp from which the

	 *                            difference ends. False for current time.

	 * @uses current_time() To get the current time in mysql format

	 * @uses human_time_diff() To get the time differene in since format

	 * @uses apply_filters() Calls 'bbp_get_time_since' with the time

	 *                        difference and time

	 * @return string Formatted time

	 */

	function bbp_get_time_since( $older_date, $newer_date = false ) {

		// Setup the strings

		$unknown_text   = apply_filters( 'bbp_core_time_since_unknown_text',   __( 'sometime',  'bbpress' ) );

		$right_now_text = apply_filters( 'bbp_core_time_since_right_now_text', __( 'right now', 'bbpress' ) );

		$ago_text       = apply_filters( 'bbp_core_time_since_ago_text',       __( '%s ago',    'bbpress' ) );

		// array of time period chunks

		$chunks = array(

			array( 60 * 60 * 24 * 365 , __( 'year',   'bbpress' ), __( 'years',   'bbpress' ) ),

			array( 60 * 60 * 24 * 30 ,  __( 'month',  'bbpress' ), __( 'months',  'bbpress' ) ),

			array( 60 * 60 * 24 * 7,    __( 'week',   'bbpress' ), __( 'weeks',   'bbpress' ) ),

			array( 60 * 60 * 24 ,       __( 'day',    'bbpress' ), __( 'days',    'bbpress' ) ),

			array( 60 * 60 ,            __( 'hour',   'bbpress' ), __( 'hours',   'bbpress' ) ),

			array( 60 ,                 __( 'minute', 'bbpress' ), __( 'minutes', 'bbpress' ) ),

			array( 1,                   __( 'second', 'bbpress' ), __( 'seconds', 'bbpress' ) )

		);

		if ( !empty( $older_date ) && !is_numeric( $older_date ) ) {

			$time_chunks = explode( ':', str_replace( ' ', ':', $older_date ) );

			$date_chunks = explode( '-', str_replace( ' ', '-', $older_date ) );

			$older_date  = gmmktime( (int) $time_chunks[1], (int) $time_chunks[2], (int) $time_chunks[3], (int) $date_chunks[1], (int) $date_chunks[2], (int) $date_chunks[0] );

		}

		// $newer_date will equal false if we want to know the time elapsed

		// between a date and the current time. $newer_date will have a value if

		// we want to work out time elapsed between two known dates.

		$newer_date = ( !$newer_date ) ? strtotime( current_time( 'mysql' ) ) : $newer_date;

		// Difference in seconds

		$since = $newer_date - $older_date;

		// Something went wrong with date calculation and we ended up with a negative date.

		if ( 0 > $since ) {

			$output = $unknown_text;

		// We only want to output two chunks of time here, eg:

		//     x years, xx months

		//     x days, xx hours

		// so there's only two bits of calculation below:

		} else {

			// Step one: the first chunk

			for ( $i = 0, $j = count( $chunks ); $i < $j; ++$i ) {

				$seconds = $chunks[$i][0];

				// Finding the biggest chunk (if the chunk fits, break)

				$count = floor( $since / $seconds );

				if ( 0 != $count ) {

					break;

				}

			}

			// If $i iterates all the way to $j, then the event happened 0 seconds ago

			if ( !isset( $chunks[$i] ) ) {

				$output = $right_now_text;

			} else {

				// Set output var

				$output = ( 1 == $count ) ? '1 '. $chunks[$i][1] : $count . ' ' . $chunks[$i][2];

				// Step two: the second chunk

				if ( $i + 2 < $j ) {

					$seconds2 = $chunks[$i + 1][0];

					$name2    = $chunks[$i + 1][1];

					$count2   = floor( ( $since - ( $seconds * $count ) ) / $seconds2 );

					// Add to output var

					if ( 0 != $count2 ) {

						$output .= ( 1 == $count2 ) ? _x( ',', 'Separator in time since', 'bbpress' ) . ' 1 '. $name2 : _x( ',', 'Separator in time since', 'bbpress' ) . ' ' . $count2 . ' ' . $chunks[$i + 1][2];

					}

				}

				// No output, so happened right now

				if ( ! (int) trim( $output ) ) {

					$output = $right_now_text;

				}

			}

		}

		// Append 'ago' to the end of time-since if not 'right now'

		if ( $output != $right_now_text ) {

			$output = sprintf( $ago_text, $output );

		}

		return apply_filters( 'bbp_get_time_since', $output, $older_date, $newer_date );

	}

/**

 * Formats the reason for editing the topic/reply.

 *

 * Does these things:

 *  - Trimming

 *  - Removing periods from the end of the string

 *  - Trimming again

 *

 * @since bbPress (r2782)

 *

 * @param int $topic_id Optional. Topic id

 * @return string Status of topic

 */

function bbp_format_revision_reason( $reason = '' ) {

	$reason = (string) $reason;

	// Format reason for proper display

	if ( empty( $reason ) )

		return $reason;

	// Trimming

	$reason = trim( $reason );

	// We add our own full stop.

	while ( substr( $reason, -1 ) == '.' )

		$reason = substr( $reason, 0, -1 );

	// Trim again

	$reason = trim( $reason );

	return $reason;

}

/** Misc **********************************************************************/

/**

 * Append 'view=all' to query string if it's already there from referer

 *

 * @since bbPress (r3325)

 *

 * @param string $original_link Original Link to be modified

 * @param bool $force Override bbp_get_view_all() check

 * @uses current_user_can() To check if the current user can moderate

 * @uses add_query_arg() To add args to the url

 * @uses apply_filters() Calls 'bbp_add_view_all' with the link and original link

 * @return string The link with 'view=all' appended if necessary

 */

function bbp_add_view_all( $original_link = '', $force = false ) {

	// Are we appending the view=all vars?

	if ( bbp_get_view_all() || !empty( $force ) )

		$link = add_query_arg( array( 'view' => 'all' ), $original_link );

	else

		$link = $original_link;

	return apply_filters( 'bbp_add_view_all', $link, $original_link );

}

/**

 * Remove 'view=all' from query string

 *

 * @since bbPress (r3325)

 *

 * @param string $original_link Original Link to be modified

 * @uses current_user_can() To check if the current user can moderate

 * @uses add_query_arg() To add args to the url

 * @uses apply_filters() Calls 'bbp_add_view_all' with the link and original link

 * @return string The link with 'view=all' appended if necessary

 */

function bbp_remove_view_all( $original_link = '' ) {

	return apply_filters( 'bbp_add_view_all', remove_query_arg( 'view', $original_link ), $original_link );

}

/**

 * If current user can and is vewing all topics/replies

 *

 * @since bbPress (r3325)

 *

 * @uses current_user_can() To check if the current user can moderate

 * @uses apply_filters() Calls 'bbp_get_view_all' with the link and original link

 * @return bool Whether current user can and is viewing all

 */

function bbp_get_view_all( $cap = 'moderate' ) {

	$retval = ( ( !empty( $_GET['view'] ) && ( 'all' == $_GET['view'] ) && current_user_can( $cap ) ) );

	return apply_filters( 'bbp_get_view_all', (bool) $retval );

}

/**

 * Assist pagination by returning correct page number

 *

 * @since bbPress (r2628)

 *

 * @uses get_query_var() To get the 'paged' value

 * @return int Current page number

 */

function bbp_get_paged() {

	global $wp_query;

	// Check the query var

	if ( get_query_var( 'paged' ) ) {

		$paged = get_query_var( 'paged' );

	// Check query paged

	} elseif ( !empty( $wp_query->query['paged'] ) ) {

		$paged = $wp_query->query['paged'];

	}

	// Paged found

	if ( !empty( $paged ) )

		return (int) $paged;

	// Default to first page

	return 1;

}

/**

 * Fix post author id on post save

 *

 * When a logged in user changes the status of an anonymous reply or topic, or

 * edits it, the post_author field is set to the logged in user's id. This

 * function fixes that.

 *

 * @since bbPress (r2734)

 *

 * @param array $data Post data

 * @param array $postarr Original post array (includes post id)

 * @uses bbp_get_topic_post_type() To get the topic post type

 * @uses bbp_get_reply_post_type() To get the reply post type

 * @uses bbp_is_topic_anonymous() To check if the topic is by an anonymous user

 * @uses bbp_is_reply_anonymous() To check if the reply is by an anonymous user

 * @return array Data

 */

function bbp_fix_post_author( $data = array(), $postarr = array() ) {

	// Post is not being updated or the post_author is already 0, return

	if ( empty( $postarr['ID'] ) || empty( $data['post_author'] ) )

		return $data;

	// Post is not a topic or reply, return

	if ( !in_array( $data['post_type'], array( bbp_get_topic_post_type(), bbp_get_reply_post_type() ) ) )

		return $data;

	// Is the post by an anonymous user?

	if ( ( bbp_get_topic_post_type() == $data['post_type'] && !bbp_is_topic_anonymous( $postarr['ID'] ) ) ||

	     ( bbp_get_reply_post_type() == $data['post_type'] && !bbp_is_reply_anonymous( $postarr['ID'] ) ) )

		return $data;

	// The post is being updated. It is a topic or a reply and is written by an anonymous user.

	// Set the post_author back to 0

	$data['post_author'] = 0;

	return $data;

}

/**

 * Check the date against the _bbp_edit_lock setting.

 *

 * @since bbPress (r3133)

 *

 * @param string $post_date_gmt

 *

 * @uses get_option() Get the edit lock time

 * @uses current_time() Get the current time

 * @uses strtotime() Convert strings to time

 * @uses apply_filters() Allow output to be manipulated

 *

 * @return bool

 */

function bbp_past_edit_lock( $post_date_gmt ) {

	// Assume editing is allowed

	$retval = false;

	// Bail if empty date

	if ( ! empty( $post_date_gmt ) ) {

		// Period of time

		$lockable  = '+' . get_option( '_bbp_edit_lock', '5' ) . ' minutes';

		// Now

		$cur_time  = current_time( 'timestamp', true );

		// Add lockable time to post time

		$lock_time = strtotime( $lockable, strtotime( $post_date_gmt ) );

		// Compare

		if ( $cur_time >= $lock_time ) {

			$retval = true;

		}

	}

	return apply_filters( 'bbp_past_edit_lock', (bool) $retval, $cur_time, $lock_time, $post_date_gmt );

}

/** Statistics ****************************************************************/

/**

 * Get the forum statistics

 *

 * @since bbPress (r2769)

 *

 * @param mixed $args Optional. The function supports these arguments (all

 *                     default to true):

 *  - count_users: Count users?

 *  - count_forums: Count forums?

 *  - count_topics: Count topics? If set to false, private, spammed and trashed

 *                   topics are also not counted.

 *  - count_private_topics: Count private topics? (only counted if the current

 *                           user has read_private_topics cap)

 *  - count_spammed_topics: Count spammed topics? (only counted if the current

 *                           user has edit_others_topics cap)

 *  - count_trashed_topics: Count trashed topics? (only counted if the current

 *                           user has view_trash cap)

 *  - count_replies: Count replies? If set to false, private, spammed and

 *                   trashed replies are also not counted.

 *  - count_private_replies: Count private replies? (only counted if the current

 *                           user has read_private_replies cap)

 *  - count_spammed_replies: Count spammed replies? (only counted if the current

 *                           user has edit_others_replies cap)

 *  - count_trashed_replies: Count trashed replies? (only counted if the current

 *                           user has view_trash cap)

 *  - count_tags: Count tags? If set to false, empty tags are also not counted

 *  - count_empty_tags: Count empty tags?

 * @uses bbp_count_users() To count the number of registered users

 * @uses bbp_get_forum_post_type() To get the forum post type

 * @uses bbp_get_topic_post_type() To get the topic post type

 * @uses bbp_get_reply_post_type() To get the reply post type

 * @uses wp_count_posts() To count the number of forums, topics and replies

 * @uses wp_count_terms() To count the number of topic tags

 * @uses current_user_can() To check if the user is capable of doing things

 * @uses number_format_i18n() To format the number

 * @uses apply_filters() Calls 'bbp_get_statistics' with the statistics and args

 * @return object Walked forum tree

 */

function bbp_get_statistics( $args = '' ) {

	$defaults = array (

		'count_users'           => true,

		'count_forums'          => true,