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