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