Rewriting the prosody config generator code.
This commit is contained in:
John Livingston
parent
c19035c0b7
commit
1c0fbe743f
@ -1,8 +1,8 @@
|
||||
import * as fs from 'fs'
|
||||
import * as path from 'path'
|
||||
import { pluginName, getBaseRouter } from '../helpers'
|
||||
|
||||
type LogMode = 'debug' | 'info'
|
||||
import { ProsodyFilePaths } from './config/paths'
|
||||
import { ProsodyConfigContent } from './config/content'
|
||||
|
||||
async function getWorkingDir ({ peertubeHelpers, storageManager }: RegisterServerOptions): Promise<string> {
|
||||
const logger = peertubeHelpers.logger
|
||||
@ -62,15 +62,6 @@ async function ensureWorkingDir (options: RegisterServerOptions): Promise<string
|
||||
return dir
|
||||
}
|
||||
|
||||
interface ProsodyFilePaths {
|
||||
dir: string
|
||||
pid: string
|
||||
error: string
|
||||
log: string
|
||||
config: string
|
||||
data: string
|
||||
modules: string
|
||||
}
|
||||
async function getProsodyFilePaths (options: RegisterServerOptions): Promise<ProsodyFilePaths> {
|
||||
const logger = options.peertubeHelpers.logger
|
||||
logger.debug('Calling getProsodyFilePaths')
|
||||
@ -87,14 +78,6 @@ async function getProsodyFilePaths (options: RegisterServerOptions): Promise<Pro
|
||||
}
|
||||
}
|
||||
|
||||
interface ProsodyModuleConfig {
|
||||
module: string
|
||||
options: Array<{
|
||||
name: string
|
||||
value: string
|
||||
}>
|
||||
}
|
||||
|
||||
interface ProsodyConfig {
|
||||
content: string
|
||||
paths: ProsodyFilePaths
|
||||
@ -110,111 +93,17 @@ async function getProsodyConfig (options: RegisterServerOptions): Promise<Prosod
|
||||
}
|
||||
const peertubeDomain = 'localhost'
|
||||
const paths = await getProsodyFilePaths(options)
|
||||
const logMode: LogMode = process.env.NODE_ENV === 'test' ? 'debug' : 'info'
|
||||
|
||||
const mucModules: ProsodyModuleConfig[] = []
|
||||
const roomApiUrl = options.peertubeHelpers.config.getWebserverUrl() +
|
||||
getBaseRouter() +
|
||||
'api/room?{room.jid|jid_node}'
|
||||
|
||||
mucModules.push({
|
||||
module: 'muc_http_defaults',
|
||||
options: [
|
||||
{
|
||||
name: 'muc_create_api_url',
|
||||
value: options.peertubeHelpers.config.getWebserverUrl() + getBaseRouter() + 'api/room'
|
||||
}
|
||||
]
|
||||
})
|
||||
|
||||
const mucModulesEnabled: string = mucModules.map(m => ' "' + m.module + '";').join('\n')
|
||||
const mucModulesOptions: string = mucModules.map(m => {
|
||||
return m.options.map(o => {
|
||||
return ' ' + o.name + ' = "' + o.value + '"'
|
||||
}).join('\n')
|
||||
}).join('\n')
|
||||
|
||||
const content = `
|
||||
|
||||
daemonize = false
|
||||
pidfile = "${paths.pid}"
|
||||
plugin_paths = { "${paths.modules}" }
|
||||
data_path = "${paths.data}"
|
||||
interfaces = { "127.0.0.1" }
|
||||
c2s_ports = { }
|
||||
c2s_interfaces = { "127.0.0.1" }
|
||||
s2s_ports = { }
|
||||
s2s_interfaces = { "127.0.0.1" }
|
||||
http_ports = { "${port}" }
|
||||
http_interfaces = { "127.0.0.1" }
|
||||
https_ports = { }
|
||||
https_interfaces = { "127.0.0.1" }
|
||||
|
||||
admins = { }
|
||||
|
||||
modules_enabled = {
|
||||
"roster"; -- Allow users to have a roster. Recommended ;)
|
||||
"saslauth"; -- Authentication for clients and servers. Recommended if you want to log in.
|
||||
"version"; -- Replies to server version requests
|
||||
"uptime"; -- Report how long server has been running
|
||||
"ping"; -- Replies to XMPP pings with pongs
|
||||
|
||||
"bosh"; -- Enable BOSH clients, aka "Jabber over HTTP"
|
||||
|
||||
"posix"; -- POSIX functionality, sends server to background, enables syslog, etc.
|
||||
}
|
||||
modules_disabled = {
|
||||
-- "offline"; -- Store offline messages
|
||||
-- "c2s"; -- Handle client connections
|
||||
"s2s"; -- Handle server-to-server connections
|
||||
}
|
||||
|
||||
allow_registration = false
|
||||
|
||||
c2s_require_encryption = false
|
||||
|
||||
archive_expires_after = "1w" -- Remove archived messages after 1 week
|
||||
|
||||
log = {
|
||||
-- Log files (change 'info' to 'debug' for debug logs):
|
||||
${logMode} = "${paths.log}";
|
||||
error = "${paths.error}";
|
||||
-- Syslog:
|
||||
-- { levels = { "error" }; to = "syslog"; };
|
||||
}
|
||||
|
||||
cross_domain_bosh = false
|
||||
consider_bosh_secure = true
|
||||
cross_domain_websocket = false
|
||||
consider_websocket_secure = true
|
||||
|
||||
VirtualHost "localhost"
|
||||
trusted_proxies = { "127.0.0.1", "::1" }
|
||||
|
||||
authentication = "anonymous"
|
||||
allow_anonymous_s2s = false
|
||||
modules_enabled = {
|
||||
"http";
|
||||
"bosh";
|
||||
"ping";
|
||||
}
|
||||
http_host = "${peertubeDomain}"
|
||||
http_external_url = "http://${peertubeDomain}"
|
||||
|
||||
Component "room.localhost" "muc"
|
||||
restrict_room_creation = "local"
|
||||
modules_enabled = {
|
||||
${mucModulesEnabled}
|
||||
}
|
||||
muc_room_locking = false
|
||||
muc_tombstones = false
|
||||
muc_room_default_language = "en"
|
||||
muc_room_default_public = true
|
||||
muc_room_default_persistent = false
|
||||
muc_room_default_members_only = false
|
||||
muc_room_default_moderated = false
|
||||
muc_room_default_public_jids = false
|
||||
muc_room_default_change_subject = false
|
||||
muc_room_default_history_length = 20
|
||||
${mucModulesOptions}
|
||||
`
|
||||
const config = new ProsodyConfigContent(paths)
|
||||
config.usePeertubeBosh(peertubeDomain, port)
|
||||
config.useMucHttpDefault(roomApiUrl)
|
||||
config.setArchive('1w') // Remove archived messages after 1 week
|
||||
config.setLog(process.env.NODE_ENV === 'test' ? 'debug' : 'info')
|
||||
const content = config.write()
|
||||
|
||||
return {
|
||||
content,
|
||||
|
||||
219
server/lib/prosody/config/content.ts
Normal file
219
server/lib/prosody/config/content.ts
Normal file
@ -0,0 +1,219 @@
|
||||
import type { ProsodyFilePaths } from './paths'
|
||||
|
||||
type ConfigEntryValue = boolean | number | string | ConfigEntryValue[]
|
||||
|
||||
interface ConfigEntries {[keys: string]: ConfigEntryValue}
|
||||
|
||||
function writeValue (value: ConfigEntryValue): string {
|
||||
if (typeof value === 'boolean') {
|
||||
return value.toString() + ';\n'
|
||||
}
|
||||
if (typeof value === 'string') {
|
||||
return '"' + value.replace(/"/g, '\\"') + '"' + ';\n'
|
||||
}
|
||||
if (typeof value === 'number') {
|
||||
return value.toString() + ';\n'
|
||||
}
|
||||
if (Array.isArray(value)) {
|
||||
let s = '{\n'
|
||||
for (let i = 0; i < value.length; i++) {
|
||||
s += ' ' + writeValue(value[i])
|
||||
}
|
||||
s += '};\n'
|
||||
return s
|
||||
}
|
||||
throw new Error(`Don't know how to handle this value: ${value as string}`)
|
||||
}
|
||||
|
||||
abstract class ProsodyConfigBlock {
|
||||
entries: ConfigEntries
|
||||
prefix: string
|
||||
|
||||
constructor (prefix: string) {
|
||||
this.prefix = prefix
|
||||
this.entries = {}
|
||||
}
|
||||
|
||||
set (name: string, value: ConfigEntryValue): void {
|
||||
this.entries[name] = value
|
||||
}
|
||||
|
||||
add (name: string, value: ConfigEntryValue): void {
|
||||
if (!(name in this.entries)) {
|
||||
this.entries[name] = []
|
||||
}
|
||||
let entry = this.entries[name]
|
||||
if (!Array.isArray(entry)) {
|
||||
entry = [entry]
|
||||
}
|
||||
entry.push(value)
|
||||
this.entries[name] = entry
|
||||
}
|
||||
|
||||
write (): string {
|
||||
let content = ''
|
||||
// Using Reflect.ownKeys to keep order
|
||||
Reflect.ownKeys(this.entries).forEach(key => {
|
||||
content += this.prefix + (key as string) + ' = ' + writeValue(this.entries[key as string])
|
||||
})
|
||||
return content
|
||||
}
|
||||
}
|
||||
|
||||
class ProsodyConfigGlobal extends ProsodyConfigBlock {
|
||||
constructor () {
|
||||
super('')
|
||||
}
|
||||
}
|
||||
|
||||
class ProsodyConfigVirtualHost extends ProsodyConfigBlock {
|
||||
name: string
|
||||
|
||||
constructor (name: string) {
|
||||
super(' ')
|
||||
this.name = name
|
||||
}
|
||||
|
||||
write (): string {
|
||||
return `VirtualHost "${this.name}"\n` + super.write()
|
||||
}
|
||||
}
|
||||
|
||||
class ProsodyConfigComponent extends ProsodyConfigBlock {
|
||||
name: string
|
||||
type: string
|
||||
|
||||
constructor (type: string, name: string) {
|
||||
super(' ')
|
||||
this.type = type
|
||||
this.name = name
|
||||
}
|
||||
|
||||
write (): string {
|
||||
return `Component "${this.name}" "${this.type}"\n` + super.write()
|
||||
}
|
||||
}
|
||||
|
||||
type ProsodyLogLevel = 'debug' | 'info'
|
||||
|
||||
class ProsodyConfigContent {
|
||||
paths: ProsodyFilePaths
|
||||
global: ProsodyConfigGlobal
|
||||
anon: ProsodyConfigVirtualHost
|
||||
muc: ProsodyConfigComponent
|
||||
log: string
|
||||
|
||||
constructor (paths: ProsodyFilePaths) {
|
||||
this.paths = paths
|
||||
this.global = new ProsodyConfigGlobal()
|
||||
this.log = ''
|
||||
this.anon = new ProsodyConfigVirtualHost('localhost')
|
||||
this.muc = new ProsodyConfigComponent('muc', 'room.localhost')
|
||||
|
||||
this.global.set('daemonize', false)
|
||||
this.global.set('allow_registration', false)
|
||||
this.global.set('admins', [])
|
||||
|
||||
this.global.set('pidfile', this.paths.pid)
|
||||
this.global.set('plugin_paths', [this.paths.modules])
|
||||
this.global.set('data_path', this.paths.data)
|
||||
|
||||
this.global.set('modules_enabled', [
|
||||
'roster', // Allow users to have a roster. Recommended ;)
|
||||
'saslauth', // Authentication for clients and servers. Recommended if you want to log in.
|
||||
'version', // Replies to server version requests
|
||||
'uptime', // Report how long server has been running
|
||||
'ping', // Replies to XMPP pings with pongs
|
||||
'bosh', // Enable BOSH clients, aka "Jabber over HTTP"
|
||||
'posix' // POSIX functionality, sends server to background, enables syslog, etc.
|
||||
])
|
||||
this.global.set('modules_disabled', [
|
||||
// 'offline' // Store offline messages
|
||||
// 'c2s' // Handle client connections
|
||||
's2s' // Handle server-to-server connections
|
||||
])
|
||||
|
||||
this.global.set('cross_domain_bosh', false)
|
||||
this.global.set('consider_bosh_secure', false)
|
||||
this.global.set('cross_domain_websocket', false)
|
||||
this.global.set('consider_websocket_secure', false)
|
||||
|
||||
this.anon.set('authentication', 'anonymous')
|
||||
this.anon.set('modules_enabled', ['ping'])
|
||||
|
||||
this.muc.set('muc_room_locking', false)
|
||||
this.muc.set('muc_tombstones', false)
|
||||
this.muc.set('muc_room_default_language', 'en')
|
||||
this.muc.set('muc_room_default_public', true)
|
||||
this.muc.set('muc_room_default_persistent', false)
|
||||
this.muc.set('muc_room_default_members_only', false)
|
||||
this.muc.set('muc_room_default_moderated', false)
|
||||
this.muc.set('muc_room_default_public_jids', false)
|
||||
this.muc.set('muc_room_default_change_subject', false)
|
||||
this.muc.set('muc_room_default_history_length', 20)
|
||||
}
|
||||
|
||||
usePeertubeBosh (peertubeDomain: string, port: string): void {
|
||||
this.global.set('c2s_require_encryption', false)
|
||||
this.global.set('interfaces', ['127.0.0.1', '::1'])
|
||||
this.global.set('c2s_ports', [])
|
||||
this.global.set('c2s_interfaces', ['127.0.0.1', '::1'])
|
||||
this.global.set('s2s_ports', [])
|
||||
this.global.set('s2s_interfaces', ['127.0.0.1', '::1'])
|
||||
this.global.set('http_ports', [port])
|
||||
this.global.set('http_interfaces', ['127.0.0.1', '::1'])
|
||||
this.global.set('https_ports', [])
|
||||
this.global.set('https_interfaces', ['127.0.0.1', '::1'])
|
||||
|
||||
this.global.set('consider_bosh_secure', true)
|
||||
|
||||
this.anon.set('trusted_proxies', ['127.0.0.1', '::1'])
|
||||
this.anon.set('allow_anonymous_s2s', false)
|
||||
this.anon.add('modules_enabled', 'http')
|
||||
this.anon.add('modules_enabled', 'bosh')
|
||||
this.anon.set('http_host', peertubeDomain)
|
||||
this.anon.set('http_external_url', 'http://' + peertubeDomain)
|
||||
|
||||
this.muc.set('restrict_room_creation', 'local')
|
||||
}
|
||||
|
||||
useMucHttpDefault (url: string, bearer?: string): void {
|
||||
this.muc.add('modules_enabled', 'muc_http_defaults')
|
||||
this.muc.add('muc_create_api_url', url)
|
||||
if (bearer) {
|
||||
this.muc.add('muc_create_api_auth', bearer)
|
||||
}
|
||||
}
|
||||
|
||||
setArchive (duration: string): void {
|
||||
this.global.set('archive_expires_after', duration)
|
||||
}
|
||||
|
||||
setLog (level: ProsodyLogLevel, syslog?: ProsodyLogLevel[]): void {
|
||||
let log = ''
|
||||
log += 'log = {\n'
|
||||
log += ' ' + level + ' = ' + writeValue(this.paths.log)
|
||||
log += ' error = ' + writeValue(this.paths.error)
|
||||
if (syslog) {
|
||||
log += ' { to = "syslog"; levels = ' + writeValue(syslog) + ' };\n'
|
||||
}
|
||||
log += '\n};\n'
|
||||
this.log = log
|
||||
}
|
||||
|
||||
public write (): string {
|
||||
let content = ''
|
||||
content += this.global.write()
|
||||
content += this.log + '\n'
|
||||
content += '\n\n'
|
||||
content += this.anon.write()
|
||||
content += '\n\n'
|
||||
content += this.muc.write()
|
||||
content += '\n\n'
|
||||
return content
|
||||
}
|
||||
}
|
||||
|
||||
export {
|
||||
ProsodyConfigContent
|
||||
}
|
||||
13
server/lib/prosody/config/paths.ts
Normal file
13
server/lib/prosody/config/paths.ts
Normal file
@ -0,0 +1,13 @@
|
||||
interface ProsodyFilePaths {
|
||||
dir: string
|
||||
pid: string
|
||||
error: string
|
||||
log: string
|
||||
config: string
|
||||
data: string
|
||||
modules: string
|
||||
}
|
||||
|
||||
export {
|
||||
ProsodyFilePaths
|
||||
}
|
||||
Loading…
x
Reference in New Issue
Block a user