Merge master

server/controllers/LibraryController.js

@@ -391,7 +391,13 @@ class LibraryController {
     res.sendStatus(200)
   }
 
-  // api/libraries/:id/series
+  /**
+   * api/libraries/:id/series
+   * Optional query string: `?include=rssfeed` that adds `rssFeed` to series if a feed is open
+   * 
+   * @param {*} req 
+   * @param {*} res 
+   */
   async getAllSeriesForLibrary(req, res) {
     const libraryItems = req.libraryItems
 
@@ -452,6 +458,42 @@ class LibraryController {
     res.json(payload)
   }
 
+  /**
+   * 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<llid>, libraryItemIdsFinished:Array<llid>, 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 = req.libraryItems.filter(li => li.media.metadata.hasSeries?.(series.id))
+
+    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 = this.rssFeedManager.findFeedForEntityId(seriesJson.id)
+      seriesJson.rssFeed = feedObj?.toJSONMinified() || null
+    }
+
+    res.json(seriesJson)
+  }
+
   // api/libraries/:id/collections
   async getCollectionsForLibrary(req, res) {
     const libraryItems = req.libraryItems
@@ -859,7 +901,7 @@ class LibraryController {
   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(404)
+      return res.sendStatus(403)
     }
 
     const library = Database.libraries.find(lib => lib.id === req.params.id)

server/controllers/SeriesController.js

@@ -5,6 +5,16 @@ const Database = require('../Database')
 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)
 
@@ -29,7 +39,7 @@ class SeriesController {
       seriesJson.rssFeed = feedObj?.toJSONMinified() || null
     }
 
-    return res.json(seriesJson)
+    res.json(seriesJson)
   }
 
   async search(req, res) {
@@ -56,9 +66,13 @@ class SeriesController {
     const series = Database.series.find(se => se.id === req.params.id)
     if (!series) return res.sendStatus(404)
 
-    const libraryItemsInSeries = Database.libraryItems.filter(li => li.media.metadata.hasSeries?.(series.id))
-    if (libraryItemsInSeries.some(li => !req.user.checkCanAccessLibrary(li.libraryId))) {
-      Logger.warn(`[SeriesController] User attempted to access series "${series.id}" without access to the library`, req.user)
+    /**
+     * Filter out any library items not accessible to user
+     */
+    const libraryItems = Database.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)
     }
 
@@ -71,7 +85,7 @@ class SeriesController {
     }
 
     req.series = series
-    req.libraryItemsInSeries = libraryItemsInSeries
+    req.libraryItemsInSeries = libraryItemsAccessible
     next()
   }
 }