server/initializers/constants.ts

   1 import { CronRepeatOptions, EveryRepeatOptions } from 'bull'
   2 import { randomBytes } from 'crypto'
   3 import { invert } from 'lodash'
   4 import { join } from 'path'
   5 import { randomInt } from '../../shared/core-utils/common/miscs'
   6 import {
   7   AbuseState,
   8   JobType,
   9   VideoImportState,
  10   VideoPrivacy,
  11   VideoRateType,
  12   VideoResolution,
  13   VideoState,
  14   VideoTranscodingFPS
  15 } from '../../shared/models'
  16 import { ActivityPubActorType } from '../../shared/models/activitypub'
  17 import { FollowState } from '../../shared/models/actors'
  18 import { NSFWPolicyType } from '../../shared/models/videos/nsfw-policy.type'
  19 import { VideoPlaylistPrivacy } from '../../shared/models/videos/playlist/video-playlist-privacy.model'
  20 import { VideoPlaylistType } from '../../shared/models/videos/playlist/video-playlist-type.model'
  21 // Do not use barrels, remain constants as independent as possible
  22 import { isTestInstance, root, sanitizeHost, sanitizeUrl } from '../helpers/core-utils'
  23 import { CONFIG, registerConfigChangedHandler } from './config'
  24
  25 // ---------------------------------------------------------------------------
  26
  27 const LAST_MIGRATION_VERSION = 670
  28
  29 // ---------------------------------------------------------------------------
  30
  31 const API_VERSION = 'v1'
  32 const PEERTUBE_VERSION: string = require(join(root(), 'package.json')).version
  33
  34 const PAGINATION = {
  35   GLOBAL: {
  36     COUNT: {
  37       DEFAULT: 15,
  38       MAX: 100
  39     }
  40   },
  41   OUTBOX: {
  42     COUNT: {
  43       MAX: 50
  44     }
  45   }
  46 }
  47
  48 const WEBSERVER = {
  49   URL: '',
  50   HOST: '',
  51   SCHEME: '',
  52   WS: '',
  53   HOSTNAME: '',
  54   PORT: 0,
  55   RTMP_URL: ''
  56 }
  57
  58 // Sortable columns per schema
  59 const SORTABLE_COLUMNS = {
  60   USERS: [ 'id', 'username', 'videoQuotaUsed', 'createdAt', 'lastLoginDate', 'role' ],
  61   USER_SUBSCRIPTIONS: [ 'id', 'createdAt' ],
  62   ACCOUNTS: [ 'createdAt' ],
  63   JOBS: [ 'createdAt' ],
  64   VIDEO_CHANNELS: [ 'id', 'name', 'updatedAt', 'createdAt' ],
  65   VIDEO_IMPORTS: [ 'createdAt' ],
  66
  67   VIDEO_COMMENT_THREADS: [ 'createdAt', 'totalReplies' ],
  68   VIDEO_COMMENTS: [ 'createdAt' ],
  69
  70   VIDEO_RATES: [ 'createdAt' ],
  71   BLACKLISTS: [ 'id', 'name', 'duration', 'views', 'likes', 'dislikes', 'uuid', 'createdAt' ],
  72
  73   INSTANCE_FOLLOWERS: [ 'createdAt', 'state', 'score' ],
  74   INSTANCE_FOLLOWING: [ 'createdAt', 'redundancyAllowed', 'state' ],
  75   ACCOUNT_FOLLOWERS: [ 'createdAt' ],
  76   CHANNEL_FOLLOWERS: [ 'createdAt' ],
  77
  78   VIDEOS: [ 'name', 'duration', 'createdAt', 'publishedAt', 'originallyPublishedAt', 'views', 'likes', 'trending', 'hot', 'best' ],
  79
  80   // Don't forget to update peertube-search-index with the same values
  81   VIDEOS_SEARCH: [ 'name', 'duration', 'createdAt', 'publishedAt', 'originallyPublishedAt', 'views', 'likes', 'match' ],
  82   VIDEO_CHANNELS_SEARCH: [ 'match', 'displayName', 'createdAt' ],
  83   VIDEO_PLAYLISTS_SEARCH: [ 'match', 'displayName', 'createdAt' ],
  84
  85   ABUSES: [ 'id', 'createdAt', 'state' ],
  86
  87   ACCOUNTS_BLOCKLIST: [ 'createdAt' ],
  88   SERVERS_BLOCKLIST: [ 'createdAt' ],
  89
  90   USER_NOTIFICATIONS: [ 'createdAt', 'read' ],
  91
  92   VIDEO_PLAYLISTS: [ 'name', 'displayName', 'createdAt', 'updatedAt' ],
  93
  94   PLUGINS: [ 'name', 'createdAt', 'updatedAt' ],
  95
  96   AVAILABLE_PLUGINS: [ 'npmName', 'popularity' ],
  97
  98   VIDEO_REDUNDANCIES: [ 'name' ]
  99 }
 100
 101 const OAUTH_LIFETIME = {
 102   ACCESS_TOKEN: 3600 * 24, // 1 day, for upload
 103   REFRESH_TOKEN: 1209600 // 2 weeks
 104 }
 105
 106 const ROUTE_CACHE_LIFETIME = {
 107   FEEDS: '15 minutes',
 108   ROBOTS: '2 hours',
 109   SITEMAP: '1 day',
 110   SECURITYTXT: '2 hours',
 111   NODEINFO: '10 minutes',
 112   DNT_POLICY: '1 week',
 113   ACTIVITY_PUB: {
 114     VIDEOS: '1 second' // 1 second, cache concurrent requests after a broadcast for example
 115   },
 116   STATS: '4 hours'
 117 }
 118
 119 // ---------------------------------------------------------------------------
 120
 121 // Number of points we add/remove after a successful/bad request
 122 const ACTOR_FOLLOW_SCORE = {
 123   PENALTY: -10,
 124   BONUS: 10,
 125   BASE: 1000,
 126   MAX: 10000
 127 }
 128
 129 const FOLLOW_STATES: { [ id: string ]: FollowState } = {
 130   PENDING: 'pending',
 131   ACCEPTED: 'accepted'
 132 }
 133
 134 const REMOTE_SCHEME = {
 135   HTTP: 'https',
 136   WS: 'wss'
 137 }
 138
 139 const JOB_ATTEMPTS: { [id in JobType]: number } = {
 140   'activitypub-http-broadcast': 1,
 141   'activitypub-http-unicast': 1,
 142   'activitypub-http-fetcher': 2,
 143   'activitypub-follow': 5,
 144   'activitypub-cleaner': 1,
 145   'video-file-import': 1,
 146   'video-transcoding': 1,
 147   'video-import': 1,
 148   'email': 5,
 149   'actor-keys': 3,
 150   'videos-views': 1,
 151   'activitypub-refresher': 1,
 152   'video-redundancy': 1,
 153   'video-live-ending': 1,
 154   'move-to-object-storage': 3
 155 }
 156 // Excluded keys are jobs that can be configured by admins
 157 const JOB_CONCURRENCY: { [id in Exclude<JobType, 'video-transcoding' | 'video-import'>]: number } = {
 158   'activitypub-http-broadcast': 1,
 159   'activitypub-http-unicast': 10,
 160   'activitypub-http-fetcher': 3,
 161   'activitypub-cleaner': 1,
 162   'activitypub-follow': 1,
 163   'video-file-import': 1,
 164   'email': 5,
 165   'actor-keys': 1,
 166   'videos-views': 1,
 167   'activitypub-refresher': 1,
 168   'video-redundancy': 1,
 169   'video-live-ending': 10,
 170   'move-to-object-storage': 1
 171 }
 172 const JOB_TTL: { [id in JobType]: number } = {
 173   'activitypub-http-broadcast': 60000 * 10, // 10 minutes
 174   'activitypub-http-unicast': 60000 * 10, // 10 minutes
 175   'activitypub-http-fetcher': 1000 * 3600 * 10, // 10 hours
 176   'activitypub-follow': 60000 * 10, // 10 minutes
 177   'activitypub-cleaner': 1000 * 3600, // 1 hour
 178   'video-file-import': 1000 * 3600, // 1 hour
 179   'video-transcoding': 1000 * 3600 * 48, // 2 days, transcoding could be long
 180   'video-import': 1000 * 3600 * 2, // 2 hours
 181   'email': 60000 * 10, // 10 minutes
 182   'actor-keys': 60000 * 20, // 20 minutes
 183   'videos-views': undefined, // Unlimited
 184   'activitypub-refresher': 60000 * 10, // 10 minutes
 185   'video-redundancy': 1000 * 3600 * 3, // 3 hours
 186   'video-live-ending': 1000 * 60 * 10, // 10 minutes
 187   'move-to-object-storage': 1000 * 60 * 60 * 3 // 3 hours
 188 }
 189 const REPEAT_JOBS: { [ id: string ]: EveryRepeatOptions | CronRepeatOptions } = {
 190   'videos-views': {
 191     cron: randomInt(1, 20) + ' * * * *' // Between 1-20 minutes past the hour
 192   },
 193   'activitypub-cleaner': {
 194     cron: '30 5 * * ' + randomInt(0, 7) // 1 time per week (random day) at 5:30 AM
 195   }
 196 }
 197 const JOB_PRIORITY = {
 198   TRANSCODING: 100
 199 }
 200
 201 const BROADCAST_CONCURRENCY = 30 // How many requests in parallel we do in activitypub-http-broadcast job
 202 const AP_CLEANER_CONCURRENCY = 10 // How many requests in parallel we do in activitypub-cleaner job
 203 const CRAWL_REQUEST_CONCURRENCY = 1 // How many requests in parallel to fetch remote data (likes, shares...)
 204 const REQUEST_TIMEOUT = 7000 // 7 seconds
 205 const JOB_COMPLETED_LIFETIME = 60000 * 60 * 24 * 2 // 2 days
 206 const VIDEO_IMPORT_TIMEOUT = 1000 * 3600 // 1 hour
 207
 208 const SCHEDULER_INTERVALS_MS = {
 209   actorFollowScores: 60000 * 60, // 1 hour
 210   removeOldJobs: 60000 * 60, // 1 hour
 211   updateVideos: 60000, // 1 minute
 212   youtubeDLUpdate: 60000 * 60 * 24, // 1 day
 213   checkPlugins: CONFIG.PLUGINS.INDEX.CHECK_LATEST_VERSIONS_INTERVAL,
 214   checkPeerTubeVersion: 60000 * 60 * 24, // 1 day
 215   autoFollowIndexInstances: 60000 * 60 * 24, // 1 day
 216   removeOldViews: 60000 * 60 * 24, // 1 day
 217   removeOldHistory: 60000 * 60 * 24, // 1 day
 218   updateInboxStats: 1000 * 60, // 1 minute
 219   removeDanglingResumableUploads: 60000 * 60 * 16 // 16 hours
 220 }
 221
 222 // ---------------------------------------------------------------------------
 223
 224 const CONSTRAINTS_FIELDS = {
 225   USERS: {
 226     NAME: { min: 1, max: 120 }, // Length
 227     DESCRIPTION: { min: 3, max: 1000 }, // Length
 228     USERNAME: { min: 1, max: 50 }, // Length
 229     PASSWORD: { min: 6, max: 255 }, // Length
 230     VIDEO_QUOTA: { min: -1 },
 231     VIDEO_QUOTA_DAILY: { min: -1 },
 232     VIDEO_LANGUAGES: { max: 500 }, // Array length
 233     BLOCKED_REASON: { min: 3, max: 250 } // Length
 234   },
 235   ABUSES: {
 236     REASON: { min: 2, max: 3000 }, // Length
 237     MODERATION_COMMENT: { min: 2, max: 3000 } // Length
 238   },
 239   ABUSE_MESSAGES: {
 240     MESSAGE: { min: 2, max: 3000 } // Length
 241   },
 242   VIDEO_BLACKLIST: {
 243     REASON: { min: 2, max: 300 } // Length
 244   },
 245   VIDEO_CHANNELS: {
 246     NAME: { min: 1, max: 120 }, // Length
 247     DESCRIPTION: { min: 3, max: 1000 }, // Length
 248     SUPPORT: { min: 3, max: 1000 }, // Length
 249     URL: { min: 3, max: 2000 } // Length
 250   },
 251   VIDEO_CAPTIONS: {
 252     CAPTION_FILE: {
 253       EXTNAME: [ '.vtt', '.srt' ],
 254       FILE_SIZE: {
 255         max: 4 * 1024 * 1024 // 4MB
 256       }
 257     }
 258   },
 259   VIDEO_IMPORTS: {
 260     URL: { min: 3, max: 2000 }, // Length
 261     TORRENT_NAME: { min: 3, max: 255 }, // Length
 262     TORRENT_FILE: {
 263       EXTNAME: [ '.torrent' ],
 264       FILE_SIZE: {
 265         max: 1024 * 200 // 200 KB
 266       }
 267     }
 268   },
 269   VIDEOS_REDUNDANCY: {
 270     URL: { min: 3, max: 2000 } // Length
 271   },
 272   VIDEO_RATES: {
 273     URL: { min: 3, max: 2000 } // Length
 274   },
 275   VIDEOS: {
 276     NAME: { min: 3, max: 120 }, // Length
 277     LANGUAGE: { min: 1, max: 10 }, // Length
 278     TRUNCATED_DESCRIPTION: { min: 3, max: 250 }, // Length
 279     DESCRIPTION: { min: 3, max: 10000 }, // Length
 280     SUPPORT: { min: 3, max: 1000 }, // Length
 281     IMAGE: {
 282       EXTNAME: [ '.png', '.jpg', '.jpeg', '.webp' ],
 283       FILE_SIZE: {
 284         max: 4 * 1024 * 1024 // 4MB
 285       }
 286     },
 287     EXTNAME: [] as string[],
 288     INFO_HASH: { min: 40, max: 40 }, // Length, info hash is 20 bytes length but we represent it in hexadecimal so 20 * 2
 289     DURATION: { min: 0 }, // Number
 290     TAGS: { min: 0, max: 5 }, // Number of total tags
 291     TAG: { min: 2, max: 30 }, // Length
 292     VIEWS: { min: 0 },
 293     LIKES: { min: 0 },
 294     DISLIKES: { min: 0 },
 295     FILE_SIZE: { min: -1 },
 296     PARTIAL_UPLOAD_SIZE: { max: 50 * 1024 * 1024 * 1024 }, // 50GB
 297     URL: { min: 3, max: 2000 } // Length
 298   },
 299   VIDEO_PLAYLISTS: {
 300     NAME: { min: 1, max: 120 }, // Length
 301     DESCRIPTION: { min: 3, max: 1000 }, // Length
 302     URL: { min: 3, max: 2000 }, // Length
 303     IMAGE: {
 304       EXTNAME: [ '.jpg', '.jpeg' ],
 305       FILE_SIZE: {
 306         max: 4 * 1024 * 1024 // 4MB
 307       }
 308     }
 309   },
 310   ACTORS: {
 311     PUBLIC_KEY: { min: 10, max: 5000 }, // Length
 312     PRIVATE_KEY: { min: 10, max: 5000 }, // Length
 313     URL: { min: 3, max: 2000 }, // Length
 314     IMAGE: {
 315       EXTNAME: [ '.png', '.jpeg', '.jpg', '.gif', '.webp' ],
 316       FILE_SIZE: {
 317         max: 4 * 1024 * 1024 // 4MB
 318       }
 319     }
 320   },
 321   VIDEO_EVENTS: {
 322     COUNT: { min: 0 }
 323   },
 324   VIDEO_COMMENTS: {
 325     TEXT: { min: 1, max: 10000 }, // Length
 326     URL: { min: 3, max: 2000 } // Length
 327   },
 328   VIDEO_SHARE: {
 329     URL: { min: 3, max: 2000 } // Length
 330   },
 331   CONTACT_FORM: {
 332     FROM_NAME: { min: 1, max: 120 }, // Length
 333     BODY: { min: 3, max: 5000 } // Length
 334   },
 335   PLUGINS: {
 336     NAME: { min: 1, max: 214 }, // Length
 337     DESCRIPTION: { min: 1, max: 20000 } // Length
 338   },
 339   COMMONS: {
 340     URL: { min: 5, max: 2000 } // Length
 341   }
 342 }
 343
 344 const VIEW_LIFETIME = {
 345   VIDEO: 60000 * 60, // 1 hour
 346   LIVE: 60000 * 5 // 5 minutes
 347 }
 348
 349 let CONTACT_FORM_LIFETIME = 60000 * 60 // 1 hour
 350
 351 const VIDEO_TRANSCODING_FPS: VideoTranscodingFPS = {
 352   MIN: 1,
 353   STANDARD: [ 24, 25, 30 ],
 354   HD_STANDARD: [ 50, 60 ],
 355   AVERAGE: 30,
 356   MAX: 60,
 357   KEEP_ORIGIN_FPS_RESOLUTION_MIN: 720 // We keep the original FPS on high resolutions (720 minimum)
 358 }
 359
 360 const DEFAULT_AUDIO_RESOLUTION = VideoResolution.H_480P
 361
 362 const VIDEO_RATE_TYPES: { [ id: string ]: VideoRateType } = {
 363   LIKE: 'like',
 364   DISLIKE: 'dislike'
 365 }
 366
 367 const FFMPEG_NICE: { [ id: string ]: number } = {
 368   // parent process defaults to niceness = 0
 369   // reminder: lower = higher priority, max value is 19, lowest is -20
 370   LIVE: 5, // prioritize over VOD and THUMBNAIL
 371   THUMBNAIL: 10,
 372   VOD: 15
 373 }
 374
 375 const VIDEO_CATEGORIES = {
 376   1: 'Music',
 377   2: 'Films',
 378   3: 'Vehicles',
 379   4: 'Art',
 380   5: 'Sports',
 381   6: 'Travels',
 382   7: 'Gaming',
 383   8: 'People',
 384   9: 'Comedy',
 385   10: 'Entertainment',
 386   11: 'News & Politics',
 387   12: 'How To',
 388   13: 'Education',
 389   14: 'Activism',
 390   15: 'Science & Technology',
 391   16: 'Animals',
 392   17: 'Kids',
 393   18: 'Food'
 394 }
 395
 396 // See https://creativecommons.org/licenses/?lang=en
 397 const VIDEO_LICENCES = {
 398   1: 'Attribution',
 399   2: 'Attribution - Share Alike',
 400   3: 'Attribution - No Derivatives',
 401   4: 'Attribution - Non Commercial',
 402   5: 'Attribution - Non Commercial - Share Alike',
 403   6: 'Attribution - Non Commercial - No Derivatives',
 404   7: 'Public Domain Dedication'
 405 }
 406
 407 const VIDEO_LANGUAGES: { [id: string]: string } = {}
 408
 409 const VIDEO_PRIVACIES: { [ id in VideoPrivacy ]: string } = {
 410   [VideoPrivacy.PUBLIC]: 'Public',
 411   [VideoPrivacy.UNLISTED]: 'Unlisted',
 412   [VideoPrivacy.PRIVATE]: 'Private',
 413   [VideoPrivacy.INTERNAL]: 'Internal'
 414 }
 415
 416 const VIDEO_STATES: { [ id in VideoState ]: string } = {
 417   [VideoState.PUBLISHED]: 'Published',
 418   [VideoState.TO_TRANSCODE]: 'To transcode',
 419   [VideoState.TO_IMPORT]: 'To import',
 420   [VideoState.WAITING_FOR_LIVE]: 'Waiting for livestream',
 421   [VideoState.LIVE_ENDED]: 'Livestream ended',
 422   [VideoState.TO_MOVE_TO_EXTERNAL_STORAGE]: 'To move to an external storage'
 423 }
 424
 425 const VIDEO_IMPORT_STATES: { [ id in VideoImportState ]: string } = {
 426   [VideoImportState.FAILED]: 'Failed',
 427   [VideoImportState.PENDING]: 'Pending',
 428   [VideoImportState.SUCCESS]: 'Success',
 429   [VideoImportState.REJECTED]: 'Rejected'
 430 }
 431
 432 const ABUSE_STATES: { [ id in AbuseState ]: string } = {
 433   [AbuseState.PENDING]: 'Pending',
 434   [AbuseState.REJECTED]: 'Rejected',
 435   [AbuseState.ACCEPTED]: 'Accepted'
 436 }
 437
 438 const VIDEO_PLAYLIST_PRIVACIES: { [ id in VideoPlaylistPrivacy ]: string } = {
 439   [VideoPlaylistPrivacy.PUBLIC]: 'Public',
 440   [VideoPlaylistPrivacy.UNLISTED]: 'Unlisted',
 441   [VideoPlaylistPrivacy.PRIVATE]: 'Private'
 442 }
 443
 444 const VIDEO_PLAYLIST_TYPES: { [ id in VideoPlaylistType ]: string } = {
 445   [VideoPlaylistType.REGULAR]: 'Regular',
 446   [VideoPlaylistType.WATCH_LATER]: 'Watch later'
 447 }
 448
 449 const MIMETYPES = {
 450   AUDIO: {
 451     MIMETYPE_EXT: {
 452       'audio/mpeg': '.mp3',
 453       'audio/mp3': '.mp3',
 454       'application/ogg': '.ogg',
 455       'audio/ogg': '.ogg',
 456       'audio/x-ms-wma': '.wma',
 457       'audio/wav': '.wav',
 458       'audio/x-wav': '.wav',
 459       'audio/x-flac': '.flac',
 460       'audio/flac': '.flac',
 461       'audio/aac': '.aac',
 462       'audio/m4a': '.m4a',
 463       'audio/mp4': '.m4a',
 464       'audio/x-m4a': '.m4a',
 465       'audio/ac3': '.ac3'
 466     },
 467     EXT_MIMETYPE: null as { [ id: string ]: string }
 468   },
 469   VIDEO: {
 470     MIMETYPE_EXT: null as { [ id: string ]: string | string[] },
 471     MIMETYPES_REGEX: null as string,
 472     EXT_MIMETYPE: null as { [ id: string ]: string }
 473   },
 474   IMAGE: {
 475     MIMETYPE_EXT: {
 476       'image/png': '.png',
 477       'image/gif': '.gif',
 478       'image/webp': '.webp',
 479       'image/jpg': '.jpg',
 480       'image/jpeg': '.jpg'
 481     },
 482     EXT_MIMETYPE: null as { [ id: string ]: string }
 483   },
 484   VIDEO_CAPTIONS: {
 485     MIMETYPE_EXT: {
 486       'text/vtt': '.vtt',
 487       'application/x-subrip': '.srt',
 488       'text/plain': '.srt'
 489     }
 490   },
 491   TORRENT: {
 492     MIMETYPE_EXT: {
 493       'application/x-bittorrent': '.torrent'
 494     }
 495   }
 496 }
 497 MIMETYPES.AUDIO.EXT_MIMETYPE = invert(MIMETYPES.AUDIO.MIMETYPE_EXT)
 498 MIMETYPES.IMAGE.EXT_MIMETYPE = invert(MIMETYPES.IMAGE.MIMETYPE_EXT)
 499
 500 // ---------------------------------------------------------------------------
 501
 502 const OVERVIEWS = {
 503   VIDEOS: {
 504     SAMPLE_THRESHOLD: 6,
 505     SAMPLES_COUNT: 20
 506   }
 507 }
 508
 509 const VIDEO_CHANNELS = {
 510   MAX_PER_USER: 20
 511 }
 512
 513 // ---------------------------------------------------------------------------
 514
 515 const SERVER_ACTOR_NAME = 'peertube'
 516
 517 const ACTIVITY_PUB = {
 518   POTENTIAL_ACCEPT_HEADERS: [
 519     'application/activity+json',
 520     'application/ld+json',
 521     'application/ld+json; profile="https://www.w3.org/ns/activitystreams"'
 522   ],
 523   ACCEPT_HEADER: 'application/activity+json, application/ld+json',
 524   PUBLIC: 'https://www.w3.org/ns/activitystreams#Public',
 525   COLLECTION_ITEMS_PER_PAGE: 10,
 526   FETCH_PAGE_LIMIT: 2000,
 527   URL_MIME_TYPES: {
 528     VIDEO: [] as string[],
 529     TORRENT: [ 'application/x-bittorrent' ],
 530     MAGNET: [ 'application/x-bittorrent;x-scheme-handler/magnet' ]
 531   },
 532   MAX_RECURSION_COMMENTS: 100,
 533   ACTOR_REFRESH_INTERVAL: 3600 * 24 * 1000 * 2, // 2 days
 534   VIDEO_REFRESH_INTERVAL: 3600 * 24 * 1000 * 2, // 2 days
 535   VIDEO_PLAYLIST_REFRESH_INTERVAL: 3600 * 24 * 1000 * 2 // 2 days
 536 }
 537
 538 const ACTIVITY_PUB_ACTOR_TYPES: { [ id: string ]: ActivityPubActorType } = {
 539   GROUP: 'Group',
 540   PERSON: 'Person',
 541   APPLICATION: 'Application',
 542   ORGANIZATION: 'Organization',
 543   SERVICE: 'Service'
 544 }
 545
 546 const HTTP_SIGNATURE = {
 547   HEADER_NAME: 'signature',
 548   ALGORITHM: 'rsa-sha256',
 549   HEADERS_TO_SIGN: [ '(request-target)', 'host', 'date', 'digest' ],
 550   REQUIRED_HEADERS: {
 551     ALL: [ '(request-target)', 'host', 'date' ],
 552     POST: [ '(request-target)', 'host', 'date', 'digest' ]
 553   },
 554   CLOCK_SKEW_SECONDS: 1800
 555 }
 556
 557 // ---------------------------------------------------------------------------
 558
 559 let PRIVATE_RSA_KEY_SIZE = 2048
 560
 561 // Password encryption
 562 const BCRYPT_SALT_SIZE = 10
 563
 564 const USER_PASSWORD_RESET_LIFETIME = 60000 * 60 // 60 minutes
 565 const USER_PASSWORD_CREATE_LIFETIME = 60000 * 60 * 24 * 7 // 7 days
 566
 567 const USER_EMAIL_VERIFY_LIFETIME = 60000 * 60 // 60 minutes
 568
 569 const NSFW_POLICY_TYPES: { [ id: string ]: NSFWPolicyType } = {
 570   DO_NOT_LIST: 'do_not_list',
 571   BLUR: 'blur',
 572   DISPLAY: 'display'
 573 }
 574
 575 // ---------------------------------------------------------------------------
 576
 577 // Express static paths (router)
 578 const STATIC_PATHS = {
 579   THUMBNAILS: '/static/thumbnails/',
 580   TORRENTS: '/static/torrents/',
 581   WEBSEED: '/static/webseed/',
 582   REDUNDANCY: '/static/redundancy/',
 583   STREAMING_PLAYLISTS: {
 584     HLS: '/static/streaming-playlists/hls'
 585   }
 586 }
 587 const STATIC_DOWNLOAD_PATHS = {
 588   TORRENTS: '/download/torrents/',
 589   VIDEOS: '/download/videos/',
 590   HLS_VIDEOS: '/download/streaming-playlists/hls/videos/'
 591 }
 592 const LAZY_STATIC_PATHS = {
 593   BANNERS: '/lazy-static/banners/',
 594   AVATARS: '/lazy-static/avatars/',
 595   PREVIEWS: '/lazy-static/previews/',
 596   VIDEO_CAPTIONS: '/lazy-static/video-captions/',
 597   TORRENTS: '/lazy-static/torrents/'
 598 }
 599
 600 // Cache control
 601 const STATIC_MAX_AGE = {
 602   SERVER: '2h',
 603   LAZY_SERVER: '2d',
 604   CLIENT: '30d'
 605 }
 606
 607 // Videos thumbnail size
 608 const THUMBNAILS_SIZE = {
 609   width: 280,
 610   height: 157,
 611   minWidth: 150
 612 }
 613 const PREVIEWS_SIZE = {
 614   width: 850,
 615   height: 480,
 616   minWidth: 400
 617 }
 618 const ACTOR_IMAGES_SIZE = {
 619   AVATARS: {
 620     width: 120,
 621     height: 120
 622   },
 623   BANNERS: {
 624     width: 1920,
 625     height: 317 // 6/1 ratio
 626   }
 627 }
 628
 629 const EMBED_SIZE = {
 630   width: 560,
 631   height: 315
 632 }
 633
 634 // Sub folders of cache directory
 635 const FILES_CACHE = {
 636   PREVIEWS: {
 637     DIRECTORY: join(CONFIG.STORAGE.CACHE_DIR, 'previews'),
 638     MAX_AGE: 1000 * 3600 * 3 // 3 hours
 639   },
 640   VIDEO_CAPTIONS: {
 641     DIRECTORY: join(CONFIG.STORAGE.CACHE_DIR, 'video-captions'),
 642     MAX_AGE: 1000 * 3600 * 3 // 3 hours
 643   },
 644   TORRENTS: {
 645     DIRECTORY: join(CONFIG.STORAGE.CACHE_DIR, 'torrents'),
 646     MAX_AGE: 1000 * 3600 * 3 // 3 hours
 647   }
 648 }
 649
 650 const LRU_CACHE = {
 651   USER_TOKENS: {
 652     MAX_SIZE: 1000
 653   },
 654   ACTOR_IMAGE_STATIC: {
 655     MAX_SIZE: 500
 656   }
 657 }
 658
 659 const RESUMABLE_UPLOAD_DIRECTORY = join(CONFIG.STORAGE.TMP_DIR, 'resumable-uploads')
 660 const HLS_STREAMING_PLAYLIST_DIRECTORY = join(CONFIG.STORAGE.STREAMING_PLAYLISTS_DIR, 'hls')
 661 const HLS_REDUNDANCY_DIRECTORY = join(CONFIG.STORAGE.REDUNDANCY_DIR, 'hls')
 662
 663 const VIDEO_LIVE = {
 664   EXTENSION: '.ts',
 665   CLEANUP_DELAY: 1000 * 60 * 5, // 5 minutes
 666   SEGMENT_TIME_SECONDS: 4, // 4 seconds
 667   SEGMENTS_LIST_SIZE: 15, // 15 maximum segments in live playlist
 668   REPLAY_DIRECTORY: 'replay',
 669   EDGE_LIVE_DELAY_SEGMENTS_NOTIFICATION: 4,
 670   MAX_SOCKET_WAITING_DATA: 1024 * 1000 * 100, // 100MB
 671   RTMP: {
 672     CHUNK_SIZE: 60000,
 673     GOP_CACHE: true,
 674     PING: 60,
 675     PING_TIMEOUT: 30,
 676     BASE_PATH: 'live'
 677   }
 678 }
 679
 680 const MEMOIZE_TTL = {
 681   OVERVIEWS_SAMPLE: 1000 * 3600 * 4, // 4 hours
 682   INFO_HASH_EXISTS: 1000 * 3600 * 12, // 12 hours
 683   LIVE_ABLE_TO_UPLOAD: 1000 * 60, // 1 minute
 684   LIVE_CHECK_SOCKET_HEALTH: 1000 * 60 // 1 minute
 685 }
 686
 687 const MEMOIZE_LENGTH = {
 688   INFO_HASH_EXISTS: 200
 689 }
 690
 691 const QUEUE_CONCURRENCY = {
 692   ACTOR_PROCESS_IMAGE: 3
 693 }
 694
 695 const REDUNDANCY = {
 696   VIDEOS: {
 697     RANDOMIZED_FACTOR: 5
 698   }
 699 }
 700
 701 const ACCEPT_HEADERS = [ 'html', 'application/json' ].concat(ACTIVITY_PUB.POTENTIAL_ACCEPT_HEADERS)
 702
 703 const ASSETS_PATH = {
 704   DEFAULT_AUDIO_BACKGROUND: join(root(), 'dist', 'server', 'assets', 'default-audio-background.jpg'),
 705   DEFAULT_LIVE_BACKGROUND: join(root(), 'dist', 'server', 'assets', 'default-live-background.jpg')
 706 }
 707
 708 // ---------------------------------------------------------------------------
 709
 710 const CUSTOM_HTML_TAG_COMMENTS = {
 711   TITLE: '<!-- title tag -->',
 712   DESCRIPTION: '<!-- description tag -->',
 713   CUSTOM_CSS: '<!-- custom css tag -->',
 714   META_TAGS: '<!-- meta tags -->',
 715   SERVER_CONFIG: '<!-- server config -->'
 716 }
 717
 718 // ---------------------------------------------------------------------------
 719
 720 const FEEDS = {
 721   COUNT: 20
 722 }
 723
 724 const MAX_LOGS_OUTPUT_CHARACTERS = 10 * 1000 * 1000
 725 const LOG_FILENAME = 'peertube.log'
 726 const AUDIT_LOG_FILENAME = 'peertube-audit.log'
 727
 728 // ---------------------------------------------------------------------------
 729
 730 const TRACKER_RATE_LIMITS = {
 731   INTERVAL: 60000 * 5, // 5 minutes
 732   ANNOUNCES_PER_IP_PER_INFOHASH: 15, // maximum announces per torrent in the interval
 733   ANNOUNCES_PER_IP: 30, // maximum announces for all our torrents in the interval
 734   BLOCK_IP_LIFETIME: 60000 * 3 // 3 minutes
 735 }
 736
 737 const P2P_MEDIA_LOADER_PEER_VERSION = 2
 738
 739 // ---------------------------------------------------------------------------
 740
 741 const PLUGIN_GLOBAL_CSS_FILE_NAME = 'plugins-global.css'
 742 const PLUGIN_GLOBAL_CSS_PATH = join(CONFIG.STORAGE.TMP_DIR, PLUGIN_GLOBAL_CSS_FILE_NAME)
 743
 744 let PLUGIN_EXTERNAL_AUTH_TOKEN_LIFETIME = 1000 * 60 * 5 // 5 minutes
 745
 746 const DEFAULT_THEME_NAME = 'default'
 747 const DEFAULT_USER_THEME_NAME = 'instance-default'
 748
 749 // ---------------------------------------------------------------------------
 750
 751 const SEARCH_INDEX = {
 752   ROUTES: {
 753     VIDEOS: '/api/v1/search/videos',
 754     VIDEO_CHANNELS: '/api/v1/search/video-channels'
 755   }
 756 }
 757
 758 // ---------------------------------------------------------------------------
 759
 760 // Special constants for a test instance
 761 if (isTestInstance() === true) {
 762   PRIVATE_RSA_KEY_SIZE = 1024
 763
 764   ACTOR_FOLLOW_SCORE.BASE = 20
 765
 766   REMOTE_SCHEME.HTTP = 'http'
 767   REMOTE_SCHEME.WS = 'ws'
 768
 769   STATIC_MAX_AGE.SERVER = '0'
 770
 771   ACTIVITY_PUB.COLLECTION_ITEMS_PER_PAGE = 2
 772   ACTIVITY_PUB.ACTOR_REFRESH_INTERVAL = 10 * 1000 // 10 seconds
 773   ACTIVITY_PUB.VIDEO_REFRESH_INTERVAL = 10 * 1000 // 10 seconds
 774   ACTIVITY_PUB.VIDEO_PLAYLIST_REFRESH_INTERVAL = 10 * 1000 // 10 seconds
 775
 776   CONSTRAINTS_FIELDS.ACTORS.IMAGE.FILE_SIZE.max = 100 * 1024 // 100KB
 777   CONSTRAINTS_FIELDS.VIDEOS.IMAGE.FILE_SIZE.max = 400 * 1024 // 400KB
 778
 779   SCHEDULER_INTERVALS_MS.actorFollowScores = 1000
 780   SCHEDULER_INTERVALS_MS.removeOldJobs = 10000
 781   SCHEDULER_INTERVALS_MS.removeOldHistory = 5000
 782   SCHEDULER_INTERVALS_MS.removeOldViews = 5000
 783   SCHEDULER_INTERVALS_MS.updateVideos = 5000
 784   SCHEDULER_INTERVALS_MS.autoFollowIndexInstances = 5000
 785   SCHEDULER_INTERVALS_MS.updateInboxStats = 5000
 786   SCHEDULER_INTERVALS_MS.checkPeerTubeVersion = 2000
 787   REPEAT_JOBS['videos-views'] = { every: 5000 }
 788   REPEAT_JOBS['activitypub-cleaner'] = { every: 5000 }
 789
 790   REDUNDANCY.VIDEOS.RANDOMIZED_FACTOR = 1
 791
 792   VIEW_LIFETIME.VIDEO = 1000 // 1 second
 793   VIEW_LIFETIME.LIVE = 1000 * 5 // 5 second
 794   CONTACT_FORM_LIFETIME = 1000 // 1 second
 795
 796   JOB_ATTEMPTS['email'] = 1
 797
 798   FILES_CACHE.VIDEO_CAPTIONS.MAX_AGE = 3000
 799   MEMOIZE_TTL.OVERVIEWS_SAMPLE = 3000
 800   MEMOIZE_TTL.LIVE_ABLE_TO_UPLOAD = 3000
 801   OVERVIEWS.VIDEOS.SAMPLE_THRESHOLD = 2
 802
 803   PLUGIN_EXTERNAL_AUTH_TOKEN_LIFETIME = 5000
 804
 805   VIDEO_LIVE.CLEANUP_DELAY = 5000
 806   VIDEO_LIVE.SEGMENT_TIME_SECONDS = 2
 807   VIDEO_LIVE.EDGE_LIVE_DELAY_SEGMENTS_NOTIFICATION = 1
 808 }
 809
 810 updateWebserverUrls()
 811 updateWebserverConfig()
 812
 813 registerConfigChangedHandler(() => {
 814   updateWebserverUrls()
 815   updateWebserverConfig()
 816 })
 817
 818 // ---------------------------------------------------------------------------
 819
 820 const FILES_CONTENT_HASH = {
 821   MANIFEST: generateContentHash(),
 822   FAVICON: generateContentHash(),
 823   LOGO: generateContentHash()
 824 }
 825
 826 // ---------------------------------------------------------------------------
 827
 828 export {
 829   WEBSERVER,
 830   API_VERSION,
 831   VIDEO_LIVE,
 832   PEERTUBE_VERSION,
 833   LAZY_STATIC_PATHS,
 834   SEARCH_INDEX,
 835   RESUMABLE_UPLOAD_DIRECTORY,
 836   HLS_REDUNDANCY_DIRECTORY,
 837   P2P_MEDIA_LOADER_PEER_VERSION,
 838   ACTOR_IMAGES_SIZE,
 839   ACCEPT_HEADERS,
 840   BCRYPT_SALT_SIZE,
 841   TRACKER_RATE_LIMITS,
 842   FILES_CACHE,
 843   LOG_FILENAME,
 844   CONSTRAINTS_FIELDS,
 845   EMBED_SIZE,
 846   REDUNDANCY,
 847   JOB_CONCURRENCY,
 848   JOB_ATTEMPTS,
 849   AP_CLEANER_CONCURRENCY,
 850   LAST_MIGRATION_VERSION,
 851   OAUTH_LIFETIME,
 852   CUSTOM_HTML_TAG_COMMENTS,
 853   BROADCAST_CONCURRENCY,
 854   AUDIT_LOG_FILENAME,
 855   PAGINATION,
 856   ACTOR_FOLLOW_SCORE,
 857   PREVIEWS_SIZE,
 858   REMOTE_SCHEME,
 859   FOLLOW_STATES,
 860   DEFAULT_USER_THEME_NAME,
 861   SERVER_ACTOR_NAME,
 862   PLUGIN_GLOBAL_CSS_FILE_NAME,
 863   PLUGIN_GLOBAL_CSS_PATH,
 864   PRIVATE_RSA_KEY_SIZE,
 865   ROUTE_CACHE_LIFETIME,
 866   SORTABLE_COLUMNS,
 867   HLS_STREAMING_PLAYLIST_DIRECTORY,
 868   FEEDS,
 869   JOB_TTL,
 870   DEFAULT_THEME_NAME,
 871   NSFW_POLICY_TYPES,
 872   STATIC_MAX_AGE,
 873   STATIC_PATHS,
 874   VIDEO_IMPORT_TIMEOUT,
 875   VIDEO_PLAYLIST_TYPES,
 876   MAX_LOGS_OUTPUT_CHARACTERS,
 877   ACTIVITY_PUB,
 878   ACTIVITY_PUB_ACTOR_TYPES,
 879   THUMBNAILS_SIZE,
 880   VIDEO_CATEGORIES,
 881   MEMOIZE_LENGTH,
 882   VIDEO_LANGUAGES,
 883   VIDEO_PRIVACIES,
 884   VIDEO_LICENCES,
 885   VIDEO_STATES,
 886   QUEUE_CONCURRENCY,
 887   VIDEO_RATE_TYPES,
 888   JOB_PRIORITY,
 889   VIDEO_TRANSCODING_FPS,
 890   FFMPEG_NICE,
 891   ABUSE_STATES,
 892   VIDEO_CHANNELS,
 893   LRU_CACHE,
 894   REQUEST_TIMEOUT,
 895   USER_PASSWORD_RESET_LIFETIME,
 896   USER_PASSWORD_CREATE_LIFETIME,
 897   MEMOIZE_TTL,
 898   USER_EMAIL_VERIFY_LIFETIME,
 899   OVERVIEWS,
 900   SCHEDULER_INTERVALS_MS,
 901   REPEAT_JOBS,
 902   STATIC_DOWNLOAD_PATHS,
 903   MIMETYPES,
 904   CRAWL_REQUEST_CONCURRENCY,
 905   DEFAULT_AUDIO_RESOLUTION,
 906   JOB_COMPLETED_LIFETIME,
 907   HTTP_SIGNATURE,
 908   VIDEO_IMPORT_STATES,
 909   VIEW_LIFETIME,
 910   CONTACT_FORM_LIFETIME,
 911   VIDEO_PLAYLIST_PRIVACIES,
 912   PLUGIN_EXTERNAL_AUTH_TOKEN_LIFETIME,
 913   ASSETS_PATH,
 914   FILES_CONTENT_HASH,
 915   loadLanguages,
 916   buildLanguages,
 917   generateContentHash
 918 }
 919
 920 // ---------------------------------------------------------------------------
 921
 922 function buildVideoMimetypeExt () {
 923   const data = {
 924     // streamable formats that warrant cross-browser compatibility
 925     'video/webm': '.webm',
 926     // We'll add .ogg if additional extensions are enabled
 927     // We could add .ogg here but since it could be an audio file,
 928     // it would be confusing for users because PeerTube will refuse their file (based on the mimetype)
 929     'video/ogg': [ '.ogv' ],
 930     'video/mp4': '.mp4'
 931   }
 932
 933   if (CONFIG.TRANSCODING.ENABLED) {
 934     if (CONFIG.TRANSCODING.ALLOW_ADDITIONAL_EXTENSIONS) {
 935       data['video/ogg'].push('.ogg')
 936
 937       Object.assign(data, {
 938         'video/x-matroska': '.mkv',
 939
 940         // Developed by Apple
 941         'video/quicktime': [ '.mov', '.qt', '.mqv' ], // often used as output format by editing software
 942         'video/x-m4v': '.m4v',
 943         'video/m4v': '.m4v',
 944
 945         // Developed by the Adobe Flash Platform
 946         'video/x-flv': '.flv',
 947         'video/x-f4v': '.f4v', // replacement for flv
 948
 949         // Developed by Microsoft
 950         'video/x-ms-wmv': '.wmv',
 951         'video/x-msvideo': '.avi',
 952         'video/avi': '.avi',
 953
 954         // Developed by 3GPP
 955         // common video formats for cell phones
 956         'video/3gpp': [ '.3gp', '.3gpp' ],
 957         'video/3gpp2': [ '.3g2', '.3gpp2' ],
 958
 959         // Developed by FFmpeg/Mplayer
 960         'application/x-nut': '.nut',
 961
 962         // The standard video format used by many Sony and Panasonic HD camcorders.
 963         // It is also used for storing high definition video on Blu-ray discs.
 964         'video/mp2t': '.mts',
 965         'video/m2ts': '.m2ts',
 966
 967         // Old formats reliant on MPEG-1/MPEG-2
 968         'video/mpv': '.mpv',
 969         'video/mpeg2': '.m2v',
 970         'video/mpeg': [ '.m1v', '.mpg', '.mpe', '.mpeg', '.vob' ],
 971         'video/dvd': '.vob',
 972
 973         // Could be anything
 974         'application/octet-stream': null,
 975         'application/mxf': '.mxf' // often used as exchange format by editing software
 976       })
 977     }
 978
 979     if (CONFIG.TRANSCODING.ALLOW_AUDIO_FILES) {
 980       Object.assign(data, MIMETYPES.AUDIO.MIMETYPE_EXT)
 981     }
 982   }
 983
 984   return data
 985 }
 986
 987 function updateWebserverUrls () {
 988   WEBSERVER.URL = sanitizeUrl(CONFIG.WEBSERVER.SCHEME + '://' + CONFIG.WEBSERVER.HOSTNAME + ':' + CONFIG.WEBSERVER.PORT)
 989   WEBSERVER.HOST = sanitizeHost(CONFIG.WEBSERVER.HOSTNAME + ':' + CONFIG.WEBSERVER.PORT, REMOTE_SCHEME.HTTP)
 990   WEBSERVER.WS = CONFIG.WEBSERVER.WS
 991
 992   WEBSERVER.SCHEME = CONFIG.WEBSERVER.SCHEME
 993   WEBSERVER.HOSTNAME = CONFIG.WEBSERVER.HOSTNAME
 994   WEBSERVER.PORT = CONFIG.WEBSERVER.PORT
 995
 996   WEBSERVER.RTMP_URL = 'rtmp://' + CONFIG.WEBSERVER.HOSTNAME + ':' + CONFIG.LIVE.RTMP.PORT + '/' + VIDEO_LIVE.RTMP.BASE_PATH
 997 }
 998
 999 function updateWebserverConfig () {
1000   MIMETYPES.VIDEO.MIMETYPE_EXT = buildVideoMimetypeExt()
1001   MIMETYPES.VIDEO.MIMETYPES_REGEX = buildMimetypesRegex(MIMETYPES.VIDEO.MIMETYPE_EXT)
1002
1003   ACTIVITY_PUB.URL_MIME_TYPES.VIDEO = Object.keys(MIMETYPES.VIDEO.MIMETYPE_EXT)
1004
1005   MIMETYPES.VIDEO.EXT_MIMETYPE = buildVideoExtMimetype(MIMETYPES.VIDEO.MIMETYPE_EXT)
1006
1007   CONSTRAINTS_FIELDS.VIDEOS.EXTNAME = Object.keys(MIMETYPES.VIDEO.EXT_MIMETYPE)
1008 }
1009
1010 function buildVideoExtMimetype (obj: { [ id: string ]: string | string[] }) {
1011   const result: { [id: string]: string } = {}
1012
1013   for (const mimetype of Object.keys(obj)) {
1014     const value = obj[mimetype]
1015     if (!value) continue
1016
1017     const extensions = Array.isArray(value) ? value : [ value ]
1018
1019     for (const extension of extensions) {
1020       result[extension] = mimetype
1021     }
1022   }
1023
1024   return result
1025 }
1026
1027 function buildMimetypesRegex (obj: { [id: string]: string | string[] }) {
1028   return Object.keys(obj)
1029     .map(m => `(${m})`)
1030     .join('|')
1031 }
1032
1033 function loadLanguages () {
1034   Object.assign(VIDEO_LANGUAGES, buildLanguages())
1035 }
1036
1037 function buildLanguages () {
1038   const iso639 = require('iso-639-3')
1039
1040   const languages: { [id: string]: string } = {}
1041
1042   const additionalLanguages = {
1043     sgn: true, // Sign languages (macro language)
1044     ase: true, // American sign language
1045     sdl: true, // Arabian sign language
1046     bfi: true, // British sign language
1047     bzs: true, // Brazilian sign language
1048     csl: true, // Chinese sign language
1049     cse: true, // Czech sign language
1050     dsl: true, // Danish sign language
1051     fsl: true, // French sign language
1052     gsg: true, // German sign language
1053     pks: true, // Pakistan sign language
1054     jsl: true, // Japanese sign language
1055     sfs: true, // South African sign language
1056     swl: true, // Swedish sign language
1057     rsl: true, // Russian sign language
1058
1059     kab: true, // Kabyle
1060
1061     lat: true, // Latin
1062
1063     epo: true, // Esperanto
1064     tlh: true, // Klingon
1065     jbo: true, // Lojban
1066     avk: true // Kotava
1067   }
1068
1069   // Only add ISO639-1 languages and some sign languages (ISO639-3)
1070   iso639
1071     .filter(l => {
1072       return (l.iso6391 !== undefined && l.type === 'living') ||
1073         additionalLanguages[l.iso6393] === true
1074     })
1075     .forEach(l => { languages[l.iso6391 || l.iso6393] = l.name })
1076
1077   // Override Occitan label
1078   languages['oc'] = 'Occitan'
1079   languages['el'] = 'Greek'
1080
1081   return languages
1082 }
1083
1084 function generateContentHash () {
1085   return randomBytes(20).toString('hex')
1086 }