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