server/initializers/constants.ts

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