Tiny File Manager

Back Back Up Advanced Editor

<?php
/**
 * The Routes class for the QR module.
 *
 * @since 6.12.0
 */

namespace TEC\Events\QR;

use TEC\Common\Contracts\Provider\Controller;
use TEC\Events\QR\Controller as QR_Controller;
use Tribe__Events__Rewrite;

/**
 * Class Routes.
 *
 * @since 6.12.0
 *
 * @package TEC\Events\QR
 */
class Routes extends Controller {
	/**
	 * The base for the routes.
	 *
	 * @since 6.12.0
	 * @var string|null
	 */
	private $route_base = null;

/**
	 * The route prefix for QR codes.
	 *
	 * @since 6.12.0
	 * @var string|null
	 */
	private $route_prefix = null;

/**
	 * The salt for QR code generation.
	 *
	 * @since 6.12.0
	 * @var string|null
	 */
	private $salt = null;

/**
	 * The query variable name for QR code hash.
	 *
	 * @since 6.12.0
	 * @var string
	 */
	const QR_HASH_VAR = 'tec_qr_hash';

/**
	 * Register the routes.
	 *
	 * @since 6.12.0
	 * @return void
	 */
	public function do_register(): void {
		$this->add_hooks();
	}

/**
	 * Unregister the routes.
	 *
	 * @since 6.12.0
	 * @return void
	 */
	public function unregister(): void {
		$this->remove_hooks();
	}

/**
	 * Adds the actions required by the controller.
	 *
	 * @since 6.12.0
	 * @return void
	 */
	protected function add_hooks(): void {
		add_action( 'tribe_events_pre_rewrite', [ $this, 'add_qr_rules' ] );
		add_filter( 'query_vars', [ $this, 'filter_add_query_vars' ] );
		add_filter( 'tribe_rewrite_parse_query_vars', [ $this, 'filter_parse_query_vars' ] );
	}

/**
	 * Removes the actions required by the controller.
	 *
	 * @since 6.12.0
	 * @return void
	 */
	protected function remove_hooks(): void {
		remove_action( 'tribe_events_pre_rewrite', [ $this, 'add_qr_rules' ] );
		remove_filter( 'query_vars', [ $this, 'filter_add_query_vars' ] );
		remove_filter( 'tribe_rewrite_parse_query_vars', [ $this, 'filter_parse_query_vars' ] );
	}

/**
	 * Get the route base for QR codes.
	 *
	 * @since 6.12.0
	 *
	 * @return string The route base.
	 */
	public function get_route_base(): string {
		if ( $this->route_base === null ) {
			$base = 'events';

/**
			 * Filter the base route for QR codes.
			 *
			 * @since 6.12.0
			 *
			 * @param string $base The base route for QR codes.
			 */
			$this->route_base = apply_filters( 'tec_events_qr_route_base', $base );
		}

return $this->route_base;
	}

/**
	 * Get the route prefix for QR codes.
	 *
	 * @since 6.12.0
	 *
	 * @return string The route prefix.
	 */
	public function get_route_prefix(): string {
		if ( $this->route_prefix === null ) {
			$prefix = 'qr';

/**
			 * Filter the route prefix for QR codes.
			 *
			 * @since 6.12.0
			 *
			 * @param string $prefix The route prefix for QR codes.
			 */
			$this->route_prefix = apply_filters( 'tec_events_qr_route_prefix', $prefix );
		}

return $this->route_prefix;
	}

/**
	 * Add QR code rewrite rules.
	 *
	 * @since 6.12.0
	 * @param Tribe__Events__Rewrite $rewrite The TEC rewrite instance.
	 * @return void
	 */
	public function add_qr_rules( Tribe__Events__Rewrite $rewrite ): void {
		$rewrite->add(
			[ $this->get_route_base(), $this->get_route_prefix(), '([^/]+)' ],
			[ self::QR_HASH_VAR => '%1' ]
		);
	}

/**
	 * Adds the required Query Vars for QR code routes.
	 *
	 * @since 6.12.0
	 * @param array $query_vars The array of query variables to add to.
	 * @return array The modified query vars.
	 */
	public function filter_add_query_vars( $query_vars = [] ) {
		$query_vars[] = self::QR_HASH_VAR;

return $query_vars;
	}

/**
	 * Parse query vars for QR code routes.
	 *
	 * @since 6.12.0
	 *
	 * @param array $query_vars The current query vars.
	 *
	 * @return array The modified query vars.
	 */
	public function filter_parse_query_vars( array $query_vars ): array {
		if ( isset( $query_vars[ self::QR_HASH_VAR ] ) ) {
			$query_vars[ self::QR_HASH_VAR ] = sanitize_text_field( $query_vars[ self::QR_HASH_VAR ] );
		}

return $query_vars;
	}

/**
	 * Get the salt for QR code generation.
	 *
	 * @since 6.12.0
	 *
	 * @return string The salt value.
	 */
	public function get_salt(): string {
		if ( $this->salt === null ) {
			$salt = substr( wp_salt( QR_Controller::QR_SLUG ), 0, 8 );

/**
			 * Filter the salt used for QR code generation.
			 *
			 * @since 6.12.0
			 *
			 * @param string $salt The salt value.
			 */
			$this->salt = apply_filters( 'tec_events_qr_salt', $salt );
		}

return $this->salt;
	}

/**
	 * Generate a unique hash for a QR code.
	 *
	 * @since 6.12.0
	 *
	 * @param int    $post_id The post ID (event or series).
	 * @param string $qr_type The QR Redirection behavior.
	 *
	 * @return string The generated hash.
	 */
	public function generate_hash( int $post_id, string $qr_type ): string {
		// Create a simple string with the data and salt.
		$data = $post_id . ':' . $qr_type . ':' . $this->get_salt();

// Convert to base64url (URL-safe base64).
		return rtrim( strtr( base64_encode( $data ), '+/', '-_' ), '=' );
	}

/**
	 * Get the URL for a QR code.
	 *
	 * @since 6.12.0
	 *
	 * @param int    $post_id The post ID (event or series).
	 * @param string $qr_type The QR Redirection behavior.
	 *
	 * @return string The QR code URL.
	 */
	public function get_qr_url( int $post_id, string $qr_type ): string {
		$hash = $this->generate_hash( $post_id, $qr_type );

return home_url( $this->get_route_base() . "/{$this->get_route_prefix()}/{$hash}/" );
	}

/**
	 * Decode a QR code hash and return its information.
	 *
	 * @since 6.12.0
	 *
	 * @param string $hash The QR code hash to decode.
	 *
	 * @throws \InvalidArgumentException If the hash is invalid.
	 *
	 * @return array{
	 *     post_id: int,
	 *     qr_type: string,
	 * } The decoded QR code information.
	 */
	public function decode_qr_hash( string $hash ): array {
		// Convert from base64url back to standard base64.
		$hash = strtr( $hash, '-_', '+/' );

// Add padding if needed.
		$padding = strlen( $hash ) % 4;
		if ( $padding ) {
			$hash .= str_repeat( '=', 4 - $padding );
		}

$decoded = base64_decode( $hash, true );
		if ( $decoded === false ) {
			throw new \InvalidArgumentException( 'Invalid QR code hash format.' );
		}

// Extract the data parts.
		$parts = explode( ':', $decoded );
		if ( count( $parts ) !== 3 ) {
			throw new \InvalidArgumentException( 'Invalid QR code data format.' );
		}

// Verify the salt matches.
		if ( $parts[2] !== $this->get_salt() ) {
			throw new \InvalidArgumentException( 'Invalid QR code signature.' );
		}

$post_id = (int) $parts[0];
		$qr_type = $parts[1];

return [
			'post_id' => $post_id,
			'qr_type' => $qr_type,
		];
	}

/**
	 * Decode a QR code URL and return its information.
	 *
	 * @since 6.12.0
	 *
	 * @param string $url The QR code URL to decode.
	 *
	 * @throws \InvalidArgumentException If the URL is not a valid QR code URL or the hash is invalid.
	 *
	 * @return array{
	 *     post_id: int,
	 *     qr_type: string,
	 * } The decoded QR code information.
	 */
	public function decode_qr_url( string $url ): array {
		$path = wp_parse_url( $url, PHP_URL_PATH );
		if ( ! $path ) {
			throw new \InvalidArgumentException( 'Invalid QR code URL.' );
		}

$parts = explode( '/', trim( $path, '/' ) );
		if ( count( $parts ) !== 3 || $parts[0] !== $this->get_route_base() || $parts[1] !== $this->get_route_prefix() ) {
			throw new \InvalidArgumentException( 'Invalid QR code URL structure. Expected: ' . $this->get_route_base() . '/' . $this->get_route_prefix() . '/{hash}, Got: ' . $path );
		}

return $this->decode_qr_hash( $parts[2] );
	}
}