import { Command } from 'commander' import { Netrc } from 'netrc-parser' import { join } from 'path' import { createLogger, format, transports } from 'winston' import { getAppNumber, isTestInstance } from '@server/helpers/core-utils' import { loadLanguages } from '@server/initializers/constants' import { root } from '@shared/core-utils' import { UserRole, VideoPrivacy } from '@shared/models' import { PeerTubeServer } from '@shared/server-commands' let configName = 'PeerTube/CLI' if (isTestInstance()) configName += `-${getAppNumber()}` const config = require('application-config')(configName) const version = require(join(root(), 'package.json')).version async function getAdminTokenOrDie (server: PeerTubeServer, username: string, password: string) { const token = await server.login.getAccessToken(username, password) const me = await server.users.getMyInfo({ token }) if (me.role.id !== UserRole.ADMINISTRATOR) { console.error('You must be an administrator.') process.exit(-1) } return token } interface Settings { remotes: any[] default: number } async function getSettings (): Promise { const defaultSettings = { remotes: [], default: -1 } const data = await config.read() return Object.keys(data).length === 0 ? defaultSettings : data } async function getNetrc () { const Netrc = require('netrc-parser').Netrc const netrc = isTestInstance() ? new Netrc(join(root(), 'test' + getAppNumber(), 'netrc')) : new Netrc() await netrc.load() return netrc } function writeSettings (settings: Settings) { return config.write(settings) } function deleteSettings () { return config.trash() } function getRemoteObjectOrDie ( program: Command, settings: Settings, netrc: Netrc ): { url: string, username: string, password: string } { const options = program.opts() function exitIfNoOptions (optionNames: string[], errorPrefix: string = '') { let exit = false for (const key of optionNames) { if (!options[key]) { if (exit === false && errorPrefix) console.error(errorPrefix) console.error(`--${key} field is required`) exit = true } } if (exit) process.exit(-1) } // If username or password are specified, both are mandatory if (options.username || options.password) { exitIfNoOptions([ 'username', 'password' ]) } // 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') } if (settings.remotes.length === 0 || settings.default === -1) { exitIfNoOptions([ 'url' ], 'No default instance found') } let url: string = options.url let username: string = options.username let password: string = options.password if (!url && settings.default !== -1) url = settings.remotes[settings.default] const machine = netrc.machines[url] if ((!username || !password) && !machine) { console.error('Cannot find existing configuration for %s.', url) process.exit(-1) } if (!username && machine) username = machine.login if (!password && machine) password = machine.password return { url, username, password } } function buildCommonVideoOptions (command: Command) { function list (val) { return val.split(',') } return command .option('-n, --video-name ', 'Video name') .option('-c, --category ', 'Category number') .option('-l, --licence ', 'Licence number') .option('-L, --language ', 'Language ISO 639 code (fr or en...)') .option('-t, --tags ', 'Video tags', list) .option('-N, --nsfw', 'Video is Not Safe For Work') .option('-d, --video-description ', 'Video description') .option('-P, --privacy ', 'Privacy') .option('-C, --channel-name ', 'Channel name') .option('--no-comments-enabled', 'Disable video comments') .option('-s, --support ', 'Video support text') .option('--no-wait-transcoding', 'Do not wait transcoding before publishing the video') .option('--no-download-enabled', 'Disable video download') .option('-v, --verbose ', 'Verbosity, from 0/\'error\' to 4/\'debug\'', 'info') } async function buildVideoAttributesFromCommander (server: PeerTubeServer, command: Command, defaultAttributes: any = {}) { const options = command.opts() const defaultBooleanAttributes = { nsfw: false, commentsEnabled: true, downloadEnabled: true, waitTranscoding: true } const booleanAttributes: { [id in keyof typeof defaultBooleanAttributes]: boolean } | {} = {} for (const key of Object.keys(defaultBooleanAttributes)) { if (options[key] !== undefined) { booleanAttributes[key] = options[key] } else if (defaultAttributes[key] !== undefined) { booleanAttributes[key] = defaultAttributes[key] } else { booleanAttributes[key] = defaultBooleanAttributes[key] } } const videoAttributes = { 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) if (options.channelName) { 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 } function getServerCredentials (program: Command) { return Promise.all([ getSettings(), getNetrc() ]) .then(([ settings, netrc ]) => { return getRemoteObjectOrDie(program, settings, netrc) }) } function buildServer (url: string) { loadLanguages() return new PeerTubeServer({ url }) } async function assignToken (server: PeerTubeServer, username: string, password: string) { const bodyClient = await server.login.getClient() const client = { id: bodyClient.client_id, secret: bodyClient.client_secret } const body = await server.login.login({ client, user: { username, password } }) 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, writeSettings, deleteSettings, getServerCredentials, buildCommonVideoOptions, buildVideoAttributesFromCommander, getAdminTokenOrDie, buildServer, assignToken }