123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359360361362363364365366367368369370371372373374375376377378379380381382383384385386387388389390391392393394395396397398399400401402403404405406407408409410411412413414415416417418419420421422423424425426427428429430431432433434435436437438439440441442443444445446447448449450451452453454455456457458459460461462463464465466467468469470471472473474475476477478479480481482483484485486487488489490491492493494495496497498499500501502503504505506507508509510511512513514515516517518 |
- import { Hooks } from '@server/lib/plugins/hooks'
- import * as express from 'express'
- import { remove, writeJSON } from 'fs-extra'
- import { snakeCase } from 'lodash'
- import validator from 'validator'
- import { RegisteredExternalAuthConfig, RegisteredIdAndPassAuthConfig, ServerConfig, UserRight } from '../../../shared'
- import { About } from '../../../shared/models/server/about.model'
- import { CustomConfig } from '../../../shared/models/server/custom-config.model'
- import { auditLoggerFactory, CustomConfigAuditView, getAuditIdFromRes } from '../../helpers/audit-logger'
- import { objectConverter } from '../../helpers/core-utils'
- import { isSignupAllowed, isSignupAllowedForCurrentIP } from '../../helpers/signup'
- import { getServerCommit } from '../../helpers/utils'
- import { getEnabledResolutions } from '../../lib/video-transcoding'
- import { CONFIG, isEmailEnabled, reloadConfig } from '../../initializers/config'
- import { CONSTRAINTS_FIELDS, DEFAULT_THEME_NAME, PEERTUBE_VERSION } from '../../initializers/constants'
- import { ClientHtml } from '../../lib/client-html'
- import { PluginManager } from '../../lib/plugins/plugin-manager'
- import { getThemeOrDefault } from '../../lib/plugins/theme-utils'
- import { asyncMiddleware, authenticate, ensureUserHasRight } from '../../middlewares'
- import { customConfigUpdateValidator } from '../../middlewares/validators/config'
- const configRouter = express.Router()
- const auditLogger = auditLoggerFactory('config')
- configRouter.get('/about', getAbout)
- configRouter.get('/',
- asyncMiddleware(getConfig)
- )
- configRouter.get('/custom',
- authenticate,
- ensureUserHasRight(UserRight.MANAGE_CONFIGURATION),
- getCustomConfig
- )
- configRouter.put('/custom',
- authenticate,
- ensureUserHasRight(UserRight.MANAGE_CONFIGURATION),
- customConfigUpdateValidator,
- asyncMiddleware(updateCustomConfig)
- )
- configRouter.delete('/custom',
- authenticate,
- ensureUserHasRight(UserRight.MANAGE_CONFIGURATION),
- asyncMiddleware(deleteCustomConfig)
- )
- let serverCommit: string
- async function getConfig (req: express.Request, res: express.Response) {
- const { allowed } = await Hooks.wrapPromiseFun(
- isSignupAllowed,
- {
- ip: req.ip
- },
- 'filter:api.user.signup.allowed.result'
- )
- const allowedForCurrentIP = isSignupAllowedForCurrentIP(req.ip)
- const defaultTheme = getThemeOrDefault(CONFIG.THEME.DEFAULT, DEFAULT_THEME_NAME)
- if (serverCommit === undefined) serverCommit = await getServerCommit()
- const json: ServerConfig = {
- instance: {
- name: CONFIG.INSTANCE.NAME,
- shortDescription: CONFIG.INSTANCE.SHORT_DESCRIPTION,
- defaultClientRoute: CONFIG.INSTANCE.DEFAULT_CLIENT_ROUTE,
- isNSFW: CONFIG.INSTANCE.IS_NSFW,
- defaultNSFWPolicy: CONFIG.INSTANCE.DEFAULT_NSFW_POLICY,
- customizations: {
- javascript: CONFIG.INSTANCE.CUSTOMIZATIONS.JAVASCRIPT,
- css: CONFIG.INSTANCE.CUSTOMIZATIONS.CSS
- }
- },
- search: {
- remoteUri: {
- users: CONFIG.SEARCH.REMOTE_URI.USERS,
- anonymous: CONFIG.SEARCH.REMOTE_URI.ANONYMOUS
- },
- searchIndex: {
- enabled: CONFIG.SEARCH.SEARCH_INDEX.ENABLED,
- url: CONFIG.SEARCH.SEARCH_INDEX.URL,
- disableLocalSearch: CONFIG.SEARCH.SEARCH_INDEX.DISABLE_LOCAL_SEARCH,
- isDefaultSearch: CONFIG.SEARCH.SEARCH_INDEX.IS_DEFAULT_SEARCH
- }
- },
- plugin: {
- registered: getRegisteredPlugins(),
- registeredExternalAuths: getExternalAuthsPlugins(),
- registeredIdAndPassAuths: getIdAndPassAuthPlugins()
- },
- theme: {
- registered: getRegisteredThemes(),
- default: defaultTheme
- },
- email: {
- enabled: isEmailEnabled()
- },
- contactForm: {
- enabled: CONFIG.CONTACT_FORM.ENABLED
- },
- serverVersion: PEERTUBE_VERSION,
- serverCommit,
- signup: {
- allowed,
- allowedForCurrentIP,
- requiresEmailVerification: CONFIG.SIGNUP.REQUIRES_EMAIL_VERIFICATION
- },
- transcoding: {
- hls: {
- enabled: CONFIG.TRANSCODING.HLS.ENABLED
- },
- webtorrent: {
- enabled: CONFIG.TRANSCODING.WEBTORRENT.ENABLED
- },
- enabledResolutions: getEnabledResolutions('vod')
- },
- live: {
- enabled: CONFIG.LIVE.ENABLED,
- allowReplay: CONFIG.LIVE.ALLOW_REPLAY,
- maxDuration: CONFIG.LIVE.MAX_DURATION,
- maxInstanceLives: CONFIG.LIVE.MAX_INSTANCE_LIVES,
- maxUserLives: CONFIG.LIVE.MAX_USER_LIVES,
- transcoding: {
- enabled: CONFIG.LIVE.TRANSCODING.ENABLED,
- enabledResolutions: getEnabledResolutions('live')
- },
- rtmp: {
- port: CONFIG.LIVE.RTMP.PORT
- }
- },
- import: {
- videos: {
- http: {
- enabled: CONFIG.IMPORT.VIDEOS.HTTP.ENABLED
- },
- torrent: {
- enabled: CONFIG.IMPORT.VIDEOS.TORRENT.ENABLED
- }
- }
- },
- autoBlacklist: {
- videos: {
- ofUsers: {
- enabled: CONFIG.AUTO_BLACKLIST.VIDEOS.OF_USERS.ENABLED
- }
- }
- },
- 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
- }
- },
- file: {
- extensions: CONSTRAINTS_FIELDS.VIDEOS.EXTNAME
- }
- },
- 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
- }
- },
- tracker: {
- enabled: CONFIG.TRACKER.ENABLED
- },
- followings: {
- instance: {
- autoFollowIndex: {
- indexUrl: CONFIG.FOLLOWINGS.INSTANCE.AUTO_FOLLOW_INDEX.INDEX_URL
- }
- }
- },
- broadcastMessage: {
- enabled: CONFIG.BROADCAST_MESSAGE.ENABLED,
- message: CONFIG.BROADCAST_MESSAGE.MESSAGE,
- level: CONFIG.BROADCAST_MESSAGE.LEVEL,
- dismissable: CONFIG.BROADCAST_MESSAGE.DISMISSABLE
- }
- }
- return res.json(json)
- }
- function getAbout (req: express.Request, res: express.Response) {
- const about: About = {
- instance: {
- name: CONFIG.INSTANCE.NAME,
- shortDescription: CONFIG.INSTANCE.SHORT_DESCRIPTION,
- description: CONFIG.INSTANCE.DESCRIPTION,
- terms: CONFIG.INSTANCE.TERMS,
- codeOfConduct: CONFIG.INSTANCE.CODE_OF_CONDUCT,
- hardwareInformation: CONFIG.INSTANCE.HARDWARE_INFORMATION,
- creationReason: CONFIG.INSTANCE.CREATION_REASON,
- 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
- }
- }
- return res.json(about).end()
- }
- function getCustomConfig (req: express.Request, res: express.Response) {
- const data = customConfig()
- return res.json(data).end()
- }
- async function deleteCustomConfig (req: express.Request, res: express.Response) {
- await remove(CONFIG.CUSTOM_FILE)
- auditLogger.delete(getAuditIdFromRes(res), new CustomConfigAuditView(customConfig()))
- reloadConfig()
- ClientHtml.invalidCache()
- const data = customConfig()
- return res.json(data)
- }
- async function updateCustomConfig (req: express.Request, res: express.Response) {
- const oldCustomConfigAuditKeys = new CustomConfigAuditView(customConfig())
- // camelCase to snake_case key + Force number conversion
- const toUpdateJSON = convertCustomConfigBody(req.body)
- await writeJSON(CONFIG.CUSTOM_FILE, toUpdateJSON, { spaces: 2 })
- reloadConfig()
- ClientHtml.invalidCache()
- const data = customConfig()
- auditLogger.update(
- getAuditIdFromRes(res),
- new CustomConfigAuditView(data),
- oldCustomConfigAuditKeys
- )
- return res.json(data)
- }
- function getRegisteredThemes () {
- return PluginManager.Instance.getRegisteredThemes()
- .map(t => ({
- name: t.name,
- version: t.version,
- description: t.description,
- css: t.css,
- clientScripts: t.clientScripts
- }))
- }
- function getRegisteredPlugins () {
- return PluginManager.Instance.getRegisteredPlugins()
- .map(p => ({
- name: p.name,
- version: p.version,
- description: p.description,
- clientScripts: p.clientScripts
- }))
- }
- function getIdAndPassAuthPlugins () {
- const result: RegisteredIdAndPassAuthConfig[] = []
- for (const p of PluginManager.Instance.getIdAndPassAuths()) {
- for (const auth of p.idAndPassAuths) {
- result.push({
- npmName: p.npmName,
- name: p.name,
- version: p.version,
- authName: auth.authName,
- weight: auth.getWeight()
- })
- }
- }
- return result
- }
- function getExternalAuthsPlugins () {
- const result: RegisteredExternalAuthConfig[] = []
- for (const p of PluginManager.Instance.getExternalAuths()) {
- for (const auth of p.externalAuths) {
- result.push({
- npmName: p.npmName,
- name: p.name,
- version: p.version,
- authName: auth.authName,
- authDisplayName: auth.authDisplayName()
- })
- }
- }
- return result
- }
- // ---------------------------------------------------------------------------
- export {
- configRouter,
- getRegisteredPlugins,
- getRegisteredThemes
- }
- // ---------------------------------------------------------------------------
- function customConfig (): CustomConfig {
- return {
- instance: {
- name: CONFIG.INSTANCE.NAME,
- shortDescription: CONFIG.INSTANCE.SHORT_DESCRIPTION,
- description: CONFIG.INSTANCE.DESCRIPTION,
- terms: CONFIG.INSTANCE.TERMS,
- codeOfConduct: CONFIG.INSTANCE.CODE_OF_CONDUCT,
- creationReason: CONFIG.INSTANCE.CREATION_REASON,
- moderationInformation: CONFIG.INSTANCE.MODERATION_INFORMATION,
- administrator: CONFIG.INSTANCE.ADMINISTRATOR,
- maintenanceLifetime: CONFIG.INSTANCE.MAINTENANCE_LIFETIME,
- businessModel: CONFIG.INSTANCE.BUSINESS_MODEL,
- hardwareInformation: CONFIG.INSTANCE.HARDWARE_INFORMATION,
- languages: CONFIG.INSTANCE.LANGUAGES,
- categories: CONFIG.INSTANCE.CATEGORIES,
- isNSFW: CONFIG.INSTANCE.IS_NSFW,
- defaultClientRoute: CONFIG.INSTANCE.DEFAULT_CLIENT_ROUTE,
- defaultNSFWPolicy: CONFIG.INSTANCE.DEFAULT_NSFW_POLICY,
- customizations: {
- css: CONFIG.INSTANCE.CUSTOMIZATIONS.CSS,
- javascript: CONFIG.INSTANCE.CUSTOMIZATIONS.JAVASCRIPT
- }
- },
- theme: {
- default: CONFIG.THEME.DEFAULT
- },
- services: {
- twitter: {
- username: CONFIG.SERVICES.TWITTER.USERNAME,
- whitelisted: CONFIG.SERVICES.TWITTER.WHITELISTED
- }
- },
- cache: {
- previews: {
- size: CONFIG.CACHE.PREVIEWS.SIZE
- },
- 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
- },
- contactForm: {
- enabled: CONFIG.CONTACT_FORM.ENABLED
- },
- user: {
- videoQuota: CONFIG.USER.VIDEO_QUOTA,
- videoQuotaDaily: CONFIG.USER.VIDEO_QUOTA_DAILY
- },
- transcoding: {
- enabled: CONFIG.TRANSCODING.ENABLED,
- allowAdditionalExtensions: CONFIG.TRANSCODING.ALLOW_ADDITIONAL_EXTENSIONS,
- allowAudioFiles: CONFIG.TRANSCODING.ALLOW_AUDIO_FILES,
- threads: CONFIG.TRANSCODING.THREADS,
- resolutions: {
- '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'],
- '1440p': CONFIG.TRANSCODING.RESOLUTIONS['1440p'],
- '2160p': CONFIG.TRANSCODING.RESOLUTIONS['2160p']
- },
- webtorrent: {
- enabled: CONFIG.TRANSCODING.WEBTORRENT.ENABLED
- },
- hls: {
- enabled: CONFIG.TRANSCODING.HLS.ENABLED
- }
- },
- live: {
- enabled: CONFIG.LIVE.ENABLED,
- allowReplay: CONFIG.LIVE.ALLOW_REPLAY,
- maxDuration: CONFIG.LIVE.MAX_DURATION,
- maxInstanceLives: CONFIG.LIVE.MAX_INSTANCE_LIVES,
- maxUserLives: CONFIG.LIVE.MAX_USER_LIVES,
- transcoding: {
- enabled: CONFIG.LIVE.TRANSCODING.ENABLED,
- threads: CONFIG.LIVE.TRANSCODING.THREADS,
- resolutions: {
- '240p': CONFIG.LIVE.TRANSCODING.RESOLUTIONS['240p'],
- '360p': CONFIG.LIVE.TRANSCODING.RESOLUTIONS['360p'],
- '480p': CONFIG.LIVE.TRANSCODING.RESOLUTIONS['480p'],
- '720p': CONFIG.LIVE.TRANSCODING.RESOLUTIONS['720p'],
- '1080p': CONFIG.LIVE.TRANSCODING.RESOLUTIONS['1080p'],
- '1440p': CONFIG.LIVE.TRANSCODING.RESOLUTIONS['1440p'],
- '2160p': CONFIG.LIVE.TRANSCODING.RESOLUTIONS['2160p']
- }
- }
- },
- import: {
- videos: {
- http: {
- enabled: CONFIG.IMPORT.VIDEOS.HTTP.ENABLED
- },
- torrent: {
- enabled: CONFIG.IMPORT.VIDEOS.TORRENT.ENABLED
- }
- }
- },
- autoBlacklist: {
- videos: {
- ofUsers: {
- enabled: CONFIG.AUTO_BLACKLIST.VIDEOS.OF_USERS.ENABLED
- }
- }
- },
- followers: {
- instance: {
- enabled: CONFIG.FOLLOWERS.INSTANCE.ENABLED,
- manualApproval: CONFIG.FOLLOWERS.INSTANCE.MANUAL_APPROVAL
- }
- },
- 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
- }
- }
- },
- broadcastMessage: {
- enabled: CONFIG.BROADCAST_MESSAGE.ENABLED,
- message: CONFIG.BROADCAST_MESSAGE.MESSAGE,
- level: CONFIG.BROADCAST_MESSAGE.LEVEL,
- dismissable: CONFIG.BROADCAST_MESSAGE.DISMISSABLE
- },
- search: {
- remoteUri: {
- users: CONFIG.SEARCH.REMOTE_URI.USERS,
- anonymous: CONFIG.SEARCH.REMOTE_URI.ANONYMOUS
- },
- searchIndex: {
- enabled: CONFIG.SEARCH.SEARCH_INDEX.ENABLED,
- url: CONFIG.SEARCH.SEARCH_INDEX.URL,
- disableLocalSearch: CONFIG.SEARCH.SEARCH_INDEX.DISABLE_LOCAL_SEARCH,
- isDefaultSearch: CONFIG.SEARCH.SEARCH_INDEX.IS_DEFAULT_SEARCH
- }
- }
- }
- }
- function convertCustomConfigBody (body: CustomConfig) {
- function keyConverter (k: string) {
- // Transcoding resolutions exception
- if (/^\d{3,4}p$/.exec(k)) return k
- if (k === '0p') return k
- return snakeCase(k)
- }
- function valueConverter (v: any) {
- if (validator.isNumeric(v + '')) return parseInt('' + v, 10)
- return v
- }
- return objectConverter(body, keyConverter, valueConverter)
- }
|