server/initializers/constants.ts

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