aboutsummaryrefslogtreecommitdiffhomepage
path: root/apps/peertube-cli/src/peertube-plugins.ts
blob: c9da5626637ea25259f373c6b57027a53c8c7e0f (plain) (blame)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
import CliTable3 from 'cli-table3'
import { isAbsolute } from 'path'
import { Command } from '@commander-js/extra-typings'
import { PluginType, PluginType_Type } from '@peertube/peertube-models'
import { assignToken, buildServer, CommonProgramOptions, getServerCredentials } from './shared/index.js'

export function definePluginsProgram () {
  const program = new Command()

  program
    .name('plugins')
    .description('Manage instance plugins/themes')
    .alias('p')

  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(async options => {
      try {
        await pluginsListCLI(options)
      } catch (err) {
        console.error('Cannot list plugins: ' + err.message)
        process.exit(-1)
      }
    })

  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')
    .option('--plugin-version <pluginVersion>', 'Specify the plugin version to install (only available when installing from npm)')
    .action(async options => {
      try {
        await installPluginCLI(options)
      } catch (err) {
        console.error('Cannot install plugin: ' + err.message)
        process.exit(-1)
      }
    })

  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')
    .action(async options => {
      try {
        await updatePluginCLI(options)
      } catch (err) {
        console.error('Cannot update plugin: ' + err.message)
        process.exit(-1)
      }
    })

  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')
    .action(async options => {
      try {
        await uninstallPluginCLI(options)
      } catch (err) {
        console.error('Cannot uninstall plugin: ' + err.message)
        process.exit(-1)
      }
    })

  return program
}

// ----------------------------------------------------------------------------

async function pluginsListCLI (options: CommonProgramOptions & { onlyThemes?: true, onlyPlugins?: true }) {
  const { url, username, password } = await getServerCredentials(options)
  const server = buildServer(url)
  await assignToken(server, username, password)

  let pluginType: PluginType_Type
  if (options.onlyThemes) pluginType = PluginType.THEME
  if (options.onlyPlugins) pluginType = PluginType.PLUGIN

  const { data } = await server.plugins.list({ start: 0, count: 100, sort: 'name', pluginType })

  const table = new CliTable3({
    head: [ 'name', 'version', 'homepage' ],
    colWidths: [ 50, 20, 50 ]
  }) as any

  for (const plugin of data) {
    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())
}

async function installPluginCLI (options: CommonProgramOptions & { path?: string, npmName?: string, pluginVersion?: string }) {
  if (!options.path && !options.npmName) {
    throw new Error('You need to specify the npm name or the path of the plugin you want to install.')
  }

  if (options.path && !isAbsolute(options.path)) {
    throw new Error('Path should be absolute.')
  }

  const { url, username, password } = await getServerCredentials(options)
  const server = buildServer(url)
  await assignToken(server, username, password)

  await server.plugins.install({ npmName: options.npmName, path: options.path, pluginVersion: options.pluginVersion })

  console.log('Plugin installed.')
}

async function updatePluginCLI (options: CommonProgramOptions & { path?: string, npmName?: string }) {
  if (!options.path && !options.npmName) {
    throw new Error('You need to specify the npm name or the path of the plugin you want to update.')
  }

  if (options.path && !isAbsolute(options.path)) {
    throw new Error('Path should be absolute.')
  }

  const { url, username, password } = await getServerCredentials(options)
  const server = buildServer(url)
  await assignToken(server, username, password)

  await server.plugins.update({ npmName: options.npmName, path: options.path })

  console.log('Plugin updated.')
}

async function uninstallPluginCLI (options: CommonProgramOptions & { npmName?: string }) {
  if (!options.npmName) {
    throw new Error('You need to specify the npm name of the plugin/theme you want to uninstall.')
  }

  const { url, username, password } = await getServerCredentials(options)
  const server = buildServer(url)
  await assignToken(server, username, password)

  await server.plugins.uninstall({ npmName: options.npmName })

  console.log('Plugin uninstalled.')
}