Merge remote-tracking branch 'origin/master' into auth_passportjs

server/objects/LibraryItem.js

@@ -9,6 +9,7 @@ const Podcast = require('./mediaTypes/Podcast')
 const Video = require('./mediaTypes/Video')
 const Music = require('./mediaTypes/Music')
 const { areEquivalent, copyValue, getId, cleanStringForSearch } = require('../utils/index')
+const { filePathToPOSIX } = require('../utils/fileUtils')
 
 class LibraryItem {
   constructor(libraryItem = null) {
@@ -368,7 +369,7 @@ class LibraryItem {
       const fileFoundCheck = this.checkFileFound(lf, true)
       if (fileFoundCheck === null) {
         newLibraryFiles.push(lf)
-      } else if (fileFoundCheck && lf.metadata.format !== 'abs') { // Ignore abs file updates
+      } else if (fileFoundCheck && lf.metadata.format !== 'abs' && lf.metadata.filename !== 'metadata.json') { // Ignore abs file updates
         hasUpdated = true
         existingLibraryFiles.push(lf)
       } else {
@@ -499,14 +500,56 @@ class LibraryItem {
       // Make sure metadata book dir exists
       await fs.ensureDir(metadataPath)
     }
-    metadataPath = Path.join(metadataPath, 'metadata.abs')
 
-    return abmetadataGenerator.generate(this, metadataPath).then((success) => {
-      this.isSavingMetadata = false
-      if (!success) Logger.error(`[LibraryItem] Failed saving abmetadata to "${metadataPath}"`)
-      else Logger.debug(`[LibraryItem] Success saving abmetadata to "${metadataPath}"`)
-      return success
-    })
+    const metadataFileFormat = global.ServerSettings.metadataFileFormat
+    const metadataFilePath = Path.join(metadataPath, `metadata.${metadataFileFormat}`)
+    if (metadataFileFormat === 'json') {
+      // Remove metadata.abs if it exists
+      if (await fs.pathExists(Path.join(metadataPath, `metadata.abs`))) {
+        Logger.debug(`[LibraryItem] Removing metadata.abs for item "${this.media.metadata.title}"`)
+        await fs.remove(Path.join(metadataPath, `metadata.abs`))
+        this.libraryFiles = this.libraryFiles.filter(lf => lf.metadata.path !== filePathToPOSIX(Path.join(metadataPath, `metadata.abs`)))
+      }
+
+      return fs.writeFile(metadataFilePath, JSON.stringify(this.media.toJSONForMetadataFile(), null, 2)).then(async () => {
+        this.isSavingMetadata = false
+        // Add metadata.json to libraryFiles array if it is new
+        if (global.ServerSettings.storeMetadataWithItem && !this.libraryFiles.some(lf => lf.metadata.path === filePathToPOSIX(metadataFilePath))) {
+          const newLibraryFile = new LibraryFile()
+          await newLibraryFile.setDataFromPath(metadataFilePath, `metadata.json`)
+          this.libraryFiles.push(newLibraryFile)
+        }
+
+        return true
+      }).catch((error) => {
+        this.isSavingMetadata = false
+        Logger.error(`[LibraryItem] Failed to save json file at "${metadataFilePath}"`, error)
+        return false
+      })
+    } else {
+      // Remove metadata.json if it exists
+      if (await fs.pathExists(Path.join(metadataPath, `metadata.json`))) {
+        Logger.debug(`[LibraryItem] Removing metadata.json for item "${this.media.metadata.title}"`)
+        await fs.remove(Path.join(metadataPath, `metadata.json`))
+        this.libraryFiles = this.libraryFiles.filter(lf => lf.metadata.path !== filePathToPOSIX(Path.join(metadataPath, `metadata.json`)))
+      }
+
+      return abmetadataGenerator.generate(this, metadataFilePath).then(async (success) => {
+        this.isSavingMetadata = false
+        if (!success) Logger.error(`[LibraryItem] Failed saving abmetadata to "${metadataFilePath}"`)
+        else {
+          // Add metadata.abs to libraryFiles array if it is new
+          if (global.ServerSettings.storeMetadataWithItem && !this.libraryFiles.some(lf => lf.metadata.path === filePathToPOSIX(metadataFilePath))) {
+            const newLibraryFile = new LibraryFile()
+            await newLibraryFile.setDataFromPath(metadataFilePath, `metadata.abs`)
+            this.libraryFiles.push(newLibraryFile)
+          }
+
+          Logger.debug(`[LibraryItem] Success saving abmetadata to "${metadataFilePath}"`)
+        }
+        return success
+      })
+    }
   }
 
   removeLibraryFile(ino) {

server/objects/PlaybackSession.js

@@ -177,7 +177,7 @@ class PlaybackSession {
     this.episodeId = episodeId
     this.mediaType = libraryItem.mediaType
     this.mediaMetadata = libraryItem.media.metadata.clone()
-    this.chapters = (libraryItem.media.chapters || []).map(c => ({ ...c })) // Only book mediaType has chapters
+    this.chapters = libraryItem.media.getChapters(episodeId)
     this.displayTitle = libraryItem.media.getPlaybackTitle(episodeId)
     this.displayAuthor = libraryItem.media.getPlaybackAuthor()
     this.coverPath = libraryItem.media.coverPath

server/objects/files/LibraryFile.js

@@ -1,5 +1,5 @@
 const Path = require('path')
-const { getFileTimestampsWithIno } = require('../../utils/fileUtils')
+const { getFileTimestampsWithIno, filePathToPOSIX } = require('../../utils/fileUtils')
 const globals = require('../../utils/globals')
 const FileMetadata = require('../metadata/FileMetadata')
 
@@ -59,8 +59,8 @@ class LibraryFile {
     var fileMetadata = new FileMetadata()
     fileMetadata.setData(fileTsData)
     fileMetadata.filename = Path.basename(relPath)
-    fileMetadata.path = path
-    fileMetadata.relPath = relPath
+    fileMetadata.path = filePathToPOSIX(path)
+    fileMetadata.relPath = filePathToPOSIX(relPath)
     fileMetadata.ext = Path.extname(relPath)
     this.ino = fileTsData.ino
     this.metadata = fileMetadata

server/objects/mediaTypes/Book.js

@@ -89,6 +89,14 @@ class Book {
     }
   }
 
+  toJSONForMetadataFile() {
+    return {
+      tags: [...this.tags],
+      chapters: this.chapters.map(c => ({ ...c })),
+      metadata: this.metadata.toJSONForMetadataFile()
+    }
+  }
+
   get size() {
     var total = 0
     this.audioFiles.forEach((af) => total += af.metadata.size)
@@ -229,7 +237,7 @@ class Book {
   // Look for desc.txt, reader.txt, metadata.abs and opf file then update details if found
   async syncMetadataFiles(textMetadataFiles, opfMetadataOverrideDetails) {
     let metadataUpdatePayload = {}
-    let tagsUpdated = false
+    let hasUpdated = false
 
     const descTxt = textMetadataFiles.find(lf => lf.metadata.filename === 'desc.txt')
     if (descTxt) {
@@ -248,17 +256,25 @@ class Book {
       }
     }
 
+    const metadataIsJSON = global.ServerSettings.metadataFileFormat === 'json'
     const metadataAbs = textMetadataFiles.find(lf => lf.metadata.filename === 'metadata.abs')
-    if (metadataAbs) {
-      Logger.debug(`[Book] Found metadata.abs file for "${this.metadata.title}"`)
-      const metadataText = await readTextFile(metadataAbs.metadata.path)
-      const abmetadataUpdates = abmetadataGenerator.parseAndCheckForUpdates(metadataText, this, 'book')
+    const metadataJson = textMetadataFiles.find(lf => lf.metadata.filename === 'metadata.json')
+
+    const metadataFile = metadataIsJSON ? metadataJson : metadataAbs
+    if (metadataFile) {
+      Logger.debug(`[Book] Found ${metadataFile.metadata.filename} file for "${this.metadata.title}"`)
+      const metadataText = await readTextFile(metadataFile.metadata.path)
+      const abmetadataUpdates = abmetadataGenerator.parseAndCheckForUpdates(metadataText, this, 'book', metadataIsJSON)
       if (abmetadataUpdates && Object.keys(abmetadataUpdates).length) {
         Logger.debug(`[Book] "${this.metadata.title}" changes found in metadata.abs file`, abmetadataUpdates)
 
         if (abmetadataUpdates.tags) { // Set media tags if updated
           this.tags = abmetadataUpdates.tags
-          tagsUpdated = true
+          hasUpdated = true
+        }
+        if (abmetadataUpdates.chapters) { // Set chapters if updated
+          this.chapters = abmetadataUpdates.chapters
+          hasUpdated = true
         }
         if (abmetadataUpdates.metadata) {
           metadataUpdatePayload = {
@@ -267,6 +283,9 @@ class Book {
           }
         }
       }
+    } else if (metadataAbs || metadataJson) { // Has different metadata file format so mark as updated
+      Logger.debug(`[Book] Found different format metadata file ${(metadataAbs || metadataJson).metadata.filename}, expecting .${global.ServerSettings.metadataFileFormat} for "${this.metadata.title}"`)
+      hasUpdated = true
     }
 
     const metadataOpf = textMetadataFiles.find(lf => lf.isOPFFile || lf.metadata.filename === 'metadata.xml')
@@ -280,7 +299,7 @@ class Book {
             if (key === 'tags') { // Add tags only if tags are empty
               if (opfMetadata.tags.length && (!this.tags.length || opfMetadataOverrideDetails)) {
                 this.tags = opfMetadata.tags
-                tagsUpdated = true
+                hasUpdated = true
               }
             } else if (key === 'genres') { // Add genres only if genres are empty
               if (opfMetadata.genres.length && (!this.metadata.genres.length || opfMetadataOverrideDetails)) {
@@ -312,9 +331,9 @@ class Book {
     }
 
     if (Object.keys(metadataUpdatePayload).length) {
-      return this.metadata.update(metadataUpdatePayload) || tagsUpdated
+      return this.metadata.update(metadataUpdatePayload) || hasUpdated
     }
-    return tagsUpdated
+    return hasUpdated
   }
 
   searchQuery(query) {
@@ -509,5 +528,9 @@ class Book {
   getPlaybackAuthor() {
     return this.metadata.authorName
   }
+
+  getChapters() {
+    return this.chapters?.map(ch => ({ ...ch })) || []
+  }
 }
 module.exports = Book

server/objects/mediaTypes/Podcast.js

@@ -94,6 +94,13 @@ class Podcast {
     }
   }
 
+  toJSONForMetadataFile() {
+    return {
+      tags: [...this.tags],
+      metadata: this.metadata.toJSON()
+    }
+  }
+
   get size() {
     var total = 0
     this.episodes.forEach((ep) => total += ep.size)
@@ -199,10 +206,11 @@ class Podcast {
     let metadataUpdatePayload = {}
     let tagsUpdated = false
 
-    const metadataAbs = textMetadataFiles.find(lf => lf.metadata.filename === 'metadata.abs')
+    const metadataAbs = textMetadataFiles.find(lf => lf.metadata.filename === 'metadata.abs' || lf.metadata.filename === 'metadata.json')
     if (metadataAbs) {
+      const isJSON = metadataAbs.metadata.filename === 'metadata.json'
       const metadataText = await readTextFile(metadataAbs.metadata.path)
-      const abmetadataUpdates = abmetadataGenerator.parseAndCheckForUpdates(metadataText, this, 'podcast')
+      const abmetadataUpdates = abmetadataGenerator.parseAndCheckForUpdates(metadataText, this, 'podcast', isJSON)
       if (abmetadataUpdates && Object.keys(abmetadataUpdates).length) {
         Logger.debug(`[Podcast] "${this.metadata.title}" changes found in metadata.abs file`, abmetadataUpdates)
 
@@ -331,5 +339,9 @@ class Podcast {
     if (!audioFile?.metaTags) return false
     return this.metadata.setDataFromAudioMetaTags(audioFile.metaTags, overrideExistingDetails)
   }
+
+  getChapters(episodeId) {
+    return this.getEpisode(episodeId)?.chapters?.map(ch => ({ ...ch })) || []
+  }
 }
 module.exports = Podcast

server/objects/metadata/BookMetadata.js

@@ -27,9 +27,9 @@ class BookMetadata {
   construct(metadata) {
     this.title = metadata.title
     this.subtitle = metadata.subtitle
-    this.authors = (metadata.authors && metadata.authors.map) ? metadata.authors.map(a => ({ ...a })) : []
-    this.narrators = metadata.narrators ? [...metadata.narrators] : []
-    this.series = (metadata.series && metadata.series.map) ? metadata.series.map(s => ({ ...s })) : []
+    this.authors = (metadata.authors?.map) ? metadata.authors.map(a => ({ ...a })) : []
+    this.narrators = metadata.narrators ? [...metadata.narrators].filter(n => n) : []
+    this.series = (metadata.series?.map) ? metadata.series.map(s => ({ ...s })) : []
     this.genres = metadata.genres ? [...metadata.genres] : []
     this.publishedYear = metadata.publishedYear || null
     this.publishedDate = metadata.publishedDate || null
@@ -109,6 +109,16 @@ class BookMetadata {
     }
   }
 
+  toJSONForMetadataFile() {
+    const json = this.toJSON()
+    json.authors = json.authors.map(au => au.name)
+    json.series = json.series.map(se => {
+      if (!se.sequence) return se.name
+      return `${se.name} #${se.sequence}`
+    })
+    return json
+  }
+
   clone() {
     return new BookMetadata(this.toJSON())
   }
@@ -191,8 +201,9 @@ class BookMetadata {
   }
 
   update(payload) {
-    var json = this.toJSON()
-    var hasUpdates = false
+    const json = this.toJSON()
+    let hasUpdates = false
+
     for (const key in json) {
       if (payload[key] !== undefined) {
         if (!areEquivalent(payload[key], json[key])) {
@@ -221,6 +232,32 @@ class BookMetadata {
     })
   }
 
+  /**
+   * Update narrator name if narrator is in book
+   * @param {String} oldNarratorName - Narrator name to get updated
+   * @param {String} newNarratorName - Updated narrator name
+   * @return {Boolean} True if narrator was updated
+   */
+  updateNarrator(oldNarratorName, newNarratorName) {
+    if (!this.hasNarrator(oldNarratorName)) return false
+    this.narrators = this.narrators.filter(n => n !== oldNarratorName)
+    if (newNarratorName && !this.hasNarrator(newNarratorName)) {
+      this.narrators.push(newNarratorName)
+    }
+    return true
+  }
+
+  /**
+   * Remove narrator name if narrator is in book
+   * @param {String} narratorName - Narrator name to remove
+   * @return {Boolean} True if narrator was updated
+   */
+  removeNarrator(narratorName) {
+    if (!this.hasNarrator(narratorName)) return false
+    this.narrators = this.narrators.filter(n => n !== narratorName)
+    return true
+  }
+
   setData(scanMediaData = {}) {
     this.title = scanMediaData.title || null
     this.subtitle = scanMediaData.subtitle || null
@@ -347,8 +384,10 @@ class BookMetadata {
     const parsed = parseNameString.parse(authorsTag)
     if (!parsed) return []
     return (parsed.names || []).map((au) => {
+      const findAuthor = this.authors.find(_au => _au.name == au)
+
       return {
-        id: `new-${Math.floor(Math.random() * 1000000)}`,
+        id: findAuthor?.id || `new-${Math.floor(Math.random() * 1000000)}`,
         name: au
       }
     })
@@ -385,7 +424,7 @@ class BookMetadata {
     return this.narrators.filter(n => cleanStringForSearch(n).includes(query))
   }
   searchQuery(query) { // Returns key if match is found
-    const keysToCheck = ['title', 'asin', 'isbn']
+    const keysToCheck = ['title', 'asin', 'isbn', 'subtitle']
     for (const key of keysToCheck) {
       if (this[key] && cleanStringForSearch(String(this[key])).includes(query)) {
         return {

server/objects/settings/ServerSettings.js

@@ -20,6 +20,7 @@ class ServerSettings {
     // Metadata - choose to store inside users library item folder
     this.storeCoverWithItem = false
     this.storeMetadataWithItem = false
+    this.metadataFileFormat = 'json'
 
     // Security/Rate limits
     this.rateLimitLoginRequests = 10
@@ -94,6 +95,7 @@ class ServerSettings {
 
     this.storeCoverWithItem = !!settings.storeCoverWithItem
     this.storeMetadataWithItem = !!settings.storeMetadataWithItem
+    this.metadataFileFormat = settings.metadataFileFormat || 'json'
 
     this.rateLimitLoginRequests = !isNaN(settings.rateLimitLoginRequests) ? Number(settings.rateLimitLoginRequests) : 10
     this.rateLimitLoginWindow = !isNaN(settings.rateLimitLoginWindow) ? Number(settings.rateLimitLoginWindow) : 10 * 60 * 1000 // 10 Minutes
@@ -175,6 +177,16 @@ class ServerSettings {
     if (settings.homeBookshelfView == undefined) { // homeBookshelfView was added in 2.1.3
       this.homeBookshelfView = settings.bookshelfView
     }
+    if (settings.metadataFileFormat == undefined) { // metadataFileFormat was added in 2.2.21
+      // All users using old settings will stay abs until changed
+      this.metadataFileFormat = 'abs'
+    }
+
+    // Validation
+    if (!['abs', 'json'].includes(this.metadataFileFormat)) {
+      Logger.error(`[ServerSettings] construct: Invalid metadataFileFormat ${this.metadataFileFormat}`)
+      this.metadataFileFormat = 'json'
+    }
 
     if (this.logLevel !== Logger.logLevel) {
       Logger.setLogLevel(this.logLevel)
@@ -196,6 +208,7 @@ class ServerSettings {
       scannerUseTone: this.scannerUseTone,
       storeCoverWithItem: this.storeCoverWithItem,
       storeMetadataWithItem: this.storeMetadataWithItem,
+      metadataFileFormat: this.metadataFileFormat,
       rateLimitLoginRequests: this.rateLimitLoginRequests,
       rateLimitLoginWindow: this.rateLimitLoginWindow,
       backupSchedule: this.backupSchedule,

server/objects/user/MediaProgress.js

@@ -10,7 +10,7 @@ class MediaProgress {
     this.isFinished = false
     this.hideFromContinueListening = false
 
-    this.ebookLocation = null // current cfi tag
+    this.ebookLocation = null // cfi tag for epub, page number for pdf
     this.ebookProgress = null // 0 to 1
 
     this.lastUpdate = null
@@ -46,11 +46,11 @@ class MediaProgress {
     this.episodeId = progress.episodeId
     this.duration = progress.duration || 0
     this.progress = progress.progress
-    this.currentTime = progress.currentTime
+    this.currentTime = progress.currentTime || 0
     this.isFinished = !!progress.isFinished
     this.hideFromContinueListening = !!progress.hideFromContinueListening
     this.ebookLocation = progress.ebookLocation || null
-    this.ebookProgress = progress.ebookProgress
+    this.ebookProgress = progress.ebookProgress || null
     this.lastUpdate = progress.lastUpdate
     this.startedAt = progress.startedAt
     this.finishedAt = progress.finishedAt || null