class-mailchimp-list-subscribe-form-blocks.php

<?php
/**
 * Class responsible for Mailchimp List Subscribe Form blocks.
 *
 * @package Mailchimp
 */

// Exit if accessed directly.
if ( ! defined( 'ABSPATH' ) ) {
	exit;
}

/**
 * Class Mailchimp_List_Subscribe_Form_Blocks
 *
 * @since 1.7.0
 */
class Mailchimp_List_Subscribe_Form_Blocks {

	/**
	 * Initialize the class.
	 */
	public function init() {
		// In line with conditional register of the widget.
		if ( ! mailchimp_sf_get_api() ) {
			return;
		}

		add_action( 'init', array( $this, 'register_blocks' ) );

		add_action( 'rest_api_init', array( $this, 'register_rest_endpoints' ) );
	}

	/**
	 * Register the block.
	 */
	public function register_blocks() {
		// Get the default visibility of interest groups.
		$interest_groups_visibility = array();
		$interest_groups            = get_option( 'mc_interest_groups', array() );
		if ( ! empty( $interest_groups ) ) {
			foreach ( $interest_groups as $group ) {
				$visible                                    = 'on' === get_option( 'mc_show_interest_groups_' . $group['id'], 'on' ) && 'hidden' !== $group['type'];
				$interest_groups_visibility[ $group['id'] ] = $visible ? 'on' : 'off';
			}
		}

		// Get the default visibility of merge fields.
		$merge_fields_visibility = array();
		$merge_fields            = get_option( 'mc_merge_vars', array() );
		if ( ! empty( $merge_fields ) ) {
			foreach ( $merge_fields as $field ) {
				$visible                                  = 'on' === get_option( 'mc_mv_' . $field['tag'], 'on' ) || $field['required'];
				$merge_fields_visibility[ $field['tag'] ] = $visible ? 'on' : 'off';
			}
		}

		// Register the Mailchimp List Subscribe Form blocks.
		$blocks_dist_path = MCSF_DIR . 'dist/blocks/';

		if ( file_exists( $blocks_dist_path ) ) {
			$block_json_files = glob( $blocks_dist_path . '*/block.json' );
			foreach ( $block_json_files as $filename ) {
				$block_folder = dirname( $filename );
				register_block_type( $block_folder );
			}
		}

		$data = array(
			'admin_settings_url'          => esc_url_raw( admin_url( 'admin.php?page=mailchimp_sf_options' ) ),
			'lists'                       => $this->get_lists(),
			'list_id'                     => get_option( 'mc_list_id', '' ),
			'header_text'                 => get_option( 'mc_header_content', '' ),
			'sub_header_text'             => get_option( 'mc_subheader_content', '' ),
			'submit_text'                 => get_option( 'mc_submit_text', __( 'Subscribe', 'mailchimp' ) ),
			'show_unsubscribe_link'       => get_option( 'mc_use_unsub_link', 'off' ) === 'on',
			'update_existing_subscribers' => (bool) get_option( 'mc_update_existing', true ),
			'double_opt_in'               => (bool) get_option( 'mc_double_optin', true ),
			'merge_fields_visibility'     => $merge_fields_visibility,
			'interest_groups_visibility'  => $interest_groups_visibility,
			'merge_fields'                => $merge_fields,
			'interest_groups'             => $interest_groups,
			'lists_per_page'              => MCSF_LISTS_PER_PAGE,
		);
		$data = 'window.mailchimp_sf_block_data = ' . wp_json_encode( $data );
		wp_add_inline_script( 'mailchimp-mailchimp-editor-script', $data, 'before' );

		// Backwards compatibility. TODO: Remove this in a future version.
		if ( get_option( 'mc_custom_style' ) === 'on' ) {
			$custom_css = mailchimp_sf_custom_style_css();
			wp_add_inline_style( 'mailchimp-mailchimp-editor-style', $custom_css );
		}
	}

	/**
	 * Get Mailchimp lists.
	 *
	 * @return array List of Mailchimp lists.
	 */
	public function get_lists() {
		$lists = get_option( 'mailchimp_sf_lists', array() );
		// If we have lists, return them.
		if ( ! empty( $lists ) ) {
			return $lists;
		}

		// If we don't have any lists, get them from the API.
		$api = mailchimp_sf_get_api();
		if ( ! $api ) {
			return array();
		}

		// Fetch all lists using paginated API requests.
		$all_lists   = array();
		$offset      = 0;
		$total_items = null;
		do {
			$response = $api->get( 'lists', MCSF_LISTS_API_FETCH_LIMIT, array( 'fields' => 'lists.id,lists.name,lists.email_type_option,total_items' ), $offset );
			if ( is_wp_error( $response ) ) {
				return array();
			}
			if ( null === $total_items ) {
				$total_items = $response['total_items'] ?? 0;
			}
			$all_lists = array_merge( $all_lists, $response['lists'] ?? array() );
			$offset   += MCSF_LISTS_API_FETCH_LIMIT;
		} while ( count( $all_lists ) < $total_items );

		$lists = $all_lists;

		// Update the option with the lists.
		update_option( 'mailchimp_sf_lists', $lists );

		return $lists;
	}

	/**
	 * Register REST API endpoints.
	 */
	public function register_rest_endpoints() {
		register_rest_route(
			'mailchimp/v1',
			'/list-data/(?P<list_id>[a-zA-Z0-9]+)/',
			array(
				'methods'             => WP_REST_Server::READABLE,
				'callback'            => array( $this, 'get_list_data' ),
				'args'                => array(
					'list_id' => array(
						'required'          => true,
						'type'              => 'string',
						'sanitize_callback' => 'sanitize_text_field',
						'description'       => esc_html__( 'Mailchimp list ID to get data', 'mailchimp' ),
					),
				),
				'permission_callback' => array( $this, 'get_list_data_permissions_check' ),
			)
		);
	}

	/**
	 * Get list data.
	 *
	 * @param WP_REST_Request $request Request object.
	 * @return WP_REST_Response|WP_Error
	 */
	public function get_list_data( $request ) {
		$list_id = $request->get_param( 'list_id' );

		$fields_key      = 'mailchimp_sf_merge_fields_' . $list_id;
		$merge_fields    = get_option( $fields_key, array() );
		$groups_key      = 'mailchimp_sf_interest_groups_' . $list_id;
		$interest_groups = get_option( $groups_key, array() );

		// If we don't have any merge fields, get them from the API.
		if ( empty( $merge_fields ) ) {
			$api      = mailchimp_sf_get_api();
			$response = $api->get( 'lists/' . $list_id . '/merge-fields', 80 );

			// if we get an error back from the api, return it.
			if ( is_wp_error( $response ) ) {
				return $response;
			}

			$merge_fields = mailchimp_sf_add_email_field( $response['merge_fields'] );
			update_option( $fields_key, $merge_fields );
		}

		// If we don't have any interest groups, get them from the API.
		if ( empty( $interest_groups ) ) {
			$api      = mailchimp_sf_get_api();
			$response = $api->get( 'lists/' . $list_id . '/interest-categories', 60 );

			// if we get an error back from the api, return it.
			if ( is_wp_error( $response ) ) {
				return $response;
			}

			if ( is_array( $response ) ) {
				foreach ( $response['categories'] as $key => $ig ) {
					$groups                                   = $api->get( 'lists/' . $list_id . '/interest-categories/' . $ig['id'] . '/interests', 60 );
					$response['categories'][ $key ]['groups'] = $groups['interests'];
				}
			}

			$interest_groups = $response['categories'];
			update_option( $groups_key, $interest_groups );
		}

		$data = array(
			'merge_fields'    => $merge_fields,
			'interest_groups' => $interest_groups,
		);

		return rest_ensure_response( $data );
	}

	/**
	 * Check permissions for the list data.
	 *
	 * @return bool
	 */
	public function get_list_data_permissions_check() {
		return current_user_can( 'edit_posts' );
	}

	/**
	 * Check if the merge validation should be skipped.
	 *
	 * @param array  $inner_blocks The inner blocks of the block.
	 * @param array  $merge_fields The merge fields.
	 * @param string $template     The template of the block.
	 * @return bool True if the merge validation should be skipped, false otherwise.
	 */
	public function should_skip_merge_validation( $inner_blocks = array(), $merge_fields = array(), $template = 'default' ) {
		if ( 'default' === $template ) {
			return false;
		}

		// Get the tags of the visible inner blocks.
		$visible_inner_blocks = array_map(
			function ( $block ) {
				return $block['attrs']['tag'] ?? '';
			},
			array_filter(
				$inner_blocks,
				function ( $block ) {
					return 'mailchimp/mailchimp-form-field' === $block['blockName'] && isset( $block['attrs']['visible'] ) && $block['attrs']['visible'];
				}
			)
		);

		// Get the tags of the required merge fields.
		$required_merge_fields = array_map(
			function ( $field ) {
				return $field['tag'] ?? '';
			},
			array_filter(
				$merge_fields,
				function ( $field ) {
					return $field['required'];
				}
			)
		);

		$missing_required_fields = array_diff( $required_merge_fields, $visible_inner_blocks );
		if ( ! empty( $missing_required_fields ) ) {
			return true;
		}

		return false;
	}
}