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       isNSFW: CONFIG.INSTANCE.IS_NSFW,
  69       defaultNSFWPolicy: CONFIG.INSTANCE.DEFAULT_NSFW_POLICY,
  70       defaultClientRoute: CONFIG.INSTANCE.DEFAULT_CLIENT_ROUTE,
  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         algorithms: {
 188           enabled: CONFIG.TRENDING.VIDEOS.ALGORITHMS.ENABLED,
 189           default: CONFIG.TRENDING.VIDEOS.ALGORITHMS.DEFAULT
 190         }
 191       }
 192     },
 193     tracker: {
 194       enabled: CONFIG.TRACKER.ENABLED
 195     },
 196
 197     followings: {
 198       instance: {
 199         autoFollowIndex: {
 200           indexUrl: CONFIG.FOLLOWINGS.INSTANCE.AUTO_FOLLOW_INDEX.INDEX_URL
 201         }
 202       }
 203     },
 204
 205     broadcastMessage: {
 206       enabled: CONFIG.BROADCAST_MESSAGE.ENABLED,
 207       message: CONFIG.BROADCAST_MESSAGE.MESSAGE,
 208       level: CONFIG.BROADCAST_MESSAGE.LEVEL,
 209       dismissable: CONFIG.BROADCAST_MESSAGE.DISMISSABLE
 210     }
 211   }
 212
 213   return res.json(json)
 214 }
 215
 216 function getAbout (req: express.Request, res: express.Response) {
 217   const about: About = {
 218     instance: {
 219       name: CONFIG.INSTANCE.NAME,
 220       shortDescription: CONFIG.INSTANCE.SHORT_DESCRIPTION,
 221       description: CONFIG.INSTANCE.DESCRIPTION,
 222       terms: CONFIG.INSTANCE.TERMS,
 223       codeOfConduct: CONFIG.INSTANCE.CODE_OF_CONDUCT,
 224
 225       hardwareInformation: CONFIG.INSTANCE.HARDWARE_INFORMATION,
 226
 227       creationReason: CONFIG.INSTANCE.CREATION_REASON,
 228       moderationInformation: CONFIG.INSTANCE.MODERATION_INFORMATION,
 229       administrator: CONFIG.INSTANCE.ADMINISTRATOR,
 230       maintenanceLifetime: CONFIG.INSTANCE.MAINTENANCE_LIFETIME,
 231       businessModel: CONFIG.INSTANCE.BUSINESS_MODEL,
 232
 233       languages: CONFIG.INSTANCE.LANGUAGES,
 234       categories: CONFIG.INSTANCE.CATEGORIES
 235     }
 236   }
 237
 238   return res.json(about).end()
 239 }
 240
 241 function getCustomConfig (req: express.Request, res: express.Response) {
 242   const data = customConfig()
 243
 244   return res.json(data).end()
 245 }
 246
 247 async function deleteCustomConfig (req: express.Request, res: express.Response) {
 248   await remove(CONFIG.CUSTOM_FILE)
 249
 250   auditLogger.delete(getAuditIdFromRes(res), new CustomConfigAuditView(customConfig()))
 251
 252   reloadConfig()
 253   ClientHtml.invalidCache()
 254
 255   const data = customConfig()
 256
 257   return res.json(data)
 258 }
 259
 260 async function updateCustomConfig (req: express.Request, res: express.Response) {
 261   const oldCustomConfigAuditKeys = new CustomConfigAuditView(customConfig())
 262
 263   // camelCase to snake_case key + Force number conversion
 264   const toUpdateJSON = convertCustomConfigBody(req.body)
 265
 266   await writeJSON(CONFIG.CUSTOM_FILE, toUpdateJSON, { spaces: 2 })
 267
 268   reloadConfig()
 269   ClientHtml.invalidCache()
 270
 271   const data = customConfig()
 272
 273   auditLogger.update(
 274     getAuditIdFromRes(res),
 275     new CustomConfigAuditView(data),
 276     oldCustomConfigAuditKeys
 277   )
 278
 279   return res.json(data)
 280 }
 281
 282 function getRegisteredThemes () {
 283   return PluginManager.Instance.getRegisteredThemes()
 284                       .map(t => ({
 285                         name: t.name,
 286                         version: t.version,
 287                         description: t.description,
 288                         css: t.css,
 289                         clientScripts: t.clientScripts
 290                       }))
 291 }
 292
 293 function getRegisteredPlugins () {
 294   return PluginManager.Instance.getRegisteredPlugins()
 295                       .map(p => ({
 296                         name: p.name,
 297                         version: p.version,
 298                         description: p.description,
 299                         clientScripts: p.clientScripts
 300                       }))
 301 }
 302
 303 function getIdAndPassAuthPlugins () {
 304   const result: RegisteredIdAndPassAuthConfig[] = []
 305
 306   for (const p of PluginManager.Instance.getIdAndPassAuths()) {
 307     for (const auth of p.idAndPassAuths) {
 308       result.push({
 309         npmName: p.npmName,
 310         name: p.name,
 311         version: p.version,
 312         authName: auth.authName,
 313         weight: auth.getWeight()
 314       })
 315     }
 316   }
 317
 318   return result
 319 }
 320
 321 function getExternalAuthsPlugins () {
 322   const result: RegisteredExternalAuthConfig[] = []
 323
 324   for (const p of PluginManager.Instance.getExternalAuths()) {
 325     for (const auth of p.externalAuths) {
 326       result.push({
 327         npmName: p.npmName,
 328         name: p.name,
 329         version: p.version,
 330         authName: auth.authName,
 331         authDisplayName: auth.authDisplayName()
 332       })
 333     }
 334   }
 335
 336   return result
 337 }
 338
 339 // ---------------------------------------------------------------------------
 340
 341 export {
 342   configRouter,
 343   getRegisteredPlugins,
 344   getRegisteredThemes
 345 }
 346
 347 // ---------------------------------------------------------------------------
 348
 349 function customConfig (): CustomConfig {
 350   return {
 351     instance: {
 352       name: CONFIG.INSTANCE.NAME,
 353       shortDescription: CONFIG.INSTANCE.SHORT_DESCRIPTION,
 354       description: CONFIG.INSTANCE.DESCRIPTION,
 355       terms: CONFIG.INSTANCE.TERMS,
 356       codeOfConduct: CONFIG.INSTANCE.CODE_OF_CONDUCT,
 357
 358       creationReason: CONFIG.INSTANCE.CREATION_REASON,
 359       moderationInformation: CONFIG.INSTANCE.MODERATION_INFORMATION,
 360       administrator: CONFIG.INSTANCE.ADMINISTRATOR,
 361       maintenanceLifetime: CONFIG.INSTANCE.MAINTENANCE_LIFETIME,
 362       businessModel: CONFIG.INSTANCE.BUSINESS_MODEL,
 363       hardwareInformation: CONFIG.INSTANCE.HARDWARE_INFORMATION,
 364
 365       languages: CONFIG.INSTANCE.LANGUAGES,
 366       categories: CONFIG.INSTANCE.CATEGORIES,
 367
 368       isNSFW: CONFIG.INSTANCE.IS_NSFW,
 369       defaultNSFWPolicy: CONFIG.INSTANCE.DEFAULT_NSFW_POLICY,
 370
 371       defaultClientRoute: CONFIG.INSTANCE.DEFAULT_CLIENT_ROUTE,
 372
 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         '1440p': CONFIG.TRANSCODING.RESOLUTIONS['1440p'],
 423         '2160p': CONFIG.TRANSCODING.RESOLUTIONS['2160p']
 424       },
 425       webtorrent: {
 426         enabled: CONFIG.TRANSCODING.WEBTORRENT.ENABLED
 427       },
 428       hls: {
 429         enabled: CONFIG.TRANSCODING.HLS.ENABLED
 430       }
 431     },
 432     live: {
 433       enabled: CONFIG.LIVE.ENABLED,
 434       allowReplay: CONFIG.LIVE.ALLOW_REPLAY,
 435       maxDuration: CONFIG.LIVE.MAX_DURATION,
 436       maxInstanceLives: CONFIG.LIVE.MAX_INSTANCE_LIVES,
 437       maxUserLives: CONFIG.LIVE.MAX_USER_LIVES,
 438       transcoding: {
 439         enabled: CONFIG.LIVE.TRANSCODING.ENABLED,
 440         threads: CONFIG.LIVE.TRANSCODING.THREADS,
 441         resolutions: {
 442           '240p': CONFIG.LIVE.TRANSCODING.RESOLUTIONS['240p'],
 443           '360p': CONFIG.LIVE.TRANSCODING.RESOLUTIONS['360p'],
 444           '480p': CONFIG.LIVE.TRANSCODING.RESOLUTIONS['480p'],
 445           '720p': CONFIG.LIVE.TRANSCODING.RESOLUTIONS['720p'],
 446           '1080p': CONFIG.LIVE.TRANSCODING.RESOLUTIONS['1080p'],
 447           '1440p': CONFIG.LIVE.TRANSCODING.RESOLUTIONS['1440p'],
 448           '2160p': CONFIG.LIVE.TRANSCODING.RESOLUTIONS['2160p']
 449         }
 450       }
 451     },
 452     import: {
 453       videos: {
 454         http: {
 455           enabled: CONFIG.IMPORT.VIDEOS.HTTP.ENABLED
 456         },
 457         torrent: {
 458           enabled: CONFIG.IMPORT.VIDEOS.TORRENT.ENABLED
 459         }
 460       }
 461     },
 462     trending: {
 463       videos: {
 464         algorithms: {
 465           enabled: CONFIG.TRENDING.VIDEOS.ALGORITHMS.ENABLED,
 466           default: CONFIG.TRENDING.VIDEOS.ALGORITHMS.DEFAULT
 467         }
 468       }
 469     },
 470     autoBlacklist: {
 471       videos: {
 472         ofUsers: {
 473           enabled: CONFIG.AUTO_BLACKLIST.VIDEOS.OF_USERS.ENABLED
 474         }
 475       }
 476     },
 477     followers: {
 478       instance: {
 479         enabled: CONFIG.FOLLOWERS.INSTANCE.ENABLED,
 480         manualApproval: CONFIG.FOLLOWERS.INSTANCE.MANUAL_APPROVAL
 481       }
 482     },
 483     followings: {
 484       instance: {
 485         autoFollowBack: {
 486           enabled: CONFIG.FOLLOWINGS.INSTANCE.AUTO_FOLLOW_BACK.ENABLED
 487         },
 488
 489         autoFollowIndex: {
 490           enabled: CONFIG.FOLLOWINGS.INSTANCE.AUTO_FOLLOW_INDEX.ENABLED,
 491           indexUrl: CONFIG.FOLLOWINGS.INSTANCE.AUTO_FOLLOW_INDEX.INDEX_URL
 492         }
 493       }
 494     },
 495     broadcastMessage: {
 496       enabled: CONFIG.BROADCAST_MESSAGE.ENABLED,
 497       message: CONFIG.BROADCAST_MESSAGE.MESSAGE,
 498       level: CONFIG.BROADCAST_MESSAGE.LEVEL,
 499       dismissable: CONFIG.BROADCAST_MESSAGE.DISMISSABLE
 500     },
 501     search: {
 502       remoteUri: {
 503         users: CONFIG.SEARCH.REMOTE_URI.USERS,
 504         anonymous: CONFIG.SEARCH.REMOTE_URI.ANONYMOUS
 505       },
 506       searchIndex: {
 507         enabled: CONFIG.SEARCH.SEARCH_INDEX.ENABLED,
 508         url: CONFIG.SEARCH.SEARCH_INDEX.URL,
 509         disableLocalSearch: CONFIG.SEARCH.SEARCH_INDEX.DISABLE_LOCAL_SEARCH,
 510         isDefaultSearch: CONFIG.SEARCH.SEARCH_INDEX.IS_DEFAULT_SEARCH
 511       }
 512     }
 513   }
 514 }
 515
 516 function convertCustomConfigBody (body: CustomConfig) {
 517   function keyConverter (k: string) {
 518     // Transcoding resolutions exception
 519     if (/^\d{3,4}p$/.exec(k)) return k
 520     if (k === '0p') return k
 521
 522     return snakeCase(k)
 523   }
 524
 525   function valueConverter (v: any) {
 526     if (validator.isNumeric(v + '')) return parseInt('' + v, 10)
 527
 528     return v
 529   }
 530
 531   return objectConverter(body, keyConverter, valueConverter)
 532 }