server/initializers/constants.ts

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