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