Update PluginManager to singleton, update PluginContext, support prompt object in plugin extension

server/Auth.js

@@ -940,7 +940,17 @@ class Auth {
       userDefaultLibraryId: user.getDefaultLibraryId(libraryIds),
       serverSettings: Database.serverSettings.toJSONForBrowser(),
       ereaderDevices: Database.emailSettings.getEReaderDevices(user),
-      plugins: this.pluginManifests,
+      // TODO: Should be better handled by the PluginManager
+      // restrict plugin extensions that are not allowed for the user type
+      plugins: this.pluginManifests.map((manifest) => {
+        const manifestExtensions = (manifest.extensions || []).filter((ext) => {
+          if (ext.restrictToAccountTypes?.length) {
+            return ext.restrictToAccountTypes.includes(user.type)
+          }
+          return true
+        })
+        return { ...manifest, extensions: manifestExtensions }
+      }),
       Source: global.Source
     }
   }

server/Server.js

@@ -28,7 +28,6 @@ const AbMergeManager = require('./managers/AbMergeManager')
 const CacheManager = require('./managers/CacheManager')
 const BackupManager = require('./managers/BackupManager')
 const PlaybackSessionManager = require('./managers/PlaybackSessionManager')
-const PodcastManager = require('./managers/PodcastManager')
 const AudioMetadataMangaer = require('./managers/AudioMetadataManager')
 const RssFeedManager = require('./managers/RssFeedManager')
 const CronManager = require('./managers/CronManager')
@@ -70,9 +69,8 @@ class Server {
     this.backupManager = new BackupManager()
     this.abMergeManager = new AbMergeManager()
     this.playbackSessionManager = new PlaybackSessionManager()
-    this.podcastManager = new PodcastManager()
     this.audioMetadataManager = new AudioMetadataMangaer()
-    this.cronManager = new CronManager(this.podcastManager, this.playbackSessionManager)
+    this.cronManager = new CronManager(this.playbackSessionManager)
     this.apiCacheManager = new ApiCacheManager()
     this.binaryManager = new BinaryManager()
 

server/controllers/LibraryController.js

@@ -19,6 +19,7 @@ const Scanner = require('../scanner/Scanner')
 const Database = require('../Database')
 const Watcher = require('../Watcher')
 const RssFeedManager = require('../managers/RssFeedManager')
+const PodcastManager = require('../managers/PodcastManager')
 
 const libraryFilters = require('../utils/queries/libraryFilters')
 const libraryItemsPodcastFilters = require('../utils/queries/libraryItemsPodcastFilters')
@@ -219,7 +220,7 @@ class LibraryController {
    * @param {Response} res
    */
   async getEpisodeDownloadQueue(req, res) {
-    const libraryDownloadQueueDetails = this.podcastManager.getDownloadQueueDetails(req.library.id)
+    const libraryDownloadQueueDetails = PodcastManager.getDownloadQueueDetails(req.library.id)
     res.json(libraryDownloadQueueDetails)
   }
 
@@ -1288,7 +1289,7 @@ class LibraryController {
       }
     })
 
-    const opmlText = this.podcastManager.generateOPMLFileText(podcasts)
+    const opmlText = PodcastManager.generateOPMLFileText(podcasts)
     res.type('application/xml')
     res.send(opmlText)
   }

server/controllers/LibraryItemController.js

@@ -18,6 +18,7 @@ const RssFeedManager = require('../managers/RssFeedManager')
 const CacheManager = require('../managers/CacheManager')
 const CoverManager = require('../managers/CoverManager')
 const ShareManager = require('../managers/ShareManager')
+const PodcastManager = require('../managers/PodcastManager')
 
 /**
  * @typedef RequestUserObject
@@ -59,10 +60,10 @@ class LibraryItemController {
       }
 
       if (item.mediaType === 'podcast' && includeEntities.includes('downloads')) {
-        const downloadsInQueue = this.podcastManager.getEpisodeDownloadsInQueue(req.libraryItem.id)
+        const downloadsInQueue = PodcastManager.getEpisodeDownloadsInQueue(req.libraryItem.id)
         item.episodeDownloadsQueued = downloadsInQueue.map((d) => d.toJSONForClient())
-        if (this.podcastManager.currentDownload?.libraryItemId === req.libraryItem.id) {
-          item.episodesDownloading = [this.podcastManager.currentDownload.toJSONForClient()]
+        if (PodcastManager.currentDownload?.libraryItemId === req.libraryItem.id) {
+          item.episodesDownloading = [PodcastManager.currentDownload.toJSONForClient()]
         }
       }
 

server/controllers/PodcastController.js

@@ -11,6 +11,7 @@ const { validateUrl } = require('../utils/index')
 
 const Scanner = require('../scanner/Scanner')
 const CoverManager = require('../managers/CoverManager')
+const PodcastManager = require('../managers/PodcastManager')
 
 const LibraryItem = require('../objects/LibraryItem')
 
@@ -114,7 +115,7 @@ class PodcastController {
 
     if (payload.episodesToDownload?.length) {
       Logger.info(`[PodcastController] Podcast created now starting ${payload.episodesToDownload.length} episode downloads`)
-      this.podcastManager.downloadPodcastEpisodes(libraryItem, payload.episodesToDownload)
+      PodcastManager.downloadPodcastEpisodes(libraryItem, payload.episodesToDownload)
     }
 
     // Turn on podcast auto download cron if not already on
@@ -169,7 +170,7 @@ class PodcastController {
     }
 
     res.json({
-      feeds: this.podcastManager.getParsedOPMLFileFeeds(req.body.opmlText)
+      feeds: PodcastManager.getParsedOPMLFileFeeds(req.body.opmlText)
     })
   }
 
@@ -203,7 +204,7 @@ class PodcastController {
       return res.status(404).send('Folder not found')
     }
     const autoDownloadEpisodes = !!req.body.autoDownloadEpisodes
-    this.podcastManager.createPodcastsFromFeedUrls(rssFeeds, folder, autoDownloadEpisodes, this.cronManager)
+    PodcastManager.createPodcastsFromFeedUrls(rssFeeds, folder, autoDownloadEpisodes, this.cronManager)
 
     res.sendStatus(200)
   }
@@ -230,7 +231,7 @@ class PodcastController {
 
     const maxEpisodesToDownload = !isNaN(req.query.limit) ? Number(req.query.limit) : 3
 
-    var newEpisodes = await this.podcastManager.checkAndDownloadNewEpisodes(libraryItem, maxEpisodesToDownload)
+    var newEpisodes = await PodcastManager.checkAndDownloadNewEpisodes(libraryItem, maxEpisodesToDownload)
     res.json({
       episodes: newEpisodes || []
     })
@@ -239,8 +240,6 @@ class PodcastController {
   /**
    * GET: /api/podcasts/:id/clear-queue
    *
-   * @this {import('../routers/ApiRouter')}
-   *
    * @param {RequestWithUser} req
    * @param {Response} res
    */
@@ -249,22 +248,20 @@ class PodcastController {
       Logger.error(`[PodcastController] Non-admin user "${req.user.username}" attempting to clear download queue`)
       return res.sendStatus(403)
     }
-    this.podcastManager.clearDownloadQueue(req.params.id)
+    PodcastManager.clearDownloadQueue(req.params.id)
     res.sendStatus(200)
   }
 
   /**
    * GET: /api/podcasts/:id/downloads
    *
-   * @this {import('../routers/ApiRouter')}
-   *
    * @param {RequestWithUser} req
    * @param {Response} res
    */
   getEpisodeDownloads(req, res) {
     var libraryItem = req.libraryItem
 
-    var downloadsInQueue = this.podcastManager.getEpisodeDownloadsInQueue(libraryItem.id)
+    var downloadsInQueue = PodcastManager.getEpisodeDownloadsInQueue(libraryItem.id)
     res.json({
       downloads: downloadsInQueue.map((d) => d.toJSONForClient())
     })
@@ -290,8 +287,6 @@ class PodcastController {
   /**
    * POST: /api/podcasts/:id/download-episodes
    *
-   * @this {import('../routers/ApiRouter')}
-   *
    * @param {RequestWithUser} req
    * @param {Response} res
    */
@@ -306,7 +301,7 @@ class PodcastController {
       return res.sendStatus(400)
     }
 
-    this.podcastManager.downloadPodcastEpisodes(libraryItem, episodes)
+    PodcastManager.downloadPodcastEpisodes(libraryItem, episodes)
     res.sendStatus(200)
   }
 

server/managers/CronManager.js

@@ -5,11 +5,10 @@ const Database = require('../Database')
 const LibraryScanner = require('../scanner/LibraryScanner')
 
 const ShareManager = require('./ShareManager')
+const PodcastManager = require('./PodcastManager')
 
 class CronManager {
-  constructor(podcastManager, playbackSessionManager) {
-    /** @type {import('./PodcastManager')} */
-    this.podcastManager = podcastManager
+  constructor(playbackSessionManager) {
     /** @type {import('./PlaybackSessionManager')} */
     this.playbackSessionManager = playbackSessionManager
 
@@ -163,7 +162,7 @@ class CronManager {
         task
       })
     } catch (error) {
-      Logger.error(`[PodcastManager] Failed to schedule podcast cron ${this.serverSettings.podcastEpisodeSchedule}`, error)
+      Logger.error(`[CronManager] Failed to schedule podcast cron ${this.serverSettings.podcastEpisodeSchedule}`, error)
     }
   }
 
@@ -192,7 +191,7 @@ class CronManager {
 
     // Run episode checks
     for (const libraryItem of libraryItems) {
-      const keepAutoDownloading = await this.podcastManager.runEpisodeCheck(libraryItem)
+      const keepAutoDownloading = await PodcastManager.runEpisodeCheck(libraryItem)
       if (!keepAutoDownloading) {
         // auto download was disabled
         podcastCron.libraryItemIds = podcastCron.libraryItemIds.filter((lid) => lid !== libraryItem.id) // Filter it out

server/managers/PluginManager.js

@@ -3,6 +3,9 @@ const Logger = require('../Logger')
 const Database = require('../Database')
 const SocketAuthority = require('../SocketAuthority')
 const TaskManager = require('../managers/TaskManager')
+const ShareManager = require('../managers/ShareManager')
+const RssFeedManager = require('../managers/RssFeedManager')
+const PodcastManager = require('../managers/PodcastManager')
 const fsExtra = require('../libs/fsExtra')
 const { isUUID, parseSemverStrict } = require('../utils')
 
@@ -13,6 +16,9 @@ const { isUUID, parseSemverStrict } = require('../utils')
  * @property {import('../SocketAuthority')} SocketAuthority
  * @property {import('../managers/TaskManager')} TaskManager
  * @property {import('../models/Plugin')} pluginInstance
+ * @property {import('../managers/ShareManager')} ShareManager
+ * @property {import('../managers/RssFeedManager')} RssFeedManager
+ * @property {import('../managers/PodcastManager')} PodcastManager
  */
 
 /**
@@ -50,7 +56,10 @@ class PluginManager {
       Database,
       SocketAuthority,
       TaskManager,
-      pluginInstance
+      pluginInstance,
+      ShareManager,
+      RssFeedManager,
+      PodcastManager
     }
   }
 

server/managers/PodcastManager.js

@@ -586,4 +586,4 @@ class PodcastManager {
     Logger.info(`[PodcastManager] createPodcastsFromFeedUrls: Finished OPML import. Created ${numPodcastsAdded} podcasts out of ${rssFeedUrls.length} RSS feed URLs`)
   }
 }
-module.exports = PodcastManager
+module.exports = new PodcastManager()

server/routers/ApiRouter.js

@@ -47,8 +47,6 @@ class ApiRouter {
     this.abMergeManager = Server.abMergeManager
     /** @type {import('../managers/BackupManager')} */
     this.backupManager = Server.backupManager
-    /** @type {import('../managers/PodcastManager')} */
-    this.podcastManager = Server.podcastManager
     /** @type {import('../managers/AudioMetadataManager')} */
     this.audioMetadataManager = Server.audioMetadataManager
     /** @type {import('../managers/CronManager')} */