<?php

/**

 * bbPress Template Functions

 *

 * This file contains functions necessary to mirror the WordPress core template

 * loading process. Many of those functions are not filterable, and even then

 * would not be robust enough to predict where bbPress templates might exist.

 *

 * @package bbPress

 * @subpackage TemplateFunctions

 */

// Exit if accessed directly

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

/**

 * Adds bbPress theme support to any active WordPress theme

 *

 * @since bbPress (r3032)

 *

 * @param string $slug

 * @param string $name Optional. Default null

 * @uses bbp_locate_template()

 * @uses load_template()

 * @uses get_template_part()

 */

function bbp_get_template_part( $slug, $name = null ) {

	// Execute code for this part

	do_action( 'get_template_part_' . $slug, $slug, $name );

	// Setup possible parts

	$templates = array();

	if ( isset( $name ) )

		$templates[] = $slug . '-' . $name . '.php';

	$templates[] = $slug . '.php';

	// Allow template parst to be filtered

	$templates = apply_filters( 'bbp_get_template_part', $templates, $slug, $name );

	// Return the part that is found

	return bbp_locate_template( $templates, true, false );

}

/**

 * Retrieve the name of the highest priority template file that exists.

 *

 * Searches in the child theme before parent theme so that themes which

 * inherit from a parent theme can just overload one file. If the template is

 * not found in either of those, it looks in the theme-compat folder last.

 *

 * @since bbPres (r3618)

 *

 * @param string|array $template_names Template file(s) to search for, in order.

 * @param bool $load If true the template file will be loaded if it is found.

 * @param bool $require_once Whether to require_once or require. Default true.

 *                            Has no effect if $load is false.

 * @return string The template filename if one is located.

 */

function bbp_locate_template( $template_names, $load = false, $require_once = true ) {

	// No file found yet

	$located            = false;

	$template_locations = bbp_get_template_stack();

	// Try to find a template file

	foreach ( (array) $template_names as $template_name ) {

		// Continue if template is empty

		if ( empty( $template_name ) )

			continue;

		// Trim off any slashes from the template name

		$template_name  = ltrim( $template_name, '/' );

		// Loop through template stack

		foreach ( (array) $template_locations as $template_location ) {

			// Continue if $template_location is empty

			if ( empty( $template_location ) )

				continue;

			// Check child theme first

			if ( file_exists( trailingslashit( $template_location ) . $template_name ) ) {

				$located = trailingslashit( $template_location ) . $template_name;

				break 2;

			}

		}

	}

	// Maybe load the template if one was located

	if ( ( true == $load ) && !empty( $located ) )

		load_template( $located, $require_once );

	return $located;

}

/**

 * This is really cool. This function registers a new template stack location,

 * using WordPress's built in filters API.

 *

 * This allows for templates to live in places beyond just the parent/child

 * relationship, to allow for custom template locations. Used in conjunction

 * with bbp_locate_template(), this allows for easy template overrides.

 *

 * @since bbPress (r4323)

 *

 * @param string $location Callback function that returns the 

 * @param int $priority

 */

function bbp_register_template_stack( $location_callback = '', $priority = 10 ) {

	// Bail if no location, or function does not exist

	if ( empty( $location_callback ) || ! function_exists( $location_callback ) )

		return false;

	// Add location callback to template stack

	add_filter( 'bbp_template_stack', $location_callback, (int) $priority );

}

/**

 * Call the functions added to the 'bbp_template_stack' filter hook, and return

 * an array of the template locations.

 *

 * @see bbp_register_template_stack()

 *

 * @since bbPress (r4323)

 *

 * @global array $wp_filter Stores all of the filters

 * @global array $merged_filters Merges the filter hooks using this function.

 * @global array $wp_current_filter stores the list of current filters with the current one last

 *

 * @return array The filtered value after all hooked functions are applied to it.

 */

function bbp_get_template_stack() {

	global $wp_filter, $merged_filters, $wp_current_filter;

	// Setup some default variables

	$tag  = 'bbp_template_stack';

	$args = $stack = array();

	// Add 'bbp_template_stack' to the current filter array

	$wp_current_filter[] = $tag;

	// Sort

	if ( ! isset( $merged_filters[ $tag ] ) ) {

		ksort( $wp_filter[$tag] );

		$merged_filters[ $tag ] = true;

	}

	// Ensure we're always at the beginning of the filter array

	reset( $wp_filter[ $tag ] );

	// Loop through 'bbp_template_stack' filters, and call callback functions

	do {

		foreach( (array) current( $wp_filter[$tag] ) as $the_ ) {

			if ( ! is_null( $the_['function'] ) ) {

				$args[1] = $stack;

				$stack[] = call_user_func_array( $the_['function'], array_slice( $args, 1, (int) $the_['accepted_args'] ) );

			}

		}

	} while ( next( $wp_filter[$tag] ) !== false );

	// Remove 'bbp_template_stack' from the current filter array

	array_pop( $wp_current_filter );

	// Remove empties and duplicates

	$stack = array_unique( array_filter( $stack ) );

	return (array) apply_filters( 'bbp_get_template_stack', $stack ) ;

}

/**

 * Retrieve path to a template

 *

 * Used to quickly retrieve the path of a template without including the file

 * extension. It will also check the parent theme and theme-compat theme with

 * the use of {@link bbp_locate_template()}. Allows for more generic template

 * locations without the use of the other get_*_template() functions.

 *

 * @since bbPress (r3629)

 *

 * @param string $type Filename without extension.

 * @param array $templates An optional list of template candidates

 * @uses bbp_set_theme_compat_templates()

 * @uses bbp_locate_template()

 * @uses bbp_set_theme_compat_template()

 * @return string Full path to file.

 */

function bbp_get_query_template( $type, $templates = array() ) {

	$type = preg_replace( '|[^a-z0-9-]+|', '', $type );

	if ( empty( $templates ) )

		$templates = array( "{$type}.php" );

	// Filter possible templates, try to match one, and set any bbPress theme

	// compat properties so they can be cross-checked later.

	$templates = apply_filters( "bbp_get_{$type}_template", $templates );

	$templates = bbp_set_theme_compat_templates( $templates );

	$template  = bbp_locate_template( $templates );

	$template  = bbp_set_theme_compat_template( $template );

	return apply_filters( "bbp_{$type}_template", $template );

}

/**

 * Get the possible subdirectories to check for templates in

 *

 * @since bbPress (r3738)

 * @param array $templates Templates we are looking for

 * @return array Possible subfolders to look in

 */

function bbp_get_template_locations( $templates = array() ) {

	$locations = array(

		'bbpress',

		'forums',

		''

	);

	return apply_filters( 'bbp_get_template_locations', $locations, $templates );

}

/**

 * Add template locations to template files being searched for

 *

 * @since bbPress (r3738)

 *

 * @param array $templates

 * @return array() 

 */

function bbp_add_template_locations( $templates = array() ) {

	$retval = array();

	// Get alternate locations

	$locations = bbp_get_template_locations( $templates );

	// Loop through locations and templates and combine

	foreach ( (array) $locations as $location )

		foreach ( (array) $templates as $template )

			$retval[] = ltrim( trailingslashit( $location ) . $template, '/' );

	return apply_filters( 'bbp_add_template_locations', array_unique( $retval ), $templates );

}

/**

 * Add checks for bbPress conditions to parse_query action

 *

 * If it's a user page, WP_Query::bbp_is_single_user is set to true.

 * If it's a user edit page, WP_Query::bbp_is_single_user_edit is set to true

 * and the the 'wp-admin/includes/user.php' file is included.

 * In addition, on user/user edit pages, WP_Query::home is set to false & query

 * vars 'bbp_user_id' with the displayed user id and 'author_name' with the

 * displayed user's nicename are added.

 *

 * If it's a forum edit, WP_Query::bbp_is_forum_edit is set to true

 * If it's a topic edit, WP_Query::bbp_is_topic_edit is set to true

 * If it's a reply edit, WP_Query::bbp_is_reply_edit is set to true.

 *

 * If it's a view page, WP_Query::bbp_is_view is set to true

 *

 * @since bbPress (r2688)

 *

 * @param WP_Query $posts_query

 *

 * @uses get_query_var() To get {@link WP_Query} query var

 * @uses is_email() To check if the string is an email

 * @uses get_user_by() To try to get the user by email and nicename

 * @uses get_userdata() to get the user data

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

 * @uses is_user_member_of_blog() To check if user profile page exists

 * @uses WP_Query::set_404() To set a 404 status

 * @uses apply_filters() Calls 'enable_edit_any_user_configuration' with true

 * @uses bbp_get_view_query_args() To get the view query args

 * @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 remove_action() To remove the auto save post revision action

 */

function bbp_parse_query( $posts_query ) {

	// Bail if $posts_query is not the main loop

	if ( ! $posts_query->is_main_query() )

		return;

	// Bail if filters are suppressed on this query

	if ( true == $posts_query->get( 'suppress_filters' ) )

		return;

	// Bail if in admin

	if ( is_admin() )

		return;

	// Get query variables

	$bbp_view = $posts_query->get( bbp_get_view_rewrite_id() );

	$bbp_user = $posts_query->get( bbp_get_user_rewrite_id() );

	$is_edit  = $posts_query->get( bbp_get_edit_rewrite_id() );

	// It is a user page - We'll also check if it is user edit

	if ( !empty( $bbp_user ) ) {

		// Not a user_id so try email and slug

		if ( !is_numeric( $bbp_user ) ) {

			// Email was passed

			if ( is_email( $bbp_user ) ) {

				$bbp_user = get_user_by( 'email', $bbp_user );

			// Try nicename

			} else {

				$bbp_user = get_user_by( 'slug', $bbp_user );

			}

			// If we were successful, set to ID

			if ( is_object( $bbp_user ) ) {

				$bbp_user = $bbp_user->ID;

			}

		}

		// Cast as int, just in case

		$bbp_user = (int) $bbp_user;

		// 404 and bail if user does not have a profile

		if ( ! bbp_user_has_profile( $bbp_user ) ) {

			$posts_query->set_404();

			return;

		}

		/** User Exists *******************************************************/

		$is_favs    = $posts_query->get( bbp_get_user_favorites_rewrite_id()     );

		$is_subs    = $posts_query->get( bbp_get_user_subscriptions_rewrite_id() );

		$is_topics  = $posts_query->get( bbp_get_user_topics_rewrite_id()        );

		$is_replies = $posts_query->get( bbp_get_user_replies_rewrite_id()       );

		// View or edit?

		if ( !empty( $is_edit ) ) {

			// We are editing a profile

			$posts_query->bbp_is_single_user_edit = true;

			// Load the core WordPress contact methods

			if ( !function_exists( '_wp_get_user_contactmethods' ) ) {

				include_once( ABSPATH . 'wp-includes/registration.php' );

			}

			// Load the edit_user functions

			if ( !function_exists( 'edit_user' ) ) {

				require_once( ABSPATH . 'wp-admin/includes/user.php' );

			}

			// Load the grant/revoke super admin functions

			if ( is_multisite() && !function_exists( 'revoke_super_admin' ) ) {

				require_once( ABSPATH . 'wp-admin/includes/ms.php' );

			}

			// Editing a user

			$posts_query->bbp_is_edit = true;

		// User favorites

		} elseif ( ! empty( $is_favs ) ) {

			$posts_query->bbp_is_single_user_favs = true;

		// User subscriptions

		} elseif ( ! empty( $is_subs ) ) {

			$posts_query->bbp_is_single_user_subs = true;

		// User topics

		} elseif ( ! empty( $is_topics ) ) {

			$posts_query->bbp_is_single_user_topics = true;

		// User topics

		} elseif ( ! empty( $is_replies ) ) {

			$posts_query->bbp_is_single_user_replies = true;

		// User profile

		} else {

			$posts_query->bbp_is_single_user_profile = true;

		}

		// Looking at a single user

		$posts_query->bbp_is_single_user = true;

		// Make sure 404 is not set

		$posts_query->is_404  = false;

		// Correct is_home variable

		$posts_query->is_home = false;

		// Get the user data

		$user = get_userdata( $bbp_user );

		// User is looking at their own profile

		if ( get_current_user_id() == $user->ID ) {

			$posts_query->bbp_is_single_user_home = true;

		}

		// Set bbp_user_id for future reference

		$posts_query->set( 'bbp_user_id', $user->ID );

		// Set author_name as current user's nicename to get correct posts

		$posts_query->set( 'author_name', $user->user_nicename );

		// Set the displayed user global to this user

		bbpress()->displayed_user = $user;

	// View Page

	} elseif ( !empty( $bbp_view ) ) {

		// Check if the view exists by checking if there are query args are set

		$view_args = bbp_get_view_query_args( $bbp_view );

		// Bail if view args is false (view isn't registered)

		if ( false === $view_args ) {

			$posts_query->set_404();

			return;

		}

		// Correct is_home variable

		$posts_query->is_home     = false;

		// We are in a custom topic view

		$posts_query->bbp_is_view = true;

	// Forum/Topic/Reply Edit Page

	} elseif ( !empty( $is_edit ) ) {

		// Get the post type from the main query loop

		$post_type = $posts_query->get( 'post_type' );

		// Check which post_type we are editing, if any

		if ( !empty( $post_type ) ) {

			switch( $post_type ) {

				// We are editing a forum

				case bbp_get_forum_post_type() :

					$posts_query->bbp_is_forum_edit = true;

					$posts_query->bbp_is_edit       = true;

					break;

				// We are editing a topic

				case bbp_get_topic_post_type() :

					$posts_query->bbp_is_topic_edit = true;

					$posts_query->bbp_is_edit       = true;

					break;