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     video: {
 167       image: {
 168         extensions: CONSTRAINTS_FIELDS.VIDEOS.IMAGE.EXTNAME,
 169         size: {
 170           max: CONSTRAINTS_FIELDS.VIDEOS.IMAGE.FILE_SIZE.max
 171         }
 172       },
 173       file: {
 174         extensions: CONSTRAINTS_FIELDS.VIDEOS.EXTNAME
 175       }
 176     },
 177     videoCaption: {
 178       file: {
 179         size: {
 180           max: CONSTRAINTS_FIELDS.VIDEO_CAPTIONS.CAPTION_FILE.FILE_SIZE.max
 181         },
 182         extensions: CONSTRAINTS_FIELDS.VIDEO_CAPTIONS.CAPTION_FILE.EXTNAME
 183       }
 184     },
 185     user: {
 186       videoQuota: CONFIG.USER.VIDEO_QUOTA,
 187       videoQuotaDaily: CONFIG.USER.VIDEO_QUOTA_DAILY
 188     },
 189     trending: {
 190       videos: {
 191         intervalDays: CONFIG.TRENDING.VIDEOS.INTERVAL_DAYS,
 192         algorithms: {
 193           enabled: CONFIG.TRENDING.VIDEOS.ALGORITHMS.ENABLED,
 194           default: CONFIG.TRENDING.VIDEOS.ALGORITHMS.DEFAULT
 195         }
 196       }
 197     },
 198     tracker: {
 199       enabled: CONFIG.TRACKER.ENABLED
 200     },
 201
 202     followings: {
 203       instance: {
 204         autoFollowIndex: {
 205           indexUrl: CONFIG.FOLLOWINGS.INSTANCE.AUTO_FOLLOW_INDEX.INDEX_URL
 206         }
 207       }
 208     },
 209
 210     broadcastMessage: {
 211       enabled: CONFIG.BROADCAST_MESSAGE.ENABLED,
 212       message: CONFIG.BROADCAST_MESSAGE.MESSAGE,
 213       level: CONFIG.BROADCAST_MESSAGE.LEVEL,
 214       dismissable: CONFIG.BROADCAST_MESSAGE.DISMISSABLE
 215     }
 216   }
 217
 218   return res.json(json)
 219 }
 220
 221 function getAbout (req: express.Request, res: express.Response) {
 222   const about: About = {
 223     instance: {
 224       name: CONFIG.INSTANCE.NAME,
 225       shortDescription: CONFIG.INSTANCE.SHORT_DESCRIPTION,
 226       description: CONFIG.INSTANCE.DESCRIPTION,
 227       terms: CONFIG.INSTANCE.TERMS,
 228       codeOfConduct: CONFIG.INSTANCE.CODE_OF_CONDUCT,
 229
 230       hardwareInformation: CONFIG.INSTANCE.HARDWARE_INFORMATION,
 231
 232       creationReason: CONFIG.INSTANCE.CREATION_REASON,
 233       moderationInformation: CONFIG.INSTANCE.MODERATION_INFORMATION,
 234       administrator: CONFIG.INSTANCE.ADMINISTRATOR,
 235       maintenanceLifetime: CONFIG.INSTANCE.MAINTENANCE_LIFETIME,
 236       businessModel: CONFIG.INSTANCE.BUSINESS_MODEL,
 237
 238       languages: CONFIG.INSTANCE.LANGUAGES,
 239       categories: CONFIG.INSTANCE.CATEGORIES
 240     }
 241   }
 242
 243   return res.json(about).end()
 244 }
 245
 246 function getCustomConfig (req: express.Request, res: express.Response) {
 247   const data = customConfig()
 248
 249   return res.json(data).end()
 250 }
 251
 252 async function deleteCustomConfig (req: express.Request, res: express.Response) {
 253   await remove(CONFIG.CUSTOM_FILE)
 254
 255   auditLogger.delete(getAuditIdFromRes(res), new CustomConfigAuditView(customConfig()))
 256
 257   reloadConfig()
 258   ClientHtml.invalidCache()
 259
 260   const data = customConfig()
 261
 262   return res.json(data)
 263 }
 264
 265 async function updateCustomConfig (req: express.Request, res: express.Response) {
 266   const oldCustomConfigAuditKeys = new CustomConfigAuditView(customConfig())
 267
 268   // camelCase to snake_case key + Force number conversion
 269   const toUpdateJSON = convertCustomConfigBody(req.body)
 270
 271   await writeJSON(CONFIG.CUSTOM_FILE, toUpdateJSON, { spaces: 2 })
 272
 273   reloadConfig()
 274   ClientHtml.invalidCache()
 275
 276   const data = customConfig()
 277
 278   auditLogger.update(
 279     getAuditIdFromRes(res),
 280     new CustomConfigAuditView(data),
 281     oldCustomConfigAuditKeys
 282   )
 283
 284   return res.json(data)
 285 }
 286
 287 function getRegisteredThemes () {
 288   return PluginManager.Instance.getRegisteredThemes()
 289                       .map(t => ({
 290                         name: t.name,
 291                         version: t.version,
 292                         description: t.description,
 293                         css: t.css,
 294                         clientScripts: t.clientScripts
 295                       }))
 296 }
 297
 298 function getRegisteredPlugins () {
 299   return PluginManager.Instance.getRegisteredPlugins()
 300                       .map(p => ({
 301                         name: p.name,
 302                         version: p.version,
 303                         description: p.description,
 304                         clientScripts: p.clientScripts
 305                       }))
 306 }
 307
 308 function getIdAndPassAuthPlugins () {
 309   const result: RegisteredIdAndPassAuthConfig[] = []
 310
 311   for (const p of PluginManager.Instance.getIdAndPassAuths()) {
 312     for (const auth of p.idAndPassAuths) {
 313       result.push({
 314         npmName: p.npmName,
 315         name: p.name,
 316         version: p.version,
 317         authName: auth.authName,
 318         weight: auth.getWeight()
 319       })
 320     }
 321   }
 322
 323   return result
 324 }
 325
 326 function getExternalAuthsPlugins () {
 327   const result: RegisteredExternalAuthConfig[] = []
 328
 329   for (const p of PluginManager.Instance.getExternalAuths()) {
 330     for (const auth of p.externalAuths) {
 331       result.push({
 332         npmName: p.npmName,
 333         name: p.name,
 334         version: p.version,
 335         authName: auth.authName,
 336         authDisplayName: auth.authDisplayName()
 337       })
 338     }
 339   }
 340
 341   return result
 342 }
 343
 344 // ---------------------------------------------------------------------------
 345
 346 export {
 347   configRouter,
 348   getRegisteredPlugins,
 349   getRegisteredThemes
 350 }
 351
 352 // ---------------------------------------------------------------------------
 353
 354 function customConfig (): CustomConfig {
 355   return {
 356     instance: {
 357       name: CONFIG.INSTANCE.NAME,
 358       shortDescription: CONFIG.INSTANCE.SHORT_DESCRIPTION,
 359       description: CONFIG.INSTANCE.DESCRIPTION,
 360       terms: CONFIG.INSTANCE.TERMS,
 361       codeOfConduct: CONFIG.INSTANCE.CODE_OF_CONDUCT,
 362
 363       creationReason: CONFIG.INSTANCE.CREATION_REASON,
 364       moderationInformation: CONFIG.INSTANCE.MODERATION_INFORMATION,
 365       administrator: CONFIG.INSTANCE.ADMINISTRATOR,
 366       maintenanceLifetime: CONFIG.INSTANCE.MAINTENANCE_LIFETIME,
 367       businessModel: CONFIG.INSTANCE.BUSINESS_MODEL,
 368       hardwareInformation: CONFIG.INSTANCE.HARDWARE_INFORMATION,
 369
 370       languages: CONFIG.INSTANCE.LANGUAGES,
 371       categories: CONFIG.INSTANCE.CATEGORIES,
 372
 373       isNSFW: CONFIG.INSTANCE.IS_NSFW,
 374       defaultNSFWPolicy: CONFIG.INSTANCE.DEFAULT_NSFW_POLICY,
 375
 376       defaultClientRoute: CONFIG.INSTANCE.DEFAULT_CLIENT_ROUTE,
 377
 378       customizations: {
 379         css: CONFIG.INSTANCE.CUSTOMIZATIONS.CSS,
 380         javascript: CONFIG.INSTANCE.CUSTOMIZATIONS.JAVASCRIPT
 381       }
 382     },
 383     theme: {
 384       default: CONFIG.THEME.DEFAULT
 385     },
 386     services: {
 387       twitter: {
 388         username: CONFIG.SERVICES.TWITTER.USERNAME,
 389         whitelisted: CONFIG.SERVICES.TWITTER.WHITELISTED
 390       }
 391     },
 392     cache: {
 393       previews: {
 394         size: CONFIG.CACHE.PREVIEWS.SIZE
 395       },
 396       captions: {
 397         size: CONFIG.CACHE.VIDEO_CAPTIONS.SIZE
 398       },
 399       torrents: {
 400         size: CONFIG.CACHE.TORRENTS.SIZE
 401       }
 402     },
 403     signup: {
 404       enabled: CONFIG.SIGNUP.ENABLED,
 405       limit: CONFIG.SIGNUP.LIMIT,
 406       requiresEmailVerification: CONFIG.SIGNUP.REQUIRES_EMAIL_VERIFICATION
 407     },
 408     admin: {
 409       email: CONFIG.ADMIN.EMAIL
 410     },
 411     contactForm: {
 412       enabled: CONFIG.CONTACT_FORM.ENABLED
 413     },
 414     user: {
 415       videoQuota: CONFIG.USER.VIDEO_QUOTA,
 416       videoQuotaDaily: CONFIG.USER.VIDEO_QUOTA_DAILY
 417     },
 418     transcoding: {
 419       enabled: CONFIG.TRANSCODING.ENABLED,
 420       allowAdditionalExtensions: CONFIG.TRANSCODING.ALLOW_ADDITIONAL_EXTENSIONS,
 421       allowAudioFiles: CONFIG.TRANSCODING.ALLOW_AUDIO_FILES,
 422       threads: CONFIG.TRANSCODING.THREADS,
 423       concurrency: CONFIG.TRANSCODING.CONCURRENCY,
 424       profile: CONFIG.TRANSCODING.PROFILE,
 425       resolutions: {
 426         '0p': CONFIG.TRANSCODING.RESOLUTIONS['0p'],
 427         '240p': CONFIG.TRANSCODING.RESOLUTIONS['240p'],
 428         '360p': CONFIG.TRANSCODING.RESOLUTIONS['360p'],
 429         '480p': CONFIG.TRANSCODING.RESOLUTIONS['480p'],
 430         '720p': CONFIG.TRANSCODING.RESOLUTIONS['720p'],
 431         '1080p': CONFIG.TRANSCODING.RESOLUTIONS['1080p'],
 432         '1440p': CONFIG.TRANSCODING.RESOLUTIONS['1440p'],
 433         '2160p': CONFIG.TRANSCODING.RESOLUTIONS['2160p']
 434       },
 435       webtorrent: {
 436         enabled: CONFIG.TRANSCODING.WEBTORRENT.ENABLED
 437       },
 438       hls: {
 439         enabled: CONFIG.TRANSCODING.HLS.ENABLED
 440       }
 441     },
 442     live: {
 443       enabled: CONFIG.LIVE.ENABLED,
 444       allowReplay: CONFIG.LIVE.ALLOW_REPLAY,
 445       maxDuration: CONFIG.LIVE.MAX_DURATION,
 446       maxInstanceLives: CONFIG.LIVE.MAX_INSTANCE_LIVES,
 447       maxUserLives: CONFIG.LIVE.MAX_USER_LIVES,
 448       transcoding: {
 449         enabled: CONFIG.LIVE.TRANSCODING.ENABLED,
 450         threads: CONFIG.LIVE.TRANSCODING.THREADS,
 451         profile: CONFIG.LIVE.TRANSCODING.PROFILE,
 452         resolutions: {
 453           '240p': CONFIG.LIVE.TRANSCODING.RESOLUTIONS['240p'],
 454           '360p': CONFIG.LIVE.TRANSCODING.RESOLUTIONS['360p'],
 455           '480p': CONFIG.LIVE.TRANSCODING.RESOLUTIONS['480p'],
 456           '720p': CONFIG.LIVE.TRANSCODING.RESOLUTIONS['720p'],
 457           '1080p': CONFIG.LIVE.TRANSCODING.RESOLUTIONS['1080p'],
 458           '1440p': CONFIG.LIVE.TRANSCODING.RESOLUTIONS['1440p'],
 459           '2160p': CONFIG.LIVE.TRANSCODING.RESOLUTIONS['2160p']
 460         }
 461       }
 462     },
 463     import: {
 464       videos: {
 465         concurrency: CONFIG.IMPORT.VIDEOS.CONCURRENCY,
 466         http: {
 467           enabled: CONFIG.IMPORT.VIDEOS.HTTP.ENABLED
 468         },
 469         torrent: {
 470           enabled: CONFIG.IMPORT.VIDEOS.TORRENT.ENABLED
 471         }
 472       }
 473     },
 474     trending: {
 475       videos: {
 476         algorithms: {
 477           enabled: CONFIG.TRENDING.VIDEOS.ALGORITHMS.ENABLED,
 478           default: CONFIG.TRENDING.VIDEOS.ALGORITHMS.DEFAULT
 479         }
 480       }
 481     },
 482     autoBlacklist: {
 483       videos: {
 484         ofUsers: {
 485           enabled: CONFIG.AUTO_BLACKLIST.VIDEOS.OF_USERS.ENABLED
 486         }
 487       }
 488     },
 489     followers: {
 490       instance: {
 491         enabled: CONFIG.FOLLOWERS.INSTANCE.ENABLED,
 492         manualApproval: CONFIG.FOLLOWERS.INSTANCE.MANUAL_APPROVAL
 493       }
 494     },
 495     followings: {
 496       instance: {
 497         autoFollowBack: {
 498           enabled: CONFIG.FOLLOWINGS.INSTANCE.AUTO_FOLLOW_BACK.ENABLED
 499         },
 500
 501         autoFollowIndex: {
 502           enabled: CONFIG.FOLLOWINGS.INSTANCE.AUTO_FOLLOW_INDEX.ENABLED,
 503           indexUrl: CONFIG.FOLLOWINGS.INSTANCE.AUTO_FOLLOW_INDEX.INDEX_URL
 504         }
 505       }
 506     },
 507     broadcastMessage: {
 508       enabled: CONFIG.BROADCAST_MESSAGE.ENABLED,
 509       message: CONFIG.BROADCAST_MESSAGE.MESSAGE,
 510       level: CONFIG.BROADCAST_MESSAGE.LEVEL,
 511       dismissable: CONFIG.BROADCAST_MESSAGE.DISMISSABLE
 512     },
 513     search: {
 514       remoteUri: {
 515         users: CONFIG.SEARCH.REMOTE_URI.USERS,
 516         anonymous: CONFIG.SEARCH.REMOTE_URI.ANONYMOUS
 517       },
 518       searchIndex: {
 519         enabled: CONFIG.SEARCH.SEARCH_INDEX.ENABLED,
 520         url: CONFIG.SEARCH.SEARCH_INDEX.URL,
 521         disableLocalSearch: CONFIG.SEARCH.SEARCH_INDEX.DISABLE_LOCAL_SEARCH,
 522         isDefaultSearch: CONFIG.SEARCH.SEARCH_INDEX.IS_DEFAULT_SEARCH
 523       }
 524     }
 525   }
 526 }
 527
 528 function convertCustomConfigBody (body: CustomConfig) {
 529   function keyConverter (k: string) {
 530     // Transcoding resolutions exception
 531     if (/^\d{3,4}p$/.exec(k)) return k
 532     if (k === '0p') return k
 533
 534     return snakeCase(k)
 535   }
 536
 537   function valueConverter (v: any) {
 538     if (validator.isNumeric(v + '')) return parseInt('' + v, 10)
 539
 540     return v
 541   }
 542
 543   return objectConverter(body, keyConverter, valueConverter)
 544 }