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