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