mirror of
https://github.com/advplyr/audiobookshelf.git
synced 2026-05-13 15:01:29 +00:00
dc0899ff61
When absMetadata (metadata.json) is the highest-priority source and a field is null, propagate that null into bookMetadata so lower-priority sources (e.g. audio file tags) cannot overwrite a value the user intentionally cleared. Previously all null values were skipped, causing cleared fields like subtitle to be repopulated from file tags on rescan.
94 lines
No EOL
4.1 KiB
JavaScript
94 lines
No EOL
4.1 KiB
JavaScript
const Path = require('path')
|
|
const fsExtra = require('../libs/fsExtra')
|
|
const { readTextFile } = require('../utils/fileUtils')
|
|
const { LogLevel } = require('../utils/constants')
|
|
const abmetadataGenerator = require('../utils/generators/abmetadataGenerator')
|
|
|
|
class AbsMetadataFileScanner {
|
|
constructor() { }
|
|
|
|
/**
|
|
* Check for metadata.json file and set book metadata
|
|
*
|
|
* @param {import('./LibraryScan')} libraryScan
|
|
* @param {import('./LibraryItemScanData')} libraryItemData
|
|
* @param {Object} bookMetadata
|
|
* @param {string} [existingLibraryItemId]
|
|
*/
|
|
async scanBookMetadataFile(libraryScan, libraryItemData, bookMetadata, existingLibraryItemId = null) {
|
|
const metadataLibraryFile = libraryItemData.metadataJsonLibraryFile
|
|
let metadataText = metadataLibraryFile ? await readTextFile(metadataLibraryFile.metadata.path) : null
|
|
let metadataFilePath = metadataLibraryFile?.metadata.path
|
|
|
|
// When metadata file is not stored with library item then check in the /metadata/items folder for it
|
|
if (!metadataText && existingLibraryItemId) {
|
|
let metadataPath = Path.join(global.MetadataPath, 'items', existingLibraryItemId)
|
|
|
|
metadataFilePath = Path.join(metadataPath, 'metadata.json')
|
|
if (await fsExtra.pathExists(metadataFilePath)) {
|
|
metadataText = await readTextFile(metadataFilePath)
|
|
}
|
|
}
|
|
|
|
if (metadataText) {
|
|
libraryScan.addLog(LogLevel.INFO, `Found metadata file "${metadataFilePath}"`)
|
|
const abMetadata = abmetadataGenerator.parseJson(metadataText) || {}
|
|
for (const key in abMetadata) {
|
|
if (abMetadata[key] === undefined) continue
|
|
if (abMetadata[key] === null) {
|
|
// Propagate null for scalar string fields so that values intentionally cleared
|
|
// by the user are preserved when the library is rescanned. absMetadata has the
|
|
// highest metadata precedence, so a null here means the user explicitly cleared
|
|
// the field and lower-priority sources (e.g. audio file tags) should not refill it.
|
|
const clearableStringFields = ['subtitle', 'publishedYear', 'publisher', 'description', 'isbn', 'asin', 'language']
|
|
if (clearableStringFields.includes(key)) {
|
|
bookMetadata[key] = null
|
|
}
|
|
continue
|
|
}
|
|
if (key === 'authors' && !abMetadata.authors?.length) continue
|
|
if (key === 'genres' && !abMetadata.genres?.length) continue
|
|
if (key === 'tags' && !abMetadata.tags?.length) continue
|
|
if (key === 'chapters' && !abMetadata.chapters?.length) continue
|
|
|
|
bookMetadata[key] = abMetadata[key]
|
|
}
|
|
}
|
|
}
|
|
|
|
/**
|
|
* Check for metadata.json file and set podcast metadata
|
|
*
|
|
* @param {import('./LibraryScan')} libraryScan
|
|
* @param {import('./LibraryItemScanData')} libraryItemData
|
|
* @param {Object} podcastMetadata
|
|
* @param {string} [existingLibraryItemId]
|
|
*/
|
|
async scanPodcastMetadataFile(libraryScan, libraryItemData, podcastMetadata, existingLibraryItemId = null) {
|
|
const metadataLibraryFile = libraryItemData.metadataJsonLibraryFile
|
|
let metadataText = metadataLibraryFile ? await readTextFile(metadataLibraryFile.metadata.path) : null
|
|
let metadataFilePath = metadataLibraryFile?.metadata.path
|
|
|
|
// When metadata file is not stored with library item then check in the /metadata/items folder for it
|
|
if (!metadataText && existingLibraryItemId) {
|
|
let metadataPath = Path.join(global.MetadataPath, 'items', existingLibraryItemId)
|
|
|
|
metadataFilePath = Path.join(metadataPath, 'metadata.json')
|
|
if (await fsExtra.pathExists(metadataFilePath)) {
|
|
metadataText = await readTextFile(metadataFilePath)
|
|
}
|
|
}
|
|
|
|
if (metadataText) {
|
|
libraryScan.addLog(LogLevel.INFO, `Found metadata file "${metadataFilePath}"`)
|
|
const abMetadata = abmetadataGenerator.parseJson(metadataText) || {}
|
|
for (const key in abMetadata) {
|
|
if (abMetadata[key] === undefined || abMetadata[key] === null) continue
|
|
if (key === 'tags' && !abMetadata.tags?.length) continue
|
|
|
|
podcastMetadata[key] = abMetadata[key]
|
|
}
|
|
}
|
|
}
|
|
}
|
|
module.exports = new AbsMetadataFileScanner() |