<?php

namespace WordPressdotorg\Forums;

abstract class Directory_Compat {

	abstract protected function compat();
	abstract protected function compat_views();
	abstract protected function compat_title();
	abstract protected function reviews_title();
	abstract protected function active_title();
	abstract protected function unresolved_title();
	abstract protected function slug();
	abstract protected function title();
	abstract protected function status();
	abstract protected function forum_id();
	abstract protected function query_var();
	abstract protected function taxonomy();
	abstract protected function name();
	abstract protected function parse_query();
	abstract protected function for_slug( $slug );
	abstract protected function do_view_sidebar();
	abstract protected function do_topic_sidebar();
	abstract protected function do_view_header();

	var $loaded       = false;
	var $authors      = null;
	var $contributors = null;
	var $support_reps = null;
	var $query        = null;
	var $term         = null;

	public function init() {
		if ( defined( 'WPORG_SUPPORT_FORUMS_BLOGID' ) && get_current_blog_id() == WPORG_SUPPORT_FORUMS_BLOGID ) {
			// Intercept feed requests prior to bbp_request_feed_trap at 10, before Performance::bbp_request_disable_missing_view_feeds at 9
			add_filter( 'bbp_request', array( $this, 'request' ), 5 );

			// Add feed links to head.
			add_action( 'wp_head', array( $this, 'meta_link_to_feeds' ) );

			// Add plugin or theme name to view feed titles.
			add_filter( 'wp_title_rss', array( $this, 'title_correction_for_feed' ) );

			// Define the taxonomy and query vars for this view.
			add_action( 'plugins_loaded', array( $this, 'always_load' ) );

			// We have to add the custom view before bbPress runs its own action
			// on parse_query at priority 2.
			add_action( 'parse_query', array( $this, 'parse_query' ), 0 );

			// And this still needs to happen before priority 2.
			add_action( 'parse_query', array( $this, 'maybe_load' ), 1 );

			// Check to see if an individual topic is compat.
			add_action( 'wp', array( $this, 'check_topic_for_compat' ) );

			// Always check to see if a topic title needs a compat prefix.
			add_filter( 'bbp_get_topic_title', array( $this, 'get_topic_title' ), 9, 2 );

			// Always check to see if a new topic is being posted; this must run
			// before subscriptions go out for `bbp_new_topic` at priority 10.
			add_action( 'bbp_new_topic', array( $this, 'new_topic' ), 9, 4 );

			// Remove new topic form at the bottom of reviews forum.
			add_filter( 'bbp_get_template_part', array( $this, 'noop_reviews_forum_form_topic' ), 10, 3 );

			// Tell WordPress not to 404 (before bbPress overrides it) so that Canonical can do it's job.
			add_filter( 'pre_handle_404', array( $this, 'abort_wp_handle_404' ) );

			// Let plugins know which forum we're in.
			add_filter( 'bbp_get_forum_id', array( $this, 'bbp_get_forum_id' ) );

		}
	}

	/**
	 * Maybe load the data for this compat directory class.
	 *
	 * @param int $topic_id The topic ID that we should initialize in the context of.
	 */
	public function init_for_topic( $topic_id ) {
		$forum_id = bbp_get_topic_forum_id( $topic_id );
		if ( $forum_id != $this->forum_id() ) {
			return;
		}

		$terms = get_the_terms( $topic_id, $this->taxonomy() );
		if ( ! $terms ) {
			return;
		}

		$this->for_slug( $terms[0]->slug );
	}

	/**
	 * Handle view feeds for this compat.
	 */
	public function request( $query_vars ) {
		// Redirect some older URLs to the correct location. This can be
		// removed once nginx rules are in place to handle them.
		$redirects = array(
			// RSS: https://wordpress.org/support/rss/plugin/akismet/
			'rss' => 'rss/' . $this->compat() . '/',
			// Reviews: https://wordpress.org/support/view/plugin-reviews/akismet/
			'reviews' => 'view/' . $this->compat() . '-reviews/',
			// Reviews RSS: https://wordpress.org/support/rss/view/plugin-reviews/akismet/
			'reviews_rss' => 'rss/view/' . $this->compat() . '-reviews/',
		);
		if ( array_key_exists( 'pagename', $query_vars ) ) {
			$pagename = $query_vars['pagename'];

			foreach ( $redirects as $r => $base ) {
				$url = false;
				if ( 0 !== strpos( $pagename, $base ) ) {
					continue;
				}
				$ending = str_replace( $base, '', $pagename );
				$slug = explode( '/', $ending );
				if ( $slug ) {
					switch ( $r ) {
						case 'rss' :
							$url = sprintf( home_url( '/%s/%s/feed/' ),
								$this->compat(),
									sanitize_key( $slug[0] ) );
							break;
						case 'reviews' :
							$url = sprintf( home_url( '/%s/%s/reviews/' ),
								$this->compat(),
								sanitize_key( $slug[0] ) );
							// Append the star filter if included in a reviews URL
							// See https://meta.trac.wordpress.org/ticket/3376
							if ( isset( $_GET['filter'] ) ) {
								$filter = absint( $_GET['filter'] );
								if ( $filter >= 1 && $filter <= 5 ) {
									$url = add_query_arg( array( 'filter' => $filter ), $url );
								}
							}
							break;
						case 'reviews_rss' :
							$url = sprintf( home_url( '/%s/%s/reviews/feed/' ),
								$this->compat(),
								sanitize_key( $slug[0] ) );
					}
					if ( $url ) {
						wp_safe_redirect( esc_url( $url ), 301 );
						exit;
					}
				}
			}
		}

		if ( isset( $query_vars['feed'] ) && isset( $query_vars[ $this->query_var() ] ) ) {

			// Compat views are hooked in a special order, and need help with feed queries.
			if ( isset( $query_vars['bbp_view'] ) && in_array( $query_vars['bbp_view'], $this->compat_views() ) ) {
				$this->query = $query_vars;
				add_filter( 'bbp_get_view_query_args', array( $this, 'get_view_query_args_for_feed' ), 10, 2 );

				// Override bbPress topic pubDate handling to show topic time and not last active time
				add_filter( 'get_post_metadata', array( $this, 'topic_pubdate_correction_for_feed' ), 10, 4 );
			}
		}
		return $query_vars;
	}

	public function topic_pubdate_correction_for_feed( $value, $object_id, $meta_key, $single ) {
		// We only care about _bbp_last_active_time in this particular context
		if ( $meta_key == '_bbp_last_active_time' ) {
			$value = get_post_time( 'Y-m-d H:i:s', true, $object_id );
		}
		return $value;
	}

	/**
	 * Replace 'All Topics' feed title with an appropriate view title
	 * that includes the plugin or theme name.
	 *
	 * @see https://meta.trac.wordpress.org/ticket/2078
	 */
	public function title_correction_for_feed( $title ) {
		if ( empty( $this->query['bbp_view'] ) || empty( $this->query[ $this->query_var() ] ) ) {
			return $title;
		}

		$object = $this->get_object( $this->query[ $this->query_var() ] );
		if ( ! $object ) {
			return $title;
		}

		$this->{$this->compat()} = $object;

		switch ( $this->query['bbp_view'] ) {
			case $this->compat():
				$title = get_bloginfo_rss( 'name' ) . ' &#187; ' . $this->compat_title();
				break;
			case 'reviews':
				$title = get_bloginfo_rss( 'name' ) . ' &#187; ' . $this->reviews_title();
				break;
			case 'active':
				$title = get_bloginfo_rss( 'name' ) . ' &#187; ' . $this->active_title();
				break;
			case 'unresolved':
				$title = get_bloginfo_rss( 'name' ) . ' &#187; ' . $this->unresolved_title();
				break;
		}

		return $title;
	}

	public function get_view_query_args_for_feed( $retval, $view ) {
		switch ( $this->query['bbp_view'] ) {
			// Return new topics from the support forum.
			case $this->compat() :
				return array(
					'post_parent'    => $this->forum_id(),
					'tax_query'      => array( array(
						'taxonomy'   => $this->taxonomy(),
						'field'      => 'slug',
						'terms'      => $this->query[ $this->query_var() ],
					) ),
					'show_stickies'  => false,
					'orderby'        => 'ID',
				);
				break;

			// Return new topics from the reviews forum.
			case 'reviews' :
				return array(
					'post_parent'    => Plugin::REVIEWS_FORUM_ID,
					'tax_query'      => array( array(
						'taxonomy'   => $this->taxonomy(),
						'field'      => 'slug',
						'terms'      => $this->query[ $this->query_var() ],
					) ),
					'show_stickies'  => false,
					'orderby'        => 'ID',
				);
				break;

			// Return active topics from the support forum.
			case 'active' :
				return array(
					'post_parent'    => $this->forum_id(),
					'post_status'    => 'publish',
					'tax_query'      => array( array(
						'taxonomy'   => $this->taxonomy(),
						'field'      => 'slug',
						'terms'      => $this->query[ $this->query_var() ],
					) ),
					'show_stickies'  => false,
				);
				break;

			// Return unresolved topics from the support forum.
			case 'unresolved' :
				return array(
					'post_parent'    => $this->forum_id(),
					'post_status'    => 'publish',
					'tax_query'      => array( array(
						'taxonomy'   => $this->taxonomy(),
						'field'      => 'slug',
						'terms'      => $this->query[ $this->query_var() ],
					) ),
					'meta_key'      => 'topic_resolved',
					'meta_type'     => 'CHAR',
					'meta_value'    => 'no',
					'meta_compare'  => '=',
					'show_stickies'  => false,
					'orderby'        => 'ID',
				);
				break;
		}
		return $retval;
	}

	public function always_load() {
		// Add filters necessary for determining which compat file to use.
		add_action( 'bbp_init',                 array( $this, 'register_taxonomy' ) );
		add_filter( 'query_vars',               array( $this, 'add_query_var' ) );
		add_action( 'bbp_add_rewrite_rules',    array( $this, 'add_rewrite_rules' ) );
		add_filter( 'term_link',                array( $this, 'get_term_link' ), 10, 3 );
		add_filter( 'get_' . $this->taxonomy(), array( $this, 'get_term' ) );
	}

	/**
	 * At this point, compat, slug, and object should be loaded.
	 */
	public function maybe_load() {
		if ( false !== $this->slug() && false == $this->loaded ) {
			// This must run before bbPress's parse_query at priority 2.
			$this->register_views();

			// Set the term for this view so we can reuse it.
			$this->initialize_term();

			// Add plugin- and theme-specific filters and actions.
			add_action( 'wporg_compat_view_sidebar',       array( $this, 'do_view_sidebar' ) );
			add_action( 'wporg_compat_view_sidebar',       array( $this, 'do_subscription_link' ), 11 );
			add_action( 'wporg_compat_before_single_view', array( $this, 'do_view_header' ) );

			// Add output filters and actions.
			add_filter( 'bbp_get_view_link', array( $this, 'get_view_link' ), 10, 2 );
			add_filter( 'bbp_breadcrumbs',   array( $this, 'breadcrumbs' ) );

			// Handle new topic form at the bottom of support view.
			add_action( 'wporg_compat_after_single_view',      array( $this, 'add_topic_form' ) );
			add_action( 'bbp_theme_before_topic_form_content', array( $this, 'add_topic_form_content' ) );
			add_filter( 'bbp_current_user_can_access_create_topic_form', array( $this, 'current_user_can_access_create_topic_form' ) );

			// Instantiate WPORG_Ratings compat mode for reviews.
			if ( class_exists( 'WPORG_Ratings' ) && class_exists( 'WordPressdotorg\Forums\Ratings_Compat' ) ) {
				$this->ratings = new Ratings_Compat( array(
					'compat'   => $this->compat(),
					'slug'     => $this->slug(),
					'taxonomy' => $this->taxonomy(),
					'object'   => $this->get_object( $this->slug() ),
				) );
			}

			// Instantiate WPORG_Stickies mode for support view.
			if ( class_exists( 'WordPressdotorg\Forums\Stickies_Compat' ) ) {
				$this->stickies = new Stickies_Compat( array(
					'compat'   => $this->compat(),
					'slug'     => $this->slug(),
					'taxonomy' => $this->taxonomy(),
					'object'   => $this->get_object( $this->slug() ),
					'term'     => $this->term,
				) );
			}

			$this->loaded = true;
		}
	}

	/**
	 * Initialises the WP_Term for the compat view.
	 *
	 * If the term does not exist, it will be created.
	 */
	public function initialize_term() {
		if ( ! $this->slug() ) {
			return;
		}

		$this->term = get_term_by( 'slug', $this->slug(), $this->taxonomy() );

		if ( $this->term || ! $this->get_object( $this->slug() ) ) {
			return;
		}

		$term_name = $this->slug();
		if ( ! sanitize_title( $term_name ) ) {
			// This happens when the slug is all non-ascii such as %e5%8f%8b%e8%a8%80, which fails to insert.
			$term_name = urldecode( $term_name );
		}

		$term = wp_insert_term( $term_name, $this->taxonomy(), array( 'slug' => $this->slug() ) );

		// Term exists already? Race-condition, or get_term_by() couldn't find $slug..
		if ( is_wp_error( $term ) && $term->get_error_data( 'term_exists' ) ) {
			$this->term = get_term( $term->get_error_data( 'term_exists' ) );
		} elseif ( ! is_wp_error( $term ) && isset( $term['term_id'] ) ) {
			$this->term = get_term( $term['term_id'] );
		}
	}

	/**
	 * Outputs `link` tags in the page head for the support and reviews feeds.
	 */
	public function meta_link_to_feeds() {
		if ( ! $this->slug() ) {
			return;
		}

		echo "\n";

		$title_support_feed = 'theme' === $this->compat()
			? __( 'Theme Support Feed', 'wporg-forums' )
			: __( 'Plugin Support Feed', 'wporg-forums' );
		printf(
			'<link rel="alternate" type="application/rss+xml" title="%s" href="%s" />' . "\n",
			esc_attr( $title_support_feed ),
			esc_url( home_url( sprintf( '/%s/%s/feed/', $this->compat(), $this->slug() ) ) )
		);

		$title_reviews_feed = 'theme' === $this->compat()
			? __( 'Theme Reviews Feed', 'wporg-forums' )
			: __( 'Plugin Reviews Feed', 'wporg-forums' );
		printf(
			'<link rel="alternate" type="application/rss+xml" title="%s" href="%s" />' . "\n",
			esc_attr( $title_reviews_feed ),
			esc_url( home_url( sprintf( '/%s/%s/reviews/feed/', $this->compat(), $this->slug() ) ) )
		);
	}

	public function check_topic_for_compat() {
		if ( ( bbp_is_single_topic() || bbp_is_topic_edit() ) && false == $this->loaded ) {
			$terms = get_the_terms( bbp_get_topic_id(), $this->taxonomy() );
			if ( ! empty( $terms ) && ! is_wp_error( $terms ) ) {
				$slug = $terms[0]->slug;

				// Basic setup.
				$this->slug              = $slug;
				$this->{$this->compat()} = $this->get_object( $slug );
				$this->authors           = $this->get_authors( $slug );
				$this->contributors      = $this->get_contributors( $slug );
				$this->support_reps      = $this->get_support_reps( $slug );
				$this->term              = $terms[0];

				// Add output filters and actions.
				add_action( 'wporg_compat_single_topic_sidebar_pre', array( $this, 'do_topic_sidebar' ) );

				// Handle topic resolution permissions.
				add_filter( 'wporg_bbp_user_can_resolve', array( $this, 'user_can_resolve' ), 10, 3 );

				// Instantiate WPORG_Ratings compat mode for reviews.
				if ( class_exists( 'WPORG_Ratings' ) && class_exists( 'WordPressdotorg\Forums\Ratings_Compat' ) ) {
					$this->ratings = new Ratings_Compat( array(
						'compat'   => $this->compat(),
						'slug'     => $this->slug(),
						'taxonomy' => $this->taxonomy(),
						'object'   => $this->get_object( $this->slug() ),
					) );
				}

				// Instantiate WPORG_Stickies mode for topic view.
				if ( class_exists( 'WordPressdotorg\Forums\Stickies_Compat' ) ) {
					$this->stickies = new Stickies_Compat( array(
						'compat'       => $this->compat(),
						'slug'         => $this->slug(),
						'taxonomy'     => $this->taxonomy(),
						'object'       => $this->get_object( $this->slug() ),
						'term'         => $this->term,
						'authors'      => $this->authors,
						'contributors' => $this->contributors,
						'support_reps' => $this->support_reps,
					) );
				}

				$this->loaded = true;
			}
		}
	}

	/**
	 * Allow plugin/theme authors, contributors, and support reps to resolve a topic
	 * on their support forum.
	 *
	 * @param bool $retval If the user can set a topic resolution for the topic
	 * @param int $user_id The user id
	 * @param int $topic_id The topic id
	 * @return bool True if the user can set the topic resolution, otherwise false
	 */
	public function user_can_resolve( $retval, $user_id, $topic_id ) {
		$user = get_userdata( $user_id );
		if ( ! $user ) {
			return $retval;
		}
		if (
			( ! empty( $this->authors ) && in_array( $user->user_nicename, $this->authors ) )
		||
			( ! empty( $this->contributors ) && in_array( $user->user_nicename, $this->contributors ) )
		||
			( ! empty( $this->support_reps ) && in_array( $user->user_nicename, $this->support_reps ) )
		||
			// Back-compat for support reps added before https://meta.trac.wordpress.org/changeset/5867,
			// can be removed once they are re-added via the Plugin Directory UI.
			( is_a( $user, 'WP_User' ) && $user->supportrep == $this->slug() )
		) {
			$retval = true;
		}
		return $retval;
	}

	public function get_topic_title( $title, $topic_id ) {
		if (
			( bbp_is_single_forum() && in_array( bbp_get_forum_id(), array( $this->forum_id(), Plugin::REVIEWS_FORUM_ID ) ) )
		||
			( bbp_is_single_view() && ! in_array( bbp_get_view_id(), $this->compat_views() ) )
		||
			( bbp_is_single_user_topics() || bbp_is_single_user_replies() )
		||
			get_query_var( 'wporg_single_user_reviews' )
		||
			get_query_var( 'wporg_single_user_topics_replied_to' )
		||
			is_tax( 'topic-tag' )
		) {
			$terms = get_the_terms( $topic_id, $this->taxonomy() );
			if ( ! empty( $terms ) && ! is_wp_error( $terms ) ) {
				$term = $terms[0];
				$object = $this->get_object( $term->slug );
				if ( $object ) {
					$title = sprintf( "[%s] %s", esc_html( $object->post_title ), esc_html( $title ) );
				}
			}
		}
		return $title;
	}

	public function add_rewrite_rules() {
		$priority          = 'top';

		$root_id           = $this->compat();
		$root_var          = $this->query_var();
		$review_id         = 'reviews';
		$active_id         = 'active';
		$unresolved_id     = 'unresolved';

		$support_rule      = $this->compat() . '/([^/]+)/';
		$reviews_rule      = $this->compat() . '/([^/]+)/' . $review_id . '/';
		$active_rule       = $this->compat() . '/([^/]+)/' . $active_id . '/';
		$unresolved_rule   = $this->compat() . '/([^/]+)/' . $unresolved_id . '/';

		$feed_id    = 'feed';
		$view_id    = bbp_get_view_rewrite_id();
		$paged_id   = bbp_get_paged_rewrite_id();

		$feed_slug  = 'feed';
		$paged_slug = bbp_get_paged_slug();

		$base_rule  = '?$';
		$feed_rule  = $feed_slug  . '/?$';
		$paged_rule = $paged_slug . '/?([0-9]{1,})/?$';

		// Add base rule, so that /support/$compat_slug/ doesn't redirect to a random topic.
		add_rewrite_rule( $this->compat() . '/?$',  'index.php?' . $view_id . '=' . $review_id . '&' . $root_var . '=_redirect_', $priority );

		// Add reviews view rewrite rules.
		add_rewrite_rule( $reviews_rule . $base_rule,  'index.php?' . $view_id . '=' . $review_id . '&' . $root_var . '=$matches[1]',                               $priority );
		add_rewrite_rule( $reviews_rule . $paged_rule, 'index.php?' . $view_id . '=' . $review_id . '&' . $root_var . '=$matches[1]&' . $paged_id . '=$matches[2]', $priority );
		add_rewrite_rule( $reviews_rule . $feed_rule,  'index.php?' . $view_id . '=' . $review_id . '&' . $root_var . '=$matches[1]&' . $feed_id  . '=$matches[2]', $priority );

		// Add support view rewrite rules.
		add_rewrite_rule( $support_rule . $base_rule,  'index.php?' . $view_id . '=' . $root_id . '&' . $root_var . '=$matches[1]',                               $priority );
		add_rewrite_rule( $support_rule . $paged_rule, 'index.php?' . $view_id . '=' . $root_id . '&' . $root_var . '=$matches[1]&' . $paged_id . '=$matches[2]', $priority );
		add_rewrite_rule( $support_rule . $feed_rule,  'index.php?' . $view_id . '=' . $root_id . '&' . $root_var . '=$matches[1]&' . $feed_id  . '=$matches[2]', $priority );

		// Add active view rewrite rules.
		add_rewrite_rule( $active_rule . $base_rule,  'index.php?' . $view_id . '=' . $active_id . '&' . $root_var . '=$matches[1]',                               $priority );
		add_rewrite_rule( $active_rule . $paged_rule, 'index.php?' . $view_id . '=' . $active_id . '&' . $root_var . '=$matches[1]&' . $paged_id . '=$matches[2]', $priority );
		add_rewrite_rule( $active_rule . $feed_rule,  'index.php?' . $view_id . '=' . $active_id . '&' . $root_var . '=$matches[1]&' . $feed_id  . '=$matches[2]', $priority );

		// Add unresolved view rewrite rules.
		add_rewrite_rule( $unresolved_rule . $base_rule,  'index.php?' . $view_id . '=' . $unresolved_id . '&' . $root_var . '=$matches[1]',                               $priority );
		add_rewrite_rule( $unresolved_rule . $paged_rule, 'index.php?' . $view_id . '=' . $unresolved_id . '&' . $root_var . '=$matches[1]&' . $paged_id . '=$matches[2]', $priority );
		add_rewrite_rule( $unresolved_rule . $feed_rule,  'index.php?' . $view_id . '=' . $unresolved_id . '&' . $root_var . '=$matches[1]&' . $feed_id  . '=$matches[2]', $priority );
	}

	public function add_query_var( $query_vars ) {
		$query_vars[] = $this->query_var();
		return $query_vars;
	}

	public function register_taxonomy() {
		if ( post_type_exists( 'topic' ) ) {
			register_taxonomy( $this->taxonomy(), 'topic', array( 'public' => false, 'show_ui' => true, 'labels' => array ('name' => $this->name() ) ) );
		}
	}

	public function register_views() {

		// Add support view.
		bbp_register_view(
			$this->compat(),
			$this->compat_title(),
			array(
				'post_parent'   => $this->forum_id(),
				'tax_query'     => array( array(
					'taxonomy'  => $this->taxonomy(),
					'field'     => 'slug',
					'terms'     => $this->slug(),
				) ),
				'show_stickies' => true,
				'meta_key'      => null,
				'meta_compare'  => null,
				'orderby'       => 'ID',
			)
		);

		// Add reviews view.
		bbp_register_view(
			'reviews',
			$this->reviews_title(),
			array(
				'post_parent'   => Plugin::REVIEWS_FORUM_ID,
				'tax_query'     => array( array(
					'taxonomy'  => $this->taxonomy(),
					'field'     => 'slug',
					'terms'     => $this->slug(),
				) ),
				'show_stickies' => false,
				'meta_key'      => null,
				'meta_compare'  => null,
				'orderby'       => 'ID',
			)
		);

		// Add recent activity view.
		bbp_register_view(
			'active',
			$this->active_title(),
			array(
				'post_parent'   => $this->forum_id(),
				'post_status'   => 'publish',
				'tax_query'     => array( array(
					'taxonomy'  => $this->taxonomy(),
					'field'     => 'slug',
					'terms'     => $this->slug(),
				) ),
				'show_stickies' => false,
			)
		);

		// Add unresolved topics view.
		bbp_register_view(
			'unresolved',
			$this->unresolved_title(),
			array(
				'post_parent'   => $this->forum_id(),
				'post_status'   => 'publish',
				'tax_query'     => array( array(
					'taxonomy'  => $this->taxonomy(),
					'field'     => 'slug',
					'terms'     => $this->slug(),
				) ),
				'meta_key'      => 'topic_resolved',
				'meta_type'     => 'CHAR',
				'meta_value'    => 'no',
				'meta_compare'  => '=',
				'orderby'       => 'ID',
				'show_stickies' => false,
			)
		);
	}

	/**
	 * Filter view links to provide prettier links for these subforum views.
	 */
	public function get_view_link( $url, $view ) {
		global $wp_rewrite;

		$view = bbp_get_view_id( $view );
		if ( ! in_array( $view, $this->compat_views() ) ) {
			return $url;
		}

		// Pretty permalinks.
		if ( $wp_rewrite->using_permalinks() ) {
			switch ( $view ) {
				case 'reviews' :
				case 'active' :
				case 'unresolved' :
					$url = $wp_rewrite->root . $this->compat() . '/' . $this->slug() . '/' . $view;
					break;

				default :
					$url = $wp_rewrite->root . $this->compat() . '/' . $this->slug();
			}
			$url = home_url( user_trailingslashit( $url ) );

		// Unpretty permalinks.
		} else {
			$url = add_query_arg( array(
				bbp_get_view_rewrite_id() => $view,
				$this->query_var()        => $this->slug(),
			) );
		}

		return $url;
	}

	/**
	 * Filter the breadcrumbs for directory views so we can specify the plugin
	 * or theme in the breadcrumbs.
	 */
	public function breadcrumbs( $r ) {
		if ( ! bbp_is_single_view() ) {
			return $r;
		}

		$view = bbp_get_view_id();
		if ( ! in_array( $view, $this->compat_views() ) ) {
			return $r;
		}

		// Prefix link to plugin/theme support or review forum with context.
		if ( 'plugin' === $this->compat() ) {
			/* translators: %s: link to plugin support or review forum */
			$compat_breadcrumb = str_replace( ' ', '&nbsp;', __( 'Plugin: %s', 'wporg-forums' ) );
		} else {
			/* translators: %s: link to theme support or review forum */
			$compat_breadcrumb = str_replace( ' ', '&nbsp;', __( 'Theme: %s', 'wporg-forums' ) );
		}

		$r[1] = sprintf( $compat_breadcrumb, esc_html( $this->title() ) );

		if ( in_array( $view, array( 'reviews', 'active', 'unresolved' ) ) ) {
			$r[1] = sprintf( $compat_breadcrumb, sprintf(
				'<a href="%s" class="bbp-breadcrumb-forum">%s</a>',
				esc_url( bbp_get_view_url( $this->compat() ) ),
				esc_html( $this->title() )
			) );
			if ( 'reviews' == $view ) {
				$r[2] = __( 'Reviews', 'wporg-forums' );
			} elseif ( 'active' == $view ) {
				$r[2] = __( 'Active Topics', 'wporg-forums' );
			} else {
				$r[2] = __( 'Unresolved Topics', 'wporg-forums' );
			}
		}
		return $r;
	}

	/**
	 * Add the new topic form at the bottom of appropriate views; the reviews view
	 * form addition is handled by Ratings_Compat.
	 */
	public function add_topic_form() {
		if ( ! bbp_is_single_view() ) {
			return;
		}

		$view = bbp_get_view_id();
		if ( ! in_array( $view, array( $this->compat() ) ) ) {
			return;
		}

		bbp_get_template_part( 'form', 'topic' );
	}

	public function add_topic_form_content() {
		if ( ! bbp_is_single_view() ) {
			return;
		}

		$view = bbp_get_view_id();
		if ( ! in_array( $view, array( $this->compat(), 'reviews' ) ) ) {
			return;
		}

		if ( 'reviews' == $view ) {
			$forum_id = Plugin::REVIEWS_FORUM_ID;
		} else {
			$forum_id = $this->forum_id();
		}
		?>
		<input type="hidden" name="bbp_forum_id" id="bbp_forum_id" value="<?php echo esc_attr( $forum_id ); ?>" />
		<input type="hidden" name="wporg_compat" id="wporg_compat" value="<?php echo esc_attr( $this->compat() ); ?>" />
		<input type="hidden" name="wporg_compat_slug" id="wporg_compat_slug" value="<?php echo esc_attr( $this->slug() ); ?>" />
		<?php
	}

	public function current_user_can_access_create_topic_form( $retval ) {
		if ( bbp_is_single_view() && in_array( bbp_get_view_id(), array( $this->compat(), 'reviews' ) ) ) {
			$retval = bbp_current_user_can_publish_topics();
		}

		if ( bbp_is_single_view() && 'reviews' === bbp_get_view_id() ) {
			if ( 'plugin' === $this->compat() && 'publish' !== $this->status() ) {
				$retval = false;
			}
		}

		return $retval;
	}

	/**
	 * Filter the template fetch to avoid displaying a new topic form in the reviews forum.
	 *
	 * @param array $templates The templates to load
	 * @param string $slug The template slug
	 * @param string $name The template name
	 * @return array|false The templates, or false if nooped
	 */
	public function noop_reviews_forum_form_topic( $templates, $slug, $name ) {
		if (
			'form' == $slug && 'topic' == $name
		&&
			bbp_is_single_forum() && Plugin::REVIEWS_FORUM_ID == bbp_get_forum_id()
		) {
			return false;
		}
		return $templates;
	}

	/**
	 * Filter WP::handle_404() to not run on compat views, so as to allow Canonical to properly handle the request.
	 */
	public function abort_wp_handle_404( $handled ) {
		if ( $this->slug() ) {
			// We've matched a term, so WordPress shouldn't 404 this request.
			$handled = true;
		}

		return $handled;
	}

	/**
	 * These compat routes are views, but showing a singular forum.
	 * This makes other plugins understand that the compat view is a forum.
	 *
	 * @param int $forum_id The detected forum id.
	 * @return int The actual forum id.
	 */
	public function bbp_get_forum_id( $forum_id ) {
		if ( ! $forum_id && bbp_is_single_view() ) {
			if ( $this->compat() === bbp_get_view_id() ) {
				$forum_id = $this->forum_id();
			} elseif ( 'reviews' == bbp_get_view_id() ) {
				$forum_id = Plugin::REVIEWS_FORUM_ID;
			}
		}

		return $forum_id;
	}

	/**
	 * Add a subscribe/unsubscribe link to the compat views.
	 */
	public function do_subscription_link() {
		if ( ! class_exists( 'WordPressdotorg\Forums\Term_Subscription\Plugin' ) ) {
			return;
		}

		if ( ! is_user_logged_in() ) {
			return;
		}

		if ( ! bbp_is_single_view() || bbp_get_view_id() != $this->compat() ) {
			return;
		}

		$term_subscription = '';
		if ( $this->term ) {
			$subscribe = $unsubscribe = '';
			if ( 'plugin' == $this->compat() ) {
				$subscribe   = esc_html__( 'Subscribe to this plugin', 'wporg-forums' );
				$unsubscribe = esc_html__( 'Unsubscribe from this plugin', 'wporg-forums' );
				$js_confirm  = esc_html__( 'Are you sure you wish to subscribe by email to all future topics created in this plugin forum?', 'wporg-forums' );
			} else {
				$subscribe   = esc_html__( 'Subscribe to this theme', 'wporg-forums' );
				$unsubscribe = esc_html__( 'Unsubscribe from this theme', 'wporg-forums' );
				$js_confirm  = esc_html__( 'Are you sure you wish to subscribe by email to all future topics created in this theme forum?', 'wporg-forums' );
			}
			$term_subscription = Term_Subscription\Plugin::get_subscription_link( array(
				'term_id'     => $this->term->term_id,
				'taxonomy'    => $this->taxonomy(),
				'subscribe'   => $subscribe,
				'unsubscribe' => $unsubscribe,
				'js_confirm'  => $js_confirm,
			) );
		}

		if ( $term_subscription ) {
			echo $term_subscription;
		}
	}

	/**
	 * Correct the link to the compat terms.
	 *
	 * @param string $term_link The term link
	 * @param object $term      The term object
	 * @param string $taxonomy  The taxonomy object
	 * @return string The term link, or the support view link
	 */
	public function get_term_link( $term_link, $term, $taxonomy ) {
		// Only do this for the non-public compat taxonomies.
		if ( $this->taxonomy() != $taxonomy ) {
			return $term_link;
		}

		$paged = '';
		if ( get_query_var( 'paged' ) > 1 ) {
			$paged = 'page/' . absint( get_query_var( 'paged' ) ) . '/';
		}

		return sprintf(
			home_url( '/%s/%s/%s' ),
			$this->compat(),
			$term->slug,
			$paged
		);
	}

	/**
	 * Set the term name for the compat terms to that of the directory.
	 * 
	 * @param \WP_Term $term 
	 * @return \WP_Term
	 */
	public function get_term( $term ) {
		// Note: Not using $this->title() here so as to filter other terms of this taxonomy correctly.

		if ( ! is_admin() ) {
			$term->name = $this->get_object( $term->slug )->post_title ?? $term->name;
		}

		return $term;
	}

	/**
	 * Set the compat taxonomy on a topic if that data is provided on new post.
	 *
	 * @param int $topic_id The topic id
	 * @param int $forum_id The forum id
	 * @param int|array $anonymous_data 0 or anonymous author data
	 * @param int $topic_author The topic author id
	 */
	public function new_topic( $topic_id, $forum_id, $anonymous_data, $topic_author ) {
		if (
			( isset( $_POST['wporg_compat'] ) && $_POST['wporg_compat'] == $this->compat() )
		&&
			( isset( $_POST['wporg_compat_slug'] ) && $_POST['wporg_compat_slug'] == $this->slug() )
		) {
			// Check against the canonical plugin/theme records for slug existence.
			$object = $this->get_object( $_POST['wporg_compat_slug'] );

			if ( ! empty( $object ) ) {
				wp_set_object_terms( $topic_id, $this->slug(), $this->taxonomy(), false );
			}
		}
	}

	/**
	 * Set up and cache the plugin or theme details.
	 *
	 * @param string $slug The object slug
	 */
	public function get_object( $slug ) {
		global $wpdb;

		if (
			'theme' == $this->compat() &&
			! is_null( $this->theme ) &&
			( ! $slug || $slug === $this->theme->post_name )
		) {
			return $this->theme;

		} elseif (
			'plugin' == $this->compat() &&
			! is_null( $this->plugin ) &&
			( ! $slug || $slug === $this->plugin->post_name )
		) {
			return $this->plugin;
		}

		return self::get_object_by_slug_and_type( $slug, $this->compat() );
	}

	/**
	 * Get and cache object based on slug and type (plugin or theme).
	 *
	 * Suitable for use outside of the class.
	 *
	 * @param string $slug The object slug.
	 * @param string $type The type of the object. Either 'plugin' or 'theme'.
	 * @return array
	 */
	public static function get_object_by_slug_and_type( $slug, $type ) {
		global $wpdb;

		// Check the cache.
		$cache_key = $slug;
		$cache_group = $type . '-objects';
		$compat_object = wp_cache_get( $cache_key, $cache_group );
		if ( false === $compat_object ) {

			// Get the object information from the correct table.
			if ( $type == 'theme' ) {
				$compat_object = $wpdb->get_row( $wpdb->prepare( "SELECT * FROM {$wpdb->base_prefix}%d_posts WHERE post_name = %s AND post_type = 'repopackage' LIMIT 1", WPORG_THEME_DIRECTORY_BLOGID, $slug ) );
			} elseif ( $type == 'plugin' ) {
				$compat_object = $wpdb->get_row( $wpdb->prepare( "SELECT * FROM {$wpdb->base_prefix}%d_posts WHERE post_name = %s AND post_type = 'plugin' LIMIT 1", WPORG_PLUGIN_DIRECTORY_BLOGID, $slug ) );
			}

			wp_cache_set( $cache_key, $compat_object, $cache_group, HOUR_IN_SECONDS );
		}
		return $compat_object;
	}

	public function get_authors( $slug ) {
		global $wpdb;

		if ( null !== $this->authors ) {
			return $this->authors;
		}

		// Check the cache.
		$cache_key   = $slug;
		$cache_group = $this->compat() . '-authors-slugs';
		$authors     = wp_cache_get( $cache_key, $cache_group );
		if ( $authors === false ) {
			$authors = array();
			if ( $this->compat() == 'theme' ) {
				$theme = $this->get_object( $slug );
				if ( $theme ) {
					$author = get_user_by( 'id', $theme->post_author );
					if ( $author ) {
						$authors = array( $author->user_nicename );
					}
				}
			} else {
				$plugin = $this->get_object( $slug );
				if ( $plugin ) {
					$prefix = $wpdb->base_prefix . WPORG_PLUGIN_DIRECTORY_BLOGID . '_';
					// Note: Intentionally not considering posts of 'plugin' post_type with
					// 'post_author' matching this author because the field only relates to
					// the user who submitted the plugin. It does not confer special access,
					// rights, or ownership.
					$authors = $wpdb->get_col( $wpdb->prepare(
						"SELECT slug
						 FROM {$prefix}terms AS t
						 LEFT JOIN {$prefix}term_taxonomy AS tt ON tt.term_id = t.term_id
						 LEFT JOIN {$prefix}term_relationships AS tr ON tr.term_taxonomy_id = tt.term_taxonomy_id
						 WHERE tt.taxonomy = 'plugin_committers' AND tr.object_id = %d",
						 $plugin->ID
					) );
				}
			}

			wp_cache_set( $cache_key, $authors, $cache_group, HOUR_IN_SECONDS );
		}
		return $authors;
	}

	public function get_contributors( $slug ) {
		global $wpdb;

		if ( null !== $this->contributors ) {
			return $this->contributors;
		}

		// Themes do not have contributors right now.
		if ( $this->compat() == 'theme' ) {
			$contributors = array();
			return $contributors;
		}

		// Check the cache.
		$cache_key    = $slug;
		$cache_group  = $this->compat() . '-contributors-slugs';
		$contributors = wp_cache_get( $cache_key, $cache_group );
		if ( $contributors === false ) {
			$contributors = array();
			$plugin       = $this->get_object( $slug );

			if ( $plugin ) {
				$prefix       = $wpdb->base_prefix . WPORG_PLUGIN_DIRECTORY_BLOGID . '_';
				$contributors = $wpdb->get_col( $wpdb->prepare(
					"SELECT slug
					 FROM {$prefix}terms AS t
					 LEFT JOIN {$prefix}term_taxonomy AS tt ON tt.term_id = t.term_id
					 LEFT JOIN {$prefix}term_relationships AS tr ON tr.term_taxonomy_id = tt.term_taxonomy_id
					 WHERE tt.taxonomy = 'plugin_contributors' AND tr.object_id = %d",
					 $plugin->ID
				) );
			}

			wp_cache_set( $cache_key, $contributors, $cache_group, HOUR_IN_SECONDS );
		}

		return $contributors;
	}

	public function get_support_reps( $slug ) {
		global $wpdb;

		if ( null !== $this->support_reps ) {
			return $this->support_reps;
		}

		// Themes do not have support reps right now.
		if ( $this->compat() == 'theme' ) {
			$support_reps = array();
			return $support_reps;
		}

		// Check the cache.
		$cache_key    = $slug;
		$cache_group  = $this->compat() . '-support-reps-slugs';
		$support_reps = wp_cache_get( $cache_key, $cache_group );
		if ( $support_reps === false ) {
			$support_reps = array();
			$plugin       = $this->get_object( $slug );

			if ( $plugin ) {
				$prefix       = $wpdb->base_prefix . WPORG_PLUGIN_DIRECTORY_BLOGID . '_';
				$support_reps = $wpdb->get_col( $wpdb->prepare(
					"SELECT slug
					 FROM {$prefix}terms AS t
					 LEFT JOIN {$prefix}term_taxonomy AS tt ON tt.term_id = t.term_id
					 LEFT JOIN {$prefix}term_relationships AS tr ON tr.term_taxonomy_id = tt.term_taxonomy_id
					 WHERE tt.taxonomy = 'plugin_support_reps' AND tr.object_id = %d",
					 $plugin->ID
				) );
			}

			wp_cache_set( $cache_key, $support_reps, $cache_group, HOUR_IN_SECONDS );
		}

		return $support_reps;
	}

	/**
	 * Get the plugin or theme object slugs for a given user.
	 *
	 * @param int $user_id The user id.
	 * @return array
	 */
	public function get_user_object_slugs( $user_id ) {
		global $wpdb;

		// Check the cache.
		$cache_key   = $user_id;
		$cache_group = $this->compat() . '-user-object-slugs';
		$slugs       = wp_cache_get( $cache_key, $cache_group );
		if ( $slugs !== false ) {
			return $slugs;
		}
		$slugs = [];

		// Themes.
		if ( 'theme' == $this->compat() ) {
			$slugs = $wpdb->get_col( $wpdb->prepare(
				"SELECT post_name
					FROM %i
					WHERE post_type = 'repopackage' AND post_author = %d",
				$wpdb->base_prefix . WPORG_THEME_DIRECTORY_BLOGID . '_posts',
				$user_id
			) );
		}

		// Plugins
		if ( 'plugin' == $this->compat() ) {
			$slugs = $wpdb->get_col( $wpdb->prepare(
				"SELECT DISTINCT p.post_name
					FROM %i AS t
						LEFT JOIN %i AS tt ON tt.term_id = t.term_id
						LEFT JOIN %i AS tr ON tr.term_taxonomy_id = tt.term_taxonomy_id
						LEFT JOIN %i AS p ON tr.object_id = p.ID
					WHERE tt.taxonomy IN( 'plugin_contributors', 'plugin_support_reps', 'plugin_committers' ) AND t.name = %s",
					$wpdb->base_prefix . WPORG_PLUGIN_DIRECTORY_BLOGID . '_terms',
					$wpdb->base_prefix . WPORG_PLUGIN_DIRECTORY_BLOGID . '_term_taxonomy',
					$wpdb->base_prefix . WPORG_PLUGIN_DIRECTORY_BLOGID . '_term_relationships',
					$wpdb->base_prefix . WPORG_PLUGIN_DIRECTORY_BLOGID . '_posts',
					get_user_by( 'id', $user_id )->user_nicename
			) );
		}

		wp_cache_set( $cache_key, $slugs, $cache_group, HOUR_IN_SECONDS );

		return $slugs;
	}
}