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