PeerTube/server/controllers/api/config.ts

354 lines
11 KiB
TypeScript
Raw Normal View History

2021-08-27 14:32:44 +02:00
import express from 'express'
2020-04-28 14:49:03 +02:00
import { remove, writeJSON } from 'fs-extra'
2019-01-29 08:37:25 +01:00
import { snakeCase } from 'lodash'
2020-04-28 14:49:03 +02:00
import validator from 'validator'
2021-07-16 14:27:30 +02:00
import { ServerConfigManager } from '@server/lib/server-config-manager'
2021-12-24 10:14:47 +01:00
import { About, CustomConfig, UserRight } from '@shared/models'
2018-09-19 17:02:16 +02:00
import { auditLoggerFactory, CustomConfigAuditView, getAuditIdFromRes } from '../../helpers/audit-logger'
2019-01-09 15:14:29 +01:00
import { objectConverter } from '../../helpers/core-utils'
2021-04-09 14:51:28 +02:00
import { CONFIG, reloadConfig } from '../../initializers/config'
2020-04-28 14:49:03 +02:00
import { ClientHtml } from '../../lib/client-html'
import { asyncMiddleware, authenticate, ensureUserHasRight, openapiOperationDoc } from '../../middlewares'
import { customConfigUpdateValidator, ensureConfigIsEditable } from '../../middlewares/validators/config'
2017-05-15 22:22:03 +02:00
const configRouter = express.Router()
const auditLogger = auditLoggerFactory('config')
2017-10-25 11:55:06 +02:00
configRouter.get('/',
openapiOperationDoc({ operationId: 'getConfig' }),
2017-10-25 11:55:06 +02:00
asyncMiddleware(getConfig)
)
2018-01-31 17:47:36 +01:00
configRouter.get('/about',
openapiOperationDoc({ operationId: 'getAbout' }),
getAbout
)
configRouter.get('/custom',
openapiOperationDoc({ operationId: 'getCustomConfig' }),
authenticate,
ensureUserHasRight(UserRight.MANAGE_CONFIGURATION),
2020-01-31 16:56:52 +01:00
getCustomConfig
)
2021-05-12 14:51:17 +02:00
configRouter.put('/custom',
openapiOperationDoc({ operationId: 'putCustomConfig' }),
authenticate,
ensureUserHasRight(UserRight.MANAGE_CONFIGURATION),
ensureConfigIsEditable,
2020-01-31 16:56:52 +01:00
customConfigUpdateValidator,
asyncMiddleware(updateCustomConfig)
)
2021-05-12 14:51:17 +02:00
configRouter.delete('/custom',
openapiOperationDoc({ operationId: 'delCustomConfig' }),
authenticate,
ensureUserHasRight(UserRight.MANAGE_CONFIGURATION),
ensureConfigIsEditable,
asyncMiddleware(deleteCustomConfig)
)
2017-05-15 22:22:03 +02:00
2018-11-23 11:06:10 +01:00
async function getConfig (req: express.Request, res: express.Response) {
const json = await ServerConfigManager.Instance.getServerConfig(req.ip)
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
}
}
2021-05-12 14:51:17 +02:00
return res.json(about)
2018-01-31 17:47:36 +01:00
}
2020-01-31 16:56:52 +01:00
function getCustomConfig (req: express.Request, res: express.Response) {
const data = customConfig()
2021-05-12 14:51:17 +02:00
return res.json(data)
}
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)
}
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)
}
2017-05-15 22:22:03 +02:00
// ---------------------------------------------------------------------------
export {
2021-04-09 14:51:28 +02:00
configRouter
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,
defaultNSFWPolicy: CONFIG.INSTANCE.DEFAULT_NSFW_POLICY,
defaultClientRoute: CONFIG.INSTANCE.DEFAULT_CLIENT_ROUTE,
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
}
},
client: {
videos: {
miniature: {
preferAuthorDisplayName: CONFIG.CLIENT.VIDEOS.MINIATURE.PREFER_AUTHOR_DISPLAY_NAME
}
},
menu: {
login: {
redirectOnSingleExternalAuth: CONFIG.CLIENT.MENU.LOGIN.REDIRECT_ON_SINGLE_EXTERNAL_AUTH
}
}
},
cache: {
previews: {
size: CONFIG.CACHE.PREVIEWS.SIZE
2018-07-12 19:02:00 +02:00
},
captions: {
size: CONFIG.CACHE.VIDEO_CAPTIONS.SIZE
},
torrents: {
size: CONFIG.CACHE.TORRENTS.SIZE
}
},
signup: {
enabled: CONFIG.SIGNUP.ENABLED,
limit: CONFIG.SIGNUP.LIMIT,
2023-01-19 09:27:16 +01:00
requiresApproval: CONFIG.SIGNUP.REQUIRES_APPROVAL,
requiresEmailVerification: CONFIG.SIGNUP.REQUIRES_EMAIL_VERIFICATION,
minimumAge: CONFIG.SIGNUP.MINIMUM_AGE
},
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
},
videoChannels: {
maxPerUser: CONFIG.VIDEO_CHANNELS.MAX_PER_USER
},
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,
concurrency: CONFIG.TRANSCODING.CONCURRENCY,
profile: CONFIG.TRANSCODING.PROFILE,
resolutions: {
2020-01-31 16:56:52 +01:00
'0p': CONFIG.TRANSCODING.RESOLUTIONS['0p'],
'144p': CONFIG.TRANSCODING.RESOLUTIONS['144p'],
2020-01-31 16:56:52 +01:00
'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'],
2020-01-31 16:56:52 +01:00
'2160p': CONFIG.TRANSCODING.RESOLUTIONS['2160p']
2019-01-29 08:37:25 +01:00
},
alwaysTranscodeOriginalResolution: CONFIG.TRANSCODING.ALWAYS_TRANSCODE_ORIGINAL_RESOLUTION,
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
},
live: {
enabled: CONFIG.LIVE.ENABLED,
2020-09-25 16:19:35 +02:00
allowReplay: CONFIG.LIVE.ALLOW_REPLAY,
2022-03-04 13:40:02 +01:00
latencySetting: {
enabled: CONFIG.LIVE.LATENCY_SETTING.ENABLED
},
2020-09-25 16:19:35 +02:00
maxDuration: CONFIG.LIVE.MAX_DURATION,
2020-10-28 15:24:40 +01:00
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: {
'144p': CONFIG.LIVE.TRANSCODING.RESOLUTIONS['144p'],
'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']
},
alwaysTranscodeOriginalResolution: CONFIG.LIVE.TRANSCODING.ALWAYS_TRANSCODE_ORIGINAL_RESOLUTION
}
},
2022-03-22 16:58:49 +01:00
videoStudio: {
enabled: CONFIG.VIDEO_STUDIO.ENABLED
2022-02-11 10:51:33 +01:00
},
2018-08-03 11:10:31 +02:00
import: {
videos: {
concurrency: CONFIG.IMPORT.VIDEOS.CONCURRENCY,
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
}
Channel sync (#5135) * Add external channel URL for channel update / creation (#754) * Disallow synchronisation if user has no video quota (#754) * More constraints serverside (#754) * Disable sync if server configuration does not allow HTTP import (#754) * Working version synchronizing videos with a job (#754) TODO: refactoring, too much code duplication * More logs and try/catch (#754) * Fix eslint error (#754) * WIP: support synchronization time change (#754) * New frontend #754 * WIP: Create sync front (#754) * Enhance UI, sync creation form (#754) * Warning message when HTTP upload is disallowed * More consistent names (#754) * Binding Front with API (#754) * Add a /me API (#754) * Improve list UI (#754) * Implement creation and deletion routes (#754) * Lint (#754) * Lint again (#754) * WIP: UI for triggering import existing videos (#754) * Implement jobs for syncing and importing channels * Don't sync videos before sync creation + avoid concurrency issue (#754) * Cleanup (#754) * Cleanup: OpenAPI + API rework (#754) * Remove dead code (#754) * Eslint (#754) * Revert the mess with whitespaces in constants.ts (#754) * Some fixes after rebase (#754) * Several fixes after PR remarks (#754) * Front + API: Rename video-channels-sync to video-channel-syncs (#754) * Allow enabling channel sync through UI (#754) * getChannelInfo (#754) * Minor fixes: openapi + model + sql (#754) * Simplified API validators (#754) * Rename MChannelSync to MChannelSyncChannel (#754) * Add command for VideoChannelSync (#754) * Use synchronization.enabled config (#754) * Check parameters test + some fixes (#754) * Fix conflict mistake (#754) * Restrict access to video channel sync list API (#754) * Start adding unit test for synchronization (#754) * Continue testing (#754) * Tests finished + convertion of job to scheduler (#754) * Add lastSyncAt field (#754) * Fix externalRemoteUrl sort + creation date not well formatted (#754) * Small fix (#754) * Factorize addYoutubeDLImport and buildVideo (#754) * Check duplicates on channel not on users (#754) * factorize thumbnail generation (#754) * Fetch error should return status 400 (#754) * Separate video-channel-import and video-channel-sync-latest (#754) * Bump DB migration version after rebase (#754) * Prettier states in UI table (#754) * Add DefaultScope in VideoChannelSyncModel (#754) * Fix audit logs (#754) * Ensure user can upload when importing channel + minor fixes (#754) * Mark synchronization as failed on exception + typos (#754) * Change REST API for importing videos into channel (#754) * Add option for fully synchronize a chnanel (#754) * Return a whole sync object on creation to avoid tricks in Front (#754) * Various remarks (#754) * Single quotes by default (#754) * Rename synchronization to video_channel_synchronization * Add check.latest_videos_count and max_per_user options (#754) * Better channel rendering in list #754 * Allow sorting with channel name and state (#754) * Add missing tests for channel imports (#754) * Prefer using a parent job for channel sync * Styling * Client styling Co-authored-by: Chocobozzz <me@florianbigard.com>
2022-08-10 09:53:39 +02:00
},
videoChannelSynchronization: {
enabled: CONFIG.IMPORT.VIDEO_CHANNEL_SYNCHRONIZATION.ENABLED,
maxPerUser: CONFIG.IMPORT.VIDEO_CHANNEL_SYNCHRONIZATION.MAX_PER_USER
2018-08-03 11:10:31 +02:00
}
},
2021-01-27 17:15:21 +01:00
trending: {
videos: {
algorithms: {
enabled: CONFIG.TRENDING.VIDEOS.ALGORITHMS.ENABLED,
default: CONFIG.TRENDING.VIDEOS.ALGORITHMS.DEFAULT
}
}
},
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
}
}
2020-05-28 11:15:38 +02:00
},
broadcastMessage: {
enabled: CONFIG.BROADCAST_MESSAGE.ENABLED,
message: CONFIG.BROADCAST_MESSAGE.MESSAGE,
level: CONFIG.BROADCAST_MESSAGE.LEVEL,
dismissable: CONFIG.BROADCAST_MESSAGE.DISMISSABLE
2020-05-29 16:16:24 +02:00
},
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
}
2020-06-10 10:58:44 +02:00
}
}
}
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)
}