New data model change of Book media type to include array of Audiobook and Ebook objects

This commit is contained in:
advplyr 2022-03-16 19:15:25 -05:00
parent 0af6ad63c1
commit 4fe60465e5
13 changed files with 677 additions and 334 deletions

View File

@ -1,168 +0,0 @@
/*
This is an example of a fully expanded book library item
*/
const LibraryItem = require('../server/objects/LibraryItem')
new LibraryItem({
id: 'li_abai123wir',
ino: "55450570412017066",
libraryId: 'lib_1239p1d8',
folderId: 'fol_192ab8901',
path: '/audiobooks/Terry Goodkind/Sword of Truth/1 - Wizards First Rule',
relPath: '/Terry Goodkind/Sword of Truth/1 - Wizards First Rule',
mtimeMs: 1646784672127,
ctimeMs: 1646784672127,
birthtimeMs: 1646784672127,
addedAt: 1646784672127,
lastUpdate: 1646784672127,
lastScan: 1646784672127,
scanVersion: 1.72,
isMissing: false,
mediaType: 'book',
media: { // Book.js
coverPath: '/metadata/books/li_abai123wir/cover.webp',
metadata: { // BookMetadata.js
title: 'Wizards First Rule',
subtitle: null,
authors: [
{
id: 'au_42908lkajsfdk',
name: 'Terry Goodkind'
}
],
narrators: ['Sam Tsoutsouvas'],
series: [
{
id: 'se_902384lansf',
name: 'Sword of Truth',
sequence: 1
}
],
genres: ['Fantasy', 'Adventure'],
publishedYear: '1994',
publishedDate: '1994-01-01',
publisher: 'Brilliance Audio',
description: 'In the aftermath of the brutal murder of his father, a mysterious woman...',
isbn: '289374092834',
asin: '19023819203',
language: 'english'
},
tags: ['favorites'],
audioFiles: [
{ // AudioFile.js
ino: "55450570412017066",
index: 1,
metadata: { // FileMetadata.js
filename: 'audiofile.mp3',
ext: '.mp3',
path: '/audiobooks/Terry Goodkind/Sword of Truth/1 - Wizards First Rule/CD01/audiofile.mp3',
relPath: '/CD01/audiofile.mp3',
mtimeMs: 1646784672127,
ctimeMs: 1646784672127,
birthtimeMs: 1646784672127,
size: 1197449516
},
trackNumFromMeta: 1,
discNumFromMeta: null,
trackNumFromFilename: null,
discNumFromFilename: 1,
manuallyVerified: false,
exclude: false,
invalid: false,
format: "MP2/3 (MPEG audio layer 2/3)",
duration: 2342342,
bitRate: 324234,
language: null,
codec: 'mp3',
timeBase: "1/14112000",
channels: 1,
channelLayout: "mono",
chapters: [],
embeddedCoverArt: 'jpeg', // Video stream codec ['mjpeg', 'jpeg', 'png'] or null
metaTags: { // AudioMetaTags.js
tagAlbum: '',
tagArtist: '',
tagGenre: '',
tagTitle: '',
tagSeries: '',
tagSeriesPart: '',
tagTrack: '',
tagDisc: '',
tagSubtitle: '',
tagAlbumArtist: '',
tagDate: '',
tagComposer: '',
tagPublisher: '',
tagComment: '',
tagDescription: '',
tagEncoder: '',
tagEncodedBy: '',
tagIsbn: '',
tagLanguage: '',
tagASIN: ''
},
addedAt: 1646784672127,
updatedAt: 1646784672127
}
],
ebookFiles: [
{ // EBookFile.js
ino: "55450570412017066",
metadata: { // FileMetadata.js
filename: 'ebookfile.mobi',
ext: '.mobi',
path: '/audiobooks/Terry Goodkind/Sword of Truth/1 - Wizards First Rule/ebookfile.mobi',
relPath: '/ebookfile.mobi',
mtimeMs: 1646784672127,
ctimeMs: 1646784672127,
birthtimeMs: 1646784672127,
size: 1197449516
},
ebookFormat: 'mobi',
addedAt: 1646784672127,
updatedAt: 1646784672127
}
],
chapters: [
{
id: 0,
title: 'Chapter 01',
start: 0,
end: 2467.753
}
]
},
libraryFiles: [
{ // LibraryFile.js
ino: "55450570412017066",
metadata: { // FileMetadata.js
filename: 'cover.png',
ext: '.png',
path: '/audiobooks/Terry Goodkind/Sword of Truth/1 - Wizards First Rule/subfolder/cover.png',
relPath: '/subfolder/cover.png',
mtimeMs: 1646784672127,
ctimeMs: 1646784672127,
birthtimeMs: 1646784672127,
size: 1197449516
},
addedAt: 1646784672127,
updatedAt: 1646784672127
},
{ // LibraryFile.js
ino: "55450570412017066",
metadata: { // FileMetadata.js
filename: 'cover.png',
ext: '.mobi',
path: '/audiobooks/Terry Goodkind/Sword of Truth/1 - Wizards First Rule/ebookfile.mobi',
relPath: '/ebookfile.mobi',
mtimeMs: 1646784672127,
ctimeMs: 1646784672127,
birthtimeMs: 1646784672127,
size: 1197449516
},
addedAt: 1646784672127,
updatedAt: 1646784672127
}
]
})

View File

@ -0,0 +1,189 @@
/*
This is an example of a fully expanded book library item
*/
const LibraryItem = require('../server/objects/LibraryItem')
new LibraryItem({
id: 'li_abai123wir',
ino: "55450570412017066",
libraryId: 'lib_1239p1d8',
folderId: 'fol_192ab8901',
path: '/audiobooks/Terry Goodkind/Sword of Truth/1 - Wizards First Rule',
relPath: '/Terry Goodkind/Sword of Truth/1 - Wizards First Rule',
mtimeMs: 1646784672127,
ctimeMs: 1646784672127,
birthtimeMs: 1646784672127,
addedAt: 1646784672127,
updatedAt: 1646784672127,
lastScan: 1646784672127,
scanVersion: 1.72,
isMissing: false,
isInvalid: false,
mediaType: 'book',
media: { // Book.js
coverPath: '/metadata/items/li_abai123wir/cover.webp',
tags: ['favorites'],
lastCoverSearch: null,
lastCoverSearchQuery: null,
metadata: { // BookMetadata.js
title: 'Wizards First Rule',
subtitle: null,
authors: [
{
id: 'au_42908lkajsfdk',
name: 'Terry Goodkind'
}
],
narrators: ['Sam Tsoutsouvas'],
series: [
{
id: 'se_902384lansf',
name: 'Sword of Truth',
sequence: 1
}
],
genres: ['Fantasy', 'Adventure'],
publishedYear: '1994',
publishedDate: '1994-01-01',
publisher: 'Brilliance Audio',
description: 'In the aftermath of the brutal murder of his father, a mysterious woman...',
isbn: '289374092834',
asin: '19023819203',
language: 'english',
explicit: false
},
audiobooks: [
{
id: 'au_289374asf0a98',
index: 1,
name: 'default',
audioFiles: [
{ // AudioFile.js
ino: "55450570412017066",
index: 1,
metadata: { // FileMetadata.js
filename: 'audiofile.mp3',
ext: '.mp3',
path: '/audiobooks/Terry Goodkind/Sword of Truth/1 - Wizards First Rule/CD01/audiofile.mp3',
relPath: '/CD01/audiofile.mp3',
mtimeMs: 1646784672127,
ctimeMs: 1646784672127,
birthtimeMs: 1646784672127,
size: 1197449516
},
trackNumFromMeta: 1,
discNumFromMeta: null,
trackNumFromFilename: null,
discNumFromFilename: 1,
manuallyVerified: false,
exclude: false,
invalid: false,
format: "MP2/3 (MPEG audio layer 2/3)",
duration: 2342342,
bitRate: 324234,
language: null,
codec: 'mp3',
timeBase: "1/14112000",
channels: 1,
channelLayout: "mono",
chapters: [],
embeddedCoverArt: 'jpeg', // Video stream codec ['mjpeg', 'jpeg', 'png'] or null
metaTags: { // AudioMetaTags.js
tagAlbum: '',
tagArtist: '',
tagGenre: '',
tagTitle: '',
tagSeries: '',
tagSeriesPart: '',
tagTrack: '',
tagDisc: '',
tagSubtitle: '',
tagAlbumArtist: '',
tagDate: '',
tagComposer: '',
tagPublisher: '',
tagComment: '',
tagDescription: '',
tagEncoder: '',
tagEncodedBy: '',
tagIsbn: '',
tagLanguage: '',
tagASIN: ''
},
addedAt: 1646784672127,
updatedAt: 1646784672127
}
],
chapters: [
{
id: 0,
title: 'Chapter 01',
start: 0,
end: 2467.753
}
],
missingParts: [4, 10], // Array of missing parts in tracklist
addedAt: 1646784672127,
updatedAt: 1646784672127
}
],
ebooks: [
{
id: 'eb_289374asf0a98',
index: 1,
name: 'default',
ebookFile: { // EBookFile.js
ino: "55450570412017066",
metadata: { // FileMetadata.js
filename: 'ebookfile.mobi',
ext: '.mobi',
path: '/audiobooks/Terry Goodkind/Sword of Truth/1 - Wizards First Rule/ebookfile.mobi',
relPath: '/ebookfile.mobi',
mtimeMs: 1646784672127,
ctimeMs: 1646784672127,
birthtimeMs: 1646784672127,
size: 1197449516
},
ebookFormat: 'mobi',
addedAt: 1646784672127,
updatedAt: 1646784672127
},
addedAt: 1646784672127,
updatedAt: 1646784672127
}
]
},
libraryFiles: [
{ // LibraryFile.js
ino: "55450570412017066",
metadata: { // FileMetadata.js
filename: 'cover.png',
ext: '.png',
path: '/audiobooks/Terry Goodkind/Sword of Truth/1 - Wizards First Rule/subfolder/cover.png',
relPath: '/subfolder/cover.png',
mtimeMs: 1646784672127,
ctimeMs: 1646784672127,
birthtimeMs: 1646784672127,
size: 1197449516
},
addedAt: 1646784672127,
updatedAt: 1646784672127
},
{ // LibraryFile.js
ino: "55450570412017066",
metadata: { // FileMetadata.js
filename: 'cover.png',
ext: '.mobi',
path: '/audiobooks/Terry Goodkind/Sword of Truth/1 - Wizards First Rule/ebookfile.mobi',
relPath: '/ebookfile.mobi',
mtimeMs: 1646784672127,
ctimeMs: 1646784672127,
birthtimeMs: 1646784672127,
size: 1197449516
},
addedAt: 1646784672127,
updatedAt: 1646784672127
}
]
})

View File

@ -0,0 +1,83 @@
/*
This is an example of a fully expanded podcast library item (under construction)
*/
const LibraryItem = require('../server/objects/LibraryItem')
new LibraryItem({
id: 'li_abai123wir',
ino: "55450570412017066",
libraryId: 'lib_1239p1d8',
folderId: 'fol_192ab8901',
path: '/podcasts/Great Podcast Name',
relPath: '/Great Podcast Name',
mtimeMs: 1646784672127,
ctimeMs: 1646784672127,
birthtimeMs: 1646784672127,
addedAt: 1646784672127,
updatedAt: 1646784672127,
lastScan: 1646784672127,
scanVersion: 1.72,
isMissing: false,
isInvalid: false,
mediaType: 'podcast',
media: { // Podcast.js
coverPath: '/metadata/items/li_abai123wir/cover.webp',
tags: ['favorites'],
lastCoverSearch: null,
lastCoverSearchQuery: null,
metadata: { // PodcastMetadata.js
title: 'Great Podcast Name',
artist: 'Some Artist Name',
genres: ['Fantasy', 'Adventure'],
publishedDate: '1994-01-01',
description: 'In the aftermath of the brutal murder of his father, a mysterious woman...',
feedUrl: '',
itunesPageUrl: '',
itunesId: '',
itunesArtistId: '',
explicit: false
},
episodes: [
{ // PodcastEpisode.js
id: 'ep_289374asf0a98',
index: 1,
// TODO: podcast episode data and PodcastEpisodeMetadata
addedAt: 1646784672127,
updatedAt: 1646784672127
}
]
},
libraryFiles: [
{ // LibraryFile.js
ino: "55450570412017066",
metadata: { // FileMetadata.js
filename: 'cover.png',
ext: '.png',
path: '/podcasts/Great Podcast Name/cover.png',
relPath: '/cover.png',
mtimeMs: 1646784672127,
ctimeMs: 1646784672127,
birthtimeMs: 1646784672127,
size: 1197449516
},
addedAt: 1646784672127,
updatedAt: 1646784672127
},
{ // LibraryFile.js
ino: "55450570412017066",
metadata: { // FileMetadata.js
filename: 'episode_1.mp3',
ext: '.mp3',
path: '/podcasts/Great Podcast Name/episode_1.mp3',
relPath: '/episode_1.mp3',
mtimeMs: 1646784672127,
ctimeMs: 1646784672127,
birthtimeMs: 1646784672127,
size: 1197449516
},
addedAt: 1646784672127,
updatedAt: 1646784672127
}
]
})

View File

@ -11,17 +11,23 @@ class PlaybackSessionManager {
this.sessions = [] this.sessions = []
} }
startSessionRequest(req, res) { async startSessionRequest(req, res) {
var user = req.user var user = req.user
var libraryItem = req.libraryItem var libraryItem = req.libraryItem
var options = req.query var options = req.query || {}
const session = this.startSession(user, libraryItem, options) const session = await this.startSession(user, libraryItem, options)
res.json(session) res.json(session)
} }
startSession(user, libraryItem, options) { async startSession(user, libraryItem, options) {
// TODO: Determine what play method to use and setup playback session // TODO: Determine what play method to use and setup playback session
// temporary client can pass direct=1 in query string for direct play
if (options.direct) {
var tracks = libraryItem.media.getDirectPlayTracklist(options)
}
const newPlaybackSession = new PlaybackSession() const newPlaybackSession = new PlaybackSession()
newPlaybackSession.setData(libraryItem, user)
this.sessions.push(newPlaybackSession) this.sessions.push(newPlaybackSession)
return newPlaybackSession return newPlaybackSession
} }

View File

@ -1,8 +1,8 @@
const { version } = require('../../package.json') const { version } = require('../../package.json')
const Logger = require('../Logger') const Logger = require('../Logger')
const LibraryFile = require('./files/LibraryFile') const LibraryFile = require('./files/LibraryFile')
const Book = require('./entities/Book') const Book = require('./mediaTypes/Book')
const Podcast = require('./entities/Podcast') const Podcast = require('./mediaTypes/Podcast')
const { areEquivalent, copyValue, getId } = require('../utils/index') const { areEquivalent, copyValue, getId } = require('../utils/index')
class LibraryItem { class LibraryItem {
@ -143,8 +143,8 @@ class LibraryItem {
get hasAudioFiles() { get hasAudioFiles() {
return this.libraryFiles.some(lf => lf.fileType === 'audio') return this.libraryFiles.some(lf => lf.fileType === 'audio')
} }
get hasMediaFiles() { get hasMediaEntities() {
return this.media.hasMediaFiles return this.media.hasMediaEntities
} }
// Data comes from scandir library item data // Data comes from scandir library item data
@ -357,7 +357,7 @@ class LibraryItem {
} }
// Check if invalid // Check if invalid
this.isInvalid = !this.media.hasMediaFiles this.isInvalid = !this.media.hasMediaEntities
// If cover path is in item folder, make sure libraryFile exists for it // If cover path is in item folder, make sure libraryFile exists for it
if (this.media.coverPath && this.media.coverPath.startsWith(this.path)) { if (this.media.coverPath && this.media.coverPath.startsWith(this.path)) {
@ -432,5 +432,9 @@ class LibraryItem {
query = query.toLowerCase() query = query.toLowerCase()
return this.media.searchQuery(query) return this.media.searchQuery(query)
} }
getDirectPlayTracklist(options) {
return this.media.getDirectPlayTracklist(options)
}
} }
module.exports = LibraryItem module.exports = LibraryItem

View File

@ -0,0 +1,218 @@
const Path = require('path')
const AudioFile = require('../files/AudioFile')
const { areEquivalent, copyValue } = require('../../utils/index')
class Audiobook {
constructor(audiobook) {
this.id = null
this.index = null
this.name = null
this.audioFiles = []
this.chapters = []
this.missingParts = []
this.addedAt = null
this.updatedAt = null
if (audiobook) {
this.construct(audiobook)
}
}
construct(audiobook) {
this.id = audiobook.id
this.index = audiobook.index
this.name = audiobook.name || null
this.audioFiles = audiobook.audioFiles.map(f => new AudioFile(f))
this.chapters = audiobook.chapters.map(c => ({ ...c }))
this.missingParts = audiobook.missingParts ? [...book.missingParts] : []
this.addedAt = audiobook.addedAt
this.updatedAt = audiobook.updatedAt
}
toJSON() {
return {
id: this.id,
index: this.index,
name: this.name,
audioFiles: this.audioFiles.map(f => f.toJSON()),
chapters: this.chapters.map(c => ({ ...c })),
missingParts: [...this.missingParts],
addedAt: this.addedAt,
updatedAt: this.updatedAt
}
}
toJSONMinified() {
return {
id: this.id,
index: this.index,
name: this.name,
numTracks: this.tracks.length,
numAudioFiles: this.audioFiles.length,
numChapters: this.chapters.length,
numMissingParts: this.missingParts.length,
duration: this.duration,
size: this.size,
addedAt: this.addedAt,
updatedAt: this.updatedAt
}
}
toJSONExpanded() {
return {
id: this.id,
index: this.index,
name: this.name,
audioFiles: this.audioFiles.map(f => f.toJSON()),
chapters: this.chapters.map(c => ({ ...c })),
duration: this.duration,
size: this.size,
tracks: this.tracks.map(t => t.toJSON()),
missingParts: [...this.missingParts],
addedAt: this.addedAt,
updatedAt: this.updatedAt
}
}
get tracks() {
return this.audioFiles.filter(af => !af.exclude && !af.invalid)
}
get duration() {
var total = 0
this.tracks.forEach((track) => total += track.duration)
return total
}
get size() {
var total = 0
this.audioFiles.forEach((af) => total += af.metadata.size)
return total
}
get hasEmbeddedCoverArt() {
return this.audioFiles.some(af => af.embeddedCoverArt)
}
update(payload) {
var json = this.toJSON()
var hasUpdates = false
for (const key in json) {
if (payload[key] !== undefined) {
if (!areEquivalent(payload[key], json[key])) {
this[key] = copyValue(payload[key])
Logger.debug('[Audiobook] Key updated', key, this[key])
hasUpdates = true
}
}
}
return hasUpdates
}
updateAudioTracks(orderedFileData) {
var index = 1
this.audioFiles = orderedFileData.map((fileData) => {
var audioFile = this.audioFiles.find(af => af.ino === fileData.ino)
audioFile.manuallyVerified = true
audioFile.invalid = false
audioFile.error = null
if (fileData.exclude !== undefined) {
audioFile.exclude = !!fileData.exclude
}
if (audioFile.exclude) {
audioFile.index = -1
} else {
audioFile.index = index++
}
return audioFile
})
this.rebuildTracks()
}
rebuildTracks() {
this.audioFiles.sort((a, b) => a.index - b.index)
this.missingParts = []
this.setChapters()
this.checkUpdateMissingTracks()
}
checkUpdateMissingTracks() {
var currMissingParts = (this.missingParts || []).join(',') || ''
var current_index = 1
var missingParts = []
for (let i = 0; i < this.tracks.length; i++) {
var _track = this.tracks[i]
if (_track.index > current_index) {
var num_parts_missing = _track.index - current_index
for (let x = 0; x < num_parts_missing && x < 9999; x++) {
missingParts.push(current_index + x)
}
}
current_index = _track.index + 1
}
this.missingParts = missingParts
var newMissingParts = (this.missingParts || []).join(',') || ''
var wasUpdated = newMissingParts !== currMissingParts
if (wasUpdated && this.missingParts.length) {
Logger.info(`[Audiobook] "${this.name}" has ${missingParts.length} missing parts`)
}
return wasUpdated
}
setChapters() {
// If 1 audio file without chapters, then no chapters will be set
var includedAudioFiles = this.audioFiles.filter(af => !af.exclude)
if (includedAudioFiles.length === 1) {
// 1 audio file with chapters
if (includedAudioFiles[0].chapters) {
this.chapters = includedAudioFiles[0].chapters.map(c => ({ ...c }))
}
} else {
this.chapters = []
var currChapterId = 0
var currStartTime = 0
includedAudioFiles.forEach((file) => {
// If audio file has chapters use chapters
if (file.chapters && file.chapters.length) {
file.chapters.forEach((chapter) => {
var chapterDuration = chapter.end - chapter.start
if (chapterDuration > 0) {
var title = `Chapter ${currChapterId}`
if (chapter.title) {
title += ` (${chapter.title})`
}
this.chapters.push({
id: currChapterId++,
start: currStartTime,
end: currStartTime + chapterDuration,
title
})
currStartTime += chapterDuration
}
})
} else if (file.duration) {
// Otherwise just use track has chapter
this.chapters.push({
id: currChapterId++,
start: currStartTime,
end: currStartTime + file.duration,
title: file.metadata.filename ? Path.basename(file.metadata.filename, Path.extname(file.metadata.filename)) : `Chapter ${currChapterId}`
})
currStartTime += file.duration
}
})
}
}
findFileWithInode(inode) {
return this.audioFiles.find(af => af.ino === inode)
}
removeFileWithInode(inode) {
this.audioFiles = this.audioFiles.filter(af => af.ino !== inode)
}
}
module.exports = Audiobook

View File

@ -0,0 +1,70 @@
const EBookFile = require('../files/EBookFile')
const { areEquivalent, copyValue } = require('../../utils/index')
class EBook {
constructor(ebook) {
this.id = null
this.index = null
this.name = null
this.ebookFile = null
this.addedAt = null
this.updatedAt = null
if (ebook) {
this.construct(ebook)
}
}
construct(ebook) {
this.id = ebook.id
this.index = ebook.index
this.name = ebook.name
this.ebookFile = new EBookFile(ebook.ebookFile)
this.addedAt = ebook.addedAt
this.updatedAt = ebook.updatedAt
}
toJSON() {
return {
id: this.id,
index: this.index,
name: this.name,
ebookFile: this.ebookFile.toJSON(),
addedAt: this.addedAt,
updatedAt: this.updatedAt
}
}
toJSONMinified() {
return {
id: this.id,
index: this.index,
name: this.name,
ebookFormat: this.ebookFile.ebookFormat,
addedAt: this.addedAt,
updatedAt: this.updatedAt,
size: this.size
}
}
toJSONMinified() {
return {
id: this.id,
index: this.index,
name: this.name,
ebookFile: this.ebookFile.toJSON(),
addedAt: this.addedAt,
updatedAt: this.updatedAt,
size: this.size
}
}
get size() {
return this.ebookFile.metadata.size
}
findFileWithInode(inode) {
return this.ebookFile.ino === inode
}
}
module.exports = EBook

View File

@ -3,6 +3,7 @@ const AudioFile = require('../files/AudioFile')
class PodcastEpisode { class PodcastEpisode {
constructor(episode) { constructor(episode) {
this.id = null this.id = null
this.index = null
this.podcastId = null this.podcastId = null
this.episodeNumber = null this.episodeNumber = null
@ -17,6 +18,7 @@ class PodcastEpisode {
construct(episode) { construct(episode) {
this.id = episode.id this.id = episode.id
this.index = episode.index
this.podcastId = episode.podcastId this.podcastId = episode.podcastId
this.episodeNumber = episode.episodeNumber this.episodeNumber = episode.episodeNumber
this.audioFile = new AudioFile(episode.audioFile) this.audioFile = new AudioFile(episode.audioFile)
@ -27,6 +29,7 @@ class PodcastEpisode {
toJSON() { toJSON() {
return { return {
id: this.id, id: this.id,
index: this.index,
podcastId: this.podcastId, podcastId: this.podcastId,
episodeNumber: this.episodeNumber, episodeNumber: this.episodeNumber,
audioFile: this.audioFile.toJSON(), audioFile: this.audioFile.toJSON(),

View File

@ -1,23 +1,23 @@
const Path = require('path') const Path = require('path')
const Logger = require('../../Logger') const Logger = require('../../Logger')
const BookMetadata = require('../metadata/BookMetadata') const BookMetadata = require('../metadata/BookMetadata')
const AudioFile = require('../files/AudioFile')
const EBookFile = require('../files/EBookFile')
const abmetadataGenerator = require('../../utils/abmetadataGenerator') const abmetadataGenerator = require('../../utils/abmetadataGenerator')
const { areEquivalent, copyValue } = require('../../utils/index') const { areEquivalent, copyValue } = require('../../utils/index')
const { parseOpfMetadataXML } = require('../../utils/parseOpfMetadata') const { parseOpfMetadataXML } = require('../../utils/parseOpfMetadata')
const { readTextFile } = require('../../utils/fileUtils') const { readTextFile } = require('../../utils/fileUtils')
const Audiobook = require('../entities/Audiobook')
const EBook = require('../entities/EBook')
class Book { class Book {
constructor(book) { constructor(book) {
this.metadata = null this.metadata = null
this.coverPath = null this.coverPath = null
this.tags = [] this.tags = []
this.audioFiles = []
this.ebookFiles = [] this.audiobooks = []
this.chapters = [] this.ebooks = []
this.missingParts = []
this.lastCoverSearch = null this.lastCoverSearch = null
this.lastCoverSearchQuery = null this.lastCoverSearchQuery = null
@ -31,10 +31,8 @@ class Book {
this.metadata = new BookMetadata(book.metadata) this.metadata = new BookMetadata(book.metadata)
this.coverPath = book.coverPath this.coverPath = book.coverPath
this.tags = [...book.tags] this.tags = [...book.tags]
this.audioFiles = book.audioFiles.map(f => new AudioFile(f)) this.audiobooks = book.audiobooks.map(ab => new Audiobook(ab))
this.ebookFiles = book.ebookFiles.map(f => new EBookFile(f)) this.ebooks = book.ebooks.map(eb => new EBook(eb))
this.chapters = book.chapters.map(c => ({ ...c }))
this.missingParts = book.missingParts ? [...book.missingParts] : []
this.lastCoverSearch = book.lastCoverSearch || null this.lastCoverSearch = book.lastCoverSearch || null
this.lastCoverSearchQuery = book.lastCoverSearchQuery || null this.lastCoverSearchQuery = book.lastCoverSearchQuery || null
} }
@ -44,10 +42,8 @@ class Book {
metadata: this.metadata.toJSON(), metadata: this.metadata.toJSON(),
coverPath: this.coverPath, coverPath: this.coverPath,
tags: [...this.tags], tags: [...this.tags],
audioFiles: this.audioFiles.map(f => f.toJSON()), audiobooks: this.audiobooks.map(ab => ab.toJSON()),
ebookFiles: this.ebookFiles.map(f => f.toJSON()), ebooks: this.ebooks.map(eb => eb.toJSON())
chapters: this.chapters.map(c => ({ ...c })),
missingParts: [...this.missingParts]
} }
} }
@ -56,11 +52,8 @@ class Book {
metadata: this.metadata.toJSON(), metadata: this.metadata.toJSON(),
coverPath: this.coverPath, coverPath: this.coverPath,
tags: [...this.tags], tags: [...this.tags],
numTracks: this.tracks.length, audiobooks: this.audiobooks.map(ab => ab.toJSONMinified()),
numAudioFiles: this.audioFiles.length, ebooks: this.ebooks.map(eb => eb.toJSONMinified()),
numEbooks: this.ebookFiles.length,
numChapters: this.chapters.length,
numMissingParts: this.missingParts.length,
duration: this.duration, duration: this.duration,
size: this.size size: this.size
} }
@ -71,13 +64,10 @@ class Book {
metadata: this.metadata.toJSONExpanded(), metadata: this.metadata.toJSONExpanded(),
coverPath: this.coverPath, coverPath: this.coverPath,
tags: [...this.tags], tags: [...this.tags],
audioFiles: this.audioFiles.map(f => f.toJSON()), audiobooks: this.audiobooks.map(ab => ab.toJSONExpanded()),
ebookFiles: this.ebookFiles.map(f => f.toJSON()), ebooks: this.ebooks.map(eb => eb.toJSONExpanded()),
chapters: this.chapters.map(c => ({ ...c })),
duration: this.duration, duration: this.duration,
size: this.size, size: this.size,
tracks: this.tracks.map(t => t.toJSON()),
missingParts: [...this.missingParts]
} }
} }
@ -94,8 +84,8 @@ class Book {
this.audioFiles.forEach((af) => total += af.metadata.size) this.audioFiles.forEach((af) => total += af.metadata.size)
return total return total
} }
get hasMediaFiles() { get hasMediaEntities() {
return !!(this.tracks.length + this.ebookFiles.length) return !!(this.audiobooks.length + this.ebooks.length)
} }
get shouldSearchForCover() { get shouldSearchForCover() {
if (this.coverPath) return false if (this.coverPath) return false
@ -103,11 +93,14 @@ class Book {
return (Date.now() - this.lastCoverSearch) > 1000 * 60 * 60 * 24 * 7 // 7 day return (Date.now() - this.lastCoverSearch) > 1000 * 60 * 60 * 24 * 7 // 7 day
} }
get hasEmbeddedCoverArt() { get hasEmbeddedCoverArt() {
return this.audioFiles.some(af => af.embeddedCoverArt) return this.audiobooks.some(ab => ab.hasEmbeddedCoverArt)
} }
update(payload) { update(payload) {
var json = this.toJSON() var json = this.toJSON()
delete json.audiobooks // do not update media entities here
delete json.ebooks
var hasUpdates = false var hasUpdates = false
for (const key in json) { for (const key in json) {
if (payload[key] !== undefined) { if (payload[key] !== undefined) {
@ -125,27 +118,6 @@ class Book {
return hasUpdates return hasUpdates
} }
updateAudioTracks(orderedFileData) {
var index = 1
this.audioFiles = orderedFileData.map((fileData) => {
var audioFile = this.audioFiles.find(af => af.ino === fileData.ino)
audioFile.manuallyVerified = true
audioFile.invalid = false
audioFile.error = null
if (fileData.exclude !== undefined) {
audioFile.exclude = !!fileData.exclude
}
if (audioFile.exclude) {
audioFile.index = -1
} else {
audioFile.index = index++
}
return audioFile
})
this.rebuildTracks()
}
updateCover(coverPath) { updateCover(coverPath) {
coverPath = coverPath.replace(/\\/g, '/') coverPath = coverPath.replace(/\\/g, '/')
if (this.coverPath === coverPath) return false if (this.coverPath === coverPath) return false
@ -153,50 +125,27 @@ class Book {
return true return true
} }
checkUpdateMissingTracks() {
var currMissingParts = (this.missingParts || []).join(',') || ''
var current_index = 1
var missingParts = []
for (let i = 0; i < this.tracks.length; i++) {
var _track = this.tracks[i]
if (_track.index > current_index) {
var num_parts_missing = _track.index - current_index
for (let x = 0; x < num_parts_missing && x < 9999; x++) {
missingParts.push(current_index + x)
}
}
current_index = _track.index + 1
}
this.missingParts = missingParts
var newMissingParts = (this.missingParts || []).join(',') || ''
var wasUpdated = newMissingParts !== currMissingParts
if (wasUpdated && this.missingParts.length) {
Logger.info(`[Book] "${this.metadata.title}" has ${missingParts.length} missing parts`)
}
return wasUpdated
}
removeFileWithInode(inode) { removeFileWithInode(inode) {
if (this.audioFiles.some(af => af.ino === inode)) { var audiobookWithIno = this.audiobooks.find(ab => ab.findFileWithInode(inode))
this.audioFiles = this.audioFiles.filter(af => af.ino !== inode) if (audiobookWithIno) {
audiobookWithIno.removeFileWithInode(inode)
if (!audiobookWithIno.audioFiles.length) { // All audio files removed = remove audiobook
this.audiobooks = this.audiobooks.filter(ab => ab.id !== audiobookWithIno.id)
}
return true return true
} }
if (this.ebookFiles.some(ef => ef.ino === inode)) { var ebookWithIno = this.ebooks.find(eb => eb.findFileWithInode(inode))
this.ebookFiles = this.ebookFiles.filter(ef => ef.ino !== inode) if (ebookWithIno) {
this.ebooks = this.ebooks.filter(eb => eb.id !== ebookWithIno.id) // Remove ebook
return true return true
} }
return false return false
} }
findFileWithInode(inode) { findFileWithInode(inode) {
var audioFile = this.audioFiles.find(af => af.ino == inode) var audioFile = this.audiobooks.find(ab => ab.findFileWithInode(inode))
if (audioFile) return audioFile if (audioFile) return audioFile
var ebookFile = this.ebookFiles.find(ef => ef.inode == inode) var ebookFile = this.ebooks.find(eb => eb.findFileWithInode(inode))
if (ebookFile) return ebookFile if (ebookFile) return ebookFile
return null return null
} }
@ -208,64 +157,13 @@ class Book {
// Audio file metadata tags map to book details (will not overwrite) // Audio file metadata tags map to book details (will not overwrite)
setMetadataFromAudioFile(overrideExistingDetails = false) { setMetadataFromAudioFile(overrideExistingDetails = false) {
if (!this.audioFiles.length) return false if (!this.audiobooks.length) return false
var audioFile = this.audioFiles[0] var audiobook = this.audiobooks[0]
var audioFile = audiobook.audioFiles[0]
if (!audioFile.metaTags) return false if (!audioFile.metaTags) return false
return this.metadata.setDataFromAudioMetaTags(audioFile.metaTags, overrideExistingDetails) return this.metadata.setDataFromAudioMetaTags(audioFile.metaTags, overrideExistingDetails)
} }
rebuildTracks() {
this.audioFiles.sort((a, b) => a.index - b.index)
this.missingParts = []
this.setChapters()
this.checkUpdateMissingTracks()
}
setChapters() {
// If 1 audio file without chapters, then no chapters will be set
var includedAudioFiles = this.audioFiles.filter(af => !af.exclude)
if (includedAudioFiles.length === 1) {
// 1 audio file with chapters
if (includedAudioFiles[0].chapters) {
this.chapters = includedAudioFiles[0].chapters.map(c => ({ ...c }))
}
} else {
this.chapters = []
var currChapterId = 0
var currStartTime = 0
includedAudioFiles.forEach((file) => {
// If audio file has chapters use chapters
if (file.chapters && file.chapters.length) {
file.chapters.forEach((chapter) => {
var chapterDuration = chapter.end - chapter.start
if (chapterDuration > 0) {
var title = `Chapter ${currChapterId}`
if (chapter.title) {
title += ` (${chapter.title})`
}
this.chapters.push({
id: currChapterId++,
start: currStartTime,
end: currStartTime + chapterDuration,
title
})
currStartTime += chapterDuration
}
})
} else if (file.duration) {
// Otherwise just use track has chapter
this.chapters.push({
id: currChapterId++,
start: currStartTime,
end: currStartTime + file.duration,
title: file.metadata.filename ? Path.basename(file.metadata.filename, Path.extname(file.metadata.filename)) : `Chapter ${currChapterId}`
})
currStartTime += file.duration
}
})
}
}
setData(scanMediaMetadata) { setData(scanMediaMetadata) {
this.metadata = new BookMetadata() this.metadata = new BookMetadata()
this.metadata.setData(scanMediaMetadata) this.metadata.setData(scanMediaMetadata)
@ -365,9 +263,13 @@ class Book {
} }
addEbookFile(libraryFile) { addEbookFile(libraryFile) {
var newEbook = new EBookFile() // var newEbook = new EBookFile()
newEbook.setData(libraryFile) // newEbook.setData(libraryFile)
this.ebookFiles.push(newEbook) // this.ebookFiles.push(newEbook)
}
getDirectPlayTracklist(options) {
} }
} }
module.exports = Book module.exports = Book

View File

@ -1,4 +1,4 @@
const PodcastEpisode = require('./PodcastEpisode') const PodcastEpisode = require('../entities/PodcastEpisode')
const PodcastMetadata = require('../metadata/PodcastMetadata') const PodcastMetadata = require('../metadata/PodcastMetadata')
const { areEquivalent, copyValue } = require('../../utils/index') const { areEquivalent, copyValue } = require('../../utils/index')
@ -68,7 +68,7 @@ class Podcast {
get size() { get size() {
return 0 return 0
} }
get hasMediaFiles() { get hasMediaEntities() {
return !!this.episodes.length return !!this.episodes.length
} }
get shouldSearchForCover() { get shouldSearchForCover() {
@ -80,6 +80,7 @@ class Podcast {
update(payload) { update(payload) {
var json = this.toJSON() var json = this.toJSON()
delete json.episodes // do not update media entities here
var hasUpdates = false var hasUpdates = false
for (const key in json) { for (const key in json) {
if (payload[key] !== undefined) { if (payload[key] !== undefined) {
@ -129,5 +130,9 @@ class Podcast {
var payload = this.metadata.searchQuery(query) var payload = this.metadata.searchQuery(query)
return payload || {} return payload || {}
} }
getDirectPlayTracklist(options) {
}
} }
module.exports = Podcast module.exports = Podcast

View File

@ -49,6 +49,9 @@ class FileMetadata {
if (!this.ext) return '' if (!this.ext) return ''
return this.ext.slice(1) return this.ext.slice(1)
} }
get filenameNoExt() {
return this.filename.replace(this.ext, '')
}
update(payload) { update(payload) {
var hasUpdates = false var hasUpdates = false

View File

@ -109,7 +109,7 @@ class Scanner {
} }
} }
if (!libraryItem.hasMediaFiles) { // Library Item is invalid if (!libraryItem.hasMediaEntities) { // Library Item is invalid
libraryItem.setInvalid() libraryItem.setInvalid()
hasUpdated = true hasUpdated = true
} else if (libraryItem.isInvalid) { } else if (libraryItem.isInvalid) {
@ -357,7 +357,7 @@ class Scanner {
// Temp authors & series are inserted - create them if found // Temp authors & series are inserted - create them if found
await this.createNewAuthorsAndSeries(libraryItem) await this.createNewAuthorsAndSeries(libraryItem)
if (!libraryItem.media.hasMediaFiles) { // Library item is invalid if (!libraryItem.hasMediaEntities) { // Library item is invalid
libraryItem.setInvalid() libraryItem.setInvalid()
hasUpdated = true hasUpdated = true
} else if (libraryItem.isInvalid) { } else if (libraryItem.isInvalid) {
@ -387,7 +387,7 @@ class Scanner {
await AudioFileScanner.scanAudioFiles(audioFiles, libraryItemData, libraryItem, preferAudioMetadata, libraryScan) await AudioFileScanner.scanAudioFiles(audioFiles, libraryItemData, libraryItem, preferAudioMetadata, libraryScan)
} }
if (!libraryItem.media.hasMediaFiles) { if (!libraryItem.hasMediaEntities) {
Logger.warn(`[Scanner] Library item has no media files "${libraryItemData.path}"`) Logger.warn(`[Scanner] Library item has no media files "${libraryItemData.path}"`)
return null return null
} }

View File

@ -3,21 +3,27 @@ const fs = require('fs-extra')
const njodb = require("njodb") const njodb = require("njodb")
const { SupportedEbookTypes } = require('./globals') const { SupportedEbookTypes } = require('./globals')
const Audiobook = require('../objects/legacy/Audiobook') const LegacyAudiobook = require('../objects/legacy/Audiobook')
const UserAudiobookData = require('../objects/legacy/UserAudiobookData') const UserAudiobookData = require('../objects/legacy/UserAudiobookData')
const LibraryItem = require('../objects/LibraryItem') const LibraryItem = require('../objects/LibraryItem')
const Logger = require('../Logger') const Logger = require('../Logger')
const Book = require('../objects/entities/Book') const Book = require('../objects/mediaTypes/Book')
const BookMetadata = require('../objects/metadata/BookMetadata') const BookMetadata = require('../objects/metadata/BookMetadata')
const Author = require('../objects/entities/Author') const FileMetadata = require('../objects/metadata/FileMetadata')
const Series = require('../objects/entities/Series')
const AudioFile = require('../objects/files/AudioFile') const AudioFile = require('../objects/files/AudioFile')
const EBookFile = require('../objects/files/EBookFile') const EBookFile = require('../objects/files/EBookFile')
const LibraryFile = require('../objects/files/LibraryFile') const LibraryFile = require('../objects/files/LibraryFile')
const FileMetadata = require('../objects/metadata/FileMetadata')
const AudioMetaTags = require('../objects/metadata/AudioMetaTags') const AudioMetaTags = require('../objects/metadata/AudioMetaTags')
const Author = require('../objects/entities/Author')
const Series = require('../objects/entities/Series')
const Audiobook = require('../objects/entities/Audiobook')
const EBook = require('../objects/entities/EBook')
const LibraryItemProgress = require('../objects/user/LibraryItemProgress') const LibraryItemProgress = require('../objects/user/LibraryItemProgress')
const PlaybackSession = require('../objects/PlaybackSession') const PlaybackSession = require('../objects/PlaybackSession')
@ -40,7 +46,7 @@ async function loadAudiobooks() {
var audiobooksDb = new njodb.Database(audiobookPath) var audiobooksDb = new njodb.Database(audiobookPath)
return audiobooksDb.select(() => true).then((results) => { return audiobooksDb.select(() => true).then((results) => {
return results.data.map(a => new Audiobook(a)) return results.data.map(a => new LegacyAudiobook(a))
}) })
} }
@ -144,7 +150,7 @@ function makeFilesFromOldAb(audiobook) {
function makeLibraryItemFromOldAb(audiobook) { function makeLibraryItemFromOldAb(audiobook) {
var libraryItem = new LibraryItem() var libraryItem = new LibraryItem()
libraryItem.id = audiobook.id libraryItem.id = getId('li')
libraryItem.ino = audiobook.ino libraryItem.ino = audiobook.ino
libraryItem.libraryId = audiobook.libraryId libraryItem.libraryId = audiobook.libraryId
libraryItem.folderId = audiobook.folderId libraryItem.folderId = audiobook.folderId
@ -154,7 +160,7 @@ function makeLibraryItemFromOldAb(audiobook) {
libraryItem.ctimeMs = audiobook.ctimeMs || 0 libraryItem.ctimeMs = audiobook.ctimeMs || 0
libraryItem.birthtimeMs = audiobook.birthtimeMs || 0 libraryItem.birthtimeMs = audiobook.birthtimeMs || 0
libraryItem.addedAt = audiobook.addedAt libraryItem.addedAt = audiobook.addedAt
libraryItem.lastUpdate = audiobook.lastUpdate libraryItem.updatedAt = audiobook.lastUpdate
libraryItem.lastScan = audiobook.lastScan libraryItem.lastScan = audiobook.lastScan
libraryItem.scanVersion = audiobook.scanVersion libraryItem.scanVersion = audiobook.scanVersion
libraryItem.isMissing = audiobook.isMissing libraryItem.isMissing = audiobook.isMissing
@ -179,13 +185,35 @@ function makeLibraryItemFromOldAb(audiobook) {
bookEntity.tags = [...audiobook.tags] bookEntity.tags = [...audiobook.tags]
var payload = makeFilesFromOldAb(audiobook) var payload = makeFilesFromOldAb(audiobook)
bookEntity.audioFiles = payload.audioFiles if (payload.audioFiles.length) {
bookEntity.ebookFiles = payload.ebookFiles var newAudiobook = new Audiobook()
newAudiobook.id = audiobook.id
newAudiobook.index = 1
newAudiobook.name = 'default'
newAudiobook.audioFiles = payload.audioFiles
if (audiobook.chapters && audiobook.chapters.length) {
newAudiobook.chapters = audiobook.chapters.map(c => ({ ...c }))
}
newAudiobook.missingParts = audiobook.missingParts || []
newAudiobook.addedAt = audiobook.addedAt
newAudiobook.updatedAt = audiobook.lastUpdate
if (audiobook.chapters && audiobook.chapters.length) { bookEntity.audiobooks.push(newAudiobook)
bookEntity.chapters = audiobook.chapters.map(c => ({ ...c }))
} }
var ebookIndex = 1
payload.ebookFiles.forEach(ebookFile => {
var newEBook = new EBook()
newEBook.id = getId('eb')
newEBook.index = ebookIndex++
newEBook.name = ebookFile.metadata.filenameNoExt
newEBook.ebookFile = ebookFile
newEBook.addedAt = audiobook.addedAt
newEBook.updatedAt = audiobook.lastUpdate
bookEntity.ebooks.push(newEBook)
})
libraryItem.media = bookEntity libraryItem.media = bookEntity
libraryItem.libraryFiles = payload.libraryFiles libraryItem.libraryFiles = payload.libraryFiles
return libraryItem return libraryItem
@ -234,8 +262,8 @@ async function migrateLibraryItems(db) {
} }
module.exports.migrateLibraryItems = migrateLibraryItems module.exports.migrateLibraryItems = migrateLibraryItems
function cleanUserObject(db, userObj) {
function cleanUserObject(db, userObj) {
var cleanedUserPayload = { var cleanedUserPayload = {
...userObj, ...userObj,
libraryItemProgress: [], libraryItemProgress: [],