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