server/initializers/constants.ts

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