Files
ragflow/api/utils/nickname_validation.py
Carl Harris a2de880b6d fix(profile): enforce profile name validation and input constraints (#15694)
### What problem does this PR solve?

The Profile **Name** field currently lacks application-level validation
and allows users to save excessively long names and unsupported special
characters.

While the database enforces a maximum length of 100 characters, neither
the frontend nor backend validates nickname format before persistence.
This can result in inconsistent user data, poor user experience, and UI
layout issues when long names wrap across multiple lines.

This PR introduces consistent frontend and backend validation for
profile names, enforces length and character constraints, provides clear
validation feedback, and prevents invalid values from being saved.

Fixes #15693

### Type of change

* [x] Bug Fix (non-breaking change which fixes an issue)
2026-06-12 11:13:18 +08:00

52 lines
1.8 KiB
Python

#
# Copyright 2026 The InfiniFlow Authors. All Rights Reserved.
#
# Licensed under the Apache License, Version 2.0 (the "License");
# you may not use this file except in compliance with the License.
# You may obtain a copy of the License at
#
# http://www.apache.org/licenses/LICENSE-2.0
#
# Unless required by applicable law or agreed to in writing, software
# distributed under the License is distributed on an "AS IS" BASIS,
# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
# See the License for the specific language governing permissions and
# limitations under the License.
#
import logging
import re
from api.constants import NICKNAME_MAX_LENGTH
from common.constants import RetCode
# Match frontend NICKNAME_PATTERN: letters, numbers, space, and . _ ' -
_NICKNAME_PATTERN = re.compile(r"^[\w ._'-]+$", re.UNICODE)
def _reject_nickname(message: str) -> tuple[str, int]:
logging.warning("Nickname validation failed: %s", message)
return message, RetCode.ARGUMENT_ERROR
def validate_nickname(nickname: str | None) -> tuple[str | None, int | None]:
"""
Validate a user nickname/display name.
Returns:
A tuple of (error_message, error_code) if validation fails,
or (None, None) if validation passes.
"""
if not isinstance(nickname, (str, type(None))):
return _reject_nickname("Nickname must be a string.")
if nickname is None:
return _reject_nickname("Nickname is required.")
nickname = nickname.strip()
if not nickname:
return _reject_nickname("Nickname cannot be empty.")
if len(nickname) > NICKNAME_MAX_LENGTH:
return _reject_nickname(f"Nickname must be at most {NICKNAME_MAX_LENGTH} characters.")
if not _NICKNAME_PATTERN.fullmatch(nickname):
return _reject_nickname("Nickname contains invalid characters.")
return None, None