+import { Hooks } from '@server/lib/plugins/hooks'
import * as express from 'express'
-import { omit } from 'lodash'
-import { ServerConfig, UserRight } from '../../../shared'
+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 { unlinkPromise, writeFilePromise } from '../../helpers/core-utils'
-import { isSignupAllowed } from '../../helpers/utils'
-import { CONFIG, CONSTRAINTS_FIELDS, reloadConfig } from '../../initializers'
+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 { 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 packageJSON = require('../../../../package.json')
const configRouter = express.Router()
+const auditLogger = auditLoggerFactory('config')
+
configRouter.get('/about', getAbout)
configRouter.get('/',
asyncMiddleware(getConfig)
configRouter.get('/custom',
authenticate,
ensureUserHasRight(UserRight.MANAGE_CONFIGURATION),
- asyncMiddleware(getCustomConfig)
+ getCustomConfig
)
configRouter.put('/custom',
authenticate,
ensureUserHasRight(UserRight.MANAGE_CONFIGURATION),
- asyncMiddleware(customConfigUpdateValidator),
+ customConfigUpdateValidator,
asyncMiddleware(updateCustomConfig)
)
configRouter.delete('/custom',
asyncMiddleware(deleteCustomConfig)
)
-async function getConfig (req: express.Request, res: express.Response, next: express.NextFunction) {
- const allowed = await isSignupAllowed()
+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)
- const enabledResolutions = Object.keys(CONFIG.TRANSCODING.RESOLUTIONS)
- .filter(key => CONFIG.TRANSCODING.RESOLUTIONS[key] === true)
- .map(r => parseInt(r, 10))
+ 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
}
},
- serverVersion: packageJSON.version,
+ 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
+ allowed,
+ allowedForCurrentIP,
+ requiresEmailVerification: CONFIG.SIGNUP.REQUIRES_EMAIL_VERIFICATION
},
transcoding: {
- enabledResolutions
+ hls: {
+ enabled: CONFIG.TRANSCODING.HLS.ENABLED
+ },
+ webtorrent: {
+ enabled: CONFIG.TRANSCODING.WEBTORRENT.ENABLED
+ },
+ enabledResolutions: getEnabledResolutions('vod')
+ },
+ live: {
+ enabled: CONFIG.LIVE.ENABLED,
+
+ transcoding: {
+ enabled: CONFIG.LIVE.TRANSCODING.ENABLED,
+ enabledResolutions: getEnabledResolutions('live')
+ }
+ },
+ 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: {
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
+ 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, next: express.NextFunction) {
+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
+ 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()
}
-async function getCustomConfig (req: express.Request, res: express.Response, next: express.NextFunction) {
+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, next: express.NextFunction) {
- await unlinkPromise(CONFIG.CUSTOM_FILE)
+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).end()
+ return res.json(data)
}
-async function updateCustomConfig (req: express.Request, res: express.Response, next: express.NextFunction) {
- const toUpdate: CustomConfig = req.body
-
- // Force number conversion
- toUpdate.cache.previews.size = parseInt('' + toUpdate.cache.previews.size, 10)
- toUpdate.signup.limit = parseInt('' + toUpdate.signup.limit, 10)
- toUpdate.user.videoQuota = parseInt('' + toUpdate.user.videoQuota, 10)
- toUpdate.transcoding.threads = parseInt('' + toUpdate.transcoding.threads, 10)
+async function updateCustomConfig (req: express.Request, res: express.Response) {
+ const oldCustomConfigAuditKeys = new CustomConfigAuditView(customConfig())
- // camelCase to snake_case key
- const toUpdateJSON = omit(toUpdate, 'user.videoQuota', 'instance.defaultClientRoute', 'instance.shortDescription')
- toUpdateJSON.user['video_quota'] = toUpdate.user.videoQuota
- toUpdateJSON.instance['default_client_route'] = toUpdate.instance.defaultClientRoute
- toUpdateJSON.instance['short_description'] = toUpdate.instance.shortDescription
- toUpdateJSON.instance['default_nsfw_policy'] = toUpdate.instance.defaultNSFWPolicy
+ // camelCase to snake_case key + Force number conversion
+ const toUpdateJSON = convertCustomConfigBody(req.body)
- await writeFilePromise(CONFIG.CUSTOM_FILE, JSON.stringify(toUpdateJSON, undefined, 2))
+ await writeJSON(CONFIG.CUSTOM_FILE, toUpdateJSON, { spaces: 2 })
reloadConfig()
+ ClientHtml.invalidCache()
const data = customConfig()
- return res.json(data).end()
+
+ 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 getEnabledResolutions (type: 'vod' | 'live') {
+ const transcoding = type === 'vod'
+ ? CONFIG.TRANSCODING
+ : CONFIG.LIVE.TRANSCODING
+
+ return Object.keys(transcoding.RESOLUTIONS)
+ .filter(key => transcoding.ENABLED && 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
+ }))
+}
+
+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
+ configRouter,
+ getEnabledResolutions,
+ getRegisteredPlugins,
+ getRegisteredThemes
}
// ---------------------------------------------------------------------------
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: {
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
+ 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
+ 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: {
- '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' ]
+ '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']
+ },
+ webtorrent: {
+ enabled: CONFIG.TRANSCODING.WEBTORRENT.ENABLED
+ },
+ hls: {
+ enabled: CONFIG.TRANSCODING.HLS.ENABLED
+ }
+ },
+ live: {
+ enabled: CONFIG.LIVE.ENABLED,
+ 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'],
+ '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)
+}
projects / github / Chocobozzz / PeerTube.git / blobdiff