server/tools/peertube-plugins.ts

   1 // eslint-disable @typescript-eslint/no-unnecessary-type-assertion
   2
   3 import { registerTSPaths } from '../helpers/register-ts-paths'
   4 registerTSPaths()
   5
   6 import * as program from 'commander'
   7 import { PluginType } from '../../shared/models/plugins/plugin.type'
   8 import { installPlugin, listPlugins, uninstallPlugin, updatePlugin } from '../../shared/extra-utils/server/plugins'
   9 import { getAdminTokenOrDie, getServerCredentials } from './cli'
  10 import { PeerTubePlugin } from '../../shared/models/plugins/peertube-plugin.model'
  11 import { isAbsolute } from 'path'
  12 import * as CliTable3 from 'cli-table3'
  13 import commander = require('commander')
  14
  15 program
  16   .name('plugins')
  17   .usage('[command] [options]')
  18
  19 program
  20   .command('list')
  21   .description('List installed plugins')
  22   .option('-u, --url <url>', 'Server url')
  23   .option('-U, --username <username>', 'Username')
  24   .option('-p, --password <token>', 'Password')
  25   .option('-t, --only-themes', 'List themes only')
  26   .option('-P, --only-plugins', 'List plugins only')
  27   .action(() => pluginsListCLI())
  28
  29 program
  30   .command('install')
  31   .description('Install a plugin or a theme')
  32   .option('-u, --url <url>', 'Server url')
  33   .option('-U, --username <username>', 'Username')
  34   .option('-p, --password <token>', 'Password')
  35   .option('-P --path <path>', 'Install from a path')
  36   .option('-n, --npm-name <npmName>', 'Install from npm')
  37   .action((options, command) => installPluginCLI(command, options))
  38
  39 program
  40   .command('update')
  41   .description('Update a plugin or a theme')
  42   .option('-u, --url <url>', 'Server url')
  43   .option('-U, --username <username>', 'Username')
  44   .option('-p, --password <token>', 'Password')
  45   .option('-P --path <path>', 'Update from a path')
  46   .option('-n, --npm-name <npmName>', 'Update from npm')
  47   .action((options, command) => updatePluginCLI(command, options))
  48
  49 program
  50   .command('uninstall')
  51   .description('Uninstall a plugin or a theme')
  52   .option('-u, --url <url>', 'Server url')
  53   .option('-U, --username <username>', 'Username')
  54   .option('-p, --password <token>', 'Password')
  55   .option('-n, --npm-name <npmName>', 'NPM plugin/theme name')
  56   .action((options, command) => uninstallPluginCLI(command, options))
  57
  58 if (!process.argv.slice(2).length) {
  59   program.outputHelp()
  60 }
  61
  62 program.parse(process.argv)
  63
  64 const options = program.opts()
  65
  66 // ----------------------------------------------------------------------------
  67
  68 async function pluginsListCLI () {
  69   const { url, username, password } = await getServerCredentials(program)
  70   const accessToken = await getAdminTokenOrDie(url, username, password)
  71
  72   let pluginType: PluginType
  73   if (options.onlyThemes) pluginType = PluginType.THEME
  74   if (options.onlyPlugins) pluginType = PluginType.PLUGIN
  75
  76   const res = await listPlugins({
  77     url,
  78     accessToken,
  79     start: 0,
  80     count: 100,
  81     sort: 'name',
  82     pluginType
  83   })
  84   const plugins: PeerTubePlugin[] = res.body.data
  85
  86   const table = new CliTable3({
  87     head: [ 'name', 'version', 'homepage' ],
  88     colWidths: [ 50, 10, 50 ]
  89   }) as any
  90
  91   for (const plugin of plugins) {
  92     const npmName = plugin.type === PluginType.PLUGIN
  93       ? 'peertube-plugin-' + plugin.name
  94       : 'peertube-theme-' + plugin.name
  95
  96     table.push([
  97       npmName,
  98       plugin.version,
  99       plugin.homepage
 100     ])
 101   }
 102
 103   console.log(table.toString())
 104   process.exit(0)
 105 }
 106
 107 async function installPluginCLI (command: commander.CommanderStatic, options: commander.OptionValues) {
 108   if (!options.path && !options.npmName) {
 109     console.error('You need to specify the npm name or the path of the plugin you want to install.\n')
 110     program.outputHelp()
 111     process.exit(-1)
 112   }
 113
 114   if (options.path && !isAbsolute(options.path)) {
 115     console.error('Path should be absolute.')
 116     process.exit(-1)
 117   }
 118
 119   const { url, username, password } = await getServerCredentials(command)
 120   const accessToken = await getAdminTokenOrDie(url, username, password)
 121
 122   try {
 123     await installPlugin({
 124       url,
 125       accessToken,
 126       npmName: options.npmName,
 127       path: options.path
 128     })
 129   } catch (err) {
 130     console.error('Cannot install plugin.', err)
 131     process.exit(-1)
 132   }
 133
 134   console.log('Plugin installed.')
 135   process.exit(0)
 136 }
 137
 138 async function updatePluginCLI (command: commander.CommanderStatic, options: commander.OptionValues) {
 139   if (!options.path && !options.npmName) {
 140     console.error('You need to specify the npm name or the path of the plugin you want to update.\n')
 141     program.outputHelp()
 142     process.exit(-1)
 143   }
 144
 145   if (options.path && !isAbsolute(options.path)) {
 146     console.error('Path should be absolute.')
 147     process.exit(-1)
 148   }
 149
 150   const { url, username, password } = await getServerCredentials(command)
 151   const accessToken = await getAdminTokenOrDie(url, username, password)
 152
 153   try {
 154     await updatePlugin({
 155       url,
 156       accessToken,
 157       npmName: options.npmName,
 158       path: options.path
 159     })
 160   } catch (err) {
 161     console.error('Cannot update plugin.', err)
 162     process.exit(-1)
 163   }
 164
 165   console.log('Plugin updated.')
 166   process.exit(0)
 167 }
 168
 169 async function uninstallPluginCLI (command: commander.CommanderStatic, options: commander.OptionValues) {
 170   if (!options.npmName) {
 171     console.error('You need to specify the npm name of the plugin/theme you want to uninstall.\n')
 172     program.outputHelp()
 173     process.exit(-1)
 174   }
 175
 176   const { url, username, password } = await getServerCredentials(command)
 177   const accessToken = await getAdminTokenOrDie(url, username, password)
 178
 179   try {
 180     await uninstallPlugin({
 181       url,
 182       accessToken,
 183       npmName: options.npmName
 184     })
 185   } catch (err) {
 186     console.error('Cannot uninstall plugin.', err)
 187     process.exit(-1)
 188   }
 189
 190   console.log('Plugin uninstalled.')
 191   process.exit(0)
 192 }