server/controllers/api/config.ts

   1 import { Hooks } from '@server/lib/plugins/hooks'
   2 import * as express from 'express'
   3 import { remove, writeJSON } from 'fs-extra'
   4 import { snakeCase } from 'lodash'
   5 import validator from 'validator'
   6 import { RegisteredExternalAuthConfig, RegisteredIdAndPassAuthConfig, ServerConfig, UserRight } from '../../../shared'
   7 import { About } from '../../../shared/models/server/about.model'
   8 import { CustomConfig } from '../../../shared/models/server/custom-config.model'
   9 import { auditLoggerFactory, CustomConfigAuditView, getAuditIdFromRes } from '../../helpers/audit-logger'
  10 import { objectConverter } from '../../helpers/core-utils'
  11 import { isSignupAllowed, isSignupAllowedForCurrentIP } from '../../helpers/signup'
  12 import { getServerCommit } from '../../helpers/utils'
  13 import { CONFIG, isEmailEnabled, reloadConfig } from '../../initializers/config'
  14 import { CONSTRAINTS_FIELDS, DEFAULT_THEME_NAME, PEERTUBE_VERSION } from '../../initializers/constants'
  15 import { ClientHtml } from '../../lib/client-html'
  16 import { PluginManager } from '../../lib/plugins/plugin-manager'
  17 import { getThemeOrDefault } from '../../lib/plugins/theme-utils'
  18 import { asyncMiddleware, authenticate, ensureUserHasRight } from '../../middlewares'
  19 import { customConfigUpdateValidator } from '../../middlewares/validators/config'
  20
  21 const configRouter = express.Router()
  22
  23 const auditLogger = auditLoggerFactory('config')
  24
  25 configRouter.get('/about', getAbout)
  26 configRouter.get('/',
  27   asyncMiddleware(getConfig)
  28 )
  29
  30 configRouter.get('/custom',
  31   authenticate,
  32   ensureUserHasRight(UserRight.MANAGE_CONFIGURATION),
  33   getCustomConfig
  34 )
  35 configRouter.put('/custom',
  36   authenticate,
  37   ensureUserHasRight(UserRight.MANAGE_CONFIGURATION),
  38   customConfigUpdateValidator,
  39   asyncMiddleware(updateCustomConfig)
  40 )
  41 configRouter.delete('/custom',
  42   authenticate,
  43   ensureUserHasRight(UserRight.MANAGE_CONFIGURATION),
  44   asyncMiddleware(deleteCustomConfig)
  45 )
  46
  47 let serverCommit: string
  48
  49 async function getConfig (req: express.Request, res: express.Response) {
  50   const { allowed } = await Hooks.wrapPromiseFun(
  51     isSignupAllowed,
  52     {
  53       ip: req.ip
  54     },
  55     'filter:api.user.signup.allowed.result'
  56   )
  57
  58   const allowedForCurrentIP = isSignupAllowedForCurrentIP(req.ip)
  59   const defaultTheme = getThemeOrDefault(CONFIG.THEME.DEFAULT, DEFAULT_THEME_NAME)
  60
  61   if (serverCommit === undefined) serverCommit = await getServerCommit()
  62
  63   const json: ServerConfig = {
  64     instance: {
  65       name: CONFIG.INSTANCE.NAME,
  66       shortDescription: CONFIG.INSTANCE.SHORT_DESCRIPTION,
  67       defaultClientRoute: CONFIG.INSTANCE.DEFAULT_CLIENT_ROUTE,
  68       isNSFW: CONFIG.INSTANCE.IS_NSFW,
  69       defaultNSFWPolicy: CONFIG.INSTANCE.DEFAULT_NSFW_POLICY,
  70       customizations: {
  71         javascript: CONFIG.INSTANCE.CUSTOMIZATIONS.JAVASCRIPT,
  72         css: CONFIG.INSTANCE.CUSTOMIZATIONS.CSS
  73       }
  74     },
  75     search: {
  76       remoteUri: {
  77         users: CONFIG.SEARCH.REMOTE_URI.USERS,
  78         anonymous: CONFIG.SEARCH.REMOTE_URI.ANONYMOUS
  79       },
  80       searchIndex: {
  81         enabled: CONFIG.SEARCH.SEARCH_INDEX.ENABLED,
  82         url: CONFIG.SEARCH.SEARCH_INDEX.URL,
  83         disableLocalSearch: CONFIG.SEARCH.SEARCH_INDEX.DISABLE_LOCAL_SEARCH,
  84         isDefaultSearch: CONFIG.SEARCH.SEARCH_INDEX.IS_DEFAULT_SEARCH
  85       }
  86     },
  87     plugin: {
  88       registered: getRegisteredPlugins(),
  89       registeredExternalAuths: getExternalAuthsPlugins(),
  90       registeredIdAndPassAuths: getIdAndPassAuthPlugins()
  91     },
  92     theme: {
  93       registered: getRegisteredThemes(),
  94       default: defaultTheme
  95     },
  96     email: {
  97       enabled: isEmailEnabled()
  98     },
  99     contactForm: {
 100       enabled: CONFIG.CONTACT_FORM.ENABLED
 101     },
 102     serverVersion: PEERTUBE_VERSION,
 103     serverCommit,
 104     signup: {
 105       allowed,
 106       allowedForCurrentIP,
 107       requiresEmailVerification: CONFIG.SIGNUP.REQUIRES_EMAIL_VERIFICATION
 108     },
 109     transcoding: {
 110       hls: {
 111         enabled: CONFIG.TRANSCODING.HLS.ENABLED
 112       },
 113       webtorrent: {
 114         enabled: CONFIG.TRANSCODING.WEBTORRENT.ENABLED
 115       },
 116       enabledResolutions: getEnabledResolutions('vod')
 117     },
 118     live: {
 119       enabled: CONFIG.LIVE.ENABLED,
 120
 121       allowReplay: CONFIG.LIVE.ALLOW_REPLAY,
 122       maxDuration: CONFIG.LIVE.MAX_DURATION,
 123       maxInstanceLives: CONFIG.LIVE.MAX_INSTANCE_LIVES,
 124       maxUserLives: CONFIG.LIVE.MAX_USER_LIVES,
 125
 126       transcoding: {
 127         enabled: CONFIG.LIVE.TRANSCODING.ENABLED,
 128         enabledResolutions: getEnabledResolutions('live')
 129       }
 130     },
 131     import: {
 132       videos: {
 133         http: {
 134           enabled: CONFIG.IMPORT.VIDEOS.HTTP.ENABLED
 135         },
 136         torrent: {
 137           enabled: CONFIG.IMPORT.VIDEOS.TORRENT.ENABLED
 138         }
 139       }
 140     },
 141     autoBlacklist: {
 142       videos: {
 143         ofUsers: {
 144           enabled: CONFIG.AUTO_BLACKLIST.VIDEOS.OF_USERS.ENABLED
 145         }
 146       }
 147     },
 148     avatar: {
 149       file: {
 150         size: {
 151           max: CONSTRAINTS_FIELDS.ACTORS.AVATAR.FILE_SIZE.max
 152         },
 153         extensions: CONSTRAINTS_FIELDS.ACTORS.AVATAR.EXTNAME
 154       }
 155     },
 156     video: {
 157       image: {
 158         extensions: CONSTRAINTS_FIELDS.VIDEOS.IMAGE.EXTNAME,
 159         size: {
 160           max: CONSTRAINTS_FIELDS.VIDEOS.IMAGE.FILE_SIZE.max
 161         }
 162       },
 163       file: {
 164         extensions: CONSTRAINTS_FIELDS.VIDEOS.EXTNAME
 165       }
 166     },
 167     videoCaption: {
 168       file: {
 169         size: {
 170           max: CONSTRAINTS_FIELDS.VIDEO_CAPTIONS.CAPTION_FILE.FILE_SIZE.max
 171         },
 172         extensions: CONSTRAINTS_FIELDS.VIDEO_CAPTIONS.CAPTION_FILE.EXTNAME
 173       }
 174     },
 175     user: {
 176       videoQuota: CONFIG.USER.VIDEO_QUOTA,
 177       videoQuotaDaily: CONFIG.USER.VIDEO_QUOTA_DAILY
 178     },
 179     trending: {
 180       videos: {
 181         intervalDays: CONFIG.TRENDING.VIDEOS.INTERVAL_DAYS
 182       }
 183     },
 184     tracker: {
 185       enabled: CONFIG.TRACKER.ENABLED
 186     },
 187
 188     followings: {
 189       instance: {
 190         autoFollowIndex: {
 191           indexUrl: CONFIG.FOLLOWINGS.INSTANCE.AUTO_FOLLOW_INDEX.INDEX_URL
 192         }
 193       }
 194     },
 195
 196     broadcastMessage: {
 197       enabled: CONFIG.BROADCAST_MESSAGE.ENABLED,
 198       message: CONFIG.BROADCAST_MESSAGE.MESSAGE,
 199       level: CONFIG.BROADCAST_MESSAGE.LEVEL,
 200       dismissable: CONFIG.BROADCAST_MESSAGE.DISMISSABLE
 201     }
 202   }
 203
 204   return res.json(json)
 205 }
 206
 207 function getAbout (req: express.Request, res: express.Response) {
 208   const about: About = {
 209     instance: {
 210       name: CONFIG.INSTANCE.NAME,
 211       shortDescription: CONFIG.INSTANCE.SHORT_DESCRIPTION,
 212       description: CONFIG.INSTANCE.DESCRIPTION,
 213       terms: CONFIG.INSTANCE.TERMS,
 214       codeOfConduct: CONFIG.INSTANCE.CODE_OF_CONDUCT,
 215
 216       hardwareInformation: CONFIG.INSTANCE.HARDWARE_INFORMATION,
 217
 218       creationReason: CONFIG.INSTANCE.CREATION_REASON,
 219       moderationInformation: CONFIG.INSTANCE.MODERATION_INFORMATION,
 220       administrator: CONFIG.INSTANCE.ADMINISTRATOR,
 221       maintenanceLifetime: CONFIG.INSTANCE.MAINTENANCE_LIFETIME,
 222       businessModel: CONFIG.INSTANCE.BUSINESS_MODEL,
 223
 224       languages: CONFIG.INSTANCE.LANGUAGES,
 225       categories: CONFIG.INSTANCE.CATEGORIES
 226     }
 227   }
 228
 229   return res.json(about).end()
 230 }
 231
 232 function getCustomConfig (req: express.Request, res: express.Response) {
 233   const data = customConfig()
 234
 235   return res.json(data).end()
 236 }
 237
 238 async function deleteCustomConfig (req: express.Request, res: express.Response) {
 239   await remove(CONFIG.CUSTOM_FILE)
 240
 241   auditLogger.delete(getAuditIdFromRes(res), new CustomConfigAuditView(customConfig()))
 242
 243   reloadConfig()
 244   ClientHtml.invalidCache()
 245
 246   const data = customConfig()
 247
 248   return res.json(data)
 249 }
 250
 251 async function updateCustomConfig (req: express.Request, res: express.Response) {
 252   const oldCustomConfigAuditKeys = new CustomConfigAuditView(customConfig())
 253
 254   // camelCase to snake_case key + Force number conversion
 255   const toUpdateJSON = convertCustomConfigBody(req.body)
 256
 257   await writeJSON(CONFIG.CUSTOM_FILE, toUpdateJSON, { spaces: 2 })
 258
 259   reloadConfig()
 260   ClientHtml.invalidCache()
 261
 262   const data = customConfig()
 263
 264   auditLogger.update(
 265     getAuditIdFromRes(res),
 266     new CustomConfigAuditView(data),
 267     oldCustomConfigAuditKeys
 268   )
 269
 270   return res.json(data)
 271 }
 272
 273 function getRegisteredThemes () {
 274   return PluginManager.Instance.getRegisteredThemes()
 275                       .map(t => ({
 276                         name: t.name,
 277                         version: t.version,
 278                         description: t.description,
 279                         css: t.css,
 280                         clientScripts: t.clientScripts
 281                       }))
 282 }
 283
 284 function getEnabledResolutions (type: 'vod' | 'live') {
 285   const transcoding = type === 'vod'
 286     ? CONFIG.TRANSCODING
 287     : CONFIG.LIVE.TRANSCODING
 288
 289   return Object.keys(transcoding.RESOLUTIONS)
 290                .filter(key => transcoding.ENABLED && transcoding.RESOLUTIONS[key] === true)
 291                .map(r => parseInt(r, 10))
 292 }
 293
 294 function getRegisteredPlugins () {
 295   return PluginManager.Instance.getRegisteredPlugins()
 296                       .map(p => ({
 297                         name: p.name,
 298                         version: p.version,
 299                         description: p.description,
 300                         clientScripts: p.clientScripts
 301                       }))
 302 }
 303
 304 function getIdAndPassAuthPlugins () {
 305   const result: RegisteredIdAndPassAuthConfig[] = []
 306
 307   for (const p of PluginManager.Instance.getIdAndPassAuths()) {
 308     for (const auth of p.idAndPassAuths) {
 309       result.push({
 310         npmName: p.npmName,
 311         name: p.name,
 312         version: p.version,
 313         authName: auth.authName,
 314         weight: auth.getWeight()
 315       })
 316     }
 317   }
 318
 319   return result
 320 }
 321
 322 function getExternalAuthsPlugins () {
 323   const result: RegisteredExternalAuthConfig[] = []
 324
 325   for (const p of PluginManager.Instance.getExternalAuths()) {
 326     for (const auth of p.externalAuths) {
 327       result.push({
 328         npmName: p.npmName,
 329         name: p.name,
 330         version: p.version,
 331         authName: auth.authName,
 332         authDisplayName: auth.authDisplayName()
 333       })
 334     }
 335   }
 336
 337   return result
 338 }
 339
 340 // ---------------------------------------------------------------------------
 341
 342 export {
 343   configRouter,
 344   getEnabledResolutions,
 345   getRegisteredPlugins,
 346   getRegisteredThemes
 347 }
 348
 349 // ---------------------------------------------------------------------------
 350
 351 function customConfig (): CustomConfig {
 352   return {
 353     instance: {
 354       name: CONFIG.INSTANCE.NAME,
 355       shortDescription: CONFIG.INSTANCE.SHORT_DESCRIPTION,
 356       description: CONFIG.INSTANCE.DESCRIPTION,
 357       terms: CONFIG.INSTANCE.TERMS,
 358       codeOfConduct: CONFIG.INSTANCE.CODE_OF_CONDUCT,
 359
 360       creationReason: CONFIG.INSTANCE.CREATION_REASON,
 361       moderationInformation: CONFIG.INSTANCE.MODERATION_INFORMATION,
 362       administrator: CONFIG.INSTANCE.ADMINISTRATOR,
 363       maintenanceLifetime: CONFIG.INSTANCE.MAINTENANCE_LIFETIME,
 364       businessModel: CONFIG.INSTANCE.BUSINESS_MODEL,
 365       hardwareInformation: CONFIG.INSTANCE.HARDWARE_INFORMATION,
 366
 367       languages: CONFIG.INSTANCE.LANGUAGES,
 368       categories: CONFIG.INSTANCE.CATEGORIES,
 369
 370       isNSFW: CONFIG.INSTANCE.IS_NSFW,
 371       defaultClientRoute: CONFIG.INSTANCE.DEFAULT_CLIENT_ROUTE,
 372       defaultNSFWPolicy: CONFIG.INSTANCE.DEFAULT_NSFW_POLICY,
 373       customizations: {
 374         css: CONFIG.INSTANCE.CUSTOMIZATIONS.CSS,
 375         javascript: CONFIG.INSTANCE.CUSTOMIZATIONS.JAVASCRIPT
 376       }
 377     },
 378     theme: {
 379       default: CONFIG.THEME.DEFAULT
 380     },
 381     services: {
 382       twitter: {
 383         username: CONFIG.SERVICES.TWITTER.USERNAME,
 384         whitelisted: CONFIG.SERVICES.TWITTER.WHITELISTED
 385       }
 386     },
 387     cache: {
 388       previews: {
 389         size: CONFIG.CACHE.PREVIEWS.SIZE
 390       },
 391       captions: {
 392         size: CONFIG.CACHE.VIDEO_CAPTIONS.SIZE
 393       }
 394     },
 395     signup: {
 396       enabled: CONFIG.SIGNUP.ENABLED,
 397       limit: CONFIG.SIGNUP.LIMIT,
 398       requiresEmailVerification: CONFIG.SIGNUP.REQUIRES_EMAIL_VERIFICATION
 399     },
 400     admin: {
 401       email: CONFIG.ADMIN.EMAIL
 402     },
 403     contactForm: {
 404       enabled: CONFIG.CONTACT_FORM.ENABLED
 405     },
 406     user: {
 407       videoQuota: CONFIG.USER.VIDEO_QUOTA,
 408       videoQuotaDaily: CONFIG.USER.VIDEO_QUOTA_DAILY
 409     },
 410     transcoding: {
 411       enabled: CONFIG.TRANSCODING.ENABLED,
 412       allowAdditionalExtensions: CONFIG.TRANSCODING.ALLOW_ADDITIONAL_EXTENSIONS,
 413       allowAudioFiles: CONFIG.TRANSCODING.ALLOW_AUDIO_FILES,
 414       threads: CONFIG.TRANSCODING.THREADS,
 415       resolutions: {
 416         '0p': CONFIG.TRANSCODING.RESOLUTIONS['0p'],
 417         '240p': CONFIG.TRANSCODING.RESOLUTIONS['240p'],
 418         '360p': CONFIG.TRANSCODING.RESOLUTIONS['360p'],
 419         '480p': CONFIG.TRANSCODING.RESOLUTIONS['480p'],
 420         '720p': CONFIG.TRANSCODING.RESOLUTIONS['720p'],
 421         '1080p': CONFIG.TRANSCODING.RESOLUTIONS['1080p'],
 422         '2160p': CONFIG.TRANSCODING.RESOLUTIONS['2160p']
 423       },
 424       webtorrent: {
 425         enabled: CONFIG.TRANSCODING.WEBTORRENT.ENABLED
 426       },
 427       hls: {
 428         enabled: CONFIG.TRANSCODING.HLS.ENABLED
 429       }
 430     },
 431     live: {
 432       enabled: CONFIG.LIVE.ENABLED,
 433       allowReplay: CONFIG.LIVE.ALLOW_REPLAY,
 434       maxDuration: CONFIG.LIVE.MAX_DURATION,
 435       maxInstanceLives: CONFIG.LIVE.MAX_INSTANCE_LIVES,
 436       maxUserLives: CONFIG.LIVE.MAX_USER_LIVES,
 437       transcoding: {
 438         enabled: CONFIG.LIVE.TRANSCODING.ENABLED,
 439         threads: CONFIG.LIVE.TRANSCODING.THREADS,
 440         resolutions: {
 441           '240p': CONFIG.LIVE.TRANSCODING.RESOLUTIONS['240p'],
 442           '360p': CONFIG.LIVE.TRANSCODING.RESOLUTIONS['360p'],
 443           '480p': CONFIG.LIVE.TRANSCODING.RESOLUTIONS['480p'],
 444           '720p': CONFIG.LIVE.TRANSCODING.RESOLUTIONS['720p'],
 445           '1080p': CONFIG.LIVE.TRANSCODING.RESOLUTIONS['1080p'],
 446           '2160p': CONFIG.LIVE.TRANSCODING.RESOLUTIONS['2160p']
 447         }
 448       }
 449     },
 450     import: {
 451       videos: {
 452         http: {
 453           enabled: CONFIG.IMPORT.VIDEOS.HTTP.ENABLED
 454         },
 455         torrent: {
 456           enabled: CONFIG.IMPORT.VIDEOS.TORRENT.ENABLED
 457         }
 458       }
 459     },
 460     autoBlacklist: {
 461       videos: {
 462         ofUsers: {
 463           enabled: CONFIG.AUTO_BLACKLIST.VIDEOS.OF_USERS.ENABLED
 464         }
 465       }
 466     },
 467     followers: {
 468       instance: {
 469         enabled: CONFIG.FOLLOWERS.INSTANCE.ENABLED,
 470         manualApproval: CONFIG.FOLLOWERS.INSTANCE.MANUAL_APPROVAL
 471       }
 472     },
 473     followings: {
 474       instance: {
 475         autoFollowBack: {
 476           enabled: CONFIG.FOLLOWINGS.INSTANCE.AUTO_FOLLOW_BACK.ENABLED
 477         },
 478
 479         autoFollowIndex: {
 480           enabled: CONFIG.FOLLOWINGS.INSTANCE.AUTO_FOLLOW_INDEX.ENABLED,
 481           indexUrl: CONFIG.FOLLOWINGS.INSTANCE.AUTO_FOLLOW_INDEX.INDEX_URL
 482         }
 483       }
 484     },
 485     broadcastMessage: {
 486       enabled: CONFIG.BROADCAST_MESSAGE.ENABLED,
 487       message: CONFIG.BROADCAST_MESSAGE.MESSAGE,
 488       level: CONFIG.BROADCAST_MESSAGE.LEVEL,
 489       dismissable: CONFIG.BROADCAST_MESSAGE.DISMISSABLE
 490     },
 491     search: {
 492       remoteUri: {
 493         users: CONFIG.SEARCH.REMOTE_URI.USERS,
 494         anonymous: CONFIG.SEARCH.REMOTE_URI.ANONYMOUS
 495       },
 496       searchIndex: {
 497         enabled: CONFIG.SEARCH.SEARCH_INDEX.ENABLED,
 498         url: CONFIG.SEARCH.SEARCH_INDEX.URL,
 499         disableLocalSearch: CONFIG.SEARCH.SEARCH_INDEX.DISABLE_LOCAL_SEARCH,
 500         isDefaultSearch: CONFIG.SEARCH.SEARCH_INDEX.IS_DEFAULT_SEARCH
 501       }
 502     }
 503   }
 504 }
 505
 506 function convertCustomConfigBody (body: CustomConfig) {
 507   function keyConverter (k: string) {
 508     // Transcoding resolutions exception
 509     if (/^\d{3,4}p$/.exec(k)) return k
 510     if (k === '0p') return k
 511
 512     return snakeCase(k)
 513   }
 514
 515   function valueConverter (v: any) {
 516     if (validator.isNumeric(v + '')) return parseInt('' + v, 10)
 517
 518     return v
 519   }
 520
 521   return objectConverter(body, keyConverter, valueConverter)
 522 }