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 { About, CustomConfig, UserRight } from '@shared/models'
   7 import { auditLoggerFactory, CustomConfigAuditView, getAuditIdFromRes } from '../../helpers/audit-logger'
   8 import { objectConverter } from '../../helpers/core-utils'
   9 import { CONFIG, reloadConfig } from '../../initializers/config'
  10 import { ClientHtml } from '../../lib/client-html'
  11 import { asyncMiddleware, authenticate, ensureUserHasRight, openapiOperationDoc } from '../../middlewares'
  12 import { customConfigUpdateValidator, ensureConfigIsEditable } from '../../middlewares/validators/config'
  13 import { logger } from '@server/helpers/logger'
  14
  15 const configRouter = express.Router()
  16
  17 const auditLogger = auditLoggerFactory('config')
  18
  19 configRouter.get('/',
  20   openapiOperationDoc({ operationId: 'getConfig' }),
  21   asyncMiddleware(getConfig)
  22 )
  23
  24 configRouter.get('/about',
  25   openapiOperationDoc({ operationId: 'getAbout' }),
  26   getAbout
  27 )
  28
  29 configRouter.get('/custom',
  30   openapiOperationDoc({ operationId: 'getCustomConfig' }),
  31   authenticate,
  32   ensureUserHasRight(UserRight.MANAGE_CONFIGURATION),
  33   getCustomConfig
  34 )
  35
  36 configRouter.put('/custom',
  37   openapiOperationDoc({ operationId: 'putCustomConfig' }),
  38   authenticate,
  39   ensureUserHasRight(UserRight.MANAGE_CONFIGURATION),
  40   ensureConfigIsEditable,
  41   customConfigUpdateValidator,
  42   asyncMiddleware(updateCustomConfig)
  43 )
  44
  45 configRouter.delete('/custom',
  46   openapiOperationDoc({ operationId: 'delCustomConfig' }),
  47   authenticate,
  48   ensureUserHasRight(UserRight.MANAGE_CONFIGURATION),
  49   ensureConfigIsEditable,
  50   asyncMiddleware(deleteCustomConfig)
  51 )
  52
  53 async function getConfig (req: express.Request, res: express.Response) {
  54   const json = await ServerConfigManager.Instance.getServerConfig(req.ip)
  55
  56   return res.json(json)
  57 }
  58
  59 function getAbout (req: express.Request, res: express.Response) {
  60   const about: About = {
  61     instance: {
  62       name: CONFIG.INSTANCE.NAME,
  63       shortDescription: CONFIG.INSTANCE.SHORT_DESCRIPTION,
  64       description: CONFIG.INSTANCE.DESCRIPTION,
  65       terms: CONFIG.INSTANCE.TERMS,
  66       codeOfConduct: CONFIG.INSTANCE.CODE_OF_CONDUCT,
  67
  68       hardwareInformation: CONFIG.INSTANCE.HARDWARE_INFORMATION,
  69
  70       creationReason: CONFIG.INSTANCE.CREATION_REASON,
  71       moderationInformation: CONFIG.INSTANCE.MODERATION_INFORMATION,
  72       administrator: CONFIG.INSTANCE.ADMINISTRATOR,
  73       maintenanceLifetime: CONFIG.INSTANCE.MAINTENANCE_LIFETIME,
  74       businessModel: CONFIG.INSTANCE.BUSINESS_MODEL,
  75
  76       languages: CONFIG.INSTANCE.LANGUAGES,
  77       categories: CONFIG.INSTANCE.CATEGORIES
  78     }
  79   }
  80
  81   return res.json(about)
  82 }
  83
  84 function getCustomConfig (req: express.Request, res: express.Response) {
  85   const data = customConfig()
  86
  87   return res.json(data)
  88 }
  89
  90 async function deleteCustomConfig (req: express.Request, res: express.Response) {
  91   await remove(CONFIG.CUSTOM_FILE)
  92
  93   auditLogger.delete(getAuditIdFromRes(res), new CustomConfigAuditView(customConfig()))
  94
  95   reloadConfig()
  96   ClientHtml.invalidCache()
  97
  98   const data = customConfig()
  99
 100   return res.json(data)
 101 }
 102
 103 async function updateCustomConfig (req: express.Request, res: express.Response) {
 104   const oldCustomConfigAuditKeys = new CustomConfigAuditView(customConfig())
 105
 106   // camelCase to snake_case key + Force number conversion
 107   const toUpdateJSON = convertCustomConfigBody(req.body)
 108
 109   await writeJSON(CONFIG.CUSTOM_FILE, toUpdateJSON, { spaces: 2 })
 110
 111   reloadConfig()
 112   ClientHtml.invalidCache()
 113
 114   const data = customConfig()
 115
 116   logger.info('coucou', { data })
 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       alwaysTranscodeOriginalResolution: CONFIG.TRANSCODING.ALWAYS_TRANSCODE_ORIGINAL_RESOLUTION,
 233       webtorrent: {
 234         enabled: CONFIG.TRANSCODING.WEBTORRENT.ENABLED
 235       },
 236       hls: {
 237         enabled: CONFIG.TRANSCODING.HLS.ENABLED
 238       }
 239     },
 240     live: {
 241       enabled: CONFIG.LIVE.ENABLED,
 242       allowReplay: CONFIG.LIVE.ALLOW_REPLAY,
 243       latencySetting: {
 244         enabled: CONFIG.LIVE.LATENCY_SETTING.ENABLED
 245       },
 246       maxDuration: CONFIG.LIVE.MAX_DURATION,
 247       maxInstanceLives: CONFIG.LIVE.MAX_INSTANCE_LIVES,
 248       maxUserLives: CONFIG.LIVE.MAX_USER_LIVES,
 249       transcoding: {
 250         enabled: CONFIG.LIVE.TRANSCODING.ENABLED,
 251         threads: CONFIG.LIVE.TRANSCODING.THREADS,
 252         profile: CONFIG.LIVE.TRANSCODING.PROFILE,
 253         resolutions: {
 254           '144p': CONFIG.LIVE.TRANSCODING.RESOLUTIONS['144p'],
 255           '240p': CONFIG.LIVE.TRANSCODING.RESOLUTIONS['240p'],
 256           '360p': CONFIG.LIVE.TRANSCODING.RESOLUTIONS['360p'],
 257           '480p': CONFIG.LIVE.TRANSCODING.RESOLUTIONS['480p'],
 258           '720p': CONFIG.LIVE.TRANSCODING.RESOLUTIONS['720p'],
 259           '1080p': CONFIG.LIVE.TRANSCODING.RESOLUTIONS['1080p'],
 260           '1440p': CONFIG.LIVE.TRANSCODING.RESOLUTIONS['1440p'],
 261           '2160p': CONFIG.LIVE.TRANSCODING.RESOLUTIONS['2160p']
 262         },
 263         alwaysTranscodeOriginalResolution: CONFIG.LIVE.TRANSCODING.ALWAYS_TRANSCODE_ORIGINAL_RESOLUTION
 264       }
 265     },
 266     videoStudio: {
 267       enabled: CONFIG.VIDEO_STUDIO.ENABLED
 268     },
 269     import: {
 270       videos: {
 271         concurrency: CONFIG.IMPORT.VIDEOS.CONCURRENCY,
 272         http: {
 273           enabled: CONFIG.IMPORT.VIDEOS.HTTP.ENABLED
 274         },
 275         torrent: {
 276           enabled: CONFIG.IMPORT.VIDEOS.TORRENT.ENABLED
 277         }
 278       }
 279     },
 280     trending: {
 281       videos: {
 282         algorithms: {
 283           enabled: CONFIG.TRENDING.VIDEOS.ALGORITHMS.ENABLED,
 284           default: CONFIG.TRENDING.VIDEOS.ALGORITHMS.DEFAULT
 285         }
 286       }
 287     },
 288     autoBlacklist: {
 289       videos: {
 290         ofUsers: {
 291           enabled: CONFIG.AUTO_BLACKLIST.VIDEOS.OF_USERS.ENABLED
 292         }
 293       }
 294     },
 295     followers: {
 296       instance: {
 297         enabled: CONFIG.FOLLOWERS.INSTANCE.ENABLED,
 298         manualApproval: CONFIG.FOLLOWERS.INSTANCE.MANUAL_APPROVAL
 299       }
 300     },
 301     followings: {
 302       instance: {
 303         autoFollowBack: {
 304           enabled: CONFIG.FOLLOWINGS.INSTANCE.AUTO_FOLLOW_BACK.ENABLED
 305         },
 306
 307         autoFollowIndex: {
 308           enabled: CONFIG.FOLLOWINGS.INSTANCE.AUTO_FOLLOW_INDEX.ENABLED,
 309           indexUrl: CONFIG.FOLLOWINGS.INSTANCE.AUTO_FOLLOW_INDEX.INDEX_URL
 310         }
 311       }
 312     },
 313     broadcastMessage: {
 314       enabled: CONFIG.BROADCAST_MESSAGE.ENABLED,
 315       message: CONFIG.BROADCAST_MESSAGE.MESSAGE,
 316       level: CONFIG.BROADCAST_MESSAGE.LEVEL,
 317       dismissable: CONFIG.BROADCAST_MESSAGE.DISMISSABLE
 318     },
 319     search: {
 320       remoteUri: {
 321         users: CONFIG.SEARCH.REMOTE_URI.USERS,
 322         anonymous: CONFIG.SEARCH.REMOTE_URI.ANONYMOUS
 323       },
 324       searchIndex: {
 325         enabled: CONFIG.SEARCH.SEARCH_INDEX.ENABLED,
 326         url: CONFIG.SEARCH.SEARCH_INDEX.URL,
 327         disableLocalSearch: CONFIG.SEARCH.SEARCH_INDEX.DISABLE_LOCAL_SEARCH,
 328         isDefaultSearch: CONFIG.SEARCH.SEARCH_INDEX.IS_DEFAULT_SEARCH
 329       }
 330     }
 331   }
 332 }
 333
 334 function convertCustomConfigBody (body: CustomConfig) {
 335   function keyConverter (k: string) {
 336     // Transcoding resolutions exception
 337     if (/^\d{3,4}p$/.exec(k)) return k
 338     if (k === '0p') return k
 339
 340     return snakeCase(k)
 341   }
 342
 343   function valueConverter (v: any) {
 344     if (validator.isNumeric(v + '')) return parseInt('' + v, 10)
 345
 346     return v
 347   }
 348
 349   return objectConverter(body, keyConverter, valueConverter)
 350 }