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