server/initializers/constants.ts

   1 import { IConfig } from 'config'
   2 import { dirname, join } from 'path'
   3 import { JobType, VideoRateType, VideoState, VideosRedundancy } from '../../shared/models'
   4 import { ActivityPubActorType } from '../../shared/models/activitypub'
   5 import { FollowState } from '../../shared/models/actors'
   6 import { VideoAbuseState, VideoImportState, VideoPrivacy, VideoTranscodingFPS } from '../../shared/models/videos'
   7 // Do not use barrels, remain constants as independent as possible
   8 import { buildPath, isTestInstance, parseDuration, parseBytes, root, sanitizeHost, sanitizeUrl } from '../helpers/core-utils'
   9 import { NSFWPolicyType } from '../../shared/models/videos/nsfw-policy.type'
  10 import { invert } from 'lodash'
  11 import { CronRepeatOptions, EveryRepeatOptions } from 'bull'
  12 import * as bytes from 'bytes'
  13 import { VideoPlaylistPrivacy } from '../../shared/models/videos/playlist/video-playlist-privacy.model'
  14 import { VideoPlaylistType } from '../../shared/models/videos/playlist/video-playlist-type.model'
  15
  16 // Use a variable to reload the configuration if we need
  17 let config: IConfig = require('config')
  18
  19 // ---------------------------------------------------------------------------
  20
  21 const LAST_MIGRATION_VERSION = 350
  22
  23 // ---------------------------------------------------------------------------
  24
  25 // API version
  26 const API_VERSION = 'v1'
  27
  28 const PAGINATION = {
  29   COUNT: {
  30     DEFAULT: 15,
  31     MAX: 100
  32   }
  33 }
  34
  35 // Sortable columns per schema
  36 const SORTABLE_COLUMNS = {
  37   USERS: [ 'id', 'username', 'createdAt' ],
  38   USER_SUBSCRIPTIONS: [ 'id', 'createdAt' ],
  39   ACCOUNTS: [ 'createdAt' ],
  40   JOBS: [ 'createdAt' ],
  41   VIDEO_ABUSES: [ 'id', 'createdAt', 'state' ],
  42   VIDEO_CHANNELS: [ 'id', 'name', 'updatedAt', 'createdAt' ],
  43   VIDEO_IMPORTS: [ 'createdAt' ],
  44   VIDEO_COMMENT_THREADS: [ 'createdAt' ],
  45   BLACKLISTS: [ 'id', 'name', 'duration', 'views', 'likes', 'dislikes', 'uuid', 'createdAt' ],
  46   FOLLOWERS: [ 'createdAt' ],
  47   FOLLOWING: [ 'createdAt' ],
  48
  49   VIDEOS: [ 'name', 'duration', 'createdAt', 'publishedAt', 'views', 'likes', 'trending' ],
  50
  51   VIDEOS_SEARCH: [ 'name', 'duration', 'createdAt', 'publishedAt', 'views', 'likes', 'match' ],
  52   VIDEO_CHANNELS_SEARCH: [ 'match', 'displayName', 'createdAt' ],
  53
  54   ACCOUNTS_BLOCKLIST: [ 'createdAt' ],
  55   SERVERS_BLOCKLIST: [ 'createdAt' ],
  56
  57   USER_NOTIFICATIONS: [ 'createdAt' ],
  58
  59   VIDEO_PLAYLISTS: [ 'displayName', 'createdAt', 'updatedAt' ]
  60 }
  61
  62 const OAUTH_LIFETIME = {
  63   ACCESS_TOKEN: 3600 * 24, // 1 day, for upload
  64   REFRESH_TOKEN: 1209600 // 2 weeks
  65 }
  66
  67 const ROUTE_CACHE_LIFETIME = {
  68   FEEDS: '15 minutes',
  69   ROBOTS: '2 hours',
  70   SITEMAP: '1 day',
  71   SECURITYTXT: '2 hours',
  72   NODEINFO: '10 minutes',
  73   DNT_POLICY: '1 week',
  74   OVERVIEWS: {
  75     VIDEOS: '1 hour'
  76   },
  77   ACTIVITY_PUB: {
  78     VIDEOS: '1 second' // 1 second, cache concurrent requests after a broadcast for example
  79   },
  80   STATS: '4 hours'
  81 }
  82
  83 // ---------------------------------------------------------------------------
  84
  85 // Number of points we add/remove after a successful/bad request
  86 const ACTOR_FOLLOW_SCORE = {
  87   PENALTY: -10,
  88   BONUS: 10,
  89   BASE: 1000,
  90   MAX: 10000
  91 }
  92
  93 const FOLLOW_STATES: { [ id: string ]: FollowState } = {
  94   PENDING: 'pending',
  95   ACCEPTED: 'accepted'
  96 }
  97
  98 const REMOTE_SCHEME = {
  99   HTTP: 'https',
 100   WS: 'wss'
 101 }
 102
 103 // TODO: remove 'video-file'
 104 const JOB_ATTEMPTS: { [ id in (JobType | 'video-file') ]: number } = {
 105   'activitypub-http-broadcast': 5,
 106   'activitypub-http-unicast': 5,
 107   'activitypub-http-fetcher': 5,
 108   'activitypub-follow': 5,
 109   'video-file-import': 1,
 110   'video-transcoding': 1,
 111   'video-file': 1,
 112   'video-import': 1,
 113   'email': 5,
 114   'videos-views': 1,
 115   'activitypub-refresher': 1
 116 }
 117 const JOB_CONCURRENCY: { [ id in (JobType | 'video-file') ]: number } = {
 118   'activitypub-http-broadcast': 1,
 119   'activitypub-http-unicast': 5,
 120   'activitypub-http-fetcher': 1,
 121   'activitypub-follow': 3,
 122   'video-file-import': 1,
 123   'video-transcoding': 1,
 124   'video-file': 1,
 125   'video-import': 1,
 126   'email': 5,
 127   'videos-views': 1,
 128   'activitypub-refresher': 1
 129 }
 130 const JOB_TTL: { [ id in (JobType | 'video-file') ]: number } = {
 131   'activitypub-http-broadcast': 60000 * 10, // 10 minutes
 132   'activitypub-http-unicast': 60000 * 10, // 10 minutes
 133   'activitypub-http-fetcher': 60000 * 10, // 10 minutes
 134   'activitypub-follow': 60000 * 10, // 10 minutes
 135   'video-file-import': 1000 * 3600, // 1 hour
 136   'video-transcoding': 1000 * 3600 * 48, // 2 days, transcoding could be long
 137   'video-file': 1000 * 3600 * 48, // 2 days, transcoding could be long
 138   'video-import': 1000 * 3600 * 2, //  hours
 139   'email': 60000 * 10, // 10 minutes
 140   'videos-views': undefined, // Unlimited
 141   'activitypub-refresher': 60000 * 10 // 10 minutes
 142 }
 143 const REPEAT_JOBS: { [ id: string ]: EveryRepeatOptions | CronRepeatOptions } = {
 144   'videos-views': {
 145     cron: '1 * * * *' // At 1 minute past the hour
 146   }
 147 }
 148
 149 const BROADCAST_CONCURRENCY = 10 // How many requests in parallel we do in activitypub-http-broadcast job
 150 const CRAWL_REQUEST_CONCURRENCY = 1 // How many requests in parallel to fetch remote data (likes, shares...)
 151 const JOB_REQUEST_TIMEOUT = 3000 // 3 seconds
 152 const JOB_COMPLETED_LIFETIME = 60000 * 60 * 24 * 2 // 2 days
 153 const VIDEO_IMPORT_TIMEOUT = 1000 * 3600 // 1 hour
 154
 155 // 1 hour
 156 let SCHEDULER_INTERVALS_MS = {
 157   actorFollowScores: 60000 * 60, // 1 hour
 158   removeOldJobs: 60000 * 60, // 1 hour
 159   updateVideos: 60000, // 1 minute
 160   youtubeDLUpdate: 60000 * 60 * 24 // 1 day
 161 }
 162
 163 // ---------------------------------------------------------------------------
 164
 165 const CONFIG = {
 166   CUSTOM_FILE: getLocalConfigFilePath(),
 167   LISTEN: {
 168     PORT: config.get<number>('listen.port'),
 169     HOSTNAME: config.get<string>('listen.hostname')
 170   },
 171   DATABASE: {
 172     DBNAME: 'peertube' + config.get<string>('database.suffix'),
 173     HOSTNAME: config.get<string>('database.hostname'),
 174     PORT: config.get<number>('database.port'),
 175     USERNAME: config.get<string>('database.username'),
 176     PASSWORD: config.get<string>('database.password'),
 177     POOL: {
 178       MAX: config.get<number>('database.pool.max')
 179     }
 180   },
 181   REDIS: {
 182     HOSTNAME: config.has('redis.hostname') ? config.get<string>('redis.hostname') : null,
 183     PORT: config.has('redis.port') ? config.get<number>('redis.port') : null,
 184     SOCKET: config.has('redis.socket') ? config.get<string>('redis.socket') : null,
 185     AUTH: config.has('redis.auth') ? config.get<string>('redis.auth') : null,
 186     DB: config.has('redis.db') ? config.get<number>('redis.db') : null
 187   },
 188   SMTP: {
 189     HOSTNAME: config.get<string>('smtp.hostname'),
 190     PORT: config.get<number>('smtp.port'),
 191     USERNAME: config.get<string>('smtp.username'),
 192     PASSWORD: config.get<string>('smtp.password'),
 193     TLS: config.get<boolean>('smtp.tls'),
 194     DISABLE_STARTTLS: config.get<boolean>('smtp.disable_starttls'),
 195     CA_FILE: config.get<string>('smtp.ca_file'),
 196     FROM_ADDRESS: config.get<string>('smtp.from_address')
 197   },
 198   STORAGE: {
 199     TMP_DIR: buildPath(config.get<string>('storage.tmp')),
 200     AVATARS_DIR: buildPath(config.get<string>('storage.avatars')),
 201     LOG_DIR: buildPath(config.get<string>('storage.logs')),
 202     VIDEOS_DIR: buildPath(config.get<string>('storage.videos')),
 203     STREAMING_PLAYLISTS_DIR: buildPath(config.get<string>('storage.streaming_playlists')),
 204     REDUNDANCY_DIR: buildPath(config.get<string>('storage.redundancy')),
 205     THUMBNAILS_DIR: buildPath(config.get<string>('storage.thumbnails')),
 206     PREVIEWS_DIR: buildPath(config.get<string>('storage.previews')),
 207     CAPTIONS_DIR: buildPath(config.get<string>('storage.captions')),
 208     TORRENTS_DIR: buildPath(config.get<string>('storage.torrents')),
 209     CACHE_DIR: buildPath(config.get<string>('storage.cache'))
 210   },
 211   WEBSERVER: {
 212     SCHEME: config.get<boolean>('webserver.https') === true ? 'https' : 'http',
 213     WS: config.get<boolean>('webserver.https') === true ? 'wss' : 'ws',
 214     HOSTNAME: config.get<string>('webserver.hostname'),
 215     PORT: config.get<number>('webserver.port'),
 216     URL: '',
 217     HOST: ''
 218   },
 219   TRUST_PROXY: config.get<string[]>('trust_proxy'),
 220   LOG: {
 221     LEVEL: config.get<string>('log.level')
 222   },
 223   SEARCH: {
 224     REMOTE_URI: {
 225       USERS: config.get<boolean>('search.remote_uri.users'),
 226       ANONYMOUS: config.get<boolean>('search.remote_uri.anonymous')
 227     }
 228   },
 229   TRENDING: {
 230     VIDEOS: {
 231       INTERVAL_DAYS: config.get<number>('trending.videos.interval_days')
 232     }
 233   },
 234   REDUNDANCY: {
 235     VIDEOS: {
 236       CHECK_INTERVAL: parseDuration(config.get<string>('redundancy.videos.check_interval')),
 237       STRATEGIES: buildVideosRedundancy(config.get<any[]>('redundancy.videos.strategies'))
 238     }
 239   },
 240   CSP: {
 241     ENABLED: config.get<boolean>('csp.enabled'),
 242     REPORT_ONLY: config.get<boolean>('csp.report_only'),
 243     REPORT_URI: config.get<boolean>('csp.report_uri')
 244   },
 245   ADMIN: {
 246     get EMAIL () { return config.get<string>('admin.email') }
 247   },
 248   CONTACT_FORM: {
 249     get ENABLED () { return config.get<boolean>('contact_form.enabled') }
 250   },
 251   SIGNUP: {
 252     get ENABLED () { return config.get<boolean>('signup.enabled') },
 253     get LIMIT () { return config.get<number>('signup.limit') },
 254     get REQUIRES_EMAIL_VERIFICATION () { return config.get<boolean>('signup.requires_email_verification') },
 255     FILTERS: {
 256       CIDR: {
 257         get WHITELIST () { return config.get<string[]>('signup.filters.cidr.whitelist') },
 258         get BLACKLIST () { return config.get<string[]>('signup.filters.cidr.blacklist') }
 259       }
 260     }
 261   },
 262   USER: {
 263     get VIDEO_QUOTA () { return parseBytes(config.get<number>('user.video_quota')) },
 264     get VIDEO_QUOTA_DAILY () { return parseBytes(config.get<number>('user.video_quota_daily')) }
 265   },
 266   TRANSCODING: {
 267     get ENABLED () { return config.get<boolean>('transcoding.enabled') },
 268     get ALLOW_ADDITIONAL_EXTENSIONS () { return config.get<boolean>('transcoding.allow_additional_extensions') },
 269     get THREADS () { return config.get<number>('transcoding.threads') },
 270     RESOLUTIONS: {
 271       get '240p' () { return config.get<boolean>('transcoding.resolutions.240p') },
 272       get '360p' () { return config.get<boolean>('transcoding.resolutions.360p') },
 273       get '480p' () { return config.get<boolean>('transcoding.resolutions.480p') },
 274       get '720p' () { return config.get<boolean>('transcoding.resolutions.720p') },
 275       get '1080p' () { return config.get<boolean>('transcoding.resolutions.1080p') }
 276     },
 277     HLS: {
 278       get ENABLED () { return config.get<boolean>('transcoding.hls.enabled') }
 279     }
 280   },
 281   IMPORT: {
 282     VIDEOS: {
 283       HTTP: {
 284         get ENABLED () { return config.get<boolean>('import.videos.http.enabled') }
 285       },
 286       TORRENT: {
 287         get ENABLED () { return config.get<boolean>('import.videos.torrent.enabled') }
 288       }
 289     }
 290   },
 291   AUTO_BLACKLIST: {
 292     VIDEOS: {
 293       OF_USERS: {
 294         get ENABLED () { return config.get<boolean>('auto_blacklist.videos.of_users.enabled') }
 295       }
 296     }
 297   },
 298   CACHE: {
 299     PREVIEWS: {
 300       get SIZE () { return config.get<number>('cache.previews.size') }
 301     },
 302     VIDEO_CAPTIONS: {
 303       get SIZE () { return config.get<number>('cache.captions.size') }
 304     }
 305   },
 306   INSTANCE: {
 307     get NAME () { return config.get<string>('instance.name') },
 308     get SHORT_DESCRIPTION () { return config.get<string>('instance.short_description') },
 309     get DESCRIPTION () { return config.get<string>('instance.description') },
 310     get TERMS () { return config.get<string>('instance.terms') },
 311     get IS_NSFW () { return config.get<boolean>('instance.is_nsfw') },
 312     get DEFAULT_CLIENT_ROUTE () { return config.get<string>('instance.default_client_route') },
 313     get DEFAULT_NSFW_POLICY () { return config.get<NSFWPolicyType>('instance.default_nsfw_policy') },
 314     CUSTOMIZATIONS: {
 315       get JAVASCRIPT () { return config.get<string>('instance.customizations.javascript') },
 316       get CSS () { return config.get<string>('instance.customizations.css') }
 317     },
 318     get ROBOTS () { return config.get<string>('instance.robots') },
 319     get SECURITYTXT () { return config.get<string>('instance.securitytxt') },
 320     get SECURITYTXT_CONTACT () { return config.get<string>('admin.email') }
 321   },
 322   SERVICES: {
 323     TWITTER: {
 324       get USERNAME () { return config.get<string>('services.twitter.username') },
 325       get WHITELISTED () { return config.get<boolean>('services.twitter.whitelisted') }
 326     }
 327   }
 328 }
 329
 330 // ---------------------------------------------------------------------------
 331
 332 let CONSTRAINTS_FIELDS = {
 333   USERS: {
 334     NAME: { min: 1, max: 120 }, // Length
 335     DESCRIPTION: { min: 3, max: 1000 }, // Length
 336     USERNAME: { min: 1, max: 50 }, // Length
 337     PASSWORD: { min: 6, max: 255 }, // Length
 338     VIDEO_QUOTA: { min: -1 },
 339     VIDEO_QUOTA_DAILY: { min: -1 },
 340     BLOCKED_REASON: { min: 3, max: 250 } // Length
 341   },
 342   VIDEO_ABUSES: {
 343     REASON: { min: 2, max: 3000 }, // Length
 344     MODERATION_COMMENT: { min: 2, max: 3000 } // Length
 345   },
 346   VIDEO_BLACKLIST: {
 347     REASON: { min: 2, max: 300 } // Length
 348   },
 349   VIDEO_CHANNELS: {
 350     NAME: { min: 1, max: 120 }, // Length
 351     DESCRIPTION: { min: 3, max: 1000 }, // Length
 352     SUPPORT: { min: 3, max: 1000 }, // Length
 353     URL: { min: 3, max: 2000 } // Length
 354   },
 355   VIDEO_CAPTIONS: {
 356     CAPTION_FILE: {
 357       EXTNAME: [ '.vtt', '.srt' ],
 358       FILE_SIZE: {
 359         max: 2 * 1024 * 1024 // 2MB
 360       }
 361     }
 362   },
 363   VIDEO_IMPORTS: {
 364     URL: { min: 3, max: 2000 }, // Length
 365     TORRENT_NAME: { min: 3, max: 255 }, // Length
 366     TORRENT_FILE: {
 367       EXTNAME: [ '.torrent' ],
 368       FILE_SIZE: {
 369         max: 1024 * 200 // 200 KB
 370       }
 371     }
 372   },
 373   VIDEOS_REDUNDANCY: {
 374     URL: { min: 3, max: 2000 } // Length
 375   },
 376   VIDEO_RATES: {
 377     URL: { min: 3, max: 2000 } // Length
 378   },
 379   VIDEOS: {
 380     NAME: { min: 3, max: 120 }, // Length
 381     LANGUAGE: { min: 1, max: 10 }, // Length
 382     TRUNCATED_DESCRIPTION: { min: 3, max: 250 }, // Length
 383     DESCRIPTION: { min: 3, max: 10000 }, // Length
 384     SUPPORT: { min: 3, max: 1000 }, // Length
 385     IMAGE: {
 386       EXTNAME: [ '.jpg', '.jpeg' ],
 387       FILE_SIZE: {
 388         max: 2 * 1024 * 1024 // 2MB
 389       }
 390     },
 391     EXTNAME: buildVideosExtname(),
 392     INFO_HASH: { min: 40, max: 40 }, // Length, info hash is 20 bytes length but we represent it in hexadecimal so 20 * 2
 393     DURATION: { min: 0 }, // Number
 394     TAGS: { min: 0, max: 5 }, // Number of total tags
 395     TAG: { min: 2, max: 30 }, // Length
 396     THUMBNAIL: { min: 2, max: 30 },
 397     THUMBNAIL_DATA: { min: 0, max: 20000 }, // Bytes
 398     VIEWS: { min: 0 },
 399     LIKES: { min: 0 },
 400     DISLIKES: { min: 0 },
 401     FILE_SIZE: { min: 10 },
 402     URL: { min: 3, max: 2000 } // Length
 403   },
 404   VIDEO_PLAYLISTS: {
 405     NAME: { min: 1, max: 120 }, // Length
 406     DESCRIPTION: { min: 3, max: 1000 }, // Length
 407     URL: { min: 3, max: 2000 }, // Length
 408     IMAGE: {
 409       EXTNAME: [ '.jpg', '.jpeg' ],
 410       FILE_SIZE: {
 411         max: 2 * 1024 * 1024 // 2MB
 412       }
 413     }
 414   },
 415   ACTORS: {
 416     PUBLIC_KEY: { min: 10, max: 5000 }, // Length
 417     PRIVATE_KEY: { min: 10, max: 5000 }, // Length
 418     URL: { min: 3, max: 2000 }, // Length
 419     AVATAR: {
 420       EXTNAME: [ '.png', '.jpeg', '.jpg' ],
 421       FILE_SIZE: {
 422         max: 2 * 1024 * 1024 // 2MB
 423       }
 424     }
 425   },
 426   VIDEO_EVENTS: {
 427     COUNT: { min: 0 }
 428   },
 429   VIDEO_COMMENTS: {
 430     TEXT: { min: 1, max: 3000 }, // Length
 431     URL: { min: 3, max: 2000 } // Length
 432   },
 433   VIDEO_SHARE: {
 434     URL: { min: 3, max: 2000 } // Length
 435   },
 436   CONTACT_FORM: {
 437     FROM_NAME: { min: 1, max: 120 }, // Length
 438     BODY: { min: 3, max: 5000 } // Length
 439   }
 440 }
 441
 442 const RATES_LIMIT = {
 443   LOGIN: {
 444     WINDOW_MS: 5 * 60 * 1000, // 5 minutes
 445     MAX: 15 // 15 attempts
 446   },
 447   ASK_SEND_EMAIL: {
 448     WINDOW_MS: 5 * 60 * 1000, // 5 minutes
 449     MAX: 3 // 3 attempts
 450   }
 451 }
 452
 453 let VIDEO_VIEW_LIFETIME = 60000 * 60 // 1 hour
 454 let CONTACT_FORM_LIFETIME = 60000 * 60 // 1 hour
 455
 456 const VIDEO_TRANSCODING_FPS: VideoTranscodingFPS = {
 457   MIN: 10,
 458   AVERAGE: 30,
 459   MAX: 60,
 460   KEEP_ORIGIN_FPS_RESOLUTION_MIN: 720 // We keep the original FPS on high resolutions (720 minimum)
 461 }
 462
 463 const VIDEO_RATE_TYPES: { [ id: string ]: VideoRateType } = {
 464   LIKE: 'like',
 465   DISLIKE: 'dislike'
 466 }
 467
 468 const FFMPEG_NICE: { [ id: string ]: number } = {
 469   THUMBNAIL: 2, // 2 just for don't blocking servers
 470   TRANSCODING: 15
 471 }
 472
 473 const VIDEO_CATEGORIES = {
 474   1: 'Music',
 475   2: 'Films',
 476   3: 'Vehicles',
 477   4: 'Art',
 478   5: 'Sports',
 479   6: 'Travels',
 480   7: 'Gaming',
 481   8: 'People',
 482   9: 'Comedy',
 483   10: 'Entertainment',
 484   11: 'News & Politics',
 485   12: 'How To',
 486   13: 'Education',
 487   14: 'Activism',
 488   15: 'Science & Technology',
 489   16: 'Animals',
 490   17: 'Kids',
 491   18: 'Food'
 492 }
 493
 494 // See https://creativecommons.org/licenses/?lang=en
 495 const VIDEO_LICENCES = {
 496   1: 'Attribution',
 497   2: 'Attribution - Share Alike',
 498   3: 'Attribution - No Derivatives',
 499   4: 'Attribution - Non Commercial',
 500   5: 'Attribution - Non Commercial - Share Alike',
 501   6: 'Attribution - Non Commercial - No Derivatives',
 502   7: 'Public Domain Dedication'
 503 }
 504
 505 const VIDEO_LANGUAGES = buildLanguages()
 506
 507 const VIDEO_PRIVACIES = {
 508   [VideoPrivacy.PUBLIC]: 'Public',
 509   [VideoPrivacy.UNLISTED]: 'Unlisted',
 510   [VideoPrivacy.PRIVATE]: 'Private'
 511 }
 512
 513 const VIDEO_STATES = {
 514   [VideoState.PUBLISHED]: 'Published',
 515   [VideoState.TO_TRANSCODE]: 'To transcode',
 516   [VideoState.TO_IMPORT]: 'To import'
 517 }
 518
 519 const VIDEO_IMPORT_STATES = {
 520   [VideoImportState.FAILED]: 'Failed',
 521   [VideoImportState.PENDING]: 'Pending',
 522   [VideoImportState.SUCCESS]: 'Success'
 523 }
 524
 525 const VIDEO_ABUSE_STATES = {
 526   [VideoAbuseState.PENDING]: 'Pending',
 527   [VideoAbuseState.REJECTED]: 'Rejected',
 528   [VideoAbuseState.ACCEPTED]: 'Accepted'
 529 }
 530
 531 const VIDEO_PLAYLIST_PRIVACIES = {
 532   [VideoPlaylistPrivacy.PUBLIC]: 'Public',
 533   [VideoPlaylistPrivacy.UNLISTED]: 'Unlisted',
 534   [VideoPlaylistPrivacy.PRIVATE]: 'Private'
 535 }
 536
 537 const VIDEO_PLAYLIST_TYPES = {
 538   [VideoPlaylistType.REGULAR]: 'Regular',
 539   [VideoPlaylistType.WATCH_LATER]: 'Watch later'
 540 }
 541
 542 const MIMETYPES = {
 543   VIDEO: {
 544     MIMETYPE_EXT: buildVideoMimetypeExt(),
 545     EXT_MIMETYPE: null as { [ id: string ]: string }
 546   },
 547   IMAGE: {
 548     MIMETYPE_EXT: {
 549       'image/png': '.png',
 550       'image/jpg': '.jpg',
 551       'image/jpeg': '.jpg'
 552     }
 553   },
 554   VIDEO_CAPTIONS: {
 555     MIMETYPE_EXT: {
 556       'text/vtt': '.vtt',
 557       'application/x-subrip': '.srt'
 558     }
 559   },
 560   TORRENT: {
 561     MIMETYPE_EXT: {
 562       'application/x-bittorrent': '.torrent'
 563     }
 564   }
 565 }
 566 MIMETYPES.VIDEO.EXT_MIMETYPE = invert(MIMETYPES.VIDEO.MIMETYPE_EXT)
 567
 568 // ---------------------------------------------------------------------------
 569
 570 const OVERVIEWS = {
 571   VIDEOS: {
 572     SAMPLE_THRESHOLD: 6,
 573     SAMPLES_COUNT: 2
 574   }
 575 }
 576
 577 // ---------------------------------------------------------------------------
 578
 579 const SERVER_ACTOR_NAME = 'peertube'
 580
 581 const ACTIVITY_PUB = {
 582   POTENTIAL_ACCEPT_HEADERS: [
 583     'application/activity+json',
 584     'application/ld+json',
 585     'application/ld+json; profile="https://www.w3.org/ns/activitystreams"'
 586   ],
 587   ACCEPT_HEADER: 'application/activity+json, application/ld+json',
 588   PUBLIC: 'https://www.w3.org/ns/activitystreams#Public',
 589   COLLECTION_ITEMS_PER_PAGE: 10,
 590   FETCH_PAGE_LIMIT: 100,
 591   URL_MIME_TYPES: {
 592     VIDEO: Object.keys(MIMETYPES.VIDEO.MIMETYPE_EXT),
 593     TORRENT: [ 'application/x-bittorrent' ],
 594     MAGNET: [ 'application/x-bittorrent;x-scheme-handler/magnet' ]
 595   },
 596   MAX_RECURSION_COMMENTS: 100,
 597   ACTOR_REFRESH_INTERVAL: 3600 * 24 * 1000 * 2, // 2 days
 598   VIDEO_REFRESH_INTERVAL: 3600 * 24 * 1000 * 2, // 2 days
 599   VIDEO_PLAYLIST_REFRESH_INTERVAL: 3600 * 24 * 1000 * 2 // 2 days
 600 }
 601
 602 const ACTIVITY_PUB_ACTOR_TYPES: { [ id: string ]: ActivityPubActorType } = {
 603   GROUP: 'Group',
 604   PERSON: 'Person',
 605   APPLICATION: 'Application'
 606 }
 607
 608 const HTTP_SIGNATURE = {
 609   HEADER_NAME: 'signature',
 610   ALGORITHM: 'rsa-sha256',
 611   HEADERS_TO_SIGN: [ '(request-target)', 'host', 'date', 'digest' ]
 612 }
 613
 614 // ---------------------------------------------------------------------------
 615
 616 let PRIVATE_RSA_KEY_SIZE = 2048
 617
 618 // Password encryption
 619 const BCRYPT_SALT_SIZE = 10
 620
 621 const USER_PASSWORD_RESET_LIFETIME = 60000 * 5 // 5 minutes
 622
 623 const USER_EMAIL_VERIFY_LIFETIME = 60000 * 60 // 60 minutes
 624
 625 const NSFW_POLICY_TYPES: { [ id: string]: NSFWPolicyType } = {
 626   DO_NOT_LIST: 'do_not_list',
 627   BLUR: 'blur',
 628   DISPLAY: 'display'
 629 }
 630
 631 // ---------------------------------------------------------------------------
 632
 633 // Express static paths (router)
 634 const STATIC_PATHS = {
 635   PREVIEWS: '/static/previews/',
 636   THUMBNAILS: '/static/thumbnails/',
 637   TORRENTS: '/static/torrents/',
 638   WEBSEED: '/static/webseed/',
 639   REDUNDANCY: '/static/redundancy/',
 640   STREAMING_PLAYLISTS: {
 641     HLS: '/static/streaming-playlists/hls'
 642   },
 643   AVATARS: '/static/avatars/',
 644   VIDEO_CAPTIONS: '/static/video-captions/'
 645 }
 646 const STATIC_DOWNLOAD_PATHS = {
 647   TORRENTS: '/download/torrents/',
 648   VIDEOS: '/download/videos/'
 649 }
 650
 651 // Cache control
 652 let STATIC_MAX_AGE = '2h'
 653
 654 // Videos thumbnail size
 655 const THUMBNAILS_SIZE = {
 656   width: 223,
 657   height: 122
 658 }
 659 const PREVIEWS_SIZE = {
 660   width: 560,
 661   height: 315
 662 }
 663 const AVATARS_SIZE = {
 664   width: 120,
 665   height: 120
 666 }
 667
 668 const EMBED_SIZE = {
 669   width: 560,
 670   height: 315
 671 }
 672
 673 // Sub folders of cache directory
 674 const FILES_CACHE = {
 675   PREVIEWS: {
 676     DIRECTORY: join(CONFIG.STORAGE.CACHE_DIR, 'previews'),
 677     MAX_AGE: 1000 * 3600 * 3 // 3 hours
 678   },
 679   VIDEO_CAPTIONS: {
 680     DIRECTORY: join(CONFIG.STORAGE.CACHE_DIR, 'video-captions'),
 681     MAX_AGE: 1000 * 3600 * 3 // 3 hours
 682   }
 683 }
 684
 685 const CACHE = {
 686   USER_TOKENS: {
 687     MAX_SIZE: 10000
 688   }
 689 }
 690
 691 const HLS_STREAMING_PLAYLIST_DIRECTORY = join(CONFIG.STORAGE.STREAMING_PLAYLISTS_DIR, 'hls')
 692 const HLS_REDUNDANCY_DIRECTORY = join(CONFIG.STORAGE.REDUNDANCY_DIR, 'hls')
 693
 694 const MEMOIZE_TTL = {
 695   OVERVIEWS_SAMPLE: 1000 * 3600 * 4 // 4 hours
 696 }
 697
 698 const REDUNDANCY = {
 699   VIDEOS: {
 700     RANDOMIZED_FACTOR: 5
 701   }
 702 }
 703
 704 const ACCEPT_HEADERS = [ 'html', 'application/json' ].concat(ACTIVITY_PUB.POTENTIAL_ACCEPT_HEADERS)
 705
 706 // ---------------------------------------------------------------------------
 707
 708 const CUSTOM_HTML_TAG_COMMENTS = {
 709   TITLE: '<!-- title tag -->',
 710   DESCRIPTION: '<!-- description tag -->',
 711   CUSTOM_CSS: '<!-- custom css tag -->',
 712   META_TAGS: '<!-- meta tags -->'
 713 }
 714
 715 // ---------------------------------------------------------------------------
 716
 717 const FEEDS = {
 718   COUNT: 20
 719 }
 720
 721 // ---------------------------------------------------------------------------
 722
 723 const TRACKER_RATE_LIMITS = {
 724   INTERVAL: 60000 * 5, // 5 minutes
 725   ANNOUNCES_PER_IP_PER_INFOHASH: 15, // maximum announces per torrent in the interval
 726   ANNOUNCES_PER_IP: 30 // maximum announces for all our torrents in the interval
 727 }
 728
 729 // ---------------------------------------------------------------------------
 730
 731 // Special constants for a test instance
 732 if (isTestInstance() === true) {
 733   PRIVATE_RSA_KEY_SIZE = 1024
 734
 735   ACTOR_FOLLOW_SCORE.BASE = 20
 736
 737   REMOTE_SCHEME.HTTP = 'http'
 738   REMOTE_SCHEME.WS = 'ws'
 739
 740   STATIC_MAX_AGE = '0'
 741
 742   ACTIVITY_PUB.COLLECTION_ITEMS_PER_PAGE = 2
 743   ACTIVITY_PUB.ACTOR_REFRESH_INTERVAL = 10 * 1000 // 10 seconds
 744   ACTIVITY_PUB.VIDEO_REFRESH_INTERVAL = 10 * 1000 // 10 seconds
 745   ACTIVITY_PUB.VIDEO_PLAYLIST_REFRESH_INTERVAL = 10 * 1000 // 10 seconds
 746
 747   CONSTRAINTS_FIELDS.ACTORS.AVATAR.FILE_SIZE.max = 100 * 1024 // 100KB
 748
 749   SCHEDULER_INTERVALS_MS.actorFollowScores = 1000
 750   SCHEDULER_INTERVALS_MS.removeOldJobs = 10000
 751   SCHEDULER_INTERVALS_MS.updateVideos = 5000
 752   REPEAT_JOBS['videos-views'] = { every: 5000 }
 753
 754   REDUNDANCY.VIDEOS.RANDOMIZED_FACTOR = 1
 755
 756   VIDEO_VIEW_LIFETIME = 1000 // 1 second
 757   CONTACT_FORM_LIFETIME = 1000 // 1 second
 758
 759   JOB_ATTEMPTS['email'] = 1
 760
 761   FILES_CACHE.VIDEO_CAPTIONS.MAX_AGE = 3000
 762   MEMOIZE_TTL.OVERVIEWS_SAMPLE = 1
 763   ROUTE_CACHE_LIFETIME.OVERVIEWS.VIDEOS = '0ms'
 764
 765   RATES_LIMIT.LOGIN.MAX = 20
 766 }
 767
 768 updateWebserverUrls()
 769
 770 // ---------------------------------------------------------------------------
 771
 772 export {
 773   API_VERSION,
 774   HLS_REDUNDANCY_DIRECTORY,
 775   AVATARS_SIZE,
 776   ACCEPT_HEADERS,
 777   BCRYPT_SALT_SIZE,
 778   TRACKER_RATE_LIMITS,
 779   FILES_CACHE,
 780   CONFIG,
 781   CONSTRAINTS_FIELDS,
 782   EMBED_SIZE,
 783   REDUNDANCY,
 784   JOB_CONCURRENCY,
 785   JOB_ATTEMPTS,
 786   LAST_MIGRATION_VERSION,
 787   OAUTH_LIFETIME,
 788   CUSTOM_HTML_TAG_COMMENTS,
 789   BROADCAST_CONCURRENCY,
 790   PAGINATION,
 791   ACTOR_FOLLOW_SCORE,
 792   PREVIEWS_SIZE,
 793   REMOTE_SCHEME,
 794   FOLLOW_STATES,
 795   SERVER_ACTOR_NAME,
 796   PRIVATE_RSA_KEY_SIZE,
 797   ROUTE_CACHE_LIFETIME,
 798   SORTABLE_COLUMNS,
 799   HLS_STREAMING_PLAYLIST_DIRECTORY,
 800   FEEDS,
 801   JOB_TTL,
 802   NSFW_POLICY_TYPES,
 803   STATIC_MAX_AGE,
 804   STATIC_PATHS,
 805   VIDEO_IMPORT_TIMEOUT,
 806   VIDEO_PLAYLIST_TYPES,
 807   ACTIVITY_PUB,
 808   ACTIVITY_PUB_ACTOR_TYPES,
 809   THUMBNAILS_SIZE,
 810   VIDEO_CATEGORIES,
 811   VIDEO_LANGUAGES,
 812   VIDEO_PRIVACIES,
 813   VIDEO_LICENCES,
 814   VIDEO_STATES,
 815   VIDEO_RATE_TYPES,
 816   VIDEO_TRANSCODING_FPS,
 817   FFMPEG_NICE,
 818   VIDEO_ABUSE_STATES,
 819   CACHE,
 820   JOB_REQUEST_TIMEOUT,
 821   USER_PASSWORD_RESET_LIFETIME,
 822   MEMOIZE_TTL,
 823   USER_EMAIL_VERIFY_LIFETIME,
 824   OVERVIEWS,
 825   SCHEDULER_INTERVALS_MS,
 826   REPEAT_JOBS,
 827   STATIC_DOWNLOAD_PATHS,
 828   RATES_LIMIT,
 829   MIMETYPES,
 830   CRAWL_REQUEST_CONCURRENCY,
 831   JOB_COMPLETED_LIFETIME,
 832   HTTP_SIGNATURE,
 833   VIDEO_IMPORT_STATES,
 834   VIDEO_VIEW_LIFETIME,
 835   CONTACT_FORM_LIFETIME,
 836   VIDEO_PLAYLIST_PRIVACIES,
 837   buildLanguages
 838 }
 839
 840 // ---------------------------------------------------------------------------
 841
 842 function getLocalConfigFilePath () {
 843   const configSources = config.util.getConfigSources()
 844   if (configSources.length === 0) throw new Error('Invalid config source.')
 845
 846   let filename = 'local'
 847   if (process.env.NODE_ENV) filename += `-${process.env.NODE_ENV}`
 848   if (process.env.NODE_APP_INSTANCE) filename += `-${process.env.NODE_APP_INSTANCE}`
 849
 850   return join(dirname(configSources[ 0 ].name), filename + '.json')
 851 }
 852
 853 function buildVideoMimetypeExt () {
 854   const data = {
 855     'video/webm': '.webm',
 856     'video/ogg': '.ogv',
 857     'video/mp4': '.mp4'
 858   }
 859
 860   if (CONFIG.TRANSCODING.ENABLED && CONFIG.TRANSCODING.ALLOW_ADDITIONAL_EXTENSIONS) {
 861     Object.assign(data, {
 862       'video/quicktime': '.mov',
 863       'video/x-msvideo': '.avi',
 864       'video/x-flv': '.flv',
 865       'video/x-matroska': '.mkv',
 866       'application/octet-stream': '.mkv',
 867       'video/avi': '.avi'
 868     })
 869   }
 870
 871   return data
 872 }
 873
 874 function updateWebserverUrls () {
 875   CONFIG.WEBSERVER.URL = sanitizeUrl(CONFIG.WEBSERVER.SCHEME + '://' + CONFIG.WEBSERVER.HOSTNAME + ':' + CONFIG.WEBSERVER.PORT)
 876   CONFIG.WEBSERVER.HOST = sanitizeHost(CONFIG.WEBSERVER.HOSTNAME + ':' + CONFIG.WEBSERVER.PORT, REMOTE_SCHEME.HTTP)
 877 }
 878
 879 function updateWebserverConfig () {
 880   CONSTRAINTS_FIELDS.VIDEOS.EXTNAME = buildVideosExtname()
 881
 882   MIMETYPES.VIDEO.MIMETYPE_EXT = buildVideoMimetypeExt()
 883   MIMETYPES.VIDEO.EXT_MIMETYPE = invert(MIMETYPES.VIDEO.MIMETYPE_EXT)
 884 }
 885
 886 function buildVideosExtname () {
 887   return CONFIG.TRANSCODING.ENABLED && CONFIG.TRANSCODING.ALLOW_ADDITIONAL_EXTENSIONS
 888     ? [ '.mp4', '.ogv', '.webm', '.mkv', '.mov', '.avi', '.flv' ]
 889     : [ '.mp4', '.ogv', '.webm' ]
 890 }
 891
 892 function buildVideosRedundancy (objs: any[]): VideosRedundancy[] {
 893   if (!objs) return []
 894
 895   if (!Array.isArray(objs)) return objs
 896
 897   return objs.map(obj => {
 898     return Object.assign({}, obj, {
 899       minLifetime: parseDuration(obj.min_lifetime),
 900       size: bytes.parse(obj.size),
 901       minViews: obj.min_views
 902     })
 903   })
 904 }
 905
 906 function buildLanguages () {
 907   const iso639 = require('iso-639-3')
 908
 909   const languages: { [ id: string ]: string } = {}
 910
 911   const additionalLanguages = {
 912     'sgn': true, // Sign languages (macro language)
 913     'ase': true, // American sign language
 914     'sdl': true, // Arabian sign language
 915     'bfi': true, // British sign language
 916     'bzs': true, // Brazilian sign language
 917     'csl': true, // Chinese sign language
 918     'cse': true, // Czech sign language
 919     'dsl': true, // Danish sign language
 920     'fsl': true, // French sign language
 921     'gsg': true, // German sign language
 922     'pks': true, // Pakistan sign language
 923     'jsl': true, // Japanese sign language
 924     'sfs': true, // South African sign language
 925     'swl': true, // Swedish sign language
 926     'rsl': true, // Russian sign language: true
 927
 928     'epo': true, // Esperanto
 929     'tlh': true, // Klingon
 930     'jbo': true, // Lojban
 931     'avk': true // Kotava
 932   }
 933
 934   // Only add ISO639-1 languages and some sign languages (ISO639-3)
 935   iso639
 936     .filter(l => {
 937       return (l.iso6391 !== null && l.type === 'living') ||
 938         additionalLanguages[l.iso6393] === true
 939     })
 940     .forEach(l => languages[l.iso6391 || l.iso6393] = l.name)
 941
 942   // Override Occitan label
 943   languages['oc'] = 'Occitan'
 944
 945   return languages
 946 }
 947
 948 export function reloadConfig () {
 949
 950   function directory () {
 951     if (process.env.NODE_CONFIG_DIR) {
 952       return process.env.NODE_CONFIG_DIR
 953     }
 954
 955     return join(root(), 'config')
 956   }
 957
 958   function purge () {
 959     for (const fileName in require.cache) {
 960       if (-1 === fileName.indexOf(directory())) {
 961         continue
 962       }
 963
 964       delete require.cache[fileName]
 965     }
 966
 967     delete require.cache[require.resolve('config')]
 968   }
 969
 970   purge()
 971
 972   config = require('config')
 973
 974   updateWebserverConfig()
 975   updateWebserverUrls()
 976 }