X-Git-Url: https://git.immae.eu/?a=blobdiff_plain;f=server%2Fcontrollers%2Fapi%2Fconfig.ts;h=7fda06a87329f565fcb06f8e5a5b3ad286af0f22;hb=1896bca09e088b0da9d5e845407ecebae330618c;hp=8a00f9835a319c834fe2419206c9c5d451f641dc;hpb=5c7d650827cc471a03e7fa18362bcbcbe5d30838;p=github%2FChocobozzz%2FPeerTube.git diff --git a/server/controllers/api/config.ts b/server/controllers/api/config.ts index 8a00f9835..7fda06a87 100644 --- a/server/controllers/api/config.ts +++ b/server/controllers/api/config.ts @@ -1,23 +1,24 @@ +import { Hooks } from '@server/lib/plugins/hooks' import * as express from 'express' +import { remove, writeJSON } from 'fs-extra' import { snakeCase } from 'lodash' -import { ServerConfig, UserRight } from '../../../shared' +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 { asyncMiddleware, authenticate, ensureUserHasRight } from '../../middlewares' -import { customConfigUpdateValidator } from '../../middlewares/validators/config' import { ClientHtml } from '../../lib/client-html' -import { auditLoggerFactory, CustomConfigAuditView, getAuditIdFromRes } from '../../helpers/audit-logger' -import { remove, writeJSON } from 'fs-extra' -import { getServerCommit } from '../../helpers/utils' -import { Emailer } from '../../lib/emailer' -import { isNumeric } from 'validator' -import { objectConverter } from '../../helpers/core-utils' -import { CONFIG, reloadConfig } from '../../initializers/config' import { PluginManager } from '../../lib/plugins/plugin-manager' import { getThemeOrDefault } from '../../lib/plugins/theme-utils' -import { Hooks } from '@server/lib/plugins/hooks' +import { asyncMiddleware, authenticate, ensureUserHasRight } from '../../middlewares' +import { customConfigUpdateValidator } from '../../middlewares/validators/config' +import { VideoTranscodingProfilesManager } from '@server/lib/video-transcoding-profiles' const configRouter = express.Router() @@ -31,12 +32,12 @@ configRouter.get('/', 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', @@ -50,7 +51,9 @@ 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' ) @@ -63,23 +66,37 @@ async function getConfig (req: express.Request, res: express.Response) { 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, + defaultClientRoute: CONFIG.INSTANCE.DEFAULT_CLIENT_ROUTE, 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() + registered: getRegisteredPlugins(), + registeredExternalAuths: getExternalAuthsPlugins(), + registeredIdAndPassAuths: getIdAndPassAuthPlugins() }, theme: { registered: getRegisteredThemes(), default: defaultTheme }, email: { - enabled: Emailer.isEnabled() + enabled: isEmailEnabled() }, contactForm: { enabled: CONFIG.CONTACT_FORM.ENABLED @@ -98,7 +115,28 @@ async function getConfig (req: express.Request, res: express.Response) { webtorrent: { enabled: CONFIG.TRANSCODING.WEBTORRENT.ENABLED }, - enabledResolutions: getEnabledResolutions() + enabledResolutions: getEnabledResolutions('vod'), + profile: CONFIG.TRANSCODING.PROFILE, + availableProfiles: VideoTranscodingProfilesManager.Instance.getAvailableProfiles('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'), + profile: CONFIG.LIVE.TRANSCODING.PROFILE, + availableProfiles: VideoTranscodingProfilesManager.Instance.getAvailableProfiles('live') + }, + + rtmp: { + port: CONFIG.LIVE.RTMP.PORT + } }, import: { videos: { @@ -150,11 +188,30 @@ async function getConfig (req: express.Request, res: express.Response) { }, trending: { videos: { - intervalDays: CONFIG.TRENDING.VIDEOS.INTERVAL_DAYS + intervalDays: CONFIG.TRENDING.VIDEOS.INTERVAL_DAYS, + algorithms: { + enabled: CONFIG.TRENDING.VIDEOS.ALGORITHMS.ENABLED, + default: CONFIG.TRENDING.VIDEOS.ALGORITHMS.DEFAULT + } } }, 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 } } @@ -186,7 +243,7 @@ function getAbout (req: express.Request, res: express.Response) { return res.json(about).end() } -async function getCustomConfig (req: express.Request, res: express.Response) { +function getCustomConfig (req: express.Request, res: express.Response) { const data = customConfig() return res.json(data).end() @@ -202,7 +259,7 @@ async function deleteCustomConfig (req: express.Request, res: express.Response) const data = customConfig() - return res.json(data).end() + return res.json(data) } async function updateCustomConfig (req: express.Request, res: express.Response) { @@ -224,13 +281,72 @@ async function updateCustomConfig (req: express.Request, res: express.Response) oldCustomConfigAuditKeys ) - return res.json(data).end() + 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 + configRouter, + getRegisteredPlugins, + getRegisteredThemes } // --------------------------------------------------------------------------- @@ -255,8 +371,10 @@ function customConfig (): CustomConfig { categories: CONFIG.INSTANCE.CATEGORIES, isNSFW: CONFIG.INSTANCE.IS_NSFW, - defaultClientRoute: CONFIG.INSTANCE.DEFAULT_CLIENT_ROUTE, defaultNSFWPolicy: CONFIG.INSTANCE.DEFAULT_NSFW_POLICY, + + defaultClientRoute: CONFIG.INSTANCE.DEFAULT_CLIENT_ROUTE, + customizations: { css: CONFIG.INSTANCE.CUSTOMIZATIONS.CSS, javascript: CONFIG.INSTANCE.CUSTOMIZATIONS.JAVASCRIPT @@ -299,14 +417,16 @@ function customConfig (): CustomConfig { allowAdditionalExtensions: CONFIG.TRANSCODING.ALLOW_ADDITIONAL_EXTENSIONS, allowAudioFiles: CONFIG.TRANSCODING.ALLOW_AUDIO_FILES, threads: CONFIG.TRANSCODING.THREADS, + profile: CONFIG.TRANSCODING.PROFILE, 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' ], - '2160p': CONFIG.TRANSCODING.RESOLUTIONS[ '2160p' ] + '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 @@ -315,6 +435,27 @@ function customConfig (): CustomConfig { 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, + profile: CONFIG.LIVE.TRANSCODING.PROFILE, + 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: { @@ -325,6 +466,14 @@ function customConfig (): CustomConfig { } } }, + trending: { + videos: { + algorithms: { + enabled: CONFIG.TRENDING.VIDEOS.ALGORITHMS.ENABLED, + default: CONFIG.TRENDING.VIDEOS.ALGORITHMS.DEFAULT + } + } + }, autoBlacklist: { videos: { ofUsers: { @@ -349,6 +498,24 @@ function customConfig (): CustomConfig { 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 + } } } } @@ -357,43 +524,16 @@ function convertCustomConfigBody (body: CustomConfig) { function keyConverter (k: string) { // Transcoding resolutions exception if (/^\d{3,4}p$/.exec(k)) return k - if (/^0p$/.exec(k)) return k + if (k === '0p') return k return snakeCase(k) } function valueConverter (v: any) { - if (isNumeric(v + '')) return parseInt('' + v, 10) + if (validator.isNumeric(v + '')) return parseInt('' + v, 10) return v } return objectConverter(body, keyConverter, valueConverter) } - -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) - .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 - })) -}