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