server/initializers/constants.ts

   1 import { IConfig } from 'config'
   2 import { dirname, join } from 'path'
   3 import { JobType, VideoRateType, VideoState } from '../../shared/models'
   4 import { ActivityPubActorType } from '../../shared/models/activitypub'
   5 import { FollowState } from '../../shared/models/actors'
   6 import { VideoPrivacy, VideoAbuseState, VideoImportState } 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 import { invert } from 'lodash'
  11
  12 // Use a variable to reload the configuration if we need
  13 let config: IConfig = require('config')
  14
  15 // ---------------------------------------------------------------------------
  16
  17 const LAST_MIGRATION_VERSION = 255
  18
  19 // ---------------------------------------------------------------------------
  20
  21 // API version
  22 const API_VERSION = 'v1'
  23
  24 const PAGINATION = {
  25   COUNT: {
  26     DEFAULT: 15,
  27     MAX: 100
  28   }
  29 }
  30
  31 // Sortable columns per schema
  32 const SORTABLE_COLUMNS = {
  33   USERS: [ 'id', 'username', 'createdAt' ],
  34   USER_SUBSCRIPTIONS: [ 'id', 'createdAt' ],
  35   ACCOUNTS: [ 'createdAt' ],
  36   JOBS: [ 'createdAt' ],
  37   VIDEO_ABUSES: [ 'id', 'createdAt', 'state' ],
  38   VIDEO_CHANNELS: [ 'id', 'name', 'updatedAt', 'createdAt' ],
  39   VIDEOS: [ 'name', 'duration', 'createdAt', 'publishedAt', 'views', 'likes' ],
  40   VIDEO_IMPORTS: [ 'createdAt' ],
  41   VIDEO_COMMENT_THREADS: [ 'createdAt' ],
  42   BLACKLISTS: [ 'id', 'name', 'duration', 'views', 'likes', 'dislikes', 'uuid', 'createdAt' ],
  43   FOLLOWERS: [ 'createdAt' ],
  44   FOLLOWING: [ 'createdAt' ],
  45
  46   VIDEOS_SEARCH: [ 'match', 'name', 'duration', 'createdAt', 'publishedAt', 'views', 'likes' ],
  47   VIDEO_CHANNELS_SEARCH: [ 'match', 'displayName', 'createdAt' ]
  48 }
  49
  50 const OAUTH_LIFETIME = {
  51   ACCESS_TOKEN: 3600 * 24, // 1 day, for upload
  52   REFRESH_TOKEN: 1209600 // 2 weeks
  53 }
  54
  55 const ROUTE_CACHE_LIFETIME = {
  56   FEEDS: '15 minutes',
  57   ROBOTS: '2 hours',
  58   NODEINFO: '10 minutes',
  59   DNT_POLICY: '1 week',
  60   ACTIVITY_PUB: {
  61     VIDEOS: '1 second' // 1 second, cache concurrent requests after a broadcast for example
  62   }
  63 }
  64
  65 // ---------------------------------------------------------------------------
  66
  67 // Number of points we add/remove after a successful/bad request
  68 const ACTOR_FOLLOW_SCORE = {
  69   PENALTY: -10,
  70   BONUS: 10,
  71   BASE: 1000,
  72   MAX: 10000
  73 }
  74
  75 const FOLLOW_STATES: { [ id: string ]: FollowState } = {
  76   PENDING: 'pending',
  77   ACCEPTED: 'accepted'
  78 }
  79
  80 const REMOTE_SCHEME = {
  81   HTTP: 'https',
  82   WS: 'wss'
  83 }
  84
  85 const JOB_ATTEMPTS: { [ id in JobType ]: number } = {
  86   'activitypub-http-broadcast': 5,
  87   'activitypub-http-unicast': 5,
  88   'activitypub-http-fetcher': 5,
  89   'activitypub-follow': 5,
  90   'video-file-import': 1,
  91   'video-file': 1,
  92   'video-import': 1,
  93   'email': 5
  94 }
  95 const JOB_CONCURRENCY: { [ id in JobType ]: number } = {
  96   'activitypub-http-broadcast': 1,
  97   'activitypub-http-unicast': 5,
  98   'activitypub-http-fetcher': 1,
  99   'activitypub-follow': 3,
 100   'video-file-import': 1,
 101   'video-file': 1,
 102   'video-import': 1,
 103   'email': 5
 104 }
 105 const JOB_TTL: { [ id in JobType ]: number } = {
 106   'activitypub-http-broadcast': 60000 * 10, // 10 minutes
 107   'activitypub-http-unicast': 60000 * 10, // 10 minutes
 108   'activitypub-http-fetcher': 60000 * 10, // 10 minutes
 109   'activitypub-follow': 60000 * 10, // 10 minutes
 110   'video-file-import': 1000 * 3600, // 1 hour
 111   'video-file': 1000 * 3600 * 48, // 2 days, transcoding could be long
 112   'video-import': 1000 * 3600 * 5, // 5 hours
 113   'email': 60000 * 10 // 10 minutes
 114 }
 115 const BROADCAST_CONCURRENCY = 10 // How many requests in parallel we do in activitypub-http-broadcast job
 116 const CRAWL_REQUEST_CONCURRENCY = 1 // How many requests in parallel to fetch remote data (likes, shares...)
 117 const JOB_REQUEST_TIMEOUT = 3000 // 3 seconds
 118 const JOB_COMPLETED_LIFETIME = 60000 * 60 * 24 * 2 // 2 days
 119
 120 // 1 hour
 121 let SCHEDULER_INTERVALS_MS = {
 122   badActorFollow: 60000 * 60, // 1 hour
 123   removeOldJobs: 60000 * 60, // 1 hour
 124   updateVideos: 60000, // 1 minute
 125   youtubeDLUpdate: 60000 * 60 * 24 // 1 day
 126 }
 127
 128 // ---------------------------------------------------------------------------
 129
 130 const CONFIG = {
 131   CUSTOM_FILE: getLocalConfigFilePath(),
 132   LISTEN: {
 133     PORT: config.get<number>('listen.port'),
 134     HOSTNAME: config.get<string>('listen.hostname')
 135   },
 136   DATABASE: {
 137     DBNAME: 'peertube' + config.get<string>('database.suffix'),
 138     HOSTNAME: config.get<string>('database.hostname'),
 139     PORT: config.get<number>('database.port'),
 140     USERNAME: config.get<string>('database.username'),
 141     PASSWORD: config.get<string>('database.password'),
 142     POOL: {
 143       MAX: config.get<number>('database.pool.max')
 144     }
 145   },
 146   REDIS: {
 147     HOSTNAME: config.has('redis.hostname') ? config.get<string>('redis.hostname') : null,
 148     PORT: config.has('redis.port') ? config.get<number>('redis.port') : null,
 149     SOCKET: config.has('redis.socket') ? config.get<string>('redis.socket') : null,
 150     AUTH: config.has('redis.auth') ? config.get<string>('redis.auth') : null,
 151     DB: config.has('redis.db') ? config.get<number>('redis.db') : null
 152   },
 153   SMTP: {
 154     HOSTNAME: config.get<string>('smtp.hostname'),
 155     PORT: config.get<number>('smtp.port'),
 156     USERNAME: config.get<string>('smtp.username'),
 157     PASSWORD: config.get<string>('smtp.password'),
 158     TLS: config.get<boolean>('smtp.tls'),
 159     DISABLE_STARTTLS: config.get<boolean>('smtp.disable_starttls'),
 160     CA_FILE: config.get<string>('smtp.ca_file'),
 161     FROM_ADDRESS: config.get<string>('smtp.from_address')
 162   },
 163   STORAGE: {
 164     AVATARS_DIR: buildPath(config.get<string>('storage.avatars')),
 165     LOG_DIR: buildPath(config.get<string>('storage.logs')),
 166     VIDEOS_DIR: buildPath(config.get<string>('storage.videos')),
 167     THUMBNAILS_DIR: buildPath(config.get<string>('storage.thumbnails')),
 168     PREVIEWS_DIR: buildPath(config.get<string>('storage.previews')),
 169     CAPTIONS_DIR: buildPath(config.get<string>('storage.captions')),
 170     TORRENTS_DIR: buildPath(config.get<string>('storage.torrents')),
 171     CACHE_DIR: buildPath(config.get<string>('storage.cache'))
 172   },
 173   WEBSERVER: {
 174     SCHEME: config.get<boolean>('webserver.https') === true ? 'https' : 'http',
 175     WS: config.get<boolean>('webserver.https') === true ? 'wss' : 'ws',
 176     HOSTNAME: config.get<string>('webserver.hostname'),
 177     PORT: config.get<number>('webserver.port'),
 178     URL: '',
 179     HOST: ''
 180   },
 181   TRUST_PROXY: config.get<string[]>('trust_proxy'),
 182   LOG: {
 183     LEVEL: config.get<string>('log.level')
 184   },
 185   SEARCH: {
 186     REMOTE_URI: {
 187       USERS: config.get<boolean>('search.remote_uri.users'),
 188       ANONYMOUS: config.get<boolean>('search.remote_uri.anonymous')
 189     }
 190   },
 191   ADMIN: {
 192     get EMAIL () { return config.get<string>('admin.email') }
 193   },
 194   SIGNUP: {
 195     get ENABLED () { return config.get<boolean>('signup.enabled') },
 196     get LIMIT () { return config.get<number>('signup.limit') },
 197     FILTERS: {
 198       CIDR: {
 199         get WHITELIST () { return config.get<string[]>('signup.filters.cidr.whitelist') },
 200         get BLACKLIST () { return config.get<string[]>('signup.filters.cidr.blacklist') }
 201       }
 202     }
 203   },
 204   USER: {
 205     get VIDEO_QUOTA () { return config.get<number>('user.video_quota') },
 206     get VIDEO_QUOTA_DAILY () { return config.get<number>('user.video_quota_daily') }
 207   },
 208   TRANSCODING: {
 209     get ENABLED () { return config.get<boolean>('transcoding.enabled') },
 210     get THREADS () { return config.get<number>('transcoding.threads') },
 211     RESOLUTIONS: {
 212       get '240p' () { return config.get<boolean>('transcoding.resolutions.240p') },
 213       get '360p' () { return config.get<boolean>('transcoding.resolutions.360p') },
 214       get '480p' () { return config.get<boolean>('transcoding.resolutions.480p') },
 215       get '720p' () { return config.get<boolean>('transcoding.resolutions.720p') },
 216       get '1080p' () { return config.get<boolean>('transcoding.resolutions.1080p') }
 217     }
 218   },
 219   IMPORT: {
 220     VIDEOS: {
 221       HTTP: {
 222         get ENABLED () { return config.get<boolean>('import.videos.http.enabled') }
 223       },
 224       TORRENT: {
 225         get ENABLED () { return config.get<boolean>('import.videos.torrent.enabled') }
 226       }
 227     }
 228   },
 229   CACHE: {
 230     PREVIEWS: {
 231       get SIZE () { return config.get<number>('cache.previews.size') }
 232     },
 233     VIDEO_CAPTIONS: {
 234       get SIZE () { return config.get<number>('cache.captions.size') }
 235     }
 236   },
 237   INSTANCE: {
 238     get NAME () { return config.get<string>('instance.name') },
 239     get SHORT_DESCRIPTION () { return config.get<string>('instance.short_description') },
 240     get DESCRIPTION () { return config.get<string>('instance.description') },
 241     get TERMS () { return config.get<string>('instance.terms') },
 242     get DEFAULT_CLIENT_ROUTE () { return config.get<string>('instance.default_client_route') },
 243     get DEFAULT_NSFW_POLICY () { return config.get<NSFWPolicyType>('instance.default_nsfw_policy') },
 244     CUSTOMIZATIONS: {
 245       get JAVASCRIPT () { return config.get<string>('instance.customizations.javascript') },
 246       get CSS () { return config.get<string>('instance.customizations.css') }
 247     },
 248     get ROBOTS () { return config.get<string>('instance.robots') }
 249   },
 250   SERVICES: {
 251     TWITTER: {
 252       get USERNAME () { return config.get<string>('services.twitter.username') },
 253       get WHITELISTED () { return config.get<boolean>('services.twitter.whitelisted') }
 254     }
 255   }
 256 }
 257
 258 // ---------------------------------------------------------------------------
 259
 260 const CONSTRAINTS_FIELDS = {
 261   USERS: {
 262     NAME: { min: 3, max: 120 }, // Length
 263     DESCRIPTION: { min: 3, max: 250 }, // Length
 264     USERNAME: { min: 3, max: 20 }, // Length
 265     PASSWORD: { min: 6, max: 255 }, // Length
 266     VIDEO_QUOTA: { min: -1 },
 267     VIDEO_QUOTA_DAILY: { min: -1 },
 268     BLOCKED_REASON: { min: 3, max: 250 } // Length
 269   },
 270   VIDEO_ABUSES: {
 271     REASON: { min: 2, max: 300 }, // Length
 272     MODERATION_COMMENT: { min: 2, max: 300 } // Length
 273   },
 274   VIDEO_BLACKLIST: {
 275     REASON: { min: 2, max: 300 } // Length
 276   },
 277   VIDEO_CHANNELS: {
 278     NAME: { min: 3, max: 120 }, // Length
 279     DESCRIPTION: { min: 3, max: 500 }, // Length
 280     SUPPORT: { min: 3, max: 500 }, // Length
 281     URL: { min: 3, max: 2000 } // Length
 282   },
 283   VIDEO_CAPTIONS: {
 284     CAPTION_FILE: {
 285       EXTNAME: [ '.vtt', '.srt' ],
 286       FILE_SIZE: {
 287         max: 2 * 1024 * 1024 // 2MB
 288       }
 289     }
 290   },
 291   VIDEO_IMPORTS: {
 292     URL: { min: 3, max: 2000 }, // Length
 293     TORRENT_NAME: { min: 3, max: 255 }, // Length
 294     TORRENT_FILE: {
 295       EXTNAME: [ '.torrent' ],
 296       FILE_SIZE: {
 297         max: 1024 * 200 // 200 KB
 298       }
 299     }
 300   },
 301   VIDEOS: {
 302     NAME: { min: 3, max: 120 }, // Length
 303     LANGUAGE: { min: 1, max: 10 }, // Length
 304     TRUNCATED_DESCRIPTION: { min: 3, max: 250 }, // Length
 305     DESCRIPTION: { min: 3, max: 10000 }, // Length
 306     SUPPORT: { min: 3, max: 500 }, // Length
 307     IMAGE: {
 308       EXTNAME: [ '.jpg', '.jpeg' ],
 309       FILE_SIZE: {
 310         max: 2 * 1024 * 1024 // 2MB
 311       }
 312     },
 313     EXTNAME: [ '.mp4', '.ogv', '.webm' ],
 314     INFO_HASH: { min: 40, max: 40 }, // Length, info hash is 20 bytes length but we represent it in hexadecimal so 20 * 2
 315     DURATION: { min: 0 }, // Number
 316     TAGS: { min: 0, max: 5 }, // Number of total tags
 317     TAG: { min: 2, max: 30 }, // Length
 318     THUMBNAIL: { min: 2, max: 30 },
 319     THUMBNAIL_DATA: { min: 0, max: 20000 }, // Bytes
 320     VIEWS: { min: 0 },
 321     LIKES: { min: 0 },
 322     DISLIKES: { min: 0 },
 323     FILE_SIZE: { min: 10 },
 324     URL: { min: 3, max: 2000 } // Length
 325   },
 326   ACTORS: {
 327     PUBLIC_KEY: { min: 10, max: 5000 }, // Length
 328     PRIVATE_KEY: { min: 10, max: 5000 }, // Length
 329     URL: { min: 3, max: 2000 }, // Length
 330     AVATAR: {
 331       EXTNAME: [ '.png', '.jpeg', '.jpg' ],
 332       FILE_SIZE: {
 333         max: 2 * 1024 * 1024 // 2MB
 334       }
 335     }
 336   },
 337   VIDEO_EVENTS: {
 338     COUNT: { min: 0 }
 339   },
 340   VIDEO_COMMENTS: {
 341     TEXT: { min: 1, max: 3000 }, // Length
 342     URL: { min: 3, max: 2000 } // Length
 343   },
 344   VIDEO_SHARE: {
 345     URL: { min: 3, max: 2000 } // Length
 346   }
 347 }
 348
 349 const RATES_LIMIT = {
 350   LOGIN: {
 351     WINDOW_MS: 5 * 60 * 1000, // 5 minutes
 352     MAX: 15 // 15 attempts
 353   }
 354 }
 355
 356 let VIDEO_VIEW_LIFETIME = 60000 * 60 // 1 hour
 357 const VIDEO_TRANSCODING_FPS = {
 358   MIN: 10,
 359   AVERAGE: 30,
 360   MAX: 60,
 361   KEEP_ORIGIN_FPS_RESOLUTION_MIN: 720 // We keep the original FPS on high resolutions (720 minimum)
 362 }
 363
 364 const VIDEO_RATE_TYPES: { [ id: string ]: VideoRateType } = {
 365   LIKE: 'like',
 366   DISLIKE: 'dislike'
 367 }
 368
 369 const FFMPEG_NICE: { [ id: string ]: number } = {
 370   THUMBNAIL: 2, // 2 just for don't blocking servers
 371   TRANSCODING: 15
 372 }
 373
 374 const VIDEO_CATEGORIES = {
 375   1: 'Music',
 376   2: 'Films',
 377   3: 'Vehicles',
 378   4: 'Art',
 379   5: 'Sports',
 380   6: 'Travels',
 381   7: 'Gaming',
 382   8: 'People',
 383   9: 'Comedy',
 384   10: 'Entertainment',
 385   11: 'News',
 386   12: 'How To',
 387   13: 'Education',
 388   14: 'Activism',
 389   15: 'Science & Technology',
 390   16: 'Animals',
 391   17: 'Kids',
 392   18: 'Food'
 393 }
 394
 395 // See https://creativecommons.org/licenses/?lang=en
 396 const VIDEO_LICENCES = {
 397   1: 'Attribution',
 398   2: 'Attribution - Share Alike',
 399   3: 'Attribution - No Derivatives',
 400   4: 'Attribution - Non Commercial',
 401   5: 'Attribution - Non Commercial - Share Alike',
 402   6: 'Attribution - Non Commercial - No Derivatives',
 403   7: 'Public Domain Dedication'
 404 }
 405
 406 const VIDEO_LANGUAGES = buildLanguages()
 407
 408 const VIDEO_PRIVACIES = {
 409   [VideoPrivacy.PUBLIC]: 'Public',
 410   [VideoPrivacy.UNLISTED]: 'Unlisted',
 411   [VideoPrivacy.PRIVATE]: 'Private'
 412 }
 413
 414 const VIDEO_STATES = {
 415   [VideoState.PUBLISHED]: 'Published',
 416   [VideoState.TO_TRANSCODE]: 'To transcode',
 417   [VideoState.TO_IMPORT]: 'To import'
 418 }
 419
 420 const VIDEO_IMPORT_STATES = {
 421   [VideoImportState.FAILED]: 'Failed',
 422   [VideoImportState.PENDING]: 'Pending',
 423   [VideoImportState.SUCCESS]: 'Success'
 424 }
 425
 426 const VIDEO_ABUSE_STATES = {
 427   [VideoAbuseState.PENDING]: 'Pending',
 428   [VideoAbuseState.REJECTED]: 'Rejected',
 429   [VideoAbuseState.ACCEPTED]: 'Accepted'
 430 }
 431
 432 const VIDEO_MIMETYPE_EXT = {
 433   'video/webm': '.webm',
 434   'video/ogg': '.ogv',
 435   'video/mp4': '.mp4'
 436 }
 437 const VIDEO_EXT_MIMETYPE = invert(VIDEO_MIMETYPE_EXT)
 438
 439 const IMAGE_MIMETYPE_EXT = {
 440   'image/png': '.png',
 441   'image/jpg': '.jpg',
 442   'image/jpeg': '.jpg'
 443 }
 444
 445 const VIDEO_CAPTIONS_MIMETYPE_EXT = {
 446   'text/vtt': '.vtt',
 447   'application/x-subrip': '.srt'
 448 }
 449
 450 const TORRENT_MIMETYPE_EXT = {
 451   'application/x-bittorrent': '.torrent'
 452 }
 453
 454 // ---------------------------------------------------------------------------
 455
 456 const SERVER_ACTOR_NAME = 'peertube'
 457
 458 const ACTIVITY_PUB = {
 459   POTENTIAL_ACCEPT_HEADERS: [
 460     'application/activity+json',
 461     'application/ld+json',
 462     'application/ld+json; profile="https://www.w3.org/ns/activitystreams"'
 463   ],
 464   ACCEPT_HEADER: 'application/activity+json, application/ld+json',
 465   PUBLIC: 'https://www.w3.org/ns/activitystreams#Public',
 466   COLLECTION_ITEMS_PER_PAGE: 10,
 467   FETCH_PAGE_LIMIT: 100,
 468   URL_MIME_TYPES: {
 469     VIDEO: Object.keys(VIDEO_MIMETYPE_EXT),
 470     TORRENT: [ 'application/x-bittorrent' ],
 471     MAGNET: [ 'application/x-bittorrent;x-scheme-handler/magnet' ]
 472   },
 473   MAX_RECURSION_COMMENTS: 100,
 474   ACTOR_REFRESH_INTERVAL: 3600 * 24 * 1000, // 1 day
 475   VIDEO_REFRESH_INTERVAL: 3600 * 24 * 1000 // 1 day
 476 }
 477
 478 const ACTIVITY_PUB_ACTOR_TYPES: { [ id: string ]: ActivityPubActorType } = {
 479   GROUP: 'Group',
 480   PERSON: 'Person',
 481   APPLICATION: 'Application'
 482 }
 483
 484 // ---------------------------------------------------------------------------
 485
 486 const PRIVATE_RSA_KEY_SIZE = 2048
 487
 488 // Password encryption
 489 const BCRYPT_SALT_SIZE = 10
 490
 491 const USER_PASSWORD_RESET_LIFETIME = 60000 * 5 // 5 minutes
 492
 493 const NSFW_POLICY_TYPES: { [ id: string]: NSFWPolicyType } = {
 494   DO_NOT_LIST: 'do_not_list',
 495   BLUR: 'blur',
 496   DISPLAY: 'display'
 497 }
 498
 499 // ---------------------------------------------------------------------------
 500
 501 // Express static paths (router)
 502 const STATIC_PATHS = {
 503   PREVIEWS: '/static/previews/',
 504   THUMBNAILS: '/static/thumbnails/',
 505   TORRENTS: '/static/torrents/',
 506   WEBSEED: '/static/webseed/',
 507   AVATARS: '/static/avatars/',
 508   VIDEO_CAPTIONS: '/static/video-captions/'
 509 }
 510 const STATIC_DOWNLOAD_PATHS = {
 511   TORRENTS: '/download/torrents/',
 512   VIDEOS: '/download/videos/'
 513 }
 514
 515 // Cache control
 516 let STATIC_MAX_AGE = '2h'
 517
 518 // Videos thumbnail size
 519 const THUMBNAILS_SIZE = {
 520   width: 200,
 521   height: 110
 522 }
 523 const PREVIEWS_SIZE = {
 524   width: 560,
 525   height: 315
 526 }
 527 const AVATARS_SIZE = {
 528   width: 120,
 529   height: 120
 530 }
 531
 532 const EMBED_SIZE = {
 533   width: 560,
 534   height: 315
 535 }
 536
 537 // Sub folders of cache directory
 538 const CACHE = {
 539   PREVIEWS: {
 540     DIRECTORY: join(CONFIG.STORAGE.CACHE_DIR, 'previews'),
 541     MAX_AGE: 1000 * 3600 * 3 // 3 hours
 542   },
 543   VIDEO_CAPTIONS: {
 544     DIRECTORY: join(CONFIG.STORAGE.CACHE_DIR, 'video-captions'),
 545     MAX_AGE: 1000 * 3600 * 3 // 3 hours
 546   }
 547 }
 548
 549 const ACCEPT_HEADERS = [ 'html', 'application/json' ].concat(ACTIVITY_PUB.POTENTIAL_ACCEPT_HEADERS)
 550
 551 // ---------------------------------------------------------------------------
 552
 553 const CUSTOM_HTML_TAG_COMMENTS = {
 554   TITLE: '<!-- title tag -->',
 555   DESCRIPTION: '<!-- description tag -->',
 556   CUSTOM_CSS: '<!-- custom css tag -->',
 557   OPENGRAPH_AND_OEMBED: '<!-- open graph and oembed tags -->'
 558 }
 559
 560 // ---------------------------------------------------------------------------
 561
 562 const FEEDS = {
 563   COUNT: 20
 564 }
 565
 566 // ---------------------------------------------------------------------------
 567
 568 const TRACKER_RATE_LIMITS = {
 569   INTERVAL: 60000 * 5, // 5 minutes
 570   ANNOUNCES_PER_IP_PER_INFOHASH: 15, // maximum announces per torrent in the interval
 571   ANNOUNCES_PER_IP: 30 // maximum announces for all our torrents in the interval
 572 }
 573
 574 // ---------------------------------------------------------------------------
 575
 576 // Special constants for a test instance
 577 if (isTestInstance() === true) {
 578   ACTOR_FOLLOW_SCORE.BASE = 20
 579
 580   REMOTE_SCHEME.HTTP = 'http'
 581   REMOTE_SCHEME.WS = 'ws'
 582
 583   STATIC_MAX_AGE = '0'
 584
 585   ACTIVITY_PUB.COLLECTION_ITEMS_PER_PAGE = 2
 586   ACTIVITY_PUB.ACTOR_REFRESH_INTERVAL = 10 * 1000 // 10 seconds
 587   ACTIVITY_PUB.VIDEO_REFRESH_INTERVAL = 10 * 1000 // 10 seconds
 588
 589   CONSTRAINTS_FIELDS.ACTORS.AVATAR.FILE_SIZE.max = 100 * 1024 // 100KB
 590
 591   SCHEDULER_INTERVALS_MS.badActorFollow = 10000
 592   SCHEDULER_INTERVALS_MS.removeOldJobs = 10000
 593   SCHEDULER_INTERVALS_MS.updateVideos = 5000
 594
 595   VIDEO_VIEW_LIFETIME = 1000 // 1 second
 596
 597   JOB_ATTEMPTS['email'] = 1
 598
 599   CACHE.VIDEO_CAPTIONS.MAX_AGE = 3000
 600 }
 601
 602 updateWebserverConfig()
 603
 604 // ---------------------------------------------------------------------------
 605
 606 export {
 607   API_VERSION,
 608   VIDEO_CAPTIONS_MIMETYPE_EXT,
 609   AVATARS_SIZE,
 610   ACCEPT_HEADERS,
 611   BCRYPT_SALT_SIZE,
 612   TRACKER_RATE_LIMITS,
 613   CACHE,
 614   CONFIG,
 615   CONSTRAINTS_FIELDS,
 616   EMBED_SIZE,
 617   JOB_CONCURRENCY,
 618   JOB_ATTEMPTS,
 619   LAST_MIGRATION_VERSION,
 620   OAUTH_LIFETIME,
 621   CUSTOM_HTML_TAG_COMMENTS,
 622   BROADCAST_CONCURRENCY,
 623   PAGINATION,
 624   ACTOR_FOLLOW_SCORE,
 625   PREVIEWS_SIZE,
 626   REMOTE_SCHEME,
 627   FOLLOW_STATES,
 628   SERVER_ACTOR_NAME,
 629   PRIVATE_RSA_KEY_SIZE,
 630   ROUTE_CACHE_LIFETIME,
 631   SORTABLE_COLUMNS,
 632   FEEDS,
 633   JOB_TTL,
 634   NSFW_POLICY_TYPES,
 635   TORRENT_MIMETYPE_EXT,
 636   STATIC_MAX_AGE,
 637   STATIC_PATHS,
 638   ACTIVITY_PUB,
 639   ACTIVITY_PUB_ACTOR_TYPES,
 640   THUMBNAILS_SIZE,
 641   VIDEO_CATEGORIES,
 642   VIDEO_LANGUAGES,
 643   VIDEO_PRIVACIES,
 644   VIDEO_LICENCES,
 645   VIDEO_STATES,
 646   VIDEO_RATE_TYPES,
 647   VIDEO_MIMETYPE_EXT,
 648   VIDEO_TRANSCODING_FPS,
 649   FFMPEG_NICE,
 650   VIDEO_ABUSE_STATES,
 651   JOB_REQUEST_TIMEOUT,
 652   USER_PASSWORD_RESET_LIFETIME,
 653   IMAGE_MIMETYPE_EXT,
 654   SCHEDULER_INTERVALS_MS,
 655   STATIC_DOWNLOAD_PATHS,
 656   RATES_LIMIT,
 657   VIDEO_EXT_MIMETYPE,
 658   CRAWL_REQUEST_CONCURRENCY,
 659   JOB_COMPLETED_LIFETIME,
 660   VIDEO_IMPORT_STATES,
 661   VIDEO_VIEW_LIFETIME,
 662   buildLanguages
 663 }
 664
 665 // ---------------------------------------------------------------------------
 666
 667 function getLocalConfigFilePath () {
 668   const configSources = config.util.getConfigSources()
 669   if (configSources.length === 0) throw new Error('Invalid config source.')
 670
 671   let filename = 'local'
 672   if (process.env.NODE_ENV) filename += `-${process.env.NODE_ENV}`
 673   if (process.env.NODE_APP_INSTANCE) filename += `-${process.env.NODE_APP_INSTANCE}`
 674
 675   return join(dirname(configSources[ 0 ].name), filename + '.json')
 676 }
 677
 678 function updateWebserverConfig () {
 679   CONFIG.WEBSERVER.URL = sanitizeUrl(CONFIG.WEBSERVER.SCHEME + '://' + CONFIG.WEBSERVER.HOSTNAME + ':' + CONFIG.WEBSERVER.PORT)
 680   CONFIG.WEBSERVER.HOST = sanitizeHost(CONFIG.WEBSERVER.HOSTNAME + ':' + CONFIG.WEBSERVER.PORT, REMOTE_SCHEME.HTTP)
 681 }
 682
 683 function buildLanguages () {
 684   const iso639 = require('iso-639-3')
 685
 686   const languages: { [ id: string ]: string } = {}
 687
 688   const additionalLanguages = {
 689     'sgn': true, // Sign languages (macro language)
 690     'ase': true, // American sign language
 691     'sdl': true, // Arabian sign language
 692     'bfi': true, // British sign language
 693     'bzs': true, // Brazilian sign language
 694     'csl': true, // Chinese sign language
 695     'cse': true, // Czech sign language
 696     'dsl': true, // Danish sign language
 697     'fsl': true, // French sign language
 698     'gsg': true, // German sign language
 699     'pks': true, // Pakistan sign language
 700     'jsl': true, // Japanese sign language
 701     'sfs': true, // South African sign language
 702     'swl': true, // Swedish sign language
 703     'rsl': true, // Russian sign language: true
 704
 705     'epo': true, // Esperanto
 706     'tlh': true, // Klingon
 707     'jbo': true, // Lojban
 708     'avk': true // Kotava
 709   }
 710
 711   // Only add ISO639-1 languages and some sign languages (ISO639-3)
 712   iso639
 713     .filter(l => {
 714       return (l.iso6391 !== null && l.type === 'living') ||
 715         additionalLanguages[l.iso6393] === true
 716     })
 717     .forEach(l => languages[l.iso6391 || l.iso6393] = l.name)
 718
 719   return languages
 720 }
 721
 722 export function reloadConfig () {
 723
 724   function directory () {
 725     if (process.env.NODE_CONFIG_DIR) {
 726       return process.env.NODE_CONFIG_DIR
 727     }
 728
 729     return join(root(), 'config')
 730   }
 731
 732   function purge () {
 733     for (const fileName in require.cache) {
 734       if (-1 === fileName.indexOf(directory())) {
 735         continue
 736       }
 737
 738       delete require.cache[fileName]
 739     }
 740
 741     delete require.cache[require.resolve('config')]
 742   }
 743
 744   purge()
 745
 746   config = require('config')
 747
 748   updateWebserverConfig()
 749 }