File "With_Nonce_Routes.php"

Full Path: /home/romayxjt/public_html/wp-content/plugins/the-events-calendar/common/src/Common/Event_Automator/Traits/With_Nonce_Routes.php
File size: 3.81 KB
MIME-type: text/x-php
Charset: utf-8

<?php
/**
 * Provides methods to route requests using nonce-based routes to identify the kind of request.
 *
 * @since 6.0.0 Migrated to Common from Event Automator
 *
 * @package TEC\Event_Automator\Traits;
 */

namespace TEC\Event_Automator\Traits;

use TEC\Event_Automator\Plugin;

/**
 * Trait With_Nonce_Routes
 *
 * @since 6.0.0 Migrated to Common from Event Automator
 *
 * @package TEC\Event_Automator\Traits;
 */
trait With_Nonce_Routes {

	/**
	 * Routes a request to the admin area only if the user can manage the site options.
	 *
	 * @since 6.0.0 Migrated to Common from Event Automator
	 *
	 * @param array<string,callable>    $routes A map of the routes to handle, from nonce actions to the callables
	 *                                              that should handle each.
	 * @param string                    ...$caps One or more capabilities the current user should possess to proceed
	 *                                              with the routing.
	 *
	 * @return false|callable The callback that will be used to handle the route, or `false` to indicate a no match.
	 */
	public function route_admin_by_nonce( array $routes, ...$caps ) {
		$routes = array_filter( $routes, 'is_callable' );

		if ( empty( $routes ) ) {
			// Let's not even start dealing with it if no route handler is callable.
			return false;
		}

		if ( ! current_user_can( ...$caps ) ) {
			return false;
		}

		$context = tribe( 'context' );
		$nonce = $context->get( 'tec_automator_admin_request' );

		if ( empty( $nonce ) || ! is_admin() || ! current_user_can( ...$caps ) ) {
			return false;
		}


		return $this->route_by_nonce( $routes, $nonce );

	}

	/**
	 * Routes a request to the admin area ignoring capabilities.
	 *
	 * @since 6.0.0 Migrated to Common from Event Automator
	 *
	 * @param array<string,callable> $routes A map of the routes to handle, from nonce actions to the callables
	 *                                              that should handle each.
	 *
	 * @return false|callable The callback that will be used to handle the route, or `false` to indicate a no match.
	 */
	public function public_route_by_nonce( array $routes ) {
		$routes = array_filter( $routes, 'is_callable' );

		if ( empty( $routes ) ) {
			// Let's not even start dealing with it if no route handler is callable.
			return false;
		}

		$context = tribe( 'context' );
		$nonce = $context->get( 'tec_automator_admin_request' );

		if ( empty( $nonce ) ) {
			return false;
		}

		return $this->route_by_nonce( $routes, $nonce );

	}

	/**
	 * Routes a request to the admin area ignoring capabilities.
	 *
	 * @since 6.0.0 Migrated to Common from Event Automator
	 *
	 * @param string                    $nonce Nonce to be validated.
	 *
	 * @param array<string,callable>    $routes A map of the routes to handle, from nonce actions to the callables
	 *                                              that should handle each.
	 *
	 * @return false|callable The callback that will be used to handle the route, or `false` to indicate a no match.
	 */
	private function route_by_nonce( array $routes, string $nonce ) {

		// Remove the query arguments from the `$_SERVER['REQUEST_URI']` to avoid issues.
		if ( isset( $_SERVER[ 'REQUEST_URI' ] ) ) {
			$_SERVER[ 'REQUEST_URI' ] = remove_query_arg(
				[ Plugin::$request_slug, ],
				$_SERVER[ 'REQUEST_URI' ]
			);
		}

		$callback = false;
		$handler  = false;
		foreach ( $routes as $nonce_action => $callback ) {
			if ( ! is_callable( $callback ) ) {
				// There are legitimate reasons why this might not be a valid callback, just move on.
				continue;
			}

			if ( wp_verify_nonce( $nonce, $nonce_action ) ) {
				$handler = static function () use ( $callback, $nonce ) {
					return $callback( $nonce );
				};
				break;
			}
		}

		if ( false === $handler ) {
			return false;
		}

		add_action( 'admin_init', $handler );

		return $callback;
	}
}