server/lib/server-config-manager.ts

   1 import { getServerCommit } from '@server/helpers/version'
   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         videoChannelSynchronization: {
 175           enabled: CONFIG.IMPORT.VIDEO_CHANNEL_SYNCHRONIZATION.ENABLED
 176         }
 177       },
 178       autoBlacklist: {
 179         videos: {
 180           ofUsers: {
 181             enabled: CONFIG.AUTO_BLACKLIST.VIDEOS.OF_USERS.ENABLED
 182           }
 183         }
 184       },
 185       avatar: {
 186         file: {
 187           size: {
 188             max: CONSTRAINTS_FIELDS.ACTORS.IMAGE.FILE_SIZE.max
 189           },
 190           extensions: CONSTRAINTS_FIELDS.ACTORS.IMAGE.EXTNAME
 191         }
 192       },
 193       banner: {
 194         file: {
 195           size: {
 196             max: CONSTRAINTS_FIELDS.ACTORS.IMAGE.FILE_SIZE.max
 197           },
 198           extensions: CONSTRAINTS_FIELDS.ACTORS.IMAGE.EXTNAME
 199         }
 200       },
 201       video: {
 202         image: {
 203           extensions: CONSTRAINTS_FIELDS.VIDEOS.IMAGE.EXTNAME,
 204           size: {
 205             max: CONSTRAINTS_FIELDS.VIDEOS.IMAGE.FILE_SIZE.max
 206           }
 207         },
 208         file: {
 209           extensions: CONSTRAINTS_FIELDS.VIDEOS.EXTNAME
 210         }
 211       },
 212       videoCaption: {
 213         file: {
 214           size: {
 215             max: CONSTRAINTS_FIELDS.VIDEO_CAPTIONS.CAPTION_FILE.FILE_SIZE.max
 216           },
 217           extensions: CONSTRAINTS_FIELDS.VIDEO_CAPTIONS.CAPTION_FILE.EXTNAME
 218         }
 219       },
 220       user: {
 221         videoQuota: CONFIG.USER.VIDEO_QUOTA,
 222         videoQuotaDaily: CONFIG.USER.VIDEO_QUOTA_DAILY
 223       },
 224       videoChannels: {
 225         maxPerUser: CONFIG.VIDEO_CHANNELS.MAX_PER_USER
 226       },
 227       trending: {
 228         videos: {
 229           intervalDays: CONFIG.TRENDING.VIDEOS.INTERVAL_DAYS,
 230           algorithms: {
 231             enabled: CONFIG.TRENDING.VIDEOS.ALGORITHMS.ENABLED,
 232             default: CONFIG.TRENDING.VIDEOS.ALGORITHMS.DEFAULT
 233           }
 234         }
 235       },
 236       tracker: {
 237         enabled: CONFIG.TRACKER.ENABLED
 238       },
 239
 240       followings: {
 241         instance: {
 242           autoFollowIndex: {
 243             indexUrl: CONFIG.FOLLOWINGS.INSTANCE.AUTO_FOLLOW_INDEX.INDEX_URL
 244           }
 245         }
 246       },
 247
 248       broadcastMessage: {
 249         enabled: CONFIG.BROADCAST_MESSAGE.ENABLED,
 250         message: CONFIG.BROADCAST_MESSAGE.MESSAGE,
 251         level: CONFIG.BROADCAST_MESSAGE.LEVEL,
 252         dismissable: CONFIG.BROADCAST_MESSAGE.DISMISSABLE
 253       },
 254
 255       homepage: {
 256         enabled: this.homepageEnabled
 257       }
 258     }
 259   }
 260
 261   async getServerConfig (ip?: string): Promise<ServerConfig> {
 262     const { allowed } = await Hooks.wrapPromiseFun(
 263       isSignupAllowed,
 264
 265       {
 266         ip,
 267         signupMode: CONFIG.SIGNUP.REQUIRES_APPROVAL
 268           ? 'request-registration'
 269           : 'direct-registration'
 270       },
 271
 272       CONFIG.SIGNUP.REQUIRES_APPROVAL
 273         ? 'filter:api.user.request-signup.allowed.result'
 274         : 'filter:api.user.signup.allowed.result'
 275     )
 276
 277     const allowedForCurrentIP = isSignupAllowedForCurrentIP(ip)
 278
 279     const signup = {
 280       allowed,
 281       allowedForCurrentIP,
 282       minimumAge: CONFIG.SIGNUP.MINIMUM_AGE,
 283       requiresApproval: CONFIG.SIGNUP.REQUIRES_APPROVAL,
 284       requiresEmailVerification: CONFIG.SIGNUP.REQUIRES_EMAIL_VERIFICATION
 285     }
 286
 287     const htmlConfig = await this.getHTMLServerConfig()
 288
 289     return { ...htmlConfig, signup }
 290   }
 291
 292   getRegisteredThemes () {
 293     return PluginManager.Instance.getRegisteredThemes()
 294                         .map(t => ({
 295                           npmName: PluginModel.buildNpmName(t.name, t.type),
 296                           name: t.name,
 297                           version: t.version,
 298                           description: t.description,
 299                           css: t.css,
 300                           clientScripts: t.clientScripts
 301                         }))
 302   }
 303
 304   getRegisteredPlugins () {
 305     return PluginManager.Instance.getRegisteredPlugins()
 306                         .map(p => ({
 307                           npmName: PluginModel.buildNpmName(p.name, p.type),
 308                           name: p.name,
 309                           version: p.version,
 310                           description: p.description,
 311                           clientScripts: p.clientScripts
 312                         }))
 313   }
 314
 315   getEnabledResolutions (type: 'vod' | 'live') {
 316     const transcoding = type === 'vod'
 317       ? CONFIG.TRANSCODING
 318       : CONFIG.LIVE.TRANSCODING
 319
 320     return Object.keys(transcoding.RESOLUTIONS)
 321                  .filter(key => transcoding.ENABLED && transcoding.RESOLUTIONS[key] === true)
 322                  .map(r => parseInt(r, 10))
 323   }
 324
 325   private getIdAndPassAuthPlugins () {
 326     const result: RegisteredIdAndPassAuthConfig[] = []
 327
 328     for (const p of PluginManager.Instance.getIdAndPassAuths()) {
 329       for (const auth of p.idAndPassAuths) {
 330         result.push({
 331           npmName: p.npmName,
 332           name: p.name,
 333           version: p.version,
 334           authName: auth.authName,
 335           weight: auth.getWeight()
 336         })
 337       }
 338     }
 339
 340     return result
 341   }
 342
 343   private getExternalAuthsPlugins () {
 344     const result: RegisteredExternalAuthConfig[] = []
 345
 346     for (const p of PluginManager.Instance.getExternalAuths()) {
 347       for (const auth of p.externalAuths) {
 348         result.push({
 349           npmName: p.npmName,
 350           name: p.name,
 351           version: p.version,
 352           authName: auth.authName,
 353           authDisplayName: auth.authDisplayName()
 354         })
 355       }
 356     }
 357
 358     return result
 359   }
 360
 361   static get Instance () {
 362     return this.instance || (this.instance = new this())
 363   }
 364 }
 365
 366 // ---------------------------------------------------------------------------
 367
 368 export {
 369   ServerConfigManager
 370 }