<?php
/**
 * Archive / page-view condition.
 *
 * @package BlockSieve
 */

namespace BlockSieve\Conditions\Definitions;

use BlockSieve\Conditions\AbstractCondition;
use BlockSieve\Conditions\Context\Context;

/**
 * Passes when the current view matches one of the chosen page types.
 *
 * Covers the standard WordPress request types: the blog index, the site front
 * page, any archive kind, search results, 404 and single views. The value is a
 * list of page types; a single stored string (the pre-1.1.0 format) is still
 * evaluated as a one-item list.
 */
final class ArchiveCondition extends AbstractCondition {

	/**
	 * Page types offered in the editor, in display order.
	 */
	public const TYPES = array(
		'home',
		'front_page',
		'archive',
		'category',
		'tag',
		'taxonomy',
		'date',
		'author',
		'post_type',
		'search',
		'404',
		'single',
	);

	/**
	 * Legacy alias of 'archive', kept so stored values keep working.
	 */
	private const LEGACY_ANY = 'any';

	/**
	 * Gets the unique condition identifier.
	 *
	 * @return string
	 */
	public function id(): string {
		return 'archive';
	}

	/**
	 * Gets the translated human label.
	 *
	 * @return string
	 */
	public function label(): string {
		return __( 'Page View', 'blocksieve' );
	}

	/**
	 * Gets the translated description shown in the UI.
	 *
	 * @return string
	 */
	public function description(): string {
		return __( 'The current view is one of the selected page types (home, front page, archive, search, 404 or single).', 'blocksieve' );
	}

	/**
	 * Gets the category used to group this condition in the UI.
	 *
	 * @return string
	 */
	public function category(): string {
		return 'content';
	}

	/**
	 * Gets the list of supported operator identifiers.
	 *
	 * @return string[]
	 */
	public function operators(): array {
		return array( 'is', 'is_not' );
	}

	/**
	 * Gets the JSON-schema-like description of the value field for the UI.
	 *
	 * @return array
	 */
	public function value_schema(): array {
		return array(
			'type'  => 'array',
			'items' => array(
				'type' => 'string',
				'enum' => self::TYPES,
			),
		);
	}

	/**
	 * Gets the default value for a newly created condition of this type.
	 *
	 * @return mixed
	 */
	public function default_value() {
		return array();
	}

	/**
	 * Validates a value against this condition's schema.
	 *
	 * Every entry must be a known page type (the legacy alias included).
	 *
	 * @param mixed $value Value to validate.
	 * @return bool
	 */
	public function is_valid_value( $value ): bool {
		$items = is_array( $value ) ? $value : array( $value );

		foreach ( $items as $item ) {
			if ( ! is_string( $item ) || ( self::LEGACY_ANY !== $item && ! in_array( $item, self::TYPES, true ) ) ) {
				return false;
			}
		}

		return true;
	}

	/**
	 * Evaluates the condition against the given context.
	 *
	 * @param Context $context  Request context value object.
	 * @param string  $operator Operator identifier.
	 * @param mixed   $value    Configured value.
	 * @return bool
	 */
	public function evaluate( Context $context, string $operator, $value ): bool {
		$match = false;

		foreach ( $this->string_list( $value ) as $type ) {
			if ( $this->matches( $context, $type ) ) {
				$match = true;
				break;
			}
		}

		return 'is_not' === $operator ? ! $match : $match;
	}

	/**
	 * Resolves whether the current view matches the chosen page type.
	 *
	 * @param Context $context Request context.
	 * @param string  $type    Chosen page type.
	 * @return bool
	 */
	private function matches( Context $context, string $type ): bool {
		switch ( $type ) {
			case 'home':
				return $context->is_home;
			case 'front_page':
				return $context->is_front_page;
			case 'search':
				return $context->is_search;
			case '404':
				return $context->is_404;
			case 'single':
				return $context->is_single;
			case 'archive':
			case self::LEGACY_ANY:
				return $context->is_archive;
			default:
				return $context->is_archive && $context->archive_type === $type;
		}
	}
}