class-enqueue-admin.php

<?php
/**
 * Class file for Admin enqueueing styles and scripts.
 *
 * @package Accessibility_Checker
 */

namespace EDAC\Admin;

use EDAC\Admin\OptIn\Email_Opt_In;
use EqualizeDigital\AccessibilityChecker\Admin\IgnoreUI;

/**
 * Class that initializes and handles enqueueing styles and scripts for the admin.
 */
class Enqueue_Admin {


	/**
	 * Constructor
	 */
	public function __construct() {
	}


	/**
	 * Enqueue the scripts and styles.
	 */
	public static function enqueue() {
		self::enqueue_styles();
		self::maybe_enqueue_admin_and_editor_app_scripts();
		self::maybe_enqueue_sidebar_script();
		self::maybe_enqueue_issue_modal_script();
		self::maybe_enqueue_email_opt_in_script();
	}

	/**
	 * Enqueue the admin styles.
	 *
	 * @return void
	 */
	public static function enqueue_styles() {
		wp_enqueue_style( 'edac', plugin_dir_url( EDAC_PLUGIN_FILE ) . 'build/css/admin.css', [], EDAC_VERSION, 'all' );
	}

	/**
	 * Enqueue the admin and editorApp scripts.
	 *
	 * @return void
	 */
	public static function maybe_enqueue_admin_and_editor_app_scripts() {

		global $pagenow;
		$post_types        = Settings::get_scannable_post_types();
		$has_post_types    = is_array( $post_types ) && count( $post_types );
		$is_scannable_post = Helpers::is_current_post_type_scannable( $post_types );
		$page              = self::get_current_page_slug();
		$enabled_pages     = apply_filters(
			'edac_filter_admin_scripts_slugs',
			[
				'accessibility_checker',
				'accessibility_checker_settings',
				'accessibility_checker_issues',
				'accessibility_checker_ignored',
			]
		);

		if (
			(
				$has_post_types &&
				(
					$is_scannable_post ||
					in_array( $page, $enabled_pages, true )
				)
			) ||
			'site-editor.php' !== $pagenow
		) {

			global $post;
			$post_id = is_object( $post ) ? $post->ID : null;

			// When the "latest posts" homepage is active (show_on_front=posts), the global
			// $post can be set to the first blog post from the main query — for example in
			// the FSE site editor while previewing the home template. Apply a filter so that
			// extensions can supply the correct post ID (e.g. a Pro virtual-page ID) rather
			// than letting the wrong post's ID propagate into scan results.
			$post_id = apply_filters( 'edac_filter_admin_post_id', $post_id );

			wp_enqueue_script( 'edac', plugin_dir_url( EDAC_PLUGIN_FILE ) . 'build/admin.bundle.js', [ 'jquery' ], EDAC_VERSION, false );
			wp_set_script_translations( 'edac', 'accessibility-checker', plugin_dir_path( EDAC_PLUGIN_FILE ) . 'languages' );

			wp_localize_script(
				'edac',
				'edac_script_vars',
				[
					'postID'                   => $post_id,
					'nonce'                    => wp_create_nonce( 'ajax-nonce' ),
					'edacApiUrl'               => esc_url_raw( rest_url() . 'accessibility-checker/v1' ),
					'restNonce'                => wp_create_nonce( 'wp_rest' ),
					'proUrl'                   => esc_url_raw( edac_generate_link_type( [ 'utm_content' => '__name__' ] ) ),
					'hasDismissEndpoint'       => method_exists( \EDAC\Inc\REST_Api::class, 'dismiss_issue' ),
					'showMetaboxInBlockEditor' => ! Helpers::is_block_editor() || (bool) get_option( 'edac_show_metabox_in_block_editor', 1 ),
				]
			);

			if ( 'post.php' === $pagenow || 'post-new.php' === $pagenow ) {

				// Is this posttype setup to be checked?
				$active = $is_scannable_post;

				$pro = defined( 'EDACP_VERSION' ) && EDAC_KEY_VALID;

				if ( EDAC_DEBUG || strpos( EDAC_VERSION, '-beta' ) !== false ) {
					$debug = true; // @codeCoverageIgnore
				} else {
					$debug = false;
				}

				wp_enqueue_script( 'edac-editor-app', plugin_dir_url( EDAC_PLUGIN_FILE ) . 'build/editorApp.bundle.js', false, EDAC_VERSION, false );
				wp_set_script_translations( 'edac-editor-app', 'accessibility-checker', plugin_dir_path( EDAC_PLUGIN_FILE ) . 'languages' );

				// If this is the frontpage or homepage, preview URLs won't work. Use the live URL.
				// When show_on_front=posts and page_for_posts is not set (0), neither WP option
				// will match — allow extensions to flag the current post as the latest-posts
				// homepage so we use get_home_url() for the scan rather than a preview link.
				$is_latest_posts_home = 'posts' === get_option( 'show_on_front' )
					&& 0 === (int) get_option( 'page_for_posts' )
					&& apply_filters( 'edac_filter_post_is_latest_posts_home', false, $post_id );

				if ( $is_latest_posts_home ) {
					$scan_url = add_query_arg( 'edac_pageScanner', 1, trailingslashit( get_home_url() ) );
				} elseif ( (int) get_option( 'page_on_front' ) === $post_id || (int) get_option( 'page_for_posts' ) === $post_id ) {
					$scan_url = add_query_arg( 'edac_pageScanner', 1, get_permalink( $post_id ) );
				} else {
					$post_view_link = apply_filters(
						'edac_get_origin_url_for_virtual_page',
						get_preview_post_link( $post_id ),
						$post_id
					);

					$scan_url = add_query_arg(
						[
							'edac_pageScanner' => 1,
						],
						$post_view_link
					);
				}

				wp_localize_script(
					'edac-editor-app',
					'edac_editor_app',
					[
						'postID'       => $post_id,
						'edacUrl'      => esc_url_raw( get_site_url() ),
						'edacApiUrl'   => esc_url_raw( rest_url() . 'accessibility-checker/v1' ),
						'baseurl'      => plugin_dir_url( __DIR__ ),
						'active'       => $active,
						'pro'          => $pro,
						'debug'        => $debug,
						'scanUrl'      => $scan_url,
						'maxAltLength' => max( 1, absint( apply_filters( 'edac_max_alt_length', 300 ) ) ),
						'version'      => EDAC_VERSION,
						'postStatus'   => get_post_status( $post_id ),
						'restNonce'    => wp_create_nonce( 'wp_rest' ),
					]
				);

			}
		}
	}

	/**
	 * Enqueue the Gutenberg sidebar script.
	 *
	 * @return void
	 */
	public static function maybe_enqueue_sidebar_script() {
		global $pagenow;

		// Only load on post edit screens.
		if ( 'post.php' !== $pagenow && 'post-new.php' !== $pagenow ) {
			return;
		}

		if ( ! Helpers::is_block_editor() ) {
			return;
		}

		// Check if this post type is scannable.
		$post_types = Settings::get_scannable_post_types();
		if ( ! Helpers::is_current_post_type_scannable( $post_types ) ) {
			return;
		}

		// Enqueue the sidebar script with WordPress dependencies.
		wp_enqueue_script(
			'edac-sidebar',
			plugin_dir_url( EDAC_PLUGIN_FILE ) . 'build/sidebar.bundle.js',
			[
				'wp-plugins',
				'wp-edit-post',
				'wp-editor',
				'wp-element',
				'wp-data',
				'wp-i18n',
				'wp-api-fetch',
				'wp-components',
			],
			EDAC_VERSION,
			false
		);

		// Set translations for the sidebar.
		wp_set_script_translations( 'edac-sidebar', 'accessibility-checker', plugin_dir_path( EDAC_PLUGIN_FILE ) . 'languages' );

		// Localize script with necessary data.
		wp_localize_script(
			'edac-sidebar',
			'edac_sidebar_app',
			[
				'gutenbergEnabled'        => true,
				'postID'                  => get_the_ID(),
				'highlightNonce'          => wp_create_nonce( 'edac_highlight' ),
				'ajaxNonce'               => wp_create_nonce( 'ajax-nonce' ),
				'ajaxUrl'                 => admin_url( 'admin-ajax.php' ),
				'edacApiUrl'              => esc_url_raw( rest_url() . 'accessibility-checker/v1' ),
				'settingsUrl'             => esc_url_raw( admin_url( 'admin.php?page=accessibility_checker_settings' ) ),
				'canManageSettings'       => current_user_can( apply_filters( 'edac_filter_settings_capability', 'manage_options' ) ),
				'readabilityHelpUrl'      => esc_url_raw( edac_link_wrapper( 'https://a11ychecker.com/help3265', 'wordpress-general', 'content-analysis-sidebar', false ) ),
				'dismissReasons'          => IgnoreUI::get_reasons(),
				'simplifiedSummaryPrompt' => get_option( 'edac_simplified_summary_prompt', 'none' ),
			]
		);

		// Enqueue sidebar styles.
		wp_enqueue_style(
			'edac-sidebar',
			plugin_dir_url( EDAC_PLUGIN_FILE ) . 'build/css/sidebar.css',
			[],
			EDAC_VERSION,
			'all'
		);

		// Enqueue CodeMirror for HTML syntax highlighting in the issue modal.
		wp_enqueue_code_editor( [ 'type' => 'text/html' ] );
	}

	/**
	 * Enqueue the issue modal bundle (used in sidebar and other admin areas).
	 *
	 * @return void
	 */
	public static function maybe_enqueue_issue_modal_script() {
		global $pagenow;

		// Only load on post edit screens where the sidebar is active.
		if ( 'post.php' !== $pagenow && 'post-new.php' !== $pagenow ) {
			return;
		}

		// Check if this post type is scannable.
		$post_types = Settings::get_scannable_post_types();
		if ( ! Helpers::is_current_post_type_scannable( $post_types ) ) {
			return;
		}

		// Enqueue the issue modal script with WordPress dependencies.
		wp_enqueue_script(
			'edac-issue-modal',
			plugin_dir_url( EDAC_PLUGIN_FILE ) . 'build/issueModal.bundle.js',
			[
				'wp-element',
				'wp-components',
				'wp-i18n',
				'wp-api-fetch',
				'wp-html-entities',
			],
			EDAC_VERSION,
			true
		);

		// Set translations for the issue modal.
		wp_set_script_translations( 'edac-issue-modal', 'accessibility-checker', plugin_dir_path( EDAC_PLUGIN_FILE ) . 'languages' );

		// Enqueue issue modal styles.
		wp_enqueue_style(
			'edac-issue-modal',
			plugin_dir_url( EDAC_PLUGIN_FILE ) . 'build/css/issueModal.css',
			[ 'wp-components' ],
			EDAC_VERSION,
			'all'
		);

		// Enqueue CodeMirror for HTML syntax highlighting.
		wp_enqueue_code_editor( [ 'type' => 'text/html' ] );
	}

	/**
	 * Enqueue the email opt-in script on the welcome page.
	 *
	 * @return void
	 */
	public static function maybe_enqueue_email_opt_in_script() {

		$page = self::get_current_page_slug();
		if ( 'accessibility_checker' !== $page ) {
			return;
		}

		$user_already_opted_in = (bool) get_user_meta( get_current_user_id(), Email_Opt_In::EDAC_USER_OPTIN_META_KEY, true );
		if ( $user_already_opted_in ) {
			return;
		}

		$email_opt_in = new Email_Opt_In();
		$email_opt_in->enqueue_scripts();
	}


	/**
	 * Enqueue the screen reader only format script and styles for the block editor.
	 *
	 * Loads on post edit screens for scannable post types, and also on the
	 * Full Site Editor (site-editor.php) where there is no post type context.
	 *
	 * @return void
	 */
	public static function maybe_enqueue_sr_only_format(): void {
		if ( ! self::should_load_sr_only_format() ) {
			return;
		}

		global $pagenow;
		$is_fse = 'site-editor.php' === $pagenow;

		wp_enqueue_script(
			'edac-sr-only-format',
			plugin_dir_url( EDAC_PLUGIN_FILE ) . 'build/srOnlyFormat.bundle.js',
			[ 'wp-rich-text', 'wp-block-editor', 'wp-element', 'wp-i18n', 'wp-plugins', 'wp-editor', 'wp-api-fetch' ],
			EDAC_VERSION,
			false
		);

		wp_set_script_translations( 'edac-sr-only-format', 'accessibility-checker', plugin_dir_path( EDAC_PLUGIN_FILE ) . 'languages' );

		wp_localize_script(
			'edac-sr-only-format',
			'edacSrOnlyFormat',
			[
				'showSrTextInEditor' => (bool) get_user_meta( get_current_user_id(), 'show_sr_text_in_editor', true ),
				'isFSE'              => $is_fse,
			]
		);
	}

	/**
	 * Inject screen reader only format styles into the block editor iframe.
	 *
	 * @param array $editor_settings Default editor settings.
	 * @return array
	 */
	public static function maybe_inject_sr_only_editor_styles( array $editor_settings ): array {
		if ( ! self::should_load_sr_only_format() ) {
			return $editor_settings;
		}

		$css = self::get_sr_only_editor_styles();
		if ( '' === $css ) {
			return $editor_settings;
		}

		if ( ! isset( $editor_settings['styles'] ) || ! is_array( $editor_settings['styles'] ) ) {
			$editor_settings['styles'] = [];
		}

		if ( get_user_meta( get_current_user_id(), 'show_sr_text_in_editor', true ) ) {
			$body_classes = trim( (string) ( $editor_settings['bodyClassName'] ?? '' ) );
			if ( false === strpos( " {$body_classes} ", ' sr-only-show-always ' ) ) {
				$editor_settings['bodyClassName'] = trim( $body_classes . ' sr-only-show-always' );
			}
		}

		$editor_settings['styles'][] = [
			'css' => $css,
		];

		return $editor_settings;
	}

	/**
	 * Determine whether the screen reader only format assets should load.
	 *
	 * Returns true for the post editor on scannable post types, and also
	 * for the Full Site Editor where there is no post type context.
	 *
	 * @return bool
	 */
	private static function should_load_sr_only_format(): bool {
		global $pagenow;

		$is_post_editor = 'post.php' === $pagenow || 'post-new.php' === $pagenow;
		$is_fse         = 'site-editor.php' === $pagenow;

		if ( ! $is_post_editor && ! $is_fse ) {
			return false;
		}

		if ( ! Helpers::is_block_editor() ) {
			return false;
		}

		// The FSE has no post type context, so always load there.
		if ( $is_fse ) {
			return true;
		}

		$post_types = Settings::get_scannable_post_types();

		return Helpers::is_current_post_type_scannable( $post_types );
	}

	/**
	 * Build the CSS that should be injected into the block editor iframe.
	 *
	 * @return string
	 */
	private static function get_sr_only_editor_styles(): string {
		static $cached_css = null;

		if ( null !== $cached_css ) {
			return $cached_css;
		}

		$css_file = plugin_dir_path( EDAC_PLUGIN_FILE ) . 'build/css/srOnlyFormat.css';
		if ( ! file_exists( $css_file ) || ! is_readable( $css_file ) ) {
			$cached_css = '';
			return $cached_css;
		}

		$css = file_get_contents( $css_file ); // phpcs:ignore WordPressVIPMinimum.Performance.FetchingRemoteData.FileGetContentsUnknown -- Reads a local built CSS asset from the plugin directory.
		if ( false === $css ) {
			$cached_css = '';
			return $cached_css;
		}

		$css .= sprintf(
			'
			.is-selected .text-format-sr-only:hover:after,
			.is-selected .text-format-sr-only:focus:after {
				content: %s;
			}',
			wp_json_encode( __( '* Screen Reader Text', 'accessibility-checker' ) )
		);

		$cached_css = $css;
		return $cached_css;
	}

	/**
	 * Gets the current admin page slug.
	 *
	 * @since 1.31.0
	 * @return string|null The current page slug or null if not set.
	 */
	private static function get_current_page_slug(): ?string {
		return isset( $_GET['page'] ) ? sanitize_key( wp_unslash( $_GET['page'] ) ) : null; // phpcs:ignore WordPress.Security.NonceVerification.Recommended -- display only.
	}
}