server/initializers/constants.ts

   1 import { join } from 'path'
   2 import { randomBytes } from 'crypto'
   3 import { ActivityPubActorType } from '../../shared/models/activitypub'
   4 import { FollowState } from '../../shared/models/actors'
   5 import {
   6   AbuseState,
   7   VideoImportState,
   8   VideoPrivacy,
   9   VideoTranscodingFPS,
  10   JobType,
  11   VideoRateType,
  12   VideoResolution,
  13   VideoState
  14 } from '../../shared/models'
  15 // Do not use barrels, remain constants as independent as possible
  16 import { isTestInstance, sanitizeHost, sanitizeUrl, root } from '../helpers/core-utils'
  17 import { NSFWPolicyType } from '../../shared/models/videos/nsfw-policy.type'
  18 import { invert } from 'lodash'
  19 import { CronRepeatOptions, EveryRepeatOptions } from 'bull'
  20 import { VideoPlaylistPrivacy } from '../../shared/models/videos/playlist/video-playlist-privacy.model'
  21 import { VideoPlaylistType } from '../../shared/models/videos/playlist/video-playlist-type.model'
  22 import { CONFIG, registerConfigChangedHandler } from './config'
  23
  24 // ---------------------------------------------------------------------------
  25
  26 const LAST_MIGRATION_VERSION = 520
  27
  28 // ---------------------------------------------------------------------------
  29
  30 const API_VERSION = 'v1'
  31 const PEERTUBE_VERSION = require(join(root(), 'package.json')).version
  32
  33 const PAGINATION = {
  34   GLOBAL: {
  35     COUNT: {
  36       DEFAULT: 15,
  37       MAX: 100
  38     }
  39   },
  40   OUTBOX: {
  41     COUNT: {
  42       MAX: 50
  43     }
  44   }
  45 }
  46
  47 const WEBSERVER = {
  48   URL: '',
  49   HOST: '',
  50   SCHEME: '',
  51   WS: '',
  52   HOSTNAME: '',
  53   PORT: 0
  54 }
  55
  56 // Sortable columns per schema
  57 const SORTABLE_COLUMNS = {
  58   USERS: [ 'id', 'username', 'videoQuotaUsed', 'createdAt' ],
  59   USER_SUBSCRIPTIONS: [ 'id', 'createdAt' ],
  60   ACCOUNTS: [ 'createdAt' ],
  61   JOBS: [ 'createdAt' ],
  62   VIDEO_CHANNELS: [ 'id', 'name', 'updatedAt', 'createdAt' ],
  63   VIDEO_IMPORTS: [ 'createdAt' ],
  64   VIDEO_COMMENT_THREADS: [ 'createdAt', 'totalReplies' ],
  65   VIDEO_RATES: [ 'createdAt' ],
  66   BLACKLISTS: [ 'id', 'name', 'duration', 'views', 'likes', 'dislikes', 'uuid', 'createdAt' ],
  67   FOLLOWERS: [ 'createdAt', 'state', 'score' ],
  68   FOLLOWING: [ 'createdAt', 'redundancyAllowed', 'state' ],
  69
  70   VIDEOS: [ 'name', 'duration', 'createdAt', 'publishedAt', 'originallyPublishedAt', 'views', 'likes', 'trending' ],
  71
  72   // Don't forget to update peertube-search-index with the same values
  73   VIDEOS_SEARCH: [ 'name', 'duration', 'createdAt', 'publishedAt', 'originallyPublishedAt', 'views', 'likes', 'match' ],
  74   VIDEO_CHANNELS_SEARCH: [ 'match', 'displayName', 'createdAt' ],
  75
  76   ABUSES: [ 'id', 'createdAt', 'state' ],
  77
  78   ACCOUNTS_BLOCKLIST: [ 'createdAt' ],
  79   SERVERS_BLOCKLIST: [ 'createdAt' ],
  80
  81   USER_NOTIFICATIONS: [ 'createdAt' ],
  82
  83   VIDEO_PLAYLISTS: [ 'displayName', 'createdAt', 'updatedAt' ],
  84
  85   PLUGINS: [ 'name', 'createdAt', 'updatedAt' ],
  86
  87   AVAILABLE_PLUGINS: [ 'npmName', 'popularity' ],
  88
  89   VIDEO_REDUNDANCIES: [ 'name' ]
  90 }
  91
  92 const OAUTH_LIFETIME = {
  93   ACCESS_TOKEN: 3600 * 24, // 1 day, for upload
  94   REFRESH_TOKEN: 1209600 // 2 weeks
  95 }
  96
  97 const ROUTE_CACHE_LIFETIME = {
  98   FEEDS: '15 minutes',
  99   ROBOTS: '2 hours',
 100   SITEMAP: '1 day',
 101   SECURITYTXT: '2 hours',
 102   NODEINFO: '10 minutes',
 103   DNT_POLICY: '1 week',
 104   ACTIVITY_PUB: {
 105     VIDEOS: '1 second' // 1 second, cache concurrent requests after a broadcast for example
 106   },
 107   STATS: '4 hours'
 108 }
 109
 110 // ---------------------------------------------------------------------------
 111
 112 // Number of points we add/remove after a successful/bad request
 113 const ACTOR_FOLLOW_SCORE = {
 114   PENALTY: -10,
 115   BONUS: 10,
 116   BASE: 1000,
 117   MAX: 10000
 118 }
 119
 120 const FOLLOW_STATES: { [ id: string ]: FollowState } = {
 121   PENDING: 'pending',
 122   ACCEPTED: 'accepted'
 123 }
 124
 125 const REMOTE_SCHEME = {
 126   HTTP: 'https',
 127   WS: 'wss'
 128 }
 129
 130 const JOB_ATTEMPTS: { [id in JobType]: number } = {
 131   'activitypub-http-broadcast': 5,
 132   'activitypub-http-unicast': 5,
 133   'activitypub-http-fetcher': 5,
 134   'activitypub-follow': 5,
 135   'video-file-import': 1,
 136   'video-transcoding': 1,
 137   'video-import': 1,
 138   'email': 5,
 139   'videos-views': 1,
 140   'activitypub-refresher': 1,
 141   'video-redundancy': 1
 142 }
 143 const JOB_CONCURRENCY: { [id in JobType]: number } = {
 144   'activitypub-http-broadcast': 1,
 145   'activitypub-http-unicast': 5,
 146   'activitypub-http-fetcher': 1,
 147   'activitypub-follow': 1,
 148   'video-file-import': 1,
 149   'video-transcoding': 1,
 150   'video-import': 1,
 151   'email': 5,
 152   'videos-views': 1,
 153   'activitypub-refresher': 1,
 154   'video-redundancy': 1
 155 }
 156 const JOB_TTL: { [id in JobType]: number } = {
 157   'activitypub-http-broadcast': 60000 * 10, // 10 minutes
 158   'activitypub-http-unicast': 60000 * 10, // 10 minutes
 159   'activitypub-http-fetcher': 1000 * 3600 * 10, // 10 hours
 160   'activitypub-follow': 60000 * 10, // 10 minutes
 161   'video-file-import': 1000 * 3600, // 1 hour
 162   'video-transcoding': 1000 * 3600 * 48, // 2 days, transcoding could be long
 163   'video-import': 1000 * 3600 * 2, // 2 hours
 164   'email': 60000 * 10, // 10 minutes
 165   'videos-views': undefined, // Unlimited
 166   'activitypub-refresher': 60000 * 10, // 10 minutes
 167   'video-redundancy': 1000 * 3600 * 3 // 3 hours
 168 }
 169 const REPEAT_JOBS: { [ id: string ]: EveryRepeatOptions | CronRepeatOptions } = {
 170   'videos-views': {
 171     cron: '1 * * * *' // At 1 minute past the hour
 172   }
 173 }
 174
 175 const BROADCAST_CONCURRENCY = 10 // How many requests in parallel we do in activitypub-http-broadcast job
 176 const CRAWL_REQUEST_CONCURRENCY = 1 // How many requests in parallel to fetch remote data (likes, shares...)
 177 const JOB_REQUEST_TIMEOUT = 3000 // 3 seconds
 178 const JOB_COMPLETED_LIFETIME = 60000 * 60 * 24 * 2 // 2 days
 179 const VIDEO_IMPORT_TIMEOUT = 1000 * 3600 // 1 hour
 180
 181 const SCHEDULER_INTERVALS_MS = {
 182   actorFollowScores: 60000 * 60, // 1 hour
 183   removeOldJobs: 60000 * 60, // 1 hour
 184   updateVideos: 60000, // 1 minute
 185   youtubeDLUpdate: 60000 * 60 * 24, // 1 day
 186   checkPlugins: CONFIG.PLUGINS.INDEX.CHECK_LATEST_VERSIONS_INTERVAL,
 187   autoFollowIndexInstances: 60000 * 60 * 24, // 1 day
 188   removeOldViews: 60000 * 60 * 24, // 1 day
 189   removeOldHistory: 60000 * 60 * 24 // 1 day
 190 }
 191
 192 // ---------------------------------------------------------------------------
 193
 194 const CONSTRAINTS_FIELDS = {
 195   USERS: {
 196     NAME: { min: 1, max: 120 }, // Length
 197     DESCRIPTION: { min: 3, max: 1000 }, // Length
 198     USERNAME: { min: 1, max: 50 }, // Length
 199     PASSWORD: { min: 6, max: 255 }, // Length
 200     VIDEO_QUOTA: { min: -1 },
 201     VIDEO_QUOTA_DAILY: { min: -1 },
 202     VIDEO_LANGUAGES: { max: 500 }, // Array length
 203     BLOCKED_REASON: { min: 3, max: 250 } // Length
 204   },
 205   ABUSES: {
 206     REASON: { min: 2, max: 3000 }, // Length
 207     MODERATION_COMMENT: { min: 2, max: 3000 } // Length
 208   },
 209   VIDEO_BLACKLIST: {
 210     REASON: { min: 2, max: 300 } // Length
 211   },
 212   VIDEO_CHANNELS: {
 213     NAME: { min: 1, max: 120 }, // Length
 214     DESCRIPTION: { min: 3, max: 1000 }, // Length
 215     SUPPORT: { min: 3, max: 1000 }, // Length
 216     URL: { min: 3, max: 2000 } // Length
 217   },
 218   VIDEO_CAPTIONS: {
 219     CAPTION_FILE: {
 220       EXTNAME: [ '.vtt', '.srt' ],
 221       FILE_SIZE: {
 222         max: 2 * 1024 * 1024 // 2MB
 223       }
 224     }
 225   },
 226   VIDEO_IMPORTS: {
 227     URL: { min: 3, max: 2000 }, // Length
 228     TORRENT_NAME: { min: 3, max: 255 }, // Length
 229     TORRENT_FILE: {
 230       EXTNAME: [ '.torrent' ],
 231       FILE_SIZE: {
 232         max: 1024 * 200 // 200 KB
 233       }
 234     }
 235   },
 236   VIDEOS_REDUNDANCY: {
 237     URL: { min: 3, max: 2000 } // Length
 238   },
 239   VIDEO_RATES: {
 240     URL: { min: 3, max: 2000 } // Length
 241   },
 242   VIDEOS: {
 243     NAME: { min: 3, max: 120 }, // Length
 244     LANGUAGE: { min: 1, max: 10 }, // Length
 245     TRUNCATED_DESCRIPTION: { min: 3, max: 250 }, // Length
 246     DESCRIPTION: { min: 3, max: 10000 }, // Length
 247     SUPPORT: { min: 3, max: 1000 }, // Length
 248     IMAGE: {
 249       EXTNAME: [ '.jpg', '.jpeg' ],
 250       FILE_SIZE: {
 251         max: 2 * 1024 * 1024 // 2MB
 252       }
 253     },
 254     EXTNAME: [] as string[],
 255     INFO_HASH: { min: 40, max: 40 }, // Length, info hash is 20 bytes length but we represent it in hexadecimal so 20 * 2
 256     DURATION: { min: 0 }, // Number
 257     TAGS: { min: 0, max: 5 }, // Number of total tags
 258     TAG: { min: 2, max: 30 }, // Length
 259     THUMBNAIL: { min: 2, max: 30 },
 260     THUMBNAIL_DATA: { min: 0, max: 20000 }, // Bytes
 261     VIEWS: { min: 0 },
 262     LIKES: { min: 0 },
 263     DISLIKES: { min: 0 },
 264     FILE_SIZE: { min: 10 },
 265     URL: { min: 3, max: 2000 } // Length
 266   },
 267   VIDEO_PLAYLISTS: {
 268     NAME: { min: 1, max: 120 }, // Length
 269     DESCRIPTION: { min: 3, max: 1000 }, // Length
 270     URL: { min: 3, max: 2000 }, // Length
 271     IMAGE: {
 272       EXTNAME: [ '.jpg', '.jpeg' ],
 273       FILE_SIZE: {
 274         max: 2 * 1024 * 1024 // 2MB
 275       }
 276     }
 277   },
 278   ACTORS: {
 279     PUBLIC_KEY: { min: 10, max: 5000 }, // Length
 280     PRIVATE_KEY: { min: 10, max: 5000 }, // Length
 281     URL: { min: 3, max: 2000 }, // Length
 282     AVATAR: {
 283       EXTNAME: [ '.png', '.jpeg', '.jpg' ],
 284       FILE_SIZE: {
 285         max: 2 * 1024 * 1024 // 2MB
 286       }
 287     }
 288   },
 289   VIDEO_EVENTS: {
 290     COUNT: { min: 0 }
 291   },
 292   VIDEO_COMMENTS: {
 293     TEXT: { min: 1, max: 10000 }, // Length
 294     URL: { min: 3, max: 2000 } // Length
 295   },
 296   VIDEO_SHARE: {
 297     URL: { min: 3, max: 2000 } // Length
 298   },
 299   CONTACT_FORM: {
 300     FROM_NAME: { min: 1, max: 120 }, // Length
 301     BODY: { min: 3, max: 5000 } // Length
 302   },
 303   PLUGINS: {
 304     NAME: { min: 1, max: 214 }, // Length
 305     DESCRIPTION: { min: 1, max: 20000 } // Length
 306   },
 307   COMMONS: {
 308     URL: { min: 5, max: 2000 } // Length
 309   }
 310 }
 311
 312 let VIDEO_VIEW_LIFETIME = 60000 * 60 // 1 hour
 313 let CONTACT_FORM_LIFETIME = 60000 * 60 // 1 hour
 314
 315 const VIDEO_TRANSCODING_FPS: VideoTranscodingFPS = {
 316   MIN: 10,
 317   STANDARD: [ 24, 25, 30 ],
 318   HD_STANDARD: [ 50, 60 ],
 319   AVERAGE: 30,
 320   MAX: 60,
 321   KEEP_ORIGIN_FPS_RESOLUTION_MIN: 720 // We keep the original FPS on high resolutions (720 minimum)
 322 }
 323
 324 const DEFAULT_AUDIO_RESOLUTION = VideoResolution.H_480P
 325
 326 const VIDEO_RATE_TYPES: { [ id: string ]: VideoRateType } = {
 327   LIKE: 'like',
 328   DISLIKE: 'dislike'
 329 }
 330
 331 const FFMPEG_NICE: { [ id: string ]: number } = {
 332   THUMBNAIL: 2, // 2 just for don't blocking servers
 333   TRANSCODING: 15
 334 }
 335
 336 const VIDEO_CATEGORIES = {
 337   1: 'Music',
 338   2: 'Films',
 339   3: 'Vehicles',
 340   4: 'Art',
 341   5: 'Sports',
 342   6: 'Travels',
 343   7: 'Gaming',
 344   8: 'People',
 345   9: 'Comedy',
 346   10: 'Entertainment',
 347   11: 'News & Politics',
 348   12: 'How To',
 349   13: 'Education',
 350   14: 'Activism',
 351   15: 'Science & Technology',
 352   16: 'Animals',
 353   17: 'Kids',
 354   18: 'Food'
 355 }
 356
 357 // See https://creativecommons.org/licenses/?lang=en
 358 const VIDEO_LICENCES = {
 359   1: 'Attribution',
 360   2: 'Attribution - Share Alike',
 361   3: 'Attribution - No Derivatives',
 362   4: 'Attribution - Non Commercial',
 363   5: 'Attribution - Non Commercial - Share Alike',
 364   6: 'Attribution - Non Commercial - No Derivatives',
 365   7: 'Public Domain Dedication'
 366 }
 367
 368 const VIDEO_LANGUAGES: { [id: string]: string } = {}
 369
 370 const VIDEO_PRIVACIES = {
 371   [VideoPrivacy.PUBLIC]: 'Public',
 372   [VideoPrivacy.UNLISTED]: 'Unlisted',
 373   [VideoPrivacy.PRIVATE]: 'Private',
 374   [VideoPrivacy.INTERNAL]: 'Internal'
 375 }
 376
 377 const VIDEO_STATES = {
 378   [VideoState.PUBLISHED]: 'Published',
 379   [VideoState.TO_TRANSCODE]: 'To transcode',
 380   [VideoState.TO_IMPORT]: 'To import'
 381 }
 382
 383 const VIDEO_IMPORT_STATES = {
 384   [VideoImportState.FAILED]: 'Failed',
 385   [VideoImportState.PENDING]: 'Pending',
 386   [VideoImportState.SUCCESS]: 'Success',
 387   [VideoImportState.REJECTED]: 'Rejected'
 388 }
 389
 390 const ABUSE_STATES = {
 391   [AbuseState.PENDING]: 'Pending',
 392   [AbuseState.REJECTED]: 'Rejected',
 393   [AbuseState.ACCEPTED]: 'Accepted'
 394 }
 395
 396 const VIDEO_PLAYLIST_PRIVACIES = {
 397   [VideoPlaylistPrivacy.PUBLIC]: 'Public',
 398   [VideoPlaylistPrivacy.UNLISTED]: 'Unlisted',
 399   [VideoPlaylistPrivacy.PRIVATE]: 'Private'
 400 }
 401
 402 const VIDEO_PLAYLIST_TYPES = {
 403   [VideoPlaylistType.REGULAR]: 'Regular',
 404   [VideoPlaylistType.WATCH_LATER]: 'Watch later'
 405 }
 406
 407 const MIMETYPES = {
 408   AUDIO: {
 409     MIMETYPE_EXT: {
 410       'audio/mpeg': '.mp3',
 411       'audio/mp3': '.mp3',
 412       'application/ogg': '.ogg',
 413       'audio/ogg': '.ogg',
 414       'audio/x-ms-wma': '.wma',
 415       'audio/wav': '.wav',
 416       'audio/x-flac': '.flac',
 417       'audio/flac': '.flac'
 418     },
 419     EXT_MIMETYPE: null as { [ id: string ]: string }
 420   },
 421   VIDEO: {
 422     MIMETYPE_EXT: null as { [ id: string ]: string },
 423     EXT_MIMETYPE: null as { [ id: string ]: string }
 424   },
 425   IMAGE: {
 426     MIMETYPE_EXT: {
 427       'image/png': '.png',
 428       'image/jpg': '.jpg',
 429       'image/jpeg': '.jpg'
 430     },
 431     EXT_MIMETYPE: null as { [ id: string ]: string }
 432   },
 433   VIDEO_CAPTIONS: {
 434     MIMETYPE_EXT: {
 435       'text/vtt': '.vtt',
 436       'application/x-subrip': '.srt',
 437       'text/plain': '.srt'
 438     }
 439   },
 440   TORRENT: {
 441     MIMETYPE_EXT: {
 442       'application/x-bittorrent': '.torrent'
 443     }
 444   }
 445 }
 446 MIMETYPES.AUDIO.EXT_MIMETYPE = invert(MIMETYPES.AUDIO.MIMETYPE_EXT)
 447 MIMETYPES.IMAGE.EXT_MIMETYPE = invert(MIMETYPES.IMAGE.MIMETYPE_EXT)
 448
 449 // ---------------------------------------------------------------------------
 450
 451 const OVERVIEWS = {
 452   VIDEOS: {
 453     SAMPLE_THRESHOLD: 6,
 454     SAMPLES_COUNT: 20
 455   }
 456 }
 457
 458 const VIDEO_CHANNELS = {
 459   MAX_PER_USER: 20
 460 }
 461
 462 // ---------------------------------------------------------------------------
 463
 464 const SERVER_ACTOR_NAME = 'peertube'
 465
 466 const ACTIVITY_PUB = {
 467   POTENTIAL_ACCEPT_HEADERS: [
 468     'application/activity+json',
 469     'application/ld+json',
 470     'application/ld+json; profile="https://www.w3.org/ns/activitystreams"'
 471   ],
 472   ACCEPT_HEADER: 'application/activity+json, application/ld+json',
 473   PUBLIC: 'https://www.w3.org/ns/activitystreams#Public',
 474   COLLECTION_ITEMS_PER_PAGE: 10,
 475   FETCH_PAGE_LIMIT: 2000,
 476   URL_MIME_TYPES: {
 477     VIDEO: [] as string[],
 478     TORRENT: [ 'application/x-bittorrent' ],
 479     MAGNET: [ 'application/x-bittorrent;x-scheme-handler/magnet' ]
 480   },
 481   MAX_RECURSION_COMMENTS: 100,
 482   ACTOR_REFRESH_INTERVAL: 3600 * 24 * 1000 * 2, // 2 days
 483   VIDEO_REFRESH_INTERVAL: 3600 * 24 * 1000 * 2, // 2 days
 484   VIDEO_PLAYLIST_REFRESH_INTERVAL: 3600 * 24 * 1000 * 2 // 2 days
 485 }
 486
 487 const ACTIVITY_PUB_ACTOR_TYPES: { [ id: string ]: ActivityPubActorType } = {
 488   GROUP: 'Group',
 489   PERSON: 'Person',
 490   APPLICATION: 'Application',
 491   ORGANIZATION: 'Organization',
 492   SERVICE: 'Service'
 493 }
 494
 495 const HTTP_SIGNATURE = {
 496   HEADER_NAME: 'signature',
 497   ALGORITHM: 'rsa-sha256',
 498   HEADERS_TO_SIGN: [ '(request-target)', 'host', 'date', 'digest' ],
 499   CLOCK_SKEW_SECONDS: 1800
 500 }
 501
 502 // ---------------------------------------------------------------------------
 503
 504 let PRIVATE_RSA_KEY_SIZE = 2048
 505
 506 // Password encryption
 507 const BCRYPT_SALT_SIZE = 10
 508
 509 const USER_PASSWORD_RESET_LIFETIME = 60000 * 60 // 60 minutes
 510 const USER_PASSWORD_CREATE_LIFETIME = 60000 * 60 * 24 * 7 // 7 days
 511
 512 const USER_EMAIL_VERIFY_LIFETIME = 60000 * 60 // 60 minutes
 513
 514 const NSFW_POLICY_TYPES: { [ id: string ]: NSFWPolicyType } = {
 515   DO_NOT_LIST: 'do_not_list',
 516   BLUR: 'blur',
 517   DISPLAY: 'display'
 518 }
 519
 520 // ---------------------------------------------------------------------------
 521
 522 // Express static paths (router)
 523 const STATIC_PATHS = {
 524   PREVIEWS: '/static/previews/',
 525   THUMBNAILS: '/static/thumbnails/',
 526   TORRENTS: '/static/torrents/',
 527   WEBSEED: '/static/webseed/',
 528   REDUNDANCY: '/static/redundancy/',
 529   STREAMING_PLAYLISTS: {
 530     HLS: '/static/streaming-playlists/hls'
 531   },
 532   AVATARS: '/static/avatars/',
 533   VIDEO_CAPTIONS: '/static/video-captions/'
 534 }
 535 const STATIC_DOWNLOAD_PATHS = {
 536   TORRENTS: '/download/torrents/',
 537   VIDEOS: '/download/videos/',
 538   HLS_VIDEOS: '/download/streaming-playlists/hls/videos/'
 539 }
 540 const LAZY_STATIC_PATHS = {
 541   AVATARS: '/lazy-static/avatars/',
 542   PREVIEWS: '/static/previews/',
 543   VIDEO_CAPTIONS: '/static/video-captions/'
 544 }
 545
 546 // Cache control
 547 const STATIC_MAX_AGE = {
 548   SERVER: '2h',
 549   CLIENT: '30d'
 550 }
 551
 552 // Videos thumbnail size
 553 const THUMBNAILS_SIZE = {
 554   width: 223,
 555   height: 122,
 556   minWidth: 150
 557 }
 558 const PREVIEWS_SIZE = {
 559   width: 850,
 560   height: 480,
 561   minWidth: 400
 562 }
 563 const AVATARS_SIZE = {
 564   width: 120,
 565   height: 120
 566 }
 567
 568 const EMBED_SIZE = {
 569   width: 560,
 570   height: 315
 571 }
 572
 573 // Sub folders of cache directory
 574 const FILES_CACHE = {
 575   PREVIEWS: {
 576     DIRECTORY: join(CONFIG.STORAGE.CACHE_DIR, 'previews'),
 577     MAX_AGE: 1000 * 3600 * 3 // 3 hours
 578   },
 579   VIDEO_CAPTIONS: {
 580     DIRECTORY: join(CONFIG.STORAGE.CACHE_DIR, 'video-captions'),
 581     MAX_AGE: 1000 * 3600 * 3 // 3 hours
 582   }
 583 }
 584
 585 const LRU_CACHE = {
 586   USER_TOKENS: {
 587     MAX_SIZE: 1000
 588   },
 589   AVATAR_STATIC: {
 590     MAX_SIZE: 500
 591   }
 592 }
 593
 594 const HLS_STREAMING_PLAYLIST_DIRECTORY = join(CONFIG.STORAGE.STREAMING_PLAYLISTS_DIR, 'hls')
 595 const HLS_REDUNDANCY_DIRECTORY = join(CONFIG.STORAGE.REDUNDANCY_DIR, 'hls')
 596
 597 const MEMOIZE_TTL = {
 598   OVERVIEWS_SAMPLE: 1000 * 3600 * 4, // 4 hours
 599   INFO_HASH_EXISTS: 1000 * 3600 * 12 // 12 hours
 600 }
 601
 602 const MEMOIZE_LENGTH = {
 603   INFO_HASH_EXISTS: 200
 604 }
 605
 606 const QUEUE_CONCURRENCY = {
 607   AVATAR_PROCESS_IMAGE: 3
 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 const ASSETS_PATH = {
 619   DEFAULT_AUDIO_BACKGROUND: join(root(), 'dist', 'server', 'assets', 'default-audio-background.jpg')
 620 }
 621
 622 // ---------------------------------------------------------------------------
 623
 624 const CUSTOM_HTML_TAG_COMMENTS = {
 625   TITLE: '<!-- title tag -->',
 626   DESCRIPTION: '<!-- description tag -->',
 627   CUSTOM_CSS: '<!-- custom css tag -->',
 628   META_TAGS: '<!-- meta tags -->'
 629 }
 630
 631 // ---------------------------------------------------------------------------
 632
 633 const FEEDS = {
 634   COUNT: 20
 635 }
 636
 637 const MAX_LOGS_OUTPUT_CHARACTERS = 10 * 1000 * 1000
 638 const LOG_FILENAME = 'peertube.log'
 639 const AUDIT_LOG_FILENAME = 'peertube-audit.log'
 640
 641 // ---------------------------------------------------------------------------
 642
 643 const TRACKER_RATE_LIMITS = {
 644   INTERVAL: 60000 * 5, // 5 minutes
 645   ANNOUNCES_PER_IP_PER_INFOHASH: 15, // maximum announces per torrent in the interval
 646   ANNOUNCES_PER_IP: 30, // maximum announces for all our torrents in the interval
 647   BLOCK_IP_LIFETIME: 60000 * 10 // 10 minutes
 648 }
 649
 650 const P2P_MEDIA_LOADER_PEER_VERSION = 2
 651
 652 // ---------------------------------------------------------------------------
 653
 654 const PLUGIN_GLOBAL_CSS_FILE_NAME = 'plugins-global.css'
 655 const PLUGIN_GLOBAL_CSS_PATH = join(CONFIG.STORAGE.TMP_DIR, PLUGIN_GLOBAL_CSS_FILE_NAME)
 656
 657 let PLUGIN_EXTERNAL_AUTH_TOKEN_LIFETIME = 1000 * 60 * 5 // 5 minutes
 658
 659 const DEFAULT_THEME_NAME = 'default'
 660 const DEFAULT_USER_THEME_NAME = 'instance-default'
 661
 662 // ---------------------------------------------------------------------------
 663
 664 const SEARCH_INDEX = {
 665   ROUTES: {
 666     VIDEOS: '/api/v1/search/videos',
 667     VIDEO_CHANNELS: '/api/v1/search/video-channels'
 668   }
 669 }
 670
 671 // ---------------------------------------------------------------------------
 672
 673 // Special constants for a test instance
 674 if (isTestInstance() === true) {
 675   PRIVATE_RSA_KEY_SIZE = 1024
 676
 677   ACTOR_FOLLOW_SCORE.BASE = 20
 678
 679   REMOTE_SCHEME.HTTP = 'http'
 680   REMOTE_SCHEME.WS = 'ws'
 681
 682   STATIC_MAX_AGE.SERVER = '0'
 683
 684   ACTIVITY_PUB.COLLECTION_ITEMS_PER_PAGE = 2
 685   ACTIVITY_PUB.ACTOR_REFRESH_INTERVAL = 10 * 1000 // 10 seconds
 686   ACTIVITY_PUB.VIDEO_REFRESH_INTERVAL = 10 * 1000 // 10 seconds
 687   ACTIVITY_PUB.VIDEO_PLAYLIST_REFRESH_INTERVAL = 10 * 1000 // 10 seconds
 688
 689   CONSTRAINTS_FIELDS.ACTORS.AVATAR.FILE_SIZE.max = 100 * 1024 // 100KB
 690
 691   SCHEDULER_INTERVALS_MS.actorFollowScores = 1000
 692   SCHEDULER_INTERVALS_MS.removeOldJobs = 10000
 693   SCHEDULER_INTERVALS_MS.removeOldHistory = 5000
 694   SCHEDULER_INTERVALS_MS.removeOldViews = 5000
 695   SCHEDULER_INTERVALS_MS.updateVideos = 5000
 696   SCHEDULER_INTERVALS_MS.autoFollowIndexInstances = 5000
 697   REPEAT_JOBS['videos-views'] = { every: 5000 }
 698
 699   REDUNDANCY.VIDEOS.RANDOMIZED_FACTOR = 1
 700
 701   VIDEO_VIEW_LIFETIME = 1000 // 1 second
 702   CONTACT_FORM_LIFETIME = 1000 // 1 second
 703
 704   JOB_ATTEMPTS['email'] = 1
 705
 706   FILES_CACHE.VIDEO_CAPTIONS.MAX_AGE = 3000
 707   MEMOIZE_TTL.OVERVIEWS_SAMPLE = 3000
 708   OVERVIEWS.VIDEOS.SAMPLE_THRESHOLD = 2
 709
 710   PLUGIN_EXTERNAL_AUTH_TOKEN_LIFETIME = 5000
 711 }
 712
 713 updateWebserverUrls()
 714 updateWebserverConfig()
 715
 716 registerConfigChangedHandler(() => {
 717   updateWebserverUrls()
 718   updateWebserverConfig()
 719 })
 720
 721 // ---------------------------------------------------------------------------
 722
 723 const FILES_CONTENT_HASH = {
 724   MANIFEST: generateContentHash(),
 725   FAVICON: generateContentHash(),
 726   LOGO: generateContentHash()
 727 }
 728
 729 // ---------------------------------------------------------------------------
 730
 731 export {
 732   WEBSERVER,
 733   API_VERSION,
 734   PEERTUBE_VERSION,
 735   LAZY_STATIC_PATHS,
 736   SEARCH_INDEX,
 737   HLS_REDUNDANCY_DIRECTORY,
 738   P2P_MEDIA_LOADER_PEER_VERSION,
 739   AVATARS_SIZE,
 740   ACCEPT_HEADERS,
 741   BCRYPT_SALT_SIZE,
 742   TRACKER_RATE_LIMITS,
 743   FILES_CACHE,
 744   LOG_FILENAME,
 745   CONSTRAINTS_FIELDS,
 746   EMBED_SIZE,
 747   REDUNDANCY,
 748   JOB_CONCURRENCY,
 749   JOB_ATTEMPTS,
 750   LAST_MIGRATION_VERSION,
 751   OAUTH_LIFETIME,
 752   CUSTOM_HTML_TAG_COMMENTS,
 753   BROADCAST_CONCURRENCY,
 754   AUDIT_LOG_FILENAME,
 755   PAGINATION,
 756   ACTOR_FOLLOW_SCORE,
 757   PREVIEWS_SIZE,
 758   REMOTE_SCHEME,
 759   FOLLOW_STATES,
 760   DEFAULT_USER_THEME_NAME,
 761   SERVER_ACTOR_NAME,
 762   PLUGIN_GLOBAL_CSS_FILE_NAME,
 763   PLUGIN_GLOBAL_CSS_PATH,
 764   PRIVATE_RSA_KEY_SIZE,
 765   ROUTE_CACHE_LIFETIME,
 766   SORTABLE_COLUMNS,
 767   HLS_STREAMING_PLAYLIST_DIRECTORY,
 768   FEEDS,
 769   JOB_TTL,
 770   DEFAULT_THEME_NAME,
 771   NSFW_POLICY_TYPES,
 772   STATIC_MAX_AGE,
 773   STATIC_PATHS,
 774   VIDEO_IMPORT_TIMEOUT,
 775   VIDEO_PLAYLIST_TYPES,
 776   MAX_LOGS_OUTPUT_CHARACTERS,
 777   ACTIVITY_PUB,
 778   ACTIVITY_PUB_ACTOR_TYPES,
 779   THUMBNAILS_SIZE,
 780   VIDEO_CATEGORIES,
 781   MEMOIZE_LENGTH,
 782   VIDEO_LANGUAGES,
 783   VIDEO_PRIVACIES,
 784   VIDEO_LICENCES,
 785   VIDEO_STATES,
 786   QUEUE_CONCURRENCY,
 787   VIDEO_RATE_TYPES,
 788   VIDEO_TRANSCODING_FPS,
 789   FFMPEG_NICE,
 790   ABUSE_STATES,
 791   VIDEO_CHANNELS,
 792   LRU_CACHE,
 793   JOB_REQUEST_TIMEOUT,
 794   USER_PASSWORD_RESET_LIFETIME,
 795   USER_PASSWORD_CREATE_LIFETIME,
 796   MEMOIZE_TTL,
 797   USER_EMAIL_VERIFY_LIFETIME,
 798   OVERVIEWS,
 799   SCHEDULER_INTERVALS_MS,
 800   REPEAT_JOBS,
 801   STATIC_DOWNLOAD_PATHS,
 802   MIMETYPES,
 803   CRAWL_REQUEST_CONCURRENCY,
 804   DEFAULT_AUDIO_RESOLUTION,
 805   JOB_COMPLETED_LIFETIME,
 806   HTTP_SIGNATURE,
 807   VIDEO_IMPORT_STATES,
 808   VIDEO_VIEW_LIFETIME,
 809   CONTACT_FORM_LIFETIME,
 810   VIDEO_PLAYLIST_PRIVACIES,
 811   PLUGIN_EXTERNAL_AUTH_TOKEN_LIFETIME,
 812   ASSETS_PATH,
 813   FILES_CONTENT_HASH,
 814   loadLanguages,
 815   buildLanguages,
 816   generateContentHash
 817 }
 818
 819 // ---------------------------------------------------------------------------
 820
 821 function buildVideoMimetypeExt () {
 822   const data = {
 823     'video/webm': '.webm',
 824     'video/ogg': '.ogv',
 825     'video/mp4': '.mp4'
 826   }
 827
 828   if (CONFIG.TRANSCODING.ENABLED) {
 829     if (CONFIG.TRANSCODING.ALLOW_ADDITIONAL_EXTENSIONS) {
 830       Object.assign(data, {
 831         'video/quicktime': '.mov',
 832         'video/x-msvideo': '.avi',
 833         'video/x-flv': '.flv',
 834         'video/x-matroska': '.mkv',
 835         'video/avi': '.avi',
 836         'video/x-m4v': '.m4v',
 837         // Could be anything
 838         'application/octet-stream': null,
 839         'video/m4v': '.m4v'
 840       })
 841     }
 842
 843     if (CONFIG.TRANSCODING.ALLOW_AUDIO_FILES) {
 844       Object.assign(data, MIMETYPES.AUDIO.MIMETYPE_EXT)
 845     }
 846   }
 847
 848   return data
 849 }
 850
 851 function updateWebserverUrls () {
 852   WEBSERVER.URL = sanitizeUrl(CONFIG.WEBSERVER.SCHEME + '://' + CONFIG.WEBSERVER.HOSTNAME + ':' + CONFIG.WEBSERVER.PORT)
 853   WEBSERVER.HOST = sanitizeHost(CONFIG.WEBSERVER.HOSTNAME + ':' + CONFIG.WEBSERVER.PORT, REMOTE_SCHEME.HTTP)
 854   WEBSERVER.SCHEME = CONFIG.WEBSERVER.SCHEME
 855   WEBSERVER.WS = CONFIG.WEBSERVER.WS
 856   WEBSERVER.HOSTNAME = CONFIG.WEBSERVER.HOSTNAME
 857   WEBSERVER.PORT = CONFIG.WEBSERVER.PORT
 858 }
 859
 860 function updateWebserverConfig () {
 861   MIMETYPES.VIDEO.MIMETYPE_EXT = buildVideoMimetypeExt()
 862   MIMETYPES.VIDEO.EXT_MIMETYPE = invert(MIMETYPES.VIDEO.MIMETYPE_EXT)
 863   ACTIVITY_PUB.URL_MIME_TYPES.VIDEO = Object.keys(MIMETYPES.VIDEO.MIMETYPE_EXT)
 864
 865   CONSTRAINTS_FIELDS.VIDEOS.EXTNAME = buildVideosExtname()
 866 }
 867
 868 function buildVideosExtname () {
 869   return Object.keys(MIMETYPES.VIDEO.EXT_MIMETYPE)
 870 }
 871
 872 function loadLanguages () {
 873   Object.assign(VIDEO_LANGUAGES, buildLanguages())
 874 }
 875
 876 function buildLanguages () {
 877   const iso639 = require('iso-639-3')
 878
 879   const languages: { [id: string]: string } = {}
 880
 881   const additionalLanguages = {
 882     sgn: true, // Sign languages (macro language)
 883     ase: true, // American sign language
 884     sdl: true, // Arabian sign language
 885     bfi: true, // British sign language
 886     bzs: true, // Brazilian sign language
 887     csl: true, // Chinese sign language
 888     cse: true, // Czech sign language
 889     dsl: true, // Danish sign language
 890     fsl: true, // French sign language
 891     gsg: true, // German sign language
 892     pks: true, // Pakistan sign language
 893     jsl: true, // Japanese sign language
 894     sfs: true, // South African sign language
 895     swl: true, // Swedish sign language
 896     rsl: true, // Russian sign language: true
 897
 898     epo: true, // Esperanto
 899     tlh: true, // Klingon
 900     jbo: true, // Lojban
 901     avk: true // Kotava
 902   }
 903
 904   // Only add ISO639-1 languages and some sign languages (ISO639-3)
 905   iso639
 906     .filter(l => {
 907       return (l.iso6391 !== undefined && l.type === 'living') ||
 908         additionalLanguages[l.iso6393] === true
 909     })
 910     .forEach(l => { languages[l.iso6391 || l.iso6393] = l.name })
 911
 912   // Override Occitan label
 913   languages['oc'] = 'Occitan'
 914   languages['el'] = 'Greek'
 915
 916   return languages
 917 }
 918
 919 function generateContentHash () {
 920   return randomBytes(20).toString('hex')
 921 }