flagpole.php

<?php
/**
 * Flagpole
 * Easily register and work with feature flags in your themes.
 *
 * @package    flagpole
 * @subpackage flagpole/flagpole
 * @author     "James Williams <james@jamesrwilliams.ca>"
 * @link       https://github.com/jamesrwilliams/flagpole
 * @copyright  2019-2021 James Williams
 *
 * @wordpress-plugin
 * Plugin Name:       Flagpole
 * Description:       Easily register and work with feature flags in your theme.
 * Version:           0.1.3-beta
 * Author:            James Williams
 * Requires PHP:      5.6
 * Text Domain:       flagpole
 * Author URI:        https://jamesrwilliams.ca/
 */

// If this file is called directly abort.
if ( ! defined( 'WPINC' ) ) {
	wp_die();
}

use Flagpole\Flagpole;

// Define plugin paths and url for global usage.
define( 'FLAGPOLE_PLUGIN_PATH', plugin_dir_path( __FILE__ ) );
define( 'FLAGPOLE_PLUGIN_URL', plugin_dir_url( __FILE__ ) );
define( 'FLAGPOLE_VERSION', '0.1.0' );

// Register admin page.
add_action(
	'admin_init',
	function () {
		register_setting(
			'ff-settings-page',
			'ff_client_secret',
			function ( $posted_data ) {
				if ( ! $posted_data ) {
					add_settings_error( 'ff_client_secret', 'ff_updated', 'Error Message', 'error' );

					return false;
				}

				return $posted_data;
			}
		);
	}
);

/**
 * Plugin styles and scripts.
 *
 * @param string $hook The Hook string.
 */
function flagpole_admin_imports( $hook ) {
	if ( 'tools_page_flagpole' !== $hook ) {
		return;
	}

	wp_enqueue_style(
		'flagpole-styles',
		plugins_url(
			'/assets/css/flagpole.css',
			__FILE__
		),
		array(),
		FLAGPOLE_VERSION
	);

	wp_register_script(
		'flagpole-script',
		plugins_url(
			'/assets/js/flagpole.js',
			__FILE__
		),
		array(),
		FLAGPOLE_VERSION,
		false
	);

	wp_localize_script(
		'flagpole-script',
		'ffwp',
		array(
			'ajax_nonce' => wp_create_nonce( 'featureFlagNonce' ),
		)
	);
	wp_enqueue_script( 'flagpole-script' );
}

add_action( 'admin_enqueue_scripts', 'flagpole_admin_imports' );

// Includes.
require plugin_dir_path( __FILE__ ) . 'includes/class-flagpole.php';
require plugin_dir_path( __FILE__ ) . 'includes/admin/settings-page.php';
require plugin_dir_path( __FILE__ ) . 'includes/api/api.general.php';
require plugin_dir_path( __FILE__ ) . 'includes/api/api.shortcode.php';

/**
 * AJAX Action toggling features from the WP admin area.
 */
add_action( 'wp_ajax_toggleFeatureFlag', 'flagpole_enable' );

/**
 * Enable a feature Flag
 */
function flagpole_enable() {
	if (
		isset( $_POST['featureKey'] ) &&
		check_ajax_referer( 'featureFlagNonce', 'security' )
	) {
		$response = array();

		$feature_key = sanitize_text_field( wp_unslash( $_POST['featureKey'] ) );

		if ( ! empty( $feature_key ) ) {
			$response['response'] = $feature_key;

			Flagpole::init()->toggle_feature_preview( $feature_key );
		} else {
			header( 'HTTP/1.1 500 Internal Server Error' );
			$response['response'] = 'no feature key';
		}
	}

	exit();
}

/**
 * AJAX Action toggling features from the WP admin area.
 */
add_action( 'wp_ajax_togglePublishedFeature', 'flagpole_flag_publish' );

/**
 * Publish a feature flag to be publicly visible.
 */
function flagpole_flag_publish() {
	if ( isset( $_POST['featureKey'] ) && check_ajax_referer( 'featureFlagNonce', 'security' ) ) {
		$response = array();

		$feature_key = sanitize_text_field( wp_unslash( $_POST['featureKey'] ) );

		if ( ! empty( $feature_key ) ) {
			$response['response'] = Flagpole::init()->toggle_feature_publication( $feature_key );
		} else {
			header( 'HTTP/1.1 500 Internal Server Error' );
			$response['response'] = 'no feature key';
		}

		header( 'Content-Type: application/json' );
		echo wp_json_encode( $response );
	}

	exit();
}

// Groups - Create.
add_action( 'admin_post_ff_register_group', 'flagpole_create_group' );
add_action( 'admin_post_nopriv_ff_register_group', 'flagpole_create_group' );

/**
 * Create group admin hook handler.
 */
function flagpole_create_group() {
	$validation                  = array();
	$validation['group-nonce']   = check_admin_referer( 'register-group' );
	$validation['group-key']     = ( ! empty( $_GET['group-key'] ) ? sanitize_text_field( wp_unslash( $_GET['group-key'] ) ) : false );
	$validation['group-name']    = ( ! empty( $_GET['group-name'] ) ? sanitize_text_field( wp_unslash( $_GET['group-name'] ) ) : false );
	$validation['group-desc']    = ( ! empty( $_GET['group-description'] ) ? sanitize_textarea_field( wp_unslash( $_GET['group-description'] ) ) : '' );
	$validation['group-private'] = ( ! empty( $_GET['group-private'] ) ? sanitize_textarea_field( wp_unslash( $_GET['group-private'] ) ) : false );

	$validation = array_filter( $validation );

	if ( $validation ) {
		$result = Flagpole::init()->create_group( $validation['group-key'], $validation['group-name'],
			$validation['group-desc'], $validation['group-private'] );

		flagpole_operation_redirect( $result );
	}
}

// Groups - Delete.
add_action( 'admin_post_ff_delete_group', 'flagpole_delete_group' );
add_action( 'admin_post_nopriv_ff_delete_group', 'flagpole_delete_group' );

/**
 * Delete group admin hook handler.
 */
function flagpole_delete_group() {
	if ( ! empty( $_GET['key'] ) && check_admin_referer( 'ff_delete_group' ) ) {
		$key = sanitize_text_field( wp_unslash( $_GET['key'] ) );
	} else {
		$key = false;
	}

	$result = Flagpole::init()->delete_group( $key );

	flagpole_operation_redirect( $result );
}

add_action( 'admin_post_ff_preview_group', 'flagpole_toggle_group_preview' );
add_action( 'admin_post_nopriv_ff_preview_group', 'flagpole_toggle_group_preview' );

/**
 * Toggle group preview handler.
 */
function flagpole_toggle_group_preview() {
	if ( ! empty( $_GET['group_key'] ) && check_admin_referer( 'ff_preview_group' ) ) {
		$group_key = sanitize_text_field( wp_unslash( $_GET['group_key'] ) );
	} else {
		$group_key = false;
	}

	$result = Flagpole::init()->toggle_group_preview( $group_key );

	flagpole_operation_redirect( $result );
}

// Groups - Add too group.
add_action( 'admin_post_ff_add_to_group', 'flagpole_add_to_group' );
add_action( 'admin_post_nopriv_ff_add_to_group', 'flagpole_add_to_group' );

/**
 * Add to group admin hook handler.
 */
function flagpole_add_to_group() {
	if (
		! empty( $_GET['selected-flag'] ) &&
		! empty( $_GET['selected-group'] ) &&
		check_admin_referer( 'ff-add-to-group' )
	) {
		$flag  = sanitize_text_field( wp_unslash( $_GET['selected-flag'] ) );
		$group = sanitize_text_field( wp_unslash( $_GET['selected-group'] ) );

		$response = Flagpole::init()->add_flag_to_group( $flag, $group );

		flagpole_operation_redirect( $response );
	} else {
		flagpole_operation_redirect( 'fgae' );
	}
}

add_action( 'admin_post_ff_remove_flag_from_group', 'flagpole_remove_from_group' );
add_action( 'admin_post_nopriv_remove_flag_from_group', 'flagpole_remove_from_group' );

/**
 * Admin Post handler for removing a flag from a group.
 */
function flagpole_remove_from_group() {
	if (
		! empty( $_GET['flag'] ) &&
		! empty( $_GET['group'] ) &&
		check_admin_referer( 'ff_remove_flag_from_group' )
	) {
		$flag  = sanitize_text_field( wp_unslash( $_GET['flag'] ) );
		$group = sanitize_text_field( wp_unslash( $_GET['group'] ) );

		$response = Flagpole::init()->remove_flag_from_group( $flag, $group );

		flagpole_operation_redirect( $response );
	} else {
		flagpole_operation_redirect( 'fgae' );
	}
}

add_action( 'template_redirect', 'flagpole_redirect_with_key' );

/**
 * Redirect the user to the login form if they attempt to use a
 * flag query string while logged out.
 */
function flagpole_redirect_with_key() {
	$query = flagpole_find_query_string();

	if (
		isset( $_SERVER['REQUEST_URI'] ) &&
		isset( $_SERVER['HTTP_HOST'] ) &&
		! empty( $query ) && ! is_user_logged_in()
	) {
		if ( Flagpole::init()->is_private( $query ) ) {
			$destination = esc_url_raw( wp_unslash( $_SERVER['HTTP_HOST'] . $_SERVER['REQUEST_URI'] ) );

			if ( filter_var( $destination, FILTER_VALIDATE_URL ) ) {
				wp_safe_redirect( wp_login_url( $destination ) );
				exit();
			}
		}
	}
}

/**
 * Check if there is a group query string.
 *
 * @return bool|string False if there isn't one, the group key if found.
 */
function flagpole_find_query_string() {

	/* TODO: #21 - Make this a configurable key */
	$query_string_key = 'group';

	// phpcs:ignore WordPress.Security.NonceVerification.Recommended
	if ( isset( $_GET[ $query_string_key ] ) && '' !== $_GET[ $query_string_key ] ) {
		// phpcs:ignore WordPress.Security.NonceVerification.Recommended
		return sanitize_title( wp_unslash( $_GET[ $query_string_key ] ) );
	} else {
		return false;
	}
}

/**
 * Quickly generate return URLs with appropriate Error code messages.
 *
 * @param bool $error_code The error code string.
 * @param bool $redirect Either safe_redirect or return the URL.
 *
 * @return null|string Depending on $redirect.
 * @see FeatureFlags::get_admin_error_message() Method for generating error messages.
 */
function flagpole_operation_redirect( $error_code = false, $redirect = true ) {
	$redirect_url = ( wp_get_referer() ? wp_get_referer() : get_home_url() );

	if ( false !== $error_code && ! empty( $error_code ) ) {
		$redirect_url = add_query_arg(
			array(
				'error' => $error_code,
			),
			$redirect_url
		);
	}

	return ( $redirect ? wp_safe_redirect( $redirect_url ) : $redirect_url );
}

add_shortcode( 'debugFlagpole_flags', 'flagpole_shortcode_debug_flags' );
add_shortcode( 'debugFlagpole_groups', 'flagpole_shortcode_debug_groups' );
add_shortcode( 'debugFlagpole_db', 'flagpole_shortcode_debug_db' );