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       creationReason: CONFIG.INSTANCE.CREATION_REASON,
 165       moderationInformation: CONFIG.INSTANCE.MODERATION_INFORMATION,
 166       administrator: CONFIG.INSTANCE.ADMINISTRATOR,
 167       maintenanceLifetime: CONFIG.INSTANCE.MAINTENANCE_LIFETIME,
 168       businessModel: CONFIG.INSTANCE.BUSINESS_MODEL,
 169
 170       languages: CONFIG.INSTANCE.LANGUAGES,
 171       categories: CONFIG.INSTANCE.CATEGORIES
 172     }
 173   }
 174
 175   return res.json(about).end()
 176 }
 177
 178 async function getCustomConfig (req: express.Request, res: express.Response) {
 179   const data = customConfig()
 180
 181   return res.json(data).end()
 182 }
 183
 184 async function deleteCustomConfig (req: express.Request, res: express.Response) {
 185   await remove(CONFIG.CUSTOM_FILE)
 186
 187   auditLogger.delete(getAuditIdFromRes(res), new CustomConfigAuditView(customConfig()))
 188
 189   reloadConfig()
 190   ClientHtml.invalidCache()
 191
 192   const data = customConfig()
 193
 194   return res.json(data).end()
 195 }
 196
 197 async function updateCustomConfig (req: express.Request, res: express.Response) {
 198   const oldCustomConfigAuditKeys = new CustomConfigAuditView(customConfig())
 199
 200   // camelCase to snake_case key + Force number conversion
 201   const toUpdateJSON = convertCustomConfigBody(req.body)
 202
 203   await writeJSON(CONFIG.CUSTOM_FILE, toUpdateJSON, { spaces: 2 })
 204
 205   reloadConfig()
 206   ClientHtml.invalidCache()
 207
 208   const data = customConfig()
 209
 210   auditLogger.update(
 211     getAuditIdFromRes(res),
 212     new CustomConfigAuditView(data),
 213     oldCustomConfigAuditKeys
 214   )
 215
 216   return res.json(data).end()
 217 }
 218
 219 // ---------------------------------------------------------------------------
 220
 221 export {
 222   configRouter
 223 }
 224
 225 // ---------------------------------------------------------------------------
 226
 227 function customConfig (): CustomConfig {
 228   return {
 229     instance: {
 230       name: CONFIG.INSTANCE.NAME,
 231       shortDescription: CONFIG.INSTANCE.SHORT_DESCRIPTION,
 232       description: CONFIG.INSTANCE.DESCRIPTION,
 233       terms: CONFIG.INSTANCE.TERMS,
 234       codeOfConduct: CONFIG.INSTANCE.CODE_OF_CONDUCT,
 235
 236       creationReason: CONFIG.INSTANCE.CREATION_REASON,
 237       moderationInformation: CONFIG.INSTANCE.MODERATION_INFORMATION,
 238       administrator: CONFIG.INSTANCE.ADMINISTRATOR,
 239       maintenanceLifetime: CONFIG.INSTANCE.MAINTENANCE_LIFETIME,
 240       businessModel: CONFIG.INSTANCE.BUSINESS_MODEL,
 241
 242       languages: CONFIG.INSTANCE.LANGUAGES,
 243       categories: CONFIG.INSTANCE.CATEGORIES,
 244
 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     followings: {
 326       instance: {
 327         autoFollowBack: {
 328           enabled: CONFIG.FOLLOWINGS.INSTANCE.AUTO_FOLLOW_BACK.ENABLED
 329         },
 330
 331         autoFollowIndex: {
 332           enabled: CONFIG.FOLLOWINGS.INSTANCE.AUTO_FOLLOW_INDEX.ENABLED,
 333           indexUrl: CONFIG.FOLLOWINGS.INSTANCE.AUTO_FOLLOW_INDEX.INDEX_URL
 334         }
 335       }
 336     }
 337   }
 338 }
 339
 340 function convertCustomConfigBody (body: CustomConfig) {
 341   function keyConverter (k: string) {
 342     // Transcoding resolutions exception
 343     if (/^\d{3,4}p$/.exec(k)) return k
 344
 345     return snakeCase(k)
 346   }
 347
 348   function valueConverter (v: any) {
 349     if (isNumeric(v + '')) return parseInt('' + v, 10)
 350
 351     return v
 352   }
 353
 354   return objectConverter(body, keyConverter, valueConverter)
 355 }
 356
 357 function getRegisteredThemes () {
 358   return PluginManager.Instance.getRegisteredThemes()
 359                       .map(t => ({
 360                         name: t.name,
 361                         version: t.version,
 362                         description: t.description,
 363                         css: t.css,
 364                         clientScripts: t.clientScripts
 365                       }))
 366 }
 367
 368 function getEnabledResolutions () {
 369   return Object.keys(CONFIG.TRANSCODING.RESOLUTIONS)
 370                .filter(key => CONFIG.TRANSCODING.ENABLED && CONFIG.TRANSCODING.RESOLUTIONS[ key ] === true)
 371                .map(r => parseInt(r, 10))
 372 }
 373
 374 function getRegisteredPlugins () {
 375   return PluginManager.Instance.getRegisteredPlugins()
 376                       .map(p => ({
 377                         name: p.name,
 378                         version: p.version,
 379                         description: p.description,
 380                         clientScripts: p.clientScripts
 381                       }))
 382 }