Merge pull request #9256 from Sesquipedalian/3.0/checkReservedName

Respects `reserveCase` setting in SpoofDetector::checkReservedName()

Author: Sesquipedalian

Sources/Actions/Admin/Registration.php

@@ -609,6 +609,8 @@ public function reservedNames(): void
 
 			$_POST['reserved'] = Utils::normalize($_POST['reserved']);
 
+			$reserve_case = Config::$modSettings['reserveCase'];
+
 			// Set all the options....
 			Config::updateModSettings([
 				'reserveWord' => (int) !empty($_POST['matchword']),
@@ -619,6 +621,28 @@ public function reservedNames(): void
 			]);
 
 			Utils::$context['saved_successful'] = true;
+
+			// If the case setting changed, must rebuild the spoofdetector_name
+			// values in the members table.
+			if ($reserve_case != Config::$modSettings['reserveCase']) {
+				Db::$db->insert(
+					'insert',
+					'{db_prefix}background_tasks',
+					[
+						'task_class' => 'string',
+						'task_data' => 'string',
+						'claimed_time' => 'int',
+					],
+					[
+						[
+							'SMF\\Tasks\\UpdateSpoofDetectorNames',
+							json_encode(['last_member_id' => 0]),
+							0,
+						],
+					],
+					['id_task'],
+				);
+			}
 		}
 
 		// Get the reserved word options and words.

Sources/Tasks/UpdateSpoofDetectorNames.php

@@ -107,7 +107,13 @@ public function execute(): bool
 		while ($row = Db::$db->fetch_assoc($request)) {
 			$this->_details['last_member_id'] = $row['id_member'];
 
-			$skeleton = Utils::htmlspecialchars(SpoofDetector::getSkeletonString(html_entity_decode($row['real_name'], ENT_QUOTES)));
+			$name = Utils::entityDecode($row['real_name'], nbsp_to_space: true);
+
+			if (empty(Config::$modSettings['reserveCase'])) {
+				$name = Utils::casefold($name);
+			}
+
+			$skeleton = SpoofDetector::getSkeletonString($name);
 
 			// Don't bother updating if there's been no change.
 			if ($row['spoofdetector_name'] === $skeleton) {

Sources/Unicode/SpoofDetector.php

@@ -228,7 +228,16 @@ public static function enhanceWordCensor(string $text): bool
 	 */
 	public static function checkReservedName(string $name, bool $fatal = false): bool
 	{
-		$skeleton = self::getSkeletonString(html_entity_decode($name, ENT_QUOTES));
+		// For ease of comparison, decode any entities.
+		$name = Utils::entityDecode($name, nbsp_to_space: true);
+
+		// Do we want caseless comparison?
+		if (empty(Config::$modSettings['reserveCase'])) {
+			$name = Utils::casefold($name);
+		}
+
+		// Get the "skeleton" for this name.
+		$skeleton = self::getSkeletonString($name);
 
 		// This will hold all the names that are similar to $name.
 		$homograph_names = [];
@@ -241,19 +250,19 @@ public static function checkReservedName(string $name, bool $fatal = false): boo
 				continue;
 			}
 
-			// The admin might've used entities too, level the playing field.
-			$reserved_check = html_entity_decode($reserved, ENT_QUOTES);
+			// The admin might've used entities too, so level the playing field.
+			$reserved_check = Utils::entityDecode($reserved, nbsp_to_space: true);
 
 			// Case sensitive name?
 			if (empty(Config::$modSettings['reserveCase'])) {
-				$reserved_check = Utils::strtolower($reserved_check);
+				$reserved_check = Utils::casefold($reserved_check);
 			}
 
 			$reserved_skeleton = self::getSkeletonString($reserved_check);
 
 			// Skeletons match.
 			if ($skeleton == $reserved_skeleton) {
-				$homograph_names[] = $reserved_check;
+				$homograph_names[$reserved] = $reserved_check;
 			}
 			// Skeleton of the name includes skeleton of a reserved name.
 			elseif (
@@ -324,6 +333,14 @@ public static function checkReservedName(string $name, bool $fatal = false): boo
 	 */
 	public static function checkSimilarMemberName(string $name, int $id_member = 0, bool $fatal = false): bool
 	{
+		$name = Utils::entityDecode($name, nbsp_to_space: true);
+
+		if (empty(Config::$modSettings['reserveCase'])) {
+			$name = Utils::casefold($name);
+		}
+
+		$skeleton = self::getSkeletonString($name);
+
 		// This will hold all the names that are similar to $name.
 		$homograph_names = [];
 
@@ -335,12 +352,18 @@ public static function checkSimilarMemberName(string $name, int $id_member = 0,
 				AND id_member != {int:current_member}') . '',
 			[
 				'current_member' => $id_member,
-				'skeleton' => Utils::htmlspecialchars(self::getSkeletonString(html_entity_decode($name, ENT_QUOTES))),
+				'skeleton' => $skeleton,
 			],
 		);
 
 		while ($row = Db::$db->fetch_assoc($request)) {
-			$homograph_names[] = html_entity_decode($row['real_name'], ENT_QUOTES);
+			$real_name = Utils::entityDecode($row['real_name'], nbsp_to_space: true);
+
+			if (empty(Config::$modSettings['reserveCase'])) {
+				$real_name = Utils::casefold($real_name);
+			}
+
+			$homograph_names[$row['real_name']] = $real_name;
 		}
 
 		Db::$db->free_result($request);
@@ -363,21 +386,32 @@ public static function checkSimilarMemberName(string $name, int $id_member = 0,
 	 */
 	public static function checkSimilarGroupName(string $name, bool $fatal = false): bool
 	{
-		$skeleton = self::getSkeletonString(html_entity_decode($name, ENT_QUOTES));
+		$name = Utils::entityDecode($name, nbsp_to_space: true);
+
+		if (empty(Config::$modSettings['reserveCase'])) {
+			$name = Utils::casefold($name);
+		}
+
+		$skeleton = self::getSkeletonString($name);
 
 		// This will hold all the names that are similar to $name.
 		$homograph_names = [];
 
 		// Get all the membergroup names.
 		$request = Db::$db->query(
-			'SELECT group_name AS name
+			'SELECT group_name
 			FROM {db_prefix}membergroups',
-			[],
 		);
 
 		while ($row = Db::$db->fetch_assoc($request)) {
-			if ($skeleton === self::getSkeletonString(html_entity_decode($row['name'], ENT_QUOTES))) {
-				$homograph_names[] = $row['name'];
+			$group_name = Utils::entityDecode($row['group_name'], nbsp_to_space: true);
+
+			if (empty(Config::$modSettings['reserveCase'])) {
+				$group_name = Utils::casefold($group_name);
+			}
+
+			if ($skeleton === self::getSkeletonString($group_name)) {
+				$homograph_names[$row['group_name']] = $group_name;
 			}
 		}
 		Db::$db->free_result($request);
@@ -407,7 +441,7 @@ protected static function checkHomographNames(string $name, array $homograph_nam
 	{
 		$name_script_set = self::resolveScriptSet($name);
 
-		foreach ($homograph_names as $homograph_name) {
+		foreach ($homograph_names as $orig => $homograph_name) {
 			$homograph_name_script_set = self::resolveScriptSet($homograph_name);
 
 			// If they are mixed script confusables, reject.
@@ -417,7 +451,7 @@ protected static function checkHomographNames(string $name, array $homograph_nam
 				&& array_intersect($name_script_set, $homograph_name_script_set) === []
 			) {
 				if ($fatal) {
-					ErrorHandler::fatalLang('username_reserved', 'password', [$homograph_name]);
+					ErrorHandler::fatalLang('username_reserved', 'password', [$orig]);
 				}
 
 				return true;
@@ -436,7 +470,7 @@ protected static function checkHomographNames(string $name, array $homograph_nam
 			// This takes care of "ljeto" vs. "ljeto".
 			if ($name_kc === $homograph_name_kc) {
 				if ($fatal) {
-					ErrorHandler::fatalLang('username_reserved', 'password', [$homograph_name]);
+					ErrorHandler::fatalLang('username_reserved', 'password', [$orig]);
 				}
 
 				return true;
@@ -449,7 +483,7 @@ protected static function checkHomographNames(string $name, array $homograph_nam
 			// This takes care of "Bogden" vs. "Boɡden".
 			if (!preg_match('~^[' . $regexes['Allowed'] . ']*$~u', $name_kc) || !preg_match('~^[' . $regexes['Allowed'] . ']*$~u', $homograph_name_kc)) {
 				if ($fatal) {
-					ErrorHandler::fatalLang('username_reserved', 'password', [$homograph_name]);
+					ErrorHandler::fatalLang('username_reserved', 'password', [$orig]);
 				}
 
 				return true;