PeerTube/server/tools/peertube-plugins.ts

189 lines
5.4 KiB
TypeScript
Raw Normal View History

2020-01-31 16:56:52 +01:00
// eslint-disable @typescript-eslint/no-unnecessary-type-assertion
import { registerTSPaths } from '../helpers/register-ts-paths'
registerTSPaths()
2021-06-25 17:48:27 +02:00
import { program, Command, OptionValues } from 'commander'
2019-07-12 11:39:58 +02:00
import { installPlugin, listPlugins, uninstallPlugin, updatePlugin } from '../../shared/extra-utils/server/plugins'
2020-01-28 11:07:23 +01:00
import { getAdminTokenOrDie, getServerCredentials } from './cli'
2021-05-11 12:04:47 +02:00
import { PeerTubePlugin, PluginType } from '../../shared/models'
import { isAbsolute } from 'path'
2020-01-28 11:07:23 +01:00
import * as CliTable3 from 'cli-table3'
program
.name('plugins')
.usage('[command] [options]')
program
.command('list')
.description('List installed plugins')
.option('-u, --url <url>', 'Server url')
.option('-U, --username <username>', 'Username')
.option('-p, --password <token>', 'Password')
.option('-t, --only-themes', 'List themes only')
.option('-P, --only-plugins', 'List plugins only')
.action((options, command) => pluginsListCLI(command, options))
program
.command('install')
.description('Install a plugin or a theme')
.option('-u, --url <url>', 'Server url')
.option('-U, --username <username>', 'Username')
.option('-p, --password <token>', 'Password')
.option('-P --path <path>', 'Install from a path')
.option('-n, --npm-name <npmName>', 'Install from npm')
2021-02-03 09:33:05 +01:00
.action((options, command) => installPluginCLI(command, options))
2019-07-12 11:39:58 +02:00
program
.command('update')
.description('Update a plugin or a theme')
.option('-u, --url <url>', 'Server url')
.option('-U, --username <username>', 'Username')
.option('-p, --password <token>', 'Password')
.option('-P --path <path>', 'Update from a path')
.option('-n, --npm-name <npmName>', 'Update from npm')
2021-02-03 09:33:05 +01:00
.action((options, command) => updatePluginCLI(command, options))
2019-07-12 11:39:58 +02:00
program
.command('uninstall')
.description('Uninstall a plugin or a theme')
.option('-u, --url <url>', 'Server url')
.option('-U, --username <username>', 'Username')
.option('-p, --password <token>', 'Password')
.option('-n, --npm-name <npmName>', 'NPM plugin/theme name')
2021-02-03 09:33:05 +01:00
.action((options, command) => uninstallPluginCLI(command, options))
if (!process.argv.slice(2).length) {
program.outputHelp()
}
program.parse(process.argv)
// ----------------------------------------------------------------------------
2021-06-25 17:48:27 +02:00
async function pluginsListCLI (command: Command, options: OptionValues) {
const { url, username, password } = await getServerCredentials(command)
const accessToken = await getAdminTokenOrDie(url, username, password)
2019-07-19 14:36:04 +02:00
let pluginType: PluginType
2021-02-03 09:33:05 +01:00
if (options.onlyThemes) pluginType = PluginType.THEME
if (options.onlyPlugins) pluginType = PluginType.PLUGIN
const res = await listPlugins({
url,
accessToken,
start: 0,
count: 100,
sort: 'name',
2019-07-19 14:36:04 +02:00
pluginType
})
const plugins: PeerTubePlugin[] = res.body.data
2020-01-28 11:07:23 +01:00
const table = new CliTable3({
2020-01-31 16:56:52 +01:00
head: [ 'name', 'version', 'homepage' ],
colWidths: [ 50, 10, 50 ]
2020-01-31 16:56:52 +01:00
}) as any
for (const plugin of plugins) {
const npmName = plugin.type === PluginType.PLUGIN
? 'peertube-plugin-' + plugin.name
: 'peertube-theme-' + plugin.name
table.push([
npmName,
plugin.version,
plugin.homepage
])
}
console.log(table.toString())
process.exit(0)
}
2021-06-25 17:48:27 +02:00
async function installPluginCLI (command: Command, options: OptionValues) {
2021-02-03 09:33:05 +01:00
if (!options.path && !options.npmName) {
console.error('You need to specify the npm name or the path of the plugin you want to install.\n')
program.outputHelp()
process.exit(-1)
}
2021-02-03 09:33:05 +01:00
if (options.path && !isAbsolute(options.path)) {
console.error('Path should be absolute.')
process.exit(-1)
}
2021-02-03 09:33:05 +01:00
const { url, username, password } = await getServerCredentials(command)
const accessToken = await getAdminTokenOrDie(url, username, password)
try {
await installPlugin({
url,
accessToken,
2021-02-03 09:33:05 +01:00
npmName: options.npmName,
path: options.path
})
} catch (err) {
console.error('Cannot install plugin.', err)
process.exit(-1)
}
console.log('Plugin installed.')
process.exit(0)
}
2021-06-25 17:48:27 +02:00
async function updatePluginCLI (command: Command, options: OptionValues) {
2021-02-03 09:33:05 +01:00
if (!options.path && !options.npmName) {
2019-07-12 11:39:58 +02:00
console.error('You need to specify the npm name or the path of the plugin you want to update.\n')
program.outputHelp()
process.exit(-1)
}
2021-02-03 09:33:05 +01:00
if (options.path && !isAbsolute(options.path)) {
2019-07-12 11:39:58 +02:00
console.error('Path should be absolute.')
process.exit(-1)
}
2021-02-03 09:33:05 +01:00
const { url, username, password } = await getServerCredentials(command)
2019-07-12 11:39:58 +02:00
const accessToken = await getAdminTokenOrDie(url, username, password)
try {
await updatePlugin({
url,
accessToken,
2021-02-03 09:33:05 +01:00
npmName: options.npmName,
path: options.path
2019-07-12 11:39:58 +02:00
})
} catch (err) {
console.error('Cannot update plugin.', err)
process.exit(-1)
}
console.log('Plugin updated.')
process.exit(0)
}
2021-06-25 17:48:27 +02:00
async function uninstallPluginCLI (command: Command, options: OptionValues) {
2021-02-03 09:33:05 +01:00
if (!options.npmName) {
console.error('You need to specify the npm name of the plugin/theme you want to uninstall.\n')
program.outputHelp()
process.exit(-1)
}
2021-02-03 09:33:05 +01:00
const { url, username, password } = await getServerCredentials(command)
const accessToken = await getAdminTokenOrDie(url, username, password)
try {
await uninstallPlugin({
url,
accessToken,
2021-02-03 09:33:05 +01:00
npmName: options.npmName
})
} catch (err) {
console.error('Cannot uninstall plugin.', err)
process.exit(-1)
}
console.log('Plugin uninstalled.')
process.exit(0)
}