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 = 600
  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', 'best' ],
  76
  77   // Don't forget to update peertube-search-index with the same values
  78   VIDEOS_SEARCH: [ 'name', 'duration', 'createdAt', 'publishedAt', 'originallyPublishedAt', 'views', 'likes', 'match' ],
  79   VIDEO_CHANNELS_SEARCH: [ 'match', 'displayName', 'createdAt' ],
  80
  81   ABUSES: [ 'id', 'createdAt', 'state' ],
  82
  83   ACCOUNTS_BLOCKLIST: [ 'createdAt' ],
  84   SERVERS_BLOCKLIST: [ 'createdAt' ],
  85
  86   USER_NOTIFICATIONS: [ 'createdAt', 'read' ],
  87
  88   VIDEO_PLAYLISTS: [ 'name', 'displayName', 'createdAt', 'updatedAt' ],
  89
  90   PLUGINS: [ 'name', 'createdAt', 'updatedAt' ],
  91
  92   AVAILABLE_PLUGINS: [ 'npmName', 'popularity' ],
  93
  94   VIDEO_REDUNDANCIES: [ 'name' ]
  95 }
  96
  97 const OAUTH_LIFETIME = {
  98   ACCESS_TOKEN: 3600 * 24, // 1 day, for upload
  99   REFRESH_TOKEN: 1209600 // 2 weeks
 100 }
 101
 102 const ROUTE_CACHE_LIFETIME = {
 103   FEEDS: '15 minutes',
 104   ROBOTS: '2 hours',
 105   SITEMAP: '1 day',
 106   SECURITYTXT: '2 hours',
 107   NODEINFO: '10 minutes',
 108   DNT_POLICY: '1 week',
 109   ACTIVITY_PUB: {
 110     VIDEOS: '1 second' // 1 second, cache concurrent requests after a broadcast for example
 111   },
 112   STATS: '4 hours'
 113 }
 114
 115 // ---------------------------------------------------------------------------
 116
 117 // Number of points we add/remove after a successful/bad request
 118 const ACTOR_FOLLOW_SCORE = {
 119   PENALTY: -10,
 120   BONUS: 10,
 121   BASE: 1000,
 122   MAX: 10000
 123 }
 124
 125 const FOLLOW_STATES: { [ id: string ]: FollowState } = {
 126   PENDING: 'pending',
 127   ACCEPTED: 'accepted'
 128 }
 129
 130 const REMOTE_SCHEME = {
 131   HTTP: 'https',
 132   WS: 'wss'
 133 }
 134
 135 const JOB_ATTEMPTS: { [id in JobType]: number } = {
 136   'activitypub-http-broadcast': 5,
 137   'activitypub-http-unicast': 5,
 138   'activitypub-http-fetcher': 5,
 139   'activitypub-follow': 5,
 140   '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   'email': 5,
 156   'videos-views': 1,
 157   'activitypub-refresher': 1,
 158   'video-redundancy': 1,
 159   'video-live-ending': 10
 160 }
 161 const JOB_TTL: { [id in JobType]: number } = {
 162   'activitypub-http-broadcast': 60000 * 10, // 10 minutes
 163   'activitypub-http-unicast': 60000 * 10, // 10 minutes
 164   'activitypub-http-fetcher': 1000 * 3600 * 10, // 10 hours
 165   'activitypub-follow': 60000 * 10, // 10 minutes
 166   'video-file-import': 1000 * 3600, // 1 hour
 167   'video-transcoding': 1000 * 3600 * 48, // 2 days, transcoding could be long
 168   'video-import': 1000 * 3600 * 2, // 2 hours
 169   'email': 60000 * 10, // 10 minutes
 170   'videos-views': undefined, // Unlimited
 171   'activitypub-refresher': 60000 * 10, // 10 minutes
 172   'video-redundancy': 1000 * 3600 * 3, // 3 hours
 173   'video-live-ending': 1000 * 60 * 10 // 10 minutes
 174 }
 175 const REPEAT_JOBS: { [ id: string ]: EveryRepeatOptions | CronRepeatOptions } = {
 176   'videos-views': {
 177     cron: randomInt(1, 20) + ' * * * *' // Between 1-20 minutes past the hour
 178   }
 179 }
 180 const JOB_PRIORITY = {
 181   TRANSCODING: {
 182     OPTIMIZER: 10,
 183     NEW_RESOLUTION: 100
 184   }
 185 }
 186
 187 const BROADCAST_CONCURRENCY = 10 // How many requests in parallel we do in activitypub-http-broadcast job
 188 const CRAWL_REQUEST_CONCURRENCY = 1 // How many requests in parallel to fetch remote data (likes, shares...)
 189 const JOB_REQUEST_TIMEOUT = 7000 // 7 seconds
 190 const JOB_COMPLETED_LIFETIME = 60000 * 60 * 24 * 2 // 2 days
 191 const VIDEO_IMPORT_TIMEOUT = 1000 * 3600 // 1 hour
 192
 193 const SCHEDULER_INTERVALS_MS = {
 194   actorFollowScores: 60000 * 60, // 1 hour
 195   removeOldJobs: 60000 * 60, // 1 hour
 196   updateVideos: 60000, // 1 minute
 197   youtubeDLUpdate: 60000 * 60 * 24, // 1 day
 198   checkPlugins: CONFIG.PLUGINS.INDEX.CHECK_LATEST_VERSIONS_INTERVAL,
 199   autoFollowIndexInstances: 60000 * 60 * 24, // 1 day
 200   removeOldViews: 60000 * 60 * 24, // 1 day
 201   removeOldHistory: 60000 * 60 * 24, // 1 day
 202   updateInboxStats: 1000 * 60// 1 minute
 203 }
 204
 205 // ---------------------------------------------------------------------------
 206
 207 const CONSTRAINTS_FIELDS = {
 208   USERS: {
 209     NAME: { min: 1, max: 120 }, // Length
 210     DESCRIPTION: { min: 3, max: 1000 }, // Length
 211     USERNAME: { min: 1, max: 50 }, // Length
 212     PASSWORD: { min: 6, max: 255 }, // Length
 213     VIDEO_QUOTA: { min: -1 },
 214     VIDEO_QUOTA_DAILY: { min: -1 },
 215     VIDEO_LANGUAGES: { max: 500 }, // Array length
 216     BLOCKED_REASON: { min: 3, max: 250 } // Length
 217   },
 218   ABUSES: {
 219     REASON: { min: 2, max: 3000 }, // Length
 220     MODERATION_COMMENT: { min: 2, max: 3000 } // Length
 221   },
 222   ABUSE_MESSAGES: {
 223     MESSAGE: { min: 2, max: 3000 } // Length
 224   },
 225   VIDEO_BLACKLIST: {
 226     REASON: { min: 2, max: 300 } // Length
 227   },
 228   VIDEO_CHANNELS: {
 229     NAME: { min: 1, max: 120 }, // Length
 230     DESCRIPTION: { min: 3, max: 1000 }, // Length
 231     SUPPORT: { min: 3, max: 1000 }, // Length
 232     URL: { min: 3, max: 2000 } // Length
 233   },
 234   VIDEO_CAPTIONS: {
 235     CAPTION_FILE: {
 236       EXTNAME: [ '.vtt', '.srt' ],
 237       FILE_SIZE: {
 238         max: 2 * 1024 * 1024 // 2MB
 239       }
 240     }
 241   },
 242   VIDEO_IMPORTS: {
 243     URL: { min: 3, max: 2000 }, // Length
 244     TORRENT_NAME: { min: 3, max: 255 }, // Length
 245     TORRENT_FILE: {
 246       EXTNAME: [ '.torrent' ],
 247       FILE_SIZE: {
 248         max: 1024 * 200 // 200 KB
 249       }
 250     }
 251   },
 252   VIDEOS_REDUNDANCY: {
 253     URL: { min: 3, max: 2000 } // Length
 254   },
 255   VIDEO_RATES: {
 256     URL: { min: 3, max: 2000 } // Length
 257   },
 258   VIDEOS: {
 259     NAME: { min: 3, max: 120 }, // Length
 260     LANGUAGE: { min: 1, max: 10 }, // Length
 261     TRUNCATED_DESCRIPTION: { min: 3, max: 250 }, // Length
 262     DESCRIPTION: { min: 3, max: 10000 }, // Length
 263     SUPPORT: { min: 3, max: 1000 }, // Length
 264     IMAGE: {
 265       EXTNAME: [ '.png', '.jpg', '.jpeg', '.webp' ],
 266       FILE_SIZE: {
 267         max: 2 * 1024 * 1024 // 2MB
 268       }
 269     },
 270     EXTNAME: [] as string[],
 271     INFO_HASH: { min: 40, max: 40 }, // Length, info hash is 20 bytes length but we represent it in hexadecimal so 20 * 2
 272     DURATION: { min: 0 }, // Number
 273     TAGS: { min: 0, max: 5 }, // Number of total tags
 274     TAG: { min: 2, max: 30 }, // Length
 275     VIEWS: { min: 0 },
 276     LIKES: { min: 0 },
 277     DISLIKES: { min: 0 },
 278     FILE_SIZE: { min: -1 },
 279     URL: { min: 3, max: 2000 } // Length
 280   },
 281   VIDEO_PLAYLISTS: {
 282     NAME: { min: 1, max: 120 }, // Length
 283     DESCRIPTION: { min: 3, max: 1000 }, // Length
 284     URL: { min: 3, max: 2000 }, // Length
 285     IMAGE: {
 286       EXTNAME: [ '.jpg', '.jpeg' ],
 287       FILE_SIZE: {
 288         max: 2 * 1024 * 1024 // 2MB
 289       }
 290     }
 291   },
 292   ACTORS: {
 293     PUBLIC_KEY: { min: 10, max: 5000 }, // Length
 294     PRIVATE_KEY: { min: 10, max: 5000 }, // Length
 295     URL: { min: 3, max: 2000 }, // Length
 296     AVATAR: {
 297       EXTNAME: [ '.png', '.jpeg', '.jpg', '.gif', '.webp' ],
 298       FILE_SIZE: {
 299         max: 2 * 1024 * 1024 // 2MB
 300       }
 301     }
 302   },
 303   VIDEO_EVENTS: {
 304     COUNT: { min: 0 }
 305   },
 306   VIDEO_COMMENTS: {
 307     TEXT: { min: 1, max: 10000 }, // Length
 308     URL: { min: 3, max: 2000 } // Length
 309   },
 310   VIDEO_SHARE: {
 311     URL: { min: 3, max: 2000 } // Length
 312   },
 313   CONTACT_FORM: {
 314     FROM_NAME: { min: 1, max: 120 }, // Length
 315     BODY: { min: 3, max: 5000 } // Length
 316   },
 317   PLUGINS: {
 318     NAME: { min: 1, max: 214 }, // Length
 319     DESCRIPTION: { min: 1, max: 20000 } // Length
 320   },
 321   COMMONS: {
 322     URL: { min: 5, max: 2000 } // Length
 323   }
 324 }
 325
 326 const VIEW_LIFETIME = {
 327   VIDEO: 60000 * 60, // 1 hour
 328   LIVE: 60000 * 5 // 5 minutes
 329 }
 330
 331 let CONTACT_FORM_LIFETIME = 60000 * 60 // 1 hour
 332
 333 const VIDEO_TRANSCODING_FPS: VideoTranscodingFPS = {
 334   MIN: 10,
 335   STANDARD: [ 24, 25, 30 ],
 336   HD_STANDARD: [ 50, 60 ],
 337   AVERAGE: 30,
 338   MAX: 60,
 339   KEEP_ORIGIN_FPS_RESOLUTION_MIN: 720 // We keep the original FPS on high resolutions (720 minimum)
 340 }
 341
 342 const DEFAULT_AUDIO_RESOLUTION = VideoResolution.H_480P
 343
 344 const VIDEO_RATE_TYPES: { [ id: string ]: VideoRateType } = {
 345   LIKE: 'like',
 346   DISLIKE: 'dislike'
 347 }
 348
 349 const FFMPEG_NICE: { [ id: string ]: number } = {
 350   // parent process defaults to niceness = 0
 351   // reminder: lower = higher priority, max value is 19, lowest is -20
 352   LIVE: 5, // prioritize over VOD and THUMBNAIL
 353   THUMBNAIL: 10,
 354   VOD: 15
 355 }
 356
 357 const VIDEO_CATEGORIES = {
 358   1: 'Music',
 359   2: 'Films',
 360   3: 'Vehicles',
 361   4: 'Art',
 362   5: 'Sports',
 363   6: 'Travels',
 364   7: 'Gaming',
 365   8: 'People',
 366   9: 'Comedy',
 367   10: 'Entertainment',
 368   11: 'News & Politics',
 369   12: 'How To',
 370   13: 'Education',
 371   14: 'Activism',
 372   15: 'Science & Technology',
 373   16: 'Animals',
 374   17: 'Kids',
 375   18: 'Food'
 376 }
 377
 378 // See https://creativecommons.org/licenses/?lang=en
 379 const VIDEO_LICENCES = {
 380   1: 'Attribution',
 381   2: 'Attribution - Share Alike',
 382   3: 'Attribution - No Derivatives',
 383   4: 'Attribution - Non Commercial',
 384   5: 'Attribution - Non Commercial - Share Alike',
 385   6: 'Attribution - Non Commercial - No Derivatives',
 386   7: 'Public Domain Dedication'
 387 }
 388
 389 const VIDEO_LANGUAGES: { [id: string]: string } = {}
 390
 391 const VIDEO_PRIVACIES: { [ id in VideoPrivacy ]: string } = {
 392   [VideoPrivacy.PUBLIC]: 'Public',
 393   [VideoPrivacy.UNLISTED]: 'Unlisted',
 394   [VideoPrivacy.PRIVATE]: 'Private',
 395   [VideoPrivacy.INTERNAL]: 'Internal'
 396 }
 397
 398 const VIDEO_STATES: { [ id in VideoState ]: string } = {
 399   [VideoState.PUBLISHED]: 'Published',
 400   [VideoState.TO_TRANSCODE]: 'To transcode',
 401   [VideoState.TO_IMPORT]: 'To import',
 402   [VideoState.WAITING_FOR_LIVE]: 'Waiting for livestream',
 403   [VideoState.LIVE_ENDED]: 'Livestream ended'
 404 }
 405
 406 const VIDEO_IMPORT_STATES: { [ id in VideoImportState ]: string } = {
 407   [VideoImportState.FAILED]: 'Failed',
 408   [VideoImportState.PENDING]: 'Pending',
 409   [VideoImportState.SUCCESS]: 'Success',
 410   [VideoImportState.REJECTED]: 'Rejected'
 411 }
 412
 413 const ABUSE_STATES: { [ id in AbuseState ]: string } = {
 414   [AbuseState.PENDING]: 'Pending',
 415   [AbuseState.REJECTED]: 'Rejected',
 416   [AbuseState.ACCEPTED]: 'Accepted'
 417 }
 418
 419 const VIDEO_PLAYLIST_PRIVACIES: { [ id in VideoPlaylistPrivacy ]: string } = {
 420   [VideoPlaylistPrivacy.PUBLIC]: 'Public',
 421   [VideoPlaylistPrivacy.UNLISTED]: 'Unlisted',
 422   [VideoPlaylistPrivacy.PRIVATE]: 'Private'
 423 }
 424
 425 const VIDEO_PLAYLIST_TYPES: { [ id in VideoPlaylistType ]: string } = {
 426   [VideoPlaylistType.REGULAR]: 'Regular',
 427   [VideoPlaylistType.WATCH_LATER]: 'Watch later'
 428 }
 429
 430 const MIMETYPES = {
 431   AUDIO: {
 432     MIMETYPE_EXT: {
 433       'audio/mpeg': '.mp3',
 434       'audio/mp3': '.mp3',
 435       'application/ogg': '.ogg',
 436       'audio/ogg': '.ogg',
 437       'audio/x-ms-wma': '.wma',
 438       'audio/wav': '.wav',
 439       'audio/x-flac': '.flac',
 440       'audio/flac': '.flac',
 441       '‎audio/aac': '.aac',
 442       'audio/m4a': '.m4a',
 443       'audio/mp4': '.m4a',
 444       'audio/x-m4a': '.m4a',
 445       'audio/ac3': '.ac3'
 446     },
 447     EXT_MIMETYPE: null as { [ id: string ]: string }
 448   },
 449   VIDEO: {
 450     MIMETYPE_EXT: null as { [ id: string ]: string | string[] },
 451     MIMETYPES_REGEX: null as string,
 452     EXT_MIMETYPE: null as { [ id: string ]: string }
 453   },
 454   IMAGE: {
 455     MIMETYPE_EXT: {
 456       'image/png': '.png',
 457       'image/jpg': '.jpg',
 458       'image/jpeg': '.jpg'
 459     },
 460     EXT_MIMETYPE: null as { [ id: string ]: string }
 461   },
 462   VIDEO_CAPTIONS: {
 463     MIMETYPE_EXT: {
 464       'text/vtt': '.vtt',
 465       'application/x-subrip': '.srt',
 466       'text/plain': '.srt'
 467     }
 468   },
 469   TORRENT: {
 470     MIMETYPE_EXT: {
 471       'application/x-bittorrent': '.torrent'
 472     }
 473   }
 474 }
 475 MIMETYPES.AUDIO.EXT_MIMETYPE = invert(MIMETYPES.AUDIO.MIMETYPE_EXT)
 476 MIMETYPES.IMAGE.EXT_MIMETYPE = invert(MIMETYPES.IMAGE.MIMETYPE_EXT)
 477
 478 // ---------------------------------------------------------------------------
 479
 480 const OVERVIEWS = {
 481   VIDEOS: {
 482     SAMPLE_THRESHOLD: 6,
 483     SAMPLES_COUNT: 20
 484   }
 485 }
 486
 487 const VIDEO_CHANNELS = {
 488   MAX_PER_USER: 20
 489 }
 490
 491 // ---------------------------------------------------------------------------
 492
 493 const SERVER_ACTOR_NAME = 'peertube'
 494
 495 const ACTIVITY_PUB = {
 496   POTENTIAL_ACCEPT_HEADERS: [
 497     'application/activity+json',
 498     'application/ld+json',
 499     'application/ld+json; profile="https://www.w3.org/ns/activitystreams"'
 500   ],
 501   ACCEPT_HEADER: 'application/activity+json, application/ld+json',
 502   PUBLIC: 'https://www.w3.org/ns/activitystreams#Public',
 503   COLLECTION_ITEMS_PER_PAGE: 10,
 504   FETCH_PAGE_LIMIT: 2000,
 505   URL_MIME_TYPES: {
 506     VIDEO: [] as string[],
 507     TORRENT: [ 'application/x-bittorrent' ],
 508     MAGNET: [ 'application/x-bittorrent;x-scheme-handler/magnet' ]
 509   },
 510   MAX_RECURSION_COMMENTS: 100,
 511   ACTOR_REFRESH_INTERVAL: 3600 * 24 * 1000 * 2, // 2 days
 512   VIDEO_REFRESH_INTERVAL: 3600 * 24 * 1000 * 2, // 2 days
 513   VIDEO_PLAYLIST_REFRESH_INTERVAL: 3600 * 24 * 1000 * 2 // 2 days
 514 }
 515
 516 const ACTIVITY_PUB_ACTOR_TYPES: { [ id: string ]: ActivityPubActorType } = {
 517   GROUP: 'Group',
 518   PERSON: 'Person',
 519   APPLICATION: 'Application',
 520   ORGANIZATION: 'Organization',
 521   SERVICE: 'Service'
 522 }
 523
 524 const HTTP_SIGNATURE = {
 525   HEADER_NAME: 'signature',
 526   ALGORITHM: 'rsa-sha256',
 527   HEADERS_TO_SIGN: [ '(request-target)', 'host', 'date', 'digest' ],
 528   REQUIRED_HEADERS: {
 529     ALL: [ '(request-target)', 'host', 'date' ],
 530     POST: [ '(request-target)', 'host', 'date', 'digest' ]
 531   },
 532   CLOCK_SKEW_SECONDS: 1800
 533 }
 534
 535 // ---------------------------------------------------------------------------
 536
 537 let PRIVATE_RSA_KEY_SIZE = 2048
 538
 539 // Password encryption
 540 const BCRYPT_SALT_SIZE = 10
 541
 542 const USER_PASSWORD_RESET_LIFETIME = 60000 * 60 // 60 minutes
 543 const USER_PASSWORD_CREATE_LIFETIME = 60000 * 60 * 24 * 7 // 7 days
 544
 545 const USER_EMAIL_VERIFY_LIFETIME = 60000 * 60 // 60 minutes
 546
 547 const NSFW_POLICY_TYPES: { [ id: string ]: NSFWPolicyType } = {
 548   DO_NOT_LIST: 'do_not_list',
 549   BLUR: 'blur',
 550   DISPLAY: 'display'
 551 }
 552
 553 // ---------------------------------------------------------------------------
 554
 555 // Express static paths (router)
 556 const STATIC_PATHS = {
 557   THUMBNAILS: '/static/thumbnails/',
 558   TORRENTS: '/static/torrents/',
 559   WEBSEED: '/static/webseed/',
 560   REDUNDANCY: '/static/redundancy/',
 561   STREAMING_PLAYLISTS: {
 562     HLS: '/static/streaming-playlists/hls'
 563   }
 564 }
 565 const STATIC_DOWNLOAD_PATHS = {
 566   TORRENTS: '/download/torrents/',
 567   VIDEOS: '/download/videos/',
 568   HLS_VIDEOS: '/download/streaming-playlists/hls/videos/'
 569 }
 570 const LAZY_STATIC_PATHS = {
 571   AVATARS: '/lazy-static/avatars/',
 572   PREVIEWS: '/lazy-static/previews/',
 573   VIDEO_CAPTIONS: '/lazy-static/video-captions/',
 574   TORRENTS: '/lazy-static/torrents/'
 575 }
 576
 577 // Cache control
 578 const STATIC_MAX_AGE = {
 579   SERVER: '2h',
 580   LAZY_SERVER: '2d',
 581   CLIENT: '30d'
 582 }
 583
 584 // Videos thumbnail size
 585 const THUMBNAILS_SIZE = {
 586   width: 223,
 587   height: 122,
 588   minWidth: 150
 589 }
 590 const PREVIEWS_SIZE = {
 591   width: 850,
 592   height: 480,
 593   minWidth: 400
 594 }
 595 const AVATARS_SIZE = {
 596   width: 120,
 597   height: 120
 598 }
 599
 600 const EMBED_SIZE = {
 601   width: 560,
 602   height: 315
 603 }
 604
 605 // Sub folders of cache directory
 606 const FILES_CACHE = {
 607   PREVIEWS: {
 608     DIRECTORY: join(CONFIG.STORAGE.CACHE_DIR, 'previews'),
 609     MAX_AGE: 1000 * 3600 * 3 // 3 hours
 610   },
 611   VIDEO_CAPTIONS: {
 612     DIRECTORY: join(CONFIG.STORAGE.CACHE_DIR, 'video-captions'),
 613     MAX_AGE: 1000 * 3600 * 3 // 3 hours
 614   },
 615   TORRENTS: {
 616     DIRECTORY: join(CONFIG.STORAGE.CACHE_DIR, 'torrents'),
 617     MAX_AGE: 1000 * 3600 * 3 // 3 hours
 618   }
 619 }
 620
 621 const LRU_CACHE = {
 622   USER_TOKENS: {
 623     MAX_SIZE: 1000
 624   },
 625   AVATAR_STATIC: {
 626     MAX_SIZE: 500
 627   }
 628 }
 629
 630 const HLS_STREAMING_PLAYLIST_DIRECTORY = join(CONFIG.STORAGE.STREAMING_PLAYLISTS_DIR, 'hls')
 631 const HLS_REDUNDANCY_DIRECTORY = join(CONFIG.STORAGE.REDUNDANCY_DIR, 'hls')
 632
 633 const VIDEO_LIVE = {
 634   EXTENSION: '.ts',
 635   CLEANUP_DELAY: 1000 * 60 * 5, // 5 minutes
 636   SEGMENT_TIME_SECONDS: 4, // 4 seconds
 637   SEGMENTS_LIST_SIZE: 15, // 15 maximum segments in live playlist
 638   REPLAY_DIRECTORY: 'replay',
 639   EDGE_LIVE_DELAY_SEGMENTS_NOTIFICATION: 4,
 640   MAX_SOCKET_WAITING_DATA: 1024 * 1000 * 100, // 100MB
 641   RTMP: {
 642     CHUNK_SIZE: 60000,
 643     GOP_CACHE: true,
 644     PING: 60,
 645     PING_TIMEOUT: 30,
 646     BASE_PATH: 'live'
 647   }
 648 }
 649
 650 const MEMOIZE_TTL = {
 651   OVERVIEWS_SAMPLE: 1000 * 3600 * 4, // 4 hours
 652   INFO_HASH_EXISTS: 1000 * 3600 * 12, // 12 hours
 653   LIVE_ABLE_TO_UPLOAD: 1000 * 60, // 1 minute
 654   LIVE_CHECK_SOCKET_HEALTH: 1000 * 60 // 1 minute
 655 }
 656
 657 const MEMOIZE_LENGTH = {
 658   INFO_HASH_EXISTS: 200
 659 }
 660
 661 const QUEUE_CONCURRENCY = {
 662   AVATAR_PROCESS_IMAGE: 3
 663 }
 664
 665 const REDUNDANCY = {
 666   VIDEOS: {
 667     RANDOMIZED_FACTOR: 5
 668   }
 669 }
 670
 671 const ACCEPT_HEADERS = [ 'html', 'application/json' ].concat(ACTIVITY_PUB.POTENTIAL_ACCEPT_HEADERS)
 672
 673 const ASSETS_PATH = {
 674   DEFAULT_AUDIO_BACKGROUND: join(root(), 'dist', 'server', 'assets', 'default-audio-background.jpg'),
 675   DEFAULT_LIVE_BACKGROUND: join(root(), 'dist', 'server', 'assets', 'default-live-background.jpg')
 676 }
 677
 678 // ---------------------------------------------------------------------------
 679
 680 const CUSTOM_HTML_TAG_COMMENTS = {
 681   TITLE: '<!-- title tag -->',
 682   DESCRIPTION: '<!-- description tag -->',
 683   CUSTOM_CSS: '<!-- custom css tag -->',
 684   META_TAGS: '<!-- meta tags -->'
 685 }
 686
 687 // ---------------------------------------------------------------------------
 688
 689 const FEEDS = {
 690   COUNT: 20
 691 }
 692
 693 const MAX_LOGS_OUTPUT_CHARACTERS = 10 * 1000 * 1000
 694 const LOG_FILENAME = 'peertube.log'
 695 const AUDIT_LOG_FILENAME = 'peertube-audit.log'
 696
 697 // ---------------------------------------------------------------------------
 698
 699 const TRACKER_RATE_LIMITS = {
 700   INTERVAL: 60000 * 5, // 5 minutes
 701   ANNOUNCES_PER_IP_PER_INFOHASH: 15, // maximum announces per torrent in the interval
 702   ANNOUNCES_PER_IP: 30, // maximum announces for all our torrents in the interval
 703   BLOCK_IP_LIFETIME: 60000 * 3 // 3 minutes
 704 }
 705
 706 const P2P_MEDIA_LOADER_PEER_VERSION = 2
 707
 708 // ---------------------------------------------------------------------------
 709
 710 const PLUGIN_GLOBAL_CSS_FILE_NAME = 'plugins-global.css'
 711 const PLUGIN_GLOBAL_CSS_PATH = join(CONFIG.STORAGE.TMP_DIR, PLUGIN_GLOBAL_CSS_FILE_NAME)
 712
 713 let PLUGIN_EXTERNAL_AUTH_TOKEN_LIFETIME = 1000 * 60 * 5 // 5 minutes
 714
 715 const DEFAULT_THEME_NAME = 'default'
 716 const DEFAULT_USER_THEME_NAME = 'instance-default'
 717
 718 // ---------------------------------------------------------------------------
 719
 720 const SEARCH_INDEX = {
 721   ROUTES: {
 722     VIDEOS: '/api/v1/search/videos',
 723     VIDEO_CHANNELS: '/api/v1/search/video-channels'
 724   }
 725 }
 726
 727 // ---------------------------------------------------------------------------
 728
 729 // Special constants for a test instance
 730 if (isTestInstance() === true) {
 731   PRIVATE_RSA_KEY_SIZE = 1024
 732
 733   ACTOR_FOLLOW_SCORE.BASE = 20
 734
 735   REMOTE_SCHEME.HTTP = 'http'
 736   REMOTE_SCHEME.WS = 'ws'
 737
 738   STATIC_MAX_AGE.SERVER = '0'
 739
 740   ACTIVITY_PUB.COLLECTION_ITEMS_PER_PAGE = 2
 741   ACTIVITY_PUB.ACTOR_REFRESH_INTERVAL = 10 * 1000 // 10 seconds
 742   ACTIVITY_PUB.VIDEO_REFRESH_INTERVAL = 10 * 1000 // 10 seconds
 743   ACTIVITY_PUB.VIDEO_PLAYLIST_REFRESH_INTERVAL = 10 * 1000 // 10 seconds
 744
 745   CONSTRAINTS_FIELDS.ACTORS.AVATAR.FILE_SIZE.max = 100 * 1024 // 100KB
 746   CONSTRAINTS_FIELDS.VIDEOS.IMAGE.FILE_SIZE.max = 400 * 1024 // 400KB
 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   FOLLOW_STATES,
 825   DEFAULT_USER_THEME_NAME,
 826   SERVER_ACTOR_NAME,
 827   PLUGIN_GLOBAL_CSS_FILE_NAME,
 828   PLUGIN_GLOBAL_CSS_PATH,
 829   PRIVATE_RSA_KEY_SIZE,
 830   ROUTE_CACHE_LIFETIME,
 831   SORTABLE_COLUMNS,
 832   HLS_STREAMING_PLAYLIST_DIRECTORY,
 833   FEEDS,
 834   JOB_TTL,
 835   DEFAULT_THEME_NAME,
 836   NSFW_POLICY_TYPES,
 837   STATIC_MAX_AGE,
 838   STATIC_PATHS,
 839   VIDEO_IMPORT_TIMEOUT,
 840   VIDEO_PLAYLIST_TYPES,
 841   MAX_LOGS_OUTPUT_CHARACTERS,
 842   ACTIVITY_PUB,
 843   ACTIVITY_PUB_ACTOR_TYPES,
 844   THUMBNAILS_SIZE,
 845   VIDEO_CATEGORIES,
 846   MEMOIZE_LENGTH,
 847   VIDEO_LANGUAGES,
 848   VIDEO_PRIVACIES,
 849   VIDEO_LICENCES,
 850   VIDEO_STATES,
 851   QUEUE_CONCURRENCY,
 852   VIDEO_RATE_TYPES,
 853   JOB_PRIORITY,
 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 }