audiobookshelf/server/controllers/SeriesController.js

const Logger = require('../Logger')
const SocketAuthority = require('../SocketAuthority')

class SeriesController {
  constructor() { }

  /**
   * @deprecated
   * /api/series/:id
   * 
   * TODO: Update mobile app to use /api/libraries/:id/series/:seriesId API route instead
   * Series are not library specific so we need to know what the library id is 
   * 
   * @param {*} req 
   * @param {*} res 
   */
  async findOne(req, res) {
    const include = (req.query.include || '').split(',').map(v => v.trim()).filter(v => !!v)

    const seriesJson = req.series.toJSON()

    // Add progress map with isFinished flag
    if (include.includes('progress')) {
      const libraryItemsInSeries = req.libraryItemsInSeries
      const libraryItemsFinished = libraryItemsInSeries.filter(li => {
        const mediaProgress = req.user.getMediaProgress(li.id)
        return mediaProgress && mediaProgress.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 = this.rssFeedManager.findFeedForEntityId(seriesJson.id)
      seriesJson.rssFeed = feedObj?.toJSONMinified() || null
    }

    res.json(seriesJson)
  }

  async search(req, res) {
    var q = (req.query.q || '').toLowerCase()
    if (!q) return res.json([])
    var limit = (req.query.limit && !isNaN(req.query.limit)) ? Number(req.query.limit) : 25
    var series = this.db.series.filter(se => se.name.toLowerCase().includes(q))
    series = series.slice(0, limit)
    res.json({
      results: series
    })
  }

  async update(req, res) {
    const hasUpdated = req.series.update(req.body)
    if (hasUpdated) {
      await this.db.updateEntity('series', req.series)
      SocketAuthority.emitter('series_updated', req.series.toJSON())
    }
    res.json(req.series.toJSON())
  }

  middleware(req, res, next) {
    const series = this.db.series.find(se => se.id === req.params.id)
    if (!series) return res.sendStatus(404)

    /**
     * Filter out any library items not accessible to user
     */
    const libraryItems = this.db.libraryItems.filter(li => li.media.metadata.hasSeries?.(series.id))
    const libraryItemsAccessible = libraryItems.filter(req.user.checkCanAccessLibraryItem)
    if (libraryItems.length && !libraryItemsAccessible.length) {
      Logger.warn(`[SeriesController] User attempted to access series "${series.id}" without access to any of the books`, req.user)
      return res.sendStatus(403)
    }

    if (req.method == 'DELETE' && !req.user.canDelete) {
      Logger.warn(`[SeriesController] User attempted to delete without permission`, req.user)
      return res.sendStatus(403)
    } else if ((req.method == 'PATCH' || req.method == 'POST') && !req.user.canUpdate) {
      Logger.warn('[SeriesController] User attempted to update without permission', req.user)
      return res.sendStatus(403)
    }

    req.series = series
    req.libraryItemsInSeries = libraryItemsAccessible
    next()
  }
}
module.exports = new SeriesController()