server/initializers/constants.ts

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