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