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, VideoTranscodingFPS } from '../../shared/models/videos'
   7 // Do not use barrels, remain constants as independent as possible
   8 import { buildPath, isTestInstance, parseDuration, parseBytes, 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 = 275
  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 * 2, //  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 const VIDEO_IMPORT_TIMEOUT = 1000 * 3600 // 1 hour
 137
 138 // 1 hour
 139 let SCHEDULER_INTERVALS_MS = {
 140   badActorFollow: 60000 * 60, // 1 hour
 141   removeOldJobs: 60000 * 60, // 1 hour
 142   updateVideos: 60000, // 1 minute
 143   youtubeDLUpdate: 60000 * 60 * 24 // 1 day
 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: {
 216       CHECK_INTERVAL: parseDuration(config.get<string>('redundancy.videos.check_interval')),
 217       STRATEGIES: buildVideosRedundancy(config.get<any[]>('redundancy.videos.strategies'))
 218     }
 219   },
 220   ADMIN: {
 221     get EMAIL () { return config.get<string>('admin.email') }
 222   },
 223   SIGNUP: {
 224     get ENABLED () { return config.get<boolean>('signup.enabled') },
 225     get LIMIT () { return config.get<number>('signup.limit') },
 226     get REQUIRES_EMAIL_VERIFICATION () { return config.get<boolean>('signup.requires_email_verification') },
 227     FILTERS: {
 228       CIDR: {
 229         get WHITELIST () { return config.get<string[]>('signup.filters.cidr.whitelist') },
 230         get BLACKLIST () { return config.get<string[]>('signup.filters.cidr.blacklist') }
 231       }
 232     }
 233   },
 234   USER: {
 235     get VIDEO_QUOTA () { return parseBytes(config.get<number>('user.video_quota')) },
 236     get VIDEO_QUOTA_DAILY () { return parseBytes(config.get<number>('user.video_quota_daily')) }
 237   },
 238   TRANSCODING: {
 239     get ENABLED () { return config.get<boolean>('transcoding.enabled') },
 240     get THREADS () { return config.get<number>('transcoding.threads') },
 241     RESOLUTIONS: {
 242       get '240p' () { return config.get<boolean>('transcoding.resolutions.240p') },
 243       get '360p' () { return config.get<boolean>('transcoding.resolutions.360p') },
 244       get '480p' () { return config.get<boolean>('transcoding.resolutions.480p') },
 245       get '720p' () { return config.get<boolean>('transcoding.resolutions.720p') },
 246       get '1080p' () { return config.get<boolean>('transcoding.resolutions.1080p') }
 247     }
 248   },
 249   IMPORT: {
 250     VIDEOS: {
 251       HTTP: {
 252         get ENABLED () { return config.get<boolean>('import.videos.http.enabled') }
 253       },
 254       TORRENT: {
 255         get ENABLED () { return config.get<boolean>('import.videos.torrent.enabled') }
 256       }
 257     }
 258   },
 259   CACHE: {
 260     PREVIEWS: {
 261       get SIZE () { return config.get<number>('cache.previews.size') }
 262     },
 263     VIDEO_CAPTIONS: {
 264       get SIZE () { return config.get<number>('cache.captions.size') }
 265     }
 266   },
 267   INSTANCE: {
 268     get NAME () { return config.get<string>('instance.name') },
 269     get SHORT_DESCRIPTION () { return config.get<string>('instance.short_description') },
 270     get DESCRIPTION () { return config.get<string>('instance.description') },
 271     get TERMS () { return config.get<string>('instance.terms') },
 272     get DEFAULT_CLIENT_ROUTE () { return config.get<string>('instance.default_client_route') },
 273     get DEFAULT_NSFW_POLICY () { return config.get<NSFWPolicyType>('instance.default_nsfw_policy') },
 274     CUSTOMIZATIONS: {
 275       get JAVASCRIPT () { return config.get<string>('instance.customizations.javascript') },
 276       get CSS () { return config.get<string>('instance.customizations.css') }
 277     },
 278     get ROBOTS () { return config.get<string>('instance.robots') },
 279     get SECURITYTXT () { return config.get<string>('instance.securitytxt') },
 280     get SECURITYTXT_CONTACT () { return config.get<string>('admin.email') }
 281   },
 282   SERVICES: {
 283     TWITTER: {
 284       get USERNAME () { return config.get<string>('services.twitter.username') },
 285       get WHITELISTED () { return config.get<boolean>('services.twitter.whitelisted') }
 286     }
 287   }
 288 }
 289
 290 // ---------------------------------------------------------------------------
 291
 292 const CONSTRAINTS_FIELDS = {
 293   USERS: {
 294     NAME: { min: 3, max: 120 }, // Length
 295     DESCRIPTION: { min: 3, max: 250 }, // Length
 296     USERNAME: { min: 3, max: 20 }, // Length
 297     PASSWORD: { min: 6, max: 255 }, // Length
 298     VIDEO_QUOTA: { min: -1 },
 299     VIDEO_QUOTA_DAILY: { min: -1 },
 300     BLOCKED_REASON: { min: 3, max: 250 } // Length
 301   },
 302   VIDEO_ABUSES: {
 303     REASON: { min: 2, max: 300 }, // Length
 304     MODERATION_COMMENT: { min: 2, max: 300 } // Length
 305   },
 306   VIDEO_BLACKLIST: {
 307     REASON: { min: 2, max: 300 } // Length
 308   },
 309   VIDEO_CHANNELS: {
 310     NAME: { min: 3, max: 120 }, // Length
 311     DESCRIPTION: { min: 3, max: 500 }, // Length
 312     SUPPORT: { min: 3, max: 500 }, // Length
 313     URL: { min: 3, max: 2000 } // Length
 314   },
 315   VIDEO_CAPTIONS: {
 316     CAPTION_FILE: {
 317       EXTNAME: [ '.vtt', '.srt' ],
 318       FILE_SIZE: {
 319         max: 2 * 1024 * 1024 // 2MB
 320       }
 321     }
 322   },
 323   VIDEO_IMPORTS: {
 324     URL: { min: 3, max: 2000 }, // Length
 325     TORRENT_NAME: { min: 3, max: 255 }, // Length
 326     TORRENT_FILE: {
 327       EXTNAME: [ '.torrent' ],
 328       FILE_SIZE: {
 329         max: 1024 * 200 // 200 KB
 330       }
 331     }
 332   },
 333   VIDEOS_REDUNDANCY: {
 334     URL: { min: 3, max: 2000 } // Length
 335   },
 336   VIDEOS: {
 337     NAME: { min: 3, max: 120 }, // Length
 338     LANGUAGE: { min: 1, max: 10 }, // Length
 339     TRUNCATED_DESCRIPTION: { min: 3, max: 250 }, // Length
 340     DESCRIPTION: { min: 3, max: 10000 }, // Length
 341     SUPPORT: { min: 3, max: 500 }, // Length
 342     IMAGE: {
 343       EXTNAME: [ '.jpg', '.jpeg' ],
 344       FILE_SIZE: {
 345         max: 2 * 1024 * 1024 // 2MB
 346       }
 347     },
 348     EXTNAME: [ '.mp4', '.ogv', '.webm' ],
 349     INFO_HASH: { min: 40, max: 40 }, // Length, info hash is 20 bytes length but we represent it in hexadecimal so 20 * 2
 350     DURATION: { min: 0 }, // Number
 351     TAGS: { min: 0, max: 5 }, // Number of total tags
 352     TAG: { min: 2, max: 30 }, // Length
 353     THUMBNAIL: { min: 2, max: 30 },
 354     THUMBNAIL_DATA: { min: 0, max: 20000 }, // Bytes
 355     VIEWS: { min: 0 },
 356     LIKES: { min: 0 },
 357     DISLIKES: { min: 0 },
 358     FILE_SIZE: { min: 10 },
 359     URL: { min: 3, max: 2000 } // Length
 360   },
 361   ACTORS: {
 362     PUBLIC_KEY: { min: 10, max: 5000 }, // Length
 363     PRIVATE_KEY: { min: 10, max: 5000 }, // Length
 364     URL: { min: 3, max: 2000 }, // Length
 365     AVATAR: {
 366       EXTNAME: [ '.png', '.jpeg', '.jpg' ],
 367       FILE_SIZE: {
 368         max: 2 * 1024 * 1024 // 2MB
 369       }
 370     }
 371   },
 372   VIDEO_EVENTS: {
 373     COUNT: { min: 0 }
 374   },
 375   VIDEO_COMMENTS: {
 376     TEXT: { min: 1, max: 3000 }, // Length
 377     URL: { min: 3, max: 2000 } // Length
 378   },
 379   VIDEO_SHARE: {
 380     URL: { min: 3, max: 2000 } // Length
 381   }
 382 }
 383
 384 const RATES_LIMIT = {
 385   LOGIN: {
 386     WINDOW_MS: 5 * 60 * 1000, // 5 minutes
 387     MAX: 15 // 15 attempts
 388   },
 389   ASK_SEND_EMAIL: {
 390     WINDOW_MS: 5 * 60 * 1000, // 5 minutes
 391     MAX: 3 // 3 attempts
 392   }
 393 }
 394
 395 let VIDEO_VIEW_LIFETIME = 60000 * 60 // 1 hour
 396 const VIDEO_TRANSCODING_FPS: VideoTranscodingFPS = {
 397   MIN: 10,
 398   AVERAGE: 30,
 399   MAX: 60,
 400   KEEP_ORIGIN_FPS_RESOLUTION_MIN: 720 // We keep the original FPS on high resolutions (720 minimum)
 401 }
 402
 403 const VIDEO_RATE_TYPES: { [ id: string ]: VideoRateType } = {
 404   LIKE: 'like',
 405   DISLIKE: 'dislike'
 406 }
 407
 408 const FFMPEG_NICE: { [ id: string ]: number } = {
 409   THUMBNAIL: 2, // 2 just for don't blocking servers
 410   TRANSCODING: 15
 411 }
 412
 413 const VIDEO_CATEGORIES = {
 414   1: 'Music',
 415   2: 'Films',
 416   3: 'Vehicles',
 417   4: 'Art',
 418   5: 'Sports',
 419   6: 'Travels',
 420   7: 'Gaming',
 421   8: 'People',
 422   9: 'Comedy',
 423   10: 'Entertainment',
 424   11: 'News & Politics',
 425   12: 'How To',
 426   13: 'Education',
 427   14: 'Activism',
 428   15: 'Science & Technology',
 429   16: 'Animals',
 430   17: 'Kids',
 431   18: 'Food'
 432 }
 433
 434 // See https://creativecommons.org/licenses/?lang=en
 435 const VIDEO_LICENCES = {
 436   1: 'Attribution',
 437   2: 'Attribution - Share Alike',
 438   3: 'Attribution - No Derivatives',
 439   4: 'Attribution - Non Commercial',
 440   5: 'Attribution - Non Commercial - Share Alike',
 441   6: 'Attribution - Non Commercial - No Derivatives',
 442   7: 'Public Domain Dedication'
 443 }
 444
 445 const VIDEO_LANGUAGES = buildLanguages()
 446
 447 const VIDEO_PRIVACIES = {
 448   [VideoPrivacy.PUBLIC]: 'Public',
 449   [VideoPrivacy.UNLISTED]: 'Unlisted',
 450   [VideoPrivacy.PRIVATE]: 'Private'
 451 }
 452
 453 const VIDEO_STATES = {
 454   [VideoState.PUBLISHED]: 'Published',
 455   [VideoState.TO_TRANSCODE]: 'To transcode',
 456   [VideoState.TO_IMPORT]: 'To import'
 457 }
 458
 459 const VIDEO_IMPORT_STATES = {
 460   [VideoImportState.FAILED]: 'Failed',
 461   [VideoImportState.PENDING]: 'Pending',
 462   [VideoImportState.SUCCESS]: 'Success'
 463 }
 464
 465 const VIDEO_ABUSE_STATES = {
 466   [VideoAbuseState.PENDING]: 'Pending',
 467   [VideoAbuseState.REJECTED]: 'Rejected',
 468   [VideoAbuseState.ACCEPTED]: 'Accepted'
 469 }
 470
 471 const VIDEO_MIMETYPE_EXT = {
 472   'video/webm': '.webm',
 473   'video/ogg': '.ogv',
 474   'video/mp4': '.mp4'
 475 }
 476 const VIDEO_EXT_MIMETYPE = invert(VIDEO_MIMETYPE_EXT)
 477
 478 const IMAGE_MIMETYPE_EXT = {
 479   'image/png': '.png',
 480   'image/jpg': '.jpg',
 481   'image/jpeg': '.jpg'
 482 }
 483
 484 const VIDEO_CAPTIONS_MIMETYPE_EXT = {
 485   'text/vtt': '.vtt',
 486   'application/x-subrip': '.srt'
 487 }
 488
 489 const TORRENT_MIMETYPE_EXT = {
 490   'application/x-bittorrent': '.torrent'
 491 }
 492
 493 // ---------------------------------------------------------------------------
 494
 495 const OVERVIEWS = {
 496   VIDEOS: {
 497     SAMPLE_THRESHOLD: 6,
 498     SAMPLES_COUNT: 2
 499   }
 500 }
 501
 502 // ---------------------------------------------------------------------------
 503
 504 const SERVER_ACTOR_NAME = 'peertube'
 505
 506 const ACTIVITY_PUB = {
 507   POTENTIAL_ACCEPT_HEADERS: [
 508     'application/activity+json',
 509     'application/ld+json',
 510     'application/ld+json; profile="https://www.w3.org/ns/activitystreams"'
 511   ],
 512   ACCEPT_HEADER: 'application/activity+json, application/ld+json',
 513   PUBLIC: 'https://www.w3.org/ns/activitystreams#Public',
 514   COLLECTION_ITEMS_PER_PAGE: 10,
 515   FETCH_PAGE_LIMIT: 100,
 516   URL_MIME_TYPES: {
 517     VIDEO: Object.keys(VIDEO_MIMETYPE_EXT),
 518     TORRENT: [ 'application/x-bittorrent' ],
 519     MAGNET: [ 'application/x-bittorrent;x-scheme-handler/magnet' ]
 520   },
 521   MAX_RECURSION_COMMENTS: 100,
 522   ACTOR_REFRESH_INTERVAL: 3600 * 24 * 1000, // 1 day
 523   VIDEO_REFRESH_INTERVAL: 3600 * 24 * 1000 // 1 day
 524 }
 525
 526 const ACTIVITY_PUB_ACTOR_TYPES: { [ id: string ]: ActivityPubActorType } = {
 527   GROUP: 'Group',
 528   PERSON: 'Person',
 529   APPLICATION: 'Application'
 530 }
 531
 532 // ---------------------------------------------------------------------------
 533
 534 const PRIVATE_RSA_KEY_SIZE = 2048
 535
 536 // Password encryption
 537 const BCRYPT_SALT_SIZE = 10
 538
 539 const USER_PASSWORD_RESET_LIFETIME = 60000 * 5 // 5 minutes
 540
 541 const USER_EMAIL_VERIFY_LIFETIME = 60000 * 60 // 60 minutes
 542
 543 const NSFW_POLICY_TYPES: { [ id: string]: NSFWPolicyType } = {
 544   DO_NOT_LIST: 'do_not_list',
 545   BLUR: 'blur',
 546   DISPLAY: 'display'
 547 }
 548
 549 // ---------------------------------------------------------------------------
 550
 551 // Express static paths (router)
 552 const STATIC_PATHS = {
 553   PREVIEWS: '/static/previews/',
 554   THUMBNAILS: '/static/thumbnails/',
 555   TORRENTS: '/static/torrents/',
 556   WEBSEED: '/static/webseed/',
 557   AVATARS: '/static/avatars/',
 558   VIDEO_CAPTIONS: '/static/video-captions/'
 559 }
 560 const STATIC_DOWNLOAD_PATHS = {
 561   TORRENTS: '/download/torrents/',
 562   VIDEOS: '/download/videos/'
 563 }
 564
 565 // Cache control
 566 let STATIC_MAX_AGE = '2h'
 567
 568 // Videos thumbnail size
 569 const THUMBNAILS_SIZE = {
 570   width: 200,
 571   height: 110
 572 }
 573 const PREVIEWS_SIZE = {
 574   width: 560,
 575   height: 315
 576 }
 577 const AVATARS_SIZE = {
 578   width: 120,
 579   height: 120
 580 }
 581
 582 const EMBED_SIZE = {
 583   width: 560,
 584   height: 315
 585 }
 586
 587 // Sub folders of cache directory
 588 const CACHE = {
 589   PREVIEWS: {
 590     DIRECTORY: join(CONFIG.STORAGE.CACHE_DIR, 'previews'),
 591     MAX_AGE: 1000 * 3600 * 3 // 3 hours
 592   },
 593   VIDEO_CAPTIONS: {
 594     DIRECTORY: join(CONFIG.STORAGE.CACHE_DIR, 'video-captions'),
 595     MAX_AGE: 1000 * 3600 * 3 // 3 hours
 596   }
 597 }
 598
 599 const MEMOIZE_TTL = {
 600   OVERVIEWS_SAMPLE: 1000 * 3600 * 4 // 4 hours
 601 }
 602
 603 const REDUNDANCY = {
 604   VIDEOS: {
 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   VIDEO_IMPORT_TIMEOUT,
 705   ACTIVITY_PUB,
 706   ACTIVITY_PUB_ACTOR_TYPES,
 707   THUMBNAILS_SIZE,
 708   VIDEO_CATEGORIES,
 709   VIDEO_LANGUAGES,
 710   VIDEO_PRIVACIES,
 711   VIDEO_LICENCES,
 712   VIDEO_STATES,
 713   VIDEO_RATE_TYPES,
 714   VIDEO_MIMETYPE_EXT,
 715   VIDEO_TRANSCODING_FPS,
 716   FFMPEG_NICE,
 717   VIDEO_ABUSE_STATES,
 718   JOB_REQUEST_TIMEOUT,
 719   USER_PASSWORD_RESET_LIFETIME,
 720   MEMOIZE_TTL,
 721   USER_EMAIL_VERIFY_LIFETIME,
 722   IMAGE_MIMETYPE_EXT,
 723   OVERVIEWS,
 724   SCHEDULER_INTERVALS_MS,
 725   REPEAT_JOBS,
 726   STATIC_DOWNLOAD_PATHS,
 727   RATES_LIMIT,
 728   VIDEO_EXT_MIMETYPE,
 729   CRAWL_REQUEST_CONCURRENCY,
 730   JOB_COMPLETED_LIFETIME,
 731   VIDEO_IMPORT_STATES,
 732   VIDEO_VIEW_LIFETIME,
 733   buildLanguages
 734 }
 735
 736 // ---------------------------------------------------------------------------
 737
 738 function getLocalConfigFilePath () {
 739   const configSources = config.util.getConfigSources()
 740   if (configSources.length === 0) throw new Error('Invalid config source.')
 741
 742   let filename = 'local'
 743   if (process.env.NODE_ENV) filename += `-${process.env.NODE_ENV}`
 744   if (process.env.NODE_APP_INSTANCE) filename += `-${process.env.NODE_APP_INSTANCE}`
 745
 746   return join(dirname(configSources[ 0 ].name), filename + '.json')
 747 }
 748
 749 function updateWebserverConfig () {
 750   CONFIG.WEBSERVER.URL = sanitizeUrl(CONFIG.WEBSERVER.SCHEME + '://' + CONFIG.WEBSERVER.HOSTNAME + ':' + CONFIG.WEBSERVER.PORT)
 751   CONFIG.WEBSERVER.HOST = sanitizeHost(CONFIG.WEBSERVER.HOSTNAME + ':' + CONFIG.WEBSERVER.PORT, REMOTE_SCHEME.HTTP)
 752 }
 753
 754 function buildVideosRedundancy (objs: any[]): VideosRedundancy[] {
 755   if (!objs) return []
 756
 757   return objs.map(obj => {
 758     return Object.assign(obj, {
 759       minLifetime: parseDuration(obj.min_lifetime),
 760       size: bytes.parse(obj.size),
 761       minViews: obj.min_views
 762     })
 763   })
 764 }
 765
 766 function buildLanguages () {
 767   const iso639 = require('iso-639-3')
 768
 769   const languages: { [ id: string ]: string } = {}
 770
 771   const additionalLanguages = {
 772     'sgn': true, // Sign languages (macro language)
 773     'ase': true, // American sign language
 774     'sdl': true, // Arabian sign language
 775     'bfi': true, // British sign language
 776     'bzs': true, // Brazilian sign language
 777     'csl': true, // Chinese sign language
 778     'cse': true, // Czech sign language
 779     'dsl': true, // Danish sign language
 780     'fsl': true, // French sign language
 781     'gsg': true, // German sign language
 782     'pks': true, // Pakistan sign language
 783     'jsl': true, // Japanese sign language
 784     'sfs': true, // South African sign language
 785     'swl': true, // Swedish sign language
 786     'rsl': true, // Russian sign language: true
 787
 788     'epo': true, // Esperanto
 789     'tlh': true, // Klingon
 790     'jbo': true, // Lojban
 791     'avk': true // Kotava
 792   }
 793
 794   // Only add ISO639-1 languages and some sign languages (ISO639-3)
 795   iso639
 796     .filter(l => {
 797       return (l.iso6391 !== null && l.type === 'living') ||
 798         additionalLanguages[l.iso6393] === true
 799     })
 800     .forEach(l => languages[l.iso6391 || l.iso6393] = l.name)
 801
 802   // Override Occitan label
 803   languages['oc'] = 'Occitan'
 804
 805   return languages
 806 }
 807
 808 export function reloadConfig () {
 809
 810   function directory () {
 811     if (process.env.NODE_CONFIG_DIR) {
 812       return process.env.NODE_CONFIG_DIR
 813     }
 814
 815     return join(root(), 'config')
 816   }
 817
 818   function purge () {
 819     for (const fileName in require.cache) {
 820       if (-1 === fileName.indexOf(directory())) {
 821         continue
 822       }
 823
 824       delete require.cache[fileName]
 825     }
 826
 827     delete require.cache[require.resolve('config')]
 828   }
 829
 830   purge()
 831
 832   config = require('config')
 833
 834   updateWebserverConfig()
 835 }