PeerTube/server/controllers/api/config.ts

418 lines
12 KiB
TypeScript
Raw Normal View History

2017-06-05 21:53:49 +02:00
import * as express from 'express'
2019-01-29 08:37:25 +01:00
import { snakeCase } from 'lodash'
2019-07-09 11:45:19 +02:00
import { ServerConfig, UserRight } from '../../../shared'
2018-02-28 18:04:46 +01:00
import { About } from '../../../shared/models/server/about.model'
import { CustomConfig } from '../../../shared/models/server/custom-config.model'
2018-08-14 15:28:30 +02:00
import { isSignupAllowed, isSignupAllowedForCurrentIP } from '../../helpers/signup'
2019-07-17 10:03:55 +02:00
import { CONSTRAINTS_FIELDS, DEFAULT_THEME_NAME, PEERTUBE_VERSION } from '../../initializers/constants'
import { asyncMiddleware, authenticate, ensureUserHasRight } from '../../middlewares'
import { customConfigUpdateValidator } from '../../middlewares/validators/config'
import { ClientHtml } from '../../lib/client-html'
2018-09-19 17:02:16 +02:00
import { auditLoggerFactory, CustomConfigAuditView, getAuditIdFromRes } from '../../helpers/audit-logger'
2018-08-27 16:23:34 +02:00
import { remove, writeJSON } from 'fs-extra'
2018-11-23 11:06:10 +01:00
import { getServerCommit } from '../../helpers/utils'
2020-01-07 14:56:07 +01:00
import validator from 'validator'
2019-01-09 15:14:29 +01:00
import { objectConverter } from '../../helpers/core-utils'
2020-02-17 10:27:00 +01:00
import { CONFIG, isEmailEnabled, reloadConfig } from '../../initializers/config'
2019-07-08 15:54:08 +02:00
import { PluginManager } from '../../lib/plugins/plugin-manager'
2019-07-09 11:45:19 +02:00
import { getThemeOrDefault } from '../../lib/plugins/theme-utils'
2019-10-25 13:54:32 +02:00
import { Hooks } from '@server/lib/plugins/hooks'
2017-05-15 22:22:03 +02:00
const configRouter = express.Router()
const auditLogger = auditLoggerFactory('config')
2018-01-31 17:47:36 +01:00
configRouter.get('/about', getAbout)
2017-10-25 11:55:06 +02:00
configRouter.get('/',
asyncMiddleware(getConfig)
)
2018-01-31 17:47:36 +01:00
configRouter.get('/custom',
authenticate,
ensureUserHasRight(UserRight.MANAGE_CONFIGURATION),
2020-01-31 16:56:52 +01:00
getCustomConfig
)
configRouter.put('/custom',
authenticate,
ensureUserHasRight(UserRight.MANAGE_CONFIGURATION),
2020-01-31 16:56:52 +01:00
customConfigUpdateValidator,
asyncMiddleware(updateCustomConfig)
)
configRouter.delete('/custom',
authenticate,
ensureUserHasRight(UserRight.MANAGE_CONFIGURATION),
asyncMiddleware(deleteCustomConfig)
)
2017-05-15 22:22:03 +02:00
let serverCommit: string
2019-07-17 10:03:55 +02:00
2018-11-23 11:06:10 +01:00
async function getConfig (req: express.Request, res: express.Response) {
2019-10-25 13:54:32 +02:00
const { allowed } = await Hooks.wrapPromiseFun(
isSignupAllowed,
{
ip: req.ip
},
2019-10-25 13:54:32 +02:00
'filter:api.user.signup.allowed.result'
)
const allowedForCurrentIP = isSignupAllowedForCurrentIP(req.ip)
2019-07-17 10:03:55 +02:00
const defaultTheme = getThemeOrDefault(CONFIG.THEME.DEFAULT, DEFAULT_THEME_NAME)
2018-11-23 11:06:10 +01:00
if (serverCommit === undefined) serverCommit = await getServerCommit()
2017-10-25 11:55:06 +02:00
const json: ServerConfig = {
2018-01-31 17:47:36 +01:00
instance: {
name: CONFIG.INSTANCE.NAME,
2018-03-15 14:31:08 +01:00
shortDescription: CONFIG.INSTANCE.SHORT_DESCRIPTION,
2018-03-01 13:57:29 +01:00
defaultClientRoute: CONFIG.INSTANCE.DEFAULT_CLIENT_ROUTE,
2019-02-20 15:36:43 +01:00
isNSFW: CONFIG.INSTANCE.IS_NSFW,
defaultNSFWPolicy: CONFIG.INSTANCE.DEFAULT_NSFW_POLICY,
customizations: {
javascript: CONFIG.INSTANCE.CUSTOMIZATIONS.JAVASCRIPT,
css: CONFIG.INSTANCE.CUSTOMIZATIONS.CSS
}
2018-01-31 17:47:36 +01:00
},
search: {
remoteUri: {
users: CONFIG.SEARCH.REMOTE_URI.USERS,
anonymous: CONFIG.SEARCH.REMOTE_URI.ANONYMOUS
}
},
2019-07-09 11:45:19 +02:00
plugin: {
2019-07-17 10:03:55 +02:00
registered: getRegisteredPlugins()
2019-07-09 11:45:19 +02:00
},
theme: {
2019-07-17 10:03:55 +02:00
registered: getRegisteredThemes(),
2019-07-09 11:45:19 +02:00
default: defaultTheme
},
email: {
2020-02-17 10:27:00 +01:00
enabled: isEmailEnabled()
},
2019-01-09 15:14:29 +01:00
contactForm: {
enabled: CONFIG.CONTACT_FORM.ENABLED
},
2019-07-17 10:03:55 +02:00
serverVersion: PEERTUBE_VERSION,
serverCommit,
2017-10-25 11:55:06 +02:00
signup: {
allowed,
allowedForCurrentIP,
requiresEmailVerification: CONFIG.SIGNUP.REQUIRES_EMAIL_VERIFICATION
2017-10-25 11:55:06 +02:00
},
transcoding: {
2019-01-29 08:37:25 +01:00
hls: {
enabled: CONFIG.TRANSCODING.HLS.ENABLED
},
webtorrent: {
enabled: CONFIG.TRANSCODING.WEBTORRENT.ENABLED
},
2019-07-17 10:03:55 +02:00
enabledResolutions: getEnabledResolutions()
2018-01-03 11:10:40 +01:00
},
2018-08-03 11:10:31 +02:00
import: {
2018-08-03 17:00:19 +02:00
videos: {
2018-08-03 11:10:31 +02:00
http: {
enabled: CONFIG.IMPORT.VIDEOS.HTTP.ENABLED
2018-08-07 10:07:53 +02:00
},
torrent: {
enabled: CONFIG.IMPORT.VIDEOS.TORRENT.ENABLED
2018-08-03 11:10:31 +02:00
}
}
},
autoBlacklist: {
videos: {
ofUsers: {
enabled: CONFIG.AUTO_BLACKLIST.VIDEOS.OF_USERS.ENABLED
}
}
},
2018-01-03 11:10:40 +01:00
avatar: {
file: {
size: {
max: CONSTRAINTS_FIELDS.ACTORS.AVATAR.FILE_SIZE.max
},
extensions: CONSTRAINTS_FIELDS.ACTORS.AVATAR.EXTNAME
}
},
video: {
image: {
extensions: CONSTRAINTS_FIELDS.VIDEOS.IMAGE.EXTNAME,
size: {
max: CONSTRAINTS_FIELDS.VIDEOS.IMAGE.FILE_SIZE.max
}
},
2018-01-03 11:10:40 +01:00
file: {
extensions: CONSTRAINTS_FIELDS.VIDEOS.EXTNAME
}
},
2018-07-12 19:02:00 +02:00
videoCaption: {
file: {
size: {
max: CONSTRAINTS_FIELDS.VIDEO_CAPTIONS.CAPTION_FILE.FILE_SIZE.max
},
extensions: CONSTRAINTS_FIELDS.VIDEO_CAPTIONS.CAPTION_FILE.EXTNAME
}
},
user: {
videoQuota: CONFIG.USER.VIDEO_QUOTA,
videoQuotaDaily: CONFIG.USER.VIDEO_QUOTA_DAILY
},
trending: {
videos: {
intervalDays: CONFIG.TRENDING.VIDEOS.INTERVAL_DAYS
}
2019-04-10 09:23:18 +02:00
},
tracker: {
enabled: CONFIG.TRACKER.ENABLED
},
followings: {
instance: {
autoFollowIndex: {
indexUrl: CONFIG.FOLLOWINGS.INSTANCE.AUTO_FOLLOW_INDEX.INDEX_URL
}
}
2017-05-15 22:22:03 +02:00
}
2017-10-25 11:55:06 +02:00
}
2017-10-25 11:55:06 +02:00
return res.json(json)
2017-05-15 22:22:03 +02:00
}
2019-02-20 15:36:43 +01:00
function getAbout (req: express.Request, res: express.Response) {
2018-01-31 17:47:36 +01:00
const about: About = {
instance: {
name: CONFIG.INSTANCE.NAME,
2018-03-15 14:31:08 +01:00
shortDescription: CONFIG.INSTANCE.SHORT_DESCRIPTION,
2018-01-31 17:47:36 +01:00
description: CONFIG.INSTANCE.DESCRIPTION,
2019-08-23 15:23:27 +02:00
terms: CONFIG.INSTANCE.TERMS,
codeOfConduct: CONFIG.INSTANCE.CODE_OF_CONDUCT,
hardwareInformation: CONFIG.INSTANCE.HARDWARE_INFORMATION,
2019-09-03 09:49:04 +02:00
creationReason: CONFIG.INSTANCE.CREATION_REASON,
2019-08-23 15:23:27 +02:00
moderationInformation: CONFIG.INSTANCE.MODERATION_INFORMATION,
administrator: CONFIG.INSTANCE.ADMINISTRATOR,
maintenanceLifetime: CONFIG.INSTANCE.MAINTENANCE_LIFETIME,
businessModel: CONFIG.INSTANCE.BUSINESS_MODEL,
languages: CONFIG.INSTANCE.LANGUAGES,
categories: CONFIG.INSTANCE.CATEGORIES
2018-01-31 17:47:36 +01:00
}
}
return res.json(about).end()
}
2020-01-31 16:56:52 +01:00
function getCustomConfig (req: express.Request, res: express.Response) {
const data = customConfig()
return res.json(data).end()
}
2019-02-20 15:36:43 +01:00
async function deleteCustomConfig (req: express.Request, res: express.Response) {
2018-08-27 16:23:34 +02:00
await remove(CONFIG.CUSTOM_FILE)
2018-09-19 17:02:16 +02:00
auditLogger.delete(getAuditIdFromRes(res), new CustomConfigAuditView(customConfig()))
reloadConfig()
ClientHtml.invalidCache()
const data = customConfig()
return res.json(data).end()
}
2019-02-20 15:36:43 +01:00
async function updateCustomConfig (req: express.Request, res: express.Response) {
const oldCustomConfigAuditKeys = new CustomConfigAuditView(customConfig())
2019-01-09 15:14:29 +01:00
// camelCase to snake_case key + Force number conversion
const toUpdateJSON = convertCustomConfigBody(req.body)
2018-08-27 16:23:34 +02:00
await writeJSON(CONFIG.CUSTOM_FILE, toUpdateJSON, { spaces: 2 })
reloadConfig()
ClientHtml.invalidCache()
const data = customConfig()
auditLogger.update(
2018-09-19 17:02:16 +02:00
getAuditIdFromRes(res),
new CustomConfigAuditView(data),
oldCustomConfigAuditKeys
)
return res.json(data).end()
}
function getRegisteredThemes () {
return PluginManager.Instance.getRegisteredThemes()
.map(t => ({
name: t.name,
version: t.version,
description: t.description,
css: t.css,
clientScripts: t.clientScripts
}))
}
function getEnabledResolutions () {
return Object.keys(CONFIG.TRANSCODING.RESOLUTIONS)
2020-01-31 16:56:52 +01:00
.filter(key => CONFIG.TRANSCODING.ENABLED && CONFIG.TRANSCODING.RESOLUTIONS[key] === true)
.map(r => parseInt(r, 10))
}
function getRegisteredPlugins () {
return PluginManager.Instance.getRegisteredPlugins()
.map(p => ({
name: p.name,
version: p.version,
description: p.description,
clientScripts: p.clientScripts
}))
}
2017-05-15 22:22:03 +02:00
// ---------------------------------------------------------------------------
export {
configRouter,
getEnabledResolutions,
getRegisteredPlugins,
getRegisteredThemes
2017-05-15 22:22:03 +02:00
}
// ---------------------------------------------------------------------------
function customConfig (): CustomConfig {
return {
instance: {
name: CONFIG.INSTANCE.NAME,
2018-03-15 14:31:08 +01:00
shortDescription: CONFIG.INSTANCE.SHORT_DESCRIPTION,
description: CONFIG.INSTANCE.DESCRIPTION,
terms: CONFIG.INSTANCE.TERMS,
2019-08-23 15:23:27 +02:00
codeOfConduct: CONFIG.INSTANCE.CODE_OF_CONDUCT,
2019-09-03 09:49:04 +02:00
creationReason: CONFIG.INSTANCE.CREATION_REASON,
2019-08-23 15:23:27 +02:00
moderationInformation: CONFIG.INSTANCE.MODERATION_INFORMATION,
administrator: CONFIG.INSTANCE.ADMINISTRATOR,
maintenanceLifetime: CONFIG.INSTANCE.MAINTENANCE_LIFETIME,
businessModel: CONFIG.INSTANCE.BUSINESS_MODEL,
hardwareInformation: CONFIG.INSTANCE.HARDWARE_INFORMATION,
2019-08-23 15:23:27 +02:00
languages: CONFIG.INSTANCE.LANGUAGES,
categories: CONFIG.INSTANCE.CATEGORIES,
2019-02-20 15:36:43 +01:00
isNSFW: CONFIG.INSTANCE.IS_NSFW,
2018-03-01 13:57:29 +01:00
defaultClientRoute: CONFIG.INSTANCE.DEFAULT_CLIENT_ROUTE,
defaultNSFWPolicy: CONFIG.INSTANCE.DEFAULT_NSFW_POLICY,
customizations: {
css: CONFIG.INSTANCE.CUSTOMIZATIONS.CSS,
javascript: CONFIG.INSTANCE.CUSTOMIZATIONS.JAVASCRIPT
}
},
2019-07-09 11:45:19 +02:00
theme: {
default: CONFIG.THEME.DEFAULT
},
services: {
twitter: {
username: CONFIG.SERVICES.TWITTER.USERNAME,
whitelisted: CONFIG.SERVICES.TWITTER.WHITELISTED
}
},
cache: {
previews: {
size: CONFIG.CACHE.PREVIEWS.SIZE
2018-07-12 19:02:00 +02:00
},
captions: {
size: CONFIG.CACHE.VIDEO_CAPTIONS.SIZE
}
},
signup: {
enabled: CONFIG.SIGNUP.ENABLED,
limit: CONFIG.SIGNUP.LIMIT,
requiresEmailVerification: CONFIG.SIGNUP.REQUIRES_EMAIL_VERIFICATION
},
admin: {
email: CONFIG.ADMIN.EMAIL
},
2019-01-09 15:14:29 +01:00
contactForm: {
enabled: CONFIG.CONTACT_FORM.ENABLED
},
user: {
videoQuota: CONFIG.USER.VIDEO_QUOTA,
videoQuotaDaily: CONFIG.USER.VIDEO_QUOTA_DAILY
},
transcoding: {
enabled: CONFIG.TRANSCODING.ENABLED,
2018-12-11 14:52:50 +01:00
allowAdditionalExtensions: CONFIG.TRANSCODING.ALLOW_ADDITIONAL_EXTENSIONS,
2019-05-16 16:55:34 +02:00
allowAudioFiles: CONFIG.TRANSCODING.ALLOW_AUDIO_FILES,
threads: CONFIG.TRANSCODING.THREADS,
resolutions: {
2020-01-31 16:56:52 +01:00
'0p': CONFIG.TRANSCODING.RESOLUTIONS['0p'],
'240p': CONFIG.TRANSCODING.RESOLUTIONS['240p'],
'360p': CONFIG.TRANSCODING.RESOLUTIONS['360p'],
'480p': CONFIG.TRANSCODING.RESOLUTIONS['480p'],
'720p': CONFIG.TRANSCODING.RESOLUTIONS['720p'],
'1080p': CONFIG.TRANSCODING.RESOLUTIONS['1080p'],
'2160p': CONFIG.TRANSCODING.RESOLUTIONS['2160p']
2019-01-29 08:37:25 +01:00
},
webtorrent: {
enabled: CONFIG.TRANSCODING.WEBTORRENT.ENABLED
},
2019-01-29 08:37:25 +01:00
hls: {
enabled: CONFIG.TRANSCODING.HLS.ENABLED
}
2018-08-03 11:10:31 +02:00
},
import: {
videos: {
http: {
enabled: CONFIG.IMPORT.VIDEOS.HTTP.ENABLED
2018-08-07 10:07:53 +02:00
},
torrent: {
enabled: CONFIG.IMPORT.VIDEOS.TORRENT.ENABLED
2018-08-03 11:10:31 +02:00
}
}
},
autoBlacklist: {
videos: {
ofUsers: {
enabled: CONFIG.AUTO_BLACKLIST.VIDEOS.OF_USERS.ENABLED
}
}
2019-04-08 14:04:57 +02:00
},
followers: {
instance: {
enabled: CONFIG.FOLLOWERS.INSTANCE.ENABLED,
manualApproval: CONFIG.FOLLOWERS.INSTANCE.MANUAL_APPROVAL
2019-04-08 14:04:57 +02:00
}
},
followings: {
instance: {
autoFollowBack: {
enabled: CONFIG.FOLLOWINGS.INSTANCE.AUTO_FOLLOW_BACK.ENABLED
},
autoFollowIndex: {
enabled: CONFIG.FOLLOWINGS.INSTANCE.AUTO_FOLLOW_INDEX.ENABLED,
indexUrl: CONFIG.FOLLOWINGS.INSTANCE.AUTO_FOLLOW_INDEX.INDEX_URL
}
}
}
}
}
2019-01-09 15:14:29 +01:00
function convertCustomConfigBody (body: CustomConfig) {
function keyConverter (k: string) {
// Transcoding resolutions exception
if (/^\d{3,4}p$/.exec(k)) return k
2019-11-22 11:43:17 +01:00
if (k === '0p') return k
2019-01-09 15:14:29 +01:00
return snakeCase(k)
}
function valueConverter (v: any) {
2020-01-07 14:56:07 +01:00
if (validator.isNumeric(v + '')) return parseInt('' + v, 10)
2019-01-09 15:14:29 +01:00
return v
}
return objectConverter(body, keyConverter, valueConverter)
}