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