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