<?php

/**

 * bbPress User Functions

 *

 * @package bbPress

 * @subpackage Functions

 */

// Exit if accessed directly

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

/**

 * Redirect back to $url when attempting to use the login page

 *

 * @since bbPress (r2815)

 *

 * @param string $url The url

 * @param string $raw_url Raw url

 * @param object $user User object

 * @uses is_wp_error() To check if the user param is a {@link WP_Error}

 * @uses admin_url() To get the admin url

 * @uses home_url() To get the home url

 * @uses esc_url() To escape the url

 * @uses wp_safe_redirect() To redirect

 */

function bbp_redirect_login( $url = '', $raw_url = '', $user = '' ) {

	// Raw redirect_to was passed, so use it

	if ( !empty( $raw_url ) )

		$url = $raw_url;

	// $url was manually set in wp-login.php to redirect to admin

	elseif ( admin_url() == $url )

		$url = home_url();

	// $url is empty

	elseif ( empty( $url ) )

		$url = home_url();

	return apply_filters( 'bbp_redirect_login', $url, $raw_url, $user );

}

/**

 * Is an anonymous topic/reply being made?

 *

 * @since bbPres (r2688)

 *

 * @uses is_user_logged_in() Is the user logged in?

 * @uses bbp_allow_anonymous() Is anonymous posting allowed?

 * @uses apply_filters() Calls 'bbp_is_anonymous' with the return value

 * @return bool True if anonymous is allowed and user is not logged in, false if

 *               anonymous is not allowed or user is logged in

 */

function bbp_is_anonymous() {

	if ( !is_user_logged_in() && bbp_allow_anonymous() )

		$is_anonymous = true;

	else

		$is_anonymous = false;

	return apply_filters( 'bbp_is_anonymous', $is_anonymous );

}

/**

 * Echoes the values for current poster (uses WP comment cookies)

 *

 * @since bbPress (r2734)

 *

 * @param string $key Which value to echo?

 * @uses bbp_get_current_anonymous_user_data() To get the current anonymous user

 *                                              data

 */

function bbp_current_anonymous_user_data( $key = '' ) {

	echo bbp_get_current_anonymous_user_data( $key );

}

	/**

	 * Get the cookies for current poster (uses WP comment cookies).

	 *

	 * @since bbPress (r2734)

	 *

	 * @param string $key Optional. Which value to get? If not given, then

	 *                     an array is returned.

	 * @uses sanitize_comment_cookies() To sanitize the current poster data

	 * @uses wp_get_current_commenter() To get the current poster data	 *

	 * @return string|array Cookie(s) for current poster

	 */

	function bbp_get_current_anonymous_user_data( $key = '' ) {

		$cookie_names = array(

			'name'    => 'comment_author',

			'email'   => 'comment_author_email',

			'website' => 'comment_author_url',

			// Here just for the sake of them, use the above ones

			'comment_author'       => 'comment_author',

			'comment_author_email' => 'comment_author_email',

			'comment_author_url'   => 'comment_author_url',

		);

		sanitize_comment_cookies();

		$bbp_current_poster = wp_get_current_commenter();

		if ( !empty( $key ) && in_array( $key, array_keys( $cookie_names ) ) )

			return $bbp_current_poster[$cookie_names[$key]];

		return $bbp_current_poster;

	}

/**

 * Set the cookies for current poster (uses WP comment cookies)

 *

 * @since bbPress (r2734)

 *

 * @param array $anonymous_data With keys 'bbp_anonymous_name',

 *                               'bbp_anonymous_email', 'bbp_anonymous_website'.

 *                               Should be sanitized (see

 *                               {@link bbp_filter_anonymous_post_data()} for

 *                               sanitization)

 * @uses apply_filters() Calls 'comment_cookie_lifetime' for cookie lifetime.

 *                        Defaults to 30000000.

 */

function bbp_set_current_anonymous_user_data( $anonymous_data = array() ) {

	if ( empty( $anonymous_data ) || !is_array( $anonymous_data ) )

		return;

	$comment_cookie_lifetime = apply_filters( 'comment_cookie_lifetime', 30000000 );

	setcookie( 'comment_author_'       . COOKIEHASH, $anonymous_data['bbp_anonymous_name'],    time() + $comment_cookie_lifetime, COOKIEPATH, COOKIE_DOMAIN );

	setcookie( 'comment_author_email_' . COOKIEHASH, $anonymous_data['bbp_anonymous_email'],   time() + $comment_cookie_lifetime, COOKIEPATH, COOKIE_DOMAIN );

	setcookie( 'comment_author_url_'   . COOKIEHASH, $anonymous_data['bbp_anonymous_website'], time() + $comment_cookie_lifetime, COOKIEPATH, COOKIE_DOMAIN );

}

/**

 * Get the poster IP address

 *

 * @since bbPress (r3120)

 *

 * @return string

 */

function bbp_current_author_ip() {

	$retval = preg_replace( '/[^0-9a-fA-F:., ]/', '', $_SERVER['REMOTE_ADDR'] );

	return apply_filters( 'bbp_current_author_ip', $retval );

}

/**

 * Get the poster user agent

 *

 * @since bbPress (r3446)

 *

 * @return string

 */

function bbp_current_author_ua() {

	$retval = !empty( $_SERVER['HTTP_USER_AGENT'] ) ? substr( $_SERVER['HTTP_USER_AGENT'], 0, 254 ) : '';

	return apply_filters( 'bbp_current_author_ua', $retval );

}

/** Post Counts ***************************************************************/

/**

 * Return the raw database count of topics by a user

 *

 * @since bbPress (r3633)

 * @global WPDB $wpdb

 * @uses bbp_get_user_id()

 * @uses get_posts_by_author_sql()

 * @uses bbp_get_topic_post_type()

 * @uses apply_filters()

 * @return int Raw DB count of topics

 */

function bbp_get_user_topic_count_raw( $user_id = 0 ) {

	$user_id = bbp_get_user_id( $user_id );

	if ( empty( $user_id ) )

		return false;

	global $wpdb;

	$where = get_posts_by_author_sql( bbp_get_topic_post_type(), true, $user_id );

	$count = (int) $wpdb->get_var( "SELECT COUNT(*) FROM {$wpdb->posts} {$where}" );

	return (int) apply_filters( 'bbp_get_user_topic_count_raw', $count, $user_id );

}

/**

 * Return the raw database count of replies by a user

 *

 * @since bbPress (r3633)

 * @global WPDB $wpdb

 * @uses bbp_get_user_id()

 * @uses get_posts_by_author_sql()

 * @uses bbp_get_reply_post_type()

 * @uses apply_filters()

 * @return int Raw DB count of replies

 */

function bbp_get_user_reply_count_raw( $user_id = 0 ) {

	$user_id = bbp_get_user_id( $user_id );

	if ( empty( $user_id ) )

		return false;

	global $wpdb;

	$where = get_posts_by_author_sql( bbp_get_reply_post_type(), true, $user_id );

	$count = (int) $wpdb->get_var( "SELECT COUNT(*) FROM {$wpdb->posts} {$where}" );

	return (int) apply_filters( 'bbp_get_user_reply_count_raw', $count, $user_id );

}

/** Favorites *****************************************************************/

/**

 * Get the users who have made the topic favorite

 *

 * @since bbPress (r2658)

 *

 * @param int $topic_id Optional. Topic id

 * @uses wpdb::get_col() To execute our query and get the column back

 * @uses apply_filters() Calls 'bbp_get_topic_favoriters' with the users and

 *                        topic id

 * @return array|bool Results if the topic has any favoriters, otherwise false

 */

function bbp_get_topic_favoriters( $topic_id = 0 ) {

	if ( empty( $topic_id ) )

		return;

	global $wpdb;

	// Get the users who have favorited the topic

	$key   = $wpdb->prefix . '_bbp_favorites';

	$users = $wpdb->get_col( "SELECT user_id FROM {$wpdb->usermeta} WHERE meta_key = '{$key}' and FIND_IN_SET('{$topic_id}', meta_value) > 0" );

	$users = apply_filters( 'bbp_get_topic_favoriters', $users, $topic_id );

	if ( !empty( $users ) )

		return $users;

	return false;

}

/**

 * Get a user's favorite topics

 *

 * @since bbPress (r2652)

 *

 * @param int $user_id Optional. User id

 * @uses bbp_get_user_favorites_topic_ids() To get the user's favorites

 * @uses bbp_has_topics() To get the topics

 * @uses apply_filters() Calls 'bbp_get_user_favorites' with the topic query and

 *                        user id

 * @return array|bool Results if user has favorites, otherwise false

 */

function bbp_get_user_favorites( $user_id = 0 ) {

	$user_id = bbp_get_user_id( $user_id );

	if ( empty( $user_id ) )

		return false;

	// If user has favorites, load them

	$favorites = bbp_get_user_favorites_topic_ids( $user_id );

	if ( !empty( $favorites ) ) {

		// Setup the topics query

		$topics_query = bbp_has_topics( array( 'post__in' => $favorites ) );

		return apply_filters( 'bbp_get_user_favorites', $topics_query, $user_id );

	}

	return false;

}

/**

 * Get a user's favorite topics' ids

 *

 * @since bbPress (r2652)

 *

 * @param int $user_id Optional. User id

 * @uses bbp_get_user_id() To get the user id

 * @uses get_user_option() To get the user favorites

 * @uses apply_filters() Calls 'bbp_get_user_favorites_topic_ids' with

 *                        the favorites and user id

 * @return array|bool Results if user has favorites, otherwise false

 */

function bbp_get_user_favorites_topic_ids( $user_id = 0 ) {

	$user_id = bbp_get_user_id( $user_id );

	if ( empty( $user_id ) )

		return false;

	$favorites = (string) get_user_option( '_bbp_favorites', $user_id );

	$favorites = (array) explode( ',', $favorites );

	$favorites = array_filter( $favorites );

	return apply_filters( 'bbp_get_user_favorites_topic_ids', $favorites, $user_id );

}

/**

 * Check if a topic is in user's favorites or not

 *

 * @since bbPress (r2652)

 *

 * @param int $user_id Optional. User id

 * @param int $topic_id Optional. Topic id

 * @uses bbp_get_user_id() To get the user id

 * @uses bbp_get_user_favorites_topic_ids() To get the user favorites

 * @uses bbp_get_topic() To get the topic

 * @uses bbp_get_topic_id() To get the topic id

 * @uses apply_filters() Calls 'bbp_is_user_favorite' with the bool, user id,

 *                        topic id and favorites

 * @return bool True if the topic is in user's favorites, otherwise false

 */

function bbp_is_user_favorite( $user_id = 0, $topic_id = 0 ) {

	$user_id = bbp_get_user_id( $user_id, true, true );

	if ( empty( $user_id ) )

		return false;

	$retval    = false;

	$favorites = bbp_get_user_favorites_topic_ids( $user_id );

	if ( !empty( $favorites ) ) {

		// Checking a specific topic id

		if ( !empty( $topic_id ) ) {

			$topic    = bbp_get_topic( $topic_id );

			$topic_id = !empty( $topic ) ? $topic->ID : 0;

		// Using the global topic id

		} elseif ( bbp_get_topic_id() ) {

			$topic_id = bbp_get_topic_id();

		// Use the current post id

		} elseif ( !bbp_get_topic_id() ) {

			$topic_id = get_the_ID();

		}

		// Is topic_id in the user's favorites

		if ( !empty( $topic_id ) ) {

			$retval = in_array( $topic_id, $favorites );

		}

	}

	return (bool) apply_filters( 'bbp_is_user_favorite', (bool) $retval, $user_id, $topic_id, $favorites );

}

/**

 * Add a topic to user's favorites

 *

 * @since bbPress (r2652)

 *

 * @param int $user_id Optional. User id

 * @param int $topic_id Optional. Topic id

 * @uses bbp_get_user_favorites_topic_ids() To get the user favorites

 * @uses update_user_option() To update the user favorites

 * @uses do_action() Calls 'bbp_add_user_favorite' with the user id and topic id

 * @return bool Always true

 */

function bbp_add_user_favorite( $user_id = 0, $topic_id = 0 ) {

	if ( empty( $user_id ) || empty( $topic_id ) )

		return false;

	$favorites = (array) bbp_get_user_favorites_topic_ids( $user_id );

	$topic     = bbp_get_topic( $topic_id );

	if ( empty( $topic ) )

		return false;

	if ( !in_array( $topic_id, $favorites ) ) {

		$favorites[] = $topic_id;

		$favorites   = array_filter( $favorites );

		$favorites   = (string) implode( ',', $favorites );

		update_user_option( $user_id, '_bbp_favorites', $favorites );

	}

	do_action( 'bbp_add_user_favorite', $user_id, $topic_id );

	return true;

}

/**

 * Remove a topic from user's favorites

 *

 * @since bbPress (r2652)

 *

 * @param int $user_id Optional. User id

 * @param int $topic_id Optional. Topic id

 * @uses bbp_get_user_favorites_topic_ids() To get the user favorites

 * @uses update_user_option() To update the user favorites

 * @uses delete_user_option() To delete the user favorites meta

 * @uses do_action() Calls 'bbp_remove_user_favorite' with the user & topic id

 * @return bool True if the topic was removed from user's favorites, otherwise

 *               false

 */

function bbp_remove_user_favorite( $user_id, $topic_id ) {

	if ( empty( $user_id ) || empty( $topic_id ) )

		return false;

	$favorites = (array) bbp_get_user_favorites_topic_ids( $user_id );

	if ( empty( $favorites ) )

		return false;

	$pos = array_search( $topic_id, $favorites );

	if ( is_numeric( $pos ) ) {

		array_splice( $favorites, $pos, 1 );

		$favorites = array_filter( $favorites );

		if ( !empty( $favorites ) ) {

			$favorites = implode( ',', $favorites );

			update_user_option( $user_id, '_bbp_favorites', $favorites );

		} else {

			delete_user_option( $user_id, '_bbp_favorites' );

		}

	}

	do_action( 'bbp_remove_user_favorite', $user_id, $topic_id );

	return true;

}

/**

 * Handles the front end adding and removing of favorite topics

 *

 * @uses bbp_get_user_id() To get the user id

 * @uses bbp_verify_nonce_request() To verify the nonce and check the request

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

 * @uses bbPress:errors:add() To log the error messages

 * @uses bbp_is_user_favorite() To check if the topic is in user's favorites

 * @uses bbp_remove_user_favorite() To remove the user favorite

 * @uses bbp_add_user_favorite() To add the user favorite

 * @uses do_action() Calls 'bbp_favorites_handler' with success, user id, topic

 *                    id and action

 * @uses bbp_is_favorites() To check if it's the favorites page

 * @uses bbp_get_favorites_link() To get the favorites page link

 * @uses bbp_get_topic_permalink() To get the topic permalink

 * @uses wp_safe_redirect() To redirect to the url

 */

function bbp_favorites_handler() {

	if ( !bbp_is_favorites_active() )

		return false;

	// Bail if not a GET action

	if ( 'GET' !== strtoupper( $_SERVER['REQUEST_METHOD'] ) )

		return;

	// Bail if required GET actions aren't passed

	if ( empty( $_GET['topic_id'] ) || empty( $_GET['action'] ) )