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