Update abmetadata file for new data model, add chapter and description section parser

server/objects/LibraryItem.js

@@ -1,5 +1,7 @@
+const Path = require('path')
 const { version } = require('../../package.json')
 const Logger = require('../Logger')
+const abmetadataGenerator = require('../utils/abmetadataGenerator')
 const LibraryFile = require('./files/LibraryFile')
 const Book = require('./mediaTypes/Book')
 const Podcast = require('./mediaTypes/Podcast')
@@ -36,6 +38,9 @@ class LibraryItem {
     if (libraryItem) {
       this.construct(libraryItem)
     }
+
+    // Temporary attributes
+    this.isSavingMetadata = false
   }
 
   construct(libraryItem) {
@@ -447,5 +452,27 @@ class LibraryItem {
   getDirectPlayTracklist(episodeId) {
     return this.media.getDirectPlayTracklist(episodeId)
   }
+
+  // Saves metadata.abs file
+  async saveMetadata() {
+    if (this.isSavingMetadata) return
+    this.isSavingMetadata = true
+
+    var metadataPath = Path.join(global.MetadataPath, 'items', this.id)
+    if (global.ServerSettings.storeMetadataWithItem) {
+      metadataPath = this.path
+    } else {
+      // 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
+    })
+  }
 }
 module.exports = LibraryItem

server/objects/ServerSettings.js

@@ -17,9 +17,9 @@ class ServerSettings {
     this.scannerPreferOpfMetadata = false
     this.scannerDisableWatcher = false
 
-    // Metadata
-    this.storeCoverWithBook = false
-    this.storeMetadataWithBook = false
+    // Metadata - choose to store inside users library item folder
+    this.storeCoverWithItem = false
+    this.storeMetadataWithItem = false
 
     // Security/Rate limits
     this.rateLimitLoginRequests = 10
@@ -64,11 +64,14 @@ class ServerSettings {
     this.scannerPreferOpfMetadata = !!settings.scannerPreferOpfMetadata
     this.scannerDisableWatcher = !!settings.scannerDisableWatcher
 
-    this.storeCoverWithBook = settings.storeCoverWithBook
-    if (this.storeCoverWithBook == undefined) { // storeCoverWithBook added in 1.7.1 to replace coverDestination
-      this.storeCoverWithBook = !!settings.coverDestination
+    this.storeCoverWithItem = !!settings.storeCoverWithItem
+    if (settings.storeCoverWithBook != undefined) { // storeCoverWithBook was old name of setting < v2
+      this.storeCoverWithItem = !!settings.storeCoverWithBook
+    }
+    this.storeMetadataWithItem = !!settings.storeMetadataWithItem
+    if (settings.storeMetadataWithBook != undefined) { // storeMetadataWithBook was old name of setting < v2
+      this.storeMetadataWithItem = !!settings.storeMetadataWithBook
     }
-    this.storeMetadataWithBook = !!settings.storeCoverWithBook
 
     this.rateLimitLoginRequests = !isNaN(settings.rateLimitLoginRequests) ? Number(settings.rateLimitLoginRequests) : 10
     this.rateLimitLoginWindow = !isNaN(settings.rateLimitLoginWindow) ? Number(settings.rateLimitLoginWindow) : 10 * 60 * 1000 // 10 Minutes
@@ -105,8 +108,8 @@ class ServerSettings {
       scannerPreferAudioMetadata: this.scannerPreferAudioMetadata,
       scannerPreferOpfMetadata: this.scannerPreferOpfMetadata,
       scannerDisableWatcher: this.scannerDisableWatcher,
-      storeCoverWithBook: this.storeCoverWithBook,
-      storeMetadataWithBook: this.storeMetadataWithBook,
+      storeCoverWithItem: this.storeCoverWithItem,
+      storeMetadataWithItem: this.storeMetadataWithItem,
       rateLimitLoginRequests: this.rateLimitLoginRequests,
       rateLimitLoginWindow: this.rateLimitLoginWindow,
       backupSchedule: this.backupSchedule,

server/objects/mediaTypes/Book.js

@@ -1,9 +1,9 @@
 const Path = require('path')
 const Logger = require('../../Logger')
 const BookMetadata = require('../metadata/BookMetadata')
-const abmetadataGenerator = require('../../utils/abmetadataGenerator')
 const { areEquivalent, copyValue } = require('../../utils/index')
 const { parseOpfMetadataXML } = require('../../utils/parseOpfMetadata')
+const abmetadataGenerator = require('../../utils/abmetadataGenerator')
 const { readTextFile } = require('../../utils/fileUtils')
 const AudioFile = require('../files/AudioFile')
 const AudioTrack = require('../files/AudioTrack')
@@ -215,10 +215,18 @@ class Book {
       }
     }
 
-    // TODO: Implement metadata.abs
     var metadataAbs = textMetadataFiles.find(lf => lf.metadata.filename === 'metadata.abs')
     if (metadataAbs) {
-
+      Logger.debug(`[Book] Found metadata.abs file for "${this.metadata.title}"`)
+      var metadataText = await readTextFile(metadataAbs.metadata.path)
+      var abmetadataUpdates = abmetadataGenerator.parseAndCheckForUpdates(metadataText, this.metadata, 'book')
+      if (abmetadataUpdates && Object.keys(abmetadataUpdates).length) {
+        Logger.debug(`[Book] "${this.metadata.title}" changes found in metadata.abs file`, abmetadataUpdates)
+        metadataUpdatePayload = {
+          ...metadataUpdatePayload,
+          ...abmetadataUpdates
+        }
+      }
     }
 
     var metadataOpf = textMetadataFiles.find(lf => lf.isOPFFile || lf.metadata.filename === 'metadata.xml')

server/objects/mediaTypes/Podcast.js

@@ -2,6 +2,8 @@ const Logger = require('../../Logger')
 const PodcastEpisode = require('../entities/PodcastEpisode')
 const PodcastMetadata = require('../metadata/PodcastMetadata')
 const { areEquivalent, copyValue } = require('../../utils/index')
+const abmetadataGenerator = require('../../utils/abmetadataGenerator')
+const { readTextFile } = require('../../utils/fileUtils')
 const { createNewSortInstance } = require('fast-sort')
 const naturalSort = createNewSortInstance({
   comparer: new Intl.Collator(undefined, { numeric: true, sensitivity: 'base' }).compare
@@ -158,6 +160,21 @@ class Podcast {
   }
 
   async syncMetadataFiles(textMetadataFiles, opfMetadataOverrideDetails) {
+    var metadataUpdatePayload = {}
+
+    var metadataAbs = textMetadataFiles.find(lf => lf.metadata.filename === 'metadata.abs')
+    if (metadataAbs) {
+      var metadataText = await readTextFile(metadataAbs.metadata.path)
+      var abmetadataUpdates = abmetadataGenerator.parseAndCheckForUpdates(metadataText, this.metadata, 'podcast')
+      if (abmetadataUpdates && Object.keys(abmetadataUpdates).length) {
+        Logger.debug(`[Podcast] "${this.metadata.title}" changes found in metadata.abs file`, abmetadataUpdates)
+        metadataUpdatePayload = abmetadataUpdates
+      }
+    }
+
+    if (Object.keys(metadataUpdatePayload).length) {
+      return this.metadata.update(metadataUpdatePayload)
+    }
     return false
   }