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   },
 427   VIDEO_CAPTIONS: {
 428     MIMETYPE_EXT: {
 429       'text/vtt': '.vtt',
 430       'application/x-subrip': '.srt',
 431       'text/plain': '.srt'
 432     }
 433   },
 434   TORRENT: {
 435     MIMETYPE_EXT: {
 436       'application/x-bittorrent': '.torrent'
 437     }
 438   }
 439 }
 440 MIMETYPES.AUDIO.EXT_MIMETYPE = invert(MIMETYPES.AUDIO.MIMETYPE_EXT)
 441
 442 // ---------------------------------------------------------------------------
 443
 444 const OVERVIEWS = {
 445   VIDEOS: {
 446     SAMPLE_THRESHOLD: 6,
 447     SAMPLES_COUNT: 2
 448   }
 449 }
 450
 451 const VIDEO_CHANNELS = {
 452   MAX_PER_USER: 20
 453 }
 454
 455 // ---------------------------------------------------------------------------
 456
 457 const SERVER_ACTOR_NAME = 'peertube'
 458
 459 const ACTIVITY_PUB = {
 460   POTENTIAL_ACCEPT_HEADERS: [
 461     'application/activity+json',
 462     'application/ld+json',
 463     'application/ld+json; profile="https://www.w3.org/ns/activitystreams"'
 464   ],
 465   ACCEPT_HEADER: 'application/activity+json, application/ld+json',
 466   PUBLIC: 'https://www.w3.org/ns/activitystreams#Public',
 467   COLLECTION_ITEMS_PER_PAGE: 10,
 468   FETCH_PAGE_LIMIT: 100,
 469   URL_MIME_TYPES: {
 470     VIDEO: [] as string[],
 471     TORRENT: [ 'application/x-bittorrent' ],
 472     MAGNET: [ 'application/x-bittorrent;x-scheme-handler/magnet' ]
 473   },
 474   MAX_RECURSION_COMMENTS: 100,
 475   ACTOR_REFRESH_INTERVAL: 3600 * 24 * 1000 * 2, // 2 days
 476   VIDEO_REFRESH_INTERVAL: 3600 * 24 * 1000 * 2, // 2 days
 477   VIDEO_PLAYLIST_REFRESH_INTERVAL: 3600 * 24 * 1000 * 2 // 2 days
 478 }
 479
 480 const ACTIVITY_PUB_ACTOR_TYPES: { [ id: string ]: ActivityPubActorType } = {
 481   GROUP: 'Group',
 482   PERSON: 'Person',
 483   APPLICATION: 'Application',
 484   ORGANIZATION: 'Organization',
 485   SERVICE: 'Service'
 486 }
 487
 488 const HTTP_SIGNATURE = {
 489   HEADER_NAME: 'signature',
 490   ALGORITHM: 'rsa-sha256',
 491   HEADERS_TO_SIGN: [ '(request-target)', 'host', 'date', 'digest' ],
 492   CLOCK_SKEW_SECONDS: 1800
 493 }
 494
 495 // ---------------------------------------------------------------------------
 496
 497 let PRIVATE_RSA_KEY_SIZE = 2048
 498
 499 // Password encryption
 500 const BCRYPT_SALT_SIZE = 10
 501
 502 const USER_PASSWORD_RESET_LIFETIME = 60000 * 60 // 60 minutes
 503
 504 const USER_EMAIL_VERIFY_LIFETIME = 60000 * 60 // 60 minutes
 505
 506 const NSFW_POLICY_TYPES: { [ id: string ]: NSFWPolicyType } = {
 507   DO_NOT_LIST: 'do_not_list',
 508   BLUR: 'blur',
 509   DISPLAY: 'display'
 510 }
 511
 512 // ---------------------------------------------------------------------------
 513
 514 // Express static paths (router)
 515 const STATIC_PATHS = {
 516   PREVIEWS: '/static/previews/',
 517   THUMBNAILS: '/static/thumbnails/',
 518   TORRENTS: '/static/torrents/',
 519   WEBSEED: '/static/webseed/',
 520   REDUNDANCY: '/static/redundancy/',
 521   STREAMING_PLAYLISTS: {
 522     HLS: '/static/streaming-playlists/hls'
 523   },
 524   AVATARS: '/static/avatars/',
 525   VIDEO_CAPTIONS: '/static/video-captions/'
 526 }
 527 const STATIC_DOWNLOAD_PATHS = {
 528   TORRENTS: '/download/torrents/',
 529   VIDEOS: '/download/videos/',
 530   HLS_VIDEOS: '/download/streaming-playlists/hls/videos/'
 531 }
 532 const LAZY_STATIC_PATHS = {
 533   AVATARS: '/lazy-static/avatars/',
 534   PREVIEWS: '/static/previews/',
 535   VIDEO_CAPTIONS: '/static/video-captions/'
 536 }
 537
 538 // Cache control
 539 const STATIC_MAX_AGE = {
 540   SERVER: '2h',
 541   CLIENT: '30d'
 542 }
 543
 544 // Videos thumbnail size
 545 const THUMBNAILS_SIZE = {
 546   width: 223,
 547   height: 122,
 548   minWidth: 150
 549 }
 550 const PREVIEWS_SIZE = {
 551   width: 850,
 552   height: 480,
 553   minWidth: 400
 554 }
 555 const AVATARS_SIZE = {
 556   width: 120,
 557   height: 120
 558 }
 559
 560 const EMBED_SIZE = {
 561   width: 560,
 562   height: 315
 563 }
 564
 565 // Sub folders of cache directory
 566 const FILES_CACHE = {
 567   PREVIEWS: {
 568     DIRECTORY: join(CONFIG.STORAGE.CACHE_DIR, 'previews'),
 569     MAX_AGE: 1000 * 3600 * 3 // 3 hours
 570   },
 571   VIDEO_CAPTIONS: {
 572     DIRECTORY: join(CONFIG.STORAGE.CACHE_DIR, 'video-captions'),
 573     MAX_AGE: 1000 * 3600 * 3 // 3 hours
 574   }
 575 }
 576
 577 const LRU_CACHE = {
 578   USER_TOKENS: {
 579     MAX_SIZE: 1000
 580   },
 581   AVATAR_STATIC: {
 582     MAX_SIZE: 500
 583   }
 584 }
 585
 586 const HLS_STREAMING_PLAYLIST_DIRECTORY = join(CONFIG.STORAGE.STREAMING_PLAYLISTS_DIR, 'hls')
 587 const HLS_REDUNDANCY_DIRECTORY = join(CONFIG.STORAGE.REDUNDANCY_DIR, 'hls')
 588
 589 const MEMOIZE_TTL = {
 590   OVERVIEWS_SAMPLE: 1000 * 3600 * 4, // 4 hours
 591   INFO_HASH_EXISTS: 1000 * 3600 * 12 // 12 hours
 592 }
 593
 594 const MEMOIZE_LENGTH = {
 595   INFO_HASH_EXISTS: 200
 596 }
 597
 598 const QUEUE_CONCURRENCY = {
 599   AVATAR_PROCESS_IMAGE: 3
 600 }
 601
 602 const REDUNDANCY = {
 603   VIDEOS: {
 604     RANDOMIZED_FACTOR: 5
 605   }
 606 }
 607
 608 const ACCEPT_HEADERS = [ 'html', 'application/json' ].concat(ACTIVITY_PUB.POTENTIAL_ACCEPT_HEADERS)
 609
 610 const ASSETS_PATH = {
 611   DEFAULT_AUDIO_BACKGROUND: join(root(), 'dist', 'server', 'assets', 'default-audio-background.jpg')
 612 }
 613
 614 // ---------------------------------------------------------------------------
 615
 616 const CUSTOM_HTML_TAG_COMMENTS = {
 617   TITLE: '<!-- title tag -->',
 618   DESCRIPTION: '<!-- description tag -->',
 619   CUSTOM_CSS: '<!-- custom css tag -->',
 620   META_TAGS: '<!-- meta tags -->'
 621 }
 622
 623 // ---------------------------------------------------------------------------
 624
 625 const FEEDS = {
 626   COUNT: 20
 627 }
 628
 629 const MAX_LOGS_OUTPUT_CHARACTERS = 10 * 1000 * 1000
 630 const LOG_FILENAME = 'peertube.log'
 631 const AUDIT_LOG_FILENAME = 'peertube-audit.log'
 632
 633 // ---------------------------------------------------------------------------
 634
 635 const TRACKER_RATE_LIMITS = {
 636   INTERVAL: 60000 * 5, // 5 minutes
 637   ANNOUNCES_PER_IP_PER_INFOHASH: 15, // maximum announces per torrent in the interval
 638   ANNOUNCES_PER_IP: 30 // maximum announces for all our torrents in the interval
 639 }
 640
 641 const P2P_MEDIA_LOADER_PEER_VERSION = 2
 642
 643 // ---------------------------------------------------------------------------
 644
 645 const PLUGIN_GLOBAL_CSS_FILE_NAME = 'plugins-global.css'
 646 const PLUGIN_GLOBAL_CSS_PATH = join(CONFIG.STORAGE.TMP_DIR, PLUGIN_GLOBAL_CSS_FILE_NAME)
 647
 648 const DEFAULT_THEME_NAME = 'default'
 649 const DEFAULT_USER_THEME_NAME = 'instance-default'
 650
 651 // ---------------------------------------------------------------------------
 652
 653 // Special constants for a test instance
 654 if (isTestInstance() === true) {
 655   PRIVATE_RSA_KEY_SIZE = 1024
 656
 657   ACTOR_FOLLOW_SCORE.BASE = 20
 658
 659   REMOTE_SCHEME.HTTP = 'http'
 660   REMOTE_SCHEME.WS = 'ws'
 661
 662   STATIC_MAX_AGE.SERVER = '0'
 663
 664   ACTIVITY_PUB.COLLECTION_ITEMS_PER_PAGE = 2
 665   ACTIVITY_PUB.ACTOR_REFRESH_INTERVAL = 10 * 1000 // 10 seconds
 666   ACTIVITY_PUB.VIDEO_REFRESH_INTERVAL = 10 * 1000 // 10 seconds
 667   ACTIVITY_PUB.VIDEO_PLAYLIST_REFRESH_INTERVAL = 10 * 1000 // 10 seconds
 668
 669   CONSTRAINTS_FIELDS.ACTORS.AVATAR.FILE_SIZE.max = 100 * 1024 // 100KB
 670
 671   SCHEDULER_INTERVALS_MS.actorFollowScores = 1000
 672   SCHEDULER_INTERVALS_MS.removeOldJobs = 10000
 673   SCHEDULER_INTERVALS_MS.removeOldHistory = 5000
 674   SCHEDULER_INTERVALS_MS.removeOldViews = 5000
 675   SCHEDULER_INTERVALS_MS.updateVideos = 5000
 676   SCHEDULER_INTERVALS_MS.autoFollowIndexInstances = 5000
 677   REPEAT_JOBS['videos-views'] = { every: 5000 }
 678
 679   REDUNDANCY.VIDEOS.RANDOMIZED_FACTOR = 1
 680
 681   VIDEO_VIEW_LIFETIME = 1000 // 1 second
 682   CONTACT_FORM_LIFETIME = 1000 // 1 second
 683
 684   JOB_ATTEMPTS['email'] = 1
 685
 686   FILES_CACHE.VIDEO_CAPTIONS.MAX_AGE = 3000
 687   MEMOIZE_TTL.OVERVIEWS_SAMPLE = 1
 688   ROUTE_CACHE_LIFETIME.OVERVIEWS.VIDEOS = '0ms'
 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   INSTANCES_INDEX,
 730   DEFAULT_USER_THEME_NAME,
 731   SERVER_ACTOR_NAME,
 732   PLUGIN_GLOBAL_CSS_FILE_NAME,
 733   PLUGIN_GLOBAL_CSS_PATH,
 734   PRIVATE_RSA_KEY_SIZE,
 735   ROUTE_CACHE_LIFETIME,
 736   SORTABLE_COLUMNS,
 737   HLS_STREAMING_PLAYLIST_DIRECTORY,
 738   FEEDS,
 739   JOB_TTL,
 740   DEFAULT_THEME_NAME,
 741   NSFW_POLICY_TYPES,
 742   STATIC_MAX_AGE,
 743   STATIC_PATHS,
 744   VIDEO_IMPORT_TIMEOUT,
 745   VIDEO_PLAYLIST_TYPES,
 746   MAX_LOGS_OUTPUT_CHARACTERS,
 747   ACTIVITY_PUB,
 748   ACTIVITY_PUB_ACTOR_TYPES,
 749   THUMBNAILS_SIZE,
 750   VIDEO_CATEGORIES,
 751   MEMOIZE_LENGTH,
 752   VIDEO_LANGUAGES,
 753   VIDEO_PRIVACIES,
 754   VIDEO_LICENCES,
 755   VIDEO_STATES,
 756   QUEUE_CONCURRENCY,
 757   VIDEO_RATE_TYPES,
 758   VIDEO_TRANSCODING_FPS,
 759   FFMPEG_NICE,
 760   VIDEO_ABUSE_STATES,
 761   VIDEO_CHANNELS,
 762   LRU_CACHE,
 763   JOB_REQUEST_TIMEOUT,
 764   USER_PASSWORD_RESET_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   ASSETS_PATH,
 781   loadLanguages,
 782   buildLanguages
 783 }
 784
 785 // ---------------------------------------------------------------------------
 786
 787 function buildVideoMimetypeExt () {
 788   const data = {
 789     'video/webm': '.webm',
 790     'video/ogg': '.ogv',
 791     'video/mp4': '.mp4'
 792   }
 793
 794   if (CONFIG.TRANSCODING.ENABLED) {
 795     if (CONFIG.TRANSCODING.ALLOW_ADDITIONAL_EXTENSIONS) {
 796       Object.assign(data, {
 797         'video/quicktime': '.mov',
 798         'video/x-msvideo': '.avi',
 799         'video/x-flv': '.flv',
 800         'video/x-matroska': '.mkv',
 801         'video/avi': '.avi',
 802         'video/x-m4v': '.m4v',
 803         // Could be anything
 804         'application/octet-stream': null,
 805         'video/m4v': '.m4v'
 806       })
 807     }
 808
 809     if (CONFIG.TRANSCODING.ALLOW_AUDIO_FILES) {
 810       Object.assign(data, MIMETYPES.AUDIO.MIMETYPE_EXT)
 811     }
 812   }
 813
 814   return data
 815 }
 816
 817 function updateWebserverUrls () {
 818   WEBSERVER.URL = sanitizeUrl(CONFIG.WEBSERVER.SCHEME + '://' + CONFIG.WEBSERVER.HOSTNAME + ':' + CONFIG.WEBSERVER.PORT)
 819   WEBSERVER.HOST = sanitizeHost(CONFIG.WEBSERVER.HOSTNAME + ':' + CONFIG.WEBSERVER.PORT, REMOTE_SCHEME.HTTP)
 820   WEBSERVER.SCHEME = CONFIG.WEBSERVER.SCHEME
 821   WEBSERVER.WS = CONFIG.WEBSERVER.WS
 822   WEBSERVER.HOSTNAME = CONFIG.WEBSERVER.HOSTNAME
 823   WEBSERVER.PORT = CONFIG.WEBSERVER.PORT
 824 }
 825
 826 function updateWebserverConfig () {
 827   MIMETYPES.VIDEO.MIMETYPE_EXT = buildVideoMimetypeExt()
 828   MIMETYPES.VIDEO.EXT_MIMETYPE = invert(MIMETYPES.VIDEO.MIMETYPE_EXT)
 829   ACTIVITY_PUB.URL_MIME_TYPES.VIDEO = Object.keys(MIMETYPES.VIDEO.MIMETYPE_EXT)
 830
 831   CONSTRAINTS_FIELDS.VIDEOS.EXTNAME = buildVideosExtname()
 832 }
 833
 834 function buildVideosExtname () {
 835   return Object.keys(MIMETYPES.VIDEO.EXT_MIMETYPE)
 836 }
 837
 838 function loadLanguages () {
 839   Object.assign(VIDEO_LANGUAGES, buildLanguages())
 840 }
 841
 842 function buildLanguages () {
 843   const iso639 = require('iso-639-3')
 844
 845   const languages: { [id: string]: string } = {}
 846
 847   const additionalLanguages = {
 848     sgn: true, // Sign languages (macro language)
 849     ase: true, // American sign language
 850     sdl: true, // Arabian sign language
 851     bfi: true, // British sign language
 852     bzs: true, // Brazilian sign language
 853     csl: true, // Chinese sign language
 854     cse: true, // Czech sign language
 855     dsl: true, // Danish sign language
 856     fsl: true, // French sign language
 857     gsg: true, // German sign language
 858     pks: true, // Pakistan sign language
 859     jsl: true, // Japanese sign language
 860     sfs: true, // South African sign language
 861     swl: true, // Swedish sign language
 862     rsl: true, // Russian sign language: true
 863
 864     epo: true, // Esperanto
 865     tlh: true, // Klingon
 866     jbo: true, // Lojban
 867     avk: true // Kotava
 868   }
 869
 870   // Only add ISO639-1 languages and some sign languages (ISO639-3)
 871   iso639
 872     .filter(l => {
 873       return (l.iso6391 !== undefined && l.type === 'living') ||
 874         additionalLanguages[l.iso6393] === true
 875     })
 876     .forEach(l => { languages[l.iso6391 || l.iso6393] = l.name })
 877
 878   // Override Occitan label
 879   languages['oc'] = 'Occitan'
 880   languages['el'] = 'Greek'
 881
 882   return languages
 883 }