<?php
/**
 * The explanation catalogue.
 *
 * Keyed by axe-core rule id, this is the same file the public scanner at
 * tools.saifbrand.com/accessibility uses. Keeping one source of truth is why a
 * result reads identically wherever it is shown.
 *
 * @package AccessVane
 */

if ( ! defined( 'ABSPATH' ) ) {
	exit;
}

/**
 * Loads and serves the issue explanations and manual checklist.
 */
class AccessVane_Catalog {

	/**
	 * Cached catalogue.
	 *
	 * @var array|null
	 */
	private static $issues = null;

	/**
	 * Cached manual checks.
	 *
	 * @var array|null
	 */
	private static $manual = null;

	/**
	 * Every issue explanation, keyed by axe rule id.
	 *
	 * @return array
	 */
	public static function issues() {
		if ( null === self::$issues ) {
			$data = self::read( 'issue-catalog.json' );
			unset( $data['$comment'] );
			self::$issues = $data;
		}

		return self::$issues;
	}

	/**
	 * The explanation for one rule.
	 *
	 * @param string $rule_id axe rule id.
	 * @return array|null
	 */
	public static function issue( $rule_id ) {
		$issues = self::issues();

		return isset( $issues[ $rule_id ] ) ? $issues[ $rule_id ] : null;
	}

	/**
	 * The manual checks automation cannot perform.
	 *
	 * @return array
	 */
	public static function manual_checks() {
		if ( null === self::$manual ) {
			$data         = self::read( 'manual-checks.json' );
			self::$manual = isset( $data['checks'] ) && is_array( $data['checks'] ) ? $data['checks'] : array();
		}

		return self::$manual;
	}

	/**
	 * Rule ids this plugin can repair without a human decision.
	 *
	 * @return array
	 */
	public static function auto_fixable_rules() {
		$fixable = array();

		foreach ( self::issues() as $rule_id => $issue ) {
			if ( ! empty( $issue['autoFixable'] ) ) {
				$fixable[] = $rule_id;
			}
		}

		return $fixable;
	}

	/**
	 * Read and decode a bundled JSON data file.
	 *
	 * @param string $filename File inside /data.
	 * @return array
	 */
	private static function read( $filename ) {
		$path = ACCESSVANE_DIR . 'data/' . $filename;

		if ( ! file_exists( $path ) || ! is_readable( $path ) ) {
			return array();
		}

		// Bundled, read-only plugin data — not remote content, and never written
		// to at runtime.
		$raw = file_get_contents( $path ); // phpcs:ignore WordPress.WP.AlternativeFunctions.file_get_contents_file_get_contents

		if ( false === $raw ) {
			return array();
		}

		$decoded = json_decode( $raw, true );

		return is_array( $decoded ) ? $decoded : array();
	}
}