PeerTube/server/tools/cli.ts

264 lines
7.4 KiB
TypeScript
Raw Normal View History

2021-07-09 15:03:44 +02:00
import { Command } from 'commander'
2019-06-13 11:09:38 +02:00
import { Netrc } from 'netrc-parser'
import { join } from 'path'
import { createLogger, format, transports } from 'winston'
import { loadLanguages } from '@server/initializers/constants'
import { root } from '@shared/core-utils'
2021-07-13 14:23:01 +02:00
import { UserRole } from '@shared/models'
import { PeerTubeServer } from '@shared/server-commands'
2021-07-09 15:03:44 +02:00
import { VideoPrivacy } from '../../shared/models/videos'
import { getAppNumber, isTestInstance } from '../helpers/core-utils'
2019-06-13 11:09:38 +02:00
let configName = 'PeerTube/CLI'
if (isTestInstance()) configName += `-${getAppNumber()}`
const config = require('application-config')(configName)
const version = require(join(root(), 'package.json')).version
2021-07-16 09:47:51 +02:00
async function getAdminTokenOrDie (server: PeerTubeServer, username: string, password: string) {
2021-07-16 09:04:35 +02:00
const token = await server.login.getAccessToken(username, password)
const me = await server.users.getMyInfo({ token })
2020-01-28 11:07:23 +01:00
2022-10-31 08:45:46 +01:00
if (me.role.id !== UserRole.ADMINISTRATOR) {
2020-01-28 11:07:23 +01:00
console.error('You must be an administrator.')
process.exit(-1)
}
2021-07-13 14:23:01 +02:00
return token
2020-01-28 11:07:23 +01:00
}
interface Settings {
2020-01-31 16:56:52 +01:00
remotes: any[]
default: number
}
2020-04-02 14:09:33 +02:00
async function getSettings (): Promise<Settings> {
const defaultSettings = {
remotes: [],
default: -1
}
2020-04-02 14:09:33 +02:00
const data = await config.read()
2020-04-02 14:09:33 +02:00
return Object.keys(data).length === 0
? defaultSettings
: data
}
async function getNetrc () {
2019-06-13 11:09:38 +02:00
const Netrc = require('netrc-parser').Netrc
const netrc = isTestInstance()
? new Netrc(join(root(), 'test' + getAppNumber(), 'netrc'))
: new Netrc()
await netrc.load()
return netrc
}
2020-04-02 14:09:33 +02:00
function writeSettings (settings: Settings) {
return config.write(settings)
2019-06-13 11:09:38 +02:00
}
function deleteSettings () {
2020-04-02 14:09:33 +02:00
return config.trash()
}
function getRemoteObjectOrDie (
2021-06-25 17:48:27 +02:00
program: Command,
settings: Settings,
netrc: Netrc
): { url: string, username: string, password: string } {
2021-02-03 09:33:05 +01:00
const options = program.opts()
2022-03-15 09:21:05 +01:00
function exitIfNoOptions (optionNames: string[], errorPrefix: string = '') {
let exit = false
2022-03-15 09:21:05 +01:00
for (const key of optionNames) {
if (!options[key]) {
2022-01-20 09:33:49 +01:00
if (exit === false && errorPrefix) console.error(errorPrefix)
console.error(`--${key} field is required`)
exit = true
}
}
if (exit) process.exit(-1)
}
2022-01-20 09:33:49 +01:00
// If username or password are specified, both are mandatory
if (options.username || options.password) {
exitIfNoOptions([ 'username', 'password' ])
}
2022-01-20 09:33:49 +01:00
// If no available machines, url, username and password args are mandatory
if (Object.keys(netrc.machines).length === 0) {
exitIfNoOptions([ 'url', 'username', 'password' ], 'No account found in netrc')
}
2022-01-20 09:33:49 +01:00
if (settings.remotes.length === 0 || settings.default === -1) {
exitIfNoOptions([ 'url' ], 'No default instance found')
}
2019-06-13 11:09:38 +02:00
2022-01-20 09:33:49 +01:00
let url: string = options.url
let username: string = options.username
let password: string = options.password
2022-01-20 09:33:49 +01:00
if (!url && settings.default !== -1) url = settings.remotes[settings.default]
2022-01-20 09:33:49 +01:00
const machine = netrc.machines[url]
if ((!username || !password) && !machine) {
console.error('Cannot find existing configuration for %s.', url)
process.exit(-1)
}
2022-01-20 09:33:49 +01:00
if (!username && machine) username = machine.login
if (!password && machine) password = machine.password
return { url, username, password }
}
2021-06-25 17:48:27 +02:00
function buildCommonVideoOptions (command: Command) {
function list (val) {
return val.split(',')
}
return command
.option('-n, --video-name <name>', 'Video name')
.option('-c, --category <category_number>', 'Category number')
.option('-l, --licence <licence_number>', 'Licence number')
.option('-L, --language <language_code>', 'Language ISO 639 code (fr or en...)')
.option('-t, --tags <tags>', 'Video tags', list)
.option('-N, --nsfw', 'Video is Not Safe For Work')
.option('-d, --video-description <description>', 'Video description')
.option('-P, --privacy <privacy_number>', 'Privacy')
.option('-C, --channel-name <channel_name>', 'Channel name')
2020-04-16 16:20:19 +02:00
.option('--no-comments-enabled', 'Disable video comments')
.option('-s, --support <support>', 'Video support text')
2020-04-16 16:20:19 +02:00
.option('--no-wait-transcoding', 'Do not wait transcoding before publishing the video')
.option('--no-download-enabled', 'Disable video download')
.option('-v, --verbose <verbose>', 'Verbosity, from 0/\'error\' to 4/\'debug\'', 'info')
}
2021-07-16 09:47:51 +02:00
async function buildVideoAttributesFromCommander (server: PeerTubeServer, command: Command, defaultAttributes: any = {}) {
2021-02-03 09:33:05 +01:00
const options = command.opts()
2019-06-13 13:59:34 +02:00
const defaultBooleanAttributes = {
nsfw: false,
commentsEnabled: true,
downloadEnabled: true,
waitTranscoding: true
}
const booleanAttributes: { [id in keyof typeof defaultBooleanAttributes]: boolean } | {} = {}
2019-06-13 13:59:34 +02:00
for (const key of Object.keys(defaultBooleanAttributes)) {
2021-02-03 09:33:05 +01:00
if (options[key] !== undefined) {
booleanAttributes[key] = options[key]
} else if (defaultAttributes[key] !== undefined) {
booleanAttributes[key] = defaultAttributes[key]
} else {
2019-06-13 13:59:34 +02:00
booleanAttributes[key] = defaultBooleanAttributes[key]
}
}
const videoAttributes = {
2021-02-03 09:33:05 +01:00
name: options.videoName || defaultAttributes.name,
category: options.category || defaultAttributes.category || undefined,
licence: options.licence || defaultAttributes.licence || undefined,
language: options.language || defaultAttributes.language || undefined,
privacy: options.privacy || defaultAttributes.privacy || VideoPrivacy.PUBLIC,
support: options.support || defaultAttributes.support || undefined,
description: options.videoDescription || defaultAttributes.description || undefined,
tags: options.tags || defaultAttributes.tags || undefined
}
Object.assign(videoAttributes, booleanAttributes)
2021-02-03 09:33:05 +01:00
if (options.channelName) {
2021-07-16 09:04:35 +02:00
const videoChannel = await server.channels.get({ channelName: options.channelName })
Object.assign(videoAttributes, { channelId: videoChannel.id })
if (!videoAttributes.support && videoChannel.support) {
Object.assign(videoAttributes, { support: videoChannel.support })
}
}
return videoAttributes
}
2021-06-25 17:48:27 +02:00
function getServerCredentials (program: Command) {
return Promise.all([ getSettings(), getNetrc() ])
2020-01-31 16:56:52 +01:00
.then(([ settings, netrc ]) => {
return getRemoteObjectOrDie(program, settings, netrc)
})
}
2021-07-16 09:47:51 +02:00
function buildServer (url: string) {
loadLanguages()
2021-07-16 09:47:51 +02:00
return new PeerTubeServer({ url })
2021-07-09 15:03:44 +02:00
}
2021-07-16 09:47:51 +02:00
async function assignToken (server: PeerTubeServer, username: string, password: string) {
2021-07-16 09:04:35 +02:00
const bodyClient = await server.login.getClient()
2021-07-13 11:44:16 +02:00
const client = { id: bodyClient.client_id, secret: bodyClient.client_secret }
2021-07-16 09:04:35 +02:00
const body = await server.login.login({ client, user: { username, password } })
2021-07-13 11:44:16 +02:00
server.accessToken = body.access_token
}
function getLogger (logLevel = 'info') {
const logLevels = {
0: 0,
error: 0,
1: 1,
warn: 1,
2: 2,
info: 2,
3: 3,
verbose: 3,
4: 4,
debug: 4
}
const logger = createLogger({
levels: logLevels,
format: format.combine(
format.splat(),
format.simple()
),
transports: [
new (transports.Console)({
level: logLevel
})
]
})
return logger
}
// ---------------------------------------------------------------------------
export {
version,
getLogger,
getSettings,
getNetrc,
getRemoteObjectOrDie,
2019-06-13 11:09:38 +02:00
writeSettings,
deleteSettings,
getServerCredentials,
buildCommonVideoOptions,
2020-01-28 11:07:23 +01:00
buildVideoAttributesFromCommander,
2021-07-09 15:03:44 +02:00
getAdminTokenOrDie,
2021-07-13 11:44:16 +02:00
buildServer,
assignToken
}