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