server/controllers/api/config.ts

   1 import * as express from 'express'
   2 import { snakeCase } from 'lodash'
   3 import { ServerConfig, UserRight } from '../../../shared'
   4 import { About } from '../../../shared/models/server/about.model'
   5 import { CustomConfig } from '../../../shared/models/server/custom-config.model'
   6 import { isSignupAllowed, isSignupAllowedForCurrentIP } from '../../helpers/signup'
   7 import { CONSTRAINTS_FIELDS, DEFAULT_THEME_NAME } from '../../initializers/constants'
   8 import { asyncMiddleware, authenticate, ensureUserHasRight } from '../../middlewares'
   9 import { customConfigUpdateValidator } from '../../middlewares/validators/config'
  10 import { ClientHtml } from '../../lib/client-html'
  11 import { auditLoggerFactory, CustomConfigAuditView, getAuditIdFromRes } from '../../helpers/audit-logger'
  12 import { remove, writeJSON } from 'fs-extra'
  13 import { getServerCommit } from '../../helpers/utils'
  14 import { Emailer } from '../../lib/emailer'
  15 import { isNumeric } from 'validator'
  16 import { objectConverter } from '../../helpers/core-utils'
  17 import { CONFIG, reloadConfig } from '../../initializers/config'
  18 import { PluginManager } from '../../lib/plugins/plugin-manager'
  19 import { getThemeOrDefault } from '../../lib/plugins/theme-utils'
  20
  21 const packageJSON = require('../../../../package.json')
  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   asyncMiddleware(getCustomConfig)
  35 )
  36 configRouter.put('/custom',
  37   authenticate,
  38   ensureUserHasRight(UserRight.MANAGE_CONFIGURATION),
  39   asyncMiddleware(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 async function getConfig (req: express.Request, res: express.Response) {
  50   const allowed = await isSignupAllowed()
  51   const allowedForCurrentIP = isSignupAllowedForCurrentIP(req.ip)
  52
  53   if (serverCommit === undefined) serverCommit = await getServerCommit()
  54
  55   const enabledResolutions = Object.keys(CONFIG.TRANSCODING.RESOLUTIONS)
  56    .filter(key => CONFIG.TRANSCODING.ENABLED && CONFIG.TRANSCODING.RESOLUTIONS[key] === true)
  57    .map(r => parseInt(r, 10))
  58
  59   const registeredPlugins = PluginManager.Instance.getRegisteredPlugins()
  60     .map(p => ({
  61       name: p.name,
  62       version: p.version,
  63       description: p.description,
  64       clientScripts: p.clientScripts
  65     }))
  66
  67   const registeredThemes = PluginManager.Instance.getRegisteredThemes()
  68                               .map(t => ({
  69                                 name: t.name,
  70                                 version: t.version,
  71                                 description: t.description,
  72                                 css: t.css,
  73                                 clientScripts: t.clientScripts
  74                               }))
  75
  76   const defaultTheme = getThemeOrDefault(CONFIG.THEME.DEFAULT, DEFAULT_THEME_NAME)
  77
  78   const json: ServerConfig = {
  79     instance: {
  80       name: CONFIG.INSTANCE.NAME,
  81       shortDescription: CONFIG.INSTANCE.SHORT_DESCRIPTION,
  82       defaultClientRoute: CONFIG.INSTANCE.DEFAULT_CLIENT_ROUTE,
  83       isNSFW: CONFIG.INSTANCE.IS_NSFW,
  84       defaultNSFWPolicy: CONFIG.INSTANCE.DEFAULT_NSFW_POLICY,
  85       customizations: {
  86         javascript: CONFIG.INSTANCE.CUSTOMIZATIONS.JAVASCRIPT,
  87         css: CONFIG.INSTANCE.CUSTOMIZATIONS.CSS
  88       }
  89     },
  90     plugin: {
  91       registered: registeredPlugins
  92     },
  93     theme: {
  94       registered: registeredThemes,
  95       default: defaultTheme
  96     },
  97     email: {
  98       enabled: Emailer.isEnabled()
  99     },
 100     contactForm: {
 101       enabled: CONFIG.CONTACT_FORM.ENABLED
 102     },
 103     serverVersion: packageJSON.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       enabledResolutions
 115     },
 116     import: {
 117       videos: {
 118         http: {
 119           enabled: CONFIG.IMPORT.VIDEOS.HTTP.ENABLED
 120         },
 121         torrent: {
 122           enabled: CONFIG.IMPORT.VIDEOS.TORRENT.ENABLED
 123         }
 124       }
 125     },
 126     autoBlacklist: {
 127       videos: {
 128         ofUsers: {
 129           enabled: CONFIG.AUTO_BLACKLIST.VIDEOS.OF_USERS.ENABLED
 130         }
 131       }
 132     },
 133     avatar: {
 134       file: {
 135         size: {
 136           max: CONSTRAINTS_FIELDS.ACTORS.AVATAR.FILE_SIZE.max
 137         },
 138         extensions: CONSTRAINTS_FIELDS.ACTORS.AVATAR.EXTNAME
 139       }
 140     },
 141     video: {
 142       image: {
 143         extensions: CONSTRAINTS_FIELDS.VIDEOS.IMAGE.EXTNAME,
 144         size: {
 145           max: CONSTRAINTS_FIELDS.VIDEOS.IMAGE.FILE_SIZE.max
 146         }
 147       },
 148       file: {
 149         extensions: CONSTRAINTS_FIELDS.VIDEOS.EXTNAME
 150       }
 151     },
 152     videoCaption: {
 153       file: {
 154         size: {
 155           max: CONSTRAINTS_FIELDS.VIDEO_CAPTIONS.CAPTION_FILE.FILE_SIZE.max
 156         },
 157         extensions: CONSTRAINTS_FIELDS.VIDEO_CAPTIONS.CAPTION_FILE.EXTNAME
 158       }
 159     },
 160     user: {
 161       videoQuota: CONFIG.USER.VIDEO_QUOTA,
 162       videoQuotaDaily: CONFIG.USER.VIDEO_QUOTA_DAILY
 163     },
 164     trending: {
 165       videos: {
 166         intervalDays: CONFIG.TRENDING.VIDEOS.INTERVAL_DAYS
 167       }
 168     },
 169     tracker: {
 170       enabled: CONFIG.TRACKER.ENABLED
 171     }
 172   }
 173
 174   return res.json(json)
 175 }
 176
 177 function getAbout (req: express.Request, res: express.Response) {
 178   const about: About = {
 179     instance: {
 180       name: CONFIG.INSTANCE.NAME,
 181       shortDescription: CONFIG.INSTANCE.SHORT_DESCRIPTION,
 182       description: CONFIG.INSTANCE.DESCRIPTION,
 183       terms: CONFIG.INSTANCE.TERMS
 184     }
 185   }
 186
 187   return res.json(about).end()
 188 }
 189
 190 async function getCustomConfig (req: express.Request, res: express.Response) {
 191   const data = customConfig()
 192
 193   return res.json(data).end()
 194 }
 195
 196 async function deleteCustomConfig (req: express.Request, res: express.Response) {
 197   await remove(CONFIG.CUSTOM_FILE)
 198
 199   auditLogger.delete(getAuditIdFromRes(res), new CustomConfigAuditView(customConfig()))
 200
 201   reloadConfig()
 202   ClientHtml.invalidCache()
 203
 204   const data = customConfig()
 205
 206   return res.json(data).end()
 207 }
 208
 209 async function updateCustomConfig (req: express.Request, res: express.Response) {
 210   const oldCustomConfigAuditKeys = new CustomConfigAuditView(customConfig())
 211
 212   // camelCase to snake_case key + Force number conversion
 213   const toUpdateJSON = convertCustomConfigBody(req.body)
 214
 215   await writeJSON(CONFIG.CUSTOM_FILE, toUpdateJSON, { spaces: 2 })
 216
 217   reloadConfig()
 218   ClientHtml.invalidCache()
 219
 220   const data = customConfig()
 221
 222   auditLogger.update(
 223     getAuditIdFromRes(res),
 224     new CustomConfigAuditView(data),
 225     oldCustomConfigAuditKeys
 226   )
 227
 228   return res.json(data).end()
 229 }
 230
 231 // ---------------------------------------------------------------------------
 232
 233 export {
 234   configRouter
 235 }
 236
 237 // ---------------------------------------------------------------------------
 238
 239 function customConfig (): CustomConfig {
 240   return {
 241     instance: {
 242       name: CONFIG.INSTANCE.NAME,
 243       shortDescription: CONFIG.INSTANCE.SHORT_DESCRIPTION,
 244       description: CONFIG.INSTANCE.DESCRIPTION,
 245       terms: CONFIG.INSTANCE.TERMS,
 246       isNSFW: CONFIG.INSTANCE.IS_NSFW,
 247       defaultClientRoute: CONFIG.INSTANCE.DEFAULT_CLIENT_ROUTE,
 248       defaultNSFWPolicy: CONFIG.INSTANCE.DEFAULT_NSFW_POLICY,
 249       customizations: {
 250         css: CONFIG.INSTANCE.CUSTOMIZATIONS.CSS,
 251         javascript: CONFIG.INSTANCE.CUSTOMIZATIONS.JAVASCRIPT
 252       }
 253     },
 254     theme: {
 255       default: CONFIG.THEME.DEFAULT
 256     },
 257     services: {
 258       twitter: {
 259         username: CONFIG.SERVICES.TWITTER.USERNAME,
 260         whitelisted: CONFIG.SERVICES.TWITTER.WHITELISTED
 261       }
 262     },
 263     cache: {
 264       previews: {
 265         size: CONFIG.CACHE.PREVIEWS.SIZE
 266       },
 267       captions: {
 268         size: CONFIG.CACHE.VIDEO_CAPTIONS.SIZE
 269       }
 270     },
 271     signup: {
 272       enabled: CONFIG.SIGNUP.ENABLED,
 273       limit: CONFIG.SIGNUP.LIMIT,
 274       requiresEmailVerification: CONFIG.SIGNUP.REQUIRES_EMAIL_VERIFICATION
 275     },
 276     admin: {
 277       email: CONFIG.ADMIN.EMAIL
 278     },
 279     contactForm: {
 280       enabled: CONFIG.CONTACT_FORM.ENABLED
 281     },
 282     user: {
 283       videoQuota: CONFIG.USER.VIDEO_QUOTA,
 284       videoQuotaDaily: CONFIG.USER.VIDEO_QUOTA_DAILY
 285     },
 286     transcoding: {
 287       enabled: CONFIG.TRANSCODING.ENABLED,
 288       allowAdditionalExtensions: CONFIG.TRANSCODING.ALLOW_ADDITIONAL_EXTENSIONS,
 289       allowAudioFiles: CONFIG.TRANSCODING.ALLOW_AUDIO_FILES,
 290       threads: CONFIG.TRANSCODING.THREADS,
 291       resolutions: {
 292         '240p': CONFIG.TRANSCODING.RESOLUTIONS[ '240p' ],
 293         '360p': CONFIG.TRANSCODING.RESOLUTIONS[ '360p' ],
 294         '480p': CONFIG.TRANSCODING.RESOLUTIONS[ '480p' ],
 295         '720p': CONFIG.TRANSCODING.RESOLUTIONS[ '720p' ],
 296         '1080p': CONFIG.TRANSCODING.RESOLUTIONS[ '1080p' ],
 297         '2160p': CONFIG.TRANSCODING.RESOLUTIONS[ '2160p' ]
 298       },
 299       hls: {
 300         enabled: CONFIG.TRANSCODING.HLS.ENABLED
 301       }
 302     },
 303     import: {
 304       videos: {
 305         http: {
 306           enabled: CONFIG.IMPORT.VIDEOS.HTTP.ENABLED
 307         },
 308         torrent: {
 309           enabled: CONFIG.IMPORT.VIDEOS.TORRENT.ENABLED
 310         }
 311       }
 312     },
 313     autoBlacklist: {
 314       videos: {
 315         ofUsers: {
 316           enabled: CONFIG.AUTO_BLACKLIST.VIDEOS.OF_USERS.ENABLED
 317         }
 318       }
 319     },
 320     followers: {
 321       instance: {
 322         enabled: CONFIG.FOLLOWERS.INSTANCE.ENABLED,
 323         manualApproval: CONFIG.FOLLOWERS.INSTANCE.MANUAL_APPROVAL
 324       }
 325     }
 326   }
 327 }
 328
 329 function convertCustomConfigBody (body: CustomConfig) {
 330   function keyConverter (k: string) {
 331     // Transcoding resolutions exception
 332     if (/^\d{3,4}p$/.exec(k)) return k
 333
 334     return snakeCase(k)
 335   }
 336
 337   function valueConverter (v: any) {
 338     if (isNumeric(v + '')) return parseInt('' + v, 10)
 339
 340     return v
 341   }
 342
 343   return objectConverter(body, keyConverter, valueConverter)
 344 }