server/initializers/constants.ts

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