<?php
/**
 * Provides methods for HTML caching for views
 *
 * @since   4.9.11
 *
 * @package Tribe\Events\Views\V2\Views
 */

namespace Tribe\Events\Views\V2\Views\Traits;

use Tribe\Events\Views\V2\View_Interface;
use Tribe__Cache as Cache;
use Tribe__Cache_Listener as Cache_Listener;
use Tribe__Context as Context;
use Tribe__Date_Utils as Dates;
use Tribe__Events__Main as TEC;

/**
 * Trait HTML_Cache
 *
 * @since   5.0.0
 *
 * @package Tribe\Events\Views\V2\Views
 *
 * @property Context $context The current View context.
 */
trait HTML_Cache {
	/**
	 * Return cached HTML if enabled and cache is set.
	 *
	 * @since 5.0.0
	 * @since 6.1.4 Removing nonce injection.
	 *
	 * @return false|string Either the cached HTML contents, or `false` if the View HTML should not be cached or is not
	 *                      cached yet.
	 */
	public function maybe_get_cached_html() {
		if ( ! $this->should_cache_html() ) {
			return false;
		}

		$cache_key   = $this->get_cache_html_key();
		$cached_html = tribe( 'cache' )->get_chunkable_transient( $cache_key, $this->cache_html_triggers() );

		if ( ! $cached_html ) {
			return false;
		}

		return $this->filter_cached_html( $cached_html );
	}

	/**
	 * Filters the cached HTML returned for a specific View.
	 *
	 * @since 4.6.0
	 *
	 * @param string $cached_html Cached HTML for a view.
	 *
	 * @return string The filtered cached HTML.
	 */
	protected function filter_cached_html( $cached_html ) {
		/**
		 * Filters the cached HTML returned for a View.
		 *
		 * @since 4.6.0
		 *
		 * @param string $cached_html  Cached HTML for a view.
		 * @param View_Interface $this This view instance.
		 */
		$cached_html = apply_filters( 'tribe_events_views_v2_view_cached_html', $cached_html, $this );

		$view_slug = static::get_view_slug();

		/**
		 * Filters the cached HTML returned for a View.
		 *
		 * @since 4.6.0
		 *
		 * @param string $cached_html  Cached HTML for a view.
		 * @param View_Interface $this This view instance.
		 */
		$cached_html = apply_filters( "tribe_events_views_v2_view_{$view_slug}_cached_html", $cached_html, $this );

		return $cached_html;
	}

	/**
	 * If caching is enabled, set the cache.
	 *
	 * @since 5.0.0
	 * @since 6.1.4 Removing nonce extraction.
	 *
	 * @param string $html HTML markup for view.
	 *
	 * @return boolean     Whether we successfully cached the View HTML or not.
	 */
	public function maybe_cache_html( $html ) {
		if ( ! $this->should_cache_html() ) {
			return false;
		}

		/**
		 * Filter the cache TTL.
		 *
		 * @since 5.0.0
		 *
		 * @param int        $cache_ttl Cache time to live.
		 * @param Context    $context   The View current context.
		 * @param HTML_Cache $this      The object using the trait.
		 */
		$cache_expiration = apply_filters(
			'tribe_events_views_v2_cache_html_expiration',
			DAY_IN_SECONDS,
			$this->get_context(),
			$this
		);

		$cache_key = $this->get_cache_html_key();

		/** @var Cache $cache */
		$cache = tribe( 'cache' );

		return $cache->set_chunkable_transient( $cache_key, $html, $cache_expiration, $this->cache_html_triggers() );
	}

	/**
	 * Fetch the HTML cache invalidation triggers.
	 *
	 * @since 5.0.0
	 *
	 * @return array A list of the triggers, `Tribe__Cache_Listener` constants, that should be used to set the HTML
	 *               cache invalidation conditions.
	 */
	protected function cache_html_triggers() {
		return [
			Cache_Listener::TRIGGER_SAVE_POST,
			Cache_Listener::TRIGGER_UPDATED_OPTION,
			Cache_Listener::TRIGGER_GENERATE_REWRITE_RULES,
		];
	}

	/**
	 * Determine if HTML of the current view needs to be cached.
	 *
	 * @since 5.0.0
	 *
	 * @return bool Whether the View HTML should be cached or not.
	 */
	public function should_cache_html() {
		if ( defined( 'TRIBE_CACHE_VIEWS' ) && ! TRIBE_CACHE_VIEWS ) {
			return false;
		}

		$context = $this->get_context();

		$cached_views = static::get_cached_views( $this );
		$view_slug = static::get_view_slug();

		$pre_conditions = 0 === $this->get_password_protected_events_count();
		$should_cache   = $pre_conditions
		                  && isset( $cached_views[ $view_slug ] )
		                  && $cached_views[ $view_slug ]
		                  && $this->should_enable_html_cache( $context );

		/**
		 * Should the v2 view HTML be cached?
		 *
		 * @since 5.0.0
		 *
		 * @param bool       $should_cache_html Should the current view have its HTML cached?
		 * @param Context    $context           The View current context.
		 * @param HTML_Cache $this              The object using the trait.
		 */
		return (bool) apply_filters( 'tribe_events_views_v2_should_cache_html', $should_cache, $context, $this );
	}

	public static function get_cached_views( $view = null ) {
		$views = [
			\Tribe\Events\Views\V2\Views\Month_View::get_view_slug() => true,
		];

		/**
		 * Allow specifically changing which views get cache.
		 *
		 * @since 5.5.0
		 *
		 * @param array               $views Should the current view have its HTML cached?
		 * @param View_Interface|null $view  The object using the trait, or null in case of static usage.
		 */
		return (array) apply_filters( 'tribe_events_views_v2_cached_views', $views, $view );
	}

	/**
	 * Determine if HTML of the current view needs to be cached.
	 *
	 * @since 5.0.0
	 *
	 * @return string The cache key that should be used to retrieve the the HTML cache.
	 */
	public function get_cache_html_key() {
		/** @var Context $context */
		$context = $this->get_context();
		$key     = spl_object_hash( $context ) . '_cache_html_key';

		$cache = tribe( 'cache' );

		// Non-persistent caching of the key, per-request.
		$cache_key = $cache->offsetGet( $key );

		if ( empty( $cache_key ) ) {
			$args = $context->to_array();

			unset( $args['now'] );

			$salts     = wp_json_encode( $this->get_cache_html_key_salts() );
			$hash      = substr( sha1( wp_json_encode( $args ) . $salts ), 0, 12 ) . ':';
			$cache_key = 'tribe_views_v2_cache_' . $hash;

			/**
			 * Filter the cached html key for v2 event views
			 *
			 * @since 5.0.0
			 *
			 * @param string             $cache_html_key Cache HTML key.
			 * @param Context            $context        The View current context.
			 * @param array<string,bool> $salts          An array of salts used to generate the cache key.
			 * @param HTML_Cache         $this           The object using the trait.
			 */
			$cache_key = apply_filters( 'tribe_events_views_v2_cache_html_key', $cache_key, $context, $this );

			$cache->offsetSet( $key, $cache_key );
		}

		return $cache_key;
	}

	/**
	 * Indicates if HTML cache should be enabled or not.
	 *
	 * If the HTML cache setting itself is not enabled (or not set) then this
	 * method will always return false.
	 *
	 * In other cases, the default rules are to cache everything in the 2 months past
	 * to 12 months in the future range. This policy can be refined or replaced via
	 * the 'tribe_events_enable_month_view_cache' filter hook.
	 *
	 * @since 5.0.0
	 *
	 * @param Context $context Context object of the request.
	 *
	 * @return bool
	 */
	protected function should_enable_html_cache( $context ) {
		$event_date = $context->get( 'event_date' );

		// Respect the month view caching setting.
		if ( ! tribe_get_option( 'enable_month_view_cache', true ) ) {
			return false;
		}

		// Default to always caching the current month.
		if ( ! $event_date ) {
			return true;
		}

		// In case we got a invalid value for Date time we dont cache.
		if ( $event_date instanceof \DateTimeInterface ) {
			return false;
		}

		// If the eventDate argument is not in the expected format then do not cache.
		if ( ! preg_match( '/^[0-9]{4}-[0-9]{1,2}$/', $event_date ) ) {
			return false;
		}

		// If the requested month is more than 2 months in the past, do not cache.
		if ( $event_date < Dates::build_date_object( '-2 months' )->format( Dates::DBYEARMONTHTIMEFORMAT ) ) {
			return false;
		}

		// If the requested month is more than 1yr in the future, do not cache.
		if ( $event_date > Dates::build_date_object( '+1 year' )->format( Dates::DBYEARMONTHTIMEFORMAT ) ) {
			return false;
		}

		// In all other cases, let's cache it!
		return true;
	}

	/**
	 * Returns the number of private events, `post_status => private`, currently in the database.
	 *
	 * The count is made database-wide to avoid having to fetch the View events (that would defeat the
	 * purpose of caching) or running more complex logic.
	 * The value is cached for a week or until an event is updated.
	 *
	 * @since 5.0.1
	 *
	 * @return int The number of events in the database that have a `post_status` of `private`.
	 */
	protected function get_private_events_count() {
		/** @var \Tribe__Cache $cache */
		$cache     = tribe( 'cache' );
		$cache_key = 'tribe_views_v2_cache_private_events_count';
		$count     = $cache->get(
			$cache_key,
			Cache_Listener::TRIGGER_SAVE_POST,
			false,
			WEEK_IN_SECONDS
		);

		if ( false === $count ) {
			$count = tribe_events()
				->where( 'post_status', 'private' )
				->order( '__none' )
				->found();
			$cache->set( $cache_key, $count, WEEK_IN_SECONDS, Cache_Listener::TRIGGER_SAVE_POST );
		}

		return max( 0, (int) $count );
	}

	/**
	 * Returns the count, an integer, of password-protected events in the database.
	 *
	 * The count is made database-wide to avoid having to fetch the View events (that would defeat the
	 * purpose of caching) or running more complex logic.
	 * The value is cached for a week or until an event is updated.
	 *
	 * @since 5.0.1
	 *
	 * @return int The number of password-protected events in the database.
	 */
	protected function get_password_protected_events_count() {
		/** @var \Tribe__Cache $cache */
		$cache     = tribe( 'cache' );
		$cache_key = 'tribe_views_v2_cache_pwd_protected_events_count';
		$count     = $cache->get(
			$cache_key,
			Cache_Listener::TRIGGER_SAVE_POST,
			false,
			WEEK_IN_SECONDS
		);

		if ( false === $count ) {
			$count = tribe_events()
				->where( 'post_status', 'any' )
				->where( 'has_password', true )
				->order( '__none' )
				->found();
			$cache->set( $cache_key, $count, WEEK_IN_SECONDS, Cache_Listener::TRIGGER_SAVE_POST );
		}

		return max( (int) $count, 0 );
	}

	/**
	 * Returns a list of salts used to generate the HTML cache keys.
	 *
	 * Salts are used to diversify HTML caches depending on the user capabilities or any "wider" context.
	 *
	 * @since 5.0.1
	 *
	 * @return array<string,bool> A list of salts, properties of the wider context, used to generate the HTML cache key.
	 */
	public function get_cache_html_key_salts() {
		$can_read_private_posts = current_user_can( 'read_private_posts', TEC::POSTTYPE );

		$salts = [
			'current_user_can_read_private_events' => $can_read_private_posts,
			'locale'                               => get_locale(),
		];

		return $salts;
	}

	/**
	 * Get the list of fields/input we will do replacement for HTML Cache.
	 *
	 * @since 5.0.0
	 * @since 6.1.4 Deprecating for new nonce structure.
	 *
	 * @deprecated 6.1.4
	 *
	 * @return array   List of fields/input that we are going to replace.
	 */
	protected function get_view_nonce_fields() {
		_deprecated_function( __METHOD__, '6.1.4' );
		$nonces = [
			'wp_rest' => 'tribe-events-views[_wpnonce]',
		];

		/**
		 * Filter to control nonce fields replacement for HTML Cache.
		 *
		 * @since 5.0.0
		 * @since 6.1.4 Changed nonce array structure, flipping key/value.
		 *
		 * @param array      $nonces  List of action and field name where the nonce is stored.
		 * @param Context    $context Context from the current view.
		 * @param HTML_Cache $this    The object using the trait.
		 */
		return apply_filters( 'tribe_events_views_v2_get_view_nonce_fields', $nonces, $this->get_context(), $this );
	}

	/**
	 * Get the list of attributes we will do replacement for HTML Cache.
	 *
	 * @since 5.0.0
	 * @since 6.1.4 Deprecating for new nonce structure.
	 *
	 * @deprecated 6.1.4
	 *
	 * @return array   List of attributes that we are going to replace.
	 */
	protected function get_view_nonce_attributes() {
		_deprecated_function( __METHOD__, '6.1.4' );
		$nonces = [
			'wp_rest' => 'data-view-rest-nonce',
		];


		/**
		 * Filter to control nonce attributes replacement for HTML Cache.
		 *
		 * @since 5.0.0
		 *
		 * @param array      $nonces  List of action and field name where the nonce is stored.
		 * @param Context    $context Context from the current view.
		 * @param HTML_Cache $this    The object using the trait.
		 */
		return apply_filters( 'tribe_events_views_v2_get_view_nonce_attributes', $nonces, $this->get_context(), $this );
	}

	/**
	 * Get the list of JSON properties we will do replacement for HTML Cache.
	 *
	 * @since 5.0.0
	 * @since 6.1.4 Deprecating for new nonce structure.
	 *
	 * @deprecated 6.1.4
	 *
	 * @return array   List of json properties that we are going to replace.
	 */
	protected function get_view_nonce_json_properties() {
		_deprecated_function( __METHOD__, '6.1.4' );
		$nonces = [
			'wp_rest' => 'rest_nonce',
		];

		/**
		 * Filter to control nonce json properties replacement for HTML Cache.
		 *
		 * @since 5.0.0
		 *
		 * @param array      $nonces  List of action and field name where the nonce is stored.
		 * @param Context    $context Context from the current view.
		 * @param HTML_Cache $this    The object using the trait.
		 */
		return apply_filters( 'tribe_events_views_v2_get_view_nonce_json_properties', $nonces, $this->get_context(), $this );
	}

	/**
	 * Does string replacement on the HTML cached based on the possible places we look for cached nonce values to inject
	 * the correct string placeholder so we can remove it later.
	 *
	 * @since 5.0.0
	 * @since 6.1.4 Deprecating for new nonce structure.
	 *
	 * @deprecated 6.1.4
	 *
	 * @param string $html HTML with the nonces to be replaced.
	 *
	 * @return string  HTML after replacement is complete.
	 */
	protected function extract_nonces_before_cache( $html ) {
		_deprecated_function( __METHOD__, '6.1.4' );

		return $html;
	}

	/**
	 * Does string replacement on the HTML cached based on the possible places we look for cached nonce values.
	 *
	 * @since 5.0.0
	 * @since 6.1.4 Deprecating for new nonce structure.
	 *
	 * @deprecated 6.1.4
	 *
	 * @param string $html HTML with the nonces to be replaced.
	 *
	 * @return string  HTML after replacement is complete.
	 */
	protected function inject_nonces_into_cached_html( $html ) {
		_deprecated_function( __METHOD__, '6.1.4' );

		return $html;
	}

	/**
	 * Get a generated nonce required for HTML cache replacement based on an action provided.
	 *
	 * @since 5.0.0
	 * @since 6.1.4 Deprecating for new nonce structure.
	 *
	 * @deprecated 6.1.4
	 *
	 * @param string $action Which action will be used to generate the nonce.
	 *
	 * @return string  Nonce based on action passed.
	 */
	protected function maybe_generate_nonce( $action ) {
		_deprecated_function( __METHOD__, '6.1.4' );
		$generated_nonces = tribe_get_var( __METHOD__, [] );

		if ( ! isset( $generated_nonces[ $action ] ) ) {
			$generated_nonces[ $action ] = wp_create_nonce( $action );
			tribe_set_var( __METHOD__, $generated_nonces );
		}

		return $generated_nonces[ $action ];
	}
}
