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