peertube-plugin-livechat/server/lib/prosody/config.ts

194 lines
5.3 KiB
TypeScript
Raw Normal View History

2021-04-12 18:52:21 +00:00
import * as fs from 'fs'
2021-04-13 15:13:41 +00:00
import * as path from 'path'
2021-04-12 18:52:21 +00:00
import { pluginName } from '../helpers'
type LogMode = 'debug' | 'info'
async function getWorkingDir ({ peertubeHelpers, storageManager }: RegisterServerOptions): Promise<string> {
2021-04-14 15:10:22 +00:00
const logger = peertubeHelpers.logger
logger.debug('Calling getWorkingDir')
2021-04-12 18:52:21 +00:00
const tmpBaseDir = '/tmp/'
let value: string = await storageManager.getData('tempDirId')
2021-04-13 15:13:41 +00:00
function getPath (value: string): string {
return path.resolve(tmpBaseDir, pluginName + '-' + value)
}
2021-04-12 18:52:21 +00:00
while (!value) {
peertubeHelpers.logger.info('Generating an id for temp dir')
value = Math.random().toString(36).slice(2, 12)
2021-04-13 15:13:41 +00:00
const name = getPath(value)
2021-04-12 18:52:21 +00:00
if (fs.existsSync(name)) {
peertubeHelpers.logger.info('The folder ' + name + ' already exists, generating another name...')
value = ''
continue
}
await storageManager.storeData('tempDirId', value)
}
2021-04-14 15:10:22 +00:00
const dir = getPath(value)
logger.debug('getWorkingDir will return ' + dir)
return dir
}
/**
* Creates the working dir if needed, and returns it.
* NB: for now, I try to create a directory in /tmp/.
* To ensure that there is no conflict with another peertube instance,
* I used a randomly generated id that will be stored in database.
*/
async function ensureWorkingDir (options: RegisterServerOptions): Promise<string> {
const logger = options.peertubeHelpers.logger
logger.debug('Calling ensureworkingDir')
const dir = await getWorkingDir(options)
if (!fs.existsSync(dir)) {
logger.info(`The working dir ${dir} does not exists, trying to create it`)
await fs.promises.mkdir(dir)
logger.debug(`Working dir ${dir} was created`)
2021-04-12 18:52:21 +00:00
}
2021-04-14 15:10:22 +00:00
logger.debug(`Testing write access on ${dir}`)
await fs.promises.access(dir, fs.constants.W_OK) // will throw an error if no access
logger.debug(`Write access ok on ${dir}`)
return dir
2021-04-12 18:52:21 +00:00
}
2021-04-13 15:13:41 +00:00
interface ProsodyFilePaths {
2021-04-14 13:26:00 +00:00
dir: string
2021-04-13 15:13:41 +00:00
pid: string
error: string
log: string
config: string
}
async function getProsodyFilePaths (options: RegisterServerOptions): Promise<ProsodyFilePaths> {
2021-04-14 15:10:22 +00:00
const logger = options.peertubeHelpers.logger
logger.debug('Calling getProsodyFilePaths')
2021-04-13 15:13:41 +00:00
const dir = await getWorkingDir(options)
return {
2021-04-14 13:26:00 +00:00
dir: dir,
2021-04-13 15:13:41 +00:00
pid: path.resolve(dir, 'prosody.pid'),
error: path.resolve(dir, 'prosody.err'),
log: path.resolve(dir, 'prosody.log'),
config: path.resolve(dir, 'prosody.cfg.lua')
}
}
interface ProsodyConfig {
content: string
paths: ProsodyFilePaths
port: string
}
async function getProsodyConfig (options: RegisterServerOptions): Promise<ProsodyConfig> {
2021-04-14 15:10:22 +00:00
const logger = options.peertubeHelpers.logger
logger.debug('Calling getProsodyConfig')
2021-04-14 15:10:22 +00:00
const port = '5280'
2021-04-12 18:52:21 +00:00
const peertubeDomain = 'localhost'
2021-04-13 15:13:41 +00:00
const paths = await getProsodyFilePaths(options)
2021-04-12 18:52:21 +00:00
const logMode: LogMode = 'debug'
const content = `
2021-04-12 18:52:21 +00:00
admins = { }
plugin_paths = { }
modules_enabled = {
"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"
-- "websocket"; -- XMPP over WebSockets
"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
2021-04-14 13:26:00 +00:00
daemonize = false;
2021-04-12 18:52:21 +00:00
2021-04-13 15:13:41 +00:00
pidfile = "${paths.pid}";
2021-04-12 18:52:21 +00:00
c2s_require_encryption = false
archive_expires_after = "1w" -- Remove archived messages after 1 week
log = {
-- Log files (change 'info' to 'debug' for debug logs):
2021-04-13 15:13:41 +00:00
${logMode} = "${paths.log}";
error = "${paths.error}";
2021-04-12 18:52:21 +00:00
-- Syslog:
-- { levels = { "error" }; to = "syslog"; };
}
cross_domain_bosh = false;
consider_bosh_secure = true;
cross_domain_websocket = false;
consider_websocket_secure = true;
2021-04-15 09:02:05 +00:00
https_ports = {};
2021-04-12 18:52:21 +00:00
VirtualHost "anon.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"
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
`
return {
content,
paths,
port
}
2021-04-12 18:52:21 +00:00
}
async function writeProsodyConfig (options: RegisterServerOptions): Promise<ProsodyConfig> {
2021-04-13 15:13:41 +00:00
const logger = options.peertubeHelpers.logger
2021-04-14 15:10:22 +00:00
logger.debug('Calling writeProsodyConfig')
logger.debug('Ensuring that the working dir exists')
await ensureWorkingDir(options)
logger.debug('Computing the Prosody config content')
const config = await getProsodyConfig(options)
const content = config.content
const fileName = config.paths.config
2021-04-14 15:10:22 +00:00
2021-04-13 15:13:41 +00:00
logger.info(`Writing prosody configuration file to ${fileName}`)
await fs.promises.writeFile(fileName, content)
2021-04-14 15:10:22 +00:00
logger.debug('Prosody configuration file writen')
return config
2021-04-13 15:13:41 +00:00
}
2021-04-12 18:52:21 +00:00
export {
getProsodyConfig,
2021-04-13 15:13:41 +00:00
getWorkingDir,
2021-04-14 15:10:22 +00:00
ensureWorkingDir,
2021-04-13 15:13:41 +00:00
getProsodyFilePaths,
writeProsodyConfig
2021-04-12 18:52:21 +00:00
}