server/initializers/constants.ts

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