server/initializers/constants.ts

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