Merge branch 'release/3.1.0' into develop

[github/Chocobozzz/PeerTube.git] / server / controllers / api / plugins.ts

diff --git a/server/controllers/api/plugins.ts b/server/controllers/api/plugins.ts
index bb410e8917672586ebaf019d314e67ecee317ae5..bb69f25a1eafbdae809a46f618eb05b0105a88be 100644 (file)
--- a/server/controllers/api/plugins.ts
+++ b/server/controllers/api/plugins.ts
@@ -25,6 +25,9 @@ import { ManagePlugin } from '../../../shared/models/plugins/manage-plugin.model
 import { logger } from '../../helpers/logger'
 import { listAvailablePluginsFromIndex } from '../../lib/plugins/plugin-index'
 import { PeertubePluginIndexList } from '../../../shared/models/plugins/peertube-plugin-index-list.model'
+import { RegisteredServerSettings } from '../../../shared/models/plugins/register-server-setting.model'
+import { PublicServerSetting } from '../../../shared/models/plugins/public-server.setting'
+import { HttpStatusCode } from '../../../shared/core-utils/miscs/http-error-codes'
 
 const pluginRouter = express.Router()
 
@@ -50,18 +53,16 @@ pluginRouter.get('/',
   asyncMiddleware(listPlugins)
 )
 
-pluginRouter.get('/:npmName',
+pluginRouter.get('/:npmName/registered-settings',
   authenticate,
   ensureUserHasRight(UserRight.MANAGE_PLUGINS),
   asyncMiddleware(existingPluginValidator),
-  getPlugin
+  getPluginRegisteredSettings
 )
 
-pluginRouter.get('/:npmName/registered-settings',
-  authenticate,
-  ensureUserHasRight(UserRight.MANAGE_PLUGINS),
+pluginRouter.get('/:npmName/public-settings',
   asyncMiddleware(existingPluginValidator),
-  getPluginRegisteredSettings
+  getPublicPluginSettings
 )
 
 pluginRouter.put('/:npmName/settings',
@@ -72,6 +73,13 @@ pluginRouter.put('/:npmName/settings',
   asyncMiddleware(updatePluginSettings)
 )
 
+pluginRouter.get('/:npmName',
+  authenticate,
+  ensureUserHasRight(UserRight.MANAGE_PLUGINS),
+  asyncMiddleware(existingPluginValidator),
+  getPlugin
+)
+
 pluginRouter.post('/install',
   authenticate,
   ensureUserHasRight(UserRight.MANAGE_PLUGINS),
@@ -103,9 +111,11 @@ export {
 
 async function listPlugins (req: express.Request, res: express.Response) {
   const pluginType = req.query.pluginType
+  const uninstalled = req.query.uninstalled
 
   const resultList = await PluginModel.listForApi({
     pluginType,
+    uninstalled,
     start: req.query.start,
     count: req.query.count,
     sort: req.query.sort
@@ -131,7 +141,7 @@ async function installPlugin (req: express.Request, res: express.Response) {
     return res.json(plugin.toFormattedJSON())
   } catch (err) {
     logger.warn('Cannot install plugin %s.', toInstall, { err })
-    return res.sendStatus(400)
+    return res.sendStatus(HttpStatusCode.BAD_REQUEST_400)
   }
 }
 
@@ -146,7 +156,7 @@ async function updatePlugin (req: express.Request, res: express.Response) {
     return res.json(plugin.toFormattedJSON())
   } catch (err) {
     logger.warn('Cannot update plugin %s.', toUpdate, { err })
-    return res.sendStatus(400)
+    return res.sendStatus(HttpStatusCode.BAD_REQUEST_400)
   }
 }
 
@@ -155,15 +165,25 @@ async function uninstallPlugin (req: express.Request, res: express.Response) {
 
   await PluginManager.Instance.uninstall(body.npmName)
 
-  return res.sendStatus(204)
+  return res.sendStatus(HttpStatusCode.NO_CONTENT_204)
+}
+
+function getPublicPluginSettings (req: express.Request, res: express.Response) {
+  const plugin = res.locals.plugin
+  const registeredSettings = PluginManager.Instance.getRegisteredSettings(req.params.npmName)
+  const publicSettings = plugin.getPublicSettings(registeredSettings)
+
+  const json: PublicServerSetting = { publicSettings }
+
+  return res.json(json)
 }
 
 function getPluginRegisteredSettings (req: express.Request, res: express.Response) {
-  const settings = PluginManager.Instance.getRegisteredSettings(req.params.npmName)
+  const registeredSettings = PluginManager.Instance.getRegisteredSettings(req.params.npmName)
 
-  return res.json({
-    settings
-  })
+  const json: RegisteredServerSettings = { registeredSettings }
+
+  return res.json(json)
 }
 
 async function updatePluginSettings (req: express.Request, res: express.Response) {
@@ -172,7 +192,9 @@ async function updatePluginSettings (req: express.Request, res: express.Response
   plugin.settings = req.body.settings
   await plugin.save()
 
-  return res.sendStatus(204)
+  await PluginManager.Instance.onSettingsChanged(plugin.name, plugin.settings)
+
+  return res.sendStatus(HttpStatusCode.NO_CONTENT_204)
 }
 
 async function listAvailablePlugins (req: express.Request, res: express.Response) {
@@ -181,9 +203,8 @@ async function listAvailablePlugins (req: express.Request, res: express.Response
   const resultList = await listAvailablePluginsFromIndex(query)
 
   if (!resultList) {
-    return res.status(503)
+    return res.status(HttpStatusCode.SERVICE_UNAVAILABLE_503)
       .json({ error: 'Plugin index unavailable. Please retry later' })
-      .end()
   }
 
   return res.json(resultList)