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