server/initializers/constants.ts

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