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