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   },
 155   USER: {
 156     get VIDEO_QUOTA () { return config.get<number>('user.video_quota') }
 157   },
 158   TRANSCODING: {
 159     get ENABLED () { return config.get<boolean>('transcoding.enabled') },
 160     get THREADS () { return config.get<number>('transcoding.threads') },
 161     RESOLUTIONS: {
 162       get '240p' () { return config.get<boolean>('transcoding.resolutions.240p') },
 163       get '360p' () { return config.get<boolean>('transcoding.resolutions.360p') },
 164       get '480p' () { return config.get<boolean>('transcoding.resolutions.480p') },
 165       get '720p' () { return config.get<boolean>('transcoding.resolutions.720p') },
 166       get '1080p' () { return config.get<boolean>('transcoding.resolutions.1080p') }
 167     }
 168   },
 169   CACHE: {
 170     PREVIEWS: {
 171       get SIZE () { return config.get<number>('cache.previews.size') }
 172     }
 173   },
 174   INSTANCE: {
 175     get NAME () { return config.get<string>('instance.name') },
 176     get SHORT_DESCRIPTION () { return config.get<string>('instance.short_description') },
 177     get DESCRIPTION () { return config.get<string>('instance.description') },
 178     get TERMS () { return config.get<string>('instance.terms') },
 179     get DEFAULT_CLIENT_ROUTE () { return config.get<string>('instance.default_client_route') },
 180     get DEFAULT_NSFW_POLICY () { return config.get<NSFWPolicyType>('instance.default_nsfw_policy') },
 181     CUSTOMIZATIONS: {
 182       get JAVASCRIPT () { return config.get<string>('instance.customizations.javascript') },
 183       get CSS () { return config.get<string>('instance.customizations.css') }
 184     },
 185     get ROBOTS () { return config.get<string>('instance.robots') }
 186   },
 187   SERVICES: {
 188     TWITTER: {
 189       get USERNAME () { return config.get<string>('services.twitter.username') },
 190       get WHITELISTED () { return config.get<boolean>('services.twitter.whitelisted') }
 191     }
 192   }
 193 }
 194
 195 // ---------------------------------------------------------------------------
 196
 197 const CONSTRAINTS_FIELDS = {
 198   USERS: {
 199     NAME: { min: 3, max: 120 }, // Length
 200     DESCRIPTION: { min: 3, max: 250 }, // Length
 201     USERNAME: { min: 3, max: 20 }, // Length
 202     PASSWORD: { min: 6, max: 255 }, // Length
 203     VIDEO_QUOTA: { min: -1 }
 204   },
 205   VIDEO_ABUSES: {
 206     REASON: { min: 2, max: 300 } // Length
 207   },
 208   VIDEO_CHANNELS: {
 209     NAME: { min: 3, max: 120 }, // Length
 210     DESCRIPTION: { min: 3, max: 500 }, // Length
 211     SUPPORT: { min: 3, max: 500 }, // Length
 212     URL: { min: 3, max: 2000 } // Length
 213   },
 214   VIDEOS: {
 215     NAME: { min: 3, max: 120 }, // Length
 216     LANGUAGE: { min: 1, max: 10 }, // Length
 217     TRUNCATED_DESCRIPTION: { min: 3, max: 250 }, // Length
 218     DESCRIPTION: { min: 3, max: 10000 }, // Length
 219     SUPPORT: { min: 3, max: 500 }, // Length
 220     IMAGE: {
 221       EXTNAME: [ '.jpg', '.jpeg' ],
 222       FILE_SIZE: {
 223         max: 2 * 1024 * 1024 // 2MB
 224       }
 225     },
 226     EXTNAME: [ '.mp4', '.ogv', '.webm' ],
 227     INFO_HASH: { min: 40, max: 40 }, // Length, info hash is 20 bytes length but we represent it in hexadecimal so 20 * 2
 228     DURATION: { min: 1 }, // Number
 229     TAGS: { min: 0, max: 5 }, // Number of total tags
 230     TAG: { min: 2, max: 30 }, // Length
 231     THUMBNAIL: { min: 2, max: 30 },
 232     THUMBNAIL_DATA: { min: 0, max: 20000 }, // Bytes
 233     VIEWS: { min: 0 },
 234     LIKES: { min: 0 },
 235     DISLIKES: { min: 0 },
 236     FILE_SIZE: { min: 10 },
 237     URL: { min: 3, max: 2000 } // Length
 238   },
 239   ACTORS: {
 240     PUBLIC_KEY: { min: 10, max: 5000 }, // Length
 241     PRIVATE_KEY: { min: 10, max: 5000 }, // Length
 242     URL: { min: 3, max: 2000 }, // Length
 243     AVATAR: {
 244       EXTNAME: [ '.png', '.jpeg', '.jpg' ],
 245       FILE_SIZE: {
 246         max: 2 * 1024 * 1024 // 2MB
 247       }
 248     }
 249   },
 250   VIDEO_EVENTS: {
 251     COUNT: { min: 0 }
 252   },
 253   VIDEO_COMMENTS: {
 254     TEXT: { min: 1, max: 3000 }, // Length
 255     URL: { min: 3, max: 2000 } // Length
 256   },
 257   VIDEO_SHARE: {
 258     URL: { min: 3, max: 2000 } // Length
 259   }
 260 }
 261
 262 const RATES_LIMIT = {
 263   LOGIN: {
 264     WINDOW_MS: 5 * 60 * 1000, // 5 minutes
 265     MAX: 15 // 15 attempts
 266   }
 267 }
 268
 269 let VIDEO_VIEW_LIFETIME = 60000 * 60 // 1 hour
 270 const VIDEO_TRANSCODING_FPS = {
 271   MIN: 10,
 272   MAX: 30
 273 }
 274
 275 const VIDEO_RATE_TYPES: { [ id: string ]: VideoRateType } = {
 276   LIKE: 'like',
 277   DISLIKE: 'dislike'
 278 }
 279
 280 const VIDEO_CATEGORIES = {
 281   1: 'Music',
 282   2: 'Films',
 283   3: 'Vehicles',
 284   4: 'Art',
 285   5: 'Sports',
 286   6: 'Travels',
 287   7: 'Gaming',
 288   8: 'People',
 289   9: 'Comedy',
 290   10: 'Entertainment',
 291   11: 'News',
 292   12: 'How To',
 293   13: 'Education',
 294   14: 'Activism',
 295   15: 'Science & Technology',
 296   16: 'Animals',
 297   17: 'Kids',
 298   18: 'Food'
 299 }
 300
 301 // See https://creativecommons.org/licenses/?lang=en
 302 const VIDEO_LICENCES = {
 303   1: 'Attribution',
 304   2: 'Attribution - Share Alike',
 305   3: 'Attribution - No Derivatives',
 306   4: 'Attribution - Non Commercial',
 307   5: 'Attribution - Non Commercial - Share Alike',
 308   6: 'Attribution - Non Commercial - No Derivatives',
 309   7: 'Public Domain Dedication'
 310 }
 311
 312 const VIDEO_LANGUAGES = buildLanguages()
 313
 314 const VIDEO_PRIVACIES = {
 315   [VideoPrivacy.PUBLIC]: 'Public',
 316   [VideoPrivacy.UNLISTED]: 'Unlisted',
 317   [VideoPrivacy.PRIVATE]: 'Private'
 318 }
 319
 320 const VIDEO_MIMETYPE_EXT = {
 321   'video/webm': '.webm',
 322   'video/ogg': '.ogv',
 323   'video/mp4': '.mp4'
 324 }
 325
 326 const IMAGE_MIMETYPE_EXT = {
 327   'image/png': '.png',
 328   'image/jpg': '.jpg',
 329   'image/jpeg': '.jpg'
 330 }
 331
 332 // ---------------------------------------------------------------------------
 333
 334 const SERVER_ACTOR_NAME = 'peertube'
 335
 336 const ACTIVITY_PUB = {
 337   POTENTIAL_ACCEPT_HEADERS: [
 338     'application/activity+json',
 339     'application/ld+json',
 340     'application/ld+json; profile="https://www.w3.org/ns/activitystreams"'
 341   ],
 342   ACCEPT_HEADER: 'application/activity+json, application/ld+json',
 343   PUBLIC: 'https://www.w3.org/ns/activitystreams#Public',
 344   COLLECTION_ITEMS_PER_PAGE: 10,
 345   FETCH_PAGE_LIMIT: 100,
 346   URL_MIME_TYPES: {
 347     VIDEO: Object.keys(VIDEO_MIMETYPE_EXT),
 348     TORRENT: [ 'application/x-bittorrent' ],
 349     MAGNET: [ 'application/x-bittorrent;x-scheme-handler/magnet' ]
 350   },
 351   MAX_RECURSION_COMMENTS: 100,
 352   ACTOR_REFRESH_INTERVAL: 3600 * 24 * 1000 // 1 day
 353 }
 354
 355 const ACTIVITY_PUB_ACTOR_TYPES: { [ id: string ]: ActivityPubActorType } = {
 356   GROUP: 'Group',
 357   PERSON: 'Person',
 358   APPLICATION: 'Application'
 359 }
 360
 361 // ---------------------------------------------------------------------------
 362
 363 const PRIVATE_RSA_KEY_SIZE = 2048
 364
 365 // Password encryption
 366 const BCRYPT_SALT_SIZE = 10
 367
 368 const USER_PASSWORD_RESET_LIFETIME = 60000 * 5 // 5 minutes
 369
 370 const NSFW_POLICY_TYPES: { [ id: string]: NSFWPolicyType } = {
 371   DO_NOT_LIST: 'do_not_list',
 372   BLUR: 'blur',
 373   DISPLAY: 'display'
 374 }
 375
 376 // ---------------------------------------------------------------------------
 377
 378 // Express static paths (router)
 379 const STATIC_PATHS = {
 380   PREVIEWS: '/static/previews/',
 381   THUMBNAILS: '/static/thumbnails/',
 382   TORRENTS: '/static/torrents/',
 383   WEBSEED: '/static/webseed/',
 384   AVATARS: '/static/avatars/'
 385 }
 386
 387 // Cache control
 388 let STATIC_MAX_AGE = '30d'
 389
 390 // Videos thumbnail size
 391 const THUMBNAILS_SIZE = {
 392   width: 200,
 393   height: 110
 394 }
 395 const PREVIEWS_SIZE = {
 396   width: 560,
 397   height: 315
 398 }
 399 const AVATARS_SIZE = {
 400   width: 120,
 401   height: 120
 402 }
 403
 404 const EMBED_SIZE = {
 405   width: 560,
 406   height: 315
 407 }
 408
 409 // Sub folders of cache directory
 410 const CACHE = {
 411   DIRECTORIES: {
 412     PREVIEWS: join(CONFIG.STORAGE.CACHE_DIR, 'previews')
 413   }
 414 }
 415
 416 const ACCEPT_HEADERS = [ 'html', 'application/json' ].concat(ACTIVITY_PUB.POTENTIAL_ACCEPT_HEADERS)
 417
 418 // ---------------------------------------------------------------------------
 419
 420 const OPENGRAPH_AND_OEMBED_COMMENT = '<!-- open graph and oembed tags -->'
 421
 422 // ---------------------------------------------------------------------------
 423
 424 const FEEDS = {
 425   COUNT: 20
 426 }
 427
 428 // ---------------------------------------------------------------------------
 429
 430 // Special constants for a test instance
 431 if (isTestInstance() === true) {
 432   ACTOR_FOLLOW_SCORE.BASE = 20
 433   REMOTE_SCHEME.HTTP = 'http'
 434   REMOTE_SCHEME.WS = 'ws'
 435   STATIC_MAX_AGE = '0'
 436   ACTIVITY_PUB.COLLECTION_ITEMS_PER_PAGE = 2
 437   ACTIVITY_PUB.ACTOR_REFRESH_INTERVAL = 10 * 1000 // 10 seconds
 438   CONSTRAINTS_FIELDS.ACTORS.AVATAR.FILE_SIZE.max = 100 * 1024 // 100KB
 439   SCHEDULER_INTERVAL = 10000
 440   VIDEO_VIEW_LIFETIME = 1000 // 1 second
 441 }
 442
 443 updateWebserverConfig()
 444
 445 // ---------------------------------------------------------------------------
 446
 447 export {
 448   API_VERSION,
 449   AVATARS_SIZE,
 450   ACCEPT_HEADERS,
 451   BCRYPT_SALT_SIZE,
 452   CACHE,
 453   CONFIG,
 454   CONSTRAINTS_FIELDS,
 455   EMBED_SIZE,
 456   JOB_CONCURRENCY,
 457   JOB_ATTEMPTS,
 458   LAST_MIGRATION_VERSION,
 459   OAUTH_LIFETIME,
 460   OPENGRAPH_AND_OEMBED_COMMENT,
 461   BROADCAST_CONCURRENCY,
 462   PAGINATION_COUNT_DEFAULT,
 463   ACTOR_FOLLOW_SCORE,
 464   PREVIEWS_SIZE,
 465   REMOTE_SCHEME,
 466   FOLLOW_STATES,
 467   SERVER_ACTOR_NAME,
 468   PRIVATE_RSA_KEY_SIZE,
 469   ROUTE_CACHE_LIFETIME,
 470   SORTABLE_COLUMNS,
 471   FEEDS,
 472   NSFW_POLICY_TYPES,
 473   STATIC_MAX_AGE,
 474   STATIC_PATHS,
 475   ACTIVITY_PUB,
 476   ACTIVITY_PUB_ACTOR_TYPES,
 477   THUMBNAILS_SIZE,
 478   VIDEO_CATEGORIES,
 479   VIDEO_LANGUAGES,
 480   VIDEO_PRIVACIES,
 481   VIDEO_LICENCES,
 482   VIDEO_RATE_TYPES,
 483   VIDEO_MIMETYPE_EXT,
 484   VIDEO_TRANSCODING_FPS,
 485   JOB_REQUEST_TIMEOUT,
 486   JOB_REQUEST_TTL,
 487   USER_PASSWORD_RESET_LIFETIME,
 488   IMAGE_MIMETYPE_EXT,
 489   SCHEDULER_INTERVAL,
 490   RATES_LIMIT,
 491   JOB_COMPLETED_LIFETIME,
 492   VIDEO_VIEW_LIFETIME
 493 }
 494
 495 // ---------------------------------------------------------------------------
 496
 497 function getLocalConfigFilePath () {
 498   const configSources = config.util.getConfigSources()
 499   if (configSources.length === 0) throw new Error('Invalid config source.')
 500
 501   let filename = 'local'
 502   if (process.env.NODE_ENV) filename += `-${process.env.NODE_ENV}`
 503   if (process.env.NODE_APP_INSTANCE) filename += `-${process.env.NODE_APP_INSTANCE}`
 504
 505   return join(dirname(configSources[ 0 ].name), filename + '.json')
 506 }
 507
 508 function updateWebserverConfig () {
 509   CONFIG.WEBSERVER.URL = sanitizeUrl(CONFIG.WEBSERVER.SCHEME + '://' + CONFIG.WEBSERVER.HOSTNAME + ':' + CONFIG.WEBSERVER.PORT)
 510   CONFIG.WEBSERVER.HOST = sanitizeHost(CONFIG.WEBSERVER.HOSTNAME + ':' + CONFIG.WEBSERVER.PORT, REMOTE_SCHEME.HTTP)
 511 }
 512
 513 function buildLanguages () {
 514   const iso639 = require('iso-639-3')
 515
 516   const languages: { [ id: string ]: string } = {}
 517
 518   const signLanguages = [
 519     'sgn', // Sign languages (macro language)
 520     'ase', // American
 521     'sdl', // Arabian
 522     'bfi', // British
 523     'bzs', // Brazilian
 524     'csl', // Chinese
 525     'cse', // Czech
 526     'dsl', // Danish
 527     'fsl', // French
 528     'gsg', // German
 529     'pks', // Pakistan
 530     'jsl', // Japanese
 531     'sfs', // South African
 532     'swl', // Swedish
 533     'rsl' // Russian
 534   ]
 535
 536   // Only add ISO639-1 languages and some sign languages (ISO639-3)
 537   iso639
 538     .filter(l => {
 539       return (l.iso6391 !== null && l.type === 'living') ||
 540         signLanguages.indexOf(l.iso6393) !== -1
 541     })
 542     .forEach(l => languages[l.iso6391 || l.iso6393] = l.name)
 543
 544   return languages
 545 }
 546
 547 export function reloadConfig () {
 548
 549   function directory () {
 550     if (process.env.NODE_CONFIG_DIR) {
 551       return process.env.NODE_CONFIG_DIR
 552     }
 553
 554     return join(root(), 'config')
 555   }
 556
 557   function purge () {
 558     for (const fileName in require.cache) {
 559       if (-1 === fileName.indexOf(directory())) {
 560         continue
 561       }
 562
 563       delete require.cache[fileName]
 564     }
 565
 566     delete require.cache[require.resolve('config')]
 567   }
 568
 569   purge()
 570
 571   config = require('config')
 572
 573   updateWebserverConfig()
 574 }