<?php
/**
 * URL Contains condition.
 *
 * @package BlockSieve
 */

namespace BlockSieve\Conditions\Definitions;

use BlockSieve\Conditions\AbstractCondition;
use BlockSieve\Conditions\Context\Context;

/**
 * Passes when the current URL contains one of the given substrings.
 */
final class UrlContainsCondition extends AbstractCondition {

	/**
	 * Gets the unique condition identifier.
	 *
	 * @return string
	 */
	public function id(): string {
		return 'url-contains';
	}

	/**
	 * Gets the translated human label.
	 *
	 * @return string
	 */
	public function label(): string {
		return __( 'URL Contains', 'blocksieve' );
	}

	/**
	 * Gets the translated description shown in the UI.
	 *
	 * @return string
	 */
	public function description(): string {
		return __( 'The current URL contains a given substring.', 'blocksieve' );
	}

	/**
	 * Gets the category used to group this condition in the UI.
	 *
	 * @return string
	 */
	public function category(): string {
		return 'request';
	}

	/**
	 * Gets the list of supported operator identifiers.
	 *
	 * @return string[]
	 */
	public function operators(): array {
		return array( 'contains', 'not_contains' );
	}

	/**
	 * 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' ),
		);
	}

	/**
	 * Gets the default value for a newly created condition of this type.
	 *
	 * @return mixed
	 */
	public function default_value() {
		return array();
	}

	/**
	 * 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 {
		$needles  = $this->string_list( $value );
		$contains = false;
		// The request URL is percent-encoded; also match a typed "café" or "a b".
		$decoded = rawurldecode( $context->url );

		foreach ( $needles as $needle ) {
			if ( '' !== $needle && ( false !== strpos( $context->url, $needle ) || false !== strpos( $decoded, $needle ) ) ) {
				$contains = true;
				break;
			}
		}

		return 'not_contains' === $operator ? ! $contains : $contains;
	}
}