Support CloudFlare IP geolocation

[bhubbard]

What problem does this address?

I would like to add the option to show or hide based on CloudFlare geolocation for country code and datacenter headers.

[bhubbard]

I had AI write it as a plugin, seems to work, with love for you to bring into the plugin.

<?php
/**
 * Plugin Name: Cloudflare Geotargeting for Block Visibility
 * Description: Adds Cloudflare geotargeting conditions (using HTTP_CF_IPCOUNTRY) to the Block Visibility plugin.
 * Version:     1.0.0
 * Author:      Community
 * License:     GPL-2.0-or-later
 * Text Domain: cloudflare-geotargeting
 */

defined( 'ABSPATH' ) || exit;

class Cloudflare_Geotargeting_Block_Visibility {

	/**
	 * Constructor.
	 */
	public function __construct() {
		add_action( 'plugins_loaded', array( $this, 'init' ) );
	}

	/**
	 * Initialize the plugin after all plugins are loaded.
	 */
	public function init() {
		// Only run if Block Visibility plugin is active.
		if ( ! class_exists( 'Block_Visibility' ) ) {
			return;
		}

		add_action( 'enqueue_block_editor_assets', array( $this, 'enqueue_editor_assets' ) );
		add_filter( 'block_visibility_settings', array( $this, 'register_settings' ) );
		add_filter( 'block_visibility_settings_defaults', array( $this, 'register_settings_defaults' ) );
		add_filter( 'block_visibility_control_set_is_block_visible', array( $this, 'evaluate_visibility' ), 15, 3 );
	}

	/**
	 * Enqueue JavaScript in Gutenberg block editor.
	 */
	public function enqueue_editor_assets() {
		wp_enqueue_script(
			'cloudflare-geotargeting-editor',
			plugins_url( 'assets/js/editor.js', __FILE__ ),
			array(
				'wp-blocks',
				'wp-element',
				'wp-components',
				'wp-hooks',
				'wp-data',
				'lodash',
			),
			'1.0.0',
			true
		);
	}

	/**
	 * Integrate our custom control into Block Visibility settings.
	 */
	public function register_settings( $settings ) {
		if ( ! is_array( $settings ) ) {
			return $settings;
		}

		$settings['visibility_controls']['properties']['cloudflare_geotargeting'] = array(
			'type'       => 'object',
			'properties' => array(
				'enable' => array(
					'type' => 'boolean',
				),
			),
		);

		return $settings;
	}

	/**
	 * Register default settings for our custom control.
	 */
	public function register_settings_defaults( $defaults ) {
		if ( ! is_array( $defaults ) ) {
			return $defaults;
		}

		$defaults['visibility_controls']['cloudflare_geotargeting'] = array(
			'enable' => true,
		);

		return $defaults;
	}

	/**
	 * Evaluate block visibility based on Cloudflare geotargeting settings.
	 *
	 * @param bool  $is_visible Current visibility state.
	 * @param array $settings   Core plugin settings.
	 * @param array $controls   Active control attributes on the block.
	 * @return bool Updated visibility state.
	 */
	public function evaluate_visibility( $is_visible, $settings, $controls ) {
		// If the block is already hidden by another control, keep it hidden.
		if ( ! $is_visible ) {
			return $is_visible;
		}

		// Check if our control is set on this block.
		$control_atts = isset( $controls['cloudflareGeo'] ) ? $controls['cloudflareGeo'] : null;
		if ( ! $control_atts ) {
			return true;
		}

		$countries_str = isset( $control_atts['countries'] ) ? $control_atts['countries'] : '';
		$datacenters_str = isset( $control_atts['datacenters'] ) ? $control_atts['datacenters'] : '';

		if ( empty( trim( $countries_str ) ) && empty( trim( $datacenters_str ) ) ) {
			return true;
		}

		// Parse country codes.
		$countries = array_map( 'strtoupper', array_map( 'trim', preg_split( '/[\s,]+/', $countries_str ) ) );
		$countries = array_filter( $countries );

		// Parse data center codes.
		$datacenters = array_map( 'strtoupper', array_map( 'trim', preg_split( '/[\s,]+/', $datacenters_str ) ) );
		$datacenters = array_filter( $datacenters );

		// Retrieve location country.
		$visitor_country = isset( $_SERVER['HTTP_CF_IPCOUNTRY'] ) ? $_SERVER['HTTP_CF_IPCOUNTRY'] : '';
		if ( current_user_can( 'manage_options' ) && isset( $_GET['cf_country'] ) ) {
			$visitor_country = sanitize_text_field( wp_unslash( $_GET['cf_country'] ) );
		}
		$visitor_country = strtoupper( trim( $visitor_country ) );

		// Retrieve data center.
		$visitor_datacenter = '';
		$cf_ray = isset( $_SERVER['HTTP_CF_RAY'] ) ? $_SERVER['HTTP_CF_RAY'] : '';
		if ( ! empty( $cf_ray ) ) {
			$parts = explode( '-', $cf_ray );
			$visitor_datacenter = end( $parts );
		}
		if ( current_user_can( 'manage_options' ) && isset( $_GET['cf_datacenter'] ) ) {
			$visitor_datacenter = sanitize_text_field( wp_unslash( $_GET['cf_datacenter'] ) );
		}
		$visitor_datacenter = strtoupper( trim( $visitor_datacenter ) );

		// If headers are missing (e.g., local development) and no debug override is active,
		// bypass the restriction so we don't break developer access.
		if ( empty( $visitor_country ) && empty( $visitor_datacenter ) ) {
			return true;
		}

		$country_match = ! empty( $countries ) && in_array( $visitor_country, $countries, true );
		$datacenter_match = ! empty( $datacenters ) && in_array( $visitor_datacenter, $datacenters, true );

		// Determine overall match.
		$is_match = false;
		if ( ! empty( $countries ) && ! empty( $datacenters ) ) {
			$is_match = $country_match || $datacenter_match;
		} elseif ( ! empty( $countries ) ) {
			$is_match = $country_match;
		} elseif ( ! empty( $datacenters ) ) {
			$is_match = $datacenter_match;
		} else {
			return true;
		}

		$hide_on_rule_sets = isset( $control_atts['hideOnRuleSets'] ) ? (bool) $control_atts['hideOnRuleSets'] : false;

		if ( $hide_on_rule_sets ) {
			if ( $is_match ) {
				return false;
			}
		} else {
			if ( ! $is_match ) {
				return false;
			}
		}

		return true;
	}
}

new Cloudflare_Geotargeting_Block_Visibility();

/**
 * Cloudflare Geotargeting for Block Visibility Gutenberg Integration
 */
( function() {
	'use strict';

	// Register our control with Block Visibility.
	wp.hooks.addFilter(
		'blockVisibility.controls',
		'cloudflare-geotargeting/controls',
		function( controls ) {
			controls.push( {
				label: 'Cloudflare Geotargeting',
				attributeSlug: 'cloudflareGeo',
				settingSlug: 'cloudflare_geotargeting',
			} );
			return controls;
		}
	);

	// React component for rendering control fields.
	var CloudflareGeoControl = function( props ) {
		var enabledControls = props.enabledControls;
		var controlSetAtts = props.controlSetAtts;
		var setControlAtts = props.setControlAtts;

		// Check if our control is currently active.
		var isControlActive = enabledControls.some( function( control ) {
			return control.attributeSlug === 'cloudflareGeo' && control.isActive;
		} );

		if ( ! isControlActive ) {
			return null;
		}

		var value = ( controlSetAtts && controlSetAtts.controls && controlSetAtts.controls.cloudflareGeo ) || {};
		var hideOnRuleSets = value.hideOnRuleSets || false;
		var countries = value.countries || '';
		var datacenters = value.datacenters || '';

		var updateValue = function( key, newVal ) {
			var newControlVal = Object.assign( {}, value, { [key]: newVal } );
			setControlAtts( 'cloudflareGeo', newControlVal );
		};

		return wp.element.createElement(
			'div',
			{ className: 'controls-panel-item cloudflare-geo-control' },
			wp.element.createElement(
				'h3',
				{ className: 'controls-panel-item__header has-icon' },
				wp.element.createElement( 'span', null, 'Cloudflare Geotargeting' )
			),
			wp.element.createElement(
				'div',
				{ className: 'controls-panel-item__control-fields' },
				wp.element.createElement( wp.components.SelectControl, {
					label: 'Visibility Rule',
					value: hideOnRuleSets ? 'hide' : 'show',
					options: [
						{ label: 'Show block only when conditions match', value: 'show' },
						{ label: 'Hide block when conditions match', value: 'hide' },
					],
					onChange: function( val ) {
						updateValue( 'hideOnRuleSets', val === 'hide' );
					},
				} ),
				wp.element.createElement( wp.components.TextareaControl, {
					label: 'Country Codes',
					help: 'Enter comma- or space-separated 2-letter ISO country codes (e.g., US, CA, GB). Leave blank to ignore.',
					value: countries,
					onChange: function( val ) {
						updateValue( 'countries', val );
					},
					placeholder: 'US, CA, GB',
					rows: 2,
				} ),
				wp.element.createElement( wp.components.TextareaControl, {
					label: 'Data Center Codes',
					help: 'Enter comma- or space-separated 3-letter IATA codes (e.g., LAX, SFO, AMS). Leave blank to ignore.',
					value: datacenters,
					onChange: function( val ) {
						updateValue( 'datacenters', val );
					},
					placeholder: 'LAX, SFO, AMS',
					rows: 2,
				} )
			)
		);
	};

	// Add our component to the Block Visibility control set.
	wp.hooks.addFilter(
		'blockVisibility.addControlSetControls',
		'cloudflare-geotargeting/add-controls',
		function( OriginalComponent ) {
			return function( props ) {
				return wp.element.createElement(
					wp.element.Fragment,
					null,
					wp.element.createElement( OriginalComponent, props ),
					wp.element.createElement( CloudflareGeoControl, props )
				);
			};
		}
	);

} )();