server/initializers/constants.ts

   1 import { IConfig } from 'config'
   2 import { dirname, join } from 'path'
   3 import { JobType, VideoRateType } from '../../shared/models'
   4 import { ActivityPubActorType } from '../../shared/models/activitypub'
   5 import { FollowState } from '../../shared/models/actors'
   6 import { VideoPrivacy } from '../../shared/models/videos'
   7 // Do not use barrels, remain constants as independent as possible
   8 import { buildPath, isTestInstance, root, sanitizeHost, sanitizeUrl } from '../helpers/core-utils'
   9 import { NSFWPolicyType } from '../../shared/models/videos/nsfw-policy.type'
  10
  11 // Use a variable to reload the configuration if we need
  12 let config: IConfig = require('config')
  13
  14 // ---------------------------------------------------------------------------
  15
  16 const LAST_MIGRATION_VERSION = 215
  17
  18 // ---------------------------------------------------------------------------
  19
  20 // API version
  21 const API_VERSION = 'v1'
  22
  23 // Number of results by default for the pagination
  24 const PAGINATION_COUNT_DEFAULT = 15
  25
  26 // Sortable columns per schema
  27 const SORTABLE_COLUMNS = {
  28   USERS: [ 'id', 'username', 'createdAt' ],
  29   ACCOUNTS: [ 'createdAt' ],
  30   JOBS: [ 'createdAt' ],
  31   VIDEO_ABUSES: [ 'id', 'createdAt' ],
  32   VIDEO_CHANNELS: [ 'id', 'name', 'updatedAt', 'createdAt' ],
  33   VIDEOS: [ 'name', 'duration', 'createdAt', 'publishedAt', 'views', 'likes' ],
  34   VIDEO_COMMENT_THREADS: [ 'createdAt' ],
  35   BLACKLISTS: [ 'id', 'name', 'duration', 'views', 'likes', 'dislikes', 'uuid', 'createdAt' ],
  36   FOLLOWERS: [ 'createdAt' ],
  37   FOLLOWING: [ 'createdAt' ]
  38 }
  39
  40 const OAUTH_LIFETIME = {
  41   ACCESS_TOKEN: 3600 * 4, // 4 hours
  42   REFRESH_TOKEN: 1209600 // 2 weeks
  43 }
  44
  45 const ROUTE_CACHE_LIFETIME = {
  46   FEEDS: 1000 * 60 * 15, // 15 minutes
  47   ACTIVITY_PUB: {
  48     VIDEOS: 1000 // 1 second, cache concurrent requests after a broadcast for example
  49   }
  50 }
  51
  52 // ---------------------------------------------------------------------------
  53
  54 // Number of points we add/remove after a successful/bad request
  55 const ACTOR_FOLLOW_SCORE = {
  56   PENALTY: -10,
  57   BONUS: 10,
  58   BASE: 1000,
  59   MAX: 10000
  60 }
  61
  62 const FOLLOW_STATES: { [ id: string ]: FollowState } = {
  63   PENDING: 'pending',
  64   ACCEPTED: 'accepted'
  65 }
  66
  67 const REMOTE_SCHEME = {
  68   HTTP: 'https',
  69   WS: 'wss'
  70 }
  71
  72 const JOB_ATTEMPTS: { [ id in JobType ]: number } = {
  73   'activitypub-http-broadcast': 5,
  74   'activitypub-http-unicast': 5,
  75   'activitypub-http-fetcher': 5,
  76   'activitypub-follow': 5,
  77   'video-file': 1,
  78   'email': 5
  79 }
  80 const JOB_CONCURRENCY: { [ id in JobType ]: number } = {
  81   'activitypub-http-broadcast': 1,
  82   'activitypub-http-unicast': 5,
  83   'activitypub-http-fetcher': 1,
  84   'activitypub-follow': 3,
  85   'video-file': 1,
  86   'email': 5
  87 }
  88 const BROADCAST_CONCURRENCY = 10 // How many requests in parallel we do in activitypub-http-broadcast job
  89 const JOB_REQUEST_TIMEOUT = 3000 // 3 seconds
  90 const JOB_REQUEST_TTL = 60000 * 10 // 10 minutes
  91 const JOB_COMPLETED_LIFETIME = 60000 * 60 * 24 * 2 // 2 days
  92
  93 // 1 hour
  94 let SCHEDULER_INTERVAL = 60000 * 60
  95
  96 // ---------------------------------------------------------------------------
  97
  98 const CONFIG = {
  99   CUSTOM_FILE: getLocalConfigFilePath(),
 100   LISTEN: {
 101     PORT: config.get<number>('listen.port'),
 102     HOSTNAME: config.get<string>('listen.hostname')
 103   },
 104   DATABASE: {
 105     DBNAME: 'peertube' + config.get<string>('database.suffix'),
 106     HOSTNAME: config.get<string>('database.hostname'),
 107     PORT: config.get<number>('database.port'),
 108     USERNAME: config.get<string>('database.username'),
 109     PASSWORD: config.get<string>('database.password')
 110   },
 111   REDIS: {
 112     HOSTNAME: config.get<string>('redis.hostname'),
 113     PORT: config.get<number>('redis.port'),
 114     AUTH: config.get<string>('redis.auth'),
 115     DB: config.get<number>('redis.db')
 116   },
 117   SMTP: {
 118     HOSTNAME: config.get<string>('smtp.hostname'),
 119     PORT: config.get<number>('smtp.port'),
 120     USERNAME: config.get<string>('smtp.username'),
 121     PASSWORD: config.get<string>('smtp.password'),
 122     TLS: config.get<boolean>('smtp.tls'),
 123     DISABLE_STARTTLS: config.get<boolean>('smtp.disable_starttls'),
 124     CA_FILE: config.get<string>('smtp.ca_file'),
 125     FROM_ADDRESS: config.get<string>('smtp.from_address')
 126   },
 127   STORAGE: {
 128     AVATARS_DIR: buildPath(config.get<string>('storage.avatars')),
 129     LOG_DIR: buildPath(config.get<string>('storage.logs')),
 130     VIDEOS_DIR: buildPath(config.get<string>('storage.videos')),
 131     THUMBNAILS_DIR: buildPath(config.get<string>('storage.thumbnails')),
 132     PREVIEWS_DIR: buildPath(config.get<string>('storage.previews')),
 133     TORRENTS_DIR: buildPath(config.get<string>('storage.torrents')),
 134     CACHE_DIR: buildPath(config.get<string>('storage.cache'))
 135   },
 136   WEBSERVER: {
 137     SCHEME: config.get<boolean>('webserver.https') === true ? 'https' : 'http',
 138     WS: config.get<boolean>('webserver.https') === true ? 'wss' : 'ws',
 139     HOSTNAME: config.get<string>('webserver.hostname'),
 140     PORT: config.get<number>('webserver.port'),
 141     URL: '',
 142     HOST: ''
 143   },
 144   TRUST_PROXY: config.get<string[]>('trust_proxy'),
 145   LOG: {
 146     LEVEL: config.get<string>('log.level')
 147   },
 148   ADMIN: {
 149     get EMAIL () { return config.get<string>('admin.email') }
 150   },
 151   SIGNUP: {
 152     get ENABLED () { return config.get<boolean>('signup.enabled') },
 153     get LIMIT () { return config.get<number>('signup.limit') },
 154     FILTERS: {
 155       CIDR: {
 156         get WHITELIST () { return config.get<string[]>('signup.filters.cidr.whitelist') },
 157         get BLACKLIST () { return config.get<string[]>('signup.filters.cidr.blacklist') }
 158       }
 159     }
 160   },
 161   USER: {
 162     get VIDEO_QUOTA () { return config.get<number>('user.video_quota') }
 163   },
 164   TRANSCODING: {
 165     get ENABLED () { return config.get<boolean>('transcoding.enabled') },
 166     get THREADS () { return config.get<number>('transcoding.threads') },
 167     RESOLUTIONS: {
 168       get '240p' () { return config.get<boolean>('transcoding.resolutions.240p') },
 169       get '360p' () { return config.get<boolean>('transcoding.resolutions.360p') },
 170       get '480p' () { return config.get<boolean>('transcoding.resolutions.480p') },
 171       get '720p' () { return config.get<boolean>('transcoding.resolutions.720p') },
 172       get '1080p' () { return config.get<boolean>('transcoding.resolutions.1080p') }
 173     }
 174   },
 175   CACHE: {
 176     PREVIEWS: {
 177       get SIZE () { return config.get<number>('cache.previews.size') }
 178     }
 179   },
 180   INSTANCE: {
 181     get NAME () { return config.get<string>('instance.name') },
 182     get SHORT_DESCRIPTION () { return config.get<string>('instance.short_description') },
 183     get DESCRIPTION () { return config.get<string>('instance.description') },
 184     get TERMS () { return config.get<string>('instance.terms') },
 185     get DEFAULT_CLIENT_ROUTE () { return config.get<string>('instance.default_client_route') },
 186     get DEFAULT_NSFW_POLICY () { return config.get<NSFWPolicyType>('instance.default_nsfw_policy') },
 187     CUSTOMIZATIONS: {
 188       get JAVASCRIPT () { return config.get<string>('instance.customizations.javascript') },
 189       get CSS () { return config.get<string>('instance.customizations.css') }
 190     },
 191     get ROBOTS () { return config.get<string>('instance.robots') }
 192   },
 193   SERVICES: {
 194     TWITTER: {
 195       get USERNAME () { return config.get<string>('services.twitter.username') },
 196       get WHITELISTED () { return config.get<boolean>('services.twitter.whitelisted') }
 197     }
 198   }
 199 }
 200
 201 // ---------------------------------------------------------------------------
 202
 203 const CONSTRAINTS_FIELDS = {
 204   USERS: {
 205     NAME: { min: 3, max: 120 }, // Length
 206     DESCRIPTION: { min: 3, max: 250 }, // Length
 207     USERNAME: { min: 3, max: 20 }, // Length
 208     PASSWORD: { min: 6, max: 255 }, // Length
 209     VIDEO_QUOTA: { min: -1 }
 210   },
 211   VIDEO_ABUSES: {
 212     REASON: { min: 2, max: 300 } // Length
 213   },
 214   VIDEO_CHANNELS: {
 215     NAME: { min: 3, max: 120 }, // Length
 216     DESCRIPTION: { min: 3, max: 500 }, // Length
 217     SUPPORT: { min: 3, max: 500 }, // Length
 218     URL: { min: 3, max: 2000 } // Length
 219   },
 220   VIDEOS: {
 221     NAME: { min: 3, max: 120 }, // Length
 222     LANGUAGE: { min: 1, max: 10 }, // Length
 223     TRUNCATED_DESCRIPTION: { min: 3, max: 250 }, // Length
 224     DESCRIPTION: { min: 3, max: 10000 }, // Length
 225     SUPPORT: { min: 3, max: 500 }, // Length
 226     IMAGE: {
 227       EXTNAME: [ '.jpg', '.jpeg' ],
 228       FILE_SIZE: {
 229         max: 2 * 1024 * 1024 // 2MB
 230       }
 231     },
 232     EXTNAME: [ '.mp4', '.ogv', '.webm' ],
 233     INFO_HASH: { min: 40, max: 40 }, // Length, info hash is 20 bytes length but we represent it in hexadecimal so 20 * 2
 234     DURATION: { min: 1 }, // Number
 235     TAGS: { min: 0, max: 5 }, // Number of total tags
 236     TAG: { min: 2, max: 30 }, // Length
 237     THUMBNAIL: { min: 2, max: 30 },
 238     THUMBNAIL_DATA: { min: 0, max: 20000 }, // Bytes
 239     VIEWS: { min: 0 },
 240     LIKES: { min: 0 },
 241     DISLIKES: { min: 0 },
 242     FILE_SIZE: { min: 10 },
 243     URL: { min: 3, max: 2000 } // Length
 244   },
 245   ACTORS: {
 246     PUBLIC_KEY: { min: 10, max: 5000 }, // Length
 247     PRIVATE_KEY: { min: 10, max: 5000 }, // Length
 248     URL: { min: 3, max: 2000 }, // Length
 249     AVATAR: {
 250       EXTNAME: [ '.png', '.jpeg', '.jpg' ],
 251       FILE_SIZE: {
 252         max: 2 * 1024 * 1024 // 2MB
 253       }
 254     }
 255   },
 256   VIDEO_EVENTS: {
 257     COUNT: { min: 0 }
 258   },
 259   VIDEO_COMMENTS: {
 260     TEXT: { min: 1, max: 3000 }, // Length
 261     URL: { min: 3, max: 2000 } // Length
 262   },
 263   VIDEO_SHARE: {
 264     URL: { min: 3, max: 2000 } // Length
 265   }
 266 }
 267
 268 const RATES_LIMIT = {
 269   LOGIN: {
 270     WINDOW_MS: 5 * 60 * 1000, // 5 minutes
 271     MAX: 15 // 15 attempts
 272   }
 273 }
 274
 275 let VIDEO_VIEW_LIFETIME = 60000 * 60 // 1 hour
 276 const VIDEO_TRANSCODING_FPS = {
 277   MIN: 10,
 278   MAX: 30
 279 }
 280
 281 const VIDEO_RATE_TYPES: { [ id: string ]: VideoRateType } = {
 282   LIKE: 'like',
 283   DISLIKE: 'dislike'
 284 }
 285
 286 const VIDEO_CATEGORIES = {
 287   1: 'Music',
 288   2: 'Films',
 289   3: 'Vehicles',
 290   4: 'Art',
 291   5: 'Sports',
 292   6: 'Travels',
 293   7: 'Gaming',
 294   8: 'People',
 295   9: 'Comedy',
 296   10: 'Entertainment',
 297   11: 'News',
 298   12: 'How To',
 299   13: 'Education',
 300   14: 'Activism',
 301   15: 'Science & Technology',
 302   16: 'Animals',
 303   17: 'Kids',
 304   18: 'Food'
 305 }
 306
 307 // See https://creativecommons.org/licenses/?lang=en
 308 const VIDEO_LICENCES = {
 309   1: 'Attribution',
 310   2: 'Attribution - Share Alike',
 311   3: 'Attribution - No Derivatives',
 312   4: 'Attribution - Non Commercial',
 313   5: 'Attribution - Non Commercial - Share Alike',
 314   6: 'Attribution - Non Commercial - No Derivatives',
 315   7: 'Public Domain Dedication'
 316 }
 317
 318 const VIDEO_LANGUAGES = buildLanguages()
 319
 320 const VIDEO_PRIVACIES = {
 321   [VideoPrivacy.PUBLIC]: 'Public',
 322   [VideoPrivacy.UNLISTED]: 'Unlisted',
 323   [VideoPrivacy.PRIVATE]: 'Private'
 324 }
 325
 326 const VIDEO_MIMETYPE_EXT = {
 327   'video/webm': '.webm',
 328   'video/ogg': '.ogv',
 329   'video/mp4': '.mp4'
 330 }
 331
 332 const IMAGE_MIMETYPE_EXT = {
 333   'image/png': '.png',
 334   'image/jpg': '.jpg',
 335   'image/jpeg': '.jpg'
 336 }
 337
 338 // ---------------------------------------------------------------------------
 339
 340 const SERVER_ACTOR_NAME = 'peertube'
 341
 342 const ACTIVITY_PUB = {
 343   POTENTIAL_ACCEPT_HEADERS: [
 344     'application/activity+json',
 345     'application/ld+json',
 346     'application/ld+json; profile="https://www.w3.org/ns/activitystreams"'
 347   ],
 348   ACCEPT_HEADER: 'application/activity+json, application/ld+json',
 349   PUBLIC: 'https://www.w3.org/ns/activitystreams#Public',
 350   COLLECTION_ITEMS_PER_PAGE: 10,
 351   FETCH_PAGE_LIMIT: 100,
 352   URL_MIME_TYPES: {
 353     VIDEO: Object.keys(VIDEO_MIMETYPE_EXT),
 354     TORRENT: [ 'application/x-bittorrent' ],
 355     MAGNET: [ 'application/x-bittorrent;x-scheme-handler/magnet' ]
 356   },
 357   MAX_RECURSION_COMMENTS: 100,
 358   ACTOR_REFRESH_INTERVAL: 3600 * 24 * 1000 // 1 day
 359 }
 360
 361 const ACTIVITY_PUB_ACTOR_TYPES: { [ id: string ]: ActivityPubActorType } = {
 362   GROUP: 'Group',
 363   PERSON: 'Person',
 364   APPLICATION: 'Application'
 365 }
 366
 367 // ---------------------------------------------------------------------------
 368
 369 const PRIVATE_RSA_KEY_SIZE = 2048
 370
 371 // Password encryption
 372 const BCRYPT_SALT_SIZE = 10
 373
 374 const USER_PASSWORD_RESET_LIFETIME = 60000 * 5 // 5 minutes
 375
 376 const NSFW_POLICY_TYPES: { [ id: string]: NSFWPolicyType } = {
 377   DO_NOT_LIST: 'do_not_list',
 378   BLUR: 'blur',
 379   DISPLAY: 'display'
 380 }
 381
 382 // ---------------------------------------------------------------------------
 383
 384 // Express static paths (router)
 385 const STATIC_PATHS = {
 386   PREVIEWS: '/static/previews/',
 387   THUMBNAILS: '/static/thumbnails/',
 388   TORRENTS: '/static/torrents/',
 389   WEBSEED: '/static/webseed/',
 390   AVATARS: '/static/avatars/'
 391 }
 392
 393 // Cache control
 394 let STATIC_MAX_AGE = '30d'
 395
 396 // Videos thumbnail size
 397 const THUMBNAILS_SIZE = {
 398   width: 200,
 399   height: 110
 400 }
 401 const PREVIEWS_SIZE = {
 402   width: 560,
 403   height: 315
 404 }
 405 const AVATARS_SIZE = {
 406   width: 120,
 407   height: 120
 408 }
 409
 410 const EMBED_SIZE = {
 411   width: 560,
 412   height: 315
 413 }
 414
 415 // Sub folders of cache directory
 416 const CACHE = {
 417   DIRECTORIES: {
 418     PREVIEWS: join(CONFIG.STORAGE.CACHE_DIR, 'previews')
 419   }
 420 }
 421
 422 const ACCEPT_HEADERS = [ 'html', 'application/json' ].concat(ACTIVITY_PUB.POTENTIAL_ACCEPT_HEADERS)
 423
 424 // ---------------------------------------------------------------------------
 425
 426 const OPENGRAPH_AND_OEMBED_COMMENT = '<!-- open graph and oembed tags -->'
 427
 428 // ---------------------------------------------------------------------------
 429
 430 const FEEDS = {
 431   COUNT: 20
 432 }
 433
 434 // ---------------------------------------------------------------------------
 435
 436 // Special constants for a test instance
 437 if (isTestInstance() === true) {
 438   ACTOR_FOLLOW_SCORE.BASE = 20
 439   REMOTE_SCHEME.HTTP = 'http'
 440   REMOTE_SCHEME.WS = 'ws'
 441   STATIC_MAX_AGE = '0'
 442   ACTIVITY_PUB.COLLECTION_ITEMS_PER_PAGE = 2
 443   ACTIVITY_PUB.ACTOR_REFRESH_INTERVAL = 10 * 1000 // 10 seconds
 444   CONSTRAINTS_FIELDS.ACTORS.AVATAR.FILE_SIZE.max = 100 * 1024 // 100KB
 445   SCHEDULER_INTERVAL = 10000
 446   VIDEO_VIEW_LIFETIME = 1000 // 1 second
 447 }
 448
 449 updateWebserverConfig()
 450
 451 // ---------------------------------------------------------------------------
 452
 453 export {
 454   API_VERSION,
 455   AVATARS_SIZE,
 456   ACCEPT_HEADERS,
 457   BCRYPT_SALT_SIZE,
 458   CACHE,
 459   CONFIG,
 460   CONSTRAINTS_FIELDS,
 461   EMBED_SIZE,
 462   JOB_CONCURRENCY,
 463   JOB_ATTEMPTS,
 464   LAST_MIGRATION_VERSION,
 465   OAUTH_LIFETIME,
 466   OPENGRAPH_AND_OEMBED_COMMENT,
 467   BROADCAST_CONCURRENCY,
 468   PAGINATION_COUNT_DEFAULT,
 469   ACTOR_FOLLOW_SCORE,
 470   PREVIEWS_SIZE,
 471   REMOTE_SCHEME,
 472   FOLLOW_STATES,
 473   SERVER_ACTOR_NAME,
 474   PRIVATE_RSA_KEY_SIZE,
 475   ROUTE_CACHE_LIFETIME,
 476   SORTABLE_COLUMNS,
 477   FEEDS,
 478   NSFW_POLICY_TYPES,
 479   STATIC_MAX_AGE,
 480   STATIC_PATHS,
 481   ACTIVITY_PUB,
 482   ACTIVITY_PUB_ACTOR_TYPES,
 483   THUMBNAILS_SIZE,
 484   VIDEO_CATEGORIES,
 485   VIDEO_LANGUAGES,
 486   VIDEO_PRIVACIES,
 487   VIDEO_LICENCES,
 488   VIDEO_RATE_TYPES,
 489   VIDEO_MIMETYPE_EXT,
 490   VIDEO_TRANSCODING_FPS,
 491   JOB_REQUEST_TIMEOUT,
 492   JOB_REQUEST_TTL,
 493   USER_PASSWORD_RESET_LIFETIME,
 494   IMAGE_MIMETYPE_EXT,
 495   SCHEDULER_INTERVAL,
 496   RATES_LIMIT,
 497   JOB_COMPLETED_LIFETIME,
 498   VIDEO_VIEW_LIFETIME
 499 }
 500
 501 // ---------------------------------------------------------------------------
 502
 503 function getLocalConfigFilePath () {
 504   const configSources = config.util.getConfigSources()
 505   if (configSources.length === 0) throw new Error('Invalid config source.')
 506
 507   let filename = 'local'
 508   if (process.env.NODE_ENV) filename += `-${process.env.NODE_ENV}`
 509   if (process.env.NODE_APP_INSTANCE) filename += `-${process.env.NODE_APP_INSTANCE}`
 510
 511   return join(dirname(configSources[ 0 ].name), filename + '.json')
 512 }
 513
 514 function updateWebserverConfig () {
 515   CONFIG.WEBSERVER.URL = sanitizeUrl(CONFIG.WEBSERVER.SCHEME + '://' + CONFIG.WEBSERVER.HOSTNAME + ':' + CONFIG.WEBSERVER.PORT)
 516   CONFIG.WEBSERVER.HOST = sanitizeHost(CONFIG.WEBSERVER.HOSTNAME + ':' + CONFIG.WEBSERVER.PORT, REMOTE_SCHEME.HTTP)
 517 }
 518
 519 function buildLanguages () {
 520   const iso639 = require('iso-639-3')
 521
 522   const languages: { [ id: string ]: string } = {}
 523
 524   const signLanguages = [
 525     'sgn', // Sign languages (macro language)
 526     'ase', // American
 527     'sdl', // Arabian
 528     'bfi', // British
 529     'bzs', // Brazilian
 530     'csl', // Chinese
 531     'cse', // Czech
 532     'dsl', // Danish
 533     'fsl', // French
 534     'gsg', // German
 535     'pks', // Pakistan
 536     'jsl', // Japanese
 537     'sfs', // South African
 538     'swl', // Swedish
 539     'rsl' // Russian
 540   ]
 541
 542   // Only add ISO639-1 languages and some sign languages (ISO639-3)
 543   iso639
 544     .filter(l => {
 545       return (l.iso6391 !== null && l.type === 'living') ||
 546         signLanguages.indexOf(l.iso6393) !== -1
 547     })
 548     .forEach(l => languages[l.iso6391 || l.iso6393] = l.name)
 549
 550   return languages
 551 }
 552
 553 export function reloadConfig () {
 554
 555   function directory () {
 556     if (process.env.NODE_CONFIG_DIR) {
 557       return process.env.NODE_CONFIG_DIR
 558     }
 559
 560     return join(root(), 'config')
 561   }
 562
 563   function purge () {
 564     for (const fileName in require.cache) {
 565       if (-1 === fileName.indexOf(directory())) {
 566         continue
 567       }
 568
 569       delete require.cache[fileName]
 570     }
 571
 572     delete require.cache[require.resolve('config')]
 573   }
 574
 575   purge()
 576
 577   config = require('config')
 578
 579   updateWebserverConfig()
 580 }