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