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