From 1a73a7dcd0d38bebbb2cf7067851fc91b8b7f0d3 Mon Sep 17 00:00:00 2001 From: Chocobozzz Date: Wed, 15 Feb 2023 16:30:33 +0100 Subject: Move cli.ts in a private shared directory It's only used by cli scripts of this directory --- server/tools/cli.ts | 263 ------------------------------ server/tools/peertube-auth.ts | 2 +- server/tools/peertube-get-access-token.ts | 2 +- server/tools/peertube-import-videos.ts | 2 +- server/tools/peertube-plugins.ts | 2 +- server/tools/peertube-redundancy.ts | 2 +- server/tools/peertube-upload.ts | 2 +- server/tools/peertube.ts | 2 +- server/tools/shared/cli.ts | 262 +++++++++++++++++++++++++++++ server/tools/shared/index.ts | 1 + 10 files changed, 270 insertions(+), 270 deletions(-) delete mode 100644 server/tools/cli.ts create mode 100644 server/tools/shared/cli.ts create mode 100644 server/tools/shared/index.ts (limited to 'server/tools') diff --git a/server/tools/cli.ts b/server/tools/cli.ts deleted file mode 100644 index 4607d052a..000000000 --- a/server/tools/cli.ts +++ /dev/null @@ -1,263 +0,0 @@ -import { Command } from 'commander' -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' -import { UserRole } from '@shared/models' -import { PeerTubeServer } from '@shared/server-commands' -import { VideoPrivacy } from '../../shared/models/videos' -import { getAppNumber, isTestInstance } from '../helpers/core-utils' - -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 -} diff --git a/server/tools/peertube-auth.ts b/server/tools/peertube-auth.ts index 051156d66..c853469c2 100644 --- a/server/tools/peertube-auth.ts +++ b/server/tools/peertube-auth.ts @@ -1,7 +1,7 @@ import CliTable3 from 'cli-table3' import { OptionValues, program } from 'commander' import { isUserUsernameValid } from '../helpers/custom-validators/users' -import { assignToken, buildServer, getNetrc, getSettings, writeSettings } from './cli' +import { assignToken, buildServer, getNetrc, getSettings, writeSettings } from './shared' import prompt = require('prompt') diff --git a/server/tools/peertube-get-access-token.ts b/server/tools/peertube-get-access-token.ts index d59a3632e..71a4826e8 100644 --- a/server/tools/peertube-get-access-token.ts +++ b/server/tools/peertube-get-access-token.ts @@ -1,5 +1,5 @@ import { program } from 'commander' -import { assignToken, buildServer } from './cli' +import { assignToken, buildServer } from './shared' program .option('-u, --url ', 'Server url') diff --git a/server/tools/peertube-import-videos.ts b/server/tools/peertube-import-videos.ts index 938eed0ef..bbdaa09c0 100644 --- a/server/tools/peertube-import-videos.ts +++ b/server/tools/peertube-import-videos.ts @@ -13,7 +13,7 @@ import { buildVideoAttributesFromCommander, getLogger, getServerCredentials -} from './cli' +} from './shared' import prompt = require('prompt') diff --git a/server/tools/peertube-plugins.ts b/server/tools/peertube-plugins.ts index c51d9ebd1..0660c855f 100644 --- a/server/tools/peertube-plugins.ts +++ b/server/tools/peertube-plugins.ts @@ -2,7 +2,7 @@ import CliTable3 from 'cli-table3' import { Command, OptionValues, program } from 'commander' import { isAbsolute } from 'path' import { PluginType } from '../../shared/models' -import { assignToken, buildServer, getServerCredentials } from './cli' +import { assignToken, buildServer, getServerCredentials } from './shared' program .name('plugins') diff --git a/server/tools/peertube-redundancy.ts b/server/tools/peertube-redundancy.ts index 5c82fa420..fd6c760b2 100644 --- a/server/tools/peertube-redundancy.ts +++ b/server/tools/peertube-redundancy.ts @@ -4,7 +4,7 @@ import { URL } from 'url' import validator from 'validator' import { forceNumber, uniqify } from '@shared/core-utils' import { HttpStatusCode, VideoRedundanciesTarget } from '@shared/models' -import { assignToken, buildServer, getServerCredentials } from './cli' +import { assignToken, buildServer, getServerCredentials } from './shared' import bytes = require('bytes') program diff --git a/server/tools/peertube-upload.ts b/server/tools/peertube-upload.ts index 114fe8a29..87da55005 100644 --- a/server/tools/peertube-upload.ts +++ b/server/tools/peertube-upload.ts @@ -1,7 +1,7 @@ import { program } from 'commander' import { access, constants } from 'fs-extra' import { isAbsolute } from 'path' -import { assignToken, buildCommonVideoOptions, buildServer, buildVideoAttributesFromCommander, getServerCredentials } from './cli' +import { assignToken, buildCommonVideoOptions, buildServer, buildVideoAttributesFromCommander, getServerCredentials } from './shared' let command = program .name('upload') diff --git a/server/tools/peertube.ts b/server/tools/peertube.ts index 1d3158044..b79917b4f 100644 --- a/server/tools/peertube.ts +++ b/server/tools/peertube.ts @@ -1,7 +1,7 @@ #!/usr/bin/env node import { CommandOptions, program } from 'commander' -import { getSettings, version } from './cli' +import { getSettings, version } from './shared' program .version(version, '-v, --version') diff --git a/server/tools/shared/cli.ts b/server/tools/shared/cli.ts new file mode 100644 index 000000000..e010ab320 --- /dev/null +++ b/server/tools/shared/cli.ts @@ -0,0 +1,262 @@ +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 +} diff --git a/server/tools/shared/index.ts b/server/tools/shared/index.ts new file mode 100644 index 000000000..8a3f31e2f --- /dev/null +++ b/server/tools/shared/index.ts @@ -0,0 +1 @@ +export * from './cli' -- cgit v1.2.3