server/controllers/api/config.ts

   1 import express from 'express'
   2 import { remove, writeJSON } from 'fs-extra'
   3 import { snakeCase } from 'lodash'
   4 import validator from 'validator'
   5 import { ServerConfigManager } from '@server/lib/server-config-manager'
   6 import { UserRight } from '../../../shared'
   7 import { About } from '../../../shared/models/server/about.model'
   8 import { CustomConfig } from '../../../shared/models/server/custom-config.model'
   9 import { auditLoggerFactory, CustomConfigAuditView, getAuditIdFromRes } from '../../helpers/audit-logger'
  10 import { objectConverter } from '../../helpers/core-utils'
  11 import { CONFIG, reloadConfig } from '../../initializers/config'
  12 import { ClientHtml } from '../../lib/client-html'
  13 import { asyncMiddleware, authenticate, ensureUserHasRight, openapiOperationDoc } from '../../middlewares'
  14 import { customConfigUpdateValidator, ensureConfigIsEditable } from '../../middlewares/validators/config'
  15
  16 const configRouter = express.Router()
  17
  18 const auditLogger = auditLoggerFactory('config')
  19
  20 configRouter.get('/',
  21   openapiOperationDoc({ operationId: 'getConfig' }),
  22   asyncMiddleware(getConfig)
  23 )
  24
  25 configRouter.get('/about',
  26   openapiOperationDoc({ operationId: 'getAbout' }),
  27   getAbout
  28 )
  29
  30 configRouter.get('/custom',
  31   openapiOperationDoc({ operationId: 'getCustomConfig' }),
  32   authenticate,
  33   ensureUserHasRight(UserRight.MANAGE_CONFIGURATION),
  34   getCustomConfig
  35 )
  36
  37 configRouter.put('/custom',
  38   openapiOperationDoc({ operationId: 'putCustomConfig' }),
  39   authenticate,
  40   ensureUserHasRight(UserRight.MANAGE_CONFIGURATION),
  41   ensureConfigIsEditable,
  42   customConfigUpdateValidator,
  43   asyncMiddleware(updateCustomConfig)
  44 )
  45
  46 configRouter.delete('/custom',
  47   openapiOperationDoc({ operationId: 'delCustomConfig' }),
  48   authenticate,
  49   ensureUserHasRight(UserRight.MANAGE_CONFIGURATION),
  50   ensureConfigIsEditable,
  51   asyncMiddleware(deleteCustomConfig)
  52 )
  53
  54 async function getConfig (req: express.Request, res: express.Response) {
  55   const json = await ServerConfigManager.Instance.getServerConfig(req.ip)
  56
  57   return res.json(json)
  58 }
  59
  60 function getAbout (req: express.Request, res: express.Response) {
  61   const about: About = {
  62     instance: {
  63       name: CONFIG.INSTANCE.NAME,
  64       shortDescription: CONFIG.INSTANCE.SHORT_DESCRIPTION,
  65       description: CONFIG.INSTANCE.DESCRIPTION,
  66       terms: CONFIG.INSTANCE.TERMS,
  67       codeOfConduct: CONFIG.INSTANCE.CODE_OF_CONDUCT,
  68
  69       hardwareInformation: CONFIG.INSTANCE.HARDWARE_INFORMATION,
  70
  71       creationReason: CONFIG.INSTANCE.CREATION_REASON,
  72       moderationInformation: CONFIG.INSTANCE.MODERATION_INFORMATION,
  73       administrator: CONFIG.INSTANCE.ADMINISTRATOR,
  74       maintenanceLifetime: CONFIG.INSTANCE.MAINTENANCE_LIFETIME,
  75       businessModel: CONFIG.INSTANCE.BUSINESS_MODEL,
  76
  77       languages: CONFIG.INSTANCE.LANGUAGES,
  78       categories: CONFIG.INSTANCE.CATEGORIES
  79     }
  80   }
  81
  82   return res.json(about)
  83 }
  84
  85 function getCustomConfig (req: express.Request, res: express.Response) {
  86   const data = customConfig()
  87
  88   return res.json(data)
  89 }
  90
  91 async function deleteCustomConfig (req: express.Request, res: express.Response) {
  92   await remove(CONFIG.CUSTOM_FILE)
  93
  94   auditLogger.delete(getAuditIdFromRes(res), new CustomConfigAuditView(customConfig()))
  95
  96   reloadConfig()
  97   ClientHtml.invalidCache()
  98
  99   const data = customConfig()
 100
 101   return res.json(data)
 102 }
 103
 104 async function updateCustomConfig (req: express.Request, res: express.Response) {
 105   const oldCustomConfigAuditKeys = new CustomConfigAuditView(customConfig())
 106
 107   // camelCase to snake_case key + Force number conversion
 108   const toUpdateJSON = convertCustomConfigBody(req.body)
 109
 110   await writeJSON(CONFIG.CUSTOM_FILE, toUpdateJSON, { spaces: 2 })
 111
 112   reloadConfig()
 113   ClientHtml.invalidCache()
 114
 115   const data = customConfig()
 116
 117   auditLogger.update(
 118     getAuditIdFromRes(res),
 119     new CustomConfigAuditView(data),
 120     oldCustomConfigAuditKeys
 121   )
 122
 123   return res.json(data)
 124 }
 125
 126 // ---------------------------------------------------------------------------
 127
 128 export {
 129   configRouter
 130 }
 131
 132 // ---------------------------------------------------------------------------
 133
 134 function customConfig (): CustomConfig {
 135   return {
 136     instance: {
 137       name: CONFIG.INSTANCE.NAME,
 138       shortDescription: CONFIG.INSTANCE.SHORT_DESCRIPTION,
 139       description: CONFIG.INSTANCE.DESCRIPTION,
 140       terms: CONFIG.INSTANCE.TERMS,
 141       codeOfConduct: CONFIG.INSTANCE.CODE_OF_CONDUCT,
 142
 143       creationReason: CONFIG.INSTANCE.CREATION_REASON,
 144       moderationInformation: CONFIG.INSTANCE.MODERATION_INFORMATION,
 145       administrator: CONFIG.INSTANCE.ADMINISTRATOR,
 146       maintenanceLifetime: CONFIG.INSTANCE.MAINTENANCE_LIFETIME,
 147       businessModel: CONFIG.INSTANCE.BUSINESS_MODEL,
 148       hardwareInformation: CONFIG.INSTANCE.HARDWARE_INFORMATION,
 149
 150       languages: CONFIG.INSTANCE.LANGUAGES,
 151       categories: CONFIG.INSTANCE.CATEGORIES,
 152
 153       isNSFW: CONFIG.INSTANCE.IS_NSFW,
 154       defaultNSFWPolicy: CONFIG.INSTANCE.DEFAULT_NSFW_POLICY,
 155
 156       defaultClientRoute: CONFIG.INSTANCE.DEFAULT_CLIENT_ROUTE,
 157
 158       customizations: {
 159         css: CONFIG.INSTANCE.CUSTOMIZATIONS.CSS,
 160         javascript: CONFIG.INSTANCE.CUSTOMIZATIONS.JAVASCRIPT
 161       }
 162     },
 163     theme: {
 164       default: CONFIG.THEME.DEFAULT
 165     },
 166     services: {
 167       twitter: {
 168         username: CONFIG.SERVICES.TWITTER.USERNAME,
 169         whitelisted: CONFIG.SERVICES.TWITTER.WHITELISTED
 170       }
 171     },
 172     client: {
 173       videos: {
 174         miniature: {
 175           preferAuthorDisplayName: CONFIG.CLIENT.VIDEOS.MINIATURE.PREFER_AUTHOR_DISPLAY_NAME
 176         }
 177       },
 178       menu: {
 179         login: {
 180           redirectOnSingleExternalAuth: CONFIG.CLIENT.MENU.LOGIN.REDIRECT_ON_SINGLE_EXTERNAL_AUTH
 181         }
 182       }
 183     },
 184     cache: {
 185       previews: {
 186         size: CONFIG.CACHE.PREVIEWS.SIZE
 187       },
 188       captions: {
 189         size: CONFIG.CACHE.VIDEO_CAPTIONS.SIZE
 190       },
 191       torrents: {
 192         size: CONFIG.CACHE.TORRENTS.SIZE
 193       }
 194     },
 195     signup: {
 196       enabled: CONFIG.SIGNUP.ENABLED,
 197       limit: CONFIG.SIGNUP.LIMIT,
 198       requiresEmailVerification: CONFIG.SIGNUP.REQUIRES_EMAIL_VERIFICATION,
 199       minimumAge: CONFIG.SIGNUP.MINIMUM_AGE
 200     },
 201     admin: {
 202       email: CONFIG.ADMIN.EMAIL
 203     },
 204     contactForm: {
 205       enabled: CONFIG.CONTACT_FORM.ENABLED
 206     },
 207     user: {
 208       videoQuota: CONFIG.USER.VIDEO_QUOTA,
 209       videoQuotaDaily: CONFIG.USER.VIDEO_QUOTA_DAILY
 210     },
 211     videoChannels: {
 212       maxPerUser: CONFIG.VIDEO_CHANNELS.MAX_PER_USER
 213     },
 214     transcoding: {
 215       enabled: CONFIG.TRANSCODING.ENABLED,
 216       allowAdditionalExtensions: CONFIG.TRANSCODING.ALLOW_ADDITIONAL_EXTENSIONS,
 217       allowAudioFiles: CONFIG.TRANSCODING.ALLOW_AUDIO_FILES,
 218       threads: CONFIG.TRANSCODING.THREADS,
 219       concurrency: CONFIG.TRANSCODING.CONCURRENCY,
 220       profile: CONFIG.TRANSCODING.PROFILE,
 221       resolutions: {
 222         '0p': CONFIG.TRANSCODING.RESOLUTIONS['0p'],
 223         '144p': CONFIG.TRANSCODING.RESOLUTIONS['144p'],
 224         '240p': CONFIG.TRANSCODING.RESOLUTIONS['240p'],
 225         '360p': CONFIG.TRANSCODING.RESOLUTIONS['360p'],
 226         '480p': CONFIG.TRANSCODING.RESOLUTIONS['480p'],
 227         '720p': CONFIG.TRANSCODING.RESOLUTIONS['720p'],
 228         '1080p': CONFIG.TRANSCODING.RESOLUTIONS['1080p'],
 229         '1440p': CONFIG.TRANSCODING.RESOLUTIONS['1440p'],
 230         '2160p': CONFIG.TRANSCODING.RESOLUTIONS['2160p']
 231       },
 232       webtorrent: {
 233         enabled: CONFIG.TRANSCODING.WEBTORRENT.ENABLED
 234       },
 235       hls: {
 236         enabled: CONFIG.TRANSCODING.HLS.ENABLED
 237       }
 238     },
 239     live: {
 240       enabled: CONFIG.LIVE.ENABLED,
 241       allowReplay: CONFIG.LIVE.ALLOW_REPLAY,
 242       maxDuration: CONFIG.LIVE.MAX_DURATION,
 243       maxInstanceLives: CONFIG.LIVE.MAX_INSTANCE_LIVES,
 244       maxUserLives: CONFIG.LIVE.MAX_USER_LIVES,
 245       transcoding: {
 246         enabled: CONFIG.LIVE.TRANSCODING.ENABLED,
 247         threads: CONFIG.LIVE.TRANSCODING.THREADS,
 248         profile: CONFIG.LIVE.TRANSCODING.PROFILE,
 249         resolutions: {
 250           '144p': CONFIG.LIVE.TRANSCODING.RESOLUTIONS['144p'],
 251           '240p': CONFIG.LIVE.TRANSCODING.RESOLUTIONS['240p'],
 252           '360p': CONFIG.LIVE.TRANSCODING.RESOLUTIONS['360p'],
 253           '480p': CONFIG.LIVE.TRANSCODING.RESOLUTIONS['480p'],
 254           '720p': CONFIG.LIVE.TRANSCODING.RESOLUTIONS['720p'],
 255           '1080p': CONFIG.LIVE.TRANSCODING.RESOLUTIONS['1080p'],
 256           '1440p': CONFIG.LIVE.TRANSCODING.RESOLUTIONS['1440p'],
 257           '2160p': CONFIG.LIVE.TRANSCODING.RESOLUTIONS['2160p']
 258         }
 259       }
 260     },
 261     import: {
 262       videos: {
 263         concurrency: CONFIG.IMPORT.VIDEOS.CONCURRENCY,
 264         http: {
 265           enabled: CONFIG.IMPORT.VIDEOS.HTTP.ENABLED
 266         },
 267         torrent: {
 268           enabled: CONFIG.IMPORT.VIDEOS.TORRENT.ENABLED
 269         }
 270       }
 271     },
 272     trending: {
 273       videos: {
 274         algorithms: {
 275           enabled: CONFIG.TRENDING.VIDEOS.ALGORITHMS.ENABLED,
 276           default: CONFIG.TRENDING.VIDEOS.ALGORITHMS.DEFAULT
 277         }
 278       }
 279     },
 280     autoBlacklist: {
 281       videos: {
 282         ofUsers: {
 283           enabled: CONFIG.AUTO_BLACKLIST.VIDEOS.OF_USERS.ENABLED
 284         }
 285       }
 286     },
 287     followers: {
 288       instance: {
 289         enabled: CONFIG.FOLLOWERS.INSTANCE.ENABLED,
 290         manualApproval: CONFIG.FOLLOWERS.INSTANCE.MANUAL_APPROVAL
 291       }
 292     },
 293     followings: {
 294       instance: {
 295         autoFollowBack: {
 296           enabled: CONFIG.FOLLOWINGS.INSTANCE.AUTO_FOLLOW_BACK.ENABLED
 297         },
 298
 299         autoFollowIndex: {
 300           enabled: CONFIG.FOLLOWINGS.INSTANCE.AUTO_FOLLOW_INDEX.ENABLED,
 301           indexUrl: CONFIG.FOLLOWINGS.INSTANCE.AUTO_FOLLOW_INDEX.INDEX_URL
 302         }
 303       }
 304     },
 305     broadcastMessage: {
 306       enabled: CONFIG.BROADCAST_MESSAGE.ENABLED,
 307       message: CONFIG.BROADCAST_MESSAGE.MESSAGE,
 308       level: CONFIG.BROADCAST_MESSAGE.LEVEL,
 309       dismissable: CONFIG.BROADCAST_MESSAGE.DISMISSABLE
 310     },
 311     search: {
 312       remoteUri: {
 313         users: CONFIG.SEARCH.REMOTE_URI.USERS,
 314         anonymous: CONFIG.SEARCH.REMOTE_URI.ANONYMOUS
 315       },
 316       searchIndex: {
 317         enabled: CONFIG.SEARCH.SEARCH_INDEX.ENABLED,
 318         url: CONFIG.SEARCH.SEARCH_INDEX.URL,
 319         disableLocalSearch: CONFIG.SEARCH.SEARCH_INDEX.DISABLE_LOCAL_SEARCH,
 320         isDefaultSearch: CONFIG.SEARCH.SEARCH_INDEX.IS_DEFAULT_SEARCH
 321       }
 322     }
 323   }
 324 }
 325
 326 function convertCustomConfigBody (body: CustomConfig) {
 327   function keyConverter (k: string) {
 328     // Transcoding resolutions exception
 329     if (/^\d{3,4}p$/.exec(k)) return k
 330     if (k === '0p') return k
 331
 332     return snakeCase(k)
 333   }
 334
 335   function valueConverter (v: any) {
 336     if (validator.isNumeric(v + '')) return parseInt('' + v, 10)
 337
 338     return v
 339   }
 340
 341   return objectConverter(body, keyConverter, valueConverter)
 342 }