server/initializers/constants.ts

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