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