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