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