<?php

/**

 * bbPress Core Theme Compatibility

 *

 * @package bbPress

 * @subpackage ThemeCompatibility

 */

// Exit if accessed directly

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

/** Theme Compat **************************************************************/

/**

 * What follows is an attempt at intercepting the natural page load process

 * to replace the_content() with the appropriate bbPress content.

 *

 * To do this, bbPress does several direct manipulations of global variables

 * and forces them to do what they are not supposed to be doing.

 *

 * Don't try anything you're about to witness here, at home. Ever.

 */

/** Base Class ****************************************************************/

/**

 * Theme Compatibility base class

 *

 * This is only intended to be extended, and is included here as a basic guide

 * for future Theme Packs to use. @link BBP_Twenty_Ten is a good example of

 * extending this class, as is @link bbp_setup_theme_compat()

 *

 * @since bbPress (r3506)

 */

class BBP_Theme_Compat {

	/**

	 * Should be like:

	 *

	 * array(

	 *     'id'      => ID of the theme (should be unique)

	 *     'name'    => Name of the theme (should match style.css)

	 *     'version' => Theme version for cache busting scripts and styling

	 *     'dir'     => Path to theme

	 *     'url'     => URL to theme

	 * );

	 * @var array 

	 */

	private $_data = array();

	/**

	 * Pass the $properties to the object on creation.

	 *

	 * @since bbPress (r3926)

	 * @param array $properties

	 */

    public function __construct( Array $properties = array() ) {

		$this->_data = $properties;

	}

	/**

	 * Set a theme's property.

	 *

	 * @since bbPress (r3926)

	 * @param string $property

	 * @param mixed $value

	 * @return mixed

	 */

	public function __set( $property, $value ) {

		return $this->_data[$property] = $value;

	}

	/**

	 * Get a theme's property.

	 *

	 * @since bbPress (r3926)

	 * @param string $property

	 * @param mixed $value

	 * @return mixed

	 */

	public function __get( $property ) {

		return array_key_exists( $property, $this->_data ) ? $this->_data[$property] : '';

	}

}

/** Functions *****************************************************************/

/**

 * Setup the default theme compat theme

 *

 * @since bbPress (r3311)

 * @param BBP_Theme_Compat $theme

 */

function bbp_setup_theme_compat( $theme = '' ) {

	$bbp = bbpress();

	// Make sure theme package is available, set to default if not

	if ( ! isset( $bbp->theme_compat->packages[$theme] ) || ! is_a( $bbp->theme_compat->packages[$theme], 'BBP_Theme_Compat' ) ) {

		$theme = 'default';

	}

	// Set the active theme compat theme

	$bbp->theme_compat->theme = $bbp->theme_compat->packages[$theme];

}

/**

 * Gets the name of the bbPress compatable theme used, in the event the

 * currently active WordPress theme does not explicitly support bbPress.

 * This can be filtered or set manually. Tricky theme authors can override the

 * default and include their own bbPress compatability layers for their themes.

 *

 * @since bbPress (r3506)

 * @uses apply_filters()

 * @return string

 */

function bbp_get_theme_compat_id() {

	return apply_filters( 'bbp_get_theme_compat_id', bbpress()->theme_compat->theme->id );

}

/**

 * Gets the name of the bbPress compatable theme used, in the event the

 * currently active WordPress theme does not explicitly support bbPress.

 * This can be filtered or set manually. Tricky theme authors can override the

 * default and include their own bbPress compatability layers for their themes.

 *

 * @since bbPress (r3506)

 * @uses apply_filters()

 * @return string

 */

function bbp_get_theme_compat_name() {

	return apply_filters( 'bbp_get_theme_compat_name', bbpress()->theme_compat->theme->name );

}

/**

 * Gets the version of the bbPress compatable theme used, in the event the

 * currently active WordPress theme does not explicitly support bbPress.

 * This can be filtered or set manually. Tricky theme authors can override the

 * default and include their own bbPress compatability layers for their themes.

 *

 * @since bbPress (r3506)

 * @uses apply_filters()

 * @return string

 */

function bbp_get_theme_compat_version() {

	return apply_filters( 'bbp_get_theme_compat_version', bbpress()->theme_compat->theme->version );

}

/**

 * Gets the bbPress compatable theme used in the event the currently active

 * WordPress theme does not explicitly support bbPress. This can be filtered,

 * or set manually. Tricky theme authors can override the default and include

 * their own bbPress compatability layers for their themes.

 *

 * @since bbPress (r3032)

 * @uses apply_filters()

 * @return string

 */

function bbp_get_theme_compat_dir() {

	return apply_filters( 'bbp_get_theme_compat_dir', bbpress()->theme_compat->theme->dir );

}

/**

 * Gets the bbPress compatable theme used in the event the currently active

 * WordPress theme does not explicitly support bbPress. This can be filtered,

 * or set manually. Tricky theme authors can override the default and include

 * their own bbPress compatability layers for their themes.

 *

 * @since bbPress (r3032)

 * @uses apply_filters()

 * @return string

 */

function bbp_get_theme_compat_url() {

	return apply_filters( 'bbp_get_theme_compat_url', bbpress()->theme_compat->theme->url );

}

/**

 * Gets true/false if page is currently inside theme compatibility

 *

 * @since bbPress (r3265)

 * @return bool

 */

function bbp_is_theme_compat_active() {

	$bbp = bbpress();

	if ( empty( $bbp->theme_compat->active ) )

		return false;

	return $bbp->theme_compat->active;

}

/**

 * Sets true/false if page is currently inside theme compatibility

 *

 * @since bbPress (r3265)

 * @param bool $set

 * @return bool

 */

function bbp_set_theme_compat_active( $set = true ) {

	bbpress()->theme_compat->active = $set;

	return (bool) bbpress()->theme_compat->active;

}

/**

 * Set the theme compat templates global

 *

 * Stash possible template files for the current query. Useful if plugins want

 * to override them, or see what files are being scanned for inclusion.

 *

 * @since bbPress (r3311)

 */

function bbp_set_theme_compat_templates( $templates = array() ) {

	bbpress()->theme_compat->templates = $templates;

	return bbpress()->theme_compat->templates;

}

/**

 * Set the theme compat template global

 *

 * Stash the template file for the current query. Useful if plugins want

 * to override it, or see what file is being included.

 *

 * @since bbPress (r3311)

 */

function bbp_set_theme_compat_template( $template = '' ) {

	bbpress()->theme_compat->template = $template;

	return bbpress()->theme_compat->template;

}

/**

 * Set the theme compat original_template global

 *

 * Stash the original template file for the current query. Useful for checking

 * if bbPress was able to find a more appropriate template.

 *

 * @since bbPress (r3926)

 */

function bbp_set_theme_compat_original_template( $template = '' ) {

	bbpress()->theme_compat->original_template = $template;

	return bbpress()->theme_compat->original_template;

}

/**

 * Set the theme compat original_template global

 *

 * Stash the original template file for the current query. Useful for checking

 * if bbPress was able to find a more appropriate template.

 *

 * @since bbPress (r3926)

 */

function bbp_is_theme_compat_original_template( $template = '' ) {

	$bbp = bbpress();

	if ( empty( $bbp->theme_compat->original_template ) )

		return false;

	return (bool) ( $bbp->theme_compat->original_template == $template );

}

/**

 * Register a new bbPress theme package to the active theme packages array

 *

 * @since bbPress (r3829)

 * @param array $theme

 */

function bbp_register_theme_package( $theme = array(), $override = true ) {

	// Create new BBP_Theme_Compat object from the $theme array

	if ( is_array( $theme ) )

		$theme = new BBP_Theme_Compat( $theme );

	// Bail if $theme isn't a proper object

	if ( ! is_a( $theme, 'BBP_Theme_Compat' ) )

		return;

	// Load up bbPress

	$bbp = bbpress();

	// Only override if the flag is set and not previously registered

	if ( empty( $bbp->theme_compat->packages[$theme->id] ) || ( true === $override ) ) {

		$bbp->theme_compat->packages[$theme->id] = $theme;

	}

}

/**

 * This fun little function fills up some WordPress globals with dummy data to

 * stop your average page template from complaining about it missing.

 *

 * @since bbPress (r3108)

 * @global WP_Query $wp_query

 * @global object $post

 * @param array $args

 */

function bbp_theme_compat_reset_post( $args = array() ) {

	global $wp_query, $post;

	// Default arguments

	$defaults = array(

		'ID'                    => -9999,

		'post_status'           => bbp_get_public_status_id(),

		'post_author'           => 0,

		'post_parent'           => 0,

		'post_type'             => 'page',

		'post_date'             => 0,

		'post_date_gmt'         => 0,

		'post_modified'         => 0,

		'post_modified_gmt'     => 0,

		'post_content'          => '',

		'post_title'            => '',

		'post_excerpt'          => '',

		'post_content_filtered' => '',

		'post_mime_type'        => '',

		'post_password'         => '',

		'post_name'             => '',

		'guid'                  => '',

		'menu_order'            => 0,

		'pinged'                => '',

		'to_ping'               => '',

		'ping_status'           => '',

		'comment_status'        => 'closed',

		'comment_count'         => 0,

		'is_404'          => false,

		'is_page'         => false,

		'is_single'       => false,

		'is_archive'      => false,

		'is_tax'          => false,

	);

	// Switch defaults if post is set

	if ( isset( $wp_query->post ) ) {		  

		$defaults = array(

			'ID'                    => $wp_query->post->ID,

			'post_status'           => $wp_query->post->post_status,

			'post_author'           => $wp_query->post->post_author,

			'post_parent'           => $wp_query->post->post_parent,

			'post_type'             => $wp_query->post->post_type,

			'post_date'             => $wp_query->post->post_date,

			'post_date_gmt'         => $wp_query->post->post_date_gmt,

			'post_modified'         => $wp_query->post->post_modified,

			'post_modified_gmt'     => $wp_query->post->post_modified_gmt,

			'post_content'          => $wp_query->post->post_content,

			'post_title'            => $wp_query->post->post_title,

			'post_excerpt'          => $wp_query->post->post_excerpt,

			'post_content_filtered' => $wp_query->post->post_content_filtered,

			'post_mime_type'        => $wp_query->post->post_mime_type,

			'post_password'         => $wp_query->post->post_password,

			'post_name'             => $wp_query->post->post_name,

			'guid'                  => $wp_query->post->guid,

			'menu_order'            => $wp_query->post->menu_order,

			'pinged'                => $wp_query->post->pinged,

			'to_ping'               => $wp_query->post->to_ping,

			'ping_status'           => $wp_query->post->ping_status,

			'comment_status'        => $wp_query->post->comment_status,

			'comment_count'         => $wp_query->post->comment_count,

			'is_404'          => false,

			'is_page'         => false,

			'is_single'       => false,

			'is_archive'      => false,

			'is_tax'          => false,

		);

	}

	$dummy = bbp_parse_args( $args, $defaults, 'theme_compat_reset_post' );

	// Clear out the post related globals

	unset( $wp_query->posts );

	unset( $wp_query->post  );

	unset( $post            );

	// Setup the dummy post object

	$wp_query->post                        = new stdClass; 

	$wp_query->post->ID                    = $dummy['ID'];

	$wp_query->post->post_status           = $dummy['post_status'];

	$wp_query->post->post_author           = $dummy['post_author'];

	$wp_query->post->post_parent           = $dummy['post_parent'];

	$wp_query->post->post_type             = $dummy['post_type'];

	$wp_query->post->post_date             = $dummy['post_date'];

	$wp_query->post->post_date_gmt         = $dummy['post_date_gmt'];

	$wp_query->post->post_modified         = $dummy['post_modified'];

	$wp_query->post->post_modified_gmt     = $dummy['post_modified_gmt'];

	$wp_query->post->post_content          = $dummy['post_content'];

	$wp_query->post->post_title            = $dummy['post_title'];

	$wp_query->post->post_excerpt          = $dummy['post_excerpt'];

	$wp_query->post->post_content_filtered = $dummy['post_content_filtered'];

	$wp_query->post->post_mime_type        = $dummy['post_mime_type'];

	$wp_query->post->post_password         = $dummy['post_password'];

	$wp_query->post->post_name             = $dummy['post_name'];

	$wp_query->post->guid                  = $dummy['guid'];

	$wp_query->post->menu_order            = $dummy['menu_order'];

	$wp_query->post->pinged                = $dummy['pinged'];

	$wp_query->post->to_ping               = $dummy['to_ping'];

	$wp_query->post->ping_status           = $dummy['ping_status'];

	$wp_query->post->comment_status        = $dummy['comment_status'];

	$wp_query->post->comment_count         = $dummy['comment_count'];

	// Set the $post global

	$post = $wp_query->post;

	// Setup the dummy post loop

	$wp_query->posts[0] = $wp_query->post;

	// Prevent comments form from appearing

	$wp_query->post_count = 1;

	$wp_query->is_404     = $dummy['is_404'];

	$wp_query->is_page    = $dummy['is_page'];

	$wp_query->is_single  = $dummy['is_single'];

	$wp_query->is_archive = $dummy['is_archive'];

	$wp_query->is_tax     = $dummy['is_tax'];

	/**

	 * Force the header back to 200 status if not a deliberate 404

	 *

	 * @see http://bbpress.trac.wordpress.org/ticket/1973

	 */

	if ( ! $wp_query->is_404() )

		status_header( 200 );

	// If we are resetting a post, we are in theme compat

	bbp_set_theme_compat_active();

}

/**

 * Reset main query vars and filter 'the_content' to output a bbPress

 * template part as needed.

 *

 * @since bbPress (r3032)

 * @param string $template

 * @uses bbp_is_single_user() To check if page is single user

 * @uses bbp_get_single_user_template() To get user template

 * @uses bbp_is_single_user_edit() To check if page is single user edit

 * @uses bbp_get_single_user_edit_template() To get user edit template