audiobookshelf/server/Database.js

793 lines
25 KiB
JavaScript
Raw Normal View History

2023-07-05 01:14:44 +02:00
const Path = require('path')
const { Sequelize, Op } = require('sequelize')
2023-07-05 01:14:44 +02:00
const packageJson = require('../package.json')
const fs = require('./libs/fsExtra')
const Logger = require('./Logger')
const dbMigration = require('./utils/migrations/dbMigration')
2023-07-22 22:32:20 +02:00
const Auth = require('./Auth')
2023-07-05 01:14:44 +02:00
const MigrationManager = require('./managers/MigrationManager')
2023-07-05 01:14:44 +02:00
class Database {
constructor() {
this.sequelize = null
this.dbPath = null
2023-07-08 21:40:49 +02:00
this.isNew = false // New absdatabase.sqlite created
2023-07-22 22:32:20 +02:00
this.hasRootUser = false // Used to show initialization page in web ui
2023-07-05 01:14:44 +02:00
this.settings = []
// Cached library filter data
this.libraryFilterData = {}
/** @type {import('./objects/settings/ServerSettings')} */
2023-07-05 01:14:44 +02:00
this.serverSettings = null
/** @type {import('./objects/settings/NotificationSettings')} */
2023-07-05 01:14:44 +02:00
this.notificationSettings = null
/** @type {import('./objects/settings/EmailSettings')} */
2023-07-05 01:14:44 +02:00
this.emailSettings = null
}
get models() {
return this.sequelize?.models || {}
}
2023-08-20 20:34:03 +02:00
/** @type {typeof import('./models/User')} */
get userModel() {
return this.models.user
}
/** @type {typeof import('./models/Library')} */
get libraryModel() {
return this.models.library
}
2023-09-04 00:51:58 +02:00
/** @type {typeof import('./models/LibraryFolder')} */
get libraryFolderModel() {
return this.models.libraryFolder
}
/** @type {typeof import('./models/Author')} */
get authorModel() {
return this.models.author
}
/** @type {typeof import('./models/Series')} */
get seriesModel() {
return this.models.series
}
/** @type {typeof import('./models/Book')} */
get bookModel() {
return this.models.book
}
2023-08-20 20:34:03 +02:00
/** @type {typeof import('./models/BookSeries')} */
get bookSeriesModel() {
return this.models.bookSeries
}
/** @type {typeof import('./models/BookAuthor')} */
get bookAuthorModel() {
return this.models.bookAuthor
}
/** @type {typeof import('./models/Podcast')} */
get podcastModel() {
return this.models.podcast
}
2023-08-20 20:34:03 +02:00
/** @type {typeof import('./models/PodcastEpisode')} */
get podcastEpisodeModel() {
return this.models.podcastEpisode
}
/** @type {typeof import('./models/LibraryItem')} */
get libraryItemModel() {
return this.models.libraryItem
}
/** @type {typeof import('./models/PodcastEpisode')} */
get podcastEpisodeModel() {
return this.models.podcastEpisode
}
/** @type {typeof import('./models/MediaProgress')} */
get mediaProgressModel() {
return this.models.mediaProgress
}
2023-08-20 20:34:03 +02:00
/** @type {typeof import('./models/Collection')} */
get collectionModel() {
return this.models.collection
}
/** @type {typeof import('./models/CollectionBook')} */
get collectionBookModel() {
return this.models.collectionBook
}
/** @type {typeof import('./models/Playlist')} */
get playlistModel() {
return this.models.playlist
}
/** @type {typeof import('./models/PlaylistMediaItem')} */
get playlistMediaItemModel() {
return this.models.playlistMediaItem
}
/** @type {typeof import('./models/Feed')} */
get feedModel() {
return this.models.feed
}
2023-12-20 00:19:33 +01:00
/** @type {typeof import('./models/FeedEpisode')} */
2023-08-20 20:34:03 +02:00
get feedEpisodeModel() {
return this.models.feedEpisode
}
2023-12-20 00:19:33 +01:00
/** @type {typeof import('./models/PlaybackSession')} */
get playbackSessionModel() {
return this.models.playbackSession
}
/** @type {typeof import('./models/CustomMetadataProvider')} */
get customMetadataProviderModel() {
return this.models.customMetadataProvider
}
/** @type {typeof import('./models/MediaItemShare')} */
get mediaItemShareModel() {
return this.models.mediaItemShare
}
/**
* Check if db file exists
* @returns {boolean}
*/
2023-07-05 01:14:44 +02:00
async checkHasDb() {
if (!(await fs.pathExists(this.dbPath))) {
2023-07-08 21:40:49 +02:00
Logger.info(`[Database] absdatabase.sqlite not found at ${this.dbPath}`)
2023-07-05 01:14:44 +02:00
return false
}
return true
}
/**
* Connect to db, build models and run migrations
* @param {boolean} [force=false] Used for testing, drops & re-creates all tables
*/
2023-07-05 01:14:44 +02:00
async init(force = false) {
2023-07-08 21:40:49 +02:00
this.dbPath = Path.join(global.ConfigPath, 'absdatabase.sqlite')
2023-07-05 01:14:44 +02:00
// First check if this is a new database
this.isNew = !(await this.checkHasDb()) || force
if (!(await this.connect())) {
2023-07-05 01:14:44 +02:00
throw new Error('Database connection failed')
}
2024-09-07 21:24:19 +02:00
try {
const migrationManager = new MigrationManager(this.sequelize, global.ConfigPath)
await migrationManager.init(packageJson.version)
if (!this.isNew) await migrationManager.runMigrations()
} catch (error) {
Logger.error(`[Database] Failed to run migrations`, error)
throw new Error('Database migration failed')
}
2023-07-05 01:14:44 +02:00
await this.buildModels(force)
Logger.info(`[Database] Db initialized with models:`, Object.keys(this.sequelize.models).join(', '))
2023-07-05 01:14:44 +02:00
2023-07-08 21:40:49 +02:00
await this.loadData()
2023-07-05 01:14:44 +02:00
}
/**
* Connect to db
* @returns {boolean}
*/
2023-07-05 01:14:44 +02:00
async connect() {
Logger.info(`[Database] Initializing db at "${this.dbPath}"`)
2023-09-22 23:14:12 +02:00
let logging = false
let benchmark = false
if (process.env.QUERY_LOGGING === 'log') {
// Setting QUERY_LOGGING=log will log all Sequelize queries before they run
2023-09-15 08:04:47 +02:00
Logger.info(`[Database] Query logging enabled`)
logging = (query) => Logger.debug(`Running the following query:\n ${query}`)
} else if (process.env.QUERY_LOGGING === 'benchmark') {
// Setting QUERY_LOGGING=benchmark will log all Sequelize queries and their execution times, after they run
Logger.info(`[Database] Query benchmarking enabled"`)
logging = (query, time) => Logger.debug(`Ran the following query in ${time}ms:\n ${query}`)
2023-09-22 23:14:00 +02:00
benchmark = true
}
2023-07-05 01:14:44 +02:00
this.sequelize = new Sequelize({
dialect: 'sqlite',
storage: this.dbPath,
logging: logging,
benchmark: benchmark,
transactionType: 'IMMEDIATE'
2023-07-05 01:14:44 +02:00
})
// Helper function
this.sequelize.uppercaseFirst = (str) => (str ? `${str[0].toUpperCase()}${str.substr(1)}` : '')
2023-07-05 01:14:44 +02:00
try {
await this.sequelize.authenticate()
Logger.info(`[Database] Db connection was successful`)
return true
} catch (error) {
Logger.error(`[Database] Failed to connect to db`, error)
return false
}
}
/**
* TODO: Temporarily disabled
* @param {string[]} extensions paths to extension binaries
*/
async loadExtensions(extensions) {
// This is a hack to get the db connection for loading extensions.
// The proper way would be to use the 'afterConnect' hook, but that hook is never called for sqlite due to a bug in sequelize.
// See https://github.com/sequelize/sequelize/issues/12487
// This is not a public API and may break in the future.
const db = await this.sequelize.dialect.connectionManager.getConnection()
if (typeof db?.loadExtension !== 'function') throw new Error('Failed to get db connection for loading extensions')
for (const ext of extensions) {
Logger.info(`[Database] Loading extension ${ext}`)
await new Promise((resolve, reject) => {
db.loadExtension(ext, (err) => {
if (err) {
Logger.error(`[Database] Failed to load extension ${ext}`, err)
reject(err)
return
}
Logger.info(`[Database] Successfully loaded extension ${ext}`)
resolve()
})
})
}
}
/**
* Disconnect from db
*/
2023-07-08 21:40:49 +02:00
async disconnect() {
Logger.info(`[Database] Disconnecting sqlite db`)
await this.sequelize.close()
}
/**
* Reconnect to db and init
*/
2023-07-08 21:40:49 +02:00
async reconnect() {
Logger.info(`[Database] Reconnecting sqlite db`)
await this.init()
}
2023-07-05 01:14:44 +02:00
buildModels(force = false) {
2023-08-16 23:38:48 +02:00
require('./models/User').init(this.sequelize)
2023-08-16 01:03:43 +02:00
require('./models/Library').init(this.sequelize)
require('./models/LibraryFolder').init(this.sequelize)
require('./models/Book').init(this.sequelize)
2023-08-16 23:38:48 +02:00
require('./models/Podcast').init(this.sequelize)
require('./models/PodcastEpisode').init(this.sequelize)
require('./models/LibraryItem').init(this.sequelize)
require('./models/MediaProgress').init(this.sequelize)
require('./models/Series').init(this.sequelize)
2023-08-16 01:03:43 +02:00
require('./models/BookSeries').init(this.sequelize)
2023-08-15 01:22:38 +02:00
require('./models/Author').init(this.sequelize)
2023-08-16 01:03:43 +02:00
require('./models/BookAuthor').init(this.sequelize)
require('./models/Collection').init(this.sequelize)
require('./models/CollectionBook').init(this.sequelize)
2023-08-16 23:38:48 +02:00
require('./models/Playlist').init(this.sequelize)
require('./models/PlaylistMediaItem').init(this.sequelize)
2023-08-16 01:03:43 +02:00
require('./models/Device').init(this.sequelize)
2023-08-16 23:38:48 +02:00
require('./models/PlaybackSession').init(this.sequelize)
2023-08-16 01:03:43 +02:00
require('./models/Feed').init(this.sequelize)
require('./models/FeedEpisode').init(this.sequelize)
2023-08-16 23:38:48 +02:00
require('./models/Setting').init(this.sequelize)
require('./models/CustomMetadataProvider').init(this.sequelize)
require('./models/MediaItemShare').init(this.sequelize)
2023-07-05 01:14:44 +02:00
2023-07-06 01:18:37 +02:00
return this.sequelize.sync({ force, alter: false })
2023-07-05 01:14:44 +02:00
}
2023-07-21 23:59:00 +02:00
/**
* Compare two server versions
* @param {string} v1
* @param {string} v2
2023-07-21 23:59:00 +02:00
* @returns {-1|0|1} 1 if v1 > v2
*/
compareVersions(v1, v2) {
if (!v1 || !v2) return 0
return v1.localeCompare(v2, undefined, { numeric: true, sensitivity: 'case', caseFirst: 'upper' })
2023-07-21 23:59:00 +02:00
}
/**
* Checks if migration to sqlite db is necessary & runs migration.
*
* Check if version was upgraded and run any version specific migrations.
*
* Loads most of the data from the database. This is a temporary solution.
*/
2023-07-08 21:40:49 +02:00
async loadData() {
if (this.isNew && (await dbMigration.checkShouldMigrate())) {
2023-07-05 01:14:44 +02:00
Logger.info(`[Database] New database was created and old database was detected - migrating old to new`)
await dbMigration.migrate(this.models)
}
const settingsData = await this.models.setting.getOldSettings()
this.settings = settingsData.settings
this.emailSettings = settingsData.emailSettings
this.serverSettings = settingsData.serverSettings
this.notificationSettings = settingsData.notificationSettings
global.ServerSettings = this.serverSettings.toJSON()
// Version specific migrations
if (packageJson.version !== this.serverSettings.version) {
if (this.serverSettings.version === '2.3.0' && this.compareVersions(packageJson.version, '2.3.0') == 1) {
await dbMigration.migrationPatch(this)
}
if (['2.3.0', '2.3.1', '2.3.2', '2.3.3'].includes(this.serverSettings.version) && this.compareVersions(packageJson.version, '2.3.3') >= 0) {
await dbMigration.migrationPatch2(this)
}
}
// Build migrations
if (this.serverSettings.buildNumber <= 0) {
await require('./utils/migrations/absMetadataMigration').migrate(this)
}
await this.cleanDatabase()
2023-07-22 22:32:20 +02:00
// Set if root user has been created
this.hasRootUser = await this.models.user.getHasRootUser()
// Update server settings with version/build
let updateServerSettings = false
2023-07-05 01:14:44 +02:00
if (packageJson.version !== this.serverSettings.version) {
Logger.info(`[Database] Server upgrade detected from ${this.serverSettings.version} to ${packageJson.version}`)
this.serverSettings.version = packageJson.version
this.serverSettings.buildNumber = packageJson.buildNumber
updateServerSettings = true
} else if (packageJson.buildNumber !== this.serverSettings.buildNumber) {
Logger.info(`[Database] Server v${packageJson.version} build upgraded from ${this.serverSettings.buildNumber} to ${packageJson.buildNumber}`)
this.serverSettings.buildNumber = packageJson.buildNumber
updateServerSettings = true
}
if (updateServerSettings) {
2023-07-05 01:14:44 +02:00
await this.updateServerSettings()
}
}
2023-07-22 22:32:20 +02:00
/**
* Create root user
* @param {string} username
* @param {string} pash
* @param {Auth} auth
* @returns {Promise<boolean>} true if created
2023-07-22 22:32:20 +02:00
*/
async createRootUser(username, pash, auth) {
2023-07-08 21:40:49 +02:00
if (!this.sequelize) return false
await this.userModel.createRootUser(username, pash, auth)
2023-07-22 22:32:20 +02:00
this.hasRootUser = true
return true
2023-07-05 01:14:44 +02:00
}
updateServerSettings() {
2023-07-08 21:40:49 +02:00
if (!this.sequelize) return false
2023-07-05 01:14:44 +02:00
global.ServerSettings = this.serverSettings.toJSON()
return this.updateSetting(this.serverSettings)
}
updateSetting(settings) {
2023-07-08 21:40:49 +02:00
if (!this.sequelize) return false
2023-07-05 01:14:44 +02:00
return this.models.setting.updateSettingObj(settings.toJSON())
}
updateBulkBooks(oldBooks) {
2023-07-08 21:40:49 +02:00
if (!this.sequelize) return false
return Promise.all(oldBooks.map((oldBook) => this.models.book.saveFromOld(oldBook)))
2023-07-05 01:14:44 +02:00
}
removeLibrary(libraryId) {
2023-07-08 21:40:49 +02:00
if (!this.sequelize) return false
return this.models.library.removeById(libraryId)
2023-07-05 01:14:44 +02:00
}
createBulkCollectionBooks(collectionBooks) {
2023-07-08 21:40:49 +02:00
if (!this.sequelize) return false
2023-07-05 01:14:44 +02:00
return this.models.collectionBook.bulkCreate(collectionBooks)
}
createPlaylistMediaItem(playlistMediaItem) {
2023-07-08 21:40:49 +02:00
if (!this.sequelize) return false
2023-07-05 01:14:44 +02:00
return this.models.playlistMediaItem.create(playlistMediaItem)
}
createBulkPlaylistMediaItems(playlistMediaItems) {
2023-07-08 21:40:49 +02:00
if (!this.sequelize) return false
2023-07-05 01:14:44 +02:00
return this.models.playlistMediaItem.bulkCreate(playlistMediaItems)
}
async createLibraryItem(oldLibraryItem) {
2023-07-08 21:40:49 +02:00
if (!this.sequelize) return false
await oldLibraryItem.saveMetadata()
2023-07-05 01:14:44 +02:00
await this.models.libraryItem.fullCreateFromOld(oldLibraryItem)
}
/**
* Save metadata file and update library item
*
* @param {import('./objects/LibraryItem')} oldLibraryItem
* @returns {Promise<boolean>}
*/
async updateLibraryItem(oldLibraryItem) {
2023-07-08 21:40:49 +02:00
if (!this.sequelize) return false
await oldLibraryItem.saveMetadata()
const updated = await this.models.libraryItem.fullUpdateFromOld(oldLibraryItem)
// Clear library filter data cache
2024-03-09 11:07:08 +01:00
if (updated) {
delete this.libraryFilterData[oldLibraryItem.libraryId]
}
return updated
2023-07-05 01:14:44 +02:00
}
2023-07-06 01:18:37 +02:00
async createFeed(oldFeed) {
2023-07-08 21:40:49 +02:00
if (!this.sequelize) return false
2023-07-06 01:18:37 +02:00
await this.models.feed.fullCreateFromOld(oldFeed)
2023-07-05 01:14:44 +02:00
}
updateFeed(oldFeed) {
2023-07-08 21:40:49 +02:00
if (!this.sequelize) return false
2023-07-06 01:18:37 +02:00
return this.models.feed.fullUpdateFromOld(oldFeed)
2023-07-05 01:14:44 +02:00
}
async removeFeed(feedId) {
2023-07-08 21:40:49 +02:00
if (!this.sequelize) return false
2023-07-05 01:14:44 +02:00
await this.models.feed.removeById(feedId)
}
async createBulkBookAuthors(bookAuthors) {
2023-07-08 21:40:49 +02:00
if (!this.sequelize) return false
2023-07-05 01:14:44 +02:00
await this.models.bookAuthor.bulkCreate(bookAuthors)
}
async removeBulkBookAuthors(authorId = null, bookId = null) {
2023-07-08 21:40:49 +02:00
if (!this.sequelize) return false
2023-07-05 01:14:44 +02:00
if (!authorId && !bookId) return
await this.models.bookAuthor.removeByIds(authorId, bookId)
}
getPlaybackSessions(where = null) {
2023-07-08 21:40:49 +02:00
if (!this.sequelize) return false
2023-07-05 01:14:44 +02:00
return this.models.playbackSession.getOldPlaybackSessions(where)
}
getPlaybackSession(sessionId) {
2023-07-08 21:40:49 +02:00
if (!this.sequelize) return false
2023-07-05 01:14:44 +02:00
return this.models.playbackSession.getById(sessionId)
}
createPlaybackSession(oldSession) {
2023-07-08 21:40:49 +02:00
if (!this.sequelize) return false
2023-07-05 01:14:44 +02:00
return this.models.playbackSession.createFromOld(oldSession)
}
updatePlaybackSession(oldSession) {
2023-07-08 21:40:49 +02:00
if (!this.sequelize) return false
2023-07-05 01:14:44 +02:00
return this.models.playbackSession.updateFromOld(oldSession)
}
removePlaybackSession(sessionId) {
2023-07-08 21:40:49 +02:00
if (!this.sequelize) return false
2023-07-05 01:14:44 +02:00
return this.models.playbackSession.removeById(sessionId)
}
getDeviceByDeviceId(deviceId) {
2023-07-08 21:40:49 +02:00
if (!this.sequelize) return false
2023-07-05 01:14:44 +02:00
return this.models.device.getOldDeviceByDeviceId(deviceId)
}
updateDevice(oldDevice) {
2023-07-08 21:40:49 +02:00
if (!this.sequelize) return false
2023-07-05 01:14:44 +02:00
return this.models.device.updateFromOld(oldDevice)
}
createDevice(oldDevice) {
2023-07-08 21:40:49 +02:00
if (!this.sequelize) return false
2023-07-05 01:14:44 +02:00
return this.models.device.createFromOld(oldDevice)
}
replaceTagInFilterData(oldTag, newTag) {
for (const libraryId in this.libraryFilterData) {
const indexOf = this.libraryFilterData[libraryId].tags.findIndex((n) => n === oldTag)
if (indexOf >= 0) {
this.libraryFilterData[libraryId].tags.splice(indexOf, 1, newTag)
}
}
}
removeTagFromFilterData(tag) {
for (const libraryId in this.libraryFilterData) {
this.libraryFilterData[libraryId].tags = this.libraryFilterData[libraryId].tags.filter((t) => t !== tag)
}
}
addTagsToFilterData(libraryId, tags) {
if (!this.libraryFilterData[libraryId] || !tags?.length) return
tags.forEach((t) => {
if (!this.libraryFilterData[libraryId].tags.includes(t)) {
this.libraryFilterData[libraryId].tags.push(t)
}
})
}
replaceGenreInFilterData(oldGenre, newGenre) {
for (const libraryId in this.libraryFilterData) {
const indexOf = this.libraryFilterData[libraryId].genres.findIndex((n) => n === oldGenre)
if (indexOf >= 0) {
this.libraryFilterData[libraryId].genres.splice(indexOf, 1, newGenre)
}
}
}
removeGenreFromFilterData(genre) {
for (const libraryId in this.libraryFilterData) {
this.libraryFilterData[libraryId].genres = this.libraryFilterData[libraryId].genres.filter((g) => g !== genre)
}
}
addGenresToFilterData(libraryId, genres) {
if (!this.libraryFilterData[libraryId] || !genres?.length) return
genres.forEach((g) => {
if (!this.libraryFilterData[libraryId].genres.includes(g)) {
this.libraryFilterData[libraryId].genres.push(g)
}
})
}
replaceNarratorInFilterData(oldNarrator, newNarrator) {
for (const libraryId in this.libraryFilterData) {
const indexOf = this.libraryFilterData[libraryId].narrators.findIndex((n) => n === oldNarrator)
if (indexOf >= 0) {
this.libraryFilterData[libraryId].narrators.splice(indexOf, 1, newNarrator)
}
}
}
removeNarratorFromFilterData(narrator) {
for (const libraryId in this.libraryFilterData) {
this.libraryFilterData[libraryId].narrators = this.libraryFilterData[libraryId].narrators.filter((n) => n !== narrator)
}
}
addNarratorsToFilterData(libraryId, narrators) {
if (!this.libraryFilterData[libraryId] || !narrators?.length) return
narrators.forEach((n) => {
if (!this.libraryFilterData[libraryId].narrators.includes(n)) {
this.libraryFilterData[libraryId].narrators.push(n)
}
})
}
removeSeriesFromFilterData(libraryId, seriesId) {
if (!this.libraryFilterData[libraryId]) return
this.libraryFilterData[libraryId].series = this.libraryFilterData[libraryId].series.filter((se) => se.id !== seriesId)
}
addSeriesToFilterData(libraryId, seriesName, seriesId) {
if (!this.libraryFilterData[libraryId]) return
// Check if series is already added
if (this.libraryFilterData[libraryId].series.some((se) => se.id === seriesId)) return
this.libraryFilterData[libraryId].series.push({
id: seriesId,
name: seriesName
})
}
removeAuthorFromFilterData(libraryId, authorId) {
if (!this.libraryFilterData[libraryId]) return
this.libraryFilterData[libraryId].authors = this.libraryFilterData[libraryId].authors.filter((au) => au.id !== authorId)
}
addAuthorToFilterData(libraryId, authorName, authorId) {
if (!this.libraryFilterData[libraryId]) return
// Check if author is already added
if (this.libraryFilterData[libraryId].authors.some((au) => au.id === authorId)) return
this.libraryFilterData[libraryId].authors.push({
id: authorId,
name: authorName
})
}
addPublisherToFilterData(libraryId, publisher) {
if (!this.libraryFilterData[libraryId] || !publisher || this.libraryFilterData[libraryId].publishers.includes(publisher)) return
this.libraryFilterData[libraryId].publishers.push(publisher)
}
addLanguageToFilterData(libraryId, language) {
if (!this.libraryFilterData[libraryId] || !language || this.libraryFilterData[libraryId].languages.includes(language)) return
this.libraryFilterData[libraryId].languages.push(language)
}
/**
* Used when updating items to make sure author id exists
* If library filter data is set then use that for check
* otherwise lookup in db
* @param {string} libraryId
* @param {string} authorId
* @returns {Promise<boolean>}
*/
async checkAuthorExists(libraryId, authorId) {
if (!this.libraryFilterData[libraryId]) {
return this.authorModel.checkExistsById(authorId)
}
return this.libraryFilterData[libraryId].authors.some((au) => au.id === authorId)
}
/**
* Used when updating items to make sure series id exists
* If library filter data is set then use that for check
* otherwise lookup in db
* @param {string} libraryId
* @param {string} seriesId
* @returns {Promise<boolean>}
*/
async checkSeriesExists(libraryId, seriesId) {
if (!this.libraryFilterData[libraryId]) {
return this.seriesModel.checkExistsById(seriesId)
}
return this.libraryFilterData[libraryId].series.some((se) => se.id === seriesId)
}
/**
* Get author id for library by name. Uses library filter data if available
*
* @param {string} libraryId
* @param {string} authorName
* @returns {Promise<string>} author id or null if not found
*/
async getAuthorIdByName(libraryId, authorName) {
if (!this.libraryFilterData[libraryId]) {
return (await this.authorModel.getByNameAndLibrary(authorName, libraryId))?.id || null
}
return this.libraryFilterData[libraryId].authors.find((au) => au.name === authorName)?.id || null
}
/**
* Get series id for library by name. Uses library filter data if available
*
* @param {string} libraryId
* @param {string} seriesName
* @returns {Promise<string>} series id or null if not found
*/
async getSeriesIdByName(libraryId, seriesName) {
if (!this.libraryFilterData[libraryId]) {
return (await this.seriesModel.getByNameAndLibrary(seriesName, libraryId))?.id || null
}
return this.libraryFilterData[libraryId].series.find((se) => se.name === seriesName)?.id || null
}
/**
* Reset numIssues for library
* @param {string} libraryId
*/
async resetLibraryIssuesFilterData(libraryId) {
if (!this.libraryFilterData[libraryId]) return // Do nothing if filter data is not set
this.libraryFilterData[libraryId].numIssues = await this.libraryItemModel.count({
where: {
libraryId,
[Sequelize.Op.or]: [
{
isMissing: true
},
{
isInvalid: true
}
]
}
})
}
/**
* Clean invalid records in database
* Series should have atleast one Book
* Book and Podcast must have an associated LibraryItem
* Remove playback sessions that are 3 seconds or less
*/
async cleanDatabase() {
// Remove invalid Podcast records
const podcastsWithNoLibraryItem = await this.podcastModel.findAll({
include: {
model: this.libraryItemModel,
required: false
},
where: { '$libraryItem.id$': null }
})
for (const podcast of podcastsWithNoLibraryItem) {
Logger.warn(`Found podcast "${podcast.title}" with no libraryItem - removing it`)
await podcast.destroy()
}
// Remove invalid Book records
const booksWithNoLibraryItem = await this.bookModel.findAll({
include: {
model: this.libraryItemModel,
required: false
},
where: { '$libraryItem.id$': null }
})
for (const book of booksWithNoLibraryItem) {
Logger.warn(`Found book "${book.title}" with no libraryItem - removing it`)
await book.destroy()
}
// Remove empty series
const emptySeries = await this.seriesModel.findAll({
include: {
model: this.bookSeriesModel,
required: false
},
where: { '$bookSeries.id$': null }
})
for (const series of emptySeries) {
Logger.warn(`Found series "${series.name}" with no books - removing it`)
await series.destroy()
}
// Remove playback sessions that were 3 seconds or less
const badSessionsRemoved = await this.playbackSessionModel.destroy({
where: {
timeListening: {
[Op.lte]: 3
}
}
})
if (badSessionsRemoved > 0) {
Logger.warn(`Removed ${badSessionsRemoved} sessions that were 3 seconds or less`)
}
}
/**
* TODO: Temporarily unused
* @param {string} value
* @returns {string}
*/
normalize(value) {
return `lower(unaccent(${value}))`
}
/**
* TODO: Temporarily unused
* @param {string} query
* @returns {Promise<string>}
*/
async getNormalizedQuery(query) {
const escapedQuery = this.sequelize.escape(query)
const normalizedQuery = this.normalize(escapedQuery)
const normalizedQueryResult = await this.sequelize.query(`SELECT ${normalizedQuery} as normalized_query`)
return normalizedQueryResult[0][0].normalized_query
}
/**
*
* @param {string} column
* @param {string} normalizedQuery
* @returns {string}
*/
matchExpression(column, normalizedQuery) {
const normalizedPattern = this.sequelize.escape(`%${normalizedQuery}%`)
const normalizedColumn = column
return `${normalizedColumn} LIKE ${normalizedPattern}`
}
2023-07-05 01:14:44 +02:00
}
module.exports = new Database()