WIP plugins: add plugin settings/uninstall in client

5 files changed, 68 insertions, 31 deletions

diff --git a/server/controllers/api/plugins.ts b/server/controllers/api/plugins.ts
index 89cc67f54..f17e8cab9 100644
--- a/server/controllers/api/plugins.ts
+++ b/server/controllers/api/plugins.ts
@@ -12,7 +12,7 @@ import { pluginsSortValidator } from '../../middlewares/validators'
 import { PluginModel } from '../../models/server/plugin'
 import { UserRight } from '../../../shared/models/users'
 import {
-  enabledPluginValidator,
+  existingPluginValidator,
   installPluginValidator,
   listPluginsValidator,
   uninstallPluginValidator,
@@ -35,18 +35,25 @@ pluginRouter.get('/',
   asyncMiddleware(listPlugins)
 )
 
-pluginRouter.get('/:pluginName/settings',
+pluginRouter.get('/:npmName',
   authenticate,
   ensureUserHasRight(UserRight.MANAGE_PLUGINS),
-  asyncMiddleware(enabledPluginValidator),
-  asyncMiddleware(listPluginSettings)
+  asyncMiddleware(existingPluginValidator),
+  getPlugin
 )
 
-pluginRouter.put('/:pluginName/settings',
+pluginRouter.get('/:npmName/registered-settings',
+  authenticate,
+  ensureUserHasRight(UserRight.MANAGE_PLUGINS),
+  asyncMiddleware(existingPluginValidator),
+  asyncMiddleware(getPluginRegisteredSettings)
+)
+
+pluginRouter.put('/:npmName/settings',
   authenticate,
   ensureUserHasRight(UserRight.MANAGE_PLUGINS),
   updatePluginSettingsValidator,
-  asyncMiddleware(enabledPluginValidator),
+  asyncMiddleware(existingPluginValidator),
   asyncMiddleware(updatePluginSettings)
 )
 
@@ -85,6 +92,12 @@ async function listPlugins (req: express.Request, res: express.Response) {
   return res.json(getFormattedObjects(resultList.data, resultList.total))
 }
 
+function getPlugin (req: express.Request, res: express.Response) {
+  const plugin = res.locals.plugin
+
+  return res.json(plugin.toFormattedJSON())
+}
+
 async function installPlugin (req: express.Request, res: express.Response) {
   const body: InstallPlugin = req.body
 
@@ -101,7 +114,7 @@ async function uninstallPlugin (req: express.Request, res: express.Response) {
   return res.sendStatus(204)
 }
 
-async function listPluginSettings (req: express.Request, res: express.Response) {
+async function getPluginRegisteredSettings (req: express.Request, res: express.Response) {
   const plugin = res.locals.plugin
 
   const settings = await PluginManager.Instance.getSettings(plugin.name)
diff --git a/server/helpers/custom-validators/plugins.ts b/server/helpers/custom-validators/plugins.ts
index 4ab5f9ce8..064af9ead 100644
--- a/server/helpers/custom-validators/plugins.ts
+++ b/server/helpers/custom-validators/plugins.ts
@@ -41,6 +41,10 @@ function isPluginEngineValid (engine: any) {
   return exists(engine) && exists(engine.peertube)
 }
 
+function isPluginHomepage (value: string) {
+  return isUrlValid(value)
+}
+
 function isStaticDirectoriesValid (staticDirs: any) {
   if (!exists(staticDirs) || typeof staticDirs !== 'object') return false
 
@@ -70,7 +74,7 @@ function isPackageJSONValid (packageJSON: PluginPackageJson, pluginType: PluginT
   return isNpmPluginNameValid(packageJSON.name) &&
     isPluginDescriptionValid(packageJSON.description) &&
     isPluginEngineValid(packageJSON.engine) &&
-    isUrlValid(packageJSON.homepage) &&
+    isPluginHomepage(packageJSON.homepage) &&
     exists(packageJSON.author) &&
     isUrlValid(packageJSON.bugs) &&
     (pluginType === PluginType.THEME || isSafePath(packageJSON.library)) &&
@@ -88,6 +92,7 @@ export {
   isPluginTypeValid,
   isPackageJSONValid,
   isThemeValid,
+  isPluginHomepage,
   isPluginVersionValid,
   isPluginNameValid,
   isPluginDescriptionValid,
diff --git a/server/lib/plugins/plugin-manager.ts b/server/lib/plugins/plugin-manager.ts
index 3d8375acd..8cdeff446 100644
--- a/server/lib/plugins/plugin-manager.ts
+++ b/server/lib/plugins/plugin-manager.ts
@@ -89,6 +89,8 @@ export class PluginManager {
   async runHook (hookName: string, param?: any) {
     let result = param
 
+    if (!this.hooks[hookName]) return result
+
     const wait = hookName.startsWith('static:')
 
     for (const hook of this.hooks[hookName]) {
@@ -162,8 +164,8 @@ export class PluginManager {
         : await installNpmPlugin(toInstall, version)
 
       name = fromDisk ? basename(toInstall) : toInstall
-      const pluginType = name.startsWith('peertube-theme-') ? PluginType.THEME : PluginType.PLUGIN
-      const pluginName = this.normalizePluginName(name)
+      const pluginType = PluginModel.getTypeFromNpmName(name)
+      const pluginName = PluginModel.normalizePluginName(name)
 
       const packageJSON = this.getPackageJSON(pluginName, pluginType)
       if (!isPackageJSONValid(packageJSON, pluginType)) {
@@ -173,6 +175,7 @@ export class PluginManager {
       [ plugin ] = await PluginModel.upsert({
         name: pluginName,
         description: packageJSON.description,
+        homepage: packageJSON.homepage,
         type: pluginType,
         version: packageJSON.version,
         enabled: true,
@@ -196,10 +199,10 @@ export class PluginManager {
     await this.registerPluginOrTheme(plugin)
   }
 
-  async uninstall (packageName: string) {
-    logger.info('Uninstalling plugin %s.', packageName)
+  async uninstall (npmName: string) {
+    logger.info('Uninstalling plugin %s.', npmName)
 
-    const pluginName = this.normalizePluginName(packageName)
+    const pluginName = PluginModel.normalizePluginName(npmName)
 
     try {
       await this.unregister(pluginName)
@@ -207,9 +210,9 @@ export class PluginManager {
       logger.warn('Cannot unregister plugin %s.', pluginName, { err })
     }
 
-    const plugin = await PluginModel.load(pluginName)
+    const plugin = await PluginModel.loadByNpmName(npmName)
     if (!plugin || plugin.uninstalled === true) {
-      logger.error('Cannot uninstall plugin %s: it does not exist or is already uninstalled.', packageName)
+      logger.error('Cannot uninstall plugin %s: it does not exist or is already uninstalled.', npmName)
       return
     }
 
@@ -218,9 +221,9 @@ export class PluginManager {
 
     await plugin.save()
 
-    await removeNpmPlugin(packageName)
+    await removeNpmPlugin(npmName)
 
-    logger.info('Plugin %s uninstalled.', packageName)
+    logger.info('Plugin %s uninstalled.', npmName)
   }
 
   // ###################### Private register ######################
@@ -353,10 +356,6 @@ export class PluginManager {
     return join(CONFIG.STORAGE.PLUGINS_DIR, 'node_modules', prefix + pluginName)
   }
 
-  private normalizePluginName (name: string) {
-    return name.replace(/^peertube-((theme)|(plugin))-/, '')
-  }
-
   // ###################### Private getters ######################
 
   private getRegisteredPluginsOrThemes (type: PluginType) {
diff --git a/server/middlewares/validators/plugins.ts b/server/middlewares/validators/plugins.ts
index 265ac7c17..a06add6b8 100644
--- a/server/middlewares/validators/plugins.ts
+++ b/server/middlewares/validators/plugins.ts
@@ -63,7 +63,7 @@ const uninstallPluginValidator = [
   body('npmName').custom(isNpmPluginNameValid).withMessage('Should have a valid npm name'),
 
   (req: express.Request, res: express.Response, next: express.NextFunction) => {
-    logger.debug('Checking managePluginValidator parameters', { parameters: req.body })
+    logger.debug('Checking uninstallPluginValidator parameters', { parameters: req.body })
 
     if (areValidationErrors(req, res)) return
 
@@ -71,15 +71,15 @@ const uninstallPluginValidator = [
   }
 ]
 
-const enabledPluginValidator = [
-  body('name').custom(isPluginNameValid).withMessage('Should have a valid plugin name'),
+const existingPluginValidator = [
+  param('npmName').custom(isPluginNameValid).withMessage('Should have a valid plugin name'),
 
   async (req: express.Request, res: express.Response, next: express.NextFunction) => {
-    logger.debug('Checking enabledPluginValidator parameters', { parameters: req.body })
+    logger.debug('Checking enabledPluginValidator parameters', { parameters: req.params })
 
     if (areValidationErrors(req, res)) return
 
-    const plugin = await PluginModel.load(req.body.name)
+    const plugin = await PluginModel.loadByNpmName(req.params.npmName)
     if (!plugin) {
       return res.status(404)
          .json({ error: 'Plugin not found' })
@@ -110,7 +110,7 @@ export {
   servePluginStaticDirectoryValidator,
   updatePluginSettingsValidator,
   uninstallPluginValidator,
-  enabledPluginValidator,
+  existingPluginValidator,
   installPluginValidator,
   listPluginsValidator
 }
diff --git a/server/models/server/plugin.ts b/server/models/server/plugin.ts
index 059a442de..60abaec65 100644
--- a/server/models/server/plugin.ts
+++ b/server/models/server/plugin.ts
@@ -1,7 +1,7 @@
 import { AllowNull, Column, CreatedAt, DataType, DefaultScope, Is, Model, Table, UpdatedAt } from 'sequelize-typescript'
 import { getSort, throwIfNotValid } from '../utils'
 import {
-  isPluginDescriptionValid,
+  isPluginDescriptionValid, isPluginHomepage,
   isPluginNameValid,
   isPluginTypeValid,
   isPluginVersionValid
@@ -20,7 +20,7 @@ import { FindAndCountOptions } from 'sequelize'
   tableName: 'plugin',
   indexes: [
     {
-      fields: [ 'name' ],
+      fields: [ 'name', 'type' ],
       unique: true
     }
   ]
@@ -59,6 +59,11 @@ export class PluginModel extends Model<PluginModel> {
   @Column
   description: string
 
+  @AllowNull(false)
+  @Is('PluginHomepage', value => throwIfNotValid(value, isPluginHomepage, 'homepage'))
+  @Column
+  homepage: string
+
   @AllowNull(true)
   @Column(DataType.JSONB)
   settings: any
@@ -84,10 +89,14 @@ export class PluginModel extends Model<PluginModel> {
     return PluginModel.findAll(query)
   }
 
-  static load (pluginName: string) {
+  static loadByNpmName (npmName: string) {
+    const name = this.normalizePluginName(npmName)
+    const type = this.getTypeFromNpmName(npmName)
+
     const query = {
       where: {
-        name: pluginName
+        name,
+        type
       }
     }
 
@@ -150,6 +159,16 @@ export class PluginModel extends Model<PluginModel> {
       })
   }
 
+  static normalizePluginName (name: string) {
+    return name.replace(/^peertube-((theme)|(plugin))-/, '')
+  }
+
+  static getTypeFromNpmName (npmName: string) {
+    return npmName.startsWith('peertube-plugin-')
+      ? PluginType.PLUGIN
+      : PluginType.THEME
+  }
+
   toFormattedJSON (): PeerTubePlugin {
     return {
       name: this.name,
@@ -159,6 +178,7 @@ export class PluginModel extends Model<PluginModel> {
       uninstalled: this.uninstalled,
       peertubeEngine: this.peertubeEngine,
       description: this.description,
+      homepage: this.homepage,
       settings: this.settings,
       createdAt: this.createdAt,
       updatedAt: this.updatedAt