server/controllers/api/config.ts

   1 import * as express from 'express'
   2 import { omit } 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 { CONFIG, CONSTRAINTS_FIELDS, reloadConfig } from '../../initializers'
   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 } from '../../helpers/audit-logger'
  12 import { remove, writeJSON } from 'fs-extra'
  13
  14 const packageJSON = require('../../../../package.json')
  15 const configRouter = express.Router()
  16
  17 const auditLogger = auditLoggerFactory('config')
  18
  19 configRouter.get('/about', getAbout)
  20 configRouter.get('/',
  21   asyncMiddleware(getConfig)
  22 )
  23
  24 configRouter.get('/custom',
  25   authenticate,
  26   ensureUserHasRight(UserRight.MANAGE_CONFIGURATION),
  27   asyncMiddleware(getCustomConfig)
  28 )
  29 configRouter.put('/custom',
  30   authenticate,
  31   ensureUserHasRight(UserRight.MANAGE_CONFIGURATION),
  32   asyncMiddleware(customConfigUpdateValidator),
  33   asyncMiddleware(updateCustomConfig)
  34 )
  35 configRouter.delete('/custom',
  36   authenticate,
  37   ensureUserHasRight(UserRight.MANAGE_CONFIGURATION),
  38   asyncMiddleware(deleteCustomConfig)
  39 )
  40
  41 async function getConfig (req: express.Request, res: express.Response, next: express.NextFunction) {
  42   const allowed = await isSignupAllowed()
  43   const allowedForCurrentIP = isSignupAllowedForCurrentIP(req.ip)
  44
  45   const enabledResolutions = Object.keys(CONFIG.TRANSCODING.RESOLUTIONS)
  46    .filter(key => CONFIG.TRANSCODING.RESOLUTIONS[key] === true)
  47    .map(r => parseInt(r, 10))
  48
  49   const json: ServerConfig = {
  50     instance: {
  51       name: CONFIG.INSTANCE.NAME,
  52       shortDescription: CONFIG.INSTANCE.SHORT_DESCRIPTION,
  53       defaultClientRoute: CONFIG.INSTANCE.DEFAULT_CLIENT_ROUTE,
  54       defaultNSFWPolicy: CONFIG.INSTANCE.DEFAULT_NSFW_POLICY,
  55       customizations: {
  56         javascript: CONFIG.INSTANCE.CUSTOMIZATIONS.JAVASCRIPT,
  57         css: CONFIG.INSTANCE.CUSTOMIZATIONS.CSS
  58       }
  59     },
  60     serverVersion: packageJSON.version,
  61     signup: {
  62       allowed,
  63       allowedForCurrentIP
  64     },
  65     transcoding: {
  66       enabledResolutions
  67     },
  68     import: {
  69       videos: {
  70         http: {
  71           enabled: CONFIG.IMPORT.VIDEOS.HTTP.ENABLED
  72         },
  73         torrent: {
  74           enabled: CONFIG.IMPORT.VIDEOS.TORRENT.ENABLED
  75         }
  76       }
  77     },
  78     avatar: {
  79       file: {
  80         size: {
  81           max: CONSTRAINTS_FIELDS.ACTORS.AVATAR.FILE_SIZE.max
  82         },
  83         extensions: CONSTRAINTS_FIELDS.ACTORS.AVATAR.EXTNAME
  84       }
  85     },
  86     video: {
  87       image: {
  88         extensions: CONSTRAINTS_FIELDS.VIDEOS.IMAGE.EXTNAME,
  89         size: {
  90           max: CONSTRAINTS_FIELDS.VIDEOS.IMAGE.FILE_SIZE.max
  91         }
  92       },
  93       file: {
  94         extensions: CONSTRAINTS_FIELDS.VIDEOS.EXTNAME
  95       }
  96     },
  97     videoCaption: {
  98       file: {
  99         size: {
 100           max: CONSTRAINTS_FIELDS.VIDEO_CAPTIONS.CAPTION_FILE.FILE_SIZE.max
 101         },
 102         extensions: CONSTRAINTS_FIELDS.VIDEO_CAPTIONS.CAPTION_FILE.EXTNAME
 103       }
 104     },
 105     user: {
 106       videoQuota: CONFIG.USER.VIDEO_QUOTA,
 107       videoQuotaDaily: CONFIG.USER.VIDEO_QUOTA_DAILY
 108     }
 109   }
 110
 111   return res.json(json)
 112 }
 113
 114 function getAbout (req: express.Request, res: express.Response, next: express.NextFunction) {
 115   const about: About = {
 116     instance: {
 117       name: CONFIG.INSTANCE.NAME,
 118       shortDescription: CONFIG.INSTANCE.SHORT_DESCRIPTION,
 119       description: CONFIG.INSTANCE.DESCRIPTION,
 120       terms: CONFIG.INSTANCE.TERMS
 121     }
 122   }
 123
 124   return res.json(about).end()
 125 }
 126
 127 async function getCustomConfig (req: express.Request, res: express.Response, next: express.NextFunction) {
 128   const data = customConfig()
 129
 130   return res.json(data).end()
 131 }
 132
 133 async function deleteCustomConfig (req: express.Request, res: express.Response, next: express.NextFunction) {
 134   await remove(CONFIG.CUSTOM_FILE)
 135
 136   auditLogger.delete(
 137     res.locals.oauth.token.User.Account.Actor.getIdentifier(),
 138     new CustomConfigAuditView(customConfig())
 139   )
 140
 141   reloadConfig()
 142   ClientHtml.invalidCache()
 143
 144   const data = customConfig()
 145
 146   return res.json(data).end()
 147 }
 148
 149 async function updateCustomConfig (req: express.Request, res: express.Response, next: express.NextFunction) {
 150   const toUpdate: CustomConfig = req.body
 151   const oldCustomConfigAuditKeys = new CustomConfigAuditView(customConfig())
 152
 153   // Force number conversion
 154   toUpdate.cache.previews.size = parseInt('' + toUpdate.cache.previews.size, 10)
 155   toUpdate.cache.captions.size = parseInt('' + toUpdate.cache.captions.size, 10)
 156   toUpdate.signup.limit = parseInt('' + toUpdate.signup.limit, 10)
 157   toUpdate.user.videoQuota = parseInt('' + toUpdate.user.videoQuota, 10)
 158   toUpdate.user.videoQuotaDaily = parseInt('' + toUpdate.user.videoQuotaDaily, 10)
 159   toUpdate.transcoding.threads = parseInt('' + toUpdate.transcoding.threads, 10)
 160
 161   // camelCase to snake_case key
 162   const toUpdateJSON = omit(toUpdate, 'user.videoQuota', 'instance.defaultClientRoute', 'instance.shortDescription', 'cache.videoCaptions')
 163   toUpdateJSON.user['video_quota'] = toUpdate.user.videoQuota
 164   toUpdateJSON.instance['default_client_route'] = toUpdate.instance.defaultClientRoute
 165   toUpdateJSON.instance['short_description'] = toUpdate.instance.shortDescription
 166   toUpdateJSON.instance['default_nsfw_policy'] = toUpdate.instance.defaultNSFWPolicy
 167
 168   await writeJSON(CONFIG.CUSTOM_FILE, toUpdateJSON, { spaces: 2 })
 169
 170   reloadConfig()
 171   ClientHtml.invalidCache()
 172
 173   const data = customConfig()
 174
 175   auditLogger.update(
 176     res.locals.oauth.token.User.Account.Actor.getIdentifier(),
 177     new CustomConfigAuditView(data),
 178     oldCustomConfigAuditKeys
 179   )
 180
 181   return res.json(data).end()
 182 }
 183
 184 // ---------------------------------------------------------------------------
 185
 186 export {
 187   configRouter
 188 }
 189
 190 // ---------------------------------------------------------------------------
 191
 192 function customConfig (): CustomConfig {
 193   return {
 194     instance: {
 195       name: CONFIG.INSTANCE.NAME,
 196       shortDescription: CONFIG.INSTANCE.SHORT_DESCRIPTION,
 197       description: CONFIG.INSTANCE.DESCRIPTION,
 198       terms: CONFIG.INSTANCE.TERMS,
 199       defaultClientRoute: CONFIG.INSTANCE.DEFAULT_CLIENT_ROUTE,
 200       defaultNSFWPolicy: CONFIG.INSTANCE.DEFAULT_NSFW_POLICY,
 201       customizations: {
 202         css: CONFIG.INSTANCE.CUSTOMIZATIONS.CSS,
 203         javascript: CONFIG.INSTANCE.CUSTOMIZATIONS.JAVASCRIPT
 204       }
 205     },
 206     services: {
 207       twitter: {
 208         username: CONFIG.SERVICES.TWITTER.USERNAME,
 209         whitelisted: CONFIG.SERVICES.TWITTER.WHITELISTED
 210       }
 211     },
 212     cache: {
 213       previews: {
 214         size: CONFIG.CACHE.PREVIEWS.SIZE
 215       },
 216       captions: {
 217         size: CONFIG.CACHE.VIDEO_CAPTIONS.SIZE
 218       }
 219     },
 220     signup: {
 221       enabled: CONFIG.SIGNUP.ENABLED,
 222       limit: CONFIG.SIGNUP.LIMIT
 223     },
 224     admin: {
 225       email: CONFIG.ADMIN.EMAIL
 226     },
 227     user: {
 228       videoQuota: CONFIG.USER.VIDEO_QUOTA,
 229       videoQuotaDaily: CONFIG.USER.VIDEO_QUOTA_DAILY
 230     },
 231     transcoding: {
 232       enabled: CONFIG.TRANSCODING.ENABLED,
 233       threads: CONFIG.TRANSCODING.THREADS,
 234       resolutions: {
 235         '240p': CONFIG.TRANSCODING.RESOLUTIONS[ '240p' ],
 236         '360p': CONFIG.TRANSCODING.RESOLUTIONS[ '360p' ],
 237         '480p': CONFIG.TRANSCODING.RESOLUTIONS[ '480p' ],
 238         '720p': CONFIG.TRANSCODING.RESOLUTIONS[ '720p' ],
 239         '1080p': CONFIG.TRANSCODING.RESOLUTIONS[ '1080p' ]
 240       }
 241     },
 242     import: {
 243       videos: {
 244         http: {
 245           enabled: CONFIG.IMPORT.VIDEOS.HTTP.ENABLED
 246         },
 247         torrent: {
 248           enabled: CONFIG.IMPORT.VIDEOS.TORRENT.ENABLED
 249         }
 250       }
 251     }
 252   }
 253 }