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