Add published decade filter option (#3489)

* Add strings for PublishedDecade and PublishedDecades

* Add publishedDecades filter options to LibraryFilterSelect

* Add publishedDecades to libraries store

* Add publishedDecades to getFilterData

* Add database method to add published decades to filter data

* Add published decade in BookScanner

* Add 'publishedDecades' to invalidFilters in user.js

* Add publishedDecades filter group to MediaGroupQuery

* Update client/strings/en-us.json

* Auto formatting

---------

Co-authored-by: advplyr <dev@advplyr.com>
Co-authored-by: advplyr <advplyr@protonmail.com>

client/components/controls/LibraryFilterSelect.vue

@@ -189,6 +189,12 @@ export default {
           value: 'publishers',
           sublist: true
         },
+        {
+          text: this.$strings.LabelPublishedDecade,
+          textPlural: this.$strings.LabelPublishedDecades,
+          value: 'publishedDecades',
+          sublist: true
+        },
         {
           text: this.$strings.LabelLanguage,
           textPlural: this.$strings.LabelLanguages,
@@ -338,6 +344,9 @@ export default {
     publishers() {
       return this.filterData.publishers || []
     },
+    publishedDecades() {
+      return this.filterData.publishedDecades || []
+    },
     progress() {
       return [
         {

client/store/libraries.js

@@ -240,7 +240,8 @@ export const mutations = {
       series: [],
       narrators: [],
       languages: [],
-      publishers: []
+      publishers: [],
+      publishedDecades: []
     }
     */
     const mediaMetadata = libraryItem.media.metadata
@@ -307,6 +308,16 @@ export const mutations = {
       state.filterData.publishers.sort((a, b) => a.localeCompare(b))
     }
 
+    // Add publishedDecades
+    if (mediaMetadata.publishedYear) {
+      const publishedYear = parseInt(mediaMetadata.publishedYear, 10)
+      const decade = Math.floor(publishedYear / 10) * 10
+      if (!state.filterData.publishedDecades.includes(decade)) {
+        state.filterData.publishedDecades.push(decade)
+        state.filterData.publishedDecades.sort((a, b) => a - b)
+      }
+    }
+
     // Add language
     if (mediaMetadata.language && !state.filterData.languages.includes(mediaMetadata.language)) {
       state.filterData.languages.push(mediaMetadata.language)

client/store/user.js

@@ -90,7 +90,7 @@ export const actions = {
       if (state.settings.orderBy == 'media.metadata.publishedYear') {
         settingsUpdate.orderBy = 'media.metadata.title'
       }
-      const invalidFilters = ['series', 'authors', 'narrators', 'publishers', 'languages', 'progress', 'issues', 'ebooks', 'abridged']
+      const invalidFilters = ['series', 'authors', 'narrators', 'publishers', 'publishedDecades', 'languages', 'progress', 'issues', 'ebooks', 'abridged']
       const filterByFirstPart = (state.settings.filterBy || '').split('.').shift()
       if (invalidFilters.includes(filterByFirstPart)) {
         settingsUpdate.filterBy = 'all'

client/strings/en-us.json

@@ -465,6 +465,8 @@
   "LabelPubDate": "Pub Date",
   "LabelPublishYear": "Publish Year",
   "LabelPublishedDate": "Published {0}",
+  "LabelPublishedDecade": "Published Decade",
+  "LabelPublishedDecades": "Published Decades",
   "LabelPublisher": "Publisher",
   "LabelPublishers": "Publishers",
   "LabelRSSFeedCustomOwnerEmail": "Custom owner Email",

server/Database.js

@@ -607,6 +607,11 @@ class Database {
     this.libraryFilterData[libraryId].publishers.push(publisher)
   }
 
+  addPublishedDecadeToFilterData(libraryId, decade) {
+    if (!this.libraryFilterData[libraryId] || !decade || this.libraryFilterData[libraryId].publishedDecades.includes(decade)) return
+    this.libraryFilterData[libraryId].publishedDecades.push(decade)
+  }
+
   addLanguageToFilterData(libraryId, language) {
     if (!this.libraryFilterData[libraryId] || !language || this.libraryFilterData[libraryId].languages.includes(language)) return
     this.libraryFilterData[libraryId].languages.push(language)

server/scanner/BookScanner.js

@@ -590,6 +590,10 @@ class BookScanner {
     Database.addPublisherToFilterData(libraryItemData.libraryId, libraryItem.book.publisher)
     Database.addLanguageToFilterData(libraryItemData.libraryId, libraryItem.book.language)
 
+    const publishedYear = libraryItem.book.publishedYear
+    const decade = publishedYear ? `${Math.floor(publishedYear / 10) * 10}` : null
+    Database.addPublishedDecadeToFilterData(libraryItemData.libraryId, decade)
+
     // Load for emitting to client
     libraryItem.media = await libraryItem.getMedia({
       include: [

server/utils/queries/libraryFilters.js

@@ -26,7 +26,7 @@ module.exports = {
     let filterValue = null
     let filterGroup = null
     if (filterBy) {
-      const searchGroups = ['genres', 'tags', 'series', 'authors', 'progress', 'narrators', 'publishers', 'missing', 'languages', 'tracks', 'ebooks']
+      const searchGroups = ['genres', 'tags', 'series', 'authors', 'progress', 'narrators', 'publishers', 'publishedDecades', 'missing', 'languages', 'tracks', 'ebooks']
       const group = searchGroups.find((_group) => filterBy.startsWith(_group + '.'))
       filterGroup = group || filterBy
       filterValue = group ? this.decode(filterBy.replace(`${group}.`, '')) : null
@@ -458,6 +458,7 @@ module.exports = {
       narrators: new Set(),
       languages: new Set(),
       publishers: new Set(),
+      publishedDecades: new Set(),
       numIssues: 0
     }
 
@@ -492,7 +493,7 @@ module.exports = {
             libraryId: libraryId
           }
         },
-        attributes: ['tags', 'genres', 'publisher', 'narrators', 'language']
+        attributes: ['tags', 'genres', 'publisher', 'publishedYear', 'narrators', 'language']
       })
       for (const book of books) {
         if (book.libraryItem.isMissing || book.libraryItem.isInvalid) data.numIssues++
@@ -506,6 +507,11 @@ module.exports = {
           book.narrators.forEach((narrator) => data.narrators.add(narrator))
         }
         if (book.publisher) data.publishers.add(book.publisher)
+        // Check if published year exists and is valid
+        if (book.publishedYear && !isNaN(book.publishedYear) && book.publishedYear > 0 && book.publishedYear < 3000 && book.publishedYear.toString().length === 4) {
+          const decade = Math.floor(book.publishedYear / 10) * 10
+          data.publishedDecades.add(decade.toString())
+        }
         if (book.language) data.languages.add(book.language)
       }
 
@@ -532,6 +538,7 @@ module.exports = {
     data.series = naturalSort(data.series).asc((se) => se.name)
     data.narrators = naturalSort([...data.narrators]).asc()
     data.publishers = naturalSort([...data.publishers]).asc()
+    data.publishedDecades = naturalSort([...data.publishedDecades]).asc()
     data.languages = naturalSort([...data.languages]).asc()
     data.loadedAt = Date.now()
     Database.libraryFilterData[libraryId] = data

server/utils/queries/libraryItemsBookFilters.js

@@ -228,6 +228,11 @@ module.exports = {
       } else if (value === 'series') {
         mediaWhere['$series.id$'] = null
       }
+    } else if (group === 'publishedDecades') {
+      const year = parseInt(value, 10)
+      mediaWhere['publishedYear'] = {
+        [Sequelize.Op.between]: year >= 1000 ? [year, year + 9] : [year * 10, (year + 1) * 10 - 1]
+      }
     }
 
     return { mediaWhere, replacements }