aboutsummaryrefslogtreecommitdiffhomepage
path: root/server/tools/peertube-plugins.ts
blob: e40606107249e5b7ab8ea81be2dd14c5b9cfbd4e (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
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
import { registerTSPaths } from '../helpers/register-ts-paths'
registerTSPaths()

import * as program from 'commander'
import { PluginType } from '../../shared/models/plugins/plugin.type'
import { getAccessToken } from '../../shared/extra-utils/users/login'
import { getMyUserInformation } from '../../shared/extra-utils/users/users'
import { installPlugin, listPlugins, uninstallPlugin, updatePlugin } from '../../shared/extra-utils/server/plugins'
import { getServerCredentials } from './cli'
import { User, UserRole } from '../../shared/models/users'
import { PeerTubePlugin } from '../../shared/models/plugins/peertube-plugin.model'
import { isAbsolute } from 'path'

const Table = require('cli-table')

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(() => pluginsListCLI())

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')
  .action((options) => installPluginCLI(options))

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((options) => updatePluginCLI(options))

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(options => uninstallPluginCLI(options))

if (!process.argv.slice(2).length) {
  program.outputHelp()
}

program.parse(process.argv)

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

async function pluginsListCLI () {
  const { url, username, password } = await getServerCredentials(program)
  const accessToken = await getAdminTokenOrDie(url, username, password)

  let pluginType: PluginType
  if (program['onlyThemes']) pluginType = PluginType.THEME
  if (program['onlyPlugins']) pluginType = PluginType.PLUGIN

  const res = await listPlugins({
    url,
    accessToken,
    start: 0,
    count: 100,
    sort: 'name',
    pluginType
  })
  const plugins: PeerTubePlugin[] = res.body.data

  const table = new Table({
    head: ['name', 'version', 'homepage'],
    colWidths: [ 50, 10, 50 ]
  })

  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)
}

async function installPluginCLI (options: any) {
  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)
  }

  if (options['path'] && !isAbsolute(options['path'])) {
    console.error('Path should be absolute.')
    process.exit(-1)
  }

  const { url, username, password } = await getServerCredentials(options)
  const accessToken = await getAdminTokenOrDie(url, username, password)

  try {
    await installPlugin({
      url,
      accessToken,
      npmName: options['npmName'],
      path: options['path']
    })
  } catch (err) {
    console.error('Cannot install plugin.', err)
    process.exit(-1)
    return
  }

  console.log('Plugin installed.')
  process.exit(0)
}

async function updatePluginCLI (options: any) {
  if (!options['path'] && !options['npmName']) {
    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)
  }

  if (options['path'] && !isAbsolute(options['path'])) {
    console.error('Path should be absolute.')
    process.exit(-1)
  }

  const { url, username, password } = await getServerCredentials(options)
  const accessToken = await getAdminTokenOrDie(url, username, password)

  try {
    await updatePlugin({
      url,
      accessToken,
      npmName: options['npmName'],
      path: options['path']
    })
  } catch (err) {
    console.error('Cannot update plugin.', err)
    process.exit(-1)
    return
  }

  console.log('Plugin updated.')
  process.exit(0)
}

async function uninstallPluginCLI (options: any) {
  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)
  }

  const { url, username, password } = await getServerCredentials(options)
  const accessToken = await getAdminTokenOrDie(url, username, password)

  try {
    await uninstallPlugin({
      url,
      accessToken,
      npmName: options[ 'npmName' ]
    })
  } catch (err) {
    console.error('Cannot uninstall plugin.', err)
    process.exit(-1)
    return
  }

  console.log('Plugin uninstalled.')
  process.exit(0)
}

async function getAdminTokenOrDie (url: string, username: string, password: string) {
  const accessToken = await getAccessToken(url, username, password)
  const resMe = await getMyUserInformation(url, accessToken)
  const me: User = resMe.body

  if (me.role !== UserRole.ADMINISTRATOR) {
    console.error('Cannot list plugins if you are not administrator.')
    process.exit(-1)
  }

  return accessToken
}