const Sequelize = require('sequelize') const Path = require('path') const fs = require('../libs/fsExtra') const filePerms = require('../utils/filePerms') const Logger = require('../Logger') const SocketAuthority = require('../SocketAuthority') const Library = require('../objects/Library') const libraryHelpers = require('../utils/libraryHelpers') const libraryItemsBookFilters = require('../utils/queries/libraryItemsBookFilters') const libraryItemFilters = require('../utils/queries/libraryItemFilters') const seriesFilters = require('../utils/queries/seriesFilters') const { sort, createNewSortInstance } = require('../libs/fastSort') const naturalSort = createNewSortInstance({ comparer: new Intl.Collator(undefined, { numeric: true, sensitivity: 'base' }).compare }) const Database = require('../Database') const libraryFilters = require('../utils/queries/libraryFilters') const libraryItemsPodcastFilters = require('../utils/queries/libraryItemsPodcastFilters') const authorFilters = require('../utils/queries/authorFilters') class LibraryController { constructor() { } async create(req, res) { const newLibraryPayload = { ...req.body } if (!newLibraryPayload.name || !newLibraryPayload.folders || !newLibraryPayload.folders.length) { return res.status(500).send('Invalid request') } // Validate folder paths exist or can be created & resolve rel paths // returns 400 if a folder fails to access newLibraryPayload.folders = newLibraryPayload.folders.map(f => { f.fullPath = Path.resolve(f.fullPath) return f }) for (const folder of newLibraryPayload.folders) { try { const direxists = await fs.pathExists(folder.fullPath) if (!direxists) { // If folder does not exist try to make it and set file permissions/owner await fs.mkdir(folder.fullPath) await filePerms.setDefault(folder.fullPath) } } catch (error) { Logger.error(`[LibraryController] Failed to ensure folder dir "${folder.fullPath}"`, error) return res.status(400).send(`Invalid folder directory "${folder.fullPath}"`) } } const library = new Library() let currentLargestDisplayOrder = await Database.models.library.getMaxDisplayOrder() if (isNaN(currentLargestDisplayOrder)) currentLargestDisplayOrder = 0 newLibraryPayload.displayOrder = currentLargestDisplayOrder + 1 library.setData(newLibraryPayload) await Database.createLibrary(library) // Only emit to users with access to library const userFilter = (user) => { return user.checkCanAccessLibrary?.(library.id) } SocketAuthority.emitter('library_added', library.toJSON(), userFilter) // Add library watcher this.watcher.addLibrary(library) res.json(library) } async findAll(req, res) { const libraries = await Database.models.library.getAllOldLibraries() const librariesAccessible = req.user.librariesAccessible || [] if (librariesAccessible.length) { return res.json({ libraries: libraries.filter(lib => librariesAccessible.includes(lib.id)).map(lib => lib.toJSON()) }) } res.json({ libraries: libraries.map(lib => lib.toJSON()) }) } async findOne(req, res) { const includeArray = (req.query.include || '').split(',') if (includeArray.includes('filterdata')) { const filterdata = await libraryFilters.getFilterData(req.library) return res.json({ filterdata, issues: filterdata.numIssues, numUserPlaylists: await Database.models.playlist.getNumPlaylistsForUserAndLibrary(req.user.id, req.library.id), library: req.library }) } return res.json(req.library) } /** * GET: /api/libraries/:id/episode-downloads * Get podcast episodes in download queue * @param {*} req * @param {*} res */ async getEpisodeDownloadQueue(req, res) { const libraryDownloadQueueDetails = this.podcastManager.getDownloadQueueDetails(req.library.id) res.json(libraryDownloadQueueDetails) } async update(req, res) { const library = req.library // Validate new folder paths exist or can be created & resolve rel paths // returns 400 if a new folder fails to access if (req.body.folders) { const newFolderPaths = [] req.body.folders = req.body.folders.map(f => { if (!f.id) { f.fullPath = Path.resolve(f.fullPath) newFolderPaths.push(f.fullPath) } return f }) for (const path of newFolderPaths) { const pathExists = await fs.pathExists(path) if (!pathExists) { // Ensure dir will recursively create directories which might be preferred over mkdir const success = await fs.ensureDir(path).then(() => true).catch((error) => { Logger.error(`[LibraryController] Failed to ensure folder dir "${path}"`, error) return false }) if (!success) { return res.status(400).send(`Invalid folder directory "${path}"`) } // Set permissions on newly created path await filePerms.setDefault(path) } } // Handle removing folders for (const folder of library.folders) { if (!req.body.folders.some(f => f.id === folder.id)) { // Remove library items in folder const libraryItemsInFolder = await Database.models.libraryItem.findAll({ where: { libraryFolderId: folder.id }, attributes: ['id', 'mediaId', 'mediaType'], include: [ { model: Database.models.podcast, attributes: ['id'], include: { model: Database.models.podcastEpisode, attributes: ['id'] } } ] }) Logger.info(`[LibraryController] Removed folder "${folder.fullPath}" from library "${library.name}" with ${libraryItemsInFolder.length} library items`) for (const libraryItem of libraryItemsInFolder) { let mediaItemIds = [] if (library.isPodcast) { mediaItemIds = libraryItem.media.podcastEpisodes.map(pe => pe.id) } else { mediaItemIds.push(libraryItem.mediaId) } Logger.info(`[LibraryController] Removing library item "${libraryItem.id}" from folder "${folder.fullPath}"`) await this.handleDeleteLibraryItem(libraryItem.mediaType, libraryItem.id, mediaItemIds) } } } } const hasUpdates = library.update(req.body) // TODO: Should check if this is an update to folder paths or name only if (hasUpdates) { // Update watcher this.watcher.updateLibrary(library) // Update auto scan cron this.cronManager.updateLibraryScanCron(library) await Database.updateLibrary(library) // Only emit to users with access to library const userFilter = (user) => { return user.checkCanAccessLibrary && user.checkCanAccessLibrary(library.id) } SocketAuthority.emitter('library_updated', library.toJSON(), userFilter) await Database.resetLibraryIssuesFilterData(library.id) } return res.json(library.toJSON()) } /** * DELETE: /api/libraries/:id * Delete a library * @param {*} req * @param {*} res */ async delete(req, res) { const library = req.library // Remove library watcher this.watcher.removeLibrary(library) // Remove collections for library const numCollectionsRemoved = await Database.models.collection.removeAllForLibrary(library.id) if (numCollectionsRemoved) { Logger.info(`[Server] Removed ${numCollectionsRemoved} collections for library "${library.name}"`) } // Remove items in this library const libraryItemsInLibrary = await Database.models.libraryItem.findAll({ where: { libraryId: library.id }, attributes: ['id', 'mediaId', 'mediaType'], include: [ { model: Database.models.podcast, attributes: ['id'], include: { model: Database.models.podcastEpisode, attributes: ['id'] } } ] }) Logger.info(`[LibraryController] Removing ${libraryItemsInLibrary.length} library items in library "${library.name}"`) for (const libraryItem of libraryItemsInLibrary) { let mediaItemIds = [] if (library.isPodcast) { mediaItemIds = libraryItem.media.podcastEpisodes.map(pe => pe.id) } else { mediaItemIds.push(libraryItem.mediaId) } Logger.info(`[LibraryController] Removing library item "${libraryItem.id}" from library "${library.name}"`) await this.handleDeleteLibraryItem(libraryItem.mediaType, libraryItem.id, mediaItemIds) } const libraryJson = library.toJSON() await Database.removeLibrary(library.id) // Re-order libraries await Database.models.library.resetDisplayOrder() SocketAuthority.emitter('library_removed', libraryJson) // Remove library filter data if (Database.libraryFilterData[library.id]) { delete Database.libraryFilterData[library.id] } return res.json(libraryJson) } async getLibraryItemsNew(req, res) { const include = (req.query.include || '').split(',').map(v => v.trim().toLowerCase()).filter(v => !!v) const payload = { results: [], total: undefined, limit: req.query.limit && !isNaN(req.query.limit) ? Number(req.query.limit) : 0, page: req.query.page && !isNaN(req.query.page) ? Number(req.query.page) : 0, sortBy: req.query.sort, sortDesc: req.query.desc === '1', filterBy: req.query.filter, mediaType: req.library.mediaType, minified: req.query.minified === '1', collapseseries: req.query.collapseseries === '1', include: include.join(',') } payload.offset = payload.page * payload.limit const { libraryItems, count } = await Database.models.libraryItem.getByFilterAndSort(req.library, req.user, payload) payload.results = libraryItems payload.total = count res.json(payload) } /** * GET: /api/libraries/:id/items * TODO: Remove after implementing getLibraryItemsNew * @param {*} req * @param {*} res */ async getLibraryItems(req, res) { let libraryItems = req.libraryItems const include = (req.query.include || '').split(',').map(v => v.trim().toLowerCase()).filter(v => !!v) const payload = { results: [], total: libraryItems.length, limit: req.query.limit && !isNaN(req.query.limit) ? Number(req.query.limit) : 0, page: req.query.page && !isNaN(req.query.page) ? Number(req.query.page) : 0, sortBy: req.query.sort, sortDesc: req.query.desc === '1', filterBy: req.query.filter, mediaType: req.library.mediaType, minified: req.query.minified === '1', collapseseries: req.query.collapseseries === '1', include: include.join(',') } const mediaIsBook = payload.mediaType === 'book' const mediaIsPodcast = payload.mediaType === 'podcast' // Step 1 - Filter the retrieved library items let filterSeries = null if (payload.filterBy) { libraryItems = await libraryHelpers.getFilteredLibraryItems(libraryItems, payload.filterBy, req.user) payload.total = libraryItems.length // Determining if we are filtering titles by a series, and if so, which series filterSeries = (mediaIsBook && payload.filterBy.startsWith('series.')) ? libraryHelpers.decode(payload.filterBy.replace('series.', '')) : null if (filterSeries === 'no-series') filterSeries = null } // Step 2 - If selected, collapse library items by the series they belong to. // If also filtering by series, will not collapse the filtered series as this would lead // to series having a collapsed series that is just that series. if (payload.collapseseries) { let collapsedItems = libraryHelpers.collapseBookSeries(libraryItems, Database.series, filterSeries, req.library.settings.hideSingleBookSeries) if (!(collapsedItems.length == 1 && collapsedItems[0].collapsedSeries)) { libraryItems = collapsedItems payload.total = libraryItems.length } } // Step 3 - Sort the retrieved library items. const sortArray = [] // When on the series page, sort by sequence only if (filterSeries && !payload.sortBy) { sortArray.push({ asc: (li) => li.media.metadata.getSeries(filterSeries).sequence }) // If no series sequence then fallback to sorting by title (or collapsed series name for sub-series) sortArray.push({ asc: (li) => { if (Database.serverSettings.sortingIgnorePrefix) { return li.collapsedSeries?.nameIgnorePrefix || li.media.metadata.titleIgnorePrefix } else { return li.collapsedSeries?.name || li.media.metadata.title } } }) } if (payload.sortBy) { let sortKey = payload.sortBy // Handle server setting sortingIgnorePrefix const sortByTitle = sortKey === 'media.metadata.title' if (sortByTitle && Database.serverSettings.sortingIgnorePrefix) { // BookMetadata.js has titleIgnorePrefix getter sortKey += 'IgnorePrefix' } // If series are collapsed and not sorting by title or sequence, // sort all collapsed series to the end in alphabetical order const sortBySequence = filterSeries && (sortKey === 'sequence') if (payload.collapseseries && !(sortByTitle || sortBySequence)) { sortArray.push({ asc: (li) => { if (li.collapsedSeries) { return Database.serverSettings.sortingIgnorePrefix ? li.collapsedSeries.nameIgnorePrefix : li.collapsedSeries.name } else { return '' } } }) } // Sort series based on the sortBy attribute const direction = payload.sortDesc ? 'desc' : 'asc' sortArray.push({ [direction]: (li) => { if (mediaIsBook && sortBySequence) { return li.media.metadata.getSeries(filterSeries).sequence } else if (mediaIsBook && sortByTitle && li.collapsedSeries) { return Database.serverSettings.sortingIgnorePrefix ? li.collapsedSeries.nameIgnorePrefix : li.collapsedSeries.name } else { // Supports dot notation strings i.e. "media.metadata.title" return sortKey.split('.').reduce((a, b) => a[b], li) } } }) // Secondary sort when sorting by book author use series sort title if (mediaIsBook && payload.sortBy.includes('author')) { sortArray.push({ asc: (li) => { if (li.media.metadata.series && li.media.metadata.series.length) { return li.media.metadata.getSeriesSortTitle(li.media.metadata.series[0]) } return null } }) } } if (sortArray.length) { libraryItems = naturalSort(libraryItems).by(sortArray) } // Step 3.5: Limit items if (payload.limit) { const startIndex = payload.page * payload.limit libraryItems = libraryItems.slice(startIndex, startIndex + payload.limit) } // Step 4 - Transform the items to pass to the client side payload.results = await Promise.all(libraryItems.map(async li => { const json = payload.minified ? li.toJSONMinified() : li.toJSON() if (li.collapsedSeries) { json.collapsedSeries = { id: li.collapsedSeries.id, name: li.collapsedSeries.name, nameIgnorePrefix: li.collapsedSeries.nameIgnorePrefix, libraryItemIds: li.collapsedSeries.books.map(b => b.id), numBooks: li.collapsedSeries.books.length } // If collapsing by series and filtering by a series, generate the list of sequences the collapsed // series represents in the filtered series if (filterSeries) { json.collapsedSeries.seriesSequenceList = naturalSort(li.collapsedSeries.books.filter(b => b.filterSeriesSequence).map(b => b.filterSeriesSequence)).asc() .reduce((ranges, currentSequence) => { let lastRange = ranges.at(-1) let isNumber = /^(\d+|\d+\.\d*|\d*\.\d+)$/.test(currentSequence) if (isNumber) currentSequence = parseFloat(currentSequence) if (lastRange && isNumber && lastRange.isNumber && ((lastRange.end + 1) == currentSequence)) { lastRange.end = currentSequence } else { ranges.push({ start: currentSequence, end: currentSequence, isNumber: isNumber }) } return ranges }, []) .map(r => r.start == r.end ? r.start : `${r.start}-${r.end}`) .join(', ') } } else { // add rssFeed object if "include=rssfeed" was put in query string (only for non-collapsed series) if (include.includes('rssfeed')) { const feedData = await this.rssFeedManager.findFeedForEntityId(json.id) json.rssFeed = feedData ? feedData.toJSONMinified() : null } // add numEpisodesIncomplete if "include=numEpisodesIncomplete" was put in query string (only for podcasts) if (mediaIsPodcast && include.includes('numepisodesincomplete')) { json.numEpisodesIncomplete = req.user.getNumEpisodesIncompleteForPodcast(li) } if (filterSeries) { // If filtering by series, make sure to include the series metadata json.media.metadata.series = li.media.metadata.getSeries(filterSeries) } } return json })) res.json(payload) } /** * DELETE: /libraries/:id/issues * Remove all library items missing or invalid * @param {import('express').Request} req * @param {import('express').Response} res */ async removeLibraryItemsWithIssues(req, res) { const libraryItemsWithIssues = await Database.models.libraryItem.findAll({ where: { libraryId: req.library.id, [Sequelize.Op.or]: [ { isMissing: true }, { isInvalid: true } ] }, attributes: ['id', 'mediaId', 'mediaType'], include: [ { model: Database.models.podcast, attributes: ['id'], include: { model: Database.models.podcastEpisode, attributes: ['id'] } } ] }) if (!libraryItemsWithIssues.length) { Logger.warn(`[LibraryController] No library items have issues`) return res.sendStatus(200) } Logger.info(`[LibraryController] Removing ${libraryItemsWithIssues.length} items with issues`) for (const libraryItem of libraryItemsWithIssues) { let mediaItemIds = [] if (req.library.isPodcast) { mediaItemIds = libraryItem.media.podcastEpisodes.map(pe => pe.id) } else { mediaItemIds.push(libraryItem.mediaId) } Logger.info(`[LibraryController] Removing library item "${libraryItem.id}" with issue`) await this.handleDeleteLibraryItem(libraryItem.mediaType, libraryItem.id, mediaItemIds) } // Set numIssues to 0 for library filter data if (Database.libraryFilterData[req.library.id]) { Database.libraryFilterData[req.library.id].numIssues = 0 } res.sendStatus(200) } /** * GET: /api/libraries/:id/series * Optional query string: `?include=rssfeed` that adds `rssFeed` to series if a feed is open * * @param {import('express').Request} req * @param {import('express').Response} res */ async getAllSeriesForLibrary(req, res) { const include = (req.query.include || '').split(',').map(v => v.trim().toLowerCase()).filter(v => !!v) const payload = { results: [], total: 0, limit: req.query.limit && !isNaN(req.query.limit) ? Number(req.query.limit) : 0, page: req.query.page && !isNaN(req.query.page) ? Number(req.query.page) : 0, sortBy: req.query.sort, sortDesc: req.query.desc === '1', filterBy: req.query.filter, minified: req.query.minified === '1', include: include.join(',') } const offset = payload.page * payload.limit const { series, count } = await seriesFilters.getFilteredSeries(req.library, req.user, payload.filterBy, payload.sortBy, payload.sortDesc, include, payload.limit, offset) payload.total = count payload.results = series res.json(payload) } /** * GET: /api/libraries/:id/series/:seriesId * * Optional includes (e.g. `?include=rssfeed,progress`) * rssfeed: adds `rssFeed` to series object if a feed is open * progress: adds `progress` to series object with { libraryItemIds:Array, libraryItemIdsFinished:Array, isFinished:boolean } * * @param {*} req * @param {*} res - Series */ async getSeriesForLibrary(req, res) { const include = (req.query.include || '').split(',').map(v => v.trim().toLowerCase()).filter(v => !!v) const series = Database.series.find(se => se.id === req.params.seriesId) if (!series) return res.sendStatus(404) const libraryItemsInSeries = await libraryItemsBookFilters.getLibraryItemsForSeries(series, req.user) const seriesJson = series.toJSON() if (include.includes('progress')) { const libraryItemsFinished = libraryItemsInSeries.filter(li => !!req.user.getMediaProgress(li.id)?.isFinished) seriesJson.progress = { libraryItemIds: libraryItemsInSeries.map(li => li.id), libraryItemIdsFinished: libraryItemsFinished.map(li => li.id), isFinished: libraryItemsFinished.length >= libraryItemsInSeries.length } } if (include.includes('rssfeed')) { const feedObj = await this.rssFeedManager.findFeedForEntityId(seriesJson.id) seriesJson.rssFeed = feedObj?.toJSONMinified() || null } res.json(seriesJson) } /** * GET: /api/libraries/:id/collections * Get all collections for library * @param {*} req * @param {*} res */ async getCollectionsForLibrary(req, res) { const include = (req.query.include || '').split(',').map(v => v.trim().toLowerCase()).filter(v => !!v) const payload = { results: [], total: 0, limit: req.query.limit && !isNaN(req.query.limit) ? Number(req.query.limit) : 0, page: req.query.page && !isNaN(req.query.page) ? Number(req.query.page) : 0, sortBy: req.query.sort, sortDesc: req.query.desc === '1', filterBy: req.query.filter, minified: req.query.minified === '1', include: include.join(',') } // TODO: Create paginated queries let collections = await Database.models.collection.getOldCollectionsJsonExpanded(req.user, req.library.id, include) payload.total = collections.length if (payload.limit) { const startIndex = payload.page * payload.limit collections = collections.slice(startIndex, startIndex + payload.limit) } payload.results = collections res.json(payload) } /** * GET: /api/libraries/:id/playlists * Get playlists for user in library * @param {*} req * @param {*} res */ async getUserPlaylistsForLibrary(req, res) { let playlistsForUser = await Database.models.playlist.getPlaylistsForUserAndLibrary(req.user.id, req.library.id) playlistsForUser = await Promise.all(playlistsForUser.map(async p => p.getOldJsonExpanded())) const payload = { results: [], total: playlistsForUser.length, limit: req.query.limit && !isNaN(req.query.limit) ? Number(req.query.limit) : 0, page: req.query.page && !isNaN(req.query.page) ? Number(req.query.page) : 0 } if (payload.limit) { const startIndex = payload.page * payload.limit playlistsForUser = playlistsForUser.slice(startIndex, startIndex + payload.limit) } payload.results = playlistsForUser res.json(payload) } /** * GET: /api/libraries/:id/filterdata * @param {import('express').Request} req * @param {import('express').Response} res */ async getLibraryFilterData(req, res) { const filterData = await libraryFilters.getFilterData(req.library) res.json(filterData) } /** * GET: /api/libraries/:id/personalized * Home page shelves * @param {import('express').Request} req * @param {import('express').Response} res */ async getUserPersonalizedShelves(req, res) { const limitPerShelf = req.query.limit && !isNaN(req.query.limit) ? Number(req.query.limit) || 10 : 10 const include = (req.query.include || '').split(',').map(v => v.trim().toLowerCase()).filter(v => !!v) const shelves = await Database.libraryItemModel.getPersonalizedShelves(req.library, req.user, include, limitPerShelf) res.json(shelves) } /** * POST: /api/libraries/order * Change the display order of libraries * @param {import('express').Request} req * @param {import('express').Response} res */ async reorder(req, res) { if (!req.user.isAdminOrUp) { Logger.error('[LibraryController] ReorderLibraries invalid user', req.user) return res.sendStatus(403) } const libraries = await Database.models.library.getAllOldLibraries() const orderdata = req.body let hasUpdates = false for (let i = 0; i < orderdata.length; i++) { const library = libraries.find(lib => lib.id === orderdata[i].id) if (!library) { Logger.error(`[LibraryController] Invalid library not found in reorder ${orderdata[i].id}`) return res.sendStatus(500) } if (library.update({ displayOrder: orderdata[i].newOrder })) { hasUpdates = true await Database.updateLibrary(library) } } if (hasUpdates) { libraries.sort((a, b) => a.displayOrder - b.displayOrder) Logger.debug(`[LibraryController] Updated library display orders`) } else { Logger.debug(`[LibraryController] Library orders were up to date`) } res.json({ libraries: libraries.map(lib => lib.toJSON()) }) } /** * GET: /api/libraries/:id/search * Search library items with query * ?q=search * @param {import('express').Request} req * @param {import('express').Response} res */ async search(req, res) { if (!req.query.q) { return res.status(400).send('No query string') } const limit = req.query.limit && !isNaN(req.query.limit) ? Number(req.query.limit) : 12 const query = req.query.q.trim().toLowerCase() const matches = await libraryItemFilters.search(req.user, req.library, query, limit) res.json(matches) } /** * GET: /api/libraries/:id/stats * Get stats for library * @param {import('express').Request} req * @param {import('express').Response} res */ async stats(req, res) { const stats = { largestItems: await libraryItemFilters.getLargestItems(req.library.id, 10) } if (req.library.isBook) { const authors = await authorFilters.getAuthorsWithCount(req.library.id) const genres = await libraryItemsBookFilters.getGenresWithCount(req.library.id) const bookStats = await libraryItemsBookFilters.getBookLibraryStats(req.library.id) const longestBooks = await libraryItemsBookFilters.getLongestBooks(req.library.id, 10) stats.totalAuthors = authors.length stats.authorsWithCount = authors stats.totalGenres = genres.length stats.genresWithCount = genres stats.totalItems = bookStats.totalItems stats.longestItems = longestBooks stats.totalSize = bookStats.totalSize stats.totalDuration = bookStats.totalDuration stats.numAudioTracks = bookStats.numAudioFiles } else { const genres = await libraryItemsPodcastFilters.getGenresWithCount(req.library.id) const podcastStats = await libraryItemsPodcastFilters.getPodcastLibraryStats(req.library.id) const longestPodcasts = await libraryItemsPodcastFilters.getLongestPodcasts(req.library.id, 10) stats.totalGenres = genres.length stats.genresWithCount = genres stats.totalItems = podcastStats.totalItems stats.longestItems = longestPodcasts stats.totalSize = podcastStats.totalSize stats.totalDuration = podcastStats.totalDuration stats.numAudioTracks = podcastStats.numAudioFiles } res.json(stats) } /** * GET: /api/libraries/:id/authors * Get authors for library * @param {import('express').Request} req * @param {import('express').Response} res */ async getAuthors(req, res) { const { bookWhere, replacements } = libraryItemsBookFilters.getUserPermissionBookWhereQuery(req.user) const authors = await Database.authorModel.findAll({ where: { libraryId: req.library.id }, replacements, include: { model: Database.models.book, attributes: ['id', 'tags', 'explicit'], where: bookWhere, required: true, through: { attributes: [] } }, order: [ [Sequelize.literal('name COLLATE NOCASE'), 'ASC'] ] }) const oldAuthors = [] for (const author of authors) { const oldAuthor = author.getOldAuthor().toJSON() oldAuthor.numBooks = author.books.length oldAuthors.push(oldAuthor) } res.json({ authors: oldAuthors }) } /** * GET: /api/libraries/:id/narrators * @param {*} req * @param {*} res */ async getNarrators(req, res) { // Get all books with narrators const booksWithNarrators = await Database.models.book.findAll({ where: Sequelize.where(Sequelize.fn('json_array_length', Sequelize.col('narrators')), { [Sequelize.Op.gt]: 0 }), include: { model: Database.models.libraryItem, attributes: ['id', 'libraryId'], where: { libraryId: req.library.id } }, attributes: ['id', 'narrators'] }) const narrators = {} for (const book of booksWithNarrators) { book.narrators.forEach(n => { if (typeof n !== 'string') { Logger.error(`[LibraryController] getNarrators: Invalid narrator "${n}" on book "${book.title}"`) } else if (!narrators[n]) { narrators[n] = { id: encodeURIComponent(Buffer.from(n).toString('base64')), name: n, numBooks: 1 } } else { narrators[n].numBooks++ } }) } res.json({ narrators: naturalSort(Object.values(narrators)).asc(n => n.name) }) } /** * PATCH: /api/libraries/:id/narrators/:narratorId * Update narrator name * :narratorId is base64 encoded name * req.body { name } * @param {*} req * @param {*} res */ async updateNarrator(req, res) { if (!req.user.canUpdate) { Logger.error(`[LibraryController] Unauthorized user "${req.user.username}" attempted to update narrator`) return res.sendStatus(403) } const narratorName = libraryHelpers.decode(req.params.narratorId) const updatedName = req.body.name if (!updatedName) { return res.status(400).send('Invalid request payload. Name not specified.') } // Update filter data Database.removeNarratorFromFilterData(narratorName) Database.addNarratorToFilterData(updatedName) const itemsUpdated = [] const itemsWithNarrator = await libraryItemFilters.getAllLibraryItemsWithNarrators([narratorName]) for (const libraryItem of itemsWithNarrator) { libraryItem.media.narrators = libraryItem.media.narrators.filter(n => n !== narratorName) if (!libraryItem.media.narrators.includes(updatedName)) { libraryItem.media.narrators.push(updatedName) } await libraryItem.media.update({ narrators: libraryItem.media.narrators }) const oldLibraryItem = Database.models.libraryItem.getOldLibraryItem(libraryItem) itemsUpdated.push(oldLibraryItem) } if (itemsUpdated.length) { SocketAuthority.emitter('items_updated', itemsUpdated.map(li => li.toJSONExpanded())) } res.json({ updated: itemsUpdated.length }) } /** * DELETE: /api/libraries/:id/narrators/:narratorId * Remove narrator * :narratorId is base64 encoded name * @param {*} req * @param {*} res */ async removeNarrator(req, res) { if (!req.user.canUpdate) { Logger.error(`[LibraryController] Unauthorized user "${req.user.username}" attempted to remove narrator`) return res.sendStatus(403) } const narratorName = libraryHelpers.decode(req.params.narratorId) // Update filter data Database.removeNarratorFromFilterData(narratorName) const itemsUpdated = [] const itemsWithNarrator = await libraryItemFilters.getAllLibraryItemsWithNarrators([narratorName]) for (const libraryItem of itemsWithNarrator) { libraryItem.media.narrators = libraryItem.media.narrators.filter(n => n !== narratorName) await libraryItem.media.update({ narrators: libraryItem.media.narrators }) const oldLibraryItem = Database.models.libraryItem.getOldLibraryItem(libraryItem) itemsUpdated.push(oldLibraryItem) } if (itemsUpdated.length) { SocketAuthority.emitter('items_updated', itemsUpdated.map(li => li.toJSONExpanded())) } res.json({ updated: itemsUpdated.length }) } async matchAll(req, res) { if (!req.user.isAdminOrUp) { Logger.error(`[LibraryController] Non-root user attempted to match library items`, req.user) return res.sendStatus(403) } this.scanner.matchLibraryItems(req.library) res.sendStatus(200) } // POST: api/libraries/:id/scan async scan(req, res) { if (!req.user.isAdminOrUp) { Logger.error(`[LibraryController] Non-root user attempted to scan library`, req.user) return res.sendStatus(403) } const options = { forceRescan: req.query.force == 1 } res.sendStatus(200) await this.scanner.scan(req.library, options) await Database.resetLibraryIssuesFilterData(req.library.id) Logger.info('[LibraryController] Scan complete') } /** * GET: /api/libraries/:id/recent-episodes * Used for latest page * @param {import('express').Request} req * @param {import('express').Response} res */ async getRecentEpisodes(req, res) { if (!req.library.isPodcast) { return res.sendStatus(404) } const payload = { episodes: [], limit: req.query.limit && !isNaN(req.query.limit) ? Number(req.query.limit) : 0, page: req.query.page && !isNaN(req.query.page) ? Number(req.query.page) : 0, } const offset = payload.page * payload.limit payload.episodes = await libraryItemsPodcastFilters.getRecentEpisodes(req.user, req.library, payload.limit, offset) res.json(payload) } /** * GET: /api/libraries/:id/opml * Get OPML file for a podcast library * @param {import('express').Request} req * @param {import('express').Response} res */ async getOPMLFile(req, res) { const userPermissionPodcastWhere = libraryItemsPodcastFilters.getUserPermissionPodcastWhereQuery(req.user) const podcasts = await Database.podcastModel.findAll({ attributes: ['id', 'feedURL', 'title', 'description', 'itunesPageURL', 'language'], where: userPermissionPodcastWhere.podcastWhere, replacements: userPermissionPodcastWhere.replacements, include: { model: Database.libraryItemModel, attributes: ['id', 'libraryId'], where: { libraryId: req.library.id } } }) const opmlText = this.podcastManager.generateOPMLFileText(podcasts) res.type('application/xml') res.send(opmlText) } /** * TODO: Replace with middlewareNew * @param {*} req * @param {*} res * @param {*} next */ async middleware(req, res, next) { if (!req.user.checkCanAccessLibrary(req.params.id)) { Logger.warn(`[LibraryController] Library ${req.params.id} not accessible to user ${req.user.username}`) return res.sendStatus(403) } const library = await Database.models.library.getOldById(req.params.id) if (!library) { return res.status(404).send('Library not found') } req.library = library req.libraryItems = Database.libraryItems.filter(li => { return li.libraryId === library.id && req.user.checkCanAccessLibraryItem(li) }) next() } /** * Middleware that is not using libraryItems from memory * @param {import('express').Request} req * @param {import('express').Response} res * @param {import('express').NextFunction} next */ async middlewareNew(req, res, next) { if (!req.user.checkCanAccessLibrary(req.params.id)) { Logger.warn(`[LibraryController] Library ${req.params.id} not accessible to user ${req.user.username}`) return res.sendStatus(403) } const library = await Database.models.library.getOldById(req.params.id) if (!library) { return res.status(404).send('Library not found') } req.library = library next() } } module.exports = new LibraryController()