server/initializers/checker-before-init.ts

   1 import * as config from 'config'
   2 import { promisify0 } from '../helpers/core-utils'
   3
   4 // ONLY USE CORE MODULES IN THIS FILE!
   5
   6 // Check the config files
   7 function checkMissedConfig () {
   8   const required = [ 'listen.port', 'listen.hostname',
   9     'webserver.https', 'webserver.hostname', 'webserver.port',
  10     'trust_proxy',
  11     'database.hostname', 'database.port', 'database.suffix', 'database.username', 'database.password', 'database.pool.max',
  12     'smtp.hostname', 'smtp.port', 'smtp.username', 'smtp.password', 'smtp.tls', 'smtp.from_address',
  13     'email.body.signature', 'email.object.prefix',
  14     'storage.avatars', 'storage.videos', 'storage.logs', 'storage.previews', 'storage.thumbnails', 'storage.torrents', 'storage.cache',
  15     'storage.redundancy', 'storage.tmp', 'storage.streaming_playlists', 'storage.plugins',
  16     'log.level',
  17     'user.video_quota', 'user.video_quota_daily',
  18     'csp.enabled', 'csp.report_only', 'csp.report_uri',
  19     'cache.previews.size', 'admin.email', 'contact_form.enabled',
  20     'signup.enabled', 'signup.limit', 'signup.requires_email_verification',
  21     'signup.filters.cidr.whitelist', 'signup.filters.cidr.blacklist',
  22     'redundancy.videos.strategies', 'redundancy.videos.check_interval',
  23     'transcoding.enabled', 'transcoding.threads', 'transcoding.allow_additional_extensions',
  24     'import.videos.http.enabled', 'import.videos.torrent.enabled', 'auto_blacklist.videos.of_users.enabled',
  25     'trending.videos.interval_days',
  26     'instance.name', 'instance.short_description', 'instance.description', 'instance.terms', 'instance.default_client_route',
  27     'instance.is_nsfw', 'instance.default_nsfw_policy', 'instance.robots', 'instance.securitytxt',
  28     'services.twitter.username', 'services.twitter.whitelisted',
  29     'followers.instance.enabled', 'followers.instance.manual_approval',
  30     'tracker.enabled', 'tracker.private', 'tracker.reject_too_many_announces',
  31     'history.videos.max_age', 'views.videos.remote.max_age',
  32     'rates_limit.login.window', 'rates_limit.login.max', 'rates_limit.ask_send_email.window', 'rates_limit.ask_send_email.max',
  33     'theme.default'
  34   ]
  35   const requiredAlternatives = [
  36     [ // set
  37       ['redis.hostname', 'redis.port'], // alternative
  38       ['redis.socket']
  39     ]
  40   ]
  41   const miss: string[] = []
  42
  43   for (const key of required) {
  44     if (!config.has(key)) {
  45       miss.push(key)
  46     }
  47   }
  48
  49   const redundancyVideos = config.get<any>('redundancy.videos.strategies')
  50
  51   if (Array.isArray(redundancyVideos)) {
  52     for (const r of redundancyVideos) {
  53       if (!r.size) miss.push('redundancy.videos.strategies.size')
  54       if (!r.min_lifetime) miss.push('redundancy.videos.strategies.min_lifetime')
  55     }
  56   }
  57
  58   const missingAlternatives = requiredAlternatives.filter(
  59     set => !set.find(alternative => !alternative.find(key => !config.has(key)))
  60   )
  61
  62   missingAlternatives
  63     .forEach(set => set[0].forEach(key => miss.push(key)))
  64
  65   return miss
  66 }
  67
  68 // Check the available codecs
  69 // We get CONFIG by param to not import it in this file (import orders)
  70 async function checkFFmpeg (CONFIG: { TRANSCODING: { ENABLED: boolean } }) {
  71   const Ffmpeg = require('fluent-ffmpeg')
  72   const getAvailableCodecsPromise = promisify0(Ffmpeg.getAvailableCodecs)
  73   const codecs = await getAvailableCodecsPromise()
  74   const canEncode = [ 'libx264' ]
  75
  76   if (CONFIG.TRANSCODING.ENABLED === false) return undefined
  77
  78   for (const codec of canEncode) {
  79     if (codecs[codec] === undefined) {
  80       throw new Error('Unknown codec ' + codec + ' in FFmpeg.')
  81     }
  82
  83     if (codecs[codec].canEncode !== true) {
  84       throw new Error('Unavailable encode codec ' + codec + ' in FFmpeg')
  85     }
  86   }
  87
  88   return checkFFmpegEncoders()
  89 }
  90
  91 // Optional encoders, if present, can be used to improve transcoding
  92 // Here we ask ffmpeg if it detects their presence on the system, so that we can later use them
  93 let supportedOptionalEncoders: Map<string, boolean>
  94 async function checkFFmpegEncoders (): Promise<Map<string, boolean>> {
  95   if (supportedOptionalEncoders !== undefined) {
  96     return supportedOptionalEncoders
  97   }
  98
  99   const Ffmpeg = require('fluent-ffmpeg')
 100   const getAvailableEncodersPromise = promisify0(Ffmpeg.getAvailableEncoders)
 101   const encoders = await getAvailableEncodersPromise()
 102   const optionalEncoders = [ 'libfdk_aac' ]
 103   supportedOptionalEncoders = new Map<string, boolean>()
 104
 105   for (const encoder of optionalEncoders) {
 106     supportedOptionalEncoders.set(encoder, encoders[encoder] !== undefined)
 107   }
 108
 109   return supportedOptionalEncoders
 110 }
 111
 112 // ---------------------------------------------------------------------------
 113
 114 export {
 115   checkFFmpeg,
 116   checkFFmpegEncoders,
 117   checkMissedConfig
 118 }