server/initializers/constants.ts

   1 import { RepeatOptions } from 'bullmq'
   2 import { Encoding, randomBytes } from 'crypto'
   3 import { invert } from 'lodash'
   4 import { join } from 'path'
   5 import { randomInt, root } from '@shared/core-utils'
   6 import {
   7   AbuseState,
   8   JobType,
   9   RunnerJobState,
  10   UserRegistrationState,
  11   VideoChannelSyncState,
  12   VideoImportState,
  13   VideoPrivacy,
  14   VideoRateType,
  15   VideoResolution,
  16   VideoState,
  17   VideoTranscodingFPS
  18 } from '../../shared/models'
  19 import { ActivityPubActorType } from '../../shared/models/activitypub'
  20 import { ActorImageType, FollowState } from '../../shared/models/actors'
  21 import { NSFWPolicyType } from '../../shared/models/videos/nsfw-policy.type'
  22 import { VideoPlaylistPrivacy } from '../../shared/models/videos/playlist/video-playlist-privacy.model'
  23 import { VideoPlaylistType } from '../../shared/models/videos/playlist/video-playlist-type.model'
  24 // Do not use barrels, remain constants as independent as possible
  25 import { isTestInstance, isTestOrDevInstance, parseDurationToMs, sanitizeHost, sanitizeUrl } from '../helpers/core-utils'
  26 import { CONFIG, registerConfigChangedHandler } from './config'
  27
  28 // ---------------------------------------------------------------------------
  29
  30 const LAST_MIGRATION_VERSION = 770
  31
  32 // ---------------------------------------------------------------------------
  33
  34 const API_VERSION = 'v1'
  35 const PEERTUBE_VERSION: string = require(join(root(), 'package.json')).version
  36
  37 const PAGINATION = {
  38   GLOBAL: {
  39     COUNT: {
  40       DEFAULT: 15,
  41       MAX: 100
  42     }
  43   },
  44   OUTBOX: {
  45     COUNT: {
  46       MAX: 50
  47     }
  48   }
  49 }
  50
  51 const WEBSERVER = {
  52   URL: '',
  53   HOST: '',
  54   SCHEME: '',
  55   WS: '',
  56   HOSTNAME: '',
  57   PORT: 0,
  58
  59   RTMP_URL: '',
  60   RTMPS_URL: '',
  61
  62   RTMP_BASE_LIVE_URL: '',
  63   RTMPS_BASE_LIVE_URL: ''
  64 }
  65
  66 // Sortable columns per schema
  67 const SORTABLE_COLUMNS = {
  68   ADMIN_USERS: [ 'id', 'username', 'videoQuotaUsed', 'createdAt', 'lastLoginDate', 'role' ],
  69   USER_SUBSCRIPTIONS: [ 'id', 'createdAt' ],
  70   ACCOUNTS: [ 'createdAt' ],
  71   JOBS: [ 'createdAt' ],
  72   VIDEO_CHANNELS: [ 'id', 'name', 'updatedAt', 'createdAt' ],
  73   VIDEO_IMPORTS: [ 'createdAt' ],
  74   VIDEO_CHANNEL_SYNCS: [ 'externalChannelUrl', 'videoChannel', 'createdAt', 'lastSyncAt', 'state' ],
  75
  76   VIDEO_COMMENT_THREADS: [ 'createdAt', 'totalReplies' ],
  77   VIDEO_COMMENTS: [ 'createdAt' ],
  78
  79   VIDEO_RATES: [ 'createdAt' ],
  80   BLACKLISTS: [ 'id', 'name', 'duration', 'views', 'likes', 'dislikes', 'uuid', 'createdAt' ],
  81
  82   INSTANCE_FOLLOWERS: [ 'createdAt', 'state', 'score' ],
  83   INSTANCE_FOLLOWING: [ 'createdAt', 'redundancyAllowed', 'state' ],
  84   ACCOUNT_FOLLOWERS: [ 'createdAt' ],
  85   CHANNEL_FOLLOWERS: [ 'createdAt' ],
  86
  87   USER_REGISTRATIONS: [ 'createdAt', 'state' ],
  88
  89   RUNNERS: [ 'createdAt' ],
  90   RUNNER_REGISTRATION_TOKENS: [ 'createdAt' ],
  91   RUNNER_JOBS: [ 'updatedAt', 'createdAt', 'priority', 'state', 'progress' ],
  92
  93   VIDEOS: [ 'name', 'duration', 'createdAt', 'publishedAt', 'originallyPublishedAt', 'views', 'likes', 'trending', 'hot', 'best' ],
  94
  95   // Don't forget to update peertube-search-index with the same values
  96   VIDEOS_SEARCH: [ 'name', 'duration', 'createdAt', 'publishedAt', 'originallyPublishedAt', 'views', 'likes', 'match' ],
  97   VIDEO_CHANNELS_SEARCH: [ 'match', 'displayName', 'createdAt' ],
  98   VIDEO_PLAYLISTS_SEARCH: [ 'match', 'displayName', 'createdAt' ],
  99
 100   ABUSES: [ 'id', 'createdAt', 'state' ],
 101
 102   ACCOUNTS_BLOCKLIST: [ 'createdAt' ],
 103   SERVERS_BLOCKLIST: [ 'createdAt' ],
 104
 105   USER_NOTIFICATIONS: [ 'createdAt', 'read' ],
 106
 107   VIDEO_PLAYLISTS: [ 'name', 'displayName', 'createdAt', 'updatedAt' ],
 108
 109   PLUGINS: [ 'name', 'createdAt', 'updatedAt' ],
 110
 111   AVAILABLE_PLUGINS: [ 'npmName', 'popularity' ],
 112
 113   VIDEO_REDUNDANCIES: [ 'name' ]
 114 }
 115
 116 const ROUTE_CACHE_LIFETIME = {
 117   FEEDS: '15 minutes',
 118   ROBOTS: '2 hours',
 119   SITEMAP: '1 day',
 120   SECURITYTXT: '2 hours',
 121   NODEINFO: '10 minutes',
 122   DNT_POLICY: '1 week',
 123   ACTIVITY_PUB: {
 124     VIDEOS: '1 second' // 1 second, cache concurrent requests after a broadcast for example
 125   },
 126   STATS: '4 hours',
 127   WELL_KNOWN: '1 day'
 128 }
 129
 130 // ---------------------------------------------------------------------------
 131
 132 // Number of points we add/remove after a successful/bad request
 133 const ACTOR_FOLLOW_SCORE = {
 134   PENALTY: -10,
 135   BONUS: 10,
 136   BASE: 1000,
 137   MAX: 10000
 138 }
 139
 140 const FOLLOW_STATES: { [ id: string ]: FollowState } = {
 141   PENDING: 'pending',
 142   ACCEPTED: 'accepted',
 143   REJECTED: 'rejected'
 144 }
 145
 146 const REMOTE_SCHEME = {
 147   HTTP: 'https',
 148   WS: 'wss'
 149 }
 150
 151 // ---------------------------------------------------------------------------
 152
 153 const JOB_ATTEMPTS: { [id in JobType]: number } = {
 154   'activitypub-http-broadcast': 1,
 155   'activitypub-http-broadcast-parallel': 1,
 156   'activitypub-http-unicast': 1,
 157   'activitypub-http-fetcher': 2,
 158   'activitypub-follow': 5,
 159   'activitypub-cleaner': 1,
 160   'video-file-import': 1,
 161   'video-transcoding': 1,
 162   'video-import': 1,
 163   'email': 5,
 164   'actor-keys': 3,
 165   'videos-views-stats': 1,
 166   'activitypub-refresher': 1,
 167   'video-redundancy': 1,
 168   'video-live-ending': 1,
 169   'video-studio-edition': 1,
 170   'manage-video-torrent': 1,
 171   'video-channel-import': 1,
 172   'after-video-channel-import': 1,
 173   'move-to-object-storage': 3,
 174   'transcoding-job-builder': 1,
 175   'notify': 1,
 176   'federate-video': 1
 177 }
 178 // Excluded keys are jobs that can be configured by admins
 179 const JOB_CONCURRENCY: { [id in Exclude<JobType, 'video-transcoding' | 'video-import'>]: number } = {
 180   'activitypub-http-broadcast': 1,
 181   'activitypub-http-broadcast-parallel': 30,
 182   'activitypub-http-unicast': 30,
 183   'activitypub-http-fetcher': 3,
 184   'activitypub-cleaner': 1,
 185   'activitypub-follow': 1,
 186   'video-file-import': 1,
 187   'email': 5,
 188   'actor-keys': 1,
 189   'videos-views-stats': 1,
 190   'activitypub-refresher': 1,
 191   'video-redundancy': 1,
 192   'video-live-ending': 10,
 193   'video-studio-edition': 1,
 194   'manage-video-torrent': 1,
 195   'move-to-object-storage': 1,
 196   'video-channel-import': 1,
 197   'after-video-channel-import': 1,
 198   'transcoding-job-builder': 1,
 199   'notify': 5,
 200   'federate-video': 3
 201 }
 202 const JOB_TTL: { [id in JobType]: number } = {
 203   'activitypub-http-broadcast': 60000 * 10, // 10 minutes
 204   'activitypub-http-broadcast-parallel': 60000 * 10, // 10 minutes
 205   'activitypub-http-unicast': 60000 * 10, // 10 minutes
 206   'activitypub-http-fetcher': 1000 * 3600 * 10, // 10 hours
 207   'activitypub-follow': 60000 * 10, // 10 minutes
 208   'activitypub-cleaner': 1000 * 3600, // 1 hour
 209   'video-file-import': 1000 * 3600, // 1 hour
 210   'video-transcoding': 1000 * 3600 * 48, // 2 days, transcoding could be long
 211   'video-studio-edition': 1000 * 3600 * 10, // 10 hours
 212   'video-import': CONFIG.IMPORT.VIDEOS.TIMEOUT,
 213   'email': 60000 * 10, // 10 minutes
 214   'actor-keys': 60000 * 20, // 20 minutes
 215   'videos-views-stats': undefined, // Unlimited
 216   'activitypub-refresher': 60000 * 10, // 10 minutes
 217   'video-redundancy': 1000 * 3600 * 3, // 3 hours
 218   'video-live-ending': 1000 * 60 * 10, // 10 minutes
 219   'manage-video-torrent': 1000 * 3600 * 3, // 3 hours
 220   'move-to-object-storage': 1000 * 60 * 60 * 3, // 3 hours
 221   'video-channel-import': 1000 * 60 * 60 * 4, // 4 hours
 222   'after-video-channel-import': 60000 * 5, // 5 minutes
 223   'transcoding-job-builder': 60000, // 1 minute
 224   'notify': 60000 * 5, // 5 minutes
 225   'federate-video': 60000 * 5 // 5 minutes
 226 }
 227 const REPEAT_JOBS: { [ id in JobType ]?: RepeatOptions } = {
 228   'videos-views-stats': {
 229     pattern: randomInt(1, 20) + ' * * * *' // Between 1-20 minutes past the hour
 230   },
 231   'activitypub-cleaner': {
 232     pattern: '30 5 * * ' + randomInt(0, 7) // 1 time per week (random day) at 5:30 AM
 233   }
 234 }
 235 const JOB_PRIORITY = {
 236   TRANSCODING: 100,
 237   VIDEO_STUDIO: 150
 238 }
 239
 240 const JOB_REMOVAL_OPTIONS = {
 241   COUNT: 10000, // Max jobs to store
 242
 243   SUCCESS: { // Success jobs
 244     'DEFAULT': parseDurationToMs('2 days'),
 245
 246     'activitypub-http-broadcast-parallel': parseDurationToMs('10 minutes'),
 247     'activitypub-http-unicast': parseDurationToMs('1 hour'),
 248     'videos-views-stats': parseDurationToMs('3 hours'),
 249     'activitypub-refresher': parseDurationToMs('10 hours')
 250   },
 251
 252   FAILURE: { // Failed job
 253     DEFAULT: parseDurationToMs('7 days')
 254   }
 255 }
 256
 257 const VIDEO_IMPORT_TIMEOUT = Math.floor(JOB_TTL['video-import'] * 0.9)
 258
 259 const RUNNER_JOBS = {
 260   MAX_FAILURES: 5,
 261   LAST_CONTACT_UPDATE_INTERVAL: 30000
 262 }
 263
 264 // ---------------------------------------------------------------------------
 265
 266 const BROADCAST_CONCURRENCY = 30 // How many requests in parallel we do in activitypub-http-broadcast job
 267 const CRAWL_REQUEST_CONCURRENCY = 1 // How many requests in parallel to fetch remote data (likes, shares...)
 268
 269 const AP_CLEANER = {
 270   CONCURRENCY: 10, // How many requests in parallel we do in activitypub-cleaner job
 271   UNAVAILABLE_TRESHOLD: 3, // How many attempts we do before removing an unavailable remote resource
 272   PERIOD: parseDurationToMs('1 week') // /!\ Has to be sync with REPEAT_JOBS
 273 }
 274
 275 const REQUEST_TIMEOUTS = {
 276   DEFAULT: 7000, // 7 seconds
 277   FILE: 30000, // 30 seconds
 278   REDUNDANCY: JOB_TTL['video-redundancy']
 279 }
 280
 281 const SCHEDULER_INTERVALS_MS = {
 282   RUNNER_JOB_WATCH_DOG: Math.min(CONFIG.REMOTE_RUNNERS.STALLED_JOBS.VOD, CONFIG.REMOTE_RUNNERS.STALLED_JOBS.LIVE),
 283   ACTOR_FOLLOW_SCORES: 60000 * 60, // 1 hour
 284   REMOVE_OLD_JOBS: 60000 * 60, // 1 hour
 285   UPDATE_VIDEOS: 60000, // 1 minute
 286   YOUTUBE_DL_UPDATE: 60000 * 60 * 24, // 1 day
 287   GEO_IP_UPDATE: 60000 * 60 * 24, // 1 day
 288   VIDEO_VIEWS_BUFFER_UPDATE: CONFIG.VIEWS.VIDEOS.LOCAL_BUFFER_UPDATE_INTERVAL,
 289   CHECK_PLUGINS: CONFIG.PLUGINS.INDEX.CHECK_LATEST_VERSIONS_INTERVAL,
 290   CHECK_PEERTUBE_VERSION: 60000 * 60 * 24, // 1 day
 291   AUTO_FOLLOW_INDEX_INSTANCES: 60000 * 60 * 24, // 1 day
 292   REMOVE_OLD_VIEWS: 60000 * 60 * 24, // 1 day
 293   REMOVE_OLD_HISTORY: 60000 * 60 * 24, // 1 day
 294   UPDATE_INBOX_STATS: 1000 * 60, // 1 minute
 295   REMOVE_DANGLING_RESUMABLE_UPLOADS: 60000 * 60, // 1 hour
 296   CHANNEL_SYNC_CHECK_INTERVAL: CONFIG.IMPORT.VIDEO_CHANNEL_SYNCHRONIZATION.CHECK_INTERVAL
 297 }
 298
 299 // ---------------------------------------------------------------------------
 300
 301 const CONSTRAINTS_FIELDS = {
 302   USERS: {
 303     NAME: { min: 1, max: 120 }, // Length
 304     DESCRIPTION: { min: 3, max: 1000 }, // Length
 305     USERNAME: { min: 1, max: 50 }, // Length
 306     PASSWORD: { min: 6, max: 255 }, // Length
 307     VIDEO_QUOTA: { min: -1 },
 308     VIDEO_QUOTA_DAILY: { min: -1 },
 309     VIDEO_LANGUAGES: { max: 500 }, // Array length
 310     BLOCKED_REASON: { min: 3, max: 250 } // Length
 311   },
 312   ABUSES: {
 313     REASON: { min: 2, max: 3000 }, // Length
 314     MODERATION_COMMENT: { min: 2, max: 3000 } // Length
 315   },
 316   ABUSE_MESSAGES: {
 317     MESSAGE: { min: 2, max: 3000 } // Length
 318   },
 319   USER_REGISTRATIONS: {
 320     REASON_MESSAGE: { min: 2, max: 3000 }, // Length
 321     MODERATOR_MESSAGE: { min: 2, max: 3000 } // Length
 322   },
 323   VIDEO_BLACKLIST: {
 324     REASON: { min: 2, max: 300 } // Length
 325   },
 326   VIDEO_CHANNELS: {
 327     NAME: { min: 1, max: 120 }, // Length
 328     DESCRIPTION: { min: 3, max: 1000 }, // Length
 329     SUPPORT: { min: 3, max: 1000 }, // Length
 330     EXTERNAL_CHANNEL_URL: { min: 3, max: 2000 }, // Length
 331     URL: { min: 3, max: 2000 } // Length
 332   },
 333   VIDEO_CHANNEL_SYNCS: {
 334     EXTERNAL_CHANNEL_URL: { min: 3, max: 2000 } // Length
 335   },
 336   VIDEO_CAPTIONS: {
 337     CAPTION_FILE: {
 338       EXTNAME: [ '.vtt', '.srt' ],
 339       FILE_SIZE: {
 340         max: 20 * 1024 * 1024 // 20MB
 341       }
 342     }
 343   },
 344   VIDEO_IMPORTS: {
 345     URL: { min: 3, max: 2000 }, // Length
 346     TORRENT_NAME: { min: 3, max: 255 }, // Length
 347     TORRENT_FILE: {
 348       EXTNAME: [ '.torrent' ],
 349       FILE_SIZE: {
 350         max: 1024 * 200 // 200 KB
 351       }
 352     }
 353   },
 354   VIDEOS_REDUNDANCY: {
 355     URL: { min: 3, max: 2000 } // Length
 356   },
 357   VIDEO_RATES: {
 358     URL: { min: 3, max: 2000 } // Length
 359   },
 360   VIDEOS: {
 361     NAME: { min: 3, max: 120 }, // Length
 362     LANGUAGE: { min: 1, max: 10 }, // Length
 363     TRUNCATED_DESCRIPTION: { min: 3, max: 250 }, // Length
 364     DESCRIPTION: { min: 3, max: 10000 }, // Length
 365     SUPPORT: { min: 3, max: 1000 }, // Length
 366     IMAGE: {
 367       EXTNAME: [ '.png', '.jpg', '.jpeg', '.webp' ],
 368       FILE_SIZE: {
 369         max: 4 * 1024 * 1024 // 4MB
 370       }
 371     },
 372     EXTNAME: [] as string[],
 373     INFO_HASH: { min: 40, max: 40 }, // Length, info hash is 20 bytes length but we represent it in hexadecimal so 20 * 2
 374     DURATION: { min: 0 }, // Number
 375     TAGS: { min: 0, max: 5 }, // Number of total tags
 376     TAG: { min: 2, max: 30 }, // Length
 377     VIEWS: { min: 0 },
 378     LIKES: { min: 0 },
 379     DISLIKES: { min: 0 },
 380     FILE_SIZE: { min: -1 },
 381     PARTIAL_UPLOAD_SIZE: { max: 50 * 1024 * 1024 * 1024 }, // 50GB
 382     URL: { min: 3, max: 2000 } // Length
 383   },
 384   VIDEO_PLAYLISTS: {
 385     NAME: { min: 1, max: 120 }, // Length
 386     DESCRIPTION: { min: 3, max: 1000 }, // Length
 387     URL: { min: 3, max: 2000 }, // Length
 388     IMAGE: {
 389       EXTNAME: [ '.jpg', '.jpeg' ],
 390       FILE_SIZE: {
 391         max: 4 * 1024 * 1024 // 4MB
 392       }
 393     }
 394   },
 395   ACTORS: {
 396     PUBLIC_KEY: { min: 10, max: 5000 }, // Length
 397     PRIVATE_KEY: { min: 10, max: 5000 }, // Length
 398     URL: { min: 3, max: 2000 }, // Length
 399     IMAGE: {
 400       EXTNAME: [ '.png', '.jpeg', '.jpg', '.gif', '.webp' ],
 401       FILE_SIZE: {
 402         max: 4 * 1024 * 1024 // 4MB
 403       }
 404     }
 405   },
 406   VIDEO_EVENTS: {
 407     COUNT: { min: 0 }
 408   },
 409   VIDEO_COMMENTS: {
 410     TEXT: { min: 1, max: 10000 }, // Length
 411     URL: { min: 3, max: 2000 } // Length
 412   },
 413   VIDEO_SHARE: {
 414     URL: { min: 3, max: 2000 } // Length
 415   },
 416   CONTACT_FORM: {
 417     FROM_NAME: { min: 1, max: 120 }, // Length
 418     BODY: { min: 3, max: 5000 } // Length
 419   },
 420   PLUGINS: {
 421     NAME: { min: 1, max: 214 }, // Length
 422     DESCRIPTION: { min: 1, max: 20000 } // Length
 423   },
 424   COMMONS: {
 425     URL: { min: 5, max: 2000 } // Length
 426   },
 427   VIDEO_STUDIO: {
 428     TASKS: { min: 1, max: 10 }, // Number of tasks
 429     CUT_TIME: { min: 0 } // Value
 430   },
 431   LOGS: {
 432     CLIENT_MESSAGE: { min: 1, max: 1000 }, // Length
 433     CLIENT_STACK_TRACE: { min: 1, max: 15000 }, // Length
 434     CLIENT_META: { min: 1, max: 5000 }, // Length
 435     CLIENT_USER_AGENT: { min: 1, max: 200 } // Length
 436   },
 437   RUNNERS: {
 438     TOKEN: { min: 1, max: 1000 }, // Length
 439     NAME: { min: 1, max: 100 }, // Length
 440     DESCRIPTION: { min: 1, max: 1000 } // Length
 441   },
 442   RUNNER_JOBS: {
 443     TOKEN: { min: 1, max: 1000 }, // Length
 444     REASON: { min: 1, max: 5000 }, // Length
 445     ERROR_MESSAGE: { min: 1, max: 5000 }, // Length
 446     PROGRESS: { min: 0, max: 100 } // Value
 447   }
 448 }
 449
 450 const VIEW_LIFETIME = {
 451   VIEW: CONFIG.VIEWS.VIDEOS.IP_VIEW_EXPIRATION,
 452   VIEWER_COUNTER: 60000 * 2, // 2 minutes
 453   VIEWER_STATS: 60000 * 60 // 1 hour
 454 }
 455
 456 const MAX_LOCAL_VIEWER_WATCH_SECTIONS = 100
 457
 458 let CONTACT_FORM_LIFETIME = 60000 * 60 // 1 hour
 459
 460 const VIDEO_TRANSCODING_FPS: VideoTranscodingFPS = {
 461   MIN: 1,
 462   STANDARD: [ 24, 25, 30 ],
 463   HD_STANDARD: [ 50, 60 ],
 464   AUDIO_MERGE: 25,
 465   AVERAGE: 30,
 466   MAX: 60,
 467   KEEP_ORIGIN_FPS_RESOLUTION_MIN: 720 // We keep the original FPS on high resolutions (720 minimum)
 468 }
 469
 470 const DEFAULT_AUDIO_RESOLUTION = VideoResolution.H_480P
 471
 472 const VIDEO_RATE_TYPES: { [ id: string ]: VideoRateType } = {
 473   LIKE: 'like',
 474   DISLIKE: 'dislike'
 475 }
 476
 477 const FFMPEG_NICE = {
 478   // parent process defaults to niceness = 0
 479   // reminder: lower = higher priority, max value is 19, lowest is -20
 480   LIVE: 5, // prioritize over VOD and THUMBNAIL
 481   THUMBNAIL: 10,
 482   VOD: 15
 483 }
 484
 485 const VIDEO_CATEGORIES = {
 486   1: 'Music',
 487   2: 'Films',
 488   3: 'Vehicles',
 489   4: 'Art',
 490   5: 'Sports',
 491   6: 'Travels',
 492   7: 'Gaming',
 493   8: 'People',
 494   9: 'Comedy',
 495   10: 'Entertainment',
 496   11: 'News & Politics',
 497   12: 'How To',
 498   13: 'Education',
 499   14: 'Activism',
 500   15: 'Science & Technology',
 501   16: 'Animals',
 502   17: 'Kids',
 503   18: 'Food'
 504 }
 505
 506 // See https://creativecommons.org/licenses/?lang=en
 507 const VIDEO_LICENCES = {
 508   1: 'Attribution',
 509   2: 'Attribution - Share Alike',
 510   3: 'Attribution - No Derivatives',
 511   4: 'Attribution - Non Commercial',
 512   5: 'Attribution - Non Commercial - Share Alike',
 513   6: 'Attribution - Non Commercial - No Derivatives',
 514   7: 'Public Domain Dedication'
 515 }
 516
 517 const VIDEO_LANGUAGES: { [id: string]: string } = {}
 518
 519 const VIDEO_PRIVACIES: { [ id in VideoPrivacy ]: string } = {
 520   [VideoPrivacy.PUBLIC]: 'Public',
 521   [VideoPrivacy.UNLISTED]: 'Unlisted',
 522   [VideoPrivacy.PRIVATE]: 'Private',
 523   [VideoPrivacy.INTERNAL]: 'Internal'
 524 }
 525
 526 const VIDEO_STATES: { [ id in VideoState ]: string } = {
 527   [VideoState.PUBLISHED]: 'Published',
 528   [VideoState.TO_TRANSCODE]: 'To transcode',
 529   [VideoState.TO_IMPORT]: 'To import',
 530   [VideoState.WAITING_FOR_LIVE]: 'Waiting for livestream',
 531   [VideoState.LIVE_ENDED]: 'Livestream ended',
 532   [VideoState.TO_MOVE_TO_EXTERNAL_STORAGE]: 'To move to an external storage',
 533   [VideoState.TRANSCODING_FAILED]: 'Transcoding failed',
 534   [VideoState.TO_MOVE_TO_EXTERNAL_STORAGE_FAILED]: 'External storage move failed',
 535   [VideoState.TO_EDIT]: 'To edit*'
 536 }
 537
 538 const VIDEO_IMPORT_STATES: { [ id in VideoImportState ]: string } = {
 539   [VideoImportState.FAILED]: 'Failed',
 540   [VideoImportState.PENDING]: 'Pending',
 541   [VideoImportState.SUCCESS]: 'Success',
 542   [VideoImportState.REJECTED]: 'Rejected',
 543   [VideoImportState.CANCELLED]: 'Cancelled',
 544   [VideoImportState.PROCESSING]: 'Processing'
 545 }
 546
 547 const VIDEO_CHANNEL_SYNC_STATE: { [ id in VideoChannelSyncState ]: string } = {
 548   [VideoChannelSyncState.FAILED]: 'Failed',
 549   [VideoChannelSyncState.SYNCED]: 'Synchronized',
 550   [VideoChannelSyncState.PROCESSING]: 'Processing',
 551   [VideoChannelSyncState.WAITING_FIRST_RUN]: 'Waiting first run'
 552 }
 553
 554 const ABUSE_STATES: { [ id in AbuseState ]: string } = {
 555   [AbuseState.PENDING]: 'Pending',
 556   [AbuseState.REJECTED]: 'Rejected',
 557   [AbuseState.ACCEPTED]: 'Accepted'
 558 }
 559
 560 const USER_REGISTRATION_STATES: { [ id in UserRegistrationState ]: string } = {
 561   [UserRegistrationState.PENDING]: 'Pending',
 562   [UserRegistrationState.REJECTED]: 'Rejected',
 563   [UserRegistrationState.ACCEPTED]: 'Accepted'
 564 }
 565
 566 const VIDEO_PLAYLIST_PRIVACIES: { [ id in VideoPlaylistPrivacy ]: string } = {
 567   [VideoPlaylistPrivacy.PUBLIC]: 'Public',
 568   [VideoPlaylistPrivacy.UNLISTED]: 'Unlisted',
 569   [VideoPlaylistPrivacy.PRIVATE]: 'Private'
 570 }
 571
 572 const VIDEO_PLAYLIST_TYPES: { [ id in VideoPlaylistType ]: string } = {
 573   [VideoPlaylistType.REGULAR]: 'Regular',
 574   [VideoPlaylistType.WATCH_LATER]: 'Watch later'
 575 }
 576
 577 const RUNNER_JOB_STATES: { [ id in RunnerJobState ]: string } = {
 578   [RunnerJobState.PROCESSING]: 'Processing',
 579   [RunnerJobState.COMPLETED]: 'Completed',
 580   [RunnerJobState.PENDING]: 'Pending',
 581   [RunnerJobState.ERRORED]: 'Errored',
 582   [RunnerJobState.WAITING_FOR_PARENT_JOB]: 'Waiting for parent job to finish',
 583   [RunnerJobState.CANCELLED]: 'Cancelled',
 584   [RunnerJobState.PARENT_ERRORED]: 'Parent job failed',
 585   [RunnerJobState.PARENT_CANCELLED]: 'Parent job cancelled'
 586 }
 587
 588 const MIMETYPES = {
 589   AUDIO: {
 590     MIMETYPE_EXT: {
 591       'audio/mpeg': '.mp3',
 592       'audio/mp3': '.mp3',
 593
 594       'application/ogg': '.ogg',
 595       'audio/ogg': '.ogg',
 596
 597       'audio/x-ms-wma': '.wma',
 598       'audio/wav': '.wav',
 599       'audio/x-wav': '.wav',
 600
 601       'audio/x-flac': '.flac',
 602       'audio/flac': '.flac',
 603
 604       'audio/vnd.dlna.adts': '.aac',
 605       'audio/aac': '.aac',
 606
 607       'audio/m4a': '.m4a',
 608       'audio/mp4': '.m4a',
 609       'audio/x-m4a': '.m4a',
 610
 611       'audio/vnd.dolby.dd-raw': '.ac3',
 612       'audio/ac3': '.ac3'
 613     },
 614     EXT_MIMETYPE: null as { [ id: string ]: string }
 615   },
 616   VIDEO: {
 617     MIMETYPE_EXT: null as { [ id: string ]: string | string[] },
 618     MIMETYPES_REGEX: null as string,
 619     EXT_MIMETYPE: null as { [ id: string ]: string }
 620   },
 621   IMAGE: {
 622     MIMETYPE_EXT: {
 623       'image/png': '.png',
 624       'image/gif': '.gif',
 625       'image/webp': '.webp',
 626       'image/jpg': '.jpg',
 627       'image/jpeg': '.jpg'
 628     },
 629     EXT_MIMETYPE: null as { [ id: string ]: string }
 630   },
 631   VIDEO_CAPTIONS: {
 632     MIMETYPE_EXT: {
 633       'text/vtt': '.vtt',
 634       'application/x-subrip': '.srt',
 635       'text/plain': '.srt'
 636     }
 637   },
 638   TORRENT: {
 639     MIMETYPE_EXT: {
 640       'application/x-bittorrent': '.torrent'
 641     }
 642   },
 643   M3U8: {
 644     MIMETYPE_EXT: {
 645       'application/vnd.apple.mpegurl': '.m3u8'
 646     }
 647   }
 648 }
 649 MIMETYPES.AUDIO.EXT_MIMETYPE = invert(MIMETYPES.AUDIO.MIMETYPE_EXT)
 650 MIMETYPES.IMAGE.EXT_MIMETYPE = invert(MIMETYPES.IMAGE.MIMETYPE_EXT)
 651
 652 const BINARY_CONTENT_TYPES = new Set([
 653   'binary/octet-stream',
 654   'application/octet-stream',
 655   'application/x-binary'
 656 ])
 657
 658 // ---------------------------------------------------------------------------
 659
 660 const OVERVIEWS = {
 661   VIDEOS: {
 662     SAMPLE_THRESHOLD: 6,
 663     SAMPLES_COUNT: 20
 664   }
 665 }
 666
 667 // ---------------------------------------------------------------------------
 668
 669 const SERVER_ACTOR_NAME = 'peertube'
 670
 671 const ACTIVITY_PUB = {
 672   POTENTIAL_ACCEPT_HEADERS: [
 673     'application/activity+json',
 674     'application/ld+json',
 675     'application/ld+json; profile="https://www.w3.org/ns/activitystreams"'
 676   ],
 677   ACCEPT_HEADER: 'application/activity+json, application/ld+json',
 678   PUBLIC: 'https://www.w3.org/ns/activitystreams#Public',
 679   COLLECTION_ITEMS_PER_PAGE: 10,
 680   FETCH_PAGE_LIMIT: 2000,
 681   URL_MIME_TYPES: {
 682     VIDEO: [] as string[],
 683     TORRENT: [ 'application/x-bittorrent' ],
 684     MAGNET: [ 'application/x-bittorrent;x-scheme-handler/magnet' ]
 685   },
 686   MAX_RECURSION_COMMENTS: 100,
 687   ACTOR_REFRESH_INTERVAL: 3600 * 24 * 1000 * 2, // 2 days
 688   VIDEO_REFRESH_INTERVAL: 3600 * 24 * 1000 * 2, // 2 days
 689   VIDEO_PLAYLIST_REFRESH_INTERVAL: 3600 * 24 * 1000 * 2 // 2 days
 690 }
 691
 692 const ACTIVITY_PUB_ACTOR_TYPES: { [ id: string ]: ActivityPubActorType } = {
 693   GROUP: 'Group',
 694   PERSON: 'Person',
 695   APPLICATION: 'Application',
 696   ORGANIZATION: 'Organization',
 697   SERVICE: 'Service'
 698 }
 699
 700 const HTTP_SIGNATURE = {
 701   HEADER_NAME: 'signature',
 702   ALGORITHM: 'rsa-sha256',
 703   HEADERS_TO_SIGN: [ '(request-target)', 'host', 'date', 'digest' ],
 704   CLOCK_SKEW_SECONDS: 1800
 705 }
 706
 707 // ---------------------------------------------------------------------------
 708
 709 let PRIVATE_RSA_KEY_SIZE = 2048
 710
 711 // Password encryption
 712 const BCRYPT_SALT_SIZE = 10
 713
 714 const ENCRYPTION = {
 715   ALGORITHM: 'aes-256-cbc',
 716   IV: 16,
 717   SALT: 'peertube',
 718   ENCODING: 'hex' as Encoding
 719 }
 720
 721 const USER_PASSWORD_RESET_LIFETIME = 60000 * 60 // 60 minutes
 722 const USER_PASSWORD_CREATE_LIFETIME = 60000 * 60 * 24 * 7 // 7 days
 723
 724 const TWO_FACTOR_AUTH_REQUEST_TOKEN_LIFETIME = 60000 * 10 // 10 minutes
 725
 726 const EMAIL_VERIFY_LIFETIME = 60000 * 60 // 60 minutes
 727
 728 const NSFW_POLICY_TYPES: { [ id: string ]: NSFWPolicyType } = {
 729   DO_NOT_LIST: 'do_not_list',
 730   BLUR: 'blur',
 731   DISPLAY: 'display'
 732 }
 733
 734 // ---------------------------------------------------------------------------
 735
 736 // Express static paths (router)
 737 const STATIC_PATHS = {
 738   THUMBNAILS: '/static/thumbnails/',
 739
 740   WEBSEED: '/static/webseed/',
 741   PRIVATE_WEBSEED: '/static/webseed/private/',
 742
 743   REDUNDANCY: '/static/redundancy/',
 744
 745   STREAMING_PLAYLISTS: {
 746     HLS: '/static/streaming-playlists/hls',
 747     PRIVATE_HLS: '/static/streaming-playlists/hls/private/'
 748   }
 749 }
 750 const STATIC_DOWNLOAD_PATHS = {
 751   TORRENTS: '/download/torrents/',
 752   VIDEOS: '/download/videos/',
 753   HLS_VIDEOS: '/download/streaming-playlists/hls/videos/'
 754 }
 755 const LAZY_STATIC_PATHS = {
 756   BANNERS: '/lazy-static/banners/',
 757   AVATARS: '/lazy-static/avatars/',
 758   PREVIEWS: '/lazy-static/previews/',
 759   VIDEO_CAPTIONS: '/lazy-static/video-captions/',
 760   TORRENTS: '/lazy-static/torrents/'
 761 }
 762 const OBJECT_STORAGE_PROXY_PATHS = {
 763   PRIVATE_WEBSEED: '/object-storage-proxy/webseed/private/',
 764
 765   STREAMING_PLAYLISTS: {
 766     PRIVATE_HLS: '/object-storage-proxy/streaming-playlists/hls/private/'
 767   }
 768 }
 769
 770 // Cache control
 771 const STATIC_MAX_AGE = {
 772   SERVER: '2h',
 773   LAZY_SERVER: '2d',
 774   CLIENT: '30d'
 775 }
 776
 777 // Videos thumbnail size
 778 const THUMBNAILS_SIZE = {
 779   width: 280,
 780   height: 157,
 781   minWidth: 150
 782 }
 783 const PREVIEWS_SIZE = {
 784   width: 850,
 785   height: 480,
 786   minWidth: 400
 787 }
 788 const ACTOR_IMAGES_SIZE: { [key in ActorImageType]: { width: number, height: number }[] } = {
 789   [ActorImageType.AVATAR]: [
 790     {
 791       width: 120,
 792       height: 120
 793     },
 794     {
 795       width: 48,
 796       height: 48
 797     }
 798   ],
 799   [ActorImageType.BANNER]: [
 800     {
 801       width: 1920,
 802       height: 317 // 6/1 ratio
 803     }
 804   ]
 805 }
 806
 807 const EMBED_SIZE = {
 808   width: 560,
 809   height: 315
 810 }
 811
 812 // Sub folders of cache directory
 813 const FILES_CACHE = {
 814   PREVIEWS: {
 815     DIRECTORY: join(CONFIG.STORAGE.CACHE_DIR, 'previews'),
 816     MAX_AGE: 1000 * 3600 * 3 // 3 hours
 817   },
 818   VIDEO_CAPTIONS: {
 819     DIRECTORY: join(CONFIG.STORAGE.CACHE_DIR, 'video-captions'),
 820     MAX_AGE: 1000 * 3600 * 3 // 3 hours
 821   },
 822   TORRENTS: {
 823     DIRECTORY: join(CONFIG.STORAGE.CACHE_DIR, 'torrents'),
 824     MAX_AGE: 1000 * 3600 * 3 // 3 hours
 825   }
 826 }
 827
 828 const LRU_CACHE = {
 829   USER_TOKENS: {
 830     MAX_SIZE: 1000
 831   },
 832   ACTOR_IMAGE_STATIC: {
 833     MAX_SIZE: 500
 834   },
 835   STATIC_VIDEO_FILES_RIGHTS_CHECK: {
 836     MAX_SIZE: 5000,
 837     TTL: parseDurationToMs('10 seconds')
 838   },
 839   VIDEO_TOKENS: {
 840     MAX_SIZE: 100_000,
 841     TTL: parseDurationToMs('8 hours')
 842   },
 843   TRACKER_IPS: {
 844     MAX_SIZE: 100_000
 845   }
 846 }
 847
 848 const DIRECTORIES = {
 849   RESUMABLE_UPLOAD: join(CONFIG.STORAGE.TMP_DIR, 'resumable-uploads'),
 850
 851   HLS_STREAMING_PLAYLIST: {
 852     PUBLIC: join(CONFIG.STORAGE.STREAMING_PLAYLISTS_DIR, 'hls'),
 853     PRIVATE: join(CONFIG.STORAGE.STREAMING_PLAYLISTS_DIR, 'hls', 'private')
 854   },
 855
 856   VIDEOS: {
 857     PUBLIC: CONFIG.STORAGE.VIDEOS_DIR,
 858     PRIVATE: join(CONFIG.STORAGE.VIDEOS_DIR, 'private')
 859   },
 860
 861   HLS_REDUNDANCY: join(CONFIG.STORAGE.REDUNDANCY_DIR, 'hls')
 862 }
 863
 864 const RESUMABLE_UPLOAD_SESSION_LIFETIME = SCHEDULER_INTERVALS_MS.REMOVE_DANGLING_RESUMABLE_UPLOADS
 865
 866 const VIDEO_LIVE = {
 867   EXTENSION: '.ts',
 868   CLEANUP_DELAY: 1000 * 60 * 5, // 5 minutes
 869   SEGMENT_TIME_SECONDS: {
 870     DEFAULT_LATENCY: 4, // 4 seconds
 871     SMALL_LATENCY: 2 // 2 seconds
 872   },
 873   SEGMENTS_LIST_SIZE: 15, // 15 maximum segments in live playlist
 874   REPLAY_DIRECTORY: 'replay',
 875   EDGE_LIVE_DELAY_SEGMENTS_NOTIFICATION: 4,
 876   MAX_SOCKET_WAITING_DATA: 1024 * 1000 * 100, // 100MB
 877   RTMP: {
 878     CHUNK_SIZE: 60000,
 879     GOP_CACHE: true,
 880     PING: 60,
 881     PING_TIMEOUT: 30,
 882     BASE_PATH: 'live'
 883   }
 884 }
 885
 886 const MEMOIZE_TTL = {
 887   OVERVIEWS_SAMPLE: 1000 * 3600 * 4, // 4 hours
 888   INFO_HASH_EXISTS: 1000 * 60, // 1 minute
 889   VIDEO_DURATION: 1000 * 10, // 10 seconds
 890   LIVE_ABLE_TO_UPLOAD: 1000 * 60, // 1 minute
 891   LIVE_CHECK_SOCKET_HEALTH: 1000 * 60, // 1 minute
 892   GET_STATS_FOR_OPEN_TELEMETRY_METRICS: 1000 * 60 // 1 minute
 893 }
 894
 895 const MEMOIZE_LENGTH = {
 896   INFO_HASH_EXISTS: 200,
 897   VIDEO_DURATION: 200
 898 }
 899
 900 const WORKER_THREADS = {
 901   DOWNLOAD_IMAGE: {
 902     CONCURRENCY: 3,
 903     MAX_THREADS: 1
 904   },
 905   PROCESS_IMAGE: {
 906     CONCURRENCY: 1,
 907     MAX_THREADS: 5
 908   }
 909 }
 910
 911 const REDUNDANCY = {
 912   VIDEOS: {
 913     RANDOMIZED_FACTOR: 5
 914   }
 915 }
 916
 917 const ACCEPT_HEADERS = [ 'html', 'application/json' ].concat(ACTIVITY_PUB.POTENTIAL_ACCEPT_HEADERS)
 918 const OTP = {
 919   HEADER_NAME: 'x-peertube-otp',
 920   HEADER_REQUIRED_VALUE: 'required; app'
 921 }
 922
 923 const ASSETS_PATH = {
 924   DEFAULT_AUDIO_BACKGROUND: join(root(), 'dist', 'server', 'assets', 'default-audio-background.jpg'),
 925   DEFAULT_LIVE_BACKGROUND: join(root(), 'dist', 'server', 'assets', 'default-live-background.jpg')
 926 }
 927
 928 // ---------------------------------------------------------------------------
 929
 930 const CUSTOM_HTML_TAG_COMMENTS = {
 931   TITLE: '<!-- title tag -->',
 932   DESCRIPTION: '<!-- description tag -->',
 933   CUSTOM_CSS: '<!-- custom css tag -->',
 934   META_TAGS: '<!-- meta tags -->',
 935   SERVER_CONFIG: '<!-- server config -->'
 936 }
 937
 938 const MAX_LOGS_OUTPUT_CHARACTERS = 10 * 1000 * 1000
 939 const LOG_FILENAME = 'peertube.log'
 940 const AUDIT_LOG_FILENAME = 'peertube-audit.log'
 941
 942 // ---------------------------------------------------------------------------
 943
 944 const TRACKER_RATE_LIMITS = {
 945   INTERVAL: 60000 * 5, // 5 minutes
 946   ANNOUNCES_PER_IP_PER_INFOHASH: 15, // maximum announces per torrent in the interval
 947   ANNOUNCES_PER_IP: 30, // maximum announces for all our torrents in the interval
 948   BLOCK_IP_LIFETIME: parseDurationToMs('3 minutes')
 949 }
 950
 951 const P2P_MEDIA_LOADER_PEER_VERSION = 2
 952
 953 // ---------------------------------------------------------------------------
 954
 955 const PLUGIN_GLOBAL_CSS_FILE_NAME = 'plugins-global.css'
 956 const PLUGIN_GLOBAL_CSS_PATH = join(CONFIG.STORAGE.TMP_DIR, PLUGIN_GLOBAL_CSS_FILE_NAME)
 957
 958 let PLUGIN_EXTERNAL_AUTH_TOKEN_LIFETIME = 1000 * 60 * 5 // 5 minutes
 959
 960 const DEFAULT_THEME_NAME = 'default'
 961 const DEFAULT_USER_THEME_NAME = 'instance-default'
 962
 963 // ---------------------------------------------------------------------------
 964
 965 const SEARCH_INDEX = {
 966   ROUTES: {
 967     VIDEOS: '/api/v1/search/videos',
 968     VIDEO_CHANNELS: '/api/v1/search/video-channels'
 969   }
 970 }
 971
 972 // ---------------------------------------------------------------------------
 973
 974 const STATS_TIMESERIE = {
 975   MAX_DAYS: 365 * 10 // Around 10 years
 976 }
 977
 978 // ---------------------------------------------------------------------------
 979
 980 // Special constants for a test instance
 981 if (process.env.PRODUCTION_CONSTANTS !== 'true') {
 982   if (isTestOrDevInstance()) {
 983     PRIVATE_RSA_KEY_SIZE = 1024
 984
 985     ACTOR_FOLLOW_SCORE.BASE = 20
 986
 987     REMOTE_SCHEME.HTTP = 'http'
 988     REMOTE_SCHEME.WS = 'ws'
 989
 990     STATIC_MAX_AGE.SERVER = '0'
 991
 992     SCHEDULER_INTERVALS_MS.ACTOR_FOLLOW_SCORES = 1000
 993     SCHEDULER_INTERVALS_MS.REMOVE_OLD_JOBS = 10000
 994     SCHEDULER_INTERVALS_MS.REMOVE_OLD_HISTORY = 5000
 995     SCHEDULER_INTERVALS_MS.REMOVE_OLD_VIEWS = 5000
 996     SCHEDULER_INTERVALS_MS.UPDATE_VIDEOS = 5000
 997     SCHEDULER_INTERVALS_MS.AUTO_FOLLOW_INDEX_INSTANCES = 5000
 998     SCHEDULER_INTERVALS_MS.UPDATE_INBOX_STATS = 5000
 999     SCHEDULER_INTERVALS_MS.CHECK_PEERTUBE_VERSION = 2000
1000
1001     REPEAT_JOBS['videos-views-stats'] = { every: 5000 }
1002
1003     REPEAT_JOBS['activitypub-cleaner'] = { every: 5000 }
1004     AP_CLEANER.PERIOD = 5000
1005
1006     REDUNDANCY.VIDEOS.RANDOMIZED_FACTOR = 1
1007
1008     CONTACT_FORM_LIFETIME = 1000 // 1 second
1009
1010     JOB_ATTEMPTS['email'] = 1
1011
1012     FILES_CACHE.VIDEO_CAPTIONS.MAX_AGE = 3000
1013     MEMOIZE_TTL.OVERVIEWS_SAMPLE = 3000
1014     MEMOIZE_TTL.LIVE_ABLE_TO_UPLOAD = 3000
1015     OVERVIEWS.VIDEOS.SAMPLE_THRESHOLD = 2
1016
1017     PLUGIN_EXTERNAL_AUTH_TOKEN_LIFETIME = 5000
1018
1019     JOB_REMOVAL_OPTIONS.SUCCESS['videos-views-stats'] = 10000
1020   }
1021
1022   if (isTestInstance()) {
1023     ACTIVITY_PUB.COLLECTION_ITEMS_PER_PAGE = 2
1024     ACTIVITY_PUB.ACTOR_REFRESH_INTERVAL = 10 * 1000 // 10 seconds
1025     ACTIVITY_PUB.VIDEO_REFRESH_INTERVAL = 10 * 1000 // 10 seconds
1026     ACTIVITY_PUB.VIDEO_PLAYLIST_REFRESH_INTERVAL = 10 * 1000 // 10 seconds
1027
1028     CONSTRAINTS_FIELDS.ACTORS.IMAGE.FILE_SIZE.max = 100 * 1024 // 100KB
1029     CONSTRAINTS_FIELDS.VIDEOS.IMAGE.FILE_SIZE.max = 400 * 1024 // 400KB
1030
1031     VIEW_LIFETIME.VIEWER_COUNTER = 1000 * 5 // 5 second
1032     VIEW_LIFETIME.VIEWER_STATS = 1000 * 5 // 5 second
1033
1034     VIDEO_LIVE.CLEANUP_DELAY = getIntEnv('PEERTUBE_TEST_CONSTANTS_VIDEO_LIVE_CLEANUP_DELAY') ?? 5000
1035     VIDEO_LIVE.SEGMENT_TIME_SECONDS.DEFAULT_LATENCY = 2
1036     VIDEO_LIVE.SEGMENT_TIME_SECONDS.SMALL_LATENCY = 1
1037     VIDEO_LIVE.EDGE_LIVE_DELAY_SEGMENTS_NOTIFICATION = 1
1038
1039     RUNNER_JOBS.LAST_CONTACT_UPDATE_INTERVAL = 2000
1040   }
1041 }
1042
1043 updateWebserverUrls()
1044 updateWebserverConfig()
1045
1046 registerConfigChangedHandler(() => {
1047   updateWebserverUrls()
1048   updateWebserverConfig()
1049 })
1050
1051 // ---------------------------------------------------------------------------
1052
1053 const FILES_CONTENT_HASH = {
1054   MANIFEST: generateContentHash(),
1055   FAVICON: generateContentHash(),
1056   LOGO: generateContentHash()
1057 }
1058
1059 // ---------------------------------------------------------------------------
1060
1061 const VIDEO_FILTERS = {
1062   WATERMARK: {
1063     SIZE_RATIO: 1 / 10,
1064     HORIZONTAL_MARGIN_RATIO: 1 / 20,
1065     VERTICAL_MARGIN_RATIO: 1 / 20
1066   }
1067 }
1068
1069 // ---------------------------------------------------------------------------
1070
1071 export {
1072   WEBSERVER,
1073   API_VERSION,
1074   ENCRYPTION,
1075   VIDEO_LIVE,
1076   PEERTUBE_VERSION,
1077   LAZY_STATIC_PATHS,
1078   OBJECT_STORAGE_PROXY_PATHS,
1079   SEARCH_INDEX,
1080   DIRECTORIES,
1081   RESUMABLE_UPLOAD_SESSION_LIFETIME,
1082   RUNNER_JOB_STATES,
1083   P2P_MEDIA_LOADER_PEER_VERSION,
1084   ACTOR_IMAGES_SIZE,
1085   ACCEPT_HEADERS,
1086   BCRYPT_SALT_SIZE,
1087   TRACKER_RATE_LIMITS,
1088   FILES_CACHE,
1089   LOG_FILENAME,
1090   CONSTRAINTS_FIELDS,
1091   EMBED_SIZE,
1092   REDUNDANCY,
1093   JOB_CONCURRENCY,
1094   JOB_ATTEMPTS,
1095   AP_CLEANER,
1096   LAST_MIGRATION_VERSION,
1097   CUSTOM_HTML_TAG_COMMENTS,
1098   STATS_TIMESERIE,
1099   BROADCAST_CONCURRENCY,
1100   AUDIT_LOG_FILENAME,
1101   PAGINATION,
1102   ACTOR_FOLLOW_SCORE,
1103   PREVIEWS_SIZE,
1104   REMOTE_SCHEME,
1105   FOLLOW_STATES,
1106   DEFAULT_USER_THEME_NAME,
1107   SERVER_ACTOR_NAME,
1108   TWO_FACTOR_AUTH_REQUEST_TOKEN_LIFETIME,
1109   PLUGIN_GLOBAL_CSS_FILE_NAME,
1110   PLUGIN_GLOBAL_CSS_PATH,
1111   PRIVATE_RSA_KEY_SIZE,
1112   VIDEO_FILTERS,
1113   ROUTE_CACHE_LIFETIME,
1114   SORTABLE_COLUMNS,
1115   JOB_TTL,
1116   DEFAULT_THEME_NAME,
1117   NSFW_POLICY_TYPES,
1118   STATIC_MAX_AGE,
1119   STATIC_PATHS,
1120   VIDEO_IMPORT_TIMEOUT,
1121   VIDEO_PLAYLIST_TYPES,
1122   MAX_LOGS_OUTPUT_CHARACTERS,
1123   ACTIVITY_PUB,
1124   ACTIVITY_PUB_ACTOR_TYPES,
1125   THUMBNAILS_SIZE,
1126   VIDEO_CATEGORIES,
1127   MEMOIZE_LENGTH,
1128   VIDEO_LANGUAGES,
1129   VIDEO_PRIVACIES,
1130   VIDEO_LICENCES,
1131   VIDEO_STATES,
1132   WORKER_THREADS,
1133   VIDEO_RATE_TYPES,
1134   JOB_PRIORITY,
1135   VIDEO_TRANSCODING_FPS,
1136   FFMPEG_NICE,
1137   ABUSE_STATES,
1138   USER_REGISTRATION_STATES,
1139   LRU_CACHE,
1140   REQUEST_TIMEOUTS,
1141   RUNNER_JOBS,
1142   MAX_LOCAL_VIEWER_WATCH_SECTIONS,
1143   USER_PASSWORD_RESET_LIFETIME,
1144   USER_PASSWORD_CREATE_LIFETIME,
1145   MEMOIZE_TTL,
1146   EMAIL_VERIFY_LIFETIME,
1147   OVERVIEWS,
1148   SCHEDULER_INTERVALS_MS,
1149   REPEAT_JOBS,
1150   STATIC_DOWNLOAD_PATHS,
1151   MIMETYPES,
1152   CRAWL_REQUEST_CONCURRENCY,
1153   DEFAULT_AUDIO_RESOLUTION,
1154   BINARY_CONTENT_TYPES,
1155   JOB_REMOVAL_OPTIONS,
1156   HTTP_SIGNATURE,
1157   VIDEO_IMPORT_STATES,
1158   VIDEO_CHANNEL_SYNC_STATE,
1159   VIEW_LIFETIME,
1160   CONTACT_FORM_LIFETIME,
1161   VIDEO_PLAYLIST_PRIVACIES,
1162   PLUGIN_EXTERNAL_AUTH_TOKEN_LIFETIME,
1163   ASSETS_PATH,
1164   FILES_CONTENT_HASH,
1165   OTP,
1166   loadLanguages,
1167   buildLanguages,
1168   generateContentHash
1169 }
1170
1171 // ---------------------------------------------------------------------------
1172
1173 function buildVideoMimetypeExt () {
1174   const data = {
1175     // streamable formats that warrant cross-browser compatibility
1176     'video/webm': '.webm',
1177     // We'll add .ogg if additional extensions are enabled
1178     // We could add .ogg here but since it could be an audio file,
1179     // it would be confusing for users because PeerTube will refuse their file (based on the mimetype)
1180     'video/ogg': [ '.ogv' ],
1181     'video/mp4': '.mp4'
1182   }
1183
1184   if (CONFIG.TRANSCODING.ENABLED) {
1185     if (CONFIG.TRANSCODING.ALLOW_ADDITIONAL_EXTENSIONS) {
1186       data['video/ogg'].push('.ogg')
1187
1188       Object.assign(data, {
1189         'video/x-matroska': '.mkv',
1190
1191         // Developed by Apple
1192         'video/quicktime': [ '.mov', '.qt', '.mqv' ], // often used as output format by editing software
1193         'video/x-m4v': '.m4v',
1194         'video/m4v': '.m4v',
1195
1196         // Developed by the Adobe Flash Platform
1197         'video/x-flv': '.flv',
1198         'video/x-f4v': '.f4v', // replacement for flv
1199
1200         // Developed by Microsoft
1201         'video/x-ms-wmv': '.wmv',
1202         'video/x-msvideo': '.avi',
1203         'video/avi': '.avi',
1204
1205         // Developed by 3GPP
1206         // common video formats for cell phones
1207         'video/3gpp': [ '.3gp', '.3gpp' ],
1208         'video/3gpp2': [ '.3g2', '.3gpp2' ],
1209
1210         // Developed by FFmpeg/Mplayer
1211         'application/x-nut': '.nut',
1212
1213         // The standard video format used by many Sony and Panasonic HD camcorders.
1214         // It is also used for storing high definition video on Blu-ray discs.
1215         'video/mp2t': '.mts',
1216         'video/vnd.dlna.mpeg-tts': '.mts',
1217
1218         'video/m2ts': '.m2ts',
1219
1220         // Old formats reliant on MPEG-1/MPEG-2
1221         'video/mpv': '.mpv',
1222         'video/mpeg2': '.m2v',
1223         'video/mpeg': [ '.m1v', '.mpg', '.mpe', '.mpeg', '.vob' ],
1224         'video/dvd': '.vob',
1225
1226         // Could be anything
1227         'application/octet-stream': null,
1228         'application/mxf': '.mxf' // often used as exchange format by editing software
1229       })
1230     }
1231
1232     if (CONFIG.TRANSCODING.ALLOW_AUDIO_FILES) {
1233       Object.assign(data, MIMETYPES.AUDIO.MIMETYPE_EXT)
1234     }
1235   }
1236
1237   return data
1238 }
1239
1240 function updateWebserverUrls () {
1241   WEBSERVER.URL = sanitizeUrl(CONFIG.WEBSERVER.SCHEME + '://' + CONFIG.WEBSERVER.HOSTNAME + ':' + CONFIG.WEBSERVER.PORT)
1242   WEBSERVER.HOST = sanitizeHost(CONFIG.WEBSERVER.HOSTNAME + ':' + CONFIG.WEBSERVER.PORT, REMOTE_SCHEME.HTTP)
1243   WEBSERVER.WS = CONFIG.WEBSERVER.WS
1244
1245   WEBSERVER.SCHEME = CONFIG.WEBSERVER.SCHEME
1246   WEBSERVER.HOSTNAME = CONFIG.WEBSERVER.HOSTNAME
1247   WEBSERVER.PORT = CONFIG.WEBSERVER.PORT
1248
1249   const rtmpHostname = CONFIG.LIVE.RTMP.PUBLIC_HOSTNAME || CONFIG.WEBSERVER.HOSTNAME
1250   const rtmpsHostname = CONFIG.LIVE.RTMPS.PUBLIC_HOSTNAME || CONFIG.WEBSERVER.HOSTNAME
1251
1252   WEBSERVER.RTMP_URL = 'rtmp://' + rtmpHostname + ':' + CONFIG.LIVE.RTMP.PORT
1253   WEBSERVER.RTMPS_URL = 'rtmps://' + rtmpsHostname + ':' + CONFIG.LIVE.RTMPS.PORT
1254
1255   WEBSERVER.RTMP_BASE_LIVE_URL = WEBSERVER.RTMP_URL + '/' + VIDEO_LIVE.RTMP.BASE_PATH
1256   WEBSERVER.RTMPS_BASE_LIVE_URL = WEBSERVER.RTMPS_URL + '/' + VIDEO_LIVE.RTMP.BASE_PATH
1257 }
1258
1259 function updateWebserverConfig () {
1260   MIMETYPES.VIDEO.MIMETYPE_EXT = buildVideoMimetypeExt()
1261   MIMETYPES.VIDEO.MIMETYPES_REGEX = buildMimetypesRegex(MIMETYPES.VIDEO.MIMETYPE_EXT)
1262
1263   ACTIVITY_PUB.URL_MIME_TYPES.VIDEO = Object.keys(MIMETYPES.VIDEO.MIMETYPE_EXT)
1264
1265   MIMETYPES.VIDEO.EXT_MIMETYPE = buildVideoExtMimetype(MIMETYPES.VIDEO.MIMETYPE_EXT)
1266
1267   CONSTRAINTS_FIELDS.VIDEOS.EXTNAME = Object.keys(MIMETYPES.VIDEO.EXT_MIMETYPE)
1268 }
1269
1270 function buildVideoExtMimetype (obj: { [ id: string ]: string | string[] }) {
1271   const result: { [id: string]: string } = {}
1272
1273   for (const mimetype of Object.keys(obj)) {
1274     const value = obj[mimetype]
1275     if (!value) continue
1276
1277     const extensions = Array.isArray(value) ? value : [ value ]
1278
1279     for (const extension of extensions) {
1280       result[extension] = mimetype
1281     }
1282   }
1283
1284   return result
1285 }
1286
1287 function buildMimetypesRegex (obj: { [id: string]: string | string[] }) {
1288   return Object.keys(obj)
1289     .map(m => `(${m})`)
1290     .join('|')
1291 }
1292
1293 function loadLanguages () {
1294   Object.assign(VIDEO_LANGUAGES, buildLanguages())
1295 }
1296
1297 function buildLanguages () {
1298   const iso639 = require('iso-639-3')
1299
1300   const languages: { [id: string]: string } = {}
1301
1302   const additionalLanguages = {
1303     sgn: true, // Sign languages (macro language)
1304     ase: true, // American sign language
1305     asq: true, // Austrian sign language
1306     sdl: true, // Arabian sign language
1307     bfi: true, // British sign language
1308     bzs: true, // Brazilian sign language
1309     csl: true, // Chinese sign language
1310     cse: true, // Czech sign language
1311     dsl: true, // Danish sign language
1312     fsl: true, // French sign language
1313     gsg: true, // German sign language
1314     pks: true, // Pakistan sign language
1315     jsl: true, // Japanese sign language
1316     sfs: true, // South African sign language
1317     swl: true, // Swedish sign language
1318     rsl: true, // Russian sign language
1319
1320     kab: true, // Kabyle
1321
1322     lat: true, // Latin
1323
1324     epo: true, // Esperanto
1325     tlh: true, // Klingon
1326     jbo: true, // Lojban
1327     avk: true, // Kotava
1328
1329     zxx: true // No linguistic content (ISO-639-2)
1330   }
1331
1332   // Only add ISO639-1 languages and some sign languages (ISO639-3)
1333   iso639
1334     .filter(l => {
1335       return (l.iso6391 !== undefined && l.type === 'living') ||
1336         additionalLanguages[l.iso6393] === true
1337     })
1338     .forEach(l => { languages[l.iso6391 || l.iso6393] = l.name })
1339
1340   // Override Occitan label
1341   languages['oc'] = 'Occitan'
1342   languages['el'] = 'Greek'
1343   languages['tok'] = 'Toki Pona'
1344
1345   // Chinese languages
1346   languages['zh-Hans'] = 'Simplified Chinese'
1347   languages['zh-Hant'] = 'Traditional Chinese'
1348
1349   return languages
1350 }
1351
1352 function generateContentHash () {
1353   return randomBytes(20).toString('hex')
1354 }
1355
1356 function getIntEnv (path: string) {
1357   if (process.env[path]) return parseInt(process.env[path])
1358
1359   return undefined
1360 }