1 // eslint-disable @typescript-eslint/no-unnecessary-type-assertion
3 import { registerTSPaths } from '../helpers/register-ts-paths'
6 import * as program from 'commander'
7 import * as prompt from 'prompt'
8 import { getNetrc, getSettings, writeSettings } from './cli'
9 import { isUserUsernameValid } from '../helpers/custom-validators/users'
10 import { getAccessToken } from '../../shared/extra-utils'
11 import * as CliTable3 from 'cli-table3'
13 async function delInstance (url: string) {
14 const [ settings, netrc ] = await Promise.all([ getSettings(), getNetrc() ])
16 const index = settings.remotes.indexOf(url)
17 settings.remotes.splice(index)
19 if (settings.default === index) settings.default = -1
21 await writeSettings(settings)
23 delete netrc.machines[url]
28 async function setInstance (url: string, username: string, password: string, isDefault: boolean) {
29 const [ settings, netrc ] = await Promise.all([ getSettings(), getNetrc() ])
31 if (settings.remotes.includes(url) === false) {
32 settings.remotes.push(url)
35 if (isDefault || settings.remotes.length === 1) {
36 settings.default = settings.remotes.length - 1
39 await writeSettings(settings)
41 netrc.machines[url] = { login: username, password }
45 function isURLaPeerTubeInstance (url: string) {
46 return url.startsWith('http://') || url.startsWith('https://')
49 function stripExtraneousFromPeerTubeUrl (url: string) {
50 // Get everything before the 3rd /.
51 const urlLength = url.includes('/', 8)
55 return url.substr(0, urlLength)
60 .usage('[command] [options]')
64 .description('remember your accounts on remote instances for easier use')
65 .option('-u, --url <url>', 'Server url')
66 .option('-U, --username <username>', 'Username')
67 .option('-p, --password <token>', 'Password')
68 .option('--default', 'add the entry as the new default')
70 prompt.override = options
75 description: 'instance url',
76 conform: (value) => isURLaPeerTubeInstance(value),
77 message: 'It should be an URL (https://peertube.example.com)',
81 conform: (value) => isUserUsernameValid(value),
82 message: 'Name must be only letters, spaces, or dashes',
91 }, async (_, result) => {
95 // Strip out everything after the domain:port.
96 // @see https://github.com/Chocobozzz/PeerTube/issues/3520
97 result.url = stripExtraneousFromPeerTubeUrl(result.url)
99 await getAccessToken(result.url, result.username, result.password)
101 console.error(err.message)
105 await setInstance(result.url, result.username, result.password, program['default'])
112 .command('del <url>')
113 .description('unregisters a remote instance')
114 .action(async url => {
115 await delInstance(url)
122 .description('lists registered remote instances')
123 .action(async () => {
124 const [ settings, netrc ] = await Promise.all([ getSettings(), getNetrc() ])
126 const table = new CliTable3({
127 head: [ 'instance', 'login' ],
128 colWidths: [ 30, 30 ]
131 settings.remotes.forEach(element => {
132 if (!netrc.machines[element]) return
136 netrc.machines[element].login
140 console.log(table.toString())
146 .command('set-default <url>')
147 .description('set an existing entry as default')
148 .action(async url => {
149 const settings = await getSettings()
150 const instanceExists = settings.remotes.includes(url)
152 if (instanceExists) {
153 settings.default = settings.remotes.indexOf(url)
154 await writeSettings(settings)
158 console.log('<url> is not a registered instance.')
163 program.on('--help', function () {
164 console.log(' Examples:')
166 console.log(' $ peertube auth add -u https://peertube.cpy.re -U "PEERTUBE_USER" --password "PEERTUBE_PASSWORD"')
167 console.log(' $ peertube auth add -u https://peertube.cpy.re -U root')
168 console.log(' $ peertube auth list')
169 console.log(' $ peertube auth del https://peertube.cpy.re')
173 if (!process.argv.slice(2).length) {
177 program.parse(process.argv)