22

✏️ Editing: class-wpml-translation-roles-records.php

<?php

use WPML\LIB\WP\Cache;

abstract class WPML_Translation_Roles_Records {

const USERS_WITH_CAPABILITY    = 'LIKE';
	const USERS_WITHOUT_CAPABILITY = 'NOT LIKE';
	const MIN_SEARCH_LENGTH        = 3;
	const CACHE_GROUP              = __CLASS__;
	const CACHE_PREFIX             = 'wpml-cache-translators-';

/** @var wpdb */
	protected $wpdb;

/** @var WPML_WP_User_Query_Factory */
	private $user_query_factory;

/** @var \WP_Roles */
	protected $wp_roles;

protected $administratorRoleManager;

/**
	 * WPML_Translation_Roles_Records constructor.
	 *
	 * @param \wpdb                       $wpdb
	 * @param \WPML_WP_User_Query_Factory $user_query_factory
	 * @param \WP_Roles                   $wp_roles
	 */
	public function __construct(
		wpdb $wpdb,
		WPML_WP_User_Query_Factory $user_query_factory,
		WP_Roles $wp_roles,
		\WPML\TranslationRoles\Service\AdministratorRoleManager $administratorRoleManager
	) {
		$this->wpdb               = $wpdb;
		$this->user_query_factory = $user_query_factory;
		$this->wp_roles           = $wp_roles;
		$this->administratorRoleManager = $administratorRoleManager;

add_action( 'user_register', [ $this, 'on_user_register' ], 10, 2 );
		add_filter( 'update_user_metadata', [ $this, 'on_user_meta_update' ], 10, 4 );
		$this->prepare_hooks();
	}

public function has_users_with_capability() {
		$sql = "
				SELECT EXISTS(
				   SELECT user_id
				   FROM {$this->wpdb->usermeta}
				   WHERE meta_key = '{$this->wpdb->prefix}capabilities' AND meta_value LIKE %s
				)
			";

$sql = $this->wpdb->prepare( $sql, '%' . $this->get_capability() . '%' );

return (bool) $this->wpdb->get_var( $sql );
	}

/**
	 * @return array
	 */
	public function get_users_with_capability() {
		return $this->get_records( self::USERS_WITH_CAPABILITY );
	}

/**
	 * @return int
	 */
	public function get_number_of_users_with_capability() {
		return count( $this->get_users_with_capability() );
	}

/**
	 * @param string $search
	 * @param int    $limit
	 *
	 * @return array
	 */
	public function search_for_users_without_capability( $search = '', $limit = -1 ) {
		return $this->get_records( self::USERS_WITHOUT_CAPABILITY, $search, $limit );
	}

/**
	 * @param int $user_id
	 *
	 * @return bool
	 */
	public function does_user_have_capability( $user_id ) {
		$fn = Cache::memorize(
			self::CACHE_GROUP . '_does_user_have_capability',
			3600,
			function ( $user_id ) {
				return $this->fetch_user_capability( $user_id );
			}
		);

return $fn( $user_id );
	}

/**
	 * Delete records for all users
	 */
	public function delete_all() {
		$users = $this->get_users_with_capability();
		foreach ( $users as $user ) {
			$this->delete( $user->ID );
		}
	}

/**
	 * Delete the record for the user
	 *
	 * @param int $user_id
	 */
	public function delete( $user_id ) {
		$user = new WP_User( $user_id );
		$user->remove_cap( $this->get_capability() );
	}

/**
	 * @param string $compare
	 * @param string $search
	 * @param int    $limit
	 *
	 * @return array
	 */
	private function get_records( $compare, $search = '', $limit = -1 ) {
		$search = trim( $search );

// Only use the cache when we are looking for all users with the capability.
		$useCache = $compare === self::USERS_WITH_CAPABILITY && '' === $search && -1 === $limit;

$preparedUserQuery = $this->wpdb->prepare(
			"SELECT u.id FROM {$this->wpdb->users} u INNER JOIN {$this->wpdb->usermeta} c ON c.user_id=u.ID AND c.meta_key=%s AND c.meta_value {$compare} %s",
			"{$this->wpdb->prefix}capabilities",
			"%" . $this->get_capability() . "%"
		);

if ( self::USERS_WITHOUT_CAPABILITY === $compare ) {
			$required_wp_roles = $this->get_required_wp_roles();
			foreach( $required_wp_roles as $required_wp_role ) {
				$preparedUserQuery .= $this->wpdb->prepare( " AND c.meta_value LIKE %s", "%{$required_wp_role}%" );
			}
		}

if ( $search ) {
			$preparedUserQuery .= $this->wpdb->prepare( " AND (u.user_login LIKE %s OR u.user_nicename LIKE %s OR u.user_email LIKE %s)", "%{$search}%", "%{$search}%", "%{$search}%" );
		}

$cache      = $this->get_cache();
		$validCache = is_array( $cache );
		if ( $validCache && $useCache ) {
			if ( count( $cache ) === 0 ) {
				// No translator OR translation manager registered on the site.
				return [];
			}
			$preparedUserQuery .= ' AND u.id IN(' . implode( ',', array_keys( $cache ) ) . ')';
		}

$preparedUserQuery .= ' ORDER BY user_login ASC';

if ( $limit > 0 ) {
			$preparedUserQuery .= $this->wpdb->prepare(" LIMIT 0,%d", $limit );
		}

$users      = $this->wpdb->get_col( $preparedUserQuery );

if ( $search && strlen( $search ) > self::MIN_SEARCH_LENGTH && ( $limit <= 0 || count( $users ) < $limit ) ) {
			$users_from_metas = $this->get_records_from_users_metas( $compare, $search, $limit );
			$users_with_dupes = array_merge( $users, $users_from_metas );
			$users            = wpml_array_unique( $users_with_dupes, SORT_REGULAR );
		}

$results     = array();
		$translators = array();
		foreach ( $users as $user_id ) {
			$user_data = get_userdata( $user_id );
			if ( $user_data ) {
				$language_pair_records = new WPML_Language_Pair_Records( $this->wpdb, new WPML_Language_Records( $this->wpdb ) );
				$language_pairs        = $language_pair_records->get( $user_id );

$translators[ $user_data->ID ] = $user_data->user_login;

$result    = (object) array(
					'ID'             => $user_data->ID,
					'full_name'      => trim( $user_data->first_name . ' ' . $user_data->last_name ),
					'user_login'     => $user_data->user_login,
					'user_email'     => $user_data->user_email,
					'display_name'   => $user_data->display_name,
					'user_nicename'  => $user_data->user_nicename,
					'language_pairs' => $language_pairs,
					'roles'          => $user_data->roles,
				);
				$results[] = $result;
			}
		}

if ( ! $validCache && $useCache ) {
			// Only cache full list of translators.
			$this->update_cache( $translators );
		}

return $results;
	}

/**
	 * @return string
	 */
	private function get_cache_key() {
		return self::CACHE_PREFIX . $this->get_capability();
	}

/**
	 * @return array | false
	 */
	private function get_cache() {
		return get_option( $this->get_cache_key(), false );
	}

/**
	 * @param array $translators
	 * @return void
	 */
	private function update_cache( $translators ) {
		update_option( $this->get_cache_key(), $translators );
	}

/**
	 * @return void
	 */
	private function delete_cache() {
		delete_option( $this->get_cache_key() );
	}

/**
	 * @param int $user_id
	 *
	 * @return void
	 */
	public function on_translator_save( $user_id = 0 ) {
		$user = $user_id ? get_userdata( $user_id ) : false;
		if ( ! $user ) {
			return;
		}

$translators = $this->get_cache();

if ( ! is_array( $translators ) ) {
			$translators = array();
		}

if ( array_key_exists( $user->ID, $translators ) ) {
			return;
		}

$translators[ $user->ID ] = $user->user_login;
		$this->update_cache( $translators );
	}

/**
	 * @param int   $id
	 * @param array $data
	 *
	 * @return void
	 */
	public function on_user_register( $id, $data = [] ) {
		if ( ! $id ) {
			return;
		}

if ( ! is_array( $data ) || ! array_key_exists( 'user_login', $data ) ) {
			// Pre WP 5.8.0.
			$user = get_userdata( $id );
			if ( ! $user ) {
				return;
			}

$data = [
				'user_login' => $user->user_login,
			];
		}

$translators = $this->get_cache();
		if ( ! is_array( $translators ) ) {
			return;
		}

foreach ( $translators as $cached_id => $cached_login ) {
			if (
				$cached_id === $id && $cached_login !== $data['user_login'] ||
				$cached_id !== $id && $cached_login === $data['user_login']
			) {
				// Import of an user, which has the same id OR login as an translator.
				// Nothing unusual on import when there are already existing users.
				$this->delete_cache();
				break;
			}
		}
	}

/**
	 * @param bool   $check       Whether to allow updating metadata.
	 * @param int    $user_id     Id of the user for which metadata is being updated.
	 * @param string $meta_key    Metadata key.
	 * @param mixed  $meta_value  Metadata value. Serialized arrays will be unserialized.
	 *
	 * @return bool
	 */
	public function on_user_meta_update( $check, $user_id, $meta_key, $meta_value ) {
		if ( $this->wpdb->prefix . 'capabilities' !== $meta_key ) {
			return $check;
		}

if ( is_array( $meta_value ) && array_key_exists( $this->get_capability(), $meta_value ) ) {
			$this->on_translator_save( $user_id );
		}

return $check;
	}

/**
	 * @param string $compare
	 * @param string $search
	 * @param int    $limit
	 *
	 * @return array
	 */
	private function get_records_from_users_metas( $compare, $search, $limit = -1 ) {
		$search = trim( $search );
		if ( ! $search ) {
			return array();
		}

$sanitized_search = preg_replace( '!\s+!', ' ', $search );
		$words            = explode( ' ', $sanitized_search );

if ( ! $words ) {
			return array();
		}

$search_by_names = array( 'relation' => 'OR' );

foreach ( $words as $word ) {
			$search_by_names[] = array(
				'key'     => 'first_name',
				'value'   => $word,
				'compare' => 'LIKE',
			);
			$search_by_names[] = array(
				'key'     => 'last_name',
				'value'   => $word,
				'compare' => 'LIKE',
			);
			$search_by_names[] = array(
				'key'     => 'last_name',
				'value'   => $word,
				'compare' => 'LIKE',
			);
		}

$query_args = array(
			'fields'     => 'ID',
			'meta_query' => array(
				'relation' => 'AND',
				array(
					'key'     => "{$this->wpdb->prefix}capabilities",
					'value'   => $this->get_capability(),
					'compare' => $compare,
				),
				$search_by_names,
			),
			'number'     => $limit,
		);

if ( 'NOT LIKE' === $compare ) {
			$required_wp_roles = $this->get_required_wp_roles();
			if ( $required_wp_roles ) {
				$query_args['role__in'] = $required_wp_roles;
			}
		}

$user_query = $this->user_query_factory->create( $query_args );

return $user_query->get_results();

}

/**
	 * Fetches the capability for the user from DB
	 *
	 * @param int $user_id
	 */
	private function fetch_user_capability( $user_id ) {
		$sql = "
			   SELECT user_id
			   FROM {$this->wpdb->usermeta}
			   WHERE user_id = %d AND meta_key = %s AND meta_value LIKE %s
			   LIMIT 1
			";

$sql = $this->wpdb->prepare( $sql, $user_id, $this->wpdb->prefix . 'capabilities', '%' . $this->get_capability() . '%' );

return (bool) $this->wpdb->get_var( $sql );
	}

/**
	 * @return void
	 */
	abstract protected function prepare_hooks();

/**
	 * @return string
	 */
	abstract protected function get_capability();

/**
	 * @return array
	 */
	abstract protected function get_required_wp_roles();
}

MR SKB