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