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