server/lib/server-config-manager.ts

   1 import { getServerCommit } from '@server/helpers/utils'
   2 import { CONFIG, isEmailEnabled } from '@server/initializers/config'
   3 import { CONSTRAINTS_FIELDS, DEFAULT_THEME_NAME, PEERTUBE_VERSION } from '@server/initializers/constants'
   4 import { isSignupAllowed, isSignupAllowedForCurrentIP } from '@server/lib/signup'
   5 import { ActorCustomPageModel } from '@server/models/account/actor-custom-page'
   6 import { PluginModel } from '@server/models/server/plugin'
   7 import { HTMLServerConfig, RegisteredExternalAuthConfig, RegisteredIdAndPassAuthConfig, ServerConfig } from '@shared/models'
   8 import { Hooks } from './plugins/hooks'
   9 import { PluginManager } from './plugins/plugin-manager'
  10 import { getThemeOrDefault } from './plugins/theme-utils'
  11 import { VideoTranscodingProfilesManager } from './transcoding/default-transcoding-profiles'
  12
  13 /**
  14  *
  15  * Used to send the server config to clients (using REST/API or plugins API)
  16  * We need a singleton class to manage config state depending on external events (to build menu entries etc)
  17  *
  18  */
  19
  20 class ServerConfigManager {
  21
  22   private static instance: ServerConfigManager
  23
  24   private serverCommit: string
  25
  26   private homepageEnabled = false
  27
  28   private constructor () {}
  29
  30   async init () {
  31     const instanceHomepage = await ActorCustomPageModel.loadInstanceHomepage()
  32
  33     this.updateHomepageState(instanceHomepage?.content)
  34   }
  35
  36   updateHomepageState (content: string) {
  37     this.homepageEnabled = !!content
  38   }
  39
  40   async getHTMLServerConfig (): Promise<HTMLServerConfig> {
  41     if (this.serverCommit === undefined) this.serverCommit = await getServerCommit()
  42
  43     const defaultTheme = getThemeOrDefault(CONFIG.THEME.DEFAULT, DEFAULT_THEME_NAME)
  44
  45     return {
  46       client: {
  47         videos: {
  48           miniature: {
  49             displayAuthorAvatar: CONFIG.CLIENT.VIDEOS.MINIATURE.DISPLAY_AUTHOR_AVATAR,
  50             preferAuthorDisplayName: CONFIG.CLIENT.VIDEOS.MINIATURE.PREFER_AUTHOR_DISPLAY_NAME
  51           },
  52           resumableUpload: {
  53             maxChunkSize: CONFIG.CLIENT.VIDEOS.RESUMABLE_UPLOAD.MAX_CHUNK_SIZE
  54           }
  55         },
  56         menu: {
  57           login: {
  58             redirectOnSingleExternalAuth: CONFIG.CLIENT.MENU.LOGIN.REDIRECT_ON_SINGLE_EXTERNAL_AUTH
  59           }
  60         }
  61       },
  62
  63       defaults: {
  64         publish: {
  65           downloadEnabled: CONFIG.DEFAULTS.PUBLISH.DOWNLOAD_ENABLED,
  66           commentsEnabled: CONFIG.DEFAULTS.PUBLISH.COMMENTS_ENABLED,
  67           privacy: CONFIG.DEFAULTS.PUBLISH.PRIVACY,
  68           licence: CONFIG.DEFAULTS.PUBLISH.LICENCE
  69         },
  70         p2p: {
  71           webapp: {
  72             enabled: CONFIG.DEFAULTS.P2P.WEBAPP.ENABLED
  73           },
  74           embed: {
  75             enabled: CONFIG.DEFAULTS.P2P.EMBED.ENABLED
  76           }
  77         }
  78       },
  79
  80       webadmin: {
  81         configuration: {
  82           edition: {
  83             allowed: CONFIG.WEBADMIN.CONFIGURATION.EDITION.ALLOWED
  84           }
  85         }
  86       },
  87
  88       instance: {
  89         name: CONFIG.INSTANCE.NAME,
  90         shortDescription: CONFIG.INSTANCE.SHORT_DESCRIPTION,
  91         isNSFW: CONFIG.INSTANCE.IS_NSFW,
  92         defaultNSFWPolicy: CONFIG.INSTANCE.DEFAULT_NSFW_POLICY,
  93         defaultClientRoute: CONFIG.INSTANCE.DEFAULT_CLIENT_ROUTE,
  94         customizations: {
  95           javascript: CONFIG.INSTANCE.CUSTOMIZATIONS.JAVASCRIPT,
  96           css: CONFIG.INSTANCE.CUSTOMIZATIONS.CSS
  97         }
  98       },
  99       search: {
 100         remoteUri: {
 101           users: CONFIG.SEARCH.REMOTE_URI.USERS,
 102           anonymous: CONFIG.SEARCH.REMOTE_URI.ANONYMOUS
 103         },
 104         searchIndex: {
 105           enabled: CONFIG.SEARCH.SEARCH_INDEX.ENABLED,
 106           url: CONFIG.SEARCH.SEARCH_INDEX.URL,
 107           disableLocalSearch: CONFIG.SEARCH.SEARCH_INDEX.DISABLE_LOCAL_SEARCH,
 108           isDefaultSearch: CONFIG.SEARCH.SEARCH_INDEX.IS_DEFAULT_SEARCH
 109         }
 110       },
 111       plugin: {
 112         registered: this.getRegisteredPlugins(),
 113         registeredExternalAuths: this.getExternalAuthsPlugins(),
 114         registeredIdAndPassAuths: this.getIdAndPassAuthPlugins()
 115       },
 116       theme: {
 117         registered: this.getRegisteredThemes(),
 118         default: defaultTheme
 119       },
 120       email: {
 121         enabled: isEmailEnabled()
 122       },
 123       contactForm: {
 124         enabled: CONFIG.CONTACT_FORM.ENABLED
 125       },
 126       serverVersion: PEERTUBE_VERSION,
 127       serverCommit: this.serverCommit,
 128       transcoding: {
 129         hls: {
 130           enabled: CONFIG.TRANSCODING.HLS.ENABLED
 131         },
 132         webtorrent: {
 133           enabled: CONFIG.TRANSCODING.WEBTORRENT.ENABLED
 134         },
 135         enabledResolutions: this.getEnabledResolutions('vod'),
 136         profile: CONFIG.TRANSCODING.PROFILE,
 137         availableProfiles: VideoTranscodingProfilesManager.Instance.getAvailableProfiles('vod')
 138       },
 139       live: {
 140         enabled: CONFIG.LIVE.ENABLED,
 141
 142         allowReplay: CONFIG.LIVE.ALLOW_REPLAY,
 143         latencySetting: {
 144           enabled: CONFIG.LIVE.LATENCY_SETTING.ENABLED
 145         },
 146
 147         maxDuration: CONFIG.LIVE.MAX_DURATION,
 148         maxInstanceLives: CONFIG.LIVE.MAX_INSTANCE_LIVES,
 149         maxUserLives: CONFIG.LIVE.MAX_USER_LIVES,
 150
 151         transcoding: {
 152           enabled: CONFIG.LIVE.TRANSCODING.ENABLED,
 153           enabledResolutions: this.getEnabledResolutions('live'),
 154           profile: CONFIG.LIVE.TRANSCODING.PROFILE,
 155           availableProfiles: VideoTranscodingProfilesManager.Instance.getAvailableProfiles('live')
 156         },
 157
 158         rtmp: {
 159           port: CONFIG.LIVE.RTMP.PORT
 160         }
 161       },
 162       videoStudio: {
 163         enabled: CONFIG.VIDEO_STUDIO.ENABLED
 164       },
 165       import: {
 166         videos: {
 167           http: {
 168             enabled: CONFIG.IMPORT.VIDEOS.HTTP.ENABLED
 169           },
 170           torrent: {
 171             enabled: CONFIG.IMPORT.VIDEOS.TORRENT.ENABLED
 172           }
 173         }
 174       },
 175       autoBlacklist: {
 176         videos: {
 177           ofUsers: {
 178             enabled: CONFIG.AUTO_BLACKLIST.VIDEOS.OF_USERS.ENABLED
 179           }
 180         }
 181       },
 182       avatar: {
 183         file: {
 184           size: {
 185             max: CONSTRAINTS_FIELDS.ACTORS.IMAGE.FILE_SIZE.max
 186           },
 187           extensions: CONSTRAINTS_FIELDS.ACTORS.IMAGE.EXTNAME
 188         }
 189       },
 190       banner: {
 191         file: {
 192           size: {
 193             max: CONSTRAINTS_FIELDS.ACTORS.IMAGE.FILE_SIZE.max
 194           },
 195           extensions: CONSTRAINTS_FIELDS.ACTORS.IMAGE.EXTNAME
 196         }
 197       },
 198       video: {
 199         image: {
 200           extensions: CONSTRAINTS_FIELDS.VIDEOS.IMAGE.EXTNAME,
 201           size: {
 202             max: CONSTRAINTS_FIELDS.VIDEOS.IMAGE.FILE_SIZE.max
 203           }
 204         },
 205         file: {
 206           extensions: CONSTRAINTS_FIELDS.VIDEOS.EXTNAME
 207         }
 208       },
 209       videoCaption: {
 210         file: {
 211           size: {
 212             max: CONSTRAINTS_FIELDS.VIDEO_CAPTIONS.CAPTION_FILE.FILE_SIZE.max
 213           },
 214           extensions: CONSTRAINTS_FIELDS.VIDEO_CAPTIONS.CAPTION_FILE.EXTNAME
 215         }
 216       },
 217       user: {
 218         videoQuota: CONFIG.USER.VIDEO_QUOTA,
 219         videoQuotaDaily: CONFIG.USER.VIDEO_QUOTA_DAILY
 220       },
 221       videoChannels: {
 222         maxPerUser: CONFIG.VIDEO_CHANNELS.MAX_PER_USER
 223       },
 224       trending: {
 225         videos: {
 226           intervalDays: CONFIG.TRENDING.VIDEOS.INTERVAL_DAYS,
 227           algorithms: {
 228             enabled: CONFIG.TRENDING.VIDEOS.ALGORITHMS.ENABLED,
 229             default: CONFIG.TRENDING.VIDEOS.ALGORITHMS.DEFAULT
 230           }
 231         }
 232       },
 233       tracker: {
 234         enabled: CONFIG.TRACKER.ENABLED
 235       },
 236
 237       followings: {
 238         instance: {
 239           autoFollowIndex: {
 240             indexUrl: CONFIG.FOLLOWINGS.INSTANCE.AUTO_FOLLOW_INDEX.INDEX_URL
 241           }
 242         }
 243       },
 244
 245       broadcastMessage: {
 246         enabled: CONFIG.BROADCAST_MESSAGE.ENABLED,
 247         message: CONFIG.BROADCAST_MESSAGE.MESSAGE,
 248         level: CONFIG.BROADCAST_MESSAGE.LEVEL,
 249         dismissable: CONFIG.BROADCAST_MESSAGE.DISMISSABLE
 250       },
 251
 252       homepage: {
 253         enabled: this.homepageEnabled
 254       }
 255     }
 256   }
 257
 258   async getServerConfig (ip?: string): Promise<ServerConfig> {
 259     const { allowed } = await Hooks.wrapPromiseFun(
 260       isSignupAllowed,
 261       {
 262         ip
 263       },
 264       'filter:api.user.signup.allowed.result'
 265     )
 266
 267     const allowedForCurrentIP = isSignupAllowedForCurrentIP(ip)
 268
 269     const signup = {
 270       allowed,
 271       allowedForCurrentIP,
 272       minimumAge: CONFIG.SIGNUP.MINIMUM_AGE,
 273       requiresEmailVerification: CONFIG.SIGNUP.REQUIRES_EMAIL_VERIFICATION
 274     }
 275
 276     const htmlConfig = await this.getHTMLServerConfig()
 277
 278     return { ...htmlConfig, signup }
 279   }
 280
 281   getRegisteredThemes () {
 282     return PluginManager.Instance.getRegisteredThemes()
 283                         .map(t => ({
 284                           npmName: PluginModel.buildNpmName(t.name, t.type),
 285                           name: t.name,
 286                           version: t.version,
 287                           description: t.description,
 288                           css: t.css,
 289                           clientScripts: t.clientScripts
 290                         }))
 291   }
 292
 293   getRegisteredPlugins () {
 294     return PluginManager.Instance.getRegisteredPlugins()
 295                         .map(p => ({
 296                           npmName: PluginModel.buildNpmName(p.name, p.type),
 297                           name: p.name,
 298                           version: p.version,
 299                           description: p.description,
 300                           clientScripts: p.clientScripts
 301                         }))
 302   }
 303
 304   getEnabledResolutions (type: 'vod' | 'live') {
 305     const transcoding = type === 'vod'
 306       ? CONFIG.TRANSCODING
 307       : CONFIG.LIVE.TRANSCODING
 308
 309     return Object.keys(transcoding.RESOLUTIONS)
 310                  .filter(key => transcoding.ENABLED && transcoding.RESOLUTIONS[key] === true)
 311                  .map(r => parseInt(r, 10))
 312   }
 313
 314   private getIdAndPassAuthPlugins () {
 315     const result: RegisteredIdAndPassAuthConfig[] = []
 316
 317     for (const p of PluginManager.Instance.getIdAndPassAuths()) {
 318       for (const auth of p.idAndPassAuths) {
 319         result.push({
 320           npmName: p.npmName,
 321           name: p.name,
 322           version: p.version,
 323           authName: auth.authName,
 324           weight: auth.getWeight()
 325         })
 326       }
 327     }
 328
 329     return result
 330   }
 331
 332   private getExternalAuthsPlugins () {
 333     const result: RegisteredExternalAuthConfig[] = []
 334
 335     for (const p of PluginManager.Instance.getExternalAuths()) {
 336       for (const auth of p.externalAuths) {
 337         result.push({
 338           npmName: p.npmName,
 339           name: p.name,
 340           version: p.version,
 341           authName: auth.authName,
 342           authDisplayName: auth.authDisplayName()
 343         })
 344       }
 345     }
 346
 347     return result
 348   }
 349
 350   static get Instance () {
 351     return this.instance || (this.instance = new this())
 352   }
 353 }
 354
 355 // ---------------------------------------------------------------------------
 356
 357 export {
 358   ServerConfigManager
 359 }