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 = 310
  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   SIGNUP: {
 235     get ENABLED () { return config.get<boolean>('signup.enabled') },
 236     get LIMIT () { return config.get<number>('signup.limit') },
 237     get REQUIRES_EMAIL_VERIFICATION () { return config.get<boolean>('signup.requires_email_verification') },
 238     FILTERS: {
 239       CIDR: {
 240         get WHITELIST () { return config.get<string[]>('signup.filters.cidr.whitelist') },
 241         get BLACKLIST () { return config.get<string[]>('signup.filters.cidr.blacklist') }
 242       }
 243     }
 244   },
 245   USER: {
 246     get VIDEO_QUOTA () { return parseBytes(config.get<number>('user.video_quota')) },
 247     get VIDEO_QUOTA_DAILY () { return parseBytes(config.get<number>('user.video_quota_daily')) }
 248   },
 249   TRANSCODING: {
 250     get ENABLED () { return config.get<boolean>('transcoding.enabled') },
 251     get ALLOW_ADDITIONAL_EXTENSIONS () { return config.get<boolean>('transcoding.allow_additional_extensions') },
 252     get THREADS () { return config.get<number>('transcoding.threads') },
 253     RESOLUTIONS: {
 254       get '240p' () { return config.get<boolean>('transcoding.resolutions.240p') },
 255       get '360p' () { return config.get<boolean>('transcoding.resolutions.360p') },
 256       get '480p' () { return config.get<boolean>('transcoding.resolutions.480p') },
 257       get '720p' () { return config.get<boolean>('transcoding.resolutions.720p') },
 258       get '1080p' () { return config.get<boolean>('transcoding.resolutions.1080p') }
 259     }
 260   },
 261   IMPORT: {
 262     VIDEOS: {
 263       HTTP: {
 264         get ENABLED () { return config.get<boolean>('import.videos.http.enabled') }
 265       },
 266       TORRENT: {
 267         get ENABLED () { return config.get<boolean>('import.videos.torrent.enabled') }
 268       }
 269     }
 270   },
 271   CACHE: {
 272     PREVIEWS: {
 273       get SIZE () { return config.get<number>('cache.previews.size') }
 274     },
 275     VIDEO_CAPTIONS: {
 276       get SIZE () { return config.get<number>('cache.captions.size') }
 277     }
 278   },
 279   INSTANCE: {
 280     get NAME () { return config.get<string>('instance.name') },
 281     get SHORT_DESCRIPTION () { return config.get<string>('instance.short_description') },
 282     get DESCRIPTION () { return config.get<string>('instance.description') },
 283     get TERMS () { return config.get<string>('instance.terms') },
 284     get DEFAULT_CLIENT_ROUTE () { return config.get<string>('instance.default_client_route') },
 285     get DEFAULT_NSFW_POLICY () { return config.get<NSFWPolicyType>('instance.default_nsfw_policy') },
 286     CUSTOMIZATIONS: {
 287       get JAVASCRIPT () { return config.get<string>('instance.customizations.javascript') },
 288       get CSS () { return config.get<string>('instance.customizations.css') }
 289     },
 290     get ROBOTS () { return config.get<string>('instance.robots') },
 291     get SECURITYTXT () { return config.get<string>('instance.securitytxt') },
 292     get SECURITYTXT_CONTACT () { return config.get<string>('admin.email') }
 293   },
 294   SERVICES: {
 295     get 'CSP-LOGGER' () { return config.get<string>('services.csp-logger') },
 296     TWITTER: {
 297       get USERNAME () { return config.get<string>('services.twitter.username') },
 298       get WHITELISTED () { return config.get<boolean>('services.twitter.whitelisted') }
 299     }
 300   }
 301 }
 302
 303 // ---------------------------------------------------------------------------
 304
 305 let CONSTRAINTS_FIELDS = {
 306   USERS: {
 307     NAME: { min: 1, max: 120 }, // Length
 308     DESCRIPTION: { min: 3, max: 1000 }, // Length
 309     USERNAME: { min: 1, max: 50 }, // Length
 310     PASSWORD: { min: 6, max: 255 }, // Length
 311     VIDEO_QUOTA: { min: -1 },
 312     VIDEO_QUOTA_DAILY: { min: -1 },
 313     BLOCKED_REASON: { min: 3, max: 250 } // Length
 314   },
 315   VIDEO_ABUSES: {
 316     REASON: { min: 2, max: 300 }, // Length
 317     MODERATION_COMMENT: { min: 2, max: 300 } // Length
 318   },
 319   VIDEO_BLACKLIST: {
 320     REASON: { min: 2, max: 300 } // Length
 321   },
 322   VIDEO_CHANNELS: {
 323     NAME: { min: 1, max: 120 }, // Length
 324     DESCRIPTION: { min: 3, max: 1000 }, // Length
 325     SUPPORT: { min: 3, max: 1000 }, // Length
 326     URL: { min: 3, max: 2000 } // Length
 327   },
 328   VIDEO_CAPTIONS: {
 329     CAPTION_FILE: {
 330       EXTNAME: [ '.vtt', '.srt' ],
 331       FILE_SIZE: {
 332         max: 2 * 1024 * 1024 // 2MB
 333       }
 334     }
 335   },
 336   VIDEO_IMPORTS: {
 337     URL: { min: 3, max: 2000 }, // Length
 338     TORRENT_NAME: { min: 3, max: 255 }, // Length
 339     TORRENT_FILE: {
 340       EXTNAME: [ '.torrent' ],
 341       FILE_SIZE: {
 342         max: 1024 * 200 // 200 KB
 343       }
 344     }
 345   },
 346   VIDEOS_REDUNDANCY: {
 347     URL: { min: 3, max: 2000 } // Length
 348   },
 349   VIDEO_RATES: {
 350     URL: { min: 3, max: 2000 } // Length
 351   },
 352   VIDEOS: {
 353     NAME: { min: 3, max: 120 }, // Length
 354     LANGUAGE: { min: 1, max: 10 }, // Length
 355     TRUNCATED_DESCRIPTION: { min: 3, max: 250 }, // Length
 356     DESCRIPTION: { min: 3, max: 10000 }, // Length
 357     SUPPORT: { min: 3, max: 1000 }, // Length
 358     IMAGE: {
 359       EXTNAME: [ '.jpg', '.jpeg' ],
 360       FILE_SIZE: {
 361         max: 2 * 1024 * 1024 // 2MB
 362       }
 363     },
 364     EXTNAME: buildVideosExtname(),
 365     INFO_HASH: { min: 40, max: 40 }, // Length, info hash is 20 bytes length but we represent it in hexadecimal so 20 * 2
 366     DURATION: { min: 0 }, // Number
 367     TAGS: { min: 0, max: 5 }, // Number of total tags
 368     TAG: { min: 2, max: 30 }, // Length
 369     THUMBNAIL: { min: 2, max: 30 },
 370     THUMBNAIL_DATA: { min: 0, max: 20000 }, // Bytes
 371     VIEWS: { min: 0 },
 372     LIKES: { min: 0 },
 373     DISLIKES: { min: 0 },
 374     FILE_SIZE: { min: 10 },
 375     URL: { min: 3, max: 2000 } // Length
 376   },
 377   ACTORS: {
 378     PUBLIC_KEY: { min: 10, max: 5000 }, // Length
 379     PRIVATE_KEY: { min: 10, max: 5000 }, // Length
 380     URL: { min: 3, max: 2000 }, // Length
 381     AVATAR: {
 382       EXTNAME: [ '.png', '.jpeg', '.jpg' ],
 383       FILE_SIZE: {
 384         max: 2 * 1024 * 1024 // 2MB
 385       }
 386     }
 387   },
 388   VIDEO_EVENTS: {
 389     COUNT: { min: 0 }
 390   },
 391   VIDEO_COMMENTS: {
 392     TEXT: { min: 1, max: 3000 }, // Length
 393     URL: { min: 3, max: 2000 } // Length
 394   },
 395   VIDEO_SHARE: {
 396     URL: { min: 3, max: 2000 } // Length
 397   }
 398 }
 399
 400 const RATES_LIMIT = {
 401   LOGIN: {
 402     WINDOW_MS: 5 * 60 * 1000, // 5 minutes
 403     MAX: 15 // 15 attempts
 404   },
 405   ASK_SEND_EMAIL: {
 406     WINDOW_MS: 5 * 60 * 1000, // 5 minutes
 407     MAX: 3 // 3 attempts
 408   }
 409 }
 410
 411 let VIDEO_VIEW_LIFETIME = 60000 * 60 // 1 hour
 412 const VIDEO_TRANSCODING_FPS: VideoTranscodingFPS = {
 413   MIN: 10,
 414   AVERAGE: 30,
 415   MAX: 60,
 416   KEEP_ORIGIN_FPS_RESOLUTION_MIN: 720 // We keep the original FPS on high resolutions (720 minimum)
 417 }
 418
 419 const VIDEO_RATE_TYPES: { [ id: string ]: VideoRateType } = {
 420   LIKE: 'like',
 421   DISLIKE: 'dislike'
 422 }
 423
 424 const FFMPEG_NICE: { [ id: string ]: number } = {
 425   THUMBNAIL: 2, // 2 just for don't blocking servers
 426   TRANSCODING: 15
 427 }
 428
 429 const VIDEO_CATEGORIES = {
 430   1: 'Music',
 431   2: 'Films',
 432   3: 'Vehicles',
 433   4: 'Art',
 434   5: 'Sports',
 435   6: 'Travels',
 436   7: 'Gaming',
 437   8: 'People',
 438   9: 'Comedy',
 439   10: 'Entertainment',
 440   11: 'News & Politics',
 441   12: 'How To',
 442   13: 'Education',
 443   14: 'Activism',
 444   15: 'Science & Technology',
 445   16: 'Animals',
 446   17: 'Kids',
 447   18: 'Food'
 448 }
 449
 450 // See https://creativecommons.org/licenses/?lang=en
 451 const VIDEO_LICENCES = {
 452   1: 'Attribution',
 453   2: 'Attribution - Share Alike',
 454   3: 'Attribution - No Derivatives',
 455   4: 'Attribution - Non Commercial',
 456   5: 'Attribution - Non Commercial - Share Alike',
 457   6: 'Attribution - Non Commercial - No Derivatives',
 458   7: 'Public Domain Dedication'
 459 }
 460
 461 const VIDEO_LANGUAGES = buildLanguages()
 462
 463 const VIDEO_PRIVACIES = {
 464   [VideoPrivacy.PUBLIC]: 'Public',
 465   [VideoPrivacy.UNLISTED]: 'Unlisted',
 466   [VideoPrivacy.PRIVATE]: 'Private'
 467 }
 468
 469 const VIDEO_STATES = {
 470   [VideoState.PUBLISHED]: 'Published',
 471   [VideoState.TO_TRANSCODE]: 'To transcode',
 472   [VideoState.TO_IMPORT]: 'To import'
 473 }
 474
 475 const VIDEO_IMPORT_STATES = {
 476   [VideoImportState.FAILED]: 'Failed',
 477   [VideoImportState.PENDING]: 'Pending',
 478   [VideoImportState.SUCCESS]: 'Success'
 479 }
 480
 481 const VIDEO_ABUSE_STATES = {
 482   [VideoAbuseState.PENDING]: 'Pending',
 483   [VideoAbuseState.REJECTED]: 'Rejected',
 484   [VideoAbuseState.ACCEPTED]: 'Accepted'
 485 }
 486
 487 const MIMETYPES = {
 488   VIDEO: {
 489     MIMETYPE_EXT: buildVideoMimetypeExt(),
 490     EXT_MIMETYPE: null as { [ id: string ]: string }
 491   },
 492   IMAGE: {
 493     MIMETYPE_EXT: {
 494       'image/png': '.png',
 495       'image/jpg': '.jpg',
 496       'image/jpeg': '.jpg'
 497     }
 498   },
 499   VIDEO_CAPTIONS: {
 500     MIMETYPE_EXT: {
 501       'text/vtt': '.vtt',
 502       'application/x-subrip': '.srt'
 503     }
 504   },
 505   TORRENT: {
 506     MIMETYPE_EXT: {
 507       'application/x-bittorrent': '.torrent'
 508     }
 509   }
 510 }
 511 MIMETYPES.VIDEO.EXT_MIMETYPE = invert(MIMETYPES.VIDEO.MIMETYPE_EXT)
 512
 513 // ---------------------------------------------------------------------------
 514
 515 const OVERVIEWS = {
 516   VIDEOS: {
 517     SAMPLE_THRESHOLD: 6,
 518     SAMPLES_COUNT: 2
 519   }
 520 }
 521
 522 // ---------------------------------------------------------------------------
 523
 524 const SERVER_ACTOR_NAME = 'peertube'
 525
 526 const ACTIVITY_PUB = {
 527   POTENTIAL_ACCEPT_HEADERS: [
 528     'application/activity+json',
 529     'application/ld+json',
 530     'application/ld+json; profile="https://www.w3.org/ns/activitystreams"'
 531   ],
 532   ACCEPT_HEADER: 'application/activity+json, application/ld+json',
 533   PUBLIC: 'https://www.w3.org/ns/activitystreams#Public',
 534   COLLECTION_ITEMS_PER_PAGE: 10,
 535   FETCH_PAGE_LIMIT: 100,
 536   URL_MIME_TYPES: {
 537     VIDEO: Object.keys(MIMETYPES.VIDEO.MIMETYPE_EXT),
 538     TORRENT: [ 'application/x-bittorrent' ],
 539     MAGNET: [ 'application/x-bittorrent;x-scheme-handler/magnet' ]
 540   },
 541   MAX_RECURSION_COMMENTS: 100,
 542   ACTOR_REFRESH_INTERVAL: 3600 * 24 * 1000, // 1 day
 543   VIDEO_REFRESH_INTERVAL: 3600 * 24 * 1000 // 1 day
 544 }
 545
 546 const ACTIVITY_PUB_ACTOR_TYPES: { [ id: string ]: ActivityPubActorType } = {
 547   GROUP: 'Group',
 548   PERSON: 'Person',
 549   APPLICATION: 'Application'
 550 }
 551
 552 const HTTP_SIGNATURE = {
 553   HEADER_NAME: 'signature',
 554   ALGORITHM: 'rsa-sha256',
 555   HEADERS_TO_SIGN: [ '(request-target)', 'host', 'date', 'digest' ]
 556 }
 557
 558 // ---------------------------------------------------------------------------
 559
 560 let PRIVATE_RSA_KEY_SIZE = 2048
 561
 562 // Password encryption
 563 const BCRYPT_SALT_SIZE = 10
 564
 565 const USER_PASSWORD_RESET_LIFETIME = 60000 * 5 // 5 minutes
 566
 567 const USER_EMAIL_VERIFY_LIFETIME = 60000 * 60 // 60 minutes
 568
 569 const NSFW_POLICY_TYPES: { [ id: string]: NSFWPolicyType } = {
 570   DO_NOT_LIST: 'do_not_list',
 571   BLUR: 'blur',
 572   DISPLAY: 'display'
 573 }
 574
 575 // ---------------------------------------------------------------------------
 576
 577 // Express static paths (router)
 578 const STATIC_PATHS = {
 579   PREVIEWS: '/static/previews/',
 580   THUMBNAILS: '/static/thumbnails/',
 581   TORRENTS: '/static/torrents/',
 582   WEBSEED: '/static/webseed/',
 583   REDUNDANCY: '/static/redundancy/',
 584   AVATARS: '/static/avatars/',
 585   VIDEO_CAPTIONS: '/static/video-captions/'
 586 }
 587 const STATIC_DOWNLOAD_PATHS = {
 588   TORRENTS: '/download/torrents/',
 589   VIDEOS: '/download/videos/'
 590 }
 591
 592 // Cache control
 593 let STATIC_MAX_AGE = '2h'
 594
 595 // Videos thumbnail size
 596 const THUMBNAILS_SIZE = {
 597   width: 200,
 598   height: 110
 599 }
 600 const PREVIEWS_SIZE = {
 601   width: 560,
 602   height: 315
 603 }
 604 const AVATARS_SIZE = {
 605   width: 120,
 606   height: 120
 607 }
 608
 609 const EMBED_SIZE = {
 610   width: 560,
 611   height: 315
 612 }
 613
 614 // Sub folders of cache directory
 615 const CACHE = {
 616   PREVIEWS: {
 617     DIRECTORY: join(CONFIG.STORAGE.CACHE_DIR, 'previews'),
 618     MAX_AGE: 1000 * 3600 * 3 // 3 hours
 619   },
 620   VIDEO_CAPTIONS: {
 621     DIRECTORY: join(CONFIG.STORAGE.CACHE_DIR, 'video-captions'),
 622     MAX_AGE: 1000 * 3600 * 3 // 3 hours
 623   }
 624 }
 625
 626 const MEMOIZE_TTL = {
 627   OVERVIEWS_SAMPLE: 1000 * 3600 * 4 // 4 hours
 628 }
 629
 630 const REDUNDANCY = {
 631   VIDEOS: {
 632     RANDOMIZED_FACTOR: 5
 633   }
 634 }
 635
 636 const ACCEPT_HEADERS = [ 'html', 'application/json' ].concat(ACTIVITY_PUB.POTENTIAL_ACCEPT_HEADERS)
 637
 638 // ---------------------------------------------------------------------------
 639
 640 const CUSTOM_HTML_TAG_COMMENTS = {
 641   TITLE: '<!-- title tag -->',
 642   DESCRIPTION: '<!-- description tag -->',
 643   CUSTOM_CSS: '<!-- custom css tag -->',
 644   OPENGRAPH_AND_OEMBED: '<!-- open graph and oembed tags -->'
 645 }
 646
 647 // ---------------------------------------------------------------------------
 648
 649 const FEEDS = {
 650   COUNT: 20
 651 }
 652
 653 // ---------------------------------------------------------------------------
 654
 655 const TRACKER_RATE_LIMITS = {
 656   INTERVAL: 60000 * 5, // 5 minutes
 657   ANNOUNCES_PER_IP_PER_INFOHASH: 15, // maximum announces per torrent in the interval
 658   ANNOUNCES_PER_IP: 30 // maximum announces for all our torrents in the interval
 659 }
 660
 661 // ---------------------------------------------------------------------------
 662
 663 // Special constants for a test instance
 664 if (isTestInstance() === true) {
 665   PRIVATE_RSA_KEY_SIZE = 1024
 666
 667   ACTOR_FOLLOW_SCORE.BASE = 20
 668
 669   REMOTE_SCHEME.HTTP = 'http'
 670   REMOTE_SCHEME.WS = 'ws'
 671
 672   STATIC_MAX_AGE = '0'
 673
 674   ACTIVITY_PUB.COLLECTION_ITEMS_PER_PAGE = 2
 675   ACTIVITY_PUB.ACTOR_REFRESH_INTERVAL = 10 * 1000 // 10 seconds
 676   ACTIVITY_PUB.VIDEO_REFRESH_INTERVAL = 10 * 1000 // 10 seconds
 677
 678   CONSTRAINTS_FIELDS.ACTORS.AVATAR.FILE_SIZE.max = 100 * 1024 // 100KB
 679
 680   SCHEDULER_INTERVALS_MS.actorFollowScores = 1000
 681   SCHEDULER_INTERVALS_MS.removeOldJobs = 10000
 682   SCHEDULER_INTERVALS_MS.updateVideos = 5000
 683   REPEAT_JOBS['videos-views'] = { every: 5000 }
 684
 685   REDUNDANCY.VIDEOS.RANDOMIZED_FACTOR = 1
 686
 687   VIDEO_VIEW_LIFETIME = 1000 // 1 second
 688
 689   JOB_ATTEMPTS['email'] = 1
 690
 691   CACHE.VIDEO_CAPTIONS.MAX_AGE = 3000
 692   MEMOIZE_TTL.OVERVIEWS_SAMPLE = 1
 693   ROUTE_CACHE_LIFETIME.OVERVIEWS.VIDEOS = '0ms'
 694 }
 695
 696 updateWebserverUrls()
 697
 698 // ---------------------------------------------------------------------------
 699
 700 export {
 701   API_VERSION,
 702   AVATARS_SIZE,
 703   ACCEPT_HEADERS,
 704   BCRYPT_SALT_SIZE,
 705   TRACKER_RATE_LIMITS,
 706   CACHE,
 707   CONFIG,
 708   CONSTRAINTS_FIELDS,
 709   EMBED_SIZE,
 710   REDUNDANCY,
 711   JOB_CONCURRENCY,
 712   JOB_ATTEMPTS,
 713   LAST_MIGRATION_VERSION,
 714   OAUTH_LIFETIME,
 715   CUSTOM_HTML_TAG_COMMENTS,
 716   BROADCAST_CONCURRENCY,
 717   PAGINATION,
 718   ACTOR_FOLLOW_SCORE,
 719   PREVIEWS_SIZE,
 720   REMOTE_SCHEME,
 721   FOLLOW_STATES,
 722   SERVER_ACTOR_NAME,
 723   PRIVATE_RSA_KEY_SIZE,
 724   ROUTE_CACHE_LIFETIME,
 725   SORTABLE_COLUMNS,
 726   FEEDS,
 727   JOB_TTL,
 728   NSFW_POLICY_TYPES,
 729   STATIC_MAX_AGE,
 730   STATIC_PATHS,
 731   VIDEO_IMPORT_TIMEOUT,
 732   ACTIVITY_PUB,
 733   ACTIVITY_PUB_ACTOR_TYPES,
 734   THUMBNAILS_SIZE,
 735   VIDEO_CATEGORIES,
 736   VIDEO_LANGUAGES,
 737   VIDEO_PRIVACIES,
 738   VIDEO_LICENCES,
 739   VIDEO_STATES,
 740   VIDEO_RATE_TYPES,
 741   VIDEO_TRANSCODING_FPS,
 742   FFMPEG_NICE,
 743   VIDEO_ABUSE_STATES,
 744   JOB_REQUEST_TIMEOUT,
 745   USER_PASSWORD_RESET_LIFETIME,
 746   MEMOIZE_TTL,
 747   USER_EMAIL_VERIFY_LIFETIME,
 748   OVERVIEWS,
 749   SCHEDULER_INTERVALS_MS,
 750   REPEAT_JOBS,
 751   STATIC_DOWNLOAD_PATHS,
 752   RATES_LIMIT,
 753   MIMETYPES,
 754   CRAWL_REQUEST_CONCURRENCY,
 755   JOB_COMPLETED_LIFETIME,
 756   HTTP_SIGNATURE,
 757   VIDEO_IMPORT_STATES,
 758   VIDEO_VIEW_LIFETIME,
 759   buildLanguages
 760 }
 761
 762 // ---------------------------------------------------------------------------
 763
 764 function getLocalConfigFilePath () {
 765   const configSources = config.util.getConfigSources()
 766   if (configSources.length === 0) throw new Error('Invalid config source.')
 767
 768   let filename = 'local'
 769   if (process.env.NODE_ENV) filename += `-${process.env.NODE_ENV}`
 770   if (process.env.NODE_APP_INSTANCE) filename += `-${process.env.NODE_APP_INSTANCE}`
 771
 772   return join(dirname(configSources[ 0 ].name), filename + '.json')
 773 }
 774
 775 function buildVideoMimetypeExt () {
 776   const data = {
 777     'video/webm': '.webm',
 778     'video/ogg': '.ogv',
 779     'video/mp4': '.mp4'
 780   }
 781
 782   if (CONFIG.TRANSCODING.ENABLED && CONFIG.TRANSCODING.ALLOW_ADDITIONAL_EXTENSIONS) {
 783     Object.assign(data, {
 784       'video/quicktime': '.mov',
 785       'video/x-msvideo': '.avi',
 786       'video/x-flv': '.flv',
 787       'video/x-matroska': '.mkv'
 788     })
 789   }
 790
 791   return data
 792 }
 793
 794 function updateWebserverUrls () {
 795   CONFIG.WEBSERVER.URL = sanitizeUrl(CONFIG.WEBSERVER.SCHEME + '://' + CONFIG.WEBSERVER.HOSTNAME + ':' + CONFIG.WEBSERVER.PORT)
 796   CONFIG.WEBSERVER.HOST = sanitizeHost(CONFIG.WEBSERVER.HOSTNAME + ':' + CONFIG.WEBSERVER.PORT, REMOTE_SCHEME.HTTP)
 797 }
 798
 799 function updateWebserverConfig () {
 800   CONSTRAINTS_FIELDS.VIDEOS.EXTNAME = buildVideosExtname()
 801
 802   MIMETYPES.VIDEO.MIMETYPE_EXT = buildVideoMimetypeExt()
 803   MIMETYPES.VIDEO.EXT_MIMETYPE = invert(MIMETYPES.VIDEO.MIMETYPE_EXT)
 804 }
 805
 806 function buildVideosExtname () {
 807   return CONFIG.TRANSCODING.ENABLED && CONFIG.TRANSCODING.ALLOW_ADDITIONAL_EXTENSIONS
 808     ? [ '.mp4', '.ogv', '.webm', '.mkv', '.mov', '.avi', '.flv' ]
 809     : [ '.mp4', '.ogv', '.webm' ]
 810 }
 811
 812 function buildVideosRedundancy (objs: any[]): VideosRedundancy[] {
 813   if (!objs) return []
 814
 815   return objs.map(obj => {
 816     return Object.assign({}, obj, {
 817       minLifetime: parseDuration(obj.min_lifetime),
 818       size: bytes.parse(obj.size),
 819       minViews: obj.min_views
 820     })
 821   })
 822 }
 823
 824 function buildLanguages () {
 825   const iso639 = require('iso-639-3')
 826
 827   const languages: { [ id: string ]: string } = {}
 828
 829   const additionalLanguages = {
 830     'sgn': true, // Sign languages (macro language)
 831     'ase': true, // American sign language
 832     'sdl': true, // Arabian sign language
 833     'bfi': true, // British sign language
 834     'bzs': true, // Brazilian sign language
 835     'csl': true, // Chinese sign language
 836     'cse': true, // Czech sign language
 837     'dsl': true, // Danish sign language
 838     'fsl': true, // French sign language
 839     'gsg': true, // German sign language
 840     'pks': true, // Pakistan sign language
 841     'jsl': true, // Japanese sign language
 842     'sfs': true, // South African sign language
 843     'swl': true, // Swedish sign language
 844     'rsl': true, // Russian sign language: true
 845
 846     'epo': true, // Esperanto
 847     'tlh': true, // Klingon
 848     'jbo': true, // Lojban
 849     'avk': true // Kotava
 850   }
 851
 852   // Only add ISO639-1 languages and some sign languages (ISO639-3)
 853   iso639
 854     .filter(l => {
 855       return (l.iso6391 !== null && l.type === 'living') ||
 856         additionalLanguages[l.iso6393] === true
 857     })
 858     .forEach(l => languages[l.iso6391 || l.iso6393] = l.name)
 859
 860   // Override Occitan label
 861   languages['oc'] = 'Occitan'
 862
 863   return languages
 864 }
 865
 866 export function reloadConfig () {
 867
 868   function directory () {
 869     if (process.env.NODE_CONFIG_DIR) {
 870       return process.env.NODE_CONFIG_DIR
 871     }
 872
 873     return join(root(), 'config')
 874   }
 875
 876   function purge () {
 877     for (const fileName in require.cache) {
 878       if (-1 === fileName.indexOf(directory())) {
 879         continue
 880       }
 881
 882       delete require.cache[fileName]
 883     }
 884
 885     delete require.cache[require.resolve('config')]
 886   }
 887
 888   purge()
 889
 890   config = require('config')
 891
 892   updateWebserverConfig()
 893   updateWebserverUrls()
 894 }