Implement support for custom usernames (#2036)

blued-gear · melroy89 · BentiGorlich · web-flow · commit 44ea96e0e66e · 2026-03-18T21:51:49.000Z
Co-authored-by: Melroy van den Berg &lt;melroy@melroy.org&gt;
Co-authored-by: BentiGorlich &lt;benjamin_g@posteo.de&gt;
diff --git a/migrations/Version20260224224633.php b/migrations/Version20260224224633.php
@@ -0,0 +1,33 @@
+<?php
+
+declare(strict_types=1);
+
+namespace DoctrineMigrations;
+
+use Doctrine\DBAL\Schema\Schema;
+use Doctrine\Migrations\AbstractMigration;
+
+/**
+ * Auto-generated Migration: Please modify to your needs!
+ */
+final class Version20260224224633 extends AbstractMigration
+{
+    public function getDescription(): string
+    {
+        return 'Add title to user';
+    }
+
+    public function up(Schema $schema): void
+    {
+        $this->addSql('ALTER TABLE "user" ADD title VARCHAR(255) DEFAULT NULL');
+        $this->addSql('ALTER TABLE "user" ADD title_ts tsvector GENERATED ALWAYS AS (to_tsvector(\'english\', title)) STORED');
+        $this->addSql('CREATE INDEX user_title_ts ON "user" USING GIN (title_ts)');
+    }
+
+    public function down(Schema $schema): void
+    {
+        $this->addSql('DROP INDEX user_title_ts');
+        $this->addSql('ALTER TABLE "user" DROP title_ts');
+        $this->addSql('ALTER TABLE "user" DROP title');
+    }
+}
diff --git a/src/Controller/Api/User/UserUpdateApi.php b/src/Controller/Api/User/UserUpdateApi.php
@@ -70,6 +70,7 @@ public function profile(
         $dto = $manager->createDto($this->getUserOrThrow());
 
         $dto->about = $deserialized->about;
+        $dto->title = $deserialized->title;
 
         $user = $manager->edit($this->getUserOrThrow(), $dto);
 
diff --git a/src/Controller/User/Profile/UserEditController.php b/src/Controller/User/Profile/UserEditController.php
@@ -154,7 +154,7 @@ private function handleForm(
         User $user,
     ): FormInterface|Response|null {
         try {
-            // Could thrown an error on event handlers (eg. onPostSubmit if a user upload an incorrect image)
+            // Could throw an error on event handlers (eg. onPostSubmit if a user upload an incorrect image)
             $form->handleRequest($request);
 
             if ($form->isSubmitted() && $form->has('currentPassword')) {
diff --git a/src/DTO/UserDto.php b/src/DTO/UserDto.php
@@ -7,6 +7,7 @@
 use App\DTO\Contracts\UserDtoInterface;
 use App\Entity\User;
 use App\Utils\RegPatterns;
+use App\Validator\NoSurroundingWhitespace;
 use App\Validator\Unique;
 use Symfony\Component\HttpFoundation\Request;
 use Symfony\Component\Validator\Constraints as Assert;
@@ -23,6 +24,9 @@ class UserDto implements UserDtoInterface
     #[Assert\Length(min: 2, max: self::MAX_USERNAME_LENGTH)]
     #[Assert\Regex(pattern: RegPatterns::USERNAME, match: true)]
     public ?string $username = null;
+    #[Assert\Length(min: 2, max: self::MAX_USERNAME_LENGTH)]
+    #[NoSurroundingWhitespace]
+    public ?string $title = null;
     #[Assert\NotBlank]
     #[Assert\Email]
     public ?string $email = null;
@@ -99,6 +103,7 @@ public static function create(
         ?int $reputationPoints = null,
         ?bool $discoverable = null,
         ?bool $indexable = null,
+        ?string $title = null,
     ): self {
         $dto = new UserDto();
         $dto->id = $id;
@@ -119,6 +124,7 @@ public static function create(
         $dto->reputationPoints = $reputationPoints;
         $dto->discoverable = $discoverable;
         $dto->indexable = $indexable;
+        $dto->title = $title;
 
         return $dto;
     }
diff --git a/src/DTO/UserProfileRequestDto.php b/src/DTO/UserProfileRequestDto.php
@@ -4,10 +4,17 @@
 
 namespace App\DTO;
 
+use App\Validator\NoSurroundingWhitespace;
 use OpenApi\Attributes as OA;
+use Symfony\Component\Validator\Constraints as Assert;
 
 #[OA\Schema()]
 class UserProfileRequestDto
 {
+    #[Assert\Length(min: 2, max: UserDto::MAX_ABOUT_LENGTH, countUnit: Assert\Length::COUNT_GRAPHEMES)]
     public ?string $about = null;
+
+    #[Assert\Length(min: 2, max: UserDto::MAX_USERNAME_LENGTH)]
+    #[NoSurroundingWhitespace]
+    public ?string $title = null;
 }
diff --git a/src/DTO/UserResponseDto.php b/src/DTO/UserResponseDto.php
@@ -13,6 +13,7 @@ class UserResponseDto implements \JsonSerializable
     public ?ImageDto $avatar = null;
     public ?ImageDto $cover = null;
     public string $username;
+    public ?string $title;
     public int $followersCount = 0;
     public ?string $about = null;
     public ?\DateTimeImmutable $createdAt = null;
@@ -41,6 +42,7 @@ public function __construct(UserDto $dto)
     {
         $this->userId = $dto->getId();
         $this->username = $dto->username;
+        $this->title = $dto->title;
         $this->about = $dto->about;
         $this->avatar = $dto->avatar;
         $this->cover = $dto->cover;
@@ -66,6 +68,7 @@ public function jsonSerialize(): mixed
         return [
             'userId' => $this->userId,
             'username' => $this->username,
+            'title' => $this->title,
             'about' => $this->about,
             'avatar' => $this->avatar?->jsonSerialize(),
             'cover' => $this->cover?->jsonSerialize(),
diff --git a/src/DTO/UserSmallResponseDto.php b/src/DTO/UserSmallResponseDto.php
@@ -11,6 +11,7 @@ class UserSmallResponseDto implements \JsonSerializable
 {
     public ?int $userId = null;
     public ?string $username = null;
+    public ?string $title = null;
     public ?bool $isBot = null;
     public ?bool $isFollowedByUser = null;
     public ?bool $isFollowerOfUser = null;
@@ -28,6 +29,7 @@ public function __construct(UserDto $dto)
     {
         $this->userId = $dto->getId();
         $this->username = $dto->username;
+        $this->title = $dto->title;
         $this->isBot = $dto->isBot;
         $this->isFollowedByUser = $dto->isFollowedByUser;
         $this->isFollowerOfUser = $dto->isFollowerOfUser;
@@ -47,6 +49,7 @@ public function jsonSerialize(): mixed
         return [
             'userId' => $this->userId,
             'username' => $this->username,
+            'title' => $this->title,
             'isBot' => $this->isBot,
             'isFollowedByUser' => $this->isFollowedByUser,
             'isFollowerOfUser' => $this->isFollowerOfUser,
diff --git a/src/Entity/Magazine.php b/src/Entity/Magazine.php
@@ -56,8 +56,6 @@ class Magazine implements VisibilityInterface, ActivityPubActorInterface, ApiRes
     public ?Image $banner = null;
     #[Column(type: 'string', nullable: false)]
     public string $name;
-    #[Column(type: 'string')]
-    public ?string $title;
     #[Column(type: 'text', length: self::MAX_DESCRIPTION_LENGTH, nullable: true)]
     public ?string $description = null;
     #[Column(type: 'text', length: self::MAX_RULES_LENGTH, nullable: true)]
diff --git a/src/Entity/Traits/ActivityPubActorTrait.php b/src/Entity/Traits/ActivityPubActorTrait.php
@@ -39,6 +39,9 @@ trait ActivityPubActorTrait
     #[Column(type: 'string', nullable: true)]
     public ?string $apPreferredUsername = null;
 
+    #[Column(type: 'string')]
+    public ?string $title = null;
+
     #[Column(type: 'boolean', nullable: true)]
     public ?bool $apDiscoverable = null;
 
diff --git a/src/Entity/User.php b/src/Entity/User.php
@@ -45,6 +45,7 @@
 #[Table(name: '`user`')]
 #[Index(columns: ['visibility'], name: 'user_visibility_idx')]
 #[Index(columns: ['username_ts'], name: 'user_username_ts')]
+#[Index(columns: ['title_ts'], name: 'user_title_ts')]
 #[Index(columns: ['about_ts'], name: 'user_about_ts')]
 #[UniqueConstraint(name: 'user_email_idx', columns: ['email'])]
 #[UniqueConstraint(name: 'user_username_idx', columns: ['username'])]
@@ -268,6 +269,8 @@ class User implements UserInterface, PasswordAuthenticatedUserInterface, Visibil
     #[Column(type: 'text', nullable: true, insertable: false, updatable: false, options: ['default' => null])]
     private ?string $usernameTs;
     #[Column(type: 'text', nullable: true, insertable: false, updatable: false, options: ['default' => null])]
+    private ?string $titleTs;
+    #[Column(type: 'text', nullable: true, insertable: false, updatable: false, options: ['default' => null])]
     private ?string $aboutTs;
 
     #[Column(type: 'enumApplicationStatus', nullable: false, options: ['default' => EApplicationStatus::Approved->value])]
diff --git a/src/Factory/ActivityPub/PersonFactory.php b/src/Factory/ActivityPub/PersonFactory.php
@@ -31,7 +31,7 @@ public function create(User $user, bool $context = true): array
             $person ?? [], [
                 'id' => $this->getActivityPubId($user),
                 'type' => $user->type,
-                'name' => $user->username,
+                'name' => $user->title ?? $user->getUsername(),
                 'preferredUsername' => $user->username,
                 'inbox' => $this->urlGenerator->generate(
                     'ap_user_inbox',
diff --git a/src/Factory/UserFactory.php b/src/Factory/UserFactory.php
@@ -43,6 +43,7 @@ public function createDto(User $user, ?int $reputationPoints = null): UserDto
             reputationPoints: $reputationPoints,
             discoverable: $user->apDiscoverable,
             indexable: $user->apIndexable,
+            title: $user->title,
         );
 
         // Only return the user's vote if permission to control voting has been given
diff --git a/src/Form/UserBasicType.php b/src/Form/UserBasicType.php
@@ -30,6 +30,7 @@ public function buildForm(FormBuilderInterface $builder, array $options): void
     {
         $builder
             ->add('username', TextType::class, ['required' => false])
+            ->add('title', TextType::class, ['required' => false])
             ->add('about', TextareaType::class, ['required' => false])
             ->add('submit', SubmitType::class);
 
diff --git a/src/Repository/SearchRepository.php b/src/Repository/SearchRepository.php
@@ -213,8 +213,8 @@ public function search(
                 $createdWhereMagazine $blockMagazineAndUserResult
         ";
 
-        $sqlUser = "SELECT u.Id, u.created_at, u.visibility, ts_rank_cd(u.username_ts, plainto_tsquery(:query)) + ts_rank_cd(u.about_ts, plainto_tsquery(:query)) as rank, 'user' AS type FROM \"user\" u
-            WHERE (u.username_ts @@ plainto_tsquery( :query ) = true OR u.about_ts @@ plainto_tsquery( :query ) = true OR u.username LIKE :likeQuery)
+        $sqlUser = "SELECT u.Id, u.created_at, u.visibility, ts_rank_cd(u.username_ts, plainto_tsquery(:query)) + ts_rank_cd(u.title_ts, plainto_tsquery(:query)) + ts_rank_cd(u.about_ts, plainto_tsquery(:query)) as rank, 'user' AS type FROM \"user\" u
+            WHERE (u.username_ts @@ plainto_tsquery( :query ) = true OR u.title_ts @@ plainto_tsquery( :query ) = true OR u.about_ts @@ plainto_tsquery( :query ) = true OR u.username LIKE :likeQuery)
                 AND u.visibility = :visibility
                 AND u.is_deleted = false
                 AND u.marked_for_deletion_at IS NULL
diff --git a/src/Service/ActivityPubManager.php b/src/Service/ActivityPubManager.php
@@ -387,6 +387,7 @@ private function updateUser(string $actorUrl): ?User
             $user->apFollowersUrl = $actor['followers'] ?? null;
             $user->apAttributedToUrl = $actor['attributedTo'] ?? null;
             $user->apPreferredUsername = $actor['preferredUsername'] ?? null;
+            $user->title = $actor['name'] ?? null;
             $user->apDiscoverable = $actor['discoverable'] ?? null;
             $user->apIndexable = $actor['indexable'] ?? null;
             $user->apManuallyApprovesFollowers = $actor['manuallyApprovesFollowers'] ?? false;
diff --git a/src/Service/UserManager.php b/src/Service/UserManager.php
@@ -207,6 +207,8 @@ public function edit(User $user, UserDto $dto): User
         try {
             $user->about = $dto->about;
 
+            $user->title = $dto->title;
+
             $oldAvatar = $user->avatar;
             if ($dto->avatar) {
                 $image = $this->imageRepository->find($dto->avatar->id);
diff --git a/src/Validator/NoSurroundingWhitespace.php b/src/Validator/NoSurroundingWhitespace.php
@@ -0,0 +1,32 @@
+<?php
+
+declare(strict_types=1);
+
+namespace App\Validator;
+
+use Symfony\Component\Validator\Attribute\HasNamedArguments;
+use Symfony\Component\Validator\Constraint;
+
+#[\Attribute(\Attribute::TARGET_PROPERTY)]
+class NoSurroundingWhitespace extends Constraint
+{
+    public const string NOT_UNIQUE_ERROR = '492764ab-760d-48da-8d2e-1d5f3e5fac4c';
+
+    protected const array ERROR_NAMES = [
+        self::NOT_UNIQUE_ERROR => 'NO_SURROUNDING_WHITESPACE_ERROR',
+    ];
+
+    public string $message = 'The value must not have whitespaces at the beginning or end.';
+
+    #[HasNamedArguments]
+    public function __construct(
+        public bool $allowEmpty = false,
+    ) {
+        parent::__construct();
+    }
+
+    public function getTargets(): array
+    {
+        return [Constraint::PROPERTY_CONSTRAINT];
+    }
+}
diff --git a/src/Validator/NoSurroundingWhitespaceValidator.php b/src/Validator/NoSurroundingWhitespaceValidator.php
@@ -0,0 +1,42 @@
+<?php
+
+declare(strict_types=1);
+
+namespace App\Validator;
+
+use Symfony\Component\Validator\Constraint;
+use Symfony\Component\Validator\ConstraintValidator;
+use Symfony\Component\Validator\Exception\UnexpectedTypeException;
+
+class NoSurroundingWhitespaceValidator extends ConstraintValidator
+{
+    public function validate($value, Constraint $constraint): void
+    {
+        if (!\is_string($value) && null !== $value) {
+            throw new UnexpectedTypeException($value, 'string');
+        }
+
+        if (!$constraint instanceof NoSurroundingWhitespace) {
+            throw new UnexpectedTypeException($constraint, NoSurroundingWhitespace::class);
+        }
+
+        if (null === $value) {
+            return;
+        }
+
+        if ('' === $value) {
+            if ($constraint->allowEmpty) {
+                return;
+            }
+            $this->context->buildViolation($constraint->message)
+                ->setCode(NoSurroundingWhitespace::NOT_UNIQUE_ERROR)
+                ->addViolation();
+        }
+
+        if (trim($value) !== $value) {
+            $this->context->buildViolation($constraint->message)
+                ->setCode(NoSurroundingWhitespace::NOT_UNIQUE_ERROR)
+                ->addViolation();
+        }
+    }
+}
diff --git a/templates/components/user_box.html.twig b/templates/components/user_box.html.twig
@@ -33,7 +33,7 @@
                     {% if stretchedLink %}
                         <h1>
                             <a class="link-muted stretched-link"
-                              href="{{ path('user_overview', {'username': user.username}) }}">{{ user.username|username(false) }}</a>
+                              href="{{ path('user_overview', {'username': user.username}) }}">{{ user.title ?? user.username|username(false) }}</a>
 
                             {% if (user.type) == "Service" %}
                               <code title="{{ 'user_badge_bot'|trans }}">{{ 'user_badge_bot'|trans }}</code>
@@ -54,7 +54,7 @@
                         </h1>
                     {% else %}
                         <h1>
-                            {{ user.apPreferredUsername ?? user.username|username(false) }}
+                            {{ user.title ?? user.apPreferredUsername ?? user.username|username(false) }}
 
                             {% if (user.type) == "Service" %}
                                 <code title="{{ 'user_badge_bot'|trans }}">{{ 'user_badge_bot'|trans }}</code>
diff --git a/templates/components/user_inline.html.twig b/templates/components/user_inline.html.twig
@@ -10,7 +10,7 @@
              src="{{ user.avatar.filePath ? (asset(user.avatar.filePath) | imagine_filter('avatar_thumb')) : user.avatar.sourceUrl }}"
              alt="{{ user.username ~' '~ 'avatar'|trans|lower }}">
     {% endif %}
-    {{ user.apPreferredUsername ?? user.username|username -}}
+    {{ user.title ?? user.apPreferredUsername ?? user.username|username -}}
     {%- if fullName is defined and fullName is same as true -%}
         @{{- user.username|apDomain -}}
     {%- endif -%}
diff --git a/templates/components/user_inline_box.html.twig b/templates/components/user_inline_box.html.twig
@@ -26,7 +26,7 @@
                           {% endif %}
                         {% endif %}
                         <h1>
-                            {{ user.apPreferredUsername ?? user.username|username(false) }}
+                            {{ user.title ?? user.apPreferredUsername ?? user.username|username(false) }}
 
                             {% if (user.type) == "Service" %}
                                 <code title="{{ 'user_badge_bot'|trans }}">{{ 'user_badge_bot'|trans }}</code>
diff --git a/templates/components/user_inline_md.html.twig b/templates/components/user_inline_md.html.twig
@@ -7,7 +7,7 @@
     }) }}
 {% else %}
     <a href="{{ path('user_overview', {username: user.username}) }}" title="{{ user.username|username(true) }}">
-        @{{- user.username|username -}}
+        @{{- user.title ?? user.username|username -}}
         {%- if fullName -%}
             @{{- user.username|apDomain -}}
         {%- endif -%}
diff --git a/templates/user/_info.html.twig b/templates/user/_info.html.twig
@@ -1,5 +1,5 @@
 <section class="section user-info">
-    <h3>{{ user.username|username }}</h3>
+    <h3>{{ user.title ?? user.username|username }}</h3>
     {% if is_route_name_starts_with('user_settings') %}
         <div class="row">
             {% if user.avatar %}
@@ -12,7 +12,7 @@
                 </figure>
             {% endif %}
             <h4><a href="{{ path('user_overview', {username:user.username}) }}"
-                   class="stretched-link">{{ user.username|username(false) }}</a></h4>
+                   class="stretched-link">{{ user.title ?? user.username|username(false) }}</a></h4>
             <p class="user__name">
                 {{ user.username|username }}{% if not user.apId %}@{{ kbin_domain() }}{% endif %}
                 {% if user.apManuallyApprovesFollowers is same as true %}
diff --git a/templates/user/_user_popover.html.twig b/templates/user/_user_popover.html.twig
@@ -10,7 +10,7 @@
         {% endif %}
         <div>
             <h3>
-                <a class="link-muted" href="{{ path('user_overview', {username: user.username}) }}">{{ user.username|username }}</a>
+                <a class="link-muted" href="{{ path('user_overview', {username: user.username}) }}">{{ user.title ?? user.username|username }}</a>
                 {% if user.isNew() %}
                     {% set days = constant('App\\Entity\\User::NEW_FOR_DAYS') %}
                     <i class="fa-solid fa-leaf new-user-icon" title="{{ 'new_user_description'|trans({ '%days%': days }) }}" aria-description="{{ 'new_user_description'|trans({ '%days%': days }) }}"></i>
diff --git a/templates/user/settings/profile.html.twig b/templates/user/settings/profile.html.twig
diff --git a/tests/Functional/ActivityPub/Inbox/UpdateHandlerTest.php b/tests/Functional/ActivityPub/Inbox/UpdateHandlerTest.php
diff --git a/tests/Functional/Controller/Api/User/UserUpdateApiTest.php b/tests/Functional/Controller/Api/User/UserUpdateApiTest.php
diff --git a/tests/Functional/Controller/User/Profile/UserEditControllerTest.php b/tests/Functional/Controller/User/Profile/UserEditControllerTest.php
diff --git a/tests/Unit/ActivityPub/Outbox/JsonSnapshots/UpdateTest__testUpdateUser__1.json b/tests/Unit/ActivityPub/Outbox/JsonSnapshots/UpdateTest__testUpdateUser__1.json
diff --git a/tests/Unit/ActivityPub/Outbox/UpdateTest.php b/tests/Unit/ActivityPub/Outbox/UpdateTest.php
diff --git a/tests/WebTestCase.php b/tests/WebTestCase.php
diff --git a/translations/messages.en.yaml b/translations/messages.en.yaml
