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