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