From 54f2bb109258976d6f23d7da06055d4a05239449 Mon Sep 17 00:00:00 2001
From: mikiher <mikiher@gmail.com>
Date: Thu, 4 Jul 2024 20:35:58 +0300
Subject: [PATCH] Add a Show Subtitles option

---
 client/components/app/BookShelfToolbar.vue    | 46 +++++++++++++++++++
 client/components/cards/LazyBookCard.vue      | 19 +++++++-
 .../tests/components/cards/LazyBookCard.cy.js | 12 ++++-
 client/store/user.js                          |  1 +
 4 files changed, 76 insertions(+), 2 deletions(-)

diff --git a/client/components/app/BookShelfToolbar.vue b/client/components/app/BookShelfToolbar.vue
index 9064c914..f763de89 100644
--- a/client/components/app/BookShelfToolbar.vue
+++ b/client/components/app/BookShelfToolbar.vue
@@ -88,11 +88,17 @@
 
         <ui-context-menu-dropdown v-if="contextMenuItems.length" :items="contextMenuItems" :menu-width="110" class="ml-2" @action="contextMenuAction" />
       </template>
+      <!-- home page -->
+      <template v-else-if="isHome">
+        <div class="flex-grow" />
+        <ui-context-menu-dropdown v-if="contextMenuItems.length" :items="contextMenuItems" :menu-width="110" class="ml-2" @action="contextMenuAction" />
+      </template>
       <!-- search page -->
       <template v-else-if="page === 'search'">
         <div class="flex-grow" />
         <p>{{ $strings.MessageSearchResultsFor }} "{{ searchQuery }}"</p>
         <div class="flex-grow" />
+        <ui-context-menu-dropdown v-if="contextMenuItems.length" :items="contextMenuItems" :menu-width="110" class="ml-2" @action="contextMenuAction" />
       </template>
       <!-- authors page -->
       <template v-else-if="page === 'authors'">
@@ -156,6 +162,8 @@ export default {
         })
       }
 
+      this.addSubtitlesMenuItem(items)
+
       return items
     },
     seriesSortItems() {
@@ -323,6 +331,8 @@ export default {
         })
       }
 
+      this.addSubtitlesMenuItem(items)
+
       return items
     },
     showPlaylists() {
@@ -330,9 +340,40 @@ export default {
     }
   },
   methods: {
+    addSubtitlesMenuItem(items) {
+      if (this.isBookLibrary && (!this.page || this.page === 'search')) {
+        if (this.settings.showSubtitles) {
+          items.push({
+            text: 'Hide Subtitles',
+            action: 'hide-subtitles'
+          })
+        } else {
+          items.push({
+            text: 'Show Subtitles',
+            action: 'show-subtitles'
+          })
+        }
+      }
+    },
+    handleSubtitlesAction(action) {
+      if (action === 'show-subtitles') {
+        this.settings.showSubtitles = true
+        this.updateShowSubtitles()
+        return true
+      }
+      if (action === 'hide-subtitles') {
+        this.settings.showSubtitles = false
+        this.updateShowSubtitles()
+        return true
+      }
+      return false
+    },
     contextMenuAction({ action }) {
       if (action === 'export-opml') {
         this.exportOPML()
+        return
+      } else if (this.handleSubtitlesAction(action)) {
+        return
       }
     },
     exportOPML() {
@@ -353,6 +394,8 @@ export default {
           return
         }
         this.markSeriesFinished()
+      } else if (this.handleSubtitlesAction(action)) {
+        return
       }
     },
     showOpenSeriesRSSFeed() {
@@ -482,6 +525,9 @@ export default {
     updateCollapseBookSeries() {
       this.saveSettings()
     },
+    updateShowSubtitles() {
+      this.saveSettings()
+    },
     updateAuthorSort() {
       this.saveSettings()
     },
diff --git a/client/components/cards/LazyBookCard.vue b/client/components/cards/LazyBookCard.vue
index 426a43d0..1ce2725f 100644
--- a/client/components/cards/LazyBookCard.vue
+++ b/client/components/cards/LazyBookCard.vue
@@ -132,6 +132,9 @@
           <widgets-explicit-indicator cy-id="explicitIndicator" v-if="isExplicit" />
         </ui-tooltip>
       </div>
+      <ui-tooltip v-if="showSubtitles" :text="displaySubtitle" :disabled="!displaySubtitleTruncated" direction="bottom" :delayOnShow="500" class="flex items-center">
+        <p cy-id="subtitle" class="truncate" ref="displaySubtitle" :style="{ fontSize: 0.6 + 'em' }">{{ displaySubtitle }}</p>
+      </ui-tooltip>
       <p cy-id="line2" class="truncate text-gray-400" :style="{ fontSize: 0.8 + 'em' }">{{ displayLineTwo || '&nbsp;' }}</p>
       <p cy-id="line3" v-if="displaySortLine" class="truncate text-gray-400" :style="{ fontSize: 0.8 + 'em' }">{{ displaySortLine }}</p>
     </div>
@@ -171,6 +174,7 @@ export default {
       selected: false,
       isSelectionMode: false,
       displayTitleTruncated: false,
+      displaySubtitleTruncated: false,
       showCoverBg: false
     }
   },
@@ -237,7 +241,7 @@ export default {
       return this._libraryItem.mediaType
     },
     isPodcast() {
-      return this.mediaType === 'podcast'
+      return this.mediaType === 'podcast' || this.store.getters['libraries/getCurrentLibraryMediaType'] === 'podcast'
     },
     isMusic() {
       return this.mediaType === 'music'
@@ -339,6 +343,13 @@ export default {
       if (this.collapsedSeries) return ignorePrefix ? this.collapsedSeries.nameIgnorePrefix : this.collapsedSeries.name
       return ignorePrefix ? this.mediaMetadata.titleIgnorePrefix : this.title || '\u00A0'
     },
+    displaySubtitle() {
+      if (!this.libraryItem) return '\u00A0'
+      if (this.collapsedSeries) return this.collapsedSeries.numBooks === 1 ? '1 book' : `${this.collapsedSeries.numBooks} books`
+      if (this.mediaMetadata.subtitle) return this.mediaMetadata.subtitle
+      if (this.mediaMetadata.seriesName) return this.mediaMetadata.seriesName
+      return ''
+    },
     displayLineTwo() {
       if (this.recentEpisode) return this.title
       if (this.isPodcast) return this.author
@@ -635,6 +646,9 @@ export default {
     },
     mediaItemShare() {
       return this._libraryItem.mediaItemShare || null
+    },
+    showSubtitles() {
+      return !this.isPodcast && this.store.getters['user/getUserSetting']('showSubtitles')
     }
   },
   methods: {
@@ -676,6 +690,9 @@ export default {
         if (this.$refs.displayTitle) {
           this.displayTitleTruncated = this.$refs.displayTitle.scrollWidth > this.$refs.displayTitle.clientWidth
         }
+        if (this.$refs.displaySubtitle) {
+          this.displaySubtitleTruncated = this.$refs.displaySubtitle.scrollWidth > this.$refs.displaySubtitle.clientWidth
+        }
       })
     },
     clickCard(e) {
diff --git a/client/cypress/tests/components/cards/LazyBookCard.cy.js b/client/cypress/tests/components/cards/LazyBookCard.cy.js
index 52a1f00b..c39c0302 100644
--- a/client/cypress/tests/components/cards/LazyBookCard.cy.js
+++ b/client/cypress/tests/components/cards/LazyBookCard.cy.js
@@ -11,7 +11,7 @@ function createMountOptions() {
     mediaType: 'book',
     media: {
       id: 'book1',
-      metadata: { title: 'The Fellowship of the Ring', titleIgnorePrefix: 'Fellowship of the Ring', authorName: 'J. R. R. Tolkien' },
+      metadata: { title: 'The Fellowship of the Ring', titleIgnorePrefix: 'Fellowship of the Ring', authorName: 'J. R. R. Tolkien', subtitle: 'The Lord of the Rings, Book 1' },
       numTracks: 1
     }
   }
@@ -138,6 +138,16 @@ describe('LazyBookCard', () => {
     })
   })
 
+  it('shows subtitle when showSubtitles settings is true', () => {
+    mountOptions.mocks.$store.getters['user/getUserSetting'] = (settingName) => {
+      if (settingName === 'showSubtitles') return true
+    }
+    cy.mount(LazyBookCard, mountOptions)
+
+    cy.get('&titleImageNotReady').should('be.hidden')
+    cy.get('&subtitle').should('be.visible').and('have.text', 'The Lord of the Rings, Book 1')
+  })
+
   it('shows overlay on mouseover', () => {
     cy.mount(LazyBookCard, mountOptions)
     cy.get('#book-card-0').trigger('mouseover')
diff --git a/client/store/user.js b/client/store/user.js
index 70746bc1..3555d63e 100644
--- a/client/store/user.js
+++ b/client/store/user.js
@@ -8,6 +8,7 @@ export const state = () => ({
     bookshelfCoverSize: 120,
     collapseSeries: false,
     collapseBookSeries: false,
+    showSubtitles: false,
     useChapterTrack: false,
     seriesSortBy: 'name',
     seriesSortDesc: false,