server/tools/cli.ts

   1 import { Command } from 'commander'
   2 import { Netrc } from 'netrc-parser'
   3 import { join } from 'path'
   4 import { createLogger, format, transports } from 'winston'
   5 import { loadLanguages } from '@server/initializers/constants'
   6 import { root } from '@shared/core-utils'
   7 import { UserRole } from '@shared/models'
   8 import { PeerTubeServer } from '@shared/server-commands'
   9 import { VideoPrivacy } from '../../shared/models/videos'
  10 import { getAppNumber, isTestInstance } from '../helpers/core-utils'
  11
  12 let configName = 'PeerTube/CLI'
  13 if (isTestInstance()) configName += `-${getAppNumber()}`
  14
  15 const config = require('application-config')(configName)
  16
  17 const version = require(join(root(), 'package.json')).version
  18
  19 async function getAdminTokenOrDie (server: PeerTubeServer, username: string, password: string) {
  20   const token = await server.login.getAccessToken(username, password)
  21   const me = await server.users.getMyInfo({ token })
  22
  23   if (me.role !== UserRole.ADMINISTRATOR) {
  24     console.error('You must be an administrator.')
  25     process.exit(-1)
  26   }
  27
  28   return token
  29 }
  30
  31 interface Settings {
  32   remotes: any[]
  33   default: number
  34 }
  35
  36 async function getSettings (): Promise<Settings> {
  37   const defaultSettings = {
  38     remotes: [],
  39     default: -1
  40   }
  41
  42   const data = await config.read()
  43
  44   return Object.keys(data).length === 0
  45     ? defaultSettings
  46     : data
  47 }
  48
  49 async function getNetrc () {
  50   const Netrc = require('netrc-parser').Netrc
  51
  52   const netrc = isTestInstance()
  53     ? new Netrc(join(root(), 'test' + getAppNumber(), 'netrc'))
  54     : new Netrc()
  55
  56   await netrc.load()
  57
  58   return netrc
  59 }
  60
  61 function writeSettings (settings: Settings) {
  62   return config.write(settings)
  63 }
  64
  65 function deleteSettings () {
  66   return config.trash()
  67 }
  68
  69 function getRemoteObjectOrDie (
  70   program: Command,
  71   settings: Settings,
  72   netrc: Netrc
  73 ): { url: string, username: string, password: string } {
  74   const options = program.opts()
  75
  76   const manualOptionMode = options.url || options.username || options.password
  77
  78   // Check parameters validity
  79   if (manualOptionMode || settings.remotes.length === 0 || Object.keys(netrc.machines).length === 0) {
  80     let exit = false
  81
  82     for (const key of [ 'url', 'username', 'password' ]) {
  83       if (!options[key]) {
  84         console.error(`--${key} field is required`)
  85         exit = true
  86       }
  87     }
  88
  89     if (exit) process.exit(-1)
  90   }
  91
  92   if (!manualOptionMode) {
  93     let url: string = options.url
  94     let username: string = options.username
  95     let password: string = options.password
  96
  97     if (!url && settings.default !== -1) url = settings.remotes[settings.default]
  98
  99     const machine = netrc.machines[url]
 100
 101     if (!username && machine) username = machine.login
 102     if (!password && machine) password = machine.password
 103
 104     return { url, username, password }
 105   }
 106
 107   return {
 108     url: options.url,
 109     username: options.username,
 110     password: options.password
 111   }
 112 }
 113
 114 function buildCommonVideoOptions (command: Command) {
 115   function list (val) {
 116     return val.split(',')
 117   }
 118
 119   return command
 120     .option('-n, --video-name <name>', 'Video name')
 121     .option('-c, --category <category_number>', 'Category number')
 122     .option('-l, --licence <licence_number>', 'Licence number')
 123     .option('-L, --language <language_code>', 'Language ISO 639 code (fr or en...)')
 124     .option('-t, --tags <tags>', 'Video tags', list)
 125     .option('-N, --nsfw', 'Video is Not Safe For Work')
 126     .option('-d, --video-description <description>', 'Video description')
 127     .option('-P, --privacy <privacy_number>', 'Privacy')
 128     .option('-C, --channel-name <channel_name>', 'Channel name')
 129     .option('--no-comments-enabled', 'Disable video comments')
 130     .option('-s, --support <support>', 'Video support text')
 131     .option('--no-wait-transcoding', 'Do not wait transcoding before publishing the video')
 132     .option('--no-download-enabled', 'Disable video download')
 133     .option('-v, --verbose <verbose>', 'Verbosity, from 0/\'error\' to 4/\'debug\'', 'info')
 134 }
 135
 136 async function buildVideoAttributesFromCommander (server: PeerTubeServer, command: Command, defaultAttributes: any = {}) {
 137   const options = command.opts()
 138
 139   const defaultBooleanAttributes = {
 140     nsfw: false,
 141     commentsEnabled: true,
 142     downloadEnabled: true,
 143     waitTranscoding: true
 144   }
 145
 146   const booleanAttributes: { [id in keyof typeof defaultBooleanAttributes]: boolean } | {} = {}
 147
 148   for (const key of Object.keys(defaultBooleanAttributes)) {
 149     if (options[key] !== undefined) {
 150       booleanAttributes[key] = options[key]
 151     } else if (defaultAttributes[key] !== undefined) {
 152       booleanAttributes[key] = defaultAttributes[key]
 153     } else {
 154       booleanAttributes[key] = defaultBooleanAttributes[key]
 155     }
 156   }
 157
 158   const videoAttributes = {
 159     name: options.videoName || defaultAttributes.name,
 160     category: options.category || defaultAttributes.category || undefined,
 161     licence: options.licence || defaultAttributes.licence || undefined,
 162     language: options.language || defaultAttributes.language || undefined,
 163     privacy: options.privacy || defaultAttributes.privacy || VideoPrivacy.PUBLIC,
 164     support: options.support || defaultAttributes.support || undefined,
 165     description: options.videoDescription || defaultAttributes.description || undefined,
 166     tags: options.tags || defaultAttributes.tags || undefined
 167   }
 168
 169   Object.assign(videoAttributes, booleanAttributes)
 170
 171   if (options.channelName) {
 172     const videoChannel = await server.channels.get({ channelName: options.channelName })
 173
 174     Object.assign(videoAttributes, { channelId: videoChannel.id })
 175
 176     if (!videoAttributes.support && videoChannel.support) {
 177       Object.assign(videoAttributes, { support: videoChannel.support })
 178     }
 179   }
 180
 181   return videoAttributes
 182 }
 183
 184 function getServerCredentials (program: Command) {
 185   return Promise.all([ getSettings(), getNetrc() ])
 186                 .then(([ settings, netrc ]) => {
 187                   return getRemoteObjectOrDie(program, settings, netrc)
 188                 })
 189 }
 190
 191 function buildServer (url: string) {
 192   loadLanguages()
 193   return new PeerTubeServer({ url })
 194 }
 195
 196 async function assignToken (server: PeerTubeServer, username: string, password: string) {
 197   const bodyClient = await server.login.getClient()
 198   const client = { id: bodyClient.client_id, secret: bodyClient.client_secret }
 199
 200   const body = await server.login.login({ client, user: { username, password } })
 201
 202   server.accessToken = body.access_token
 203 }
 204
 205 function getLogger (logLevel = 'info') {
 206   const logLevels = {
 207     0: 0,
 208     error: 0,
 209     1: 1,
 210     warn: 1,
 211     2: 2,
 212     info: 2,
 213     3: 3,
 214     verbose: 3,
 215     4: 4,
 216     debug: 4
 217   }
 218
 219   const logger = createLogger({
 220     levels: logLevels,
 221     format: format.combine(
 222       format.splat(),
 223       format.simple()
 224     ),
 225     transports: [
 226       new (transports.Console)({
 227         level: logLevel
 228       })
 229     ]
 230   })
 231
 232   return logger
 233 }
 234
 235 // ---------------------------------------------------------------------------
 236
 237 export {
 238   version,
 239   getLogger,
 240   getSettings,
 241   getNetrc,
 242   getRemoteObjectOrDie,
 243   writeSettings,
 244   deleteSettings,
 245
 246   getServerCredentials,
 247
 248   buildCommonVideoOptions,
 249   buildVideoAttributesFromCommander,
 250
 251   getAdminTokenOrDie,
 252   buildServer,
 253   assignToken
 254 }