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