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