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