class-permissions.php

<?php
/**
 * Permissions Class
 *
 * @package Parsely
 * @since   3.16.0
 */

declare(strict_types=1);

namespace Parsely;

/**
 * Class implementing user/role permissions functionality.
 *
 * @since 3.16.0
 *
 * @phpstan-import-type Parsely_Options_Content_Helper from Parsely
 * @phpstan-import-type Parsely_Options_Content_Helper_Feature from Parsely
 */
class Permissions {
	/**
	 * Returns all user roles (custom roles included) that have the edit_posts
	 * capability.
	 *
	 * The return value is an associative array with role keys and names, e.g.
	 * `array( 'administrator' => 'Administrator', 'editor' => 'Editor' )`.
	 *
	 * @since 3.16.0
	 *
	 * @return array<string, string> The user roles having the edit_posts capability.
	 */
	public static function get_user_roles_with_edit_posts_cap(): array {
		$result = array();
		$roles  = wp_roles()->roles;

		foreach ( $roles as $key => $role ) {
			if ( isset( $role['capabilities']['edit_posts'] ) ) {
				$result[ $key ] = $role['name'];
			}
		}

		return $result;
	}

	/**
	 * Returns whether the current user has the permission to access the
	 * specified Content Intelligence feature.
	 *
	 * @since 3.16.0
	 *
	 * @param string                         $feature_name The feature's name.
	 * @param Parsely_Options_Content_Helper $pch_options The Content Intelligence options.
	 * @param int|false                      $post_id The post ID, if the check is for a specific post.
	 * @return bool Whether the current user can access the specified feature.
	 */
	public static function current_user_can_use_pch_feature(
		string $feature_name,
		$pch_options,
		$post_id = false
	): bool {
		if ( isset( $pch_options[ $feature_name ] ) ) {
			/**
			 * The feature's options.
			 *
			 * @var Parsely_Options_Content_Helper_Feature $feature_options
			 */
			$feature_options = $pch_options[ $feature_name ];
		} else {
			return false;
		}

		$current_user = wp_get_current_user();
		$user_roles   = $current_user->roles;

		/**
		 * Filters whether the current user can use the specified Content
		 * Intelligence feature.
		 *
		 * This filter can be used to override the default permissions check.
		 *
		 * @since 3.16.2
		 *
		 * @param ?bool   $current_user_can_use_pch_feature Whether the current user can use the feature.
		 *                                                  Is null when the filter isn't being used.
		 * @param string $feature_name The feature's name.
		 * @param \WP_User $current_user The current user object.
		 * @param int|false $post_id The post ID, if the check is for a specific post.
		 */
		$filtered_current_user_can_use_pch_feature = apply_filters(
			'wp_parsely_current_user_can_use_pch_feature',
			null,
			$feature_name,
			$current_user,
			$post_id
		);

		// When $wp_parsely_current_user_can_use_pch_feature's value is set,
		// return it without further processing.
		if ( null !== $filtered_current_user_can_use_pch_feature ) {
			if ( true === $filtered_current_user_can_use_pch_feature ) {
				return true;
			}

			return false;
		}

		// All AI features are disabled.
		if ( true !== $pch_options['ai_features_enabled'] ) {
			return false;
		}

		// The specific AI feature is disabled.
		if ( true !== $feature_options['enabled'] ) {
			return false;
		}

		// If the user is a super admin, they can access the feature.
		if ( is_multisite() && is_super_admin( $current_user->ID ) ) {
			return true;
		}

		// Current user's role is not yet set.
		if ( 0 === count( $user_roles ) ) {
			return false;
		}

		// Get the roles with the capability to edit posts.
		$valid_roles = array_keys( self::get_user_roles_with_edit_posts_cap() );

		// Check that at least one of the user's roles has the capability to edit posts.
		if ( 0 === count( array_intersect( $user_roles, $valid_roles ) ) ) {
			return false;
		}

		// Check that at least one of the user's roles has access to the specific feature/post.
		$allowed_roles = $feature_options['allowed_user_roles'];
		if ( 0 === count( array_intersect( $user_roles, $allowed_roles ) ) ) {
			return false;
		}

		// Check if the user can edit the post.
		if ( (int) $post_id > 0 ) {
			return current_user_can( 'edit_post', $post_id );
		}

		return true;
	}

	/**
	 * Returns a JSON-encoded string with the Content Intelligence permissions
	 * for the current user.
	 *
	 * @since 3.16.0
	 *
	 * @param Parsely_Options_Content_Helper $pch_options The options to check against.
	 * @return string The JSON-encoded permissions string.
	 */
	public static function get_pch_permissions_json( $pch_options ): string {
		$permissions = array();
		$features    = array(
			'SmartLinking'       => 'smart_linking',
			'TitleSuggestions'   => 'title_suggestions',
			'ExcerptSuggestions' => 'excerpt_suggestions',
			'TrafficBoost'       => 'traffic_boost',
		);

		foreach ( $features as $key => $value ) {
			$permissions[ $key ] = self::current_user_can_use_pch_feature(
				$value,
				$pch_options,
				get_the_ID()
			);
		}

		$result = wp_json_encode( $permissions );

		return is_string( $result ) ? $result : '{}';
	}

	/**
	 * Builds and returns a permissions settings array for Content Intelligence,
	 * based on the passed values.
	 *
	 * @since 3.16.0
	 *
	 * @param bool               $enabled Whether to enable the features.
	 * @param array<int, string> $allowed_user_roles The allowed user roles.
	 * @return Parsely_Options_Content_Helper The resulting permissions settings.
	 */
	public static function build_pch_permissions_settings_array(
		bool $enabled,
		array $allowed_user_roles
	) {
		return array(
			'ai_features_enabled' => $enabled,
			'smart_linking'       => array(
				'enabled'            => $enabled,
				'allowed_user_roles' => $allowed_user_roles,
			),
			'title_suggestions'   => array(
				'enabled'            => $enabled,
				'allowed_user_roles' => $allowed_user_roles,
			),
			'excerpt_suggestions' => array(
				'enabled'            => $enabled,
				'allowed_user_roles' => $allowed_user_roles,
			),
			'traffic_boost'       => array(
				'enabled'            => $enabled,
				'allowed_user_roles' => $allowed_user_roles,
			),
		);
	}
}