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
 124       transcoding: {
 125         enabled: CONFIG.LIVE.TRANSCODING.ENABLED,
 126         enabledResolutions: getEnabledResolutions('live')
 127       }
 128     },
 129     import: {
 130       videos: {
 131         http: {
 132           enabled: CONFIG.IMPORT.VIDEOS.HTTP.ENABLED
 133         },
 134         torrent: {
 135           enabled: CONFIG.IMPORT.VIDEOS.TORRENT.ENABLED
 136         }
 137       }
 138     },
 139     autoBlacklist: {
 140       videos: {
 141         ofUsers: {
 142           enabled: CONFIG.AUTO_BLACKLIST.VIDEOS.OF_USERS.ENABLED
 143         }
 144       }
 145     },
 146     avatar: {
 147       file: {
 148         size: {
 149           max: CONSTRAINTS_FIELDS.ACTORS.AVATAR.FILE_SIZE.max
 150         },
 151         extensions: CONSTRAINTS_FIELDS.ACTORS.AVATAR.EXTNAME
 152       }
 153     },
 154     video: {
 155       image: {
 156         extensions: CONSTRAINTS_FIELDS.VIDEOS.IMAGE.EXTNAME,
 157         size: {
 158           max: CONSTRAINTS_FIELDS.VIDEOS.IMAGE.FILE_SIZE.max
 159         }
 160       },
 161       file: {
 162         extensions: CONSTRAINTS_FIELDS.VIDEOS.EXTNAME
 163       }
 164     },
 165     videoCaption: {
 166       file: {
 167         size: {
 168           max: CONSTRAINTS_FIELDS.VIDEO_CAPTIONS.CAPTION_FILE.FILE_SIZE.max
 169         },
 170         extensions: CONSTRAINTS_FIELDS.VIDEO_CAPTIONS.CAPTION_FILE.EXTNAME
 171       }
 172     },
 173     user: {
 174       videoQuota: CONFIG.USER.VIDEO_QUOTA,
 175       videoQuotaDaily: CONFIG.USER.VIDEO_QUOTA_DAILY
 176     },
 177     trending: {
 178       videos: {
 179         intervalDays: CONFIG.TRENDING.VIDEOS.INTERVAL_DAYS
 180       }
 181     },
 182     tracker: {
 183       enabled: CONFIG.TRACKER.ENABLED
 184     },
 185
 186     followings: {
 187       instance: {
 188         autoFollowIndex: {
 189           indexUrl: CONFIG.FOLLOWINGS.INSTANCE.AUTO_FOLLOW_INDEX.INDEX_URL
 190         }
 191       }
 192     },
 193
 194     broadcastMessage: {
 195       enabled: CONFIG.BROADCAST_MESSAGE.ENABLED,
 196       message: CONFIG.BROADCAST_MESSAGE.MESSAGE,
 197       level: CONFIG.BROADCAST_MESSAGE.LEVEL,
 198       dismissable: CONFIG.BROADCAST_MESSAGE.DISMISSABLE
 199     }
 200   }
 201
 202   return res.json(json)
 203 }
 204
 205 function getAbout (req: express.Request, res: express.Response) {
 206   const about: About = {
 207     instance: {
 208       name: CONFIG.INSTANCE.NAME,
 209       shortDescription: CONFIG.INSTANCE.SHORT_DESCRIPTION,
 210       description: CONFIG.INSTANCE.DESCRIPTION,
 211       terms: CONFIG.INSTANCE.TERMS,
 212       codeOfConduct: CONFIG.INSTANCE.CODE_OF_CONDUCT,
 213
 214       hardwareInformation: CONFIG.INSTANCE.HARDWARE_INFORMATION,
 215
 216       creationReason: CONFIG.INSTANCE.CREATION_REASON,
 217       moderationInformation: CONFIG.INSTANCE.MODERATION_INFORMATION,
 218       administrator: CONFIG.INSTANCE.ADMINISTRATOR,
 219       maintenanceLifetime: CONFIG.INSTANCE.MAINTENANCE_LIFETIME,
 220       businessModel: CONFIG.INSTANCE.BUSINESS_MODEL,
 221
 222       languages: CONFIG.INSTANCE.LANGUAGES,
 223       categories: CONFIG.INSTANCE.CATEGORIES
 224     }
 225   }
 226
 227   return res.json(about).end()
 228 }
 229
 230 function getCustomConfig (req: express.Request, res: express.Response) {
 231   const data = customConfig()
 232
 233   return res.json(data).end()
 234 }
 235
 236 async function deleteCustomConfig (req: express.Request, res: express.Response) {
 237   await remove(CONFIG.CUSTOM_FILE)
 238
 239   auditLogger.delete(getAuditIdFromRes(res), new CustomConfigAuditView(customConfig()))
 240
 241   reloadConfig()
 242   ClientHtml.invalidCache()
 243
 244   const data = customConfig()
 245
 246   return res.json(data)
 247 }
 248
 249 async function updateCustomConfig (req: express.Request, res: express.Response) {
 250   const oldCustomConfigAuditKeys = new CustomConfigAuditView(customConfig())
 251
 252   // camelCase to snake_case key + Force number conversion
 253   const toUpdateJSON = convertCustomConfigBody(req.body)
 254
 255   await writeJSON(CONFIG.CUSTOM_FILE, toUpdateJSON, { spaces: 2 })
 256
 257   reloadConfig()
 258   ClientHtml.invalidCache()
 259
 260   const data = customConfig()
 261
 262   auditLogger.update(
 263     getAuditIdFromRes(res),
 264     new CustomConfigAuditView(data),
 265     oldCustomConfigAuditKeys
 266   )
 267
 268   return res.json(data)
 269 }
 270
 271 function getRegisteredThemes () {
 272   return PluginManager.Instance.getRegisteredThemes()
 273                       .map(t => ({
 274                         name: t.name,
 275                         version: t.version,
 276                         description: t.description,
 277                         css: t.css,
 278                         clientScripts: t.clientScripts
 279                       }))
 280 }
 281
 282 function getEnabledResolutions (type: 'vod' | 'live') {
 283   const transcoding = type === 'vod'
 284     ? CONFIG.TRANSCODING
 285     : CONFIG.LIVE.TRANSCODING
 286
 287   return Object.keys(transcoding.RESOLUTIONS)
 288                .filter(key => transcoding.ENABLED && transcoding.RESOLUTIONS[key] === true)
 289                .map(r => parseInt(r, 10))
 290 }
 291
 292 function getRegisteredPlugins () {
 293   return PluginManager.Instance.getRegisteredPlugins()
 294                       .map(p => ({
 295                         name: p.name,
 296                         version: p.version,
 297                         description: p.description,
 298                         clientScripts: p.clientScripts
 299                       }))
 300 }
 301
 302 function getIdAndPassAuthPlugins () {
 303   const result: RegisteredIdAndPassAuthConfig[] = []
 304
 305   for (const p of PluginManager.Instance.getIdAndPassAuths()) {
 306     for (const auth of p.idAndPassAuths) {
 307       result.push({
 308         npmName: p.npmName,
 309         name: p.name,
 310         version: p.version,
 311         authName: auth.authName,
 312         weight: auth.getWeight()
 313       })
 314     }
 315   }
 316
 317   return result
 318 }
 319
 320 function getExternalAuthsPlugins () {
 321   const result: RegisteredExternalAuthConfig[] = []
 322
 323   for (const p of PluginManager.Instance.getExternalAuths()) {
 324     for (const auth of p.externalAuths) {
 325       result.push({
 326         npmName: p.npmName,
 327         name: p.name,
 328         version: p.version,
 329         authName: auth.authName,
 330         authDisplayName: auth.authDisplayName()
 331       })
 332     }
 333   }
 334
 335   return result
 336 }
 337
 338 // ---------------------------------------------------------------------------
 339
 340 export {
 341   configRouter,
 342   getEnabledResolutions,
 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       defaultClientRoute: CONFIG.INSTANCE.DEFAULT_CLIENT_ROUTE,
 370       defaultNSFWPolicy: CONFIG.INSTANCE.DEFAULT_NSFW_POLICY,
 371       customizations: {
 372         css: CONFIG.INSTANCE.CUSTOMIZATIONS.CSS,
 373         javascript: CONFIG.INSTANCE.CUSTOMIZATIONS.JAVASCRIPT
 374       }
 375     },
 376     theme: {
 377       default: CONFIG.THEME.DEFAULT
 378     },
 379     services: {
 380       twitter: {
 381         username: CONFIG.SERVICES.TWITTER.USERNAME,
 382         whitelisted: CONFIG.SERVICES.TWITTER.WHITELISTED
 383       }
 384     },
 385     cache: {
 386       previews: {
 387         size: CONFIG.CACHE.PREVIEWS.SIZE
 388       },
 389       captions: {
 390         size: CONFIG.CACHE.VIDEO_CAPTIONS.SIZE
 391       }
 392     },
 393     signup: {
 394       enabled: CONFIG.SIGNUP.ENABLED,
 395       limit: CONFIG.SIGNUP.LIMIT,
 396       requiresEmailVerification: CONFIG.SIGNUP.REQUIRES_EMAIL_VERIFICATION
 397     },
 398     admin: {
 399       email: CONFIG.ADMIN.EMAIL
 400     },
 401     contactForm: {
 402       enabled: CONFIG.CONTACT_FORM.ENABLED
 403     },
 404     user: {
 405       videoQuota: CONFIG.USER.VIDEO_QUOTA,
 406       videoQuotaDaily: CONFIG.USER.VIDEO_QUOTA_DAILY
 407     },
 408     transcoding: {
 409       enabled: CONFIG.TRANSCODING.ENABLED,
 410       allowAdditionalExtensions: CONFIG.TRANSCODING.ALLOW_ADDITIONAL_EXTENSIONS,
 411       allowAudioFiles: CONFIG.TRANSCODING.ALLOW_AUDIO_FILES,
 412       threads: CONFIG.TRANSCODING.THREADS,
 413       resolutions: {
 414         '0p': CONFIG.TRANSCODING.RESOLUTIONS['0p'],
 415         '240p': CONFIG.TRANSCODING.RESOLUTIONS['240p'],
 416         '360p': CONFIG.TRANSCODING.RESOLUTIONS['360p'],
 417         '480p': CONFIG.TRANSCODING.RESOLUTIONS['480p'],
 418         '720p': CONFIG.TRANSCODING.RESOLUTIONS['720p'],
 419         '1080p': CONFIG.TRANSCODING.RESOLUTIONS['1080p'],
 420         '2160p': CONFIG.TRANSCODING.RESOLUTIONS['2160p']
 421       },
 422       webtorrent: {
 423         enabled: CONFIG.TRANSCODING.WEBTORRENT.ENABLED
 424       },
 425       hls: {
 426         enabled: CONFIG.TRANSCODING.HLS.ENABLED
 427       }
 428     },
 429     live: {
 430       enabled: CONFIG.LIVE.ENABLED,
 431       allowReplay: CONFIG.LIVE.ALLOW_REPLAY,
 432       maxDuration: CONFIG.LIVE.MAX_DURATION,
 433       transcoding: {
 434         enabled: CONFIG.LIVE.TRANSCODING.ENABLED,
 435         threads: CONFIG.LIVE.TRANSCODING.THREADS,
 436         resolutions: {
 437           '240p': CONFIG.LIVE.TRANSCODING.RESOLUTIONS['240p'],
 438           '360p': CONFIG.LIVE.TRANSCODING.RESOLUTIONS['360p'],
 439           '480p': CONFIG.LIVE.TRANSCODING.RESOLUTIONS['480p'],
 440           '720p': CONFIG.LIVE.TRANSCODING.RESOLUTIONS['720p'],
 441           '1080p': CONFIG.LIVE.TRANSCODING.RESOLUTIONS['1080p'],
 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 }