<?php
/**
 * Iranian provinces and cities module.
 *
 * @package Rahkar\WP
 */

declare( strict_types = 1 );

namespace Rahkar\WP\Modules\IranLocations;

use Rahkar\WP\Contracts\HasSettings;
use Rahkar\WP\Modules\BaseModule;
use Rahkar\WP\Admin\Menu;
use Rahkar\WP\Plugin;
use WP_Error;

defined( 'ABSPATH' ) || exit;

/**
 * Province and city fields for WooCommerce addresses.
 *
 * WooCommerce already ships Iranian provinces with three-letter codes — `THR`,
 * `ESF`, and so on — in `i18n/states.php`. Those codes are reused rather than
 * replaced: shipping plugins, exported orders, and every order already in the
 * database key off them, so redefining the set would quietly break all of it.
 * What this module adds is the city layer WooCommerce has no concept of, plus
 * pure-Persian labels in place of WooCommerce's `Tehran (تهران)` transliteration.
 */
final class IranLocationsModule extends BaseModule implements HasSettings {

	public const SLUG = 'iran_locations';

	/**
	 * Every hook this module attaches is a WooCommerce hook.
	 *
	 * @var bool
	 */
	protected bool $requiresWooCommerce = true;

	/**
	 * {@inheritDoc}
	 */
	public function slug(): string {
		return self::SLUG;
	}

	/**
	 * {@inheritDoc}
	 */
	public function name(): string {
		return __( 'استان و شهرهای ایران', 'rahkar-toolkit' );
	}

	/**
	 * {@inheritDoc}
	 */
	public function description(): string {
		return __( 'افزودن لیست کامل استان‌ها و شهرهای ایران به فرم آدرس ووکامرس، سازگار با چک‌اوت کلاسیک و بلاکی.', 'rahkar-toolkit' );
	}

	/**
	 * {@inheritDoc}
	 */
	public function defaults(): array {
		return [
			'persian_state_labels' => true,
			'city_required'        => true,
			'replace_city_field'   => true,
			'custom_cities'        => [],
		];
	}

	/**
	 * {@inheritDoc}
	 */
	public function settingsSchema(): array {
		return [
			'persian_state_labels' => [
				'type'    => 'checkbox',
				'label'   => __( 'نام فارسی استان‌ها', 'rahkar-toolkit' ),
				'help'    => __( 'ووکامرس استان‌ها را به شکل «Tehran (تهران)» نمایش می‌دهد. با این گزینه فقط نام فارسی نشان داده می‌شود. کد استان تغییر نمی‌کند، پس سفارش‌های قبلی و افزونه‌های حمل‌ونقل دست‌نخورده می‌مانند.', 'rahkar-toolkit' ),
				'default' => true,
			],
			'replace_city_field'   => [
				'type'    => 'checkbox',
				'label'   => __( 'تبدیل فیلد شهر به لیست انتخابی', 'rahkar-toolkit' ),
				'help'    => __( 'به‌جای فیلد متنی آزاد، لیست شهرهای استان انتخاب‌شده نمایش داده می‌شود.', 'rahkar-toolkit' ),
				'default' => true,
			],
			'city_required'        => [
				'type'    => 'checkbox',
				'label'   => __( 'شهر اجباری باشد', 'rahkar-toolkit' ),
				'default' => true,
			],
		];
	}

	/**
	 * {@inheritDoc}
	 */
	public function settingsSections(): array {
		return [];
	}

	/**
	 * {@inheritDoc}
	 */
	public function register(): void {
		// Every callback below is a lazy closure. `CheckoutFields` is only
		// constructed once one of these hooks actually fires, so a product page —
		// which fires none of them — never opens the file.
		// `woocommerce_states` fires on ordinary pages too, so it deliberately
		// resolves the small ProvinceLabels class rather than CheckoutFields —
		// otherwise the address-field machinery would load store-wide.
		if ( $this->bootSwitch( 'persian_state_labels' ) ) {
			add_filter(
				'woocommerce_states',
				static fn( array $states ): array => Plugin::make( ProvinceLabels::class )->filter( $states )
			);
		}

		if ( $this->bootSwitch( 'replace_city_field' ) ) {
			add_filter(
				'woocommerce_default_address_fields',
				static fn( array $fields ): array => Plugin::make( CheckoutFields::class )->addressFields( $fields )
			);

			add_filter(
				'woocommerce_checkout_fields',
				static fn( array $fields ): array => Plugin::make( CheckoutFields::class )->seedSavedCity( $fields )
			);

			// `wp_enqueue_scripts` fires on every front-end page, so the page test
			// happens in the closure — which lives in this already-loaded file —
			// rather than inside the handlers. Testing it there would load them
			// store-wide just to be told the page has no address form.
			//
			// The two checkouts are mutually exclusive: the block checkout has no
			// `<select name="billing_city">` for the classic script to find, and
			// the classic one has no React tree for the block script to observe.
			// Loading both would ship dead code to every customer.
			add_action(
				'wp_enqueue_scripts',
				static function (): void {
					if ( ! self::rendersAddressForm() ) {
						return;
					}

					if ( BlockCheckout::isBlockCheckout() ) {
						Plugin::make( BlockCheckout::class )->enqueue();

						return;
					}

					Plugin::make( CheckoutFields::class )->enqueue();
				},
				20
			);
		}

		// The two checkouts submit through entirely different paths, so both need
		// their own server-side check. Whichever one the store uses, the city is
		// verified against the province on the server — the browser's list is a
		// convenience, never the constraint.
		add_action(
			'woocommerce_after_checkout_validation',
			static fn( array $data, WP_Error $errors ) => Plugin::make( CheckoutFields::class )->validate( $data, $errors ),
			10,
			2
		);

		add_action(
			'woocommerce_blocks_validate_location_address_fields',
			static fn( WP_Error $errors, array $fields ) => Plugin::make( BlockCheckout::class )->validate( $errors, $fields ),
			10,
			2
		);

		if ( is_admin() ) {
			// Declared here, with a lazy render callback. The screen class used to
			// hook `admin_menu` itself, which fires on every admin request — so the
			// city browser was opened on all of them to contribute one menu entry.
			add_action(
				'admin_menu',
				static function (): void {
					add_submenu_page(
						Menu::SLUG,
						__( 'شهرهای ایران', 'rahkar-toolkit' ),
						__( 'شهرهای ایران', 'rahkar-toolkit' ),
						Menu::CAPABILITY,
						Menu::SLUG . '-cities',
						static fn() => Plugin::make( CitiesPage::class )->render()
					);
				},
				20
			);
		}
	}

	/**
	 * Does the current page render a WooCommerce address form?
	 *
	 * Checkout and the account area cover the stock cases. A site that renders an
	 * address form somewhere else — a custom page, a popup built in a page builder
	 * — can opt in through the filter rather than losing the city selector.
	 */
	private static function rendersAddressForm(): bool {
		$is_address_page = function_exists( 'is_checkout' )
			&& ( is_checkout() || is_account_page() || is_cart() );

		/**
		 * Filters whether the Iranian city selector loads on this page.
		 *
		 * @param bool $is_address_page Whether an address form is expected here.
		 */
		return (bool) apply_filters( 'rahkar_wp_render_city_selector', $is_address_page );
	}
}