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 } 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
  19 const packageJSON = require('../../../../package.json')
  20 const configRouter = express.Router()
  21
  22 const auditLogger = auditLoggerFactory('config')
  23
  24 configRouter.get('/about', getAbout)
  25 configRouter.get('/',
  26   asyncMiddleware(getConfig)
  27 )
  28
  29 configRouter.get('/custom',
  30   authenticate,
  31   ensureUserHasRight(UserRight.MANAGE_CONFIGURATION),
  32   asyncMiddleware(getCustomConfig)
  33 )
  34 configRouter.put('/custom',
  35   authenticate,
  36   ensureUserHasRight(UserRight.MANAGE_CONFIGURATION),
  37   asyncMiddleware(customConfigUpdateValidator),
  38   asyncMiddleware(updateCustomConfig)
  39 )
  40 configRouter.delete('/custom',
  41   authenticate,
  42   ensureUserHasRight(UserRight.MANAGE_CONFIGURATION),
  43   asyncMiddleware(deleteCustomConfig)
  44 )
  45
  46 let serverCommit: string
  47 async function getConfig (req: express.Request, res: express.Response) {
  48   const allowed = await isSignupAllowed()
  49   const allowedForCurrentIP = isSignupAllowedForCurrentIP(req.ip)
  50
  51   if (serverCommit === undefined) serverCommit = await getServerCommit()
  52
  53   const enabledResolutions = Object.keys(CONFIG.TRANSCODING.RESOLUTIONS)
  54    .filter(key => CONFIG.TRANSCODING.ENABLED === CONFIG.TRANSCODING.RESOLUTIONS[key] === true)
  55    .map(r => parseInt(r, 10))
  56
  57   const json: ServerConfig = {
  58     instance: {
  59       name: CONFIG.INSTANCE.NAME,
  60       shortDescription: CONFIG.INSTANCE.SHORT_DESCRIPTION,
  61       defaultClientRoute: CONFIG.INSTANCE.DEFAULT_CLIENT_ROUTE,
  62       isNSFW: CONFIG.INSTANCE.IS_NSFW,
  63       defaultNSFWPolicy: CONFIG.INSTANCE.DEFAULT_NSFW_POLICY,
  64       customizations: {
  65         javascript: CONFIG.INSTANCE.CUSTOMIZATIONS.JAVASCRIPT,
  66         css: CONFIG.INSTANCE.CUSTOMIZATIONS.CSS
  67       }
  68     },
  69     email: {
  70       enabled: Emailer.isEnabled()
  71     },
  72     contactForm: {
  73       enabled: CONFIG.CONTACT_FORM.ENABLED
  74     },
  75     serverVersion: packageJSON.version,
  76     serverCommit,
  77     signup: {
  78       allowed,
  79       allowedForCurrentIP,
  80       requiresEmailVerification: CONFIG.SIGNUP.REQUIRES_EMAIL_VERIFICATION
  81     },
  82     transcoding: {
  83       hls: {
  84         enabled: CONFIG.TRANSCODING.HLS.ENABLED
  85       },
  86       enabledResolutions
  87     },
  88     import: {
  89       videos: {
  90         http: {
  91           enabled: CONFIG.IMPORT.VIDEOS.HTTP.ENABLED
  92         },
  93         torrent: {
  94           enabled: CONFIG.IMPORT.VIDEOS.TORRENT.ENABLED
  95         }
  96       }
  97     },
  98     autoBlacklist: {
  99       videos: {
 100         ofUsers: {
 101           enabled: CONFIG.AUTO_BLACKLIST.VIDEOS.OF_USERS.ENABLED
 102         }
 103       }
 104     },
 105     avatar: {
 106       file: {
 107         size: {
 108           max: CONSTRAINTS_FIELDS.ACTORS.AVATAR.FILE_SIZE.max
 109         },
 110         extensions: CONSTRAINTS_FIELDS.ACTORS.AVATAR.EXTNAME
 111       }
 112     },
 113     video: {
 114       image: {
 115         extensions: CONSTRAINTS_FIELDS.VIDEOS.IMAGE.EXTNAME,
 116         size: {
 117           max: CONSTRAINTS_FIELDS.VIDEOS.IMAGE.FILE_SIZE.max
 118         }
 119       },
 120       file: {
 121         extensions: CONSTRAINTS_FIELDS.VIDEOS.EXTNAME
 122       }
 123     },
 124     videoCaption: {
 125       file: {
 126         size: {
 127           max: CONSTRAINTS_FIELDS.VIDEO_CAPTIONS.CAPTION_FILE.FILE_SIZE.max
 128         },
 129         extensions: CONSTRAINTS_FIELDS.VIDEO_CAPTIONS.CAPTION_FILE.EXTNAME
 130       }
 131     },
 132     user: {
 133       videoQuota: CONFIG.USER.VIDEO_QUOTA,
 134       videoQuotaDaily: CONFIG.USER.VIDEO_QUOTA_DAILY
 135     },
 136     trending: {
 137       videos: {
 138         intervalDays: CONFIG.TRENDING.VIDEOS.INTERVAL_DAYS
 139       }
 140     },
 141     tracker: {
 142       enabled: CONFIG.TRACKER.ENABLED
 143     }
 144   }
 145
 146   return res.json(json)
 147 }
 148
 149 function getAbout (req: express.Request, res: express.Response) {
 150   const about: About = {
 151     instance: {
 152       name: CONFIG.INSTANCE.NAME,
 153       shortDescription: CONFIG.INSTANCE.SHORT_DESCRIPTION,
 154       description: CONFIG.INSTANCE.DESCRIPTION,
 155       terms: CONFIG.INSTANCE.TERMS
 156     }
 157   }
 158
 159   return res.json(about).end()
 160 }
 161
 162 async function getCustomConfig (req: express.Request, res: express.Response) {
 163   const data = customConfig()
 164
 165   return res.json(data).end()
 166 }
 167
 168 async function deleteCustomConfig (req: express.Request, res: express.Response) {
 169   await remove(CONFIG.CUSTOM_FILE)
 170
 171   auditLogger.delete(getAuditIdFromRes(res), new CustomConfigAuditView(customConfig()))
 172
 173   reloadConfig()
 174   ClientHtml.invalidCache()
 175
 176   const data = customConfig()
 177
 178   return res.json(data).end()
 179 }
 180
 181 async function updateCustomConfig (req: express.Request, res: express.Response) {
 182   const oldCustomConfigAuditKeys = new CustomConfigAuditView(customConfig())
 183
 184   // camelCase to snake_case key + Force number conversion
 185   const toUpdateJSON = convertCustomConfigBody(req.body)
 186
 187   await writeJSON(CONFIG.CUSTOM_FILE, toUpdateJSON, { spaces: 2 })
 188
 189   reloadConfig()
 190   ClientHtml.invalidCache()
 191
 192   const data = customConfig()
 193
 194   auditLogger.update(
 195     getAuditIdFromRes(res),
 196     new CustomConfigAuditView(data),
 197     oldCustomConfigAuditKeys
 198   )
 199
 200   return res.json(data).end()
 201 }
 202
 203 // ---------------------------------------------------------------------------
 204
 205 export {
 206   configRouter
 207 }
 208
 209 // ---------------------------------------------------------------------------
 210
 211 function customConfig (): CustomConfig {
 212   return {
 213     instance: {
 214       name: CONFIG.INSTANCE.NAME,
 215       shortDescription: CONFIG.INSTANCE.SHORT_DESCRIPTION,
 216       description: CONFIG.INSTANCE.DESCRIPTION,
 217       terms: CONFIG.INSTANCE.TERMS,
 218       isNSFW: CONFIG.INSTANCE.IS_NSFW,
 219       defaultClientRoute: CONFIG.INSTANCE.DEFAULT_CLIENT_ROUTE,
 220       defaultNSFWPolicy: CONFIG.INSTANCE.DEFAULT_NSFW_POLICY,
 221       customizations: {
 222         css: CONFIG.INSTANCE.CUSTOMIZATIONS.CSS,
 223         javascript: CONFIG.INSTANCE.CUSTOMIZATIONS.JAVASCRIPT
 224       }
 225     },
 226     services: {
 227       twitter: {
 228         username: CONFIG.SERVICES.TWITTER.USERNAME,
 229         whitelisted: CONFIG.SERVICES.TWITTER.WHITELISTED
 230       }
 231     },
 232     cache: {
 233       previews: {
 234         size: CONFIG.CACHE.PREVIEWS.SIZE
 235       },
 236       captions: {
 237         size: CONFIG.CACHE.VIDEO_CAPTIONS.SIZE
 238       }
 239     },
 240     signup: {
 241       enabled: CONFIG.SIGNUP.ENABLED,
 242       limit: CONFIG.SIGNUP.LIMIT,
 243       requiresEmailVerification: CONFIG.SIGNUP.REQUIRES_EMAIL_VERIFICATION
 244     },
 245     admin: {
 246       email: CONFIG.ADMIN.EMAIL
 247     },
 248     contactForm: {
 249       enabled: CONFIG.CONTACT_FORM.ENABLED
 250     },
 251     user: {
 252       videoQuota: CONFIG.USER.VIDEO_QUOTA,
 253       videoQuotaDaily: CONFIG.USER.VIDEO_QUOTA_DAILY
 254     },
 255     transcoding: {
 256       enabled: CONFIG.TRANSCODING.ENABLED,
 257       allowAdditionalExtensions: CONFIG.TRANSCODING.ALLOW_ADDITIONAL_EXTENSIONS,
 258       allowAudioFiles: CONFIG.TRANSCODING.ALLOW_AUDIO_FILES,
 259       threads: CONFIG.TRANSCODING.THREADS,
 260       resolutions: {
 261         '240p': CONFIG.TRANSCODING.RESOLUTIONS[ '240p' ],
 262         '360p': CONFIG.TRANSCODING.RESOLUTIONS[ '360p' ],
 263         '480p': CONFIG.TRANSCODING.RESOLUTIONS[ '480p' ],
 264         '720p': CONFIG.TRANSCODING.RESOLUTIONS[ '720p' ],
 265         '1080p': CONFIG.TRANSCODING.RESOLUTIONS[ '1080p' ]
 266       },
 267       hls: {
 268         enabled: CONFIG.TRANSCODING.HLS.ENABLED
 269       }
 270     },
 271     import: {
 272       videos: {
 273         http: {
 274           enabled: CONFIG.IMPORT.VIDEOS.HTTP.ENABLED
 275         },
 276         torrent: {
 277           enabled: CONFIG.IMPORT.VIDEOS.TORRENT.ENABLED
 278         }
 279       }
 280     },
 281     autoBlacklist: {
 282       videos: {
 283         ofUsers: {
 284           enabled: CONFIG.AUTO_BLACKLIST.VIDEOS.OF_USERS.ENABLED
 285         }
 286       }
 287     },
 288     followers: {
 289       instance: {
 290         enabled: CONFIG.FOLLOWERS.INSTANCE.ENABLED,
 291         manualApproval: CONFIG.FOLLOWERS.INSTANCE.MANUAL_APPROVAL
 292       }
 293     }
 294   }
 295 }
 296
 297 function convertCustomConfigBody (body: CustomConfig) {
 298   function keyConverter (k: string) {
 299     // Transcoding resolutions exception
 300     if (/^\d{3,4}p$/.exec(k)) return k
 301
 302     return snakeCase(k)
 303   }
 304
 305   function valueConverter (v: any) {
 306     if (isNumeric(v + '')) return parseInt('' + v, 10)
 307
 308     return v
 309   }
 310
 311   return objectConverter(body, keyConverter, valueConverter)
 312 }