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