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