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