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