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