WIP plugins: move plugin CLI in peertube script

Install/uninstall/list plugins remotely

6 files changed, 224 insertions, 62 deletions

diff --git a/server/tools/cli.ts b/server/tools/cli.ts
index 2eec51aa4..67755022c 100644
--- a/server/tools/cli.ts
+++ b/server/tools/cli.ts
@@ -1,7 +1,8 @@
 import { Netrc } from 'netrc-parser'
 import { getAppNumber, isTestInstance } from '../helpers/core-utils'
 import { join } from 'path'
-import { getVideoChannel, root } from '../../shared/extra-utils'
+import { root } from '../../shared/extra-utils/miscs/miscs'
+import { getVideoChannel } from '../../shared/extra-utils/videos/video-channels'
 import { Command } from 'commander'
 import { VideoChannel, VideoPrivacy } from '../../shared/models/videos'
 
@@ -64,7 +65,11 @@ function deleteSettings () {
   })
 }
 
-function getRemoteObjectOrDie (program: any, settings: Settings, netrc: Netrc) {
+function getRemoteObjectOrDie (
+  program: any,
+  settings: Settings,
+  netrc: Netrc
+): { url: string, username: string, password: string } {
   if (!program['url'] || !program['username'] || !program['password']) {
     // No remote and we don't have program parameters: quit
     if (settings.remotes.length === 0 || Object.keys(netrc.machines).length === 0) {
@@ -161,6 +166,13 @@ async function buildVideoAttributesFromCommander (url: string, command: Command,
   return videoAttributes
 }
 
+function getServerCredentials (program: any) {
+  return Promise.all([ getSettings(), getNetrc() ])
+         .then(([ settings, netrc ]) => {
+           return getRemoteObjectOrDie(program, settings, netrc)
+         })
+}
+
 // ---------------------------------------------------------------------------
 
 export {
@@ -172,6 +184,8 @@ export {
   writeSettings,
   deleteSettings,
 
+  getServerCredentials,
+
   buildCommonVideoOptions,
   buildVideoAttributesFromCommander
 }
diff --git a/server/tools/peertube-auth.ts b/server/tools/peertube-auth.ts
index 1035d664a..d4ad56e47 100644
--- a/server/tools/peertube-auth.ts
+++ b/server/tools/peertube-auth.ts
@@ -1,8 +1,8 @@
 import * as program from 'commander'
 import * as prompt from 'prompt'
-import { getSettings, writeSettings, getNetrc } from './cli'
-import { isHostValid } from '../helpers/custom-validators/servers'
+import { getNetrc, getSettings, writeSettings } from './cli'
 import { isUserUsernameValid } from '../helpers/custom-validators/users'
+import { getAccessToken, login } from '../../shared/extra-utils'
 
 const Table = require('cli-table')
 
@@ -76,6 +76,14 @@ program
         }
       }
     }, async (_, result) => {
+      // Check credentials
+      try {
+        await getAccessToken(result.url, result.username, result.password)
+      } catch (err) {
+        console.error(err.message)
+        process.exit(-1)
+      }
+
       await setInstance(result.url, result.username, result.password, program['default'])
 
       process.exit(0)
diff --git a/server/tools/peertube-import-videos.ts b/server/tools/peertube-import-videos.ts
index d7bb00e02..1f0350442 100644
--- a/server/tools/peertube-import-videos.ts
+++ b/server/tools/peertube-import-videos.ts
@@ -11,7 +11,7 @@ import * as prompt from 'prompt'
 import { remove } from 'fs-extra'
 import { sha256 } from '../helpers/core-utils'
 import { buildOriginallyPublishedAt, safeGetYoutubeDL } from '../helpers/youtube-dl'
-import { buildCommonVideoOptions, buildVideoAttributesFromCommander, getNetrc, getRemoteObjectOrDie, getSettings } from './cli'
+import { buildCommonVideoOptions, buildVideoAttributesFromCommander, getServerCredentials } from './cli'
 
 type UserInfo = {
   username: string
@@ -36,27 +36,25 @@ command
   .option('-v, --verbose', 'Verbose mode')
   .parse(process.argv)
 
-Promise.all([ getSettings(), getNetrc() ])
-       .then(([ settings, netrc ]) => {
-         const { url, username, password } = getRemoteObjectOrDie(program, settings, netrc)
+getServerCredentials(command)
+  .then(({ url, username, password }) => {
+    if (!program[ 'targetUrl' ]) {
+      console.error('--targetUrl field is required.')
 
-         if (!program[ 'targetUrl' ]) {
-           console.error('--targetUrl field is required.')
-
-           process.exit(-1)
-         }
+      process.exit(-1)
+    }
 
-         removeEndSlashes(url)
-         removeEndSlashes(program[ 'targetUrl' ])
+    removeEndSlashes(url)
+    removeEndSlashes(program[ 'targetUrl' ])
 
-         const user = { username, password }
+    const user = { username, password }
 
-         run(url, user)
-           .catch(err => {
-             console.error(err)
-             process.exit(-1)
-           })
-       })
+    run(url, user)
+      .catch(err => {
+        console.error(err)
+        process.exit(-1)
+      })
+  })
 
 async function run (url: string, user: UserInfo) {
   if (!user.password) {
diff --git a/server/tools/peertube-plugins.ts b/server/tools/peertube-plugins.ts
new file mode 100644
index 000000000..d5e024383
--- /dev/null
+++ b/server/tools/peertube-plugins.ts
@@ -0,0 +1,162 @@
+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 } 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('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 type: PluginType
+  if (program['onlyThemes']) type = PluginType.THEME
+  if (program['onlyPlugins']) type = PluginType.PLUGIN
+
+  const res = await listPlugins({
+    url,
+    accessToken,
+    start: 0,
+    count: 100,
+    sort: 'name',
+    type
+  })
+  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 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
+}
diff --git a/server/tools/peertube-upload.ts b/server/tools/peertube-upload.ts
index c00205e8f..d9f9a8ead 100644
--- a/server/tools/peertube-upload.ts
+++ b/server/tools/peertube-upload.ts
@@ -1,9 +1,9 @@
 import * as program from 'commander'
 import { access, constants } from 'fs-extra'
 import { isAbsolute } from 'path'
-import { getClient, login } from '../../shared/extra-utils'
+import { getAccessToken } from '../../shared/extra-utils'
 import { uploadVideo } from '../../shared/extra-utils/'
-import { buildCommonVideoOptions, buildVideoAttributesFromCommander, getNetrc, getRemoteObjectOrDie, getSettings } from './cli'
+import { buildCommonVideoOptions, buildVideoAttributesFromCommander, getServerCredentials } from './cli'
 
 let command = program
   .name('upload')
@@ -11,7 +11,6 @@ let command = program
 command = buildCommonVideoOptions(command)
 
 command
-
   .option('-u, --url <url>', 'Server url')
   .option('-U, --username <username>', 'Username')
   .option('-p, --password <token>', 'Password')
@@ -20,44 +19,28 @@ command
   .option('-f, --file <file>', 'Video absolute file path')
   .parse(process.argv)
 
-Promise.all([ getSettings(), getNetrc() ])
-       .then(([ settings, netrc ]) => {
-         const { url, username, password } = getRemoteObjectOrDie(program, settings, netrc)
-
-         if (!program[ 'videoName' ] || !program[ 'file' ]) {
-           if (!program[ 'videoName' ]) console.error('--video-name is required.')
-           if (!program[ 'file' ]) console.error('--file is required.')
+getServerCredentials(command)
+  .then(({ url, username, password }) => {
+    if (!program[ 'videoName' ] || !program[ 'file' ]) {
+      if (!program[ 'videoName' ]) console.error('--video-name is required.')
+      if (!program[ 'file' ]) console.error('--file is required.')
 
-           process.exit(-1)
-         }
+      process.exit(-1)
+    }
 
-         if (isAbsolute(program[ 'file' ]) === false) {
-           console.error('File path should be absolute.')
-           process.exit(-1)
-         }
+    if (isAbsolute(program[ 'file' ]) === false) {
+      console.error('File path should be absolute.')
+      process.exit(-1)
+    }
 
-         run(url, username, password).catch(err => {
-           console.error(err)
-           process.exit(-1)
-         })
-       })
+    run(url, username, password).catch(err => {
+      console.error(err)
+      process.exit(-1)
+    })
+  })
 
 async function run (url: string, username: string, password: string) {
-  const resClient = await getClient(url)
-  const client = {
-    id: resClient.body.client_id,
-    secret: resClient.body.client_secret
-  }
-
-  const user = { username, password }
-
-  let accessToken: string
-  try {
-    const res = await login(url, client, user)
-    accessToken = res.body.access_token
-  } catch (err) {
-    throw new Error('Cannot authenticate. Please check your username/password.')
-  }
+  const accessToken = await getAccessToken(url, username, password)
 
   await access(program[ 'file' ], constants.F_OK)
 
diff --git a/server/tools/peertube.ts b/server/tools/peertube.ts
index daa5586c3..e79a7e041 100644
--- a/server/tools/peertube.ts
+++ b/server/tools/peertube.ts
@@ -18,13 +18,10 @@ program
   .command('get-access-token', 'get a peertube access token', { noHelp: true }).alias('token')
   .command('watch', 'watch a video in the terminal ✩°｡⋆').alias('w')
   .command('repl', 'initiate a REPL to access internals')
+  .command('plugins [action]', 'manage plugins on a local instance').alias('p')
 
 /* Not Yet Implemented */
 program
-  .command('plugins [action]',
-           'manage plugins on a local instance',
-           { noHelp: true } as program.CommandOptions
-          ).alias('p')
   .command('diagnostic [action]',
            'like couple therapy, but for your instance',
            { noHelp: true } as program.CommandOptions