From c0294f4c39fe257c7454987f4c80c24ea1738eb4 Mon Sep 17 00:00:00 2001
From: zipben <zipben@gmail.com>
Date: Wed, 4 Jun 2025 16:04:28 +0000
Subject: [PATCH] added display name to users

---
 .gitignore                                    |  1 +
 client/components/app/Appbar.vue              |  2 +-
 client/components/modals/AccountModal.vue     |  6 ++++
 client/components/tables/UsersTable.vue       |  4 +++
 client/pages/account.vue                      | 33 ++++++++++++++++++-
 client/pages/config/users/_id/index.vue       |  2 +-
 client/pages/config/users/_id/sessions.vue    |  2 +-
 client/pages/item/_id/index.vue               |  4 ++-
 client/pages/user/_id/index.vue               |  2 +-
 package.json                                  |  2 +-
 server/controllers/LibraryItemController.js   |  8 ++---
 server/controllers/MeController.js            |  6 +++-
 server/controllers/UserController.js          | 25 +++++++++++++-
 .../v2.24.1-add-user-display-name.js          | 22 +++++++++++++
 server/models/Comment.js                      |  3 +-
 server/models/User.js                         |  4 +++
 16 files changed, 112 insertions(+), 14 deletions(-)
 create mode 100644 server/migrations/v2.24.1-add-user-display-name.js

diff --git a/.gitignore b/.gitignore
index 12ebec1c2..b6d6f25dd 100644
--- a/.gitignore
+++ b/.gitignore
@@ -8,6 +8,7 @@
 /media/
 /metadata/
 /plugins/
+*.epub
 /client/.nuxt/
 /client/dist/
 /dist/
diff --git a/client/components/app/Appbar.vue b/client/components/app/Appbar.vue
index 2f29b5688..cbd0a96f3 100644
--- a/client/components/app/Appbar.vue
+++ b/client/components/app/Appbar.vue
@@ -116,7 +116,7 @@ export default {
       return this.$store.getters['user/getIsAdminOrUp']
     },
     username() {
-      return this.user ? this.user.username : 'err'
+      return this.user ? this.user.displayName || this.user.username : 'err'
     },
     numMediaItemsSelected() {
       return this.selectedMediaItems.length
diff --git a/client/components/modals/AccountModal.vue b/client/components/modals/AccountModal.vue
index 71ac81550..c291a7a99 100644
--- a/client/components/modals/AccountModal.vue
+++ b/client/components/modals/AccountModal.vue
@@ -18,9 +18,14 @@
             </div>
           </div>
           <div v-show="!isEditingRoot" class="flex py-2">
+            <div class="w-1/2 px-2">
+              <ui-text-input-with-label v-model.trim="newUser.displayName" :label="'Display Name'" />
+            </div>
             <div class="w-1/2 px-2">
               <ui-text-input-with-label v-model.trim="newUser.email" :label="$strings.LabelEmail" />
             </div>
+          </div>
+          <div v-show="!isEditingRoot" class="flex py-2">
             <div class="px-2 w-52">
               <ui-dropdown v-model="newUser.type" :label="$strings.LabelAccountType" :disabled="isEditingRoot" :items="accountTypes" small @input="userTypeUpdated" />
             </div>
@@ -387,6 +392,7 @@ export default {
           username: null,
           email: null,
           password: null,
+          displayName: null,
           type: 'user',
           isActive: true,
           permissions: {
diff --git a/client/components/tables/UsersTable.vue b/client/components/tables/UsersTable.vue
index 20f412288..00a211de0 100644
--- a/client/components/tables/UsersTable.vue
+++ b/client/components/tables/UsersTable.vue
@@ -4,6 +4,7 @@
       <table id="accounts">
         <tr>
           <th>{{ $strings.LabelUsername }}</th>
+          <th>{{ $strings.LabelDisplayName }}</th>
           <th class="w-20">{{ $strings.LabelAccountType }}</th>
           <th class="hidden lg:table-cell">{{ $strings.LabelActivity }}</th>
           <th class="w-32 hidden sm:table-cell">{{ $strings.LabelLastSeen }}</th>
@@ -17,6 +18,9 @@
               <p class="pl-2 truncate">{{ user.username }}</p>
             </div>
           </td>
+          <td>
+            <p class="truncate">{{ user.displayName || '-' }}</p>
+          </td>
           <td class="text-sm">{{ user.type }}</td>
           <td class="hidden lg:table-cell">
             <div v-if="usersOnline[user.id]?.session?.displayTitle">
diff --git a/client/pages/account.vue b/client/pages/account.vue
index b157f5704..3ea112aad 100644
--- a/client/pages/account.vue
+++ b/client/pages/account.vue
@@ -12,6 +12,16 @@
             <ui-text-input-with-label disabled :value="usertype" :label="$strings.LabelAccountType" />
           </div>
         </div>
+        <form @submit.prevent="submitDisplayName">
+          <div class="flex -mx-2 mt-4">
+            <div class="w-2/3 px-2">
+              <ui-text-input-with-label v-model="displayNameInput" :label="'Display Name'" />
+            </div>
+            <div class="px-2 flex items-end">
+              <ui-btn type="submit" color="bg-success">Update</ui-btn>
+            </div>
+          </div>
+        </form>
         <div class="py-4">
           <p class="px-1 text-sm font-semibold">{{ $strings.LabelLanguage }}</p>
           <ui-dropdown v-model="selectedLanguage" :items="$languageCodeOptions" small class="max-w-48" @input="updateLocalLanguage" />
@@ -88,6 +98,7 @@ export default {
       confirmPassword: null,
       changingPassword: false,
       selectedLanguage: '',
+      displayNameInput: '',
       newEReaderDevice: {
         name: '',
         email: ''
@@ -103,7 +114,9 @@ export default {
       return this.$store.state.streamLibraryItem
     },
     user() {
-      return this.$store.state.user.user || null
+      const user = this.$store.state.user.user || null
+      console.log('[Account Page] Current user object:', user)
+      return user
     },
     username() {
       return this.user.username
@@ -111,6 +124,9 @@ export default {
     usertype() {
       return this.user.type
     },
+    displayName() {
+      return this.user.displayName || ''
+    },
     isRoot() {
       return this.usertype === 'root'
     },
@@ -237,11 +253,26 @@ export default {
     },
     ereaderDevicesUpdated(ereaderDevices) {
       this.ereaderDevices = ereaderDevices
+    },
+    async submitDisplayName() {
+      try {
+        await this.$axios.$patch(`/api/users/${this.user.id}`, {
+          displayName: this.displayNameInput
+        })
+        this.$toast.success('Display name updated successfully')
+        // Update the user in the store
+        const user = { ...this.user, displayName: this.displayNameInput }
+        this.$store.commit('user/setUser', user)
+      } catch (error) {
+        console.error('Failed to update display name:', error)
+        this.$toast.error('Failed to update display name')
+      }
     }
   },
   mounted() {
     this.selectedLanguage = this.$languageCodes.current
     this.ereaderDevices = this.$store.state.libraries.ereaderDevices || []
+    this.displayNameInput = this.displayName
   }
 }
 </script>
diff --git a/client/pages/config/users/_id/index.vue b/client/pages/config/users/_id/index.vue
index e2f8e2086..ff3aabe3f 100644
--- a/client/pages/config/users/_id/index.vue
+++ b/client/pages/config/users/_id/index.vue
@@ -107,7 +107,7 @@ export default {
       return this.$store.getters['libraries/getBookCoverAspectRatio']
     },
     username() {
-      return this.user.username
+      return this.user.displayName || this.user.username
     },
     userOnline() {
       return this.$store.getters['users/getIsUserOnline'](this.user.id)
diff --git a/client/pages/config/users/_id/sessions.vue b/client/pages/config/users/_id/sessions.vue
index ab33b4b1c..7f7cab227 100644
--- a/client/pages/config/users/_id/sessions.vue
+++ b/client/pages/config/users/_id/sessions.vue
@@ -92,7 +92,7 @@ export default {
   },
   computed: {
     username() {
-      return this.user.username
+      return this.user.displayName || this.user.username
     },
     userOnline() {
       return this.$store.getters['users/getIsUserOnline'](this.user.id)
diff --git a/client/pages/item/_id/index.vue b/client/pages/item/_id/index.vue
index 6fe00fbb2..bc229acb1 100644
--- a/client/pages/item/_id/index.vue
+++ b/client/pages/item/_id/index.vue
@@ -189,7 +189,7 @@
                   <div v-for="comment in sortedComments" :key="comment.id" class="bg-bg border rounded-lg p-4" :class="comment.userId === currentUser.id ? 'border-white border-4' : 'border-gray-700'">
                     <div class="flex justify-between items-start mb-2">
                       <div>
-                        <nuxt-link :to="'/user/' + comment.userId" class="font-semibold hover:text-white hover:underline">{{ comment.user.username }}</nuxt-link>
+                        <nuxt-link :to="'/user/' + comment.userId" class="font-semibold hover:text-white hover:underline">{{ comment.user.displayName || comment.user.username }}</nuxt-link>
                         <span class="text-sm text-gray-400 ml-2">
                           {{ formatDate(comment.createdAt) }}
                         </span>
@@ -1012,6 +1012,7 @@ export default {
     this.$root.socket.on('episode_download_started', this.episodeDownloadStarted)
     this.$root.socket.on('episode_download_finished', this.episodeDownloadFinished)
     this.$root.socket.on('episode_download_queue_cleared', this.episodeDownloadQueueCleared)
+    this.$root.socket.on('user_updated', this.loadComments)
   },
   beforeDestroy() {
     this.$eventBus.$off(`${this.libraryItem.id}_updated`, this.libraryItemUpdated)
@@ -1024,6 +1025,7 @@ export default {
     this.$root.socket.off('episode_download_started', this.episodeDownloadStarted)
     this.$root.socket.off('episode_download_finished', this.episodeDownloadFinished)
     this.$root.socket.off('episode_download_queue_cleared', this.episodeDownloadQueueCleared)
+    this.$root.socket.off('user_updated', this.loadComments)
   }
 }
 </script>
diff --git a/client/pages/user/_id/index.vue b/client/pages/user/_id/index.vue
index 52652928c..cabe099b8 100644
--- a/client/pages/user/_id/index.vue
+++ b/client/pages/user/_id/index.vue
@@ -2,7 +2,7 @@
   <div class="bg-bg min-h-screen">
     <div class="max-w-6xl mx-auto px-4 py-8">
       <div v-if="user" class="mb-8">
-        <h1 class="text-3xl font-semibold mb-2">{{ user.username }}'s Profile</h1>
+        <h1 class="text-3xl font-semibold mb-2">{{ user.displayName || user.username }}'s Profile</h1>
         <p class="text-gray-400">Member since {{ formatDate(user.createdAt) }}</p>
       </div>
 
diff --git a/package.json b/package.json
index d4831736d..ad202a939 100644
--- a/package.json
+++ b/package.json
@@ -1,6 +1,6 @@
 {
   "name": "audiobookshelf",
-  "version": "2.24.0",
+  "version": "2.24.1",
   "buildNumber": 1,
   "description": "Self-hosted audiobook and podcast server",
   "main": "index.js",
diff --git a/server/controllers/LibraryItemController.js b/server/controllers/LibraryItemController.js
index 99831cbcd..ca8a4c314 100644
--- a/server/controllers/LibraryItemController.js
+++ b/server/controllers/LibraryItemController.js
@@ -82,7 +82,7 @@ class LibraryItemController {
         include: [{
           model: Database.userModel,
           as: 'user',
-          attributes: ['id', 'username']
+          attributes: ['id', 'username', 'displayName']
         }],
         order: [['createdAt', 'DESC']]
       })
@@ -1224,7 +1224,7 @@ class LibraryItemController {
         include: [{
           model: Database.userModel,
           as: 'user',
-          attributes: ['id', 'username']
+          attributes: ['id', 'username', 'displayName']
         }],
         order: [['createdAt', 'DESC']]
       })
@@ -1267,7 +1267,7 @@ class LibraryItemController {
         include: [{
           model: Database.userModel,
           as: 'user',
-          attributes: ['id', 'username']
+          attributes: ['id', 'username', 'displayName']
         }]
       })
 
@@ -1291,7 +1291,7 @@ class LibraryItemController {
         include: [{
           model: Database.userModel,
           as: 'user',
-          attributes: ['id', 'username']
+          attributes: ['id', 'username', 'displayName']
         }]
       })
 
diff --git a/server/controllers/MeController.js b/server/controllers/MeController.js
index 87acd2211..4bc71dbc0 100644
--- a/server/controllers/MeController.js
+++ b/server/controllers/MeController.js
@@ -23,7 +23,11 @@ class MeController {
    * @param {Response} res
    */
   getCurrentUser(req, res) {
-    res.json(req.user.toOldJSONForBrowser())
+    const userJson = req.user.toOldJSONForBrowser()
+    Logger.info('[MeController] getCurrentUser response:', {
+      user: userJson
+    })
+    res.json(userJson)
   }
 
   /**
diff --git a/server/controllers/UserController.js b/server/controllers/UserController.js
index 9a0e7f9ec..1f5b35a8f 100644
--- a/server/controllers/UserController.js
+++ b/server/controllers/UserController.js
@@ -172,6 +172,7 @@ class UserController {
       type: userType,
       username: req.body.username,
       email: typeof req.body.email === 'string' ? req.body.email : null,
+      displayName: typeof req.body.displayName === 'string' ? req.body.displayName : null,
       pash,
       token,
       isActive: !!req.body.isActive,
@@ -203,6 +204,13 @@ class UserController {
    * @param {Response} res
    */
   async update(req, res) {
+    Logger.info('[UserController] Update request:', {
+      params: req.params,
+      body: req.body,
+      user: req.user?.username,
+      reqUser: req.reqUser?.username
+    })
+
     const user = req.reqUser
 
     if (user.isRoot && !req.user.isRoot) {
@@ -228,6 +236,9 @@ class UserController {
     if (updatePayload.username && typeof updatePayload.username !== 'string') {
       return res.status(400).send('Invalid username')
     }
+    if (updatePayload.displayName && typeof updatePayload.displayName !== 'string') {
+      return res.status(400).send('Invalid display name')
+    }
     if (updatePayload.type && !Database.userModel.accountTypes.includes(updatePayload.type)) {
       return res.status(400).send('Invalid account type')
     }
@@ -322,6 +333,10 @@ class UserController {
       user.lastSeen = updatePayload.lastSeen
       hasUpdates = true
     }
+    if (updatePayload.displayName !== undefined) {
+      user.displayName = updatePayload.displayName
+      hasUpdates = true
+    }
 
     if (hasUpdates) {
       if (shouldUpdateToken) {
@@ -474,6 +489,14 @@ class UserController {
    * @param {NextFunction} next
    */
   async middleware(req, res, next) {
+    Logger.info('[UserController] Middleware request:', {
+      method: req.method,
+      path: req.path,
+      params: req.params,
+      userId: req.user?.id,
+      username: req.user?.username
+    })
+
     if (!req.user.isAdminOrUp && req.user.id !== req.params.id) {
       return res.sendStatus(403)
     } else if ((req.method == 'PATCH' || req.method == 'POST' || req.method == 'DELETE') && !req.user.isAdminOrUp) {
@@ -505,7 +528,7 @@ class UserController {
         include: [{
           model: Database.userModel,
           as: 'user',
-          attributes: ['id', 'username']
+          attributes: ['id', 'username', 'displayName']
         }],
         order: [['createdAt', 'DESC']]
       })
diff --git a/server/migrations/v2.24.1-add-user-display-name.js b/server/migrations/v2.24.1-add-user-display-name.js
new file mode 100644
index 000000000..df25e3177
--- /dev/null
+++ b/server/migrations/v2.24.1-add-user-display-name.js
@@ -0,0 +1,22 @@
+const { DataTypes } = require('sequelize')
+
+async function up({ context: { queryInterface, logger } }) {
+  logger.info('[Migration] Adding displayName column to users table')
+
+  await queryInterface.addColumn('users', 'displayName', {
+    type: DataTypes.STRING,
+    allowNull: true
+  })
+
+  logger.info('[Migration] Successfully added displayName column to users table')
+}
+
+async function down({ context: { queryInterface, logger } }) {
+  logger.info('[Migration] Removing displayName column from users table')
+
+  await queryInterface.removeColumn('users', 'displayName')
+
+  logger.info('[Migration] Successfully removed displayName column from users table')
+}
+
+module.exports = { up, down } 
\ No newline at end of file
diff --git a/server/models/Comment.js b/server/models/Comment.js
index 827e93793..3e5ac346d 100644
--- a/server/models/Comment.js
+++ b/server/models/Comment.js
@@ -83,7 +83,8 @@ class Comment extends Model {
       updatedAt: this.updatedAt,
       user: this.user ? {
         id: this.user.id,
-        username: this.user.username
+        username: this.user.username,
+        displayName: this.user.displayName
       } : null
     }
   }
diff --git a/server/models/User.js b/server/models/User.js
index 999c80b2c..1ab70ebd1 100644
--- a/server/models/User.js
+++ b/server/models/User.js
@@ -87,6 +87,8 @@ class User extends Model {
     /** @type {string} */
     this.username
     /** @type {string} */
+    this.displayName
+    /** @type {string} */
     this.email
     /** @type {string} */
     this.pash
@@ -425,6 +427,7 @@ class User extends Model {
           primaryKey: true
         },
         username: DataTypes.STRING,
+        displayName: DataTypes.STRING,
         email: DataTypes.STRING,
         pash: DataTypes.STRING,
         type: DataTypes.STRING,
@@ -518,6 +521,7 @@ class User extends Model {
     const json = {
       id: this.id,
       username: this.username,
+      displayName: this.displayName,
       email: this.email,
       type: this.type,
       token: this.type === 'root' && hideRootToken ? '' : this.token,